[linux.git] / scripts / tags.sh

#!/bin/bash
# SPDX-License-Identifier: GPL-2.0-only
# Generate tags or cscope files
# Usage tags.sh <mode>
#
# mode may be any of: tags, TAGS, cscope
#
# Uses the following environment variables:
# SUBARCH, SRCARCH, srctree

if [ "$KBUILD_VERBOSE" = "1" ]; then
	set -x
fi

# RCS_FIND_IGNORE has escaped ()s -- remove them.
ignore="$(echo "$RCS_FIND_IGNORE" | sed 's|\\||g' )"
# tags and cscope files should also ignore MODVERSION *.mod.c files
ignore="$ignore ( -name *.mod.c ) -prune -o"

# Use make KBUILD_ABS_SRCTREE=1 {tags|cscope}
# to force full paths for a non-O= build
if [ "${srctree}" = "." -o -z "${srctree}" ]; then
	tree=
else
	tree=${srctree}/
fi

# ignore userspace tools
if [ -n "$COMPILED_SOURCE" ]; then
	ignore="$ignore ( -path ./tools ) -prune -o"
else
	ignore="$ignore ( -path ${tree}tools ) -prune -o"
fi

# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
if [ "${ALLSOURCE_ARCHS}" = "" ]; then
	ALLSOURCE_ARCHS=${SRCARCH}
elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
	ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')
fi

# find sources in arch/$1
find_arch_sources()
{
	for i in $archincludedir; do
		prune="$prune -wholename $i -prune -o"
	done
	find ${tree}arch/$1 $ignore $prune -name "$2" -not -type l -print;
}

# find sources in arch/$1/include
find_arch_include_sources()
{
	include=$(find ${tree}arch/$1/ -name include -type d -print);
	if [ -n "$include" ]; then
		archincludedir="$archincludedir $include"
		find $include $ignore -name "$2" -not -type l -print;
	fi
}

# find sources in include/
find_include_sources()
{
	find ${tree}include $ignore -name config -prune -o -name "$1" \
		-not -type l -print;
}

# find sources in rest of tree
# we could benefit from a list of dirs to search in here
find_other_sources()
{
	find ${tree}* $ignore \
	     \( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
	       -name "$1" -not -type l -print;
}

find_sources()
{
	find_arch_sources $1 "$2"
}

all_sources()
{
	find_arch_include_sources ${SRCARCH} '*.[chS]'
	if [ ! -z "$archinclude" ]; then
		find_arch_include_sources $archinclude '*.[chS]'
	fi
	find_include_sources '*.[chS]'
	for arch in $ALLSOURCE_ARCHS
	do
		find_sources $arch '*.[chS]'
	done
	find_other_sources '*.[chS]'
}

all_compiled_sources()
{
	realpath -es $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) \
		include/generated/autoconf.h $(find $ignore -name "*.cmd" -exec \
		grep -Poh '(?(?=^source_.* \K).*|(?=^  \K\S).*(?= \\))' {} \+ |
		awk '!a[$0]++') | sort -u
}

all_target_sources()
{
	if [ -n "$COMPILED_SOURCE" ]; then
		all_compiled_sources
	else
		all_sources
	fi
}

all_kconfigs()
{
	find ${tree}arch/ -maxdepth 1 $ignore \
	       -name "Kconfig*" -not -type l -print;
	for arch in $ALLSOURCE_ARCHS; do
		find_sources $arch 'Kconfig*'
	done
	find_other_sources 'Kconfig*'
}

docscope()
{
	(echo \-k; echo \-q; all_target_sources) > cscope.files
	cscope -b -f cscope.out
}

dogtags()
{
	all_target_sources | gtags -i -f -
}

