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 10if [ "$KBUILD_VERBOSE" = "1" ]; then 11 set -x 12fi 13 14# RCS_FIND_IGNORE has escaped ()s -- remove them. 15ignore="$(echo "$RCS_FIND_IGNORE" | sed 's|\\||g' )" 16# tags and cscope files should also ignore MODVERSION *.mod.c files 17ignore="$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 22if [ "${KBUILD_SRC}" = "" ]; then 23 tree= 24else 25 tree=${srctree}/ 26fi 27 28# ignore userspace tools 29ignore="$ignore ( -path ${tree}tools ) -prune -o" 30 31# Find all available archs 32find_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 41if [ "${ALLSOURCE_ARCHS}" = "" ]; then 42 ALLSOURCE_ARCHS=${SRCARCH} 43elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then 44 find_all_archs 45fi 46 47# find sources in arch/$ARCH 48find_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 58find_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/ 69find_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 77find_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 84find_sources() 85{ 86 find_arch_sources $1 "$2" 87} 88 89all_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 103all_compiled_sources() 104{ 105 for i in $(all_sources); do 106 case "$i" in 107 *.[cS]) 108 j=${i/\.[cS]/\.o} 109 j="${j#$tree}" 110 if [ -e $j ]; then 111 echo $i 112 fi 113 ;; 114 *) 115 echo $i 116 ;; 117 esac 118 done 119} 120 121all_target_sources() 122{ 123 if [ -n "$COMPILED_SOURCE" ]; then 124 all_compiled_sources 125 else 126 all_sources 127 fi 128} 129 130all_kconfigs() 131{ 132 for arch in $ALLSOURCE_ARCHS; do 133 find_sources $arch 'Kconfig*' 134 done 135 find_other_sources 'Kconfig*' 136} 137 138docscope() 139{ 140 (echo \-k; echo \-q; all_target_sources) > cscope.files 141 cscope -b -f cscope.out 142} 143 144dogtags() 145{ 146 all_target_sources | gtags -i -f - 147} 148 149# Basic regular expressions with an optional /kind-spec/ for ctags and 150# the following limitations: 151# - No regex modifiers 152# - Use \{0,1\} instead of \?, because etags expects an unescaped ? 153# - \s is not working with etags, use a space or [ \t] 154# - \w works, but does not match underscores in etags 155# - etags regular expressions have to match at the start of a line; 156# a ^[^#] is prepended by setup_regex unless an anchor is already present 157regex_asm=( 158 '/^\(ENTRY\|_GLOBAL\)(\([[:alnum:]_\\]*\)).*/\2/' 159) 160regex_c=( 161 '/^SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/sys_\1/' 162 '/^COMPAT_SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/compat_sys_\1/' 163 '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1/' 164 '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1_rcuidle/' 165 '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1/' 166 '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1_rcuidle/' 167 '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/get_\1_slot/' 168 '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/free_\1_slot/' 169 '/^PAGEFLAG(\([[:alnum:]_]*\).*/Page\1/' 170 '/^PAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/' 171 '/^PAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/' 172 '/^TESTSETFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/' 173 '/^TESTPAGEFLAG(\([[:alnum:]_]*\).*/Page\1/' 174 '/^SETPAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/' 175 '/\<__SETPAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/' 176 '/\<TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 177 '/\<__TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 178 '/\<CLEARPAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/' 179 '/\<__CLEARPAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/' 180 '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/' 181 '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/' 182 '/^PAGEFLAG_FALSE(\([[:alnum:]_]*\).*/Page\1/' 183 '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/' 184 '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/' 185 '/\<SETPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/SetPage\1/' 186 '/\<CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/ClearPage\1/' 187 '/\<__CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/__ClearPage\1/' 188 '/\<TESTCLEARFLAG_FALSE(\([[:alnum:]_]*\).*/TestClearPage\1/' 189 '/^PAGE_MAPCOUNT_OPS(\([[:alnum:]_]*\).*/Page\1/' 190 '/^PAGE_MAPCOUNT_OPS(\([[:alnum:]_]*\).*/__SetPage\1/' 191 '/^PAGE_MAPCOUNT_OPS(\([[:alnum:]_]*\).*/__ClearPage\1/' 192 '/^TASK_PFA_TEST([^,]*, *\([[:alnum:]_]*\))/task_\1/' 193 '/^TASK_PFA_SET([^,]*, *\([[:alnum:]_]*\))/task_set_\1/' 194 '/^TASK_PFA_CLEAR([^,]*, *\([[:alnum:]_]*\))/task_clear_\1/' 195 '/^DEF_MMIO_\(IN\|OUT\)_[XD](\([[:alnum:]_]*\),[^)]*)/\2/' 196 '/^DEBUGGER_BOILERPLATE(\([[:alnum:]_]*\))/\1/' 197 '/^DEF_PCI_AC_\(\|NO\)RET(\([[:alnum:]_]*\).*/\2/' 198 '/^PCI_OP_READ(\(\w*\).*[1-4])/pci_bus_read_config_\1/' 199 '/^PCI_OP_WRITE(\(\w*\).*[1-4])/pci_bus_write_config_\1/' 200 '/\<DEFINE_\(MUTEX\|SEMAPHORE\|SPINLOCK\)(\([[:alnum:]_]*\)/\2/v/' 201 '/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)(\([[:alnum:]_]*\)/\2/v/' 202 '/\<DECLARE_\(RWSEM\|COMPLETION\)(\([[:alnum:]_]\+\)/\2/v/' 203 '/\<DECLARE_BITMAP(\([[:alnum:]_]*\)/\1/v/' 204 '/\(^\|\s\)\(\|L\|H\)LIST_HEAD(\([[:alnum:]_]*\)/\3/v/' 205 '/\(^\|\s\)RADIX_TREE(\([[:alnum:]_]*\)/\2/v/' 206 '/\<DEFINE_PER_CPU([^,]*, *\([[:alnum:]_]*\)/\1/v/' 207 '/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*, *\([[:alnum:]_]*\)/\1/v/' 208 '/\<DECLARE_WAIT_QUEUE_HEAD(\([[:alnum:]_]*\)/\1/v/' 209 '/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)(\([[:alnum:]_]*\)/\2/v/' 210 '/\(^\s\)OFFSET(\([[:alnum:]_]*\)/\2/v/' 211 '/\(^\s\)DEFINE(\([[:alnum:]_]*\)/\2/v/' 212 '/\<DEFINE_HASHTABLE(\([[:alnum:]_]*\)/\1/v/' 213) 214regex_kconfig=( 215 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/' 216 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/' 217) 218setup_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 251exuberant() 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=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \ 268 "${regex[@]}" 269 270 setup_regex exuberant kconfig 271 all_kconfigs | xargs $1 -a \ 272 --langdef=kconfig --language-force=kconfig "${regex[@]}" 273 274} 275 276emacs() 277{ 278 setup_regex emacs asm c 279 all_target_sources | xargs $1 -a "${regex[@]}" 280 281 setup_regex emacs kconfig 282 all_kconfigs | xargs $1 -a "${regex[@]}" 283} 284 285xtags() 286{ 287 if $1 --version 2>&1 | grep -iq exuberant; then 288 exuberant $1 289 elif $1 --version 2>&1 | grep -iq emacs; then 290 emacs $1 291 else 292 all_target_sources | xargs $1 -a 293 fi 294} 295 296# Support um (which uses SUBARCH) 297if [ "${ARCH}" = "um" ]; then 298 if [ "$SUBARCH" = "i386" ]; then 299 archinclude=x86 300 elif [ "$SUBARCH" = "x86_64" ]; then 301 archinclude=x86 302 else 303 archinclude=${SUBARCH} 304 fi 305elif [ "${SRCARCH}" = "arm" -a "${SUBARCH}" != "" ]; then 306 subarchdir=$(find ${tree}arch/$SRCARCH/ -name "mach-*" -type d -o \ 307 -name "plat-*" -type d); 308 for i in $subarchdir; do 309 case "$i" in 310 *"mach-"${SUBARCH}) 311 ;; 312 *"plat-"${SUBARCH}) 313 ;; 314 *) 315 subarchprune="$subarchprune \ 316 -wholename $i -prune -o" 317 ;; 318 esac 319 done 320fi 321 322remove_structs= 323case "$1" in 324 "cscope") 325 docscope 326 ;; 327 328 "gtags") 329 dogtags 330 ;; 331 332 "tags") 333 rm -f tags 334 xtags ctags 335 remove_structs=y 336 ;; 337 338 "TAGS") 339 rm -f TAGS 340 xtags etags 341 remove_structs=y 342 ;; 343esac 344 345# Remove structure forward declarations. 346if [ -n "$remove_structs" ]; then 347 LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1 348fi 349