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