Version:  2.0.40 2.2.26 2.4.37 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2

Linux/include/linux/init.h

  1 #ifndef _LINUX_INIT_H
  2 #define _LINUX_INIT_H
  3 
  4 #include <linux/compiler.h>
  5 #include <linux/types.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 or __initconst between the variable name
 30  * and equal sign followed by value, e.g.:
 31  *
 32  * static int init_variable __initdata = 0;
 33  * static const char linux_logo[] __initconst = { 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 
 40 /* These are for everybody (although not all archs will actually
 41    discard it in modules) */
 42 #define __init          __section(.init.text) __cold notrace
 43 #define __initdata      __section(.init.data)
 44 #define __initconst     __constsection(.init.rodata)
 45 #define __exitdata      __section(.exit.data)
 46 #define __exit_call     __used __section(.exitcall.exit)
 47 
 48 /*
 49  * Some architecture have tool chains which do not handle rodata attributes
 50  * correctly. For those disable special sections for const, so that other
 51  * architectures can annotate correctly.
 52  */
 53 #ifdef CONFIG_BROKEN_RODATA
 54 #define __constsection(x)
 55 #else
 56 #define __constsection(x) __section(x)
 57 #endif
 58 
 59 /*
 60  * modpost check for section mismatches during the kernel build.
 61  * A section mismatch happens when there are references from a
 62  * code or data section to an init section (both code or data).
 63  * The init sections are (for most archs) discarded by the kernel
 64  * when early init has completed so all such references are potential bugs.
 65  * For exit sections the same issue exists.
 66  *
 67  * The following markers are used for the cases where the reference to
 68  * the *init / *exit section (code or data) is valid and will teach
 69  * modpost not to issue a warning.  Intended semantics is that a code or
 70  * data tagged __ref* can reference code or data from init section without
 71  * producing a warning (of course, no warning does not mean code is
 72  * correct, so optimally document why the __ref is needed and why it's OK).
 73  *
 74  * The markers follow same syntax rules as __init / __initdata.
 75  */
 76 #define __ref            __section(.ref.text) noinline
 77 #define __refdata        __section(.ref.data)
 78 #define __refconst       __constsection(.ref.rodata)
 79 
 80 /* compatibility defines */
 81 #define __init_refok     __ref
 82 #define __initdata_refok __refdata
 83 #define __exit_refok     __ref
 84 
 85 
 86 #ifdef MODULE
 87 #define __exitused
 88 #else
 89 #define __exitused  __used
 90 #endif
 91 
 92 #define __exit          __section(.exit.text) __exitused __cold notrace
 93 
 94 /* Used for MEMORY_HOTPLUG */
 95 #define __meminit        __section(.meminit.text) __cold notrace
 96 #define __meminitdata    __section(.meminit.data)
 97 #define __meminitconst   __constsection(.meminit.rodata)
 98 #define __memexit        __section(.memexit.text) __exitused __cold notrace
 99 #define __memexitdata    __section(.memexit.data)
100 #define __memexitconst   __constsection(.memexit.rodata)
101 
102 /* For assembly routines */
103 #define __HEAD          .section        ".head.text","ax"
104 #define __INIT          .section        ".init.text","ax"
105 #define __FINIT         .previous
106 
107 #define __INITDATA      .section        ".init.data","aw",%progbits
108 #define __INITRODATA    .section        ".init.rodata","a",%progbits
109 #define __FINITDATA     .previous
110 
111 #define __MEMINIT        .section       ".meminit.text", "ax"
112 #define __MEMINITDATA    .section       ".meminit.data", "aw"
113 #define __MEMINITRODATA  .section       ".meminit.rodata", "a"
114 
115 /* silence warnings when references are OK */
116 #define __REF            .section       ".ref.text", "ax"
117 #define __REFDATA        .section       ".ref.data", "aw"
118 #define __REFCONST       .section       ".ref.rodata", "a"
119 
120 #ifndef __ASSEMBLY__
121 /*
122  * Used for initialization calls..
123  */
124 typedef int (*initcall_t)(void);
125 typedef void (*exitcall_t)(void);
126 
127 extern initcall_t __con_initcall_start[], __con_initcall_end[];
128 extern initcall_t __security_initcall_start[], __security_initcall_end[];
129 
130 /* Used for contructor calls. */
131 typedef void (*ctor_fn_t)(void);
132 
133 /* Defined in init/main.c */
134 extern int do_one_initcall(initcall_t fn);
135 extern char __initdata boot_command_line[];
136 extern char *saved_command_line;
137 extern unsigned int reset_devices;
138 
139 /* used by init/main.c */
140 void setup_arch(char **);
141 void prepare_namespace(void);
142 void __init load_default_modules(void);
143 int __init init_rootfs(void);
144 
145 extern void (*late_time_init)(void);
146 
147 extern bool initcall_debug;
148 
149 #endif
150   
151 #ifndef MODULE
152 
153 #ifndef __ASSEMBLY__
154 
155 #ifdef CONFIG_LTO
156 /* Work around a LTO gcc problem: when there is no reference to a variable
157  * in a module it will be moved to the end of the program. This causes
158  * reordering of initcalls which the kernel does not like.
159  * Add a dummy reference function to avoid this. The function is
160  * deleted by the linker.
161  */
162 #define LTO_REFERENCE_INITCALL(x) \
163         ; /* yes this is needed */                      \
164         static __used __exit void *reference_##x(void)  \
165         {                                               \
166                 return &x;                              \
167         }
168 #else
169 #define LTO_REFERENCE_INITCALL(x)
170 #endif
171 
172 /* initcalls are now grouped by functionality into separate 
173  * subsections. Ordering inside the subsections is determined
174  * by link order. 
175  * For backwards compatibility, initcall() puts the call in 
176  * the device init subsection.
177  *
178  * The `id' arg to __define_initcall() is needed so that multiple initcalls
179  * can point at the same handler without causing duplicate-symbol build errors.
180  */
181 
182 #define __define_initcall(fn, id) \
183         static initcall_t __initcall_##fn##id __used \
184         __attribute__((__section__(".initcall" #id ".init"))) = fn; \
185         LTO_REFERENCE_INITCALL(__initcall_##fn##id)
186 
187 /*
188  * Early initcalls run before initializing SMP.
189  *
190  * Only for built-in code, not modules.
191  */
192 #define early_initcall(fn)              __define_initcall(fn, early)
193 
194 /*
195  * A "pure" initcall has no dependencies on anything else, and purely
196  * initializes variables that couldn't be statically initialized.
197  *
198  * This only exists for built-in code, not for modules.
199  * Keep main.c:initcall_level_names[] in sync.
200  */
201 #define pure_initcall(fn)               __define_initcall(fn, 0)
202 
203 #define core_initcall(fn)               __define_initcall(fn, 1)
204 #define core_initcall_sync(fn)          __define_initcall(fn, 1s)
205 #define postcore_initcall(fn)           __define_initcall(fn, 2)
206 #define postcore_initcall_sync(fn)      __define_initcall(fn, 2s)
207 #define arch_initcall(fn)               __define_initcall(fn, 3)
208 #define arch_initcall_sync(fn)          __define_initcall(fn, 3s)
209 #define subsys_initcall(fn)             __define_initcall(fn, 4)
210 #define subsys_initcall_sync(fn)        __define_initcall(fn, 4s)
211 #define fs_initcall(fn)                 __define_initcall(fn, 5)
212 #define fs_initcall_sync(fn)            __define_initcall(fn, 5s)
213 #define rootfs_initcall(fn)             __define_initcall(fn, rootfs)
214 #define device_initcall(fn)             __define_initcall(fn, 6)
215 #define device_initcall_sync(fn)        __define_initcall(fn, 6s)
216 #define late_initcall(fn)               __define_initcall(fn, 7)
217 #define late_initcall_sync(fn)          __define_initcall(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 /*
256  * NOTE: fn is as per module_param, not __setup!
257  * Emits warning if fn returns non-zero.
258  */
259 #define early_param(str, fn)                                            \
260         __setup_param(str, fn, fn, 1)
261 
262 #define early_param_on_off(str_on, str_off, var, config)                \
263                                                                         \
264         int var = IS_ENABLED(config);                                   \
265                                                                         \
266         static int __init parse_##var##_on(char *arg)                   \
267         {                                                               \
268                 var = 1;                                                \
269                 return 0;                                               \
270         }                                                               \
271         __setup_param(str_on, parse_##var##_on, parse_##var##_on, 1);   \
272                                                                         \
273         static int __init parse_##var##_off(char *arg)                  \
274         {                                                               \
275                 var = 0;                                                \
276                 return 0;                                               \
277         }                                                               \
278         __setup_param(str_off, parse_##var##_off, parse_##var##_off, 1)
279 
280 /* Relies on boot_command_line being set */
281 void __init parse_early_param(void);
282 void __init parse_early_options(char *cmdline);
283 #endif /* __ASSEMBLY__ */
284 
285 #else /* MODULE */
286 
287 #define __setup_param(str, unique_id, fn)       /* nothing */
288 #define __setup(str, func)                      /* nothing */
289 #endif
290 
291 /* Data marked not to be saved by software suspend */
292 #define __nosavedata __section(.data..nosave)
293 
294 #ifdef MODULE
295 #define __exit_p(x) x
296 #else
297 #define __exit_p(x) NULL
298 #endif
299 
300 #endif /* _LINUX_INIT_H */
301 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us