module.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. #ifndef _LINUX_MODULE_H
  2. #define _LINUX_MODULE_H
  3. /*
  4. * Dynamic loading of modules into the kernel.
  5. *
  6. * Rewritten by Richard Henderson <[email protected]> Dec 1996
  7. * Rewritten again by Rusty Russell, 2002
  8. */
  9. #include <linux/list.h>
  10. #include <linux/stat.h>
  11. #include <linux/compiler.h>
  12. #include <linux/cache.h>
  13. #include <linux/kmod.h>
  14. #include <linux/init.h>
  15. #include <linux/elf.h>
  16. #include <linux/stringify.h>
  17. #include <linux/kobject.h>
  18. #include <linux/moduleparam.h>
  19. #include <linux/jump_label.h>
  20. #include <linux/export.h>
  21. #include <linux/rbtree_latch.h>
  22. #include <linux/error-injection.h>
  23. #include <linux/tracepoint-defs.h>
  24. #include <linux/percpu.h>
  25. #include <asm/module.h>
  26. /* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
  27. #define MODULE_SIG_STRING "~Module signature appended~\n"
  28. /* Not Yet Implemented */
  29. #define MODULE_SUPPORTED_DEVICE(name)
  30. #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
  31. struct modversion_info {
  32. unsigned long crc;
  33. char name[MODULE_NAME_LEN];
  34. };
  35. struct module;
  36. struct exception_table_entry;
  37. struct module_kobject {
  38. struct kobject kobj;
  39. struct module *mod;
  40. struct kobject *drivers_dir;
  41. struct module_param_attrs *mp;
  42. struct completion *kobj_completion;
  43. } __randomize_layout;
  44. struct module_attribute {
  45. struct attribute attr;
  46. ssize_t (*show)(struct module_attribute *, struct module_kobject *,
  47. char *);
  48. ssize_t (*store)(struct module_attribute *, struct module_kobject *,
  49. const char *, size_t count);
  50. void (*setup)(struct module *, const char *);
  51. int (*test)(struct module *);
  52. void (*free)(struct module *);
  53. };
  54. struct module_version_attribute {
  55. struct module_attribute mattr;
  56. const char *module_name;
  57. const char *version;
  58. } __attribute__ ((__aligned__(sizeof(void *))));
  59. extern ssize_t __modver_version_show(struct module_attribute *,
  60. struct module_kobject *, char *);
  61. extern struct module_attribute module_uevent;
  62. /* These are either module local, or the kernel's dummy ones. */
  63. extern int init_module(void);
  64. extern void cleanup_module(void);
  65. #ifndef MODULE
  66. /**
  67. * module_init() - driver initialization entry point
  68. * @x: function to be run at kernel boot time or module insertion
  69. *
  70. * module_init() will either be called during do_initcalls() (if
  71. * builtin) or at module insertion time (if a module). There can only
  72. * be one per module.
  73. */
  74. #define module_init(x) __initcall(x);
  75. /**
  76. * module_exit() - driver exit entry point
  77. * @x: function to be run when driver is removed
  78. *
  79. * module_exit() will wrap the driver clean-up code
  80. * with cleanup_module() when used with rmmod when
  81. * the driver is a module. If the driver is statically
  82. * compiled into the kernel, module_exit() has no effect.
  83. * There can only be one per module.
  84. */
  85. #define module_exit(x) __exitcall(x);
  86. #else /* MODULE */
  87. /*
  88. * In most cases loadable modules do not need custom
  89. * initcall levels. There are still some valid cases where
  90. * a driver may be needed early if built in, and does not
  91. * matter when built as a loadable module. Like bus
  92. * snooping debug drivers.
  93. */
  94. #define early_initcall(fn) module_init(fn)
  95. #define core_initcall(fn) module_init(fn)
  96. #define core_initcall_sync(fn) module_init(fn)
  97. #define postcore_initcall(fn) module_init(fn)
  98. #define postcore_initcall_sync(fn) module_init(fn)
  99. #define arch_initcall(fn) module_init(fn)
  100. #define subsys_initcall(fn) module_init(fn)
  101. #define subsys_initcall_sync(fn) module_init(fn)
  102. #define fs_initcall(fn) module_init(fn)
  103. #define fs_initcall_sync(fn) module_init(fn)
  104. #define rootfs_initcall(fn) module_init(fn)
  105. #define device_initcall(fn) module_init(fn)
  106. #define device_initcall_sync(fn) module_init(fn)
  107. #define late_initcall(fn) module_init(fn)
  108. #define late_initcall_sync(fn) module_init(fn)
  109. #define console_initcall(fn) module_init(fn)
  110. /* Each module must use one module_init(). */
  111. #define module_init(initfn) \
  112. static inline initcall_t __maybe_unused __inittest(void) \
  113. { return initfn; } \
  114. int init_module(void) __attribute__((alias(#initfn)));
  115. /* This is only required if you want to be unloadable. */
  116. #define module_exit(exitfn) \
  117. static inline exitcall_t __maybe_unused __exittest(void) \
  118. { return exitfn; } \
  119. void cleanup_module(void) __attribute__((alias(#exitfn)));
  120. #endif
  121. /* This means "can be init if no module support, otherwise module load
  122. may call it." */
  123. #ifdef CONFIG_MODULES
  124. #define __init_or_module
  125. #define __initdata_or_module
  126. #define __initconst_or_module
  127. #define __INIT_OR_MODULE .text
  128. #define __INITDATA_OR_MODULE .data
  129. #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
  130. #else
  131. #define __init_or_module __init
  132. #define __initdata_or_module __initdata
  133. #define __initconst_or_module __initconst
  134. #define __INIT_OR_MODULE __INIT
  135. #define __INITDATA_OR_MODULE __INITDATA
  136. #define __INITRODATA_OR_MODULE __INITRODATA
  137. #endif /*CONFIG_MODULES*/
  138. /* Generic info of form tag = "info" */
  139. #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
  140. /* For userspace: you can also call me... */
  141. #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
  142. /* Soft module dependencies. See man modprobe.d for details.
  143. * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
  144. */
  145. #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
  146. /*
  147. * The following license idents are currently accepted as indicating free
  148. * software modules
  149. *
  150. * "GPL" [GNU Public License v2 or later]
  151. * "GPL v2" [GNU Public License v2]
  152. * "GPL and additional rights" [GNU Public License v2 rights and more]
  153. * "Dual BSD/GPL" [GNU Public License v2
  154. * or BSD license choice]
  155. * "Dual MIT/GPL" [GNU Public License v2
  156. * or MIT license choice]
  157. * "Dual MPL/GPL" [GNU Public License v2
  158. * or Mozilla license choice]
  159. *
  160. * The following other idents are available
  161. *
  162. * "Proprietary" [Non free products]
  163. *
  164. * There are dual licensed components, but when running with Linux it is the
  165. * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
  166. * is a GPL combined work.
  167. *
  168. * This exists for several reasons
  169. * 1. So modinfo can show license info for users wanting to vet their setup
  170. * is free
  171. * 2. So the community can ignore bug reports including proprietary modules
  172. * 3. So vendors can do likewise based on their own policies
  173. */
  174. #define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
  175. /*
  176. * Author(s), use "Name <email>" or just "Name", for multiple
  177. * authors use multiple MODULE_AUTHOR() statements/lines.
  178. */
  179. #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
  180. /* What your module does. */
  181. #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
  182. #ifdef MODULE
  183. /* Creates an alias so file2alias.c can find device table. */
  184. #define MODULE_DEVICE_TABLE(type, name) \
  185. extern typeof(name) __mod_##type##__##name##_device_table \
  186. __attribute__ ((unused, alias(__stringify(name))))
  187. #else /* !MODULE */
  188. #define MODULE_DEVICE_TABLE(type, name)
  189. #endif
  190. /* Version of form [<epoch>:]<version>[-<extra-version>].
  191. * Or for CVS/RCS ID version, everything but the number is stripped.
  192. * <epoch>: A (small) unsigned integer which allows you to start versions
  193. * anew. If not mentioned, it's zero. eg. "2:1.0" is after
  194. * "1:2.0".
  195. * <version>: The <version> may contain only alphanumerics and the
  196. * character `.'. Ordered by numeric sort for numeric parts,
  197. * ascii sort for ascii parts (as per RPM or DEB algorithm).
  198. * <extraversion>: Like <version>, but inserted for local
  199. * customizations, eg "rh3" or "rusty1".
  200. * Using this automatically adds a checksum of the .c files and the
  201. * local headers in "srcversion".
  202. */
  203. #if defined(MODULE) || !defined(CONFIG_SYSFS)
  204. #define MODULE_VERSION(_version) MODULE_INFO(version, _version)
  205. #else
  206. #define MODULE_VERSION(_version) \
  207. static struct module_version_attribute ___modver_attr = { \
  208. .mattr = { \
  209. .attr = { \
  210. .name = "version", \
  211. .mode = S_IRUGO, \
  212. }, \
  213. .show = __modver_version_show, \
  214. }, \
  215. .module_name = KBUILD_MODNAME, \
  216. .version = _version, \
  217. }; \
  218. static const struct module_version_attribute \
  219. __used __attribute__ ((__section__ ("__modver"))) \
  220. * __moduleparam_const __modver_attr = &___modver_attr
  221. #endif
  222. /* Optional firmware file (or files) needed by the module
  223. * format is simply firmware file name. Multiple firmware
  224. * files require multiple MODULE_FIRMWARE() specifiers */
  225. #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
  226. struct notifier_block;
  227. #ifdef CONFIG_MODULES
  228. extern int modules_disabled; /* for sysctl */
  229. /* Get/put a kernel symbol (calls must be symmetric) */
  230. void *__symbol_get(const char *symbol);
  231. void *__symbol_get_gpl(const char *symbol);
  232. #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x))))
  233. /* modules using other modules: kdb wants to see this. */
  234. struct module_use {
  235. struct list_head source_list;
  236. struct list_head target_list;
  237. struct module *source, *target;
  238. };
  239. enum module_state {
  240. MODULE_STATE_LIVE, /* Normal state. */
  241. MODULE_STATE_COMING, /* Full formed, running module_init. */
  242. MODULE_STATE_GOING, /* Going away. */
  243. MODULE_STATE_UNFORMED, /* Still setting it up. */
  244. };
  245. struct mod_tree_node {
  246. struct module *mod;
  247. struct latch_tree_node node;
  248. };
  249. struct module_layout {
  250. /* The actual code + data. */
  251. void *base;
  252. /* Total size. */
  253. unsigned int size;
  254. /* The size of the executable code. */
  255. unsigned int text_size;
  256. /* Size of RO section of the module (text+rodata) */
  257. unsigned int ro_size;
  258. /* Size of RO after init section */
  259. unsigned int ro_after_init_size;
  260. #ifdef CONFIG_MODULES_TREE_LOOKUP
  261. struct mod_tree_node mtn;
  262. #endif
  263. };
  264. #ifdef CONFIG_MODULES_TREE_LOOKUP
  265. /* Only touch one cacheline for common rbtree-for-core-layout case. */
  266. #define __module_layout_align ____cacheline_aligned
  267. #else
  268. #define __module_layout_align
  269. #endif
  270. struct mod_kallsyms {
  271. Elf_Sym *symtab;
  272. unsigned int num_symtab;
  273. char *strtab;
  274. };
  275. #ifdef CONFIG_LIVEPATCH
  276. struct klp_modinfo {
  277. Elf_Ehdr hdr;
  278. Elf_Shdr *sechdrs;
  279. char *secstrings;
  280. unsigned int symndx;
  281. };
  282. #endif
  283. struct module {
  284. enum module_state state;
  285. /* Member of list of modules */
  286. struct list_head list;
  287. /* Unique handle for this module */
  288. char name[MODULE_NAME_LEN];
  289. /* Sysfs stuff. */
  290. struct module_kobject mkobj;
  291. struct module_attribute *modinfo_attrs;
  292. const char *version;
  293. const char *srcversion;
  294. struct kobject *holders_dir;
  295. /* Exported symbols */
  296. const struct kernel_symbol *syms;
  297. const s32 *crcs;
  298. unsigned int num_syms;
  299. /* Kernel parameters. */
  300. #ifdef CONFIG_SYSFS
  301. struct mutex param_lock;
  302. #endif
  303. struct kernel_param *kp;
  304. unsigned int num_kp;
  305. /* GPL-only exported symbols. */
  306. unsigned int num_gpl_syms;
  307. const struct kernel_symbol *gpl_syms;
  308. const s32 *gpl_crcs;
  309. #ifdef CONFIG_UNUSED_SYMBOLS
  310. /* unused exported symbols. */
  311. const struct kernel_symbol *unused_syms;
  312. const s32 *unused_crcs;
  313. unsigned int num_unused_syms;
  314. /* GPL-only, unused exported symbols. */
  315. unsigned int num_unused_gpl_syms;
  316. const struct kernel_symbol *unused_gpl_syms;
  317. const s32 *unused_gpl_crcs;
  318. #endif
  319. #ifdef CONFIG_MODULE_SIG
  320. /* Signature was verified. */
  321. bool sig_ok;
  322. #endif
  323. bool async_probe_requested;
  324. /* symbols that will be GPL-only in the near future. */
  325. const struct kernel_symbol *gpl_future_syms;
  326. const s32 *gpl_future_crcs;
  327. unsigned int num_gpl_future_syms;
  328. /* Exception table */
  329. unsigned int num_exentries;
  330. struct exception_table_entry *extable;
  331. /* Startup function. */
  332. int (*init)(void);
  333. /* Core layout: rbtree is accessed frequently, so keep together. */
  334. struct module_layout core_layout __module_layout_align;
  335. struct module_layout init_layout;
  336. /* Arch-specific module values */
  337. struct mod_arch_specific arch;
  338. unsigned long taints; /* same bits as kernel:taint_flags */
  339. #ifdef CONFIG_GENERIC_BUG
  340. /* Support for BUG */
  341. unsigned num_bugs;
  342. struct list_head bug_list;
  343. struct bug_entry *bug_table;
  344. #endif
  345. #ifdef CONFIG_KALLSYMS
  346. /* Protected by RCU and/or module_mutex: use rcu_dereference() */
  347. struct mod_kallsyms *kallsyms;
  348. struct mod_kallsyms core_kallsyms;
  349. /* Section attributes */
  350. struct module_sect_attrs *sect_attrs;
  351. /* Notes attributes */
  352. struct module_notes_attrs *notes_attrs;
  353. #endif
  354. /* The command line arguments (may be mangled). People like
  355. keeping pointers to this stuff */
  356. char *args;
  357. #ifdef CONFIG_SMP
  358. /* Per-cpu data. */
  359. void __percpu *percpu;
  360. unsigned int percpu_size;
  361. #endif
  362. #ifdef CONFIG_TRACEPOINTS
  363. unsigned int num_tracepoints;
  364. tracepoint_ptr_t *tracepoints_ptrs;
  365. #endif
  366. #ifdef CONFIG_BPF_EVENTS
  367. unsigned int num_bpf_raw_events;
  368. struct bpf_raw_event_map *bpf_raw_events;
  369. #endif
  370. #ifdef CONFIG_JUMP_LABEL
  371. struct jump_entry *jump_entries;
  372. unsigned int num_jump_entries;
  373. #endif
  374. #ifdef CONFIG_TRACING
  375. unsigned int num_trace_bprintk_fmt;
  376. const char **trace_bprintk_fmt_start;
  377. #endif
  378. #ifdef CONFIG_EVENT_TRACING
  379. struct trace_event_call **trace_events;
  380. unsigned int num_trace_events;
  381. struct trace_eval_map **trace_evals;
  382. unsigned int num_trace_evals;
  383. #endif
  384. #ifdef CONFIG_FTRACE_MCOUNT_RECORD
  385. unsigned int num_ftrace_callsites;
  386. unsigned long *ftrace_callsites;
  387. #endif
  388. #ifdef CONFIG_LIVEPATCH
  389. bool klp; /* Is this a livepatch module? */
  390. bool klp_alive;
  391. /* Elf information */
  392. struct klp_modinfo *klp_info;
  393. #endif
  394. #ifdef CONFIG_MODULE_UNLOAD
  395. /* What modules depend on me? */
  396. struct list_head source_list;
  397. /* What modules do I depend on? */
  398. struct list_head target_list;
  399. /* Destruction function. */
  400. void (*exit)(void);
  401. atomic_t refcnt;
  402. #endif
  403. #ifdef CONFIG_CONSTRUCTORS
  404. /* Constructor functions. */
  405. ctor_fn_t *ctors;
  406. unsigned int num_ctors;
  407. #endif
  408. #ifdef CONFIG_FUNCTION_ERROR_INJECTION
  409. struct error_injection_entry *ei_funcs;
  410. unsigned int num_ei_funcs;
  411. #endif
  412. } ____cacheline_aligned __randomize_layout;
  413. #ifndef MODULE_ARCH_INIT
  414. #define MODULE_ARCH_INIT {}
  415. #endif
  416. #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE
  417. static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym)
  418. {
  419. return sym->st_value;
  420. }
  421. #endif
  422. extern struct mutex module_mutex;
  423. /* FIXME: It'd be nice to isolate modules during init, too, so they
  424. aren't used before they (may) fail. But presently too much code
  425. (IDE & SCSI) require entry into the module during init.*/
  426. static inline bool module_is_live(struct module *mod)
  427. {
  428. return mod->state != MODULE_STATE_GOING;
  429. }
  430. struct module *__module_text_address(unsigned long addr);
  431. struct module *__module_address(unsigned long addr);
  432. bool is_module_address(unsigned long addr);
  433. bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr);
  434. bool is_module_percpu_address(unsigned long addr);
  435. bool is_module_text_address(unsigned long addr);
  436. static inline bool within_module_core(unsigned long addr,
  437. const struct module *mod)
  438. {
  439. return (unsigned long)mod->core_layout.base <= addr &&
  440. addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
  441. }
  442. static inline bool within_module_init(unsigned long addr,
  443. const struct module *mod)
  444. {
  445. return (unsigned long)mod->init_layout.base <= addr &&
  446. addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
  447. }
  448. static inline bool within_module(unsigned long addr, const struct module *mod)
  449. {
  450. return within_module_init(addr, mod) || within_module_core(addr, mod);
  451. }
  452. /* Search for module by name: must hold module_mutex. */
  453. struct module *find_module(const char *name);
  454. struct symsearch {
  455. const struct kernel_symbol *start, *stop;
  456. const s32 *crcs;
  457. enum {
  458. NOT_GPL_ONLY,
  459. GPL_ONLY,
  460. WILL_BE_GPL_ONLY,
  461. } licence;
  462. bool unused;
  463. };
  464. /*
  465. * Search for an exported symbol by name.
  466. *
  467. * Must be called with module_mutex held or preemption disabled.
  468. */
  469. const struct kernel_symbol *find_symbol(const char *name,
  470. struct module **owner,
  471. const s32 **crc,
  472. bool gplok,
  473. bool warn);
  474. /*
  475. * Walk the exported symbol table
  476. *
  477. * Must be called with module_mutex held or preemption disabled.
  478. */
  479. bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
  480. struct module *owner,
  481. void *data), void *data);
  482. /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
  483. symnum out of range. */
  484. int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
  485. char *name, char *module_name, int *exported);
  486. /* Look for this name: can be of form module:name. */
  487. unsigned long module_kallsyms_lookup_name(const char *name);
  488. int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
  489. struct module *, unsigned long),
  490. void *data);
  491. extern void __noreturn __module_put_and_exit(struct module *mod,
  492. long code);
  493. #define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
  494. #ifdef CONFIG_MODULE_UNLOAD
  495. int module_refcount(struct module *mod);
  496. void __symbol_put(const char *symbol);
  497. #define symbol_put(x) __symbol_put(__stringify(x))
  498. void symbol_put_addr(void *addr);
  499. /* Sometimes we know we already have a refcount, and it's easier not
  500. to handle the error case (which only happens with rmmod --wait). */
  501. extern void __module_get(struct module *module);
  502. /* This is the Right Way to get a module: if it fails, it's being removed,
  503. * so pretend it's not there. */
  504. extern bool try_module_get(struct module *module);
  505. extern void module_put(struct module *module);
  506. #else /*!CONFIG_MODULE_UNLOAD*/
  507. static inline bool try_module_get(struct module *module)
  508. {
  509. return !module || module_is_live(module);
  510. }
  511. static inline void module_put(struct module *module)
  512. {
  513. }
  514. static inline void __module_get(struct module *module)
  515. {
  516. }
  517. #define symbol_put(x) do { } while (0)
  518. #define symbol_put_addr(p) do { } while (0)
  519. #endif /* CONFIG_MODULE_UNLOAD */
  520. int ref_module(struct module *a, struct module *b);
  521. /* This is a #define so the string doesn't get put in every .o file */
  522. #define module_name(mod) \
  523. ({ \
  524. struct module *__mod = (mod); \
  525. __mod ? __mod->name : "kernel"; \
  526. })
  527. /* Dereference module function descriptor */
  528. void *dereference_module_function_descriptor(struct module *mod, void *ptr);
  529. /* For kallsyms to ask for address resolution. namebuf should be at
  530. * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
  531. * found, otherwise NULL. */
  532. const char *module_address_lookup(unsigned long addr,
  533. unsigned long *symbolsize,
  534. unsigned long *offset,
  535. char **modname,
  536. char *namebuf);
  537. int lookup_module_symbol_name(unsigned long addr, char *symname);
  538. int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
  539. int register_module_notifier(struct notifier_block *nb);
  540. int unregister_module_notifier(struct notifier_block *nb);
  541. extern void print_modules(void);
  542. static inline bool module_requested_async_probing(struct module *module)
  543. {
  544. return module && module->async_probe_requested;
  545. }
  546. #ifdef CONFIG_LIVEPATCH
  547. static inline bool is_livepatch_module(struct module *mod)
  548. {
  549. return mod->klp;
  550. }
  551. #else /* !CONFIG_LIVEPATCH */
  552. static inline bool is_livepatch_module(struct module *mod)
  553. {
  554. return false;
  555. }
  556. #endif /* CONFIG_LIVEPATCH */
  557. bool is_module_sig_enforced(void);
  558. #else /* !CONFIG_MODULES... */
  559. static inline struct module *__module_address(unsigned long addr)
  560. {
  561. return NULL;
  562. }
  563. static inline struct module *__module_text_address(unsigned long addr)
  564. {
  565. return NULL;
  566. }
  567. static inline bool is_module_address(unsigned long addr)
  568. {
  569. return false;
  570. }
  571. static inline bool is_module_percpu_address(unsigned long addr)
  572. {
  573. return false;
  574. }
  575. static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr)
  576. {
  577. return false;
  578. }
  579. static inline bool is_module_text_address(unsigned long addr)
  580. {
  581. return false;
  582. }
  583. /* Get/put a kernel symbol (calls should be symmetric) */
  584. #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
  585. #define symbol_put(x) do { } while (0)
  586. #define symbol_put_addr(x) do { } while (0)
  587. static inline void __module_get(struct module *module)
  588. {
  589. }
  590. static inline bool try_module_get(struct module *module)
  591. {
  592. return true;
  593. }
  594. static inline void module_put(struct module *module)
  595. {
  596. }
  597. #define module_name(mod) "kernel"
  598. /* For kallsyms to ask for address resolution. NULL means not found. */
  599. static inline const char *module_address_lookup(unsigned long addr,
  600. unsigned long *symbolsize,
  601. unsigned long *offset,
  602. char **modname,
  603. char *namebuf)
  604. {
  605. return NULL;
  606. }
  607. static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
  608. {
  609. return -ERANGE;
  610. }
  611. static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
  612. {
  613. return -ERANGE;
  614. }
  615. static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
  616. char *type, char *name,
  617. char *module_name, int *exported)
  618. {
  619. return -ERANGE;
  620. }
  621. static inline unsigned long module_kallsyms_lookup_name(const char *name)
  622. {
  623. return 0;
  624. }
  625. static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
  626. struct module *,
  627. unsigned long),
  628. void *data)
  629. {
  630. return 0;
  631. }
  632. static inline int register_module_notifier(struct notifier_block *nb)
  633. {
  634. /* no events will happen anyway, so this can always succeed */
  635. return 0;
  636. }
  637. static inline int unregister_module_notifier(struct notifier_block *nb)
  638. {
  639. return 0;
  640. }
  641. #define module_put_and_exit(code) do_exit(code)
  642. static inline void print_modules(void)
  643. {
  644. }
  645. static inline bool module_requested_async_probing(struct module *module)
  646. {
  647. return false;
  648. }
  649. static inline bool is_module_sig_enforced(void)
  650. {
  651. return false;
  652. }
  653. /* Dereference module function descriptor */
  654. static inline
  655. void *dereference_module_function_descriptor(struct module *mod, void *ptr)
  656. {
  657. return ptr;
  658. }
  659. #endif /* CONFIG_MODULES */
  660. #ifdef CONFIG_SYSFS
  661. extern struct kset *module_kset;
  662. extern struct kobj_type module_ktype;
  663. extern int module_sysfs_initialized;
  664. #endif /* CONFIG_SYSFS */
  665. #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
  666. /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
  667. #define __MODULE_STRING(x) __stringify(x)
  668. #ifdef CONFIG_STRICT_MODULE_RWX
  669. extern void set_all_modules_text_rw(void);
  670. extern void set_all_modules_text_ro(void);
  671. extern void module_enable_ro(const struct module *mod, bool after_init);
  672. extern void module_disable_ro(const struct module *mod);
  673. #else
  674. static inline void set_all_modules_text_rw(void) { }
  675. static inline void set_all_modules_text_ro(void) { }
  676. static inline void module_enable_ro(const struct module *mod, bool after_init) { }
  677. static inline void module_disable_ro(const struct module *mod) { }
  678. #endif
  679. #ifdef CONFIG_GENERIC_BUG
  680. void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
  681. struct module *);
  682. void module_bug_cleanup(struct module *);
  683. #else /* !CONFIG_GENERIC_BUG */
  684. static inline void module_bug_finalize(const Elf_Ehdr *hdr,
  685. const Elf_Shdr *sechdrs,
  686. struct module *mod)
  687. {
  688. }
  689. static inline void module_bug_cleanup(struct module *mod) {}
  690. #endif /* CONFIG_GENERIC_BUG */
  691. #ifdef RETPOLINE
  692. extern bool retpoline_module_ok(bool has_retpoline);
  693. #else
  694. static inline bool retpoline_module_ok(bool has_retpoline)
  695. {
  696. return true;
  697. }
  698. #endif
  699. #ifdef CONFIG_MODULE_SIG
  700. static inline bool module_sig_ok(struct module *module)
  701. {
  702. return module->sig_ok;
  703. }
  704. #else /* !CONFIG_MODULE_SIG */
  705. static inline bool module_sig_ok(struct module *module)
  706. {
  707. return true;
  708. }
  709. #endif /* CONFIG_MODULE_SIG */
  710. #endif /* _LINUX_MODULE_H */