Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* Helpers for initial module or kernel cmdline parsing |
| 2 | Copyright (C) 2001 Rusty Russell. |
| 3 | |
| 4 | This program is free software; you can redistribute it and/or modify |
| 5 | it under the terms of the GNU General Public License as published by |
| 6 | the Free Software Foundation; either version 2 of the License, or |
| 7 | (at your option) any later version. |
| 8 | |
| 9 | This program is distributed in the hope that it will be useful, |
| 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | GNU General Public License for more details. |
| 13 | |
| 14 | You should have received a copy of the GNU General Public License |
| 15 | along with this program; if not, write to the Free Software |
| 16 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 18 | #include <linux/moduleparam.h> |
| 19 | #include <linux/kernel.h> |
| 20 | #include <linux/string.h> |
| 21 | #include <linux/errno.h> |
| 22 | #include <linux/module.h> |
| 23 | #include <linux/device.h> |
| 24 | #include <linux/err.h> |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 25 | #include <linux/slab.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | |
Rusty Russell | e180a6b | 2009-03-31 13:05:29 -0600 | [diff] [blame^] | 27 | /* We abuse the high bits of "perm" to record whether we kmalloc'ed. */ |
| 28 | #define KPARAM_KMALLOCED 0x80000000 |
| 29 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | #if 0 |
| 31 | #define DEBUGP printk |
| 32 | #else |
| 33 | #define DEBUGP(fmt, a...) |
| 34 | #endif |
| 35 | |
Eric Sesterhenn | b9e20a9 | 2006-03-28 01:56:24 -0800 | [diff] [blame] | 36 | static inline char dash2underscore(char c) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | { |
| 38 | if (c == '-') |
| 39 | return '_'; |
| 40 | return c; |
| 41 | } |
| 42 | |
| 43 | static inline int parameq(const char *input, const char *paramname) |
| 44 | { |
| 45 | unsigned int i; |
| 46 | for (i = 0; dash2underscore(input[i]) == paramname[i]; i++) |
| 47 | if (input[i] == '\0') |
| 48 | return 1; |
| 49 | return 0; |
| 50 | } |
| 51 | |
| 52 | static int parse_one(char *param, |
| 53 | char *val, |
| 54 | struct kernel_param *params, |
| 55 | unsigned num_params, |
| 56 | int (*handle_unknown)(char *param, char *val)) |
| 57 | { |
| 58 | unsigned int i; |
| 59 | |
| 60 | /* Find parameter */ |
| 61 | for (i = 0; i < num_params; i++) { |
| 62 | if (parameq(param, params[i].name)) { |
| 63 | DEBUGP("They are equal! Calling %p\n", |
| 64 | params[i].set); |
| 65 | return params[i].set(val, ¶ms[i]); |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | if (handle_unknown) { |
| 70 | DEBUGP("Unknown argument: calling %p\n", handle_unknown); |
| 71 | return handle_unknown(param, val); |
| 72 | } |
| 73 | |
| 74 | DEBUGP("Unknown argument `%s'\n", param); |
| 75 | return -ENOENT; |
| 76 | } |
| 77 | |
| 78 | /* You can use " around spaces, but can't escape ". */ |
| 79 | /* Hyphens and underscores equivalent in parameter names. */ |
| 80 | static char *next_arg(char *args, char **param, char **val) |
| 81 | { |
| 82 | unsigned int i, equals = 0; |
| 83 | int in_quote = 0, quoted = 0; |
| 84 | char *next; |
| 85 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 86 | if (*args == '"') { |
| 87 | args++; |
| 88 | in_quote = 1; |
| 89 | quoted = 1; |
| 90 | } |
| 91 | |
| 92 | for (i = 0; args[i]; i++) { |
| 93 | if (args[i] == ' ' && !in_quote) |
| 94 | break; |
| 95 | if (equals == 0) { |
| 96 | if (args[i] == '=') |
| 97 | equals = i; |
| 98 | } |
| 99 | if (args[i] == '"') |
| 100 | in_quote = !in_quote; |
| 101 | } |
| 102 | |
| 103 | *param = args; |
| 104 | if (!equals) |
| 105 | *val = NULL; |
| 106 | else { |
| 107 | args[equals] = '\0'; |
| 108 | *val = args + equals + 1; |
| 109 | |
| 110 | /* Don't include quotes in value. */ |
| 111 | if (**val == '"') { |
| 112 | (*val)++; |
| 113 | if (args[i-1] == '"') |
| 114 | args[i-1] = '\0'; |
| 115 | } |
| 116 | if (quoted && args[i-1] == '"') |
| 117 | args[i-1] = '\0'; |
| 118 | } |
| 119 | |
| 120 | if (args[i]) { |
| 121 | args[i] = '\0'; |
| 122 | next = args + i + 1; |
| 123 | } else |
| 124 | next = args + i; |
Rusty Russell | f36462f | 2005-09-27 21:45:34 -0700 | [diff] [blame] | 125 | |
| 126 | /* Chew up trailing spaces. */ |
| 127 | while (*next == ' ') |
| 128 | next++; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | return next; |
| 130 | } |
| 131 | |
| 132 | /* Args looks like "foo=bar,bar2 baz=fuz wiz". */ |
| 133 | int parse_args(const char *name, |
| 134 | char *args, |
| 135 | struct kernel_param *params, |
| 136 | unsigned num, |
| 137 | int (*unknown)(char *param, char *val)) |
| 138 | { |
| 139 | char *param, *val; |
| 140 | |
| 141 | DEBUGP("Parsing ARGS: %s\n", args); |
| 142 | |
Rusty Russell | f36462f | 2005-09-27 21:45:34 -0700 | [diff] [blame] | 143 | /* Chew leading spaces */ |
| 144 | while (*args == ' ') |
| 145 | args++; |
| 146 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | while (*args) { |
| 148 | int ret; |
Ard van Breemen | a416aba | 2007-01-05 16:36:20 -0800 | [diff] [blame] | 149 | int irq_was_disabled; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
| 151 | args = next_arg(args, ¶m, &val); |
Ard van Breemen | a416aba | 2007-01-05 16:36:20 -0800 | [diff] [blame] | 152 | irq_was_disabled = irqs_disabled(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 153 | ret = parse_one(param, val, params, num, unknown); |
Ard van Breemen | a416aba | 2007-01-05 16:36:20 -0800 | [diff] [blame] | 154 | if (irq_was_disabled && !irqs_disabled()) { |
| 155 | printk(KERN_WARNING "parse_args(): option '%s' enabled " |
| 156 | "irq's!\n", param); |
| 157 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 158 | switch (ret) { |
| 159 | case -ENOENT: |
| 160 | printk(KERN_ERR "%s: Unknown parameter `%s'\n", |
| 161 | name, param); |
| 162 | return ret; |
| 163 | case -ENOSPC: |
| 164 | printk(KERN_ERR |
| 165 | "%s: `%s' too large for parameter `%s'\n", |
| 166 | name, val ?: "", param); |
| 167 | return ret; |
| 168 | case 0: |
| 169 | break; |
| 170 | default: |
| 171 | printk(KERN_ERR |
| 172 | "%s: `%s' invalid for parameter `%s'\n", |
| 173 | name, val ?: "", param); |
| 174 | return ret; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | /* All parsed OK. */ |
| 179 | return 0; |
| 180 | } |
| 181 | |
| 182 | /* Lazy bastard, eh? */ |
| 183 | #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \ |
| 184 | int param_set_##name(const char *val, struct kernel_param *kp) \ |
| 185 | { \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 186 | tmptype l; \ |
Yi Yang | 06b2a76 | 2008-02-08 04:21:57 -0800 | [diff] [blame] | 187 | int ret; \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 188 | \ |
| 189 | if (!val) return -EINVAL; \ |
Yi Yang | 06b2a76 | 2008-02-08 04:21:57 -0800 | [diff] [blame] | 190 | ret = strtolfn(val, 0, &l); \ |
| 191 | if (ret == -EINVAL || ((type)l != l)) \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 192 | return -EINVAL; \ |
| 193 | *((type *)kp->arg) = l; \ |
| 194 | return 0; \ |
| 195 | } \ |
| 196 | int param_get_##name(char *buffer, struct kernel_param *kp) \ |
| 197 | { \ |
| 198 | return sprintf(buffer, format, *((type *)kp->arg)); \ |
| 199 | } |
| 200 | |
Yi Yang | 06b2a76 | 2008-02-08 04:21:57 -0800 | [diff] [blame] | 201 | STANDARD_PARAM_DEF(byte, unsigned char, "%c", unsigned long, strict_strtoul); |
| 202 | STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol); |
| 203 | STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", unsigned long, strict_strtoul); |
| 204 | STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol); |
| 205 | STANDARD_PARAM_DEF(uint, unsigned int, "%u", unsigned long, strict_strtoul); |
| 206 | STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol); |
| 207 | STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", unsigned long, strict_strtoul); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | |
| 209 | int param_set_charp(const char *val, struct kernel_param *kp) |
| 210 | { |
| 211 | if (!val) { |
| 212 | printk(KERN_ERR "%s: string parameter expected\n", |
| 213 | kp->name); |
| 214 | return -EINVAL; |
| 215 | } |
| 216 | |
| 217 | if (strlen(val) > 1024) { |
| 218 | printk(KERN_ERR "%s: string parameter too long\n", |
| 219 | kp->name); |
| 220 | return -ENOSPC; |
| 221 | } |
| 222 | |
Rusty Russell | e180a6b | 2009-03-31 13:05:29 -0600 | [diff] [blame^] | 223 | if (kp->perm & KPARAM_KMALLOCED) |
| 224 | kfree(*(char **)kp->arg); |
| 225 | |
| 226 | /* This is a hack. We can't need to strdup in early boot, and we |
| 227 | * don't need to; this mangled commandline is preserved. */ |
| 228 | if (slab_is_available()) { |
| 229 | kp->perm |= KPARAM_KMALLOCED; |
| 230 | *(char **)kp->arg = kstrdup(val, GFP_KERNEL); |
| 231 | if (!kp->arg) |
| 232 | return -ENOMEM; |
| 233 | } else |
| 234 | *(const char **)kp->arg = val; |
| 235 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 236 | return 0; |
| 237 | } |
| 238 | |
| 239 | int param_get_charp(char *buffer, struct kernel_param *kp) |
| 240 | { |
| 241 | return sprintf(buffer, "%s", *((char **)kp->arg)); |
| 242 | } |
| 243 | |
| 244 | int param_set_bool(const char *val, struct kernel_param *kp) |
| 245 | { |
| 246 | /* No equals means "set"... */ |
| 247 | if (!val) val = "1"; |
| 248 | |
| 249 | /* One of =[yYnN01] */ |
| 250 | switch (val[0]) { |
| 251 | case 'y': case 'Y': case '1': |
| 252 | *(int *)kp->arg = 1; |
| 253 | return 0; |
| 254 | case 'n': case 'N': case '0': |
| 255 | *(int *)kp->arg = 0; |
| 256 | return 0; |
| 257 | } |
| 258 | return -EINVAL; |
| 259 | } |
| 260 | |
| 261 | int param_get_bool(char *buffer, struct kernel_param *kp) |
| 262 | { |
| 263 | /* Y and N chosen as being relatively non-coder friendly */ |
| 264 | return sprintf(buffer, "%c", (*(int *)kp->arg) ? 'Y' : 'N'); |
| 265 | } |
| 266 | |
| 267 | int param_set_invbool(const char *val, struct kernel_param *kp) |
| 268 | { |
| 269 | int boolval, ret; |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 270 | struct kernel_param dummy; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 271 | |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 272 | dummy.arg = &boolval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 273 | ret = param_set_bool(val, &dummy); |
| 274 | if (ret == 0) |
| 275 | *(int *)kp->arg = !boolval; |
| 276 | return ret; |
| 277 | } |
| 278 | |
| 279 | int param_get_invbool(char *buffer, struct kernel_param *kp) |
| 280 | { |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 281 | return sprintf(buffer, "%c", (*(int *)kp->arg) ? 'N' : 'Y'); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 282 | } |
| 283 | |
Bert Wesarg | 9730b5b | 2007-05-08 00:28:50 -0700 | [diff] [blame] | 284 | /* We break the rule and mangle the string. */ |
Adrian Bunk | 9871728 | 2006-03-25 03:07:06 -0800 | [diff] [blame] | 285 | static int param_array(const char *name, |
| 286 | const char *val, |
| 287 | unsigned int min, unsigned int max, |
| 288 | void *elem, int elemsize, |
| 289 | int (*set)(const char *, struct kernel_param *kp), |
Richard Knutsson | eb38a99 | 2008-02-06 01:37:50 -0800 | [diff] [blame] | 290 | unsigned int *num) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 291 | { |
| 292 | int ret; |
| 293 | struct kernel_param kp; |
| 294 | char save; |
| 295 | |
| 296 | /* Get the name right for errors. */ |
| 297 | kp.name = name; |
| 298 | kp.arg = elem; |
| 299 | |
| 300 | /* No equals sign? */ |
| 301 | if (!val) { |
| 302 | printk(KERN_ERR "%s: expects arguments\n", name); |
| 303 | return -EINVAL; |
| 304 | } |
| 305 | |
| 306 | *num = 0; |
| 307 | /* We expect a comma-separated list of values. */ |
| 308 | do { |
| 309 | int len; |
| 310 | |
| 311 | if (*num == max) { |
| 312 | printk(KERN_ERR "%s: can only take %i arguments\n", |
| 313 | name, max); |
| 314 | return -EINVAL; |
| 315 | } |
| 316 | len = strcspn(val, ","); |
| 317 | |
| 318 | /* nul-terminate and parse */ |
| 319 | save = val[len]; |
| 320 | ((char *)val)[len] = '\0'; |
| 321 | ret = set(val, &kp); |
| 322 | |
| 323 | if (ret != 0) |
| 324 | return ret; |
| 325 | kp.arg += elemsize; |
| 326 | val += len+1; |
| 327 | (*num)++; |
| 328 | } while (save == ','); |
| 329 | |
| 330 | if (*num < min) { |
| 331 | printk(KERN_ERR "%s: needs at least %i arguments\n", |
| 332 | name, min); |
| 333 | return -EINVAL; |
| 334 | } |
| 335 | return 0; |
| 336 | } |
| 337 | |
| 338 | int param_array_set(const char *val, struct kernel_param *kp) |
| 339 | { |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 340 | const struct kparam_array *arr = kp->arr; |
Bert Wesarg | 31143a1 | 2005-04-16 15:25:42 -0700 | [diff] [blame] | 341 | unsigned int temp_num; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 342 | |
| 343 | return param_array(kp->name, val, 1, arr->max, arr->elem, |
Bert Wesarg | 31143a1 | 2005-04-16 15:25:42 -0700 | [diff] [blame] | 344 | arr->elemsize, arr->set, arr->num ?: &temp_num); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | } |
| 346 | |
| 347 | int param_array_get(char *buffer, struct kernel_param *kp) |
| 348 | { |
| 349 | int i, off, ret; |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 350 | const struct kparam_array *arr = kp->arr; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 351 | struct kernel_param p; |
| 352 | |
| 353 | p = *kp; |
| 354 | for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) { |
| 355 | if (i) |
| 356 | buffer[off++] = ','; |
| 357 | p.arg = arr->elem + arr->elemsize * i; |
| 358 | ret = arr->get(buffer + off, &p); |
| 359 | if (ret < 0) |
| 360 | return ret; |
| 361 | off += ret; |
| 362 | } |
| 363 | buffer[off] = '\0'; |
| 364 | return off; |
| 365 | } |
| 366 | |
| 367 | int param_set_copystring(const char *val, struct kernel_param *kp) |
| 368 | { |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 369 | const struct kparam_string *kps = kp->str; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 370 | |
Randy Dunlap | fe20e58 | 2007-04-11 23:28:41 -0700 | [diff] [blame] | 371 | if (!val) { |
| 372 | printk(KERN_ERR "%s: missing param set value\n", kp->name); |
| 373 | return -EINVAL; |
| 374 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 375 | if (strlen(val)+1 > kps->maxlen) { |
| 376 | printk(KERN_ERR "%s: string doesn't fit in %u chars.\n", |
| 377 | kp->name, kps->maxlen-1); |
| 378 | return -ENOSPC; |
| 379 | } |
| 380 | strcpy(kps->string, val); |
| 381 | return 0; |
| 382 | } |
| 383 | |
| 384 | int param_get_string(char *buffer, struct kernel_param *kp) |
| 385 | { |
Jan Beulich | 22e48ea | 2007-10-16 23:29:34 -0700 | [diff] [blame] | 386 | const struct kparam_string *kps = kp->str; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 387 | return strlcpy(buffer, kps->string, kps->maxlen); |
| 388 | } |
| 389 | |
| 390 | /* sysfs output in /sys/modules/XYZ/parameters/ */ |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 391 | #define to_module_attr(n) container_of(n, struct module_attribute, attr); |
| 392 | #define to_module_kobject(n) container_of(n, struct module_kobject, kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 393 | |
| 394 | extern struct kernel_param __start___param[], __stop___param[]; |
| 395 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 396 | struct param_attribute |
| 397 | { |
| 398 | struct module_attribute mattr; |
| 399 | struct kernel_param *param; |
| 400 | }; |
| 401 | |
| 402 | struct module_param_attrs |
| 403 | { |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 404 | unsigned int num; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | struct attribute_group grp; |
| 406 | struct param_attribute attrs[0]; |
| 407 | }; |
| 408 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 409 | #ifdef CONFIG_SYSFS |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 410 | #define to_param_attr(n) container_of(n, struct param_attribute, mattr); |
| 411 | |
| 412 | static ssize_t param_attr_show(struct module_attribute *mattr, |
| 413 | struct module *mod, char *buf) |
| 414 | { |
| 415 | int count; |
| 416 | struct param_attribute *attribute = to_param_attr(mattr); |
| 417 | |
| 418 | if (!attribute->param->get) |
| 419 | return -EPERM; |
| 420 | |
| 421 | count = attribute->param->get(buf, attribute->param); |
| 422 | if (count > 0) { |
| 423 | strcat(buf, "\n"); |
| 424 | ++count; |
| 425 | } |
| 426 | return count; |
| 427 | } |
| 428 | |
| 429 | /* sysfs always hands a nul-terminated string in buf. We rely on that. */ |
| 430 | static ssize_t param_attr_store(struct module_attribute *mattr, |
| 431 | struct module *owner, |
| 432 | const char *buf, size_t len) |
| 433 | { |
| 434 | int err; |
| 435 | struct param_attribute *attribute = to_param_attr(mattr); |
| 436 | |
| 437 | if (!attribute->param->set) |
| 438 | return -EPERM; |
| 439 | |
| 440 | err = attribute->param->set(buf, attribute->param); |
| 441 | if (!err) |
| 442 | return len; |
| 443 | return err; |
| 444 | } |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 445 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 446 | |
| 447 | #ifdef CONFIG_MODULES |
| 448 | #define __modinit |
| 449 | #else |
| 450 | #define __modinit __init |
| 451 | #endif |
| 452 | |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 453 | #ifdef CONFIG_SYSFS |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 454 | /* |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 455 | * add_sysfs_param - add a parameter to sysfs |
| 456 | * @mk: struct module_kobject |
| 457 | * @kparam: the actual parameter definition to add to sysfs |
| 458 | * @name: name of parameter |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 459 | * |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 460 | * Create a kobject if for a (per-module) parameter if mp NULL, and |
| 461 | * create file in sysfs. Returns an error on out of memory. Always cleans up |
| 462 | * if there's an error. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 463 | */ |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 464 | static __modinit int add_sysfs_param(struct module_kobject *mk, |
| 465 | struct kernel_param *kp, |
| 466 | const char *name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 467 | { |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 468 | struct module_param_attrs *new; |
| 469 | struct attribute **attrs; |
| 470 | int err, num; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 471 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 472 | /* We don't bother calling this with invisible parameters. */ |
| 473 | BUG_ON(!kp->perm); |
| 474 | |
| 475 | if (!mk->mp) { |
| 476 | num = 0; |
| 477 | attrs = NULL; |
| 478 | } else { |
| 479 | num = mk->mp->num; |
| 480 | attrs = mk->mp->grp.attrs; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 481 | } |
| 482 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 483 | /* Enlarge. */ |
| 484 | new = krealloc(mk->mp, |
| 485 | sizeof(*mk->mp) + sizeof(mk->mp->attrs[0]) * (num+1), |
| 486 | GFP_KERNEL); |
| 487 | if (!new) { |
| 488 | kfree(mk->mp); |
| 489 | err = -ENOMEM; |
| 490 | goto fail; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 491 | } |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 492 | attrs = krealloc(attrs, sizeof(new->grp.attrs[0])*(num+2), GFP_KERNEL); |
| 493 | if (!attrs) { |
| 494 | err = -ENOMEM; |
| 495 | goto fail_free_new; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 496 | } |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 497 | |
| 498 | /* Sysfs wants everything zeroed. */ |
| 499 | memset(new, 0, sizeof(*new)); |
| 500 | memset(&new->attrs[num], 0, sizeof(new->attrs[num])); |
| 501 | memset(&attrs[num], 0, sizeof(attrs[num])); |
| 502 | new->grp.name = "parameters"; |
| 503 | new->grp.attrs = attrs; |
| 504 | |
| 505 | /* Tack new one on the end. */ |
| 506 | new->attrs[num].param = kp; |
| 507 | new->attrs[num].mattr.show = param_attr_show; |
| 508 | new->attrs[num].mattr.store = param_attr_store; |
| 509 | new->attrs[num].mattr.attr.name = (char *)name; |
| 510 | new->attrs[num].mattr.attr.mode = kp->perm; |
| 511 | new->num = num+1; |
| 512 | |
| 513 | /* Fix up all the pointers, since krealloc can move us */ |
| 514 | for (num = 0; num < new->num; num++) |
| 515 | new->grp.attrs[num] = &new->attrs[num].mattr.attr; |
| 516 | new->grp.attrs[num] = NULL; |
| 517 | |
| 518 | mk->mp = new; |
| 519 | return 0; |
| 520 | |
| 521 | fail_free_new: |
| 522 | kfree(new); |
| 523 | fail: |
| 524 | mk->mp = NULL; |
| 525 | return err; |
| 526 | } |
| 527 | |
Linus Torvalds | d244118 | 2008-10-23 12:07:17 -0700 | [diff] [blame] | 528 | #ifdef CONFIG_MODULES |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 529 | static void free_module_param_attrs(struct module_kobject *mk) |
| 530 | { |
| 531 | kfree(mk->mp->grp.attrs); |
| 532 | kfree(mk->mp); |
| 533 | mk->mp = NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 534 | } |
| 535 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 536 | /* |
| 537 | * module_param_sysfs_setup - setup sysfs support for one module |
| 538 | * @mod: module |
| 539 | * @kparam: module parameters (array) |
| 540 | * @num_params: number of module parameters |
| 541 | * |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 542 | * Adds sysfs entries for module parameters under |
| 543 | * /sys/module/[mod->name]/parameters/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 544 | */ |
| 545 | int module_param_sysfs_setup(struct module *mod, |
| 546 | struct kernel_param *kparam, |
| 547 | unsigned int num_params) |
| 548 | { |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 549 | int i, err; |
| 550 | bool params = false; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 551 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 552 | for (i = 0; i < num_params; i++) { |
| 553 | if (kparam[i].perm == 0) |
| 554 | continue; |
| 555 | err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name); |
| 556 | if (err) |
| 557 | return err; |
| 558 | params = true; |
| 559 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 560 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 561 | if (!params) |
| 562 | return 0; |
| 563 | |
| 564 | /* Create the param group. */ |
| 565 | err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp); |
| 566 | if (err) |
| 567 | free_module_param_attrs(&mod->mkobj); |
| 568 | return err; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 569 | } |
| 570 | |
| 571 | /* |
| 572 | * module_param_sysfs_remove - remove sysfs support for one module |
| 573 | * @mod: module |
| 574 | * |
| 575 | * Remove sysfs entries for module parameters and the corresponding |
| 576 | * kobject. |
| 577 | */ |
| 578 | void module_param_sysfs_remove(struct module *mod) |
| 579 | { |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 580 | if (mod->mkobj.mp) { |
| 581 | sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 582 | /* We are positive that no one is using any param |
| 583 | * attrs at this point. Deallocate immediately. */ |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 584 | free_module_param_attrs(&mod->mkobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 585 | } |
| 586 | } |
| 587 | #endif |
| 588 | |
Rusty Russell | e180a6b | 2009-03-31 13:05:29 -0600 | [diff] [blame^] | 589 | void destroy_params(const struct kernel_param *params, unsigned num) |
| 590 | { |
| 591 | unsigned int i; |
| 592 | |
| 593 | for (i = 0; i < num; i++) |
| 594 | if (params[i].perm & KPARAM_KMALLOCED) |
| 595 | kfree(*(char **)params[i].arg); |
| 596 | } |
| 597 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 598 | static void __init kernel_add_sysfs_param(const char *name, |
| 599 | struct kernel_param *kparam, |
| 600 | unsigned int name_skip) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 601 | { |
| 602 | struct module_kobject *mk; |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 603 | struct kobject *kobj; |
| 604 | int err; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 605 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 606 | kobj = kset_find_obj(module_kset, name); |
| 607 | if (kobj) { |
| 608 | /* We already have one. Remove params so we can add more. */ |
| 609 | mk = to_module_kobject(kobj); |
| 610 | /* We need to remove it before adding parameters. */ |
| 611 | sysfs_remove_group(&mk->kobj, &mk->mp->grp); |
| 612 | } else { |
| 613 | mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL); |
| 614 | BUG_ON(!mk); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 615 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 616 | mk->mod = THIS_MODULE; |
| 617 | mk->kobj.kset = module_kset; |
| 618 | err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL, |
| 619 | "%s", name); |
| 620 | if (err) { |
| 621 | kobject_put(&mk->kobj); |
| 622 | printk(KERN_ERR "Module '%s' failed add to sysfs, " |
| 623 | "error number %d\n", name, err); |
| 624 | printk(KERN_ERR "The system will be unstable now.\n"); |
| 625 | return; |
| 626 | } |
| 627 | /* So that exit path is even. */ |
| 628 | kobject_get(&mk->kobj); |
Greg Kroah-Hartman | 74c5b59 | 2007-07-30 11:26:38 -0700 | [diff] [blame] | 629 | } |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 630 | |
| 631 | /* These should not fail at boot. */ |
| 632 | err = add_sysfs_param(mk, kparam, kparam->name + name_skip); |
| 633 | BUG_ON(err); |
| 634 | err = sysfs_create_group(&mk->kobj, &mk->mp->grp); |
| 635 | BUG_ON(err); |
Kay Sievers | f30c53a | 2007-01-15 20:22:02 +0100 | [diff] [blame] | 636 | kobject_uevent(&mk->kobj, KOBJ_ADD); |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 637 | kobject_put(&mk->kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 638 | } |
| 639 | |
| 640 | /* |
| 641 | * param_sysfs_builtin - add contents in /sys/parameters for built-in modules |
| 642 | * |
| 643 | * Add module_parameters to sysfs for "modules" built into the kernel. |
| 644 | * |
| 645 | * The "module" name (KBUILD_MODNAME) is stored before a dot, the |
| 646 | * "parameter" name is stored behind a dot in kernel_param->name. So, |
| 647 | * extract the "module" name for all built-in kernel_param-eters, |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 648 | * and for all who have the same, call kernel_add_sysfs_param. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 649 | */ |
| 650 | static void __init param_sysfs_builtin(void) |
| 651 | { |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 652 | struct kernel_param *kp; |
| 653 | unsigned int name_len; |
| 654 | char modname[MODULE_NAME_LEN]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 655 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 656 | for (kp = __start___param; kp < __stop___param; kp++) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 657 | char *dot; |
| 658 | |
Rusty Russell | 9b473de | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 659 | if (kp->perm == 0) |
| 660 | continue; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 661 | |
Rusty Russell | 730b69d | 2008-10-22 10:00:22 -0500 | [diff] [blame] | 662 | dot = strchr(kp->name, '.'); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 663 | if (!dot) { |
Rusty Russell | 67e67ce | 2008-10-22 10:00:23 -0500 | [diff] [blame] | 664 | /* This happens for core_param() */ |
| 665 | strcpy(modname, "kernel"); |
| 666 | name_len = 0; |
| 667 | } else { |
| 668 | name_len = dot - kp->name + 1; |
| 669 | strlcpy(modname, kp->name, name_len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 670 | } |
Rusty Russell | 67e67ce | 2008-10-22 10:00:23 -0500 | [diff] [blame] | 671 | kernel_add_sysfs_param(modname, kp, name_len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 672 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 673 | } |
| 674 | |
| 675 | |
| 676 | /* module-related sysfs stuff */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 677 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 678 | static ssize_t module_attr_show(struct kobject *kobj, |
| 679 | struct attribute *attr, |
| 680 | char *buf) |
| 681 | { |
| 682 | struct module_attribute *attribute; |
| 683 | struct module_kobject *mk; |
| 684 | int ret; |
| 685 | |
| 686 | attribute = to_module_attr(attr); |
| 687 | mk = to_module_kobject(kobj); |
| 688 | |
| 689 | if (!attribute->show) |
Dmitry Torokhov | 70f2817 | 2005-04-29 01:27:34 -0500 | [diff] [blame] | 690 | return -EIO; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 691 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 692 | ret = attribute->show(attribute, mk->mod, buf); |
| 693 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 694 | return ret; |
| 695 | } |
| 696 | |
| 697 | static ssize_t module_attr_store(struct kobject *kobj, |
| 698 | struct attribute *attr, |
| 699 | const char *buf, size_t len) |
| 700 | { |
| 701 | struct module_attribute *attribute; |
| 702 | struct module_kobject *mk; |
| 703 | int ret; |
| 704 | |
| 705 | attribute = to_module_attr(attr); |
| 706 | mk = to_module_kobject(kobj); |
| 707 | |
| 708 | if (!attribute->store) |
Dmitry Torokhov | 70f2817 | 2005-04-29 01:27:34 -0500 | [diff] [blame] | 709 | return -EIO; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 710 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 711 | ret = attribute->store(attribute, mk->mod, buf, len); |
| 712 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 713 | return ret; |
| 714 | } |
| 715 | |
| 716 | static struct sysfs_ops module_sysfs_ops = { |
| 717 | .show = module_attr_show, |
| 718 | .store = module_attr_store, |
| 719 | }; |
| 720 | |
Kay Sievers | 270a6c4 | 2007-01-18 13:26:15 +0100 | [diff] [blame] | 721 | static int uevent_filter(struct kset *kset, struct kobject *kobj) |
| 722 | { |
| 723 | struct kobj_type *ktype = get_ktype(kobj); |
| 724 | |
| 725 | if (ktype == &module_ktype) |
| 726 | return 1; |
| 727 | return 0; |
| 728 | } |
| 729 | |
| 730 | static struct kset_uevent_ops module_uevent_ops = { |
| 731 | .filter = uevent_filter, |
| 732 | }; |
| 733 | |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 734 | struct kset *module_kset; |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 735 | int module_sysfs_initialized; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 736 | |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 737 | struct kobj_type module_ktype = { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 738 | .sysfs_ops = &module_sysfs_ops, |
| 739 | }; |
| 740 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 741 | /* |
| 742 | * param_sysfs_init - wrapper for built-in params support |
| 743 | */ |
| 744 | static int __init param_sysfs_init(void) |
| 745 | { |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 746 | module_kset = kset_create_and_add("module", &module_uevent_ops, NULL); |
| 747 | if (!module_kset) { |
| 748 | printk(KERN_WARNING "%s (%d): error creating kset\n", |
| 749 | __FILE__, __LINE__); |
| 750 | return -ENOMEM; |
Randy Dunlap | d8c7649 | 2006-09-29 01:58:55 -0700 | [diff] [blame] | 751 | } |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 752 | module_sysfs_initialized = 1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 753 | |
| 754 | param_sysfs_builtin(); |
| 755 | |
| 756 | return 0; |
| 757 | } |
Mark Huang | d10be6d | 2006-09-29 01:59:34 -0700 | [diff] [blame] | 758 | subsys_initcall(param_sysfs_init); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 759 | |
Greg Kroah-Hartman | 7405c1e | 2007-11-01 10:39:50 -0700 | [diff] [blame] | 760 | #endif /* CONFIG_SYSFS */ |
Randy Dunlap | ef665c1 | 2007-02-13 15:19:06 -0800 | [diff] [blame] | 761 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 762 | EXPORT_SYMBOL(param_set_byte); |
| 763 | EXPORT_SYMBOL(param_get_byte); |
| 764 | EXPORT_SYMBOL(param_set_short); |
| 765 | EXPORT_SYMBOL(param_get_short); |
| 766 | EXPORT_SYMBOL(param_set_ushort); |
| 767 | EXPORT_SYMBOL(param_get_ushort); |
| 768 | EXPORT_SYMBOL(param_set_int); |
| 769 | EXPORT_SYMBOL(param_get_int); |
| 770 | EXPORT_SYMBOL(param_set_uint); |
| 771 | EXPORT_SYMBOL(param_get_uint); |
| 772 | EXPORT_SYMBOL(param_set_long); |
| 773 | EXPORT_SYMBOL(param_get_long); |
| 774 | EXPORT_SYMBOL(param_set_ulong); |
| 775 | EXPORT_SYMBOL(param_get_ulong); |
| 776 | EXPORT_SYMBOL(param_set_charp); |
| 777 | EXPORT_SYMBOL(param_get_charp); |
| 778 | EXPORT_SYMBOL(param_set_bool); |
| 779 | EXPORT_SYMBOL(param_get_bool); |
| 780 | EXPORT_SYMBOL(param_set_invbool); |
| 781 | EXPORT_SYMBOL(param_get_invbool); |
| 782 | EXPORT_SYMBOL(param_array_set); |
| 783 | EXPORT_SYMBOL(param_array_get); |
| 784 | EXPORT_SYMBOL(param_set_copystring); |
| 785 | EXPORT_SYMBOL(param_get_string); |