Patchwork [U-Boot,v5] common: add a grepenv command

login
register
mail settings
Submitter Kim Phillips
Date April 5, 2011, 5:15 p.m.
Message ID <20110405121514.8641e889.kim.phillips@freescale.com>
Download mbox | patch
Permalink /patch/89905/
State Accepted
Headers show

Comments

Kim Phillips - April 5, 2011, 5:15 p.m.
u-boot environments, esp. when boards are shared across multiple
users, can get pretty large and time consuming to visually parse.
The grepenv command this patch adds can be used in lieu of printenv
to facilitate searching.  grepenv works like printenv but limits
its output only to environment strings (variable name and value
pairs) that match the user specified substring.

the following examples are on a board with a 5313 byte environment
that spans multiple screen pages:

Example 1:  summarize ethernet configuration:

=> grepenv eth TSEC
etact=FM1@DTSEC2
eth=FM1@DTSEC4
ethact=FM1@DTSEC2
eth1addr=00:E0:0C:00:8b:01
eth2addr=00:E0:0C:00:8b:02
eth3addr=00:E0:0C:00:8b:03
eth4addr=00:E0:0C:00:8b:04
eth5addr=00:E0:0C:00:8b:05
eth6addr=00:E0:0C:00:8b:06
eth7addr=00:E0:0C:00:8b:07
eth8addr=00:E0:0C:00:8b:08
eth9addr=00:E0:0C:00:8b:09
ethaddr=00:E0:0C:00:8b:00
netdev=eth0
uprcw=setenv ethact $eth;setenv filename p4080ds/R_PPSXX_0xe/rcw_0xe_2sgmii_rev2_high.bin;setenv start 0xe8000000;protect off all;run upimage;protect on all
upuboot=setenv ethact $eth;setenv filename u-boot.bin;setenv start eff80000;protect off all;run upimage;protect on all
upucode=setenv ethact $eth;setenv filename fsl_fman_ucode_P4080_101_6.bin;setenv start 0xef000000;protect off all;run upimage;protect on all
usdboot=setenv ethact $eth;tftp 1000000 $dir/$bootfile;tftp 2000000 $dir/initramfs.cpio.gz.uboot;tftp c00000 $dir/p4080ds-usdpaa.dtb;setenv bootargs root=/dev/ram rw console=ttyS0,115200 $othbootargs;bootm 1000000 2000000 c00000;
=>

Example 2: detect unused env vars:

=> grepenv etact
etact=FM1@DTSEC2
=>

Example 3: reveal hardcoded variables; e.g., for fdtaddr:

=> grepenv fdtaddr
fdtaddr=c00000
nfsboot=setenv bootargs root=/dev/nfs rw nfsroot=$serverip:$rootpath ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname:$netdev:off console=$consoledev,$baudrate $othbootargs;tftp $loadaddr $bootfile;tftp $fdtaddr $fdtfile;bootm $loadaddr - $fdtaddr
ramboot=setenv bootargs root=/dev/ram rw console=$consoledev,$baudrate $othbootargs;tftp $ramdiskaddr $ramdiskfile;tftp $loadaddr $bootfile;tftp $fdtaddr $fdtfile;bootm $loadaddr $ramdiskaddr $fdtaddr
=> grep $fdtaddr
fdtaddr=c00000
my_boot=bootm 0x40000000 0x41000000 0x00c00000
my_dtb=tftp 0x00c00000 $prefix/p4080ds.dtb
nohvboot=tftp 1000000 $dir/$bootfile;tftp 2000000 $dir/$ramdiskfile;tftp c00000 $dir/$fdtfile;setenv bootargs root=/dev/ram rw ramdisk_size=0x10000000 console=ttyS0,115200;bootm 1000000 2000000 c00000;
=>

This patch also enables the grepenv command by default on
corenet_ds based boards (and repositions the DHCP command
entry to keep the list sorted).

