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 # This is a duplicate of RCS_FIND_IGNORE without escaped '()'
  15 ignore="( -name SCCS -o -name BitKeeper -o -name .svn -o \
  16           -name CVS  -o -name .pc       -o -name .hg  -o \
  17           -name .git )                                   \
  18           -prune -o"
  19
  20 # Do not use full path if we do not use O=.. builds
  21 # Use make O=. {tags|cscope}
  22 # to force full paths for a non-O= build
  23 if [ "${KBUILD_SRC}" = "" ]; then
  24         tree=
  25 else
  26         tree=${srctree}/
  27 fi
  28
  29 # Find all available archs
  30 find_all_archs()
  31 {
  32         ALLSOURCE_ARCHS=""
  33         for arch in `ls ${tree}arch`; do
  34                 ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
  35         done
  36 }
  37
  38 # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
  39 if [ "${ALLSOURCE_ARCHS}" = "" ]; then
  40         ALLSOURCE_ARCHS=${SRCARCH}
  41 elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
  42         find_all_archs
  43 fi
  44
  45 # find sources in arch/$ARCH
  46 find_arch_sources()
  47 {
  48         for i in $archincludedir; do
  49                 prune="$prune -wholename $i -prune -o"
  50         done
  51         find ${tree}arch/$1 $ignore $prune -name "$2" -print;
  52 }
  53
  54 # find sources in arch/$1/include
  55 find_arch_include_sources()
  56 {
  57         include=$(find ${tree}arch/$1/ -name include -type d);
  58         if [ -n "$include" ]; then
  59                 archincludedir="$archincludedir $include"
  60                 find $include $ignore -name "$2" -print;
  61         fi
  62 }
  63
  64 # find sources in include/
  65 find_include_sources()
  66 {
  67         find ${tree}include $ignore -name config -prune -o -name "$1" -print;
  68 }
  69
  70 # find sources in rest of tree
  71 # we could benefit from a list of dirs to search in here
  72 find_other_sources()
  73 {
  74         find ${tree}* $ignore \
  75              \( -name include -o -name arch -o -name '.tmp_*' \) -prune -o \
  76                -name "$1" -print;
  77 }
  78
  79 find_sources()
  80 {
  81         find_arch_sources $1 "$2"
  82 }
  83
  84 all_sources()
  85 {
  86         find_arch_include_sources ${SRCARCH} '*.[chS]'
  87         if [ ! -z "$archinclude" ]; then
  88                 find_arch_include_sources $archinclude '*.[chS]'
  89         fi
  90         find_include_sources '*.[chS]'
  91         for arch in $ALLSOURCE_ARCHS
  92         do
  93                 find_sources $arch '*.[chS]'
  94         done
  95         find_other_sources '*.[chS]'
  96 }
  97
  98 all_kconfigs()
  99 {
 100         for arch in $ALLSOURCE_ARCHS; do
 101                 find_sources $arch 'Kconfig*'
 102         done
 103         find_other_sources 'Kconfig*'
 104 }
 105
 106 all_defconfigs()
 107 {
 108         find_sources $ALLSOURCE_ARCHS "defconfig"
 109 }
 110
 111 docscope()
 112 {
 113         (echo \-k; echo \-q; all_sources) > cscope.files
 114         cscope -b -f cscope.out
 115 }
 116
 117 dogtags()
 118 {
 119         all_sources | gtags -i -f -
 120 }
 121
 122 exuberant()
 123 {
 124         all_sources | xargs $1 -a                               \
 125         -I __initdata,__exitdata,__initconst,__devinitdata      \
 126         -I __devinitconst,__cpuinitdata,__initdata_memblock     \
 127         -I __refdata,__attribute                                \
 128         -I __acquires,__releases,__deprecated                   \
 129         -I __read_mostly,__aligned,____cacheline_aligned        \
 130         -I ____cacheline_aligned_in_smp                         \
 131         -I ____cacheline_internodealigned_in_smp                \
 132         -I __used,__packed,__packed2__,__must_check,__must_hold \
 133         -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL                      \
 134         -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
 135         -I static,const                                         \
 136         --extra=+f --c-kinds=+px                                \
 137         --regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/'        \
 138         --regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
 139         --regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'               \
 140         --regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'     \
 141         --regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/'                     \
 142         --regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/'                  \
 143         --regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'                \
 144         --regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'           \
 145         --regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'                 \
 146         --regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'               \
 147         --regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'           \
 148         --regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'       \
 149         --regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'     \
 150         --regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'           \
 151         --regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'       \
 152         --regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'              \
 153         --regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'            \
 154         --regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'               \
 155         --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'            \
 156         --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'          \
 157         --regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'          \
 158         --regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'      \
 159         --regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/'  \
 160         --regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
 161         --regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
 162         --regex-c++='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/'                \
 163         --regex-c='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/' \
 164         --regex-c='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/' \
 165         --regex-c='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/'     \
 166         --regex-c='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/'  \
 167         --regex-c='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/'            \
 168         --regex-c='/DECLARE_BITMAP\((\w*)/\1/v/'                        \
 169         --regex-c='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/'                 \
 170         --regex-c='/(^|\s)RADIX_TREE\((\w*)/\2/v/'                      \
 171         --regex-c='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/'         \
 172         --regex-c='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
 173         --regex-c='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/'               \
 174         --regex-c='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/'   \
 175         --regex-c='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/'
 176
 177         all_kconfigs | xargs $1 -a                              \
 178         --langdef=kconfig --language-force=kconfig              \
 179         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
 180
 181         all_kconfigs | xargs $1 -a                              \
 182         --langdef=kconfig --language-force=kconfig              \
 183         --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
 184
 185         all_defconfigs | xargs -r $1 -a                         \
 186         --langdef=dotconfig --language-force=dotconfig          \
 187         --regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
 188 }
 189
 190 emacs()
 191 {
 192         all_sources | xargs $1 -a                               \
 193         --regex='/^(ENTRY|_GLOBAL)(\([^)]*\)).*/\2/'            \
 194         --regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
 195         --regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'          \
 196         --regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
 197         --regex='/PAGEFLAG\(([^,)]*).*/Page\1/'                 \
 198         --regex='/PAGEFLAG\(([^,)]*).*/SetPage\1/'              \
 199         --regex='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'            \
 200         --regex='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'       \
 201         --regex='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'             \
 202         --regex='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'           \
 203         --regex='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'       \
 204         --regex='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'   \
 205         --regex='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/' \
 206         --regex='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'       \
 207         --regex='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'   \
 208         --regex='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'          \
 209         --regex='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'        \
 210         --regex='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'           \
 211         --regex='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'        \
 212         --regex='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'      \
 213         --regex='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'      \
 214         --regex='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'  \
 215         --regex='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/' \
 216         --regex='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
 217         --regex='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
 218         --regex='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/'                    \
 219         --regex='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/'  \
 220         --regex='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/'\
 221         --regex='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/'       \
 222         --regex='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/'    \
 223         --regex='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/'              \
 224         --regex='/DECLARE_BITMAP\((\w*)/\1/v/'                          \
 225         --regex='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/'                   \
 226         --regex='/(^|\s)RADIX_TREE\((\w*)/\2/v/'                        \
 227         --regex='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/'           \
 228         --regex='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
 229         --regex='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/'                 \
 230         --regex='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/'     \
 231         --regex='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/'
 232
 233         all_kconfigs | xargs $1 -a                              \
 234         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
 235
 236         all_kconfigs | xargs $1 -a                              \
 237         --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
 238
 239         all_defconfigs | xargs -r $1 -a                         \
 240         --regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
 241 }
 242
 243 xtags()
 244 {
 245         if $1 --version 2>&1 | grep -iq exuberant; then
 246                 exuberant $1
 247         elif $1 --version 2>&1 | grep -iq emacs; then
 248                 emacs $1
 249         else
 250                 all_sources | xargs $1 -a
 251         fi
 252 }
 253
 254
 255 # Support um (which uses SUBARCH)
 256 if [ "${ARCH}" = "um" ]; then
 257         if [ "$SUBARCH" = "i386" ]; then
 258                 archinclude=x86
 259         elif [ "$SUBARCH" = "x86_64" ]; then
 260                 archinclude=x86
 261         else
 262                 archinclude=${SUBARCH}
 263         fi
 264 fi
 265
 266 remove_structs=
 267 case "$1" in
 268         "cscope")
 269                 docscope
 270                 ;;
 271
 272         "gtags")
 273                 dogtags
 274                 ;;
 275
 276         "tags")
 277                 rm -f tags
 278                 xtags ctags
 279                 remove_structs=y
 280                 ;;
 281
 282         "TAGS")
 283                 rm -f TAGS
 284                 xtags etags
 285                 remove_structs=y
 286                 ;;
 287 esac
 288
 289 # Remove structure forward declarations.
 290 if [ -n "$remove_structs" ]; then
 291     LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
 292 fi