Skip to contentSkip to conversation

Check for NULL prompt in readline_into_buffer()

PATCH New Peter Tyser 2 participants 10 messages Oct 25, 2009 – Oct 27, 2009

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/5 Check for NULL prompt in readline_into_buffer()

Previously, passing readline() or readline_into_buffer() a NULL 'prompt' parameter would result in puts() printing garbage when CONFIG_CMDLINE_EDITING was enabled.

Note that no board currently triggers this bug. Enabling CONFIG_CMDLINE_EDITING on some boards (eg bab7xx) would result in the bug appearing. This change is only intended to prevent someone from running into this issue in the future.

---
Changes since v1:
- Updated commit message

This change isn't strictly necessary for the new "editenv" command, I just noticed it during development of the "editenv" command.

 common/main.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
common/main.c +2 -1
index 026edd1..298982a 100644
@@ -964,7 +964,8 @@ int readline_into_buffer (const char *const prompt, char * buffer)
 			initted = 1;
 		}
 
-		puts (prompt);
+		if (prompt)
+			puts (prompt);
 
 		rc = cread_line(prompt, p, &len);
 		return rc < 0 ? rc : len;
Signature · 1 line
1.6.2.1
#1 lore raw

PATCH v2 2/5 cread_line(): Remove unused variables

---
- No change since v1

 common/main.c |    5 +----
 1 files changed, 1 insertions(+), 4 deletions(-)
