blob: 58c4559290915594e1bd18a67770d0d4bafdc6e3 [file] [log] [blame]
Sam Ravnborga680eed2008-12-03 22:24:13 +01001#!/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:
Michal Mareka8bac512010-02-19 16:18:41 +01008# ARCH, SUBARCH, SRCARCH, srctree, src, obj
Sam Ravnborga680eed2008-12-03 22:24:13 +01009
Jiri Slabya6ba0cb2008-12-10 13:48:38 +010010if [ "$KBUILD_VERBOSE" = "1" ]; then
Sam Ravnborga680eed2008-12-03 22:24:13 +010011 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
John Kacur4431d4c2010-03-02 15:38:10 +010020# Do not use full path if we do not use O=.. builds
Michal Mareke93bc1a2010-03-08 10:26:22 +010021# Use make O=. {tags|cscope}
22# to force full paths for a non-O= build
Jiri Slabya6ba0cb2008-12-10 13:48:38 +010023if [ "${KBUILD_SRC}" = "" ]; then
Sam Ravnborga680eed2008-12-03 22:24:13 +010024 tree=
25else
Jiri Slaby709cc372008-12-10 13:10:13 +010026 tree=${srctree}/
Sam Ravnborga680eed2008-12-03 22:24:13 +010027fi
28
John Kacurbc75cc62010-03-02 16:57:52 +010029# 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
Jike Song4f628242009-01-05 14:57:03 +080038# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
39if [ "${ALLSOURCE_ARCHS}" = "" ]; then
40 ALLSOURCE_ARCHS=${SRCARCH}
John Kacurbc75cc62010-03-02 16:57:52 +010041elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
42 find_all_archs
Jike Song4f628242009-01-05 14:57:03 +080043fi
44
Sam Ravnborga680eed2008-12-03 22:24:13 +010045# find sources in arch/$ARCH
46find_arch_sources()
47{
Guennadi Liakhovetskif81b1be2010-02-08 00:25:59 +010048 for i in $archincludedir; do
49 prune="$prune -wholename $i -prune -o"
50 done
Joonsoo Kim59658502012-12-11 00:11:45 +090051 find ${tree}arch/$1 $ignore $subarchprune $prune -name "$2" -print;
Sam Ravnborga680eed2008-12-03 22:24:13 +010052}
53
54# find sources in arch/$1/include
55find_arch_include_sources()
56{
Joonsoo Kim59658502012-12-11 00:11:45 +090057 include=$(find ${tree}arch/$1/ $subarchprune \
58 -name include -type d -print);
Guennadi Liakhovetskif81b1be2010-02-08 00:25:59 +010059 if [ -n "$include" ]; then
60 archincludedir="$archincludedir $include"
61 find $include $ignore -name "$2" -print;
62 fi
Sam Ravnborga680eed2008-12-03 22:24:13 +010063}
64
65# find sources in include/
66find_include_sources()
67{
Jiri Slaby709cc372008-12-10 13:10:13 +010068 find ${tree}include $ignore -name config -prune -o -name "$1" -print;
Sam Ravnborga680eed2008-12-03 22:24:13 +010069}
70
71# find sources in rest of tree
72# we could benefit from a list of dirs to search in here
73find_other_sources()
74{
75 find ${tree}* $ignore \
76 \( -name include -o -name arch -o -name '.tmp_*' \) -prune -o \
Jiri Slaby709cc372008-12-10 13:10:13 +010077 -name "$1" -print;
Sam Ravnborga680eed2008-12-03 22:24:13 +010078}
79
80find_sources()
81{
Jiri Slaby709cc372008-12-10 13:10:13 +010082 find_arch_sources $1 "$2"
Sam Ravnborga680eed2008-12-03 22:24:13 +010083}
84
85all_sources()
86{
Michal Mareka8bac512010-02-19 16:18:41 +010087 find_arch_include_sources ${SRCARCH} '*.[chS]'
Sam Ravnborga680eed2008-12-03 22:24:13 +010088 if [ ! -z "$archinclude" ]; then
Jiri Slaby709cc372008-12-10 13:10:13 +010089 find_arch_include_sources $archinclude '*.[chS]'
Sam Ravnborga680eed2008-12-03 22:24:13 +010090 fi
Jike Song4f628242009-01-05 14:57:03 +080091 find_include_sources '*.[chS]'
Guennadi Liakhovetskif81b1be2010-02-08 00:25:59 +010092 for arch in $ALLSOURCE_ARCHS
93 do
94 find_sources $arch '*.[chS]'
95 done
Jike Song4f628242009-01-05 14:57:03 +080096 find_other_sources '*.[chS]'
Sam Ravnborga680eed2008-12-03 22:24:13 +010097}
98
Joonsoo Kim923e02e2012-12-11 00:11:46 +090099all_compiled_sources()
100{
101 for i in $(all_sources); do
102 case "$i" in
103 *.[cS])
104 j=${i/\.[cS]/\.o}
105 if [ -e $j ]; then
106 echo $i
107 fi
108 ;;
109 *)
110 echo $i
111 ;;
112 esac
113 done
114}
115
116all_target_sources()
117{
118 if [ -n "$COMPILED_SOURCE" ]; then
119 all_compiled_sources
120 else
121 all_sources
122 fi
123}
124
Sam Ravnborga680eed2008-12-03 22:24:13 +0100125all_kconfigs()
126{
Alexey Dobriyan953fae62009-02-11 13:24:09 -0800127 for arch in $ALLSOURCE_ARCHS; do
128 find_sources $arch 'Kconfig*'
129 done
130 find_other_sources 'Kconfig*'
Sam Ravnborga680eed2008-12-03 22:24:13 +0100131}
132
133all_defconfigs()
134{
Jike Song4f628242009-01-05 14:57:03 +0800135 find_sources $ALLSOURCE_ARCHS "defconfig"
Sam Ravnborga680eed2008-12-03 22:24:13 +0100136}
137
138docscope()
139{
Joonsoo Kim923e02e2012-12-11 00:11:46 +0900140 (echo \-k; echo \-q; all_target_sources) > cscope.files
Sam Ravnborga680eed2008-12-03 22:24:13 +0100141 cscope -b -f cscope.out
142}
143
Jianbin Kangf4ed1002011-01-14 20:07:05 +0800144dogtags()
145{
Joonsoo Kim923e02e2012-12-11 00:11:46 +0900146 all_target_sources | gtags -i -f -
Jianbin Kangf4ed1002011-01-14 20:07:05 +0800147}
148
Sam Ravnborga680eed2008-12-03 22:24:13 +0100149exuberant()
150{
Joonsoo Kim923e02e2012-12-11 00:11:46 +0900151 all_target_sources | xargs $1 -a \
Michael Opdenacker6cf3a6e2013-11-07 12:09:51 +1100152 -I __initdata,__exitdata,__initconst, \
153 -I __cpuinitdata,__initdata_memblock \
Kirill Tkhaif5a82132013-10-23 15:08:44 +0200154 -I __refdata,__attribute,__maybe_unused,__always_unused \
Kirill Tkhai1b2643f2013-02-21 16:42:42 -0800155 -I __acquires,__releases,__deprecated \
156 -I __read_mostly,__aligned,____cacheline_aligned \
Sam Ravnborga680eed2008-12-03 22:24:13 +0100157 -I ____cacheline_aligned_in_smp \
Kirill Tkhaif5a82132013-10-23 15:08:44 +0200158 -I __cacheline_aligned,__cacheline_aligned_in_smp \
Sam Ravnborga680eed2008-12-03 22:24:13 +0100159 -I ____cacheline_internodealigned_in_smp \
Kirill Tkhai1b2643f2013-02-21 16:42:42 -0800160 -I __used,__packed,__packed2__,__must_check,__must_hold \
Kirill Tkhaif5a82132013-10-23 15:08:44 +0200161 -I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL \
Stefani Seibold7db86dc92009-09-18 12:49:24 -0700162 -I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
Kirill Tkhai1b2643f2013-02-21 16:42:42 -0800163 -I static,const \
Uwe Kleine-König0a18a932010-11-04 10:24:16 +0100164 --extra=+f --c-kinds=+px \
Ian Munsie9c654262011-08-30 11:47:58 +1000165 --regex-asm='/^(ENTRY|_GLOBAL)\(([^)]*)\).*/\2/' \
Peter Zijlstra15664122010-11-24 10:43:55 +0100166 --regex-c='/^SYSCALL_DEFINE[[:digit:]]?\(([^,)]*).*/sys_\1/' \
167 --regex-c++='/^TRACE_EVENT\(([^,)]*).*/trace_\1/' \
Stephen Boyd358142d2011-11-03 10:09:57 -0700168 --regex-c++='/^DEFINE_EVENT\([^,)]*, *([^,)]*).*/trace_\1/' \
169 --regex-c++='/PAGEFLAG\(([^,)]*).*/Page\1/' \
170 --regex-c++='/PAGEFLAG\(([^,)]*).*/SetPage\1/' \
171 --regex-c++='/PAGEFLAG\(([^,)]*).*/ClearPage\1/' \
172 --regex-c++='/TESTSETFLAG\(([^,)]*).*/TestSetPage\1/' \
173 --regex-c++='/TESTPAGEFLAG\(([^,)]*).*/Page\1/' \
174 --regex-c++='/SETPAGEFLAG\(([^,)]*).*/SetPage\1/' \
175 --regex-c++='/__SETPAGEFLAG\(([^,)]*).*/__SetPage\1/' \
176 --regex-c++='/TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/' \
177 --regex-c++='/__TESTCLEARFLAG\(([^,)]*).*/TestClearPage\1/' \
178 --regex-c++='/CLEARPAGEFLAG\(([^,)]*).*/ClearPage\1/' \
179 --regex-c++='/__CLEARPAGEFLAG\(([^,)]*).*/__ClearPage\1/' \
180 --regex-c++='/__PAGEFLAG\(([^,)]*).*/__SetPage\1/' \
181 --regex-c++='/__PAGEFLAG\(([^,)]*).*/__ClearPage\1/' \
182 --regex-c++='/PAGEFLAG_FALSE\(([^,)]*).*/Page\1/' \
183 --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestSetPage\1/' \
184 --regex-c++='/TESTSCFLAG\(([^,)]*).*/TestClearPage\1/' \
185 --regex-c++='/SETPAGEFLAG_NOOP\(([^,)]*).*/SetPage\1/' \
186 --regex-c++='/CLEARPAGEFLAG_NOOP\(([^,)]*).*/ClearPage\1/' \
187 --regex-c++='/__CLEARPAGEFLAG_NOOP\(([^,)]*).*/__ClearPage\1/' \
188 --regex-c++='/TESTCLEARFLAG_FALSE\(([^,)]*).*/TestClearPage\1/' \
Namhyung Kim1fa85052012-06-18 11:50:51 +0900189 --regex-c++='/__TESTCLEARFLAG_FALSE\(([^,)]*).*/__TestClearPage\1/' \
Kirill Tkhai22beb562012-08-24 13:50:28 +0400190 --regex-c++='/_PE\(([^,)]*).*/PEVENT_ERRNO__\1/' \
Kirill Tkhai1b2643f2013-02-21 16:42:42 -0800191 --regex-c='/PCI_OP_READ\((\w*).*[1-4]\)/pci_bus_read_config_\1/' \
192 --regex-c='/PCI_OP_WRITE\((\w*).*[1-4]\)/pci_bus_write_config_\1/' \
193 --regex-c='/DEFINE_(MUTEX|SEMAPHORE|SPINLOCK)\((\w*)/\2/v/' \
194 --regex-c='/DEFINE_(RAW_SPINLOCK|RWLOCK|SEQLOCK)\((\w*)/\2/v/' \
195 --regex-c='/DECLARE_(RWSEM|COMPLETION)\((\w*)/\2/v/' \
196 --regex-c='/DECLARE_BITMAP\((\w*)/\1/v/' \
197 --regex-c='/(^|\s)(|L|H)LIST_HEAD\((\w*)/\3/v/' \
198 --regex-c='/(^|\s)RADIX_TREE\((\w*)/\2/v/' \
199 --regex-c='/DEFINE_PER_CPU\(([^,]*,\s*)(\w*).*\)/\2/v/' \
200 --regex-c='/DEFINE_PER_CPU_SHARED_ALIGNED\(([^,]*,\s*)(\w*).*\)/\2/v/' \
201 --regex-c='/DECLARE_WAIT_QUEUE_HEAD\((\w*)/\1/v/' \
202 --regex-c='/DECLARE_(TASKLET|WORK|DELAYED_WORK)\((\w*)/\2/v/' \
Kirill Tkhai987d0c82013-03-23 14:58:20 +0400203 --regex-c='/DEFINE_PCI_DEVICE_TABLE\((\w*)/\1/v/' \
204 --regex-c='/(^\s)OFFSET\((\w*)/\2/v/' \
205 --regex-c='/(^\s)DEFINE\((\w*)/\2/v/'
Sam Ravnborga680eed2008-12-03 22:24:13 +0100206
207 all_kconfigs | xargs $1 -a \
208 --langdef=kconfig --language-force=kconfig \
209 --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/\2/'
210
211 all_kconfigs | xargs $1 -a \
212 --langdef=kconfig --language-force=kconfig \
213 --regex-kconfig='/^[[:blank:]]*(menu|)config[[:blank:]]+([[:alnum:]_]+)/CONFIG_\2/'
214
215 all_defconfigs | xargs -r $1 -a \
216 --langdef=dotconfig --language-force=dotconfig \
217 --regex-dotconfig='/^#?[[:blank:]]*(CONFIG_[[:alnum:]_]+)/\1/'
Sam Ravnborga680eed2008-12-03 22:24:13 +0100218}
219
220emacs()
221{
Joonsoo Kim923e02e2012-12-11 00:11:46 +0900222 all_target_sources | xargs $1 -a \
Andreas Schwab9f14b422012-12-29 00:08:22 +0100223 --regex='/^\(ENTRY\|_GLOBAL\)(\([^)]*\)).*/\2/' \
Steven Rostedt4d7a2fa2011-05-19 14:43:57 -0400224 --regex='/^SYSCALL_DEFINE[0-9]?(\([^,)]*\).*/sys_\1/' \
225 --regex='/^TRACE_EVENT(\([^,)]*\).*/trace_\1/' \
Stephen Boyd358142d2011-11-03 10:09:57 -0700226 --regex='/^DEFINE_EVENT([^,)]*, *\([^,)]*\).*/trace_\1/' \
Andreas Schwab9f14b422012-12-29 00:08:22 +0100227 --regex='/PAGEFLAG(\([^,)]*\).*/Page\1/' \
228 --regex='/PAGEFLAG(\([^,)]*\).*/SetPage\1/' \
229 --regex='/PAGEFLAG(\([^,)]*\).*/ClearPage\1/' \
230 --regex='/TESTSETFLAG(\([^,)]*\).*/TestSetPage\1/' \
231 --regex='/TESTPAGEFLAG(\([^,)]*\).*/Page\1/' \
232 --regex='/SETPAGEFLAG(\([^,)]*\).*/SetPage\1/' \
233 --regex='/__SETPAGEFLAG(\([^,)]*\).*/__SetPage\1/' \
234 --regex='/TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/' \
235 --regex='/__TESTCLEARFLAG(\([^,)]*\).*/TestClearPage\1/' \
236 --regex='/CLEARPAGEFLAG(\([^,)]*\).*/ClearPage\1/' \
237 --regex='/__CLEARPAGEFLAG(\([^,)]*\).*/__ClearPage\1/' \
238 --regex='/__PAGEFLAG(\([^,)]*\).*/__SetPage\1/' \
239 --regex='/__PAGEFLAG(\([^,)]*\).*/__ClearPage\1/' \
240 --regex='/PAGEFLAG_FALSE(\([^,)]*\).*/Page\1/' \
241 --regex='/TESTSCFLAG(\([^,)]*\).*/TestSetPage\1/' \
242 --regex='/TESTSCFLAG(\([^,)]*\).*/TestClearPage\1/' \
243 --regex='/SETPAGEFLAG_NOOP(\([^,)]*\).*/SetPage\1/' \
244 --regex='/CLEARPAGEFLAG_NOOP(\([^,)]*\).*/ClearPage\1/' \
245 --regex='/__CLEARPAGEFLAG_NOOP(\([^,)]*\).*/__ClearPage\1/' \
246 --regex='/TESTCLEARFLAG_FALSE(\([^,)]*\).*/TestClearPage\1/' \
247 --regex='/__TESTCLEARFLAG_FALSE(\([^,)]*\).*/__TestClearPage\1/' \
248 --regex='/_PE(\([^,)]*\).*/PEVENT_ERRNO__\1/' \
249 --regex='/PCI_OP_READ(\([a-z]*[a-z]\).*[1-4])/pci_bus_read_config_\1/' \
250 --regex='/PCI_OP_WRITE(\([a-z]*[a-z]\).*[1-4])/pci_bus_write_config_\1/'
Sam Ravnborga680eed2008-12-03 22:24:13 +0100251
252 all_kconfigs | xargs $1 -a \
253 --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/\3/'
254
255 all_kconfigs | xargs $1 -a \
256 --regex='/^[ \t]*\(\(menu\)*config\)[ \t]+\([a-zA-Z0-9_]+\)/CONFIG_\3/'
257
258 all_defconfigs | xargs -r $1 -a \
259 --regex='/^#?[ \t]?\(CONFIG_[a-zA-Z0-9_]+\)/\1/'
260}
261
262xtags()
263{
264 if $1 --version 2>&1 | grep -iq exuberant; then
265 exuberant $1
266 elif $1 --version 2>&1 | grep -iq emacs; then
267 emacs $1
268 else
Joonsoo Kim923e02e2012-12-11 00:11:46 +0900269 all_target_sources | xargs $1 -a
Sam Ravnborga680eed2008-12-03 22:24:13 +0100270 fi
271}
272
Sam Ravnborga680eed2008-12-03 22:24:13 +0100273# Support um (which uses SUBARCH)
Jiri Slabya6ba0cb2008-12-10 13:48:38 +0100274if [ "${ARCH}" = "um" ]; then
275 if [ "$SUBARCH" = "i386" ]; then
Sam Ravnborga680eed2008-12-03 22:24:13 +0100276 archinclude=x86
Jiri Slabya6ba0cb2008-12-10 13:48:38 +0100277 elif [ "$SUBARCH" = "x86_64" ]; then
Sam Ravnborga680eed2008-12-03 22:24:13 +0100278 archinclude=x86
279 else
280 archinclude=${SUBARCH}
281 fi
Joonsoo Kim59658502012-12-11 00:11:45 +0900282elif [ "${SRCARCH}" = "arm" -a "${SUBARCH}" != "" ]; then
283 subarchdir=$(find ${tree}arch/$SRCARCH/ -name "mach-*" -type d -o \
284 -name "plat-*" -type d);
285 for i in $subarchdir; do
286 case "$i" in
287 *"mach-"${SUBARCH})
288 ;;
289 *"plat-"${SUBARCH})
290 ;;
291 *)
292 subarchprune="$subarchprune \
293 -wholename $i -prune -o"
294 ;;
295 esac
296 done
Sam Ravnborga680eed2008-12-03 22:24:13 +0100297fi
298
Yang Bai66979222012-03-12 16:20:51 +0800299remove_structs=
Sam Ravnborga680eed2008-12-03 22:24:13 +0100300case "$1" in
301 "cscope")
302 docscope
303 ;;
304
Jianbin Kangf4ed1002011-01-14 20:07:05 +0800305 "gtags")
306 dogtags
307 ;;
308
Sam Ravnborga680eed2008-12-03 22:24:13 +0100309 "tags")
Matt Kraai2e6cb8b2009-04-21 20:38:23 -0700310 rm -f tags
Sam Ravnborga680eed2008-12-03 22:24:13 +0100311 xtags ctags
Yang Bai66979222012-03-12 16:20:51 +0800312 remove_structs=y
Sam Ravnborga680eed2008-12-03 22:24:13 +0100313 ;;
314
315 "TAGS")
Matt Kraai2e6cb8b2009-04-21 20:38:23 -0700316 rm -f TAGS
Sam Ravnborga680eed2008-12-03 22:24:13 +0100317 xtags etags
Yang Bai66979222012-03-12 16:20:51 +0800318 remove_structs=y
Sam Ravnborga680eed2008-12-03 22:24:13 +0100319 ;;
320esac
Yang Bai66979222012-03-12 16:20:51 +0800321
322# Remove structure forward declarations.
Stephen Boyd0eb043d2012-03-31 23:41:07 -0700323if [ -n "$remove_structs" ]; then
Yang Bai66979222012-03-12 16:20:51 +0800324 LANG=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
325fi