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>
11 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
14 * The parser routines proper are all original material, first
15 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
16 * execution engine, the builtins, and much of the underlying
17 * support has been adapted from busybox-0.49pre's lash, which is
18 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
19 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
20 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
21 * Troan, which they placed in the public domain. I don't know
22 * how much of the Johnson/Troan code has survived the repeated
26 * o_addchr derived from similar w_addchar function in glibc-2.2.
27 * parse_redirect, redirect_opt_num, and big chunks of main
28 * and many builtins derived from contributions by Erik Andersen.
29 * Miscellaneous bugfixes from Matt Kraai.
31 * There are two big (and related) architecture differences between
32 * this parser and the lash parser. One is that this version is
33 * actually designed from the ground up to understand nearly all
34 * of the Bourne grammar. The second, consequential change is that
35 * the parser and input reader have been turned inside out. Now,
36 * the parser is in control, and asks for input as needed. The old
37 * way had the input reader in control, and it asked for parsing to
38 * take place as needed. The new way makes it much easier to properly
39 * handle the recursion implicit in the various substitutions, especially
40 * across continuation lines.
43 * grep for "TODO" and fix (some of them are easy)
44 * special variables (done: PWD, PPID, RANDOM)
47 * follow IFS rules more precisely, including update semantics
48 * builtins mandated by standards we don't support:
49 * [un]alias, command, fc, getopts, newgrp, readonly, times
50 * make complex ${var%...} constructs support optional
51 * make here documents optional
54 * redirection of stdout+stderr: &> and >&
55 * reserved words: function select
56 * advanced test: [[ ]]
57 * process substitution: <(list) and >(list)
60 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
61 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
62 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
64 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
65 * This is exactly equivalent to let "EXPR".
66 * $[EXPR]: synonym for $((EXPR))
69 * In bash, export builtin is special, its arguments are assignments
70 * and therefore expansion of them should be "one-word" expansion:
71 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
73 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
74 * ls: cannot access i=a: No such file or directory
75 * ls: cannot access b: No such file or directory
76 * Note1: same applies to local builtin.
77 * Note2: bash 3.2.33(1) does this only if export word itself
79 * $ export i=`echo 'aaa bbb'`; echo "$i"
81 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
84 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
85 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
86 || defined(__APPLE__) \
88 # include <malloc.h> /* for malloc_trim */
91 /* #include <dmalloc.h> */
96 #include "shell_common.h"
99 #if ENABLE_HUSH_RANDOM_SUPPORT
102 # define CLEAR_RANDOM_T(rnd) ((void)0)
105 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
108 //applet:IF_HUSH(APPLET(hush, _BB_DIR_BIN, _BB_SUID_DROP))
109 //applet:IF_MSH(APPLET(msh, _BB_DIR_BIN, _BB_SUID_DROP))
110 //applet:IF_FEATURE_SH_IS_HUSH(APPLET_ODDNAME(sh, hush, _BB_DIR_BIN, _BB_SUID_DROP, sh))
111 //applet:IF_FEATURE_BASH_IS_HUSH(APPLET_ODDNAME(bash, hush, _BB_DIR_BIN, _BB_SUID_DROP, bash))
113 //kbuild:lib-$(CONFIG_HUSH) += hush.o match.o shell_common.o
114 //kbuild:lib-$(CONFIG_HUSH_RANDOM_SUPPORT) += random.o
117 //config: bool "hush"
120 //config: hush is a small shell (25k). It handles the normal flow control
121 //config: constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
122 //config: case/esac. Redirections, here documents, $((arithmetic))
123 //config: and functions are supported.
125 //config: It will compile and work on no-mmu systems.
127 //config: It does not handle select, aliases, tilde expansion,
128 //config: &>file and >&file redirection of stdout+stderr.
130 //config:config HUSH_BASH_COMPAT
131 //config: bool "bash-compatible extensions"
133 //config: depends on HUSH
135 //config: Enable bash-compatible extensions.
137 //config:config HUSH_BRACE_EXPANSION
138 //config: bool "Brace expansion"
140 //config: depends on HUSH_BASH_COMPAT
142 //config: Enable {abc,def} extension.
144 //config:config HUSH_HELP
145 //config: bool "help builtin"
147 //config: depends on HUSH
149 //config: Enable help builtin in hush. Code size + ~1 kbyte.
151 //config:config HUSH_INTERACTIVE
152 //config: bool "Interactive mode"
154 //config: depends on HUSH
156 //config: Enable interactive mode (prompt and command editing).
157 //config: Without this, hush simply reads and executes commands
158 //config: from stdin just like a shell script from a file.
159 //config: No prompt, no PS1/PS2 magic shell variables.
161 //config:config HUSH_SAVEHISTORY
162 //config: bool "Save command history to .hush_history"
164 //config: depends on HUSH_INTERACTIVE && FEATURE_EDITING_SAVEHISTORY
166 //config: Enable history saving in hush.
168 //config:config HUSH_JOB
169 //config: bool "Job control"
171 //config: depends on HUSH_INTERACTIVE
173 //config: Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
174 //config: command (not entire shell), fg/bg builtins work. Without this option,
175 //config: "cmd &" still works by simply spawning a process and immediately
176 //config: prompting for next command (or executing next command in a script),
177 //config: but no separate process group is formed.
179 //config:config HUSH_TICK
180 //config: bool "Process substitution"
182 //config: depends on HUSH
184 //config: Enable process substitution `command` and $(command) in hush.
186 //config:config HUSH_IF
187 //config: bool "Support if/then/elif/else/fi"
189 //config: depends on HUSH
191 //config: Enable if/then/elif/else/fi in hush.
193 //config:config HUSH_LOOPS
194 //config: bool "Support for, while and until loops"
196 //config: depends on HUSH
198 //config: Enable for, while and until loops in hush.
200 //config:config HUSH_CASE
201 //config: bool "Support case ... esac statement"
203 //config: depends on HUSH
205 //config: Enable case ... esac statement in hush. +400 bytes.
207 //config:config HUSH_FUNCTIONS
208 //config: bool "Support funcname() { commands; } syntax"
210 //config: depends on HUSH
212 //config: Enable support for shell functions in hush. +800 bytes.
214 //config:config HUSH_LOCAL
215 //config: bool "Support local builtin"
217 //config: depends on HUSH_FUNCTIONS
219 //config: Enable support for local variables in functions.
221 //config:config HUSH_RANDOM_SUPPORT
222 //config: bool "Pseudorandom generator and $RANDOM variable"
224 //config: depends on HUSH
226 //config: Enable pseudorandom generator and dynamic variable "$RANDOM".
227 //config: Each read of "$RANDOM" will generate a new pseudorandom value.
229 //config:config HUSH_EXPORT_N
230 //config: bool "Support 'export -n' option"
232 //config: depends on HUSH
234 //config: export -n unexports variables. It is a bash extension.
236 //config:config HUSH_MODE_X
237 //config: bool "Support 'hush -x' option and 'set -x' command"
239 //config: depends on HUSH
241 //config: This instructs hush to print commands before execution.
242 //config: Adds ~300 bytes.
245 //config: bool "msh (deprecated: aliased to hush)"
247 //config: select HUSH
249 //config: msh is deprecated and will be removed, please migrate to hush.
252 /* -i (interactive) and -s (read stdin) are also accepted,
253 * but currently do nothing, therefore aren't shown in help.
254 * NOMMU-specific options are not meant to be used by users,
255 * therefore we don't show them either.
257 //usage:#define hush_trivial_usage
258 //usage: "[-nx] [-c SCRIPT]"
259 //usage:#define hush_full_usage ""
260 //usage:#define msh_trivial_usage hush_trivial_usage
261 //usage:#define msh_full_usage ""
262 //usage:#define sh_trivial_usage NOUSAGE_STR
263 //usage:#define sh_full_usage ""
264 //usage:#define bash_trivial_usage NOUSAGE_STR
265 //usage:#define bash_full_usage ""
269 #define LEAK_HUNTING 0
270 #define BUILD_AS_NOMMU 0
271 /* Enable/disable sanity checks. Ok to enable in production,
272 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
273 * Keeping 1 for now even in released versions.
276 /* Slightly bigger (+200 bytes), but faster hush.
277 * So far it only enables a trick with counting SIGCHLDs and forks,
278 * which allows us to do fewer waitpid's.
279 * (we can detect a case where neither forks were done nor SIGCHLDs happened
280 * and therefore waitpid will return the same result as last time)
282 #define ENABLE_HUSH_FAST 0
283 /* TODO: implement simplified code for users which do not need ${var%...} ops
284 * So far ${var%...} ops are always enabled:
286 #define ENABLE_HUSH_DOLLAR_OPS 1
291 # undef USE_FOR_NOMMU
294 # define USE_FOR_NOMMU(...) __VA_ARGS__
295 # define USE_FOR_MMU(...)
298 #include "NUM_APPLETS.h"
300 /* STANDALONE does not make sense, and won't compile */
301 # undef CONFIG_FEATURE_SH_STANDALONE
302 # undef ENABLE_FEATURE_SH_STANDALONE
303 # undef IF_FEATURE_SH_STANDALONE
304 # undef IF_NOT_FEATURE_SH_STANDALONE
305 # define ENABLE_FEATURE_SH_STANDALONE 0
306 # define IF_FEATURE_SH_STANDALONE(...)
307 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
310 #if !ENABLE_HUSH_INTERACTIVE
311 # undef ENABLE_FEATURE_EDITING
312 # define ENABLE_FEATURE_EDITING 0
313 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
314 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
317 /* Do we support ANY keywords? */
318 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
319 # define HAS_KEYWORDS 1
320 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
321 # define IF_HAS_NO_KEYWORDS(...)
323 # define HAS_KEYWORDS 0
324 # define IF_HAS_KEYWORDS(...)
325 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
328 /* If you comment out one of these below, it will be #defined later
329 * to perform debug printfs to stderr: */
330 #define debug_printf(...) do {} while (0)
331 /* Finer-grained debug switches */
332 #define debug_printf_parse(...) do {} while (0)
333 #define debug_print_tree(a, b) do {} while (0)
334 #define debug_printf_exec(...) do {} while (0)
335 #define debug_printf_env(...) do {} while (0)
336 #define debug_printf_jobs(...) do {} while (0)
337 #define debug_printf_expand(...) do {} while (0)
338 #define debug_printf_varexp(...) do {} while (0)
339 #define debug_printf_glob(...) do {} while (0)
340 #define debug_printf_list(...) do {} while (0)
341 #define debug_printf_subst(...) do {} while (0)
342 #define debug_printf_clean(...) do {} while (0)
344 #define ERR_PTR ((void*)(long)1)
346 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
348 #define _SPECIAL_VARS_STR "_*@$!?#"
349 #define SPECIAL_VARS_STR ("_*@$!?#" + 1)
350 #define NUMERIC_SPECVARS_STR ("_*@$!?#" + 3)
351 #if ENABLE_HUSH_BASH_COMPAT
352 /* Support / and // replace ops */
353 /* Note that // is stored as \ in "encoded" string representation */
354 # define VAR_ENCODED_SUBST_OPS "\\/%#:-=+?"
355 # define VAR_SUBST_OPS ("\\/%#:-=+?" + 1)
356 # define MINUS_PLUS_EQUAL_QUESTION ("\\/%#:-=+?" + 5)
358 # define VAR_ENCODED_SUBST_OPS "%#:-=+?"
359 # define VAR_SUBST_OPS "%#:-=+?"
360 # define MINUS_PLUS_EQUAL_QUESTION ("%#:-=+?" + 3)
363 #define SPECIAL_VAR_SYMBOL 3
367 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
369 /* This supports saving pointers malloced in vfork child,
370 * to be freed in the parent.
373 typedef struct nommu_save_t {
375 struct variable *old_vars;
377 char **argv_from_re_execing;
390 #if ENABLE_HUSH_LOOPS
397 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
402 /* three pseudo-keywords support contrived "case" syntax: */
403 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
404 RES_MATCH , /* "word)" */
405 RES_CASE_BODY, /* "this command is inside CASE" */
412 typedef struct o_string {
414 int length; /* position where data is appended */
417 /* At least some part of the string was inside '' or "",
418 * possibly empty one: word"", wo''rd etc. */
419 smallint has_quoted_part;
420 smallint has_empty_slot;
421 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
424 EXP_FLAG_SINGLEWORD = 0x80, /* must be 0x80 */
426 /* Protect newly added chars against globbing
427 * by prepending \ to *, ?, [, \ */
428 EXP_FLAG_ESC_GLOB_CHARS = 0x1,
431 MAYBE_ASSIGNMENT = 0,
432 DEFINITELY_ASSIGNMENT = 1,
434 /* Not an assigment, but next word may be: "if v=xyz cmd;" */
437 /* Used for initialization: o_string foo = NULL_O_STRING; */
438 #define NULL_O_STRING { NULL }
440 /* I can almost use ordinary FILE*. Is open_memstream() universally
441 * available? Where is it documented? */
442 typedef struct in_str {
444 /* eof_flag=1: last char in ->p is really an EOF */
445 char eof_flag; /* meaningless if ->p == NULL */
447 #if ENABLE_HUSH_INTERACTIVE
449 smallint promptmode; /* 0: PS1, 1: PS2 */
452 int (*get) (struct in_str *) FAST_FUNC;
453 int (*peek) (struct in_str *) FAST_FUNC;
455 #define i_getch(input) ((input)->get(input))
456 #define i_peek(input) ((input)->peek(input))
458 /* The descrip member of this structure is only used to make
459 * debugging output pretty */
460 static const struct {
462 signed char default_fd;
465 { O_RDONLY, 0, "<" },
466 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
467 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
468 { O_CREAT|O_RDWR, 1, "<>" },
469 { O_RDONLY, 0, "<<" },
470 /* Should not be needed. Bogus default_fd helps in debugging */
471 /* { O_RDONLY, 77, "<<" }, */
474 struct redir_struct {
475 struct redir_struct *next;
476 char *rd_filename; /* filename */
477 int rd_fd; /* fd to redirect */
478 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
480 smallint rd_type; /* (enum redir_type) */
481 /* note: for heredocs, rd_filename contains heredoc delimiter,
482 * and subsequently heredoc itself; and rd_dup is a bitmask:
483 * bit 0: do we need to trim leading tabs?
484 * bit 1: is heredoc quoted (<<'delim' syntax) ?
487 typedef enum redir_type {
489 REDIRECT_OVERWRITE = 1,
492 REDIRECT_HEREDOC = 4,
493 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
496 REDIRFD_SYNTAX_ERR = -2,
497 REDIRFD_TO_FILE = -1,
498 /* otherwise, rd_fd is redirected to rd_dup */
500 HEREDOC_SKIPTABS = 1,
506 pid_t pid; /* 0 if exited */
507 int assignment_cnt; /* how many argv[i] are assignments? */
508 smallint is_stopped; /* is the command currently running? */
509 smallint cmd_type; /* CMD_xxx */
511 #define CMD_SUBSHELL 1
512 #if ENABLE_HUSH_BASH_COMPAT
513 /* used for "[[ EXPR ]]" */
514 # define CMD_SINGLEWORD_NOGLOB 2
516 #if ENABLE_HUSH_FUNCTIONS
517 # define CMD_FUNCDEF 3
520 smalluint cmd_exitcode;
521 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
524 char *group_as_string;
526 #if ENABLE_HUSH_FUNCTIONS
527 struct function *child_func;
528 /* This field is used to prevent a bug here:
529 * while...do f1() {a;}; f1; f1() {b;}; f1; done
530 * When we execute "f1() {a;}" cmd, we create new function and clear
531 * cmd->group, cmd->group_as_string, cmd->argv[0].
532 * When we execute "f1() {b;}", we notice that f1 exists,
533 * and that its "parent cmd" struct is still "alive",
534 * we put those fields back into cmd->xxx
535 * (struct function has ->parent_cmd ptr to facilitate that).
536 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
537 * Without this trick, loop would execute a;b;b;b;...
538 * instead of correct sequence a;b;a;b;...
539 * When command is freed, it severs the link
540 * (sets ->child_func->parent_cmd to NULL).
543 char **argv; /* command name and arguments */
544 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
545 * and on execution these are substituted with their values.
546 * Substitution can make _several_ words out of one argv[n]!
547 * Example: argv[0]=='.^C*^C.' here: echo .$*.
548 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
550 struct redir_struct *redirects; /* I/O redirections */
552 /* Is there anything in this command at all? */
553 #define IS_NULL_CMD(cmd) \
554 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
558 int num_cmds; /* total number of commands in pipe */
559 int alive_cmds; /* number of commands running (not exited) */
560 int stopped_cmds; /* number of commands alive, but stopped */
562 int jobid; /* job number */
563 pid_t pgrp; /* process group ID for the job */
564 char *cmdtext; /* name of job */
566 struct command *cmds; /* array of commands in pipe */
567 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
568 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
569 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
571 typedef enum pipe_style {
577 /* Is there anything in this pipe at all? */
578 #define IS_NULL_PIPE(pi) \
579 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
581 /* This holds pointers to the various results of parsing */
582 struct parse_context {
583 /* linked list of pipes */
584 struct pipe *list_head;
585 /* last pipe (being constructed right now) */
587 /* last command in pipe (being constructed right now) */
588 struct command *command;
589 /* last redirect in command->redirects list */
590 struct redir_struct *pending_redirect;
596 smallint ctx_inverted; /* "! cmd | cmd" */
598 smallint ctx_dsemicolon; /* ";;" seen */
600 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
602 /* group we are enclosed in:
603 * example: "if pipe1; pipe2; then pipe3; fi"
604 * when we see "if" or "then", we malloc and copy current context,
605 * and make ->stack point to it. then we parse pipeN.
606 * when closing "then" / fi" / whatever is found,
607 * we move list_head into ->stack->command->group,
608 * copy ->stack into current context, and delete ->stack.
609 * (parsing of { list } and ( list ) doesn't use this method)
611 struct parse_context *stack;
615 /* On program start, environ points to initial environment.
616 * putenv adds new pointers into it, unsetenv removes them.
617 * Neither of these (de)allocates the strings.
618 * setenv allocates new strings in malloc space and does putenv,
619 * and thus setenv is unusable (leaky) for shell's purposes */
620 #define setenv(...) setenv_is_leaky_dont_use()
622 struct variable *next;
623 char *varstr; /* points to "name=" portion */
624 #if ENABLE_HUSH_LOCAL
625 unsigned func_nest_level;
627 int max_len; /* if > 0, name is part of initial env; else name is malloced */
628 smallint flg_export; /* putenv should be done on this var */
629 smallint flg_read_only;
637 #if ENABLE_HUSH_FUNCTIONS
639 struct function *next;
641 struct command *parent_cmd;
644 char *body_as_string;
650 /* set -/+o OPT support. (TODO: make it optional)
651 * bash supports the following opts:
662 * interactive-comments on
680 static const char o_opt_strings[] ALIGN1 =
683 #if ENABLE_HUSH_MODE_X
690 #if ENABLE_HUSH_MODE_X
697 /* "Globals" within this file */
698 /* Sorted roughly by size (smaller offsets == smaller code) */
700 /* interactive_fd != 0 means we are an interactive shell.
701 * If we are, then saved_tty_pgrp can also be != 0, meaning
702 * that controlling tty is available. With saved_tty_pgrp == 0,
703 * job control still works, but terminal signals
704 * (^C, ^Z, ^Y, ^\) won't work at all, and background
705 * process groups can only be created with "cmd &".
706 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
707 * to give tty to the foreground process group,
708 * and will take it back when the group is stopped (^Z)
711 #if ENABLE_HUSH_INTERACTIVE
712 /* 'interactive_fd' is a fd# open to ctty, if we have one
713 * _AND_ if we decided to act interactively */
717 # define G_interactive_fd (G.interactive_fd)
719 # define G_interactive_fd 0
721 #if ENABLE_FEATURE_EDITING
722 line_input_t *line_input_state;
727 #if ENABLE_HUSH_RANDOM_SUPPORT
733 pid_t saved_tty_pgrp;
734 struct pipe *job_list;
735 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
737 # define G_saved_tty_pgrp 0
739 char o_opt[NUM_OPT_O];
740 #if ENABLE_HUSH_MODE_X
741 # define G_x_mode (G.o_opt[OPT_O_XTRACE])
745 smallint flag_SIGINT;
746 #if ENABLE_HUSH_LOOPS
747 smallint flag_break_continue;
749 #if ENABLE_HUSH_FUNCTIONS
750 /* 0: outside of a function (or sourced file)
751 * -1: inside of a function, ok to use return builtin
752 * 1: return is invoked, skip all till end of func
754 smallint flag_return_in_progress;
756 smallint exiting; /* used to prevent EXIT trap recursion */
757 /* These four support $?, $#, and $1 */
758 smalluint last_exitcode;
759 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
760 smalluint global_args_malloced;
761 smalluint inherited_set_is_saved;
762 /* how many non-NULL argv's we have. NB: $# + 1 */
766 char *argv0_for_re_execing;
768 #if ENABLE_HUSH_LOOPS
769 unsigned depth_break_continue;
770 unsigned depth_of_loop;
774 struct variable *top_var;
775 char **expanded_assignments;
776 #if ENABLE_HUSH_FUNCTIONS
777 struct function *top_func;
778 # if ENABLE_HUSH_LOCAL
779 struct variable **shadowed_vars_pp;
780 unsigned func_nest_level;
783 /* Signal and trap handling */
785 unsigned count_SIGCHLD;
786 unsigned handled_SIGCHLD;
787 smallint we_have_children;
789 /* which signals have non-DFL handler (even with no traps set)? */
790 unsigned non_DFL_mask;
791 char **traps; /* char *traps[NSIG] */
792 sigset_t blocked_set;
793 sigset_t inherited_set;
795 unsigned long memleak_value;
798 char user_input_buf[ENABLE_FEATURE_EDITING ? CONFIG_FEATURE_EDITING_MAX_LEN : 2];
800 #define G (*ptr_to_globals)
801 /* Not #defining name to G.name - this quickly gets unwieldy
802 * (too many defines). Also, I actually prefer to see when a variable
803 * is global, thus "G." prefix is a useful hint */
804 #define INIT_G() do { \
805 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
809 /* Function prototypes for builtins */
810 static int builtin_cd(char **argv) FAST_FUNC;
811 static int builtin_echo(char **argv) FAST_FUNC;
812 static int builtin_eval(char **argv) FAST_FUNC;
813 static int builtin_exec(char **argv) FAST_FUNC;
814 static int builtin_exit(char **argv) FAST_FUNC;
815 static int builtin_export(char **argv) FAST_FUNC;
817 static int builtin_fg_bg(char **argv) FAST_FUNC;
818 static int builtin_jobs(char **argv) FAST_FUNC;
821 static int builtin_help(char **argv) FAST_FUNC;
823 #if ENABLE_HUSH_LOCAL
824 static int builtin_local(char **argv) FAST_FUNC;
827 static int builtin_memleak(char **argv) FAST_FUNC;
830 static int builtin_printf(char **argv) FAST_FUNC;
832 static int builtin_pwd(char **argv) FAST_FUNC;
833 static int builtin_read(char **argv) FAST_FUNC;
834 static int builtin_set(char **argv) FAST_FUNC;
835 static int builtin_shift(char **argv) FAST_FUNC;
836 static int builtin_source(char **argv) FAST_FUNC;
837 static int builtin_test(char **argv) FAST_FUNC;
838 static int builtin_trap(char **argv) FAST_FUNC;
839 static int builtin_type(char **argv) FAST_FUNC;
840 static int builtin_true(char **argv) FAST_FUNC;
841 static int builtin_umask(char **argv) FAST_FUNC;
842 static int builtin_unset(char **argv) FAST_FUNC;
843 static int builtin_wait(char **argv) FAST_FUNC;
844 #if ENABLE_HUSH_LOOPS
845 static int builtin_break(char **argv) FAST_FUNC;
846 static int builtin_continue(char **argv) FAST_FUNC;
848 #if ENABLE_HUSH_FUNCTIONS
849 static int builtin_return(char **argv) FAST_FUNC;
852 /* Table of built-in functions. They can be forked or not, depending on
853 * context: within pipes, they fork. As simple commands, they do not.
854 * When used in non-forking context, they can change global variables
855 * in the parent shell process. If forked, of course they cannot.
856 * For example, 'unset foo | whatever' will parse and run, but foo will
857 * still be set at the end. */
858 struct built_in_command {
860 int (*b_function)(char **argv) FAST_FUNC;
863 # define BLTIN(cmd, func, help) { cmd, func, help }
865 # define BLTIN(cmd, func, help) { cmd, func }
869 static const struct built_in_command bltins1[] = {
870 BLTIN("." , builtin_source , "Run commands in a file"),
871 BLTIN(":" , builtin_true , NULL),
873 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
875 #if ENABLE_HUSH_LOOPS
876 BLTIN("break" , builtin_break , "Exit from a loop"),
878 BLTIN("cd" , builtin_cd , "Change directory"),
879 #if ENABLE_HUSH_LOOPS
880 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
882 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
883 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
884 BLTIN("exit" , builtin_exit , "Exit"),
885 BLTIN("export" , builtin_export , "Set environment variables"),
887 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
890 BLTIN("help" , builtin_help , NULL),
893 BLTIN("jobs" , builtin_jobs , "List jobs"),
895 #if ENABLE_HUSH_LOCAL
896 BLTIN("local" , builtin_local , "Set local variables"),
899 BLTIN("memleak" , builtin_memleak , NULL),
901 BLTIN("read" , builtin_read , "Input into variable"),
902 #if ENABLE_HUSH_FUNCTIONS
903 BLTIN("return" , builtin_return , "Return from a function"),
905 BLTIN("set" , builtin_set , "Set/unset positional parameters"),
906 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
907 #if ENABLE_HUSH_BASH_COMPAT
908 BLTIN("source" , builtin_source , "Run commands in a file"),
910 BLTIN("trap" , builtin_trap , "Trap signals"),
911 BLTIN("type" , builtin_type , "Show command type"),
912 BLTIN("ulimit" , shell_builtin_ulimit , "Control resource limits"),
913 BLTIN("umask" , builtin_umask , "Set file creation mask"),
914 BLTIN("unset" , builtin_unset , "Unset variables"),
915 BLTIN("wait" , builtin_wait , "Wait for process"),
917 /* For now, echo and test are unconditionally enabled.
918 * Maybe make it configurable? */
919 static const struct built_in_command bltins2[] = {
920 BLTIN("[" , builtin_test , NULL),
921 BLTIN("echo" , builtin_echo , NULL),
923 BLTIN("printf" , builtin_printf , NULL),
925 BLTIN("pwd" , builtin_pwd , NULL),
926 BLTIN("test" , builtin_test , NULL),
933 /* prevent disasters with G.debug_indent < 0 */
934 # define indent() fdprintf(2, "%*s", (G.debug_indent * 2) & 0xff, "")
935 # define debug_enter() (G.debug_indent++)
936 # define debug_leave() (G.debug_indent--)
938 # define indent() ((void)0)
939 # define debug_enter() ((void)0)
940 # define debug_leave() ((void)0)
944 # define debug_printf(...) (indent(), fdprintf(2, __VA_ARGS__))
947 #ifndef debug_printf_parse
948 # define debug_printf_parse(...) (indent(), fdprintf(2, __VA_ARGS__))
951 #ifndef debug_printf_exec
952 #define debug_printf_exec(...) (indent(), fdprintf(2, __VA_ARGS__))
955 #ifndef debug_printf_env
956 # define debug_printf_env(...) (indent(), fdprintf(2, __VA_ARGS__))
959 #ifndef debug_printf_jobs
960 # define debug_printf_jobs(...) (indent(), fdprintf(2, __VA_ARGS__))
961 # define DEBUG_JOBS 1
963 # define DEBUG_JOBS 0
966 #ifndef debug_printf_expand
967 # define debug_printf_expand(...) (indent(), fdprintf(2, __VA_ARGS__))
968 # define DEBUG_EXPAND 1
970 # define DEBUG_EXPAND 0
973 #ifndef debug_printf_varexp
974 # define debug_printf_varexp(...) (indent(), fdprintf(2, __VA_ARGS__))
977 #ifndef debug_printf_glob
978 # define debug_printf_glob(...) (indent(), fdprintf(2, __VA_ARGS__))
979 # define DEBUG_GLOB 1
981 # define DEBUG_GLOB 0
984 #ifndef debug_printf_list
985 # define debug_printf_list(...) (indent(), fdprintf(2, __VA_ARGS__))
988 #ifndef debug_printf_subst
989 # define debug_printf_subst(...) (indent(), fdprintf(2, __VA_ARGS__))
992 #ifndef debug_printf_clean
993 # define debug_printf_clean(...) (indent(), fdprintf(2, __VA_ARGS__))
994 # define DEBUG_CLEAN 1
996 # define DEBUG_CLEAN 0
1000 static void debug_print_strings(const char *prefix, char **vv)
1003 fdprintf(2, "%s:\n", prefix);
1005 fdprintf(2, " '%s'\n", *vv++);
1008 # define debug_print_strings(prefix, vv) ((void)0)
1012 /* Leak hunting. Use hush_leaktool.sh for post-processing.
1015 static void *xxmalloc(int lineno, size_t size)
1017 void *ptr = xmalloc((size + 0xff) & ~0xff);
1018 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
1021 static void *xxrealloc(int lineno, void *ptr, size_t size)
1023 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
1024 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
1027 static char *xxstrdup(int lineno, const char *str)
1029 char *ptr = xstrdup(str);
1030 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
1033 static void xxfree(void *ptr)
1035 fdprintf(2, "free %p\n", ptr);
1038 # define xmalloc(s) xxmalloc(__LINE__, s)
1039 # define xrealloc(p, s) xxrealloc(__LINE__, p, s)
1040 # define xstrdup(s) xxstrdup(__LINE__, s)
1041 # define free(p) xxfree(p)
1045 /* Syntax and runtime errors. They always abort scripts.
1046 * In interactive use they usually discard unparsed and/or unexecuted commands
1047 * and return to the prompt.
1048 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
1051 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
1052 # define syntax_error(lineno, msg) syntax_error(msg)
1053 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
1054 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
1055 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
1056 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
1059 static void die_if_script(unsigned lineno, const char *fmt, ...)
1064 bb_error_msg("hush.c:%u", lineno);
1067 bb_verror_msg(fmt, p, NULL);
1069 if (!G_interactive_fd)
1073 static void syntax_error(unsigned lineno, const char *msg)
1076 die_if_script(lineno, "syntax error: %s", msg);
1078 die_if_script(lineno, "syntax error", NULL);
1081 static void syntax_error_at(unsigned lineno, const char *msg)
1083 die_if_script(lineno, "syntax error at '%s'", msg);
1086 static void syntax_error_unterm_str(unsigned lineno, const char *s)
1088 die_if_script(lineno, "syntax error: unterminated %s", s);
1091 /* It so happens that all such cases are totally fatal
1092 * even if shell is interactive: EOF while looking for closing
1093 * delimiter. There is nowhere to read stuff from after that,
1094 * it's EOF! The only choice is to terminate.
1096 static void syntax_error_unterm_ch(unsigned lineno, char ch) NORETURN;
1097 static void syntax_error_unterm_ch(unsigned lineno, char ch)
1099 char msg[2] = { ch, '\0' };
1100 syntax_error_unterm_str(lineno, msg);
1104 static void syntax_error_unexpected_ch(unsigned lineno, int ch)
1109 die_if_script(lineno, "syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
1113 # undef die_if_script
1114 # undef syntax_error
1115 # undef syntax_error_at
1116 # undef syntax_error_unterm_ch
1117 # undef syntax_error_unterm_str
1118 # undef syntax_error_unexpected_ch
1120 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
1121 # define syntax_error(msg) syntax_error(__LINE__, msg)
1122 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
1123 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
1124 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
1125 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
1129 #if ENABLE_HUSH_INTERACTIVE
1130 static void cmdedit_update_prompt(void);
1132 # define cmdedit_update_prompt() ((void)0)
1136 /* Utility functions
1138 /* Replace each \x with x in place, return ptr past NUL. */
1139 static char *unbackslash(char *src)
1141 char *dst = src = strchrnul(src, '\\');
1145 if ((*dst++ = *src++) == '\0')
1151 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
1172 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
1173 v[count1 + count2] = NULL;
1176 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
1180 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
1182 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
1183 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
1186 #define add_strings_to_strings(strings, add, need_to_dup) \
1187 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
1190 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
1191 static char **add_string_to_strings(char **strings, char *add)
1196 return add_strings_to_strings(strings, v, /*dup:*/ 0);
1199 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
1201 char **ptr = add_string_to_strings(strings, add);
1202 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
1205 #define add_string_to_strings(strings, add) \
1206 xx_add_string_to_strings(__LINE__, strings, add)
1209 static void free_strings(char **strings)
1224 /* Helpers for setting new $n and restoring them back
1226 typedef struct save_arg_t {
1230 smallint sv_g_malloced;
1233 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1237 sv->sv_argv0 = argv[0];
1238 sv->sv_g_argv = G.global_argv;
1239 sv->sv_g_argc = G.global_argc;
1240 sv->sv_g_malloced = G.global_args_malloced;
1242 argv[0] = G.global_argv[0]; /* retain $0 */
1243 G.global_argv = argv;
1244 G.global_args_malloced = 0;
1252 static void restore_G_args(save_arg_t *sv, char **argv)
1256 if (G.global_args_malloced) {
1257 /* someone ran "set -- arg1 arg2 ...", undo */
1259 while (*++pp) /* note: does not free $0 */
1261 free(G.global_argv);
1263 argv[0] = sv->sv_argv0;
1264 G.global_argv = sv->sv_g_argv;
1265 G.global_argc = sv->sv_g_argc;
1266 G.global_args_malloced = sv->sv_g_malloced;
1270 /* Basic theory of signal handling in shell
1271 * ========================================
1272 * This does not describe what hush does, rather, it is current understanding
1273 * what it _should_ do. If it doesn't, it's a bug.
1274 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1276 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1277 * is finished or backgrounded. It is the same in interactive and
1278 * non-interactive shells, and is the same regardless of whether
1279 * a user trap handler is installed or a shell special one is in effect.
1280 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1281 * backgrounds (i.e. stops) or kills all members of currently running
1284 * Wait builtin in interruptible by signals for which user trap is set
1285 * or by SIGINT in interactive shell.
1287 * Trap handlers will execute even within trap handlers. (right?)
1289 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1290 * except for handlers set to '' (empty string).
1292 * If job control is off, backgrounded commands ("cmd &")
1293 * have SIGINT, SIGQUIT set to SIG_IGN.
1295 * Commands which are run in command substitution ("`cmd`")
1296 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1298 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1299 * by the shell from its parent.
1301 * Signals which differ from SIG_DFL action
1302 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1305 * SIGTERM (interactive): ignore
1306 * SIGHUP (interactive):
1307 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1308 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1309 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1310 * that all pipe members are stopped. Try this in bash:
1311 * while :; do :; done - ^Z does not background it
1312 * (while :; do :; done) - ^Z backgrounds it
1313 * SIGINT (interactive): wait for last pipe, ignore the rest
1314 * of the command line, show prompt. NB: ^C does not send SIGINT
1315 * to interactive shell while shell is waiting for a pipe,
1316 * since shell is bg'ed (is not in foreground process group).
1317 * Example 1: this waits 5 sec, but does not execute ls:
1318 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1319 * Example 2: this does not wait and does not execute ls:
1320 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1321 * Example 3: this does not wait 5 sec, but executes ls:
1322 * "sleep 5; ls -l" + press ^C
1324 * (What happens to signals which are IGN on shell start?)
1325 * (What happens with signal mask on shell start?)
1327 * Implementation in hush
1328 * ======================
1329 * We use in-kernel pending signal mask to determine which signals were sent.
1330 * We block all signals which we don't want to take action immediately,
1331 * i.e. we block all signals which need to have special handling as described
1332 * above, and all signals which have traps set.
1333 * After each pipe execution, we extract any pending signals via sigtimedwait()
1336 * unsigned non_DFL_mask: a mask of such "special" signals
1337 * sigset_t blocked_set: current blocked signal set
1340 * clear bit in blocked_set unless it is also in non_DFL_mask
1341 * "trap 'cmd' SIGxxx":
1342 * set bit in blocked_set (even if 'cmd' is '')
1343 * after [v]fork, if we plan to be a shell:
1344 * unblock signals with special interactive handling
1345 * (child shell is not interactive),
1346 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1347 * after [v]fork, if we plan to exec:
1348 * POSIX says fork clears pending signal mask in child - no need to clear it.
1349 * Restore blocked signal set to one inherited by shell just prior to exec.
1351 * Note: as a result, we do not use signal handlers much. The only uses
1352 * are to count SIGCHLDs
1353 * and to restore tty pgrp on signal-induced exit.
1356 * Standard says "When a subshell is entered, traps that are not being ignored
1357 * are set to the default actions". bash interprets it so that traps which
1358 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1361 SPECIAL_INTERACTIVE_SIGS = 0
1366 SPECIAL_JOB_SIGS = 0
1374 #if ENABLE_HUSH_FAST
1375 static void SIGCHLD_handler(int sig UNUSED_PARAM)
1378 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1384 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1385 # define disable_restore_tty_pgrp_on_exit() (die_sleep = 0)
1386 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1387 # define enable_restore_tty_pgrp_on_exit() (die_sleep = -1)
1389 /* Restores tty foreground process group, and exits.
1390 * May be called as signal handler for fatal signal
1391 * (will resend signal to itself, producing correct exit state)
1392 * or called directly with -EXITCODE.
1393 * We also call it if xfunc is exiting. */
1394 static void sigexit(int sig) NORETURN;
1395 static void sigexit(int sig)
1397 /* Disable all signals: job control, SIGPIPE, etc. */
1398 sigprocmask_allsigs(SIG_BLOCK);
1400 /* Careful: we can end up here after [v]fork. Do not restore
1401 * tty pgrp then, only top-level shell process does that */
1402 if (G_saved_tty_pgrp && getpid() == G.root_pid)
1403 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1405 /* Not a signal, just exit */
1409 kill_myself_with_sig(sig); /* does not return */
1413 # define disable_restore_tty_pgrp_on_exit() ((void)0)
1414 # define enable_restore_tty_pgrp_on_exit() ((void)0)
1418 /* Restores tty foreground process group, and exits. */
1419 static void hush_exit(int exitcode) NORETURN;
1420 static void hush_exit(int exitcode)
1422 if (G.exiting <= 0 && G.traps && G.traps[0] && G.traps[0][0]) {
1423 /* Prevent recursion:
1424 * trap "echo Hi; exit" EXIT; exit
1427 /* argv[0] is unused */
1428 argv[1] = G.traps[0];
1430 G.exiting = 1; /* prevent EXIT trap recursion */
1431 /* Note: G.traps[0] is not cleared!
1432 * "trap" will still show it, if executed
1437 #if ENABLE_FEATURE_CLEAN_UP
1439 struct variable *cur_var;
1440 if (G.cwd != bb_msg_unknown)
1442 cur_var = G.top_var;
1444 struct variable *tmp = cur_var;
1445 if (!cur_var->max_len)
1446 free(cur_var->varstr);
1447 cur_var = cur_var->next;
1455 sigexit(- (exitcode & 0xff));
1462 static int check_and_run_traps(int sig)
1464 /* I want it in rodata, not in bss.
1465 * gcc 4.2.1 puts it in rodata only if it has { 0, 0 }
1466 * initializer. But other compilers may still use bss.
1467 * TODO: find more portable solution.
1469 static const struct timespec zero_timespec = { 0, 0 };
1470 smalluint save_rcode;
1476 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
1481 if (G.traps && G.traps[sig]) {
1482 if (G.traps[sig][0]) {
1483 /* We have user-defined handler */
1485 /* argv[0] is unused */
1486 argv[1] = G.traps[sig];
1488 save_rcode = G.last_exitcode;
1490 G.last_exitcode = save_rcode;
1491 } /* else: "" trap, ignoring signal */
1494 /* not a trap: special action */
1496 #if ENABLE_HUSH_FAST
1499 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1503 /* Builtin was ^C'ed, make it look prettier: */
1510 /* bash is observed to signal whole process groups,
1511 * not individual processes */
1512 for (job = G.job_list; job; job = job->next) {
1515 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
1516 if (kill(- job->pgrp, SIGHUP) == 0)
1517 kill(- job->pgrp, SIGCONT);
1522 default: /* ignored: */
1523 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1531 static const char *get_cwd(int force)
1533 if (force || G.cwd == NULL) {
1534 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1535 * we must not try to free(bb_msg_unknown) */
1536 if (G.cwd == bb_msg_unknown)
1538 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1540 G.cwd = bb_msg_unknown;
1547 * Shell and environment variable support
1549 static struct variable **get_ptr_to_local_var(const char *name, unsigned len)
1551 struct variable **pp;
1552 struct variable *cur;
1555 while ((cur = *pp) != NULL) {
1556 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1563 static const char* FAST_FUNC get_local_var_value(const char *name)
1565 struct variable **vpp;
1566 unsigned len = strlen(name);
1568 if (G.expanded_assignments) {
1569 char **cpp = G.expanded_assignments;
1572 if (strncmp(cp, name, len) == 0 && cp[len] == '=')
1573 return cp + len + 1;
1578 vpp = get_ptr_to_local_var(name, len);
1580 return (*vpp)->varstr + len + 1;
1582 if (strcmp(name, "PPID") == 0)
1583 return utoa(G.root_ppid);
1584 // bash compat: UID? EUID?
1585 #if ENABLE_HUSH_RANDOM_SUPPORT
1586 if (strcmp(name, "RANDOM") == 0)
1587 return utoa(next_random(&G.random_gen));
1592 /* str holds "NAME=VAL" and is expected to be malloced.
1593 * We take ownership of it.
1595 * 0: do not change export flag
1596 * (if creating new variable, flag will be 0)
1597 * 1: set export flag and putenv the variable
1598 * -1: clear export flag and unsetenv the variable
1599 * flg_read_only is set only when we handle -R var=val
1601 #if !BB_MMU && ENABLE_HUSH_LOCAL
1602 /* all params are used */
1603 #elif BB_MMU && ENABLE_HUSH_LOCAL
1604 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1605 set_local_var(str, flg_export, local_lvl)
1606 #elif BB_MMU && !ENABLE_HUSH_LOCAL
1607 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1608 set_local_var(str, flg_export)
1609 #elif !BB_MMU && !ENABLE_HUSH_LOCAL
1610 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1611 set_local_var(str, flg_export, flg_read_only)
1613 static int set_local_var(char *str, int flg_export, int local_lvl, int flg_read_only)
1615 struct variable **var_pp;
1616 struct variable *cur;
1620 eq_sign = strchr(str, '=');
1621 if (!eq_sign) { /* not expected to ever happen? */
1626 name_len = eq_sign - str + 1; /* including '=' */
1627 var_pp = &G.top_var;
1628 while ((cur = *var_pp) != NULL) {
1629 if (strncmp(cur->varstr, str, name_len) != 0) {
1630 var_pp = &cur->next;
1633 /* We found an existing var with this name */
1634 if (cur->flg_read_only) {
1638 bb_error_msg("%s: readonly variable", str);
1642 if (flg_export == -1) { // "&& cur->flg_export" ?
1643 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1648 #if ENABLE_HUSH_LOCAL
1649 if (cur->func_nest_level < local_lvl) {
1650 /* New variable is declared as local,
1651 * and existing one is global, or local
1652 * from enclosing function.
1653 * Remove and save old one: */
1654 *var_pp = cur->next;
1655 cur->next = *G.shadowed_vars_pp;
1656 *G.shadowed_vars_pp = cur;
1657 /* bash 3.2.33(1) and exported vars:
1659 * # f() { local z=a; env | grep ^z; }
1665 if (cur->flg_export)
1670 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
1675 if (cur->max_len != 0) {
1676 if (cur->max_len >= strlen(str)) {
1677 /* This one is from startup env, reuse space */
1678 strcpy(cur->varstr, str);
1682 /* max_len == 0 signifies "malloced" var, which we can
1683 * (and has to) free */
1687 goto set_str_and_exp;
1690 /* Not found - create new variable struct */
1691 cur = xzalloc(sizeof(*cur));
1692 #if ENABLE_HUSH_LOCAL
1693 cur->func_nest_level = local_lvl;
1695 cur->next = *var_pp;
1701 cur->flg_read_only = flg_read_only;
1704 if (flg_export == 1)
1705 cur->flg_export = 1;
1706 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1707 cmdedit_update_prompt();
1708 if (cur->flg_export) {
1709 if (flg_export == -1) {
1710 cur->flg_export = 0;
1711 /* unsetenv was already done */
1713 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1714 return putenv(cur->varstr);
1720 /* Used at startup and after each cd */
1721 static void set_pwd_var(int exp)
1723 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)),
1724 /*exp:*/ exp, /*lvl:*/ 0, /*ro:*/ 0);
1727 static int unset_local_var_len(const char *name, int name_len)
1729 struct variable *cur;
1730 struct variable **var_pp;
1733 return EXIT_SUCCESS;
1734 var_pp = &G.top_var;
1735 while ((cur = *var_pp) != NULL) {
1736 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1737 if (cur->flg_read_only) {
1738 bb_error_msg("%s: readonly variable", name);
1739 return EXIT_FAILURE;
1741 *var_pp = cur->next;
1742 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1743 bb_unsetenv(cur->varstr);
1744 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1745 cmdedit_update_prompt();
1749 return EXIT_SUCCESS;
1751 var_pp = &cur->next;
1753 return EXIT_SUCCESS;
1756 static int unset_local_var(const char *name)
1758 return unset_local_var_len(name, strlen(name));
1761 static void unset_vars(char **strings)
1769 const char *eq = strchrnul(*v, '=');
1770 unset_local_var_len(*v, (int)(eq - *v));
1776 static void FAST_FUNC set_local_var_from_halves(const char *name, const char *val)
1778 char *var = xasprintf("%s=%s", name, val);
1779 set_local_var(var, /*flags:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
1784 * Helpers for "var1=val1 var2=val2 cmd" feature
1786 static void add_vars(struct variable *var)
1788 struct variable *next;
1792 var->next = G.top_var;
1794 if (var->flg_export) {
1795 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
1796 putenv(var->varstr);
1798 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
1804 static struct variable *set_vars_and_save_old(char **strings)
1807 struct variable *old = NULL;
1813 struct variable *var_p;
1814 struct variable **var_pp;
1817 eq = strchr(*s, '=');
1819 var_pp = get_ptr_to_local_var(*s, eq - *s);
1821 /* Remove variable from global linked list */
1823 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
1824 *var_pp = var_p->next;
1825 /* Add it to returned list */
1829 set_local_var(*s, /*exp:*/ 1, /*lvl:*/ 0, /*ro:*/ 0);
1840 static int FAST_FUNC static_get(struct in_str *i)
1850 static int FAST_FUNC static_peek(struct in_str *i)
1855 #if ENABLE_HUSH_INTERACTIVE
1857 static void cmdedit_update_prompt(void)
1859 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1860 G.PS1 = get_local_var_value("PS1");
1863 G.PS2 = get_local_var_value("PS2");
1871 static const char *setup_prompt_string(int promptmode)
1873 const char *prompt_str;
1874 debug_printf("setup_prompt_string %d ", promptmode);
1875 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1876 /* Set up the prompt */
1877 if (promptmode == 0) { /* PS1 */
1879 /* bash uses $PWD value, even if it is set by user.
1880 * It uses current dir only if PWD is unset.
1881 * We always use current dir. */
1882 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
1887 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1888 debug_printf("result '%s'\n", prompt_str);
1892 static void get_user_input(struct in_str *i)
1895 const char *prompt_str;
1897 prompt_str = setup_prompt_string(i->promptmode);
1898 # if ENABLE_FEATURE_EDITING
1899 /* Enable command line editing only while a command line
1900 * is actually being read */
1903 /* buglet: SIGINT will not make new prompt to appear _at once_,
1904 * only after <Enter>. (^C will work) */
1905 r = read_line_input(prompt_str, G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1, G.line_input_state);
1906 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1907 check_and_run_traps(0);
1908 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1909 i->eof_flag = (r < 0);
1910 if (i->eof_flag) { /* EOF/error detected */
1911 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1912 G.user_input_buf[1] = '\0';
1917 fputs(prompt_str, stdout);
1919 G.user_input_buf[0] = r = fgetc(i->file);
1920 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1921 //do we need check_and_run_traps(0)? (maybe only if stdin)
1922 } while (G.flag_SIGINT);
1923 i->eof_flag = (r == EOF);
1925 i->p = G.user_input_buf;
1928 #endif /* INTERACTIVE */
1930 /* This is the magic location that prints prompts
1931 * and gets data back from the user */
1932 static int FAST_FUNC file_get(struct in_str *i)
1936 /* If there is data waiting, eat it up */
1937 if (i->p && *i->p) {
1938 #if ENABLE_HUSH_INTERACTIVE
1942 if (i->eof_flag && !*i->p)
1944 /* note: ch is never NUL */
1946 /* need to double check i->file because we might be doing something
1947 * more complicated by now, like sourcing or substituting. */
1948 #if ENABLE_HUSH_INTERACTIVE
1949 if (G_interactive_fd && i->promptme && i->file == stdin) {
1952 } while (!*i->p); /* need non-empty line */
1953 i->promptmode = 1; /* PS2 */
1958 do ch = fgetc(i->file); while (ch == '\0');
1960 debug_printf("file_get: got '%c' %d\n", ch, ch);
1961 #if ENABLE_HUSH_INTERACTIVE
1968 /* All callers guarantee this routine will never
1969 * be used right after a newline, so prompting is not needed.
1971 static int FAST_FUNC file_peek(struct in_str *i)
1974 if (i->p && *i->p) {
1975 if (i->eof_flag && !i->p[1])
1978 /* note: ch is never NUL */
1980 do ch = fgetc(i->file); while (ch == '\0');
1981 i->eof_flag = (ch == EOF);
1982 i->peek_buf[0] = ch;
1983 i->peek_buf[1] = '\0';
1985 debug_printf("file_peek: got '%c' %d\n", ch, ch);
1989 static void setup_file_in_str(struct in_str *i, FILE *f)
1991 i->peek = file_peek;
1993 #if ENABLE_HUSH_INTERACTIVE
1995 i->promptmode = 0; /* PS1 */
2001 static void setup_string_in_str(struct in_str *i, const char *s)
2003 i->peek = static_peek;
2004 i->get = static_get;
2005 #if ENABLE_HUSH_INTERACTIVE
2007 i->promptmode = 0; /* PS1 */
2017 #define B_CHUNK (32 * sizeof(char*))
2019 static void o_reset_to_empty_unquoted(o_string *o)
2022 o->has_quoted_part = 0;
2027 static void o_free(o_string *o)
2030 memset(o, 0, sizeof(*o));
2033 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
2038 static void o_grow_by(o_string *o, int len)
2040 if (o->length + len > o->maxlen) {
2041 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
2042 o->data = xrealloc(o->data, 1 + o->maxlen);
2046 static void o_addchr(o_string *o, int ch)
2048 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
2050 o->data[o->length] = ch;
2052 o->data[o->length] = '\0';
2055 static void o_addblock(o_string *o, const char *str, int len)
2058 memcpy(&o->data[o->length], str, len);
2060 o->data[o->length] = '\0';
2063 static void o_addstr(o_string *o, const char *str)
2065 o_addblock(o, str, strlen(str));
2069 static void nommu_addchr(o_string *o, int ch)
2075 # define nommu_addchr(o, str) ((void)0)
2078 static void o_addstr_with_NUL(o_string *o, const char *str)
2080 o_addblock(o, str, strlen(str) + 1);
2084 * HUSH_BRACE_EXPANSION code needs corresponding quoting on variable expansion side.
2085 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
2086 * Apparently, on unquoted $v bash still does globbing
2087 * ("v='*.txt'; echo $v" prints all .txt files),
2088 * but NOT brace expansion! Thus, there should be TWO independent
2089 * quoting mechanisms on $v expansion side: one protects
2090 * $v from brace expansion, and other additionally protects "$v" against globbing.
2091 * We have only second one.
2094 #if ENABLE_HUSH_BRACE_EXPANSION
2095 # define MAYBE_BRACES "{}"
2097 # define MAYBE_BRACES ""
2100 /* My analysis of quoting semantics tells me that state information
2101 * is associated with a destination, not a source.
2103 static void o_addqchr(o_string *o, int ch)
2106 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
2111 o->data[o->length] = '\\';
2114 o->data[o->length] = ch;
2116 o->data[o->length] = '\0';
2119 static void o_addQchr(o_string *o, int ch)
2122 if ((o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)
2123 && strchr("*?[\\" MAYBE_BRACES, ch)
2126 o->data[o->length] = '\\';
2130 o->data[o->length] = ch;
2132 o->data[o->length] = '\0';
2135 static void o_addqblock(o_string *o, const char *str, int len)
2140 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
2141 if (ordinary_cnt > len) /* paranoia */
2143 o_addblock(o, str, ordinary_cnt);
2144 if (ordinary_cnt == len)
2146 str += ordinary_cnt;
2147 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
2151 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
2153 o->data[o->length] = '\\';
2157 o->data[o->length] = ch;
2159 o->data[o->length] = '\0';
2163 static void o_addQblock(o_string *o, const char *str, int len)
2165 if (!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)) {
2166 o_addblock(o, str, len);
2169 o_addqblock(o, str, len);
2172 static void o_addQstr(o_string *o, const char *str)
2174 o_addQblock(o, str, strlen(str));
2177 /* A special kind of o_string for $VAR and `cmd` expansion.
2178 * It contains char* list[] at the beginning, which is grown in 16 element
2179 * increments. Actual string data starts at the next multiple of 16 * (char*).
2180 * list[i] contains an INDEX (int!) into this string data.
2181 * It means that if list[] needs to grow, data needs to be moved higher up
2182 * but list[i]'s need not be modified.
2183 * NB: remembering how many list[i]'s you have there is crucial.
2184 * o_finalize_list() operation post-processes this structure - calculates
2185 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
2187 #if DEBUG_EXPAND || DEBUG_GLOB
2188 static void debug_print_list(const char *prefix, o_string *o, int n)
2190 char **list = (char**)o->data;
2191 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2195 fdprintf(2, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d glob:%d quoted:%d escape:%d\n",
2196 prefix, list, n, string_start, o->length, o->maxlen,
2197 !!(o->o_expflags & EXP_FLAG_GLOB),
2199 !!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
2202 fdprintf(2, " list[%d]=%d '%s' %p\n", i, (int)(uintptr_t)list[i],
2203 o->data + (int)(uintptr_t)list[i] + string_start,
2204 o->data + (int)(uintptr_t)list[i] + string_start);
2208 const char *p = o->data + (int)(uintptr_t)list[n - 1] + string_start;
2210 fdprintf(2, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
2214 # define debug_print_list(prefix, o, n) ((void)0)
2217 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
2218 * in list[n] so that it points past last stored byte so far.
2219 * It returns n+1. */
2220 static int o_save_ptr_helper(o_string *o, int n)
2222 char **list = (char**)o->data;
2226 if (!o->has_empty_slot) {
2227 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2228 string_len = o->length - string_start;
2229 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
2230 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
2231 /* list[n] points to string_start, make space for 16 more pointers */
2232 o->maxlen += 0x10 * sizeof(list[0]);
2233 o->data = xrealloc(o->data, o->maxlen + 1);
2234 list = (char**)o->data;
2235 memmove(list + n + 0x10, list + n, string_len);
2236 o->length += 0x10 * sizeof(list[0]);
2238 debug_printf_list("list[%d]=%d string_start=%d\n",
2239 n, string_len, string_start);
2242 /* We have empty slot at list[n], reuse without growth */
2243 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
2244 string_len = o->length - string_start;
2245 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2246 n, string_len, string_start);
2247 o->has_empty_slot = 0;
2249 list[n] = (char*)(uintptr_t)string_len;
2253 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2254 static int o_get_last_ptr(o_string *o, int n)
2256 char **list = (char**)o->data;
2257 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2259 return ((int)(uintptr_t)list[n-1]) + string_start;
2262 #if ENABLE_HUSH_BRACE_EXPANSION
2263 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2264 * first, it processes even {a} (no commas), second,
2265 * I didn't manage to make it return strings when they don't match
2266 * existing files. Need to re-implement it.
2270 static int glob_needed(const char *s)
2279 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2285 /* Return pointer to next closing brace or to comma */
2286 static const char *next_brace_sub(const char *cp)
2290 while (*cp != '\0') {
2297 if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2303 return *cp != '\0' ? cp : NULL;
2305 /* Recursive brace globber. Note: may garble pattern[]. */
2306 static int glob_brace(char *pattern, o_string *o, int n)
2308 char *new_pattern_buf;
2315 debug_printf_glob("glob_brace('%s')\n", pattern);
2321 if (*begin == '{') {
2322 /* Find the first sub-pattern and at the same time
2323 * find the rest after the closing brace */
2324 next = next_brace_sub(begin);
2326 /* An illegal expression */
2330 /* "{abc}" with no commas - illegal
2331 * brace expr, disregard and skip it */
2337 if (*begin == '\\' && begin[1] != '\0')
2341 debug_printf_glob("begin:%s\n", begin);
2342 debug_printf_glob("next:%s\n", next);
2344 /* Now find the end of the whole brace expression */
2346 while (*rest != '}') {
2347 rest = next_brace_sub(rest);
2349 /* An illegal expression */
2352 debug_printf_glob("rest:%s\n", rest);
2354 rest_len = strlen(++rest) + 1;
2356 /* We are sure the brace expression is well-formed */
2358 /* Allocate working buffer large enough for our work */
2359 new_pattern_buf = xmalloc(strlen(pattern));
2361 /* We have a brace expression. BEGIN points to the opening {,
2362 * NEXT points past the terminator of the first element, and REST
2363 * points past the final }. We will accumulate result names from
2364 * recursive runs for each brace alternative in the buffer using
2369 /* Construct the new glob expression */
2372 mempcpy(new_pattern_buf,
2373 /* We know the prefix for all sub-patterns */
2374 pattern, begin - pattern),
2378 /* Note: glob_brace() may garble new_pattern_buf[].
2379 * That's why we re-copy prefix every time (1st memcpy above).
2381 n = glob_brace(new_pattern_buf, o, n);
2383 /* We saw the last entry */
2387 next = next_brace_sub(next);
2389 free(new_pattern_buf);
2397 memset(&globdata, 0, sizeof(globdata));
2398 gr = glob(pattern, 0, NULL, &globdata);
2399 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2401 if (gr == GLOB_NOMATCH) {
2402 globfree(&globdata);
2403 /* NB: garbles parameter */
2404 unbackslash(pattern);
2405 o_addstr_with_NUL(o, pattern);
2406 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2407 return o_save_ptr_helper(o, n);
2409 if (gr == GLOB_NOSPACE)
2410 bb_error_msg_and_die(bb_msg_memory_exhausted);
2411 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2412 * but we didn't specify it. Paranoia again. */
2413 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2415 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2416 char **argv = globdata.gl_pathv;
2418 o_addstr_with_NUL(o, *argv);
2419 n = o_save_ptr_helper(o, n);
2425 globfree(&globdata);
2429 /* Performs globbing on last list[],
2430 * saving each result as a new list[].
2432 static int perform_glob(o_string *o, int n)
2434 char *pattern, *copy;
2436 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
2438 return o_save_ptr_helper(o, n);
2439 pattern = o->data + o_get_last_ptr(o, n);
2440 debug_printf_glob("glob pattern '%s'\n", pattern);
2441 if (!glob_needed(pattern)) {
2442 /* unbackslash last string in o in place, fix length */
2443 o->length = unbackslash(pattern) - o->data;
2444 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2445 return o_save_ptr_helper(o, n);
2448 copy = xstrdup(pattern);
2449 /* "forget" pattern in o */
2450 o->length = pattern - o->data;
2451 n = glob_brace(copy, o, n);
2454 debug_print_list("perform_glob returning", o, n);
2458 #else /* !HUSH_BRACE_EXPANSION */
2461 static int glob_needed(const char *s)
2470 if (*s == '*' || *s == '[' || *s == '?')
2476 /* Performs globbing on last list[],
2477 * saving each result as a new list[].
2479 static int perform_glob(o_string *o, int n)
2485 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
2487 return o_save_ptr_helper(o, n);
2488 pattern = o->data + o_get_last_ptr(o, n);
2489 debug_printf_glob("glob pattern '%s'\n", pattern);
2490 if (!glob_needed(pattern)) {
2492 /* unbackslash last string in o in place, fix length */
2493 o->length = unbackslash(pattern) - o->data;
2494 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2495 return o_save_ptr_helper(o, n);
2498 memset(&globdata, 0, sizeof(globdata));
2499 /* Can't use GLOB_NOCHECK: it does not unescape the string.
2500 * If we glob "*.\*" and don't find anything, we need
2501 * to fall back to using literal "*.*", but GLOB_NOCHECK
2502 * will return "*.\*"!
2504 gr = glob(pattern, 0, NULL, &globdata);
2505 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2507 if (gr == GLOB_NOMATCH) {
2508 globfree(&globdata);
2511 if (gr == GLOB_NOSPACE)
2512 bb_error_msg_and_die(bb_msg_memory_exhausted);
2513 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2514 * but we didn't specify it. Paranoia again. */
2515 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2517 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2518 char **argv = globdata.gl_pathv;
2519 /* "forget" pattern in o */
2520 o->length = pattern - o->data;
2522 o_addstr_with_NUL(o, *argv);
2523 n = o_save_ptr_helper(o, n);
2529 globfree(&globdata);
2531 debug_print_list("perform_glob returning", o, n);
2535 #endif /* !HUSH_BRACE_EXPANSION */
2537 /* If o->o_expflags & EXP_FLAG_GLOB, glob the string so far remembered.
2538 * Otherwise, just finish current list[] and start new */
2539 static int o_save_ptr(o_string *o, int n)
2541 if (o->o_expflags & EXP_FLAG_GLOB) {
2542 /* If o->has_empty_slot, list[n] was already globbed
2543 * (if it was requested back then when it was filled)
2544 * so don't do that again! */
2545 if (!o->has_empty_slot)
2546 return perform_glob(o, n); /* o_save_ptr_helper is inside */
2548 return o_save_ptr_helper(o, n);
2551 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
2552 static char **o_finalize_list(o_string *o, int n)
2557 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
2559 debug_print_list("finalized", o, n);
2560 debug_printf_expand("finalized n:%d\n", n);
2561 list = (char**)o->data;
2562 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2566 list[n] = o->data + (int)(uintptr_t)list[n] + string_start;
2571 static void free_pipe_list(struct pipe *pi);
2573 /* Returns pi->next - next pipe in the list */
2574 static struct pipe *free_pipe(struct pipe *pi)
2579 debug_printf_clean("free_pipe (pid %d)\n", getpid());
2580 for (i = 0; i < pi->num_cmds; i++) {
2581 struct command *command;
2582 struct redir_struct *r, *rnext;
2584 command = &pi->cmds[i];
2585 debug_printf_clean(" command %d:\n", i);
2586 if (command->argv) {
2590 for (a = 0, p = command->argv; *p; a++, p++) {
2591 debug_printf_clean(" argv[%d] = %s\n", a, *p);
2594 free_strings(command->argv);
2595 //command->argv = NULL;
2597 /* not "else if": on syntax error, we may have both! */
2598 if (command->group) {
2599 debug_printf_clean(" begin group (cmd_type:%d)\n",
2601 free_pipe_list(command->group);
2602 debug_printf_clean(" end group\n");
2603 //command->group = NULL;
2605 /* else is crucial here.
2606 * If group != NULL, child_func is meaningless */
2607 #if ENABLE_HUSH_FUNCTIONS
2608 else if (command->child_func) {
2609 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
2610 command->child_func->parent_cmd = NULL;
2614 free(command->group_as_string);
2615 //command->group_as_string = NULL;
2617 for (r = command->redirects; r; r = rnext) {
2618 debug_printf_clean(" redirect %d%s",
2619 r->rd_fd, redir_table[r->rd_type].descrip);
2620 /* guard against the case >$FOO, where foo is unset or blank */
2621 if (r->rd_filename) {
2622 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
2623 free(r->rd_filename);
2624 //r->rd_filename = NULL;
2626 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
2630 //command->redirects = NULL;
2632 free(pi->cmds); /* children are an array, they get freed all at once */
2636 //pi->cmdtext = NULL;
2644 static void free_pipe_list(struct pipe *pi)
2648 debug_printf_clean("pipe reserved word %d\n", pi->res_word);
2650 debug_printf_clean("pipe followup code %d\n", pi->followup);
2656 /*** Parsing routines ***/
2658 #ifndef debug_print_tree
2659 static void debug_print_tree(struct pipe *pi, int lvl)
2661 static const char *const PIPE[] = {
2667 static const char *RES[] = {
2668 [RES_NONE ] = "NONE" ,
2671 [RES_THEN ] = "THEN" ,
2672 [RES_ELIF ] = "ELIF" ,
2673 [RES_ELSE ] = "ELSE" ,
2676 # if ENABLE_HUSH_LOOPS
2677 [RES_FOR ] = "FOR" ,
2678 [RES_WHILE] = "WHILE",
2679 [RES_UNTIL] = "UNTIL",
2681 [RES_DONE ] = "DONE" ,
2683 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2686 # if ENABLE_HUSH_CASE
2687 [RES_CASE ] = "CASE" ,
2688 [RES_CASE_IN ] = "CASE_IN" ,
2689 [RES_MATCH] = "MATCH",
2690 [RES_CASE_BODY] = "CASE_BODY",
2691 [RES_ESAC ] = "ESAC" ,
2693 [RES_XXXX ] = "XXXX" ,
2694 [RES_SNTX ] = "SNTX" ,
2696 static const char *const CMDTYPE[] = {
2700 # if ENABLE_HUSH_FUNCTIONS
2709 fdprintf(2, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
2710 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
2712 while (prn < pi->num_cmds) {
2713 struct command *command = &pi->cmds[prn];
2714 char **argv = command->argv;
2716 fdprintf(2, "%*s cmd %d assignment_cnt:%d",
2718 command->assignment_cnt);
2719 if (command->group) {
2720 fdprintf(2, " group %s: (argv=%p)%s%s\n",
2721 CMDTYPE[command->cmd_type],
2724 , " group_as_string:", command->group_as_string
2729 debug_print_tree(command->group, lvl+1);
2733 if (argv) while (*argv) {
2734 fdprintf(2, " '%s'", *argv);
2744 #endif /* debug_print_tree */
2746 static struct pipe *new_pipe(void)
2749 pi = xzalloc(sizeof(struct pipe));
2750 /*pi->followup = 0; - deliberately invalid value */
2751 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
2755 /* Command (member of a pipe) is complete, or we start a new pipe
2756 * if ctx->command is NULL.
2757 * No errors possible here.
2759 static int done_command(struct parse_context *ctx)
2761 /* The command is really already in the pipe structure, so
2762 * advance the pipe counter and make a new, null command. */
2763 struct pipe *pi = ctx->pipe;
2764 struct command *command = ctx->command;
2767 if (IS_NULL_CMD(command)) {
2768 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
2772 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
2773 //debug_print_tree(ctx->list_head, 20);
2775 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
2778 /* Only real trickiness here is that the uncommitted
2779 * command structure is not counted in pi->num_cmds. */
2780 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
2781 ctx->command = command = &pi->cmds[pi->num_cmds];
2783 memset(command, 0, sizeof(*command));
2784 return pi->num_cmds; /* used only for 0/nonzero check */
2787 static void done_pipe(struct parse_context *ctx, pipe_style type)
2791 debug_printf_parse("done_pipe entered, followup %d\n", type);
2792 /* Close previous command */
2793 not_null = done_command(ctx);
2794 ctx->pipe->followup = type;
2796 ctx->pipe->pi_inverted = ctx->ctx_inverted;
2797 ctx->ctx_inverted = 0;
2798 ctx->pipe->res_word = ctx->ctx_res_w;
2801 /* Without this check, even just <enter> on command line generates
2802 * tree of three NOPs (!). Which is harmless but annoying.
2803 * IOW: it is safe to do it unconditionally. */
2806 || ctx->ctx_res_w == RES_FI
2808 #if ENABLE_HUSH_LOOPS
2809 || ctx->ctx_res_w == RES_DONE
2810 || ctx->ctx_res_w == RES_FOR
2811 || ctx->ctx_res_w == RES_IN
2813 #if ENABLE_HUSH_CASE
2814 || ctx->ctx_res_w == RES_ESAC
2818 debug_printf_parse("done_pipe: adding new pipe: "
2819 "not_null:%d ctx->ctx_res_w:%d\n",
2820 not_null, ctx->ctx_res_w);
2822 ctx->pipe->next = new_p;
2824 /* RES_THEN, RES_DO etc are "sticky" -
2825 * they remain set for pipes inside if/while.
2826 * This is used to control execution.
2827 * RES_FOR and RES_IN are NOT sticky (needed to support
2828 * cases where variable or value happens to match a keyword):
2830 #if ENABLE_HUSH_LOOPS
2831 if (ctx->ctx_res_w == RES_FOR
2832 || ctx->ctx_res_w == RES_IN)
2833 ctx->ctx_res_w = RES_NONE;
2835 #if ENABLE_HUSH_CASE
2836 if (ctx->ctx_res_w == RES_MATCH)
2837 ctx->ctx_res_w = RES_CASE_BODY;
2838 if (ctx->ctx_res_w == RES_CASE)
2839 ctx->ctx_res_w = RES_CASE_IN;
2841 ctx->command = NULL; /* trick done_command below */
2842 /* Create the memory for command, roughly:
2843 * ctx->pipe->cmds = new struct command;
2844 * ctx->command = &ctx->pipe->cmds[0];
2847 //debug_print_tree(ctx->list_head, 10);
2849 debug_printf_parse("done_pipe return\n");
2852 static void initialize_context(struct parse_context *ctx)
2854 memset(ctx, 0, sizeof(*ctx));
2855 ctx->pipe = ctx->list_head = new_pipe();
2856 /* Create the memory for command, roughly:
2857 * ctx->pipe->cmds = new struct command;
2858 * ctx->command = &ctx->pipe->cmds[0];
2863 /* If a reserved word is found and processed, parse context is modified
2864 * and 1 is returned.
2867 struct reserved_combo {
2870 unsigned char assignment_flag;
2874 FLAG_END = (1 << RES_NONE ),
2876 FLAG_IF = (1 << RES_IF ),
2877 FLAG_THEN = (1 << RES_THEN ),
2878 FLAG_ELIF = (1 << RES_ELIF ),
2879 FLAG_ELSE = (1 << RES_ELSE ),
2880 FLAG_FI = (1 << RES_FI ),
2882 # if ENABLE_HUSH_LOOPS
2883 FLAG_FOR = (1 << RES_FOR ),
2884 FLAG_WHILE = (1 << RES_WHILE),
2885 FLAG_UNTIL = (1 << RES_UNTIL),
2886 FLAG_DO = (1 << RES_DO ),
2887 FLAG_DONE = (1 << RES_DONE ),
2888 FLAG_IN = (1 << RES_IN ),
2890 # if ENABLE_HUSH_CASE
2891 FLAG_MATCH = (1 << RES_MATCH),
2892 FLAG_ESAC = (1 << RES_ESAC ),
2894 FLAG_START = (1 << RES_XXXX ),
2897 static const struct reserved_combo* match_reserved_word(o_string *word)
2899 /* Mostly a list of accepted follow-up reserved words.
2900 * FLAG_END means we are done with the sequence, and are ready
2901 * to turn the compound list into a command.
2902 * FLAG_START means the word must start a new compound list.
2904 static const struct reserved_combo reserved_list[] = {
2906 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
2907 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
2908 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
2909 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
2910 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
2911 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
2913 # if ENABLE_HUSH_LOOPS
2914 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
2915 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
2916 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
2917 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
2918 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
2919 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
2921 # if ENABLE_HUSH_CASE
2922 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
2923 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
2926 const struct reserved_combo *r;
2928 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
2929 if (strcmp(word->data, r->literal) == 0)
2934 /* Return 0: not a keyword, 1: keyword
2936 static int reserved_word(o_string *word, struct parse_context *ctx)
2938 # if ENABLE_HUSH_CASE
2939 static const struct reserved_combo reserved_match = {
2940 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
2943 const struct reserved_combo *r;
2945 if (word->has_quoted_part)
2947 r = match_reserved_word(word);
2951 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
2952 # if ENABLE_HUSH_CASE
2953 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
2954 /* "case word IN ..." - IN part starts first MATCH part */
2955 r = &reserved_match;
2958 if (r->flag == 0) { /* '!' */
2959 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
2960 syntax_error("! ! command");
2961 ctx->ctx_res_w = RES_SNTX;
2963 ctx->ctx_inverted = 1;
2966 if (r->flag & FLAG_START) {
2967 struct parse_context *old;
2969 old = xmalloc(sizeof(*old));
2970 debug_printf_parse("push stack %p\n", old);
2971 *old = *ctx; /* physical copy */
2972 initialize_context(ctx);
2974 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
2975 syntax_error_at(word->data);
2976 ctx->ctx_res_w = RES_SNTX;
2979 /* "{...} fi" is ok. "{...} if" is not
2981 * if { echo foo; } then { echo bar; } fi */
2982 if (ctx->command->group)
2983 done_pipe(ctx, PIPE_SEQ);
2986 ctx->ctx_res_w = r->res;
2987 ctx->old_flag = r->flag;
2988 word->o_assignment = r->assignment_flag;
2990 if (ctx->old_flag & FLAG_END) {
2991 struct parse_context *old;
2993 done_pipe(ctx, PIPE_SEQ);
2994 debug_printf_parse("pop stack %p\n", ctx->stack);
2996 old->command->group = ctx->list_head;
2997 old->command->cmd_type = CMD_NORMAL;
2999 o_addstr(&old->as_string, ctx->as_string.data);
3000 o_free_unsafe(&ctx->as_string);
3001 old->command->group_as_string = xstrdup(old->as_string.data);
3002 debug_printf_parse("pop, remembering as:'%s'\n",
3003 old->command->group_as_string);
3005 *ctx = *old; /* physical copy */
3010 #endif /* HAS_KEYWORDS */
3012 /* Word is complete, look at it and update parsing context.
3013 * Normal return is 0. Syntax errors return 1.
3014 * Note: on return, word is reset, but not o_free'd!
3016 static int done_word(o_string *word, struct parse_context *ctx)
3018 struct command *command = ctx->command;
3020 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3021 if (word->length == 0 && !word->has_quoted_part) {
3022 debug_printf_parse("done_word return 0: true null, ignored\n");
3026 if (ctx->pending_redirect) {
3027 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3028 * only if run as "bash", not "sh" */
3029 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3031 * ...the word that follows the redirection operator
3032 * shall be subjected to tilde expansion, parameter expansion,
3033 * command substitution, arithmetic expansion, and quote
3034 * removal. Pathname expansion shall not be performed
3035 * on the word by a non-interactive shell; an interactive
3036 * shell may perform it, but shall do so only when
3037 * the expansion would result in one word."
3039 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3040 /* Cater for >\file case:
3041 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
3042 * Same with heredocs:
3043 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
3045 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
3046 unbackslash(ctx->pending_redirect->rd_filename);
3047 /* Is it <<"HEREDOC"? */
3048 if (word->has_quoted_part) {
3049 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
3052 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
3053 ctx->pending_redirect = NULL;
3055 /* If this word wasn't an assignment, next ones definitely
3056 * can't be assignments. Even if they look like ones. */
3057 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3058 && word->o_assignment != WORD_IS_KEYWORD
3060 word->o_assignment = NOT_ASSIGNMENT;
3062 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3063 command->assignment_cnt++;
3064 word->o_assignment = MAYBE_ASSIGNMENT;
3068 # if ENABLE_HUSH_CASE
3069 if (ctx->ctx_dsemicolon
3070 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3072 /* already done when ctx_dsemicolon was set to 1: */
3073 /* ctx->ctx_res_w = RES_MATCH; */
3074 ctx->ctx_dsemicolon = 0;
3077 if (!command->argv /* if it's the first word... */
3078 # if ENABLE_HUSH_LOOPS
3079 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3080 && ctx->ctx_res_w != RES_IN
3082 # if ENABLE_HUSH_CASE
3083 && ctx->ctx_res_w != RES_CASE
3086 debug_printf_parse("checking '%s' for reserved-ness\n", word->data);
3087 if (reserved_word(word, ctx)) {
3088 o_reset_to_empty_unquoted(word);
3089 debug_printf_parse("done_word return %d\n",
3090 (ctx->ctx_res_w == RES_SNTX));
3091 return (ctx->ctx_res_w == RES_SNTX);
3093 # if ENABLE_HUSH_BASH_COMPAT
3094 if (strcmp(word->data, "[[") == 0) {
3095 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
3101 if (command->group) {
3102 /* "{ echo foo; } echo bar" - bad */
3103 syntax_error_at(word->data);
3104 debug_printf_parse("done_word return 1: syntax error, "
3105 "groups and arglists don't mix\n");
3108 if (word->has_quoted_part
3109 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3110 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3111 /* (otherwise it's known to be not empty and is already safe) */
3113 /* exclude "$@" - it can expand to no word despite "" */
3114 char *p = word->data;
3115 while (p[0] == SPECIAL_VAR_SYMBOL
3116 && (p[1] & 0x7f) == '@'
3117 && p[2] == SPECIAL_VAR_SYMBOL
3121 if (p == word->data || p[0] != '\0') {
3122 /* saw no "$@", or not only "$@" but some
3123 * real text is there too */
3124 /* insert "empty variable" reference, this makes
3125 * e.g. "", $empty"" etc to not disappear */
3126 o_addchr(word, SPECIAL_VAR_SYMBOL);
3127 o_addchr(word, SPECIAL_VAR_SYMBOL);
3130 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3131 debug_print_strings("word appended to argv", command->argv);
3134 #if ENABLE_HUSH_LOOPS
3135 if (ctx->ctx_res_w == RES_FOR) {
3136 if (word->has_quoted_part
3137 || !is_well_formed_var_name(command->argv[0], '\0')
3139 /* bash says just "not a valid identifier" */
3140 syntax_error("not a valid identifier in for");
3143 /* Force FOR to have just one word (variable name) */
3144 /* NB: basically, this makes hush see "for v in ..."
3145 * syntax as if it is "for v; in ...". FOR and IN become
3146 * two pipe structs in parse tree. */
3147 done_pipe(ctx, PIPE_SEQ);
3150 #if ENABLE_HUSH_CASE
3151 /* Force CASE to have just one word */
3152 if (ctx->ctx_res_w == RES_CASE) {
3153 done_pipe(ctx, PIPE_SEQ);
3157 o_reset_to_empty_unquoted(word);
3159 debug_printf_parse("done_word return 0\n");
3164 /* Peek ahead in the input to find out if we have a "&n" construct,
3165 * as in "2>&1", that represents duplicating a file descriptor.
3167 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
3168 * REDIRFD_SYNTAX_ERR if syntax error,
3169 * REDIRFD_TO_FILE if no & was seen,
3170 * or the number found.
3173 #define parse_redir_right_fd(as_string, input) \
3174 parse_redir_right_fd(input)
3176 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
3182 return REDIRFD_TO_FILE;
3184 ch = i_getch(input); /* get the & */
3185 nommu_addchr(as_string, ch);
3188 ch = i_getch(input);
3189 nommu_addchr(as_string, ch);
3190 return REDIRFD_CLOSE;
3194 while (ch != EOF && isdigit(ch)) {
3195 d = d*10 + (ch-'0');
3197 ch = i_getch(input);
3198 nommu_addchr(as_string, ch);
3203 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
3205 bb_error_msg("ambiguous redirect");
3206 return REDIRFD_SYNTAX_ERR;
3209 /* Return code is 0 normal, 1 if a syntax error is detected
3211 static int parse_redirect(struct parse_context *ctx,
3214 struct in_str *input)
3216 struct command *command = ctx->command;
3217 struct redir_struct *redir;
3218 struct redir_struct **redirp;
3221 dup_num = REDIRFD_TO_FILE;
3222 if (style != REDIRECT_HEREDOC) {
3223 /* Check for a '>&1' type redirect */
3224 dup_num = parse_redir_right_fd(&ctx->as_string, input);
3225 if (dup_num == REDIRFD_SYNTAX_ERR)
3228 int ch = i_peek(input);
3229 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
3230 if (dup_num) { /* <<-... */
3231 ch = i_getch(input);
3232 nommu_addchr(&ctx->as_string, ch);
3237 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
3238 int ch = i_peek(input);
3240 /* >|FILE redirect ("clobbering" >).
3241 * Since we do not support "set -o noclobber" yet,
3242 * >| and > are the same for now. Just eat |.
3244 ch = i_getch(input);
3245 nommu_addchr(&ctx->as_string, ch);
3249 /* Create a new redir_struct and append it to the linked list */
3250 redirp = &command->redirects;
3251 while ((redir = *redirp) != NULL) {
3252 redirp = &(redir->next);
3254 *redirp = redir = xzalloc(sizeof(*redir));
3255 /* redir->next = NULL; */
3256 /* redir->rd_filename = NULL; */
3257 redir->rd_type = style;
3258 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
3260 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
3261 redir_table[style].descrip);
3263 redir->rd_dup = dup_num;
3264 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
3265 /* Erik had a check here that the file descriptor in question
3266 * is legit; I postpone that to "run time"
3267 * A "-" representation of "close me" shows up as a -3 here */
3268 debug_printf_parse("duplicating redirect '%d>&%d'\n",
3269 redir->rd_fd, redir->rd_dup);
3271 /* Set ctx->pending_redirect, so we know what to do at the
3272 * end of the next parsed word. */
3273 ctx->pending_redirect = redir;
3278 /* If a redirect is immediately preceded by a number, that number is
3279 * supposed to tell which file descriptor to redirect. This routine
3280 * looks for such preceding numbers. In an ideal world this routine
3281 * needs to handle all the following classes of redirects...
3282 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3283 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3284 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3285 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3287 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3289 * ... If n is quoted, the number shall not be recognized as part of
3290 * the redirection expression. For example:
3292 * writes the character 2 into file a"
3293 * We are getting it right by setting ->has_quoted_part on any \<char>
3295 * A -1 return means no valid number was found,
3296 * the caller should use the appropriate default for this redirection.
3298 static int redirect_opt_num(o_string *o)
3302 if (o->data == NULL)
3304 num = bb_strtou(o->data, NULL, 10);
3305 if (errno || num < 0)
3307 o_reset_to_empty_unquoted(o);
3312 #define fetch_till_str(as_string, input, word, skip_tabs) \
3313 fetch_till_str(input, word, skip_tabs)
3315 static char *fetch_till_str(o_string *as_string,
3316 struct in_str *input,
3320 o_string heredoc = NULL_O_STRING;
3322 int prev = 0; /* not \ */
3327 ch = i_getch(input);
3329 nommu_addchr(as_string, ch);
3330 if ((ch == '\n' || ch == EOF)
3331 && ((heredoc_flags & HEREDOC_QUOTED) || prev != '\\')
3333 if (strcmp(heredoc.data + past_EOL, word) == 0) {
3334 heredoc.data[past_EOL] = '\0';
3335 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
3336 return heredoc.data;
3338 while (ch == '\n') {
3339 o_addchr(&heredoc, ch);
3342 past_EOL = heredoc.length;
3344 ch = i_getch(input);
3346 nommu_addchr(as_string, ch);
3347 } while ((heredoc_flags & HEREDOC_SKIPTABS) && ch == '\t');
3351 o_free_unsafe(&heredoc);
3354 o_addchr(&heredoc, ch);
3355 nommu_addchr(as_string, ch);
3356 if (prev == '\\' && ch == '\\')
3357 /* Correctly handle foo\\<eol> (not a line cont.) */
3358 prev = 0; /* not \ */
3364 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
3365 * and load them all. There should be exactly heredoc_cnt of them.
3367 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
3369 struct pipe *pi = ctx->list_head;
3371 while (pi && heredoc_cnt) {
3373 struct command *cmd = pi->cmds;
3375 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
3377 cmd->argv ? cmd->argv[0] : "NONE");
3378 for (i = 0; i < pi->num_cmds; i++) {
3379 struct redir_struct *redir = cmd->redirects;
3381 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
3382 i, cmd->argv ? cmd->argv[0] : "NONE");
3384 if (redir->rd_type == REDIRECT_HEREDOC) {
3387 redir->rd_type = REDIRECT_HEREDOC2;
3388 /* redir->rd_dup is (ab)used to indicate <<- */
3389 p = fetch_till_str(&ctx->as_string, input,
3390 redir->rd_filename, redir->rd_dup);
3392 syntax_error("unexpected EOF in here document");
3395 free(redir->rd_filename);
3396 redir->rd_filename = p;
3399 redir = redir->next;
3406 /* Should be 0. If it isn't, it's a parse error */
3408 bb_error_msg_and_die("heredoc BUG 2");
3414 static int run_list(struct pipe *pi);
3416 #define parse_stream(pstring, input, end_trigger) \
3417 parse_stream(input, end_trigger)
3419 static struct pipe *parse_stream(char **pstring,
3420 struct in_str *input,
3424 #if !ENABLE_HUSH_FUNCTIONS
3425 #define parse_group(dest, ctx, input, ch) \
3426 parse_group(ctx, input, ch)
3428 static int parse_group(o_string *dest, struct parse_context *ctx,
3429 struct in_str *input, int ch)
3431 /* dest contains characters seen prior to ( or {.
3432 * Typically it's empty, but for function defs,
3433 * it contains function name (without '()'). */
3434 struct pipe *pipe_list;
3436 struct command *command = ctx->command;
3438 debug_printf_parse("parse_group entered\n");
3439 #if ENABLE_HUSH_FUNCTIONS
3440 if (ch == '(' && !dest->has_quoted_part) {
3442 if (done_word(dest, ctx))
3445 goto skip; /* (... */
3446 if (command->argv[1]) { /* word word ... (... */
3447 syntax_error_unexpected_ch('(');
3450 /* it is "word(..." or "word (..." */
3452 ch = i_getch(input);
3453 while (ch == ' ' || ch == '\t');
3455 syntax_error_unexpected_ch(ch);
3458 nommu_addchr(&ctx->as_string, ch);
3460 ch = i_getch(input);
3461 while (ch == ' ' || ch == '\t' || ch == '\n');
3463 syntax_error_unexpected_ch(ch);
3466 nommu_addchr(&ctx->as_string, ch);
3467 command->cmd_type = CMD_FUNCDEF;
3472 #if 0 /* Prevented by caller */
3473 if (command->argv /* word [word]{... */
3474 || dest->length /* word{... */
3475 || dest->has_quoted_part /* ""{... */
3478 debug_printf_parse("parse_group return 1: "
3479 "syntax error, groups and arglists don't mix\n");
3484 #if ENABLE_HUSH_FUNCTIONS
3490 command->cmd_type = CMD_SUBSHELL;
3492 /* bash does not allow "{echo...", requires whitespace */
3493 ch = i_getch(input);
3494 if (ch != ' ' && ch != '\t' && ch != '\n') {
3495 syntax_error_unexpected_ch(ch);
3498 nommu_addchr(&ctx->as_string, ch);
3503 # define as_string NULL
3505 char *as_string = NULL;
3507 pipe_list = parse_stream(&as_string, input, endch);
3510 o_addstr(&ctx->as_string, as_string);
3512 /* empty ()/{} or parse error? */
3513 if (!pipe_list || pipe_list == ERR_PTR) {
3514 /* parse_stream already emitted error msg */
3517 debug_printf_parse("parse_group return 1: "
3518 "parse_stream returned %p\n", pipe_list);
3521 command->group = pipe_list;
3523 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
3524 command->group_as_string = as_string;
3525 debug_printf_parse("end of group, remembering as:'%s'\n",
3526 command->group_as_string);
3530 debug_printf_parse("parse_group return 0\n");
3532 /* command remains "open", available for possible redirects */
3535 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS
3536 /* Subroutines for copying $(...) and `...` things */
3537 static void add_till_backquote(o_string *dest, struct in_str *input, int in_dquote);
3539 static void add_till_single_quote(o_string *dest, struct in_str *input)
3542 int ch = i_getch(input);
3544 syntax_error_unterm_ch('\'');
3545 /*xfunc_die(); - redundant */
3552 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
3553 static void add_till_double_quote(o_string *dest, struct in_str *input)
3556 int ch = i_getch(input);
3558 syntax_error_unterm_ch('"');
3559 /*xfunc_die(); - redundant */
3563 if (ch == '\\') { /* \x. Copy both chars. */
3565 ch = i_getch(input);
3569 add_till_backquote(dest, input, /*in_dquote:*/ 1);
3573 //if (ch == '$') ...
3576 /* Process `cmd` - copy contents until "`" is seen. Complicated by
3578 * "Within the backquoted style of command substitution, backslash
3579 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
3580 * The search for the matching backquote shall be satisfied by the first
3581 * backquote found without a preceding backslash; during this search,
3582 * if a non-escaped backquote is encountered within a shell comment,
3583 * a here-document, an embedded command substitution of the $(command)
3584 * form, or a quoted string, undefined results occur. A single-quoted
3585 * or double-quoted string that begins, but does not end, within the
3586 * "`...`" sequence produces undefined results."
3588 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
3590 static void add_till_backquote(o_string *dest, struct in_str *input, int in_dquote)
3593 int ch = i_getch(input);
3597 /* \x. Copy both unless it is \`, \$, \\ and maybe \" */
3598 ch = i_getch(input);
3602 && (!in_dquote || ch != '"')
3604 o_addchr(dest, '\\');
3608 syntax_error_unterm_ch('`');
3609 /*xfunc_die(); - redundant */
3614 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
3615 * quoting and nested ()s.
3616 * "With the $(command) style of command substitution, all characters
3617 * following the open parenthesis to the matching closing parenthesis
3618 * constitute the command. Any valid shell script can be used for command,
3619 * except a script consisting solely of redirections which produces
3620 * unspecified results."
3622 * echo $(echo '(TEST)' BEST) (TEST) BEST
3623 * echo $(echo 'TEST)' BEST) TEST) BEST
3624 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
3626 * Also adapted to eat ${var%...} and $((...)) constructs, since ... part
3627 * can contain arbitrary constructs, just like $(cmd).
3628 * In bash compat mode, it needs to also be able to stop on ':' or '/'
3629 * for ${var:N[:M]} and ${var/P[/R]} parsing.
3631 #define DOUBLE_CLOSE_CHAR_FLAG 0x80
3632 static int add_till_closing_bracket(o_string *dest, struct in_str *input, unsigned end_ch)
3635 char dbl = end_ch & DOUBLE_CLOSE_CHAR_FLAG;
3636 # if ENABLE_HUSH_BASH_COMPAT
3637 char end_char2 = end_ch >> 8;
3639 end_ch &= (DOUBLE_CLOSE_CHAR_FLAG - 1);
3642 ch = i_getch(input);
3644 syntax_error_unterm_ch(end_ch);
3645 /*xfunc_die(); - redundant */
3647 if (ch == end_ch IF_HUSH_BASH_COMPAT( || ch == end_char2)) {
3650 /* we look for closing )) of $((EXPR)) */
3651 if (i_peek(input) == end_ch) {
3652 i_getch(input); /* eat second ')' */
3657 if (ch == '(' || ch == '{') {
3658 ch = (ch == '(' ? ')' : '}');
3659 add_till_closing_bracket(dest, input, ch);
3664 add_till_single_quote(dest, input);
3669 add_till_double_quote(dest, input);
3674 add_till_backquote(dest, input, /*in_dquote:*/ 0);
3679 /* \x. Copy verbatim. Important for \(, \) */
3680 ch = i_getch(input);
3682 syntax_error_unterm_ch(')');
3683 /*xfunc_die(); - redundant */
3691 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS */
3693 /* Return code: 0 for OK, 1 for syntax error */
3695 #define parse_dollar(as_string, dest, input, quote_mask) \
3696 parse_dollar(dest, input, quote_mask)
3697 #define as_string NULL
3699 static int parse_dollar(o_string *as_string,
3701 struct in_str *input, unsigned char quote_mask)
3703 int ch = i_peek(input); /* first character after the $ */
3705 debug_printf_parse("parse_dollar entered: ch='%c'\n", ch);
3707 ch = i_getch(input);
3708 nommu_addchr(as_string, ch);
3710 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3712 debug_printf_parse(": '%c'\n", ch);
3713 o_addchr(dest, ch | quote_mask);
3716 if (!isalnum(ch) && ch != '_')
3718 ch = i_getch(input);
3719 nommu_addchr(as_string, ch);
3721 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3722 } else if (isdigit(ch)) {
3724 ch = i_getch(input);
3725 nommu_addchr(as_string, ch);
3726 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3727 debug_printf_parse(": '%c'\n", ch);
3728 o_addchr(dest, ch | quote_mask);
3729 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3730 } else switch (ch) {
3732 case '!': /* last bg pid */
3733 case '?': /* last exit code */
3734 case '#': /* number of args */
3735 case '*': /* args */
3736 case '@': /* args */
3737 goto make_one_char_var;
3739 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3741 ch = i_getch(input); /* eat '{' */
3742 nommu_addchr(as_string, ch);
3744 ch = i_getch(input); /* first char after '{' */
3745 /* It should be ${?}, or ${#var},
3746 * or even ${?+subst} - operator acting on a special variable,
3747 * or the beginning of variable name.
3750 || (!strchr(_SPECIAL_VARS_STR, ch) && !isalnum(ch)) /* not one of those */
3753 syntax_error_unterm_str("${name}");
3754 debug_printf_parse("parse_dollar return 1: unterminated ${name}\n");
3757 nommu_addchr(as_string, ch);
3760 /* It's possible to just call add_till_closing_bracket() at this point.
3761 * However, this regresses some of our testsuite cases
3762 * which check invalid constructs like ${%}.
3763 * Oh well... let's check that the var name part is fine... */
3769 debug_printf_parse(": '%c'\n", ch);
3771 ch = i_getch(input);
3772 nommu_addchr(as_string, ch);
3776 if (!isalnum(ch) && ch != '_') {
3778 unsigned char last_ch;
3779 /* handle parameter expansions
3780 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
3782 if (!strchr(VAR_SUBST_OPS, ch)) /* ${var<bad_char>... */
3783 goto bad_dollar_syntax;
3785 /* Eat everything until closing '}' (or ':') */
3787 if (ENABLE_HUSH_BASH_COMPAT
3789 && !strchr(MINUS_PLUS_EQUAL_QUESTION, i_peek(input))
3791 /* It's ${var:N[:M]} thing */
3792 end_ch = '}' * 0x100 + ':';
3794 if (ENABLE_HUSH_BASH_COMPAT
3797 /* It's ${var/[/]pattern[/repl]} thing */
3798 if (i_peek(input) == '/') { /* ${var//pattern[/repl]}? */
3800 nommu_addchr(as_string, '/');
3803 end_ch = '}' * 0x100 + '/';
3809 #if ENABLE_HUSH_DOLLAR_OPS
3810 last_ch = add_till_closing_bracket(dest, input, end_ch);
3812 #error Simple code to only allow ${var} is not implemented
3815 o_addstr(as_string, dest->data + pos);
3816 o_addchr(as_string, last_ch);
3819 if (ENABLE_HUSH_BASH_COMPAT && (end_ch & 0xff00)) {
3820 /* close the first block: */
3821 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3822 /* while parsing N from ${var:N[:M]}
3823 * or pattern from ${var/[/]pattern[/repl]} */
3824 if ((end_ch & 0xff) == last_ch) {
3825 /* got ':' or '/'- parse the rest */
3830 if (end_ch == '}' * 0x100 + ':') {
3831 /* it's ${var:N} - emulate :999999999 */
3832 o_addstr(dest, "999999999");
3833 } /* else: it's ${var/[/]pattern} */
3838 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3841 #if ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK
3845 ch = i_getch(input);
3846 nommu_addchr(as_string, ch);
3847 # if ENABLE_SH_MATH_SUPPORT
3848 if (i_peek(input) == '(') {
3849 ch = i_getch(input);
3850 nommu_addchr(as_string, ch);
3851 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3852 o_addchr(dest, /*quote_mask |*/ '+');
3855 add_till_closing_bracket(dest, input, ')' | DOUBLE_CLOSE_CHAR_FLAG);
3857 o_addstr(as_string, dest->data + pos);
3858 o_addchr(as_string, ')');
3859 o_addchr(as_string, ')');
3861 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3865 # if ENABLE_HUSH_TICK
3866 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3867 o_addchr(dest, quote_mask | '`');
3870 add_till_closing_bracket(dest, input, ')');
3872 o_addstr(as_string, dest->data + pos);
3873 o_addchr(as_string, ')');
3875 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3881 ch = i_getch(input);
3882 nommu_addchr(as_string, ch);
3884 if (isalnum(ch)) { /* it's $_name or $_123 */
3889 /* TODO: $_ and $-: */
3890 /* $_ Shell or shell script name; or last argument of last command
3891 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
3892 * but in command's env, set to full pathname used to invoke it */
3893 /* $- Option flags set by set builtin or shell options (-i etc) */
3895 o_addQchr(dest, '$');
3897 debug_printf_parse("parse_dollar return 0\n");
3903 # if ENABLE_HUSH_BASH_COMPAT
3904 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
3905 encode_string(dest, input, dquote_end, process_bkslash)
3907 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
3908 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
3909 encode_string(dest, input, dquote_end)
3911 #define as_string NULL
3915 # if ENABLE_HUSH_BASH_COMPAT
3916 /* all parameters are needed, no macro tricks */
3918 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
3919 encode_string(as_string, dest, input, dquote_end)
3922 static int encode_string(o_string *as_string,
3924 struct in_str *input,
3926 int process_bkslash)
3928 #if !ENABLE_HUSH_BASH_COMPAT
3929 const int process_bkslash = 1;
3935 ch = i_getch(input);
3937 nommu_addchr(as_string, ch);
3938 if (ch == dquote_end) { /* may be only '"' or EOF */
3939 debug_printf_parse("encode_string return 0\n");
3942 /* note: can't move it above ch == dquote_end check! */
3944 syntax_error_unterm_ch('"');
3945 /*xfunc_die(); - redundant */
3949 next = i_peek(input);
3951 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
3952 ch, ch, !!(dest->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
3953 if (process_bkslash && ch == '\\') {
3955 syntax_error("\\<eof>");
3959 * "The backslash retains its special meaning [in "..."]
3960 * only when followed by one of the following characters:
3961 * $, `, ", \, or <newline>. A double quote may be quoted
3962 * within double quotes by preceding it with a backslash."
3963 * NB: in (unquoted) heredoc, above does not apply to ",
3964 * therefore we check for it by "next == dquote_end" cond.
3966 if (next == dquote_end || strchr("$`\\\n", next)) {
3967 ch = i_getch(input); /* eat next */
3969 goto again; /* skip \<newline> */
3970 } /* else: ch remains == '\\', and we double it below: */
3971 o_addqchr(dest, ch); /* \c if c is a glob char, else just c */
3972 nommu_addchr(as_string, ch);
3976 if (parse_dollar(as_string, dest, input, /*quote_mask:*/ 0x80) != 0) {
3977 debug_printf_parse("encode_string return 1: "
3978 "parse_dollar returned non-0\n");
3983 #if ENABLE_HUSH_TICK
3985 //unsigned pos = dest->length;
3986 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3987 o_addchr(dest, 0x80 | '`');
3988 add_till_backquote(dest, input, /*in_dquote:*/ dquote_end == '"');
3989 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3990 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
3994 o_addQchr(dest, ch);
4000 * Scan input until EOF or end_trigger char.
4001 * Return a list of pipes to execute, or NULL on EOF
4002 * or if end_trigger character is met.
4003 * On syntax error, exit is shell is not interactive,
4004 * reset parsing machinery and start parsing anew,
4005 * or return ERR_PTR.
4007 static struct pipe *parse_stream(char **pstring,
4008 struct in_str *input,
4011 struct parse_context ctx;
4012 o_string dest = NULL_O_STRING;
4015 /* Single-quote triggers a bypass of the main loop until its mate is
4016 * found. When recursing, quote state is passed in via dest->o_expflags.
4018 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4019 end_trigger ? end_trigger : 'X');
4022 /* If very first arg is "" or '', dest.data may end up NULL.
4023 * Preventing this: */
4024 o_addchr(&dest, '\0');
4027 /* We used to separate words on $IFS here. This was wrong.
4028 * $IFS is used only for word splitting when $var is expanded,
4029 * here we should use blank chars as separators, not $IFS
4032 reset: /* we come back here only on syntax errors in interactive shell */
4034 #if ENABLE_HUSH_INTERACTIVE
4035 input->promptmode = 0; /* PS1 */
4037 if (MAYBE_ASSIGNMENT != 0)
4038 dest.o_assignment = MAYBE_ASSIGNMENT;
4039 initialize_context(&ctx);
4042 const char *is_blank;
4043 const char *is_special;
4047 redir_type redir_style;
4049 ch = i_getch(input);
4050 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4051 ch, ch, !!(dest.o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
4056 syntax_error_unterm_str("here document");
4059 /* end_trigger == '}' case errors out earlier,
4060 * checking only ')' */
4061 if (end_trigger == ')') {
4062 syntax_error_unterm_ch('('); /* exits */
4063 /* goto parse_error; */
4066 if (done_word(&dest, &ctx)) {
4070 done_pipe(&ctx, PIPE_SEQ);
4072 /* If we got nothing... */
4073 /* (this makes bare "&" cmd a no-op.
4074 * bash says: "syntax error near unexpected token '&'") */
4075 if (pi->num_cmds == 0
4076 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
4082 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4084 *pstring = ctx.as_string.data;
4086 o_free_unsafe(&ctx.as_string);
4089 debug_printf_parse("parse_stream return %p\n", pi);
4092 nommu_addchr(&ctx.as_string, ch);
4096 next = i_peek(input);
4098 is_special = "{}<>;&|()#'" /* special outside of "str" */
4099 "\\$\"" IF_HUSH_TICK("`"); /* always special */
4100 /* Are { and } special here? */
4101 if (ctx.command->argv /* word [word]{... - non-special */
4102 || dest.length /* word{... - non-special */
4103 || dest.has_quoted_part /* ""{... - non-special */
4104 || (next != ';' /* }; - special */
4105 && next != ')' /* }) - special */
4106 && next != '&' /* }& and }&& ... - special */
4107 && next != '|' /* }|| ... - special */
4108 && !strchr(defifs, next) /* {word - non-special */
4111 /* They are not special, skip "{}" */
4114 is_special = strchr(is_special, ch);
4115 is_blank = strchr(defifs, ch);
4117 if (!is_special && !is_blank) { /* ordinary char */
4119 o_addQchr(&dest, ch);
4120 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4121 || dest.o_assignment == WORD_IS_KEYWORD)
4123 && is_well_formed_var_name(dest.data, '=')
4125 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4131 if (done_word(&dest, &ctx)) {
4135 /* Is this a case when newline is simply ignored?
4137 * "cmd | <newline> cmd ..."
4138 * "case ... in <newline> word) ..."
4140 if (IS_NULL_CMD(ctx.command)
4141 && dest.length == 0 && !dest.has_quoted_part
4143 /* This newline can be ignored. But...
4144 * without the below check, interactive shell
4145 * will ignore even lines with bare <newline>,
4146 * and show the continuation prompt:
4147 * ps1_prompt$ <enter>
4148 * ps2> _ <=== wrong prompt, should be ps1
4150 struct pipe *pi = ctx.list_head;
4151 if (pi->num_cmds != 0)
4154 /* Treat newline as a command separator. */
4155 done_pipe(&ctx, PIPE_SEQ);
4156 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
4158 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
4163 dest.o_assignment = MAYBE_ASSIGNMENT;
4165 /* note: if (is_blank) continue;
4166 * will still trigger for us */
4170 /* "cmd}" or "cmd }..." without semicolon or &:
4171 * } is an ordinary char in this case, even inside { cmd; }
4172 * Pathological example: { ""}; } should exec "}" cmd
4175 if (!IS_NULL_CMD(ctx.command) /* cmd } */
4176 || dest.length != 0 /* word} */
4177 || dest.has_quoted_part /* ""} */
4181 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
4182 goto skip_end_trigger;
4183 /* else: } does terminate a group */
4186 if (end_trigger && end_trigger == ch
4187 && (ch != ';' || heredoc_cnt == 0)
4188 #if ENABLE_HUSH_CASE
4190 || ctx.ctx_res_w != RES_MATCH
4191 || (!dest.has_quoted_part && strcmp(dest.data, "esac") == 0)
4196 /* This is technically valid:
4197 * { cat <<HERE; }; echo Ok
4201 * but we don't support this.
4202 * We require heredoc to be in enclosing {}/(),
4205 syntax_error_unterm_str("here document");
4208 if (done_word(&dest, &ctx)) {
4211 done_pipe(&ctx, PIPE_SEQ);
4212 dest.o_assignment = MAYBE_ASSIGNMENT;
4213 /* Do we sit outside of any if's, loops or case's? */
4215 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4219 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4221 *pstring = ctx.as_string.data;
4223 o_free_unsafe(&ctx.as_string);
4226 debug_printf_parse("parse_stream return %p: "
4227 "end_trigger char found\n",
4229 return ctx.list_head;
4236 /* Catch <, > before deciding whether this word is
4237 * an assignment. a=1 2>z b=2: b=2 is still assignment */
4240 redir_fd = redirect_opt_num(&dest);
4241 if (done_word(&dest, &ctx)) {
4244 redir_style = REDIRECT_OVERWRITE;
4246 redir_style = REDIRECT_APPEND;
4247 ch = i_getch(input);
4248 nommu_addchr(&ctx.as_string, ch);
4251 else if (next == '(') {
4252 syntax_error(">(process) not supported");
4256 if (parse_redirect(&ctx, redir_fd, redir_style, input))
4258 continue; /* back to top of while (1) */
4260 redir_fd = redirect_opt_num(&dest);
4261 if (done_word(&dest, &ctx)) {
4264 redir_style = REDIRECT_INPUT;
4266 redir_style = REDIRECT_HEREDOC;
4268 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
4269 ch = i_getch(input);
4270 nommu_addchr(&ctx.as_string, ch);
4271 } else if (next == '>') {
4272 redir_style = REDIRECT_IO;
4273 ch = i_getch(input);
4274 nommu_addchr(&ctx.as_string, ch);
4277 else if (next == '(') {
4278 syntax_error("<(process) not supported");
4282 if (parse_redirect(&ctx, redir_fd, redir_style, input))
4284 continue; /* back to top of while (1) */
4286 if (dest.length == 0 && !dest.has_quoted_part) {
4287 /* skip "#comment" */
4290 if (ch == EOF || ch == '\n')
4293 /* note: we do not add it to &ctx.as_string */
4295 nommu_addchr(&ctx.as_string, '\n');
4296 continue; /* back to top of while (1) */
4301 /* It's "\<newline>" */
4303 /* Remove trailing '\' from ctx.as_string */
4304 ctx.as_string.data[--ctx.as_string.length] = '\0';
4306 ch = i_getch(input); /* eat it */
4307 continue; /* back to top of while (1) */
4312 if (dest.o_assignment == MAYBE_ASSIGNMENT
4313 /* check that we are not in word in "a=1 2>word b=1": */
4314 && !ctx.pending_redirect
4316 /* ch is a special char and thus this word
4317 * cannot be an assignment */
4318 dest.o_assignment = NOT_ASSIGNMENT;
4321 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
4324 case '#': /* non-comment #: "echo a#b" etc */
4325 o_addQchr(&dest, ch);
4329 syntax_error("\\<eof>");
4332 ch = i_getch(input);
4333 /* note: ch != '\n' (that case does not reach this place) */
4334 o_addchr(&dest, '\\');
4335 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
4336 o_addchr(&dest, ch);
4337 nommu_addchr(&ctx.as_string, ch);
4338 /* Example: echo Hello \2>file
4339 * we need to know that word 2 is quoted */
4340 dest.has_quoted_part = 1;
4343 if (parse_dollar(&ctx.as_string, &dest, input, /*quote_mask:*/ 0) != 0) {
4344 debug_printf_parse("parse_stream parse error: "
4345 "parse_dollar returned non-0\n");
4350 dest.has_quoted_part = 1;
4352 ch = i_getch(input);
4354 syntax_error_unterm_ch('\'');
4355 /*xfunc_die(); - redundant */
4357 nommu_addchr(&ctx.as_string, ch);
4360 o_addqchr(&dest, ch);
4364 dest.has_quoted_part = 1;
4365 if (dest.o_assignment == NOT_ASSIGNMENT)
4366 dest.o_expflags |= EXP_FLAG_ESC_GLOB_CHARS;
4367 if (encode_string(&ctx.as_string, &dest, input, '"', /*process_bkslash:*/ 1))
4369 dest.o_expflags &= ~EXP_FLAG_ESC_GLOB_CHARS;
4371 #if ENABLE_HUSH_TICK
4375 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4376 o_addchr(&dest, '`');
4378 add_till_backquote(&dest, input, /*in_dquote:*/ 0);
4380 o_addstr(&ctx.as_string, dest.data + pos);
4381 o_addchr(&ctx.as_string, '`');
4383 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4384 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4389 #if ENABLE_HUSH_CASE
4392 if (done_word(&dest, &ctx)) {
4395 done_pipe(&ctx, PIPE_SEQ);
4396 #if ENABLE_HUSH_CASE
4397 /* Eat multiple semicolons, detect
4398 * whether it means something special */
4403 ch = i_getch(input);
4404 nommu_addchr(&ctx.as_string, ch);
4405 if (ctx.ctx_res_w == RES_CASE_BODY) {
4406 ctx.ctx_dsemicolon = 1;
4407 ctx.ctx_res_w = RES_MATCH;
4413 /* We just finished a cmd. New one may start
4414 * with an assignment */
4415 dest.o_assignment = MAYBE_ASSIGNMENT;
4418 if (done_word(&dest, &ctx)) {
4422 ch = i_getch(input);
4423 nommu_addchr(&ctx.as_string, ch);
4424 done_pipe(&ctx, PIPE_AND);
4426 done_pipe(&ctx, PIPE_BG);
4430 if (done_word(&dest, &ctx)) {
4433 #if ENABLE_HUSH_CASE
4434 if (ctx.ctx_res_w == RES_MATCH)
4435 break; /* we are in case's "word | word)" */
4437 if (next == '|') { /* || */
4438 ch = i_getch(input);
4439 nommu_addchr(&ctx.as_string, ch);
4440 done_pipe(&ctx, PIPE_OR);
4442 /* we could pick up a file descriptor choice here
4443 * with redirect_opt_num(), but bash doesn't do it.
4444 * "echo foo 2| cat" yields "foo 2". */
4447 o_reset_to_empty_unquoted(&ctx.as_string);
4452 #if ENABLE_HUSH_CASE
4453 /* "case... in [(]word)..." - skip '(' */
4454 if (ctx.ctx_res_w == RES_MATCH
4455 && ctx.command->argv == NULL /* not (word|(... */
4456 && dest.length == 0 /* not word(... */
4457 && dest.has_quoted_part == 0 /* not ""(... */
4463 if (parse_group(&dest, &ctx, input, ch) != 0) {
4468 #if ENABLE_HUSH_CASE
4469 if (ctx.ctx_res_w == RES_MATCH)
4473 /* proper use of this character is caught by end_trigger:
4474 * if we see {, we call parse_group(..., end_trigger='}')
4475 * and it will match } earlier (not here). */
4476 syntax_error_unexpected_ch(ch);
4480 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4486 struct parse_context *pctx;
4487 IF_HAS_KEYWORDS(struct parse_context *p2;)
4489 /* Clean up allocated tree.
4490 * Sample for finding leaks on syntax error recovery path.
4491 * Run it from interactive shell, watch pmap `pidof hush`.
4492 * while if false; then false; fi; do break; fi
4493 * Samples to catch leaks at execution:
4494 * while if (true | {true;}); then echo ok; fi; do break; done
4495 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
4499 /* Update pipe/command counts,
4500 * otherwise freeing may miss some */
4501 done_pipe(pctx, PIPE_SEQ);
4502 debug_printf_clean("freeing list %p from ctx %p\n",
4503 pctx->list_head, pctx);
4504 debug_print_tree(pctx->list_head, 0);
4505 free_pipe_list(pctx->list_head);
4506 debug_printf_clean("freed list %p\n", pctx->list_head);
4508 o_free_unsafe(&pctx->as_string);
4510 IF_HAS_KEYWORDS(p2 = pctx->stack;)
4514 IF_HAS_KEYWORDS(pctx = p2;)
4515 } while (HAS_KEYWORDS && pctx);
4516 /* Free text, clear all dest fields */
4518 /* If we are not in top-level parse, we return,
4519 * our caller will propagate error.
4521 if (end_trigger != ';') {
4529 /* Discard cached input, force prompt */
4531 IF_HUSH_INTERACTIVE(input->promptme = 1;)
4537 /*** Execution routines ***/
4539 /* Expansion can recurse, need forward decls: */
4540 #if !ENABLE_HUSH_BASH_COMPAT
4541 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4542 #define expand_string_to_string(str, do_unbackslash) \
4543 expand_string_to_string(str)
4545 static char *expand_string_to_string(const char *str, int do_unbackslash);
4546 #if ENABLE_HUSH_TICK
4547 static int process_command_subs(o_string *dest, const char *s);
4550 /* expand_strvec_to_strvec() takes a list of strings, expands
4551 * all variable references within and returns a pointer to
4552 * a list of expanded strings, possibly with larger number
4553 * of strings. (Think VAR="a b"; echo $VAR).
4554 * This new list is allocated as a single malloc block.
4555 * NULL-terminated list of char* pointers is at the beginning of it,
4556 * followed by strings themselves.
4557 * Caller can deallocate entire list by single free(list). */
4559 /* A horde of its helpers come first: */
4561 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
4563 while (--len >= 0) {
4566 #if ENABLE_HUSH_BRACE_EXPANSION
4567 if (c == '{' || c == '}') {
4568 /* { -> \{, } -> \} */
4570 /* And now we want to add { or } and continue:
4573 * luckily, just falling throught achieves this.
4579 /* \z -> \\\z; \<eol> -> \\<eol> */
4584 o_addchr(o, *str++);
4590 /* Store given string, finalizing the word and starting new one whenever
4591 * we encounter IFS char(s). This is used for expanding variable values.
4592 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
4593 static int expand_on_ifs(o_string *output, int n, const char *str)
4596 int word_len = strcspn(str, G.ifs);
4598 if (!(output->o_expflags & EXP_FLAG_GLOB)) {
4599 o_addblock(output, str, word_len);
4601 /* Protect backslashes against globbing up :)
4602 * Example: "v='\*'; echo b$v" prints "b\*"
4603 * (and does not try to glob on "*")
4605 o_addblock_duplicate_backslash(output, str, word_len);
4606 /*/ Why can't we do it easier? */
4607 /*o_addblock(output, str, word_len); - WRONG: "v='\*'; echo Z$v" prints "Z*" instead of "Z\*" */
4608 /*o_addqblock(output, str, word_len); - WRONG: "v='*'; echo Z$v" prints "Z*" instead of Z* files */
4612 if (!*str) /* EOL - do not finalize word */
4614 o_addchr(output, '\0');
4615 debug_print_list("expand_on_ifs", output, n);
4616 n = o_save_ptr(output, n);
4617 str += strspn(str, G.ifs); /* skip ifs chars */
4619 debug_print_list("expand_on_ifs[1]", output, n);
4623 /* Helper to expand $((...)) and heredoc body. These act as if
4624 * they are in double quotes, with the exception that they are not :).
4625 * Just the rules are similar: "expand only $var and `cmd`"
4627 * Returns malloced string.
4628 * As an optimization, we return NULL if expansion is not needed.
4630 #if !ENABLE_HUSH_BASH_COMPAT
4631 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4632 #define encode_then_expand_string(str, process_bkslash, do_unbackslash) \
4633 encode_then_expand_string(str)
4635 static char *encode_then_expand_string(const char *str, int process_bkslash, int do_unbackslash)
4638 struct in_str input;
4639 o_string dest = NULL_O_STRING;
4641 if (!strchr(str, '$')
4642 && !strchr(str, '\\')
4643 #if ENABLE_HUSH_TICK
4644 && !strchr(str, '`')
4650 /* We need to expand. Example:
4651 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
4653 setup_string_in_str(&input, str);
4654 encode_string(NULL, &dest, &input, EOF, process_bkslash);
4655 //bb_error_msg("'%s' -> '%s'", str, dest.data);
4656 exp_str = expand_string_to_string(dest.data, /*unbackslash:*/ do_unbackslash);
4657 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
4658 o_free_unsafe(&dest);
4662 #if ENABLE_SH_MATH_SUPPORT
4663 static arith_t expand_and_evaluate_arith(const char *arg, const char **errmsg_p)
4665 arith_state_t math_state;
4669 math_state.lookupvar = get_local_var_value;
4670 math_state.setvar = set_local_var_from_halves;
4671 //math_state.endofname = endofname;
4672 exp_str = encode_then_expand_string(arg, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
4673 res = arith(&math_state, exp_str ? exp_str : arg);
4676 *errmsg_p = math_state.errmsg;
4677 if (math_state.errmsg)
4678 die_if_script(math_state.errmsg);
4683 #if ENABLE_HUSH_BASH_COMPAT
4684 /* ${var/[/]pattern[/repl]} helpers */
4685 static char *strstr_pattern(char *val, const char *pattern, int *size)
4688 char *end = scan_and_match(val, pattern, SCAN_MOVE_FROM_RIGHT + SCAN_MATCH_LEFT_HALF);
4689 debug_printf_varexp("val:'%s' pattern:'%s' end:'%s'\n", val, pattern, end);
4696 /* Optimization: if "*pat" did not match the start of "string",
4697 * we know that "tring", "ring" etc will not match too:
4699 if (pattern[0] == '*')
4704 static char *replace_pattern(char *val, const char *pattern, const char *repl, char exp_op)
4706 char *result = NULL;
4707 unsigned res_len = 0;
4708 unsigned repl_len = strlen(repl);
4712 char *s = strstr_pattern(val, pattern, &size);
4716 result = xrealloc(result, res_len + (s - val) + repl_len + 1);
4717 memcpy(result + res_len, val, s - val);
4719 strcpy(result + res_len, repl);
4720 res_len += repl_len;
4721 debug_printf_varexp("val:'%s' s:'%s' result:'%s'\n", val, s, result);
4727 if (val[0] && result) {
4728 result = xrealloc(result, res_len + strlen(val) + 1);
4729 strcpy(result + res_len, val);
4730 debug_printf_varexp("val:'%s' result:'%s'\n", val, result);
4732 debug_printf_varexp("result:'%s'\n", result);
4738 * Handles <SPECIAL_VAR_SYMBOL>varname...<SPECIAL_VAR_SYMBOL> construct.
4740 static NOINLINE const char *expand_one_var(char **to_be_freed_pp, char *arg, char **pp)
4742 const char *val = NULL;
4743 char *to_be_freed = NULL;
4748 char exp_save = exp_save; /* for compiler */
4749 char *exp_saveptr; /* points to expansion operator */
4750 char *exp_word = exp_word; /* for compiler */
4753 *p = '\0'; /* replace trailing SPECIAL_VAR_SYMBOL */
4755 exp_saveptr = arg[1] ? strchr(VAR_ENCODED_SUBST_OPS, arg[1]) : NULL;
4757 first_char = arg[0] = arg0 & 0x7f;
4760 if (first_char == '#' /* ${#... */
4761 && arg[1] && !exp_saveptr /* not ${#} and not ${#<op_char>...} */
4763 /* It must be length operator: ${#var} */
4767 /* Maybe handle parameter expansion */
4768 if (exp_saveptr /* if 2nd char is one of expansion operators */
4769 && strchr(NUMERIC_SPECVARS_STR, first_char) /* 1st char is special variable */
4771 /* ${?:0}, ${#[:]%0} etc */
4772 exp_saveptr = var + 1;
4774 /* ${?}, ${var}, ${var:0}, ${var[:]%0} etc */
4775 exp_saveptr = var+1 + strcspn(var+1, VAR_ENCODED_SUBST_OPS);
4777 exp_op = exp_save = *exp_saveptr;
4779 exp_word = exp_saveptr + 1;
4780 if (exp_op == ':') {
4781 exp_op = *exp_word++;
4782 //TODO: try ${var:} and ${var:bogus} in non-bash config
4783 if (ENABLE_HUSH_BASH_COMPAT
4784 && (!exp_op || !strchr(MINUS_PLUS_EQUAL_QUESTION, exp_op))
4786 /* oops... it's ${var:N[:M]}, not ${var:?xxx} or some such */
4791 *exp_saveptr = '\0';
4792 } /* else: it's not an expansion op, but bare ${var} */
4795 /* Look up the variable in question */
4796 if (isdigit(var[0])) {
4797 /* parse_dollar should have vetted var for us */
4798 int n = xatoi_positive(var);
4799 if (n < G.global_argc)
4800 val = G.global_argv[n];
4801 /* else val remains NULL: $N with too big N */
4805 val = utoa(G.root_pid);
4807 case '!': /* bg pid */
4808 val = G.last_bg_pid ? utoa(G.last_bg_pid) : "";
4810 case '?': /* exitcode */
4811 val = utoa(G.last_exitcode);
4813 case '#': /* argc */
4814 val = utoa(G.global_argc ? G.global_argc-1 : 0);
4817 val = get_local_var_value(var);
4821 /* Handle any expansions */
4822 if (exp_op == 'L') {
4823 debug_printf_expand("expand: length(%s)=", val);
4824 val = utoa(val ? strlen(val) : 0);
4825 debug_printf_expand("%s\n", val);
4826 } else if (exp_op) {
4827 if (exp_op == '%' || exp_op == '#') {
4828 /* Standard-mandated substring removal ops:
4829 * ${parameter%word} - remove smallest suffix pattern
4830 * ${parameter%%word} - remove largest suffix pattern
4831 * ${parameter#word} - remove smallest prefix pattern
4832 * ${parameter##word} - remove largest prefix pattern
4834 * Word is expanded to produce a glob pattern.
4835 * Then var's value is matched to it and matching part removed.
4837 if (val && val[0]) {
4841 unsigned scan_flags = pick_scan(exp_op, *exp_word);
4842 if (exp_op == *exp_word) /* ## or %% */
4844 exp_exp_word = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
4846 exp_word = exp_exp_word;
4847 /* HACK ALERT. We depend here on the fact that
4848 * G.global_argv and results of utoa and get_local_var_value
4849 * are actually in writable memory:
4850 * scan_and_match momentarily stores NULs there. */
4852 loc = scan_and_match(t, exp_word, scan_flags);
4853 //bb_error_msg("op:%c str:'%s' pat:'%s' res:'%s'",
4854 // exp_op, t, exp_word, loc);
4856 if (loc) { /* match was found */
4857 if (scan_flags & SCAN_MATCH_LEFT_HALF) /* #[#] */
4858 val = loc; /* take right part */
4860 val = to_be_freed = xstrndup(val, loc - val); /* left */
4864 #if ENABLE_HUSH_BASH_COMPAT
4865 else if (exp_op == '/' || exp_op == '\\') {
4866 /* It's ${var/[/]pattern[/repl]} thing.
4867 * Note that in encoded form it has TWO parts:
4868 * var/pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
4869 * and if // is used, it is encoded as \:
4870 * var\pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
4872 /* Empty variable always gives nothing: */
4873 // "v=''; echo ${v/*/w}" prints "", not "w"
4874 if (val && val[0]) {
4875 /* pattern uses non-standard expansion.
4876 * repl should be unbackslashed and globbed
4877 * by the usual expansion rules:
4879 * v='a bz'; echo "${v/a*z/a*z}" prints "a*z"
4880 * v='a bz'; echo "${v/a*z/\z}" prints "\z"
4881 * v='a bz'; echo ${v/a*z/a*z} prints "az"
4882 * v='a bz'; echo ${v/a*z/\z} prints "z"
4883 * (note that a*z _pattern_ is never globbed!)
4885 char *pattern, *repl, *t;
4886 pattern = encode_then_expand_string(exp_word, /*process_bkslash:*/ 0, /*unbackslash:*/ 0);
4888 pattern = xstrdup(exp_word);
4889 debug_printf_varexp("pattern:'%s'->'%s'\n", exp_word, pattern);
4890 *p++ = SPECIAL_VAR_SYMBOL;
4892 p = strchr(p, SPECIAL_VAR_SYMBOL);
4894 repl = encode_then_expand_string(exp_word, /*process_bkslash:*/ arg0 & 0x80, /*unbackslash:*/ 1);
4895 debug_printf_varexp("repl:'%s'->'%s'\n", exp_word, repl);
4896 /* HACK ALERT. We depend here on the fact that
4897 * G.global_argv and results of utoa and get_local_var_value
4898 * are actually in writable memory:
4899 * replace_pattern momentarily stores NULs there. */
4901 to_be_freed = replace_pattern(t,
4903 (repl ? repl : exp_word),
4905 if (to_be_freed) /* at least one replace happened */
4912 else if (exp_op == ':') {
4913 #if ENABLE_HUSH_BASH_COMPAT && ENABLE_SH_MATH_SUPPORT
4914 /* It's ${var:N[:M]} bashism.
4915 * Note that in encoded form it has TWO parts:
4916 * var:N<SPECIAL_VAR_SYMBOL>M<SPECIAL_VAR_SYMBOL>
4921 beg = expand_and_evaluate_arith(exp_word, &errmsg);
4924 debug_printf_varexp("beg:'%s'=%lld\n", exp_word, (long long)beg);
4925 *p++ = SPECIAL_VAR_SYMBOL;
4927 p = strchr(p, SPECIAL_VAR_SYMBOL);
4929 len = expand_and_evaluate_arith(exp_word, &errmsg);
4932 debug_printf_varexp("len:'%s'=%lld\n", exp_word, (long long)len);
4933 if (len >= 0) { /* bash compat: len < 0 is illegal */
4934 if (beg < 0) /* bash compat */
4936 debug_printf_varexp("from val:'%s'\n", val);
4937 if (len == 0 || !val || beg >= strlen(val)) {
4941 /* Paranoia. What if user entered 9999999999999
4942 * which fits in arith_t but not int? */
4945 val = to_be_freed = xstrndup(val + beg, len);
4947 debug_printf_varexp("val:'%s'\n", val);
4951 die_if_script("malformed ${%s:...}", var);
4954 } else { /* one of "-=+?" */
4955 /* Standard-mandated substitution ops:
4956 * ${var?word} - indicate error if unset
4957 * If var is unset, word (or a message indicating it is unset
4958 * if word is null) is written to standard error
4959 * and the shell exits with a non-zero exit status.
4960 * Otherwise, the value of var is substituted.
4961 * ${var-word} - use default value
4962 * If var is unset, word is substituted.
4963 * ${var=word} - assign and use default value
4964 * If var is unset, word is assigned to var.
4965 * In all cases, final value of var is substituted.
4966 * ${var+word} - use alternative value
4967 * If var is unset, null is substituted.
4968 * Otherwise, word is substituted.
4970 * Word is subjected to tilde expansion, parameter expansion,
4971 * command substitution, and arithmetic expansion.
4972 * If word is not needed, it is not expanded.
4974 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
4975 * but also treat null var as if it is unset.
4977 int use_word = (!val || ((exp_save == ':') && !val[0]));
4979 use_word = !use_word;
4980 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
4981 (exp_save == ':') ? "true" : "false", use_word);
4983 to_be_freed = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
4985 exp_word = to_be_freed;
4986 if (exp_op == '?') {
4987 /* mimic bash message */
4988 die_if_script("%s: %s",
4990 exp_word[0] ? exp_word : "parameter null or not set"
4992 //TODO: how interactive bash aborts expansion mid-command?
4997 if (exp_op == '=') {
4998 /* ${var=[word]} or ${var:=[word]} */
4999 if (isdigit(var[0]) || var[0] == '#') {
5000 /* mimic bash message */
5001 die_if_script("$%s: cannot assign in this way", var);
5004 char *new_var = xasprintf("%s=%s", var, val);
5005 set_local_var(new_var, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
5009 } /* one of "-=+?" */
5011 *exp_saveptr = exp_save;
5017 *to_be_freed_pp = to_be_freed;
5021 /* Expand all variable references in given string, adding words to list[]
5022 * at n, n+1,... positions. Return updated n (so that list[n] is next one
5023 * to be filled). This routine is extremely tricky: has to deal with
5024 * variables/parameters with whitespace, $* and $@, and constructs like
5025 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
5026 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg)
5028 /* output->o_expflags & EXP_FLAG_SINGLEWORD (0x80) if we are in
5029 * expansion of right-hand side of assignment == 1-element expand.
5031 char cant_be_null = 0; /* only bit 0x80 matters */
5034 debug_printf_expand("expand_vars_to_list: arg:'%s' singleword:%x\n", arg,
5035 !!(output->o_expflags & EXP_FLAG_SINGLEWORD));
5036 debug_print_list("expand_vars_to_list", output, n);
5037 n = o_save_ptr(output, n);
5038 debug_print_list("expand_vars_to_list[0]", output, n);
5040 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
5042 char *to_be_freed = NULL;
5043 const char *val = NULL;
5044 #if ENABLE_HUSH_TICK
5045 o_string subst_result = NULL_O_STRING;
5047 #if ENABLE_SH_MATH_SUPPORT
5048 char arith_buf[sizeof(arith_t)*3 + 2];
5050 o_addblock(output, arg, p - arg);
5051 debug_print_list("expand_vars_to_list[1]", output, n);
5053 p = strchr(p, SPECIAL_VAR_SYMBOL);
5055 /* Fetch special var name (if it is indeed one of them)
5056 * and quote bit, force the bit on if singleword expansion -
5057 * important for not getting v=$@ expand to many words. */
5058 first_ch = arg[0] | (output->o_expflags & EXP_FLAG_SINGLEWORD);
5060 /* Is this variable quoted and thus expansion can't be null?
5061 * "$@" is special. Even if quoted, it can still
5062 * expand to nothing (not even an empty string),
5063 * thus it is excluded. */
5064 if ((first_ch & 0x7f) != '@')
5065 cant_be_null |= first_ch;
5067 switch (first_ch & 0x7f) {
5068 /* Highest bit in first_ch indicates that var is double-quoted */
5072 if (!G.global_argv[1])
5075 cant_be_null |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
5076 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
5077 while (G.global_argv[i]) {
5078 n = expand_on_ifs(output, n, G.global_argv[i]);
5079 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
5080 if (G.global_argv[i++][0] && G.global_argv[i]) {
5081 /* this argv[] is not empty and not last:
5082 * put terminating NUL, start new word */
5083 o_addchr(output, '\0');
5084 debug_print_list("expand_vars_to_list[2]", output, n);
5085 n = o_save_ptr(output, n);
5086 debug_print_list("expand_vars_to_list[3]", output, n);
5090 /* If EXP_FLAG_SINGLEWORD, we handle assignment 'a=....$@.....'
5091 * and in this case should treat it like '$*' - see 'else...' below */
5092 if (first_ch == ('@'|0x80) /* quoted $@ */
5093 && !(output->o_expflags & EXP_FLAG_SINGLEWORD) /* not v="$@" case */
5096 o_addQstr(output, G.global_argv[i]);
5097 if (++i >= G.global_argc)
5099 o_addchr(output, '\0');
5100 debug_print_list("expand_vars_to_list[4]", output, n);
5101 n = o_save_ptr(output, n);
5103 } else { /* quoted $* (or v="$@" case): add as one word */
5105 o_addQstr(output, G.global_argv[i]);
5106 if (!G.global_argv[++i])
5109 o_addchr(output, G.ifs[0]);
5114 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
5115 /* "Empty variable", used to make "" etc to not disappear */
5117 cant_be_null = 0x80;
5119 #if ENABLE_HUSH_TICK
5120 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
5121 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5123 /* Can't just stuff it into output o_string,
5124 * expanded result may need to be globbed
5125 * and $IFS-splitted */
5126 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
5127 G.last_exitcode = process_command_subs(&subst_result, arg);
5128 debug_printf_subst("SUBST RES:%d '%s'\n", G.last_exitcode, subst_result.data);
5129 val = subst_result.data;
5132 #if ENABLE_SH_MATH_SUPPORT
5133 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
5136 arg++; /* skip '+' */
5137 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
5138 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
5139 res = expand_and_evaluate_arith(arg, NULL);
5140 debug_printf_subst("ARITH RES '"ARITH_FMT"'\n", res);
5141 sprintf(arith_buf, ARITH_FMT, res);
5147 val = expand_one_var(&to_be_freed, arg, &p);
5148 IF_HUSH_TICK(store_val:)
5149 if (!(first_ch & 0x80)) { /* unquoted $VAR */
5150 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val,
5151 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
5152 if (val && val[0]) {
5153 n = expand_on_ifs(output, n, val);
5156 } else { /* quoted $VAR, val will be appended below */
5157 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val,
5158 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
5162 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
5164 if (val && val[0]) {
5165 o_addQstr(output, val);
5169 /* Restore NULL'ed SPECIAL_VAR_SYMBOL.
5170 * Do the check to avoid writing to a const string. */
5171 if (*p != SPECIAL_VAR_SYMBOL)
5172 *p = SPECIAL_VAR_SYMBOL;
5174 #if ENABLE_HUSH_TICK
5175 o_free(&subst_result);
5178 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
5181 debug_print_list("expand_vars_to_list[a]", output, n);
5182 /* this part is literal, and it was already pre-quoted
5183 * if needed (much earlier), do not use o_addQstr here! */
5184 o_addstr_with_NUL(output, arg);
5185 debug_print_list("expand_vars_to_list[b]", output, n);
5186 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
5187 && !(cant_be_null & 0x80) /* and all vars were not quoted. */
5190 /* allow to reuse list[n] later without re-growth */
5191 output->has_empty_slot = 1;
5193 o_addchr(output, '\0');
5199 static char **expand_variables(char **argv, unsigned expflags)
5203 o_string output = NULL_O_STRING;
5205 output.o_expflags = expflags;
5209 n = expand_vars_to_list(&output, n, *argv);
5212 debug_print_list("expand_variables", &output, n);
5214 /* output.data (malloced in one block) gets returned in "list" */
5215 list = o_finalize_list(&output, n);
5216 debug_print_strings("expand_variables[1]", list);
5220 static char **expand_strvec_to_strvec(char **argv)
5222 return expand_variables(argv, EXP_FLAG_GLOB | EXP_FLAG_ESC_GLOB_CHARS);
5225 #if ENABLE_HUSH_BASH_COMPAT
5226 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
5228 return expand_variables(argv, EXP_FLAG_SINGLEWORD);
5232 /* Used for expansion of right hand of assignments,
5233 * $((...)), heredocs, variable espansion parts.
5235 * NB: should NOT do globbing!
5236 * "export v=/bin/c*; env | grep ^v=" outputs "v=/bin/c*"
5238 static char *expand_string_to_string(const char *str, int do_unbackslash)
5240 #if !ENABLE_HUSH_BASH_COMPAT
5241 const int do_unbackslash = 1;
5243 char *argv[2], **list;
5245 debug_printf_expand("string_to_string<='%s'\n", str);
5246 /* This is generally an optimization, but it also
5247 * handles "", which otherwise trips over !list[0] check below.
5248 * (is this ever happens that we actually get str="" here?)
5250 if (!strchr(str, SPECIAL_VAR_SYMBOL) && !strchr(str, '\\')) {
5251 //TODO: Can use on strings with \ too, just unbackslash() them?
5252 debug_printf_expand("string_to_string(fast)=>'%s'\n", str);
5253 return xstrdup(str);
5256 argv[0] = (char*)str;
5258 list = expand_variables(argv, do_unbackslash
5259 ? EXP_FLAG_ESC_GLOB_CHARS | EXP_FLAG_SINGLEWORD
5260 : EXP_FLAG_SINGLEWORD
5263 if (!list[0] || list[1])
5264 bb_error_msg_and_die("BUG in varexp2");
5265 /* actually, just move string 2*sizeof(char*) bytes back */
5266 overlapping_strcpy((char*)list, list[0]);
5268 unbackslash((char*)list);
5269 debug_printf_expand("string_to_string=>'%s'\n", (char*)list);
5273 /* Used for "eval" builtin */
5274 static char* expand_strvec_to_string(char **argv)
5278 list = expand_variables(argv, EXP_FLAG_SINGLEWORD);
5279 /* Convert all NULs to spaces */
5284 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
5285 bb_error_msg_and_die("BUG in varexp3");
5286 /* bash uses ' ' regardless of $IFS contents */
5291 overlapping_strcpy((char*)list, list[0]);
5292 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
5296 static char **expand_assignments(char **argv, int count)
5301 G.expanded_assignments = p = NULL;
5302 /* Expand assignments into one string each */
5303 for (i = 0; i < count; i++) {
5304 G.expanded_assignments = p = add_string_to_strings(p, expand_string_to_string(argv[i], /*unbackslash:*/ 1));
5306 G.expanded_assignments = NULL;
5313 void re_execute_shell(char ***to_free, const char *s,
5314 char *g_argv0, char **g_argv,
5315 char **builtin_argv) NORETURN;
5317 static void reset_traps_to_defaults(void)
5319 /* This function is always called in a child shell
5320 * after fork (not vfork, NOMMU doesn't use this function).
5325 /* Child shells are not interactive.
5326 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
5327 * Testcase: (while :; do :; done) + ^Z should background.
5328 * Same goes for SIGTERM, SIGHUP, SIGINT.
5330 if (!G.traps && !(G.non_DFL_mask & SPECIAL_INTERACTIVE_SIGS))
5331 return; /* already no traps and no SPECIAL_INTERACTIVE_SIGS */
5333 /* Switching off SPECIAL_INTERACTIVE_SIGS.
5334 * Stupid. It can be done with *single* &= op, but we can't use
5335 * the fact that G.blocked_set is implemented as a bitmask
5337 mask = (SPECIAL_INTERACTIVE_SIGS >> 1);
5341 /* Careful. Only if no trap or trap is not "" */
5342 if (!G.traps || !G.traps[sig] || G.traps[sig][0])
5343 sigdelset(&G.blocked_set, sig);
5350 /* Our homegrown sig mask is saner to work with :) */
5351 G.non_DFL_mask &= ~SPECIAL_INTERACTIVE_SIGS;
5353 /* Resetting all traps to default except empty ones */
5354 mask = G.non_DFL_mask;
5355 if (G.traps) for (sig = 0; sig < NSIG; sig++, mask >>= 1) {
5356 if (!G.traps[sig] || !G.traps[sig][0])
5359 G.traps[sig] = NULL;
5360 /* There is no signal for 0 (EXIT) */
5363 /* There was a trap handler, we just removed it.
5364 * But if sig still has non-DFL handling,
5365 * we should not unblock the sig. */
5368 sigdelset(&G.blocked_set, sig);
5370 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5375 static void re_execute_shell(char ***to_free, const char *s,
5376 char *g_argv0, char **g_argv,
5377 char **builtin_argv) NORETURN;
5378 static void re_execute_shell(char ***to_free, const char *s,
5379 char *g_argv0, char **g_argv,
5380 char **builtin_argv)
5382 # define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
5383 /* delims + 2 * (number of bytes in printed hex numbers) */
5384 char param_buf[sizeof(NOMMU_HACK_FMT) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
5385 char *heredoc_argv[4];
5386 struct variable *cur;
5387 # if ENABLE_HUSH_FUNCTIONS
5388 struct function *funcp;
5392 unsigned long long empty_trap_mask;
5394 if (!g_argv0) { /* heredoc */
5395 argv = heredoc_argv;
5396 argv[0] = (char *) G.argv0_for_re_execing;
5397 argv[1] = (char *) "-<";
5398 argv[2] = (char *) s;
5400 pp = &argv[3]; /* used as pointer to empty environment */
5406 if (pp) while (*pp++)
5409 empty_trap_mask = 0;
5412 for (sig = 1; sig < NSIG; sig++) {
5413 if (G.traps[sig] && !G.traps[sig][0])
5414 empty_trap_mask |= 1LL << sig;
5418 sprintf(param_buf, NOMMU_HACK_FMT
5419 , (unsigned) G.root_pid
5420 , (unsigned) G.root_ppid
5421 , (unsigned) G.last_bg_pid
5422 , (unsigned) G.last_exitcode
5425 IF_HUSH_LOOPS(, G.depth_of_loop)
5427 # undef NOMMU_HACK_FMT
5428 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
5429 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
5432 for (cur = G.top_var; cur; cur = cur->next) {
5433 if (!cur->flg_export || cur->flg_read_only)
5436 # if ENABLE_HUSH_FUNCTIONS
5437 for (funcp = G.top_func; funcp; funcp = funcp->next)
5443 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
5444 *pp++ = (char *) G.argv0_for_re_execing;
5446 for (cur = G.top_var; cur; cur = cur->next) {
5447 if (strcmp(cur->varstr, hush_version_str) == 0)
5449 if (cur->flg_read_only) {
5450 *pp++ = (char *) "-R";
5451 *pp++ = cur->varstr;
5452 } else if (!cur->flg_export) {
5453 *pp++ = (char *) "-V";
5454 *pp++ = cur->varstr;
5457 # if ENABLE_HUSH_FUNCTIONS
5458 for (funcp = G.top_func; funcp; funcp = funcp->next) {
5459 *pp++ = (char *) "-F";
5460 *pp++ = funcp->name;
5461 *pp++ = funcp->body_as_string;
5464 /* We can pass activated traps here. Say, -Tnn:trap_string
5466 * However, POSIX says that subshells reset signals with traps
5468 * I tested bash-3.2 and it not only does that with true subshells
5469 * of the form ( list ), but with any forked children shells.
5470 * I set trap "echo W" WINCH; and then tried:
5472 * { echo 1; sleep 20; echo 2; } &
5473 * while true; do echo 1; sleep 20; echo 2; break; done &
5474 * true | { echo 1; sleep 20; echo 2; } | cat
5476 * In all these cases sending SIGWINCH to the child shell
5477 * did not run the trap. If I add trap "echo V" WINCH;
5478 * _inside_ group (just before echo 1), it works.
5480 * I conclude it means we don't need to pass active traps here.
5481 * Even if we would use signal handlers instead of signal masking
5482 * in order to implement trap handling,
5483 * exec syscall below resets signals to SIG_DFL for us.
5485 *pp++ = (char *) "-c";
5488 while (*++builtin_argv)
5489 *pp++ = *builtin_argv;
5490 *pp++ = (char *) "";
5495 /* *pp = NULL; - is already there */
5499 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
5500 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
5501 execve(bb_busybox_exec_path, argv, pp);
5502 /* Fallback. Useful for init=/bin/hush usage etc */
5503 if (argv[0][0] == '/')
5504 execve(argv[0], argv, pp);
5505 xfunc_error_retval = 127;
5506 bb_error_msg_and_die("can't re-execute the shell");
5508 #endif /* !BB_MMU */
5511 static int run_and_free_list(struct pipe *pi);
5513 /* Executing from string: eval, sh -c '...'
5514 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
5515 * end_trigger controls how often we stop parsing
5516 * NUL: parse all, execute, return
5517 * ';': parse till ';' or newline, execute, repeat till EOF
5519 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
5521 /* Why we need empty flag?
5522 * An obscure corner case "false; ``; echo $?":
5523 * empty command in `` should still set $? to 0.
5524 * But we can't just set $? to 0 at the start,
5525 * this breaks "false; echo `echo $?`" case.
5529 struct pipe *pipe_list;
5531 pipe_list = parse_stream(NULL, inp, end_trigger);
5532 if (!pipe_list) { /* EOF */
5534 G.last_exitcode = 0;
5537 debug_print_tree(pipe_list, 0);
5538 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
5539 run_and_free_list(pipe_list);
5544 static void parse_and_run_string(const char *s)
5546 struct in_str input;
5547 setup_string_in_str(&input, s);
5548 parse_and_run_stream(&input, '\0');
5551 static void parse_and_run_file(FILE *f)
5553 struct in_str input;
5554 setup_file_in_str(&input, f);
5555 parse_and_run_stream(&input, ';');
5558 #if ENABLE_HUSH_TICK
5559 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
5564 char **to_free = NULL;
5568 pid = BB_MMU ? xfork() : xvfork();
5569 if (pid == 0) { /* child */
5570 disable_restore_tty_pgrp_on_exit();
5571 /* Process substitution is not considered to be usual
5572 * 'command execution'.
5573 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
5580 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
5581 close(channel[0]); /* NB: close _first_, then move fd! */
5582 xmove_fd(channel[1], 1);
5583 /* Prevent it from trying to handle ctrl-z etc */
5584 IF_HUSH_JOB(G.run_list_level = 1;)
5585 /* Awful hack for `trap` or $(trap).
5587 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
5588 * contains an example where "trap" is executed in a subshell:
5590 * save_traps=$(trap)
5592 * eval "$save_traps"
5594 * Standard does not say that "trap" in subshell shall print
5595 * parent shell's traps. It only says that its output
5596 * must have suitable form, but then, in the above example
5597 * (which is not supposed to be normative), it implies that.
5599 * bash (and probably other shell) does implement it
5600 * (traps are reset to defaults, but "trap" still shows them),
5601 * but as a result, "trap" logic is hopelessly messed up:
5604 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
5605 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
5606 * # true | trap <--- trap is in subshell - no output (ditto)
5607 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
5608 * trap -- 'echo Ho' SIGWINCH
5609 * # echo `(trap)` <--- in subshell in subshell - output
5610 * trap -- 'echo Ho' SIGWINCH
5611 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
5612 * trap -- 'echo Ho' SIGWINCH
5614 * The rules when to forget and when to not forget traps
5615 * get really complex and nonsensical.
5617 * Our solution: ONLY bare $(trap) or `trap` is special.
5619 s = skip_whitespace(s);
5620 if (strncmp(s, "trap", 4) == 0
5621 && skip_whitespace(s + 4)[0] == '\0'
5623 static const char *const argv[] = { NULL, NULL };
5624 builtin_trap((char**)argv);
5625 exit(0); /* not _exit() - we need to fflush */
5628 reset_traps_to_defaults();
5629 parse_and_run_string(s);
5630 _exit(G.last_exitcode);
5632 /* We re-execute after vfork on NOMMU. This makes this script safe:
5633 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
5634 * huge=`cat BIG` # was blocking here forever
5637 re_execute_shell(&to_free,
5647 # if ENABLE_HUSH_FAST
5649 //bb_error_msg("[%d] fork in generate_stream_from_string:"
5650 // " G.count_SIGCHLD:%d G.handled_SIGCHLD:%d",
5651 // getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5653 enable_restore_tty_pgrp_on_exit();
5658 close_on_exec_on(channel[0]);
5659 return xfdopen_for_read(channel[0]);
5662 /* Return code is exit status of the process that is run. */
5663 static int process_command_subs(o_string *dest, const char *s)
5666 struct in_str pipe_str;
5668 int status, ch, eol_cnt;
5670 fp = generate_stream_from_string(s, &pid);
5672 /* Now send results of command back into original context */
5673 setup_file_in_str(&pipe_str, fp);
5675 while ((ch = i_getch(&pipe_str)) != EOF) {
5681 o_addchr(dest, '\n');
5684 o_addQchr(dest, ch);
5687 debug_printf("done reading from `cmd` pipe, closing it\n");
5689 /* We need to extract exitcode. Test case
5690 * "true; echo `sleep 1; false` $?"
5692 safe_waitpid(pid, &status, 0);
5693 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
5694 return WEXITSTATUS(status);
5696 #endif /* ENABLE_HUSH_TICK */
5699 static void setup_heredoc(struct redir_struct *redir)
5701 struct fd_pair pair;
5704 /* the _body_ of heredoc (misleading field name) */
5705 const char *heredoc = redir->rd_filename;
5712 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
5713 expanded = encode_then_expand_string(heredoc, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5717 len = strlen(heredoc);
5719 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
5721 xmove_fd(pair.rd, redir->rd_fd);
5723 /* Try writing without forking. Newer kernels have
5724 * dynamically growing pipes. Must use non-blocking write! */
5727 written = write(pair.wr, heredoc, len);
5738 ndelay_off(pair.wr);
5740 /* Okay, pipe buffer was not big enough */
5741 /* Note: we must not create a stray child (bastard? :)
5742 * for the unsuspecting parent process. Child creates a grandchild
5743 * and exits before parent execs the process which consumes heredoc
5744 * (that exec happens after we return from this function) */
5751 disable_restore_tty_pgrp_on_exit();
5752 pid = BB_MMU ? xfork() : xvfork();
5756 close(redir->rd_fd); /* read side of the pipe */
5758 full_write(pair.wr, heredoc, len); /* may loop or block */
5761 /* Delegate blocking writes to another process */
5762 xmove_fd(pair.wr, STDOUT_FILENO);
5763 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
5767 #if ENABLE_HUSH_FAST
5769 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5771 enable_restore_tty_pgrp_on_exit();
5777 wait(NULL); /* wait till child has died */
5780 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
5781 * and stderr if they are redirected. */
5782 static int setup_redirects(struct command *prog, int squirrel[])
5785 struct redir_struct *redir;
5787 for (redir = prog->redirects; redir; redir = redir->next) {
5788 if (redir->rd_type == REDIRECT_HEREDOC2) {
5789 /* rd_fd<<HERE case */
5790 if (squirrel && redir->rd_fd < 3
5791 && squirrel[redir->rd_fd] < 0
5793 squirrel[redir->rd_fd] = dup(redir->rd_fd);
5795 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
5797 debug_printf_parse("set heredoc '%s'\n",
5798 redir->rd_filename);
5799 setup_heredoc(redir);
5803 if (redir->rd_dup == REDIRFD_TO_FILE) {
5804 /* rd_fd<*>file case (<*> is <,>,>>,<>) */
5806 if (redir->rd_filename == NULL) {
5807 /* Something went wrong in the parse.
5808 * Pretend it didn't happen */
5809 bb_error_msg("bug in redirect parse");
5812 mode = redir_table[redir->rd_type].mode;
5813 p = expand_string_to_string(redir->rd_filename, /*unbackslash:*/ 1);
5814 openfd = open_or_warn(p, mode);
5817 /* this could get lost if stderr has been redirected, but
5818 * bash and ash both lose it as well (though zsh doesn't!) */
5819 //what the above comment tries to say?
5823 /* rd_fd<*>rd_dup or rd_fd<*>- cases */
5824 openfd = redir->rd_dup;
5827 if (openfd != redir->rd_fd) {
5828 if (squirrel && redir->rd_fd < 3
5829 && squirrel[redir->rd_fd] < 0
5831 squirrel[redir->rd_fd] = dup(redir->rd_fd);
5833 if (openfd == REDIRFD_CLOSE) {
5834 /* "n>-" means "close me" */
5835 close(redir->rd_fd);
5837 xdup2(openfd, redir->rd_fd);
5838 if (redir->rd_dup == REDIRFD_TO_FILE)
5846 static void restore_redirects(int squirrel[])
5849 for (i = 0; i < 3; i++) {
5852 /* We simply die on error */
5858 static char *find_in_path(const char *arg)
5861 const char *PATH = get_local_var_value("PATH");
5867 const char *end = strchrnul(PATH, ':');
5868 int sz = end - PATH; /* must be int! */
5872 ret = xasprintf("%.*s/%s", sz, PATH, arg);
5874 /* We have xxx::yyyy in $PATH,
5875 * it means "use current dir" */
5878 if (access(ret, F_OK) == 0)
5891 static const struct built_in_command *find_builtin_helper(const char *name,
5892 const struct built_in_command *x,
5893 const struct built_in_command *end)
5896 if (strcmp(name, x->b_cmd) != 0) {
5900 debug_printf_exec("found builtin '%s'\n", name);
5905 static const struct built_in_command *find_builtin1(const char *name)
5907 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
5909 static const struct built_in_command *find_builtin(const char *name)
5911 const struct built_in_command *x = find_builtin1(name);
5914 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
5917 #if ENABLE_HUSH_FUNCTIONS
5918 static struct function **find_function_slot(const char *name)
5920 struct function **funcpp = &G.top_func;
5922 if (strcmp(name, (*funcpp)->name) == 0) {
5925 funcpp = &(*funcpp)->next;
5930 static const struct function *find_function(const char *name)
5932 const struct function *funcp = *find_function_slot(name);
5934 debug_printf_exec("found function '%s'\n", name);
5938 /* Note: takes ownership on name ptr */
5939 static struct function *new_function(char *name)
5941 struct function **funcpp = find_function_slot(name);
5942 struct function *funcp = *funcpp;
5944 if (funcp != NULL) {
5945 struct command *cmd = funcp->parent_cmd;
5946 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
5948 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
5950 /* Note: if !funcp->body, do not free body_as_string!
5951 * This is a special case of "-F name body" function:
5952 * body_as_string was not malloced! */
5954 free_pipe_list(funcp->body);
5956 free(funcp->body_as_string);
5960 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
5961 cmd->argv[0] = funcp->name;
5962 cmd->group = funcp->body;
5964 cmd->group_as_string = funcp->body_as_string;
5968 debug_printf_exec("remembering new function '%s'\n", name);
5969 funcp = *funcpp = xzalloc(sizeof(*funcp));
5970 /*funcp->next = NULL;*/
5977 static void unset_func(const char *name)
5979 struct function **funcpp = find_function_slot(name);
5980 struct function *funcp = *funcpp;
5982 if (funcp != NULL) {
5983 debug_printf_exec("freeing function '%s'\n", funcp->name);
5984 *funcpp = funcp->next;
5985 /* funcp is unlinked now, deleting it.
5986 * Note: if !funcp->body, the function was created by
5987 * "-F name body", do not free ->body_as_string
5988 * and ->name as they were not malloced. */
5990 free_pipe_list(funcp->body);
5993 free(funcp->body_as_string);
6001 #define exec_function(to_free, funcp, argv) \
6002 exec_function(funcp, argv)
6004 static void exec_function(char ***to_free,
6005 const struct function *funcp,
6006 char **argv) NORETURN;
6007 static void exec_function(char ***to_free,
6008 const struct function *funcp,
6014 argv[0] = G.global_argv[0];
6015 G.global_argv = argv;
6019 /* On MMU, funcp->body is always non-NULL */
6020 n = run_list(funcp->body);
6024 re_execute_shell(to_free,
6025 funcp->body_as_string,
6032 static int run_function(const struct function *funcp, char **argv)
6038 save_and_replace_G_args(&sv, argv);
6040 /* "we are in function, ok to use return" */
6041 sv_flg = G.flag_return_in_progress;
6042 G.flag_return_in_progress = -1;
6043 # if ENABLE_HUSH_LOCAL
6044 G.func_nest_level++;
6047 /* On MMU, funcp->body is always non-NULL */
6050 /* Function defined by -F */
6051 parse_and_run_string(funcp->body_as_string);
6052 rc = G.last_exitcode;
6056 rc = run_list(funcp->body);
6059 # if ENABLE_HUSH_LOCAL
6061 struct variable *var;
6062 struct variable **var_pp;
6064 var_pp = &G.top_var;
6065 while ((var = *var_pp) != NULL) {
6066 if (var->func_nest_level < G.func_nest_level) {
6067 var_pp = &var->next;
6071 if (var->flg_export)
6072 bb_unsetenv(var->varstr);
6073 /* Remove from global list */
6074 *var_pp = var->next;
6080 G.func_nest_level--;
6083 G.flag_return_in_progress = sv_flg;
6085 restore_G_args(&sv, argv);
6089 #endif /* ENABLE_HUSH_FUNCTIONS */
6093 #define exec_builtin(to_free, x, argv) \
6094 exec_builtin(x, argv)
6096 #define exec_builtin(to_free, x, argv) \
6097 exec_builtin(to_free, argv)
6099 static void exec_builtin(char ***to_free,
6100 const struct built_in_command *x,
6101 char **argv) NORETURN;
6102 static void exec_builtin(char ***to_free,
6103 const struct built_in_command *x,
6107 int rcode = x->b_function(argv);
6111 /* On NOMMU, we must never block!
6112 * Example: { sleep 99 | read line; } & echo Ok
6114 re_execute_shell(to_free,
6123 static void execvp_or_die(char **argv) NORETURN;
6124 static void execvp_or_die(char **argv)
6126 debug_printf_exec("execing '%s'\n", argv[0]);
6127 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
6128 execvp(argv[0], argv);
6129 bb_perror_msg("can't execute '%s'", argv[0]);
6130 _exit(127); /* bash compat */
6133 #if ENABLE_HUSH_MODE_X
6134 static void dump_cmd_in_x_mode(char **argv)
6136 if (G_x_mode && argv) {
6137 /* We want to output the line in one write op */
6145 len += strlen(argv[n++]) + 1;
6151 p += sprintf(p, " %s", argv[n++]);
6159 # define dump_cmd_in_x_mode(argv) ((void)0)
6163 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
6164 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
6165 #define pseudo_exec(nommu_save, command, argv_expanded) \
6166 pseudo_exec(command, argv_expanded)
6169 /* Called after [v]fork() in run_pipe, or from builtin_exec.
6171 * Don't exit() here. If you don't exec, use _exit instead.
6172 * The at_exit handlers apparently confuse the calling process,
6173 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
6174 static void pseudo_exec_argv(nommu_save_t *nommu_save,
6175 char **argv, int assignment_cnt,
6176 char **argv_expanded) NORETURN;
6177 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
6178 char **argv, int assignment_cnt,
6179 char **argv_expanded)
6183 new_env = expand_assignments(argv, assignment_cnt);
6184 dump_cmd_in_x_mode(new_env);
6186 if (!argv[assignment_cnt]) {
6187 /* Case when we are here: ... | var=val | ...
6188 * (note that we do not exit early, i.e., do not optimize out
6189 * expand_assignments(): think about ... | var=`sleep 1` | ...
6191 free_strings(new_env);
6192 _exit(EXIT_SUCCESS);
6196 set_vars_and_save_old(new_env);
6197 free(new_env); /* optional */
6198 /* we can also destroy set_vars_and_save_old's return value,
6201 nommu_save->new_env = new_env;
6202 nommu_save->old_vars = set_vars_and_save_old(new_env);
6205 if (argv_expanded) {
6206 argv = argv_expanded;
6208 argv = expand_strvec_to_strvec(argv + assignment_cnt);
6210 nommu_save->argv = argv;
6213 dump_cmd_in_x_mode(argv);
6215 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
6216 if (strchr(argv[0], '/') != NULL)
6220 /* Check if the command matches any of the builtins.
6221 * Depending on context, this might be redundant. But it's
6222 * easier to waste a few CPU cycles than it is to figure out
6223 * if this is one of those cases.
6226 /* On NOMMU, it is more expensive to re-execute shell
6227 * just in order to run echo or test builtin.
6228 * It's better to skip it here and run corresponding
6229 * non-builtin later. */
6230 const struct built_in_command *x;
6231 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
6233 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
6236 #if ENABLE_HUSH_FUNCTIONS
6237 /* Check if the command matches any functions */
6239 const struct function *funcp = find_function(argv[0]);
6241 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
6246 #if ENABLE_FEATURE_SH_STANDALONE
6247 /* Check if the command matches any busybox applets */
6249 int a = find_applet_by_name(argv[0]);
6251 # if BB_MMU /* see above why on NOMMU it is not allowed */
6252 if (APPLET_IS_NOEXEC(a)) {
6253 debug_printf_exec("running applet '%s'\n", argv[0]);
6254 run_applet_no_and_exit(a, argv);
6257 /* Re-exec ourselves */
6258 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
6259 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
6260 execv(bb_busybox_exec_path, argv);
6261 /* If they called chroot or otherwise made the binary no longer
6262 * executable, fall through */
6267 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
6270 execvp_or_die(argv);
6273 /* Called after [v]fork() in run_pipe
6275 static void pseudo_exec(nommu_save_t *nommu_save,
6276 struct command *command,
6277 char **argv_expanded) NORETURN;
6278 static void pseudo_exec(nommu_save_t *nommu_save,
6279 struct command *command,
6280 char **argv_expanded)
6282 if (command->argv) {
6283 pseudo_exec_argv(nommu_save, command->argv,
6284 command->assignment_cnt, argv_expanded);
6287 if (command->group) {
6288 /* Cases when we are here:
6291 * ... | ( list ) | ...
6292 * ... | { list } | ...
6296 debug_printf_exec("pseudo_exec: run_list\n");
6297 reset_traps_to_defaults();
6298 rcode = run_list(command->group);
6299 /* OK to leak memory by not calling free_pipe_list,
6300 * since this process is about to exit */
6303 re_execute_shell(&nommu_save->argv_from_re_execing,
6304 command->group_as_string,
6311 /* Case when we are here: ... | >file */
6312 debug_printf_exec("pseudo_exec'ed null command\n");
6313 _exit(EXIT_SUCCESS);
6317 static const char *get_cmdtext(struct pipe *pi)
6323 /* This is subtle. ->cmdtext is created only on first backgrounding.
6324 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
6325 * On subsequent bg argv is trashed, but we won't use it */
6328 argv = pi->cmds[0].argv;
6329 if (!argv || !argv[0]) {
6330 pi->cmdtext = xzalloc(1);
6336 len += strlen(*argv) + 1;
6340 argv = pi->cmds[0].argv;
6342 len = strlen(*argv);
6343 memcpy(p, *argv, len);
6351 static void insert_bg_job(struct pipe *pi)
6353 struct pipe *job, **jobp;
6356 /* Linear search for the ID of the job to use */
6358 for (job = G.job_list; job; job = job->next)
6359 if (job->jobid >= pi->jobid)
6360 pi->jobid = job->jobid + 1;
6362 /* Add job to the list of running jobs */
6364 while ((job = *jobp) != NULL)
6366 job = *jobp = xmalloc(sizeof(*job));
6368 *job = *pi; /* physical copy */
6370 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
6371 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
6372 for (i = 0; i < pi->num_cmds; i++) {
6373 job->cmds[i].pid = pi->cmds[i].pid;
6374 /* all other fields are not used and stay zero */
6376 job->cmdtext = xstrdup(get_cmdtext(pi));
6378 if (G_interactive_fd)
6379 printf("[%d] %d %s\n", job->jobid, job->cmds[0].pid, job->cmdtext);
6380 G.last_jobid = job->jobid;
6383 static void remove_bg_job(struct pipe *pi)
6385 struct pipe *prev_pipe;
6387 if (pi == G.job_list) {
6388 G.job_list = pi->next;
6390 prev_pipe = G.job_list;
6391 while (prev_pipe->next != pi)
6392 prev_pipe = prev_pipe->next;
6393 prev_pipe->next = pi->next;
6396 G.last_jobid = G.job_list->jobid;
6401 /* Remove a backgrounded job */
6402 static void delete_finished_bg_job(struct pipe *pi)
6409 /* Check to see if any processes have exited -- if they
6410 * have, figure out why and see if a job has completed */
6411 static int checkjobs(struct pipe *fg_pipe)
6421 debug_printf_jobs("checkjobs %p\n", fg_pipe);
6423 attributes = WUNTRACED;
6424 if (fg_pipe == NULL)
6425 attributes |= WNOHANG;
6428 #if ENABLE_HUSH_FAST
6429 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
6430 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
6431 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
6432 /* There was neither fork nor SIGCHLD since last waitpid */
6433 /* Avoid doing waitpid syscall if possible */
6434 if (!G.we_have_children) {
6438 if (fg_pipe == NULL) { /* is WNOHANG set? */
6439 /* We have children, but they did not exit
6440 * or stop yet (we saw no SIGCHLD) */
6443 /* else: !WNOHANG, waitpid will block, can't short-circuit */
6447 /* Do we do this right?
6448 * bash-3.00# sleep 20 | false
6450 * [3]+ Stopped sleep 20 | false
6451 * bash-3.00# echo $?
6452 * 1 <========== bg pipe is not fully done, but exitcode is already known!
6453 * [hush 1.14.0: yes we do it right]
6460 #if ENABLE_HUSH_FAST
6461 i = G.count_SIGCHLD;
6463 childpid = waitpid(-1, &status, attributes);
6464 if (childpid <= 0) {
6465 if (childpid && errno != ECHILD)
6466 bb_perror_msg("waitpid");
6467 #if ENABLE_HUSH_FAST
6468 else { /* Until next SIGCHLD, waitpid's are useless */
6469 G.we_have_children = (childpid == 0);
6470 G.handled_SIGCHLD = i;
6471 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6476 dead = WIFEXITED(status) || WIFSIGNALED(status);
6479 if (WIFSTOPPED(status))
6480 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
6481 childpid, WSTOPSIG(status), WEXITSTATUS(status));
6482 if (WIFSIGNALED(status))
6483 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
6484 childpid, WTERMSIG(status), WEXITSTATUS(status));
6485 if (WIFEXITED(status))
6486 debug_printf_jobs("pid %d exited, exitcode %d\n",
6487 childpid, WEXITSTATUS(status));
6489 /* Were we asked to wait for fg pipe? */
6491 i = fg_pipe->num_cmds;
6493 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
6494 if (fg_pipe->cmds[i].pid != childpid)
6498 fg_pipe->cmds[i].pid = 0;
6499 fg_pipe->alive_cmds--;
6500 ex = WEXITSTATUS(status);
6501 /* bash prints killer signal's name for *last*
6502 * process in pipe (prints just newline for SIGINT).
6503 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
6505 if (WIFSIGNALED(status)) {
6506 int sig = WTERMSIG(status);
6507 if (i == fg_pipe->num_cmds-1)
6508 printf("%s\n", sig == SIGINT ? "" : get_signame(sig));
6509 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
6510 * Maybe we need to use sig | 128? */
6513 fg_pipe->cmds[i].cmd_exitcode = ex;
6515 fg_pipe->cmds[i].is_stopped = 1;
6516 fg_pipe->stopped_cmds++;
6518 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
6519 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
6520 if (fg_pipe->alive_cmds == fg_pipe->stopped_cmds) {
6521 /* All processes in fg pipe have exited or stopped */
6522 i = fg_pipe->num_cmds;
6524 rcode = fg_pipe->cmds[i].cmd_exitcode;
6525 /* usually last process gives overall exitstatus,
6526 * but with "set -o pipefail", last *failed* process does */
6527 if (G.o_opt[OPT_O_PIPEFAIL] == 0 || rcode != 0)
6530 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
6531 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
6532 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
6533 * and "killall -STOP cat" */
6534 if (G_interactive_fd) {
6536 if (fg_pipe->alive_cmds != 0)
6537 insert_bg_job(fg_pipe);
6541 if (fg_pipe->alive_cmds == 0)
6544 /* There are still running processes in the fg pipe */
6545 goto wait_more; /* do waitpid again */
6547 /* it wasnt fg_pipe, look for process in bg pipes */
6551 /* We asked to wait for bg or orphaned children */
6552 /* No need to remember exitcode in this case */
6553 for (pi = G.job_list; pi; pi = pi->next) {
6554 for (i = 0; i < pi->num_cmds; i++) {
6555 if (pi->cmds[i].pid == childpid)
6556 goto found_pi_and_prognum;
6559 /* Happens when shell is used as init process (init=/bin/sh) */
6560 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
6561 continue; /* do waitpid again */
6563 found_pi_and_prognum:
6566 pi->cmds[i].pid = 0;
6568 if (!pi->alive_cmds) {
6569 if (G_interactive_fd)
6570 printf(JOB_STATUS_FORMAT, pi->jobid,
6571 "Done", pi->cmdtext);
6572 delete_finished_bg_job(pi);
6576 pi->cmds[i].is_stopped = 1;
6580 } /* while (waitpid succeeds)... */
6586 static int checkjobs_and_fg_shell(struct pipe *fg_pipe)
6589 int rcode = checkjobs(fg_pipe);
6590 if (G_saved_tty_pgrp) {
6591 /* Job finished, move the shell to the foreground */
6592 p = getpgrp(); /* our process group id */
6593 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
6594 tcsetpgrp(G_interactive_fd, p);
6600 /* Start all the jobs, but don't wait for anything to finish.
6603 * Return code is normally -1, when the caller has to wait for children
6604 * to finish to determine the exit status of the pipe. If the pipe
6605 * is a simple builtin command, however, the action is done by the
6606 * time run_pipe returns, and the exit code is provided as the
6609 * Returns -1 only if started some children. IOW: we have to
6610 * mask out retvals of builtins etc with 0xff!
6612 * The only case when we do not need to [v]fork is when the pipe
6613 * is single, non-backgrounded, non-subshell command. Examples:
6614 * cmd ; ... { list } ; ...
6615 * cmd && ... { list } && ...
6616 * cmd || ... { list } || ...
6617 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
6618 * or (if SH_STANDALONE) an applet, and we can run the { list }
6619 * with run_list. If it isn't one of these, we fork and exec cmd.
6621 * Cases when we must fork:
6622 * non-single: cmd | cmd
6623 * backgrounded: cmd & { list } &
6624 * subshell: ( list ) [&]
6626 #if !ENABLE_HUSH_MODE_X
6627 #define redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel, argv_expanded) \
6628 redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel)
6630 static int redirect_and_varexp_helper(char ***new_env_p,
6631 struct variable **old_vars_p,
6632 struct command *command,
6634 char **argv_expanded)
6636 /* setup_redirects acts on file descriptors, not FILEs.
6637 * This is perfect for work that comes after exec().
6638 * Is it really safe for inline use? Experimentally,
6639 * things seem to work. */
6640 int rcode = setup_redirects(command, squirrel);
6642 char **new_env = expand_assignments(command->argv, command->assignment_cnt);
6643 *new_env_p = new_env;
6644 dump_cmd_in_x_mode(new_env);
6645 dump_cmd_in_x_mode(argv_expanded);
6647 *old_vars_p = set_vars_and_save_old(new_env);
6651 static NOINLINE int run_pipe(struct pipe *pi)
6653 static const char *const null_ptr = NULL;
6657 struct command *command;
6658 char **argv_expanded;
6660 /* it is not always needed, but we aim to smaller code */
6661 int squirrel[] = { -1, -1, -1 };
6664 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
6667 /* Testcase: set -- q w e; (IFS='' echo "$*"; IFS=''; echo "$*"); echo "$*"
6668 * Result should be 3 lines: q w e, qwe, q w e
6670 G.ifs = get_local_var_value("IFS");
6674 IF_HUSH_JOB(pi->pgrp = -1;)
6675 pi->stopped_cmds = 0;
6676 command = &pi->cmds[0];
6677 argv_expanded = NULL;
6679 if (pi->num_cmds != 1
6680 || pi->followup == PIPE_BG
6681 || command->cmd_type == CMD_SUBSHELL
6688 debug_printf_exec(": group:%p argv:'%s'\n",
6689 command->group, command->argv ? command->argv[0] : "NONE");
6691 if (command->group) {
6692 #if ENABLE_HUSH_FUNCTIONS
6693 if (command->cmd_type == CMD_FUNCDEF) {
6694 /* "executing" func () { list } */
6695 struct function *funcp;
6697 funcp = new_function(command->argv[0]);
6698 /* funcp->name is already set to argv[0] */
6699 funcp->body = command->group;
6701 funcp->body_as_string = command->group_as_string;
6702 command->group_as_string = NULL;
6704 command->group = NULL;
6705 command->argv[0] = NULL;
6706 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
6707 funcp->parent_cmd = command;
6708 command->child_func = funcp;
6710 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
6712 return EXIT_SUCCESS;
6716 debug_printf("non-subshell group\n");
6717 rcode = 1; /* exitcode if redir failed */
6718 if (setup_redirects(command, squirrel) == 0) {
6719 debug_printf_exec(": run_list\n");
6720 rcode = run_list(command->group) & 0xff;
6722 restore_redirects(squirrel);
6723 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6725 debug_printf_exec("run_pipe: return %d\n", rcode);
6729 argv = command->argv ? command->argv : (char **) &null_ptr;
6731 const struct built_in_command *x;
6732 #if ENABLE_HUSH_FUNCTIONS
6733 const struct function *funcp;
6737 char **new_env = NULL;
6738 struct variable *old_vars = NULL;
6740 if (argv[command->assignment_cnt] == NULL) {
6741 /* Assignments, but no command */
6742 /* Ensure redirects take effect (that is, create files).
6743 * Try "a=t >file" */
6744 #if 0 /* A few cases in testsuite fail with this code. FIXME */
6745 rcode = redirect_and_varexp_helper(&new_env, /*old_vars:*/ NULL, command, squirrel, /*argv_expanded:*/ NULL);
6746 /* Set shell variables */
6750 set_local_var(*argv, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
6751 /* Do we need to flag set_local_var() errors?
6752 * "assignment to readonly var" and "putenv error"
6757 /* Redirect error sets $? to 1. Otherwise,
6758 * if evaluating assignment value set $?, retain it.
6759 * Try "false; q=`exit 2`; echo $?" - should print 2: */
6761 rcode = G.last_exitcode;
6762 /* Exit, _skipping_ variable restoring code: */
6763 goto clean_up_and_ret0;
6765 #else /* Older, bigger, but more correct code */
6767 rcode = setup_redirects(command, squirrel);
6768 restore_redirects(squirrel);
6769 /* Set shell variables */
6771 bb_putchar_stderr('+');
6773 char *p = expand_string_to_string(*argv, /*unbackslash:*/ 1);
6775 fprintf(stderr, " %s", p);
6776 debug_printf_exec("set shell var:'%s'->'%s'\n",
6778 set_local_var(p, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
6779 /* Do we need to flag set_local_var() errors?
6780 * "assignment to readonly var" and "putenv error"
6785 bb_putchar_stderr('\n');
6786 /* Redirect error sets $? to 1. Otherwise,
6787 * if evaluating assignment value set $?, retain it.
6788 * Try "false; q=`exit 2`; echo $?" - should print 2: */
6790 rcode = G.last_exitcode;
6791 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6793 debug_printf_exec("run_pipe: return %d\n", rcode);
6798 /* Expand the rest into (possibly) many strings each */
6800 #if ENABLE_HUSH_BASH_COMPAT
6801 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
6802 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
6806 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
6809 /* if someone gives us an empty string: `cmd with empty output` */
6810 if (!argv_expanded[0]) {
6811 free(argv_expanded);
6813 return G.last_exitcode;
6816 x = find_builtin(argv_expanded[0]);
6817 #if ENABLE_HUSH_FUNCTIONS
6820 funcp = find_function(argv_expanded[0]);
6824 if (x->b_function == builtin_exec && argv_expanded[1] == NULL) {
6825 debug_printf("exec with redirects only\n");
6826 rcode = setup_redirects(command, NULL);
6827 goto clean_up_and_ret1;
6830 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, squirrel, argv_expanded);
6833 debug_printf_exec(": builtin '%s' '%s'...\n",
6834 x->b_cmd, argv_expanded[1]);
6835 rcode = x->b_function(argv_expanded) & 0xff;
6838 #if ENABLE_HUSH_FUNCTIONS
6840 # if ENABLE_HUSH_LOCAL
6841 struct variable **sv;
6842 sv = G.shadowed_vars_pp;
6843 G.shadowed_vars_pp = &old_vars;
6845 debug_printf_exec(": function '%s' '%s'...\n",
6846 funcp->name, argv_expanded[1]);
6847 rcode = run_function(funcp, argv_expanded) & 0xff;
6848 # if ENABLE_HUSH_LOCAL
6849 G.shadowed_vars_pp = sv;
6855 unset_vars(new_env);
6857 /* clean_up_and_ret0: */
6858 restore_redirects(squirrel);
6860 free(argv_expanded);
6861 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6863 debug_printf_exec("run_pipe return %d\n", rcode);
6867 if (ENABLE_FEATURE_SH_STANDALONE) {
6868 int n = find_applet_by_name(argv_expanded[0]);
6869 if (n >= 0 && APPLET_IS_NOFORK(n)) {
6870 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, squirrel, argv_expanded);
6872 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
6873 argv_expanded[0], argv_expanded[1]);
6874 rcode = run_nofork_applet(n, argv_expanded);
6876 goto clean_up_and_ret;
6879 /* It is neither builtin nor applet. We must fork. */
6883 /* NB: argv_expanded may already be created, and that
6884 * might include `cmd` runs! Do not rerun it! We *must*
6885 * use argv_expanded if it's non-NULL */
6887 /* Going to fork a child per each pipe member */
6892 while (cmd_no < pi->num_cmds) {
6893 struct fd_pair pipefds;
6895 volatile nommu_save_t nommu_save;
6896 nommu_save.new_env = NULL;
6897 nommu_save.old_vars = NULL;
6898 nommu_save.argv = NULL;
6899 nommu_save.argv_from_re_execing = NULL;
6901 command = &pi->cmds[cmd_no];
6903 if (command->argv) {
6904 debug_printf_exec(": pipe member '%s' '%s'...\n",
6905 command->argv[0], command->argv[1]);
6907 debug_printf_exec(": pipe member with no argv\n");
6910 /* pipes are inserted between pairs of commands */
6913 if (cmd_no < pi->num_cmds)
6914 xpiped_pair(pipefds);
6916 command->pid = BB_MMU ? fork() : vfork();
6917 if (!command->pid) { /* child */
6919 disable_restore_tty_pgrp_on_exit();
6920 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
6922 /* Every child adds itself to new process group
6923 * with pgid == pid_of_first_child_in_pipe */
6924 if (G.run_list_level == 1 && G_interactive_fd) {
6927 if (pgrp < 0) /* true for 1st process only */
6929 if (setpgid(0, pgrp) == 0
6930 && pi->followup != PIPE_BG
6931 && G_saved_tty_pgrp /* we have ctty */
6933 /* We do it in *every* child, not just first,
6935 tcsetpgrp(G_interactive_fd, pgrp);
6939 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
6940 /* 1st cmd in backgrounded pipe
6941 * should have its stdin /dev/null'ed */
6943 if (open(bb_dev_null, O_RDONLY))
6944 xopen("/", O_RDONLY);
6946 xmove_fd(next_infd, 0);
6948 xmove_fd(pipefds.wr, 1);
6951 /* Like bash, explicit redirects override pipes,
6952 * and the pipe fd is available for dup'ing. */
6953 if (setup_redirects(command, NULL))
6956 /* Restore default handlers just prior to exec */
6957 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
6959 /* Stores to nommu_save list of env vars putenv'ed
6960 * (NOMMU, on MMU we don't need that) */
6961 /* cast away volatility... */
6962 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
6963 /* pseudo_exec() does not return */
6966 /* parent or error */
6967 #if ENABLE_HUSH_FAST
6969 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6971 enable_restore_tty_pgrp_on_exit();
6973 /* Clean up after vforked child */
6974 free(nommu_save.argv);
6975 free(nommu_save.argv_from_re_execing);
6976 unset_vars(nommu_save.new_env);
6977 add_vars(nommu_save.old_vars);
6979 free(argv_expanded);
6980 argv_expanded = NULL;
6981 if (command->pid < 0) { /* [v]fork failed */
6982 /* Clearly indicate, was it fork or vfork */
6983 bb_perror_msg(BB_MMU ? "vfork"+1 : "vfork");
6987 /* Second and next children need to know pid of first one */
6989 pi->pgrp = command->pid;
6995 if (cmd_no < pi->num_cmds)
6997 /* Pass read (output) pipe end to next iteration */
6998 next_infd = pipefds.rd;
7001 if (!pi->alive_cmds) {
7003 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
7008 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
7012 /* NB: called by pseudo_exec, and therefore must not modify any
7013 * global data until exec/_exit (we can be a child after vfork!) */
7014 static int run_list(struct pipe *pi)
7016 #if ENABLE_HUSH_CASE
7017 char *case_word = NULL;
7019 #if ENABLE_HUSH_LOOPS
7020 struct pipe *loop_top = NULL;
7021 char **for_lcur = NULL;
7022 char **for_list = NULL;
7024 smallint last_followup;
7026 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
7027 smalluint cond_code = 0;
7029 enum { cond_code = 0 };
7032 smallint rword; /* RES_foo */
7033 smallint last_rword; /* ditto */
7036 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
7039 #if ENABLE_HUSH_LOOPS
7040 /* Check syntax for "for" */
7043 for (cpipe = pi; cpipe; cpipe = cpipe->next) {
7044 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
7046 /* current word is FOR or IN (BOLD in comments below) */
7047 if (cpipe->next == NULL) {
7048 syntax_error("malformed for");
7050 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
7053 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
7054 if (cpipe->next->res_word == RES_DO)
7056 /* next word is not "do". It must be "in" then ("FOR v in ...") */
7057 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
7058 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
7060 syntax_error("malformed for");
7062 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
7069 /* Past this point, all code paths should jump to ret: label
7070 * in order to return, no direct "return" statements please.
7071 * This helps to ensure that no memory is leaked. */
7079 last_rword = RES_XXXX;
7081 last_followup = PIPE_SEQ;
7082 rcode = G.last_exitcode;
7084 /* Go through list of pipes, (maybe) executing them. */
7085 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
7089 IF_HAS_KEYWORDS(rword = pi->res_word;)
7090 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
7091 rword, cond_code, last_rword);
7092 #if ENABLE_HUSH_LOOPS
7093 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
7094 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
7096 /* start of a loop: remember where loop starts */
7101 /* Still in the same "if...", "then..." or "do..." branch? */
7102 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
7103 if ((rcode == 0 && last_followup == PIPE_OR)
7104 || (rcode != 0 && last_followup == PIPE_AND)
7106 /* It is "<true> || CMD" or "<false> && CMD"
7107 * and we should not execute CMD */
7108 debug_printf_exec("skipped cmd because of || or &&\n");
7109 last_followup = pi->followup;
7113 last_followup = pi->followup;
7114 IF_HAS_KEYWORDS(last_rword = rword;)
7117 if (rword == RES_THEN) {
7118 /* if false; then ... fi has exitcode 0! */
7119 G.last_exitcode = rcode = EXIT_SUCCESS;
7120 /* "if <false> THEN cmd": skip cmd */
7124 if (rword == RES_ELSE || rword == RES_ELIF) {
7125 /* "if <true> then ... ELSE/ELIF cmd":
7126 * skip cmd and all following ones */
7131 #if ENABLE_HUSH_LOOPS
7132 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
7134 /* first loop through for */
7136 static const char encoded_dollar_at[] ALIGN1 = {
7137 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
7138 }; /* encoded representation of "$@" */
7139 static const char *const encoded_dollar_at_argv[] = {
7140 encoded_dollar_at, NULL
7141 }; /* argv list with one element: "$@" */
7144 vals = (char**)encoded_dollar_at_argv;
7145 if (pi->next->res_word == RES_IN) {
7146 /* if no variable values after "in" we skip "for" */
7147 if (!pi->next->cmds[0].argv) {
7148 G.last_exitcode = rcode = EXIT_SUCCESS;
7149 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
7152 vals = pi->next->cmds[0].argv;
7153 } /* else: "for var; do..." -> assume "$@" list */
7154 /* create list of variable values */
7155 debug_print_strings("for_list made from", vals);
7156 for_list = expand_strvec_to_strvec(vals);
7157 for_lcur = for_list;
7158 debug_print_strings("for_list", for_list);
7161 /* "for" loop is over, clean up */
7167 /* Insert next value from for_lcur */
7168 /* note: *for_lcur already has quotes removed, $var expanded, etc */
7169 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7172 if (rword == RES_IN) {
7173 continue; /* "for v IN list;..." - "in" has no cmds anyway */
7175 if (rword == RES_DONE) {
7176 continue; /* "done" has no cmds too */
7179 #if ENABLE_HUSH_CASE
7180 if (rword == RES_CASE) {
7181 case_word = expand_strvec_to_string(pi->cmds->argv);
7184 if (rword == RES_MATCH) {
7187 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
7189 /* all prev words didn't match, does this one match? */
7190 argv = pi->cmds->argv;
7192 char *pattern = expand_string_to_string(*argv, /*unbackslash:*/ 1);
7193 /* TODO: which FNM_xxx flags to use? */
7194 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
7196 if (cond_code == 0) { /* match! we will execute this branch */
7197 free(case_word); /* make future "word)" stop */
7205 if (rword == RES_CASE_BODY) { /* inside of a case branch */
7207 continue; /* not matched yet, skip this pipe */
7210 /* Just pressing <enter> in shell should check for jobs.
7211 * OTOH, in non-interactive shell this is useless
7212 * and only leads to extra job checks */
7213 if (pi->num_cmds == 0) {
7214 if (G_interactive_fd)
7215 goto check_jobs_and_continue;
7219 /* After analyzing all keywords and conditions, we decided
7220 * to execute this pipe. NB: have to do checkjobs(NULL)
7221 * after run_pipe to collect any background children,
7222 * even if list execution is to be stopped. */
7223 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
7226 #if ENABLE_HUSH_LOOPS
7227 G.flag_break_continue = 0;
7229 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
7231 /* We ran a builtin, function, or group.
7232 * rcode is already known
7233 * and we don't need to wait for anything. */
7234 G.last_exitcode = rcode;
7235 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
7236 check_and_run_traps(0);
7237 #if ENABLE_HUSH_LOOPS
7238 /* Was it "break" or "continue"? */
7239 if (G.flag_break_continue) {
7240 smallint fbc = G.flag_break_continue;
7241 /* We might fall into outer *loop*,
7242 * don't want to break it too */
7244 G.depth_break_continue--;
7245 if (G.depth_break_continue == 0)
7246 G.flag_break_continue = 0;
7247 /* else: e.g. "continue 2" should *break* once, *then* continue */
7248 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
7249 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
7250 goto check_jobs_and_break;
7251 /* "continue": simulate end of loop */
7256 #if ENABLE_HUSH_FUNCTIONS
7257 if (G.flag_return_in_progress == 1) {
7258 /* same as "goto check_jobs_and_break" */
7263 } else if (pi->followup == PIPE_BG) {
7264 /* What does bash do with attempts to background builtins? */
7265 /* even bash 3.2 doesn't do that well with nested bg:
7266 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
7267 * I'm NOT treating inner &'s as jobs */
7268 check_and_run_traps(0);
7270 if (G.run_list_level == 1)
7273 /* Last command's pid goes to $! */
7274 G.last_bg_pid = pi->cmds[pi->num_cmds - 1].pid;
7275 G.last_exitcode = rcode = EXIT_SUCCESS;
7276 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
7279 if (G.run_list_level == 1 && G_interactive_fd) {
7280 /* Waits for completion, then fg's main shell */
7281 rcode = checkjobs_and_fg_shell(pi);
7282 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
7283 check_and_run_traps(0);
7286 { /* This one just waits for completion */
7287 rcode = checkjobs(pi);
7288 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
7289 check_and_run_traps(0);
7291 G.last_exitcode = rcode;
7295 /* Analyze how result affects subsequent commands */
7297 if (rword == RES_IF || rword == RES_ELIF)
7300 #if ENABLE_HUSH_LOOPS
7301 /* Beware of "while false; true; do ..."! */
7302 if (pi->next && pi->next->res_word == RES_DO) {
7303 if (rword == RES_WHILE) {
7305 /* "while false; do...done" - exitcode 0 */
7306 G.last_exitcode = rcode = EXIT_SUCCESS;
7307 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
7308 goto check_jobs_and_break;
7311 if (rword == RES_UNTIL) {
7313 debug_printf_exec(": until expr is true: breaking\n");
7314 check_jobs_and_break:
7322 check_jobs_and_continue:
7329 #if ENABLE_HUSH_LOOPS
7334 #if ENABLE_HUSH_CASE
7338 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
7342 /* Select which version we will use */
7343 static int run_and_free_list(struct pipe *pi)
7346 debug_printf_exec("run_and_free_list entered\n");
7347 if (!G.o_opt[OPT_O_NOEXEC]) {
7348 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
7349 rcode = run_list(pi);
7351 /* free_pipe_list has the side effect of clearing memory.
7352 * In the long run that function can be merged with run_list,
7353 * but doing that now would hobble the debugging effort. */
7355 debug_printf_exec("run_and_free_list return %d\n", rcode);
7360 /* Called a few times only (or even once if "sh -c") */
7361 static void init_sigmasks(void)
7365 sigset_t old_blocked_set;
7367 if (!G.inherited_set_is_saved) {
7368 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
7369 G.inherited_set = G.blocked_set;
7371 old_blocked_set = G.blocked_set;
7373 mask = (1 << SIGQUIT);
7374 if (G_interactive_fd) {
7375 mask = (1 << SIGQUIT) | SPECIAL_INTERACTIVE_SIGS;
7376 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
7377 mask |= SPECIAL_JOB_SIGS;
7379 G.non_DFL_mask = mask;
7384 sigaddset(&G.blocked_set, sig);
7388 sigdelset(&G.blocked_set, SIGCHLD);
7390 if (memcmp(&old_blocked_set, &G.blocked_set, sizeof(old_blocked_set)) != 0)
7391 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7393 /* POSIX allows shell to re-enable SIGCHLD
7394 * even if it was SIG_IGN on entry */
7395 #if ENABLE_HUSH_FAST
7396 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
7397 if (!G.inherited_set_is_saved)
7398 signal(SIGCHLD, SIGCHLD_handler);
7400 if (!G.inherited_set_is_saved)
7401 signal(SIGCHLD, SIG_DFL);
7404 G.inherited_set_is_saved = 1;
7409 static void maybe_set_to_sigexit(int sig)
7411 void (*handler)(int);
7412 /* non_DFL_mask'ed signals are, well, masked,
7413 * no need to set handler for them.
7415 if (!((G.non_DFL_mask >> sig) & 1)) {
7416 handler = signal(sig, sigexit);
7417 if (handler == SIG_IGN) /* oops... restore back to IGN! */
7418 signal(sig, handler);
7421 /* Set handlers to restore tty pgrp and exit */
7422 static void set_fatal_handlers(void)
7424 /* We _must_ restore tty pgrp on fatal signals */
7426 maybe_set_to_sigexit(SIGILL );
7427 maybe_set_to_sigexit(SIGFPE );
7428 maybe_set_to_sigexit(SIGBUS );
7429 maybe_set_to_sigexit(SIGSEGV);
7430 maybe_set_to_sigexit(SIGTRAP);
7431 } /* else: hush is perfect. what SEGV? */
7432 maybe_set_to_sigexit(SIGABRT);
7433 /* bash 3.2 seems to handle these just like 'fatal' ones */
7434 maybe_set_to_sigexit(SIGPIPE);
7435 maybe_set_to_sigexit(SIGALRM);
7436 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are masked.
7437 * if we aren't interactive... but in this case
7438 * we never want to restore pgrp on exit, and this fn is not called */
7439 /*maybe_set_to_sigexit(SIGHUP );*/
7440 /*maybe_set_to_sigexit(SIGTERM);*/
7441 /*maybe_set_to_sigexit(SIGINT );*/
7445 static int set_mode(int state, char mode, const char *o_opt)
7450 G.o_opt[OPT_O_NOEXEC] = state;
7453 IF_HUSH_MODE_X(G_x_mode = state;)
7457 /* "set -+o" without parameter.
7458 * in bash, set -o produces this output:
7462 * We always use the second form.
7464 const char *p = o_opt_strings;
7467 printf("set %co %s\n", (G.o_opt[idx] ? '-' : '+'), p);
7473 idx = index_in_strings(o_opt_strings, o_opt);
7475 G.o_opt[idx] = state;
7479 return EXIT_FAILURE;
7481 return EXIT_SUCCESS;
7484 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7485 int hush_main(int argc, char **argv)
7488 unsigned builtin_argc;
7490 struct variable *cur_var;
7491 struct variable *shell_ver;
7494 if (EXIT_SUCCESS) /* if EXIT_SUCCESS == 0, it is already done */
7495 G.last_exitcode = EXIT_SUCCESS;
7497 G.argv0_for_re_execing = argv[0];
7499 /* Deal with HUSH_VERSION */
7500 shell_ver = xzalloc(sizeof(*shell_ver));
7501 shell_ver->flg_export = 1;
7502 shell_ver->flg_read_only = 1;
7503 /* Code which handles ${var<op>...} needs writable values for all variables,
7504 * therefore we xstrdup: */
7505 shell_ver->varstr = xstrdup(hush_version_str);
7506 /* Create shell local variables from the values
7507 * currently living in the environment */
7508 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
7509 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
7510 G.top_var = shell_ver;
7511 cur_var = G.top_var;
7514 char *value = strchr(*e, '=');
7515 if (value) { /* paranoia */
7516 cur_var->next = xzalloc(sizeof(*cur_var));
7517 cur_var = cur_var->next;
7518 cur_var->varstr = *e;
7519 cur_var->max_len = strlen(*e);
7520 cur_var->flg_export = 1;
7524 /* (Re)insert HUSH_VERSION into env (AFTER we scanned the env!) */
7525 debug_printf_env("putenv '%s'\n", shell_ver->varstr);
7526 putenv(shell_ver->varstr);
7529 set_pwd_var(/*exp:*/ 1);
7530 /* bash also exports SHLVL and _,
7531 * and sets (but doesn't export) the following variables:
7533 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
7534 * BASH_VERSION='3.2.0(1)-release'
7536 * MACHTYPE=i386-pc-linux-gnu
7538 * HOSTNAME=<xxxxxxxxxx>
7539 * PPID=<NNNNN> - we also do it elsewhere
7550 * PIPESTATUS=([0]="0")
7551 * HISTFILE=/<xxx>/.bash_history
7555 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
7557 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
7567 #if ENABLE_FEATURE_EDITING
7568 G.line_input_state = new_line_input_t(FOR_SHELL);
7569 # if defined MAX_HISTORY && MAX_HISTORY > 0 && ENABLE_HUSH_SAVEHISTORY
7571 const char *hp = get_local_var_value("HISTFILE");
7573 hp = get_local_var_value("HOME");
7575 G.line_input_state->hist_file = concat_path_file(hp, ".hush_history");
7576 //set_local_var(xasprintf("HISTFILE=%s", ...));
7583 G.global_argc = argc;
7584 G.global_argv = argv;
7585 /* Initialize some more globals to non-zero values */
7586 cmdedit_update_prompt();
7588 if (setjmp(die_jmp)) {
7589 /* xfunc has failed! die die die */
7590 /* no EXIT traps, this is an escape hatch! */
7592 hush_exit(xfunc_error_retval);
7595 /* Shell is non-interactive at first. We need to call
7596 * init_sigmasks() if we are going to execute "sh <script>",
7597 * "sh -c <cmds>" or login shell's /etc/profile and friends.
7598 * If we later decide that we are interactive, we run init_sigmasks()
7599 * in order to intercept (more) signals.
7603 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
7606 opt = getopt(argc, argv, "+c:xins"
7609 # if ENABLE_HUSH_FUNCTIONS
7619 * sh ... -c 'script'
7620 * sh ... -c 'script' ARG0 [ARG1...]
7621 * On NOMMU, if builtin_argc != 0,
7622 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
7623 * "" needs to be replaced with NULL
7624 * and BARGV vector fed to builtin function.
7625 * Note: the form without ARG0 never happens:
7626 * sh ... -c 'builtin' BARGV... ""
7629 G.root_pid = getpid();
7630 G.root_ppid = getppid();
7632 G.global_argv = argv + optind;
7633 G.global_argc = argc - optind;
7635 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
7636 const struct built_in_command *x;
7639 x = find_builtin(optarg);
7640 if (x) { /* paranoia */
7641 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
7642 G.global_argv += builtin_argc;
7643 G.global_argv[-1] = NULL; /* replace "" */
7644 G.last_exitcode = x->b_function(argv + optind - 1);
7648 if (!G.global_argv[0]) {
7649 /* -c 'script' (no params): prevent empty $0 */
7650 G.global_argv--; /* points to argv[i] of 'script' */
7651 G.global_argv[0] = argv[0];
7653 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
7655 parse_and_run_string(optarg);
7658 /* Well, we cannot just declare interactiveness,
7659 * we have to have some stuff (ctty, etc) */
7660 /* G_interactive_fd++; */
7663 /* "-s" means "read from stdin", but this is how we always
7664 * operate, so simply do nothing here. */
7667 case '<': /* "big heredoc" support */
7668 full_write1_str(optarg);
7671 unsigned long long empty_trap_mask;
7673 G.root_pid = bb_strtou(optarg, &optarg, 16);
7675 G.root_ppid = bb_strtou(optarg, &optarg, 16);
7677 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
7679 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
7681 builtin_argc = bb_strtou(optarg, &optarg, 16);
7683 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
7684 if (empty_trap_mask != 0) {
7687 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7688 for (sig = 1; sig < NSIG; sig++) {
7689 if (empty_trap_mask & (1LL << sig)) {
7690 G.traps[sig] = xzalloc(1); /* == xstrdup(""); */
7691 sigaddset(&G.blocked_set, sig);
7694 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7696 # if ENABLE_HUSH_LOOPS
7698 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
7704 set_local_var(xstrdup(optarg), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ opt == 'R');
7706 # if ENABLE_HUSH_FUNCTIONS
7708 struct function *funcp = new_function(optarg);
7709 /* funcp->name is already set to optarg */
7710 /* funcp->body is set to NULL. It's a special case. */
7711 funcp->body_as_string = argv[optind];
7719 if (set_mode(1, opt, NULL) == 0) /* no error */
7723 fprintf(stderr, "Usage: sh [FILE]...\n"
7724 " or: sh -c command [args]...\n\n");
7730 } /* option parsing loop */
7733 G.root_pid = getpid();
7734 G.root_ppid = getppid();
7737 /* If we are login shell... */
7738 if (argv[0] && argv[0][0] == '-') {
7740 debug_printf("sourcing /etc/profile\n");
7741 input = fopen_for_read("/etc/profile");
7742 if (input != NULL) {
7743 close_on_exec_on(fileno(input));
7745 parse_and_run_file(input);
7748 /* bash: after sourcing /etc/profile,
7749 * tries to source (in the given order):
7750 * ~/.bash_profile, ~/.bash_login, ~/.profile,
7751 * stopping on first found. --noprofile turns this off.
7752 * bash also sources ~/.bash_logout on exit.
7753 * If called as sh, skips .bash_XXX files.
7760 * "bash <script>" (which is never interactive (unless -i?))
7761 * sources $BASH_ENV here (without scanning $PATH).
7762 * If called as sh, does the same but with $ENV.
7764 debug_printf("running script '%s'\n", argv[optind]);
7765 G.global_argv = argv + optind;
7766 G.global_argc = argc - optind;
7767 input = xfopen_for_read(argv[optind]);
7768 close_on_exec_on(fileno(input));
7770 parse_and_run_file(input);
7771 #if ENABLE_FEATURE_CLEAN_UP
7777 /* Up to here, shell was non-interactive. Now it may become one.
7778 * NB: don't forget to (re)run init_sigmasks() as needed.
7781 /* A shell is interactive if the '-i' flag was given,
7782 * or if all of the following conditions are met:
7784 * no arguments remaining or the -s flag given
7785 * standard input is a terminal
7786 * standard output is a terminal
7787 * Refer to Posix.2, the description of the 'sh' utility.
7790 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7791 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
7792 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
7793 if (G_saved_tty_pgrp < 0)
7794 G_saved_tty_pgrp = 0;
7796 /* try to dup stdin to high fd#, >= 255 */
7797 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7798 if (G_interactive_fd < 0) {
7799 /* try to dup to any fd */
7800 G_interactive_fd = dup(STDIN_FILENO);
7801 if (G_interactive_fd < 0) {
7803 G_interactive_fd = 0;
7804 G_saved_tty_pgrp = 0;
7807 // TODO: track & disallow any attempts of user
7808 // to (inadvertently) close/redirect G_interactive_fd
7810 debug_printf("interactive_fd:%d\n", G_interactive_fd);
7811 if (G_interactive_fd) {
7812 close_on_exec_on(G_interactive_fd);
7814 if (G_saved_tty_pgrp) {
7815 /* If we were run as 'hush &', sleep until we are
7816 * in the foreground (tty pgrp == our pgrp).
7817 * If we get started under a job aware app (like bash),
7818 * make sure we are now in charge so we don't fight over
7819 * who gets the foreground */
7821 pid_t shell_pgrp = getpgrp();
7822 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
7823 if (G_saved_tty_pgrp == shell_pgrp)
7825 /* send TTIN to ourself (should stop us) */
7826 kill(- shell_pgrp, SIGTTIN);
7830 /* Block some signals */
7833 if (G_saved_tty_pgrp) {
7834 /* Set other signals to restore saved_tty_pgrp */
7835 set_fatal_handlers();
7836 /* Put ourselves in our own process group
7837 * (bash, too, does this only if ctty is available) */
7838 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
7839 /* Grab control of the terminal */
7840 tcsetpgrp(G_interactive_fd, getpid());
7842 /* -1 is special - makes xfuncs longjmp, not exit
7843 * (we reset die_sleep = 0 whereever we [v]fork) */
7844 enable_restore_tty_pgrp_on_exit(); /* sets die_sleep = -1 */
7848 #elif ENABLE_HUSH_INTERACTIVE
7849 /* No job control compiled in, only prompt/line editing */
7850 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7851 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7852 if (G_interactive_fd < 0) {
7853 /* try to dup to any fd */
7854 G_interactive_fd = dup(STDIN_FILENO);
7855 if (G_interactive_fd < 0)
7857 G_interactive_fd = 0;
7860 if (G_interactive_fd) {
7861 close_on_exec_on(G_interactive_fd);
7865 /* We have interactiveness code disabled */
7869 * if interactive but not a login shell, sources ~/.bashrc
7870 * (--norc turns this off, --rcfile <file> overrides)
7873 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
7874 /* note: ash and hush share this string */
7875 printf("\n\n%s %s\n"
7876 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
7879 "hush - the humble shell"
7883 parse_and_run_file(stdin);
7886 hush_exit(G.last_exitcode);
7891 int msh_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7892 int msh_main(int argc, char **argv)
7894 //bb_error_msg("msh is deprecated, please use hush instead");
7895 return hush_main(argc, argv);
7903 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
7908 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
7915 return applet_main_func(argc, argv - argc);
7918 static int FAST_FUNC builtin_test(char **argv)
7920 return run_applet_main(argv, test_main);
7923 static int FAST_FUNC builtin_echo(char **argv)
7925 return run_applet_main(argv, echo_main);
7929 static int FAST_FUNC builtin_printf(char **argv)
7931 return run_applet_main(argv, printf_main);
7935 static char **skip_dash_dash(char **argv)
7938 if (argv[0] && argv[0][0] == '-' && argv[0][1] == '-' && argv[0][2] == '\0')
7943 static int FAST_FUNC builtin_eval(char **argv)
7945 int rcode = EXIT_SUCCESS;
7947 argv = skip_dash_dash(argv);
7949 char *str = expand_strvec_to_string(argv);
7951 * eval "echo Hi; done" ("done" is syntax error):
7952 * "echo Hi" will not execute too.
7954 parse_and_run_string(str);
7956 rcode = G.last_exitcode;
7961 static int FAST_FUNC builtin_cd(char **argv)
7965 argv = skip_dash_dash(argv);
7967 if (newdir == NULL) {
7968 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
7969 * bash says "bash: cd: HOME not set" and does nothing
7972 const char *home = get_local_var_value("HOME");
7973 newdir = home ? home : "/";
7975 if (chdir(newdir)) {
7976 /* Mimic bash message exactly */
7977 bb_perror_msg("cd: %s", newdir);
7978 return EXIT_FAILURE;
7980 /* Read current dir (get_cwd(1) is inside) and set PWD.
7981 * Note: do not enforce exporting. If PWD was unset or unexported,
7982 * set it again, but do not export. bash does the same.
7984 set_pwd_var(/*exp:*/ 0);
7985 return EXIT_SUCCESS;
7988 static int FAST_FUNC builtin_exec(char **argv)
7990 argv = skip_dash_dash(argv);
7991 if (argv[0] == NULL)
7992 return EXIT_SUCCESS; /* bash does this */
7994 /* Careful: we can end up here after [v]fork. Do not restore
7995 * tty pgrp then, only top-level shell process does that */
7996 if (G_saved_tty_pgrp && getpid() == G.root_pid)
7997 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
7999 /* TODO: if exec fails, bash does NOT exit! We do.
8000 * We'll need to undo sigprocmask (it's inside execvp_or_die)
8001 * and tcsetpgrp, and this is inherently racy.
8003 execvp_or_die(argv);
8006 static int FAST_FUNC builtin_exit(char **argv)
8008 debug_printf_exec("%s()\n", __func__);
8010 /* interactive bash:
8011 * # trap "echo EEE" EXIT
8014 * There are stopped jobs.
8015 * (if there are _stopped_ jobs, running ones don't count)
8018 # EEE (then bash exits)
8020 * TODO: we can use G.exiting = -1 as indicator "last cmd was exit"
8023 /* note: EXIT trap is run by hush_exit */
8024 argv = skip_dash_dash(argv);
8025 if (argv[0] == NULL)
8026 hush_exit(G.last_exitcode);
8027 /* mimic bash: exit 123abc == exit 255 + error msg */
8028 xfunc_error_retval = 255;
8029 /* bash: exit -2 == exit 254, no error msg */
8030 hush_exit(xatoi(argv[0]) & 0xff);
8033 static void print_escaped(const char *s)
8038 const char *p = strchrnul(s, '\'');
8039 /* print 'xxxx', possibly just '' */
8040 printf("'%.*s'", (int)(p - s), s);
8045 /* s points to '; print "'''...'''" */
8047 do putchar('\''); while (*++s == '\'');
8052 #if !ENABLE_HUSH_LOCAL
8053 #define helper_export_local(argv, exp, lvl) \
8054 helper_export_local(argv, exp)
8056 static void helper_export_local(char **argv, int exp, int lvl)
8060 char *name_end = strchrnul(name, '=');
8062 /* So far we do not check that name is valid (TODO?) */
8064 if (*name_end == '\0') {
8065 struct variable *var, **vpp;
8067 vpp = get_ptr_to_local_var(name, name_end - name);
8068 var = vpp ? *vpp : NULL;
8070 if (exp == -1) { /* unexporting? */
8071 /* export -n NAME (without =VALUE) */
8073 var->flg_export = 0;
8074 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
8076 } /* else: export -n NOT_EXISTING_VAR: no-op */
8079 if (exp == 1) { /* exporting? */
8080 /* export NAME (without =VALUE) */
8082 var->flg_export = 1;
8083 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
8084 putenv(var->varstr);
8088 /* Exporting non-existing variable.
8089 * bash does not put it in environment,
8090 * but remembers that it is exported,
8091 * and does put it in env when it is set later.
8092 * We just set it to "" and export. */
8093 /* Or, it's "local NAME" (without =VALUE).
8094 * bash sets the value to "". */
8095 name = xasprintf("%s=", name);
8097 /* (Un)exporting/making local NAME=VALUE */
8098 name = xstrdup(name);
8100 set_local_var(name, /*exp:*/ exp, /*lvl:*/ lvl, /*ro:*/ 0);
8104 static int FAST_FUNC builtin_export(char **argv)
8106 unsigned opt_unexport;
8108 #if ENABLE_HUSH_EXPORT_N
8109 /* "!": do not abort on errors */
8110 opt_unexport = getopt32(argv, "!n");
8111 if (opt_unexport == (uint32_t)-1)
8112 return EXIT_FAILURE;
8119 if (argv[0] == NULL) {
8126 /* ash emits: export VAR='VAL'
8127 * bash: declare -x VAR="VAL"
8128 * we follow ash example */
8129 const char *s = *e++;
8130 const char *p = strchr(s, '=');
8132 if (!p) /* wtf? take next variable */
8135 printf("export %.*s", (int)(p - s) + 1, s);
8136 print_escaped(p + 1);
8140 /*fflush_all(); - done after each builtin anyway */
8142 return EXIT_SUCCESS;
8145 helper_export_local(argv, (opt_unexport ? -1 : 1), 0);
8147 return EXIT_SUCCESS;
8150 #if ENABLE_HUSH_LOCAL
8151 static int FAST_FUNC builtin_local(char **argv)
8153 if (G.func_nest_level == 0) {
8154 bb_error_msg("%s: not in a function", argv[0]);
8155 return EXIT_FAILURE; /* bash compat */
8157 helper_export_local(argv, 0, G.func_nest_level);
8158 return EXIT_SUCCESS;
8162 static int FAST_FUNC builtin_trap(char **argv)
8168 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
8173 /* No args: print all trapped */
8174 for (i = 0; i < NSIG; ++i) {
8177 print_escaped(G.traps[i]);
8178 /* note: bash adds "SIG", but only if invoked
8179 * as "bash". If called as "sh", or if set -o posix,
8180 * then it prints short signal names.
8181 * We are printing short names: */
8182 printf(" %s\n", get_signame(i));
8185 /*fflush_all(); - done after each builtin anyway */
8186 return EXIT_SUCCESS;
8190 /* If first arg is a number: reset all specified signals */
8191 sig = bb_strtou(*argv, NULL, 10);
8197 sig = get_signum(*argv++);
8198 if (sig < 0 || sig >= NSIG) {
8200 /* Mimic bash message exactly */
8201 bb_perror_msg("trap: %s: invalid signal specification", argv[-1]);
8206 G.traps[sig] = xstrdup(new_cmd);
8208 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
8209 get_signame(sig), sig, G.traps[sig]);
8211 /* There is no signal for 0 (EXIT) */
8216 sigaddset(&G.blocked_set, sig);
8218 /* There was a trap handler, we are removing it
8219 * (if sig has non-DFL handling,
8220 * we don't need to do anything) */
8221 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
8223 sigdelset(&G.blocked_set, sig);
8226 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8230 if (!argv[1]) { /* no second arg */
8231 bb_error_msg("trap: invalid arguments");
8232 return EXIT_FAILURE;
8235 /* First arg is "-": reset all specified to default */
8236 /* First arg is "--": skip it, the rest is "handler SIGs..." */
8237 /* Everything else: set arg as signal handler
8238 * (includes "" case, which ignores signal) */
8239 if (argv[0][0] == '-') {
8240 if (argv[0][1] == '\0') { /* "-" */
8241 /* new_cmd remains NULL: "reset these sigs" */
8244 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
8247 /* else: "-something", no special meaning */
8252 goto process_sig_list;
8255 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
8256 static int FAST_FUNC builtin_type(char **argv)
8258 int ret = EXIT_SUCCESS;
8264 if (0) {} /* make conditional compile easier below */
8265 /*else if (find_alias(*argv))
8266 type = "an alias";*/
8267 #if ENABLE_HUSH_FUNCTIONS
8268 else if (find_function(*argv))
8269 type = "a function";
8271 else if (find_builtin(*argv))
8272 type = "a shell builtin";
8273 else if ((path = find_in_path(*argv)) != NULL)
8276 bb_error_msg("type: %s: not found", *argv);
8281 printf("%s is %s\n", *argv, type);
8289 /* built-in 'fg' and 'bg' handler */
8290 static int FAST_FUNC builtin_fg_bg(char **argv)
8295 if (!G_interactive_fd)
8296 return EXIT_FAILURE;
8298 /* If they gave us no args, assume they want the last backgrounded task */
8300 for (pi = G.job_list; pi; pi = pi->next) {
8301 if (pi->jobid == G.last_jobid) {
8305 bb_error_msg("%s: no current job", argv[0]);
8306 return EXIT_FAILURE;
8308 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
8309 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
8310 return EXIT_FAILURE;
8312 for (pi = G.job_list; pi; pi = pi->next) {
8313 if (pi->jobid == jobnum) {
8317 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
8318 return EXIT_FAILURE;
8320 /* TODO: bash prints a string representation
8321 * of job being foregrounded (like "sleep 1 | cat") */
8322 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
8323 /* Put the job into the foreground. */
8324 tcsetpgrp(G_interactive_fd, pi->pgrp);
8327 /* Restart the processes in the job */
8328 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
8329 for (i = 0; i < pi->num_cmds; i++) {
8330 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
8331 pi->cmds[i].is_stopped = 0;
8333 pi->stopped_cmds = 0;
8335 i = kill(- pi->pgrp, SIGCONT);
8337 if (errno == ESRCH) {
8338 delete_finished_bg_job(pi);
8339 return EXIT_SUCCESS;
8341 bb_perror_msg("kill (SIGCONT)");
8344 if (argv[0][0] == 'f') {
8346 return checkjobs_and_fg_shell(pi);
8348 return EXIT_SUCCESS;
8352 #if ENABLE_HUSH_HELP
8353 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
8355 const struct built_in_command *x;
8358 "Built-in commands:\n"
8359 "------------------\n");
8360 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
8362 printf("%-10s%s\n", x->b_cmd, x->b_descr);
8365 return EXIT_SUCCESS;
8370 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
8373 const char *status_string;
8375 for (job = G.job_list; job; job = job->next) {
8376 if (job->alive_cmds == job->stopped_cmds)
8377 status_string = "Stopped";
8379 status_string = "Running";
8381 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
8383 return EXIT_SUCCESS;
8388 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
8393 # ifdef M_TRIM_THRESHOLD
8394 /* Optional. Reduces probability of false positives */
8397 /* Crude attempt to find where "free memory" starts,
8398 * sans fragmentation. */
8400 l = (unsigned long)p;
8403 if (l < (unsigned long)p) l = (unsigned long)p;
8406 if (!G.memleak_value)
8407 G.memleak_value = l;
8409 l -= G.memleak_value;
8416 /* Exitcode is "how many kilobytes we leaked since 1st call" */
8421 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
8424 return EXIT_SUCCESS;
8427 static int FAST_FUNC builtin_read(char **argv)
8436 /* "!": do not abort on errors.
8437 * Option string must start with "sr" to match BUILTIN_READ_xxx
8439 read_flags = getopt32(argv, "!srn:p:t:u:", &opt_n, &opt_p, &opt_t, &opt_u);
8440 if (read_flags == (uint32_t)-1)
8441 return EXIT_FAILURE;
8444 r = shell_builtin_read(set_local_var_from_halves,
8446 get_local_var_value("IFS"), /* can be NULL */
8454 if ((uintptr_t)r > 1) {
8455 bb_error_msg("%s", r);
8456 r = (char*)(uintptr_t)1;
8459 return (uintptr_t)r;
8462 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
8463 * built-in 'set' handler
8465 * set [-abCefhmnuvx] [-o option] [argument...]
8466 * set [+abCefhmnuvx] [+o option] [argument...]
8467 * set -- [argument...]
8470 * Implementations shall support the options in both their hyphen and
8471 * plus-sign forms. These options can also be specified as options to sh.
8473 * Write out all variables and their values: set
8474 * Set $1, $2, and $3 and set "$#" to 3: set c a b
8475 * Turn on the -x and -v options: set -xv
8476 * Unset all positional parameters: set --
8477 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
8478 * Set the positional parameters to the expansion of x, even if x expands
8479 * with a leading '-' or '+': set -- $x
8481 * So far, we only support "set -- [argument...]" and some of the short names.
8483 static int FAST_FUNC builtin_set(char **argv)
8486 char **pp, **g_argv;
8487 char *arg = *++argv;
8491 for (e = G.top_var; e; e = e->next)
8493 return EXIT_SUCCESS;
8497 if (strcmp(arg, "--") == 0) {
8501 if (arg[0] != '+' && arg[0] != '-')
8503 for (n = 1; arg[n]; ++n) {
8504 if (set_mode((arg[0] == '-'), arg[n], argv[1]))
8506 if (arg[n] == 'o' && argv[1])
8509 } while ((arg = *++argv) != NULL);
8510 /* Now argv[0] is 1st argument */
8513 return EXIT_SUCCESS;
8516 /* NB: G.global_argv[0] ($0) is never freed/changed */
8517 g_argv = G.global_argv;
8518 if (G.global_args_malloced) {
8524 G.global_args_malloced = 1;
8525 pp = xzalloc(sizeof(pp[0]) * 2);
8526 pp[0] = g_argv[0]; /* retain $0 */
8529 /* This realloc's G.global_argv */
8530 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
8537 return EXIT_SUCCESS;
8539 /* Nothing known, so abort */
8541 bb_error_msg("set: %s: invalid option", arg);
8542 return EXIT_FAILURE;
8545 static int FAST_FUNC builtin_shift(char **argv)
8548 argv = skip_dash_dash(argv);
8552 if (n >= 0 && n < G.global_argc) {
8553 if (G.global_args_malloced) {
8556 free(G.global_argv[m++]);
8559 memmove(&G.global_argv[1], &G.global_argv[n+1],
8560 G.global_argc * sizeof(G.global_argv[0]));
8561 return EXIT_SUCCESS;
8563 return EXIT_FAILURE;
8566 static int FAST_FUNC builtin_source(char **argv)
8568 char *arg_path, *filename;
8571 #if ENABLE_HUSH_FUNCTIONS
8575 argv = skip_dash_dash(argv);
8578 /* bash says: "bash: .: filename argument required" */
8579 return 2; /* bash compat */
8582 if (!strchr(filename, '/')) {
8583 arg_path = find_in_path(filename);
8585 filename = arg_path;
8587 input = fopen_or_warn(filename, "r");
8590 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
8591 return EXIT_FAILURE;
8593 close_on_exec_on(fileno(input));
8595 #if ENABLE_HUSH_FUNCTIONS
8596 sv_flg = G.flag_return_in_progress;
8597 /* "we are inside sourced file, ok to use return" */
8598 G.flag_return_in_progress = -1;
8600 save_and_replace_G_args(&sv, argv);
8602 parse_and_run_file(input);
8605 restore_G_args(&sv, argv);
8606 #if ENABLE_HUSH_FUNCTIONS
8607 G.flag_return_in_progress = sv_flg;
8610 return G.last_exitcode;
8613 static int FAST_FUNC builtin_umask(char **argv)
8619 argv = skip_dash_dash(argv);
8621 mode_t old_mask = mask;
8624 rc = bb_parse_mode(argv[0], &mask);
8629 * bash: umask: 'q': invalid symbolic mode operator
8630 * bash: umask: 999: octal number out of range
8632 bb_error_msg("%s: invalid mode '%s'", "umask", argv[0]);
8637 printf("%04o\n", (unsigned) mask);
8638 /* fall through and restore mask which we set to 0 */
8642 return !rc; /* rc != 0 - success */
8645 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
8646 static int FAST_FUNC builtin_unset(char **argv)
8651 /* "!": do not abort on errors */
8652 /* "+": stop at 1st non-option */
8653 opts = getopt32(argv, "!+vf");
8654 if (opts == (unsigned)-1)
8655 return EXIT_FAILURE;
8657 bb_error_msg("unset: -v and -f are exclusive");
8658 return EXIT_FAILURE;
8664 if (!(opts & 2)) { /* not -f */
8665 if (unset_local_var(*argv)) {
8666 /* unset <nonexistent_var> doesn't fail.
8667 * Error is when one tries to unset RO var.
8668 * Message was printed by unset_local_var. */
8672 #if ENABLE_HUSH_FUNCTIONS
8682 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
8683 static int FAST_FUNC builtin_wait(char **argv)
8685 int ret = EXIT_SUCCESS;
8688 argv = skip_dash_dash(argv);
8689 if (argv[0] == NULL) {
8690 /* Don't care about wait results */
8691 /* Note 1: must wait until there are no more children */
8692 /* Note 2: must be interruptible */
8694 * $ sleep 3 & sleep 6 & wait
8699 * $ sleep 3 & sleep 6 & wait
8703 * ^C <-- after ~4 sec from keyboard
8706 sigaddset(&G.blocked_set, SIGCHLD);
8707 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8710 if (errno == ECHILD)
8712 /* Wait for SIGCHLD or any other signal of interest */
8713 /* sigtimedwait with infinite timeout: */
8714 sig = sigwaitinfo(&G.blocked_set, NULL);
8716 sig = check_and_run_traps(sig);
8717 if (sig && sig != SIGCHLD) { /* see note 2 */
8723 sigdelset(&G.blocked_set, SIGCHLD);
8724 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8728 /* This is probably buggy wrt interruptible-ness */
8730 pid_t pid = bb_strtou(*argv, NULL, 10);
8732 /* mimic bash message */
8733 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
8734 return EXIT_FAILURE;
8736 if (waitpid(pid, &status, 0) == pid) {
8737 if (WIFSIGNALED(status))
8738 ret = 128 + WTERMSIG(status);
8739 else if (WIFEXITED(status))
8740 ret = WEXITSTATUS(status);
8744 bb_perror_msg("wait %s", *argv);
8753 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
8754 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
8757 def = bb_strtou(argv[1], NULL, 10);
8758 if (errno || def < def_min || argv[2]) {
8759 bb_error_msg("%s: bad arguments", argv[0]);
8767 #if ENABLE_HUSH_LOOPS
8768 static int FAST_FUNC builtin_break(char **argv)
8771 if (G.depth_of_loop == 0) {
8772 bb_error_msg("%s: only meaningful in a loop", argv[0]);
8773 return EXIT_SUCCESS; /* bash compat */
8775 G.flag_break_continue++; /* BC_BREAK = 1 */
8777 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
8778 if (depth == UINT_MAX)
8779 G.flag_break_continue = BC_BREAK;
8780 if (G.depth_of_loop < depth)
8781 G.depth_break_continue = G.depth_of_loop;
8783 return EXIT_SUCCESS;
8786 static int FAST_FUNC builtin_continue(char **argv)
8788 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
8789 return builtin_break(argv);
8793 #if ENABLE_HUSH_FUNCTIONS
8794 static int FAST_FUNC builtin_return(char **argv)
8798 if (G.flag_return_in_progress != -1) {
8799 bb_error_msg("%s: not in a function or sourced script", argv[0]);
8800 return EXIT_FAILURE; /* bash compat */
8803 G.flag_return_in_progress = 1;
8806 * out of range: wraps around at 256, does not error out
8807 * non-numeric param:
8808 * f() { false; return qwe; }; f; echo $?
8809 * bash: return: qwe: numeric argument required <== we do this
8810 * 255 <== we also do this
8812 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);