common/main.c +1 -4
index 298982a..b47e443 100644
@@ -715,16 +715,13 @@ static int cread_line(const char *const prompt, char *buf, unsigned int *len)
 {
 	unsigned long num = 0;
 	unsigned long eol_num = 0;
-	unsigned long rlen;
 	unsigned long wlen;
 	char ichar;
 	int insert = 1;
 	int esc_len = 0;
-	int rc = 0;
 	char esc_save[8];
 
 	while (1) {
-		rlen = 1;
 #ifdef CONFIG_BOOT_RETRY_TIME
 		while (!tstc()) {	/* while no incoming data */
 			if (retry_time >= 0 && get_ticks() > endtime)
@@ -923,7 +920,7 @@ static int cread_line(const char *const prompt, char *buf, unsigned int *len)
 		cread_add_to_hist(buf);
 	hist_cur = hist_add_idx;
 
-	return (rc);
+	return 0;
 }
 
 #endif /* CONFIG_CMDLINE_EDITING */
Signature · 1 line
1.6.2.1
#2 lore raw

PATCH v2 2/5 cread_line(): Remove unused variables

Dear Peter Tyser,

Quoted 6 lines · In message <[email protected]> you wrote:

---
- No change since v1

 common/main.c |    5 +----
 1 files changed, 1 insertions(+), 4 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 10 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
"The History of every  major  Galactic  Civilization  tends  to  pass
through  three  distinct  and recognizable phases, those of Survival,
Inquiry and Sophistication, otherwise known as the How, Why and Where
phases. "For instance,  the  first  phase  is  characterized  by  the
question  'How  can  we  eat?'  the second by the question 'Why do we
eat?' and the third by the question 'Where shall we have lunch?'"
- Hitchhiker's Guide to the Galaxy
#3 lore raw

PATCH v2 3/5 readline(): Add ability to modify a string buffer

In reply to Peter Tyser

If the 'buf' parameter is a non-0-length string, its contents will be edited. Previously, the initial contents of 'buf' were ignored and the user entered its contents from scratch.

This change is necessary to support the upcoming "editenv" command but could also be used for future commands which require a user to modify an existing string.

---
Changes since v1:
- Updated commit message

 common/main.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
common/main.c +10 -0
index b47e443..10d8904 100644
@@ -720,6 +720,10 @@ static int cread_line(const char *const prompt, char *buf, unsigned int *len)
 	int insert = 1;
 	int esc_len = 0;
 	char esc_save[8];
+	int init_len = strlen(buf);
+
+	if (init_len)
+		cread_add_str(buf, init_len, 1, &num, &eol_num, buf, *len);
 
 	while (1) {
 #ifdef CONFIG_BOOT_RETRY_TIME
@@ -937,6 +941,12 @@ static int cread_line(const char *const prompt, char *buf, unsigned int *len)
  */
 int readline (const char *const prompt)
 {
+	/*
+	 * If console_buffer isn't 0-length the user will be prompted to modify
+	 * it instead of entering it from scratch as desired.
+	 */
+	console_buffer[0] = '\0';
+
 	return readline_into_buffer(prompt, console_buffer);
 }
 
Signature · 1 line
1.6.2.1
#4 lore raw

PATCH v2 3/5 readline(): Add ability to modify a string buffer

Dear Peter Tyser,

Quoted 8 lines · In message <[email protected]> you wrote:

If the 'buf' parameter is a non-0-length string, its contents will be edited. Previously, the initial contents of 'buf' were ignored and the user entered its contents from scratch.

This change is necessary to support the upcoming "editenv" command but could also be used for future commands which require a user to modify an existing string.

Quoted 7 lines

---
Changes since v1:
- Updated commit message

 common/main.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 6 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Women professionals do tend to over-compensate.
	-- Dr. Elizabeth Dehaver, "Where No Man Has Gone Before",
	   stardate 1312.9.
#5 lore raw

PATCH v2 4/5 setenv(): Delete 0-length environment variables

In reply to Peter Tyser

Previously setenv() would only delete an environment variable if it was passed a NULL string pointer as a value. It should also delete an environment variable when it encounters a valid string pointer of 0-length.

This change/fix is generally useful and is necessary for the upcoming "editenv" command.

---
Changes since v1:
- Updated commit title/message

 common/cmd_nvedit.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
common/cmd_nvedit.c +1 -1
index 9f8d531..725e573 100644
@@ -400,7 +400,7 @@ int _do_setenv (int flag, int argc, char *argv[])
 int setenv (char *varname, char *varvalue)
 {
 	char *argv[4] = { "setenv", varname, varvalue, NULL };
-	if (varvalue == NULL)
+	if ((varvalue == NULL) || (varvalue[0] == '\0'))
 		return _do_setenv (0, 2, argv);
 	else
 		return _do_setenv (0, 3, argv);
Signature · 1 line
1.6.2.1
#6 lore raw

PATCH v2 4/5 setenv(): Delete 0-length environment variables

Dear Peter Tyser,

Quoted 8 lines · In message <[email protected]> you wrote:

Previously setenv() would only delete an environment variable if it was passed a NULL string pointer as a value. It should also delete an environment variable when it encounters a valid string pointer of 0-length.

This change/fix is generally useful and is necessary for the upcoming "editenv" command.

Quoted 7 lines

---
Changes since v1:
- Updated commit title/message

 common/cmd_nvedit.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 4 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Computers are not intelligent.  They only think they are.
#7 lore raw

PATCH v2 5/5 Add 'editenv' command

In reply to Peter Tyser

The editenv command can be used to edit an environment variable. Editing an environment variable is useful when one wants to tweak an existing variable, for example fix a typo or change the baudrate in the 'bootargs' environment variable.

---
- No changes since v1

The footprint of editenv is relatively small and I personally find it very useful so I added it to the config_cmd_default.h. Let me know if others would prefer not to include it by default.

 README                       |    1 +
 common/cmd_nvedit.c          |   40 ++++++++++++++++++++++++++++++++++++++++
 include/config_cmd_all.h     |    1 +
 include/config_cmd_default.h |    1 +
 4 files changed, 43 insertions(+), 0 deletions(-)
README +1 -0
index 744f6bf..c300443 100644
@@ -620,6 +620,7 @@ The following options need to be configured:
 		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
 		CONFIG_CMD_DTT		* Digital Therm and Thermostat
 		CONFIG_CMD_ECHO		  echo arguments
+		CONFIG_CMD_EDITENV	  edit env variable
 		CONFIG_CMD_EEPROM	* EEPROM read/write support
 		CONFIG_CMD_ELF		* bootelf, bootvx
 		CONFIG_CMD_SAVEENV	  saveenv
common/cmd_nvedit.c +40 -0
index 725e573..eb89e9e 100644
@@ -42,6 +42,9 @@
 #include <common.h>
 #include <command.h>
 #include <environment.h>
+#if defined(CONFIG_CMD_EDITENV)
+#include <malloc.h>
+#endif
 #include <watchdog.h>
 #include <serial.h>
 #include <linux/stddef.h>
@@ -503,6 +506,34 @@ int do_askenv ( cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 #endif
 
 /************************************************************************
+ * Interactively edit an environment variable
+ */
+#if defined(CONFIG_CMD_EDITENV)
+int do_editenv(cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
+{
+	char buffer[CONFIG_SYS_CBSIZE];
+	char *init_val;
+	int len;
+
+	if (argc < 2) {
+		cmd_usage(cmdtp);
+		return 1;
+	}
+
+	/* Set read buffer to initial value or empty sting */
+	init_val = getenv(argv[1]);
+	if (init_val)
+		len = sprintf(buffer, "%s", init_val);
+	else
+		buffer[0] = '\0';
+
+	readline_into_buffer("edit: ", buffer);
+
+	return setenv(argv[1], buffer);
+}
+#endif /* CONFIG_CMD_EDITENV */
+
+/************************************************************************
  * Look up variable from environment,
  * return address of storage for that variable,
  * or NULL if not found
@@ -597,6 +628,15 @@ int envmatch (uchar *s1, int i2)
 
 /**************************************************/
 
+#if defined(CONFIG_CMD_EDITENV)
+U_BOOT_CMD(
+	editenv, 2, 0,	do_editenv,
+	"edit environment variable",
+	"name\n"
+	"    - edit environment variable 'name'"
+);
+#endif
+
 U_BOOT_CMD(
 	printenv, CONFIG_SYS_MAXARGS, 1,	do_printenv,
 	"print environment variables",
include/config_cmd_all.h +1 -0
index c747b4b..058fdf1 100644
@@ -30,6 +30,7 @@
 #define CONFIG_CMD_DOC		/* Disk-On-Chip Support		*/
 #define CONFIG_CMD_DTT		/* Digital Therm and Thermostat */
 #define CONFIG_CMD_ECHO		/* echo arguments		*/
+#define CONFIG_CMD_EDITENV	/* editenv			*/
 #define CONFIG_CMD_EEPROM	/* EEPROM read/write support	*/
 #define CONFIG_CMD_ELF		/* ELF (VxWorks) load/boot cmd	*/
 #define CONFIG_CMD_SAVEENV	/* saveenv			*/
include/config_cmd_default.h +1 -0
index a5d87a6..6e3903c 100644
@@ -20,6 +20,7 @@
 #define CONFIG_CMD_BOOTD	/* bootd			*/
 #define CONFIG_CMD_CONSOLE	/* coninfo			*/
 #define CONFIG_CMD_ECHO		/* echo arguments		*/
+#define CONFIG_CMD_EDITENV	/* editenv			*/
 #define CONFIG_CMD_FPGA		/* FPGA configuration Support	*/
 #define CONFIG_CMD_IMI		/* iminfo			*/
 #define CONFIG_CMD_ITEST	/* Integer (and string) test	*/
Signature · 1 line
1.6.2.1
#8 lore raw

PATCH v2 5/5 Add 'editenv' command

Dear Peter Tyser,

Quoted 13 lines · In message <[email protected]> you wrote:

The editenv command can be used to edit an environment variable. Editing an environment variable is useful when one wants to tweak an existing variable, for example fix a typo or change the baudrate in the 'bootargs' environment variable.

---
- No changes since v1

The footprint of editenv is relatively small and I personally find it very useful so I added it to the config_cmd_default.h. Let me know if others would prefer not to include it by default.

Quoted 5 lines
 README                       |    1 +
 common/cmd_nvedit.c          |   40 ++++++++++++++++++++++++++++++++++++++++
 include/config_cmd_all.h     |    1 +
 include/config_cmd_default.h |    1 +
 4 files changed, 43 insertions(+), 0 deletions(-)

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 6 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Lots of people drink from the wrong bottle sometimes.
	-- Edith Keeler, "The City on the Edge of Forever",
	   stardate unknown
#9 lore raw

PATCH v2 1/5 Check for NULL prompt in readline_into_buffer()

In reply to Peter Tyser

Dear Peter Tyser,

Quoted 9 lines · In message <[email protected]> you wrote:

Previously, passing readline() or readline_into_buffer() a NULL 'prompt' parameter would result in puts() printing garbage when CONFIG_CMDLINE_EDITING was enabled.

Note that no board currently triggers this bug. Enabling CONFIG_CMDLINE_EDITING on some boards (eg bab7xx) would result in the bug appearing. This change is only intended to prevent someone from running into this issue in the future.

Quoted 7 lines

---
Changes since v1:
- Updated commit message

This change isn't strictly necessary for the new "editenv" command, I just noticed it during development of the "editenv" command.

Regarding the whole series: some of the patches fix actual bugs (including potential ones), i. e. 1/5 and 4/5, or cleanups (2/5), which I want to have in the next release. The other ones are new stuff, which should actually go into "next", but then I don't want to rip the patch sequence apart.

And we don't have -rc1 yet, so I allow myself to apply the whole series now.

Applied, thanks.

Best regards,

Wolfgang Denk

Signature · 7 lines
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
In any group of employed individuals the only naturally  early  riser
is  _always_  the office manager, who will _always_ leave reproachful
little notes ... on the desks of their subordinates.
                                - Terry Pratchett, _Lords and Ladies_