Blame view

common/cli_simple.c 7.32 KB
83d290c56   Tom Rini   SPDX: Convert all...
1
  // SPDX-License-Identifier: GPL-2.0+
6493ccc7c   Simon Glass   Split out simple ...
2
3
4
5
6
7
8
  /*
   * (C) Copyright 2000
   * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   *
   * Add to readline cmdline-editing by
   * (C) Copyright 2005
   * JinHua Luo, GuangDong Linux Center, <luo.jinhua@gd-linux.com>
6493ccc7c   Simon Glass   Split out simple ...
9
10
11
   */
  
  #include <common.h>
0098e179e   Simon Glass   Move bootretry co...
12
  #include <bootretry.h>
6493ccc7c   Simon Glass   Split out simple ...
13
  #include <cli.h>
288b29e44   Simon Glass   common: Move comm...
14
  #include <command.h>
24b852a7a   Simon Glass   Move console defi...
15
  #include <console.h>
7b51b576d   Simon Glass   env: Move env_get...
16
  #include <env.h>
6493ccc7c   Simon Glass   Split out simple ...
17
18
19
20
21
22
  #include <linux/ctype.h>
  
  #define DEBUG_PARSER	0	/* set to 1 to debug */
  
  #define debug_parser(fmt, args...)		\
  	debug_cond(DEBUG_PARSER, fmt, ##args)
e1bf824df   Simon Glass   Add cli_ prefix t...
23
  int cli_simple_parse_line(char *line, char *argv[])
6493ccc7c   Simon Glass   Split out simple ...
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  {
  	int nargs = 0;
  
  	debug_parser("%s: \"%s\"
  ", __func__, line);
  	while (nargs < CONFIG_SYS_MAXARGS) {
  		/* skip any white space */
  		while (isblank(*line))
  			++line;
  
  		if (*line == '\0') {	/* end of line, no more args	*/
  			argv[nargs] = NULL;
  			debug_parser("%s: nargs=%d
  ", __func__, nargs);
  			return nargs;
  		}
  
  		argv[nargs++] = line;	/* begin of argument string	*/
  
  		/* find end of string */
  		while (*line && !isblank(*line))
  			++line;
  
  		if (*line == '\0') {	/* end of line, no more args	*/
  			argv[nargs] = NULL;
  			debug_parser("parse_line: nargs=%d
  ", nargs);
  			return nargs;
  		}
  
  		*line++ = '\0';		/* terminate current arg	 */
  	}
  
  	printf("** Too many args (max. %d) **
  ", CONFIG_SYS_MAXARGS);
  
  	debug_parser("%s: nargs=%d
  ", __func__, nargs);
  	return nargs;
  }
a06be2d07   Hans de Goede   cli: Export cli_s...
64
  void cli_simple_process_macros(const char *input, char *output)
6493ccc7c   Simon Glass   Split out simple ...
65
66
67
68
69
70
71
72
73
74
  {
  	char c, prev;
  	const char *varname_start = NULL;
  	int inputcnt = strlen(input);
  	int outputcnt = CONFIG_SYS_CBSIZE;
  	int state = 0;		/* 0 = waiting for '$'  */
  
  	/* 1 = waiting for '(' or '{' */
  	/* 2 = waiting for ')' or '}' */
  	/* 3 = waiting for '''  */
80402f34f   Heiko Schocher   spl, common, seri...
75
  	char __maybe_unused *output_start = output;
6493ccc7c   Simon Glass   Split out simple ...
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
  
  	debug_parser("[PROCESS_MACROS] INPUT len %zd: \"%s\"
  ", strlen(input),
  		     input);
  
  	prev = '\0';		/* previous character   */
  
  	while (inputcnt && outputcnt) {
  		c = *input++;
  		inputcnt--;
  
  		if (state != 3) {
  			/* remove one level of escape characters */
  			if ((c == '\\') && (prev != '\\')) {
  				if (inputcnt-- == 0)
  					break;
  				prev = c;
  				c = *input++;
  			}
  		}
  
  		switch (state) {
  		case 0:	/* Waiting for (unescaped) $    */
  			if ((c == '\'') && (prev != '\\')) {
  				state = 3;
  				break;
  			}
  			if ((c == '$') && (prev != '\\')) {
  				state++;
  			} else {
  				*(output++) = c;
  				outputcnt--;
  			}
  			break;
  		case 1:	/* Waiting for (        */
  			if (c == '(' || c == '{') {
  				state++;
  				varname_start = input;
  			} else {
  				state = 0;
  				*(output++) = '$';
  				outputcnt--;
  
  				if (outputcnt) {
  					*(output++) = c;
  					outputcnt--;
  				}
  			}
  			break;
  		case 2:	/* Waiting for )        */
  			if (c == ')' || c == '}') {
  				int i;
  				char envname[CONFIG_SYS_CBSIZE], *envval;
  				/* Varname # of chars */
  				int envcnt = input - varname_start - 1;
  
  				/* Get the varname */
  				for (i = 0; i < envcnt; i++)
  					envname[i] = varname_start[i];
  				envname[i] = 0;
  
  				/* Get its value */
00caae6d4   Simon Glass   env: Rename geten...
138
  				envval = env_get(envname);
6493ccc7c   Simon Glass   Split out simple ...
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  
  				/* Copy into the line if it exists */
  				if (envval != NULL)
  					while ((*envval) && outputcnt) {
  						*(output++) = *(envval++);
  						outputcnt--;
  					}
  				/* Look for another '$' */
  				state = 0;
  			}
  			break;
  		case 3:	/* Waiting for '        */
  			if ((c == '\'') && (prev != '\\')) {
  				state = 0;
  			} else {
  				*(output++) = c;
  				outputcnt--;
  			}
  			break;
  		}
  		prev = c;
  	}
  
  	if (outputcnt)
  		*output = 0;
  	else
  		*(output - 1) = 0;
  
  	debug_parser("[PROCESS_MACROS] OUTPUT len %zd: \"%s\"
  ",
  		     strlen(output_start), output_start);
  }
  
   /*
   * WARNING:
   *
   * We must create a temporary copy of the command since the command we get
00caae6d4   Simon Glass   env: Rename geten...
176
   * may be the result from env_get(), which returns a pointer directly to
6493ccc7c   Simon Glass   Split out simple ...
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
   * the environment data, which may change magicly when the command we run
   * creates or modifies environment variables (like "bootp" does).
   */
  int cli_simple_run_command(const char *cmd, int flag)
  {
  	char cmdbuf[CONFIG_SYS_CBSIZE];	/* working copy of cmd		*/
  	char *token;			/* start of token in cmdbuf	*/
  	char *sep;			/* end of token (separator) in cmdbuf */
  	char finaltoken[CONFIG_SYS_CBSIZE];
  	char *str = cmdbuf;
  	char *argv[CONFIG_SYS_MAXARGS + 1];	/* NULL terminated	*/
  	int argc, inquotes;
  	int repeatable = 1;
  	int rc = 0;
  
  	debug_parser("[RUN_COMMAND] cmd[%p]=\"", cmd);
  	if (DEBUG_PARSER) {
  		/* use puts - string may be loooong */
  		puts(cmd ? cmd : "NULL");
  		puts("\"
  ");
  	}
  	clear_ctrlc();		/* forget any previous Control C */
  
  	if (!cmd || !*cmd)
  		return -1;	/* empty command */
  
  	if (strlen(cmd) >= CONFIG_SYS_CBSIZE) {
  		puts("## Command too long!
  ");
  		return -1;
  	}
  
  	strcpy(cmdbuf, cmd);
  
  	/* Process separators and check for invalid
  	 * repeatable commands
  	 */
  
  	debug_parser("[PROCESS_SEPARATORS] %s
  ", cmd);
  	while (*str) {
  		/*
  		 * Find separator, or string end
  		 * Allow simple escape of ';' by writing "\;"
  		 */
  		for (inquotes = 0, sep = str; *sep; sep++) {
  			if ((*sep == '\'') &&
  			    (*(sep - 1) != '\\'))
  				inquotes = !inquotes;
  
  			if (!inquotes &&
  			    (*sep == ';') &&	/* separator		*/
  			    (sep != str) &&	/* past string start	*/
  			    (*(sep - 1) != '\\'))	/* and NOT escaped */
  				break;
  		}
  
  		/*
  		 * Limit the token to data between separators
  		 */
  		token = str;
  		if (*sep) {
  			str = sep + 1;	/* start of command for next pass */
  			*sep = '\0';
  		} else {
  			str = sep;	/* no more commands for next pass */
  		}
  		debug_parser("token: \"%s\"
  ", token);
  
  		/* find macros in this token and replace them */
a06be2d07   Hans de Goede   cli: Export cli_s...
249
  		cli_simple_process_macros(token, finaltoken);
6493ccc7c   Simon Glass   Split out simple ...
250
251
  
  		/* Extract arguments */
e1bf824df   Simon Glass   Add cli_ prefix t...
252
  		argc = cli_simple_parse_line(finaltoken, argv);
6493ccc7c   Simon Glass   Split out simple ...
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
  		if (argc == 0) {
  			rc = -1;	/* no command at all */
  			continue;
  		}
  
  		if (cmd_process(flag, argc, argv, &repeatable, NULL))
  			rc = -1;
  
  		/* Did the user stop this? */
  		if (had_ctrlc())
  			return -1;	/* if stopped then not repeatable */
  	}
  
  	return rc ? rc : repeatable;
  }
c1bb2cd0b   Simon Glass   main: Hide the hu...
268
  void cli_simple_loop(void)
6493ccc7c   Simon Glass   Split out simple ...
269
  {
ca7def600   Imran Zaman   cli_simple.c: fix...
270
  	static char lastcommand[CONFIG_SYS_CBSIZE + 1] = { 0, };
6493ccc7c   Simon Glass   Split out simple ...
271
272
273
274
275
276
  
  	int len;
  	int flag;
  	int rc = 1;
  
  	for (;;) {
6493ccc7c   Simon Glass   Split out simple ...
277
278
279
280
  		if (rc >= 0) {
  			/* Saw enough of a valid command to
  			 * restart the timeout.
  			 */
b26440f1f   Simon Glass   Rename bootretry ...
281
  			bootretry_reset_cmd_timeout();
6493ccc7c   Simon Glass   Split out simple ...
282
  		}
e1bf824df   Simon Glass   Add cli_ prefix t...
283
  		len = cli_readline(CONFIG_SYS_PROMPT);
6493ccc7c   Simon Glass   Split out simple ...
284
285
286
  
  		flag = 0;	/* assume no special flags for now */
  		if (len > 0)
bb08a6e7d   Peng Fan   common: cli_simpl...
287
288
  			strlcpy(lastcommand, console_buffer,
  				CONFIG_SYS_CBSIZE + 1);
6493ccc7c   Simon Glass   Split out simple ...
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
  		else if (len == 0)
  			flag |= CMD_FLAG_REPEAT;
  #ifdef CONFIG_BOOT_RETRY_TIME
  		else if (len == -2) {
  			/* -2 means timed out, retry autoboot
  			 */
  			puts("
  Timed out waiting for command
  ");
  # ifdef CONFIG_RESET_TO_RETRY
  			/* Reinit board to run initialization code again */
  			do_reset(NULL, 0, 0, NULL);
  # else
  			return;		/* retry autoboot */
  # endif
  		}
  #endif
  
  		if (len == -1)
  			puts("<INTERRUPT>
  ");
  		else
52715f893   Thomas Betker   Use run_command_r...
311
  			rc = run_command_repeatable(lastcommand, flag);
6493ccc7c   Simon Glass   Split out simple ...
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
  
  		if (rc <= 0) {
  			/* invalid command or not repeatable, forget it */
  			lastcommand[0] = 0;
  		}
  	}
  }
  
  int cli_simple_run_command_list(char *cmd, int flag)
  {
  	char *line, *next;
  	int rcode = 0;
  
  	/*
  	 * Break into individual lines, and execute each line; terminate on
  	 * error.
  	 */
  	next = cmd;
  	line = cmd;
  	while (*next) {
  		if (*next == '
  ') {
  			*next = '\0';
  			/* run only non-empty commands */
  			if (*line) {
  				debug("** exec: \"%s\"
  ", line);
  				if (cli_simple_run_command(line, 0) < 0) {
  					rcode = 1;
  					break;
  				}
  			}
  			line = next + 1;
  		}
  		++next;
  	}
  	if (rcode == 0 && *line)
4eb580b78   Simon Glass   Correct return co...
349
  		rcode = (cli_simple_run_command(line, 0) < 0);
6493ccc7c   Simon Glass   Split out simple ...
350
351
352
  
  	return rcode;
  }