[deliverable/linux.git] / include / linux / module.h

#ifndef _LINUX_MODULE_H
#define _LINUX_MODULE_H
/*
 * Dynamic loading of modules into the kernel.
 *
 * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
 * Rewritten again by Rusty Russell, 2002
 */
#include <linux/list.h>
#include <linux/stat.h>
#include <linux/compiler.h>
#include <linux/cache.h>
#include <linux/kmod.h>
#include <linux/elf.h>
#include <linux/stringify.h>
#include <linux/kobject.h>
#include <linux/moduleparam.h>
#include <linux/marker.h>
#include <linux/tracepoint.h>
#include <asm/local.h>

#include <asm/module.h>

/* Not Yet Implemented */
#define MODULE_SUPPORTED_DEVICE(name)

/* some toolchains uses a `_' prefix for all user symbols */
#ifndef MODULE_SYMBOL_PREFIX
#define MODULE_SYMBOL_PREFIX ""
#endif

#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN

struct kernel_symbol
{
	unsigned long value;
	const char *name;
};

struct modversion_info
{
	unsigned long crc;
	char name[MODULE_NAME_LEN];
};

struct module;

struct module_attribute {
        struct attribute attr;
        ssize_t (*show)(struct module_attribute *, struct module *, char *);
        ssize_t (*store)(struct module_attribute *, struct module *,
			 const char *, size_t count);
	void (*setup)(struct module *, const char *);
	int (*test)(struct module *);
	void (*free)(struct module *);
};

struct module_kobject
{
	struct kobject kobj;
	struct module *mod;
	struct kobject *drivers_dir;
	struct module_param_attrs *mp;
};

/* These are either module local, or the kernel's dummy ones. */
extern int init_module(void);
extern void cleanup_module(void);

/* Archs provide a method of finding the correct exception table. */
struct exception_table_entry;

const struct exception_table_entry *
search_extable(const struct exception_table_entry *first,
	       const struct exception_table_entry *last,
	       unsigned long value);
void sort_extable(struct exception_table_entry *start,
		  struct exception_table_entry *finish);
void sort_main_extable(void);

#ifdef MODULE
#define MODULE_GENERIC_TABLE(gtype,name)			\
extern const struct gtype##_id __mod_##gtype##_table		\
  __attribute__ ((unused, alias(__stringify(name))))

extern struct module __this_module;
#define THIS_MODULE (&__this_module)
#else  /* !MODULE */
#define MODULE_GENERIC_TABLE(gtype,name)
#define THIS_MODULE ((struct module *)0)
#endif

/* Generic info of form tag = "info" */
#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)

/* For userspace: you can also call me... */
#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)

/*
 * The following license idents are currently accepted as indicating free
 * software modules
 *
 *	"GPL"				[GNU Public License v2 or later]
 *	"GPL v2"			[GNU Public License v2]
 *	"GPL and additional rights"	[GNU Public License v2 rights and more]
 *	"Dual BSD/GPL"			[GNU Public License v2
 *					 or BSD license choice]
 *	"Dual MIT/GPL"			[GNU Public License v2
 *					 or MIT license choice]
 *	"Dual MPL/GPL"			[GNU Public License v2
 *					 or Mozilla license choice]
 *
 * The following other idents are available
 *
 *	"Proprietary"			[Non free products]
 *
 * There are dual licensed components, but when running with Linux it is the
 * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
 * is a GPL combined work.
 *
 * This exists for several reasons
 * 1.	So modinfo can show license info for users wanting to vet their setup 
 *	is free
 * 2.	So the community can ignore bug reports including proprietary modules
 * 3.	So vendors can do likewise based on their own policies
 */
#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)

/* Author, ideally of form NAME[, NAME]*[ and NAME] */
#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
  
/* What your module does. */
#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)

/* One for each parameter, describing how to use it.  Some files do
   multiple of these per line, so can't just use MODULE_INFO. */
