[PATCH] Compile-time check re world-writeable module params
[linux-2.6.git] / include / linux / moduleparam.h
1 #ifndef _LINUX_MODULE_PARAMS_H
2 #define _LINUX_MODULE_PARAMS_H
3 /* (C) Copyright 2001, 2002 Rusty Russell IBM Corporation */
4 #include <linux/init.h>
5 #include <linux/stringify.h>
6 #include <linux/kernel.h>
7
8 /* You can override this manually, but generally this should match the
9    module name. */
10 #ifdef MODULE
11 #define MODULE_PARAM_PREFIX /* empty */
12 #else
13 #define MODULE_PARAM_PREFIX KBUILD_MODNAME "."
14 #endif
15
16 #ifdef MODULE
17 #define ___module_cat(a,b) __mod_ ## a ## b
18 #define __module_cat(a,b) ___module_cat(a,b)
19 #define __MODULE_INFO(tag, name, info)                                    \
20 static const char __module_cat(name,__LINE__)[]                           \
21   __attribute_used__                                                      \
22   __attribute__((section(".modinfo"),unused)) = __stringify(tag) "=" info
23 #else  /* !MODULE */
24 #define __MODULE_INFO(tag, name, info)
25 #endif
26 #define __MODULE_PARM_TYPE(name, _type)                                   \
27   __MODULE_INFO(parmtype, name##type, #name ":" _type)
28
29 struct kernel_param;
30
31 /* Returns 0, or -errno.  arg is in kp->arg. */
32 typedef int (*param_set_fn)(const char *val, struct kernel_param *kp);
33 /* Returns length written or -errno.  Buffer is 4k (ie. be short!) */
34 typedef int (*param_get_fn)(char *buffer, struct kernel_param *kp);
35
36 struct kernel_param {
37         const char *name;
38         unsigned int perm;
39         param_set_fn set;
40         param_get_fn get;
41         void *arg;
42 };
43
44 /* Special one for strings we want to copy into */
45 struct kparam_string {
46         unsigned int maxlen;
47         char *string;
48 };
49
50 /* Special one for arrays */
51 struct kparam_array
52 {
53         unsigned int max;
54         unsigned int *num;
55         param_set_fn set;
56         param_get_fn get;
57         unsigned int elemsize;
58         void *elem;
59 };
60
61 /* This is the fundamental function for registering boot/module
62    parameters.  perm sets the visibility in driverfs: 000 means it's
63    not there, read bits mean it's readable, write bits mean it's
64    writable. */
65 #define __module_param_call(prefix, name, set, get, arg, perm)          \
66         /* Default value instead of permissions? */                     \
67         static int __param_perm_check_##name __attribute__((unused)) =  \
68         BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2)); \
69         static char __param_str_##name[] = prefix #name;                \
70         static struct kernel_param const __param_##name                 \
71         __attribute_used__                                              \
72     __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \
73         = { __param_str_##name, perm, set, get, arg }
74
75 #define module_param_call(name, set, get, arg, perm)                          \
76         __module_param_call(MODULE_PARAM_PREFIX, name, set, get, arg, perm)
77
78 /* Helper functions: type is byte, short, ushort, int, uint, long,
79    ulong, charp, bool or invbool, or XXX if you define param_get_XXX,
80    param_set_XXX and param_check_XXX. */
81 #define module_param_named(name, value, type, perm)                        \
82         param_check_##type(name, &(value));                                \
83         module_param_call(name, param_set_##type, param_get_##type, &value, perm); \
84         __MODULE_PARM_TYPE(name, #type)
85
86 #define module_param(name, type, perm)                          \
87         module_param_named(name, name, type, perm)
88
89 /* Actually copy string: maxlen param is usually sizeof(string). */
90 #define module_param_string(name, string, len, perm)                    \
91         static struct kparam_string __param_string_##name               \
92                 = { len, string };                                      \
93         module_param_call(name, param_set_copystring, param_get_string, \
94                    &__param_string_##name, perm);                       \
95         __MODULE_PARM_TYPE(name, "string")
96
97 /* Called on module insert or kernel boot */
98 extern int parse_args(const char *name,
99                       char *args,
100                       struct kernel_param *params,
101                       unsigned num,
102                       int (*unknown)(char *param, char *val));
103
104 /* All the helper functions */
105 /* The macros to do compile-time type checking stolen from Jakub
106    Jelinek, who IIRC came up with this idea for the 2.4 module init code. */
107 #define __param_check(name, p, type) \
108         static inline type *__check_##name(void) { return(p); }
109
110 extern int param_set_byte(const char *val, struct kernel_param *kp);
111 extern int param_get_byte(char *buffer, struct kernel_param *kp);
112 #define param_check_byte(name, p) __param_check(name, p, unsigned char)
113
114 extern int param_set_short(const char *val, struct kernel_param *kp);
115 extern int param_get_short(char *buffer, struct kernel_param *kp);
116 #define param_check_short(name, p) __param_check(name, p, short)
117
118 extern int param_set_ushort(const char *val, struct kernel_param *kp);
119 extern int param_get_ushort(char *buffer, struct kernel_param *kp);
120 #define param_check_ushort(name, p) __param_check(name, p, unsigned short)
121
122 extern int param_set_int(const char *val, struct kernel_param *kp);
123 extern int param_get_int(char *buffer, struct kernel_param *kp);
124 #define param_check_int(name, p) __param_check(name, p, int)
125
126 extern int param_set_uint(const char *val, struct kernel_param *kp);
127 extern int param_get_uint(char *buffer, struct kernel_param *kp);
128 #define param_check_uint(name, p) __param_check(name, p, unsigned int)
129
130 extern int param_set_long(const char *val, struct kernel_param *kp);
131 extern int param_get_long(char *buffer, struct kernel_param *kp);
132 #define param_check_long(name, p) __param_check(name, p, long)
133
134 extern int param_set_ulong(const char *val, struct kernel_param *kp);
135 extern int param_get_ulong(char *buffer, struct kernel_param *kp);
136 #define param_check_ulong(name, p) __param_check(name, p, unsigned long)
137
138 extern int param_set_charp(const char *val, struct kernel_param *kp);
139 extern int param_get_charp(char *buffer, struct kernel_param *kp);
140 #define param_check_charp(name, p) __param_check(name, p, char *)
141
142 extern int param_set_bool(const char *val, struct kernel_param *kp);
143 extern int param_get_bool(char *buffer, struct kernel_param *kp);
144 #define param_check_bool(name, p) __param_check(name, p, int)
145
146 extern int param_set_invbool(const char *val, struct kernel_param *kp);
147 extern int param_get_invbool(char *buffer, struct kernel_param *kp);
148 #define param_check_invbool(name, p) __param_check(name, p, int)
149
150 /* Comma-separated array: *nump is set to number they actually specified. */
151 #define module_param_array_named(name, array, type, nump, perm)         \
152         static struct kparam_array __param_arr_##name                   \
153         = { ARRAY_SIZE(array), nump, param_set_##type, param_get_##type,\
154             sizeof(array[0]), array };                                  \
155         module_param_call(name, param_array_set, param_array_get,       \
156                           &__param_arr_##name, perm);                   \
157         __MODULE_PARM_TYPE(name, "array of " #type)
158
159 #define module_param_array(name, type, nump, perm)              \
160         module_param_array_named(name, name, type, nump, perm)
161
162 extern int param_array_set(const char *val, struct kernel_param *kp);
163 extern int param_array_get(char *buffer, struct kernel_param *kp);
164
165 extern int param_set_copystring(const char *val, struct kernel_param *kp);
166 extern int param_get_string(char *buffer, struct kernel_param *kp);
167
168 /* for exporting parameters in /sys/parameters */
169
170 struct module;
171
172 extern int module_param_sysfs_setup(struct module *mod,
173                                     struct kernel_param *kparam,
174                                     unsigned int num_params);
175
176 extern void module_param_sysfs_remove(struct module *mod);
177
178 #endif /* _LINUX_MODULE_PARAMS_H */