# Basic regular expressions with an optional /kind-spec/ for ctags and
# the following limitations:
# - No regex modifiers
# - Use \{0,1\} instead of \?, because etags expects an unescaped ?
# - \s is not working with etags, use a space or [ \t]
# - \w works, but does not match underscores in etags
# - etags regular expressions have to match at the start of a line;
#   a ^[^#] is prepended by setup_regex unless an anchor is already present
regex_asm=(
	'/^\(ENTRY\|_GLOBAL\)(\([[:alnum:]_\\]*\)).*/\2/'
)
regex_c=(
	'/^SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/sys_\1/'
	'/^BPF_CALL_[0-9](\([[:alnum:]_]*\).*/\1/'
	'/^COMPAT_SYSCALL_DEFINE[0-9](\([[:alnum:]_]*\).*/compat_sys_\1/'
	'/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1/'
	'/^TRACE_EVENT(\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
	'/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1/'
	'/^DEFINE_EVENT([^,)]*, *\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
	'/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/get_\1_slot/'
	'/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]*\).*/free_\1_slot/'
	'/^PAGEFLAG(\([[:alnum:]_]*\).*/Page\1/'
	'/^PAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/'
	'/^PAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/'
	'/^TESTSETFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/'
	'/^TESTPAGEFLAG(\([[:alnum:]_]*\).*/Page\1/'
	'/^SETPAGEFLAG(\([[:alnum:]_]*\).*/SetPage\1/'
	'/\<__SETPAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/'
	'/\<TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<__TESTCLEARFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<CLEARPAGEFLAG(\([[:alnum:]_]*\).*/ClearPage\1/'
	'/\<__CLEARPAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^__PAGEFLAG(\([[:alnum:]_]*\).*/__SetPage\1/'
	'/^__PAGEFLAG(\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^PAGEFLAG_FALSE(\([[:alnum:]_]*\).*/Page\1/'
	'/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestSetPage\1/'
	'/\<TESTSCFLAG(\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<SETPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/SetPage\1/'
	'/\<CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/ClearPage\1/'
	'/\<__CLEARPAGEFLAG_NOOP(\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/\<TESTCLEARFLAG_FALSE(\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/Page\1/'
	'/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__SetPage\1/'
	'/^PAGE_TYPE_OPS(\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^TASK_PFA_TEST([^,]*, *\([[:alnum:]_]*\))/task_\1/'
	'/^TASK_PFA_SET([^,]*, *\([[:alnum:]_]*\))/task_set_\1/'
	'/^TASK_PFA_CLEAR([^,]*, *\([[:alnum:]_]*\))/task_clear_\1/'
	'/^DEF_MMIO_\(IN\|OUT\)_[XD](\([[:alnum:]_]*\),[^)]*)/\2/'
	'/^DEBUGGER_BOILERPLATE(\([[:alnum:]_]*\))/\1/'
	'/^DEF_PCI_AC_\(\|NO\)RET(\([[:alnum:]_]*\).*/\2/'
	'/^PCI_OP_READ(\(\w*\).*[1-4])/pci_bus_read_config_\1/'
	'/^PCI_OP_WRITE(\(\w*\).*[1-4])/pci_bus_write_config_\1/'
	'/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)(\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)(\([[:alnum:]_]*\)/\2/v/'
	'/\<DECLARE_\(RWSEM\|COMPLETION\)(\([[:alnum:]_]\+\)/\2/v/'
	'/\<DECLARE_BITMAP(\([[:alnum:]_]*\)/\1/v/'
	'/\(^\|\s\)\(\|L\|H\)LIST_HEAD(\([[:alnum:]_]*\)/\3/v/'
	'/\(^\|\s\)RADIX_TREE(\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_PER_CPU([^,]*, *\([[:alnum:]_]*\)/\1/v/'
	'/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*, *\([[:alnum:]_]*\)/\1/v/'
	'/\<DECLARE_WAIT_QUEUE_HEAD(\([[:alnum:]_]*\)/\1/v/'
	'/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)(\([[:alnum:]_]*\)/\2/v/'
	'/\(^\s\)OFFSET(\([[:alnum:]_]*\)/\2/v/'
	'/\(^\s\)DEFINE(\([[:alnum:]_]*\)/\2/v/'
	'/\<\(DEFINE\|DECLARE\)_HASHTABLE(\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_ID\(R\|A\)(\([[:alnum:]_]\+\)/\2/'
	'/\<DEFINE_WD_CLASS(\([[:alnum:]_]\+\)/\1/'
	'/\<ATOMIC_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	'/\<RAW_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	'/\<DECLARE_FAULT_ATTR(\([[:alnum:]_]\+\)/\1/'
	'/\<BLOCKING_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	'/\<DEVICE_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/dev_attr_\2/'
	'/\<DRIVER_ATTR_\(RW\|RO\|WO\)(\([[:alnum:]_]\+\)/driver_attr_\2/'
	'/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)(\([[:alnum:]_]\+\)/\4/'
	'/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_t/'
	'/^SEQCOUNT_LOCKTYPE(\([^,]*\),[[:space:]]*\([^,]*\),[^)]*)/seqcount_\2_init/'
)
regex_kconfig=(
	'/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
	'/^[[:blank:]]*\(menu\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
)
setup_regex()
{
	local mode=$1 lang tmp=() r
	shift

	regex=()
	for lang; do
		case "$lang" in
		asm)       tmp=("${regex_asm[@]}") ;;
		c)         tmp=("${regex_c[@]}") ;;
		kconfig)   tmp=("${regex_kconfig[@]}") ;;
		esac
		for r in "${tmp[@]}"; do
			if test "$mode" = "exuberant"; then
				regex[${#regex[@]}]="--regex-$lang=${r}b"
			else
				# Remove ctags /kind-spec/
				case "$r" in
				/*/*/?/)
					r=${r%?/}
				esac
				# Prepend ^[^#] unless already anchored
				case "$r" in
				/^*) ;;
				*)
					r="/^[^#]*${r#/}"
				esac
				regex[${#regex[@]}]="--regex=$r"
			fi
		done
	done
}

exuberant()
{
	setup_regex exuberant asm c
	all_target_sources | xargs $1 -a                        \
	-I __initdata,__exitdata,__initconst,__ro_after_init	\
	-I __initdata_memblock					\
	-I __refdata,__attribute,__maybe_unused,__always_unused \
	-I __acquires,__releases,__deprecated,__always_inline	\
	-I __read_mostly,__aligned,____cacheline_aligned        \
	-I ____cacheline_aligned_in_smp                         \
	-I __cacheline_aligned,__cacheline_aligned_in_smp	\
	-I ____cacheline_internodealigned_in_smp                \
	-I __used,__packed,__packed2__,__must_check,__must_hold	\
	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL   \
	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
	-I static,const						\
	--extra=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
	"${regex[@]}"

	setup_regex exuberant kconfig
	all_kconfigs | xargs $1 -a                              \
	--langdef=kconfig --language-force=kconfig "${regex[@]}"

}

emacs()
{
	setup_regex emacs asm c
	all_target_sources | xargs $1 -a "${regex[@]}"

	setup_regex emacs kconfig
	all_kconfigs | xargs $1 -a "${regex[@]}"
}

xtags()
{
	if $1 --version 2>&1 | grep -iq exuberant; then
		exuberant $1
	elif $1 --version 2>&1 | grep -iq emacs; then
		emacs $1
	else
		all_target_sources | xargs $1 -a
	fi
}

# Support um (which uses SUBARCH)
if [ "${ARCH}" = "um" ]; then
	if [ "$SUBARCH" = "i386" ]; then
		archinclude=x86
	elif [ "$SUBARCH" = "x86_64" ]; then
		archinclude=x86
	else
		archinclude=${SUBARCH}
	fi
fi

remove_structs=
case "$1" in
	"cscope")
		docscope
		;;

	"gtags")
		dogtags
		;;

	"tags")
		rm -f tags
		xtags ctags
		remove_structs=y
		;;

	"TAGS")
		rm -f TAGS
		xtags etags
		remove_structs=y
		;;