#define MODULE_PARM_DESC(_parm, desc) \
	__MODULE_INFO(parm, _parm, #_parm ":" desc)

#define MODULE_DEVICE_TABLE(type,name)		\
  MODULE_GENERIC_TABLE(type##_device,name)

/* Version of form [<epoch>:]<version>[-<extra-version>].
   Or for CVS/RCS ID version, everything but the number is stripped.
  <epoch>: A (small) unsigned integer which allows you to start versions
           anew. If not mentioned, it's zero.  eg. "2:1.0" is after
	   "1:2.0".
  <version>: The <version> may contain only alphanumerics and the
           character `.'.  Ordered by numeric sort for numeric parts,
	   ascii sort for ascii parts (as per RPM or DEB algorithm).
  <extraversion>: Like <version>, but inserted for local
           customizations, eg "rh3" or "rusty1".

  Using this automatically adds a checksum of the .c files and the
  local headers in "srcversion".
*/
#define MODULE_VERSION(_version) MODULE_INFO(version, _version)

/* Optional firmware file (or files) needed by the module
 * format is simply firmware file name.  Multiple firmware
 * files require multiple MODULE_FIRMWARE() specifiers */
#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)

/* Given an address, look for it in the exception tables */
const struct exception_table_entry *search_exception_tables(unsigned long add);

struct notifier_block;

#ifdef CONFIG_MODULES

/* Get/put a kernel symbol (calls must be symmetric) */
void *__symbol_get(const char *symbol);
void *__symbol_get_gpl(const char *symbol);
#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))

#ifndef __GENKSYMS__
#ifdef CONFIG_MODVERSIONS
/* Mark the CRC weak since genksyms apparently decides not to
 * generate a checksums for some symbols */
#define __CRC_SYMBOL(sym, sec)					\
	extern void *__crc_##sym __attribute__((weak));		\
	static const unsigned long __kcrctab_##sym		\
	__used							\
	__attribute__((section("__kcrctab" sec), unused))	\
	= (unsigned long) &__crc_##sym;
#else
#define __CRC_SYMBOL(sym, sec)
#endif

/* For every exported symbol, place a struct in the __ksymtab section */
#define __EXPORT_SYMBOL(sym, sec)				\
	extern typeof(sym) sym;					\
	__CRC_SYMBOL(sym, sec)					\
	static const char __kstrtab_##sym[]			\
	__attribute__((section("__ksymtab_strings"), aligned(1))) \
	= MODULE_SYMBOL_PREFIX #sym;                    	\
	static const struct kernel_symbol __ksymtab_##sym	\
	__used							\
	__attribute__((section("__ksymtab" sec), unused))	\
	= { (unsigned long)&sym, __kstrtab_##sym }

#define EXPORT_SYMBOL(sym)					\
	__EXPORT_SYMBOL(sym, "")

#define EXPORT_SYMBOL_GPL(sym)					\
	__EXPORT_SYMBOL(sym, "_gpl")

#define EXPORT_SYMBOL_GPL_FUTURE(sym)				\
	__EXPORT_SYMBOL(sym, "_gpl_future")


#ifdef CONFIG_UNUSED_SYMBOLS
#define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
#define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
#else
#define EXPORT_UNUSED_SYMBOL(sym)
#define EXPORT_UNUSED_SYMBOL_GPL(sym)
#endif

#endif

enum module_state
{
	MODULE_STATE_LIVE,
	MODULE_STATE_COMING,
	MODULE_STATE_GOING,
};

struct module
{
	enum module_state state;

	/* Member of list of modules */
	struct list_head list;

	/* Unique handle for this module */
	char name[MODULE_NAME_LEN];

	/* Sysfs stuff. */
	struct module_kobject mkobj;
	struct module_attribute *modinfo_attrs;
	const char *version;
	const char *srcversion;
	struct kobject *holders_dir;

	/* Exported symbols */
	const struct kernel_symbol *syms;
	const unsigned long *crcs;
	unsigned int num_syms;

	/* GPL-only exported symbols. */
	unsigned int num_gpl_syms;
	const struct kernel_symbol *gpl_syms;
	const unsigned long *gpl_crcs;

#ifdef CONFIG_UNUSED_SYMBOLS
	/* unused exported symbols. */
	const struct kernel_symbol *unused_syms;
	const unsigned long *unused_crcs;
	unsigned int num_unused_syms;

	/* GPL-only, unused exported symbols. */
	unsigned int num_unused_gpl_syms;
	const struct kernel_symbol *unused_gpl_syms;
	const unsigned long *unused_gpl_crcs;
#endif

	/* symbols that will be GPL-only in the near future. */
	const struct kernel_symbol *gpl_future_syms;
	const unsigned long *gpl_future_crcs;
	unsigned int num_gpl_future_syms;

	/* Exception table */
	unsigned int num_exentries;
	struct exception_table_entry *extable;

	/* Startup function. */
	int (*init)(void);

	/* If this is non-NULL, vfree after init() returns */
	void *module_init;

	/* Here is the actual code + data, vfree'd on unload. */
	void *module_core;

	/* Here are the sizes of the init and core sections */
	unsigned int init_size, core_size;

	/* The size of the executable code in each section.  */
	unsigned int init_text_size, core_text_size;

	/* Arch-specific module values */
	struct mod_arch_specific arch;

	unsigned int taints;	/* same bits as kernel:tainted */

#ifdef CONFIG_GENERIC_BUG
	/* Support for BUG */
	unsigned num_bugs;
	struct list_head bug_list;
	struct bug_entry *bug_table;
#endif

#ifdef CONFIG_KALLSYMS
	/* We keep the symbol and string tables for kallsyms. */
	Elf_Sym *symtab;
	unsigned int num_symtab;
	char *strtab;

	/* Section attributes */
	struct module_sect_attrs *sect_attrs;

	/* Notes attributes */
	struct module_notes_attrs *notes_attrs;
#endif

	/* Per-cpu data. */
	void *percpu;

	/* The command line arguments (may be mangled).  People like
	   keeping pointers to this stuff */
	char *args;
#ifdef CONFIG_MARKERS
	struct marker *markers;
	unsigned int num_markers;
#endif
#ifdef CONFIG_TRACEPOINTS
	struct tracepoint *tracepoints;
	unsigned int num_tracepoints;
#endif

#ifdef CONFIG_MODULE_UNLOAD
	/* What modules depend on me? */
	struct list_head modules_which_use_me;

	/* Who is waiting for us to be unloaded */
	struct task_struct *waiter;

	/* Destruction function. */
	void (*exit)(void);

#ifdef CONFIG_SMP
	char *refptr;
#else
	local_t ref;
#endif
#endif
};
#ifndef MODULE_ARCH_INIT
#define MODULE_ARCH_INIT {}
#endif

/* FIXME: It'd be nice to isolate modules during init, too, so they
   aren't used before they (may) fail.  But presently too much code
   (IDE & SCSI) require entry into the module during init.*/
static inline int module_is_live(struct module *mod)
{
	return mod->state != MODULE_STATE_GOING;
}

/* Is this address in a module? (second is with no locks, for oops) */
struct module *module_text_address(unsigned long addr);
struct module *__module_text_address(unsigned long addr);
int is_module_address(unsigned long addr);

static inline int within_module_core(unsigned long addr, struct module *mod)
{
	return (unsigned long)mod->module_core <= addr &&
	       addr < (unsigned long)mod->module_core + mod->core_size;
}

static inline int within_module_init(unsigned long addr, struct module *mod)
{
	return (unsigned long)mod->module_init <= addr &&
	       addr < (unsigned long)mod->module_init + mod->init_size;
}

/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
   symnum out of range. */
int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
			char *name, char *module_name, int *exported);

/* Look for this name: can be of form module:name. */
unsigned long module_kallsyms_lookup_name(const char *name);

extern void __module_put_and_exit(struct module *mod, long code)
	__attribute__((noreturn));
#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);

#ifdef CONFIG_MODULE_UNLOAD
unsigned int module_refcount(struct module *mod);
void __symbol_put(const char *symbol);
#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
void symbol_put_addr(void *addr);

static inline local_t *__module_ref_addr(struct module *mod, int cpu)
{
#ifdef CONFIG_SMP
	return (local_t *) (mod->refptr + per_cpu_offset(cpu));
#else
	return &mod->ref;
#endif
}

/* Sometimes we know we already have a refcount, and it's easier not
   to handle the error case (which only happens with rmmod --wait). */
static inline void __module_get(struct module *module)
{
	if (module) {
		local_inc(__module_ref_addr(module, get_cpu()));
		put_cpu();
	}
}

static inline int try_module_get(struct module *module)
{
	int ret = 1;

	if (module) {
		unsigned int cpu = get_cpu();
		if (likely(module_is_live(module)))
			local_inc(__module_ref_addr(module, cpu));
		else
			ret = 0;
		put_cpu();
	}
	return ret;
}

extern void module_put(struct module *module);

#else /*!CONFIG_MODULE_UNLOAD*/
static inline int try_module_get(struct module *module)
{
	return !module || module_is_live(module);
}
static inline void module_put(struct module *module)
{
}
static inline void __module_get(struct module *module)
{
}
#define symbol_put(x) do { } while(0)
#define symbol_put_addr(p) do { } while(0)

#endif /* CONFIG_MODULE_UNLOAD */

/* This is a #define so the string doesn't get put in every .o file */
#define module_name(mod)			\
({						\
	struct module *__mod = (mod);		\
	__mod ? __mod->name : "kernel";		\
})

/* For kallsyms to ask for address resolution.  namebuf should be at
 * least KSYM_NAME_LEN long: a pointer to namebuf is returned if
 * found, otherwise NULL. */
const char *module_address_lookup(unsigned long addr,
			    unsigned long *symbolsize,
			    unsigned long *offset,
			    char **modname,
			    char *namebuf);
int lookup_module_symbol_name(unsigned long addr, char *symname);
int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name);

/* For extable.c to search modules' exception tables. */
const struct exception_table_entry *search_module_extables(unsigned long addr);

int register_module_notifier(struct notifier_block * nb);
int unregister_module_notifier(struct notifier_block * nb);

extern void print_modules(void);

extern void module_update_markers(void);

extern void module_update_tracepoints(void);
extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);

