devlink: add format requirement for devlink param names
Subsystems (2)
PATCH v2 1/1 devlink: add format requirement for devlink param names
From: Jiri Pirko <[email protected]>
Currently, the name format is not required by the code, however it is required during patch review. All params added until now are in-lined with the following format:
1) lowercase characters, digits and underscored are allowed
2) underscore is neither at the beginning nor at the end and there is no more than one in a row.
Add checker to the code to require this format from drivers and warn if they don't follow.
---v1->v2:
- removed empty line after comment
- added check for empty string
- converted i and len to size_t and put on a single line
- s/valid_name/name_valid/ to be aligned with the rest
--- net/core/devlink.c | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+)
net/core/devlink.c +29 -0
@@ -20,6 +20,7 @@#include <linux/workqueue.h> #include <linux/u64_stats_sync.h> #include <linux/timekeeping.h> +#include <linux/ctype.h> #include <rdma/ib_verbs.h> #include <net/netlink.h> #include <net/genetlink.h>
@@ -7040,10 +7041,38 @@ void devlink_resource_occ_get_unregister(struct devlink *devlink, }EXPORT_SYMBOL_GPL (devlink_resource_occ_get_unregister); +static bool devlink_param_name_valid (const char *name) +{ +size_t i, len =strlen (name); + +if (!len) +return false; + +/* Name can contain lowercase characters or digits. +* Underscores are also allowed, but not at the beginning +* or end of the name and not more than one in a row. +*/ +for (i =0 ; i < len; i++) { +if (islower (name[i]) ||isdigit (name[i])) +continue ; +if (name[i] !='_' ) +return false; +if (i ==0 || i +1 == len) +return false; +if (name[i -1 ] =='_' ) +return false; + } +return true; +} +static int devlink_param_verify (const struct devlink_param *param) {if (!param || !param->name || !param->supported_cmodes)return -EINVAL ; + +if (WARN_ON (!devlink_param_name_valid (param->name))) +return -EINVAL ; +if (param->generic)return devlink_param_generic_verify (param);else
Signature · 1 line
2.21.0
Quoted 9 lines · Jiri Pirko
From: Jiri Pirko <[email protected]>
Currently, the name format is not required by the code, however it is required during patch review. All params added until now are in-lined with the following format:
1) lowercase characters, digits and underscored are allowed
2) underscore is neither at the beginning nor at the end and there is no more than one in a row.
Quoted 4 lines
Add checker to the code to require this format from drivers and warn if they don't follow.
Signed-off-by Jiri Pirko <[email protected]>
Quoted 12 lines · Fri, Oct 18, 2019 at 07:09:51PM CEST, [email protected] wrote:
From: Jiri Pirko <[email protected]>
Currently, the name format is not required by the code, however it is required during patch review. All params added until now are in-lined with the following format:
1) lowercase characters, digits and underscored are allowed
2) underscore is neither at the beginning nor at the end and there is no more than one in a row.Add checker to the code to require this format from drivers and warn if they don't follow.
Quoted 7 lines
Signed-off-by Jiri Pirko <[email protected]>---
v1->v2:
- removed empty line after comment
- added check for empty string
- converted i and len tosize_tand put on a single line
- s/valid_name/name_valid/ to be aligned with the rest
Will send v3 which would allow uppercase and will make it part of patchset that would check more devlink strings.