blob: 5b92310425c50a5314942b14d7866f7fec383c20 [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
Sagi Grimberg2a14c9a2021-06-16 14:19:33 -0700246int param_set_uint_minmax(const char *val, const struct kernel_param *kp,
247 unsigned int min, unsigned int max)
248{
249 unsigned int num;
250 int ret;
251
252 if (!val)
253 return -EINVAL;
254 ret = kstrtouint(val, 0, &num);
255 if (ret)
256 return ret;
257 if (num < min || num > max)
258 return -EINVAL;
259 *((unsigned int *)kp->arg) = num;
260 return 0;
261}
262EXPORT_SYMBOL_GPL(param_set_uint_minmax);
263
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600264int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600267 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 return -ENOSPC;
269 }
270
Rusty Russella1054322010-08-11 23:04:18 -0600271 maybe_kfree_parameter(*(char **)kp->arg);
272
273 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600274 * don't need to; this mangled commandline is preserved. */
275 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600276 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600277 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600278 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600279 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600280 } else
281 *(const char **)kp->arg = val;
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return 0;
284}
Rusty Russella14fe242010-08-11 23:04:11 -0600285EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600287int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
Jean Delvare96802e62017-10-03 16:16:38 -0700289 return scnprintf(buffer, PAGE_SIZE, "%s\n", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290}
Rusty Russella14fe242010-08-11 23:04:11 -0600291EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Dan Streetman3d9c6372015-11-06 16:29:12 -0800293void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600294{
295 maybe_kfree_parameter(*((char **)arg));
296}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800297EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600298
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930299const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600300 .set = param_set_charp,
301 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600302 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600303};
304EXPORT_SYMBOL(param_ops_charp);
305
Rusty Russellfddd5202009-06-12 21:46:57 -0600306/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600307int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
309 /* No equals means "set"... */
310 if (!val) val = "1";
311
312 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030313 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314}
Rusty Russella14fe242010-08-11 23:04:11 -0600315EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600317int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318{
319 /* Y and N chosen as being relatively non-coder friendly */
Jean Delvare96802e62017-10-03 16:16:38 -0700320 return sprintf(buffer, "%c\n", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
Rusty Russella14fe242010-08-11 23:04:11 -0600322EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930324const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930325 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600326 .set = param_set_bool,
327 .get = param_get_bool,
328};
329EXPORT_SYMBOL(param_ops_bool);
330
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930331int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
332{
333 int err = 0;
334 bool new_value;
335 bool orig_value = *(bool *)kp->arg;
336 struct kernel_param dummy_kp = *kp;
337
338 dummy_kp.arg = &new_value;
339
340 err = param_set_bool(val, &dummy_kp);
341 if (err)
342 return err;
343
344 /* Don't let them unset it once it's set! */
345 if (!new_value && orig_value)
346 return -EROFS;
347
348 if (new_value)
349 err = param_set_bool(val, kp);
350
351 return err;
352}
353EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
354
355const struct kernel_param_ops param_ops_bool_enable_only = {
356 .flags = KERNEL_PARAM_OPS_FL_NOARG,
357 .set = param_set_bool_enable_only,
358 .get = param_get_bool,
359};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930360EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930361
Rusty Russellfddd5202009-06-12 21:46:57 -0600362/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600363int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
Rusty Russellfddd5202009-06-12 21:46:57 -0600365 int ret;
366 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700367 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Jan Beulich22e48ea2007-10-16 23:29:34 -0700369 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 ret = param_set_bool(val, &dummy);
371 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600372 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 return ret;
374}
Rusty Russella14fe242010-08-11 23:04:11 -0600375EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600377int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378{
Jean Delvare96802e62017-10-03 16:16:38 -0700379 return sprintf(buffer, "%c\n", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380}
Rusty Russella14fe242010-08-11 23:04:11 -0600381EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930383const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600384 .set = param_set_invbool,
385 .get = param_get_invbool,
386};
387EXPORT_SYMBOL(param_ops_invbool);
388
Rusty Russell69116f22012-01-13 09:32:17 +1030389int param_set_bint(const char *val, const struct kernel_param *kp)
390{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930391 /* Match bool exactly, by re-using it. */
392 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030393 bool v;
394 int ret;
395
Rusty Russell69116f22012-01-13 09:32:17 +1030396 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030397
398 ret = param_set_bool(val, &boolkp);
399 if (ret == 0)
400 *(int *)kp->arg = v;
401 return ret;
402}
403EXPORT_SYMBOL(param_set_bint);
404
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930405const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930406 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030407 .set = param_set_bint,
408 .get = param_get_int,
409};
410EXPORT_SYMBOL(param_ops_bint);
411
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700412/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930413static int param_array(struct module *mod,
414 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800415 const char *val,
416 unsigned int min, unsigned int max,
417 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600418 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030419 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800420 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
422 int ret;
423 struct kernel_param kp;
424 char save;
425
426 /* Get the name right for errors. */
427 kp.name = name;
428 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030429 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 *num = 0;
432 /* We expect a comma-separated list of values. */
433 do {
434 int len;
435
436 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600437 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return -EINVAL;
439 }
440 len = strcspn(val, ",");
441
442 /* nul-terminate and parse */
443 save = val[len];
444 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930445 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 ret = set(val, &kp);
447
448 if (ret != 0)
449 return ret;
450 kp.arg += elemsize;
451 val += len+1;
452 (*num)++;
453 } while (save == ',');
454
455 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600456 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 return -EINVAL;
458 }
459 return 0;
460}
461
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600462static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700464 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700465 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930467 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030468 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600469 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470}
471
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600472static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473{
474 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700475 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930476 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
Jean Delvare96802e62017-10-03 16:16:38 -0700479 /* Replace \n with comma */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 if (i)
Jean Delvare96802e62017-10-03 16:16:38 -0700481 buffer[off - 1] = ',';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930483 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600484 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 if (ret < 0)
486 return ret;
487 off += ret;
488 }
489 buffer[off] = '\0';
490 return off;
491}
492
Rusty Russelle6df34a2010-08-11 23:04:17 -0600493static void param_array_free(void *arg)
494{
495 unsigned int i;
496 const struct kparam_array *arr = arg;
497
498 if (arr->ops->free)
499 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
500 arr->ops->free(arr->elem + arr->elemsize * i);
501}
502
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930503const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600504 .set = param_array_set,
505 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600506 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600507};
508EXPORT_SYMBOL(param_array_ops);
509
510int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700512 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600515 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 kp->name, kps->maxlen-1);
517 return -ENOSPC;
518 }
519 strcpy(kps->string, val);
520 return 0;
521}
Rusty Russella14fe242010-08-11 23:04:11 -0600522EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600524int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700526 const struct kparam_string *kps = kp->str;
Jean Delvare96802e62017-10-03 16:16:38 -0700527 return scnprintf(buffer, PAGE_SIZE, "%s\n", kps->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528}
Rusty Russella14fe242010-08-11 23:04:11 -0600529EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930531const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600532 .set = param_set_copystring,
533 .get = param_get_string,
534};
535EXPORT_SYMBOL(param_ops_string);
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500538#define to_module_attr(n) container_of(n, struct module_attribute, attr)
539#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541struct param_attribute
542{
543 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600544 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
547struct module_param_attrs
548{
Rusty Russell9b473de2008-10-22 10:00:22 -0500549 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 struct attribute_group grp;
Gustavo A. R. Silvafa29c9c2020-08-31 10:23:32 -0500551 struct param_attribute attrs[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552};
553
Randy Dunlapef665c12007-02-13 15:19:06 -0800554#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500555#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930558 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
560 int count;
561 struct param_attribute *attribute = to_param_attr(mattr);
562
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600563 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 return -EPERM;
565
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930566 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600567 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930568 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return count;
570}
571
572/* sysfs always hands a nul-terminated string in buf. We rely on that. */
573static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930574 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 const char *buf, size_t len)
576{
577 int err;
578 struct param_attribute *attribute = to_param_attr(mattr);
579
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600580 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 return -EPERM;
582
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930583 kernel_param_lock(mk->mod);
David Howells20657f62019-08-19 17:17:55 -0700584 if (param_check_unsafe(attribute->param))
585 err = attribute->param->ops->set(buf, attribute->param);
586 else
587 err = -EPERM;
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930588 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 if (!err)
590 return len;
591 return err;
592}
Randy Dunlapef665c12007-02-13 15:19:06 -0800593#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
595#ifdef CONFIG_MODULES
596#define __modinit
597#else
598#define __modinit __init
599#endif
600
Randy Dunlapef665c12007-02-13 15:19:06 -0800601#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930602void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600603{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930604 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600605}
Rusty Russell907b29e2010-08-11 23:04:19 -0600606
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930607void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600608{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930609 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600610}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930611
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930612EXPORT_SYMBOL(kernel_param_lock);
613EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600614
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500616 * add_sysfs_param - add a parameter to sysfs
617 * @mk: struct module_kobject
Jean Delvare630cc2b2017-10-03 16:14:18 -0700618 * @kp: the actual parameter definition to add to sysfs
Rusty Russell9b473de2008-10-22 10:00:22 -0500619 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500621 * Create a kobject if for a (per-module) parameter if mp NULL, and
622 * create file in sysfs. Returns an error on out of memory. Always cleans up
623 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500625static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600626 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500627 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030629 struct module_param_attrs *new_mp;
630 struct attribute **new_attrs;
631 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Rusty Russell9b473de2008-10-22 10:00:22 -0500633 /* We don't bother calling this with invisible parameters. */
634 BUG_ON(!kp->perm);
635
636 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030637 /* First allocation. */
638 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
639 if (!mk->mp)
640 return -ENOMEM;
641 mk->mp->grp.name = "parameters";
642 /* NULL-terminated attribute array. */
643 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
644 GFP_KERNEL);
645 /* Caller will cleanup via free_module_param_attrs */
646 if (!mk->mp->grp.attrs)
647 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
649
Rusty Russell18eb74f2014-11-10 09:32:29 +1030650 /* Enlarge allocations. */
651 new_mp = krealloc(mk->mp,
652 sizeof(*mk->mp) +
653 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
654 GFP_KERNEL);
655 if (!new_mp)
656 return -ENOMEM;
657 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500658
Rusty Russell18eb74f2014-11-10 09:32:29 +1030659 /* Extra pointer for NULL terminator */
660 new_attrs = krealloc(mk->mp->grp.attrs,
661 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
662 GFP_KERNEL);
663 if (!new_attrs)
664 return -ENOMEM;
665 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500666
667 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030668 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030669 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
670 mk->mp->attrs[mk->mp->num].param = kp;
671 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030672 /* Do not allow runtime DAC changes to make param writable. */
673 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
674 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030675 else
676 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030677 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
678 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
679 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500680
681 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030682 for (i = 0; i < mk->mp->num; i++)
683 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
684 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500685 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500686}
687
Linus Torvaldsd2441182008-10-23 12:07:17 -0700688#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500689static void free_module_param_attrs(struct module_kobject *mk)
690{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030691 if (mk->mp)
692 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500693 kfree(mk->mp);
694 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697/*
698 * module_param_sysfs_setup - setup sysfs support for one module
699 * @mod: module
700 * @kparam: module parameters (array)
701 * @num_params: number of module parameters
702 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500703 * Adds sysfs entries for module parameters under
704 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 */
706int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600707 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 unsigned int num_params)
709{
Rusty Russell9b473de2008-10-22 10:00:22 -0500710 int i, err;
711 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Rusty Russell9b473de2008-10-22 10:00:22 -0500713 for (i = 0; i < num_params; i++) {
714 if (kparam[i].perm == 0)
715 continue;
716 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030717 if (err) {
718 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500719 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030720 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500721 params = true;
722 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Rusty Russell9b473de2008-10-22 10:00:22 -0500724 if (!params)
725 return 0;
726
727 /* Create the param group. */
728 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
729 if (err)
730 free_module_param_attrs(&mod->mkobj);
731 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
734/*
735 * module_param_sysfs_remove - remove sysfs support for one module
736 * @mod: module
737 *
738 * Remove sysfs entries for module parameters and the corresponding
739 * kobject.
740 */
741void module_param_sysfs_remove(struct module *mod)
742{
Rusty Russell9b473de2008-10-22 10:00:22 -0500743 if (mod->mkobj.mp) {
744 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 /* We are positive that no one is using any param
746 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500747 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 }
749}
750#endif
751
Rusty Russelle180a6b2009-03-31 13:05:29 -0600752void destroy_params(const struct kernel_param *params, unsigned num)
753{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600754 unsigned int i;
755
756 for (i = 0; i < num; i++)
757 if (params[i].ops->free)
758 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600759}
760
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800761static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
763 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500764 struct kobject *kobj;
765 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
Rusty Russell9b473de2008-10-22 10:00:22 -0500767 kobj = kset_find_obj(module_kset, name);
768 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500769 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500770 } else {
771 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
772 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Rusty Russell9b473de2008-10-22 10:00:22 -0500774 mk->mod = THIS_MODULE;
775 mk->kobj.kset = module_kset;
776 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
777 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930778#ifdef CONFIG_MODULES
779 if (!err)
780 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
781#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500782 if (err) {
783 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600784 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800785 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800786 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500787 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800788
789 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500790 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700791 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500792
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800793 return mk;
794}
795
796static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700797 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800798 unsigned int name_skip)
799{
800 struct module_kobject *mk;
801 int err;
802
803 mk = locate_module_kobject(name);
804 if (!mk)
805 return;
806
807 /* We need to remove old parameters before adding more. */
808 if (mk->mp)
809 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
810
Rusty Russell9b473de2008-10-22 10:00:22 -0500811 /* These should not fail at boot. */
812 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
813 BUG_ON(err);
814 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
815 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100816 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500817 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818}
819
820/*
Jean Delvareb634d132013-07-02 15:35:11 +0930821 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 *
823 * Add module_parameters to sysfs for "modules" built into the kernel.
824 *
825 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
826 * "parameter" name is stored behind a dot in kernel_param->name. So,
827 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500828 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 */
830static void __init param_sysfs_builtin(void)
831{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700832 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500833 unsigned int name_len;
834 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Rusty Russell9b473de2008-10-22 10:00:22 -0500836 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 char *dot;
838
Rusty Russell9b473de2008-10-22 10:00:22 -0500839 if (kp->perm == 0)
840 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Rusty Russell730b69d2008-10-22 10:00:22 -0500842 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500844 /* This happens for core_param() */
845 strcpy(modname, "kernel");
846 name_len = 0;
847 } else {
848 name_len = dot - kp->name + 1;
849 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500851 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853}
854
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800855ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930856 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800857{
858 struct module_version_attribute *vattr =
859 container_of(mattr, struct module_version_attribute, mattr);
860
Chen Gangf4940ab2013-08-20 15:35:04 +0930861 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800862}
863
Johan Hovoldb1120822020-11-23 11:23:15 +0100864extern const struct module_version_attribute __start___modver[];
865extern const struct module_version_attribute __stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800866
867static void __init version_sysfs_builtin(void)
868{
Johan Hovoldb1120822020-11-23 11:23:15 +0100869 const struct module_version_attribute *vattr;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800870 struct module_kobject *mk;
871 int err;
872
Johan Hovoldb1120822020-11-23 11:23:15 +0100873 for (vattr = __start___modver; vattr < __stop___modver; vattr++) {
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800874 mk = locate_module_kobject(vattr->module_name);
875 if (mk) {
876 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930877 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800878 kobject_uevent(&mk->kobj, KOBJ_ADD);
879 kobject_put(&mk->kobj);
880 }
881 }
882}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886static ssize_t module_attr_show(struct kobject *kobj,
887 struct attribute *attr,
888 char *buf)
889{
890 struct module_attribute *attribute;
891 struct module_kobject *mk;
892 int ret;
893
894 attribute = to_module_attr(attr);
895 mk = to_module_kobject(kobj);
896
897 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500898 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Kay Sievers4befb022011-07-24 22:06:04 +0930900 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 return ret;
903}
904
905static ssize_t module_attr_store(struct kobject *kobj,
906 struct attribute *attr,
907 const char *buf, size_t len)
908{
909 struct module_attribute *attribute;
910 struct module_kobject *mk;
911 int ret;
912
913 attribute = to_module_attr(attr);
914 mk = to_module_kobject(kobj);
915
916 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500917 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
Kay Sievers4befb022011-07-24 22:06:04 +0930919 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 return ret;
922}
923
Emese Revfy52cf25d2010-01-19 02:58:23 +0100924static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 .show = module_attr_show,
926 .store = module_attr_store,
927};
928
Greg Kroah-Hartmancf6299b62021-12-27 17:39:24 +0100929static int uevent_filter(struct kobject *kobj)
Kay Sievers270a6c42007-01-18 13:26:15 +0100930{
Wedson Almeida Filhoee6d3dd2021-12-24 23:13:45 +0000931 const struct kobj_type *ktype = get_ktype(kobj);
Kay Sievers270a6c42007-01-18 13:26:15 +0100932
933 if (ktype == &module_ktype)
934 return 1;
935 return 0;
936}
937
Emese Revfy9cd43612009-12-31 14:52:51 +0100938static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100939 .filter = uevent_filter,
940};
941
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700942struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700943int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
Li Zhong942e4432013-09-03 16:33:57 +0930945static void module_kobj_release(struct kobject *kobj)
946{
947 struct module_kobject *mk = to_module_kobject(kobj);
948 complete(mk->kobj_completion);
949}
950
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700951struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930952 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 .sysfs_ops = &module_sysfs_ops,
954};
955
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956/*
957 * param_sysfs_init - wrapper for built-in params support
958 */
959static int __init param_sysfs_init(void)
960{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700961 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
962 if (!module_kset) {
963 printk(KERN_WARNING "%s (%d): error creating kset\n",
964 __FILE__, __LINE__);
965 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700966 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700967 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800969 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 param_sysfs_builtin();
971
972 return 0;
973}
Mark Huangd10be6d2006-09-29 01:59:34 -0700974subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700976#endif /* CONFIG_SYSFS */