#else /* !CONFIG_MODULES... */
#define EXPORT_SYMBOL(sym)
#define EXPORT_SYMBOL_GPL(sym)
#define EXPORT_SYMBOL_GPL_FUTURE(sym)
#define EXPORT_UNUSED_SYMBOL(sym)
#define EXPORT_UNUSED_SYMBOL_GPL(sym)

/* Given an address, look for it in the exception tables. */
static inline const struct exception_table_entry *
search_module_extables(unsigned long addr)
{
	return NULL;
}

/* Is this address in a module? */
static inline struct module *module_text_address(unsigned long addr)
{
	return NULL;
}

/* Is this address in a module? (don't take a lock, we're oopsing) */
static inline struct module *__module_text_address(unsigned long addr)
{
	return NULL;
}

static inline int is_module_address(unsigned long addr)
{
	return 0;
}

/* Get/put a kernel symbol (calls should be symmetric) */
#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
#define symbol_put(x) do { } while(0)
#define symbol_put_addr(x) do { } while(0)

static inline void __module_get(struct module *module)
{
}

static inline int try_module_get(struct module *module)
{
	return 1;
}

static inline void module_put(struct module *module)
{
}

#define module_name(mod) "kernel"

/* For kallsyms to ask for address resolution.  NULL means not found. */
static inline const char *module_address_lookup(unsigned long addr,
					  unsigned long *symbolsize,
					  unsigned long *offset,
					  char **modname,
					  char *namebuf)
{
	return NULL;
}

static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
{
	return -ERANGE;
}

static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name)
{
	return -ERANGE;
}

static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
					char *type, char *name,
					char *module_name, int *exported)
{
	return -ERANGE;
}

static inline unsigned long module_kallsyms_lookup_name(const char *name)
{
	return 0;
}

static inline int register_module_notifier(struct notifier_block * nb)
{
	/* no events will happen anyway, so this can always succeed */
	return 0;
}

