Merge tag 'afs-next-20190507' of git://git.kernel.org/pub/scm/linux/kernel/git/dhowel...
[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 # Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
32 if [ "${ALLSOURCE_ARCHS}" = "" ]; then
33         ALLSOURCE_ARCHS=${SRCARCH}
34 elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
35         ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')
36 fi
37
38 # find sources in arch/$ARCH
39 find_arch_sources()
40 {
41         for i in $archincludedir; do
42                 prune="$prune -wholename $i -prune -o"
43         done
44         find ${tree}arch/$1 $ignore $subarchprune $prune -name "$2" \
45                 -not -type l -print;
46 }
47
48 # find sources in arch/$1/include
49 find_arch_include_sources()
50 {
51         include=$(find ${tree}arch/$1/ $subarchprune \
52                                         -name include -type d -print);
53         if [ -n "$include" ]; then
54                 archincludedir="$archincludedir $include"
55                 find $include $ignore -name "$2" -not -type l -print;
56         fi
57 }
58
59 # find sources in include/
60 find_include_sources()
61 {
62         find ${tree}include $ignore -name config -prune -o -name "$1" \
63                 -not -type l -print;
64 }
65
66 # find sources in rest of tree
67 # we could benefit from a list of dirs to search in here
68 find_other_sources()
69 {
70         find ${tree}* $ignore \
71              \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
72                -name "$1" -not -type l -print;
73 }
74
75 find_sources()
76 {
77         find_arch_sources $1 "$2"
78 }
79
80 all_sources()
81 {
82         find_arch_include_sources ${SRCARCH} '*.[chS]'
83         if [ ! -z "$archinclude" ]; then
84                 find_arch_include_sources $archinclude '*.[chS]'
85         fi
86         find_include_sources '*.[chS]'
87         for arch in $ALLSOURCE_ARCHS
88         do
89                 find_sources $arch '*.[chS]'
90         done
91         find_other_sources '*.[chS]'
92 }
93
94 all_compiled_sources()
95 {
96         for i in $(all_sources); do
97                 case "$i" in
98                         *.[cS])
99                                 j=${i/\.[cS]/\.o}
100                                 j="${j#$tree}"
101                                 if [ -e $j ]; then
102                                         echo $i
103                                 fi
104                                 ;;
105                         *)
106                                 echo $i
107                                 ;;
108                 esac
109         done
110 }
111
112 all_target_sources()
113 {
114         if [ -n "$COMPILED_SOURCE" ]; then
115                 all_compiled_sources
116         else
117                 all_sources
118         fi
119 }
120
121 all_kconfigs()
122 {
123         find ${tree}arch/ -maxdepth 1 $ignore \
124                -name "Kconfig*" -not -type l -print;
125         for arch in $ALLSOURCE_ARCHS; do
126                 find_sources $arch 'Kconfig*'
127         done
128         find_other_sources 'Kconfig*'
129 }
130
131 docscope()
132 {
133         (echo \-k; echo \-q; all_target_sources) > cscope.files
134         cscope -b -f cscope.out
135 }
136
137 dogtags()
138 {
139         all_target_sources | gtags -i -f -
140 }
141
142 # Basic regular expressions with an optional /kind-spec/ for ctags and
143 # the following limitations:
144 # - No regex modifiers
145 # - Use \{0,1\} instead of \?, because etags expects an unescaped ?
146 # - \s is not working with etags, use a space or [ \t]
147 # - \w works, but does not match underscores in etags
148 # - etags regular expressions have to match at the start of a line;
149 #   a ^[^#] is prepended by setup_regex unless an anchor is already present
150 regex_asm=(
151         '/^\(ENTRY\|_GLOBAL\)(\([[:alnum:]_\\]*\)).*/\2/'
152 )
153 regex_c=(
154         '/^SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/sys_\1/'
155         '/^BPF_CALL_[0-9](\([[:alnum:]_]*\).*/\1/'
156         '/^COMPAT_SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/compat_sys_\1/'
157         '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1/'
158         '/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
159         '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1/'
160         '/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
161         '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/get_\1_slot/'
162         '/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/free_\1_slot/'
163         '/^PAGEFLAG(\([[:alnum:]_]*\).*/Page\1/'
164         '/^PAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/'
165         '/^PAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/'
166         '/^TESTSETFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/'
167         '/^TESTPAGEFLAG(\([[:alnum:]_]*\).*/Page\1/'
168         '/^SETPAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/'
169         '/\<__SETPAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/'
170         '/\<TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
171         '/\<__TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
172         '/\<CLEARPAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/'
173         '/\<__CLEARPAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/'
174         '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/'
175         '/^__PAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/'
176         '/^PAGEFLAG_FALSE(\([[:alnum:]_]*\).*/Page\1/'
177         '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/'
178         '/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
179         '/\<SETPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/SetPage\1/'
180         '/\<CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/ClearPage\1/'
181         '/\<__CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/__ClearPage\1/'
182         '/\<TESTCLEARFLAG_FALSE(\([[:alnum:]_]*\).*/TestClearPage\1/'
183         '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/Page\1/'
184         '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__SetPage\1/'
185         '/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__ClearPage\1/'
186         '/^TASK_PFA_TEST([^,]*, *\([[:alnum:]_]*\))/task_\1/'
187         '/^TASK_PFA_SET([^,]*, *\([[:alnum:]_]*\))/task_set_\1/'
188         '/^TASK_PFA_CLEAR([^,]*, *\([[:alnum:]_]*\))/task_clear_\1/'
189         '/^DEF_MMIO_\(IN\|OUT\)_[XD](\([[:alnum:]_]*\),[^)]*)/\2/'
190         '/^DEBUGGER_BOILERPLATE(\([[:alnum:]_]*\))/\1/'
191         '/^DEF_PCI_AC_\(\|NO\)RET(\([[:alnum:]_]*\).*/\2/'
192         '/^PCI_OP_READ(\(\w*\).*[1-4])/pci_bus_read_config_\1/'
193         '/^PCI_OP_WRITE(\(\w*\).*[1-4])/pci_bus_write_config_\1/'
194         '/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)(\([[:alnum:]_]*\)/\2/v/'
195         '/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)(\([[:alnum:]_]*\)/\2/v/'
196         '/\<DECLARE_\(RWSEM\|COMPLETION\)(\([[:alnum:]_]\+\)/\2/v/'
197         '/\<DECLARE_BITMAP(\([[:alnum:]_]*\)/\1/v/'
198         '/\(^\|\s\)\(\|L\|H\)LIST_HEAD(\([[:alnum:]_]*\)/\3/v/'
199         '/\(^\|\s\)RADIX_TREE(\([[:alnum:]_]*\)/\2/v/'
200         '/\<DEFINE_PER_CPU([^,]*, *\([[:alnum:]_]*\)/\1/v/'
201         '/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*, *\([[:alnum:]_]*\)/\1/v/'
202         '/\<DECLARE_WAIT_QUEUE_HEAD(\([[:alnum:]_]*\)/\1/v/'
203         '/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)(\([[:alnum:]_]*\)/\2/v/'
204         '/\(^\s\)OFFSET(\([[:alnum:]_]*\)/\2/v/'
205         '/\(^\s\)DEFINE(\([[:alnum:]_]*\)/\2/v/'
206         '/\<\(DEFINE\|DECLARE\)_HASHTABLE(\([[:alnum:]_]*\)/\2/v/'
207         '/\<DEFINE_ID\(R\|A\)(\([[:alnum:]_]\+\)/\2/'
208         '/\<DEFINE_WD_CLASS(\([[:alnum:]_]\+\)/\1/'
209         '/\<ATOMIC_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
210         '/\<RAW_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
211         '/\<DECLARE_FAULT_ATTR(\([[:alnum:]_]\+\)/\1/'
212         '/\<BLOCKING_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
213         '/\<DEVICE_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/dev_attr_\2/'
214         '/\<DRIVER_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/driver_attr_\2/'
215         '/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)(\([[:alnum:]_]\+\)/\4/'
216 )
217 regex_kconfig=(
218         '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
219         '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
220 )
221 setup_regex()
222 {
223         local mode=$1 lang tmp=() r
224         shift
225
226         regex=()
227         for lang; do
228                 case "$lang" in
229                 asm)       tmp=("${regex_asm[@]}") ;;
230                 c)         tmp=("${regex_c[@]}") ;;
231                 kconfig)   tmp=("${regex_kconfig[@]}") ;;
232                 esac
233                 for r in "${tmp[@]}"; do
234                         if test "$mode" = "exuberant"; then
235                                 regex[${#regex[@]}]="--regex-$lang=${r}b"
236                         else
237                                 # Remove ctags /kind-spec/
238                                 case "$r" in
239                                 /*/*/?/)
240                                         r=${r%?/}
241                                 esac
242                                 # Prepend ^[^#] unless already anchored
243                                 case "$r" in
244                                 /^*) ;;
245                                 *)
246                                         r="/^[^#]*${r#/}"
247                                 esac
248                                 regex[${#regex[@]}]="--regex=$r"
249                         fi
250                 done
251         done
252 }
253
254 exuberant()
255 {
256         setup_regex exuberant asm c
257         all_target_sources | xargs $1 -a                        \
258         -I __initdata,__exitdata,__initconst,__ro_after_init    \
259         -I __initdata_memblock                                  \
260         -I __refdata,__attribute,__maybe_unused,__always_unused \
261         -I __acquires,__releases,__deprecated,__always_inline   \
262         -I __read_mostly,__aligned,____cacheline_aligned        \
263         -I ____cacheline_aligned_in_smp                         \
264         -I __cacheline_aligned,__cacheline_aligned_in_smp       \
265         -I ____cacheline_internodealigned_in_smp                \
266         -I __used,__packed,__packed2__,__must_check,__must_hold \
267         -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
268         -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
269         -I static,const                                         \
270         --extra=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
271         "${regex[@]}"
272
273         setup_regex exuberant kconfig
274         all_kconfigs | xargs $1 -a                              \
275         --langdef=kconfig --language-force=kconfig "${regex[@]}"
276
277 }
278
279 emacs()
280 {
281         setup_regex emacs asm c
282         all_target_sources | xargs $1 -a "${regex[@]}"
283
284         setup_regex emacs kconfig
285         all_kconfigs | xargs $1 -a "${regex[@]}"
286 }
287
288 xtags()
289 {
290         if $1 --version 2>&1 | grep -iq exuberant; then
291                 exuberant $1
292         elif $1 --version 2>&1 | grep -iq emacs; then
293                 emacs $1
294         else
295                 all_target_sources | xargs $1 -a
296         fi
297 }
298
299 # Support um (which uses SUBARCH)
300 if [ "${ARCH}" = "um" ]; then
301         if [ "$SUBARCH" = "i386" ]; then
302                 archinclude=x86
303         elif [ "$SUBARCH" = "x86_64" ]; then
304                 archinclude=x86
305         else
306                 archinclude=${SUBARCH}
307         fi
308 elif [ "${SRCARCH}" = "arm" -a "${SUBARCH}" != "" ]; then
309         subarchdir=$(find ${tree}arch/$SRCARCH/ -name "mach-*" -type d -o \
310                                                         -name "plat-*" -type d);
311         mach_suffix=$SUBARCH
312         plat_suffix=$SUBARCH
313
314         # Special cases when $plat_suffix != $mach_suffix
315         case $mach_suffix in
316                 "omap1" | "omap2")
317                         plat_suffix="omap"
318                         ;;
319         esac
320
321         if [ ! -d ${tree}arch/$SRCARCH/mach-$mach_suffix ]; then
322                 echo "Warning: arch/arm/mach-$mach_suffix/ not found." >&2
323                 echo "         Fix your \$SUBARCH appropriately" >&2
324         fi
325
326         for i in $subarchdir; do
327                 case "$i" in
328                         *"mach-"${mach_suffix})
329                                 ;;
330                         *"plat-"${plat_suffix})
331                                 ;;
332                         *)
333                                 subarchprune="$subarchprune \
334                                                 -wholename $i -prune -o"
335                                 ;;
336                 esac
337         done
338 fi
339
340 remove_structs=
341 case "$1" in
342         "cscope")
343                 docscope
344                 ;;
345
346         "gtags")
347                 dogtags
348                 ;;
349
350         "tags")
351                 rm -f tags
352                 xtags ctags
353                 remove_structs=y
354                 ;;
355
356         "TAGS")
357                 rm -f TAGS
358                 xtags etags
359                 remove_structs=y
360                 ;;
361 esac
362
363 # Remove structure forward declarations.
364 if [ -n "$remove_structs" ]; then
365     LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
366 fi