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, 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                 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
  59 find_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/
  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 find_sources()
  85 {
  86         find_arch_sources $1 "$2"
  87 }
  88
  89 all_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
 103 all_compiled_sources()
 104 {
 105         {
 106                 echo include/generated/autoconf.h
 107                 find $ignore -name "*.cmd" -exec \
 108                         grep -Poh '(?<=^  )\S+|(?<== )\S+[^\\](?=$)' {} \+ |
 109                 awk '!a[$0]++'
 110         } | xargs realpath -esq $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) |
 111         sort -u
 112 }
 113
 114 all_target_sources()
 115 {
 116         if [ -n "$COMPILED_SOURCE" ]; then
 117                 all_compiled_sources
 118         else
 119                 all_sources
 120         fi
 121 }
 122
 123 all_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
 133 docscope()
 134 {
 135         (echo \-k; echo \-q; all_target_sources) > cscope.files
 136         cscope -b -f cscope.out
 137 }
 138
 139 dogtags()
 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
 152 regex_asm=(
 153         '/^\(ENTRY\|_GLOBAL\)([[:space:]]*\([[:alnum:]_\\]*\)).*/\2/'
 154 )
 155 regex_c=(
 156         '/^SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/sys_\1/'
 157         '/^BPF_CALL_[0-9]([[:space:]]*\([[:alnum:]_]*\).*/\1/'
 158         '/^COMPAT_SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/compat_sys_\1/'
 159         '/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
 160         '/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
 161         '/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
 162         '/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
 163         '/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/get_\1_slot/'
 164         '/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/free_\1_slot/'
 165         '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
 166         '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
 167         '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
 168         '/^TESTSETFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
 169         '/^TESTPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
 170         '/^SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
 171         '/\<__SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
 172         '/\<TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
 173         '/\<__TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
 174         '/\<CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
 175         '/\<__CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
 176         '/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
 177         '/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
 178         '/^PAGEFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
 179         '/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
 180         '/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
 181         '/\<SETPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
 182         '/\<CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
 183         '/\<__CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
 184         '/\<TESTCLEARFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
 185         '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
 186         '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
 187         '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
 188         '/^TASK_PFA_TEST([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_\1/'
 189         '/^TASK_PFA_SET([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_set_\1/'
 190         '/^TASK_PFA_CLEAR([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_clear_\1/'
 191         '/^DEF_MMIO_\(IN\|OUT\)_[XD]([[:space:]]*\([[:alnum:]_]*\),[^)]*)/\2/'
 192         '/^DEBUGGER_BOILERPLATE([[:space:]]*\([[:alnum:]_]*\))/\1/'
 193         '/^DEF_PCI_AC_\(\|NO\)RET([[:space:]]*\([[:alnum:]_]*\).*/\2/'
 194         '/^PCI_OP_READ([[:space:]]*\(\w*\).*[1-4])/pci_bus_read_config_\1/'
 195         '/^PCI_OP_WRITE([[:space:]]*\(\w*\).*[1-4])/pci_bus_write_config_\1/'
 196         '/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 197         '/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 198         '/\<DECLARE_\(RWSEM\|COMPLETION\)([[:space:]]*\([[:alnum:]_]\+\)/\2/v/'
 199         '/\<DECLARE_BITMAP([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
 200         '/\(^\|\s\)\(\|L\|H\)LIST_HEAD([[:space:]]*\([[:alnum:]_]*\)/\3/v/'
 201         '/\(^\|\s\)RADIX_TREE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 202         '/\<DEFINE_PER_CPU([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
 203         '/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
 204         '/\<DECLARE_WAIT_QUEUE_HEAD([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
 205         '/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 206         '/\(^\s\)OFFSET([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 207         '/\(^\s\)DEFINE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 208         '/\<\(DEFINE\|DECLARE\)_HASHTABLE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
 209         '/\<DEFINE_ID\(R\|A\)([[:space:]]*\([[:alnum:]_]\+\)/\2/'
 210         '/\<DEFINE_WD_CLASS([[:space:]]*\([[:alnum:]_]\+\)/\1/'
 211         '/\<ATOMIC_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
 212         '/\<RAW_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
 213         '/\<DECLARE_FAULT_ATTR([[:space:]]*\([[:alnum:]_]\+\)/\1/'
 214         '/\<BLOCKING_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
 215         '/\<DEVICE_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/dev_attr_\2/'
 216         '/\<DRIVER_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/driver_attr_\2/'
 217         '/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)([[:space:]]*\([[:alnum:]_]\+\)/\4/'
 218         '/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_t/'
 219         '/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_init/'
 220 )
 221 regex_kconfig=(
 222         '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
 223         '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
 224 )
 225 setup_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
 258 exuberant()
 259 {
 260         CTAGS_EXTRA="extra"
 261         if $1 --version 2>&1 | grep -iq universal; then
 262             CTAGS_EXTRA="extras"
 263         fi
 264         setup_regex exuberant asm c
 265         all_target_sources | xargs $1 -a                        \
 266         -I __initdata,__exitdata,__initconst,__ro_after_init    \
 267         -I __initdata_memblock                                  \
 268         -I __refdata,__attribute,__maybe_unused,__always_unused \
 269         -I __acquires,__releases,__deprecated,__always_inline   \
 270         -I __read_mostly,__aligned,____cacheline_aligned        \
 271         -I ____cacheline_aligned_in_smp                         \
 272         -I __cacheline_aligned,__cacheline_aligned_in_smp       \
 273         -I ____cacheline_internodealigned_in_smp                \
 274         -I __used,__packed,__packed2__,__must_check,__must_hold \
 275         -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
 276         -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
 277         -I static,const                                         \
 278         --$CTAGS_EXTRA=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
 279         "${regex[@]}"
 280
 281         KCONFIG_ARGS=()
 282         if ! $1 --list-languages | grep -iq kconfig; then
 283                 setup_regex exuberant kconfig
 284                 KCONFIG_ARGS=(--langdef=kconfig --language-force=kconfig "${regex[@]}")
 285         fi
 286         all_kconfigs | xargs $1 -a "${KCONFIG_ARGS[@]}"
 287 }
 288
 289 emacs()
 290 {
 291         setup_regex emacs asm c
 292         all_target_sources | xargs $1 -a "${regex[@]}"
 293
 294         setup_regex emacs kconfig
 295         all_kconfigs | xargs $1 -a "${regex[@]}"
 296 }
 297
 298 xtags()
 299 {
 300         if $1 --version 2>&1 | grep -iq exuberant; then
 301                 exuberant $1
 302         elif $1 --version 2>&1 | grep -iq emacs; then
 303                 emacs $1
 304         else
 305                 all_target_sources | xargs $1 -a
 306         fi
 307 }
 308
 309 # Support um (which uses SUBARCH)
 310 if [ "${ARCH}" = "um" ]; then
 311         if [ "$SUBARCH" = "i386" ]; then
 312                 archinclude=x86
 313         elif [ "$SUBARCH" = "x86_64" ]; then
 314                 archinclude=x86
 315         else
 316                 archinclude=${SUBARCH}
 317         fi
 318 fi
 319
 320 remove_structs=
 321 case "$1" in
 322         "cscope")
 323                 docscope
 324                 ;;
 325
 326         "gtags")
 327                 dogtags
 328                 ;;
 329
 330         "tags")
 331                 rm -f tags
 332                 xtags ctags
 333                 remove_structs=y
 334                 ;;
 335
 336         "TAGS")
 337                 rm -f TAGS
 338                 xtags etags
 339                 remove_structs=y
 340                 ;;
 341 esac
 342
 343 # Remove structure forward declarations.
 344 if [ -n "$remove_structs" ]; then
 345     LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
 346 fi