[linux-block.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

# 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()
{
	{
		echo include/generated/autoconf.h
		find $ignore -name "*.cmd" -exec \
			grep -Poh '(?(?=^source_.* \K).*|(?=^  \K\S).*(?= \\))' {} \+ |
		awk '!a[$0]++'
	} | xargs realpath -esq $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) |
	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\)([[:space:]]*\([[:alnum:]_\\]*\)).*/\2/'
)
regex_c=(
	'/^SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/sys_\1/'
	'/^BPF_CALL_[0-9]([[:space:]]*\([[:alnum:]_]*\).*/\1/'
	'/^COMPAT_SYSCALL_DEFINE[0-9]([[:space:]]*\([[:alnum:]_]*\).*/compat_sys_\1/'
	'/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
	'/^TRACE_EVENT([[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
	'/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1/'
	'/^DEFINE_EVENT([^,)]*,[[:space:]]*\([[:alnum:]_]*\).*/trace_\1_rcuidle/'
	'/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/get_\1_slot/'
	'/^DEFINE_INSN_CACHE_OPS([[:space:]]*\([[:alnum:]_]*\).*/free_\1_slot/'
	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
	'/^PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
	'/^TESTSETFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
	'/^TESTPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
	'/^SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
	'/\<__SETPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
	'/\<TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<__TESTCLEARFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
	'/\<__CLEARPAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
	'/^__PAGEFLAG([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^PAGEFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
	'/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestSetPage\1/'
	'/\<TESTSCFLAG([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/\<SETPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/SetPage\1/'
	'/\<CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/ClearPage\1/'
	'/\<__CLEARPAGEFLAG_NOOP([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/\<TESTCLEARFLAG_FALSE([[:space:]]*\([[:alnum:]_]*\).*/TestClearPage\1/'
	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/Page\1/'
	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__SetPage\1/'
	'/^PAGE_TYPE_OPS([[:space:]]*\([[:alnum:]_]*\).*/__ClearPage\1/'
	'/^TASK_PFA_TEST([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_\1/'
	'/^TASK_PFA_SET([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_set_\1/'
	'/^TASK_PFA_CLEAR([^,]*,[[:space:]]*\([[:alnum:]_]*\))/task_clear_\1/'
	'/^DEF_MMIO_\(IN\|OUT\)_[XD]([[:space:]]*\([[:alnum:]_]*\),[^)]*)/\2/'
	'/^DEBUGGER_BOILERPLATE([[:space:]]*\([[:alnum:]_]*\))/\1/'
	'/^DEF_PCI_AC_\(\|NO\)RET([[:space:]]*\([[:alnum:]_]*\).*/\2/'
	'/^PCI_OP_READ([[:space:]]*\(\w*\).*[1-4])/pci_bus_read_config_\1/'
	'/^PCI_OP_WRITE([[:space:]]*\(\w*\).*[1-4])/pci_bus_write_config_\1/'
	'/\<DEFINE_\(RT_MUTEX\|MUTEX\|SEMAPHORE\|SPINLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_\(RAW_SPINLOCK\|RWLOCK\|SEQLOCK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\<DECLARE_\(RWSEM\|COMPLETION\)([[:space:]]*\([[:alnum:]_]\+\)/\2/v/'
	'/\<DECLARE_BITMAP([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
	'/\(^\|\s\)\(\|L\|H\)LIST_HEAD([[:space:]]*\([[:alnum:]_]*\)/\3/v/'
	'/\(^\|\s\)RADIX_TREE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_PER_CPU([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
	'/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,]*,[[:space:]]*\([[:alnum:]_]*\)/\1/v/'
	'/\<DECLARE_WAIT_QUEUE_HEAD([[:space:]]*\([[:alnum:]_]*\)/\1/v/'
	'/\<DECLARE_\(TASKLET\|WORK\|DELAYED_WORK\)([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\(^\s\)OFFSET([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\(^\s\)DEFINE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\<\(DEFINE\|DECLARE\)_HASHTABLE([[:space:]]*\([[:alnum:]_]*\)/\2/v/'
	'/\<DEFINE_ID\(R\|A\)([[:space:]]*\([[:alnum:]_]\+\)/\2/'
	'/\<DEFINE_WD_CLASS([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	'/\<ATOMIC_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	'/\<RAW_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	'/\<DECLARE_FAULT_ATTR([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	'/\<BLOCKING_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	'/\<DEVICE_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/dev_attr_\2/'
	'/\<DRIVER_ATTR_\(RW\|RO\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/driver_attr_\2/'
	'/\<\(DEFINE\|DECLARE\)_STATIC_KEY_\(TRUE\|FALSE\)\(\|_RO\)([[:space:]]*\([[: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()
{
	CTAGS_EXTRA="extra"
	if $1 --version 2>&1 | grep -iq universal; then
	    CTAGS_EXTRA="extras"
	fi
	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						\
	--$CTAGS_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
4f628248 JS	28	# Detect if ALLSOURCE_ARCHS is set. If not, we assume SRCARCH
	29	if [ "${ALLSOURCE_ARCHS}" = "" ]; then
	30	ALLSOURCE_ARCHS=${SRCARCH}
bc75cc6b	31	elif [ "${ALLSOURCE_ARCHS}" = "all" ]; then
656c1077	32	ALLSOURCE_ARCHS=$(find ${tree}arch/ -mindepth 1 -maxdepth 1 -type d -printf '%f ')
4f628248 JS	33	fi
4f628248 JS	34
b3b3eb9d	35	# find sources in arch/$1
a680eedc SR	36	find_arch_sources()
a680eedc SR	37	{
f81b1be4 GL	38	for i in $archincludedir; do
	39	prune="$prune -wholename $i -prune -o"
	40	done
d1db881d	41	find ${tree}arch/$1 $ignore $prune -name "$2" -not -type l -print;
a680eedc SR	42	}
	43
	44	# find sources in arch/$1/include
	45	find_arch_include_sources()
	46	{
d1db881d	47	include=$(find ${tree}arch/$1/ -name include -type d -print);
f81b1be4 GL	48	if [ -n "$include" ]; then
f81b1be4 GL	49	archincludedir="$archincludedir $include"
9b24a15d	50	find $include $ignore -name "$2" -not -type l -print;
f81b1be4	51	fi
a680eedc SR	52	}
	53
	54	# find sources in include/
	55	find_include_sources()
	56	{
9b24a15d YD	57	find ${tree}include $ignore -name config -prune -o -name "$1" \
9b24a15d YD	58	-not -type l -print;
a680eedc SR	59	}
	60
	61	# find sources in rest of tree
	62	# we could benefit from a list of dirs to search in here
	63	find_other_sources()
	64	{
	65	find ${tree}* $ignore \
99443f81	66	\( -path ${tree}include -o -path ${tree}arch -o -name '.tmp_*' \) -prune -o \
9b24a15d	67	-name "$1" -not -type l -print;
a680eedc SR	68	}
	69
	70	find_sources()
	71	{
709cc372	72	find_arch_sources $1 "$2"
a680eedc SR	73	}
	74
	75	all_sources()
	76	{
a8bac511	77	find_arch_include_sources ${SRCARCH} '*.[chS]'
a680eedc	78	if [ ! -z "$archinclude" ]; then
709cc372	79	find_arch_include_sources $archinclude '*.[chS]'
a680eedc	80	fi
4f628248	81	find_include_sources '*.[chS]'
f81b1be4 GL	82	for arch in $ALLSOURCE_ARCHS
	83	do
	84	find_sources $arch '*.[chS]'
	85	done
4f628248	86	find_other_sources '*.[chS]'
a680eedc SR	87	}
a680eedc SR	88
923e02ec JK	89	all_compiled_sources()
923e02ec JK	90	{
7394d2eb CC	91	{
	92	echo include/generated/autoconf.h
	93	find $ignore -name "*.cmd" -exec \
	94	grep -Poh '(?(?=^source_.* \K).\|(?=^ \K\S).(?= \\))' {} \+ \|
	95	awk '!a[$0]++'
d60be533	96	} \| xargs realpath -esq $([ -z "$KBUILD_ABS_SRCTREE" ] && echo --relative-to=.) \|
7394d2eb	97	sort -u
923e02ec JK	98	}
	99
	100	all_target_sources()
	101	{
	102	if [ -n "$COMPILED_SOURCE" ]; then
	103	all_compiled_sources
	104	else
	105	all_sources
	106	fi
	107	}
	108
a680eedc SR	109	all_kconfigs()
a680eedc SR	110	{
7659c655 HT	111	find ${tree}arch/ -maxdepth 1 $ignore \
7659c655 HT	112	-name "Kconfig*" -not -type l -print;
953fae66 AD	113	for arch in $ALLSOURCE_ARCHS; do
	114	find_sources $arch 'Kconfig*'
	115	done
	116	find_other_sources 'Kconfig*'
a680eedc SR	117	}
a680eedc SR	118
a680eedc SR	119	docscope()
a680eedc SR	120	{
923e02ec	121	(echo \-k; echo \-q; all_target_sources) > cscope.files
a680eedc SR	122	cscope -b -f cscope.out
	123	}
	124
f4ed1009 JK	125	dogtags()
f4ed1009 JK	126	{
923e02ec	127	all_target_sources \| gtags -i -f -
f4ed1009 JK	128	}
f4ed1009 JK	129
93209d65 MM	130	# Basic regular expressions with an optional /kind-spec/ for ctags and
	131	# the following limitations:
	132	# - No regex modifiers
	133	# - Use \{0,1\} instead of \?, because etags expects an unescaped ?
	134	# - \s is not working with etags, use a space or [ \t]
	135	# - \w works, but does not match underscores in etags
	136	# - etags regular expressions have to match at the start of a line;
	137	# a ^[^#] is prepended by setup_regex unless an anchor is already present
	138	regex_asm=(
b6379e73	139	'/^\(ENTRY\\|_GLOBAL\)([[:space:]]\([[:alnum:]_\\]\)).*/\2/'
93209d65 MM	140	)
93209d65 MM	141	regex_c=(
b6379e73 ZL	142	'/^SYSCALL_DEFINE[0-9]([[:space:]]\([[:alnum:]_]\).*/sys_\1/'
	143	'/^BPF_CALL_[0-9]([[:space:]]\([[:alnum:]_]\).*/\1/'
	144	'/^COMPAT_SYSCALL_DEFINE[0-9]([[:space:]]\([[:alnum:]_]\).*/compat_sys_\1/'
	145	'/^TRACE_EVENT([[:space:]]\([[:alnum:]_]\).*/trace_\1/'
	146	'/^TRACE_EVENT([[:space:]]\([[:alnum:]_]\).*/trace_\1_rcuidle/'
	147	'/^DEFINE_EVENT([^,)],[[:space:]]\([[:alnum:]_]\)./trace_\1/'
	148	'/^DEFINE_EVENT([^,)],[[:space:]]\([[:alnum:]_]\)./trace_\1_rcuidle/'
	149	'/^DEFINE_INSN_CACHE_OPS([[:space:]]\([[:alnum:]_]\).*/get_\1_slot/'
	150	'/^DEFINE_INSN_CACHE_OPS([[:space:]]\([[:alnum:]_]\).*/free_\1_slot/'
	151	'/^PAGEFLAG([[:space:]]\([[:alnum:]_]\).*/Page\1/'
	152	'/^PAGEFLAG([[:space:]]\([[:alnum:]_]\).*/SetPage\1/'
	153	'/^PAGEFLAG([[:space:]]\([[:alnum:]_]\).*/ClearPage\1/'
	154	'/^TESTSETFLAG([[:space:]]\([[:alnum:]_]\).*/TestSetPage\1/'
	155	'/^TESTPAGEFLAG([[:space:]]\([[:alnum:]_]\).*/Page\1/'
	156	'/^SETPAGEFLAG([[:space:]]\([[:alnum:]_]\).*/SetPage\1/'
	157	'/\<__SETPAGEFLAG([[:space:]]\([[:alnum:]_]\).*/__SetPage\1/'
	158	'/\<TESTCLEARFLAG([[:space:]]\([[:alnum:]_]\).*/TestClearPage\1/'
	159	'/\<__TESTCLEARFLAG([[:space:]]\([[:alnum:]_]\).*/TestClearPage\1/'
	160	'/\<CLEARPAGEFLAG([[:space:]]\([[:alnum:]_]\).*/ClearPage\1/'
	161	'/\<__CLEARPAGEFLAG([[:space:]]\([[:alnum:]_]\).*/__ClearPage\1/'
	162	'/^__PAGEFLAG([[:space:]]\([[:alnum:]_]\).*/__SetPage\1/'
	163	'/^__PAGEFLAG([[:space:]]\([[:alnum:]_]\).*/__ClearPage\1/'
	164	'/^PAGEFLAG_FALSE([[:space:]]\([[:alnum:]_]\).*/Page\1/'
	165	'/\<TESTSCFLAG([[:space:]]\([[:alnum:]_]\).*/TestSetPage\1/'
	166	'/\<TESTSCFLAG([[:space:]]\([[:alnum:]_]\).*/TestClearPage\1/'
	167	'/\<SETPAGEFLAG_NOOP([[:space:]]\([[:alnum:]_]\).*/SetPage\1/'
	168	'/\<CLEARPAGEFLAG_NOOP([[:space:]]\([[:alnum:]_]\).*/ClearPage\1/'
	169	'/\<__CLEARPAGEFLAG_NOOP([[:space:]]\([[:alnum:]_]\).*/__ClearPage\1/'
	170	'/\<TESTCLEARFLAG_FALSE([[:space:]]\([[:alnum:]_]\).*/TestClearPage\1/'
	171	'/^PAGE_TYPE_OPS([[:space:]]\([[:alnum:]_]\).*/Page\1/'
	172	'/^PAGE_TYPE_OPS([[:space:]]\([[:alnum:]_]\).*/__SetPage\1/'
	173	'/^PAGE_TYPE_OPS([[:space:]]\([[:alnum:]_]\).*/__ClearPage\1/'
	174	'/^TASK_PFA_TEST([^,],[[:space:]]\([[:alnum:]_]*\))/task_\1/'
	175	'/^TASK_PFA_SET([^,],[[:space:]]\([[:alnum:]_]*\))/task_set_\1/'
	176	'/^TASK_PFA_CLEAR([^,],[[:space:]]\([[:alnum:]_]*\))/task_clear_\1/'
	177	'/^DEF_MMIO_\(IN\\|OUT\)_[XD]([[:space:]]\([[:alnum:]_]\),[^)]*)/\2/'
	178	'/^DEBUGGER_BOILERPLATE([[:space:]]\([[:alnum:]_]\))/\1/'
	179	'/^DEF_PCI_AC_\(\\|NO\)RET([[:space:]]\([[:alnum:]_]\).*/\2/'
	180	'/^PCI_OP_READ([[:space:]]\(\w\).*[1-4])/pci_bus_read_config_\1/'
	181	'/^PCI_OP_WRITE([[:space:]]\(\w\).*[1-4])/pci_bus_write_config_\1/'
	182	'/\<DEFINE_\(RT_MUTEX\\|MUTEX\\|SEMAPHORE\\|SPINLOCK\)([[:space:]]\([[:alnum:]_]\)/\2/v/'
	183	'/\<DEFINE_\(RAW_SPINLOCK\\|RWLOCK\\|SEQLOCK\)([[:space:]]\([[:alnum:]_]\)/\2/v/'
	184	'/\<DECLARE_\(RWSEM\\|COMPLETION\)([[:space:]]*\([[:alnum:]_]\+\)/\2/v/'
	185	'/\<DECLARE_BITMAP([[:space:]]\([[:alnum:]_]\)/\1/v/'
	186	'/\(^\\|\s\)\(\\|L\\|H\)LIST_HEAD([[:space:]]\([[:alnum:]_]\)/\3/v/'
	187	'/\(^\\|\s\)RADIX_TREE([[:space:]]\([[:alnum:]_]\)/\2/v/'
	188	'/\<DEFINE_PER_CPU([^,],[[:space:]]\([[:alnum:]_]*\)/\1/v/'
	189	'/\<DEFINE_PER_CPU_SHARED_ALIGNED([^,],[[:space:]]\([[:alnum:]_]*\)/\1/v/'
	190	'/\<DECLARE_WAIT_QUEUE_HEAD([[:space:]]\([[:alnum:]_]\)/\1/v/'
	191	'/\<DECLARE_\(TASKLET\\|WORK\\|DELAYED_WORK\)([[:space:]]\([[:alnum:]_]\)/\2/v/'
	192	'/\(^\s\)OFFSET([[:space:]]\([[:alnum:]_]\)/\2/v/'
	193	'/\(^\s\)DEFINE([[:space:]]\([[:alnum:]_]\)/\2/v/'
	194	'/\<\(DEFINE\\|DECLARE\)_HASHTABLE([[:space:]]\([[:alnum:]_]\)/\2/v/'
	195	'/\<DEFINE_ID\(R\\|A\)([[:space:]]*\([[:alnum:]_]\+\)/\2/'
	196	'/\<DEFINE_WD_CLASS([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	197	'/\<ATOMIC_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	198	'/\<RAW_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	199	'/\<DECLARE_FAULT_ATTR([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	200	'/\<BLOCKING_NOTIFIER_HEAD([[:space:]]*\([[:alnum:]_]\+\)/\1/'
	201	'/\<DEVICE_ATTR_\(RW\\|RO\\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/dev_attr_\2/'
	202	'/\<DRIVER_ATTR_\(RW\\|RO\\|WO\)([[:space:]]*\([[:alnum:]_]\+\)/driver_attr_\2/'
	203	'/\<\(DEFINE\\|DECLARE\)_STATIC_KEY_\(TRUE\\|FALSE\)\(\\|_RO\)([[:space:]]*\([[:alnum:]_]\+\)/\4/'
6eb6d059 PZ	204	'/^SEQCOUNT_LOCKTYPE(\([^,]\),[[:space:]]\([^,]\),[^)])/seqcount_\2_t/'
6eb6d059 PZ	205	'/^SEQCOUNT_LOCKTYPE(\([^,]\),[[:space:]]\([^,]\),[^)])/seqcount_\2_init/'
93209d65 MM	206	)
	207	regex_kconfig=(
	208	'/^[[:blank:]]*\(menu\\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/\2/'
	209	'/^[[:blank:]]*\(menu\\|\)config[[:blank:]]\+\([[:alnum:]_]\+\)/CONFIG_\2/'
	210	)
	211	setup_regex()
	212	{
	213	local mode=$1 lang tmp=() r
	214	shift
	215
	216	regex=()
	217	for lang; do
	218	case "$lang" in
	219	asm) tmp=("${regex_asm[@]}") ;;
	220	c) tmp=("${regex_c[@]}") ;;
	221	kconfig) tmp=("${regex_kconfig[@]}") ;;
	222	esac
	223	for r in "${tmp[@]}"; do
	224	if test "$mode" = "exuberant"; then
	225	regex[${#regex[@]}]="--regex-$lang=${r}b"
	226	else
	227	# Remove ctags /kind-spec/
	228	case "$r" in
	229	///?/)
	230	r=${r%?/}
	231	esac
	232	# Prepend ^[^#] unless already anchored
	233	case "$r" in
	234	/^*) ;;
	235	*)
	236	r="/^[^#]*${r#/}"
	237	esac
	238	regex[${#regex[@]}]="--regex=$r"
	239	fi
	240	done
	241	done
	242	}
	243
a680eedc SR	244	exuberant()
a680eedc SR	245	{
d06246eb PG	246	CTAGS_EXTRA="extra"
	247	if $1 --version 2>&1 \| grep -iq universal; then
	248	CTAGS_EXTRA="extras"
	249	fi
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 \
d06246eb	264	--$CTAGS_EXTRA=+fq --c-kinds=+px --fields=+iaS --langmap=c:+.h \
d0c75f33	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