1 /*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice unmodified, this list of conditions, and the following
13 * disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29 #ifndef _LINUXKPI_LINUX_MODULE_H_
30 #define _LINUXKPI_LINUX_MODULE_H_
31
32 #include <sys/cdefs.h>
33 #include <sys/types.h>
34 #include <sys/param.h>
35 #include <sys/module.h>
36 #include <sys/queue.h>
37 #include <sys/linker.h>
38
39 #include <linux/list.h>
40 #include <linux/compiler.h>
41 #include <linux/stringify.h>
42 #include <linux/kmod.h>
43 #include <linux/kobject.h>
44 #include <linux/sysfs.h>
45 #include <linux/moduleparam.h>
46 #include <linux/slab.h>
47 #include <linux/export.h>
48
49 #define MODULE_AUTHOR(name)
50 #define MODULE_DESCRIPTION(name)
51 #define MODULE_LICENSE(name)
52 #define MODULE_INFO(tag, info)
53 #define MODULE_FIRMWARE(firmware)
54 #define MODULE_SUPPORTED_DEVICE(name)
55 #define MODULE_IMPORT_NS(_name)
56
57 /*
58 * THIS_MODULE is used to differentiate modules on Linux. We currently
59 * completely stub out any Linux struct module usage, but THIS_MODULE is still
60 * used to populate the "owner" fields of various drivers. Even though we
61 * don't actually dereference these "owner" fields they are still used by
62 * drivers to check if devices/dmabufs/etc come from different modules. For
63 * example, during DRM GEM import some drivers check if the dmabuf's owner
64 * matches the dev's owner. If they match because they are both NULL drivers
65 * may incorrectly think two resources come from the same module.
66 *
67 * To handle this we specify an undefined symbol __this_linker_file, which
68 * will get special treatment from the linker when resolving. This will
69 * populate the usages of __this_linker_file with the linker_file_t of the
70 * module.
71 */
72 #ifdef KLD_MODULE
73 #define THIS_MODULE ((struct module *)&__this_linker_file)
74 #else
75 #define THIS_MODULE ((struct module *)0)
76 #endif
77
78 #define __MODULE_STRING(x) __stringify(x)
79
80 /* OFED pre-module initialization */
81 #define SI_SUB_OFED_PREINIT (SI_SUB_ROOT_CONF - 2)
82 /* OFED default module initialization */
83 #define SI_SUB_OFED_MODINIT (SI_SUB_ROOT_CONF - 1)
84
85 #include <sys/linker.h>
86
87 static inline void
_module_run(void * arg)88 _module_run(void *arg)
89 {
90 void (*fn)(void);
91 #ifdef OFED_DEBUG_INIT
92 char name[1024];
93 caddr_t pc;
94 long offset;
95
96 pc = (caddr_t)arg;
97 if (linker_search_symbol_name(pc, name, sizeof(name), &offset) != 0)
98 printf("Running ??? (%p)\n", pc);
99 else
100 printf("Running %s (%p)\n", name, pc);
101 #endif
102 fn = arg;
103 fn();
104 }
105
106 #define module_init(fn) \
107 SYSINIT(fn, SI_SUB_OFED_MODINIT, SI_ORDER_FIRST, _module_run, (fn))
108
109 #define module_exit(fn) \
110 SYSUNINIT(fn, SI_SUB_OFED_MODINIT, SI_ORDER_SECOND, _module_run, (fn))
111
112 /*
113 * The following two macros are a workaround for not having a module
114 * load and unload order resolver:
115 */
116 #define module_init_order(fn, order) \
117 SYSINIT(fn, SI_SUB_OFED_MODINIT, (order), _module_run, (fn))
118
119 #define module_exit_order(fn, order) \
120 SYSUNINIT(fn, SI_SUB_OFED_MODINIT, (order), _module_run, (fn))
121
122 #define module_get(module)
123 #define module_put(module)
124 #define try_module_get(module) 1
125
126 #define postcore_initcall(fn) module_init(fn)
127
128 #endif /* _LINUXKPI_LINUX_MODULE_H_ */
129