static inline int unregister_module_notifier(struct notifier_block * nb)
{
	return 0;
}

#define module_put_and_exit(code) do_exit(code)

static inline void print_modules(void)
{
}

static inline void module_update_markers(void)
{
}

static inline void module_update_tracepoints(void)
{
}

static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
{
	return 0;
}

#endif /* CONFIG_MODULES */

struct device_driver;
#ifdef CONFIG_SYSFS
struct module;

extern struct kset *module_kset;
extern struct kobj_type module_ktype;
extern int module_sysfs_initialized;

int mod_sysfs_init(struct module *mod);
int mod_sysfs_setup(struct module *mod,
			   struct kernel_param *kparam,
			   unsigned int num_params);
int module_add_modinfo_attrs(struct module *mod);
void module_remove_modinfo_attrs(struct module *mod);

#else /* !CONFIG_SYSFS */

static inline int mod_sysfs_init(struct module *mod)
{
	return 0;
}

static inline int mod_sysfs_setup(struct module *mod,
			   struct kernel_param *kparam,
			   unsigned int num_params)
{
	return 0;
}

static inline int module_add_modinfo_attrs(struct module *mod)
{
	return 0;
}

static inline void module_remove_modinfo_attrs(struct module *mod)
{ }

#endif /* CONFIG_SYSFS */

#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)

/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */

#define __MODULE_STRING(x) __stringify(x)

#endif /* _LINUX_MODULE_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_MODULE_H
	2	#define _LINUX_MODULE_H
	3	/*
	4	* Dynamic loading of modules into the kernel.
	5	*
	6	* Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
	7	* Rewritten again by Rusty Russell, 2002
	8	*/
1da177e4 LT	9	#include <linux/list.h>
	10	#include <linux/stat.h>
	11	#include <linux/compiler.h>
	12	#include <linux/cache.h>
	13	#include <linux/kmod.h>
	14	#include <linux/elf.h>
	15	#include <linux/stringify.h>
	16	#include <linux/kobject.h>
	17	#include <linux/moduleparam.h>
8256e47c	18	#include <linux/marker.h>
97e1c18e	19	#include <linux/tracepoint.h>
1da177e4 LT	20	#include <asm/local.h>
	21
	22	#include <asm/module.h>
	23
	24	/* Not Yet Implemented */
	25	#define MODULE_SUPPORTED_DEVICE(name)
	26
f606ddf4	27	/* some toolchains uses a `_' prefix for all user symbols */
1da177e4 LT	28	#ifndef MODULE_SYMBOL_PREFIX
	29	#define MODULE_SYMBOL_PREFIX ""
	30	#endif
	31
730b69d2	32	#define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN
1da177e4 LT	33
	34	struct kernel_symbol
	35	{
	36	unsigned long value;
	37	const char *name;
	38	};
	39
	40	struct modversion_info
	41	{
	42	unsigned long crc;
	43	char name[MODULE_NAME_LEN];
	44	};
	45
	46	struct module;
	47
	48	struct module_attribute {
	49	struct attribute attr;
	50	ssize_t (show)(struct module_attribute , struct module , char );
	51	ssize_t (store)(struct module_attribute , struct module *,
	52	const char *, size_t count);
c988d2b2 MD	53	void (setup)(struct module , const char *);
	54	int (test)(struct module );
	55	void (free)(struct module );
1da177e4 LT	56	};
	57
	58	struct module_kobject
	59	{
	60	struct kobject kobj;
	61	struct module *mod;
f30c53a8	62	struct kobject *drivers_dir;
9b473de8	63	struct module_param_attrs *mp;
1da177e4 LT	64	};
	65
	66	/* These are either module local, or the kernel's dummy ones. */
	67	extern int init_module(void);
	68	extern void cleanup_module(void);
	69
	70	/* Archs provide a method of finding the correct exception table. */
	71	struct exception_table_entry;
	72
	73	const struct exception_table_entry *
	74	search_extable(const struct exception_table_entry *first,
	75	const struct exception_table_entry *last,
	76	unsigned long value);
	77	void sort_extable(struct exception_table_entry *start,
	78	struct exception_table_entry *finish);
	79	void sort_main_extable(void);
	80
1da177e4 LT	81	#ifdef MODULE
	82	#define MODULE_GENERIC_TABLE(gtype,name) \
	83	extern const struct gtype##_id __mod_##gtype##_table \
	84	__attribute__ ((unused, alias(__stringify(name))))
	85
	86	extern struct module __this_module;
	87	#define THIS_MODULE (&__this_module)
	88	#else /* !MODULE */
	89	#define MODULE_GENERIC_TABLE(gtype,name)
	90	#define THIS_MODULE ((struct module *)0)
	91	#endif
	92
	93	/* Generic info of form tag = "info" */
	94	#define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info)
	95
	96	/* For userspace: you can also call me... */
	97	#define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias)
	98
	99	/*
	100	* The following license idents are currently accepted as indicating free
	101	* software modules
	102	*
	103	* "GPL" [GNU Public License v2 or later]
	104	* "GPL v2" [GNU Public License v2]
	105	* "GPL and additional rights" [GNU Public License v2 rights and more]
	106	* "Dual BSD/GPL" [GNU Public License v2
	107	* or BSD license choice]
8d27e908 XVP	108	* "Dual MIT/GPL" [GNU Public License v2
8d27e908 XVP	109	* or MIT license choice]
1da177e4 LT	110	* "Dual MPL/GPL" [GNU Public License v2
	111	* or Mozilla license choice]
	112	*
	113	* The following other idents are available
	114	*
	115	* "Proprietary" [Non free products]
	116	*
	117	* There are dual licensed components, but when running with Linux it is the
	118	* GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
	119	* is a GPL combined work.
	120	*
	121	* This exists for several reasons
	122	* 1. So modinfo can show license info for users wanting to vet their setup
	123	* is free
	124	* 2. So the community can ignore bug reports including proprietary modules
	125	* 3. So vendors can do likewise based on their own policies
	126	*/
	127	#define MODULE_LICENSE(_license) MODULE_INFO(license, _license)
	128
