[mirror_ubuntu-bionic-kernel.git] / include / linux / init.h

#ifndef _LINUX_INIT_H
#define _LINUX_INIT_H

#include <linux/compiler.h>
#include <linux/types.h>

/* These macros are used to mark some functions or 
 * initialized data (doesn't apply to uninitialized data)
 * as `initialization' functions. The kernel can take this
 * as hint that the function is used only during the initialization
 * phase and free up used memory resources after
 *
 * Usage:
 * For functions:
 * 
 * You should add __init immediately before the function name, like:
 *
 * static void __init initme(int x, int y)
 * {
 *    extern int z; z = x * y;
 * }
 *
 * If the function has a prototype somewhere, you can also add
 * __init between closing brace of the prototype and semicolon:
 *
 * extern int initialize_foobar_device(int, int, int) __init;
 *
 * For initialized data:
 * You should insert __initdata or __initconst between the variable name
 * and equal sign followed by value, e.g.:
 *
 * static int init_variable __initdata = 0;
 * static const char linux_logo[] __initconst = { 0x32, 0x36, ... };
 *
 * Don't forget to initialize data not at file scope, i.e. within a function,
 * as gcc otherwise puts the data into the bss section and not into the init
 * section.
 */

/* These are for everybody (although not all archs will actually
   discard it in modules) */
#define __init		__section(.init.text) __cold notrace
#define __initdata	__section(.init.data)
#define __initconst	__constsection(.init.rodata)
#define __exitdata	__section(.exit.data)
#define __exit_call	__used __section(.exitcall.exit)

/*
 * Some architecture have tool chains which do not handle rodata attributes
 * correctly. For those disable special sections for const, so that other
 * architectures can annotate correctly.
 */
#ifdef CONFIG_BROKEN_RODATA
#define __constsection(x)
#else
#define __constsection(x) __section(x)
#endif

/*
 * modpost check for section mismatches during the kernel build.
 * A section mismatch happens when there are references from a
 * code or data section to an init section (both code or data).
 * The init sections are (for most archs) discarded by the kernel
 * when early init has completed so all such references are potential bugs.
 * For exit sections the same issue exists.
 *
 * The following markers are used for the cases where the reference to
 * the *init / *exit section (code or data) is valid and will teach
 * modpost not to issue a warning.  Intended semantics is that a code or
 * data tagged __ref* can reference code or data from init section without
 * producing a warning (of course, no warning does not mean code is
 * correct, so optimally document why the __ref is needed and why it's OK).
 *
 * The markers follow same syntax rules as __init / __initdata.
 */
#define __ref            __section(.ref.text) noinline
#define __refdata        __section(.ref.data)
#define __refconst       __constsection(.ref.rodata)

/* compatibility defines */
#define __init_refok     __ref
#define __initdata_refok __refdata
#define __exit_refok     __ref


#ifdef MODULE
#define __exitused
#else
#define __exitused  __used
#endif

#define __exit          __section(.exit.text) __exitused __cold notrace

/* temporary, until all users are removed */
#define __cpuinit
#define __cpuinitdata
#define __cpuinitconst
#define __cpuexit
#define __cpuexitdata
#define __cpuexitconst

/* Used for MEMORY_HOTPLUG */
#define __meminit        __section(.meminit.text) __cold notrace
#define __meminitdata    __section(.meminit.data)
#define __meminitconst   __constsection(.meminit.rodata)
#define __memexit        __section(.memexit.text) __exitused __cold notrace
#define __memexitdata    __section(.memexit.data)
#define __memexitconst   __constsection(.memexit.rodata)

/* For assembly routines */
#define __HEAD		.section	".head.text","ax"
#define __INIT		.section	".init.text","ax"
#define __FINIT		.previous

#define __INITDATA	.section	".init.data","aw",%progbits
#define __INITRODATA	.section	".init.rodata","a",%progbits
#define __FINITDATA	.previous