esac

# Remove structure forward declarations.
if [ -n "$remove_structs" ]; then
    LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]*\)\t.*\t\/\^struct \1;.*\$\/;"\tx$/d' $1
fi
Commit	Line	Data
93209d65	1	#!/bin/bash
457c8996	2	# SPDX-License-Identifier: GPL-2.0-only
a680eedc SR	3	# Generate tags or cscope files
	4	# Usage tags.sh <mode>
	5	#
	6	# mode may be any of: tags, TAGS, cscope
	7	#
	8	# Uses the following environment variables:
b3b3eb9d	9	# SUBARCH, SRCARCH, srctree
a680eedc	10
a6ba0cb3	11	if [ "$KBUILD_VERBOSE" = "1" ]; then
a680eedc SR	12	set -x
	13	fi
	14
ae63b2d7 PB	15	# RCS_FIND_IGNORE has escaped ()s -- remove them.
	16	ignore="$(echo "$RCS_FIND_IGNORE" \| sed 's\|\\\|\|g' )"
	17	# tags and cscope files should also ignore MODVERSION *.mod.c files
	18	ignore="$ignore ( -name *.mod.c ) -prune -o"
a680eedc	19
95fd3f87	20	# Use make KBUILD_ABS_SRCTREE=1 {tags\|cscope}
e93bc1a0	21	# to force full paths for a non-O= build
c69ef1c8	22	if [ "${srctree}" = "." -o -z "${srctree}" ]; then
a680eedc SR	23	tree=
a680eedc SR	24	else
709cc372	25	tree=${srctree}/
a680eedc SR	26	fi
a680eedc SR	27
8c38a532	28	# ignore userspace tools
162343a8 RK	29	if [ -n "$COMPILED_SOURCE" ]; then
	30	ignore="$ignore ( -path ./tools ) -prune -o"
	31	else
	32	ignore="$ignore ( -path ${tree}tools ) -prune -o"
	33	fi
