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 **argv_for_re_execing;
492 #if ENABLE_HUSH_LOOPS
493 unsigned depth_break_continue;
494 unsigned depth_of_loop;
498 struct variable *top_var; /* = &G.shell_ver (set in main()) */
499 struct variable shell_ver;
500 /* Signal and trap handling */
501 // unsigned count_SIGCHLD;
502 // unsigned handled_SIGCHLD;
503 /* which signals have non-DFL handler (even with no traps set)? */
504 unsigned non_DFL_mask;
505 char **traps; /* char *traps[NSIG] */
506 sigset_t blocked_set;
507 sigset_t inherited_set;
508 char user_input_buf[ENABLE_FEATURE_EDITING ? BUFSIZ : 2];
509 #if ENABLE_FEATURE_SH_STANDALONE
510 struct nofork_save_area nofork_save;
513 sigjmp_buf toplevel_jb;
516 #define G (*ptr_to_globals)
517 /* Not #defining name to G.name - this quickly gets unwieldy
518 * (too many defines). Also, I actually prefer to see when a variable
519 * is global, thus "G." prefix is a useful hint */
520 #define INIT_G() do { \
521 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
525 /* Function prototypes for builtins */
526 static int builtin_cd(char **argv);
527 static int builtin_echo(char **argv);
528 static int builtin_eval(char **argv);
529 static int builtin_exec(char **argv);
530 static int builtin_exit(char **argv);
531 static int builtin_export(char **argv);
533 static int builtin_fg_bg(char **argv);
534 static int builtin_jobs(char **argv);
537 static int builtin_help(char **argv);
539 static int builtin_pwd(char **argv);
540 static int builtin_read(char **argv);
541 static int builtin_test(char **argv);
542 static int builtin_trap(char **argv);
543 static int builtin_true(char **argv);
544 static int builtin_set(char **argv);
545 static int builtin_shift(char **argv);
546 static int builtin_source(char **argv);
547 static int builtin_umask(char **argv);
548 static int builtin_unset(char **argv);
549 static int builtin_wait(char **argv);
550 #if ENABLE_HUSH_LOOPS
551 static int builtin_break(char **argv);
552 static int builtin_continue(char **argv);
555 /* Table of built-in functions. They can be forked or not, depending on
556 * context: within pipes, they fork. As simple commands, they do not.
557 * When used in non-forking context, they can change global variables
558 * in the parent shell process. If forked, of course they cannot.
559 * For example, 'unset foo | whatever' will parse and run, but foo will
560 * still be set at the end. */
561 struct built_in_command {
563 int (*function)(char **argv);
566 #define BLTIN(cmd, func, help) { cmd, func, help }
568 #define BLTIN(cmd, func, help) { cmd, func }
572 /* For now, echo and test are unconditionally enabled.
573 * Maybe make it configurable? */
574 static const struct built_in_command bltins[] = {
575 BLTIN("." , builtin_source , "Run commands in a file"),
576 BLTIN(":" , builtin_true , "No-op"),
577 BLTIN("[" , builtin_test , "Test condition"),
579 BLTIN("bg" , builtin_fg_bg , "Resume a job in the background"),
581 #if ENABLE_HUSH_LOOPS
582 BLTIN("break" , builtin_break , "Exit from a loop"),
584 BLTIN("cd" , builtin_cd , "Change directory"),
585 #if ENABLE_HUSH_LOOPS
586 BLTIN("continue", builtin_continue, "Start new loop iteration"),
588 BLTIN("echo" , builtin_echo , "Write to stdout"),
589 BLTIN("eval" , builtin_eval , "Construct and run shell command"),
590 BLTIN("exec" , builtin_exec , "Execute command, don't return to shell"),
591 BLTIN("exit" , builtin_exit , "Exit"),
592 BLTIN("export" , builtin_export , "Set environment variable"),
594 BLTIN("fg" , builtin_fg_bg , "Bring job into the foreground"),
597 BLTIN("help" , builtin_help , "List shell built-in commands"),
600 BLTIN("jobs" , builtin_jobs , "List active jobs"),
602 BLTIN("pwd" , builtin_pwd , "Print current directory"),
603 BLTIN("read" , builtin_read , "Input environment variable"),
604 // BLTIN("return" , builtin_return , "Return from a function"),
605 BLTIN("set" , builtin_set , "Set/unset shell local variables"),
606 BLTIN("shift" , builtin_shift , "Shift positional parameters"),
607 BLTIN("test" , builtin_test , "Test condition"),
608 BLTIN("trap" , builtin_trap , "Trap signals"),
609 // BLTIN("ulimit" , builtin_return , "Control resource limits"),
610 BLTIN("umask" , builtin_umask , "Set file creation mask"),
611 BLTIN("unset" , builtin_unset , "Unset environment variable"),
612 BLTIN("wait" , builtin_wait , "Wait for process"),
616 static void maybe_die(const char *notice, const char *msg)
618 /* Was using fancy stuff:
619 * (G_interactive_fd ? bb_error_msg : bb_error_msg_and_die)(...params...)
620 * but it SEGVs. ?! Oh well... explicit temp ptr works around that */
621 void FAST_FUNC (*fp)(const char *s, ...) = bb_error_msg_and_die;
622 #if ENABLE_HUSH_INTERACTIVE
623 if (G_interactive_fd)
626 fp(msg ? "%s: %s" : notice, notice, msg);
629 #define syntax(msg) maybe_die("syntax error", msg);
631 /* Debug -- trick gcc to expand __LINE__ and convert to string */
632 #define __syntax(msg, line) maybe_die("syntax error hush.c:" # line, msg)
633 #define _syntax(msg, line) __syntax(msg, line)
634 #define syntax(msg) _syntax(msg, __LINE__)
638 static int glob_needed(const char *s)
643 if (*s == '*' || *s == '[' || *s == '?')
650 static int is_assignment(const char *s)
652 if (!s || !(isalpha(*s) || *s == '_'))
655 while (isalnum(*s) || *s == '_')
660 /* Replace each \x with x in place, return ptr past NUL. */
661 static char *unbackslash(char *src)
667 if ((*dst++ = *src++) == '\0')
673 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
694 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
695 v[count1 + count2] = NULL;
698 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
702 static char **add_string_to_strings(char **strings, char *add)
707 return add_strings_to_strings(strings, v, /*dup:*/ 0);
710 static void putenv_all(char **strings)
715 debug_printf_env("putenv '%s'\n", *strings);
720 static char **putenv_all_and_save_old(char **strings)
730 eq = strchr(*strings, '=');
733 v = getenv(*strings);
736 /* v points to VAL in VAR=VAL, go back to VAR */
737 v -= (eq - *strings) + 1;
738 old = add_string_to_strings(old, v);
747 static void free_strings_and_unsetenv(char **strings, int unset)
757 debug_printf_env("unsetenv '%s'\n", *v);
765 static void free_strings(char **strings)
767 free_strings_and_unsetenv(strings, 0);
771 /* Basic theory of signal handling in shell
772 * ========================================
773 * This does not describe what hush does, rather, it is current understanding
774 * what it _should_ do. If it doesn't, it's a bug.
775 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
777 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
778 * is finished or backgrounded. It is the same in interactive and
779 * non-interactive shells, and is the same regardless of whether
780 * a user trap handler is installed or a shell special one is in effect.
781 * ^C or ^Z from keyboard seem to execute "at once" because it usually
782 * backgrounds (i.e. stops) or kills all members of currently running
785 * Wait builtin in interruptible by signals for which user trap is set
786 * or by SIGINT in interactive shell.
788 * Trap handlers will execute even within trap handlers. (right?)
790 * User trap handlers are forgotten when subshell ("(cmd)") is entered. [TODO]
792 * If job control is off, backgrounded commands ("cmd &")
793 * have SIGINT, SIGQUIT set to SIG_IGN.
795 * Commands run in command substitution ("`cmd`")
796 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
798 * Ordinary commands have signals set to SIG_IGN/DFL set as inherited
799 * by the shell from its parent.
801 * Siganls which differ from SIG_DFL action
802 * (note: child (i.e., [v]forked) shell is not an interactive shell):
805 * SIGTERM (interactive): ignore
806 * SIGHUP (interactive):
807 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
808 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
809 * (note that ^Z is handled not by trapping SIGTSTP, but by seeing
810 * that all pipe members are stopped) (right?)
811 * SIGINT (interactive): wait for last pipe, ignore the rest
812 * of the command line, show prompt. NB: ^C does not send SIGINT
813 * to interactive shell while shell is waiting for a pipe,
814 * since shell is bg'ed (is not in foreground process group).
815 * (check/expand this)
816 * Example 1: this waits 5 sec, but does not execute ls:
817 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
818 * Example 2: this does not wait and does not execute ls:
819 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
820 * Example 3: this does not wait 5 sec, but executes ls:
821 * "sleep 5; ls -l" + press ^C
823 * (What happens to signals which are IGN on shell start?)
824 * (What happens with signal mask on shell start?)
826 * Implementation in hush
827 * ======================
828 * We use in-kernel pending signal mask to determine which signals were sent.
829 * We block all signals which we don't want to take action immediately,
830 * i.e. we block all signals which need to have special handling as described
831 * above, and all signals which have traps set.
832 * After each pipe execution, we extract any pending signals via sigtimedwait()
835 * unsigned non_DFL_mask: a mask of such "special" signals
836 * sigset_t blocked_set: current blocked signal set
839 * clear bit in blocked_set unless it is also in non_DFL_mask
840 * "trap 'cmd' SIGxxx":
841 * set bit in blocked_set (even if 'cmd' is '')
842 * after [v]fork, if we plan to be a shell:
843 * nothing for {} child shell (say, "true | { true; true; } | true")
844 * unset all traps if () shell. [TODO]
845 * after [v]fork, if we plan to exec:
846 * POSIX says pending signal mask is cleared in child - no need to clear it.
847 * Restore blocked signal set to one inherited by shell just prior to exec.
849 * Note: as a result, we do not use signal handlers much. The only uses
850 * are to count SIGCHLDs [disabled - bug somewhere, + bloat]
851 * and to restore tty pgrp on signal-induced exit.
853 * TODO: check/fix wait builtin to be interruptible.
856 //static void SIGCHLD_handler(int sig UNUSED_PARAM)
858 // G.count_SIGCHLD++;
861 /* called once at shell init */
862 static void init_signal_mask(void)
865 unsigned mask = (1 << SIGQUIT);
866 if (G_interactive_fd) {
872 | (1 << SIGTTIN) | (1 << SIGTTOU) | (1 << SIGTSTP)
877 G.non_DFL_mask = mask;
879 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
883 sigaddset(&G.blocked_set, sig);
887 sigdelset(&G.blocked_set, SIGCHLD);
888 sigprocmask(SIG_SETMASK, &G.blocked_set, &G.inherited_set);
891 static int check_and_run_traps(int sig)
893 static const struct timespec zero_timespec = { 0, 0 };
894 smalluint save_rcode;
900 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
905 if (G.traps && G.traps[sig]) {
906 if (G.traps[sig][0]) {
907 /* We have user-defined handler */
908 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
909 save_rcode = G.last_return_code;
912 G.last_return_code = save_rcode;
913 } /* else: "" trap, ignoring signal */
916 /* not a trap: special action */
919 // G.count_SIGCHLD++;
928 default: /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
937 /* Restores tty foreground process group, and exits.
938 * May be called as signal handler for fatal signal
939 * (will faithfully resend signal to itself, producing correct exit state)
940 * or called directly with -EXITCODE.
941 * We also call it if xfunc is exiting. */
942 static void sigexit(int sig) NORETURN;
943 static void sigexit(int sig)
945 /* Disable all signals: job control, SIGPIPE, etc. */
946 sigprocmask_allsigs(SIG_BLOCK);
948 /* Careful: we can end up here after [v]fork. Do not restore
949 * tty pgrp then, only top-level shell process does that */
950 if (G_interactive_fd && getpid() == G.root_pid)
951 tcsetpgrp(G_interactive_fd, G.saved_tty_pgrp);
953 /* Not a signal, just exit */
957 kill_myself_with_sig(sig); /* does not return */
961 static void maybe_set_sighandler(int sig)
963 void (*handler)(int);
964 /* non_DFL_mask'ed signals are, well, masked,
965 * no need to set handler for them.
967 if (!((G.non_DFL_mask >> sig) & 1)) {
968 handler = signal(sig, sigexit);
969 if (handler == SIG_IGN) /* oops... restore back to IGN! */
970 signal(sig, handler);
973 /* Used only to set handler to restore pgrp on exit */
974 static void set_fatal_signals_to_sigexit(void)
977 maybe_set_sighandler(SIGILL );
978 maybe_set_sighandler(SIGFPE );
979 maybe_set_sighandler(SIGBUS );
980 maybe_set_sighandler(SIGSEGV);
981 maybe_set_sighandler(SIGTRAP);
982 } /* else: hush is perfect. what SEGV? */
984 maybe_set_sighandler(SIGABRT);
986 /* bash 3.2 seems to handle these just like 'fatal' ones */
987 maybe_set_sighandler(SIGPIPE);
988 maybe_set_sighandler(SIGALRM);
989 maybe_set_sighandler(SIGHUP );
991 /* if we aren't interactive... but in this case
992 * we never want to restore pgrp on exit, and this fn is not called */
993 /*maybe_set_sighandler(SIGTERM);*/
994 /*maybe_set_sighandler(SIGINT );*/
999 #define set_fatal_signals_to_sigexit(handler) ((void)0)
1003 /* Restores tty foreground process group, and exits. */
1004 static void hush_exit(int exitcode) NORETURN;
1005 static void hush_exit(int exitcode)
1007 if (G.traps && G.traps[0] && G.traps[0][0]) {
1008 char *argv[] = { NULL, xstrdup(G.traps[0]), NULL };
1014 fflush(NULL); /* flush all streams */
1015 sigexit(- (exitcode & 0xff));
1022 static const char *set_cwd(void)
1024 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1025 * we must not try to free(bb_msg_unknown) */
1026 if (G.cwd == bb_msg_unknown)
1028 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1030 G.cwd = bb_msg_unknown;
1035 /* Get/check local shell variables */
1036 static struct variable *get_local_var(const char *name)
1038 struct variable *cur;
1044 for (cur = G.top_var; cur; cur = cur->next) {
1045 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1051 static const char *get_local_var_value(const char *src)
1053 struct variable *var = get_local_var(src);
1055 return strchr(var->varstr, '=') + 1;
1059 /* str holds "NAME=VAL" and is expected to be malloced.
1060 * We take ownership of it.
1064 * -1: if NAME is set, leave export status alone
1065 * if NAME is not set, do not export
1066 * flg_read_only is set only when we handle -R var=val
1069 #define set_local_var(str, flg_export, flg_read_only) \
1070 set_local_var(str, flg_export)
1072 static int set_local_var(char *str, int flg_export, int flg_read_only)
1074 struct variable *cur;
1078 value = strchr(str, '=');
1079 if (!value) { /* not expected to ever happen? */
1084 name_len = value - str + 1; /* including '=' */
1085 cur = G.top_var; /* cannot be NULL (we have HUSH_VERSION and it's RO) */
1087 if (strncmp(cur->varstr, str, name_len) != 0) {
1089 /* Bail out. Note that now cur points
1090 * to last var in linked list */
1096 /* We found an existing var with this name */
1098 if (cur->flg_read_only) {
1102 bb_error_msg("%s: readonly variable", str);
1106 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1107 unsetenv(str); /* just in case */
1109 if (strcmp(cur->varstr, str) == 0) {
1114 if (cur->max_len >= strlen(str)) {
1115 /* This one is from startup env, reuse space */
1116 strcpy(cur->varstr, str);
1119 /* max_len == 0 signifies "malloced" var, which we can
1120 * (and has to) free */
1124 goto set_str_and_exp;
1127 /* Not found - create next variable struct */
1128 cur->next = xzalloc(sizeof(*cur));
1134 cur->flg_read_only = flg_read_only;
1137 if (flg_export == 1)
1138 cur->flg_export = 1;
1139 if (cur->flg_export) {
1140 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1141 return putenv(cur->varstr);
1146 static int unset_local_var(const char *name)
1148 struct variable *cur;
1149 struct variable *prev = prev; /* for gcc */
1153 return EXIT_SUCCESS;
1154 name_len = strlen(name);
1157 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1158 if (cur->flg_read_only) {
1159 bb_error_msg("%s: readonly variable", name);
1160 return EXIT_FAILURE;
1162 /* prev is ok to use here because 1st variable, HUSH_VERSION,
1163 * is ro, and we cannot reach this code on the 1st pass */
1164 prev->next = cur->next;
1165 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1166 bb_unsetenv(cur->varstr);
1170 return EXIT_SUCCESS;
1175 return EXIT_SUCCESS;
1178 #if ENABLE_SH_MATH_SUPPORT
1179 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1180 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1181 static char *endofname(const char *name)
1189 if (!is_in_name(*p))
1195 static void arith_set_local_var(const char *name, const char *val, int flags)
1197 /* arith code doesnt malloc space, so do it for it */
1198 char *var = xasprintf("%s=%s", name, val);
1199 set_local_var(var, flags, 0);
1207 static int static_get(struct in_str *i)
1216 static int static_peek(struct in_str *i)
1221 #if ENABLE_HUSH_INTERACTIVE
1223 static void cmdedit_set_initial_prompt(void)
1225 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1226 G.PS1 = getenv("PS1");
1233 static const char* setup_prompt_string(int promptmode)
1235 const char *prompt_str;
1236 debug_printf("setup_prompt_string %d ", promptmode);
1237 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1238 /* Set up the prompt */
1239 if (promptmode == 0) { /* PS1 */
1241 G.PS1 = xasprintf("%s %c ", G.cwd, (geteuid() != 0) ? '$' : '#');
1246 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1247 debug_printf("result '%s'\n", prompt_str);
1251 static void get_user_input(struct in_str *i)
1254 const char *prompt_str;
1256 prompt_str = setup_prompt_string(i->promptmode);
1257 #if ENABLE_FEATURE_EDITING
1258 /* Enable command line editing only while a command line
1259 * is actually being read */
1262 /* buglet: SIGINT will not make new prompt to appear _at once_,
1263 * only after <Enter>. (^C will work) */
1264 r = read_line_input(prompt_str, G.user_input_buf, BUFSIZ-1, G.line_input_state);
1265 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1266 check_and_run_traps(0);
1267 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1268 i->eof_flag = (r < 0);
1269 if (i->eof_flag) { /* EOF/error detected */
1270 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1271 G.user_input_buf[1] = '\0';
1276 fputs(prompt_str, stdout);
1278 G.user_input_buf[0] = r = fgetc(i->file);
1279 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1280 //do we need check_and_run_traps(0)? (maybe only if stdin)
1281 } while (G.flag_SIGINT);
1282 i->eof_flag = (r == EOF);
1284 i->p = G.user_input_buf;
1287 #endif /* INTERACTIVE */
1289 /* This is the magic location that prints prompts
1290 * and gets data back from the user */
1291 static int file_get(struct in_str *i)
1295 /* If there is data waiting, eat it up */
1296 if (i->p && *i->p) {
1297 #if ENABLE_HUSH_INTERACTIVE
1301 if (i->eof_flag && !*i->p)
1304 /* need to double check i->file because we might be doing something
1305 * more complicated by now, like sourcing or substituting. */
1306 #if ENABLE_HUSH_INTERACTIVE
1307 if (G_interactive_fd && i->promptme && i->file == stdin) {
1310 } while (!*i->p); /* need non-empty line */
1311 i->promptmode = 1; /* PS2 */
1316 ch = fgetc(i->file);
1318 debug_printf("file_get: got a '%c' %d\n", ch, ch);
1319 #if ENABLE_HUSH_INTERACTIVE
1326 /* All the callers guarantee this routine will never be
1327 * used right after a newline, so prompting is not needed.
1329 static int file_peek(struct in_str *i)
1332 if (i->p && *i->p) {
1333 if (i->eof_flag && !i->p[1])
1337 ch = fgetc(i->file);
1338 i->eof_flag = (ch == EOF);
1339 i->peek_buf[0] = ch;
1340 i->peek_buf[1] = '\0';
1342 debug_printf("file_peek: got a '%c' %d\n", *i->p, *i->p);
1346 static void setup_file_in_str(struct in_str *i, FILE *f)
1348 i->peek = file_peek;
1350 #if ENABLE_HUSH_INTERACTIVE
1352 i->promptmode = 0; /* PS1 */
1358 static void setup_string_in_str(struct in_str *i, const char *s)
1360 i->peek = static_peek;
1361 i->get = static_get;
1362 #if ENABLE_HUSH_INTERACTIVE
1364 i->promptmode = 0; /* PS1 */
1374 #define B_CHUNK (32 * sizeof(char*))
1376 static void o_reset(o_string *o)
1384 static void o_free(o_string *o)
1387 memset(o, 0, sizeof(*o));
1390 static ALWAYS_INLINE void o_free_unsafe(o_string *o)
1395 static void o_grow_by(o_string *o, int len)
1397 if (o->length + len > o->maxlen) {
1398 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1399 o->data = xrealloc(o->data, 1 + o->maxlen);
1403 static void o_addchr(o_string *o, int ch)
1405 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1407 o->data[o->length] = ch;
1409 o->data[o->length] = '\0';
1412 static void o_addblock(o_string *o, const char *str, int len)
1415 memcpy(&o->data[o->length], str, len);
1417 o->data[o->length] = '\0';
1421 static void o_addstr(o_string *o, const char *str)
1423 o_addblock(o, str, strlen(str));
1427 static void o_addstr_with_NUL(o_string *o, const char *str)
1429 o_addblock(o, str, strlen(str) + 1);
1432 static void o_addblock_duplicate_backslash(o_string *o, const char *str, int len)
1437 && (*str != '*' && *str != '?' && *str != '[')
1445 /* My analysis of quoting semantics tells me that state information
1446 * is associated with a destination, not a source.
1448 static void o_addqchr(o_string *o, int ch)
1451 char *found = strchr("*?[\\", ch);
1456 o->data[o->length] = '\\';
1459 o->data[o->length] = ch;
1461 o->data[o->length] = '\0';
1464 static void o_addQchr(o_string *o, int ch)
1467 if (o->o_escape && strchr("*?[\\", ch)) {
1469 o->data[o->length] = '\\';
1473 o->data[o->length] = ch;
1475 o->data[o->length] = '\0';
1478 static void o_addQstr(o_string *o, const char *str, int len)
1481 o_addblock(o, str, len);
1487 int ordinary_cnt = strcspn(str, "*?[\\");
1488 if (ordinary_cnt > len) /* paranoia */
1490 o_addblock(o, str, ordinary_cnt);
1491 if (ordinary_cnt == len)
1493 str += ordinary_cnt;
1494 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1498 if (ch) { /* it is necessarily one of "*?[\\" */
1500 o->data[o->length] = '\\';
1504 o->data[o->length] = ch;
1506 o->data[o->length] = '\0';
1510 /* A special kind of o_string for $VAR and `cmd` expansion.
1511 * It contains char* list[] at the beginning, which is grown in 16 element
1512 * increments. Actual string data starts at the next multiple of 16 * (char*).
1513 * list[i] contains an INDEX (int!) into this string data.
1514 * It means that if list[] needs to grow, data needs to be moved higher up
1515 * but list[i]'s need not be modified.
1516 * NB: remembering how many list[i]'s you have there is crucial.
1517 * o_finalize_list() operation post-processes this structure - calculates
1518 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1520 #if DEBUG_EXPAND || DEBUG_GLOB
1521 static void debug_print_list(const char *prefix, o_string *o, int n)
1523 char **list = (char**)o->data;
1524 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1526 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1527 prefix, list, n, string_start, o->length, o->maxlen);
1529 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1530 o->data + (int)list[i] + string_start,
1531 o->data + (int)list[i] + string_start);
1535 const char *p = o->data + (int)list[n - 1] + string_start;
1536 fprintf(stderr, " total_sz:%ld\n", (long)((p + strlen(p) + 1) - o->data));
1540 #define debug_print_list(prefix, o, n) ((void)0)
1543 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1544 * in list[n] so that it points past last stored byte so far.
1545 * It returns n+1. */
1546 static int o_save_ptr_helper(o_string *o, int n)
1548 char **list = (char**)o->data;
1552 if (!o->has_empty_slot) {
1553 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1554 string_len = o->length - string_start;
1555 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1556 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1557 /* list[n] points to string_start, make space for 16 more pointers */
1558 o->maxlen += 0x10 * sizeof(list[0]);
1559 o->data = xrealloc(o->data, o->maxlen + 1);
1560 list = (char**)o->data;
1561 memmove(list + n + 0x10, list + n, string_len);
1562 o->length += 0x10 * sizeof(list[0]);
1564 debug_printf_list("list[%d]=%d string_start=%d\n",
1565 n, string_len, string_start);
1568 /* We have empty slot at list[n], reuse without growth */
1569 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1570 string_len = o->length - string_start;
1571 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n",
1572 n, string_len, string_start);
1573 o->has_empty_slot = 0;
1575 list[n] = (char*)(ptrdiff_t)string_len;
1579 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
1580 static int o_get_last_ptr(o_string *o, int n)
1582 char **list = (char**)o->data;
1583 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1585 return ((int)(ptrdiff_t)list[n-1]) + string_start;
1588 /* o_glob performs globbing on last list[], saving each result
1589 * as a new list[]. */
1590 static int o_glob(o_string *o, int n)
1596 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
1598 return o_save_ptr_helper(o, n);
1599 pattern = o->data + o_get_last_ptr(o, n);
1600 debug_printf_glob("glob pattern '%s'\n", pattern);
1601 if (!glob_needed(pattern)) {
1603 o->length = unbackslash(pattern) - o->data;
1604 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
1605 return o_save_ptr_helper(o, n);
1608 memset(&globdata, 0, sizeof(globdata));
1609 gr = glob(pattern, 0, NULL, &globdata);
1610 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
1611 if (gr == GLOB_NOSPACE)
1612 bb_error_msg_and_die("out of memory during glob");
1613 if (gr == GLOB_NOMATCH) {
1614 globfree(&globdata);
1617 if (gr != 0) { /* GLOB_ABORTED ? */
1618 //TODO: testcase for bad glob pattern behavior
1619 bb_error_msg("glob(3) error %d on '%s'", gr, pattern);
1621 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
1622 char **argv = globdata.gl_pathv;
1623 o->length = pattern - o->data; /* "forget" pattern */
1625 o_addstr_with_NUL(o, *argv);
1626 n = o_save_ptr_helper(o, n);
1632 globfree(&globdata);
1634 debug_print_list("o_glob returning", o, n);
1638 /* If o->o_glob == 1, glob the string so far remembered.
1639 * Otherwise, just finish current list[] and start new */
1640 static int o_save_ptr(o_string *o, int n)
1642 if (o->o_glob) { /* if globbing is requested */
1643 /* If o->has_empty_slot, list[n] was already globbed
1644 * (if it was requested back then when it was filled)
1645 * so don't do that again! */
1646 if (!o->has_empty_slot)
1647 return o_glob(o, n); /* o_save_ptr_helper is inside */
1649 return o_save_ptr_helper(o, n);
1652 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
1653 static char **o_finalize_list(o_string *o, int n)
1658 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
1660 debug_print_list("finalized", o, n);
1661 debug_printf_expand("finalized n:%d\n", n);
1662 list = (char**)o->data;
1663 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1667 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
1673 /* Expansion can recurse */
1674 #if ENABLE_HUSH_TICK
1675 static int process_command_subs(o_string *dest, const char *s);
1677 static char *expand_string_to_string(const char *str);
1679 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
1680 parse_stream_dquoted(dest, input, dquote_end)
1682 static int parse_stream_dquoted(struct parse_context *ctx,
1684 struct in_str *input,
1687 /* expand_strvec_to_strvec() takes a list of strings, expands
1688 * all variable references within and returns a pointer to
1689 * a list of expanded strings, possibly with larger number
1690 * of strings. (Think VAR="a b"; echo $VAR).
1691 * This new list is allocated as a single malloc block.
1692 * NULL-terminated list of char* pointers is at the beginning of it,
1693 * followed by strings themself.
1694 * Caller can deallocate entire list by single free(list). */
1696 /* Store given string, finalizing the word and starting new one whenever
1697 * we encounter IFS char(s). This is used for expanding variable values.
1698 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
1699 static int expand_on_ifs(o_string *output, int n, const char *str)
1702 int word_len = strcspn(str, G.ifs);
1704 if (output->o_escape || !output->o_glob)
1705 o_addQstr(output, str, word_len);
1706 else /* protect backslashes against globbing up :) */
1707 o_addblock_duplicate_backslash(output, str, word_len);
1710 if (!*str) /* EOL - do not finalize word */
1712 o_addchr(output, '\0');
1713 debug_print_list("expand_on_ifs", output, n);
1714 n = o_save_ptr(output, n);
1715 str += strspn(str, G.ifs); /* skip ifs chars */
1717 debug_print_list("expand_on_ifs[1]", output, n);
1721 /* Expand all variable references in given string, adding words to list[]
1722 * at n, n+1,... positions. Return updated n (so that list[n] is next one
1723 * to be filled). This routine is extremely tricky: has to deal with
1724 * variables/parameters with whitespace, $* and $@, and constructs like
1725 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
1726 static int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
1728 /* or_mask is either 0 (normal case) or 0x80
1729 * (expansion of right-hand side of assignment == 1-element expand.
1730 * It will also do no globbing, and thus we must not backslash-quote!) */
1732 char first_ch, ored_ch;
1739 debug_printf_expand("expand_vars_to_list: arg '%s'\n", arg);
1740 debug_print_list("expand_vars_to_list", output, n);
1741 n = o_save_ptr(output, n);
1742 debug_print_list("expand_vars_to_list[0]", output, n);
1744 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
1745 #if ENABLE_HUSH_TICK
1746 o_string subst_result = NULL_O_STRING;
1748 #if ENABLE_SH_MATH_SUPPORT
1749 char arith_buf[sizeof(arith_t)*3 + 2];
1751 o_addblock(output, arg, p - arg);
1752 debug_print_list("expand_vars_to_list[1]", output, n);
1754 p = strchr(p, SPECIAL_VAR_SYMBOL);
1756 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
1757 /* "$@" is special. Even if quoted, it can still
1758 * expand to nothing (not even an empty string) */
1759 if ((first_ch & 0x7f) != '@')
1760 ored_ch |= first_ch;
1763 switch (first_ch & 0x7f) {
1764 /* Highest bit in first_ch indicates that var is double-quoted */
1766 val = utoa(G.root_pid);
1768 case '!': /* bg pid */
1769 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
1771 case '?': /* exitcode */
1772 val = utoa(G.last_return_code);
1774 case '#': /* argc */
1775 if (arg[1] != SPECIAL_VAR_SYMBOL)
1776 /* actually, it's a ${#var} */
1778 val = utoa(G.global_argc ? G.global_argc-1 : 0);
1783 if (!G.global_argv[i])
1785 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
1786 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
1787 smallint sv = output->o_escape;
1788 /* unquoted var's contents should be globbed, so don't escape */
1789 output->o_escape = 0;
1790 while (G.global_argv[i]) {
1791 n = expand_on_ifs(output, n, G.global_argv[i]);
1792 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
1793 if (G.global_argv[i++][0] && G.global_argv[i]) {
1794 /* this argv[] is not empty and not last:
1795 * put terminating NUL, start new word */
1796 o_addchr(output, '\0');
1797 debug_print_list("expand_vars_to_list[2]", output, n);
1798 n = o_save_ptr(output, n);
1799 debug_print_list("expand_vars_to_list[3]", output, n);
1802 output->o_escape = sv;
1804 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
1805 * and in this case should treat it like '$*' - see 'else...' below */
1806 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
1808 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1809 if (++i >= G.global_argc)
1811 o_addchr(output, '\0');
1812 debug_print_list("expand_vars_to_list[4]", output, n);
1813 n = o_save_ptr(output, n);
1815 } else { /* quoted $*: add as one word */
1817 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1818 if (!G.global_argv[++i])
1821 o_addchr(output, G.ifs[0]);
1825 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
1826 /* "Empty variable", used to make "" etc to not disappear */
1830 #if ENABLE_HUSH_TICK
1831 case '`': /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
1834 //TODO: can we just stuff it into "output" directly?
1835 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
1836 process_command_subs(&subst_result, arg);
1837 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
1838 val = subst_result.data;
1841 #if ENABLE_SH_MATH_SUPPORT
1842 case '+': { /* <SPECIAL_VAR_SYMBOL>+cmd<SPECIAL_VAR_SYMBOL> */
1843 arith_eval_hooks_t hooks;
1848 arg++; /* skip '+' */
1849 *p = '\0'; /* replace trailing <SPECIAL_VAR_SYMBOL> */
1850 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
1852 /* Optional: skip expansion if expr is simple ("a + 3", "i++" etc) */
1855 unsigned char c = *exp_str++;
1862 if (strchr(" \t+-*/%_", c) != NULL)
1864 c |= 0x20; /* tolower */
1865 if (c >= 'a' && c <= 'z')
1869 /* We need to expand. Example: "echo $(($a + 1)) $((1 + $((2)) ))" */
1871 struct in_str input;
1872 o_string dest = NULL_O_STRING;
1874 setup_string_in_str(&input, arg);
1875 parse_stream_dquoted(NULL, &dest, &input, EOF);
1876 //bb_error_msg("'%s' -> '%s'", arg, dest.data);
1877 exp_str = expand_string_to_string(dest.data);
1878 //bb_error_msg("'%s' -> '%s'", dest.data, exp_str);
1882 hooks.lookupvar = get_local_var_value;
1883 hooks.setvar = arith_set_local_var;
1884 hooks.endofname = endofname;
1885 res = arith(exp_str ? exp_str : arg, &errcode, &hooks);
1890 case -3: maybe_die("arith", "exponent less than 0"); break;
1891 case -2: maybe_die("arith", "divide by zero"); break;
1892 case -5: maybe_die("arith", "expression recursion loop detected"); break;
1893 default: maybe_die("arith", "syntax error"); break;
1896 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
1897 sprintf(arith_buf, arith_t_fmt, res);
1902 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
1904 bool exp_len = false, exp_null = false;
1905 char *var = arg, exp_save, exp_op, *exp_word;
1908 arg[0] = first_ch & 0x7f;
1910 /* prepare for expansions */
1911 if (var[0] == '#') {
1912 /* handle length expansion ${#var} */
1916 /* maybe handle parameter expansion */
1917 exp_off = strcspn(var, ":-=+?");
1921 exp_save = var[exp_off];
1922 exp_null = exp_save == ':';
1923 exp_word = var + exp_off;
1924 if (exp_null) ++exp_word;
1925 exp_op = *exp_word++;
1926 var[exp_off] = '\0';
1930 /* lookup the variable in question */
1931 if (isdigit(var[0])) {
1932 /* handle_dollar() should have vetted var for us */
1934 if (i < G.global_argc)
1935 val = G.global_argv[i];
1936 /* else val remains NULL: $N with too big N */
1938 val = get_local_var_value(var);
1940 /* handle any expansions */
1942 debug_printf_expand("expand: length of '%s' = ", val);
1943 val = utoa(val ? strlen(val) : 0);
1944 debug_printf_expand("%s\n", val);
1945 } else if (exp_off) {
1946 /* we need to do an expansion */
1947 int exp_test = (!val || (exp_null && !val[0]));
1949 exp_test = !exp_test;
1950 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
1951 exp_null ? "true" : "false", exp_test);
1954 maybe_die(var, *exp_word ? exp_word : "parameter null or not set");
1958 if (exp_op == '=') {
1959 if (isdigit(var[0]) || var[0] == '#') {
1960 maybe_die(var, "special vars cannot assign in this way");
1963 char *new_var = xmalloc(strlen(var) + strlen(val) + 2);
1964 sprintf(new_var, "%s=%s", var, val);
1965 set_local_var(new_var, -1, 0);
1969 var[exp_off] = exp_save;
1973 #if ENABLE_HUSH_TICK
1976 if (!(first_ch & 0x80)) { /* unquoted $VAR */
1977 debug_printf_expand("unquoted '%s', output->o_escape:%d\n", val, output->o_escape);
1979 /* unquoted var's contents should be globbed, so don't escape */
1980 smallint sv = output->o_escape;
1981 output->o_escape = 0;
1982 n = expand_on_ifs(output, n, val);
1984 output->o_escape = sv;
1986 } else { /* quoted $VAR, val will be appended below */
1987 debug_printf_expand("quoted '%s', output->o_escape:%d\n", val, output->o_escape);
1990 } /* switch (char after <SPECIAL_VAR_SYMBOL>) */
1992 o_addQstr(output, val, strlen(val));
1994 /* Do the check to avoid writing to a const string */
1995 if (*p != SPECIAL_VAR_SYMBOL)
1996 *p = SPECIAL_VAR_SYMBOL;
1998 #if ENABLE_HUSH_TICK
1999 o_free(&subst_result);
2002 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
2005 debug_print_list("expand_vars_to_list[a]", output, n);
2006 /* this part is literal, and it was already pre-quoted
2007 * if needed (much earlier), do not use o_addQstr here! */
2008 o_addstr_with_NUL(output, arg);
2009 debug_print_list("expand_vars_to_list[b]", output, n);
2010 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
2011 && !(ored_ch & 0x80) /* and all vars were not quoted. */
2014 /* allow to reuse list[n] later without re-growth */
2015 output->has_empty_slot = 1;
2017 o_addchr(output, '\0');
2022 static char **expand_variables(char **argv, int or_mask)
2027 o_string output = NULL_O_STRING;
2029 if (or_mask & 0x100) {
2030 output.o_escape = 1; /* protect against globbing for "$var" */
2031 /* (unquoted $var will temporarily switch it off) */
2038 n = expand_vars_to_list(&output, n, *v, (char)or_mask);
2041 debug_print_list("expand_variables", &output, n);
2043 /* output.data (malloced in one block) gets returned in "list" */
2044 list = o_finalize_list(&output, n);
2045 debug_print_strings("expand_variables[1]", list);
2049 static char **expand_strvec_to_strvec(char **argv)
2051 return expand_variables(argv, 0x100);
2054 /* Used for expansion of right hand of assignments */
2055 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
2057 static char *expand_string_to_string(const char *str)
2059 char *argv[2], **list;
2061 argv[0] = (char*)str;
2063 list = expand_variables(argv, 0x80); /* 0x80: make one-element expansion */
2065 if (!list[0] || list[1])
2066 bb_error_msg_and_die("BUG in varexp2");
2067 /* actually, just move string 2*sizeof(char*) bytes back */
2068 overlapping_strcpy((char*)list, list[0]);
2069 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2073 /* Used for "eval" builtin */
2074 static char* expand_strvec_to_string(char **argv)
2078 list = expand_variables(argv, 0x80);
2079 /* Convert all NULs to spaces */
2084 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2085 bb_error_msg_and_die("BUG in varexp3");
2086 list[n][-1] = ' '; /* TODO: or to G.ifs[0]? */
2090 overlapping_strcpy((char*)list, list[0]);
2091 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2095 static char **expand_assignments(char **argv, int count)
2099 /* Expand assignments into one string each */
2100 for (i = 0; i < count; i++) {
2101 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2107 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
2108 * and stderr if they are redirected. */
2109 static int setup_redirects(struct command *prog, int squirrel[])
2112 struct redir_struct *redir;
2114 for (redir = prog->redirects; redir; redir = redir->next) {
2115 if (redir->dup == -1 && redir->rd_filename == NULL) {
2116 /* something went wrong in the parse. Pretend it didn't happen */
2119 if (redir->dup == -1) {
2121 mode = redir_table[redir->rd_type].mode;
2122 //TODO: check redir for names like '\\'
2123 p = expand_string_to_string(redir->rd_filename);
2124 openfd = open_or_warn(p, mode);
2127 /* this could get lost if stderr has been redirected, but
2128 bash and ash both lose it as well (though zsh doesn't!) */
2132 openfd = redir->dup;
2135 if (openfd != redir->fd) {
2136 if (squirrel && redir->fd < 3) {
2137 squirrel[redir->fd] = dup(redir->fd);
2140 //close(openfd); // close(-3) ??!
2142 dup2(openfd, redir->fd);
2143 if (redir->dup == -1)
2151 static void restore_redirects(int squirrel[])
2154 for (i = 0; i < 3; i++) {
2157 /* We simply die on error */
2164 #if !defined(DEBUG_CLEAN)
2165 #define free_pipe_list(head, indent) free_pipe_list(head)
2166 #define free_pipe(pi, indent) free_pipe(pi)
2168 static void free_pipe_list(struct pipe *head, int indent);
2170 /* Return code is the exit status of the pipe */
2171 static void free_pipe(struct pipe *pi, int indent)
2174 struct command *command;
2175 struct redir_struct *r, *rnext;
2178 if (pi->stopped_cmds > 0) /* why? */
2180 debug_printf_clean("%s run pipe: (pid %d)\n", indenter(indent), getpid());
2181 for (i = 0; i < pi->num_cmds; i++) {
2182 command = &pi->cmds[i];
2183 debug_printf_clean("%s command %d:\n", indenter(indent), i);
2184 if (command->argv) {
2185 for (a = 0, p = command->argv; *p; a++, p++) {
2186 debug_printf_clean("%s argv[%d] = %s\n", indenter(indent), a, *p);
2188 free_strings(command->argv);
2189 command->argv = NULL;
2191 /* not "else if": on syntax error, we may have both! */
2192 if (command->group) {
2193 debug_printf_clean("%s begin group (grp_type:%d)\n", indenter(indent), command->grp_type);
2194 free_pipe_list(command->group, indent+3);
2195 debug_printf_clean("%s end group\n", indenter(indent));
2196 command->group = NULL;
2199 free(command->group_as_string);
2200 command->group_as_string = NULL;
2202 for (r = command->redirects; r; r = rnext) {
2203 debug_printf_clean("%s redirect %d%s", indenter(indent), r->fd, redir_table[r->rd_type].descrip);
2205 /* guard against the case >$FOO, where foo is unset or blank */
2206 if (r->rd_filename) {
2207 debug_printf_clean(" %s\n", r->rd_filename);
2208 free(r->rd_filename);
2209 r->rd_filename = NULL;
2212 debug_printf_clean("&%d\n", r->dup);
2217 command->redirects = NULL;
2219 free(pi->cmds); /* children are an array, they get freed all at once */
2227 static void free_pipe_list(struct pipe *head, int indent)
2229 struct pipe *pi, *next;
2231 for (pi = head; pi; pi = next) {
2233 debug_printf_clean("%s pipe reserved mode %d\n", indenter(indent), pi->res_word);
2235 free_pipe(pi, indent);
2236 debug_printf_clean("%s pipe followup code %d\n", indenter(indent), pi->followup);
2238 /*pi->next = NULL;*/
2245 typedef struct nommu_save_t {
2251 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
2252 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
2253 #define pseudo_exec(nommu_save, command, argv_expanded) \
2254 pseudo_exec(command, argv_expanded)
2257 /* Called after [v]fork() in run_pipe(), or from builtin_exec().
2259 * XXX no exit() here. If you don't exec, use _exit instead.
2260 * The at_exit handlers apparently confuse the calling process,
2261 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
2262 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2263 char **argv, int assignment_cnt,
2264 char **argv_expanded) NORETURN;
2265 static void pseudo_exec_argv(nommu_save_t *nommu_save,
2266 char **argv, int assignment_cnt,
2267 char **argv_expanded)
2271 /* Case when we are here: ... | var=val | ... */
2272 if (!argv[assignment_cnt])
2273 _exit(EXIT_SUCCESS);
2275 new_env = expand_assignments(argv, assignment_cnt);
2277 putenv_all(new_env);
2278 free(new_env); /* optional */
2280 nommu_save->new_env = new_env;
2281 nommu_save->old_env = putenv_all_and_save_old(new_env);
2283 if (argv_expanded) {
2284 argv = argv_expanded;
2286 argv = expand_strvec_to_strvec(argv + assignment_cnt);
2288 nommu_save->argv = argv;
2292 /* On NOMMU, we must never block!
2293 * Example: { sleep 99999 | read line } & echo Ok
2294 * read builtin will block on read syscall, leaving parent blocked
2295 * in vfork. Therefore we can't do this:
2298 /* Check if the command matches any of the builtins.
2299 * Depending on context, this might be redundant. But it's
2300 * easier to waste a few CPU cycles than it is to figure out
2301 * if this is one of those cases.
2305 const struct built_in_command *x;
2306 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2307 if (strcmp(argv[0], x->cmd) == 0) {
2308 debug_printf_exec("running builtin '%s'\n",
2310 rcode = x->function(argv);
2318 #if ENABLE_FEATURE_SH_STANDALONE
2319 /* Check if the command matches any busybox applets */
2320 if (strchr(argv[0], '/') == NULL) {
2321 int a = find_applet_by_name(argv[0]);
2323 #if BB_MMU /* see above why on NOMMU it is not allowed */
2324 if (APPLET_IS_NOEXEC(a)) {
2325 debug_printf_exec("running applet '%s'\n", argv[0]);
2326 run_applet_no_and_exit(a, argv);
2329 /* Re-exec ourselves */
2330 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
2331 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2332 execv(bb_busybox_exec_path, argv);
2333 /* If they called chroot or otherwise made the binary no longer
2334 * executable, fall through */
2339 debug_printf_exec("execing '%s'\n", argv[0]);
2340 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2341 execvp(argv[0], argv);
2342 bb_perror_msg("can't exec '%s'", argv[0]);
2343 _exit(EXIT_FAILURE);
2347 static void re_execute_shell(const char *s) NORETURN;
2348 static void re_execute_shell(const char *s)
2350 struct variable *cur;
2351 char **argv, **pp, **pp2;
2354 /* 1:hush 2:-$<pid> 3:-?<exitcode> 4:-D<depth> <vars...>
2355 * 5:-c 6:<cmd> <argN...> 7:NULL
2357 cnt = 7 + G.global_argc;
2358 for (cur = G.top_var; cur; cur = cur->next) {
2359 if (!cur->flg_export || cur->flg_read_only)
2362 G.argv_for_re_execing = pp = xzalloc(sizeof(argv[0]) * cnt);
2363 *pp++ = (char *) applet_name;
2364 *pp++ = xasprintf("-$%u", G.root_pid);
2365 *pp++ = xasprintf("-?%u", G.last_return_code);
2366 #if ENABLE_HUSH_LOOPS
2367 *pp++ = xasprintf("-D%u", G.depth_of_loop);
2369 for (cur = G.top_var; cur; cur = cur->next) {
2370 if (cur->varstr == hush_version_str)
2372 if (cur->flg_read_only) {
2373 *pp++ = (char *) "-R";
2374 *pp++ = cur->varstr;
2375 } else if (!cur->flg_export) {
2376 *pp++ = (char *) "-V";
2377 *pp++ = cur->varstr;
2380 *pp++ = (char *) "-c";
2382 pp2 = G.global_argv;
2385 /* *pp = NULL; - is already there */
2386 //TODO: pass traps and functions
2388 debug_printf_exec("re_execute_shell pid:%d cmd:'%s'\n", getpid(), s);
2389 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2390 execv(bb_busybox_exec_path, G.argv_for_re_execing);
2391 //TODO: fallback for init=/bin/hush?
2395 static void clean_up_after_re_execute(void)
2397 char **pp = G.argv_for_re_execing;
2399 /* Must match re_execute_shell's allocations */
2402 #if ENABLE_HUSH_LOOPS
2406 G.argv_for_re_execing = NULL;
2410 #define clean_up_after_re_execute() ((void)0)
2413 static int run_list(struct pipe *pi);
2415 /* Called after [v]fork() in run_pipe()
2417 static void pseudo_exec(nommu_save_t *nommu_save,
2418 struct command *command,
2419 char **argv_expanded) NORETURN;
2420 static void pseudo_exec(nommu_save_t *nommu_save,
2421 struct command *command,
2422 char **argv_expanded)
2424 if (command->argv) {
2425 pseudo_exec_argv(nommu_save, command->argv,
2426 command->assignment_cnt, argv_expanded);
2429 if (command->group) {
2430 /* Cases when we are here:
2433 * ... | ( list ) | ...
2434 * ... | { list } | ...
2438 debug_printf_exec("pseudo_exec: run_list\n");
2439 rcode = run_list(command->group);
2440 /* OK to leak memory by not calling free_pipe_list,
2441 * since this process is about to exit */
2444 re_execute_shell(command->group_as_string);
2448 /* Case when we are here: ... | >file */
2449 debug_printf_exec("pseudo_exec'ed null command\n");
2450 _exit(EXIT_SUCCESS);
2454 static const char *get_cmdtext(struct pipe *pi)
2460 /* This is subtle. ->cmdtext is created only on first backgrounding.
2461 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
2462 * On subsequent bg argv is trashed, but we won't use it */
2465 argv = pi->cmds[0].argv;
2466 if (!argv || !argv[0]) {
2467 pi->cmdtext = xzalloc(1);
2472 do len += strlen(*argv) + 1; while (*++argv);
2473 pi->cmdtext = p = xmalloc(len);
2474 argv = pi->cmds[0].argv;
2476 len = strlen(*argv);
2477 memcpy(p, *argv, len);
2485 static void insert_bg_job(struct pipe *pi)
2487 struct pipe *thejob;
2490 /* Linear search for the ID of the job to use */
2492 for (thejob = G.job_list; thejob; thejob = thejob->next)
2493 if (thejob->jobid >= pi->jobid)
2494 pi->jobid = thejob->jobid + 1;
2496 /* Add thejob to the list of running jobs */
2498 thejob = G.job_list = xmalloc(sizeof(*thejob));
2500 for (thejob = G.job_list; thejob->next; thejob = thejob->next)
2502 thejob->next = xmalloc(sizeof(*thejob));
2503 thejob = thejob->next;
2506 /* Physically copy the struct job */
2507 memcpy(thejob, pi, sizeof(struct pipe));
2508 thejob->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
2509 /* We cannot copy entire pi->cmds[] vector! Double free()s will happen */
2510 for (i = 0; i < pi->num_cmds; i++) {
2511 // TODO: do we really need to have so many fields which are just dead weight
2512 // at execution stage?
2513 thejob->cmds[i].pid = pi->cmds[i].pid;
2514 /* all other fields are not used and stay zero */
2516 thejob->next = NULL;
2517 thejob->cmdtext = xstrdup(get_cmdtext(pi));
2519 /* We don't wait for background thejobs to return -- append it
2520 to the list of backgrounded thejobs and leave it alone */
2521 if (G_interactive_fd)
2522 printf("[%d] %d %s\n", thejob->jobid, thejob->cmds[0].pid, thejob->cmdtext);
2523 G.last_bg_pid = thejob->cmds[0].pid;
2524 G.last_jobid = thejob->jobid;
2527 static void remove_bg_job(struct pipe *pi)
2529 struct pipe *prev_pipe;
2531 if (pi == G.job_list) {
2532 G.job_list = pi->next;
2534 prev_pipe = G.job_list;
2535 while (prev_pipe->next != pi)
2536 prev_pipe = prev_pipe->next;
2537 prev_pipe->next = pi->next;
2540 G.last_jobid = G.job_list->jobid;
2545 /* Remove a backgrounded job */
2546 static void delete_finished_bg_job(struct pipe *pi)
2549 pi->stopped_cmds = 0;
2555 /* Check to see if any processes have exited -- if they
2556 * have, figure out why and see if a job has completed */
2557 static int checkjobs(struct pipe* fg_pipe)
2567 debug_printf_jobs("checkjobs %p\n", fg_pipe);
2570 // if (G.handled_SIGCHLD == G.count_SIGCHLD)
2571 // /* avoid doing syscall, nothing there anyway */
2574 attributes = WUNTRACED;
2575 if (fg_pipe == NULL)
2576 attributes |= WNOHANG;
2578 /* Do we do this right?
2579 * bash-3.00# sleep 20 | false
2581 * [3]+ Stopped sleep 20 | false
2582 * bash-3.00# echo $?
2583 * 1 <========== bg pipe is not fully done, but exitcode is already known!
2586 //FIXME: non-interactive bash does not continue even if all processes in fg pipe
2587 //are stopped. Testcase: "cat | cat" in a script (not on command line)
2588 // + killall -STOP cat
2595 // i = G.count_SIGCHLD;
2596 childpid = waitpid(-1, &status, attributes);
2597 if (childpid <= 0) {
2598 if (childpid && errno != ECHILD)
2599 bb_perror_msg("waitpid");
2600 // else /* Until next SIGCHLD, waitpid's are useless */
2601 // G.handled_SIGCHLD = i;
2604 dead = WIFEXITED(status) || WIFSIGNALED(status);
2607 if (WIFSTOPPED(status))
2608 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
2609 childpid, WSTOPSIG(status), WEXITSTATUS(status));
2610 if (WIFSIGNALED(status))
2611 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
2612 childpid, WTERMSIG(status), WEXITSTATUS(status));
2613 if (WIFEXITED(status))
2614 debug_printf_jobs("pid %d exited, exitcode %d\n",
2615 childpid, WEXITSTATUS(status));
2617 /* Were we asked to wait for fg pipe? */
2619 for (i = 0; i < fg_pipe->num_cmds; i++) {
2620 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
2621 if (fg_pipe->cmds[i].pid != childpid)
2623 /* printf("process %d exit %d\n", i, WEXITSTATUS(status)); */
2625 fg_pipe->cmds[i].pid = 0;
2626 fg_pipe->alive_cmds--;
2627 if (i == fg_pipe->num_cmds - 1) {
2628 /* last process gives overall exitstatus */
2629 rcode = WEXITSTATUS(status);
2630 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
2633 fg_pipe->cmds[i].is_stopped = 1;
2634 fg_pipe->stopped_cmds++;
2636 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
2637 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
2638 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
2639 /* All processes in fg pipe have exited/stopped */
2641 if (fg_pipe->alive_cmds)
2642 insert_bg_job(fg_pipe);
2646 /* There are still running processes in the fg pipe */
2647 goto wait_more; /* do waitpid again */
2649 /* it wasnt fg_pipe, look for process in bg pipes */
2653 /* We asked to wait for bg or orphaned children */
2654 /* No need to remember exitcode in this case */
2655 for (pi = G.job_list; pi; pi = pi->next) {
2656 for (i = 0; i < pi->num_cmds; i++) {
2657 if (pi->cmds[i].pid == childpid)
2658 goto found_pi_and_prognum;
2661 /* Happens when shell is used as init process (init=/bin/sh) */
2662 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
2663 continue; /* do waitpid again */
2665 found_pi_and_prognum:
2668 pi->cmds[i].pid = 0;
2670 if (!pi->alive_cmds) {
2671 if (G_interactive_fd)
2672 printf(JOB_STATUS_FORMAT, pi->jobid,
2673 "Done", pi->cmdtext);
2674 delete_finished_bg_job(pi);
2678 pi->cmds[i].is_stopped = 1;
2682 } /* while (waitpid succeeds)... */
2688 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
2691 int rcode = checkjobs(fg_pipe);
2692 /* Job finished, move the shell to the foreground */
2693 p = getpgid(0); /* pgid of our process */
2694 debug_printf_jobs("fg'ing ourself: getpgid(0)=%d\n", (int)p);
2695 tcsetpgrp(G_interactive_fd, p);
2700 /* Start all the jobs, but don't wait for anything to finish.
2703 * Return code is normally -1, when the caller has to wait for children
2704 * to finish to determine the exit status of the pipe. If the pipe
2705 * is a simple builtin command, however, the action is done by the
2706 * time run_pipe returns, and the exit code is provided as the
2709 * Returns -1 only if started some children. IOW: we have to
2710 * mask out retvals of builtins etc with 0xff!
2712 * The only case when we do not need to [v]fork is when the pipe
2713 * is single, non-backgrounded, non-subshell command. Examples:
2714 * cmd ; ... { list } ; ...
2715 * cmd && ... { list } && ...
2716 * cmd || ... { list } || ...
2717 * If it is, then we can run cmd as a builtin, NOFORK [do we do this?],
2718 * or (if SH_STANDALONE) an applet, and we can run the { list }
2719 * with run_list(). If it isn't one of these, we fork and exec cmd.
2721 * Cases when we must fork:
2722 * non-single: cmd | cmd
2723 * backgrounded: cmd & { list } &
2724 * subshell: ( list ) [&]
2726 static int run_pipe(struct pipe *pi)
2728 static const char *const null_ptr = NULL;
2731 int pipefds[2]; /* pipefds[0] is for reading */
2732 struct command *command;
2733 char **argv_expanded;
2736 /* it is not always needed, but we aim to smaller code */
2737 int squirrel[] = { -1, -1, -1 };
2740 debug_printf_exec("run_pipe start: members:%d\n", pi->num_cmds);
2742 USE_HUSH_JOB(pi->pgrp = -1;)
2743 pi->stopped_cmds = 0;
2744 command = &(pi->cmds[0]);
2745 argv_expanded = NULL;
2747 if (pi->num_cmds != 1
2748 || pi->followup == PIPE_BG
2749 || command->grp_type == GRP_SUBSHELL
2756 debug_printf_exec(": group:%p argv:'%s'\n",
2757 command->group, command->argv ? command->argv[0] : "NONE");
2759 if (command->group) {
2760 #if ENABLE_HUSH_FUNCTIONS
2761 if (command->grp_type == GRP_FUNCTION) {
2762 /* func () { list } */
2763 bb_error_msg("here we ought to remember function definition, and go on");
2764 return EXIT_SUCCESS;
2768 debug_printf("non-subshell group\n");
2769 setup_redirects(command, squirrel);
2770 debug_printf_exec(": run_list\n");
2771 rcode = run_list(command->group) & 0xff;
2772 restore_redirects(squirrel);
2773 debug_printf_exec("run_pipe return %d\n", rcode);
2774 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2778 argv = command->argv ? command->argv : (char **) &null_ptr;
2780 const struct built_in_command *x;
2781 char **new_env = NULL;
2782 char **old_env = NULL;
2784 if (argv[command->assignment_cnt] == NULL) {
2785 /* Assignments, but no command */
2786 /* Ensure redirects take effect. Try "a=t >file" */
2787 setup_redirects(command, squirrel);
2788 restore_redirects(squirrel);
2789 /* Set shell variables */
2791 p = expand_string_to_string(*argv);
2792 debug_printf_exec("set shell var:'%s'->'%s'\n",
2794 set_local_var(p, 0, 0);
2797 /* Do we need to flag set_local_var() errors?
2798 * "assignment to readonly var" and "putenv error"
2800 return EXIT_SUCCESS;
2803 /* Expand the rest into (possibly) many strings each */
2804 argv_expanded = expand_strvec_to_strvec(argv + command->assignment_cnt);
2806 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2807 if (strcmp(argv_expanded[0], x->cmd) != 0)
2809 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
2810 debug_printf("exec with redirects only\n");
2811 setup_redirects(command, NULL);
2812 rcode = EXIT_SUCCESS;
2813 goto clean_up_and_ret1;
2815 debug_printf("builtin inline %s\n", argv_expanded[0]);
2816 /* XXX setup_redirects acts on file descriptors, not FILEs.
2817 * This is perfect for work that comes after exec().
2818 * Is it really safe for inline use? Experimentally,
2819 * things seem to work with glibc. */
2820 setup_redirects(command, squirrel);
2821 new_env = expand_assignments(argv, command->assignment_cnt);
2822 old_env = putenv_all_and_save_old(new_env);
2823 debug_printf_exec(": builtin '%s' '%s'...\n",
2824 x->cmd, argv_expanded[1]);
2825 rcode = x->function(argv_expanded) & 0xff;
2826 #if ENABLE_FEATURE_SH_STANDALONE
2829 restore_redirects(squirrel);
2830 free_strings_and_unsetenv(new_env, 1);
2831 putenv_all(old_env);
2832 free(old_env); /* not free_strings()! */
2834 free(argv_expanded);
2835 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2836 debug_printf_exec("run_pipe return %d\n", rcode);
2839 #if ENABLE_FEATURE_SH_STANDALONE
2840 i = find_applet_by_name(argv_expanded[0]);
2841 if (i >= 0 && APPLET_IS_NOFORK(i)) {
2842 setup_redirects(command, squirrel);
2843 save_nofork_data(&G.nofork_save);
2844 new_env = expand_assignments(argv, command->assignment_cnt);
2845 old_env = putenv_all_and_save_old(new_env);
2846 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n",
2847 argv_expanded[0], argv_expanded[1]);
2848 rcode = run_nofork_applet_prime(&G.nofork_save, i, argv_expanded);
2849 goto clean_up_and_ret;
2852 /* It is neither builtin nor applet. We must fork. */
2856 /* NB: argv_expanded may already be created, and that
2857 * might include `cmd` runs! Do not rerun it! We *must*
2858 * use argv_expanded if it's non-NULL */
2860 /* Going to fork a child per each pipe member */
2864 for (i = 0; i < pi->num_cmds; i++) {
2866 volatile nommu_save_t nommu_save;
2867 nommu_save.new_env = NULL;
2868 nommu_save.old_env = NULL;
2869 nommu_save.argv = NULL;
2871 command = &(pi->cmds[i]);
2872 if (command->argv) {
2873 debug_printf_exec(": pipe member '%s' '%s'...\n",
2874 command->argv[0], command->argv[1]);
2876 debug_printf_exec(": pipe member with no argv\n");
2879 /* pipes are inserted between pairs of commands */
2882 if ((i + 1) < pi->num_cmds)
2885 command->pid = BB_MMU ? fork() : vfork();
2886 if (!command->pid) { /* child */
2888 die_sleep = 0; /* let nofork's xfuncs die */
2890 /* Every child adds itself to new process group
2891 * with pgid == pid_of_first_child_in_pipe */
2892 if (G.run_list_level == 1 && G_interactive_fd) {
2895 if (pgrp < 0) /* true for 1st process only */
2897 if (setpgid(0, pgrp) == 0 && pi->followup != PIPE_BG) {
2898 /* We do it in *every* child, not just first,
2900 tcsetpgrp(G_interactive_fd, pgrp);
2904 xmove_fd(nextin, 0);
2905 xmove_fd(pipefds[1], 1); /* write end */
2907 close(pipefds[0]); /* read end */
2908 /* Like bash, explicit redirects override pipes,
2909 * and the pipe fd is available for dup'ing. */
2910 setup_redirects(command, NULL);
2912 /* Restore default handlers just prior to exec */
2913 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
2915 /* Stores to nommu_save list of env vars putenv'ed
2916 * (NOMMU, on MMU we don't need that) */
2917 /* cast away volatility... */
2918 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
2919 /* pseudo_exec() does not return */
2924 /* Clean up after vforked child */
2925 clean_up_after_re_execute();
2926 free(nommu_save.argv);
2927 free_strings_and_unsetenv(nommu_save.new_env, 1);
2928 putenv_all(nommu_save.old_env);
2930 free(argv_expanded);
2931 argv_expanded = NULL;
2932 if (command->pid < 0) { /* [v]fork failed */
2933 /* Clearly indicate, was it fork or vfork */
2934 bb_perror_msg(BB_MMU ? "fork" : "vfork");
2938 /* Second and next children need to know pid of first one */
2940 pi->pgrp = command->pid;
2946 if ((i + 1) < pi->num_cmds)
2947 close(pipefds[1]); /* write end */
2948 /* Pass read (output) pipe end to next iteration */
2949 nextin = pipefds[0];
2952 if (!pi->alive_cmds) {
2953 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
2957 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
2961 #ifndef debug_print_tree
2962 static void debug_print_tree(struct pipe *pi, int lvl)
2964 static const char *const PIPE[] = {
2970 static const char *RES[] = {
2971 [RES_NONE ] = "NONE" ,
2974 [RES_THEN ] = "THEN" ,
2975 [RES_ELIF ] = "ELIF" ,
2976 [RES_ELSE ] = "ELSE" ,
2979 #if ENABLE_HUSH_LOOPS
2980 [RES_FOR ] = "FOR" ,
2981 [RES_WHILE] = "WHILE",
2982 [RES_UNTIL] = "UNTIL",
2984 [RES_DONE ] = "DONE" ,
2986 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2989 #if ENABLE_HUSH_CASE
2990 [RES_CASE ] = "CASE" ,
2991 [RES_MATCH] = "MATCH",
2992 [RES_CASEI] = "CASEI",
2993 [RES_ESAC ] = "ESAC" ,
2995 [RES_XXXX ] = "XXXX" ,
2996 [RES_SNTX ] = "SNTX" ,
2998 static const char *const GRPTYPE[] = {
3001 #if ENABLE_HUSH_FUNCTIONS
3010 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
3011 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
3013 while (prn < pi->num_cmds) {
3014 struct command *command = &pi->cmds[prn];
3015 char **argv = command->argv;
3017 fprintf(stderr, "%*s prog %d assignment_cnt:%d",
3019 command->assignment_cnt);
3020 if (command->group) {
3021 fprintf(stderr, " group %s: (argv=%p)\n",
3022 GRPTYPE[command->grp_type],
3024 debug_print_tree(command->group, lvl+1);
3028 if (argv) while (*argv) {
3029 fprintf(stderr, " '%s'", *argv);
3032 fprintf(stderr, "\n");
3041 /* NB: called by pseudo_exec, and therefore must not modify any
3042 * global data until exec/_exit (we can be a child after vfork!) */
3043 static int run_list(struct pipe *pi)
3045 #if ENABLE_HUSH_CASE
3046 char *case_word = NULL;
3048 #if ENABLE_HUSH_LOOPS
3049 struct pipe *loop_top = NULL;
3050 char *for_varname = NULL;
3051 char **for_lcur = NULL;
3052 char **for_list = NULL;
3054 smallint flag_skip = 1;
3055 smalluint rcode = 0; /* probably just for compiler */
3056 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
3057 smalluint cond_code = 0;
3059 enum { cond_code = 0, };
3061 /*enum reserved_style*/ smallint rword = RES_NONE;
3062 /*enum reserved_style*/ smallint skip_more_for_this_rword = RES_XXXX;
3064 debug_printf_exec("run_list start lvl %d\n", G.run_list_level + 1);
3066 #if ENABLE_HUSH_LOOPS
3067 /* Check syntax for "for" */
3068 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
3069 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
3071 /* current word is FOR or IN (BOLD in comments below) */
3072 if (cpipe->next == NULL) {
3073 syntax("malformed for");
3074 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3077 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
3078 if (cpipe->next->res_word == RES_DO)
3080 /* next word is not "do". It must be "in" then ("FOR v in ...") */
3081 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
3082 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
3084 syntax("malformed for");
3085 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
3091 /* Past this point, all code paths should jump to ret: label
3092 * in order to return, no direct "return" statements please.
3093 * This helps to ensure that no memory is leaked. */
3095 ////TODO: ctrl-Z handling needs re-thinking and re-testing
3098 /* Example of nested list: "while true; do { sleep 1 | exit 2; } done".
3099 * We are saving state before entering outermost list ("while...done")
3100 * so that ctrl-Z will correctly background _entire_ outermost list,
3101 * not just a part of it (like "sleep 1 | exit 2") */
3102 if (++G.run_list_level == 1 && G_interactive_fd) {
3103 if (sigsetjmp(G.toplevel_jb, 1)) {
3104 /* ctrl-Z forked and we are parent; or ctrl-C.
3105 * Sighandler has longjmped us here */
3106 signal(SIGINT, SIG_IGN);
3107 signal(SIGTSTP, SIG_IGN);
3108 /* Restore level (we can be coming from deep inside
3110 G.run_list_level = 1;
3111 #if ENABLE_FEATURE_SH_STANDALONE
3112 if (G.nofork_save.saved) { /* if save area is valid */
3113 debug_printf_jobs("exiting nofork early\n");
3114 restore_nofork_data(&G.nofork_save);
3117 //// if (G.ctrl_z_flag) {
3118 //// /* ctrl-Z has forked and stored pid of the child in pi->pid.
3119 //// * Remember this child as background job */
3120 //// insert_bg_job(pi);
3122 /* ctrl-C. We just stop doing whatever we were doing */
3125 USE_HUSH_LOOPS(loop_top = NULL;)
3126 USE_HUSH_LOOPS(G.depth_of_loop = 0;)
3130 //// /* ctrl-Z handler will store pid etc in pi */
3131 //// G.toplevel_list = pi;
3132 //// G.ctrl_z_flag = 0;
3133 ////#if ENABLE_FEATURE_SH_STANDALONE
3134 //// G.nofork_save.saved = 0; /* in case we will run a nofork later */
3136 //// signal_SA_RESTART_empty_mask(SIGTSTP, handler_ctrl_z);
3137 //// signal(SIGINT, handler_ctrl_c);
3141 /* Go through list of pipes, (maybe) executing them. */
3142 for (; pi; pi = USE_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
3146 IF_HAS_KEYWORDS(rword = pi->res_word;)
3147 IF_HAS_NO_KEYWORDS(rword = RES_NONE;)
3148 debug_printf_exec(": rword=%d cond_code=%d skip_more=%d\n",
3149 rword, cond_code, skip_more_for_this_rword);
3150 #if ENABLE_HUSH_LOOPS
3151 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
3152 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
3154 /* start of a loop: remember where loop starts */
3159 if (rword == skip_more_for_this_rword && flag_skip) {
3160 if (pi->followup == PIPE_SEQ)
3162 /* it is "<false> && CMD" or "<true> || CMD"
3163 * and we should not execute CMD */
3167 skip_more_for_this_rword = RES_XXXX;
3170 if (rword == RES_THEN) {
3171 /* "if <false> THEN cmd": skip cmd */
3175 if (rword == RES_ELSE || rword == RES_ELIF) {
3176 /* "if <true> then ... ELSE/ELIF cmd":
3177 * skip cmd and all following ones */
3182 #if ENABLE_HUSH_LOOPS
3183 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
3185 /* first loop through for */
3187 static const char encoded_dollar_at[] ALIGN1 = {
3188 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
3189 }; /* encoded representation of "$@" */
3190 static const char *const encoded_dollar_at_argv[] = {
3191 encoded_dollar_at, NULL
3192 }; /* argv list with one element: "$@" */
3195 vals = (char**)encoded_dollar_at_argv;
3196 if (pi->next->res_word == RES_IN) {
3197 /* if no variable values after "in" we skip "for" */
3198 if (!pi->next->cmds[0].argv)
3200 vals = pi->next->cmds[0].argv;
3201 } /* else: "for var; do..." -> assume "$@" list */
3202 /* create list of variable values */
3203 debug_print_strings("for_list made from", vals);
3204 for_list = expand_strvec_to_strvec(vals);
3205 for_lcur = for_list;
3206 debug_print_strings("for_list", for_list);
3207 for_varname = pi->cmds[0].argv[0];
3208 pi->cmds[0].argv[0] = NULL;
3210 free(pi->cmds[0].argv[0]);
3212 /* "for" loop is over, clean up */
3216 pi->cmds[0].argv[0] = for_varname;
3219 /* insert next value from for_lcur */
3220 //TODO: does it need escaping?
3221 pi->cmds[0].argv[0] = xasprintf("%s=%s", for_varname, *for_lcur++);
3222 pi->cmds[0].assignment_cnt = 1;
3224 if (rword == RES_IN) {
3225 continue; /* "for v IN list;..." - "in" has no cmds anyway */
3227 if (rword == RES_DONE) {
3228 continue; /* "done" has no cmds too */
3231 #if ENABLE_HUSH_CASE
3232 if (rword == RES_CASE) {
3233 case_word = expand_strvec_to_string(pi->cmds->argv);
3236 if (rword == RES_MATCH) {
3239 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
3241 /* all prev words didn't match, does this one match? */
3242 argv = pi->cmds->argv;
3244 char *pattern = expand_string_to_string(*argv);
3245 /* TODO: which FNM_xxx flags to use? */
3246 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
3248 if (cond_code == 0) { /* match! we will execute this branch */
3249 free(case_word); /* make future "word)" stop */
3257 if (rword == RES_CASEI) { /* inside of a case branch */
3259 continue; /* not matched yet, skip this pipe */
3262 /* Just pressing <enter> in shell should check for jobs.
3263 * OTOH, in non-interactive shell this is useless
3264 * and only leads to extra job checks */
3265 if (pi->num_cmds == 0) {
3266 if (G_interactive_fd)
3267 goto check_jobs_and_continue;
3271 /* After analyzing all keywords and conditions, we decided
3272 * to execute this pipe. NB: have to do checkjobs(NULL)
3273 * after run_pipe() to collect any background children,
3274 * even if list execution is to be stopped. */
3275 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
3278 #if ENABLE_HUSH_LOOPS
3279 G.flag_break_continue = 0;
3281 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
3283 /* we only ran a builtin: rcode is already known
3284 * and we don't need to wait for anything. */
3285 check_and_run_traps(0);
3286 #if ENABLE_HUSH_LOOPS
3287 /* was it "break" or "continue"? */
3288 if (G.flag_break_continue) {
3289 smallint fbc = G.flag_break_continue;
3290 /* we might fall into outer *loop*,
3291 * don't want to break it too */
3293 G.depth_break_continue--;
3294 if (G.depth_break_continue == 0)
3295 G.flag_break_continue = 0;
3296 /* else: e.g. "continue 2" should *break* once, *then* continue */
3297 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
3298 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
3299 goto check_jobs_and_break;
3300 /* "continue": simulate end of loop */
3305 } else if (pi->followup == PIPE_BG) {
3306 /* what does bash do with attempts to background builtins? */
3307 /* even bash 3.2 doesn't do that well with nested bg:
3308 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
3309 * I'm NOT treating inner &'s as jobs */
3310 check_and_run_traps(0);
3312 if (G.run_list_level == 1)
3315 rcode = 0; /* EXIT_SUCCESS */
3318 if (G.run_list_level == 1 && G_interactive_fd) {
3319 /* waits for completion, then fg's main shell */
3320 rcode = checkjobs_and_fg_shell(pi);
3321 check_and_run_traps(0);
3322 debug_printf_exec(": checkjobs_and_fg_shell returned %d\n", rcode);
3325 { /* this one just waits for completion */
3326 rcode = checkjobs(pi);
3327 check_and_run_traps(0);
3328 debug_printf_exec(": checkjobs returned %d\n", rcode);
3332 debug_printf_exec(": setting last_return_code=%d\n", rcode);
3333 G.last_return_code = rcode;
3335 /* Analyze how result affects subsequent commands */
3337 if (rword == RES_IF || rword == RES_ELIF)
3340 #if ENABLE_HUSH_LOOPS
3341 if (rword == RES_WHILE) {
3343 rcode = 0; /* "while false; do...done" - exitcode 0 */
3344 goto check_jobs_and_break;
3347 if (rword == RES_UNTIL) {
3349 check_jobs_and_break:
3355 if ((rcode == 0 && pi->followup == PIPE_OR)
3356 || (rcode != 0 && pi->followup == PIPE_AND)
3358 skip_more_for_this_rword = rword;
3361 check_jobs_and_continue:
3366 //// if (G.ctrl_z_flag) {
3367 //// /* ctrl-Z forked somewhere in the past, we are the child,
3368 //// * and now we completed running the list. Exit. */
3374 //// if (!G.run_list_level && G_interactive_fd) {
3375 //// signal(SIGTSTP, SIG_IGN);
3376 //// signal(SIGINT, SIG_IGN);
3379 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
3380 #if ENABLE_HUSH_LOOPS
3385 #if ENABLE_HUSH_CASE
3391 /* Select which version we will use */
3392 static int run_and_free_list(struct pipe *pi)
3395 debug_printf_exec("run_and_free_list entered\n");
3397 debug_printf_exec(": run_list with %d members\n", pi->num_cmds);
3398 rcode = run_list(pi);
3400 /* free_pipe_list has the side effect of clearing memory.
3401 * In the long run that function can be merged with run_list,
3402 * but doing that now would hobble the debugging effort. */
3403 free_pipe_list(pi, /* indent: */ 0);
3404 debug_printf_exec("run_and_free_list return %d\n", rcode);
3409 /* Peek ahead in the in_str to find out if we have a "&n" construct,
3410 * as in "2>&1", that represents duplicating a file descriptor.
3411 * Return either -2 (syntax error), -1 (no &), or the number found.
3413 static int redirect_dup_num(struct in_str *input)
3415 int ch, d = 0, ok = 0;
3417 if (ch != '&') return -1;
3419 i_getch(input); /* get the & */
3423 return -3; /* "-" represents "close me" */
3425 while (isdigit(ch)) {
3426 d = d*10 + (ch-'0');
3433 bb_error_msg("ambiguous redirect");
3437 /* The src parameter allows us to peek forward to a possible &n syntax
3438 * for file descriptor duplication, e.g., "2>&1".
3439 * Return code is 0 normally, 1 if a syntax error is detected in src.
3440 * Resource errors (in xmalloc) cause the process to exit */
3441 static int setup_redirect(struct parse_context *ctx,
3444 struct in_str *input)
3446 struct command *command = ctx->command;
3447 struct redir_struct *redir;
3448 struct redir_struct **redirp;
3451 /* Check for a '2>&1' type redirect */
3452 dup_num = redirect_dup_num(input);
3454 return 1; /* syntax error */
3456 /* Create a new redir_struct and drop it onto the end of the linked list */
3457 redirp = &command->redirects;
3458 while ((redir = *redirp) != NULL) {
3459 redirp = &(redir->next);
3461 *redirp = redir = xzalloc(sizeof(*redir));
3462 /* redir->next = NULL; */
3463 /* redir->rd_filename = NULL; */
3464 redir->rd_type = style;
3465 redir->fd = (fd == -1) ? redir_table[style].default_fd : fd;
3467 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
3469 redir->dup = dup_num;
3470 if (dup_num != -1) {
3471 /* Erik had a check here that the file descriptor in question
3472 * is legit; I postpone that to "run time"
3473 * A "-" representation of "close me" shows up as a -3 here */
3474 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
3476 /* We do _not_ try to open the file that src points to,
3477 * since we need to return and let src be expanded first.
3478 * Set ctx->pending_redirect, so we know what to do at the
3479 * end of the next parsed word. */
3480 ctx->pending_redirect = redir;
3486 static struct pipe *new_pipe(void)
3489 pi = xzalloc(sizeof(struct pipe));
3490 /*pi->followup = 0; - deliberately invalid value */
3491 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3495 /* Command (member of a pipe) is complete. The only possible error here
3496 * is out of memory, in which case xmalloc exits. */
3497 static int done_command(struct parse_context *ctx)
3499 /* The command is really already in the pipe structure, so
3500 * advance the pipe counter and make a new, null command. */
3501 struct pipe *pi = ctx->pipe;
3502 struct command *command = ctx->command;
3505 if (command->group == NULL
3506 && command->argv == NULL
3507 && command->redirects == NULL
3509 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3510 return pi->num_cmds;
3513 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3515 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3518 /* Only real trickiness here is that the uncommitted
3519 * command structure is not counted in pi->num_cmds. */
3520 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3521 command = &pi->cmds[pi->num_cmds];
3522 memset(command, 0, sizeof(*command));
3524 ctx->command = command;
3525 /* but ctx->pipe and ctx->list_head remain unchanged */
3527 return pi->num_cmds; /* used only for 0/nonzero check */
3530 static void done_pipe(struct parse_context *ctx, pipe_style type)
3534 debug_printf_parse("done_pipe entered, followup %d\n", type);
3535 /* Close previous command */
3536 not_null = done_command(ctx);
3537 ctx->pipe->followup = type;
3538 IF_HAS_KEYWORDS(ctx->pipe->pi_inverted = ctx->ctx_inverted;)
3539 IF_HAS_KEYWORDS(ctx->ctx_inverted = 0;)
3540 IF_HAS_KEYWORDS(ctx->pipe->res_word = ctx->ctx_res_w;)
3542 /* Without this check, even just <enter> on command line generates
3543 * tree of three NOPs (!). Which is harmless but annoying.
3544 * IOW: it is safe to do it unconditionally.
3545 * RES_NONE case is for "for a in; do ..." (empty IN set)
3546 * to work, possibly other cases too. */
3547 if (not_null IF_HAS_KEYWORDS(|| ctx->ctx_res_w != RES_NONE)) {
3549 debug_printf_parse("done_pipe: adding new pipe: "
3550 "not_null:%d ctx->ctx_res_w:%d\n",
3551 not_null, ctx->ctx_res_w);
3553 ctx->pipe->next = new_p;
3555 /* RES_THEN, RES_DO etc are "sticky" -
3556 * they remain set for commands inside if/while.
3557 * This is used to control execution.
3558 * RES_FOR and RES_IN are NOT sticky (needed to support
3559 * cases where variable or value happens to match a keyword):
3561 #if ENABLE_HUSH_LOOPS
3562 if (ctx->ctx_res_w == RES_FOR
3563 || ctx->ctx_res_w == RES_IN)
3564 ctx->ctx_res_w = RES_NONE;
3566 #if ENABLE_HUSH_CASE
3567 if (ctx->ctx_res_w == RES_MATCH)
3568 ctx->ctx_res_w = RES_CASEI;
3570 ctx->command = NULL; /* trick done_command below */
3571 /* Create the memory for command, roughly:
3572 * ctx->pipe->cmds = new struct command;
3573 * ctx->command = &ctx->pipe->cmds[0];
3577 debug_printf_parse("done_pipe return\n");
3580 static void initialize_context(struct parse_context *ctx)
3582 memset(ctx, 0, sizeof(*ctx));
3583 ctx->pipe = ctx->list_head = new_pipe();
3584 /* Create the memory for command, roughly:
3585 * ctx->pipe->cmds = new struct command;
3586 * ctx->command = &ctx->pipe->cmds[0];
3592 /* If a reserved word is found and processed, parse context is modified
3593 * and 1 is returned.
3596 struct reserved_combo {
3599 unsigned char assignment_flag;
3603 FLAG_END = (1 << RES_NONE ),
3605 FLAG_IF = (1 << RES_IF ),
3606 FLAG_THEN = (1 << RES_THEN ),
3607 FLAG_ELIF = (1 << RES_ELIF ),
3608 FLAG_ELSE = (1 << RES_ELSE ),
3609 FLAG_FI = (1 << RES_FI ),
3611 #if ENABLE_HUSH_LOOPS
3612 FLAG_FOR = (1 << RES_FOR ),
3613 FLAG_WHILE = (1 << RES_WHILE),
3614 FLAG_UNTIL = (1 << RES_UNTIL),
3615 FLAG_DO = (1 << RES_DO ),
3616 FLAG_DONE = (1 << RES_DONE ),
3617 FLAG_IN = (1 << RES_IN ),
3619 #if ENABLE_HUSH_CASE
3620 FLAG_MATCH = (1 << RES_MATCH),
3621 FLAG_ESAC = (1 << RES_ESAC ),
3623 FLAG_START = (1 << RES_XXXX ),
3626 static const struct reserved_combo* match_reserved_word(o_string *word)
3628 /* Mostly a list of accepted follow-up reserved words.
3629 * FLAG_END means we are done with the sequence, and are ready
3630 * to turn the compound list into a command.
3631 * FLAG_START means the word must start a new compound list.
3633 static const struct reserved_combo reserved_list[] = {
3635 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3636 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
3637 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3638 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
3639 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
3640 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3642 #if ENABLE_HUSH_LOOPS
3643 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3644 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3645 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3646 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3647 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
3648 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3650 #if ENABLE_HUSH_CASE
3651 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3652 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3655 const struct reserved_combo *r;
3657 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3658 if (strcmp(word->data, r->literal) == 0)
3663 static int reserved_word(o_string *word, struct parse_context *ctx)
3665 #if ENABLE_HUSH_CASE
3666 static const struct reserved_combo reserved_match = {
3667 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3670 const struct reserved_combo *r;
3672 r = match_reserved_word(word);
3676 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3677 #if ENABLE_HUSH_CASE
3678 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE)
3679 /* "case word IN ..." - IN part starts first match part */
3680 r = &reserved_match;
3683 if (r->flag == 0) { /* '!' */
3684 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3685 syntax("! ! command");
3686 IF_HAS_KEYWORDS(ctx->ctx_res_w = RES_SNTX;)
3688 ctx->ctx_inverted = 1;
3691 if (r->flag & FLAG_START) {
3692 struct parse_context *old;
3693 old = xmalloc(sizeof(*old));
3694 debug_printf_parse("push stack %p\n", old);
3695 *old = *ctx; /* physical copy */
3696 initialize_context(ctx);
3698 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3700 ctx->ctx_res_w = RES_SNTX;
3703 ctx->ctx_res_w = r->res;
3704 ctx->old_flag = r->flag;
3705 if (ctx->old_flag & FLAG_END) {
3706 struct parse_context *old;
3707 done_pipe(ctx, PIPE_SEQ);
3708 debug_printf_parse("pop stack %p\n", ctx->stack);
3710 old->command->group = ctx->list_head;
3711 old->command->grp_type = GRP_NORMAL;
3713 o_addstr(&old->as_string, ctx->as_string.data);
3714 o_free_unsafe(&ctx->as_string);
3715 old->command->group_as_string = xstrdup(old->as_string.data);
3716 debug_printf_parse("pop, remembering as:'%s'\n",
3717 old->command->group_as_string);
3719 *ctx = *old; /* physical copy */
3722 word->o_assignment = r->assignment_flag;
3727 /* Word is complete, look at it and update parsing context.
3728 * Normal return is 0. Syntax errors return 1.
3729 * Note: on return, word is reset, but not o_free'd!
3731 static int done_word(o_string *word, struct parse_context *ctx)
3733 struct command *command = ctx->command;
3735 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3736 if (word->length == 0 && word->nonnull == 0) {
3737 debug_printf_parse("done_word return 0: true null, ignored\n");
3740 /* If this word wasn't an assignment, next ones definitely
3741 * can't be assignments. Even if they look like ones. */
3742 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3743 && word->o_assignment != WORD_IS_KEYWORD
3745 word->o_assignment = NOT_ASSIGNMENT;
3747 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3748 command->assignment_cnt++;
3749 word->o_assignment = MAYBE_ASSIGNMENT;
3752 if (ctx->pending_redirect) {
3753 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3754 * only if run as "bash", not "sh" */
3755 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3756 word->o_assignment = NOT_ASSIGNMENT;
3757 debug_printf("word stored in rd_filename: '%s'\n", word->data);
3759 /* "{ echo foo; } echo bar" - bad */
3760 /* NB: bash allows e.g.:
3761 * if true; then { echo foo; } fi
3762 * while if false; then false; fi do break; done
3764 if (command->group) {
3766 debug_printf_parse("done_word return 1: syntax error, "
3767 "groups and arglists don't mix\n");
3771 #if ENABLE_HUSH_CASE
3772 if (ctx->ctx_dsemicolon
3773 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3775 /* already done when ctx_dsemicolon was set to 1: */
3776 /* ctx->ctx_res_w = RES_MATCH; */
3777 ctx->ctx_dsemicolon = 0;
3780 if (!command->argv /* if it's the first word... */
3781 #if ENABLE_HUSH_LOOPS
3782 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3783 && ctx->ctx_res_w != RES_IN
3786 debug_printf_parse(": checking '%s' for reserved-ness\n", word->data);
3787 if (reserved_word(word, ctx)) {
3789 debug_printf_parse("done_word return %d\n",
3790 (ctx->ctx_res_w == RES_SNTX));
3791 return (ctx->ctx_res_w == RES_SNTX);
3795 if (word->nonnull /* word had "xx" or 'xx' at least as part of it. */
3796 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3797 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3798 /* (otherwise it's known to be not empty and is already safe) */
3800 /* exclude "$@" - it can expand to no word despite "" */
3801 char *p = word->data;
3802 while (p[0] == SPECIAL_VAR_SYMBOL
3803 && (p[1] & 0x7f) == '@'
3804 && p[2] == SPECIAL_VAR_SYMBOL
3808 if (p == word->data || p[0] != '\0') {
3809 /* saw no "$@", or not only "$@" but some
3810 * real text is there too */
3811 /* insert "empty variable" reference, this makes
3812 * e.g. "", $empty"" etc to not disappear */
3813 o_addchr(word, SPECIAL_VAR_SYMBOL);
3814 o_addchr(word, SPECIAL_VAR_SYMBOL);
3817 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3818 debug_print_strings("word appended to argv", command->argv);
3822 ctx->pending_redirect = NULL;
3824 #if ENABLE_HUSH_LOOPS
3825 /* Force FOR to have just one word (variable name) */
3826 /* NB: basically, this makes hush see "for v in ..." syntax as if
3827 * as it is "for v; in ...". FOR and IN become two pipe structs
3829 if (ctx->ctx_res_w == RES_FOR) {
3830 //TODO: check that command->argv[0] is a valid variable name!
3831 done_pipe(ctx, PIPE_SEQ);
3834 #if ENABLE_HUSH_CASE
3835 /* Force CASE to have just one word */
3836 if (ctx->ctx_res_w == RES_CASE) {
3837 done_pipe(ctx, PIPE_SEQ);
3840 debug_printf_parse("done_word return 0\n");
3844 /* If a redirect is immediately preceded by a number, that number is
3845 * supposed to tell which file descriptor to redirect. This routine
3846 * looks for such preceding numbers. In an ideal world this routine
3847 * needs to handle all the following classes of redirects...
3848 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3849 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3850 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3851 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3852 * A -1 output from this program means no valid number was found, so the
3853 * caller should use the appropriate default for this redirection.
3855 static int redirect_opt_num(o_string *o)
3861 for (num = 0; num < o->length; num++) {
3862 if (!isdigit(o->data[num])) {
3866 num = atoi(o->data);
3872 #define parse_stream(pstring, input, end_trigger) \
3873 parse_stream(input, end_trigger)
3875 static struct pipe *parse_stream(char **pstring,
3876 struct in_str *input,
3878 static void parse_and_run_string(const char *s);
3880 #if ENABLE_HUSH_TICK
3881 static FILE *generate_stream_from_string(const char *s)
3884 int pid, channel[2];
3887 pid = BB_MMU ? fork() : vfork();
3889 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3891 if (pid == 0) { /* child */
3892 /* Process substitution is not considered to be usual
3893 * 'command execution'.
3894 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
3901 if (ENABLE_HUSH_JOB)
3902 die_sleep = 0; /* let nofork's xfuncs die */
3903 close(channel[0]); /* NB: close _first_, then move fd! */
3904 xmove_fd(channel[1], 1);
3905 /* Prevent it from trying to handle ctrl-z etc */
3906 USE_HUSH_JOB(G.run_list_level = 1;)
3908 parse_and_run_string(s);
3909 _exit(G.last_return_code);
3911 /* We re-execute after vfork on NOMMU. This makes this script safe:
3912 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >TESTFILE
3913 * huge=`cat TESTFILE` # was blocking here forever
3916 re_execute_shell(s);
3921 clean_up_after_re_execute();
3923 pf = fdopen(channel[0], "r");
3927 /* Return code is exit status of the process that is run. */
3928 static int process_command_subs(o_string *dest, const char *s)
3931 struct in_str pipe_str;
3934 pf = generate_stream_from_string(s);
3937 close_on_exec_on(fileno(pf));
3939 /* Now send results of command back into original context */
3940 setup_file_in_str(&pipe_str, pf);
3942 while ((ch = i_getch(&pipe_str)) != EOF) {
3948 o_addchr(dest, '\n');
3951 o_addQchr(dest, ch);
3954 debug_printf("done reading from pipe, pclose()ing\n");
3955 /* Note: we got EOF, and we just close the read end of the pipe.
3956 * We do not wait for the `cmd` child to terminate. bash and ash do.
3958 * echo `echo Hi; exec 1>&-; sleep 2` - bash waits 2 sec
3959 * `false`; echo $? - bash outputs "1"
3962 debug_printf("closed FILE from child. return 0\n");
3967 static int parse_group(o_string *dest, struct parse_context *ctx,
3968 struct in_str *input, int ch)
3970 /* dest contains characters seen prior to ( or {.
3971 * Typically it's empty, but for function defs,
3972 * it contains function name (without '()'). */
3973 struct pipe *pipe_list;
3975 struct command *command = ctx->command;
3977 debug_printf_parse("parse_group entered\n");
3978 #if ENABLE_HUSH_FUNCTIONS
3979 if (ch == 'F') { /* function definition? */
3980 bb_error_msg("aha '%s' is a function, parsing it...", dest->data);
3981 //command->fname = dest->data;
3982 command->grp_type = GRP_FUNCTION;
3983 //TODO: review every o_reset() location... do they handle all o_string fields correctly?
3984 memset(dest, 0, sizeof(*dest));
3987 if (command->argv /* word [word](... */
3988 || dest->length /* word(... */
3989 || dest->nonnull /* ""(... */
3992 debug_printf_parse("parse_group return 1: "
3993 "syntax error, groups and arglists don't mix\n");
3999 command->grp_type = GRP_SUBSHELL;
4003 char *as_string = NULL;
4005 pipe_list = parse_stream(&as_string, input, endch);
4008 o_addstr(&ctx->as_string, as_string);
4010 /* empty ()/{} or parse error? */
4011 if (!pipe_list || pipe_list == ERR_PTR) {
4016 debug_printf_parse("parse_group return 1: "
4017 "parse_stream returned %p\n", pipe_list);
4020 command->group = pipe_list;
4022 as_string[strlen(as_string) - 1] = '\0'; /* plink ')' or '}' */
4023 command->group_as_string = as_string;
4024 debug_printf_parse("end of group, remembering as:'%s'\n",
4025 command->group_as_string);
4028 debug_printf_parse("parse_group return 0\n");
4030 /* command remains "open", available for possible redirects */
4033 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
4034 /* Subroutines for copying $(...) and `...` things */
4035 static void add_till_backquote(o_string *dest, struct in_str *input);
4037 static void add_till_single_quote(o_string *dest, struct in_str *input)
4040 int ch = i_getch(input);
4048 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
4049 static void add_till_double_quote(o_string *dest, struct in_str *input)
4052 int ch = i_getch(input);
4055 if (ch == '\\') { /* \x. Copy both chars. */
4057 ch = i_getch(input);
4063 add_till_backquote(dest, input);
4067 //if (ch == '$') ...
4070 /* Process `cmd` - copy contents until "`" is seen. Complicated by
4072 * "Within the backquoted style of command substitution, backslash
4073 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
4074 * The search for the matching backquote shall be satisfied by the first
4075 * backquote found without a preceding backslash; during this search,
4076 * if a non-escaped backquote is encountered within a shell comment,
4077 * a here-document, an embedded command substitution of the $(command)
4078 * form, or a quoted string, undefined results occur. A single-quoted
4079 * or double-quoted string that begins, but does not end, within the
4080 * "`...`" sequence produces undefined results."
4082 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
4084 static void add_till_backquote(o_string *dest, struct in_str *input)
4087 int ch = i_getch(input);
4090 if (ch == '\\') { /* \x. Copy both chars unless it is \` */
4091 int ch2 = i_getch(input);
4092 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
4101 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
4102 * quoting and nested ()s.
4103 * "With the $(command) style of command substitution, all characters
4104 * following the open parenthesis to the matching closing parenthesis
4105 * constitute the command. Any valid shell script can be used for command,
4106 * except a script consisting solely of redirections which produces
4107 * unspecified results."
4109 * echo $(echo '(TEST)' BEST) (TEST) BEST
4110 * echo $(echo 'TEST)' BEST) TEST) BEST
4111 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
4113 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
4117 int ch = i_getch(input);
4126 if (i_peek(input) == ')') {
4134 add_till_single_quote(dest, input);
4139 add_till_double_quote(dest, input);
4143 if (ch == '\\') { /* \x. Copy verbatim. Important for \(, \) */
4144 ch = i_getch(input);
4152 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
4154 /* Return code: 0 for OK, 1 for syntax error */
4156 #define handle_dollar(ctx, dest, input) \
4157 handle_dollar(dest, input)
4159 static int handle_dollar(struct parse_context *ctx,
4161 struct in_str *input)
4164 int ch = i_peek(input); /* first character after the $ */
4165 unsigned char quote_mask = dest->o_escape ? 0x80 : 0;
4167 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
4169 ch = i_getch(input);
4171 if (ctx) o_addchr(&ctx->as_string, ch);
4174 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4176 debug_printf_parse(": '%c'\n", ch);
4177 o_addchr(dest, ch | quote_mask);
4180 if (!isalnum(ch) && ch != '_')
4182 ch = i_getch(input);
4184 if (ctx) o_addchr(&ctx->as_string, ch);
4187 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4188 } else if (isdigit(ch)) {
4190 ch = i_getch(input);
4192 if (ctx) o_addchr(&ctx->as_string, ch);
4194 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4195 debug_printf_parse(": '%c'\n", ch);
4196 o_addchr(dest, ch | quote_mask);
4197 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4198 } else switch (ch) {
4200 case '!': /* last bg pid */
4201 case '?': /* last exit code */
4202 case '#': /* number of args */
4203 case '*': /* args */
4204 case '@': /* args */
4205 goto make_one_char_var;
4207 bool first_char, all_digits;
4209 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4210 ch = i_getch(input);
4212 if (ctx) o_addchr(&ctx->as_string, ch);
4214 /* XXX maybe someone will try to escape the '}' */
4219 ch = i_getch(input);
4221 if (ctx) o_addchr(&ctx->as_string, ch);
4228 /* ${#var}: length of var contents */
4230 else if (isdigit(ch)) {
4237 && ( (all_digits && !isdigit(ch))
4238 || (!all_digits && !isalnum(ch) && ch != '_')
4241 /* handle parameter expansions
4242 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4247 case ':': /* null modifier */
4248 if (expansion == 0) {
4249 debug_printf_parse(": null modifier\n");
4254 #if 0 /* not implemented yet :( */
4255 case '#': /* remove prefix */
4256 case '%': /* remove suffix */
4257 if (expansion == 0) {
4258 debug_printf_parse(": remove suffix/prefix\n");
4264 case '-': /* default value */
4265 case '=': /* assign default */
4266 case '+': /* alternative */
4267 case '?': /* error indicate */
4268 debug_printf_parse(": parameter expansion\n");
4273 syntax("unterminated ${name}");
4274 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
4279 debug_printf_parse(": '%c'\n", ch);
4280 o_addchr(dest, ch | quote_mask);
4284 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4287 #if (ENABLE_SH_MATH_SUPPORT || ENABLE_HUSH_TICK)
4292 ch = i_getch(input);
4294 if (ctx) o_addchr(&ctx->as_string, ch);
4296 # if ENABLE_SH_MATH_SUPPORT
4297 if (i_peek(input) == '(') {
4298 ch = i_getch(input);
4300 if (ctx) o_addchr(&ctx->as_string, ch);
4302 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4303 o_addchr(dest, /*quote_mask |*/ '+');
4307 add_till_closing_paren(dest, input, true);
4310 o_addstr(&ctx->as_string, dest->data + pos);
4311 o_addchr(&ctx->as_string, ')');
4312 o_addchr(&ctx->as_string, ')');
4315 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4319 # if ENABLE_HUSH_TICK
4320 //int pos = dest->length;
4321 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4322 o_addchr(dest, quote_mask | '`');
4326 add_till_closing_paren(dest, input, false);
4329 o_addstr(&ctx->as_string, dest->data + pos);
4330 o_addchr(&ctx->as_string, '`');
4333 //debug_printf_subst("SUBST RES2 '%s'\n", dest->data + pos);
4334 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4340 ch = i_getch(input);
4342 if (ctx) o_addchr(&ctx->as_string, ch);
4345 if (isalnum(ch)) { /* it's $_name or $_123 */
4351 /* $_ Shell or shell script name; or last cmd name */
4352 /* $- Option flags set by set builtin or shell options (-i etc) */
4354 o_addQchr(dest, '$');
4356 debug_printf_parse("handle_dollar return 0\n");
4361 #define parse_stream_dquoted(ctx, dest, input, dquote_end) \
4362 parse_stream_dquoted(dest, input, dquote_end)
4364 static int parse_stream_dquoted(struct parse_context *ctx,
4366 struct in_str *input,
4373 ch = i_getch(input);
4375 if (ctx && ch != EOF)
4376 o_addchr(&ctx->as_string, ch);
4378 if (ch == dquote_end) { /* may be only '"' or EOF */
4380 if (dest->o_assignment == NOT_ASSIGNMENT)
4381 dest->o_escape ^= 1;
4382 debug_printf_parse("parse_stream_dquoted return 0\n");
4386 syntax("unterminated \"");
4387 debug_printf_parse("parse_stream_dquoted return 1: unterminated \"\n");
4392 next = i_peek(input);
4394 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4395 ch, ch, dest->o_escape);
4399 debug_printf_parse("parse_stream_dquoted return 1: \\<eof>\n");
4403 * "The backslash retains its special meaning [in "..."]
4404 * only when followed by one of the following characters:
4405 * $, `, ", \, or <newline>. A double quote may be quoted
4406 * within double quotes by preceding it with a backslash.
4407 * If enabled, history expansion will be performed unless
4408 * an ! appearing in double quotes is escaped using
4409 * a backslash. The backslash preceding the ! is not removed."
4411 if (strchr("$`\"\\", next) != NULL) {
4412 o_addqchr(dest, i_getch(input));
4414 o_addqchr(dest, '\\');
4419 if (handle_dollar(ctx, dest, input) != 0) {
4420 debug_printf_parse("parse_stream_dquoted return 1: "
4421 "handle_dollar returned non-0\n");
4426 #if ENABLE_HUSH_TICK
4428 //int pos = dest->length;
4429 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4430 o_addchr(dest, 0x80 | '`');
4431 add_till_backquote(dest, input);
4432 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4433 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4437 o_addQchr(dest, ch);
4439 && (dest->o_assignment == MAYBE_ASSIGNMENT
4440 || dest->o_assignment == WORD_IS_KEYWORD)
4441 && is_assignment(dest->data)
4443 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4449 * Scan input until EOF or end_trigger char.
4450 * Return a list of pipes to execute, or NULL on EOF
4451 * or if end_trigger character is met.
4452 * On syntax error, exit is shell is not interactive,
4453 * reset parsing machinery and start parsing anew,
4454 * or return ERR_PTR.
4456 static struct pipe *parse_stream(char **pstring,
4457 struct in_str *input,
4460 struct parse_context ctx;
4461 o_string dest = NULL_O_STRING;
4464 /* Double-quote state is handled in the state variable is_in_dquote.
4465 * A single-quote triggers a bypass of the main loop until its mate is
4466 * found. When recursing, quote state is passed in via dest->o_escape.
4468 debug_printf_parse("parse_stream entered, end_trigger='%c'\n",
4469 end_trigger ? : 'X');
4471 G.ifs = get_local_var_value("IFS");
4476 #if ENABLE_HUSH_INTERACTIVE
4477 input->promptmode = 0; /* PS1 */
4479 /* dest.o_assignment = MAYBE_ASSIGNMENT; - already is */
4480 initialize_context(&ctx);
4484 const char *is_special;
4488 redir_type redir_style;
4491 if (parse_stream_dquoted(&ctx, &dest, input, '"')) {
4494 /* We reached closing '"' */
4497 ch = i_getch(input);
4498 debug_printf_parse(": ch=%c (%d) escape=%d\n",
4499 ch, ch, dest.o_escape);
4502 if (done_word(&dest, &ctx)) {
4506 done_pipe(&ctx, PIPE_SEQ);
4508 /* If we got nothing... */
4509 // TODO: test script consisting of just "&"
4510 if (pi->num_cmds == 0
4511 IF_HAS_KEYWORDS( && pi->res_word == RES_NONE)
4513 free_pipe_list(pi, 0);
4516 debug_printf_parse("parse_stream return %p\n", pi);
4518 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4520 *pstring = ctx.as_string.data;
4522 o_free_unsafe(&ctx.as_string);
4527 o_addchr(&ctx.as_string, ch);
4529 is_ifs = strchr(G.ifs, ch);
4530 is_special = strchr("<>;&|(){}#'" /* special outside of "str" */
4531 "\\$\"" USE_HUSH_TICK("`") /* always special */
4534 if (!is_special && !is_ifs) { /* ordinary char */
4535 o_addQchr(&dest, ch);
4536 if ((dest.o_assignment == MAYBE_ASSIGNMENT
4537 || dest.o_assignment == WORD_IS_KEYWORD)
4539 && is_assignment(dest.data)
4541 dest.o_assignment = DEFINITELY_ASSIGNMENT;
4547 if (done_word(&dest, &ctx)) {
4551 #if ENABLE_HUSH_CASE
4552 /* "case ... in <newline> word) ..." -
4553 * newlines are ignored (but ';' wouldn't be) */
4554 if (ctx.command->argv == NULL
4555 && ctx.ctx_res_w == RES_MATCH
4560 /* Treat newline as a command separator. */
4561 done_pipe(&ctx, PIPE_SEQ);
4562 dest.o_assignment = MAYBE_ASSIGNMENT;
4564 /* note: if (is_ifs) continue;
4565 * will still trigger for us */
4568 if (end_trigger && end_trigger == ch) {
4569 //TODO: disallow "{ cmd }" without semicolon
4570 if (done_word(&dest, &ctx)) {
4573 done_pipe(&ctx, PIPE_SEQ);
4574 dest.o_assignment = MAYBE_ASSIGNMENT;
4575 /* Do we sit outside of any if's, loops or case's? */
4577 IF_HAS_KEYWORDS(|| (ctx.ctx_res_w == RES_NONE && ctx.old_flag == 0))
4579 debug_printf_parse("parse_stream return %p: "
4580 "end_trigger char found\n",
4584 debug_printf_parse("as_string '%s'\n", ctx.as_string.data);
4586 *pstring = ctx.as_string.data;
4588 o_free_unsafe(&ctx.as_string);
4590 return ctx.list_head;
4596 if (dest.o_assignment == MAYBE_ASSIGNMENT) {
4597 /* ch is a special char and thus this word
4598 * cannot be an assignment */
4599 dest.o_assignment = NOT_ASSIGNMENT;
4604 next = i_peek(input);
4609 if (dest.length == 0) {
4612 if (ch == EOF || ch == '\n')
4615 /* note: we do not add it to &ctx.as_string */
4618 //TODO: go back one char?
4619 o_addchr(&ctx.as_string, '\n');
4622 o_addQchr(&dest, ch);
4630 o_addchr(&dest, '\\');
4631 ch = i_getch(input);
4632 o_addchr(&dest, ch);
4634 o_addchr(&ctx.as_string, ch);
4639 if (handle_dollar(&ctx, &dest, input) != 0) {
4640 debug_printf_parse("parse_stream parse error: "
4641 "handle_dollar returned non-0\n");
4648 ch = i_getch(input);
4650 syntax("unterminated '");
4654 o_addchr(&ctx.as_string, ch);
4658 if (dest.o_assignment == NOT_ASSIGNMENT)
4659 o_addqchr(&dest, ch);
4661 o_addchr(&dest, ch);
4666 is_in_dquote ^= 1; /* invert */
4667 if (dest.o_assignment == NOT_ASSIGNMENT)
4670 #if ENABLE_HUSH_TICK
4672 //int pos = dest.length;
4673 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4674 o_addchr(&dest, '`');
4675 add_till_backquote(&dest, input);
4676 o_addchr(&dest, SPECIAL_VAR_SYMBOL);
4677 //debug_printf_subst("SUBST RES3 '%s'\n", dest.data + pos);
4682 redir_fd = redirect_opt_num(&dest);
4683 if (done_word(&dest, &ctx)) {
4686 redir_style = REDIRECT_OVERWRITE;
4688 redir_style = REDIRECT_APPEND;
4689 ch = i_getch(input);
4691 o_addchr(&ctx.as_string, ch);
4695 else if (next == '(') {
4696 syntax(">(process) not supported");
4700 setup_redirect(&ctx, redir_fd, redir_style, input);
4703 redir_fd = redirect_opt_num(&dest);
4704 if (done_word(&dest, &ctx)) {
4707 redir_style = REDIRECT_INPUT;
4709 redir_style = REDIRECT_HEREIS;
4710 ch = i_getch(input);
4712 o_addchr(&ctx.as_string, ch);
4714 } else if (next == '>') {
4715 redir_style = REDIRECT_IO;
4716 ch = i_getch(input);
4718 o_addchr(&ctx.as_string, ch);
4722 else if (next == '(') {
4723 syntax("<(process) not supported");
4727 setup_redirect(&ctx, redir_fd, redir_style, input);
4730 #if ENABLE_HUSH_CASE
4733 if (done_word(&dest, &ctx)) {
4736 done_pipe(&ctx, PIPE_SEQ);
4737 #if ENABLE_HUSH_CASE
4738 /* Eat multiple semicolons, detect
4739 * whether it means something special */
4744 ch = i_getch(input);
4746 o_addchr(&ctx.as_string, ch);
4748 if (ctx.ctx_res_w == RES_CASEI) {
4749 ctx.ctx_dsemicolon = 1;
4750 ctx.ctx_res_w = RES_MATCH;
4756 /* We just finished a cmd. New one may start
4757 * with an assignment */
4758 dest.o_assignment = MAYBE_ASSIGNMENT;
4761 if (done_word(&dest, &ctx)) {
4765 ch = i_getch(input);
4767 o_addchr(&ctx.as_string, ch);
4769 done_pipe(&ctx, PIPE_AND);
4771 done_pipe(&ctx, PIPE_BG);
4775 if (done_word(&dest, &ctx)) {
4778 #if ENABLE_HUSH_CASE
4779 if (ctx.ctx_res_w == RES_MATCH)
4780 break; /* we are in case's "word | word)" */
4782 if (next == '|') { /* || */
4783 ch = i_getch(input);
4785 o_addchr(&ctx.as_string, ch);
4787 done_pipe(&ctx, PIPE_OR);
4789 /* we could pick up a file descriptor choice here
4790 * with redirect_opt_num(), but bash doesn't do it.
4791 * "echo foo 2| cat" yields "foo 2". */
4796 #if ENABLE_HUSH_CASE
4797 /* "case... in [(]word)..." - skip '(' */
4798 if (ctx.ctx_res_w == RES_MATCH
4799 && ctx.command->argv == NULL /* not (word|(... */
4800 && dest.length == 0 /* not word(... */
4801 && dest.nonnull == 0 /* not ""(... */
4806 #if ENABLE_HUSH_FUNCTIONS
4807 if (dest.length != 0 /* not just () but word() */
4808 && dest.nonnull == 0 /* not a"b"c() */
4809 && ctx.command->argv == NULL /* it's the first word */
4810 //TODO: "func ( ) {...}" - note spaces - is valid format too in bash
4811 && i_peek(input) == ')'
4812 && !match_reserved_word(&dest)
4814 bb_error_msg("seems like a function definition");
4816 //if !BB_MMU o_addchr(&ctx.as_string...
4818 //TODO: do it properly.
4819 ch = i_getch(input);
4820 } while (ch == ' ' || ch == '\n');
4822 syntax("was expecting {");
4825 ch = 'F'; /* magic value */
4829 if (parse_group(&dest, &ctx, input, ch) != 0) {
4834 #if ENABLE_HUSH_CASE
4835 if (ctx.ctx_res_w == RES_MATCH)
4839 /* proper use of this character is caught by end_trigger:
4840 * if we see {, we call parse_group(..., end_trigger='}')
4841 * and it will match } earlier (not here). */
4842 syntax("unexpected } or )");
4846 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4852 struct parse_context *pctx;
4853 IF_HAS_KEYWORDS(struct parse_context *p2;)
4855 /* Clean up allocated tree.
4856 * Samples for finding leaks on syntax error recovery path.
4857 * Run them from interactive shell, watch pmap `pidof hush`.
4858 * while if false; then false; fi do break; done
4860 * while if false; then false; fi; do break; fi
4861 * Samples to catch leaks at execution:
4862 * while if (true | {true;}); then echo ok; fi; do break; done
4863 * while if (true | {true;}); then echo ok; fi; do (if echo ok; break; then :; fi) | cat; break; done
4867 /* Update pipe/command counts,
4868 * otherwise freeing may miss some */
4869 done_pipe(pctx, PIPE_SEQ);
4870 debug_printf_clean("freeing list %p from ctx %p\n",
4871 pctx->list_head, pctx);
4872 debug_print_tree(pctx->list_head, 0);
4873 free_pipe_list(pctx->list_head, 0);
4874 debug_printf_clean("freed list %p\n", pctx->list_head);
4876 o_free_unsafe(&pctx->as_string);
4878 IF_HAS_KEYWORDS(p2 = pctx->stack;)
4882 IF_HAS_KEYWORDS(pctx = p2;)
4883 } while (HAS_KEYWORDS && pctx);
4884 /* Free text, clear all dest fields */
4886 /* If we are not in top-level parse, we return,
4887 * our caller will propagate error.
4889 if (end_trigger != ';') {
4896 /* Discard cached input, force prompt */
4898 USE_HUSH_INTERACTIVE(input->promptme = 1;)
4903 /* Executing from string: eval, sh -c '...'
4904 * or from file: /etc/profile, . file, sh <script>, sh (intereactive)
4905 * end_trigger controls how often we stop parsing
4906 * NUL: parse all, execute, return
4907 * ';': parse till ';' or newline, execute, repeat till EOF
4909 static void parse_and_run_stream(struct in_str *inp, int end_trigger)
4912 struct pipe *pipe_list;
4914 pipe_list = parse_stream(NULL, inp, end_trigger);
4915 if (!pipe_list) /* EOF */
4917 debug_print_tree(pipe_list, 0);
4918 debug_printf_exec("parse_and_run_stream: run_and_free_list\n");
4919 run_and_free_list(pipe_list);
4923 static void parse_and_run_string(const char *s)
4925 struct in_str input;
4926 setup_string_in_str(&input, s);
4927 parse_and_run_stream(&input, '\0');
4930 static void parse_and_run_file(FILE *f)
4932 struct in_str input;
4933 setup_file_in_str(&input, f);
4934 parse_and_run_stream(&input, ';');
4938 /* Make sure we have a controlling tty. If we get started under a job
4939 * aware app (like bash for example), make sure we are now in charge so
4940 * we don't fight over who gets the foreground */
4941 static void setup_job_control(void)
4945 shell_pgrp = getpgrp();
4947 /* If we were ran as 'hush &',
4948 * sleep until we are in the foreground. */
4949 while (tcgetpgrp(G_interactive_fd) != shell_pgrp) {
4950 /* Send TTIN to ourself (should stop us) */
4951 kill(- shell_pgrp, SIGTTIN);
4952 shell_pgrp = getpgrp();
4955 /* We _must_ restore tty pgrp on fatal signals */
4956 set_fatal_signals_to_sigexit();
4958 /* Put ourselves in our own process group. */
4959 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
4960 /* Grab control of the terminal. */
4961 tcsetpgrp(G_interactive_fd, getpid());
4965 static int set_mode(const char cstate, const char mode)
4967 int state = (cstate == '-' ? 1 : 0);
4969 case 'n': G.fake_mode = state; break;
4970 case 'x': /*G.debug_mode = state;*/ break;
4971 default: return EXIT_FAILURE;
4973 return EXIT_SUCCESS;
4976 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4977 int hush_main(int argc, char **argv)
4979 static const struct variable const_shell_ver = {
4981 .varstr = (char*)hush_version_str,
4982 .max_len = 1, /* 0 can provoke free(name) */
4990 struct variable *cur_var;
4994 G.root_pid = getpid();
4996 /* Deal with HUSH_VERSION */
4997 G.shell_ver = const_shell_ver; /* copying struct here */
4998 G.top_var = &G.shell_ver;
4999 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
5000 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
5001 /* Initialize our shell local variables with the values
5002 * currently living in the environment */
5003 cur_var = G.top_var;
5006 char *value = strchr(*e, '=');
5007 if (value) { /* paranoia */
5008 cur_var->next = xzalloc(sizeof(*cur_var));
5009 cur_var = cur_var->next;
5010 cur_var->varstr = *e;
5011 cur_var->max_len = strlen(*e);
5012 cur_var->flg_export = 1;
5016 debug_printf_env("putenv '%s'\n", hush_version_str);
5017 putenv((char *)hush_version_str); /* reinstate HUSH_VERSION */
5019 #if ENABLE_FEATURE_EDITING
5020 G.line_input_state = new_line_input_t(FOR_SHELL);
5022 /* XXX what should these be while sourcing /etc/profile? */
5023 G.global_argc = argc;
5024 G.global_argv = argv;
5025 /* Initialize some more globals to non-zero values */
5027 #if ENABLE_HUSH_INTERACTIVE
5028 if (ENABLE_FEATURE_EDITING)
5029 cmdedit_set_initial_prompt();
5033 if (EXIT_SUCCESS) /* otherwise is already done */
5034 G.last_return_code = EXIT_SUCCESS;
5036 if (argv[0] && argv[0][0] == '-') {
5037 debug_printf("sourcing /etc/profile\n");
5038 input = fopen_for_read("/etc/profile");
5039 if (input != NULL) {
5040 close_on_exec_on(fileno(input));
5041 parse_and_run_file(input);
5047 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
5049 opt = getopt(argc, argv, "c:xins"
5058 G.global_argv = argv + optind;
5059 if (!argv[optind]) {
5060 /* -c 'script' (no params): prevent empty $0 */
5061 *--G.global_argv = argv[0];
5063 } /* else -c 'script' PAR0 PAR1: $0 is PAR0 */
5064 G.global_argc = argc - optind;
5065 parse_and_run_string(optarg);
5068 /* Well, we cannot just declare interactiveness,
5069 * we have to have some stuff (ctty, etc) */
5070 /* G_interactive_fd++; */
5073 /* "-s" means "read from stdin", but this is how we always
5074 * operate, so simply do nothing here. */
5078 G.root_pid = xatoi_u(optarg);
5081 G.last_return_code = xatoi_u(optarg);
5083 #if ENABLE_HUSH_LOOPS
5085 G.depth_of_loop = xatoi_u(optarg);
5090 set_local_var(xstrdup(optarg), 0, opt == 'R');
5095 if (!set_mode('-', opt))
5099 fprintf(stderr, "Usage: sh [FILE]...\n"
5100 " or: sh -c command [args]...\n\n");
5108 /* A shell is interactive if the '-i' flag was given, or if all of
5109 * the following conditions are met:
5111 * no arguments remaining or the -s flag given
5112 * standard input is a terminal
5113 * standard output is a terminal
5114 * Refer to Posix.2, the description of the 'sh' utility. */
5115 if (argv[optind] == NULL && input == stdin
5116 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5118 G.saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
5119 debug_printf("saved_tty_pgrp=%d\n", G.saved_tty_pgrp);
5120 if (G.saved_tty_pgrp >= 0) {
5121 /* try to dup to high fd#, >= 255 */
5122 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5123 if (G_interactive_fd < 0) {
5124 /* try to dup to any fd */
5125 G_interactive_fd = dup(STDIN_FILENO);
5126 if (G_interactive_fd < 0)
5128 G_interactive_fd = 0;
5130 // TODO: track & disallow any attempts of user
5131 // to (inadvertently) close/redirect it
5134 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5135 debug_printf("interactive_fd=%d\n", G_interactive_fd);
5136 if (G_interactive_fd) {
5137 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5138 /* Looks like they want an interactive shell */
5139 setup_job_control();
5140 /* -1 is special - makes xfuncs longjmp, not exit
5141 * (we reset die_sleep = 0 whereever we [v]fork) */
5143 if (setjmp(die_jmp)) {
5144 /* xfunc has failed! die die die */
5145 hush_exit(xfunc_error_retval);
5148 #elif ENABLE_HUSH_INTERACTIVE
5149 /* no job control compiled, only prompt/line editing */
5150 if (argv[optind] == NULL && input == stdin
5151 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
5153 G_interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
5154 if (G_interactive_fd < 0) {
5155 /* try to dup to any fd */
5156 G_interactive_fd = dup(STDIN_FILENO);
5157 if (G_interactive_fd < 0)
5159 G_interactive_fd = 0;
5161 if (G_interactive_fd) {
5162 fcntl(G_interactive_fd, F_SETFD, FD_CLOEXEC);
5165 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
5169 /* POSIX allows shell to re-enable SIGCHLD
5170 * even if it was SIG_IGN on entry */
5171 // G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
5172 signal(SIGCHLD, SIG_DFL); // SIGCHLD_handler);
5174 #if ENABLE_HUSH_INTERACTIVE && !ENABLE_FEATURE_SH_EXTRA_QUIET
5175 if (G_interactive_fd) {
5176 printf("\n\n%s hush - the humble shell v"HUSH_VER_STR"\n", bb_banner);
5177 printf("Enter 'help' for a list of built-in commands.\n\n");
5181 if (argv[optind] == NULL) {
5182 parse_and_run_file(stdin);
5184 debug_printf("\nrunning script '%s'\n", argv[optind]);
5185 G.global_argv = argv + optind;
5186 G.global_argc = argc - optind;
5187 input = xfopen_for_read(argv[optind]);
5188 fcntl(fileno(input), F_SETFD, FD_CLOEXEC);
5189 parse_and_run_file(input);
5194 #if ENABLE_FEATURE_CLEAN_UP
5196 if (G.cwd != bb_msg_unknown)
5198 cur_var = G.top_var->next;
5200 struct variable *tmp = cur_var;
5201 if (!cur_var->max_len)
5202 free(cur_var->varstr);
5203 cur_var = cur_var->next;
5207 hush_exit(G.last_return_code);
5212 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
5213 int lash_main(int argc, char **argv)
5215 //bb_error_msg("lash is deprecated, please use hush instead");
5216 return hush_main(argc, argv);
5224 static int builtin_trap(char **argv)
5231 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
5234 /* No args: print all trapped. This isn't 100% correct as we should
5235 * be escaping the cmd so that it can be pasted back in ...
5237 for (i = 0; i < NSIG; ++i)
5239 printf("trap -- '%s' %s\n", G.traps[i], get_signame(i));
5240 return EXIT_SUCCESS;
5245 /* if first arg is decimal: reset all specified */
5246 sig = bb_strtou(*++argv, NULL, 10);
5252 sig = get_signum(*argv++);
5253 if (sig < 0 || sig >= NSIG) {
5255 /* mimic bash message exactly */
5256 bb_perror_msg("trap: %s: invalid signal specification", argv[i]);
5261 G.traps[sig] = xstrdup(new_cmd);
5263 debug_printf("trap: setting SIG%s (%i) to '%s'",
5264 get_signame(sig), sig, G.traps[sig]);
5266 /* There is no signal for 0 (EXIT) */
5271 sigaddset(&G.blocked_set, sig);
5273 /* there was a trap handler, we are removing it
5274 * (if sig has non-DFL handling,
5275 * we don't need to do anything) */
5276 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
5278 sigdelset(&G.blocked_set, sig);
5280 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5285 /* first arg is "-": reset all specified to default */
5286 /* first arg is "": ignore all specified */
5287 /* everything else: execute first arg upon signal */
5289 bb_error_msg("trap: invalid arguments");
5290 return EXIT_FAILURE;
5292 if (LONE_DASH(*argv))
5300 static int builtin_true(char **argv UNUSED_PARAM)
5305 static int builtin_test(char **argv)
5312 return test_main(argc, argv - argc);
5315 static int builtin_echo(char **argv)
5322 return echo_main(argc, argv - argc);
5325 static int builtin_eval(char **argv)
5327 int rcode = EXIT_SUCCESS;
5330 char *str = expand_strvec_to_string(argv + 1);
5332 * eval "echo Hi; done" ("done" is syntax error):
5333 * "echo Hi" will not execute too.
5335 parse_and_run_string(str);
5337 rcode = G.last_return_code;
5342 static int builtin_cd(char **argv)
5345 if (argv[1] == NULL) {
5346 /* bash does nothing (exitcode 0) if HOME is ""; if it's unset,
5347 * bash says "bash: cd: HOME not set" and does nothing (exitcode 1)
5349 newdir = getenv("HOME") ? : "/";
5352 if (chdir(newdir)) {
5353 printf("cd: %s: %s\n", newdir, strerror(errno));
5354 return EXIT_FAILURE;
5357 return EXIT_SUCCESS;
5360 static int builtin_exec(char **argv)
5362 if (argv[1] == NULL)
5363 return EXIT_SUCCESS; /* bash does this */
5368 // FIXME: if exec fails, bash does NOT exit! We do...
5369 pseudo_exec_argv(&dummy, argv + 1, 0, NULL);
5374 static int builtin_exit(char **argv)
5376 // TODO: bash does it ONLY on top-level sh exit (+interacive only?)
5377 //puts("exit"); /* bash does it */
5378 // TODO: warn if we have background jobs: "There are stopped jobs"
5379 // On second consecutive 'exit', exit anyway.
5380 if (argv[1] == NULL)
5381 hush_exit(G.last_return_code);
5382 /* mimic bash: exit 123abc == exit 255 + error msg */
5383 xfunc_error_retval = 255;
5384 /* bash: exit -2 == exit 254, no error msg */
5385 hush_exit(xatoi(argv[1]) & 0xff);
5388 static int builtin_export(char **argv)
5391 char *name = argv[1];
5395 // ash emits: export VAR='VAL'
5396 // bash: declare -x VAR="VAL"
5397 // (both also escape as needed (quotes, $, etc))
5402 return EXIT_SUCCESS;
5405 value = strchr(name, '=');
5407 /* They are exporting something without a =VALUE */
5408 struct variable *var;
5410 var = get_local_var(name);
5412 var->flg_export = 1;
5413 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
5414 putenv(var->varstr);
5416 /* bash does not return an error when trying to export
5417 * an undefined variable. Do likewise. */
5418 return EXIT_SUCCESS;
5421 set_local_var(xstrdup(name), 1, 0);
5422 return EXIT_SUCCESS;
5426 /* built-in 'fg' and 'bg' handler */
5427 static int builtin_fg_bg(char **argv)
5432 if (!G_interactive_fd)
5433 return EXIT_FAILURE;
5434 /* If they gave us no args, assume they want the last backgrounded task */
5436 for (pi = G.job_list; pi; pi = pi->next) {
5437 if (pi->jobid == G.last_jobid) {
5441 bb_error_msg("%s: no current job", argv[0]);
5442 return EXIT_FAILURE;
5444 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
5445 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
5446 return EXIT_FAILURE;
5448 for (pi = G.job_list; pi; pi = pi->next) {
5449 if (pi->jobid == jobnum) {
5453 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
5454 return EXIT_FAILURE;
5456 // TODO: bash prints a string representation
5457 // of job being foregrounded (like "sleep 1 | cat")
5458 if (argv[0][0] == 'f') {
5459 /* Put the job into the foreground. */
5460 tcsetpgrp(G_interactive_fd, pi->pgrp);
5463 /* Restart the processes in the job */
5464 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
5465 for (i = 0; i < pi->num_cmds; i++) {
5466 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
5467 pi->cmds[i].is_stopped = 0;
5469 pi->stopped_cmds = 0;
5471 i = kill(- pi->pgrp, SIGCONT);
5473 if (errno == ESRCH) {
5474 delete_finished_bg_job(pi);
5475 return EXIT_SUCCESS;
5477 bb_perror_msg("kill (SIGCONT)");
5480 if (argv[0][0] == 'f') {
5482 return checkjobs_and_fg_shell(pi);
5484 return EXIT_SUCCESS;
5488 #if ENABLE_HUSH_HELP
5489 static int builtin_help(char **argv UNUSED_PARAM)
5491 const struct built_in_command *x;
5494 "Built-in commands:\n"
5495 "------------------\n");
5496 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
5497 printf("%s\t%s\n", x->cmd, x->descr);
5500 return EXIT_SUCCESS;
5505 static int builtin_jobs(char **argv UNUSED_PARAM)
5508 const char *status_string;
5510 for (job = G.job_list; job; job = job->next) {
5511 if (job->alive_cmds == job->stopped_cmds)
5512 status_string = "Stopped";
5514 status_string = "Running";
5516 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
5518 return EXIT_SUCCESS;
5522 static int builtin_pwd(char **argv UNUSED_PARAM)
5525 return EXIT_SUCCESS;
5528 static int builtin_read(char **argv)
5531 const char *name = argv[1] ? argv[1] : "REPLY";
5533 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
5534 return set_local_var(string, 0, 0);
5537 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
5538 * built-in 'set' handler
5540 * set [-abCefhmnuvx] [-o option] [argument...]
5541 * set [+abCefhmnuvx] [+o option] [argument...]
5542 * set -- [argument...]
5545 * Implementations shall support the options in both their hyphen and
5546 * plus-sign forms. These options can also be specified as options to sh.
5548 * Write out all variables and their values: set
5549 * Set $1, $2, and $3 and set "$#" to 3: set c a b
5550 * Turn on the -x and -v options: set -xv
5551 * Unset all positional parameters: set --
5552 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
5553 * Set the positional parameters to the expansion of x, even if x expands
5554 * with a leading '-' or '+': set -- $x
5556 * So far, we only support "set -- [argument...]" and some of the short names.
5558 static int builtin_set(char **argv)
5561 char **pp, **g_argv;
5562 char *arg = *++argv;
5566 for (e = G.top_var; e; e = e->next)
5568 return EXIT_SUCCESS;
5572 if (!strcmp(arg, "--")) {
5577 if (arg[0] == '+' || arg[0] == '-') {
5578 for (n = 1; arg[n]; ++n)
5579 if (set_mode(arg[0], arg[n]))
5585 } while ((arg = *++argv) != NULL);
5586 /* Now argv[0] is 1st argument */
5588 /* Only reset global_argv if we didn't process anything */
5590 return EXIT_SUCCESS;
5593 /* NB: G.global_argv[0] ($0) is never freed/changed */
5594 g_argv = G.global_argv;
5595 if (G.global_args_malloced) {
5601 G.global_args_malloced = 1;
5602 pp = xzalloc(sizeof(pp[0]) * 2);
5603 pp[0] = g_argv[0]; /* retain $0 */
5606 /* This realloc's G.global_argv */
5607 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
5614 return EXIT_SUCCESS;
5616 /* Nothing known, so abort */
5618 bb_error_msg("set: %s: invalid option", arg);
5619 return EXIT_FAILURE;
5622 static int builtin_shift(char **argv)
5628 if (n >= 0 && n < G.global_argc) {
5629 if (G.global_args_malloced) {
5632 free(G.global_argv[m++]);
5635 memmove(&G.global_argv[1], &G.global_argv[n+1],
5636 G.global_argc * sizeof(G.global_argv[0]));
5637 return EXIT_SUCCESS;
5639 return EXIT_FAILURE;
5642 static int builtin_source(char **argv)
5646 if (argv[1] == NULL)
5647 return EXIT_FAILURE;
5649 /* XXX search through $PATH is missing */
5650 input = fopen_for_read(argv[1]);
5652 bb_error_msg("can't open '%s'", argv[1]);
5653 return EXIT_FAILURE;
5655 close_on_exec_on(fileno(input));
5657 /* Now run the file */
5658 /* XXX argv and argc are broken; need to save old G.global_argv
5659 * (pointer only is OK!) on this stack frame,
5660 * set G.global_argv=argv+1, recurse, and restore. */
5661 parse_and_run_file(input);
5663 return G.last_return_code;
5666 static int builtin_umask(char **argv)
5669 const char *arg = argv[1];
5671 new_umask = bb_strtou(arg, NULL, 8);
5673 return EXIT_FAILURE;
5675 new_umask = umask(0);
5676 printf("%.3o\n", (unsigned) new_umask);
5679 return EXIT_SUCCESS;
5682 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
5683 static int builtin_unset(char **argv)
5690 return EXIT_SUCCESS;
5693 if (argv[1][0] == '-') {
5694 switch (argv[1][1]) {
5696 case 'f': if (ENABLE_HUSH_FUNCTIONS) { var = false; break; }
5698 bb_error_msg("unset: %s: invalid option", argv[1]);
5699 return EXIT_FAILURE;
5707 if (unset_local_var(argv[i]))
5710 #if ENABLE_HUSH_FUNCTIONS
5712 unset_local_func(argv[i]);
5718 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
5719 static int builtin_wait(char **argv)
5721 int ret = EXIT_SUCCESS;
5724 if (*++argv == NULL) {
5725 /* Don't care about wait results */
5726 /* Note 1: must wait until there are no more children */
5727 /* Note 2: must be interruptible */
5729 * $ sleep 3 & sleep 6 & wait
5734 * $ sleep 3 & sleep 6 & wait
5738 * ^C <-- after ~4 sec from keyboard
5741 sigaddset(&G.blocked_set, SIGCHLD);
5742 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5745 if (errno == ECHILD)
5747 /* Wait for SIGCHLD or any other signal of interest */
5748 /* sigtimedwait with infinite timeout: */
5749 sig = sigwaitinfo(&G.blocked_set, NULL);
5751 sig = check_and_run_traps(sig);
5752 if (sig && sig != SIGCHLD) { /* see note 2 */
5758 sigdelset(&G.blocked_set, SIGCHLD);
5759 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5763 /* This is probably buggy wrt interruptible-ness */
5765 pid_t pid = bb_strtou(*argv, NULL, 10);
5767 /* mimic bash message */
5768 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
5769 return EXIT_FAILURE;
5771 if (waitpid(pid, &status, 0) == pid) {
5772 if (WIFSIGNALED(status))
5773 ret = 128 + WTERMSIG(status);
5774 else if (WIFEXITED(status))
5775 ret = WEXITSTATUS(status);
5779 bb_perror_msg("wait %s", *argv);
5788 #if ENABLE_HUSH_LOOPS
5789 static int builtin_break(char **argv)
5791 if (G.depth_of_loop == 0) {
5792 bb_error_msg("%s: only meaningful in a loop", argv[0]);
5793 return EXIT_SUCCESS; /* bash compat */
5795 G.flag_break_continue++; /* BC_BREAK = 1 */
5796 G.depth_break_continue = 1;
5798 G.depth_break_continue = bb_strtou(argv[1], NULL, 10);
5799 if (errno || !G.depth_break_continue || argv[2]) {
5800 bb_error_msg("%s: bad arguments", argv[0]);
5801 G.flag_break_continue = BC_BREAK;
5802 G.depth_break_continue = UINT_MAX;
5805 if (G.depth_of_loop < G.depth_break_continue)
5806 G.depth_break_continue = G.depth_of_loop;
5807 return EXIT_SUCCESS;
5810 static int builtin_continue(char **argv)
5812 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
5813 return builtin_break(argv);