blob: 482efc865acf272994b4de7906a8d403a1c1454a [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>
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -040018#include <linux/tracepoint.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Li Zefan7ead8b82009-08-17 16:56:28 +080020#include <asm/local.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <asm/module.h>
22
Li Zefan7ead8b82009-08-17 16:56:28 +080023#include <trace/events/module.h>
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/* Not Yet Implemented */
26#define MODULE_SUPPORTED_DEVICE(name)
27
Adrian Bunkf606ddf2008-07-23 21:28:50 -070028/* some toolchains uses a `_' prefix for all user symbols */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#ifndef MODULE_SYMBOL_PREFIX
30#define MODULE_SYMBOL_PREFIX ""
31#endif
32
Rusty Russell730b69d2008-10-22 10:00:22 -050033#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35struct kernel_symbol
36{
37 unsigned long value;
38 const char *name;
39};
40
41struct modversion_info
42{
43 unsigned long crc;
44 char name[MODULE_NAME_LEN];
45};
46
47struct module;
48
49struct module_attribute {
50 struct attribute attr;
51 ssize_t (*show)(struct module_attribute *, struct module *, char *);
52 ssize_t (*store)(struct module_attribute *, struct module *,
53 const char *, size_t count);
Matt Domschc988d2b2005-06-23 22:05:15 -070054 void (*setup)(struct module *, const char *);
55 int (*test)(struct module *);
56 void (*free)(struct module *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070057};
58
59struct module_kobject
60{
61 struct kobject kobj;
62 struct module *mod;
Kay Sieversf30c53a2007-01-15 20:22:02 +010063 struct kobject *drivers_dir;
Rusty Russell9b473de2008-10-22 10:00:22 -050064 struct module_param_attrs *mp;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
66
67/* These are either module local, or the kernel's dummy ones. */
68extern int init_module(void);
69extern void cleanup_module(void);
70
71/* Archs provide a method of finding the correct exception table. */
72struct exception_table_entry;
73
74const struct exception_table_entry *
75search_extable(const struct exception_table_entry *first,
76 const struct exception_table_entry *last,
77 unsigned long value);
78void sort_extable(struct exception_table_entry *start,
79 struct exception_table_entry *finish);
80void sort_main_extable(void);
Rusty Russellad6561d2009-06-12 21:47:03 -060081void trim_init_extable(struct module *m);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#ifdef MODULE
84#define MODULE_GENERIC_TABLE(gtype,name) \
85extern const struct gtype##_id __mod_##gtype##_table \
86 __attribute__ ((unused, alias(__stringify(name))))
87
88extern struct module __this_module;
89#define THIS_MODULE (&__this_module)
90#else /* !MODULE */
91#define MODULE_GENERIC_TABLE(gtype,name)
92#define THIS_MODULE ((struct module *)0)
93#endif
94
95/* Generic info of form tag = "info" */
96#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
97
98/* For userspace: you can also call me... */
99#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
100
101/*
102 * The following license idents are currently accepted as indicating free
103 * software modules
104 *
105 * "GPL" [GNU Public License v2 or later]
106 * "GPL v2" [GNU Public License v2]
107 * "GPL and additional rights" [GNU Public License v2 rights and more]
108 * "Dual BSD/GPL" [GNU Public License v2
109 * or BSD license choice]
Xose Vazquez Perez8d27e902006-06-23 02:05:13 -0700110 * "Dual MIT/GPL" [GNU Public License v2
111 * or MIT license choice]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 * "Dual MPL/GPL" [GNU Public License v2
113 * or Mozilla license choice]
114 *
115 * The following other idents are available
116 *
117 * "Proprietary" [Non free products]
118 *
119 * There are dual licensed components, but when running with Linux it is the
120 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
121 * is a GPL combined work.
122 *
123 * This exists for several reasons
124 * 1. So modinfo can show license info for users wanting to vet their setup
125 * is free
126 * 2. So the community can ignore bug reports including proprietary modules
127 * 3. So vendors can do likewise based on their own policies
128 */
129#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
130
Johannes Berg1d7015c2009-09-25 00:32:58 -0600131/*
132 * Author(s), use "Name <email>" or just "Name", for multiple
133 * authors use multiple MODULE_AUTHOR() statements/lines.
134 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
136
137/* What your module does. */
138#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
139
140/* One for each parameter, describing how to use it. Some files do
141 multiple of these per line, so can't just use MODULE_INFO. */
142#define MODULE_PARM_DESC(_parm, desc) \
143 __MODULE_INFO(parm, _parm, #_parm ":" desc)
144
145#define MODULE_DEVICE_TABLE(type,name) \
146 MODULE_GENERIC_TABLE(type##_device,name)
147
148/* Version of form [<epoch>:]<version>[-<extra-version>].
149 Or for CVS/RCS ID version, everything but the number is stripped.
150 <epoch>: A (small) unsigned integer which allows you to start versions
151 anew. If not mentioned, it's zero. eg. "2:1.0" is after
152 "1:2.0".
153 <version>: The <version> may contain only alphanumerics and the
154 character `.'. Ordered by numeric sort for numeric parts,
155 ascii sort for ascii parts (as per RPM or DEB algorithm).
156 <extraversion>: Like <version>, but inserted for local
157 customizations, eg "rh3" or "rusty1".
158
159 Using this automatically adds a checksum of the .c files and the
160 local headers in "srcversion".
161*/
162#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
163
Jon Masters187afbe2006-08-28 17:08:21 -0500164/* Optional firmware file (or files) needed by the module
165 * format is simply firmware file name. Multiple firmware
166 * files require multiple MODULE_FIRMWARE() specifiers */
167#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169/* Given an address, look for it in the exception tables */
170const struct exception_table_entry *search_exception_tables(unsigned long add);
171
172struct notifier_block;
173
174#ifdef CONFIG_MODULES
175
176/* Get/put a kernel symbol (calls must be symmetric) */
177void *__symbol_get(const char *symbol);
178void *__symbol_get_gpl(const char *symbol);
179#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
180
181#ifndef __GENKSYMS__
182#ifdef CONFIG_MODVERSIONS
183/* Mark the CRC weak since genksyms apparently decides not to
184 * generate a checksums for some symbols */
185#define __CRC_SYMBOL(sym, sec) \
186 extern void *__crc_##sym __attribute__((weak)); \
187 static const unsigned long __kcrctab_##sym \
Adrian Bunk3ff6eec2008-01-24 22:16:20 +0100188 __used \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 __attribute__((section("__kcrctab" sec), unused)) \
190 = (unsigned long) &__crc_##sym;
191#else
192#define __CRC_SYMBOL(sym, sec)
193#endif
194
195/* For every exported symbol, place a struct in the __ksymtab section */
196#define __EXPORT_SYMBOL(sym, sec) \
Patrick McHardya1a8fee2006-03-23 22:07:34 -0800197 extern typeof(sym) sym; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 __CRC_SYMBOL(sym, sec) \
199 static const char __kstrtab_##sym[] \
Rusty Russellea01e792008-03-13 09:02:17 +0000200 __attribute__((section("__ksymtab_strings"), aligned(1))) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 = MODULE_SYMBOL_PREFIX #sym; \
202 static const struct kernel_symbol __ksymtab_##sym \
Adrian Bunk3ff6eec2008-01-24 22:16:20 +0100203 __used \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 __attribute__((section("__ksymtab" sec), unused)) \
205 = { (unsigned long)&sym, __kstrtab_##sym }
206
207#define EXPORT_SYMBOL(sym) \
208 __EXPORT_SYMBOL(sym, "")
209
210#define EXPORT_SYMBOL_GPL(sym) \
211 __EXPORT_SYMBOL(sym, "_gpl")
212
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800213#define EXPORT_SYMBOL_GPL_FUTURE(sym) \
214 __EXPORT_SYMBOL(sym, "_gpl_future")
215
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700216
217#ifdef CONFIG_UNUSED_SYMBOLS
218#define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
219#define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
220#else
221#define EXPORT_UNUSED_SYMBOL(sym)
222#define EXPORT_UNUSED_SYMBOL_GPL(sym)
223#endif
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225#endif
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227enum module_state
228{
229 MODULE_STATE_LIVE,
230 MODULE_STATE_COMING,
231 MODULE_STATE_GOING,
232};
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234struct module
235{
236 enum module_state state;
237
238 /* Member of list of modules */
239 struct list_head list;
240
241 /* Unique handle for this module */
242 char name[MODULE_NAME_LEN];
243
244 /* Sysfs stuff. */
245 struct module_kobject mkobj;
Greg Kroah-Hartman03e88ae12006-02-16 13:50:23 -0800246 struct module_attribute *modinfo_attrs;
Matt Domschc988d2b2005-06-23 22:05:15 -0700247 const char *version;
248 const char *srcversion;
Kay Sievers270a6c42007-01-18 13:26:15 +0100249 struct kobject *holders_dir;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251 /* Exported symbols */
252 const struct kernel_symbol *syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 const unsigned long *crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500254 unsigned int num_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Rusty Russelle180a6b2009-03-31 13:05:29 -0600256 /* Kernel parameters. */
257 struct kernel_param *kp;
258 unsigned int num_kp;
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 /* GPL-only exported symbols. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 unsigned int num_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500262 const struct kernel_symbol *gpl_syms;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 const unsigned long *gpl_crcs;
264
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500265#ifdef CONFIG_UNUSED_SYMBOLS
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700266 /* unused exported symbols. */
267 const struct kernel_symbol *unused_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700268 const unsigned long *unused_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500269 unsigned int num_unused_syms;
270
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700271 /* GPL-only, unused exported symbols. */
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700272 unsigned int num_unused_gpl_syms;
Richard Kennedyaf540682008-07-22 19:24:26 -0500273 const struct kernel_symbol *unused_gpl_syms;
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700274 const unsigned long *unused_gpl_crcs;
Denys Vlasenkof7f5b672008-07-22 19:24:26 -0500275#endif
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700276
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800277 /* symbols that will be GPL-only in the near future. */
278 const struct kernel_symbol *gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800279 const unsigned long *gpl_future_crcs;
Richard Kennedyaf540682008-07-22 19:24:26 -0500280 unsigned int num_gpl_future_syms;
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 /* Exception table */
283 unsigned int num_exentries;
Rusty Russell5e458cc2008-10-22 10:00:13 -0500284 struct exception_table_entry *extable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286 /* Startup function. */
287 int (*init)(void);
288
289 /* If this is non-NULL, vfree after init() returns */
290 void *module_init;
291
292 /* Here is the actual code + data, vfree'd on unload. */
293 void *module_core;
294
295 /* Here are the sizes of the init and core sections */
Denys Vlasenko2f0f2a32008-07-22 19:24:27 -0500296 unsigned int init_size, core_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 /* The size of the executable code in each section. */
Denys Vlasenko2f0f2a32008-07-22 19:24:27 -0500299 unsigned int init_text_size, core_text_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 /* 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
330 /* Per-cpu data. */
331 void *percpu;
332
333 /* The command line arguments (may be mangled). People like
334 keeping pointers to this stuff */
335 char *args;
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400336#ifdef CONFIG_TRACEPOINTS
337 struct tracepoint *tracepoints;
338 unsigned int num_tracepoints;
339#endif
Richard Kennedyaf540682008-07-22 19:24:26 -0500340
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100341#ifdef CONFIG_TRACING
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100342 const char **trace_bprintk_fmt_start;
343 unsigned int num_trace_bprintk_fmt;
344#endif
Steven Rostedt6d723732009-04-10 14:53:50 -0400345#ifdef CONFIG_EVENT_TRACING
346 struct ftrace_event_call *trace_events;
347 unsigned int num_trace_events;
348#endif
Steven Rostedt93eb6772009-04-15 13:24:06 -0400349#ifdef CONFIG_FTRACE_MCOUNT_RECORD
350 unsigned long *ftrace_callsites;
351 unsigned int num_ftrace_callsites;
352#endif
Lai Jiangshan1ba28e02009-03-06 17:21:48 +0100353
Richard Kennedyaf540682008-07-22 19:24:26 -0500354#ifdef CONFIG_MODULE_UNLOAD
355 /* What modules depend on me? */
356 struct list_head modules_which_use_me;
357
358 /* Who is waiting for us to be unloaded */
359 struct task_struct *waiter;
360
361 /* Destruction function. */
362 void (*exit)(void);
363
Eric Dumazet720eba32009-02-03 13:31:36 +1030364#ifdef CONFIG_SMP
365 char *refptr;
366#else
367 local_t ref;
368#endif
Richard Kennedyaf540682008-07-22 19:24:26 -0500369#endif
Peter Oberparleiterb99b87f2009-06-17 16:28:03 -0700370
371#ifdef CONFIG_CONSTRUCTORS
372 /* Constructor functions. */
373 ctor_fn_t *ctors;
374 unsigned int num_ctors;
375#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376};
Roman Zippele61a1c12007-05-09 02:35:15 -0700377#ifndef MODULE_ARCH_INIT
378#define MODULE_ARCH_INIT {}
379#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Tim Abbottc6b37802008-12-05 19:03:59 -0500381extern struct mutex module_mutex;
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383/* FIXME: It'd be nice to isolate modules during init, too, so they
384 aren't used before they (may) fail. But presently too much code
385 (IDE & SCSI) require entry into the module during init.*/
386static inline int module_is_live(struct module *mod)
387{
388 return mod->state != MODULE_STATE_GOING;
389}
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391struct module *__module_text_address(unsigned long addr);
Rusty Russelle6104992009-03-31 13:05:31 -0600392struct module *__module_address(unsigned long addr);
393bool is_module_address(unsigned long addr);
394bool is_module_text_address(unsigned long addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Masami Hiramatsua06f6212009-01-06 14:41:49 -0800396static inline int within_module_core(unsigned long addr, struct module *mod)
397{
398 return (unsigned long)mod->module_core <= addr &&
399 addr < (unsigned long)mod->module_core + mod->core_size;
400}
401
402static inline int within_module_init(unsigned long addr, struct module *mod)
403{
404 return (unsigned long)mod->module_init <= addr &&
405 addr < (unsigned long)mod->module_init + mod->init_size;
406}
407
Tim Abbottc6b37802008-12-05 19:03:59 -0500408/* Search for module by name: must hold module_mutex. */
409struct module *find_module(const char *name);
410
411struct symsearch {
412 const struct kernel_symbol *start, *stop;
413 const unsigned long *crcs;
414 enum {
415 NOT_GPL_ONLY,
416 GPL_ONLY,
417 WILL_BE_GPL_ONLY,
418 } licence;
419 bool unused;
420};
421
422/* Search for an exported symbol by name. */
423const struct kernel_symbol *find_symbol(const char *name,
424 struct module **owner,
425 const unsigned long **crc,
426 bool gplok,
427 bool warn);
428
429/* Walk the exported symbol table */
430bool each_symbol(bool (*fn)(const struct symsearch *arr, struct module *owner,
431 unsigned int symnum, void *data), void *data);
432
Alexey Dobriyanea078902007-05-08 00:28:39 -0700433/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 symnum out of range. */
Alexey Dobriyanea078902007-05-08 00:28:39 -0700435int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
436 char *name, char *module_name, int *exported);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438/* Look for this name: can be of form module:name. */
439unsigned long module_kallsyms_lookup_name(const char *name);
440
Anders Kaseorg75a66612008-12-05 19:03:58 -0500441int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
442 struct module *, unsigned long),
443 void *data);
444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445extern void __module_put_and_exit(struct module *mod, long code)
446 __attribute__((noreturn));
447#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
448
449#ifdef CONFIG_MODULE_UNLOAD
450unsigned int module_refcount(struct module *mod);
451void __symbol_put(const char *symbol);
452#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
453void symbol_put_addr(void *addr);
454
Eric Dumazet720eba32009-02-03 13:31:36 +1030455static inline local_t *__module_ref_addr(struct module *mod, int cpu)
456{
457#ifdef CONFIG_SMP
458 return (local_t *) (mod->refptr + per_cpu_offset(cpu));
459#else
460 return &mod->ref;
461#endif
462}
463
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464/* Sometimes we know we already have a refcount, and it's easier not
465 to handle the error case (which only happens with rmmod --wait). */
466static inline void __module_get(struct module *module)
467{
468 if (module) {
Li Zefan7ead8b82009-08-17 16:56:28 +0800469 unsigned int cpu = get_cpu();
470 local_inc(__module_ref_addr(module, cpu));
471 trace_module_get(module, _THIS_IP_,
472 local_read(__module_ref_addr(module, cpu)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 put_cpu();
474 }
475}
476
477static inline int try_module_get(struct module *module)
478{
479 int ret = 1;
480
481 if (module) {
482 unsigned int cpu = get_cpu();
Li Zefan7ead8b82009-08-17 16:56:28 +0800483 if (likely(module_is_live(module))) {
Eric Dumazet720eba32009-02-03 13:31:36 +1030484 local_inc(__module_ref_addr(module, cpu));
Li Zefan7ead8b82009-08-17 16:56:28 +0800485 trace_module_get(module, _THIS_IP_,
486 local_read(__module_ref_addr(module, cpu)));
487 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 else
489 ret = 0;
490 put_cpu();
491 }
492 return ret;
493}
494
Al Virof6a57032006-10-18 01:47:25 -0400495extern void module_put(struct module *module);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497#else /*!CONFIG_MODULE_UNLOAD*/
498static inline int try_module_get(struct module *module)
499{
500 return !module || module_is_live(module);
501}
502static inline void module_put(struct module *module)
503{
504}
505static inline void __module_get(struct module *module)
506{
507}
508#define symbol_put(x) do { } while(0)
509#define symbol_put_addr(p) do { } while(0)
510
511#endif /* CONFIG_MODULE_UNLOAD */
Tim Abbottc6b37802008-12-05 19:03:59 -0500512int use_module(struct module *a, struct module *b);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514/* This is a #define so the string doesn't get put in every .o file */
515#define module_name(mod) \
516({ \
517 struct module *__mod = (mod); \
518 __mod ? __mod->name : "kernel"; \
519})
520
Rusty Russell6dd06c92008-01-29 17:13:22 -0500521/* For kallsyms to ask for address resolution. namebuf should be at
522 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
523 * found, otherwise NULL. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800524const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500525 unsigned long *symbolsize,
526 unsigned long *offset,
527 char **modname,
528 char *namebuf);
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700529int lookup_module_symbol_name(unsigned long addr, char *symname);
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700530int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
532/* For extable.c to search modules' exception tables. */
533const struct exception_table_entry *search_module_extables(unsigned long addr);
534
535int register_module_notifier(struct notifier_block * nb);
536int unregister_module_notifier(struct notifier_block * nb);
537
538extern void print_modules(void);
539
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400540extern void module_update_tracepoints(void);
541extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543#else /* !CONFIG_MODULES... */
544#define EXPORT_SYMBOL(sym)
545#define EXPORT_SYMBOL_GPL(sym)
Greg Kroah-Hartman9f28bb72006-03-20 13:17:13 -0800546#define EXPORT_SYMBOL_GPL_FUTURE(sym)
Arjan van de Venf71d20e2006-06-28 04:26:45 -0700547#define EXPORT_UNUSED_SYMBOL(sym)
548#define EXPORT_UNUSED_SYMBOL_GPL(sym)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550/* Given an address, look for it in the exception tables. */
551static inline const struct exception_table_entry *
552search_module_extables(unsigned long addr)
553{
554 return NULL;
555}
556
Rusty Russelle6104992009-03-31 13:05:31 -0600557static inline struct module *__module_address(unsigned long addr)
558{
559 return NULL;
560}
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562static inline struct module *__module_text_address(unsigned long addr)
563{
564 return NULL;
565}
566
Rusty Russelle6104992009-03-31 13:05:31 -0600567static inline bool is_module_address(unsigned long addr)
Ingo Molnar4d435f92006-07-03 00:24:24 -0700568{
Rusty Russelle6104992009-03-31 13:05:31 -0600569 return false;
570}
571
572static inline bool is_module_text_address(unsigned long addr)
573{
574 return false;
Ingo Molnar4d435f92006-07-03 00:24:24 -0700575}
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/* Get/put a kernel symbol (calls should be symmetric) */
578#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
579#define symbol_put(x) do { } while(0)
580#define symbol_put_addr(x) do { } while(0)
581
582static inline void __module_get(struct module *module)
583{
584}
585
586static inline int try_module_get(struct module *module)
587{
588 return 1;
589}
590
591static inline void module_put(struct module *module)
592{
593}
594
595#define module_name(mod) "kernel"
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597/* For kallsyms to ask for address resolution. NULL means not found. */
Andrew Morton92dfc9d2008-02-08 04:18:43 -0800598static inline const char *module_address_lookup(unsigned long addr,
Rusty Russell6dd06c92008-01-29 17:13:22 -0500599 unsigned long *symbolsize,
600 unsigned long *offset,
601 char **modname,
602 char *namebuf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
604 return NULL;
605}
606
Alexey Dobriyan9d65cb42007-05-08 00:28:43 -0700607static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
608{
609 return -ERANGE;
610}
611
Alexey Dobriyana5c43da2007-05-08 00:28:47 -0700612static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
613{
614 return -ERANGE;
615}
616
Alexey Dobriyanea078902007-05-08 00:28:39 -0700617static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
618 char *type, char *name,
619 char *module_name, int *exported)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Alexey Dobriyanea078902007-05-08 00:28:39 -0700621 return -ERANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
623
624static inline unsigned long module_kallsyms_lookup_name(const char *name)
625{
626 return 0;
627}
628
Anders Kaseorg75a66612008-12-05 19:03:58 -0500629static inline int module_kallsyms_on_each_symbol(int (*fn)(void *, const char *,
630 struct module *,
631 unsigned long),
632 void *data)
633{
634 return 0;
635}
636
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637static inline int register_module_notifier(struct notifier_block * nb)
638{
639 /* no events will happen anyway, so this can always succeed */
640 return 0;
641}
642
643static inline int unregister_module_notifier(struct notifier_block * nb)
644{
645 return 0;
646}
647
648#define module_put_and_exit(code) do_exit(code)
649
650static inline void print_modules(void)
651{
652}
653
Mathieu Desnoyers97e1c182008-07-18 12:16:16 -0400654static inline void module_update_tracepoints(void)
655{
656}
657
658static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
659{
660 return 0;
661}
662
Randy Dunlapef665c12007-02-13 15:19:06 -0800663#endif /* CONFIG_MODULES */
664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665struct device_driver;
Randy Dunlapef665c12007-02-13 15:19:06 -0800666#ifdef CONFIG_SYSFS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667struct module;
668
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700669extern struct kset *module_kset;
670extern struct kobj_type module_ktype;
671extern int module_sysfs_initialized;
Randy Dunlapef665c12007-02-13 15:19:06 -0800672
673int mod_sysfs_init(struct module *mod);
674int mod_sysfs_setup(struct module *mod,
675 struct kernel_param *kparam,
676 unsigned int num_params);
677int module_add_modinfo_attrs(struct module *mod);
678void module_remove_modinfo_attrs(struct module *mod);
679
680#else /* !CONFIG_SYSFS */
681
682static inline int mod_sysfs_init(struct module *mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
Randy Dunlapef665c12007-02-13 15:19:06 -0800684 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685}
686
Randy Dunlapef665c12007-02-13 15:19:06 -0800687static inline int mod_sysfs_setup(struct module *mod,
688 struct kernel_param *kparam,
689 unsigned int num_params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690{
Randy Dunlapef665c12007-02-13 15:19:06 -0800691 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692}
693
Randy Dunlapef665c12007-02-13 15:19:06 -0800694static inline int module_add_modinfo_attrs(struct module *mod)
695{
696 return 0;
697}
698
699static inline void module_remove_modinfo_attrs(struct module *mod)
700{ }
701
702#endif /* CONFIG_SYSFS */
703
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
705
706/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708#define __MODULE_STRING(x) __stringify(x)
709
Andrew Morton0d9c25d2009-06-16 15:33:37 -0700710
711#ifdef CONFIG_GENERIC_BUG
712int module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *,
713 struct module *);
714void module_bug_cleanup(struct module *);
715
716#else /* !CONFIG_GENERIC_BUG */
717
718static inline int module_bug_finalize(const Elf_Ehdr *hdr,
719 const Elf_Shdr *sechdrs,
720 struct module *mod)
721{
722 return 0;
723}
724static inline void module_bug_cleanup(struct module *mod) {}
725#endif /* CONFIG_GENERIC_BUG */
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727#endif /* _LINUX_MODULE_H */