1#!/bin/bash 2# SPDX-License-Identifier: GPL-2.0-only 3# Generate tags or cscope files 4# Usage tags.sh <mode> 5# 6# mode may be any of: tags, TAGS, cscope 7# 8# Uses the following environment variables: 9# SUBARCH, SRCARCH, srctree 10 11if [ "$KBUILD_VERBOSE" = "1" ]; then 12 set -x 13fi 14 15# RCS_FIND_IGNORE has escaped ()s -- remove them. 16ignore="$(echo "$RCS_FIND_IGNORE" | sed 's|\\||g' )" 17# tags and cscope files should also ignore MODVERSION *.mod.c files 18ignore="$ignore ( -name *.mod.c ) -prune -o" 19 20# Use make KBUILD_ABS_SRCTREE=1 {tags|cscope} 21# to force full paths for a non-O= build 22if [ "${srctree}" = "." -o -z "${srctree}" ]; then 23 tree= 24else 25 tree=${srctree}/ 26fi 27 28# ignore userspace tools 29if [ -n "$COMPILED_SOURCE" ]; then 30 ignore="$ignore ( -path ./tools ) -prune -o" 31else 32 ignore="$ignore ( -path ${tree}tools ) -prune -o" 33fi 34 35# gtags(1) refuses to index any file outside of its current working dir. 36# If gtags indexing is requested and the build output directory is not 37# the kernel source tree, index all files in absolute-path form. 38if [[ "$1" == "gtags" && -n "${tree}" ]]; then 39 tree=$(realpath "$tree")/ 40fi 41 42# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH 43if [ "${ALLSOURCE_ARCHS}" = "" ]; then 44 ALLSOURCE_ARCHS=${SRCARCH} 45elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then 46 ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ') 47fi 48 49# find sources in arch/$1 50find_arch_sources() 51{ 52 for i in $archincludedir; do 53 prune="$prune -wholename $i -prune -o" 54 done 55 find ${tree}arch/$1 $ignore $prune -name "$2" -not -type l -print; 56} 57 58# find sources in arch/$1/include 59find_arch_include_sources() 60{ 61 include=$(find ${tree}arch/$1/ -name include -type d -print); 62 if [ -n "$include" ]; then 63 archincludedir="$archincludedir $include" 64 find $include $ignore -name "$2" -not -type l -print; 65 fi 66} 67 68# find sources in include/ 69find_include_sources() 70{ 71 find ${tree}include $ignore -name config -prune -o -name "$1" \ 72 -not -type l -print; 73} 74 75# find sources in rest of tree 76# we could benefit from a list of dirs to search in here 77find_other_sources() 78{ 79 find ${tree}* $ignore \ 80 \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \ 81 -name "$1" -not -type l -print; 82} 83 84find_sources() 85{ 86 find_arch_sources $1 "$2" 87} 88 89all_sources() 90{ 91 find_arch_include_sources ${SRCARCH} '*.[chS]' 92 if [ ! -z "$archinclude" ]; then 93 find_arch_include_sources $archinclude '*.[chS]' 94 fi 95 find_include_sources '*.[chS]' 96 for arch in $ALLSOURCE_ARCHS 97 do 98 find_sources $arch '*.[chS]' 99 done 100 find_other_sources '*.[chS]' 101} 102 103all_compiled_sources() 104{ 105 { 106 echo include/generated/autoconf.h 107 find $ignore -name "*.cmd" -exec \ 108 sed -n -E 's/^source_.* (.*)/\1/p; s/^ (\S.*) \\/\1/p' {} \+ | 109 awk '!a[$0]++' 110 } | xargs realpath -es $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) | 111 sort -u 112} 113 114all_target_sources() 115{ 116 if [ -n "$COMPILED_SOURCE" ]; then 117 all_compiled_sources 118 else 119 all_sources 120 fi 121} 122 123all_kconfigs() 124{ 125 find ${tree}arch/ -maxdepth 1 $ignore \ 126 -name "Kconfig*" -not -type l -print; 127 for arch in $ALLSOURCE_ARCHS; do 128 find_sources $arch 'Kconfig*' 129 done 130 find_other_sources 'Kconfig*' 131} 132 133docscope() 134{ 135 (echo \-k; echo \-q; all_target_sources) > cscope.files 136 cscope -b -f cscope.out 137} 138 139dogtags() 140{ 141 all_target_sources | gtags -i -C "${tree:-.}" -f - "$PWD" 142} 143 144# Basic regular expressions with an optional /kind-spec/ for ctags and 145# the following limitations: 146# - No regex modifiers 147# - Use \{0,1\} instead of \?, because etags expects an unescaped ? 148# - \s is not working with etags, use a space or [ \t] 149# - \w works, but does not match underscores in etags 150# - etags regular expressions have to match at the start of a line; 151# a ^[^#] is prepended by setup_regex unless an anchor is already present 152regex_asm=( 153 '/^\(ENTRY\|_GLOBAL\)(\([[:alnum:]_\\]*\)).*/\2/' 154) 155regex_c=( 156 '/^SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/sys_\1/' 157 '/^BPF_CALL_[0-9](\([[:alnum:]_]*\).*/\1/' 158 '/^COMPAT_SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/compat_sys_\1/' 159 '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1/' 160 '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1_rcuidle/' 161 '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1/' 162 '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1_rcuidle/' 163 '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/get_\1_slot/' 164 '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/free_\1_slot/' 165 '/^PAGEFLAG(\([[:alnum:]_]*\).*/Page\1/' 166 '/^PAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/' 167 '/^PAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/' 168 '/^TESTSETFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/' 169 '/^TESTPAGEFLAG(\([[:alnum:]_]*\).*/Page\1/' 170 '/^SETPAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/' 171 '/\<__SETPAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/' 172 '/\<TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 173 '/\<__TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 174 '/\<CLEARPAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/' 175 '/\<__CLEARPAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/' 176 '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/' 177 '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/' 178 '/^PAGEFLAG_FALSE(\([[:alnum:]_]*\).*/Page\1/' 179 '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/' 180 '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 181 '/\<SETPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/SetPage\1/' 182 '/\<CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/ClearPage\1/' 183 '/\<__CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/__ClearPage\1/' 184 '/\<TESTCLEARFLAG_FALSE(\([[:alnum:]_]*\).*/TestClearPage\1/' 185 '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/Page\1/' 186 '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__SetPage\1/' 187 '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__ClearPage\1/' 188 '/^TASK_PFA_TEST([^,]*, *\([[:alnum:]_]*\))/task_\1/' 189 '/^TASK_PFA_SET([^,]*, *\([[:alnum:]_]*\))/task_set_\1/' 190 '/^TASK_PFA_CLEAR([^,]*, *\([[:alnum:]_]*\))/task_clear_\1/' 191 '/^DEF_MMIO_\(IN\|OUT\)_[XD](\([[:alnum:]_]*\),[^)]*)/\2/' 192 '/^DEBUGGER_BOILERPLATE(\([[:alnum:]_]*\))/\1/' 193 '/^DEF_PCI_AC_\(\|NO\)RET(\([[:alnum:]_]*\).*/\2/' 194 '/^PCI_OP_READ(\(\w*\).*[1-4])/pci_bus_read_config_\1/' 195 '/^PCI_OP_WRITE(\(\w*\).*[1-4])/pci_bus_write_config_\1/' 196 '/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)(\([[:alnum:]_]*\)/\2/v/' 197 '/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)(\([[:alnum:]_]*\)/\2/v/' 198 '/\<DECLARE_\(RWSEM\|COMPLETION\)(\([[:alnum:]_]\+\)/\2/v/' 199 '/\<DECLARE_BITMAP(\([[:alnum:]_]*\)/\1/v/' 200 '/\(^\|\s\)\(\|L\|H\)LIST_HEAD(\([[:alnum:]_]*\)/\3/v/' 201 '/\(^\|\s\)RADIX_TREE(\([[:alnum:]_]*\)/\2/v/' 202 '/\<DEFINE_PER_CPU([^,]*, *\([[:alnum:]_]*\)/\1/v/' 203 '/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*, *\([[:alnum:]_]*\)/\1/v/' 204 '/\<DECLARE_WAIT_QUEUE_HEAD(\([[:alnum:]_]*\)/\1/v/' 205 '/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)(\([[:alnum:]_]*\)/\2/v/' 206 '/\(^\s\)OFFSET(\([[:alnum:]_]*\)/\2/v/' 207 '/\(^\s\)DEFINE(\([[:alnum:]_]*\)/\2/v/' 208 '/\<\(DEFINE\|DECLARE\)_HASHTABLE(\([[:alnum:]_]*\)/\2/v/' 209 '/\<DEFINE_ID\(R\|A\)(\([[:alnum:]_]\+\)/\2/' 210 '/\<DEFINE_WD_CLASS(\([[:alnum:]_]\+\)/\1/' 211 '/\<ATOMIC_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/' 212 '/\<RAW_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/' 213 '/\<DECLARE_FAULT_ATTR(\([[:alnum:]_]\+\)/\1/' 214 '/\<BLOCKING_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/' 215 '/\<DEVICE_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/dev_attr_\2/' 216 '/\<DRIVER_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/driver_attr_\2/' 217 '/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)(\([[:alnum:]_]\+\)/\4/' 218 '/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_t/' 219 '/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_init/' 220) 221regex_kconfig=( 222 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/' 223 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/' 224) 225setup_regex() 226{ 227 local mode=$1 lang tmp=() r 228 shift 229 230 regex=() 231 for lang; do 232 case "$lang" in 233 asm) tmp=("${regex_asm[@]}") ;; 234 c) tmp=("${regex_c[@]}") ;; 235 kconfig) tmp=("${regex_kconfig[@]}") ;; 236 esac 237 for r in "${tmp[@]}"; do 238 if test "$mode" = "exuberant"; then 239 regex[${#regex[@]}]="--regex-$lang=${r}b" 240 else 241 # Remove ctags /kind-spec/ 242 case "$r" in 243 /*/*/?/) 244 r=${r%?/} 245 esac 246 # Prepend ^[^#] unless already anchored 247 case "$r" in 248 /^*) ;; 249 *) 250 r="/^[^#]*${r#/}" 251 esac 252 regex[${#regex[@]}]="--regex=$r" 253 fi 254 done 255 done 256} 257 258exuberant() 259{ 260 setup_regex exuberant asm c 261 all_target_sources | xargs $1 -a \ 262 -I __initdata,__exitdata,__initconst,__ro_after_init \ 263 -I __initdata_memblock \ 264 -I __refdata,__attribute,__maybe_unused,__always_unused \ 265 -I __acquires,__releases,__deprecated,__always_inline \ 266 -I __read_mostly,__aligned,____cacheline_aligned \ 267 -I ____cacheline_aligned_in_smp \ 268 -I __cacheline_aligned,__cacheline_aligned_in_smp \ 269 -I ____cacheline_internodealigned_in_smp \ 270 -I __used,__packed,__packed2__,__must_check,__must_hold \ 271 -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL \ 272 -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \ 273 -I static,const \ 274 --extra=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \ 275 "${regex[@]}" 276 277 setup_regex exuberant kconfig 278 all_kconfigs | xargs $1 -a \ 279 --langdef=kconfig --language-force=kconfig "${regex[@]}" 280 281} 282 283emacs() 284{ 285 setup_regex emacs asm c 286 all_target_sources | xargs $1 -a "${regex[@]}" 287 288 setup_regex emacs kconfig 289 all_kconfigs | xargs $1 -a "${regex[@]}" 290} 291 292xtags() 293{ 294 if $1 --version 2>&1 | grep -iq exuberant; then 295 exuberant $1 296 elif $1 --version 2>&1 | grep -iq emacs; then 297 emacs $1 298 else 299 all_target_sources | xargs $1 -a 300 fi 301} 302 303# Support um (which uses SUBARCH) 304if [ "${ARCH}" = "um" ]; then 305 if [ "$SUBARCH" = "i386" ]; then 306 archinclude=x86 307 elif [ "$SUBARCH" = "x86_64" ]; then 308 archinclude=x86 309 else 310 archinclude=${SUBARCH} 311 fi 312fi 313 314remove_structs= 315case "$1" in 316 "cscope") 317 docscope 318 ;; 319 320 "gtags") 321 dogtags 322 ;; 323 324 "tags") 325 rm -f tags 326 xtags ctags 327 remove_structs=y 328 ;; 329 330 "TAGS") 331 rm -f TAGS 332 xtags etags 333 remove_structs=y 334 ;; 335esac 336 337# Remove structure forward declarations. 338if [ -n "$remove_structs" ]; then 339 LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1 340fi 341