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