/* temporary, until all users are removed */
#define __CPUINIT

#define __MEMINIT        .section	".meminit.text", "ax"
#define __MEMINITDATA    .section	".meminit.data", "aw"
#define __MEMINITRODATA  .section	".meminit.rodata", "a"

/* silence warnings when references are OK */
#define __REF            .section       ".ref.text", "ax"
#define __REFDATA        .section       ".ref.data", "aw"
#define __REFCONST       .section       ".ref.rodata", "a"

#ifndef __ASSEMBLY__
/*
 * Used for initialization calls..
 */
typedef int (*initcall_t)(void);
typedef void (*exitcall_t)(void);

extern initcall_t __con_initcall_start[], __con_initcall_end[];
extern initcall_t __security_initcall_start[], __security_initcall_end[];

/* Used for contructor calls. */
typedef void (*ctor_fn_t)(void);

/* Defined in init/main.c */
extern int do_one_initcall(initcall_t fn);
extern char __initdata boot_command_line[];
extern char *saved_command_line;
extern unsigned int reset_devices;

/* used by init/main.c */
void setup_arch(char **);
void prepare_namespace(void);
void __init load_default_modules(void);
int __init init_rootfs(void);

extern void (*late_time_init)(void);

extern bool initcall_debug;

#endif
  
#ifndef MODULE

#ifndef __ASSEMBLY__

#ifdef CONFIG_LTO
/* Work around a LTO gcc problem: when there is no reference to a variable
 * in a module it will be moved to the end of the program. This causes
 * reordering of initcalls which the kernel does not like.
 * Add a dummy reference function to avoid this. The function is
 * deleted by the linker.
 */
#define LTO_REFERENCE_INITCALL(x) \
	; /* yes this is needed */			\
	static __used __exit void *reference_##x(void)	\
	{						\
		return &x;				\
	}
#else
#define LTO_REFERENCE_INITCALL(x)
#endif

/* initcalls are now grouped by functionality into separate 
 * subsections. Ordering inside the subsections is determined
 * by link order. 
 * For backwards compatibility, initcall() puts the call in 
 * the device init subsection.
 *
 * The `id' arg to __define_initcall() is needed so that multiple initcalls
 * can point at the same handler without causing duplicate-symbol build errors.
 */

