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