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 * Arithmetic Expansion
42 * <(list) and >(list) Process Substitution
43 * Here Documents ( << word )
46 * Parameter Expansion for substring processing ${var#word} ${var%word}
48 * Bash stuff maybe optional enable:
49 * &> and >& redirection of stdout+stderr
51 * reserved words: [[ ]] function select
52 * substrings ${var:1:5}
55 * job handling woefully incomplete and buggy (improved --vda)
57 * port selected bugfixes from post-0.49 busybox lash - done?
58 * change { and } from special chars to reserved words
59 * builtins: return, trap, ulimit
60 * test magic exec with redirection only
61 * follow IFS rules more precisely, including update semantics
62 * figure out what to do with backslash-newline
63 * propagate syntax errors, die on resource errors?
64 * continuation lines, both explicit and implicit - done?
65 * maybe change charmap[] to use 2-bit entries
67 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
70 #include "busybox.h" /* for APPLET_IS_NOFORK/NOEXEC */
71 //TODO: pull in some .h and find out whether we have SINGLE_APPLET_MAIN?
72 //#include "applet_tables.h" doesn't work
74 /* #include <dmalloc.h> */
81 #define HUSH_VER_STR "0.92"
83 #if defined SINGLE_APPLET_MAIN
84 /* STANDALONE does not make sense, and won't compile */
85 #undef CONFIG_FEATURE_SH_STANDALONE
86 #undef ENABLE_FEATURE_SH_STANDALONE
87 #undef USE_FEATURE_SH_STANDALONE
88 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
89 #define ENABLE_FEATURE_SH_STANDALONE 0
90 #define USE_FEATURE_SH_STANDALONE(...)
91 #define SKIP_FEATURE_SH_STANDALONE(...) __VA_ARGS__
94 #if !BB_MMU && ENABLE_HUSH_TICK
95 //#undef ENABLE_HUSH_TICK
96 //#define ENABLE_HUSH_TICK 0
97 #warning On NOMMU, hush command substitution is dangerous.
98 #warning Dont use it for commands which produce lots of output.
99 #warning For more info see shell/hush.c, generate_stream_from_list().
102 #if !ENABLE_HUSH_INTERACTIVE
103 #undef ENABLE_FEATURE_EDITING
104 #define ENABLE_FEATURE_EDITING 0
105 #undef ENABLE_FEATURE_EDITING_FANCY_PROMPT
106 #define ENABLE_FEATURE_EDITING_FANCY_PROMPT 0
109 /* Do we support ANY keywords? */
110 #if ENABLE_HUSH_IF || ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
111 #define HAS_KEYWORDS 1
112 #define IF_HAS_KEYWORDS(...) __VA_ARGS__
113 #define IF_HAS_NO_KEYWORDS(...)
115 #define HAS_KEYWORDS 0
116 #define IF_HAS_KEYWORDS(...)
117 #define IF_HAS_NO_KEYWORDS(...) __VA_ARGS__
120 /* Keep unconditionally on for now */
123 #define ENABLE_HUSH_FUNCTIONS 0
126 /* If you comment out one of these below, it will be #defined later
127 * to perform debug printfs to stderr: */
128 #define debug_printf(...) do {} while (0)
129 /* Finer-grained debug switches */
130 #define debug_printf_parse(...) do {} while (0)
131 #define debug_print_tree(a, b) do {} while (0)
132 #define debug_printf_exec(...) do {} while (0)
133 #define debug_printf_env(...) do {} while (0)
134 #define debug_printf_jobs(...) do {} while (0)
135 #define debug_printf_expand(...) do {} while (0)
136 #define debug_printf_glob(...) do {} while (0)
137 #define debug_printf_list(...) do {} while (0)
138 #define debug_printf_subst(...) do {} while (0)
139 #define debug_printf_clean(...) do {} while (0)
142 #define debug_printf(...) fprintf(stderr, __VA_ARGS__)
145 #ifndef debug_printf_parse
146 #define debug_printf_parse(...) fprintf(stderr, __VA_ARGS__)
149 #ifndef debug_printf_exec
150 #define debug_printf_exec(...) fprintf(stderr, __VA_ARGS__)
153 #ifndef debug_printf_env
154 #define debug_printf_env(...) fprintf(stderr, __VA_ARGS__)
157 #ifndef debug_printf_jobs
158 #define debug_printf_jobs(...) fprintf(stderr, __VA_ARGS__)
164 #ifndef debug_printf_expand
165 #define debug_printf_expand(...) fprintf(stderr, __VA_ARGS__)
166 #define DEBUG_EXPAND 1
168 #define DEBUG_EXPAND 0
171 #ifndef debug_printf_glob
172 #define debug_printf_glob(...) fprintf(stderr, __VA_ARGS__)
178 #ifndef debug_printf_list
179 #define debug_printf_list(...) fprintf(stderr, __VA_ARGS__)
182 #ifndef debug_printf_subst
183 #define debug_printf_subst(...) fprintf(stderr, __VA_ARGS__)
186 #ifndef debug_printf_clean
187 /* broken, of course, but OK for testing */
188 static const char *indenter(int i)
190 static const char blanks[] ALIGN1 =
192 return &blanks[sizeof(blanks) - i - 1];
194 #define debug_printf_clean(...) fprintf(stderr, __VA_ARGS__)
195 #define DEBUG_CLEAN 1
199 static void debug_print_strings(const char *prefix, char **vv)
201 fprintf(stderr, "%s:\n", prefix);
203 fprintf(stderr, " '%s'\n", *vv++);
206 #define debug_print_strings(prefix, vv) ((void)0)
210 * Leak hunting. Use hush_leaktool.sh for post-processing.
212 #ifdef FOR_HUSH_LEAKTOOL
213 /* suppress "warning: no previous prototype..." */
214 void *xxmalloc(int lineno, size_t size);
215 void *xxrealloc(int lineno, void *ptr, size_t size);
216 char *xxstrdup(int lineno, const char *str);
217 void xxfree(void *ptr);
218 void *xxmalloc(int lineno, size_t size)
220 void *ptr = xmalloc((size + 0xff) & ~0xff);
221 fprintf(stderr, "line %d: malloc %p\n", lineno, ptr);
224 void *xxrealloc(int lineno, void *ptr, size_t size)
226 ptr = xrealloc(ptr, (size + 0xff) & ~0xff);
227 fprintf(stderr, "line %d: realloc %p\n", lineno, ptr);
230 char *xxstrdup(int lineno, const char *str)
232 char *ptr = xstrdup(str);
233 fprintf(stderr, "line %d: strdup %p\n", lineno, ptr);
236 void xxfree(void *ptr)
238 fprintf(stderr, "free %p\n", ptr);
241 #define xmalloc(s) xxmalloc(__LINE__, s)
242 #define xrealloc(p, s) xxrealloc(__LINE__, p, s)
243 #define xstrdup(s) xxstrdup(__LINE__, s)
244 #define free(p) xxfree(p)
248 static const char hush_version_str[] ALIGN1 = "HUSH_VERSION="HUSH_VER_STR;
250 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
252 #define SPECIAL_VAR_SYMBOL 3
253 #define PARSEFLAG_EXIT_FROM_LOOP 1
255 typedef enum redir_type {
257 REDIRECT_OVERWRITE = 2,
263 /* The descrip member of this structure is only used to make
264 * debugging output pretty */
265 static const struct {
267 signed char default_fd;
271 { O_RDONLY, 0, "<" },
272 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
273 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
274 { O_RDONLY, -1, "<<" },
278 typedef enum pipe_style {
285 typedef enum reserved_style {
294 #if ENABLE_HUSH_LOOPS
301 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
306 /* two pseudo-keywords support contrived "case" syntax: */
307 RES_MATCH , /* "word)" */
308 RES_CASEI , /* "this command is inside CASE" */
315 struct redir_struct {
316 struct redir_struct *next;
317 char *rd_filename; /* filename */
318 int fd; /* file descriptor being redirected */
319 int dup; /* -1, or file descriptor being duplicated */
320 smallint /*enum redir_type*/ rd_type;
324 pid_t pid; /* 0 if exited */
325 int assignment_cnt; /* how many argv[i] are assignments? */
326 smallint is_stopped; /* is the command currently running? */
327 smallint grp_type; /* GRP_xxx */
328 struct pipe *group; /* if non-NULL, this "prog" is {} group,
329 * subshell, or a compound statement */
330 char **argv; /* command name and arguments */
331 struct redir_struct *redirects; /* I/O redirections */
333 /* argv vector may contain variable references (^Cvar^C, ^C0^C etc)
334 * and on execution these are substituted with their values.
335 * Substitution can make _several_ words out of one argv[n]!
336 * Example: argv[0]=='.^C*^C.' here: echo .$*.
337 * References of the form ^C`cmd arg^C are `cmd arg` substitutions.
340 #define GRP_SUBSHELL 1
341 #if ENABLE_HUSH_FUNCTIONS
342 #define GRP_FUNCTION 2
347 int num_cmds; /* total number of commands in job */
348 int alive_cmds; /* number of commands running (not exited) */
349 int stopped_cmds; /* number of commands alive, but stopped */
351 int jobid; /* job number */
352 pid_t pgrp; /* process group ID for the job */
353 char *cmdtext; /* name of job */
355 struct command *cmds; /* array of commands in pipe */
356 smallint followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
357 IF_HAS_KEYWORDS(smallint pi_inverted;) /* "! cmd | cmd" */
358 IF_HAS_KEYWORDS(smallint res_word;) /* needed for if, for, while, until... */
361 /* This holds pointers to the various results of parsing */
362 struct parse_context {
363 struct command *command;
364 struct pipe *list_head;
366 struct redir_struct *pending_redirect;
369 smallint ctx_inverted; /* "! cmd | cmd" */
371 smallint ctx_dsemicolon; /* ";;" seen */
373 int old_flag; /* bitmask of FLAG_xxx, for figuring out valid reserved words */
374 struct parse_context *stack;
378 /* On program start, environ points to initial environment.
379 * putenv adds new pointers into it, unsetenv removes them.
380 * Neither of these (de)allocates the strings.
381 * setenv allocates new strings in malloc space and does putenv,
382 * and thus setenv is unusable (leaky) for shell's purposes */
383 #define setenv(...) setenv_is_leaky_dont_use()
385 struct variable *next;
386 char *varstr; /* points to "name=" portion */
387 int max_len; /* if > 0, name is part of initial env; else name is malloced */
388 smallint flg_export; /* putenv should be done on this var */
389 smallint flg_read_only;
392 typedef struct o_string {
394 int length; /* position where data is appended */
396 /* Misnomer! it's not "quoting", it's "protection against globbing"!
397 * (by prepending \ to *, ?, [ and to \ too) */
401 smallint has_empty_slot;
402 smallint o_assignment; /* 0:maybe, 1:yes, 2:no */
405 MAYBE_ASSIGNMENT = 0,
406 DEFINITELY_ASSIGNMENT = 1,
408 WORD_IS_KEYWORD = 3, /* not assigment, but next word may be: "if v=xyz cmd;" */
410 /* Used for initialization: o_string foo = NULL_O_STRING; */
411 #define NULL_O_STRING { NULL }
413 /* I can almost use ordinary FILE*. Is open_memstream() universally
414 * available? Where is it documented? */
415 typedef struct in_str {
417 /* eof_flag=1: last char in ->p is really an EOF */
418 char eof_flag; /* meaningless if ->p == NULL */
420 #if ENABLE_HUSH_INTERACTIVE
422 smallint promptmode; /* 0: PS1, 1: PS2 */
425 int (*get) (struct in_str *);
426 int (*peek) (struct in_str *);
428 #define i_getch(input) ((input)->get(input))
429 #define i_peek(input) ((input)->peek(input))
433 CHAR_ORDINARY_IF_QUOTED = 1, /* example: *, # */
434 CHAR_IFS = 2, /* treated as ordinary if quoted */
435 CHAR_SPECIAL = 3, /* example: $ */
444 /* "Globals" within this file */
445 /* Sorted roughly by size (smaller offsets == smaller code) */
447 #if ENABLE_HUSH_INTERACTIVE
448 /* 'interactive_fd' is a fd# open to ctty, if we have one
449 * _AND_ if we decided to act interactively */
454 #if ENABLE_FEATURE_EDITING
455 line_input_t *line_input_state;
457 #if ENABLE_SH_MATH_SUPPORT
458 arith_eval_hooks_t hooks;
464 pid_t saved_tty_pgrp;
466 struct pipe *job_list;
467 struct pipe *toplevel_list;
468 //// smallint ctrl_z_flag;
470 smallint flag_SIGINT;
471 #if ENABLE_HUSH_LOOPS
472 smallint flag_break_continue;
475 /* These four support $?, $#, and $1 */
476 smalluint last_return_code;
477 /* is global_argv and global_argv[1..n] malloced? (note: not [0]) */
478 smalluint global_args_malloced;
479 /* how many non-NULL argv's we have. NB: $# + 1 */
482 #if ENABLE_HUSH_LOOPS
483 unsigned depth_break_continue;
484 unsigned depth_of_loop;
488 struct variable *top_var; /* = &G.shell_ver (set in main()) */
489 struct variable shell_ver;
490 #if ENABLE_FEATURE_SH_STANDALONE
491 struct nofork_save_area nofork_save;
494 sigjmp_buf toplevel_jb;
496 unsigned char charmap[256];
497 char user_input_buf[ENABLE_FEATURE_EDITING ? BUFSIZ : 2];
498 /* Signal and trap handling */
499 // unsigned count_SIGCHLD;
500 // unsigned handled_SIGCHLD;
501 /* which signals have non-DFL handler (even with no traps set)? */
502 unsigned non_DFL_mask;
503 char **traps; /* char *traps[NSIG] */
504 sigset_t blocked_set;
505 sigset_t inherited_set;
507 #define G (*ptr_to_globals)
508 /* Not #defining name to G.name - this quickly gets unwieldy
509 * (too many defines). Also, I actually prefer to see when a variable
510 * is global, thus "G." prefix is a useful hint */
511 #define INIT_G() do { \
512 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
516 /* Function prototypes for builtins */
517 static int builtin_cd(char **argv);
518 static int builtin_echo(char **argv);
519 static int builtin_eval(char **argv);
520 static int builtin_exec(char **argv);
521 static int builtin_exit(char **argv);
522 static int builtin_export(char **argv);
524 static int builtin_fg_bg(char **argv);
525 static int builtin_jobs(char **argv);
528 static int builtin_help(char **argv);
530 static int builtin_pwd(char **argv);
531 static int builtin_read(char **argv);
532 static int builtin_test(char **argv);
533 static int builtin_trap(char **argv);
534 static int builtin_true(char **argv);
535 static int builtin_set(char **argv);
536 static int builtin_shift(char **argv);
537 static int builtin_source(char **argv);
538 static int builtin_umask(char **argv);
539 static int builtin_unset(char **argv);
540 static int builtin_wait(char **argv);
541 #if ENABLE_HUSH_LOOPS
542 static int builtin_break(char **argv);
543 static int builtin_continue(char **argv);
545 //static int builtin_not_written(char **argv);
547 /* Table of built-in functions. They can be forked or not, depending on
548 * context: within pipes, they fork. As simple commands, they do not.
549 * When used in non-forking context, they can change global variables
550 * in the parent shell process. If forked, of course they cannot.
551 * For example, 'unset foo | whatever' will parse and run, but foo will
552 * still be set at the end. */
553 struct built_in_command {
555 int (*function)(char **argv);
558 #define BLTIN(cmd, func, help) { cmd, func, help }
560 #define BLTIN(cmd, func, help) { cmd, func }
564 /* For now, echo and test are unconditionally enabled.
565 * Maybe make it configurable? */
566 static const struct built_in_command bltins[] = {
567 BLTIN("." , builtin_source, "Run commands in a file"),
568 BLTIN(":" , builtin_true, "No-op"),
569 BLTIN("[" , builtin_test, "Test condition"),
571 BLTIN("bg" , builtin_fg_bg, "Resume a job in the background"),
573 #if ENABLE_HUSH_LOOPS
574 BLTIN("break" , builtin_break, "Exit from a loop"),
576 BLTIN("cd" , builtin_cd, "Change directory"),
577 #if ENABLE_HUSH_LOOPS
578 BLTIN("continue", builtin_continue, "Start new loop iteration"),
580 BLTIN("echo" , builtin_echo, "Write to stdout"),
581 BLTIN("eval" , builtin_eval, "Construct and run shell command"),
582 BLTIN("exec" , builtin_exec, "Execute command, don't return to shell"),
583 BLTIN("exit" , builtin_exit, "Exit"),
584 BLTIN("export", builtin_export, "Set environment variable"),
586 BLTIN("fg" , builtin_fg_bg, "Bring job into the foreground"),
587 BLTIN("jobs" , builtin_jobs, "List active jobs"),
589 BLTIN("pwd" , builtin_pwd, "Print current directory"),
590 BLTIN("read" , builtin_read, "Input environment variable"),
591 // BLTIN("return", builtin_not_written, "Return from a function"),
592 BLTIN("set" , builtin_set, "Set/unset shell local variables"),
593 BLTIN("shift" , builtin_shift, "Shift positional parameters"),
594 BLTIN("test" , builtin_test, "Test condition"),
595 BLTIN("trap" , builtin_trap, "Trap signals"),
596 // BLTIN("ulimit", builtin_not_written, "Control resource limits"),
597 BLTIN("umask" , builtin_umask, "Set file creation mask"),
598 BLTIN("unset" , builtin_unset, "Unset environment variable"),
599 BLTIN("wait" , builtin_wait, "Wait for process"),
601 BLTIN("help" , builtin_help, "List shell built-in commands"),
607 static void maybe_die(const char *notice, const char *msg)
609 /* Was using fancy stuff:
610 * (G.interactive_fd ? bb_error_msg : bb_error_msg_and_die)(...params...)
611 * but it SEGVs. ?! Oh well... explicit temp ptr works around that */
612 void FAST_FUNC (*fp)(const char *s, ...) = bb_error_msg_and_die;
613 #if ENABLE_HUSH_INTERACTIVE
614 fp = (G.interactive_fd ? bb_error_msg : bb_error_msg_and_die);
616 fp(msg ? "%s: %s" : notice, notice, msg);
619 #define syntax(msg) maybe_die("syntax error", msg);
621 /* Debug -- trick gcc to expand __LINE__ and convert to string */
622 #define __syntax(msg, line) maybe_die("syntax error hush.c:" # line, msg)
623 #define _syntax(msg, line) __syntax(msg, line)
624 #define syntax(msg) _syntax(msg, __LINE__)
627 static int glob_needed(const char *s)
632 if (*s == '*' || *s == '[' || *s == '?')
639 static int is_assignment(const char *s)
641 if (!s || !(isalpha(*s) || *s == '_'))
644 while (isalnum(*s) || *s == '_')
649 /* Replace each \x with x in place, return ptr past NUL. */
650 static char *unbackslash(char *src)
656 if ((*dst++ = *src++) == '\0')
662 static char **add_strings_to_strings(char **strings, char **add, int need_to_dup)
683 v = xrealloc(strings, (count1 + count2 + 1) * sizeof(char*));
684 v[count1 + count2] = NULL;
687 v[count1 + i] = (need_to_dup ? xstrdup(add[i]) : add[i]);
691 static char **add_string_to_strings(char **strings, char *add)
696 return add_strings_to_strings(strings, v, /*dup:*/ 0);
699 static void putenv_all(char **strings)
704 debug_printf_env("putenv '%s'\n", *strings);
709 static char **putenv_all_and_save_old(char **strings)
719 eq = strchr(*strings, '=');
722 v = getenv(*strings);
725 /* v points to VAL in VAR=VAL, go back to VAR */
726 v -= (eq - *strings) + 1;
727 old = add_string_to_strings(old, v);
736 static void free_strings_and_unsetenv(char **strings, int unset)
746 debug_printf_env("unsetenv '%s'\n", *v);
754 static void free_strings(char **strings)
756 free_strings_and_unsetenv(strings, 0);
760 /* Basic theory of signal handling in shell
761 * ========================================
762 * This does not describe what hush does, rather, it is current understanding
763 * what it _should_ do. If it doesn't, it's a bug.
764 * http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#trap
766 * Signals are handled only after each pipe ("cmd | cmd | cmd" thing)
767 * is finished or backgrounded. It is the same in interactive and
768 * non-interactive shells, and is the same regardless of whether
769 * a user trap handler is installed or a shell special one is in effect.
770 * ^C or ^Z from keyboard seem to execute "at once" because it usually
771 * backgrounds (i.e. stops) or kills all members of currently running
774 * Wait builtin in interruptible by signals for which user trap is set
775 * or by SIGINT in interactive shell.
777 * Trap handlers will execute even within trap handlers. (right?)
779 * User trap handlers are forgotten when subshell ("(cmd)") is entered. [TODO]
781 * If job control is off, backgrounded commands ("cmd &")
782 * have SIGINT, SIGQUIT set to SIG_IGN.
784 * Commands run in command substitution ("`cmd`")
785 * have SIGTTIN, SIGTTOU, SIGTSTP set to SIG_IGN.
787 * Ordinary commands have signals set to SIG_IGN/DFL set as inherited
788 * by the shell from its parent.
790 * Siganls which differ from SIG_DFL action
791 * (note: child (i.e., [v]forked) shell is not an interactive shell):
794 * SIGTERM (interactive): ignore
795 * SIGHUP (interactive):
796 * send SIGCONT to stopped jobs, send SIGHUP to all jobs and exit
797 * SIGTTIN, SIGTTOU, SIGTSTP (if job control is on): ignore
798 * (note that ^Z is handled not by trapping SIGTSTP, but by seeing
799 * that all pipe members are stopped) (right?)
800 * SIGINT (interactive): wait for last pipe, ignore the rest
801 * of the command line, show prompt. NB: ^C does not send SIGINT
802 * to interactive shell while shell is waiting for a pipe,
803 * since shell is bg'ed (is not in foreground process group).
804 * (check/expand this)
805 * Example 1: this waits 5 sec, but does not execute ls:
806 * "echo $$; sleep 5; ls -l" + "kill -INT <pid>"
807 * Example 2: this does not wait and does not execute ls:
808 * "echo $$; sleep 5 & wait; ls -l" + "kill -INT <pid>"
809 * Example 3: this does not wait 5 sec, but executes ls:
810 * "sleep 5; ls -l" + press ^C
812 * (What happens to signals which are IGN on shell start?)
813 * (What happens with signal mask on shell start?)
815 * Implementation in hush
816 * ======================
817 * We use in-kernel pending signal mask to determine which signals were sent.
818 * We block all signals which we don't want to take action immediately,
819 * i.e. we block all signals which need to have special handling as described
820 * above, and all signals which have traps set.
821 * After each pipe execution, we extract any pending signals via sigtimedwait()
824 * unsigned non_DFL_mask: a mask of such "special" signals
825 * sigset_t blocked_set: current blocked signal set
828 * clear bit in blocked_set unless it is also in non_DFL
829 * "trap 'cmd' SIGxxx":
830 * set bit in blocked_set (even if 'cmd' is '')
831 * after [v]fork, if we plan to be a shell:
832 * nothing for {} child shell (say, "true | { true; true; } | true")
833 * unset all traps if () shell. [TODO]
834 * after [v]fork, if we plan to exec:
835 * POSIX says pending signal mask is cleared in child - no need to clear it.
836 * Restore blocked signal set to one inherited by shell just prior to exec.
838 * Note: as a result, we do not use signal handlers much. The only uses
839 * are to count SIGCHLDs [disabled - bug somewhere, + bloat]
840 * and to restore tty pgrp on signal-induced exit.
842 * TODO: check/fix wait builtin to be interruptible.
845 //static void SIGCHLD_handler(int sig UNUSED_PARAM)
847 // G.count_SIGCHLD++;
850 /* called once at shell init */
851 static void init_signal_mask(void)
854 unsigned mask = (1 << SIGQUIT);
855 #if ENABLE_HUSH_INTERACTIVE
856 if (G.interactive_fd) {
862 | (1 << SIGTTIN) | (1 << SIGTTOU) | (1 << SIGTSTP)
868 G.non_DFL_mask = mask;
870 sigprocmask(SIG_SETMASK, NULL, &G.blocked_set);
874 sigaddset(&G.blocked_set, sig);
878 sigdelset(&G.blocked_set, SIGCHLD);
879 sigprocmask(SIG_SETMASK, &G.blocked_set, &G.inherited_set);
882 static int check_and_run_traps(int sig)
884 static const struct timespec zero_timespec = { 0, 0 };
885 smalluint save_rcode;
891 sig = sigtimedwait(&G.blocked_set, NULL, &zero_timespec);
896 if (G.traps && G.traps[sig]) {
897 if (G.traps[sig][0]) {
898 /* We have user-defined handler */
899 char *argv[] = { NULL, xstrdup(G.traps[sig]), NULL };
900 save_rcode = G.last_return_code;
903 G.last_return_code = save_rcode;
904 } /* else: "" trap, ignoring signal */
907 /* not a trap: special action */
910 // G.count_SIGCHLD++;
919 default: /* SIGTERM, SIGQUIT, SIGTTIN, SIGTTOU, SIGTSTP */
928 /* Restores tty foreground process group, and exits.
929 * May be called as signal handler for fatal signal
930 * (will faithfully resend signal to itself, producing correct exit state)
931 * or called directly with -EXITCODE.
932 * We also call it if xfunc is exiting. */
933 static void sigexit(int sig) NORETURN;
934 static void sigexit(int sig)
936 /* Disable all signals: job control, SIGPIPE, etc. */
937 sigprocmask_allsigs(SIG_BLOCK);
939 #if ENABLE_HUSH_INTERACTIVE
940 /* Careful: we can end up here after [v]fork. Do not restore
941 * tty pgrp then, only top-level shell process does that */
942 if (G.interactive_fd && getpid() == G.root_pid)
943 tcsetpgrp(G.interactive_fd, G.saved_tty_pgrp);
946 /* Not a signal, just exit */
950 kill_myself_with_sig(sig); /* does not return */
954 static void maybe_set_sighandler(int sig)
956 void (*handler)(int);
957 /* non_DFL_mask'ed signals are, well, masked,
958 * no need to set handler for them.
960 if (!((G.non_DFL_mask >> sig) & 1)) {
961 handler = signal(sig, sigexit);
962 if (handler == SIG_IGN) /* oops... restore back to IGN! */
963 signal(sig, handler);
966 /* Used only to set handler to restore pgrp on exit */
967 static void set_fatal_signals_to_sigexit(void)
970 maybe_set_sighandler(SIGILL );
971 maybe_set_sighandler(SIGFPE );
972 maybe_set_sighandler(SIGBUS );
973 maybe_set_sighandler(SIGSEGV);
974 maybe_set_sighandler(SIGTRAP);
975 } /* else: hush is perfect. what SEGV? */
977 maybe_set_sighandler(SIGABRT);
979 /* bash 3.2 seems to handle these just like 'fatal' ones */
980 maybe_set_sighandler(SIGPIPE);
981 maybe_set_sighandler(SIGALRM);
982 maybe_set_sighandler(SIGHUP );
984 /* if we aren't interactive... but in this case
985 * we never want to restore pgrp on exit, and this fn is not called */
986 /*maybe_set_sighandler(SIGTERM);*/
987 /*maybe_set_sighandler(SIGINT );*/
989 /* Used only to suppress ^Z in `cmd` */
990 static void set_jobctrl_signals_to_IGN(void)
1001 #define set_fatal_signals_to_sigexit(handler) ((void)0)
1002 #define set_jobctrl_signals_to_IGN(handler) ((void)0)
1006 /* Restores tty foreground process group, and exits. */
1007 static void hush_exit(int exitcode) NORETURN;
1008 static void hush_exit(int exitcode)
1010 if (G.traps && G.traps[0] && G.traps[0][0]) {
1011 char *argv[] = { NULL, xstrdup(G.traps[0]), NULL };
1017 fflush(NULL); /* flush all streams */
1018 sigexit(- (exitcode & 0xff));
1025 static const char *set_cwd(void)
1027 /* xrealloc_getcwd_or_warn(arg) calls free(arg),
1028 * we must not try to free(bb_msg_unknown) */
1029 if (G.cwd == bb_msg_unknown)
1031 G.cwd = xrealloc_getcwd_or_warn((char *)G.cwd);
1033 G.cwd = bb_msg_unknown;
1038 /* Get/check local shell variables */
1039 static struct variable *get_local_var(const char *name)
1041 struct variable *cur;
1047 for (cur = G.top_var; cur; cur = cur->next) {
1048 if (strncmp(cur->varstr, name, len) == 0 && cur->varstr[len] == '=')
1054 /* Basically useful version until someone wants to get fancier,
1055 * see the bash man page under "Parameter Expansion" */
1056 static const char *lookup_param(const char *src)
1058 struct variable *var = get_local_var(src);
1060 return strchr(var->varstr, '=') + 1;
1064 /* str holds "NAME=VAL" and is expected to be malloced.
1065 * We take ownership of it.
1066 * flg_export is used by:
1069 * -1: if NAME is set, leave export status alone
1070 * if NAME is not set, do not export
1072 static int set_local_var(char *str, int flg_export)
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) {
1099 bb_error_msg("%s: readonly variable", str);
1103 debug_printf_env("%s: unsetenv '%s'\n", __func__, str);
1104 unsetenv(str); /* just in case */
1106 if (strcmp(cur->varstr, str) == 0) {
1111 if (cur->max_len >= strlen(str)) {
1112 /* This one is from startup env, reuse space */
1113 strcpy(cur->varstr, str);
1116 /* max_len == 0 signifies "malloced" var, which we can
1117 * (and has to) free */
1121 goto set_str_and_exp;
1124 /* Not found - create next variable struct */
1125 cur->next = xzalloc(sizeof(*cur));
1131 if (flg_export == 1)
1132 cur->flg_export = 1;
1133 if (cur->flg_export) {
1134 debug_printf_env("%s: putenv '%s'\n", __func__, cur->varstr);
1135 return putenv(cur->varstr);
1140 static int unset_local_var(const char *name)
1142 struct variable *cur;
1143 struct variable *prev = prev; /* for gcc */
1147 return EXIT_SUCCESS;
1148 name_len = strlen(name);
1151 if (strncmp(cur->varstr, name, name_len) == 0 && cur->varstr[name_len] == '=') {
1152 if (cur->flg_read_only) {
1153 bb_error_msg("%s: readonly variable", name);
1154 return EXIT_FAILURE;
1156 /* prev is ok to use here because 1st variable, HUSH_VERSION,
1157 * is ro, and we cannot reach this code on the 1st pass */
1158 prev->next = cur->next;
1159 debug_printf_env("%s: unsetenv '%s'\n", __func__, cur->varstr);
1160 bb_unsetenv(cur->varstr);
1164 return EXIT_SUCCESS;
1169 return EXIT_SUCCESS;
1172 #if ENABLE_SH_MATH_SUPPORT
1173 #define is_name(c) ((c) == '_' || isalpha((unsigned char)(c)))
1174 #define is_in_name(c) ((c) == '_' || isalnum((unsigned char)(c)))
1175 static char *endofname(const char *name)
1183 if (!is_in_name(*p))
1189 static void arith_set_local_var(const char *name, const char *val, int flags)
1191 /* arith code doesnt malloc space, so do it for it */
1192 char *var = xmalloc(strlen(name) + 1 + strlen(val) + 1);
1193 sprintf(var, "%s=%s", name, val);
1194 set_local_var(var, flags);
1201 static int static_get(struct in_str *i)
1204 if (ch == '\0') return EOF;
1208 static int static_peek(struct in_str *i)
1213 #if ENABLE_HUSH_INTERACTIVE
1215 static void cmdedit_set_initial_prompt(void)
1217 if (ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1218 G.PS1 = getenv("PS1");
1225 static const char* setup_prompt_string(int promptmode)
1227 const char *prompt_str;
1228 debug_printf("setup_prompt_string %d ", promptmode);
1229 if (!ENABLE_FEATURE_EDITING_FANCY_PROMPT) {
1230 /* Set up the prompt */
1231 if (promptmode == 0) { /* PS1 */
1233 G.PS1 = xasprintf("%s %c ", G.cwd, (geteuid() != 0) ? '$' : '#');
1238 prompt_str = (promptmode == 0) ? G.PS1 : G.PS2;
1239 debug_printf("result '%s'\n", prompt_str);
1243 static void get_user_input(struct in_str *i)
1246 const char *prompt_str;
1248 prompt_str = setup_prompt_string(i->promptmode);
1249 #if ENABLE_FEATURE_EDITING
1250 /* Enable command line editing only while a command line
1251 * is actually being read */
1254 /* buglet: SIGINT will not make new prompt to appear _at once_,
1255 * only after <Enter>. (^C will work) */
1256 r = read_line_input(prompt_str, G.user_input_buf, BUFSIZ-1, G.line_input_state);
1257 /* catch *SIGINT* etc (^C is handled by read_line_input) */
1258 check_and_run_traps(0);
1259 } while (r == 0 || G.flag_SIGINT); /* repeat if ^C or SIGINT */
1260 i->eof_flag = (r < 0);
1261 if (i->eof_flag) { /* EOF/error detected */
1262 G.user_input_buf[0] = EOF; /* yes, it will be truncated, it's ok */
1263 G.user_input_buf[1] = '\0';
1268 fputs(prompt_str, stdout);
1270 G.user_input_buf[0] = r = fgetc(i->file);
1271 /*G.user_input_buf[1] = '\0'; - already is and never changed */
1272 //do we need check_and_run_traps(0)? (maybe only if stdin)
1273 } while (G.flag_SIGINT);
1274 i->eof_flag = (r == EOF);
1276 i->p = G.user_input_buf;
1279 #endif /* INTERACTIVE */
1281 /* This is the magic location that prints prompts
1282 * and gets data back from the user */
1283 static int file_get(struct in_str *i)
1287 /* If there is data waiting, eat it up */
1288 if (i->p && *i->p) {
1289 #if ENABLE_HUSH_INTERACTIVE
1293 if (i->eof_flag && !*i->p)
1296 /* need to double check i->file because we might be doing something
1297 * more complicated by now, like sourcing or substituting. */
1298 #if ENABLE_HUSH_INTERACTIVE
1299 if (G.interactive_fd && i->promptme && i->file == stdin) {
1302 } while (!*i->p); /* need non-empty line */
1303 i->promptmode = 1; /* PS2 */
1308 ch = fgetc(i->file);
1310 debug_printf("file_get: got a '%c' %d\n", ch, ch);
1311 #if ENABLE_HUSH_INTERACTIVE
1318 /* All the callers guarantee this routine will never be
1319 * used right after a newline, so prompting is not needed.
1321 static int file_peek(struct in_str *i)
1324 if (i->p && *i->p) {
1325 if (i->eof_flag && !i->p[1])
1329 ch = fgetc(i->file);
1330 i->eof_flag = (ch == EOF);
1331 i->peek_buf[0] = ch;
1332 i->peek_buf[1] = '\0';
1334 debug_printf("file_peek: got a '%c' %d\n", *i->p, *i->p);
1338 static void setup_file_in_str(struct in_str *i, FILE *f)
1340 i->peek = file_peek;
1342 #if ENABLE_HUSH_INTERACTIVE
1344 i->promptmode = 0; /* PS1 */
1350 static void setup_string_in_str(struct in_str *i, const char *s)
1352 i->peek = static_peek;
1353 i->get = static_get;
1354 #if ENABLE_HUSH_INTERACTIVE
1356 i->promptmode = 0; /* PS1 */
1366 #define B_CHUNK (32 * sizeof(char*))
1368 static void o_reset(o_string *o)
1376 static void o_free(o_string *o)
1379 memset(o, 0, sizeof(*o));
1382 static void o_grow_by(o_string *o, int len)
1384 if (o->length + len > o->maxlen) {
1385 o->maxlen += (2*len > B_CHUNK ? 2*len : B_CHUNK);
1386 o->data = xrealloc(o->data, 1 + o->maxlen);
1390 static void o_addchr(o_string *o, int ch)
1392 debug_printf("o_addchr: '%c' o->length=%d o=%p\n", ch, o->length, o);
1394 o->data[o->length] = ch;
1396 o->data[o->length] = '\0';
1399 static void o_addstr(o_string *o, const char *str, int len)
1402 memcpy(&o->data[o->length], str, len);
1404 o->data[o->length] = '\0';
1407 static void o_addstrauto(o_string *o, const char *str)
1409 o_addstr(o, str, strlen(str) + 1);
1412 static void o_addstr_duplicate_backslash(o_string *o, const char *str, int len)
1417 && (*str != '*' && *str != '?' && *str != '[')
1425 /* My analysis of quoting semantics tells me that state information
1426 * is associated with a destination, not a source.
1428 static void o_addqchr(o_string *o, int ch)
1431 char *found = strchr("*?[\\", ch);
1436 o->data[o->length] = '\\';
1439 o->data[o->length] = ch;
1441 o->data[o->length] = '\0';
1444 static void o_addQchr(o_string *o, int ch)
1447 if (o->o_quote && strchr("*?[\\", ch)) {
1449 o->data[o->length] = '\\';
1453 o->data[o->length] = ch;
1455 o->data[o->length] = '\0';
1458 static void o_addQstr(o_string *o, const char *str, int len)
1461 o_addstr(o, str, len);
1467 int ordinary_cnt = strcspn(str, "*?[\\");
1468 if (ordinary_cnt > len) /* paranoia */
1470 o_addstr(o, str, ordinary_cnt);
1471 if (ordinary_cnt == len)
1473 str += ordinary_cnt;
1474 len -= ordinary_cnt + 1; /* we are processing + 1 char below */
1478 if (ch) { /* it is necessarily one of "*?[\\" */
1480 o->data[o->length] = '\\';
1484 o->data[o->length] = ch;
1486 o->data[o->length] = '\0';
1490 /* A special kind of o_string for $VAR and `cmd` expansion.
1491 * It contains char* list[] at the beginning, which is grown in 16 element
1492 * increments. Actual string data starts at the next multiple of 16 * (char*).
1493 * list[i] contains an INDEX (int!) into this string data.
1494 * It means that if list[] needs to grow, data needs to be moved higher up
1495 * but list[i]'s need not be modified.
1496 * NB: remembering how many list[i]'s you have there is crucial.
1497 * o_finalize_list() operation post-processes this structure - calculates
1498 * and stores actual char* ptrs in list[]. Oh, it NULL terminates it as well.
1500 #if DEBUG_EXPAND || DEBUG_GLOB
1501 static void debug_print_list(const char *prefix, o_string *o, int n)
1503 char **list = (char**)o->data;
1504 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1506 fprintf(stderr, "%s: list:%p n:%d string_start:%d length:%d maxlen:%d\n",
1507 prefix, list, n, string_start, o->length, o->maxlen);
1509 fprintf(stderr, " list[%d]=%d '%s' %p\n", i, (int)list[i],
1510 o->data + (int)list[i] + string_start,
1511 o->data + (int)list[i] + string_start);
1515 const char *p = o->data + (int)list[n - 1] + string_start;
1516 fprintf(stderr, " total_sz:%ld\n", (p + strlen(p) + 1) - o->data);
1520 #define debug_print_list(prefix, o, n) ((void)0)
1523 /* n = o_save_ptr_helper(str, n) "starts new string" by storing an index value
1524 * in list[n] so that it points past last stored byte so far.
1525 * It returns n+1. */
1526 static int o_save_ptr_helper(o_string *o, int n)
1528 char **list = (char**)o->data;
1532 if (!o->has_empty_slot) {
1533 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1534 string_len = o->length - string_start;
1535 if (!(n & 0xf)) { /* 0, 0x10, 0x20...? */
1536 debug_printf_list("list[%d]=%d string_start=%d (growing)\n", n, string_len, string_start);
1537 /* list[n] points to string_start, make space for 16 more pointers */
1538 o->maxlen += 0x10 * sizeof(list[0]);
1539 o->data = xrealloc(o->data, o->maxlen + 1);
1540 list = (char**)o->data;
1541 memmove(list + n + 0x10, list + n, string_len);
1542 o->length += 0x10 * sizeof(list[0]);
1544 debug_printf_list("list[%d]=%d string_start=%d\n", n, string_len, string_start);
1546 /* We have empty slot at list[n], reuse without growth */
1547 string_start = ((n+1 + 0xf) & ~0xf) * sizeof(list[0]); /* NB: n+1! */
1548 string_len = o->length - string_start;
1549 debug_printf_list("list[%d]=%d string_start=%d (empty slot)\n", n, string_len, string_start);
1550 o->has_empty_slot = 0;
1552 list[n] = (char*)(ptrdiff_t)string_len;
1556 /* "What was our last o_save_ptr'ed position (byte offset relative o->data)?" */
1557 static int o_get_last_ptr(o_string *o, int n)
1559 char **list = (char**)o->data;
1560 int string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1562 return ((int)(ptrdiff_t)list[n-1]) + string_start;
1565 /* o_glob performs globbing on last list[], saving each result
1566 * as a new list[]. */
1567 static int o_glob(o_string *o, int n)
1573 debug_printf_glob("start o_glob: n:%d o->data:%p\n", n, o->data);
1575 return o_save_ptr_helper(o, n);
1576 pattern = o->data + o_get_last_ptr(o, n);
1577 debug_printf_glob("glob pattern '%s'\n", pattern);
1578 if (!glob_needed(pattern)) {
1580 o->length = unbackslash(pattern) - o->data;
1581 debug_printf_glob("glob pattern '%s' is literal\n", pattern);
1582 return o_save_ptr_helper(o, n);
1585 memset(&globdata, 0, sizeof(globdata));
1586 gr = glob(pattern, 0, NULL, &globdata);
1587 debug_printf_glob("glob('%s'):%d\n", pattern, gr);
1588 if (gr == GLOB_NOSPACE)
1589 bb_error_msg_and_die("out of memory during glob");
1590 if (gr == GLOB_NOMATCH) {
1591 globfree(&globdata);
1594 if (gr != 0) { /* GLOB_ABORTED ? */
1595 //TODO: testcase for bad glob pattern behavior
1596 bb_error_msg("glob(3) error %d on '%s'", gr, pattern);
1598 if (globdata.gl_pathv && globdata.gl_pathv[0]) {
1599 char **argv = globdata.gl_pathv;
1600 o->length = pattern - o->data; /* "forget" pattern */
1602 o_addstrauto(o, *argv);
1603 n = o_save_ptr_helper(o, n);
1609 globfree(&globdata);
1611 debug_print_list("o_glob returning", o, n);
1615 /* If o->o_glob == 1, glob the string so far remembered.
1616 * Otherwise, just finish current list[] and start new */
1617 static int o_save_ptr(o_string *o, int n)
1619 if (o->o_glob) { /* if globbing is requested */
1620 /* If o->has_empty_slot, list[n] was already globbed
1621 * (if it was requested back then when it was filled)
1622 * so don't do that again! */
1623 if (!o->has_empty_slot)
1624 return o_glob(o, n); /* o_save_ptr_helper is inside */
1626 return o_save_ptr_helper(o, n);
1629 /* "Please convert list[n] to real char* ptrs, and NULL terminate it." */
1630 static char **o_finalize_list(o_string *o, int n)
1635 n = o_save_ptr(o, n); /* force growth for list[n] if necessary */
1637 debug_print_list("finalized", o, n);
1638 debug_printf_expand("finalized n:%d\n", n);
1639 list = (char**)o->data;
1640 string_start = ((n + 0xf) & ~0xf) * sizeof(list[0]);
1644 list[n] = o->data + (int)(ptrdiff_t)list[n] + string_start;
1650 /* expand_strvec_to_strvec() takes a list of strings, expands
1651 * all variable references within and returns a pointer to
1652 * a list of expanded strings, possibly with larger number
1653 * of strings. (Think VAR="a b"; echo $VAR).
1654 * This new list is allocated as a single malloc block.
1655 * NULL-terminated list of char* pointers is at the beginning of it,
1656 * followed by strings themself.
1657 * Caller can deallocate entire list by single free(list). */
1659 /* Store given string, finalizing the word and starting new one whenever
1660 * we encounter IFS char(s). This is used for expanding variable values.
1661 * End-of-string does NOT finalize word: think about 'echo -$VAR-' */
1662 static int expand_on_ifs(o_string *output, int n, const char *str)
1665 int word_len = strcspn(str, G.ifs);
1667 if (output->o_quote || !output->o_glob)
1668 o_addQstr(output, str, word_len);
1669 else /* protect backslashes against globbing up :) */
1670 o_addstr_duplicate_backslash(output, str, word_len);
1673 if (!*str) /* EOL - do not finalize word */
1675 o_addchr(output, '\0');
1676 debug_print_list("expand_on_ifs", output, n);
1677 n = o_save_ptr(output, n);
1678 str += strspn(str, G.ifs); /* skip ifs chars */
1680 debug_print_list("expand_on_ifs[1]", output, n);
1684 #if ENABLE_HUSH_TICK
1685 static int process_command_subs(o_string *dest,
1686 struct in_str *input, const char *subst_end);
1689 /* Expand all variable references in given string, adding words to list[]
1690 * at n, n+1,... positions. Return updated n (so that list[n] is next one
1691 * to be filled). This routine is extremely tricky: has to deal with
1692 * variables/parameters with whitespace, $* and $@, and constructs like
1693 * 'echo -$*-'. If you play here, you must run testsuite afterwards! */
1694 static int expand_vars_to_list(o_string *output, int n, char *arg, char or_mask)
1696 /* or_mask is either 0 (normal case) or 0x80
1697 * (expansion of right-hand side of assignment == 1-element expand.
1698 * It will also do no globbing, and thus we must not backslash-quote!) */
1700 char first_ch, ored_ch;
1707 debug_printf_expand("expand_vars_to_list: arg '%s'\n", arg);
1708 debug_print_list("expand_vars_to_list", output, n);
1709 n = o_save_ptr(output, n);
1710 debug_print_list("expand_vars_to_list[0]", output, n);
1712 while ((p = strchr(arg, SPECIAL_VAR_SYMBOL)) != NULL) {
1713 #if ENABLE_HUSH_TICK
1714 o_string subst_result = NULL_O_STRING;
1716 o_addstr(output, arg, p - arg);
1717 debug_print_list("expand_vars_to_list[1]", output, n);
1719 p = strchr(p, SPECIAL_VAR_SYMBOL);
1721 first_ch = arg[0] | or_mask; /* forced to "quoted" if or_mask = 0x80 */
1722 /* "$@" is special. Even if quoted, it can still
1723 * expand to nothing (not even an empty string) */
1724 if ((first_ch & 0x7f) != '@')
1725 ored_ch |= first_ch;
1727 switch (first_ch & 0x7f) {
1728 /* Highest bit in first_ch indicates that var is double-quoted */
1730 val = utoa(G.root_pid);
1732 case '!': /* bg pid */
1733 val = G.last_bg_pid ? utoa(G.last_bg_pid) : (char*)"";
1735 case '?': /* exitcode */
1736 val = utoa(G.last_return_code);
1738 case '#': /* argc */
1739 if (arg[1] != SPECIAL_VAR_SYMBOL)
1740 /* actually, it's a ${#var} */
1742 val = utoa(G.global_argc ? G.global_argc-1 : 0);
1747 if (!G.global_argv[i])
1749 ored_ch |= first_ch; /* do it for "$@" _now_, when we know it's not empty */
1750 if (!(first_ch & 0x80)) { /* unquoted $* or $@ */
1751 smallint sv = output->o_quote;
1752 /* unquoted var's contents should be globbed, so don't quote */
1753 output->o_quote = 0;
1754 while (G.global_argv[i]) {
1755 n = expand_on_ifs(output, n, G.global_argv[i]);
1756 debug_printf_expand("expand_vars_to_list: argv %d (last %d)\n", i, G.global_argc - 1);
1757 if (G.global_argv[i++][0] && G.global_argv[i]) {
1758 /* this argv[] is not empty and not last:
1759 * put terminating NUL, start new word */
1760 o_addchr(output, '\0');
1761 debug_print_list("expand_vars_to_list[2]", output, n);
1762 n = o_save_ptr(output, n);
1763 debug_print_list("expand_vars_to_list[3]", output, n);
1766 output->o_quote = sv;
1768 /* If or_mask is nonzero, we handle assignment 'a=....$@.....'
1769 * and in this case should treat it like '$*' - see 'else...' below */
1770 if (first_ch == ('@'|0x80) && !or_mask) { /* quoted $@ */
1772 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1773 if (++i >= G.global_argc)
1775 o_addchr(output, '\0');
1776 debug_print_list("expand_vars_to_list[4]", output, n);
1777 n = o_save_ptr(output, n);
1779 } else { /* quoted $*: add as one word */
1781 o_addQstr(output, G.global_argv[i], strlen(G.global_argv[i]));
1782 if (!G.global_argv[++i])
1785 o_addchr(output, G.ifs[0]);
1789 case SPECIAL_VAR_SYMBOL: /* <SPECIAL_VAR_SYMBOL><SPECIAL_VAR_SYMBOL> */
1790 /* "Empty variable", used to make "" etc to not disappear */
1794 #if ENABLE_HUSH_TICK
1795 case '`': { /* <SPECIAL_VAR_SYMBOL>`cmd<SPECIAL_VAR_SYMBOL> */
1796 struct in_str input;
1799 //TODO: can we just stuff it into "output" directly?
1800 debug_printf_subst("SUBST '%s' first_ch %x\n", arg, first_ch);
1801 setup_string_in_str(&input, arg);
1802 process_command_subs(&subst_result, &input, NULL);
1803 debug_printf_subst("SUBST RES '%s'\n", subst_result.data);
1804 val = subst_result.data;
1808 #if ENABLE_SH_MATH_SUPPORT
1809 case '+': { /* <SPECIAL_VAR_SYMBOL>(cmd<SPECIAL_VAR_SYMBOL> */
1815 debug_printf_subst("ARITH '%s' first_ch %x\n", arg, first_ch);
1816 res = arith(arg, &errcode, &G.hooks);
1819 case -3: maybe_die("arith", "exponent less than 0"); break;
1820 case -2: maybe_die("arith", "divide by zero"); break;
1821 case -5: maybe_die("arith", "expression recursion loop detected"); break;
1822 default: maybe_die("arith", "syntax error");
1824 sprintf(buf, arith_t_fmt, res);
1825 o_addstrauto(output, buf);
1826 debug_printf_subst("ARITH RES '"arith_t_fmt"'\n", res);
1830 default: /* <SPECIAL_VAR_SYMBOL>varname<SPECIAL_VAR_SYMBOL> */
1832 bool exp_len = false, exp_null = false;
1833 char *var = arg, exp_save, exp_op, *exp_word;
1836 arg[0] = first_ch & 0x7f;
1838 /* prepare for expansions */
1839 if (var[0] == '#') {
1840 /* handle length expansion ${#var} */
1844 /* maybe handle parameter expansion */
1845 exp_off = strcspn(var, ":-=+?");
1849 exp_save = var[exp_off];
1850 exp_null = exp_save == ':';
1851 exp_word = var + exp_off;
1852 if (exp_null) ++exp_word;
1853 exp_op = *exp_word++;
1854 var[exp_off] = '\0';
1858 /* lookup the variable in question */
1859 if (isdigit(var[0])) {
1860 /* handle_dollar() should have vetted var for us */
1862 if (i < G.global_argc)
1863 val = G.global_argv[i];
1864 /* else val remains NULL: $N with too big N */
1866 val = lookup_param(var);
1868 /* handle any expansions */
1870 debug_printf_expand("expand: length of '%s' = ", val);
1871 val = utoa(val ? strlen(val) : 0);
1872 debug_printf_expand("%s\n", val);
1873 } else if (exp_off) {
1874 /* we need to do an expansion */
1875 int exp_test = (!val || (exp_null && !val[0]));
1877 exp_test = !exp_test;
1878 debug_printf_expand("expand: op:%c (null:%s) test:%i\n", exp_op,
1879 exp_null ? "true" : "false", exp_test);
1882 maybe_die(var, *exp_word ? exp_word : "parameter null or not set");
1886 if (exp_op == '=') {
1887 if (isdigit(var[0]) || var[0] == '#') {
1888 maybe_die(var, "special vars cannot assign in this way");
1891 char *new_var = xmalloc(strlen(var) + strlen(val) + 2);
1892 sprintf(new_var, "%s=%s", var, val);
1893 set_local_var(new_var, -1);
1897 var[exp_off] = exp_save;
1902 #if ENABLE_HUSH_TICK
1905 if (!(first_ch & 0x80)) { /* unquoted $VAR */
1906 debug_printf_expand("unquoted '%s', output->o_quote:%d\n", val, output->o_quote);
1908 /* unquoted var's contents should be globbed, so don't quote */
1909 smallint sv = output->o_quote;
1910 output->o_quote = 0;
1911 n = expand_on_ifs(output, n, val);
1913 output->o_quote = sv;
1915 } else { /* quoted $VAR, val will be appended below */
1916 debug_printf_expand("quoted '%s', output->o_quote:%d\n", val, output->o_quote);
1921 o_addQstr(output, val, strlen(val));
1923 /* Do the check to avoid writing to a const string */
1924 if (p && *p != SPECIAL_VAR_SYMBOL)
1925 *p = SPECIAL_VAR_SYMBOL;
1927 #if ENABLE_HUSH_TICK
1928 o_free(&subst_result);
1931 } /* end of "while (SPECIAL_VAR_SYMBOL is found) ..." */
1934 debug_print_list("expand_vars_to_list[a]", output, n);
1935 /* this part is literal, and it was already pre-quoted
1936 * if needed (much earlier), do not use o_addQstr here! */
1937 o_addstrauto(output, arg);
1938 debug_print_list("expand_vars_to_list[b]", output, n);
1939 } else if (output->length == o_get_last_ptr(output, n) /* expansion is empty */
1940 && !(ored_ch & 0x80) /* and all vars were not quoted. */
1943 /* allow to reuse list[n] later without re-growth */
1944 output->has_empty_slot = 1;
1946 o_addchr(output, '\0');
1951 static char **expand_variables(char **argv, int or_mask)
1956 o_string output = NULL_O_STRING;
1958 if (or_mask & 0x100) {
1959 output.o_quote = 1; /* protect against globbing for "$var" */
1960 /* (unquoted $var will temporarily switch it off) */
1967 n = expand_vars_to_list(&output, n, *v, (char)or_mask);
1970 debug_print_list("expand_variables", &output, n);
1972 /* output.data (malloced in one block) gets returned in "list" */
1973 list = o_finalize_list(&output, n);
1974 debug_print_strings("expand_variables[1]", list);
1978 static char **expand_strvec_to_strvec(char **argv)
1980 return expand_variables(argv, 0x100);
1983 /* Used for expansion of right hand of assignments */
1984 /* NB: should NOT do globbing! "export v=/bin/c*; env | grep ^v=" outputs
1986 static char *expand_string_to_string(const char *str)
1988 char *argv[2], **list;
1990 argv[0] = (char*)str;
1992 list = expand_variables(argv, 0x80); /* 0x80: make one-element expansion */
1994 if (!list[0] || list[1])
1995 bb_error_msg_and_die("BUG in varexp2");
1996 /* actually, just move string 2*sizeof(char*) bytes back */
1997 overlapping_strcpy((char*)list, list[0]);
1998 debug_printf_expand("string_to_string='%s'\n", (char*)list);
2002 /* Used for "eval" builtin */
2003 static char* expand_strvec_to_string(char **argv)
2007 list = expand_variables(argv, 0x80);
2008 /* Convert all NULs to spaces */
2013 if (list[n-1] + strlen(list[n-1]) + 1 != list[n])
2014 bb_error_msg_and_die("BUG in varexp3");
2015 list[n][-1] = ' '; /* TODO: or to G.ifs[0]? */
2019 overlapping_strcpy((char*)list, list[0]);
2020 debug_printf_expand("strvec_to_string='%s'\n", (char*)list);
2024 static char **expand_assignments(char **argv, int count)
2028 /* Expand assignments into one string each */
2029 for (i = 0; i < count; i++) {
2030 p = add_string_to_strings(p, expand_string_to_string(argv[i]));
2036 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
2037 * and stderr if they are redirected. */
2038 static int setup_redirects(struct command *prog, int squirrel[])
2041 struct redir_struct *redir;
2043 for (redir = prog->redirects; redir; redir = redir->next) {
2044 if (redir->dup == -1 && redir->rd_filename == NULL) {
2045 /* something went wrong in the parse. Pretend it didn't happen */
2048 if (redir->dup == -1) {
2050 mode = redir_table[redir->rd_type].mode;
2051 //TODO: check redir for names like '\\'
2052 p = expand_string_to_string(redir->rd_filename);
2053 openfd = open_or_warn(p, mode);
2056 /* this could get lost if stderr has been redirected, but
2057 bash and ash both lose it as well (though zsh doesn't!) */
2061 openfd = redir->dup;
2064 if (openfd != redir->fd) {
2065 if (squirrel && redir->fd < 3) {
2066 squirrel[redir->fd] = dup(redir->fd);
2069 //close(openfd); // close(-3) ??!
2071 dup2(openfd, redir->fd);
2072 if (redir->dup == -1)
2080 static void restore_redirects(int squirrel[])
2083 for (i = 0; i < 3; i++) {
2086 /* We simply die on error */
2093 #if !defined(DEBUG_CLEAN)
2094 #define free_pipe_list(head, indent) free_pipe_list(head)
2095 #define free_pipe(pi, indent) free_pipe(pi)
2097 static int free_pipe_list(struct pipe *head, int indent);
2099 /* return code is the exit status of the pipe */
2100 static int free_pipe(struct pipe *pi, int indent)
2103 struct command *command;
2104 struct redir_struct *r, *rnext;
2105 int a, i, ret_code = 0;
2107 if (pi->stopped_cmds > 0)
2109 debug_printf_clean("%s run pipe: (pid %d)\n", indenter(indent), getpid());
2110 for (i = 0; i < pi->num_cmds; i++) {
2111 command = &pi->cmds[i];
2112 debug_printf_clean("%s command %d:\n", indenter(indent), i);
2113 if (command->argv) {
2114 for (a = 0, p = command->argv; *p; a++, p++) {
2115 debug_printf_clean("%s argv[%d] = %s\n", indenter(indent), a, *p);
2117 free_strings(command->argv);
2118 command->argv = NULL;
2119 } else if (command->group) {
2120 debug_printf_clean("%s begin group (grp_type:%d)\n", indenter(indent), command->grp_type);
2121 ret_code = free_pipe_list(command->group, indent+3);
2122 debug_printf_clean("%s end group\n", indenter(indent));
2124 debug_printf_clean("%s (nil)\n", indenter(indent));
2126 for (r = command->redirects; r; r = rnext) {
2127 debug_printf_clean("%s redirect %d%s", indenter(indent), r->fd, redir_table[r->rd_type].descrip);
2129 /* guard against the case >$FOO, where foo is unset or blank */
2130 if (r->rd_filename) {
2131 debug_printf_clean(" %s\n", r->rd_filename);
2132 free(r->rd_filename);
2133 r->rd_filename = NULL;
2136 debug_printf_clean("&%d\n", r->dup);
2141 command->redirects = NULL;
2143 free(pi->cmds); /* children are an array, they get freed all at once */
2152 static int free_pipe_list(struct pipe *head, int indent)
2154 int rcode = 0; /* if list has no members */
2155 struct pipe *pi, *next;
2157 for (pi = head; pi; pi = next) {
2159 debug_printf_clean("%s pipe reserved mode %d\n", indenter(indent), pi->res_word);
2161 rcode = free_pipe(pi, indent);
2162 debug_printf_clean("%s pipe followup code %d\n", indenter(indent), pi->followup);
2164 /*pi->next = NULL;*/
2172 typedef struct nommu_save_t {
2178 #define pseudo_exec_argv(nommu_save, argv, assignment_cnt, argv_expanded) \
2179 pseudo_exec_argv(argv, assignment_cnt, argv_expanded)
2180 #define pseudo_exec(nommu_save, command, argv_expanded) \
2181 pseudo_exec(command, argv_expanded)
2184 /* Called after [v]fork() in run_pipe(), or from builtin_exec().
2186 * XXX no exit() here. If you don't exec, use _exit instead.
2187 * The at_exit handlers apparently confuse the calling process,
2188 * in particular stdin handling. Not sure why? -- because of vfork! (vda) */
2189 static void pseudo_exec_argv(nommu_save_t *nommu_save, char **argv, int assignment_cnt, char **argv_expanded) NORETURN;
2190 static void pseudo_exec_argv(nommu_save_t *nommu_save, char **argv, int assignment_cnt, char **argv_expanded)
2194 const struct built_in_command *x;
2196 /* If a variable is assigned in a forest, and nobody listens,
2197 * was it ever really set?
2199 if (!argv[assignment_cnt])
2200 _exit(EXIT_SUCCESS);
2202 new_env = expand_assignments(argv, assignment_cnt);
2204 putenv_all(new_env);
2205 free(new_env); /* optional */
2207 nommu_save->new_env = new_env;
2208 nommu_save->old_env = putenv_all_and_save_old(new_env);
2210 if (argv_expanded) {
2211 argv = argv_expanded;
2213 argv = expand_strvec_to_strvec(argv);
2215 nommu_save->argv = argv;
2220 * Check if the command matches any of the builtins.
2221 * Depending on context, this might be redundant. But it's
2222 * easier to waste a few CPU cycles than it is to figure out
2223 * if this is one of those cases.
2225 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2226 if (strcmp(argv[0], x->cmd) == 0) {
2227 debug_printf_exec("running builtin '%s'\n", argv[0]);
2228 rcode = x->function(argv);
2234 /* Check if the command matches any busybox applets */
2235 #if ENABLE_FEATURE_SH_STANDALONE
2236 if (strchr(argv[0], '/') == NULL) {
2237 int a = find_applet_by_name(argv[0]);
2239 if (APPLET_IS_NOEXEC(a)) {
2240 debug_printf_exec("running applet '%s'\n", argv[0]);
2241 // is it ok that run_applet_no_and_exit() does exit(), not _exit()?
2242 run_applet_no_and_exit(a, argv);
2244 /* re-exec ourselves with the new arguments */
2245 debug_printf_exec("re-execing applet '%s'\n", argv[0]);
2246 execvp(bb_busybox_exec_path, argv);
2247 /* If they called chroot or otherwise made the binary no longer
2248 * executable, fall through */
2253 sigprocmask(SIG_SETMASK, &G.inherited_set, NULL);
2255 debug_printf_exec("execing '%s'\n", argv[0]);
2256 execvp(argv[0], argv);
2257 bb_perror_msg("can't exec '%s'", argv[0]);
2258 _exit(EXIT_FAILURE);
2261 static int run_list(struct pipe *pi);
2263 /* Called after [v]fork() in run_pipe()
2265 static void pseudo_exec(nommu_save_t *nommu_save, struct command *command, char **argv_expanded) NORETURN;
2266 static void pseudo_exec(nommu_save_t *nommu_save, struct command *command, char **argv_expanded)
2269 pseudo_exec_argv(nommu_save, command->argv, command->assignment_cnt, argv_expanded);
2271 if (command->group) {
2273 bb_error_msg_and_die("nested lists are not supported on NOMMU");
2276 debug_printf_exec("pseudo_exec: run_list\n");
2277 rcode = run_list(command->group);
2278 /* OK to leak memory by not calling free_pipe_list,
2279 * since this process is about to exit */
2284 /* Can happen. See what bash does with ">foo" by itself. */
2285 debug_printf("trying to pseudo_exec null command\n");
2286 _exit(EXIT_SUCCESS);
2290 static const char *get_cmdtext(struct pipe *pi)
2296 /* This is subtle. ->cmdtext is created only on first backgrounding.
2297 * (Think "cat, <ctrl-z>, fg, <ctrl-z>, fg, <ctrl-z>...." here...)
2298 * On subsequent bg argv is trashed, but we won't use it */
2301 argv = pi->cmds[0].argv;
2302 if (!argv || !argv[0]) {
2303 pi->cmdtext = xzalloc(1);
2308 do len += strlen(*argv) + 1; while (*++argv);
2309 pi->cmdtext = p = xmalloc(len);
2310 argv = pi->cmds[0].argv;
2312 len = strlen(*argv);
2313 memcpy(p, *argv, len);
2321 static void insert_bg_job(struct pipe *pi)
2323 struct pipe *thejob;
2326 /* Linear search for the ID of the job to use */
2328 for (thejob = G.job_list; thejob; thejob = thejob->next)
2329 if (thejob->jobid >= pi->jobid)
2330 pi->jobid = thejob->jobid + 1;
2332 /* Add thejob to the list of running jobs */
2334 thejob = G.job_list = xmalloc(sizeof(*thejob));
2336 for (thejob = G.job_list; thejob->next; thejob = thejob->next)
2338 thejob->next = xmalloc(sizeof(*thejob));
2339 thejob = thejob->next;
2342 /* Physically copy the struct job */
2343 memcpy(thejob, pi, sizeof(struct pipe));
2344 thejob->cmds = xzalloc(sizeof(pi->cmds[0]) * pi->num_cmds);
2345 /* We cannot copy entire pi->cmds[] vector! Double free()s will happen */
2346 for (i = 0; i < pi->num_cmds; i++) {
2347 // TODO: do we really need to have so many fields which are just dead weight
2348 // at execution stage?
2349 thejob->cmds[i].pid = pi->cmds[i].pid;
2350 /* all other fields are not used and stay zero */
2352 thejob->next = NULL;
2353 thejob->cmdtext = xstrdup(get_cmdtext(pi));
2355 /* We don't wait for background thejobs to return -- append it
2356 to the list of backgrounded thejobs and leave it alone */
2357 if (G.interactive_fd)
2358 printf("[%d] %d %s\n", thejob->jobid, thejob->cmds[0].pid, thejob->cmdtext);
2359 G.last_bg_pid = thejob->cmds[0].pid;
2360 G.last_jobid = thejob->jobid;
2363 static void remove_bg_job(struct pipe *pi)
2365 struct pipe *prev_pipe;
2367 if (pi == G.job_list) {
2368 G.job_list = pi->next;
2370 prev_pipe = G.job_list;
2371 while (prev_pipe->next != pi)
2372 prev_pipe = prev_pipe->next;
2373 prev_pipe->next = pi->next;
2376 G.last_jobid = G.job_list->jobid;
2381 /* Remove a backgrounded job */
2382 static void delete_finished_bg_job(struct pipe *pi)
2385 pi->stopped_cmds = 0;
2391 /* Check to see if any processes have exited -- if they
2392 * have, figure out why and see if a job has completed */
2393 static int checkjobs(struct pipe* fg_pipe)
2403 debug_printf_jobs("checkjobs %p\n", fg_pipe);
2406 // if (G.handled_SIGCHLD == G.count_SIGCHLD)
2407 // /* avoid doing syscall, nothing there anyway */
2410 attributes = WUNTRACED;
2411 if (fg_pipe == NULL)
2412 attributes |= WNOHANG;
2414 /* Do we do this right?
2415 * bash-3.00# sleep 20 | false
2417 * [3]+ Stopped sleep 20 | false
2418 * bash-3.00# echo $?
2419 * 1 <========== bg pipe is not fully done, but exitcode is already known!
2422 //FIXME: non-interactive bash does not continue even if all processes in fg pipe
2423 //are stopped. Testcase: "cat | cat" in a script (not on command line)
2424 // + killall -STOP cat
2431 // i = G.count_SIGCHLD;
2432 childpid = waitpid(-1, &status, attributes);
2433 if (childpid <= 0) {
2434 if (childpid && errno != ECHILD)
2435 bb_perror_msg("waitpid");
2436 // else /* Until next SIGCHLD, waitpid's are useless */
2437 // G.handled_SIGCHLD = i;
2440 dead = WIFEXITED(status) || WIFSIGNALED(status);
2443 if (WIFSTOPPED(status))
2444 debug_printf_jobs("pid %d stopped by sig %d (exitcode %d)\n",
2445 childpid, WSTOPSIG(status), WEXITSTATUS(status));
2446 if (WIFSIGNALED(status))
2447 debug_printf_jobs("pid %d killed by sig %d (exitcode %d)\n",
2448 childpid, WTERMSIG(status), WEXITSTATUS(status));
2449 if (WIFEXITED(status))
2450 debug_printf_jobs("pid %d exited, exitcode %d\n",
2451 childpid, WEXITSTATUS(status));
2453 /* Were we asked to wait for fg pipe? */
2455 for (i = 0; i < fg_pipe->num_cmds; i++) {
2456 debug_printf_jobs("check pid %d\n", fg_pipe->cmds[i].pid);
2457 if (fg_pipe->cmds[i].pid != childpid)
2459 /* printf("process %d exit %d\n", i, WEXITSTATUS(status)); */
2461 fg_pipe->cmds[i].pid = 0;
2462 fg_pipe->alive_cmds--;
2463 if (i == fg_pipe->num_cmds - 1) {
2464 /* last process gives overall exitstatus */
2465 rcode = WEXITSTATUS(status);
2466 IF_HAS_KEYWORDS(if (fg_pipe->pi_inverted) rcode = !rcode;)
2469 fg_pipe->cmds[i].is_stopped = 1;
2470 fg_pipe->stopped_cmds++;
2472 debug_printf_jobs("fg_pipe: alive_cmds %d stopped_cmds %d\n",
2473 fg_pipe->alive_cmds, fg_pipe->stopped_cmds);
2474 if (fg_pipe->alive_cmds - fg_pipe->stopped_cmds <= 0) {
2475 /* All processes in fg pipe have exited/stopped */
2477 if (fg_pipe->alive_cmds)
2478 insert_bg_job(fg_pipe);
2482 /* There are still running processes in the fg pipe */
2483 goto wait_more; /* do waitpid again */
2485 /* it wasnt fg_pipe, look for process in bg pipes */
2489 /* We asked to wait for bg or orphaned children */
2490 /* No need to remember exitcode in this case */
2491 for (pi = G.job_list; pi; pi = pi->next) {
2492 for (i = 0; i < pi->num_cmds; i++) {
2493 if (pi->cmds[i].pid == childpid)
2494 goto found_pi_and_prognum;
2497 /* Happens when shell is used as init process (init=/bin/sh) */
2498 debug_printf("checkjobs: pid %d was not in our list!\n", childpid);
2499 continue; /* do waitpid again */
2501 found_pi_and_prognum:
2504 pi->cmds[i].pid = 0;
2506 if (!pi->alive_cmds) {
2507 if (G.interactive_fd)
2508 printf(JOB_STATUS_FORMAT, pi->jobid,
2509 "Done", pi->cmdtext);
2510 delete_finished_bg_job(pi);
2514 pi->cmds[i].is_stopped = 1;
2518 } /* while (waitpid succeeds)... */
2524 static int checkjobs_and_fg_shell(struct pipe* fg_pipe)
2527 int rcode = checkjobs(fg_pipe);
2528 /* Job finished, move the shell to the foreground */
2529 p = getpgid(0); /* pgid of our process */
2530 debug_printf_jobs("fg'ing ourself: getpgid(0)=%d\n", (int)p);
2531 tcsetpgrp(G.interactive_fd, p);
2536 /* run_pipe() starts all the jobs, but doesn't wait for anything
2537 * to finish. See checkjobs().
2539 * return code is normally -1, when the caller has to wait for children
2540 * to finish to determine the exit status of the pipe. If the pipe
2541 * is a simple builtin command, however, the action is done by the
2542 * time run_pipe returns, and the exit code is provided as the
2545 * The input of the pipe is always stdin, the output is always
2546 * stdout. The outpipe[] mechanism in BusyBox-0.48 lash is bogus,
2547 * because it tries to avoid running the command substitution in
2548 * subshell, when that is in fact necessary. The subshell process
2549 * now has its stdout directed to the input of the appropriate pipe,
2550 * so this routine is noticeably simpler.
2552 * Returns -1 only if started some children. IOW: we have to
2553 * mask out retvals of builtins etc with 0xff!
2555 static int run_pipe(struct pipe *pi)
2559 int pipefds[2]; /* pipefds[0] is for reading */
2560 struct command *command;
2561 char **argv_expanded;
2563 const struct built_in_command *x;
2565 /* it is not always needed, but we aim to smaller code */
2566 int squirrel[] = { -1, -1, -1 };
2568 const int single_and_fg = (pi->num_cmds == 1 && pi->followup != PIPE_BG);
2570 debug_printf_exec("run_pipe start: single_and_fg=%d\n", single_and_fg);
2576 pi->stopped_cmds = 0;
2578 /* Check if this is a simple builtin (not part of a pipe).
2579 * Builtins within pipes have to fork anyway, and are handled in
2580 * pseudo_exec. "echo foo | read bar" doesn't work on bash, either.
2582 command = &(pi->cmds[0]);
2584 #if ENABLE_HUSH_FUNCTIONS
2585 if (single_and_fg && command->group && command->grp_type == GRP_FUNCTION) {
2586 /* We "execute" function definition */
2587 bb_error_msg("here we ought to remember function definition, and go on");
2588 return EXIT_SUCCESS;
2592 if (single_and_fg && command->group && command->grp_type == GRP_NORMAL) {
2593 debug_printf("non-subshell grouping\n");
2594 setup_redirects(command, squirrel);
2595 debug_printf_exec(": run_list\n");
2596 rcode = run_list(command->group) & 0xff;
2597 restore_redirects(squirrel);
2598 debug_printf_exec("run_pipe return %d\n", rcode);
2599 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2603 argv = command->argv;
2604 argv_expanded = NULL;
2606 if (single_and_fg && argv != NULL) {
2607 char **new_env = NULL;
2608 char **old_env = NULL;
2610 i = command->assignment_cnt;
2611 if (i != 0 && argv[i] == NULL) {
2612 /* assignments, but no command: set local environment */
2613 for (i = 0; argv[i] != NULL; i++) {
2614 debug_printf("local environment set: %s\n", argv[i]);
2615 p = expand_string_to_string(argv[i]);
2616 set_local_var(p, 0);
2618 return EXIT_SUCCESS; /* don't worry about errors in set_local_var() yet */
2621 /* Expand the rest into (possibly) many strings each */
2622 argv_expanded = expand_strvec_to_strvec(argv + i);
2624 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
2625 if (strcmp(argv_expanded[0], x->cmd) != 0)
2627 if (x->function == builtin_exec && argv_expanded[1] == NULL) {
2628 debug_printf("exec with redirects only\n");
2629 setup_redirects(command, NULL);
2630 rcode = EXIT_SUCCESS;
2631 goto clean_up_and_ret1;
2633 debug_printf("builtin inline %s\n", argv_expanded[0]);
2634 /* XXX setup_redirects acts on file descriptors, not FILEs.
2635 * This is perfect for work that comes after exec().
2636 * Is it really safe for inline use? Experimentally,
2637 * things seem to work with glibc. */
2638 setup_redirects(command, squirrel);
2639 new_env = expand_assignments(argv, command->assignment_cnt);
2640 old_env = putenv_all_and_save_old(new_env);
2641 debug_printf_exec(": builtin '%s' '%s'...\n", x->cmd, argv_expanded[1]);
2642 rcode = x->function(argv_expanded) & 0xff;
2643 #if ENABLE_FEATURE_SH_STANDALONE
2646 restore_redirects(squirrel);
2647 free_strings_and_unsetenv(new_env, 1);
2648 putenv_all(old_env);
2649 free(old_env); /* not free_strings()! */
2651 free(argv_expanded);
2652 IF_HAS_KEYWORDS(if (pi->pi_inverted) rcode = !rcode;)
2653 debug_printf_exec("run_pipe return %d\n", rcode);
2656 #if ENABLE_FEATURE_SH_STANDALONE
2657 i = find_applet_by_name(argv_expanded[0]);
2658 if (i >= 0 && APPLET_IS_NOFORK(i)) {
2659 setup_redirects(command, squirrel);
2660 save_nofork_data(&G.nofork_save);
2661 new_env = expand_assignments(argv, command->assignment_cnt);
2662 old_env = putenv_all_and_save_old(new_env);
2663 debug_printf_exec(": run_nofork_applet '%s' '%s'...\n", argv_expanded[0], argv_expanded[1]);
2664 rcode = run_nofork_applet_prime(&G.nofork_save, i, argv_expanded);
2665 goto clean_up_and_ret;
2670 /* NB: argv_expanded may already be created, and that
2671 * might include `cmd` runs! Do not rerun it! We *must*
2672 * use argv_expanded if it's non-NULL */
2674 /* Going to fork a child per each pipe member */
2678 for (i = 0; i < pi->num_cmds; i++) {
2680 volatile nommu_save_t nommu_save;
2681 nommu_save.new_env = NULL;
2682 nommu_save.old_env = NULL;
2683 nommu_save.argv = NULL;
2685 command = &(pi->cmds[i]);
2686 if (command->argv) {
2687 debug_printf_exec(": pipe member '%s' '%s'...\n", command->argv[0], command->argv[1]);
2689 debug_printf_exec(": pipe member with no argv\n");
2691 /* pipes are inserted between pairs of commands */
2694 if ((i + 1) < pi->num_cmds)
2697 command->pid = BB_MMU ? fork() : vfork();
2698 if (!command->pid) { /* child */
2700 die_sleep = 0; /* let nofork's xfuncs die */
2702 /* Every child adds itself to new process group
2703 * with pgid == pid_of_first_child_in_pipe */
2704 if (G.run_list_level == 1 && G.interactive_fd) {
2707 if (pgrp < 0) /* true for 1st process only */
2709 if (setpgid(0, pgrp) == 0 && pi->followup != PIPE_BG) {
2710 /* We do it in *every* child, not just first,
2712 tcsetpgrp(G.interactive_fd, pgrp);
2716 xmove_fd(nextin, 0);
2717 xmove_fd(pipefds[1], 1); /* write end */
2719 close(pipefds[0]); /* read end */
2720 /* Like bash, explicit redirects override pipes,
2721 * and the pipe fd is available for dup'ing. */
2722 setup_redirects(command, NULL);
2724 /* Restore default handlers just prior to exec */
2725 /*signal(SIGCHLD, SIG_DFL); - so far we don't have any handlers */
2727 /* Stores to nommu_save list of env vars putenv'ed
2728 * (NOMMU, on MMU we don't need that) */
2729 /* cast away volatility... */
2730 pseudo_exec((nommu_save_t*) &nommu_save, command, argv_expanded);
2731 /* pseudo_exec() does not return */
2735 /* Clean up after vforked child */
2736 free(nommu_save.argv);
2737 free_strings_and_unsetenv(nommu_save.new_env, 1);
2738 putenv_all(nommu_save.old_env);
2740 free(argv_expanded);
2741 argv_expanded = NULL;
2742 if (command->pid < 0) { /* [v]fork failed */
2743 /* Clearly indicate, was it fork or vfork */
2744 bb_perror_msg(BB_MMU ? "fork" : "vfork");
2748 /* Second and next children need to know pid of first one */
2750 pi->pgrp = command->pid;
2756 if ((i + 1) < pi->num_cmds)
2757 close(pipefds[1]); /* write end */
2758 /* Pass read (output) pipe end to next iteration */
2759 nextin = pipefds[0];
2762 if (!pi->alive_cmds) {
2763 debug_printf_exec("run_pipe return 1 (all forks failed, no children)\n");
2767 debug_printf_exec("run_pipe return -1 (%u children started)\n", pi->alive_cmds);
2771 #ifndef debug_print_tree
2772 static void debug_print_tree(struct pipe *pi, int lvl)
2774 static const char *const PIPE[] = {
2780 static const char *RES[] = {
2781 [RES_NONE ] = "NONE" ,
2784 [RES_THEN ] = "THEN" ,
2785 [RES_ELIF ] = "ELIF" ,
2786 [RES_ELSE ] = "ELSE" ,
2789 #if ENABLE_HUSH_LOOPS
2790 [RES_FOR ] = "FOR" ,
2791 [RES_WHILE] = "WHILE",
2792 [RES_UNTIL] = "UNTIL",
2794 [RES_DONE ] = "DONE" ,
2796 #if ENABLE_HUSH_LOOPS || ENABLE_HUSH_CASE
2799 #if ENABLE_HUSH_CASE
2800 [RES_CASE ] = "CASE" ,
2801 [RES_MATCH] = "MATCH",
2802 [RES_CASEI] = "CASEI",
2803 [RES_ESAC ] = "ESAC" ,
2805 [RES_XXXX ] = "XXXX" ,
2806 [RES_SNTX ] = "SNTX" ,
2808 static const char *const GRPTYPE[] = {
2811 #if ENABLE_HUSH_FUNCTIONS
2820 fprintf(stderr, "%*spipe %d res_word=%s followup=%d %s\n", lvl*2, "",
2821 pin, RES[pi->res_word], pi->followup, PIPE[pi->followup]);
2823 while (prn < pi->num_cmds) {
2824 struct command *command = &pi->cmds[prn];
2825 char **argv = command->argv;
2827 fprintf(stderr, "%*s prog %d assignment_cnt:%d", lvl*2, "", prn, command->assignment_cnt);
2828 if (command->group) {
2829 fprintf(stderr, " group %s: (argv=%p)\n",
2830 GRPTYPE[command->grp_type],
2832 debug_print_tree(command->group, lvl+1);
2836 if (argv) while (*argv) {
2837 fprintf(stderr, " '%s'", *argv);
2840 fprintf(stderr, "\n");
2849 /* NB: called by pseudo_exec, and therefore must not modify any
2850 * global data until exec/_exit (we can be a child after vfork!) */
2851 static int run_list(struct pipe *pi)
2853 #if ENABLE_HUSH_CASE
2854 char *case_word = NULL;
2856 #if ENABLE_HUSH_LOOPS
2857 struct pipe *loop_top = NULL;
2858 char *for_varname = NULL;
2859 char **for_lcur = NULL;
2860 char **for_list = NULL;
2862 smallint flag_skip = 1;
2863 smalluint rcode = 0; /* probably just for compiler */
2864 #if ENABLE_HUSH_IF || ENABLE_HUSH_CASE
2865 smalluint cond_code = 0;
2867 enum { cond_code = 0, };
2869 /*enum reserved_style*/ smallint rword = RES_NONE;
2870 /*enum reserved_style*/ smallint skip_more_for_this_rword = RES_XXXX;
2872 debug_printf_exec("run_list start lvl %d\n", G.run_list_level + 1);
2874 #if ENABLE_HUSH_LOOPS
2875 /* Check syntax for "for" */
2876 for (struct pipe *cpipe = pi; cpipe; cpipe = cpipe->next) {
2877 if (cpipe->res_word != RES_FOR && cpipe->res_word != RES_IN)
2879 /* current word is FOR or IN (BOLD in comments below) */
2880 if (cpipe->next == NULL) {
2881 syntax("malformed for");
2882 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
2885 /* "FOR v; do ..." and "for v IN a b; do..." are ok */
2886 if (cpipe->next->res_word == RES_DO)
2888 /* next word is not "do". It must be "in" then ("FOR v in ...") */
2889 if (cpipe->res_word == RES_IN /* "for v IN a b; not_do..."? */
2890 || cpipe->next->res_word != RES_IN /* FOR v not_do_and_not_in..."? */
2892 syntax("malformed for");
2893 debug_printf_exec("run_list lvl %d return 1\n", G.run_list_level);
2899 /* Past this point, all code paths should jump to ret: label
2900 * in order to return, no direct "return" statements please.
2901 * This helps to ensure that no memory is leaked. */
2903 ////TODO: ctrl-Z handling needs re-thinking and re-testing
2906 /* Example of nested list: "while true; do { sleep 1 | exit 2; } done".
2907 * We are saving state before entering outermost list ("while...done")
2908 * so that ctrl-Z will correctly background _entire_ outermost list,
2909 * not just a part of it (like "sleep 1 | exit 2") */
2910 if (++G.run_list_level == 1 && G.interactive_fd) {
2911 if (sigsetjmp(G.toplevel_jb, 1)) {
2912 /* ctrl-Z forked and we are parent; or ctrl-C.
2913 * Sighandler has longjmped us here */
2914 signal(SIGINT, SIG_IGN);
2915 signal(SIGTSTP, SIG_IGN);
2916 /* Restore level (we can be coming from deep inside
2918 G.run_list_level = 1;
2919 #if ENABLE_FEATURE_SH_STANDALONE
2920 if (G.nofork_save.saved) { /* if save area is valid */
2921 debug_printf_jobs("exiting nofork early\n");
2922 restore_nofork_data(&G.nofork_save);
2925 //// if (G.ctrl_z_flag) {
2926 //// /* ctrl-Z has forked and stored pid of the child in pi->pid.
2927 //// * Remember this child as background job */
2928 //// insert_bg_job(pi);
2930 /* ctrl-C. We just stop doing whatever we were doing */
2933 USE_HUSH_LOOPS(loop_top = NULL;)
2934 USE_HUSH_LOOPS(G.depth_of_loop = 0;)
2938 //// /* ctrl-Z handler will store pid etc in pi */
2939 //// G.toplevel_list = pi;
2940 //// G.ctrl_z_flag = 0;
2941 ////#if ENABLE_FEATURE_SH_STANDALONE
2942 //// G.nofork_save.saved = 0; /* in case we will run a nofork later */
2944 //// signal_SA_RESTART_empty_mask(SIGTSTP, handler_ctrl_z);
2945 //// signal(SIGINT, handler_ctrl_c);
2949 /* Go through list of pipes, (maybe) executing them. */
2950 for (; pi; pi = USE_HUSH_LOOPS(rword == RES_DONE ? loop_top : ) pi->next) {
2954 IF_HAS_KEYWORDS(rword = pi->res_word;)
2955 IF_HAS_NO_KEYWORDS(rword = RES_NONE;)
2956 debug_printf_exec(": rword=%d cond_code=%d skip_more=%d\n",
2957 rword, cond_code, skip_more_for_this_rword);
2958 #if ENABLE_HUSH_LOOPS
2959 if ((rword == RES_WHILE || rword == RES_UNTIL || rword == RES_FOR)
2960 && loop_top == NULL /* avoid bumping G.depth_of_loop twice */
2962 /* start of a loop: remember where loop starts */
2967 if (rword == skip_more_for_this_rword && flag_skip) {
2968 if (pi->followup == PIPE_SEQ)
2970 /* it is "<false> && CMD" or "<true> || CMD"
2971 * and we should not execute CMD */
2975 skip_more_for_this_rword = RES_XXXX;
2978 if (rword == RES_THEN) {
2979 /* "if <false> THEN cmd": skip cmd */
2983 if (rword == RES_ELSE || rword == RES_ELIF) {
2984 /* "if <true> then ... ELSE/ELIF cmd":
2985 * skip cmd and all following ones */
2990 #if ENABLE_HUSH_LOOPS
2991 if (rword == RES_FOR) { /* && pi->num_cmds - always == 1 */
2993 /* first loop through for */
2995 static const char encoded_dollar_at[] ALIGN1 = {
2996 SPECIAL_VAR_SYMBOL, '@' | 0x80, SPECIAL_VAR_SYMBOL, '\0'
2997 }; /* encoded representation of "$@" */
2998 static const char *const encoded_dollar_at_argv[] = {
2999 encoded_dollar_at, NULL
3000 }; /* argv list with one element: "$@" */
3003 vals = (char**)encoded_dollar_at_argv;
3004 if (pi->next->res_word == RES_IN) {
3005 /* if no variable values after "in" we skip "for" */
3006 if (!pi->next->cmds[0].argv)
3008 vals = pi->next->cmds[0].argv;
3009 } /* else: "for var; do..." -> assume "$@" list */
3010 /* create list of variable values */
3011 debug_print_strings("for_list made from", vals);
3012 for_list = expand_strvec_to_strvec(vals);
3013 for_lcur = for_list;
3014 debug_print_strings("for_list", for_list);
3015 for_varname = pi->cmds[0].argv[0];
3016 pi->cmds[0].argv[0] = NULL;
3018 free(pi->cmds[0].argv[0]);
3020 /* "for" loop is over, clean up */
3024 pi->cmds[0].argv[0] = for_varname;
3027 /* insert next value from for_lcur */
3028 //TODO: does it need escaping?
3029 pi->cmds[0].argv[0] = xasprintf("%s=%s", for_varname, *for_lcur++);
3030 pi->cmds[0].assignment_cnt = 1;
3032 if (rword == RES_IN) /* "for v IN list;..." - "in" has no cmds anyway */
3034 if (rword == RES_DONE) {
3035 continue; /* "done" has no cmds too */
3038 #if ENABLE_HUSH_CASE
3039 if (rword == RES_CASE) {
3040 case_word = expand_strvec_to_string(pi->cmds->argv);
3043 if (rword == RES_MATCH) {
3046 if (!case_word) /* "case ... matched_word) ... WORD)": we executed selected branch, stop */
3048 /* all prev words didn't match, does this one match? */
3049 argv = pi->cmds->argv;
3051 char *pattern = expand_string_to_string(*argv);
3052 /* TODO: which FNM_xxx flags to use? */
3053 cond_code = (fnmatch(pattern, case_word, /*flags:*/ 0) != 0);
3055 if (cond_code == 0) { /* match! we will execute this branch */
3056 free(case_word); /* make future "word)" stop */
3064 if (rword == RES_CASEI) { /* inside of a case branch */
3066 continue; /* not matched yet, skip this pipe */
3069 /* Just pressing <enter> in shell should check for jobs.
3070 * OTOH, in non-interactive shell this is useless
3071 * and only leads to extra job checks */
3072 if (pi->num_cmds == 0) {
3073 if (G.interactive_fd)
3074 goto check_jobs_and_continue;
3078 /* After analyzing all keywords and conditions, we decided
3079 * to execute this pipe. NB: have to do checkjobs(NULL)
3080 * after run_pipe() to collect any background children,
3081 * even if list execution is to be stopped. */
3082 debug_printf_exec(": run_pipe with %d members\n", pi->num_cmds);
3085 #if ENABLE_HUSH_LOOPS
3086 G.flag_break_continue = 0;
3088 rcode = r = run_pipe(pi); /* NB: rcode is a smallint */
3090 /* we only ran a builtin: rcode is already known
3091 * and we don't need to wait for anything. */
3092 check_and_run_traps(0);
3093 #if ENABLE_HUSH_LOOPS
3094 /* was it "break" or "continue"? */
3095 if (G.flag_break_continue) {
3096 smallint fbc = G.flag_break_continue;
3097 /* we might fall into outer *loop*,
3098 * don't want to break it too */
3100 G.depth_break_continue--;
3101 if (G.depth_break_continue == 0)
3102 G.flag_break_continue = 0;
3103 /* else: e.g. "continue 2" should *break* once, *then* continue */
3104 } /* else: "while... do... { we are here (innermost list is not a loop!) };...done" */
3105 if (G.depth_break_continue != 0 || fbc == BC_BREAK)
3106 goto check_jobs_and_break;
3107 /* "continue": simulate end of loop */
3112 } else if (pi->followup == PIPE_BG) {
3113 /* what does bash do with attempts to background builtins? */
3114 /* even bash 3.2 doesn't do that well with nested bg:
3115 * try "{ { sleep 10; echo DEEP; } & echo HERE; } &".
3116 * I'm NOT treating inner &'s as jobs */
3117 check_and_run_traps(0);
3119 if (G.run_list_level == 1)
3122 rcode = 0; /* EXIT_SUCCESS */
3125 if (G.run_list_level == 1 && G.interactive_fd) {
3126 /* waits for completion, then fg's main shell */
3127 rcode = checkjobs_and_fg_shell(pi);
3128 check_and_run_traps(0);
3129 debug_printf_exec(": checkjobs_and_fg_shell returned %d\n", rcode);
3132 { /* this one just waits for completion */
3133 rcode = checkjobs(pi);
3134 check_and_run_traps(0);
3135 debug_printf_exec(": checkjobs returned %d\n", rcode);
3139 debug_printf_exec(": setting last_return_code=%d\n", rcode);
3140 G.last_return_code = rcode;
3142 /* Analyze how result affects subsequent commands */
3144 if (rword == RES_IF || rword == RES_ELIF)
3147 #if ENABLE_HUSH_LOOPS
3148 if (rword == RES_WHILE) {
3150 rcode = 0; /* "while false; do...done" - exitcode 0 */
3151 goto check_jobs_and_break;
3154 if (rword == RES_UNTIL) {
3156 check_jobs_and_break:
3162 if ((rcode == 0 && pi->followup == PIPE_OR)
3163 || (rcode != 0 && pi->followup == PIPE_AND)
3165 skip_more_for_this_rword = rword;
3168 check_jobs_and_continue:
3173 //// if (G.ctrl_z_flag) {
3174 //// /* ctrl-Z forked somewhere in the past, we are the child,
3175 //// * and now we completed running the list. Exit. */
3181 //// if (!G.run_list_level && G.interactive_fd) {
3182 //// signal(SIGTSTP, SIG_IGN);
3183 //// signal(SIGINT, SIG_IGN);
3186 debug_printf_exec("run_list lvl %d return %d\n", G.run_list_level + 1, rcode);
3187 #if ENABLE_HUSH_LOOPS
3192 #if ENABLE_HUSH_CASE
3198 /* Select which version we will use */
3199 static int run_and_free_list(struct pipe *pi)
3202 debug_printf_exec("run_and_free_list entered\n");
3204 debug_printf_exec(": run_list with %d members\n", pi->num_cmds);
3205 rcode = run_list(pi);
3207 /* free_pipe_list has the side effect of clearing memory.
3208 * In the long run that function can be merged with run_list,
3209 * but doing that now would hobble the debugging effort. */
3210 free_pipe_list(pi, /* indent: */ 0);
3211 debug_printf_exec("run_and_free_list return %d\n", rcode);
3216 /* Peek ahead in the in_str to find out if we have a "&n" construct,
3217 * as in "2>&1", that represents duplicating a file descriptor.
3218 * Return either -2 (syntax error), -1 (no &), or the number found.
3220 static int redirect_dup_num(struct in_str *input)
3222 int ch, d = 0, ok = 0;
3224 if (ch != '&') return -1;
3226 i_getch(input); /* get the & */
3230 return -3; /* "-" represents "close me" */
3232 while (isdigit(ch)) {
3233 d = d*10 + (ch-'0');
3240 bb_error_msg("ambiguous redirect");
3244 /* The src parameter allows us to peek forward to a possible &n syntax
3245 * for file descriptor duplication, e.g., "2>&1".
3246 * Return code is 0 normally, 1 if a syntax error is detected in src.
3247 * Resource errors (in xmalloc) cause the process to exit */
3248 static int setup_redirect(struct parse_context *ctx, int fd, redir_type style,
3249 struct in_str *input)
3251 struct command *command = ctx->command;
3252 struct redir_struct *redir = command->redirects;
3253 struct redir_struct *last_redir = NULL;
3255 /* Create a new redir_struct and drop it onto the end of the linked list */
3258 redir = redir->next;
3260 redir = xzalloc(sizeof(struct redir_struct));
3261 /* redir->next = NULL; */
3262 /* redir->rd_filename = NULL; */
3264 last_redir->next = redir;
3266 command->redirects = redir;
3269 redir->rd_type = style;
3270 redir->fd = (fd == -1) ? redir_table[style].default_fd : fd;
3272 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
3274 /* Check for a '2>&1' type redirect */
3275 redir->dup = redirect_dup_num(input);
3276 if (redir->dup == -2)
3277 return 1; /* syntax error */
3278 if (redir->dup != -1) {
3279 /* Erik had a check here that the file descriptor in question
3280 * is legit; I postpone that to "run time"
3281 * A "-" representation of "close me" shows up as a -3 here */
3282 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
3284 /* We do _not_ try to open the file that src points to,
3285 * since we need to return and let src be expanded first.
3286 * Set ctx->pending_redirect, so we know what to do at the
3287 * end of the next parsed word. */
3288 ctx->pending_redirect = redir;
3294 static struct pipe *new_pipe(void)
3297 pi = xzalloc(sizeof(struct pipe));
3298 /*pi->followup = 0; - deliberately invalid value */
3299 /*pi->res_word = RES_NONE; - RES_NONE is 0 anyway */
3303 /* Command (member of a pipe) is complete. The only possible error here
3304 * is out of memory, in which case xmalloc exits. */
3305 static int done_command(struct parse_context *ctx)
3307 /* The command is really already in the pipe structure, so
3308 * advance the pipe counter and make a new, null command. */
3309 struct pipe *pi = ctx->pipe;
3310 struct command *command = ctx->command;
3313 if (command->group == NULL
3314 && command->argv == NULL
3315 && command->redirects == NULL
3317 debug_printf_parse("done_command: skipping null cmd, num_cmds=%d\n", pi->num_cmds);
3318 return pi->num_cmds;
3321 debug_printf_parse("done_command: ++num_cmds=%d\n", pi->num_cmds);
3323 debug_printf_parse("done_command: initializing, num_cmds=%d\n", pi->num_cmds);
3326 /* Only real trickiness here is that the uncommitted
3327 * command structure is not counted in pi->num_cmds. */
3328 pi->cmds = xrealloc(pi->cmds, sizeof(*pi->cmds) * (pi->num_cmds+1));
3329 command = &pi->cmds[pi->num_cmds];
3330 memset(command, 0, sizeof(*command));
3332 ctx->command = command;
3333 /* but ctx->pipe and ctx->list_head remain unchanged */
3335 return pi->num_cmds; /* used only for 0/nonzero check */
3338 static void done_pipe(struct parse_context *ctx, pipe_style type)
3342 debug_printf_parse("done_pipe entered, followup %d\n", type);
3343 /* Close previous command */
3344 not_null = done_command(ctx);
3345 ctx->pipe->followup = type;
3346 IF_HAS_KEYWORDS(ctx->pipe->pi_inverted = ctx->ctx_inverted;)
3347 IF_HAS_KEYWORDS(ctx->ctx_inverted = 0;)
3348 IF_HAS_KEYWORDS(ctx->pipe->res_word = ctx->ctx_res_w;)
3350 /* Without this check, even just <enter> on command line generates
3351 * tree of three NOPs (!). Which is harmless but annoying.
3352 * IOW: it is safe to do it unconditionally.
3353 * RES_NONE case is for "for a in; do ..." (empty IN set)
3354 * to work, possibly other cases too. */
3355 if (not_null IF_HAS_KEYWORDS(|| ctx->ctx_res_w != RES_NONE)) {
3357 debug_printf_parse("done_pipe: adding new pipe: "
3358 "not_null:%d ctx->ctx_res_w:%d\n",
3359 not_null, ctx->ctx_res_w);
3361 ctx->pipe->next = new_p;
3363 ctx->command = NULL; /* needed! */
3364 /* RES_THEN, RES_DO etc are "sticky" -
3365 * they remain set for commands inside if/while.
3366 * This is used to control execution.
3367 * RES_FOR and RES_IN are NOT sticky (needed to support
3368 * cases where variable or value happens to match a keyword):
3370 #if ENABLE_HUSH_LOOPS
3371 if (ctx->ctx_res_w == RES_FOR
3372 || ctx->ctx_res_w == RES_IN)
3373 ctx->ctx_res_w = RES_NONE;
3375 #if ENABLE_HUSH_CASE
3376 if (ctx->ctx_res_w == RES_MATCH)
3377 ctx->ctx_res_w = RES_CASEI;
3379 /* Create the memory for command, roughly:
3380 * ctx->pipe->cmds = new struct command;
3381 * ctx->command = &ctx->pipe->cmds[0];
3385 debug_printf_parse("done_pipe return\n");
3388 static void initialize_context(struct parse_context *ctx)
3390 memset(ctx, 0, sizeof(*ctx));
3391 ctx->pipe = ctx->list_head = new_pipe();
3392 /* Create the memory for command, roughly:
3393 * ctx->pipe->cmds = new struct command;
3394 * ctx->command = &ctx->pipe->cmds[0];
3400 /* If a reserved word is found and processed, parse context is modified
3401 * and 1 is returned.
3404 struct reserved_combo {
3407 unsigned char assignment_flag;
3411 FLAG_END = (1 << RES_NONE ),
3413 FLAG_IF = (1 << RES_IF ),
3414 FLAG_THEN = (1 << RES_THEN ),
3415 FLAG_ELIF = (1 << RES_ELIF ),
3416 FLAG_ELSE = (1 << RES_ELSE ),
3417 FLAG_FI = (1 << RES_FI ),
3419 #if ENABLE_HUSH_LOOPS
3420 FLAG_FOR = (1 << RES_FOR ),
3421 FLAG_WHILE = (1 << RES_WHILE),
3422 FLAG_UNTIL = (1 << RES_UNTIL),
3423 FLAG_DO = (1 << RES_DO ),
3424 FLAG_DONE = (1 << RES_DONE ),
3425 FLAG_IN = (1 << RES_IN ),
3427 #if ENABLE_HUSH_CASE
3428 FLAG_MATCH = (1 << RES_MATCH),
3429 FLAG_ESAC = (1 << RES_ESAC ),
3431 FLAG_START = (1 << RES_XXXX ),
3434 static const struct reserved_combo* match_reserved_word(o_string *word)
3436 /* Mostly a list of accepted follow-up reserved words.
3437 * FLAG_END means we are done with the sequence, and are ready
3438 * to turn the compound list into a command.
3439 * FLAG_START means the word must start a new compound list.
3441 static const struct reserved_combo reserved_list[] = {
3443 { "!", RES_NONE, NOT_ASSIGNMENT , 0 },
3444 { "if", RES_IF, WORD_IS_KEYWORD, FLAG_THEN | FLAG_START },
3445 { "then", RES_THEN, WORD_IS_KEYWORD, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
3446 { "elif", RES_ELIF, WORD_IS_KEYWORD, FLAG_THEN },
3447 { "else", RES_ELSE, WORD_IS_KEYWORD, FLAG_FI },
3448 { "fi", RES_FI, NOT_ASSIGNMENT , FLAG_END },
3450 #if ENABLE_HUSH_LOOPS
3451 { "for", RES_FOR, NOT_ASSIGNMENT , FLAG_IN | FLAG_DO | FLAG_START },
3452 { "while", RES_WHILE, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3453 { "until", RES_UNTIL, WORD_IS_KEYWORD, FLAG_DO | FLAG_START },
3454 { "in", RES_IN, NOT_ASSIGNMENT , FLAG_DO },
3455 { "do", RES_DO, WORD_IS_KEYWORD, FLAG_DONE },
3456 { "done", RES_DONE, NOT_ASSIGNMENT , FLAG_END },
3458 #if ENABLE_HUSH_CASE
3459 { "case", RES_CASE, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_START },
3460 { "esac", RES_ESAC, NOT_ASSIGNMENT , FLAG_END },
3463 const struct reserved_combo *r;
3465 for (r = reserved_list; r < reserved_list + ARRAY_SIZE(reserved_list); r++) {
3466 if (strcmp(word->data, r->literal) == 0)
3471 static int reserved_word(o_string *word, struct parse_context *ctx)
3473 #if ENABLE_HUSH_CASE
3474 static const struct reserved_combo reserved_match = {
3475 "", RES_MATCH, NOT_ASSIGNMENT , FLAG_MATCH | FLAG_ESAC
3478 const struct reserved_combo *r;
3480 r = match_reserved_word(word);
3484 debug_printf("found reserved word %s, res %d\n", r->literal, r->res);
3485 #if ENABLE_HUSH_CASE
3486 if (r->res == RES_IN && ctx->ctx_res_w == RES_CASE)
3487 /* "case word IN ..." - IN part starts first match part */
3488 r = &reserved_match;
3491 if (r->flag == 0) { /* '!' */
3492 if (ctx->ctx_inverted) { /* bash doesn't accept '! ! true' */
3494 IF_HAS_KEYWORDS(ctx->ctx_res_w = RES_SNTX;)
3496 ctx->ctx_inverted = 1;
3499 if (r->flag & FLAG_START) {
3500 struct parse_context *new;
3501 debug_printf("push stack\n");
3502 new = xmalloc(sizeof(*new));
3503 *new = *ctx; /* physical copy */
3504 initialize_context(ctx);
3506 } else if (/*ctx->ctx_res_w == RES_NONE ||*/ !(ctx->old_flag & (1 << r->res))) {
3508 ctx->ctx_res_w = RES_SNTX;
3511 ctx->ctx_res_w = r->res;
3512 ctx->old_flag = r->flag;
3513 if (ctx->old_flag & FLAG_END) {
3514 struct parse_context *old;
3515 debug_printf("pop stack\n");
3516 done_pipe(ctx, PIPE_SEQ);
3518 old->command->group = ctx->list_head;
3519 old->command->grp_type = GRP_NORMAL;
3520 *ctx = *old; /* physical copy */
3523 word->o_assignment = r->assignment_flag;
3528 //TODO: many, many callers don't check error from done_word()
3530 /* Word is complete, look at it and update parsing context.
3531 * Normal return is 0. Syntax errors return 1. */
3532 static int done_word(o_string *word, struct parse_context *ctx)
3534 struct command *command = ctx->command;
3536 debug_printf_parse("done_word entered: '%s' %p\n", word->data, command);
3537 if (word->length == 0 && word->nonnull == 0) {
3538 debug_printf_parse("done_word return 0: true null, ignored\n");
3541 /* If this word wasn't an assignment, next ones definitely
3542 * can't be assignments. Even if they look like ones. */
3543 if (word->o_assignment != DEFINITELY_ASSIGNMENT
3544 && word->o_assignment != WORD_IS_KEYWORD
3546 word->o_assignment = NOT_ASSIGNMENT;
3548 if (word->o_assignment == DEFINITELY_ASSIGNMENT)
3549 command->assignment_cnt++;
3550 word->o_assignment = MAYBE_ASSIGNMENT;
3553 if (ctx->pending_redirect) {
3554 /* We do not glob in e.g. >*.tmp case. bash seems to glob here
3555 * only if run as "bash", not "sh" */
3556 ctx->pending_redirect->rd_filename = xstrdup(word->data);
3557 word->o_assignment = NOT_ASSIGNMENT;
3558 debug_printf("word stored in rd_filename: '%s'\n", word->data);
3560 /* "{ echo foo; } echo bar" - bad */
3561 /* NB: bash allows e.g. "if true; then { echo foo; } fi". TODO? */
3562 if (command->group) {
3564 debug_printf_parse("done_word return 1: syntax error, groups and arglists don't mix\n");
3568 #if ENABLE_HUSH_CASE
3569 if (ctx->ctx_dsemicolon
3570 && strcmp(word->data, "esac") != 0 /* not "... pattern) cmd;; esac" */
3572 /* already done when ctx_dsemicolon was set to 1: */
3573 /* ctx->ctx_res_w = RES_MATCH; */
3574 ctx->ctx_dsemicolon = 0;
3578 if (!command->argv /* if it's the first word... */
3579 #if ENABLE_HUSH_LOOPS
3580 && ctx->ctx_res_w != RES_FOR /* ...not after FOR or IN */
3581 && ctx->ctx_res_w != RES_IN
3584 debug_printf_parse(": checking '%s' for reserved-ness\n", word->data);
3585 if (reserved_word(word, ctx)) {
3587 debug_printf_parse("done_word return %d\n", (ctx->ctx_res_w == RES_SNTX));
3588 return (ctx->ctx_res_w == RES_SNTX);
3592 if (word->nonnull /* word had "xx" or 'xx' at least as part of it. */
3593 /* optimization: and if it's ("" or '') or ($v... or `cmd`...): */
3594 && (word->data[0] == '\0' || word->data[0] == SPECIAL_VAR_SYMBOL)
3595 /* (otherwise it's known to be not empty and is already safe) */
3597 /* exclude "$@" - it can expand to no word despite "" */
3598 char *p = word->data;
3599 while (p[0] == SPECIAL_VAR_SYMBOL
3600 && (p[1] & 0x7f) == '@'
3601 && p[2] == SPECIAL_VAR_SYMBOL
3605 if (p == word->data || p[0] != '\0') {
3606 /* saw no "$@", or not only "$@" but some
3607 * real text is there too */
3608 /* insert "empty variable" reference, this makes
3609 * e.g. "", $empty"" etc to not disappear */
3610 o_addchr(word, SPECIAL_VAR_SYMBOL);
3611 o_addchr(word, SPECIAL_VAR_SYMBOL);
3614 command->argv = add_string_to_strings(command->argv, xstrdup(word->data));
3615 debug_print_strings("word appended to argv", command->argv);
3619 ctx->pending_redirect = NULL;
3621 #if ENABLE_HUSH_LOOPS
3622 /* Force FOR to have just one word (variable name) */
3623 /* NB: basically, this makes hush see "for v in ..." syntax as if
3624 * as it is "for v; in ...". FOR and IN become two pipe structs
3626 if (ctx->ctx_res_w == RES_FOR) {
3627 //TODO: check that command->argv[0] is a valid variable name!
3628 done_pipe(ctx, PIPE_SEQ);
3631 #if ENABLE_HUSH_CASE
3632 /* Force CASE to have just one word */
3633 if (ctx->ctx_res_w == RES_CASE) {
3634 done_pipe(ctx, PIPE_SEQ);
3637 debug_printf_parse("done_word return 0\n");
3641 /* If a redirect is immediately preceded by a number, that number is
3642 * supposed to tell which file descriptor to redirect. This routine
3643 * looks for such preceding numbers. In an ideal world this routine
3644 * needs to handle all the following classes of redirects...
3645 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
3646 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
3647 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
3648 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
3649 * A -1 output from this program means no valid number was found, so the
3650 * caller should use the appropriate default for this redirection.
3652 static int redirect_opt_num(o_string *o)
3658 for (num = 0; num < o->length; num++) {
3659 if (!isdigit(o->data[num])) {
3663 num = atoi(o->data);
3668 static int parse_stream(o_string *dest, struct parse_context *ctx,
3669 struct in_str *input0, const char *end_trigger);
3671 #if ENABLE_HUSH_TICK
3672 static FILE *generate_stream_from_list(struct pipe *head)
3675 int pid, channel[2];
3678 /* *** NOMMU WARNING *** */
3679 /* By using vfork here, we suspend parent till child exits or execs.
3680 * If child will not do it before it fills the pipe, it can block forever
3681 * in write(STDOUT_FILENO), and parent (shell) will be also stuck.
3683 * yes "0123456789012345678901234567890" | dd bs=32 count=64k >TESTFILE
3684 * huge=`cat TESTFILE` # will block here forever
3687 pid = BB_MMU ? fork() : vfork();
3689 bb_perror_msg_and_die(BB_MMU ? "fork" : "vfork");
3690 if (pid == 0) { /* child */
3691 if (ENABLE_HUSH_JOB)
3692 die_sleep = 0; /* let nofork's xfuncs die */
3693 close(channel[0]); /* NB: close _first_, then move fd! */
3694 xmove_fd(channel[1], 1);
3695 /* Prevent it from trying to handle ctrl-z etc */
3697 G.run_list_level = 1;
3699 /* Process substitution is not considered to be usual
3700 * 'command execution'.
3701 * SUSv3 says ctrl-Z should be ignored, ctrl-C should not.
3703 set_jobctrl_signals_to_IGN();
3705 /* Note: freeing 'head' here would break NOMMU. */
3706 _exit(run_list(head));
3709 pf = fdopen(channel[0], "r");
3711 /* 'head' is freed by the caller */
3714 /* Return code is exit status of the process that is run. */
3715 static int process_command_subs(o_string *dest,
3716 struct in_str *input,
3717 const char *subst_end)
3719 int retcode, ch, eol_cnt;
3720 o_string result = NULL_O_STRING;
3721 struct parse_context inner;
3723 struct in_str pipe_str;
3725 initialize_context(&inner);
3727 /* Recursion to generate command */
3728 retcode = parse_stream(&result, &inner, input, subst_end);
3730 return retcode; /* syntax error or EOF */
3731 done_word(&result, &inner);
3732 done_pipe(&inner, PIPE_SEQ);
3735 p = generate_stream_from_list(inner.list_head);
3738 close_on_exec_on(fileno(p));
3739 setup_file_in_str(&pipe_str, p);
3741 /* Now send results of command back into original context */
3743 while ((ch = i_getch(&pipe_str)) != EOF) {
3749 o_addchr(dest, '\n');
3752 o_addQchr(dest, ch);
3755 debug_printf("done reading from pipe, pclose()ing\n");
3756 /* This is the step that waits for the child. Should be pretty
3757 * safe, since we just read an EOF from its stdout. We could try
3758 * to do better, by using waitpid, and keeping track of background jobs
3759 * at the same time. That would be a lot of work, and contrary
3760 * to the KISS philosophy of this program. */
3761 retcode = fclose(p);
3762 free_pipe_list(inner.list_head, /* indent: */ 0);
3763 debug_printf("closed FILE from child, retcode=%d\n", retcode);
3768 static int parse_group(o_string *dest, struct parse_context *ctx,
3769 struct in_str *input, int ch)
3771 /* dest contains characters seen prior to ( or {.
3772 * Typically it's empty, but for functions defs,
3773 * it contains function name (without '()'). */
3775 const char *endch = NULL;
3776 struct parse_context sub;
3777 struct command *command = ctx->command;
3779 debug_printf_parse("parse_group entered\n");
3780 #if ENABLE_HUSH_FUNCTIONS
3781 if (ch == 'F') { /* function definition? */
3782 bb_error_msg("aha '%s' is a function, parsing it...", dest->data);
3783 //command->fname = dest->data;
3784 command->grp_type = GRP_FUNCTION;
3785 //TODO: review every o_reset() location... do they handle all o_string fields correctly?
3786 memset(dest, 0, sizeof(*dest));
3789 if (command->argv /* word [word](... */
3790 || dest->length /* word(... */
3791 || dest->nonnull /* ""(... */
3794 debug_printf_parse("parse_group return 1: syntax error, groups and arglists don't mix\n");
3797 initialize_context(&sub);
3801 command->grp_type = GRP_SUBSHELL;
3803 rcode = parse_stream(dest, &sub, input, endch);
3805 done_word(dest, &sub); /* finish off the final word in the subcontext */
3806 done_pipe(&sub, PIPE_SEQ); /* and the final command there, too */
3807 command->group = sub.list_head;
3809 debug_printf_parse("parse_group return %d\n", rcode);
3811 /* command remains "open", available for possible redirects */
3814 #if ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT
3815 /* Subroutines for copying $(...) and `...` things */
3816 static void add_till_backquote(o_string *dest, struct in_str *input);
3818 static void add_till_single_quote(o_string *dest, struct in_str *input)
3821 int ch = i_getch(input);
3829 /* "...\"...`..`...." - do we need to handle "...$(..)..." too? */
3830 static void add_till_double_quote(o_string *dest, struct in_str *input)
3833 int ch = i_getch(input);
3836 if (ch == '\\') { /* \x. Copy both chars. */
3838 ch = i_getch(input);
3844 add_till_backquote(dest, input);
3848 //if (ch == '$') ...
3851 /* Process `cmd` - copy contents until "`" is seen. Complicated by
3853 * "Within the backquoted style of command substitution, backslash
3854 * shall retain its literal meaning, except when followed by: '$', '`', or '\'.
3855 * The search for the matching backquote shall be satisfied by the first
3856 * backquote found without a preceding backslash; during this search,
3857 * if a non-escaped backquote is encountered within a shell comment,
3858 * a here-document, an embedded command substitution of the $(command)
3859 * form, or a quoted string, undefined results occur. A single-quoted
3860 * or double-quoted string that begins, but does not end, within the
3861 * "`...`" sequence produces undefined results."
3863 * echo `echo '\'TEST\`echo ZZ\`BEST` \TESTZZBEST
3865 static void add_till_backquote(o_string *dest, struct in_str *input)
3868 int ch = i_getch(input);
3871 if (ch == '\\') { /* \x. Copy both chars unless it is \` */
3872 int ch2 = i_getch(input);
3873 if (ch2 != '`' && ch2 != '$' && ch2 != '\\')
3882 /* Process $(cmd) - copy contents until ")" is seen. Complicated by
3883 * quoting and nested ()s.
3884 * "With the $(command) style of command substitution, all characters
3885 * following the open parenthesis to the matching closing parenthesis
3886 * constitute the command. Any valid shell script can be used for command,
3887 * except a script consisting solely of redirections which produces
3888 * unspecified results."
3890 * echo $(echo '(TEST)' BEST) (TEST) BEST
3891 * echo $(echo 'TEST)' BEST) TEST) BEST
3892 * echo $(echo \(\(TEST\) BEST) ((TEST) BEST
3894 static void add_till_closing_paren(o_string *dest, struct in_str *input, bool dbl)
3898 int ch = i_getch(input);
3907 if (i_peek(input) == ')') {
3914 add_till_single_quote(dest, input);
3919 add_till_double_quote(dest, input);
3923 if (ch == '\\') { /* \x. Copy verbatim. Important for \(, \) */
3924 ch = i_getch(input);
3932 #endif /* ENABLE_HUSH_TICK || ENABLE_SH_MATH_SUPPORT */
3934 /* Return code: 0 for OK, 1 for syntax error */
3935 static int handle_dollar(o_string *dest, struct in_str *input)
3938 int ch = i_peek(input); /* first character after the $ */
3939 unsigned char quote_mask = dest->o_quote ? 0x80 : 0;
3941 debug_printf_parse("handle_dollar entered: ch='%c'\n", ch);
3945 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3947 debug_printf_parse(": '%c'\n", ch);
3948 o_addchr(dest, ch | quote_mask);
3951 if (!isalnum(ch) && ch != '_')
3955 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3956 } else if (isdigit(ch)) {
3959 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3960 debug_printf_parse(": '%c'\n", ch);
3961 o_addchr(dest, ch | quote_mask);
3962 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3963 } else switch (ch) {
3965 case '!': /* last bg pid */
3966 case '?': /* last exit code */
3967 case '#': /* number of args */
3968 case '*': /* args */
3969 case '@': /* args */
3970 goto make_one_char_var;
3972 bool first_char, all_digits;
3974 o_addchr(dest, SPECIAL_VAR_SYMBOL);
3976 /* XXX maybe someone will try to escape the '}' */
3981 ch = i_getch(input);
3987 /* ${#var}: length of var contents */
3989 else if (isdigit(ch)) {
3995 if (expansion < 2 &&
3996 ((all_digits && !isdigit(ch)) ||
3997 (!all_digits && !isalnum(ch) && ch != '_')))
3999 /* handle parameter expansions
4000 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_02
4005 case ':': /* null modifier */
4006 if (expansion == 0) {
4007 debug_printf_parse(": null modifier\n");
4013 #if 0 /* not implemented yet :( */
4014 case '#': /* remove prefix */
4015 case '%': /* remove suffix */
4016 if (expansion == 0) {
4017 debug_printf_parse(": remove suffix/prefix\n");
4024 case '-': /* default value */
4025 case '=': /* assign default */
4026 case '+': /* alternative */
4027 case '?': /* error indicate */
4028 debug_printf_parse(": parameter expansion\n");
4034 syntax("unterminated ${name}");
4035 debug_printf_parse("handle_dollar return 1: unterminated ${name}\n");
4041 debug_printf_parse(": '%c'\n", ch);
4042 o_addchr(dest, ch | quote_mask);
4046 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4052 #if ENABLE_SH_MATH_SUPPORT
4053 if (i_peek(input) == '(') {
4055 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4056 o_addchr(dest, quote_mask | '+');
4057 add_till_closing_paren(dest, input, true);
4058 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4063 #if ENABLE_HUSH_TICK
4064 //int pos = dest->length;
4065 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4066 o_addchr(dest, quote_mask | '`');
4067 add_till_closing_paren(dest, input, false);
4068 //debug_printf_subst("SUBST RES2 '%s'\n", dest->data + pos);
4069 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4076 if (isalnum(ch)) { /* it's $_name or $_123 */
4082 /* still unhandled, but should be eventually */
4083 bb_error_msg("unhandled syntax: $%c", ch);
4087 o_addQchr(dest, '$');
4089 debug_printf_parse("handle_dollar return 0\n");
4093 /* Scan input, call done_word() whenever full IFS delimited word was seen.
4094 * Call done_pipe if '\n' was seen (and end_trigger != NULL).
4095 * Return code is 0 if end_trigger char is met,
4096 * -1 on EOF (but if end_trigger == NULL then return 0),
4097 * 1 for syntax error */
4098 static int parse_stream(o_string *dest, struct parse_context *ctx,
4099 struct in_str *input, const char *end_trigger)
4103 redir_type redir_style;
4104 int shadow_quote = dest->o_quote;
4107 /* Only double-quote state is handled in the state variable dest->o_quote.
4108 * A single-quote triggers a bypass of the main loop until its mate is
4109 * found. When recursing, quote state is passed in via dest->o_quote. */
4111 debug_printf_parse("parse_stream entered, end_trigger='%s' dest->o_assignment:%d\n", end_trigger, dest->o_assignment);
4116 ch = i_getch(input);
4120 next = i_peek(input);
4123 debug_printf_parse(": ch=%c (%d) m=%d quote=%d\n",
4124 ch, ch, m, dest->o_quote);
4125 if (m == CHAR_ORDINARY
4126 || (m != CHAR_SPECIAL && shadow_quote)
4129 syntax("unterminated \"");
4130 debug_printf_parse("parse_stream return 1: unterminated \"\n");
4133 o_addQchr(dest, ch);
4134 if ((dest->o_assignment == MAYBE_ASSIGNMENT
4135 || dest->o_assignment == WORD_IS_KEYWORD)
4137 && is_assignment(dest->data)
4139 dest->o_assignment = DEFINITELY_ASSIGNMENT;
4143 if (m == CHAR_IFS) {
4144 if (done_word(dest, ctx)) {
4145 debug_printf_parse("parse_stream return 1: done_word!=0\n");
4150 /* If we aren't performing a substitution, treat
4151 * a newline as a command separator.
4152 * [why we don't handle it exactly like ';'? --vda] */
4153 if (end_trigger && ch == '\n') {
4154 #if ENABLE_HUSH_CASE
4155 /* "case ... in <newline> word) ..." -
4156 * newlines are ignored (but ';' wouldn't be) */
4157 if (dest->length == 0 // && argv[0] == NULL
4158 && ctx->ctx_res_w == RES_MATCH
4163 done_pipe(ctx, PIPE_SEQ);
4164 dest->o_assignment = MAYBE_ASSIGNMENT;
4168 if (!shadow_quote && strchr(end_trigger, ch)) {
4169 /* Special case: (...word) makes last word terminate,
4170 * as if ';' is seen */
4172 done_word(dest, ctx);
4174 done_pipe(ctx, PIPE_SEQ);
4175 dest->o_assignment = MAYBE_ASSIGNMENT;
4178 IF_HAS_KEYWORDS(|| (ctx->ctx_res_w == RES_NONE && ctx->old_flag == 0))
4180 debug_printf_parse("parse_stream return 0: end_trigger char found\n");
4188 if (dest->o_assignment == MAYBE_ASSIGNMENT) {
4189 /* ch is a special char and thus this word
4190 * cannot be an assignment: */
4191 dest->o_assignment = NOT_ASSIGNMENT;
4196 if (dest->length == 0 && !shadow_quote) {
4199 if (ch == EOF || ch == '\n')
4204 o_addQchr(dest, ch);
4210 debug_printf_parse("parse_stream return 1: \\<eof>\n");
4214 * "The backslash retains its special meaning [in "..."]
4215 * only when followed by one of the following characters:
4216 * $, `, ", \, or <newline>. A double quote may be quoted
4217 * within double quotes by preceding it with a backslash.
4218 * If enabled, history expansion will be performed unless
4219 * an ! appearing in double quotes is escaped using
4220 * a backslash. The backslash preceding the ! is not removed."
4222 if (shadow_quote) { //NOT SURE dest->o_quote) {
4223 if (strchr("$`\"\\", next) != NULL) {
4224 o_addqchr(dest, i_getch(input));
4226 o_addqchr(dest, '\\');
4229 o_addchr(dest, '\\');
4230 o_addchr(dest, i_getch(input));
4234 if (handle_dollar(dest, input) != 0) {
4235 debug_printf_parse("parse_stream return 1: handle_dollar returned non-0\n");
4242 ch = i_getch(input);
4244 syntax("unterminated '");
4245 debug_printf_parse("parse_stream return 1: unterminated '\n");
4250 if (dest->o_assignment == NOT_ASSIGNMENT)
4251 o_addqchr(dest, ch);
4258 shadow_quote ^= 1; /* invert */
4259 if (dest->o_assignment == NOT_ASSIGNMENT)
4262 #if ENABLE_HUSH_TICK
4264 //int pos = dest->length;
4265 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4266 o_addchr(dest, shadow_quote /*or dest->o_quote??*/ ? 0x80 | '`' : '`');
4267 add_till_backquote(dest, input);
4268 o_addchr(dest, SPECIAL_VAR_SYMBOL);
4269 //debug_printf_subst("SUBST RES3 '%s'\n", dest->data + pos);
4274 redir_fd = redirect_opt_num(dest);
4275 done_word(dest, ctx);
4276 redir_style = REDIRECT_OVERWRITE;
4278 redir_style = REDIRECT_APPEND;
4282 else if (next == '(') {
4283 syntax(">(process) not supported");
4284 debug_printf_parse("parse_stream return 1: >(process) not supported\n");
4288 setup_redirect(ctx, redir_fd, redir_style, input);
4291 redir_fd = redirect_opt_num(dest);
4292 done_word(dest, ctx);
4293 redir_style = REDIRECT_INPUT;
4295 redir_style = REDIRECT_HEREIS;
4297 } else if (next == '>') {
4298 redir_style = REDIRECT_IO;
4302 else if (next == '(') {
4303 syntax("<(process) not supported");
4304 debug_printf_parse("parse_stream return 1: <(process) not supported\n");
4308 setup_redirect(ctx, redir_fd, redir_style, input);
4311 #if ENABLE_HUSH_CASE
4314 done_word(dest, ctx);
4315 done_pipe(ctx, PIPE_SEQ);
4316 #if ENABLE_HUSH_CASE
4317 /* Eat multiple semicolons, detect
4318 * whether it means something special */
4324 if (ctx->ctx_res_w == RES_CASEI) {
4325 ctx->ctx_dsemicolon = 1;
4326 ctx->ctx_res_w = RES_MATCH;
4332 /* We just finished a cmd. New one may start
4333 * with an assignment */
4334 dest->o_assignment = MAYBE_ASSIGNMENT;
4337 done_word(dest, ctx);
4340 done_pipe(ctx, PIPE_AND);
4342 done_pipe(ctx, PIPE_BG);
4346 done_word(dest, ctx);
4347 #if ENABLE_HUSH_CASE
4348 if (ctx->ctx_res_w == RES_MATCH)
4349 break; /* we are in case's "word | word)" */
4351 if (next == '|') { /* || */
4353 done_pipe(ctx, PIPE_OR);
4355 /* we could pick up a file descriptor choice here
4356 * with redirect_opt_num(), but bash doesn't do it.
4357 * "echo foo 2| cat" yields "foo 2". */
4362 #if ENABLE_HUSH_CASE
4363 /* "case... in [(]word)..." - skip '(' */
4364 if (ctx->ctx_res_w == RES_MATCH
4365 && ctx->command->argv == NULL /* not (word|(... */
4366 && dest->length == 0 /* not word(... */
4367 && dest->nonnull == 0 /* not ""(... */
4372 #if ENABLE_HUSH_FUNCTIONS
4373 if (dest->length != 0 /* not just () but word() */
4374 && dest->nonnull == 0 /* not a"b"c() */
4375 && ctx->command->argv == NULL /* it's the first word */
4376 //TODO: "func ( ) {...}" - note spaces - is valid format too in bash
4377 && i_peek(input) == ')'
4378 && !match_reserved_word(dest)
4380 bb_error_msg("seems like a function definition");
4383 //TODO: do it properly.
4384 ch = i_getch(input);
4385 } while (ch == ' ' || ch == '\n');
4387 syntax("was expecting {");
4388 debug_printf_parse("parse_stream return 1\n");
4391 ch = 'F'; /* magic value */
4395 if (parse_group(dest, ctx, input, ch) != 0) {
4396 debug_printf_parse("parse_stream return 1: parse_group returned non-0\n");
4401 #if ENABLE_HUSH_CASE
4402 if (ctx->ctx_res_w == RES_MATCH)
4406 /* proper use of this character is caught by end_trigger:
4407 * if we see {, we call parse_group(..., end_trigger='}')
4408 * and it will match } earlier (not here). */
4409 syntax("unexpected } or )");
4410 debug_printf_parse("parse_stream return 1: unexpected '}'\n");
4414 bb_error_msg_and_die("BUG: unexpected %c\n", ch);
4417 debug_printf_parse("parse_stream return %d\n", -(end_trigger != NULL));
4423 static void set_in_charmap(const char *set, int code)
4426 G.charmap[(unsigned char)*set++] = code;
4429 static void update_charmap(void)
4431 G.ifs = getenv("IFS");
4434 /* Precompute a list of 'flow through' behavior so it can be treated
4435 * quickly up front. Computation is necessary because of IFS.
4436 * Special case handling of IFS == " \t\n" is not implemented.
4437 * The charmap[] array only really needs two bits each,
4438 * and on most machines that would be faster (reduced L1 cache use).
4440 memset(G.charmap, CHAR_ORDINARY, sizeof(G.charmap));
4441 #if ENABLE_HUSH_TICK
4442 set_in_charmap("\\$\"`", CHAR_SPECIAL);
4444 set_in_charmap("\\$\"", CHAR_SPECIAL);
4446 set_in_charmap("<>;&|(){}#'", CHAR_ORDINARY_IF_QUOTED);
4447 set_in_charmap(G.ifs, CHAR_IFS); /* are ordinary if quoted */
4450 /* Most recursion does not come through here, the exception is
4451 * from builtin_source() and builtin_eval() */
4452 static int parse_and_run_stream(struct in_str *inp, int parse_flag)
4454 struct parse_context ctx;
4455 o_string temp = NULL_O_STRING;
4459 initialize_context(&ctx);
4461 #if ENABLE_HUSH_INTERACTIVE
4462 inp->promptmode = 0; /* PS1 */
4464 /* We will stop & execute after each ';' or '\n'.
4465 * Example: "sleep 9999; echo TEST" + ctrl-C:
4466 * TEST should be printed */
4467 temp.o_assignment = MAYBE_ASSIGNMENT;
4468 rcode = parse_stream(&temp, &ctx, inp, ";\n");
4470 if (rcode != 1 && ctx.old_flag != 0) {
4474 if (rcode != 1 IF_HAS_KEYWORDS(&& ctx.old_flag == 0)) {
4475 done_word(&temp, &ctx);
4476 done_pipe(&ctx, PIPE_SEQ);
4477 debug_print_tree(ctx.list_head, 0);
4478 debug_printf_exec("parse_stream_outer: run_and_free_list\n");
4479 run_and_free_list(ctx.list_head);
4481 /* We arrive here also if rcode == 1 (error in parse_stream) */
4483 if (ctx.old_flag != 0) {
4488 /*temp.nonnull = 0; - o_free does it below */
4489 /*temp.o_quote = 0; - o_free does it below */
4490 free_pipe_list(ctx.list_head, /* indent: */ 0);
4491 /* Discard all unprocessed line input, force prompt on */
4493 #if ENABLE_HUSH_INTERACTIVE
4498 /* loop on syntax errors, return on EOF: */
4499 } while (rcode != -1 && !(parse_flag & PARSEFLAG_EXIT_FROM_LOOP));
4503 static int parse_and_run_string(const char *s, int parse_flag)
4505 struct in_str input;
4506 setup_string_in_str(&input, s);
4507 return parse_and_run_stream(&input, parse_flag);
4510 static int parse_and_run_file(FILE *f)
4513 struct in_str input;
4514 setup_file_in_str(&input, f);
4515 rcode = parse_and_run_stream(&input, 0 /* parse_flag */);
4520 /* Make sure we have a controlling tty. If we get started under a job
4521 * aware app (like bash for example), make sure we are now in charge so
4522 * we don't fight over who gets the foreground */
4523 static void setup_job_control(void)
4527 shell_pgrp = getpgrp();
4529 /* If we were ran as 'hush &',
4530 * sleep until we are in the foreground. */
4531 while (tcgetpgrp(G.interactive_fd) != shell_pgrp) {
4532 /* Send TTIN to ourself (should stop us) */
4533 kill(- shell_pgrp, SIGTTIN);
4534 shell_pgrp = getpgrp();
4537 /* We _must_ restore tty pgrp on fatal signals */
4538 set_fatal_signals_to_sigexit();
4540 /* Put ourselves in our own process group. */
4541 bb_setpgrp(); /* is the same as setpgid(our_pid, our_pid); */
4542 /* Grab control of the terminal. */
4543 tcsetpgrp(G.interactive_fd, getpid());
4547 static int set_mode(const char cstate, const char mode)
4549 int state = (cstate == '-' ? 1 : 0);
4551 case 'n': G.fake_mode = state; break;
4552 case 'x': /*G.debug_mode = state;*/ break;
4553 default: return EXIT_FAILURE;
4555 return EXIT_SUCCESS;
4558 int hush_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4559 int hush_main(int argc, char **argv)
4561 static const struct variable const_shell_ver = {
4563 .varstr = (char*)hush_version_str,
4564 .max_len = 1, /* 0 can provoke free(name) */
4572 struct variable *cur_var;
4576 G.root_pid = getpid();
4578 /* Deal with HUSH_VERSION */
4579 G.shell_ver = const_shell_ver; /* copying struct here */
4580 G.top_var = &G.shell_ver;
4581 debug_printf_env("unsetenv '%s'\n", "HUSH_VERSION");
4582 unsetenv("HUSH_VERSION"); /* in case it exists in initial env */
4583 /* Initialize our shell local variables with the values
4584 * currently living in the environment */
4585 cur_var = G.top_var;
4588 char *value = strchr(*e, '=');
4589 if (value) { /* paranoia */
4590 cur_var->next = xzalloc(sizeof(*cur_var));
4591 cur_var = cur_var->next;
4592 cur_var->varstr = *e;
4593 cur_var->max_len = strlen(*e);
4594 cur_var->flg_export = 1;
4598 debug_printf_env("putenv '%s'\n", hush_version_str);
4599 putenv((char *)hush_version_str); /* reinstate HUSH_VERSION */
4601 #if ENABLE_FEATURE_EDITING
4602 G.line_input_state = new_line_input_t(FOR_SHELL);
4604 #if ENABLE_SH_MATH_SUPPORT
4605 G.hooks.lookupvar = lookup_param;
4606 G.hooks.setvar = arith_set_local_var;
4607 G.hooks.endofname = endofname;
4609 /* XXX what should these be while sourcing /etc/profile? */
4610 G.global_argc = argc;
4611 G.global_argv = argv;
4612 /* Initialize some more globals to non-zero values */
4614 #if ENABLE_HUSH_INTERACTIVE
4615 if (ENABLE_FEATURE_EDITING)
4616 cmdedit_set_initial_prompt();
4620 if (EXIT_SUCCESS) /* otherwise is already done */
4621 G.last_return_code = EXIT_SUCCESS;
4623 if (argv[0] && argv[0][0] == '-') {
4624 debug_printf("sourcing /etc/profile\n");
4625 input = fopen_for_read("/etc/profile");
4626 if (input != NULL) {
4627 close_on_exec_on(fileno(input));
4628 parse_and_run_file(input);
4634 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/sh.html */
4635 while ((opt = getopt(argc, argv, "c:xins")) > 0) {
4638 G.global_argv = argv + optind;
4639 if (!argv[optind]) {
4640 /* -c 'script' (no params): prevent empty $0 */
4641 *--G.global_argv = argv[0];
4643 } /* else -c 'script' PAR0 PAR1: $0 is PAR0 */
4644 G.global_argc = argc - optind;
4645 opt = parse_and_run_string(optarg, 0 /* parse_flag */);
4648 /* Well, we cannot just declare interactiveness,
4649 * we have to have some stuff (ctty, etc) */
4650 /* G.interactive_fd++; */
4653 /* "-s" means "read from stdin", but this is how we always
4654 * operate, so simply do nothing here. */
4658 if (!set_mode('-', opt))
4662 fprintf(stderr, "Usage: sh [FILE]...\n"
4663 " or: sh -c command [args]...\n\n");
4671 /* A shell is interactive if the '-i' flag was given, or if all of
4672 * the following conditions are met:
4674 * no arguments remaining or the -s flag given
4675 * standard input is a terminal
4676 * standard output is a terminal
4677 * Refer to Posix.2, the description of the 'sh' utility. */
4678 if (argv[optind] == NULL && input == stdin
4679 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
4681 G.saved_tty_pgrp = tcgetpgrp(STDIN_FILENO);
4682 debug_printf("saved_tty_pgrp=%d\n", G.saved_tty_pgrp);
4683 if (G.saved_tty_pgrp >= 0) {
4684 /* try to dup to high fd#, >= 255 */
4685 G.interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
4686 if (G.interactive_fd < 0) {
4687 /* try to dup to any fd */
4688 G.interactive_fd = dup(STDIN_FILENO);
4689 if (G.interactive_fd < 0)
4691 G.interactive_fd = 0;
4693 // TODO: track & disallow any attempts of user
4694 // to (inadvertently) close/redirect it
4697 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
4698 debug_printf("G.interactive_fd=%d\n", G.interactive_fd);
4699 if (G.interactive_fd) {
4700 fcntl(G.interactive_fd, F_SETFD, FD_CLOEXEC);
4701 /* Looks like they want an interactive shell */
4702 setup_job_control();
4703 /* -1 is special - makes xfuncs longjmp, not exit
4704 * (we reset die_sleep = 0 whereever we [v]fork) */
4706 if (setjmp(die_jmp)) {
4707 /* xfunc has failed! die die die */
4708 hush_exit(xfunc_error_retval);
4711 #elif ENABLE_HUSH_INTERACTIVE
4712 /* no job control compiled, only prompt/line editing */
4713 if (argv[optind] == NULL && input == stdin
4714 && isatty(STDIN_FILENO) && isatty(STDOUT_FILENO)
4716 G.interactive_fd = fcntl(STDIN_FILENO, F_DUPFD, 255);
4717 if (G.interactive_fd < 0) {
4718 /* try to dup to any fd */
4719 G.interactive_fd = dup(STDIN_FILENO);
4720 if (G.interactive_fd < 0)
4722 G.interactive_fd = 0;
4724 if (G.interactive_fd) {
4725 fcntl(G.interactive_fd, F_SETFD, FD_CLOEXEC);
4728 init_signal_mask(); /* note: ensures SIGCHLD is not masked */
4730 /* POSIX allows shell to re-enable SIGCHLD
4731 * even if it was SIG_IGN on entry */
4732 // G.count_SIGCHLD++; /* ensure it is != G.handled_SIGCHLD */
4733 signal(SIGCHLD, SIG_DFL); // SIGCHLD_handler);
4735 #if ENABLE_HUSH_INTERACTIVE && !ENABLE_FEATURE_SH_EXTRA_QUIET
4736 if (G.interactive_fd) {
4737 printf("\n\n%s hush - the humble shell v"HUSH_VER_STR"\n", bb_banner);
4738 printf("Enter 'help' for a list of built-in commands.\n\n");
4742 if (argv[optind] == NULL) {
4743 opt = parse_and_run_file(stdin);
4745 debug_printf("\nrunning script '%s'\n", argv[optind]);
4746 G.global_argv = argv + optind;
4747 G.global_argc = argc - optind;
4748 input = xfopen_for_read(argv[optind]);
4749 fcntl(fileno(input), F_SETFD, FD_CLOEXEC);
4750 opt = parse_and_run_file(input);
4755 #if ENABLE_FEATURE_CLEAN_UP
4757 if (G.cwd != bb_msg_unknown)
4759 cur_var = G.top_var->next;
4761 struct variable *tmp = cur_var;
4762 if (!cur_var->max_len)
4763 free(cur_var->varstr);
4764 cur_var = cur_var->next;
4768 hush_exit(opt ? opt : G.last_return_code);
4773 int lash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
4774 int lash_main(int argc, char **argv)
4776 //bb_error_msg("lash is deprecated, please use hush instead");
4777 return hush_main(argc, argv);
4785 static int builtin_trap(char **argv)
4792 G.traps = xzalloc(sizeof(G.traps[0]) * NSIG);
4795 /* No args: print all trapped. This isn't 100% correct as we should
4796 * be escaping the cmd so that it can be pasted back in ...
4798 for (i = 0; i < NSIG; ++i)
4800 printf("trap -- '%s' %s\n", G.traps[i], get_signame(i));
4801 return EXIT_SUCCESS;
4806 /* if first arg is decimal: reset all specified */
4807 sig = bb_strtou(*++argv, NULL, 10);
4813 sig = get_signum(*argv++);
4814 if (sig < 0 || sig >= NSIG) {
4816 /* mimic bash message exactly */
4817 bb_perror_msg("trap: %s: invalid signal specification", argv[i]);
4822 G.traps[sig] = xstrdup(new_cmd);
4824 debug_printf("trap: setting SIG%s (%i) to '%s'",
4825 get_signame(sig), sig, G.traps[sig]);
4827 /* There is no signal for 0 (EXIT) */
4832 sigaddset(&G.blocked_set, sig);
4834 /* there was a trap handler, we are removing it
4835 * (if sig has non-DFL handling,
4836 * we don't need to do anything) */
4837 if (sig < 32 && (G.non_DFL_mask & (1 << sig)))
4839 sigdelset(&G.blocked_set, sig);
4841 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
4846 /* first arg is "-": reset all specified to default */
4847 /* first arg is "": ignore all specified */
4848 /* everything else: execute first arg upon signal */
4850 bb_error_msg("trap: invalid arguments");
4851 return EXIT_FAILURE;
4853 if (LONE_DASH(*argv))
4861 static int builtin_true(char **argv UNUSED_PARAM)
4866 static int builtin_test(char **argv)
4873 return test_main(argc, argv - argc);
4876 static int builtin_echo(char **argv)
4883 return echo_main(argc, argv - argc);
4886 static int builtin_eval(char **argv)
4888 int rcode = EXIT_SUCCESS;
4891 char *str = expand_strvec_to_string(argv + 1);
4892 parse_and_run_string(str, PARSEFLAG_EXIT_FROM_LOOP);
4894 rcode = G.last_return_code;
4899 static int builtin_cd(char **argv)
4902 if (argv[1] == NULL) {
4903 // bash does nothing (exitcode 0) if HOME is ""; if it's unset,
4904 // bash says "bash: cd: HOME not set" and does nothing (exitcode 1)
4905 newdir = getenv("HOME") ? : "/";
4908 if (chdir(newdir)) {
4909 printf("cd: %s: %s\n", newdir, strerror(errno));
4910 return EXIT_FAILURE;
4913 return EXIT_SUCCESS;
4916 static int builtin_exec(char **argv)
4918 if (argv[1] == NULL)
4919 return EXIT_SUCCESS; /* bash does this */
4924 // FIXME: if exec fails, bash does NOT exit! We do...
4925 pseudo_exec_argv(&dummy, argv + 1, 0, NULL);
4930 static int builtin_exit(char **argv)
4932 // TODO: bash does it ONLY on top-level sh exit (+interacive only?)
4933 //puts("exit"); /* bash does it */
4934 // TODO: warn if we have background jobs: "There are stopped jobs"
4935 // On second consecutive 'exit', exit anyway.
4936 if (argv[1] == NULL)
4937 hush_exit(G.last_return_code);
4938 /* mimic bash: exit 123abc == exit 255 + error msg */
4939 xfunc_error_retval = 255;
4940 /* bash: exit -2 == exit 254, no error msg */
4941 hush_exit(xatoi(argv[1]) & 0xff);
4944 static int builtin_export(char **argv)
4947 char *name = argv[1];
4951 // ash emits: export VAR='VAL'
4952 // bash: declare -x VAR="VAL"
4953 // (both also escape as needed (quotes, $, etc))
4958 return EXIT_SUCCESS;
4961 value = strchr(name, '=');
4963 /* They are exporting something without a =VALUE */
4964 struct variable *var;
4966 var = get_local_var(name);
4968 var->flg_export = 1;
4969 debug_printf_env("%s: putenv '%s'\n", __func__, var->varstr);
4970 putenv(var->varstr);
4972 /* bash does not return an error when trying to export
4973 * an undefined variable. Do likewise. */
4974 return EXIT_SUCCESS;
4977 set_local_var(xstrdup(name), 1);
4978 return EXIT_SUCCESS;
4982 /* built-in 'fg' and 'bg' handler */
4983 static int builtin_fg_bg(char **argv)
4988 if (!G.interactive_fd)
4989 return EXIT_FAILURE;
4990 /* If they gave us no args, assume they want the last backgrounded task */
4992 for (pi = G.job_list; pi; pi = pi->next) {
4993 if (pi->jobid == G.last_jobid) {
4997 bb_error_msg("%s: no current job", argv[0]);
4998 return EXIT_FAILURE;
5000 if (sscanf(argv[1], "%%%d", &jobnum) != 1) {
5001 bb_error_msg("%s: bad argument '%s'", argv[0], argv[1]);
5002 return EXIT_FAILURE;
5004 for (pi = G.job_list; pi; pi = pi->next) {
5005 if (pi->jobid == jobnum) {
5009 bb_error_msg("%s: %d: no such job", argv[0], jobnum);
5010 return EXIT_FAILURE;
5012 // TODO: bash prints a string representation
5013 // of job being foregrounded (like "sleep 1 | cat")
5014 if (*argv[0] == 'f') {
5015 /* Put the job into the foreground. */
5016 tcsetpgrp(G.interactive_fd, pi->pgrp);
5019 /* Restart the processes in the job */
5020 debug_printf_jobs("reviving %d procs, pgrp %d\n", pi->num_cmds, pi->pgrp);
5021 for (i = 0; i < pi->num_cmds; i++) {
5022 debug_printf_jobs("reviving pid %d\n", pi->cmds[i].pid);
5023 pi->cmds[i].is_stopped = 0;
5025 pi->stopped_cmds = 0;
5027 i = kill(- pi->pgrp, SIGCONT);
5029 if (errno == ESRCH) {
5030 delete_finished_bg_job(pi);
5031 return EXIT_SUCCESS;
5033 bb_perror_msg("kill (SIGCONT)");
5037 if (*argv[0] == 'f') {
5039 return checkjobs_and_fg_shell(pi);
5041 return EXIT_SUCCESS;
5045 #if ENABLE_HUSH_HELP
5046 static int builtin_help(char **argv UNUSED_PARAM)
5048 const struct built_in_command *x;
5050 printf("\nBuilt-in commands:\n");
5051 printf("-------------------\n");
5052 for (x = bltins; x != &bltins[ARRAY_SIZE(bltins)]; x++) {
5053 printf("%s\t%s\n", x->cmd, x->descr);
5056 return EXIT_SUCCESS;
5061 static int builtin_jobs(char **argv UNUSED_PARAM)
5064 const char *status_string;
5066 for (job = G.job_list; job; job = job->next) {
5067 if (job->alive_cmds == job->stopped_cmds)
5068 status_string = "Stopped";
5070 status_string = "Running";
5072 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->cmdtext);
5074 return EXIT_SUCCESS;
5078 static int builtin_pwd(char **argv UNUSED_PARAM)
5081 return EXIT_SUCCESS;
5084 static int builtin_read(char **argv)
5087 const char *name = argv[1] ? argv[1] : "REPLY";
5089 string = xmalloc_reads(STDIN_FILENO, xasprintf("%s=", name), NULL);
5090 return set_local_var(string, 0);
5093 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#set
5094 * built-in 'set' handler
5096 * set [-abCefhmnuvx] [-o option] [argument...]
5097 * set [+abCefhmnuvx] [+o option] [argument...]
5098 * set -- [argument...]
5101 * Implementations shall support the options in both their hyphen and
5102 * plus-sign forms. These options can also be specified as options to sh.
5104 * Write out all variables and their values: set
5105 * Set $1, $2, and $3 and set "$#" to 3: set c a b
5106 * Turn on the -x and -v options: set -xv
5107 * Unset all positional parameters: set --
5108 * Set $1 to the value of x, even if it begins with '-' or '+': set -- "$x"
5109 * Set the positional parameters to the expansion of x, even if x expands
5110 * with a leading '-' or '+': set -- $x
5112 * So far, we only support "set -- [argument...]" and some of the short names.
5114 static int builtin_set(char **argv)
5117 char **pp, **g_argv;
5118 char *arg = *++argv;
5122 for (e = G.top_var; e; e = e->next)
5124 return EXIT_SUCCESS;
5128 if (!strcmp(arg, "--")) {
5133 if (arg[0] == '+' || arg[0] == '-') {
5134 for (n = 1; arg[n]; ++n)
5135 if (set_mode(arg[0], arg[n]))
5141 } while ((arg = *++argv) != NULL);
5142 /* Now argv[0] is 1st argument */
5144 /* Only reset global_argv if we didn't process anything */
5146 return EXIT_SUCCESS;
5149 /* NB: G.global_argv[0] ($0) is never freed/changed */
5150 g_argv = G.global_argv;
5151 if (G.global_args_malloced) {
5157 G.global_args_malloced = 1;
5158 pp = xzalloc(sizeof(pp[0]) * 2);
5159 pp[0] = g_argv[0]; /* retain $0 */
5162 /* This realloc's G.global_argv */
5163 G.global_argv = pp = add_strings_to_strings(g_argv, argv, /*dup:*/ 1);
5170 return EXIT_SUCCESS;
5172 /* Nothing known, so abort */
5174 bb_error_msg("set: %s: invalid option", arg);
5175 return EXIT_FAILURE;
5178 static int builtin_shift(char **argv)
5184 if (n >= 0 && n < G.global_argc) {
5185 if (G.global_args_malloced) {
5188 free(G.global_argv[m++]);
5191 memmove(&G.global_argv[1], &G.global_argv[n+1],
5192 G.global_argc * sizeof(G.global_argv[0]));
5193 return EXIT_SUCCESS;
5195 return EXIT_FAILURE;
5198 static int builtin_source(char **argv)
5203 if (argv[1] == NULL)
5204 return EXIT_FAILURE;
5206 /* XXX search through $PATH is missing */
5207 input = fopen_for_read(argv[1]);
5209 bb_error_msg("can't open '%s'", argv[1]);
5210 return EXIT_FAILURE;
5212 close_on_exec_on(fileno(input));
5214 /* Now run the file */
5215 /* XXX argv and argc are broken; need to save old G.global_argv
5216 * (pointer only is OK!) on this stack frame,
5217 * set G.global_argv=argv+1, recurse, and restore. */
5218 status = parse_and_run_file(input);
5223 static int builtin_umask(char **argv)
5226 const char *arg = argv[1];
5228 new_umask = bb_strtou(arg, NULL, 8);
5230 return EXIT_FAILURE;
5232 new_umask = umask(0);
5233 printf("%.3o\n", (unsigned) new_umask);
5236 return EXIT_SUCCESS;
5239 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#unset */
5240 static int builtin_unset(char **argv)
5247 return EXIT_SUCCESS;
5250 if (argv[1][0] == '-') {
5251 switch (argv[1][1]) {
5253 case 'f': if (ENABLE_HUSH_FUNCTIONS) { var = false; break; }
5255 bb_error_msg("unset: %s: invalid option", argv[1]);
5256 return EXIT_FAILURE;
5264 if (unset_local_var(argv[i]))
5267 #if ENABLE_HUSH_FUNCTIONS
5269 unset_local_func(argv[i]);
5275 /* http://www.opengroup.org/onlinepubs/9699919799/utilities/wait.html */
5276 static int builtin_wait(char **argv)
5278 int ret = EXIT_SUCCESS;
5281 if (*++argv == NULL) {
5282 /* Don't care about wait results */
5283 /* Note 1: must wait until there are no more children */
5284 /* Note 2: must be interruptible */
5286 * $ sleep 3 & sleep 6 & wait
5291 * $ sleep 3 & sleep 6 & wait
5295 * ^C <-- after ~4 sec from keyboard
5298 sigaddset(&G.blocked_set, SIGCHLD);
5299 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5302 if (errno == ECHILD)
5304 /* Wait for SIGCHLD or any other signal of interest */
5305 /* sigtimedwait with infinite timeout: */
5306 sig = sigwaitinfo(&G.blocked_set, NULL);
5308 sig = check_and_run_traps(sig);
5309 if (sig && sig != SIGCHLD) { /* see note 2 */
5315 sigdelset(&G.blocked_set, SIGCHLD);
5316 sigprocmask(SIG_SETMASK, &G.blocked_set, NULL);
5320 /* This is probably buggy wrt interruptible-ness */
5322 pid_t pid = bb_strtou(*argv, NULL, 10);
5324 /* mimic bash message */
5325 bb_error_msg("wait: '%s': not a pid or valid job spec", *argv);
5326 return EXIT_FAILURE;
5328 if (waitpid(pid, &status, 0) == pid) {
5329 if (WIFSIGNALED(status))
5330 ret = 128 + WTERMSIG(status);
5331 else if (WIFEXITED(status))
5332 ret = WEXITSTATUS(status);
5336 bb_perror_msg("wait %s", *argv);
5345 #if ENABLE_HUSH_LOOPS
5346 static int builtin_break(char **argv)
5348 if (G.depth_of_loop == 0) {
5349 bb_error_msg("%s: only meaningful in a loop", argv[0]);
5350 return EXIT_SUCCESS; /* bash compat */
5352 G.flag_break_continue++; /* BC_BREAK = 1 */
5353 G.depth_break_continue = 1;
5355 G.depth_break_continue = bb_strtou(argv[1], NULL, 10);
5356 if (errno || !G.depth_break_continue || argv[2]) {
5357 bb_error_msg("%s: bad arguments", argv[0]);
5358 G.flag_break_continue = BC_BREAK;
5359 G.depth_break_continue = UINT_MAX;
5362 if (G.depth_of_loop < G.depth_break_continue)
5363 G.depth_break_continue = G.depth_of_loop;
5364 return EXIT_SUCCESS;
5367 static int builtin_continue(char **argv)
5369 G.flag_break_continue = 1; /* BC_CONTINUE = 2 = 1+1 */
5370 return builtin_break(argv);