scripts/tags.sh

   1 #!/bin/sh
   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" -print;
  54 }
  55
  56 # find sources in arch/$1/include
  57 find_arch_include_sources()
  58 {
  59         include=$(find ${tree}arch/$1/ $subarchprune \
  60                                         -name include -type d -print);
  61         if [ -n "$include" ]; then
  62                 archincludedir="$archincludedir $include"
  63                 find $include $ignore -name "$2" -print;
  64         fi
  65 }
  66
  67 # find sources in include/
  68 find_include_sources()
  69 {
  70         find ${tree}include $ignore -name config -prune -o -name "$1" -print;
  71 }
  72
  73 # find sources in rest of tree
  74 # we could benefit from a list of dirs to search in here
  75 find_other_sources()
  76 {
  77         find ${tree}* $ignore \
  78              \( -name include -o -name arch -o -name '.tmp_*' \) -prune -o \
  79                -name "$1" -print;
  80 }
  81
  82 find_sources()
  83 {
  84         find_arch_sources $1 "$2"
  85 }
  86
  87 all_sources()
  88 {
  89         find_arch_include_sources ${SRCARCH} '*.[chS]'
  90         if [ ! -z "$archinclude" ]; then
  91                 find_arch_include_sources $archinclude '*.[chS]'
  92         fi
  93         find_include_sources '*.[chS]'
  94         for arch in $ALLSOURCE_ARCHS
  95         do
  96                 find_sources $arch '*.[chS]'
  97         done
  98         find_other_sources '*.[chS]'
  99 }
 100
 101 all_compiled_sources()
 102 {
 103         for i in $(all_sources); do
 104                 case "$i" in
 105                         *.[cS])
 106                                 j=${i/\.[cS]/\.o}
 107                                 if [ -e $j ]; then
 108                                         echo $i
 109                                 fi
 110                                 ;;
 111                         *)
 112                                 echo $i
 113                                 ;;
 114                 esac
 115         done
 116 }
 117
 118 all_target_sources()
 119 {
 120         if [ -n "$COMPILED_SOURCE" ]; then
 121                 all_compiled_sources
 122         else
 123                 all_sources
 124         fi
 125 }
 126
 127 all_kconfigs()
 128 {
 129         for arch in $ALLSOURCE_ARCHS; do
 130                 find_sources $arch 'Kconfig*'
 131         done
 132         find_other_sources 'Kconfig*'
 133 }
 134
 135 all_defconfigs()
 136 {
 137         find_sources $ALLSOURCE_ARCHS "defconfig"
 138 }
 139
 140 docscope()
 141 {
 142         (echo \-k; echo \-q; all_target_sources) > cscope.files
 143         cscope -b -f cscope.out
 144 }
 145
 146 dogtags()
 147 {
 148         all_target_sources | gtags -i -f -
 149 }
 150
 151 exuberant()
 152 {
 153         all_target_sources | xargs $1 -a                        \
 154         -I __initdata,__exitdata,__initconst,                   \
 155         -I __cpuinitdata,__initdata_memblock                    \
 156         -I __refdata,__attribute,__maybe_unused,__always_unused \
 157         -I __acquires,__releases,__deprecated                   \
 158         -I __read_mostly,__aligned,____cacheline_aligned        \
 159         -I ____cacheline_aligned_in_smp                         \
 160         -I __cacheline_aligned,__cacheline_aligned_in_smp       \
 161         -I ____cacheline_internodealigned_in_smp                \
 162         -I __used,__packed,__packed2__,__must_check,__must_hold \
 163         -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
 164         -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
 165         -I static,const                                         \
 166         --extra=+f --c-kinds=+px                                \
 167         --regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/'        \
 168         --regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
 169         --regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'               \
 170         --regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'     \
 171         --regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/'                     \
 172         --regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/'                  \
 173         --regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'                \
 174         --regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'           \
 175         --regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'                 \
 176         --regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'               \
 177         --regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'           \
 178         --regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'       \
 179         --regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'     \
 180         --regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'           \
 181         --regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'       \
 182         --regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'              \
 183         --regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'            \
 184         --regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'               \
 185         --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'            \
 186         --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'          \
 187         --regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'          \
 188         --regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'      \
 189         --regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/'  \
 190         --regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
 191         --regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
 192         --regex-c++='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/'                \
 193         --regex-c='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/' \
 194         --regex-c='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/' \
 195         --regex-c='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/'     \
 196         --regex-c='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/'  \
 197         --regex-c='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/'            \
 198         --regex-c='/DECLARE_BITMAP\((\w*)/\1/v/'                        \
 199         --regex-c='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/'                 \
 200         --regex-c='/(^|\s)RADIX_TREE\((\w*)/\2/v/'                      \
 201         --regex-c='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/'         \
 202         --regex-c='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
 203         --regex-c='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/'               \
 204         --regex-c='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/'   \
 205         --regex-c='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/'               \
 206         --regex-c='/(^\s)OFFSET\((\w*)/\2/v/'                           \
 207         --regex-c='/(^\s)DEFINE\((\w*)/\2/v/'                           \
 208         --regex-c='/DEFINE_HASHTABLE\((\w*)/\1/v/'
 209
 210         all_kconfigs | xargs $1 -a                              \
 211         --langdef=kconfig --language-force=kconfig              \
 212         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
 213
 214         all_kconfigs | xargs $1 -a                              \
 215         --langdef=kconfig --language-force=kconfig              \
 216         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
 217
 218         all_defconfigs | xargs -r $1 -a                         \
 219         --langdef=dotconfig --language-force=dotconfig          \
 220         --regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
 221 }
 222
 223 emacs()
 224 {
 225         all_target_sources | xargs $1 -a                        \
 226         --regex='/^\(ENTRY\|_GLOBAL\)(\([^)]*\)).*/\2/'         \
 227         --regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
 228         --regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'          \
 229         --regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
 230         --regex='/PAGEFLAG(\([^,)]*\).*/Page\1/'                        \
 231         --regex='/PAGEFLAG(\([^,)]*\).*/SetPage\1/'             \
 232         --regex='/PAGEFLAG(\([^,)]*\).*/ClearPage\1/'           \
 233         --regex='/TESTSETFLAG(\([^,)]*\).*/TestSetPage\1/'      \
 234         --regex='/TESTPAGEFLAG(\([^,)]*\).*/Page\1/'            \
 235         --regex='/SETPAGEFLAG(\([^,)]*\).*/SetPage\1/'          \
 236         --regex='/__SETPAGEFLAG(\([^,)]*\).*/__SetPage\1/'      \
 237         --regex='/TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'  \
 238         --regex='/__TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'        \
 239         --regex='/CLEARPAGEFLAG(\([^,)]*\).*/ClearPage\1/'      \
 240         --regex='/__CLEARPAGEFLAG(\([^,)]*\).*/__ClearPage\1/'  \
 241         --regex='/__PAGEFLAG(\([^,)]*\).*/__SetPage\1/'         \
 242         --regex='/__PAGEFLAG(\([^,)]*\).*/__ClearPage\1/'       \
 243         --regex='/PAGEFLAG_FALSE(\([^,)]*\).*/Page\1/'          \
 244         --regex='/TESTSCFLAG(\([^,)]*\).*/TestSetPage\1/'       \
 245         --regex='/TESTSCFLAG(\([^,)]*\).*/TestClearPage\1/'     \
 246         --regex='/SETPAGEFLAG_NOOP(\([^,)]*\).*/SetPage\1/'     \
 247         --regex='/CLEARPAGEFLAG_NOOP(\([^,)]*\).*/ClearPage\1/' \
 248         --regex='/__CLEARPAGEFLAG_NOOP(\([^,)]*\).*/__ClearPage\1/' \
 249         --regex='/TESTCLEARFLAG_FALSE(\([^,)]*\).*/TestClearPage\1/' \
 250         --regex='/__TESTCLEARFLAG_FALSE(\([^,)]*\).*/__TestClearPage\1/' \
 251         --regex='/_PE(\([^,)]*\).*/PEVENT_ERRNO__\1/'           \
 252         --regex='/PCI_OP_READ(\([a-z]*[a-z]\).*[1-4])/pci_bus_read_config_\1/' \
 253         --regex='/PCI_OP_WRITE(\([a-z]*[a-z]\).*[1-4])/pci_bus_write_config_\1/'\
 254         --regex='/DEFINE_HASHTABLE\((\w*)/\1/v/'
 255
 256         all_kconfigs | xargs $1 -a                              \
 257         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
 258
 259         all_kconfigs | xargs $1 -a                              \
 260         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
 261
 262         all_defconfigs | xargs -r $1 -a                         \
 263         --regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
 264 }
 265
 266 xtags()
 267 {
 268         if $1 --version 2>&1 | grep -iq exuberant; then
 269                 exuberant $1
 270         elif $1 --version 2>&1 | grep -iq emacs; then
 271                 emacs $1
 272         else
 273                 all_target_sources | xargs $1 -a
 274         fi
 275 }
 276
 277 # Support um (which uses SUBARCH)
 278 if [ "${ARCH}" = "um" ]; then
 279         if [ "$SUBARCH" = "i386" ]; then
 280                 archinclude=x86
 281         elif [ "$SUBARCH" = "x86_64" ]; then
 282                 archinclude=x86
 283         else
 284                 archinclude=${SUBARCH}
 285         fi
 286 elif [ "${SRCARCH}" = "arm" -a "${SUBARCH}" != "" ]; then
 287         subarchdir=$(find ${tree}arch/$SRCARCH/ -name "mach-*" -type d -o \
 288                                                         -name "plat-*" -type d);
 289         for i in $subarchdir; do
 290                 case "$i" in
 291                         *"mach-"${SUBARCH})
 292                                 ;;
 293                         *"plat-"${SUBARCH})
 294                                 ;;
 295                         *)
 296                                 subarchprune="$subarchprune \
 297                                                 -wholename $i -prune -o"
 298                                 ;;
 299                 esac
 300         done
 301 fi
 302
 303 remove_structs=
 304 case "$1" in
 305         "cscope")
 306                 docscope
 307                 ;;
 308
 309         "gtags")
 310                 dogtags
 311                 ;;
 312
 313         "tags")
 314                 rm -f tags
 315                 xtags ctags
 316                 remove_structs=y
 317                 ;;
 318
 319         "TAGS")
 320                 rm -f TAGS
 321                 xtags etags
 322                 remove_structs=y
 323                 ;;
 324 esac
 325
 326 # Remove structure forward declarations.
 327 if [ -n "$remove_structs" ]; then
 328     LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
 329 fi