blob: 3daf2b3a09d29b934a865be849dab354bd00dde0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_MODULE_H
2#define _LINUX_MODULE_H
3/*
4 * Dynamic loading of modules into the kernel.
5 *
6 * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
7 * Rewritten again by Rusty Russell, 2002
8 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#include <linux/list.h>
10#include <linux/stat.h>
11#include <linux/compiler.h>
12#include <linux/cache.h>
13#include <linux/kmod.h>
Paul Gortmaker0fd972a2015-05-01 20:13:42 -040014#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/elf.h>
16#include <linux/stringify.h>
17#include <linux/kobject.h>
18#include <linux/moduleparam.h>
Steven Rostedt (Red Hat)b2e285f2014-02-26 13:12:06 -050019#include <linux/jump_label.h>
Paul Gortmakerf5016932011-05-23 14:11:39 -040020#include <linux/export.h>
Peter Zijlstra93c2e102015-05-27 11:09:37 +093021#include <linux/rbtree_latch.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Christoph Lametere1783a22010-01-05 15:34:50 +090023#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <asm/module.h>
25
Rusty Russell106a4ee2012-09-26 10:09:40 +010026/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
27#define MODULE_SIG_STRING "~Module signature appended~\n"
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029/* Not Yet Implemented */
30#define MODULE_SUPPORTED_DEVICE(name)
31
Rusty Russell730b69d2008-10-22 10:00:22 -050032#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Seunghun Leee865d062014-01-16 10:18:49 +103034struct modversion_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 unsigned long crc;
36 char name[MODULE_NAME_LEN];
37};
38
39struct module;
40
Kay Sievers4befb022011-07-24 22:06:04 +093041struct module_kobject {
42 struct kobject kobj;
43 struct module *mod;
44 struct kobject *drivers_dir;
45 struct module_param_attrs *mp;
Li Zhong942e4432013-09-03 16:33:57 +093046 struct completion *kobj_completion;
Kay Sievers4befb022011-07-24 22:06:04 +093047};
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049struct module_attribute {
Kay Sievers4befb022011-07-24 22:06:04 +093050 struct attribute attr;
51 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
52 char *);
53 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 const char *, size_t count);
Matt Domschc988d2b2005-06-23 22:05:15 -070055 void (*setup)(struct module *, const char *);
56 int (*test)(struct module *);
57 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
Dmitry Torokhove94965e2010-12-15 14:00:19 -080060struct module_version_attribute {
61 struct module_attribute mattr;
62 const char *module_name;
63 const char *version;
Dmitry Torokhov98562ad2011-02-04 13:30:10 -080064} __attribute__ ((__aligned__(sizeof(void *))));
Dmitry Torokhove94965e2010-12-15 14:00:19 -080065
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080066extern ssize_t __modver_version_show(struct module_attribute *,
Kay Sievers4befb022011-07-24 22:06:04 +093067 struct module_kobject *, char *);
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080068
Kay Sievers88bfa322011-07-24 22:06:04 +093069extern struct module_attribute module_uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71/* These are either module local, or the kernel's dummy ones. */
72extern int init_module(void);
73extern void cleanup_module(void);
74
Paul Gortmaker0fd972a2015-05-01 20:13:42 -040075#ifndef MODULE
76/**
77 * module_init() - driver initialization entry point
78 * @x: function to be run at kernel boot time or module insertion
79 *
80 * module_init() will either be called during do_initcalls() (if
81 * builtin) or at module insertion time (if a module). There can only
82 * be one per module.
83 */
84#define module_init(x) __initcall(x);
85
86/**
87 * module_exit() - driver exit entry point
88 * @x: function to be run when driver is removed
89 *
90 * module_exit() will wrap the driver clean-up code
91 * with cleanup_module() when used with rmmod when
92 * the driver is a module. If the driver is statically
93 * compiled into the kernel, module_exit() has no effect.
94 * There can only be one per module.
95 */
96#define module_exit(x) __exitcall(x);
97
98#else /* MODULE */
99
100/*
101 * In most cases loadable modules do not need custom
102 * initcall levels. There are still some valid cases where
103 * a driver may be needed early if built in, and does not
104 * matter when built as a loadable module. Like bus
105 * snooping debug drivers.
106 */
107#define early_initcall(fn) module_init(fn)
108#define core_initcall(fn) module_init(fn)
109#define core_initcall_sync(fn) module_init(fn)
110#define postcore_initcall(fn) module_init(fn)
111#define postcore_initcall_sync(fn) module_init(fn)
112#define arch_initcall(fn) module_init(fn)
113#define subsys_initcall(fn) module_init(fn)
114#define subsys_initcall_sync(fn) module_init(fn)
115#define fs_initcall(fn) module_init(fn)
116#define fs_initcall_sync(fn) module_init(fn)
117#define rootfs_initcall(fn) module_init(fn)
118#define device_initcall(fn) module_init(fn)
119#define device_initcall_sync(fn) module_init(fn)
120#define late_initcall(fn) module_init(fn)
121#define late_initcall_sync(fn) module_init(fn)
122
123#define console_initcall(fn) module_init(fn)
124#define security_initcall(fn) module_init(fn)
125
126/* Each module must use one module_init(). */
127#define module_init(initfn) \
128 static inline initcall_t __inittest(void) \
129 { return initfn; } \
130 int init_module(void) __attribute__((alias(#initfn)));
131
132/* This is only required if you want to be unloadable. */
133#define module_exit(exitfn) \
134 static inline exitcall_t __exittest(void) \
135 { return exitfn; } \
136 void cleanup_module(void) __attribute__((alias(#exitfn)));
137
138#endif
139
140/* This means "can be init if no module support, otherwise module load
141 may call it." */
142#ifdef CONFIG_MODULES
143#define __init_or_module
144#define __initdata_or_module
145#define __initconst_or_module
146#define __INIT_OR_MODULE .text
147#define __INITDATA_OR_MODULE .data
148#define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits
149#else
150#define __init_or_module __init
151#define __initdata_or_module __initdata
152#define __initconst_or_module __initconst
153#define __INIT_OR_MODULE __INIT
154#define __INITDATA_OR_MODULE __INITDATA
155#define __INITRODATA_OR_MODULE __INITRODATA
156#endif /*CONFIG_MODULES*/
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/* Archs provide a method of finding the correct exception table. */
159struct exception_table_entry;
160
161const struct exception_table_entry *
162search_extable(const struct exception_table_entry *first,
163 const struct exception_table_entry *last,
164 unsigned long value);
165void sort_extable(struct exception_table_entry *start,
166 struct exception_table_entry *finish);
167void sort_main_extable(void);
Rusty Russellad6561d2009-06-12 21:47:03 -0600168void trim_init_extable(struct module *m);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170/* Generic info of form tag = "info" */
171#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
172
173/* For userspace: you can also call me... */
174#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
175
Andreas Robinson7cb14ba2013-08-20 15:33:19 +0930176/* Soft module dependencies. See man modprobe.d for details.
177 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
178 */
179#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/*
182 * The following license idents are currently accepted as indicating free
183 * software modules
184 *
185 * "GPL" [GNU Public License v2 or later]
186 * "GPL v2" [GNU Public License v2]
187 * "GPL and additional rights" [GNU Public License v2 rights and more]
188 * "Dual BSD/GPL" [GNU Public License v2
189 * or BSD license choice]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700190 * "Dual MIT/GPL" [GNU Public License v2
191 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * "Dual MPL/GPL" [GNU Public License v2
193 * or Mozilla license choice]
194 *
195 * The following other idents are available
196 *
197 * "Proprietary" [Non free products]
198 *
199 * There are dual licensed components, but when running with Linux it is the
200 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
201 * is a GPL combined work.
202 *
203 * This exists for several reasons
Seunghun Leee865d062014-01-16 10:18:49 +1030204 * 1. So modinfo can show license info for users wanting to vet their setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * is free
206 * 2. So the community can ignore bug reports including proprietary modules
207 * 3. So vendors can do likewise based on their own policies
208 */
209#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
210
Johannes Berg1d7015c2009-09-25 00:32:58 -0600211/*
212 * Author(s), use "Name <email>" or just "Name", for multiple
213 * authors use multiple MODULE_AUTHOR() statements/lines.
214 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
Seunghun Leee865d062014-01-16 10:18:49 +1030216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217/* What your module does. */
218#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
219
Rusty Russellcff26a52014-02-03 11:15:13 +1030220#ifdef MODULE
221/* Creates an alias so file2alias.c can find device table. */
222#define MODULE_DEVICE_TABLE(type, name) \
Andrey Ryabinin63019392015-02-13 14:40:13 -0800223extern const typeof(name) __mod_##type##__##name##_device_table \
Rusty Russellcff26a52014-02-03 11:15:13 +1030224 __attribute__ ((unused, alias(__stringify(name))))
225#else /* !MODULE */
226#define MODULE_DEVICE_TABLE(type, name)
227#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229/* Version of form [<epoch>:]<version>[-<extra-version>].
Seunghun Leee865d062014-01-16 10:18:49 +1030230 * Or for CVS/RCS ID version, everything but the number is stripped.
231 * <epoch>: A (small) unsigned integer which allows you to start versions
232 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
233 * "1:2.0".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Seunghun Leee865d062014-01-16 10:18:49 +1030235 * <version>: The <version> may contain only alphanumerics and the
236 * character `.'. Ordered by numeric sort for numeric parts,
237 * ascii sort for ascii parts (as per RPM or DEB algorithm).
238
239 * <extraversion>: Like <version>, but inserted for local
240 * customizations, eg "rh3" or "rusty1".
241
242 * Using this automatically adds a checksum of the .c files and the
243 * local headers in "srcversion".
244 */
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800245
Rusty Russell3b90a5b2011-01-24 14:32:51 -0600246#if defined(MODULE) || !defined(CONFIG_SYSFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800248#else
249#define MODULE_VERSION(_version) \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800250 static struct module_version_attribute ___modver_attr = { \
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800251 .mattr = { \
252 .attr = { \
253 .name = "version", \
254 .mode = S_IRUGO, \
255 }, \
256 .show = __modver_version_show, \
257 }, \
258 .module_name = KBUILD_MODNAME, \
259 .version = _version, \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800260 }; \
261 static const struct module_version_attribute \
262 __used __attribute__ ((__section__ ("__modver"))) \
263 * __moduleparam_const __modver_attr = &___modver_attr
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800264#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Jon Masters187afbe2006-08-28 17:08:21 -0500266/* Optional firmware file (or files) needed by the module
267 * format is simply firmware file name. Multiple firmware
268 * files require multiple MODULE_FIRMWARE() specifiers */
269#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
270
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271/* Given an address, look for it in the exception tables */
272const struct exception_table_entry *search_exception_tables(unsigned long add);
273
274struct notifier_block;
275
276#ifdef CONFIG_MODULES
277
Dave Young5ed10912010-03-10 15:24:06 -0800278extern int modules_disabled; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279/* Get/put a kernel symbol (calls must be symmetric) */
280void *__symbol_get(const char *symbol);
281void *__symbol_get_gpl(const char *symbol);
Rusty Russellb92021b2013-03-15 15:04:17 +1030282#define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
Rusty Russellc8e21ce2010-06-05 11:17:35 -0600284/* modules using other modules: kdb wants to see this. */
285struct module_use {
286 struct list_head source_list;
287 struct list_head target_list;
288 struct module *source, *target;
289};
290
Rusty Russell0d21b0e2013-01-12 11:38:44 +1030291enum module_state {
292 MODULE_STATE_LIVE, /* Normal state. */
293 MODULE_STATE_COMING, /* Full formed, running module_init. */
294 MODULE_STATE_GOING, /* Going away. */
295 MODULE_STATE_UNFORMED, /* Still setting it up. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296};
297
Peter Zijlstra93c2e102015-05-27 11:09:37 +0930298struct module;
299
300struct mod_tree_node {
301 struct module *mod;
302 struct latch_tree_node node;
303};
304
Rusty Russell7523e4d2015-11-26 09:44:08 +1030305struct module_layout {
306 /* The actual code + data. */
307 void *base;
308 /* Total size. */
309 unsigned int size;
310 /* The size of the executable code. */
311 unsigned int text_size;
312 /* Size of RO section of the module (text+rodata) */
313 unsigned int ro_size;
314
315#ifdef CONFIG_MODULES_TREE_LOOKUP
316 struct mod_tree_node mtn;
317#endif
318};
319
320#ifdef CONFIG_MODULES_TREE_LOOKUP
321/* Only touch one cacheline for common rbtree-for-core-layout case. */
322#define __module_layout_align ____cacheline_aligned
323#else
324#define __module_layout_align
325#endif
326
Rusty Russell82440622016-02-03 16:55:26 +1030327struct mod_kallsyms {
328 Elf_Sym *symtab;
329 unsigned int num_symtab;
330 char *strtab;
331};
332
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400333#ifdef CONFIG_LIVEPATCH
334struct klp_modinfo {
335 Elf_Ehdr hdr;
336 Elf_Shdr *sechdrs;
337 char *secstrings;
338 unsigned int symndx;
339};
340#endif
341
Seunghun Leee865d062014-01-16 10:18:49 +1030342struct module {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 enum module_state state;
344
345 /* Member of list of modules */
346 struct list_head list;
347
348 /* Unique handle for this module */
349 char name[MODULE_NAME_LEN];
350
351 /* Sysfs stuff. */
352 struct module_kobject mkobj;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800353 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700354 const char *version;
355 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100356 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358 /* Exported symbols */
359 const struct kernel_symbol *syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 const unsigned long *crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500361 unsigned int num_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
Rusty Russelle180a6b2009-03-31 13:05:29 -0600363 /* Kernel parameters. */
Rusty Russellcf2fde72015-06-26 06:44:38 +0930364#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930365 struct mutex param_lock;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930366#endif
Rusty Russelle180a6b2009-03-31 13:05:29 -0600367 struct kernel_param *kp;
368 unsigned int num_kp;
369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 /* GPL-only exported symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 unsigned int num_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500372 const struct kernel_symbol *gpl_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 const unsigned long *gpl_crcs;
374
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500375#ifdef CONFIG_UNUSED_SYMBOLS
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700376 /* unused exported symbols. */
377 const struct kernel_symbol *unused_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700378 const unsigned long *unused_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500379 unsigned int num_unused_syms;
380
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700381 /* GPL-only, unused exported symbols. */
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700382 unsigned int num_unused_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500383 const struct kernel_symbol *unused_gpl_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700384 const unsigned long *unused_gpl_crcs;
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500385#endif
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700386
Rusty Russell106a4ee2012-09-26 10:09:40 +0100387#ifdef CONFIG_MODULE_SIG
388 /* Signature was verified. */
389 bool sig_ok;
390#endif
391
Luis R. Rodriguezf2411da2015-03-30 16:20:05 -0700392 bool async_probe_requested;
393
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800394 /* symbols that will be GPL-only in the near future. */
395 const struct kernel_symbol *gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800396 const unsigned long *gpl_future_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500397 unsigned int num_gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /* Exception table */
400 unsigned int num_exentries;
Rusty Russell5e458cc2008-10-22 10:00:13 -0500401 struct exception_table_entry *extable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403 /* Startup function. */
404 int (*init)(void);
405
Rusty Russell7523e4d2015-11-26 09:44:08 +1030406 /* Core layout: rbtree is accessed frequently, so keep together. */
407 struct module_layout core_layout __module_layout_align;
408 struct module_layout init_layout;
matthieu castet84e1c6b2010-11-16 22:35:16 +0100409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 /* Arch-specific module values */
411 struct mod_arch_specific arch;
412
Randy Dunlap2bc2d612006-10-02 02:17:02 -0700413 unsigned int taints; /* same bits as kernel:tainted */
414
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800415#ifdef CONFIG_GENERIC_BUG
416 /* Support for BUG */
Richard Kennedyaf540682008-07-22 19:24:26 -0500417 unsigned num_bugs;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800418 struct list_head bug_list;
419 struct bug_entry *bug_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#endif
421
422#ifdef CONFIG_KALLSYMS
Rusty Russell82440622016-02-03 16:55:26 +1030423 /* Protected by RCU and/or module_mutex: use rcu_dereference() */
424 struct mod_kallsyms *kallsyms;
425 struct mod_kallsyms core_kallsyms;
426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 /* Section attributes */
428 struct module_sect_attrs *sect_attrs;
Roland McGrath6d760132007-10-16 23:26:40 -0700429
430 /* Notes attributes */
431 struct module_notes_attrs *notes_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432#endif
433
Richard Kennedya288bd62011-05-19 16:55:25 -0600434 /* The command line arguments (may be mangled). People like
435 keeping pointers to this stuff */
436 char *args;
437
Tejun Heo259354d2010-03-10 18:56:10 +0900438#ifdef CONFIG_SMP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 /* Per-cpu data. */
Tejun Heo259354d2010-03-10 18:56:10 +0900440 void __percpu *percpu;
441 unsigned int percpu_size;
442#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400444#ifdef CONFIG_TRACEPOINTS
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400445 unsigned int num_tracepoints;
Richard Kennedya288bd62011-05-19 16:55:25 -0600446 struct tracepoint * const *tracepoints_ptrs;
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400447#endif
Jason Baronbf5438fc2010-09-17 11:09:00 -0400448#ifdef HAVE_JUMP_LABEL
449 struct jump_entry *jump_entries;
450 unsigned int num_jump_entries;
451#endif
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100452#ifdef CONFIG_TRACING
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100453 unsigned int num_trace_bprintk_fmt;
Richard Kennedya288bd62011-05-19 16:55:25 -0600454 const char **trace_bprintk_fmt_start;
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100455#endif
Steven Rostedt6d723732009-04-10 14:53:50 -0400456#ifdef CONFIG_EVENT_TRACING
Steven Rostedt (Red Hat)2425bcb2015-05-05 11:45:27 -0400457 struct trace_event_call **trace_events;
Steven Rostedt6d723732009-04-10 14:53:50 -0400458 unsigned int num_trace_events;
Steven Rostedt (Red Hat)3673b8e2015-03-25 15:44:21 -0400459 struct trace_enum_map **trace_enums;
460 unsigned int num_trace_enums;
Steven Rostedt6d723732009-04-10 14:53:50 -0400461#endif
Steven Rostedt93eb6772009-04-15 13:24:06 -0400462#ifdef CONFIG_FTRACE_MCOUNT_RECORD
Steven Rostedt93eb6772009-04-15 13:24:06 -0400463 unsigned int num_ftrace_callsites;
Richard Kennedya288bd62011-05-19 16:55:25 -0600464 unsigned long *ftrace_callsites;
Steven Rostedt93eb6772009-04-15 13:24:06 -0400465#endif
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100466
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100467#ifdef CONFIG_LIVEPATCH
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400468 bool klp; /* Is this a livepatch module? */
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100469 bool klp_alive;
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400470
471 /* Elf information */
472 struct klp_modinfo *klp_info;
Petr Mladek8cb2c2d2015-03-12 12:55:13 +0100473#endif
474
Richard Kennedyaf540682008-07-22 19:24:26 -0500475#ifdef CONFIG_MODULE_UNLOAD
476 /* What modules depend on me? */
Linus Torvalds2c02dfe2010-05-31 12:19:37 -0700477 struct list_head source_list;
478 /* What modules do I depend on? */
479 struct list_head target_list;
Richard Kennedyaf540682008-07-22 19:24:26 -0500480
Richard Kennedyaf540682008-07-22 19:24:26 -0500481 /* Destruction function. */
482 void (*exit)(void);
483
Masami Hiramatsu2f35c412014-11-10 09:29:29 +1030484 atomic_t refcnt;
Richard Kennedyaf540682008-07-22 19:24:26 -0500485#endif
Peter Oberparleiterb99b87f2009-06-17 16:28:03 -0700486
487#ifdef CONFIG_CONSTRUCTORS
488 /* Constructor functions. */
489 ctor_fn_t *ctors;
490 unsigned int num_ctors;
491#endif
Peter Zijlstra93c2e102015-05-27 11:09:37 +0930492} ____cacheline_aligned;
Roman Zippele61a1c12007-05-09 02:35:15 -0700493#ifndef MODULE_ARCH_INIT
494#define MODULE_ARCH_INIT {}
495#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Tim Abbottc6b37802008-12-05 19:03:59 -0500497extern struct mutex module_mutex;
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499/* FIXME: It'd be nice to isolate modules during init, too, so they
500 aren't used before they (may) fail. But presently too much code
501 (IDE & SCSI) require entry into the module during init.*/
502static inline int module_is_live(struct module *mod)
503{
504 return mod->state != MODULE_STATE_GOING;
505}
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507struct module *__module_text_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600508struct module *__module_address(unsigned long addr);
509bool is_module_address(unsigned long addr);
Tejun Heo10fad5e2010-03-10 18:57:54 +0900510bool is_module_percpu_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600511bool is_module_text_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Petr Mladek76681c82014-07-27 07:25:01 +0930513static inline bool within_module_core(unsigned long addr,
514 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800515{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030516 return (unsigned long)mod->core_layout.base <= addr &&
517 addr < (unsigned long)mod->core_layout.base + mod->core_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800518}
519
Petr Mladek76681c82014-07-27 07:25:01 +0930520static inline bool within_module_init(unsigned long addr,
521 const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800522{
Rusty Russell7523e4d2015-11-26 09:44:08 +1030523 return (unsigned long)mod->init_layout.base <= addr &&
524 addr < (unsigned long)mod->init_layout.base + mod->init_layout.size;
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800525}
526
Petr Mladek76681c82014-07-27 07:25:01 +0930527static inline bool within_module(unsigned long addr, const struct module *mod)
Petr Mladek9b20a352014-07-27 07:24:01 +0930528{
529 return within_module_init(addr, mod) || within_module_core(addr, mod);
530}
531
Tim Abbottc6b37802008-12-05 19:03:59 -0500532/* Search for module by name: must hold module_mutex. */
533struct module *find_module(const char *name);
534
535struct symsearch {
536 const struct kernel_symbol *start, *stop;
537 const unsigned long *crcs;
538 enum {
539 NOT_GPL_ONLY,
540 GPL_ONLY,
541 WILL_BE_GPL_ONLY,
542 } licence;
543 bool unused;
544};
545
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930546/*
547 * Search for an exported symbol by name.
548 *
549 * Must be called with module_mutex held or preemption disabled.
550 */
Tim Abbottc6b37802008-12-05 19:03:59 -0500551const struct kernel_symbol *find_symbol(const char *name,
552 struct module **owner,
553 const unsigned long **crc,
554 bool gplok,
555 bool warn);
556
Peter Zijlstra0be964b2015-05-27 11:09:35 +0930557/*
558 * Walk the exported symbol table
559 *
560 * Must be called with module_mutex held or preemption disabled.
561 */
Rusty Russellde4d8d52011-04-19 21:49:58 +0200562bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
563 struct module *owner,
564 void *data), void *data);
Tim Abbottc6b37802008-12-05 19:03:59 -0500565
Alexey Dobriyanea078902007-05-08 00:28:39 -0700566/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 symnum out of range. */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700568int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
569 char *name, char *module_name, int *exported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571/* Look for this name: can be of form module:name. */
572unsigned long module_kallsyms_lookup_name(const char *name);
573
Anders Kaseorg75a66612008-12-05 19:03:58 -0500574int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
575 struct module *, unsigned long),
576 void *data);
577
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578extern void __module_put_and_exit(struct module *mod, long code)
579 __attribute__((noreturn));
Joe Perches74e22fa2013-12-04 14:09:38 +1030580#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581
582#ifdef CONFIG_MODULE_UNLOAD
Rusty Russelld5db1392015-01-22 11:13:14 +1030583int module_refcount(struct module *mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584void __symbol_put(const char *symbol);
Rusty Russellb92021b2013-03-15 15:04:17 +1030585#define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586void symbol_put_addr(void *addr);
587
588/* Sometimes we know we already have a refcount, and it's easier not
589 to handle the error case (which only happens with rmmod --wait). */
Steven Rostedtd53799b2012-03-26 12:50:52 +1030590extern void __module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Steven Rostedtd53799b2012-03-26 12:50:52 +1030592/* This is the Right Way to get a module: if it fails, it's being removed,
593 * so pretend it's not there. */
594extern bool try_module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Al Virof6a57032006-10-18 01:47:25 -0400596extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598#else /*!CONFIG_MODULE_UNLOAD*/
599static inline int try_module_get(struct module *module)
600{
601 return !module || module_is_live(module);
602}
603static inline void module_put(struct module *module)
604{
605}
606static inline void __module_get(struct module *module)
607{
608}
Seunghun Leee865d062014-01-16 10:18:49 +1030609#define symbol_put(x) do { } while (0)
610#define symbol_put_addr(p) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
612#endif /* CONFIG_MODULE_UNLOAD */
Anders Kaseorgdfd62d12010-11-24 15:21:10 -0600613int ref_module(struct module *a, struct module *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615/* This is a #define so the string doesn't get put in every .o file */
616#define module_name(mod) \
617({ \
618 struct module *__mod = (mod); \
619 __mod ? __mod->name : "kernel"; \
620})
621
Rusty Russell6dd06c92008-01-29 17:13:22 -0500622/* For kallsyms to ask for address resolution. namebuf should be at
623 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
624 * found, otherwise NULL. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800625const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500626 unsigned long *symbolsize,
627 unsigned long *offset,
628 char **modname,
629 char *namebuf);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700630int lookup_module_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700631int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633/* For extable.c to search modules' exception tables. */
634const struct exception_table_entry *search_module_extables(unsigned long addr);
635
Seunghun Leee865d062014-01-16 10:18:49 +1030636int register_module_notifier(struct notifier_block *nb);
637int unregister_module_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639extern void print_modules(void);
640
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700641static inline bool module_requested_async_probing(struct module *module)
642{
643 return module && module->async_probe_requested;
644}
645
Jessica Yu1ce15ef2016-03-22 20:03:16 -0400646#ifdef CONFIG_LIVEPATCH
647static inline bool is_livepatch_module(struct module *mod)
648{
649 return mod->klp;
650}
651#else /* !CONFIG_LIVEPATCH */
652static inline bool is_livepatch_module(struct module *mod)
653{
654 return false;
655}
656#endif /* CONFIG_LIVEPATCH */
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658#else /* !CONFIG_MODULES... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
660/* Given an address, look for it in the exception tables. */
661static inline const struct exception_table_entry *
662search_module_extables(unsigned long addr)
663{
664 return NULL;
665}
666
Rusty Russelle6104992009-03-31 13:05:31 -0600667static inline struct module *__module_address(unsigned long addr)
668{
669 return NULL;
670}
671
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672static inline struct module *__module_text_address(unsigned long addr)
673{
674 return NULL;
675}
676
Rusty Russelle6104992009-03-31 13:05:31 -0600677static inline bool is_module_address(unsigned long addr)
Ingo Molnar4d435f92006-07-03 00:24:24 -0700678{
Rusty Russelle6104992009-03-31 13:05:31 -0600679 return false;
680}
681
Randy Dunlapd5e50da2010-03-31 11:33:42 +0900682static inline bool is_module_percpu_address(unsigned long addr)
683{
684 return false;
685}
686
Rusty Russelle6104992009-03-31 13:05:31 -0600687static inline bool is_module_text_address(unsigned long addr)
688{
689 return false;
Ingo Molnar4d435f92006-07-03 00:24:24 -0700690}
691
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692/* Get/put a kernel symbol (calls should be symmetric) */
693#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
Seunghun Leee865d062014-01-16 10:18:49 +1030694#define symbol_put(x) do { } while (0)
695#define symbol_put_addr(x) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697static inline void __module_get(struct module *module)
698{
699}
700
701static inline int try_module_get(struct module *module)
702{
703 return 1;
704}
705
706static inline void module_put(struct module *module)
707{
708}
709
710#define module_name(mod) "kernel"
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712/* For kallsyms to ask for address resolution. NULL means not found. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800713static inline const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500714 unsigned long *symbolsize,
715 unsigned long *offset,
716 char **modname,
717 char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718{
719 return NULL;
720}
721
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700722static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
723{
724 return -ERANGE;
725}
726
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700727static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
728{
729 return -ERANGE;
730}
731
Alexey Dobriyanea078902007-05-08 00:28:39 -0700732static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
733 char *type, char *name,
734 char *module_name, int *exported)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700736 return -ERANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737}
738
739static inline unsigned long module_kallsyms_lookup_name(const char *name)
740{
741 return 0;
742}
743
Anders Kaseorg75a66612008-12-05 19:03:58 -0500744static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
745 struct module *,
746 unsigned long),
747 void *data)
748{
749 return 0;
750}
751
Seunghun Leee865d062014-01-16 10:18:49 +1030752static inline int register_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
754 /* no events will happen anyway, so this can always succeed */
755 return 0;
756}
757
Seunghun Leee865d062014-01-16 10:18:49 +1030758static inline int unregister_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759{
760 return 0;
761}
762
763#define module_put_and_exit(code) do_exit(code)
764
765static inline void print_modules(void)
766{
767}
Dmitry Torokhov80c6e142015-05-21 15:49:37 -0700768
769static inline bool module_requested_async_probing(struct module *module)
770{
771 return false;
772}
773
Randy Dunlapef665c12007-02-13 15:19:06 -0800774#endif /* CONFIG_MODULES */
775
Randy Dunlapef665c12007-02-13 15:19:06 -0800776#ifdef CONFIG_SYSFS
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700777extern struct kset *module_kset;
778extern struct kobj_type module_ktype;
779extern int module_sysfs_initialized;
Randy Dunlapef665c12007-02-13 15:19:06 -0800780#endif /* CONFIG_SYSFS */
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
783
784/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786#define __MODULE_STRING(x) __stringify(x)
787
matthieu castet84e1c6b2010-11-16 22:35:16 +0100788#ifdef CONFIG_DEBUG_SET_MODULE_RONX
789extern void set_all_modules_text_rw(void);
790extern void set_all_modules_text_ro(void);
Rusty Russell85c898d2015-11-26 09:45:08 +1030791extern void module_enable_ro(const struct module *mod);
792extern void module_disable_ro(const struct module *mod);
matthieu castet84e1c6b2010-11-16 22:35:16 +0100793#else
794static inline void set_all_modules_text_rw(void) { }
795static inline void set_all_modules_text_ro(void) { }
Rusty Russell85c898d2015-11-26 09:45:08 +1030796static inline void module_enable_ro(const struct module *mod) { }
797static inline void module_disable_ro(const struct module *mod) { }
matthieu castet84e1c6b2010-11-16 22:35:16 +0100798#endif
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700799
800#ifdef CONFIG_GENERIC_BUG
Linus Torvalds53363772010-10-05 11:29:27 -0700801void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700802 struct module *);
803void module_bug_cleanup(struct module *);
804
805#else /* !CONFIG_GENERIC_BUG */
806
Linus Torvalds53363772010-10-05 11:29:27 -0700807static inline void module_bug_finalize(const Elf_Ehdr *hdr,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700808 const Elf_Shdr *sechdrs,
809 struct module *mod)
810{
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700811}
812static inline void module_bug_cleanup(struct module *mod) {}
813#endif /* CONFIG_GENERIC_BUG */
814
Herbert Xu59afdc72015-04-22 11:28:46 +0800815#ifdef CONFIG_MODULE_SIG
816static inline bool module_sig_ok(struct module *module)
817{
818 return module->sig_ok;
819}
820#else /* !CONFIG_MODULE_SIG */
821static inline bool module_sig_ok(struct module *module)
822{
823 return true;
824}
825#endif /* CONFIG_MODULE_SIG */
826
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827#endif /* _LINUX_MODULE_H */