init.h 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. #ifndef _LINUX_INIT_H
  2. #define _LINUX_INIT_H
  3. #include <linux/compiler.h>
  4. #include <linux/types.h>
  5. /* Built-in __init functions needn't be compiled with retpoline */
  6. #if defined(RETPOLINE) && !defined(MODULE)
  7. #define __noretpoline __attribute__((indirect_branch("keep")))
  8. #else
  9. #define __noretpoline
  10. #endif
  11. /* These macros are used to mark some functions or
  12. * initialized data (doesn't apply to uninitialized data)
  13. * as `initialization' functions. The kernel can take this
  14. * as hint that the function is used only during the initialization
  15. * phase and free up used memory resources after
  16. *
  17. * Usage:
  18. * For functions:
  19. *
  20. * You should add __init immediately before the function name, like:
  21. *
  22. * static void __init initme(int x, int y)
  23. * {
  24. * extern int z; z = x * y;
  25. * }
  26. *
  27. * If the function has a prototype somewhere, you can also add
  28. * __init between closing brace of the prototype and semicolon:
  29. *
  30. * extern int initialize_foobar_device(int, int, int) __init;
  31. *
  32. * For initialized data:
  33. * You should insert __initdata or __initconst between the variable name
  34. * and equal sign followed by value, e.g.:
  35. *
  36. * static int init_variable __initdata = 0;
  37. * static const char linux_logo[] __initconst = { 0x32, 0x36, ... };
  38. *
  39. * Don't forget to initialize data not at file scope, i.e. within a function,
  40. * as gcc otherwise puts the data into the bss section and not into the init
  41. * section.
  42. */
  43. /* These are for everybody (although not all archs will actually
  44. discard it in modules) */
  45. #define __init __section(.init.text) __cold notrace __noretpoline
  46. #define __initdata __section(.init.data)
  47. #define __initconst __constsection(.init.rodata)
  48. #define __exitdata __section(.exit.data)
  49. #define __exit_call __used __section(.exitcall.exit)
  50. /*
  51. * Some architecture have tool chains which do not handle rodata attributes
  52. * correctly. For those disable special sections for const, so that other
  53. * architectures can annotate correctly.
  54. */
  55. #ifdef CONFIG_BROKEN_RODATA
  56. #define __constsection(x)
  57. #else
  58. #define __constsection(x) __section(x)
  59. #endif
  60. /*
  61. * modpost check for section mismatches during the kernel build.
  62. * A section mismatch happens when there are references from a
  63. * code or data section to an init section (both code or data).
  64. * The init sections are (for most archs) discarded by the kernel
  65. * when early init has completed so all such references are potential bugs.
  66. * For exit sections the same issue exists.
  67. *
  68. * The following markers are used for the cases where the reference to
  69. * the *init / *exit section (code or data) is valid and will teach
  70. * modpost not to issue a warning. Intended semantics is that a code or
  71. * data tagged __ref* can reference code or data from init section without
  72. * producing a warning (of course, no warning does not mean code is
  73. * correct, so optimally document why the __ref is needed and why it's OK).
  74. *
  75. * The markers follow same syntax rules as __init / __initdata.
  76. */
  77. #define __ref __section(.ref.text) noinline
  78. #define __refdata __section(.ref.data)
  79. #define __refconst __constsection(.ref.rodata)
  80. /* compatibility defines */
  81. #define __init_refok __ref
  82. #define __initdata_refok __refdata
  83. #define __exit_refok __ref
  84. #ifdef MODULE
  85. #define __exitused
  86. #else
  87. #define __exitused __used
  88. #endif
  89. #define __exit __section(.exit.text) __exitused __cold notrace
  90. /* Used for MEMORY_HOTPLUG */
  91. #define __meminit __section(.meminit.text) __cold notrace
  92. #define __meminitdata __section(.meminit.data)
  93. #define __meminitconst __constsection(.meminit.rodata)
  94. #define __memexit __section(.memexit.text) __exitused __cold notrace
  95. #define __memexitdata __section(.memexit.data)
  96. #define __memexitconst __constsection(.memexit.rodata)
  97. /* For assembly routines */
  98. #define __HEAD .section ".head.text","ax"
  99. #define __INIT .section ".init.text","ax"
  100. #define __FINIT .previous
  101. #define __INITDATA .section ".init.data","aw",%progbits
  102. #define __INITRODATA .section ".init.rodata","a",%progbits
  103. #define __FINITDATA .previous
  104. #define __MEMINIT .section ".meminit.text", "ax"
  105. #define __MEMINITDATA .section ".meminit.data", "aw"
  106. #define __MEMINITRODATA .section ".meminit.rodata", "a"
  107. /* silence warnings when references are OK */
  108. #define __REF .section ".ref.text", "ax"
  109. #define __REFDATA .section ".ref.data", "aw"
  110. #define __REFCONST .section ".ref.rodata", "a"
  111. #ifndef __ASSEMBLY__
  112. /*
  113. * Used for initialization calls..
  114. */
  115. typedef int (*initcall_t)(void);
  116. typedef void (*exitcall_t)(void);
  117. extern initcall_t __con_initcall_start[], __con_initcall_end[];
  118. extern initcall_t __security_initcall_start[], __security_initcall_end[];
  119. /* Used for contructor calls. */
  120. typedef void (*ctor_fn_t)(void);
  121. /* Defined in init/main.c */
  122. extern int do_one_initcall(initcall_t fn);
  123. extern char __initdata boot_command_line[];
  124. extern char *saved_command_line;
  125. extern unsigned int reset_devices;
  126. /* used by init/main.c */
  127. void setup_arch(char **);
  128. void prepare_namespace(void);
  129. void __init load_default_modules(void);
  130. int __init init_rootfs(void);
  131. extern void (*late_time_init)(void);
  132. extern bool initcall_debug;
  133. #endif
  134. #ifndef MODULE
  135. #ifndef __ASSEMBLY__
  136. #ifdef CONFIG_LTO
  137. /* Work around a LTO gcc problem: when there is no reference to a variable
  138. * in a module it will be moved to the end of the program. This causes
  139. * reordering of initcalls which the kernel does not like.
  140. * Add a dummy reference function to avoid this. The function is
  141. * deleted by the linker.
  142. */
  143. #define LTO_REFERENCE_INITCALL(x) \
  144. ; /* yes this is needed */ \
  145. static __used __exit void *reference_##x(void) \
  146. { \
  147. return &x; \
  148. }
  149. #else
  150. #define LTO_REFERENCE_INITCALL(x)
  151. #endif
  152. /* initcalls are now grouped by functionality into separate
  153. * subsections. Ordering inside the subsections is determined
  154. * by link order.
  155. * For backwards compatibility, initcall() puts the call in
  156. * the device init subsection.
  157. *
  158. * The `id' arg to __define_initcall() is needed so that multiple initcalls
  159. * can point at the same handler without causing duplicate-symbol build errors.
  160. */
  161. #define __define_initcall(fn, id) \
  162. static initcall_t __initcall_##fn##id __used \
  163. __attribute__((__section__(".initcall" #id ".init"))) = fn; \
  164. LTO_REFERENCE_INITCALL(__initcall_##fn##id)
  165. /*
  166. * Early initcalls run before initializing SMP.
  167. *
  168. * Only for built-in code, not modules.
  169. */
  170. #define early_initcall(fn) __define_initcall(fn, early)
  171. /*
  172. * A "pure" initcall has no dependencies on anything else, and purely
  173. * initializes variables that couldn't be statically initialized.
  174. *
  175. * This only exists for built-in code, not for modules.
  176. * Keep main.c:initcall_level_names[] in sync.
  177. */
  178. #define pure_initcall(fn) __define_initcall(fn, 0)
  179. #define core_initcall(fn) __define_initcall(fn, 1)
  180. #define core_initcall_sync(fn) __define_initcall(fn, 1s)
  181. #define postcore_initcall(fn) __define_initcall(fn, 2)
  182. #define postcore_initcall_sync(fn) __define_initcall(fn, 2s)
  183. #define arch_initcall(fn) __define_initcall(fn, 3)
  184. #define arch_initcall_sync(fn) __define_initcall(fn, 3s)
  185. #define subsys_initcall(fn) __define_initcall(fn, 4)
  186. #define subsys_initcall_sync(fn) __define_initcall(fn, 4s)
  187. #define fs_initcall(fn) __define_initcall(fn, 5)
  188. #define fs_initcall_sync(fn) __define_initcall(fn, 5s)
  189. #define rootfs_initcall(fn) __define_initcall(fn, rootfs)
  190. #define device_initcall(fn) __define_initcall(fn, 6)
  191. #define device_initcall_sync(fn) __define_initcall(fn, 6s)
  192. #define late_initcall(fn) __define_initcall(fn, 7)
  193. #define late_initcall_sync(fn) __define_initcall(fn, 7s)
  194. #define __initcall(fn) device_initcall(fn)
  195. #define __exitcall(fn) \
  196. static exitcall_t __exitcall_##fn __exit_call = fn
  197. #define console_initcall(fn) \
  198. static initcall_t __initcall_##fn \
  199. __used __section(.con_initcall.init) = fn
  200. #define security_initcall(fn) \
  201. static initcall_t __initcall_##fn \
  202. __used __section(.security_initcall.init) = fn
  203. struct obs_kernel_param {
  204. const char *str;
  205. int (*setup_func)(char *);
  206. int early;
  207. };
  208. /*
  209. * Only for really core code. See moduleparam.h for the normal way.
  210. *
  211. * Force the alignment so the compiler doesn't space elements of the
  212. * obs_kernel_param "array" too far apart in .init.setup.
  213. */
  214. #define __setup_param(str, unique_id, fn, early) \
  215. static const char __setup_str_##unique_id[] __initconst \
  216. __aligned(1) = str; \
  217. static struct obs_kernel_param __setup_##unique_id \
  218. __used __section(.init.setup) \
  219. __attribute__((aligned((sizeof(long))))) \
  220. = { __setup_str_##unique_id, fn, early }
  221. #define __setup(str, fn) \
  222. __setup_param(str, fn, fn, 0)
  223. /*
  224. * NOTE: fn is as per module_param, not __setup!
  225. * Emits warning if fn returns non-zero.
  226. */
  227. #define early_param(str, fn) \
  228. __setup_param(str, fn, fn, 1)
  229. #define early_param_on_off(str_on, str_off, var, config) \
  230. \
  231. int var = IS_ENABLED(config); \
  232. \
  233. static int __init parse_##var##_on(char *arg) \
  234. { \
  235. var = 1; \
  236. return 0; \
  237. } \
  238. __setup_param(str_on, parse_##var##_on, parse_##var##_on, 1); \
  239. \
  240. static int __init parse_##var##_off(char *arg) \
  241. { \
  242. var = 0; \
  243. return 0; \
  244. } \
  245. __setup_param(str_off, parse_##var##_off, parse_##var##_off, 1)
  246. /* Relies on boot_command_line being set */
  247. void __init parse_early_param(void);
  248. void __init parse_early_options(char *cmdline);
  249. #endif /* __ASSEMBLY__ */
  250. #else /* MODULE */
  251. #define __setup_param(str, unique_id, fn) /* nothing */
  252. #define __setup(str, func) /* nothing */
  253. #endif
  254. /* Data marked not to be saved by software suspend */
  255. #define __nosavedata __section(.data..nosave)
  256. #ifdef MODULE
  257. #define __exit_p(x) x
  258. #else
  259. #define __exit_p(x) NULL
  260. #endif
  261. #endif /* _LINUX_INIT_H */