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