1#!/bin/sh
2# SPDX-License-Identifier: Apache-2.0
3# SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
4# Generate tags or cscope files
5# Usage tags.sh <mode>
6#
7# mode may be any of: tags, TAGS, cscope
8#
9# Uses the following environment variables:
10# ARCH, SOC, BOARD, ZEPHYR_BASE
11
12
13find_sources()
14{
15	find "$1" -name "$2"
16}
17
18# Looks for assembly, c and header files of selected architectures
19all_sources()
20{
21	for dir in $ALLSOURCES
22	do
23		find_sources "$dir" '*.[chS]'
24	done
25}
26
27all_target_sources()
28{
29	all_sources
30}
31
32all_kconfigs()
33{
34	for dir in $ALLSOURCES; do
35		find_sources $dir 'Kconfig*'
36	done
37}
38
39all_defconfigs()
40{
41	for dir in $ALLSOURCES; do
42		find_sources $dir 'defconfig*'
43	done
44}
45
46docscope()
47{
48	(echo \-k; echo \-q; all_target_sources) > cscope.files
49	cscope -b -f cscope.out
50}
51
52dogtags()
53{
54	all_target_sources | gtags -i -f -
55}
56
57exuberant()
58{
59	all_target_sources | xargs $1 -a                        \
60	-I __initdata,__exitdata,__initconst,			\
61	-I __initdata_memblock					\
62	-I __refdata,__attribute,__maybe_unused,__always_unused \
63	-I __acquires,__releases,__deprecated,__deprecated_version	\
64	-I __read_mostly,__aligned,____cacheline_aligned        \
65	-I ____cacheline_aligned_in_smp                         \
66	-I __cacheline_aligned,__cacheline_aligned_in_smp	\
67	-I ____cacheline_internodealigned_in_smp                \
68	-I __used,__packed,__packed2__,__must_check,__must_hold	\
69	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
70	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
71	-I static,const						\
72	--extra=+f --c-kinds=+px                                \
73	--regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/'        \
74	--regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
75	--regex-c='/^COMPAT_SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/compat_sys_\1/' \
76	--regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'		\
77	--regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1_rcuidle/'	\
78	--regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'	\
79	--regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1_rcuidle/' \
80	--regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/'			\
81	--regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/'			\
82	--regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
83	--regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'		\
84	--regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'			\
85	--regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'		\
86	--regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
87	--regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
88	--regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
89	--regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
90	--regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'	\
91	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
92	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'		\
93	--regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'		\
94	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'		\
95	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'		\
96	--regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'		\
97	--regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'	\
98	--regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/'	\
99	--regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
100	--regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
101	--regex-c++='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/'		\
102	--regex-c++='/TASK_PFA_TEST\([^,]*,\s*([^)]*)\)/task_\1/'	\
103	--regex-c++='/TASK_PFA_SET\([^,]*,\s*([^)]*)\)/task_set_\1/'	\
104	--regex-c++='/TASK_PFA_CLEAR\([^,]*,\s*([^)]*)\)/task_clear_\1/'\
105	--regex-c='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/' \
106	--regex-c='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/' \
107	--regex-c='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/'	\
108	--regex-c='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/'	\
109	--regex-c='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/'		\
110	--regex-c='/DECLARE_BITMAP\((\w*)/\1/v/'			\
111	--regex-c='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/'			\
112	--regex-c='/(^|\s)RADIX_TREE\((\w*)/\2/v/'			\
113	--regex-c='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/'		\
114	--regex-c='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
115	--regex-c='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/'		\
116	--regex-c='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/'	\
117	--regex-c='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/'		\
118	--regex-c='/(^\s)OFFSET\((\w*)/\2/v/'				\
119	--regex-c='/(^\s)DEFINE\((\w*)/\2/v/'				\
120	--regex-c='/DEFINE_HASHTABLE\((\w*)/\1/v/'
121
122	all_kconfigs | xargs $1 -a                              \
123	--langdef=kconfig --language-force=kconfig              \
124	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
125
126	all_kconfigs | xargs $1 -a                              \
127	--langdef=kconfig --language-force=kconfig              \
128	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
129
130	all_defconfigs | xargs -r $1 -a                         \
131	--langdef=dotconfig --language-force=dotconfig          \
132	--regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
133}
134
135emacs()
136{
137	all_target_sources | xargs $1 -a                        \
138	--regex='/^\(ENTRY\|_GLOBAL\)(\([^)]*\)).*/\2/'         \
139	--regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
140	--regex='/^COMPAT_SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/compat_sys_\1/' \
141	--regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'		\
142	--regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1_rcuidle/'	\
143	--regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
144	--regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1_rcuidle/' \
145	--regex='/PAGEFLAG(\([^,)]*\).*/Page\1/'			\
146	--regex='/PAGEFLAG(\([^,)]*\).*/SetPage\1/'		\
147	--regex='/PAGEFLAG(\([^,)]*\).*/ClearPage\1/'		\
148	--regex='/TESTSETFLAG(\([^,)]*\).*/TestSetPage\1/'	\
149	--regex='/TESTPAGEFLAG(\([^,)]*\).*/Page\1/'		\
150	--regex='/SETPAGEFLAG(\([^,)]*\).*/SetPage\1/'		\
151	--regex='/__SETPAGEFLAG(\([^,)]*\).*/__SetPage\1/'	\
152	--regex='/TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'	\
153	--regex='/__TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/'	\
154	--regex='/CLEARPAGEFLAG(\([^,)]*\).*/ClearPage\1/'	\
155	--regex='/__CLEARPAGEFLAG(\([^,)]*\).*/__ClearPage\1/'	\
156	--regex='/__PAGEFLAG(\([^,)]*\).*/__SetPage\1/'		\
157	--regex='/__PAGEFLAG(\([^,)]*\).*/__ClearPage\1/'	\
158	--regex='/PAGEFLAG_FALSE(\([^,)]*\).*/Page\1/'		\
159	--regex='/TESTSCFLAG(\([^,)]*\).*/TestSetPage\1/'	\
160	--regex='/TESTSCFLAG(\([^,)]*\).*/TestClearPage\1/'	\
161	--regex='/SETPAGEFLAG_NOOP(\([^,)]*\).*/SetPage\1/'	\
162	--regex='/CLEARPAGEFLAG_NOOP(\([^,)]*\).*/ClearPage\1/'	\
163	--regex='/__CLEARPAGEFLAG_NOOP(\([^,)]*\).*/__ClearPage\1/' \
164	--regex='/TESTCLEARFLAG_FALSE(\([^,)]*\).*/TestClearPage\1/' \
165	--regex='/__TESTCLEARFLAG_FALSE(\([^,)]*\).*/__TestClearPage\1/' \
166	--regex='/TASK_PFA_TEST\([^,]*,\s*([^)]*)\)/task_\1/'		\
167	--regex='/TASK_PFA_SET\([^,]*,\s*([^)]*)\)/task_set_\1/'	\
168	--regex='/TASK_PFA_CLEAR\([^,]*,\s*([^)]*)\)/task_clear_\1/'	\
169	--regex='/_PE(\([^,)]*\).*/PEVENT_ERRNO__\1/'		\
170	--regex='/PCI_OP_READ(\([a-z]*[a-z]\).*[1-4])/pci_bus_read_config_\1/' \
171	--regex='/PCI_OP_WRITE(\([a-z]*[a-z]\).*[1-4])/pci_bus_write_config_\1/'\
172	--regex='/[^#]*DEFINE_HASHTABLE(\([^,)]*\)/\1/'
173
174	all_kconfigs | xargs $1 -a                              \
175	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
176
177	all_kconfigs | xargs $1 -a                              \
178	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
179
180	all_defconfigs | xargs -r $1 -a                         \
181	--regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
182}
183
184xtags()
185{
186	if $1 --version 2>&1 | grep -iq exuberant; then
187		exuberant $1
188	elif $1 --version 2>&1 | grep -iq emacs; then
189		emacs $1
190	else
191		all_target_sources | xargs $1 -a
192	fi
193}
194
195
196# Used for debugging
197if [ "$TAGS_VERBOSE" = "1" ]; then
198	set -x
199fi
200
201# Set project base directory
202if [ "${ZEPHYR_BASE}" = "" ]; then
203	echo "error: run zephyr-env.sh before $0"
204	exit 1
205fi
206tree="${ZEPHYR_BASE}/"
207
208# List of always explored directories
209COMMON_DIRS="drivers dts include kernel lib misc subsys"
210
211# Detect if ARCH is set. If not, we look for all archs
212if [ "${ARCH}" = "" ]; then
213	ALLSOURCES="${COMMON_DIRS} arch boards soc"
214else
215	ALLSOURCES="${COMMON_DIRS} arch/${ARCH} boards/${ARCH} soc/${ARCH}"
216fi
217
218# TODO: detect if BOARD is set so we can select certain files
219
220
221# Perform main action
222remove_structs=
223case "$1" in
224	"cscope")
225		docscope
226		;;
227
228	"gtags")
229		dogtags
230		;;
231
232	"tags")
233		rm -f tags
234		xtags ctags
235		remove_structs=y
236		;;
237
238	"TAGS")
239		rm -f TAGS
240		xtags etags
241		remove_structs=y
242		;;
243	*)
244		echo "error: incorrect parameter"
245		;;
246esac
247
248# Remove structure forward declarations.
249if [ -n "$remove_structs" ]; then
250    LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
251fi
252