l4/pkg/dde/linux26/include/linux/init.h

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