Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 '/^SYM_[[:alnum:]_]*START[[:alnum:]_]*([[:space:]]*\([[:alnum:]_\\]*\)).*/\1/'
150)
151regex_c=(
152 '/^SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/sys_\1/'
153 '/^BPF_CALL_[0-9]([[:space:]]*\([[:alnum:]_]*\).*/\1/'
154 '/^COMPAT_SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/compat_sys_\1/'
155 '/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
156 '/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
157 '/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/get_\1_slot/'
158 '/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/free_\1_slot/'
159 '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
160 '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
161 '/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
162 '/^TESTSETFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
163 '/^TESTPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
164 '/^SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
165 '/\<__SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
166 '/\<TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
167 '/\<__TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
168 '/\<CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
169 '/\<__CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
170 '/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
171 '/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
172 '/^PAGEFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
173 '/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
174 '/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
175 '/\<SETPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
176 '/\<CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
177 '/\<__CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
178 '/\<TESTCLEARFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
179 '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
180 '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
181 '/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
182 '/^TASK_PFA_TEST([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_\1/'
183 '/^TASK_PFA_SET([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_set_\1/'
184 '/^TASK_PFA_CLEAR([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_clear_\1/'
185 '/^DEF_MMIO_\(IN\|OUT\)_[XD]([[:space:]]*\([[:alnum:]_]*\),[^)]*)/\2/'
186 '/^DEBUGGER_BOILERPLATE([[:space:]]*\([[:alnum:]_]*\))/\1/'
187 '/^DEF_PCI_AC_\(\|NO\)RET([[:space:]]*\([[:alnum:]_]*\).*/\2/'
188 '/^PCI_OP_READ([[:space:]]*\(\w*\).*[1-4])/pci_bus_read_config_\1/'
189 '/^PCI_OP_WRITE([[:space:]]*\(\w*\).*[1-4])/pci_bus_write_config_\1/'
190 '/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
191 '/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
192 '/\<DEFINE_TIMER(\([^,)]*\),/\1/'
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 '/^\<DECLARE_IDTENTRY[[:alnum:]_]*([^,)]*,[[:space:]]*\([[:alnum:]_]\+\)/\1/'
216 '/^\<DEFINE_IDTENTRY[[:alnum:]_]*([[:space:]]*\([[:alnum:]_]\+\)/\1/'
217 '/^\<DEFINE_FREE(\([[:alnum:]_]\+\)/cleanup_\1/'
218 '/^\<DEFINE_CLASS(\([[:alnum:]_]\+\)/class_\1/'
219 '/^\<EXTEND_CLASS(\([[:alnum:]_]\+\),[[:space:]]*\([[:alnum:]_]\+\)/class_\1\2/'
220 '/^\<DEFINE_GUARD(\([[:alnum:]_]\+\)/class_\1/'
221 '/^\<DEFINE_GUARD_COND(\([[:alnum:]_]\+\),[[:space:]]*\([[:alnum:]_]\+\)/class_\1\2/'
222 '/^\<DEFINE_LOCK_GUARD_[[:digit:]](\([[:alnum:]_]\+\)/class_\1/'
223 '/^\<DEFINE_LOCK_GUARD_[[:digit:]]_COND(\([[:alnum:]_]\+\),[[:space:]]*\([[:alnum:]_]\+\)/class_\1\2/'
224)
225regex_kconfig=(
226 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
227 '/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
228)
229setup_regex()
230{
231 local mode=$1 lang tmp=() r
232 shift
233
234 regex=()
235 for lang; do
236 case "$lang" in
237 asm) tmp=("${regex_asm[@]}") ;;
238 c) tmp=("${regex_c[@]}") ;;
239 kconfig) tmp=("${regex_kconfig[@]}") ;;
240 esac
241 for r in "${tmp[@]}"; do
242 if test "$mode" = "exuberant"; then
243 regex[${#regex[@]}]="--regex-$lang=${r}b"
244 else
245 # Remove ctags /kind-spec/
246 case "$r" in
247 /*/*/?/)
248 r=${r%?/}
249 esac
250 # Prepend ^[^#] unless already anchored
251 case "$r" in
252 /^*) ;;
253 *)
254 r="/^[^#]*${r#/}"
255 esac
256 regex[${#regex[@]}]="--regex=$r"
257 fi
258 done
259 done
260}
261
262exuberant()
263{
264 CTAGS_EXTRA="extra"
265 if $1 --version 2>&1 | grep -iq universal; then
266 CTAGS_EXTRA="extras"
267 fi
268 setup_regex exuberant asm c
269 # identifiers to ignore by ctags
270 local ign=(
271 ACPI_EXPORT_SYMBOL
272 DECLARE_BITMAP
273 DEFINE_{TRACE,MUTEX,TIMER}
274 EXPORT_SYMBOL EXPORT_SYMBOL_GPL
275 EXPORT_TRACEPOINT_SYMBOL EXPORT_TRACEPOINT_SYMBOL_GPL
276 ____cacheline_aligned ____cacheline_aligned_in_smp
277 ____cacheline_internodealigned_in_smp
278 __acquires __aligned __always_inline __always_unused
279 __attribute
280 __cacheline_aligned __cacheline_aligned_in_smp
281 __deprecated
282 __exitdata
283 __initconst __initdata __initdata_memblock
284 __maybe_unused __must_check __must_hold
285 __packed __packed2__
286 __read_mostly __refdata __releases __ro_after_init
287 __used
288 const
289 static
290 )
291 all_target_sources | \
292 xargs $1 -a -I "$(IFS=','; echo "${ign[*]}")" \
293 --$CTAGS_EXTRA=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
294 "${regex[@]}"
295
296 KCONFIG_ARGS=()
297 if ! $1 --list-languages | grep -iq kconfig; then
298 setup_regex exuberant kconfig
299 KCONFIG_ARGS=(--langdef=kconfig --language-force=kconfig "${regex[@]}")
300 fi
301 all_kconfigs | xargs $1 -a "${KCONFIG_ARGS[@]}"
302}
303
304emacs()
305{
306 setup_regex emacs asm c
307 all_target_sources | xargs $1 -a "${regex[@]}"
308
309 setup_regex emacs kconfig
310 all_kconfigs | xargs $1 -a "${regex[@]}"
311}
312
313xtags()
314{
315 if $1 --version 2>&1 | grep -iq exuberant; then
316 exuberant $1
317 elif $1 --version 2>&1 | grep -iq emacs; then
318 emacs $1
319 else
320 all_target_sources | xargs $1 -a
321 fi
322}
323
324# Support um (which uses SUBARCH)
325if [ "${ARCH}" = "um" ]; then
326 if [ "$SUBARCH" = "i386" ]; then
327 archinclude=x86
328 elif [ "$SUBARCH" = "x86_64" ]; then
329 archinclude=x86
330 else
331 archinclude=${SUBARCH}
332 fi
333fi
334
335remove_structs=
336case "$1" in
337 "cscope")
338 docscope
339 ;;
340
341 "gtags")
342 dogtags
343 ;;
344
345 "tags")
346 rm -f tags
347 xtags ${CTAGS:-ctags}
348 remove_structs=y
349 ;;
350
351 "TAGS")
352 rm -f TAGS
353 xtags etags
354 remove_structs=y
355 ;;
356esac
357
358# Remove structure forward declarations.
359if [ -n "$remove_structs" ]; then
360 LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
361fi