1 /* vi: set sw=4 ts=4: */
3 * A prototype Bourne shell grammar parser.
4 * Intended to follow the original Thompson and Ritchie
5 * "small and simple is beautiful" philosophy, which
6 * incidentally is a good match to today's BusyBox.
8 * Copyright (C) 2000,2001 Larry Doolittle <larry@doolittle.boa.org>
9 * Copyright (C) 2008,2009 Denys Vlasenko <vda.linux@googlemail.com>
11 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
14 * The parser routines proper are all original material, first
15 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
16 * execution engine, the builtins, and much of the underlying
17 * support has been adapted from busybox-0.49pre's lash, which is
18 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
19 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
20 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
21 * Troan, which they placed in the public domain. I don't know
22 * how much of the Johnson/Troan code has survived the repeated
26 * o_addchr derived from similar w_addchar function in glibc-2.2.
27 * parse_redirect, redirect_opt_num, and big chunks of main
28 * and many builtins derived from contributions by Erik Andersen.
29 * Miscellaneous bugfixes from Matt Kraai.
31 * There are two big (and related) architecture differences between
32 * this parser and the lash parser. One is that this version is
33 * actually designed from the ground up to understand nearly all
34 * of the Bourne grammar. The second, consequential change is that
35 * the parser and input reader have been turned inside out. Now,
36 * the parser is in control, and asks for input as needed. The old
37 * way had the input reader in control, and it asked for parsing to
38 * take place as needed. The new way makes it much easier to properly
39 * handle the recursion implicit in the various substitutions, especially
40 * across continuation lines.
43 * grep for "TODO" and fix (some of them are easy)
44 * make complex ${var%...} constructs support optional
45 * make here documents optional
46 * special variables (done: PWD, PPID, RANDOM)
47 * follow IFS rules more precisely, including update semantics
50 * "command" missing features:
51 * command -p CMD: run CMD using default $PATH
52 * (can use this to override standalone shell as well?)
53 * command BLTIN: disables special-ness (e.g. errors do not abort)
54 * command -V CMD1 CMD2 CMD3 (multiple args) (not in standard)
55 * builtins mandated by standards we don't support:
57 * fc -l[nr] [BEG] [END]: list range of commands in history
58 * fc [-e EDITOR] [BEG] [END]: edit/rerun range of commands
59 * fc -s [PAT=REP] [CMD]: rerun CMD, replacing PAT with REP
62 * redirection of stdout+stderr: &> and >&
63 * reserved words: function select
64 * advanced test: [[ ]]
65 * process substitution: <(list) and >(list)
68 * Each EXPR is an arithmetic expression (ARITHMETIC EVALUATION)
69 * If the last arg evaluates to 0, let returns 1; 0 otherwise.
70 * NB: let `echo 'a=a + 1'` - error (IOW: multi-word expansion is used)
72 * The EXPR is evaluated according to ARITHMETIC EVALUATION.
73 * This is exactly equivalent to let "EXPR".
74 * $[EXPR]: synonym for $((EXPR))
75 * indirect expansion: ${!VAR}
76 * substring op on @: ${@:n:m}
79 * Some builtins mandated by standards:
80 * newgrp [GRP]: not a builtin in bash but a suid binary
81 * which spawns a new shell with new group ID
82 * In bash, export builtin is special, its arguments are assignments
83 * and therefore expansion of them should be "one-word" expansion:
84 * $ export i=`echo 'a b'` # export has one arg: "i=a b"
86 * $ ls i=`echo 'a b'` # ls has two args: "i=a" and "b"
87 * ls: cannot access i=a: No such file or directory
88 * ls: cannot access b: No such file or directory
89 * Note1: same applies to local builtin.
90 * Note2: bash 3.2.33(1) does this only if export word itself
92 * $ export i=`echo 'aaa bbb'`; echo "$i"
94 * $ "export" i=`echo 'aaa bbb'`; echo "$i"
98 //config: bool "hush (64 kb)"
101 //config: hush is a small shell. It handles the normal flow control
102 //config: constructs such as if/then/elif/else/fi, for/in/do/done, while loops,
103 //config: case/esac. Redirections, here documents, $((arithmetic))
104 //config: and functions are supported.
106 //config: It will compile and work on no-mmu systems.
108 //config: It does not handle select, aliases, tilde expansion,
109 //config: &>file and >&file redirection of stdout+stderr.
111 //config:config HUSH_BASH_COMPAT
112 //config: bool "bash-compatible extensions"
114 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
116 //config:config HUSH_BRACE_EXPANSION
117 //config: bool "Brace expansion"
119 //config: depends on HUSH_BASH_COMPAT
121 //config: Enable {abc,def} extension.
123 //config:config HUSH_INTERACTIVE
124 //config: bool "Interactive mode"
126 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
128 //config: Enable interactive mode (prompt and command editing).
129 //config: Without this, hush simply reads and executes commands
130 //config: from stdin just like a shell script from a file.
131 //config: No prompt, no PS1/PS2 magic shell variables.
133 //config:config HUSH_SAVEHISTORY
134 //config: bool "Save command history to .hush_history"
136 //config: depends on HUSH_INTERACTIVE && FEATURE_EDITING_SAVEHISTORY
138 //config:config HUSH_JOB
139 //config: bool "Job control"
141 //config: depends on HUSH_INTERACTIVE
143 //config: Enable job control: Ctrl-Z backgrounds, Ctrl-C interrupts current
144 //config: command (not entire shell), fg/bg builtins work. Without this option,
145 //config: "cmd &" still works by simply spawning a process and immediately
146 //config: prompting for next command (or executing next command in a script),
147 //config: but no separate process group is formed.
149 //config:config HUSH_TICK
150 //config: bool "Support process substitution"
152 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
154 //config: Enable `command` and $(command).
156 //config:config HUSH_IF
157 //config: bool "Support if/then/elif/else/fi"
159 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
161 //config:config HUSH_LOOPS
162 //config: bool "Support for, while and until loops"
164 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
166 //config:config HUSH_CASE
167 //config: bool "Support case ... esac statement"
169 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
171 //config: Enable case ... esac statement. +400 bytes.
173 //config:config HUSH_FUNCTIONS
174 //config: bool "Support funcname() { commands; } syntax"
176 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
178 //config: Enable support for shell functions. +800 bytes.
180 //config:config HUSH_LOCAL
181 //config: bool "local builtin"
183 //config: depends on HUSH_FUNCTIONS
185 //config: Enable support for local variables in functions.
187 //config:config HUSH_RANDOM_SUPPORT
188 //config: bool "Pseudorandom generator and $RANDOM variable"
190 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
192 //config: Enable pseudorandom generator and dynamic variable "$RANDOM".
193 //config: Each read of "$RANDOM" will generate a new pseudorandom value.
195 //config:config HUSH_MODE_X
196 //config: bool "Support 'hush -x' option and 'set -x' command"
198 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
200 //config: This instructs hush to print commands before execution.
201 //config: Adds ~300 bytes.
203 //config:config HUSH_ECHO
204 //config: bool "echo builtin"
206 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
208 //config:config HUSH_PRINTF
209 //config: bool "printf builtin"
211 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
213 //config:config HUSH_TEST
214 //config: bool "test builtin"
216 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
218 //config:config HUSH_HELP
219 //config: bool "help builtin"
221 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
223 //config:config HUSH_EXPORT
224 //config: bool "export builtin"
226 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
228 //config:config HUSH_EXPORT_N
229 //config: bool "Support 'export -n' option"
231 //config: depends on HUSH_EXPORT
233 //config: export -n unexports variables. It is a bash extension.
235 //config:config HUSH_READONLY
236 //config: bool "readonly builtin"
238 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
240 //config: Enable support for read-only variables.
242 //config:config HUSH_KILL
243 //config: bool "kill builtin (supports kill %jobspec)"
245 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
247 //config:config HUSH_WAIT
248 //config: bool "wait builtin"
250 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
252 //config:config HUSH_COMMAND
253 //config: bool "command builtin"
255 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
257 //config:config HUSH_TRAP
258 //config: bool "trap builtin"
260 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
262 //config:config HUSH_TYPE
263 //config: bool "type builtin"
265 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
267 //config:config HUSH_TIMES
268 //config: bool "times builtin"
270 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
272 //config:config HUSH_READ
273 //config: bool "read builtin"
275 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
277 //config:config HUSH_SET
278 //config: bool "set builtin"
280 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
282 //config:config HUSH_UNSET
283 //config: bool "unset builtin"
285 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
287 //config:config HUSH_ULIMIT
288 //config: bool "ulimit builtin"
290 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
292 //config:config HUSH_UMASK
293 //config: bool "umask builtin"
295 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
297 //config:config HUSH_GETOPTS
298 //config: bool "getopts builtin"
300 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
302 //config:config HUSH_MEMLEAK
303 //config: bool "memleak builtin (debugging)"
305 //config: depends on HUSH || SH_IS_HUSH || BASH_IS_HUSH
307 //applet:IF_HUSH(APPLET(hush, BB_DIR_BIN, BB_SUID_DROP))
308 // APPLET_ODDNAME:name main location suid_type help
309 //applet:IF_SH_IS_HUSH( APPLET_ODDNAME(sh, hush, BB_DIR_BIN, BB_SUID_DROP, hush))
310 //applet:IF_BASH_IS_HUSH(APPLET_ODDNAME(bash, hush, BB_DIR_BIN, BB_SUID_DROP, hush))
312 //kbuild:lib-$(CONFIG_HUSH) += hush.o match.o shell_common.o
313 //kbuild:lib-$(CONFIG_SH_IS_HUSH) += hush.o match.o shell_common.o
314 //kbuild:lib-$(CONFIG_BASH_IS_HUSH) += hush.o match.o shell_common.o
315 //kbuild:lib-$(CONFIG_HUSH_RANDOM_SUPPORT) += random.o
317 /* -i (interactive) and -s (read stdin) are also accepted,
318 * but currently do nothing, therefore aren't shown in help.
319 * NOMMU-specific options are not meant to be used by users,
320 * therefore we don't show them either.
322 //usage:#define hush_trivial_usage
323 //usage: "[-enxl] [-c 'SCRIPT' [ARG0 [ARGS]] / FILE [ARGS]]"
324 //usage:#define hush_full_usage "\n\n"
325 //usage: "Unix shell interpreter"
327 #if !(defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) \
328 || defined(__APPLE__) \
330 # include <malloc.h> /* for malloc_trim */
333 /* #include <dmalloc.h> */
335 # include <fnmatch.h>
337 #include <sys/times.h>
338 #include <sys/utsname.h> /* for setting $HOSTNAME */
340 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
342 #include "shell_common.h"
345 #if ENABLE_HUSH_RANDOM_SUPPORT
348 # define CLEAR_RANDOM_T(rnd) ((void)0)
350 #ifndef F_DUPFD_CLOEXEC
351 # define F_DUPFD_CLOEXEC F_DUPFD
354 # define PIPE_BUF 4096 /* amount of buffering in a pipe */
358 /* So far, all bash compat is controlled by one config option */
359 /* Separate defines document which part of code implements what */
360 #define BASH_PATTERN_SUBST ENABLE_HUSH_BASH_COMPAT
361 #define BASH_SUBSTR ENABLE_HUSH_BASH_COMPAT
362 #define BASH_SOURCE ENABLE_HUSH_BASH_COMPAT
363 #define BASH_HOSTNAME_VAR ENABLE_HUSH_BASH_COMPAT
364 #define BASH_TEST2 (ENABLE_HUSH_BASH_COMPAT && ENABLE_HUSH_TEST)
365 #define BASH_READ_D ENABLE_HUSH_BASH_COMPAT
369 #define LEAK_HUNTING 0
370 #define BUILD_AS_NOMMU 0
371 /* Enable/disable sanity checks. Ok to enable in production,
372 * only adds a bit of bloat. Set to >1 to get non-production level verbosity.
373 * Keeping 1 for now even in released versions.
376 /* Slightly bigger (+200 bytes), but faster hush.
377 * So far it only enables a trick with counting SIGCHLDs and forks,
378 * which allows us to do fewer waitpid's.
379 * (we can detect a case where neither forks were done nor SIGCHLDs happened
380 * and therefore waitpid will return the same result as last time)
382 #define ENABLE_HUSH_FAST 0
383 /* TODO: implement simplified code for users which do not need ${var%...} ops
384 * So far ${var%...} ops are always enabled:
386 #define ENABLE_HUSH_DOLLAR_OPS 1
391 # undef USE_FOR_NOMMU
394 # define USE_FOR_NOMMU(...) __VA_ARGS__
395 # define USE_FOR_MMU(...)
398 #include "NUM_APPLETS.h"
400 /* STANDALONE does not make sense, and won't compile */
401 # undef CONFIG_FEATURE_SH_STANDALONE
402 # undef ENABLE_FEATURE_SH_STANDALONE
403 # undef IF_FEATURE_SH_STANDALONE
404 # undef IF_NOT_FEATURE_SH_STANDALONE
405 # define ENABLE_FEATURE_SH_STANDALONE 0
406 # define IF_FEATURE_SH_STANDALONE(...)
407 # define IF_NOT_FEATURE_SH_STANDALONE(...) __VA_ARGS__
410 #if !ENABLE_HUSH_INTERACTIVE
411 # undef ENABLE_FEATURE_EDITING
412 # define ENABLE_FEATURE_EDITING 0
413 # undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
414 # define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
415 # undef ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
416 # define ENABLE_FEATURE_EDITING_SAVE_ON_EXIT 0
419 /* Do we support ANY keywords? */
420 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
421 # define HAS_KEYWORDS 1
422 # define IF_HAS_KEYWORDS(...) __VA_ARGS__
423 # define IF_HAS_NO_KEYWORDS(...)
425 # define HAS_KEYWORDS 0
426 # define IF_HAS_KEYWORDS(...)
427 # define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
430 /* If you comment out one of these below, it will be #defined later
431 * to perform debug printfs to stderr: */
432 #define debug_printf(...) do {} while (0)
433 /* Finer-grained debug switches */
434 #define debug_printf_parse(...) do {} while (0)
435 #define debug_print_tree(a, b) do {} while (0)
436 #define debug_printf_exec(...) do {} while (0)
437 #define debug_printf_env(...) do {} while (0)
438 #define debug_printf_jobs(...) do {} while (0)
439 #define debug_printf_expand(...) do {} while (0)
440 #define debug_printf_varexp(...) do {} while (0)
441 #define debug_printf_glob(...) do {} while (0)
442 #define debug_printf_redir(...) do {} while (0)
443 #define debug_printf_list(...) do {} while (0)
444 #define debug_printf_subst(...) do {} while (0)
445 #define debug_printf_clean(...) do {} while (0)
447 #define ERR_PTR ((void*)(long)1)
449 #define JOB_STATUS_FORMAT "[%u] %-22s %.40s\n"
451 #define _SPECIAL_VARS_STR "_*@$!?#"
452 #define SPECIAL_VARS_STR ("_*@$!?#" + 1)
453 #define NUMERIC_SPECVARS_STR ("_*@$!?#" + 3)
454 #if BASH_PATTERN_SUBST
455 /* Support / and // replace ops */
456 /* Note that // is stored as \ in "encoded" string representation */
457 # define VAR_ENCODED_SUBST_OPS "\\/%#:-=+?"
458 # define VAR_SUBST_OPS ("\\/%#:-=+?" + 1)
459 # define MINUS_PLUS_EQUAL_QUESTION ("\\/%#:-=+?" + 5)
461 # define VAR_ENCODED_SUBST_OPS "%#:-=+?"
462 # define VAR_SUBST_OPS "%#:-=+?"
463 # define MINUS_PLUS_EQUAL_QUESTION ("%#:-=+?" + 3)
466 #define SPECIAL_VAR_SYMBOL_STR "\3"
467 #define SPECIAL_VAR_SYMBOL 3
468 /* The "variable" with name "\1" emits string "\3". Testcase: "echo ^C" */
469 #define SPECIAL_VAR_QUOTED_SVS 1
473 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="BB_VER;
475 /* This supports saving pointers malloced in vfork child,
476 * to be freed in the parent.
479 typedef struct nommu_save_t {
481 struct variable *old_vars;
483 char **argv_from_re_execing;
496 #if ENABLE_HUSH_LOOPS
503 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
508 /* three pseudo-keywords support contrived "case" syntax: */
509 RES_CASE_IN, /* "case ... IN", turns into RES_MATCH when IN is observed */
510 RES_MATCH , /* "word)" */
511 RES_CASE_BODY, /* "this command is inside CASE" */
518 typedef struct o_string {
520 int length; /* position where data is appended */
523 /* At least some part of the string was inside '' or "",
524 * possibly empty one: word"", wo''rd etc. */
525 smallint has_quoted_part;
526 smallint has_empty_slot;
527 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
530 EXP_FLAG_SINGLEWORD = 0x80, /* must be 0x80 */
532 /* Protect newly added chars against globbing
533 * by prepending \ to *, ?, [, \ */
534 EXP_FLAG_ESC_GLOB_CHARS = 0x1,
537 MAYBE_ASSIGNMENT = 0,
538 DEFINITELY_ASSIGNMENT = 1,
540 /* Not an assignment, but next word may be: "if v=xyz cmd;" */
543 /* Used for initialization: o_string foo = NULL_O_STRING; */
544 #define NULL_O_STRING { NULL }
546 #ifndef debug_printf_parse
547 static const char *const assignment_flag[] = {
549 "DEFINITELY_ASSIGNMENT",
555 typedef struct in_str {
557 #if ENABLE_HUSH_INTERACTIVE
558 smallint promptmode; /* 0: PS1, 1: PS2 */
565 /* The descrip member of this structure is only used to make
566 * debugging output pretty */
567 static const struct {
569 signed char default_fd;
572 { O_RDONLY, 0, "<" },
573 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
574 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
575 { O_CREAT|O_RDWR, 1, "<>" },
576 { O_RDONLY, 0, "<<" },
577 /* Should not be needed. Bogus default_fd helps in debugging */
578 /* { O_RDONLY, 77, "<<" }, */
581 struct redir_struct {
582 struct redir_struct *next;
583 char *rd_filename; /* filename */
584 int rd_fd; /* fd to redirect */
585 /* fd to redirect to, or -3 if rd_fd is to be closed (n>&-) */
587 smallint rd_type; /* (enum redir_type) */
588 /* note: for heredocs, rd_filename contains heredoc delimiter,
589 * and subsequently heredoc itself; and rd_dup is a bitmask:
590 * bit 0: do we need to trim leading tabs?
591 * bit 1: is heredoc quoted (<<'delim' syntax) ?
594 typedef enum redir_type {
596 REDIRECT_OVERWRITE = 1,
599 REDIRECT_HEREDOC = 4,
600 REDIRECT_HEREDOC2 = 5, /* REDIRECT_HEREDOC after heredoc is loaded */
603 REDIRFD_SYNTAX_ERR = -2,
604 REDIRFD_TO_FILE = -1,
605 /* otherwise, rd_fd is redirected to rd_dup */
607 HEREDOC_SKIPTABS = 1,
613 pid_t pid; /* 0 if exited */
614 int assignment_cnt; /* how many argv[i] are assignments? */
615 smallint cmd_type; /* CMD_xxx */
617 #define CMD_SUBSHELL 1
619 /* used for "[[ EXPR ]]" */
620 # define CMD_SINGLEWORD_NOGLOB 2
622 #if ENABLE_HUSH_FUNCTIONS
623 # define CMD_FUNCDEF 3
626 smalluint cmd_exitcode;
627 /* if non-NULL, this "command" is { list }, ( list ), or a compound statement */
630 char *group_as_string;
632 #if ENABLE_HUSH_FUNCTIONS
633 struct function *child_func;
634 /* This field is used to prevent a bug here:
635 * while...do f1() {a;}; f1; f1() {b;}; f1; done
636 * When we execute "f1() {a;}" cmd, we create new function and clear
637 * cmd->group, cmd->group_as_string, cmd->argv[0].
638 * When we execute "f1() {b;}", we notice that f1 exists,
639 * and that its "parent cmd" struct is still "alive",
640 * we put those fields back into cmd->xxx
641 * (struct function has ->parent_cmd ptr to facilitate that).
642 * When we loop back, we can execute "f1() {a;}" again and set f1 correctly.
643 * Without this trick, loop would execute a;b;b;b;...
644 * instead of correct sequence a;b;a;b;...
645 * When command is freed, it severs the link
646 * (sets ->child_func->parent_cmd to NULL).
649 char **argv; /* command name and arguments */
650 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
651 * and on execution these are substituted with their values.
652 * Substitution can make _several_ words out of one argv[n]!
653 * Example: argv[0]=='.^C*^C.' here: echo .$*.
654 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
656 struct redir_struct *redirects; /* I/O redirections */
658 /* Is there anything in this command at all? */
659 #define IS_NULL_CMD(cmd) \
660 (!(cmd)->group && !(cmd)->argv && !(cmd)->redirects)
664 int num_cmds; /* total number of commands in pipe */
665 int alive_cmds; /* number of commands running (not exited) */
666 int stopped_cmds; /* number of commands alive, but stopped */
668 unsigned jobid; /* job number */
669 pid_t pgrp; /* process group ID for the job */
670 char *cmdtext; /* name of job */
672 struct command *cmds; /* array of commands in pipe */
673 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
674 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
675 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
677 typedef enum pipe_style {
683 /* Is there anything in this pipe at all? */
684 #define IS_NULL_PIPE(pi) \
685 ((pi)->num_cmds == 0 IF_HAS_KEYWORDS( && (pi)->res_word == RES_NONE))
687 /* This holds pointers to the various results of parsing */
688 struct parse_context {
689 /* linked list of pipes */
690 struct pipe *list_head;
691 /* last pipe (being constructed right now) */
693 /* last command in pipe (being constructed right now) */
694 struct command *command;
695 /* last redirect in command->redirects list */
696 struct redir_struct *pending_redirect;
702 smallint ctx_inverted; /* "! cmd | cmd" */
704 smallint ctx_dsemicolon; /* ";;" seen */
706 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
708 /* group we are enclosed in:
709 * example: "if pipe1; pipe2; then pipe3; fi"
710 * when we see "if" or "then", we malloc and copy current context,
711 * and make ->stack point to it. then we parse pipeN.
712 * when closing "then" / fi" / whatever is found,
713 * we move list_head into ->stack->command->group,
714 * copy ->stack into current context, and delete ->stack.
715 * (parsing of { list } and ( list ) doesn't use this method)
717 struct parse_context *stack;
721 /* On program start, environ points to initial environment.
722 * putenv adds new pointers into it, unsetenv removes them.
723 * Neither of these (de)allocates the strings.
724 * setenv allocates new strings in malloc space and does putenv,
725 * and thus setenv is unusable (leaky) for shell's purposes */
726 #define setenv(...) setenv_is_leaky_dont_use()
728 struct variable *next;
729 char *varstr; /* points to "name=" portion */
730 #if ENABLE_HUSH_LOCAL
731 unsigned func_nest_level;
733 int max_len; /* if > 0, name is part of initial env; else name is malloced */
734 smallint flg_export; /* putenv should be done on this var */
735 smallint flg_read_only;
743 #if ENABLE_HUSH_FUNCTIONS
745 struct function *next;
747 struct command *parent_cmd;
750 char *body_as_string;
756 /* set -/+o OPT support. (TODO: make it optional)
757 * bash supports the following opts:
768 * interactive-comments on
786 static const char o_opt_strings[] ALIGN1 =
790 #if ENABLE_HUSH_MODE_X
798 #if ENABLE_HUSH_MODE_X
806 struct FILE_list *next;
812 /* "Globals" within this file */
813 /* Sorted roughly by size (smaller offsets == smaller code) */
815 /* interactive_fd != 0 means we are an interactive shell.
816 * If we are, then saved_tty_pgrp can also be != 0, meaning
817 * that controlling tty is available. With saved_tty_pgrp == 0,
818 * job control still works, but terminal signals
819 * (^C, ^Z, ^Y, ^\) won't work at all, and background
820 * process groups can only be created with "cmd &".
821 * With saved_tty_pgrp != 0, hush will use tcsetpgrp()
822 * to give tty to the foreground process group,
823 * and will take it back when the group is stopped (^Z)
826 #if ENABLE_HUSH_INTERACTIVE
827 /* 'interactive_fd' is a fd# open to ctty, if we have one
828 * _AND_ if we decided to act interactively */
832 # define G_interactive_fd (G.interactive_fd)
834 # define G_interactive_fd 0
836 #if ENABLE_FEATURE_EDITING
837 line_input_t *line_input_state;
842 #if ENABLE_HUSH_RANDOM_SUPPORT
848 pid_t saved_tty_pgrp;
849 struct pipe *job_list;
850 # define G_saved_tty_pgrp (G.saved_tty_pgrp)
852 # define G_saved_tty_pgrp 0
854 /* How deeply are we in context where "set -e" is ignored */
856 /* "set -e" rules (do we follow them correctly?):
857 * Exit if pipe, list, or compound command exits with a non-zero status.
858 * Shell does not exit if failed command is part of condition in
859 * if/while, part of && or || list except the last command, any command
860 * in a pipe but the last, or if the command's return value is being
861 * inverted with !. If a compound command other than a subshell returns a
862 * non-zero status because a command failed while -e was being ignored, the
863 * shell does not exit. A trap on ERR, if set, is executed before the shell
864 * exits [ERR is a bashism].
866 * If a compound command or function executes in a context where -e is
867 * ignored, none of the commands executed within are affected by the -e
868 * setting. If a compound command or function sets -e while executing in a
869 * context where -e is ignored, that setting does not have any effect until
870 * the compound command or the command containing the function call completes.
873 char o_opt[NUM_OPT_O];
874 #if ENABLE_HUSH_MODE_X
875 # define G_x_mode (G.o_opt[OPT_O_XTRACE])
879 smallint flag_SIGINT;
880 #if ENABLE_HUSH_LOOPS
881 smallint flag_break_continue;
883 #if ENABLE_HUSH_FUNCTIONS
884 /* 0: outside of a function (or sourced file)
885 * -1: inside of a function, ok to use return builtin
886 * 1: return is invoked, skip all till end of func
888 smallint flag_return_in_progress;
889 # define G_flag_return_in_progress (G.flag_return_in_progress)
891 # define G_flag_return_in_progress 0
893 smallint exiting; /* used to prevent EXIT trap recursion */
894 /* These four support $?, $#, and $1 */
895 smalluint last_exitcode;
896 smalluint last_bg_pid_exitcode;
898 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
899 smalluint global_args_malloced;
900 # define G_global_args_malloced (G.global_args_malloced)
902 # define G_global_args_malloced 0
904 /* how many non-NULL argv's we have. NB: $# + 1 */
908 char *argv0_for_re_execing;
910 #if ENABLE_HUSH_LOOPS
911 unsigned depth_break_continue;
912 unsigned depth_of_loop;
914 #if ENABLE_HUSH_GETOPTS
915 unsigned getopt_count;
919 struct variable *top_var;
920 char **expanded_assignments;
921 #if ENABLE_HUSH_FUNCTIONS
922 struct function *top_func;
923 # if ENABLE_HUSH_LOCAL
924 struct variable **shadowed_vars_pp;
925 unsigned func_nest_level;
928 /* Signal and trap handling */
930 unsigned count_SIGCHLD;
931 unsigned handled_SIGCHLD;
932 smallint we_have_children;
934 struct FILE_list *FILE_list;
935 /* Which signals have non-DFL handler (even with no traps set)?
936 * Set at the start to:
937 * (SIGQUIT + maybe SPECIAL_INTERACTIVE_SIGS + maybe SPECIAL_JOBSTOP_SIGS)
938 * SPECIAL_INTERACTIVE_SIGS are cleared after fork.
939 * The rest is cleared right before execv syscalls.
940 * Other than these two times, never modified.
942 unsigned special_sig_mask;
944 unsigned fatal_sig_mask;
945 # define G_fatal_sig_mask (G.fatal_sig_mask)
947 # define G_fatal_sig_mask 0
950 char **traps; /* char *traps[NSIG] */
951 # define G_traps G.traps
953 # define G_traps ((char**)NULL)
955 sigset_t pending_set;
956 #if ENABLE_HUSH_MEMLEAK
957 unsigned long memleak_value;
963 #if ENABLE_FEATURE_EDITING
964 char user_input_buf[CONFIG_FEATURE_EDITING_MAX_LEN];
967 #define G (*ptr_to_globals)
968 /* Not #defining name to G.name - this quickly gets unwieldy
969 * (too many defines). Also, I actually prefer to see when a variable
970 * is global, thus "G." prefix is a useful hint */
971 #define INIT_G() do { \
972 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
973 /* memset(&G.sa, 0, sizeof(G.sa)); */ \
974 sigfillset(&G.sa.sa_mask); \
975 G.sa.sa_flags = SA_RESTART; \
979 /* Function prototypes for builtins */
980 static int builtin_cd(char **argv) FAST_FUNC;
982 static int builtin_echo(char **argv) FAST_FUNC;
984 static int builtin_eval(char **argv) FAST_FUNC;
985 static int builtin_exec(char **argv) FAST_FUNC;
986 static int builtin_exit(char **argv) FAST_FUNC;
987 #if ENABLE_HUSH_EXPORT
988 static int builtin_export(char **argv) FAST_FUNC;
990 #if ENABLE_HUSH_READONLY
991 static int builtin_readonly(char **argv) FAST_FUNC;
994 static int builtin_fg_bg(char **argv) FAST_FUNC;
995 static int builtin_jobs(char **argv) FAST_FUNC;
997 #if ENABLE_HUSH_GETOPTS
998 static int builtin_getopts(char **argv) FAST_FUNC;
1000 #if ENABLE_HUSH_HELP
1001 static int builtin_help(char **argv) FAST_FUNC;
1003 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
1004 static int builtin_history(char **argv) FAST_FUNC;
1006 #if ENABLE_HUSH_LOCAL
1007 static int builtin_local(char **argv) FAST_FUNC;
1009 #if ENABLE_HUSH_MEMLEAK
1010 static int builtin_memleak(char **argv) FAST_FUNC;
1012 #if ENABLE_HUSH_PRINTF
1013 static int builtin_printf(char **argv) FAST_FUNC;
1015 static int builtin_pwd(char **argv) FAST_FUNC;
1016 #if ENABLE_HUSH_READ
1017 static int builtin_read(char **argv) FAST_FUNC;
1020 static int builtin_set(char **argv) FAST_FUNC;
1022 static int builtin_shift(char **argv) FAST_FUNC;
1023 static int builtin_source(char **argv) FAST_FUNC;
1024 #if ENABLE_HUSH_TEST || BASH_TEST2
1025 static int builtin_test(char **argv) FAST_FUNC;
1027 #if ENABLE_HUSH_TRAP
1028 static int builtin_trap(char **argv) FAST_FUNC;
1030 #if ENABLE_HUSH_TYPE
1031 static int builtin_type(char **argv) FAST_FUNC;
1033 #if ENABLE_HUSH_TIMES
1034 static int builtin_times(char **argv) FAST_FUNC;
1036 static int builtin_true(char **argv) FAST_FUNC;
1037 #if ENABLE_HUSH_UMASK
1038 static int builtin_umask(char **argv) FAST_FUNC;
1040 #if ENABLE_HUSH_UNSET
1041 static int builtin_unset(char **argv) FAST_FUNC;
1043 #if ENABLE_HUSH_KILL
1044 static int builtin_kill(char **argv) FAST_FUNC;
1046 #if ENABLE_HUSH_WAIT
1047 static int builtin_wait(char **argv) FAST_FUNC;
1049 #if ENABLE_HUSH_LOOPS
1050 static int builtin_break(char **argv) FAST_FUNC;
1051 static int builtin_continue(char **argv) FAST_FUNC;
1053 #if ENABLE_HUSH_FUNCTIONS
1054 static int builtin_return(char **argv) FAST_FUNC;
1057 /* Table of built-in functions. They can be forked or not, depending on
1058 * context: within pipes, they fork. As simple commands, they do not.
1059 * When used in non-forking context, they can change global variables
1060 * in the parent shell process. If forked, of course they cannot.
1061 * For example, 'unset foo | whatever' will parse and run, but foo will
1062 * still be set at the end. */
1063 struct built_in_command {
1065 int (*b_function)(char **argv) FAST_FUNC;
1066 #if ENABLE_HUSH_HELP
1067 const char *b_descr;
1068 # define BLTIN(cmd, func, help) { cmd, func, help }
1070 # define BLTIN(cmd, func, help) { cmd, func }
1074 static const struct built_in_command bltins1[] = {
1075 BLTIN("." , builtin_source , "Run commands in file"),
1076 BLTIN(":" , builtin_true , NULL),
1078 BLTIN("bg" , builtin_fg_bg , "Resume job in background"),
1080 #if ENABLE_HUSH_LOOPS
1081 BLTIN("break" , builtin_break , "Exit loop"),
1083 BLTIN("cd" , builtin_cd , "Change directory"),
1084 #if ENABLE_HUSH_LOOPS
1085 BLTIN("continue" , builtin_continue, "Start new loop iteration"),
1087 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
1088 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
1089 BLTIN("exit" , builtin_exit , NULL),
1090 #if ENABLE_HUSH_EXPORT
1091 BLTIN("export" , builtin_export , "Set environment variables"),
1094 BLTIN("fg" , builtin_fg_bg , "Bring job to foreground"),
1096 #if ENABLE_HUSH_GETOPTS
1097 BLTIN("getopts" , builtin_getopts , NULL),
1099 #if ENABLE_HUSH_HELP
1100 BLTIN("help" , builtin_help , NULL),
1102 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
1103 BLTIN("history" , builtin_history , "Show history"),
1106 BLTIN("jobs" , builtin_jobs , "List jobs"),
1108 #if ENABLE_HUSH_KILL
1109 BLTIN("kill" , builtin_kill , "Send signals to processes"),
1111 #if ENABLE_HUSH_LOCAL
1112 BLTIN("local" , builtin_local , "Set local variables"),
1114 #if ENABLE_HUSH_MEMLEAK
1115 BLTIN("memleak" , builtin_memleak , NULL),
1117 #if ENABLE_HUSH_READ
1118 BLTIN("read" , builtin_read , "Input into variable"),
1120 #if ENABLE_HUSH_READONLY
1121 BLTIN("readonly" , builtin_readonly, "Make variables read-only"),
1123 #if ENABLE_HUSH_FUNCTIONS
1124 BLTIN("return" , builtin_return , "Return from function"),
1127 BLTIN("set" , builtin_set , "Set positional parameters"),
1129 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
1131 BLTIN("source" , builtin_source , NULL),
1133 #if ENABLE_HUSH_TIMES
1134 BLTIN("times" , builtin_times , NULL),
1136 #if ENABLE_HUSH_TRAP
1137 BLTIN("trap" , builtin_trap , "Trap signals"),
1139 BLTIN("true" , builtin_true , NULL),
1140 #if ENABLE_HUSH_TYPE
1141 BLTIN("type" , builtin_type , "Show command type"),
1143 #if ENABLE_HUSH_ULIMIT
1144 BLTIN("ulimit" , shell_builtin_ulimit, "Control resource limits"),
1146 #if ENABLE_HUSH_UMASK
1147 BLTIN("umask" , builtin_umask , "Set file creation mask"),
1149 #if ENABLE_HUSH_UNSET
1150 BLTIN("unset" , builtin_unset , "Unset variables"),
1152 #if ENABLE_HUSH_WAIT
1153 BLTIN("wait" , builtin_wait , "Wait for process to finish"),
1156 /* These builtins won't be used if we are on NOMMU and need to re-exec
1157 * (it's cheaper to run an external program in this case):
1159 static const struct built_in_command bltins2[] = {
1160 #if ENABLE_HUSH_TEST
1161 BLTIN("[" , builtin_test , NULL),
1164 BLTIN("[[" , builtin_test , NULL),
1166 #if ENABLE_HUSH_ECHO
1167 BLTIN("echo" , builtin_echo , NULL),
1169 #if ENABLE_HUSH_PRINTF
1170 BLTIN("printf" , builtin_printf , NULL),
1172 BLTIN("pwd" , builtin_pwd , NULL),
1173 #if ENABLE_HUSH_TEST
1174 BLTIN("test" , builtin_test , NULL),
1182 /* prevent disasters with G.debug_indent < 0 */
1183 # define indent() fdprintf(2, "%*s", (G.debug_indent * 2) & 0xff, "")
1184 # define debug_enter() (G.debug_indent++)
1185 # define debug_leave() (G.debug_indent--)
1187 # define indent() ((void)0)
1188 # define debug_enter() ((void)0)
1189 # define debug_leave() ((void)0)
1192 #ifndef debug_printf
1193 # define debug_printf(...) (indent(), fdprintf(2, __VA_ARGS__))
1196 #ifndef debug_printf_parse
1197 # define debug_printf_parse(...) (indent(), fdprintf(2, __VA_ARGS__))
1200 #ifndef debug_printf_exec
1201 #define debug_printf_exec(...) (indent(), fdprintf(2, __VA_ARGS__))
1204 #ifndef debug_printf_env
1205 # define debug_printf_env(...) (indent(), fdprintf(2, __VA_ARGS__))
1208 #ifndef debug_printf_jobs
1209 # define debug_printf_jobs(...) (indent(), fdprintf(2, __VA_ARGS__))
1210 # define DEBUG_JOBS 1
1212 # define DEBUG_JOBS 0
1215 #ifndef debug_printf_expand
1216 # define debug_printf_expand(...) (indent(), fdprintf(2, __VA_ARGS__))
1217 # define DEBUG_EXPAND 1
1219 # define DEBUG_EXPAND 0
1222 #ifndef debug_printf_varexp
1223 # define debug_printf_varexp(...) (indent(), fdprintf(2, __VA_ARGS__))
1226 #ifndef debug_printf_glob
1227 # define debug_printf_glob(...) (indent(), fdprintf(2, __VA_ARGS__))
1228 # define DEBUG_GLOB 1
1230 # define DEBUG_GLOB 0
1233 #ifndef debug_printf_redir
1234 # define debug_printf_redir(...) (indent(), fdprintf(2, __VA_ARGS__))
1237 #ifndef debug_printf_list
1238 # define debug_printf_list(...) (indent(), fdprintf(2, __VA_ARGS__))
1241 #ifndef debug_printf_subst
1242 # define debug_printf_subst(...) (indent(), fdprintf(2, __VA_ARGS__))
1245 #ifndef debug_printf_clean
1246 # define debug_printf_clean(...) (indent(), fdprintf(2, __VA_ARGS__))
1247 # define DEBUG_CLEAN 1
1249 # define DEBUG_CLEAN 0
1253 static void debug_print_strings(const char *prefix, char **vv)
1256 fdprintf(2, "%s:\n", prefix);
1258 fdprintf(2, " '%s'\n", *vv++);
1261 # define debug_print_strings(prefix, vv) ((void)0)
1265 /* Leak hunting. Use hush_leaktool.sh for post-processing.
1268 static void *xxmalloc(int lineno, size_t size)
1270 void *ptr = xmalloc((size + 0xff) & ~0xff);
1271 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
1274 static void *xxrealloc(int lineno, void *ptr, size_t size)
1276 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
1277 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
1280 static char *xxstrdup(int lineno, const char *str)
1282 char *ptr = xstrdup(str);
1283 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
1286 static void xxfree(void *ptr)
1288 fdprintf(2, "free %p\n", ptr);
1291 # define xmalloc(s) xxmalloc(__LINE__, s)
1292 # define xrealloc(p, s) xxrealloc(__LINE__, p, s)
1293 # define xstrdup(s) xxstrdup(__LINE__, s)
1294 # define free(p) xxfree(p)
1298 /* Syntax and runtime errors. They always abort scripts.
1299 * In interactive use they usually discard unparsed and/or unexecuted commands
1300 * and return to the prompt.
1301 * HUSH_DEBUG >= 2 prints line number in this file where it was detected.
1304 # define msg_and_die_if_script(lineno, ...) msg_and_die_if_script(__VA_ARGS__)
1305 # define syntax_error(lineno, msg) syntax_error(msg)
1306 # define syntax_error_at(lineno, msg) syntax_error_at(msg)
1307 # define syntax_error_unterm_ch(lineno, ch) syntax_error_unterm_ch(ch)
1308 # define syntax_error_unterm_str(lineno, s) syntax_error_unterm_str(s)
1309 # define syntax_error_unexpected_ch(lineno, ch) syntax_error_unexpected_ch(ch)
1312 static void die_if_script(void)
1314 if (!G_interactive_fd) {
1315 if (G.last_exitcode) /* sometines it's 2, not 1 (bash compat) */
1316 xfunc_error_retval = G.last_exitcode;
1321 static void msg_and_die_if_script(unsigned lineno, const char *fmt, ...)
1326 bb_error_msg("hush.c:%u", lineno);
1329 bb_verror_msg(fmt, p, NULL);
1334 static void syntax_error(unsigned lineno UNUSED_PARAM, const char *msg)
1337 bb_error_msg("syntax error: %s", msg);
1339 bb_error_msg("syntax error");
1343 static void syntax_error_at(unsigned lineno UNUSED_PARAM, const char *msg)
1345 bb_error_msg("syntax error at '%s'", msg);
1349 static void syntax_error_unterm_str(unsigned lineno UNUSED_PARAM, const char *s)
1351 bb_error_msg("syntax error: unterminated %s", s);
1352 //? source4.tests fails: in bash, echo ${^} in script does not terminate the script
1356 static void syntax_error_unterm_ch(unsigned lineno, char ch)
1358 char msg[2] = { ch, '\0' };
1359 syntax_error_unterm_str(lineno, msg);
1362 static void syntax_error_unexpected_ch(unsigned lineno UNUSED_PARAM, int ch)
1368 bb_error_msg("hush.c:%u", lineno);
1370 bb_error_msg("syntax error: unexpected %s", ch == EOF ? "EOF" : msg);
1375 # undef msg_and_die_if_script
1376 # undef syntax_error
1377 # undef syntax_error_at
1378 # undef syntax_error_unterm_ch
1379 # undef syntax_error_unterm_str
1380 # undef syntax_error_unexpected_ch
1382 # define msg_and_die_if_script(...) msg_and_die_if_script(__LINE__, __VA_ARGS__)
1383 # define syntax_error(msg) syntax_error(__LINE__, msg)
1384 # define syntax_error_at(msg) syntax_error_at(__LINE__, msg)
1385 # define syntax_error_unterm_ch(ch) syntax_error_unterm_ch(__LINE__, ch)
1386 # define syntax_error_unterm_str(s) syntax_error_unterm_str(__LINE__, s)
1387 # define syntax_error_unexpected_ch(ch) syntax_error_unexpected_ch(__LINE__, ch)
1391 #if ENABLE_HUSH_INTERACTIVE
1392 static void cmdedit_update_prompt(void);
1394 # define cmdedit_update_prompt() ((void)0)
1398 /* Utility functions
1400 /* Replace each \x with x in place, return ptr past NUL. */
1401 static char *unbackslash(char *src)
1403 char *dst = src = strchrnul(src, '\\');
1407 if ((*dst++ = *src++) == '\0')
1413 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
1434 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
1435 v[count1 + count2] = NULL;
1438 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
1442 static char **xx_add_strings_to_strings(int lineno, char **strings, char **add, int need_to_dup)
1444 char **ptr = add_strings_to_strings(strings, add, need_to_dup);
1445 fdprintf(2, "line %d: add_strings_to_strings %p\n", lineno, ptr);
1448 #define add_strings_to_strings(strings, add, need_to_dup) \
1449 xx_add_strings_to_strings(__LINE__, strings, add, need_to_dup)
1452 /* Note: takes ownership of "add" ptr (it is not strdup'ed) */
1453 static char **add_string_to_strings(char **strings, char *add)
1458 return add_strings_to_strings(strings, v, /*dup:*/ 0);
1461 static char **xx_add_string_to_strings(int lineno, char **strings, char *add)
1463 char **ptr = add_string_to_strings(strings, add);
1464 fdprintf(2, "line %d: add_string_to_strings %p\n", lineno, ptr);
1467 #define add_string_to_strings(strings, add) \
1468 xx_add_string_to_strings(__LINE__, strings, add)
1471 static void free_strings(char **strings)
1485 static int fcntl_F_DUPFD(int fd, int avoid_fd)
1489 newfd = fcntl(fd, F_DUPFD, avoid_fd + 1);
1499 static int xdup_CLOEXEC_and_close(int fd, int avoid_fd)
1503 newfd = fcntl(fd, F_DUPFD_CLOEXEC, avoid_fd + 1);
1509 /* fd was not open? */
1514 if (F_DUPFD_CLOEXEC == F_DUPFD) /* if old libc (w/o F_DUPFD_CLOEXEC) */
1515 fcntl(newfd, F_SETFD, FD_CLOEXEC);
1521 /* Manipulating the list of open FILEs */
1522 static FILE *remember_FILE(FILE *fp)
1525 struct FILE_list *n = xmalloc(sizeof(*n));
1526 n->next = G.FILE_list;
1530 close_on_exec_on(n->fd);
1534 static void fclose_and_forget(FILE *fp)
1536 struct FILE_list **pp = &G.FILE_list;
1538 struct FILE_list *cur = *pp;
1539 if (cur->fp == fp) {
1548 static int save_FILEs_on_redirect(int fd, int avoid_fd)
1550 struct FILE_list *fl = G.FILE_list;
1553 /* We use it only on script files, they are all CLOEXEC */
1554 fl->fd = xdup_CLOEXEC_and_close(fd, avoid_fd);
1555 debug_printf_redir("redirect_fd %d: matches a script fd, moving it to %d\n", fd, fl->fd);
1562 static void restore_redirected_FILEs(void)
1564 struct FILE_list *fl = G.FILE_list;
1566 int should_be = fileno(fl->fp);
1567 if (fl->fd != should_be) {
1568 debug_printf_redir("restoring script fd from %d to %d\n", fl->fd, should_be);
1569 xmove_fd(fl->fd, should_be);
1575 #if ENABLE_FEATURE_SH_STANDALONE && BB_MMU
1576 static void close_all_FILE_list(void)
1578 struct FILE_list *fl = G.FILE_list;
1580 /* fclose would also free FILE object.
1581 * It is disastrous if we share memory with a vforked parent.
1582 * I'm not sure we never come here after vfork.
1583 * Therefore just close fd, nothing more.
1585 /*fclose(fl->fp); - unsafe */
1591 static int fd_in_FILEs(int fd)
1593 struct FILE_list *fl = G.FILE_list;
1603 /* Helpers for setting new $n and restoring them back
1605 typedef struct save_arg_t {
1609 IF_HUSH_SET(smallint sv_g_malloced;)
1612 static void save_and_replace_G_args(save_arg_t *sv, char **argv)
1614 sv->sv_argv0 = argv[0];
1615 sv->sv_g_argv = G.global_argv;
1616 sv->sv_g_argc = G.global_argc;
1617 IF_HUSH_SET(sv->sv_g_malloced = G.global_args_malloced;)
1619 argv[0] = G.global_argv[0]; /* retain $0 */
1620 G.global_argv = argv;
1621 IF_HUSH_SET(G.global_args_malloced = 0;)
1623 G.global_argc = 1 + string_array_len(argv + 1);
1626 static void restore_G_args(save_arg_t *sv, char **argv)
1629 if (G.global_args_malloced) {
1630 /* someone ran "set -- arg1 arg2 ...", undo */
1631 char **pp = G.global_argv;
1632 while (*++pp) /* note: does not free $0 */
1634 free(G.global_argv);
1637 argv[0] = sv->sv_argv0;
1638 G.global_argv = sv->sv_g_argv;
1639 G.global_argc = sv->sv_g_argc;
1640 IF_HUSH_SET(G.global_args_malloced = sv->sv_g_malloced;)
1644 /* Basic theory of signal handling in shell
1645 * ========================================
1646 * This does not describe what hush does, rather, it is current understanding
1647 * what it _should_ do. If it doesn't, it's a bug.
1648 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
1650 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
1651 * is finished or backgrounded. It is the same in interactive and
1652 * non-interactive shells, and is the same regardless of whether
1653 * a user trap handler is installed or a shell special one is in effect.
1654 * ^C or ^Z from keyboard seems to execute "at once" because it usually
1655 * backgrounds (i.e. stops) or kills all members of currently running
1658 * Wait builtin is interruptible by signals for which user trap is set
1659 * or by SIGINT in interactive shell.
1661 * Trap handlers will execute even within trap handlers. (right?)
1663 * User trap handlers are forgotten when subshell ("(cmd)") is entered,
1664 * except for handlers set to '' (empty string).
1666 * If job control is off, backgrounded commands ("cmd &")
1667 * have SIGINT, SIGQUIT set to SIG_IGN.
1669 * Commands which are run in command substitution ("`cmd`")
1670 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
1672 * Ordinary commands have signals set to SIG_IGN/DFL as inherited
1673 * by the shell from its parent.
1675 * Signals which differ from SIG_DFL action
1676 * (note: child (i.e., [v]forked) shell is not an interactive shell):
1679 * SIGTERM (interactive): ignore
1680 * SIGHUP (interactive):
1681 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
1682 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
1683 * Note that ^Z is handled not by trapping SIGTSTP, but by seeing
1684 * that all pipe members are stopped. Try this in bash:
1685 * while :; do :; done - ^Z does not background it
1686 * (while :; do :; done) - ^Z backgrounds it
1687 * SIGINT (interactive): wait for last pipe, ignore the rest
1688 * of the command line, show prompt. NB: ^C does not send SIGINT
1689 * to interactive shell while shell is waiting for a pipe,
1690 * since shell is bg'ed (is not in foreground process group).
1691 * Example 1: this waits 5 sec, but does not execute ls:
1692 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
1693 * Example 2: this does not wait and does not execute ls:
1694 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
1695 * Example 3: this does not wait 5 sec, but executes ls:
1696 * "sleep 5; ls -l" + press ^C
1697 * Example 4: this does not wait and does not execute ls:
1698 * "sleep 5 & wait; ls -l" + press ^C
1700 * (What happens to signals which are IGN on shell start?)
1701 * (What happens with signal mask on shell start?)
1703 * Old implementation
1704 * ==================
1705 * We use in-kernel pending signal mask to determine which signals were sent.
1706 * We block all signals which we don't want to take action immediately,
1707 * i.e. we block all signals which need to have special handling as described
1708 * above, and all signals which have traps set.
1709 * After each pipe execution, we extract any pending signals via sigtimedwait()
1712 * unsigned special_sig_mask: a mask of such "special" signals
1713 * sigset_t blocked_set: current blocked signal set
1716 * clear bit in blocked_set unless it is also in special_sig_mask
1717 * "trap 'cmd' SIGxxx":
1718 * set bit in blocked_set (even if 'cmd' is '')
1719 * after [v]fork, if we plan to be a shell:
1720 * unblock signals with special interactive handling
1721 * (child shell is not interactive),
1722 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1723 * after [v]fork, if we plan to exec:
1724 * POSIX says fork clears pending signal mask in child - no need to clear it.
1725 * Restore blocked signal set to one inherited by shell just prior to exec.
1727 * Note: as a result, we do not use signal handlers much. The only uses
1728 * are to count SIGCHLDs
1729 * and to restore tty pgrp on signal-induced exit.
1732 * Standard says "When a subshell is entered, traps that are not being ignored
1733 * are set to the default actions". bash interprets it so that traps which
1734 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1736 * Problem: the above approach makes it unwieldy to catch signals while
1737 * we are in read builtin, or while we read commands from stdin:
1738 * masked signals are not visible!
1740 * New implementation
1741 * ==================
1742 * We record each signal we are interested in by installing signal handler
1743 * for them - a bit like emulating kernel pending signal mask in userspace.
1744 * We are interested in: signals which need to have special handling
1745 * as described above, and all signals which have traps set.
1746 * Signals are recorded in pending_set.
1747 * After each pipe execution, we extract any pending signals
1750 * unsigned special_sig_mask: a mask of shell-special signals.
1751 * unsigned fatal_sig_mask: a mask of signals on which we restore tty pgrp.
1752 * char *traps[sig] if trap for sig is set (even if it's '').
1753 * sigset_t pending_set: set of sigs we received.
1756 * if sig is in special_sig_mask, set handler back to:
1757 * record_pending_signo, or to IGN if it's a tty stop signal
1758 * if sig is in fatal_sig_mask, set handler back to sigexit.
1759 * else: set handler back to SIG_DFL
1760 * "trap 'cmd' SIGxxx":
1761 * set handler to record_pending_signo.
1763 * set handler to SIG_IGN.
1764 * after [v]fork, if we plan to be a shell:
1765 * set signals with special interactive handling to SIG_DFL
1766 * (because child shell is not interactive),
1767 * unset all traps except '' (note: regardless of child shell's type - {}, (), etc)
1768 * after [v]fork, if we plan to exec:
1769 * POSIX says fork clears pending signal mask in child - no need to clear it.
1771 * To make wait builtin interruptible, we handle SIGCHLD as special signal,
1772 * otherwise (if we leave it SIG_DFL) sigsuspend in wait builtin will not wake up on it.
1775 * Standard says "When a subshell is entered, traps that are not being ignored
1776 * are set to the default actions". bash interprets it so that traps which
1777 * are set to '' (ignore) are NOT reset to defaults. We do the same.
1780 SPECIAL_INTERACTIVE_SIGS = 0
1785 SPECIAL_JOBSTOP_SIGS = 0
1794 static void record_pending_signo(int sig)
1796 sigaddset(&G.pending_set, sig);
1797 #if ENABLE_HUSH_FAST
1798 if (sig == SIGCHLD) {
1800 //bb_error_msg("[%d] SIGCHLD_handler: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
1805 static sighandler_t install_sighandler(int sig, sighandler_t handler)
1807 struct sigaction old_sa;
1809 /* We could use signal() to install handlers... almost:
1810 * except that we need to mask ALL signals while handlers run.
1811 * I saw signal nesting in strace, race window isn't small.
1812 * SA_RESTART is also needed, but in Linux, signal()
1813 * sets SA_RESTART too.
1815 /* memset(&G.sa, 0, sizeof(G.sa)); - already done */
1816 /* sigfillset(&G.sa.sa_mask); - already done */
1817 /* G.sa.sa_flags = SA_RESTART; - already done */
1818 G.sa.sa_handler = handler;
1819 sigaction(sig, &G.sa, &old_sa);
1820 return old_sa.sa_handler;
1823 static void hush_exit(int exitcode) NORETURN;
1825 static void restore_ttypgrp_and__exit(void) NORETURN;
1826 static void restore_ttypgrp_and__exit(void)
1828 /* xfunc has failed! die die die */
1829 /* no EXIT traps, this is an escape hatch! */
1831 hush_exit(xfunc_error_retval);
1836 /* Needed only on some libc:
1837 * It was observed that on exit(), fgetc'ed buffered data
1838 * gets "unwound" via lseek(fd, -NUM, SEEK_CUR).
1839 * With the net effect that even after fork(), not vfork(),
1840 * exit() in NOEXECed applet in "sh SCRIPT":
1841 * noexec_applet_here
1842 * echo END_OF_SCRIPT
1843 * lseeks fd in input FILE object from EOF to "e" in "echo END_OF_SCRIPT".
1844 * This makes "echo END_OF_SCRIPT" executed twice.
1845 * Similar problems can be seen with msg_and_die_if_script() -> xfunc_die()
1846 * and in `cmd` handling.
1847 * If set as die_func(), this makes xfunc_die() exit via _exit(), not exit():
1849 static void fflush_and__exit(void) NORETURN;
1850 static void fflush_and__exit(void)
1853 _exit(xfunc_error_retval);
1856 /* After [v]fork, in child: do not restore tty pgrp on xfunc death */
1857 # define disable_restore_tty_pgrp_on_exit() (die_func = fflush_and__exit)
1858 /* After [v]fork, in parent: restore tty pgrp on xfunc death */
1859 # define enable_restore_tty_pgrp_on_exit() (die_func = restore_ttypgrp_and__exit)
1861 /* Restores tty foreground process group, and exits.
1862 * May be called as signal handler for fatal signal
1863 * (will resend signal to itself, producing correct exit state)
1864 * or called directly with -EXITCODE.
1865 * We also call it if xfunc is exiting.
1867 static void sigexit(int sig) NORETURN;
1868 static void sigexit(int sig)
1870 /* Careful: we can end up here after [v]fork. Do not restore
1871 * tty pgrp then, only top-level shell process does that */
1872 if (G_saved_tty_pgrp && getpid() == G.root_pid) {
1873 /* Disable all signals: job control, SIGPIPE, etc.
1874 * Mostly paranoid measure, to prevent infinite SIGTTOU.
1876 sigprocmask_allsigs(SIG_BLOCK);
1877 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
1880 /* Not a signal, just exit */
1884 kill_myself_with_sig(sig); /* does not return */
1888 # define disable_restore_tty_pgrp_on_exit() ((void)0)
1889 # define enable_restore_tty_pgrp_on_exit() ((void)0)
1893 static sighandler_t pick_sighandler(unsigned sig)
1895 sighandler_t handler = SIG_DFL;
1896 if (sig < sizeof(unsigned)*8) {
1897 unsigned sigmask = (1 << sig);
1901 if (G_fatal_sig_mask & sigmask)
1905 /* sig has special handling? */
1906 if (G.special_sig_mask & sigmask) {
1907 handler = record_pending_signo;
1908 /* TTIN/TTOU/TSTP can't be set to record_pending_signo
1909 * in order to ignore them: they will be raised
1910 * in an endless loop when we try to do some
1911 * terminal ioctls! We do have to _ignore_ these.
1913 if (SPECIAL_JOBSTOP_SIGS & sigmask)
1920 /* Restores tty foreground process group, and exits. */
1921 static void hush_exit(int exitcode)
1923 #if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1924 save_history(G.line_input_state);
1928 if (G.exiting <= 0 && G_traps && G_traps[0] && G_traps[0][0]) {
1930 /* argv[0] is unused */
1931 argv[1] = G_traps[0];
1933 G.exiting = 1; /* prevent EXIT trap recursion */
1934 /* Note: G_traps[0] is not cleared!
1935 * "trap" will still show it, if executed
1940 #if ENABLE_FEATURE_CLEAN_UP
1942 struct variable *cur_var;
1943 if (G.cwd != bb_msg_unknown)
1945 cur_var = G.top_var;
1947 struct variable *tmp = cur_var;
1948 if (!cur_var->max_len)
1949 free(cur_var->varstr);
1950 cur_var = cur_var->next;
1958 sigexit(- (exitcode & 0xff));
1965 //TODO: return a mask of ALL handled sigs?
1966 static int check_and_run_traps(void)
1973 if (sigisemptyset(&G.pending_set))
1978 if (sigismember(&G.pending_set, sig)) {
1979 sigdelset(&G.pending_set, sig);
1982 } while (sig < NSIG);
1985 if (G_traps && G_traps[sig]) {
1986 debug_printf_exec("%s: sig:%d handler:'%s'\n", __func__, sig, G.traps[sig]);
1987 if (G_traps[sig][0]) {
1988 /* We have user-defined handler */
1989 smalluint save_rcode;
1991 /* argv[0] is unused */
1992 argv[1] = G_traps[sig];
1994 save_rcode = G.last_exitcode;
1996 //FIXME: shouldn't it be set to 128 + sig instead?
1997 G.last_exitcode = save_rcode;
1999 } /* else: "" trap, ignoring signal */
2002 /* not a trap: special action */
2005 debug_printf_exec("%s: sig:%d default SIGINT handler\n", __func__, sig);
2011 //TODO: why are we doing this? ash and dash don't do this,
2012 //they have no handler for SIGHUP at all,
2013 //they rely on kernel to send SIGHUP+SIGCONT to orphaned process groups
2015 debug_printf_exec("%s: sig:%d default SIGHUP handler\n", __func__, sig);
2016 /* bash is observed to signal whole process groups,
2017 * not individual processes */
2018 for (job = G.job_list; job; job = job->next) {
2021 debug_printf_exec("HUPing pgrp %d\n", job->pgrp);
2022 if (kill(- job->pgrp, SIGHUP) == 0)
2023 kill(- job->pgrp, SIGCONT);
2028 #if ENABLE_HUSH_FAST
2030 debug_printf_exec("%s: sig:%d default SIGCHLD handler\n", __func__, sig);
2032 //bb_error_msg("[%d] check_and_run_traps: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
2034 * We don't do 'last_sig = sig' here -> NOT returning this sig.
2035 * This simplifies wait builtin a bit.
2039 default: /* ignored: */
2040 debug_printf_exec("%s: sig:%d default handling is to ignore\n", __func__, sig);
2041 /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
2043 * We don't do 'last_sig = sig' here -> NOT returning this sig.
2044 * Example: wait is not interrupted by TERM
2045 * in interactive shell, because TERM is ignored.
2054 static const char *get_cwd(int force)
2056 if (force || G.cwd == NULL) {
2057 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
2058 * we must not try to free(bb_msg_unknown) */
2059 if (G.cwd == bb_msg_unknown)
2061 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
2063 G.cwd = bb_msg_unknown;
2070 * Shell and environment variable support
2072 static struct variable **get_ptr_to_local_var(const char *name, unsigned len)
2074 struct variable **pp;
2075 struct variable *cur;
2078 while ((cur = *pp) != NULL) {
2079 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
2086 static const char* FAST_FUNC get_local_var_value(const char *name)
2088 struct variable **vpp;
2089 unsigned len = strlen(name);
2091 if (G.expanded_assignments) {
2092 char **cpp = G.expanded_assignments;
2095 if (strncmp(cp, name, len) == 0 && cp[len] == '=')
2096 return cp + len + 1;
2101 vpp = get_ptr_to_local_var(name, len);
2103 return (*vpp)->varstr + len + 1;
2105 if (strcmp(name, "PPID") == 0)
2106 return utoa(G.root_ppid);
2107 // bash compat: UID? EUID?
2108 #if ENABLE_HUSH_RANDOM_SUPPORT
2109 if (strcmp(name, "RANDOM") == 0)
2110 return utoa(next_random(&G.random_gen));
2115 /* str holds "NAME=VAL" and is expected to be malloced.
2116 * We take ownership of it.
2118 #define SETFLAG_EXPORT (1 << 0)
2119 #define SETFLAG_UNEXPORT (1 << 1)
2120 #define SETFLAG_MAKE_RO (1 << 2)
2121 #define SETFLAG_LOCAL_SHIFT 3
2122 static int set_local_var(char *str, unsigned flags)
2124 struct variable **var_pp;
2125 struct variable *cur;
2126 char *free_me = NULL;
2129 IF_HUSH_LOCAL(unsigned local_lvl = (flags >> SETFLAG_LOCAL_SHIFT);)
2131 eq_sign = strchr(str, '=');
2132 if (!eq_sign) { /* not expected to ever happen? */
2137 name_len = eq_sign - str + 1; /* including '=' */
2138 var_pp = &G.top_var;
2139 while ((cur = *var_pp) != NULL) {
2140 if (strncmp(cur->varstr, str, name_len) != 0) {
2141 var_pp = &cur->next;
2145 /* We found an existing var with this name */
2146 if (cur->flg_read_only) {
2147 bb_error_msg("%s: readonly variable", str);
2149 //NOTE: in bash, assignment in "export READONLY_VAR=Z" fails, and sets $?=1,
2150 //but export per se succeeds (does put the var in env). We don't mimic that.
2153 if (flags & SETFLAG_UNEXPORT) { // && cur->flg_export ?
2154 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
2159 #if ENABLE_HUSH_LOCAL
2160 if (cur->func_nest_level < local_lvl) {
2161 /* New variable is declared as local,
2162 * and existing one is global, or local
2163 * from enclosing function.
2164 * Remove and save old one: */
2165 *var_pp = cur->next;
2166 cur->next = *G.shadowed_vars_pp;
2167 *G.shadowed_vars_pp = cur;
2168 /* bash 3.2.33(1) and exported vars:
2170 * # f() { local z=a; env | grep ^z; }
2176 if (cur->flg_export)
2177 flags |= SETFLAG_EXPORT;
2181 if (strcmp(cur->varstr + name_len, eq_sign + 1) == 0) {
2186 if (cur->max_len != 0) {
2187 if (cur->max_len >= strlen(str)) {
2188 /* This one is from startup env, reuse space */
2189 strcpy(cur->varstr, str);
2194 goto set_str_and_exp;
2196 /* max_len == 0 signifies "malloced" var, which we can
2197 * (and have to) free. But we can't free(cur->varstr) here:
2198 * if cur->flg_export is 1, it is in the environment.
2199 * We should either unsetenv+free, or wait until putenv,
2200 * then putenv(new)+free(old).
2202 free_me = cur->varstr;
2203 goto set_str_and_exp;
2206 /* Not found - create new variable struct */
2207 cur = xzalloc(sizeof(*cur));
2208 IF_HUSH_LOCAL(cur->func_nest_level = local_lvl;)
2209 cur->next = *var_pp;
2215 #if !BB_MMU || ENABLE_HUSH_READONLY
2216 if (flags & SETFLAG_MAKE_RO) {
2217 cur->flg_read_only = 1;
2220 if (flags & SETFLAG_EXPORT)
2221 cur->flg_export = 1;
2222 if (name_len == 4 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
2223 cmdedit_update_prompt();
2224 #if ENABLE_HUSH_GETOPTS
2225 /* defoptindvar is a "OPTIND=..." constant string */
2226 if (strncmp(cur->varstr, defoptindvar, 7) == 0)
2229 if (cur->flg_export) {
2230 if (flags & SETFLAG_UNEXPORT) {
2231 cur->flg_export = 0;
2232 /* unsetenv was already done */
2235 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
2236 i = putenv(cur->varstr);
2237 /* only now we can free old exported malloced string */
2246 /* Used at startup and after each cd */
2247 static void set_pwd_var(unsigned flag)
2249 set_local_var(xasprintf("PWD=%s", get_cwd(/*force:*/ 1)), flag);
2252 static int unset_local_var_len(const char *name, int name_len)
2254 struct variable *cur;
2255 struct variable **var_pp;
2258 return EXIT_SUCCESS;
2259 #if ENABLE_HUSH_GETOPTS
2260 if (name_len == 6 && strncmp(name, "OPTIND", 6) == 0)
2263 var_pp = &G.top_var;
2264 while ((cur = *var_pp) != NULL) {
2265 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
2266 if (cur->flg_read_only) {
2267 bb_error_msg("%s: readonly variable", name);
2268 return EXIT_FAILURE;
2270 *var_pp = cur->next;
2271 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
2272 bb_unsetenv(cur->varstr);
2273 if (name_len == 3 && cur->varstr[0] == 'P' && cur->varstr[1] == 'S')
2274 cmdedit_update_prompt();
2278 return EXIT_SUCCESS;
2280 var_pp = &cur->next;
2282 return EXIT_SUCCESS;
2285 #if ENABLE_HUSH_UNSET || ENABLE_HUSH_GETOPTS
2286 static int unset_local_var(const char *name)
2288 return unset_local_var_len(name, strlen(name));
2292 static void unset_vars(char **strings)
2300 const char *eq = strchrnul(*v, '=');
2301 unset_local_var_len(*v, (int)(eq - *v));
2307 #if BASH_HOSTNAME_VAR || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_READ || ENABLE_HUSH_GETOPTS
2308 static void FAST_FUNC set_local_var_from_halves(const char *name, const char *val)
2310 char *var = xasprintf("%s=%s", name, val);
2311 set_local_var(var, /*flag:*/ 0);
2317 * Helpers for "var1=val1 var2=val2 cmd" feature
2319 static void add_vars(struct variable *var)
2321 struct variable *next;
2325 var->next = G.top_var;
2327 if (var->flg_export) {
2328 debug_printf_env("%s: restoring exported '%s'\n", __func__, var->varstr);
2329 putenv(var->varstr);
2331 debug_printf_env("%s: restoring variable '%s'\n", __func__, var->varstr);
2337 static struct variable *set_vars_and_save_old(char **strings)
2340 struct variable *old = NULL;
2346 struct variable *var_p;
2347 struct variable **var_pp;
2350 eq = strchr(*s, '=');
2352 var_pp = get_ptr_to_local_var(*s, eq - *s);
2355 if (var_p->flg_read_only) {
2357 bb_error_msg("%s: readonly variable", *s);
2359 * "VAR=V BLTIN" unsets VARs after BLTIN completes.
2360 * If VAR is readonly, leaving it in the list
2361 * after asssignment error (msg above)
2362 * causes doubled error message later, on unset.
2364 debug_printf_env("removing/freeing '%s' element\n", *s);
2367 do { *p = p[1]; p++; } while (*p);
2370 /* Remove variable from global linked list */
2371 debug_printf_env("%s: removing '%s'\n", __func__, var_p->varstr);
2372 *var_pp = var_p->next;
2373 /* Add it to returned list */
2377 set_local_var(*s, SETFLAG_EXPORT);
2389 static void reinit_unicode_for_hush(void)
2391 /* Unicode support should be activated even if LANG is set
2392 * _during_ shell execution, not only if it was set when
2393 * shell was started. Therefore, re-check LANG every time:
2395 if (ENABLE_FEATURE_CHECK_UNICODE_IN_ENV
2396 || ENABLE_UNICODE_USING_LOCALE
2398 const char *s = get_local_var_value("LC_ALL");
2399 if (!s) s = get_local_var_value("LC_CTYPE");
2400 if (!s) s = get_local_var_value("LANG");
2406 * in_str support (strings, and "strings" read from files).
2409 #if ENABLE_HUSH_INTERACTIVE
2410 /* To test correct lineedit/interactive behavior, type from command line:
2416 * It exercises a lot of corner cases.
2418 static void cmdedit_update_prompt(void)
2420 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
2421 G.PS1 = get_local_var_value("PS1");
2424 G.PS2 = get_local_var_value("PS2");
2431 static const char *setup_prompt_string(int promptmode)
2433 const char *prompt_str;
2434 debug_printf("setup_prompt_string %d ", promptmode);
2435 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
2436 /* Set up the prompt */
2437 if (promptmode == 0) { /* PS1 */
2439 /* bash uses $PWD value, even if it is set by user.
2440 * It uses current dir only if PWD is unset.
2441 * We always use current dir. */
2442 G.PS1 = xasprintf("%s %c ", get_cwd(0), (geteuid() != 0) ? '$' : '#');
2447 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
2448 debug_printf("prompt_str '%s'\n", prompt_str);
2451 static int get_user_input(struct in_str *i)
2454 const char *prompt_str;
2456 prompt_str = setup_prompt_string(i->promptmode);
2457 # if ENABLE_FEATURE_EDITING
2459 reinit_unicode_for_hush();
2460 if (G.flag_SIGINT) {
2461 /* There was ^C'ed, make it look prettier: */
2465 /* buglet: SIGINT will not make new prompt to appear _at once_,
2466 * only after <Enter>. (^C works immediately) */
2467 r = read_line_input(G.line_input_state, prompt_str,
2468 G.user_input_buf, CONFIG_FEATURE_EDITING_MAX_LEN-1
2470 /* read_line_input intercepts ^C, "convert" it to SIGINT */
2473 check_and_run_traps();
2474 if (r != 0 && !G.flag_SIGINT)
2476 /* ^C or SIGINT: repeat */
2477 /* bash prints ^C even on real SIGINT (non-kbd generated) */
2478 write(STDOUT_FILENO, "^C", 2);
2479 G.last_exitcode = 128 + SIGINT;
2482 /* EOF/error detected */
2484 i->peek_buf[0] = r = EOF;
2487 i->p = G.user_input_buf;
2488 return (unsigned char)*i->p++;
2492 if (i->last_char == '\0' || i->last_char == '\n') {
2493 /* Why check_and_run_traps here? Try this interactively:
2494 * $ trap 'echo INT' INT; (sleep 2; kill -INT $$) &
2495 * $ <[enter], repeatedly...>
2496 * Without check_and_run_traps, handler never runs.
2498 check_and_run_traps();
2499 fputs(prompt_str, stdout);
2502 //FIXME: here ^C or SIGINT will have effect only after <Enter>
2504 /* In !ENABLE_FEATURE_EDITING we don't use read_line_input,
2505 * no ^C masking happens during fgetc, no special code for ^C:
2506 * it generates SIGINT as usual.
2508 check_and_run_traps();
2510 G.last_exitcode = 128 + SIGINT;
2517 /* This is the magic location that prints prompts
2518 * and gets data back from the user */
2519 static int fgetc_interactive(struct in_str *i)
2522 /* If it's interactive stdin, get new line. */
2523 if (G_interactive_fd && i->file == stdin) {
2524 /* Returns first char (or EOF), the rest is in i->p[] */
2525 ch = get_user_input(i);
2526 i->promptmode = 1; /* PS2 */
2528 /* Not stdin: script file, sourced file, etc */
2529 do ch = fgetc(i->file); while (ch == '\0');
2534 static inline int fgetc_interactive(struct in_str *i)
2537 do ch = fgetc(i->file); while (ch == '\0');
2540 #endif /* INTERACTIVE */
2542 static int i_getch(struct in_str *i)
2547 /* string-based in_str */
2548 ch = (unsigned char)*i->p;
2557 /* FILE-based in_str */
2559 #if ENABLE_FEATURE_EDITING
2560 /* This can be stdin, check line editing char[] buffer */
2561 if (i->p && *i->p != '\0') {
2562 ch = (unsigned char)*i->p++;
2566 /* peek_buf[] is an int array, not char. Can contain EOF. */
2567 ch = i->peek_buf[0];
2569 int ch2 = i->peek_buf[1];
2570 i->peek_buf[0] = ch2;
2571 if (ch2 == 0) /* very likely, avoid redundant write */
2577 ch = fgetc_interactive(i);
2579 debug_printf("file_get: got '%c' %d\n", ch, ch);
2584 static int i_peek(struct in_str *i)
2589 /* string-based in_str */
2590 /* Doesn't report EOF on NUL. None of the callers care. */
2591 return (unsigned char)*i->p;
2594 /* FILE-based in_str */
2596 #if ENABLE_FEATURE_EDITING && ENABLE_HUSH_INTERACTIVE
2597 /* This can be stdin, check line editing char[] buffer */
2598 if (i->p && *i->p != '\0')
2599 return (unsigned char)*i->p;
2601 /* peek_buf[] is an int array, not char. Can contain EOF. */
2602 ch = i->peek_buf[0];
2606 /* Need to get a new char */
2607 ch = fgetc_interactive(i);
2608 debug_printf("file_peek: got '%c' %d\n", ch, ch);
2610 /* Save it by either rolling back line editing buffer, or in i->peek_buf[0] */
2611 #if ENABLE_FEATURE_EDITING && ENABLE_HUSH_INTERACTIVE
2617 i->peek_buf[0] = ch;
2618 /*i->peek_buf[1] = 0; - already is */
2622 /* Only ever called if i_peek() was called, and did not return EOF.
2623 * IOW: we know the previous peek saw an ordinary char, not EOF, not NUL,
2624 * not end-of-line. Therefore we never need to read a new editing line here.
2626 static int i_peek2(struct in_str *i)
2630 /* There are two cases when i->p[] buffer exists.
2631 * (1) it's a string in_str.
2632 * (2) It's a file, and we have a saved line editing buffer.
2633 * In both cases, we know that i->p[0] exists and not NUL, and
2634 * the peek2 result is in i->p[1].
2637 return (unsigned char)i->p[1];
2639 /* Now we know it is a file-based in_str. */
2641 /* peek_buf[] is an int array, not char. Can contain EOF. */
2642 /* Is there 2nd char? */
2643 ch = i->peek_buf[1];
2645 /* We did not read it yet, get it now */
2646 do ch = fgetc(i->file); while (ch == '\0');
2647 i->peek_buf[1] = ch;
2650 debug_printf("file_peek2: got '%c' %d\n", ch, ch);
2654 static void setup_file_in_str(struct in_str *i, FILE *f)
2656 memset(i, 0, sizeof(*i));
2657 /* i->promptmode = 0; - PS1 (memset did it) */
2662 static void setup_string_in_str(struct in_str *i, const char *s)
2664 memset(i, 0, sizeof(*i));
2665 /* i->promptmode = 0; - PS1 (memset did it) */
2666 /*i->file = NULL */;
2674 #define B_CHUNK (32 * sizeof(char*))
2676 static void o_reset_to_empty_unquoted(o_string *o)
2679 o->has_quoted_part = 0;
2684 static void o_free(o_string *o)
2687 memset(o, 0, sizeof(*o));
2690 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
2695 static void o_grow_by(o_string *o, int len)
2697 if (o->length + len > o->maxlen) {
2698 o->maxlen += (2 * len) | (B_CHUNK-1);
2699 o->data = xrealloc(o->data, 1 + o->maxlen);
2703 static void o_addchr(o_string *o, int ch)
2705 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
2706 if (o->length < o->maxlen) {
2707 /* likely. avoid o_grow_by() call */
2709 o->data[o->length] = ch;
2711 o->data[o->length] = '\0';
2719 /* Valid only if we know o_string is not empty */
2720 static void o_delchr(o_string *o)
2723 o->data[o->length] = '\0';
2727 static void o_addblock(o_string *o, const char *str, int len)
2730 ((char*)mempcpy(&o->data[o->length], str, len))[0] = '\0';
2734 static void o_addstr(o_string *o, const char *str)
2736 o_addblock(o, str, strlen(str));
2740 static void nommu_addchr(o_string *o, int ch)
2746 # define nommu_addchr(o, str) ((void)0)
2749 static void o_addstr_with_NUL(o_string *o, const char *str)
2751 o_addblock(o, str, strlen(str) + 1);
2755 * HUSH_BRACE_EXPANSION code needs corresponding quoting on variable expansion side.
2756 * Currently, "v='{q,w}'; echo $v" erroneously expands braces in $v.
2757 * Apparently, on unquoted $v bash still does globbing
2758 * ("v='*.txt'; echo $v" prints all .txt files),
2759 * but NOT brace expansion! Thus, there should be TWO independent
2760 * quoting mechanisms on $v expansion side: one protects
2761 * $v from brace expansion, and other additionally protects "$v" against globbing.
2762 * We have only second one.
2765 #if ENABLE_HUSH_BRACE_EXPANSION
2766 # define MAYBE_BRACES "{}"
2768 # define MAYBE_BRACES ""
2771 /* My analysis of quoting semantics tells me that state information
2772 * is associated with a destination, not a source.
2774 static void o_addqchr(o_string *o, int ch)
2777 char *found = strchr("*?[\\" MAYBE_BRACES, ch);
2782 o->data[o->length] = '\\';
2785 o->data[o->length] = ch;
2787 o->data[o->length] = '\0';
2790 static void o_addQchr(o_string *o, int ch)
2793 if ((o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)
2794 && strchr("*?[\\" MAYBE_BRACES, ch)
2797 o->data[o->length] = '\\';
2801 o->data[o->length] = ch;
2803 o->data[o->length] = '\0';
2806 static void o_addqblock(o_string *o, const char *str, int len)
2811 int ordinary_cnt = strcspn(str, "*?[\\" MAYBE_BRACES);
2812 if (ordinary_cnt > len) /* paranoia */
2814 o_addblock(o, str, ordinary_cnt);
2815 if (ordinary_cnt == len)
2816 return; /* NUL is already added by o_addblock */
2817 str += ordinary_cnt;
2818 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
2822 if (ch) { /* it is necessarily one of "*?[\\" MAYBE_BRACES */
2824 o->data[o->length] = '\\';
2828 o->data[o->length] = ch;
2831 o->data[o->length] = '\0';
2834 static void o_addQblock(o_string *o, const char *str, int len)
2836 if (!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS)) {
2837 o_addblock(o, str, len);
2840 o_addqblock(o, str, len);
2843 static void o_addQstr(o_string *o, const char *str)
2845 o_addQblock(o, str, strlen(str));
2848 /* A special kind of o_string for $VAR and `cmd` expansion.
2849 * It contains char* list[] at the beginning, which is grown in 16 element
2850 * increments. Actual string data starts at the next multiple of 16 * (char*).
2851 * list[i] contains an INDEX (int!) into this string data.
2852 * It means that if list[] needs to grow, data needs to be moved higher up
2853 * but list[i]'s need not be modified.
2854 * NB: remembering how many list[i]'s you have there is crucial.
2855 * o_finalize_list() operation post-processes this structure - calculates
2856 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
2858 #if DEBUG_EXPAND || DEBUG_GLOB
2859 static void debug_print_list(const char *prefix, o_string *o, int n)
2861 char **list = (char**)o->data;
2862 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2866 fdprintf(2, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d glob:%d quoted:%d escape:%d\n",
2867 prefix, list, n, string_start, o->length, o->maxlen,
2868 !!(o->o_expflags & EXP_FLAG_GLOB),
2870 !!(o->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
2873 fdprintf(2, " list[%d]=%d '%s' %p\n", i, (int)(uintptr_t)list[i],
2874 o->data + (int)(uintptr_t)list[i] + string_start,
2875 o->data + (int)(uintptr_t)list[i] + string_start);
2879 const char *p = o->data + (int)(uintptr_t)list[n - 1] + string_start;
2881 fdprintf(2, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
2885 # define debug_print_list(prefix, o, n) ((void)0)
2888 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
2889 * in list[n] so that it points past last stored byte so far.
2890 * It returns n+1. */
2891 static int o_save_ptr_helper(o_string *o, int n)
2893 char **list = (char**)o->data;
2897 if (!o->has_empty_slot) {
2898 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2899 string_len = o->length - string_start;
2900 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
2901 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
2902 /* list[n] points to string_start, make space for 16 more pointers */
2903 o->maxlen += 0x10 * sizeof(list[0]);
2904 o->data = xrealloc(o->data, o->maxlen + 1);
2905 list = (char**)o->data;
2906 memmove(list + n + 0x10, list + n, string_len);
2907 o->length += 0x10 * sizeof(list[0]);
2909 debug_printf_list("list[%d]=%d string_start=%d\n",
2910 n, string_len, string_start);
2913 /* We have empty slot at list[n], reuse without growth */
2914 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
2915 string_len = o->length - string_start;
2916 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
2917 n, string_len, string_start);
2918 o->has_empty_slot = 0;
2920 o->has_quoted_part = 0;
2921 list[n] = (char*)(uintptr_t)string_len;
2925 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
2926 static int o_get_last_ptr(o_string *o, int n)
2928 char **list = (char**)o->data;
2929 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
2931 return ((int)(uintptr_t)list[n-1]) + string_start;
2934 #if ENABLE_HUSH_BRACE_EXPANSION
2935 /* There in a GNU extension, GLOB_BRACE, but it is not usable:
2936 * first, it processes even {a} (no commas), second,
2937 * I didn't manage to make it return strings when they don't match
2938 * existing files. Need to re-implement it.
2942 static int glob_needed(const char *s)
2951 if (*s == '*' || *s == '[' || *s == '?' || *s == '{')
2957 /* Return pointer to next closing brace or to comma */
2958 static const char *next_brace_sub(const char *cp)
2962 while (*cp != '\0') {
2969 if ((*cp == '}' && depth-- == 0) || (*cp == ',' && depth == 0))
2975 return *cp != '\0' ? cp : NULL;
2977 /* Recursive brace globber. Note: may garble pattern[]. */
2978 static int glob_brace(char *pattern, o_string *o, int n)
2980 char *new_pattern_buf;
2987 debug_printf_glob("glob_brace('%s')\n", pattern);
2993 if (*begin == '{') {
2994 /* Find the first sub-pattern and at the same time
2995 * find the rest after the closing brace */
2996 next = next_brace_sub(begin);
2998 /* An illegal expression */
3002 /* "{abc}" with no commas - illegal
3003 * brace expr, disregard and skip it */
3009 if (*begin == '\\' && begin[1] != '\0')
3013 debug_printf_glob("begin:%s\n", begin);
3014 debug_printf_glob("next:%s\n", next);
3016 /* Now find the end of the whole brace expression */
3018 while (*rest != '}') {
3019 rest = next_brace_sub(rest);
3021 /* An illegal expression */
3024 debug_printf_glob("rest:%s\n", rest);
3026 rest_len = strlen(++rest) + 1;
3028 /* We are sure the brace expression is well-formed */
3030 /* Allocate working buffer large enough for our work */
3031 new_pattern_buf = xmalloc(strlen(pattern));
3033 /* We have a brace expression. BEGIN points to the opening {,
3034 * NEXT points past the terminator of the first element, and REST
3035 * points past the final }. We will accumulate result names from
3036 * recursive runs for each brace alternative in the buffer using
3041 /* Construct the new glob expression */
3044 mempcpy(new_pattern_buf,
3045 /* We know the prefix for all sub-patterns */
3046 pattern, begin - pattern),
3050 /* Note: glob_brace() may garble new_pattern_buf[].
3051 * That's why we re-copy prefix every time (1st memcpy above).
3053 n = glob_brace(new_pattern_buf, o, n);
3055 /* We saw the last entry */
3059 next = next_brace_sub(next);
3061 free(new_pattern_buf);
3069 memset(&globdata, 0, sizeof(globdata));
3070 gr = glob(pattern, 0, NULL, &globdata);
3071 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
3073 if (gr == GLOB_NOMATCH) {
3074 globfree(&globdata);
3075 /* NB: garbles parameter */
3076 unbackslash(pattern);
3077 o_addstr_with_NUL(o, pattern);
3078 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3079 return o_save_ptr_helper(o, n);
3081 if (gr == GLOB_NOSPACE)
3082 bb_error_msg_and_die(bb_msg_memory_exhausted);
3083 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
3084 * but we didn't specify it. Paranoia again. */
3085 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
3087 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
3088 char **argv = globdata.gl_pathv;
3090 o_addstr_with_NUL(o, *argv);
3091 n = o_save_ptr_helper(o, n);
3097 globfree(&globdata);
3101 /* Performs globbing on last list[],
3102 * saving each result as a new list[].
3104 static int perform_glob(o_string *o, int n)
3106 char *pattern, *copy;
3108 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
3110 return o_save_ptr_helper(o, n);
3111 pattern = o->data + o_get_last_ptr(o, n);
3112 debug_printf_glob("glob pattern '%s'\n", pattern);
3113 if (!glob_needed(pattern)) {
3114 /* unbackslash last string in o in place, fix length */
3115 o->length = unbackslash(pattern) - o->data;
3116 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3117 return o_save_ptr_helper(o, n);
3120 copy = xstrdup(pattern);
3121 /* "forget" pattern in o */
3122 o->length = pattern - o->data;
3123 n = glob_brace(copy, o, n);
3126 debug_print_list("perform_glob returning", o, n);
3130 #else /* !HUSH_BRACE_EXPANSION */
3133 static int glob_needed(const char *s)
3142 if (*s == '*' || *s == '[' || *s == '?')
3148 /* Performs globbing on last list[],
3149 * saving each result as a new list[].
3151 static int perform_glob(o_string *o, int n)
3157 debug_printf_glob("start perform_glob: n:%d o->data:%p\n", n, o->data);
3159 return o_save_ptr_helper(o, n);
3160 pattern = o->data + o_get_last_ptr(o, n);
3161 debug_printf_glob("glob pattern '%s'\n", pattern);
3162 if (!glob_needed(pattern)) {
3164 /* unbackslash last string in o in place, fix length */
3165 o->length = unbackslash(pattern) - o->data;
3166 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
3167 return o_save_ptr_helper(o, n);
3170 memset(&globdata, 0, sizeof(globdata));
3171 /* Can't use GLOB_NOCHECK: it does not unescape the string.
3172 * If we glob "*.\*" and don't find anything, we need
3173 * to fall back to using literal "*.*", but GLOB_NOCHECK
3174 * will return "*.\*"!
3176 gr = glob(pattern, 0, NULL, &globdata);
3177 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
3179 if (gr == GLOB_NOMATCH) {
3180 globfree(&globdata);
3183 if (gr == GLOB_NOSPACE)
3184 bb_error_msg_and_die(bb_msg_memory_exhausted);
3185 /* GLOB_ABORTED? Only happens with GLOB_ERR flag,
3186 * but we didn't specify it. Paranoia again. */
3187 bb_error_msg_and_die("glob error %d on '%s'", gr, pattern);
3189 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
3190 char **argv = globdata.gl_pathv;
3191 /* "forget" pattern in o */
3192 o->length = pattern - o->data;
3194 o_addstr_with_NUL(o, *argv);
3195 n = o_save_ptr_helper(o, n);
3201 globfree(&globdata);
3203 debug_print_list("perform_glob returning", o, n);
3207 #endif /* !HUSH_BRACE_EXPANSION */
3209 /* If o->o_expflags & EXP_FLAG_GLOB, glob the string so far remembered.
3210 * Otherwise, just finish current list[] and start new */
3211 static int o_save_ptr(o_string *o, int n)
3213 if (o->o_expflags & EXP_FLAG_GLOB) {
3214 /* If o->has_empty_slot, list[n] was already globbed
3215 * (if it was requested back then when it was filled)
3216 * so don't do that again! */
3217 if (!o->has_empty_slot)
3218 return perform_glob(o, n); /* o_save_ptr_helper is inside */
3220 return o_save_ptr_helper(o, n);
3223 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
3224 static char **o_finalize_list(o_string *o, int n)
3229 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
3231 debug_print_list("finalized", o, n);
3232 debug_printf_expand("finalized n:%d\n", n);
3233 list = (char**)o->data;
3234 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
3238 list[n] = o->data + (int)(uintptr_t)list[n] + string_start;
3243 static void free_pipe_list(struct pipe *pi);
3245 /* Returns pi->next - next pipe in the list */
3246 static struct pipe *free_pipe(struct pipe *pi)
3251 debug_printf_clean("free_pipe (pid %d)\n", getpid());
3252 for (i = 0; i < pi->num_cmds; i++) {
3253 struct command *command;
3254 struct redir_struct *r, *rnext;
3256 command = &pi->cmds[i];
3257 debug_printf_clean(" command %d:\n", i);
3258 if (command->argv) {
3262 for (a = 0, p = command->argv; *p; a++, p++) {
3263 debug_printf_clean(" argv[%d] = %s\n", a, *p);
3266 free_strings(command->argv);
3267 //command->argv = NULL;
3269 /* not "else if": on syntax error, we may have both! */
3270 if (command->group) {
3271 debug_printf_clean(" begin group (cmd_type:%d)\n",
3273 free_pipe_list(command->group);
3274 debug_printf_clean(" end group\n");
3275 //command->group = NULL;
3277 /* else is crucial here.
3278 * If group != NULL, child_func is meaningless */
3279 #if ENABLE_HUSH_FUNCTIONS
3280 else if (command->child_func) {
3281 debug_printf_exec("cmd %p releases child func at %p\n", command, command->child_func);
3282 command->child_func->parent_cmd = NULL;
3286 free(command->group_as_string);
3287 //command->group_as_string = NULL;
3289 for (r = command->redirects; r; r = rnext) {
3290 debug_printf_clean(" redirect %d%s",
3291 r->rd_fd, redir_table[r->rd_type].descrip);
3292 /* guard against the case >$FOO, where foo is unset or blank */
3293 if (r->rd_filename) {
3294 debug_printf_clean(" fname:'%s'\n", r->rd_filename);
3295 free(r->rd_filename);
3296 //r->rd_filename = NULL;
3298 debug_printf_clean(" rd_dup:%d\n", r->rd_dup);
3302 //command->redirects = NULL;
3304 free(pi->cmds); /* children are an array, they get freed all at once */
3308 //pi->cmdtext = NULL;
3316 static void free_pipe_list(struct pipe *pi)
3320 debug_printf_clean("pipe reserved word %d\n", pi->res_word);
3322 debug_printf_clean("pipe followup code %d\n", pi->followup);
3328 /*** Parsing routines ***/
3330 #ifndef debug_print_tree
3331 static void debug_print_tree(struct pipe *pi, int lvl)
3333 static const char *const PIPE[] = {
3339 static const char *RES[] = {
3340 [RES_NONE ] = "NONE" ,
3343 [RES_THEN ] = "THEN" ,
3344 [RES_ELIF ] = "ELIF" ,
3345 [RES_ELSE ] = "ELSE" ,
3348 # if ENABLE_HUSH_LOOPS
3349 [RES_FOR ] = "FOR" ,
3350 [RES_WHILE] = "WHILE",
3351 [RES_UNTIL] = "UNTIL",
3353 [RES_DONE ] = "DONE" ,
3355 # if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
3358 # if ENABLE_HUSH_CASE
3359 [RES_CASE ] = "CASE" ,
3360 [RES_CASE_IN ] = "CASE_IN" ,
3361 [RES_MATCH] = "MATCH",
3362 [RES_CASE_BODY] = "CASE_BODY",
3363 [RES_ESAC ] = "ESAC" ,
3365 [RES_XXXX ] = "XXXX" ,
3366 [RES_SNTX ] = "SNTX" ,
3368 static const char *const CMDTYPE[] = {
3372 # if ENABLE_HUSH_FUNCTIONS
3381 fdprintf(2, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
3382 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
3384 while (prn < pi->num_cmds) {
3385 struct command *command = &pi->cmds[prn];
3386 char **argv = command->argv;
3388 fdprintf(2, "%*s cmd %d assignment_cnt:%d",
3390 command->assignment_cnt);
3391 if (command->group) {
3392 fdprintf(2, " group %s: (argv=%p)%s%s\n",
3393 CMDTYPE[command->cmd_type],
3396 , " group_as_string:", command->group_as_string
3401 debug_print_tree(command->group, lvl+1);
3405 if (argv) while (*argv) {
3406 fdprintf(2, " '%s'", *argv);
3416 #endif /* debug_print_tree */
3418 static struct pipe *new_pipe(void)
3421 pi = xzalloc(sizeof(struct pipe));
3422 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3426 /* Command (member of a pipe) is complete, or we start a new pipe
3427 * if ctx->command is NULL.
3428 * No errors possible here.
3430 static int done_command(struct parse_context *ctx)
3432 /* The command is really already in the pipe structure, so
3433 * advance the pipe counter and make a new, null command. */
3434 struct pipe *pi = ctx->pipe;
3435 struct command *command = ctx->command;
3437 #if 0 /* Instead we emit error message at run time */
3438 if (ctx->pending_redirect) {
3439 /* For example, "cmd >" (no filename to redirect to) */
3440 syntax_error("invalid redirect");
3441 ctx->pending_redirect = NULL;
3446 if (IS_NULL_CMD(command)) {
3447 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3451 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3452 //debug_print_tree(ctx->list_head, 20);
3454 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3457 /* Only real trickiness here is that the uncommitted
3458 * command structure is not counted in pi->num_cmds. */
3459 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3460 ctx->command = command = &pi->cmds[pi->num_cmds];
3462 memset(command, 0, sizeof(*command));
3463 return pi->num_cmds; /* used only for 0/nonzero check */
3466 static void done_pipe(struct parse_context *ctx, pipe_style type)
3470 debug_printf_parse("done_pipe entered, followup %d\n", type);
3471 /* Close previous command */
3472 not_null = done_command(ctx);
3474 ctx->pipe->pi_inverted = ctx->ctx_inverted;
3475 ctx->ctx_inverted = 0;
3476 ctx->pipe->res_word = ctx->ctx_res_w;
3478 if (type == PIPE_BG && ctx->list_head != ctx->pipe) {
3479 /* Necessary since && and || have precedence over &:
3480 * "cmd1 && cmd2 &" must spawn both cmds, not only cmd2,
3481 * in a backgrounded subshell.
3484 struct command *command;
3486 /* Is this actually this construct, all pipes end with && or ||? */
3487 pi = ctx->list_head;
3488 while (pi != ctx->pipe) {
3489 if (pi->followup != PIPE_AND && pi->followup != PIPE_OR)
3494 debug_printf_parse("BG with more than one pipe, converting to { p1 &&...pN; } &\n");
3495 pi->followup = PIPE_SEQ; /* close pN _not_ with "&"! */
3496 pi = xzalloc(sizeof(*pi));
3497 pi->followup = PIPE_BG;
3499 pi->cmds = xzalloc(sizeof(pi->cmds[0]));
3500 command = &pi->cmds[0];
3501 if (CMD_NORMAL != 0) /* "if xzalloc didn't do that already" */
3502 command->cmd_type = CMD_NORMAL;
3503 command->group = ctx->list_head;
3505 command->group_as_string = xstrndup(
3506 ctx->as_string.data,
3507 ctx->as_string.length - 1 /* do not copy last char, "&" */
3510 /* Replace all pipes in ctx with one newly created */
3511 ctx->list_head = ctx->pipe = pi;
3514 ctx->pipe->followup = type;
3517 /* Without this check, even just <enter> on command line generates
3518 * tree of three NOPs (!). Which is harmless but annoying.
3519 * IOW: it is safe to do it unconditionally. */
3522 || ctx->ctx_res_w == RES_FI
3524 #if ENABLE_HUSH_LOOPS
3525 || ctx->ctx_res_w == RES_DONE
3526 || ctx->ctx_res_w == RES_FOR
3527 || ctx->ctx_res_w == RES_IN
3529 #if ENABLE_HUSH_CASE
3530 || ctx->ctx_res_w == RES_ESAC
3534 debug_printf_parse("done_pipe: adding new pipe: "
3535 "not_null:%d ctx->ctx_res_w:%d\n",
3536 not_null, ctx->ctx_res_w);
3538 ctx->pipe->next = new_p;
3540 /* RES_THEN, RES_DO etc are "sticky" -
3541 * they remain set for pipes inside if/while.
3542 * This is used to control execution.
3543 * RES_FOR and RES_IN are NOT sticky (needed to support
3544 * cases where variable or value happens to match a keyword):
3546 #if ENABLE_HUSH_LOOPS
3547 if (ctx->ctx_res_w == RES_FOR
3548 || ctx->ctx_res_w == RES_IN)
3549 ctx->ctx_res_w = RES_NONE;
3551 #if ENABLE_HUSH_CASE
3552 if (ctx->ctx_res_w == RES_MATCH)
3553 ctx->ctx_res_w = RES_CASE_BODY;
3554 if (ctx->ctx_res_w == RES_CASE)
3555 ctx->ctx_res_w = RES_CASE_IN;
3557 ctx->command = NULL; /* trick done_command below */
3558 /* Create the memory for command, roughly:
3559 * ctx->pipe->cmds = new struct command;
3560 * ctx->command = &ctx->pipe->cmds[0];
3563 //debug_print_tree(ctx->list_head, 10);
3565 debug_printf_parse("done_pipe return\n");
3568 static void initialize_context(struct parse_context *ctx)
3570 memset(ctx, 0, sizeof(*ctx));
3571 ctx->pipe = ctx->list_head = new_pipe();
3572 /* Create the memory for command, roughly:
3573 * ctx->pipe->cmds = new struct command;
3574 * ctx->command = &ctx->pipe->cmds[0];
3579 /* If a reserved word is found and processed, parse context is modified
3580 * and 1 is returned.
3583 struct reserved_combo {
3586 unsigned char assignment_flag;
3590 FLAG_END = (1 << RES_NONE ),
3592 FLAG_IF = (1 << RES_IF ),
3593 FLAG_THEN = (1 << RES_THEN ),
3594 FLAG_ELIF = (1 << RES_ELIF ),
3595 FLAG_ELSE = (1 << RES_ELSE ),
3596 FLAG_FI = (1 << RES_FI ),
3598 # if ENABLE_HUSH_LOOPS
3599 FLAG_FOR = (1 << RES_FOR ),
3600 FLAG_WHILE = (1 << RES_WHILE),
3601 FLAG_UNTIL = (1 << RES_UNTIL),
3602 FLAG_DO = (1 << RES_DO ),
3603 FLAG_DONE = (1 << RES_DONE ),
3604 FLAG_IN = (1 << RES_IN ),
3606 # if ENABLE_HUSH_CASE
3607 FLAG_MATCH = (1 << RES_MATCH),
3608 FLAG_ESAC = (1 << RES_ESAC ),
3610 FLAG_START = (1 << RES_XXXX ),
3613 static const struct reserved_combo* match_reserved_word(o_string *word)
3615 /* Mostly a list of accepted follow-up reserved words.
3616 * FLAG_END means we are done with the sequence, and are ready
3617 * to turn the compound list into a command.
3618 * FLAG_START means the word must start a new compound list.
3620 static const struct reserved_combo reserved_list[] = {
3622 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3623 { "if", RES_IF, MAYBE_ASSIGNMENT, FLAG_THEN | FLAG_START },
3624 { "then", RES_THEN, MAYBE_ASSIGNMENT, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3625 { "elif", RES_ELIF, MAYBE_ASSIGNMENT, FLAG_THEN },
3626 { "else", RES_ELSE, MAYBE_ASSIGNMENT, FLAG_FI },
3627 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3629 # if ENABLE_HUSH_LOOPS
3630 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3631 { "while", RES_WHILE, MAYBE_ASSIGNMENT, FLAG_DO | FLAG_START },
3632 { "until", RES_UNTIL, MAYBE_ASSIGNMENT, FLAG_DO | FLAG_START },
3633 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3634 { "do", RES_DO, MAYBE_ASSIGNMENT, FLAG_DONE },
3635 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3637 # if ENABLE_HUSH_CASE
3638 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3639 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3642 const struct reserved_combo *r;
3644 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3645 if (strcmp(word->data, r->literal) == 0)
3650 /* Return 0: not a keyword, 1: keyword
3652 static int reserved_word(o_string *word, struct parse_context *ctx)
3654 # if ENABLE_HUSH_CASE
3655 static const struct reserved_combo reserved_match = {
3656 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3659 const struct reserved_combo *r;
3661 if (word->has_quoted_part)
3663 r = match_reserved_word(word);
3667 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3668 # if ENABLE_HUSH_CASE
3669 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE_IN) {
3670 /* "case word IN ..." - IN part starts first MATCH part */
3671 r = &reserved_match;
3674 if (r->flag == 0) { /* '!' */
3675 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3676 syntax_error("! ! command");
3677 ctx->ctx_res_w = RES_SNTX;
3679 ctx->ctx_inverted = 1;
3682 if (r->flag & FLAG_START) {
3683 struct parse_context *old;
3685 old = xmemdup(ctx, sizeof(*ctx));
3686 debug_printf_parse("push stack %p\n", old);
3687 initialize_context(ctx);
3689 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3690 syntax_error_at(word->data);
3691 ctx->ctx_res_w = RES_SNTX;
3694 /* "{...} fi" is ok. "{...} if" is not
3696 * if { echo foo; } then { echo bar; } fi */
3697 if (ctx->command->group)
3698 done_pipe(ctx, PIPE_SEQ);
3701 ctx->ctx_res_w = r->res;
3702 ctx->old_flag = r->flag;
3703 word->o_assignment = r->assignment_flag;
3704 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag[word->o_assignment]);
3706 if (ctx->old_flag & FLAG_END) {
3707 struct parse_context *old;
3709 done_pipe(ctx, PIPE_SEQ);
3710 debug_printf_parse("pop stack %p\n", ctx->stack);
3712 old->command->group = ctx->list_head;
3713 old->command->cmd_type = CMD_NORMAL;
3715 /* At this point, the compound command's string is in
3716 * ctx->as_string... except for the leading keyword!
3717 * Consider this example: "echo a | if true; then echo a; fi"
3718 * ctx->as_string will contain "true; then echo a; fi",
3719 * with "if " remaining in old->as_string!
3723 int len = old->as_string.length;
3724 /* Concatenate halves */
3725 o_addstr(&old->as_string, ctx->as_string.data);
3726 o_free_unsafe(&ctx->as_string);
3727 /* Find where leading keyword starts in first half */
3728 str = old->as_string.data + len;
3729 if (str > old->as_string.data)
3730 str--; /* skip whitespace after keyword */
3731 while (str > old->as_string.data && isalpha(str[-1]))
3733 /* Ugh, we're done with this horrid hack */
3734 old->command->group_as_string = xstrdup(str);
3735 debug_printf_parse("pop, remembering as:'%s'\n",
3736 old->command->group_as_string);
3739 *ctx = *old; /* physical copy */
3744 #endif /* HAS_KEYWORDS */
3746 /* Word is complete, look at it and update parsing context.
3747 * Normal return is 0. Syntax errors return 1.
3748 * Note: on return, word is reset, but not o_free'd!
3750 static int done_word(o_string *word, struct parse_context *ctx)
3752 struct command *command = ctx->command;
3754 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3755 if (word->length == 0 && !word->has_quoted_part) {
3756 debug_printf_parse("done_word return 0: true null, ignored\n");
3760 if (ctx->pending_redirect) {
3761 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3762 * only if run as "bash", not "sh" */
3763 /* http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
3765 * ...the word that follows the redirection operator
3766 * shall be subjected to tilde expansion, parameter expansion,
3767 * command substitution, arithmetic expansion, and quote
3768 * removal. Pathname expansion shall not be performed
3769 * on the word by a non-interactive shell; an interactive
3770 * shell may perform it, but shall do so only when
3771 * the expansion would result in one word."
3773 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3774 /* Cater for >\file case:
3775 * >\a creates file a; >\\a, >"\a", >"\\a" create file \a
3776 * Same with heredocs:
3777 * for <<\H delim is H; <<\\H, <<"\H", <<"\\H" - \H
3779 if (ctx->pending_redirect->rd_type == REDIRECT_HEREDOC) {
3780 unbackslash(ctx->pending_redirect->rd_filename);
3781 /* Is it <<"HEREDOC"? */
3782 if (word->has_quoted_part) {
3783 ctx->pending_redirect->rd_dup |= HEREDOC_QUOTED;
3786 debug_printf_parse("word stored in rd_filename: '%s'\n", word->data);
3787 ctx->pending_redirect = NULL;
3790 # if ENABLE_HUSH_CASE
3791 if (ctx->ctx_dsemicolon
3792 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3794 /* already done when ctx_dsemicolon was set to 1: */
3795 /* ctx->ctx_res_w = RES_MATCH; */
3796 ctx->ctx_dsemicolon = 0;
3799 if (!command->argv /* if it's the first word... */
3800 # if ENABLE_HUSH_LOOPS
3801 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3802 && ctx->ctx_res_w != RES_IN
3804 # if ENABLE_HUSH_CASE
3805 && ctx->ctx_res_w != RES_CASE
3808 int reserved = reserved_word(word, ctx);
3809 debug_printf_parse("checking for reserved-ness: %d\n", reserved);
3811 o_reset_to_empty_unquoted(word);
3812 debug_printf_parse("done_word return %d\n",
3813 (ctx->ctx_res_w == RES_SNTX));
3814 return (ctx->ctx_res_w == RES_SNTX);
3817 if (strcmp(word->data, "[[") == 0) {
3818 command->cmd_type = CMD_SINGLEWORD_NOGLOB;
3824 if (command->group) {
3825 /* "{ echo foo; } echo bar" - bad */
3826 syntax_error_at(word->data);
3827 debug_printf_parse("done_word return 1: syntax error, "
3828 "groups and arglists don't mix\n");
3832 /* If this word wasn't an assignment, next ones definitely
3833 * can't be assignments. Even if they look like ones. */
3834 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3835 && word->o_assignment != WORD_IS_KEYWORD
3837 word->o_assignment = NOT_ASSIGNMENT;
3839 if (word->o_assignment == DEFINITELY_ASSIGNMENT) {
3840 command->assignment_cnt++;
3841 debug_printf_parse("++assignment_cnt=%d\n", command->assignment_cnt);
3843 debug_printf_parse("word->o_assignment was:'%s'\n", assignment_flag[word->o_assignment]);
3844 word->o_assignment = MAYBE_ASSIGNMENT;
3846 debug_printf_parse("word->o_assignment='%s'\n", assignment_flag[word->o_assignment]);
3847 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3848 debug_print_strings("word appended to argv", command->argv);
3851 #if ENABLE_HUSH_LOOPS
3852 if (ctx->ctx_res_w == RES_FOR) {
3853 if (word->has_quoted_part
3854 || !is_well_formed_var_name(command->argv[0], '\0')
3856 /* bash says just "not a valid identifier" */
3857 syntax_error("not a valid identifier in for");
3860 /* Force FOR to have just one word (variable name) */
3861 /* NB: basically, this makes hush see "for v in ..."
3862 * syntax as if it is "for v; in ...". FOR and IN become
3863 * two pipe structs in parse tree. */
3864 done_pipe(ctx, PIPE_SEQ);
3867 #if ENABLE_HUSH_CASE
3868 /* Force CASE to have just one word */
3869 if (ctx->ctx_res_w == RES_CASE) {
3870 done_pipe(ctx, PIPE_SEQ);
3874 o_reset_to_empty_unquoted(word);
3876 debug_printf_parse("done_word return 0\n");
3881 /* Peek ahead in the input to find out if we have a "&n" construct,
3882 * as in "2>&1", that represents duplicating a file descriptor.
3884 * REDIRFD_CLOSE if >&- "close fd" construct is seen,
3885 * REDIRFD_SYNTAX_ERR if syntax error,
3886 * REDIRFD_TO_FILE if no & was seen,
3887 * or the number found.
3890 #define parse_redir_right_fd(as_string, input) \
3891 parse_redir_right_fd(input)
3893 static int parse_redir_right_fd(o_string *as_string, struct in_str *input)
3899 return REDIRFD_TO_FILE;
3901 ch = i_getch(input); /* get the & */
3902 nommu_addchr(as_string, ch);
3905 ch = i_getch(input);
3906 nommu_addchr(as_string, ch);
3907 return REDIRFD_CLOSE;
3911 while (ch != EOF && isdigit(ch)) {
3912 d = d*10 + (ch-'0');
3914 ch = i_getch(input);
3915 nommu_addchr(as_string, ch);
3920 //TODO: this is the place to catch ">&file" bashism (redirect both fd 1 and 2)
3922 bb_error_msg("ambiguous redirect");
3923 return REDIRFD_SYNTAX_ERR;
3926 /* Return code is 0 normal, 1 if a syntax error is detected
3928 static int parse_redirect(struct parse_context *ctx,
3931 struct in_str *input)
3933 struct command *command = ctx->command;
3934 struct redir_struct *redir;
3935 struct redir_struct **redirp;
3938 dup_num = REDIRFD_TO_FILE;
3939 if (style != REDIRECT_HEREDOC) {
3940 /* Check for a '>&1' type redirect */
3941 dup_num = parse_redir_right_fd(&ctx->as_string, input);
3942 if (dup_num == REDIRFD_SYNTAX_ERR)
3945 int ch = i_peek(input);
3946 dup_num = (ch == '-'); /* HEREDOC_SKIPTABS bit is 1 */
3947 if (dup_num) { /* <<-... */
3948 ch = i_getch(input);
3949 nommu_addchr(&ctx->as_string, ch);
3954 if (style == REDIRECT_OVERWRITE && dup_num == REDIRFD_TO_FILE) {
3955 int ch = i_peek(input);
3957 /* >|FILE redirect ("clobbering" >).
3958 * Since we do not support "set -o noclobber" yet,
3959 * >| and > are the same for now. Just eat |.
3961 ch = i_getch(input);
3962 nommu_addchr(&ctx->as_string, ch);
3966 /* Create a new redir_struct and append it to the linked list */
3967 redirp = &command->redirects;
3968 while ((redir = *redirp) != NULL) {
3969 redirp = &(redir->next);
3971 *redirp = redir = xzalloc(sizeof(*redir));
3972 /* redir->next = NULL; */
3973 /* redir->rd_filename = NULL; */
3974 redir->rd_type = style;
3975 redir->rd_fd = (fd == -1) ? redir_table[style].default_fd : fd;
3977 debug_printf_parse("redirect type %d %s\n", redir->rd_fd,
3978 redir_table[style].descrip);
3980 redir->rd_dup = dup_num;
3981 if (style != REDIRECT_HEREDOC && dup_num != REDIRFD_TO_FILE) {
3982 /* Erik had a check here that the file descriptor in question
3983 * is legit; I postpone that to "run time"
3984 * A "-" representation of "close me" shows up as a -3 here */
3985 debug_printf_parse("duplicating redirect '%d>&%d'\n",
3986 redir->rd_fd, redir->rd_dup);
3988 #if 0 /* Instead we emit error message at run time */
3989 if (ctx->pending_redirect) {
3990 /* For example, "cmd > <file" */
3991 syntax_error("invalid redirect");
3994 /* Set ctx->pending_redirect, so we know what to do at the
3995 * end of the next parsed word. */
3996 ctx->pending_redirect = redir;
4001 /* If a redirect is immediately preceded by a number, that number is
4002 * supposed to tell which file descriptor to redirect. This routine
4003 * looks for such preceding numbers. In an ideal world this routine
4004 * needs to handle all the following classes of redirects...
4005 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
4006 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
4007 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
4008 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
4010 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html
4012 * ... If n is quoted, the number shall not be recognized as part of
4013 * the redirection expression. For example:
4015 * writes the character 2 into file a"
4016 * We are getting it right by setting ->has_quoted_part on any \<char>
4018 * A -1 return means no valid number was found,
4019 * the caller should use the appropriate default for this redirection.
4021 static int redirect_opt_num(o_string *o)
4025 if (o->data == NULL)
4027 num = bb_strtou(o->data, NULL, 10);
4028 if (errno || num < 0)
4030 o_reset_to_empty_unquoted(o);
4035 #define fetch_till_str(as_string, input, word, skip_tabs) \
4036 fetch_till_str(input, word, skip_tabs)
4038 static char *fetch_till_str(o_string *as_string,
4039 struct in_str *input,
4043 o_string heredoc = NULL_O_STRING;
4045 int prev = 0; /* not \ */
4051 ch = i_getch(input);
4053 nommu_addchr(as_string, ch);
4054 if (ch == '\n' || ch == EOF) {
4056 if ((heredoc_flags & HEREDOC_QUOTED) || prev != '\\') {
4057 if (strcmp(heredoc.data + past_EOL, word) == 0) {
4058 heredoc.data[past_EOL] = '\0';
4059 debug_printf_parse("parsed heredoc '%s'\n", heredoc.data);
4060 return heredoc.data;
4063 /* This is a new line.
4064 * Remember position and backslash-escaping status.
4066 o_addchr(&heredoc, ch);
4069 past_EOL = heredoc.length;
4070 /* Get 1st char of next line, possibly skipping leading tabs */
4072 ch = i_getch(input);
4074 nommu_addchr(as_string, ch);
4075 } while ((heredoc_flags & HEREDOC_SKIPTABS) && ch == '\t');
4076 /* If this immediately ended the line,
4077 * go back to end-of-line checks.
4080 goto check_heredoc_end;
4085 o_free_unsafe(&heredoc);
4088 o_addchr(&heredoc, ch);
4089 nommu_addchr(as_string, ch);
4090 if (prev == '\\' && ch == '\\')
4091 /* Correctly handle foo\\<eol> (not a line cont.) */
4092 prev = 0; /* not \ */
4098 /* Look at entire parse tree for not-yet-loaded REDIRECT_HEREDOCs
4099 * and load them all. There should be exactly heredoc_cnt of them.
4101 static int fetch_heredocs(int heredoc_cnt, struct parse_context *ctx, struct in_str *input)
4103 struct pipe *pi = ctx->list_head;
4105 while (pi && heredoc_cnt) {
4107 struct command *cmd = pi->cmds;
4109 debug_printf_parse("fetch_heredocs: num_cmds:%d cmd argv0:'%s'\n",
4111 cmd->argv ? cmd->argv[0] : "NONE");
4112 for (i = 0; i < pi->num_cmds; i++) {
4113 struct redir_struct *redir = cmd->redirects;
4115 debug_printf_parse("fetch_heredocs: %d cmd argv0:'%s'\n",
4116 i, cmd->argv ? cmd->argv[0] : "NONE");
4118 if (redir->rd_type == REDIRECT_HEREDOC) {
4121 redir->rd_type = REDIRECT_HEREDOC2;
4122 /* redir->rd_dup is (ab)used to indicate <<- */
4123 p = fetch_till_str(&ctx->as_string, input,
4124 redir->rd_filename, redir->rd_dup);
4126 syntax_error("unexpected EOF in here document");
4129 free(redir->rd_filename);
4130 redir->rd_filename = p;
4133 redir = redir->next;
4140 /* Should be 0. If it isn't, it's a parse error */
4142 bb_error_msg_and_die("heredoc BUG 2");
4148 static int run_list(struct pipe *pi);
4150 #define parse_stream(pstring, input, end_trigger) \
4151 parse_stream(input, end_trigger)
4153 static struct pipe *parse_stream(char **pstring,
4154 struct in_str *input,
4158 #if !ENABLE_HUSH_FUNCTIONS
4159 #define parse_group(dest, ctx, input, ch) \
4160 parse_group(ctx, input, ch)
4162 static int parse_group(o_string *dest, struct parse_context *ctx,
4163 struct in_str *input, int ch)
4165 /* dest contains characters seen prior to ( or {.
4166 * Typically it's empty, but for function defs,
4167 * it contains function name (without '()'). */
4168 struct pipe *pipe_list;
4170 struct command *command = ctx->command;
4172 debug_printf_parse("parse_group entered\n");
4173 #if ENABLE_HUSH_FUNCTIONS
4174 if (ch == '(' && !dest->has_quoted_part) {
4176 if (done_word(dest, ctx))
4179 goto skip; /* (... */
4180 if (command->argv[1]) { /* word word ... (... */
4181 syntax_error_unexpected_ch('(');
4184 /* it is "word(..." or "word (..." */
4186 ch = i_getch(input);
4187 while (ch == ' ' || ch == '\t');
4189 syntax_error_unexpected_ch(ch);
4192 nommu_addchr(&ctx->as_string, ch);
4194 ch = i_getch(input);
4195 while (ch == ' ' || ch == '\t' || ch == '\n');
4197 syntax_error_unexpected_ch(ch);
4200 nommu_addchr(&ctx->as_string, ch);
4201 command->cmd_type = CMD_FUNCDEF;
4206 #if 0 /* Prevented by caller */
4207 if (command->argv /* word [word]{... */
4208 || dest->length /* word{... */
4209 || dest->has_quoted_part /* ""{... */
4212 debug_printf_parse("parse_group return 1: "
4213 "syntax error, groups and arglists don't mix\n");
4218 #if ENABLE_HUSH_FUNCTIONS
4224 command->cmd_type = CMD_SUBSHELL;
4226 /* bash does not allow "{echo...", requires whitespace */
4228 if (ch != ' ' && ch != '\t' && ch != '\n'
4229 && ch != '(' /* but "{(..." is allowed (without whitespace) */
4231 syntax_error_unexpected_ch(ch);
4235 ch = i_getch(input);
4236 nommu_addchr(&ctx->as_string, ch);
4242 # define as_string NULL
4244 char *as_string = NULL;
4246 pipe_list = parse_stream(&as_string, input, endch);
4249 o_addstr(&ctx->as_string, as_string);
4251 /* empty ()/{} or parse error? */
4252 if (!pipe_list || pipe_list == ERR_PTR) {
4253 /* parse_stream already emitted error msg */
4256 debug_printf_parse("parse_group return 1: "
4257 "parse_stream returned %p\n", pipe_list);
4260 command->group = pipe_list;
4262 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
4263 command->group_as_string = as_string;
4264 debug_printf_parse("end of group, remembering as:'%s'\n",
4265 command->group_as_string);
4269 debug_printf_parse("parse_group return 0\n");
4271 /* command remains "open", available for possible redirects */
4274 static int i_getch_and_eat_bkslash_nl(struct in_str *input)
4279 ch = i_getch(input);
4282 ch2 = i_peek(input);
4285 /* backslash+newline, skip it */
4290 static int i_peek_and_eat_bkslash_nl(struct in_str *input)
4298 ch2 = i_peek2(input);
4301 /* backslash+newline, skip it */
4307 #if ENABLE_HUSH_TICK || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_DOLLAR_OPS
4308 /* Subroutines for copying $(...) and `...` things */
4309 static int add_till_backquote(o_string *dest, struct in_str *input, int in_dquote);
4311 static int add_till_single_quote(o_string *dest, struct in_str *input)
4314 int ch = i_getch(input);
4316 syntax_error_unterm_ch('\'');
4324 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
4325 static int add_till_double_quote(o_string *dest, struct in_str *input)
4328 int ch = i_getch(input);
4330 syntax_error_unterm_ch('"');
4335 if (ch == '\\') { /* \x. Copy both chars. */
4337 ch = i_getch(input);
4341 if (!add_till_backquote(dest, input, /*in_dquote:*/ 1))
4346 //if (ch == '$') ...
4349 /* Process `cmd` - copy contents until "`" is seen. Complicated by
4351 * "Within the backquoted style of command substitution, backslash
4352 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
4353 * The search for the matching backquote shall be satisfied by the first
4354 * backquote found without a preceding backslash; during this search,
4355 * if a non-escaped backquote is encountered within a shell comment,
4356 * a here-document, an embedded command substitution of the $(command)
4357 * form, or a quoted string, undefined results occur. A single-quoted
4358 * or double-quoted string that begins, but does not end, within the
4359 * "`...`" sequence produces undefined results."
4361 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
4363 static int add_till_backquote(o_string *dest, struct in_str *input, int in_dquote)
4366 int ch = i_getch(input);
4370 /* \x. Copy both unless it is \`, \$, \\ and maybe \" */
4371 ch = i_getch(input);
4375 && (!in_dquote || ch != '"')
4377 o_addchr(dest, '\\');
4381 syntax_error_unterm_ch('`');
4387 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
4388 * quoting and nested ()s.
4389 * "With the $(command) style of command substitution, all characters
4390 * following the open parenthesis to the matching closing parenthesis
4391 * constitute the command. Any valid shell script can be used for command,
4392 * except a script consisting solely of redirections which produces
4393 * unspecified results."
4395 * echo $(echo '(TEST)' BEST) (TEST) BEST
4396 * echo $(echo 'TEST)' BEST) TEST) BEST
4397 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
4399 * Also adapted to eat ${var%...} and $((...)) constructs, since ... part
4400 * can contain arbitrary constructs, just like $(cmd).
4401 * In bash compat mode, it needs to also be able to stop on ':' or '/'
4402 * for ${var:N[:M]} and ${var/P[/R]} parsing.
4404 #define DOUBLE_CLOSE_CHAR_FLAG 0x80
4405 static int add_till_closing_bracket(o_string *dest, struct in_str *input, unsigned end_ch)
4408 char dbl = end_ch & DOUBLE_CLOSE_CHAR_FLAG;
4409 # if BASH_SUBSTR || BASH_PATTERN_SUBST
4410 char end_char2 = end_ch >> 8;
4412 end_ch &= (DOUBLE_CLOSE_CHAR_FLAG - 1);
4415 ch = i_getch(input);
4417 syntax_error_unterm_ch(end_ch);
4421 # if BASH_SUBSTR || BASH_PATTERN_SUBST
4427 /* we look for closing )) of $((EXPR)) */
4428 if (i_peek_and_eat_bkslash_nl(input) == end_ch) {
4429 i_getch(input); /* eat second ')' */
4434 if (ch == '(' || ch == '{') {
4435 ch = (ch == '(' ? ')' : '}');
4436 if (!add_till_closing_bracket(dest, input, ch))
4442 if (!add_till_single_quote(dest, input))
4448 if (!add_till_double_quote(dest, input))
4454 if (!add_till_backquote(dest, input, /*in_dquote:*/ 0))
4460 /* \x. Copy verbatim. Important for \(, \) */
4461 ch = i_getch(input);
4463 syntax_error_unterm_ch(')');
4468 /* "backslash+newline", ignore both */
4469 o_delchr(dest); /* undo insertion of '\' */
4479 #endif /* ENABLE_HUSH_TICK || ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_DOLLAR_OPS */
4481 /* Return code: 0 for OK, 1 for syntax error */
4483 #define parse_dollar(as_string, dest, input, quote_mask) \
4484 parse_dollar(dest, input, quote_mask)
4485 #define as_string NULL
4487 static int parse_dollar(o_string *as_string,
4489 struct in_str *input, unsigned char quote_mask)
4491 int ch = i_peek_and_eat_bkslash_nl(input); /* first character after the $ */
4493 debug_printf_parse("parse_dollar entered: ch='%c'\n", ch);
4495 ch = i_getch(input);
4496 nommu_addchr(as_string, ch);
4498 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4500 debug_printf_parse(": '%c'\n", ch);
4501 o_addchr(dest, ch | quote_mask);
4503 ch = i_peek_and_eat_bkslash_nl(input);
4504 if (!isalnum(ch) && ch != '_') {
4505 /* End of variable name reached */
4508 ch = i_getch(input);
4509 nommu_addchr(as_string, ch);
4511 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4512 } else if (isdigit(ch)) {
4514 ch = i_getch(input);
4515 nommu_addchr(as_string, ch);
4516 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4517 debug_printf_parse(": '%c'\n", ch);
4518 o_addchr(dest, ch | quote_mask);
4519 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4520 } else switch (ch) {
4522 case '!': /* last bg pid */
4523 case '?': /* last exit code */
4524 case '#': /* number of args */
4525 case '*': /* args */
4526 case '@': /* args */
4527 goto make_one_char_var;
4531 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4533 ch = i_getch(input); /* eat '{' */
4534 nommu_addchr(as_string, ch);
4536 ch = i_getch_and_eat_bkslash_nl(input); /* first char after '{' */
4537 /* It should be ${?}, or ${#var},
4538 * or even ${?+subst} - operator acting on a special variable,
4539 * or the beginning of variable name.
4542 || (!strchr(_SPECIAL_VARS_STR, ch) && !isalnum(ch)) /* not one of those */
4545 syntax_error_unterm_str("${name}");
4546 debug_printf_parse("parse_dollar return 0: unterminated ${name}\n");
4549 nommu_addchr(as_string, ch);
4553 /* It's possible to just call add_till_closing_bracket() at this point.
4554 * However, this regresses some of our testsuite cases
4555 * which check invalid constructs like ${%}.
4556 * Oh well... let's check that the var name part is fine... */
4562 debug_printf_parse(": '%c'\n", ch);
4564 ch = i_getch(input);
4565 nommu_addchr(as_string, ch);
4569 if (!isalnum(ch) && ch != '_') {
4571 unsigned char last_ch;
4572 /* handle parameter expansions
4573 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4575 if (!strchr(VAR_SUBST_OPS, ch)) { /* ${var<bad_char>... */
4576 if (len_single_ch != '#'
4577 /*|| !strchr(SPECIAL_VARS_STR, ch) - disallow errors like ${#+} ? */
4578 || i_peek(input) != '}'
4580 goto bad_dollar_syntax;
4582 /* else: it's "length of C" ${#C} op,
4583 * where C is a single char
4584 * special var name, e.g. ${#!}.
4587 /* Eat everything until closing '}' (or ':') */
4591 && !strchr(MINUS_PLUS_EQUAL_QUESTION, i_peek(input))
4593 /* It's ${var:N[:M]} thing */
4594 end_ch = '}' * 0x100 + ':';
4596 if (BASH_PATTERN_SUBST
4599 /* It's ${var/[/]pattern[/repl]} thing */
4600 if (i_peek(input) == '/') { /* ${var//pattern[/repl]}? */
4602 nommu_addchr(as_string, '/');
4605 end_ch = '}' * 0x100 + '/';
4611 #if ENABLE_HUSH_DOLLAR_OPS
4612 last_ch = add_till_closing_bracket(dest, input, end_ch);
4613 if (last_ch == 0) /* error? */
4616 #error Simple code to only allow ${var} is not implemented
4619 o_addstr(as_string, dest->data + pos);
4620 o_addchr(as_string, last_ch);
4623 if ((BASH_SUBSTR || BASH_PATTERN_SUBST)
4624 && (end_ch & 0xff00)
4626 /* close the first block: */
4627 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4628 /* while parsing N from ${var:N[:M]}
4629 * or pattern from ${var/[/]pattern[/repl]} */
4630 if ((end_ch & 0xff) == last_ch) {
4631 /* got ':' or '/'- parse the rest */
4636 if (BASH_SUBSTR && end_ch == '}' * 0x100 + ':') {
4637 /* it's ${var:N} - emulate :999999999 */
4638 o_addstr(dest, "999999999");
4639 } /* else: it's ${var/[/]pattern} */
4643 len_single_ch = 0; /* it can't be ${#C} op */
4645 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4648 #if ENABLE_FEATURE_SH_MATH || ENABLE_HUSH_TICK
4652 ch = i_getch(input);
4653 nommu_addchr(as_string, ch);
4654 # if ENABLE_FEATURE_SH_MATH
4655 if (i_peek_and_eat_bkslash_nl(input) == '(') {
4656 ch = i_getch(input);
4657 nommu_addchr(as_string, ch);
4658 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4659 o_addchr(dest, /*quote_mask |*/ '+');
4662 if (!add_till_closing_bracket(dest, input, ')' | DOUBLE_CLOSE_CHAR_FLAG))
4663 return 0; /* error */
4665 o_addstr(as_string, dest->data + pos);
4666 o_addchr(as_string, ')');
4667 o_addchr(as_string, ')');
4669 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4673 # if ENABLE_HUSH_TICK
4674 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4675 o_addchr(dest, quote_mask | '`');
4678 if (!add_till_closing_bracket(dest, input, ')'))
4679 return 0; /* error */
4681 o_addstr(as_string, dest->data + pos);
4682 o_addchr(as_string, ')');
4684 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4690 ch = i_getch(input);
4691 nommu_addchr(as_string, ch);
4692 ch = i_peek_and_eat_bkslash_nl(input);
4693 if (isalnum(ch)) { /* it's $_name or $_123 */
4698 /* TODO: $_ and $-: */
4699 /* $_ Shell or shell script name; or last argument of last command
4700 * (if last command wasn't a pipe; if it was, bash sets $_ to "");
4701 * but in command's env, set to full pathname used to invoke it */
4702 /* $- Option flags set by set builtin or shell options (-i etc) */
4704 o_addQchr(dest, '$');
4706 debug_printf_parse("parse_dollar return 1 (ok)\n");
4712 # if BASH_PATTERN_SUBST
4713 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4714 encode_string(dest, input, dquote_end, process_bkslash)
4716 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
4717 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4718 encode_string(dest, input, dquote_end)
4720 #define as_string NULL
4724 # if BASH_PATTERN_SUBST
4725 /* all parameters are needed, no macro tricks */
4727 #define encode_string(as_string, dest, input, dquote_end, process_bkslash) \
4728 encode_string(as_string, dest, input, dquote_end)
4731 static int encode_string(o_string *as_string,
4733 struct in_str *input,
4735 int process_bkslash)
4737 #if !BASH_PATTERN_SUBST
4738 const int process_bkslash = 1;
4744 ch = i_getch(input);
4746 nommu_addchr(as_string, ch);
4747 if (ch == dquote_end) { /* may be only '"' or EOF */
4748 debug_printf_parse("encode_string return 1 (ok)\n");
4751 /* note: can't move it above ch == dquote_end check! */
4753 syntax_error_unterm_ch('"');
4754 return 0; /* error */
4758 next = i_peek(input);
4760 debug_printf_parse("\" ch=%c (%d) escape=%d\n",
4761 ch, ch, !!(dest->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
4762 if (process_bkslash && ch == '\\') {
4764 syntax_error("\\<eof>");
4768 * "The backslash retains its special meaning [in "..."]
4769 * only when followed by one of the following characters:
4770 * $, `, ", \, or <newline>. A double quote may be quoted
4771 * within double quotes by preceding it with a backslash."
4772 * NB: in (unquoted) heredoc, above does not apply to ",
4773 * therefore we check for it by "next == dquote_end" cond.
4775 if (next == dquote_end || strchr("$`\\\n", next)) {
4776 ch = i_getch(input); /* eat next */
4778 goto again; /* skip \<newline> */
4779 } /* else: ch remains == '\\', and we double it below: */
4780 o_addqchr(dest, ch); /* \c if c is a glob char, else just c */
4781 nommu_addchr(as_string, ch);
4785 if (!parse_dollar(as_string, dest, input, /*quote_mask:*/ 0x80)) {
4786 debug_printf_parse("encode_string return 0: "
4787 "parse_dollar returned 0 (error)\n");
4792 #if ENABLE_HUSH_TICK
4794 //unsigned pos = dest->length;
4795 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4796 o_addchr(dest, 0x80 | '`');
4797 if (!add_till_backquote(dest, input, /*in_dquote:*/ dquote_end == '"'))
4798 return 0; /* error */
4799 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4800 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4804 o_addQchr(dest, ch);
4810 * Scan input until EOF or end_trigger char.
4811 * Return a list of pipes to execute, or NULL on EOF
4812 * or if end_trigger character is met.
4813 * On syntax error, exit if shell is not interactive,
4814 * reset parsing machinery and start parsing anew,
4815 * or return ERR_PTR.
4817 static struct pipe *parse_stream(char **pstring,
4818 struct in_str *input,
4821 struct parse_context ctx;
4822 o_string dest = NULL_O_STRING;
4825 /* Single-quote triggers a bypass of the main loop until its mate is
4826 * found. When recursing, quote state is passed in via dest->o_expflags.
4828 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4829 end_trigger ? end_trigger : 'X');
4832 /* If very first arg is "" or '', dest.data may end up NULL.
4833 * Preventing this: */
4834 o_addchr(&dest, '\0');
4837 /* We used to separate words on $IFS here. This was wrong.
4838 * $IFS is used only for word splitting when $var is expanded,
4839 * here we should use blank chars as separators, not $IFS
4842 if (MAYBE_ASSIGNMENT != 0)
4843 dest.o_assignment = MAYBE_ASSIGNMENT;
4844 initialize_context(&ctx);
4847 const char *is_blank;
4848 const char *is_special;
4852 redir_type redir_style;
4854 ch = i_getch(input);
4855 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4856 ch, ch, !!(dest.o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
4861 syntax_error_unterm_str("here document");
4864 if (end_trigger == ')') {
4865 syntax_error_unterm_ch('(');
4868 if (end_trigger == '}') {
4869 syntax_error_unterm_ch('{');
4873 if (done_word(&dest, &ctx)) {
4877 done_pipe(&ctx, PIPE_SEQ);
4879 /* If we got nothing... */
4880 /* (this makes bare "&" cmd a no-op.
4881 * bash says: "syntax error near unexpected token '&'") */
4882 if (pi->num_cmds == 0
4883 IF_HAS_KEYWORDS(&& pi->res_word == RES_NONE)
4889 debug_printf_parse("as_string1 '%s'\n", ctx.as_string.data);
4891 *pstring = ctx.as_string.data;
4893 o_free_unsafe(&ctx.as_string);
4896 debug_printf_parse("parse_stream return %p\n", pi);
4899 nommu_addchr(&ctx.as_string, ch);
4903 next = i_peek(input);
4905 is_special = "{}<>;&|()#'" /* special outside of "str" */
4906 "\\$\"" IF_HUSH_TICK("`") /* always special */
4907 SPECIAL_VAR_SYMBOL_STR;
4908 /* Are { and } special here? */
4909 if (ctx.command->argv /* word [word]{... - non-special */
4910 || dest.length /* word{... - non-special */
4911 || dest.has_quoted_part /* ""{... - non-special */
4912 || (next != ';' /* }; - special */
4913 && next != ')' /* }) - special */
4914 && next != '(' /* {( - special */
4915 && next != '&' /* }& and }&& ... - special */
4916 && next != '|' /* }|| ... - special */
4917 && !strchr(defifs, next) /* {word - non-special */
4920 /* They are not special, skip "{}" */
4923 is_special = strchr(is_special, ch);
4924 is_blank = strchr(defifs, ch);
4926 if (!is_special && !is_blank) { /* ordinary char */
4928 o_addQchr(&dest, ch);
4929 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4930 || dest.o_assignment == WORD_IS_KEYWORD)
4932 && is_well_formed_var_name(dest.data, '=')
4934 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4935 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
4941 if (done_word(&dest, &ctx)) {
4945 /* Is this a case when newline is simply ignored?
4947 * "cmd | <newline> cmd ..."
4948 * "case ... in <newline> word) ..."
4950 if (IS_NULL_CMD(ctx.command)
4951 && dest.length == 0 && !dest.has_quoted_part
4953 /* This newline can be ignored. But...
4954 * Without check #1, interactive shell
4955 * ignores even bare <newline>,
4956 * and shows the continuation prompt:
4957 * ps1_prompt$ <enter>
4958 * ps2> _ <=== wrong, should be ps1
4959 * Without check #2, "cmd & <newline>"
4960 * is similarly mistreated.
4961 * (BTW, this makes "cmd & cmd"
4962 * and "cmd && cmd" non-orthogonal.
4963 * Really, ask yourself, why
4964 * "cmd && <newline>" doesn't start
4965 * cmd but waits for more input?
4966 * The only reason is that it might be
4967 * a "cmd1 && <nl> cmd2 &" construct,
4968 * cmd1 may need to run in BG).
4970 struct pipe *pi = ctx.list_head;
4971 if (pi->num_cmds != 0 /* check #1 */
4972 && pi->followup != PIPE_BG /* check #2 */
4977 /* Treat newline as a command separator. */
4978 done_pipe(&ctx, PIPE_SEQ);
4979 debug_printf_parse("heredoc_cnt:%d\n", heredoc_cnt);
4981 if (fetch_heredocs(heredoc_cnt, &ctx, input)) {
4986 dest.o_assignment = MAYBE_ASSIGNMENT;
4987 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
4989 /* note: if (is_blank) continue;
4990 * will still trigger for us */
4994 /* "cmd}" or "cmd }..." without semicolon or &:
4995 * } is an ordinary char in this case, even inside { cmd; }
4996 * Pathological example: { ""}; } should exec "}" cmd
4999 if (dest.length != 0 /* word} */
5000 || dest.has_quoted_part /* ""} */
5004 if (!IS_NULL_CMD(ctx.command)) { /* cmd } */
5005 /* Generally, there should be semicolon: "cmd; }"
5006 * However, bash allows to omit it if "cmd" is
5007 * a group. Examples:
5010 * { echo 0 >&2 | { echo 1; } }
5011 * { while false; do :; done }
5012 * { case a in b) ;; esac }
5014 if (ctx.command->group)
5018 if (!IS_NULL_PIPE(ctx.pipe)) /* cmd | } */
5019 /* Can't be an end of {cmd}, skip the check */
5020 goto skip_end_trigger;
5021 /* else: } does terminate a group */
5024 if (end_trigger && end_trigger == ch
5025 && (ch != ';' || heredoc_cnt == 0)
5026 #if ENABLE_HUSH_CASE
5028 || ctx.ctx_res_w != RES_MATCH
5029 || (!dest.has_quoted_part && strcmp(dest.data, "esac") == 0)
5034 /* This is technically valid:
5035 * { cat <<HERE; }; echo Ok
5039 * but we don't support this.
5040 * We require heredoc to be in enclosing {}/(),
5043 syntax_error_unterm_str("here document");
5046 if (done_word(&dest, &ctx)) {
5049 done_pipe(&ctx, PIPE_SEQ);
5050 dest.o_assignment = MAYBE_ASSIGNMENT;
5051 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
5052 /* Do we sit outside of any if's, loops or case's? */
5054 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
5058 debug_printf_parse("as_string2 '%s'\n", ctx.as_string.data);
5060 *pstring = ctx.as_string.data;
5062 o_free_unsafe(&ctx.as_string);
5064 if (ch != ';' && IS_NULL_PIPE(ctx.list_head)) {
5065 /* Example: bare "{ }", "()" */
5066 G.last_exitcode = 2; /* bash compat */
5067 syntax_error_unexpected_ch(ch);
5070 debug_printf_parse("parse_stream return %p: "
5071 "end_trigger char found\n",
5074 return ctx.list_head;
5081 /* Catch <, > before deciding whether this word is
5082 * an assignment. a=1 2>z b=2: b=2 is still assignment */
5085 redir_fd = redirect_opt_num(&dest);
5086 if (done_word(&dest, &ctx)) {
5089 redir_style = REDIRECT_OVERWRITE;
5091 redir_style = REDIRECT_APPEND;
5092 ch = i_getch(input);
5093 nommu_addchr(&ctx.as_string, ch);
5096 else if (next == '(') {
5097 syntax_error(">(process) not supported");
5101 if (parse_redirect(&ctx, redir_fd, redir_style, input))
5103 continue; /* back to top of while (1) */
5105 redir_fd = redirect_opt_num(&dest);
5106 if (done_word(&dest, &ctx)) {
5109 redir_style = REDIRECT_INPUT;
5111 redir_style = REDIRECT_HEREDOC;
5113 debug_printf_parse("++heredoc_cnt=%d\n", heredoc_cnt);
5114 ch = i_getch(input);
5115 nommu_addchr(&ctx.as_string, ch);
5116 } else if (next == '>') {
5117 redir_style = REDIRECT_IO;
5118 ch = i_getch(input);
5119 nommu_addchr(&ctx.as_string, ch);
5122 else if (next == '(') {
5123 syntax_error("<(process) not supported");
5127 if (parse_redirect(&ctx, redir_fd, redir_style, input))
5129 continue; /* back to top of while (1) */
5131 if (dest.length == 0 && !dest.has_quoted_part) {
5132 /* skip "#comment" */
5133 /* note: we do not add it to &ctx.as_string */
5135 * comment inside $() goes to the next \n, even inside quoted string (!):
5136 * cmd "$(cmd2 #comment)" - syntax error
5137 * cmd "`cmd2 #comment`" - ok
5138 * We accept both (comment ends where command subst ends, in both cases).
5143 nommu_addchr(&ctx.as_string, '\n');
5146 ch = i_getch(input);
5150 continue; /* back to top of while (1) */
5155 /* It's "\<newline>" */
5157 /* Remove trailing '\' from ctx.as_string */
5158 ctx.as_string.data[--ctx.as_string.length] = '\0';
5160 ch = i_getch(input); /* eat it */
5161 continue; /* back to top of while (1) */
5166 if (dest.o_assignment == MAYBE_ASSIGNMENT
5167 /* check that we are not in word in "a=1 2>word b=1": */
5168 && !ctx.pending_redirect
5170 /* ch is a special char and thus this word
5171 * cannot be an assignment */
5172 dest.o_assignment = NOT_ASSIGNMENT;
5173 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
5176 /* Note: nommu_addchr(&ctx.as_string, ch) is already done */
5179 case SPECIAL_VAR_SYMBOL:
5180 /* Convert raw ^C to corresponding special variable reference */
5181 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5182 o_addchr(&dest, SPECIAL_VAR_QUOTED_SVS);
5185 /* non-comment #: "echo a#b" etc */
5186 o_addchr(&dest, ch);
5190 syntax_error("\\<eof>");
5193 ch = i_getch(input);
5194 /* note: ch != '\n' (that case does not reach this place) */
5195 o_addchr(&dest, '\\');
5196 /*nommu_addchr(&ctx.as_string, '\\'); - already done */
5197 o_addchr(&dest, ch);
5198 nommu_addchr(&ctx.as_string, ch);
5199 /* Example: echo Hello \2>file
5200 * we need to know that word 2 is quoted */
5201 dest.has_quoted_part = 1;
5204 if (!parse_dollar(&ctx.as_string, &dest, input, /*quote_mask:*/ 0)) {
5205 debug_printf_parse("parse_stream parse error: "
5206 "parse_dollar returned 0 (error)\n");
5211 dest.has_quoted_part = 1;
5212 if (next == '\'' && !ctx.pending_redirect) {
5213 insert_empty_quoted_str_marker:
5214 nommu_addchr(&ctx.as_string, next);
5215 i_getch(input); /* eat second ' */
5216 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5217 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5220 ch = i_getch(input);
5222 syntax_error_unterm_ch('\'');
5225 nommu_addchr(&ctx.as_string, ch);
5228 if (ch == SPECIAL_VAR_SYMBOL) {
5229 /* Convert raw ^C to corresponding special variable reference */
5230 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5231 o_addchr(&dest, SPECIAL_VAR_QUOTED_SVS);
5233 o_addqchr(&dest, ch);
5238 dest.has_quoted_part = 1;
5239 if (next == '"' && !ctx.pending_redirect)
5240 goto insert_empty_quoted_str_marker;
5241 if (dest.o_assignment == NOT_ASSIGNMENT)
5242 dest.o_expflags |= EXP_FLAG_ESC_GLOB_CHARS;
5243 if (!encode_string(&ctx.as_string, &dest, input, '"', /*process_bkslash:*/ 1))
5245 dest.o_expflags &= ~EXP_FLAG_ESC_GLOB_CHARS;
5247 #if ENABLE_HUSH_TICK
5249 USE_FOR_NOMMU(unsigned pos;)
5251 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5252 o_addchr(&dest, '`');
5253 USE_FOR_NOMMU(pos = dest.length;)
5254 if (!add_till_backquote(&dest, input, /*in_dquote:*/ 0))
5257 o_addstr(&ctx.as_string, dest.data + pos);
5258 o_addchr(&ctx.as_string, '`');
5260 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
5261 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
5266 #if ENABLE_HUSH_CASE
5269 if (done_word(&dest, &ctx)) {
5272 done_pipe(&ctx, PIPE_SEQ);
5273 #if ENABLE_HUSH_CASE
5274 /* Eat multiple semicolons, detect
5275 * whether it means something special */
5280 ch = i_getch(input);
5281 nommu_addchr(&ctx.as_string, ch);
5282 if (ctx.ctx_res_w == RES_CASE_BODY) {
5283 ctx.ctx_dsemicolon = 1;
5284 ctx.ctx_res_w = RES_MATCH;
5290 /* We just finished a cmd. New one may start
5291 * with an assignment */
5292 dest.o_assignment = MAYBE_ASSIGNMENT;
5293 debug_printf_parse("dest.o_assignment='%s'\n", assignment_flag[dest.o_assignment]);
5296 if (done_word(&dest, &ctx)) {
5300 ch = i_getch(input);
5301 nommu_addchr(&ctx.as_string, ch);
5302 done_pipe(&ctx, PIPE_AND);
5304 done_pipe(&ctx, PIPE_BG);
5308 if (done_word(&dest, &ctx)) {
5311 #if ENABLE_HUSH_CASE
5312 if (ctx.ctx_res_w == RES_MATCH)
5313 break; /* we are in case's "word | word)" */
5315 if (next == '|') { /* || */
5316 ch = i_getch(input);
5317 nommu_addchr(&ctx.as_string, ch);
5318 done_pipe(&ctx, PIPE_OR);
5320 /* we could pick up a file descriptor choice here
5321 * with redirect_opt_num(), but bash doesn't do it.
5322 * "echo foo 2| cat" yields "foo 2". */
5327 #if ENABLE_HUSH_CASE
5328 /* "case... in [(]word)..." - skip '(' */
5329 if (ctx.ctx_res_w == RES_MATCH
5330 && ctx.command->argv == NULL /* not (word|(... */
5331 && dest.length == 0 /* not word(... */
5332 && dest.has_quoted_part == 0 /* not ""(... */
5338 if (parse_group(&dest, &ctx, input, ch) != 0) {
5343 #if ENABLE_HUSH_CASE
5344 if (ctx.ctx_res_w == RES_MATCH)
5348 /* proper use of this character is caught by end_trigger:
5349 * if we see {, we call parse_group(..., end_trigger='}')
5350 * and it will match } earlier (not here). */
5351 G.last_exitcode = 2;
5352 syntax_error_unexpected_ch(ch);
5356 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
5361 G.last_exitcode = 1;
5364 struct parse_context *pctx;
5365 IF_HAS_KEYWORDS(struct parse_context *p2;)
5367 /* Clean up allocated tree.
5368 * Sample for finding leaks on syntax error recovery path.
5369 * Run it from interactive shell, watch pmap `pidof hush`.
5370 * while if false; then false; fi; do break; fi
5371 * Samples to catch leaks at execution:
5372 * while if (true | { true;}); then echo ok; fi; do break; done
5373 * while if (true | { true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
5377 /* Update pipe/command counts,
5378 * otherwise freeing may miss some */
5379 done_pipe(pctx, PIPE_SEQ);
5380 debug_printf_clean("freeing list %p from ctx %p\n",
5381 pctx->list_head, pctx);
5382 debug_print_tree(pctx->list_head, 0);
5383 free_pipe_list(pctx->list_head);
5384 debug_printf_clean("freed list %p\n", pctx->list_head);
5386 o_free_unsafe(&pctx->as_string);
5388 IF_HAS_KEYWORDS(p2 = pctx->stack;)
5392 IF_HAS_KEYWORDS(pctx = p2;)
5393 } while (HAS_KEYWORDS && pctx);
5406 /*** Execution routines ***/
5408 /* Expansion can recurse, need forward decls: */
5409 #if !BASH_PATTERN_SUBST && !ENABLE_HUSH_CASE
5410 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
5411 #define expand_string_to_string(str, do_unbackslash) \
5412 expand_string_to_string(str)
5414 static char *expand_string_to_string(const char *str, int do_unbackslash);
5415 #if ENABLE_HUSH_TICK
5416 static int process_command_subs(o_string *dest, const char *s);
5419 /* expand_strvec_to_strvec() takes a list of strings, expands
5420 * all variable references within and returns a pointer to
5421 * a list of expanded strings, possibly with larger number
5422 * of strings. (Think VAR="a b"; echo $VAR).
5423 * This new list is allocated as a single malloc block.
5424 * NULL-terminated list of char* pointers is at the beginning of it,
5425 * followed by strings themselves.
5426 * Caller can deallocate entire list by single free(list). */
5428 /* A horde of its helpers come first: */
5430 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
5432 while (--len >= 0) {
5435 #if ENABLE_HUSH_BRACE_EXPANSION
5436 if (c == '{' || c == '}') {
5437 /* { -> \{, } -> \} */
5439 /* And now we want to add { or } and continue:
5442 * luckily, just falling through achieves this.
5448 /* \z -> \\\z; \<eol> -> \\<eol> */
5453 o_addchr(o, *str++);
5459 /* Store given string, finalizing the word and starting new one whenever
5460 * we encounter IFS char(s). This is used for expanding variable values.
5461 * End-of-string does NOT finalize word: think about 'echo -$VAR-'.
5462 * Return in *ended_with_ifs:
5463 * 1 - ended with IFS char, else 0 (this includes case of empty str).
5465 static int expand_on_ifs(int *ended_with_ifs, o_string *output, int n, const char *str)
5467 int last_is_ifs = 0;
5472 if (!*str) /* EOL - do not finalize word */
5474 word_len = strcspn(str, G.ifs);
5476 /* We have WORD_LEN leading non-IFS chars */
5477 if (!(output->o_expflags & EXP_FLAG_GLOB)) {
5478 o_addblock(output, str, word_len);
5480 /* Protect backslashes against globbing up :)
5481 * Example: "v='\*'; echo b$v" prints "b\*"
5482 * (and does not try to glob on "*")
5484 o_addblock_duplicate_backslash(output, str, word_len);
5485 /*/ Why can't we do it easier? */
5486 /*o_addblock(output, str, word_len); - WRONG: "v='\*'; echo Z$v" prints "Z*" instead of "Z\*" */
5487 /*o_addqblock(output, str, word_len); - WRONG: "v='*'; echo Z$v" prints "Z*" instead of Z* files */
5491 if (!*str) /* EOL - do not finalize word */
5495 /* We know str here points to at least one IFS char */
5497 str += strspn(str, G.ifs); /* skip IFS chars */
5498 if (!*str) /* EOL - do not finalize word */
5501 /* Start new word... but not always! */
5502 /* Case "v=' a'; echo ''$v": we do need to finalize empty word: */
5503 if (output->has_quoted_part
5504 /* Case "v=' a'; echo $v":
5505 * here nothing precedes the space in $v expansion,
5506 * therefore we should not finish the word
5507 * (IOW: if there *is* word to finalize, only then do it):
5509 || (n > 0 && output->data[output->length - 1])
5511 o_addchr(output, '\0');
5512 debug_print_list("expand_on_ifs", output, n);
5513 n = o_save_ptr(output, n);
5518 *ended_with_ifs = last_is_ifs;
5519 debug_print_list("expand_on_ifs[1]", output, n);
5523 /* Helper to expand $((...)) and heredoc body. These act as if
5524 * they are in double quotes, with the exception that they are not :).
5525 * Just the rules are similar: "expand only $var and `cmd`"
5527 * Returns malloced string.
5528 * As an optimization, we return NULL if expansion is not needed.
5530 #if !BASH_PATTERN_SUBST
5531 /* only ${var/pattern/repl} (its pattern part) needs additional mode */
5532 #define encode_then_expand_string(str, process_bkslash, do_unbackslash) \
5533 encode_then_expand_string(str)
5535 static char *encode_then_expand_string(const char *str, int process_bkslash, int do_unbackslash)
5537 #if !BASH_PATTERN_SUBST
5538 enum { do_unbackslash = 1 };
5541 struct in_str input;
5542 o_string dest = NULL_O_STRING;
5544 if (!strchr(str, '$')
5545 && !strchr(str, '\\')
5546 #if ENABLE_HUSH_TICK
5547 && !strchr(str, '`')
5553 /* We need to expand. Example:
5554 * echo $(($a + `echo 1`)) $((1 + $((2)) ))
5556 setup_string_in_str(&input, str);
5557 encode_string(NULL, &dest, &input, EOF, process_bkslash);
5558 //TODO: error check (encode_string returns 0 on error)?
5559 //bb_error_msg("'%s' -> '%s'", str, dest.data);
5560 exp_str = expand_string_to_string(dest.data, /*unbackslash:*/ do_unbackslash);
5561 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
5562 o_free_unsafe(&dest);
5566 #if ENABLE_FEATURE_SH_MATH
5567 static arith_t expand_and_evaluate_arith(const char *arg, const char **errmsg_p)
5569 arith_state_t math_state;
5573 math_state.lookupvar = get_local_var_value;
5574 math_state.setvar = set_local_var_from_halves;
5575 //math_state.endofname = endofname;
5576 exp_str = encode_then_expand_string(arg, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5577 res = arith(&math_state, exp_str ? exp_str : arg);
5580 *errmsg_p = math_state.errmsg;
5581 if (math_state.errmsg)
5582 msg_and_die_if_script(math_state.errmsg);
5587 #if BASH_PATTERN_SUBST
5588 /* ${var/[/]pattern[/repl]} helpers */
5589 static char *strstr_pattern(char *val, const char *pattern, int *size)
5592 char *end = scan_and_match(val, pattern, SCAN_MOVE_FROM_RIGHT + SCAN_MATCH_LEFT_HALF);
5593 debug_printf_varexp("val:'%s' pattern:'%s' end:'%s'\n", val, pattern, end);
5600 /* Optimization: if "*pat" did not match the start of "string",
5601 * we know that "tring", "ring" etc will not match too:
5603 if (pattern[0] == '*')
5608 static char *replace_pattern(char *val, const char *pattern, const char *repl, char exp_op)
5610 char *result = NULL;
5611 unsigned res_len = 0;
5612 unsigned repl_len = strlen(repl);
5616 char *s = strstr_pattern(val, pattern, &size);
5620 result = xrealloc(result, res_len + (s - val) + repl_len + 1);
5621 strcpy(mempcpy(result + res_len, val, s - val), repl);
5622 res_len += (s - val) + repl_len;
5623 debug_printf_varexp("val:'%s' s:'%s' result:'%s'\n", val, s, result);
5629 if (*val && result) {
5630 result = xrealloc(result, res_len + strlen(val) + 1);
5631 strcpy(result + res_len, val);
5632 debug_printf_varexp("val:'%s' result:'%s'\n", val, result);
5634 debug_printf_varexp("result:'%s'\n", result);
5637 #endif /* BASH_PATTERN_SUBST */
5640 * Handles <SPECIAL_VAR_SYMBOL>varname...<SPECIAL_VAR_SYMBOL> construct.
5642 static NOINLINE const char *expand_one_var(char **to_be_freed_pp, char *arg, char **pp)
5644 const char *val = NULL;
5645 char *to_be_freed = NULL;
5650 char exp_save = exp_save; /* for compiler */
5651 char *exp_saveptr; /* points to expansion operator */
5652 char *exp_word = exp_word; /* for compiler */
5655 *p = '\0'; /* replace trailing SPECIAL_VAR_SYMBOL */
5657 exp_saveptr = arg[1] ? strchr(VAR_ENCODED_SUBST_OPS, arg[1]) : NULL;
5659 first_char = arg[0] = arg0 & 0x7f;
5662 if (first_char == '#' && arg[1] /* ${#...} but not ${#} */
5663 && (!exp_saveptr /* and ( not(${#<op_char>...}) */
5664 || (arg[2] == '\0' && strchr(SPECIAL_VARS_STR, arg[1])) /* or ${#C} "len of $C" ) */
5665 ) /* NB: skipping ^^^specvar check mishandles ${#::2} */
5667 /* It must be length operator: ${#var} */
5671 /* Maybe handle parameter expansion */
5672 if (exp_saveptr /* if 2nd char is one of expansion operators */
5673 && strchr(NUMERIC_SPECVARS_STR, first_char) /* 1st char is special variable */
5675 /* ${?:0}, ${#[:]%0} etc */
5676 exp_saveptr = var + 1;
5678 /* ${?}, ${var}, ${var:0}, ${var[:]%0} etc */
5679 exp_saveptr = var+1 + strcspn(var+1, VAR_ENCODED_SUBST_OPS);
5681 exp_op = exp_save = *exp_saveptr;
5683 exp_word = exp_saveptr + 1;
5684 if (exp_op == ':') {
5685 exp_op = *exp_word++;
5686 //TODO: try ${var:} and ${var:bogus} in non-bash config
5688 && (!exp_op || !strchr(MINUS_PLUS_EQUAL_QUESTION, exp_op))
5690 /* oops... it's ${var:N[:M]}, not ${var:?xxx} or some such */
5695 *exp_saveptr = '\0';
5696 } /* else: it's not an expansion op, but bare ${var} */
5699 /* Look up the variable in question */
5700 if (isdigit(var[0])) {
5701 /* parse_dollar should have vetted var for us */
5702 int n = xatoi_positive(var);
5703 if (n < G.global_argc)
5704 val = G.global_argv[n];
5705 /* else val remains NULL: $N with too big N */
5709 val = utoa(G.root_pid);
5711 case '!': /* bg pid */
5712 val = G.last_bg_pid ? utoa(G.last_bg_pid) : "";
5714 case '?': /* exitcode */
5715 val = utoa(G.last_exitcode);
5717 case '#': /* argc */
5718 val = utoa(G.global_argc ? G.global_argc-1 : 0);
5721 val = get_local_var_value(var);
5725 /* Handle any expansions */
5726 if (exp_op == 'L') {
5727 reinit_unicode_for_hush();
5728 debug_printf_expand("expand: length(%s)=", val);
5729 val = utoa(val ? unicode_strlen(val) : 0);
5730 debug_printf_expand("%s\n", val);
5731 } else if (exp_op) {
5732 if (exp_op == '%' || exp_op == '#') {
5733 /* Standard-mandated substring removal ops:
5734 * ${parameter%word} - remove smallest suffix pattern
5735 * ${parameter%%word} - remove largest suffix pattern
5736 * ${parameter#word} - remove smallest prefix pattern
5737 * ${parameter##word} - remove largest prefix pattern
5739 * Word is expanded to produce a glob pattern.
5740 * Then var's value is matched to it and matching part removed.
5742 if (val && val[0]) {
5746 unsigned scan_flags = pick_scan(exp_op, *exp_word);
5747 if (exp_op == *exp_word) /* ## or %% */
5749 exp_exp_word = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5751 exp_word = exp_exp_word;
5752 /* HACK ALERT. We depend here on the fact that
5753 * G.global_argv and results of utoa and get_local_var_value
5754 * are actually in writable memory:
5755 * scan_and_match momentarily stores NULs there. */
5757 loc = scan_and_match(t, exp_word, scan_flags);
5758 //bb_error_msg("op:%c str:'%s' pat:'%s' res:'%s'",
5759 // exp_op, t, exp_word, loc);
5761 if (loc) { /* match was found */
5762 if (scan_flags & SCAN_MATCH_LEFT_HALF) /* #[#] */
5763 val = loc; /* take right part */
5765 val = to_be_freed = xstrndup(val, loc - val); /* left */
5769 #if BASH_PATTERN_SUBST
5770 else if (exp_op == '/' || exp_op == '\\') {
5771 /* It's ${var/[/]pattern[/repl]} thing.
5772 * Note that in encoded form it has TWO parts:
5773 * var/pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5774 * and if // is used, it is encoded as \:
5775 * var\pattern<SPECIAL_VAR_SYMBOL>repl<SPECIAL_VAR_SYMBOL>
5777 /* Empty variable always gives nothing: */
5778 // "v=''; echo ${v/*/w}" prints "", not "w"
5779 if (val && val[0]) {
5780 /* pattern uses non-standard expansion.
5781 * repl should be unbackslashed and globbed
5782 * by the usual expansion rules:
5784 * v='a bz'; echo "${v/a*z/a*z}" prints "a*z"
5785 * v='a bz'; echo "${v/a*z/\z}" prints "\z"
5786 * v='a bz'; echo ${v/a*z/a*z} prints "az"
5787 * v='a bz'; echo ${v/a*z/\z} prints "z"
5788 * (note that a*z _pattern_ is never globbed!)
5790 char *pattern, *repl, *t;
5791 pattern = encode_then_expand_string(exp_word, /*process_bkslash:*/ 0, /*unbackslash:*/ 0);
5793 pattern = xstrdup(exp_word);
5794 debug_printf_varexp("pattern:'%s'->'%s'\n", exp_word, pattern);
5795 *p++ = SPECIAL_VAR_SYMBOL;
5797 p = strchr(p, SPECIAL_VAR_SYMBOL);
5799 repl = encode_then_expand_string(exp_word, /*process_bkslash:*/ arg0 & 0x80, /*unbackslash:*/ 1);
5800 debug_printf_varexp("repl:'%s'->'%s'\n", exp_word, repl);
5801 /* HACK ALERT. We depend here on the fact that
5802 * G.global_argv and results of utoa and get_local_var_value
5803 * are actually in writable memory:
5804 * replace_pattern momentarily stores NULs there. */
5806 to_be_freed = replace_pattern(t,
5808 (repl ? repl : exp_word),
5810 if (to_be_freed) /* at least one replace happened */
5816 #endif /* BASH_PATTERN_SUBST */
5817 else if (exp_op == ':') {
5818 #if BASH_SUBSTR && ENABLE_FEATURE_SH_MATH
5819 /* It's ${var:N[:M]} bashism.
5820 * Note that in encoded form it has TWO parts:
5821 * var:N<SPECIAL_VAR_SYMBOL>M<SPECIAL_VAR_SYMBOL>
5826 beg = expand_and_evaluate_arith(exp_word, &errmsg);
5829 debug_printf_varexp("beg:'%s'=%lld\n", exp_word, (long long)beg);
5830 *p++ = SPECIAL_VAR_SYMBOL;
5832 p = strchr(p, SPECIAL_VAR_SYMBOL);
5834 len = expand_and_evaluate_arith(exp_word, &errmsg);
5837 debug_printf_varexp("len:'%s'=%lld\n", exp_word, (long long)len);
5839 /* negative beg counts from the end */
5840 beg = (arith_t)strlen(val) + beg;
5841 if (beg < 0) /* ${v: -999999} is "" */
5844 debug_printf_varexp("from val:'%s'\n", val);
5846 /* in bash, len=-n means strlen()-n */
5847 len = (arith_t)strlen(val) - beg + len;
5848 if (len < 0) /* bash compat */
5849 msg_and_die_if_script("%s: substring expression < 0", var);
5851 if (len <= 0 || !val || beg >= strlen(val)) {
5855 /* Paranoia. What if user entered 9999999999999
5856 * which fits in arith_t but not int? */
5859 val = to_be_freed = xstrndup(val + beg, len);
5861 debug_printf_varexp("val:'%s'\n", val);
5862 #else /* not (HUSH_SUBSTR_EXPANSION && FEATURE_SH_MATH) */
5863 msg_and_die_if_script("malformed ${%s:...}", var);
5866 } else { /* one of "-=+?" */
5867 /* Standard-mandated substitution ops:
5868 * ${var?word} - indicate error if unset
5869 * If var is unset, word (or a message indicating it is unset
5870 * if word is null) is written to standard error
5871 * and the shell exits with a non-zero exit status.
5872 * Otherwise, the value of var is substituted.
5873 * ${var-word} - use default value
5874 * If var is unset, word is substituted.
5875 * ${var=word} - assign and use default value
5876 * If var is unset, word is assigned to var.
5877 * In all cases, final value of var is substituted.
5878 * ${var+word} - use alternative value
5879 * If var is unset, null is substituted.
5880 * Otherwise, word is substituted.
5882 * Word is subjected to tilde expansion, parameter expansion,
5883 * command substitution, and arithmetic expansion.
5884 * If word is not needed, it is not expanded.
5886 * Colon forms (${var:-word}, ${var:=word} etc) do the same,
5887 * but also treat null var as if it is unset.
5889 int use_word = (!val || ((exp_save == ':') && !val[0]));
5891 use_word = !use_word;
5892 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
5893 (exp_save == ':') ? "true" : "false", use_word);
5895 to_be_freed = encode_then_expand_string(exp_word, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
5897 exp_word = to_be_freed;
5898 if (exp_op == '?') {
5899 /* mimic bash message */
5900 msg_and_die_if_script("%s: %s",
5904 : "parameter null or not set"
5905 /* ash has more specific messages, a-la: */
5906 /*: (exp_save == ':' ? "parameter null or not set" : "parameter not set")*/
5908 //TODO: how interactive bash aborts expansion mid-command?
5913 if (exp_op == '=') {
5914 /* ${var=[word]} or ${var:=[word]} */
5915 if (isdigit(var[0]) || var[0] == '#') {
5916 /* mimic bash message */
5917 msg_and_die_if_script("$%s: cannot assign in this way", var);
5920 char *new_var = xasprintf("%s=%s", var, val);
5921 set_local_var(new_var, /*flag:*/ 0);
5925 } /* one of "-=+?" */
5927 *exp_saveptr = exp_save;
5933 *to_be_freed_pp = to_be_freed;
5937 /* Expand all variable references in given string, adding words to list[]
5938 * at n, n+1,... positions. Return updated n (so that list[n] is next one
5939 * to be filled). This routine is extremely tricky: has to deal with
5940 * variables/parameters with whitespace, $* and $@, and constructs like
5941 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
5942 static NOINLINE int expand_vars_to_list(o_string *output, int n, char *arg)
5944 /* output->o_expflags & EXP_FLAG_SINGLEWORD (0x80) if we are in
5945 * expansion of right-hand side of assignment == 1-element expand.
5947 char cant_be_null = 0; /* only bit 0x80 matters */
5948 int ended_in_ifs = 0; /* did last unquoted expansion end with IFS chars? */
5951 debug_printf_expand("expand_vars_to_list: arg:'%s' singleword:%x\n", arg,
5952 !!(output->o_expflags & EXP_FLAG_SINGLEWORD));
5953 debug_print_list("expand_vars_to_list", output, n);
5954 n = o_save_ptr(output, n);
5955 debug_print_list("expand_vars_to_list[0]", output, n);
5957 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
5959 char *to_be_freed = NULL;
5960 const char *val = NULL;
5961 #if ENABLE_HUSH_TICK
5962 o_string subst_result = NULL_O_STRING;
5964 #if ENABLE_FEATURE_SH_MATH
5965 char arith_buf[sizeof(arith_t)*3 + 2];
5969 o_addchr(output, '\0');
5970 n = o_save_ptr(output, n);
5974 o_addblock(output, arg, p - arg);
5975 debug_print_list("expand_vars_to_list[1]", output, n);
5977 p = strchr(p, SPECIAL_VAR_SYMBOL);
5979 /* Fetch special var name (if it is indeed one of them)
5980 * and quote bit, force the bit on if singleword expansion -
5981 * important for not getting v=$@ expand to many words. */
5982 first_ch = arg[0] | (output->o_expflags & EXP_FLAG_SINGLEWORD);
5984 /* Is this variable quoted and thus expansion can't be null?
5985 * "$@" is special. Even if quoted, it can still
5986 * expand to nothing (not even an empty string),
5987 * thus it is excluded. */
5988 if ((first_ch & 0x7f) != '@')
5989 cant_be_null |= first_ch;
5991 switch (first_ch & 0x7f) {
5992 /* Highest bit in first_ch indicates that var is double-quoted */
5996 if (!G.global_argv[1])
5999 cant_be_null |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
6000 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
6001 while (G.global_argv[i]) {
6002 n = expand_on_ifs(NULL, output, n, G.global_argv[i]);
6003 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
6004 if (G.global_argv[i++][0] && G.global_argv[i]) {
6005 /* this argv[] is not empty and not last:
6006 * put terminating NUL, start new word */
6007 o_addchr(output, '\0');
6008 debug_print_list("expand_vars_to_list[2]", output, n);
6009 n = o_save_ptr(output, n);
6010 debug_print_list("expand_vars_to_list[3]", output, n);
6014 /* If EXP_FLAG_SINGLEWORD, we handle assignment 'a=....$@.....'
6015 * and in this case should treat it like '$*' - see 'else...' below */
6016 if (first_ch == ('@'|0x80) /* quoted $@ */
6017 && !(output->o_expflags & EXP_FLAG_SINGLEWORD) /* not v="$@" case */
6020 o_addQstr(output, G.global_argv[i]);
6021 if (++i >= G.global_argc)
6023 o_addchr(output, '\0');
6024 debug_print_list("expand_vars_to_list[4]", output, n);
6025 n = o_save_ptr(output, n);
6027 } else { /* quoted $* (or v="$@" case): add as one word */
6029 o_addQstr(output, G.global_argv[i]);
6030 if (!G.global_argv[++i])
6033 o_addchr(output, G.ifs[0]);
6035 output->has_quoted_part = 1;
6039 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
6040 /* "Empty variable", used to make "" etc to not disappear */
6041 output->has_quoted_part = 1;
6043 cant_be_null = 0x80;
6045 case SPECIAL_VAR_QUOTED_SVS:
6046 /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_QUOTED_SVS><SPECIAL_VAR_SYMBOL> */
6048 val = SPECIAL_VAR_SYMBOL_STR;
6050 #if ENABLE_HUSH_TICK
6051 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
6052 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
6054 /* Can't just stuff it into output o_string,
6055 * expanded result may need to be globbed
6057 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
6058 G.last_exitcode = process_command_subs(&subst_result, arg);
6059 debug_printf_subst("SUBST RES:%d '%s'\n", G.last_exitcode, subst_result.data);
6060 val = subst_result.data;
6063 #if ENABLE_FEATURE_SH_MATH
6064 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
6067 arg++; /* skip '+' */
6068 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
6069 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
6070 res = expand_and_evaluate_arith(arg, NULL);
6071 debug_printf_subst("ARITH RES '"ARITH_FMT"'\n", res);
6072 sprintf(arith_buf, ARITH_FMT, res);
6078 val = expand_one_var(&to_be_freed, arg, &p);
6079 IF_HUSH_TICK(store_val:)
6080 if (!(first_ch & 0x80)) { /* unquoted $VAR */
6081 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val,
6082 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
6083 if (val && val[0]) {
6084 n = expand_on_ifs(&ended_in_ifs, output, n, val);
6087 } else { /* quoted $VAR, val will be appended below */
6088 output->has_quoted_part = 1;
6089 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val,
6090 !!(output->o_expflags & EXP_FLAG_ESC_GLOB_CHARS));
6093 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
6095 if (val && val[0]) {
6096 o_addQstr(output, val);
6100 /* Restore NULL'ed SPECIAL_VAR_SYMBOL.
6101 * Do the check to avoid writing to a const string. */
6102 if (*p != SPECIAL_VAR_SYMBOL)
6103 *p = SPECIAL_VAR_SYMBOL;
6105 #if ENABLE_HUSH_TICK
6106 o_free(&subst_result);
6109 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
6113 o_addchr(output, '\0');
6114 n = o_save_ptr(output, n);
6116 debug_print_list("expand_vars_to_list[a]", output, n);
6117 /* this part is literal, and it was already pre-quoted
6118 * if needed (much earlier), do not use o_addQstr here! */
6119 o_addstr_with_NUL(output, arg);
6120 debug_print_list("expand_vars_to_list[b]", output, n);
6121 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
6122 && !(cant_be_null & 0x80) /* and all vars were not quoted. */
6125 /* allow to reuse list[n] later without re-growth */
6126 output->has_empty_slot = 1;
6128 o_addchr(output, '\0');
6134 static char **expand_variables(char **argv, unsigned expflags)
6138 o_string output = NULL_O_STRING;
6140 output.o_expflags = expflags;
6144 n = expand_vars_to_list(&output, n, *argv);
6147 debug_print_list("expand_variables", &output, n);
6149 /* output.data (malloced in one block) gets returned in "list" */
6150 list = o_finalize_list(&output, n);
6151 debug_print_strings("expand_variables[1]", list);
6155 static char **expand_strvec_to_strvec(char **argv)
6157 return expand_variables(argv, EXP_FLAG_GLOB | EXP_FLAG_ESC_GLOB_CHARS);
6161 static char **expand_strvec_to_strvec_singleword_noglob(char **argv)
6163 return expand_variables(argv, EXP_FLAG_SINGLEWORD);
6167 /* Used for expansion of right hand of assignments,
6168 * $((...)), heredocs, variable espansion parts.
6170 * NB: should NOT do globbing!
6171 * "export v=/bin/c*; env | grep ^v=" outputs "v=/bin/c*"
6173 static char *expand_string_to_string(const char *str, int do_unbackslash)
6175 #if !BASH_PATTERN_SUBST && !ENABLE_HUSH_CASE
6176 const int do_unbackslash = 1;
6178 char *argv[2], **list;
6180 debug_printf_expand("string_to_string<='%s'\n", str);
6181 /* This is generally an optimization, but it also
6182 * handles "", which otherwise trips over !list[0] check below.
6183 * (is this ever happens that we actually get str="" here?)
6185 if (!strchr(str, SPECIAL_VAR_SYMBOL) && !strchr(str, '\\')) {
6186 //TODO: Can use on strings with \ too, just unbackslash() them?
6187 debug_printf_expand("string_to_string(fast)=>'%s'\n", str);
6188 return xstrdup(str);
6191 argv[0] = (char*)str;
6193 list = expand_variables(argv, do_unbackslash
6194 ? EXP_FLAG_ESC_GLOB_CHARS | EXP_FLAG_SINGLEWORD
6195 : EXP_FLAG_SINGLEWORD
6198 if (!list[0] || list[1])
6199 bb_error_msg_and_die("BUG in varexp2");
6200 /* actually, just move string 2*sizeof(char*) bytes back */
6201 overlapping_strcpy((char*)list, list[0]);
6203 unbackslash((char*)list);
6204 debug_printf_expand("string_to_string=>'%s'\n", (char*)list);
6208 #if ENABLE_HUSH_CASE
6209 static char* expand_strvec_to_string(char **argv)
6213 list = expand_variables(argv, EXP_FLAG_SINGLEWORD);
6214 /* Convert all NULs to spaces */
6219 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
6220 bb_error_msg_and_die("BUG in varexp3");
6221 /* bash uses ' ' regardless of $IFS contents */
6226 overlapping_strcpy((char*)list, list[0] ? list[0] : "");
6227 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
6232 static char **expand_assignments(char **argv, int count)
6237 G.expanded_assignments = p = NULL;
6238 /* Expand assignments into one string each */
6239 for (i = 0; i < count; i++) {
6240 G.expanded_assignments = p = add_string_to_strings(p, expand_string_to_string(argv[i], /*unbackslash:*/ 1));
6242 G.expanded_assignments = NULL;
6247 static void switch_off_special_sigs(unsigned mask)
6250 while ((mask >>= 1) != 0) {
6254 #if ENABLE_HUSH_TRAP
6256 if (G_traps[sig] && !G_traps[sig][0])
6257 /* trap is '', has to remain SIG_IGN */
6260 G_traps[sig] = NULL;
6263 /* We are here only if no trap or trap was not '' */
6264 install_sighandler(sig, SIG_DFL);
6270 void re_execute_shell(char ***to_free, const char *s,
6271 char *g_argv0, char **g_argv,
6272 char **builtin_argv) NORETURN;
6274 static void reset_traps_to_defaults(void)
6276 /* This function is always called in a child shell
6277 * after fork (not vfork, NOMMU doesn't use this function).
6279 IF_HUSH_TRAP(unsigned sig;)
6282 /* Child shells are not interactive.
6283 * SIGTTIN/SIGTTOU/SIGTSTP should not have special handling.
6284 * Testcase: (while :; do :; done) + ^Z should background.
6285 * Same goes for SIGTERM, SIGHUP, SIGINT.
6287 mask = (G.special_sig_mask & SPECIAL_INTERACTIVE_SIGS) | G_fatal_sig_mask;
6288 if (!G_traps && !mask)
6289 return; /* already no traps and no special sigs */
6291 /* Switch off special sigs */
6292 switch_off_special_sigs(mask);
6293 # if ENABLE_HUSH_JOB
6294 G_fatal_sig_mask = 0;
6296 G.special_sig_mask &= ~SPECIAL_INTERACTIVE_SIGS;
6297 /* SIGQUIT,SIGCHLD and maybe SPECIAL_JOBSTOP_SIGS
6298 * remain set in G.special_sig_mask */
6300 # if ENABLE_HUSH_TRAP
6304 /* Reset all sigs to default except ones with empty traps */
6305 for (sig = 0; sig < NSIG; sig++) {
6307 continue; /* no trap: nothing to do */
6308 if (!G_traps[sig][0])
6309 continue; /* empty trap: has to remain SIG_IGN */
6310 /* sig has non-empty trap, reset it: */
6312 G_traps[sig] = NULL;
6313 /* There is no signal for trap 0 (EXIT) */
6316 install_sighandler(sig, pick_sighandler(sig));
6323 static void re_execute_shell(char ***to_free, const char *s,
6324 char *g_argv0, char **g_argv,
6325 char **builtin_argv) NORETURN;
6326 static void re_execute_shell(char ***to_free, const char *s,
6327 char *g_argv0, char **g_argv,
6328 char **builtin_argv)
6330 # define NOMMU_HACK_FMT ("-$%x:%x:%x:%x:%x:%llx" IF_HUSH_LOOPS(":%x"))
6331 /* delims + 2 * (number of bytes in printed hex numbers) */
6332 char param_buf[sizeof(NOMMU_HACK_FMT) + 2 * (sizeof(int)*6 + sizeof(long long)*1)];
6333 char *heredoc_argv[4];
6334 struct variable *cur;
6335 # if ENABLE_HUSH_FUNCTIONS
6336 struct function *funcp;
6340 unsigned long long empty_trap_mask;
6342 if (!g_argv0) { /* heredoc */
6343 argv = heredoc_argv;
6344 argv[0] = (char *) G.argv0_for_re_execing;
6345 argv[1] = (char *) "-<";
6346 argv[2] = (char *) s;
6348 pp = &argv[3]; /* used as pointer to empty environment */
6354 if (pp) while (*pp++)
6357 empty_trap_mask = 0;
6360 for (sig = 1; sig < NSIG; sig++) {
6361 if (G_traps[sig] && !G_traps[sig][0])
6362 empty_trap_mask |= 1LL << sig;
6366 sprintf(param_buf, NOMMU_HACK_FMT
6367 , (unsigned) G.root_pid
6368 , (unsigned) G.root_ppid
6369 , (unsigned) G.last_bg_pid
6370 , (unsigned) G.last_exitcode
6373 IF_HUSH_LOOPS(, G.depth_of_loop)
6375 # undef NOMMU_HACK_FMT
6376 /* 1:hush 2:-$<pid>:<pid>:<exitcode>:<etc...> <vars...> <funcs...>
6377 * 3:-c 4:<cmd> 5:<arg0> <argN...> 6:NULL
6380 for (cur = G.top_var; cur; cur = cur->next) {
6381 if (!cur->flg_export || cur->flg_read_only)
6384 # if ENABLE_HUSH_FUNCTIONS
6385 for (funcp = G.top_func; funcp; funcp = funcp->next)
6391 *to_free = argv = pp = xzalloc(sizeof(argv[0]) * cnt);
6392 *pp++ = (char *) G.argv0_for_re_execing;
6394 for (cur = G.top_var; cur; cur = cur->next) {
6395 if (strcmp(cur->varstr, hush_version_str) == 0)
6397 if (cur->flg_read_only) {
6398 *pp++ = (char *) "-R";
6399 *pp++ = cur->varstr;
6400 } else if (!cur->flg_export) {
6401 *pp++ = (char *) "-V";
6402 *pp++ = cur->varstr;
6405 # if ENABLE_HUSH_FUNCTIONS
6406 for (funcp = G.top_func; funcp; funcp = funcp->next) {
6407 *pp++ = (char *) "-F";
6408 *pp++ = funcp->name;
6409 *pp++ = funcp->body_as_string;
6412 /* We can pass activated traps here. Say, -Tnn:trap_string
6414 * However, POSIX says that subshells reset signals with traps
6416 * I tested bash-3.2 and it not only does that with true subshells
6417 * of the form ( list ), but with any forked children shells.
6418 * I set trap "echo W" WINCH; and then tried:
6420 * { echo 1; sleep 20; echo 2; } &
6421 * while true; do echo 1; sleep 20; echo 2; break; done &
6422 * true | { echo 1; sleep 20; echo 2; } | cat
6424 * In all these cases sending SIGWINCH to the child shell
6425 * did not run the trap. If I add trap "echo V" WINCH;
6426 * _inside_ group (just before echo 1), it works.
6428 * I conclude it means we don't need to pass active traps here.
6430 *pp++ = (char *) "-c";
6433 while (*++builtin_argv)
6434 *pp++ = *builtin_argv;
6435 *pp++ = (char *) "";
6440 /* *pp = NULL; - is already there */
6444 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
6445 /* Don't propagate SIG_IGN to the child */
6446 if (SPECIAL_JOBSTOP_SIGS != 0)
6447 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
6448 execve(bb_busybox_exec_path, argv, pp);
6449 /* Fallback. Useful for init=/bin/hush usage etc */
6450 if (argv[0][0] == '/')
6451 execve(argv[0], argv, pp);
6452 xfunc_error_retval = 127;
6453 bb_error_msg_and_die("can't re-execute the shell");
6455 #endif /* !BB_MMU */
6458 static int run_and_free_list(struct pipe *pi);
6460 /* Executing from string: eval, sh -c '...'
6461 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
6462 * end_trigger controls how often we stop parsing
6463 * NUL: parse all, execute, return
6464 * ';': parse till ';' or newline, execute, repeat till EOF
6466 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
6468 /* Why we need empty flag?
6469 * An obscure corner case "false; ``; echo $?":
6470 * empty command in `` should still set $? to 0.
6471 * But we can't just set $? to 0 at the start,
6472 * this breaks "false; echo `echo $?`" case.
6476 struct pipe *pipe_list;
6478 #if ENABLE_HUSH_INTERACTIVE
6479 if (end_trigger == ';')
6480 inp->promptmode = 0; /* PS1 */
6482 pipe_list = parse_stream(NULL, inp, end_trigger);
6483 if (!pipe_list || pipe_list == ERR_PTR) { /* EOF/error */
6484 /* If we are in "big" script
6485 * (not in `cmd` or something similar)...
6487 if (pipe_list == ERR_PTR && end_trigger == ';') {
6488 /* Discard cached input (rest of line) */
6489 int ch = inp->last_char;
6490 while (ch != EOF && ch != '\n') {
6491 //bb_error_msg("Discarded:'%c'", ch);
6496 /* This stream isn't empty */
6500 if (!pipe_list && empty)
6501 G.last_exitcode = 0;
6504 debug_print_tree(pipe_list, 0);
6505 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
6506 run_and_free_list(pipe_list);
6508 if (G_flag_return_in_progress == 1)
6513 static void parse_and_run_string(const char *s)
6515 struct in_str input;
6516 setup_string_in_str(&input, s);
6517 parse_and_run_stream(&input, '\0');
6520 static void parse_and_run_file(FILE *f)
6522 struct in_str input;
6523 setup_file_in_str(&input, f);
6524 parse_and_run_stream(&input, ';');
6527 #if ENABLE_HUSH_TICK
6528 static FILE *generate_stream_from_string(const char *s, pid_t *pid_p)
6533 char **to_free = NULL;
6537 pid = BB_MMU ? xfork() : xvfork();
6538 if (pid == 0) { /* child */
6539 disable_restore_tty_pgrp_on_exit();
6540 /* Process substitution is not considered to be usual
6541 * 'command execution'.
6542 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
6549 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
6550 close(channel[0]); /* NB: close _first_, then move fd! */
6551 xmove_fd(channel[1], 1);
6552 /* Prevent it from trying to handle ctrl-z etc */
6553 IF_HUSH_JOB(G.run_list_level = 1;)
6554 # if ENABLE_HUSH_TRAP
6555 /* Awful hack for `trap` or $(trap).
6557 * http://www.opengroup.org/onlinepubs/009695399/utilities/trap.html
6558 * contains an example where "trap" is executed in a subshell:
6560 * save_traps=$(trap)
6562 * eval "$save_traps"
6564 * Standard does not say that "trap" in subshell shall print
6565 * parent shell's traps. It only says that its output
6566 * must have suitable form, but then, in the above example
6567 * (which is not supposed to be normative), it implies that.
6569 * bash (and probably other shell) does implement it
6570 * (traps are reset to defaults, but "trap" still shows them),
6571 * but as a result, "trap" logic is hopelessly messed up:
6574 * trap -- 'echo Ho' SIGWINCH <--- we have a handler
6575 * # (trap) <--- trap is in subshell - no output (correct, traps are reset)
6576 * # true | trap <--- trap is in subshell - no output (ditto)
6577 * # echo `true | trap` <--- in subshell - output (but traps are reset!)
6578 * trap -- 'echo Ho' SIGWINCH
6579 * # echo `(trap)` <--- in subshell in subshell - output
6580 * trap -- 'echo Ho' SIGWINCH
6581 * # echo `true | (trap)` <--- in subshell in subshell in subshell - output!
6582 * trap -- 'echo Ho' SIGWINCH
6584 * The rules when to forget and when to not forget traps
6585 * get really complex and nonsensical.
6587 * Our solution: ONLY bare $(trap) or `trap` is special.
6589 s = skip_whitespace(s);
6590 if (is_prefixed_with(s, "trap")
6591 && skip_whitespace(s + 4)[0] == '\0'
6593 static const char *const argv[] = { NULL, NULL };
6594 builtin_trap((char**)argv);
6595 fflush_all(); /* important */
6600 reset_traps_to_defaults();
6601 parse_and_run_string(s);
6602 _exit(G.last_exitcode);
6604 /* We re-execute after vfork on NOMMU. This makes this script safe:
6605 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >BIG
6606 * huge=`cat BIG` # was blocking here forever
6609 re_execute_shell(&to_free,
6619 # if ENABLE_HUSH_FAST
6621 //bb_error_msg("[%d] fork in generate_stream_from_string:"
6622 // " G.count_SIGCHLD:%d G.handled_SIGCHLD:%d",
6623 // getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6625 enable_restore_tty_pgrp_on_exit();
6630 return remember_FILE(xfdopen_for_read(channel[0]));
6633 /* Return code is exit status of the process that is run. */
6634 static int process_command_subs(o_string *dest, const char *s)
6637 struct in_str pipe_str;
6639 int status, ch, eol_cnt;
6641 fp = generate_stream_from_string(s, &pid);
6643 /* Now send results of command back into original context */
6644 setup_file_in_str(&pipe_str, fp);
6646 while ((ch = i_getch(&pipe_str)) != EOF) {
6652 o_addchr(dest, '\n');
6655 o_addQchr(dest, ch);
6658 debug_printf("done reading from `cmd` pipe, closing it\n");
6659 fclose_and_forget(fp);
6660 /* We need to extract exitcode. Test case
6661 * "true; echo `sleep 1; false` $?"
6663 safe_waitpid(pid, &status, 0);
6664 debug_printf("child exited. returning its exitcode:%d\n", WEXITSTATUS(status));
6665 return WEXITSTATUS(status);
6667 #endif /* ENABLE_HUSH_TICK */
6670 static void setup_heredoc(struct redir_struct *redir)
6672 struct fd_pair pair;
6675 /* the _body_ of heredoc (misleading field name) */
6676 const char *heredoc = redir->rd_filename;
6683 if (!(redir->rd_dup & HEREDOC_QUOTED)) {
6684 expanded = encode_then_expand_string(heredoc, /*process_bkslash:*/ 1, /*unbackslash:*/ 1);
6688 len = strlen(heredoc);
6690 close(redir->rd_fd); /* often saves dup2+close in xmove_fd */
6692 xmove_fd(pair.rd, redir->rd_fd);
6694 /* Try writing without forking. Newer kernels have
6695 * dynamically growing pipes. Must use non-blocking write! */
6698 written = write(pair.wr, heredoc, len);
6709 ndelay_off(pair.wr);
6711 /* Okay, pipe buffer was not big enough */
6712 /* Note: we must not create a stray child (bastard? :)
6713 * for the unsuspecting parent process. Child creates a grandchild
6714 * and exits before parent execs the process which consumes heredoc
6715 * (that exec happens after we return from this function) */
6722 disable_restore_tty_pgrp_on_exit();
6723 pid = BB_MMU ? xfork() : xvfork();
6727 close(redir->rd_fd); /* read side of the pipe */
6729 full_write(pair.wr, heredoc, len); /* may loop or block */
6732 /* Delegate blocking writes to another process */
6733 xmove_fd(pair.wr, STDOUT_FILENO);
6734 re_execute_shell(&to_free, heredoc, NULL, NULL, NULL);
6738 #if ENABLE_HUSH_FAST
6740 //bb_error_msg("[%d] fork in setup_heredoc: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
6742 enable_restore_tty_pgrp_on_exit();
6748 wait(NULL); /* wait till child has died */
6754 /* moved_to = n: fd was moved to n; restore back to orig_fd after redir */
6755 /* moved_to = -1: fd was opened by redirect; close orig_fd after redir */
6758 static struct squirrel *append_squirrel(struct squirrel *sq, int i, int orig, int moved)
6760 sq = xrealloc(sq, (i + 2) * sizeof(sq[0]));
6761 sq[i].orig_fd = orig;
6762 sq[i].moved_to = moved;
6763 sq[i+1].orig_fd = -1; /* end marker */
6767 static struct squirrel *add_squirrel(struct squirrel *sq, int fd, int avoid_fd)
6773 if (sq) for (; sq[i].orig_fd >= 0; i++) {
6774 /* If we collide with an already moved fd... */
6775 if (fd == sq[i].moved_to) {
6776 sq[i].moved_to = fcntl_F_DUPFD(sq[i].moved_to, avoid_fd);
6777 debug_printf_redir("redirect_fd %d: already busy, moving to %d\n", fd, sq[i].moved_to);
6778 if (sq[i].moved_to < 0) /* what? */
6782 if (fd == sq[i].orig_fd) {
6783 /* Example: echo Hello >/dev/null 1>&2 */
6784 debug_printf_redir("redirect_fd %d: already moved\n", fd);
6789 /* If this fd is open, we move and remember it; if it's closed, moved_to = -1 */
6790 moved_to = fcntl_F_DUPFD(fd, avoid_fd);
6791 debug_printf_redir("redirect_fd %d: previous fd is moved to %d (-1 if it was closed)\n", fd, moved_to);
6792 if (moved_to < 0 && errno != EBADF)
6794 return append_squirrel(sq, i, fd, moved_to);
6797 static struct squirrel *add_squirrel_closed(struct squirrel *sq, int fd)
6802 if (sq) for (; sq[i].orig_fd >= 0; i++) {
6803 /* If we collide with an already moved fd... */
6804 if (fd == sq[i].orig_fd) {
6806 * "echo 3>FILE 3>&- 3>FILE"
6807 * "echo 3>&- 3>FILE"
6808 * No need for last redirect to insert
6809 * another "need to close 3" indicator.
6811 debug_printf_redir("redirect_fd %d: already moved or closed\n", fd);
6816 debug_printf_redir("redirect_fd %d: previous fd was closed\n", fd);
6817 return append_squirrel(sq, i, fd, -1);
6820 /* fd: redirect wants this fd to be used (e.g. 3>file).
6821 * Move all conflicting internally used fds,
6822 * and remember them so that we can restore them later.
6824 static int save_fd_on_redirect(int fd, int avoid_fd, struct squirrel **sqp)
6826 if (avoid_fd < 9) /* the important case here is that it can be -1 */
6829 #if ENABLE_HUSH_INTERACTIVE
6830 if (fd == G.interactive_fd) {
6831 /* Testcase: "ls -l /proc/$$/fd 255>&-" should work */
6832 G.interactive_fd = xdup_CLOEXEC_and_close(G.interactive_fd, avoid_fd);
6833 debug_printf_redir("redirect_fd %d: matches interactive_fd, moving it to %d\n", fd, G.interactive_fd);
6834 return 1; /* "we closed fd" */
6837 /* Are we called from setup_redirects(squirrel==NULL)? Two cases:
6838 * (1) Redirect in a forked child. No need to save FILEs' fds,
6839 * we aren't going to use them anymore, ok to trash.
6840 * (2) "exec 3>FILE". Bummer. We can save script FILEs' fds,
6841 * but how are we doing to restore them?
6842 * "fileno(fd) = new_fd" can't be done.
6847 /* If this one of script's fds? */
6848 if (save_FILEs_on_redirect(fd, avoid_fd))
6849 return 1; /* yes. "we closed fd" */
6851 /* Check whether it collides with any open fds (e.g. stdio), save fds as needed */
6852 *sqp = add_squirrel(*sqp, fd, avoid_fd);
6853 return 0; /* "we did not close fd" */
6856 static void restore_redirects(struct squirrel *sq)
6860 for (i = 0; sq[i].orig_fd >= 0; i++) {
6861 if (sq[i].moved_to >= 0) {
6862 /* We simply die on error */
6863 debug_printf_redir("restoring redirected fd from %d to %d\n", sq[i].moved_to, sq[i].orig_fd);
6864 xmove_fd(sq[i].moved_to, sq[i].orig_fd);
6866 /* cmd1 9>FILE; cmd2_should_see_fd9_closed */
6867 debug_printf_redir("restoring redirected fd %d: closing it\n", sq[i].orig_fd);
6868 close(sq[i].orig_fd);
6874 /* If moved, G.interactive_fd stays on new fd, not restoring it */
6876 restore_redirected_FILEs();
6879 #if ENABLE_FEATURE_SH_STANDALONE && BB_MMU
6880 static void close_saved_fds_and_FILE_fds(void)
6882 if (G_interactive_fd)
6883 close(G_interactive_fd);
6884 close_all_FILE_list();
6888 static int internally_opened_fd(int fd, struct squirrel *sq)
6892 #if ENABLE_HUSH_INTERACTIVE
6893 if (fd == G.interactive_fd)
6896 /* If this one of script's fds? */
6897 if (fd_in_FILEs(fd))
6900 if (sq) for (i = 0; sq[i].orig_fd >= 0; i++) {
6901 if (fd == sq[i].moved_to)
6907 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
6908 * and stderr if they are redirected. */
6909 static int setup_redirects(struct command *prog, struct squirrel **sqp)
6911 struct redir_struct *redir;
6913 for (redir = prog->redirects; redir; redir = redir->next) {
6917 if (redir->rd_type == REDIRECT_HEREDOC2) {
6918 /* "rd_fd<<HERE" case */
6919 save_fd_on_redirect(redir->rd_fd, /*avoid:*/ 0, sqp);
6920 /* for REDIRECT_HEREDOC2, rd_filename holds _contents_
6922 debug_printf_parse("set heredoc '%s'\n",
6923 redir->rd_filename);
6924 setup_heredoc(redir);
6928 if (redir->rd_dup == REDIRFD_TO_FILE) {
6929 /* "rd_fd<*>file" case (<*> is <,>,>>,<>) */
6933 if (redir->rd_filename == NULL) {
6936 * "cmd >" (no filename)
6937 * "cmd > <file" (2nd redirect starts too early)
6939 syntax_error("invalid redirect");
6942 mode = redir_table[redir->rd_type].mode;
6943 p = expand_string_to_string(redir->rd_filename, /*unbackslash:*/ 1);
6944 newfd = open_or_warn(p, mode);
6947 /* Error message from open_or_warn can be lost
6948 * if stderr has been redirected, but bash
6949 * and ash both lose it as well
6950 * (though zsh doesn't!)
6954 if (newfd == redir->rd_fd && sqp) {
6955 /* open() gave us precisely the fd we wanted.
6956 * This means that this fd was not busy
6957 * (not opened to anywhere).
6958 * Remember to close it on restore:
6960 *sqp = add_squirrel_closed(*sqp, newfd);
6961 debug_printf_redir("redir to previously closed fd %d\n", newfd);
6964 /* "rd_fd>&rd_dup" or "rd_fd>&-" case */
6965 newfd = redir->rd_dup;
6968 if (newfd == redir->rd_fd)
6971 /* if "N>FILE": move newfd to redir->rd_fd */
6972 /* if "N>&M": dup newfd to redir->rd_fd */
6973 /* if "N>&-": close redir->rd_fd (newfd is REDIRFD_CLOSE) */
6975 closed = save_fd_on_redirect(redir->rd_fd, /*avoid:*/ newfd, sqp);
6976 if (newfd == REDIRFD_CLOSE) {
6977 /* "N>&-" means "close me" */
6979 /* ^^^ optimization: saving may already
6980 * have closed it. If not... */
6981 close(redir->rd_fd);
6983 /* Sometimes we do another close on restore, getting EBADF.
6984 * Consider "echo 3>FILE 3>&-"
6985 * first redirect remembers "need to close 3",
6986 * and second redirect closes 3! Restore code then closes 3 again.
6989 /* if newfd is a script fd or saved fd, simulate EBADF */
6990 if (internally_opened_fd(newfd, sqp ? *sqp : NULL)) {
6992 //bb_perror_msg_and_die("can't duplicate file descriptor");
6993 newfd = -1; /* same effect as code above */
6995 xdup2(newfd, redir->rd_fd);
6996 if (redir->rd_dup == REDIRFD_TO_FILE)
6997 /* "rd_fd > FILE" */
6999 /* else: "rd_fd > rd_dup" */
7005 static char *find_in_path(const char *arg)
7008 const char *PATH = get_local_var_value("PATH");
7014 const char *end = strchrnul(PATH, ':');
7015 int sz = end - PATH; /* must be int! */
7019 ret = xasprintf("%.*s/%s", sz, PATH, arg);
7021 /* We have xxx::yyyy in $PATH,
7022 * it means "use current dir" */
7025 if (access(ret, F_OK) == 0)
7038 static const struct built_in_command *find_builtin_helper(const char *name,
7039 const struct built_in_command *x,
7040 const struct built_in_command *end)
7043 if (strcmp(name, x->b_cmd) != 0) {
7047 debug_printf_exec("found builtin '%s'\n", name);
7052 static const struct built_in_command *find_builtin1(const char *name)
7054 return find_builtin_helper(name, bltins1, &bltins1[ARRAY_SIZE(bltins1)]);
7056 static const struct built_in_command *find_builtin(const char *name)
7058 const struct built_in_command *x = find_builtin1(name);
7061 return find_builtin_helper(name, bltins2, &bltins2[ARRAY_SIZE(bltins2)]);
7064 #if ENABLE_HUSH_FUNCTIONS
7065 static struct function **find_function_slot(const char *name)
7067 struct function **funcpp = &G.top_func;
7069 if (strcmp(name, (*funcpp)->name) == 0) {
7072 funcpp = &(*funcpp)->next;
7077 static const struct function *find_function(const char *name)
7079 const struct function *funcp = *find_function_slot(name);
7081 debug_printf_exec("found function '%s'\n", name);
7085 /* Note: takes ownership on name ptr */
7086 static struct function *new_function(char *name)
7088 struct function **funcpp = find_function_slot(name);
7089 struct function *funcp = *funcpp;
7091 if (funcp != NULL) {
7092 struct command *cmd = funcp->parent_cmd;
7093 debug_printf_exec("func %p parent_cmd %p\n", funcp, cmd);
7095 debug_printf_exec("freeing & replacing function '%s'\n", funcp->name);
7097 /* Note: if !funcp->body, do not free body_as_string!
7098 * This is a special case of "-F name body" function:
7099 * body_as_string was not malloced! */
7101 free_pipe_list(funcp->body);
7103 free(funcp->body_as_string);
7107 debug_printf_exec("reinserting in tree & replacing function '%s'\n", funcp->name);
7108 cmd->argv[0] = funcp->name;
7109 cmd->group = funcp->body;
7111 cmd->group_as_string = funcp->body_as_string;
7115 debug_printf_exec("remembering new function '%s'\n", name);
7116 funcp = *funcpp = xzalloc(sizeof(*funcp));
7117 /*funcp->next = NULL;*/
7124 # if ENABLE_HUSH_UNSET
7125 static void unset_func(const char *name)
7127 struct function **funcpp = find_function_slot(name);
7128 struct function *funcp = *funcpp;
7130 if (funcp != NULL) {
7131 debug_printf_exec("freeing function '%s'\n", funcp->name);
7132 *funcpp = funcp->next;
7133 /* funcp is unlinked now, deleting it.
7134 * Note: if !funcp->body, the function was created by
7135 * "-F name body", do not free ->body_as_string
7136 * and ->name as they were not malloced. */
7138 free_pipe_list(funcp->body);
7141 free(funcp->body_as_string);
7150 #define exec_function(to_free, funcp, argv) \
7151 exec_function(funcp, argv)
7153 static void exec_function(char ***to_free,
7154 const struct function *funcp,
7155 char **argv) NORETURN;
7156 static void exec_function(char ***to_free,
7157 const struct function *funcp,
7163 argv[0] = G.global_argv[0];
7164 G.global_argv = argv;
7165 G.global_argc = n = 1 + string_array_len(argv + 1);
7167 // Example when we are here: "cmd | func"
7168 // func will run with saved-redirect fds open.
7169 // $ f() { echo /proc/self/fd/*; }
7171 // /proc/self/fd/0 /proc/self/fd/1 /proc/self/fd/2 /proc/self/fd/255 /proc/self/fd/3
7172 // stdio^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ G_interactive_fd^ DIR fd for glob
7175 // /proc/self/fd/0 /proc/self/fd/1 /proc/self/fd/2 /proc/self/fd/255 /proc/self/fd/3 /proc/self/fd/4
7176 // stdio^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ G_interactive_fd^ opened ./SCRIPT DIR fd for glob
7177 // They are CLOEXEC so external programs won't see them, but
7178 // for "more correctness" we might want to close those extra fds here:
7179 //? close_saved_fds_and_FILE_fds();
7181 /* "we are in function, ok to use return" */
7182 G_flag_return_in_progress = -1;
7183 IF_HUSH_LOCAL(G.func_nest_level++;)
7185 /* On MMU, funcp->body is always non-NULL */
7186 n = run_list(funcp->body);
7190 //? close_saved_fds_and_FILE_fds();
7192 //TODO: check whether "true | func_with_return" works
7194 re_execute_shell(to_free,
7195 funcp->body_as_string,
7202 static int run_function(const struct function *funcp, char **argv)
7208 save_and_replace_G_args(&sv, argv);
7210 /* "we are in function, ok to use return" */
7211 sv_flg = G_flag_return_in_progress;
7212 G_flag_return_in_progress = -1;
7213 IF_HUSH_LOCAL(G.func_nest_level++;)
7215 /* On MMU, funcp->body is always non-NULL */
7218 /* Function defined by -F */
7219 parse_and_run_string(funcp->body_as_string);
7220 rc = G.last_exitcode;
7224 rc = run_list(funcp->body);
7227 # if ENABLE_HUSH_LOCAL
7229 struct variable *var;
7230 struct variable **var_pp;
7232 var_pp = &G.top_var;
7233 while ((var = *var_pp) != NULL) {
7234 if (var->func_nest_level < G.func_nest_level) {
7235 var_pp = &var->next;
7239 if (var->flg_export)
7240 bb_unsetenv(var->varstr);
7241 /* Remove from global list */
7242 *var_pp = var->next;
7248 G.func_nest_level--;
7251 G_flag_return_in_progress = sv_flg;
7253 restore_G_args(&sv, argv);
7257 #endif /* ENABLE_HUSH_FUNCTIONS */
7261 #define exec_builtin(to_free, x, argv) \
7262 exec_builtin(x, argv)
7264 #define exec_builtin(to_free, x, argv) \
7265 exec_builtin(to_free, argv)
7267 static void exec_builtin(char ***to_free,
7268 const struct built_in_command *x,
7269 char **argv) NORETURN;
7270 static void exec_builtin(char ***to_free,
7271 const struct built_in_command *x,
7277 //? close_saved_fds_and_FILE_fds();
7278 rcode = x->b_function(argv);
7283 /* On NOMMU, we must never block!
7284 * Example: { sleep 99 | read line; } & echo Ok
7286 re_execute_shell(to_free,
7295 static void execvp_or_die(char **argv) NORETURN;
7296 static void execvp_or_die(char **argv)
7299 debug_printf_exec("execing '%s'\n", argv[0]);
7300 /* Don't propagate SIG_IGN to the child */
7301 if (SPECIAL_JOBSTOP_SIGS != 0)
7302 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
7303 execvp(argv[0], argv);
7305 if (errno == EACCES) e = 126;
7306 if (errno == ENOENT) e = 127;
7307 bb_perror_msg("can't execute '%s'", argv[0]);
7311 #if ENABLE_HUSH_MODE_X
7312 static void dump_cmd_in_x_mode(char **argv)
7314 if (G_x_mode && argv) {
7315 /* We want to output the line in one write op */
7323 len += strlen(argv[n++]) + 1;
7329 p += sprintf(p, " %s", argv[n++]);
7337 # define dump_cmd_in_x_mode(argv) ((void)0)
7340 #if ENABLE_HUSH_COMMAND
7341 static void if_command_vV_print_and_exit(char opt_vV, char *cmd, const char *explanation)
7350 char *path = getenv("PATH");
7351 explanation = to_free = find_executable(cmd, &path); /* path == NULL is ok */
7353 _exit(1); /* PROG was not found */
7355 cmd = to_free; /* -v PROG prints "/path/to/PROG" */
7357 printf((opt_vV == 'V') ? "%s is %s\n" : "%s\n", cmd, explanation);
7363 # define if_command_vV_print_and_exit(a,b,c) ((void)0)
7367 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
7368 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
7369 #define pseudo_exec(nommu_save, command, argv_expanded) \
7370 pseudo_exec(command, argv_expanded)
7373 /* Called after [v]fork() in run_pipe, or from builtin_exec.
7375 * Don't exit() here. If you don't exec, use _exit instead.
7376 * The at_exit handlers apparently confuse the calling process,
7377 * in particular stdin handling. Not sure why? -- because of vfork! (vda)
7379 static void pseudo_exec_argv(nommu_save_t *nommu_save,
7380 char **argv, int assignment_cnt,
7381 char **argv_expanded) NORETURN;
7382 static NOINLINE void pseudo_exec_argv(nommu_save_t *nommu_save,
7383 char **argv, int assignment_cnt,
7384 char **argv_expanded)
7386 const struct built_in_command *x;
7388 #if ENABLE_HUSH_COMMAND
7392 new_env = expand_assignments(argv, assignment_cnt);
7393 dump_cmd_in_x_mode(new_env);
7395 if (!argv[assignment_cnt]) {
7396 /* Case when we are here: ... | var=val | ...
7397 * (note that we do not exit early, i.e., do not optimize out
7398 * expand_assignments(): think about ... | var=`sleep 1` | ...
7400 free_strings(new_env);
7401 _exit(EXIT_SUCCESS);
7405 set_vars_and_save_old(new_env);
7406 free(new_env); /* optional */
7407 /* we can also destroy set_vars_and_save_old's return value,
7410 nommu_save->new_env = new_env;
7411 nommu_save->old_vars = set_vars_and_save_old(new_env);
7414 if (argv_expanded) {
7415 argv = argv_expanded;
7417 argv = expand_strvec_to_strvec(argv + assignment_cnt);
7419 nommu_save->argv = argv;
7422 dump_cmd_in_x_mode(argv);
7424 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
7425 if (strchr(argv[0], '/') != NULL)
7429 #if ENABLE_HUSH_FUNCTIONS
7430 /* Check if the command matches any functions (this goes before bltins) */
7432 const struct function *funcp = find_function(argv[0]);
7434 exec_function(&nommu_save->argv_from_re_execing, funcp, argv);
7439 #if ENABLE_HUSH_COMMAND
7440 /* "command BAR": run BAR without looking it up among functions
7441 * "command -v BAR": print "BAR" or "/path/to/BAR"; or exit 1
7442 * "command -V BAR": print "BAR is {a function,a shell builtin,/path/to/BAR}"
7444 while (strcmp(argv[0], "command") == 0 && argv[1]) {
7449 if (p[0] != '-' || !p[1])
7450 continue; /* bash allows "command command command [-OPT] BAR" */
7458 if (p[0] != '-' || !p[1])
7460 continue; /* next arg is also -opts, process it too */
7466 bb_error_msg_and_die("%s: %s: invalid option", "command", argv[0]);
7471 # if ENABLE_HUSH_FUNCTIONS
7472 if (opt_vV && find_function(argv[0]))
7473 if_command_vV_print_and_exit(opt_vV, argv[0], "a function");
7477 /* Check if the command matches any of the builtins.
7478 * Depending on context, this might be redundant. But it's
7479 * easier to waste a few CPU cycles than it is to figure out
7480 * if this is one of those cases.
7482 /* Why "BB_MMU ? :" difference in logic? -
7483 * On NOMMU, it is more expensive to re-execute shell
7484 * just in order to run echo or test builtin.
7485 * It's better to skip it here and run corresponding
7486 * non-builtin later. */
7487 x = BB_MMU ? find_builtin(argv[0]) : find_builtin1(argv[0]);
7489 if_command_vV_print_and_exit(opt_vV, argv[0], "a shell builtin");
7490 exec_builtin(&nommu_save->argv_from_re_execing, x, argv);
7493 #if ENABLE_FEATURE_SH_STANDALONE
7494 /* Check if the command matches any busybox applets */
7496 int a = find_applet_by_name(argv[0]);
7498 if_command_vV_print_and_exit(opt_vV, argv[0], "an applet");
7499 # if BB_MMU /* see above why on NOMMU it is not allowed */
7500 if (APPLET_IS_NOEXEC(a)) {
7501 /* Do not leak open fds from opened script files etc.
7502 * Testcase: interactive "ls -l /proc/self/fd"
7503 * should not show tty fd open.
7505 close_saved_fds_and_FILE_fds();
7506 //FIXME: should also close saved redir fds
7507 /* Without this, "rm -i FILE" can't be ^C'ed: */
7508 switch_off_special_sigs(G.special_sig_mask);
7509 debug_printf_exec("running applet '%s'\n", argv[0]);
7510 run_noexec_applet_and_exit(a, argv[0], argv);
7513 /* Re-exec ourselves */
7514 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
7515 /* Don't propagate SIG_IGN to the child */
7516 if (SPECIAL_JOBSTOP_SIGS != 0)
7517 switch_off_special_sigs(G.special_sig_mask & SPECIAL_JOBSTOP_SIGS);
7518 execv(bb_busybox_exec_path, argv);
7519 /* If they called chroot or otherwise made the binary no longer
7520 * executable, fall through */
7525 #if ENABLE_FEATURE_SH_STANDALONE || BB_MMU
7528 if_command_vV_print_and_exit(opt_vV, argv[0], NULL);
7529 execvp_or_die(argv);
7532 /* Called after [v]fork() in run_pipe
7534 static void pseudo_exec(nommu_save_t *nommu_save,
7535 struct command *command,
7536 char **argv_expanded) NORETURN;
7537 static void pseudo_exec(nommu_save_t *nommu_save,
7538 struct command *command,
7539 char **argv_expanded)
7541 if (command->argv) {
7542 pseudo_exec_argv(nommu_save, command->argv,
7543 command->assignment_cnt, argv_expanded);
7546 if (command->group) {
7547 /* Cases when we are here:
7550 * ... | ( list ) | ...
7551 * ... | { list } | ...
7555 debug_printf_exec("pseudo_exec: run_list\n");
7556 reset_traps_to_defaults();
7557 rcode = run_list(command->group);
7558 /* OK to leak memory by not calling free_pipe_list,
7559 * since this process is about to exit */
7562 re_execute_shell(&nommu_save->argv_from_re_execing,
7563 command->group_as_string,
7570 /* Case when we are here: ... | >file */
7571 debug_printf_exec("pseudo_exec'ed null command\n");
7572 _exit(EXIT_SUCCESS);
7576 static const char *get_cmdtext(struct pipe *pi)
7582 /* This is subtle. ->cmdtext is created only on first backgrounding.
7583 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
7584 * On subsequent bg argv is trashed, but we won't use it */
7588 argv = pi->cmds[0].argv;
7590 pi->cmdtext = xzalloc(1);
7595 len += strlen(*argv) + 1;
7599 argv = pi->cmds[0].argv;
7601 p = stpcpy(p, *argv);
7608 static void remove_job_from_table(struct pipe *pi)
7610 struct pipe *prev_pipe;
7612 if (pi == G.job_list) {
7613 G.job_list = pi->next;
7615 prev_pipe = G.job_list;
7616 while (prev_pipe->next != pi)
7617 prev_pipe = prev_pipe->next;
7618 prev_pipe->next = pi->next;
7622 G.last_jobid = G.job_list->jobid;
7625 static void delete_finished_job(struct pipe *pi)
7627 remove_job_from_table(pi);
7631 static void clean_up_last_dead_job(void)
7633 if (G.job_list && !G.job_list->alive_cmds)
7634 delete_finished_job(G.job_list);
7637 static void insert_job_into_table(struct pipe *pi)
7639 struct pipe *job, **jobp;
7642 clean_up_last_dead_job();
7644 /* Find the end of the list, and find next job ID to use */
7647 while ((job = *jobp) != NULL) {
7654 /* Create a new job struct at the end */
7655 job = *jobp = xmemdup(pi, sizeof(*pi));
7657 job->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
7658 /* Cannot copy entire pi->cmds[] vector! This causes double frees */
7659 for (i = 0; i < pi->num_cmds; i++) {
7660 job->cmds[i].pid = pi->cmds[i].pid;
7661 /* all other fields are not used and stay zero */
7663 job->cmdtext = xstrdup(get_cmdtext(pi));
7665 if (G_interactive_fd)
7666 printf("[%u] %u %s\n", job->jobid, (unsigned)job->cmds[0].pid, job->cmdtext);
7667 G.last_jobid = job->jobid;
7671 static int job_exited_or_stopped(struct pipe *pi)
7675 if (pi->alive_cmds != pi->stopped_cmds)
7678 /* All processes in fg pipe have exited or stopped */
7682 rcode = pi->cmds[i].cmd_exitcode;
7683 /* usually last process gives overall exitstatus,
7684 * but with "set -o pipefail", last *failed* process does */
7685 if (G.o_opt[OPT_O_PIPEFAIL] == 0 || rcode != 0)
7688 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
7692 static int process_wait_result(struct pipe *fg_pipe, pid_t childpid, int status)
7699 dead = WIFEXITED(status) || WIFSIGNALED(status);
7702 if (WIFSTOPPED(status))
7703 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
7704 childpid, WSTOPSIG(status), WEXITSTATUS(status));
7705 if (WIFSIGNALED(status))
7706 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
7707 childpid, WTERMSIG(status), WEXITSTATUS(status));
7708 if (WIFEXITED(status))
7709 debug_printf_jobs("pid %d exited, exitcode %d\n",
7710 childpid, WEXITSTATUS(status));
7712 /* Were we asked to wait for a fg pipe? */
7714 i = fg_pipe->num_cmds;
7719 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
7720 if (fg_pipe->cmds[i].pid != childpid)
7724 fg_pipe->cmds[i].pid = 0;
7725 fg_pipe->alive_cmds--;
7726 ex = WEXITSTATUS(status);
7727 /* bash prints killer signal's name for *last*
7728 * process in pipe (prints just newline for SIGINT/SIGPIPE).
7729 * Mimic this. Example: "sleep 5" + (^\ or kill -QUIT)
7731 if (WIFSIGNALED(status)) {
7732 int sig = WTERMSIG(status);
7733 if (i == fg_pipe->num_cmds-1)
7734 /* TODO: use strsignal() instead for bash compat? but that's bloat... */
7735 puts(sig == SIGINT || sig == SIGPIPE ? "" : get_signame(sig));
7736 /* TODO: if (WCOREDUMP(status)) + " (core dumped)"; */
7737 /* TODO: MIPS has 128 sigs (1..128), what if sig==128 here?
7738 * Maybe we need to use sig | 128? */
7741 fg_pipe->cmds[i].cmd_exitcode = ex;
7743 fg_pipe->stopped_cmds++;
7745 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
7746 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
7747 rcode = job_exited_or_stopped(fg_pipe);
7749 /* Note: *non-interactive* bash does not continue if all processes in fg pipe
7750 * are stopped. Testcase: "cat | cat" in a script (not on command line!)
7751 * and "killall -STOP cat" */
7752 if (G_interactive_fd) {
7754 if (fg_pipe->alive_cmds != 0)
7755 insert_job_into_table(fg_pipe);
7759 if (fg_pipe->alive_cmds == 0)
7762 /* There are still running processes in the fg_pipe */
7765 /* It wasn't in fg_pipe, look for process in bg pipes */
7769 /* We were asked to wait for bg or orphaned children */
7770 /* No need to remember exitcode in this case */
7771 for (pi = G.job_list; pi; pi = pi->next) {
7772 for (i = 0; i < pi->num_cmds; i++) {
7773 if (pi->cmds[i].pid == childpid)
7774 goto found_pi_and_prognum;
7777 /* Happens when shell is used as init process (init=/bin/sh) */
7778 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
7779 return -1; /* this wasn't a process from fg_pipe */
7781 found_pi_and_prognum:
7784 int rcode = WEXITSTATUS(status);
7785 if (WIFSIGNALED(status))
7786 rcode = 128 + WTERMSIG(status);
7787 pi->cmds[i].cmd_exitcode = rcode;
7788 if (G.last_bg_pid == pi->cmds[i].pid)
7789 G.last_bg_pid_exitcode = rcode;
7790 pi->cmds[i].pid = 0;
7792 if (!pi->alive_cmds) {
7793 if (G_interactive_fd) {
7794 printf(JOB_STATUS_FORMAT, pi->jobid,
7795 "Done", pi->cmdtext);
7796 delete_finished_job(pi);
7799 * bash deletes finished jobs from job table only in interactive mode,
7800 * after "jobs" cmd, or if pid of a new process matches one of the old ones
7801 * (see cleanup_dead_jobs(), delete_old_job(), J_NOTIFIED in bash source).
7802 * Testcase script: "(exit 3) & sleep 1; wait %1; echo $?" prints 3 in bash.
7803 * We only retain one "dead" job, if it's the single job on the list.
7804 * This covers most of real-world scenarios where this is useful.
7806 if (pi != G.job_list)
7807 delete_finished_job(pi);
7815 return -1; /* this wasn't a process from fg_pipe */
7818 /* Check to see if any processes have exited -- if they have,
7819 * figure out why and see if a job has completed.
7821 * If non-NULL fg_pipe: wait for its completion or stop.
7822 * Return its exitcode or zero if stopped.
7824 * Alternatively (fg_pipe == NULL, waitfor_pid != 0):
7825 * waitpid(WNOHANG), if waitfor_pid exits or stops, return exitcode+1,
7826 * else return <0 if waitpid errors out (e.g. ECHILD: nothing to wait for)
7827 * or 0 if no children changed status.
7829 * Alternatively (fg_pipe == NULL, waitfor_pid == 0),
7830 * return <0 if waitpid errors out (e.g. ECHILD: nothing to wait for)
7831 * or 0 if no children changed status.
7833 static int checkjobs(struct pipe *fg_pipe, pid_t waitfor_pid)
7839 debug_printf_jobs("checkjobs %p\n", fg_pipe);
7841 attributes = WUNTRACED;
7842 if (fg_pipe == NULL)
7843 attributes |= WNOHANG;
7846 #if ENABLE_HUSH_FAST
7847 if (G.handled_SIGCHLD == G.count_SIGCHLD) {
7848 //bb_error_msg("[%d] checkjobs: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d children?:%d fg_pipe:%p",
7849 //getpid(), G.count_SIGCHLD, G.handled_SIGCHLD, G.we_have_children, fg_pipe);
7850 /* There was neither fork nor SIGCHLD since last waitpid */
7851 /* Avoid doing waitpid syscall if possible */
7852 if (!G.we_have_children) {
7856 if (fg_pipe == NULL) { /* is WNOHANG set? */
7857 /* We have children, but they did not exit
7858 * or stop yet (we saw no SIGCHLD) */
7861 /* else: !WNOHANG, waitpid will block, can't short-circuit */
7865 /* Do we do this right?
7866 * bash-3.00# sleep 20 | false
7868 * [3]+ Stopped sleep 20 | false
7869 * bash-3.00# echo $?
7870 * 1 <========== bg pipe is not fully done, but exitcode is already known!
7871 * [hush 1.14.0: yes we do it right]
7875 #if ENABLE_HUSH_FAST
7877 i = G.count_SIGCHLD;
7879 childpid = waitpid(-1, &status, attributes);
7880 if (childpid <= 0) {
7881 if (childpid && errno != ECHILD)
7882 bb_perror_msg("waitpid");
7883 #if ENABLE_HUSH_FAST
7884 else { /* Until next SIGCHLD, waitpid's are useless */
7885 G.we_have_children = (childpid == 0);
7886 G.handled_SIGCHLD = i;
7887 //bb_error_msg("[%d] checkjobs: waitpid returned <= 0, G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
7890 /* ECHILD (no children), or 0 (no change in children status) */
7894 rcode = process_wait_result(fg_pipe, childpid, status);
7896 /* fg_pipe exited or stopped */
7899 if (childpid == waitfor_pid) {
7900 debug_printf_exec("childpid==waitfor_pid:%d status:0x%08x\n", childpid, status);
7901 rcode = WEXITSTATUS(status);
7902 if (WIFSIGNALED(status))
7903 rcode = 128 + WTERMSIG(status);
7904 if (WIFSTOPPED(status))
7905 /* bash: "cmd & wait $!" and cmd stops: $? = 128 + stopsig */
7906 rcode = 128 + WSTOPSIG(status);
7908 break; /* "wait PID" called us, give it exitcode+1 */
7910 /* This wasn't one of our processes, or */
7911 /* fg_pipe still has running processes, do waitpid again */
7912 } /* while (waitpid succeeds)... */
7918 static int checkjobs_and_fg_shell(struct pipe *fg_pipe)
7921 int rcode = checkjobs(fg_pipe, 0 /*(no pid to wait for)*/);
7922 if (G_saved_tty_pgrp) {
7923 /* Job finished, move the shell to the foreground */
7924 p = getpgrp(); /* our process group id */
7925 debug_printf_jobs("fg'ing ourself: getpgrp()=%d\n", (int)p);
7926 tcsetpgrp(G_interactive_fd, p);
7932 /* Start all the jobs, but don't wait for anything to finish.
7935 * Return code is normally -1, when the caller has to wait for children
7936 * to finish to determine the exit status of the pipe. If the pipe
7937 * is a simple builtin command, however, the action is done by the
7938 * time run_pipe returns, and the exit code is provided as the
7941 * Returns -1 only if started some children. IOW: we have to
7942 * mask out retvals of builtins etc with 0xff!
7944 * The only case when we do not need to [v]fork is when the pipe
7945 * is single, non-backgrounded, non-subshell command. Examples:
7946 * cmd ; ... { list } ; ...
7947 * cmd && ... { list } && ...
7948 * cmd || ... { list } || ...
7949 * If it is, then we can run cmd as a builtin, NOFORK,
7950 * or (if SH_STANDALONE) an applet, and we can run the { list }
7951 * with run_list. If it isn't one of these, we fork and exec cmd.
7953 * Cases when we must fork:
7954 * non-single: cmd | cmd
7955 * backgrounded: cmd & { list } &
7956 * subshell: ( list ) [&]
7958 #if !ENABLE_HUSH_MODE_X
7959 #define redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel, argv_expanded) \
7960 redirect_and_varexp_helper(new_env_p, old_vars_p, command, squirrel)
7962 static int redirect_and_varexp_helper(char ***new_env_p,
7963 struct variable **old_vars_p,
7964 struct command *command,
7965 struct squirrel **sqp,
7966 char **argv_expanded)
7968 /* setup_redirects acts on file descriptors, not FILEs.
7969 * This is perfect for work that comes after exec().
7970 * Is it really safe for inline use? Experimentally,
7971 * things seem to work. */
7972 int rcode = setup_redirects(command, sqp);
7974 char **new_env = expand_assignments(command->argv, command->assignment_cnt);
7975 *new_env_p = new_env;
7976 dump_cmd_in_x_mode(new_env);
7977 dump_cmd_in_x_mode(argv_expanded);
7979 *old_vars_p = set_vars_and_save_old(new_env);
7983 static NOINLINE int run_pipe(struct pipe *pi)
7985 static const char *const null_ptr = NULL;
7989 struct command *command;
7990 char **argv_expanded;
7992 struct squirrel *squirrel = NULL;
7995 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
7998 /* Testcase: set -- q w e; (IFS='' echo "$*"; IFS=''; echo "$*"); echo "$*"
7999 * Result should be 3 lines: q w e, qwe, q w e
8001 G.ifs = get_local_var_value("IFS");
8005 IF_HUSH_JOB(pi->pgrp = -1;)
8006 pi->stopped_cmds = 0;
8007 command = &pi->cmds[0];
8008 argv_expanded = NULL;
8010 if (pi->num_cmds != 1
8011 || pi->followup == PIPE_BG
8012 || command->cmd_type == CMD_SUBSHELL
8019 debug_printf_exec(": group:%p argv:'%s'\n",
8020 command->group, command->argv ? command->argv[0] : "NONE");
8022 if (command->group) {
8023 #if ENABLE_HUSH_FUNCTIONS
8024 if (command->cmd_type == CMD_FUNCDEF) {
8025 /* "executing" func () { list } */
8026 struct function *funcp;
8028 funcp = new_function(command->argv[0]);
8029 /* funcp->name is already set to argv[0] */
8030 funcp->body = command->group;
8032 funcp->body_as_string = command->group_as_string;
8033 command->group_as_string = NULL;
8035 command->group = NULL;
8036 command->argv[0] = NULL;
8037 debug_printf_exec("cmd %p has child func at %p\n", command, funcp);
8038 funcp->parent_cmd = command;
8039 command->child_func = funcp;
8041 debug_printf_exec("run_pipe: return EXIT_SUCCESS\n");
8043 return EXIT_SUCCESS;
8047 debug_printf("non-subshell group\n");
8048 rcode = 1; /* exitcode if redir failed */
8049 if (setup_redirects(command, &squirrel) == 0) {
8050 debug_printf_exec(": run_list\n");
8051 rcode = run_list(command->group) & 0xff;
8053 restore_redirects(squirrel);
8054 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
8056 debug_printf_exec("run_pipe: return %d\n", rcode);
8060 argv = command->argv ? command->argv : (char **) &null_ptr;
8062 const struct built_in_command *x;
8063 #if ENABLE_HUSH_FUNCTIONS
8064 const struct function *funcp;
8068 char **new_env = NULL;
8069 struct variable *old_vars = NULL;
8071 if (argv[command->assignment_cnt] == NULL) {
8072 /* Assignments, but no command */
8073 /* Ensure redirects take effect (that is, create files).
8074 * Try "a=t >file" */
8075 #if 0 /* A few cases in testsuite fail with this code. FIXME */
8076 rcode = redirect_and_varexp_helper(&new_env, /*old_vars:*/ NULL, command, &squirrel, /*argv_expanded:*/ NULL);
8077 /* Set shell variables */
8081 if (set_local_var(*argv, /*flag:*/ 0)) {
8082 /* assignment to readonly var / putenv error? */
8088 /* Redirect error sets $? to 1. Otherwise,
8089 * if evaluating assignment value set $?, retain it.
8090 * Try "false; q=`exit 2`; echo $?" - should print 2: */
8092 rcode = G.last_exitcode;
8093 /* Exit, _skipping_ variable restoring code: */
8094 goto clean_up_and_ret0;
8096 #else /* Older, bigger, but more correct code */
8098 rcode = setup_redirects(command, &squirrel);
8099 restore_redirects(squirrel);
8100 /* Set shell variables */
8102 bb_putchar_stderr('+');
8104 char *p = expand_string_to_string(*argv, /*unbackslash:*/ 1);
8106 fprintf(stderr, " %s", p);
8107 debug_printf_exec("set shell var:'%s'->'%s'\n",
8109 if (set_local_var(p, /*flag:*/ 0)) {
8110 /* assignment to readonly var / putenv error? */
8116 bb_putchar_stderr('\n');
8117 /* Redirect error sets $? to 1. Otherwise,
8118 * if evaluating assignment value set $?, retain it.
8119 * Try "false; q=`exit 2`; echo $?" - should print 2: */
8121 rcode = G.last_exitcode;
8122 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
8124 debug_printf_exec("run_pipe: return %d\n", rcode);
8129 /* Expand the rest into (possibly) many strings each */
8131 if (command->cmd_type == CMD_SINGLEWORD_NOGLOB) {
8132 argv_expanded = expand_strvec_to_strvec_singleword_noglob(argv + command->assignment_cnt);
8136 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
8139 /* if someone gives us an empty string: `cmd with empty output` */
8140 if (!argv_expanded[0]) {
8141 free(argv_expanded);
8143 return G.last_exitcode;
8146 #if ENABLE_HUSH_FUNCTIONS
8147 /* Check if argv[0] matches any functions (this goes before bltins) */
8148 funcp = find_function(argv_expanded[0]);
8152 x = find_builtin(argv_expanded[0]);
8155 if (x->b_function == builtin_exec && argv_expanded[1] == NULL) {
8156 debug_printf("exec with redirects only\n");
8157 rcode = setup_redirects(command, NULL);
8158 /* rcode=1 can be if redir file can't be opened */
8159 goto clean_up_and_ret1;
8162 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, &squirrel, argv_expanded);
8165 debug_printf_exec(": builtin '%s' '%s'...\n",
8166 x->b_cmd, argv_expanded[1]);
8168 rcode = x->b_function(argv_expanded) & 0xff;
8171 #if ENABLE_HUSH_FUNCTIONS
8173 # if ENABLE_HUSH_LOCAL
8174 struct variable **sv;
8175 sv = G.shadowed_vars_pp;
8176 G.shadowed_vars_pp = &old_vars;
8178 debug_printf_exec(": function '%s' '%s'...\n",
8179 funcp->name, argv_expanded[1]);
8180 rcode = run_function(funcp, argv_expanded) & 0xff;
8181 # if ENABLE_HUSH_LOCAL
8182 G.shadowed_vars_pp = sv;
8188 unset_vars(new_env);
8190 /* clean_up_and_ret0: */
8191 restore_redirects(squirrel);
8193 * Try "usleep 99999999" + ^C + "echo $?"
8194 * with FEATURE_SH_NOFORK=y.
8197 /* It was builtin or nofork.
8198 * if this would be a real fork/execed program,
8199 * it should have died if a fatal sig was received.
8200 * But OTOH, there was no separate process,
8201 * the sig was sent to _shell_, not to non-existing
8203 * Let's just handle ^C only, this one is obvious:
8204 * we aren't ok with exitcode 0 when ^C was pressed
8205 * during builtin/nofork.
8207 if (sigismember(&G.pending_set, SIGINT))
8208 rcode = 128 + SIGINT;
8211 free(argv_expanded);
8212 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
8214 debug_printf_exec("run_pipe return %d\n", rcode);
8218 if (ENABLE_FEATURE_SH_NOFORK && NUM_APPLETS > 1) {
8219 int n = find_applet_by_name(argv_expanded[0]);
8220 if (n >= 0 && APPLET_IS_NOFORK(n)) {
8221 rcode = redirect_and_varexp_helper(&new_env, &old_vars, command, &squirrel, argv_expanded);
8223 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
8224 argv_expanded[0], argv_expanded[1]);
8226 * Note: signals (^C) can't interrupt here.
8227 * We remember them and they will be acted upon
8228 * after applet returns.
8229 * This makes applets which can run for a long time
8230 * and/or wait for user input ineligible for NOFORK:
8231 * for example, "yes" or "rm" (rm -i waits for input).
8233 rcode = run_nofork_applet(n, argv_expanded);
8235 goto clean_up_and_ret;
8238 /* It is neither builtin nor applet. We must fork. */
8242 /* NB: argv_expanded may already be created, and that
8243 * might include `cmd` runs! Do not rerun it! We *must*
8244 * use argv_expanded if it's non-NULL */
8246 /* Going to fork a child per each pipe member */
8251 while (cmd_no < pi->num_cmds) {
8252 struct fd_pair pipefds;
8254 volatile nommu_save_t nommu_save;
8255 nommu_save.new_env = NULL;
8256 nommu_save.old_vars = NULL;
8257 nommu_save.argv = NULL;
8258 nommu_save.argv_from_re_execing = NULL;
8260 command = &pi->cmds[cmd_no];
8262 if (command->argv) {
8263 debug_printf_exec(": pipe member '%s' '%s'...\n",
8264 command->argv[0], command->argv[1]);
8266 debug_printf_exec(": pipe member with no argv\n");
8269 /* pipes are inserted between pairs of commands */
8272 if (cmd_no < pi->num_cmds)
8273 xpiped_pair(pipefds);
8275 command->pid = BB_MMU ? fork() : vfork();
8276 if (!command->pid) { /* child */
8278 disable_restore_tty_pgrp_on_exit();
8279 CLEAR_RANDOM_T(&G.random_gen); /* or else $RANDOM repeats in child */
8281 /* Every child adds itself to new process group
8282 * with pgid == pid_of_first_child_in_pipe */
8283 if (G.run_list_level == 1 && G_interactive_fd) {
8286 if (pgrp < 0) /* true for 1st process only */
8288 if (setpgid(0, pgrp) == 0
8289 && pi->followup != PIPE_BG
8290 && G_saved_tty_pgrp /* we have ctty */
8292 /* We do it in *every* child, not just first,
8294 tcsetpgrp(G_interactive_fd, pgrp);
8298 if (pi->alive_cmds == 0 && pi->followup == PIPE_BG) {
8299 /* 1st cmd in backgrounded pipe
8300 * should have its stdin /dev/null'ed */
8302 if (open(bb_dev_null, O_RDONLY))
8303 xopen("/", O_RDONLY);
8305 xmove_fd(next_infd, 0);
8307 xmove_fd(pipefds.wr, 1);
8310 /* Like bash, explicit redirects override pipes,
8311 * and the pipe fd (fd#1) is available for dup'ing:
8312 * "cmd1 2>&1 | cmd2": fd#1 is duped to fd#2, thus stderr
8313 * of cmd1 goes into pipe.
8315 if (setup_redirects(command, NULL)) {
8316 /* Happens when redir file can't be opened:
8317 * $ hush -c 'echo FOO >&2 | echo BAR 3>/qwe/rty; echo BAZ'
8319 * hush: can't open '/qwe/rty': No such file or directory
8321 * (echo BAR is not executed, it hits _exit(1) below)
8326 /* Stores to nommu_save list of env vars putenv'ed
8327 * (NOMMU, on MMU we don't need that) */
8328 /* cast away volatility... */
8329 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
8330 /* pseudo_exec() does not return */
8333 /* parent or error */
8334 #if ENABLE_HUSH_FAST
8336 //bb_error_msg("[%d] fork in run_pipe: G.count_SIGCHLD:%d G.handled_SIGCHLD:%d", getpid(), G.count_SIGCHLD, G.handled_SIGCHLD);
8338 enable_restore_tty_pgrp_on_exit();
8340 /* Clean up after vforked child */
8341 free(nommu_save.argv);
8342 free(nommu_save.argv_from_re_execing);
8343 unset_vars(nommu_save.new_env);
8344 add_vars(nommu_save.old_vars);
8346 free(argv_expanded);
8347 argv_expanded = NULL;
8348 if (command->pid < 0) { /* [v]fork failed */
8349 /* Clearly indicate, was it fork or vfork */
8350 bb_perror_msg(BB_MMU ? "vfork"+1 : "vfork");
8354 /* Second and next children need to know pid of first one */
8356 pi->pgrp = command->pid;
8362 if (cmd_no < pi->num_cmds)
8364 /* Pass read (output) pipe end to next iteration */
8365 next_infd = pipefds.rd;
8368 if (!pi->alive_cmds) {
8370 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
8375 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
8379 /* NB: called by pseudo_exec, and therefore must not modify any
8380 * global data until exec/_exit (we can be a child after vfork!) */
8381 static int run_list(struct pipe *pi)
8383 #if ENABLE_HUSH_CASE
8384 char *case_word = NULL;
8386 #if ENABLE_HUSH_LOOPS
8387 struct pipe *loop_top = NULL;
8388 char **for_lcur = NULL;
8389 char **for_list = NULL;
8391 smallint last_followup;
8393 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
8394 smalluint cond_code = 0;
8396 enum { cond_code = 0 };
8399 smallint rword; /* RES_foo */
8400 smallint last_rword; /* ditto */
8403 debug_printf_exec("run_list start lvl %d\n", G.run_list_level);
8406 #if ENABLE_HUSH_LOOPS
8407 /* Check syntax for "for" */
8410 for (cpipe = pi; cpipe; cpipe = cpipe->next) {
8411 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
8413 /* current word is FOR or IN (BOLD in comments below) */
8414 if (cpipe->next == NULL) {
8415 syntax_error("malformed for");
8417 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
8420 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
8421 if (cpipe->next->res_word == RES_DO)
8423 /* next word is not "do". It must be "in" then ("FOR v in ...") */
8424 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
8425 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
8427 syntax_error("malformed for");
8429 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
8436 /* Past this point, all code paths should jump to ret: label
8437 * in order to return, no direct "return" statements please.
8438 * This helps to ensure that no memory is leaked. */
8446 last_rword = RES_XXXX;
8448 last_followup = PIPE_SEQ;
8449 rcode = G.last_exitcode;
8451 /* Go through list of pipes, (maybe) executing them. */
8452 for (; pi; pi = IF_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
8454 int sv_errexit_depth;
8458 if (G_flag_return_in_progress == 1)
8461 IF_HAS_KEYWORDS(rword = pi->res_word;)
8462 debug_printf_exec(": rword=%d cond_code=%d last_rword=%d\n",
8463 rword, cond_code, last_rword);
8465 sv_errexit_depth = G.errexit_depth;
8468 rword == RES_IF || rword == RES_ELIF ||
8470 pi->followup != PIPE_SEQ
8474 #if ENABLE_HUSH_LOOPS
8475 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
8476 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
8478 /* start of a loop: remember where loop starts */
8483 /* Still in the same "if...", "then..." or "do..." branch? */
8484 if (IF_HAS_KEYWORDS(rword == last_rword &&) 1) {
8485 if ((rcode == 0 && last_followup == PIPE_OR)
8486 || (rcode != 0 && last_followup == PIPE_AND)
8488 /* It is "<true> || CMD" or "<false> && CMD"
8489 * and we should not execute CMD */
8490 debug_printf_exec("skipped cmd because of || or &&\n");
8491 last_followup = pi->followup;
8492 goto dont_check_jobs_but_continue;
8495 last_followup = pi->followup;
8496 IF_HAS_KEYWORDS(last_rword = rword;)
8499 if (rword == RES_THEN) {
8500 /* if false; then ... fi has exitcode 0! */
8501 G.last_exitcode = rcode = EXIT_SUCCESS;
8502 /* "if <false> THEN cmd": skip cmd */
8506 if (rword == RES_ELSE || rword == RES_ELIF) {
8507 /* "if <true> then ... ELSE/ELIF cmd":
8508 * skip cmd and all following ones */
8513 #if ENABLE_HUSH_LOOPS
8514 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
8516 /* first loop through for */
8518 static const char encoded_dollar_at[] ALIGN1 = {
8519 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
8520 }; /* encoded representation of "$@" */
8521 static const char *const encoded_dollar_at_argv[] = {
8522 encoded_dollar_at, NULL
8523 }; /* argv list with one element: "$@" */
8526 vals = (char**)encoded_dollar_at_argv;
8527 if (pi->next->res_word == RES_IN) {
8528 /* if no variable values after "in" we skip "for" */
8529 if (!pi->next->cmds[0].argv) {
8530 G.last_exitcode = rcode = EXIT_SUCCESS;
8531 debug_printf_exec(": null FOR: exitcode EXIT_SUCCESS\n");
8534 vals = pi->next->cmds[0].argv;
8535 } /* else: "for var; do..." -> assume "$@" list */
8536 /* create list of variable values */
8537 debug_print_strings("for_list made from", vals);
8538 for_list = expand_strvec_to_strvec(vals);
8539 for_lcur = for_list;
8540 debug_print_strings("for_list", for_list);
8543 /* "for" loop is over, clean up */
8549 /* Insert next value from for_lcur */
8550 /* note: *for_lcur already has quotes removed, $var expanded, etc */
8551 set_local_var(xasprintf("%s=%s", pi->cmds[0].argv[0], *for_lcur++), /*flag:*/ 0);
8554 if (rword == RES_IN) {
8555 continue; /* "for v IN list;..." - "in" has no cmds anyway */
8557 if (rword == RES_DONE) {
8558 continue; /* "done" has no cmds too */
8561 #if ENABLE_HUSH_CASE
8562 if (rword == RES_CASE) {
8563 debug_printf_exec("CASE cond_code:%d\n", cond_code);
8564 case_word = expand_strvec_to_string(pi->cmds->argv);
8565 unbackslash(case_word);
8568 if (rword == RES_MATCH) {
8571 debug_printf_exec("MATCH cond_code:%d\n", cond_code);
8572 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
8574 /* all prev words didn't match, does this one match? */
8575 argv = pi->cmds->argv;
8577 char *pattern = expand_string_to_string(*argv, /*unbackslash:*/ 0);
8578 /* TODO: which FNM_xxx flags to use? */
8579 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
8580 debug_printf_exec("fnmatch(pattern:'%s',str:'%s'):%d\n", pattern, case_word, cond_code);
8582 if (cond_code == 0) { /* match! we will execute this branch */
8584 case_word = NULL; /* make future "word)" stop */
8591 if (rword == RES_CASE_BODY) { /* inside of a case branch */
8592 debug_printf_exec("CASE_BODY cond_code:%d\n", cond_code);
8594 continue; /* not matched yet, skip this pipe */
8596 if (rword == RES_ESAC) {
8597 debug_printf_exec("ESAC cond_code:%d\n", cond_code);
8599 /* "case" did not match anything: still set $? (to 0) */
8600 G.last_exitcode = rcode = EXIT_SUCCESS;
8604 /* Just pressing <enter> in shell should check for jobs.
8605 * OTOH, in non-interactive shell this is useless
8606 * and only leads to extra job checks */
8607 if (pi->num_cmds == 0) {
8608 if (G_interactive_fd)
8609 goto check_jobs_and_continue;
8613 /* After analyzing all keywords and conditions, we decided
8614 * to execute this pipe. NB: have to do checkjobs(NULL)
8615 * after run_pipe to collect any background children,
8616 * even if list execution is to be stopped. */
8617 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
8618 #if ENABLE_HUSH_LOOPS
8619 G.flag_break_continue = 0;
8621 rcode = r = run_pipe(pi); /* NB: rcode is a smalluint, r is int */
8623 /* We ran a builtin, function, or group.
8624 * rcode is already known
8625 * and we don't need to wait for anything. */
8626 debug_printf_exec(": builtin/func exitcode %d\n", rcode);
8627 G.last_exitcode = rcode;
8628 check_and_run_traps();
8629 #if ENABLE_HUSH_LOOPS
8630 /* Was it "break" or "continue"? */
8631 if (G.flag_break_continue) {
8632 smallint fbc = G.flag_break_continue;
8633 /* We might fall into outer *loop*,
8634 * don't want to break it too */
8636 G.depth_break_continue--;
8637 if (G.depth_break_continue == 0)
8638 G.flag_break_continue = 0;
8639 /* else: e.g. "continue 2" should *break* once, *then* continue */
8640 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
8641 if (G.depth_break_continue != 0 || fbc == BC_BREAK) {
8642 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8645 /* "continue": simulate end of loop */
8650 if (G_flag_return_in_progress == 1) {
8651 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8654 } else if (pi->followup == PIPE_BG) {
8655 /* What does bash do with attempts to background builtins? */
8656 /* even bash 3.2 doesn't do that well with nested bg:
8657 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
8658 * I'm NOT treating inner &'s as jobs */
8660 if (G.run_list_level == 1)
8661 insert_job_into_table(pi);
8663 /* Last command's pid goes to $! */
8664 G.last_bg_pid = pi->cmds[pi->num_cmds - 1].pid;
8665 G.last_bg_pid_exitcode = 0;
8666 debug_printf_exec(": cmd&: exitcode EXIT_SUCCESS\n");
8667 /* Check pi->pi_inverted? "! sleep 1 & echo $?": bash says 1. dash and ash say 0 */
8668 rcode = EXIT_SUCCESS;
8672 if (G.run_list_level == 1 && G_interactive_fd) {
8673 /* Waits for completion, then fg's main shell */
8674 rcode = checkjobs_and_fg_shell(pi);
8675 debug_printf_exec(": checkjobs_and_fg_shell exitcode %d\n", rcode);
8679 /* This one just waits for completion */
8680 rcode = checkjobs(pi, 0 /*(no pid to wait for)*/);
8681 debug_printf_exec(": checkjobs exitcode %d\n", rcode);
8683 G.last_exitcode = rcode;
8684 check_and_run_traps();
8687 /* Handle "set -e" */
8688 if (rcode != 0 && G.o_opt[OPT_O_ERREXIT]) {
8689 debug_printf_exec("ERREXIT:1 errexit_depth:%d\n", G.errexit_depth);
8690 if (G.errexit_depth == 0)
8693 G.errexit_depth = sv_errexit_depth;
8695 /* Analyze how result affects subsequent commands */
8697 if (rword == RES_IF || rword == RES_ELIF)
8700 check_jobs_and_continue:
8701 checkjobs(NULL, 0 /*(no pid to wait for)*/);
8702 dont_check_jobs_but_continue: ;
8703 #if ENABLE_HUSH_LOOPS
8704 /* Beware of "while false; true; do ..."! */
8706 && (pi->next->res_word == RES_DO || pi->next->res_word == RES_DONE)
8707 /* check for RES_DONE is needed for "while ...; do \n done" case */
8709 if (rword == RES_WHILE) {
8711 /* "while false; do...done" - exitcode 0 */
8712 G.last_exitcode = rcode = EXIT_SUCCESS;
8713 debug_printf_exec(": while expr is false: breaking (exitcode:EXIT_SUCCESS)\n");
8717 if (rword == RES_UNTIL) {
8719 debug_printf_exec(": until expr is true: breaking\n");
8730 #if ENABLE_HUSH_LOOPS
8735 #if ENABLE_HUSH_CASE
8739 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
8743 /* Select which version we will use */
8744 static int run_and_free_list(struct pipe *pi)
8747 debug_printf_exec("run_and_free_list entered\n");
8748 if (!G.o_opt[OPT_O_NOEXEC]) {
8749 debug_printf_exec(": run_list: 1st pipe with %d cmds\n", pi->num_cmds);
8750 rcode = run_list(pi);
8752 /* free_pipe_list has the side effect of clearing memory.
8753 * In the long run that function can be merged with run_list,
8754 * but doing that now would hobble the debugging effort. */
8756 debug_printf_exec("run_and_free_list return %d\n", rcode);
8761 static void install_sighandlers(unsigned mask)
8763 sighandler_t old_handler;
8765 while ((mask >>= 1) != 0) {
8769 old_handler = install_sighandler(sig, pick_sighandler(sig));
8770 /* POSIX allows shell to re-enable SIGCHLD
8771 * even if it was SIG_IGN on entry.
8772 * Therefore we skip IGN check for it:
8776 /* bash re-enables SIGHUP which is SIG_IGNed on entry.
8777 * Try: "trap '' HUP; bash; echo RET" and type "kill -HUP $$"
8779 //if (sig == SIGHUP) continue; - TODO?
8780 if (old_handler == SIG_IGN) {
8781 /* oops... restore back to IGN, and record this fact */
8782 install_sighandler(sig, old_handler);
8783 #if ENABLE_HUSH_TRAP
8785 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
8787 G_traps[sig] = xzalloc(1); /* == xstrdup(""); */
8793 /* Called a few times only (or even once if "sh -c") */
8794 static void install_special_sighandlers(void)
8798 /* Which signals are shell-special? */
8799 mask = (1 << SIGQUIT) | (1 << SIGCHLD);
8800 if (G_interactive_fd) {
8801 mask |= SPECIAL_INTERACTIVE_SIGS;
8802 if (G_saved_tty_pgrp) /* we have ctty, job control sigs work */
8803 mask |= SPECIAL_JOBSTOP_SIGS;
8805 /* Careful, do not re-install handlers we already installed */
8806 if (G.special_sig_mask != mask) {
8807 unsigned diff = mask & ~G.special_sig_mask;
8808 G.special_sig_mask = mask;
8809 install_sighandlers(diff);
8815 /* Set handlers to restore tty pgrp and exit */
8816 static void install_fatal_sighandlers(void)
8820 /* We will restore tty pgrp on these signals */
8822 /*+ (1 << SIGILL ) * HUSH_DEBUG*/
8823 /*+ (1 << SIGFPE ) * HUSH_DEBUG*/
8824 + (1 << SIGBUS ) * HUSH_DEBUG
8825 + (1 << SIGSEGV) * HUSH_DEBUG
8826 /*+ (1 << SIGTRAP) * HUSH_DEBUG*/
8828 /* bash 3.2 seems to handle these just like 'fatal' ones */
8831 /* if we are interactive, SIGHUP, SIGTERM and SIGINT are special sigs.
8832 * if we aren't interactive... but in this case
8833 * we never want to restore pgrp on exit, and this fn is not called
8835 /*+ (1 << SIGHUP )*/
8836 /*+ (1 << SIGTERM)*/
8837 /*+ (1 << SIGINT )*/
8839 G_fatal_sig_mask = mask;
8841 install_sighandlers(mask);
8845 static int set_mode(int state, char mode, const char *o_opt)
8850 G.o_opt[OPT_O_NOEXEC] = state;
8853 IF_HUSH_MODE_X(G_x_mode = state;)
8857 /* "set -+o" without parameter.
8858 * in bash, set -o produces this output:
8862 * We always use the second form.
8864 const char *p = o_opt_strings;
8867 printf("set %co %s\n", (G.o_opt[idx] ? '-' : '+'), p);
8873 idx = index_in_strings(o_opt_strings, o_opt);
8875 G.o_opt[idx] = state;
8879 G.o_opt[OPT_O_ERREXIT] = state;
8882 return EXIT_FAILURE;
8884 return EXIT_SUCCESS;
8887 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
8888 int hush_main(int argc, char **argv)
8891 OPT_login = (1 << 0),
8895 unsigned builtin_argc;
8897 struct variable *cur_var;
8898 struct variable *shell_ver;
8901 if (EXIT_SUCCESS != 0) /* if EXIT_SUCCESS == 0, it is already done */
8902 G.last_exitcode = EXIT_SUCCESS;
8904 #if ENABLE_HUSH_FAST
8905 G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
8908 G.argv0_for_re_execing = argv[0];
8910 /* Deal with HUSH_VERSION */
8911 shell_ver = xzalloc(sizeof(*shell_ver));
8912 shell_ver->flg_export = 1;
8913 shell_ver->flg_read_only = 1;
8914 /* Code which handles ${var<op>...} needs writable values for all variables,
8915 * therefore we xstrdup: */
8916 shell_ver->varstr = xstrdup(hush_version_str);
8917 /* Create shell local variables from the values
8918 * currently living in the environment */
8919 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
8920 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
8921 G.top_var = shell_ver;
8922 cur_var = G.top_var;
8925 char *value = strchr(*e, '=');
8926 if (value) { /* paranoia */
8927 cur_var->next = xzalloc(sizeof(*cur_var));
8928 cur_var = cur_var->next;
8929 cur_var->varstr = *e;
8930 cur_var->max_len = strlen(*e);
8931 cur_var->flg_export = 1;
8935 /* (Re)insert HUSH_VERSION into env (AFTER we scanned the env!) */
8936 debug_printf_env("putenv '%s'\n", shell_ver->varstr);
8937 putenv(shell_ver->varstr);
8940 set_pwd_var(SETFLAG_EXPORT);
8942 #if BASH_HOSTNAME_VAR
8943 /* Set (but not export) HOSTNAME unless already set */
8944 if (!get_local_var_value("HOSTNAME")) {
8947 set_local_var_from_halves("HOSTNAME", uts.nodename);
8949 /* bash also exports SHLVL and _,
8950 * and sets (but doesn't export) the following variables:
8952 * BASH_VERSINFO=([0]="3" [1]="2" [2]="0" [3]="1" [4]="release" [5]="i386-pc-linux-gnu")
8953 * BASH_VERSION='3.2.0(1)-release'
8955 * MACHTYPE=i386-pc-linux-gnu
8957 * PPID=<NNNNN> - we also do it elsewhere
8968 * PIPESTATUS=([0]="0")
8969 * HISTFILE=/<xxx>/.bash_history
8973 * PATH=/usr/gnu/bin:/usr/local/bin:/bin:/usr/bin:.
8975 * SHELLOPTS=braceexpand:emacs:hashall:histexpand:history:interactive-comments:monitor
8986 #if ENABLE_FEATURE_EDITING
8987 G.line_input_state = new_line_input_t(FOR_SHELL);
8990 /* Initialize some more globals to non-zero values */
8991 cmdedit_update_prompt();
8993 die_func = restore_ttypgrp_and__exit;
8995 /* Shell is non-interactive at first. We need to call
8996 * install_special_sighandlers() if we are going to execute "sh <script>",
8997 * "sh -c <cmds>" or login shell's /etc/profile and friends.
8998 * If we later decide that we are interactive, we run install_special_sighandlers()
8999 * in order to intercept (more) signals.
9003 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
9004 flags = (argv[0] && argv[0][0] == '-') ? OPT_login : 0;
9007 opt = getopt(argc, argv, "+c:exinsl"
9010 # if ENABLE_HUSH_FUNCTIONS
9020 * sh ... -c 'script'
9021 * sh ... -c 'script' ARG0 [ARG1...]
9022 * On NOMMU, if builtin_argc != 0,
9023 * sh ... -c 'builtin' BARGV... "" ARG0 [ARG1...]
9024 * "" needs to be replaced with NULL
9025 * and BARGV vector fed to builtin function.
9026 * Note: the form without ARG0 never happens:
9027 * sh ... -c 'builtin' BARGV... ""
9030 G.root_pid = getpid();
9031 G.root_ppid = getppid();
9033 G.global_argv = argv + optind;
9034 G.global_argc = argc - optind;
9036 /* -c 'builtin' [BARGV...] "" ARG0 [ARG1...] */
9037 const struct built_in_command *x;
9039 install_special_sighandlers();
9040 x = find_builtin(optarg);
9041 if (x) { /* paranoia */
9042 G.global_argc -= builtin_argc; /* skip [BARGV...] "" */
9043 G.global_argv += builtin_argc;
9044 G.global_argv[-1] = NULL; /* replace "" */
9046 G.last_exitcode = x->b_function(argv + optind - 1);
9050 if (!G.global_argv[0]) {
9051 /* -c 'script' (no params): prevent empty $0 */
9052 G.global_argv--; /* points to argv[i] of 'script' */
9053 G.global_argv[0] = argv[0];
9055 } /* else -c 'script' ARG0 [ARG1...]: $0 is ARG0 */
9056 install_special_sighandlers();
9057 parse_and_run_string(optarg);
9060 /* Well, we cannot just declare interactiveness,
9061 * we have to have some stuff (ctty, etc) */
9062 /* G_interactive_fd++; */
9065 /* "-s" means "read from stdin", but this is how we always
9066 * operate, so simply do nothing here. */
9072 case '<': /* "big heredoc" support */
9073 full_write1_str(optarg);
9076 unsigned long long empty_trap_mask;
9078 G.root_pid = bb_strtou(optarg, &optarg, 16);
9080 G.root_ppid = bb_strtou(optarg, &optarg, 16);
9082 G.last_bg_pid = bb_strtou(optarg, &optarg, 16);
9084 G.last_exitcode = bb_strtou(optarg, &optarg, 16);
9086 builtin_argc = bb_strtou(optarg, &optarg, 16);
9088 empty_trap_mask = bb_strtoull(optarg, &optarg, 16);
9089 if (empty_trap_mask != 0) {
9090 IF_HUSH_TRAP(int sig;)
9091 install_special_sighandlers();
9092 # if ENABLE_HUSH_TRAP
9093 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
9094 for (sig = 1; sig < NSIG; sig++) {
9095 if (empty_trap_mask & (1LL << sig)) {
9096 G_traps[sig] = xzalloc(1); /* == xstrdup(""); */
9097 install_sighandler(sig, SIG_IGN);
9102 # if ENABLE_HUSH_LOOPS
9104 G.depth_of_loop = bb_strtou(optarg, &optarg, 16);
9110 set_local_var(xstrdup(optarg), opt == 'R' ? SETFLAG_MAKE_RO : 0);
9112 # if ENABLE_HUSH_FUNCTIONS
9114 struct function *funcp = new_function(optarg);
9115 /* funcp->name is already set to optarg */
9116 /* funcp->body is set to NULL. It's a special case. */
9117 funcp->body_as_string = argv[optind];
9126 if (set_mode(1, opt, NULL) == 0) /* no error */
9130 fprintf(stderr, "Usage: sh [FILE]...\n"
9131 " or: sh -c command [args]...\n\n");
9137 } /* option parsing loop */
9139 /* Skip options. Try "hush -l": $1 should not be "-l"! */
9140 G.global_argc = argc - (optind - 1);
9141 G.global_argv = argv + (optind - 1);
9142 G.global_argv[0] = argv[0];
9145 G.root_pid = getpid();
9146 G.root_ppid = getppid();
9149 /* If we are login shell... */
9150 if (flags & OPT_login) {
9152 debug_printf("sourcing /etc/profile\n");
9153 input = fopen_for_read("/etc/profile");
9154 if (input != NULL) {
9155 remember_FILE(input);
9156 install_special_sighandlers();
9157 parse_and_run_file(input);
9158 fclose_and_forget(input);
9160 /* bash: after sourcing /etc/profile,
9161 * tries to source (in the given order):
9162 * ~/.bash_profile, ~/.bash_login, ~/.profile,
9163 * stopping on first found. --noprofile turns this off.
9164 * bash also sources ~/.bash_logout on exit.
9165 * If called as sh, skips .bash_XXX files.
9169 if (G.global_argv[1]) {
9172 * "bash <script>" (which is never interactive (unless -i?))
9173 * sources $BASH_ENV here (without scanning $PATH).
9174 * If called as sh, does the same but with $ENV.
9175 * Also NB, per POSIX, $ENV should undergo parameter expansion.
9179 debug_printf("running script '%s'\n", G.global_argv[0]);
9180 xfunc_error_retval = 127; /* for "hush /does/not/exist" case */
9181 input = xfopen_for_read(G.global_argv[0]);
9182 xfunc_error_retval = 1;
9183 remember_FILE(input);
9184 install_special_sighandlers();
9185 parse_and_run_file(input);
9186 #if ENABLE_FEATURE_CLEAN_UP
9187 fclose_and_forget(input);
9192 /* Up to here, shell was non-interactive. Now it may become one.
9193 * NB: don't forget to (re)run install_special_sighandlers() as needed.
9196 /* A shell is interactive if the '-i' flag was given,
9197 * or if all of the following conditions are met:
9199 * no arguments remaining or the -s flag given
9200 * standard input is a terminal
9201 * standard output is a terminal
9202 * Refer to Posix.2, the description of the 'sh' utility.
9205 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
9206 G_saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
9207 debug_printf("saved_tty_pgrp:%d\n", G_saved_tty_pgrp);
9208 if (G_saved_tty_pgrp < 0)
9209 G_saved_tty_pgrp = 0;
9211 /* try to dup stdin to high fd#, >= 255 */
9212 G_interactive_fd = fcntl_F_DUPFD(STDIN_FILENO, 254);
9213 if (G_interactive_fd < 0) {
9214 /* try to dup to any fd */
9215 G_interactive_fd = dup(STDIN_FILENO);
9216 if (G_interactive_fd < 0) {
9218 G_interactive_fd = 0;
9219 G_saved_tty_pgrp = 0;
9222 // TODO: track & disallow any attempts of user
9223 // to (inadvertently) close/redirect G_interactive_fd
9225 debug_printf("interactive_fd:%d\n", G_interactive_fd);
9226 if (G_interactive_fd) {
9227 close_on_exec_on(G_interactive_fd);
9229 if (G_saved_tty_pgrp) {
9230 /* If we were run as 'hush &', sleep until we are
9231 * in the foreground (tty pgrp == our pgrp).
9232 * If we get started under a job aware app (like bash),
9233 * make sure we are now in charge so we don't fight over
9234 * who gets the foreground */
9236 pid_t shell_pgrp = getpgrp();
9237 G_saved_tty_pgrp = tcgetpgrp(G_interactive_fd);
9238 if (G_saved_tty_pgrp == shell_pgrp)
9240 /* send TTIN to ourself (should stop us) */
9241 kill(- shell_pgrp, SIGTTIN);
9245 /* Install more signal handlers */
9246 install_special_sighandlers();
9248 if (G_saved_tty_pgrp) {
9249 /* Set other signals to restore saved_tty_pgrp */
9250 install_fatal_sighandlers();
9251 /* Put ourselves in our own process group
9252 * (bash, too, does this only if ctty is available) */
9253 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
9254 /* Grab control of the terminal */
9255 tcsetpgrp(G_interactive_fd, getpid());
9257 enable_restore_tty_pgrp_on_exit();
9259 # if ENABLE_HUSH_SAVEHISTORY && MAX_HISTORY > 0
9261 const char *hp = get_local_var_value("HISTFILE");
9263 hp = get_local_var_value("HOME");
9265 hp = concat_path_file(hp, ".hush_history");
9270 G.line_input_state->hist_file = hp;
9271 //set_local_var(xasprintf("HISTFILE=%s", ...));
9273 # if ENABLE_FEATURE_SH_HISTFILESIZE
9274 hp = get_local_var_value("HISTFILESIZE");
9275 G.line_input_state->max_history = size_from_HISTFILESIZE(hp);
9280 install_special_sighandlers();
9282 #elif ENABLE_HUSH_INTERACTIVE
9283 /* No job control compiled in, only prompt/line editing */
9284 if (isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)) {
9285 G_interactive_fd = fcntl_F_DUPFD(STDIN_FILENO, 254);
9286 if (G_interactive_fd < 0) {
9287 /* try to dup to any fd */
9288 G_interactive_fd = dup(STDIN_FILENO);
9289 if (G_interactive_fd < 0)
9291 G_interactive_fd = 0;
9294 if (G_interactive_fd) {
9295 close_on_exec_on(G_interactive_fd);
9297 install_special_sighandlers();
9299 /* We have interactiveness code disabled */
9300 install_special_sighandlers();
9303 * if interactive but not a login shell, sources ~/.bashrc
9304 * (--norc turns this off, --rcfile <file> overrides)
9307 if (!ENABLE_FEATURE_SH_EXTRA_QUIET && G_interactive_fd) {
9308 /* note: ash and hush share this string */
9309 printf("\n\n%s %s\n"
9310 IF_HUSH_HELP("Enter 'help' for a list of built-in commands.\n")
9313 "hush - the humble shell"
9317 parse_and_run_file(stdin);
9320 hush_exit(G.last_exitcode);
9327 static int FAST_FUNC builtin_true(char **argv UNUSED_PARAM)
9332 #if ENABLE_HUSH_TEST || ENABLE_HUSH_ECHO || ENABLE_HUSH_PRINTF || ENABLE_HUSH_KILL
9333 static int run_applet_main(char **argv, int (*applet_main_func)(int argc, char **argv))
9335 int argc = string_array_len(argv);
9336 return applet_main_func(argc, argv);
9339 #if ENABLE_HUSH_TEST || BASH_TEST2
9340 static int FAST_FUNC builtin_test(char **argv)
9342 return run_applet_main(argv, test_main);
9345 #if ENABLE_HUSH_ECHO
9346 static int FAST_FUNC builtin_echo(char **argv)
9348 return run_applet_main(argv, echo_main);
9351 #if ENABLE_HUSH_PRINTF
9352 static int FAST_FUNC builtin_printf(char **argv)
9354 return run_applet_main(argv, printf_main);
9358 #if ENABLE_HUSH_HELP
9359 static int FAST_FUNC builtin_help(char **argv UNUSED_PARAM)
9361 const struct built_in_command *x;
9364 "Built-in commands:\n"
9365 "------------------\n");
9366 for (x = bltins1; x != &bltins1[ARRAY_SIZE(bltins1)]; x++) {
9368 printf("%-10s%s\n", x->b_cmd, x->b_descr);
9370 return EXIT_SUCCESS;
9374 #if MAX_HISTORY && ENABLE_FEATURE_EDITING
9375 static int FAST_FUNC builtin_history(char **argv UNUSED_PARAM)
9377 show_history(G.line_input_state);
9378 return EXIT_SUCCESS;
9382 static char **skip_dash_dash(char **argv)
9385 if (argv[0] && argv[0][0] == '-' && argv[0][1] == '-' && argv[0][2] == '\0')
9390 static int FAST_FUNC builtin_cd(char **argv)
9394 argv = skip_dash_dash(argv);
9396 if (newdir == NULL) {
9397 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
9398 * bash says "bash: cd: HOME not set" and does nothing
9401 const char *home = get_local_var_value("HOME");
9402 newdir = home ? home : "/";
9404 if (chdir(newdir)) {
9405 /* Mimic bash message exactly */
9406 bb_perror_msg("cd: %s", newdir);
9407 return EXIT_FAILURE;
9409 /* Read current dir (get_cwd(1) is inside) and set PWD.
9410 * Note: do not enforce exporting. If PWD was unset or unexported,
9411 * set it again, but do not export. bash does the same.
9413 set_pwd_var(/*flag:*/ 0);
9414 return EXIT_SUCCESS;
9417 static int FAST_FUNC builtin_pwd(char **argv UNUSED_PARAM)
9420 return EXIT_SUCCESS;
9423 static int FAST_FUNC builtin_eval(char **argv)
9425 int rcode = EXIT_SUCCESS;
9427 argv = skip_dash_dash(argv);
9432 /* "The eval utility shall construct a command by
9433 * concatenating arguments together, separating
9434 * each with a <space> character."
9440 len += strlen(*pp) + 1;
9442 str = p = xmalloc(len);
9452 * eval "echo Hi; done" ("done" is syntax error):
9453 * "echo Hi" will not execute too.
9455 parse_and_run_string(str ? str : argv[0]);
9457 rcode = G.last_exitcode;
9462 static int FAST_FUNC builtin_exec(char **argv)
9464 argv = skip_dash_dash(argv);
9465 if (argv[0] == NULL)
9466 return EXIT_SUCCESS; /* bash does this */
9468 /* Careful: we can end up here after [v]fork. Do not restore
9469 * tty pgrp then, only top-level shell process does that */
9470 if (G_saved_tty_pgrp && getpid() == G.root_pid)
9471 tcsetpgrp(G_interactive_fd, G_saved_tty_pgrp);
9473 /* Saved-redirect fds, script fds and G_interactive_fd are still
9474 * open here. However, they are all CLOEXEC, and execv below
9475 * closes them. Try interactive "exec ls -l /proc/self/fd",
9476 * it should show no extra open fds in the "ls" process.
9477 * If we'd try to run builtins/NOEXECs, this would need improving.
9479 //close_saved_fds_and_FILE_fds();
9481 /* TODO: if exec fails, bash does NOT exit! We do.
9482 * We'll need to undo trap cleanup (it's inside execvp_or_die)
9483 * and tcsetpgrp, and this is inherently racy.
9485 execvp_or_die(argv);
9488 static int FAST_FUNC builtin_exit(char **argv)
9490 debug_printf_exec("%s()\n", __func__);
9492 /* interactive bash:
9493 * # trap "echo EEE" EXIT
9496 * There are stopped jobs.
9497 * (if there are _stopped_ jobs, running ones don't count)
9500 * EEE (then bash exits)
9502 * TODO: we can use G.exiting = -1 as indicator "last cmd was exit"
9505 /* note: EXIT trap is run by hush_exit */
9506 argv = skip_dash_dash(argv);
9507 if (argv[0] == NULL)
9508 hush_exit(G.last_exitcode);
9509 /* mimic bash: exit 123abc == exit 255 + error msg */
9510 xfunc_error_retval = 255;
9511 /* bash: exit -2 == exit 254, no error msg */
9512 hush_exit(xatoi(argv[0]) & 0xff);
9515 #if ENABLE_HUSH_TYPE
9516 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/type.html */
9517 static int FAST_FUNC builtin_type(char **argv)
9519 int ret = EXIT_SUCCESS;
9525 if (0) {} /* make conditional compile easier below */
9526 /*else if (find_alias(*argv))
9527 type = "an alias";*/
9528 #if ENABLE_HUSH_FUNCTIONS
9529 else if (find_function(*argv))
9530 type = "a function";
9532 else if (find_builtin(*argv))
9533 type = "a shell builtin";
9534 else if ((path = find_in_path(*argv)) != NULL)
9537 bb_error_msg("type: %s: not found", *argv);
9542 printf("%s is %s\n", *argv, type);
9550 #if ENABLE_HUSH_READ
9551 /* Interruptibility of read builtin in bash
9552 * (tested on bash-4.2.8 by sending signals (not by ^C)):
9554 * Empty trap makes read ignore corresponding signal, for any signal.
9557 * - terminates non-interactive shell;
9558 * - interrupts read in interactive shell;
9559 * if it has non-empty trap:
9560 * - executes trap and returns to command prompt in interactive shell;
9561 * - executes trap and returns to read in non-interactive shell;
9563 * - is ignored (does not interrupt) read in interactive shell;
9564 * - terminates non-interactive shell;
9565 * if it has non-empty trap:
9566 * - executes trap and returns to read;
9568 * - terminates shell (regardless of interactivity);
9569 * if it has non-empty trap:
9570 * - executes trap and returns to read;
9571 * SIGCHLD from children:
9572 * - does not interrupt read regardless of interactivity:
9573 * try: sleep 1 & read x; echo $x
9575 static int FAST_FUNC builtin_read(char **argv)
9582 char *opt_d = NULL; /* optimized out if !BASH */
9586 /* "!": do not abort on errors.
9587 * Option string must start with "sr" to match BUILTIN_READ_xxx
9589 read_flags = getopt32(argv,
9591 "!srn:p:t:u:d:", &opt_n, &opt_p, &opt_t, &opt_u, &opt_d
9593 "!srn:p:t:u:", &opt_n, &opt_p, &opt_t, &opt_u
9596 if (read_flags == (uint32_t)-1)
9597 return EXIT_FAILURE;
9599 ifs = get_local_var_value("IFS"); /* can be NULL */
9602 r = shell_builtin_read(set_local_var_from_halves,
9613 if ((uintptr_t)r == 1 && errno == EINTR) {
9614 unsigned sig = check_and_run_traps();
9619 if ((uintptr_t)r > 1) {
9620 bb_error_msg("%s", r);
9621 r = (char*)(uintptr_t)1;
9624 return (uintptr_t)r;
9628 #if ENABLE_HUSH_UMASK
9629 static int FAST_FUNC builtin_umask(char **argv)
9636 argv = skip_dash_dash(argv);
9638 mode_t old_mask = mask;
9640 /* numeric umasks are taken as-is */
9641 /* symbolic umasks are inverted: "umask a=rx" calls umask(222) */
9642 if (!isdigit(argv[0][0]))
9644 mask = bb_parse_mode(argv[0], mask);
9645 if (!isdigit(argv[0][0]))
9647 if ((unsigned)mask > 0777) {
9650 * bash: umask: 'q': invalid symbolic mode operator
9651 * bash: umask: 999: octal number out of range
9653 bb_error_msg("%s: invalid mode '%s'", "umask", argv[0]);
9658 printf("%04o\n", (unsigned) mask);
9659 /* fall through and restore mask which we set to 0 */
9663 return !rc; /* rc != 0 - success */
9667 #if ENABLE_HUSH_EXPORT || ENABLE_HUSH_TRAP
9668 static void print_escaped(const char *s)
9673 const char *p = strchrnul(s, '\'');
9674 /* print 'xxxx', possibly just '' */
9675 printf("'%.*s'", (int)(p - s), s);
9680 /* s points to '; print "'''...'''" */
9682 do putchar('\''); while (*++s == '\'');
9688 #if ENABLE_HUSH_EXPORT || ENABLE_HUSH_LOCAL || ENABLE_HUSH_READONLY
9689 static int helper_export_local(char **argv, unsigned flags)
9693 char *name_end = strchrnul(name, '=');
9695 /* So far we do not check that name is valid (TODO?) */
9697 if (*name_end == '\0') {
9698 struct variable *var, **vpp;
9700 vpp = get_ptr_to_local_var(name, name_end - name);
9701 var = vpp ? *vpp : NULL;
9703 if (flags & SETFLAG_UNEXPORT) {
9704 /* export -n NAME (without =VALUE) */
9706 var->flg_export = 0;
9707 debug_printf_env("%s: unsetenv '%s'\n", __func__, name);
9709 } /* else: export -n NOT_EXISTING_VAR: no-op */
9712 if (flags & SETFLAG_EXPORT) {
9713 /* export NAME (without =VALUE) */
9715 var->flg_export = 1;
9716 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
9717 putenv(var->varstr);
9721 if (flags & SETFLAG_MAKE_RO) {
9722 /* readonly NAME (without =VALUE) */
9724 var->flg_read_only = 1;
9728 # if ENABLE_HUSH_LOCAL
9729 /* Is this "local" bltin? */
9730 if (!(flags & (SETFLAG_EXPORT|SETFLAG_UNEXPORT|SETFLAG_MAKE_RO))) {
9731 unsigned lvl = flags >> SETFLAG_LOCAL_SHIFT;
9732 if (var && var->func_nest_level == lvl) {
9733 /* "local x=abc; ...; local x" - ignore second local decl */
9738 /* Exporting non-existing variable.
9739 * bash does not put it in environment,
9740 * but remembers that it is exported,
9741 * and does put it in env when it is set later.
9742 * We just set it to "" and export.
9744 /* Or, it's "local NAME" (without =VALUE).
9745 * bash sets the value to "".
9747 /* Or, it's "readonly NAME" (without =VALUE).
9748 * bash remembers NAME and disallows its creation
9751 name = xasprintf("%s=", name);
9753 /* (Un)exporting/making local NAME=VALUE */
9754 name = xstrdup(name);
9756 if (set_local_var(name, flags))
9757 return EXIT_FAILURE;
9759 return EXIT_SUCCESS;
9763 #if ENABLE_HUSH_EXPORT
9764 static int FAST_FUNC builtin_export(char **argv)
9766 unsigned opt_unexport;
9768 #if ENABLE_HUSH_EXPORT_N
9769 /* "!": do not abort on errors */
9770 opt_unexport = getopt32(argv, "!n");
9771 if (opt_unexport == (uint32_t)-1)
9772 return EXIT_FAILURE;
9779 if (argv[0] == NULL) {
9786 /* ash emits: export VAR='VAL'
9787 * bash: declare -x VAR="VAL"
9788 * we follow ash example */
9789 const char *s = *e++;
9790 const char *p = strchr(s, '=');
9792 if (!p) /* wtf? take next variable */
9795 printf("export %.*s", (int)(p - s) + 1, s);
9796 print_escaped(p + 1);
9800 /*fflush_all(); - done after each builtin anyway */
9802 return EXIT_SUCCESS;
9805 return helper_export_local(argv, opt_unexport ? SETFLAG_UNEXPORT : SETFLAG_EXPORT);
9809 #if ENABLE_HUSH_LOCAL
9810 static int FAST_FUNC builtin_local(char **argv)
9812 if (G.func_nest_level == 0) {
9813 bb_error_msg("%s: not in a function", argv[0]);
9814 return EXIT_FAILURE; /* bash compat */
9817 return helper_export_local(argv, G.func_nest_level << SETFLAG_LOCAL_SHIFT);
9821 #if ENABLE_HUSH_READONLY
9822 static int FAST_FUNC builtin_readonly(char **argv)
9825 if (*argv == NULL) {
9826 /* bash: readonly [-p]: list all readonly VARs
9827 * (-p has no effect in bash)
9830 for (e = G.top_var; e; e = e->next) {
9831 if (e->flg_read_only) {
9832 //TODO: quote value: readonly VAR='VAL'
9833 printf("readonly %s\n", e->varstr);
9836 return EXIT_SUCCESS;
9838 return helper_export_local(argv, SETFLAG_MAKE_RO);
9842 #if ENABLE_HUSH_UNSET
9843 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
9844 static int FAST_FUNC builtin_unset(char **argv)
9849 /* "!": do not abort on errors */
9850 /* "+": stop at 1st non-option */
9851 opts = getopt32(argv, "!+vf");
9852 if (opts == (unsigned)-1)
9853 return EXIT_FAILURE;
9855 bb_error_msg("unset: -v and -f are exclusive");
9856 return EXIT_FAILURE;
9862 if (!(opts & 2)) { /* not -f */
9863 if (unset_local_var(*argv)) {
9864 /* unset <nonexistent_var> doesn't fail.
9865 * Error is when one tries to unset RO var.
9866 * Message was printed by unset_local_var. */
9870 # if ENABLE_HUSH_FUNCTIONS
9882 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
9883 * built-in 'set' handler
9885 * set [-abCefhmnuvx] [-o option] [argument...]
9886 * set [+abCefhmnuvx] [+o option] [argument...]
9887 * set -- [argument...]
9890 * Implementations shall support the options in both their hyphen and
9891 * plus-sign forms. These options can also be specified as options to sh.
9893 * Write out all variables and their values: set
9894 * Set $1, $2, and $3 and set "$#" to 3: set c a b
9895 * Turn on the -x and -v options: set -xv
9896 * Unset all positional parameters: set --
9897 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
9898 * Set the positional parameters to the expansion of x, even if x expands
9899 * with a leading '-' or '+': set -- $x
9901 * So far, we only support "set -- [argument...]" and some of the short names.
9903 static int FAST_FUNC builtin_set(char **argv)
9906 char **pp, **g_argv;
9907 char *arg = *++argv;
9911 for (e = G.top_var; e; e = e->next)
9913 return EXIT_SUCCESS;
9917 if (strcmp(arg, "--") == 0) {
9921 if (arg[0] != '+' && arg[0] != '-')
9923 for (n = 1; arg[n]; ++n) {
9924 if (set_mode((arg[0] == '-'), arg[n], argv[1]))
9926 if (arg[n] == 'o' && argv[1])
9929 } while ((arg = *++argv) != NULL);
9930 /* Now argv[0] is 1st argument */
9933 return EXIT_SUCCESS;
9936 /* NB: G.global_argv[0] ($0) is never freed/changed */
9937 g_argv = G.global_argv;
9938 if (G.global_args_malloced) {
9944 G.global_args_malloced = 1;
9945 pp = xzalloc(sizeof(pp[0]) * 2);
9946 pp[0] = g_argv[0]; /* retain $0 */
9949 /* This realloc's G.global_argv */
9950 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
9952 G.global_argc = 1 + string_array_len(pp + 1);
9954 return EXIT_SUCCESS;
9956 /* Nothing known, so abort */
9958 bb_error_msg("%s: %s: invalid option", "set", arg);
9959 return EXIT_FAILURE;
9963 static int FAST_FUNC builtin_shift(char **argv)
9966 argv = skip_dash_dash(argv);
9968 n = bb_strtou(argv[0], NULL, 10);
9969 if (errno || n < 0) {
9970 /* shared string with ash.c */
9971 bb_error_msg("Illegal number: %s", argv[0]);
9973 * ash aborts in this case.
9974 * bash prints error message and set $? to 1.
9975 * Interestingly, for "shift 99999" bash does not
9976 * print error message, but does set $? to 1
9977 * (and does no shifting at all).
9981 if (n >= 0 && n < G.global_argc) {
9982 if (G_global_args_malloced) {
9985 free(G.global_argv[m++]);
9988 memmove(&G.global_argv[1], &G.global_argv[n+1],
9989 G.global_argc * sizeof(G.global_argv[0]));
9990 return EXIT_SUCCESS;
9992 return EXIT_FAILURE;
9995 #if ENABLE_HUSH_GETOPTS
9996 static int FAST_FUNC builtin_getopts(char **argv)
9998 /* http://pubs.opengroup.org/onlinepubs/9699919799/utilities/getopts.html
10001 If a required argument is not found, and getopts is not silent,
10002 a question mark (?) is placed in VAR, OPTARG is unset, and a
10003 diagnostic message is printed. If getopts is silent, then a
10004 colon (:) is placed in VAR and OPTARG is set to the option
10007 Test that VAR is a valid variable name?
10009 "Whenever the shell is invoked, OPTIND shall be initialized to 1"
10012 const char *cp, *optstring, *var;
10013 int c, n, exitcode, my_opterr;
10016 optstring = *++argv;
10017 if (!optstring || !(var = *++argv)) {
10018 bb_error_msg("usage: getopts OPTSTRING VAR [ARGS]");
10019 return EXIT_FAILURE;
10023 argv[0] = G.global_argv[0]; /* for error messages in getopt() */
10025 argv = G.global_argv;
10029 if (optstring[0] != ':') {
10030 cp = get_local_var_value("OPTERR");
10031 /* 0 if "OPTERR=0", 1 otherwise */
10032 my_opterr = (!cp || NOT_LONE_CHAR(cp, '0'));
10035 /* getopts stops on first non-option. Add "+" to force that */
10036 /*if (optstring[0] != '+')*/ {
10037 char *s = alloca(strlen(optstring) + 2);
10038 sprintf(s, "+%s", optstring);
10042 /* Naively, now we should just
10043 * cp = get_local_var_value("OPTIND");
10044 * optind = cp ? atoi(cp) : 0;
10046 * opterr = my_opterr;
10047 * c = getopt(string_array_len(argv), argv, optstring);
10048 * and be done? Not so fast...
10049 * Unlike normal getopt() usage in C programs, here
10050 * each successive call will (usually) have the same argv[] CONTENTS,
10051 * but not the ADDRESSES. Worse yet, it's possible that between
10052 * invocations of "getopts", there will be calls to shell builtins
10053 * which use getopt() internally. Example:
10054 * while getopts "abc" RES -a -bc -abc de; do
10057 * This would not work correctly: getopt() call inside "unset"
10058 * modifies internal libc state which is tracking position in
10059 * multi-option strings ("-abc"). At best, it can skip options
10060 * or return the same option infinitely. With glibc implementation
10061 * of getopt(), it would use outright invalid pointers and return
10062 * garbage even _without_ "unset" mangling internal state.
10064 * We resort to resetting getopt() state and calling it N times,
10065 * until we get Nth result (or failure).
10066 * (N == G.getopt_count is reset to 0 whenever OPTIND is [un]set).
10070 n = string_array_len(argv);
10073 opterr = (count < G.getopt_count) ? 0 : my_opterr;
10074 c = getopt(n, argv, optstring);
10078 } while (count <= G.getopt_count);
10080 /* Set OPTIND. Prevent resetting of the magic counter! */
10081 set_local_var_from_halves("OPTIND", utoa(optind));
10082 G.getopt_count = count; /* "next time, give me N+1'th result" */
10083 GETOPT_RESET(); /* just in case */
10086 /* Always set or unset, never left as-is, even on exit/error:
10087 * "If no option was found, or if the option that was found
10088 * does not have an option-argument, OPTARG shall be unset."
10092 /* If ":optstring" and unknown option is seen,
10093 * it is stored to OPTARG.
10095 if (optstring[1] == ':') {
10101 set_local_var_from_halves("OPTARG", cp);
10103 unset_local_var("OPTARG");
10105 /* Convert -1 to "?" */
10106 exitcode = EXIT_SUCCESS;
10107 if (c < 0) { /* -1: end of options */
10108 exitcode = EXIT_FAILURE;
10114 set_local_var_from_halves(var, cbuf);
10120 static int FAST_FUNC builtin_source(char **argv)
10122 char *arg_path, *filename;
10125 char *args_need_save;
10126 #if ENABLE_HUSH_FUNCTIONS
10130 argv = skip_dash_dash(argv);
10131 filename = argv[0];
10133 /* bash says: "bash: .: filename argument required" */
10134 return 2; /* bash compat */
10137 if (!strchr(filename, '/')) {
10138 arg_path = find_in_path(filename);
10140 filename = arg_path;
10142 input = remember_FILE(fopen_or_warn(filename, "r"));
10145 /* bb_perror_msg("%s", *argv); - done by fopen_or_warn */
10146 /* POSIX: non-interactive shell should abort here,
10147 * not merely fail. So far no one complained :)
10149 return EXIT_FAILURE;
10152 #if ENABLE_HUSH_FUNCTIONS
10153 sv_flg = G_flag_return_in_progress;
10154 /* "we are inside sourced file, ok to use return" */
10155 G_flag_return_in_progress = -1;
10157 args_need_save = argv[1]; /* used as a boolean variable */
10158 if (args_need_save)
10159 save_and_replace_G_args(&sv, argv);
10161 /* "false; . ./empty_line; echo Zero:$?" should print 0 */
10162 G.last_exitcode = 0;
10163 parse_and_run_file(input);
10164 fclose_and_forget(input);
10166 if (args_need_save) /* can't use argv[1] instead: "shift" can mangle it */
10167 restore_G_args(&sv, argv);
10168 #if ENABLE_HUSH_FUNCTIONS
10169 G_flag_return_in_progress = sv_flg;
10172 return G.last_exitcode;
10175 #if ENABLE_HUSH_TRAP
10176 static int FAST_FUNC builtin_trap(char **argv)
10182 G_traps = xzalloc(sizeof(G_traps[0]) * NSIG);
10187 /* No args: print all trapped */
10188 for (i = 0; i < NSIG; ++i) {
10190 printf("trap -- ");
10191 print_escaped(G_traps[i]);
10192 /* note: bash adds "SIG", but only if invoked
10193 * as "bash". If called as "sh", or if set -o posix,
10194 * then it prints short signal names.
10195 * We are printing short names: */
10196 printf(" %s\n", get_signame(i));
10199 /*fflush_all(); - done after each builtin anyway */
10200 return EXIT_SUCCESS;
10204 /* If first arg is a number: reset all specified signals */
10205 sig = bb_strtou(*argv, NULL, 10);
10209 ret = EXIT_SUCCESS;
10211 sighandler_t handler;
10213 sig = get_signum(*argv++);
10215 ret = EXIT_FAILURE;
10216 /* Mimic bash message exactly */
10217 bb_error_msg("trap: %s: invalid signal specification", argv[-1]);
10221 free(G_traps[sig]);
10222 G_traps[sig] = xstrdup(new_cmd);
10224 debug_printf("trap: setting SIG%s (%i) to '%s'\n",
10225 get_signame(sig), sig, G_traps[sig]);
10227 /* There is no signal for 0 (EXIT) */
10232 handler = (new_cmd[0] ? record_pending_signo : SIG_IGN);
10234 /* We are removing trap handler */
10235 handler = pick_sighandler(sig);
10236 install_sighandler(sig, handler);
10241 if (!argv[1]) { /* no second arg */
10242 bb_error_msg("trap: invalid arguments");
10243 return EXIT_FAILURE;
10246 /* First arg is "-": reset all specified to default */
10247 /* First arg is "--": skip it, the rest is "handler SIGs..." */
10248 /* Everything else: set arg as signal handler
10249 * (includes "" case, which ignores signal) */
10250 if (argv[0][0] == '-') {
10251 if (argv[0][1] == '\0') { /* "-" */
10252 /* new_cmd remains NULL: "reset these sigs" */
10255 if (argv[0][1] == '-' && argv[0][2] == '\0') { /* "--" */
10258 /* else: "-something", no special meaning */
10263 goto process_sig_list;
10267 #if ENABLE_HUSH_JOB
10268 static struct pipe *parse_jobspec(const char *str)
10273 if (sscanf(str, "%%%u", &jobnum) != 1) {
10275 || (str[1] != '%' && str[1] != '+' && str[1] != '\0')
10277 bb_error_msg("bad argument '%s'", str);
10280 /* It is "%%", "%+" or "%" - current job */
10281 jobnum = G.last_jobid;
10283 bb_error_msg("no current job");
10287 for (pi = G.job_list; pi; pi = pi->next) {
10288 if (pi->jobid == jobnum) {
10292 bb_error_msg("%u: no such job", jobnum);
10296 static int FAST_FUNC builtin_jobs(char **argv UNUSED_PARAM)
10299 const char *status_string;
10301 checkjobs(NULL, 0 /*(no pid to wait for)*/);
10302 for (job = G.job_list; job; job = job->next) {
10303 if (job->alive_cmds == job->stopped_cmds)
10304 status_string = "Stopped";
10306 status_string = "Running";
10308 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
10311 clean_up_last_dead_job();
10313 return EXIT_SUCCESS;
10316 /* built-in 'fg' and 'bg' handler */
10317 static int FAST_FUNC builtin_fg_bg(char **argv)
10322 if (!G_interactive_fd)
10323 return EXIT_FAILURE;
10325 /* If they gave us no args, assume they want the last backgrounded task */
10327 for (pi = G.job_list; pi; pi = pi->next) {
10328 if (pi->jobid == G.last_jobid) {
10332 bb_error_msg("%s: no current job", argv[0]);
10333 return EXIT_FAILURE;
10336 pi = parse_jobspec(argv[1]);
10338 return EXIT_FAILURE;
10340 /* TODO: bash prints a string representation
10341 * of job being foregrounded (like "sleep 1 | cat") */
10342 if (argv[0][0] == 'f' && G_saved_tty_pgrp) {
10343 /* Put the job into the foreground. */
10344 tcsetpgrp(G_interactive_fd, pi->pgrp);
10347 /* Restart the processes in the job */
10348 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
10349 for (i = 0; i < pi->num_cmds; i++) {
10350 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
10352 pi->stopped_cmds = 0;
10354 i = kill(- pi->pgrp, SIGCONT);
10356 if (errno == ESRCH) {
10357 delete_finished_job(pi);
10358 return EXIT_SUCCESS;
10360 bb_perror_msg("kill (SIGCONT)");
10363 if (argv[0][0] == 'f') {
10364 remove_job_from_table(pi); /* FG job shouldn't be in job table */
10365 return checkjobs_and_fg_shell(pi);
10367 return EXIT_SUCCESS;
10371 #if ENABLE_HUSH_KILL
10372 static int FAST_FUNC builtin_kill(char **argv)
10376 # if ENABLE_HUSH_JOB
10377 if (argv[1] && strcmp(argv[1], "-l") != 0) {
10385 if (argv[i][0] != '%')
10388 * "kill %N" - job kill
10389 * Converting to pgrp / pid kill
10391 pi = parse_jobspec(argv[i]);
10393 /* Eat bad jobspec */
10397 argv[j - 1] = argv[j];
10404 * In jobs started under job control, we signal
10405 * entire process group by kill -PGRP_ID.
10406 * This happens, f.e., in interactive shell.
10408 * Otherwise, we signal each child via
10409 * kill PID1 PID2 PID3.
10411 * sh -c 'sleep 1|sleep 1 & kill %1'
10412 * sh -c 'true|sleep 2 & sleep 1; kill %1'
10413 * sh -c 'true|sleep 1 & sleep 2; kill %1'
10415 n = G_interactive_fd ? 1 : pi->num_cmds;
10416 dst = alloca(n * sizeof(int)*4);
10418 if (G_interactive_fd)
10419 dst += sprintf(dst, " -%u", (int)pi->pgrp);
10420 else for (j = 0; j < n; j++) {
10421 struct command *cmd = &pi->cmds[j];
10422 /* Skip exited members of the job */
10426 * kill_main has matching code to expect
10427 * leading space. Needed to not confuse
10428 * negative pids with "kill -SIGNAL_NO" syntax
10430 dst += sprintf(dst, " %u", (int)cmd->pid);
10433 } while (argv[++i]);
10437 if (argv[1] || ret == 0) {
10438 ret = run_applet_main(argv, kill_main);
10440 /* else: ret = 1, "kill %bad_jobspec" case */
10445 #if ENABLE_HUSH_WAIT
10446 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
10447 #if !ENABLE_HUSH_JOB
10448 # define wait_for_child_or_signal(pipe,pid) wait_for_child_or_signal(pid)
10450 static int wait_for_child_or_signal(struct pipe *waitfor_pipe, pid_t waitfor_pid)
10457 if (!sigisemptyset(&G.pending_set))
10460 /* waitpid is not interruptible by SA_RESTARTed
10461 * signals which we use. Thus, this ugly dance:
10464 /* Make sure possible SIGCHLD is stored in kernel's
10465 * pending signal mask before we call waitpid.
10466 * Or else we may race with SIGCHLD, lose it,
10467 * and get stuck in sigsuspend...
10469 sigfillset(&oldset); /* block all signals, remember old set */
10470 sigprocmask(SIG_SETMASK, &oldset, &oldset);
10472 if (!sigisemptyset(&G.pending_set)) {
10473 /* Crap! we raced with some signal! */
10477 /*errno = 0; - checkjobs does this */
10478 /* Can't pass waitfor_pipe into checkjobs(): it won't be interruptible */
10479 ret = checkjobs(NULL, waitfor_pid); /* waitpid(WNOHANG) inside */
10480 debug_printf_exec("checkjobs:%d\n", ret);
10481 #if ENABLE_HUSH_JOB
10482 if (waitfor_pipe) {
10483 int rcode = job_exited_or_stopped(waitfor_pipe);
10484 debug_printf_exec("job_exited_or_stopped:%d\n", rcode);
10487 sigprocmask(SIG_SETMASK, &oldset, NULL);
10492 /* if ECHILD, there are no children (ret is -1 or 0) */
10493 /* if ret == 0, no children changed state */
10494 /* if ret != 0, it's exitcode+1 of exited waitfor_pid child */
10495 if (errno == ECHILD || ret) {
10497 if (ret < 0) /* if ECHILD, may need to fix "ret" */
10499 sigprocmask(SIG_SETMASK, &oldset, NULL);
10502 /* Wait for SIGCHLD or any other signal */
10503 /* It is vitally important for sigsuspend that SIGCHLD has non-DFL handler! */
10504 /* Note: sigsuspend invokes signal handler */
10505 sigsuspend(&oldset);
10507 sigprocmask(SIG_SETMASK, &oldset, NULL);
10509 /* So, did we get a signal? */
10510 sig = check_and_run_traps();
10511 if (sig /*&& sig != SIGCHLD - always true */) {
10512 /* Do this for any (non-ignored) signal, not only for ^C */
10516 /* SIGCHLD, or no signal, or ignored one, such as SIGQUIT. Repeat */
10521 static int FAST_FUNC builtin_wait(char **argv)
10526 argv = skip_dash_dash(argv);
10527 if (argv[0] == NULL) {
10528 /* Don't care about wait results */
10529 /* Note 1: must wait until there are no more children */
10530 /* Note 2: must be interruptible */
10532 * $ sleep 3 & sleep 6 & wait
10533 * [1] 30934 sleep 3
10534 * [2] 30935 sleep 6
10537 * $ sleep 3 & sleep 6 & wait
10538 * [1] 30936 sleep 3
10539 * [2] 30937 sleep 6
10541 * ^C <-- after ~4 sec from keyboard
10544 return wait_for_child_or_signal(NULL, 0 /*(no job and no pid to wait for)*/);
10548 pid_t pid = bb_strtou(*argv, NULL, 10);
10549 if (errno || pid <= 0) {
10550 #if ENABLE_HUSH_JOB
10551 if (argv[0][0] == '%') {
10552 struct pipe *wait_pipe;
10553 ret = 127; /* bash compat for bad jobspecs */
10554 wait_pipe = parse_jobspec(*argv);
10556 ret = job_exited_or_stopped(wait_pipe);
10558 ret = wait_for_child_or_signal(wait_pipe, 0);
10560 /* waiting on "last dead job" removes it */
10561 clean_up_last_dead_job();
10564 /* else: parse_jobspec() already emitted error msg */
10568 /* mimic bash message */
10569 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
10570 ret = EXIT_FAILURE;
10571 continue; /* bash checks all argv[] */
10574 /* Do we have such child? */
10575 ret = waitpid(pid, &status, WNOHANG);
10579 if (errno == ECHILD) {
10580 if (pid == G.last_bg_pid) {
10581 /* "wait $!" but last bg task has already exited. Try:
10582 * (sleep 1; exit 3) & sleep 2; echo $?; wait $!; echo $?
10583 * In bash it prints exitcode 0, then 3.
10584 * In dash, it is 127.
10586 ret = G.last_bg_pid_exitcode;
10588 /* Example: "wait 1". mimic bash message */
10589 bb_error_msg("wait: pid %d is not a child of this shell", (int)pid);
10593 bb_perror_msg("wait %s", *argv);
10595 continue; /* bash checks all argv[] */
10598 /* Yes, and it still runs */
10599 ret = wait_for_child_or_signal(NULL, pid);
10601 /* Yes, and it just exited */
10602 process_wait_result(NULL, pid, status);
10603 ret = WEXITSTATUS(status);
10604 if (WIFSIGNALED(status))
10605 ret = 128 + WTERMSIG(status);
10613 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_FUNCTIONS
10614 static unsigned parse_numeric_argv1(char **argv, unsigned def, unsigned def_min)
10617 def = bb_strtou(argv[1], NULL, 10);
10618 if (errno || def < def_min || argv[2]) {
10619 bb_error_msg("%s: bad arguments", argv[0]);
10627 #if ENABLE_HUSH_LOOPS
10628 static int FAST_FUNC builtin_break(char **argv)
10631 if (G.depth_of_loop == 0) {
10632 bb_error_msg("%s: only meaningful in a loop", argv[0]);
10633 /* if we came from builtin_continue(), need to undo "= 1" */
10634 G.flag_break_continue = 0;
10635 return EXIT_SUCCESS; /* bash compat */
10637 G.flag_break_continue++; /* BC_BREAK = 1, or BC_CONTINUE = 2 */
10639 G.depth_break_continue = depth = parse_numeric_argv1(argv, 1, 1);
10640 if (depth == UINT_MAX)
10641 G.flag_break_continue = BC_BREAK;
10642 if (G.depth_of_loop < depth)
10643 G.depth_break_continue = G.depth_of_loop;
10645 return EXIT_SUCCESS;
10648 static int FAST_FUNC builtin_continue(char **argv)
10650 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
10651 return builtin_break(argv);
10655 #if ENABLE_HUSH_FUNCTIONS
10656 static int FAST_FUNC builtin_return(char **argv)
10660 if (G_flag_return_in_progress != -1) {
10661 bb_error_msg("%s: not in a function or sourced script", argv[0]);
10662 return EXIT_FAILURE; /* bash compat */
10665 G_flag_return_in_progress = 1;
10668 * out of range: wraps around at 256, does not error out
10669 * non-numeric param:
10670 * f() { false; return qwe; }; f; echo $?
10671 * bash: return: qwe: numeric argument required <== we do this
10672 * 255 <== we also do this
10674 rc = parse_numeric_argv1(argv, G.last_exitcode, 0);
10679 #if ENABLE_HUSH_TIMES
10680 static int FAST_FUNC builtin_times(char **argv UNUSED_PARAM)
10682 static const uint8_t times_tbl[] ALIGN1 = {
10683 ' ', offsetof(struct tms, tms_utime),
10684 '\n', offsetof(struct tms, tms_stime),
10685 ' ', offsetof(struct tms, tms_cutime),
10686 '\n', offsetof(struct tms, tms_cstime),
10693 clk_tck = bb_clk_tck();
10698 unsigned sec, frac;
10700 t = *(clock_t *)(((char *) &buf) + p[1]);
10702 frac = t % clk_tck;
10703 printf("%um%u.%03us%c",
10704 sec / 60, sec % 60,
10705 (frac * 1000) / clk_tck,
10710 return EXIT_SUCCESS;
10714 #if ENABLE_HUSH_MEMLEAK
10715 static int FAST_FUNC builtin_memleak(char **argv UNUSED_PARAM)
10720 # ifdef M_TRIM_THRESHOLD
10721 /* Optional. Reduces probability of false positives */
10724 /* Crude attempt to find where "free memory" starts,
10725 * sans fragmentation. */
10727 l = (unsigned long)p;
10730 if (l < (unsigned long)p) l = (unsigned long)p;
10736 struct mallinfo mi = mallinfo();
10737 printf("top alloc:0x%lx malloced:%d+%d=%d\n", l,
10738 mi.arena, mi.hblkhd, mi.arena + mi.hblkhd);
10742 if (!G.memleak_value)
10743 G.memleak_value = l;
10745 l -= G.memleak_value;
10752 /* Exitcode is "how many kilobytes we leaked since 1st call" */