include/linux/init.h

   1 #ifndef _LINUX_INIT_H
   2 #define _LINUX_INIT_H
   3
   4 #include <linux/compiler.h>
   5
   6 /* These macros are used to mark some functions or
   7  * initialized data (doesn't apply to uninitialized data)
   8  * as `initialization' functions. The kernel can take this
   9  * as hint that the function is used only during the initialization
  10  * phase and free up used memory resources after
  11  *
  12  * Usage:
  13  * For functions:
  14  *
  15  * You should add __init immediately before the function name, like:
  16  *
  17  * static void __init initme(int x, int y)
  18  * {
  19  *    extern int z; z = x * y;
  20  * }
  21  *
  22  * If the function has a prototype somewhere, you can also add
  23  * __init between closing brace of the prototype and semicolon:
  24  *
  25  * extern int initialize_foobar_device(int, int, int) __init;
  26  *
  27  * For initialized data:
  28  * You should insert __initdata between the variable name and equal
  29  * sign followed by value, e.g.:
  30  *
  31  * static int init_variable __initdata = 0;
  32  * static char linux_logo[] __initdata = { 0x32, 0x36, ... };
  33  *
  34  * Don't forget to initialize data not at file scope, i.e. within a function,
  35  * as gcc otherwise puts the data into the bss section and not into the init
  36  * section.
  37  *
  38  * Also note, that this data cannot be "const".
  39  */
  40
  41 /* These are for everybody (although not all archs will actually
  42    discard it in modules) */
  43 #define __init          __attribute__ ((__section__ (".init.text")))
  44 #define __initdata      __attribute__ ((__section__ (".init.data")))
  45 #define __exitdata      __attribute__ ((__section__(".exit.data")))
  46 #define __exit_call     __attribute_used__ __attribute__ ((__section__ (".exitcall.exit")))
  47
  48 #ifdef MODULE
  49 #define __exit          __attribute__ ((__section__(".exit.text")))
  50 #else
  51 #define __exit          __attribute_used__ __attribute__ ((__section__(".exit.text")))
  52 #endif
  53
  54 /* For assembly routines */
  55 #define __INIT          .section        ".init.text","ax"
  56 #define __FINIT         .previous
  57 #define __INITDATA      .section        ".init.data","aw"
  58
  59 #ifndef __ASSEMBLY__
  60 /*
  61  * Used for initialization calls..
  62  */
  63 typedef int (*initcall_t)(void);
  64 typedef void (*exitcall_t)(void);
  65
  66 extern initcall_t __con_initcall_start[], __con_initcall_end[];
  67 extern initcall_t __security_initcall_start[], __security_initcall_end[];
  68
  69 /* Defined in init/main.c */
  70 extern char saved_command_line[];
  71 extern unsigned int reset_devices;
  72
  73 /* used by init/main.c */
  74 extern void setup_arch(char **);
  75
  76 #endif
  77
  78 #ifndef MODULE
  79
  80 #ifndef __ASSEMBLY__
  81
  82 /* initcalls are now grouped by functionality into separate
  83  * subsections. Ordering inside the subsections is determined
  84  * by link order.
  85  * For backwards compatibility, initcall() puts the call in
  86  * the device init subsection.
  87  *
  88  * The `id' arg to __define_initcall() is needed so that multiple initcalls
  89  * can point at the same handler without causing duplicate-symbol build errors.
  90  */
  91
  92 #define __define_initcall(level,fn,id) \
  93         static initcall_t __initcall_##fn##id __attribute_used__ \
  94         __attribute__((__section__(".initcall" level ".init"))) = fn
  95
  96 /*
  97  * A "pure" initcall has no dependencies on anything else, and purely
  98  * initializes variables that couldn't be statically initialized.
  99  *
 100  * This only exists for built-in code, not for modules.
 101  */
 102 #define pure_initcall(fn)               __define_initcall("0",fn,1)
 103
 104 #define core_initcall(fn)               __define_initcall("1",fn,1)
 105 #define core_initcall_sync(fn)          __define_initcall("1s",fn,1s)
 106 #define postcore_initcall(fn)           __define_initcall("2",fn,2)
 107 #define postcore_initcall_sync(fn)      __define_initcall("2s",fn,2s)
 108 #define arch_initcall(fn)               __define_initcall("3",fn,3)
 109 #define arch_initcall_sync(fn)          __define_initcall("3s",fn,3s)
 110 #define subsys_initcall(fn)             __define_initcall("4",fn,4)
 111 #define subsys_initcall_sync(fn)        __define_initcall("4s",fn,4s)
 112 #define fs_initcall(fn)                 __define_initcall("5",fn,5)
 113 #define fs_initcall_sync(fn)            __define_initcall("5s",fn,5s)
 114 #define rootfs_initcall(fn)             __define_initcall("rootfs",fn,rootfs)
 115 #define device_initcall(fn)             __define_initcall("6",fn,6)
 116 #define device_initcall_sync(fn)        __define_initcall("6s",fn,6s)
 117 #define late_initcall(fn)               __define_initcall("7",fn,7)
 118 #define late_initcall_sync(fn)          __define_initcall("7s",fn,7s)
 119
 120 #define __initcall(fn) device_initcall(fn)
 121
 122 #define __exitcall(fn) \
 123         static exitcall_t __exitcall_##fn __exit_call = fn
 124
 125 #define console_initcall(fn) \
 126         static initcall_t __initcall_##fn \
 127         __attribute_used__ __attribute__((__section__(".con_initcall.init")))=fn
 128
 129 #define security_initcall(fn) \
 130         static initcall_t __initcall_##fn \
 131         __attribute_used__ __attribute__((__section__(".security_initcall.init"))) = fn
 132
 133 struct obs_kernel_param {
 134         const char *str;
 135         int (*setup_func)(char *);
 136         int early;
 137 };
 138
 139 /*
 140  * Only for really core code.  See moduleparam.h for the normal way.
 141  *
 142  * Force the alignment so the compiler doesn't space elements of the
 143  * obs_kernel_param "array" too far apart in .init.setup.
 144  */
 145 #define __setup_param(str, unique_id, fn, early)                        \
 146         static char __setup_str_##unique_id[] __initdata = str; \
 147         static struct obs_kernel_param __setup_##unique_id      \
 148                 __attribute_used__                              \
 149                 __attribute__((__section__(".init.setup")))     \
 150                 __attribute__((aligned((sizeof(long)))))        \
 151                 = { __setup_str_##unique_id, fn, early }
 152
 153 #define __setup_null_param(str, unique_id)                      \
 154         __setup_param(str, unique_id, NULL, 0)
 155
 156 #define __setup(str, fn)                                        \
 157         __setup_param(str, fn, fn, 0)
 158
 159 #define __obsolete_setup(str)                                   \
 160         __setup_null_param(str, __LINE__)
 161
 162 /* NOTE: fn is as per module_param, not __setup!  Emits warning if fn
 163  * returns non-zero. */
 164 #define early_param(str, fn)                                    \
 165         __setup_param(str, fn, fn, 1)
 166
 167 /* Relies on saved_command_line being set */
 168 void __init parse_early_param(void);
 169 #endif /* __ASSEMBLY__ */
 170
 171 /**
 172  * module_init() - driver initialization entry point
 173  * @x: function to be run at kernel boot time or module insertion
 174  *
 175  * module_init() will either be called during do_initcalls (if
 176  * builtin) or at module insertion time (if a module).  There can only
 177  * be one per module.
 178  */
 179 #define module_init(x)  __initcall(x);
 180
 181 /**
 182  * module_exit() - driver exit entry point
 183  * @x: function to be run when driver is removed
 184  *
 185  * module_exit() will wrap the driver clean-up code
 186  * with cleanup_module() when used with rmmod when
 187  * the driver is a module.  If the driver is statically
 188  * compiled into the kernel, module_exit() has no effect.
 189  * There can only be one per module.
 190  */
 191 #define module_exit(x)  __exitcall(x);
 192
 193 #else /* MODULE */
 194
 195 /* Don't use these in modules, but some people do... */
 196 #define core_initcall(fn)               module_init(fn)
 197 #define postcore_initcall(fn)           module_init(fn)
 198 #define arch_initcall(fn)               module_init(fn)
 199 #define subsys_initcall(fn)             module_init(fn)
 200 #define fs_initcall(fn)                 module_init(fn)
 201 #define device_initcall(fn)             module_init(fn)
 202 #define late_initcall(fn)               module_init(fn)
 203
 204 #define security_initcall(fn)           module_init(fn)
 205
 206 /* These macros create a dummy inline: gcc 2.9x does not count alias
 207  as usage, hence the `unused function' warning when __init functions
 208  are declared static. We use the dummy __*_module_inline functions
 209  both to kill the warning and check the type of the init/cleanup
 210  function. */
 211
 212 /* Each module must use one module_init(), or one no_module_init */
 213 #define module_init(initfn)                                     \
 214         static inline initcall_t __inittest(void)               \
 215         { return initfn; }                                      \
 216         int init_module(void) __attribute__((alias(#initfn)));
 217
 218 /* This is only required if you want to be unloadable. */
 219 #define module_exit(exitfn)                                     \
 220         static inline exitcall_t __exittest(void)               \
 221         { return exitfn; }                                      \
 222         void cleanup_module(void) __attribute__((alias(#exitfn)));
 223
 224 #define __setup_param(str, unique_id, fn)       /* nothing */
 225 #define __setup_null_param(str, unique_id)      /* nothing */
 226 #define __setup(str, func)                      /* nothing */
 227 #define __obsolete_setup(str)                   /* nothing */
 228 #endif
 229
 230 /* Data marked not to be saved by software_suspend() */
 231 #define __nosavedata __attribute__ ((__section__ (".data.nosave")))
 232
 233 /* This means "can be init if no module support, otherwise module load
 234    may call it." */
 235 #ifdef CONFIG_MODULES
 236 #define __init_or_module
 237 #define __initdata_or_module
 238 #else
 239 #define __init_or_module __init
 240 #define __initdata_or_module __initdata
 241 #endif /*CONFIG_MODULES*/
 242
 243 #ifdef CONFIG_HOTPLUG
 244 #define __devinit
 245 #define __devinitdata
 246 #define __devexit
 247 #define __devexitdata
 248 #else
 249 #define __devinit __init
 250 #define __devinitdata __initdata
 251 #define __devexit __exit
 252 #define __devexitdata __exitdata
 253 #endif
 254
 255 #ifdef CONFIG_HOTPLUG_CPU
 256 #define __cpuinit
 257 #define __cpuinitdata
 258 #define __cpuexit
 259 #define __cpuexitdata
 260 #else
 261 #define __cpuinit       __init
 262 #define __cpuinitdata __initdata
 263 #define __cpuexit __exit
 264 #define __cpuexitdata   __exitdata
 265 #endif
 266
 267 #if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_ACPI_HOTPLUG_MEMORY) \
 268         || defined(CONFIG_ACPI_HOTPLUG_MEMORY_MODULE)
 269 #define __meminit
 270 #define __meminitdata
 271 #define __memexit
 272 #define __memexitdata
 273 #else
 274 #define __meminit       __init
 275 #define __meminitdata __initdata
 276 #define __memexit __exit
 277 #define __memexitdata   __exitdata
 278 #endif
 279
 280 /* Functions marked as __devexit may be discarded at kernel link time, depending
 281    on config options.  Newer versions of binutils detect references from
 282    retained sections to discarded sections and flag an error.  Pointers to
 283    __devexit functions must use __devexit_p(function_name), the wrapper will
 284    insert either the function_name or NULL, depending on the config options.
 285  */
 286 #if defined(MODULE) || defined(CONFIG_HOTPLUG)
 287 #define __devexit_p(x) x
 288 #else
 289 #define __devexit_p(x) NULL
 290 #endif
 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 */