108f39a1	129	/* Author, ideally of form NAME[, NAME][ and NAME] /
1da177e4 LT	130	#define MODULE_AUTHOR(_author) MODULE_INFO(author, _author)
	131
	132	/* What your module does. */
	133	#define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description)
	134
	135	/* One for each parameter, describing how to use it. Some files do
	136	multiple of these per line, so can't just use MODULE_INFO. */
	137	#define MODULE_PARM_DESC(_parm, desc) \
	138	__MODULE_INFO(parm, _parm, #_parm ":" desc)
	139
	140	#define MODULE_DEVICE_TABLE(type,name) \
	141	MODULE_GENERIC_TABLE(type##_device,name)
	142
	143	/* Version of form [<epoch>:]<version>[-<extra-version>].
	144	Or for CVS/RCS ID version, everything but the number is stripped.
	145	<epoch>: A (small) unsigned integer which allows you to start versions
	146	anew. If not mentioned, it's zero. eg. "2:1.0" is after
	147	"1:2.0".
	148	<version>: The <version> may contain only alphanumerics and the
	149	character `.'. Ordered by numeric sort for numeric parts,
	150	ascii sort for ascii parts (as per RPM or DEB algorithm).
	151	<extraversion>: Like <version>, but inserted for local
	152	customizations, eg "rh3" or "rusty1".
	153
	154	Using this automatically adds a checksum of the .c files and the
	155	local headers in "srcversion".
	156	*/
	157	#define MODULE_VERSION(_version) MODULE_INFO(version, _version)
	158
187afbed JM	159	/* Optional firmware file (or files) needed by the module
	160	* format is simply firmware file name. Multiple firmware
	161	* files require multiple MODULE_FIRMWARE() specifiers */
	162	#define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware)
	163
1da177e4 LT	164	/* Given an address, look for it in the exception tables */
	165	const struct exception_table_entry *search_exception_tables(unsigned long add);
	166
	167	struct notifier_block;
	168
	169	#ifdef CONFIG_MODULES
	170
	171	/* Get/put a kernel symbol (calls must be symmetric) */
	172	void __symbol_get(const char symbol);
	173	void __symbol_get_gpl(const char symbol);
	174	#define symbol_get(x) ((typeof(&x))(__symbol_get(MODULE_SYMBOL_PREFIX #x)))
	175
	176	#ifndef __GENKSYMS__
	177	#ifdef CONFIG_MODVERSIONS
	178	/* Mark the CRC weak since genksyms apparently decides not to
	179	* generate a checksums for some symbols */
	180	#define __CRC_SYMBOL(sym, sec) \
	181	extern void *__crc_##sym __attribute__((weak)); \
	182	static const unsigned long __kcrctab_##sym \
3ff6eecc	183	__used \
1da177e4 LT	184	__attribute__((section("__kcrctab" sec), unused)) \
	185	= (unsigned long) &__crc_##sym;
	186	#else
	187	#define __CRC_SYMBOL(sym, sec)
	188	#endif
	189
	190	/* For every exported symbol, place a struct in the __ksymtab section */
	191	#define __EXPORT_SYMBOL(sym, sec) \
a1a8feed	192	extern typeof(sym) sym; \
1da177e4 LT	193	__CRC_SYMBOL(sym, sec) \
1da177e4 LT	194	static const char __kstrtab_##sym[] \
ea01e798	195	__attribute__((section("__ksymtab_strings"), aligned(1))) \
1da177e4 LT	196	= MODULE_SYMBOL_PREFIX #sym; \
1da177e4 LT	197	static const struct kernel_symbol __ksymtab_##sym \
3ff6eecc	198	__used \
1da177e4 LT	199	__attribute__((section("__ksymtab" sec), unused)) \
	200	= { (unsigned long)&sym, __kstrtab_##sym }
	201
	202	#define EXPORT_SYMBOL(sym) \
	203	__EXPORT_SYMBOL(sym, "")
	204
	205	#define EXPORT_SYMBOL_GPL(sym) \
	206	__EXPORT_SYMBOL(sym, "_gpl")
	207
9f28bb7e GKH	208	#define EXPORT_SYMBOL_GPL_FUTURE(sym) \
	209	__EXPORT_SYMBOL(sym, "_gpl_future")
	210
f71d20e9 AV	211
	212	#ifdef CONFIG_UNUSED_SYMBOLS
	213	#define EXPORT_UNUSED_SYMBOL(sym) __EXPORT_SYMBOL(sym, "_unused")
	214	#define EXPORT_UNUSED_SYMBOL_GPL(sym) __EXPORT_SYMBOL(sym, "_unused_gpl")
	215	#else
	216	#define EXPORT_UNUSED_SYMBOL(sym)
	217	#define EXPORT_UNUSED_SYMBOL_GPL(sym)
	218	#endif
	219
1da177e4 LT	220	#endif
1da177e4 LT	221
1da177e4 LT	222	enum module_state
	223	{
	224	MODULE_STATE_LIVE,
	225	MODULE_STATE_COMING,
	226	MODULE_STATE_GOING,
	227	};
	228
1da177e4 LT	229	struct module
	230	{
	231	enum module_state state;
	232
	233	/* Member of list of modules */
	234	struct list_head list;
	235
	236	/* Unique handle for this module */
	237	char name[MODULE_NAME_LEN];
	238
	239	/* Sysfs stuff. */
	240	struct module_kobject mkobj;
03e88ae1	241	struct module_attribute *modinfo_attrs;
c988d2b2 MD	242	const char *version;
c988d2b2 MD	243	const char *srcversion;
270a6c4c	244	struct kobject *holders_dir;
1da177e4 LT	245
	246	/* Exported symbols */
	247	const struct kernel_symbol *syms;
1da177e4	248	const unsigned long *crcs;
af540689	249	unsigned int num_syms;
1da177e4 LT	250
1da177e4 LT	251	/* GPL-only exported symbols. */
1da177e4	252	unsigned int num_gpl_syms;
af540689	253	const struct kernel_symbol *gpl_syms;
1da177e4 LT	254	const unsigned long *gpl_crcs;
1da177e4 LT	255
f7f5b675	256	#ifdef CONFIG_UNUSED_SYMBOLS
f71d20e9 AV	257	/* unused exported symbols. */
f71d20e9 AV	258	const struct kernel_symbol *unused_syms;
f71d20e9	259	const unsigned long *unused_crcs;
af540689 RK	260	unsigned int num_unused_syms;
af540689 RK	261
f71d20e9	262	/* GPL-only, unused exported symbols. */
f71d20e9	263	unsigned int num_unused_gpl_syms;
af540689	264	const struct kernel_symbol *unused_gpl_syms;
f71d20e9	265	const unsigned long *unused_gpl_crcs;
f7f5b675	266	#endif
f71d20e9	267
9f28bb7e GKH	268	/* symbols that will be GPL-only in the near future. */
9f28bb7e GKH	269	const struct kernel_symbol *gpl_future_syms;
9f28bb7e	270	const unsigned long *gpl_future_crcs;
af540689	271	unsigned int num_gpl_future_syms;
9f28bb7e	272
1da177e4 LT	273	/* Exception table */
1da177e4 LT	274	unsigned int num_exentries;
5e458cc0	275	struct exception_table_entry *extable;
1da177e4 LT	276
	277	/* Startup function. */
	278	int (*init)(void);
	279
	280	/* If this is non-NULL, vfree after init() returns */
	281	void *module_init;
	282
	283	/* Here is the actual code + data, vfree'd on unload. */
	284	void *module_core;
	285
	286	/* Here are the sizes of the init and core sections */
2f0f2a33	287	unsigned int init_size, core_size;
1da177e4 LT	288
1da177e4 LT	289	/* The size of the executable code in each section. */
2f0f2a33	290	unsigned int init_text_size, core_text_size;
1da177e4 LT	291
	292	/* Arch-specific module values */
	293	struct mod_arch_specific arch;
	294
2bc2d61a RD	295	unsigned int taints; /* same bits as kernel:tainted */
2bc2d61a RD	296
7664c5a1 JF	297	#ifdef CONFIG_GENERIC_BUG
7664c5a1 JF	298	/* Support for BUG */
af540689	299	unsigned num_bugs;
7664c5a1 JF	300	struct list_head bug_list;
7664c5a1 JF	301	struct bug_entry *bug_table;
1da177e4 LT	302	#endif
	303
	304	#ifdef CONFIG_KALLSYMS
	305	/* We keep the symbol and string tables for kallsyms. */
	306	Elf_Sym *symtab;
2f0f2a33	307	unsigned int num_symtab;
1da177e4 LT	308	char *strtab;
	309
	310	/* Section attributes */
	311	struct module_sect_attrs *sect_attrs;
6d760133 RM	312
	313	/* Notes attributes */
	314	struct module_notes_attrs *notes_attrs;
1da177e4 LT	315	#endif
	316
	317	/* Per-cpu data. */
	318	void *percpu;
	319
	320	/* The command line arguments (may be mangled). People like
	321	keeping pointers to this stuff */
	322	char *args;
8256e47c MD	323	#ifdef CONFIG_MARKERS
	324	struct marker *markers;
	325	unsigned int num_markers;
	326	#endif
97e1c18e MD	327	#ifdef CONFIG_TRACEPOINTS
	328	struct tracepoint *tracepoints;
	329	unsigned int num_tracepoints;
	330	#endif
af540689 RK	331
	332	#ifdef CONFIG_MODULE_UNLOAD
	333	/* What modules depend on me? */
	334	struct list_head modules_which_use_me;
	335
	336	/* Who is waiting for us to be unloaded */
	337	struct task_struct *waiter;
	338
	339	/* Destruction function. */
	340	void (*exit)(void);
	341
720eba31 ED	342	#ifdef CONFIG_SMP
	343	char *refptr;
	344	#else
	345	local_t ref;
	346	#endif
af540689	347	#endif
1da177e4	348	};
e61a1c1c RZ	349	#ifndef MODULE_ARCH_INIT
	350	#define MODULE_ARCH_INIT {}
	351	#endif
1da177e4 LT	352
	353	/* FIXME: It'd be nice to isolate modules during init, too, so they
	354	aren't used before they (may) fail. But presently too much code
	355	(IDE & SCSI) require entry into the module during init.*/
	356	static inline int module_is_live(struct module *mod)
	357	{
	358	return mod->state != MODULE_STATE_GOING;
	359	}
	360
	361	/* Is this address in a module? (second is with no locks, for oops) */
	362	struct module *module_text_address(unsigned long addr);
	363	struct module *__module_text_address(unsigned long addr);
4d435f9d	364	int is_module_address(unsigned long addr);
1da177e4	365
a06f6211 MH	366	static inline int within_module_core(unsigned long addr, struct module *mod)
	367	{
	368	return (unsigned long)mod->module_core <= addr &&
	369	addr < (unsigned long)mod->module_core + mod->core_size;
	370	}
	371
	372	static inline int within_module_init(unsigned long addr, struct module *mod)
	373	{
	374	return (unsigned long)mod->module_init <= addr &&
	375	addr < (unsigned long)mod->module_init + mod->init_size;
	376	}
	377
ea07890a	378	/* Returns 0 and fills in value, defined and namebuf, or -ERANGE if
1da177e4	379	symnum out of range. */
ea07890a AD	380	int module_get_kallsym(unsigned int symnum, unsigned long value, char type,
ea07890a AD	381	char name, char module_name, int *exported);
1da177e4 LT	382
	383	/* Look for this name: can be of form module:name. */
	384	unsigned long module_kallsyms_lookup_name(const char *name);
	385
1da177e4 LT	386	extern void __module_put_and_exit(struct module *mod, long code)
	387	__attribute__((noreturn));
	388	#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
	389
	390	#ifdef CONFIG_MODULE_UNLOAD
	391	unsigned int module_refcount(struct module *mod);
	392	void __symbol_put(const char *symbol);
	393	#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
	394	void symbol_put_addr(void *addr);
	395
720eba31 ED	396	static inline local_t __module_ref_addr(struct module mod, int cpu)
	397	{
	398	#ifdef CONFIG_SMP
	399	return (local_t *) (mod->refptr + per_cpu_offset(cpu));
	400	#else
	401	return &mod->ref;
	402	#endif
	403	}
	404
1da177e4 LT	405	/* Sometimes we know we already have a refcount, and it's easier not
	406	to handle the error case (which only happens with rmmod --wait). */
	407	static inline void __module_get(struct module *module)
	408	{
	409	if (module) {
720eba31	410	local_inc(__module_ref_addr(module, get_cpu()));
1da177e4 LT	411	put_cpu();
	412	}
	413	}
	414
	415	static inline int try_module_get(struct module *module)
	416	{
	417	int ret = 1;
	418
	419	if (module) {
	420	unsigned int cpu = get_cpu();
	421	if (likely(module_is_live(module)))
720eba31	422	local_inc(__module_ref_addr(module, cpu));
1da177e4 LT	423	else
	424	ret = 0;
	425	put_cpu();
	426	}
	427	return ret;
	428	}
	429
f6a57033	430	extern void module_put(struct module *module);
1da177e4 LT	431
	432	#else /!CONFIG_MODULE_UNLOAD/
	433	static inline int try_module_get(struct module *module)
	434	{
	435	return !module \|\| module_is_live(module);
	436	}
	437	static inline void module_put(struct module *module)
	438	{
	439	}
	440	static inline void __module_get(struct module *module)
	441	{
	442	}
	443	#define symbol_put(x) do { } while(0)
	444	#define symbol_put_addr(p) do { } while(0)
	445
	446	#endif /* CONFIG_MODULE_UNLOAD */
	447
	448	/* This is a #define so the string doesn't get put in every .o file */
	449	#define module_name(mod) \
	450	({ \
	451	struct module *__mod = (mod); \
	452	__mod ? __mod->name : "kernel"; \
	453	})
	454
6dd06c9f RR	455	/* For kallsyms to ask for address resolution. namebuf should be at
	456	* least KSYM_NAME_LEN long: a pointer to namebuf is returned if
	457	* found, otherwise NULL. */
92dfc9dc	458	const char *module_address_lookup(unsigned long addr,
6dd06c9f RR	459	unsigned long *symbolsize,
	460	unsigned long *offset,
	461	char **modname,
	462	char *namebuf);
9d65cb4a	463	int lookup_module_symbol_name(unsigned long addr, char *symname);
a5c43dae	464	int lookup_module_symbol_attrs(unsigned long addr, unsigned long size, unsigned long offset, char modname, char name);
1da177e4 LT	465
	466	/* For extable.c to search modules' exception tables. */
	467	const struct exception_table_entry *search_module_extables(unsigned long addr);
	468
	469	int register_module_notifier(struct notifier_block * nb);
	470	int unregister_module_notifier(struct notifier_block * nb);
	471
	472	extern void print_modules(void);
	473
fb40bd78	474	extern void module_update_markers(void);
8256e47c	475
97e1c18e MD	476	extern void module_update_tracepoints(void);
	477	extern int module_get_iter_tracepoints(struct tracepoint_iter *iter);
	478
1da177e4 LT	479	#else /* !CONFIG_MODULES... */
	480	#define EXPORT_SYMBOL(sym)
	481	#define EXPORT_SYMBOL_GPL(sym)
9f28bb7e	482	#define EXPORT_SYMBOL_GPL_FUTURE(sym)
f71d20e9 AV	483	#define EXPORT_UNUSED_SYMBOL(sym)
f71d20e9 AV	484	#define EXPORT_UNUSED_SYMBOL_GPL(sym)
1da177e4 LT	485
	486	/* Given an address, look for it in the exception tables. */
	487	static inline const struct exception_table_entry *
	488	search_module_extables(unsigned long addr)
	489	{
	490	return NULL;
	491	}
	492
	493	/* Is this address in a module? */
	494	static inline struct module *module_text_address(unsigned long addr)
	495	{
	496	return NULL;
	497	}
	498
	499	/* Is this address in a module? (don't take a lock, we're oopsing) */
	500	static inline struct module *__module_text_address(unsigned long addr)
	501	{
	502	return NULL;
	503	}
	504
4d435f9d IM	505	static inline int is_module_address(unsigned long addr)
	506	{
	507	return 0;
	508	}
	509
1da177e4 LT	510	/* Get/put a kernel symbol (calls should be symmetric) */
	511	#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
	512	#define symbol_put(x) do { } while(0)
	513	#define symbol_put_addr(x) do { } while(0)
	514
	515	static inline void __module_get(struct module *module)
	516	{
	517	}
	518
	519	static inline int try_module_get(struct module *module)
	520	{
	521	return 1;
	522	}
	523
	524	static inline void module_put(struct module *module)
	525	{
	526	}
	527
	528	#define module_name(mod) "kernel"
	529
1da177e4	530	/* For kallsyms to ask for address resolution. NULL means not found. */
92dfc9dc	531	static inline const char *module_address_lookup(unsigned long addr,
6dd06c9f RR	532	unsigned long *symbolsize,
	533	unsigned long *offset,
	534	char **modname,
	535	char *namebuf)
1da177e4 LT	536	{
	537	return NULL;
	538	}
	539
9d65cb4a AD	540	static inline int lookup_module_symbol_name(unsigned long addr, char *symname)
	541	{
	542	return -ERANGE;
	543	}
	544
a5c43dae AD	545	static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long size, unsigned long offset, char modname, char name)
	546	{
	547	return -ERANGE;
	548	}
	549
ea07890a AD	550	static inline int module_get_kallsym(unsigned int symnum, unsigned long *value,
	551	char type, char name,
	552	char module_name, int exported)
1da177e4	553	{
ea07890a	554	return -ERANGE;
1da177e4 LT	555	}
	556
	557	static inline unsigned long module_kallsyms_lookup_name(const char *name)
	558	{
	559	return 0;
	560	}
	561
1da177e4 LT	562	static inline int register_module_notifier(struct notifier_block * nb)
	563	{
	564	/* no events will happen anyway, so this can always succeed */
	565	return 0;
	566	}
	567
	568	static inline int unregister_module_notifier(struct notifier_block * nb)
	569	{
	570	return 0;
	571	}
	572
	573	#define module_put_and_exit(code) do_exit(code)
	574
	575	static inline void print_modules(void)
	576	{
	577	}
	578
1387d0d8	579	static inline void module_update_markers(void)
8256e47c MD	580	{
	581	}
	582
97e1c18e MD	583	static inline void module_update_tracepoints(void)
	584	{
	585	}
	586
	587	static inline int module_get_iter_tracepoints(struct tracepoint_iter *iter)
	588	{
	589	return 0;
	590	}
	591
ef665c1a RD	592	#endif /* CONFIG_MODULES */
ef665c1a RD	593
1da177e4	594	struct device_driver;
ef665c1a	595	#ifdef CONFIG_SYSFS
1da177e4 LT	596	struct module;
1da177e4 LT	597
7405c1e1 GKH	598	extern struct kset *module_kset;
	599	extern struct kobj_type module_ktype;
	600	extern int module_sysfs_initialized;
ef665c1a RD	601
	602	int mod_sysfs_init(struct module *mod);
	603	int mod_sysfs_setup(struct module *mod,
	604	struct kernel_param *kparam,
	605	unsigned int num_params);
	606	int module_add_modinfo_attrs(struct module *mod);
	607	void module_remove_modinfo_attrs(struct module *mod);
	608
	609	#else /* !CONFIG_SYSFS */
	610
	611	static inline int mod_sysfs_init(struct module *mod)
1da177e4	612	{
ef665c1a	613	return 0;
1da177e4 LT	614	}
1da177e4 LT	615
ef665c1a RD	616	static inline int mod_sysfs_setup(struct module *mod,
	617	struct kernel_param *kparam,
	618	unsigned int num_params)
1da177e4	619	{
ef665c1a	620	return 0;
1da177e4 LT	621	}
1da177e4 LT	622
ef665c1a RD	623	static inline int module_add_modinfo_attrs(struct module *mod)
	624	{
	625	return 0;
	626	}
	627
	628	static inline void module_remove_modinfo_attrs(struct module *mod)
	629	{ }
	630
	631	#endif /* CONFIG_SYSFS */
	632
1da177e4 LT	633	#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
	634
	635	/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
	636
1da177e4 LT	637	#define __MODULE_STRING(x) __stringify(x)
1da177e4 LT	638
1da177e4	639	#endif /* _LINUX_MODULE_H */