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, gtags, 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# ignore arbitrary directories
21if [ -n "${IGNORE_DIRS}" ]; then
22	for i in ${IGNORE_DIRS}; do
23		ignore="${ignore} ( -path $i ) -prune -o"
24	done
25fi
26
27# Use make KBUILD_ABS_SRCTREE=1 {tags|cscope}
28# to force full paths for a non-O= build
29if [ "${srctree}" = "." -o -z "${srctree}" ]; then
30	tree=
31else
32	tree=${srctree}/
33fi
34
35# gtags(1) refuses to index any file outside of its current working dir.
36# If gtags indexing is requested and the build output directory is not
37# the kernel source tree, index all files in absolute-path form.
38if [[ "$1" == "gtags" && -n "${tree}" ]]; then
39	tree=$(realpath "$tree")/
40fi
41
42# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
43if [ "${ALLSOURCE_ARCHS}" = "" ]; then
44	ALLSOURCE_ARCHS=${SRCARCH}
45elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
46	ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')
47fi
48
49# find sources in arch/$1
50find_arch_sources()
51{
52	for i in $archincludedir; do
53		local prune="$prune ( -path $i ) -prune -o"
54	done
55	find ${tree}arch/$1 $ignore $prune -name "$2" -not -type l -print;
56}
57
58# find sources in arch/$1/include
59find_arch_include_sources()
60{
61	local include=$(find ${tree}arch/$1/ -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/
69find_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
77find_other_sources()
78{
79	find ${tree}* $ignore \
80	     \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
81	       -name "$1" -not -type l -print;
82}
83
84all_sources()
85{
86	find_arch_include_sources ${SRCARCH} '*.[chS]'
87	if [ -n "$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_arch_sources $arch '*.[chS]'
94	done
95	find_other_sources '*.[chS]'
96}
97
98all_compiled_sources()
99{
100	{
101		echo include/generated/autoconf.h
102		find $ignore -name "*.cmd" -exec \
103			grep -Poh '(?<=^  )\S+|(?<== )\S+[^\\](?=$)' {} \+ |
104		awk '!a[$0]++'
105	} | xargs realpath -esq $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) |
106	sort -u
107}
108
109all_target_sources()
110{
111	if [ -n "$COMPILED_SOURCE" ]; then
112		all_compiled_sources
113	else
114		all_sources
115	fi
116}
117
118all_kconfigs()
119{
120	find ${tree}arch/ -maxdepth 1 $ignore \
121	       -name "Kconfig*" -not -type l -print;
122	for arch in $ALLSOURCE_ARCHS; do
123		find_arch_sources $arch 'Kconfig*'
124	done
125	find_other_sources 'Kconfig*'
126}
127
128docscope()
129{
130	(echo \-k; echo \-q; all_target_sources) > cscope.files
131	cscope -b -f cscope.out
132}
133
134dogtags()
135{
136	all_target_sources | gtags -i -C "${tree:-.}" -f - "$PWD"
137}
138
139# Basic regular expressions with an optional /kind-spec/ for ctags and
140# the following limitations:
141# - No regex modifiers
142# - Use \{0,1\} instead of \?, because etags expects an unescaped ?
143# - \s is not working with etags, use a space or [ \t]
144# - \w works, but does not match underscores in etags
145# - etags regular expressions have to match at the start of a line;
146#   a ^[^#] is prepended by setup_regex unless an anchor is already present
147regex_asm=(
148	'/^\(ENTRY\|_GLOBAL\)([[:space:]]*\([[:alnum:]_\\]*\)).*/\2/'
149)
150regex_c=(
151	'/^SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/sys_\1/'
152	'/^BPF_CALL_[0-9]([[:space:]]*\([[:alnum:]_]*\).*/\1/'
153	'/^COMPAT_SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/compat_sys_\1/'
154	'/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
155	'/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
156	'/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
157	'/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
158	'/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/get_\1_slot/'
159	'/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/free_\1_slot/'
160	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
161	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
162	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
163	'/^TESTSETFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
164	'/^TESTPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
165	'/^SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
166	'/\<__SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
167	'/\<TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
168	'/\<__TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
169	'/\<CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
170	'/\<__CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
171	'/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
172	'/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
173	'/^PAGEFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
174	'/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
175	'/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
176	'/\<SETPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
177	'/\<CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
178	'/\<__CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
179	'/\<TESTCLEARFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
180	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
181	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
182	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
183	'/^TASK_PFA_TEST([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_\1/'
184	'/^TASK_PFA_SET([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_set_\1/'
185	'/^TASK_PFA_CLEAR([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_clear_\1/'
186	'/^DEF_MMIO_\(IN\|OUT\)_[XD]([[:space:]]*\([[:alnum:]_]*\),[^)]*)/\2/'
187	'/^DEBUGGER_BOILERPLATE([[:space:]]*\([[:alnum:]_]*\))/\1/'
188	'/^DEF_PCI_AC_\(\|NO\)RET([[:space:]]*\([[:alnum:]_]*\).*/\2/'
189	'/^PCI_OP_READ([[:space:]]*\(\w*\).*[1-4])/pci_bus_read_config_\1/'
190	'/^PCI_OP_WRITE([[:space:]]*\(\w*\).*[1-4])/pci_bus_write_config_\1/'
191	'/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
192	'/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
193	'/\<DECLARE_\(RWSEM\|COMPLETION\)([[:space:]]*\([[:alnum:]_]\+\)/\2/v/'
194	'/\<DECLARE_BITMAP([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
195	'/\(^\|\s\)\(\|L\|H\)LIST_HEAD([[:space:]]*\([[:alnum:]_]*\)/\3/v/'
196	'/\(^\|\s\)RADIX_TREE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
197	'/\<DEFINE_PER_CPU([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
198	'/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
199	'/\<DECLARE_WAIT_QUEUE_HEAD([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
200	'/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
201	'/\(^\s\)OFFSET([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
202	'/\(^\s\)DEFINE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
203	'/\<\(DEFINE\|DECLARE\)_HASHTABLE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
204	'/\<DEFINE_ID\(R\|A\)([[:space:]]*\([[:alnum:]_]\+\)/\2/'
205	'/\<DEFINE_WD_CLASS([[:space:]]*\([[:alnum:]_]\+\)/\1/'
206	'/\<ATOMIC_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
207	'/\<RAW_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
208	'/\<DECLARE_FAULT_ATTR([[:space:]]*\([[:alnum:]_]\+\)/\1/'
209	'/\<BLOCKING_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
210	'/\<DEVICE_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/dev_attr_\2/'
211	'/\<DRIVER_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/driver_attr_\2/'
212	'/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)([[:space:]]*\([[:alnum:]_]\+\)/\4/'
213	'/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_t/'
214	'/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_init/'
215)
216regex_kconfig=(
217	'/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
218	'/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
219)
220setup_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
253exuberant()
254{
255	CTAGS_EXTRA="extra"
256	if $1 --version 2>&1 | grep -iq universal; then
257	    CTAGS_EXTRA="extras"
258	fi
259	setup_regex exuberant asm c
260	all_target_sources | xargs $1 -a                        \
261	-I __initdata,__exitdata,__initconst,__ro_after_init	\
262	-I __initdata_memblock					\
263	-I __refdata,__attribute,__maybe_unused,__always_unused \
264	-I __acquires,__releases,__deprecated,__always_inline	\
265	-I __read_mostly,__aligned,____cacheline_aligned        \
266	-I ____cacheline_aligned_in_smp                         \
267	-I __cacheline_aligned,__cacheline_aligned_in_smp	\
268	-I ____cacheline_internodealigned_in_smp                \
269	-I __used,__packed,__packed2__,__must_check,__must_hold	\
270	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
271	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
272	-I static,const						\
273	--$CTAGS_EXTRA=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
274	"${regex[@]}"
275
276	KCONFIG_ARGS=()
277	if ! $1 --list-languages | grep -iq kconfig; then
278		setup_regex exuberant kconfig
279		KCONFIG_ARGS=(--langdef=kconfig --language-force=kconfig "${regex[@]}")
280	fi
281	all_kconfigs | xargs $1 -a "${KCONFIG_ARGS[@]}"
282}
283
284emacs()
285{
286	setup_regex emacs asm c
287	all_target_sources | xargs $1 -a "${regex[@]}"
288
289	setup_regex emacs kconfig
290	all_kconfigs | xargs $1 -a "${regex[@]}"
291}
292
293xtags()
294{
295	if $1 --version 2>&1 | grep -iq exuberant; then
296		exuberant $1
297	elif $1 --version 2>&1 | grep -iq emacs; then
298		emacs $1
299	else
300		all_target_sources | xargs $1 -a
301	fi
302}
303
304# Support um (which uses SUBARCH)
305if [ "${ARCH}" = "um" ]; then
306	if [ "$SUBARCH" = "i386" ]; then
307		archinclude=x86
308	elif [ "$SUBARCH" = "x86_64" ]; then
309		archinclude=x86
310	else
311		archinclude=${SUBARCH}
312	fi
313fi
314
315remove_structs=
316case "$1" in
317	"cscope")
318		docscope
319		;;
320
321	"gtags")
322		dogtags
323		;;
324
325	"tags")
326		rm -f tags
327		xtags ctags
328		remove_structs=y
329		;;
330
331	"TAGS")
332		rm -f TAGS
333		xtags etags
334		remove_structs=y
335		;;
336esac
337
338# Remove structure forward declarations.
339if [ -n "$remove_structs" ]; then
340    LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
341fi
342