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