scripts/tags.sh

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