fix propagation of flags from do_env_default()
Subsystems (3)
cover fix propagation of flags from do_env_default()
The function do_env_default() doesn't propagate flags to himport_r(). It causes the "-f" option to have no effect on the execution of "env default" commands.
Fix the call paths from do_env_default() to himport_r() to pass flags correctly.
Yaniv Levinsky (4):
cmd: nvedit: rename flags in do_env_default
cmd: nvedit: propagate envflag to set_default_vars
cmd: nvedit: set H_INTERACTIVE in do_env_default
env: common: accept flags on reset to default env
arch/arm/mach-imx/mx6/opos6ul.c | 2 +- cmd/nvedit.c | 11 ++++++----- common/board_r.c | 2 +- common/spl/spl_dfu.c | 2 +- env/common.c | 27 ++++++++++++--------------- env/ext4.c | 2 +- env/fat.c | 2 +- env/mmc.c | 12 ++++++------ env/nand.c | 6 +++--- env/sata.c | 2 +- env/sf.c | 10 +++++----- env/ubi.c | 6 +++--- include/environment.h | 4 ++-- 13 files changed, 43 insertions(+), 45 deletions(-)
Signature · 1 line
2.17.1
PATCH 1/4 cmd: nvedit: rename flags in do_env_default
The naming convention for flags in nvedit.c is:
* The hashtable flag (defined in search.h) is named "env_flag"
* The command flag argument (defined in command.h) is named "flag"
This convention is kept in functions like do_env_print(), do_env_set() and do_env_delete(), but not in do_env_default().
Rename the hashtable flag in do_env_default() from "flag" to "env_flag". Rename the command flag in do_env_default() from "__flag" to "flag".
No functional change.
--- cmd/nvedit.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
cmd/nvedit.c +3 -3
@@ -777,10 +777,10 @@ int envmatch(uchar *s1, int i2) }#ifndef CONFIG_SPL_BUILD -static int do_env_default (cmd_tbl_t *cmdtp,int __flag, +static int do_env_default (cmd_tbl_t *cmdtp,int flag,int argc,char *const argv[]) { -int all =0 , flag =0 ; +int all =0 , env_flag =0 ;debug ("Initial value for argc=%d\n" , argc);while (--argc >0 && **++argv =='-' ) {
@@ -792,7 +792,7 @@ static int do_env_default(cmd_tbl_t *cmdtp, int __flag, all =1 ;break ;case 'f' :/* force */ - flag |=H_FORCE ; + env_flag |=H_FORCE ;break ;default :return cmd_usage (cmdtp);
Signature · 1 line
2.17.1
PATCH 1/4 cmd: nvedit: rename flags in do_env_default
Quoted 7 lines · Yaniv Levinsky
The naming convention for flags in
nvedit.cis:
* The hashtable flag (defined insearch.h) is named "env_flag"
* The command flag argument (defined incommand.h) is named "flag"This convention is kept in functions like
do_env_print(),do_env_set()anddo_env_delete(), but not indo_env_default().
Quoted 7 lines
Rename the hashtable flag in
do_env_default()from "flag" to "env_flag". Rename the command flag indo_env_default()from "__flag" to "flag".No functional change.
Signed-off-by Yaniv Levinsky <[email protected]>Reviewed-by Igor Grinberg <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180720/1ac43d72/attachment.sig>
PATCH 2/4 cmd: nvedit: propagate envflag to set_default_vars
In reply to Yaniv LevinskyThe env_flag in do_env_default() doesn't get propagated and therefore gets ignored by himport_r(). This breaks to ability to "forcibly" reset variables to their default values using the environment command.
Scenario example of the problem:
# setenv kernel uImage # setenv .flags kernel:so # env default -f kernel ## Error: Can't overwrite "kernel" himport_r: can't insert "kernel=zImage" into hash table
Change the call path so it will pass the flag correctly.
--- cmd/nvedit.c | 2 +- env/common.c | 5 +++-- include/environment.h | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-)
cmd/nvedit.c +1 -1
@@ -807,7 +807,7 @@ static int do_env_default(cmd_tbl_t *cmdtp, int flag, }if (!all && (argc >0 )) {/* Reset individual variables */ -set_default_vars (argc, argv); +set_default_vars (argc, argv, env_flag);return 0 ; }
env/common.c +3 -2
@@ -91,15 +91,16 @@ void set_default_env(const char *s)/* [re]set individual variables to their value in the default environment */ -int set_default_vars (int nvars,char *const vars[]) +int set_default_vars (int nvars,char *const vars[],int flags) {/* * Special use-case: import from default environment * (and use \0 as a separator) */ + flags |=H_NOCLEAR |H_INTERACTIVE ;return himport_r (&env_htab, (const char *)default_environment,sizeof (default_environment),'\0' , -H_NOCLEAR |H_INTERACTIVE ,0 , nvars, vars); + flags,0 , nvars, vars); }/*
include/environment.h +1 -1
@@ -275,7 +275,7 @@ char *env_get_default(const char *name);void set_default_env (const char *s);/* [re]set individual variables to their value in the default environment */ -int set_default_vars (int nvars,char *const vars[]); +int set_default_vars (int nvars,char *const vars[],int flags);/* Import from binary representation into hash table */ int env_import (const char *buf,int check);
Signature · 1 line
2.17.1
PATCH 2/4 cmd: nvedit: propagate envflag to set_default_vars
Quoted 11 lines · Yaniv Levinsky
The
env_flagindo_env_default()doesn't get propagated and therefore gets ignored byhimport_r(). This breaks to ability to "forcibly" reset variables to their default values using the environment command.Scenario example of the problem:
# setenv kernel uImage # setenv .flags kernel:so # env default -f kernel ## Error: Can't overwrite "kernel" himport_r: can't insert "kernel=zImage" into hash table
Quoted 4 lines
Change the call path so it will pass the flag correctly.
Signed-off-by Yaniv Levinsky <[email protected]>Acked-by Igor Grinberg <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180720/ead74cd0/attachment.sig>
PATCH 3/4 cmd: nvedit: set H_INTERACTIVE in do_env_default
In reply to Yaniv LevinskyThe function set_default_vars() in common.c adds H_INTERACTIVE to the h_import() flag, but the function has no way of telling if the command actually was user directed like this flag suggest. The flag should be set by the calling function do_env_default() in nvedit.c instead, where the command is certainty user directed.
Move the H_INTERACTIVE flag from set_default_vars() to do_env_default().
--- cmd/nvedit.c | 2 +- env/common.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
cmd/nvedit.c +1 -1
@@ -780,7 +780,7 @@ int envmatch(uchar *s1, int i2)static int do_env_default (cmd_tbl_t *cmdtp,int flag,int argc,char *const argv[]) { -int all =0 , env_flag =0 ; +int all =0 , env_flag =H_INTERACTIVE ;debug ("Initial value for argc=%d\n" , argc);while (--argc >0 && **++argv =='-' ) {
env/common.c +1 -1
@@ -97,7 +97,7 @@ int set_default_vars(int nvars, char * const vars[], int flags)* Special use-case: import from default environment * (and use \0 as a separator) */ - flags |=H_NOCLEAR |H_INTERACTIVE ; + flags |=H_NOCLEAR ;return himport_r (&env_htab, (const char *)default_environment,sizeof (default_environment),'\0' , flags,0 , nvars, vars);
Signature · 1 line
2.17.1
PATCH 3/4 cmd: nvedit: set H_INTERACTIVE in do_env_default
Quoted 10 lines · Yaniv Levinsky
The function
set_default_vars()incommon.caddsH_INTERACTIVEto theh_import()flag, but the function has no way of telling if the command actually was user directed like this flag suggest. The flag should be set by the calling functiondo_env_default()innvedit.cinstead, where the command is certainty user directed.Move the
H_INTERACTIVEflag fromset_default_vars()todo_env_default().Signed-off-by Yaniv Levinsky <[email protected]>Acked-by Igor Grinberg <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180720/8430b79a/attachment.sig>
PATCH 4/4 env: common: accept flags on reset to default env
In reply to Yaniv LevinskyThe function set_default_env() sets the hashtable flags for import_r(). Formally set_default_env() doesn't accept flags from its callers. In practice the caller can (un)set the H_INTERACTIVE flag, but it has to be done using the first character of the function's string argument. Other flags like H_FORCE can't be set by the caller.
Change the function to accept flags argument. The benefits are:
1. The caller will have to explicitly set the H_INTERACTIVE flag, instead of un-setting it using a special char in a string.
2. Add the ability to propagate flags from the caller to himport(), especially the H_FORCE flag from do_env_default() in nvedit.c that currently gets ignored for "env default -a -f" commands.
3. Flags and messages will not be coupled together. A caller will be able to set flags without passing a string and vice versa.
Please note:
The propagation of H_FORCE from do_env_default() does not introduce any functional changes, because currently himport_r() is set to destroy the old environment regardless if H_FORCE flag is set or not. More changes are needed to utilize the propagation of H_FORCE.
--- arch/arm/mach-imx/mx6/opos6ul.c | 2 +- cmd/nvedit.c | 3 ++- common/board_r.c | 2 +- common/spl/spl_dfu.c | 2 +- env/common.c | 22 +++++++++------------- env/ext4.c | 2 +- env/fat.c | 2 +- env/mmc.c | 12 ++++++------ env/nand.c | 6 +++--- env/sata.c | 2 +- env/sf.c | 10 +++++----- env/ubi.c | 6 +++--- include/environment.h | 2 +- 13 files changed, 35 insertions(+), 38 deletions(-)
arch/arm/mach-imx/mx6/opos6ul.c +1 -1
@@ -127,7 +127,7 @@ int board_late_init(void)/* In bootstrap don't use the env vars */ if (((reg &0x3000000 ) >>24 ) ==0x1 ) { -set_default_env (NULL ); +set_default_env (NULL ,0 );env_set ("preboot" ,"" ); }
cmd/nvedit.c +2 -1
@@ -802,7 +802,8 @@ static int do_env_default(cmd_tbl_t *cmdtp, int flag,debug ("Final value for argc=%d\n" , argc);if (all && (argc ==0 )) {/* Reset the whole environment */ -set_default_env ("## Resetting to default environment\n" ); +set_default_env ("## Resetting to default environment\n" , + env_flag);return 0 ; }if (!all && (argc >0 )) {
common/board_r.c +1 -1
@@ -454,7 +454,7 @@ static int initr_env(void)if (should_load_env ())env_relocate ();else -set_default_env (NULL ); +set_default_env (NULL ,0 );#ifdef CONFIG_OF_CONTROL env_set_addr ("fdtcontroladdr" , gd->fdt_blob);#endif
common/spl/spl_dfu.c +1 -1
@@ -38,7 +38,7 @@ int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr)int ret;/* set default environment */ -set_default_env (0 ); +set_default_env (NULL ,0 ); str_env =env_get (dfu_alt_info);if (!str_env) {pr_err ("\"dfu_alt_info\" env variable not defined!\n" );
env/common.c +9 -13
@@ -58,22 +58,18 @@ char *env_get_default(const char *name)return ret_val; } -void set_default_env (const char *s) +void set_default_env (const char *s,int flags) { -int flags =0 ; -if (sizeof (default_environment) >ENV_SIZE ) {puts ("*** Error - default environment is too large\n\n" );return ; }if (s) { -if (*s =='!' ) { +if ((flags &H_INTERACTIVE ) ==0 ) {printf ("*** Warning - %s, " -"using default environment\n\n" , - s +1 ); +"using default environment\n\n" , s); }else { - flags =H_INTERACTIVE ;puts (s); } }else {
@@ -117,7 +113,7 @@ int env_import(const char *buf, int check)memcpy (&crc, &ep->crc,sizeof (crc));if (crc32 (0 , ep->data,ENV_SIZE ) != crc) { -set_default_env ("!bad CRC" ); +set_default_env ("bad CRC" ,0 );return -EIO ; } }
@@ -130,7 +126,7 @@ int env_import(const char *buf, int check)pr_err ("Cannot import environment: errno = %d\n" , errno); -set_default_env ("!import failed" ); +set_default_env ("import failed" ,0 );return -EIO ; }
@@ -155,7 +151,7 @@ int env_import_redund(const char *buf1, int buf1_read_fail, }if (buf1_read_fail && buf2_read_fail) { -set_default_env ("!bad env area" ); +set_default_env ("bad env area" ,0 );return -EIO ; }else if (!buf1_read_fail && buf2_read_fail) { gd->env_valid =ENV_VALID ;
@@ -171,7 +167,7 @@ int env_import_redund(const char *buf1, int buf1_read_fail, tmp_env2->crc;if (!crc1_ok && !crc2_ok) { -set_default_env ("!bad CRC" ); +set_default_env ("bad CRC" ,0 );return -EIO ; }else if (crc1_ok && !crc2_ok) { gd->env_valid =ENV_VALID ;
@@ -233,10 +229,10 @@ void env_relocate(void)if (gd->env_valid ==ENV_INVALID ) {#if defined(CONFIG_ENV_IS_NOWHERE ) || defined(CONFIG_SPL_BUILD )/* Environment not changable */ -set_default_env (NULL ); +set_default_env (NULL ,0 );#else bootstage_error (BOOTSTAGE_ID_NET_CHECKSUM ); -set_default_env ("!bad CRC" ); +set_default_env ("bad CRC" ,0 );#endif }else {env_load ();
env/ext4.c +1 -1
@@ -119,7 +119,7 @@ static int env_ext4_load(void)return env_import (buf,1 ); err_env_relocate: -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }
env/fat.c +1 -1
@@ -122,7 +122,7 @@ static int env_fat_load(void)return env_import (buf,1 ); err_env_relocate: -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }
env/mmc.c +6 -6
@@ -155,19 +155,19 @@ static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };static const char *init_mmc_for_env (struct mmc *mmc) {if (!mmc) -return "!No MMC card found" ; +return "No MMC card found" ;#if CONFIG_IS_ENABLED (BLK )struct udevice *dev;if (blk_get_from_parent (mmc->dev, &dev)) -return "!No block device" ; +return "No block device" ;#else if (mmc_init (mmc)) -return "!MMC init failed" ; +return "MMC init failed" ;#endif if (mmc_set_env_part (mmc)) -return "!MMC partition switch failed" ; +return "MMC partition switch failed" ;return NULL ; }
@@ -298,7 +298,7 @@ fini:fini_mmc_for_env (mmc); err:if (ret) -set_default_env (errmsg); +set_default_env (errmsg,0 );#endif return ret;
@@ -339,7 +339,7 @@ fini:fini_mmc_for_env (mmc); err:if (ret) -set_default_env (errmsg); +set_default_env (errmsg,0 );#endif return ret; }
env/nand.c +3 -3
@@ -327,7 +327,7 @@ static int env_nand_load(void) tmp_env2 = (env_t *)malloc (CONFIG_ENV_SIZE );if (tmp_env1 ==NULL || tmp_env2 ==NULL ) {puts ("Can't allocate buffers for environment\n" ); -set_default_env ("!malloc() failed" ); +set_default_env ("malloc() failed" ,0 ); ret = -EIO ; goto done; }
@@ -366,14 +366,14 @@ static int env_nand_load(void)if (mtd && !get_nand_env_oob (mtd, &nand_env_oob_offset)) {printf ("Found Environment offset in OOB..\n" ); }else { -set_default_env ("!no env offset in OOB" ); +set_default_env ("no env offset in OOB" ,0 );return ; }#endif ret =readenv (CONFIG_ENV_OFFSET , (u_char *)buf);if (ret) { -set_default_env ("!readenv() failed" ); +set_default_env ("readenv() failed" ,0 );return -EIO ; }
env/sata.c +1 -1
@@ -106,7 +106,7 @@ static void env_sata_load(void) }if (read_env (sata,CONFIG_ENV_SIZE ,CONFIG_ENV_OFFSET , buf)) { -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }
env/sf.c +5 -5
@@ -60,7 +60,7 @@ static int setup_flash_device(void) ret =spi_flash_probe_bus_cs (CONFIG_ENV_SPI_BUS ,CONFIG_ENV_SPI_CS ,0 ,0 , &new);if (ret) { -set_default_env ("!spi_flash_probe_bus_cs() failed" ); +set_default_env ("spi_flash_probe_bus_cs() failed" ,0 );return ret; }
@@ -72,7 +72,7 @@ static int setup_flash_device(void)CONFIG_ENV_SPI_CS , CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);if (!env_flash) { -set_default_env ("!spi_flash_probe() failed" ); +set_default_env ("spi_flash_probe() failed" ,0 );return -EIO ; } }
@@ -173,7 +173,7 @@ static int env_sf_load(void) tmp_env2 = (env_t *)memalign (ARCH_DMA_MINALIGN ,CONFIG_ENV_SIZE );if (!tmp_env1 || !tmp_env2) { -set_default_env ("!malloc() failed" ); +set_default_env ("malloc() failed" ,0 ); ret = -EIO ; goto out; }
@@ -268,7 +268,7 @@ static int env_sf_load(void) buf = (char *)memalign (ARCH_DMA_MINALIGN ,CONFIG_ENV_SIZE );if (!buf) { -set_default_env ("!malloc() failed" ); +set_default_env ("malloc() failed" ,0 );return -EIO ; }
@@ -279,7 +279,7 @@ static int env_sf_load(void) ret =spi_flash_read (env_flash,CONFIG_ENV_OFFSET ,CONFIG_ENV_SIZE , buf);if (ret) { -set_default_env ("!spi_flash_read() failed" ); +set_default_env ("spi_flash_read() failed" ,0 ); goto err_read; }
env/ubi.c +3 -3
@@ -114,7 +114,7 @@ static int env_ubi_load(void)if (ubi_part (CONFIG_ENV_UBI_PART ,NULL )) {printf ("\n** Cannot find mtd partition \"%s\"\n" ,CONFIG_ENV_UBI_PART ); -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }
@@ -151,14 +151,14 @@ static int env_ubi_load(void)if (ubi_part (CONFIG_ENV_UBI_PART ,NULL )) {printf ("\n** Cannot find mtd partition \"%s\"\n" ,CONFIG_ENV_UBI_PART ); -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }if (ubi_volume_read (CONFIG_ENV_UBI_VOLUME , buf,CONFIG_ENV_SIZE )) {printf ("\n** Unable to read env from %s:%s **\n" ,CONFIG_ENV_UBI_PART ,CONFIG_ENV_UBI_VOLUME ); -set_default_env (NULL ); +set_default_env (NULL ,0 );return -EIO ; }
include/environment.h +1 -1
@@ -272,7 +272,7 @@ void env_crc_update(void);char *env_get_default (const char *name);/* [re]set to the default environment */ -void set_default_env (const char *s); +void set_default_env (const char *s,int flags);/* [re]set individual variables to their value in the default environment */ int set_default_vars (int nvars,char *const vars[],int flags);
Signature · 1 line
2.17.1
PATCH 4/4 env: common: accept flags on reset to default env
Quoted 15 lines · Yaniv Levinsky
The function
set_default_env()sets the hashtable flags forimport_r(). Formallyset_default_env()doesn't accept flags from its callers. In practice the caller can (un)set theH_INTERACTIVEflag, but it has to be done using the first character of the function's string argument. Other flags likeH_FORCEcan't be set by the caller.Change the function to accept flags argument. The benefits are:
1. The caller will have to explicitly set theH_INTERACTIVEflag, instead of un-setting it using a special char in a string.
2. Add the ability to propagate flags from the caller tohimport(), especially theH_FORCEflag fromdo_env_default()innvedit.cthat currently gets ignored for "env default -a -f" commands.
3. Flags and messages will not be coupled together. A caller will be able to set flags without passing a string and vice versa.
Quoted 8 lines
Please note:
The propagation ofH_FORCEfromdo_env_default()does not introduce any functional changes, because currentlyhimport_r()is set to destroy the old environment regardless ifH_FORCEflag is set or not. More changes are needed to utilize the propagation ofH_FORCE.Signed-off-by Yaniv Levinsky <[email protected]>Acked-by Igor Grinberg <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180720/dac54b57/attachment.sig>
cover fix propagation of flags from do_env_default()
In reply to Yaniv LevinskyGentle ping.
Quoted 26 lines · Yaniv Levinsky
The function
do_env_default()doesn't propagate flags tohimport_r(). It causes the "-f" option to have no effect on the execution of "env default" commands.Fix the call paths from
do_env_default()tohimport_r()to pass flags correctly.Yaniv Levinsky (4):
cmd: nvedit: rename flags indo_env_default
cmd: nvedit: propagate envflag toset_default_vars
cmd: nvedit: setH_INTERACTIVEindo_env_default
env: common: accept flags on reset to default envarch/arm/mach-imx/mx6/opos6ul.c | 2 +- cmd/nvedit.c | 11 ++++++----- common/board_r.c | 2 +- common/spl/spl_dfu.c | 2 +- env/common.c | 27 ++++++++++++--------------- env/ext4.c | 2 +- env/fat.c | 2 +- env/mmc.c | 12 ++++++------ env/nand.c | 6 +++--- env/sata.c | 2 +- env/sf.c | 10 +++++----- env/ubi.c | 6 +++--- include/environment.h | 4 ++-- 13 files changed, 43 insertions(+), 45 deletions(-)