diff options
| author | Linus Torvalds <torvalds@linux-foundation.org> | 2010-08-12 13:01:59 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2010-08-12 13:01:59 -0400 |
| commit | 26df0766a73a859bb93dc58e747c5028557a23fd (patch) | |
| tree | 4776de567425a7fb66ca9a87228309f9c84de633 /include | |
| parent | 580287628cdd99366b10c9050c4479b387283be8 (diff) | |
| parent | a6de51b2787012ba3ab62c7d50df1b749b83d5f0 (diff) | |
Merge branch 'params' of git://git.kernel.org/pub/scm/linux/kernel/git/rusty/linux-2.6-for-linus
* 'params' of git://git.kernel.org/pub/scm/linux/kernel/git/rusty/linux-2.6-for-linus: (22 commits)
param: don't deref arg in __same_type() checks
param: update drivers/acpi/debug.c to new scheme
param: use module_param in drivers/message/fusion/mptbase.c
ide: use module_param_named rather than module_param_call
param: update drivers/char/ipmi/ipmi_watchdog.c to new scheme
param: lock if_sdio's lbs_helper_name and lbs_fw_name against sysfs changes.
param: lock myri10ge_fw_name against sysfs changes.
param: simple locking for sysfs-writable charp parameters
param: remove unnecessary writable charp
param: add kerneldoc to moduleparam.h
param: locking for kernel parameters
param: make param sections const.
param: use free hook for charp (fix leak of charp parameters)
param: add a free hook to kernel_param_ops.
param: silence .init.text references from param ops
Add param ops struct for hvc_iucv driver.
nfs: update for module_param_named API change
AppArmor: update for module_param_named API change
param: use ops in struct kernel_param, rather than get and set fns directly
param: move the EXPORT_SYMBOL to after the definitions.
...
Diffstat (limited to 'include')
| -rw-r--r-- | include/linux/moduleparam.h | 288 |
1 files changed, 221 insertions, 67 deletions
diff --git a/include/linux/moduleparam.h b/include/linux/moduleparam.h index 82a9124f7d75..9d2f1837b3d8 100644 --- a/include/linux/moduleparam.h +++ b/include/linux/moduleparam.h | |||
| @@ -31,20 +31,23 @@ static const char __module_cat(name,__LINE__)[] \ | |||
| 31 | 31 | ||
| 32 | struct kernel_param; | 32 | struct kernel_param; |
| 33 | 33 | ||
| 34 | /* Returns 0, or -errno. arg is in kp->arg. */ | 34 | struct kernel_param_ops { |
| 35 | typedef int (*param_set_fn)(const char *val, struct kernel_param *kp); | 35 | /* Returns 0, or -errno. arg is in kp->arg. */ |
| 36 | /* Returns length written or -errno. Buffer is 4k (ie. be short!) */ | 36 | int (*set)(const char *val, const struct kernel_param *kp); |
| 37 | typedef int (*param_get_fn)(char *buffer, struct kernel_param *kp); | 37 | /* Returns length written or -errno. Buffer is 4k (ie. be short!) */ |
| 38 | int (*get)(char *buffer, const struct kernel_param *kp); | ||
| 39 | /* Optional function to free kp->arg when module unloaded. */ | ||
| 40 | void (*free)(void *arg); | ||
| 41 | }; | ||
| 38 | 42 | ||
| 39 | /* Flag bits for kernel_param.flags */ | 43 | /* Flag bits for kernel_param.flags */ |
| 40 | #define KPARAM_ISBOOL 2 | 44 | #define KPARAM_ISBOOL 2 |
| 41 | 45 | ||
| 42 | struct kernel_param { | 46 | struct kernel_param { |
| 43 | const char *name; | 47 | const char *name; |
| 48 | const struct kernel_param_ops *ops; | ||
| 44 | u16 perm; | 49 | u16 perm; |
| 45 | u16 flags; | 50 | u16 flags; |
| 46 | param_set_fn set; | ||
| 47 | param_get_fn get; | ||
| 48 | union { | 51 | union { |
| 49 | void *arg; | 52 | void *arg; |
| 50 | const struct kparam_string *str; | 53 | const struct kparam_string *str; |
| @@ -63,12 +66,67 @@ struct kparam_array | |||
| 63 | { | 66 | { |
| 64 | unsigned int max; | 67 | unsigned int max; |
| 65 | unsigned int *num; | 68 | unsigned int *num; |
| 66 | param_set_fn set; | 69 | const struct kernel_param_ops *ops; |
| 67 | param_get_fn get; | ||
| 68 | unsigned int elemsize; | 70 | unsigned int elemsize; |
| 69 | void *elem; | 71 | void *elem; |
| 70 | }; | 72 | }; |
| 71 | 73 | ||
| 74 | /** | ||
| 75 | * module_param - typesafe helper for a module/cmdline parameter | ||
| 76 | * @value: the variable to alter, and exposed parameter name. | ||
| 77 | * @type: the type of the parameter | ||
| 78 | * @perm: visibility in sysfs. | ||
| 79 | * | ||
| 80 | * @value becomes the module parameter, or (prefixed by KBUILD_MODNAME and a | ||
| 81 | * ".") the kernel commandline parameter. Note that - is changed to _, so | ||
| 82 | * the user can use "foo-bar=1" even for variable "foo_bar". | ||
| 83 | * | ||
| 84 | * @perm is 0 if the the variable is not to appear in sysfs, or 0444 | ||
| 85 | * for world-readable, 0644 for root-writable, etc. Note that if it | ||
| 86 | * is writable, you may need to use kparam_block_sysfs_write() around | ||
| 87 | * accesses (esp. charp, which can be kfreed when it changes). | ||
| 88 | * | ||
| 89 | * The @type is simply pasted to refer to a param_ops_##type and a | ||
| 90 | * param_check_##type: for convenience many standard types are provided but | ||
| 91 | * you can create your own by defining those variables. | ||
| 92 | * | ||
| 93 | * Standard types are: | ||
| 94 | * byte, short, ushort, int, uint, long, ulong | ||
| 95 | * charp: a character pointer | ||
| 96 | * bool: a bool, values 0/1, y/n, Y/N. | ||
| 97 | * invbool: the above, only sense-reversed (N = true). | ||
| 98 | */ | ||
| 99 | #define module_param(name, type, perm) \ | ||
| 100 | module_param_named(name, name, type, perm) | ||
| 101 | |||
| 102 | /** | ||
| 103 | * module_param_named - typesafe helper for a renamed module/cmdline parameter | ||
| 104 | * @name: a valid C identifier which is the parameter name. | ||
| 105 | * @value: the actual lvalue to alter. | ||
| 106 | * @type: the type of the parameter | ||
| 107 | * @perm: visibility in sysfs. | ||
| 108 | * | ||
| 109 | * Usually it's a good idea to have variable names and user-exposed names the | ||
| 110 | * same, but that's harder if the variable must be non-static or is inside a | ||
| 111 | * structure. This allows exposure under a different name. | ||
| 112 | */ | ||
| 113 | #define module_param_named(name, value, type, perm) \ | ||
| 114 | param_check_##type(name, &(value)); \ | ||
| 115 | module_param_cb(name, ¶m_ops_##type, &value, perm); \ | ||
| 116 | __MODULE_PARM_TYPE(name, #type) | ||
| 117 | |||
| 118 | /** | ||
| 119 | * module_param_cb - general callback for a module/cmdline parameter | ||
| 120 | * @name: a valid C identifier which is the parameter name. | ||
| 121 | * @ops: the set & get operations for this parameter. | ||
| 122 | * @perm: visibility in sysfs. | ||
| 123 | * | ||
| 124 | * The ops can have NULL set or get functions. | ||
| 125 | */ | ||
| 126 | #define module_param_cb(name, ops, arg, perm) \ | ||
| 127 | __module_param_call(MODULE_PARAM_PREFIX, \ | ||
| 128 | name, ops, arg, __same_type((arg), bool *), perm) | ||
| 129 | |||
| 72 | /* On alpha, ia64 and ppc64 relocations to global data cannot go into | 130 | /* On alpha, ia64 and ppc64 relocations to global data cannot go into |
| 73 | read-only sections (which is part of respective UNIX ABI on these | 131 | read-only sections (which is part of respective UNIX ABI on these |
| 74 | platforms). So 'const' makes no sense and even causes compile failures | 132 | platforms). So 'const' makes no sense and even causes compile failures |
| @@ -80,10 +138,8 @@ struct kparam_array | |||
| 80 | #endif | 138 | #endif |
| 81 | 139 | ||
| 82 | /* This is the fundamental function for registering boot/module | 140 | /* This is the fundamental function for registering boot/module |
| 83 | parameters. perm sets the visibility in sysfs: 000 means it's | 141 | parameters. */ |
| 84 | not there, read bits mean it's readable, write bits mean it's | 142 | #define __module_param_call(prefix, name, ops, arg, isbool, perm) \ |
| 85 | writable. */ | ||
| 86 | #define __module_param_call(prefix, name, set, get, arg, isbool, perm) \ | ||
| 87 | /* Default value instead of permissions? */ \ | 143 | /* Default value instead of permissions? */ \ |
| 88 | static int __param_perm_check_##name __attribute__((unused)) = \ | 144 | static int __param_perm_check_##name __attribute__((unused)) = \ |
| 89 | BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2)) \ | 145 | BUILD_BUG_ON_ZERO((perm) < 0 || (perm) > 0777 || ((perm) & 2)) \ |
| @@ -92,31 +148,87 @@ struct kparam_array | |||
| 92 | static struct kernel_param __moduleparam_const __param_##name \ | 148 | static struct kernel_param __moduleparam_const __param_##name \ |
| 93 | __used \ | 149 | __used \ |
| 94 | __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \ | 150 | __attribute__ ((unused,__section__ ("__param"),aligned(sizeof(void *)))) \ |
| 95 | = { __param_str_##name, perm, isbool ? KPARAM_ISBOOL : 0, \ | 151 | = { __param_str_##name, ops, perm, isbool ? KPARAM_ISBOOL : 0, \ |
| 96 | set, get, { arg } } | 152 | { arg } } |
| 153 | |||
| 154 | /* Obsolete - use module_param_cb() */ | ||
| 155 | #define module_param_call(name, set, get, arg, perm) \ | ||
| 156 | static struct kernel_param_ops __param_ops_##name = \ | ||
| 157 | { (void *)set, (void *)get }; \ | ||
| 158 | __module_param_call(MODULE_PARAM_PREFIX, \ | ||
| 159 | name, &__param_ops_##name, arg, \ | ||
| 160 | __same_type(arg, bool *), \ | ||
| 161 | (perm) + sizeof(__check_old_set_param(set))*0) | ||
| 162 | |||
| 163 | /* We don't get oldget: it's often a new-style param_get_uint, etc. */ | ||
| 164 | static inline int | ||
| 165 | __check_old_set_param(int (*oldset)(const char *, struct kernel_param *)) | ||
| 166 | { | ||
| 167 | return 0; | ||
| 168 | } | ||
| 97 | 169 | ||
| 98 | #define module_param_call(name, set, get, arg, perm) \ | 170 | /** |
| 99 | __module_param_call(MODULE_PARAM_PREFIX, \ | 171 | * kparam_block_sysfs_write - make sure a parameter isn't written via sysfs. |
| 100 | name, set, get, arg, \ | 172 | * @name: the name of the parameter |
| 101 | __same_type(*(arg), bool), perm) | 173 | * |
| 174 | * There's no point blocking write on a paramter that isn't writable via sysfs! | ||
| 175 | */ | ||
| 176 | #define kparam_block_sysfs_write(name) \ | ||
| 177 | do { \ | ||
| 178 | BUG_ON(!(__param_##name.perm & 0222)); \ | ||
| 179 | __kernel_param_lock(); \ | ||
| 180 | } while (0) | ||
| 102 | 181 | ||
| 103 | /* Helper functions: type is byte, short, ushort, int, uint, long, | 182 | /** |
| 104 | ulong, charp, bool or invbool, or XXX if you define param_get_XXX, | 183 | * kparam_unblock_sysfs_write - allows sysfs to write to a parameter again. |
| 105 | param_set_XXX and param_check_XXX. */ | 184 | * @name: the name of the parameter |
| 106 | #define module_param_named(name, value, type, perm) \ | 185 | */ |
| 107 | param_check_##type(name, &(value)); \ | 186 | #define kparam_unblock_sysfs_write(name) \ |
| 108 | module_param_call(name, param_set_##type, param_get_##type, &value, perm); \ | 187 | do { \ |
| 109 | __MODULE_PARM_TYPE(name, #type) | 188 | BUG_ON(!(__param_##name.perm & 0222)); \ |
| 189 | __kernel_param_unlock(); \ | ||
| 190 | } while (0) | ||
| 110 | 191 | ||
| 111 | |||
