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