module.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:13k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  * Dynamic loading of modules into the kernel.
  3.  *
  4.  * Rewritten by Richard Henderson <rth@tamu.edu> Dec 1996
  5.  */
  6. #ifndef _LINUX_MODULE_H
  7. #define _LINUX_MODULE_H
  8. #include <linux/config.h>
  9. #include <linux/spinlock.h>
  10. #include <linux/list.h>
  11. #ifdef __GENKSYMS__
  12. #  define _set_ver(sym) sym
  13. #  undef  MODVERSIONS
  14. #  define MODVERSIONS
  15. #else /* ! __GENKSYMS__ */
  16. # if !defined(MODVERSIONS) && defined(EXPORT_SYMTAB)
  17. #   define _set_ver(sym) sym
  18. #   include <linux/modversions.h>
  19. # endif
  20. #endif /* __GENKSYMS__ */
  21. #include <asm/atomic.h>
  22. /* Don't need to bring in all of uaccess.h just for this decl.  */
  23. struct exception_table_entry;
  24. /* Used by get_kernel_syms, which is obsolete.  */
  25. struct kernel_sym
  26. {
  27. unsigned long value;
  28. char name[60]; /* should have been 64-sizeof(long); oh well */
  29. };
  30. struct module_symbol
  31. {
  32. unsigned long value;
  33. const char *name;
  34. };
  35. struct module_ref
  36. {
  37. struct module *dep; /* "parent" pointer */
  38. struct module *ref; /* "child" pointer */
  39. struct module_ref *next_ref;
  40. };
  41. /* TBD */
  42. struct module_persist;
  43. struct module
  44. {
  45. unsigned long size_of_struct; /* == sizeof(module) */
  46. struct module *next;
  47. const char *name;
  48. unsigned long size;
  49. union
  50. {
  51. atomic_t usecount;
  52. long pad;
  53. } uc; /* Needs to keep its size - so says rth */
  54. unsigned long flags; /* AUTOCLEAN et al */
  55. unsigned nsyms;
  56. unsigned ndeps;
  57. struct module_symbol *syms;
  58. struct module_ref *deps;
  59. struct module_ref *refs;
  60. int (*init)(void);
  61. void (*cleanup)(void);
  62. const struct exception_table_entry *ex_table_start;
  63. const struct exception_table_entry *ex_table_end;
  64. #ifdef __alpha__
  65. unsigned long gp;
  66. #endif
  67. /* Members past this point are extensions to the basic
  68.    module support and are optional.  Use mod_member_present()
  69.    to examine them.  */
  70. const struct module_persist *persist_start;
  71. const struct module_persist *persist_end;
  72. int (*can_unload)(void);
  73. int runsize; /* In modutils, not currently used */
  74. const char *kallsyms_start; /* All symbols for kernel debugging */
  75. const char *kallsyms_end;
  76. const char *archdata_start; /* arch specific data for module */
  77. const char *archdata_end;
  78. const char *kernel_data; /* Reserved for kernel internal use */
  79. };
  80. struct module_info
  81. {
  82. unsigned long addr;
  83. unsigned long size;
  84. unsigned long flags;
  85. long usecount;
  86. };
  87. /* Bits of module.flags.  */
  88. #define MOD_UNINITIALIZED 0
  89. #define MOD_RUNNING 1
  90. #define MOD_DELETED 2
  91. #define MOD_AUTOCLEAN 4
  92. #define MOD_VISITED   8
  93. #define MOD_USED_ONCE 16
  94. #define MOD_JUST_FREED 32
  95. #define MOD_INITIALIZING 64
  96. /* Values for query_module's which.  */
  97. #define QM_MODULES 1
  98. #define QM_DEPS 2
  99. #define QM_REFS 3
  100. #define QM_SYMBOLS 4
  101. #define QM_INFO 5
  102. /* Can the module be queried? */
  103. #define MOD_CAN_QUERY(mod) (((mod)->flags & (MOD_RUNNING | MOD_INITIALIZING)) && !((mod)->flags & MOD_DELETED))
  104. /* When struct module is extended, we must test whether the new member
  105.    is present in the header received from insmod before we can use it.  
  106.    This function returns true if the member is present.  */
  107. #define mod_member_present(mod,member) 
  108. ((unsigned long)(&((struct module *)0L)->member + 1)
  109.  <= (mod)->size_of_struct)
  110. /*
  111.  * Ditto for archdata.  Assumes mod->archdata_start and mod->archdata_end
  112.  * are validated elsewhere.
  113.  */
  114. #define mod_archdata_member_present(mod, type, member)
  115. (((unsigned long)(&((type *)0L)->member) +
  116.   sizeof(((type *)0L)->member)) <=
  117.  ((mod)->archdata_end - (mod)->archdata_start))
  118.  
  119. /* Check if an address p with number of entries n is within the body of module m */
  120. #define mod_bound(p, n, m) ((unsigned long)(p) >= ((unsigned long)(m) + ((m)->size_of_struct)) && 
  121.          (unsigned long)((p)+(n)) <= (unsigned long)(m) + (m)->size)
  122. /* Backwards compatibility definition.  */
  123. #define GET_USE_COUNT(module) (atomic_read(&(module)->uc.usecount))
  124. /* Poke the use count of a module.  */
  125. #define __MOD_INC_USE_COUNT(mod)
  126. (atomic_inc(&(mod)->uc.usecount), (mod)->flags |= MOD_VISITED|MOD_USED_ONCE)
  127. #define __MOD_DEC_USE_COUNT(mod)
  128. (atomic_dec(&(mod)->uc.usecount), (mod)->flags |= MOD_VISITED)
  129. #define __MOD_IN_USE(mod)
  130. (mod_member_present((mod), can_unload) && (mod)->can_unload
  131.  ? (mod)->can_unload() : atomic_read(&(mod)->uc.usecount))
  132. /* Indirect stringification.  */
  133. #define __MODULE_STRING_1(x) #x
  134. #define __MODULE_STRING(x) __MODULE_STRING_1(x)
  135. /* Generic inter module communication.
  136.  *
  137.  * NOTE: This interface is intended for small amounts of data that are
  138.  *       passed between two objects and either or both of the objects
  139.  *       might be compiled as modules.  Do not over use this interface.
  140.  *
  141.  *       If more than two objects need to communicate then you probably
  142.  *       need a specific interface instead of abusing this generic
  143.  *       interface.  If both objects are *always* built into the kernel
  144.  *       then a global extern variable is good enough, you do not need
  145.  *       this interface.
  146.  *
  147.  * Keith Owens <kaos@ocs.com.au> 28 Oct 2000.
  148.  */
  149. #ifdef __KERNEL__
  150. #define HAVE_INTER_MODULE
  151. extern void inter_module_register(const char *, struct module *, const void *);
  152. extern void inter_module_unregister(const char *);
  153. extern const void *inter_module_get(const char *);
  154. extern const void *inter_module_get_request(const char *, const char *);
  155. extern void inter_module_put(const char *);
  156. struct inter_module_entry {
  157. struct list_head list;
  158. const char *im_name;
  159. struct module *owner;
  160. const void *userdata;
  161. };
  162. extern int try_inc_mod_count(struct module *mod);
  163. #endif /* __KERNEL__ */
  164. #if defined(MODULE) && !defined(__GENKSYMS__)
  165. /* Embedded module documentation macros.  */
  166. /* For documentation purposes only.  */
  167. #define MODULE_AUTHOR(name)    
  168. const char __module_author[] __attribute__((section(".modinfo"))) =     
  169. "author=" name
  170. #define MODULE_DESCRIPTION(desc)    
  171. const char __module_description[] __attribute__((section(".modinfo"))) =   
  172. "description=" desc
  173. /* Could potentially be used by kmod...  */
  174. #define MODULE_SUPPORTED_DEVICE(dev)    
  175. const char __module_device[] __attribute__((section(".modinfo"))) =     
  176. "device=" dev
  177. /* Used to verify parameters given to the module.  The TYPE arg should
  178.    be a string in the following format:
  179.     [min[-max]]{b,h,i,l,s}
  180.    The MIN and MAX specifiers delimit the length of the array.  If MAX
  181.    is omitted, it defaults to MIN; if both are omitted, the default is 1.
  182.    The final character is a type specifier:
  183. b byte
  184. h short
  185. i int
  186. l long
  187. s string
  188. */
  189. #define MODULE_PARM(var,type)
  190. const char __module_parm_##var[]
  191. __attribute__((section(".modinfo"))) =
  192. "parm_" __MODULE_STRING(var) "=" type
  193. #define MODULE_PARM_DESC(var,desc)
  194. const char __module_parm_desc_##var[]
  195. __attribute__((section(".modinfo"))) =
  196. "parm_desc_" __MODULE_STRING(var) "=" desc
  197. /*
  198.  * MODULE_DEVICE_TABLE exports information about devices
  199.  * currently supported by this module.  A device type, such as PCI,
  200.  * is a C-like identifier passed as the first arg to this macro.
  201.  * The second macro arg is the variable containing the device
  202.  * information being made public.
  203.  *
  204.  * The following is a list of known device types (arg 1),
  205.  * and the C types which are to be passed as arg 2.
  206.  * pci - struct pci_device_id - List of PCI ids supported by this module
  207.  * isapnp - struct isapnp_device_id - List of ISA PnP ids supported by this module
  208.  * usb - struct usb_device_id - List of USB ids supported by this module
  209.  */
  210. #define MODULE_GENERIC_TABLE(gtype,name)
  211. static const unsigned long __module_##gtype##_size 
  212.   __attribute__ ((unused)) = sizeof(struct gtype##_id); 
  213. static const struct gtype##_id * __module_##gtype##_table 
  214.   __attribute__ ((unused)) = name
  215. /*
  216.  * The following license idents are currently accepted as indicating free
  217.  * software modules
  218.  *
  219.  * "GPL" [GNU Public License v2 or later]
  220.  * "GPL v2" [GNU Public License v2]
  221.  * "GPL and additional rights" [GNU Public License v2 rights and more]
  222.  * "Dual BSD/GPL" [GNU Public License v2 or BSD license choice]
  223.  * "Dual MPL/GPL" [GNU Public License v2 or Mozilla license choice]
  224.  *
  225.  * The following other idents are available
  226.  *
  227.  * "Proprietary" [Non free products]
  228.  *
  229.  * There are dual licensed components, but when running with Linux it is the
  230.  * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL
  231.  * is a GPL combined work.
  232.  *
  233.  * This exists for several reasons
  234.  * 1. So modinfo can show license info for users wanting to vet their setup 
  235.  * is free
  236.  * 2. So the community can ignore bug reports including proprietary modules
  237.  * 3. So vendors can do likewise based on their own policies
  238.  */
  239.  
  240. #define MODULE_LICENSE(license) 
  241. static const char __module_license[] __attribute__((section(".modinfo"))) =   
  242. "license=" license
  243. /* Define the module variable, and usage macros.  */
  244. extern struct module __this_module;
  245. #define THIS_MODULE (&__this_module)
  246. #define MOD_INC_USE_COUNT __MOD_INC_USE_COUNT(THIS_MODULE)
  247. #define MOD_DEC_USE_COUNT __MOD_DEC_USE_COUNT(THIS_MODULE)
  248. #define MOD_IN_USE __MOD_IN_USE(THIS_MODULE)
  249. #include <linux/version.h>
  250. static const char __module_kernel_version[] __attribute__((section(".modinfo"))) =
  251. "kernel_version=" UTS_RELEASE;
  252. #ifdef MODVERSIONS
  253. static const char __module_using_checksums[] __attribute__((section(".modinfo"))) =
  254. "using_checksums=1";
  255. #endif
  256. #else /* MODULE */
  257. #define MODULE_AUTHOR(name)
  258. #define MODULE_LICENSE(license)
  259. #define MODULE_DESCRIPTION(desc)
  260. #define MODULE_SUPPORTED_DEVICE(name)
  261. #define MODULE_PARM(var,type)
  262. #define MODULE_PARM_DESC(var,desc)
  263. /* Create a dummy reference to the table to suppress gcc unused warnings.  Put
  264.  * the reference in the .data.exit section which is discarded when code is built
  265.  * in, so the reference does not bloat the running kernel.  Note: cannot be
  266.  * const, other exit data may be writable.
  267.  */
  268. #define MODULE_GENERIC_TABLE(gtype,name) 
  269. static const struct gtype##_id * __module_##gtype##_table 
  270.   __attribute__ ((unused, __section__(".data.exit"))) = name
  271. #ifndef __GENKSYMS__
  272. #define THIS_MODULE NULL
  273. #define MOD_INC_USE_COUNT do { } while (0)
  274. #define MOD_DEC_USE_COUNT do { } while (0)
  275. #define MOD_IN_USE 1
  276. extern struct module *module_list;
  277. #endif /* !__GENKSYMS__ */
  278. #endif /* MODULE */
  279. #define MODULE_DEVICE_TABLE(type,name)
  280.   MODULE_GENERIC_TABLE(type##_device,name)
  281. /* Export a symbol either from the kernel or a module.
  282.    In the kernel, the symbol is added to the kernel's global symbol table.
  283.    In a module, it controls which variables are exported.  If no
  284.    variables are explicitly exported, the action is controled by the
  285.    insmod -[xX] flags.  Otherwise, only the variables listed are exported.
  286.    This obviates the need for the old register_symtab() function.  */
  287. #if defined(__GENKSYMS__)
  288. /* We want the EXPORT_SYMBOL tag left intact for recognition.  */
  289. #elif !defined(AUTOCONF_INCLUDED)
  290. #define __EXPORT_SYMBOL(sym,str)   error config_must_be_included_before_module
  291. #define EXPORT_SYMBOL(var)    error config_must_be_included_before_module
  292. #define EXPORT_SYMBOL_NOVERS(var)  error config_must_be_included_before_module
  293. #define EXPORT_SYMBOL_GPL(var)  error config_must_be_included_before_module
  294. #elif !defined(CONFIG_MODULES)
  295. #define __EXPORT_SYMBOL(sym,str)
  296. #define EXPORT_SYMBOL(var)
  297. #define EXPORT_SYMBOL_NOVERS(var)
  298. #define EXPORT_SYMBOL_GPL(var)
  299. #elif !defined(EXPORT_SYMTAB)
  300. #define __EXPORT_SYMBOL(sym,str)   error this_object_must_be_defined_as_export_objs_in_the_Makefile
  301. #define EXPORT_SYMBOL(var)    error this_object_must_be_defined_as_export_objs_in_the_Makefile
  302. #define EXPORT_SYMBOL_NOVERS(var)  error this_object_must_be_defined_as_export_objs_in_the_Makefile
  303. #define EXPORT_SYMBOL_GPL(var)  error this_object_must_be_defined_as_export_objs_in_the_Makefile
  304. #else
  305. #define __EXPORT_SYMBOL(sym, str)
  306. const char __kstrtab_##sym[]
  307. __attribute__((section(".kstrtab"))) = str;
  308. const struct module_symbol __ksymtab_##sym 
  309. __attribute__((section("__ksymtab"))) =
  310. { (unsigned long)&sym, __kstrtab_##sym }
  311. #define __EXPORT_SYMBOL_GPL(sym, str)
  312. const char __kstrtab_##sym[]
  313. __attribute__((section(".kstrtab"))) = "GPLONLY_" str;
  314. const struct module_symbol __ksymtab_##sym
  315. __attribute__((section("__ksymtab"))) =
  316. { (unsigned long)&sym, __kstrtab_##sym }
  317. #if defined(MODVERSIONS) || !defined(CONFIG_MODVERSIONS)
  318. #define EXPORT_SYMBOL(var)  __EXPORT_SYMBOL(var, __MODULE_STRING(var))
  319. #define EXPORT_SYMBOL_GPL(var)  __EXPORT_SYMBOL_GPL(var, __MODULE_STRING(var))
  320. #else
  321. #define EXPORT_SYMBOL(var)  __EXPORT_SYMBOL(var, __MODULE_STRING(__VERSIONED_SYMBOL(var)))
  322. #define EXPORT_SYMBOL_GPL(var)  __EXPORT_SYMBOL(var, __MODULE_STRING(__VERSIONED_SYMBOL(var)))
  323. #endif
  324. #define EXPORT_SYMBOL_NOVERS(var)  __EXPORT_SYMBOL(var, __MODULE_STRING(var))
  325. #endif /* __GENKSYMS__ */
  326. #ifdef MODULE
  327. /* Force a module to export no symbols.  */
  328. #define EXPORT_NO_SYMBOLS  __asm__(".section __ksymtabn.previous")
  329. #else
  330. #define EXPORT_NO_SYMBOLS
  331. #endif /* MODULE */
  332. #ifdef CONFIG_MODULES
  333. #define SET_MODULE_OWNER(some_struct) do { (some_struct)->owner = THIS_MODULE; } while (0)
  334. #else
  335. #define SET_MODULE_OWNER(some_struct) do { } while (0)
  336. #endif
  337. #endif /* _LINUX_MODULE_H */