1 /* vi: set sw=4 ts=4: */
3 * sh.c -- 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.
13 * The execution engine, the builtins, and much of the underlying
14 * support has been adapted from busybox-0.49pre's lash,
15 * which is Copyright (C) 2000 by Lineo, Inc., and
16 * written by Erik Andersen <andersen@lineo.com>, <andersee@debian.org>.
17 * That, in turn, is based in part on ladsh.c, by Michael K. Johnson and
18 * Erik W. Troan, which they placed in the public domain. I don't know
19 * how much of the Johnson/Troan code has survived the repeated rewrites.
21 * simple_itoa() was lifted from boa-0.93.15
22 * b_addchr() derived from similar w_addchar function in glibc-2.2
23 * setup_redirect(), redirect_opt_num(), and big chunks of main()
24 * and many builtins derived from contributions by Erik Andersen
25 * miscellaneous bugfixes from Matt Kraai
27 * There are two big (and related) architecture differences between
28 * this parser and the lash parser. One is that this version is
29 * actually designed from the ground up to understand nearly all
30 * of the Bourne grammar. The second, consequential change is that
31 * the parser and input reader have been turned inside out. Now,
32 * the parser is in control, and asks for input as needed. The old
33 * way had the input reader in control, and it asked for parsing to
34 * take place as needed. The new way makes it much easier to properly
35 * handle the recursion implicit in the various substitutions, especially
36 * across continuation lines.
38 * Bash grammar not implemented: (how many of these were in original sh?)
39 * $@ (those sure look like weird quoting rules)
41 * ! negation operator for pipes
42 * &> and >& redirection of stdout+stderr
45 * fancy forms of Parameter Expansion
46 * Arithmetic Expansion
47 * <(list) and >(list) Process Substitution
48 * reserved words: case, esac, select, function
49 * Here Documents ( << word )
52 * job handling woefully incomplete and buggy
53 * reserved word execution woefully incomplete and buggy
55 * port selected bugfixes from post-0.49 busybox lash - done?
56 * finish implementing reserved words: for, while, until, do, done
57 * change { and } from special chars to reserved words
58 * builtins: break, continue, eval, return, set, trap, ulimit
60 * handle children going into background
61 * clean up recognition of null pipes
62 * have builtin_exec set flag to avoid restore_redirects
63 * check setting of global_argc and global_argv
64 * control-C handling, probably with longjmp
65 * VAR=value prefix for simple commands
66 * follow IFS rules more precisely, including update semantics
67 * figure out what to do with backslash-newline
68 * explain why we use signal instead of sigaction
69 * propagate syntax errors, die on resource errors?
70 * continuation lines, both explicit and implicit - done?
71 * memory leak finding and plugging - done?
72 * more testing, especially quoting rules and redirection
73 * maybe change map[] to use 2-bit entries
74 * (eventually) remove all the printf's
76 * This program is free software; you can redistribute it and/or modify
77 * it under the terms of the GNU General Public License as published by
78 * the Free Software Foundation; either version 2 of the License, or
79 * (at your option) any later version.
81 * This program is distributed in the hope that it will be useful,
82 * but WITHOUT ANY WARRANTY; without even the implied warranty of
83 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
84 * General Public License for more details.
86 * You should have received a copy of the GNU General Public License
87 * along with this program; if not, write to the Free Software
88 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
90 #include <ctype.h> /* isalpha, isdigit */
91 #include <unistd.h> /* getpid */
92 #include <stdlib.h> /* getenv, atoi */
93 #include <string.h> /* strchr */
94 #include <stdio.h> /* popen etc. */
95 #include <glob.h> /* glob, of course */
96 #include <stdarg.h> /* va_list */
99 #include <getopt.h> /* should be pretty obvious */
101 #include <sys/stat.h> /* ulimit */
102 #include <sys/types.h>
103 #include <sys/wait.h>
106 /* #include <dmalloc.h> */
107 /* #define DEBUG_SHELL */
113 #define applet_name "hush"
114 #include "standalone.h"
115 #define shell_main main
116 #define BB_FEATURE_SH_SIMPLE_PROMPT
121 REDIRECT_OVERWRITE = 2,
127 /* The descrip member of this structure is only used to make debugging
129 struct {int mode; int default_fd; char *descrip;} redir_table[] = {
131 { O_RDONLY, 0, "<" },
132 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
133 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
134 { O_RDONLY, -1, "<<" },
145 /* might eventually control execution */
161 #define FLAG_END (1<<RES_NONE)
162 #define FLAG_IF (1<<RES_IF)
163 #define FLAG_THEN (1<<RES_THEN)
164 #define FLAG_ELIF (1<<RES_ELIF)
165 #define FLAG_ELSE (1<<RES_ELSE)
166 #define FLAG_FI (1<<RES_FI)
167 #define FLAG_FOR (1<<RES_FOR)
168 #define FLAG_WHILE (1<<RES_WHILE)
169 #define FLAG_UNTIL (1<<RES_UNTIL)
170 #define FLAG_DO (1<<RES_DO)
171 #define FLAG_DONE (1<<RES_DONE)
172 #define FLAG_START (1<<RES_XXXX)
174 /* This holds pointers to the various results of parsing */
176 struct child_prog *child;
177 struct pipe *list_head;
179 struct redir_struct *pending_redirect;
181 int old_flag; /* for figuring out valid reserved words */
182 struct p_context *stack;
183 /* How about quoting status? */
186 struct redir_struct {
187 redir_type type; /* type of redirection */
188 int fd; /* file descriptor being redirected */
189 int dup; /* -1, or file descriptor being duplicated */
190 struct redir_struct *next; /* pointer to the next redirect in the list */
191 glob_t word; /* *word.gl_pathv is the filename */
195 pid_t pid; /* 0 if exited */
196 char **argv; /* program name and arguments */
197 struct pipe *group; /* if non-NULL, first in group or subshell */
198 int subshell; /* flag, non-zero if group must be forked */
199 struct redir_struct *redirects; /* I/O redirections */
200 glob_t glob_result; /* result of parameter globbing */
201 int is_stopped; /* is the program currently running? */
202 struct pipe *family; /* pointer back to the child's parent pipe */
206 int jobid; /* job number */
207 int num_progs; /* total number of programs in job */
208 int running_progs; /* number of programs running */
209 char *text; /* name of job */
210 char *cmdbuf; /* buffer various argv's point into */
211 pid_t pgrp; /* process group ID for the job */
212 struct child_prog *progs; /* array of commands in pipe */
213 struct pipe *next; /* to track background commands */
214 int stopped_progs; /* number of programs alive, but stopped */
215 int job_context; /* bitmask defining current context */
216 pipe_style followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
217 reserved_style r_mode; /* supports if, for, while, until */
221 struct pipe *head; /* head of list of running jobs */
222 struct pipe *fg; /* current foreground job */
227 struct close_me *next;
230 /* globals, connect us to the outside world
231 * the first three support $?, $#, and $1 */
233 unsigned int global_argc;
234 unsigned int last_return_code;
235 extern char **environ; /* This is in <unistd.h>, but protected with __USE_GNU */
237 /* Variables we export */
238 unsigned int shell_context; /* Used in cmdedit.c to reset the
239 * context when someone hits ^C */
241 /* "globals" within this file */
242 static char *ifs=NULL;
243 static char map[256];
244 static int fake_mode=0;
245 static int interactive=0;
246 static struct close_me *close_me_head = NULL;
248 static struct jobset *job_list;
249 static unsigned int last_bg_pid=0;
251 static char *PS2 = "> ";
253 #define B_CHUNK (100)
255 #define MAX_LINE 256 /* for cwd */
256 #define MAX_READ 256 /* for builtin_read */
265 #define NULL_O_STRING {NULL,0,0,0,0}
266 /* used for initialization:
267 o_string foo = NULL_O_STRING; */
269 /* I can almost use ordinary FILE *. Is open_memstream() universally
270 * available? Where is it documented? */
276 int (*get) (struct in_str *);
277 int (*peek) (struct in_str *);
279 #define b_getch(input) ((input)->get(input))
280 #define b_peek(input) ((input)->peek(input))
282 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
284 struct built_in_command {
285 char *cmd; /* name */
286 char *descr; /* description */
287 int (*function) (struct child_prog *); /* function ptr */
290 /* belongs in busybox.h */
291 static inline int max(int a, int b) {
295 /* This should be in utility.c */
297 static void debug_printf(const char *format, ...)
300 va_start(args, format);
301 vfprintf(stderr, format, args);
305 static void debug_printf(const char *format, ...) { }
307 #define final_printf debug_printf
309 void __syntax(char *file, int line) {
310 fprintf(stderr,"syntax error %s:%d\n",file,line);
312 #define syntax() __syntax(__FILE__, __LINE__)
314 /* Index of subroutines: */
315 /* function prototypes for builtins */
316 static int builtin_cd(struct child_prog *child);
317 static int builtin_env(struct child_prog *child);
318 static int builtin_exec(struct child_prog *child);
319 static int builtin_exit(struct child_prog *child);
320 static int builtin_export(struct child_prog *child);
321 static int builtin_fg_bg(struct child_prog *child);
322 static int builtin_help(struct child_prog *child);
323 static int builtin_jobs(struct child_prog *child);
324 static int builtin_pwd(struct child_prog *child);
325 static int builtin_read(struct child_prog *child);
326 static int builtin_shift(struct child_prog *child);
327 static int builtin_source(struct child_prog *child);
328 static int builtin_umask(struct child_prog *child);
329 static int builtin_unset(struct child_prog *child);
330 static int builtin_not_written(struct child_prog *child);
331 /* o_string manipulation: */
332 static int b_check_space(o_string *o, int len);
333 static int b_addchr(o_string *o, int ch);
334 static void b_reset(o_string *o);
335 static int b_addqchr(o_string *o, int ch, int quote);
336 static int b_adduint(o_string *o, unsigned int i);
337 /* in_str manipulations: */
338 static int static_get(struct in_str *i);
339 static int static_peek(struct in_str *i);
340 static int file_get(struct in_str *i);
341 static int file_peek(struct in_str *i);
342 static void setup_file_in_str(struct in_str *i, FILE *f);
343 static void setup_string_in_str(struct in_str *i, const char *s);
344 /* close_me manipulations: */
345 static void mark_open(int fd);
346 static void mark_closed(int fd);
347 static void close_all();
348 /* "run" the final data structures: */
349 static char *indenter(int i);
350 static int run_list_test(struct pipe *head, int indent);
351 static int run_pipe_test(struct pipe *pi, int indent);
352 /* really run the final data structures: */
353 static int setup_redirects(struct child_prog *prog, int squirrel[]);
354 static int pipe_wait(struct pipe *pi);
355 static int run_list_real(struct pipe *pi);
356 static void pseudo_exec(struct child_prog *child) __attribute__ ((noreturn));
357 static int run_pipe_real(struct pipe *pi);
358 /* extended glob support: */
359 static int globhack(const char *src, int flags, glob_t *pglob);
360 static int glob_needed(const char *s);
361 static int xglob(o_string *dest, int flags, glob_t *pglob);
362 /* data structure manipulation: */
363 static int setup_redirect(struct p_context *ctx, int fd, redir_type style, struct in_str *input);
364 static void initialize_context(struct p_context *ctx);
365 static int done_word(o_string *dest, struct p_context *ctx);
366 static int done_command(struct p_context *ctx);
367 static int done_pipe(struct p_context *ctx, pipe_style type);
368 /* primary string parsing: */
369 static int redirect_dup_num(struct in_str *input);
370 static int redirect_opt_num(o_string *o);
371 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end);
372 static int parse_group(o_string *dest, struct p_context *ctx, struct in_str *input, int ch);
373 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src);
374 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input);
375 static int parse_string(o_string *dest, struct p_context *ctx, const char *src);
376 static int parse_stream(o_string *dest, struct p_context *ctx, struct in_str *input0, int end_trigger);
378 static int parse_stream_outer(struct in_str *inp);
379 static int parse_string_outer(const char *s);
380 static int parse_file_outer(FILE *f);
381 /* job management: */
382 static void checkjobs();
383 static void insert_bg_job(struct pipe *pi);
384 static void remove_bg_job(struct pipe *pi);
385 static void free_pipe(struct pipe *pi);
387 /* Table of built-in functions. They can be forked or not, depending on
388 * context: within pipes, they fork. As simple commands, they do not.
389 * When used in non-forking context, they can change global variables
390 * in the parent shell process. If forked, of course they can not.
391 * For example, 'unset foo | whatever' will parse and run, but foo will
392 * still be set at the end. */
393 static struct built_in_command bltins[] = {
394 {"bg", "Resume a job in the background", builtin_fg_bg},
395 {"break", "Exit for, while or until loop", builtin_not_written},
396 {"cd", "Change working directory", builtin_cd},
397 {"continue", "Continue for, while or until loop", builtin_not_written},
398 {"env", "Print all environment variables", builtin_env},
399 {"eval", "Construct and run shell command", builtin_not_written},
400 {"exec", "Exec command, replacing this shell with the exec'd process", builtin_exec},
401 {"exit", "Exit from shell()", builtin_exit},
402 {"export", "Set environment variable", builtin_export},
403 {"fg", "Bring job into the foreground", builtin_fg_bg},
404 {"jobs", "Lists the active jobs", builtin_jobs},
405 {"pwd", "Print current directory", builtin_pwd},
406 {"read", "Input environment variable", builtin_read},
407 {"return", "Return from a function", builtin_not_written},
408 {"set", "Set/unset shell options", builtin_not_written},
409 {"shift", "Shift positional parameters", builtin_shift},
410 {"trap", "Trap signals", builtin_not_written},
411 {"ulimit","Controls resource limits", builtin_not_written},
412 {"umask","Sets file creation mask", builtin_umask},
413 {"unset", "Unset environment variable", builtin_unset},
414 {".", "Source-in and run commands in a file", builtin_source},
415 {"help", "List shell built-in commands", builtin_help},
419 /* built-in 'cd <path>' handler */
420 static int builtin_cd(struct child_prog *child)
423 if (child->argv[1] == NULL)
424 newdir = getenv("HOME");
426 newdir = child->argv[1];
428 printf("cd: %s: %s\n", newdir, strerror(errno));
431 getcwd(cwd, sizeof(char)*MAX_LINE);
435 /* built-in 'env' handler */
436 static int builtin_env(struct child_prog *dummy)
439 if (e == NULL) return EXIT_FAILURE;
446 /* built-in 'exec' handler */
447 static int builtin_exec(struct child_prog *child)
449 if (child->argv[1] == NULL)
450 return EXIT_SUCCESS; /* Really? */
456 /* built-in 'exit' handler */
457 static int builtin_exit(struct child_prog *child)
459 if (child->argv[1] == NULL)
460 exit(last_return_code);
461 exit (atoi(child->argv[1]));
464 /* built-in 'export VAR=value' handler */
465 static int builtin_export(struct child_prog *child)
469 if (child->argv[1] == NULL) {
470 return (builtin_env(child));
472 /* FIXME -- I leak memory. This will be
473 * fixed up properly when we add local
474 * variable support -- I hope */
475 res = putenv(strdup(child->argv[1]));
477 fprintf(stderr, "export: %s\n", strerror(errno));
481 /* built-in 'fg' and 'bg' handler */
482 static int builtin_fg_bg(struct child_prog *child)
485 struct pipe *pi=NULL;
487 /* If they gave us no args, assume they want the last backgrounded task */
488 if (!child->argv[1]) {
489 for (pi = job_list->head; pi; pi = pi->next) {
490 if (pi->progs && pi->progs->pid == last_bg_pid) {
495 error_msg("%s: no current job", child->argv[0]);
499 if (sscanf(child->argv[1], "%%%d", &jobnum) != 1) {
500 error_msg("%s: bad argument '%s'", child->argv[0], child->argv[1]);
504 for (pi = job_list->head; pi; pi = pi->next) {
505 if (pi->jobid == jobnum) {
510 error_msg("%s: %d: no such job", child->argv[0], jobnum);
514 if (*child->argv[0] == 'f') {
515 /* Make this job the foreground job */
516 signal(SIGTTOU, SIG_IGN);
517 /* suppress messages when run from /linuxrc mag@sysgo.de */
518 if (tcsetpgrp(0, pi->pgrp) && errno != ENOTTY)
519 perror_msg("tcsetpgrp");
520 signal(SIGTTOU, SIG_DFL);
524 /* Restart the processes in the job */
525 for (i = 0; i < pi->num_progs; i++)
526 pi->progs[i].is_stopped = 0;
528 kill(-pi->pgrp, SIGCONT);
530 pi->stopped_progs = 0;
534 /* built-in 'help' handler */
535 static int builtin_help(struct child_prog *dummy)
537 struct built_in_command *x;
539 printf("\nBuilt-in commands:\n");
540 printf("-------------------\n");
541 for (x = bltins; x->cmd; x++) {
544 printf("%s\t%s\n", x->cmd, x->descr);
550 /* built-in 'jobs' handler */
551 static int builtin_jobs(struct child_prog *child)
556 for (job = job_list->head; job; job = job->next) {
557 if (job->running_progs == job->stopped_progs)
558 status_string = "Stopped";
560 status_string = "Running";
561 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->text);
567 /* built-in 'pwd' handler */
568 static int builtin_pwd(struct child_prog *dummy)
570 getcwd(cwd, MAX_LINE);
575 /* built-in 'read VAR' handler */
576 static int builtin_read(struct child_prog *child)
578 int res = 0, len, newlen;
580 char string[MAX_READ];
582 if (child->argv[1]) {
583 /* argument (VAR) given: put "VAR=" into buffer */
584 strcpy(string, child->argv[1]);
585 len = strlen(string);
588 /* XXX would it be better to go through in_str? */
589 fgets(&string[len], sizeof(string) - len, stdin); /* read string */
590 newlen = strlen(string);
592 string[--newlen] = '\0'; /* chomp trailing newline */
594 ** string should now contain "VAR=<value>"
595 ** copy it (putenv() won't do that, so we must make sure
596 ** the string resides in a static buffer!)
599 if((s = strdup(string)))
602 fprintf(stderr, "read: %s\n", strerror(errno));
605 fgets(string, sizeof(string), stdin);
610 /* Built-in 'shift' handler */
611 static int builtin_shift(struct child_prog *child)
614 if (child->argv[1]) {
615 n=atoi(child->argv[1]);
617 if (n>=0 && n<global_argc) {
618 /* XXX This probably breaks $0 */
627 /* Built-in '.' handler (read-in and execute commands from file) */
628 static int builtin_source(struct child_prog *child)
633 if (child->argv[1] == NULL)
636 /* XXX search through $PATH is missing */
637 input = fopen(child->argv[1], "r");
639 fprintf(stderr, "Couldn't open file '%s'\n", child->argv[1]);
643 /* Now run the file */
644 /* XXX argv and argc are broken; need to save old global_argv
645 * (pointer only is OK!) on this stack frame,
646 * set global_argv=child->argv+1, recurse, and restore. */
647 mark_open(fileno(input));
648 status = parse_file_outer(input);
649 mark_closed(fileno(input));
654 static int builtin_umask(struct child_prog *child)
657 const char *arg = child->argv[1];
660 new_umask=strtoul(arg, &end, 8);
661 if (*end!='\0' || end == arg) {
665 printf("%.3o\n", (unsigned int) (new_umask=umask(0)));
671 /* built-in 'unset VAR' handler */
672 static int builtin_unset(struct child_prog *child)
674 if (child->argv[1] == NULL) {
675 fprintf(stderr, "unset: parameter required.\n");
678 unsetenv(child->argv[1]);
682 static int builtin_not_written(struct child_prog *child)
684 printf("builtin_%s not written\n",child->argv[0]);
688 static int b_check_space(o_string *o, int len)
690 /* It would be easy to drop a more restrictive policy
691 * in here, such as setting a maximum string length */
692 if (o->length + len > o->maxlen) {
693 char *old_data = o->data;
694 /* assert (data == NULL || o->maxlen != 0); */
695 o->maxlen += max(2*len, B_CHUNK);
696 o->data = realloc(o->data, 1 + o->maxlen);
697 if (o->data == NULL) {
701 return o->data == NULL;
704 static int b_addchr(o_string *o, int ch)
706 debug_printf("b_addchr: %c %d %p\n", ch, o->length, o);
707 if (b_check_space(o, 1)) return B_NOSPAC;
708 o->data[o->length] = ch;
710 o->data[o->length] = '\0';
714 static void b_reset(o_string *o)
718 if (o->data != NULL) *o->data = '\0';
721 static void b_free(o_string *o)
724 if (o->data != NULL) free(o->data);
729 /* My analysis of quoting semantics tells me that state information
730 * is associated with a destination, not a source.
732 static int b_addqchr(o_string *o, int ch, int quote)
734 if (quote && strchr("*?[\\",ch)) {
736 rc = b_addchr(o, '\\');
739 return b_addchr(o, ch);
742 /* belongs in utility.c */
743 char *simple_itoa(unsigned int i)
745 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
746 static char local[22];
747 char *p = &local[21];
756 static int b_adduint(o_string *o, unsigned int i)
759 char *p = simple_itoa(i);
760 /* no escape checking necessary */
761 do r=b_addchr(o, *p++); while (r==0 && *p);
765 static int static_get(struct in_str *i)
768 if (ch=='\0') return EOF;
772 static int static_peek(struct in_str *i)
777 static inline void cmdedit_set_initial_prompt(void)
779 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
788 static inline void setup_prompt_string(int promptmode, char **prompt_str)
790 debug_printf("setup_prompt_string %d ",promptmode);
791 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
792 /* Set up the prompt */
793 if (promptmode == 1) {
796 PS1=xmalloc(strlen(cwd)+4);
797 sprintf(PS1, "%s %s", cwd, ( geteuid() != 0 ) ? "$ ":"# ");
803 *prompt_str = (promptmode==0)? PS1 : PS2;
805 debug_printf("result %s\n",*prompt_str);
808 static void get_user_input(struct in_str *i)
811 static char the_command[BUFSIZ];
813 setup_prompt_string(i->promptmode, &prompt_str);
814 #ifdef BB_FEATURE_COMMAND_EDITING
816 ** enable command line editing only while a command line
817 ** is actually being read; otherwise, we'll end up bequeathing
818 ** atexit() handlers and other unwanted stuff to our
819 ** child processes (rob@sysgo.de)
821 cmdedit_read_input(prompt_str, the_command);
824 fputs(prompt_str, stdout);
826 the_command[0]=fgetc(i->file);
832 /* This is the magic location that prints prompts
833 * and gets data back from the user */
834 static int file_get(struct in_str *i)
839 /* If there is data waiting, eat it up */
843 /* need to double check i->file because we might be doing something
844 * more complicated by now, like sourcing or substituting. */
845 if (i->__promptme && interactive && i->file == stdin) {
856 debug_printf("b_getch: got a %d\n", ch);
858 if (ch == '\n') i->__promptme=1;
862 /* All the callers guarantee this routine will never be
863 * used right after a newline, so prompting is not needed.
865 static int file_peek(struct in_str *i)
870 static char buffer[2];
871 buffer[0] = fgetc(i->file);
874 debug_printf("b_peek: got a %d\n", *i->p);
879 static void setup_file_in_str(struct in_str *i, FILE *f)
889 static void setup_string_in_str(struct in_str *i, const char *s)
891 i->peek = static_peek;
898 static void mark_open(int fd)
900 struct close_me *new = xmalloc(sizeof(struct close_me));
902 new->next = close_me_head;
906 static void mark_closed(int fd)
908 struct close_me *tmp;
909 if (close_me_head == NULL || close_me_head->fd != fd)
910 error_msg_and_die("corrupt close_me");
912 close_me_head = close_me_head->next;
916 static void close_all()
919 for (c=close_me_head; c; c=c->next) {
922 close_me_head = NULL;
925 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
926 * and stderr if they are redirected. */
927 static int setup_redirects(struct child_prog *prog, int squirrel[])
930 struct redir_struct *redir;
932 for (redir=prog->redirects; redir; redir=redir->next) {
933 if (redir->dup == -1) {
934 mode=redir_table[redir->type].mode;
935 openfd = open(redir->word.gl_pathv[0], mode, 0666);
937 /* this could get lost if stderr has been redirected, but
938 bash and ash both lose it as well (though zsh doesn't!) */
939 fprintf(stderr,"error opening %s: %s\n", redir->word.gl_pathv[0],
947 if (openfd != redir->fd) {
948 if (squirrel && redir->fd < 3) {
949 squirrel[redir->fd] = dup(redir->fd);
954 dup2(openfd, redir->fd);
962 static void restore_redirects(int squirrel[])
965 for (i=0; i<3; i++) {
968 /* No error checking. I sure wouldn't know what
969 * to do with an error if I found one! */
976 /* XXX this definitely needs some more thought, work, and
977 * cribbing from other shells */
978 static int pipe_wait(struct pipe *pi)
980 int rcode=0, i, pid, running, status;
981 running = pi->num_progs;
983 pid=waitpid(-1, &status, 0);
984 if (pid < 0) perror_msg_and_die("waitpid");
985 for (i=0; i < pi->num_progs; i++) {
986 if (pi->progs[i].pid == pid) {
987 if (i==pi->num_progs-1) rcode=WEXITSTATUS(status);
988 pi->progs[i].pid = 0;
997 /* very simple version for testing */
998 static void pseudo_exec(struct child_prog *child)
1001 struct built_in_command *x;
1004 * Check if the command matches any of the builtins.
1005 * Depending on context, this might be redundant. But it's
1006 * easier to waste a few CPU cycles than it is to figure out
1007 * if this is one of those cases.
1009 for (x = bltins; x->cmd; x++) {
1010 if (strcmp(child->argv[0], x->cmd) == 0 ) {
1011 debug_printf("builtin exec %s\n", child->argv[0]);
1012 exit(x->function(child));
1016 /* Check if the command matches any busybox internal commands
1018 * FIXME: This feature is not 100% safe, since
1019 * BusyBox is not fully reentrant, so we have no guarantee the things
1020 * from the .bss are still zeroed, or that things from .data are still
1021 * at their defaults. We could exec ourself from /proc/self/exe, but I
1022 * really dislike relying on /proc for things. We could exec ourself
1023 * from global_argv[0], but if we are in a chroot, we may not be able
1024 * to find ourself... */
1025 #ifdef BB_FEATURE_SH_STANDALONE_SHELL
1028 char** argv_l=child->argv;
1029 char *name = child->argv[0];
1031 #ifdef BB_FEATURE_SH_APPLETS_ALWAYS_WIN
1032 /* Following discussions from November 2000 on the busybox mailing
1033 * list, the default configuration, (without
1034 * get_last_path_component()) lets the user force use of an
1035 * external command by specifying the full (with slashes) filename.
1036 * If you enable BB_FEATURE_SH_APPLETS_ALWAYS_WIN, then applets
1037 * _aways_ override external commands, so if you want to run
1038 * /bin/cat, it will use BusyBox cat even if /bin/cat exists on the
1039 * filesystem and is _not_ busybox. Some systems may want this,
1041 name = get_last_path_component(name);
1043 /* Count argc for use in a second... */
1044 for(argc_l=0;*argv_l!=NULL; argv_l++, argc_l++);
1046 debug_printf("running applet %s\n", name);
1047 run_applet_by_name(name, argc_l, child->argv);
1050 debug_printf("exec of %s\n",child->argv[0]);
1051 execvp(child->argv[0],child->argv);
1054 } else if (child->group) {
1055 debug_printf("runtime nesting to group\n");
1056 interactive=0; /* crucial!!!! */
1057 rcode = run_list_real(child->group);
1058 /* OK to leak memory by not calling run_list_test,
1059 * since this process is about to exit */
1062 /* Can happen. See what bash does with ">foo" by itself. */
1063 debug_printf("trying to pseudo_exec null command\n");
1068 static void insert_bg_job(struct pipe *pi)
1070 struct pipe *thejob;
1072 /* Linear search for the ID of the job to use */
1074 for (thejob = job_list->head; thejob; thejob = thejob->next)
1075 if (thejob->jobid >= pi->jobid)
1076 pi->jobid = thejob->jobid + 1;
1078 /* add thejob to the list of running jobs */
1079 if (!job_list->head) {
1080 thejob = job_list->head = xmalloc(sizeof(*thejob));
1082 for (thejob = job_list->head; thejob->next; thejob = thejob->next) /* nothing */;
1083 thejob->next = xmalloc(sizeof(*thejob));
1084 thejob = thejob->next;
1087 /* physically copy the struct job */
1088 memcpy(thejob, pi, sizeof(struct pipe));
1089 thejob->next = NULL;
1090 thejob->running_progs = thejob->num_progs;
1091 thejob->stopped_progs = 0;
1093 /* we don't wait for background thejobs to return -- append it
1094 to the list of backgrounded thejobs and leave it alone */
1095 printf("[%d] %d\n", pi->jobid, pi->pgrp);
1096 last_bg_pid = pi->pgrp;
1099 /* remove a backgrounded job from a jobset */
1100 static void remove_bg_job(struct pipe *pi)
1102 struct pipe *prev_pipe;
1105 if (pi == job_list->head) {
1106 job_list->head = pi->next;
1108 prev_pipe = job_list->head;
1109 while (prev_pipe->next != pi)
1110 prev_pipe = prev_pipe->next;
1111 prev_pipe->next = pi->next;
1117 /* free up all memory from a pipe */
1118 static void free_pipe(struct pipe *pi)
1122 for (i = 0; i < pi->num_progs; i++) {
1123 free(pi->progs[i].argv);
1124 if (pi->progs[i].redirects)
1125 free(pi->progs[i].redirects);
1133 memset(pi, 0, sizeof(struct pipe));
1137 /* Checks to see if any background processes have exited -- if they
1138 have, figure out why and see if a job has completed */
1139 static void checkjobs()
1146 while ((childpid = waitpid(-1, &status, WNOHANG | WUNTRACED)) > 0) {
1147 for (pi = job_list->head; pi; pi = pi->next) {
1149 while (prognum < pi->num_progs &&
1150 pi->progs[prognum].pid != childpid) prognum++;
1151 if (prognum < pi->num_progs)
1155 if (WIFEXITED(status) || WIFSIGNALED(status)) {
1157 pi->running_progs--;
1158 pi->progs[prognum].pid = 0;
1160 if (!pi->running_progs) {
1161 printf(JOB_STATUS_FORMAT, pi->jobid, "Done", pi->text);
1166 pi->stopped_progs++;
1167 pi->progs[prognum].is_stopped = 1;
1169 if (pi->stopped_progs == pi->num_progs) {
1170 printf(JOB_STATUS_FORMAT, pi->jobid, "Stopped",
1176 if (childpid == -1 && errno != ECHILD)
1177 perror_msg("waitpid");
1179 /* move the shell to the foreground */
1180 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1181 perror_msg("tcsetpgrp");
1184 /* run_pipe_real() starts all the jobs, but doesn't wait for anything
1185 * to finish. See pipe_wait().
1187 * return code is normally -1, when the caller has to wait for children
1188 * to finish to determine the exit status of the pipe. If the pipe
1189 * is a simple builtin command, however, the action is done by the
1190 * time run_pipe_real returns, and the exit code is provided as the
1193 * The input of the pipe is always stdin, the output is always
1194 * stdout. The outpipe[] mechanism in BusyBox-0.48 lash is bogus,
1195 * because it tries to avoid running the command substitution in
1196 * subshell, when that is in fact necessary. The subshell process
1197 * now has its stdout directed to the input of the appropriate pipe,
1198 * so this routine is noticeably simpler.
1200 static int run_pipe_real(struct pipe *pi)
1204 int nextin, nextout;
1205 int pipefds[2]; /* pipefds[0] is for reading */
1206 struct child_prog *child;
1207 struct built_in_command *x;
1213 /* Check if we are supposed to run in the foreground */
1214 if (interactive && pi->followup!=PIPE_BG) {
1215 if ((pi->pgrp = tcgetpgrp(ctty = 2)) < 0
1216 && (pi->pgrp = tcgetpgrp(ctty = 0)) < 0
1217 && (pi->pgrp = tcgetpgrp(ctty = 1)) < 0)
1218 return errno = ENOTTY, -1;
1220 if (pi->pgrp < 0 && pi->pgrp != getpgrp())
1221 return errno = EPERM, -1;
1224 /* Check if this is a simple builtin (not part of a pipe).
1225 * Builtins within pipes have to fork anyway, and are handled in
1226 * pseudo_exec. "echo foo | read bar" doesn't work on bash, either.
1228 if (pi->num_progs == 1 && pi->progs[0].argv != NULL) {
1229 child = & (pi->progs[0]);
1230 if (child->group && ! child->subshell) {
1231 int squirrel[] = {-1, -1, -1};
1233 debug_printf("non-subshell grouping\n");
1234 setup_redirects(child, squirrel);
1235 /* XXX could we merge code with following builtin case,
1236 * by creating a pseudo builtin that calls run_list_real? */
1237 rcode = run_list_real(child->group);
1238 restore_redirects(squirrel);
1241 for (x = bltins; x->cmd; x++) {
1242 if (strcmp(child->argv[0], x->cmd) == 0 ) {
1243 int squirrel[] = {-1, -1, -1};
1245 if (x->function == builtin_exec && child->argv[1]==NULL) {
1246 debug_printf("magic exec\n");
1247 setup_redirects(child,NULL);
1248 return EXIT_SUCCESS;
1250 debug_printf("builtin inline %s\n", child->argv[0]);
1251 /* XXX setup_redirects acts on file descriptors, not FILEs.
1252 * This is perfect for work that comes after exec().
1253 * Is it really safe for inline use? Experimentally,
1254 * things seem to work with glibc. */
1255 setup_redirects(child, squirrel);
1256 rcode = x->function(child);
1257 restore_redirects(squirrel);
1263 for (i = 0; i < pi->num_progs; i++) {
1264 child = & (pi->progs[i]);
1266 /* pipes are inserted between pairs of commands */
1267 if ((i + 1) < pi->num_progs) {
1268 if (pipe(pipefds)<0) perror_msg_and_die("pipe");
1269 nextout = pipefds[1];
1275 /* XXX test for failed fork()? */
1276 if (!(child->pid = fork())) {
1278 signal(SIGTTOU, SIG_DFL);
1290 if (pipefds[0]!=-1) {
1291 close(pipefds[0]); /* opposite end of our output pipe */
1294 /* Like bash, explicit redirects override pipes,
1295 * and the pipe fd is available for dup'ing. */
1296 setup_redirects(child,NULL);
1298 if (pi->followup!=PIPE_BG) {
1299 /* Put our child in the process group whose leader is the
1300 * first process in this pipe. */
1302 pi->pgrp = child->pid;
1304 /* Don't check for errors. The child may be dead already,
1305 * in which case setpgid returns error code EACCES. */
1306 if (setpgid(0, pi->pgrp) == 0) {
1307 signal(SIGTTOU, SIG_IGN);
1308 tcsetpgrp(ctty, pi->pgrp);
1309 signal(SIGTTOU, SIG_DFL);
1315 /* Put our child in the process group whose leader is the
1316 * first process in this pipe. */
1318 pi->pgrp = child->pid;
1320 /* Don't check for errors. The child may be dead already,
1321 * in which case setpgid returns error code EACCES. */
1322 setpgid(child->pid, pi->pgrp);
1329 /* If there isn't another process, nextin is garbage
1330 but it doesn't matter */
1331 nextin = pipefds[0];
1336 static int run_list_real(struct pipe *pi)
1339 int if_code=0, next_if_code=0; /* need double-buffer to handle elif */
1340 reserved_style rmode, skip_more_in_this_rmode=RES_XXXX;
1341 for (;pi;pi=pi->next) {
1343 debug_printf("rmode=%d if_code=%d next_if_code=%d skip_more=%d\n", rmode, if_code, next_if_code, skip_more_in_this_rmode);
1344 if (rmode == skip_more_in_this_rmode) continue;
1345 skip_more_in_this_rmode = RES_XXXX;
1346 if (rmode == RES_THEN || rmode == RES_ELSE) if_code = next_if_code;
1347 if (rmode == RES_THEN && if_code) continue;
1348 if (rmode == RES_ELSE && !if_code) continue;
1349 if (rmode == RES_ELIF && !if_code) continue;
1350 if (pi->num_progs == 0) continue;
1351 rcode = run_pipe_real(pi);
1353 /* We only ran a builtin: rcode was set by the return value
1354 * of run_pipe_real(), and we don't need to wait for anything. */
1355 } else if (pi->followup==PIPE_BG) {
1356 /* XXX check bash's behavior with nontrivial pipes */
1357 /* XXX compute jobid */
1358 /* XXX what does bash do with attempts to background builtins? */
1360 rcode = EXIT_SUCCESS;
1364 /* move the new process group into the foreground */
1365 /* suppress messages when run from /linuxrc mag@sysgo.de */
1366 //signal(SIGTTIN, SIG_IGN);
1367 //signal(SIGTTOU, SIG_IGN);
1368 if (tcsetpgrp(0, pi->pgrp) && errno != ENOTTY)
1369 perror_msg("tcsetpgrp");
1370 rcode = pipe_wait(pi);
1371 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1372 perror_msg("tcsetpgrp");
1373 //signal(SIGTTIN, SIG_DFL);
1374 //signal(SIGTTOU, SIG_DFL);
1376 rcode = pipe_wait(pi);
1379 last_return_code=rcode;
1380 if ( rmode == RES_IF || rmode == RES_ELIF )
1381 next_if_code=rcode; /* can be overwritten a number of times */
1382 if ( (rcode==EXIT_SUCCESS && pi->followup==PIPE_OR) ||
1383 (rcode!=EXIT_SUCCESS && pi->followup==PIPE_AND) )
1384 skip_more_in_this_rmode=rmode;
1385 /* return rcode; */ /* XXX broken if list is part of if/then/else */
1391 /* broken, of course, but OK for testing */
1392 static char *indenter(int i)
1394 static char blanks[]=" ";
1395 return &blanks[sizeof(blanks)-i-1];
1398 /* return code is the exit status of the pipe */
1399 static int run_pipe_test(struct pipe *pi, int indent)
1402 struct child_prog *child;
1403 struct redir_struct *r, *rnext;
1404 int a, i, ret_code=0;
1405 char *ind = indenter(indent);
1406 final_printf("%s run pipe: (pid %d)\n",ind,getpid());
1407 for (i=0; i<pi->num_progs; i++) {
1408 child = &pi->progs[i];
1409 final_printf("%s command %d:\n",ind,i);
1411 for (a=0,p=child->argv; *p; a++,p++) {
1412 final_printf("%s argv[%d] = %s\n",ind,a,*p);
1414 globfree(&child->glob_result);
1416 } else if (child->group) {
1417 final_printf("%s begin group (subshell:%d)\n",ind, child->subshell);
1418 ret_code = run_list_test(child->group,indent+3);
1419 final_printf("%s end group\n",ind);
1421 final_printf("%s (nil)\n",ind);
1423 for (r=child->redirects; r; r=rnext) {
1424 final_printf("%s redirect %d%s", ind, r->fd, redir_table[r->type].descrip);
1426 final_printf(" %s\n", *r->word.gl_pathv);
1429 final_printf("&%d\n", r->dup);
1434 child->redirects=NULL;
1436 free(pi->progs); /* children are an array, they get freed all at once */
1441 static int run_list_test(struct pipe *head, int indent)
1443 int rcode=0; /* if list has no members */
1444 struct pipe *pi, *next;
1445 char *ind = indenter(indent);
1446 for (pi=head; pi; pi=next) {
1447 if (pi->num_progs == 0) break;
1448 final_printf("%s pipe reserved mode %d\n", ind, pi->r_mode);
1449 rcode = run_pipe_test(pi, indent);
1450 final_printf("%s pipe followup code %d\n", ind, pi->followup);
1458 /* Select which version we will use */
1459 static int run_list(struct pipe *pi)
1463 rcode = run_list_real(pi);
1465 /* run_list_test has the side effect of clearing memory
1466 * In the long run that function can be merged with run_list_real,
1467 * but doing that now would hobble the debugging effort. */
1468 run_list_test(pi,0);
1472 /* The API for glob is arguably broken. This routine pushes a non-matching
1473 * string into the output structure, removing non-backslashed backslashes.
1474 * If someone can prove me wrong, by performing this function within the
1475 * original glob(3) api, feel free to rewrite this routine into oblivion.
1476 * Return code (0 vs. GLOB_NOSPACE) matches glob(3).
1477 * XXX broken if the last character is '\\', check that before calling.
1479 static int globhack(const char *src, int flags, glob_t *pglob)
1484 for (cnt=1, s=src; *s; s++) {
1485 if (*s == '\\') s++;
1489 if (!dest) return GLOB_NOSPACE;
1490 if (!(flags & GLOB_APPEND)) {
1491 pglob->gl_pathv=NULL;
1496 pathc = ++pglob->gl_pathc;
1497 pglob->gl_pathv = realloc(pglob->gl_pathv, (pathc+1)*sizeof(*pglob->gl_pathv));
1498 if (pglob->gl_pathv == NULL) return GLOB_NOSPACE;
1499 pglob->gl_pathv[pathc-1]=dest;
1500 pglob->gl_pathv[pathc]=NULL;
1501 for (s=src; *s; s++, dest++) {
1502 if (*s == '\\') s++;
1509 /* XXX broken if the last character is '\\', check that before calling */
1510 static int glob_needed(const char *s)
1513 if (*s == '\\') s++;
1514 if (strchr("*[?",*s)) return 1;
1520 static void globprint(glob_t *pglob)
1523 debug_printf("glob_t at %p:\n", pglob);
1524 debug_printf(" gl_pathc=%d gl_pathv=%p gl_offs=%d gl_flags=%d\n",
1525 pglob->gl_pathc, pglob->gl_pathv, pglob->gl_offs, pglob->gl_flags);
1526 for (i=0; i<pglob->gl_pathc; i++)
1527 debug_printf("pglob->gl_pathv[%d] = %p = %s\n", i,
1528 pglob->gl_pathv[i], pglob->gl_pathv[i]);
1532 static int xglob(o_string *dest, int flags, glob_t *pglob)
1536 /* short-circuit for null word */
1537 /* we can code this better when the debug_printf's are gone */
1538 if (dest->length == 0) {
1539 if (dest->nonnull) {
1540 /* bash man page calls this an "explicit" null */
1541 gr = globhack(dest->data, flags, pglob);
1542 debug_printf("globhack returned %d\n",gr);
1546 } else if (glob_needed(dest->data)) {
1547 gr = glob(dest->data, flags, NULL, pglob);
1548 debug_printf("glob returned %d\n",gr);
1549 if (gr == GLOB_NOMATCH) {
1550 /* quote removal, or more accurately, backslash removal */
1551 gr = globhack(dest->data, flags, pglob);
1552 debug_printf("globhack returned %d\n",gr);
1555 gr = globhack(dest->data, flags, pglob);
1556 debug_printf("globhack returned %d\n",gr);
1558 if (gr == GLOB_NOSPACE) {
1559 fprintf(stderr,"out of memory during glob\n");
1562 if (gr != 0) { /* GLOB_ABORTED ? */
1563 fprintf(stderr,"glob(3) error %d\n",gr);
1565 /* globprint(glob_target); */
1569 /* the src parameter allows us to peek forward to a possible &n syntax
1570 * for file descriptor duplication, e.g., "2>&1".
1571 * Return code is 0 normally, 1 if a syntax error is detected in src.
1572 * Resource errors (in xmalloc) cause the process to exit */
1573 static int setup_redirect(struct p_context *ctx, int fd, redir_type style,
1574 struct in_str *input)
1576 struct child_prog *child=ctx->child;
1577 struct redir_struct *redir = child->redirects;
1578 struct redir_struct *last_redir=NULL;
1580 /* Create a new redir_struct and drop it onto the end of the linked list */
1585 redir = xmalloc(sizeof(struct redir_struct));
1588 last_redir->next=redir;
1590 child->redirects=redir;
1594 redir->fd= (fd==-1) ? redir_table[style].default_fd : fd ;
1596 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
1598 /* Check for a '2>&1' type redirect */
1599 redir->dup = redirect_dup_num(input);
1600 if (redir->dup == -2) return 1; /* syntax error */
1601 if (redir->dup != -1) {
1602 /* Erik had a check here that the file descriptor in question
1603 * is legit; I postpone that to "run time"
1604 * A "-" representation of "close me" shows up as a -3 here */
1605 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
1607 /* We do _not_ try to open the file that src points to,
1608 * since we need to return and let src be expanded first.
1609 * Set ctx->pending_redirect, so we know what to do at the
1610 * end of the next parsed word.
1612 ctx->pending_redirect = redir;
1617 struct pipe *new_pipe(void) {
1619 pi = xmalloc(sizeof(struct pipe));
1623 pi->followup = 0; /* invalid */
1627 static void initialize_context(struct p_context *ctx)
1630 ctx->pending_redirect=NULL;
1632 ctx->list_head=new_pipe();
1633 ctx->pipe=ctx->list_head;
1636 done_command(ctx); /* creates the memory for working child */
1639 /* normal return is 0
1640 * if a reserved word is found, and processed, return 1
1641 * should handle if, then, elif, else, fi, for, while, until, do, done.
1642 * case, function, and select are obnoxious, save those for later.
1644 int reserved_word(o_string *dest, struct p_context *ctx)
1646 struct reserved_combo {
1651 /* Mostly a list of accepted follow-up reserved words.
1652 * FLAG_END means we are done with the sequence, and are ready
1653 * to turn the compound list into a command.
1654 * FLAG_START means the word must start a new compound list.
1656 static struct reserved_combo reserved_list[] = {
1657 { "if", RES_IF, FLAG_THEN | FLAG_START },
1658 { "then", RES_THEN, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
1659 { "elif", RES_ELIF, FLAG_THEN },
1660 { "else", RES_ELSE, FLAG_FI },
1661 { "fi", RES_FI, FLAG_END },
1662 { "for", RES_FOR, FLAG_DO | FLAG_START },
1663 { "while", RES_WHILE, FLAG_DO | FLAG_START },
1664 { "until", RES_UNTIL, FLAG_DO | FLAG_START },
1665 { "do", RES_DO, FLAG_DONE },
1666 { "done", RES_DONE, FLAG_END }
1668 struct reserved_combo *r;
1669 for (r=reserved_list;
1670 #define NRES sizeof(reserved_list)/sizeof(struct reserved_combo)
1671 r<reserved_list+NRES; r++) {
1672 if (strcmp(dest->data, r->literal) == 0) {
1673 debug_printf("found reserved word %s, code %d\n",r->literal,r->code);
1674 if (r->flag & FLAG_START) {
1675 struct p_context *new = xmalloc(sizeof(struct p_context));
1676 debug_printf("push stack\n");
1677 *new = *ctx; /* physical copy */
1678 initialize_context(ctx);
1680 } else if ( ctx->w == RES_NONE || ! (ctx->old_flag & (1<<r->code))) {
1687 ctx->old_flag = r->flag;
1688 if (ctx->old_flag & FLAG_END) {
1689 struct p_context *old;
1690 debug_printf("pop stack\n");
1692 old->child->group = ctx->list_head;
1693 *ctx = *old; /* physical copy */
1703 /* normal return is 0.
1704 * Syntax or xglob errors return 1. */
1705 static int done_word(o_string *dest, struct p_context *ctx)
1707 struct child_prog *child=ctx->child;
1708 glob_t *glob_target;
1711 debug_printf("done_word: %s %p\n", dest->data, child);
1712 if (dest->length == 0 && !dest->nonnull) {
1713 debug_printf(" true null, ignored\n");
1716 if (ctx->pending_redirect) {
1717 glob_target = &ctx->pending_redirect->word;
1721 return 1; /* syntax error, groups and arglists don't mix */
1724 debug_printf("checking %s for reserved-ness\n",dest->data);
1725 if (reserved_word(dest,ctx)) return ctx->w==RES_SNTX;
1727 glob_target = &child->glob_result;
1728 if (child->argv) flags |= GLOB_APPEND;
1730 gr = xglob(dest, flags, glob_target);
1731 if (gr != 0) return 1;
1734 if (ctx->pending_redirect) {
1735 ctx->pending_redirect=NULL;
1736 if (glob_target->gl_pathc != 1) {
1737 fprintf(stderr, "ambiguous redirect\n");
1741 child->argv = glob_target->gl_pathv;
1746 /* The only possible error here is out of memory, in which case
1748 static int done_command(struct p_context *ctx)
1750 /* The child is really already in the pipe structure, so
1751 * advance the pipe counter and make a new, null child.
1752 * Only real trickiness here is that the uncommitted
1753 * child structure, to which ctx->child points, is not
1754 * counted in pi->num_progs. */
1755 struct pipe *pi=ctx->pipe;
1756 struct child_prog *prog=ctx->child;
1758 if (prog && prog->group == NULL
1759 && prog->argv == NULL
1760 && prog->redirects == NULL) {
1761 debug_printf("done_command: skipping null command\n");
1765 debug_printf("done_command: num_progs incremented to %d\n",pi->num_progs);
1767 debug_printf("done_command: initializing\n");
1769 pi->progs = xrealloc(pi->progs, sizeof(*pi->progs) * (pi->num_progs+1));
1771 prog = pi->progs + pi->num_progs;
1772 prog->redirects = NULL;
1774 prog->is_stopped = 0;
1776 prog->glob_result.gl_pathv = NULL;
1780 /* but ctx->pipe and ctx->list_head remain unchanged */
1784 static int done_pipe(struct p_context *ctx, pipe_style type)
1787 done_command(ctx); /* implicit closure of previous command */
1788 debug_printf("done_pipe, type %d\n", type);
1789 ctx->pipe->followup = type;
1790 ctx->pipe->r_mode = ctx->w;
1792 ctx->pipe->next = new_p;
1795 done_command(ctx); /* set up new pipe to accept commands */
1799 /* peek ahead in the in_str to find out if we have a "&n" construct,
1800 * as in "2>&1", that represents duplicating a file descriptor.
1801 * returns either -2 (syntax error), -1 (no &), or the number found.
1803 static int redirect_dup_num(struct in_str *input)
1807 if (ch != '&') return -1;
1809 b_getch(input); /* get the & */
1813 return -3; /* "-" represents "close me" */
1815 while (isdigit(ch)) {
1823 fprintf(stderr, "ambiguous redirect\n");
1827 /* If a redirect is immediately preceded by a number, that number is
1828 * supposed to tell which file descriptor to redirect. This routine
1829 * looks for such preceding numbers. In an ideal world this routine
1830 * needs to handle all the following classes of redirects...
1831 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
1832 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
1833 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
1834 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
1835 * A -1 output from this program means no valid number was found, so the
1836 * caller should use the appropriate default for this redirection.
1838 static int redirect_opt_num(o_string *o)
1842 if (o->length==0) return -1;
1843 for(num=0; num<o->length; num++) {
1844 if (!isdigit(*(o->data+num))) {
1848 /* reuse num (and save an int) */
1854 FILE *generate_stream_from_list(struct pipe *head)
1858 int pid, channel[2];
1859 if (pipe(channel)<0) perror_msg_and_die("pipe");
1862 perror_msg_and_die("fork");
1863 } else if (pid==0) {
1865 if (channel[1] != 1) {
1870 #define SURROGATE "surrogate response"
1871 write(1,SURROGATE,sizeof(SURROGATE));
1872 exit(run_list(head));
1874 exit(run_list_real(head)); /* leaks memory */
1877 debug_printf("forked child %d\n",pid);
1879 pf = fdopen(channel[0],"r");
1880 debug_printf("pipe on FILE *%p\n",pf);
1882 run_list_test(head,0);
1883 pf=popen("echo surrogate response","r");
1884 debug_printf("started fake pipe on FILE *%p\n",pf);
1889 /* this version hacked for testing purposes */
1890 /* return code is exit status of the process that is run. */
1891 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end)
1894 o_string result=NULL_O_STRING;
1895 struct p_context inner;
1897 struct in_str pipe_str;
1898 initialize_context(&inner);
1900 /* recursion to generate command */
1901 retcode = parse_stream(&result, &inner, input, subst_end);
1902 if (retcode != 0) return retcode; /* syntax error or EOF */
1903 done_word(&result, &inner);
1904 done_pipe(&inner, PIPE_SEQ);
1907 p=generate_stream_from_list(inner.list_head);
1908 if (p==NULL) return 1;
1909 mark_open(fileno(p));
1910 setup_file_in_str(&pipe_str, p);
1912 /* now send results of command back into original context */
1913 retcode = parse_stream(dest, ctx, &pipe_str, '\0');
1914 /* XXX In case of a syntax error, should we try to kill the child?
1915 * That would be tough to do right, so just read until EOF. */
1917 while (b_getch(&pipe_str)!=EOF) { /* discard */ };
1920 debug_printf("done reading from pipe, pclose()ing\n");
1921 /* This is the step that wait()s for the child. Should be pretty
1922 * safe, since we just read an EOF from its stdout. We could try
1923 * to better, by using wait(), and keeping track of background jobs
1924 * at the same time. That would be a lot of work, and contrary
1925 * to the KISS philosophy of this program. */
1926 mark_closed(fileno(p));
1928 debug_printf("pclosed, retcode=%d\n",retcode);
1929 /* XXX this process fails to trim a single trailing newline */
1933 static int parse_group(o_string *dest, struct p_context *ctx,
1934 struct in_str *input, int ch)
1937 struct p_context sub;
1938 struct child_prog *child = ctx->child;
1941 return 1; /* syntax error, groups and arglists don't mix */
1943 initialize_context(&sub);
1945 case '(': endch=')'; child->subshell=1; break;
1946 case '{': endch='}'; break;
1947 default: syntax(); /* really logic error */
1949 rcode=parse_stream(dest,&sub,input,endch);
1950 done_word(dest,&sub); /* finish off the final word in the subcontext */
1951 done_pipe(&sub, PIPE_SEQ); /* and the final command there, too */
1952 child->group = sub.list_head;
1954 /* child remains "open", available for possible redirects */
1957 /* basically useful version until someone wants to get fancier,
1958 * see the bash man page under "Parameter Expansion" */
1959 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src)
1962 if (src->data) p = getenv(src->data);
1963 if (p) parse_string(dest, ctx, p); /* recursion */
1967 /* return code: 0 for OK, 1 for syntax error */
1968 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input)
1971 o_string alt=NULL_O_STRING;
1973 int ch = input->peek(input); /* first character after the $ */
1974 debug_printf("handle_dollar: ch=%c\n",ch);
1976 while(ch=b_peek(input),isalnum(ch) || ch=='_') {
1980 lookup_param(dest, ctx, &alt);
1981 } else if (isdigit(ch)) {
1982 i = ch-'0'; /* XXX is $0 special? */
1983 if (i<global_argc) {
1984 parse_string(dest, ctx, global_argv[i]); /* recursion */
1987 } else switch (ch) {
1989 b_adduint(dest,getpid());
1993 if (last_bg_pid > 0) b_adduint(dest, last_bg_pid);
1997 b_adduint(dest,last_return_code);
2001 b_adduint(dest,global_argc ? global_argc-1 : 0);
2006 /* XXX maybe someone will try to escape the '}' */
2007 while(ch=b_getch(input),ch!=EOF && ch!='}') {
2014 lookup_param(dest, ctx, &alt);
2018 process_command_subs(dest, ctx, input, ')');
2022 for (i=1; i<global_argc; i++) {
2023 parse_string(dest, ctx, global_argv[i]);
2024 if (i+1 < global_argc) parse_string(dest, ctx, sep);
2030 /* still unhandled, but should be eventually */
2031 fprintf(stderr,"unhandled syntax: $%c\n",ch);
2035 b_addqchr(dest,'$',dest->quote);
2037 /* Eat the character if the flag was set. If the compiler
2038 * is smart enough, we could substitute "b_getch(input);"
2039 * for all the "advance = 1;" above, and also end up with
2040 * a nice size-optimized program. Hah! That'll be the day.
2042 if (advance) b_getch(input);
2046 int parse_string(o_string *dest, struct p_context *ctx, const char *src)
2049 setup_string_in_str(&foo, src);
2050 return parse_stream(dest, ctx, &foo, '\0');
2053 /* return code is 0 for normal exit, 1 for syntax error */
2054 int parse_stream(o_string *dest, struct p_context *ctx,
2055 struct in_str *input, int end_trigger)
2059 redir_type redir_style;
2062 /* Only double-quote state is handled in the state variable dest->quote.
2063 * A single-quote triggers a bypass of the main loop until its mate is
2064 * found. When recursing, quote state is passed in via dest->quote. */
2066 debug_printf("parse_stream, end_trigger=%d\n",end_trigger);
2067 while ((ch=b_getch(input))!=EOF) {
2069 next = (ch == '\n') ? 0 : b_peek(input);
2070 debug_printf("parse_stream: ch=%c (%d) m=%d quote=%d\n",
2071 ch,ch,m,dest->quote);
2072 if (m==0 || ((m==1 || m==2) && dest->quote)) {
2073 b_addqchr(dest, ch, dest->quote);
2075 if (m==2) { /* unquoted IFS */
2076 done_word(dest, ctx);
2077 /* If we aren't performing a substitution, treat a newline as a
2078 * command separator. */
2079 if (end_trigger != '\0' && ch=='\n')
2080 done_pipe(ctx,PIPE_SEQ);
2082 if (ch == end_trigger && !dest->quote && ctx->w==RES_NONE) {
2083 debug_printf("leaving parse_stream\n");
2088 /* Yahoo! Time to run with it! */
2089 done_pipe(ctx,PIPE_SEQ);
2090 run_list(ctx->list_head);
2091 initialize_context(ctx);
2094 if (m!=2) switch (ch) {
2096 if (dest->length == 0 && !dest->quote) {
2097 while(ch=b_peek(input),ch!=EOF && ch!='\n') { b_getch(input); }
2099 b_addqchr(dest, ch, dest->quote);
2107 b_addqchr(dest, '\\', dest->quote);
2108 b_addqchr(dest, b_getch(input), dest->quote);
2111 if (handle_dollar(dest, ctx, input)!=0) return 1;
2115 while(ch=b_getch(input),ch!=EOF && ch!='\'') {
2125 dest->quote = !dest->quote;
2128 process_command_subs(dest, ctx, input, '`');
2131 redir_fd = redirect_opt_num(dest);
2132 done_word(dest, ctx);
2133 redir_style=REDIRECT_OVERWRITE;
2135 redir_style=REDIRECT_APPEND;
2137 } else if (next == '(') {
2138 syntax(); /* until we support >(list) Process Substitution */
2141 setup_redirect(ctx, redir_fd, redir_style, input);
2144 redir_fd = redirect_opt_num(dest);
2145 done_word(dest, ctx);
2146 redir_style=REDIRECT_INPUT;
2148 redir_style=REDIRECT_HEREIS;
2150 } else if (next == '>') {
2151 redir_style=REDIRECT_IO;
2153 } else if (next == '(') {
2154 syntax(); /* until we support <(list) Process Substitution */
2157 setup_redirect(ctx, redir_fd, redir_style, input);
2160 done_word(dest, ctx);
2161 done_pipe(ctx,PIPE_SEQ);
2164 done_word(dest, ctx);
2167 done_pipe(ctx,PIPE_AND);
2169 done_pipe(ctx,PIPE_BG);
2173 done_word(dest, ctx);
2176 done_pipe(ctx,PIPE_OR);
2178 /* we could pick up a file descriptor choice here
2179 * with redirect_opt_num(), but bash doesn't do it.
2180 * "echo foo 2| cat" yields "foo 2". */
2186 if (parse_group(dest, ctx, input, ch)!=0) return 1;
2190 syntax(); /* Proper use of this character caught by end_trigger */
2194 syntax(); /* this is really an internal logic error */
2199 /* complain if quote? No, maybe we just finished a command substitution
2200 * that was quoted. Example:
2201 * $ echo "`cat foo` plus more"
2202 * and we just got the EOF generated by the subshell that ran "cat foo"
2203 * The only real complaint is if we got an EOF when end_trigger != '\0',
2204 * that is, we were really supposed to get end_trigger, and never got
2205 * one before the EOF. Can't use the standard "syntax error" return code,
2206 * so that parse_stream_outer can distinguish the EOF and exit smoothly. */
2207 if (end_trigger != '\0') return -1;
2211 void mapset(const unsigned char *set, int code)
2213 const unsigned char *s;
2214 for (s=set; *s; s++) map[*s] = code;
2217 void update_ifs_map(void)
2219 /* char *ifs and char map[256] are both globals. */
2220 ifs = getenv("IFS");
2221 if (ifs == NULL) ifs=" \t\n";
2222 /* Precompute a list of 'flow through' behavior so it can be treated
2223 * quickly up front. Computation is necessary because of IFS.
2224 * Special case handling of IFS == " \t\n" is not implemented.
2225 * The map[] array only really needs two bits each, and on most machines
2226 * that would be faster because of the reduced L1 cache footprint.
2228 memset(map,0,256); /* most characters flow through always */
2229 mapset("\\$'\"`", 3); /* never flow through */
2230 mapset("<>;&|(){}#", 1); /* flow through if quoted */
2231 mapset(ifs, 2); /* also flow through if quoted */
2234 /* most recursion does not come through here, the exeception is
2235 * from builtin_source() */
2236 int parse_stream_outer(struct in_str *inp)
2239 struct p_context ctx;
2240 o_string temp=NULL_O_STRING;
2243 initialize_context(&ctx);
2246 rcode = parse_stream(&temp, &ctx, inp, '\n');
2247 done_word(&temp, &ctx);
2248 done_pipe(&ctx,PIPE_SEQ);
2249 run_list(ctx.list_head);
2250 } while (rcode != -1); /* loop on syntax errors, return on EOF */
2254 static int parse_string_outer(const char *s)
2256 struct in_str input;
2257 setup_string_in_str(&input, s);
2258 return parse_stream_outer(&input);
2261 static int parse_file_outer(FILE *f)
2264 struct in_str input;
2265 setup_file_in_str(&input, f);
2266 rcode = parse_stream_outer(&input);
2270 int shell_main(int argc, char **argv)
2274 struct jobset joblist_end = { NULL, NULL };
2275 job_list = &joblist_end;
2277 last_return_code=EXIT_SUCCESS;
2279 /* XXX what should these be while sourcing /etc/profile? */
2283 /* don't pay any attention to this signal; it just confuses
2284 things and isn't really meant for shells anyway */
2285 signal(SIGTTOU, SIG_IGN);
2287 if (argv[0] && argv[0][0] == '-') {
2288 debug_printf("\nsourcing /etc/profile\n");
2289 input = xfopen("/etc/profile", "r");
2290 mark_open(fileno(input));
2291 parse_file_outer(input);
2292 mark_closed(fileno(input));
2297 /* initialize the cwd -- this is never freed...*/
2299 #ifdef BB_FEATURE_COMMAND_EDITING
2300 cmdedit_set_initial_prompt();
2305 while ((opt = getopt(argc, argv, "c:xif")) > 0) {
2309 global_argv = argv+optind;
2310 global_argc = argc-optind;
2311 opt = parse_string_outer(optarg);
2322 fprintf(stderr, "Usage: sh [FILE]...\n"
2323 " or: sh -c command [args]...\n\n");
2327 /* A shell is interactive if the `-i' flag was given, or if all of
2328 * the following conditions are met:
2330 * no arguments remaining or the -s flag given
2331 * standard input is a terminal
2332 * standard output is a terminal
2333 * Refer to Posix.2, the description of the `sh' utility. */
2334 if (argv[optind]==NULL && input==stdin &&
2335 isatty(fileno(stdin)) && isatty(fileno(stdout))) {
2339 debug_printf("\ninteractive=%d\n", interactive);
2341 /* Looks like they want an interactive shell */
2342 fprintf(stdout, "\nhush -- the humble shell v0.01 (testing)\n\n");
2343 opt=parse_file_outer(stdin);
2347 debug_printf("\nrunning script '%s'\n", argv[optind]);
2348 global_argv = argv+optind;
2349 global_argc = argc-optind;
2350 input = xfopen(argv[optind], "r");
2351 opt = parse_file_outer(input);
2353 #ifdef BB_FEATURE_CLEAN_UP
2358 return(opt?opt:last_return_code);