include/linux/init.h

   1 #ifndef _LINUX_INIT_H
   2 #define _LINUX_INIT_H
   3
   4 #include <linux/config.h>
   5 #include <linux/compiler.h>
   6
   7 /* These macros are used to mark some functions or
   8  * initialized data (doesn't apply to uninitialized data)
   9  * as `initialization' functions. The kernel can take this
  10  * as hint that the function is used only during the initialization
  11  * phase and free up used memory resources after
  12  *
  13  * Usage:
  14  * For functions:
  15  *
  16  * You should add __init immediately before the function name, like:
  17  *
  18  * static void __init initme(int x, int y)
  19  * {
  20  *    extern int z; z = x * y;
  21  * }
  22  *
  23  * If the function has a prototype somewhere, you can also add
  24  * __init between closing brace of the prototype and semicolon:
  25  *
  26  * extern int initialize_foobar_device(int, int, int) __init;
  27  *
  28  * For initialized data:
  29  * You should insert __initdata between the variable name and equal
  30  * sign followed by value, e.g.:
  31  *
  32  * static int init_variable __initdata = 0;
  33  * static char linux_logo[] __initdata = { 0x32, 0x36, ... };
  34  *
  35  * Don't forget to initialize data not at file scope, i.e. within a function,
  36  * as gcc otherwise puts the data into the bss section and not into the init
  37  * section.
  38  *
  39  * Also note, that this data cannot be "const".
  40  */
  41
  42 /* These are for everybody (although not all archs will actually
  43    discard it in modules) */
  44 #define __init          __attribute__ ((__section__ (".init.text")))
  45 #define __initdata      __attribute__ ((__section__ (".init.data")))
  46 #define __exitdata      __attribute__ ((__section__(".exit.data")))
  47 #define __exit_call     __attribute_used__ __attribute__ ((__section__ (".exitcall.exit")))
  48
  49 #define __sched         __attribute__((__section__(".sched.text")))
  50
  51 #ifdef MODULE
  52 #define __exit          __attribute__ ((__section__(".exit.text")))
  53 #else
  54 #define __exit          __attribute_used__ __attribute__ ((__section__(".exit.text")))
  55 #endif
  56
  57 /* For assembly routines */
  58 #define __INIT          .section        ".init.text","ax"
  59 #define __FINIT         .previous
  60 #define __INITDATA      .section        ".init.data","aw"
  61
  62 #ifndef __ASSEMBLY__
  63 /*
  64  * Used for initialization calls..
  65  */
  66 typedef int (*initcall_t)(void);
  67 typedef void (*exitcall_t)(void);
  68
  69 extern initcall_t __con_initcall_start, __con_initcall_end;
  70 extern initcall_t __security_initcall_start, __security_initcall_end;
  71 #endif
  72
  73 #ifndef MODULE
  74
  75 #ifndef __ASSEMBLY__
  76
  77 /* initcalls are now grouped by functionality into separate
  78  * subsections. Ordering inside the subsections is determined
  79  * by link order.
  80  * For backwards compatibility, initcall() puts the call in
  81  * the device init subsection.
  82  */
  83
  84 #define __define_initcall(level,fn) \
  85         static initcall_t __initcall_##fn __attribute_used__ \
  86         __attribute__((__section__(".initcall" level ".init"))) = fn
  87
  88 #define core_initcall(fn)               __define_initcall("1",fn)
  89 #define postcore_initcall(fn)           __define_initcall("2",fn)
  90 #define arch_initcall(fn)               __define_initcall("3",fn)
  91 #define subsys_initcall(fn)             __define_initcall("4",fn)
  92 #define fs_initcall(fn)                 __define_initcall("5",fn)
  93 #define device_initcall(fn)             __define_initcall("6",fn)
  94 #define late_initcall(fn)               __define_initcall("7",fn)
  95
  96 #define __initcall(fn) device_initcall(fn)
  97
  98 #define __exitcall(fn) \
  99         static exitcall_t __exitcall_##fn __exit_call = fn
 100
 101 #define console_initcall(fn) \
 102         static initcall_t __initcall_##fn \
 103         __attribute_used__ __attribute__((__section__(".con_initcall.init")))=fn
 104
 105 #define security_initcall(fn) \
 106         static initcall_t __initcall_##fn \
 107         __attribute_used__ __attribute__((__section__(".security_initcall.init"))) = fn
 108
 109 struct obs_kernel_param {
 110         const char *str;
 111         int (*setup_func)(char *);
 112 };
 113
 114 /* OBSOLETE: see moduleparam.h for the right way. */
 115 #define __setup_param(str, unique_id, fn)                       \
 116         static char __setup_str_##unique_id[] __initdata = str; \
 117         static struct obs_kernel_param __setup_##unique_id      \
 118                  __attribute_used__                             \
 119                  __attribute__((__section__(".init.setup")))    \
 120                 = { __setup_str_##unique_id, fn }
 121
 122 #define __setup_null_param(str, unique_id)                      \
 123         __setup_param(str, unique_id, NULL)
 124
 125 #define __setup(str, fn)                                        \
 126         __setup_param(str, fn, fn)
 127
 128 #define __obsolete_setup(str)                                   \
 129         __setup_null_param(str, __LINE__)
 130
 131 #endif /* __ASSEMBLY__ */
 132
 133 /**
 134  * module_init() - driver initialization entry point
 135  * @x: function to be run at kernel boot time or module insertion
 136  *
 137  * module_init() will either be called during do_initcalls (if
 138  * builtin) or at module insertion time (if a module).  There can only
 139  * be one per module.
 140  */
 141 #define module_init(x)  __initcall(x);
 142
 143 /**
 144  * module_exit() - driver exit entry point
 145  * @x: function to be run when driver is removed
 146  *
 147  * module_exit() will wrap the driver clean-up code
 148  * with cleanup_module() when used with rmmod when
 149  * the driver is a module.  If the driver is statically
 150  * compiled into the kernel, module_exit() has no effect.
 151  * There can only be one per module.
 152  */
 153 #define module_exit(x)  __exitcall(x);
 154
 155 #else /* MODULE */
 156
 157 /* Don't use these in modules, but some people do... */
 158 #define core_initcall(fn)               module_init(fn)
 159 #define postcore_initcall(fn)           module_init(fn)
 160 #define arch_initcall(fn)               module_init(fn)
 161 #define subsys_initcall(fn)             module_init(fn)
 162 #define fs_initcall(fn)                 module_init(fn)
 163 #define device_initcall(fn)             module_init(fn)
 164 #define late_initcall(fn)               module_init(fn)
 165
 166 #define security_initcall(fn)           module_init(fn)
 167
 168 /* These macros create a dummy inline: gcc 2.9x does not count alias
 169  as usage, hence the `unused function' warning when __init functions
 170  are declared static. We use the dummy __*_module_inline functions
 171  both to kill the warning and check the type of the init/cleanup
 172  function. */
 173
 174 /* Each module must use one module_init(), or one no_module_init */
 175 #define module_init(initfn)                                     \
 176         static inline initcall_t __inittest(void)               \
 177         { return initfn; }                                      \
 178         int init_module(void) __attribute__((alias(#initfn)));
 179
 180 /* This is only required if you want to be unloadable. */
 181 #define module_exit(exitfn)                                     \
 182         static inline exitcall_t __exittest(void)               \
 183         { return exitfn; }                                      \
 184         void cleanup_module(void) __attribute__((alias(#exitfn)));
 185
 186 #define __setup_param(str, unique_id, fn)       /* nothing */
 187 #define __setup_null_param(str, unique_id)      /* nothing */
 188 #define __setup(str, func)                      /* nothing */
 189 #define __obsolete_setup(str)                   /* nothing */
 190 #endif
 191
 192 /* Data marked not to be saved by software_suspend() */
 193 #define __nosavedata __attribute__ ((__section__ (".data.nosave")))
 194
 195 /* This means "can be init if no module support, otherwise module load
 196    may call it." */
 197 #ifdef CONFIG_MODULES
 198 #define __init_or_module
 199 #define __initdata_or_module
 200 #else
 201 #define __init_or_module __init
 202 #define __initdata_or_module __initdata
 203 #endif /*CONFIG_MODULES*/
 204
 205 #ifdef CONFIG_HOTPLUG
 206 #define __devinit
 207 #define __devinitdata
 208 #define __devexit
 209 #define __devexitdata
 210 #else
 211 #define __devinit __init
 212 #define __devinitdata __initdata
 213 #define __devexit __exit
 214 #define __devexitdata __exitdata
 215 #endif
 216
 217 /* Functions marked as __devexit may be discarded at kernel link time, depending
 218    on config options.  Newer versions of binutils detect references from
 219    retained sections to discarded sections and flag an error.  Pointers to
 220    __devexit functions must use __devexit_p(function_name), the wrapper will
 221    insert either the function_name or NULL, depending on the config options.
 222  */
 223 #if defined(MODULE) || defined(CONFIG_HOTPLUG)
 224 #define __devexit_p(x) x
 225 #else
 226 #define __devexit_p(x) NULL
 227 #endif
 228
 229 #ifdef MODULE
 230 #define __exit_p(x) x
 231 #else
 232 #define __exit_p(x) NULL
 233 #endif
 234
 235 #endif /* _LINUX_INIT_H */