include/linux/init.h

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