[mirror_ubuntu-jammy-kernel.git] / tools / perf / util / include / linux / linkage.h

/* SPDX-License-Identifier: GPL-2.0 */

#ifndef PERF_LINUX_LINKAGE_H_
#define PERF_LINUX_LINKAGE_H_

/* linkage.h ... for including arch/x86/lib/memcpy_64.S */

/* Some toolchains use other characters (e.g. '`') to mark new line in macro */
#ifndef ASM_NL
#define ASM_NL		 ;
#endif

#ifndef __ALIGN
#define __ALIGN		.align 4,0x90
#define __ALIGN_STR	".align 4,0x90"
#endif

/* SYM_T_FUNC -- type used by assembler to mark functions */
#ifndef SYM_T_FUNC
#define SYM_T_FUNC				STT_FUNC
#endif

/* SYM_A_* -- align the symbol? */
#define SYM_A_ALIGN				ALIGN

/* SYM_L_* -- linkage of symbols */
#define SYM_L_GLOBAL(name)			.globl name
#define SYM_L_LOCAL(name)			/* nothing */

#define ALIGN __ALIGN

/* === generic annotations === */

/* SYM_ENTRY -- use only if you have to for non-paired symbols */
#ifndef SYM_ENTRY
#define SYM_ENTRY(name, linkage, align...)		\
	linkage(name) ASM_NL				\
	align ASM_NL					\
	name:
#endif

/* SYM_START -- use only if you have to */
#ifndef SYM_START
#define SYM_START(name, linkage, align...)		\
	SYM_ENTRY(name, linkage, align)
#endif

/* SYM_END -- use only if you have to */
#ifndef SYM_END
#define SYM_END(name, sym_type)				\
	.type name sym_type ASM_NL			\
	.size name, .-name
#endif

/*
 * SYM_FUNC_START_ALIAS -- use where there are two global names for one
 * function
 */
#ifndef SYM_FUNC_START_ALIAS
#define SYM_FUNC_START_ALIAS(name)			\
	SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
#endif

/* SYM_FUNC_START -- use for global functions */
#ifndef SYM_FUNC_START
/*
 * The same as SYM_FUNC_START_ALIAS, but we will need to distinguish these two
 * later.
 */
#define SYM_FUNC_START(name)				\
	SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
#endif

/* SYM_FUNC_START_LOCAL -- use for local functions */
#ifndef SYM_FUNC_START_LOCAL
/* the same as SYM_FUNC_START_LOCAL_ALIAS, see comment near SYM_FUNC_START */
#define SYM_FUNC_START_LOCAL(name)			\
	SYM_START(name, SYM_L_LOCAL, SYM_A_ALIGN)
#endif

/* SYM_FUNC_END_ALIAS -- the end of LOCAL_ALIASed or ALIASed function */
#ifndef SYM_FUNC_END_ALIAS
#define SYM_FUNC_END_ALIAS(name)			\
	SYM_END(name, SYM_T_FUNC)
#endif

/*
 * SYM_FUNC_END -- the end of SYM_FUNC_START_LOCAL, SYM_FUNC_START,
 * SYM_FUNC_START_WEAK, ...
 */
#ifndef SYM_FUNC_END
/* the same as SYM_FUNC_END_ALIAS, see comment near SYM_FUNC_START */
#define SYM_FUNC_END(name)				\
	SYM_END(name, SYM_T_FUNC)
#endif

#endif	/* PERF_LINUX_LINKAGE_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
ea7872b9 HM	2
	3	#ifndef PERF_LINUX_LINKAGE_H_
	4	#define PERF_LINUX_LINKAGE_H_
	5
	6	/* linkage.h ... for including arch/x86/lib/memcpy_64.S */
	7
bd5c6b81 ACM	8	/* Some toolchains use other characters (e.g. '`') to mark new line in macro */
	9	#ifndef ASM_NL
	10	#define ASM_NL ;
	11	#endif
	12
	13	#ifndef __ALIGN
	14	#define __ALIGN .align 4,0x90
	15	#define __ALIGN_STR ".align 4,0x90"
	16	#endif
	17
	18	/* SYM_T_FUNC -- type used by assembler to mark functions */
	19	#ifndef SYM_T_FUNC
	20	#define SYM_T_FUNC STT_FUNC
	21	#endif
	22
	23	/* SYM_A_* -- align the symbol? */
	24	#define SYM_A_ALIGN ALIGN
	25
	26	/* SYM_L_* -- linkage of symbols */
	27	#define SYM_L_GLOBAL(name) .globl name
	28	#define SYM_L_LOCAL(name) /* nothing */
	29
	30	#define ALIGN __ALIGN
	31
	32	/* === generic annotations === */
	33
	34	/* SYM_ENTRY -- use only if you have to for non-paired symbols */
	35	#ifndef SYM_ENTRY
	36	#define SYM_ENTRY(name, linkage, align...) \
	37	linkage(name) ASM_NL \
	38	align ASM_NL \
ea7872b9	39	name:
bd5c6b81 ACM	40	#endif
	41
	42	/* SYM_START -- use only if you have to */
	43	#ifndef SYM_START
	44	#define SYM_START(name, linkage, align...) \
	45	SYM_ENTRY(name, linkage, align)
	46	#endif
	47
	48	/* SYM_END -- use only if you have to */
	49	#ifndef SYM_END
	50	#define SYM_END(name, sym_type) \
	51	.type name sym_type ASM_NL \
	52	.size name, .-name
	53	#endif
	54
	55	/*
	56	* SYM_FUNC_START_ALIAS -- use where there are two global names for one
	57	* function
	58	*/
	59	#ifndef SYM_FUNC_START_ALIAS
	60	#define SYM_FUNC_START_ALIAS(name) \
	61	SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
	62	#endif
	63
	64	/* SYM_FUNC_START -- use for global functions */
	65	#ifndef SYM_FUNC_START
	66	/*
	67	* The same as SYM_FUNC_START_ALIAS, but we will need to distinguish these two
	68	* later.
	69	*/
	70	#define SYM_FUNC_START(name) \
	71	SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
	72	#endif
	73
	74	/* SYM_FUNC_START_LOCAL -- use for local functions */
	75	#ifndef SYM_FUNC_START_LOCAL
	76	/* the same as SYM_FUNC_START_LOCAL_ALIAS, see comment near SYM_FUNC_START */
	77	#define SYM_FUNC_START_LOCAL(name) \
	78	SYM_START(name, SYM_L_LOCAL, SYM_A_ALIGN)
	79	#endif
	80
	81	/* SYM_FUNC_END_ALIAS -- the end of LOCAL_ALIASed or ALIASed function */
	82	#ifndef SYM_FUNC_END_ALIAS
	83	#define SYM_FUNC_END_ALIAS(name) \
	84	SYM_END(name, SYM_T_FUNC)
	85	#endif
ea7872b9	86
bd5c6b81 ACM	87	/*
	88	* SYM_FUNC_END -- the end of SYM_FUNC_START_LOCAL, SYM_FUNC_START,
	89	* SYM_FUNC_START_WEAK, ...
	90	*/
	91	#ifndef SYM_FUNC_END
	92	/* the same as SYM_FUNC_END_ALIAS, see comment near SYM_FUNC_START */
	93	#define SYM_FUNC_END(name) \
	94	SYM_END(name, SYM_T_FUNC)
	95	#endif
ea7872b9 HM	96
ea7872b9 HM	97	#endif /* PERF_LINUX_LINKAGE_H_ */