1 /* vi: set sw=4 ts=4: */
3 * A prototype Bourne shell grammar parser.
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
9 * Copyright (C) 2008,2009 Denys Vlasenko <vda.linux@googlemail.com>
12 * The parser routines proper are all original material, first
13 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
14 * execution engine, the builtins, and much of the underlying
15 * support has been adapted from busybox-0.49pre's lash, which is
16 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
17 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
18 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
19 * Troan, which they placed in the public domain. I don't know
20 * how much of the Johnson/Troan code has survived the repeated
24 * o_addchr derived from similar w_addchar function in glibc-2.2.
25 * parse_redirect, redirect_opt_num, and big chunks of main
26 * and many builtins derived from contributions by Erik Andersen.
27 * Miscellaneous bugfixes from Matt Kraai.
29 * There are two big (and related) architecture differences between
30 * this parser and the lash parser. One is that this version is
31 * actually designed from the ground up to understand nearly all
32 * of the Bourne grammar. The second, consequential change is that
33 * the parser and input reader have been turned inside out. Now,
34 * the parser is in control, and asks for input as needed. The old
35 * way had the input reader in control, and it asked for parsing to
36 * take place as needed. The new way makes it much easier to properly
37 * handle the recursion implicit in the various substitutions, especially
38 * across continuation lines.
40 * POSIX syntax not implemented:
45 * redirection of stdout+stderr: &> and >&
46 * brace expansion: one/{two,three,four}
47 * reserved words: function select
48 * advanced test: [[ ]]
49 * substrings: ${var:1:5}
50 * process substitution: <(list) and >(list)
53 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
54 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
55 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
57 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
58 * This is exactly equivalent to let "EXPR".
59 * $[EXPR]: synonym for $((EXPR))
62 * grep for "TODO" and fix (some of them are easy)
63 * special variables (done: PWD, PPID, RANDOM)
64 * follow IFS rules more precisely, including update semantics
65 * export builtin should be special, its arguments are assignments
66 * and therefore expansion of them should be "one-word" expansion:
67 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
69 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
70 * ls: cannot access i=a: No such file or directory
71 * ls: cannot access b: No such file or directory
72 * Note1: same applies to local builtin.
73 * Note2: bash 3.2.33(1) does this only if export word itself
75 * $ export i=`echo 'aaa bbb'`; echo "$i"
77 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
80 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
82 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
83 #include <malloc.h> /* for malloc_trim */
85 /* #include <dmalloc.h> */
90 #include "shell_common.h"
91 #include "builtin_read.h"
92 #include "builtin_ulimit.h"
95 #if ENABLE_HUSH_RANDOM_SUPPORT
98 # define CLEAR_RANDOM_T(rnd) ((void)0)
101 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
106 #define LEAK_HUNTING 0
107 #define BUILD_AS_NOMMU 0
108 /* Enable/disable sanity checks. Ok to enable in production,
109 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
110 * Keeping 1 for now even in released versions.
113 /* Slightly bigger (+200 bytes), but faster hush.
114 * So far it only enables a trick with counting SIGCHLDs and forks,
115 * which allows us to do fewer waitpid's.
116 * (we can detect a case where neither forks were done nor SIGCHLDs happened
117 * and therefore waitpid will return the same result as last time)
119 #define ENABLE_HUSH_FAST 0
124 # undef USE_FOR_NOMMU
127 # define USE_FOR_NOMMU(...) __VA_ARGS__
128 # define USE_FOR_MMU(...)
131 #define SKIP_definitions 1
132 #include "applet_tables.h"
133 #undef SKIP_definitions
135 /* STANDALONE does not make sense, and won't compile */
136 # undef CONFIG_FEATURE_SH_STANDALONE
137 # undef ENABLE_FEATURE_SH_STANDALONE
138 # undef IF_FEATURE_SH_STANDALONE
139 # undef IF_NOT_FEATURE_SH_STANDALONE
140 # define ENABLE_FEATURE_SH_STANDALONE 0
141 # define IF_FEATURE_SH_STANDALONE(...)
142 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
145 #if !ENABLE_HUSH_INTERACTIVE
146 # undef ENABLE_FEATURE_EDITING
147 # define ENABLE_FEATURE_EDITING 0
148 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
149 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
152 /* Do we support ANY keywords? */
153 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
154 # define HAS_KEYWORDS 1
155 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
156 # define IF_HAS_NO_KEYWORDS(...)
158 # define HAS_KEYWORDS 0
159 # define IF_HAS_KEYWORDS(...)
160 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
163 /* If you comment out one of these below, it will be #defined later
164 * to perform debug printfs to stderr: */
165 #define debug_printf(...) do {} while (0)
166 /* Finer-grained debug switches */
167 #define debug_printf_parse(...) do {} while (0)
168 #define debug_print_tree(a, b) do {} while (0)
169 #define debug_printf_exec(...) do {} while (0)
170 #define debug_printf_env(...) do {} while (0)
171 #define debug_printf_jobs(...) do {} while (0)
172 #define debug_printf_expand(...) do {} while (0)
173 #define debug_printf_glob(...) do {} while (0)
174 #define debug_printf_list(...) do {} while (0)
175 #define debug_printf_subst(...) do {} while (0)
176 #define debug_printf_clean(...) do {} while (0)
178 #define ERR_PTR ((void*)(long)1)
180 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
182 #define SPECIAL_VAR_SYMBOL 3
186 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
188 /* This supports saving pointers malloced in vfork child,
189 * to be freed in the parent.
192 typedef struct nommu_save_t {
194 struct variable *old_vars;
196 char **argv_from_re_execing;
200 typedef enum reserved_style {
209 #if ENABLE_HUSH_LOOPS
216 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
221 /* three pseudo-keywords support contrived "case" syntax: */
222 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
223 RES_MATCH , /* "word)" */
224 RES_CASE_BODY, /* "this command is inside CASE" */
231 typedef struct o_string {
233 int length; /* position where data is appended */
235 /* Protect newly added chars against globbing
236 * (by prepending \ to *, ?, [, \) */
239 /* At least some part of the string was inside '' or "",
240 * possibly empty one: word"", wo''rd etc. */
242 smallint has_empty_slot;
243 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
246 MAYBE_ASSIGNMENT = 0,
247 DEFINITELY_ASSIGNMENT = 1,
249 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
251 /* Used for initialization: o_string foo = NULL_O_STRING; */
252 #define NULL_O_STRING { NULL }
254 /* I can almost use ordinary FILE*. Is open_memstream() universally
255 * available? Where is it documented? */
256 typedef struct in_str {
258 /* eof_flag=1: last char in ->p is really an EOF */
259 char eof_flag; /* meaningless if ->p == NULL */
261 #if ENABLE_HUSH_INTERACTIVE
263 smallint promptmode; /* 0: PS1, 1: PS2 */
266 int (*get) (struct in_str *) FAST_FUNC;
267 int (*peek) (struct in_str *) FAST_FUNC;
269 #define i_getch(input) ((input)->get(input))
270 #define i_peek(input) ((input)->peek(input))
272 /* The descrip member of this structure is only used to make
273 * debugging output pretty */
274 static const struct {
276 signed char default_fd;
279 { O_RDONLY, 0, "<" },
280 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
281 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
282 { O_CREAT|O_RDWR, 1, "<>" },
283 { O_RDONLY, 0, "<<" },
284 /* Should not be needed. Bogus default_fd helps in debugging */
285 /* { O_RDONLY, 77, "<<" }, */
288 struct redir_struct {
289 struct redir_struct *next;
290 char *rd_filename; /* filename */
291 int rd_fd; /* fd to redirect */
292 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
294 smallint rd_type; /* (enum redir_type) */
295 /* note: for heredocs, rd_filename contains heredoc delimiter,
296 * and subsequently heredoc itself; and rd_dup is a bitmask:
297 * bit 0: do we need to trim leading tabs?
298 * bit 1: is heredoc quoted (<<'delim' syntax) ?
301 typedef enum redir_type {
303 REDIRECT_OVERWRITE = 1,
306 REDIRECT_HEREDOC = 4,
307 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
310 REDIRFD_SYNTAX_ERR = -2,
311 REDIRFD_TO_FILE = -1,
312 /* otherwise, rd_fd is redirected to rd_dup */
314 HEREDOC_SKIPTABS = 1,
320 pid_t pid; /* 0 if exited */
321 int assignment_cnt; /* how many argv[i] are assignments? */
322 smallint is_stopped; /* is the command currently running? */
323 smallint cmd_type; /* CMD_xxx */
325 #define CMD_SUBSHELL 1
327 /* used for "[[ EXPR ]]" */
328 #if ENABLE_HUSH_BASH_COMPAT
329 # define CMD_SINGLEWORD_NOGLOB 2
332 /* used for "export noglob=* glob* a=`echo a b`" */
333 //#define CMD_SINGLEWORD_NOGLOB_COND 3
334 // It is hard to implement correctly, it adds significant amounts of tricky code,
335 // and all this is only useful for really obscure export statements
336 // almost nobody would use anyway. #ifdef CMD_SINGLEWORD_NOGLOB_COND
337 // guards the code which implements it, but I have doubts it works
338 // in all cases (especially with mixed globbed/non-globbed arguments)
340 #if ENABLE_HUSH_FUNCTIONS
341 # define CMD_FUNCDEF 3
344 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
347 char *group_as_string;
349 #if ENABLE_HUSH_FUNCTIONS
350 struct function *child_func;
351 /* This field is used to prevent a bug here:
352 * while...do f1() {a;}; f1; f1() {b;}; f1; done
353 * When we execute "f1() {a;}" cmd, we create new function and clear
354 * cmd->group, cmd->group_as_string, cmd->argv[0].
355 * When we execute "f1() {b;}", we notice that f1 exists,
356 * and that its "parent cmd" struct is still "alive",
357 * we put those fields back into cmd->xxx
358 * (struct function has ->parent_cmd ptr to facilitate that).
359 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
360 * Without this trick, loop would execute a;b;b;b;...
361 * instead of correct sequence a;b;a;b;...
362 * When command is freed, it severs the link
363 * (sets ->child_func->parent_cmd to NULL).
366 char **argv; /* command name and arguments */
367 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
368 * and on execution these are substituted with their values.
369 * Substitution can make _several_ words out of one argv[n]!
370 * Example: argv[0]=='.^C*^C.' here: echo .$*.
371 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
373 struct redir_struct *redirects; /* I/O redirections */
375 /* Is there anything in this command at all? */
376 #define IS_NULL_CMD(cmd) \
377 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
382 int num_cmds; /* total number of commands in pipe */
383 int alive_cmds; /* number of commands running (not exited) */
384 int stopped_cmds; /* number of commands alive, but stopped */
386 int jobid; /* job number */
387 pid_t pgrp; /* process group ID for the job */
388 char *cmdtext; /* name of job */
390 struct command *cmds; /* array of commands in pipe */
391 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
392 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
393 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
395 typedef enum pipe_style {
401 /* Is there anything in this pipe at all? */
402 #define IS_NULL_PIPE(pi) \
403 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
405 /* This holds pointers to the various results of parsing */
406 struct parse_context {
407 /* linked list of pipes */
408 struct pipe *list_head;
409 /* last pipe (being constructed right now) */
411 /* last command in pipe (being constructed right now) */
412 struct command *command;
413 /* last redirect in command->redirects list */
414 struct redir_struct *pending_redirect;
420 smallint ctx_inverted; /* "! cmd | cmd" */
422 smallint ctx_dsemicolon; /* ";;" seen */
424 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
426 /* group we are enclosed in:
427 * example: "if pipe1; pipe2; then pipe3; fi"
428 * when we see "if" or "then", we malloc and copy current context,
429 * and make ->stack point to it. then we parse pipeN.
430 * when closing "then" / fi" / whatever is found,
431 * we move list_head into ->stack->command->group,
432 * copy ->stack into current context, and delete ->stack.
433 * (parsing of { list } and ( list ) doesn't use this method)
435 struct parse_context *stack;
439 /* On program start, environ points to initial environment.
440 * putenv adds new pointers into it, unsetenv removes them.
441 * Neither of these (de)allocates the strings.
442 * setenv allocates new strings in malloc space and does putenv,
443 * and thus setenv is unusable (leaky) for shell's purposes */
444 #define setenv(...) setenv_is_leaky_dont_use()
446 struct variable *next;
447 char *varstr; /* points to "name=" portion */
448 #if ENABLE_HUSH_LOCAL
449 unsigned func_nest_level;
451 int max_len; /* if > 0, name is part of initial env; else name is malloced */
452 smallint flg_export; /* putenv should be done on this var */
453 smallint flg_read_only;
461 #if ENABLE_HUSH_FUNCTIONS
463 struct function *next;
465 struct command *parent_cmd;
468 char *body_as_string;
474 /* "Globals" within this file */
475 /* Sorted roughly by size (smaller offsets == smaller code) */
477 /* interactive_fd != 0 means we are an interactive shell.
478 * If we are, then saved_tty_pgrp can also be != 0, meaning
479 * that controlling tty is available. With saved_tty_pgrp == 0,
480 * job control still works, but terminal signals
481 * (^C, ^Z, ^Y, ^\) won't work at all, and background
482 * process groups can only be created with "cmd &".
483 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
484 * to give tty to the foreground process group,
485 * and will take it back when the group is stopped (^Z)
488 #if ENABLE_HUSH_INTERACTIVE
489 /* 'interactive_fd' is a fd# open to ctty, if we have one
490 * _AND_ if we decided to act interactively */
494 # define G_interactive_fd (G.interactive_fd)
496 # define G_interactive_fd 0
498 #if ENABLE_FEATURE_EDITING
499 line_input_t *line_input_state;
504 #if ENABLE_HUSH_RANDOM_SUPPORT
510 pid_t saved_tty_pgrp;
511 struct pipe *job_list;
512 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
514 # define G_saved_tty_pgrp 0
516 smallint flag_SIGINT;
517 #if ENABLE_HUSH_LOOPS
518 smallint flag_break_continue;
520 #if ENABLE_HUSH_FUNCTIONS
521 /* 0: outside of a function (or sourced file)
522 * -1: inside of a function, ok to use return builtin
523 * 1: return is invoked, skip all till end of func
525 smallint flag_return_in_progress;
528 smallint exiting; /* used to prevent EXIT trap recursion */
529 /* These four support $?, $#, and $1 */
530 smalluint last_exitcode;
531 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
532 smalluint global_args_malloced;
533 smalluint inherited_set_is_saved;
534 /* how many non-NULL argv's we have. NB: $# + 1 */
538 char *argv0_for_re_execing;
540 #if ENABLE_HUSH_LOOPS
541 unsigned depth_break_continue;
542 unsigned depth_of_loop;
546 struct variable *top_var; /* = &G.shell_ver (set in main()) */
547 struct variable shell_ver;
548 #if ENABLE_HUSH_FUNCTIONS
549 struct function *top_func;
550 # if ENABLE_HUSH_LOCAL
551 struct variable **shadowed_vars_pp;
552 unsigned func_nest_level;
555 /* Signal and trap handling */
557 unsigned count_SIGCHLD;
558 unsigned handled_SIGCHLD;
559 smallint we_have_children;
561 /* which signals have non-DFL handler (even with no traps set)? */
562 unsigned non_DFL_mask;
563 char **traps; /* char *traps[NSIG] */
564 sigset_t blocked_set;
565 sigset_t inherited_set;
567 unsigned long memleak_value;
570 char user_input_buf[ENABLE_FEATURE_EDITING ? CONFIG_FEATURE_EDITING_MAX_LEN : 2];
572 #define G (*ptr_to_globals)
573 /* Not #defining name to G.name - this quickly gets unwieldy
574 * (too many defines). Also, I actually prefer to see when a variable
575 * is global, thus "G." prefix is a useful hint */
576 #define INIT_G() do { \
577 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
581 /* Function prototypes for builtins */
582 static int builtin_cd(char **argv) FAST_FUNC;
583 static int builtin_echo(char **argv) FAST_FUNC;
584 static int builtin_eval(char **argv) FAST_FUNC;
585 static int builtin_exec(char **argv) FAST_FUNC;
586 static int builtin_exit(char **argv) FAST_FUNC;
587 static int builtin_export(char **argv) FAST_FUNC;
589 static int builtin_fg_bg(char **argv) FAST_FUNC;
590 static int builtin_jobs(char **argv) FAST_FUNC;
593 static int builtin_help(char **argv) FAST_FUNC;
595 #if ENABLE_HUSH_LOCAL
596 static int builtin_local(char **argv) FAST_FUNC;
599 static int builtin_memleak(char **argv) FAST_FUNC;
602 static int builtin_printf(char **argv) FAST_FUNC;
604 static int builtin_pwd(char **argv) FAST_FUNC;
605 static int builtin_read(char **argv) FAST_FUNC;
606 static int builtin_set(char **argv) FAST_FUNC;
607 static int builtin_shift(char **argv) FAST_FUNC;
608 static int builtin_source(char **argv) FAST_FUNC;
609 static int builtin_test(char **argv) FAST_FUNC;
610 static int builtin_trap(char **argv) FAST_FUNC;
611 static int builtin_type(char **argv) FAST_FUNC;
612 static int builtin_true(char **argv) FAST_FUNC;
613 static int builtin_umask(char **argv) FAST_FUNC;
614 static int builtin_unset(char **argv) FAST_FUNC;
615 static int builtin_wait(char **argv) FAST_FUNC;
616 #if ENABLE_HUSH_LOOPS
617 static int builtin_break(char **argv) FAST_FUNC;
618 static int builtin_continue(char **argv) FAST_FUNC;
620 #if ENABLE_HUSH_FUNCTIONS
621 static int builtin_return(char **argv) FAST_FUNC;
624 /* Table of built-in functions. They can be forked or not, depending on
625 * context: within pipes, they fork. As simple commands, they do not.
626 * When used in non-forking context, they can change global variables
627 * in the parent shell process. If forked, of course they cannot.
628 * For example, 'unset foo | whatever' will parse and run, but foo will
629 * still be set at the end. */
630 struct built_in_command {
632 int (*b_function)(char **argv) FAST_FUNC;
635 # define BLTIN(cmd, func, help) { cmd, func, help }
637 # define BLTIN(cmd, func, help) { cmd, func }
641 static const struct built_in_command bltins1[] = {
642 BLTIN("." , builtin_source , "Run commands in a file"),
643 BLTIN(":" , builtin_true , NULL),
645 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
647 #if ENABLE_HUSH_LOOPS
648 BLTIN("break" , builtin_break , "Exit from a loop"),
650 BLTIN("cd" , builtin_cd , "Change directory"),
651 #if ENABLE_HUSH_LOOPS
652 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
654 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
655 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
656 BLTIN("exit" , builtin_exit , "Exit"),
657 BLTIN("export" , builtin_export , "Set environment variables"),
659 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
662 BLTIN("help" , builtin_help , NULL),
665 BLTIN("jobs" , builtin_jobs , "List jobs"),
667 #if ENABLE_HUSH_LOCAL
668 BLTIN("local" , builtin_local , "Set local variables"),
671 BLTIN("memleak" , builtin_memleak , NULL),
673 BLTIN("read" , builtin_read , "Input into variable"),
674 #if ENABLE_HUSH_FUNCTIONS
675 BLTIN("return" , builtin_return , "Return from a function"),
677 BLTIN("set" , builtin_set , "Set/unset positional parameters"),
678 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
679 #if ENABLE_HUSH_BASH_COMPAT
680 BLTIN("source" , builtin_source , "Run commands in a file"),
682 BLTIN("trap" , builtin_trap , "Trap signals"),
683 BLTIN("type" , builtin_type , "Show command type"),
684 BLTIN("ulimit" , shell_builtin_ulimit , "Control resource limits"),
685 BLTIN("umask" , builtin_umask , "Set file creation mask"),
686 BLTIN("unset" , builtin_unset , "Unset variables"),
687 BLTIN("wait" , builtin_wait , "Wait for process"),
689 /* For now, echo and test are unconditionally enabled.
690 * Maybe make it configurable? */
691 static const struct built_in_command bltins2[] = {
692 BLTIN("[" , builtin_test , NULL),
693 BLTIN("echo" , builtin_echo , NULL),
695 BLTIN("printf" , builtin_printf , NULL),
697 BLTIN("pwd" , builtin_pwd , NULL),
698 BLTIN("test" , builtin_test , NULL),
705 /* prevent disasters with G.debug_indent < 0 */
706 # define indent() fprintf(stderr, "%*s", (G.debug_indent * 2) & 0xff, "")
707 # define debug_enter() (G.debug_indent++)
708 # define debug_leave() (G.debug_indent--)
710 # define indent() ((void)0)
711 # define debug_enter() ((void)0)
712 # define debug_leave() ((void)0)
716 # define debug_printf(...) (indent(), fprintf(stderr, __VA_ARGS__))
719 #ifndef debug_printf_parse
720 # define debug_printf_parse(...) (indent(), fprintf(stderr, __VA_ARGS__))
723 #ifndef debug_printf_exec
724 #define debug_printf_exec(...) (indent(), fprintf(stderr, __VA_ARGS__))
727 #ifndef debug_printf_env
728 # define debug_printf_env(...) (indent(), fprintf(stderr, __VA_ARGS__))
731 #ifndef debug_printf_jobs
732 # define debug_printf_jobs(...) (indent(), fprintf(stderr, __VA_ARGS__))
733 # define DEBUG_JOBS 1
735 # define DEBUG_JOBS 0
738 #ifndef debug_printf_expand
739 # define debug_printf_expand(...) (indent(), fprintf(stderr, __VA_ARGS__))
740 # define DEBUG_EXPAND 1
742 # define DEBUG_EXPAND 0
745 #ifndef debug_printf_glob
746 # define debug_printf_glob(...) (indent(), fprintf(stderr, __VA_ARGS__))
747 # define DEBUG_GLOB 1
749 # define DEBUG_GLOB 0
752 #ifndef debug_printf_list
753 # define debug_printf_list(...) (indent(), fprintf(stderr, __VA_ARGS__))
756 #ifndef debug_printf_subst
757 # define debug_printf_subst(...) (indent(), fprintf(stderr, __VA_ARGS__))
760 #ifndef debug_printf_clean
761 # define debug_printf_clean(...) (indent(), fprintf(stderr, __VA_ARGS__))
762 # define DEBUG_CLEAN 1
764 # define DEBUG_CLEAN 0
768 static void debug_print_strings(const char *prefix, char **vv)
771 fprintf(stderr, "%s:\n", prefix);
773 fprintf(stderr, " '%s'\n", *vv++);
776 # define debug_print_strings(prefix, vv) ((void)0)
780 /* Leak hunting. Use hush_leaktool.sh for post-processing.
783 static void *xxmalloc(int lineno, size_t size)
785 void *ptr = xmalloc((size + 0xff) & ~0xff);
786 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
789 static void *xxrealloc(int lineno, void *ptr, size_t size)
791 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
792 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
795 static char *xxstrdup(int lineno, const char *str)
797 char *ptr = xstrdup(str);
798 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
801 static void xxfree(void *ptr)
803 fdprintf(2, "free %p\n", ptr);
806 #define xmalloc(s) xxmalloc(__LINE__, s)
807 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
808 #define xstrdup(s) xxstrdup(__LINE__, s)
809 #define free(p) xxfree(p)
813 /* Syntax and runtime errors. They always abort scripts.
814 * In interactive use they usually discard unparsed and/or unexecuted commands
815 * and return to the prompt.
816 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
819 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
820 # define syntax_error(lineno, msg) syntax_error(msg)
821 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
822 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
823 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
824 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
827 static void die_if_script(unsigned lineno, const char *fmt, ...)
832 bb_error_msg("hush.c:%u", lineno);
835 bb_verror_msg(fmt, p, NULL);
837 if (!G_interactive_fd)
841 static void syntax_error(unsigned lineno, const char *msg)
844 die_if_script(lineno, "syntax error: %s", msg);
846 die_if_script(lineno, "syntax error", NULL);
849 static void syntax_error_at(unsigned lineno, const char *msg)
851 die_if_script(lineno, "syntax error at '%s'", msg);
854 static void syntax_error_unterm_str(unsigned lineno, const char *s)
856 die_if_script(lineno, "syntax error: unterminated %s", s);
859 /* It so happens that all such cases are totally fatal
860 * even if shell is interactive: EOF while looking for closing
861 * delimiter. There is nowhere to read stuff from after that,
862 * it's EOF! The only choice is to terminate.
864 static void syntax_error_unterm_ch(unsigned lineno, char ch) NORETURN;
865 static void syntax_error_unterm_ch(unsigned lineno, char ch)
867 char msg[2] = { ch, '\0' };
868 syntax_error_unterm_str(lineno, msg);
872 static void syntax_error_unexpected_ch(unsigned lineno, int ch)
877 die_if_script(lineno, "syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
881 # undef die_if_script
883 # undef syntax_error_at
884 # undef syntax_error_unterm_ch
885 # undef syntax_error_unterm_str
886 # undef syntax_error_unexpected_ch
888 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
889 # define syntax_error(msg) syntax_error(__LINE__, msg)
890 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
891 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
892 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
893 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
897 #if ENABLE_HUSH_INTERACTIVE
898 static void cmdedit_update_prompt(void);
900 # define cmdedit_update_prompt() ((void)0)
906 /* Replace each \x with x in place, return ptr past NUL. */
907 static char *unbackslash(char *src)
909 char *dst = src = strchrnul(src, '\\');
913 if ((*dst++ = *src++) == '\0')
919 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
940 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
941 v[count1 + count2] = NULL;
944 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
948 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
950 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
951 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
954 #define add_strings_to_strings(strings, add, need_to_dup) \
955 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
958 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
959 static char **add_string_to_strings(char **strings, char *add)
964 return add_strings_to_strings(strings, v, /*dup:*/ 0);
967 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
969 char **ptr = add_string_to_strings(strings, add);
970 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
973 #define add_string_to_strings(strings, add) \
974 xx_add_string_to_strings(__LINE__, strings, add)
977 static void free_strings(char **strings)
992 /* Helpers for setting new $n and restoring them back
994 typedef struct save_arg_t {
998 smallint sv_g_malloced;
1001 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1005 sv->sv_argv0 = argv[0];
1006 sv->sv_g_argv = G.global_argv;
1007 sv->sv_g_argc = G.global_argc;
1008 sv->sv_g_malloced = G.global_args_malloced;
1010 argv[0] = G.global_argv[0]; /* retain $0 */
1011 G.global_argv = argv;
1012 G.global_args_malloced = 0;
1020 static void restore_G_args(save_arg_t *sv, char **argv)
1024 if (G.global_args_malloced) {
1025 /* someone ran "set -- arg1 arg2 ...", undo */
1027 while (*++pp) /* note: does not free $0 */
1029 free(G.global_argv);
1031 argv[0] = sv->sv_argv0;
1032 G.global_argv = sv->sv_g_argv;
1033 G.global_argc = sv->sv_g_argc;
1034 G.global_args_malloced = sv->sv_g_malloced;
1038 /* Basic theory of signal handling in shell
1039 * ========================================
1040 * This does not describe what hush does, rather, it is current understanding
1041 * what it _should_ do. If it doesn't, it's a bug.
1042 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1044 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1045 * is finished or backgrounded. It is the same in interactive and
1046 * non-interactive shells, and is the same regardless of whether
1047 * a user trap handler is installed or a shell special one is in effect.
1048 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1049 * backgrounds (i.e. stops) or kills all members of currently running
1052 * Wait builtin in interruptible by signals for which user trap is set
1053 * or by SIGINT in interactive shell.
1055 * Trap handlers will execute even within trap handlers. (right?)
1057 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1058 * except for handlers set to '' (empty string).
1060 * If job control is off, backgrounded commands ("cmd &")
1061 * have SIGINT, SIGQUIT set to SIG_IGN.
1063 * Commands which are run in command substitution ("`cmd`")
1064 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1066 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1067 * by the shell from its parent.
1069 * Signals which differ from SIG_DFL action
1070 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1073 * SIGTERM (interactive): ignore
1074 * SIGHUP (interactive):
1075 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1076 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1077 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1078 * that all pipe members are stopped. Try this in bash:
1079 * while :; do :; done - ^Z does not background it
1080 * (while :; do :; done) - ^Z backgrounds it
1081 * SIGINT (interactive): wait for last pipe, ignore the rest
1082 * of the command line, show prompt. NB: ^C does not send SIGINT
1083 * to interactive shell while shell is waiting for a pipe,
1084 * since shell is bg'ed (is not in foreground process group).
1085 * Example 1: this waits 5 sec, but does not execute ls:
1086 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1087 * Example 2: this does not wait and does not execute ls:
1088 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1089 * Example 3: this does not wait 5 sec, but executes ls:
1090 * "sleep 5; ls -l" + press ^C
1092 * (What happens to signals which are IGN on shell start?)
1093 * (What happens with signal mask on shell start?)
1095 * Implementation in hush
1096 * ======================
1097 * We use in-kernel pending signal mask to determine which signals were sent.
1098 * We block all signals which we don't want to take action immediately,
1099 * i.e. we block all signals which need to have special handling as described
1100 * above, and all signals which have traps set.
1101 * After each pipe execution, we extract any pending signals via sigtimedwait()
1104 * unsigned non_DFL_mask: a mask of such "special" signals
1105 * sigset_t blocked_set: current blocked signal set
1108 * clear bit in blocked_set unless it is also in non_DFL_mask
1109 * "trap 'cmd' SIGxxx":
1110 * set bit in blocked_set (even if 'cmd' is '')
1111 * after [v]fork, if we plan to be a shell:
1112 * unblock signals with special interactive handling
1113 * (child shell is not interactive),
1114 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1115 * after [v]fork, if we plan to exec:
1116 * POSIX says fork clears pending signal mask in child - no need to clear it.
1117 * Restore blocked signal set to one inherited by shell just prior to exec.
1119 * Note: as a result, we do not use signal handlers much. The only uses
1120 * are to count SIGCHLDs
1121 * and to restore tty pgrp on signal-induced exit.
1124 * Standard says "When a subshell is entered, traps that are not being ignored
1125 * are set to the default actions". bash interprets it so that traps which
1126 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1129 SPECIAL_INTERACTIVE_SIGS = 0
1134 SPECIAL_JOB_SIGS = 0
1142 #if ENABLE_HUSH_FAST
1143 static void SIGCHLD_handler(int sig UNUSED_PARAM)
1146 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1152 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1153 #define disable_restore_tty_pgrp_on_exit() (die_sleep = 0)
1154 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1155 #define enable_restore_tty_pgrp_on_exit() (die_sleep = -1)
1157 /* Restores tty foreground process group, and exits.
1158 * May be called as signal handler for fatal signal
1159 * (will resend signal to itself, producing correct exit state)
1160 * or called directly with -EXITCODE.
1161 * We also call it if xfunc is exiting. */
1162 static void sigexit(int sig) NORETURN;
1163 static void sigexit(int sig)
1165 /* Disable all signals: job control, SIGPIPE, etc. */
1166 sigprocmask_allsigs(SIG_BLOCK);
1168 /* Careful: we can end up here after [v]fork. Do not restore
1169 * tty pgrp then, only top-level shell process does that */
1170 if (G_saved_tty_pgrp && getpid() == G.root_pid)
1171 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1173 /* Not a signal, just exit */
1177 kill_myself_with_sig(sig); /* does not return */
1181 #define disable_restore_tty_pgrp_on_exit() ((void)0)
1182 #define enable_restore_tty_pgrp_on_exit() ((void)0)
1186 /* Restores tty foreground process group, and exits. */
1187 static void hush_exit(int exitcode) NORETURN;
1188 static void hush_exit(int exitcode)
1190 if (G.exiting <= 0 && G.traps && G.traps[0] && G.traps[0][0]) {
1191 /* Prevent recursion:
1192 * trap "echo Hi; exit" EXIT; exit
1194 char *argv[] = { NULL, G.traps[0], NULL };
1203 sigexit(- (exitcode & 0xff));
1209 static int check_and_run_traps(int sig)
1211 static const struct timespec zero_timespec = { 0, 0 };
1212 smalluint save_rcode;
1218 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
1223 if (G.traps && G.traps[sig]) {
1224 if (G.traps[sig][0]) {
1225 /* We have user-defined handler */
1226 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
1227 save_rcode = G.last_exitcode;
1230 G.last_exitcode = save_rcode;
1231 } /* else: "" trap, ignoring signal */
1234 /* not a trap: special action */
1236 #if ENABLE_HUSH_FAST
1239 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1243 /* Builtin was ^C'ed, make it look prettier: */
1250 /* bash is observed to signal whole process groups,
1251 * not individual processes */
1252 for (job = G.job_list; job; job = job->next) {
1255 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
1256 if (kill(- job->pgrp, SIGHUP) == 0)
1257 kill(- job->pgrp, SIGCONT);
1262 default: /* ignored: */
1263 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1271 static const char *get_cwd(int force)
1273 if (force || G.cwd == NULL) {
1274 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1275 * we must not try to free(bb_msg_unknown) */
1276 if (G.cwd == bb_msg_unknown)
1278 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1280 G.cwd = bb_msg_unknown;
1287 * Shell and environment variable support
1289 static struct variable **get_ptr_to_local_var(const char *name)
1291 struct variable **pp;
1292 struct variable *cur;
1297 while ((cur = *pp) != NULL) {
1298 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1305 static struct variable *get_local_var(const char *name)
1307 struct variable **pp = get_ptr_to_local_var(name);
1313 static const char* FAST_FUNC get_local_var_value(const char *name)
1315 struct variable **pp = get_ptr_to_local_var(name);
1317 return strchr((*pp)->varstr, '=') + 1;
1318 if (strcmp(name, "PPID") == 0)
1319 return utoa(G.root_ppid);
1320 // bash compat: UID? EUID?
1321 #if ENABLE_HUSH_RANDOM_SUPPORT
1322 if (strcmp(name, "RANDOM") == 0) {
1323 return utoa(next_random(&G.random_gen));
1329 /* str holds "NAME=VAL" and is expected to be malloced.
1330 * We take ownership of it.
1332 * 0: do not change export flag
1333 * (if creating new variable, flag will be 0)
1334 * 1: set export flag and putenv the variable
1335 * -1: clear export flag and unsetenv the variable
1336 * flg_read_only is set only when we handle -R var=val
1338 #if !BB_MMU && ENABLE_HUSH_LOCAL
1339 /* all params are used */
1340 #elif BB_MMU && ENABLE_HUSH_LOCAL
1341 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1342 set_local_var(str, flg_export, local_lvl)
1343 #elif BB_MMU && !ENABLE_HUSH_LOCAL
1344 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1345 set_local_var(str, flg_export)
1346 #elif !BB_MMU && !ENABLE_HUSH_LOCAL
1347 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1348 set_local_var(str, flg_export, flg_read_only)
1350 static int set_local_var(char *str, int flg_export, int local_lvl, int flg_read_only)
1352 struct variable **var_pp;
1353 struct variable *cur;
1357 eq_sign = strchr(str, '=');
1358 if (!eq_sign) { /* not expected to ever happen? */
1363 name_len = eq_sign - str + 1; /* including '=' */
1364 var_pp = &G.top_var;
1365 while ((cur = *var_pp) != NULL) {
1366 if (strncmp(cur->varstr, str, name_len) != 0) {
1367 var_pp = &cur->next;
1370 /* We found an existing var with this name */
1371 if (cur->flg_read_only) {
1375 bb_error_msg("%s: readonly variable", str);
1379 if (flg_export == -1) { // "&& cur->flg_export" ?
1380 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1385 #if ENABLE_HUSH_LOCAL
1386 if (cur->func_nest_level < local_lvl) {
1387 /* New variable is declared as local,
1388 * and existing one is global, or local
1389 * from enclosing function.
1390 * Remove and save old one: */
1391 *var_pp = cur->next;
1392 cur->next = *G.shadowed_vars_pp;
1393 *G.shadowed_vars_pp = cur;
1394 /* bash 3.2.33(1) and exported vars:
1396 * # f() { local z=a; env | grep ^z; }
1402 if (cur->flg_export)
1407 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
1412 if (cur->max_len != 0) {
1413 if (cur->max_len >= strlen(str)) {
1414 /* This one is from startup env, reuse space */
1415 strcpy(cur->varstr, str);
1419 /* max_len == 0 signifies "malloced" var, which we can
1420 * (and has to) free */
1424 goto set_str_and_exp;
1427 /* Not found - create new variable struct */
1428 cur = xzalloc(sizeof(*cur));
1429 #if ENABLE_HUSH_LOCAL
1430 cur->func_nest_level = local_lvl;
1432 cur->next = *var_pp;
1438 cur->flg_read_only = flg_read_only;
1441 if (flg_export == 1)
1442 cur->flg_export = 1;
1443 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1444 cmdedit_update_prompt();
1445 if (cur->flg_export) {
1446 if (flg_export == -1) {
1447 cur->flg_export = 0;
1448 /* unsetenv was already done */
1450 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1451 return putenv(cur->varstr);
1457 /* Used at startup and after each cd */
1458 static void set_pwd_var(int exp)
1460 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)),
1461 /*exp:*/ exp, /*lvl:*/ 0, /*ro:*/ 0);
1464 static int unset_local_var_len(const char *name, int name_len)
1466 struct variable *cur;
1467 struct variable **var_pp;
1470 return EXIT_SUCCESS;
1471 var_pp = &G.top_var;
1472 while ((cur = *var_pp) != NULL) {
1473 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1474 if (cur->flg_read_only) {
1475 bb_error_msg("%s: readonly variable", name);
1476 return EXIT_FAILURE;
1478 *var_pp = cur->next;
1479 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1480 bb_unsetenv(cur->varstr);
1481 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1482 cmdedit_update_prompt();
1486 return EXIT_SUCCESS;
1488 var_pp = &cur->next;
1490 return EXIT_SUCCESS;
1493 static int unset_local_var(const char *name)
1495 return unset_local_var_len(name, strlen(name));
1498 static void unset_vars(char **strings)
1506 const char *eq = strchrnul(*v, '=');
1507 unset_local_var_len(*v, (int)(eq - *v));
1513 #if ENABLE_SH_MATH_SUPPORT
1514 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1515 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1516 static char* FAST_FUNC endofname(const char *name)
1524 if (!is_in_name(*p))
1531 static void FAST_FUNC set_local_var_from_halves(const char *name, const char *val)
1533 char *var = xasprintf("%s=%s", name, val);
1534 set_local_var(var, /*flags:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
1539 * Helpers for "var1=val1 var2=val2 cmd" feature
1541 static void add_vars(struct variable *var)
1543 struct variable *next;
1547 var->next = G.top_var;
1549 if (var->flg_export) {
1550 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
1551 putenv(var->varstr);
1553 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
1559 static struct variable *set_vars_and_save_old(char **strings)
1562 struct variable *old = NULL;
1568 struct variable *var_p;
1569 struct variable **var_pp;
1572 eq = strchr(*s, '=');
1575 var_pp = get_ptr_to_local_var(*s);
1578 /* Remove variable from global linked list */
1580 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
1581 *var_pp = var_p->next;
1582 /* Add it to returned list */
1586 set_local_var(*s, /*exp:*/ 1, /*lvl:*/ 0, /*ro:*/ 0);
1597 static int FAST_FUNC static_get(struct in_str *i)
1606 static int FAST_FUNC static_peek(struct in_str *i)
1611 #if ENABLE_HUSH_INTERACTIVE
1613 static void cmdedit_update_prompt(void)
1615 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1616 G.PS1 = get_local_var_value("PS1");
1619 G.PS2 = get_local_var_value("PS2");
1627 static const char* setup_prompt_string(int promptmode)
1629 const char *prompt_str;
1630 debug_printf("setup_prompt_string %d ", promptmode);
1631 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1632 /* Set up the prompt */
1633 if (promptmode == 0) { /* PS1 */
1635 /* bash uses $PWD value, even if it is set by user.
1636 * It uses current dir only if PWD is unset.
1637 * We always use current dir. */
1638 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
1643 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1644 debug_printf("result '%s'\n", prompt_str);
1648 static void get_user_input(struct in_str *i)
1651 const char *prompt_str;
1653 prompt_str = setup_prompt_string(i->promptmode);
1654 #if ENABLE_FEATURE_EDITING
1655 /* Enable command line editing only while a command line
1656 * is actually being read */
1659 /* buglet: SIGINT will not make new prompt to appear _at once_,
1660 * only after <Enter>. (^C will work) */
1661 r = read_line_input(prompt_str, G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1, G.line_input_state);
1662 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1663 check_and_run_traps(0);
1664 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1665 i->eof_flag = (r < 0);
1666 if (i->eof_flag) { /* EOF/error detected */
1667 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1668 G.user_input_buf[1] = '\0';
1673 fputs(prompt_str, stdout);
1675 G.user_input_buf[0] = r = fgetc(i->file);
1676 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1677 //do we need check_and_run_traps(0)? (maybe only if stdin)
1678 } while (G.flag_SIGINT);
1679 i->eof_flag = (r == EOF);
1681 i->p = G.user_input_buf;
1684 #endif /* INTERACTIVE */
1686 /* This is the magic location that prints prompts
1687 * and gets data back from the user */
1688 static int FAST_FUNC file_get(struct in_str *i)
1692 /* If there is data waiting, eat it up */
1693 if (i->p && *i->p) {
1694 #if ENABLE_HUSH_INTERACTIVE
1698 if (i->eof_flag && !*i->p)
1700 /* note: ch is never NUL */
1702 /* need to double check i->file because we might be doing something
1703 * more complicated by now, like sourcing or substituting. */
1704 #if ENABLE_HUSH_INTERACTIVE
1705 if (G_interactive_fd && i->promptme && i->file == stdin) {
1708 } while (!*i->p); /* need non-empty line */
1709 i->promptmode = 1; /* PS2 */
1714 do ch = fgetc(i->file); while (ch == '\0');
1716 debug_printf("file_get: got '%c' %d\n", ch, ch);
1717 #if ENABLE_HUSH_INTERACTIVE
1724 /* All callers guarantee this routine will never
1725 * be used right after a newline, so prompting is not needed.
1727 static int FAST_FUNC file_peek(struct in_str *i)
1730 if (i->p && *i->p) {
1731 if (i->eof_flag && !i->p[1])
1734 /* note: ch is never NUL */
1736 do ch = fgetc(i->file); while (ch == '\0');
1737 i->eof_flag = (ch == EOF);
1738 i->peek_buf[0] = ch;
1739 i->peek_buf[1] = '\0';
1741 debug_printf("file_peek: got '%c' %d\n", ch, ch);
1745 static void setup_file_in_str(struct in_str *i, FILE *f)
1747 i->peek = file_peek;
1749 #if ENABLE_HUSH_INTERACTIVE
1751 i->promptmode = 0; /* PS1 */
1757 static void setup_string_in_str(struct in_str *i, const char *s)
1759 i->peek = static_peek;
1760 i->get = static_get;
1761 #if ENABLE_HUSH_INTERACTIVE
1763 i->promptmode = 0; /* PS1 */
1773 #define B_CHUNK (32 * sizeof(char*))
1775 static void o_reset_to_empty_unquoted(o_string *o)
1783 static void o_free(o_string *o)
1786 memset(o, 0, sizeof(*o));
1789 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1794 static void o_grow_by(o_string *o, int len)
1796 if (o->length + len > o->maxlen) {
1797 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1798 o->data = xrealloc(o->data, 1 + o->maxlen);
1802 static void o_addchr(o_string *o, int ch)
1804 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1806 o->data[o->length] = ch;
1808 o->data[o->length] = '\0';
1811 static void o_addblock(o_string *o, const char *str, int len)
1814 memcpy(&o->data[o->length], str, len);
1816 o->data[o->length] = '\0';
1820 static void o_addstr(o_string *o, const char *str)
1822 o_addblock(o, str, strlen(str));
1824 static void nommu_addchr(o_string *o, int ch)
1830 # define nommu_addchr(o, str) ((void)0)
1833 static void o_addstr_with_NUL(o_string *o, const char *str)
1835 o_addblock(o, str, strlen(str) + 1);
1838 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
1843 && (*str != '*' && *str != '?' && *str != '[')
1851 #undef HUSH_BRACE_EXP
1853 * HUSH_BRACE_EXP code needs corresponding quoting on variable expansion side.
1854 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
1855 * Apparently, on unquoted $v bash still does globbing
1856 * ("v='*.txt'; echo $v" prints all .txt files),
1857 * but NOT brace expansion! Thus, there should be TWO independent
1858 * quoting mechanisms on $v expansion side: one protects
1859 * $v from brace expansion, and other additionally protects "$v" against globbing.
1860 * We have only second one.
1863 #ifdef HUSH_BRACE_EXP
1864 # define MAYBE_BRACES "{}"
1866 # define MAYBE_BRACES ""
1869 /* My analysis of quoting semantics tells me that state information
1870 * is associated with a destination, not a source.
1872 static void o_addqchr(o_string *o, int ch)
1875 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
1880 o->data[o->length] = '\\';
1883 o->data[o->length] = ch;
1885 o->data[o->length] = '\0';
1888 static void o_addQchr(o_string *o, int ch)
1891 if (o->o_escape && strchr("*?[\\" MAYBE_BRACES, ch)) {
1893 o->data[o->length] = '\\';
1897 o->data[o->length] = ch;
1899 o->data[o->length] = '\0';
1902 static void o_addQstr(o_string *o, const char *str, int len)
1905 o_addblock(o, str, len);
1911 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
1912 if (ordinary_cnt > len) /* paranoia */
1914 o_addblock(o, str, ordinary_cnt);
1915 if (ordinary_cnt == len)
1917 str += ordinary_cnt;
1918 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1922 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
1924 o->data[o->length] = '\\';
1928 o->data[o->length] = ch;
1930 o->data[o->length] = '\0';
1934 /* A special kind of o_string for $VAR and `cmd` expansion.
1935 * It contains char* list[] at the beginning, which is grown in 16 element
1936 * increments. Actual string data starts at the next multiple of 16 * (char*).
1937 * list[i] contains an INDEX (int!) into this string data.
1938 * It means that if list[] needs to grow, data needs to be moved higher up
1939 * but list[i]'s need not be modified.
1940 * NB: remembering how many list[i]'s you have there is crucial.
1941 * o_finalize_list() operation post-processes this structure - calculates
1942 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1944 #if DEBUG_EXPAND || DEBUG_GLOB
1945 static void debug_print_list(const char *prefix, o_string *o, int n)
1947 char **list = (char**)o->data;
1948 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1952 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1953 prefix, list, n, string_start, o->length, o->maxlen);
1956 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1957 o->data + (int)list[i] + string_start,
1958 o->data + (int)list[i] + string_start);
1962 const char *p = o->data + (int)list[n - 1] + string_start;
1964 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1968 # define debug_print_list(prefix, o, n) ((void)0)
1971 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1972 * in list[n] so that it points past last stored byte so far.
1973 * It returns n+1. */
1974 static int o_save_ptr_helper(o_string *o, int n)
1976 char **list = (char**)o->data;
1980 if (!o->has_empty_slot) {
1981 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1982 string_len = o->length - string_start;
1983 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1984 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1985 /* list[n] points to string_start, make space for 16 more pointers */
1986 o->maxlen += 0x10 * sizeof(list[0]);
1987 o->data = xrealloc(o->data, o->maxlen + 1);
1988 list = (char**)o->data;
1989 memmove(list + n + 0x10, list + n, string_len);
1990 o->length += 0x10 * sizeof(list[0]);
1992 debug_printf_list("list[%d]=%d string_start=%d\n",
1993 n, string_len, string_start);
1996 /* We have empty slot at list[n], reuse without growth */
1997 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1998 string_len = o->length - string_start;
1999 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2000 n, string_len, string_start);
2001 o->has_empty_slot = 0;
2003 list[n] = (char*)(ptrdiff_t)string_len;
2007 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2008 static int o_get_last_ptr(o_string *o, int n)
2010 char **list = (char**)o->data;
2011 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2013 return ((int)(ptrdiff_t)list[n-1]) + string_start;
2016 #ifdef HUSH_BRACE_EXP
2017 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2018 * first, it processes even {a} (no commas), second,
2019 * I didn't manage to make it return strings when they don't match
2020 * existing files. Need to re-implement it.
2024 static int glob_needed(const char *s)
2033 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2039 /* Return pointer to next closing brace or to comma */
2040 static const char *next_brace_sub(const char *cp)
2044 while (*cp != '\0') {
2051 /*{*/ if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2053 if (*cp++ == '{') /*}*/
2057 return *cp != '\0' ? cp : NULL;
2059 /* Recursive brace globber. Note: may garble pattern[]. */
2060 static int glob_brace(char *pattern, o_string *o, int n)
2062 char *new_pattern_buf;
2069 debug_printf_glob("glob_brace('%s')\n", pattern);
2075 if (*begin == '{') /*}*/ {
2076 /* Find the first sub-pattern and at the same time
2077 * find the rest after the closing brace */
2078 next = next_brace_sub(begin);
2080 /* An illegal expression */
2083 /*{*/ if (*next == '}') {
2084 /* "{abc}" with no commas - illegal
2085 * brace expr, disregard and skip it */
2091 if (*begin == '\\' && begin[1] != '\0')
2095 debug_printf_glob("begin:%s\n", begin);
2096 debug_printf_glob("next:%s\n", next);
2098 /* Now find the end of the whole brace expression */
2100 /*{*/ while (*rest != '}') {
2101 rest = next_brace_sub(rest);
2103 /* An illegal expression */
2106 debug_printf_glob("rest:%s\n", rest);
2108 rest_len = strlen(++rest) + 1;
2110 /* We are sure the brace expression is well-formed */
2112 /* Allocate working buffer large enough for our work */
2113 new_pattern_buf = xmalloc(strlen(pattern));
2115 /* We have a brace expression. BEGIN points to the opening {,
2116 * NEXT points past the terminator of the first element, and REST
2117 * points past the final }. We will accumulate result names from
2118 * recursive runs for each brace alternative in the buffer using
2123 /* Construct the new glob expression */
2126 mempcpy(new_pattern_buf,
2127 /* We know the prefix for all sub-patterns */
2128 pattern, begin - pattern),
2132 /* Note: glob_brace() may garble new_pattern_buf[].
2133 * That's why we re-copy prefix every time (1st memcpy above).
2135 n = glob_brace(new_pattern_buf, o, n);
2136 /*{*/ if (*next == '}') {
2137 /* We saw the last entry */
2141 next = next_brace_sub(next);
2143 free(new_pattern_buf);
2151 memset(&globdata, 0, sizeof(globdata));
2152 gr = glob(pattern, 0, NULL, &globdata);
2153 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2155 if (gr == GLOB_NOMATCH) {
2156 globfree(&globdata);
2157 /* NB: garbles parameter */
2158 unbackslash(pattern);
2159 o_addstr_with_NUL(o, pattern);
2160 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2161 return o_save_ptr_helper(o, n);
2163 if (gr == GLOB_NOSPACE)
2164 bb_error_msg_and_die(bb_msg_memory_exhausted);
2165 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2166 * but we didn't specify it. Paranoia again. */
2167 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2169 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2170 char **argv = globdata.gl_pathv;
2172 o_addstr_with_NUL(o, *argv);
2173 n = o_save_ptr_helper(o, n);
2179 globfree(&globdata);
2183 /* Performs globbing on last list[],
2184 * saving each result as a new list[].
2186 static int o_glob(o_string *o, int n)
2188 char *pattern, *copy;
2190 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
2192 return o_save_ptr_helper(o, n);
2193 pattern = o->data + o_get_last_ptr(o, n);
2194 debug_printf_glob("glob pattern '%s'\n", pattern);
2195 if (!glob_needed(pattern)) {
2196 /* unbackslash last string in o in place, fix length */
2197 o->length = unbackslash(pattern) - o->data;
2198 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2199 return o_save_ptr_helper(o, n);
2202 copy = xstrdup(pattern);
2203 /* "forget" pattern in o */
2204 o->length = pattern - o->data;
2205 n = glob_brace(copy, o, n);
2208 debug_print_list("o_glob returning", o, n);
2215 static int glob_needed(const char *s)
2224 if (*s == '*' || *s == '[' || *s == '?')
2230 /* Performs globbing on last list[],
2231 * saving each result as a new list[].
2233 static int o_glob(o_string *o, int n)
2239 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
2241 return o_save_ptr_helper(o, n);
2242 pattern = o->data + o_get_last_ptr(o, n);
2243 debug_printf_glob("glob pattern '%s'\n", pattern);
2244 if (!glob_needed(pattern)) {
2246 /* unbackslash last string in o in place, fix length */
2247 o->length = unbackslash(pattern) - o->data;
2248 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2249 return o_save_ptr_helper(o, n);
2252 memset(&globdata, 0, sizeof(globdata));
2253 /* Can't use GLOB_NOCHECK: it does not unescape the string.
2254 * If we glob "*.\*" and don't find anything, we need
2255 * to fall back to using literal "*.*", but GLOB_NOCHECK
2256 * will return "*.\*"!
2258 gr = glob(pattern, 0, NULL, &globdata);
2259 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2261 if (gr == GLOB_NOMATCH) {
2262 globfree(&globdata);
2265 if (gr == GLOB_NOSPACE)
2266 bb_error_msg_and_die(bb_msg_memory_exhausted);
2267 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2268 * but we didn't specify it. Paranoia again. */
2269 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2271 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2272 char **argv = globdata.gl_pathv;
2273 /* "forget" pattern in o */
2274 o->length = pattern - o->data;
2276 o_addstr_with_NUL(o, *argv);
2277 n = o_save_ptr_helper(o, n);
2283 globfree(&globdata);
2285 debug_print_list("o_glob returning", o, n);
2291 /* If o->o_glob == 1, glob the string so far remembered.
2292 * Otherwise, just finish current list[] and start new */
2293 static int o_save_ptr(o_string *o, int n)
2295 if (o->o_glob) { /* if globbing is requested */
2296 /* If o->has_empty_slot, list[n] was already globbed
2297 * (if it was requested back then when it was filled)
2298 * so don't do that again! */
2299 if (!o->has_empty_slot)
2300 return o_glob(o, n); /* o_save_ptr_helper is inside */
2302 return o_save_ptr_helper(o, n);
2305 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
2306 static char **o_finalize_list(o_string *o, int n)
2311 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
2313 debug_print_list("finalized", o, n);
2314 debug_printf_expand("finalized n:%d\n", n);
2315 list = (char**)o->data;
2316 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2320 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
2326 /* Expansion can recurse */
2327 #if ENABLE_HUSH_TICK
2328 static int process_command_subs(o_string *dest, const char *s);
2330 static char *expand_string_to_string(const char *str);
2332 #define parse_stream_dquoted(as_string, dest, input, dquote_end) \
2333 parse_stream_dquoted(dest, input, dquote_end)
2335 static int parse_stream_dquoted(o_string *as_string,
2337 struct in_str *input,
2340 /* expand_strvec_to_strvec() takes a list of strings, expands
2341 * all variable references within and returns a pointer to
2342 * a list of expanded strings, possibly with larger number
2343 * of strings. (Think VAR="a b"; echo $VAR).
2344 * This new list is allocated as a single malloc block.
2345 * NULL-terminated list of char* pointers is at the beginning of it,
2346 * followed by strings themself.
2347 * Caller can deallocate entire list by single free(list). */
2349 /* Store given string, finalizing the word and starting new one whenever
2350 * we encounter IFS char(s). This is used for expanding variable values.
2351 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
2352 static int expand_on_ifs(o_string *output, int n, const char *str)
2355 int word_len = strcspn(str, G.ifs);
2357 if (output->o_escape || !output->o_glob)
2358 o_addQstr(output, str, word_len);
2359 else /* protect backslashes against globbing up :) */
2360 o_addblock_duplicate_backslash(output, str, word_len);
2363 if (!*str) /* EOL - do not finalize word */
2365 o_addchr(output, '\0');
2366 debug_print_list("expand_on_ifs", output, n);
2367 n = o_save_ptr(output, n);
2368 str += strspn(str, G.ifs); /* skip ifs chars */
2370 debug_print_list("expand_on_ifs[1]", output, n);
2374 /* Helper to expand $((...)) and heredoc body. These act as if
2375 * they are in double quotes, with the exception that they are not :).
2376 * Just the rules are similar: "expand only $var and `cmd`"
2378 * Returns malloced string.
2379 * As an optimization, we return NULL if expansion is not needed.
2381 static char *expand_pseudo_dquoted(const char *str)
2384 struct in_str input;
2385 o_string dest = NULL_O_STRING;
2387 if (strchr(str, '$') == NULL
2388 #if ENABLE_HUSH_TICK
2389 && strchr(str, '`') == NULL
2395 /* We need to expand. Example:
2396 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
2398 setup_string_in_str(&input, str);
2399 parse_stream_dquoted(NULL, &dest, &input, EOF);
2400 //bb_error_msg("'%s' -> '%s'", str, dest.data);
2401 exp_str = expand_string_to_string(dest.data);
2402 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
2403 o_free_unsafe(&dest);
2407 /* Expand all variable references in given string, adding words to list[]
2408 * at n, n+1,... positions. Return updated n (so that list[n] is next one
2409 * to be filled). This routine is extremely tricky: has to deal with
2410 * variables/parameters with whitespace, $* and $@, and constructs like
2411 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
2412 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
2414 /* or_mask is either 0 (normal case) or 0x80 -
2415 * expansion of right-hand side of assignment == 1-element expand.
2416 * It will also do no globbing, and thus we must not backslash-quote!
2423 debug_printf_expand("expand_vars_to_list: arg:'%s' or_mask:%x\n", arg, or_mask);
2424 debug_print_list("expand_vars_to_list", output, n);
2425 n = o_save_ptr(output, n);
2426 debug_print_list("expand_vars_to_list[0]", output, n);
2428 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
2431 char *dyn_val = NULL;
2432 const char *val = NULL;
2433 #if ENABLE_HUSH_TICK
2434 o_string subst_result = NULL_O_STRING;
2436 #if ENABLE_SH_MATH_SUPPORT
2437 char arith_buf[sizeof(arith_t)*3 + 2];
2439 o_addblock(output, arg, p - arg);
2440 debug_print_list("expand_vars_to_list[1]", output, n);
2442 p = strchr(p, SPECIAL_VAR_SYMBOL);
2444 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
2445 /* "$@" is special. Even if quoted, it can still
2446 * expand to nothing (not even an empty string) */
2447 if ((first_ch & 0x7f) != '@')
2448 ored_ch |= first_ch;
2450 switch (first_ch & 0x7f) {
2451 /* Highest bit in first_ch indicates that var is double-quoted */
2453 val = utoa(G.root_pid);
2455 case '!': /* bg pid */
2456 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
2458 case '?': /* exitcode */
2459 val = utoa(G.last_exitcode);
2461 case '#': /* argc */
2462 if (arg[1] != SPECIAL_VAR_SYMBOL)
2463 /* actually, it's a ${#var} */
2465 val = utoa(G.global_argc ? G.global_argc-1 : 0);
2470 if (!G.global_argv[i])
2472 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
2473 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
2474 smallint sv = output->o_escape;
2475 /* unquoted var's contents should be globbed, so don't escape */
2476 output->o_escape = 0;
2477 while (G.global_argv[i]) {
2478 n = expand_on_ifs(output, n, G.global_argv[i]);
2479 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
2480 if (G.global_argv[i++][0] && G.global_argv[i]) {
2481 /* this argv[] is not empty and not last:
2482 * put terminating NUL, start new word */
2483 o_addchr(output, '\0');
2484 debug_print_list("expand_vars_to_list[2]", output, n);
2485 n = o_save_ptr(output, n);
2486 debug_print_list("expand_vars_to_list[3]", output, n);
2489 output->o_escape = sv;
2491 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
2492 * and in this case should treat it like '$*' - see 'else...' below */
2493 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
2495 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
2496 if (++i >= G.global_argc)
2498 o_addchr(output, '\0');
2499 debug_print_list("expand_vars_to_list[4]", output, n);
2500 n = o_save_ptr(output, n);
2502 } else { /* quoted $*: add as one word */
2504 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
2505 if (!G.global_argv[++i])
2508 o_addchr(output, G.ifs[0]);
2512 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
2513 /* "Empty variable", used to make "" etc to not disappear */
2517 #if ENABLE_HUSH_TICK
2518 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
2521 /* Can't just stuff it into output o_string,
2522 * expanded result may need to be globbed
2523 * and $IFS-splitted */
2524 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
2525 G.last_exitcode = process_command_subs(&subst_result, arg);
2526 debug_printf_subst("SUBST RES:%d '%s'\n", G.last_exitcode, subst_result.data);
2527 val = subst_result.data;
2530 #if ENABLE_SH_MATH_SUPPORT
2531 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
2532 arith_eval_hooks_t hooks;
2537 arg++; /* skip '+' */
2538 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
2539 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
2541 exp_str = expand_pseudo_dquoted(arg);
2542 hooks.lookupvar = get_local_var_value;
2543 hooks.setvar = set_local_var_from_halves;
2544 hooks.endofname = endofname;
2545 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
2549 const char *msg = "error in arithmetic";
2552 msg = "exponent less than 0";
2555 msg = "divide by 0";
2558 msg = "expression recursion loop detected";
2563 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
2564 sprintf(arith_buf, arith_t_fmt, res);
2569 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
2572 char exp_len; /* '#' if it's ${#var} */
2574 char exp_save = exp_save; /* for compiler */
2575 char *exp_saveptr = exp_saveptr; /* points to expansion operator */
2576 char *exp_word = exp_word; /* for compiler */
2579 arg[0] = first_ch & 0x7f;
2581 /* prepare for expansions */
2584 if (exp_len == '#') {
2585 /* handle length expansion ${#var} */
2588 /* maybe handle parameter expansion */
2589 exp_saveptr = var + strcspn(var, ":-=+?%#");
2590 exp_save = *exp_saveptr;
2592 exp_word = exp_saveptr;
2593 if (exp_save == ':')
2595 exp_op = *exp_word++;
2596 *exp_saveptr = '\0';
2600 /* lookup the variable in question */
2601 if (isdigit(var[0])) {
2602 /* handle_dollar() should have vetted var for us */
2604 if (i < G.global_argc)
2605 val = G.global_argv[i];
2606 /* else val remains NULL: $N with too big N */
2608 val = get_local_var_value(var);
2610 /* handle any expansions */
2611 if (exp_len == '#') {
2612 debug_printf_expand("expand: length(%s)=", val);
2613 val = utoa(val ? strlen(val) : 0);
2614 debug_printf_expand("%s\n", val);
2615 } else if (exp_op) {
2616 if (exp_op == '%' || exp_op == '#') {
2617 /* Standard-mandated substring removal ops:
2618 * ${parameter%word} - remove smallest suffix pattern
2619 * ${parameter%%word} - remove largest suffix pattern
2620 * ${parameter#word} - remove smallest prefix pattern
2621 * ${parameter##word} - remove largest prefix pattern
2623 * Word is expanded to produce a glob pattern.
2624 * Then var's value is matched to it and matching part removed.
2629 scan_t scan = pick_scan(exp_op, *exp_word, &match_at_left);
2630 if (exp_op == *exp_word) /* ## or %% */
2632 val = dyn_val = xstrdup(val);
2633 loc = scan(dyn_val, exp_word, match_at_left);
2634 if (match_at_left) /* # or ## */
2636 else if (loc) /* % or %% and match was found */
2639 } else { /* one of :-=+? */
2640 //TODO: check validity of exp_op. Currently it can be anything.
2641 //TODO: handle ${VAR:N[:M]} here. N, M can be expressions similar to $((EXPR)): 2+2, 2+var etc
2642 /* Standard-mandated substitution ops:
2643 * ${var?word} - indicate error if unset
2644 * If var is unset, word (or a message indicating it is unset
2645 * if word is null) is written to standard error
2646 * and the shell exits with a non-zero exit status.
2647 * Otherwise, the value of var is substituted.
2648 * ${var-word} - use default value
2649 * If var is unset, word is substituted.
2650 * ${var=word} - assign and use default value
2651 * If var is unset, word is assigned to var.
2652 * In all cases, final value of var is substituted.
2653 * ${var+word} - use alternative value
2654 * If var is unset, null is substituted.
2655 * Otherwise, word is substituted.
2657 * Word is subjected to tilde expansion, parameter expansion,
2658 * command substitution, and arithmetic expansion.
2659 * If word is not needed, it is not expanded.
2661 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
2662 * but also treat null var as if it is unset.
2664 int use_word = (!val || ((exp_save == ':') && !val[0]));
2666 use_word = !use_word;
2667 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
2668 (exp_save == ':') ? "true" : "false", use_word);
2670 if (exp_op == '?') {
2671 //TODO: how interactive bash aborts expansion mid-command?
2672 /* mimic bash message */
2673 die_if_script("%s: %s",
2675 exp_word[0] ? exp_word : "parameter null or not set"
2681 if (exp_op == '=') {
2682 /* ${var=[word]} or ${var:=[word]} */
2683 if (isdigit(var[0]) || var[0] == '#') {
2684 /* mimic bash message */
2685 die_if_script("$%s: cannot assign in this way", var);
2688 char *new_var = xasprintf("%s=%s", var, val);
2689 set_local_var(new_var, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
2695 *exp_saveptr = exp_save;
2699 #if ENABLE_HUSH_TICK
2702 if (!(first_ch & 0x80)) { /* unquoted $VAR */
2703 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
2705 /* unquoted var's contents should be globbed, so don't escape */
2706 smallint sv = output->o_escape;
2707 output->o_escape = 0;
2708 n = expand_on_ifs(output, n, val);
2710 output->o_escape = sv;
2712 } else { /* quoted $VAR, val will be appended below */
2713 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
2716 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
2719 o_addQstr(output, val, strlen(val));
2722 /* Do the check to avoid writing to a const string */
2723 if (*p != SPECIAL_VAR_SYMBOL)
2724 *p = SPECIAL_VAR_SYMBOL;
2726 #if ENABLE_HUSH_TICK
2727 o_free(&subst_result);
2730 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
2733 debug_print_list("expand_vars_to_list[a]", output, n);
2734 /* this part is literal, and it was already pre-quoted
2735 * if needed (much earlier), do not use o_addQstr here! */
2736 o_addstr_with_NUL(output, arg);
2737 debug_print_list("expand_vars_to_list[b]", output, n);
2738 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
2739 && !(ored_ch & 0x80) /* and all vars were not quoted. */
2742 /* allow to reuse list[n] later without re-growth */
2743 output->has_empty_slot = 1;
2745 o_addchr(output, '\0');
2750 static char **expand_variables(char **argv, int or_mask)
2755 o_string output = NULL_O_STRING;
2757 if (or_mask & 0x100) {
2758 output.o_escape = 1; /* protect against globbing for "$var" */
2759 /* (unquoted $var will temporarily switch it off) */
2766 n = expand_vars_to_list(&output, n, *v, (unsigned char)or_mask);
2769 debug_print_list("expand_variables", &output, n);
2771 /* output.data (malloced in one block) gets returned in "list" */
2772 list = o_finalize_list(&output, n);
2773 debug_print_strings("expand_variables[1]", list);
2777 static char **expand_strvec_to_strvec(char **argv)
2779 return expand_variables(argv, 0x100);
2782 #if ENABLE_HUSH_BASH_COMPAT
2783 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
2785 return expand_variables(argv, 0x80);
2789 #ifdef CMD_SINGLEWORD_NOGLOB_COND
2790 static char **expand_strvec_to_strvec_singleword_noglob_cond(char **argv)
2795 o_string output = NULL_O_STRING;
2800 int is_var = is_well_formed_var_name(*v, '=');
2801 /* is_var * 0x80: singleword expansion for vars */
2802 n = expand_vars_to_list(&output, n, *v, is_var * 0x80);
2804 /* Subtle! expand_vars_to_list did not glob last word yet.
2805 * It does this only when fed with further data.
2806 * Therefore we set globbing flags AFTER it, not before:
2809 /* if it is not recognizably abc=...; then: */
2810 output.o_escape = !is_var; /* protect against globbing for "$var" */
2811 /* (unquoted $var will temporarily switch it off) */
2812 output.o_glob = !is_var; /* and indeed do globbing */
2815 debug_print_list("expand_cond", &output, n);
2817 /* output.data (malloced in one block) gets returned in "list" */
2818 list = o_finalize_list(&output, n);
2819 debug_print_strings("expand_cond[1]", list);
2824 /* Used for expansion of right hand of assignments */
2825 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2827 static char *expand_string_to_string(const char *str)
2829 char *argv[2], **list;
2831 argv[0] = (char*)str;
2833 list = expand_variables(argv, 0x80); /* 0x80: singleword expansion */
2835 if (!list[0] || list[1])
2836 bb_error_msg_and_die("BUG in varexp2");
2837 /* actually, just move string 2*sizeof(char*) bytes back */
2838 overlapping_strcpy((char*)list, list[0]);
2839 unbackslash((char*)list);
2840 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2844 /* Used for "eval" builtin */
2845 static char* expand_strvec_to_string(char **argv)
2849 list = expand_variables(argv, 0x80);
2850 /* Convert all NULs to spaces */
2855 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2856 bb_error_msg_and_die("BUG in varexp3");
2857 /* bash uses ' ' regardless of $IFS contents */
2862 overlapping_strcpy((char*)list, list[0]);
2863 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2867 static char **expand_assignments(char **argv, int count)
2871 /* Expand assignments into one string each */
2872 for (i = 0; i < count; i++) {
2873 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2881 void re_execute_shell(char ***to_free, const char *s,
2882 char *g_argv0, char **g_argv,
2883 char **builtin_argv) NORETURN;
2885 static void reset_traps_to_defaults(void)
2887 /* This function is always called in a child shell
2888 * after fork (not vfork, NOMMU doesn't use this function).
2893 /* Child shells are not interactive.
2894 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
2895 * Testcase: (while :; do :; done) + ^Z should background.
2896 * Same goes for SIGTERM, SIGHUP, SIGINT.
2898 if (!G.traps && !(G.non_DFL_mask & SPECIAL_INTERACTIVE_SIGS))
2899 return; /* already no traps and no SPECIAL_INTERACTIVE_SIGS */
2901 /* Switching off SPECIAL_INTERACTIVE_SIGS.
2902 * Stupid. It can be done with *single* &= op, but we can't use
2903 * the fact that G.blocked_set is implemented as a bitmask
2905 mask = (SPECIAL_INTERACTIVE_SIGS >> 1);
2909 /* Careful. Only if no trap or trap is not "" */
2910 if (!G.traps || !G.traps[sig] || G.traps[sig][0])
2911 sigdelset(&G.blocked_set, sig);
2918 /* Our homegrown sig mask is saner to work with :) */
2919 G.non_DFL_mask &= ~SPECIAL_INTERACTIVE_SIGS;
2921 /* Resetting all traps to default except empty ones */
2922 mask = G.non_DFL_mask;
2923 if (G.traps) for (sig = 0; sig < NSIG; sig++, mask >>= 1) {
2924 if (!G.traps[sig] || !G.traps[sig][0])
2927 G.traps[sig] = NULL;
2928 /* There is no signal for 0 (EXIT) */
2931 /* There was a trap handler, we just removed it.
2932 * But if sig still has non-DFL handling,
2933 * we should not unblock the sig. */
2936 sigdelset(&G.blocked_set, sig);
2938 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
2943 static void re_execute_shell(char ***to_free, const char *s,
2944 char *g_argv0, char **g_argv,
2945 char **builtin_argv) NORETURN;
2946 static void re_execute_shell(char ***to_free, const char *s,
2947 char *g_argv0, char **g_argv,
2948 char **builtin_argv)
2950 #define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
2951 /* delims + 2 * (number of bytes in printed hex numbers) */
2952 char param_buf[sizeof(NOMMU_HACK_FMT) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
2953 char *heredoc_argv[4];
2954 struct variable *cur;
2955 # if ENABLE_HUSH_FUNCTIONS
2956 struct function *funcp;
2960 unsigned long long empty_trap_mask;
2962 if (!g_argv0) { /* heredoc */
2963 argv = heredoc_argv;
2964 argv[0] = (char *) G.argv0_for_re_execing;
2965 argv[1] = (char *) "-<";
2966 argv[2] = (char *) s;
2968 pp = &argv[3]; /* used as pointer to empty environment */
2974 if (pp) while (*pp++)
2977 empty_trap_mask = 0;
2980 for (sig = 1; sig < NSIG; sig++) {
2981 if (G.traps[sig] && !G.traps[sig][0])
2982 empty_trap_mask |= 1LL << sig;
2986 sprintf(param_buf, NOMMU_HACK_FMT
2987 , (unsigned) G.root_pid
2988 , (unsigned) G.root_ppid
2989 , (unsigned) G.last_bg_pid
2990 , (unsigned) G.last_exitcode
2993 IF_HUSH_LOOPS(, G.depth_of_loop)
2995 #undef NOMMU_HACK_FMT
2996 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
2997 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
3000 for (cur = G.top_var; cur; cur = cur->next) {
3001 if (!cur->flg_export || cur->flg_read_only)
3004 # if ENABLE_HUSH_FUNCTIONS
3005 for (funcp = G.top_func; funcp; funcp = funcp->next)
3011 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
3012 *pp++ = (char *) G.argv0_for_re_execing;
3014 for (cur = G.top_var; cur; cur = cur->next) {
3015 if (cur->varstr == hush_version_str)
3017 if (cur->flg_read_only) {
3018 *pp++ = (char *) "-R";
3019 *pp++ = cur->varstr;
3020 } else if (!cur->flg_export) {
3021 *pp++ = (char *) "-V";
3022 *pp++ = cur->varstr;
3025 # if ENABLE_HUSH_FUNCTIONS
3026 for (funcp = G.top_func; funcp; funcp = funcp->next) {
3027 *pp++ = (char *) "-F";
3028 *pp++ = funcp->name;
3029 *pp++ = funcp->body_as_string;
3032 /* We can pass activated traps here. Say, -Tnn:trap_string
3034 * However, POSIX says that subshells reset signals with traps
3036 * I tested bash-3.2 and it not only does that with true subshells
3037 * of the form ( list ), but with any forked children shells.
3038 * I set trap "echo W" WINCH; and then tried:
3040 * { echo 1; sleep 20; echo 2; } &
3041 * while true; do echo 1; sleep 20; echo 2; break; done &
3042 * true | { echo 1; sleep 20; echo 2; } | cat
3044 * In all these cases sending SIGWINCH to the child shell
3045 * did not run the trap. If I add trap "echo V" WINCH;
3046 * _inside_ group (just before echo 1), it works.
3048 * I conclude it means we don't need to pass active traps here.
3049 * Even if we would use signal handlers instead of signal masking
3050 * in order to implement trap handling,
3051 * exec syscall below resets signals to SIG_DFL for us.
3053 *pp++ = (char *) "-c";
3056 while (*++builtin_argv)
3057 *pp++ = *builtin_argv;
3058 *pp++ = (char *) "";
3063 /* *pp = NULL; - is already there */
3067 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
3068 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3069 execve(bb_busybox_exec_path, argv, pp);
3070 /* Fallback. Useful for init=/bin/hush usage etc */
3071 if (argv[0][0] == '/')
3072 execve(argv[0], argv, pp);
3073 xfunc_error_retval = 127;
3074 bb_error_msg_and_die("can't re-execute the shell");
3076 #endif /* !BB_MMU */
3079 static void setup_heredoc(struct redir_struct *redir)
3081 struct fd_pair pair;
3084 /* the _body_ of heredoc (misleading field name) */
3085 const char *heredoc = redir->rd_filename;
3092 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
3093 expanded = expand_pseudo_dquoted(heredoc);
3097 len = strlen(heredoc);
3099 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
3101 xmove_fd(pair.rd, redir->rd_fd);
3103 /* Try writing without forking. Newer kernels have
3104 * dynamically growing pipes. Must use non-blocking write! */
3107 written = write(pair.wr, heredoc, len);
3118 ndelay_off(pair.wr);
3120 /* Okay, pipe buffer was not big enough */
3121 /* Note: we must not create a stray child (bastard? :)
3122 * for the unsuspecting parent process. Child creates a grandchild
3123 * and exits before parent execs the process which consumes heredoc
3124 * (that exec happens after we return from this function) */
3130 bb_perror_msg_and_die("vfork");
3133 disable_restore_tty_pgrp_on_exit();
3134 pid = BB_MMU ? fork() : vfork();
3136 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3140 close(redir->rd_fd); /* read side of the pipe */
3142 full_write(pair.wr, heredoc, len); /* may loop or block */
3145 /* Delegate blocking writes to another process */
3146 xmove_fd(pair.wr, STDOUT_FILENO);
3147 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
3151 #if ENABLE_HUSH_FAST
3153 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
3155 enable_restore_tty_pgrp_on_exit();
3161 wait(NULL); /* wait till child has died */
3164 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
3165 * and stderr if they are redirected. */
3166 static int setup_redirects(struct command *prog, int squirrel[])
3169 struct redir_struct *redir;
3171 for (redir = prog->redirects; redir; redir = redir->next) {
3172 if (redir->rd_type == REDIRECT_HEREDOC2) {
3173 /* rd_fd<<HERE case */
3174 if (squirrel && redir->rd_fd < 3
3175 && squirrel[redir->rd_fd] < 0
3177 squirrel[redir->rd_fd] = dup(redir->rd_fd);
3179 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
3181 debug_printf_parse("set heredoc '%s'\n",
3182 redir->rd_filename);
3183 setup_heredoc(redir);
3187 if (redir->rd_dup == REDIRFD_TO_FILE) {
3188 /* rd_fd<*>file case (<*> is <,>,>>,<>) */
3190 if (redir->rd_filename == NULL) {
3191 /* Something went wrong in the parse.
3192 * Pretend it didn't happen */
3193 bb_error_msg("bug in redirect parse");
3196 mode = redir_table[redir->rd_type].mode;
3197 p = expand_string_to_string(redir->rd_filename);
3198 openfd = open_or_warn(p, mode);
3201 /* this could get lost if stderr has been redirected, but
3202 * bash and ash both lose it as well (though zsh doesn't!) */
3203 //what the above comment tries to say?
3207 /* rd_fd<*>rd_dup or rd_fd<*>- cases */
3208 openfd = redir->rd_dup;
3211 if (openfd != redir->rd_fd) {
3212 if (squirrel && redir->rd_fd < 3
3213 && squirrel[redir->rd_fd] < 0
3215 squirrel[redir->rd_fd] = dup(redir->rd_fd);
3217 if (openfd == REDIRFD_CLOSE) {
3218 /* "n>-" means "close me" */
3219 close(redir->rd_fd);
3221 xdup2(openfd, redir->rd_fd);
3222 if (redir->rd_dup == REDIRFD_TO_FILE)
3230 static void restore_redirects(int squirrel[])
3233 for (i = 0; i < 3; i++) {
3236 /* We simply die on error */
3243 static void free_pipe_list(struct pipe *head);
3245 /* Return code is the exit status of the pipe */
3246 static void free_pipe(struct pipe *pi)
3249 struct command *command;
3250 struct redir_struct *r, *rnext;
3253 if (pi->stopped_cmds > 0) /* why? */
3255 debug_printf_clean("run pipe: (pid %d)\n", getpid());
3256 for (i = 0; i < pi->num_cmds; i++) {
3257 command = &pi->cmds[i];
3258 debug_printf_clean(" command %d:\n", i);
3259 if (command->argv) {
3260 for (a = 0, p = command->argv; *p; a++, p++) {
3261 debug_printf_clean(" argv[%d] = %s\n", a, *p);
3263 free_strings(command->argv);
3264 command->argv = NULL;
3266 /* not "else if": on syntax error, we may have both! */
3267 if (command->group) {
3268 debug_printf_clean(" begin group (cmd_type:%d)\n",
3270 free_pipe_list(command->group);
3271 debug_printf_clean(" end group\n");
3272 command->group = NULL;
3274 /* else is crucial here.
3275 * If group != NULL, child_func is meaningless */
3276 #if ENABLE_HUSH_FUNCTIONS
3277 else if (command->child_func) {
3278 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
3279 command->child_func->parent_cmd = NULL;
3283 free(command->group_as_string);
3284 command->group_as_string = NULL;
3286 for (r = command->redirects; r; r = rnext) {
3287 debug_printf_clean(" redirect %d%s",
3288 r->rd_fd, redir_table[r->rd_type].descrip);
3289 /* guard against the case >$FOO, where foo is unset or blank */
3290 if (r->rd_filename) {
3291 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
3292 free(r->rd_filename);
3293 r->rd_filename = NULL;
3295 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
3299 command->redirects = NULL;
3301 free(pi->cmds); /* children are an array, they get freed all at once */
3309 static void free_pipe_list(struct pipe *head)
3311 struct pipe *pi, *next;
3313 for (pi = head; pi; pi = next) {
3315 debug_printf_clean(" pipe reserved word %d\n", pi->res_word);
3318 debug_printf_clean("pipe followup code %d\n", pi->followup);
3320 /*pi->next = NULL;*/
3326 static int run_list(struct pipe *pi);
3328 #define parse_stream(pstring, input, end_trigger) \
3329 parse_stream(input, end_trigger)
3331 static struct pipe *parse_stream(char **pstring,
3332 struct in_str *input,
3334 static void parse_and_run_string(const char *s);
3337 static char *find_in_path(const char *arg)
3340 const char *PATH = get_local_var_value("PATH");
3346 const char *end = strchrnul(PATH, ':');
3347 int sz = end - PATH; /* must be int! */
3351 ret = xasprintf("%.*s/%s", sz, PATH, arg);
3353 /* We have xxx::yyyy in $PATH,
3354 * it means "use current dir" */
3357 if (access(ret, F_OK) == 0)
3370 static const struct built_in_command* find_builtin_helper(const char *name,
3371 const struct built_in_command *x,
3372 const struct built_in_command *end)
3375 if (strcmp(name, x->b_cmd) != 0) {
3379 debug_printf_exec("found builtin '%s'\n", name);
3384 static const struct built_in_command* find_builtin1(const char *name)
3386 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
3388 static const struct built_in_command* find_builtin(const char *name)
3390 const struct built_in_command *x = find_builtin1(name);
3393 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
3396 #if ENABLE_HUSH_FUNCTIONS
3397 static struct function **find_function_slot(const char *name)
3399 struct function **funcpp = &G.top_func;
3401 if (strcmp(name, (*funcpp)->name) == 0) {
3404 funcpp = &(*funcpp)->next;
3409 static const struct function *find_function(const char *name)
3411 const struct function *funcp = *find_function_slot(name);
3413 debug_printf_exec("found function '%s'\n", name);
3417 /* Note: takes ownership on name ptr */
3418 static struct function *new_function(char *name)
3420 struct function **funcpp = find_function_slot(name);
3421 struct function *funcp = *funcpp;
3423 if (funcp != NULL) {
3424 struct command *cmd = funcp->parent_cmd;
3425 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
3427 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
3429 /* Note: if !funcp->body, do not free body_as_string!
3430 * This is a special case of "-F name body" function:
3431 * body_as_string was not malloced! */
3433 free_pipe_list(funcp->body);
3435 free(funcp->body_as_string);
3439 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
3440 cmd->argv[0] = funcp->name;
3441 cmd->group = funcp->body;
3443 cmd->group_as_string = funcp->body_as_string;
3447 debug_printf_exec("remembering new function '%s'\n", name);
3448 funcp = *funcpp = xzalloc(sizeof(*funcp));
3449 /*funcp->next = NULL;*/
3456 static void unset_func(const char *name)
3458 struct function **funcpp = find_function_slot(name);
3459 struct function *funcp = *funcpp;
3461 if (funcp != NULL) {
3462 debug_printf_exec("freeing function '%s'\n", funcp->name);
3463 *funcpp = funcp->next;
3464 /* funcp is unlinked now, deleting it.
3465 * Note: if !funcp->body, the function was created by
3466 * "-F name body", do not free ->body_as_string
3467 * and ->name as they were not malloced. */
3469 free_pipe_list(funcp->body);
3472 free(funcp->body_as_string);
3480 #define exec_function(to_free, funcp, argv) \
3481 exec_function(funcp, argv)
3483 static void exec_function(char ***to_free,
3484 const struct function *funcp,
3485 char **argv) NORETURN;
3486 static void exec_function(char ***to_free,
3487 const struct function *funcp,
3493 argv[0] = G.global_argv[0];
3494 G.global_argv = argv;
3498 /* On MMU, funcp->body is always non-NULL */
3499 n = run_list(funcp->body);
3503 re_execute_shell(to_free,
3504 funcp->body_as_string,
3511 static int run_function(const struct function *funcp, char **argv)
3517 save_and_replace_G_args(&sv, argv);
3519 /* "we are in function, ok to use return" */
3520 sv_flg = G.flag_return_in_progress;
3521 G.flag_return_in_progress = -1;
3522 # if ENABLE_HUSH_LOCAL
3523 G.func_nest_level++;
3526 /* On MMU, funcp->body is always non-NULL */
3529 /* Function defined by -F */
3530 parse_and_run_string(funcp->body_as_string);
3531 rc = G.last_exitcode;
3535 rc = run_list(funcp->body);
3538 # if ENABLE_HUSH_LOCAL
3540 struct variable *var;
3541 struct variable **var_pp;
3543 var_pp = &G.top_var;
3544 while ((var = *var_pp) != NULL) {
3545 if (var->func_nest_level < G.func_nest_level) {
3546 var_pp = &var->next;
3550 if (var->flg_export)
3551 bb_unsetenv(var->varstr);
3552 /* Remove from global list */
3553 *var_pp = var->next;
3559 G.func_nest_level--;
3562 G.flag_return_in_progress = sv_flg;
3564 restore_G_args(&sv, argv);
3568 #endif /* ENABLE_HUSH_FUNCTIONS */
3572 #define exec_builtin(to_free, x, argv) \
3573 exec_builtin(x, argv)
3575 #define exec_builtin(to_free, x, argv) \
3576 exec_builtin(to_free, argv)
3578 static void exec_builtin(char ***to_free,
3579 const struct built_in_command *x,
3580 char **argv) NORETURN;
3581 static void exec_builtin(char ***to_free,
3582 const struct built_in_command *x,
3586 int rcode = x->b_function(argv);
3590 /* On NOMMU, we must never block!
3591 * Example: { sleep 99 | read line; } & echo Ok
3593 re_execute_shell(to_free,
3602 static void execvp_or_die(char **argv) NORETURN;
3603 static void execvp_or_die(char **argv)
3605 debug_printf_exec("execing '%s'\n", argv[0]);
3606 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3607 execvp(argv[0], argv);
3608 bb_perror_msg("can't execute '%s'", argv[0]);
3609 _exit(127); /* bash compat */
3613 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
3614 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
3615 #define pseudo_exec(nommu_save, command, argv_expanded) \
3616 pseudo_exec(command, argv_expanded)
3619 /* Called after [v]fork() in run_pipe, or from builtin_exec.
3621 * Don't exit() here. If you don't exec, use _exit instead.
3622 * The at_exit handlers apparently confuse the calling process,
3623 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
3624 static void pseudo_exec_argv(nommu_save_t *nommu_save,
3625 char **argv, int assignment_cnt,
3626 char **argv_expanded) NORETURN;
3627 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
3628 char **argv, int assignment_cnt,
3629 char **argv_expanded)
3633 /* Case when we are here: ... | var=val | ... */
3634 if (!argv[assignment_cnt])
3635 _exit(EXIT_SUCCESS);
3637 new_env = expand_assignments(argv, assignment_cnt);
3639 set_vars_and_save_old(new_env);
3640 free(new_env); /* optional */
3641 /* we can also destroy set_vars_and_save_old's return value,
3644 nommu_save->new_env = new_env;
3645 nommu_save->old_vars = set_vars_and_save_old(new_env);
3647 if (argv_expanded) {
3648 argv = argv_expanded;
3650 argv = expand_strvec_to_strvec(argv + assignment_cnt);
3652 nommu_save->argv = argv;
3656 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
3657 if (strchr(argv[0], '/') != NULL)
3661 /* Check if the command matches any of the builtins.
3662 * Depending on context, this might be redundant. But it's
3663 * easier to waste a few CPU cycles than it is to figure out
3664 * if this is one of those cases.
3667 /* On NOMMU, it is more expensive to re-execute shell
3668 * just in order to run echo or test builtin.
3669 * It's better to skip it here and run corresponding
3670 * non-builtin later. */
3671 const struct built_in_command *x;
3672 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
3674 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
3677 #if ENABLE_HUSH_FUNCTIONS
3678 /* Check if the command matches any functions */
3680 const struct function *funcp = find_function(argv[0]);
3682 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
3687 #if ENABLE_FEATURE_SH_STANDALONE
3688 /* Check if the command matches any busybox applets */
3690 int a = find_applet_by_name(argv[0]);
3692 # if BB_MMU /* see above why on NOMMU it is not allowed */
3693 if (APPLET_IS_NOEXEC(a)) {
3694 debug_printf_exec("running applet '%s'\n", argv[0]);
3695 run_applet_no_and_exit(a, argv);
3698 /* Re-exec ourselves */
3699 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
3700 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
3701 execv(bb_busybox_exec_path, argv);
3702 /* If they called chroot or otherwise made the binary no longer
3703 * executable, fall through */
3708 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
3711 execvp_or_die(argv);
3714 /* Called after [v]fork() in run_pipe
3716 static void pseudo_exec(nommu_save_t *nommu_save,
3717 struct command *command,
3718 char **argv_expanded) NORETURN;
3719 static void pseudo_exec(nommu_save_t *nommu_save,
3720 struct command *command,
3721 char **argv_expanded)
3723 if (command->argv) {
3724 pseudo_exec_argv(nommu_save, command->argv,
3725 command->assignment_cnt, argv_expanded);
3728 if (command->group) {
3729 /* Cases when we are here:
3732 * ... | ( list ) | ...
3733 * ... | { list } | ...
3737 debug_printf_exec("pseudo_exec: run_list\n");
3738 reset_traps_to_defaults();
3739 rcode = run_list(command->group);
3740 /* OK to leak memory by not calling free_pipe_list,
3741 * since this process is about to exit */
3744 re_execute_shell(&nommu_save->argv_from_re_execing,
3745 command->group_as_string,
3752 /* Case when we are here: ... | >file */
3753 debug_printf_exec("pseudo_exec'ed null command\n");
3754 _exit(EXIT_SUCCESS);
3758 static const char *get_cmdtext(struct pipe *pi)
3764 /* This is subtle. ->cmdtext is created only on first backgrounding.
3765 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
3766 * On subsequent bg argv is trashed, but we won't use it */
3769 argv = pi->cmds[0].argv;
3770 if (!argv || !argv[0]) {
3771 pi->cmdtext = xzalloc(1);
3777 len += strlen(*argv) + 1;
3781 argv = pi->cmds[0].argv;
3783 len = strlen(*argv);
3784 memcpy(p, *argv, len);
3792 static void insert_bg_job(struct pipe *pi)
3794 struct pipe *job, **jobp;
3797 /* Linear search for the ID of the job to use */
3799 for (job = G.job_list; job; job = job->next)
3800 if (job->jobid >= pi->jobid)
3801 pi->jobid = job->jobid + 1;
3803 /* Add job to the list of running jobs */
3805 while ((job = *jobp) != NULL)
3807 job = *jobp = xmalloc(sizeof(*job));
3809 *job = *pi; /* physical copy */
3811 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
3812 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
3813 for (i = 0; i < pi->num_cmds; i++) {
3814 job->cmds[i].pid = pi->cmds[i].pid;
3815 /* all other fields are not used and stay zero */
3817 job->cmdtext = xstrdup(get_cmdtext(pi));
3819 if (G_interactive_fd)
3820 printf("[%d] %d %s\n", job->jobid, job->cmds[0].pid, job->cmdtext);
3821 /* Last command's pid goes to $! */
3822 G.last_bg_pid = job->cmds[job->num_cmds - 1].pid;
3823 G.last_jobid = job->jobid;
3826 static void remove_bg_job(struct pipe *pi)
3828 struct pipe *prev_pipe;
3830 if (pi == G.job_list) {
3831 G.job_list = pi->next;
3833 prev_pipe = G.job_list;
3834 while (prev_pipe->next != pi)
3835 prev_pipe = prev_pipe->next;
3836 prev_pipe->next = pi->next;
3839 G.last_jobid = G.job_list->jobid;
3844 /* Remove a backgrounded job */
3845 static void delete_finished_bg_job(struct pipe *pi)
3848 pi->stopped_cmds = 0;
3854 /* Check to see if any processes have exited -- if they
3855 * have, figure out why and see if a job has completed */
3856 static int checkjobs(struct pipe* fg_pipe)
3866 debug_printf_jobs("checkjobs %p\n", fg_pipe);
3868 attributes = WUNTRACED;
3869 if (fg_pipe == NULL)
3870 attributes |= WNOHANG;
3873 #if ENABLE_HUSH_FAST
3874 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
3875 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
3876 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
3877 /* There was neither fork nor SIGCHLD since last waitpid */
3878 /* Avoid doing waitpid syscall if possible */
3879 if (!G.we_have_children) {
3883 if (fg_pipe == NULL) { /* is WNOHANG set? */
3884 /* We have children, but they did not exit
3885 * or stop yet (we saw no SIGCHLD) */
3888 /* else: !WNOHANG, waitpid will block, can't short-circuit */
3892 /* Do we do this right?
3893 * bash-3.00# sleep 20 | false
3895 * [3]+ Stopped sleep 20 | false
3896 * bash-3.00# echo $?
3897 * 1 <========== bg pipe is not fully done, but exitcode is already known!
3898 * [hush 1.14.0: yes we do it right]
3905 #if ENABLE_HUSH_FAST
3906 i = G.count_SIGCHLD;
3908 childpid = waitpid(-1, &status, attributes);
3909 if (childpid <= 0) {
3910 if (childpid && errno != ECHILD)
3911 bb_perror_msg("waitpid");
3912 #if ENABLE_HUSH_FAST
3913 else { /* Until next SIGCHLD, waitpid's are useless */
3914 G.we_have_children = (childpid == 0);
3915 G.handled_SIGCHLD = i;
3916 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
3921 dead = WIFEXITED(status) || WIFSIGNALED(status);
3924 if (WIFSTOPPED(status))
3925 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
3926 childpid, WSTOPSIG(status), WEXITSTATUS(status));
3927 if (WIFSIGNALED(status))
3928 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
3929 childpid, WTERMSIG(status), WEXITSTATUS(status));
3930 if (WIFEXITED(status))
3931 debug_printf_jobs("pid %d exited, exitcode %d\n",
3932 childpid, WEXITSTATUS(status));
3934 /* Were we asked to wait for fg pipe? */
3936 for (i = 0; i < fg_pipe->num_cmds; i++) {
3937 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
3938 if (fg_pipe->cmds[i].pid != childpid)
3941 fg_pipe->cmds[i].pid = 0;
3942 fg_pipe->alive_cmds--;
3943 if (i == fg_pipe->num_cmds - 1) {
3944 /* last process gives overall exitstatus */
3945 rcode = WEXITSTATUS(status);
3946 /* bash prints killer signal's name for *last*
3947 * process in pipe (prints just newline for SIGINT).
3948 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
3950 if (WIFSIGNALED(status)) {
3951 int sig = WTERMSIG(status);
3952 printf("%s\n", sig == SIGINT ? "" : get_signame(sig));
3953 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
3954 * Maybe we need to use sig | 128? */
3957 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
3960 fg_pipe->cmds[i].is_stopped = 1;
3961 fg_pipe->stopped_cmds++;
3963 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
3964 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
3965 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
3966 /* All processes in fg pipe have exited or stopped */
3967 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
3968 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
3969 * and "killall -STOP cat" */
3970 if (G_interactive_fd) {
3972 if (fg_pipe->alive_cmds)
3973 insert_bg_job(fg_pipe);
3977 if (!fg_pipe->alive_cmds)
3980 /* There are still running processes in the fg pipe */
3981 goto wait_more; /* do waitpid again */
3983 /* it wasnt fg_pipe, look for process in bg pipes */
3987 /* We asked to wait for bg or orphaned children */
3988 /* No need to remember exitcode in this case */
3989 for (pi = G.job_list; pi; pi = pi->next) {
3990 for (i = 0; i < pi->num_cmds; i++) {
3991 if (pi->cmds[i].pid == childpid)
3992 goto found_pi_and_prognum;
3995 /* Happens when shell is used as init process (init=/bin/sh) */
3996 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
3997 continue; /* do waitpid again */
3999 found_pi_and_prognum:
4002 pi->cmds[i].pid = 0;
4004 if (!pi->alive_cmds) {
4005 if (G_interactive_fd)
4006 printf(JOB_STATUS_FORMAT, pi->jobid,
4007 "Done", pi->cmdtext);
4008 delete_finished_bg_job(pi);
4012 pi->cmds[i].is_stopped = 1;
4016 } /* while (waitpid succeeds)... */
4022 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
4025 int rcode = checkjobs(fg_pipe);
4026 if (G_saved_tty_pgrp) {
4027 /* Job finished, move the shell to the foreground */
4028 p = getpgrp(); /* our process group id */
4029 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
4030 tcsetpgrp(G_interactive_fd, p);
4036 /* Start all the jobs, but don't wait for anything to finish.
4039 * Return code is normally -1, when the caller has to wait for children
4040 * to finish to determine the exit status of the pipe. If the pipe
4041 * is a simple builtin command, however, the action is done by the
4042 * time run_pipe returns, and the exit code is provided as the
4045 * Returns -1 only if started some children. IOW: we have to
4046 * mask out retvals of builtins etc with 0xff!
4048 * The only case when we do not need to [v]fork is when the pipe
4049 * is single, non-backgrounded, non-subshell command. Examples:
4050 * cmd ; ... { list } ; ...
4051 * cmd && ... { list } && ...
4052 * cmd || ... { list } || ...
4053 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
4054 * or (if SH_STANDALONE) an applet, and we can run the { list }
4055 * with run_list. If it isn't one of these, we fork and exec cmd.
4057 * Cases when we must fork:
4058 * non-single: cmd | cmd
4059 * backgrounded: cmd & { list } &
4060 * subshell: ( list ) [&]
4062 static NOINLINE int run_pipe(struct pipe *pi)
4064 static const char *const null_ptr = NULL;
4067 struct command *command;
4068 char **argv_expanded;
4071 /* it is not always needed, but we aim to smaller code */
4072 int squirrel[] = { -1, -1, -1 };
4075 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
4078 IF_HUSH_JOB(pi->pgrp = -1;)
4079 pi->stopped_cmds = 0;
4080 command = &(pi->cmds[0]);
4081 argv_expanded = NULL;
4083 if (pi->num_cmds != 1
4084 || pi->followup == PIPE_BG
4085 || command->cmd_type == CMD_SUBSHELL
4092 debug_printf_exec(": group:%p argv:'%s'\n",
4093 command->group, command->argv ? command->argv[0] : "NONE");
4095 if (command->group) {
4096 #if ENABLE_HUSH_FUNCTIONS
4097 if (command->cmd_type == CMD_FUNCDEF) {
4098 /* "executing" func () { list } */
4099 struct function *funcp;
4101 funcp = new_function(command->argv[0]);
4102 /* funcp->name is already set to argv[0] */
4103 funcp->body = command->group;
4105 funcp->body_as_string = command->group_as_string;
4106 command->group_as_string = NULL;
4108 command->group = NULL;
4109 command->argv[0] = NULL;
4110 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
4111 funcp->parent_cmd = command;
4112 command->child_func = funcp;
4114 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
4116 return EXIT_SUCCESS;
4120 debug_printf("non-subshell group\n");
4121 rcode = 1; /* exitcode if redir failed */
4122 if (setup_redirects(command, squirrel) == 0) {
4123 debug_printf_exec(": run_list\n");
4124 rcode = run_list(command->group) & 0xff;
4126 restore_redirects(squirrel);
4127 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4129 debug_printf_exec("run_pipe: return %d\n", rcode);
4133 argv = command->argv ? command->argv : (char **) &null_ptr;
4135 const struct built_in_command *x;
4136 #if ENABLE_HUSH_FUNCTIONS
4137 const struct function *funcp;
4141 char **new_env = NULL;
4142 struct variable *old_vars = NULL;
4144 if (argv[command->assignment_cnt] == NULL) {
4145 /* Assignments, but no command */
4146 /* Ensure redirects take effect (that is, create files).
4147 * Try "a=t >file": */
4148 rcode = setup_redirects(command, squirrel);
4149 restore_redirects(squirrel);
4150 /* Set shell variables */
4152 p = expand_string_to_string(*argv);
4153 debug_printf_exec("set shell var:'%s'->'%s'\n",
4155 set_local_var(p, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
4158 /* Redirect error sets $? to 1. Othervise,
4159 * if evaluating assignment value set $?, retain it.
4160 * Try "false; q=`exit 2`; echo $?" - should print 2: */
4162 rcode = G.last_exitcode;
4163 /* Do we need to flag set_local_var() errors?
4164 * "assignment to readonly var" and "putenv error"
4166 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4168 debug_printf_exec("run_pipe: return %d\n", rcode);
4172 /* Expand the rest into (possibly) many strings each */
4174 #if ENABLE_HUSH_BASH_COMPAT
4175 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
4176 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
4179 #ifdef CMD_SINGLEWORD_NOGLOB_COND
4180 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB_COND) {
4181 argv_expanded = expand_strvec_to_strvec_singleword_noglob_cond(argv + command->assignment_cnt);
4186 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
4189 /* if someone gives us an empty string: `cmd with empty output` */
4190 if (!argv_expanded[0]) {
4191 free(argv_expanded);
4193 return G.last_exitcode;
4196 x = find_builtin(argv_expanded[0]);
4197 #if ENABLE_HUSH_FUNCTIONS
4200 funcp = find_function(argv_expanded[0]);
4204 if (x->b_function == builtin_exec && argv_expanded[1] == NULL) {
4205 debug_printf("exec with redirects only\n");
4206 rcode = setup_redirects(command, NULL);
4207 goto clean_up_and_ret1;
4210 /* setup_redirects acts on file descriptors, not FILEs.
4211 * This is perfect for work that comes after exec().
4212 * Is it really safe for inline use? Experimentally,
4213 * things seem to work. */
4214 rcode = setup_redirects(command, squirrel);
4216 new_env = expand_assignments(argv, command->assignment_cnt);
4217 old_vars = set_vars_and_save_old(new_env);
4219 debug_printf_exec(": builtin '%s' '%s'...\n",
4220 x->b_cmd, argv_expanded[1]);
4221 rcode = x->b_function(argv_expanded) & 0xff;
4224 #if ENABLE_HUSH_FUNCTIONS
4226 # if ENABLE_HUSH_LOCAL
4227 struct variable **sv;
4228 sv = G.shadowed_vars_pp;
4229 G.shadowed_vars_pp = &old_vars;
4231 debug_printf_exec(": function '%s' '%s'...\n",
4232 funcp->name, argv_expanded[1]);
4233 rcode = run_function(funcp, argv_expanded) & 0xff;
4234 # if ENABLE_HUSH_LOCAL
4235 G.shadowed_vars_pp = sv;
4240 #if ENABLE_FEATURE_SH_STANDALONE
4243 restore_redirects(squirrel);
4244 unset_vars(new_env);
4247 free(argv_expanded);
4248 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
4250 debug_printf_exec("run_pipe return %d\n", rcode);
4254 #if ENABLE_FEATURE_SH_STANDALONE
4255 i = find_applet_by_name(argv_expanded[0]);
4256 if (i >= 0 && APPLET_IS_NOFORK(i)) {
4257 rcode = setup_redirects(command, squirrel);
4259 new_env = expand_assignments(argv, command->assignment_cnt);
4260 old_vars = set_vars_and_save_old(new_env);
4261 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
4262 argv_expanded[0], argv_expanded[1]);
4263 rcode = run_nofork_applet(i, argv_expanded);
4265 goto clean_up_and_ret;
4268 /* It is neither builtin nor applet. We must fork. */
4272 /* NB: argv_expanded may already be created, and that
4273 * might include `cmd` runs! Do not rerun it! We *must*
4274 * use argv_expanded if it's non-NULL */
4276 /* Going to fork a child per each pipe member */
4280 for (i = 0; i < pi->num_cmds; i++) {
4281 struct fd_pair pipefds;
4283 volatile nommu_save_t nommu_save;
4284 nommu_save.new_env = NULL;
4285 nommu_save.old_vars = NULL;
4286 nommu_save.argv = NULL;
4287 nommu_save.argv_from_re_execing = NULL;
4289 command = &(pi->cmds[i]);
4290 if (command->argv) {
4291 debug_printf_exec(": pipe member '%s' '%s'...\n",
4292 command->argv[0], command->argv[1]);
4294 debug_printf_exec(": pipe member with no argv\n");
4297 /* pipes are inserted between pairs of commands */
4300 if ((i + 1) < pi->num_cmds)
4301 xpiped_pair(pipefds);
4303 command->pid = BB_MMU ? fork() : vfork();
4304 if (!command->pid) { /* child */
4306 disable_restore_tty_pgrp_on_exit();
4307 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
4309 /* Every child adds itself to new process group
4310 * with pgid == pid_of_first_child_in_pipe */
4311 if (G.run_list_level == 1 && G_interactive_fd) {
4314 if (pgrp < 0) /* true for 1st process only */
4316 if (setpgid(0, pgrp) == 0
4317 && pi->followup != PIPE_BG
4318 && G_saved_tty_pgrp /* we have ctty */
4320 /* We do it in *every* child, not just first,
4322 tcsetpgrp(G_interactive_fd, pgrp);
4326 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
4327 /* 1st cmd in backgrounded pipe
4328 * should have its stdin /dev/null'ed */
4330 if (open(bb_dev_null, O_RDONLY))
4331 xopen("/", O_RDONLY);
4333 xmove_fd(nextin, 0);
4335 xmove_fd(pipefds.wr, 1);
4338 /* Like bash, explicit redirects override pipes,
4339 * and the pipe fd is available for dup'ing. */
4340 if (setup_redirects(command, NULL))
4343 /* Restore default handlers just prior to exec */
4344 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
4346 /* Stores to nommu_save list of env vars putenv'ed
4347 * (NOMMU, on MMU we don't need that) */
4348 /* cast away volatility... */
4349 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
4350 /* pseudo_exec() does not return */
4353 /* parent or error */
4354 #if ENABLE_HUSH_FAST
4356 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
4358 enable_restore_tty_pgrp_on_exit();
4360 /* Clean up after vforked child */
4361 free(nommu_save.argv);
4362 free(nommu_save.argv_from_re_execing);
4363 unset_vars(nommu_save.new_env);
4364 add_vars(nommu_save.old_vars);
4366 free(argv_expanded);
4367 argv_expanded = NULL;
4368 if (command->pid < 0) { /* [v]fork failed */
4369 /* Clearly indicate, was it fork or vfork */
4370 bb_perror_msg(BB_MMU ? "fork" : "vfork");
4374 /* Second and next children need to know pid of first one */
4376 pi->pgrp = command->pid;
4382 if ((i + 1) < pi->num_cmds)
4384 /* Pass read (output) pipe end to next iteration */
4385 nextin = pipefds.rd;
4388 if (!pi->alive_cmds) {
4390 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
4395 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
4399 #ifndef debug_print_tree
4400 static void debug_print_tree(struct pipe *pi, int lvl)
4402 static const char *const PIPE[] = {
4408 static const char *RES[] = {
4409 [RES_NONE ] = "NONE" ,
4412 [RES_THEN ] = "THEN" ,
4413 [RES_ELIF ] = "ELIF" ,
4414 [RES_ELSE ] = "ELSE" ,
4417 # if ENABLE_HUSH_LOOPS
4418 [RES_FOR ] = "FOR" ,
4419 [RES_WHILE] = "WHILE",
4420 [RES_UNTIL] = "UNTIL",
4422 [RES_DONE ] = "DONE" ,
4424 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
4427 # if ENABLE_HUSH_CASE
4428 [RES_CASE ] = "CASE" ,
4429 [RES_CASE_IN ] = "CASE_IN" ,
4430 [RES_MATCH] = "MATCH",
4431 [RES_CASE_BODY] = "CASE_BODY",
4432 [RES_ESAC ] = "ESAC" ,
4434 [RES_XXXX ] = "XXXX" ,
4435 [RES_SNTX ] = "SNTX" ,
4437 static const char *const CMDTYPE[] = {
4441 # if ENABLE_HUSH_FUNCTIONS
4450 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
4451 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
4453 while (prn < pi->num_cmds) {
4454 struct command *command = &pi->cmds[prn];
4455 char **argv = command->argv;
4457 fprintf(stderr, "%*s cmd %d assignment_cnt:%d",
4459 command->assignment_cnt);
4460 if (command->group) {
4461 fprintf(stderr, " group %s: (argv=%p)%s%s\n",
4462 CMDTYPE[command->cmd_type],
4465 , " group_as_string:", command->group_as_string
4470 debug_print_tree(command->group, lvl+1);
4474 if (argv) while (*argv) {
4475 fprintf(stderr, " '%s'", *argv);
4478 fprintf(stderr, "\n");
4485 #endif /* debug_print_tree */
4487 /* NB: called by pseudo_exec, and therefore must not modify any
4488 * global data until exec/_exit (we can be a child after vfork!) */
4489 static int run_list(struct pipe *pi)
4491 #if ENABLE_HUSH_CASE
4492 char *case_word = NULL;
4494 #if ENABLE_HUSH_LOOPS
4495 struct pipe *loop_top = NULL;
4496 char **for_lcur = NULL;
4497 char **for_list = NULL;
4499 smallint last_followup;
4501 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
4502 smalluint cond_code = 0;
4504 enum { cond_code = 0 };
4507 smallint rword; /* enum reserved_style */
4508 smallint last_rword; /* ditto */
4511 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
4514 #if ENABLE_HUSH_LOOPS
4515 /* Check syntax for "for" */
4516 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
4517 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
4519 /* current word is FOR or IN (BOLD in comments below) */
4520 if (cpipe->next == NULL) {
4521 syntax_error("malformed for");
4523 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
4526 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
4527 if (cpipe->next->res_word == RES_DO)
4529 /* next word is not "do". It must be "in" then ("FOR v in ...") */
4530 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
4531 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
4533 syntax_error("malformed for");
4535 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
4541 /* Past this point, all code paths should jump to ret: label
4542 * in order to return, no direct "return" statements please.
4543 * This helps to ensure that no memory is leaked. */
4551 last_rword = RES_XXXX;
4553 last_followup = PIPE_SEQ;
4554 rcode = G.last_exitcode;
4556 /* Go through list of pipes, (maybe) executing them. */
4557 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
4561 IF_HAS_KEYWORDS(rword = pi->res_word;)
4562 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
4563 rword, cond_code, last_rword);
4564 #if ENABLE_HUSH_LOOPS
4565 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
4566 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
4568 /* start of a loop: remember where loop starts */
4573 /* Still in the same "if...", "then..." or "do..." branch? */
4574 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
4575 if ((rcode == 0 && last_followup == PIPE_OR)
4576 || (rcode != 0 && last_followup == PIPE_AND)
4578 /* It is "<true> || CMD" or "<false> && CMD"
4579 * and we should not execute CMD */
4580 debug_printf_exec("skipped cmd because of || or &&\n");
4581 last_followup = pi->followup;
4585 last_followup = pi->followup;
4586 IF_HAS_KEYWORDS(last_rword = rword;)
4589 if (rword == RES_THEN) {
4590 /* if false; then ... fi has exitcode 0! */
4591 G.last_exitcode = rcode = EXIT_SUCCESS;
4592 /* "if <false> THEN cmd": skip cmd */
4596 if (rword == RES_ELSE || rword == RES_ELIF) {
4597 /* "if <true> then ... ELSE/ELIF cmd":
4598 * skip cmd and all following ones */
4603 #if ENABLE_HUSH_LOOPS
4604 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
4606 /* first loop through for */
4608 static const char encoded_dollar_at[] ALIGN1 = {
4609 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
4610 }; /* encoded representation of "$@" */
4611 static const char *const encoded_dollar_at_argv[] = {
4612 encoded_dollar_at, NULL
4613 }; /* argv list with one element: "$@" */
4616 vals = (char**)encoded_dollar_at_argv;
4617 if (pi->next->res_word == RES_IN) {
4618 /* if no variable values after "in" we skip "for" */
4619 if (!pi->next->cmds[0].argv) {
4620 G.last_exitcode = rcode = EXIT_SUCCESS;
4621 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
4624 vals = pi->next->cmds[0].argv;
4625 } /* else: "for var; do..." -> assume "$@" list */
4626 /* create list of variable values */
4627 debug_print_strings("for_list made from", vals);
4628 for_list = expand_strvec_to_strvec(vals);
4629 for_lcur = for_list;
4630 debug_print_strings("for_list", for_list);
4633 /* "for" loop is over, clean up */
4639 /* Insert next value from for_lcur */
4640 /* note: *for_lcur already has quotes removed, $var expanded, etc */
4641 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
4644 if (rword == RES_IN) {
4645 continue; /* "for v IN list;..." - "in" has no cmds anyway */
4647 if (rword == RES_DONE) {
4648 continue; /* "done" has no cmds too */
4651 #if ENABLE_HUSH_CASE
4652 if (rword == RES_CASE) {
4653 case_word = expand_strvec_to_string(pi->cmds->argv);
4656 if (rword == RES_MATCH) {
4659 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
4661 /* all prev words didn't match, does this one match? */
4662 argv = pi->cmds->argv;
4664 char *pattern = expand_string_to_string(*argv);
4665 /* TODO: which FNM_xxx flags to use? */
4666 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
4668 if (cond_code == 0) { /* match! we will execute this branch */
4669 free(case_word); /* make future "word)" stop */
4677 if (rword == RES_CASE_BODY) { /* inside of a case branch */
4679 continue; /* not matched yet, skip this pipe */
4682 /* Just pressing <enter> in shell should check for jobs.
4683 * OTOH, in non-interactive shell this is useless
4684 * and only leads to extra job checks */
4685 if (pi->num_cmds == 0) {
4686 if (G_interactive_fd)
4687 goto check_jobs_and_continue;
4691 /* After analyzing all keywords and conditions, we decided
4692 * to execute this pipe. NB: have to do checkjobs(NULL)
4693 * after run_pipe to collect any background children,
4694 * even if list execution is to be stopped. */
4695 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
4698 #if ENABLE_HUSH_LOOPS
4699 G.flag_break_continue = 0;
4701 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
4703 /* We ran a builtin, function, or group.
4704 * rcode is already known
4705 * and we don't need to wait for anything. */
4706 G.last_exitcode = rcode;
4707 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
4708 check_and_run_traps(0);
4709 #if ENABLE_HUSH_LOOPS
4710 /* Was it "break" or "continue"? */
4711 if (G.flag_break_continue) {
4712 smallint fbc = G.flag_break_continue;
4713 /* We might fall into outer *loop*,
4714 * don't want to break it too */
4716 G.depth_break_continue--;
4717 if (G.depth_break_continue == 0)
4718 G.flag_break_continue = 0;
4719 /* else: e.g. "continue 2" should *break* once, *then* continue */
4720 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
4721 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
4722 goto check_jobs_and_break;
4723 /* "continue": simulate end of loop */
4728 #if ENABLE_HUSH_FUNCTIONS
4729 if (G.flag_return_in_progress == 1) {
4730 /* same as "goto check_jobs_and_break" */
4735 } else if (pi->followup == PIPE_BG) {
4736 /* What does bash do with attempts to background builtins? */
4737 /* even bash 3.2 doesn't do that well with nested bg:
4738 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
4739 * I'm NOT treating inner &'s as jobs */
4740 check_and_run_traps(0);
4742 if (G.run_list_level == 1)
4745 G.last_exitcode = rcode = EXIT_SUCCESS;
4746 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
4749 if (G.run_list_level == 1 && G_interactive_fd) {
4750 /* Waits for completion, then fg's main shell */
4751 rcode = checkjobs_and_fg_shell(pi);
4752 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
4753 check_and_run_traps(0);
4756 { /* This one just waits for completion */
4757 rcode = checkjobs(pi);
4758 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
4759 check_and_run_traps(0);
4761 G.last_exitcode = rcode;
4765 /* Analyze how result affects subsequent commands */
4767 if (rword == RES_IF || rword == RES_ELIF)
4770 #if ENABLE_HUSH_LOOPS
4771 /* Beware of "while false; true; do ..."! */
4772 if (pi->next && pi->next->res_word == RES_DO) {
4773 if (rword == RES_WHILE) {
4775 /* "while false; do...done" - exitcode 0 */
4776 G.last_exitcode = rcode = EXIT_SUCCESS;
4777 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
4778 goto check_jobs_and_break;
4781 if (rword == RES_UNTIL) {
4783 debug_printf_exec(": until expr is true: breaking\n");
4784 check_jobs_and_break:
4792 check_jobs_and_continue:
4799 #if ENABLE_HUSH_LOOPS
4804 #if ENABLE_HUSH_CASE
4808 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
4812 /* Select which version we will use */
4813 static int run_and_free_list(struct pipe *pi)
4816 debug_printf_exec("run_and_free_list entered\n");
4818 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
4819 rcode = run_list(pi);
4821 /* free_pipe_list has the side effect of clearing memory.
4822 * In the long run that function can be merged with run_list,
4823 * but doing that now would hobble the debugging effort. */
4825 debug_printf_exec("run_and_free_list return %d\n", rcode);
4830 static struct pipe *new_pipe(void)
4833 pi = xzalloc(sizeof(struct pipe));
4834 /*pi->followup = 0; - deliberately invalid value */
4835 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
4839 /* Command (member of a pipe) is complete, or we start a new pipe
4840 * if ctx->command is NULL.
4841 * No errors possible here.
4843 static int done_command(struct parse_context *ctx)
4845 /* The command is really already in the pipe structure, so
4846 * advance the pipe counter and make a new, null command. */
4847 struct pipe *pi = ctx->pipe;
4848 struct command *command = ctx->command;
4851 if (IS_NULL_CMD(command)) {
4852 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
4856 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
4857 //debug_print_tree(ctx->list_head, 20);
4859 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
4862 /* Only real trickiness here is that the uncommitted
4863 * command structure is not counted in pi->num_cmds. */
4864 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
4865 ctx->command = command = &pi->cmds[pi->num_cmds];
4867 memset(command, 0, sizeof(*command));
4868 return pi->num_cmds; /* used only for 0/nonzero check */
4871 static void done_pipe(struct parse_context *ctx, pipe_style type)
4875 debug_printf_parse("done_pipe entered, followup %d\n", type);
4876 /* Close previous command */
4877 not_null = done_command(ctx);
4878 ctx->pipe->followup = type;
4880 ctx->pipe->pi_inverted = ctx->ctx_inverted;
4881 ctx->ctx_inverted = 0;
4882 ctx->pipe->res_word = ctx->ctx_res_w;
4885 /* Without this check, even just <enter> on command line generates
4886 * tree of three NOPs (!). Which is harmless but annoying.
4887 * IOW: it is safe to do it unconditionally. */
4890 || ctx->ctx_res_w == RES_FI
4892 #if ENABLE_HUSH_LOOPS
4893 || ctx->ctx_res_w == RES_DONE
4894 || ctx->ctx_res_w == RES_FOR
4895 || ctx->ctx_res_w == RES_IN
4897 #if ENABLE_HUSH_CASE
4898 || ctx->ctx_res_w == RES_ESAC
4902 debug_printf_parse("done_pipe: adding new pipe: "
4903 "not_null:%d ctx->ctx_res_w:%d\n",
4904 not_null, ctx->ctx_res_w);
4906 ctx->pipe->next = new_p;
4908 /* RES_THEN, RES_DO etc are "sticky" -
4909 * they remain set for pipes inside if/while.
4910 * This is used to control execution.
4911 * RES_FOR and RES_IN are NOT sticky (needed to support
4912 * cases where variable or value happens to match a keyword):
4914 #if ENABLE_HUSH_LOOPS
4915 if (ctx->ctx_res_w == RES_FOR
4916 || ctx->ctx_res_w == RES_IN)
4917 ctx->ctx_res_w = RES_NONE;
4919 #if ENABLE_HUSH_CASE
4920 if (ctx->ctx_res_w == RES_MATCH)
4921 ctx->ctx_res_w = RES_CASE_BODY;
4922 if (ctx->ctx_res_w == RES_CASE)
4923 ctx->ctx_res_w = RES_CASE_IN;
4925 ctx->command = NULL; /* trick done_command below */
4926 /* Create the memory for command, roughly:
4927 * ctx->pipe->cmds = new struct command;
4928 * ctx->command = &ctx->pipe->cmds[0];
4931 //debug_print_tree(ctx->list_head, 10);
4933 debug_printf_parse("done_pipe return\n");
4936 static void initialize_context(struct parse_context *ctx)
4938 memset(ctx, 0, sizeof(*ctx));
4939 ctx->pipe = ctx->list_head = new_pipe();
4940 /* Create the memory for command, roughly:
4941 * ctx->pipe->cmds = new struct command;
4942 * ctx->command = &ctx->pipe->cmds[0];
4947 /* If a reserved word is found and processed, parse context is modified
4948 * and 1 is returned.
4951 struct reserved_combo {
4954 unsigned char assignment_flag;
4958 FLAG_END = (1 << RES_NONE ),
4960 FLAG_IF = (1 << RES_IF ),
4961 FLAG_THEN = (1 << RES_THEN ),
4962 FLAG_ELIF = (1 << RES_ELIF ),
4963 FLAG_ELSE = (1 << RES_ELSE ),
4964 FLAG_FI = (1 << RES_FI ),
4966 # if ENABLE_HUSH_LOOPS
4967 FLAG_FOR = (1 << RES_FOR ),
4968 FLAG_WHILE = (1 << RES_WHILE),
4969 FLAG_UNTIL = (1 << RES_UNTIL),
4970 FLAG_DO = (1 << RES_DO ),
4971 FLAG_DONE = (1 << RES_DONE ),
4972 FLAG_IN = (1 << RES_IN ),
4974 # if ENABLE_HUSH_CASE
4975 FLAG_MATCH = (1 << RES_MATCH),
4976 FLAG_ESAC = (1 << RES_ESAC ),
4978 FLAG_START = (1 << RES_XXXX ),
4981 static const struct reserved_combo* match_reserved_word(o_string *word)
4983 /* Mostly a list of accepted follow-up reserved words.
4984 * FLAG_END means we are done with the sequence, and are ready
4985 * to turn the compound list into a command.
4986 * FLAG_START means the word must start a new compound list.
4988 static const struct reserved_combo reserved_list[] = {
4990 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
4991 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
4992 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
4993 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
4994 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
4995 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
4997 # if ENABLE_HUSH_LOOPS
4998 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
4999 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
5000 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
5001 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
5002 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
5003 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
5005 # if ENABLE_HUSH_CASE
5006 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
5007 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
5010 const struct reserved_combo *r;
5012 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
5013 if (strcmp(word->data, r->literal) == 0)
5018 /* Return 0: not a keyword, 1: keyword
5020 static int reserved_word(o_string *word, struct parse_context *ctx)
5022 # if ENABLE_HUSH_CASE
5023 static const struct reserved_combo reserved_match = {
5024 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
5027 const struct reserved_combo *r;
5031 r = match_reserved_word(word);
5035 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
5036 # if ENABLE_HUSH_CASE
5037 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
5038 /* "case word IN ..." - IN part starts first MATCH part */
5039 r = &reserved_match;
5042 if (r->flag == 0) { /* '!' */
5043 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
5044 syntax_error("! ! command");
5045 ctx->ctx_res_w = RES_SNTX;
5047 ctx->ctx_inverted = 1;
5050 if (r->flag & FLAG_START) {
5051 struct parse_context *old;
5053 old = xmalloc(sizeof(*old));
5054 debug_printf_parse("push stack %p\n", old);
5055 *old = *ctx; /* physical copy */
5056 initialize_context(ctx);
5058 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
5059 syntax_error_at(word->data);
5060 ctx->ctx_res_w = RES_SNTX;
5063 /* "{...} fi" is ok. "{...} if" is not
5065 * if { echo foo; } then { echo bar; } fi */
5066 if (ctx->command->group)
5067 done_pipe(ctx, PIPE_SEQ);
5070 ctx->ctx_res_w = r->res;
5071 ctx->old_flag = r->flag;
5072 word->o_assignment = r->assignment_flag;
5074 if (ctx->old_flag & FLAG_END) {
5075 struct parse_context *old;
5077 done_pipe(ctx, PIPE_SEQ);
5078 debug_printf_parse("pop stack %p\n", ctx->stack);
5080 old->command->group = ctx->list_head;
5081 old->command->cmd_type = CMD_NORMAL;
5083 o_addstr(&old->as_string, ctx->as_string.data);
5084 o_free_unsafe(&ctx->as_string);
5085 old->command->group_as_string = xstrdup(old->as_string.data);
5086 debug_printf_parse("pop, remembering as:'%s'\n",
5087 old->command->group_as_string);
5089 *ctx = *old; /* physical copy */
5094 #endif /* HAS_KEYWORDS */
5096 /* Word is complete, look at it and update parsing context.
5097 * Normal return is 0. Syntax errors return 1.
5098 * Note: on return, word is reset, but not o_free'd!
5100 static int done_word(o_string *word, struct parse_context *ctx)
5102 struct command *command = ctx->command;
5104 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
5105 if (word->length == 0 && word->o_quoted == 0) {
5106 debug_printf_parse("done_word return 0: true null, ignored\n");
5110 if (ctx->pending_redirect) {
5111 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
5112 * only if run as "bash", not "sh" */
5113 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
5115 * ...the word that follows the redirection operator
5116 * shall be subjected to tilde expansion, parameter expansion,
5117 * command substitution, arithmetic expansion, and quote
5118 * removal. Pathname expansion shall not be performed
5119 * on the word by a non-interactive shell; an interactive
5120 * shell may perform it, but shall do so only when
5121 * the expansion would result in one word."
5123 ctx->pending_redirect->rd_filename = xstrdup(word->data);
5124 /* Cater for >\file case:
5125 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
5126 * Same with heredocs:
5127 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
5129 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
5130 unbackslash(ctx->pending_redirect->rd_filename);
5131 /* Is it <<"HEREDOC"? */
5132 if (word->o_quoted) {
5133 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
5136 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
5137 ctx->pending_redirect = NULL;
5139 /* If this word wasn't an assignment, next ones definitely
5140 * can't be assignments. Even if they look like ones. */
5141 if (word->o_assignment != DEFINITELY_ASSIGNMENT
5142 && word->o_assignment != WORD_IS_KEYWORD
5144 word->o_assignment = NOT_ASSIGNMENT;
5146 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
5147 command->assignment_cnt++;
5148 word->o_assignment = MAYBE_ASSIGNMENT;
5152 # if ENABLE_HUSH_CASE
5153 if (ctx->ctx_dsemicolon
5154 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
5156 /* already done when ctx_dsemicolon was set to 1: */
5157 /* ctx->ctx_res_w = RES_MATCH; */
5158 ctx->ctx_dsemicolon = 0;
5161 if (!command->argv /* if it's the first word... */
5162 # if ENABLE_HUSH_LOOPS
5163 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
5164 && ctx->ctx_res_w != RES_IN
5166 # if ENABLE_HUSH_CASE
5167 && ctx->ctx_res_w != RES_CASE
5170 debug_printf_parse("checking '%s' for reserved-ness\n", word->data);
5171 if (reserved_word(word, ctx)) {
5172 o_reset_to_empty_unquoted(word);
5173 debug_printf_parse("done_word return %d\n",
5174 (ctx->ctx_res_w == RES_SNTX));
5175 return (ctx->ctx_res_w == RES_SNTX);
5177 # ifdef CMD_SINGLEWORD_NOGLOB_COND
5178 if (strcmp(word->data, "export") == 0
5179 # if ENABLE_HUSH_LOCAL
5180 || strcmp(word->data, "local") == 0
5183 command->cmd_type = CMD_SINGLEWORD_NOGLOB_COND;
5186 # if ENABLE_HUSH_BASH_COMPAT
5187 if (strcmp(word->data, "[[") == 0) {
5188 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
5194 if (command->group) {
5195 /* "{ echo foo; } echo bar" - bad */
5196 syntax_error_at(word->data);
5197 debug_printf_parse("done_word return 1: syntax error, "
5198 "groups and arglists don't mix\n");
5201 if (word->o_quoted /* word had "xx" or 'xx' at least as part of it. */
5202 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
5203 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
5204 /* (otherwise it's known to be not empty and is already safe) */
5206 /* exclude "$@" - it can expand to no word despite "" */
5207 char *p = word->data;
5208 while (p[0] == SPECIAL_VAR_SYMBOL
5209 && (p[1] & 0x7f) == '@'
5210 && p[2] == SPECIAL_VAR_SYMBOL
5214 if (p == word->data || p[0] != '\0') {
5215 /* saw no "$@", or not only "$@" but some
5216 * real text is there too */
5217 /* insert "empty variable" reference, this makes
5218 * e.g. "", $empty"" etc to not disappear */
5219 o_addchr(word, SPECIAL_VAR_SYMBOL);
5220 o_addchr(word, SPECIAL_VAR_SYMBOL);
5223 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
5224 debug_print_strings("word appended to argv", command->argv);
5227 #if ENABLE_HUSH_LOOPS
5228 if (ctx->ctx_res_w == RES_FOR) {
5230 || !is_well_formed_var_name(command->argv[0], '\0')
5232 /* bash says just "not a valid identifier" */
5233 syntax_error("not a valid identifier in for");
5236 /* Force FOR to have just one word (variable name) */
5237 /* NB: basically, this makes hush see "for v in ..."
5238 * syntax as if it is "for v; in ...". FOR and IN become
5239 * two pipe structs in parse tree. */
5240 done_pipe(ctx, PIPE_SEQ);
5243 #if ENABLE_HUSH_CASE
5244 /* Force CASE to have just one word */
5245 if (ctx->ctx_res_w == RES_CASE) {
5246 done_pipe(ctx, PIPE_SEQ);
5250 o_reset_to_empty_unquoted(word);
5252 debug_printf_parse("done_word return 0\n");
5257 /* Peek ahead in the input to find out if we have a "&n" construct,
5258 * as in "2>&1", that represents duplicating a file descriptor.
5260 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
5261 * REDIRFD_SYNTAX_ERR if syntax error,
5262 * REDIRFD_TO_FILE if no & was seen,
5263 * or the number found.
5266 #define parse_redir_right_fd(as_string, input) \
5267 parse_redir_right_fd(input)
5269 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
5275 return REDIRFD_TO_FILE;
5277 ch = i_getch(input); /* get the & */
5278 nommu_addchr(as_string, ch);
5281 ch = i_getch(input);
5282 nommu_addchr(as_string, ch);
5283 return REDIRFD_CLOSE;
5287 while (ch != EOF && isdigit(ch)) {
5288 d = d*10 + (ch-'0');
5290 ch = i_getch(input);
5291 nommu_addchr(as_string, ch);
5296 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
5298 bb_error_msg("ambiguous redirect");
5299 return REDIRFD_SYNTAX_ERR;
5302 /* Return code is 0 normal, 1 if a syntax error is detected
5304 static int parse_redirect(struct parse_context *ctx,
5307 struct in_str *input)
5309 struct command *command = ctx->command;
5310 struct redir_struct *redir;
5311 struct redir_struct **redirp;
5314 dup_num = REDIRFD_TO_FILE;
5315 if (style != REDIRECT_HEREDOC) {
5316 /* Check for a '>&1' type redirect */
5317 dup_num = parse_redir_right_fd(&ctx->as_string, input);
5318 if (dup_num == REDIRFD_SYNTAX_ERR)
5321 int ch = i_peek(input);
5322 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
5323 if (dup_num) { /* <<-... */
5324 ch = i_getch(input);
5325 nommu_addchr(&ctx->as_string, ch);
5330 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
5331 int ch = i_peek(input);
5333 /* >|FILE redirect ("clobbering" >).
5334 * Since we do not support "set -o noclobber" yet,
5335 * >| and > are the same for now. Just eat |.
5337 ch = i_getch(input);
5338 nommu_addchr(&ctx->as_string, ch);
5342 /* Create a new redir_struct and append it to the linked list */
5343 redirp = &command->redirects;
5344 while ((redir = *redirp) != NULL) {
5345 redirp = &(redir->next);
5347 *redirp = redir = xzalloc(sizeof(*redir));
5348 /* redir->next = NULL; */
5349 /* redir->rd_filename = NULL; */
5350 redir->rd_type = style;
5351 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
5353 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
5354 redir_table[style].descrip);
5356 redir->rd_dup = dup_num;
5357 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
5358 /* Erik had a check here that the file descriptor in question
5359 * is legit; I postpone that to "run time"
5360 * A "-" representation of "close me" shows up as a -3 here */
5361 debug_printf_parse("duplicating redirect '%d>&%d'\n",
5362 redir->rd_fd, redir->rd_dup);
5364 /* Set ctx->pending_redirect, so we know what to do at the
5365 * end of the next parsed word. */
5366 ctx->pending_redirect = redir;
5371 /* If a redirect is immediately preceded by a number, that number is
5372 * supposed to tell which file descriptor to redirect. This routine
5373 * looks for such preceding numbers. In an ideal world this routine
5374 * needs to handle all the following classes of redirects...
5375 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
5376 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
5377 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
5378 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
5380 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
5382 * ... If n is quoted, the number shall not be recognized as part of
5383 * the redirection expression. For example:
5385 * writes the character 2 into file a"
5386 * We are getting it right by setting ->o_quoted on any \<char>
5388 * A -1 return means no valid number was found,
5389 * the caller should use the appropriate default for this redirection.
5391 static int redirect_opt_num(o_string *o)
5395 if (o->data == NULL)
5397 num = bb_strtou(o->data, NULL, 10);
5398 if (errno || num < 0)
5400 o_reset_to_empty_unquoted(o);
5405 #define fetch_till_str(as_string, input, word, skip_tabs) \
5406 fetch_till_str(input, word, skip_tabs)
5408 static char *fetch_till_str(o_string *as_string,
5409 struct in_str *input,
5413 o_string heredoc = NULL_O_STRING;
5419 ch = i_getch(input);
5420 nommu_addchr(as_string, ch);
5422 if (strcmp(heredoc.data + past_EOL, word) == 0) {
5423 heredoc.data[past_EOL] = '\0';
5424 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
5425 return heredoc.data;
5428 o_addchr(&heredoc, ch);
5429 past_EOL = heredoc.length;
5432 ch = i_getch(input);
5433 nommu_addchr(as_string, ch);
5434 } while (skip_tabs && ch == '\t');
5435 } while (ch == '\n');
5438 o_free_unsafe(&heredoc);
5441 o_addchr(&heredoc, ch);
5442 nommu_addchr(as_string, ch);
5446 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
5447 * and load them all. There should be exactly heredoc_cnt of them.
5449 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
5451 struct pipe *pi = ctx->list_head;
5453 while (pi && heredoc_cnt) {
5455 struct command *cmd = pi->cmds;
5457 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
5459 cmd->argv ? cmd->argv[0] : "NONE");
5460 for (i = 0; i < pi->num_cmds; i++) {
5461 struct redir_struct *redir = cmd->redirects;
5463 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
5464 i, cmd->argv ? cmd->argv[0] : "NONE");
5466 if (redir->rd_type == REDIRECT_HEREDOC) {
5469 redir->rd_type = REDIRECT_HEREDOC2;
5470 /* redir->rd_dup is (ab)used to indicate <<- */
5471 p = fetch_till_str(&ctx->as_string, input,
5472 redir->rd_filename, redir->rd_dup & HEREDOC_SKIPTABS);
5474 syntax_error("unexpected EOF in here document");
5477 free(redir->rd_filename);
5478 redir->rd_filename = p;
5481 redir = redir->next;
5488 /* Should be 0. If it isn't, it's a parse error */
5490 bb_error_msg_and_die("heredoc BUG 2");
5496 #if ENABLE_HUSH_TICK
5497 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
5502 char **to_free = NULL;
5506 pid = BB_MMU ? fork() : vfork();
5508 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
5510 if (pid == 0) { /* child */
5511 disable_restore_tty_pgrp_on_exit();
5512 /* Process substitution is not considered to be usual
5513 * 'command execution'.
5514 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
5521 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
5522 close(channel[0]); /* NB: close _first_, then move fd! */
5523 xmove_fd(channel[1], 1);
5524 /* Prevent it from trying to handle ctrl-z etc */
5525 IF_HUSH_JOB(G.run_list_level = 1;)
5526 /* Awful hack for `trap` or $(trap).
5528 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
5529 * contains an example where "trap" is executed in a subshell:
5531 * save_traps=$(trap)
5533 * eval "$save_traps"
5535 * Standard does not say that "trap" in subshell shall print
5536 * parent shell's traps. It only says that its output
5537 * must have suitable form, but then, in the above example
5538 * (which is not supposed to be normative), it implies that.
5540 * bash (and probably other shell) does implement it
5541 * (traps are reset to defaults, but "trap" still shows them),
5542 * but as a result, "trap" logic is hopelessly messed up:
5545 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
5546 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
5547 * # true | trap <--- trap is in subshell - no output (ditto)
5548 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
5549 * trap -- 'echo Ho' SIGWINCH
5550 * # echo `(trap)` <--- in subshell in subshell - output
5551 * trap -- 'echo Ho' SIGWINCH
5552 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
5553 * trap -- 'echo Ho' SIGWINCH
5555 * The rules when to forget and when to not forget traps
5556 * get really complex and nonsensical.
5558 * Our solution: ONLY bare $(trap) or `trap` is special.
5560 s = skip_whitespace(s);
5561 if (strncmp(s, "trap", 4) == 0 && (*skip_whitespace(s + 4) == '\0'))
5563 static const char *const argv[] = { NULL, NULL };
5564 builtin_trap((char**)argv);
5565 exit(0); /* not _exit() - we need to fflush */
5568 reset_traps_to_defaults();
5569 parse_and_run_string(s);
5570 _exit(G.last_exitcode);
5572 /* We re-execute after vfork on NOMMU. This makes this script safe:
5573 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
5574 * huge=`cat BIG` # was blocking here forever
5577 re_execute_shell(&to_free,
5587 # if ENABLE_HUSH_FAST
5589 //bb_error_msg("[%d] fork in generate_stream_from_string: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5591 enable_restore_tty_pgrp_on_exit();
5596 close_on_exec_on(channel[0]);
5597 return xfdopen_for_read(channel[0]);
5600 /* Return code is exit status of the process that is run. */
5601 static int process_command_subs(o_string *dest, const char *s)
5604 struct in_str pipe_str;
5606 int status, ch, eol_cnt;
5608 fp = generate_stream_from_string(s, &pid);
5610 /* Now send results of command back into original context */
5611 setup_file_in_str(&pipe_str, fp);
5613 while ((ch = i_getch(&pipe_str)) != EOF) {
5619 o_addchr(dest, '\n');
5622 o_addQchr(dest, ch);
5625 debug_printf("done reading from `cmd` pipe, closing it\n");
5627 /* We need to extract exitcode. Test case
5628 * "true; echo `sleep 1; false` $?"
5630 safe_waitpid(pid, &status, 0);
5631 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
5632 return WEXITSTATUS(status);
5634 #endif /* ENABLE_HUSH_TICK */
5636 #if !ENABLE_HUSH_FUNCTIONS
5637 #define parse_group(dest, ctx, input, ch) \
5638 parse_group(ctx, input, ch)
5640 static int parse_group(o_string *dest, struct parse_context *ctx,
5641 struct in_str *input, int ch)
5643 /* dest contains characters seen prior to ( or {.
5644 * Typically it's empty, but for function defs,
5645 * it contains function name (without '()'). */
5646 struct pipe *pipe_list;
5648 struct command *command = ctx->command;
5650 debug_printf_parse("parse_group entered\n");
5651 #if ENABLE_HUSH_FUNCTIONS
5652 if (ch == '(' && !dest->o_quoted) {
5654 if (done_word(dest, ctx))
5657 goto skip; /* (... */
5658 if (command->argv[1]) { /* word word ... (... */
5659 syntax_error_unexpected_ch('(');
5662 /* it is "word(..." or "word (..." */
5664 ch = i_getch(input);
5665 while (ch == ' ' || ch == '\t');
5667 syntax_error_unexpected_ch(ch);
5670 nommu_addchr(&ctx->as_string, ch);
5672 ch = i_getch(input);
5673 while (ch == ' ' || ch == '\t' || ch == '\n');
5675 syntax_error_unexpected_ch(ch);
5678 nommu_addchr(&ctx->as_string, ch);
5679 command->cmd_type = CMD_FUNCDEF;
5684 #if 0 /* Prevented by caller */
5685 if (command->argv /* word [word]{... */
5686 || dest->length /* word{... */
5687 || dest->o_quoted /* ""{... */
5690 debug_printf_parse("parse_group return 1: "
5691 "syntax error, groups and arglists don't mix\n");
5696 #if ENABLE_HUSH_FUNCTIONS
5702 command->cmd_type = CMD_SUBSHELL;
5704 /* bash does not allow "{echo...", requires whitespace */
5705 ch = i_getch(input);
5706 if (ch != ' ' && ch != '\t' && ch != '\n') {
5707 syntax_error_unexpected_ch(ch);
5710 nommu_addchr(&ctx->as_string, ch);
5715 char *as_string = NULL;
5717 pipe_list = parse_stream(&as_string, input, endch);
5720 o_addstr(&ctx->as_string, as_string);
5722 /* empty ()/{} or parse error? */
5723 if (!pipe_list || pipe_list == ERR_PTR) {
5724 /* parse_stream already emitted error msg */
5728 debug_printf_parse("parse_group return 1: "
5729 "parse_stream returned %p\n", pipe_list);
5732 command->group = pipe_list;
5734 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
5735 command->group_as_string = as_string;
5736 debug_printf_parse("end of group, remembering as:'%s'\n",
5737 command->group_as_string);
5740 debug_printf_parse("parse_group return 0\n");
5742 /* command remains "open", available for possible redirects */
5745 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
5746 /* Subroutines for copying $(...) and `...` things */
5747 static void add_till_backquote(o_string *dest, struct in_str *input);
5749 static void add_till_single_quote(o_string *dest, struct in_str *input)
5752 int ch = i_getch(input);
5754 syntax_error_unterm_ch('\'');
5755 /*xfunc_die(); - redundant */
5762 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
5763 static void add_till_double_quote(o_string *dest, struct in_str *input)
5766 int ch = i_getch(input);
5768 syntax_error_unterm_ch('"');
5769 /*xfunc_die(); - redundant */
5773 if (ch == '\\') { /* \x. Copy both chars. */
5775 ch = i_getch(input);
5779 add_till_backquote(dest, input);
5783 //if (ch == '$') ...
5786 /* Process `cmd` - copy contents until "`" is seen. Complicated by
5788 * "Within the backquoted style of command substitution, backslash
5789 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
5790 * The search for the matching backquote shall be satisfied by the first
5791 * backquote found without a preceding backslash; during this search,
5792 * if a non-escaped backquote is encountered within a shell comment,
5793 * a here-document, an embedded command substitution of the $(command)
5794 * form, or a quoted string, undefined results occur. A single-quoted
5795 * or double-quoted string that begins, but does not end, within the
5796 * "`...`" sequence produces undefined results."
5798 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
5800 static void add_till_backquote(o_string *dest, struct in_str *input)
5803 int ch = i_getch(input);
5805 syntax_error_unterm_ch('`');
5806 /*xfunc_die(); - redundant */
5811 /* \x. Copy both chars unless it is \` */
5812 int ch2 = i_getch(input);
5814 syntax_error_unterm_ch('`');
5815 /*xfunc_die(); - redundant */
5817 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
5824 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
5825 * quoting and nested ()s.
5826 * "With the $(command) style of command substitution, all characters
5827 * following the open parenthesis to the matching closing parenthesis
5828 * constitute the command. Any valid shell script can be used for command,
5829 * except a script consisting solely of redirections which produces
5830 * unspecified results."
5832 * echo $(echo '(TEST)' BEST) (TEST) BEST
5833 * echo $(echo 'TEST)' BEST) TEST) BEST
5834 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
5836 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
5840 int ch = i_getch(input);
5842 syntax_error_unterm_ch(')');
5843 /*xfunc_die(); - redundant */
5851 if (i_peek(input) == ')') {
5859 add_till_single_quote(dest, input);
5864 add_till_double_quote(dest, input);
5869 /* \x. Copy verbatim. Important for \(, \) */
5870 ch = i_getch(input);
5872 syntax_error_unterm_ch(')');
5873 /*xfunc_die(); - redundant */
5880 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
5882 /* Return code: 0 for OK, 1 for syntax error */
5884 #define handle_dollar(as_string, dest, input) \
5885 handle_dollar(dest, input)
5887 static int handle_dollar(o_string *as_string,
5889 struct in_str *input)
5891 int ch = i_peek(input); /* first character after the $ */
5892 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
5894 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
5896 ch = i_getch(input);
5897 nommu_addchr(as_string, ch);
5899 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5901 debug_printf_parse(": '%c'\n", ch);
5902 o_addchr(dest, ch | quote_mask);
5905 if (!isalnum(ch) && ch != '_')
5907 ch = i_getch(input);
5908 nommu_addchr(as_string, ch);
5910 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5911 } else if (isdigit(ch)) {
5913 ch = i_getch(input);
5914 nommu_addchr(as_string, ch);
5915 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5916 debug_printf_parse(": '%c'\n", ch);
5917 o_addchr(dest, ch | quote_mask);
5918 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5919 } else switch (ch) {
5921 case '!': /* last bg pid */
5922 case '?': /* last exit code */
5923 case '#': /* number of args */
5924 case '*': /* args */
5925 case '@': /* args */
5926 goto make_one_char_var;
5928 bool first_char, all_digits;
5931 ch = i_getch(input);
5932 nommu_addchr(as_string, ch);
5933 o_addchr(dest, SPECIAL_VAR_SYMBOL);
5935 /* TODO: maybe someone will try to escape the '}' */
5940 ch = i_getch(input);
5941 nommu_addchr(as_string, ch);
5948 /* ${#var}: length of var contents */
5955 /* They're being verbose and doing ${?} */
5956 if (i_peek(input) == '}' && strchr("$!?#*@_", ch))
5961 && ( (all_digits && !isdigit(ch))
5962 || (!all_digits && !isalnum(ch) && ch != '_')
5965 /* handle parameter expansions
5966 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
5971 case ':': /* null modifier */
5972 if (expansion == 0) {
5973 debug_printf_parse(": null modifier\n");
5978 case '#': /* remove prefix */
5979 case '%': /* remove suffix */
5980 if (expansion == 0) {
5981 debug_printf_parse(": remove suffix/prefix\n");
5986 case '-': /* default value */
5987 case '=': /* assign default */
5988 case '+': /* alternative */
5989 case '?': /* error indicate */
5990 debug_printf_parse(": parameter expansion\n");
5995 syntax_error_unterm_str("${name}");
5996 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
6001 debug_printf_parse(": '%c'\n", ch);
6002 o_addchr(dest, ch | quote_mask);
6006 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6009 #if ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK
6014 ch = i_getch(input);
6015 nommu_addchr(as_string, ch);
6016 # if ENABLE_SH_MATH_SUPPORT
6017 if (i_peek(input) == '(') {
6018 ch = i_getch(input);
6019 nommu_addchr(as_string, ch);
6020 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6021 o_addchr(dest, /*quote_mask |*/ '+');
6025 add_till_closing_paren(dest, input, true);
6028 o_addstr(as_string, dest->data + pos);
6029 o_addchr(as_string, ')');
6030 o_addchr(as_string, ')');
6033 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6037 # if ENABLE_HUSH_TICK
6038 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6039 o_addchr(dest, quote_mask | '`');
6043 add_till_closing_paren(dest, input, false);
6046 o_addstr(as_string, dest->data + pos);
6047 o_addchr(as_string, ')');
6050 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6056 ch = i_getch(input);
6057 nommu_addchr(as_string, ch);
6059 if (isalnum(ch)) { /* it's $_name or $_123 */
6064 /* TODO: $_ and $-: */
6065 /* $_ Shell or shell script name; or last argument of last command
6066 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
6067 * but in command's env, set to full pathname used to invoke it */
6068 /* $- Option flags set by set builtin or shell options (-i etc) */
6070 o_addQchr(dest, '$');
6072 debug_printf_parse("handle_dollar return 0\n");
6077 #define parse_stream_dquoted(as_string, dest, input, dquote_end) \
6078 parse_stream_dquoted(dest, input, dquote_end)
6080 static int parse_stream_dquoted(o_string *as_string,
6082 struct in_str *input,
6089 ch = i_getch(input);
6091 nommu_addchr(as_string, ch);
6092 if (ch == dquote_end) { /* may be only '"' or EOF */
6093 if (dest->o_assignment == NOT_ASSIGNMENT)
6094 dest->o_escape ^= 1;
6095 debug_printf_parse("parse_stream_dquoted return 0\n");
6098 /* note: can't move it above ch == dquote_end check! */
6100 syntax_error_unterm_ch('"');
6101 /*xfunc_die(); - redundant */
6105 next = i_peek(input);
6107 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
6108 ch, ch, dest->o_escape);
6111 syntax_error("\\<eof>");
6115 * "The backslash retains its special meaning [in "..."]
6116 * only when followed by one of the following characters:
6117 * $, `, ", \, or <newline>. A double quote may be quoted
6118 * within double quotes by preceding it with a backslash."
6120 if (strchr("$`\"\\\n", next) != NULL) {
6121 ch = i_getch(input);
6123 o_addqchr(dest, ch);
6124 nommu_addchr(as_string, ch);
6127 o_addqchr(dest, '\\');
6128 nommu_addchr(as_string, '\\');
6133 if (handle_dollar(as_string, dest, input) != 0) {
6134 debug_printf_parse("parse_stream_dquoted return 1: "
6135 "handle_dollar returned non-0\n");
6140 #if ENABLE_HUSH_TICK
6142 //int pos = dest->length;
6143 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6144 o_addchr(dest, 0x80 | '`');
6145 add_till_backquote(dest, input);
6146 o_addchr(dest, SPECIAL_VAR_SYMBOL);
6147 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
6151 o_addQchr(dest, ch);
6153 && (dest->o_assignment == MAYBE_ASSIGNMENT
6154 || dest->o_assignment == WORD_IS_KEYWORD)
6155 && is_well_formed_var_name(dest->data, '=')
6157 dest->o_assignment = DEFINITELY_ASSIGNMENT;
6163 * Scan input until EOF or end_trigger char.
6164 * Return a list of pipes to execute, or NULL on EOF
6165 * or if end_trigger character is met.
6166 * On syntax error, exit is shell is not interactive,
6167 * reset parsing machinery and start parsing anew,
6168 * or return ERR_PTR.
6170 static struct pipe *parse_stream(char **pstring,
6171 struct in_str *input,
6174 struct parse_context ctx;
6175 o_string dest = NULL_O_STRING;
6179 /* Double-quote state is handled in the state variable is_in_dquote.
6180 * A single-quote triggers a bypass of the main loop until its mate is
6181 * found. When recursing, quote state is passed in via dest->o_escape.
6183 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
6184 end_trigger ? end_trigger : 'X');
6187 /* If very first arg is "" or '', dest.data may end up NULL.
6188 * Preventing this: */
6189 o_addchr(&dest, '\0');
6192 G.ifs = get_local_var_value("IFS");
6197 #if ENABLE_HUSH_INTERACTIVE
6198 input->promptmode = 0; /* PS1 */
6200 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
6201 initialize_context(&ctx);
6206 const char *is_special;
6210 redir_type redir_style;
6213 /* dest.o_quoted = 1; - already is (see below) */
6214 if (parse_stream_dquoted(&ctx.as_string, &dest, input, '"')) {
6217 /* We reached closing '"' */
6220 ch = i_getch(input);
6221 debug_printf_parse(": ch=%c (%d) escape=%d\n",
6222 ch, ch, dest.o_escape);
6227 syntax_error_unterm_str("here document");
6230 /* end_trigger == '}' case errors out earlier,
6231 * checking only ')' */
6232 if (end_trigger == ')') {
6233 syntax_error_unterm_ch('('); /* exits */
6234 /* goto parse_error; */
6237 if (done_word(&dest, &ctx)) {
6241 done_pipe(&ctx, PIPE_SEQ);
6243 /* If we got nothing... */
6244 /* (this makes bare "&" cmd a no-op.
6245 * bash says: "syntax error near unexpected token '&'") */
6246 if (pi->num_cmds == 0
6247 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
6253 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
6255 *pstring = ctx.as_string.data;
6257 o_free_unsafe(&ctx.as_string);
6260 debug_printf_parse("parse_stream return %p\n", pi);
6263 nommu_addchr(&ctx.as_string, ch);
6267 next = i_peek(input);
6269 is_special = "{}<>;&|()#'" /* special outside of "str" */
6270 "\\$\"" IF_HUSH_TICK("`"); /* always special */
6271 /* Are { and } special here? */
6272 if (ctx.command->argv /* word [word]{... - non-special */
6273 || dest.length /* word{... - non-special */
6274 || dest.o_quoted /* ""{... - non-special */
6275 || (next != ';' /* }; - special */
6276 && next != ')' /* }) - special */
6277 && next != '&' /* }& and }&& ... - special */
6278 && next != '|' /* }|| ... - special */
6279 && !strchr(G.ifs, next) /* {word - non-special */
6282 /* They are not special, skip "{}" */
6285 is_special = strchr(is_special, ch);
6286 is_ifs = strchr(G.ifs, ch);
6288 if (!is_special && !is_ifs) { /* ordinary char */
6290 o_addQchr(&dest, ch);
6291 if ((dest.o_assignment == MAYBE_ASSIGNMENT
6292 || dest.o_assignment == WORD_IS_KEYWORD)
6294 && is_well_formed_var_name(dest.data, '=')
6296 dest.o_assignment = DEFINITELY_ASSIGNMENT;
6302 if (done_word(&dest, &ctx)) {
6306 #if ENABLE_HUSH_CASE
6307 /* "case ... in <newline> word) ..." -
6308 * newlines are ignored (but ';' wouldn't be) */
6309 if (ctx.command->argv == NULL
6310 && ctx.ctx_res_w == RES_MATCH
6315 /* Treat newline as a command separator. */
6316 done_pipe(&ctx, PIPE_SEQ);
6317 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
6319 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
6324 dest.o_assignment = MAYBE_ASSIGNMENT;
6326 /* note: if (is_ifs) continue;
6327 * will still trigger for us */
6331 /* "cmd}" or "cmd }..." without semicolon or &:
6332 * } is an ordinary char in this case, even inside { cmd; }
6333 * Pathological example: { ""}; } should exec "}" cmd
6336 if (!IS_NULL_CMD(ctx.command) /* cmd } */
6337 || dest.length != 0 /* word} */
6338 || dest.o_quoted /* ""} */
6342 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
6343 goto skip_end_trigger;
6344 /* else: } does terminate a group */
6347 if (end_trigger && end_trigger == ch
6348 && (ch != ';' || heredoc_cnt == 0)
6349 #if ENABLE_HUSH_CASE
6351 || ctx.ctx_res_w != RES_MATCH
6352 || (!dest.o_quoted && strcmp(dest.data, "esac") == 0)
6357 /* This is technically valid:
6358 * { cat <<HERE; }; echo Ok
6362 * but we don't support this.
6363 * We require heredoc to be in enclosing {}/(),
6366 syntax_error_unterm_str("here document");
6369 if (done_word(&dest, &ctx)) {
6372 done_pipe(&ctx, PIPE_SEQ);
6373 dest.o_assignment = MAYBE_ASSIGNMENT;
6374 /* Do we sit outside of any if's, loops or case's? */
6376 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
6380 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
6382 *pstring = ctx.as_string.data;
6384 o_free_unsafe(&ctx.as_string);
6387 debug_printf_parse("parse_stream return %p: "
6388 "end_trigger char found\n",
6390 return ctx.list_head;
6397 /* Catch <, > before deciding whether this word is
6398 * an assignment. a=1 2>z b=2: b=2 is still assignment */
6401 redir_fd = redirect_opt_num(&dest);
6402 if (done_word(&dest, &ctx)) {
6405 redir_style = REDIRECT_OVERWRITE;
6407 redir_style = REDIRECT_APPEND;
6408 ch = i_getch(input);
6409 nommu_addchr(&ctx.as_string, ch);
6412 else if (next == '(') {
6413 syntax_error(">(process) not supported");
6417 if (parse_redirect(&ctx, redir_fd, redir_style, input))
6419 continue; /* back to top of while (1) */
6421 redir_fd = redirect_opt_num(&dest);
6422 if (done_word(&dest, &ctx)) {
6425 redir_style = REDIRECT_INPUT;
6427 redir_style = REDIRECT_HEREDOC;
6429 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
6430 ch = i_getch(input);
6431 nommu_addchr(&ctx.as_string, ch);
6432 } else if (next == '>') {
6433 redir_style = REDIRECT_IO;
6434 ch = i_getch(input);
6435 nommu_addchr(&ctx.as_string, ch);
6438 else if (next == '(') {
6439 syntax_error("<(process) not supported");
6443 if (parse_redirect(&ctx, redir_fd, redir_style, input))
6445 continue; /* back to top of while (1) */
6448 if (dest.o_assignment == MAYBE_ASSIGNMENT
6449 /* check that we are not in word in "a=1 2>word b=1": */
6450 && !ctx.pending_redirect
6452 /* ch is a special char and thus this word
6453 * cannot be an assignment */
6454 dest.o_assignment = NOT_ASSIGNMENT;
6457 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
6461 if (dest.length == 0) {
6464 if (ch == EOF || ch == '\n')
6467 /* note: we do not add it to &ctx.as_string */
6469 nommu_addchr(&ctx.as_string, '\n');
6471 o_addQchr(&dest, ch);
6476 syntax_error("\\<eof>");
6479 ch = i_getch(input);
6481 o_addchr(&dest, '\\');
6482 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
6483 o_addchr(&dest, ch);
6484 nommu_addchr(&ctx.as_string, ch);
6485 /* Example: echo Hello \2>file
6486 * we need to know that word 2 is quoted */
6491 /* It's "\<newline>". Remove trailing '\' from ctx.as_string */
6492 ctx.as_string.data[--ctx.as_string.length] = '\0';
6497 if (handle_dollar(&ctx.as_string, &dest, input) != 0) {
6498 debug_printf_parse("parse_stream parse error: "
6499 "handle_dollar returned non-0\n");
6506 ch = i_getch(input);
6508 syntax_error_unterm_ch('\'');
6509 /*xfunc_die(); - redundant */
6511 nommu_addchr(&ctx.as_string, ch);
6514 o_addqchr(&dest, ch);
6519 is_in_dquote ^= 1; /* invert */
6520 if (dest.o_assignment == NOT_ASSIGNMENT)
6523 #if ENABLE_HUSH_TICK
6528 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
6529 o_addchr(&dest, '`');
6533 add_till_backquote(&dest, input);
6535 o_addstr(&ctx.as_string, dest.data + pos);
6536 o_addchr(&ctx.as_string, '`');
6538 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
6539 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
6544 #if ENABLE_HUSH_CASE
6547 if (done_word(&dest, &ctx)) {
6550 done_pipe(&ctx, PIPE_SEQ);
6551 #if ENABLE_HUSH_CASE
6552 /* Eat multiple semicolons, detect
6553 * whether it means something special */
6558 ch = i_getch(input);
6559 nommu_addchr(&ctx.as_string, ch);
6560 if (ctx.ctx_res_w == RES_CASE_BODY) {
6561 ctx.ctx_dsemicolon = 1;
6562 ctx.ctx_res_w = RES_MATCH;
6568 /* We just finished a cmd. New one may start
6569 * with an assignment */
6570 dest.o_assignment = MAYBE_ASSIGNMENT;
6573 if (done_word(&dest, &ctx)) {
6577 ch = i_getch(input);
6578 nommu_addchr(&ctx.as_string, ch);
6579 done_pipe(&ctx, PIPE_AND);
6581 done_pipe(&ctx, PIPE_BG);
6585 if (done_word(&dest, &ctx)) {
6588 #if ENABLE_HUSH_CASE
6589 if (ctx.ctx_res_w == RES_MATCH)
6590 break; /* we are in case's "word | word)" */
6592 if (next == '|') { /* || */
6593 ch = i_getch(input);
6594 nommu_addchr(&ctx.as_string, ch);
6595 done_pipe(&ctx, PIPE_OR);
6597 /* we could pick up a file descriptor choice here
6598 * with redirect_opt_num(), but bash doesn't do it.
6599 * "echo foo 2| cat" yields "foo 2". */
6602 o_reset_to_empty_unquoted(&ctx.as_string);
6607 #if ENABLE_HUSH_CASE
6608 /* "case... in [(]word)..." - skip '(' */
6609 if (ctx.ctx_res_w == RES_MATCH
6610 && ctx.command->argv == NULL /* not (word|(... */
6611 && dest.length == 0 /* not word(... */
6612 && dest.o_quoted == 0 /* not ""(... */
6618 if (parse_group(&dest, &ctx, input, ch) != 0) {
6623 #if ENABLE_HUSH_CASE
6624 if (ctx.ctx_res_w == RES_MATCH)
6628 /* proper use of this character is caught by end_trigger:
6629 * if we see {, we call parse_group(..., end_trigger='}')
6630 * and it will match } earlier (not here). */
6631 syntax_error_unexpected_ch(ch);
6635 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
6641 struct parse_context *pctx;
6642 IF_HAS_KEYWORDS(struct parse_context *p2;)
6644 /* Clean up allocated tree.
6645 * Sample for finding leaks on syntax error recovery path.
6646 * Run it from interactive shell, watch pmap `pidof hush`.
6647 * while if false; then false; fi; do break; fi
6648 * Samples to catch leaks at execution:
6649 * while if (true | {true;}); then echo ok; fi; do break; done
6650 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
6654 /* Update pipe/command counts,
6655 * otherwise freeing may miss some */
6656 done_pipe(pctx, PIPE_SEQ);
6657 debug_printf_clean("freeing list %p from ctx %p\n",
6658 pctx->list_head, pctx);
6659 debug_print_tree(pctx->list_head, 0);
6660 free_pipe_list(pctx->list_head);
6661 debug_printf_clean("freed list %p\n", pctx->list_head);
6663 o_free_unsafe(&pctx->as_string);
6665 IF_HAS_KEYWORDS(p2 = pctx->stack;)
6669 IF_HAS_KEYWORDS(pctx = p2;)
6670 } while (HAS_KEYWORDS && pctx);
6671 /* Free text, clear all dest fields */
6673 /* If we are not in top-level parse, we return,
6674 * our caller will propagate error.
6676 if (end_trigger != ';') {
6684 /* Discard cached input, force prompt */
6686 IF_HUSH_INTERACTIVE(input->promptme = 1;)
6691 /* Executing from string: eval, sh -c '...'
6692 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
6693 * end_trigger controls how often we stop parsing
6694 * NUL: parse all, execute, return
6695 * ';': parse till ';' or newline, execute, repeat till EOF
6697 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
6699 /* Why we need empty flag?
6700 * An obscure corner case "false; ``; echo $?":
6701 * empty command in `` should still set $? to 0.
6702 * But we can't just set $? to 0 at the start,
6703 * this breaks "false; echo `echo $?`" case.
6707 struct pipe *pipe_list;
6709 pipe_list = parse_stream(NULL, inp, end_trigger);
6710 if (!pipe_list) { /* EOF */
6712 G.last_exitcode = 0;
6715 debug_print_tree(pipe_list, 0);
6716 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
6717 run_and_free_list(pipe_list);
6722 static void parse_and_run_string(const char *s)
6724 struct in_str input;
6725 setup_string_in_str(&input, s);
6726 parse_and_run_stream(&input, '\0');
6729 static void parse_and_run_file(FILE *f)
6731 struct in_str input;
6732 setup_file_in_str(&input, f);
6733 parse_and_run_stream(&input, ';');
6736 /* Called a few times only (or even once if "sh -c") */
6737 static void init_sigmasks(void)
6741 sigset_t old_blocked_set;
6743 if (!G.inherited_set_is_saved) {
6744 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
6745 G.inherited_set = G.blocked_set;
6747 old_blocked_set = G.blocked_set;
6749 mask = (1 << SIGQUIT);
6750 if (G_interactive_fd) {
6751 mask = (1 << SIGQUIT) | SPECIAL_INTERACTIVE_SIGS;
6752 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
6753 mask |= SPECIAL_JOB_SIGS;
6755 G.non_DFL_mask = mask;
6760 sigaddset(&G.blocked_set, sig);
6764 sigdelset(&G.blocked_set, SIGCHLD);
6766 if (memcmp(&old_blocked_set, &G.blocked_set, sizeof(old_blocked_set)) != 0)
6767 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
6769 /* POSIX allows shell to re-enable SIGCHLD
6770 * even if it was SIG_IGN on entry */
6771 #if ENABLE_HUSH_FAST
6772 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
6773 if (!G.inherited_set_is_saved)
6774 signal(SIGCHLD, SIGCHLD_handler);
6776 if (!G.inherited_set_is_saved)
6777 signal(SIGCHLD, SIG_DFL);
6780 G.inherited_set_is_saved = 1;
6785 static void maybe_set_to_sigexit(int sig)
6787 void (*handler)(int);
6788 /* non_DFL_mask'ed signals are, well, masked,
6789 * no need to set handler for them.
6791 if (!((G.non_DFL_mask >> sig) & 1)) {
6792 handler = signal(sig, sigexit);
6793 if (handler == SIG_IGN) /* oops... restore back to IGN! */
6794 signal(sig, handler);
6797 /* Set handlers to restore tty pgrp and exit */
6798 static void set_fatal_handlers(void)
6800 /* We _must_ restore tty pgrp on fatal signals */
6802 maybe_set_to_sigexit(SIGILL );
6803 maybe_set_to_sigexit(SIGFPE );
6804 maybe_set_to_sigexit(SIGBUS );
6805 maybe_set_to_sigexit(SIGSEGV);
6806 maybe_set_to_sigexit(SIGTRAP);
6807 } /* else: hush is perfect. what SEGV? */
6808 maybe_set_to_sigexit(SIGABRT);
6809 /* bash 3.2 seems to handle these just like 'fatal' ones */
6810 maybe_set_to_sigexit(SIGPIPE);
6811 maybe_set_to_sigexit(SIGALRM);
6812 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are masked.
6813 * if we aren't interactive... but in this case
6814 * we never want to restore pgrp on exit, and this fn is not called */
6815 /*maybe_set_to_sigexit(SIGHUP );*/
6816 /*maybe_set_to_sigexit(SIGTERM);*/
6817 /*maybe_set_to_sigexit(SIGINT );*/
6821 static int set_mode(const char cstate, const char mode)
6823 int state = (cstate == '-' ? 1 : 0);
6825 case 'n': G.fake_mode = state; break;
6826 case 'x': /*G.debug_mode = state;*/ break;
6827 default: return EXIT_FAILURE;
6829 return EXIT_SUCCESS;
6832 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
6833 int hush_main(int argc, char **argv)
6835 static const struct variable const_shell_ver = {
6837 .varstr = (char*)hush_version_str,
6838 .max_len = 1, /* 0 can provoke free(name) */
6843 unsigned builtin_argc;
6845 struct variable *cur_var;
6848 if (EXIT_SUCCESS) /* if EXIT_SUCCESS == 0, it is already done */
6849 G.last_exitcode = EXIT_SUCCESS;
6851 G.argv0_for_re_execing = argv[0];
6853 /* Deal with HUSH_VERSION */
6854 G.shell_ver = const_shell_ver; /* copying struct here */
6855 G.top_var = &G.shell_ver;
6856 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
6857 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
6858 /* Initialize our shell local variables with the values
6859 * currently living in the environment */
6860 cur_var = G.top_var;
6863 char *value = strchr(*e, '=');
6864 if (value) { /* paranoia */
6865 cur_var->next = xzalloc(sizeof(*cur_var));
6866 cur_var = cur_var->next;
6867 cur_var->varstr = *e;
6868 cur_var->max_len = strlen(*e);
6869 cur_var->flg_export = 1;
6873 /* reinstate HUSH_VERSION */
6874 debug_printf_env("putenv '%s'\n", hush_version_str);
6875 putenv((char *)hush_version_str);
6878 set_pwd_var(/*exp:*/ 1);
6879 /* bash also exports SHLVL and _,
6880 * and sets (but doesn't export) the following variables:
6882 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
6883 * BASH_VERSION='3.2.0(1)-release'
6885 * MACHTYPE=i386-pc-linux-gnu
6887 * HOSTNAME=<xxxxxxxxxx>
6888 * PPID=<NNNNN> - we also do it elsewhere
6899 * PIPESTATUS=([0]="0")
6900 * HISTFILE=/<xxx>/.bash_history
6904 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
6906 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
6916 #if ENABLE_FEATURE_EDITING
6917 G.line_input_state = new_line_input_t(FOR_SHELL);
6919 G.global_argc = argc;
6920 G.global_argv = argv;
6921 /* Initialize some more globals to non-zero values */
6922 cmdedit_update_prompt();
6924 if (setjmp(die_jmp)) {
6925 /* xfunc has failed! die die die */
6926 /* no EXIT traps, this is an escape hatch! */
6928 hush_exit(xfunc_error_retval);
6931 /* Shell is non-interactive at first. We need to call
6932 * init_sigmasks() if we are going to execute "sh <script>",
6933 * "sh -c <cmds>" or login shell's /etc/profile and friends.
6934 * If we later decide that we are interactive, we run init_sigmasks()
6935 * in order to intercept (more) signals.
6939 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
6942 opt = getopt(argc, argv, "+c:xins"
6945 # if ENABLE_HUSH_FUNCTIONS
6955 * sh ... -c 'script'
6956 * sh ... -c 'script' ARG0 [ARG1...]
6957 * On NOMMU, if builtin_argc != 0,
6958 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
6959 * "" needs to be replaced with NULL
6960 * and BARGV vector fed to builtin function.
6961 * Note: the form without ARG0 never happens:
6962 * sh ... -c 'builtin' BARGV... ""
6965 G.root_pid = getpid();
6966 G.root_ppid = getppid();
6968 G.global_argv = argv + optind;
6969 G.global_argc = argc - optind;
6971 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
6972 const struct built_in_command *x;
6975 x = find_builtin(optarg);
6976 if (x) { /* paranoia */
6977 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
6978 G.global_argv += builtin_argc;
6979 G.global_argv[-1] = NULL; /* replace "" */
6980 G.last_exitcode = x->b_function(argv + optind - 1);
6984 if (!G.global_argv[0]) {
6985 /* -c 'script' (no params): prevent empty $0 */
6986 G.global_argv--; /* points to argv[i] of 'script' */
6987 G.global_argv[0] = argv[0];
6989 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
6991 parse_and_run_string(optarg);
6994 /* Well, we cannot just declare interactiveness,
6995 * we have to have some stuff (ctty, etc) */
6996 /* G_interactive_fd++; */
6999 /* "-s" means "read from stdin", but this is how we always
7000 * operate, so simply do nothing here. */
7003 case '<': /* "big heredoc" support */
7004 full_write(STDOUT_FILENO, optarg, strlen(optarg));
7007 unsigned long long empty_trap_mask;
7009 G.root_pid = bb_strtou(optarg, &optarg, 16);
7011 G.root_ppid = bb_strtou(optarg, &optarg, 16);
7013 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
7015 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
7017 builtin_argc = bb_strtou(optarg, &optarg, 16);
7019 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
7020 if (empty_trap_mask != 0) {
7023 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7024 for (sig = 1; sig < NSIG; sig++) {
7025 if (empty_trap_mask & (1LL << sig)) {
7026 G.traps[sig] = xzalloc(1); /* == xstrdup(""); */
7027 sigaddset(&G.blocked_set, sig);
7030 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7032 # if ENABLE_HUSH_LOOPS
7034 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
7040 set_local_var(xstrdup(optarg), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ opt == 'R');
7042 # if ENABLE_HUSH_FUNCTIONS
7044 struct function *funcp = new_function(optarg);
7045 /* funcp->name is already set to optarg */
7046 /* funcp->body is set to NULL. It's a special case. */
7047 funcp->body_as_string = argv[optind];
7055 if (!set_mode('-', opt))
7059 fprintf(stderr, "Usage: sh [FILE]...\n"
7060 " or: sh -c command [args]...\n\n");
7066 } /* option parsing loop */
7069 G.root_pid = getpid();
7070 G.root_ppid = getppid();
7073 /* If we are login shell... */
7074 if (argv[0] && argv[0][0] == '-') {
7076 debug_printf("sourcing /etc/profile\n");
7077 input = fopen_for_read("/etc/profile");
7078 if (input != NULL) {
7079 close_on_exec_on(fileno(input));
7081 parse_and_run_file(input);
7084 /* bash: after sourcing /etc/profile,
7085 * tries to source (in the given order):
7086 * ~/.bash_profile, ~/.bash_login, ~/.profile,
7087 * stopping on first found. --noprofile turns this off.
7088 * bash also sources ~/.bash_logout on exit.
7089 * If called as sh, skips .bash_XXX files.
7096 * "bash <script>" (which is never interactive (unless -i?))
7097 * sources $BASH_ENV here (without scanning $PATH).
7098 * If called as sh, does the same but with $ENV.
7100 debug_printf("running script '%s'\n", argv[optind]);
7101 G.global_argv = argv + optind;
7102 G.global_argc = argc - optind;
7103 input = xfopen_for_read(argv[optind]);
7104 close_on_exec_on(fileno(input));
7106 parse_and_run_file(input);
7107 #if ENABLE_FEATURE_CLEAN_UP
7113 /* Up to here, shell was non-interactive. Now it may become one.
7114 * NB: don't forget to (re)run init_sigmasks() as needed.
7117 /* A shell is interactive if the '-i' flag was given,
7118 * or if all of the following conditions are met:
7120 * no arguments remaining or the -s flag given
7121 * standard input is a terminal
7122 * standard output is a terminal
7123 * Refer to Posix.2, the description of the 'sh' utility.
7126 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7127 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
7128 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
7129 if (G_saved_tty_pgrp < 0)
7130 G_saved_tty_pgrp = 0;
7132 /* try to dup stdin to high fd#, >= 255 */
7133 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7134 if (G_interactive_fd < 0) {
7135 /* try to dup to any fd */
7136 G_interactive_fd = dup(STDIN_FILENO);
7137 if (G_interactive_fd < 0) {
7139 G_interactive_fd = 0;
7140 G_saved_tty_pgrp = 0;
7143 // TODO: track & disallow any attempts of user
7144 // to (inadvertently) close/redirect G_interactive_fd
7146 debug_printf("interactive_fd:%d\n", G_interactive_fd);
7147 if (G_interactive_fd) {
7148 close_on_exec_on(G_interactive_fd);
7150 if (G_saved_tty_pgrp) {
7151 /* If we were run as 'hush &', sleep until we are
7152 * in the foreground (tty pgrp == our pgrp).
7153 * If we get started under a job aware app (like bash),
7154 * make sure we are now in charge so we don't fight over
7155 * who gets the foreground */
7157 pid_t shell_pgrp = getpgrp();
7158 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
7159 if (G_saved_tty_pgrp == shell_pgrp)
7161 /* send TTIN to ourself (should stop us) */
7162 kill(- shell_pgrp, SIGTTIN);
7166 /* Block some signals */
7169 if (G_saved_tty_pgrp) {
7170 /* Set other signals to restore saved_tty_pgrp */
7171 set_fatal_handlers();
7172 /* Put ourselves in our own process group
7173 * (bash, too, does this only if ctty is available) */
7174 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
7175 /* Grab control of the terminal */
7176 tcsetpgrp(G_interactive_fd, getpid());
7178 /* -1 is special - makes xfuncs longjmp, not exit
7179 * (we reset die_sleep = 0 whereever we [v]fork) */
7180 enable_restore_tty_pgrp_on_exit(); /* sets die_sleep = -1 */
7184 #elif ENABLE_HUSH_INTERACTIVE
7185 /* No job control compiled in, only prompt/line editing */
7186 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7187 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7188 if (G_interactive_fd < 0) {
7189 /* try to dup to any fd */
7190 G_interactive_fd = dup(STDIN_FILENO);
7191 if (G_interactive_fd < 0)
7193 G_interactive_fd = 0;
7196 if (G_interactive_fd) {
7197 close_on_exec_on(G_interactive_fd);
7201 /* We have interactiveness code disabled */
7205 * if interactive but not a login shell, sources ~/.bashrc
7206 * (--norc turns this off, --rcfile <file> overrides)
7209 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
7210 /* note: ash and hush share this string */
7211 printf("\n\n%s %s\n"
7212 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
7215 "hush - the humble shell"
7219 parse_and_run_file(stdin);
7222 #if ENABLE_FEATURE_CLEAN_UP
7223 if (G.cwd != bb_msg_unknown)
7225 cur_var = G.top_var->next;
7227 struct variable *tmp = cur_var;
7228 if (!cur_var->max_len)
7229 free(cur_var->varstr);
7230 cur_var = cur_var->next;
7234 hush_exit(G.last_exitcode);
7239 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7240 int lash_main(int argc, char **argv)
7242 bb_error_msg("lash is deprecated, please use hush instead");
7243 return hush_main(argc, argv);
7248 int msh_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7249 int msh_main(int argc, char **argv)
7251 //bb_error_msg("msh is deprecated, please use hush instead");
7252 return hush_main(argc, argv);
7260 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
7265 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
7272 return applet_main_func(argc, argv - argc);
7275 static int FAST_FUNC builtin_test(char **argv)
7277 return run_applet_main(argv, test_main);
7280 static int FAST_FUNC builtin_echo(char **argv)
7282 return run_applet_main(argv, echo_main);
7286 static int FAST_FUNC builtin_printf(char **argv)
7288 return run_applet_main(argv, printf_main);
7292 static char **skip_dash_dash(char **argv)
7295 if (argv[0] && argv[0][0] == '-' && argv[0][1] == '-' && argv[0][2] == '\0')
7300 static int FAST_FUNC builtin_eval(char **argv)
7302 int rcode = EXIT_SUCCESS;
7304 argv = skip_dash_dash(argv);
7306 char *str = expand_strvec_to_string(argv);
7308 * eval "echo Hi; done" ("done" is syntax error):
7309 * "echo Hi" will not execute too.
7311 parse_and_run_string(str);
7313 rcode = G.last_exitcode;
7318 static int FAST_FUNC builtin_cd(char **argv)
7322 argv = skip_dash_dash(argv);
7324 if (newdir == NULL) {
7325 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
7326 * bash says "bash: cd: HOME not set" and does nothing
7329 const char *home = get_local_var_value("HOME");
7330 newdir = home ? home : "/";
7332 if (chdir(newdir)) {
7333 /* Mimic bash message exactly */
7334 bb_perror_msg("cd: %s", newdir);
7335 return EXIT_FAILURE;
7337 /* Read current dir (get_cwd(1) is inside) and set PWD.
7338 * Note: do not enforce exporting. If PWD was unset or unexported,
7339 * set it again, but do not export. bash does the same.
7341 set_pwd_var(/*exp:*/ 0);
7342 return EXIT_SUCCESS;
7345 static int FAST_FUNC builtin_exec(char **argv)
7347 argv = skip_dash_dash(argv);
7348 if (argv[0] == NULL)
7349 return EXIT_SUCCESS; /* bash does this */
7351 /* Careful: we can end up here after [v]fork. Do not restore
7352 * tty pgrp then, only top-level shell process does that */
7353 if (G_saved_tty_pgrp && getpid() == G.root_pid)
7354 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
7356 /* TODO: if exec fails, bash does NOT exit! We do.
7357 * We'll need to undo sigprocmask (it's inside execvp_or_die)
7358 * and tcsetpgrp, and this is inherently racy.
7360 execvp_or_die(argv);
7363 static int FAST_FUNC builtin_exit(char **argv)
7365 debug_printf_exec("%s()\n", __func__);
7367 /* interactive bash:
7368 * # trap "echo EEE" EXIT
7371 * There are stopped jobs.
7372 * (if there are _stopped_ jobs, running ones don't count)
7375 # EEE (then bash exits)
7377 * we can use G.exiting = -1 as indicator "last cmd was exit"
7380 /* note: EXIT trap is run by hush_exit */
7381 argv = skip_dash_dash(argv);
7382 if (argv[0] == NULL)
7383 hush_exit(G.last_exitcode);
7384 /* mimic bash: exit 123abc == exit 255 + error msg */
7385 xfunc_error_retval = 255;
7386 /* bash: exit -2 == exit 254, no error msg */
7387 hush_exit(xatoi(argv[0]) & 0xff);
7390 static void print_escaped(const char *s)
7395 const char *p = strchrnul(s, '\'');
7396 /* print 'xxxx', possibly just '' */
7397 printf("'%.*s'", (int)(p - s), s);
7402 /* s points to '; print "'''...'''" */
7404 do putchar('\''); while (*++s == '\'');
7409 #if !ENABLE_HUSH_LOCAL
7410 #define helper_export_local(argv, exp, lvl) \
7411 helper_export_local(argv, exp)
7413 static void helper_export_local(char **argv, int exp, int lvl)
7418 /* So far we do not check that name is valid (TODO?) */
7420 if (strchr(name, '=') == NULL) {
7421 struct variable *var;
7423 var = get_local_var(name);
7424 if (exp == -1) { /* unexporting? */
7425 /* export -n NAME (without =VALUE) */
7427 var->flg_export = 0;
7428 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
7430 } /* else: export -n NOT_EXISTING_VAR: no-op */
7433 if (exp == 1) { /* exporting? */
7434 /* export NAME (without =VALUE) */
7436 var->flg_export = 1;
7437 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
7438 putenv(var->varstr);
7442 /* Exporting non-existing variable.
7443 * bash does not put it in environment,
7444 * but remembers that it is exported,
7445 * and does put it in env when it is set later.
7446 * We just set it to "" and export. */
7447 /* Or, it's "local NAME" (without =VALUE).
7448 * bash sets the value to "". */
7449 name = xasprintf("%s=", name);
7451 /* (Un)exporting/making local NAME=VALUE */
7452 name = xstrdup(name);
7454 set_local_var(name, /*exp:*/ exp, /*lvl:*/ lvl, /*ro:*/ 0);
7458 static int FAST_FUNC builtin_export(char **argv)
7460 unsigned opt_unexport;
7462 #if ENABLE_HUSH_EXPORT_N
7463 /* "!": do not abort on errors */
7464 opt_unexport = getopt32(argv, "!n");
7465 if (opt_unexport == (uint32_t)-1)
7466 return EXIT_FAILURE;
7473 if (argv[0] == NULL) {
7480 /* ash emits: export VAR='VAL'
7481 * bash: declare -x VAR="VAL"
7482 * we follow ash example */
7483 const char *s = *e++;
7484 const char *p = strchr(s, '=');
7486 if (!p) /* wtf? take next variable */
7489 printf("export %.*s", (int)(p - s) + 1, s);
7490 print_escaped(p + 1);
7494 /*fflush_all(); - done after each builtin anyway */
7496 return EXIT_SUCCESS;
7499 helper_export_local(argv, (opt_unexport ? -1 : 1), 0);
7501 return EXIT_SUCCESS;
7504 #if ENABLE_HUSH_LOCAL
7505 static int FAST_FUNC builtin_local(char **argv)
7507 if (G.func_nest_level == 0) {
7508 bb_error_msg("%s: not in a function", argv[0]);
7509 return EXIT_FAILURE; /* bash compat */
7511 helper_export_local(argv, 0, G.func_nest_level);
7512 return EXIT_SUCCESS;
7516 static int FAST_FUNC builtin_trap(char **argv)
7522 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7527 /* No args: print all trapped */
7528 for (i = 0; i < NSIG; ++i) {
7531 print_escaped(G.traps[i]);
7532 /* note: bash adds "SIG", but only if invoked
7533 * as "bash". If called as "sh", or if set -o posix,
7534 * then it prints short signal names.
7535 * We are printing short names: */
7536 printf(" %s\n", get_signame(i));
7539 /*fflush_all(); - done after each builtin anyway */
7540 return EXIT_SUCCESS;
7544 /* If first arg is a number: reset all specified signals */
7545 sig = bb_strtou(*argv, NULL, 10);
7551 sig = get_signum(*argv++);
7552 if (sig < 0 || sig >= NSIG) {
7554 /* Mimic bash message exactly */
7555 bb_perror_msg("trap: %s: invalid signal specification", argv[-1]);
7560 G.traps[sig] = xstrdup(new_cmd);
7562 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
7563 get_signame(sig), sig, G.traps[sig]);
7565 /* There is no signal for 0 (EXIT) */
7570 sigaddset(&G.blocked_set, sig);
7572 /* There was a trap handler, we are removing it
7573 * (if sig has non-DFL handling,
7574 * we don't need to do anything) */
7575 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
7577 sigdelset(&G.blocked_set, sig);
7580 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7584 if (!argv[1]) { /* no second arg */
7585 bb_error_msg("trap: invalid arguments");
7586 return EXIT_FAILURE;
7589 /* First arg is "-": reset all specified to default */
7590 /* First arg is "--": skip it, the rest is "handler SIGs..." */
7591 /* Everything else: set arg as signal handler
7592 * (includes "" case, which ignores signal) */
7593 if (argv[0][0] == '-') {
7594 if (argv[0][1] == '\0') { /* "-" */
7595 /* new_cmd remains NULL: "reset these sigs" */
7598 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
7601 /* else: "-something", no special meaning */
7606 goto process_sig_list;
7609 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
7610 static int FAST_FUNC builtin_type(char **argv)
7612 int ret = EXIT_SUCCESS;
7618 if (0) {} /* make conditional compile easier below */
7619 /*else if (find_alias(*argv))
7620 type = "an alias";*/
7621 #if ENABLE_HUSH_FUNCTIONS
7622 else if (find_function(*argv))
7623 type = "a function";
7625 else if (find_builtin(*argv))
7626 type = "a shell builtin";
7627 else if ((path = find_in_path(*argv)) != NULL)
7630 bb_error_msg("type: %s: not found", *argv);
7635 printf("%s is %s\n", *argv, type);
7643 /* built-in 'fg' and 'bg' handler */
7644 static int FAST_FUNC builtin_fg_bg(char **argv)
7649 if (!G_interactive_fd)
7650 return EXIT_FAILURE;
7652 /* If they gave us no args, assume they want the last backgrounded task */
7654 for (pi = G.job_list; pi; pi = pi->next) {
7655 if (pi->jobid == G.last_jobid) {
7659 bb_error_msg("%s: no current job", argv[0]);
7660 return EXIT_FAILURE;
7662 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
7663 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
7664 return EXIT_FAILURE;
7666 for (pi = G.job_list; pi; pi = pi->next) {
7667 if (pi->jobid == jobnum) {
7671 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
7672 return EXIT_FAILURE;
7674 /* TODO: bash prints a string representation
7675 * of job being foregrounded (like "sleep 1 | cat") */
7676 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
7677 /* Put the job into the foreground. */
7678 tcsetpgrp(G_interactive_fd, pi->pgrp);
7681 /* Restart the processes in the job */
7682 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
7683 for (i = 0; i < pi->num_cmds; i++) {
7684 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
7685 pi->cmds[i].is_stopped = 0;
7687 pi->stopped_cmds = 0;
7689 i = kill(- pi->pgrp, SIGCONT);
7691 if (errno == ESRCH) {
7692 delete_finished_bg_job(pi);
7693 return EXIT_SUCCESS;
7695 bb_perror_msg("kill (SIGCONT)");
7698 if (argv[0][0] == 'f') {
7700 return checkjobs_and_fg_shell(pi);
7702 return EXIT_SUCCESS;
7706 #if ENABLE_HUSH_HELP
7707 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
7709 const struct built_in_command *x;
7712 "Built-in commands:\n"
7713 "------------------\n");
7714 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
7716 printf("%-10s%s\n", x->b_cmd, x->b_descr);
7719 return EXIT_SUCCESS;
7724 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
7727 const char *status_string;
7729 for (job = G.job_list; job; job = job->next) {
7730 if (job->alive_cmds == job->stopped_cmds)
7731 status_string = "Stopped";
7733 status_string = "Running";
7735 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
7737 return EXIT_SUCCESS;
7742 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
7747 # ifdef M_TRIM_THRESHOLD
7748 /* Optional. Reduces probability of false positives */
7751 /* Crude attempt to find where "free memory" starts,
7752 * sans fragmentation. */
7754 l = (unsigned long)p;
7757 if (l < (unsigned long)p) l = (unsigned long)p;
7760 if (!G.memleak_value)
7761 G.memleak_value = l;
7763 l -= G.memleak_value;
7770 /* Exitcode is "how many kilobytes we leaked since 1st call" */
7775 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
7778 return EXIT_SUCCESS;
7781 static int FAST_FUNC builtin_read(char **argv)
7790 /* "!": do not abort on errors.
7791 * Option string must start with "sr" to match BUILTIN_READ_xxx
7793 read_flags = getopt32(argv, "!srn:p:t:u:", &opt_n, &opt_p, &opt_t, &opt_u);
7794 if (read_flags == (uint32_t)-1)
7795 return EXIT_FAILURE;
7798 r = shell_builtin_read(set_local_var_from_halves,
7800 get_local_var_value("IFS"), /* can be NULL */
7808 if ((uintptr_t)r > 1) {
7809 bb_error_msg("%s", r);
7810 r = (char*)(uintptr_t)1;
7813 return (uintptr_t)r;
7816 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
7817 * built-in 'set' handler
7819 * set [-abCefhmnuvx] [-o option] [argument...]
7820 * set [+abCefhmnuvx] [+o option] [argument...]
7821 * set -- [argument...]
7824 * Implementations shall support the options in both their hyphen and
7825 * plus-sign forms. These options can also be specified as options to sh.
7827 * Write out all variables and their values: set
7828 * Set $1, $2, and $3 and set "$#" to 3: set c a b
7829 * Turn on the -x and -v options: set -xv
7830 * Unset all positional parameters: set --
7831 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
7832 * Set the positional parameters to the expansion of x, even if x expands
7833 * with a leading '-' or '+': set -- $x
7835 * So far, we only support "set -- [argument...]" and some of the short names.
7837 static int FAST_FUNC builtin_set(char **argv)
7840 char **pp, **g_argv;
7841 char *arg = *++argv;
7845 for (e = G.top_var; e; e = e->next)
7847 return EXIT_SUCCESS;
7851 if (!strcmp(arg, "--")) {
7855 if (arg[0] != '+' && arg[0] != '-')
7857 for (n = 1; arg[n]; ++n)
7858 if (set_mode(arg[0], arg[n]))
7860 } while ((arg = *++argv) != NULL);
7861 /* Now argv[0] is 1st argument */
7864 return EXIT_SUCCESS;
7867 /* NB: G.global_argv[0] ($0) is never freed/changed */
7868 g_argv = G.global_argv;
7869 if (G.global_args_malloced) {
7875 G.global_args_malloced = 1;
7876 pp = xzalloc(sizeof(pp[0]) * 2);
7877 pp[0] = g_argv[0]; /* retain $0 */
7880 /* This realloc's G.global_argv */
7881 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
7888 return EXIT_SUCCESS;
7890 /* Nothing known, so abort */
7892 bb_error_msg("set: %s: invalid option", arg);
7893 return EXIT_FAILURE;
7896 static int FAST_FUNC builtin_shift(char **argv)
7899 argv = skip_dash_dash(argv);
7903 if (n >= 0 && n < G.global_argc) {
7904 if (G.global_args_malloced) {
7907 free(G.global_argv[m++]);
7910 memmove(&G.global_argv[1], &G.global_argv[n+1],
7911 G.global_argc * sizeof(G.global_argv[0]));
7912 return EXIT_SUCCESS;
7914 return EXIT_FAILURE;
7917 static int FAST_FUNC builtin_source(char **argv)
7919 char *arg_path, *filename;
7922 #if ENABLE_HUSH_FUNCTIONS
7926 argv = skip_dash_dash(argv);
7929 /* bash says: "bash: .: filename argument required" */
7930 return 2; /* bash compat */
7933 if (!strchr(filename, '/')) {
7934 arg_path = find_in_path(filename);
7936 filename = arg_path;
7938 input = fopen_or_warn(filename, "r");
7941 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
7942 return EXIT_FAILURE;
7944 close_on_exec_on(fileno(input));
7946 #if ENABLE_HUSH_FUNCTIONS
7947 sv_flg = G.flag_return_in_progress;
7948 /* "we are inside sourced file, ok to use return" */
7949 G.flag_return_in_progress = -1;
7951 save_and_replace_G_args(&sv, argv);
7953 parse_and_run_file(input);
7956 restore_G_args(&sv, argv);
7957 #if ENABLE_HUSH_FUNCTIONS
7958 G.flag_return_in_progress = sv_flg;
7961 return G.last_exitcode;
7964 static int FAST_FUNC builtin_umask(char **argv)
7970 argv = skip_dash_dash(argv);
7972 mode_t old_mask = mask;
7975 rc = bb_parse_mode(argv[0], &mask);
7980 * bash: umask: 'q': invalid symbolic mode operator
7981 * bash: umask: 999: octal number out of range
7983 bb_error_msg("%s: invalid mode '%s'", "umask", argv[0]);
7988 printf("%04o\n", (unsigned) mask);
7989 /* fall through and restore mask which we set to 0 */
7993 return !rc; /* rc != 0 - success */
7996 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
7997 static int FAST_FUNC builtin_unset(char **argv)
8002 /* "!": do not abort on errors */
8003 /* "+": stop at 1st non-option */
8004 opts = getopt32(argv, "!+vf");
8005 if (opts == (unsigned)-1)
8006 return EXIT_FAILURE;
8008 bb_error_msg("unset: -v and -f are exclusive");
8009 return EXIT_FAILURE;
8015 if (!(opts & 2)) { /* not -f */
8016 if (unset_local_var(*argv)) {
8017 /* unset <nonexistent_var> doesn't fail.
8018 * Error is when one tries to unset RO var.
8019 * Message was printed by unset_local_var. */
8023 #if ENABLE_HUSH_FUNCTIONS
8033 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
8034 static int FAST_FUNC builtin_wait(char **argv)
8036 int ret = EXIT_SUCCESS;
8039 argv = skip_dash_dash(argv);
8040 if (argv[0] == NULL) {
8041 /* Don't care about wait results */
8042 /* Note 1: must wait until there are no more children */
8043 /* Note 2: must be interruptible */
8045 * $ sleep 3 & sleep 6 & wait
8050 * $ sleep 3 & sleep 6 & wait
8054 * ^C <-- after ~4 sec from keyboard
8057 sigaddset(&G.blocked_set, SIGCHLD);
8058 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8061 if (errno == ECHILD)
8063 /* Wait for SIGCHLD or any other signal of interest */
8064 /* sigtimedwait with infinite timeout: */
8065 sig = sigwaitinfo(&G.blocked_set, NULL);
8067 sig = check_and_run_traps(sig);
8068 if (sig && sig != SIGCHLD) { /* see note 2 */
8074 sigdelset(&G.blocked_set, SIGCHLD);
8075 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8079 /* This is probably buggy wrt interruptible-ness */
8081 pid_t pid = bb_strtou(*argv, NULL, 10);
8083 /* mimic bash message */
8084 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
8085 return EXIT_FAILURE;
8087 if (waitpid(pid, &status, 0) == pid) {
8088 if (WIFSIGNALED(status))
8089 ret = 128 + WTERMSIG(status);
8090 else if (WIFEXITED(status))
8091 ret = WEXITSTATUS(status);
8095 bb_perror_msg("wait %s", *argv);
8104 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
8105 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
8108 def = bb_strtou(argv[1], NULL, 10);
8109 if (errno || def < def_min || argv[2]) {
8110 bb_error_msg("%s: bad arguments", argv[0]);
8118 #if ENABLE_HUSH_LOOPS
8119 static int FAST_FUNC builtin_break(char **argv)
8122 if (G.depth_of_loop == 0) {
8123 bb_error_msg("%s: only meaningful in a loop", argv[0]);
8124 return EXIT_SUCCESS; /* bash compat */
8126 G.flag_break_continue++; /* BC_BREAK = 1 */
8128 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
8129 if (depth == UINT_MAX)
8130 G.flag_break_continue = BC_BREAK;
8131 if (G.depth_of_loop < depth)
8132 G.depth_break_continue = G.depth_of_loop;
8134 return EXIT_SUCCESS;
8137 static int FAST_FUNC builtin_continue(char **argv)
8139 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
8140 return builtin_break(argv);
8144 #if ENABLE_HUSH_FUNCTIONS
8145 static int FAST_FUNC builtin_return(char **argv)
8149 if (G.flag_return_in_progress != -1) {
8150 bb_error_msg("%s: not in a function or sourced script", argv[0]);
8151 return EXIT_FAILURE; /* bash compat */
8154 G.flag_return_in_progress = 1;
8157 * out of range: wraps around at 256, does not error out
8158 * non-numeric param:
8159 * f() { false; return qwe; }; f; echo $?
8160 * bash: return: qwe: numeric argument required <== we do this
8161 * 255 <== we also do this
8163 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);