xref: /openbmc/linux/scripts/tags.sh (revision 7490ca1e)
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# This is a duplicate of RCS_FIND_IGNORE without escaped '()'
15ignore="( -name SCCS -o -name BitKeeper -o -name .svn -o \
16          -name CVS  -o -name .pc       -o -name .hg  -o \
17          -name .git )                                   \
18          -prune -o"
19
20# Do not use full path if we do not use O=.. builds
21# Use make O=. {tags|cscope}
22# to force full paths for a non-O= build
23if [ "${KBUILD_SRC}" = "" ]; then
24	tree=
25else
26	tree=${srctree}/
27fi
28
29# Find all available archs
30find_all_archs()
31{
32	ALLSOURCE_ARCHS=""
33	for arch in `ls ${tree}arch`; do
34		ALLSOURCE_ARCHS="${ALLSOURCE_ARCHS} "${arch##\/}
35	done
36}
37
38# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
39if [ "${ALLSOURCE_ARCHS}" = "" ]; then
40	ALLSOURCE_ARCHS=${SRCARCH}
41elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
42	find_all_archs
43fi
44
45# find sources in arch/$ARCH
46find_arch_sources()
47{
48	for i in $archincludedir; do
49		prune="$prune -wholename $i -prune -o"
50	done
51	find ${tree}arch/$1 $ignore $prune -name "$2" -print;
52}
53
54# find sources in arch/$1/include
55find_arch_include_sources()
56{
57	include=$(find ${tree}arch/$1/ -name include -type d);
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_kconfigs()
99{
100	for arch in $ALLSOURCE_ARCHS; do
101		find_sources $arch 'Kconfig*'
102	done
103	find_other_sources 'Kconfig*'
104}
105
106all_defconfigs()
107{
108	find_sources $ALLSOURCE_ARCHS "defconfig"
109}
110
111docscope()
112{
113	(echo \-k; echo \-q; all_sources) > cscope.files
114	cscope -b -f cscope.out
115}
116
117dogtags()
118{
119	all_sources | gtags -f -
120}
121
122exuberant()
123{
124	all_sources | xargs $1 -a                               \
125	-I __initdata,__exitdata,__acquires,__releases          \
126	-I __read_mostly,____cacheline_aligned                  \
127	-I ____cacheline_aligned_in_smp                         \
128	-I ____cacheline_internodealigned_in_smp                \
129	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL                      \
130	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
131	--extra=+f --c-kinds=+px                                \
132	--regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/'        \
133	--regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
134	--regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'		\
135	--regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/'	\
136	--regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/'			\
137	--regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/'			\
138	--regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
139	--regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'		\
140	--regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'			\
141	--regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'		\
142	--regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
143	--regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
144	--regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
145	--regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
146	--regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'	\
147	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
148	--regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'		\
149	--regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'		\
150	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'		\
151	--regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'		\
152	--regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'		\
153	--regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'	\
154	--regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/'	\
155	--regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
156	--regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/'
157
158	all_kconfigs | xargs $1 -a                              \
159	--langdef=kconfig --language-force=kconfig              \
160	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
161
162	all_kconfigs | xargs $1 -a                              \
163	--langdef=kconfig --language-force=kconfig              \
164	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
165
166	all_defconfigs | xargs -r $1 -a                         \
167	--langdef=dotconfig --language-force=dotconfig          \
168	--regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
169
170	# Remove structure forward declarations.
171	LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' tags
172}
173
174emacs()
175{
176	all_sources | xargs $1 -a                               \
177	--regex='/^(ENTRY|_GLOBAL)(\([^)]*\)).*/\2/'            \
178	--regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'   \
179	--regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/'		\
180	--regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
181	--regex='/PAGEFLAG\(([^,)]*).*/Page\1/'			\
182	--regex='/PAGEFLAG\(([^,)]*).*/SetPage\1/'		\
183	--regex='/PAGEFLAG\(([^,)]*).*/ClearPage\1/'		\
184	--regex='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/'	\
185	--regex='/TESTPAGEFLAG\(([^,)]*).*/Page\1/'		\
186	--regex='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/'		\
187	--regex='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/'	\
188	--regex='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
189	--regex='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/'	\
190	--regex='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/'	\
191	--regex='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/'	\
192	--regex='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/'		\
193	--regex='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/'	\
194	--regex='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/'		\
195	--regex='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/'	\
196	--regex='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/'	\
197	--regex='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/'	\
198	--regex='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/'	\
199	--regex='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/' \
200	--regex='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
201	--regex='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/'
202
203	all_kconfigs | xargs $1 -a                              \
204	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
205
206	all_kconfigs | xargs $1 -a                              \
207	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
208
209	all_defconfigs | xargs -r $1 -a                         \
210	--regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
211}
212
213xtags()
214{
215	if $1 --version 2>&1 | grep -iq exuberant; then
216		exuberant $1
217	elif $1 --version 2>&1 | grep -iq emacs; then
218		emacs $1
219	else
220		all_sources | xargs $1 -a
221        fi
222}
223
224
225# Support um (which uses SUBARCH)
226if [ "${ARCH}" = "um" ]; then
227	if [ "$SUBARCH" = "i386" ]; then
228		archinclude=x86
229	elif [ "$SUBARCH" = "x86_64" ]; then
230		archinclude=x86
231	else
232		archinclude=${SUBARCH}
233	fi
234fi
235
236case "$1" in
237	"cscope")
238		docscope
239		;;
240
241	"gtags")
242		dogtags
243		;;
244
245	"tags")
246		rm -f tags
247		xtags ctags
248		;;
249
250	"TAGS")
251		rm -f TAGS
252		xtags etags
253		;;
254esac
255