SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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          __section(.init.text) __cold
  44 #define __initdata      __section(.init.data)
  45 #define __exitdata      __section(.exit.data)
  46 #define __exit_call     __attribute_used__ __section(.exitcall.exit)
  47
  48 /* modpost check for section mismatches during the kernel build.
  49  * A section mismatch happens when there are references from a
  50  * code or data section to an init section (both code or data).
  51  * The init sections are (for most archs) discarded by the kernel
  52  * when early init has completed so all such references are potential bugs.
  53  * For exit sections the same issue exists.
  54  * The following markers are used for the cases where the reference to
  55  * the init/exit section (code or data) is valid and will teach modpost
  56  * not to issue a warning.
  57  * The markers follow same syntax rules as __init / __initdata. */
  58 #define __init_refok     noinline __section(.text.init.refok)
  59 #define __initdata_refok          __section(.data.init.refok)
  60 #define __exit_refok     noinline __section(.exit.text.refok)
  61
  62 #ifdef MODULE
  63 #define __exitused
  64 #else
  65 #define __exitused  __used
  66 #endif
  67
  68 #define __exit          __section(.exit.text) __exitused __cold
  69
  70 /* Used for HOTPLUG */
  71 #define __devinit        __section(.devinit.text) __cold
  72 #define __devinitdata    __section(.devinit.data)
  73 #define __devinitconst   __section(.devinit.rodata)
  74 #define __devexit        __section(.devexit.text) __exitused __cold
  75 #define __devexitdata    __section(.devexit.data)
  76 #define __devexitconst   __section(.devexit.rodata)
  77
  78 /* Used for HOTPLUG_CPU */
  79 #define __cpuinit        __section(.cpuinit.text) __cold
  80 #define __cpuinitdata    __section(.cpuinit.data)
  81 #define __cpuinitconst   __section(.cpuinit.rodata)
  82 #define __cpuexit        __section(.cpuexit.text) __exitused __cold
  83 #define __cpuexitdata    __section(.cpuexit.data)
  84 #define __cpuexitconst   __section(.cpuexit.rodata)
  85
  86 /* Used for MEMORY_HOTPLUG */
  87 #define __meminit        __section(.meminit.text) __cold
  88 #define __meminitdata    __section(.meminit.data)
  89 #define __meminitconst   __section(.meminit.rodata)
  90 #define __memexit        __section(.memexit.text) __exitused __cold
  91 #define __memexitdata    __section(.memexit.data)
  92 #define __memexitconst   __section(.memexit.rodata)
  93
  94 /* For assembly routines */
  95 #define __INIT          .section        ".init.text","ax"
  96 #define __INIT_REFOK    .section        ".text.init.refok","ax"
  97 #define __FINIT         .previous
  98
  99 #define __INITDATA      .section        ".init.data","aw"
 100 #define __INITDATA_REFOK .section       ".data.init.refok","aw"
 101
 102 #define __DEVINIT        .section       ".devinit.text", "ax"
 103 #define __DEVINITDATA    .section       ".devinit.data", "aw"
 104
 105 #define __CPUINIT        .section       ".cpuinit.text", "ax"
 106 #define __CPUINITDATA    .section       ".cpuinit.data", "aw"
 107
 108 #define __MEMINIT        .section       ".meminit.text", "ax"
 109 #define __MEMINITDATA    .section       ".meminit.data", "aw"
 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 /* Defined in init/main.c */
 122 extern char __initdata boot_command_line[];
 123 extern char *saved_command_line;
 124 extern unsigned int reset_devices;
 125
 126 /* used by init/main.c */
 127 void setup_arch(char **);
 128 void prepare_namespace(void);
 129
 130 #endif
 131
 132 #ifndef MODULE
 133
 134 #ifndef __ASSEMBLY__
 135
 136 /* initcalls are now grouped by functionality into separate
 137  * subsections. Ordering inside the subsections is determined
 138  * by link order.
 139  * For backwards compatibility, initcall() puts the call in
 140  * the device init subsection.
 141  *
 142  * The `id' arg to __define_initcall() is needed so that multiple initcalls
 143  * can point at the same handler without causing duplicate-symbol build errors.
 144  */
 145
 146 #define __define_initcall(level,fn,id) \
 147         static initcall_t __initcall_##fn##id __attribute_used__ \
 148         __attribute__((__section__(".initcall" level ".init"))) = fn
 149
 150 /*
 151  * A "pure" initcall has no dependencies on anything else, and purely
 152  * initializes variables that couldn't be statically initialized.
 153  *
 154  * This only exists for built-in code, not for modules.
 155  */
 156 #define pure_initcall(fn)               __define_initcall("0",fn,0)
 157
 158 #define core_initcall(fn)               __define_initcall("1",fn,1)
 159 #define core_initcall_sync(fn)          __define_initcall("1s",fn,1s)
 160 #define postcore_initcall(fn)           __define_initcall("2",fn,2)
 161 #define postcore_initcall_sync(fn)      __define_initcall("2s",fn,2s)
 162 #define arch_initcall(fn)               __define_initcall("3",fn,3)
 163 #define arch_initcall_sync(fn)          __define_initcall("3s",fn,3s)
 164 #define subsys_initcall(fn)             __define_initcall("4",fn,4)
 165 #define subsys_initcall_sync(fn)        __define_initcall("4s",fn,4s)
 166 #define fs_initcall(fn)                 __define_initcall("5",fn,5)
 167 #define fs_initcall_sync(fn)            __define_initcall("5s",fn,5s)
 168 #define rootfs_initcall(fn)             __define_initcall("rootfs",fn,rootfs)
 169 #define device_initcall(fn)             __define_initcall("6",fn,6)
 170 #define device_initcall_sync(fn)        __define_initcall("6s",fn,6s)
 171 #define late_initcall(fn)               __define_initcall("7",fn,7)
 172 #define late_initcall_sync(fn)          __define_initcall("7s",fn,7s)
 173
 174 #define __initcall(fn) device_initcall(fn)
 175
 176 #define __exitcall(fn) \
 177         static exitcall_t __exitcall_##fn __exit_call = fn
 178
 179 #define console_initcall(fn) \
 180         static initcall_t __initcall_##fn \
 181         __attribute_used__ __section(.con_initcall.init)=fn
 182
 183 #define security_initcall(fn) \
 184         static initcall_t __initcall_##fn \
 185         __attribute_used__ __section(.security_initcall.init) = fn
 186
 187 struct obs_kernel_param {
 188         const char *str;
 189         int (*setup_func)(char *);
 190         int early;
 191 };
 192
 193 /*
 194  * Only for really core code.  See moduleparam.h for the normal way.
 195  *
 196  * Force the alignment so the compiler doesn't space elements of the
 197  * obs_kernel_param "array" too far apart in .init.setup.
 198  */
 199 #define __setup_param(str, unique_id, fn, early)                        \
 200         static char __setup_str_##unique_id[] __initdata __aligned(1) = str; \
 201         static struct obs_kernel_param __setup_##unique_id      \
 202                 __attribute_used__                              \
 203                 __section(.init.setup)                          \
 204                 __attribute__((aligned((sizeof(long)))))        \
 205                 = { __setup_str_##unique_id, fn, early }
 206
 207 #define __setup_null_param(str, unique_id)                      \
 208         __setup_param(str, unique_id, NULL, 0)
 209
 210 #define __setup(str, fn)                                        \
 211         __setup_param(str, fn, fn, 0)
 212
 213 /* NOTE: fn is as per module_param, not __setup!  Emits warning if fn
 214  * returns non-zero. */
 215 #define early_param(str, fn)                                    \
 216         __setup_param(str, fn, fn, 1)
 217
 218 /* Relies on boot_command_line being set */
 219 void __init parse_early_param(void);
 220 #endif /* __ASSEMBLY__ */
 221
 222 /**
 223  * module_init() - driver initialization entry point
 224  * @x: function to be run at kernel boot time or module insertion
 225  *
 226  * module_init() will either be called during do_initcalls() (if
 227  * builtin) or at module insertion time (if a module).  There can only
 228  * be one per module.
 229  */
 230 #define module_init(x)  __initcall(x);
 231
 232 /**
 233  * module_exit() - driver exit entry point
 234  * @x: function to be run when driver is removed
 235  *
 236  * module_exit() will wrap the driver clean-up code
 237  * with cleanup_module() when used with rmmod when
 238  * the driver is a module.  If the driver is statically
 239  * compiled into the kernel, module_exit() has no effect.
 240  * There can only be one per module.
 241  */
 242 #define module_exit(x)  __exitcall(x);
 243
 244 #else /* MODULE */
 245
 246 /* Don't use these in modules, but some people do... */
 247 #define core_initcall(fn)               module_init(fn)
 248 #define postcore_initcall(fn)           module_init(fn)
 249 #define arch_initcall(fn)               module_init(fn)
 250 #define subsys_initcall(fn)             module_init(fn)
 251 #define fs_initcall(fn)                 module_init(fn)
 252 #define device_initcall(fn)             module_init(fn)
 253 #define late_initcall(fn)               module_init(fn)
 254
 255 #define security_initcall(fn)           module_init(fn)
 256
 257 /* These macros create a dummy inline: gcc 2.9x does not count alias
 258  as usage, hence the `unused function' warning when __init functions
 259  are declared static. We use the dummy __*_module_inline functions
 260  both to kill the warning and check the type of the init/cleanup
 261  function. */
 262
 263 /* Each module must use one module_init(), or one no_module_init */
 264 #define module_init(initfn)                                     \
 265         static inline initcall_t __inittest(void)               \
 266         { return initfn; }                                      \
 267         int init_module(void) __attribute__((alias(#initfn)));
 268
 269 /* This is only required if you want to be unloadable. */
 270 #define module_exit(exitfn)                                     \
 271         static inline exitcall_t __exittest(void)               \
 272         { return exitfn; }                                      \
 273         void cleanup_module(void) __attribute__((alias(#exitfn)));
 274
 275 #define __setup_param(str, unique_id, fn)       /* nothing */
 276 #define __setup_null_param(str, unique_id)      /* nothing */
 277 #define __setup(str, func)                      /* nothing */
 278 #endif
 279
 280 /* Data marked not to be saved by software suspend */
 281 #define __nosavedata __section(.data.nosave)
 282
 283 /* This means "can be init if no module support, otherwise module load
 284    may call it." */
 285 #ifdef CONFIG_MODULES
 286 #define __init_or_module
 287 #define __initdata_or_module
 288 #else
 289 #define __init_or_module __init
 290 #define __initdata_or_module __initdata
 291 #endif /*CONFIG_MODULES*/
 292
 293 /* Functions marked as __devexit may be discarded at kernel link time, depending
 294    on config options.  Newer versions of binutils detect references from
 295    retained sections to discarded sections and flag an error.  Pointers to
 296    __devexit functions must use __devexit_p(function_name), the wrapper will
 297    insert either the function_name or NULL, depending on the config options.
 298  */
 299 #if defined(MODULE) || defined(CONFIG_HOTPLUG)
 300 #define __devexit_p(x) x
 301 #else
 302 #define __devexit_p(x) NULL
 303 #endif
 304
 305 #ifdef MODULE
 306 #define __exit_p(x) x
 307 #else
 308 #define __exit_p(x) NULL
 309 #endif
 310
 311 #endif /* _LINUX_INIT_H */