Remove cpu hotplug defines for __INIT & __INITDATA
[linux-2.6.git] / 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 __initdata boot_command_line[];
71 extern char *saved_command_line;
72 extern unsigned int reset_devices;
73
74 /* used by init/main.c */
75 void setup_arch(char **);
76 void prepare_namespace(void);
77
78 #endif
79   
80 #ifndef MODULE
81
82 #ifndef __ASSEMBLY__
83
84 /* initcalls are now grouped by functionality into separate 
85  * subsections. Ordering inside the subsections is determined
86  * by link order. 
87  * For backwards compatibility, initcall() puts the call in 
88  * the device init subsection.
89  *
90  * The `id' arg to __define_initcall() is needed so that multiple initcalls
91  * can point at the same handler without causing duplicate-symbol build errors.
92  */
93
94 #define __define_initcall(level,fn,id) \
95         static initcall_t __initcall_##fn##id __attribute_used__ \
96         __attribute__((__section__(".initcall" level ".init"))) = fn
97
98 /*
99  * A "pure" initcall has no dependencies on anything else, and purely
100  * initializes variables that couldn't be statically initialized.
101  *
102  * This only exists for built-in code, not for modules.
103  */
104 #define pure_initcall(fn)               __define_initcall("0",fn,1)
105
106 #define core_initcall(fn)               __define_initcall("1",fn,1)
107 #define core_initcall_sync(fn)          __define_initcall("1s",fn,1s)
108 #define postcore_initcall(fn)           __define_initcall("2",fn,2)
109 #define postcore_initcall_sync(fn)      __define_initcall("2s",fn,2s)
110 #define arch_initcall(fn)               __define_initcall("3",fn,3)
111 #define arch_initcall_sync(fn)          __define_initcall("3s",fn,3s)
112 #define subsys_initcall(fn)             __define_initcall("4",fn,4)
113 #define subsys_initcall_sync(fn)        __define_initcall("4s",fn,4s)
114 #define fs_initcall(fn)                 __define_initcall("5",fn,5)
115 #define fs_initcall_sync(fn)            __define_initcall("5s",fn,5s)
116 #define rootfs_initcall(fn)             __define_initcall("rootfs",fn,rootfs)
117 #define device_initcall(fn)             __define_initcall("6",fn,6)
118 #define device_initcall_sync(fn)        __define_initcall("6s",fn,6s)
119 #define late_initcall(fn)               __define_initcall("7",fn,7)
120 #define late_initcall_sync(fn)          __define_initcall("7s",fn,7s)
121
122 #define __initcall(fn) device_initcall(fn)
123
124 #define __exitcall(fn) \
125         static exitcall_t __exitcall_##fn __exit_call = fn
126
127 #define console_initcall(fn) \
128         static initcall_t __initcall_##fn \
129         __attribute_used__ __attribute__((__section__(".con_initcall.init")))=fn
130
131 #define security_initcall(fn) \
132         static initcall_t __initcall_##fn \
133         __attribute_used__ __attribute__((__section__(".security_initcall.init"))) = fn
134
135 struct obs_kernel_param {
136         const char *str;
137         int (*setup_func)(char *);
138         int early;
139 };
140
141 /*
142  * Only for really core code.  See moduleparam.h for the normal way.
143  *
144  * Force the alignment so the compiler doesn't space elements of the
145  * obs_kernel_param "array" too far apart in .init.setup.
146  */
147 #define __setup_param(str, unique_id, fn, early)                        \
148         static char __setup_str_##unique_id[] __initdata = str; \
149         static struct obs_kernel_param __setup_##unique_id      \
150                 __attribute_used__                              \
151                 __attribute__((__section__(".init.setup")))     \
152                 __attribute__((aligned((sizeof(long)))))        \
153                 = { __setup_str_##unique_id, fn, early }
154
155 #define __setup_null_param(str, unique_id)                      \
156         __setup_param(str, unique_id, NULL, 0)
157
158 #define __setup(str, fn)                                        \
159         __setup_param(str, fn, fn, 0)
160
161 #define __obsolete_setup(str)                                   \
162         __setup_null_param(str, __LINE__)
163
164 /* NOTE: fn is as per module_param, not __setup!  Emits warning if fn
165  * returns non-zero. */
166 #define early_param(str, fn)                                    \
167         __setup_param(str, fn, fn, 1)
168
169 /* Relies on boot_command_line being set */
170 void __init parse_early_param(void);
171 #endif /* __ASSEMBLY__ */
172
173 /**
174  * module_init() - driver initialization entry point
175  * @x: function to be run at kernel boot time or module insertion
176  * 
177  * module_init() will either be called during do_initcalls() (if
178  * builtin) or at module insertion time (if a module).  There can only
179  * be one per module.
180  */
181 #define module_init(x)  __initcall(x);
182
183 /**
184  * module_exit() - driver exit entry point
185  * @x: function to be run when driver is removed
186  * 
187  * module_exit() will wrap the driver clean-up code
188  * with cleanup_module() when used with rmmod when
189  * the driver is a module.  If the driver is statically
190  * compiled into the kernel, module_exit() has no effect.
191  * There can only be one per module.
192  */
193 #define module_exit(x)  __exitcall(x);
194
195 #else /* MODULE */
196
197 /* Don't use these in modules, but some people do... */
198 #define core_initcall(fn)               module_init(fn)
199 #define postcore_initcall(fn)           module_init(fn)
200 #define arch_initcall(fn)               module_init(fn)
201 #define subsys_initcall(fn)             module_init(fn)
202 #define fs_initcall(fn)                 module_init(fn)
203 #define device_initcall(fn)             module_init(fn)
204 #define late_initcall(fn)               module_init(fn)
205
206 #define security_initcall(fn)           module_init(fn)
207
208 /* These macros create a dummy inline: gcc 2.9x does not count alias
209  as usage, hence the `unused function' warning when __init functions
210  are declared static. We use the dummy __*_module_inline functions
211  both to kill the warning and check the type of the init/cleanup
212  function. */
213
214 /* Each module must use one module_init(), or one no_module_init */
215 #define module_init(initfn)                                     \
216         static inline initcall_t __inittest(void)               \
217         { return initfn; }                                      \
218         int init_module(void) __attribute__((alias(#initfn)));
219
220 /* This is only required if you want to be unloadable. */
221 #define module_exit(exitfn)                                     \
222         static inline exitcall_t __exittest(void)               \
223         { return exitfn; }                                      \
224         void cleanup_module(void) __attribute__((alias(#exitfn)));
225
226 #define __setup_param(str, unique_id, fn)       /* nothing */
227 #define __setup_null_param(str, unique_id)      /* nothing */
228 #define __setup(str, func)                      /* nothing */
229 #define __obsolete_setup(str)                   /* nothing */
230 #endif
231
232 /* Data marked not to be saved by software suspend */
233 #define __nosavedata __attribute__ ((__section__ (".data.nosave")))
234
235 /* This means "can be init if no module support, otherwise module load
236    may call it." */
237 #ifdef CONFIG_MODULES
238 #define __init_or_module
239 #define __initdata_or_module
240 #else
241 #define __init_or_module __init
242 #define __initdata_or_module __initdata
243 #endif /*CONFIG_MODULES*/
244
245 #ifdef CONFIG_HOTPLUG
246 #define __devinit
247 #define __devinitdata
248 #define __devexit
249 #define __devexitdata
250 #else
251 #define __devinit __init
252 #define __devinitdata __initdata
253 #define __devexit __exit
254 #define __devexitdata __exitdata
255 #endif
256
257 #ifdef CONFIG_HOTPLUG_CPU
258 #define __cpuinit
259 #define __cpuinitdata
260 #define __cpuexit
261 #define __cpuexitdata
262 #else
263 #define __cpuinit       __init
264 #define __cpuinitdata __initdata
265 #define __cpuexit __exit
266 #define __cpuexitdata   __exitdata
267 #endif
268
269 #if defined(CONFIG_MEMORY_HOTPLUG) || defined(CONFIG_ACPI_HOTPLUG_MEMORY) \
270         || defined(CONFIG_ACPI_HOTPLUG_MEMORY_MODULE)
271 #define __meminit
272 #define __meminitdata
273 #define __memexit
274 #define __memexitdata
275 #else
276 #define __meminit       __init
277 #define __meminitdata __initdata
278 #define __memexit __exit
279 #define __memexitdata   __exitdata
280 #endif
281
282 /* Functions marked as __devexit may be discarded at kernel link time, depending
283    on config options.  Newer versions of binutils detect references from
284    retained sections to discarded sections and flag an error.  Pointers to
285    __devexit functions must use __devexit_p(function_name), the wrapper will
286    insert either the function_name or NULL, depending on the config options.
287  */
288 #if defined(MODULE) || defined(CONFIG_HOTPLUG)
289 #define __devexit_p(x) x
290 #else
291 #define __devexit_p(x) NULL
292 #endif
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 */