#define __define_initcall(fn, id) \
	static initcall_t __initcall_##fn##id __used \
	__attribute__((__section__(".initcall" #id ".init"))) = fn; \
	LTO_REFERENCE_INITCALL(__initcall_##fn##id)

/*
 * Early initcalls run before initializing SMP.
 *
 * Only for built-in code, not modules.
 */
#define early_initcall(fn)		__define_initcall(fn, early)

/*
 * A "pure" initcall has no dependencies on anything else, and purely
 * initializes variables that couldn't be statically initialized.
 *
 * This only exists for built-in code, not for modules.
 * Keep main.c:initcall_level_names[] in sync.
 */
#define pure_initcall(fn)		__define_initcall(fn, 0)

#define core_initcall(fn)		__define_initcall(fn, 1)
#define core_initcall_sync(fn)		__define_initcall(fn, 1s)
#define postcore_initcall(fn)		__define_initcall(fn, 2)
#define postcore_initcall_sync(fn)	__define_initcall(fn, 2s)
#define arch_initcall(fn)		__define_initcall(fn, 3)
#define arch_initcall_sync(fn)		__define_initcall(fn, 3s)
#define subsys_initcall(fn)		__define_initcall(fn, 4)
#define subsys_initcall_sync(fn)	__define_initcall(fn, 4s)
#define fs_initcall(fn)			__define_initcall(fn, 5)
#define fs_initcall_sync(fn)		__define_initcall(fn, 5s)
#define rootfs_initcall(fn)		__define_initcall(fn, rootfs)
#define device_initcall(fn)		__define_initcall(fn, 6)
#define device_initcall_sync(fn)	__define_initcall(fn, 6s)
#define late_initcall(fn)		__define_initcall(fn, 7)
#define late_initcall_sync(fn)		__define_initcall(fn, 7s)

#define __initcall(fn) device_initcall(fn)

#define __exitcall(fn) \
	static exitcall_t __exitcall_##fn __exit_call = fn

#define console_initcall(fn) \
	static initcall_t __initcall_##fn \
	__used __section(.con_initcall.init) = fn

#define security_initcall(fn) \
	static initcall_t __initcall_##fn \
	__used __section(.security_initcall.init) = fn

struct obs_kernel_param {
	const char *str;
	int (*setup_func)(char *);
	int early;
};

/*
 * Only for really core code.  See moduleparam.h for the normal way.
 *
 * Force the alignment so the compiler doesn't space elements of the
 * obs_kernel_param "array" too far apart in .init.setup.
 */
#define __setup_param(str, unique_id, fn, early)			\
	static const char __setup_str_##unique_id[] __initconst	\
		__aligned(1) = str; \
	static struct obs_kernel_param __setup_##unique_id	\
		__used __section(.init.setup)			\
		__attribute__((aligned((sizeof(long)))))	\
		= { __setup_str_##unique_id, fn, early }

#define __setup(str, fn)					\
	__setup_param(str, fn, fn, 0)

/* NOTE: fn is as per module_param, not __setup!  Emits warning if fn
 * returns non-zero. */
#define early_param(str, fn)					\
	__setup_param(str, fn, fn, 1)

#define early_param_on_off(str_on, str_off, var, config)			\
	int var = IS_ENABLED(config);				\
	static int __init parse_##var##_on(char *arg)		\
	{							\
		var = 1;					\
		return 0;					\
	}							\
	static int __init parse_##var##_off(char *arg)		\
	{							\
		var = 0;					\
		return 0;					\
	}							\
	__setup_param(str_on, parse_##var##_on, parse_##var##_on, 1); \
	__setup_param(str_off, parse_##var##_off, parse_##var##_off, 1)

/* Relies on boot_command_line being set */
void __init parse_early_param(void);
void __init parse_early_options(char *cmdline);
#endif /* __ASSEMBLY__ */

/**
 * module_init() - driver initialization entry point
 * @x: function to be run at kernel boot time or module insertion
 * 
 * module_init() will either be called during do_initcalls() (if
 * builtin) or at module insertion time (if a module).  There can only
 * be one per module.
 */
#define module_init(x)	__initcall(x);

/**
 * module_exit() - driver exit entry point
 * @x: function to be run when driver is removed
 * 
 * module_exit() will wrap the driver clean-up code
 * with cleanup_module() when used with rmmod when
 * the driver is a module.  If the driver is statically
 * compiled into the kernel, module_exit() has no effect.
 * There can only be one per module.
 */
#define module_exit(x)	__exitcall(x);

#else /* MODULE */

/*
 * In most cases loadable modules do not need custom
 * initcall levels. There are still some valid cases where
 * a driver may be needed early if built in, and does not
 * matter when built as a loadable module. Like bus
 * snooping debug drivers.
 */
#define early_initcall(fn)		module_init(fn)
#define core_initcall(fn)		module_init(fn)
#define core_initcall_sync(fn)		module_init(fn)
#define postcore_initcall(fn)		module_init(fn)
#define postcore_initcall_sync(fn)	module_init(fn)
#define arch_initcall(fn)		module_init(fn)
#define subsys_initcall(fn)		module_init(fn)
#define subsys_initcall_sync(fn)	module_init(fn)
#define fs_initcall(fn)			module_init(fn)
#define fs_initcall_sync(fn)		module_init(fn)
#define rootfs_initcall(fn)		module_init(fn)
#define device_initcall(fn)		module_init(fn)
#define device_initcall_sync(fn)	module_init(fn)
#define late_initcall(fn)		module_init(fn)
#define late_initcall_sync(fn)		module_init(fn)

#define console_initcall(fn)		module_init(fn)
#define security_initcall(fn)		module_init(fn)

/* Each module must use one module_init(). */
#define module_init(initfn)					\
	static inline initcall_t __inittest(void)		\
	{ return initfn; }					\
	int init_module(void) __attribute__((alias(#initfn)));

/* This is only required if you want to be unloadable. */
#define module_exit(exitfn)					\
	static inline exitcall_t __exittest(void)		\
	{ return exitfn; }					\
	void cleanup_module(void) __attribute__((alias(#exitfn)));

#define __setup_param(str, unique_id, fn)	/* nothing */
#define __setup(str, func) 			/* nothing */
#endif

/* Data marked not to be saved by software suspend */
#define __nosavedata __section(.data..nosave)

/* This means "can be init if no module support, otherwise module load
   may call it." */
#ifdef CONFIG_MODULES
#define __init_or_module
#define __initdata_or_module
#define __initconst_or_module
#define __INIT_OR_MODULE	.text
#define __INITDATA_OR_MODULE	.data
#define __INITRODATA_OR_MODULE	.section ".rodata","a",%progbits
#else
#define __init_or_module __init
#define __initdata_or_module __initdata
#define __initconst_or_module __initconst
#define __INIT_OR_MODULE __INIT
#define __INITDATA_OR_MODULE __INITDATA
#define __INITRODATA_OR_MODULE __INITRODATA
#endif /*CONFIG_MODULES*/

#ifdef MODULE
#define __exit_p(x) x
#else
#define __exit_p(x) NULL
#endif

#endif /* _LINUX_INIT_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_INIT_H
	2	#define _LINUX_INIT_H
	3
1da177e4	4	#include <linux/compiler.h>
2329abfa	5	#include <linux/types.h>
1da177e4 LT	6
	7	/* These macros are used to mark some functions or
	8	* initialized data (doesn't apply to uninitialized data)
	9	* as `initialization' functions. The kernel can take this
	10	* as hint that the function is used only during the initialization
	11	* phase and free up used memory resources after
	12	*
	13	* Usage:
	14	* For functions:
	15	*
	16	* You should add __init immediately before the function name, like:
	17	*
	18	* static void __init initme(int x, int y)
	19	* {
	20	* extern int z; z = x * y;
	21	* }
	22	*
	23	* If the function has a prototype somewhere, you can also add
	24	* __init between closing brace of the prototype and semicolon:
	25	*
	26	* extern int initialize_foobar_device(int, int, int) __init;
	27	*
	28	* For initialized data:
65321547 GU	29	* You should insert __initdata or __initconst between the variable name
65321547 GU	30	* and equal sign followed by value, e.g.:
1da177e4 LT	31	*
1da177e4 LT	32	* static int init_variable __initdata = 0;
ae52bb23	33	* static const char linux_logo[] __initconst = { 0x32, 0x36, ... };
1da177e4 LT	34	*
	35	* Don't forget to initialize data not at file scope, i.e. within a function,
	36	* as gcc otherwise puts the data into the bss section and not into the init
	37	* section.
1da177e4 LT	38	*/
	39
	40	/* These are for everybody (although not all archs will actually
	41	discard it in modules) */
fed1939c	42	#define __init __section(.init.text) __cold notrace
f3fe866d	43	#define __initdata __section(.init.data)
754b7b63	44	#define __initconst __constsection(.init.rodata)
f3fe866d	45	#define __exitdata __section(.exit.data)
3ff6eecc	46	#define __exit_call __used __section(.exitcall.exit)
1da177e4	47
754b7b63 AK	48	/*
	49	* Some architecture have tool chains which do not handle rodata attributes
	50	* correctly. For those disable special sections for const, so that other
	51	* architectures can annotate correctly.
	52	*/
	53	#ifdef CONFIG_BROKEN_RODATA
	54	#define __constsection(x)
	55	#else
	56	#define __constsection(x) __section(x)
	57	#endif
	58
5ea08178 MN	59	/*
5ea08178 MN	60	* modpost check for section mismatches during the kernel build.
0e0d314e SR	61	* A section mismatch happens when there are references from a
	62	* code or data section to an init section (both code or data).
	63	* The init sections are (for most archs) discarded by the kernel
	64	* when early init has completed so all such references are potential bugs.
	65	* For exit sections the same issue exists.
5ea08178	66	*
0e0d314e	67	* The following markers are used for the cases where the reference to
312b1485	68	* the init / exit section (code or data) is valid and will teach
5ea08178 MN	69	* modpost not to issue a warning. Intended semantics is that a code or
	70	* data tagged __ref* can reference code or data from init section without
	71	* producing a warning (of course, no warning does not mean code is
	72	* correct, so optimally document why the __ref is needed and why it's OK).
	73	*
	74	* The markers follow same syntax rules as __init / __initdata.
	75	*/
312b1485 SR	76	#define __ref __section(.ref.text) noinline
312b1485 SR	77	#define __refdata __section(.ref.data)
754b7b63	78	#define __refconst __constsection(.ref.rodata)
312b1485	79
312b1485 SR	80	/* compatibility defines */
	81	#define __init_refok __ref
	82	#define __initdata_refok __refdata
	83	#define __exit_refok __ref
	84
0e0d314e	85
1da177e4	86	#ifdef MODULE
eb8f6890	87	#define __exitused
1da177e4	88	#else
eb8f6890	89	#define __exitused __used
1da177e4 LT	90	#endif
1da177e4 LT	91
f0201738	92	#define __exit __section(.exit.text) __exitused __cold notrace
eb8f6890	93
22f0a273 PG	94	/* temporary, until all users are removed */
	95	#define __cpuinit
	96	#define __cpuinitdata
	97	#define __cpuinitconst
	98	#define __cpuexit
	99	#define __cpuexitdata
	100	#define __cpuexitconst
eb8f6890 SR	101
eb8f6890 SR	102	/* Used for MEMORY_HOTPLUG */
f0201738	103	#define __meminit __section(.meminit.text) __cold notrace
eb8f6890	104	#define __meminitdata __section(.meminit.data)
754b7b63	105	#define __meminitconst __constsection(.meminit.rodata)
f0201738	106	#define __memexit __section(.memexit.text) __exitused __cold notrace
eb8f6890	107	#define __memexitdata __section(.memexit.data)
754b7b63	108	#define __memexitconst __constsection(.memexit.rodata)
eb8f6890	109
1da177e4	110	/* For assembly routines */
7923f90f	111	#define __HEAD .section ".head.text","ax"
1da177e4	112	#define __INIT .section ".init.text","ax"
86c0baf1	113	#define __FINIT .previous
eb8f6890	114
8b5a10fc JB	115	#define __INITDATA .section ".init.data","aw",%progbits
8b5a10fc JB	116	#define __INITRODATA .section ".init.rodata","a",%progbits
9f9975a5	117	#define __FINITDATA .previous
1da177e4	118
22f0a273 PG	119	/* temporary, until all users are removed */
22f0a273 PG	120	#define __CPUINIT
eb8f6890 SR	121
	122	#define __MEMINIT .section ".meminit.text", "ax"
	123	#define __MEMINITDATA .section ".meminit.data", "aw"
3f5e26ce	124	#define __MEMINITRODATA .section ".meminit.rodata", "a"
eb8f6890	125
312b1485 SR	126	/* silence warnings when references are OK */
	127	#define __REF .section ".ref.text", "ax"
	128	#define __REFDATA .section ".ref.data", "aw"
3f5e26ce	129	#define __REFCONST .section ".ref.rodata", "a"
312b1485	130
1da177e4 LT	131	#ifndef __ASSEMBLY__
	132	/*
	133	* Used for initialization calls..
	134	*/
	135	typedef int (*initcall_t)(void);
	136	typedef void (*exitcall_t)(void);
	137
	138	extern initcall_t __con_initcall_start[], __con_initcall_end[];
	139	extern initcall_t __security_initcall_start[], __security_initcall_end[];
	140
b99b87f7 PO	141	/* Used for contructor calls. */
	142	typedef void (*ctor_fn_t)(void);
	143
1da177e4	144	/* Defined in init/main.c */
59f9415f	145	extern int do_one_initcall(initcall_t fn);
30d7e0d4 ABL	146	extern char __initdata boot_command_line[];
30d7e0d4 ABL	147	extern char *saved_command_line;
7e96287d	148	extern unsigned int reset_devices;
77d47582 AB	149
77d47582 AB	150	/* used by init/main.c */
46595390 AB	151	void setup_arch(char **);
46595390 AB	152	void prepare_namespace(void);
bb813f4c	153	void __init load_default_modules(void);
57f150a5	154	int __init init_rootfs(void);
77d47582	155
7d195a54 AB	156	extern void (*late_time_init)(void);
7d195a54 AB	157
2329abfa	158	extern bool initcall_debug;
f2511774	159
1da177e4 LT	160	#endif
	161
	162	#ifndef MODULE
	163
	164	#ifndef __ASSEMBLY__
	165
ef1b893c AK	166	#ifdef CONFIG_LTO
	167	/* Work around a LTO gcc problem: when there is no reference to a variable
	168	* in a module it will be moved to the end of the program. This causes
	169	* reordering of initcalls which the kernel does not like.
	170	* Add a dummy reference function to avoid this. The function is
	171	* deleted by the linker.
	172	*/
	173	#define LTO_REFERENCE_INITCALL(x) \
	174	; /* yes this is needed */ \
	175	static __used __exit void *reference_##x(void) \
	176	{ \
	177	return &x; \
	178	}
	179	#else
	180	#define LTO_REFERENCE_INITCALL(x)
	181	#endif
	182
1da177e4 LT	183	/* initcalls are now grouped by functionality into separate
	184	* subsections. Ordering inside the subsections is determined
	185	* by link order.
	186	* For backwards compatibility, initcall() puts the call in
	187	* the device init subsection.
735a7ffb AM	188	*
	189	* The `id' arg to __define_initcall() is needed so that multiple initcalls
	190	* can point at the same handler without causing duplicate-symbol build errors.
1da177e4 LT	191	*/
1da177e4 LT	192
7929d407	193	#define __define_initcall(fn, id) \
3ff6eecc	194	static initcall_t __initcall_##fn##id __used \
ef1b893c AK	195	__attribute__((__section__(".initcall" #id ".init"))) = fn; \
ef1b893c AK	196	LTO_REFERENCE_INITCALL(__initcall_##fn##id)
1da177e4	197
c2147a50 EGM	198	/*
	199	* Early initcalls run before initializing SMP.
	200	*
	201	* Only for built-in code, not modules.
	202	*/
7929d407	203	#define early_initcall(fn) __define_initcall(fn, early)
c2147a50	204
b3438f82 LT	205	/*
	206	* A "pure" initcall has no dependencies on anything else, and purely
	207	* initializes variables that couldn't be statically initialized.
	208	*
	209	* This only exists for built-in code, not for modules.
96263d28	210	* Keep main.c:initcall_level_names[] in sync.
b3438f82	211	*/
7929d407 ML	212	#define pure_initcall(fn) __define_initcall(fn, 0)
	213
	214	#define core_initcall(fn) __define_initcall(fn, 1)
	215	#define core_initcall_sync(fn) __define_initcall(fn, 1s)
	216	#define postcore_initcall(fn) __define_initcall(fn, 2)
	217	#define postcore_initcall_sync(fn) __define_initcall(fn, 2s)
	218	#define arch_initcall(fn) __define_initcall(fn, 3)
	219	#define arch_initcall_sync(fn) __define_initcall(fn, 3s)
	220	#define subsys_initcall(fn) __define_initcall(fn, 4)
	221	#define subsys_initcall_sync(fn) __define_initcall(fn, 4s)
	222	#define fs_initcall(fn) __define_initcall(fn, 5)
	223	#define fs_initcall_sync(fn) __define_initcall(fn, 5s)
	224	#define rootfs_initcall(fn) __define_initcall(fn, rootfs)
	225	#define device_initcall(fn) __define_initcall(fn, 6)
	226	#define device_initcall_sync(fn) __define_initcall(fn, 6s)
	227	#define late_initcall(fn) __define_initcall(fn, 7)
	228	#define late_initcall_sync(fn) __define_initcall(fn, 7s)
1da177e4 LT	229
	230	#define __initcall(fn) device_initcall(fn)
	231
	232	#define __exitcall(fn) \
	233	static exitcall_t __exitcall_##fn __exit_call = fn
	234
	235	#define console_initcall(fn) \
	236	static initcall_t __initcall_##fn \
3ff6eecc	237	__used __section(.con_initcall.init) = fn
1da177e4 LT	238
	239	#define security_initcall(fn) \
	240	static initcall_t __initcall_##fn \
3ff6eecc	241	__used __section(.security_initcall.init) = fn
1da177e4 LT	242
	243	struct obs_kernel_param {
	244	const char *str;
	245	int (setup_func)(char );
	246	int early;
	247	};
	248
	249	/*
	250	* Only for really core code. See moduleparam.h for the normal way.
	251	*
	252	* Force the alignment so the compiler doesn't space elements of the
	253	* obs_kernel_param "array" too far apart in .init.setup.
	254	*/
	255	#define __setup_param(str, unique_id, fn, early) \
fd6c3a8d JB	256	static const char __setup_str_##unique_id[] __initconst \
fd6c3a8d JB	257	__aligned(1) = str; \
1da177e4	258	static struct obs_kernel_param __setup_##unique_id \
3ff6eecc	259	__used __section(.init.setup) \
1da177e4 LT	260	__attribute__((aligned((sizeof(long))))) \
	261	= { __setup_str_##unique_id, fn, early }
	262
1da177e4 LT	263	#define __setup(str, fn) \
	264	__setup_param(str, fn, fn, 0)
	265
1da177e4 LT	266	/* NOTE: fn is as per module_param, not __setup! Emits warning if fn
	267	* returns non-zero. */
	268	#define early_param(str, fn) \
	269	__setup_param(str, fn, fn, 1)
	270
bfb33bad LR	271	#define early_param_on_off(str_on, str_off, var, config) \
	272	int var = IS_ENABLED(config); \
	273	static int __init parse_##var##_on(char *arg) \
	274	{ \
	275	var = 1; \
	276	return 0; \
	277	} \
	278	static int __init parse_##var##_off(char *arg) \
	279	{ \
	280	var = 0; \
	281	return 0; \
	282	} \
	283	__setup_param(str_on, parse_##var##_on, parse_##var##_on, 1); \
	284	__setup_param(str_off, parse_##var##_off, parse_##var##_off, 1)
	285
30d7e0d4	286	/* Relies on boot_command_line being set */
1da177e4	287	void __init parse_early_param(void);
13977091	288	void __init parse_early_options(char *cmdline);
1da177e4 LT	289	#endif /* __ASSEMBLY__ */
	290
	291	/**
	292	* module_init() - driver initialization entry point
	293	* @x: function to be run at kernel boot time or module insertion
	294	*
72fd4a35	295	* module_init() will either be called during do_initcalls() (if
1da177e4 LT	296	* builtin) or at module insertion time (if a module). There can only
	297	* be one per module.
	298	*/
	299	#define module_init(x) __initcall(x);
	300
	301	/**
	302	* module_exit() - driver exit entry point
	303	* @x: function to be run when driver is removed
	304	*
	305	* module_exit() will wrap the driver clean-up code
	306	* with cleanup_module() when used with rmmod when
	307	* the driver is a module. If the driver is statically
	308	* compiled into the kernel, module_exit() has no effect.
	309	* There can only be one per module.
	310	*/
	311	#define module_exit(x) __exitcall(x);
	312
	313	#else /* MODULE */
	314
451ef1ca TL	315	/*
	316	* In most cases loadable modules do not need custom
	317	* initcall levels. There are still some valid cases where
	318	* a driver may be needed early if built in, and does not
	319	* matter when built as a loadable module. Like bus
	320	* snooping debug drivers.
	321	*/
329bd411	322	#define early_initcall(fn) module_init(fn)
1da177e4	323	#define core_initcall(fn) module_init(fn)
451ef1ca	324	#define core_initcall_sync(fn) module_init(fn)
1da177e4	325	#define postcore_initcall(fn) module_init(fn)
451ef1ca	326	#define postcore_initcall_sync(fn) module_init(fn)
1da177e4 LT	327	#define arch_initcall(fn) module_init(fn)
1da177e4 LT	328	#define subsys_initcall(fn) module_init(fn)
451ef1ca	329	#define subsys_initcall_sync(fn) module_init(fn)
1da177e4	330	#define fs_initcall(fn) module_init(fn)
451ef1ca	331	#define fs_initcall_sync(fn) module_init(fn)
b46d0c46	332	#define rootfs_initcall(fn) module_init(fn)
1da177e4	333	#define device_initcall(fn) module_init(fn)
451ef1ca	334	#define device_initcall_sync(fn) module_init(fn)
1da177e4	335	#define late_initcall(fn) module_init(fn)
451ef1ca	336	#define late_initcall_sync(fn) module_init(fn)
1da177e4	337
b46d0c46	338	#define console_initcall(fn) module_init(fn)
1da177e4 LT	339	#define security_initcall(fn) module_init(fn)
1da177e4 LT	340
4500d067	341	/* Each module must use one module_init(). */
1da177e4 LT	342	#define module_init(initfn) \
	343	static inline initcall_t __inittest(void) \
	344	{ return initfn; } \
	345	int init_module(void) __attribute__((alias(#initfn)));
	346
	347	/* This is only required if you want to be unloadable. */
	348	#define module_exit(exitfn) \
	349	static inline exitcall_t __exittest(void) \
	350	{ return exitfn; } \
	351	void cleanup_module(void) __attribute__((alias(#exitfn)));
	352
	353	#define __setup_param(str, unique_id, fn) /* nothing */
1da177e4	354	#define __setup(str, func) /* nothing */
1da177e4 LT	355	#endif
1da177e4 LT	356
ab3bfca7	357	/* Data marked not to be saved by software suspend */
07b3bb1e	358	#define __nosavedata __section(.data..nosave)
1da177e4 LT	359
	360	/* This means "can be init if no module support, otherwise module load
	361	may call it." */
	362	#ifdef CONFIG_MODULES
	363	#define __init_or_module
	364	#define __initdata_or_module
8b5a10fc JB	365	#define __initconst_or_module
	366	#define __INIT_OR_MODULE .text
	367	#define __INITDATA_OR_MODULE .data
	368	#define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
1da177e4 LT	369	#else
	370	#define __init_or_module __init
	371	#define __initdata_or_module __initdata
8b5a10fc JB	372	#define __initconst_or_module __initconst
	373	#define __INIT_OR_MODULE __INIT
	374	#define __INITDATA_OR_MODULE __INITDATA
	375	#define __INITRODATA_OR_MODULE __INITRODATA
1da177e4 LT	376	#endif /CONFIG_MODULES/
1da177e4 LT	377
1da177e4 LT	378	#ifdef MODULE
	379	#define __exit_p(x) x
	380	#else
	381	#define __exit_p(x) NULL
	382	#endif
	383
	384	#endif /* _LINUX_INIT_H */