1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_INIT_H 3 #define _LINUX_INIT_H 4 5 #include <linux/compiler.h> 6 #include <linux/types.h> 7 8 /* Built-in __init functions needn't be compiled with retpoline */ 9 #if defined(__noretpoline) && !defined(MODULE) 10 #define __noinitretpoline __noretpoline 11 #else 12 #define __noinitretpoline 13 #endif 14 15 /* These macros are used to mark some functions or 16 * initialized data (doesn't apply to uninitialized data) 17 * as `initialization' functions. The kernel can take this 18 * as hint that the function is used only during the initialization 19 * phase and free up used memory resources after 20 * 21 * Usage: 22 * For functions: 23 * 24 * You should add __init immediately before the function name, like: 25 * 26 * static void __init initme(int x, int y) 27 * { 28 * extern int z; z = x * y; 29 * } 30 * 31 * If the function has a prototype somewhere, you can also add 32 * __init between closing brace of the prototype and semicolon: 33 * 34 * extern int initialize_foobar_device(int, int, int) __init; 35 * 36 * For initialized data: 37 * You should insert __initdata or __initconst between the variable name 38 * and equal sign followed by value, e.g.: 39 * 40 * static int init_variable __initdata = 0; 41 * static const char linux_logo[] __initconst = { 0x32, 0x36, ... }; 42 * 43 * Don't forget to initialize data not at file scope, i.e. within a function, 44 * as gcc otherwise puts the data into the bss section and not into the init 45 * section. 46 */ 47 48 /* These are for everybody (although not all archs will actually 49 discard it in modules) */ 50 #define __init __section(.init.text) __cold __inittrace __latent_entropy __noinitretpoline __nocfi 51 #define __initdata __section(.init.data) 52 #define __initconst __section(.init.rodata) 53 #define __exitdata __section(.exit.data) 54 #define __exit_call __used __section(.exitcall.exit) 55 56 /* 57 * modpost check for section mismatches during the kernel build. 58 * A section mismatch happens when there are references from a 59 * code or data section to an init section (both code or data). 60 * The init sections are (for most archs) discarded by the kernel 61 * when early init has completed so all such references are potential bugs. 62 * For exit sections the same issue exists. 63 * 64 * The following markers are used for the cases where the reference to 65 * the *init / *exit section (code or data) is valid and will teach 66 * modpost not to issue a warning. Intended semantics is that a code or 67 * data tagged __ref* can reference code or data from init section without 68 * producing a warning (of course, no warning does not mean code is 69 * correct, so optimally document why the __ref is needed and why it's OK). 70 * 71 * The markers follow same syntax rules as __init / __initdata. 72 */ 73 #define __ref __section(.ref.text) noinline 74 #define __refdata __section(.ref.data) 75 #define __refconst __section(.ref.rodata) 76 77 #ifdef MODULE 78 #define __exitused 79 #define __inittrace notrace 80 #else 81 #define __exitused __used 82 #define __inittrace 83 #endif 84 85 #define __exit __section(.exit.text) __exitused __cold notrace 86 87 /* Used for MEMORY_HOTPLUG */ 88 #define __meminit __section(.meminit.text) __cold notrace \ 89 __latent_entropy 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) 95 96 /* For assembly routines */ 97 #define __HEAD .section ".head.text","ax" 98 #define __INIT .section ".init.text","ax" 99 #define __FINIT .previous 100 101 #define __INITDATA .section ".init.data","aw",%progbits 102 #define __INITRODATA .section ".init.rodata","a",%progbits 103 #define __FINITDATA .previous 104 105 #define __MEMINIT .section ".meminit.text", "ax" 106 #define __MEMINITDATA .section ".meminit.data", "aw" 107 #define __MEMINITRODATA .section ".meminit.rodata", "a" 108 109 /* silence warnings when references are OK */ 110 #define __REF .section ".ref.text", "ax" 111 #define __REFDATA .section ".ref.data", "aw" 112 #define __REFCONST .section ".ref.rodata", "a" 113 114 #ifndef __ASSEMBLY__ 115 /* 116 * Used for initialization calls.. 117 */ 118 typedef int (*initcall_t)(void); 119 typedef void (*exitcall_t)(void); 120 121 extern initcall_t __con_initcall_start[], __con_initcall_end[]; 122 extern initcall_t __security_initcall_start[], __security_initcall_end[]; 123 124 /* Used for contructor calls. */ 125 typedef void (*ctor_fn_t)(void); 126 127 /* Defined in init/main.c */ 128 extern int do_one_initcall(initcall_t fn); 129 extern char __initdata boot_command_line[]; 130 extern char *saved_command_line; 131 extern unsigned int reset_devices; 132 133 /* used by init/main.c */ 134 void setup_arch(char **); 135 void prepare_namespace(void); 136 void __init load_default_modules(void); 137 int __init init_rootfs(void); 138 139 #if defined(CONFIG_STRICT_KERNEL_RWX) || defined(CONFIG_STRICT_MODULE_RWX) 140 extern bool rodata_enabled; 141 #endif 142 #ifdef CONFIG_STRICT_KERNEL_RWX 143 void mark_rodata_ro(void); 144 #endif 145 146 extern void (*late_time_init)(void); 147 148 extern bool initcall_debug; 149 150 #endif 151 152 #ifndef MODULE 153 154 #ifndef __ASSEMBLY__ 155 156 #ifdef CONFIG_LTO_CLANG 157 /* prepend the variable name with __COUNTER__ to ensure correct ordering */ 158 #define ___initcall_name2(c, fn, id) __initcall_##c##_##fn##id 159 #define ___initcall_name1(c, fn, id) ___initcall_name2(c, fn, id) 160 #define __initcall_name(fn, id) ___initcall_name1(__COUNTER__, fn, id) 161 #else 162 #define __initcall_name(fn, id) __initcall_##fn##id 163 #endif 164 165 /* 166 * initcalls are now grouped by functionality into separate 167 * subsections. Ordering inside the subsections is determined 168 * by link order. 169 * For backwards compatibility, initcall() puts the call in 170 * the device init subsection. 171 * 172 * The `id' arg to __define_initcall() is needed so that multiple initcalls 173 * can point at the same handler without causing duplicate-symbol build errors. 174 * 175 * Initcalls are run by placing pointers in initcall sections that the 176 * kernel iterates at runtime. The linker can do dead code / data elimination 177 * and remove that completely, so the initcall sections have to be marked 178 * as KEEP() in the linker script. 179 */ 180 181 #define __define_initcall(fn, id) \ 182 static initcall_t __initcall_name(fn, id) __used \ 183 __attribute__((__section__(".initcall" #id ".init"))) = fn; 184 185 /* 186 * Early initcalls run before initializing SMP. 187 * 188 * Only for built-in code, not modules. 189 */ 190 #define early_initcall(fn) __define_initcall(fn, early) 191 192 /* 193 * A "pure" initcall has no dependencies on anything else, and purely 194 * initializes variables that couldn't be statically initialized. 195 * 196 * This only exists for built-in code, not for modules. 197 * Keep main.c:initcall_level_names[] in sync. 198 */ 199 #define pure_initcall(fn) __define_initcall(fn, 0) 200 201 #define core_initcall(fn) __define_initcall(fn, 1) 202 #define core_initcall_sync(fn) __define_initcall(fn, 1s) 203 #define postcore_initcall(fn) __define_initcall(fn, 2) 204 #define postcore_initcall_sync(fn) __define_initcall(fn, 2s) 205 #define arch_initcall(fn) __define_initcall(fn, 3) 206 #define arch_initcall_sync(fn) __define_initcall(fn, 3s) 207 #define subsys_initcall(fn) __define_initcall(fn, 4) 208 #define subsys_initcall_sync(fn) __define_initcall(fn, 4s) 209 #define fs_initcall(fn) __define_initcall(fn, 5) 210 #define fs_initcall_sync(fn) __define_initcall(fn, 5s) 211 #define rootfs_initcall(fn) __define_initcall(fn, rootfs) 212 #define device_initcall(fn) __define_initcall(fn, 6) 213 #define device_initcall_sync(fn) __define_initcall(fn, 6s) 214 #define late_initcall(fn) __define_initcall(fn, 7) 215 #define late_initcall_sync(fn) __define_initcall(fn, 7s) 216 217 #define __initcall(fn) device_initcall(fn) 218 219 #define __exitcall(fn) \ 220 static exitcall_t __exitcall_##fn __exit_call = fn 221 222 #define console_initcall(fn) \ 223 static initcall_t __initcall_##fn \ 224 __used __section(.con_initcall.init) = fn 225 226 #define security_initcall(fn) \ 227 static initcall_t __initcall_##fn \ 228 __used __section(.security_initcall.init) = fn 229 230 struct obs_kernel_param { 231 const char *str; 232 int (*setup_func)(char *); 233 int early; 234 }; 235 236 /* 237 * Only for really core code. See moduleparam.h for the normal way. 238 * 239 * Force the alignment so the compiler doesn't space elements of the 240 * obs_kernel_param "array" too far apart in .init.setup. 241 */ 242 #define __setup_param(str, unique_id, fn, early) \ 243 static const char __setup_str_##unique_id[] __initconst \ 244 __aligned(1) = str; \ 245 static struct obs_kernel_param __setup_##unique_id \ 246 __used __section(.init.setup) \ 247 __attribute__((aligned((sizeof(long))))) \ 248 = { __setup_str_##unique_id, fn, early } 249 250 #define __setup(str, fn) \ 251 __setup_param(str, fn, fn, 0) 252 253 /* 254 * NOTE: fn is as per module_param, not __setup! 255 * Emits warning if fn returns non-zero. 256 */ 257 #define early_param(str, fn) \ 258 __setup_param(str, fn, fn, 1) 259 260 #define early_param_on_off(str_on, str_off, var, config) \ 261 \ 262 int var = IS_ENABLED(config); \ 263 \ 264 static int __init parse_##var##_on(char *arg) \ 265 { \ 266 var = 1; \ 267 return 0; \ 268 } \ 269 __setup_param(str_on, parse_##var##_on, parse_##var##_on, 1); \ 270 \ 271 static int __init parse_##var##_off(char *arg) \ 272 { \ 273 var = 0; \ 274 return 0; \ 275 } \ 276 __setup_param(str_off, parse_##var##_off, parse_##var##_off, 1) 277 278 /* Relies on boot_command_line being set */ 279 void __init parse_early_param(void); 280 void __init parse_early_options(char *cmdline); 281 #endif /* __ASSEMBLY__ */ 282 283 #else /* MODULE */ 284 285 #define __setup_param(str, unique_id, fn) /* nothing */ 286 #define __setup(str, func) /* nothing */ 287 #endif 288 289 /* Data marked not to be saved by software suspend */ 290 #define __nosavedata __section(.data..nosave) 291 292 #ifdef MODULE 293 #define __exit_p(x) x 294 #else 295 #define __exit_p(x) NULL 296 #endif 297 298 #endif /* _LINUX_INIT_H */ 299