1
#ifndef _LINUX_MODULE_H
2
#define _LINUX_MODULE_H
4
* Dynamic loading of modules into the kernel.
6
* Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
7
* Rewritten again by Rusty Russell, 2002
9
#include <linux/config.h>
10
#include <linux/stddef.h>
11
//#include <linux/sched.h>
12
//#include <linux/spinlock.h>
13
//#include <linux/list.h>
14
//#include <linux/stat.h>
15
#include <linux/compiler.h>
16
//#include <linux/cache.h>
17
//#include <linux/kmod.h>
18
//#include <linux/elf.h>
19
//#include <linux/stringify.h>
20
//#include <linux/kobject.h>
21
//#include <linux/moduleparam.h>
22
//#include <asm/local.h>
24
#include <asm/module.h>
26
/* Not Yet Implemented */
27
#define MODULE_SUPPORTED_DEVICE(name)
29
/* v850 toolchain uses a `_' prefix for all user symbols */
30
#ifndef MODULE_SYMBOL_PREFIX
31
#define MODULE_SYMBOL_PREFIX ""
34
#define MODULE_NAME_LEN (64 - sizeof(unsigned long))
42
struct modversion_info
45
char name[MODULE_NAME_LEN];
48
/* These are either module local, or the kernel's dummy ones. */
49
extern int init_module(void);
50
extern void cleanup_module(void);
52
/* Archs provide a method of finding the correct exception table. */
53
struct exception_table_entry;
55
const struct exception_table_entry *
56
search_extable(const struct exception_table_entry *first,
57
const struct exception_table_entry *last,
59
void sort_extable(struct exception_table_entry *start,
60
struct exception_table_entry *finish);
61
void sort_main_extable(void);
64
#define ___module_cat(a,b) __mod_ ## a ## b
65
#define __module_cat(a,b) ___module_cat(a,b)
66
#define __MODULE_INFO(tag, name, info) \
67
static const char __module_cat(name,__LINE__)[] \
69
__attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
71
#define MODULE_GENERIC_TABLE(gtype,name) \
72
extern const struct gtype##_id __mod_##gtype##_table \
73
__attribute__ ((unused, alias(__stringify(name))))
75
extern struct module __this_module;
76
#define THIS_MODULE (&__this_module)
80
#define MODULE_GENERIC_TABLE(gtype,name)
81
#define __MODULE_INFO(tag, name, info)
82
#define THIS_MODULE ((struct module *)0)
85
/* Generic info of form tag = "info" */
86
#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
88
/* For userspace: you can also call me... */
89
#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
92
* The following license idents are currently accepted as indicating free
95
* "GPL" [GNU Public License v2 or later]
96
* "GPL v2" [GNU Public License v2]
97
* "GPL and additional rights" [GNU Public License v2 rights and more]
98
* "Dual BSD/GPL" [GNU Public License v2
99
* or BSD license choice]
100
* "Dual MPL/GPL" [GNU Public License v2
101
* or Mozilla license choice]
103
* The following other idents are available
105
* "Proprietary" [Non free products]
107
* There are dual licensed components, but when running with Linux it is the
108
* GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
109
* is a GPL combined work.
111
* This exists for several reasons
112
* 1. So modinfo can show license info for users wanting to vet their setup
114
* 2. So the community can ignore bug reports including proprietary modules
115
* 3. So vendors can do likewise based on their own policies
117
#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
119
/* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
120
#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
122
/* What your module does. */
123
#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
125
/* One for each parameter, describing how to use it. Some files do
126
multiple of these per line, so can't just use MODULE_INFO. */
127
#define MODULE_PARM_DESC(_parm, desc) \
128
__MODULE_INFO(parm, _parm, #_parm ":" desc)
130
#define MODULE_DEVICE_TABLE(type,name) \
131
MODULE_GENERIC_TABLE(type##_device,name)
133
/* Version of form [<epoch>:]<version>[-<extra-version>].
134
Or for CVS/RCS ID version, everything but the number is stripped.
135
<epoch>: A (small) unsigned integer which allows you to start versions
136
anew. If not mentioned, it's zero. eg. "2:1.0" is after
138
<version>: The <version> may contain only alphanumerics and the
139
character `.'. Ordered by numeric sort for numeric parts,
140
ascii sort for ascii parts (as per RPM or DEB algorithm).
141
<extraversion>: Like <version>, but inserted for local
142
customizations, eg "rh3" or "rusty1".
144
Using this automatically adds a checksum of the .c files and the
145
local headers to the end. Use MODULE_VERSION("") if you want just
146
this. Macro includes room for this.
6
Copyright (C) 2008 Marc Singer
148
#define MODULE_VERSION(_version) \
149
MODULE_INFO(version, _version "\0xxxxxxxxxxxxxxxxxxxxxxxx")
151
/* Given an address, look for it in the exception tables */
152
const struct exception_table_entry *search_exception_tables(unsigned long add);
154
struct notifier_block;
156
#ifdef CONFIG_MODULES
158
/* Get/put a kernel symbol (calls must be symmetric) */
159
void *__symbol_get(const char *symbol);
160
void *__symbol_get_gpl(const char *symbol);
161
#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
164
#ifdef CONFIG_MODVERSIONS
165
/* Mark the CRC weak since genksyms apparently decides not to
166
* generate a checksums for some symbols */
167
#define __CRC_SYMBOL(sym, sec) \
168
extern void *__crc_##sym __attribute__((weak)); \
169
static const unsigned long __kcrctab_##sym \
171
__attribute__((section("__kcrctab" sec), unused)) \
172
= (unsigned long) &__crc_##sym;
174
#define __CRC_SYMBOL(sym, sec)
177
/* For every exported symbol, place a struct in the __ksymtab section */
178
#define __EXPORT_SYMBOL(sym, sec) \
179
__CRC_SYMBOL(sym, sec) \
180
static const char __kstrtab_##sym[] \
181
__attribute__((section("__ksymtab_strings"))) \
182
= MODULE_SYMBOL_PREFIX #sym; \
183
static const struct kernel_symbol __ksymtab_##sym \
185
__attribute__((section("__ksymtab" sec), unused)) \
186
= { (unsigned long)&sym, __kstrtab_##sym }
188
#define EXPORT_SYMBOL(sym) \
189
__EXPORT_SYMBOL(sym, "")
191
#define EXPORT_SYMBOL_GPL(sym) \
192
__EXPORT_SYMBOL(sym, "_gpl")
196
/* We don't mangle the actual symbol anymore, so no need for
197
* special casing EXPORT_SYMBOL_NOVERS. FIXME: Deprecated */
198
#define EXPORT_SYMBOL_NOVERS(sym) EXPORT_SYMBOL(sym)
203
} ____cacheline_aligned;
213
struct module_attribute
215
struct attribute attr;
216
struct kernel_param *param;
219
struct module_kobject
221
/* Everyone should have one of these. */
224
/* We always have refcnt, we may have others from module_param(). */
225
unsigned int num_attributes;
226
struct module_attribute attr[0];
229
/* Similar stuff for section attributes. */
230
#define MODULE_SECT_NAME_LEN 32
231
struct module_sect_attr
233
struct attribute attr;
234
char name[MODULE_SECT_NAME_LEN];
235
unsigned long address;
238
struct module_sections
241
struct module_sect_attr attrs[0];
247
enum module_state state;
249
/* Member of list of modules */
250
struct list_head list;
252
/* Unique handle for this module */
253
char name[MODULE_NAME_LEN];
256
struct module_kobject *mkobj;
258
/* Exported symbols */
259
const struct kernel_symbol *syms;
260
unsigned int num_syms;
261
const unsigned long *crcs;
263
/* GPL-only exported symbols. */
264
const struct kernel_symbol *gpl_syms;
265
unsigned int num_gpl_syms;
266
const unsigned long *gpl_crcs;
268
/* Exception table */
269
unsigned int num_exentries;
270
const struct exception_table_entry *extable;
272
/* Startup function. */
275
/* If this is non-NULL, vfree after init() returns */
278
/* Here is the actual code + data, vfree'd on unload. */
281
/* Here are the sizes of the init and core sections */
282
unsigned long init_size, core_size;
284
/* The size of the executable code in each section. */
285
unsigned long init_text_size, core_text_size;
287
/* Arch-specific module values */
288
struct mod_arch_specific arch;
290
/* Am I unsafe to unload? */
293
/* Am I GPL-compatible */
296
#ifdef CONFIG_MODULE_UNLOAD
297
/* Reference counts */
298
struct module_ref ref[NR_CPUS];
300
/* What modules depend on me? */
301
struct list_head modules_which_use_me;
303
/* Who is waiting for us to be unloaded */
304
struct task_struct *waiter;
306
/* Destruction function. */
309
/* Fake kernel param for refcnt. */
310
struct kernel_param refcnt_param;
313
#ifdef CONFIG_KALLSYMS
314
/* We keep the symbol and string tables for kallsyms. */
316
unsigned long num_symtab;
319
/* Section attributes */
320
struct module_sections *sect_attrs;
326
/* The command line arguments (may be mangled). People like
327
keeping pointers to this stuff */
331
/* FIXME: It'd be nice to isolate modules during init, too, so they
332
aren't used before they (may) fail. But presently too much code
333
(IDE & SCSI) require entry into the module during init.*/
334
static inline int module_is_live(struct module *mod)
336
return mod->state != MODULE_STATE_GOING;
339
/* Is this address in a module? (second is with no locks, for oops) */
340
struct module *module_text_address(unsigned long addr);
341
struct module *__module_text_address(unsigned long addr);
343
/* Returns module and fills in value, defined and namebuf, or NULL if
344
symnum out of range. */
345
struct module *module_get_kallsym(unsigned int symnum,
346
unsigned long *value,
350
/* Look for this name: can be of form module:name. */
351
unsigned long module_kallsyms_lookup_name(const char *name);
353
int is_exported(const char *name, const struct module *mod);
355
extern void __module_put_and_exit(struct module *mod, long code)
356
__attribute__((noreturn));
357
#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
359
#ifdef CONFIG_MODULE_UNLOAD
360
unsigned int module_refcount(struct module *mod);
361
void __symbol_put(const char *symbol);
362
#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
363
void symbol_put_addr(void *addr);
365
/* Sometimes we know we already have a refcount, and it's easier not
366
to handle the error case (which only happens with rmmod --wait). */
367
static inline void __module_get(struct module *module)
370
BUG_ON(module_refcount(module) == 0);
371
local_inc(&module->ref[get_cpu()].count);
376
static inline int try_module_get(struct module *module)
381
unsigned int cpu = get_cpu();
382
if (likely(module_is_live(module)))
383
local_inc(&module->ref[cpu].count);
391
static inline void module_put(struct module *module)
394
unsigned int cpu = get_cpu();
395
local_dec(&module->ref[cpu].count);
396
/* Maybe they're waiting for us to drop reference? */
397
if (unlikely(!module_is_live(module)))
398
wake_up_process(module->waiter);
403
#else /*!CONFIG_MODULE_UNLOAD*/
404
static inline int try_module_get(struct module *module)
406
return !module || module_is_live(module);
408
static inline void module_put(struct module *module)
411
static inline void __module_get(struct module *module)
414
#define symbol_put(x) do { } while(0)
415
#define symbol_put_addr(p) do { } while(0)
417
#endif /* CONFIG_MODULE_UNLOAD */
419
/* This is a #define so the string doesn't get put in every .o file */
420
#define module_name(mod) \
422
struct module *__mod = (mod); \
423
__mod ? __mod->name : "kernel"; \
426
#define __unsafe(mod) \
428
if (mod && !(mod)->unsafe) { \
429
printk(KERN_WARNING \
430
"Module %s cannot be unloaded due to unsafe usage in" \
431
" %s:%u\n", (mod)->name, __FILE__, __LINE__); \
436
/* For kallsyms to ask for address resolution. NULL means not found. */
437
const char *module_address_lookup(unsigned long addr,
438
unsigned long *symbolsize,
439
unsigned long *offset,
442
/* For extable.c to search modules' exception tables. */
443
const struct exception_table_entry *search_module_extables(unsigned long addr);
445
int register_module_notifier(struct notifier_block * nb);
446
int unregister_module_notifier(struct notifier_block * nb);
448
extern void print_modules(void);
449
#else /* !CONFIG_MODULES... */
450
#define EXPORT_SYMBOL(sym)
451
#define EXPORT_SYMBOL_GPL(sym)
452
#define EXPORT_SYMBOL_NOVERS(sym)
454
/* Given an address, look for it in the exception tables. */
455
static inline const struct exception_table_entry *
456
search_module_extables(unsigned long addr)
461
/* Is this address in a module? */
462
static inline struct module *module_text_address(unsigned long addr)
467
/* Is this address in a module? (don't take a lock, we're oopsing) */
468
static inline struct module *__module_text_address(unsigned long addr)
473
/* Get/put a kernel symbol (calls should be symmetric) */
474
#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
475
#define symbol_put(x) do { } while(0)
476
#define symbol_put_addr(x) do { } while(0)
478
static inline void __module_get(struct module *module)
482
static inline int try_module_get(struct module *module)
487
static inline void module_put(struct module *module)
491
#define module_name(mod) "kernel"
493
#define __unsafe(mod)
495
/* For kallsyms to ask for address resolution. NULL means not found. */
496
static inline const char *module_address_lookup(unsigned long addr,
497
unsigned long *symbolsize,
498
unsigned long *offset,
504
static inline struct module *module_get_kallsym(unsigned int symnum,
505
unsigned long *value,
512
static inline unsigned long module_kallsyms_lookup_name(const char *name)
517
static inline int is_exported(const char *name, const struct module *mod)
522
static inline int register_module_notifier(struct notifier_block * nb)
524
/* no events will happen anyway, so this can always succeed */
528
static inline int unregister_module_notifier(struct notifier_block * nb)
533
#define module_put_and_exit(code) do_exit(code)
535
static inline void print_modules(void)
538
#endif /* CONFIG_MODULES */
540
#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
542
/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
544
struct obsolete_modparm {
546
char type[64-sizeof(void *)];
550
/* DEPRECATED: Do not use. */
551
#define MODULE_PARM(var,type) \
552
struct obsolete_modparm __parm_##var __attribute__((section("__obsparm"))) = \
553
{ __stringify(var), type };
555
static inline void __deprecated MOD_INC_USE_COUNT(struct module *module)
559
#if defined(CONFIG_MODULE_UNLOAD) && defined(MODULE)
560
local_inc(&module->ref[get_cpu()].count);
563
(void)try_module_get(module);
567
static inline void __deprecated MOD_DEC_USE_COUNT(struct module *module)
572
#define MOD_INC_USE_COUNT MOD_INC_USE_COUNT(THIS_MODULE)
573
#define MOD_DEC_USE_COUNT MOD_DEC_USE_COUNT(THIS_MODULE)
575
#define MODULE_PARM(var,type)
576
#define MOD_INC_USE_COUNT do { } while (0)
577
#define MOD_DEC_USE_COUNT do { } while (0)
580
#define __MODULE_STRING(x) __stringify(x)
582
/* Use symbol_get and symbol_put instead. You'll thank me. */
583
#define HAVE_INTER_MODULE
584
extern void inter_module_register(const char *, struct module *, const void *);
585
extern void inter_module_unregister(const char *);
586
extern const void *inter_module_get(const char *);
587
extern const void *inter_module_get_request(const char *, const char *);
588
extern void inter_module_put(const char *);
590
#endif /* _LINUX_MODULE_H */
14
#if !defined (__MODULE_H__)
23
/* ----- Prototypes */
25
#define EXPORT_SYMBOL(a)
28
#endif /* __MODULE_H__ */
added
removed
include/linux/module.h
