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