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>
11 * The parser routines proper are all original material, first
12 * written Dec 2000 and Jan 2001 by Larry Doolittle. The
13 * execution engine, the builtins, and much of the underlying
14 * support has been adapted from busybox-0.49pre's lash, which is
15 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
16 * written by Erik Andersen <andersen@codepoet.org>. That, in turn,
17 * is based in part on ladsh.c, by Michael K. Johnson and Erik W.
18 * Troan, which they placed in the public domain. I don't know
19 * how much of the Johnson/Troan code has survived the repeated
23 * o_addchr() derived from similar w_addchar function in glibc-2.2.
24 * setup_redirect(), redirect_opt_num(), and big chunks of main()
25 * and many builtins derived from contributions by Erik Andersen.
26 * Miscellaneous bugfixes from Matt Kraai.
28 * There are two big (and related) architecture differences between
29 * this parser and the lash parser. One is that this version is
30 * actually designed from the ground up to understand nearly all
31 * of the Bourne grammar. The second, consequential change is that
32 * the parser and input reader have been turned inside out. Now,
33 * the parser is in control, and asks for input as needed. The old
34 * way had the input reader in control, and it asked for parsing to
35 * take place as needed. The new way makes it much easier to properly
36 * handle the recursion implicit in the various substitutions, especially
37 * across continuation lines.
39 * POSIX syntax not implemented:
41 * <(list) and >(list) Process Substitution
42 * Here Documents ( << word )
45 * Parameter Expansion for substring processing ${var#word} ${var%word}
47 * Bash stuff maybe optional enable:
48 * &> and >& redirection of stdout+stderr
50 * reserved words: [[ ]] function select
51 * substrings ${var:1:5}
54 * job handling woefully incomplete and buggy (improved --vda)
56 * port selected bugfixes from post-0.49 busybox lash - done?
57 * change { and } from special chars to reserved words
58 * builtins: return, trap, ulimit
59 * test magic exec with redirection only
60 * follow IFS rules more precisely, including update semantics
61 * figure out what to do with backslash-newline
62 * propagate syntax errors, die on resource errors?
63 * continuation lines, both explicit and implicit - done?
65 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
68 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
69 //TODO: pull in some .h and find out whether we have SINGLE_APPLET_MAIN?
70 //#include "applet_tables.h" doesn't work
72 /* #include <dmalloc.h> */
78 #ifdef WANT_TO_TEST_NOMMU
83 # define USE_FOR_NOMMU(...) __VA_ARGS__
84 # define USE_FOR_MMU(...)
87 #define HUSH_VER_STR "0.93"
89 #if defined SINGLE_APPLET_MAIN
90 /* STANDALONE does not make sense, and won't compile */
91 #undef CONFIG_FEATURE_SH_STANDALONE
92 #undef ENABLE_FEATURE_SH_STANDALONE
93 #undef USE_FEATURE_SH_STANDALONE
94 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
95 #define ENABLE_FEATURE_SH_STANDALONE 0
96 #define USE_FEATURE_SH_STANDALONE(...)
97 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
100 #if !ENABLE_HUSH_INTERACTIVE
101 #undef ENABLE_FEATURE_EDITING
102 #define ENABLE_FEATURE_EDITING 0
103 #undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
104 #define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
107 /* Do we support ANY keywords? */
108 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
109 #define HAS_KEYWORDS 1
110 #define IF_HAS_KEYWORDS(...) __VA_ARGS__
111 #define IF_HAS_NO_KEYWORDS(...)
113 #define HAS_KEYWORDS 0
114 #define IF_HAS_KEYWORDS(...)
115 #define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
118 /* Keep unconditionally on for now */
121 #define ENABLE_HUSH_FUNCTIONS 0
124 /* If you comment out one of these below, it will be #defined later
125 * to perform debug printfs to stderr: */
126 #define debug_printf(...) do {} while (0)
127 /* Finer-grained debug switches */
128 #define debug_printf_parse(...) do {} while (0)
129 #define debug_print_tree(a, b) do {} while (0)
130 #define debug_printf_exec(...) do {} while (0)
131 #define debug_printf_env(...) do {} while (0)
132 #define debug_printf_jobs(...) do {} while (0)
133 #define debug_printf_expand(...) do {} while (0)
134 #define debug_printf_glob(...) do {} while (0)
135 #define debug_printf_list(...) do {} while (0)
136 #define debug_printf_subst(...) do {} while (0)
137 #define debug_printf_clean(...) do {} while (0)
140 #define debug_printf(...) fprintf(stderr, __VA_ARGS__)
143 #ifndef debug_printf_parse
144 #define debug_printf_parse(...) fprintf(stderr, __VA_ARGS__)
147 #ifndef debug_printf_exec
148 #define debug_printf_exec(...) fprintf(stderr, __VA_ARGS__)
151 #ifndef debug_printf_env
152 #define debug_printf_env(...) fprintf(stderr, __VA_ARGS__)
155 #ifndef debug_printf_jobs
156 #define debug_printf_jobs(...) fprintf(stderr, __VA_ARGS__)
162 #ifndef debug_printf_expand
163 #define debug_printf_expand(...) fprintf(stderr, __VA_ARGS__)
164 #define DEBUG_EXPAND 1
166 #define DEBUG_EXPAND 0
169 #ifndef debug_printf_glob
170 #define debug_printf_glob(...) fprintf(stderr, __VA_ARGS__)
176 #ifndef debug_printf_list
177 #define debug_printf_list(...) fprintf(stderr, __VA_ARGS__)
180 #ifndef debug_printf_subst
181 #define debug_printf_subst(...) fprintf(stderr, __VA_ARGS__)
184 #ifndef debug_printf_clean
185 /* broken, of course, but OK for testing */
186 static const char *indenter(int i)
188 static const char blanks[] ALIGN1 =
190 return &blanks[sizeof(blanks) - i - 1];
192 #define debug_printf_clean(...) fprintf(stderr, __VA_ARGS__)
193 #define DEBUG_CLEAN 1
197 static void debug_print_strings(const char *prefix, char **vv)
199 fprintf(stderr, "%s:\n", prefix);
201 fprintf(stderr, " '%s'\n", *vv++);
204 #define debug_print_strings(prefix, vv) ((void)0)
208 * Leak hunting. Use hush_leaktool.sh for post-processing.
210 #ifdef FOR_HUSH_LEAKTOOL
211 static void *xxmalloc(int lineno, size_t size)
213 void *ptr = xmalloc((size + 0xff) & ~0xff);
214 fdprintf(2, "line %d: malloc %p\n", lineno, ptr);
217 static void *xxrealloc(int lineno, void *ptr, size_t size)
219 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
220 fdprintf(2, "line %d: realloc %p\n", lineno, ptr);
223 static char *xxstrdup(int lineno, const char *str)
225 char *ptr = xstrdup(str);
226 fdprintf(2, "line %d: strdup %p\n", lineno, ptr);
229 static void xxfree(void *ptr)
231 fdprintf(2, "free %p\n", ptr);
234 #define xmalloc(s) xxmalloc(__LINE__, s)
235 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
236 #define xstrdup(s) xxstrdup(__LINE__, s)
237 #define free(p) xxfree(p)
241 #define ERR_PTR ((void*)(long)1)
243 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="HUSH_VER_STR;
245 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
247 #define SPECIAL_VAR_SYMBOL 3
249 typedef enum redir_type {
251 REDIRECT_OVERWRITE = 2,
257 /* The descrip member of this structure is only used to make
258 * debugging output pretty */
259 static const struct {
261 signed char default_fd;
265 { O_RDONLY, 0, "<" },
266 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
267 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
268 { O_RDONLY, -1, "<<" },
272 typedef enum pipe_style {
279 typedef enum reserved_style {
288 #if ENABLE_HUSH_LOOPS
295 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
300 /* two pseudo-keywords support contrived "case" syntax: */
301 RES_MATCH , /* "word)" */
302 RES_CASEI , /* "this command is inside CASE" */
309 typedef struct o_string {
311 int length; /* position where data is appended */
313 /* Protect newly added chars against globbing
314 * (by prepending \ to *, ?, [, \) */
318 smallint has_empty_slot;
319 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
322 MAYBE_ASSIGNMENT = 0,
323 DEFINITELY_ASSIGNMENT = 1,
325 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
327 /* Used for initialization: o_string foo = NULL_O_STRING; */
328 #define NULL_O_STRING { NULL }
330 /* I can almost use ordinary FILE*. Is open_memstream() universally
331 * available? Where is it documented? */
332 typedef struct in_str {
334 /* eof_flag=1: last char in ->p is really an EOF */
335 char eof_flag; /* meaningless if ->p == NULL */
337 #if ENABLE_HUSH_INTERACTIVE
339 smallint promptmode; /* 0: PS1, 1: PS2 */
342 int (*get) (struct in_str *);
343 int (*peek) (struct in_str *);
345 #define i_getch(input) ((input)->get(input))
346 #define i_peek(input) ((input)->peek(input))
348 struct redir_struct {
349 struct redir_struct *next;
350 char *rd_filename; /* filename */
351 int fd; /* file descriptor being redirected */
352 int dup; /* -1, or file descriptor being duplicated */
353 smallint /*enum redir_type*/ rd_type;
357 pid_t pid; /* 0 if exited */
358 int assignment_cnt; /* how many argv[i] are assignments? */
359 smallint is_stopped; /* is the command currently running? */
360 smallint grp_type; /* GRP_xxx */
361 struct pipe *group; /* if non-NULL, this "command" is { list },
362 * ( list ), or a compound statement */
364 char *group_as_string;
366 char **argv; /* command name and arguments */
367 struct redir_struct *redirects; /* I/O redirections */
369 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
370 * and on execution these are substituted with their values.
371 * Substitution can make _several_ words out of one argv[n]!
372 * Example: argv[0]=='.^C*^C.' here: echo .$*.
373 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
376 #define GRP_SUBSHELL 1
377 #if ENABLE_HUSH_FUNCTIONS
378 #define GRP_FUNCTION 2
383 int num_cmds; /* total number of commands in job */
384 int alive_cmds; /* number of commands running (not exited) */
385 int stopped_cmds; /* number of commands alive, but stopped */
387 int jobid; /* job number */
388 pid_t pgrp; /* process group ID for the job */
389 char *cmdtext; /* name of job */
391 struct command *cmds; /* array of commands in pipe */
392 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
393 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
394 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
397 /* This holds pointers to the various results of parsing */
398 struct parse_context {
399 /* linked list of pipes */
400 struct pipe *list_head;
401 /* last pipe (being constructed right now) */
403 /* last command in pipe (being constructed right now) */
404 struct command *command;
405 /* last redirect in command->redirects list */
406 struct redir_struct *pending_redirect;
412 smallint ctx_inverted; /* "! cmd | cmd" */
414 smallint ctx_dsemicolon; /* ";;" seen */
416 /* bitmask of FLAG_xxx, for figuring out valid reserved words */
418 /* group we are enclosed in:
419 * example: "if pipe1; pipe2; then pipe3; fi"
420 * when we see "if" or "then", we malloc and copy current context,
421 * and make ->stack point to it. then we parse pipeN.
422 * when closing "then" / fi" / whatever is found,
423 * we move list_head into ->stack->command->group,
424 * copy ->stack into current context, and delete ->stack.
425 * (parsing of { list } and ( list ) doesn't use this method)
427 struct parse_context *stack;
431 /* On program start, environ points to initial environment.
432 * putenv adds new pointers into it, unsetenv removes them.
433 * Neither of these (de)allocates the strings.
434 * setenv allocates new strings in malloc space and does putenv,
435 * and thus setenv is unusable (leaky) for shell's purposes */
436 #define setenv(...) setenv_is_leaky_dont_use()
438 struct variable *next;
439 char *varstr; /* points to "name=" portion */
440 int max_len; /* if > 0, name is part of initial env; else name is malloced */
441 smallint flg_export; /* putenv should be done on this var */
442 smallint flg_read_only;
451 /* "Globals" within this file */
452 /* Sorted roughly by size (smaller offsets == smaller code) */
454 #if ENABLE_HUSH_INTERACTIVE
455 /* 'interactive_fd' is a fd# open to ctty, if we have one
456 * _AND_ if we decided to act interactively */
460 #define G_interactive_fd (G.interactive_fd)
462 #define G_interactive_fd 0
464 #if ENABLE_FEATURE_EDITING
465 line_input_t *line_input_state;
471 pid_t saved_tty_pgrp;
473 struct pipe *job_list;
474 struct pipe *toplevel_list;
475 //// smallint ctrl_z_flag;
477 smallint flag_SIGINT;
478 #if ENABLE_HUSH_LOOPS
479 smallint flag_break_continue;
482 /* These four support $?, $#, and $1 */
483 smalluint last_return_code;
484 /* are global_argv and global_argv[1..n] malloced? (note: not [0]) */
485 smalluint global_args_malloced;
486 /* how many non-NULL argv's we have. NB: $# + 1 */
490 char *argv0_for_re_execing;
491 char **argv_from_re_execing;
493 #if ENABLE_HUSH_LOOPS
494 unsigned depth_break_continue;
495 unsigned depth_of_loop;
499 struct variable *top_var; /* = &G.shell_ver (set in main()) */
500 struct variable shell_ver;
501 /* Signal and trap handling */
502 // unsigned count_SIGCHLD;
503 // unsigned handled_SIGCHLD;
504 /* which signals have non-DFL handler (even with no traps set)? */
505 unsigned non_DFL_mask;
506 char **traps; /* char *traps[NSIG] */
507 sigset_t blocked_set;
508 sigset_t inherited_set;
509 char user_input_buf[ENABLE_FEATURE_EDITING ? BUFSIZ : 2];
510 #if ENABLE_FEATURE_SH_STANDALONE
511 struct nofork_save_area nofork_save;
514 sigjmp_buf toplevel_jb;
517 #define G (*ptr_to_globals)
518 /* Not #defining name to G.name - this quickly gets unwieldy
519 * (too many defines). Also, I actually prefer to see when a variable
520 * is global, thus "G." prefix is a useful hint */
521 #define INIT_G() do { \
522 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
526 /* Function prototypes for builtins */
527 static int builtin_cd(char **argv);
528 static int builtin_echo(char **argv);
529 static int builtin_eval(char **argv);
530 static int builtin_exec(char **argv);
531 static int builtin_exit(char **argv);
532 static int builtin_export(char **argv);
534 static int builtin_fg_bg(char **argv);
535 static int builtin_jobs(char **argv);
538 static int builtin_help(char **argv);
540 static int builtin_pwd(char **argv);
541 static int builtin_read(char **argv);
542 static int builtin_test(char **argv);
543 static int builtin_trap(char **argv);
544 static int builtin_true(char **argv);
545 static int builtin_set(char **argv);
546 static int builtin_shift(char **argv);
547 static int builtin_source(char **argv);
548 static int builtin_umask(char **argv);
549 static int builtin_unset(char **argv);
550 static int builtin_wait(char **argv);
551 #if ENABLE_HUSH_LOOPS
552 static int builtin_break(char **argv);
553 static int builtin_continue(char **argv);
556 /* Table of built-in functions. They can be forked or not, depending on
557 * context: within pipes, they fork. As simple commands, they do not.
558 * When used in non-forking context, they can change global variables
559 * in the parent shell process. If forked, of course they cannot.
560 * For example, 'unset foo | whatever' will parse and run, but foo will
561 * still be set at the end. */
562 struct built_in_command {
564 int (*function)(char **argv);
567 #define BLTIN(cmd, func, help) { cmd, func, help }
569 #define BLTIN(cmd, func, help) { cmd, func }
573 /* For now, echo and test are unconditionally enabled.
574 * Maybe make it configurable? */
575 static const struct built_in_command bltins[] = {
576 BLTIN("." , builtin_source , "Run commands in a file"),
577 BLTIN(":" , builtin_true , "No-op"),
578 BLTIN("[" , builtin_test , "Test condition"),
580 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
582 #if ENABLE_HUSH_LOOPS
583 BLTIN("break" , builtin_break , "Exit from a loop"),
585 BLTIN("cd" , builtin_cd , "Change directory"),
586 #if ENABLE_HUSH_LOOPS
587 BLTIN("continue", builtin_continue, "Start new loop iteration"),
589 BLTIN("echo" , builtin_echo , "Write to stdout"),
590 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
591 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
592 BLTIN("exit" , builtin_exit , "Exit"),
593 BLTIN("export" , builtin_export , "Set environment variable"),
595 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
598 BLTIN("help" , builtin_help , "List shell built-in commands"),
601 BLTIN("jobs" , builtin_jobs , "List active jobs"),
603 BLTIN("pwd" , builtin_pwd , "Print current directory"),
604 BLTIN("read" , builtin_read , "Input environment variable"),
605 // BLTIN("return" , builtin_return , "Return from a function"),
606 BLTIN("set" , builtin_set , "Set/unset shell local variables"),
607 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
608 BLTIN("test" , builtin_test , "Test condition"),
609 BLTIN("trap" , builtin_trap , "Trap signals"),
610 // BLTIN("ulimit" , builtin_return , "Control resource limits"),
611 BLTIN("umask" , builtin_umask , "Set file creation mask"),
612 BLTIN("unset" , builtin_unset , "Unset environment variable"),
613 BLTIN("wait" , builtin_wait , "Wait for process"),
617 static void maybe_die(const char *notice, const char *msg)
619 /* Was using fancy stuff:
620 * (G_interactive_fd ? bb_error_msg : bb_error_msg_and_die)(...params...)
621 * but it SEGVs. ?! Oh well... explicit temp ptr works around that */
622 void FAST_FUNC (*fp)(const char *s, ...) = bb_error_msg_and_die;
623 #if ENABLE_HUSH_INTERACTIVE
624 if (G_interactive_fd)
627 fp(msg ? "%s: %s" : notice, notice, msg);
630 #define syntax(msg) maybe_die("syntax error", msg);
632 /* Debug -- trick gcc to expand __LINE__ and convert to string */
633 #define __syntax(msg, line) maybe_die("syntax error hush.c:" # line, msg)
634 #define _syntax(msg, line) __syntax(msg, line)
635 #define syntax(msg) _syntax(msg, __LINE__)
639 static int glob_needed(const char *s)
644 if (*s == '*' || *s == '[' || *s == '?')
651 static int is_assignment(const char *s)
653 if (!s || !(isalpha(*s) || *s == '_'))
656 while (isalnum(*s) || *s == '_')
661 /* Replace each \x with x in place, return ptr past NUL. */
662 static char *unbackslash(char *src)
668 if ((*dst++ = *src++) == '\0')
674 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
695 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
696 v[count1 + count2] = NULL;
699 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
703 static char **add_string_to_strings(char **strings, char *add)
708 return add_strings_to_strings(strings, v, /*dup:*/ 0);
711 static void putenv_all(char **strings)
716 debug_printf_env("putenv '%s'\n", *strings);
721 static char **putenv_all_and_save_old(char **strings)
731 eq = strchr(*strings, '=');
734 v = getenv(*strings);
737 /* v points to VAL in VAR=VAL, go back to VAR */
738 v -= (eq - *strings) + 1;
739 old = add_string_to_strings(old, v);
748 static void free_strings_and_unsetenv(char **strings, int unset)
758 debug_printf_env("unsetenv '%s'\n", *v);
766 static void free_strings(char **strings)
768 free_strings_and_unsetenv(strings, 0);
772 /* Basic theory of signal handling in shell
773 * ========================================
774 * This does not describe what hush does, rather, it is current understanding
775 * what it _should_ do. If it doesn't, it's a bug.
776 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
778 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
779 * is finished or backgrounded. It is the same in interactive and
780 * non-interactive shells, and is the same regardless of whether
781 * a user trap handler is installed or a shell special one is in effect.
782 * ^C or ^Z from keyboard seem to execute "at once" because it usually
783 * backgrounds (i.e. stops) or kills all members of currently running
786 * Wait builtin in interruptible by signals for which user trap is set
787 * or by SIGINT in interactive shell.
789 * Trap handlers will execute even within trap handlers. (right?)
791 * User trap handlers are forgotten when subshell ("(cmd)") is entered. [TODO]
793 * If job control is off, backgrounded commands ("cmd &")
794 * have SIGINT, SIGQUIT set to SIG_IGN.
796 * Commands run in command substitution ("`cmd`")
797 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
799 * Ordinary commands have signals set to SIG_IGN/DFL set as inherited
800 * by the shell from its parent.
802 * Siganls which differ from SIG_DFL action
803 * (note: child (i.e., [v]forked) shell is not an interactive shell):
806 * SIGTERM (interactive): ignore
807 * SIGHUP (interactive):
808 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
809 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
810 * (note that ^Z is handled not by trapping SIGTSTP, but by seeing
811 * that all pipe members are stopped) (right?)
812 * SIGINT (interactive): wait for last pipe, ignore the rest
813 * of the command line, show prompt. NB: ^C does not send SIGINT
814 * to interactive shell while shell is waiting for a pipe,
815 * since shell is bg'ed (is not in foreground process group).
816 * (check/expand this)
817 * Example 1: this waits 5 sec, but does not execute ls:
818 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
819 * Example 2: this does not wait and does not execute ls:
820 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
821 * Example 3: this does not wait 5 sec, but executes ls:
822 * "sleep 5; ls -l" + press ^C
824 * (What happens to signals which are IGN on shell start?)
825 * (What happens with signal mask on shell start?)
827 * Implementation in hush
828 * ======================
829 * We use in-kernel pending signal mask to determine which signals were sent.
830 * We block all signals which we don't want to take action immediately,
831 * i.e. we block all signals which need to have special handling as described
832 * above, and all signals which have traps set.
833 * After each pipe execution, we extract any pending signals via sigtimedwait()
836 * unsigned non_DFL_mask: a mask of such "special" signals
837 * sigset_t blocked_set: current blocked signal set
840 * clear bit in blocked_set unless it is also in non_DFL_mask
841 * "trap 'cmd' SIGxxx":
842 * set bit in blocked_set (even if 'cmd' is '')
843 * after [v]fork, if we plan to be a shell:
844 * nothing for {} child shell (say, "true | { true; true; } | true")
845 * unset all traps if () shell. [TODO]
846 * after [v]fork, if we plan to exec:
847 * POSIX says pending signal mask is cleared in child - no need to clear it.
848 * Restore blocked signal set to one inherited by shell just prior to exec.
850 * Note: as a result, we do not use signal handlers much. The only uses
851 * are to count SIGCHLDs [disabled - bug somewhere, + bloat]
852 * and to restore tty pgrp on signal-induced exit.
854 * TODO: check/fix wait builtin to be interruptible.
857 //static void SIGCHLD_handler(int sig UNUSED_PARAM)
859 // G.count_SIGCHLD++;
862 /* called once at shell init */
863 static void init_signal_mask(void)
866 unsigned mask = (1 << SIGQUIT);
867 if (G_interactive_fd) {
873 | (1 << SIGTTIN) | (1 << SIGTTOU) | (1 << SIGTSTP)
878 G.non_DFL_mask = mask;
880 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
884 sigaddset(&G.blocked_set, sig);
888 sigdelset(&G.blocked_set, SIGCHLD);
889 sigprocmask(SIG_SETMASK, &G.blocked_set, &G.inherited_set);
892 static int check_and_run_traps(int sig)
894 static const struct timespec zero_timespec = { 0, 0 };
895 smalluint save_rcode;
901 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
906 if (G.traps && G.traps[sig]) {
907 if (G.traps[sig][0]) {
908 /* We have user-defined handler */
909 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
910 save_rcode = G.last_return_code;
913 G.last_return_code = save_rcode;
914 } /* else: "" trap, ignoring signal */
917 /* not a trap: special action */
920 // G.count_SIGCHLD++;
929 default: /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
938 /* Restores tty foreground process group, and exits.
939 * May be called as signal handler for fatal signal
940 * (will faithfully resend signal to itself, producing correct exit state)
941 * or called directly with -EXITCODE.
942 * We also call it if xfunc is exiting. */
943 static void sigexit(int sig) NORETURN;
944 static void sigexit(int sig)
946 /* Disable all signals: job control, SIGPIPE, etc. */
947 sigprocmask_allsigs(SIG_BLOCK);
949 /* Careful: we can end up here after [v]fork. Do not restore
950 * tty pgrp then, only top-level shell process does that */
951 if (G_interactive_fd && getpid() == G.root_pid)
952 tcsetpgrp(G_interactive_fd, G.saved_tty_pgrp);
954 /* Not a signal, just exit */
958 kill_myself_with_sig(sig); /* does not return */
962 static void maybe_set_sighandler(int sig)
964 void (*handler)(int);
965 /* non_DFL_mask'ed signals are, well, masked,
966 * no need to set handler for them.
968 if (!((G.non_DFL_mask >> sig) & 1)) {
969 handler = signal(sig, sigexit);
970 if (handler == SIG_IGN) /* oops... restore back to IGN! */
971 signal(sig, handler);
974 /* Used only to set handler to restore pgrp on exit */
975 static void set_fatal_signals_to_sigexit(void)
978 maybe_set_sighandler(SIGILL );
979 maybe_set_sighandler(SIGFPE );
980 maybe_set_sighandler(SIGBUS );
981 maybe_set_sighandler(SIGSEGV);
982 maybe_set_sighandler(SIGTRAP);
983 } /* else: hush is perfect. what SEGV? */
985 maybe_set_sighandler(SIGABRT);
987 /* bash 3.2 seems to handle these just like 'fatal' ones */
988 maybe_set_sighandler(SIGPIPE);
989 maybe_set_sighandler(SIGALRM);
990 maybe_set_sighandler(SIGHUP );
992 /* if we aren't interactive... but in this case
993 * we never want to restore pgrp on exit, and this fn is not called */
994 /*maybe_set_sighandler(SIGTERM);*/
995 /*maybe_set_sighandler(SIGINT );*/
1000 #define set_fatal_signals_to_sigexit(handler) ((void)0)
1004 /* Restores tty foreground process group, and exits. */
1005 static void hush_exit(int exitcode) NORETURN;
1006 static void hush_exit(int exitcode)
1008 if (G.traps && G.traps[0] && G.traps[0][0]) {
1009 char *argv[] = { NULL, xstrdup(G.traps[0]), NULL };
1015 fflush(NULL); /* flush all streams */
1016 sigexit(- (exitcode & 0xff));
1023 static const char *set_cwd(void)
1025 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1026 * we must not try to free(bb_msg_unknown) */
1027 if (G.cwd == bb_msg_unknown)
1029 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1031 G.cwd = bb_msg_unknown;
1036 /* Get/check local shell variables */
1037 static struct variable *get_local_var(const char *name)
1039 struct variable *cur;
1045 for (cur = G.top_var; cur; cur = cur->next) {
1046 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1052 static const char *get_local_var_value(const char *src)
1054 struct variable *var = get_local_var(src);
1056 return strchr(var->varstr, '=') + 1;
1060 /* str holds "NAME=VAL" and is expected to be malloced.
1061 * We take ownership of it.
1065 * -1: if NAME is set, leave export status alone
1066 * if NAME is not set, do not export
1067 * flg_read_only is set only when we handle -R var=val
1070 #define set_local_var(str, flg_export, flg_read_only) \
1071 set_local_var(str, flg_export)
1073 static int set_local_var(char *str, int flg_export, int flg_read_only)
1075 struct variable *cur;
1079 value = strchr(str, '=');
1080 if (!value) { /* not expected to ever happen? */
1085 name_len = value - str + 1; /* including '=' */
1086 cur = G.top_var; /* cannot be NULL (we have HUSH_VERSION and it's RO) */
1088 if (strncmp(cur->varstr, str, name_len) != 0) {
1090 /* Bail out. Note that now cur points
1091 * to last var in linked list */
1097 /* We found an existing var with this name */
1099 if (cur->flg_read_only) {
1103 bb_error_msg("%s: readonly variable", str);
1107 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1108 unsetenv(str); /* just in case */
1110 if (strcmp(cur->varstr, str) == 0) {
1115 if (cur->max_len >= strlen(str)) {
1116 /* This one is from startup env, reuse space */
1117 strcpy(cur->varstr, str);
1120 /* max_len == 0 signifies "malloced" var, which we can
1121 * (and has to) free */
1125 goto set_str_and_exp;
1128 /* Not found - create next variable struct */
1129 cur->next = xzalloc(sizeof(*cur));
1135 cur->flg_read_only = flg_read_only;
1138 if (flg_export == 1)
1139 cur->flg_export = 1;
1140 if (cur->flg_export) {
1141 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1142 return putenv(cur->varstr);
1147 static int unset_local_var(const char *name)
1149 struct variable *cur;
1150 struct variable *prev = prev; /* for gcc */
1154 return EXIT_SUCCESS;
1155 name_len = strlen(name);
1158 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1159 if (cur->flg_read_only) {
1160 bb_error_msg("%s: readonly variable", name);
1161 return EXIT_FAILURE;
1163 /* prev is ok to use here because 1st variable, HUSH_VERSION,
1164 * is ro, and we cannot reach this code on the 1st pass */
1165 prev->next = cur->next;
1166 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1167 bb_unsetenv(cur->varstr);
1171 return EXIT_SUCCESS;
1176 return EXIT_SUCCESS;
1179 #if ENABLE_SH_MATH_SUPPORT
1180 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1181 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1182 static char *endofname(const char *name)
1190 if (!is_in_name(*p))
1196 static void arith_set_local_var(const char *name, const char *val, int flags)
1198 /* arith code doesnt malloc space, so do it for it */
1199 char *var = xasprintf("%s=%s", name, val);
1200 set_local_var(var, flags, 0);
1208 static int static_get(struct in_str *i)
1217 static int static_peek(struct in_str *i)
1222 #if ENABLE_HUSH_INTERACTIVE
1224 static void cmdedit_set_initial_prompt(void)
1226 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1227 G.PS1 = getenv("PS1");
1234 static const char* setup_prompt_string(int promptmode)
1236 const char *prompt_str;
1237 debug_printf("setup_prompt_string %d ", promptmode);
1238 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1239 /* Set up the prompt */
1240 if (promptmode == 0) { /* PS1 */
1242 G.PS1 = xasprintf("%s %c ", G.cwd, (geteuid() != 0) ? '$' : '#');
1247 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1248 debug_printf("result '%s'\n", prompt_str);
1252 static void get_user_input(struct in_str *i)
1255 const char *prompt_str;
1257 prompt_str = setup_prompt_string(i->promptmode);
1258 #if ENABLE_FEATURE_EDITING
1259 /* Enable command line editing only while a command line
1260 * is actually being read */
1263 /* buglet: SIGINT will not make new prompt to appear _at once_,
1264 * only after <Enter>. (^C will work) */
1265 r = read_line_input(prompt_str, G.user_input_buf, BUFSIZ-1, G.line_input_state);
1266 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1267 check_and_run_traps(0);
1268 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1269 i->eof_flag = (r < 0);
1270 if (i->eof_flag) { /* EOF/error detected */
1271 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1272 G.user_input_buf[1] = '\0';
1277 fputs(prompt_str, stdout);
1279 G.user_input_buf[0] = r = fgetc(i->file);
1280 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1281 //do we need check_and_run_traps(0)? (maybe only if stdin)
1282 } while (G.flag_SIGINT);
1283 i->eof_flag = (r == EOF);
1285 i->p = G.user_input_buf;
1288 #endif /* INTERACTIVE */
1290 /* This is the magic location that prints prompts
1291 * and gets data back from the user */
1292 static int file_get(struct in_str *i)
1296 /* If there is data waiting, eat it up */
1297 if (i->p && *i->p) {
1298 #if ENABLE_HUSH_INTERACTIVE
1302 if (i->eof_flag && !*i->p)
1305 /* need to double check i->file because we might be doing something
1306 * more complicated by now, like sourcing or substituting. */
1307 #if ENABLE_HUSH_INTERACTIVE
1308 if (G_interactive_fd && i->promptme && i->file == stdin) {
1311 } while (!*i->p); /* need non-empty line */
1312 i->promptmode = 1; /* PS2 */
1317 ch = fgetc(i->file);
1319 debug_printf("file_get: got a '%c' %d\n", ch, ch);
1320 #if ENABLE_HUSH_INTERACTIVE
1327 /* All the callers guarantee this routine will never be
1328 * used right after a newline, so prompting is not needed.
1330 static int file_peek(struct in_str *i)
1333 if (i->p && *i->p) {
1334 if (i->eof_flag && !i->p[1])
1338 ch = fgetc(i->file);
1339 i->eof_flag = (ch == EOF);
1340 i->peek_buf[0] = ch;
1341 i->peek_buf[1] = '\0';
1343 debug_printf("file_peek: got a '%c' %d\n", *i->p, *i->p);
1347 static void setup_file_in_str(struct in_str *i, FILE *f)
1349 i->peek = file_peek;
1351 #if ENABLE_HUSH_INTERACTIVE
1353 i->promptmode = 0; /* PS1 */
1359 static void setup_string_in_str(struct in_str *i, const char *s)
1361 i->peek = static_peek;
1362 i->get = static_get;
1363 #if ENABLE_HUSH_INTERACTIVE
1365 i->promptmode = 0; /* PS1 */
1375 #define B_CHUNK (32 * sizeof(char*))
1377 static void o_reset(o_string *o)
1385 static void o_free(o_string *o)
1388 memset(o, 0, sizeof(*o));
1391 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1396 static void o_grow_by(o_string *o, int len)
1398 if (o->length + len > o->maxlen) {
1399 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1400 o->data = xrealloc(o->data, 1 + o->maxlen);
1404 static void o_addchr(o_string *o, int ch)
1406 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1408 o->data[o->length] = ch;
1410 o->data[o->length] = '\0';
1413 static void o_addblock(o_string *o, const char *str, int len)
1416 memcpy(&o->data[o->length], str, len);
1418 o->data[o->length] = '\0';
1422 static void o_addstr(o_string *o, const char *str)
1424 o_addblock(o, str, strlen(str));
1428 static void o_addstr_with_NUL(o_string *o, const char *str)
1430 o_addblock(o, str, strlen(str) + 1);
1433 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
1438 && (*str != '*' && *str != '?' && *str != '[')
1446 /* My analysis of quoting semantics tells me that state information
1447 * is associated with a destination, not a source.
1449 static void o_addqchr(o_string *o, int ch)
1452 char *found = strchr("*?[\\", ch);
1457 o->data[o->length] = '\\';
1460 o->data[o->length] = ch;
1462 o->data[o->length] = '\0';
1465 static void o_addQchr(o_string *o, int ch)
1468 if (o->o_escape && strchr("*?[\\", ch)) {
1470 o->data[o->length] = '\\';
1474 o->data[o->length] = ch;
1476 o->data[o->length] = '\0';
1479 static void o_addQstr(o_string *o, const char *str, int len)
1482 o_addblock(o, str, len);
1488 int ordinary_cnt = strcspn(str, "*?[\\");
1489 if (ordinary_cnt > len) /* paranoia */
1491 o_addblock(o, str, ordinary_cnt);
1492 if (ordinary_cnt == len)
1494 str += ordinary_cnt;
1495 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1499 if (ch) { /* it is necessarily one of "*?[\\" */
1501 o->data[o->length] = '\\';
1505 o->data[o->length] = ch;
1507 o->data[o->length] = '\0';
1511 /* A special kind of o_string for $VAR and `cmd` expansion.
1512 * It contains char* list[] at the beginning, which is grown in 16 element
1513 * increments. Actual string data starts at the next multiple of 16 * (char*).
1514 * list[i] contains an INDEX (int!) into this string data.
1515 * It means that if list[] needs to grow, data needs to be moved higher up
1516 * but list[i]'s need not be modified.
1517 * NB: remembering how many list[i]'s you have there is crucial.
1518 * o_finalize_list() operation post-processes this structure - calculates
1519 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1521 #if DEBUG_EXPAND || DEBUG_GLOB
1522 static void debug_print_list(const char *prefix, o_string *o, int n)
1524 char **list = (char**)o->data;
1525 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1527 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1528 prefix, list, n, string_start, o->length, o->maxlen);
1530 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1531 o->data + (int)list[i] + string_start,
1532 o->data + (int)list[i] + string_start);
1536 const char *p = o->data + (int)list[n - 1] + string_start;
1537 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1541 #define debug_print_list(prefix, o, n) ((void)0)
1544 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1545 * in list[n] so that it points past last stored byte so far.
1546 * It returns n+1. */
1547 static int o_save_ptr_helper(o_string *o, int n)
1549 char **list = (char**)o->data;
1553 if (!o->has_empty_slot) {
1554 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1555 string_len = o->length - string_start;
1556 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1557 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1558 /* list[n] points to string_start, make space for 16 more pointers */
1559 o->maxlen += 0x10 * sizeof(list[0]);
1560 o->data = xrealloc(o->data, o->maxlen + 1);
1561 list = (char**)o->data;
1562 memmove(list + n + 0x10, list + n, string_len);
1563 o->length += 0x10 * sizeof(list[0]);
1565 debug_printf_list("list[%d]=%d string_start=%d\n",
1566 n, string_len, string_start);
1569 /* We have empty slot at list[n], reuse without growth */
1570 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1571 string_len = o->length - string_start;
1572 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
1573 n, string_len, string_start);
1574 o->has_empty_slot = 0;
1576 list[n] = (char*)(ptrdiff_t)string_len;
1580 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
1581 static int o_get_last_ptr(o_string *o, int n)
1583 char **list = (char**)o->data;
1584 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1586 return ((int)(ptrdiff_t)list[n-1]) + string_start;
1589 /* o_glob performs globbing on last list[], saving each result
1590 * as a new list[]. */
1591 static int o_glob(o_string *o, int n)
1597 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
1599 return o_save_ptr_helper(o, n);
1600 pattern = o->data + o_get_last_ptr(o, n);
1601 debug_printf_glob("glob pattern '%s'\n", pattern);
1602 if (!glob_needed(pattern)) {
1604 o->length = unbackslash(pattern) - o->data;
1605 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
1606 return o_save_ptr_helper(o, n);
1609 memset(&globdata, 0, sizeof(globdata));
1610 gr = glob(pattern, 0, NULL, &globdata);
1611 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
1612 if (gr == GLOB_NOSPACE)
1613 bb_error_msg_and_die("out of memory during glob");
1614 if (gr == GLOB_NOMATCH) {
1615 globfree(&globdata);
1618 if (gr != 0) { /* GLOB_ABORTED ? */
1619 //TODO: testcase for bad glob pattern behavior
1620 bb_error_msg("glob(3) error %d on '%s'", gr, pattern);
1622 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
1623 char **argv = globdata.gl_pathv;
1624 o->length = pattern - o->data; /* "forget" pattern */
1626 o_addstr_with_NUL(o, *argv);
1627 n = o_save_ptr_helper(o, n);
1633 globfree(&globdata);
1635 debug_print_list("o_glob returning", o, n);
1639 /* If o->o_glob == 1, glob the string so far remembered.
1640 * Otherwise, just finish current list[] and start new */
1641 static int o_save_ptr(o_string *o, int n)
1643 if (o->o_glob) { /* if globbing is requested */
1644 /* If o->has_empty_slot, list[n] was already globbed
1645 * (if it was requested back then when it was filled)
1646 * so don't do that again! */
1647 if (!o->has_empty_slot)
1648 return o_glob(o, n); /* o_save_ptr_helper is inside */
1650 return o_save_ptr_helper(o, n);
1653 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
1654 static char **o_finalize_list(o_string *o, int n)
1659 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
1661 debug_print_list("finalized", o, n);
1662 debug_printf_expand("finalized n:%d\n", n);
1663 list = (char**)o->data;
1664 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1668 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
1674 /* Expansion can recurse */
1675 #if ENABLE_HUSH_TICK
1676 static int process_command_subs(o_string *dest, const char *s);
1678 static char *expand_string_to_string(const char *str);
1680 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
1681 parse_stream_dquoted(dest, input, dquote_end)
1683 static int parse_stream_dquoted(struct parse_context *ctx,
1685 struct in_str *input,
1688 /* expand_strvec_to_strvec() takes a list of strings, expands
1689 * all variable references within and returns a pointer to
1690 * a list of expanded strings, possibly with larger number
1691 * of strings. (Think VAR="a b"; echo $VAR).
1692 * This new list is allocated as a single malloc block.
1693 * NULL-terminated list of char* pointers is at the beginning of it,
1694 * followed by strings themself.
1695 * Caller can deallocate entire list by single free(list). */
1697 /* Store given string, finalizing the word and starting new one whenever
1698 * we encounter IFS char(s). This is used for expanding variable values.
1699 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
1700 static int expand_on_ifs(o_string *output, int n, const char *str)
1703 int word_len = strcspn(str, G.ifs);
1705 if (output->o_escape || !output->o_glob)
1706 o_addQstr(output, str, word_len);
1707 else /* protect backslashes against globbing up :) */
1708 o_addblock_duplicate_backslash(output, str, word_len);
1711 if (!*str) /* EOL - do not finalize word */
1713 o_addchr(output, '\0');
1714 debug_print_list("expand_on_ifs", output, n);
1715 n = o_save_ptr(output, n);
1716 str += strspn(str, G.ifs); /* skip ifs chars */
1718 debug_print_list("expand_on_ifs[1]", output, n);
1722 /* Expand all variable references in given string, adding words to list[]
1723 * at n, n+1,... positions. Return updated n (so that list[n] is next one
1724 * to be filled). This routine is extremely tricky: has to deal with
1725 * variables/parameters with whitespace, $* and $@, and constructs like
1726 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
1727 static int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
1729 /* or_mask is either 0 (normal case) or 0x80
1730 * (expansion of right-hand side of assignment == 1-element expand.
1731 * It will also do no globbing, and thus we must not backslash-quote!) */
1733 char first_ch, ored_ch;
1740 debug_printf_expand("expand_vars_to_list: arg '%s'\n", arg);
1741 debug_print_list("expand_vars_to_list", output, n);
1742 n = o_save_ptr(output, n);
1743 debug_print_list("expand_vars_to_list[0]", output, n);
1745 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
1746 #if ENABLE_HUSH_TICK
1747 o_string subst_result = NULL_O_STRING;
1749 #if ENABLE_SH_MATH_SUPPORT
1750 char arith_buf[sizeof(arith_t)*3 + 2];
1752 o_addblock(output, arg, p - arg);
1753 debug_print_list("expand_vars_to_list[1]", output, n);
1755 p = strchr(p, SPECIAL_VAR_SYMBOL);
1757 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
1758 /* "$@" is special. Even if quoted, it can still
1759 * expand to nothing (not even an empty string) */
1760 if ((first_ch & 0x7f) != '@')
1761 ored_ch |= first_ch;
1764 switch (first_ch & 0x7f) {
1765 /* Highest bit in first_ch indicates that var is double-quoted */
1767 val = utoa(G.root_pid);
1769 case '!': /* bg pid */
1770 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
1772 case '?': /* exitcode */
1773 val = utoa(G.last_return_code);
1775 case '#': /* argc */
1776 if (arg[1] != SPECIAL_VAR_SYMBOL)
1777 /* actually, it's a ${#var} */
1779 val = utoa(G.global_argc ? G.global_argc-1 : 0);
1784 if (!G.global_argv[i])
1786 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
1787 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
1788 smallint sv = output->o_escape;
1789 /* unquoted var's contents should be globbed, so don't escape */
1790 output->o_escape = 0;
1791 while (G.global_argv[i]) {
1792 n = expand_on_ifs(output, n, G.global_argv[i]);
1793 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
1794 if (G.global_argv[i++][0] && G.global_argv[i]) {
1795 /* this argv[] is not empty and not last:
1796 * put terminating NUL, start new word */
1797 o_addchr(output, '\0');
1798 debug_print_list("expand_vars_to_list[2]", output, n);
1799 n = o_save_ptr(output, n);
1800 debug_print_list("expand_vars_to_list[3]", output, n);
1803 output->o_escape = sv;
1805 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
1806 * and in this case should treat it like '$*' - see 'else...' below */
1807 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
1809 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1810 if (++i >= G.global_argc)
1812 o_addchr(output, '\0');
1813 debug_print_list("expand_vars_to_list[4]", output, n);
1814 n = o_save_ptr(output, n);
1816 } else { /* quoted $*: add as one word */
1818 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1819 if (!G.global_argv[++i])
1822 o_addchr(output, G.ifs[0]);
1826 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
1827 /* "Empty variable", used to make "" etc to not disappear */
1831 #if ENABLE_HUSH_TICK
1832 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
1835 //TODO: can we just stuff it into "output" directly?
1836 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
1837 process_command_subs(&subst_result, arg);
1838 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
1839 val = subst_result.data;
1842 #if ENABLE_SH_MATH_SUPPORT
1843 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
1844 arith_eval_hooks_t hooks;
1849 arg++; /* skip '+' */
1850 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
1851 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
1853 /* Optional: skip expansion if expr is simple ("a + 3", "i++" etc) */
1856 unsigned char c = *exp_str++;
1863 if (strchr(" \t+-*/%_", c) != NULL)
1865 c |= 0x20; /* tolower */
1866 if (c >= 'a' && c <= 'z')
1870 /* We need to expand. Example: "echo $(($a + 1)) $((1 + $((2)) ))" */
1872 struct in_str input;
1873 o_string dest = NULL_O_STRING;
1875 setup_string_in_str(&input, arg);
1876 parse_stream_dquoted(NULL, &dest, &input, EOF);
1877 //bb_error_msg("'%s' -> '%s'", arg, dest.data);
1878 exp_str = expand_string_to_string(dest.data);
1879 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
1883 hooks.lookupvar = get_local_var_value;
1884 hooks.setvar = arith_set_local_var;
1885 hooks.endofname = endofname;
1886 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
1891 case -3: maybe_die("arith", "exponent less than 0"); break;
1892 case -2: maybe_die("arith", "divide by zero"); break;
1893 case -5: maybe_die("arith", "expression recursion loop detected"); break;
1894 default: maybe_die("arith", "syntax error"); break;
1897 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
1898 sprintf(arith_buf, arith_t_fmt, res);
1903 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
1905 bool exp_len = false;
1906 bool exp_null = false;
1908 char exp_save = exp_save; /* for compiler */
1909 char exp_op = exp_op; /* for compiler */
1910 char *exp_word = exp_word; /* for compiler */
1914 arg[0] = first_ch & 0x7f;
1916 /* prepare for expansions */
1917 if (var[0] == '#') {
1918 /* handle length expansion ${#var} */
1922 /* maybe handle parameter expansion */
1923 exp_off = strcspn(var, ":-=+?");
1927 exp_save = var[exp_off];
1928 exp_null = exp_save == ':';
1929 exp_word = var + exp_off;
1930 if (exp_null) ++exp_word;
1931 exp_op = *exp_word++;
1932 var[exp_off] = '\0';
1936 /* lookup the variable in question */
1937 if (isdigit(var[0])) {
1938 /* handle_dollar() should have vetted var for us */
1940 if (i < G.global_argc)
1941 val = G.global_argv[i];
1942 /* else val remains NULL: $N with too big N */
1944 val = get_local_var_value(var);
1946 /* handle any expansions */
1948 debug_printf_expand("expand: length of '%s' = ", val);
1949 val = utoa(val ? strlen(val) : 0);
1950 debug_printf_expand("%s\n", val);
1951 } else if (exp_off) {
1952 /* we need to do an expansion */
1953 int exp_test = (!val || (exp_null && !val[0]));
1955 exp_test = !exp_test;
1956 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
1957 exp_null ? "true" : "false", exp_test);
1960 maybe_die(var, *exp_word ? exp_word : "parameter null or not set");
1964 if (exp_op == '=') {
1965 if (isdigit(var[0]) || var[0] == '#') {
1966 maybe_die(var, "special vars cannot assign in this way");
1969 char *new_var = xmalloc(strlen(var) + strlen(val) + 2);
1970 sprintf(new_var, "%s=%s", var, val);
1971 set_local_var(new_var, -1, 0);
1975 var[exp_off] = exp_save;
1979 #if ENABLE_HUSH_TICK
1982 if (!(first_ch & 0x80)) { /* unquoted $VAR */
1983 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
1985 /* unquoted var's contents should be globbed, so don't escape */
1986 smallint sv = output->o_escape;
1987 output->o_escape = 0;
1988 n = expand_on_ifs(output, n, val);
1990 output->o_escape = sv;
1992 } else { /* quoted $VAR, val will be appended below */
1993 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
1996 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
1998 o_addQstr(output, val, strlen(val));
2000 /* Do the check to avoid writing to a const string */
2001 if (*p != SPECIAL_VAR_SYMBOL)
2002 *p = SPECIAL_VAR_SYMBOL;
2004 #if ENABLE_HUSH_TICK
2005 o_free(&subst_result);
2008 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
2011 debug_print_list("expand_vars_to_list[a]", output, n);
2012 /* this part is literal, and it was already pre-quoted
2013 * if needed (much earlier), do not use o_addQstr here! */
2014 o_addstr_with_NUL(output, arg);
2015 debug_print_list("expand_vars_to_list[b]", output, n);
2016 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
2017 && !(ored_ch & 0x80) /* and all vars were not quoted. */
2020 /* allow to reuse list[n] later without re-growth */
2021 output->has_empty_slot = 1;
2023 o_addchr(output, '\0');
2028 static char **expand_variables(char **argv, int or_mask)
2033 o_string output = NULL_O_STRING;
2035 if (or_mask & 0x100) {
2036 output.o_escape = 1; /* protect against globbing for "$var" */
2037 /* (unquoted $var will temporarily switch it off) */
2044 n = expand_vars_to_list(&output, n, *v, (char)or_mask);
2047 debug_print_list("expand_variables", &output, n);
2049 /* output.data (malloced in one block) gets returned in "list" */
2050 list = o_finalize_list(&output, n);
2051 debug_print_strings("expand_variables[1]", list);
2055 static char **expand_strvec_to_strvec(char **argv)
2057 return expand_variables(argv, 0x100);
2060 /* Used for expansion of right hand of assignments */
2061 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2063 static char *expand_string_to_string(const char *str)
2065 char *argv[2], **list;
2067 argv[0] = (char*)str;
2069 list = expand_variables(argv, 0x80); /* 0x80: make one-element expansion */
2071 if (!list[0] || list[1])
2072 bb_error_msg_and_die("BUG in varexp2");
2073 /* actually, just move string 2*sizeof(char*) bytes back */
2074 overlapping_strcpy((char*)list, list[0]);
2075 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2079 /* Used for "eval" builtin */
2080 static char* expand_strvec_to_string(char **argv)
2084 list = expand_variables(argv, 0x80);
2085 /* Convert all NULs to spaces */
2090 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2091 bb_error_msg_and_die("BUG in varexp3");
2092 list[n][-1] = ' '; /* TODO: or to G.ifs[0]? */
2096 overlapping_strcpy((char*)list, list[0]);
2097 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2101 static char **expand_assignments(char **argv, int count)
2105 /* Expand assignments into one string each */
2106 for (i = 0; i < count; i++) {
2107 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2113 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
2114 * and stderr if they are redirected. */
2115 static int setup_redirects(struct command *prog, int squirrel[])
2118 struct redir_struct *redir;
2120 for (redir = prog->redirects; redir; redir = redir->next) {
2121 if (redir->dup == -1 && redir->rd_filename == NULL) {
2122 /* something went wrong in the parse. Pretend it didn't happen */
2125 if (redir->dup == -1) {
2127 mode = redir_table[redir->rd_type].mode;
2128 //TODO: check redir for names like '\\'
2129 p = expand_string_to_string(redir->rd_filename);
2130 openfd = open_or_warn(p, mode);
2133 /* this could get lost if stderr has been redirected, but
2134 bash and ash both lose it as well (though zsh doesn't!) */
2138 openfd = redir->dup;
2141 if (openfd != redir->fd) {
2142 if (squirrel && redir->fd < 3) {
2143 squirrel[redir->fd] = dup(redir->fd);
2146 //close(openfd); // close(-3) ??!
2148 dup2(openfd, redir->fd);
2149 if (redir->dup == -1)
2157 static void restore_redirects(int squirrel[])
2160 for (i = 0; i < 3; i++) {
2163 /* We simply die on error */
2170 #if !defined(DEBUG_CLEAN)
2171 #define free_pipe_list(head, indent) free_pipe_list(head)
2172 #define free_pipe(pi, indent) free_pipe(pi)
2174 static void free_pipe_list(struct pipe *head, int indent);
2176 /* Return code is the exit status of the pipe */
2177 static void free_pipe(struct pipe *pi, int indent)
2180 struct command *command;
2181 struct redir_struct *r, *rnext;
2184 if (pi->stopped_cmds > 0) /* why? */
2186 debug_printf_clean("%s run pipe: (pid %d)\n", indenter(indent), getpid());
2187 for (i = 0; i < pi->num_cmds; i++) {
2188 command = &pi->cmds[i];
2189 debug_printf_clean("%s command %d:\n", indenter(indent), i);
2190 if (command->argv) {
2191 for (a = 0, p = command->argv; *p; a++, p++) {
2192 debug_printf_clean("%s argv[%d] = %s\n", indenter(indent), a, *p);
2194 free_strings(command->argv);
2195 command->argv = NULL;
2197 /* not "else if": on syntax error, we may have both! */
2198 if (command->group) {
2199 debug_printf_clean("%s begin group (grp_type:%d)\n", indenter(indent), command->grp_type);
2200 free_pipe_list(command->group, indent+3);
2201 debug_printf_clean("%s end group\n", indenter(indent));
2202 command->group = NULL;
2205 free(command->group_as_string);
2206 command->group_as_string = NULL;
2208 for (r = command->redirects; r; r = rnext) {
2209 debug_printf_clean("%s redirect %d%s", indenter(indent), r->fd, redir_table[r->rd_type].descrip);
2211 /* guard against the case >$FOO, where foo is unset or blank */
2212 if (r->rd_filename) {
2213 debug_printf_clean(" %s\n", r->rd_filename);
2214 free(r->rd_filename);
2215 r->rd_filename = NULL;
2218 debug_printf_clean("&%d\n", r->dup);
2223 command->redirects = NULL;
2225 free(pi->cmds); /* children are an array, they get freed all at once */
2233 static void free_pipe_list(struct pipe *head, int indent)
2235 struct pipe *pi, *next;
2237 for (pi = head; pi; pi = next) {
2239 debug_printf_clean("%s pipe reserved mode %d\n", indenter(indent), pi->res_word);
2241 free_pipe(pi, indent);
2242 debug_printf_clean("%s pipe followup code %d\n", indenter(indent), pi->followup);
2244 /*pi->next = NULL;*/
2251 typedef struct nommu_save_t {
2257 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
2258 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
2259 #define pseudo_exec(nommu_save, command, argv_expanded) \
2260 pseudo_exec(command, argv_expanded)
2263 /* Called after [v]fork() in run_pipe(), or from builtin_exec().
2265 * XXX no exit() here. If you don't exec, use _exit instead.
2266 * The at_exit handlers apparently confuse the calling process,
2267 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
2268 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2269 char **argv, int assignment_cnt,
2270 char **argv_expanded) NORETURN;
2271 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2272 char **argv, int assignment_cnt,
2273 char **argv_expanded)
2277 /* Case when we are here: ... | var=val | ... */
2278 if (!argv[assignment_cnt])
2279 _exit(EXIT_SUCCESS);
2281 new_env = expand_assignments(argv, assignment_cnt);
2283 putenv_all(new_env);
2284 free(new_env); /* optional */
2286 nommu_save->new_env = new_env;
2287 nommu_save->old_env = putenv_all_and_save_old(new_env);
2289 if (argv_expanded) {
2290 argv = argv_expanded;
2292 argv = expand_strvec_to_strvec(argv + assignment_cnt);
2294 nommu_save->argv = argv;
2298 /* On NOMMU, we must never block!
2299 * Example: { sleep 99999 | read line } & echo Ok
2300 * read builtin will block on read syscall, leaving parent blocked
2301 * in vfork. Therefore we can't do this:
2304 /* Check if the command matches any of the builtins.
2305 * Depending on context, this might be redundant. But it's
2306 * easier to waste a few CPU cycles than it is to figure out
2307 * if this is one of those cases.
2311 const struct built_in_command *x;
2312 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2313 if (strcmp(argv[0], x->cmd) == 0) {
2314 debug_printf_exec("running builtin '%s'\n",
2316 rcode = x->function(argv);
2324 #if ENABLE_FEATURE_SH_STANDALONE
2325 /* Check if the command matches any busybox applets */
2326 if (strchr(argv[0], '/') == NULL) {
2327 int a = find_applet_by_name(argv[0]);
2329 #if BB_MMU /* see above why on NOMMU it is not allowed */
2330 if (APPLET_IS_NOEXEC(a)) {
2331 debug_printf_exec("running applet '%s'\n", argv[0]);
2332 run_applet_no_and_exit(a, argv);
2335 /* Re-exec ourselves */
2336 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
2337 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2338 execv(bb_busybox_exec_path, argv);
2339 /* If they called chroot or otherwise made the binary no longer
2340 * executable, fall through */
2345 debug_printf_exec("execing '%s'\n", argv[0]);
2346 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2347 execvp(argv[0], argv);
2348 bb_perror_msg("can't exec '%s'", argv[0]);
2349 _exit(EXIT_FAILURE);
2353 static void re_execute_shell(const char *s) NORETURN;
2354 static void re_execute_shell(const char *s)
2356 struct variable *cur;
2357 char **argv, **pp, **pp2;
2360 /* 1:hush 2:-$<pid> 3:-!<pid> 4:-?<exitcode> 5:-D<depth> <vars...>
2361 * 6:-c 7:<cmd> <argN...> 8:NULL
2363 cnt = 8 + G.global_argc;
2364 for (cur = G.top_var; cur; cur = cur->next) {
2365 if (!cur->flg_export || cur->flg_read_only)
2368 G.argv_from_re_execing = pp = xzalloc(sizeof(argv[0]) * cnt);
2369 *pp++ = (char *) G.argv0_for_re_execing;
2370 *pp++ = xasprintf("-$%u", (unsigned) G.root_pid);
2371 *pp++ = xasprintf("-!%u", (unsigned) G.last_bg_pid);
2372 *pp++ = xasprintf("-?%u", (unsigned) G.last_return_code);
2373 #if ENABLE_HUSH_LOOPS
2374 *pp++ = xasprintf("-D%u", G.depth_of_loop);
2376 for (cur = G.top_var; cur; cur = cur->next) {
2377 if (cur->varstr == hush_version_str)
2379 if (cur->flg_read_only) {
2380 *pp++ = (char *) "-R";
2381 *pp++ = cur->varstr;
2382 } else if (!cur->flg_export) {
2383 *pp++ = (char *) "-V";
2384 *pp++ = cur->varstr;
2387 *pp++ = (char *) "-c";
2389 pp2 = G.global_argv;
2392 /* *pp = NULL; - is already there */
2393 //TODO: pass traps and functions
2395 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
2396 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2397 execv(bb_busybox_exec_path, G.argv_from_re_execing);
2398 /* Fallback. Useful for init=/bin/hush usage etc */
2399 if (G.argv0_for_re_execing[0] == '/')
2400 execv(G.argv0_for_re_execing, G.argv_from_re_execing);
2401 xfunc_error_retval = 127;
2402 bb_error_msg_and_die("can't re-execute the shell");
2405 static void clean_up_after_re_execute(void)
2407 char **pp = G.argv_from_re_execing;
2409 /* Must match re_execute_shell's allocations */
2413 #if ENABLE_HUSH_LOOPS
2417 G.argv_from_re_execing = NULL;
2421 #define clean_up_after_re_execute() ((void)0)
2424 static int run_list(struct pipe *pi);
2426 /* Called after [v]fork() in run_pipe()
2428 static void pseudo_exec(nommu_save_t *nommu_save,
2429 struct command *command,
2430 char **argv_expanded) NORETURN;
2431 static void pseudo_exec(nommu_save_t *nommu_save,
2432 struct command *command,
2433 char **argv_expanded)
2435 if (command->argv) {
2436 pseudo_exec_argv(nommu_save, command->argv,
2437 command->assignment_cnt, argv_expanded);
2440 if (command->group) {
2441 /* Cases when we are here:
2444 * ... | ( list ) | ...
2445 * ... | { list } | ...
2449 debug_printf_exec("pseudo_exec: run_list\n");
2450 rcode = run_list(command->group);
2451 /* OK to leak memory by not calling free_pipe_list,
2452 * since this process is about to exit */
2455 re_execute_shell(command->group_as_string);
2459 /* Case when we are here: ... | >file */
2460 debug_printf_exec("pseudo_exec'ed null command\n");
2461 _exit(EXIT_SUCCESS);
2465 static const char *get_cmdtext(struct pipe *pi)
2471 /* This is subtle. ->cmdtext is created only on first backgrounding.
2472 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
2473 * On subsequent bg argv is trashed, but we won't use it */
2476 argv = pi->cmds[0].argv;
2477 if (!argv || !argv[0]) {
2478 pi->cmdtext = xzalloc(1);
2483 do len += strlen(*argv) + 1; while (*++argv);
2484 pi->cmdtext = p = xmalloc(len);
2485 argv = pi->cmds[0].argv;
2487 len = strlen(*argv);
2488 memcpy(p, *argv, len);
2496 static void insert_bg_job(struct pipe *pi)
2498 struct pipe *thejob;
2501 /* Linear search for the ID of the job to use */
2503 for (thejob = G.job_list; thejob; thejob = thejob->next)
2504 if (thejob->jobid >= pi->jobid)
2505 pi->jobid = thejob->jobid + 1;
2507 /* Add thejob to the list of running jobs */
2509 thejob = G.job_list = xmalloc(sizeof(*thejob));
2511 for (thejob = G.job_list; thejob->next; thejob = thejob->next)
2513 thejob->next = xmalloc(sizeof(*thejob));
2514 thejob = thejob->next;
2517 /* Physically copy the struct job */
2518 memcpy(thejob, pi, sizeof(struct pipe));
2519 thejob->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
2520 /* We cannot copy entire pi->cmds[] vector! Double free()s will happen */
2521 for (i = 0; i < pi->num_cmds; i++) {
2522 // TODO: do we really need to have so many fields which are just dead weight
2523 // at execution stage?
2524 thejob->cmds[i].pid = pi->cmds[i].pid;
2525 /* all other fields are not used and stay zero */
2527 thejob->next = NULL;
2528 thejob->cmdtext = xstrdup(get_cmdtext(pi));
2530 /* We don't wait for background thejobs to return -- append it
2531 to the list of backgrounded thejobs and leave it alone */
2532 if (G_interactive_fd)
2533 printf("[%d] %d %s\n", thejob->jobid, thejob->cmds[0].pid, thejob->cmdtext);
2534 G.last_bg_pid = thejob->cmds[0].pid;
2535 G.last_jobid = thejob->jobid;
2538 static void remove_bg_job(struct pipe *pi)
2540 struct pipe *prev_pipe;
2542 if (pi == G.job_list) {
2543 G.job_list = pi->next;
2545 prev_pipe = G.job_list;
2546 while (prev_pipe->next != pi)
2547 prev_pipe = prev_pipe->next;
2548 prev_pipe->next = pi->next;
2551 G.last_jobid = G.job_list->jobid;
2556 /* Remove a backgrounded job */
2557 static void delete_finished_bg_job(struct pipe *pi)
2560 pi->stopped_cmds = 0;
2566 /* Check to see if any processes have exited -- if they
2567 * have, figure out why and see if a job has completed */
2568 static int checkjobs(struct pipe* fg_pipe)
2578 debug_printf_jobs("checkjobs %p\n", fg_pipe);
2581 // if (G.handled_SIGCHLD == G.count_SIGCHLD)
2582 // /* avoid doing syscall, nothing there anyway */
2585 attributes = WUNTRACED;
2586 if (fg_pipe == NULL)
2587 attributes |= WNOHANG;
2589 /* Do we do this right?
2590 * bash-3.00# sleep 20 | false
2592 * [3]+ Stopped sleep 20 | false
2593 * bash-3.00# echo $?
2594 * 1 <========== bg pipe is not fully done, but exitcode is already known!
2597 //FIXME: non-interactive bash does not continue even if all processes in fg pipe
2598 //are stopped. Testcase: "cat | cat" in a script (not on command line)
2599 // + killall -STOP cat
2606 // i = G.count_SIGCHLD;
2607 childpid = waitpid(-1, &status, attributes);
2608 if (childpid <= 0) {
2609 if (childpid && errno != ECHILD)
2610 bb_perror_msg("waitpid");
2611 // else /* Until next SIGCHLD, waitpid's are useless */
2612 // G.handled_SIGCHLD = i;
2615 dead = WIFEXITED(status) || WIFSIGNALED(status);
2618 if (WIFSTOPPED(status))
2619 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
2620 childpid, WSTOPSIG(status), WEXITSTATUS(status));
2621 if (WIFSIGNALED(status))
2622 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
2623 childpid, WTERMSIG(status), WEXITSTATUS(status));
2624 if (WIFEXITED(status))
2625 debug_printf_jobs("pid %d exited, exitcode %d\n",
2626 childpid, WEXITSTATUS(status));
2628 /* Were we asked to wait for fg pipe? */
2630 for (i = 0; i < fg_pipe->num_cmds; i++) {
2631 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
2632 if (fg_pipe->cmds[i].pid != childpid)
2634 /* printf("process %d exit %d\n", i, WEXITSTATUS(status)); */
2636 fg_pipe->cmds[i].pid = 0;
2637 fg_pipe->alive_cmds--;
2638 if (i == fg_pipe->num_cmds - 1) {
2639 /* last process gives overall exitstatus */
2640 rcode = WEXITSTATUS(status);
2641 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
2644 fg_pipe->cmds[i].is_stopped = 1;
2645 fg_pipe->stopped_cmds++;
2647 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
2648 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
2649 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
2650 /* All processes in fg pipe have exited/stopped */
2652 if (fg_pipe->alive_cmds)
2653 insert_bg_job(fg_pipe);
2657 /* There are still running processes in the fg pipe */
2658 goto wait_more; /* do waitpid again */
2660 /* it wasnt fg_pipe, look for process in bg pipes */
2664 /* We asked to wait for bg or orphaned children */
2665 /* No need to remember exitcode in this case */
2666 for (pi = G.job_list; pi; pi = pi->next) {
2667 for (i = 0; i < pi->num_cmds; i++) {
2668 if (pi->cmds[i].pid == childpid)
2669 goto found_pi_and_prognum;
2672 /* Happens when shell is used as init process (init=/bin/sh) */
2673 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
2674 continue; /* do waitpid again */
2676 found_pi_and_prognum:
2679 pi->cmds[i].pid = 0;
2681 if (!pi->alive_cmds) {
2682 if (G_interactive_fd)
2683 printf(JOB_STATUS_FORMAT, pi->jobid,
2684 "Done", pi->cmdtext);
2685 delete_finished_bg_job(pi);
2689 pi->cmds[i].is_stopped = 1;
2693 } /* while (waitpid succeeds)... */
2699 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
2702 int rcode = checkjobs(fg_pipe);
2703 /* Job finished, move the shell to the foreground */
2704 p = getpgid(0); /* pgid of our process */
2705 debug_printf_jobs("fg'ing ourself: getpgid(0)=%d\n", (int)p);
2706 tcsetpgrp(G_interactive_fd, p);
2711 /* Start all the jobs, but don't wait for anything to finish.
2714 * Return code is normally -1, when the caller has to wait for children
2715 * to finish to determine the exit status of the pipe. If the pipe
2716 * is a simple builtin command, however, the action is done by the
2717 * time run_pipe returns, and the exit code is provided as the
2720 * Returns -1 only if started some children. IOW: we have to
2721 * mask out retvals of builtins etc with 0xff!
2723 * The only case when we do not need to [v]fork is when the pipe
2724 * is single, non-backgrounded, non-subshell command. Examples:
2725 * cmd ; ... { list } ; ...
2726 * cmd && ... { list } && ...
2727 * cmd || ... { list } || ...
2728 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
2729 * or (if SH_STANDALONE) an applet, and we can run the { list }
2730 * with run_list(). If it isn't one of these, we fork and exec cmd.
2732 * Cases when we must fork:
2733 * non-single: cmd | cmd
2734 * backgrounded: cmd & { list } &
2735 * subshell: ( list ) [&]
2737 static int run_pipe(struct pipe *pi)
2739 static const char *const null_ptr = NULL;
2742 int pipefds[2]; /* pipefds[0] is for reading */
2743 struct command *command;
2744 char **argv_expanded;
2747 /* it is not always needed, but we aim to smaller code */
2748 int squirrel[] = { -1, -1, -1 };
2751 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
2753 USE_HUSH_JOB(pi->pgrp = -1;)
2754 pi->stopped_cmds = 0;
2755 command = &(pi->cmds[0]);
2756 argv_expanded = NULL;
2758 if (pi->num_cmds != 1
2759 || pi->followup == PIPE_BG
2760 || command->grp_type == GRP_SUBSHELL
2767 debug_printf_exec(": group:%p argv:'%s'\n",
2768 command->group, command->argv ? command->argv[0] : "NONE");
2770 if (command->group) {
2771 #if ENABLE_HUSH_FUNCTIONS
2772 if (command->grp_type == GRP_FUNCTION) {
2773 /* func () { list } */
2774 bb_error_msg("here we ought to remember function definition, and go on");
2775 return EXIT_SUCCESS;
2779 debug_printf("non-subshell group\n");
2780 setup_redirects(command, squirrel);
2781 debug_printf_exec(": run_list\n");
2782 rcode = run_list(command->group) & 0xff;
2783 restore_redirects(squirrel);
2784 debug_printf_exec("run_pipe return %d\n", rcode);
2785 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2789 argv = command->argv ? command->argv : (char **) &null_ptr;
2791 const struct built_in_command *x;
2792 char **new_env = NULL;
2793 char **old_env = NULL;
2795 if (argv[command->assignment_cnt] == NULL) {
2796 /* Assignments, but no command */
2797 /* Ensure redirects take effect. Try "a=t >file" */
2798 setup_redirects(command, squirrel);
2799 restore_redirects(squirrel);
2800 /* Set shell variables */
2802 p = expand_string_to_string(*argv);
2803 debug_printf_exec("set shell var:'%s'->'%s'\n",
2805 set_local_var(p, 0, 0);
2808 /* Do we need to flag set_local_var() errors?
2809 * "assignment to readonly var" and "putenv error"
2811 return EXIT_SUCCESS;
2814 /* Expand the rest into (possibly) many strings each */
2815 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
2817 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2818 if (strcmp(argv_expanded[0], x->cmd) != 0)
2820 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
2821 debug_printf("exec with redirects only\n");
2822 setup_redirects(command, NULL);
2823 rcode = EXIT_SUCCESS;
2824 goto clean_up_and_ret1;
2826 debug_printf("builtin inline %s\n", argv_expanded[0]);
2827 /* XXX setup_redirects acts on file descriptors, not FILEs.
2828 * This is perfect for work that comes after exec().
2829 * Is it really safe for inline use? Experimentally,
2830 * things seem to work with glibc. */
2831 setup_redirects(command, squirrel);
2832 new_env = expand_assignments(argv, command->assignment_cnt);
2833 old_env = putenv_all_and_save_old(new_env);
2834 debug_printf_exec(": builtin '%s' '%s'...\n",
2835 x->cmd, argv_expanded[1]);
2836 rcode = x->function(argv_expanded) & 0xff;
2837 #if ENABLE_FEATURE_SH_STANDALONE
2840 restore_redirects(squirrel);
2841 free_strings_and_unsetenv(new_env, 1);
2842 putenv_all(old_env);
2843 free(old_env); /* not free_strings()! */
2845 free(argv_expanded);
2846 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2847 debug_printf_exec("run_pipe return %d\n", rcode);
2850 #if ENABLE_FEATURE_SH_STANDALONE
2851 i = find_applet_by_name(argv_expanded[0]);
2852 if (i >= 0 && APPLET_IS_NOFORK(i)) {
2853 setup_redirects(command, squirrel);
2854 save_nofork_data(&G.nofork_save);
2855 new_env = expand_assignments(argv, command->assignment_cnt);
2856 old_env = putenv_all_and_save_old(new_env);
2857 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
2858 argv_expanded[0], argv_expanded[1]);
2859 rcode = run_nofork_applet_prime(&G.nofork_save, i, argv_expanded);
2860 goto clean_up_and_ret;
2863 /* It is neither builtin nor applet. We must fork. */
2867 /* NB: argv_expanded may already be created, and that
2868 * might include `cmd` runs! Do not rerun it! We *must*
2869 * use argv_expanded if it's non-NULL */
2871 /* Going to fork a child per each pipe member */
2875 for (i = 0; i < pi->num_cmds; i++) {
2877 volatile nommu_save_t nommu_save;
2878 nommu_save.new_env = NULL;
2879 nommu_save.old_env = NULL;
2880 nommu_save.argv = NULL;
2882 command = &(pi->cmds[i]);
2883 if (command->argv) {
2884 debug_printf_exec(": pipe member '%s' '%s'...\n",
2885 command->argv[0], command->argv[1]);
2887 debug_printf_exec(": pipe member with no argv\n");
2890 /* pipes are inserted between pairs of commands */
2893 if ((i + 1) < pi->num_cmds)
2896 command->pid = BB_MMU ? fork() : vfork();
2897 if (!command->pid) { /* child */
2899 die_sleep = 0; /* let nofork's xfuncs die */
2901 /* Every child adds itself to new process group
2902 * with pgid == pid_of_first_child_in_pipe */
2903 if (G.run_list_level == 1 && G_interactive_fd) {
2906 if (pgrp < 0) /* true for 1st process only */
2908 if (setpgid(0, pgrp) == 0 && pi->followup != PIPE_BG) {
2909 /* We do it in *every* child, not just first,
2911 tcsetpgrp(G_interactive_fd, pgrp);
2915 xmove_fd(nextin, 0);
2916 xmove_fd(pipefds[1], 1); /* write end */
2918 close(pipefds[0]); /* read end */
2919 /* Like bash, explicit redirects override pipes,
2920 * and the pipe fd is available for dup'ing. */
2921 setup_redirects(command, NULL);
2923 /* Restore default handlers just prior to exec */
2924 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
2926 /* Stores to nommu_save list of env vars putenv'ed
2927 * (NOMMU, on MMU we don't need that) */
2928 /* cast away volatility... */
2929 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
2930 /* pseudo_exec() does not return */
2935 /* Clean up after vforked child */
2936 clean_up_after_re_execute();
2937 free(nommu_save.argv);
2938 free_strings_and_unsetenv(nommu_save.new_env, 1);
2939 putenv_all(nommu_save.old_env);
2941 free(argv_expanded);
2942 argv_expanded = NULL;
2943 if (command->pid < 0) { /* [v]fork failed */
2944 /* Clearly indicate, was it fork or vfork */
2945 bb_perror_msg(BB_MMU ? "fork" : "vfork");
2949 /* Second and next children need to know pid of first one */
2951 pi->pgrp = command->pid;
2957 if ((i + 1) < pi->num_cmds)
2958 close(pipefds[1]); /* write end */
2959 /* Pass read (output) pipe end to next iteration */
2960 nextin = pipefds[0];
2963 if (!pi->alive_cmds) {
2964 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
2968 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
2972 #ifndef debug_print_tree
2973 static void debug_print_tree(struct pipe *pi, int lvl)
2975 static const char *const PIPE[] = {
2981 static const char *RES[] = {
2982 [RES_NONE ] = "NONE" ,
2985 [RES_THEN ] = "THEN" ,
2986 [RES_ELIF ] = "ELIF" ,
2987 [RES_ELSE ] = "ELSE" ,
2990 #if ENABLE_HUSH_LOOPS
2991 [RES_FOR ] = "FOR" ,
2992 [RES_WHILE] = "WHILE",
2993 [RES_UNTIL] = "UNTIL",
2995 [RES_DONE ] = "DONE" ,
2997 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
3000 #if ENABLE_HUSH_CASE
3001 [RES_CASE ] = "CASE" ,
3002 [RES_MATCH] = "MATCH",
3003 [RES_CASEI] = "CASEI",
3004 [RES_ESAC ] = "ESAC" ,
3006 [RES_XXXX ] = "XXXX" ,
3007 [RES_SNTX ] = "SNTX" ,
3009 static const char *const GRPTYPE[] = {
3012 #if ENABLE_HUSH_FUNCTIONS
3021 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
3022 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
3024 while (prn < pi->num_cmds) {
3025 struct command *command = &pi->cmds[prn];
3026 char **argv = command->argv;
3028 fprintf(stderr, "%*s prog %d assignment_cnt:%d",
3030 command->assignment_cnt);
3031 if (command->group) {
3032 fprintf(stderr, " group %s: (argv=%p)\n",
3033 GRPTYPE[command->grp_type],
3035 debug_print_tree(command->group, lvl+1);
3039 if (argv) while (*argv) {
3040 fprintf(stderr, " '%s'", *argv);
3043 fprintf(stderr, "\n");
3052 /* NB: called by pseudo_exec, and therefore must not modify any
3053 * global data until exec/_exit (we can be a child after vfork!) */
3054 static int run_list(struct pipe *pi)
3056 #if ENABLE_HUSH_CASE
3057 char *case_word = NULL;
3059 #if ENABLE_HUSH_LOOPS
3060 struct pipe *loop_top = NULL;
3061 char *for_varname = NULL;
3062 char **for_lcur = NULL;
3063 char **for_list = NULL;
3065 smallint flag_skip = 1;
3066 smalluint rcode = 0; /* probably just for compiler */
3067 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
3068 smalluint cond_code = 0;
3070 enum { cond_code = 0, };
3072 /*enum reserved_style*/ smallint rword = RES_NONE;
3073 /*enum reserved_style*/ smallint skip_more_for_this_rword = RES_XXXX;
3075 debug_printf_exec("run_list start lvl %d\n", G.run_list_level + 1);
3077 #if ENABLE_HUSH_LOOPS
3078 /* Check syntax for "for" */
3079 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
3080 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
3082 /* current word is FOR or IN (BOLD in comments below) */
3083 if (cpipe->next == NULL) {
3084 syntax("malformed for");
3085 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3088 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
3089 if (cpipe->next->res_word == RES_DO)
3091 /* next word is not "do". It must be "in" then ("FOR v in ...") */
3092 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
3093 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
3095 syntax("malformed for");
3096 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3102 /* Past this point, all code paths should jump to ret: label
3103 * in order to return, no direct "return" statements please.
3104 * This helps to ensure that no memory is leaked. */
3106 ////TODO: ctrl-Z handling needs re-thinking and re-testing
3109 /* Example of nested list: "while true; do { sleep 1 | exit 2; } done".
3110 * We are saving state before entering outermost list ("while...done")
3111 * so that ctrl-Z will correctly background _entire_ outermost list,
3112 * not just a part of it (like "sleep 1 | exit 2") */
3113 if (++G.run_list_level == 1 && G_interactive_fd) {
3114 if (sigsetjmp(G.toplevel_jb, 1)) {
3115 /* ctrl-Z forked and we are parent; or ctrl-C.
3116 * Sighandler has longjmped us here */
3117 signal(SIGINT, SIG_IGN);
3118 signal(SIGTSTP, SIG_IGN);
3119 /* Restore level (we can be coming from deep inside
3121 G.run_list_level = 1;
3122 #if ENABLE_FEATURE_SH_STANDALONE
3123 if (G.nofork_save.saved) { /* if save area is valid */
3124 debug_printf_jobs("exiting nofork early\n");
3125 restore_nofork_data(&G.nofork_save);
3128 //// if (G.ctrl_z_flag) {
3129 //// /* ctrl-Z has forked and stored pid of the child in pi->pid.
3130 //// * Remember this child as background job */
3131 //// insert_bg_job(pi);
3133 /* ctrl-C. We just stop doing whatever we were doing */
3136 USE_HUSH_LOOPS(loop_top = NULL;)
3137 USE_HUSH_LOOPS(G.depth_of_loop = 0;)
3141 //// /* ctrl-Z handler will store pid etc in pi */
3142 //// G.toplevel_list = pi;
3143 //// G.ctrl_z_flag = 0;
3144 ////#if ENABLE_FEATURE_SH_STANDALONE
3145 //// G.nofork_save.saved = 0; /* in case we will run a nofork later */
3147 //// signal_SA_RESTART_empty_mask(SIGTSTP, handler_ctrl_z);
3148 //// signal(SIGINT, handler_ctrl_c);
3152 /* Go through list of pipes, (maybe) executing them. */
3153 for (; pi; pi = USE_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
3157 IF_HAS_KEYWORDS(rword = pi->res_word;)
3158 IF_HAS_NO_KEYWORDS(rword = RES_NONE;)
3159 debug_printf_exec(": rword=%d cond_code=%d skip_more=%d\n",
3160 rword, cond_code, skip_more_for_this_rword);
3161 #if ENABLE_HUSH_LOOPS
3162 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
3163 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
3165 /* start of a loop: remember where loop starts */
3170 if (rword == skip_more_for_this_rword && flag_skip) {
3171 if (pi->followup == PIPE_SEQ)
3173 /* it is "<false> && CMD" or "<true> || CMD"
3174 * and we should not execute CMD */
3178 skip_more_for_this_rword = RES_XXXX;
3181 if (rword == RES_THEN) {
3182 /* "if <false> THEN cmd": skip cmd */
3186 if (rword == RES_ELSE || rword == RES_ELIF) {
3187 /* "if <true> then ... ELSE/ELIF cmd":
3188 * skip cmd and all following ones */
3193 #if ENABLE_HUSH_LOOPS
3194 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
3196 /* first loop through for */
3198 static const char encoded_dollar_at[] ALIGN1 = {
3199 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
3200 }; /* encoded representation of "$@" */
3201 static const char *const encoded_dollar_at_argv[] = {
3202 encoded_dollar_at, NULL
3203 }; /* argv list with one element: "$@" */
3206 vals = (char**)encoded_dollar_at_argv;
3207 if (pi->next->res_word == RES_IN) {
3208 /* if no variable values after "in" we skip "for" */
3209 if (!pi->next->cmds[0].argv)
3211 vals = pi->next->cmds[0].argv;
3212 } /* else: "for var; do..." -> assume "$@" list */
3213 /* create list of variable values */
3214 debug_print_strings("for_list made from", vals);
3215 for_list = expand_strvec_to_strvec(vals);
3216 for_lcur = for_list;
3217 debug_print_strings("for_list", for_list);
3218 for_varname = pi->cmds[0].argv[0];
3219 pi->cmds[0].argv[0] = NULL;
3221 free(pi->cmds[0].argv[0]);
3223 /* "for" loop is over, clean up */
3227 pi->cmds[0].argv[0] = for_varname;
3230 /* insert next value from for_lcur */
3231 //TODO: does it need escaping?
3232 pi->cmds[0].argv[0] = xasprintf("%s=%s", for_varname, *for_lcur++);
3233 pi->cmds[0].assignment_cnt = 1;
3235 if (rword == RES_IN) {
3236 continue; /* "for v IN list;..." - "in" has no cmds anyway */
3238 if (rword == RES_DONE) {
3239 continue; /* "done" has no cmds too */
3242 #if ENABLE_HUSH_CASE
3243 if (rword == RES_CASE) {
3244 case_word = expand_strvec_to_string(pi->cmds->argv);
3247 if (rword == RES_MATCH) {
3250 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
3252 /* all prev words didn't match, does this one match? */
3253 argv = pi->cmds->argv;
3255 char *pattern = expand_string_to_string(*argv);
3256 /* TODO: which FNM_xxx flags to use? */
3257 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
3259 if (cond_code == 0) { /* match! we will execute this branch */
3260 free(case_word); /* make future "word)" stop */
3268 if (rword == RES_CASEI) { /* inside of a case branch */
3270 continue; /* not matched yet, skip this pipe */
3273 /* Just pressing <enter> in shell should check for jobs.
3274 * OTOH, in non-interactive shell this is useless
3275 * and only leads to extra job checks */
3276 if (pi->num_cmds == 0) {
3277 if (G_interactive_fd)
3278 goto check_jobs_and_continue;
3282 /* After analyzing all keywords and conditions, we decided
3283 * to execute this pipe. NB: have to do checkjobs(NULL)
3284 * after run_pipe() to collect any background children,
3285 * even if list execution is to be stopped. */
3286 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
3289 #if ENABLE_HUSH_LOOPS
3290 G.flag_break_continue = 0;
3292 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
3294 /* we only ran a builtin: rcode is already known
3295 * and we don't need to wait for anything. */
3296 check_and_run_traps(0);
3297 #if ENABLE_HUSH_LOOPS
3298 /* was it "break" or "continue"? */
3299 if (G.flag_break_continue) {
3300 smallint fbc = G.flag_break_continue;
3301 /* we might fall into outer *loop*,
3302 * don't want to break it too */
3304 G.depth_break_continue--;
3305 if (G.depth_break_continue == 0)
3306 G.flag_break_continue = 0;
3307 /* else: e.g. "continue 2" should *break* once, *then* continue */
3308 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
3309 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
3310 goto check_jobs_and_break;
3311 /* "continue": simulate end of loop */
3316 } else if (pi->followup == PIPE_BG) {
3317 /* what does bash do with attempts to background builtins? */
3318 /* even bash 3.2 doesn't do that well with nested bg:
3319 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
3320 * I'm NOT treating inner &'s as jobs */
3321 check_and_run_traps(0);
3323 if (G.run_list_level == 1)
3326 rcode = 0; /* EXIT_SUCCESS */
3329 if (G.run_list_level == 1 && G_interactive_fd) {
3330 /* waits for completion, then fg's main shell */
3331 rcode = checkjobs_and_fg_shell(pi);
3332 check_and_run_traps(0);
3333 debug_printf_exec(": checkjobs_and_fg_shell returned %d\n", rcode);
3336 { /* this one just waits for completion */
3337 rcode = checkjobs(pi);
3338 check_and_run_traps(0);
3339 debug_printf_exec(": checkjobs returned %d\n", rcode);
3343 debug_printf_exec(": setting last_return_code=%d\n", rcode);
3344 G.last_return_code = rcode;
3346 /* Analyze how result affects subsequent commands */
3348 if (rword == RES_IF || rword == RES_ELIF)
3351 #if ENABLE_HUSH_LOOPS
3352 if (rword == RES_WHILE) {
3354 rcode = 0; /* "while false; do...done" - exitcode 0 */
3355 goto check_jobs_and_break;
3358 if (rword == RES_UNTIL) {
3360 check_jobs_and_break:
3366 if ((rcode == 0 && pi->followup == PIPE_OR)
3367 || (rcode != 0 && pi->followup == PIPE_AND)
3369 skip_more_for_this_rword = rword;
3372 check_jobs_and_continue:
3377 //// if (G.ctrl_z_flag) {
3378 //// /* ctrl-Z forked somewhere in the past, we are the child,
3379 //// * and now we completed running the list. Exit. */
3385 //// if (!G.run_list_level && G_interactive_fd) {
3386 //// signal(SIGTSTP, SIG_IGN);
3387 //// signal(SIGINT, SIG_IGN);
3390 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
3391 #if ENABLE_HUSH_LOOPS
3396 #if ENABLE_HUSH_CASE
3402 /* Select which version we will use */
3403 static int run_and_free_list(struct pipe *pi)
3406 debug_printf_exec("run_and_free_list entered\n");
3408 debug_printf_exec(": run_list with %d members\n", pi->num_cmds);
3409 rcode = run_list(pi);
3411 /* free_pipe_list has the side effect of clearing memory.
3412 * In the long run that function can be merged with run_list,
3413 * but doing that now would hobble the debugging effort. */
3414 free_pipe_list(pi, /* indent: */ 0);
3415 debug_printf_exec("run_and_free_list return %d\n", rcode);
3420 /* Peek ahead in the in_str to find out if we have a "&n" construct,
3421 * as in "2>&1", that represents duplicating a file descriptor.
3422 * Return either -2 (syntax error), -1 (no &), or the number found.
3424 static int redirect_dup_num(struct in_str *input)
3426 int ch, d = 0, ok = 0;
3428 if (ch != '&') return -1;
3430 i_getch(input); /* get the & */
3434 return -3; /* "-" represents "close me" */
3436 while (isdigit(ch)) {
3437 d = d*10 + (ch-'0');
3444 bb_error_msg("ambiguous redirect");
3448 /* The src parameter allows us to peek forward to a possible &n syntax
3449 * for file descriptor duplication, e.g., "2>&1".
3450 * Return code is 0 normally, 1 if a syntax error is detected in src.
3451 * Resource errors (in xmalloc) cause the process to exit */
3452 static int setup_redirect(struct parse_context *ctx,
3455 struct in_str *input)
3457 struct command *command = ctx->command;
3458 struct redir_struct *redir;
3459 struct redir_struct **redirp;
3462 /* Check for a '2>&1' type redirect */
3463 dup_num = redirect_dup_num(input);
3465 return 1; /* syntax error */
3467 /* Create a new redir_struct and drop it onto the end of the linked list */
3468 redirp = &command->redirects;
3469 while ((redir = *redirp) != NULL) {
3470 redirp = &(redir->next);
3472 *redirp = redir = xzalloc(sizeof(*redir));
3473 /* redir->next = NULL; */
3474 /* redir->rd_filename = NULL; */
3475 redir->rd_type = style;
3476 redir->fd = (fd == -1) ? redir_table[style].default_fd : fd;
3478 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
3480 redir->dup = dup_num;
3481 if (dup_num != -1) {
3482 /* Erik had a check here that the file descriptor in question
3483 * is legit; I postpone that to "run time"
3484 * A "-" representation of "close me" shows up as a -3 here */
3485 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
3487 /* We do _not_ try to open the file that src points to,
3488 * since we need to return and let src be expanded first.
3489 * Set ctx->pending_redirect, so we know what to do at the
3490 * end of the next parsed word. */
3491 ctx->pending_redirect = redir;
3497 static struct pipe *new_pipe(void)
3500 pi = xzalloc(sizeof(struct pipe));
3501 /*pi->followup = 0; - deliberately invalid value */
3502 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3506 /* Command (member of a pipe) is complete. The only possible error here
3507 * is out of memory, in which case xmalloc exits. */
3508 static int done_command(struct parse_context *ctx)
3510 /* The command is really already in the pipe structure, so
3511 * advance the pipe counter and make a new, null command. */
3512 struct pipe *pi = ctx->pipe;
3513 struct command *command = ctx->command;
3516 if (command->group == NULL
3517 && command->argv == NULL
3518 && command->redirects == NULL
3520 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3521 return pi->num_cmds;
3524 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3526 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3529 /* Only real trickiness here is that the uncommitted
3530 * command structure is not counted in pi->num_cmds. */
3531 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3532 command = &pi->cmds[pi->num_cmds];
3533 memset(command, 0, sizeof(*command));
3535 ctx->command = command;
3536 /* but ctx->pipe and ctx->list_head remain unchanged */
3538 return pi->num_cmds; /* used only for 0/nonzero check */
3541 static void done_pipe(struct parse_context *ctx, pipe_style type)
3545 debug_printf_parse("done_pipe entered, followup %d\n", type);
3546 /* Close previous command */
3547 not_null = done_command(ctx);
3548 ctx->pipe->followup = type;
3549 IF_HAS_KEYWORDS(ctx->pipe->pi_inverted = ctx->ctx_inverted;)
3550 IF_HAS_KEYWORDS(ctx->ctx_inverted = 0;)
3551 IF_HAS_KEYWORDS(ctx->pipe->res_word = ctx->ctx_res_w;)
3553 /* Without this check, even just <enter> on command line generates
3554 * tree of three NOPs (!). Which is harmless but annoying.
3555 * IOW: it is safe to do it unconditionally.
3556 * RES_NONE case is for "for a in; do ..." (empty IN set)
3557 * to work, possibly other cases too. */
3558 if (not_null IF_HAS_KEYWORDS(|| ctx->ctx_res_w != RES_NONE)) {
3560 debug_printf_parse("done_pipe: adding new pipe: "
3561 "not_null:%d ctx->ctx_res_w:%d\n",
3562 not_null, ctx->ctx_res_w);
3564 ctx->pipe->next = new_p;
3566 /* RES_THEN, RES_DO etc are "sticky" -
3567 * they remain set for commands inside if/while.
3568 * This is used to control execution.
3569 * RES_FOR and RES_IN are NOT sticky (needed to support
3570 * cases where variable or value happens to match a keyword):
3572 #if ENABLE_HUSH_LOOPS
3573 if (ctx->ctx_res_w == RES_FOR
3574 || ctx->ctx_res_w == RES_IN)
3575 ctx->ctx_res_w = RES_NONE;
3577 #if ENABLE_HUSH_CASE
3578 if (ctx->ctx_res_w == RES_MATCH)
3579 ctx->ctx_res_w = RES_CASEI;
3581 ctx->command = NULL; /* trick done_command below */
3582 /* Create the memory for command, roughly:
3583 * ctx->pipe->cmds = new struct command;
3584 * ctx->command = &ctx->pipe->cmds[0];
3588 debug_printf_parse("done_pipe return\n");
3591 static void initialize_context(struct parse_context *ctx)
3593 memset(ctx, 0, sizeof(*ctx));
3594 ctx->pipe = ctx->list_head = new_pipe();
3595 /* Create the memory for command, roughly:
3596 * ctx->pipe->cmds = new struct command;
3597 * ctx->command = &ctx->pipe->cmds[0];
3603 /* If a reserved word is found and processed, parse context is modified
3604 * and 1 is returned.
3607 struct reserved_combo {
3610 unsigned char assignment_flag;
3614 FLAG_END = (1 << RES_NONE ),
3616 FLAG_IF = (1 << RES_IF ),
3617 FLAG_THEN = (1 << RES_THEN ),
3618 FLAG_ELIF = (1 << RES_ELIF ),
3619 FLAG_ELSE = (1 << RES_ELSE ),
3620 FLAG_FI = (1 << RES_FI ),
3622 #if ENABLE_HUSH_LOOPS
3623 FLAG_FOR = (1 << RES_FOR ),
3624 FLAG_WHILE = (1 << RES_WHILE),
3625 FLAG_UNTIL = (1 << RES_UNTIL),
3626 FLAG_DO = (1 << RES_DO ),
3627 FLAG_DONE = (1 << RES_DONE ),
3628 FLAG_IN = (1 << RES_IN ),
3630 #if ENABLE_HUSH_CASE
3631 FLAG_MATCH = (1 << RES_MATCH),
3632 FLAG_ESAC = (1 << RES_ESAC ),
3634 FLAG_START = (1 << RES_XXXX ),
3637 static const struct reserved_combo* match_reserved_word(o_string *word)
3639 /* Mostly a list of accepted follow-up reserved words.
3640 * FLAG_END means we are done with the sequence, and are ready
3641 * to turn the compound list into a command.
3642 * FLAG_START means the word must start a new compound list.
3644 static const struct reserved_combo reserved_list[] = {
3646 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3647 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
3648 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3649 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
3650 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
3651 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3653 #if ENABLE_HUSH_LOOPS
3654 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3655 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3656 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3657 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3658 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
3659 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3661 #if ENABLE_HUSH_CASE
3662 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3663 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3666 const struct reserved_combo *r;
3668 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3669 if (strcmp(word->data, r->literal) == 0)
3674 static int reserved_word(o_string *word, struct parse_context *ctx)
3676 #if ENABLE_HUSH_CASE
3677 static const struct reserved_combo reserved_match = {
3678 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3681 const struct reserved_combo *r;
3683 r = match_reserved_word(word);
3687 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3688 #if ENABLE_HUSH_CASE
3689 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE)
3690 /* "case word IN ..." - IN part starts first match part */
3691 r = &reserved_match;
3694 if (r->flag == 0) { /* '!' */
3695 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3696 syntax("! ! command");
3697 IF_HAS_KEYWORDS(ctx->ctx_res_w = RES_SNTX;)
3699 ctx->ctx_inverted = 1;
3702 if (r->flag & FLAG_START) {
3703 struct parse_context *old;
3704 old = xmalloc(sizeof(*old));
3705 debug_printf_parse("push stack %p\n", old);
3706 *old = *ctx; /* physical copy */
3707 initialize_context(ctx);
3709 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3711 ctx->ctx_res_w = RES_SNTX;
3714 ctx->ctx_res_w = r->res;
3715 ctx->old_flag = r->flag;
3716 if (ctx->old_flag & FLAG_END) {
3717 struct parse_context *old;
3718 done_pipe(ctx, PIPE_SEQ);
3719 debug_printf_parse("pop stack %p\n", ctx->stack);
3721 old->command->group = ctx->list_head;
3722 old->command->grp_type = GRP_NORMAL;
3724 o_addstr(&old->as_string, ctx->as_string.data);
3725 o_free_unsafe(&ctx->as_string);
3726 old->command->group_as_string = xstrdup(old->as_string.data);
3727 debug_printf_parse("pop, remembering as:'%s'\n",
3728 old->command->group_as_string);
3730 *ctx = *old; /* physical copy */
3733 word->o_assignment = r->assignment_flag;
3738 /* Word is complete, look at it and update parsing context.
3739 * Normal return is 0. Syntax errors return 1.
3740 * Note: on return, word is reset, but not o_free'd!
3742 static int done_word(o_string *word, struct parse_context *ctx)
3744 struct command *command = ctx->command;
3746 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3747 if (word->length == 0 && word->nonnull == 0) {
3748 debug_printf_parse("done_word return 0: true null, ignored\n");
3751 /* If this word wasn't an assignment, next ones definitely
3752 * can't be assignments. Even if they look like ones. */
3753 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3754 && word->o_assignment != WORD_IS_KEYWORD
3756 word->o_assignment = NOT_ASSIGNMENT;
3758 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3759 command->assignment_cnt++;
3760 word->o_assignment = MAYBE_ASSIGNMENT;
3763 if (ctx->pending_redirect) {
3764 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3765 * only if run as "bash", not "sh" */
3766 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3767 word->o_assignment = NOT_ASSIGNMENT;
3768 debug_printf("word stored in rd_filename: '%s'\n", word->data);
3770 /* "{ echo foo; } echo bar" - bad */
3771 /* NB: bash allows e.g.:
3772 * if true; then { echo foo; } fi
3773 * while if false; then false; fi do break; done
3775 if (command->group) {
3777 debug_printf_parse("done_word return 1: syntax error, "
3778 "groups and arglists don't mix\n");
3782 #if ENABLE_HUSH_CASE
3783 if (ctx->ctx_dsemicolon
3784 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3786 /* already done when ctx_dsemicolon was set to 1: */
3787 /* ctx->ctx_res_w = RES_MATCH; */
3788 ctx->ctx_dsemicolon = 0;
3791 if (!command->argv /* if it's the first word... */
3792 #if ENABLE_HUSH_LOOPS
3793 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3794 && ctx->ctx_res_w != RES_IN
3797 debug_printf_parse(": checking '%s' for reserved-ness\n", word->data);
3798 if (reserved_word(word, ctx)) {
3800 debug_printf_parse("done_word return %d\n",
3801 (ctx->ctx_res_w == RES_SNTX));
3802 return (ctx->ctx_res_w == RES_SNTX);
3806 if (word->nonnull /* word had "xx" or 'xx' at least as part of it. */
3807 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3808 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3809 /* (otherwise it's known to be not empty and is already safe) */
3811 /* exclude "$@" - it can expand to no word despite "" */
3812 char *p = word->data;
3813 while (p[0] == SPECIAL_VAR_SYMBOL
3814 && (p[1] & 0x7f) == '@'
3815 && p[2] == SPECIAL_VAR_SYMBOL
3819 if (p == word->data || p[0] != '\0') {
3820 /* saw no "$@", or not only "$@" but some
3821 * real text is there too */
3822 /* insert "empty variable" reference, this makes
3823 * e.g. "", $empty"" etc to not disappear */
3824 o_addchr(word, SPECIAL_VAR_SYMBOL);
3825 o_addchr(word, SPECIAL_VAR_SYMBOL);
3828 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3829 debug_print_strings("word appended to argv", command->argv);
3833 ctx->pending_redirect = NULL;
3835 #if ENABLE_HUSH_LOOPS
3836 /* Force FOR to have just one word (variable name) */
3837 /* NB: basically, this makes hush see "for v in ..." syntax as if
3838 * as it is "for v; in ...". FOR and IN become two pipe structs
3840 if (ctx->ctx_res_w == RES_FOR) {
3841 //TODO: check that command->argv[0] is a valid variable name!
3842 done_pipe(ctx, PIPE_SEQ);
3845 #if ENABLE_HUSH_CASE
3846 /* Force CASE to have just one word */
3847 if (ctx->ctx_res_w == RES_CASE) {
3848 done_pipe(ctx, PIPE_SEQ);
3851 debug_printf_parse("done_word return 0\n");
3855 /* If a redirect is immediately preceded by a number, that number is
3856 * supposed to tell which file descriptor to redirect. This routine
3857 * looks for such preceding numbers. In an ideal world this routine
3858 * needs to handle all the following classes of redirects...
3859 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3860 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3861 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3862 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3863 * A -1 output from this program means no valid number was found, so the
3864 * caller should use the appropriate default for this redirection.
3866 static int redirect_opt_num(o_string *o)
3872 for (num = 0; num < o->length; num++) {
3873 if (!isdigit(o->data[num])) {
3877 num = atoi(o->data);
3883 #define parse_stream(pstring, input, end_trigger) \
3884 parse_stream(input, end_trigger)
3886 static struct pipe *parse_stream(char **pstring,
3887 struct in_str *input,
3889 static void parse_and_run_string(const char *s);
3891 #if ENABLE_HUSH_TICK
3892 static FILE *generate_stream_from_string(const char *s)
3895 int pid, channel[2];
3898 pid = BB_MMU ? fork() : vfork();
3900 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3902 if (pid == 0) { /* child */
3903 /* Process substitution is not considered to be usual
3904 * 'command execution'.
3905 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
3912 if (ENABLE_HUSH_JOB)
3913 die_sleep = 0; /* let nofork's xfuncs die */
3914 close(channel[0]); /* NB: close _first_, then move fd! */
3915 xmove_fd(channel[1], 1);
3916 /* Prevent it from trying to handle ctrl-z etc */
3917 USE_HUSH_JOB(G.run_list_level = 1;)
3919 parse_and_run_string(s);
3920 _exit(G.last_return_code);
3922 /* We re-execute after vfork on NOMMU. This makes this script safe:
3923 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >TESTFILE
3924 * huge=`cat TESTFILE` # was blocking here forever
3927 re_execute_shell(s);
3932 clean_up_after_re_execute();
3934 pf = fdopen(channel[0], "r");
3938 /* Return code is exit status of the process that is run. */
3939 static int process_command_subs(o_string *dest, const char *s)
3942 struct in_str pipe_str;
3945 pf = generate_stream_from_string(s);
3948 close_on_exec_on(fileno(pf));
3950 /* Now send results of command back into original context */
3951 setup_file_in_str(&pipe_str, pf);
3953 while ((ch = i_getch(&pipe_str)) != EOF) {
3959 o_addchr(dest, '\n');
3962 o_addQchr(dest, ch);
3965 debug_printf("done reading from pipe, pclose()ing\n");
3966 /* Note: we got EOF, and we just close the read end of the pipe.
3967 * We do not wait for the `cmd` child to terminate. bash and ash do.
3969 * echo `echo Hi; exec 1>&-; sleep 2` - bash waits 2 sec
3970 * `false`; echo $? - bash outputs "1"
3973 debug_printf("closed FILE from child. return 0\n");
3978 static int parse_group(o_string *dest, struct parse_context *ctx,
3979 struct in_str *input, int ch)
3981 /* dest contains characters seen prior to ( or {.
3982 * Typically it's empty, but for function defs,
3983 * it contains function name (without '()'). */
3984 struct pipe *pipe_list;
3986 struct command *command = ctx->command;
3988 debug_printf_parse("parse_group entered\n");
3989 #if ENABLE_HUSH_FUNCTIONS
3990 if (ch == 'F') { /* function definition? */
3991 bb_error_msg("aha '%s' is a function, parsing it...", dest->data);
3992 //command->fname = dest->data;
3993 command->grp_type = GRP_FUNCTION;
3994 //TODO: review every o_reset() location... do they handle all o_string fields correctly?
3995 memset(dest, 0, sizeof(*dest));
3998 if (command->argv /* word [word](... */
3999 || dest->length /* word(... */
4000 || dest->nonnull /* ""(... */
4003 debug_printf_parse("parse_group return 1: "
4004 "syntax error, groups and arglists don't mix\n");
4010 command->grp_type = GRP_SUBSHELL;
4014 char *as_string = NULL;
4016 pipe_list = parse_stream(&as_string, input, endch);
4019 o_addstr(&ctx->as_string, as_string);
4021 /* empty ()/{} or parse error? */
4022 if (!pipe_list || pipe_list == ERR_PTR) {
4027 debug_printf_parse("parse_group return 1: "
4028 "parse_stream returned %p\n", pipe_list);
4031 command->group = pipe_list;
4033 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
4034 command->group_as_string = as_string;
4035 debug_printf_parse("end of group, remembering as:'%s'\n",
4036 command->group_as_string);
4039 debug_printf_parse("parse_group return 0\n");
4041 /* command remains "open", available for possible redirects */
4044 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
4045 /* Subroutines for copying $(...) and `...` things */
4046 static void add_till_backquote(o_string *dest, struct in_str *input);
4048 static void add_till_single_quote(o_string *dest, struct in_str *input)
4051 int ch = i_getch(input);
4059 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
4060 static void add_till_double_quote(o_string *dest, struct in_str *input)
4063 int ch = i_getch(input);
4066 if (ch == '\\') { /* \x. Copy both chars. */
4068 ch = i_getch(input);
4074 add_till_backquote(dest, input);
4078 //if (ch == '$') ...
4081 /* Process `cmd` - copy contents until "`" is seen. Complicated by
4083 * "Within the backquoted style of command substitution, backslash
4084 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
4085 * The search for the matching backquote shall be satisfied by the first
4086 * backquote found without a preceding backslash; during this search,
4087 * if a non-escaped backquote is encountered within a shell comment,
4088 * a here-document, an embedded command substitution of the $(command)
4089 * form, or a quoted string, undefined results occur. A single-quoted
4090 * or double-quoted string that begins, but does not end, within the
4091 * "`...`" sequence produces undefined results."
4093 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
4095 static void add_till_backquote(o_string *dest, struct in_str *input)
4098 int ch = i_getch(input);
4101 if (ch == '\\') { /* \x. Copy both chars unless it is \` */
4102 int ch2 = i_getch(input);
4103 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
4112 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
4113 * quoting and nested ()s.
4114 * "With the $(command) style of command substitution, all characters
4115 * following the open parenthesis to the matching closing parenthesis
4116 * constitute the command. Any valid shell script can be used for command,
4117 * except a script consisting solely of redirections which produces
4118 * unspecified results."
4120 * echo $(echo '(TEST)' BEST) (TEST) BEST
4121 * echo $(echo 'TEST)' BEST) TEST) BEST
4122 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
4124 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
4128 int ch = i_getch(input);
4137 if (i_peek(input) == ')') {
4145 add_till_single_quote(dest, input);
4150 add_till_double_quote(dest, input);
4154 if (ch == '\\') { /* \x. Copy verbatim. Important for \(, \) */
4155 ch = i_getch(input);
4163 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
4165 /* Return code: 0 for OK, 1 for syntax error */
4167 #define handle_dollar(ctx, dest, input) \
4168 handle_dollar(dest, input)
4170 static int handle_dollar(struct parse_context *ctx,
4172 struct in_str *input)
4175 int ch = i_peek(input); /* first character after the $ */
4176 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
4178 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
4180 ch = i_getch(input);
4182 if (ctx) o_addchr(&ctx->as_string, ch);
4185 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4187 debug_printf_parse(": '%c'\n", ch);
4188 o_addchr(dest, ch | quote_mask);
4191 if (!isalnum(ch) && ch != '_')
4193 ch = i_getch(input);
4195 if (ctx) o_addchr(&ctx->as_string, ch);
4198 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4199 } else if (isdigit(ch)) {
4201 ch = i_getch(input);
4203 if (ctx) o_addchr(&ctx->as_string, ch);
4205 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4206 debug_printf_parse(": '%c'\n", ch);
4207 o_addchr(dest, ch | quote_mask);
4208 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4209 } else switch (ch) {
4211 case '!': /* last bg pid */
4212 case '?': /* last exit code */
4213 case '#': /* number of args */
4214 case '*': /* args */
4215 case '@': /* args */
4216 goto make_one_char_var;
4218 bool first_char, all_digits;
4220 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4221 ch = i_getch(input);
4223 if (ctx) o_addchr(&ctx->as_string, ch);
4225 /* XXX maybe someone will try to escape the '}' */
4230 ch = i_getch(input);
4232 if (ctx) o_addchr(&ctx->as_string, ch);
4239 /* ${#var}: length of var contents */
4241 else if (isdigit(ch)) {
4248 && ( (all_digits && !isdigit(ch))
4249 || (!all_digits && !isalnum(ch) && ch != '_')
4252 /* handle parameter expansions
4253 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4258 case ':': /* null modifier */
4259 if (expansion == 0) {
4260 debug_printf_parse(": null modifier\n");
4265 #if 0 /* not implemented yet :( */
4266 case '#': /* remove prefix */
4267 case '%': /* remove suffix */
4268 if (expansion == 0) {
4269 debug_printf_parse(": remove suffix/prefix\n");
4275 case '-': /* default value */
4276 case '=': /* assign default */
4277 case '+': /* alternative */
4278 case '?': /* error indicate */
4279 debug_printf_parse(": parameter expansion\n");
4284 syntax("unterminated ${name}");
4285 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
4290 debug_printf_parse(": '%c'\n", ch);
4291 o_addchr(dest, ch | quote_mask);
4295 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4298 #if (ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK)
4303 ch = i_getch(input);
4305 if (ctx) o_addchr(&ctx->as_string, ch);
4307 # if ENABLE_SH_MATH_SUPPORT
4308 if (i_peek(input) == '(') {
4309 ch = i_getch(input);
4311 if (ctx) o_addchr(&ctx->as_string, ch);
4313 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4314 o_addchr(dest, /*quote_mask |*/ '+');
4318 add_till_closing_paren(dest, input, true);
4321 o_addstr(&ctx->as_string, dest->data + pos);
4322 o_addchr(&ctx->as_string, ')');
4323 o_addchr(&ctx->as_string, ')');
4326 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4330 # if ENABLE_HUSH_TICK
4331 //int pos = dest->length;
4332 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4333 o_addchr(dest, quote_mask | '`');
4337 add_till_closing_paren(dest, input, false);
4340 o_addstr(&ctx->as_string, dest->data + pos);
4341 o_addchr(&ctx->as_string, '`');
4344 //debug_printf_subst("SUBST RES2 '%s'\n", dest->data + pos);
4345 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4351 ch = i_getch(input);
4353 if (ctx) o_addchr(&ctx->as_string, ch);
4356 if (isalnum(ch)) { /* it's $_name or $_123 */
4362 /* $_ Shell or shell script name; or last cmd name */
4363 /* $- Option flags set by set builtin or shell options (-i etc) */
4365 o_addQchr(dest, '$');
4367 debug_printf_parse("handle_dollar return 0\n");
4372 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
4373 parse_stream_dquoted(dest, input, dquote_end)
4375 static int parse_stream_dquoted(struct parse_context *ctx,
4377 struct in_str *input,
4384 ch = i_getch(input);
4386 if (ctx && ch != EOF)
4387 o_addchr(&ctx->as_string, ch);
4389 if (ch == dquote_end) { /* may be only '"' or EOF */
4391 if (dest->o_assignment == NOT_ASSIGNMENT)
4392 dest->o_escape ^= 1;
4393 debug_printf_parse("parse_stream_dquoted return 0\n");
4397 syntax("unterminated \"");
4398 debug_printf_parse("parse_stream_dquoted return 1: unterminated \"\n");
4403 next = i_peek(input);
4405 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4406 ch, ch, dest->o_escape);
4410 debug_printf_parse("parse_stream_dquoted return 1: \\<eof>\n");
4414 * "The backslash retains its special meaning [in "..."]
4415 * only when followed by one of the following characters:
4416 * $, `, ", \, or <newline>. A double quote may be quoted
4417 * within double quotes by preceding it with a backslash.
4418 * If enabled, history expansion will be performed unless
4419 * an ! appearing in double quotes is escaped using
4420 * a backslash. The backslash preceding the ! is not removed."
4422 if (strchr("$`\"\\", next) != NULL) {
4423 o_addqchr(dest, i_getch(input));
4425 o_addqchr(dest, '\\');
4430 if (handle_dollar(ctx, dest, input) != 0) {
4431 debug_printf_parse("parse_stream_dquoted return 1: "
4432 "handle_dollar returned non-0\n");
4437 #if ENABLE_HUSH_TICK
4439 //int pos = dest->length;
4440 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4441 o_addchr(dest, 0x80 | '`');
4442 add_till_backquote(dest, input);
4443 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4444 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4448 o_addQchr(dest, ch);
4450 && (dest->o_assignment == MAYBE_ASSIGNMENT
4451 || dest->o_assignment == WORD_IS_KEYWORD)
4452 && is_assignment(dest->data)
4454 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4460 * Scan input until EOF or end_trigger char.
4461 * Return a list of pipes to execute, or NULL on EOF
4462 * or if end_trigger character is met.
4463 * On syntax error, exit is shell is not interactive,
4464 * reset parsing machinery and start parsing anew,
4465 * or return ERR_PTR.
4467 static struct pipe *parse_stream(char **pstring,
4468 struct in_str *input,
4471 struct parse_context ctx;
4472 o_string dest = NULL_O_STRING;
4475 /* Double-quote state is handled in the state variable is_in_dquote.
4476 * A single-quote triggers a bypass of the main loop until its mate is
4477 * found. When recursing, quote state is passed in via dest->o_escape.
4479 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4480 end_trigger ? : 'X');
4482 G.ifs = get_local_var_value("IFS");
4487 #if ENABLE_HUSH_INTERACTIVE
4488 input->promptmode = 0; /* PS1 */
4490 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
4491 initialize_context(&ctx);
4495 const char *is_special;
4499 redir_type redir_style;
4502 if (parse_stream_dquoted(&ctx, &dest, input, '"')) {
4505 /* We reached closing '"' */
4508 ch = i_getch(input);
4509 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4510 ch, ch, dest.o_escape);
4513 if (done_word(&dest, &ctx)) {
4517 done_pipe(&ctx, PIPE_SEQ);
4519 /* If we got nothing... */
4520 // TODO: test script consisting of just "&"
4521 if (pi->num_cmds == 0
4522 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
4524 free_pipe_list(pi, 0);
4527 debug_printf_parse("parse_stream return %p\n", pi);
4529 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4531 *pstring = ctx.as_string.data;
4533 o_free_unsafe(&ctx.as_string);
4538 o_addchr(&ctx.as_string, ch);
4540 is_ifs = strchr(G.ifs, ch);
4541 is_special = strchr("<>;&|(){}#'" /* special outside of "str" */
4542 "\\$\"" USE_HUSH_TICK("`") /* always special */
4545 if (!is_special && !is_ifs) { /* ordinary char */
4546 o_addQchr(&dest, ch);
4547 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4548 || dest.o_assignment == WORD_IS_KEYWORD)
4550 && is_assignment(dest.data)
4552 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4558 if (done_word(&dest, &ctx)) {
4562 #if ENABLE_HUSH_CASE
4563 /* "case ... in <newline> word) ..." -
4564 * newlines are ignored (but ';' wouldn't be) */
4565 if (ctx.command->argv == NULL
4566 && ctx.ctx_res_w == RES_MATCH
4571 /* Treat newline as a command separator. */
4572 done_pipe(&ctx, PIPE_SEQ);
4573 dest.o_assignment = MAYBE_ASSIGNMENT;
4575 /* note: if (is_ifs) continue;
4576 * will still trigger for us */
4579 if (end_trigger && end_trigger == ch) {
4580 //TODO: disallow "{ cmd }" without semicolon
4581 if (done_word(&dest, &ctx)) {
4584 done_pipe(&ctx, PIPE_SEQ);
4585 dest.o_assignment = MAYBE_ASSIGNMENT;
4586 /* Do we sit outside of any if's, loops or case's? */
4588 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4590 debug_printf_parse("parse_stream return %p: "
4591 "end_trigger char found\n",
4595 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4597 *pstring = ctx.as_string.data;
4599 o_free_unsafe(&ctx.as_string);
4601 return ctx.list_head;
4607 if (dest.o_assignment == MAYBE_ASSIGNMENT) {
4608 /* ch is a special char and thus this word
4609 * cannot be an assignment */
4610 dest.o_assignment = NOT_ASSIGNMENT;
4615 next = i_peek(input);
4620 if (dest.length == 0) {
4623 if (ch == EOF || ch == '\n')
4626 /* note: we do not add it to &ctx.as_string */
4629 //TODO: go back one char?
4630 o_addchr(&ctx.as_string, '\n');
4633 o_addQchr(&dest, ch);
4641 o_addchr(&dest, '\\');
4642 ch = i_getch(input);
4643 o_addchr(&dest, ch);
4645 o_addchr(&ctx.as_string, ch);
4650 if (handle_dollar(&ctx, &dest, input) != 0) {
4651 debug_printf_parse("parse_stream parse error: "
4652 "handle_dollar returned non-0\n");
4659 ch = i_getch(input);
4661 syntax("unterminated '");
4665 o_addchr(&ctx.as_string, ch);
4669 if (dest.o_assignment == NOT_ASSIGNMENT)
4670 o_addqchr(&dest, ch);
4672 o_addchr(&dest, ch);
4677 is_in_dquote ^= 1; /* invert */
4678 if (dest.o_assignment == NOT_ASSIGNMENT)
4681 #if ENABLE_HUSH_TICK
4683 //int pos = dest.length;
4684 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4685 o_addchr(&dest, '`');
4686 add_till_backquote(&dest, input);
4687 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4688 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4693 redir_fd = redirect_opt_num(&dest);
4694 if (done_word(&dest, &ctx)) {
4697 redir_style = REDIRECT_OVERWRITE;
4699 redir_style = REDIRECT_APPEND;
4700 ch = i_getch(input);
4702 o_addchr(&ctx.as_string, ch);
4706 else if (next == '(') {
4707 syntax(">(process) not supported");
4711 setup_redirect(&ctx, redir_fd, redir_style, input);
4714 redir_fd = redirect_opt_num(&dest);
4715 if (done_word(&dest, &ctx)) {
4718 redir_style = REDIRECT_INPUT;
4720 redir_style = REDIRECT_HEREIS;
4721 ch = i_getch(input);
4723 o_addchr(&ctx.as_string, ch);
4725 } else if (next == '>') {
4726 redir_style = REDIRECT_IO;
4727 ch = i_getch(input);
4729 o_addchr(&ctx.as_string, ch);
4733 else if (next == '(') {
4734 syntax("<(process) not supported");
4738 setup_redirect(&ctx, redir_fd, redir_style, input);
4741 #if ENABLE_HUSH_CASE
4744 if (done_word(&dest, &ctx)) {
4747 done_pipe(&ctx, PIPE_SEQ);
4748 #if ENABLE_HUSH_CASE
4749 /* Eat multiple semicolons, detect
4750 * whether it means something special */
4755 ch = i_getch(input);
4757 o_addchr(&ctx.as_string, ch);
4759 if (ctx.ctx_res_w == RES_CASEI) {
4760 ctx.ctx_dsemicolon = 1;
4761 ctx.ctx_res_w = RES_MATCH;
4767 /* We just finished a cmd. New one may start
4768 * with an assignment */
4769 dest.o_assignment = MAYBE_ASSIGNMENT;
4772 if (done_word(&dest, &ctx)) {
4776 ch = i_getch(input);
4778 o_addchr(&ctx.as_string, ch);
4780 done_pipe(&ctx, PIPE_AND);
4782 done_pipe(&ctx, PIPE_BG);
4786 if (done_word(&dest, &ctx)) {
4789 #if ENABLE_HUSH_CASE
4790 if (ctx.ctx_res_w == RES_MATCH)
4791 break; /* we are in case's "word | word)" */
4793 if (next == '|') { /* || */
4794 ch = i_getch(input);
4796 o_addchr(&ctx.as_string, ch);
4798 done_pipe(&ctx, PIPE_OR);
4800 /* we could pick up a file descriptor choice here
4801 * with redirect_opt_num(), but bash doesn't do it.
4802 * "echo foo 2| cat" yields "foo 2". */
4807 #if ENABLE_HUSH_CASE
4808 /* "case... in [(]word)..." - skip '(' */
4809 if (ctx.ctx_res_w == RES_MATCH
4810 && ctx.command->argv == NULL /* not (word|(... */
4811 && dest.length == 0 /* not word(... */
4812 && dest.nonnull == 0 /* not ""(... */
4817 #if ENABLE_HUSH_FUNCTIONS
4818 if (dest.length != 0 /* not just () but word() */
4819 && dest.nonnull == 0 /* not a"b"c() */
4820 && ctx.command->argv == NULL /* it's the first word */
4821 //TODO: "func ( ) {...}" - note spaces - is valid format too in bash
4822 && i_peek(input) == ')'
4823 && !match_reserved_word(&dest)
4825 bb_error_msg("seems like a function definition");
4827 //if !BB_MMU o_addchr(&ctx.as_string...
4829 //TODO: do it properly.
4830 ch = i_getch(input);
4831 } while (ch == ' ' || ch == '\n');
4833 syntax("was expecting {");
4836 ch = 'F'; /* magic value */
4840 if (parse_group(&dest, &ctx, input, ch) != 0) {
4845 #if ENABLE_HUSH_CASE
4846 if (ctx.ctx_res_w == RES_MATCH)
4850 /* proper use of this character is caught by end_trigger:
4851 * if we see {, we call parse_group(..., end_trigger='}')
4852 * and it will match } earlier (not here). */
4853 syntax("unexpected } or )");
4857 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4863 struct parse_context *pctx;
4864 IF_HAS_KEYWORDS(struct parse_context *p2;)
4866 /* Clean up allocated tree.
4867 * Samples for finding leaks on syntax error recovery path.
4868 * Run them from interactive shell, watch pmap `pidof hush`.
4869 * while if false; then false; fi do break; done
4871 * while if false; then false; fi; do break; fi
4872 * Samples to catch leaks at execution:
4873 * while if (true | {true;}); then echo ok; fi; do break; done
4874 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
4878 /* Update pipe/command counts,
4879 * otherwise freeing may miss some */
4880 done_pipe(pctx, PIPE_SEQ);
4881 debug_printf_clean("freeing list %p from ctx %p\n",
4882 pctx->list_head, pctx);
4883 debug_print_tree(pctx->list_head, 0);
4884 free_pipe_list(pctx->list_head, 0);
4885 debug_printf_clean("freed list %p\n", pctx->list_head);
4887 o_free_unsafe(&pctx->as_string);
4889 IF_HAS_KEYWORDS(p2 = pctx->stack;)
4893 IF_HAS_KEYWORDS(pctx = p2;)
4894 } while (HAS_KEYWORDS && pctx);
4895 /* Free text, clear all dest fields */
4897 /* If we are not in top-level parse, we return,
4898 * our caller will propagate error.
4900 if (end_trigger != ';') {
4907 /* Discard cached input, force prompt */
4909 USE_HUSH_INTERACTIVE(input->promptme = 1;)
4914 /* Executing from string: eval, sh -c '...'
4915 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
4916 * end_trigger controls how often we stop parsing
4917 * NUL: parse all, execute, return
4918 * ';': parse till ';' or newline, execute, repeat till EOF
4920 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
4923 struct pipe *pipe_list;
4925 pipe_list = parse_stream(NULL, inp, end_trigger);
4926 if (!pipe_list) /* EOF */
4928 debug_print_tree(pipe_list, 0);
4929 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
4930 run_and_free_list(pipe_list);
4934 static void parse_and_run_string(const char *s)
4936 struct in_str input;
4937 setup_string_in_str(&input, s);
4938 parse_and_run_stream(&input, '\0');
4941 static void parse_and_run_file(FILE *f)
4943 struct in_str input;
4944 setup_file_in_str(&input, f);
4945 parse_and_run_stream(&input, ';');
4949 /* Make sure we have a controlling tty. If we get started under a job
4950 * aware app (like bash for example), make sure we are now in charge so
4951 * we don't fight over who gets the foreground */
4952 static void setup_job_control(void)
4956 shell_pgrp = getpgrp();
4958 /* If we were ran as 'hush &',
4959 * sleep until we are in the foreground. */
4960 while (tcgetpgrp(G_interactive_fd) != shell_pgrp) {
4961 /* Send TTIN to ourself (should stop us) */
4962 kill(- shell_pgrp, SIGTTIN);
4963 shell_pgrp = getpgrp();
4966 /* We _must_ restore tty pgrp on fatal signals */
4967 set_fatal_signals_to_sigexit();
4969 /* Put ourselves in our own process group. */
4970 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
4971 /* Grab control of the terminal. */
4972 tcsetpgrp(G_interactive_fd, getpid());
4976 static int set_mode(const char cstate, const char mode)
4978 int state = (cstate == '-' ? 1 : 0);
4980 case 'n': G.fake_mode = state; break;
4981 case 'x': /*G.debug_mode = state;*/ break;
4982 default: return EXIT_FAILURE;
4984 return EXIT_SUCCESS;
4987 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4988 int hush_main(int argc, char **argv)
4990 static const struct variable const_shell_ver = {
4992 .varstr = (char*)hush_version_str,
4993 .max_len = 1, /* 0 can provoke free(name) */
5000 struct variable *cur_var;
5003 if (EXIT_SUCCESS) /* if EXIT_SUCCESS == 0, is already done */
5004 G.last_return_code = EXIT_SUCCESS;
5006 G.argv0_for_re_execing = argv[0];
5008 /* Deal with HUSH_VERSION */
5009 G.shell_ver = const_shell_ver; /* copying struct here */
5010 G.top_var = &G.shell_ver;
5011 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
5012 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
5013 /* Initialize our shell local variables with the values
5014 * currently living in the environment */
5015 cur_var = G.top_var;
5018 char *value = strchr(*e, '=');
5019 if (value) { /* paranoia */
5020 cur_var->next = xzalloc(sizeof(*cur_var));
5021 cur_var = cur_var->next;
5022 cur_var->varstr = *e;
5023 cur_var->max_len = strlen(*e);
5024 cur_var->flg_export = 1;
5028 debug_printf_env("putenv '%s'\n", hush_version_str);
5029 putenv((char *)hush_version_str); /* reinstate HUSH_VERSION */
5030 #if ENABLE_FEATURE_EDITING
5031 G.line_input_state = new_line_input_t(FOR_SHELL);
5033 G.global_argc = argc;
5034 G.global_argv = argv;
5035 /* Initialize some more globals to non-zero values */
5037 #if ENABLE_HUSH_INTERACTIVE
5038 if (ENABLE_FEATURE_EDITING)
5039 cmdedit_set_initial_prompt();
5043 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
5045 opt = getopt(argc, argv, "c:xins"
5055 G.root_pid = getpid();
5056 G.global_argv = argv + optind;
5057 if (!argv[optind]) {
5058 /* -c 'script' (no params): prevent empty $0 */
5059 *--G.global_argv = argv[0];
5061 } /* else -c 'script' PAR0 PAR1: $0 is PAR0 */
5062 G.global_argc = argc - optind;
5063 parse_and_run_string(optarg);
5066 /* Well, we cannot just declare interactiveness,
5067 * we have to have some stuff (ctty, etc) */
5068 /* G_interactive_fd++; */
5071 /* "-s" means "read from stdin", but this is how we always
5072 * operate, so simply do nothing here. */
5076 G.root_pid = xatoi_u(optarg);
5079 G.last_bg_pid = xatoi_u(optarg);
5082 G.last_return_code = xatoi_u(optarg);
5084 #if ENABLE_HUSH_LOOPS
5086 G.depth_of_loop = xatoi_u(optarg);
5091 set_local_var(xstrdup(optarg), 0, opt == 'R');
5096 if (!set_mode('-', opt))
5100 fprintf(stderr, "Usage: sh [FILE]...\n"
5101 " or: sh -c command [args]...\n\n");
5110 G.root_pid = getpid();
5111 if (argv[0] && argv[0][0] == '-') {
5113 /* XXX what should argv be while sourcing /etc/profile? */
5114 debug_printf("sourcing /etc/profile\n");
5115 input = fopen_for_read("/etc/profile");
5116 if (input != NULL) {
5117 close_on_exec_on(fileno(input));
5118 parse_and_run_file(input);
5124 /* A shell is interactive if the '-i' flag was given, or if all of
5125 * the following conditions are met:
5127 * no arguments remaining or the -s flag given
5128 * standard input is a terminal
5129 * standard output is a terminal
5130 * Refer to Posix.2, the description of the 'sh' utility. */
5131 if (argv[optind] == NULL
5132 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5134 G.saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
5135 debug_printf("saved_tty_pgrp=%d\n", G.saved_tty_pgrp);
5136 if (G.saved_tty_pgrp >= 0) {
5137 /* try to dup to high fd#, >= 255 */
5138 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5139 if (G_interactive_fd < 0) {
5140 /* try to dup to any fd */
5141 G_interactive_fd = dup(STDIN_FILENO);
5142 if (G_interactive_fd < 0)
5144 G_interactive_fd = 0;
5146 // TODO: track & disallow any attempts of user
5147 // to (inadvertently) close/redirect it
5150 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5151 debug_printf("interactive_fd=%d\n", G_interactive_fd);
5152 if (G_interactive_fd) {
5153 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5154 /* Looks like they want an interactive shell */
5155 setup_job_control();
5156 /* -1 is special - makes xfuncs longjmp, not exit
5157 * (we reset die_sleep = 0 whereever we [v]fork) */
5159 if (setjmp(die_jmp)) {
5160 /* xfunc has failed! die die die */
5161 hush_exit(xfunc_error_retval);
5164 #elif ENABLE_HUSH_INTERACTIVE
5165 /* no job control compiled, only prompt/line editing */
5166 if (argv[optind] == NULL
5167 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5169 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5170 if (G_interactive_fd < 0) {
5171 /* try to dup to any fd */
5172 G_interactive_fd = dup(STDIN_FILENO);
5173 if (G_interactive_fd < 0)
5175 G_interactive_fd = 0;
5177 if (G_interactive_fd) {
5178 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5181 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5183 //TODO: we didn't do it for -c or /etc/profile! Shouldn't we?
5186 /* POSIX allows shell to re-enable SIGCHLD
5187 * even if it was SIG_IGN on entry */
5188 //TODO: we didn't do it for -c or /etc/profile! Shouldn't we?
5189 // G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
5190 signal(SIGCHLD, SIG_DFL); // SIGCHLD_handler);
5192 #if ENABLE_HUSH_INTERACTIVE && !ENABLE_FEATURE_SH_EXTRA_QUIET
5193 if (G_interactive_fd) {
5194 printf("\n\n%s hush - the humble shell v"HUSH_VER_STR"\n", bb_banner);
5195 printf("Enter 'help' for a list of built-in commands.\n\n");
5199 if (argv[optind] == NULL) {
5200 parse_and_run_file(stdin);
5203 debug_printf("\nrunning script '%s'\n", argv[optind]);
5204 G.global_argv = argv + optind;
5205 G.global_argc = argc - optind;
5206 input = xfopen_for_read(argv[optind]);
5207 fcntl(fileno(input), F_SETFD, FD_CLOEXEC);
5208 parse_and_run_file(input);
5209 #if ENABLE_FEATURE_CLEAN_UP
5216 #if ENABLE_FEATURE_CLEAN_UP
5217 if (G.cwd != bb_msg_unknown)
5219 cur_var = G.top_var->next;
5221 struct variable *tmp = cur_var;
5222 if (!cur_var->max_len)
5223 free(cur_var->varstr);
5224 cur_var = cur_var->next;
5228 hush_exit(G.last_return_code);
5233 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
5234 int lash_main(int argc, char **argv)
5236 //bb_error_msg("lash is deprecated, please use hush instead");
5237 return hush_main(argc, argv);
5245 static int builtin_trap(char **argv)
5252 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
5255 /* No args: print all trapped. This isn't 100% correct as we should
5256 * be escaping the cmd so that it can be pasted back in ...
5258 for (i = 0; i < NSIG; ++i)
5260 printf("trap -- '%s' %s\n", G.traps[i], get_signame(i));
5261 return EXIT_SUCCESS;
5266 /* if first arg is decimal: reset all specified */
5267 sig = bb_strtou(*++argv, NULL, 10);
5273 sig = get_signum(*argv++);
5274 if (sig < 0 || sig >= NSIG) {
5276 /* mimic bash message exactly */
5277 bb_perror_msg("trap: %s: invalid signal specification", argv[i]);
5282 G.traps[sig] = xstrdup(new_cmd);
5284 debug_printf("trap: setting SIG%s (%i) to '%s'",
5285 get_signame(sig), sig, G.traps[sig]);
5287 /* There is no signal for 0 (EXIT) */
5292 sigaddset(&G.blocked_set, sig);
5294 /* there was a trap handler, we are removing it
5295 * (if sig has non-DFL handling,
5296 * we don't need to do anything) */
5297 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
5299 sigdelset(&G.blocked_set, sig);
5301 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5306 /* first arg is "-": reset all specified to default */
5307 /* first arg is "": ignore all specified */
5308 /* everything else: execute first arg upon signal */
5310 bb_error_msg("trap: invalid arguments");
5311 return EXIT_FAILURE;
5313 if (LONE_DASH(*argv))
5321 static int builtin_true(char **argv UNUSED_PARAM)
5326 static int builtin_test(char **argv)
5333 return test_main(argc, argv - argc);
5336 static int builtin_echo(char **argv)
5343 return echo_main(argc, argv - argc);
5346 static int builtin_eval(char **argv)
5348 int rcode = EXIT_SUCCESS;
5351 char *str = expand_strvec_to_string(argv + 1);
5353 * eval "echo Hi; done" ("done" is syntax error):
5354 * "echo Hi" will not execute too.
5356 parse_and_run_string(str);
5358 rcode = G.last_return_code;
5363 static int builtin_cd(char **argv)
5366 if (argv[1] == NULL) {
5367 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
5368 * bash says "bash: cd: HOME not set" and does nothing (exitcode 1)
5370 newdir = getenv("HOME") ? : "/";
5373 if (chdir(newdir)) {
5374 printf("cd: %s: %s\n", newdir, strerror(errno));
5375 return EXIT_FAILURE;
5378 return EXIT_SUCCESS;
5381 static int builtin_exec(char **argv)
5383 if (argv[1] == NULL)
5384 return EXIT_SUCCESS; /* bash does this */
5389 // FIXME: if exec fails, bash does NOT exit! We do...
5390 pseudo_exec_argv(&dummy, argv + 1, 0, NULL);
5395 static int builtin_exit(char **argv)
5397 // TODO: bash does it ONLY on top-level sh exit (+interacive only?)
5398 //puts("exit"); /* bash does it */
5399 // TODO: warn if we have background jobs: "There are stopped jobs"
5400 // On second consecutive 'exit', exit anyway.
5401 if (argv[1] == NULL)
5402 hush_exit(G.last_return_code);
5403 /* mimic bash: exit 123abc == exit 255 + error msg */
5404 xfunc_error_retval = 255;
5405 /* bash: exit -2 == exit 254, no error msg */
5406 hush_exit(xatoi(argv[1]) & 0xff);
5409 static int builtin_export(char **argv)
5412 char *name = argv[1];
5416 // ash emits: export VAR='VAL'
5417 // bash: declare -x VAR="VAL"
5418 // (both also escape as needed (quotes, $, etc))
5423 return EXIT_SUCCESS;
5426 value = strchr(name, '=');
5428 /* They are exporting something without a =VALUE */
5429 struct variable *var;
5431 var = get_local_var(name);
5433 var->flg_export = 1;
5434 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
5435 putenv(var->varstr);
5437 /* bash does not return an error when trying to export
5438 * an undefined variable. Do likewise. */
5439 return EXIT_SUCCESS;
5442 set_local_var(xstrdup(name), 1, 0);
5443 return EXIT_SUCCESS;
5447 /* built-in 'fg' and 'bg' handler */
5448 static int builtin_fg_bg(char **argv)
5453 if (!G_interactive_fd)
5454 return EXIT_FAILURE;
5455 /* If they gave us no args, assume they want the last backgrounded task */
5457 for (pi = G.job_list; pi; pi = pi->next) {
5458 if (pi->jobid == G.last_jobid) {
5462 bb_error_msg("%s: no current job", argv[0]);
5463 return EXIT_FAILURE;
5465 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
5466 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
5467 return EXIT_FAILURE;
5469 for (pi = G.job_list; pi; pi = pi->next) {
5470 if (pi->jobid == jobnum) {
5474 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
5475 return EXIT_FAILURE;
5477 // TODO: bash prints a string representation
5478 // of job being foregrounded (like "sleep 1 | cat")
5479 if (argv[0][0] == 'f') {
5480 /* Put the job into the foreground. */
5481 tcsetpgrp(G_interactive_fd, pi->pgrp);
5484 /* Restart the processes in the job */
5485 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
5486 for (i = 0; i < pi->num_cmds; i++) {
5487 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
5488 pi->cmds[i].is_stopped = 0;
5490 pi->stopped_cmds = 0;
5492 i = kill(- pi->pgrp, SIGCONT);
5494 if (errno == ESRCH) {
5495 delete_finished_bg_job(pi);
5496 return EXIT_SUCCESS;
5498 bb_perror_msg("kill (SIGCONT)");
5501 if (argv[0][0] == 'f') {
5503 return checkjobs_and_fg_shell(pi);
5505 return EXIT_SUCCESS;
5509 #if ENABLE_HUSH_HELP
5510 static int builtin_help(char **argv UNUSED_PARAM)
5512 const struct built_in_command *x;
5515 "Built-in commands:\n"
5516 "------------------\n");
5517 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
5518 printf("%s\t%s\n", x->cmd, x->descr);
5521 return EXIT_SUCCESS;
5526 static int builtin_jobs(char **argv UNUSED_PARAM)
5529 const char *status_string;
5531 for (job = G.job_list; job; job = job->next) {
5532 if (job->alive_cmds == job->stopped_cmds)
5533 status_string = "Stopped";
5535 status_string = "Running";
5537 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
5539 return EXIT_SUCCESS;
5543 static int builtin_pwd(char **argv UNUSED_PARAM)
5546 return EXIT_SUCCESS;
5549 static int builtin_read(char **argv)
5552 const char *name = argv[1] ? argv[1] : "REPLY";
5554 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
5555 return set_local_var(string, 0, 0);
5558 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
5559 * built-in 'set' handler
5561 * set [-abCefhmnuvx] [-o option] [argument...]
5562 * set [+abCefhmnuvx] [+o option] [argument...]
5563 * set -- [argument...]
5566 * Implementations shall support the options in both their hyphen and
5567 * plus-sign forms. These options can also be specified as options to sh.
5569 * Write out all variables and their values: set
5570 * Set $1, $2, and $3 and set "$#" to 3: set c a b
5571 * Turn on the -x and -v options: set -xv
5572 * Unset all positional parameters: set --
5573 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
5574 * Set the positional parameters to the expansion of x, even if x expands
5575 * with a leading '-' or '+': set -- $x
5577 * So far, we only support "set -- [argument...]" and some of the short names.
5579 static int builtin_set(char **argv)
5582 char **pp, **g_argv;
5583 char *arg = *++argv;
5587 for (e = G.top_var; e; e = e->next)
5589 return EXIT_SUCCESS;
5593 if (!strcmp(arg, "--")) {
5598 if (arg[0] == '+' || arg[0] == '-') {
5599 for (n = 1; arg[n]; ++n)
5600 if (set_mode(arg[0], arg[n]))
5606 } while ((arg = *++argv) != NULL);
5607 /* Now argv[0] is 1st argument */
5609 /* Only reset global_argv if we didn't process anything */
5611 return EXIT_SUCCESS;
5614 /* NB: G.global_argv[0] ($0) is never freed/changed */
5615 g_argv = G.global_argv;
5616 if (G.global_args_malloced) {
5622 G.global_args_malloced = 1;
5623 pp = xzalloc(sizeof(pp[0]) * 2);
5624 pp[0] = g_argv[0]; /* retain $0 */
5627 /* This realloc's G.global_argv */
5628 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
5635 return EXIT_SUCCESS;
5637 /* Nothing known, so abort */
5639 bb_error_msg("set: %s: invalid option", arg);
5640 return EXIT_FAILURE;
5643 static int builtin_shift(char **argv)
5649 if (n >= 0 && n < G.global_argc) {
5650 if (G.global_args_malloced) {
5653 free(G.global_argv[m++]);
5656 memmove(&G.global_argv[1], &G.global_argv[n+1],
5657 G.global_argc * sizeof(G.global_argv[0]));
5658 return EXIT_SUCCESS;
5660 return EXIT_FAILURE;
5663 static int builtin_source(char **argv)
5667 if (argv[1] == NULL)
5668 return EXIT_FAILURE;
5670 /* XXX search through $PATH is missing */
5671 input = fopen_for_read(argv[1]);
5673 bb_error_msg("can't open '%s'", argv[1]);
5674 return EXIT_FAILURE;
5676 close_on_exec_on(fileno(input));
5678 /* Now run the file */
5679 /* XXX argv and argc are broken; need to save old G.global_argv
5680 * (pointer only is OK!) on this stack frame,
5681 * set G.global_argv=argv+1, recurse, and restore. */
5682 parse_and_run_file(input);
5684 return G.last_return_code;
5687 static int builtin_umask(char **argv)
5690 const char *arg = argv[1];
5692 new_umask = bb_strtou(arg, NULL, 8);
5694 return EXIT_FAILURE;
5696 new_umask = umask(0);
5697 printf("%.3o\n", (unsigned) new_umask);
5700 return EXIT_SUCCESS;
5703 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
5704 static int builtin_unset(char **argv)
5711 return EXIT_SUCCESS;
5714 if (argv[1][0] == '-') {
5715 switch (argv[1][1]) {
5717 case 'f': if (ENABLE_HUSH_FUNCTIONS) { var = false; break; }
5719 bb_error_msg("unset: %s: invalid option", argv[1]);
5720 return EXIT_FAILURE;
5728 if (unset_local_var(argv[i]))
5731 #if ENABLE_HUSH_FUNCTIONS
5733 unset_local_func(argv[i]);
5739 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
5740 static int builtin_wait(char **argv)
5742 int ret = EXIT_SUCCESS;
5745 if (*++argv == NULL) {
5746 /* Don't care about wait results */
5747 /* Note 1: must wait until there are no more children */
5748 /* Note 2: must be interruptible */
5750 * $ sleep 3 & sleep 6 & wait
5755 * $ sleep 3 & sleep 6 & wait
5759 * ^C <-- after ~4 sec from keyboard
5762 sigaddset(&G.blocked_set, SIGCHLD);
5763 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5766 if (errno == ECHILD)
5768 /* Wait for SIGCHLD or any other signal of interest */
5769 /* sigtimedwait with infinite timeout: */
5770 sig = sigwaitinfo(&G.blocked_set, NULL);
5772 sig = check_and_run_traps(sig);
5773 if (sig && sig != SIGCHLD) { /* see note 2 */
5779 sigdelset(&G.blocked_set, SIGCHLD);
5780 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5784 /* This is probably buggy wrt interruptible-ness */
5786 pid_t pid = bb_strtou(*argv, NULL, 10);
5788 /* mimic bash message */
5789 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
5790 return EXIT_FAILURE;
5792 if (waitpid(pid, &status, 0) == pid) {
5793 if (WIFSIGNALED(status))
5794 ret = 128 + WTERMSIG(status);
5795 else if (WIFEXITED(status))
5796 ret = WEXITSTATUS(status);
5800 bb_perror_msg("wait %s", *argv);
5809 #if ENABLE_HUSH_LOOPS
5810 static int builtin_break(char **argv)
5812 if (G.depth_of_loop == 0) {
5813 bb_error_msg("%s: only meaningful in a loop", argv[0]);
5814 return EXIT_SUCCESS; /* bash compat */
5816 G.flag_break_continue++; /* BC_BREAK = 1 */
5817 G.depth_break_continue = 1;
5819 G.depth_break_continue = bb_strtou(argv[1], NULL, 10);
5820 if (errno || !G.depth_break_continue || argv[2]) {
5821 bb_error_msg("%s: bad arguments", argv[0]);
5822 G.flag_break_continue = BC_BREAK;
5823 G.depth_break_continue = UINT_MAX;
5826 if (G.depth_of_loop < G.depth_break_continue)
5827 G.depth_break_continue = G.depth_of_loop;
5828 return EXIT_SUCCESS;
5831 static int builtin_continue(char **argv)
5833 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
5834 return builtin_break(argv);