[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/spinlock.h>
#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);

extern struct subsystem module_subsys;

#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 <EMAIL>[, NAME <EMAIL>]*[ and NAME <EMAIL>] */
#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;

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

	/* Am I unsafe to unload? */
	int unsafe;

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

/* 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 module and fills in value, defined and namebuf, or NULL if
   symnum out of range. */
struct module *module_get_kallsym(unsigned int symnum, unsigned long *value,
				char *type, char *name, size_t namelen);

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

int is_exported(const char *name, const struct module *mod);

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";		\
})

#define __unsafe(mod)							     \
do {									     \
	if (mod && !(mod)->unsafe) {					     \
		printk(KERN_WARNING					     \
		       "Module %s cannot be unloaded due to unsafe usage in" \
		       " %s:%u\n", (mod)->name, __FILE__, __LINE__);	     \
		(mod)->unsafe = 1;					     \
	}								     \
} while(0)

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

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

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

#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"

#define __unsafe(mod)

/* 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 struct module *module_get_kallsym(unsigned int symnum,
						unsigned long *value,
						char *type, char *name,
						size_t namelen)
{
	return NULL;
}

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

static inline int is_exported(const char *name, const struct module *mod)
{
	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)
{
}

struct device_driver;
struct module;

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

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

#endif /* CONFIG_MODULES */

#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/spinlock.h>
	10	#include <linux/list.h>
	11	#include <linux/stat.h>
	12	#include <linux/compiler.h>
	13	#include <linux/cache.h>
	14	#include <linux/kmod.h>
	15	#include <linux/elf.h>
	16	#include <linux/stringify.h>
	17	#include <linux/kobject.h>
	18	#include <linux/moduleparam.h>
	19	#include <asm/local.h>
	20
	21	#include <asm/module.h>
	22
	23	/* Not Yet Implemented */
	24	#define MODULE_SUPPORTED_DEVICE(name)
	25
	26	/* v850 toolchain uses a `_' prefix for all user symbols */
	27	#ifndef MODULE_SYMBOL_PREFIX
	28	#define MODULE_SYMBOL_PREFIX ""
	29	#endif
	30
	31	#define MODULE_NAME_LEN (64 - sizeof(unsigned long))
	32
	33	struct kernel_symbol
	34	{
	35	unsigned long value;
	36	const char *name;
	37	};
	38
	39	struct modversion_info
	40	{
	41	unsigned long crc;
	42	char name[MODULE_NAME_LEN];
	43	};
	44
	45	struct module;
	46
	47	struct module_attribute {
	48	struct attribute attr;
	49	ssize_t (show)(struct module_attribute , struct module , char );
	50	ssize_t (store)(struct module_attribute , struct module *,
	51	const char *, size_t count);
c988d2b2 MD	52	void (setup)(struct module , const char *);
	53	int (test)(struct module );
	54	void (free)(struct module );
1da177e4 LT	55	};
	56
	57	struct module_kobject
	58	{
	59	struct kobject kobj;
	60	struct module *mod;
f30c53a8	61	struct kobject *drivers_dir;
1da177e4 LT	62	};
	63
	64	/* These are either module local, or the kernel's dummy ones. */
	65	extern int init_module(void);
	66	extern void cleanup_module(void);
	67
	68	/* Archs provide a method of finding the correct exception table. */
	69	struct exception_table_entry;
	70
	71	const struct exception_table_entry *
	72	search_extable(const struct exception_table_entry *first,
	73	const struct exception_table_entry *last,
	74	unsigned long value);
	75	void sort_extable(struct exception_table_entry *start,
	76	struct exception_table_entry *finish);
	77	void sort_main_extable(void);
	78
	79	extern struct subsystem module_subsys;
	80
	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
	129	/* Author, ideally of form NAME <EMAIL>[, NAME <EMAIL>][ and NAME <EMAIL>] /
	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 \
	183	__attribute_used__ \
	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) \
	194	static const char __kstrtab_##sym[] \
	195	__attribute__((section("__ksymtab_strings"))) \
	196	= MODULE_SYMBOL_PREFIX #sym; \
	197	static const struct kernel_symbol __ksymtab_##sym \
	198	__attribute_used__ \
	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
	221
	222	struct module_ref
	223	{
	224	local_t count;
	225	} ____cacheline_aligned;
	226
	227	enum module_state
	228	{
	229	MODULE_STATE_LIVE,
	230	MODULE_STATE_COMING,
	231	MODULE_STATE_GOING,
	232	};
	233
	234	/* Similar stuff for section attributes. */
1da177e4 LT	235	struct module_sect_attr
	236	{
	237	struct module_attribute mattr;
04b1db9f	238	char *name;
1da177e4 LT	239	unsigned long address;
	240	};
	241
	242	struct module_sect_attrs
	243	{
	244	struct attribute_group grp;
04b1db9f	245	int nsections;
1da177e4 LT	246	struct module_sect_attr attrs[0];
	247	};
	248
	249	struct module_param_attrs;
	250
	251	struct module
	252	{
	253	enum module_state state;
	254
	255	/* Member of list of modules */
	256	struct list_head list;
	257
	258	/* Unique handle for this module */
	259	char name[MODULE_NAME_LEN];
	260
	261	/* Sysfs stuff. */
	262	struct module_kobject mkobj;
	263	struct module_param_attrs *param_attrs;
03e88ae1	264	struct module_attribute *modinfo_attrs;
c988d2b2 MD	265	const char *version;
c988d2b2 MD	266	const char *srcversion;
1da177e4 LT	267
	268	/* Exported symbols */
	269	const struct kernel_symbol *syms;
	270	unsigned int num_syms;
	271	const unsigned long *crcs;
	272
	273	/* GPL-only exported symbols. */
	274	const struct kernel_symbol *gpl_syms;
	275	unsigned int num_gpl_syms;
	276	const unsigned long *gpl_crcs;
	277
f71d20e9 AV	278	/* unused exported symbols. */
	279	const struct kernel_symbol *unused_syms;
	280	unsigned int num_unused_syms;
	281	const unsigned long *unused_crcs;
	282	/* GPL-only, unused exported symbols. */
	283	const struct kernel_symbol *unused_gpl_syms;
	284	unsigned int num_unused_gpl_syms;
	285	const unsigned long *unused_gpl_crcs;
	286
9f28bb7e GKH	287	/* symbols that will be GPL-only in the near future. */
	288	const struct kernel_symbol *gpl_future_syms;
	289	unsigned int num_gpl_future_syms;
	290	const unsigned long *gpl_future_crcs;
	291
1da177e4 LT	292	/* Exception table */
	293	unsigned int num_exentries;
	294	const struct exception_table_entry *extable;
	295
	296	/* Startup function. */
	297	int (*init)(void);
	298
	299	/* If this is non-NULL, vfree after init() returns */
	300	void *module_init;
	301
	302	/* Here is the actual code + data, vfree'd on unload. */
	303	void *module_core;
	304
	305	/* Here are the sizes of the init and core sections */
	306	unsigned long init_size, core_size;
	307
	308	/* The size of the executable code in each section. */
	309	unsigned long init_text_size, core_text_size;
	310
4552d5dc JB	311	/* The handle returned from unwind_add_table. */
	312	void *unwind_info;
	313
1da177e4 LT	314	/* Arch-specific module values */
	315	struct mod_arch_specific arch;
	316
	317	/* Am I unsafe to unload? */
	318	int unsafe;
	319
2bc2d61a RD	320	unsigned int taints; /* same bits as kernel:tainted */
2bc2d61a RD	321
7664c5a1 JF	322	#ifdef CONFIG_GENERIC_BUG
	323	/* Support for BUG */
	324	struct list_head bug_list;
	325	struct bug_entry *bug_table;
	326	unsigned num_bugs;
	327	#endif
	328
1da177e4 LT	329	#ifdef CONFIG_MODULE_UNLOAD
	330	/* Reference counts */
	331	struct module_ref ref[NR_CPUS];
	332
	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	#endif
	342
	343	#ifdef CONFIG_KALLSYMS
	344	/* We keep the symbol and string tables for kallsyms. */
	345	Elf_Sym *symtab;
	346	unsigned long num_symtab;
	347	char *strtab;
	348
	349	/* Section attributes */
	350	struct module_sect_attrs *sect_attrs;
	351	#endif
	352
	353	/* Per-cpu data. */
	354	void *percpu;
	355
	356	/* The command line arguments (may be mangled). People like
	357	keeping pointers to this stuff */
	358	char *args;
	359	};
	360
	361	/* FIXME: It'd be nice to isolate modules during init, too, so they
	362	aren't used before they (may) fail. But presently too much code
	363	(IDE & SCSI) require entry into the module during init.*/
	364	static inline int module_is_live(struct module *mod)
	365	{
	366	return mod->state != MODULE_STATE_GOING;
	367	}
	368
	369	/* Is this address in a module? (second is with no locks, for oops) */
	370	struct module *module_text_address(unsigned long addr);
	371	struct module *__module_text_address(unsigned long addr);
4d435f9d	372	int is_module_address(unsigned long addr);
1da177e4 LT	373
	374	/* Returns module and fills in value, defined and namebuf, or NULL if
	375	symnum out of range. */
098c5eea AG	376	struct module module_get_kallsym(unsigned int symnum, unsigned long value,
098c5eea AG	377	char type, char name, size_t namelen);
1da177e4 LT	378
	379	/* Look for this name: can be of form module:name. */
	380	unsigned long module_kallsyms_lookup_name(const char *name);
	381
	382	int is_exported(const char name, const struct module mod);
	383
	384	extern void __module_put_and_exit(struct module *mod, long code)
	385	__attribute__((noreturn));
	386	#define module_put_and_exit(code) __module_put_and_exit(THIS_MODULE, code);
	387
	388	#ifdef CONFIG_MODULE_UNLOAD
	389	unsigned int module_refcount(struct module *mod);
	390	void __symbol_put(const char *symbol);
	391	#define symbol_put(x) __symbol_put(MODULE_SYMBOL_PREFIX #x)
	392	void symbol_put_addr(void *addr);
	393
	394	/* Sometimes we know we already have a refcount, and it's easier not
	395	to handle the error case (which only happens with rmmod --wait). */
	396	static inline void __module_get(struct module *module)
	397	{
	398	if (module) {
	399	BUG_ON(module_refcount(module) == 0);
	400	local_inc(&module->ref[get_cpu()].count);
	401	put_cpu();
	402	}
	403	}
	404
	405	static inline int try_module_get(struct module *module)
	406	{
	407	int ret = 1;
	408
	409	if (module) {
	410	unsigned int cpu = get_cpu();
	411	if (likely(module_is_live(module)))
	412	local_inc(&module->ref[cpu].count);
	413	else
	414	ret = 0;
	415	put_cpu();
	416	}
	417	return ret;
	418	}
	419
f6a57033	420	extern void module_put(struct module *module);
1da177e4 LT	421
	422	#else /!CONFIG_MODULE_UNLOAD/
	423	static inline int try_module_get(struct module *module)
	424	{
	425	return !module \|\| module_is_live(module);
	426	}
	427	static inline void module_put(struct module *module)
	428	{
	429	}
	430	static inline void __module_get(struct module *module)
	431	{
	432	}
	433	#define symbol_put(x) do { } while(0)
	434	#define symbol_put_addr(p) do { } while(0)
	435
	436	#endif /* CONFIG_MODULE_UNLOAD */
	437
	438	/* This is a #define so the string doesn't get put in every .o file */
	439	#define module_name(mod) \
	440	({ \
	441	struct module *__mod = (mod); \
	442	__mod ? __mod->name : "kernel"; \
	443	})
	444
	445	#define __unsafe(mod) \
	446	do { \
	447	if (mod && !(mod)->unsafe) { \
	448	printk(KERN_WARNING \
	449	"Module %s cannot be unloaded due to unsafe usage in" \
	450	" %s:%u\n", (mod)->name, __FILE__, __LINE__); \
	451	(mod)->unsafe = 1; \
	452	} \
	453	} while(0)
	454
	455	/* For kallsyms to ask for address resolution. NULL means not found. */
	456	const char *module_address_lookup(unsigned long addr,
	457	unsigned long *symbolsize,
	458	unsigned long *offset,
	459	char **modname);
	460
	461	/* For extable.c to search modules' exception tables. */
	462	const struct exception_table_entry *search_module_extables(unsigned long addr);
	463
	464	int register_module_notifier(struct notifier_block * nb);
	465	int unregister_module_notifier(struct notifier_block * nb);
	466
	467	extern void print_modules(void);
	468
	469	struct device_driver;
	470	void module_add_driver(struct module , struct device_driver );
	471	void module_remove_driver(struct device_driver *);
	472
	473	#else /* !CONFIG_MODULES... */
	474	#define EXPORT_SYMBOL(sym)
	475	#define EXPORT_SYMBOL_GPL(sym)
9f28bb7e	476	#define EXPORT_SYMBOL_GPL_FUTURE(sym)
f71d20e9 AV	477	#define EXPORT_UNUSED_SYMBOL(sym)
f71d20e9 AV	478	#define EXPORT_UNUSED_SYMBOL_GPL(sym)
1da177e4 LT	479
	480	/* Given an address, look for it in the exception tables. */
	481	static inline const struct exception_table_entry *
	482	search_module_extables(unsigned long addr)
	483	{
	484	return NULL;
	485	}
	486
	487	/* Is this address in a module? */
	488	static inline struct module *module_text_address(unsigned long addr)
	489	{
	490	return NULL;
	491	}
	492
	493	/* Is this address in a module? (don't take a lock, we're oopsing) */
	494	static inline struct module *__module_text_address(unsigned long addr)
	495	{
	496	return NULL;
	497	}
	498
4d435f9d IM	499	static inline int is_module_address(unsigned long addr)
	500	{
	501	return 0;
	502	}
	503
1da177e4 LT	504	/* Get/put a kernel symbol (calls should be symmetric) */
	505	#define symbol_get(x) ({ extern typeof(x) x __attribute__((weak)); &(x); })
	506	#define symbol_put(x) do { } while(0)
	507	#define symbol_put_addr(x) do { } while(0)
	508
	509	static inline void __module_get(struct module *module)
	510	{
	511	}
	512
	513	static inline int try_module_get(struct module *module)
	514	{
	515	return 1;
	516	}
	517
	518	static inline void module_put(struct module *module)
	519	{
	520	}
	521
	522	#define module_name(mod) "kernel"
	523
	524	#define __unsafe(mod)
	525
	526	/* For kallsyms to ask for address resolution. NULL means not found. */
	527	static inline const char *module_address_lookup(unsigned long addr,
	528	unsigned long *symbolsize,
	529	unsigned long *offset,
	530	char **modname)
	531	{
	532	return NULL;
	533	}
	534
	535	static inline struct module *module_get_kallsym(unsigned int symnum,
	536	unsigned long *value,
098c5eea AG	537	char type, char name,
098c5eea AG	538	size_t namelen)
1da177e4 LT	539	{
	540	return NULL;
	541	}
	542
	543	static inline unsigned long module_kallsyms_lookup_name(const char *name)
	544	{
	545	return 0;
	546	}
	547
	548	static inline int is_exported(const char name, const struct module mod)
	549	{
	550	return 0;
	551	}
	552
	553	static inline int register_module_notifier(struct notifier_block * nb)
	554	{
	555	/* no events will happen anyway, so this can always succeed */
	556	return 0;
	557	}
	558
	559	static inline int unregister_module_notifier(struct notifier_block * nb)
	560	{
	561	return 0;
	562	}
	563
	564	#define module_put_and_exit(code) do_exit(code)
	565
	566	static inline void print_modules(void)
	567	{
	568	}
	569
	570	struct device_driver;
	571	struct module;
	572
	573	static inline void module_add_driver(struct module module, struct device_driver driver)
	574	{
	575	}
	576
	577	static inline void module_remove_driver(struct device_driver *driver)
	578	{
	579	}
	580
	581	#endif /* CONFIG_MODULES */
	582
	583	#define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x)
	584
	585	/* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */
	586
1da177e4 LT	587	#define __MODULE_STRING(x) __stringify(x)
1da177e4 LT	588
1da177e4	589	#endif /* _LINUX_MODULE_H */