Merge tag 'iommu-updates-v6.4' of git://git.kernel.org/pub/scm/linux/kernel/git/joro...
[linux-2.6-block.git] / include / linux / init.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _LINUX_INIT_H
3#define _LINUX_INIT_H
4
de985c10 5#include <linux/build_bug.h>
1da177e4 6#include <linux/compiler.h>
de985c10 7#include <linux/stringify.h>
2329abfa 8#include <linux/types.h>
1da177e4 9
66f79309 10/* Built-in __init functions needn't be compiled with retpoline */
87358710
DW
11#if defined(__noretpoline) && !defined(MODULE)
12#define __noinitretpoline __noretpoline
66f79309 13#else
87358710 14#define __noinitretpoline
66f79309
DW
15#endif
16
1da177e4
LT
17/* These macros are used to mark some functions or
18 * initialized data (doesn't apply to uninitialized data)
19 * as `initialization' functions. The kernel can take this
20 * as hint that the function is used only during the initialization
21 * phase and free up used memory resources after
22 *
23 * Usage:
24 * For functions:
25 *
26 * You should add __init immediately before the function name, like:
27 *
28 * static void __init initme(int x, int y)
29 * {
30 * extern int z; z = x * y;
31 * }
32 *
33 * If the function has a prototype somewhere, you can also add
34 * __init between closing brace of the prototype and semicolon:
35 *
36 * extern int initialize_foobar_device(int, int, int) __init;
37 *
38 * For initialized data:
65321547
GU
39 * You should insert __initdata or __initconst between the variable name
40 * and equal sign followed by value, e.g.:
1da177e4
LT
41 *
42 * static int init_variable __initdata = 0;
ae52bb23 43 * static const char linux_logo[] __initconst = { 0x32, 0x36, ... };
1da177e4
LT
44 *
45 * Don't forget to initialize data not at file scope, i.e. within a function,
46 * as gcc otherwise puts the data into the bss section and not into the init
47 * section.
1da177e4
LT
48 */
49
50/* These are for everybody (although not all archs will actually
51 discard it in modules) */
5dbbb3ea 52#define __init __section(".init.text") __cold __latent_entropy __noinitretpoline
33def849
JP
53#define __initdata __section(".init.data")
54#define __initconst __section(".init.rodata")
55#define __exitdata __section(".exit.data")
56#define __exit_call __used __section(".exitcall.exit")
1da177e4 57
5ea08178
MN
58/*
59 * modpost check for section mismatches during the kernel build.
0e0d314e
SR
60 * A section mismatch happens when there are references from a
61 * code or data section to an init section (both code or data).
62 * The init sections are (for most archs) discarded by the kernel
63 * when early init has completed so all such references are potential bugs.
64 * For exit sections the same issue exists.
5ea08178 65 *
0e0d314e 66 * The following markers are used for the cases where the reference to
312b1485 67 * the *init / *exit section (code or data) is valid and will teach
5ea08178
MN
68 * modpost not to issue a warning. Intended semantics is that a code or
69 * data tagged __ref* can reference code or data from init section without
70 * producing a warning (of course, no warning does not mean code is
71 * correct, so optimally document why the __ref is needed and why it's OK).
72 *
73 * The markers follow same syntax rules as __init / __initdata.
74 */
33def849
JP
75#define __ref __section(".ref.text") noinline
76#define __refdata __section(".ref.data")
77#define __refconst __section(".ref.rodata")
312b1485 78
1da177e4 79#ifdef MODULE
eb8f6890 80#define __exitused
1da177e4 81#else
eb8f6890 82#define __exitused __used
1da177e4
LT
83#endif
84
33def849 85#define __exit __section(".exit.text") __exitused __cold notrace
eb8f6890 86
eb8f6890 87/* Used for MEMORY_HOTPLUG */
33def849 88#define __meminit __section(".meminit.text") __cold notrace \
0766f788 89 __latent_entropy
33def849
JP
90#define __meminitdata __section(".meminit.data")
91#define __meminitconst __section(".meminit.rodata")
92#define __memexit __section(".memexit.text") __exitused __cold notrace
93#define __memexitdata __section(".memexit.data")
94#define __memexitconst __section(".memexit.rodata")
eb8f6890 95
1da177e4 96/* For assembly routines */
7923f90f 97#define __HEAD .section ".head.text","ax"
1da177e4 98#define __INIT .section ".init.text","ax"
86c0baf1 99#define __FINIT .previous
eb8f6890 100
8b5a10fc
JB
101#define __INITDATA .section ".init.data","aw",%progbits
102#define __INITRODATA .section ".init.rodata","a",%progbits
9f9975a5 103#define __FINITDATA .previous
1da177e4 104
eb8f6890
SR
105#define __MEMINIT .section ".meminit.text", "ax"
106#define __MEMINITDATA .section ".meminit.data", "aw"
3f5e26ce 107#define __MEMINITRODATA .section ".meminit.rodata", "a"
eb8f6890 108
312b1485
SR
109/* silence warnings when references are OK */
110#define __REF .section ".ref.text", "ax"
111#define __REFDATA .section ".ref.data", "aw"
3f5e26ce 112#define __REFCONST .section ".ref.rodata", "a"
312b1485 113
1da177e4
LT
114#ifndef __ASSEMBLY__
115/*
116 * Used for initialization calls..
117 */
118typedef int (*initcall_t)(void);
119typedef void (*exitcall_t)(void);
120
1b1eeca7
AB
121#ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
122typedef int initcall_entry_t;
123
124static inline initcall_t initcall_from_entry(initcall_entry_t *entry)
125{
126 return offset_to_ptr(entry);
127}
128#else
129typedef initcall_t initcall_entry_t;
130
131static inline initcall_t initcall_from_entry(initcall_entry_t *entry)
132{
133 return *entry;
134}
135#endif
136
137extern initcall_entry_t __con_initcall_start[], __con_initcall_end[];
1da177e4 138
8f824b4a 139/* Used for constructor calls. */
b99b87f7
PO
140typedef void (*ctor_fn_t)(void);
141
fd3e007f
AV
142struct file_system_type;
143
1da177e4 144/* Defined in init/main.c */
59f9415f 145extern int do_one_initcall(initcall_t fn);
30d7e0d4
ABL
146extern char __initdata boot_command_line[];
147extern char *saved_command_line;
941baf6f 148extern unsigned int saved_command_line_len;
7e96287d 149extern unsigned int reset_devices;
77d47582
AB
150
151/* used by init/main.c */
46595390
AB
152void setup_arch(char **);
153void prepare_namespace(void);
037f11b4 154void __init init_rootfs(void);
fd3e007f 155extern struct file_system_type rootfs_fs_type;
77d47582 156
0f5bf6d0 157#if defined(CONFIG_STRICT_KERNEL_RWX) || defined(CONFIG_STRICT_MODULE_RWX)
39290b38
AT
158extern bool rodata_enabled;
159#endif
0f5bf6d0 160#ifdef CONFIG_STRICT_KERNEL_RWX
e267d97b
KC
161void mark_rodata_ro(void);
162#endif
163
7d195a54
AB
164extern void (*late_time_init)(void);
165
2329abfa 166extern bool initcall_debug;
f2511774 167
1da177e4
LT
168#endif
169
170#ifndef MODULE
171
172#ifndef __ASSEMBLY__
173
b67067f1
NP
174/*
175 * initcalls are now grouped by functionality into separate
1da177e4
LT
176 * subsections. Ordering inside the subsections is determined
177 * by link order.
178 * For backwards compatibility, initcall() puts the call in
179 * the device init subsection.
735a7ffb
AM
180 *
181 * The `id' arg to __define_initcall() is needed so that multiple initcalls
182 * can point at the same handler without causing duplicate-symbol build errors.
b67067f1
NP
183 *
184 * Initcalls are run by placing pointers in initcall sections that the
185 * kernel iterates at runtime. The linker can do dead code / data elimination
186 * and remove that completely, so the initcall sections have to be marked
187 * as KEEP() in the linker script.
1da177e4
LT
188 */
189
a8cccdd9
ST
190/* Format: <modname>__<counter>_<line>_<fn> */
191#define __initcall_id(fn) \
192 __PASTE(__KBUILD_MODNAME, \
193 __PASTE(__, \
194 __PASTE(__COUNTER__, \
195 __PASTE(_, \
196 __PASTE(__LINE__, \
197 __PASTE(_, fn))))))
198
199/* Format: __<prefix>__<iid><id> */
200#define __initcall_name(prefix, __iid, id) \
201 __PASTE(__, \
202 __PASTE(prefix, \
203 __PASTE(__, \
204 __PASTE(__iid, id))))
205
206#ifdef CONFIG_LTO_CLANG
207/*
208 * With LTO, the compiler doesn't necessarily obey link order for
209 * initcalls. In order to preserve the correct order, we add each
210 * variable into its own section and generate a linker script (in
211 * scripts/link-vmlinux.sh) to specify the order of the sections.
212 */
213#define __initcall_section(__sec, __iid) \
214 #__sec ".init.." #__iid
3578ad11
ST
215
216/*
217 * With LTO, the compiler can rename static functions to avoid
218 * global naming collisions. We use a global stub function for
219 * initcalls to create a stable symbol name whose address can be
220 * taken in inline assembly when PREL32 relocations are used.
221 */
222#define __initcall_stub(fn, __iid, id) \
223 __initcall_name(initstub, __iid, id)
224
225#define __define_initcall_stub(__stub, fn) \
5659b598
ST
226 int __init __stub(void); \
227 int __init __stub(void) \
3578ad11
ST
228 { \
229 return fn(); \
230 } \
231 __ADDRESSABLE(__stub)
a8cccdd9
ST
232#else
233#define __initcall_section(__sec, __iid) \
234 #__sec ".init"
3578ad11
ST
235
236#define __initcall_stub(fn, __iid, id) fn
237
238#define __define_initcall_stub(__stub, fn) \
239 __ADDRESSABLE(fn)
a8cccdd9
ST
240#endif
241
1b1eeca7 242#ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
3578ad11
ST
243#define ____define_initcall(fn, __stub, __name, __sec) \
244 __define_initcall_stub(__stub, fn) \
a8cccdd9
ST
245 asm(".section \"" __sec "\", \"a\" \n" \
246 __stringify(__name) ": \n" \
3578ad11 247 ".long " __stringify(__stub) " - . \n" \
1cb61759
ME
248 ".previous \n"); \
249 static_assert(__same_type(initcall_t, &fn));
1b1eeca7 250#else
3578ad11 251#define ____define_initcall(fn, __unused, __name, __sec) \
a8cccdd9
ST
252 static initcall_t __name __used \
253 __attribute__((__section__(__sec))) = fn;
1b1eeca7
AB
254#endif
255
a8cccdd9
ST
256#define __unique_initcall(fn, id, __sec, __iid) \
257 ____define_initcall(fn, \
3578ad11 258 __initcall_stub(fn, __iid, id), \
a8cccdd9
ST
259 __initcall_name(initcall, __iid, id), \
260 __initcall_section(__sec, __iid))
261
262#define ___define_initcall(fn, id, __sec) \
263 __unique_initcall(fn, id, __sec, __initcall_id(fn))
264
1b1eeca7 265#define __define_initcall(fn, id) ___define_initcall(fn, id, .initcall##id)
1da177e4 266
c2147a50
EGM
267/*
268 * Early initcalls run before initializing SMP.
269 *
270 * Only for built-in code, not modules.
271 */
7929d407 272#define early_initcall(fn) __define_initcall(fn, early)
c2147a50 273
b3438f82
LT
274/*
275 * A "pure" initcall has no dependencies on anything else, and purely
276 * initializes variables that couldn't be statically initialized.
277 *
278 * This only exists for built-in code, not for modules.
96263d28 279 * Keep main.c:initcall_level_names[] in sync.
b3438f82 280 */
7929d407
ML
281#define pure_initcall(fn) __define_initcall(fn, 0)
282
283#define core_initcall(fn) __define_initcall(fn, 1)
284#define core_initcall_sync(fn) __define_initcall(fn, 1s)
285#define postcore_initcall(fn) __define_initcall(fn, 2)
286#define postcore_initcall_sync(fn) __define_initcall(fn, 2s)
287#define arch_initcall(fn) __define_initcall(fn, 3)
288#define arch_initcall_sync(fn) __define_initcall(fn, 3s)
289#define subsys_initcall(fn) __define_initcall(fn, 4)
290#define subsys_initcall_sync(fn) __define_initcall(fn, 4s)
291#define fs_initcall(fn) __define_initcall(fn, 5)
292#define fs_initcall_sync(fn) __define_initcall(fn, 5s)
293#define rootfs_initcall(fn) __define_initcall(fn, rootfs)
294#define device_initcall(fn) __define_initcall(fn, 6)
295#define device_initcall_sync(fn) __define_initcall(fn, 6s)
296#define late_initcall(fn) __define_initcall(fn, 7)
297#define late_initcall_sync(fn) __define_initcall(fn, 7s)
1da177e4
LT
298
299#define __initcall(fn) device_initcall(fn)
300
b67067f1 301#define __exitcall(fn) \
1da177e4
LT
302 static exitcall_t __exitcall_##fn __exit_call = fn
303
a8cccdd9 304#define console_initcall(fn) ___define_initcall(fn, con, .con_initcall)
1da177e4
LT
305
306struct obs_kernel_param {
307 const char *str;
308 int (*setup_func)(char *);
309 int early;
310};
311
312/*
313 * Only for really core code. See moduleparam.h for the normal way.
314 *
315 * Force the alignment so the compiler doesn't space elements of the
316 * obs_kernel_param "array" too far apart in .init.setup.
317 */
318#define __setup_param(str, unique_id, fn, early) \
c281b945
IM
319 static const char __setup_str_##unique_id[] __initconst \
320 __aligned(1) = str; \
321 static struct obs_kernel_param __setup_##unique_id \
33def849 322 __used __section(".init.setup") \
147ad605 323 __aligned(__alignof__(struct obs_kernel_param)) \
1da177e4
LT
324 = { __setup_str_##unique_id, fn, early }
325
abc7da58
RD
326/*
327 * NOTE: __setup functions return values:
328 * @fn returns 1 (or non-zero) if the option argument is "handled"
329 * and returns 0 if the option argument is "not handled".
330 */
c281b945 331#define __setup(str, fn) \
1da177e4
LT
332 __setup_param(str, fn, fn, 0)
333
c281b945 334/*
abc7da58
RD
335 * NOTE: @fn is as per module_param, not __setup!
336 * I.e., @fn returns 0 for no error or non-zero for error
337 * (possibly @fn returns a -errno value, but it does not matter).
338 * Emits warning if @fn returns non-zero.
c281b945
IM
339 */
340#define early_param(str, fn) \
1da177e4
LT
341 __setup_param(str, fn, fn, 1)
342
c281b945
IM
343#define early_param_on_off(str_on, str_off, var, config) \
344 \
345 int var = IS_ENABLED(config); \
346 \
347 static int __init parse_##var##_on(char *arg) \
348 { \
349 var = 1; \
350 return 0; \
351 } \
a5a673f7 352 early_param(str_on, parse_##var##_on); \
c281b945
IM
353 \
354 static int __init parse_##var##_off(char *arg) \
355 { \
356 var = 0; \
357 return 0; \
358 } \
a5a673f7 359 early_param(str_off, parse_##var##_off)
bfb33bad 360
30d7e0d4 361/* Relies on boot_command_line being set */
1da177e4 362void __init parse_early_param(void);
13977091 363void __init parse_early_options(char *cmdline);
1da177e4
LT
364#endif /* __ASSEMBLY__ */
365
1da177e4
LT
366#else /* MODULE */
367
1da177e4 368#define __setup_param(str, unique_id, fn) /* nothing */
1da177e4 369#define __setup(str, func) /* nothing */
1da177e4
LT
370#endif
371
ab3bfca7 372/* Data marked not to be saved by software suspend */
33def849 373#define __nosavedata __section(".data..nosave")
1da177e4 374
1da177e4
LT
375#ifdef MODULE
376#define __exit_p(x) x
377#else
378#define __exit_p(x) NULL
379#endif
380
381#endif /* _LINUX_INIT_H */