1bf49d9ddSMasahiro Yamada /* SPDX-License-Identifier: GPL-2.0-only */ 21da177e4SLinus Torvalds /* 31da177e4SLinus Torvalds * Dynamic loading of modules into the kernel. 41da177e4SLinus Torvalds * 51da177e4SLinus Torvalds * Rewritten by Richard Henderson <[email protected]> Dec 1996 61da177e4SLinus Torvalds * Rewritten again by Rusty Russell, 2002 71da177e4SLinus Torvalds */ 8bf49d9ddSMasahiro Yamada 9bf49d9ddSMasahiro Yamada #ifndef _LINUX_MODULE_H 10bf49d9ddSMasahiro Yamada #define _LINUX_MODULE_H 11bf49d9ddSMasahiro Yamada 121da177e4SLinus Torvalds #include <linux/list.h> 131da177e4SLinus Torvalds #include <linux/stat.h> 149294523eSStephen Boyd #include <linux/buildid.h> 151da177e4SLinus Torvalds #include <linux/compiler.h> 161da177e4SLinus Torvalds #include <linux/cache.h> 171da177e4SLinus Torvalds #include <linux/kmod.h> 180fd972a7SPaul Gortmaker #include <linux/init.h> 191da177e4SLinus Torvalds #include <linux/elf.h> 201da177e4SLinus Torvalds #include <linux/stringify.h> 211da177e4SLinus Torvalds #include <linux/kobject.h> 221da177e4SLinus Torvalds #include <linux/moduleparam.h> 23b2e285fcSSteven Rostedt (Red Hat) #include <linux/jump_label.h> 24f5016932SPaul Gortmaker #include <linux/export.h> 2593c2e105SPeter Zijlstra #include <linux/rbtree_latch.h> 26663faf9fSMasami Hiramatsu #include <linux/error-injection.h> 279c0be3f6SMathieu Desnoyers #include <linux/tracepoint-defs.h> 28fe15b50cSPaul E. McKenney #include <linux/srcu.h> 299183c3f9SJosh Poimboeuf #include <linux/static_call_types.h> 301da177e4SLinus Torvalds 31e1783a24SChristoph Lameter #include <linux/percpu.h> 321da177e4SLinus Torvalds #include <asm/module.h> 331da177e4SLinus Torvalds 34730b69d2SRusty Russell #define MODULE_NAME_LEN MAX_PARAM_PREFIX_LEN 351da177e4SLinus Torvalds 36e865d06bSSeunghun Lee struct modversion_info { 371da177e4SLinus Torvalds unsigned long crc; 381da177e4SLinus Torvalds char name[MODULE_NAME_LEN]; 391da177e4SLinus Torvalds }; 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds struct module; 420ef76537SPaul Gortmaker struct exception_table_entry; 431da177e4SLinus Torvalds 444befb026SKay Sievers struct module_kobject { 454befb026SKay Sievers struct kobject kobj; 464befb026SKay Sievers struct module *mod; 474befb026SKay Sievers struct kobject *drivers_dir; 484befb026SKay Sievers struct module_param_attrs *mp; 49942e4431SLi Zhong struct completion *kobj_completion; 503859a271SKees Cook } __randomize_layout; 514befb026SKay Sievers 521da177e4SLinus Torvalds struct module_attribute { 531da177e4SLinus Torvalds struct attribute attr; 544befb026SKay Sievers ssize_t (*show)(struct module_attribute *, struct module_kobject *, 554befb026SKay Sievers char *); 564befb026SKay Sievers ssize_t (*store)(struct module_attribute *, struct module_kobject *, 571da177e4SLinus Torvalds const char *, size_t count); 58c988d2b2SMatt Domsch void (*setup)(struct module *, const char *); 59c988d2b2SMatt Domsch int (*test)(struct module *); 60c988d2b2SMatt Domsch void (*free)(struct module *); 611da177e4SLinus Torvalds }; 621da177e4SLinus Torvalds 63e94965edSDmitry Torokhov struct module_version_attribute { 64e94965edSDmitry Torokhov struct module_attribute mattr; 65e94965edSDmitry Torokhov const char *module_name; 66e94965edSDmitry Torokhov const char *version; 670801a007SJohan Hovold }; 68e94965edSDmitry Torokhov 699b73a584SDmitry Torokhov extern ssize_t __modver_version_show(struct module_attribute *, 704befb026SKay Sievers struct module_kobject *, char *); 719b73a584SDmitry Torokhov 7288bfa324SKay Sievers extern struct module_attribute module_uevent; 731da177e4SLinus Torvalds 741da177e4SLinus Torvalds /* These are either module local, or the kernel's dummy ones. */ 751da177e4SLinus Torvalds extern int init_module(void); 761da177e4SLinus Torvalds extern void cleanup_module(void); 771da177e4SLinus Torvalds 780fd972a7SPaul Gortmaker #ifndef MODULE 790fd972a7SPaul Gortmaker /** 800fd972a7SPaul Gortmaker * module_init() - driver initialization entry point 810fd972a7SPaul Gortmaker * @x: function to be run at kernel boot time or module insertion 820fd972a7SPaul Gortmaker * 830fd972a7SPaul Gortmaker * module_init() will either be called during do_initcalls() (if 840fd972a7SPaul Gortmaker * builtin) or at module insertion time (if a module). There can only 850fd972a7SPaul Gortmaker * be one per module. 860fd972a7SPaul Gortmaker */ 870fd972a7SPaul Gortmaker #define module_init(x) __initcall(x); 880fd972a7SPaul Gortmaker 890fd972a7SPaul Gortmaker /** 900fd972a7SPaul Gortmaker * module_exit() - driver exit entry point 910fd972a7SPaul Gortmaker * @x: function to be run when driver is removed 920fd972a7SPaul Gortmaker * 930fd972a7SPaul Gortmaker * module_exit() will wrap the driver clean-up code 940fd972a7SPaul Gortmaker * with cleanup_module() when used with rmmod when 950fd972a7SPaul Gortmaker * the driver is a module. If the driver is statically 960fd972a7SPaul Gortmaker * compiled into the kernel, module_exit() has no effect. 970fd972a7SPaul Gortmaker * There can only be one per module. 980fd972a7SPaul Gortmaker */ 990fd972a7SPaul Gortmaker #define module_exit(x) __exitcall(x); 1000fd972a7SPaul Gortmaker 1010fd972a7SPaul Gortmaker #else /* MODULE */ 1020fd972a7SPaul Gortmaker 1030fd972a7SPaul Gortmaker /* 1040fd972a7SPaul Gortmaker * In most cases loadable modules do not need custom 1050fd972a7SPaul Gortmaker * initcall levels. There are still some valid cases where 1060fd972a7SPaul Gortmaker * a driver may be needed early if built in, and does not 1070fd972a7SPaul Gortmaker * matter when built as a loadable module. Like bus 1080fd972a7SPaul Gortmaker * snooping debug drivers. 1090fd972a7SPaul Gortmaker */ 1100fd972a7SPaul Gortmaker #define early_initcall(fn) module_init(fn) 1110fd972a7SPaul Gortmaker #define core_initcall(fn) module_init(fn) 1120fd972a7SPaul Gortmaker #define core_initcall_sync(fn) module_init(fn) 1130fd972a7SPaul Gortmaker #define postcore_initcall(fn) module_init(fn) 1140fd972a7SPaul Gortmaker #define postcore_initcall_sync(fn) module_init(fn) 1150fd972a7SPaul Gortmaker #define arch_initcall(fn) module_init(fn) 1160fd972a7SPaul Gortmaker #define subsys_initcall(fn) module_init(fn) 1170fd972a7SPaul Gortmaker #define subsys_initcall_sync(fn) module_init(fn) 1180fd972a7SPaul Gortmaker #define fs_initcall(fn) module_init(fn) 1190fd972a7SPaul Gortmaker #define fs_initcall_sync(fn) module_init(fn) 1200fd972a7SPaul Gortmaker #define rootfs_initcall(fn) module_init(fn) 1210fd972a7SPaul Gortmaker #define device_initcall(fn) module_init(fn) 1220fd972a7SPaul Gortmaker #define device_initcall_sync(fn) module_init(fn) 1230fd972a7SPaul Gortmaker #define late_initcall(fn) module_init(fn) 1240fd972a7SPaul Gortmaker #define late_initcall_sync(fn) module_init(fn) 1250fd972a7SPaul Gortmaker 1260fd972a7SPaul Gortmaker #define console_initcall(fn) module_init(fn) 1270fd972a7SPaul Gortmaker 1280fd972a7SPaul Gortmaker /* Each module must use one module_init(). */ 1290fd972a7SPaul Gortmaker #define module_init(initfn) \ 1301f318a8bSArnd Bergmann static inline initcall_t __maybe_unused __inittest(void) \ 1310fd972a7SPaul Gortmaker { return initfn; } \ 132cf68fffbSSami Tolvanen int init_module(void) __copy(initfn) \ 133cf68fffbSSami Tolvanen __attribute__((alias(#initfn))); \ 13492efda8eSSami Tolvanen ___ADDRESSABLE(init_module, __initdata); 1350fd972a7SPaul Gortmaker 1360fd972a7SPaul Gortmaker /* This is only required if you want to be unloadable. */ 1370fd972a7SPaul Gortmaker #define module_exit(exitfn) \ 1381f318a8bSArnd Bergmann static inline exitcall_t __maybe_unused __exittest(void) \ 1390fd972a7SPaul Gortmaker { return exitfn; } \ 140cf68fffbSSami Tolvanen void cleanup_module(void) __copy(exitfn) \ 141cf68fffbSSami Tolvanen __attribute__((alias(#exitfn))); \ 14292efda8eSSami Tolvanen ___ADDRESSABLE(cleanup_module, __exitdata); 1430fd972a7SPaul Gortmaker 1440fd972a7SPaul Gortmaker #endif 1450fd972a7SPaul Gortmaker 1460fd972a7SPaul Gortmaker /* This means "can be init if no module support, otherwise module load 1470fd972a7SPaul Gortmaker may call it." */ 1480fd972a7SPaul Gortmaker #ifdef CONFIG_MODULES 1490fd972a7SPaul Gortmaker #define __init_or_module 1500fd972a7SPaul Gortmaker #define __initdata_or_module 1510fd972a7SPaul Gortmaker #define __initconst_or_module 1520fd972a7SPaul Gortmaker #define __INIT_OR_MODULE .text 1530fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE .data 1540fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE .section ".rodata","a",%progbits 1550fd972a7SPaul Gortmaker #else 1560fd972a7SPaul Gortmaker #define __init_or_module __init 1570fd972a7SPaul Gortmaker #define __initdata_or_module __initdata 1580fd972a7SPaul Gortmaker #define __initconst_or_module __initconst 1590fd972a7SPaul Gortmaker #define __INIT_OR_MODULE __INIT 1600fd972a7SPaul Gortmaker #define __INITDATA_OR_MODULE __INITDATA 1610fd972a7SPaul Gortmaker #define __INITRODATA_OR_MODULE __INITRODATA 1620fd972a7SPaul Gortmaker #endif /*CONFIG_MODULES*/ 1630fd972a7SPaul Gortmaker 1641da177e4SLinus Torvalds /* Generic info of form tag = "info" */ 1651da177e4SLinus Torvalds #define MODULE_INFO(tag, info) __MODULE_INFO(tag, tag, info) 1661da177e4SLinus Torvalds 1671da177e4SLinus Torvalds /* For userspace: you can also call me... */ 1681da177e4SLinus Torvalds #define MODULE_ALIAS(_alias) MODULE_INFO(alias, _alias) 1691da177e4SLinus Torvalds 1707cb14ba7SAndreas Robinson /* Soft module dependencies. See man modprobe.d for details. 1717cb14ba7SAndreas Robinson * Example: MODULE_SOFTDEP("pre: module-foo module-bar post: module-baz") 1727cb14ba7SAndreas Robinson */ 1737cb14ba7SAndreas Robinson #define MODULE_SOFTDEP(_softdep) MODULE_INFO(softdep, _softdep) 1747cb14ba7SAndreas Robinson 1751da177e4SLinus Torvalds /* 1768b41fc44SMasahiro Yamada * MODULE_FILE is used for generating modules.builtin 1778b41fc44SMasahiro Yamada * So, make it no-op when this is being built as a module 1788b41fc44SMasahiro Yamada */ 1798b41fc44SMasahiro Yamada #ifdef MODULE 1808b41fc44SMasahiro Yamada #define MODULE_FILE 1818b41fc44SMasahiro Yamada #else 1828b41fc44SMasahiro Yamada #define MODULE_FILE MODULE_INFO(file, KBUILD_MODFILE); 1838b41fc44SMasahiro Yamada #endif 1848b41fc44SMasahiro Yamada 1858b41fc44SMasahiro Yamada /* 1861da177e4SLinus Torvalds * The following license idents are currently accepted as indicating free 1871da177e4SLinus Torvalds * software modules 1881da177e4SLinus Torvalds * 189bf7fbeeaSThomas Gleixner * "GPL" [GNU Public License v2] 1901da177e4SLinus Torvalds * "GPL v2" [GNU Public License v2] 1911da177e4SLinus Torvalds * "GPL and additional rights" [GNU Public License v2 rights and more] 1921da177e4SLinus Torvalds * "Dual BSD/GPL" [GNU Public License v2 1931da177e4SLinus Torvalds * or BSD license choice] 1948d27e908SXose Vazquez Perez * "Dual MIT/GPL" [GNU Public License v2 1958d27e908SXose Vazquez Perez * or MIT license choice] 1961da177e4SLinus Torvalds * "Dual MPL/GPL" [GNU Public License v2 1971da177e4SLinus Torvalds * or Mozilla license choice] 1981da177e4SLinus Torvalds * 1991da177e4SLinus Torvalds * The following other idents are available 2001da177e4SLinus Torvalds * 2011da177e4SLinus Torvalds * "Proprietary" [Non free products] 2021da177e4SLinus Torvalds * 203bf7fbeeaSThomas Gleixner * Both "GPL v2" and "GPL" (the latter also in dual licensed strings) are 204bf7fbeeaSThomas Gleixner * merely stating that the module is licensed under the GPL v2, but are not 205bf7fbeeaSThomas Gleixner * telling whether "GPL v2 only" or "GPL v2 or later". The reason why there 206bf7fbeeaSThomas Gleixner * are two variants is a historic and failed attempt to convey more 207bf7fbeeaSThomas Gleixner * information in the MODULE_LICENSE string. For module loading the 208bf7fbeeaSThomas Gleixner * "only/or later" distinction is completely irrelevant and does neither 209bf7fbeeaSThomas Gleixner * replace the proper license identifiers in the corresponding source file 210bf7fbeeaSThomas Gleixner * nor amends them in any way. The sole purpose is to make the 211bf7fbeeaSThomas Gleixner * 'Proprietary' flagging work and to refuse to bind symbols which are 212bf7fbeeaSThomas Gleixner * exported with EXPORT_SYMBOL_GPL when a non free module is loaded. 213bf7fbeeaSThomas Gleixner * 214bf7fbeeaSThomas Gleixner * In the same way "BSD" is not a clear license information. It merely 215bf7fbeeaSThomas Gleixner * states, that the module is licensed under one of the compatible BSD 216bf7fbeeaSThomas Gleixner * license variants. The detailed and correct license information is again 217bf7fbeeaSThomas Gleixner * to be found in the corresponding source files. 218bf7fbeeaSThomas Gleixner * 2191da177e4SLinus Torvalds * There are dual licensed components, but when running with Linux it is the 2201da177e4SLinus Torvalds * GPL that is relevant so this is a non issue. Similarly LGPL linked with GPL 2211da177e4SLinus Torvalds * is a GPL combined work. 2221da177e4SLinus Torvalds * 2231da177e4SLinus Torvalds * This exists for several reasons 2241da177e4SLinus Torvalds * 1. So modinfo can show license info for users wanting to vet their setup 2251da177e4SLinus Torvalds * is free 2261da177e4SLinus Torvalds * 2. So the community can ignore bug reports including proprietary modules 2271da177e4SLinus Torvalds * 3. So vendors can do likewise based on their own policies 2281da177e4SLinus Torvalds */ 2298b41fc44SMasahiro Yamada #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license) 2301da177e4SLinus Torvalds 2311d7015caSJohannes Berg /* 2321d7015caSJohannes Berg * Author(s), use "Name <email>" or just "Name", for multiple 2331d7015caSJohannes Berg * authors use multiple MODULE_AUTHOR() statements/lines. 2341d7015caSJohannes Berg */ 2351da177e4SLinus Torvalds #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author) 2361da177e4SLinus Torvalds 2371da177e4SLinus Torvalds /* What your module does. */ 2381da177e4SLinus Torvalds #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description) 2391da177e4SLinus Torvalds 240cff26a51SRusty Russell #ifdef MODULE 241cff26a51SRusty Russell /* Creates an alias so file2alias.c can find device table. */ 2421da177e4SLinus Torvalds #define MODULE_DEVICE_TABLE(type, name) \ 2430bf8bf50SMatthias Kaehlcke extern typeof(name) __mod_##type##__##name##_device_table \ 244cff26a51SRusty Russell __attribute__ ((unused, alias(__stringify(name)))) 245cff26a51SRusty Russell #else /* !MODULE */ 246cff26a51SRusty Russell #define MODULE_DEVICE_TABLE(type, name) 247cff26a51SRusty Russell #endif 2481da177e4SLinus Torvalds 2491da177e4SLinus Torvalds /* Version of form [<epoch>:]<version>[-<extra-version>]. 250e865d06bSSeunghun Lee * Or for CVS/RCS ID version, everything but the number is stripped. 251e865d06bSSeunghun Lee * <epoch>: A (small) unsigned integer which allows you to start versions 252e865d06bSSeunghun Lee * anew. If not mentioned, it's zero. eg. "2:1.0" is after 253e865d06bSSeunghun Lee * "1:2.0". 2541da177e4SLinus Torvalds 255e865d06bSSeunghun Lee * <version>: The <version> may contain only alphanumerics and the 256e865d06bSSeunghun Lee * character `.'. Ordered by numeric sort for numeric parts, 257e865d06bSSeunghun Lee * ascii sort for ascii parts (as per RPM or DEB algorithm). 258e865d06bSSeunghun Lee 259e865d06bSSeunghun Lee * <extraversion>: Like <version>, but inserted for local 260e865d06bSSeunghun Lee * customizations, eg "rh3" or "rusty1". 261e865d06bSSeunghun Lee 262e865d06bSSeunghun Lee * Using this automatically adds a checksum of the .c files and the 263e865d06bSSeunghun Lee * local headers in "srcversion". 2641da177e4SLinus Torvalds */ 265e94965edSDmitry Torokhov 2663b90a5b2SRusty Russell #if defined(MODULE) || !defined(CONFIG_SYSFS) 2671da177e4SLinus Torvalds #define MODULE_VERSION(_version) MODULE_INFO(version, _version) 268e94965edSDmitry Torokhov #else 269e94965edSDmitry Torokhov #define MODULE_VERSION(_version) \ 270898490c0SAlexey Gladkov MODULE_INFO(version, _version); \ 271b112082cSJohan Hovold static struct module_version_attribute __modver_attr \ 272b112082cSJohan Hovold __used __section("__modver") \ 273b112082cSJohan Hovold __aligned(__alignof__(struct module_version_attribute)) \ 274b112082cSJohan Hovold = { \ 275e94965edSDmitry Torokhov .mattr = { \ 276e94965edSDmitry Torokhov .attr = { \ 277e94965edSDmitry Torokhov .name = "version", \ 278e94965edSDmitry Torokhov .mode = S_IRUGO, \ 279e94965edSDmitry Torokhov }, \ 280e94965edSDmitry Torokhov .show = __modver_version_show, \ 281e94965edSDmitry Torokhov }, \ 282e94965edSDmitry Torokhov .module_name = KBUILD_MODNAME, \ 283e94965edSDmitry Torokhov .version = _version, \ 2842d26c716SJohan Hovold } 285e94965edSDmitry Torokhov #endif 2861da177e4SLinus Torvalds 287187afbedSJon Masters /* Optional firmware file (or files) needed by the module 288187afbedSJon Masters * format is simply firmware file name. Multiple firmware 289187afbedSJon Masters * files require multiple MODULE_FIRMWARE() specifiers */ 290187afbedSJon Masters #define MODULE_FIRMWARE(_firmware) MODULE_INFO(firmware, _firmware) 291187afbedSJon Masters 29280140a81SGreg Kroah-Hartman #define MODULE_IMPORT_NS(ns) MODULE_INFO(import_ns, __stringify(ns)) 2933e4d890aSLinus Torvalds 2941da177e4SLinus Torvalds struct notifier_block; 2951da177e4SLinus Torvalds 2961da177e4SLinus Torvalds #ifdef CONFIG_MODULES 2971da177e4SLinus Torvalds 2985ed10910SDave Young extern int modules_disabled; /* for sysctl */ 2991da177e4SLinus Torvalds /* Get/put a kernel symbol (calls must be symmetric) */ 3001da177e4SLinus Torvalds void *__symbol_get(const char *symbol); 3011da177e4SLinus Torvalds void *__symbol_get_gpl(const char *symbol); 302996302c5SMasahiro Yamada #define symbol_get(x) ((typeof(&x))(__symbol_get(__stringify(x)))) 3031da177e4SLinus Torvalds 304c8e21cedSRusty Russell /* modules using other modules: kdb wants to see this. */ 305c8e21cedSRusty Russell struct module_use { 306c8e21cedSRusty Russell struct list_head source_list; 307c8e21cedSRusty Russell struct list_head target_list; 308c8e21cedSRusty Russell struct module *source, *target; 309c8e21cedSRusty Russell }; 310c8e21cedSRusty Russell 3110d21b0e3SRusty Russell enum module_state { 3120d21b0e3SRusty Russell MODULE_STATE_LIVE, /* Normal state. */ 3130d21b0e3SRusty Russell MODULE_STATE_COMING, /* Full formed, running module_init. */ 3140d21b0e3SRusty Russell MODULE_STATE_GOING, /* Going away. */ 3150d21b0e3SRusty Russell MODULE_STATE_UNFORMED, /* Still setting it up. */ 3161da177e4SLinus Torvalds }; 3171da177e4SLinus Torvalds 31893c2e105SPeter Zijlstra struct mod_tree_node { 31993c2e105SPeter Zijlstra struct module *mod; 32093c2e105SPeter Zijlstra struct latch_tree_node node; 32193c2e105SPeter Zijlstra }; 32293c2e105SPeter Zijlstra 323ac3b4328SSong Liu enum mod_mem_type { 324ac3b4328SSong Liu MOD_TEXT = 0, 325ac3b4328SSong Liu MOD_DATA, 326ac3b4328SSong Liu MOD_RODATA, 327ac3b4328SSong Liu MOD_RO_AFTER_INIT, 328ac3b4328SSong Liu MOD_INIT_TEXT, 329ac3b4328SSong Liu MOD_INIT_DATA, 330ac3b4328SSong Liu MOD_INIT_RODATA, 331ac3b4328SSong Liu 332ac3b4328SSong Liu MOD_MEM_NUM_TYPES, 333ac3b4328SSong Liu MOD_INVALID = -1, 334ac3b4328SSong Liu }; 335ac3b4328SSong Liu 336ac3b4328SSong Liu #define mod_mem_type_is_init(type) \ 337ac3b4328SSong Liu ((type) == MOD_INIT_TEXT || \ 338ac3b4328SSong Liu (type) == MOD_INIT_DATA || \ 339ac3b4328SSong Liu (type) == MOD_INIT_RODATA) 340ac3b4328SSong Liu 341ac3b4328SSong Liu #define mod_mem_type_is_core(type) (!mod_mem_type_is_init(type)) 342ac3b4328SSong Liu 343ac3b4328SSong Liu #define mod_mem_type_is_text(type) \ 344ac3b4328SSong Liu ((type) == MOD_TEXT || \ 345ac3b4328SSong Liu (type) == MOD_INIT_TEXT) 346ac3b4328SSong Liu 347ac3b4328SSong Liu #define mod_mem_type_is_data(type) (!mod_mem_type_is_text(type)) 348ac3b4328SSong Liu 349ac3b4328SSong Liu #define mod_mem_type_is_core_data(type) \ 350ac3b4328SSong Liu (mod_mem_type_is_core(type) && \ 351ac3b4328SSong Liu mod_mem_type_is_data(type)) 352ac3b4328SSong Liu 353ac3b4328SSong Liu #define for_each_mod_mem_type(type) \ 354ac3b4328SSong Liu for (enum mod_mem_type (type) = 0; \ 355ac3b4328SSong Liu (type) < MOD_MEM_NUM_TYPES; (type)++) 356ac3b4328SSong Liu 357ac3b4328SSong Liu #define for_class_mod_mem_type(type, class) \ 358ac3b4328SSong Liu for_each_mod_mem_type(type) \ 359ac3b4328SSong Liu if (mod_mem_type_is_##class(type)) 360ac3b4328SSong Liu 361ac3b4328SSong Liu struct module_memory { 3627523e4dcSRusty Russell void *base; 3637523e4dcSRusty Russell unsigned int size; 3647523e4dcSRusty Russell 3657523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP 3667523e4dcSRusty Russell struct mod_tree_node mtn; 3677523e4dcSRusty Russell #endif 3687523e4dcSRusty Russell }; 3697523e4dcSRusty Russell 3707523e4dcSRusty Russell #ifdef CONFIG_MODULES_TREE_LOOKUP 3717523e4dcSRusty Russell /* Only touch one cacheline for common rbtree-for-core-layout case. */ 372ac3b4328SSong Liu #define __module_memory_align ____cacheline_aligned 3737523e4dcSRusty Russell #else 374ac3b4328SSong Liu #define __module_memory_align 3757523e4dcSRusty Russell #endif 3767523e4dcSRusty Russell 3778244062eSRusty Russell struct mod_kallsyms { 3788244062eSRusty Russell Elf_Sym *symtab; 3798244062eSRusty Russell unsigned int num_symtab; 3808244062eSRusty Russell char *strtab; 3811c7651f4SEugene Loh char *typetab; 3828244062eSRusty Russell }; 3838244062eSRusty Russell 3841ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH 385eca0edafSMarcos Paulo de Souza /** 386eca0edafSMarcos Paulo de Souza * struct klp_modinfo - Elf information preserved from the livepatch module 387eca0edafSMarcos Paulo de Souza * 388eca0edafSMarcos Paulo de Souza * @hdr: Elf header 389eca0edafSMarcos Paulo de Souza * @sechdrs: Section header table 390eca0edafSMarcos Paulo de Souza * @secstrings: String table for the section headers 391eca0edafSMarcos Paulo de Souza * @symndx: The symbol table section index 392eca0edafSMarcos Paulo de Souza */ 3931ce15ef4SJessica Yu struct klp_modinfo { 3941ce15ef4SJessica Yu Elf_Ehdr hdr; 3951ce15ef4SJessica Yu Elf_Shdr *sechdrs; 3961ce15ef4SJessica Yu char *secstrings; 3971ce15ef4SJessica Yu unsigned int symndx; 3981ce15ef4SJessica Yu }; 3991ce15ef4SJessica Yu #endif 4001ce15ef4SJessica Yu 401e865d06bSSeunghun Lee struct module { 4021da177e4SLinus Torvalds enum module_state state; 4031da177e4SLinus Torvalds 4041da177e4SLinus Torvalds /* Member of list of modules */ 4051da177e4SLinus Torvalds struct list_head list; 4061da177e4SLinus Torvalds 4071da177e4SLinus Torvalds /* Unique handle for this module */ 4081da177e4SLinus Torvalds char name[MODULE_NAME_LEN]; 4091da177e4SLinus Torvalds 4109294523eSStephen Boyd #ifdef CONFIG_STACKTRACE_BUILD_ID 4119294523eSStephen Boyd /* Module build ID */ 4129294523eSStephen Boyd unsigned char build_id[BUILD_ID_SIZE_MAX]; 4139294523eSStephen Boyd #endif 4149294523eSStephen Boyd 4151da177e4SLinus Torvalds /* Sysfs stuff. */ 4161da177e4SLinus Torvalds struct module_kobject mkobj; 41703e88ae1SGreg Kroah-Hartman struct module_attribute *modinfo_attrs; 418c988d2b2SMatt Domsch const char *version; 419c988d2b2SMatt Domsch const char *srcversion; 420270a6c4cSKay Sievers struct kobject *holders_dir; 4211da177e4SLinus Torvalds 4221da177e4SLinus Torvalds /* Exported symbols */ 4231da177e4SLinus Torvalds const struct kernel_symbol *syms; 42471810db2SArd Biesheuvel const s32 *crcs; 425af540689SRichard Kennedy unsigned int num_syms; 4261da177e4SLinus Torvalds 42789245600SSami Tolvanen #ifdef CONFIG_ARCH_USES_CFI_TRAPS 42889245600SSami Tolvanen s32 *kcfi_traps; 42989245600SSami Tolvanen s32 *kcfi_traps_end; 430cf68fffbSSami Tolvanen #endif 431cf68fffbSSami Tolvanen 432e180a6b7SRusty Russell /* Kernel parameters. */ 433cf2fde7bSRusty Russell #ifdef CONFIG_SYSFS 434b51d23e4SDan Streetman struct mutex param_lock; 435cf2fde7bSRusty Russell #endif 436e180a6b7SRusty Russell struct kernel_param *kp; 437e180a6b7SRusty Russell unsigned int num_kp; 438e180a6b7SRusty Russell 4391da177e4SLinus Torvalds /* GPL-only exported symbols. */ 4401da177e4SLinus Torvalds unsigned int num_gpl_syms; 441af540689SRichard Kennedy const struct kernel_symbol *gpl_syms; 44271810db2SArd Biesheuvel const s32 *gpl_crcs; 443262e6ae7SChristoph Hellwig bool using_gplonly_symbols; 4441da177e4SLinus Torvalds 445106a4ee2SRusty Russell #ifdef CONFIG_MODULE_SIG 446106a4ee2SRusty Russell /* Signature was verified. */ 447106a4ee2SRusty Russell bool sig_ok; 448106a4ee2SRusty Russell #endif 449106a4ee2SRusty Russell 450f2411da7SLuis R. Rodriguez bool async_probe_requested; 451f2411da7SLuis R. Rodriguez 4521da177e4SLinus Torvalds /* Exception table */ 4531da177e4SLinus Torvalds unsigned int num_exentries; 4545e458cc0SRusty Russell struct exception_table_entry *extable; 4551da177e4SLinus Torvalds 4561da177e4SLinus Torvalds /* Startup function. */ 4571da177e4SLinus Torvalds int (*init)(void); 4581da177e4SLinus Torvalds 459ac3b4328SSong Liu struct module_memory mem[MOD_MEM_NUM_TYPES] __module_memory_align; 46084e1c6bbSmatthieu castet 4611da177e4SLinus Torvalds /* Arch-specific module values */ 4621da177e4SLinus Torvalds struct mod_arch_specific arch; 4631da177e4SLinus Torvalds 4647fd8329bSPetr Mladek unsigned long taints; /* same bits as kernel:taint_flags */ 4652bc2d61aSRandy Dunlap 4667664c5a1SJeremy Fitzhardinge #ifdef CONFIG_GENERIC_BUG 4677664c5a1SJeremy Fitzhardinge /* Support for BUG */ 468af540689SRichard Kennedy unsigned num_bugs; 4697664c5a1SJeremy Fitzhardinge struct list_head bug_list; 4707664c5a1SJeremy Fitzhardinge struct bug_entry *bug_table; 4711da177e4SLinus Torvalds #endif 4721da177e4SLinus Torvalds 4731da177e4SLinus Torvalds #ifdef CONFIG_KALLSYMS 4748244062eSRusty Russell /* Protected by RCU and/or module_mutex: use rcu_dereference() */ 4756080d608SMadhuparna Bhowmik struct mod_kallsyms __rcu *kallsyms; 4768244062eSRusty Russell struct mod_kallsyms core_kallsyms; 4771da177e4SLinus Torvalds 4781da177e4SLinus Torvalds /* Section attributes */ 4791da177e4SLinus Torvalds struct module_sect_attrs *sect_attrs; 4806d760133SRoland McGrath 4816d760133SRoland McGrath /* Notes attributes */ 4826d760133SRoland McGrath struct module_notes_attrs *notes_attrs; 4831da177e4SLinus Torvalds #endif 4841da177e4SLinus Torvalds 485a288bd65SRichard Kennedy /* The command line arguments (may be mangled). People like 486a288bd65SRichard Kennedy keeping pointers to this stuff */ 487a288bd65SRichard Kennedy char *args; 488a288bd65SRichard Kennedy 489259354deSTejun Heo #ifdef CONFIG_SMP 4901da177e4SLinus Torvalds /* Per-cpu data. */ 491259354deSTejun Heo void __percpu *percpu; 492259354deSTejun Heo unsigned int percpu_size; 493259354deSTejun Heo #endif 49466e9b071SThomas Gleixner void *noinstr_text_start; 49566e9b071SThomas Gleixner unsigned int noinstr_text_size; 4961da177e4SLinus Torvalds 49797e1c18eSMathieu Desnoyers #ifdef CONFIG_TRACEPOINTS 49897e1c18eSMathieu Desnoyers unsigned int num_tracepoints; 4999c0be3f6SMathieu Desnoyers tracepoint_ptr_t *tracepoints_ptrs; 50097e1c18eSMathieu Desnoyers #endif 501fe15b50cSPaul E. McKenney #ifdef CONFIG_TREE_SRCU 502fe15b50cSPaul E. McKenney unsigned int num_srcu_structs; 503fe15b50cSPaul E. McKenney struct srcu_struct **srcu_struct_ptrs; 504fe15b50cSPaul E. McKenney #endif 505a38d1107SMatt Mullins #ifdef CONFIG_BPF_EVENTS 506a38d1107SMatt Mullins unsigned int num_bpf_raw_events; 507a38d1107SMatt Mullins struct bpf_raw_event_map *bpf_raw_events; 508a38d1107SMatt Mullins #endif 50936e68442SAndrii Nakryiko #ifdef CONFIG_DEBUG_INFO_BTF_MODULES 51036e68442SAndrii Nakryiko unsigned int btf_data_size; 51136e68442SAndrii Nakryiko void *btf_data; 51236e68442SAndrii Nakryiko #endif 513e9666d10SMasahiro Yamada #ifdef CONFIG_JUMP_LABEL 514bf5438fcSJason Baron struct jump_entry *jump_entries; 515bf5438fcSJason Baron unsigned int num_jump_entries; 516bf5438fcSJason Baron #endif 517769b0441SFrederic Weisbecker #ifdef CONFIG_TRACING 5181ba28e02SLai Jiangshan unsigned int num_trace_bprintk_fmt; 519a288bd65SRichard Kennedy const char **trace_bprintk_fmt_start; 5201ba28e02SLai Jiangshan #endif 5216d723736SSteven Rostedt #ifdef CONFIG_EVENT_TRACING 5222425bcb9SSteven Rostedt (Red Hat) struct trace_event_call **trace_events; 5236d723736SSteven Rostedt unsigned int num_trace_events; 52499be647cSJeremy Linton struct trace_eval_map **trace_evals; 52599be647cSJeremy Linton unsigned int num_trace_evals; 5266d723736SSteven Rostedt #endif 52793eb677dSSteven Rostedt #ifdef CONFIG_FTRACE_MCOUNT_RECORD 52893eb677dSSteven Rostedt unsigned int num_ftrace_callsites; 529a288bd65SRichard Kennedy unsigned long *ftrace_callsites; 53093eb677dSSteven Rostedt #endif 5311e6769b0SMasami Hiramatsu #ifdef CONFIG_KPROBES 5321e6769b0SMasami Hiramatsu void *kprobes_text_start; 5331e6769b0SMasami Hiramatsu unsigned int kprobes_text_size; 53416db6264SMasami Hiramatsu unsigned long *kprobe_blacklist; 53516db6264SMasami Hiramatsu unsigned int num_kprobe_blacklist; 5361e6769b0SMasami Hiramatsu #endif 5379183c3f9SJosh Poimboeuf #ifdef CONFIG_HAVE_STATIC_CALL_INLINE 5389183c3f9SJosh Poimboeuf int num_static_call_sites; 5399183c3f9SJosh Poimboeuf struct static_call_site *static_call_sites; 5409183c3f9SJosh Poimboeuf #endif 5413d6e4462SJeremy Kerr #if IS_ENABLED(CONFIG_KUNIT) 5423d6e4462SJeremy Kerr int num_kunit_suites; 543e5857d39SDaniel Latypov struct kunit_suite **kunit_suites; 5443d6e4462SJeremy Kerr #endif 5453d6e4462SJeremy Kerr 5461ba28e02SLai Jiangshan 5478cb2c2dcSPetr Mladek #ifdef CONFIG_LIVEPATCH 5481ce15ef4SJessica Yu bool klp; /* Is this a livepatch module? */ 5498cb2c2dcSPetr Mladek bool klp_alive; 5501ce15ef4SJessica Yu 5511ce15ef4SJessica Yu /* Elf information */ 5521ce15ef4SJessica Yu struct klp_modinfo *klp_info; 5538cb2c2dcSPetr Mladek #endif 5548cb2c2dcSPetr Mladek 55533701557SChris Down #ifdef CONFIG_PRINTK_INDEX 55633701557SChris Down unsigned int printk_index_size; 55733701557SChris Down struct pi_entry **printk_index_start; 55833701557SChris Down #endif 55933701557SChris Down 560af540689SRichard Kennedy #ifdef CONFIG_MODULE_UNLOAD 561af540689SRichard Kennedy /* What modules depend on me? */ 5622c02dfe7SLinus Torvalds struct list_head source_list; 5632c02dfe7SLinus Torvalds /* What modules do I depend on? */ 5642c02dfe7SLinus Torvalds struct list_head target_list; 565af540689SRichard Kennedy 566af540689SRichard Kennedy /* Destruction function. */ 567af540689SRichard Kennedy void (*exit)(void); 568af540689SRichard Kennedy 5692f35c41fSMasami Hiramatsu atomic_t refcnt; 570af540689SRichard Kennedy #endif 571b99b87f7SPeter Oberparleiter 572b99b87f7SPeter Oberparleiter #ifdef CONFIG_CONSTRUCTORS 573b99b87f7SPeter Oberparleiter /* Constructor functions. */ 574b99b87f7SPeter Oberparleiter ctor_fn_t *ctors; 575b99b87f7SPeter Oberparleiter unsigned int num_ctors; 576b99b87f7SPeter Oberparleiter #endif 57792ace999SJosef Bacik 578540adea3SMasami Hiramatsu #ifdef CONFIG_FUNCTION_ERROR_INJECTION 579663faf9fSMasami Hiramatsu struct error_injection_entry *ei_funcs; 580540adea3SMasami Hiramatsu unsigned int num_ei_funcs; 58192ace999SJosef Bacik #endif 5823859a271SKees Cook } ____cacheline_aligned __randomize_layout; 583e61a1c1cSRoman Zippel #ifndef MODULE_ARCH_INIT 584e61a1c1cSRoman Zippel #define MODULE_ARCH_INIT {} 585e61a1c1cSRoman Zippel #endif 5861da177e4SLinus Torvalds 58793d77e7fSVincent Whitchurch #ifndef HAVE_ARCH_KALLSYMS_SYMBOL_VALUE 58893d77e7fSVincent Whitchurch static inline unsigned long kallsyms_symbol_value(const Elf_Sym *sym) 58993d77e7fSVincent Whitchurch { 59093d77e7fSVincent Whitchurch return sym->st_value; 59193d77e7fSVincent Whitchurch } 59293d77e7fSVincent Whitchurch #endif 59393d77e7fSVincent Whitchurch 5941da177e4SLinus Torvalds /* FIXME: It'd be nice to isolate modules during init, too, so they 5951da177e4SLinus Torvalds aren't used before they (may) fail. But presently too much code 5961da177e4SLinus Torvalds (IDE & SCSI) require entry into the module during init.*/ 597171d864eSYaowei Bai static inline bool module_is_live(struct module *mod) 5981da177e4SLinus Torvalds { 5991da177e4SLinus Torvalds return mod->state != MODULE_STATE_GOING; 6001da177e4SLinus Torvalds } 6011da177e4SLinus Torvalds 6021da177e4SLinus Torvalds struct module *__module_text_address(unsigned long addr); 603e610499eSRusty Russell struct module *__module_address(unsigned long addr); 604e610499eSRusty Russell bool is_module_address(unsigned long addr); 605383776faSThomas Gleixner bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr); 60610fad5e4STejun Heo bool is_module_percpu_address(unsigned long addr); 607e610499eSRusty Russell bool is_module_text_address(unsigned long addr); 6081da177e4SLinus Torvalds 609ac3b4328SSong Liu static inline bool within_module_mem_type(unsigned long addr, 610ac3b4328SSong Liu const struct module *mod, 611ac3b4328SSong Liu enum mod_mem_type type) 612ac3b4328SSong Liu { 613ac3b4328SSong Liu unsigned long base, size; 614ac3b4328SSong Liu 615ac3b4328SSong Liu base = (unsigned long)mod->mem[type].base; 616ac3b4328SSong Liu size = mod->mem[type].size; 617ac3b4328SSong Liu return addr - base < size; 618ac3b4328SSong Liu } 619ac3b4328SSong Liu 62076681c8fSPetr Mladek static inline bool within_module_core(unsigned long addr, 62176681c8fSPetr Mladek const struct module *mod) 622a06f6211SMasami Hiramatsu { 623ac3b4328SSong Liu for_class_mod_mem_type(type, core) { 624ac3b4328SSong Liu if (within_module_mem_type(addr, mod, type)) 62501dc0386SChristophe Leroy return true; 626ac3b4328SSong Liu } 627ac3b4328SSong Liu return false; 628a06f6211SMasami Hiramatsu } 629a06f6211SMasami Hiramatsu 63076681c8fSPetr Mladek static inline bool within_module_init(unsigned long addr, 63176681c8fSPetr Mladek const struct module *mod) 632a06f6211SMasami Hiramatsu { 633ac3b4328SSong Liu for_class_mod_mem_type(type, init) { 634ac3b4328SSong Liu if (within_module_mem_type(addr, mod, type)) 635ac3b4328SSong Liu return true; 636ac3b4328SSong Liu } 637ac3b4328SSong Liu return false; 638a06f6211SMasami Hiramatsu } 639a06f6211SMasami Hiramatsu 64076681c8fSPetr Mladek static inline bool within_module(unsigned long addr, const struct module *mod) 6419b20a352SPetr Mladek { 6429b20a352SPetr Mladek return within_module_init(addr, mod) || within_module_core(addr, mod); 6439b20a352SPetr Mladek } 6449b20a352SPetr Mladek 645a0060505SChristoph Hellwig /* Search for module by name: must be in a RCU-sched critical section. */ 646c6b37801STim Abbott struct module *find_module(const char *name); 647c6b37801STim Abbott 648ea07890aSAlexey Dobriyan /* Returns 0 and fills in value, defined and namebuf, or -ERANGE if 6491da177e4SLinus Torvalds symnum out of range. */ 650ea07890aSAlexey Dobriyan int module_get_kallsym(unsigned int symnum, unsigned long *value, char *type, 651ea07890aSAlexey Dobriyan char *name, char *module_name, int *exported); 6521da177e4SLinus Torvalds 6531da177e4SLinus Torvalds /* Look for this name: can be of form module:name. */ 6541da177e4SLinus Torvalds unsigned long module_kallsyms_lookup_name(const char *name); 6551da177e4SLinus Torvalds 656ca3574bdSEric W. Biederman extern void __noreturn __module_put_and_kthread_exit(struct module *mod, 657bf262dceSJiri Kosina long code); 658ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) __module_put_and_kthread_exit(THIS_MODULE, code) 6591da177e4SLinus Torvalds 6601da177e4SLinus Torvalds #ifdef CONFIG_MODULE_UNLOAD 661d5db139aSRusty Russell int module_refcount(struct module *mod); 6621da177e4SLinus Torvalds void __symbol_put(const char *symbol); 663996302c5SMasahiro Yamada #define symbol_put(x) __symbol_put(__stringify(x)) 6641da177e4SLinus Torvalds void symbol_put_addr(void *addr); 6651da177e4SLinus Torvalds 6661da177e4SLinus Torvalds /* Sometimes we know we already have a refcount, and it's easier not 6671da177e4SLinus Torvalds to handle the error case (which only happens with rmmod --wait). */ 668d53799beSSteven Rostedt extern void __module_get(struct module *module); 6691da177e4SLinus Torvalds 670d53799beSSteven Rostedt /* This is the Right Way to get a module: if it fails, it's being removed, 671d53799beSSteven Rostedt * so pretend it's not there. */ 672d53799beSSteven Rostedt extern bool try_module_get(struct module *module); 6731da177e4SLinus Torvalds 674f6a57033SAl Viro extern void module_put(struct module *module); 6751da177e4SLinus Torvalds 6761da177e4SLinus Torvalds #else /*!CONFIG_MODULE_UNLOAD*/ 6778ba4fcdfSGao Feng static inline bool try_module_get(struct module *module) 6781da177e4SLinus Torvalds { 6791da177e4SLinus Torvalds return !module || module_is_live(module); 6801da177e4SLinus Torvalds } 6811da177e4SLinus Torvalds static inline void module_put(struct module *module) 6821da177e4SLinus Torvalds { 6831da177e4SLinus Torvalds } 6841da177e4SLinus Torvalds static inline void __module_get(struct module *module) 6851da177e4SLinus Torvalds { 6861da177e4SLinus Torvalds } 6871da177e4SLinus Torvalds #define symbol_put(x) do { } while (0) 6881da177e4SLinus Torvalds #define symbol_put_addr(p) do { } while (0) 6891da177e4SLinus Torvalds 6901da177e4SLinus Torvalds #endif /* CONFIG_MODULE_UNLOAD */ 6911da177e4SLinus Torvalds 6921da177e4SLinus Torvalds /* This is a #define so the string doesn't get put in every .o file */ 6931da177e4SLinus Torvalds #define module_name(mod) \ 6941da177e4SLinus Torvalds ({ \ 6951da177e4SLinus Torvalds struct module *__mod = (mod); \ 6961da177e4SLinus Torvalds __mod ? __mod->name : "kernel"; \ 6971da177e4SLinus Torvalds }) 6981da177e4SLinus Torvalds 699b865ea64SSergey Senozhatsky /* Dereference module function descriptor */ 700b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr); 701b865ea64SSergey Senozhatsky 7026dd06c9fSRusty Russell /* For kallsyms to ask for address resolution. namebuf should be at 7036dd06c9fSRusty Russell * least KSYM_NAME_LEN long: a pointer to namebuf is returned if 7046dd06c9fSRusty Russell * found, otherwise NULL. */ 70592dfc9dcSAndrew Morton const char *module_address_lookup(unsigned long addr, 7061da177e4SLinus Torvalds unsigned long *symbolsize, 7071da177e4SLinus Torvalds unsigned long *offset, 7089294523eSStephen Boyd char **modname, const unsigned char **modbuildid, 7096dd06c9fSRusty Russell char *namebuf); 7109d65cb4aSAlexey Dobriyan int lookup_module_symbol_name(unsigned long addr, char *symname); 711a5c43daeSAlexey Dobriyan int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name); 7121da177e4SLinus Torvalds 7131da177e4SLinus Torvalds int register_module_notifier(struct notifier_block *nb); 7141da177e4SLinus Torvalds int unregister_module_notifier(struct notifier_block *nb); 7151da177e4SLinus Torvalds 7161da177e4SLinus Torvalds extern void print_modules(void); 7171da177e4SLinus Torvalds 71880c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module) 71980c6e146SDmitry Torokhov { 72080c6e146SDmitry Torokhov return module && module->async_probe_requested; 72180c6e146SDmitry Torokhov } 72280c6e146SDmitry Torokhov 7231be9473eSAaron Tomlin static inline bool is_livepatch_module(struct module *mod) 7241be9473eSAaron Tomlin { 7251ce15ef4SJessica Yu #ifdef CONFIG_LIVEPATCH 7261ce15ef4SJessica Yu return mod->klp; 7271be9473eSAaron Tomlin #else 7281ce15ef4SJessica Yu return false; 7291be9473eSAaron Tomlin #endif 7301ce15ef4SJessica Yu } 7311ce15ef4SJessica Yu 7328db5da0bSMimi Zohar void set_module_sig_enforced(void); 733fda784e5SBruno E. O. Meneguele 7341da177e4SLinus Torvalds #else /* !CONFIG_MODULES... */ 7351da177e4SLinus Torvalds 736e610499eSRusty Russell static inline struct module *__module_address(unsigned long addr) 737e610499eSRusty Russell { 738e610499eSRusty Russell return NULL; 739e610499eSRusty Russell } 740e610499eSRusty Russell 7411da177e4SLinus Torvalds static inline struct module *__module_text_address(unsigned long addr) 7421da177e4SLinus Torvalds { 7431da177e4SLinus Torvalds return NULL; 7441da177e4SLinus Torvalds } 7451da177e4SLinus Torvalds 746e610499eSRusty Russell static inline bool is_module_address(unsigned long addr) 7474d435f9dSIngo Molnar { 748e610499eSRusty Russell return false; 749e610499eSRusty Russell } 750e610499eSRusty Russell 751d5e50dafSRandy Dunlap static inline bool is_module_percpu_address(unsigned long addr) 752d5e50dafSRandy Dunlap { 753d5e50dafSRandy Dunlap return false; 754d5e50dafSRandy Dunlap } 755d5e50dafSRandy Dunlap 756383776faSThomas Gleixner static inline bool __is_module_percpu_address(unsigned long addr, unsigned long *can_addr) 757383776faSThomas Gleixner { 758383776faSThomas Gleixner return false; 759383776faSThomas Gleixner } 760383776faSThomas Gleixner 761e610499eSRusty Russell static inline bool is_module_text_address(unsigned long addr) 762e610499eSRusty Russell { 763e610499eSRusty Russell return false; 7644d435f9dSIngo Molnar } 7654d435f9dSIngo Molnar 766007ec26cSDavid Howells static inline bool within_module_core(unsigned long addr, 767007ec26cSDavid Howells const struct module *mod) 768007ec26cSDavid Howells { 769007ec26cSDavid Howells return false; 770007ec26cSDavid Howells } 771007ec26cSDavid Howells 772dadec066STri Vo static inline bool within_module_init(unsigned long addr, 773dadec066STri Vo const struct module *mod) 774dadec066STri Vo { 775dadec066STri Vo return false; 776dadec066STri Vo } 777dadec066STri Vo 778dadec066STri Vo static inline bool within_module(unsigned long addr, const struct module *mod) 779dadec066STri Vo { 780dadec066STri Vo return false; 781dadec066STri Vo } 782dadec066STri Vo 7831da177e4SLinus Torvalds /* Get/put a kernel symbol (calls should be symmetric) */ 78413150bc5SArd Biesheuvel #define symbol_get(x) ({ extern typeof(x) x __attribute__((weak,visibility("hidden"))); &(x); }) 7851da177e4SLinus Torvalds #define symbol_put(x) do { } while (0) 7861da177e4SLinus Torvalds #define symbol_put_addr(x) do { } while (0) 7871da177e4SLinus Torvalds 7881da177e4SLinus Torvalds static inline void __module_get(struct module *module) 7891da177e4SLinus Torvalds { 7901da177e4SLinus Torvalds } 7911da177e4SLinus Torvalds 7928ba4fcdfSGao Feng static inline bool try_module_get(struct module *module) 7931da177e4SLinus Torvalds { 7948ba4fcdfSGao Feng return true; 7951da177e4SLinus Torvalds } 7961da177e4SLinus Torvalds 7971da177e4SLinus Torvalds static inline void module_put(struct module *module) 7981da177e4SLinus Torvalds { 7991da177e4SLinus Torvalds } 8001da177e4SLinus Torvalds 8011da177e4SLinus Torvalds #define module_name(mod) "kernel" 8021da177e4SLinus Torvalds 8031da177e4SLinus Torvalds /* For kallsyms to ask for address resolution. NULL means not found. */ 80492dfc9dcSAndrew Morton static inline const char *module_address_lookup(unsigned long addr, 8051da177e4SLinus Torvalds unsigned long *symbolsize, 8061da177e4SLinus Torvalds unsigned long *offset, 8076dd06c9fSRusty Russell char **modname, 8089294523eSStephen Boyd const unsigned char **modbuildid, 8096dd06c9fSRusty Russell char *namebuf) 8101da177e4SLinus Torvalds { 8111da177e4SLinus Torvalds return NULL; 8121da177e4SLinus Torvalds } 8131da177e4SLinus Torvalds 8149d65cb4aSAlexey Dobriyan static inline int lookup_module_symbol_name(unsigned long addr, char *symname) 8159d65cb4aSAlexey Dobriyan { 8169d65cb4aSAlexey Dobriyan return -ERANGE; 8179d65cb4aSAlexey Dobriyan } 8189d65cb4aSAlexey Dobriyan 819a5c43daeSAlexey Dobriyan static inline int lookup_module_symbol_attrs(unsigned long addr, unsigned long *size, unsigned long *offset, char *modname, char *name) 820a5c43daeSAlexey Dobriyan { 821a5c43daeSAlexey Dobriyan return -ERANGE; 822a5c43daeSAlexey Dobriyan } 823a5c43daeSAlexey Dobriyan 824ea07890aSAlexey Dobriyan static inline int module_get_kallsym(unsigned int symnum, unsigned long *value, 825ea07890aSAlexey Dobriyan char *type, char *name, 826ea07890aSAlexey Dobriyan char *module_name, int *exported) 8271da177e4SLinus Torvalds { 828ea07890aSAlexey Dobriyan return -ERANGE; 8291da177e4SLinus Torvalds } 8301da177e4SLinus Torvalds 8311da177e4SLinus Torvalds static inline unsigned long module_kallsyms_lookup_name(const char *name) 8321da177e4SLinus Torvalds { 8331da177e4SLinus Torvalds return 0; 8341da177e4SLinus Torvalds } 8351da177e4SLinus Torvalds 8361da177e4SLinus Torvalds static inline int register_module_notifier(struct notifier_block *nb) 8371da177e4SLinus Torvalds { 8381da177e4SLinus Torvalds /* no events will happen anyway, so this can always succeed */ 8391da177e4SLinus Torvalds return 0; 8401da177e4SLinus Torvalds } 8411da177e4SLinus Torvalds 8421da177e4SLinus Torvalds static inline int unregister_module_notifier(struct notifier_block *nb) 8431da177e4SLinus Torvalds { 8441da177e4SLinus Torvalds return 0; 8451da177e4SLinus Torvalds } 8461da177e4SLinus Torvalds 847ca3574bdSEric W. Biederman #define module_put_and_kthread_exit(code) kthread_exit(code) 8481da177e4SLinus Torvalds 8491da177e4SLinus Torvalds static inline void print_modules(void) 8501da177e4SLinus Torvalds { 8511da177e4SLinus Torvalds } 85280c6e146SDmitry Torokhov 85380c6e146SDmitry Torokhov static inline bool module_requested_async_probing(struct module *module) 85480c6e146SDmitry Torokhov { 85580c6e146SDmitry Torokhov return false; 85680c6e146SDmitry Torokhov } 85780c6e146SDmitry Torokhov 858fda784e5SBruno E. O. Meneguele 8598db5da0bSMimi Zohar static inline void set_module_sig_enforced(void) 8608db5da0bSMimi Zohar { 8618db5da0bSMimi Zohar } 8628db5da0bSMimi Zohar 863b865ea64SSergey Senozhatsky /* Dereference module function descriptor */ 864b865ea64SSergey Senozhatsky static inline 865b865ea64SSergey Senozhatsky void *dereference_module_function_descriptor(struct module *mod, void *ptr) 866b865ea64SSergey Senozhatsky { 867b865ea64SSergey Senozhatsky return ptr; 868b865ea64SSergey Senozhatsky } 869b865ea64SSergey Senozhatsky 870ef665c1aSRandy Dunlap #endif /* CONFIG_MODULES */ 871ef665c1aSRandy Dunlap 872ef665c1aSRandy Dunlap #ifdef CONFIG_SYSFS 8737405c1e1SGreg Kroah-Hartman extern struct kset *module_kset; 874*042edf1eSThomas Weißschuh extern const struct kobj_type module_ktype; 875ef665c1aSRandy Dunlap #endif /* CONFIG_SYSFS */ 876ef665c1aSRandy Dunlap 8771da177e4SLinus Torvalds #define symbol_request(x) try_then_request_module(symbol_get(x), "symbol:" #x) 8781da177e4SLinus Torvalds 8791da177e4SLinus Torvalds /* BELOW HERE ALL THESE ARE OBSOLETE AND WILL VANISH */ 8801da177e4SLinus Torvalds 8811da177e4SLinus Torvalds #define __MODULE_STRING(x) __stringify(x) 8821da177e4SLinus Torvalds 8830d9c25ddSAndrew Morton #ifdef CONFIG_GENERIC_BUG 8845336377dSLinus Torvalds void module_bug_finalize(const Elf_Ehdr *, const Elf_Shdr *, 8850d9c25ddSAndrew Morton struct module *); 8860d9c25ddSAndrew Morton void module_bug_cleanup(struct module *); 8870d9c25ddSAndrew Morton 8880d9c25ddSAndrew Morton #else /* !CONFIG_GENERIC_BUG */ 8890d9c25ddSAndrew Morton 8905336377dSLinus Torvalds static inline void module_bug_finalize(const Elf_Ehdr *hdr, 8910d9c25ddSAndrew Morton const Elf_Shdr *sechdrs, 8920d9c25ddSAndrew Morton struct module *mod) 8930d9c25ddSAndrew Morton { 8940d9c25ddSAndrew Morton } 8950d9c25ddSAndrew Morton static inline void module_bug_cleanup(struct module *mod) {} 8960d9c25ddSAndrew Morton #endif /* CONFIG_GENERIC_BUG */ 8970d9c25ddSAndrew Morton 898e4f35891SWANG Chao #ifdef CONFIG_RETPOLINE 899caf7501aSAndi Kleen extern bool retpoline_module_ok(bool has_retpoline); 900caf7501aSAndi Kleen #else 901caf7501aSAndi Kleen static inline bool retpoline_module_ok(bool has_retpoline) 902caf7501aSAndi Kleen { 903caf7501aSAndi Kleen return true; 904caf7501aSAndi Kleen } 905caf7501aSAndi Kleen #endif 906caf7501aSAndi Kleen 90759afdc7bSHerbert Xu #ifdef CONFIG_MODULE_SIG 9080c1e4280SAaron Tomlin bool is_module_sig_enforced(void); 9090c1e4280SAaron Tomlin 91059afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module) 91159afdc7bSHerbert Xu { 91259afdc7bSHerbert Xu return module->sig_ok; 91359afdc7bSHerbert Xu } 91459afdc7bSHerbert Xu #else /* !CONFIG_MODULE_SIG */ 9150c1e4280SAaron Tomlin static inline bool is_module_sig_enforced(void) 9160c1e4280SAaron Tomlin { 9170c1e4280SAaron Tomlin return false; 9180c1e4280SAaron Tomlin } 9190c1e4280SAaron Tomlin 92059afdc7bSHerbert Xu static inline bool module_sig_ok(struct module *module) 92159afdc7bSHerbert Xu { 92259afdc7bSHerbert Xu return true; 92359afdc7bSHerbert Xu } 92459afdc7bSHerbert Xu #endif /* CONFIG_MODULE_SIG */ 92559afdc7bSHerbert Xu 92673feb8d5SJiri Olsa #if defined(CONFIG_MODULES) && defined(CONFIG_KALLSYMS) 92707cc2c93SZhen Lei int module_kallsyms_on_each_symbol(const char *modname, 92807cc2c93SZhen Lei int (*fn)(void *, const char *, 9293e355205SChristoph Hellwig struct module *, unsigned long), 9303e355205SChristoph Hellwig void *data); 93173feb8d5SJiri Olsa #else 93207cc2c93SZhen Lei static inline int module_kallsyms_on_each_symbol(const char *modname, 93307cc2c93SZhen Lei int (*fn)(void *, const char *, 93473feb8d5SJiri Olsa struct module *, unsigned long), 93573feb8d5SJiri Olsa void *data) 93673feb8d5SJiri Olsa { 93773feb8d5SJiri Olsa return -EOPNOTSUPP; 93873feb8d5SJiri Olsa } 93973feb8d5SJiri Olsa #endif /* CONFIG_MODULES && CONFIG_KALLSYMS */ 9403e355205SChristoph Hellwig 9411da177e4SLinus Torvalds #endif /* _LINUX_MODULE_H */ 942