1 /* vi: set sw=4 ts=4: */
3 * A prototype Bourne shell grammar parser.
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
9 * Copyright (C) 2008,2009 Denys Vlasenko <vda.linux@googlemail.com>
12 * The parser routines proper are all original material, first
13 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
14 * execution engine, the builtins, and much of the underlying
15 * support has been adapted from busybox-0.49pre's lash, which is
16 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
17 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
18 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
19 * Troan, which they placed in the public domain. I don't know
20 * how much of the Johnson/Troan code has survived the repeated
24 * o_addchr derived from similar w_addchar function in glibc-2.2.
25 * parse_redirect, redirect_opt_num, and big chunks of main
26 * and many builtins derived from contributions by Erik Andersen.
27 * Miscellaneous bugfixes from Matt Kraai.
29 * There are two big (and related) architecture differences between
30 * this parser and the lash parser. One is that this version is
31 * actually designed from the ground up to understand nearly all
32 * of the Bourne grammar. The second, consequential change is that
33 * the parser and input reader have been turned inside out. Now,
34 * the parser is in control, and asks for input as needed. The old
35 * way had the input reader in control, and it asked for parsing to
36 * take place as needed. The new way makes it much easier to properly
37 * handle the recursion implicit in the various substitutions, especially
38 * across continuation lines.
41 * grep for "TODO" and fix (some of them are easy)
42 * special variables (done: PWD, PPID, RANDOM)
45 * follow IFS rules more precisely, including update semantics
46 * builtins mandated by standards we don't support:
47 * [un]alias, command, fc, getopts, newgrp, readonly, times
48 * make complex ${var%...} constructs support optional
49 * make here documents optional
52 * redirection of stdout+stderr: &> and >&
53 * brace expansion: one/{two,three,four}
54 * reserved words: function select
55 * advanced test: [[ ]]
56 * process substitution: <(list) and >(list)
59 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
60 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
61 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
63 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
64 * This is exactly equivalent to let "EXPR".
65 * $[EXPR]: synonym for $((EXPR))
66 * export builtin should be special, its arguments are assignments
67 * and therefore expansion of them should be "one-word" expansion:
68 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
70 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
71 * ls: cannot access i=a: No such file or directory
72 * ls: cannot access b: No such file or directory
73 * Note1: same applies to local builtin.
74 * Note2: bash 3.2.33(1) does this only if export word itself
76 * $ export i=`echo 'aaa bbb'`; echo "$i"
78 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
81 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
83 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
84 #include <malloc.h> /* for malloc_trim */
86 /* #include <dmalloc.h> */
91 #include "shell_common.h"
94 #if ENABLE_HUSH_RANDOM_SUPPORT
97 # define CLEAR_RANDOM_T(rnd) ((void)0)
100 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
103 //applet:IF_HUSH(APPLET(hush, _BB_DIR_BIN, _BB_SUID_DROP))
104 //applet:IF_MSH(APPLET(msh, _BB_DIR_BIN, _BB_SUID_DROP))
105 //applet:IF_FEATURE_SH_IS_HUSH(APPLET_ODDNAME(sh, hush, _BB_DIR_BIN, _BB_SUID_DROP, sh))
106 //applet:IF_FEATURE_BASH_IS_HUSH(APPLET_ODDNAME(bash, hush, _BB_DIR_BIN, _BB_SUID_DROP, bash))
108 //kbuild:lib-$(CONFIG_HUSH) += hush.o match.o shell_common.o
109 //kbuild:lib-$(CONFIG_HUSH_RANDOM_SUPPORT) += random.o
112 //config: bool "hush"
115 //config: hush is a small shell (25k). It handles the normal flow control
116 //config: constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
117 //config: case/esac. Redirections, here documents, $((arithmetic))
118 //config: and functions are supported.
120 //config: It will compile and work on no-mmu systems.
122 //config: It does not handle select, aliases, brace expansion,
123 //config: tilde expansion, &>file and >&file redirection of stdout+stderr.
125 //config:config HUSH_BASH_COMPAT
126 //config: bool "bash-compatible extensions"
128 //config: depends on HUSH
130 //config: Enable bash-compatible extensions.
132 //config:config HUSH_HELP
133 //config: bool "help builtin"
135 //config: depends on HUSH
137 //config: Enable help builtin in hush. Code size + ~1 kbyte.
139 //config:config HUSH_INTERACTIVE
140 //config: bool "Interactive mode"
142 //config: depends on HUSH
144 //config: Enable interactive mode (prompt and command editing).
145 //config: Without this, hush simply reads and executes commands
146 //config: from stdin just like a shell script from a file.
147 //config: No prompt, no PS1/PS2 magic shell variables.
149 //config:config HUSH_JOB
150 //config: bool "Job control"
152 //config: depends on HUSH_INTERACTIVE
154 //config: Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
155 //config: command (not entire shell), fg/bg builtins work. Without this option,
156 //config: "cmd &" still works by simply spawning a process and immediately
157 //config: prompting for next command (or executing next command in a script),
158 //config: but no separate process group is formed.
160 //config:config HUSH_TICK
161 //config: bool "Process substitution"
163 //config: depends on HUSH
165 //config: Enable process substitution `command` and $(command) in hush.
167 //config:config HUSH_IF
168 //config: bool "Support if/then/elif/else/fi"
170 //config: depends on HUSH
172 //config: Enable if/then/elif/else/fi in hush.
174 //config:config HUSH_LOOPS
175 //config: bool "Support for, while and until loops"
177 //config: depends on HUSH
179 //config: Enable for, while and until loops in hush.
181 //config:config HUSH_CASE
182 //config: bool "Support case ... esac statement"
184 //config: depends on HUSH
186 //config: Enable case ... esac statement in hush. +400 bytes.
188 //config:config HUSH_FUNCTIONS
189 //config: bool "Support funcname() { commands; } syntax"
191 //config: depends on HUSH
193 //config: Enable support for shell functions in hush. +800 bytes.
195 //config:config HUSH_LOCAL
196 //config: bool "Support local builtin"
198 //config: depends on HUSH_FUNCTIONS
200 //config: Enable support for local variables in functions.
202 //config:config HUSH_RANDOM_SUPPORT
203 //config: bool "Pseudorandom generator and $RANDOM variable"
205 //config: depends on HUSH
207 //config: Enable pseudorandom generator and dynamic variable "$RANDOM".
208 //config: Each read of "$RANDOM" will generate a new pseudorandom value.
210 //config:config HUSH_EXPORT_N
211 //config: bool "Support 'export -n' option"
213 //config: depends on HUSH
215 //config: export -n unexports variables. It is a bash extension.
217 //config:config HUSH_MODE_X
218 //config: bool "Support 'hush -x' option and 'set -x' command"
220 //config: depends on HUSH
222 //config: This instructs hush to print commands before execution.
223 //config: Adds ~300 bytes.
226 //config: bool "msh (deprecated: aliased to hush)"
228 //config: select HUSH
230 //config: msh is deprecated and will be removed, please migrate to hush.
233 //usage:#define hush_trivial_usage NOUSAGE_STR
234 //usage:#define hush_full_usage ""
235 //usage:#define msh_trivial_usage NOUSAGE_STR
236 //usage:#define msh_full_usage ""
240 #define LEAK_HUNTING 0
241 #define BUILD_AS_NOMMU 0
242 /* Enable/disable sanity checks. Ok to enable in production,
243 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
244 * Keeping 1 for now even in released versions.
247 /* Slightly bigger (+200 bytes), but faster hush.
248 * So far it only enables a trick with counting SIGCHLDs and forks,
249 * which allows us to do fewer waitpid's.
250 * (we can detect a case where neither forks were done nor SIGCHLDs happened
251 * and therefore waitpid will return the same result as last time)
253 #define ENABLE_HUSH_FAST 0
254 /* TODO: implement simplified code for users which do not need ${var%...} ops
255 * So far ${var%...} ops are always enabled:
257 #define ENABLE_HUSH_DOLLAR_OPS 1
262 # undef USE_FOR_NOMMU
265 # define USE_FOR_NOMMU(...) __VA_ARGS__
266 # define USE_FOR_MMU(...)
269 #include "NUM_APPLETS.h"
271 /* STANDALONE does not make sense, and won't compile */
272 # undef CONFIG_FEATURE_SH_STANDALONE
273 # undef ENABLE_FEATURE_SH_STANDALONE
274 # undef IF_FEATURE_SH_STANDALONE
275 # undef IF_NOT_FEATURE_SH_STANDALONE
276 # define ENABLE_FEATURE_SH_STANDALONE 0
277 # define IF_FEATURE_SH_STANDALONE(...)
278 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
281 #if !ENABLE_HUSH_INTERACTIVE
282 # undef ENABLE_FEATURE_EDITING
283 # define ENABLE_FEATURE_EDITING 0
284 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
285 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
288 /* Do we support ANY keywords? */
289 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
290 # define HAS_KEYWORDS 1
291 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
292 # define IF_HAS_NO_KEYWORDS(...)
294 # define HAS_KEYWORDS 0
295 # define IF_HAS_KEYWORDS(...)
296 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
299 /* If you comment out one of these below, it will be #defined later
300 * to perform debug printfs to stderr: */
301 #define debug_printf(...) do {} while (0)
302 /* Finer-grained debug switches */
303 #define debug_printf_parse(...) do {} while (0)
304 #define debug_print_tree(a, b) do {} while (0)
305 #define debug_printf_exec(...) do {} while (0)
306 #define debug_printf_env(...) do {} while (0)
307 #define debug_printf_jobs(...) do {} while (0)
308 #define debug_printf_expand(...) do {} while (0)
309 #define debug_printf_varexp(...) do {} while (0)
310 #define debug_printf_glob(...) do {} while (0)
311 #define debug_printf_list(...) do {} while (0)
312 #define debug_printf_subst(...) do {} while (0)
313 #define debug_printf_clean(...) do {} while (0)
315 #define ERR_PTR ((void*)(long)1)
317 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
319 #define _SPECIAL_VARS_STR "_*@$!?#"
320 #define SPECIAL_VARS_STR ("_*@$!?#" + 1)
321 #define NUMERIC_SPECVARS_STR ("_*@$!?#" + 3)
322 #if ENABLE_HUSH_BASH_COMPAT
323 /* Support / and // replace ops */
324 /* Note that // is stored as \ in "encoded" string representation */
325 # define VAR_ENCODED_SUBST_OPS "\\/%#:-=+?"
326 # define VAR_SUBST_OPS ("\\/%#:-=+?" + 1)
327 # define MINUS_PLUS_EQUAL_QUESTION ("\\/%#:-=+?" + 5)
329 # define VAR_ENCODED_SUBST_OPS "%#:-=+?"
330 # define VAR_SUBST_OPS "%#:-=+?"
331 # define MINUS_PLUS_EQUAL_QUESTION ("%#:-=+?" + 3)
334 #define SPECIAL_VAR_SYMBOL 3
338 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
340 /* This supports saving pointers malloced in vfork child,
341 * to be freed in the parent.
344 typedef struct nommu_save_t {
346 struct variable *old_vars;
348 char **argv_from_re_execing;
352 typedef enum reserved_style {
361 #if ENABLE_HUSH_LOOPS
368 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
373 /* three pseudo-keywords support contrived "case" syntax: */
374 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
375 RES_MATCH , /* "word)" */
376 RES_CASE_BODY, /* "this command is inside CASE" */
383 typedef struct o_string {
385 int length; /* position where data is appended */
387 /* Protect newly added chars against globbing
388 * (by prepending \ to *, ?, [, \) */
391 /* At least some part of the string was inside '' or "",
392 * possibly empty one: word"", wo''rd etc. */
393 smallint has_quoted_part;
394 smallint has_empty_slot;
395 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
398 MAYBE_ASSIGNMENT = 0,
399 DEFINITELY_ASSIGNMENT = 1,
401 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
403 /* Used for initialization: o_string foo = NULL_O_STRING; */
404 #define NULL_O_STRING { NULL }
406 /* I can almost use ordinary FILE*. Is open_memstream() universally
407 * available? Where is it documented? */
408 typedef struct in_str {
410 /* eof_flag=1: last char in ->p is really an EOF */
411 char eof_flag; /* meaningless if ->p == NULL */
413 #if ENABLE_HUSH_INTERACTIVE
415 smallint promptmode; /* 0: PS1, 1: PS2 */
418 int (*get) (struct in_str *) FAST_FUNC;
419 int (*peek) (struct in_str *) FAST_FUNC;
421 #define i_getch(input) ((input)->get(input))
422 #define i_peek(input) ((input)->peek(input))
424 /* The descrip member of this structure is only used to make
425 * debugging output pretty */
426 static const struct {
428 signed char default_fd;
431 { O_RDONLY, 0, "<" },
432 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
433 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
434 { O_CREAT|O_RDWR, 1, "<>" },
435 { O_RDONLY, 0, "<<" },
436 /* Should not be needed. Bogus default_fd helps in debugging */
437 /* { O_RDONLY, 77, "<<" }, */
440 struct redir_struct {
441 struct redir_struct *next;
442 char *rd_filename; /* filename */
443 int rd_fd; /* fd to redirect */
444 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
446 smallint rd_type; /* (enum redir_type) */
447 /* note: for heredocs, rd_filename contains heredoc delimiter,
448 * and subsequently heredoc itself; and rd_dup is a bitmask:
449 * bit 0: do we need to trim leading tabs?
450 * bit 1: is heredoc quoted (<<'delim' syntax) ?
453 typedef enum redir_type {
455 REDIRECT_OVERWRITE = 1,
458 REDIRECT_HEREDOC = 4,
459 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
462 REDIRFD_SYNTAX_ERR = -2,
463 REDIRFD_TO_FILE = -1,
464 /* otherwise, rd_fd is redirected to rd_dup */
466 HEREDOC_SKIPTABS = 1,
472 pid_t pid; /* 0 if exited */
473 int assignment_cnt; /* how many argv[i] are assignments? */
474 smallint is_stopped; /* is the command currently running? */
475 smallint cmd_type; /* CMD_xxx */
477 #define CMD_SUBSHELL 1
478 #if ENABLE_HUSH_BASH_COMPAT
479 /* used for "[[ EXPR ]]" */
480 # define CMD_SINGLEWORD_NOGLOB 2
482 #if ENABLE_HUSH_FUNCTIONS
483 # define CMD_FUNCDEF 3
486 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
489 char *group_as_string;
491 #if ENABLE_HUSH_FUNCTIONS
492 struct function *child_func;
493 /* This field is used to prevent a bug here:
494 * while...do f1() {a;}; f1; f1() {b;}; f1; done
495 * When we execute "f1() {a;}" cmd, we create new function and clear
496 * cmd->group, cmd->group_as_string, cmd->argv[0].
497 * When we execute "f1() {b;}", we notice that f1 exists,
498 * and that its "parent cmd" struct is still "alive",
499 * we put those fields back into cmd->xxx
500 * (struct function has ->parent_cmd ptr to facilitate that).
501 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
502 * Without this trick, loop would execute a;b;b;b;...
503 * instead of correct sequence a;b;a;b;...
504 * When command is freed, it severs the link
505 * (sets ->child_func->parent_cmd to NULL).
508 char **argv; /* command name and arguments */
509 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
510 * and on execution these are substituted with their values.
511 * Substitution can make _several_ words out of one argv[n]!
512 * Example: argv[0]=='.^C*^C.' here: echo .$*.
513 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
515 struct redir_struct *redirects; /* I/O redirections */
517 /* Is there anything in this command at all? */
518 #define IS_NULL_CMD(cmd) \
519 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
524 int num_cmds; /* total number of commands in pipe */
525 int alive_cmds; /* number of commands running (not exited) */
526 int stopped_cmds; /* number of commands alive, but stopped */
528 int jobid; /* job number */
529 pid_t pgrp; /* process group ID for the job */
530 char *cmdtext; /* name of job */
532 struct command *cmds; /* array of commands in pipe */
533 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
534 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
535 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
537 typedef enum pipe_style {
543 /* Is there anything in this pipe at all? */
544 #define IS_NULL_PIPE(pi) \
545 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
547 /* This holds pointers to the various results of parsing */
548 struct parse_context {
549 /* linked list of pipes */
550 struct pipe *list_head;
551 /* last pipe (being constructed right now) */
553 /* last command in pipe (being constructed right now) */
554 struct command *command;
555 /* last redirect in command->redirects list */
556 struct redir_struct *pending_redirect;
562 smallint ctx_inverted; /* "! cmd | cmd" */
564 smallint ctx_dsemicolon; /* ";;" seen */
566 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
568 /* group we are enclosed in:
569 * example: "if pipe1; pipe2; then pipe3; fi"
570 * when we see "if" or "then", we malloc and copy current context,
571 * and make ->stack point to it. then we parse pipeN.
572 * when closing "then" / fi" / whatever is found,
573 * we move list_head into ->stack->command->group,
574 * copy ->stack into current context, and delete ->stack.
575 * (parsing of { list } and ( list ) doesn't use this method)
577 struct parse_context *stack;
581 /* On program start, environ points to initial environment.
582 * putenv adds new pointers into it, unsetenv removes them.
583 * Neither of these (de)allocates the strings.
584 * setenv allocates new strings in malloc space and does putenv,
585 * and thus setenv is unusable (leaky) for shell's purposes */
586 #define setenv(...) setenv_is_leaky_dont_use()
588 struct variable *next;
589 char *varstr; /* points to "name=" portion */
590 #if ENABLE_HUSH_LOCAL
591 unsigned func_nest_level;
593 int max_len; /* if > 0, name is part of initial env; else name is malloced */
594 smallint flg_export; /* putenv should be done on this var */
595 smallint flg_read_only;
603 #if ENABLE_HUSH_FUNCTIONS
605 struct function *next;
607 struct command *parent_cmd;
610 char *body_as_string;
616 /* "Globals" within this file */
617 /* Sorted roughly by size (smaller offsets == smaller code) */
619 /* interactive_fd != 0 means we are an interactive shell.
620 * If we are, then saved_tty_pgrp can also be != 0, meaning
621 * that controlling tty is available. With saved_tty_pgrp == 0,
622 * job control still works, but terminal signals
623 * (^C, ^Z, ^Y, ^\) won't work at all, and background
624 * process groups can only be created with "cmd &".
625 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
626 * to give tty to the foreground process group,
627 * and will take it back when the group is stopped (^Z)
630 #if ENABLE_HUSH_INTERACTIVE
631 /* 'interactive_fd' is a fd# open to ctty, if we have one
632 * _AND_ if we decided to act interactively */
636 # define G_interactive_fd (G.interactive_fd)
638 # define G_interactive_fd 0
640 #if ENABLE_FEATURE_EDITING
641 line_input_t *line_input_state;
646 #if ENABLE_HUSH_RANDOM_SUPPORT
652 pid_t saved_tty_pgrp;
653 struct pipe *job_list;
654 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
656 # define G_saved_tty_pgrp 0
658 smallint flag_SIGINT;
659 #if ENABLE_HUSH_LOOPS
660 smallint flag_break_continue;
662 #if ENABLE_HUSH_FUNCTIONS
663 /* 0: outside of a function (or sourced file)
664 * -1: inside of a function, ok to use return builtin
665 * 1: return is invoked, skip all till end of func
667 smallint flag_return_in_progress;
670 #if ENABLE_HUSH_MODE_X
672 # define G_x_mode (G.x_mode)
676 smallint exiting; /* used to prevent EXIT trap recursion */
677 /* These four support $?, $#, and $1 */
678 smalluint last_exitcode;
679 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
680 smalluint global_args_malloced;
681 smalluint inherited_set_is_saved;
682 /* how many non-NULL argv's we have. NB: $# + 1 */
686 char *argv0_for_re_execing;
688 #if ENABLE_HUSH_LOOPS
689 unsigned depth_break_continue;
690 unsigned depth_of_loop;
694 struct variable *top_var; /* = &G.shell_ver (set in main()) */
695 struct variable shell_ver;
696 char **expanded_assignments;
697 #if ENABLE_HUSH_FUNCTIONS
698 struct function *top_func;
699 # if ENABLE_HUSH_LOCAL
700 struct variable **shadowed_vars_pp;
701 unsigned func_nest_level;
704 /* Signal and trap handling */
706 unsigned count_SIGCHLD;
707 unsigned handled_SIGCHLD;
708 smallint we_have_children;
710 /* which signals have non-DFL handler (even with no traps set)? */
711 unsigned non_DFL_mask;
712 char **traps; /* char *traps[NSIG] */
713 sigset_t blocked_set;
714 sigset_t inherited_set;
716 unsigned long memleak_value;
719 char user_input_buf[ENABLE_FEATURE_EDITING ? CONFIG_FEATURE_EDITING_MAX_LEN : 2];
721 #define G (*ptr_to_globals)
722 /* Not #defining name to G.name - this quickly gets unwieldy
723 * (too many defines). Also, I actually prefer to see when a variable
724 * is global, thus "G." prefix is a useful hint */
725 #define INIT_G() do { \
726 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
730 /* Function prototypes for builtins */
731 static int builtin_cd(char **argv) FAST_FUNC;
732 static int builtin_echo(char **argv) FAST_FUNC;
733 static int builtin_eval(char **argv) FAST_FUNC;
734 static int builtin_exec(char **argv) FAST_FUNC;
735 static int builtin_exit(char **argv) FAST_FUNC;
736 static int builtin_export(char **argv) FAST_FUNC;
738 static int builtin_fg_bg(char **argv) FAST_FUNC;
739 static int builtin_jobs(char **argv) FAST_FUNC;
742 static int builtin_help(char **argv) FAST_FUNC;
744 #if ENABLE_HUSH_LOCAL
745 static int builtin_local(char **argv) FAST_FUNC;
748 static int builtin_memleak(char **argv) FAST_FUNC;
751 static int builtin_printf(char **argv) FAST_FUNC;
753 static int builtin_pwd(char **argv) FAST_FUNC;
754 static int builtin_read(char **argv) FAST_FUNC;
755 static int builtin_set(char **argv) FAST_FUNC;
756 static int builtin_shift(char **argv) FAST_FUNC;
757 static int builtin_source(char **argv) FAST_FUNC;
758 static int builtin_test(char **argv) FAST_FUNC;
759 static int builtin_trap(char **argv) FAST_FUNC;
760 static int builtin_type(char **argv) FAST_FUNC;
761 static int builtin_true(char **argv) FAST_FUNC;
762 static int builtin_umask(char **argv) FAST_FUNC;
763 static int builtin_unset(char **argv) FAST_FUNC;
764 static int builtin_wait(char **argv) FAST_FUNC;
765 #if ENABLE_HUSH_LOOPS
766 static int builtin_break(char **argv) FAST_FUNC;
767 static int builtin_continue(char **argv) FAST_FUNC;
769 #if ENABLE_HUSH_FUNCTIONS
770 static int builtin_return(char **argv) FAST_FUNC;
773 /* Table of built-in functions. They can be forked or not, depending on
774 * context: within pipes, they fork. As simple commands, they do not.
775 * When used in non-forking context, they can change global variables
776 * in the parent shell process. If forked, of course they cannot.
777 * For example, 'unset foo | whatever' will parse and run, but foo will
778 * still be set at the end. */
779 struct built_in_command {
781 int (*b_function)(char **argv) FAST_FUNC;
784 # define BLTIN(cmd, func, help) { cmd, func, help }
786 # define BLTIN(cmd, func, help) { cmd, func }
790 static const struct built_in_command bltins1[] = {
791 BLTIN("." , builtin_source , "Run commands in a file"),
792 BLTIN(":" , builtin_true , NULL),
794 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
796 #if ENABLE_HUSH_LOOPS
797 BLTIN("break" , builtin_break , "Exit from a loop"),
799 BLTIN("cd" , builtin_cd , "Change directory"),
800 #if ENABLE_HUSH_LOOPS
801 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
803 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
804 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
805 BLTIN("exit" , builtin_exit , "Exit"),
806 BLTIN("export" , builtin_export , "Set environment variables"),
808 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
811 BLTIN("help" , builtin_help , NULL),
814 BLTIN("jobs" , builtin_jobs , "List jobs"),
816 #if ENABLE_HUSH_LOCAL
817 BLTIN("local" , builtin_local , "Set local variables"),
820 BLTIN("memleak" , builtin_memleak , NULL),
822 BLTIN("read" , builtin_read , "Input into variable"),
823 #if ENABLE_HUSH_FUNCTIONS
824 BLTIN("return" , builtin_return , "Return from a function"),
826 BLTIN("set" , builtin_set , "Set/unset positional parameters"),
827 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
828 #if ENABLE_HUSH_BASH_COMPAT
829 BLTIN("source" , builtin_source , "Run commands in a file"),
831 BLTIN("trap" , builtin_trap , "Trap signals"),
832 BLTIN("type" , builtin_type , "Show command type"),
833 BLTIN("ulimit" , shell_builtin_ulimit , "Control resource limits"),
834 BLTIN("umask" , builtin_umask , "Set file creation mask"),
835 BLTIN("unset" , builtin_unset , "Unset variables"),
836 BLTIN("wait" , builtin_wait , "Wait for process"),
838 /* For now, echo and test are unconditionally enabled.
839 * Maybe make it configurable? */
840 static const struct built_in_command bltins2[] = {
841 BLTIN("[" , builtin_test , NULL),
842 BLTIN("echo" , builtin_echo , NULL),
844 BLTIN("printf" , builtin_printf , NULL),
846 BLTIN("pwd" , builtin_pwd , NULL),
847 BLTIN("test" , builtin_test , NULL),
854 /* prevent disasters with G.debug_indent < 0 */
855 # define indent() fprintf(stderr, "%*s", (G.debug_indent * 2) & 0xff, "")
856 # define debug_enter() (G.debug_indent++)
857 # define debug_leave() (G.debug_indent--)
859 # define indent() ((void)0)
860 # define debug_enter() ((void)0)
861 # define debug_leave() ((void)0)
865 # define debug_printf(...) (indent(), fprintf(stderr, __VA_ARGS__))
868 #ifndef debug_printf_parse
869 # define debug_printf_parse(...) (indent(), fprintf(stderr, __VA_ARGS__))
872 #ifndef debug_printf_exec
873 #define debug_printf_exec(...) (indent(), fprintf(stderr, __VA_ARGS__))
876 #ifndef debug_printf_env
877 # define debug_printf_env(...) (indent(), fprintf(stderr, __VA_ARGS__))
880 #ifndef debug_printf_jobs
881 # define debug_printf_jobs(...) (indent(), fprintf(stderr, __VA_ARGS__))
882 # define DEBUG_JOBS 1
884 # define DEBUG_JOBS 0
887 #ifndef debug_printf_expand
888 # define debug_printf_expand(...) (indent(), fprintf(stderr, __VA_ARGS__))
889 # define DEBUG_EXPAND 1
891 # define DEBUG_EXPAND 0
894 #ifndef debug_printf_varexp
895 # define debug_printf_varexp(...) (indent(), fprintf(stderr, __VA_ARGS__))
898 #ifndef debug_printf_glob
899 # define debug_printf_glob(...) (indent(), fprintf(stderr, __VA_ARGS__))
900 # define DEBUG_GLOB 1
902 # define DEBUG_GLOB 0
905 #ifndef debug_printf_list
906 # define debug_printf_list(...) (indent(), fprintf(stderr, __VA_ARGS__))
909 #ifndef debug_printf_subst
910 # define debug_printf_subst(...) (indent(), fprintf(stderr, __VA_ARGS__))
913 #ifndef debug_printf_clean
914 # define debug_printf_clean(...) (indent(), fprintf(stderr, __VA_ARGS__))
915 # define DEBUG_CLEAN 1
917 # define DEBUG_CLEAN 0
921 static void debug_print_strings(const char *prefix, char **vv)
924 fprintf(stderr, "%s:\n", prefix);
926 fprintf(stderr, " '%s'\n", *vv++);
929 # define debug_print_strings(prefix, vv) ((void)0)
933 /* Leak hunting. Use hush_leaktool.sh for post-processing.
936 static void *xxmalloc(int lineno, size_t size)
938 void *ptr = xmalloc((size + 0xff) & ~0xff);
939 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
942 static void *xxrealloc(int lineno, void *ptr, size_t size)
944 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
945 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
948 static char *xxstrdup(int lineno, const char *str)
950 char *ptr = xstrdup(str);
951 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
954 static void xxfree(void *ptr)
956 fdprintf(2, "free %p\n", ptr);
959 # define xmalloc(s) xxmalloc(__LINE__, s)
960 # define xrealloc(p, s) xxrealloc(__LINE__, p, s)
961 # define xstrdup(s) xxstrdup(__LINE__, s)
962 # define free(p) xxfree(p)
966 /* Syntax and runtime errors. They always abort scripts.
967 * In interactive use they usually discard unparsed and/or unexecuted commands
968 * and return to the prompt.
969 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
972 # define die_if_script(lineno, ...) die_if_script(__VA_ARGS__)
973 # define syntax_error(lineno, msg) syntax_error(msg)
974 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
975 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
976 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
977 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
980 static void die_if_script(unsigned lineno, const char *fmt, ...)
985 bb_error_msg("hush.c:%u", lineno);
988 bb_verror_msg(fmt, p, NULL);
990 if (!G_interactive_fd)
994 static void syntax_error(unsigned lineno, const char *msg)
997 die_if_script(lineno, "syntax error: %s", msg);
999 die_if_script(lineno, "syntax error", NULL);
1002 static void syntax_error_at(unsigned lineno, const char *msg)
1004 die_if_script(lineno, "syntax error at '%s'", msg);
1007 static void syntax_error_unterm_str(unsigned lineno, const char *s)
1009 die_if_script(lineno, "syntax error: unterminated %s", s);
1012 /* It so happens that all such cases are totally fatal
1013 * even if shell is interactive: EOF while looking for closing
1014 * delimiter. There is nowhere to read stuff from after that,
1015 * it's EOF! The only choice is to terminate.
1017 static void syntax_error_unterm_ch(unsigned lineno, char ch) NORETURN;
1018 static void syntax_error_unterm_ch(unsigned lineno, char ch)
1020 char msg[2] = { ch, '\0' };
1021 syntax_error_unterm_str(lineno, msg);
1025 static void syntax_error_unexpected_ch(unsigned lineno, int ch)
1030 die_if_script(lineno, "syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
1034 # undef die_if_script
1035 # undef syntax_error
1036 # undef syntax_error_at
1037 # undef syntax_error_unterm_ch
1038 # undef syntax_error_unterm_str
1039 # undef syntax_error_unexpected_ch
1041 # define die_if_script(...) die_if_script(__LINE__, __VA_ARGS__)
1042 # define syntax_error(msg) syntax_error(__LINE__, msg)
1043 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
1044 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
1045 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
1046 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
1050 #if ENABLE_HUSH_INTERACTIVE
1051 static void cmdedit_update_prompt(void);
1053 # define cmdedit_update_prompt() ((void)0)
1057 /* Utility functions
1059 /* Replace each \x with x in place, return ptr past NUL. */
1060 static char *unbackslash(char *src)
1062 char *dst = src = strchrnul(src, '\\');
1066 if ((*dst++ = *src++) == '\0')
1072 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
1093 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
1094 v[count1 + count2] = NULL;
1097 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
1101 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
1103 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
1104 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
1107 #define add_strings_to_strings(strings, add, need_to_dup) \
1108 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
1111 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
1112 static char **add_string_to_strings(char **strings, char *add)
1117 return add_strings_to_strings(strings, v, /*dup:*/ 0);
1120 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
1122 char **ptr = add_string_to_strings(strings, add);
1123 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
1126 #define add_string_to_strings(strings, add) \
1127 xx_add_string_to_strings(__LINE__, strings, add)
1130 static void free_strings(char **strings)
1145 /* Helpers for setting new $n and restoring them back
1147 typedef struct save_arg_t {
1151 smallint sv_g_malloced;
1154 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1158 sv->sv_argv0 = argv[0];
1159 sv->sv_g_argv = G.global_argv;
1160 sv->sv_g_argc = G.global_argc;
1161 sv->sv_g_malloced = G.global_args_malloced;
1163 argv[0] = G.global_argv[0]; /* retain $0 */
1164 G.global_argv = argv;
1165 G.global_args_malloced = 0;
1173 static void restore_G_args(save_arg_t *sv, char **argv)
1177 if (G.global_args_malloced) {
1178 /* someone ran "set -- arg1 arg2 ...", undo */
1180 while (*++pp) /* note: does not free $0 */
1182 free(G.global_argv);
1184 argv[0] = sv->sv_argv0;
1185 G.global_argv = sv->sv_g_argv;
1186 G.global_argc = sv->sv_g_argc;
1187 G.global_args_malloced = sv->sv_g_malloced;
1191 /* Basic theory of signal handling in shell
1192 * ========================================
1193 * This does not describe what hush does, rather, it is current understanding
1194 * what it _should_ do. If it doesn't, it's a bug.
1195 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1197 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1198 * is finished or backgrounded. It is the same in interactive and
1199 * non-interactive shells, and is the same regardless of whether
1200 * a user trap handler is installed or a shell special one is in effect.
1201 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1202 * backgrounds (i.e. stops) or kills all members of currently running
1205 * Wait builtin in interruptible by signals for which user trap is set
1206 * or by SIGINT in interactive shell.
1208 * Trap handlers will execute even within trap handlers. (right?)
1210 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1211 * except for handlers set to '' (empty string).
1213 * If job control is off, backgrounded commands ("cmd &")
1214 * have SIGINT, SIGQUIT set to SIG_IGN.
1216 * Commands which are run in command substitution ("`cmd`")
1217 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1219 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1220 * by the shell from its parent.
1222 * Signals which differ from SIG_DFL action
1223 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1226 * SIGTERM (interactive): ignore
1227 * SIGHUP (interactive):
1228 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1229 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1230 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1231 * that all pipe members are stopped. Try this in bash:
1232 * while :; do :; done - ^Z does not background it
1233 * (while :; do :; done) - ^Z backgrounds it
1234 * SIGINT (interactive): wait for last pipe, ignore the rest
1235 * of the command line, show prompt. NB: ^C does not send SIGINT
1236 * to interactive shell while shell is waiting for a pipe,
1237 * since shell is bg'ed (is not in foreground process group).
1238 * Example 1: this waits 5 sec, but does not execute ls:
1239 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1240 * Example 2: this does not wait and does not execute ls:
1241 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1242 * Example 3: this does not wait 5 sec, but executes ls:
1243 * "sleep 5; ls -l" + press ^C
1245 * (What happens to signals which are IGN on shell start?)
1246 * (What happens with signal mask on shell start?)
1248 * Implementation in hush
1249 * ======================
1250 * We use in-kernel pending signal mask to determine which signals were sent.
1251 * We block all signals which we don't want to take action immediately,
1252 * i.e. we block all signals which need to have special handling as described
1253 * above, and all signals which have traps set.
1254 * After each pipe execution, we extract any pending signals via sigtimedwait()
1257 * unsigned non_DFL_mask: a mask of such "special" signals
1258 * sigset_t blocked_set: current blocked signal set
1261 * clear bit in blocked_set unless it is also in non_DFL_mask
1262 * "trap 'cmd' SIGxxx":
1263 * set bit in blocked_set (even if 'cmd' is '')
1264 * after [v]fork, if we plan to be a shell:
1265 * unblock signals with special interactive handling
1266 * (child shell is not interactive),
1267 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1268 * after [v]fork, if we plan to exec:
1269 * POSIX says fork clears pending signal mask in child - no need to clear it.
1270 * Restore blocked signal set to one inherited by shell just prior to exec.
1272 * Note: as a result, we do not use signal handlers much. The only uses
1273 * are to count SIGCHLDs
1274 * and to restore tty pgrp on signal-induced exit.
1277 * Standard says "When a subshell is entered, traps that are not being ignored
1278 * are set to the default actions". bash interprets it so that traps which
1279 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1282 SPECIAL_INTERACTIVE_SIGS = 0
1287 SPECIAL_JOB_SIGS = 0
1295 #if ENABLE_HUSH_FAST
1296 static void SIGCHLD_handler(int sig UNUSED_PARAM)
1299 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1305 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1306 # define disable_restore_tty_pgrp_on_exit() (die_sleep = 0)
1307 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1308 # define enable_restore_tty_pgrp_on_exit() (die_sleep = -1)
1310 /* Restores tty foreground process group, and exits.
1311 * May be called as signal handler for fatal signal
1312 * (will resend signal to itself, producing correct exit state)
1313 * or called directly with -EXITCODE.
1314 * We also call it if xfunc is exiting. */
1315 static void sigexit(int sig) NORETURN;
1316 static void sigexit(int sig)
1318 /* Disable all signals: job control, SIGPIPE, etc. */
1319 sigprocmask_allsigs(SIG_BLOCK);
1321 /* Careful: we can end up here after [v]fork. Do not restore
1322 * tty pgrp then, only top-level shell process does that */
1323 if (G_saved_tty_pgrp && getpid() == G.root_pid)
1324 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1326 /* Not a signal, just exit */
1330 kill_myself_with_sig(sig); /* does not return */
1334 # define disable_restore_tty_pgrp_on_exit() ((void)0)
1335 # define enable_restore_tty_pgrp_on_exit() ((void)0)
1339 /* Restores tty foreground process group, and exits. */
1340 static void hush_exit(int exitcode) NORETURN;
1341 static void hush_exit(int exitcode)
1343 if (G.exiting <= 0 && G.traps && G.traps[0] && G.traps[0][0]) {
1344 /* Prevent recursion:
1345 * trap "echo Hi; exit" EXIT; exit
1347 char *argv[] = { NULL, G.traps[0], NULL };
1356 sigexit(- (exitcode & 0xff));
1362 static int check_and_run_traps(int sig)
1364 static const struct timespec zero_timespec;
1365 smalluint save_rcode;
1371 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
1376 if (G.traps && G.traps[sig]) {
1377 if (G.traps[sig][0]) {
1378 /* We have user-defined handler */
1379 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
1380 save_rcode = G.last_exitcode;
1383 G.last_exitcode = save_rcode;
1384 } /* else: "" trap, ignoring signal */
1387 /* not a trap: special action */
1389 #if ENABLE_HUSH_FAST
1392 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1396 /* Builtin was ^C'ed, make it look prettier: */
1403 /* bash is observed to signal whole process groups,
1404 * not individual processes */
1405 for (job = G.job_list; job; job = job->next) {
1408 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
1409 if (kill(- job->pgrp, SIGHUP) == 0)
1410 kill(- job->pgrp, SIGCONT);
1415 default: /* ignored: */
1416 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
1424 static const char *get_cwd(int force)
1426 if (force || G.cwd == NULL) {
1427 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1428 * we must not try to free(bb_msg_unknown) */
1429 if (G.cwd == bb_msg_unknown)
1431 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1433 G.cwd = bb_msg_unknown;
1440 * Shell and environment variable support
1442 static struct variable **get_ptr_to_local_var(const char *name)
1444 struct variable **pp;
1445 struct variable *cur;
1450 while ((cur = *pp) != NULL) {
1451 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1458 static struct variable *get_local_var(const char *name)
1460 struct variable **pp = get_ptr_to_local_var(name);
1466 static const char* FAST_FUNC get_local_var_value(const char *name)
1468 struct variable **vpp;
1470 if (G.expanded_assignments) {
1471 char **cpp = G.expanded_assignments;
1472 int len = strlen(name);
1475 if (strncmp(cp, name, len) == 0 && cp[len] == '=')
1476 return cp + len + 1;
1481 vpp = get_ptr_to_local_var(name);
1483 return strchr((*vpp)->varstr, '=') + 1;
1485 if (strcmp(name, "PPID") == 0)
1486 return utoa(G.root_ppid);
1487 // bash compat: UID? EUID?
1488 #if ENABLE_HUSH_RANDOM_SUPPORT
1489 if (strcmp(name, "RANDOM") == 0) {
1490 return utoa(next_random(&G.random_gen));
1496 /* str holds "NAME=VAL" and is expected to be malloced.
1497 * We take ownership of it.
1499 * 0: do not change export flag
1500 * (if creating new variable, flag will be 0)
1501 * 1: set export flag and putenv the variable
1502 * -1: clear export flag and unsetenv the variable
1503 * flg_read_only is set only when we handle -R var=val
1505 #if !BB_MMU && ENABLE_HUSH_LOCAL
1506 /* all params are used */
1507 #elif BB_MMU && ENABLE_HUSH_LOCAL
1508 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1509 set_local_var(str, flg_export, local_lvl)
1510 #elif BB_MMU && !ENABLE_HUSH_LOCAL
1511 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1512 set_local_var(str, flg_export)
1513 #elif !BB_MMU && !ENABLE_HUSH_LOCAL
1514 #define set_local_var(str, flg_export, local_lvl, flg_read_only) \
1515 set_local_var(str, flg_export, flg_read_only)
1517 static int set_local_var(char *str, int flg_export, int local_lvl, int flg_read_only)
1519 struct variable **var_pp;
1520 struct variable *cur;
1524 eq_sign = strchr(str, '=');
1525 if (!eq_sign) { /* not expected to ever happen? */
1530 name_len = eq_sign - str + 1; /* including '=' */
1531 var_pp = &G.top_var;
1532 while ((cur = *var_pp) != NULL) {
1533 if (strncmp(cur->varstr, str, name_len) != 0) {
1534 var_pp = &cur->next;
1537 /* We found an existing var with this name */
1538 if (cur->flg_read_only) {
1542 bb_error_msg("%s: readonly variable", str);
1546 if (flg_export == -1) { // "&& cur->flg_export" ?
1547 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1552 #if ENABLE_HUSH_LOCAL
1553 if (cur->func_nest_level < local_lvl) {
1554 /* New variable is declared as local,
1555 * and existing one is global, or local
1556 * from enclosing function.
1557 * Remove and save old one: */
1558 *var_pp = cur->next;
1559 cur->next = *G.shadowed_vars_pp;
1560 *G.shadowed_vars_pp = cur;
1561 /* bash 3.2.33(1) and exported vars:
1563 * # f() { local z=a; env | grep ^z; }
1569 if (cur->flg_export)
1574 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
1579 if (cur->max_len != 0) {
1580 if (cur->max_len >= strlen(str)) {
1581 /* This one is from startup env, reuse space */
1582 strcpy(cur->varstr, str);
1586 /* max_len == 0 signifies "malloced" var, which we can
1587 * (and has to) free */
1591 goto set_str_and_exp;
1594 /* Not found - create new variable struct */
1595 cur = xzalloc(sizeof(*cur));
1596 #if ENABLE_HUSH_LOCAL
1597 cur->func_nest_level = local_lvl;
1599 cur->next = *var_pp;
1605 cur->flg_read_only = flg_read_only;
1608 if (flg_export == 1)
1609 cur->flg_export = 1;
1610 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1611 cmdedit_update_prompt();
1612 if (cur->flg_export) {
1613 if (flg_export == -1) {
1614 cur->flg_export = 0;
1615 /* unsetenv was already done */
1617 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1618 return putenv(cur->varstr);
1624 /* Used at startup and after each cd */
1625 static void set_pwd_var(int exp)
1627 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)),
1628 /*exp:*/ exp, /*lvl:*/ 0, /*ro:*/ 0);
1631 static int unset_local_var_len(const char *name, int name_len)
1633 struct variable *cur;
1634 struct variable **var_pp;
1637 return EXIT_SUCCESS;
1638 var_pp = &G.top_var;
1639 while ((cur = *var_pp) != NULL) {
1640 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1641 if (cur->flg_read_only) {
1642 bb_error_msg("%s: readonly variable", name);
1643 return EXIT_FAILURE;
1645 *var_pp = cur->next;
1646 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1647 bb_unsetenv(cur->varstr);
1648 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
1649 cmdedit_update_prompt();
1653 return EXIT_SUCCESS;
1655 var_pp = &cur->next;
1657 return EXIT_SUCCESS;
1660 static int unset_local_var(const char *name)
1662 return unset_local_var_len(name, strlen(name));
1665 static void unset_vars(char **strings)
1673 const char *eq = strchrnul(*v, '=');
1674 unset_local_var_len(*v, (int)(eq - *v));
1680 #if ENABLE_SH_MATH_SUPPORT
1681 # define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1682 # define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1683 static char* FAST_FUNC endofname(const char *name)
1691 if (!is_in_name(*p))
1698 static void FAST_FUNC set_local_var_from_halves(const char *name, const char *val)
1700 char *var = xasprintf("%s=%s", name, val);
1701 set_local_var(var, /*flags:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
1706 * Helpers for "var1=val1 var2=val2 cmd" feature
1708 static void add_vars(struct variable *var)
1710 struct variable *next;
1714 var->next = G.top_var;
1716 if (var->flg_export) {
1717 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
1718 putenv(var->varstr);
1720 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
1726 static struct variable *set_vars_and_save_old(char **strings)
1729 struct variable *old = NULL;
1735 struct variable *var_p;
1736 struct variable **var_pp;
1739 eq = strchr(*s, '=');
1742 var_pp = get_ptr_to_local_var(*s);
1745 /* Remove variable from global linked list */
1747 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
1748 *var_pp = var_p->next;
1749 /* Add it to returned list */
1753 set_local_var(*s, /*exp:*/ 1, /*lvl:*/ 0, /*ro:*/ 0);
1764 static int FAST_FUNC static_get(struct in_str *i)
1774 static int FAST_FUNC static_peek(struct in_str *i)
1779 #if ENABLE_HUSH_INTERACTIVE
1781 static void cmdedit_update_prompt(void)
1783 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1784 G.PS1 = get_local_var_value("PS1");
1787 G.PS2 = get_local_var_value("PS2");
1795 static const char* setup_prompt_string(int promptmode)
1797 const char *prompt_str;
1798 debug_printf("setup_prompt_string %d ", promptmode);
1799 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1800 /* Set up the prompt */
1801 if (promptmode == 0) { /* PS1 */
1803 /* bash uses $PWD value, even if it is set by user.
1804 * It uses current dir only if PWD is unset.
1805 * We always use current dir. */
1806 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
1811 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1812 debug_printf("result '%s'\n", prompt_str);
1816 static void get_user_input(struct in_str *i)
1819 const char *prompt_str;
1821 prompt_str = setup_prompt_string(i->promptmode);
1822 # if ENABLE_FEATURE_EDITING
1823 /* Enable command line editing only while a command line
1824 * is actually being read */
1827 /* buglet: SIGINT will not make new prompt to appear _at once_,
1828 * only after <Enter>. (^C will work) */
1829 r = read_line_input(prompt_str, G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1, G.line_input_state);
1830 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1831 check_and_run_traps(0);
1832 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1833 i->eof_flag = (r < 0);
1834 if (i->eof_flag) { /* EOF/error detected */
1835 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1836 G.user_input_buf[1] = '\0';
1841 fputs(prompt_str, stdout);
1843 G.user_input_buf[0] = r = fgetc(i->file);
1844 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1845 //do we need check_and_run_traps(0)? (maybe only if stdin)
1846 } while (G.flag_SIGINT);
1847 i->eof_flag = (r == EOF);
1849 i->p = G.user_input_buf;
1852 #endif /* INTERACTIVE */
1854 /* This is the magic location that prints prompts
1855 * and gets data back from the user */
1856 static int FAST_FUNC file_get(struct in_str *i)
1860 /* If there is data waiting, eat it up */
1861 if (i->p && *i->p) {
1862 #if ENABLE_HUSH_INTERACTIVE
1866 if (i->eof_flag && !*i->p)
1868 /* note: ch is never NUL */
1870 /* need to double check i->file because we might be doing something
1871 * more complicated by now, like sourcing or substituting. */
1872 #if ENABLE_HUSH_INTERACTIVE
1873 if (G_interactive_fd && i->promptme && i->file == stdin) {
1876 } while (!*i->p); /* need non-empty line */
1877 i->promptmode = 1; /* PS2 */
1882 do ch = fgetc(i->file); while (ch == '\0');
1884 debug_printf("file_get: got '%c' %d\n", ch, ch);
1885 #if ENABLE_HUSH_INTERACTIVE
1892 /* All callers guarantee this routine will never
1893 * be used right after a newline, so prompting is not needed.
1895 static int FAST_FUNC file_peek(struct in_str *i)
1898 if (i->p && *i->p) {
1899 if (i->eof_flag && !i->p[1])
1902 /* note: ch is never NUL */
1904 do ch = fgetc(i->file); while (ch == '\0');
1905 i->eof_flag = (ch == EOF);
1906 i->peek_buf[0] = ch;
1907 i->peek_buf[1] = '\0';
1909 debug_printf("file_peek: got '%c' %d\n", ch, ch);
1913 static void setup_file_in_str(struct in_str *i, FILE *f)
1915 i->peek = file_peek;
1917 #if ENABLE_HUSH_INTERACTIVE
1919 i->promptmode = 0; /* PS1 */
1925 static void setup_string_in_str(struct in_str *i, const char *s)
1927 i->peek = static_peek;
1928 i->get = static_get;
1929 #if ENABLE_HUSH_INTERACTIVE
1931 i->promptmode = 0; /* PS1 */
1941 #define B_CHUNK (32 * sizeof(char*))
1943 static void o_reset_to_empty_unquoted(o_string *o)
1946 o->has_quoted_part = 0;
1951 static void o_free(o_string *o)
1954 memset(o, 0, sizeof(*o));
1957 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1962 static void o_grow_by(o_string *o, int len)
1964 if (o->length + len > o->maxlen) {
1965 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1966 o->data = xrealloc(o->data, 1 + o->maxlen);
1970 static void o_addchr(o_string *o, int ch)
1972 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1974 o->data[o->length] = ch;
1976 o->data[o->length] = '\0';
1979 static void o_addblock(o_string *o, const char *str, int len)
1982 memcpy(&o->data[o->length], str, len);
1984 o->data[o->length] = '\0';
1987 static void o_addstr(o_string *o, const char *str)
1989 o_addblock(o, str, strlen(str));
1993 static void nommu_addchr(o_string *o, int ch)
1999 # define nommu_addchr(o, str) ((void)0)
2002 static void o_addstr_with_NUL(o_string *o, const char *str)
2004 o_addblock(o, str, strlen(str) + 1);
2007 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
2012 if (*str++ == '\\') {
2013 /* \z -> \\\z; \<eol> -> \\<eol> */
2018 o_addchr(o, *str++);
2024 #undef HUSH_BRACE_EXP
2026 * HUSH_BRACE_EXP code needs corresponding quoting on variable expansion side.
2027 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
2028 * Apparently, on unquoted $v bash still does globbing
2029 * ("v='*.txt'; echo $v" prints all .txt files),
2030 * but NOT brace expansion! Thus, there should be TWO independent
2031 * quoting mechanisms on $v expansion side: one protects
2032 * $v from brace expansion, and other additionally protects "$v" against globbing.
2033 * We have only second one.
2036 #ifdef HUSH_BRACE_EXP
2037 # define MAYBE_BRACES "{}"
2039 # define MAYBE_BRACES ""
2042 /* My analysis of quoting semantics tells me that state information
2043 * is associated with a destination, not a source.
2045 static void o_addqchr(o_string *o, int ch)
2048 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
2053 o->data[o->length] = '\\';
2056 o->data[o->length] = ch;
2058 o->data[o->length] = '\0';
2061 static void o_addQchr(o_string *o, int ch)
2064 if (o->o_escape && strchr("*?[\\" MAYBE_BRACES, ch)) {
2066 o->data[o->length] = '\\';
2070 o->data[o->length] = ch;
2072 o->data[o->length] = '\0';
2075 static void o_addqblock(o_string *o, const char *str, int len)
2080 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
2081 if (ordinary_cnt > len) /* paranoia */
2083 o_addblock(o, str, ordinary_cnt);
2084 if (ordinary_cnt == len)
2086 str += ordinary_cnt;
2087 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
2091 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
2093 o->data[o->length] = '\\';
2097 o->data[o->length] = ch;
2099 o->data[o->length] = '\0';
2103 static void o_addQblock(o_string *o, const char *str, int len)
2106 o_addblock(o, str, len);
2109 o_addqblock(o, str, len);
2112 static void o_addQstr(o_string *o, const char *str)
2114 o_addQblock(o, str, strlen(str));
2117 /* A special kind of o_string for $VAR and `cmd` expansion.
2118 * It contains char* list[] at the beginning, which is grown in 16 element
2119 * increments. Actual string data starts at the next multiple of 16 * (char*).
2120 * list[i] contains an INDEX (int!) into this string data.
2121 * It means that if list[] needs to grow, data needs to be moved higher up
2122 * but list[i]'s need not be modified.
2123 * NB: remembering how many list[i]'s you have there is crucial.
2124 * o_finalize_list() operation post-processes this structure - calculates
2125 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
2127 #if DEBUG_EXPAND || DEBUG_GLOB
2128 static void debug_print_list(const char *prefix, o_string *o, int n)
2130 char **list = (char**)o->data;
2131 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2135 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d glob:%d quoted:%d escape:%d\n",
2136 prefix, list, n, string_start, o->length, o->maxlen, o->o_glob, o->has_quoted_part, o->o_escape);
2139 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
2140 o->data + (int)list[i] + string_start,
2141 o->data + (int)list[i] + string_start);
2145 const char *p = o->data + (int)list[n - 1] + string_start;
2147 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
2151 # define debug_print_list(prefix, o, n) ((void)0)
2154 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
2155 * in list[n] so that it points past last stored byte so far.
2156 * It returns n+1. */
2157 static int o_save_ptr_helper(o_string *o, int n)
2159 char **list = (char**)o->data;
2163 if (!o->has_empty_slot) {
2164 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2165 string_len = o->length - string_start;
2166 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
2167 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
2168 /* list[n] points to string_start, make space for 16 more pointers */
2169 o->maxlen += 0x10 * sizeof(list[0]);
2170 o->data = xrealloc(o->data, o->maxlen + 1);
2171 list = (char**)o->data;
2172 memmove(list + n + 0x10, list + n, string_len);
2173 o->length += 0x10 * sizeof(list[0]);
2175 debug_printf_list("list[%d]=%d string_start=%d\n",
2176 n, string_len, string_start);
2179 /* We have empty slot at list[n], reuse without growth */
2180 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
2181 string_len = o->length - string_start;
2182 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2183 n, string_len, string_start);
2184 o->has_empty_slot = 0;
2186 list[n] = (char*)(ptrdiff_t)string_len;
2190 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2191 static int o_get_last_ptr(o_string *o, int n)
2193 char **list = (char**)o->data;
2194 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2196 return ((int)(ptrdiff_t)list[n-1]) + string_start;
2199 #ifdef HUSH_BRACE_EXP
2200 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2201 * first, it processes even {a} (no commas), second,
2202 * I didn't manage to make it return strings when they don't match
2203 * existing files. Need to re-implement it.
2207 static int glob_needed(const char *s)
2216 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2222 /* Return pointer to next closing brace or to comma */
2223 static const char *next_brace_sub(const char *cp)
2227 while (*cp != '\0') {
2234 /*{*/ if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2236 if (*cp++ == '{') /*}*/
2240 return *cp != '\0' ? cp : NULL;
2242 /* Recursive brace globber. Note: may garble pattern[]. */
2243 static int glob_brace(char *pattern, o_string *o, int n)
2245 char *new_pattern_buf;
2252 debug_printf_glob("glob_brace('%s')\n", pattern);
2258 if (*begin == '{') /*}*/ {
2259 /* Find the first sub-pattern and at the same time
2260 * find the rest after the closing brace */
2261 next = next_brace_sub(begin);
2263 /* An illegal expression */
2266 /*{*/ if (*next == '}') {
2267 /* "{abc}" with no commas - illegal
2268 * brace expr, disregard and skip it */
2274 if (*begin == '\\' && begin[1] != '\0')
2278 debug_printf_glob("begin:%s\n", begin);
2279 debug_printf_glob("next:%s\n", next);
2281 /* Now find the end of the whole brace expression */
2283 /*{*/ while (*rest != '}') {
2284 rest = next_brace_sub(rest);
2286 /* An illegal expression */
2289 debug_printf_glob("rest:%s\n", rest);
2291 rest_len = strlen(++rest) + 1;
2293 /* We are sure the brace expression is well-formed */
2295 /* Allocate working buffer large enough for our work */
2296 new_pattern_buf = xmalloc(strlen(pattern));
2298 /* We have a brace expression. BEGIN points to the opening {,
2299 * NEXT points past the terminator of the first element, and REST
2300 * points past the final }. We will accumulate result names from
2301 * recursive runs for each brace alternative in the buffer using
2306 /* Construct the new glob expression */
2309 mempcpy(new_pattern_buf,
2310 /* We know the prefix for all sub-patterns */
2311 pattern, begin - pattern),
2315 /* Note: glob_brace() may garble new_pattern_buf[].
2316 * That's why we re-copy prefix every time (1st memcpy above).
2318 n = glob_brace(new_pattern_buf, o, n);
2319 /*{*/ if (*next == '}') {
2320 /* We saw the last entry */
2324 next = next_brace_sub(next);
2326 free(new_pattern_buf);
2334 memset(&globdata, 0, sizeof(globdata));
2335 gr = glob(pattern, 0, NULL, &globdata);
2336 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2338 if (gr == GLOB_NOMATCH) {
2339 globfree(&globdata);
2340 /* NB: garbles parameter */
2341 unbackslash(pattern);
2342 o_addstr_with_NUL(o, pattern);
2343 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2344 return o_save_ptr_helper(o, n);
2346 if (gr == GLOB_NOSPACE)
2347 bb_error_msg_and_die(bb_msg_memory_exhausted);
2348 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2349 * but we didn't specify it. Paranoia again. */
2350 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2352 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2353 char **argv = globdata.gl_pathv;
2355 o_addstr_with_NUL(o, *argv);
2356 n = o_save_ptr_helper(o, n);
2362 globfree(&globdata);
2366 /* Performs globbing on last list[],
2367 * saving each result as a new list[].
2369 static int perform_glob(o_string *o, int n)
2371 char *pattern, *copy;
2373 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
2375 return o_save_ptr_helper(o, n);
2376 pattern = o->data + o_get_last_ptr(o, n);
2377 debug_printf_glob("glob pattern '%s'\n", pattern);
2378 if (!glob_needed(pattern)) {
2379 /* unbackslash last string in o in place, fix length */
2380 o->length = unbackslash(pattern) - o->data;
2381 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2382 return o_save_ptr_helper(o, n);
2385 copy = xstrdup(pattern);
2386 /* "forget" pattern in o */
2387 o->length = pattern - o->data;
2388 n = glob_brace(copy, o, n);
2391 debug_print_list("perform_glob returning", o, n);
2395 #else /* !HUSH_BRACE_EXP */
2398 static int glob_needed(const char *s)
2407 if (*s == '*' || *s == '[' || *s == '?')
2413 /* Performs globbing on last list[],
2414 * saving each result as a new list[].
2416 static int perform_glob(o_string *o, int n)
2422 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
2424 return o_save_ptr_helper(o, n);
2425 pattern = o->data + o_get_last_ptr(o, n);
2426 debug_printf_glob("glob pattern '%s'\n", pattern);
2427 if (!glob_needed(pattern)) {
2429 /* unbackslash last string in o in place, fix length */
2430 o->length = unbackslash(pattern) - o->data;
2431 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
2432 return o_save_ptr_helper(o, n);
2435 memset(&globdata, 0, sizeof(globdata));
2436 /* Can't use GLOB_NOCHECK: it does not unescape the string.
2437 * If we glob "*.\*" and don't find anything, we need
2438 * to fall back to using literal "*.*", but GLOB_NOCHECK
2439 * will return "*.\*"!
2441 gr = glob(pattern, 0, NULL, &globdata);
2442 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
2444 if (gr == GLOB_NOMATCH) {
2445 globfree(&globdata);
2448 if (gr == GLOB_NOSPACE)
2449 bb_error_msg_and_die(bb_msg_memory_exhausted);
2450 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
2451 * but we didn't specify it. Paranoia again. */
2452 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
2454 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
2455 char **argv = globdata.gl_pathv;
2456 /* "forget" pattern in o */
2457 o->length = pattern - o->data;
2459 o_addstr_with_NUL(o, *argv);
2460 n = o_save_ptr_helper(o, n);
2466 globfree(&globdata);
2468 debug_print_list("perform_glob returning", o, n);
2472 #endif /* !HUSH_BRACE_EXP */
2474 /* If o->o_glob == 1, glob the string so far remembered.
2475 * Otherwise, just finish current list[] and start new */
2476 static int o_save_ptr(o_string *o, int n)
2478 if (o->o_glob) { /* if globbing is requested */
2479 /* If o->has_empty_slot, list[n] was already globbed
2480 * (if it was requested back then when it was filled)
2481 * so don't do that again! */
2482 if (!o->has_empty_slot)
2483 return perform_glob(o, n); /* o_save_ptr_helper is inside */
2485 return o_save_ptr_helper(o, n);
2488 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
2489 static char **o_finalize_list(o_string *o, int n)
2494 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
2496 debug_print_list("finalized", o, n);
2497 debug_printf_expand("finalized n:%d\n", n);
2498 list = (char**)o->data;
2499 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2503 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
2508 static void free_pipe_list(struct pipe *head);
2510 /* Return code is the exit status of the pipe */
2511 static void free_pipe(struct pipe *pi)
2514 struct command *command;
2515 struct redir_struct *r, *rnext;
2518 if (pi->stopped_cmds > 0) /* why? */
2520 debug_printf_clean("run pipe: (pid %d)\n", getpid());
2521 for (i = 0; i < pi->num_cmds; i++) {
2522 command = &pi->cmds[i];
2523 debug_printf_clean(" command %d:\n", i);
2524 if (command->argv) {
2525 for (a = 0, p = command->argv; *p; a++, p++) {
2526 debug_printf_clean(" argv[%d] = %s\n", a, *p);
2528 free_strings(command->argv);
2529 command->argv = NULL;
2531 /* not "else if": on syntax error, we may have both! */
2532 if (command->group) {
2533 debug_printf_clean(" begin group (cmd_type:%d)\n",
2535 free_pipe_list(command->group);
2536 debug_printf_clean(" end group\n");
2537 command->group = NULL;
2539 /* else is crucial here.
2540 * If group != NULL, child_func is meaningless */
2541 #if ENABLE_HUSH_FUNCTIONS
2542 else if (command->child_func) {
2543 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
2544 command->child_func->parent_cmd = NULL;
2548 free(command->group_as_string);
2549 command->group_as_string = NULL;
2551 for (r = command->redirects; r; r = rnext) {
2552 debug_printf_clean(" redirect %d%s",
2553 r->rd_fd, redir_table[r->rd_type].descrip);
2554 /* guard against the case >$FOO, where foo is unset or blank */
2555 if (r->rd_filename) {
2556 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
2557 free(r->rd_filename);
2558 r->rd_filename = NULL;
2560 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
2564 command->redirects = NULL;
2566 free(pi->cmds); /* children are an array, they get freed all at once */
2574 static void free_pipe_list(struct pipe *head)
2576 struct pipe *pi, *next;
2578 for (pi = head; pi; pi = next) {
2580 debug_printf_clean(" pipe reserved word %d\n", pi->res_word);
2583 debug_printf_clean("pipe followup code %d\n", pi->followup);
2585 /*pi->next = NULL;*/
2591 /*** Parsing routines ***/
2593 static struct pipe *new_pipe(void)
2596 pi = xzalloc(sizeof(struct pipe));
2597 /*pi->followup = 0; - deliberately invalid value */
2598 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
2602 /* Command (member of a pipe) is complete, or we start a new pipe
2603 * if ctx->command is NULL.
2604 * No errors possible here.
2606 static int done_command(struct parse_context *ctx)
2608 /* The command is really already in the pipe structure, so
2609 * advance the pipe counter and make a new, null command. */
2610 struct pipe *pi = ctx->pipe;
2611 struct command *command = ctx->command;
2614 if (IS_NULL_CMD(command)) {
2615 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
2619 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
2620 //debug_print_tree(ctx->list_head, 20);
2622 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
2625 /* Only real trickiness here is that the uncommitted
2626 * command structure is not counted in pi->num_cmds. */
2627 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
2628 ctx->command = command = &pi->cmds[pi->num_cmds];
2630 memset(command, 0, sizeof(*command));
2631 return pi->num_cmds; /* used only for 0/nonzero check */
2634 static void done_pipe(struct parse_context *ctx, pipe_style type)
2638 debug_printf_parse("done_pipe entered, followup %d\n", type);
2639 /* Close previous command */
2640 not_null = done_command(ctx);
2641 ctx->pipe->followup = type;
2643 ctx->pipe->pi_inverted = ctx->ctx_inverted;
2644 ctx->ctx_inverted = 0;
2645 ctx->pipe->res_word = ctx->ctx_res_w;
2648 /* Without this check, even just <enter> on command line generates
2649 * tree of three NOPs (!). Which is harmless but annoying.
2650 * IOW: it is safe to do it unconditionally. */
2653 || ctx->ctx_res_w == RES_FI
2655 #if ENABLE_HUSH_LOOPS
2656 || ctx->ctx_res_w == RES_DONE
2657 || ctx->ctx_res_w == RES_FOR
2658 || ctx->ctx_res_w == RES_IN
2660 #if ENABLE_HUSH_CASE
2661 || ctx->ctx_res_w == RES_ESAC
2665 debug_printf_parse("done_pipe: adding new pipe: "
2666 "not_null:%d ctx->ctx_res_w:%d\n",
2667 not_null, ctx->ctx_res_w);
2669 ctx->pipe->next = new_p;
2671 /* RES_THEN, RES_DO etc are "sticky" -
2672 * they remain set for pipes inside if/while.
2673 * This is used to control execution.
2674 * RES_FOR and RES_IN are NOT sticky (needed to support
2675 * cases where variable or value happens to match a keyword):
2677 #if ENABLE_HUSH_LOOPS
2678 if (ctx->ctx_res_w == RES_FOR
2679 || ctx->ctx_res_w == RES_IN)
2680 ctx->ctx_res_w = RES_NONE;
2682 #if ENABLE_HUSH_CASE
2683 if (ctx->ctx_res_w == RES_MATCH)
2684 ctx->ctx_res_w = RES_CASE_BODY;
2685 if (ctx->ctx_res_w == RES_CASE)
2686 ctx->ctx_res_w = RES_CASE_IN;
2688 ctx->command = NULL; /* trick done_command below */
2689 /* Create the memory for command, roughly:
2690 * ctx->pipe->cmds = new struct command;
2691 * ctx->command = &ctx->pipe->cmds[0];
2694 //debug_print_tree(ctx->list_head, 10);
2696 debug_printf_parse("done_pipe return\n");
2699 static void initialize_context(struct parse_context *ctx)
2701 memset(ctx, 0, sizeof(*ctx));
2702 ctx->pipe = ctx->list_head = new_pipe();
2703 /* Create the memory for command, roughly:
2704 * ctx->pipe->cmds = new struct command;
2705 * ctx->command = &ctx->pipe->cmds[0];
2710 /* If a reserved word is found and processed, parse context is modified
2711 * and 1 is returned.
2714 struct reserved_combo {
2717 unsigned char assignment_flag;
2721 FLAG_END = (1 << RES_NONE ),
2723 FLAG_IF = (1 << RES_IF ),
2724 FLAG_THEN = (1 << RES_THEN ),
2725 FLAG_ELIF = (1 << RES_ELIF ),
2726 FLAG_ELSE = (1 << RES_ELSE ),
2727 FLAG_FI = (1 << RES_FI ),
2729 # if ENABLE_HUSH_LOOPS
2730 FLAG_FOR = (1 << RES_FOR ),
2731 FLAG_WHILE = (1 << RES_WHILE),
2732 FLAG_UNTIL = (1 << RES_UNTIL),
2733 FLAG_DO = (1 << RES_DO ),
2734 FLAG_DONE = (1 << RES_DONE ),
2735 FLAG_IN = (1 << RES_IN ),
2737 # if ENABLE_HUSH_CASE
2738 FLAG_MATCH = (1 << RES_MATCH),
2739 FLAG_ESAC = (1 << RES_ESAC ),
2741 FLAG_START = (1 << RES_XXXX ),
2744 static const struct reserved_combo* match_reserved_word(o_string *word)
2746 /* Mostly a list of accepted follow-up reserved words.
2747 * FLAG_END means we are done with the sequence, and are ready
2748 * to turn the compound list into a command.
2749 * FLAG_START means the word must start a new compound list.
2751 static const struct reserved_combo reserved_list[] = {
2753 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
2754 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
2755 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
2756 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
2757 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
2758 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
2760 # if ENABLE_HUSH_LOOPS
2761 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
2762 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
2763 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
2764 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
2765 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
2766 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
2768 # if ENABLE_HUSH_CASE
2769 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
2770 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
2773 const struct reserved_combo *r;
2775 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
2776 if (strcmp(word->data, r->literal) == 0)
2781 /* Return 0: not a keyword, 1: keyword
2783 static int reserved_word(o_string *word, struct parse_context *ctx)
2785 # if ENABLE_HUSH_CASE
2786 static const struct reserved_combo reserved_match = {
2787 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
2790 const struct reserved_combo *r;
2792 if (word->has_quoted_part)
2794 r = match_reserved_word(word);
2798 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
2799 # if ENABLE_HUSH_CASE
2800 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
2801 /* "case word IN ..." - IN part starts first MATCH part */
2802 r = &reserved_match;
2805 if (r->flag == 0) { /* '!' */
2806 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
2807 syntax_error("! ! command");
2808 ctx->ctx_res_w = RES_SNTX;
2810 ctx->ctx_inverted = 1;
2813 if (r->flag & FLAG_START) {
2814 struct parse_context *old;
2816 old = xmalloc(sizeof(*old));
2817 debug_printf_parse("push stack %p\n", old);
2818 *old = *ctx; /* physical copy */
2819 initialize_context(ctx);
2821 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
2822 syntax_error_at(word->data);
2823 ctx->ctx_res_w = RES_SNTX;
2826 /* "{...} fi" is ok. "{...} if" is not
2828 * if { echo foo; } then { echo bar; } fi */
2829 if (ctx->command->group)
2830 done_pipe(ctx, PIPE_SEQ);
2833 ctx->ctx_res_w = r->res;
2834 ctx->old_flag = r->flag;
2835 word->o_assignment = r->assignment_flag;
2837 if (ctx->old_flag & FLAG_END) {
2838 struct parse_context *old;
2840 done_pipe(ctx, PIPE_SEQ);
2841 debug_printf_parse("pop stack %p\n", ctx->stack);
2843 old->command->group = ctx->list_head;
2844 old->command->cmd_type = CMD_NORMAL;
2846 o_addstr(&old->as_string, ctx->as_string.data);
2847 o_free_unsafe(&ctx->as_string);
2848 old->command->group_as_string = xstrdup(old->as_string.data);
2849 debug_printf_parse("pop, remembering as:'%s'\n",
2850 old->command->group_as_string);
2852 *ctx = *old; /* physical copy */
2857 #endif /* HAS_KEYWORDS */
2859 /* Word is complete, look at it and update parsing context.
2860 * Normal return is 0. Syntax errors return 1.
2861 * Note: on return, word is reset, but not o_free'd!
2863 static int done_word(o_string *word, struct parse_context *ctx)
2865 struct command *command = ctx->command;
2867 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
2868 if (word->length == 0 && !word->has_quoted_part) {
2869 debug_printf_parse("done_word return 0: true null, ignored\n");
2873 if (ctx->pending_redirect) {
2874 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
2875 * only if run as "bash", not "sh" */
2876 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
2878 * ...the word that follows the redirection operator
2879 * shall be subjected to tilde expansion, parameter expansion,
2880 * command substitution, arithmetic expansion, and quote
2881 * removal. Pathname expansion shall not be performed
2882 * on the word by a non-interactive shell; an interactive
2883 * shell may perform it, but shall do so only when
2884 * the expansion would result in one word."
2886 ctx->pending_redirect->rd_filename = xstrdup(word->data);
2887 /* Cater for >\file case:
2888 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
2889 * Same with heredocs:
2890 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
2892 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
2893 unbackslash(ctx->pending_redirect->rd_filename);
2894 /* Is it <<"HEREDOC"? */
2895 if (word->has_quoted_part) {
2896 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
2899 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
2900 ctx->pending_redirect = NULL;
2902 /* If this word wasn't an assignment, next ones definitely
2903 * can't be assignments. Even if they look like ones. */
2904 if (word->o_assignment != DEFINITELY_ASSIGNMENT
2905 && word->o_assignment != WORD_IS_KEYWORD
2907 word->o_assignment = NOT_ASSIGNMENT;
2909 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
2910 command->assignment_cnt++;
2911 word->o_assignment = MAYBE_ASSIGNMENT;
2915 # if ENABLE_HUSH_CASE
2916 if (ctx->ctx_dsemicolon
2917 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
2919 /* already done when ctx_dsemicolon was set to 1: */
2920 /* ctx->ctx_res_w = RES_MATCH; */
2921 ctx->ctx_dsemicolon = 0;
2924 if (!command->argv /* if it's the first word... */
2925 # if ENABLE_HUSH_LOOPS
2926 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
2927 && ctx->ctx_res_w != RES_IN
2929 # if ENABLE_HUSH_CASE
2930 && ctx->ctx_res_w != RES_CASE
2933 debug_printf_parse("checking '%s' for reserved-ness\n", word->data);
2934 if (reserved_word(word, ctx)) {
2935 o_reset_to_empty_unquoted(word);
2936 debug_printf_parse("done_word return %d\n",
2937 (ctx->ctx_res_w == RES_SNTX));
2938 return (ctx->ctx_res_w == RES_SNTX);
2940 # if ENABLE_HUSH_BASH_COMPAT
2941 if (strcmp(word->data, "[[") == 0) {
2942 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
2948 if (command->group) {
2949 /* "{ echo foo; } echo bar" - bad */
2950 syntax_error_at(word->data);
2951 debug_printf_parse("done_word return 1: syntax error, "
2952 "groups and arglists don't mix\n");
2955 if (word->has_quoted_part
2956 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
2957 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
2958 /* (otherwise it's known to be not empty and is already safe) */
2960 /* exclude "$@" - it can expand to no word despite "" */
2961 char *p = word->data;
2962 while (p[0] == SPECIAL_VAR_SYMBOL
2963 && (p[1] & 0x7f) == '@'
2964 && p[2] == SPECIAL_VAR_SYMBOL
2968 if (p == word->data || p[0] != '\0') {
2969 /* saw no "$@", or not only "$@" but some
2970 * real text is there too */
2971 /* insert "empty variable" reference, this makes
2972 * e.g. "", $empty"" etc to not disappear */
2973 o_addchr(word, SPECIAL_VAR_SYMBOL);
2974 o_addchr(word, SPECIAL_VAR_SYMBOL);
2977 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
2978 debug_print_strings("word appended to argv", command->argv);
2981 #if ENABLE_HUSH_LOOPS
2982 if (ctx->ctx_res_w == RES_FOR) {
2983 if (word->has_quoted_part
2984 || !is_well_formed_var_name(command->argv[0], '\0')
2986 /* bash says just "not a valid identifier" */
2987 syntax_error("not a valid identifier in for");
2990 /* Force FOR to have just one word (variable name) */
2991 /* NB: basically, this makes hush see "for v in ..."
2992 * syntax as if it is "for v; in ...". FOR and IN become
2993 * two pipe structs in parse tree. */
2994 done_pipe(ctx, PIPE_SEQ);
2997 #if ENABLE_HUSH_CASE
2998 /* Force CASE to have just one word */
2999 if (ctx->ctx_res_w == RES_CASE) {
3000 done_pipe(ctx, PIPE_SEQ);
3004 o_reset_to_empty_unquoted(word);
3006 debug_printf_parse("done_word return 0\n");
3011 /* Peek ahead in the input to find out if we have a "&n" construct,
3012 * as in "2>&1", that represents duplicating a file descriptor.
3014 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
3015 * REDIRFD_SYNTAX_ERR if syntax error,
3016 * REDIRFD_TO_FILE if no & was seen,
3017 * or the number found.
3020 #define parse_redir_right_fd(as_string, input) \
3021 parse_redir_right_fd(input)
3023 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
3029 return REDIRFD_TO_FILE;
3031 ch = i_getch(input); /* get the & */
3032 nommu_addchr(as_string, ch);
3035 ch = i_getch(input);
3036 nommu_addchr(as_string, ch);
3037 return REDIRFD_CLOSE;
3041 while (ch != EOF && isdigit(ch)) {
3042 d = d*10 + (ch-'0');
3044 ch = i_getch(input);
3045 nommu_addchr(as_string, ch);
3050 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
3052 bb_error_msg("ambiguous redirect");
3053 return REDIRFD_SYNTAX_ERR;
3056 /* Return code is 0 normal, 1 if a syntax error is detected
3058 static int parse_redirect(struct parse_context *ctx,
3061 struct in_str *input)
3063 struct command *command = ctx->command;
3064 struct redir_struct *redir;
3065 struct redir_struct **redirp;
3068 dup_num = REDIRFD_TO_FILE;
3069 if (style != REDIRECT_HEREDOC) {
3070 /* Check for a '>&1' type redirect */
3071 dup_num = parse_redir_right_fd(&ctx->as_string, input);
3072 if (dup_num == REDIRFD_SYNTAX_ERR)
3075 int ch = i_peek(input);
3076 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
3077 if (dup_num) { /* <<-... */
3078 ch = i_getch(input);
3079 nommu_addchr(&ctx->as_string, ch);
3084 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
3085 int ch = i_peek(input);
3087 /* >|FILE redirect ("clobbering" >).
3088 * Since we do not support "set -o noclobber" yet,
3089 * >| and > are the same for now. Just eat |.
3091 ch = i_getch(input);
3092 nommu_addchr(&ctx->as_string, ch);
3096 /* Create a new redir_struct and append it to the linked list */
3097 redirp = &command->redirects;
3098 while ((redir = *redirp) != NULL) {
3099 redirp = &(redir->next);
3101 *redirp = redir = xzalloc(sizeof(*redir));
3102 /* redir->next = NULL; */
3103 /* redir->rd_filename = NULL; */
3104 redir->rd_type = style;
3105 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
3107 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
3108 redir_table[style].descrip);
3110 redir->rd_dup = dup_num;
3111 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
3112 /* Erik had a check here that the file descriptor in question
3113 * is legit; I postpone that to "run time"
3114 * A "-" representation of "close me" shows up as a -3 here */
3115 debug_printf_parse("duplicating redirect '%d>&%d'\n",
3116 redir->rd_fd, redir->rd_dup);
3118 /* Set ctx->pending_redirect, so we know what to do at the
3119 * end of the next parsed word. */
3120 ctx->pending_redirect = redir;
3125 /* If a redirect is immediately preceded by a number, that number is
3126 * supposed to tell which file descriptor to redirect. This routine
3127 * looks for such preceding numbers. In an ideal world this routine
3128 * needs to handle all the following classes of redirects...
3129 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3130 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3131 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3132 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3134 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3136 * ... If n is quoted, the number shall not be recognized as part of
3137 * the redirection expression. For example:
3139 * writes the character 2 into file a"
3140 * We are getting it right by setting ->has_quoted_part on any \<char>
3142 * A -1 return means no valid number was found,
3143 * the caller should use the appropriate default for this redirection.
3145 static int redirect_opt_num(o_string *o)
3149 if (o->data == NULL)
3151 num = bb_strtou(o->data, NULL, 10);
3152 if (errno || num < 0)
3154 o_reset_to_empty_unquoted(o);
3159 #define fetch_till_str(as_string, input, word, skip_tabs) \
3160 fetch_till_str(input, word, skip_tabs)
3162 static char *fetch_till_str(o_string *as_string,
3163 struct in_str *input,
3167 o_string heredoc = NULL_O_STRING;
3169 int prev = 0; /* not \ */
3174 ch = i_getch(input);
3175 nommu_addchr(as_string, ch);
3177 && ((heredoc_flags & HEREDOC_QUOTED) || prev != '\\')
3179 if (strcmp(heredoc.data + past_EOL, word) == 0) {
3180 heredoc.data[past_EOL] = '\0';
3181 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
3182 return heredoc.data;
3185 o_addchr(&heredoc, ch);
3186 past_EOL = heredoc.length;
3189 ch = i_getch(input);
3190 nommu_addchr(as_string, ch);
3191 } while ((heredoc_flags & HEREDOC_SKIPTABS) && ch == '\t');
3192 } while (ch == '\n');
3195 o_free_unsafe(&heredoc);
3198 o_addchr(&heredoc, ch);
3199 nommu_addchr(as_string, ch);
3204 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
3205 * and load them all. There should be exactly heredoc_cnt of them.
3207 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
3209 struct pipe *pi = ctx->list_head;
3211 while (pi && heredoc_cnt) {
3213 struct command *cmd = pi->cmds;
3215 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
3217 cmd->argv ? cmd->argv[0] : "NONE");
3218 for (i = 0; i < pi->num_cmds; i++) {
3219 struct redir_struct *redir = cmd->redirects;
3221 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
3222 i, cmd->argv ? cmd->argv[0] : "NONE");
3224 if (redir->rd_type == REDIRECT_HEREDOC) {
3227 redir->rd_type = REDIRECT_HEREDOC2;
3228 /* redir->rd_dup is (ab)used to indicate <<- */
3229 p = fetch_till_str(&ctx->as_string, input,
3230 redir->rd_filename, redir->rd_dup);
3232 syntax_error("unexpected EOF in here document");
3235 free(redir->rd_filename);
3236 redir->rd_filename = p;
3239 redir = redir->next;
3246 /* Should be 0. If it isn't, it's a parse error */
3248 bb_error_msg_and_die("heredoc BUG 2");
3254 static int run_list(struct pipe *pi);
3256 #define parse_stream(pstring, input, end_trigger) \
3257 parse_stream(input, end_trigger)
3259 static struct pipe *parse_stream(char **pstring,
3260 struct in_str *input,
3264 #if !ENABLE_HUSH_FUNCTIONS
3265 #define parse_group(dest, ctx, input, ch) \
3266 parse_group(ctx, input, ch)
3268 static int parse_group(o_string *dest, struct parse_context *ctx,
3269 struct in_str *input, int ch)
3271 /* dest contains characters seen prior to ( or {.
3272 * Typically it's empty, but for function defs,
3273 * it contains function name (without '()'). */
3274 struct pipe *pipe_list;
3276 struct command *command = ctx->command;
3278 debug_printf_parse("parse_group entered\n");
3279 #if ENABLE_HUSH_FUNCTIONS
3280 if (ch == '(' && !dest->has_quoted_part) {
3282 if (done_word(dest, ctx))
3285 goto skip; /* (... */
3286 if (command->argv[1]) { /* word word ... (... */
3287 syntax_error_unexpected_ch('(');
3290 /* it is "word(..." or "word (..." */
3292 ch = i_getch(input);
3293 while (ch == ' ' || ch == '\t');
3295 syntax_error_unexpected_ch(ch);
3298 nommu_addchr(&ctx->as_string, ch);
3300 ch = i_getch(input);
3301 while (ch == ' ' || ch == '\t' || ch == '\n');
3303 syntax_error_unexpected_ch(ch);
3306 nommu_addchr(&ctx->as_string, ch);
3307 command->cmd_type = CMD_FUNCDEF;
3312 #if 0 /* Prevented by caller */
3313 if (command->argv /* word [word]{... */
3314 || dest->length /* word{... */
3315 || dest->has_quoted_part /* ""{... */
3318 debug_printf_parse("parse_group return 1: "
3319 "syntax error, groups and arglists don't mix\n");
3324 #if ENABLE_HUSH_FUNCTIONS
3330 command->cmd_type = CMD_SUBSHELL;
3332 /* bash does not allow "{echo...", requires whitespace */
3333 ch = i_getch(input);
3334 if (ch != ' ' && ch != '\t' && ch != '\n') {
3335 syntax_error_unexpected_ch(ch);
3338 nommu_addchr(&ctx->as_string, ch);
3343 # define as_string NULL
3345 char *as_string = NULL;
3347 pipe_list = parse_stream(&as_string, input, endch);
3350 o_addstr(&ctx->as_string, as_string);
3352 /* empty ()/{} or parse error? */
3353 if (!pipe_list || pipe_list == ERR_PTR) {
3354 /* parse_stream already emitted error msg */
3357 debug_printf_parse("parse_group return 1: "
3358 "parse_stream returned %p\n", pipe_list);
3361 command->group = pipe_list;
3363 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
3364 command->group_as_string = as_string;
3365 debug_printf_parse("end of group, remembering as:'%s'\n",
3366 command->group_as_string);
3370 debug_printf_parse("parse_group return 0\n");
3372 /* command remains "open", available for possible redirects */
3375 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS
3376 /* Subroutines for copying $(...) and `...` things */
3377 static void add_till_backquote(o_string *dest, struct in_str *input);
3379 static void add_till_single_quote(o_string *dest, struct in_str *input)
3382 int ch = i_getch(input);
3384 syntax_error_unterm_ch('\'');
3385 /*xfunc_die(); - redundant */
3392 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
3393 static void add_till_double_quote(o_string *dest, struct in_str *input)
3396 int ch = i_getch(input);
3398 syntax_error_unterm_ch('"');
3399 /*xfunc_die(); - redundant */
3403 if (ch == '\\') { /* \x. Copy both chars. */
3405 ch = i_getch(input);
3409 add_till_backquote(dest, input);
3413 //if (ch == '$') ...
3416 /* Process `cmd` - copy contents until "`" is seen. Complicated by
3418 * "Within the backquoted style of command substitution, backslash
3419 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
3420 * The search for the matching backquote shall be satisfied by the first
3421 * backquote found without a preceding backslash; during this search,
3422 * if a non-escaped backquote is encountered within a shell comment,
3423 * a here-document, an embedded command substitution of the $(command)
3424 * form, or a quoted string, undefined results occur. A single-quoted
3425 * or double-quoted string that begins, but does not end, within the
3426 * "`...`" sequence produces undefined results."
3428 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
3430 static void add_till_backquote(o_string *dest, struct in_str *input)
3433 int ch = i_getch(input);
3435 syntax_error_unterm_ch('`');
3436 /*xfunc_die(); - redundant */
3441 /* \x. Copy both chars unless it is \` */
3442 int ch2 = i_getch(input);
3444 syntax_error_unterm_ch('`');
3445 /*xfunc_die(); - redundant */
3447 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
3454 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
3455 * quoting and nested ()s.
3456 * "With the $(command) style of command substitution, all characters
3457 * following the open parenthesis to the matching closing parenthesis
3458 * constitute the command. Any valid shell script can be used for command,
3459 * except a script consisting solely of redirections which produces
3460 * unspecified results."
3462 * echo $(echo '(TEST)' BEST) (TEST) BEST
3463 * echo $(echo 'TEST)' BEST) TEST) BEST
3464 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
3466 * Also adapted to eat ${var%...} and $((...)) constructs, since ... part
3467 * can contain arbitrary constructs, just like $(cmd).
3468 * In bash compat mode, it needs to also be able to stop on ':' or '/'
3469 * for ${var:N[:M]} and ${var/P[/R]} parsing.
3471 #define DOUBLE_CLOSE_CHAR_FLAG 0x80
3472 static int add_till_closing_bracket(o_string *dest, struct in_str *input, unsigned end_ch)
3475 char dbl = end_ch & DOUBLE_CLOSE_CHAR_FLAG;
3476 # if ENABLE_HUSH_BASH_COMPAT
3477 char end_char2 = end_ch >> 8;
3479 end_ch &= (DOUBLE_CLOSE_CHAR_FLAG - 1);
3482 ch = i_getch(input);
3484 syntax_error_unterm_ch(end_ch);
3485 /*xfunc_die(); - redundant */
3487 if (ch == end_ch IF_HUSH_BASH_COMPAT( || ch == end_char2)) {
3490 /* we look for closing )) of $((EXPR)) */
3491 if (i_peek(input) == end_ch) {
3492 i_getch(input); /* eat second ')' */
3497 if (ch == '(' || ch == '{') {
3498 ch = (ch == '(' ? ')' : '}');
3499 add_till_closing_bracket(dest, input, ch);
3504 add_till_single_quote(dest, input);
3509 add_till_double_quote(dest, input);
3514 add_till_backquote(dest, input);
3519 /* \x. Copy verbatim. Important for \(, \) */
3520 ch = i_getch(input);
3522 syntax_error_unterm_ch(')');
3523 /*xfunc_die(); - redundant */
3531 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_DOLLAR_OPS */
3533 /* Return code: 0 for OK, 1 for syntax error */
3535 #define parse_dollar(as_string, dest, input) \
3536 parse_dollar(dest, input)
3537 #define as_string NULL
3539 static int parse_dollar(o_string *as_string,
3541 struct in_str *input)
3543 int ch = i_peek(input); /* first character after the $ */
3544 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
3546 debug_printf_parse("parse_dollar entered: ch='%c'\n", ch);
3548 ch = i_getch(input);
3549 nommu_addchr(as_string, ch);
3551 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3553 debug_printf_parse(": '%c'\n", ch);
3554 o_addchr(dest, ch | quote_mask);
3557 if (!isalnum(ch) && ch != '_')
3559 ch = i_getch(input);
3560 nommu_addchr(as_string, ch);
3562 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3563 } else if (isdigit(ch)) {
3565 ch = i_getch(input);
3566 nommu_addchr(as_string, ch);
3567 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3568 debug_printf_parse(": '%c'\n", ch);
3569 o_addchr(dest, ch | quote_mask);
3570 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3571 } else switch (ch) {
3573 case '!': /* last bg pid */
3574 case '?': /* last exit code */
3575 case '#': /* number of args */
3576 case '*': /* args */
3577 case '@': /* args */
3578 goto make_one_char_var;
3580 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3582 ch = i_getch(input); /* eat '{' */
3583 nommu_addchr(as_string, ch);
3585 ch = i_getch(input); /* first char after '{' */
3586 nommu_addchr(as_string, ch);
3587 /* It should be ${?}, or ${#var},
3588 * or even ${?+subst} - operator acting on a special variable,
3589 * or the beginning of variable name.
3591 if (!strchr(_SPECIAL_VARS_STR, ch) && !isalnum(ch)) { /* not one of those */
3593 syntax_error_unterm_str("${name}");
3594 debug_printf_parse("parse_dollar return 1: unterminated ${name}\n");
3599 /* It's possible to just call add_till_closing_bracket() at this point.
3600 * However, this regresses some of our testsuite cases
3601 * which check invalid constructs like ${%}.
3602 * Oh well... let's check that the var name part is fine... */
3608 debug_printf_parse(": '%c'\n", ch);
3610 ch = i_getch(input);
3611 nommu_addchr(as_string, ch);
3615 if (!isalnum(ch) && ch != '_') {
3617 unsigned char last_ch;
3618 /* handle parameter expansions
3619 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
3621 if (!strchr(VAR_SUBST_OPS, ch)) /* ${var<bad_char>... */
3622 goto bad_dollar_syntax;
3624 /* Eat everything until closing '}' (or ':') */
3626 if (ENABLE_HUSH_BASH_COMPAT
3628 && !strchr(MINUS_PLUS_EQUAL_QUESTION, i_peek(input))
3630 /* It's ${var:N[:M]} thing */
3631 end_ch = '}' * 0x100 + ':';
3633 if (ENABLE_HUSH_BASH_COMPAT
3636 /* It's ${var/[/]pattern[/repl]} thing */
3637 if (i_peek(input) == '/') { /* ${var//pattern[/repl]}? */
3639 nommu_addchr(as_string, '/');
3642 end_ch = '}' * 0x100 + '/';
3648 #if ENABLE_HUSH_DOLLAR_OPS
3649 last_ch = add_till_closing_bracket(dest, input, end_ch);
3651 #error Simple code to only allow ${var} is not implemented
3654 o_addstr(as_string, dest->data + pos);
3655 o_addchr(as_string, last_ch);
3658 if (ENABLE_HUSH_BASH_COMPAT && (end_ch & 0xff00)) {
3659 /* close the first block: */
3660 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3661 /* while parsing N from ${var:N[:M]}
3662 * or pattern from ${var/[/]pattern[/repl]} */
3663 if ((end_ch & 0xff) == last_ch) {
3664 /* got ':' or '/'- parse the rest */
3669 if (end_ch == '}' * 0x100 + ':') {
3670 /* it's ${var:N} - emulate :999999999 */
3671 o_addstr(dest, "999999999");
3672 } /* else: it's ${var/[/]pattern} */
3677 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3680 #if ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK
3684 ch = i_getch(input);
3685 nommu_addchr(as_string, ch);
3686 # if ENABLE_SH_MATH_SUPPORT
3687 if (i_peek(input) == '(') {
3688 ch = i_getch(input);
3689 nommu_addchr(as_string, ch);
3690 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3691 o_addchr(dest, /*quote_mask |*/ '+');
3694 add_till_closing_bracket(dest, input, ')' | DOUBLE_CLOSE_CHAR_FLAG);
3696 o_addstr(as_string, dest->data + pos);
3697 o_addchr(as_string, ')');
3698 o_addchr(as_string, ')');
3700 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3704 # if ENABLE_HUSH_TICK
3705 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3706 o_addchr(dest, quote_mask | '`');
3709 add_till_closing_bracket(dest, input, ')');
3711 o_addstr(as_string, dest->data + pos);
3712 o_addchr(as_string, ')');
3714 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3720 ch = i_getch(input);
3721 nommu_addchr(as_string, ch);
3723 if (isalnum(ch)) { /* it's $_name or $_123 */
3728 /* TODO: $_ and $-: */
3729 /* $_ Shell or shell script name; or last argument of last command
3730 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
3731 * but in command's env, set to full pathname used to invoke it */
3732 /* $- Option flags set by set builtin or shell options (-i etc) */
3734 o_addQchr(dest, '$');
3736 debug_printf_parse("parse_dollar return 0\n");
3742 #define parse_stream_dquoted(as_string, dest, input, dquote_end) \
3743 parse_stream_dquoted(dest, input, dquote_end)
3744 #define as_string NULL
3746 static int parse_stream_dquoted(o_string *as_string,
3748 struct in_str *input,
3755 ch = i_getch(input);
3757 nommu_addchr(as_string, ch);
3758 if (ch == dquote_end) { /* may be only '"' or EOF */
3759 if (dest->o_assignment == NOT_ASSIGNMENT)
3760 dest->o_escape ^= 1;
3761 debug_printf_parse("parse_stream_dquoted return 0\n");
3764 /* note: can't move it above ch == dquote_end check! */
3766 syntax_error_unterm_ch('"');
3767 /*xfunc_die(); - redundant */
3771 next = i_peek(input);
3773 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
3774 ch, ch, dest->o_escape);
3777 syntax_error("\\<eof>");
3781 * "The backslash retains its special meaning [in "..."]
3782 * only when followed by one of the following characters:
3783 * $, `, ", \, or <newline>. A double quote may be quoted
3784 * within double quotes by preceding it with a backslash."
3785 * NB: in (unquoted) heredoc, above does not apply to ".
3787 if (next == dquote_end || strchr("$`\\\n", next) != NULL) {
3788 ch = i_getch(input);
3790 o_addqchr(dest, ch);
3791 nommu_addchr(as_string, ch);
3794 o_addqchr(dest, '\\');
3795 nommu_addchr(as_string, '\\');
3800 if (parse_dollar(as_string, dest, input) != 0) {
3801 debug_printf_parse("parse_stream_dquoted return 1: "
3802 "parse_dollar returned non-0\n");
3807 #if ENABLE_HUSH_TICK
3809 //unsigned pos = dest->length;
3810 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3811 o_addchr(dest, 0x80 | '`');
3812 add_till_backquote(dest, input);
3813 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3814 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
3818 o_addQchr(dest, ch);
3820 && (dest->o_assignment == MAYBE_ASSIGNMENT
3821 || dest->o_assignment == WORD_IS_KEYWORD)
3822 && is_well_formed_var_name(dest->data, '=')
3824 dest->o_assignment = DEFINITELY_ASSIGNMENT;
3831 * Scan input until EOF or end_trigger char.
3832 * Return a list of pipes to execute, or NULL on EOF
3833 * or if end_trigger character is met.
3834 * On syntax error, exit is shell is not interactive,
3835 * reset parsing machinery and start parsing anew,
3836 * or return ERR_PTR.
3838 static struct pipe *parse_stream(char **pstring,
3839 struct in_str *input,
3842 struct parse_context ctx;
3843 o_string dest = NULL_O_STRING;
3847 /* Double-quote state is handled in the state variable is_in_dquote.
3848 * A single-quote triggers a bypass of the main loop until its mate is
3849 * found. When recursing, quote state is passed in via dest->o_escape.
3851 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
3852 end_trigger ? end_trigger : 'X');
3855 /* If very first arg is "" or '', dest.data may end up NULL.
3856 * Preventing this: */
3857 o_addchr(&dest, '\0');
3860 G.ifs = get_local_var_value("IFS");
3865 #if ENABLE_HUSH_INTERACTIVE
3866 input->promptmode = 0; /* PS1 */
3868 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
3869 initialize_context(&ctx);
3874 const char *is_special;
3878 redir_type redir_style;
3881 /* dest.has_quoted_part = 1; - already is (see below) */
3882 if (parse_stream_dquoted(&ctx.as_string, &dest, input, '"')) {
3885 /* We reached closing '"' */
3888 ch = i_getch(input);
3889 debug_printf_parse(": ch=%c (%d) escape=%d\n",
3890 ch, ch, dest.o_escape);
3895 syntax_error_unterm_str("here document");
3898 /* end_trigger == '}' case errors out earlier,
3899 * checking only ')' */
3900 if (end_trigger == ')') {
3901 syntax_error_unterm_ch('('); /* exits */
3902 /* goto parse_error; */
3905 if (done_word(&dest, &ctx)) {
3909 done_pipe(&ctx, PIPE_SEQ);
3911 /* If we got nothing... */
3912 /* (this makes bare "&" cmd a no-op.
3913 * bash says: "syntax error near unexpected token '&'") */
3914 if (pi->num_cmds == 0
3915 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
3921 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
3923 *pstring = ctx.as_string.data;
3925 o_free_unsafe(&ctx.as_string);
3928 debug_printf_parse("parse_stream return %p\n", pi);
3931 nommu_addchr(&ctx.as_string, ch);
3935 next = i_peek(input);
3937 is_special = "{}<>;&|()#'" /* special outside of "str" */
3938 "\\$\"" IF_HUSH_TICK("`"); /* always special */
3939 /* Are { and } special here? */
3940 if (ctx.command->argv /* word [word]{... - non-special */
3941 || dest.length /* word{... - non-special */
3942 || dest.has_quoted_part /* ""{... - non-special */
3943 || (next != ';' /* }; - special */
3944 && next != ')' /* }) - special */
3945 && next != '&' /* }& and }&& ... - special */
3946 && next != '|' /* }|| ... - special */
3947 && !strchr(G.ifs, next) /* {word - non-special */
3950 /* They are not special, skip "{}" */
3953 is_special = strchr(is_special, ch);
3954 is_ifs = strchr(G.ifs, ch);
3956 if (!is_special && !is_ifs) { /* ordinary char */
3958 o_addQchr(&dest, ch);
3959 if ((dest.o_assignment == MAYBE_ASSIGNMENT
3960 || dest.o_assignment == WORD_IS_KEYWORD)
3962 && is_well_formed_var_name(dest.data, '=')
3964 dest.o_assignment = DEFINITELY_ASSIGNMENT;
3970 if (done_word(&dest, &ctx)) {
3974 #if ENABLE_HUSH_CASE
3975 /* "case ... in <newline> word) ..." -
3976 * newlines are ignored (but ';' wouldn't be) */
3977 if (ctx.command->argv == NULL
3978 && ctx.ctx_res_w == RES_MATCH
3983 /* Treat newline as a command separator. */
3984 done_pipe(&ctx, PIPE_SEQ);
3985 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
3987 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
3992 dest.o_assignment = MAYBE_ASSIGNMENT;
3994 /* note: if (is_ifs) continue;
3995 * will still trigger for us */
3999 /* "cmd}" or "cmd }..." without semicolon or &:
4000 * } is an ordinary char in this case, even inside { cmd; }
4001 * Pathological example: { ""}; } should exec "}" cmd
4004 if (!IS_NULL_CMD(ctx.command) /* cmd } */
4005 || dest.length != 0 /* word} */
4006 || dest.has_quoted_part /* ""} */
4010 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
4011 goto skip_end_trigger;
4012 /* else: } does terminate a group */
4015 if (end_trigger && end_trigger == ch
4016 && (ch != ';' || heredoc_cnt == 0)
4017 #if ENABLE_HUSH_CASE
4019 || ctx.ctx_res_w != RES_MATCH
4020 || (!dest.has_quoted_part && strcmp(dest.data, "esac") == 0)
4025 /* This is technically valid:
4026 * { cat <<HERE; }; echo Ok
4030 * but we don't support this.
4031 * We require heredoc to be in enclosing {}/(),
4034 syntax_error_unterm_str("here document");
4037 if (done_word(&dest, &ctx)) {
4040 done_pipe(&ctx, PIPE_SEQ);
4041 dest.o_assignment = MAYBE_ASSIGNMENT;
4042 /* Do we sit outside of any if's, loops or case's? */
4044 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4048 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4050 *pstring = ctx.as_string.data;
4052 o_free_unsafe(&ctx.as_string);
4055 debug_printf_parse("parse_stream return %p: "
4056 "end_trigger char found\n",
4058 return ctx.list_head;
4065 /* Catch <, > before deciding whether this word is
4066 * an assignment. a=1 2>z b=2: b=2 is still assignment */
4069 redir_fd = redirect_opt_num(&dest);
4070 if (done_word(&dest, &ctx)) {
4073 redir_style = REDIRECT_OVERWRITE;
4075 redir_style = REDIRECT_APPEND;
4076 ch = i_getch(input);
4077 nommu_addchr(&ctx.as_string, ch);
4080 else if (next == '(') {
4081 syntax_error(">(process) not supported");
4085 if (parse_redirect(&ctx, redir_fd, redir_style, input))
4087 continue; /* back to top of while (1) */
4089 redir_fd = redirect_opt_num(&dest);
4090 if (done_word(&dest, &ctx)) {
4093 redir_style = REDIRECT_INPUT;
4095 redir_style = REDIRECT_HEREDOC;
4097 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
4098 ch = i_getch(input);
4099 nommu_addchr(&ctx.as_string, ch);
4100 } else if (next == '>') {
4101 redir_style = REDIRECT_IO;
4102 ch = i_getch(input);
4103 nommu_addchr(&ctx.as_string, ch);
4106 else if (next == '(') {
4107 syntax_error("<(process) not supported");
4111 if (parse_redirect(&ctx, redir_fd, redir_style, input))
4113 continue; /* back to top of while (1) */
4116 if (dest.o_assignment == MAYBE_ASSIGNMENT
4117 /* check that we are not in word in "a=1 2>word b=1": */
4118 && !ctx.pending_redirect
4120 /* ch is a special char and thus this word
4121 * cannot be an assignment */
4122 dest.o_assignment = NOT_ASSIGNMENT;
4125 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
4129 if (dest.length == 0) {
4132 if (ch == EOF || ch == '\n')
4135 /* note: we do not add it to &ctx.as_string */
4137 nommu_addchr(&ctx.as_string, '\n');
4139 o_addQchr(&dest, ch);
4144 syntax_error("\\<eof>");
4147 ch = i_getch(input);
4149 o_addchr(&dest, '\\');
4150 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
4151 o_addchr(&dest, ch);
4152 nommu_addchr(&ctx.as_string, ch);
4153 /* Example: echo Hello \2>file
4154 * we need to know that word 2 is quoted */
4155 dest.has_quoted_part = 1;
4159 /* It's "\<newline>". Remove trailing '\' from ctx.as_string */
4160 ctx.as_string.data[--ctx.as_string.length] = '\0';
4165 if (parse_dollar(&ctx.as_string, &dest, input) != 0) {
4166 debug_printf_parse("parse_stream parse error: "
4167 "parse_dollar returned non-0\n");
4172 dest.has_quoted_part = 1;
4174 ch = i_getch(input);
4176 syntax_error_unterm_ch('\'');
4177 /*xfunc_die(); - redundant */
4179 nommu_addchr(&ctx.as_string, ch);
4182 o_addqchr(&dest, ch);
4186 dest.has_quoted_part = 1;
4187 is_in_dquote ^= 1; /* invert */
4188 if (dest.o_assignment == NOT_ASSIGNMENT)
4191 #if ENABLE_HUSH_TICK
4195 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4196 o_addchr(&dest, '`');
4198 add_till_backquote(&dest, input);
4200 o_addstr(&ctx.as_string, dest.data + pos);
4201 o_addchr(&ctx.as_string, '`');
4203 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4204 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4209 #if ENABLE_HUSH_CASE
4212 if (done_word(&dest, &ctx)) {
4215 done_pipe(&ctx, PIPE_SEQ);
4216 #if ENABLE_HUSH_CASE
4217 /* Eat multiple semicolons, detect
4218 * whether it means something special */
4223 ch = i_getch(input);
4224 nommu_addchr(&ctx.as_string, ch);
4225 if (ctx.ctx_res_w == RES_CASE_BODY) {
4226 ctx.ctx_dsemicolon = 1;
4227 ctx.ctx_res_w = RES_MATCH;
4233 /* We just finished a cmd. New one may start
4234 * with an assignment */
4235 dest.o_assignment = MAYBE_ASSIGNMENT;
4238 if (done_word(&dest, &ctx)) {
4242 ch = i_getch(input);
4243 nommu_addchr(&ctx.as_string, ch);
4244 done_pipe(&ctx, PIPE_AND);
4246 done_pipe(&ctx, PIPE_BG);
4250 if (done_word(&dest, &ctx)) {
4253 #if ENABLE_HUSH_CASE
4254 if (ctx.ctx_res_w == RES_MATCH)
4255 break; /* we are in case's "word | word)" */
4257 if (next == '|') { /* || */
4258 ch = i_getch(input);
4259 nommu_addchr(&ctx.as_string, ch);
4260 done_pipe(&ctx, PIPE_OR);
4262 /* we could pick up a file descriptor choice here
4263 * with redirect_opt_num(), but bash doesn't do it.
4264 * "echo foo 2| cat" yields "foo 2". */
4267 o_reset_to_empty_unquoted(&ctx.as_string);
4272 #if ENABLE_HUSH_CASE
4273 /* "case... in [(]word)..." - skip '(' */
4274 if (ctx.ctx_res_w == RES_MATCH
4275 && ctx.command->argv == NULL /* not (word|(... */
4276 && dest.length == 0 /* not word(... */
4277 && dest.has_quoted_part == 0 /* not ""(... */
4283 if (parse_group(&dest, &ctx, input, ch) != 0) {
4288 #if ENABLE_HUSH_CASE
4289 if (ctx.ctx_res_w == RES_MATCH)
4293 /* proper use of this character is caught by end_trigger:
4294 * if we see {, we call parse_group(..., end_trigger='}')
4295 * and it will match } earlier (not here). */
4296 syntax_error_unexpected_ch(ch);
4300 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4306 struct parse_context *pctx;
4307 IF_HAS_KEYWORDS(struct parse_context *p2;)
4309 /* Clean up allocated tree.
4310 * Sample for finding leaks on syntax error recovery path.
4311 * Run it from interactive shell, watch pmap `pidof hush`.
4312 * while if false; then false; fi; do break; fi
4313 * Samples to catch leaks at execution:
4314 * while if (true | {true;}); then echo ok; fi; do break; done
4315 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
4319 /* Update pipe/command counts,
4320 * otherwise freeing may miss some */
4321 done_pipe(pctx, PIPE_SEQ);
4322 debug_printf_clean("freeing list %p from ctx %p\n",
4323 pctx->list_head, pctx);
4324 debug_print_tree(pctx->list_head, 0);
4325 free_pipe_list(pctx->list_head);
4326 debug_printf_clean("freed list %p\n", pctx->list_head);
4328 o_free_unsafe(&pctx->as_string);
4330 IF_HAS_KEYWORDS(p2 = pctx->stack;)
4334 IF_HAS_KEYWORDS(pctx = p2;)
4335 } while (HAS_KEYWORDS && pctx);
4336 /* Free text, clear all dest fields */
4338 /* If we are not in top-level parse, we return,
4339 * our caller will propagate error.
4341 if (end_trigger != ';') {
4349 /* Discard cached input, force prompt */
4351 IF_HUSH_INTERACTIVE(input->promptme = 1;)
4357 /*** Execution routines ***/
4359 /* Expansion can recurse, need forward decls: */
4360 static char *expand_string_to_string(const char *str);
4361 static int process_command_subs(o_string *dest, const char *s);
4363 /* expand_strvec_to_strvec() takes a list of strings, expands
4364 * all variable references within and returns a pointer to
4365 * a list of expanded strings, possibly with larger number
4366 * of strings. (Think VAR="a b"; echo $VAR).
4367 * This new list is allocated as a single malloc block.
4368 * NULL-terminated list of char* pointers is at the beginning of it,
4369 * followed by strings themself.
4370 * Caller can deallocate entire list by single free(list). */
4372 /* Store given string, finalizing the word and starting new one whenever
4373 * we encounter IFS char(s). This is used for expanding variable values.
4374 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
4375 static int expand_on_ifs(o_string *output, int n, const char *str)
4378 int word_len = strcspn(str, G.ifs);
4380 if (output->o_escape)
4381 o_addqblock(output, str, word_len);
4382 else if (!output->o_glob)
4383 o_addblock(output, str, word_len);
4384 else /* if (!escape && glob) */ {
4385 /* Protect backslashes against globbing up :)
4386 * Example: "v='\*'; echo b$v"
4388 o_addblock_duplicate_backslash(output, str, word_len);
4389 /*/ Why can't we do it easier? */
4390 /*o_addblock(output, str, word_len); - WRONG: "v='\*'; echo Z$v" prints "Z*" instead of "Z\*" */
4391 /*o_addqblock(output, str, word_len); - WRONG: "v='*'; echo Z$v" prints "Z*" instead of Z* files */
4395 if (!*str) /* EOL - do not finalize word */
4397 o_addchr(output, '\0');
4398 debug_print_list("expand_on_ifs", output, n);
4399 n = o_save_ptr(output, n);
4400 str += strspn(str, G.ifs); /* skip ifs chars */
4402 debug_print_list("expand_on_ifs[1]", output, n);
4406 /* Helper to expand $((...)) and heredoc body. These act as if
4407 * they are in double quotes, with the exception that they are not :).
4408 * Just the rules are similar: "expand only $var and `cmd`"
4410 * Returns malloced string.
4411 * As an optimization, we return NULL if expansion is not needed.
4413 static char *expand_pseudo_dquoted(const char *str)
4416 struct in_str input;
4417 o_string dest = NULL_O_STRING;
4419 if (!strchr(str, '$')
4420 && !strchr(str, '\\')
4421 #if ENABLE_HUSH_TICK
4422 && !strchr(str, '`')
4428 /* We need to expand. Example:
4429 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
4431 setup_string_in_str(&input, str);
4432 parse_stream_dquoted(NULL, &dest, &input, EOF);
4433 //bb_error_msg("'%s' -> '%s'", str, dest.data);
4434 exp_str = expand_string_to_string(dest.data);
4435 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
4436 o_free_unsafe(&dest);
4440 #if ENABLE_SH_MATH_SUPPORT
4441 static arith_t expand_and_evaluate_arith(const char *arg, int *errcode_p)
4443 arith_eval_hooks_t hooks;
4447 hooks.lookupvar = get_local_var_value;
4448 hooks.setvar = set_local_var_from_halves;
4449 hooks.endofname = endofname;
4450 exp_str = expand_pseudo_dquoted(arg);
4451 res = arith(exp_str ? exp_str : arg, errcode_p, &hooks);
4457 #if ENABLE_HUSH_BASH_COMPAT
4458 /* ${var/[/]pattern[/repl]} helpers */
4459 static char *strstr_pattern(char *val, const char *pattern, int *size)
4462 char *end = scan_and_match(val, pattern, SCAN_MOVE_FROM_RIGHT + SCAN_MATCH_LEFT_HALF);
4463 debug_printf_varexp("val:'%s' pattern:'%s' end:'%s'\n", val, pattern, end);
4470 /* Optimization: if "*pat" did not match the start of "string",
4471 * we know that "tring", "ring" etc will not match too:
4473 if (pattern[0] == '*')
4478 static char *replace_pattern(char *val, const char *pattern, const char *repl, char exp_op)
4480 char *result = NULL;
4481 unsigned res_len = 0;
4482 unsigned repl_len = strlen(repl);
4486 char *s = strstr_pattern(val, pattern, &size);
4490 result = xrealloc(result, res_len + (s - val) + repl_len + 1);
4491 memcpy(result + res_len, val, s - val);
4493 strcpy(result + res_len, repl);
4494 res_len += repl_len;
4495 debug_printf_varexp("val:'%s' s:'%s' result:'%s'\n", val, s, result);
4501 if (val[0] && result) {
4502 result = xrealloc(result, res_len + strlen(val) + 1);
4503 strcpy(result + res_len, val);
4504 debug_printf_varexp("val:'%s' result:'%s'\n", val, result);
4506 debug_printf_varexp("result:'%s'\n", result);
4512 * Handles <SPECIAL_VAR_SYMBOL>varname...<SPECIAL_VAR_SYMBOL> construct.
4514 static NOINLINE const char *expand_one_var(char **to_be_freed_pp, char *arg, char **pp, char first_ch)
4516 const char *val = NULL;
4517 char *to_be_freed = NULL;
4522 char exp_save = exp_save; /* for compiler */
4523 char *exp_saveptr; /* points to expansion operator */
4524 char *exp_word = exp_word; /* for compiler */
4528 exp_saveptr = arg[1] ? strchr(VAR_ENCODED_SUBST_OPS, arg[1]) : NULL;
4529 first_char = arg[0] = first_ch & 0x7f;
4532 if (first_char == '#' && arg[1] && !exp_saveptr) {
4533 /* handle length expansion ${#var} */
4537 /* maybe handle parameter expansion */
4538 if (exp_saveptr /* if 2nd char is one of expansion operators */
4539 && strchr(NUMERIC_SPECVARS_STR, first_char) /* 1st char is special variable */
4541 /* ${?:0}, ${#[:]%0} etc */
4542 exp_saveptr = var + 1;
4544 /* ${?}, ${var}, ${var:0}, ${var[:]%0} etc */
4545 exp_saveptr = var+1 + strcspn(var+1, VAR_ENCODED_SUBST_OPS);
4547 exp_op = exp_save = *exp_saveptr;
4549 exp_word = exp_saveptr + 1;
4550 if (exp_op == ':') {
4551 exp_op = *exp_word++;
4552 if (ENABLE_HUSH_BASH_COMPAT
4553 && (exp_op == '\0' || !strchr(MINUS_PLUS_EQUAL_QUESTION, exp_op))
4555 /* oops... it's ${var:N[:M]}, not ${var:?xxx} or some such */
4560 *exp_saveptr = '\0';
4561 } /* else: it's not an expansion op, but bare ${var} */
4564 /* lookup the variable in question */
4565 if (isdigit(var[0])) {
4566 /* parse_dollar() should have vetted var for us */
4567 int n = xatoi_positive(var);
4568 if (n < G.global_argc)
4569 val = G.global_argv[n];
4570 /* else val remains NULL: $N with too big N */
4574 val = utoa(G.root_pid);
4576 case '!': /* bg pid */
4577 val = G.last_bg_pid ? utoa(G.last_bg_pid) : "";
4579 case '?': /* exitcode */
4580 val = utoa(G.last_exitcode);
4582 case '#': /* argc */
4583 val = utoa(G.global_argc ? G.global_argc-1 : 0);
4586 val = get_local_var_value(var);
4590 /* Handle any expansions */
4591 if (exp_op == 'L') {
4592 debug_printf_expand("expand: length(%s)=", val);
4593 val = utoa(val ? strlen(val) : 0);
4594 debug_printf_expand("%s\n", val);
4595 } else if (exp_op) {
4596 if (exp_op == '%' || exp_op == '#') {
4597 /* Standard-mandated substring removal ops:
4598 * ${parameter%word} - remove smallest suffix pattern
4599 * ${parameter%%word} - remove largest suffix pattern
4600 * ${parameter#word} - remove smallest prefix pattern
4601 * ${parameter##word} - remove largest prefix pattern
4603 * Word is expanded to produce a glob pattern.
4604 * Then var's value is matched to it and matching part removed.
4606 if (val && val[0]) {
4609 unsigned scan_flags = pick_scan(exp_op, *exp_word);
4610 if (exp_op == *exp_word) /* ## or %% */
4612 //TODO: avoid xstrdup unless needed
4613 // (see HACK ALERT below for an example)
4614 val = to_be_freed = xstrdup(val);
4615 //TODO: fix expansion rules:
4616 exp_exp_word = expand_pseudo_dquoted(exp_word);
4618 exp_word = exp_exp_word;
4619 loc = scan_and_match(to_be_freed, exp_word, scan_flags);
4620 //bb_error_msg("op:%c str:'%s' pat:'%s' res:'%s'",
4621 // exp_op, to_be_freed, exp_word, loc);
4623 if (loc) { /* match was found */
4624 if (scan_flags & SCAN_MATCH_LEFT_HALF) /* #[#] */
4631 #if ENABLE_HUSH_BASH_COMPAT
4632 else if (exp_op == '/' || exp_op == '\\') {
4633 /* It's ${var/[/]pattern[/repl]} thing.
4634 * Note that in encoded form it has TWO parts:
4635 * var/pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
4637 /* Empty variable always gives nothing: */
4638 // "v=''; echo ${v/*/w}" prints "", not "w"
4639 if (val && val[0]) {
4640 /* It's ${var/[/]pattern[/repl]} thing */
4642 * Pattern is taken literally, while
4643 * repl should be de-backslased and globbed
4644 * by the usual expansion rules:
4646 * v='a bz'; echo "${v/a*z/a*z}" prints "a*z"
4647 * v='a bz'; echo "${v/a*z/\z}" prints "\z"
4648 * v='a bz'; echo ${v/a*z/a*z} prints "az"
4649 * v='a bz'; echo ${v/a*z/\z} prints "z"
4650 * (note that a*z _pattern_ is never globbed!)
4652 //TODO: fix expansion rules:
4653 char *pattern, *repl, *t;
4654 pattern = expand_pseudo_dquoted(exp_word);
4656 pattern = xstrdup(exp_word);
4657 debug_printf_varexp("pattern:'%s'->'%s'\n", exp_word, pattern);
4658 *p++ = SPECIAL_VAR_SYMBOL;
4660 p = strchr(p, SPECIAL_VAR_SYMBOL);
4662 repl = expand_pseudo_dquoted(exp_word);
4663 debug_printf_varexp("repl:'%s'->'%s'\n", exp_word, repl);
4664 /* HACK ALERT. We depend here on the fact that
4665 * G.global_argv and results of utoa and get_local_var_value
4666 * are actually in writable memory:
4667 * replace_pattern momentarily stores NULs there. */
4669 to_be_freed = replace_pattern(t,
4671 (repl ? repl : exp_word),
4673 if (to_be_freed) /* at least one replace happened */
4680 else if (exp_op == ':') {
4681 #if ENABLE_HUSH_BASH_COMPAT && ENABLE_SH_MATH_SUPPORT
4682 /* It's ${var:N[:M]} bashism.
4683 * Note that in encoded form it has TWO parts:
4684 * var:N<SPECIAL_VAR_SYMBOL>M<SPECIAL_VAR_SYMBOL>
4689 beg = expand_and_evaluate_arith(exp_word, &errcode);
4690 debug_printf_varexp("beg:'%s'=%lld\n", exp_word, (long long)beg);
4691 *p++ = SPECIAL_VAR_SYMBOL;
4693 p = strchr(p, SPECIAL_VAR_SYMBOL);
4695 len = expand_and_evaluate_arith(exp_word, &errcode);
4696 debug_printf_varexp("len:'%s'=%lld\n", exp_word, (long long)len);
4698 if (errcode >= 0 && len >= 0) { /* bash compat: len < 0 is illegal */
4699 if (beg < 0) /* bash compat */
4701 debug_printf_varexp("from val:'%s'\n", val);
4702 if (len == 0 || !val || beg >= strlen(val))
4705 /* Paranoia. What if user entered 9999999999999
4706 * which fits in arith_t but not int? */
4709 val = to_be_freed = xstrndup(val + beg, len);
4711 debug_printf_varexp("val:'%s'\n", val);
4715 die_if_script("malformed ${%s:...}", var);
4718 } else { /* one of "-=+?" */
4719 /* Standard-mandated substitution ops:
4720 * ${var?word} - indicate error if unset
4721 * If var is unset, word (or a message indicating it is unset
4722 * if word is null) is written to standard error
4723 * and the shell exits with a non-zero exit status.
4724 * Otherwise, the value of var is substituted.
4725 * ${var-word} - use default value
4726 * If var is unset, word is substituted.
4727 * ${var=word} - assign and use default value
4728 * If var is unset, word is assigned to var.
4729 * In all cases, final value of var is substituted.
4730 * ${var+word} - use alternative value
4731 * If var is unset, null is substituted.
4732 * Otherwise, word is substituted.
4734 * Word is subjected to tilde expansion, parameter expansion,
4735 * command substitution, and arithmetic expansion.
4736 * If word is not needed, it is not expanded.
4738 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
4739 * but also treat null var as if it is unset.
4741 int use_word = (!val || ((exp_save == ':') && !val[0]));
4743 use_word = !use_word;
4744 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
4745 (exp_save == ':') ? "true" : "false", use_word);
4747 to_be_freed = expand_pseudo_dquoted(exp_word);
4749 exp_word = to_be_freed;
4750 if (exp_op == '?') {
4751 /* mimic bash message */
4752 die_if_script("%s: %s",
4754 exp_word[0] ? exp_word : "parameter null or not set"
4756 //TODO: how interactive bash aborts expansion mid-command?
4761 if (exp_op == '=') {
4762 /* ${var=[word]} or ${var:=[word]} */
4763 if (isdigit(var[0]) || var[0] == '#') {
4764 /* mimic bash message */
4765 die_if_script("$%s: cannot assign in this way", var);
4768 char *new_var = xasprintf("%s=%s", var, val);
4769 set_local_var(new_var, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
4773 } /* one of "-=+?" */
4775 *exp_saveptr = exp_save;
4781 *to_be_freed_pp = to_be_freed;
4785 /* Expand all variable references in given string, adding words to list[]
4786 * at n, n+1,... positions. Return updated n (so that list[n] is next one
4787 * to be filled). This routine is extremely tricky: has to deal with
4788 * variables/parameters with whitespace, $* and $@, and constructs like
4789 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
4790 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
4792 /* or_mask is either 0 (normal case) or 0x80 -
4793 * expansion of right-hand side of assignment == 1-element expand.
4794 * It will also do no globbing, and thus we must not backslash-quote!
4801 debug_printf_expand("expand_vars_to_list: arg:'%s' or_mask:%x\n", arg, or_mask);
4802 debug_print_list("expand_vars_to_list", output, n);
4803 n = o_save_ptr(output, n);
4804 debug_print_list("expand_vars_to_list[0]", output, n);
4806 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
4808 char *to_be_freed = NULL;
4809 const char *val = NULL;
4810 #if ENABLE_HUSH_TICK
4811 o_string subst_result = NULL_O_STRING;
4813 #if ENABLE_SH_MATH_SUPPORT
4814 char arith_buf[sizeof(arith_t)*3 + 2];
4816 o_addblock(output, arg, p - arg);
4817 debug_print_list("expand_vars_to_list[1]", output, n);
4819 p = strchr(p, SPECIAL_VAR_SYMBOL);
4821 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
4822 /* "$@" is special. Even if quoted, it can still
4823 * expand to nothing (not even an empty string) */
4824 if ((first_ch & 0x7f) != '@')
4825 ored_ch |= first_ch;
4827 switch (first_ch & 0x7f) {
4828 /* Highest bit in first_ch indicates that var is double-quoted */
4832 if (!G.global_argv[1])
4835 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
4836 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
4837 smallint sv = output->o_escape;
4838 /* unquoted var's contents should be globbed, so don't escape */
4839 output->o_escape = 0;
4840 while (G.global_argv[i]) {
4841 n = expand_on_ifs(output, n, G.global_argv[i]);
4842 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
4843 if (G.global_argv[i++][0] && G.global_argv[i]) {
4844 /* this argv[] is not empty and not last:
4845 * put terminating NUL, start new word */
4846 o_addchr(output, '\0');
4847 debug_print_list("expand_vars_to_list[2]", output, n);
4848 n = o_save_ptr(output, n);
4849 debug_print_list("expand_vars_to_list[3]", output, n);
4852 output->o_escape = sv;
4854 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
4855 * and in this case should treat it like '$*' - see 'else...' below */
4856 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
4858 o_addQstr(output, G.global_argv[i]);
4859 if (++i >= G.global_argc)
4861 o_addchr(output, '\0');
4862 debug_print_list("expand_vars_to_list[4]", output, n);
4863 n = o_save_ptr(output, n);
4865 } else { /* quoted $*: add as one word */
4867 o_addQstr(output, G.global_argv[i]);
4868 if (!G.global_argv[++i])
4871 o_addchr(output, G.ifs[0]);
4876 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
4877 /* "Empty variable", used to make "" etc to not disappear */
4881 #if ENABLE_HUSH_TICK
4882 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
4885 /* Can't just stuff it into output o_string,
4886 * expanded result may need to be globbed
4887 * and $IFS-splitted */
4888 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
4889 G.last_exitcode = process_command_subs(&subst_result, arg);
4890 debug_printf_subst("SUBST RES:%d '%s'\n", G.last_exitcode, subst_result.data);
4891 val = subst_result.data;
4894 #if ENABLE_SH_MATH_SUPPORT
4895 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
4899 arg++; /* skip '+' */
4900 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
4901 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
4902 res = expand_and_evaluate_arith(arg, &errcode);
4905 const char *msg = "error in arithmetic";
4908 msg = "exponent less than 0";
4911 msg = "divide by 0";
4914 msg = "expression recursion loop detected";
4919 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
4920 sprintf(arith_buf, arith_t_fmt, res);
4926 val = expand_one_var(&to_be_freed, arg, &p, first_ch);
4927 IF_HUSH_TICK(store_val:)
4928 if (!(first_ch & 0x80)) { /* unquoted $VAR */
4929 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
4930 if (val && val[0]) {
4931 /* unquoted var's contents should be globbed, so don't escape */
4932 smallint sv = output->o_escape;
4933 output->o_escape = 0;
4934 n = expand_on_ifs(output, n, val);
4936 output->o_escape = sv;
4938 } else { /* quoted $VAR, val will be appended below */
4939 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
4943 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
4945 if (val && val[0]) {
4946 o_addQstr(output, val);
4949 /* Do the check to avoid writing to a const string */
4950 if (*p != SPECIAL_VAR_SYMBOL)
4951 *p = SPECIAL_VAR_SYMBOL;
4953 #if ENABLE_HUSH_TICK
4954 o_free(&subst_result);
4957 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
4960 debug_print_list("expand_vars_to_list[a]", output, n);
4961 /* this part is literal, and it was already pre-quoted
4962 * if needed (much earlier), do not use o_addQstr here! */
4963 o_addstr_with_NUL(output, arg);
4964 debug_print_list("expand_vars_to_list[b]", output, n);
4965 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
4966 && !(ored_ch & 0x80) /* and all vars were not quoted. */
4969 /* allow to reuse list[n] later without re-growth */
4970 output->has_empty_slot = 1;
4972 o_addchr(output, '\0');
4979 EXPVAR_FLAG_GLOB = 0x200,
4980 EXPVAR_FLAG_ESCAPE_VARS = 0x100,
4981 EXPVAR_FLAG_SINGLEWORD = 0x80, /* must be 0x80 */
4983 static char **expand_variables(char **argv, unsigned or_mask)
4988 o_string output = NULL_O_STRING;
4990 /* protect against globbing for "$var"? */
4991 /* (unquoted $var will temporarily switch it off) */
4992 output.o_escape = 1 & (or_mask / EXPVAR_FLAG_ESCAPE_VARS);
4993 output.o_glob = 1 & (or_mask / EXPVAR_FLAG_GLOB);
4998 n = expand_vars_to_list(&output, n, *v, (unsigned char)or_mask);
5001 debug_print_list("expand_variables", &output, n);
5003 /* output.data (malloced in one block) gets returned in "list" */
5004 list = o_finalize_list(&output, n);
5005 debug_print_strings("expand_variables[1]", list);
5009 static char **expand_strvec_to_strvec(char **argv)
5011 return expand_variables(argv, EXPVAR_FLAG_GLOB | EXPVAR_FLAG_ESCAPE_VARS);
5014 #if ENABLE_HUSH_BASH_COMPAT
5015 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
5017 return expand_variables(argv, EXPVAR_FLAG_SINGLEWORD);
5021 /* Used for expansion of right hand of assignments */
5022 /* NB: should NOT do globbing!
5023 * "export v=/bin/c*; env | grep ^v=" outputs "v=/bin/c*" */
5024 static char *expand_string_to_string(const char *str)
5026 char *argv[2], **list;
5028 /* This is generally an optimization, but it also
5029 * handles "", which otherwise trips over !list[0] check below.
5030 * (is this ever happens that we actually get str="" here?)
5032 if (!strchr(str, SPECIAL_VAR_SYMBOL) && !strchr(str, '\\')) {
5033 //TODO: Can use on strings with \ too, just unbackslash() them?
5034 debug_printf_expand("string_to_string(fast)='%s'\n", str);
5035 return xstrdup(str);
5038 argv[0] = (char*)str;
5040 list = expand_variables(argv, EXPVAR_FLAG_ESCAPE_VARS | EXPVAR_FLAG_SINGLEWORD);
5042 if (!list[0] || list[1])
5043 bb_error_msg_and_die("BUG in varexp2");
5044 /* actually, just move string 2*sizeof(char*) bytes back */
5045 overlapping_strcpy((char*)list, list[0]);
5046 unbackslash((char*)list);
5047 debug_printf_expand("string_to_string='%s'\n", (char*)list);
5051 /* Used for "eval" builtin */
5052 static char* expand_strvec_to_string(char **argv)
5056 list = expand_variables(argv, EXPVAR_FLAG_SINGLEWORD);
5057 /* Convert all NULs to spaces */
5062 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
5063 bb_error_msg_and_die("BUG in varexp3");
5064 /* bash uses ' ' regardless of $IFS contents */
5069 overlapping_strcpy((char*)list, list[0]);
5070 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
5074 static char **expand_assignments(char **argv, int count)
5079 G.expanded_assignments = p = NULL;
5080 /* Expand assignments into one string each */
5081 for (i = 0; i < count; i++) {
5082 G.expanded_assignments = p = add_string_to_strings(p, expand_string_to_string(argv[i]));
5084 G.expanded_assignments = NULL;
5091 void re_execute_shell(char ***to_free, const char *s,
5092 char *g_argv0, char **g_argv,
5093 char **builtin_argv) NORETURN;
5095 static void reset_traps_to_defaults(void)
5097 /* This function is always called in a child shell
5098 * after fork (not vfork, NOMMU doesn't use this function).
5103 /* Child shells are not interactive.
5104 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
5105 * Testcase: (while :; do :; done) + ^Z should background.
5106 * Same goes for SIGTERM, SIGHUP, SIGINT.
5108 if (!G.traps && !(G.non_DFL_mask & SPECIAL_INTERACTIVE_SIGS))
5109 return; /* already no traps and no SPECIAL_INTERACTIVE_SIGS */
5111 /* Switching off SPECIAL_INTERACTIVE_SIGS.
5112 * Stupid. It can be done with *single* &= op, but we can't use
5113 * the fact that G.blocked_set is implemented as a bitmask
5115 mask = (SPECIAL_INTERACTIVE_SIGS >> 1);
5119 /* Careful. Only if no trap or trap is not "" */
5120 if (!G.traps || !G.traps[sig] || G.traps[sig][0])
5121 sigdelset(&G.blocked_set, sig);
5128 /* Our homegrown sig mask is saner to work with :) */
5129 G.non_DFL_mask &= ~SPECIAL_INTERACTIVE_SIGS;
5131 /* Resetting all traps to default except empty ones */
5132 mask = G.non_DFL_mask;
5133 if (G.traps) for (sig = 0; sig < NSIG; sig++, mask >>= 1) {
5134 if (!G.traps[sig] || !G.traps[sig][0])
5137 G.traps[sig] = NULL;
5138 /* There is no signal for 0 (EXIT) */
5141 /* There was a trap handler, we just removed it.
5142 * But if sig still has non-DFL handling,
5143 * we should not unblock the sig. */
5146 sigdelset(&G.blocked_set, sig);
5148 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5153 static void re_execute_shell(char ***to_free, const char *s,
5154 char *g_argv0, char **g_argv,
5155 char **builtin_argv) NORETURN;
5156 static void re_execute_shell(char ***to_free, const char *s,
5157 char *g_argv0, char **g_argv,
5158 char **builtin_argv)
5160 # define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
5161 /* delims + 2 * (number of bytes in printed hex numbers) */
5162 char param_buf[sizeof(NOMMU_HACK_FMT) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
5163 char *heredoc_argv[4];
5164 struct variable *cur;
5165 # if ENABLE_HUSH_FUNCTIONS
5166 struct function *funcp;
5170 unsigned long long empty_trap_mask;
5172 if (!g_argv0) { /* heredoc */
5173 argv = heredoc_argv;
5174 argv[0] = (char *) G.argv0_for_re_execing;
5175 argv[1] = (char *) "-<";
5176 argv[2] = (char *) s;
5178 pp = &argv[3]; /* used as pointer to empty environment */
5184 if (pp) while (*pp++)
5187 empty_trap_mask = 0;
5190 for (sig = 1; sig < NSIG; sig++) {
5191 if (G.traps[sig] && !G.traps[sig][0])
5192 empty_trap_mask |= 1LL << sig;
5196 sprintf(param_buf, NOMMU_HACK_FMT
5197 , (unsigned) G.root_pid
5198 , (unsigned) G.root_ppid
5199 , (unsigned) G.last_bg_pid
5200 , (unsigned) G.last_exitcode
5203 IF_HUSH_LOOPS(, G.depth_of_loop)
5205 # undef NOMMU_HACK_FMT
5206 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
5207 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
5210 for (cur = G.top_var; cur; cur = cur->next) {
5211 if (!cur->flg_export || cur->flg_read_only)
5214 # if ENABLE_HUSH_FUNCTIONS
5215 for (funcp = G.top_func; funcp; funcp = funcp->next)
5221 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
5222 *pp++ = (char *) G.argv0_for_re_execing;
5224 for (cur = G.top_var; cur; cur = cur->next) {
5225 if (strcmp(cur->varstr, hush_version_str) == 0)
5227 if (cur->flg_read_only) {
5228 *pp++ = (char *) "-R";
5229 *pp++ = cur->varstr;
5230 } else if (!cur->flg_export) {
5231 *pp++ = (char *) "-V";
5232 *pp++ = cur->varstr;
5235 # if ENABLE_HUSH_FUNCTIONS
5236 for (funcp = G.top_func; funcp; funcp = funcp->next) {
5237 *pp++ = (char *) "-F";
5238 *pp++ = funcp->name;
5239 *pp++ = funcp->body_as_string;
5242 /* We can pass activated traps here. Say, -Tnn:trap_string
5244 * However, POSIX says that subshells reset signals with traps
5246 * I tested bash-3.2 and it not only does that with true subshells
5247 * of the form ( list ), but with any forked children shells.
5248 * I set trap "echo W" WINCH; and then tried:
5250 * { echo 1; sleep 20; echo 2; } &
5251 * while true; do echo 1; sleep 20; echo 2; break; done &
5252 * true | { echo 1; sleep 20; echo 2; } | cat
5254 * In all these cases sending SIGWINCH to the child shell
5255 * did not run the trap. If I add trap "echo V" WINCH;
5256 * _inside_ group (just before echo 1), it works.
5258 * I conclude it means we don't need to pass active traps here.
5259 * Even if we would use signal handlers instead of signal masking
5260 * in order to implement trap handling,
5261 * exec syscall below resets signals to SIG_DFL for us.
5263 *pp++ = (char *) "-c";
5266 while (*++builtin_argv)
5267 *pp++ = *builtin_argv;
5268 *pp++ = (char *) "";
5273 /* *pp = NULL; - is already there */
5277 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
5278 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
5279 execve(bb_busybox_exec_path, argv, pp);
5280 /* Fallback. Useful for init=/bin/hush usage etc */
5281 if (argv[0][0] == '/')
5282 execve(argv[0], argv, pp);
5283 xfunc_error_retval = 127;
5284 bb_error_msg_and_die("can't re-execute the shell");
5286 #endif /* !BB_MMU */
5289 static int run_and_free_list(struct pipe *pi);
5291 /* Executing from string: eval, sh -c '...'
5292 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
5293 * end_trigger controls how often we stop parsing
5294 * NUL: parse all, execute, return
5295 * ';': parse till ';' or newline, execute, repeat till EOF
5297 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
5299 /* Why we need empty flag?
5300 * An obscure corner case "false; ``; echo $?":
5301 * empty command in `` should still set $? to 0.
5302 * But we can't just set $? to 0 at the start,
5303 * this breaks "false; echo `echo $?`" case.
5307 struct pipe *pipe_list;
5309 pipe_list = parse_stream(NULL, inp, end_trigger);
5310 if (!pipe_list) { /* EOF */
5312 G.last_exitcode = 0;
5315 debug_print_tree(pipe_list, 0);
5316 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
5317 run_and_free_list(pipe_list);
5322 static void parse_and_run_string(const char *s)
5324 struct in_str input;
5325 setup_string_in_str(&input, s);
5326 parse_and_run_stream(&input, '\0');
5329 static void parse_and_run_file(FILE *f)
5331 struct in_str input;
5332 setup_file_in_str(&input, f);
5333 parse_and_run_stream(&input, ';');
5336 #if ENABLE_HUSH_TICK
5337 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
5342 char **to_free = NULL;
5346 pid = BB_MMU ? xfork() : xvfork();
5347 if (pid == 0) { /* child */
5348 disable_restore_tty_pgrp_on_exit();
5349 /* Process substitution is not considered to be usual
5350 * 'command execution'.
5351 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
5358 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
5359 close(channel[0]); /* NB: close _first_, then move fd! */
5360 xmove_fd(channel[1], 1);
5361 /* Prevent it from trying to handle ctrl-z etc */
5362 IF_HUSH_JOB(G.run_list_level = 1;)
5363 /* Awful hack for `trap` or $(trap).
5365 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
5366 * contains an example where "trap" is executed in a subshell:
5368 * save_traps=$(trap)
5370 * eval "$save_traps"
5372 * Standard does not say that "trap" in subshell shall print
5373 * parent shell's traps. It only says that its output
5374 * must have suitable form, but then, in the above example
5375 * (which is not supposed to be normative), it implies that.
5377 * bash (and probably other shell) does implement it
5378 * (traps are reset to defaults, but "trap" still shows them),
5379 * but as a result, "trap" logic is hopelessly messed up:
5382 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
5383 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
5384 * # true | trap <--- trap is in subshell - no output (ditto)
5385 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
5386 * trap -- 'echo Ho' SIGWINCH
5387 * # echo `(trap)` <--- in subshell in subshell - output
5388 * trap -- 'echo Ho' SIGWINCH
5389 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
5390 * trap -- 'echo Ho' SIGWINCH
5392 * The rules when to forget and when to not forget traps
5393 * get really complex and nonsensical.
5395 * Our solution: ONLY bare $(trap) or `trap` is special.
5397 s = skip_whitespace(s);
5398 if (strncmp(s, "trap", 4) == 0
5399 && skip_whitespace(s + 4)[0] == '\0'
5401 static const char *const argv[] = { NULL, NULL };
5402 builtin_trap((char**)argv);
5403 exit(0); /* not _exit() - we need to fflush */
5406 reset_traps_to_defaults();
5407 parse_and_run_string(s);
5408 _exit(G.last_exitcode);
5410 /* We re-execute after vfork on NOMMU. This makes this script safe:
5411 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
5412 * huge=`cat BIG` # was blocking here forever
5415 re_execute_shell(&to_free,
5425 # if ENABLE_HUSH_FAST
5427 //bb_error_msg("[%d] fork in generate_stream_from_string:"
5428 // " G.count_SIGCHLD:%d G.handled_SIGCHLD:%d",
5429 // getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5431 enable_restore_tty_pgrp_on_exit();
5436 close_on_exec_on(channel[0]);
5437 return xfdopen_for_read(channel[0]);
5440 /* Return code is exit status of the process that is run. */
5441 static int process_command_subs(o_string *dest, const char *s)
5444 struct in_str pipe_str;
5446 int status, ch, eol_cnt;
5448 fp = generate_stream_from_string(s, &pid);
5450 /* Now send results of command back into original context */
5451 setup_file_in_str(&pipe_str, fp);
5453 while ((ch = i_getch(&pipe_str)) != EOF) {
5459 o_addchr(dest, '\n');
5462 o_addQchr(dest, ch);
5465 debug_printf("done reading from `cmd` pipe, closing it\n");
5467 /* We need to extract exitcode. Test case
5468 * "true; echo `sleep 1; false` $?"
5470 safe_waitpid(pid, &status, 0);
5471 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
5472 return WEXITSTATUS(status);
5474 #endif /* ENABLE_HUSH_TICK */
5477 static void setup_heredoc(struct redir_struct *redir)
5479 struct fd_pair pair;
5482 /* the _body_ of heredoc (misleading field name) */
5483 const char *heredoc = redir->rd_filename;
5490 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
5491 expanded = expand_pseudo_dquoted(heredoc);
5495 len = strlen(heredoc);
5497 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
5499 xmove_fd(pair.rd, redir->rd_fd);
5501 /* Try writing without forking. Newer kernels have
5502 * dynamically growing pipes. Must use non-blocking write! */
5505 written = write(pair.wr, heredoc, len);
5516 ndelay_off(pair.wr);
5518 /* Okay, pipe buffer was not big enough */
5519 /* Note: we must not create a stray child (bastard? :)
5520 * for the unsuspecting parent process. Child creates a grandchild
5521 * and exits before parent execs the process which consumes heredoc
5522 * (that exec happens after we return from this function) */
5529 disable_restore_tty_pgrp_on_exit();
5530 pid = BB_MMU ? xfork() : xvfork();
5534 close(redir->rd_fd); /* read side of the pipe */
5536 full_write(pair.wr, heredoc, len); /* may loop or block */
5539 /* Delegate blocking writes to another process */
5540 xmove_fd(pair.wr, STDOUT_FILENO);
5541 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
5545 #if ENABLE_HUSH_FAST
5547 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
5549 enable_restore_tty_pgrp_on_exit();
5555 wait(NULL); /* wait till child has died */
5558 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
5559 * and stderr if they are redirected. */
5560 static int setup_redirects(struct command *prog, int squirrel[])
5563 struct redir_struct *redir;
5565 for (redir = prog->redirects; redir; redir = redir->next) {
5566 if (redir->rd_type == REDIRECT_HEREDOC2) {
5567 /* rd_fd<<HERE case */
5568 if (squirrel && redir->rd_fd < 3
5569 && squirrel[redir->rd_fd] < 0
5571 squirrel[redir->rd_fd] = dup(redir->rd_fd);
5573 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
5575 debug_printf_parse("set heredoc '%s'\n",
5576 redir->rd_filename);
5577 setup_heredoc(redir);
5581 if (redir->rd_dup == REDIRFD_TO_FILE) {
5582 /* rd_fd<*>file case (<*> is <,>,>>,<>) */
5584 if (redir->rd_filename == NULL) {
5585 /* Something went wrong in the parse.
5586 * Pretend it didn't happen */
5587 bb_error_msg("bug in redirect parse");
5590 mode = redir_table[redir->rd_type].mode;
5591 p = expand_string_to_string(redir->rd_filename);
5592 openfd = open_or_warn(p, mode);
5595 /* this could get lost if stderr has been redirected, but
5596 * bash and ash both lose it as well (though zsh doesn't!) */
5597 //what the above comment tries to say?
5601 /* rd_fd<*>rd_dup or rd_fd<*>- cases */
5602 openfd = redir->rd_dup;
5605 if (openfd != redir->rd_fd) {
5606 if (squirrel && redir->rd_fd < 3
5607 && squirrel[redir->rd_fd] < 0
5609 squirrel[redir->rd_fd] = dup(redir->rd_fd);
5611 if (openfd == REDIRFD_CLOSE) {
5612 /* "n>-" means "close me" */
5613 close(redir->rd_fd);
5615 xdup2(openfd, redir->rd_fd);
5616 if (redir->rd_dup == REDIRFD_TO_FILE)
5624 static void restore_redirects(int squirrel[])
5627 for (i = 0; i < 3; i++) {
5630 /* We simply die on error */
5636 static char *find_in_path(const char *arg)
5639 const char *PATH = get_local_var_value("PATH");
5645 const char *end = strchrnul(PATH, ':');
5646 int sz = end - PATH; /* must be int! */
5650 ret = xasprintf("%.*s/%s", sz, PATH, arg);
5652 /* We have xxx::yyyy in $PATH,
5653 * it means "use current dir" */
5656 if (access(ret, F_OK) == 0)
5669 static const struct built_in_command* find_builtin_helper(const char *name,
5670 const struct built_in_command *x,
5671 const struct built_in_command *end)
5674 if (strcmp(name, x->b_cmd) != 0) {
5678 debug_printf_exec("found builtin '%s'\n", name);
5683 static const struct built_in_command* find_builtin1(const char *name)
5685 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
5687 static const struct built_in_command* find_builtin(const char *name)
5689 const struct built_in_command *x = find_builtin1(name);
5692 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
5695 #if ENABLE_HUSH_FUNCTIONS
5696 static struct function **find_function_slot(const char *name)
5698 struct function **funcpp = &G.top_func;
5700 if (strcmp(name, (*funcpp)->name) == 0) {
5703 funcpp = &(*funcpp)->next;
5708 static const struct function *find_function(const char *name)
5710 const struct function *funcp = *find_function_slot(name);
5712 debug_printf_exec("found function '%s'\n", name);
5716 /* Note: takes ownership on name ptr */
5717 static struct function *new_function(char *name)
5719 struct function **funcpp = find_function_slot(name);
5720 struct function *funcp = *funcpp;
5722 if (funcp != NULL) {
5723 struct command *cmd = funcp->parent_cmd;
5724 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
5726 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
5728 /* Note: if !funcp->body, do not free body_as_string!
5729 * This is a special case of "-F name body" function:
5730 * body_as_string was not malloced! */
5732 free_pipe_list(funcp->body);
5734 free(funcp->body_as_string);
5738 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
5739 cmd->argv[0] = funcp->name;
5740 cmd->group = funcp->body;
5742 cmd->group_as_string = funcp->body_as_string;
5746 debug_printf_exec("remembering new function '%s'\n", name);
5747 funcp = *funcpp = xzalloc(sizeof(*funcp));
5748 /*funcp->next = NULL;*/
5755 static void unset_func(const char *name)
5757 struct function **funcpp = find_function_slot(name);
5758 struct function *funcp = *funcpp;
5760 if (funcp != NULL) {
5761 debug_printf_exec("freeing function '%s'\n", funcp->name);
5762 *funcpp = funcp->next;
5763 /* funcp is unlinked now, deleting it.
5764 * Note: if !funcp->body, the function was created by
5765 * "-F name body", do not free ->body_as_string
5766 * and ->name as they were not malloced. */
5768 free_pipe_list(funcp->body);
5771 free(funcp->body_as_string);
5779 #define exec_function(to_free, funcp, argv) \
5780 exec_function(funcp, argv)
5782 static void exec_function(char ***to_free,
5783 const struct function *funcp,
5784 char **argv) NORETURN;
5785 static void exec_function(char ***to_free,
5786 const struct function *funcp,
5792 argv[0] = G.global_argv[0];
5793 G.global_argv = argv;
5797 /* On MMU, funcp->body is always non-NULL */
5798 n = run_list(funcp->body);
5802 re_execute_shell(to_free,
5803 funcp->body_as_string,
5810 static int run_function(const struct function *funcp, char **argv)
5816 save_and_replace_G_args(&sv, argv);
5818 /* "we are in function, ok to use return" */
5819 sv_flg = G.flag_return_in_progress;
5820 G.flag_return_in_progress = -1;
5821 # if ENABLE_HUSH_LOCAL
5822 G.func_nest_level++;
5825 /* On MMU, funcp->body is always non-NULL */
5828 /* Function defined by -F */
5829 parse_and_run_string(funcp->body_as_string);
5830 rc = G.last_exitcode;
5834 rc = run_list(funcp->body);
5837 # if ENABLE_HUSH_LOCAL
5839 struct variable *var;
5840 struct variable **var_pp;
5842 var_pp = &G.top_var;
5843 while ((var = *var_pp) != NULL) {
5844 if (var->func_nest_level < G.func_nest_level) {
5845 var_pp = &var->next;
5849 if (var->flg_export)
5850 bb_unsetenv(var->varstr);
5851 /* Remove from global list */
5852 *var_pp = var->next;
5858 G.func_nest_level--;
5861 G.flag_return_in_progress = sv_flg;
5863 restore_G_args(&sv, argv);
5867 #endif /* ENABLE_HUSH_FUNCTIONS */
5871 #define exec_builtin(to_free, x, argv) \
5872 exec_builtin(x, argv)
5874 #define exec_builtin(to_free, x, argv) \
5875 exec_builtin(to_free, argv)
5877 static void exec_builtin(char ***to_free,
5878 const struct built_in_command *x,
5879 char **argv) NORETURN;
5880 static void exec_builtin(char ***to_free,
5881 const struct built_in_command *x,
5885 int rcode = x->b_function(argv);
5889 /* On NOMMU, we must never block!
5890 * Example: { sleep 99 | read line; } & echo Ok
5892 re_execute_shell(to_free,
5901 static void execvp_or_die(char **argv) NORETURN;
5902 static void execvp_or_die(char **argv)
5904 debug_printf_exec("execing '%s'\n", argv[0]);
5905 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
5906 execvp(argv[0], argv);
5907 bb_perror_msg("can't execute '%s'", argv[0]);
5908 _exit(127); /* bash compat */
5911 #if ENABLE_HUSH_MODE_X
5912 static void dump_cmd_in_x_mode(char **argv)
5914 if (G_x_mode && argv) {
5915 /* We want to output the line in one write op */
5923 len += strlen(argv[n++]) + 1;
5929 p += sprintf(p, " %s", argv[n++]);
5937 # define dump_cmd_in_x_mode(argv) ((void)0)
5941 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
5942 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
5943 #define pseudo_exec(nommu_save, command, argv_expanded) \
5944 pseudo_exec(command, argv_expanded)
5947 /* Called after [v]fork() in run_pipe, or from builtin_exec.
5949 * Don't exit() here. If you don't exec, use _exit instead.
5950 * The at_exit handlers apparently confuse the calling process,
5951 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
5952 static void pseudo_exec_argv(nommu_save_t *nommu_save,
5953 char **argv, int assignment_cnt,
5954 char **argv_expanded) NORETURN;
5955 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
5956 char **argv, int assignment_cnt,
5957 char **argv_expanded)
5961 new_env = expand_assignments(argv, assignment_cnt);
5962 dump_cmd_in_x_mode(new_env);
5964 if (!argv[assignment_cnt]) {
5965 /* Case when we are here: ... | var=val | ...
5966 * (note that we do not exit early, i.e., do not optimize out
5967 * expand_assignments(): think about ... | var=`sleep 1` | ...
5969 free_strings(new_env);
5970 _exit(EXIT_SUCCESS);
5974 set_vars_and_save_old(new_env);
5975 free(new_env); /* optional */
5976 /* we can also destroy set_vars_and_save_old's return value,
5979 nommu_save->new_env = new_env;
5980 nommu_save->old_vars = set_vars_and_save_old(new_env);
5983 if (argv_expanded) {
5984 argv = argv_expanded;
5986 argv = expand_strvec_to_strvec(argv + assignment_cnt);
5988 nommu_save->argv = argv;
5991 dump_cmd_in_x_mode(argv);
5993 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
5994 if (strchr(argv[0], '/') != NULL)
5998 /* Check if the command matches any of the builtins.
5999 * Depending on context, this might be redundant. But it's
6000 * easier to waste a few CPU cycles than it is to figure out
6001 * if this is one of those cases.
6004 /* On NOMMU, it is more expensive to re-execute shell
6005 * just in order to run echo or test builtin.
6006 * It's better to skip it here and run corresponding
6007 * non-builtin later. */
6008 const struct built_in_command *x;
6009 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
6011 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
6014 #if ENABLE_HUSH_FUNCTIONS
6015 /* Check if the command matches any functions */
6017 const struct function *funcp = find_function(argv[0]);
6019 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
6024 #if ENABLE_FEATURE_SH_STANDALONE
6025 /* Check if the command matches any busybox applets */
6027 int a = find_applet_by_name(argv[0]);
6029 # if BB_MMU /* see above why on NOMMU it is not allowed */
6030 if (APPLET_IS_NOEXEC(a)) {
6031 debug_printf_exec("running applet '%s'\n", argv[0]);
6032 run_applet_no_and_exit(a, argv);
6035 /* Re-exec ourselves */
6036 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
6037 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
6038 execv(bb_busybox_exec_path, argv);
6039 /* If they called chroot or otherwise made the binary no longer
6040 * executable, fall through */
6045 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
6048 execvp_or_die(argv);
6051 /* Called after [v]fork() in run_pipe
6053 static void pseudo_exec(nommu_save_t *nommu_save,
6054 struct command *command,
6055 char **argv_expanded) NORETURN;
6056 static void pseudo_exec(nommu_save_t *nommu_save,
6057 struct command *command,
6058 char **argv_expanded)
6060 if (command->argv) {
6061 pseudo_exec_argv(nommu_save, command->argv,
6062 command->assignment_cnt, argv_expanded);
6065 if (command->group) {
6066 /* Cases when we are here:
6069 * ... | ( list ) | ...
6070 * ... | { list } | ...
6074 debug_printf_exec("pseudo_exec: run_list\n");
6075 reset_traps_to_defaults();
6076 rcode = run_list(command->group);
6077 /* OK to leak memory by not calling free_pipe_list,
6078 * since this process is about to exit */
6081 re_execute_shell(&nommu_save->argv_from_re_execing,
6082 command->group_as_string,
6089 /* Case when we are here: ... | >file */
6090 debug_printf_exec("pseudo_exec'ed null command\n");
6091 _exit(EXIT_SUCCESS);
6095 static const char *get_cmdtext(struct pipe *pi)
6101 /* This is subtle. ->cmdtext is created only on first backgrounding.
6102 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
6103 * On subsequent bg argv is trashed, but we won't use it */
6106 argv = pi->cmds[0].argv;
6107 if (!argv || !argv[0]) {
6108 pi->cmdtext = xzalloc(1);
6114 len += strlen(*argv) + 1;
6118 argv = pi->cmds[0].argv;
6120 len = strlen(*argv);
6121 memcpy(p, *argv, len);
6129 static void insert_bg_job(struct pipe *pi)
6131 struct pipe *job, **jobp;
6134 /* Linear search for the ID of the job to use */
6136 for (job = G.job_list; job; job = job->next)
6137 if (job->jobid >= pi->jobid)
6138 pi->jobid = job->jobid + 1;
6140 /* Add job to the list of running jobs */
6142 while ((job = *jobp) != NULL)
6144 job = *jobp = xmalloc(sizeof(*job));
6146 *job = *pi; /* physical copy */
6148 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
6149 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
6150 for (i = 0; i < pi->num_cmds; i++) {
6151 job->cmds[i].pid = pi->cmds[i].pid;
6152 /* all other fields are not used and stay zero */
6154 job->cmdtext = xstrdup(get_cmdtext(pi));
6156 if (G_interactive_fd)
6157 printf("[%d] %d %s\n", job->jobid, job->cmds[0].pid, job->cmdtext);
6158 G.last_jobid = job->jobid;
6161 static void remove_bg_job(struct pipe *pi)
6163 struct pipe *prev_pipe;
6165 if (pi == G.job_list) {
6166 G.job_list = pi->next;
6168 prev_pipe = G.job_list;
6169 while (prev_pipe->next != pi)
6170 prev_pipe = prev_pipe->next;
6171 prev_pipe->next = pi->next;
6174 G.last_jobid = G.job_list->jobid;
6179 /* Remove a backgrounded job */
6180 static void delete_finished_bg_job(struct pipe *pi)
6183 pi->stopped_cmds = 0;
6189 /* Check to see if any processes have exited -- if they
6190 * have, figure out why and see if a job has completed */
6191 static int checkjobs(struct pipe* fg_pipe)
6201 debug_printf_jobs("checkjobs %p\n", fg_pipe);
6203 attributes = WUNTRACED;
6204 if (fg_pipe == NULL)
6205 attributes |= WNOHANG;
6208 #if ENABLE_HUSH_FAST
6209 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
6210 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
6211 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
6212 /* There was neither fork nor SIGCHLD since last waitpid */
6213 /* Avoid doing waitpid syscall if possible */
6214 if (!G.we_have_children) {
6218 if (fg_pipe == NULL) { /* is WNOHANG set? */
6219 /* We have children, but they did not exit
6220 * or stop yet (we saw no SIGCHLD) */
6223 /* else: !WNOHANG, waitpid will block, can't short-circuit */
6227 /* Do we do this right?
6228 * bash-3.00# sleep 20 | false
6230 * [3]+ Stopped sleep 20 | false
6231 * bash-3.00# echo $?
6232 * 1 <========== bg pipe is not fully done, but exitcode is already known!
6233 * [hush 1.14.0: yes we do it right]
6240 #if ENABLE_HUSH_FAST
6241 i = G.count_SIGCHLD;
6243 childpid = waitpid(-1, &status, attributes);
6244 if (childpid <= 0) {
6245 if (childpid && errno != ECHILD)
6246 bb_perror_msg("waitpid");
6247 #if ENABLE_HUSH_FAST
6248 else { /* Until next SIGCHLD, waitpid's are useless */
6249 G.we_have_children = (childpid == 0);
6250 G.handled_SIGCHLD = i;
6251 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6256 dead = WIFEXITED(status) || WIFSIGNALED(status);
6259 if (WIFSTOPPED(status))
6260 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
6261 childpid, WSTOPSIG(status), WEXITSTATUS(status));
6262 if (WIFSIGNALED(status))
6263 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
6264 childpid, WTERMSIG(status), WEXITSTATUS(status));
6265 if (WIFEXITED(status))
6266 debug_printf_jobs("pid %d exited, exitcode %d\n",
6267 childpid, WEXITSTATUS(status));
6269 /* Were we asked to wait for fg pipe? */
6271 for (i = 0; i < fg_pipe->num_cmds; i++) {
6272 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
6273 if (fg_pipe->cmds[i].pid != childpid)
6276 fg_pipe->cmds[i].pid = 0;
6277 fg_pipe->alive_cmds--;
6278 if (i == fg_pipe->num_cmds - 1) {
6279 /* last process gives overall exitstatus */
6280 rcode = WEXITSTATUS(status);
6281 /* bash prints killer signal's name for *last*
6282 * process in pipe (prints just newline for SIGINT).
6283 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
6285 if (WIFSIGNALED(status)) {
6286 int sig = WTERMSIG(status);
6287 printf("%s\n", sig == SIGINT ? "" : get_signame(sig));
6288 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
6289 * Maybe we need to use sig | 128? */
6292 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
6295 fg_pipe->cmds[i].is_stopped = 1;
6296 fg_pipe->stopped_cmds++;
6298 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
6299 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
6300 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
6301 /* All processes in fg pipe have exited or stopped */
6302 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
6303 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
6304 * and "killall -STOP cat" */
6305 if (G_interactive_fd) {
6307 if (fg_pipe->alive_cmds)
6308 insert_bg_job(fg_pipe);
6312 if (!fg_pipe->alive_cmds)
6315 /* There are still running processes in the fg pipe */
6316 goto wait_more; /* do waitpid again */
6318 /* it wasnt fg_pipe, look for process in bg pipes */
6322 /* We asked to wait for bg or orphaned children */
6323 /* No need to remember exitcode in this case */
6324 for (pi = G.job_list; pi; pi = pi->next) {
6325 for (i = 0; i < pi->num_cmds; i++) {
6326 if (pi->cmds[i].pid == childpid)
6327 goto found_pi_and_prognum;
6330 /* Happens when shell is used as init process (init=/bin/sh) */
6331 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
6332 continue; /* do waitpid again */
6334 found_pi_and_prognum:
6337 pi->cmds[i].pid = 0;
6339 if (!pi->alive_cmds) {
6340 if (G_interactive_fd)
6341 printf(JOB_STATUS_FORMAT, pi->jobid,
6342 "Done", pi->cmdtext);
6343 delete_finished_bg_job(pi);
6347 pi->cmds[i].is_stopped = 1;
6351 } /* while (waitpid succeeds)... */
6357 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
6360 int rcode = checkjobs(fg_pipe);
6361 if (G_saved_tty_pgrp) {
6362 /* Job finished, move the shell to the foreground */
6363 p = getpgrp(); /* our process group id */
6364 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
6365 tcsetpgrp(G_interactive_fd, p);
6371 /* Start all the jobs, but don't wait for anything to finish.
6374 * Return code is normally -1, when the caller has to wait for children
6375 * to finish to determine the exit status of the pipe. If the pipe
6376 * is a simple builtin command, however, the action is done by the
6377 * time run_pipe returns, and the exit code is provided as the
6380 * Returns -1 only if started some children. IOW: we have to
6381 * mask out retvals of builtins etc with 0xff!
6383 * The only case when we do not need to [v]fork is when the pipe
6384 * is single, non-backgrounded, non-subshell command. Examples:
6385 * cmd ; ... { list } ; ...
6386 * cmd && ... { list } && ...
6387 * cmd || ... { list } || ...
6388 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
6389 * or (if SH_STANDALONE) an applet, and we can run the { list }
6390 * with run_list. If it isn't one of these, we fork and exec cmd.
6392 * Cases when we must fork:
6393 * non-single: cmd | cmd
6394 * backgrounded: cmd & { list } &
6395 * subshell: ( list ) [&]
6397 #if !ENABLE_HUSH_MODE_X
6398 #define redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel, char argv_expanded) \
6399 redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel)
6401 static int redirect_and_varexp_helper(char ***new_env_p,
6402 struct variable **old_vars_p,
6403 struct command *command,
6405 char **argv_expanded)
6407 /* setup_redirects acts on file descriptors, not FILEs.
6408 * This is perfect for work that comes after exec().
6409 * Is it really safe for inline use? Experimentally,
6410 * things seem to work. */
6411 int rcode = setup_redirects(command, squirrel);
6413 char **new_env = expand_assignments(command->argv, command->assignment_cnt);
6414 *new_env_p = new_env;
6415 dump_cmd_in_x_mode(new_env);
6416 dump_cmd_in_x_mode(argv_expanded);
6418 *old_vars_p = set_vars_and_save_old(new_env);
6422 static NOINLINE int run_pipe(struct pipe *pi)
6424 static const char *const null_ptr = NULL;
6428 struct command *command;
6429 char **argv_expanded;
6431 /* it is not always needed, but we aim to smaller code */
6432 int squirrel[] = { -1, -1, -1 };
6435 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
6438 IF_HUSH_JOB(pi->pgrp = -1;)
6439 pi->stopped_cmds = 0;
6440 command = &pi->cmds[0];
6441 argv_expanded = NULL;
6443 if (pi->num_cmds != 1
6444 || pi->followup == PIPE_BG
6445 || command->cmd_type == CMD_SUBSHELL
6452 debug_printf_exec(": group:%p argv:'%s'\n",
6453 command->group, command->argv ? command->argv[0] : "NONE");
6455 if (command->group) {
6456 #if ENABLE_HUSH_FUNCTIONS
6457 if (command->cmd_type == CMD_FUNCDEF) {
6458 /* "executing" func () { list } */
6459 struct function *funcp;
6461 funcp = new_function(command->argv[0]);
6462 /* funcp->name is already set to argv[0] */
6463 funcp->body = command->group;
6465 funcp->body_as_string = command->group_as_string;
6466 command->group_as_string = NULL;
6468 command->group = NULL;
6469 command->argv[0] = NULL;
6470 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
6471 funcp->parent_cmd = command;
6472 command->child_func = funcp;
6474 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
6476 return EXIT_SUCCESS;
6480 debug_printf("non-subshell group\n");
6481 rcode = 1; /* exitcode if redir failed */
6482 if (setup_redirects(command, squirrel) == 0) {
6483 debug_printf_exec(": run_list\n");
6484 rcode = run_list(command->group) & 0xff;
6486 restore_redirects(squirrel);
6487 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6489 debug_printf_exec("run_pipe: return %d\n", rcode);
6493 argv = command->argv ? command->argv : (char **) &null_ptr;
6495 const struct built_in_command *x;
6496 #if ENABLE_HUSH_FUNCTIONS
6497 const struct function *funcp;
6501 char **new_env = NULL;
6502 struct variable *old_vars = NULL;
6504 if (argv[command->assignment_cnt] == NULL) {
6505 /* Assignments, but no command */
6506 /* Ensure redirects take effect (that is, create files).
6507 * Try "a=t >file" */
6508 #if 0 /* A few cases in testsuite fail with this code. FIXME */
6509 rcode = redirect_and_varexp_helper(&new_env, /*old_vars:*/ NULL, command, squirrel, /*argv_expanded:*/ NULL);
6510 /* Set shell variables */
6514 set_local_var(*argv, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
6515 /* Do we need to flag set_local_var() errors?
6516 * "assignment to readonly var" and "putenv error"
6521 /* Redirect error sets $? to 1. Otherwise,
6522 * if evaluating assignment value set $?, retain it.
6523 * Try "false; q=`exit 2`; echo $?" - should print 2: */
6525 rcode = G.last_exitcode;
6526 /* Exit, _skipping_ variable restoring code: */
6527 goto clean_up_and_ret0;
6529 #else /* Older, bigger, but more correct code */
6531 rcode = setup_redirects(command, squirrel);
6532 restore_redirects(squirrel);
6533 /* Set shell variables */
6535 bb_putchar_stderr('+');
6537 char *p = expand_string_to_string(*argv);
6539 fprintf(stderr, " %s", p);
6540 debug_printf_exec("set shell var:'%s'->'%s'\n",
6542 set_local_var(p, /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
6543 /* Do we need to flag set_local_var() errors?
6544 * "assignment to readonly var" and "putenv error"
6549 bb_putchar_stderr('\n');
6550 /* Redirect error sets $? to 1. Otherwise,
6551 * if evaluating assignment value set $?, retain it.
6552 * Try "false; q=`exit 2`; echo $?" - should print 2: */
6554 rcode = G.last_exitcode;
6555 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6557 debug_printf_exec("run_pipe: return %d\n", rcode);
6562 /* Expand the rest into (possibly) many strings each */
6564 #if ENABLE_HUSH_BASH_COMPAT
6565 else if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
6566 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
6570 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
6573 /* if someone gives us an empty string: `cmd with empty output` */
6574 if (!argv_expanded[0]) {
6575 free(argv_expanded);
6577 return G.last_exitcode;
6580 x = find_builtin(argv_expanded[0]);
6581 #if ENABLE_HUSH_FUNCTIONS
6584 funcp = find_function(argv_expanded[0]);
6588 if (x->b_function == builtin_exec && argv_expanded[1] == NULL) {
6589 debug_printf("exec with redirects only\n");
6590 rcode = setup_redirects(command, NULL);
6591 goto clean_up_and_ret1;
6594 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, squirrel, argv_expanded);
6597 debug_printf_exec(": builtin '%s' '%s'...\n",
6598 x->b_cmd, argv_expanded[1]);
6599 rcode = x->b_function(argv_expanded) & 0xff;
6602 #if ENABLE_HUSH_FUNCTIONS
6604 # if ENABLE_HUSH_LOCAL
6605 struct variable **sv;
6606 sv = G.shadowed_vars_pp;
6607 G.shadowed_vars_pp = &old_vars;
6609 debug_printf_exec(": function '%s' '%s'...\n",
6610 funcp->name, argv_expanded[1]);
6611 rcode = run_function(funcp, argv_expanded) & 0xff;
6612 # if ENABLE_HUSH_LOCAL
6613 G.shadowed_vars_pp = sv;
6619 unset_vars(new_env);
6621 /* clean_up_and_ret0: */
6622 restore_redirects(squirrel);
6624 free(argv_expanded);
6625 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
6627 debug_printf_exec("run_pipe return %d\n", rcode);
6631 if (ENABLE_FEATURE_SH_STANDALONE) {
6632 int n = find_applet_by_name(argv_expanded[0]);
6633 if (n >= 0 && APPLET_IS_NOFORK(n)) {
6634 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, squirrel, argv_expanded);
6636 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
6637 argv_expanded[0], argv_expanded[1]);
6638 rcode = run_nofork_applet(n, argv_expanded);
6640 goto clean_up_and_ret;
6643 /* It is neither builtin nor applet. We must fork. */
6647 /* NB: argv_expanded may already be created, and that
6648 * might include `cmd` runs! Do not rerun it! We *must*
6649 * use argv_expanded if it's non-NULL */
6651 /* Going to fork a child per each pipe member */
6656 while (cmd_no < pi->num_cmds) {
6657 struct fd_pair pipefds;
6659 volatile nommu_save_t nommu_save;
6660 nommu_save.new_env = NULL;
6661 nommu_save.old_vars = NULL;
6662 nommu_save.argv = NULL;
6663 nommu_save.argv_from_re_execing = NULL;
6665 command = &pi->cmds[cmd_no];
6667 if (command->argv) {
6668 debug_printf_exec(": pipe member '%s' '%s'...\n",
6669 command->argv[0], command->argv[1]);
6671 debug_printf_exec(": pipe member with no argv\n");
6674 /* pipes are inserted between pairs of commands */
6677 if (cmd_no < pi->num_cmds)
6678 xpiped_pair(pipefds);
6680 command->pid = BB_MMU ? fork() : vfork();
6681 if (!command->pid) { /* child */
6683 disable_restore_tty_pgrp_on_exit();
6684 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
6686 /* Every child adds itself to new process group
6687 * with pgid == pid_of_first_child_in_pipe */
6688 if (G.run_list_level == 1 && G_interactive_fd) {
6691 if (pgrp < 0) /* true for 1st process only */
6693 if (setpgid(0, pgrp) == 0
6694 && pi->followup != PIPE_BG
6695 && G_saved_tty_pgrp /* we have ctty */
6697 /* We do it in *every* child, not just first,
6699 tcsetpgrp(G_interactive_fd, pgrp);
6703 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
6704 /* 1st cmd in backgrounded pipe
6705 * should have its stdin /dev/null'ed */
6707 if (open(bb_dev_null, O_RDONLY))
6708 xopen("/", O_RDONLY);
6710 xmove_fd(next_infd, 0);
6712 xmove_fd(pipefds.wr, 1);
6715 /* Like bash, explicit redirects override pipes,
6716 * and the pipe fd is available for dup'ing. */
6717 if (setup_redirects(command, NULL))
6720 /* Restore default handlers just prior to exec */
6721 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
6723 /* Stores to nommu_save list of env vars putenv'ed
6724 * (NOMMU, on MMU we don't need that) */
6725 /* cast away volatility... */
6726 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
6727 /* pseudo_exec() does not return */
6730 /* parent or error */
6731 #if ENABLE_HUSH_FAST
6733 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6735 enable_restore_tty_pgrp_on_exit();
6737 /* Clean up after vforked child */
6738 free(nommu_save.argv);
6739 free(nommu_save.argv_from_re_execing);
6740 unset_vars(nommu_save.new_env);
6741 add_vars(nommu_save.old_vars);
6743 free(argv_expanded);
6744 argv_expanded = NULL;
6745 if (command->pid < 0) { /* [v]fork failed */
6746 /* Clearly indicate, was it fork or vfork */
6747 bb_perror_msg(BB_MMU ? "vfork"+1 : "vfork");
6751 /* Second and next children need to know pid of first one */
6753 pi->pgrp = command->pid;
6759 if (cmd_no < pi->num_cmds)
6761 /* Pass read (output) pipe end to next iteration */
6762 next_infd = pipefds.rd;
6765 if (!pi->alive_cmds) {
6767 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
6772 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
6776 #ifndef debug_print_tree
6777 static void debug_print_tree(struct pipe *pi, int lvl)
6779 static const char *const PIPE[] = {
6785 static const char *RES[] = {
6786 [RES_NONE ] = "NONE" ,
6789 [RES_THEN ] = "THEN" ,
6790 [RES_ELIF ] = "ELIF" ,
6791 [RES_ELSE ] = "ELSE" ,
6794 # if ENABLE_HUSH_LOOPS
6795 [RES_FOR ] = "FOR" ,
6796 [RES_WHILE] = "WHILE",
6797 [RES_UNTIL] = "UNTIL",
6799 [RES_DONE ] = "DONE" ,
6801 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
6804 # if ENABLE_HUSH_CASE
6805 [RES_CASE ] = "CASE" ,
6806 [RES_CASE_IN ] = "CASE_IN" ,
6807 [RES_MATCH] = "MATCH",
6808 [RES_CASE_BODY] = "CASE_BODY",
6809 [RES_ESAC ] = "ESAC" ,
6811 [RES_XXXX ] = "XXXX" ,
6812 [RES_SNTX ] = "SNTX" ,
6814 static const char *const CMDTYPE[] = {
6818 # if ENABLE_HUSH_FUNCTIONS
6827 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
6828 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
6830 while (prn < pi->num_cmds) {
6831 struct command *command = &pi->cmds[prn];
6832 char **argv = command->argv;
6834 fprintf(stderr, "%*s cmd %d assignment_cnt:%d",
6836 command->assignment_cnt);
6837 if (command->group) {
6838 fprintf(stderr, " group %s: (argv=%p)%s%s\n",
6839 CMDTYPE[command->cmd_type],
6842 , " group_as_string:", command->group_as_string
6847 debug_print_tree(command->group, lvl+1);
6851 if (argv) while (*argv) {
6852 fprintf(stderr, " '%s'", *argv);
6855 fprintf(stderr, "\n");
6862 #endif /* debug_print_tree */
6864 /* NB: called by pseudo_exec, and therefore must not modify any
6865 * global data until exec/_exit (we can be a child after vfork!) */
6866 static int run_list(struct pipe *pi)
6868 #if ENABLE_HUSH_CASE
6869 char *case_word = NULL;
6871 #if ENABLE_HUSH_LOOPS
6872 struct pipe *loop_top = NULL;
6873 char **for_lcur = NULL;
6874 char **for_list = NULL;
6876 smallint last_followup;
6878 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
6879 smalluint cond_code = 0;
6881 enum { cond_code = 0 };
6884 smallint rword; /* enum reserved_style */
6885 smallint last_rword; /* ditto */
6888 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
6891 #if ENABLE_HUSH_LOOPS
6892 /* Check syntax for "for" */
6893 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
6894 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
6896 /* current word is FOR or IN (BOLD in comments below) */
6897 if (cpipe->next == NULL) {
6898 syntax_error("malformed for");
6900 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
6903 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
6904 if (cpipe->next->res_word == RES_DO)
6906 /* next word is not "do". It must be "in" then ("FOR v in ...") */
6907 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
6908 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
6910 syntax_error("malformed for");
6912 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
6918 /* Past this point, all code paths should jump to ret: label
6919 * in order to return, no direct "return" statements please.
6920 * This helps to ensure that no memory is leaked. */
6928 last_rword = RES_XXXX;
6930 last_followup = PIPE_SEQ;
6931 rcode = G.last_exitcode;
6933 /* Go through list of pipes, (maybe) executing them. */
6934 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
6938 IF_HAS_KEYWORDS(rword = pi->res_word;)
6939 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
6940 rword, cond_code, last_rword);
6941 #if ENABLE_HUSH_LOOPS
6942 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
6943 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
6945 /* start of a loop: remember where loop starts */
6950 /* Still in the same "if...", "then..." or "do..." branch? */
6951 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
6952 if ((rcode == 0 && last_followup == PIPE_OR)
6953 || (rcode != 0 && last_followup == PIPE_AND)
6955 /* It is "<true> || CMD" or "<false> && CMD"
6956 * and we should not execute CMD */
6957 debug_printf_exec("skipped cmd because of || or &&\n");
6958 last_followup = pi->followup;
6962 last_followup = pi->followup;
6963 IF_HAS_KEYWORDS(last_rword = rword;)
6966 if (rword == RES_THEN) {
6967 /* if false; then ... fi has exitcode 0! */
6968 G.last_exitcode = rcode = EXIT_SUCCESS;
6969 /* "if <false> THEN cmd": skip cmd */
6973 if (rword == RES_ELSE || rword == RES_ELIF) {
6974 /* "if <true> then ... ELSE/ELIF cmd":
6975 * skip cmd and all following ones */
6980 #if ENABLE_HUSH_LOOPS
6981 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
6983 /* first loop through for */
6985 static const char encoded_dollar_at[] ALIGN1 = {
6986 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
6987 }; /* encoded representation of "$@" */
6988 static const char *const encoded_dollar_at_argv[] = {
6989 encoded_dollar_at, NULL
6990 }; /* argv list with one element: "$@" */
6993 vals = (char**)encoded_dollar_at_argv;
6994 if (pi->next->res_word == RES_IN) {
6995 /* if no variable values after "in" we skip "for" */
6996 if (!pi->next->cmds[0].argv) {
6997 G.last_exitcode = rcode = EXIT_SUCCESS;
6998 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
7001 vals = pi->next->cmds[0].argv;
7002 } /* else: "for var; do..." -> assume "$@" list */
7003 /* create list of variable values */
7004 debug_print_strings("for_list made from", vals);
7005 for_list = expand_strvec_to_strvec(vals);
7006 for_lcur = for_list;
7007 debug_print_strings("for_list", for_list);
7010 /* "for" loop is over, clean up */
7016 /* Insert next value from for_lcur */
7017 /* note: *for_lcur already has quotes removed, $var expanded, etc */
7018 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ 0);
7021 if (rword == RES_IN) {
7022 continue; /* "for v IN list;..." - "in" has no cmds anyway */
7024 if (rword == RES_DONE) {
7025 continue; /* "done" has no cmds too */
7028 #if ENABLE_HUSH_CASE
7029 if (rword == RES_CASE) {
7030 case_word = expand_strvec_to_string(pi->cmds->argv);
7033 if (rword == RES_MATCH) {
7036 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
7038 /* all prev words didn't match, does this one match? */
7039 argv = pi->cmds->argv;
7041 char *pattern = expand_string_to_string(*argv);
7042 /* TODO: which FNM_xxx flags to use? */
7043 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
7045 if (cond_code == 0) { /* match! we will execute this branch */
7046 free(case_word); /* make future "word)" stop */
7054 if (rword == RES_CASE_BODY) { /* inside of a case branch */
7056 continue; /* not matched yet, skip this pipe */
7059 /* Just pressing <enter> in shell should check for jobs.
7060 * OTOH, in non-interactive shell this is useless
7061 * and only leads to extra job checks */
7062 if (pi->num_cmds == 0) {
7063 if (G_interactive_fd)
7064 goto check_jobs_and_continue;
7068 /* After analyzing all keywords and conditions, we decided
7069 * to execute this pipe. NB: have to do checkjobs(NULL)
7070 * after run_pipe to collect any background children,
7071 * even if list execution is to be stopped. */
7072 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
7075 #if ENABLE_HUSH_LOOPS
7076 G.flag_break_continue = 0;
7078 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
7080 /* We ran a builtin, function, or group.
7081 * rcode is already known
7082 * and we don't need to wait for anything. */
7083 G.last_exitcode = rcode;
7084 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
7085 check_and_run_traps(0);
7086 #if ENABLE_HUSH_LOOPS
7087 /* Was it "break" or "continue"? */
7088 if (G.flag_break_continue) {
7089 smallint fbc = G.flag_break_continue;
7090 /* We might fall into outer *loop*,
7091 * don't want to break it too */
7093 G.depth_break_continue--;
7094 if (G.depth_break_continue == 0)
7095 G.flag_break_continue = 0;
7096 /* else: e.g. "continue 2" should *break* once, *then* continue */
7097 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
7098 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
7099 goto check_jobs_and_break;
7100 /* "continue": simulate end of loop */
7105 #if ENABLE_HUSH_FUNCTIONS
7106 if (G.flag_return_in_progress == 1) {
7107 /* same as "goto check_jobs_and_break" */
7112 } else if (pi->followup == PIPE_BG) {
7113 /* What does bash do with attempts to background builtins? */
7114 /* even bash 3.2 doesn't do that well with nested bg:
7115 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
7116 * I'm NOT treating inner &'s as jobs */
7117 check_and_run_traps(0);
7119 if (G.run_list_level == 1)
7122 /* Last command's pid goes to $! */
7123 G.last_bg_pid = pi->cmds[pi->num_cmds - 1].pid;
7124 G.last_exitcode = rcode = EXIT_SUCCESS;
7125 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
7128 if (G.run_list_level == 1 && G_interactive_fd) {
7129 /* Waits for completion, then fg's main shell */
7130 rcode = checkjobs_and_fg_shell(pi);
7131 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
7132 check_and_run_traps(0);
7135 { /* This one just waits for completion */
7136 rcode = checkjobs(pi);
7137 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
7138 check_and_run_traps(0);
7140 G.last_exitcode = rcode;
7144 /* Analyze how result affects subsequent commands */
7146 if (rword == RES_IF || rword == RES_ELIF)
7149 #if ENABLE_HUSH_LOOPS
7150 /* Beware of "while false; true; do ..."! */
7151 if (pi->next && pi->next->res_word == RES_DO) {
7152 if (rword == RES_WHILE) {
7154 /* "while false; do...done" - exitcode 0 */
7155 G.last_exitcode = rcode = EXIT_SUCCESS;
7156 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
7157 goto check_jobs_and_break;
7160 if (rword == RES_UNTIL) {
7162 debug_printf_exec(": until expr is true: breaking\n");
7163 check_jobs_and_break:
7171 check_jobs_and_continue:
7178 #if ENABLE_HUSH_LOOPS
7183 #if ENABLE_HUSH_CASE
7187 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
7191 /* Select which version we will use */
7192 static int run_and_free_list(struct pipe *pi)
7195 debug_printf_exec("run_and_free_list entered\n");
7197 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
7198 rcode = run_list(pi);
7200 /* free_pipe_list has the side effect of clearing memory.
7201 * In the long run that function can be merged with run_list,
7202 * but doing that now would hobble the debugging effort. */
7204 debug_printf_exec("run_and_free_list return %d\n", rcode);
7209 /* Called a few times only (or even once if "sh -c") */
7210 static void init_sigmasks(void)
7214 sigset_t old_blocked_set;
7216 if (!G.inherited_set_is_saved) {
7217 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
7218 G.inherited_set = G.blocked_set;
7220 old_blocked_set = G.blocked_set;
7222 mask = (1 << SIGQUIT);
7223 if (G_interactive_fd) {
7224 mask = (1 << SIGQUIT) | SPECIAL_INTERACTIVE_SIGS;
7225 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
7226 mask |= SPECIAL_JOB_SIGS;
7228 G.non_DFL_mask = mask;
7233 sigaddset(&G.blocked_set, sig);
7237 sigdelset(&G.blocked_set, SIGCHLD);
7239 if (memcmp(&old_blocked_set, &G.blocked_set, sizeof(old_blocked_set)) != 0)
7240 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7242 /* POSIX allows shell to re-enable SIGCHLD
7243 * even if it was SIG_IGN on entry */
7244 #if ENABLE_HUSH_FAST
7245 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
7246 if (!G.inherited_set_is_saved)
7247 signal(SIGCHLD, SIGCHLD_handler);
7249 if (!G.inherited_set_is_saved)
7250 signal(SIGCHLD, SIG_DFL);
7253 G.inherited_set_is_saved = 1;
7258 static void maybe_set_to_sigexit(int sig)
7260 void (*handler)(int);
7261 /* non_DFL_mask'ed signals are, well, masked,
7262 * no need to set handler for them.
7264 if (!((G.non_DFL_mask >> sig) & 1)) {
7265 handler = signal(sig, sigexit);
7266 if (handler == SIG_IGN) /* oops... restore back to IGN! */
7267 signal(sig, handler);
7270 /* Set handlers to restore tty pgrp and exit */
7271 static void set_fatal_handlers(void)
7273 /* We _must_ restore tty pgrp on fatal signals */
7275 maybe_set_to_sigexit(SIGILL );
7276 maybe_set_to_sigexit(SIGFPE );
7277 maybe_set_to_sigexit(SIGBUS );
7278 maybe_set_to_sigexit(SIGSEGV);
7279 maybe_set_to_sigexit(SIGTRAP);
7280 } /* else: hush is perfect. what SEGV? */
7281 maybe_set_to_sigexit(SIGABRT);
7282 /* bash 3.2 seems to handle these just like 'fatal' ones */
7283 maybe_set_to_sigexit(SIGPIPE);
7284 maybe_set_to_sigexit(SIGALRM);
7285 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are masked.
7286 * if we aren't interactive... but in this case
7287 * we never want to restore pgrp on exit, and this fn is not called */
7288 /*maybe_set_to_sigexit(SIGHUP );*/
7289 /*maybe_set_to_sigexit(SIGTERM);*/
7290 /*maybe_set_to_sigexit(SIGINT );*/
7294 static int set_mode(const char cstate, const char mode)
7296 int state = (cstate == '-' ? 1 : 0);
7298 case 'n': G.n_mode = state; break;
7299 case 'x': IF_HUSH_MODE_X(G_x_mode = state;) break;
7300 default: return EXIT_FAILURE;
7302 return EXIT_SUCCESS;
7305 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7306 int hush_main(int argc, char **argv)
7309 unsigned builtin_argc;
7311 struct variable *cur_var;
7314 if (EXIT_SUCCESS) /* if EXIT_SUCCESS == 0, it is already done */
7315 G.last_exitcode = EXIT_SUCCESS;
7317 G.argv0_for_re_execing = argv[0];
7319 /* Deal with HUSH_VERSION */
7320 G.shell_ver.flg_export = 1;
7321 G.shell_ver.flg_read_only = 1;
7322 /* Code which handles ${var/P/R} needs writable values for all variables,
7323 * therefore we xstrdup: */
7324 G.shell_ver.varstr = xstrdup(hush_version_str),
7325 G.top_var = &G.shell_ver;
7326 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
7327 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
7328 /* reinstate HUSH_VERSION in environment */
7329 debug_printf_env("putenv '%s'\n", G.shell_ver.varstr);
7330 putenv(G.shell_ver.varstr);
7332 /* Initialize our shell local variables with the values
7333 * currently living in the environment */
7334 cur_var = G.top_var;
7337 char *value = strchr(*e, '=');
7338 if (value) { /* paranoia */
7339 cur_var->next = xzalloc(sizeof(*cur_var));
7340 cur_var = cur_var->next;
7341 cur_var->varstr = *e;
7342 cur_var->max_len = strlen(*e);
7343 cur_var->flg_export = 1;
7349 set_pwd_var(/*exp:*/ 1);
7350 /* bash also exports SHLVL and _,
7351 * and sets (but doesn't export) the following variables:
7353 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
7354 * BASH_VERSION='3.2.0(1)-release'
7356 * MACHTYPE=i386-pc-linux-gnu
7358 * HOSTNAME=<xxxxxxxxxx>
7359 * PPID=<NNNNN> - we also do it elsewhere
7370 * PIPESTATUS=([0]="0")
7371 * HISTFILE=/<xxx>/.bash_history
7375 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
7377 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
7387 #if ENABLE_FEATURE_EDITING
7388 G.line_input_state = new_line_input_t(FOR_SHELL);
7390 G.global_argc = argc;
7391 G.global_argv = argv;
7392 /* Initialize some more globals to non-zero values */
7393 cmdedit_update_prompt();
7395 if (setjmp(die_jmp)) {
7396 /* xfunc has failed! die die die */
7397 /* no EXIT traps, this is an escape hatch! */
7399 hush_exit(xfunc_error_retval);
7402 /* Shell is non-interactive at first. We need to call
7403 * init_sigmasks() if we are going to execute "sh <script>",
7404 * "sh -c <cmds>" or login shell's /etc/profile and friends.
7405 * If we later decide that we are interactive, we run init_sigmasks()
7406 * in order to intercept (more) signals.
7410 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
7413 opt = getopt(argc, argv, "+c:xins"
7416 # if ENABLE_HUSH_FUNCTIONS
7426 * sh ... -c 'script'
7427 * sh ... -c 'script' ARG0 [ARG1...]
7428 * On NOMMU, if builtin_argc != 0,
7429 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
7430 * "" needs to be replaced with NULL
7431 * and BARGV vector fed to builtin function.
7432 * Note: the form without ARG0 never happens:
7433 * sh ... -c 'builtin' BARGV... ""
7436 G.root_pid = getpid();
7437 G.root_ppid = getppid();
7439 G.global_argv = argv + optind;
7440 G.global_argc = argc - optind;
7442 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
7443 const struct built_in_command *x;
7446 x = find_builtin(optarg);
7447 if (x) { /* paranoia */
7448 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
7449 G.global_argv += builtin_argc;
7450 G.global_argv[-1] = NULL; /* replace "" */
7451 G.last_exitcode = x->b_function(argv + optind - 1);
7455 if (!G.global_argv[0]) {
7456 /* -c 'script' (no params): prevent empty $0 */
7457 G.global_argv--; /* points to argv[i] of 'script' */
7458 G.global_argv[0] = argv[0];
7460 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
7462 parse_and_run_string(optarg);
7465 /* Well, we cannot just declare interactiveness,
7466 * we have to have some stuff (ctty, etc) */
7467 /* G_interactive_fd++; */
7470 /* "-s" means "read from stdin", but this is how we always
7471 * operate, so simply do nothing here. */
7474 case '<': /* "big heredoc" support */
7475 full_write1_str(optarg);
7478 unsigned long long empty_trap_mask;
7480 G.root_pid = bb_strtou(optarg, &optarg, 16);
7482 G.root_ppid = bb_strtou(optarg, &optarg, 16);
7484 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
7486 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
7488 builtin_argc = bb_strtou(optarg, &optarg, 16);
7490 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
7491 if (empty_trap_mask != 0) {
7494 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7495 for (sig = 1; sig < NSIG; sig++) {
7496 if (empty_trap_mask & (1LL << sig)) {
7497 G.traps[sig] = xzalloc(1); /* == xstrdup(""); */
7498 sigaddset(&G.blocked_set, sig);
7501 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
7503 # if ENABLE_HUSH_LOOPS
7505 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
7511 set_local_var(xstrdup(optarg), /*exp:*/ 0, /*lvl:*/ 0, /*ro:*/ opt == 'R');
7513 # if ENABLE_HUSH_FUNCTIONS
7515 struct function *funcp = new_function(optarg);
7516 /* funcp->name is already set to optarg */
7517 /* funcp->body is set to NULL. It's a special case. */
7518 funcp->body_as_string = argv[optind];
7526 if (set_mode('-', opt) == 0) /* no error */
7530 fprintf(stderr, "Usage: sh [FILE]...\n"
7531 " or: sh -c command [args]...\n\n");
7537 } /* option parsing loop */
7540 G.root_pid = getpid();
7541 G.root_ppid = getppid();
7544 /* If we are login shell... */
7545 if (argv[0] && argv[0][0] == '-') {
7547 debug_printf("sourcing /etc/profile\n");
7548 input = fopen_for_read("/etc/profile");
7549 if (input != NULL) {
7550 close_on_exec_on(fileno(input));
7552 parse_and_run_file(input);
7555 /* bash: after sourcing /etc/profile,
7556 * tries to source (in the given order):
7557 * ~/.bash_profile, ~/.bash_login, ~/.profile,
7558 * stopping on first found. --noprofile turns this off.
7559 * bash also sources ~/.bash_logout on exit.
7560 * If called as sh, skips .bash_XXX files.
7567 * "bash <script>" (which is never interactive (unless -i?))
7568 * sources $BASH_ENV here (without scanning $PATH).
7569 * If called as sh, does the same but with $ENV.
7571 debug_printf("running script '%s'\n", argv[optind]);
7572 G.global_argv = argv + optind;
7573 G.global_argc = argc - optind;
7574 input = xfopen_for_read(argv[optind]);
7575 close_on_exec_on(fileno(input));
7577 parse_and_run_file(input);
7578 #if ENABLE_FEATURE_CLEAN_UP
7584 /* Up to here, shell was non-interactive. Now it may become one.
7585 * NB: don't forget to (re)run init_sigmasks() as needed.
7588 /* A shell is interactive if the '-i' flag was given,
7589 * or if all of the following conditions are met:
7591 * no arguments remaining or the -s flag given
7592 * standard input is a terminal
7593 * standard output is a terminal
7594 * Refer to Posix.2, the description of the 'sh' utility.
7597 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7598 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
7599 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
7600 if (G_saved_tty_pgrp < 0)
7601 G_saved_tty_pgrp = 0;
7603 /* try to dup stdin to high fd#, >= 255 */
7604 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7605 if (G_interactive_fd < 0) {
7606 /* try to dup to any fd */
7607 G_interactive_fd = dup(STDIN_FILENO);
7608 if (G_interactive_fd < 0) {
7610 G_interactive_fd = 0;
7611 G_saved_tty_pgrp = 0;
7614 // TODO: track & disallow any attempts of user
7615 // to (inadvertently) close/redirect G_interactive_fd
7617 debug_printf("interactive_fd:%d\n", G_interactive_fd);
7618 if (G_interactive_fd) {
7619 close_on_exec_on(G_interactive_fd);
7621 if (G_saved_tty_pgrp) {
7622 /* If we were run as 'hush &', sleep until we are
7623 * in the foreground (tty pgrp == our pgrp).
7624 * If we get started under a job aware app (like bash),
7625 * make sure we are now in charge so we don't fight over
7626 * who gets the foreground */
7628 pid_t shell_pgrp = getpgrp();
7629 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
7630 if (G_saved_tty_pgrp == shell_pgrp)
7632 /* send TTIN to ourself (should stop us) */
7633 kill(- shell_pgrp, SIGTTIN);
7637 /* Block some signals */
7640 if (G_saved_tty_pgrp) {
7641 /* Set other signals to restore saved_tty_pgrp */
7642 set_fatal_handlers();
7643 /* Put ourselves in our own process group
7644 * (bash, too, does this only if ctty is available) */
7645 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
7646 /* Grab control of the terminal */
7647 tcsetpgrp(G_interactive_fd, getpid());
7649 /* -1 is special - makes xfuncs longjmp, not exit
7650 * (we reset die_sleep = 0 whereever we [v]fork) */
7651 enable_restore_tty_pgrp_on_exit(); /* sets die_sleep = -1 */
7655 #elif ENABLE_HUSH_INTERACTIVE
7656 /* No job control compiled in, only prompt/line editing */
7657 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
7658 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
7659 if (G_interactive_fd < 0) {
7660 /* try to dup to any fd */
7661 G_interactive_fd = dup(STDIN_FILENO);
7662 if (G_interactive_fd < 0)
7664 G_interactive_fd = 0;
7667 if (G_interactive_fd) {
7668 close_on_exec_on(G_interactive_fd);
7672 /* We have interactiveness code disabled */
7676 * if interactive but not a login shell, sources ~/.bashrc
7677 * (--norc turns this off, --rcfile <file> overrides)
7680 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
7681 /* note: ash and hush share this string */
7682 printf("\n\n%s %s\n"
7683 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
7686 "hush - the humble shell"
7690 parse_and_run_file(stdin);
7693 #if ENABLE_FEATURE_CLEAN_UP
7694 if (G.cwd != bb_msg_unknown)
7696 cur_var = G.top_var->next;
7698 struct variable *tmp = cur_var;
7699 if (!cur_var->max_len)
7700 free(cur_var->varstr);
7701 cur_var = cur_var->next;
7705 hush_exit(G.last_exitcode);
7710 int msh_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
7711 int msh_main(int argc, char **argv)
7713 //bb_error_msg("msh is deprecated, please use hush instead");
7714 return hush_main(argc, argv);
7722 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
7727 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
7734 return applet_main_func(argc, argv - argc);
7737 static int FAST_FUNC builtin_test(char **argv)
7739 return run_applet_main(argv, test_main);
7742 static int FAST_FUNC builtin_echo(char **argv)
7744 return run_applet_main(argv, echo_main);
7748 static int FAST_FUNC builtin_printf(char **argv)
7750 return run_applet_main(argv, printf_main);
7754 static char **skip_dash_dash(char **argv)
7757 if (argv[0] && argv[0][0] == '-' && argv[0][1] == '-' && argv[0][2] == '\0')
7762 static int FAST_FUNC builtin_eval(char **argv)
7764 int rcode = EXIT_SUCCESS;
7766 argv = skip_dash_dash(argv);
7768 char *str = expand_strvec_to_string(argv);
7770 * eval "echo Hi; done" ("done" is syntax error):
7771 * "echo Hi" will not execute too.
7773 parse_and_run_string(str);
7775 rcode = G.last_exitcode;
7780 static int FAST_FUNC builtin_cd(char **argv)
7784 argv = skip_dash_dash(argv);
7786 if (newdir == NULL) {
7787 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
7788 * bash says "bash: cd: HOME not set" and does nothing
7791 const char *home = get_local_var_value("HOME");
7792 newdir = home ? home : "/";
7794 if (chdir(newdir)) {
7795 /* Mimic bash message exactly */
7796 bb_perror_msg("cd: %s", newdir);
7797 return EXIT_FAILURE;
7799 /* Read current dir (get_cwd(1) is inside) and set PWD.
7800 * Note: do not enforce exporting. If PWD was unset or unexported,
7801 * set it again, but do not export. bash does the same.
7803 set_pwd_var(/*exp:*/ 0);
7804 return EXIT_SUCCESS;
7807 static int FAST_FUNC builtin_exec(char **argv)
7809 argv = skip_dash_dash(argv);
7810 if (argv[0] == NULL)
7811 return EXIT_SUCCESS; /* bash does this */
7813 /* Careful: we can end up here after [v]fork. Do not restore
7814 * tty pgrp then, only top-level shell process does that */
7815 if (G_saved_tty_pgrp && getpid() == G.root_pid)
7816 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
7818 /* TODO: if exec fails, bash does NOT exit! We do.
7819 * We'll need to undo sigprocmask (it's inside execvp_or_die)
7820 * and tcsetpgrp, and this is inherently racy.
7822 execvp_or_die(argv);
7825 static int FAST_FUNC builtin_exit(char **argv)
7827 debug_printf_exec("%s()\n", __func__);
7829 /* interactive bash:
7830 * # trap "echo EEE" EXIT
7833 * There are stopped jobs.
7834 * (if there are _stopped_ jobs, running ones don't count)
7837 # EEE (then bash exits)
7839 * we can use G.exiting = -1 as indicator "last cmd was exit"
7842 /* note: EXIT trap is run by hush_exit */
7843 argv = skip_dash_dash(argv);
7844 if (argv[0] == NULL)
7845 hush_exit(G.last_exitcode);
7846 /* mimic bash: exit 123abc == exit 255 + error msg */
7847 xfunc_error_retval = 255;
7848 /* bash: exit -2 == exit 254, no error msg */
7849 hush_exit(xatoi(argv[0]) & 0xff);
7852 static void print_escaped(const char *s)
7857 const char *p = strchrnul(s, '\'');
7858 /* print 'xxxx', possibly just '' */
7859 printf("'%.*s'", (int)(p - s), s);
7864 /* s points to '; print "'''...'''" */
7866 do putchar('\''); while (*++s == '\'');
7871 #if !ENABLE_HUSH_LOCAL
7872 #define helper_export_local(argv, exp, lvl) \
7873 helper_export_local(argv, exp)
7875 static void helper_export_local(char **argv, int exp, int lvl)
7880 /* So far we do not check that name is valid (TODO?) */
7882 if (strchr(name, '=') == NULL) {
7883 struct variable *var;
7885 var = get_local_var(name);
7886 if (exp == -1) { /* unexporting? */
7887 /* export -n NAME (without =VALUE) */
7889 var->flg_export = 0;
7890 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
7892 } /* else: export -n NOT_EXISTING_VAR: no-op */
7895 if (exp == 1) { /* exporting? */
7896 /* export NAME (without =VALUE) */
7898 var->flg_export = 1;
7899 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
7900 putenv(var->varstr);
7904 /* Exporting non-existing variable.
7905 * bash does not put it in environment,
7906 * but remembers that it is exported,
7907 * and does put it in env when it is set later.
7908 * We just set it to "" and export. */
7909 /* Or, it's "local NAME" (without =VALUE).
7910 * bash sets the value to "". */
7911 name = xasprintf("%s=", name);
7913 /* (Un)exporting/making local NAME=VALUE */
7914 name = xstrdup(name);
7916 set_local_var(name, /*exp:*/ exp, /*lvl:*/ lvl, /*ro:*/ 0);
7920 static int FAST_FUNC builtin_export(char **argv)
7922 unsigned opt_unexport;
7924 #if ENABLE_HUSH_EXPORT_N
7925 /* "!": do not abort on errors */
7926 opt_unexport = getopt32(argv, "!n");
7927 if (opt_unexport == (uint32_t)-1)
7928 return EXIT_FAILURE;
7935 if (argv[0] == NULL) {
7942 /* ash emits: export VAR='VAL'
7943 * bash: declare -x VAR="VAL"
7944 * we follow ash example */
7945 const char *s = *e++;
7946 const char *p = strchr(s, '=');
7948 if (!p) /* wtf? take next variable */
7951 printf("export %.*s", (int)(p - s) + 1, s);
7952 print_escaped(p + 1);
7956 /*fflush_all(); - done after each builtin anyway */
7958 return EXIT_SUCCESS;
7961 helper_export_local(argv, (opt_unexport ? -1 : 1), 0);
7963 return EXIT_SUCCESS;
7966 #if ENABLE_HUSH_LOCAL
7967 static int FAST_FUNC builtin_local(char **argv)
7969 if (G.func_nest_level == 0) {
7970 bb_error_msg("%s: not in a function", argv[0]);
7971 return EXIT_FAILURE; /* bash compat */
7973 helper_export_local(argv, 0, G.func_nest_level);
7974 return EXIT_SUCCESS;
7978 static int FAST_FUNC builtin_trap(char **argv)
7984 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
7989 /* No args: print all trapped */
7990 for (i = 0; i < NSIG; ++i) {
7993 print_escaped(G.traps[i]);
7994 /* note: bash adds "SIG", but only if invoked
7995 * as "bash". If called as "sh", or if set -o posix,
7996 * then it prints short signal names.
7997 * We are printing short names: */
7998 printf(" %s\n", get_signame(i));
8001 /*fflush_all(); - done after each builtin anyway */
8002 return EXIT_SUCCESS;
8006 /* If first arg is a number: reset all specified signals */
8007 sig = bb_strtou(*argv, NULL, 10);
8013 sig = get_signum(*argv++);
8014 if (sig < 0 || sig >= NSIG) {
8016 /* Mimic bash message exactly */
8017 bb_perror_msg("trap: %s: invalid signal specification", argv[-1]);
8022 G.traps[sig] = xstrdup(new_cmd);
8024 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
8025 get_signame(sig), sig, G.traps[sig]);
8027 /* There is no signal for 0 (EXIT) */
8032 sigaddset(&G.blocked_set, sig);
8034 /* There was a trap handler, we are removing it
8035 * (if sig has non-DFL handling,
8036 * we don't need to do anything) */
8037 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
8039 sigdelset(&G.blocked_set, sig);
8042 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8046 if (!argv[1]) { /* no second arg */
8047 bb_error_msg("trap: invalid arguments");
8048 return EXIT_FAILURE;
8051 /* First arg is "-": reset all specified to default */
8052 /* First arg is "--": skip it, the rest is "handler SIGs..." */
8053 /* Everything else: set arg as signal handler
8054 * (includes "" case, which ignores signal) */
8055 if (argv[0][0] == '-') {
8056 if (argv[0][1] == '\0') { /* "-" */
8057 /* new_cmd remains NULL: "reset these sigs" */
8060 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
8063 /* else: "-something", no special meaning */
8068 goto process_sig_list;
8071 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
8072 static int FAST_FUNC builtin_type(char **argv)
8074 int ret = EXIT_SUCCESS;
8080 if (0) {} /* make conditional compile easier below */
8081 /*else if (find_alias(*argv))
8082 type = "an alias";*/
8083 #if ENABLE_HUSH_FUNCTIONS
8084 else if (find_function(*argv))
8085 type = "a function";
8087 else if (find_builtin(*argv))
8088 type = "a shell builtin";
8089 else if ((path = find_in_path(*argv)) != NULL)
8092 bb_error_msg("type: %s: not found", *argv);
8097 printf("%s is %s\n", *argv, type);
8105 /* built-in 'fg' and 'bg' handler */
8106 static int FAST_FUNC builtin_fg_bg(char **argv)
8111 if (!G_interactive_fd)
8112 return EXIT_FAILURE;
8114 /* If they gave us no args, assume they want the last backgrounded task */
8116 for (pi = G.job_list; pi; pi = pi->next) {
8117 if (pi->jobid == G.last_jobid) {
8121 bb_error_msg("%s: no current job", argv[0]);
8122 return EXIT_FAILURE;
8124 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
8125 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
8126 return EXIT_FAILURE;
8128 for (pi = G.job_list; pi; pi = pi->next) {
8129 if (pi->jobid == jobnum) {
8133 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
8134 return EXIT_FAILURE;
8136 /* TODO: bash prints a string representation
8137 * of job being foregrounded (like "sleep 1 | cat") */
8138 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
8139 /* Put the job into the foreground. */
8140 tcsetpgrp(G_interactive_fd, pi->pgrp);
8143 /* Restart the processes in the job */
8144 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
8145 for (i = 0; i < pi->num_cmds; i++) {
8146 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
8147 pi->cmds[i].is_stopped = 0;
8149 pi->stopped_cmds = 0;
8151 i = kill(- pi->pgrp, SIGCONT);
8153 if (errno == ESRCH) {
8154 delete_finished_bg_job(pi);
8155 return EXIT_SUCCESS;
8157 bb_perror_msg("kill (SIGCONT)");
8160 if (argv[0][0] == 'f') {
8162 return checkjobs_and_fg_shell(pi);
8164 return EXIT_SUCCESS;
8168 #if ENABLE_HUSH_HELP
8169 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
8171 const struct built_in_command *x;
8174 "Built-in commands:\n"
8175 "------------------\n");
8176 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
8178 printf("%-10s%s\n", x->b_cmd, x->b_descr);
8181 return EXIT_SUCCESS;
8186 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
8189 const char *status_string;
8191 for (job = G.job_list; job; job = job->next) {
8192 if (job->alive_cmds == job->stopped_cmds)
8193 status_string = "Stopped";
8195 status_string = "Running";
8197 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
8199 return EXIT_SUCCESS;
8204 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
8209 # ifdef M_TRIM_THRESHOLD
8210 /* Optional. Reduces probability of false positives */
8213 /* Crude attempt to find where "free memory" starts,
8214 * sans fragmentation. */
8216 l = (unsigned long)p;
8219 if (l < (unsigned long)p) l = (unsigned long)p;
8222 if (!G.memleak_value)
8223 G.memleak_value = l;
8225 l -= G.memleak_value;
8232 /* Exitcode is "how many kilobytes we leaked since 1st call" */
8237 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
8240 return EXIT_SUCCESS;
8243 static int FAST_FUNC builtin_read(char **argv)
8252 /* "!": do not abort on errors.
8253 * Option string must start with "sr" to match BUILTIN_READ_xxx
8255 read_flags = getopt32(argv, "!srn:p:t:u:", &opt_n, &opt_p, &opt_t, &opt_u);
8256 if (read_flags == (uint32_t)-1)
8257 return EXIT_FAILURE;
8260 r = shell_builtin_read(set_local_var_from_halves,
8262 get_local_var_value("IFS"), /* can be NULL */
8270 if ((uintptr_t)r > 1) {
8271 bb_error_msg("%s", r);
8272 r = (char*)(uintptr_t)1;
8275 return (uintptr_t)r;
8278 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
8279 * built-in 'set' handler
8281 * set [-abCefhmnuvx] [-o option] [argument...]
8282 * set [+abCefhmnuvx] [+o option] [argument...]
8283 * set -- [argument...]
8286 * Implementations shall support the options in both their hyphen and
8287 * plus-sign forms. These options can also be specified as options to sh.
8289 * Write out all variables and their values: set
8290 * Set $1, $2, and $3 and set "$#" to 3: set c a b
8291 * Turn on the -x and -v options: set -xv
8292 * Unset all positional parameters: set --
8293 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
8294 * Set the positional parameters to the expansion of x, even if x expands
8295 * with a leading '-' or '+': set -- $x
8297 * So far, we only support "set -- [argument...]" and some of the short names.
8299 static int FAST_FUNC builtin_set(char **argv)
8302 char **pp, **g_argv;
8303 char *arg = *++argv;
8307 for (e = G.top_var; e; e = e->next)
8309 return EXIT_SUCCESS;
8313 if (!strcmp(arg, "--")) {
8317 if (arg[0] != '+' && arg[0] != '-')
8319 for (n = 1; arg[n]; ++n)
8320 if (set_mode(arg[0], arg[n]))
8322 } while ((arg = *++argv) != NULL);
8323 /* Now argv[0] is 1st argument */
8326 return EXIT_SUCCESS;
8329 /* NB: G.global_argv[0] ($0) is never freed/changed */
8330 g_argv = G.global_argv;
8331 if (G.global_args_malloced) {
8337 G.global_args_malloced = 1;
8338 pp = xzalloc(sizeof(pp[0]) * 2);
8339 pp[0] = g_argv[0]; /* retain $0 */
8342 /* This realloc's G.global_argv */
8343 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
8350 return EXIT_SUCCESS;
8352 /* Nothing known, so abort */
8354 bb_error_msg("set: %s: invalid option", arg);
8355 return EXIT_FAILURE;
8358 static int FAST_FUNC builtin_shift(char **argv)
8361 argv = skip_dash_dash(argv);
8365 if (n >= 0 && n < G.global_argc) {
8366 if (G.global_args_malloced) {
8369 free(G.global_argv[m++]);
8372 memmove(&G.global_argv[1], &G.global_argv[n+1],
8373 G.global_argc * sizeof(G.global_argv[0]));
8374 return EXIT_SUCCESS;
8376 return EXIT_FAILURE;
8379 static int FAST_FUNC builtin_source(char **argv)
8381 char *arg_path, *filename;
8384 #if ENABLE_HUSH_FUNCTIONS
8388 argv = skip_dash_dash(argv);
8391 /* bash says: "bash: .: filename argument required" */
8392 return 2; /* bash compat */
8395 if (!strchr(filename, '/')) {
8396 arg_path = find_in_path(filename);
8398 filename = arg_path;
8400 input = fopen_or_warn(filename, "r");
8403 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
8404 return EXIT_FAILURE;
8406 close_on_exec_on(fileno(input));
8408 #if ENABLE_HUSH_FUNCTIONS
8409 sv_flg = G.flag_return_in_progress;
8410 /* "we are inside sourced file, ok to use return" */
8411 G.flag_return_in_progress = -1;
8413 save_and_replace_G_args(&sv, argv);
8415 parse_and_run_file(input);
8418 restore_G_args(&sv, argv);
8419 #if ENABLE_HUSH_FUNCTIONS
8420 G.flag_return_in_progress = sv_flg;
8423 return G.last_exitcode;
8426 static int FAST_FUNC builtin_umask(char **argv)
8432 argv = skip_dash_dash(argv);
8434 mode_t old_mask = mask;
8437 rc = bb_parse_mode(argv[0], &mask);
8442 * bash: umask: 'q': invalid symbolic mode operator
8443 * bash: umask: 999: octal number out of range
8445 bb_error_msg("%s: invalid mode '%s'", "umask", argv[0]);
8450 printf("%04o\n", (unsigned) mask);
8451 /* fall through and restore mask which we set to 0 */
8455 return !rc; /* rc != 0 - success */
8458 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
8459 static int FAST_FUNC builtin_unset(char **argv)
8464 /* "!": do not abort on errors */
8465 /* "+": stop at 1st non-option */
8466 opts = getopt32(argv, "!+vf");
8467 if (opts == (unsigned)-1)
8468 return EXIT_FAILURE;
8470 bb_error_msg("unset: -v and -f are exclusive");
8471 return EXIT_FAILURE;
8477 if (!(opts & 2)) { /* not -f */
8478 if (unset_local_var(*argv)) {
8479 /* unset <nonexistent_var> doesn't fail.
8480 * Error is when one tries to unset RO var.
8481 * Message was printed by unset_local_var. */
8485 #if ENABLE_HUSH_FUNCTIONS
8495 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
8496 static int FAST_FUNC builtin_wait(char **argv)
8498 int ret = EXIT_SUCCESS;
8501 argv = skip_dash_dash(argv);
8502 if (argv[0] == NULL) {
8503 /* Don't care about wait results */
8504 /* Note 1: must wait until there are no more children */
8505 /* Note 2: must be interruptible */
8507 * $ sleep 3 & sleep 6 & wait
8512 * $ sleep 3 & sleep 6 & wait
8516 * ^C <-- after ~4 sec from keyboard
8519 sigaddset(&G.blocked_set, SIGCHLD);
8520 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8523 if (errno == ECHILD)
8525 /* Wait for SIGCHLD or any other signal of interest */
8526 /* sigtimedwait with infinite timeout: */
8527 sig = sigwaitinfo(&G.blocked_set, NULL);
8529 sig = check_and_run_traps(sig);
8530 if (sig && sig != SIGCHLD) { /* see note 2 */
8536 sigdelset(&G.blocked_set, SIGCHLD);
8537 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
8541 /* This is probably buggy wrt interruptible-ness */
8543 pid_t pid = bb_strtou(*argv, NULL, 10);
8545 /* mimic bash message */
8546 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
8547 return EXIT_FAILURE;
8549 if (waitpid(pid, &status, 0) == pid) {
8550 if (WIFSIGNALED(status))
8551 ret = 128 + WTERMSIG(status);
8552 else if (WIFEXITED(status))
8553 ret = WEXITSTATUS(status);
8557 bb_perror_msg("wait %s", *argv);
8566 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
8567 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
8570 def = bb_strtou(argv[1], NULL, 10);
8571 if (errno || def < def_min || argv[2]) {
8572 bb_error_msg("%s: bad arguments", argv[0]);
8580 #if ENABLE_HUSH_LOOPS
8581 static int FAST_FUNC builtin_break(char **argv)
8584 if (G.depth_of_loop == 0) {
8585 bb_error_msg("%s: only meaningful in a loop", argv[0]);
8586 return EXIT_SUCCESS; /* bash compat */
8588 G.flag_break_continue++; /* BC_BREAK = 1 */
8590 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
8591 if (depth == UINT_MAX)
8592 G.flag_break_continue = BC_BREAK;
8593 if (G.depth_of_loop < depth)
8594 G.depth_break_continue = G.depth_of_loop;
8596 return EXIT_SUCCESS;
8599 static int FAST_FUNC builtin_continue(char **argv)
8601 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
8602 return builtin_break(argv);
8606 #if ENABLE_HUSH_FUNCTIONS
8607 static int FAST_FUNC builtin_return(char **argv)
8611 if (G.flag_return_in_progress != -1) {
8612 bb_error_msg("%s: not in a function or sourced script", argv[0]);
8613 return EXIT_FAILURE; /* bash compat */
8616 G.flag_return_in_progress = 1;
8619 * out of range: wraps around at 256, does not error out
8620 * non-numeric param:
8621 * f() { false; return qwe; }; f; echo $?
8622 * bash: return: qwe: numeric argument required <== we do this
8623 * 255 <== we also do this
8625 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);