xref: /linux-6.15/scripts/tags.sh (revision facb4edc)
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
117exuberant()
118{
119	all_sources | xargs $1 -a                               \
120	-I __initdata,__exitdata,__acquires,__releases          \
121	-I __read_mostly,____cacheline_aligned                  \
122	-I ____cacheline_aligned_in_smp                         \
123	-I ____cacheline_internodealigned_in_smp                \
124	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL                      \
125	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
126	--extra=+f --c-kinds=-px                                \
127	--regex-asm='/^ENTRY\(([^)]*)\).*/\1/'                  \
128	--regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
129	--regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/'		\
130	--regex-c++='/^DEFINE_EVENT\(([^,)]*).*/trace_\1/'
131
132	all_kconfigs | xargs $1 -a                              \
133	--langdef=kconfig --language-force=kconfig              \
134	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
135
136	all_kconfigs | xargs $1 -a                              \
137	--langdef=kconfig --language-force=kconfig              \
138	--regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
139
140	all_defconfigs | xargs -r $1 -a                         \
141	--langdef=dotconfig --language-force=dotconfig          \
142	--regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
143
144}
145
146emacs()
147{
148	all_sources | xargs $1 -a                               \
149	--regex='/^ENTRY(\([^)]*\)).*/\1/'                      \
150	--regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/'
151
152	all_kconfigs | xargs $1 -a                              \
153	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
154
155	all_kconfigs | xargs $1 -a                              \
156	--regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
157
158	all_defconfigs | xargs -r $1 -a                         \
159	--regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
160}
161
162xtags()
163{
164	if $1 --version 2>&1 | grep -iq exuberant; then
165		exuberant $1
166	elif $1 --version 2>&1 | grep -iq emacs; then
167		emacs $1
168	else
169		all_sources | xargs $1 -a
170        fi
171}
172
173
174# Support um (which uses SUBARCH)
175if [ "${ARCH}" = "um" ]; then
176	if [ "$SUBARCH" = "i386" ]; then
177		archinclude=x86
178	elif [ "$SUBARCH" = "x86_64" ]; then
179		archinclude=x86
180	else
181		archinclude=${SUBARCH}
182	fi
183fi
184
185case "$1" in
186	"cscope")
187		docscope
188		;;
189
190	"tags")
191		rm -f tags
192		xtags ctags
193		;;
194
195	"TAGS")
196		rm -f TAGS
197		xtags etags
198		;;
199esac
200