blob: f520a767c86ca7eb4e91a92d84f0c3f08c70e899 [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>
14#include <linux/elf.h>
15#include <linux/stringify.h>
16#include <linux/kobject.h>
17#include <linux/moduleparam.h>
Steven Rostedt (Red Hat)b2e285f2014-02-26 13:12:06 -050018#include <linux/jump_label.h>
Paul Gortmakerf5016932011-05-23 14:11:39 -040019#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Christoph Lametere1783a22010-01-05 15:34:50 +090021#include <linux/percpu.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <asm/module.h>
23
Rusty Russell106a4ee2012-09-26 10:09:40 +010024/* In stripped ARM and x86-64 modules, ~ is surprisingly rare. */
25#define MODULE_SIG_STRING "~Module signature appended~\n"
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* Not Yet Implemented */
28#define MODULE_SUPPORTED_DEVICE(name)
29
Rusty Russell730b69d2008-10-22 10:00:22 -050030#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Seunghun Leee865d062014-01-16 10:18:49 +103032struct modversion_info {
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 unsigned long crc;
34 char name[MODULE_NAME_LEN];
35};
36
37struct module;
38
Kay Sievers4befb022011-07-24 22:06:04 +093039struct module_kobject {
40 struct kobject kobj;
41 struct module *mod;
42 struct kobject *drivers_dir;
43 struct module_param_attrs *mp;
Li Zhong942e4432013-09-03 16:33:57 +093044 struct completion *kobj_completion;
Kay Sievers4befb022011-07-24 22:06:04 +093045};
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047struct module_attribute {
Kay Sievers4befb022011-07-24 22:06:04 +093048 struct attribute attr;
49 ssize_t (*show)(struct module_attribute *, struct module_kobject *,
50 char *);
51 ssize_t (*store)(struct module_attribute *, struct module_kobject *,
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 const char *, size_t count);
Matt Domschc988d2b2005-06-23 22:05:15 -070053 void (*setup)(struct module *, const char *);
54 int (*test)(struct module *);
55 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056};
57
Dmitry Torokhove94965e2010-12-15 14:00:19 -080058struct module_version_attribute {
59 struct module_attribute mattr;
60 const char *module_name;
61 const char *version;
Dmitry Torokhov98562ad2011-02-04 13:30:10 -080062} __attribute__ ((__aligned__(sizeof(void *))));
Dmitry Torokhove94965e2010-12-15 14:00:19 -080063
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080064extern ssize_t __modver_version_show(struct module_attribute *,
Kay Sievers4befb022011-07-24 22:06:04 +093065 struct module_kobject *, char *);
Dmitry Torokhov9b73a582011-02-07 16:02:27 -080066
Kay Sievers88bfa322011-07-24 22:06:04 +093067extern struct module_attribute module_uevent;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/* These are either module local, or the kernel's dummy ones. */
70extern int init_module(void);
71extern void cleanup_module(void);
72
73/* Archs provide a method of finding the correct exception table. */
74struct exception_table_entry;
75
76const struct exception_table_entry *
77search_extable(const struct exception_table_entry *first,
78 const struct exception_table_entry *last,
79 unsigned long value);
80void sort_extable(struct exception_table_entry *start,
81 struct exception_table_entry *finish);
82void sort_main_extable(void);
Rusty Russellad6561d2009-06-12 21:47:03 -060083void trim_init_extable(struct module *m);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Linus Torvalds1da177e2005-04-16 15:20:36 -070085/* Generic info of form tag = "info" */
86#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
87
88/* For userspace: you can also call me... */
89#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
90
Andreas Robinson7cb14ba2013-08-20 15:33:19 +093091/* Soft module dependencies. See man modprobe.d for details.
92 * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz")
93 */
94#define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep)
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/*
97 * The following license idents are currently accepted as indicating free
98 * software modules
99 *
100 * "GPL" [GNU Public License v2 or later]
101 * "GPL v2" [GNU Public License v2]
102 * "GPL and additional rights" [GNU Public License v2 rights and more]
103 * "Dual BSD/GPL" [GNU Public License v2
104 * or BSD license choice]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700105 * "Dual MIT/GPL" [GNU Public License v2
106 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * "Dual MPL/GPL" [GNU Public License v2
108 * or Mozilla license choice]
109 *
110 * The following other idents are available
111 *
112 * "Proprietary" [Non free products]
113 *
114 * There are dual licensed components, but when running with Linux it is the
115 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
116 * is a GPL combined work.
117 *
118 * This exists for several reasons
Seunghun Leee865d062014-01-16 10:18:49 +1030119 * 1. So modinfo can show license info for users wanting to vet their setup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 * is free
121 * 2. So the community can ignore bug reports including proprietary modules
122 * 3. So vendors can do likewise based on their own policies
123 */
124#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
125
Johannes Berg1d7015c2009-09-25 00:32:58 -0600126/*
127 * Author(s), use "Name <email>" or just "Name", for multiple
128 * authors use multiple MODULE_AUTHOR() statements/lines.
129 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
Seunghun Leee865d062014-01-16 10:18:49 +1030131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/* What your module does. */
133#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
134
Rusty Russellcff26a52014-02-03 11:15:13 +1030135#ifdef MODULE
136/* Creates an alias so file2alias.c can find device table. */
137#define MODULE_DEVICE_TABLE(type, name) \
138 extern const struct type##_device_id __mod_##type##__##name##_device_table \
139 __attribute__ ((unused, alias(__stringify(name))))
140#else /* !MODULE */
141#define MODULE_DEVICE_TABLE(type, name)
142#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
144/* Version of form [<epoch>:]<version>[-<extra-version>].
Seunghun Leee865d062014-01-16 10:18:49 +1030145 * Or for CVS/RCS ID version, everything but the number is stripped.
146 * <epoch>: A (small) unsigned integer which allows you to start versions
147 * anew. If not mentioned, it's zero. eg. "2:1.0" is after
148 * "1:2.0".
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
Seunghun Leee865d062014-01-16 10:18:49 +1030150 * <version>: The <version> may contain only alphanumerics and the
151 * character `.'. Ordered by numeric sort for numeric parts,
152 * ascii sort for ascii parts (as per RPM or DEB algorithm).
153
154 * <extraversion>: Like <version>, but inserted for local
155 * customizations, eg "rh3" or "rusty1".
156
157 * Using this automatically adds a checksum of the .c files and the
158 * local headers in "srcversion".
159 */
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800160
Rusty Russell3b90a5b2011-01-24 14:32:51 -0600161#if defined(MODULE) || !defined(CONFIG_SYSFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800163#else
164#define MODULE_VERSION(_version) \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800165 static struct module_version_attribute ___modver_attr = { \
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800166 .mattr = { \
167 .attr = { \
168 .name = "version", \
169 .mode = S_IRUGO, \
170 }, \
171 .show = __modver_version_show, \
172 }, \
173 .module_name = KBUILD_MODNAME, \
174 .version = _version, \
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800175 }; \
176 static const struct module_version_attribute \
177 __used __attribute__ ((__section__ ("__modver"))) \
178 * __moduleparam_const __modver_attr = &___modver_attr
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800179#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Jon Masters187afbe2006-08-28 17:08:21 -0500181/* Optional firmware file (or files) needed by the module
182 * format is simply firmware file name. Multiple firmware
183 * files require multiple MODULE_FIRMWARE() specifiers */
184#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/* Given an address, look for it in the exception tables */
187const struct exception_table_entry *search_exception_tables(unsigned long add);
188
189struct notifier_block;
190
191#ifdef CONFIG_MODULES
192
Dave Young5ed10912010-03-10 15:24:06 -0800193extern int modules_disabled; /* for sysctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194/* Get/put a kernel symbol (calls must be symmetric) */
195void *__symbol_get(const char *symbol);
196void *__symbol_get_gpl(const char *symbol);
Rusty Russellb92021b2013-03-15 15:04:17 +1030197#define symbol_get(x) ((typeof(&x))(__symbol_get(VMLINUX_SYMBOL_STR(x))))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Rusty Russellc8e21ce2010-06-05 11:17:35 -0600199/* modules using other modules: kdb wants to see this. */
200struct module_use {
201 struct list_head source_list;
202 struct list_head target_list;
203 struct module *source, *target;
204};
205
Rusty Russell0d21b0e2013-01-12 11:38:44 +1030206enum module_state {
207 MODULE_STATE_LIVE, /* Normal state. */
208 MODULE_STATE_COMING, /* Full formed, running module_init. */
209 MODULE_STATE_GOING, /* Going away. */
210 MODULE_STATE_UNFORMED, /* Still setting it up. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211};
212
Eric Dumazetbd77c042012-01-13 09:32:14 +1030213/**
214 * struct module_ref - per cpu module reference counts
215 * @incs: number of module get on this cpu
216 * @decs: number of module put on this cpu
217 *
218 * We force an alignment on 8 or 16 bytes, so that alloc_percpu()
219 * put @incs/@decs in same cache line, with no extra memory cost,
220 * since alloc_percpu() is fine grained.
221 */
222struct module_ref {
223 unsigned long incs;
224 unsigned long decs;
225} __attribute((aligned(2 * sizeof(unsigned long))));
226
Seunghun Leee865d062014-01-16 10:18:49 +1030227struct module {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 enum module_state state;
229
230 /* Member of list of modules */
231 struct list_head list;
232
233 /* Unique handle for this module */
234 char name[MODULE_NAME_LEN];
235
236 /* Sysfs stuff. */
237 struct module_kobject mkobj;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800238 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700239 const char *version;
240 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100241 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243 /* Exported symbols */
244 const struct kernel_symbol *syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 const unsigned long *crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500246 unsigned int num_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Rusty Russelle180a6b2009-03-31 13:05:29 -0600248 /* Kernel parameters. */
249 struct kernel_param *kp;
250 unsigned int num_kp;
251
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 /* GPL-only exported symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 unsigned int num_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500254 const struct kernel_symbol *gpl_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 const unsigned long *gpl_crcs;
256
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500257#ifdef CONFIG_UNUSED_SYMBOLS
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700258 /* unused exported symbols. */
259 const struct kernel_symbol *unused_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700260 const unsigned long *unused_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500261 unsigned int num_unused_syms;
262
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700263 /* GPL-only, unused exported symbols. */
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700264 unsigned int num_unused_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500265 const struct kernel_symbol *unused_gpl_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700266 const unsigned long *unused_gpl_crcs;
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500267#endif
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700268
Rusty Russell106a4ee2012-09-26 10:09:40 +0100269#ifdef CONFIG_MODULE_SIG
270 /* Signature was verified. */
271 bool sig_ok;
272#endif
273
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800274 /* symbols that will be GPL-only in the near future. */
275 const struct kernel_symbol *gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800276 const unsigned long *gpl_future_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500277 unsigned int num_gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 /* Exception table */
280 unsigned int num_exentries;
Rusty Russell5e458cc2008-10-22 10:00:13 -0500281 struct exception_table_entry *extable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283 /* Startup function. */
284 int (*init)(void);
285
286 /* If this is non-NULL, vfree after init() returns */
287 void *module_init;
288
289 /* Here is the actual code + data, vfree'd on unload. */
290 void *module_core;
291
292 /* Here are the sizes of the init and core sections */
Denys Vlasenko2f0f2a32008-07-22 19:24:27 -0500293 unsigned int init_size, core_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
295 /* The size of the executable code in each section. */
Denys Vlasenko2f0f2a32008-07-22 19:24:27 -0500296 unsigned int init_text_size, core_text_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
matthieu castet84e1c6b2010-11-16 22:35:16 +0100298 /* Size of RO sections of the module (text+rodata) */
299 unsigned int init_ro_size, core_ro_size;
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 /* Arch-specific module values */
302 struct mod_arch_specific arch;
303
Randy Dunlap2bc2d612006-10-02 02:17:02 -0700304 unsigned int taints; /* same bits as kernel:tainted */
305
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800306#ifdef CONFIG_GENERIC_BUG
307 /* Support for BUG */
Richard Kennedyaf540682008-07-22 19:24:26 -0500308 unsigned num_bugs;
Jeremy Fitzhardinge7664c5a2006-12-08 02:36:19 -0800309 struct list_head bug_list;
310 struct bug_entry *bug_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311#endif
312
313#ifdef CONFIG_KALLSYMS
Jan Beulich4a496222009-07-06 14:50:42 +0100314 /*
315 * We keep the symbol and string tables for kallsyms.
316 * The core_* fields below are temporary, loader-only (they
317 * could really be discarded after module init).
318 */
319 Elf_Sym *symtab, *core_symtab;
320 unsigned int num_symtab, core_num_syms;
Jan Beulich554bdfe2009-07-06 14:51:44 +0100321 char *strtab, *core_strtab;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323 /* Section attributes */
324 struct module_sect_attrs *sect_attrs;
Roland McGrath6d760132007-10-16 23:26:40 -0700325
326 /* Notes attributes */
327 struct module_notes_attrs *notes_attrs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328#endif
329
Richard Kennedya288bd62011-05-19 16:55:25 -0600330 /* The command line arguments (may be mangled). People like
331 keeping pointers to this stuff */
332 char *args;
333
Tejun Heo259354d2010-03-10 18:56:10 +0900334#ifdef CONFIG_SMP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 /* Per-cpu data. */
Tejun Heo259354d2010-03-10 18:56:10 +0900336 void __percpu *percpu;
337 unsigned int percpu_size;
338#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400340#ifdef CONFIG_TRACEPOINTS
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400341 unsigned int num_tracepoints;
Richard Kennedya288bd62011-05-19 16:55:25 -0600342 struct tracepoint * const *tracepoints_ptrs;
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400343#endif
Jason Baronbf5438fc2010-09-17 11:09:00 -0400344#ifdef HAVE_JUMP_LABEL
345 struct jump_entry *jump_entries;
346 unsigned int num_jump_entries;
347#endif
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100348#ifdef CONFIG_TRACING
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100349 unsigned int num_trace_bprintk_fmt;
Richard Kennedya288bd62011-05-19 16:55:25 -0600350 const char **trace_bprintk_fmt_start;
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100351#endif
Steven Rostedt6d723732009-04-10 14:53:50 -0400352#ifdef CONFIG_EVENT_TRACING
Steven Rostedte4a9ea52011-01-27 09:15:30 -0500353 struct ftrace_event_call **trace_events;
Steven Rostedt6d723732009-04-10 14:53:50 -0400354 unsigned int num_trace_events;
355#endif
Steven Rostedt93eb6772009-04-15 13:24:06 -0400356#ifdef CONFIG_FTRACE_MCOUNT_RECORD
Steven Rostedt93eb6772009-04-15 13:24:06 -0400357 unsigned int num_ftrace_callsites;
Richard Kennedya288bd62011-05-19 16:55:25 -0600358 unsigned long *ftrace_callsites;
Steven Rostedt93eb6772009-04-15 13:24:06 -0400359#endif
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100360
Richard Kennedyaf540682008-07-22 19:24:26 -0500361#ifdef CONFIG_MODULE_UNLOAD
362 /* What modules depend on me? */
Linus Torvalds2c02dfe2010-05-31 12:19:37 -0700363 struct list_head source_list;
364 /* What modules do I depend on? */
365 struct list_head target_list;
Richard Kennedyaf540682008-07-22 19:24:26 -0500366
Richard Kennedyaf540682008-07-22 19:24:26 -0500367 /* Destruction function. */
368 void (*exit)(void);
369
Eric Dumazetbd77c042012-01-13 09:32:14 +1030370 struct module_ref __percpu *refptr;
Richard Kennedyaf540682008-07-22 19:24:26 -0500371#endif
Peter Oberparleiterb99b87f2009-06-17 16:28:03 -0700372
373#ifdef CONFIG_CONSTRUCTORS
374 /* Constructor functions. */
375 ctor_fn_t *ctors;
376 unsigned int num_ctors;
377#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378};
Roman Zippele61a1c12007-05-09 02:35:15 -0700379#ifndef MODULE_ARCH_INIT
380#define MODULE_ARCH_INIT {}
381#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Tim Abbottc6b37802008-12-05 19:03:59 -0500383extern struct mutex module_mutex;
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/* FIXME: It'd be nice to isolate modules during init, too, so they
386 aren't used before they (may) fail. But presently too much code
387 (IDE & SCSI) require entry into the module during init.*/
388static inline int module_is_live(struct module *mod)
389{
390 return mod->state != MODULE_STATE_GOING;
391}
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393struct module *__module_text_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600394struct module *__module_address(unsigned long addr);
395bool is_module_address(unsigned long addr);
Tejun Heo10fad5e2010-03-10 18:57:54 +0900396bool is_module_percpu_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600397bool is_module_text_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
Sasha Levin93843b32013-01-21 17:17:39 +1030399static inline int within_module_core(unsigned long addr, const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800400{
401 return (unsigned long)mod->module_core <= addr &&
402 addr < (unsigned long)mod->module_core + mod->core_size;
403}
404
Sasha Levin93843b32013-01-21 17:17:39 +1030405static inline int within_module_init(unsigned long addr, const struct module *mod)
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800406{
407 return (unsigned long)mod->module_init <= addr &&
408 addr < (unsigned long)mod->module_init + mod->init_size;
409}
410
Tim Abbottc6b37802008-12-05 19:03:59 -0500411/* Search for module by name: must hold module_mutex. */
412struct module *find_module(const char *name);
413
414struct symsearch {
415 const struct kernel_symbol *start, *stop;
416 const unsigned long *crcs;
417 enum {
418 NOT_GPL_ONLY,
419 GPL_ONLY,
420 WILL_BE_GPL_ONLY,
421 } licence;
422 bool unused;
423};
424
425/* Search for an exported symbol by name. */
426const struct kernel_symbol *find_symbol(const char *name,
427 struct module **owner,
428 const unsigned long **crc,
429 bool gplok,
430 bool warn);
431
432/* Walk the exported symbol table */
Rusty Russellde4d8d52011-04-19 21:49:58 +0200433bool each_symbol_section(bool (*fn)(const struct symsearch *arr,
434 struct module *owner,
435 void *data), void *data);
Tim Abbottc6b37802008-12-05 19:03:59 -0500436
Alexey Dobriyanea078902007-05-08 00:28:39 -0700437/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 symnum out of range. */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700439int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
440 char *name, char *module_name, int *exported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/* Look for this name: can be of form module:name. */
443unsigned long module_kallsyms_lookup_name(const char *name);
444
Anders Kaseorg75a66612008-12-05 19:03:58 -0500445int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
446 struct module *, unsigned long),
447 void *data);
448
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449extern void __module_put_and_exit(struct module *mod, long code)
450 __attribute__((noreturn));
Joe Perches74e22fa2013-12-04 14:09:38 +1030451#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
453#ifdef CONFIG_MODULE_UNLOAD
Eric Dumazetbd77c042012-01-13 09:32:14 +1030454unsigned long module_refcount(struct module *mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455void __symbol_put(const char *symbol);
Rusty Russellb92021b2013-03-15 15:04:17 +1030456#define symbol_put(x) __symbol_put(VMLINUX_SYMBOL_STR(x))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457void symbol_put_addr(void *addr);
458
459/* Sometimes we know we already have a refcount, and it's easier not
460 to handle the error case (which only happens with rmmod --wait). */
Steven Rostedtd53799b2012-03-26 12:50:52 +1030461extern void __module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
Steven Rostedtd53799b2012-03-26 12:50:52 +1030463/* This is the Right Way to get a module: if it fails, it's being removed,
464 * so pretend it's not there. */
465extern bool try_module_get(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Al Virof6a57032006-10-18 01:47:25 -0400467extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468
469#else /*!CONFIG_MODULE_UNLOAD*/
470static inline int try_module_get(struct module *module)
471{
472 return !module || module_is_live(module);
473}
474static inline void module_put(struct module *module)
475{
476}
477static inline void __module_get(struct module *module)
478{
479}
Seunghun Leee865d062014-01-16 10:18:49 +1030480#define symbol_put(x) do { } while (0)
481#define symbol_put_addr(p) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483#endif /* CONFIG_MODULE_UNLOAD */
Anders Kaseorgdfd62d12010-11-24 15:21:10 -0600484int ref_module(struct module *a, struct module *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486/* This is a #define so the string doesn't get put in every .o file */
487#define module_name(mod) \
488({ \
489 struct module *__mod = (mod); \
490 __mod ? __mod->name : "kernel"; \
491})
492
Rusty Russell6dd06c92008-01-29 17:13:22 -0500493/* For kallsyms to ask for address resolution. namebuf should be at
494 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
495 * found, otherwise NULL. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800496const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500497 unsigned long *symbolsize,
498 unsigned long *offset,
499 char **modname,
500 char *namebuf);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700501int lookup_module_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700502int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
504/* For extable.c to search modules' exception tables. */
505const struct exception_table_entry *search_module_extables(unsigned long addr);
506
Seunghun Leee865d062014-01-16 10:18:49 +1030507int register_module_notifier(struct notifier_block *nb);
508int unregister_module_notifier(struct notifier_block *nb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
510extern void print_modules(void);
511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512#else /* !CONFIG_MODULES... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514/* Given an address, look for it in the exception tables. */
515static inline const struct exception_table_entry *
516search_module_extables(unsigned long addr)
517{
518 return NULL;
519}
520
Rusty Russelle6104992009-03-31 13:05:31 -0600521static inline struct module *__module_address(unsigned long addr)
522{
523 return NULL;
524}
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526static inline struct module *__module_text_address(unsigned long addr)
527{
528 return NULL;
529}
530
Rusty Russelle6104992009-03-31 13:05:31 -0600531static inline bool is_module_address(unsigned long addr)
Ingo Molnar4d435f92006-07-03 00:24:24 -0700532{
Rusty Russelle6104992009-03-31 13:05:31 -0600533 return false;
534}
535
Randy Dunlapd5e50da2010-03-31 11:33:42 +0900536static inline bool is_module_percpu_address(unsigned long addr)
537{
538 return false;
539}
540
Rusty Russelle6104992009-03-31 13:05:31 -0600541static inline bool is_module_text_address(unsigned long addr)
542{
543 return false;
Ingo Molnar4d435f92006-07-03 00:24:24 -0700544}
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546/* Get/put a kernel symbol (calls should be symmetric) */
547#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
Seunghun Leee865d062014-01-16 10:18:49 +1030548#define symbol_put(x) do { } while (0)
549#define symbol_put_addr(x) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
551static inline void __module_get(struct module *module)
552{
553}
554
555static inline int try_module_get(struct module *module)
556{
557 return 1;
558}
559
560static inline void module_put(struct module *module)
561{
562}
563
564#define module_name(mod) "kernel"
565
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566/* For kallsyms to ask for address resolution. NULL means not found. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800567static inline const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500568 unsigned long *symbolsize,
569 unsigned long *offset,
570 char **modname,
571 char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
573 return NULL;
574}
575
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700576static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
577{
578 return -ERANGE;
579}
580
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700581static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
582{
583 return -ERANGE;
584}
585
Alexey Dobriyanea078902007-05-08 00:28:39 -0700586static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
587 char *type, char *name,
588 char *module_name, int *exported)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700590 return -ERANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
593static inline unsigned long module_kallsyms_lookup_name(const char *name)
594{
595 return 0;
596}
597
Anders Kaseorg75a66612008-12-05 19:03:58 -0500598static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
599 struct module *,
600 unsigned long),
601 void *data)
602{
603 return 0;
604}
605
Seunghun Leee865d062014-01-16 10:18:49 +1030606static inline int register_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 /* no events will happen anyway, so this can always succeed */
609 return 0;
610}
611
Seunghun Leee865d062014-01-16 10:18:49 +1030612static inline int unregister_module_notifier(struct notifier_block *nb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
614 return 0;
615}
616
617#define module_put_and_exit(code) do_exit(code)
618
619static inline void print_modules(void)
620{
621}
Randy Dunlapef665c12007-02-13 15:19:06 -0800622#endif /* CONFIG_MODULES */
623
Randy Dunlapef665c12007-02-13 15:19:06 -0800624#ifdef CONFIG_SYSFS
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700625extern struct kset *module_kset;
626extern struct kobj_type module_ktype;
627extern int module_sysfs_initialized;
Randy Dunlapef665c12007-02-13 15:19:06 -0800628#endif /* CONFIG_SYSFS */
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
631
632/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634#define __MODULE_STRING(x) __stringify(x)
635
matthieu castet84e1c6b2010-11-16 22:35:16 +0100636#ifdef CONFIG_DEBUG_SET_MODULE_RONX
637extern void set_all_modules_text_rw(void);
638extern void set_all_modules_text_ro(void);
639#else
640static inline void set_all_modules_text_rw(void) { }
641static inline void set_all_modules_text_ro(void) { }
642#endif
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700643
644#ifdef CONFIG_GENERIC_BUG
Linus Torvalds53363772010-10-05 11:29:27 -0700645void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700646 struct module *);
647void module_bug_cleanup(struct module *);
648
649#else /* !CONFIG_GENERIC_BUG */
650
Linus Torvalds53363772010-10-05 11:29:27 -0700651static inline void module_bug_finalize(const Elf_Ehdr *hdr,
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700652 const Elf_Shdr *sechdrs,
653 struct module *mod)
654{
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700655}
656static inline void module_bug_cleanup(struct module *mod) {}
657#endif /* CONFIG_GENERIC_BUG */
658
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659#endif /* _LINUX_MODULE_H */