grub: add grub variable extend functionality
v2 cover grub: add grub variable extend functionality
This patchset allows a user to update an existing grub variable on the commandline.
v2:
- Split into 3 patches.
- fix "=value" bug. An additional consequence of this is that the value pointer p in set_variable() cannot underflow.
- make grub_envblk_iterate return an int and fix return values.
- add "+=" functionality
- Changes suggested by David Kiper: Change name to grub_envblk_extend(), capitalize comments, use standard GRUB error enum, change goto from "out" to "err", drop cast in grub_strlen() call, use grub_snprintf() instead of strcpy & memcpy.
- Instead of parsing envblk separately, use grub_envblk_iterate()
- use a case statement in set_variable() error handling, and add a comment about deleting the "=" sign.
Prarit Bhargava (3):
grub-editenv: Verify the variable size
grub: Make grub_envblk_iterate() return an int
grub: add extend variable functionality
grub-core/commands/loadenv.c | 6 +-- grub-core/lib/envblk.c | 17 ++++--- include/grub/err.h | 4 +- include/grub/lib/envblk.h | 6 +-- util/grub-editenv.c | 86 ++++++++++++++++++++++++++++++++++-- 5 files changed, 100 insertions(+), 19 deletions(-)
Signature · 1 line
2.17.2
PATCH v2 1/3 grub-editenv: Verify the variable size
It is possible to execute 'grub-editenv - set ="some data"', which results in an unremoveable entry
="some data"
Verify the variable has a size before setting a value.
--- util/grub-editenv.c | 3 +++ 1 file changed, 3 insertions(+)
util/grub-editenv.c +3 -0
@@ -217,6 +217,9 @@ set_variables (const char *name, int argc, char *argv[]) *(p++) =0 ; +if (!grub_strlen (argv[0 ])) +grub_util_error (_ ("No parameter specified" )); +if (!grub_envblk_set (envblk, argv[0 ], p))grub_util_error ("%s" ,_ ("environment block too small" ));
Signature · 1 line
2.17.2
Re: [PATCH v2 1/3] grub-editenv: Verify the variable size
Quoted 4 lines · Prarit Bhargava
It is possible to execute 'grub-editenv - set ="some data"', which results in an unremoveable entry
="some data"
Please explain why it happens.
Quoted 1 line
Verify the variable has a size before setting a value.
s/variable/argument/
s/size/size greater than zero/
Quoted 15 lines
Signed-off-by Prarit Bhargava <[email protected]>Cc Daniel Kiper <[email protected]>--- util/grub-editenv.c | 3 +++ 1 file changed, 3 insertions(+)util/grub-editenv.c +0
-0
util/grub-editenv.c set_variables (const char *name, int argc, char *argv[]) · line 221
Quoted 5 lines
util/grub-editenv.c +2
-0@@ -217,6 +217,9 @@ set_variables (const char *name, int argc, char *argv[]) *(p++) =0 ; +if (!grub_strlen (argv[0 ])) +grub_util_error (_ ("No parameter specified" ));
s/parameter/argument/
Daniel
PATCH v2 2/3 grub: Make grub_envblk_iterate() return an int
In reply to Prarit Bhargavagrub_envblk_iterate() is a void. Future functions will require the ability to interpret return codes from the iteration, so grub_envblk_iterate() should be an int.
The value of 0 returned from the hook functions is overloaded and cannot be parsed by callers to grub_envblk_iterate() for error handling. To fix this add GRUB_ERR_ITERATE_STOP and GRUB_ERR_ITERATE_CONTINUE to the error returns so the iteration can be stopped and continued respectively.
Make grub_envblk_iterate() return an int.
--- grub-core/commands/loadenv.c | 6 +++--- grub-core/lib/envblk.c | 17 ++++++++--------- include/grub/err.h | 4 +++- include/grub/lib/envblk.h | 6 +++--- util/grub-editenv.c | 2 +- 5 files changed, 18 insertions(+), 17 deletions(-)
grub-core/commands/loadenv.c +3 -3
@@ -144,14 +144,14 @@ set_var (const char *name, const char *value, void *whitelist)if (! whitelist) {grub_env_set (name, value); -return 0 ; +return GRUB_ERR_ITERATE_CONTINUE ; }if (test_whitelist_membership (name, (const grub_env_whitelist_t *) whitelist))grub_env_set (name, value); -return 0 ; +return GRUB_ERR_ITERATE_CONTINUE ; } static grub_err_t
@@ -192,7 +192,7 @@ print_var (const char *name, const char *value, void *hook_data __attribute__ ((unused))) {grub_printf ("%s=%s\n" , name, value); -return 0 ; +return GRUB_ERR_ITERATE_CONTINUE ; } static grub_err_t
grub-core/lib/envblk.c +8 -9
@@ -223,7 +223,7 @@ grub_envblk_delete (grub_envblk_t envblk, const char *name) } } -void +int grub_envblk_iterate (grub_envblk_t envblk,void *hook_data,int hook (const char *name,const char *value,void *hook_data))
@@ -247,8 +247,7 @@ grub_envblk_iterate (grub_envblk_t envblk,while (p < pend && *p !='=' ) p++;if (p == pend) -/* Broken. */ -return ; +return GRUB_ERR_OUT_OF_RANGE ; name_end = p; p++;
@@ -264,13 +263,11 @@ grub_envblk_iterate (grub_envblk_t envblk, }if (p >= pend) -/* Broken. */ -return ; +return GRUB_ERR_OUT_OF_RANGE ; name =grub_malloc (p - name_start +1 );if (! name) -/* out of memory. */ -return ; +return GRUB_ERR_OUT_OF_MEMORY ; value = name + (value_start - name_start);
@@ -288,10 +285,12 @@ grub_envblk_iterate (grub_envblk_t envblk, ret =hook (name, value, hook_data);grub_free (name); -if (ret) -return ; +if (ret !=GRUB_ERR_ITERATE_CONTINUE ) +return ret; } p =find_next_line (p, pend); } + +return GRUB_ERR_NONE ; }
include/grub/err.h +3 -1
@@ -71,7 +71,9 @@ typedef enumGRUB_ERR_NET_PACKET_TOO_BIG ,GRUB_ERR_NET_NO_DOMAIN ,GRUB_ERR_EOF , - GRUB_ERR_BAD_SIGNATURE +GRUB_ERR_BAD_SIGNATURE , +GRUB_ERR_ITERATE_STOP , + GRUB_ERR_ITERATE_CONTINUE } grub_err_t;
include/grub/lib/envblk.h +3 -3
@@ -34,9 +34,9 @@ typedef struct grub_envblk *grub_envblk_t;grub_envblk_t grub_envblk_open (char *buf,grub_size_t size);int grub_envblk_set (grub_envblk_t envblk,const char *name,const char *value);void grub_envblk_delete (grub_envblk_t envblk,const char *name); -void grub_envblk_iterate (grub_envblk_t envblk, -void *hook_data, -int hook (const char *name,const char *value,void *hook_data)); +int grub_envblk_iterate (grub_envblk_t envblk, +void *hook_data, +int hook (const char *name,const char *value,void *hook_data));void grub_envblk_close (grub_envblk_t envblk); static inline char *
util/grub-editenv.c +1 -1
@@ -169,7 +169,7 @@ print_var (const char *varname, const char *value, void *hook_data __attribute__ ((unused))) {printf ("%s=%s\n" , varname, value); -return 0 ; +return GRUB_ERR_ITERATE_CONTINUE ; } static void
Signature · 1 line
2.17.2
Re: [PATCH v2 2/3] grub: Make grub_envblk_iterate() return an int
Quoted 4 lines · Prarit Bhargava
grub_envblk_iterate()is a void. Future functions will require the ability to interpret return codes from the iteration, sogrub_envblk_iterate()should be an int.
Quoted 8 lines
The value of 0 returned from the hook functions is overloaded and cannot be parsed by callers to
grub_envblk_iterate()for error handling. To fix this addGRUB_ERR_ITERATE_STOPandGRUB_ERR_ITERATE_CONTINUEto the error returns so the iteration can be stopped and continued respectively.Make
grub_envblk_iterate()return an int.Signed-off-by Prarit Bhargava <[email protected]>
I do not like this patch. First of all GRUB errors are defined as an enum not as an int. The second: do not add error codes if they are not really needed. And yours are not needed at all.
Daniel
PATCH v2 3/3 grub: add extend variable functionality
In reply to Prarit BhargavaCustomers and users of the kernel are commenting that there is no way to update a grub variable without copy and pasting the existing data.
For example,
[10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81 ignore_loglevel
[10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv - set kernelopts="root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81 ignore_loglevel newarg" [10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81 ignore_loglevel newarg
which is cumbersome.
Add functionality to add to an existing variable. For example,
[10:58 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81 ignore_loglevel [10:58 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv - set kernelopts+="newarg"
[10:59 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81 ignore_loglevel newarg
--- util/grub-editenv.c | 81 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 79 insertions(+), 2 deletions(-)
util/grub-editenv.c +79 -2
@@ -201,6 +201,49 @@ write_envblk (const char *name, grub_envblk_t envblk)fclose (fp); } +struct extend_variable_data { +grub_envblk_t envblk; +const char *name; +const char *add; +}; + +static int +extend_variable_hook (const char *varname,const char *value,void *hook_data) +{ +char *new =NULL ; +int ret =GRUB_ERR_NONE ; +struct extend_variable_data *data = hook_data; + +if (grub_strcmp (data->name, varname)) +return GRUB_ERR_ITERATE_CONTINUE ; + +/* Create the new entry.*/ + new =grub_zalloc (grub_strlen (value) +grub_strlen (data->add) +2 ); +if (!new) + { +return GRUB_ERR_OUT_OF_MEMORY ; + goto err; + } +grub_snprintf (new,grub_strlen (value) +grub_strlen (data->add) +2 , +"%s %s" , value, data->add); + +/* Erase the current entry. */ +grub_envblk_delete (data->envblk, varname); +/* Add the updated entry. */ +if (!grub_envblk_set (data->envblk, varname, new)) + { +/* Restore the original entry. This should always work. */ +grub_envblk_set (data->envblk, varname, value); + ret =GRUB_ERR_EOF ; + goto err; + } + + err: +grub_free (new); +return GRUB_ERR_ITERATE_STOP ; + +} +static void set_variables (const char *name,int argc,char *argv[]) {
@@ -210,18 +253,52 @@ set_variables (const char *name, int argc, char *argv[])while (argc) {char *p; +struct extend_variable_data data; +int err; p =strchr (argv[0 ],'=' );if (! p)grub_util_error (_ ("invalid parameter %s" ), argv[0 ]); +/* Delete "=" to separate variable name and value */ *(p++) =0 ;if (!grub_strlen (argv[0 ]))grub_util_error (_ ("No parameter specified" )); -if (!grub_envblk_set (envblk, argv[0 ], p)) -grub_util_error ("%s" ,_ ("environment block too small" )); +switch (*(p -2 )) + { +case '+' :/* Extend a parameter */ + *(p -2 ) =0 ;/* Delete "+" from variable name */ + + data.envblk = envblk; + data.name = argv[0 ]; + data.add = p; + err =grub_envblk_iterate (envblk, &data, extend_variable_hook); +switch (err) + { +case GRUB_ERR_ITERATE_STOP :/* Success */ +break ; + +case GRUB_ERR_OUT_OF_RANGE : +case GRUB_ERR_EOF : +grub_util_error ("%s" ,_ ("environment block too small" )); +break ; + +case GRUB_ERR_OUT_OF_MEMORY : +grub_util_error ("%s" ,_ ("out of memory" )); +break ; + +case GRUB_ERR_NONE : +grub_util_error (_ ("variable %s not found" ), argv[0 ]); +break ; + } +break ; + +default :/* Add a new parameter */ +if (!grub_envblk_set (envblk, argv[0 ], p)) +grub_util_error ("%s" ,_ ("environment block too small" )); + } argc--; argv++;
Signature · 1 line
2.17.2
Re: [PATCH v2 3/3] grub: add extend variable functionality
Quoted 29 lines · Prarit Bhargava
Customers and users of the kernel are commenting that there is no way to update a grub variable without copy and pasting the existing data.
For example,
[10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81ignore_loglevel
[10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv - set kernelopts="root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81ignore_loglevelnewarg" [10:57 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81ignore_loglevelnewargwhich is cumbersome.
Add functionality to add to an existing variable. For example,
[10:58 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81ignore_loglevel[10:58 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv - set kernelopts+="newarg"
[10:59 AM root@intel-wildcatpass-07 grub-2.02]# ./grub-editenv list
saved_entry=0
next_entry=
kernelopts=root=/dev/mapper/rhel_intel--wildcatpass--07-root ro crashkernel=auto resume=/dev/mapper/rhel_intel--wildcatpass--07-swap rd.lvm.lv=rhel_intel-wildcatpass-07/root rd.lvm.lv=rhel_intel-wildcatpass-07/swap console=ttyS0,115200n81ignore_loglevelnewarg
Quoted 1 line
Signed-off-by Prarit Bhargava <[email protected]>
I prefer v1 patch +/- my suggestions. IMO current solution is an overkill.
Daniel