8c38a532	34
4f628248 JS	35	# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
	36	if [ "${ALLSOURCE_ARCHS}" = "" ]; then
	37	ALLSOURCE_ARCHS=${SRCARCH}
bc75cc6b	38	elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
656c1077	39	ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')
4f628248 JS	40	fi
4f628248 JS	41
b3b3eb9d	42	# find sources in arch/$1
a680eedc SR	43	find_arch_sources()
a680eedc SR	44	{
f81b1be4 GL	45	for i in $archincludedir; do
	46	prune="$prune -wholename $i -prune -o"
	47	done
d1db881d	48	find ${tree}arch/$1 $ignore $prune -name "$2" -not -type l -print;
a680eedc SR	49	}
	50
	51	# find sources in arch/$1/include
	52	find_arch_include_sources()
	53	{
d1db881d	54	include=$(find ${tree}arch/$1/ -name include -type d -print);
f81b1be4 GL	55	if [ -n "$include" ]; then
f81b1be4 GL	56	archincludedir="$archincludedir $include"
9b24a15d	57	find $include $ignore -name "$2" -not -type l -print;
f81b1be4	58	fi
a680eedc SR	59	}
	60
	61	# find sources in include/
	62	find_include_sources()
	63	{
9b24a15d YD	64	find ${tree}include $ignore -name config -prune -o -name "$1" \
9b24a15d YD	65	-not -type l -print;
a680eedc SR	66	}
	67
	68	# find sources in rest of tree
	69	# we could benefit from a list of dirs to search in here
	70	find_other_sources()
	71	{
	72	find ${tree}* $ignore \
99443f81	73	\( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
9b24a15d	74	-name "$1" -not -type l -print;
a680eedc SR	75	}
	76
	77	find_sources()
	78	{
709cc372	79	find_arch_sources $1 "$2"
a680eedc SR	80	}
	81
	82	all_sources()
	83	{
a8bac511	84	find_arch_include_sources ${SRCARCH} '*.[chS]'
a680eedc	85	if [ ! -z "$archinclude" ]; then
709cc372	86	find_arch_include_sources $archinclude '*.[chS]'
a680eedc	87	fi
4f628248	88	find_include_sources '*.[chS]'
f81b1be4 GL	89	for arch in $ALLSOURCE_ARCHS
	90	do
	91	find_sources $arch '*.[chS]'
	92	done
4f628248	93	find_other_sources '*.[chS]'
a680eedc SR	94	}
a680eedc SR	95
923e02ec JK	96	all_compiled_sources()
923e02ec JK	97	{
4f491bb6	98	realpath -es $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) \
162343a8	99	include/generated/autoconf.h $(find $ignore -name "*.cmd" -exec \
4f491bb6 JX	100	grep -Poh '(?(?=^source_.* \K).\|(?=^ \K\S).(?= \\))' {} \+ \|
4f491bb6 JX	101	awk '!a[$0]++') \| sort -u
923e02ec JK	102	}
	103
	104	all_target_sources()
	105	{
	106	if [ -n "$COMPILED_SOURCE" ]; then
	107	all_compiled_sources
	108	else
	109	all_sources
	110	fi
	111	}
	112
