[linux-2.6-block.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 <asm/local.h>

#include <asm/module.h>

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

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

#define MODULE_NAME_LEN (64 - sizeof(unsigned long))

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;
};

/* 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		\
	__attribute_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")))		\
	= MODULE_SYMBOL_PREFIX #sym;                    	\
	static const struct kernel_symbol __ksymtab_##sym	\
	__attribute_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

struct module_ref
{
	local_t count;
} ____cacheline_aligned;

enum module_state
{
	MODULE_STATE_LIVE,
	MODULE_STATE_COMING,
	MODULE_STATE_GOING,
};

/* Similar stuff for section attributes. */
struct module_sect_attr
{
	struct module_attribute mattr;
	char *name;
	unsigned long address;
};

struct module_sect_attrs
{
	struct attribute_group grp;
	int nsections;
	struct module_sect_attr attrs[0];
};

struct module_param_attrs;

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_param_attrs *param_attrs;
	struct module_attribute *modinfo_attrs;
	const char *version;
	const char *srcversion;
	struct kobject *holders_dir;

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

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

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

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

	/* Exception table */
	unsigned int num_exentries;
	const 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 long init_size, core_size;

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

	/* The handle returned from unwind_add_table. */
	void *unwind_info;

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

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

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

#ifdef CONFIG_MODULE_UNLOAD
	/* Reference counts */
	struct module_ref ref[NR_CPUS];

	/* 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);
#endif

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

	/* Section attributes */
	struct module_sect_attrs *sect_attrs;
#endif

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

	/* The command line arguments (may be mangled).  People like
	   keeping pointers to this stuff */
	char *args;
};
#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);

/* 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);

/* 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) {
		BUG_ON(module_refcount(module) == 0);
		local_inc(&module->ref[get_cpu()].count);
		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[cpu].count);
		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.  NULL means not found. */
const char *module_address_lookup(unsigned long addr,
				  unsigned long *symbolsize,
				  unsigned long *offset,
				  char **modname);
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);

#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)
{
	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)
{
}

#endif /* CONFIG_MODULES */

struct device_driver;
#ifdef CONFIG_SYSFS
struct module;

extern struct kset module_subsys;

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 */

#if defined(CONFIG_SYSFS) && defined(CONFIG_MODULES)

void module_add_driver(struct module *mod, struct device_driver *drv);
void module_remove_driver(struct device_driver *drv);

#else /* not both CONFIG_SYSFS && CONFIG_MODULES */

static inline void module_add_driver(struct module *mod, struct device_driver *drv)
{ }

static inline void module_remove_driver(struct device_driver *drv)
{ }

#endif

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