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