include/linux/init.h

   1 #ifndef _LINUX_INIT_H
   2 #define _LINUX_INIT_H
   3
   4 #include <linux/compiler.h>
   5
   6 /* Built-in __init functions needn't be compiled with retpoline */
   7 #if defined(RETPOLINE) && !defined(MODULE)
   8 #define __noretpoline __attribute__((indirect_branch("keep")))
   9 #else
  10 #define __noretpoline
  11 #endif
  12
  13 /* These macros are used to mark some functions or
  14  * initialized data (doesn't apply to uninitialized data)
  15  * as `initialization' functions. The kernel can take this
  16  * as hint that the function is used only during the initialization
  17  * phase and free up used memory resources after
  18  *
  19  * Usage:
  20  * For functions:
  21  *
  22  * You should add __init immediately before the function name, like:
  23  *
  24  * static void __init initme(int x, int y)
  25  * {
  26  *    extern int z; z = x * y;
  27  * }
  28  *
  29  * If the function has a prototype somewhere, you can also add
  30  * __init between closing brace of the prototype and semicolon:
  31  *
  32  * extern int initialize_foobar_device(int, int, int) __init;
  33  *
  34  * For initialized data:
  35  * You should insert __initdata between the variable name and equal
  36  * sign followed by value, e.g.:
  37  *
  38  * static int init_variable __initdata = 0;
  39  * static const char linux_logo[] __initconst = { 0x32, 0x36, ... };
  40  *
  41  * Don't forget to initialize data not at file scope, i.e. within a function,
  42  * as gcc otherwise puts the data into the bss section and not into the init
  43  * section.
  44  *
  45  * Also note, that this data cannot be "const".
  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 notrace __noretpoline
  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 /* compatibility defines */
  78 #define __init_refok     __ref
  79 #define __initdata_refok __refdata
  80 #define __exit_refok     __ref
  81
  82
  83 #ifdef MODULE
  84 #define __exitused
  85 #else
  86 #define __exitused  __used
  87 #endif
  88
  89 #define __exit          __section(.exit.text) __exitused __cold notrace
  90
  91 /* Used for HOTPLUG */
  92 #define __devinit        __section(.devinit.text) __cold notrace
  93 #define __devinitdata    __section(.devinit.data)
  94 #define __devinitconst   __section(.devinit.rodata)
  95 #define __devexit        __section(.devexit.text) __exitused __cold notrace
  96 #define __devexitdata    __section(.devexit.data)
  97 #define __devexitconst   __section(.devexit.rodata)
  98
  99 /* Used for HOTPLUG_CPU */
 100 #define __cpuinit        __section(.cpuinit.text) __cold notrace
 101 #define __cpuinitdata    __section(.cpuinit.data)
 102 #define __cpuinitconst   __section(.cpuinit.rodata)
 103 #define __cpuexit        __section(.cpuexit.text) __exitused __cold notrace
 104 #define __cpuexitdata    __section(.cpuexit.data)
 105 #define __cpuexitconst   __section(.cpuexit.rodata)
 106
 107 /* Used for MEMORY_HOTPLUG */
 108 #define __meminit        __section(.meminit.text) __cold notrace
 109 #define __meminitdata    __section(.meminit.data)
 110 #define __meminitconst   __section(.meminit.rodata)
 111 #define __memexit        __section(.memexit.text) __exitused __cold notrace
 112 #define __memexitdata    __section(.memexit.data)
 113 #define __memexitconst   __section(.memexit.rodata)
 114
 115 /* For assembly routines */
 116 #define __HEAD          .section        ".head.text","ax"
 117 #define __INIT          .section        ".init.text","ax"
 118 #define __FINIT         .previous
 119
 120 #define __INITDATA      .section        ".init.data","aw",%progbits
 121 #define __INITRODATA    .section        ".init.rodata","a",%progbits
 122 #define __FINITDATA     .previous
 123
 124 #define __DEVINIT        .section       ".devinit.text", "ax"
 125 #define __DEVINITDATA    .section       ".devinit.data", "aw"
 126 #define __DEVINITRODATA  .section       ".devinit.rodata", "a"
 127
 128 #define __CPUINIT        .section       ".cpuinit.text", "ax"
 129 #define __CPUINITDATA    .section       ".cpuinit.data", "aw"
 130 #define __CPUINITRODATA  .section       ".cpuinit.rodata", "a"
 131
 132 #define __MEMINIT        .section       ".meminit.text", "ax"
 133 #define __MEMINITDATA    .section       ".meminit.data", "aw"
 134 #define __MEMINITRODATA  .section       ".meminit.rodata", "a"
 135
 136 /* silence warnings when references are OK */
 137 #define __REF            .section       ".ref.text", "ax"
 138 #define __REFDATA        .section       ".ref.data", "aw"
 139 #define __REFCONST       .section       ".ref.rodata", "a"
 140
 141 #ifndef __ASSEMBLY__
 142 /*
 143  * Used for initialization calls..
 144  */
 145 typedef int (*initcall_t)(void);
 146 typedef void (*exitcall_t)(void);
 147
 148 extern initcall_t __con_initcall_start[], __con_initcall_end[];
 149 extern initcall_t __security_initcall_start[], __security_initcall_end[];
 150
 151 /* Used for contructor calls. */
 152 typedef void (*ctor_fn_t)(void);
 153
 154 /* Defined in init/main.c */
 155 extern int do_one_initcall(initcall_t fn);
 156 extern char __initdata boot_command_line[];
 157 extern char *saved_command_line;
 158 extern unsigned int reset_devices;
 159
 160 /* used by init/main.c */
 161 void setup_arch(char **);
 162 void prepare_namespace(void);
 163
 164 extern void (*late_time_init)(void);
 165
 166 extern int initcall_debug;
 167
 168 #endif
 169
 170 #ifndef MODULE
 171
 172 #ifndef __ASSEMBLY__
 173
 174 /* initcalls are now grouped by functionality into separate
 175  * subsections. Ordering inside the subsections is determined
 176  * by link order.
 177  * For backwards compatibility, initcall() puts the call in
 178  * the device init subsection.
 179  *
 180  * The `id' arg to __define_initcall() is needed so that multiple initcalls
 181  * can point at the same handler without causing duplicate-symbol build errors.
 182  */
 183
 184 #define __define_initcall(level,fn,id) \
 185         static initcall_t __initcall_##fn##id __used \
 186         __attribute__((__section__(".initcall" level ".init"))) = fn
 187
 188 /*
 189  * Early initcalls run before initializing SMP.
 190  *
 191  * Only for built-in code, not modules.
 192  */
 193 #define early_initcall(fn)              __define_initcall("early",fn,early)
 194
 195 /*
 196  * A "pure" initcall has no dependencies on anything else, and purely
 197  * initializes variables that couldn't be statically initialized.
 198  *
 199  * This only exists for built-in code, not for modules.
 200  */
 201 #define pure_initcall(fn)               __define_initcall("0",fn,0)
 202
 203 #define core_initcall(fn)               __define_initcall("1",fn,1)
 204 #define core_initcall_sync(fn)          __define_initcall("1s",fn,1s)
 205 #define postcore_initcall(fn)           __define_initcall("2",fn,2)
 206 #define postcore_initcall_sync(fn)      __define_initcall("2s",fn,2s)
 207 #define arch_initcall(fn)               __define_initcall("3",fn,3)
 208 #define arch_initcall_sync(fn)          __define_initcall("3s",fn,3s)
 209 #define subsys_initcall(fn)             __define_initcall("4",fn,4)
 210 #define subsys_initcall_sync(fn)        __define_initcall("4s",fn,4s)
 211 #define fs_initcall(fn)                 __define_initcall("5",fn,5)
 212 #define fs_initcall_sync(fn)            __define_initcall("5s",fn,5s)
 213 #define rootfs_initcall(fn)             __define_initcall("rootfs",fn,rootfs)
 214 #define device_initcall(fn)             __define_initcall("6",fn,6)
 215 #define device_initcall_sync(fn)        __define_initcall("6s",fn,6s)
 216 #define late_initcall(fn)               __define_initcall("7",fn,7)
 217 #define late_initcall_sync(fn)          __define_initcall("7s",fn,7s)
 218
 219 #define __initcall(fn) device_initcall(fn)
 220
 221 #define __exitcall(fn) \
 222         static exitcall_t __exitcall_##fn __exit_call = fn
 223
 224 #define console_initcall(fn) \
 225         static initcall_t __initcall_##fn \
 226         __used __section(.con_initcall.init) = fn
 227
 228 #define security_initcall(fn) \
 229         static initcall_t __initcall_##fn \
 230         __used __section(.security_initcall.init) = fn
 231
 232 struct obs_kernel_param {
 233         const char *str;
 234         int (*setup_func)(char *);
 235         int early;
 236 };
 237
 238 /*
 239  * Only for really core code.  See moduleparam.h for the normal way.
 240  *
 241  * Force the alignment so the compiler doesn't space elements of the
 242  * obs_kernel_param "array" too far apart in .init.setup.
 243  */
 244 #define __setup_param(str, unique_id, fn, early)                        \
 245         static const char __setup_str_##unique_id[] __initconst \
 246                 __aligned(1) = str; \
 247         static struct obs_kernel_param __setup_##unique_id      \
 248                 __used __section(.init.setup)                   \
 249                 __attribute__((aligned((sizeof(long)))))        \
 250                 = { __setup_str_##unique_id, fn, early }
 251
 252 #define __setup(str, fn)                                        \
 253         __setup_param(str, fn, fn, 0)
 254
 255 /* NOTE: fn is as per module_param, not __setup!  Emits warning if fn
 256  * returns non-zero. */
 257 #define early_param(str, fn)                                    \
 258         __setup_param(str, fn, fn, 1)
 259
 260 /* Relies on boot_command_line being set */
 261 void __init parse_early_param(void);
 262 void __init parse_early_options(char *cmdline);
 263 #endif /* __ASSEMBLY__ */
 264
 265 /**
 266  * module_init() - driver initialization entry point
 267  * @x: function to be run at kernel boot time or module insertion
 268  *
 269  * module_init() will either be called during do_initcalls() (if
 270  * builtin) or at module insertion time (if a module).  There can only
 271  * be one per module.
 272  */
 273 #define module_init(x)  __initcall(x);
 274
 275 /**
 276  * module_exit() - driver exit entry point
 277  * @x: function to be run when driver is removed
 278  *
 279  * module_exit() will wrap the driver clean-up code
 280  * with cleanup_module() when used with rmmod when
 281  * the driver is a module.  If the driver is statically
 282  * compiled into the kernel, module_exit() has no effect.
 283  * There can only be one per module.
 284  */
 285 #define module_exit(x)  __exitcall(x);
 286
 287 #else /* MODULE */
 288
 289 /* Don't use these in modules, but some people do... */
 290 #define early_initcall(fn)              module_init(fn)
 291 #define core_initcall(fn)               module_init(fn)
 292 #define postcore_initcall(fn)           module_init(fn)
 293 #define arch_initcall(fn)               module_init(fn)
 294 #define subsys_initcall(fn)             module_init(fn)
 295 #define fs_initcall(fn)                 module_init(fn)
 296 #define device_initcall(fn)             module_init(fn)
 297 #define late_initcall(fn)               module_init(fn)
 298
 299 #define security_initcall(fn)           module_init(fn)
 300
 301 /* Each module must use one module_init(). */
 302 #define module_init(initfn)                                     \
 303         static inline initcall_t __inittest(void)               \
 304         { return initfn; }                                      \
 305         int init_module(void) __attribute__((alias(#initfn)));
 306
 307 /* This is only required if you want to be unloadable. */
 308 #define module_exit(exitfn)                                     \
 309         static inline exitcall_t __exittest(void)               \
 310         { return exitfn; }                                      \
 311         void cleanup_module(void) __attribute__((alias(#exitfn)));
 312
 313 #define __setup_param(str, unique_id, fn)       /* nothing */
 314 #define __setup(str, func)                      /* nothing */
 315 #endif
 316
 317 /* Data marked not to be saved by software suspend */
 318 #define __nosavedata __section(.data..nosave)
 319
 320 /* This means "can be init if no module support, otherwise module load
 321    may call it." */
 322 #ifdef CONFIG_MODULES
 323 #define __init_or_module
 324 #define __initdata_or_module
 325 #define __initconst_or_module
 326 #define __INIT_OR_MODULE        .text
 327 #define __INITDATA_OR_MODULE    .data
 328 #define __INITRODATA_OR_MODULE  .section ".rodata","a",%progbits
 329 #else
 330 #define __init_or_module __init
 331 #define __initdata_or_module __initdata
 332 #define __initconst_or_module __initconst
 333 #define __INIT_OR_MODULE __INIT
 334 #define __INITDATA_OR_MODULE __INITDATA
 335 #define __INITRODATA_OR_MODULE __INITRODATA
 336 #endif /*CONFIG_MODULES*/
 337
 338 /* Functions marked as __devexit may be discarded at kernel link time, depending
 339    on config options.  Newer versions of binutils detect references from
 340    retained sections to discarded sections and flag an error.  Pointers to
 341    __devexit functions must use __devexit_p(function_name), the wrapper will
 342    insert either the function_name or NULL, depending on the config options.
 343  */
 344 #if defined(MODULE) || defined(CONFIG_HOTPLUG)
 345 #define __devexit_p(x) x
 346 #else
 347 #define __devexit_p(x) NULL
 348 #endif
 349
 350 #ifdef MODULE
 351 #define __exit_p(x) x
 352 #else
 353 #define __exit_p(x) NULL
 354 #endif
 355
 356 #endif /* _LINUX_INIT_H */