blob: aa7d6f2213f10dece53aba3c6a8a2af4e339e319 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/* Helpers for initial module or kernel cmdline parsing
3 Copyright (C) 2001 Rusty Russell.
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kernel.h>
7#include <linux/string.h>
8#include <linux/errno.h>
9#include <linux/module.h>
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -070010#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/device.h>
12#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080013#include <linux/slab.h>
Peter Oberparleiter26d052b2009-07-06 17:11:22 +020014#include <linux/ctype.h>
David Howells20657f62019-08-19 17:17:55 -070015#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
Rusty Russellcf2fde72015-06-26 06:44:38 +093017#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +093018/* Protects all built-in parameters, modules use their own param_lock */
Rusty Russell907b29e2010-08-11 23:04:19 -060019static DEFINE_MUTEX(param_lock);
20
Dan Streetmanb51d23e2015-06-17 06:18:52 +093021/* Use the module's mutex, or if built-in use the built-in mutex */
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100022#ifdef CONFIG_MODULES
Dan Streetmanb51d23e2015-06-17 06:18:52 +093023#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100024#else
25#define KPARAM_MUTEX(mod) (&param_lock)
26#endif
Rusty Russellcf2fde72015-06-26 06:44:38 +093027
28static inline void check_kparam_locked(struct module *mod)
29{
30 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
31}
32#else
33static inline void check_kparam_locked(struct module *mod)
34{
35}
36#endif /* !CONFIG_SYSFS */
Dan Streetmanb51d23e2015-06-17 06:18:52 +093037
Rusty Russella1054322010-08-11 23:04:18 -060038/* This just allows us to keep track of which parameters are kmalloced. */
39struct kmalloced_param {
40 struct list_head list;
41 char val[];
42};
Rusty Russella1054322010-08-11 23:04:18 -060043static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093044static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060045
46static void *kmalloc_parameter(unsigned int size)
47{
48 struct kmalloced_param *p;
49
50 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
51 if (!p)
52 return NULL;
53
Dan Streetmanb51d23e2015-06-17 06:18:52 +093054 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060055 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093056 spin_unlock(&kmalloced_params_lock);
57
Rusty Russella1054322010-08-11 23:04:18 -060058 return p->val;
59}
60
61/* Does nothing if parameter wasn't kmalloced above. */
62static void maybe_kfree_parameter(void *param)
63{
64 struct kmalloced_param *p;
65
Dan Streetmanb51d23e2015-06-17 06:18:52 +093066 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060067 list_for_each_entry(p, &kmalloced_params, list) {
68 if (p->val == param) {
69 list_del(&p->list);
70 kfree(p);
71 break;
72 }
73 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093074 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060075}
76
Michal Schmidtb1e4d202011-10-10 00:03:37 +020077static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078{
79 if (c == '-')
80 return '_';
81 return c;
82}
83
Michal Schmidtb1e4d202011-10-10 00:03:37 +020084bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020086 size_t i;
87
88 for (i = 0; i < n; i++) {
89 if (dash2underscore(a[i]) != dash2underscore(b[i]))
90 return false;
91 }
92 return true;
93}
94
95bool parameq(const char *a, const char *b)
96{
97 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098}
99
David Howells20657f62019-08-19 17:17:55 -0700100static bool param_check_unsafe(const struct kernel_param *kp)
Rusty Russell7a486d372014-08-27 06:25:23 +0930101{
David Howells20657f62019-08-19 17:17:55 -0700102 if (kp->flags & KERNEL_PARAM_FL_HWPARAM &&
103 security_locked_down(LOCKDOWN_MODULE_PARAMETERS))
104 return false;
105
Rusty Russell7a486d372014-08-27 06:25:23 +0930106 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
Chris Wilsonedc41b32018-04-10 16:35:18 -0700107 pr_notice("Setting dangerous option %s - tainting kernel\n",
108 kp->name);
Rusty Russell7a486d372014-08-27 06:25:23 +0930109 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
110 }
David Howells20657f62019-08-19 17:17:55 -0700111
112 return true;
Rusty Russell7a486d372014-08-27 06:25:23 +0930113}
114
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115static int parse_one(char *param,
116 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600117 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600118 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030120 s16 min_level,
121 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700122 void *arg,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600123 int (*handle_unknown)(char *param, char *val,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700124 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
126 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600127 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 /* Find parameter */
130 for (i = 0; i < num_params; i++) {
131 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030132 if (params[i].level < min_level
133 || params[i].level > max_level)
134 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300135 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930136 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930137 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600138 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600139 pr_debug("handling %s with %p\n", param,
140 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930141 kernel_param_lock(params[i].mod);
David Howells20657f62019-08-19 17:17:55 -0700142 if (param_check_unsafe(&params[i]))
143 err = params[i].ops->set(val, &params[i]);
144 else
145 err = -EPERM;
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930146 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600147 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 }
149 }
150
151 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600152 pr_debug("doing %s: %s='%s'\n", doing, param, val);
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700153 return handle_unknown(param, val, doing, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 }
155
Jim Cromie9fb48c72012-04-27 14:30:34 -0600156 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 return -ENOENT;
158}
159
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930161char *parse_args(const char *doing,
162 char *args,
163 const struct kernel_param *params,
164 unsigned num,
165 s16 min_level,
166 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700167 void *arg,
168 int (*unknown)(char *param, char *val,
169 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930171 char *param, *val, *err = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Rusty Russellf36462f2005-09-27 21:45:34 -0700173 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800174 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700175
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600176 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600177 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 while (*args) {
180 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800181 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930184 /* Stop at -- */
185 if (!val && strcmp(param, "--") == 0)
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930186 return err ?: args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800187 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600188 ret = parse_one(param, val, doing, params, num,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700189 min_level, max_level, arg, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600190 if (irq_was_disabled && !irqs_disabled())
191 pr_warn("%s: option '%s' enabled irq's!\n",
192 doing, param);
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 switch (ret) {
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930195 case 0:
196 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600198 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930199 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600201 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600202 doing, val ?: "", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 break;
204 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600205 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600206 doing, val ?: "", param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930207 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 }
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930209
210 err = ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 }
212
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930213 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214}
215
216/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030217#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600218 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030220 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600222 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 { \
Jean Delvare96802e62017-10-03 16:16:38 -0700224 return scnprintf(buffer, PAGE_SIZE, format "\n", \
Chen Gangf4940ab2013-08-20 15:35:04 +0930225 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600226 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930227 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600228 .set = param_set_##name, \
229 .get = param_get_##name, \
230 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600231 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600232 EXPORT_SYMBOL(param_get_##name); \
233 EXPORT_SYMBOL(param_ops_##name)
234
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Paul Menzel7d836572020-07-03 16:29:38 +0200236STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
237STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
238STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
239STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
240STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
241STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
242STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
243STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
244STANDARD_PARAM_DEF(hexint, unsigned int, "%#08x", kstrtouint);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600246int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600249 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 return -ENOSPC;
251 }
252
Rusty Russella1054322010-08-11 23:04:18 -0600253 maybe_kfree_parameter(*(char **)kp->arg);
254
255 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600256 * don't need to; this mangled commandline is preserved. */
257 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600258 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600259 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600260 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600261 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600262 } else
263 *(const char **)kp->arg = val;
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 return 0;
266}
Rusty Russella14fe242010-08-11 23:04:11 -0600267EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600269int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Jean Delvare96802e62017-10-03 16:16:38 -0700271 return scnprintf(buffer, PAGE_SIZE, "%s\n", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272}
Rusty Russella14fe242010-08-11 23:04:11 -0600273EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Dan Streetman3d9c6372015-11-06 16:29:12 -0800275void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600276{
277 maybe_kfree_parameter(*((char **)arg));
278}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800279EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600280
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930281const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600282 .set = param_set_charp,
283 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600284 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600285};
286EXPORT_SYMBOL(param_ops_charp);
287
Rusty Russellfddd5202009-06-12 21:46:57 -0600288/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600289int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 /* No equals means "set"... */
292 if (!val) val = "1";
293
294 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030295 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
Rusty Russella14fe242010-08-11 23:04:11 -0600297EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600299int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
301 /* Y and N chosen as being relatively non-coder friendly */
Jean Delvare96802e62017-10-03 16:16:38 -0700302 return sprintf(buffer, "%c\n", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
Rusty Russella14fe242010-08-11 23:04:11 -0600304EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930306const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930307 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600308 .set = param_set_bool,
309 .get = param_get_bool,
310};
311EXPORT_SYMBOL(param_ops_bool);
312
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930313int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
314{
315 int err = 0;
316 bool new_value;
317 bool orig_value = *(bool *)kp->arg;
318 struct kernel_param dummy_kp = *kp;
319
320 dummy_kp.arg = &new_value;
321
322 err = param_set_bool(val, &dummy_kp);
323 if (err)
324 return err;
325
326 /* Don't let them unset it once it's set! */
327 if (!new_value && orig_value)
328 return -EROFS;
329
330 if (new_value)
331 err = param_set_bool(val, kp);
332
333 return err;
334}
335EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
336
337const struct kernel_param_ops param_ops_bool_enable_only = {
338 .flags = KERNEL_PARAM_OPS_FL_NOARG,
339 .set = param_set_bool_enable_only,
340 .get = param_get_bool,
341};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930342EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930343
Rusty Russellfddd5202009-06-12 21:46:57 -0600344/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600345int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346{
Rusty Russellfddd5202009-06-12 21:46:57 -0600347 int ret;
348 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700349 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Jan Beulich22e48ea2007-10-16 23:29:34 -0700351 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 ret = param_set_bool(val, &dummy);
353 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600354 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 return ret;
356}
Rusty Russella14fe242010-08-11 23:04:11 -0600357EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600359int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
Jean Delvare96802e62017-10-03 16:16:38 -0700361 return sprintf(buffer, "%c\n", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362}
Rusty Russella14fe242010-08-11 23:04:11 -0600363EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930365const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600366 .set = param_set_invbool,
367 .get = param_get_invbool,
368};
369EXPORT_SYMBOL(param_ops_invbool);
370
Rusty Russell69116f22012-01-13 09:32:17 +1030371int param_set_bint(const char *val, const struct kernel_param *kp)
372{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930373 /* Match bool exactly, by re-using it. */
374 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030375 bool v;
376 int ret;
377
Rusty Russell69116f22012-01-13 09:32:17 +1030378 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030379
380 ret = param_set_bool(val, &boolkp);
381 if (ret == 0)
382 *(int *)kp->arg = v;
383 return ret;
384}
385EXPORT_SYMBOL(param_set_bint);
386
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930387const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930388 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030389 .set = param_set_bint,
390 .get = param_get_int,
391};
392EXPORT_SYMBOL(param_ops_bint);
393
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700394/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930395static int param_array(struct module *mod,
396 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800397 const char *val,
398 unsigned int min, unsigned int max,
399 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600400 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030401 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800402 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403{
404 int ret;
405 struct kernel_param kp;
406 char save;
407
408 /* Get the name right for errors. */
409 kp.name = name;
410 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030411 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 *num = 0;
414 /* We expect a comma-separated list of values. */
415 do {
416 int len;
417
418 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600419 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 return -EINVAL;
421 }
422 len = strcspn(val, ",");
423
424 /* nul-terminate and parse */
425 save = val[len];
426 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930427 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 ret = set(val, &kp);
429
430 if (ret != 0)
431 return ret;
432 kp.arg += elemsize;
433 val += len+1;
434 (*num)++;
435 } while (save == ',');
436
437 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600438 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 return -EINVAL;
440 }
441 return 0;
442}
443
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600444static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700446 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700447 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930449 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030450 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600451 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452}
453
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600454static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
456 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700457 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930458 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
Jean Delvare96802e62017-10-03 16:16:38 -0700461 /* Replace \n with comma */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 if (i)
Jean Delvare96802e62017-10-03 16:16:38 -0700463 buffer[off - 1] = ',';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930465 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600466 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 if (ret < 0)
468 return ret;
469 off += ret;
470 }
471 buffer[off] = '\0';
472 return off;
473}
474
Rusty Russelle6df34a2010-08-11 23:04:17 -0600475static void param_array_free(void *arg)
476{
477 unsigned int i;
478 const struct kparam_array *arr = arg;
479
480 if (arr->ops->free)
481 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
482 arr->ops->free(arr->elem + arr->elemsize * i);
483}
484
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930485const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600486 .set = param_array_set,
487 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600488 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600489};
490EXPORT_SYMBOL(param_array_ops);
491
492int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700494 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600497 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 kp->name, kps->maxlen-1);
499 return -ENOSPC;
500 }
501 strcpy(kps->string, val);
502 return 0;
503}
Rusty Russella14fe242010-08-11 23:04:11 -0600504EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600506int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700508 const struct kparam_string *kps = kp->str;
Jean Delvare96802e62017-10-03 16:16:38 -0700509 return scnprintf(buffer, PAGE_SIZE, "%s\n", kps->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
Rusty Russella14fe242010-08-11 23:04:11 -0600511EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930513const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600514 .set = param_set_copystring,
515 .get = param_get_string,
516};
517EXPORT_SYMBOL(param_ops_string);
518
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500520#define to_module_attr(n) container_of(n, struct module_attribute, attr)
521#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523struct param_attribute
524{
525 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600526 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527};
528
529struct module_param_attrs
530{
Rusty Russell9b473de2008-10-22 10:00:22 -0500531 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 struct attribute_group grp;
533 struct param_attribute attrs[0];
534};
535
Randy Dunlapef665c12007-02-13 15:19:06 -0800536#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500537#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
539static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930540 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
542 int count;
543 struct param_attribute *attribute = to_param_attr(mattr);
544
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600545 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 return -EPERM;
547
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930548 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600549 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930550 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return count;
552}
553
554/* sysfs always hands a nul-terminated string in buf. We rely on that. */
555static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930556 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 const char *buf, size_t len)
558{
559 int err;
560 struct param_attribute *attribute = to_param_attr(mattr);
561
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600562 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 return -EPERM;
564
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930565 kernel_param_lock(mk->mod);
David Howells20657f62019-08-19 17:17:55 -0700566 if (param_check_unsafe(attribute->param))
567 err = attribute->param->ops->set(buf, attribute->param);
568 else
569 err = -EPERM;
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930570 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 if (!err)
572 return len;
573 return err;
574}
Randy Dunlapef665c12007-02-13 15:19:06 -0800575#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577#ifdef CONFIG_MODULES
578#define __modinit
579#else
580#define __modinit __init
581#endif
582
Randy Dunlapef665c12007-02-13 15:19:06 -0800583#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930584void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600585{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930586 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600587}
Rusty Russell907b29e2010-08-11 23:04:19 -0600588
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930589void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600590{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930591 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600592}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930593
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930594EXPORT_SYMBOL(kernel_param_lock);
595EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500598 * add_sysfs_param - add a parameter to sysfs
599 * @mk: struct module_kobject
Jean Delvare630cc2b2017-10-03 16:14:18 -0700600 * @kp: the actual parameter definition to add to sysfs
Rusty Russell9b473de2008-10-22 10:00:22 -0500601 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500603 * Create a kobject if for a (per-module) parameter if mp NULL, and
604 * create file in sysfs. Returns an error on out of memory. Always cleans up
605 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500607static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600608 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500609 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030611 struct module_param_attrs *new_mp;
612 struct attribute **new_attrs;
613 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Rusty Russell9b473de2008-10-22 10:00:22 -0500615 /* We don't bother calling this with invisible parameters. */
616 BUG_ON(!kp->perm);
617
618 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030619 /* First allocation. */
620 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
621 if (!mk->mp)
622 return -ENOMEM;
623 mk->mp->grp.name = "parameters";
624 /* NULL-terminated attribute array. */
625 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
626 GFP_KERNEL);
627 /* Caller will cleanup via free_module_param_attrs */
628 if (!mk->mp->grp.attrs)
629 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 }
631
Rusty Russell18eb74f2014-11-10 09:32:29 +1030632 /* Enlarge allocations. */
633 new_mp = krealloc(mk->mp,
634 sizeof(*mk->mp) +
635 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
636 GFP_KERNEL);
637 if (!new_mp)
638 return -ENOMEM;
639 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500640
Rusty Russell18eb74f2014-11-10 09:32:29 +1030641 /* Extra pointer for NULL terminator */
642 new_attrs = krealloc(mk->mp->grp.attrs,
643 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
644 GFP_KERNEL);
645 if (!new_attrs)
646 return -ENOMEM;
647 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500648
649 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030650 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030651 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
652 mk->mp->attrs[mk->mp->num].param = kp;
653 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030654 /* Do not allow runtime DAC changes to make param writable. */
655 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
656 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030657 else
658 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030659 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
660 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
661 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500662
663 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030664 for (i = 0; i < mk->mp->num; i++)
665 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
666 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500667 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500668}
669
Linus Torvaldsd2441182008-10-23 12:07:17 -0700670#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500671static void free_module_param_attrs(struct module_kobject *mk)
672{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030673 if (mk->mp)
674 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500675 kfree(mk->mp);
676 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*
680 * module_param_sysfs_setup - setup sysfs support for one module
681 * @mod: module
682 * @kparam: module parameters (array)
683 * @num_params: number of module parameters
684 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500685 * Adds sysfs entries for module parameters under
686 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 */
688int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600689 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 unsigned int num_params)
691{
Rusty Russell9b473de2008-10-22 10:00:22 -0500692 int i, err;
693 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Rusty Russell9b473de2008-10-22 10:00:22 -0500695 for (i = 0; i < num_params; i++) {
696 if (kparam[i].perm == 0)
697 continue;
698 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030699 if (err) {
700 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500701 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030702 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500703 params = true;
704 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Rusty Russell9b473de2008-10-22 10:00:22 -0500706 if (!params)
707 return 0;
708
709 /* Create the param group. */
710 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
711 if (err)
712 free_module_param_attrs(&mod->mkobj);
713 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
715
716/*
717 * module_param_sysfs_remove - remove sysfs support for one module
718 * @mod: module
719 *
720 * Remove sysfs entries for module parameters and the corresponding
721 * kobject.
722 */
723void module_param_sysfs_remove(struct module *mod)
724{
Rusty Russell9b473de2008-10-22 10:00:22 -0500725 if (mod->mkobj.mp) {
726 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 /* We are positive that no one is using any param
728 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500729 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 }
731}
732#endif
733
Rusty Russelle180a6b2009-03-31 13:05:29 -0600734void destroy_params(const struct kernel_param *params, unsigned num)
735{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600736 unsigned int i;
737
738 for (i = 0; i < num; i++)
739 if (params[i].ops->free)
740 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600741}
742
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800743static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
745 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500746 struct kobject *kobj;
747 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 kobj = kset_find_obj(module_kset, name);
750 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500751 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500752 } else {
753 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
754 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Rusty Russell9b473de2008-10-22 10:00:22 -0500756 mk->mod = THIS_MODULE;
757 mk->kobj.kset = module_kset;
758 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
759 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930760#ifdef CONFIG_MODULES
761 if (!err)
762 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
763#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500764 if (err) {
765 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600766 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800767 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800768 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500769 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800770
771 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500772 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700773 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500774
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800775 return mk;
776}
777
778static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700779 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800780 unsigned int name_skip)
781{
782 struct module_kobject *mk;
783 int err;
784
785 mk = locate_module_kobject(name);
786 if (!mk)
787 return;
788
789 /* We need to remove old parameters before adding more. */
790 if (mk->mp)
791 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
792
Rusty Russell9b473de2008-10-22 10:00:22 -0500793 /* These should not fail at boot. */
794 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
795 BUG_ON(err);
796 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
797 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100798 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500799 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802/*
Jean Delvareb634d132013-07-02 15:35:11 +0930803 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 *
805 * Add module_parameters to sysfs for "modules" built into the kernel.
806 *
807 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
808 * "parameter" name is stored behind a dot in kernel_param->name. So,
809 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500810 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 */
812static void __init param_sysfs_builtin(void)
813{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700814 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500815 unsigned int name_len;
816 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Rusty Russell9b473de2008-10-22 10:00:22 -0500818 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 char *dot;
820
Rusty Russell9b473de2008-10-22 10:00:22 -0500821 if (kp->perm == 0)
822 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Rusty Russell730b69d2008-10-22 10:00:22 -0500824 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500826 /* This happens for core_param() */
827 strcpy(modname, "kernel");
828 name_len = 0;
829 } else {
830 name_len = dot - kp->name + 1;
831 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500833 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800837ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930838 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800839{
840 struct module_version_attribute *vattr =
841 container_of(mattr, struct module_version_attribute, mattr);
842
Chen Gangf4940ab2013-08-20 15:35:04 +0930843 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800844}
845
Johan Hovoldb1120822020-11-23 11:23:15 +0100846extern const struct module_version_attribute __start___modver[];
847extern const struct module_version_attribute __stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800848
849static void __init version_sysfs_builtin(void)
850{
Johan Hovoldb1120822020-11-23 11:23:15 +0100851 const struct module_version_attribute *vattr;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800852 struct module_kobject *mk;
853 int err;
854
Johan Hovoldb1120822020-11-23 11:23:15 +0100855 for (vattr = __start___modver; vattr < __stop___modver; vattr++) {
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800856 mk = locate_module_kobject(vattr->module_name);
857 if (mk) {
858 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930859 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800860 kobject_uevent(&mk->kobj, KOBJ_ADD);
861 kobject_put(&mk->kobj);
862 }
863 }
864}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
866/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868static ssize_t module_attr_show(struct kobject *kobj,
869 struct attribute *attr,
870 char *buf)
871{
872 struct module_attribute *attribute;
873 struct module_kobject *mk;
874 int ret;
875
876 attribute = to_module_attr(attr);
877 mk = to_module_kobject(kobj);
878
879 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500880 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881
Kay Sievers4befb022011-07-24 22:06:04 +0930882 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 return ret;
885}
886
887static ssize_t module_attr_store(struct kobject *kobj,
888 struct attribute *attr,
889 const char *buf, size_t len)
890{
891 struct module_attribute *attribute;
892 struct module_kobject *mk;
893 int ret;
894
895 attribute = to_module_attr(attr);
896 mk = to_module_kobject(kobj);
897
898 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500899 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Kay Sievers4befb022011-07-24 22:06:04 +0930901 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 return ret;
904}
905
Emese Revfy52cf25d2010-01-19 02:58:23 +0100906static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 .show = module_attr_show,
908 .store = module_attr_store,
909};
910
Kay Sievers270a6c42007-01-18 13:26:15 +0100911static int uevent_filter(struct kset *kset, struct kobject *kobj)
912{
913 struct kobj_type *ktype = get_ktype(kobj);
914
915 if (ktype == &module_ktype)
916 return 1;
917 return 0;
918}
919
Emese Revfy9cd43612009-12-31 14:52:51 +0100920static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100921 .filter = uevent_filter,
922};
923
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700924struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700925int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Li Zhong942e4432013-09-03 16:33:57 +0930927static void module_kobj_release(struct kobject *kobj)
928{
929 struct module_kobject *mk = to_module_kobject(kobj);
930 complete(mk->kobj_completion);
931}
932
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700933struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930934 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 .sysfs_ops = &module_sysfs_ops,
936};
937
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938/*
939 * param_sysfs_init - wrapper for built-in params support
940 */
941static int __init param_sysfs_init(void)
942{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700943 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
944 if (!module_kset) {
945 printk(KERN_WARNING "%s (%d): error creating kset\n",
946 __FILE__, __LINE__);
947 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700948 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700949 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800951 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 param_sysfs_builtin();
953
954 return 0;
955}
Mark Huangd10be6d2006-09-29 01:59:34 -0700956subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700958#endif /* CONFIG_SYSFS */