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