a680eedc SR	113	all_kconfigs()
a680eedc SR	114	{
7659c655 HT	115	find ${tree}arch/ -maxdepth 1 $ignore \
7659c655 HT	116	-name "Kconfig*" -not -type l -print;
953fae66 AD	117	for arch in $ALLSOURCE_ARCHS; do
	118	find_sources $arch 'Kconfig*'
	119	done
	120	find_other_sources 'Kconfig*'
a680eedc SR	121	}
a680eedc SR	122
a680eedc SR	123	docscope()
a680eedc SR	124	{
923e02ec	125	(echo \-k; echo \-q; all_target_sources) > cscope.files
a680eedc SR	126	cscope -b -f cscope.out
	127	}
	128
f4ed1009 JK	129	dogtags()
f4ed1009 JK	130	{
923e02ec	131	all_target_sources \| gtags -i -f -
f4ed1009 JK	132	}
f4ed1009 JK	133
93209d65 MM	134	# Basic regular expressions with an optional /kind-spec/ for ctags and
	135	# the following limitations:
	136	# - No regex modifiers
	137	# - Use \{0,1\} instead of \?, because etags expects an unescaped ?
	138	# - \s is not working with etags, use a space or [ \t]
	139	# - \w works, but does not match underscores in etags
	140	# - etags regular expressions have to match at the start of a line;
	141	# a ^[^#] is prepended by setup_regex unless an anchor is already present
	142	regex_asm=(
	143	'/^\(ENTRY\\|_GLOBAL\)(\([[:alnum:]_\\]\))./\2/'
	144	)
	145	regex_c=(
	146	'/^SYSCALL_DEFINE[0-9](\([[:alnum:]_]\)./sys_\1/'
24d4e34f	147	'/^BPF_CALL_[0-9](\([[:alnum:]_]\)./\1/'
93209d65 MM	148	'/^COMPAT_SYSCALL_DEFINE[0-9](\([[:alnum:]_]\)./compat_sys_\1/'
	149	'/^TRACE_EVENT(\([[:alnum:]_]\)./trace_\1/'
	150	'/^TRACE_EVENT(\([[:alnum:]_]\)./trace_\1_rcuidle/'
	151	'/^DEFINE_EVENT([^,)], \([[:alnum:]_]\)./trace_\1/'
	152	'/^DEFINE_EVENT([^,)], \([[:alnum:]_]\)./trace_\1_rcuidle/'
0a9e7da6 NR	153	'/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]\)./get_\1_slot/'
0a9e7da6 NR	154	'/^DEFINE_INSN_CACHE_OPS(\([[:alnum:]_]\)./free_\1_slot/'
93209d65 MM	155	'/^PAGEFLAG(\([[:alnum:]_]\)./Page\1/'
	156	'/^PAGEFLAG(\([[:alnum:]_]\)./SetPage\1/'
	157	'/^PAGEFLAG(\([[:alnum:]_]\)./ClearPage\1/'
	158	'/^TESTSETFLAG(\([[:alnum:]_]\)./TestSetPage\1/'
	159	'/^TESTPAGEFLAG(\([[:alnum:]_]\)./Page\1/'
	160	'/^SETPAGEFLAG(\([[:alnum:]_]\)./SetPage\1/'
	161	'/\<__SETPAGEFLAG(\([[:alnum:]_]\)./__SetPage\1/'
	162	'/\<TESTCLEARFLAG(\([[:alnum:]_]\)./TestClearPage\1/'
	163	'/\<__TESTCLEARFLAG(\([[:alnum:]_]\)./TestClearPage\1/'
	164	'/\<CLEARPAGEFLAG(\([[:alnum:]_]\)./ClearPage\1/'
	165	'/\<__CLEARPAGEFLAG(\([[:alnum:]_]\)./__ClearPage\1/'
	166	'/^__PAGEFLAG(\([[:alnum:]_]\)./__SetPage\1/'
	167	'/^__PAGEFLAG(\([[:alnum:]_]\)./__ClearPage\1/'
	168	'/^PAGEFLAG_FALSE(\([[:alnum:]_]\)./Page\1/'
	169	'/\<TESTSCFLAG(\([[:alnum:]_]\)./TestSetPage\1/'
	170	'/\<TESTSCFLAG(\([[:alnum:]_]\)./TestClearPage\1/'
	171	'/\<SETPAGEFLAG_NOOP(\([[:alnum:]_]\)./SetPage\1/'
	172	'/\<CLEARPAGEFLAG_NOOP(\([[:alnum:]_]\)./ClearPage\1/'
	173	'/\<__CLEARPAGEFLAG_NOOP(\([[:alnum:]_]\)./__ClearPage\1/'
	174	'/\<TESTCLEARFLAG_FALSE(\([[:alnum:]_]\)./TestClearPage\1/'
6e292b9b MW	175	'/^PAGE_TYPE_OPS(\([[:alnum:]_]\)./Page\1/'
	176	'/^PAGE_TYPE_OPS(\([[:alnum:]_]\)./__SetPage\1/'
	177	'/^PAGE_TYPE_OPS(\([[:alnum:]_]\)./__ClearPage\1/'
93209d65 MM	178	'/^TASK_PFA_TEST([^,], \([[:alnum:]_]*\))/task_\1/'
	179	'/^TASK_PFA_SET([^,], \([[:alnum:]_]*\))/task_set_\1/'
	180	'/^TASK_PFA_CLEAR([^,], \([[:alnum:]_]*\))/task_clear_\1/'
	181	'/^DEF_MMIO_\(IN\\|OUT\)_[XD](\([[:alnum:]_]\),[^)])/\2/'
	182	'/^DEBUGGER_BOILERPLATE(\([[:alnum:]_]*\))/\1/'
	183	'/^DEF_PCI_AC_\(\\|NO\)RET(\([[:alnum:]_]\)./\2/'
	184	'/^PCI_OP_READ(\(\w\).[1-4])/pci_bus_read_config_\1/'
	185	'/^PCI_OP_WRITE(\(\w\).[1-4])/pci_bus_write_config_\1/'
cd68a525	186	'/\<DEFINE_\(RT_MUTEX\\|MUTEX\\|SEMAPHORE\\|SPINLOCK\)(\([[:alnum:]_]*\)/\2/v/'
93209d65 MM	187	'/\<DEFINE_\(RAW_SPINLOCK\\|RWLOCK\\|SEQLOCK\)(\([[:alnum:]_]*\)/\2/v/'
	188	'/\<DECLARE_\(RWSEM\\|COMPLETION\)(\([[:alnum:]_]\+\)/\2/v/'
	189	'/\<DECLARE_BITMAP(\([[:alnum:]_]*\)/\1/v/'
	190	'/\(^\\|\s\)\(\\|L\\|H\)LIST_HEAD(\([[:alnum:]_]*\)/\3/v/'
	191	'/\(^\\|\s\)RADIX_TREE(\([[:alnum:]_]*\)/\2/v/'
	192	'/\<DEFINE_PER_CPU([^,], \([[:alnum:]_]*\)/\1/v/'
	193	'/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,], \([[:alnum:]_]*\)/\1/v/'
	194	'/\<DECLARE_WAIT_QUEUE_HEAD(\([[:alnum:]_]*\)/\1/v/'
	195	'/\<DECLARE_\(TASKLET\\|WORK\\|DELAYED_WORK\)(\([[:alnum:]_]*\)/\2/v/'
93209d65 MM	196	'/\(^\s\)OFFSET(\([[:alnum:]_]*\)/\2/v/'
93209d65 MM	197	'/\(^\s\)DEFINE(\([[:alnum:]_]*\)/\2/v/'
1f6904f7	198	'/\<\(DEFINE\\|DECLARE\)_HASHTABLE(\([[:alnum:]_]*\)/\2/v/'
cd68a525 KT	199	'/\<DEFINE_ID\(R\\|A\)(\([[:alnum:]_]\+\)/\2/'
	200	'/\<DEFINE_WD_CLASS(\([[:alnum:]_]\+\)/\1/'
	201	'/\<ATOMIC_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	202	'/\<RAW_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	203	'/\<DECLARE_FAULT_ATTR(\([[:alnum:]_]\+\)/\1/'
	204	'/\<BLOCKING_NOTIFIER_HEAD(\([[:alnum:]_]\+\)/\1/'
	205	'/\<DEVICE_ATTR_\(RW\\|RO\\|WO\)(\([[:alnum:]_]\+\)/dev_attr_\2/'
	206	'/\<DRIVER_ATTR_\(RW\\|RO\\|WO\)(\([[:alnum:]_]\+\)/driver_attr_\2/'
	207	'/\<\(DEFINE\\|DECLARE\)_STATIC_KEY_\(TRUE\\|FALSE\)\(\\|_RO\)(\([[:alnum:]_]\+\)/\4/'
6eb6d059 PZ	208	'/^SEQCOUNT_LOCKTYPE(\([^,]\),[[:space:]]\([^,]\),[^)])/seqcount_\2_t/'
6eb6d059 PZ	209	'/^SEQCOUNT_LOCKTYPE(\([^,]\),[[:space:]]\([^,]\),[^)])/seqcount_\2_init/'
93209d65 MM	210	)
	211	regex_kconfig=(
	212	'/^[[:blank:]]*\(menu\\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
	213	'/^[[:blank:]]*\(menu\\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
	214	)
	215	setup_regex()
	216	{
	217	local mode=$1 lang tmp=() r
	218	shift
	219
	220	regex=()
	221	for lang; do
	222	case "$lang" in
	223	asm) tmp=("${regex_asm[@]}") ;;
	224	c) tmp=("${regex_c[@]}") ;;
	225	kconfig) tmp=("${regex_kconfig[@]}") ;;
	226	esac
	227	for r in "${tmp[@]}"; do
	228	if test "$mode" = "exuberant"; then
	229	regex[${#regex[@]}]="--regex-$lang=${r}b"
	230	else
	231	# Remove ctags /kind-spec/
	232	case "$r" in
	233	///?/)
	234	r=${r%?/}
	235	esac
	236	# Prepend ^[^#] unless already anchored
	237	case "$r" in
	238	/^*) ;;
	239	*)
	240	r="/^[^#]*${r#/}"
	241	esac
	242	regex[${#regex[@]}]="--regex=$r"
	243	fi
	244	done
	245	done
	246	}
	247
a680eedc SR	248	exuberant()
a680eedc SR	249	{
93209d65	250	setup_regex exuberant asm c
923e02ec	251	all_target_sources \| xargs $1 -a \
e23ba825	252	-I __initdata,__exitdata,__initconst,__ro_after_init \
22c1587a	253	-I __initdata_memblock \
f5a82137	254	-I __refdata,__attribute,__maybe_unused,__always_unused \
cd68a525	255	-I __acquires,__releases,__deprecated,__always_inline \
1b2643f0	256	-I __read_mostly,__aligned,____cacheline_aligned \
a680eedc	257	-I ____cacheline_aligned_in_smp \
f5a82137	258	-I __cacheline_aligned,__cacheline_aligned_in_smp \
a680eedc	259	-I ____cacheline_internodealigned_in_smp \
1b2643f0	260	-I __used,__packed,__packed2__,__must_check,__must_hold \
f5a82137	261	-I EXPORT_SYMBOL,EXPORT_SYMBOL_GPL,ACPI_EXPORT_SYMBOL \
7db86dc9	262	-I DEFINE_TRACE,EXPORT_TRACEPOINT_SYMBOL,EXPORT_TRACEPOINT_SYMBOL_GPL \
1b2643f0	263	-I static,const \
d0c75f33 MM	264	--extra=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
d0c75f33 MM	265	"${regex[@]}"
a680eedc	266
93209d65	267	setup_regex exuberant kconfig
a680eedc	268	all_kconfigs \| xargs $1 -a \
93209d65	269	--langdef=kconfig --language-force=kconfig "${regex[@]}"
a680eedc	270
a680eedc SR	271	}
	272
	273	emacs()
	274	{
93209d65 MM	275	setup_regex emacs asm c
93209d65 MM	276	all_target_sources \| xargs $1 -a "${regex[@]}"
a680eedc	277
93209d65 MM	278	setup_regex emacs kconfig
93209d65 MM	279	all_kconfigs \| xargs $1 -a "${regex[@]}"
a680eedc SR	280	}
	281
	282	xtags()
	283	{
	284	if $1 --version 2>&1 \| grep -iq exuberant; then
	285	exuberant $1
	286	elif $1 --version 2>&1 \| grep -iq emacs; then
	287	emacs $1
	288	else
923e02ec	289	all_target_sources \| xargs $1 -a
bb66fc67	290	fi
a680eedc SR	291	}
a680eedc SR	292
a680eedc	293	# Support um (which uses SUBARCH)
a6ba0cb3 JS	294	if [ "${ARCH}" = "um" ]; then
a6ba0cb3 JS	295	if [ "$SUBARCH" = "i386" ]; then
a680eedc	296	archinclude=x86
a6ba0cb3	297	elif [ "$SUBARCH" = "x86_64" ]; then
a680eedc SR	298	archinclude=x86
	299	else
	300	archinclude=${SUBARCH}
	301	fi
	302	fi
	303
66979224	304	remove_structs=
a680eedc SR	305	case "$1" in
	306	"cscope")
	307	docscope
	308	;;
	309
f4ed1009 JK	310	"gtags")
	311	dogtags
	312	;;
	313
a680eedc	314	"tags")
2e6cb8b0	315	rm -f tags
a680eedc	316	xtags ctags
66979224	317	remove_structs=y
a680eedc SR	318	;;
	319
	320	"TAGS")
2e6cb8b0	321	rm -f TAGS
a680eedc	322	xtags etags
66979224	323	remove_structs=y
a680eedc SR	324	;;
a680eedc SR	325	esac
66979224 YB	326
66979224 YB	327	# Remove structure forward declarations.
0eb043d0	328	if [ -n "$remove_structs" ]; then
77a88274	329	LC_ALL=C sed -i -e '/^\([a-zA-Z_][a-zA-Z0-9_]\)\t.\t\/\^struct \1;.*\$\/;"\tx$/d' $1
66979224	330	fi