scripts/tags.sh

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