Signed-off-by: Kim Phillips <kim.phillips@freescale.com>
Cc: Kumar Gala <kumar.gala@freescale.com>
Cc: Andy Fleming <afleming@freescale.com>
---
v2: rebase
v3: address comments from Mike Frysinger, Wolfgang Denk:
- hexport first, so as to always get current environment
- handle multiple strings per invocation, in an OR fashion, uniquify
output
- add a proper #ifdef like CONFIG_CMD_GREPENV, only enabled by default
on corenet_ds systems
- don't use dubious CONFIG_SYS_CBSIZE - use hexported memory
- assign index variables better names than i,j,k.
- provide usage examples in commit text
- add copyright
v4: change to use commit 560d424 as guidance for how to iterate
directly over the variables in the hash table
v5: comments from Peter Tyser:
- add "env grep" to the "env" command
- use memset for matched
also in v5:
- make 'already matched' an array of bits instead of ints to reduce stack usage
- perform in-order argument matching -- previous version would search for last token first
- fix spelling whilst in there: environmnt->environment

 README                       |    1 +
 common/cmd_nvedit.c          |   55 +++++++++++++++++++++++++++++++++++++++--
 include/configs/corenet_ds.h |    3 +-
 include/search.h             |    6 ++++
 lib/hashtable.c              |   23 +++++++++++++++++
 5 files changed, 84 insertions(+), 4 deletions(-)
Wolfgang Denk - April 27, 2011, 10:57 p.m.
Dear Kim Phillips,

In message <20110405121514.8641e889.kim.phillips@freescale.com> you wrote:
> u-boot environments, esp. when boards are shared across multiple
> users, can get pretty large and time consuming to visually parse.
> The grepenv command this patch adds can be used in lieu of printenv
> to facilitate searching.  grepenv works like printenv but limits
> its output only to environment strings (variable name and value
> pairs) that match the user specified substring.
> 
> the following examples are on a board with a 5313 byte environment
> that spans multiple screen pages:
...
>  README                       |    1 +
>  common/cmd_nvedit.c          |   55 +++++++++++++++++++++++++++++++++++++++--
>  include/configs/corenet_ds.h |    3 +-
>  include/search.h             |    6 ++++
>  lib/hashtable.c              |   23 +++++++++++++++++
>  5 files changed, 84 insertions(+), 4 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Patch

diff --git a/README b/README
index bd03523..29e56b7 100644
--- a/README
+++ b/README
@@ -643,6 +643,7 @@  The following options need to be configured:
 		CONFIG_CMD_FDOS		* Dos diskette Support
 		CONFIG_CMD_FLASH	  flinfo, erase, protect
 		CONFIG_CMD_FPGA		  FPGA device initialization support
+		CONFIG_CMD_GREPENV	* search environment
 		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
 		CONFIG_CMD_I2C		* I2C serial bus support
 		CONFIG_CMD_IDE		* IDE harddisk support
diff --git a/common/cmd_nvedit.c b/common/cmd_nvedit.c
index fb69c24..5e9a19d 100644
--- a/common/cmd_nvedit.c
+++ b/common/cmd_nvedit.c
@@ -4,7 +4,9 @@ 
  *
  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  * Andreas Heppel <aheppel@sysgo.de>
-
+ *
+ * Copyright 2011 Freescale Semiconductor, Inc.
+ *
  * See file CREDITS for list of people who contributed to this
  * project.
  *
@@ -160,6 +162,37 @@  int do_env_print (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 	return rcode;
 }
 
