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(RETPOLINE) && !defined(MODULE)
   9 #define __noretpoline __attribute__((indirect_branch("keep")))
  10 #else
  11 #define __noretpoline
  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 __noretpoline
  50 #define __initdata      __section(.init.data)
  51 #define __initconst     __constsection(.init.rodata)
  52 #define __exitdata      __section(.exit.data)
  53 #define __exit_call     __used __section(.exitcall.exit)
  54
  55 /*
  56  * Some architecture have tool chains which do not handle rodata attributes
  57  * correctly. For those disable special sections for const, so that other
  58  * architectures can annotate correctly.
  59  */
  60 #ifdef CONFIG_BROKEN_RODATA
  61 #define __constsection(x)
  62 #else
  63 #define __constsection(x) __section(x)
  64 #endif
  65
  66 /*
  67  * modpost check for section mismatches during the kernel build.
  68  * A section mismatch happens when there are references from a
  69  * code or data section to an init section (both code or data).
  70  * The init sections are (for most archs) discarded by the kernel
  71  * when early init has completed so all such references are potential bugs.
  72  * For exit sections the same issue exists.
  73  *
  74  * The following markers are used for the cases where the reference to
  75  * the *init / *exit section (code or data) is valid and will teach
  76  * modpost not to issue a warning.  Intended semantics is that a code or
  77  * data tagged __ref* can reference code or data from init section without
  78  * producing a warning (of course, no warning does not mean code is
  79  * correct, so optimally document why the __ref is needed and why it's OK).
  80  *
  81  * The markers follow same syntax rules as __init / __initdata.
  82  */
  83 #define __ref            __section(.ref.text) noinline
  84 #define __refdata        __section(.ref.data)
  85 #define __refconst       __constsection(.ref.rodata)
  86
  87 /* compatibility defines */
  88 #define __init_refok     __ref
  89 #define __initdata_refok __refdata
  90 #define __exit_refok     __ref
  91
  92
  93 #ifdef MODULE
  94 #define __exitused
  95 #else
  96 #define __exitused  __used
  97 #endif
  98
  99 #define __exit          __section(.exit.text) __exitused __cold notrace
 100
 101 /* Used for MEMORY_HOTPLUG */
 102 #define __meminit        __section(.meminit.text) __cold notrace
 103 #define __meminitdata    __section(.meminit.data)
 104 #define __meminitconst   __constsection(.meminit.rodata)
 105 #define __memexit        __section(.memexit.text) __exitused __cold notrace
 106 #define __memexitdata    __section(.memexit.data)
 107 #define __memexitconst   __constsection(.memexit.rodata)
 108
 109 /* For assembly routines */
 110 #define __HEAD          .section        ".head.text","ax"
 111 #define __INIT          .section        ".init.text","ax"
 112 #define __FINIT         .previous
 113
 114 #define __INITDATA      .section        ".init.data","aw",%progbits
 115 #define __INITRODATA    .section        ".init.rodata","a",%progbits
 116 #define __FINITDATA     .previous
 117
 118 #define __MEMINIT        .section       ".meminit.text", "ax"
 119 #define __MEMINITDATA    .section       ".meminit.data", "aw"
 120 #define __MEMINITRODATA  .section       ".meminit.rodata", "a"
 121
 122 /* silence warnings when references are OK */
 123 #define __REF            .section       ".ref.text", "ax"
 124 #define __REFDATA        .section       ".ref.data", "aw"
 125 #define __REFCONST       .section       ".ref.rodata", "a"
 126
 127 #ifndef __ASSEMBLY__
 128 /*
 129  * Used for initialization calls..
 130  */
 131 typedef int (*initcall_t)(void);
 132 typedef void (*exitcall_t)(void);
 133
 134 extern initcall_t __con_initcall_start[], __con_initcall_end[];
 135 extern initcall_t __security_initcall_start[], __security_initcall_end[];
 136
 137 /* Used for contructor calls. */
 138 typedef void (*ctor_fn_t)(void);
 139
 140 /* Defined in init/main.c */
 141 extern int do_one_initcall(initcall_t fn);
 142 extern char __initdata boot_command_line[];
 143 extern char *saved_command_line;
 144 extern unsigned int reset_devices;
 145
 146 /* used by init/main.c */
 147 void setup_arch(char **);
 148 void prepare_namespace(void);
 149 void __init load_default_modules(void);
 150 int __init init_rootfs(void);
 151
 152 extern void (*late_time_init)(void);
 153
 154 extern bool initcall_debug;
 155
 156 #endif
 157
 158 #ifndef MODULE
 159
 160 #ifndef __ASSEMBLY__
 161
 162 #ifdef CONFIG_LTO
 163 /* Work around a LTO gcc problem: when there is no reference to a variable
 164  * in a module it will be moved to the end of the program. This causes
 165  * reordering of initcalls which the kernel does not like.
 166  * Add a dummy reference function to avoid this. The function is
 167  * deleted by the linker.
 168  */
 169 #define LTO_REFERENCE_INITCALL(x) \
 170         ; /* yes this is needed */                      \
 171         static __used __exit void *reference_##x(void)  \
 172         {                                               \
 173                 return &x;                              \
 174         }
 175 #else
 176 #define LTO_REFERENCE_INITCALL(x)
 177 #endif
 178
 179 /* initcalls are now grouped by functionality into separate
 180  * subsections. Ordering inside the subsections is determined
 181  * by link order.
 182  * For backwards compatibility, initcall() puts the call in
 183  * the device init subsection.
 184  *
 185  * The `id' arg to __define_initcall() is needed so that multiple initcalls
 186  * can point at the same handler without causing duplicate-symbol build errors.
 187  */
 188
 189 #define __define_initcall(fn, id) \
 190         static initcall_t __initcall_##fn##id __used \
 191         __attribute__((__section__(".initcall" #id ".init"))) = fn; \
 192         LTO_REFERENCE_INITCALL(__initcall_##fn##id)
 193
 194 /*
 195  * Early initcalls run before initializing SMP.
 196  *
 197  * Only for built-in code, not modules.
 198  */
 199 #define early_initcall(fn)              __define_initcall(fn, early)
 200
 201 /*
 202  * A "pure" initcall has no dependencies on anything else, and purely
 203  * initializes variables that couldn't be statically initialized.
 204  *
 205  * This only exists for built-in code, not for modules.
 206  * Keep main.c:initcall_level_names[] in sync.
 207  */
 208 #define pure_initcall(fn)               __define_initcall(fn, 0)
 209
 210 #define core_initcall(fn)               __define_initcall(fn, 1)
 211 #define core_initcall_sync(fn)          __define_initcall(fn, 1s)
 212 #define postcore_initcall(fn)           __define_initcall(fn, 2)
 213 #define postcore_initcall_sync(fn)      __define_initcall(fn, 2s)
 214 #define arch_initcall(fn)               __define_initcall(fn, 3)
 215 #define arch_initcall_sync(fn)          __define_initcall(fn, 3s)
 216 #define subsys_initcall(fn)             __define_initcall(fn, 4)
 217 #define subsys_initcall_sync(fn)        __define_initcall(fn, 4s)
 218 #define fs_initcall(fn)                 __define_initcall(fn, 5)
 219 #define fs_initcall_sync(fn)            __define_initcall(fn, 5s)
 220 #define rootfs_initcall(fn)             __define_initcall(fn, rootfs)
 221 #define device_initcall(fn)             __define_initcall(fn, 6)
 222 #define device_initcall_sync(fn)        __define_initcall(fn, 6s)
 223 #define late_initcall(fn)               __define_initcall(fn, 7)
 224 #define late_initcall_sync(fn)          __define_initcall(fn, 7s)
 225
 226 #define __initcall(fn) device_initcall(fn)
 227
 228 #define __exitcall(fn) \
 229         static exitcall_t __exitcall_##fn __exit_call = fn
 230
 231 #define console_initcall(fn) \
 232         static initcall_t __initcall_##fn \
 233         __used __section(.con_initcall.init) = fn
 234
 235 #define security_initcall(fn) \
 236         static initcall_t __initcall_##fn \
 237         __used __section(.security_initcall.init) = fn
 238
 239 struct obs_kernel_param {
 240         const char *str;
 241         int (*setup_func)(char *);
 242         int early;
 243 };
 244
 245 /*
 246  * Only for really core code.  See moduleparam.h for the normal way.
 247  *
 248  * Force the alignment so the compiler doesn't space elements of the
 249  * obs_kernel_param "array" too far apart in .init.setup.
 250  */
 251 #define __setup_param(str, unique_id, fn, early)                        \
 252         static const char __setup_str_##unique_id[] __initconst         \
 253                 __aligned(1) = str;                                     \
 254         static struct obs_kernel_param __setup_##unique_id              \
 255                 __used __section(.init.setup)                           \
 256                 __attribute__((aligned((sizeof(long)))))                \
 257                 = { __setup_str_##unique_id, fn, early }
 258
 259 #define __setup(str, fn)                                                \
 260         __setup_param(str, fn, fn, 0)
 261
 262 /*
 263  * NOTE: fn is as per module_param, not __setup!
 264  * Emits warning if fn returns non-zero.
 265  */
 266 #define early_param(str, fn)                                            \
 267         __setup_param(str, fn, fn, 1)
 268
 269 #define early_param_on_off(str_on, str_off, var, config)                \
 270                                                                         \
 271         int var = IS_ENABLED(config);                                   \
 272                                                                         \
 273         static int __init parse_##var##_on(char *arg)                   \
 274         {                                                               \
 275                 var = 1;                                                \
 276                 return 0;                                               \
 277         }                                                               \
 278         __setup_param(str_on, parse_##var##_on, parse_##var##_on, 1);   \
 279                                                                         \
 280         static int __init parse_##var##_off(char *arg)                  \
 281         {                                                               \
 282                 var = 0;                                                \
 283                 return 0;                                               \
 284         }                                                               \
 285         __setup_param(str_off, parse_##var##_off, parse_##var##_off, 1)
 286
 287 /* Relies on boot_command_line being set */
 288 void __init parse_early_param(void);
 289 void __init parse_early_options(char *cmdline);
 290 #endif /* __ASSEMBLY__ */
 291
 292 #else /* MODULE */
 293
 294 #define __setup_param(str, unique_id, fn)       /* nothing */
 295 #define __setup(str, func)                      /* nothing */
 296 #endif
 297
 298 /* Data marked not to be saved by software suspend */
 299 #define __nosavedata __section(.data..nosave)
 300
 301 #ifdef MODULE
 302 #define __exit_p(x) x
 303 #else
 304 #define __exit_p(x) NULL
 305 #endif
 306
 307 #endif /* _LINUX_INIT_H */