xref: /linux-6.15/scripts/tags.sh (revision 8ab596af) 
1#!/bin/sh
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# Find all available archs
29find_all_archs()
30{
31	ALLSOURCE_ARCHS=""
32	for arch in `ls ${tree}arch`; do
33		ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
34	done
35}
36
37# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
38if [ "${ALLSOURCE_ARCHS}" = "" ]; then
39	ALLSOURCE_ARCHS=${SRCARCH}
40elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
41	find_all_archs
42fi
43
44# find sources in arch/$ARCH
45find_arch_sources()
46{
47	for i in $archincludedir; do
48		prune="$prune -wholename $i -prune -o"
49	done
50	find ${tree}arch/$1 $ignore $subarchprune $prune -name "$2" -print;
51}
52
53# find sources in arch/$1/include
54find_arch_include_sources()
55{
56	include=$(find ${tree}arch/$1/ $subarchprune \
57					-name include -type d -print);
58	if [ -n "$include" ]; then
59		archincludedir="$archincludedir $include"
60		find $include $ignore -name "$2" -print;
61	fi
62}
63
64# find sources in include/
65find_include_sources()
66{
67	find ${tree}include $ignore -name config -prune -o -name "$1" -print;
68}
69
70# find sources in rest of tree
71# we could benefit from a list of dirs to search in here
72find_other_sources()
73{
74	find ${tree}* $ignore \
75	     \( -name include -o -name arch -o -name '.tmp_*' \) -prune -o \
76	       -name "$1" -print;
77}
78
79find_sources()
80{
81	find_arch_sources $1 "$2"
82}
83
84all_sources()
85{
86	find_arch_include_sources ${SRCARCH} '*.[chS]'
87	if [ ! -z "$archinclude" ]; then
88		find_arch_include_sources $archinclude '*.[chS]'
89	fi
90	find_include_sources '*.[chS]'
91	for arch in $ALLSOURCE_ARCHS
92	do
93		find_sources $arch '*.[chS]'
94	done
95	find_other_sources '*.[chS]'
96}
97
98all_compiled_sources()
99{
100	for i in $(all_sources); do
101		case "$i" in
102			*.[cS])
103				j=${i/\.[cS]/\.o}
104				if [ -e $j ]; then
105					echo $i
106				fi
107				;;
108			*)
109				echo $i
110				;;
111		esac
112	done
113}
114
115all_target_sources()
116{
117	if [ -n "$COMPILED_SOURCE" ]; then
118		all_compiled_sources
119	else
120		all_sources
121	fi
122}
123
124all_kconfigs()
125{
126	for arch in $ALLSOURCE_ARCHS; do
127		find_sources $arch 'Kconfig*'
128	done
129	find_other_sources 'Kconfig*'
130}
131
132all_defconfigs()
133{
134	find_sources $ALLSOURCE_ARCHS "defconfig"
135}
136
137docscope()
138{
139	(echo \-k; echo \-q; all_target_sources) > cscope.files
140	cscope -b -f cscope.out
141}
142
143dogtags()
144{
145	all_target_sources | gtags -i -f -
146}
147
148exuberant()
149{
150	all_target_sources | xargs $1 -a                        \
151	-I __initdata,__exitdata,__initconst,			\
152	-I __cpuinitdata,__initdata_memblock			\
153	-I __refdata,__attribute,__maybe_unused,__always_unused \
154	-I __acquires,__releases,__deprecated			\
155	-I __read_mostly,__aligned,____cacheline_aligned        \
156	-I ____cacheline_aligned_in_smp                         \
157	-I __cacheline_aligned,__cacheline_aligned_in_smp	\
158	-I ____cacheline_internodealigned_in_smp                \
159	-I __used,__packed,__packed2__,__must_check,__must_hold	\
160	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
161	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
162	-I static,const						\
163	--extra=+f --c-kinds=+px                                \
164	--regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/'        \
165	--regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
166	--regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'		\
167	--regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'	\
168	--regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/'			\
169	--regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/'			\
170	--regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
171	--regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'		\
172	--regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'			\
173	--regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'		\
174	--regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
175	--regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
176	--regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
177	--regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
178	--regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'	\
179	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
180	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'		\
181	--regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'		\
182	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'		\
183	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'		\
184	--regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'		\
185	--regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'	\
186	--regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/'	\
187	--regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
188	--regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
189	--regex-c++='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/'		\
190	--regex-c='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/' \
191	--regex-c='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/' \
192	--regex-c='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/'	\
193	--regex-c='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/'	\
194	--regex-c='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/'		\
195	--regex-c='/DECLARE_BITMAP\((\w*)/\1/v/'			\
196	--regex-c='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/'			\
197	--regex-c='/(^|\s)RADIX_TREE\((\w*)/\2/v/'			\
198	--regex-c='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/'		\
199	--regex-c='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
200	--regex-c='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/'		\
201	--regex-c='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/'	\
202	--regex-c='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/'		\
203	--regex-c='/(^\s)OFFSET\((\w*)/\2/v/'				\
204	--regex-c='/(^\s)DEFINE\((\w*)/\2/v/'
205
206	all_kconfigs | xargs $1 -a                              \
207	--langdef=kconfig --language-force=kconfig              \
208	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
209
210	all_kconfigs | xargs $1 -a                              \
211	--langdef=kconfig --language-force=kconfig              \
212	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
213
214	all_defconfigs | xargs -r $1 -a                         \
215	--langdef=dotconfig --language-force=dotconfig          \
216	--regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
217}
218
219emacs()
220{
221	all_target_sources | xargs $1 -a                        \
222	--regex='/^\(ENTRY\|_GLOBAL\)(\([^)]*\)).*/\2/'         \
223	--regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
224	--regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'		\
225	--regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
226	--regex='/PAGEFLAG(\([^,)]*\).*/Page\1/'			\
227	--regex='/PAGEFLAG(\([^,)]*\).*/SetPage\1/'		\
228	--regex='/PAGEFLAG(\([^,)]*\).*/ClearPage\1/'		\
229	--regex='/TESTSETFLAG(\([^,)]*\).*/TestSetPage\1/'	\
230	--regex='/TESTPAGEFLAG(\([^,)]*\).*/Page\1/'		\
231	--regex='/SETPAGEFLAG(\([^,)]*\).*/SetPage\1/'		\
232	--regex='/__SETPAGEFLAG(\([^,)]*\).*/__SetPage\1/'	\
233	--regex='/TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'	\
234	--regex='/__TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'	\
235	--regex='/CLEARPAGEFLAG(\([^,)]*\).*/ClearPage\1/'	\
236	--regex='/__CLEARPAGEFLAG(\([^,)]*\).*/__ClearPage\1/'	\
237	--regex='/__PAGEFLAG(\([^,)]*\).*/__SetPage\1/'		\
238	--regex='/__PAGEFLAG(\([^,)]*\).*/__ClearPage\1/'	\
239	--regex='/PAGEFLAG_FALSE(\([^,)]*\).*/Page\1/'		\
240	--regex='/TESTSCFLAG(\([^,)]*\).*/TestSetPage\1/'	\
241	--regex='/TESTSCFLAG(\([^,)]*\).*/TestClearPage\1/'	\
242	--regex='/SETPAGEFLAG_NOOP(\([^,)]*\).*/SetPage\1/'	\
243	--regex='/CLEARPAGEFLAG_NOOP(\([^,)]*\).*/ClearPage\1/'	\
244	--regex='/__CLEARPAGEFLAG_NOOP(\([^,)]*\).*/__ClearPage\1/' \
245	--regex='/TESTCLEARFLAG_FALSE(\([^,)]*\).*/TestClearPage\1/' \
246	--regex='/__TESTCLEARFLAG_FALSE(\([^,)]*\).*/__TestClearPage\1/' \
247	--regex='/_PE(\([^,)]*\).*/PEVENT_ERRNO__\1/'		\
248	--regex='/PCI_OP_READ(\([a-z]*[a-z]\).*[1-4])/pci_bus_read_config_\1/' \
249	--regex='/PCI_OP_WRITE(\([a-z]*[a-z]\).*[1-4])/pci_bus_write_config_\1/'
250
251	all_kconfigs | xargs $1 -a                              \
252	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
253
254	all_kconfigs | xargs $1 -a                              \
255	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
256
257	all_defconfigs | xargs -r $1 -a                         \
258	--regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
259}
260
261xtags()
262{
263	if $1 --version 2>&1 | grep -iq exuberant; then
264		exuberant $1
265	elif $1 --version 2>&1 | grep -iq emacs; then
266		emacs $1
267	else
268		all_target_sources | xargs $1 -a
269        fi
270}
271
272# Support um (which uses SUBARCH)
273if [ "${ARCH}" = "um" ]; then
274	if [ "$SUBARCH" = "i386" ]; then
275		archinclude=x86
276	elif [ "$SUBARCH" = "x86_64" ]; then
277		archinclude=x86
278	else
279		archinclude=${SUBARCH}
280	fi
281elif [ "${SRCARCH}" = "arm" -a "${SUBARCH}" != "" ]; then
282	subarchdir=$(find ${tree}arch/$SRCARCH/ -name "mach-*" -type d -o \
283							-name "plat-*" -type d);
284	for i in $subarchdir; do
285		case "$i" in
286			*"mach-"${SUBARCH})
287				;;
288			*"plat-"${SUBARCH})
289				;;
290			*)
291				subarchprune="$subarchprune \
292						-wholename $i -prune -o"
293				;;
294		esac
295	done
296fi
297
298remove_structs=
299case "$1" in
300	"cscope")
301		docscope
302		;;
303
304	"gtags")
305		dogtags
306		;;
307
308	"tags")
309		rm -f tags
310		xtags ctags
311		remove_structs=y
312		;;
313
314	"TAGS")
315		rm -f TAGS
316		xtags etags
317		remove_structs=y
318		;;
319esac
320
321# Remove structure forward declarations.
322if [ -n "$remove_structs" ]; then
323    LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
324fi
325