+#ifdef CONFIG_CMD_GREPENV
+static int do_env_grep (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+{
+	ENTRY *match;
+	unsigned char matched[env_htab.size / 8];
+	int rcode = 1, arg = 1, idx;
+
+	if (argc < 2)
+		return cmd_usage(cmdtp);
+
+	memset(matched, 0, env_htab.size / 8);
+
+	while (arg <= argc) {
+		idx = 0;
+		while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
+			if (!(matched[idx / 8] & (1 << (idx & 7)))) {
+				puts(match->key);
+				puts("=");
+				puts(match->data);
+				puts("\n");
+			}
+			matched[idx / 8] |= 1 << (idx & 7);
+			rcode = 0;
+		}
+		arg++;
+	}
+
+	return rcode;
+}
+#endif
+
 /*
  * Set a new environment variable,
  * or replace or delete an existing one.
@@ -823,6 +856,9 @@  static cmd_tbl_t cmd_env_sub[] = {
 	U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
 #endif
 	U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
+#if defined(CONFIG_CMD_GREPENV)
+	U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
+#endif
 	U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
 	U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
 #if defined(CONFIG_CMD_RUN)
@@ -870,8 +906,11 @@  U_BOOT_CMD(
 #if defined(CONFIG_CMD_EDITENV)
 	"env edit name - edit environment variable\n"
 #endif
-	"env export [-t | -b | -c] addr [size] - export environmnt\n"
-	"env import [-d] [-t | -b | -c] addr [size] - import environmnt\n"
+	"env export [-t | -b | -c] addr [size] - export environment\n"
+#if defined(CONFIG_CMD_GREPENV)
+	"env grep string [...] - search environment\n"
+#endif
+	"env import [-d] [-t | -b | -c] addr [size] - import environment\n"
 	"env print [name ...] - print environment\n"
 #if defined(CONFIG_CMD_RUN)
 	"env run var [...] - run commands in an environment variable\n"
@@ -903,6 +942,16 @@  U_BOOT_CMD_COMPLETE(
 	var_complete
 );
 
+#ifdef CONFIG_CMD_GREPENV
+U_BOOT_CMD_COMPLETE(
+	grepenv, CONFIG_SYS_MAXARGS, 0,  do_env_grep,
+	"search environment variables",
+	"string ...\n"
+	"    - list environment name=value pairs matching 'string'",
+	var_complete
+);
+#endif
+
 U_BOOT_CMD_COMPLETE(
 	setenv, CONFIG_SYS_MAXARGS, 0,	do_env_set,
 	"set environment variables",
diff --git a/include/configs/corenet_ds.h b/include/configs/corenet_ds.h
index 7bafa05..032bb26 100644
--- a/include/configs/corenet_ds.h
+++ b/include/configs/corenet_ds.h
@@ -474,14 +474,15 @@ 
  */
 #include <config_cmd_default.h>
 
+#define CONFIG_CMD_DHCP
 #define CONFIG_CMD_ELF
 #define CONFIG_CMD_ERRATA
+#define CONFIG_CMD_GREPENV
 #define CONFIG_CMD_IRQ
 #define CONFIG_CMD_I2C
 #define CONFIG_CMD_MII
 #define CONFIG_CMD_PING
 #define CONFIG_CMD_SETEXPR
-#define CONFIG_CMD_DHCP
 
 #ifdef CONFIG_PCI
 #define CONFIG_CMD_PCI
diff --git a/include/search.h b/include/search.h
index a7c1293..c827d4d 100644
--- a/include/search.h
+++ b/include/search.h
@@ -80,6 +80,12 @@  extern int hsearch_r(ENTRY __item, ACTION __action, ENTRY ** __retval,
  */
 extern int hmatch_r(const char *__match, int __last_idx, ENTRY ** __retval,
 		    struct hsearch_data *__htab);
+/*
+ * Search for an entry whose key or data contains `MATCH'.  Otherwise,
+ * Same semantics as hsearch_r().
+ */
+extern int hstrstr_r(const char *__match, int __last_idx, ENTRY ** __retval,
+		    struct hsearch_data *__htab);
 
 /* Search and delete entry matching ITEM.key in internal hash table. */
 extern int hdelete_r(const char *__key, struct hsearch_data *__htab);
diff --git a/lib/hashtable.c b/lib/hashtable.c
index fcdb53c..2788a65 100644
--- a/lib/hashtable.c
+++ b/lib/hashtable.c
@@ -202,6 +202,29 @@  void hdestroy_r(struct hsearch_data *htab)
  *   example for functions like hdelete().
  */
 
+/*
+ * hstrstr_r - return index to entry whose key and/or data contains match
+ */
+int hstrstr_r(const char *match, int last_idx, ENTRY ** retval,
+	      struct hsearch_data *htab)
+{
+	unsigned int idx;
+
+	for (idx = last_idx + 1; idx < htab->size; ++idx) {
+		if (htab->table[idx].used <= 0)
+			continue;
+		if (strstr(htab->table[idx].entry.key, match) ||
+		    strstr(htab->table[idx].entry.data, match)) {
+			*retval = &htab->table[idx].entry;
+			return idx;
+		}
+	}
+
+	__set_errno(ESRCH);
+	*retval = NULL;
+	return 0;
+}
+
 int hmatch_r(const char *match, int last_idx, ENTRY ** retval,
 	     struct hsearch_data *htab)
 {