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, 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
56 * finish implementing reserved words
57 * handle children going into background
58 * clean up recognition of null pipes
59 * have builtin_exec set flag to avoid restore_redirects
60 * figure out if "echo foo}" is fixable
61 * check setting of global_argc and global_argv
62 * control-C handling, probably with longjmp
63 * VAR=value prefix for simple commands
64 * follow IFS rules more precisely, including update semantics
65 * write builtin_eval, builtin_ulimit, builtin_umask
66 * figure out what to do with backslash-newline
67 * explain why we use signal instead of sigaction
68 * propagate syntax errors, die on resource errors?
69 * continuation lines, both explicit and implicit - done?
70 * memory leak finding and plugging - done?
71 * more testing, especially quoting rules and redirection
72 * maybe change map[] to use 2-bit entries
73 * (eventually) remove all the printf's
75 * This program is free software; you can redistribute it and/or modify
76 * it under the terms of the GNU General Public License as published by
77 * the Free Software Foundation; either version 2 of the License, or
78 * (at your option) any later version.
80 * This program is distributed in the hope that it will be useful,
81 * but WITHOUT ANY WARRANTY; without even the implied warranty of
82 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
83 * General Public License for more details.
85 * You should have received a copy of the GNU General Public License
86 * along with this program; if not, write to the Free Software
87 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
89 #include <ctype.h> /* isalpha, isdigit */
90 #include <unistd.h> /* getpid */
91 #include <stdlib.h> /* getenv, atoi */
92 #include <string.h> /* strchr */
93 #include <stdio.h> /* popen etc. */
94 #include <glob.h> /* glob, of course */
95 #include <stdarg.h> /* va_list */
98 #include <getopt.h> /* should be pretty obvious */
100 #include <sys/types.h>
101 #include <sys/wait.h>
104 /* #include <dmalloc.h> */
105 /* #define DEBUG_SHELL */
111 #define applet_name "hush"
112 #include "standalone.h"
113 #define shell_main main
114 #define BB_FEATURE_SH_SIMPLE_PROMPT
119 REDIRECT_OVERWRITE = 2,
125 /* The descrip member of this structure is only used to make debugging
127 struct {int mode; int default_fd; char *descrip;} redir_table[] = {
129 { O_RDONLY, 0, "<" },
130 { O_CREAT|O_TRUNC|O_WRONLY, 1, ">" },
131 { O_CREAT|O_APPEND|O_WRONLY, 1, ">>" },
132 { O_RDONLY, -1, "<<" },
143 /* might eventually control execution */
159 #define FLAG_END (1<<RES_NONE)
160 #define FLAG_IF (1<<RES_IF)
161 #define FLAG_THEN (1<<RES_THEN)
162 #define FLAG_ELIF (1<<RES_ELIF)
163 #define FLAG_ELSE (1<<RES_ELSE)
164 #define FLAG_FI (1<<RES_FI)
165 #define FLAG_FOR (1<<RES_FOR)
166 #define FLAG_WHILE (1<<RES_WHILE)
167 #define FLAG_UNTIL (1<<RES_UNTIL)
168 #define FLAG_DO (1<<RES_DO)
169 #define FLAG_DONE (1<<RES_DONE)
170 #define FLAG_START (1<<RES_XXXX)
172 /* This holds pointers to the various results of parsing */
174 struct child_prog *child;
175 struct pipe *list_head;
177 struct redir_struct *pending_redirect;
179 int old_flag; /* for figuring out valid reserved words */
180 struct p_context *stack;
181 /* How about quoting status? */
184 struct redir_struct {
185 redir_type type; /* type of redirection */
186 int fd; /* file descriptor being redirected */
187 int dup; /* -1, or file descriptor being duplicated */
188 struct redir_struct *next; /* pointer to the next redirect in the list */
189 glob_t word; /* *word.gl_pathv is the filename */
193 pid_t pid; /* 0 if exited */
194 char **argv; /* program name and arguments */
195 struct pipe *group; /* if non-NULL, first in group or subshell */
196 int subshell; /* flag, non-zero if group must be forked */
197 struct redir_struct *redirects; /* I/O redirections */
198 glob_t glob_result; /* result of parameter globbing */
199 int is_stopped; /* is the program currently running? */
200 struct pipe *family; /* pointer back to the child's parent pipe */
204 int jobid; /* job number */
205 int num_progs; /* total number of programs in job */
206 int running_progs; /* number of programs running */
207 char *text; /* name of job */
208 char *cmdbuf; /* buffer various argv's point into */
209 pid_t pgrp; /* process group ID for the job */
210 struct child_prog *progs; /* array of commands in pipe */
211 struct pipe *next; /* to track background commands */
212 int stopped_progs; /* number of programs alive, but stopped */
213 int job_context; /* bitmask defining current context */
214 pipe_style followup; /* PIPE_BG, PIPE_SEQ, PIPE_OR, PIPE_AND */
215 reserved_style r_mode; /* supports if, for, while, until */
219 struct pipe *head; /* head of list of running jobs */
220 struct pipe *fg; /* current foreground job */
225 struct close_me *next;
228 /* globals, connect us to the outside world
229 * the first three support $?, $#, and $1 */
231 unsigned int global_argc;
232 unsigned int last_return_code;
233 extern char **environ; /* This is in <unistd.h>, but protected with __USE_GNU */
235 /* Variables we export */
236 unsigned int shell_context; /* Used in cmdedit.c to reset the
237 * context when someone hits ^C */
239 /* "globals" within this file */
240 static char *ifs=NULL;
241 static char map[256];
242 static int fake_mode=0;
243 static int interactive=0;
244 static struct close_me *close_me_head = NULL;
246 static struct jobset *job_list;
247 static unsigned int last_bg_pid=0;
249 static char *PS2 = "> ";
251 #define B_CHUNK (100)
253 #define MAX_LINE 256 /* for cwd */
254 #define MAX_READ 256 /* for builtin_read */
263 #define NULL_O_STRING {NULL,0,0,0,0}
264 /* used for initialization:
265 o_string foo = NULL_O_STRING; */
267 /* I can almost use ordinary FILE *. Is open_memstream() universally
268 * available? Where is it documented? */
274 int (*get) (struct in_str *);
275 int (*peek) (struct in_str *);
277 #define b_getch(input) ((input)->get(input))
278 #define b_peek(input) ((input)->peek(input))
280 #define JOB_STATUS_FORMAT "[%d] %-22s %.40s\n"
282 struct built_in_command {
283 char *cmd; /* name */
284 char *descr; /* description */
285 int (*function) (struct child_prog *); /* function ptr */
288 /* belongs in busybox.h */
289 static inline int max(int a, int b) {
293 /* This should be in utility.c */
295 static void debug_printf(const char *format, ...)
298 va_start(args, format);
299 vfprintf(stderr, format, args);
303 static void debug_printf(const char *format, ...) { }
305 #define final_printf debug_printf
307 void __syntax(char *file, int line) {
308 fprintf(stderr,"syntax error %s:%d\n",file,line);
310 #define syntax() __syntax(__FILE__, __LINE__)
312 /* Index of subroutines: */
313 /* function prototypes for builtins */
314 static int builtin_cd(struct child_prog *child);
315 static int builtin_env(struct child_prog *child);
316 static int builtin_exec(struct child_prog *child);
317 static int builtin_exit(struct child_prog *child);
318 static int builtin_export(struct child_prog *child);
319 static int builtin_fg_bg(struct child_prog *child);
320 static int builtin_help(struct child_prog *child);
321 static int builtin_jobs(struct child_prog *child);
322 static int builtin_pwd(struct child_prog *child);
323 static int builtin_read(struct child_prog *child);
324 static int builtin_shift(struct child_prog *child);
325 static int builtin_source(struct child_prog *child);
326 static int builtin_ulimit(struct child_prog *child);
327 static int builtin_umask(struct child_prog *child);
328 static int builtin_unset(struct child_prog *child);
329 /* o_string manipulation: */
330 static int b_check_space(o_string *o, int len);
331 static int b_addchr(o_string *o, int ch);
332 static void b_reset(o_string *o);
333 static int b_addqchr(o_string *o, int ch, int quote);
334 static int b_adduint(o_string *o, unsigned int i);
335 /* in_str manipulations: */
336 static int static_get(struct in_str *i);
337 static int static_peek(struct in_str *i);
338 static int file_get(struct in_str *i);
339 static int file_peek(struct in_str *i);
340 static void setup_file_in_str(struct in_str *i, FILE *f);
341 static void setup_string_in_str(struct in_str *i, const char *s);
342 /* close_me manipulations: */
343 static void mark_open(int fd);
344 static void mark_closed(int fd);
345 static void close_all();
346 /* "run" the final data structures: */
347 static char *indenter(int i);
348 static int run_list_test(struct pipe *head, int indent);
349 static int run_pipe_test(struct pipe *pi, int indent);
350 /* really run the final data structures: */
351 static int setup_redirects(struct child_prog *prog, int squirrel[]);
352 static int pipe_wait(struct pipe *pi);
353 static int run_list_real(struct pipe *pi);
354 static void pseudo_exec(struct child_prog *child) __attribute__ ((noreturn));
355 static int run_pipe_real(struct pipe *pi);
356 /* extended glob support: */
357 static int globhack(const char *src, int flags, glob_t *pglob);
358 static int glob_needed(const char *s);
359 static int xglob(o_string *dest, int flags, glob_t *pglob);
360 /* data structure manipulation: */
361 static int setup_redirect(struct p_context *ctx, int fd, redir_type style, struct in_str *input);
362 static void initialize_context(struct p_context *ctx);
363 static int done_word(o_string *dest, struct p_context *ctx);
364 static int done_command(struct p_context *ctx);
365 static int done_pipe(struct p_context *ctx, pipe_style type);
366 /* primary string parsing: */
367 static int redirect_dup_num(struct in_str *input);
368 static int redirect_opt_num(o_string *o);
369 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end);
370 static int parse_group(o_string *dest, struct p_context *ctx, struct in_str *input, int ch);
371 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src);
372 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input);
373 static int parse_string(o_string *dest, struct p_context *ctx, const char *src);
374 static int parse_stream(o_string *dest, struct p_context *ctx, struct in_str *input0, int end_trigger);
376 static int parse_stream_outer(struct in_str *inp);
377 static int parse_string_outer(const char *s);
378 static int parse_file_outer(FILE *f);
379 /* job management: */
380 static void checkjobs();
381 static void insert_bg_job(struct pipe *pi);
382 static void remove_bg_job(struct pipe *pi);
383 static void free_pipe(struct pipe *pi);
385 /* Table of built-in functions. They can be forked or not, depending on
386 * context: within pipes, they fork. As simple commands, they do not.
387 * When used in non-forking context, they can change global variables
388 * in the parent shell process. If forked, of course they can not.
389 * For example, 'unset foo | whatever' will parse and run, but foo will
390 * still be set at the end. */
391 static struct built_in_command bltins[] = {
392 {"bg", "Resume a job in the background", builtin_fg_bg},
393 {"cd", "Change working directory", builtin_cd},
394 {"env", "Print all environment variables", builtin_env},
395 {"exec", "Exec command, replacing this shell with the exec'd process", builtin_exec},
396 {"exit", "Exit from shell()", builtin_exit},
397 {"export", "Set environment variable", builtin_export},
398 {"fg", "Bring job into the foreground", builtin_fg_bg},
399 {"jobs", "Lists the active jobs", builtin_jobs},
400 {"pwd", "Print current directory", builtin_pwd},
401 {"read", "Input environment variable", builtin_read},
402 {"shift", "Shift positional parameters", builtin_shift},
403 {"ulimit","Controls resource limits", builtin_ulimit},
404 {"umask","Sets file creation mask", builtin_umask},
405 {"unset", "Unset environment variable", builtin_unset},
406 {".", "Source-in and run commands in a file", builtin_source},
407 {"help", "List shell built-in commands", builtin_help},
411 /* built-in 'cd <path>' handler */
412 static int builtin_cd(struct child_prog *child)
415 if (child->argv[1] == NULL)
416 newdir = getenv("HOME");
418 newdir = child->argv[1];
420 printf("cd: %s: %s\n", newdir, strerror(errno));
423 getcwd(cwd, sizeof(char)*MAX_LINE);
427 /* built-in 'env' handler */
428 static int builtin_env(struct child_prog *dummy)
431 if (e == NULL) return EXIT_FAILURE;
438 /* built-in 'exec' handler */
439 static int builtin_exec(struct child_prog *child)
441 if (child->argv[1] == NULL)
442 return EXIT_SUCCESS; /* Really? */
448 /* built-in 'exit' handler */
449 static int builtin_exit(struct child_prog *child)
451 if (child->argv[1] == NULL)
452 exit(last_return_code);
453 exit (atoi(child->argv[1]));
456 /* built-in 'export VAR=value' handler */
457 static int builtin_export(struct child_prog *child)
461 if (child->argv[1] == NULL) {
462 return (builtin_env(child));
464 res = putenv(child->argv[1]);
466 fprintf(stderr, "export: %s\n", strerror(errno));
470 /* built-in 'fg' and 'bg' handler */
471 static int builtin_fg_bg(struct child_prog *child)
474 struct pipe *job=NULL;
476 if (!child->argv[1] || child->argv[2]) {
477 error_msg("%s: exactly one argument is expected\n",
482 if (sscanf(child->argv[1], "%%%d", &jobNum) != 1) {
483 error_msg("%s: bad argument '%s'\n",
484 child->argv[0], child->argv[1]);
488 for (job = job_list->head; job; job = job->next) {
489 if (job->jobid == jobNum) {
495 error_msg("%s: unknown job %d\n",
496 child->argv[0], jobNum);
500 if (*child->argv[0] == 'f') {
501 /* Make this job the foreground job */
502 /* suppress messages when run from /linuxrc mag@sysgo.de */
503 if (tcsetpgrp(0, job->pgrp) && errno != ENOTTY)
504 perror_msg("tcsetpgrp");
508 /* Restart the processes in the job */
509 for (i = 0; i < job->num_progs; i++)
510 job->progs[i].is_stopped = 0;
512 kill(-job->pgrp, SIGCONT);
514 job->stopped_progs = 0;
518 /* built-in 'help' handler */
519 static int builtin_help(struct child_prog *dummy)
521 struct built_in_command *x;
523 printf("\nBuilt-in commands:\n");
524 printf("-------------------\n");
525 for (x = bltins; x->cmd; x++) {
528 printf("%s\t%s\n", x->cmd, x->descr);
534 /* built-in 'jobs' handler */
535 static int builtin_jobs(struct child_prog *child)
540 for (job = job_list->head; job; job = job->next) {
541 if (job->running_progs == job->stopped_progs)
542 status_string = "Stopped";
544 status_string = "Running";
545 printf(JOB_STATUS_FORMAT, job->jobid, status_string, job->text);
551 /* built-in 'pwd' handler */
552 static int builtin_pwd(struct child_prog *dummy)
554 getcwd(cwd, MAX_LINE);
559 /* built-in 'read VAR' handler */
560 static int builtin_read(struct child_prog *child)
562 int res = 0, len, newlen;
564 char string[MAX_READ];
566 if (child->argv[1]) {
567 /* argument (VAR) given: put "VAR=" into buffer */
568 strcpy(string, child->argv[1]);
569 len = strlen(string);
572 /* XXX would it be better to go through in_str? */
573 fgets(&string[len], sizeof(string) - len, stdin); /* read string */
574 newlen = strlen(string);
576 string[--newlen] = '\0'; /* chomp trailing newline */
578 ** string should now contain "VAR=<value>"
579 ** copy it (putenv() won't do that, so we must make sure
580 ** the string resides in a static buffer!)
583 if((s = strdup(string)))
586 fprintf(stderr, "read: %s\n", strerror(errno));
589 fgets(string, sizeof(string), stdin);
594 /* Built-in 'shift' handler */
595 static int builtin_shift(struct child_prog *child)
598 if (child->argv[1]) {
599 n=atoi(child->argv[1]);
601 if (n>=0 && n<global_argc) {
602 /* XXX This probably breaks $0 */
611 /* Built-in '.' handler (read-in and execute commands from file) */
612 static int builtin_source(struct child_prog *child)
617 if (child->argv[1] == NULL)
620 /* XXX search through $PATH is missing */
621 input = fopen(child->argv[1], "r");
623 fprintf(stderr, "Couldn't open file '%s'\n", child->argv[1]);
627 /* Now run the file */
628 /* XXX argv and argc are broken; need to save old global_argv
629 * (pointer only is OK!) on this stack frame,
630 * set global_argv=child->argv+1, recurse, and restore. */
631 mark_open(fileno(input));
632 status = parse_file_outer(input);
633 mark_closed(fileno(input));
638 static int builtin_ulimit(struct child_prog *child)
640 printf("builtin_ulimit not written\n");
644 static int builtin_umask(struct child_prog *child)
646 printf("builtin_umask not written\n");
650 /* built-in 'unset VAR' handler */
651 static int builtin_unset(struct child_prog *child)
653 if (child->argv[1] == NULL) {
654 fprintf(stderr, "unset: parameter required.\n");
657 unsetenv(child->argv[1]);
661 static int b_check_space(o_string *o, int len)
663 /* It would be easy to drop a more restrictive policy
664 * in here, such as setting a maximum string length */
665 if (o->length + len > o->maxlen) {
666 char *old_data = o->data;
667 /* assert (data == NULL || o->maxlen != 0); */
668 o->maxlen += max(2*len, B_CHUNK);
669 o->data = realloc(o->data, 1 + o->maxlen);
670 if (o->data == NULL) {
674 return o->data == NULL;
677 static int b_addchr(o_string *o, int ch)
679 debug_printf("b_addchr: %c %d %p\n", ch, o->length, o);
680 if (b_check_space(o, 1)) return B_NOSPAC;
681 o->data[o->length] = ch;
683 o->data[o->length] = '\0';
687 static void b_reset(o_string *o)
691 if (o->data != NULL) *o->data = '\0';
694 static void b_free(o_string *o)
697 if (o->data != NULL) free(o->data);
702 /* My analysis of quoting semantics tells me that state information
703 * is associated with a destination, not a source.
705 static int b_addqchr(o_string *o, int ch, int quote)
707 if (quote && strchr("*?[\\",ch)) {
709 rc = b_addchr(o, '\\');
712 return b_addchr(o, ch);
715 /* belongs in utility.c */
716 char *simple_itoa(unsigned int i)
718 /* 21 digits plus null terminator, good for 64-bit or smaller ints */
719 static char local[22];
720 char *p = &local[21];
729 static int b_adduint(o_string *o, unsigned int i)
732 char *p = simple_itoa(i);
733 /* no escape checking necessary */
734 do r=b_addchr(o, *p++); while (r==0 && *p);
738 static int static_get(struct in_str *i)
741 if (ch=='\0') return EOF;
745 static int static_peek(struct in_str *i)
750 static inline void cmdedit_set_initial_prompt(void)
752 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
761 static inline void setup_prompt_string(int promptmode, char **prompt_str)
763 debug_printf("setup_prompt_string %d ",promptmode);
764 #ifdef BB_FEATURE_SH_SIMPLE_PROMPT
765 /* Set up the prompt */
766 if (promptmode == 1) {
769 PS1=xmalloc(strlen(cwd)+4);
770 sprintf(PS1, "%s %s", cwd, ( geteuid() != 0 ) ? "$ ":"# ");
776 *prompt_str = (promptmode==0)? PS1 : PS2;
778 debug_printf("result %s\n",*prompt_str);
781 static void get_user_input(struct in_str *i)
784 static char the_command[BUFSIZ];
786 setup_prompt_string(i->promptmode, &prompt_str);
787 #ifdef BB_FEATURE_COMMAND_EDITING
789 ** enable command line editing only while a command line
790 ** is actually being read; otherwise, we'll end up bequeathing
791 ** atexit() handlers and other unwanted stuff to our
792 ** child processes (rob@sysgo.de)
794 cmdedit_read_input(prompt_str, the_command);
797 fputs(prompt_str, stdout);
799 the_command[0]=fgetc(i->file);
805 /* This is the magic location that prints prompts
806 * and gets data back from the user */
807 static int file_get(struct in_str *i)
812 /* If there is data waiting, eat it up */
816 /* need to double check i->file because we might be doing something
817 * more complicated by now, like sourcing or substituting. */
818 if (i->__promptme && interactive && i->file == stdin) {
829 debug_printf("b_getch: got a %d\n", ch);
831 if (ch == '\n') i->__promptme=1;
835 /* All the callers guarantee this routine will never be
836 * used right after a newline, so prompting is not needed.
838 static int file_peek(struct in_str *i)
843 static char buffer[2];
844 buffer[0] = fgetc(i->file);
847 debug_printf("b_peek: got a %d\n", *i->p);
852 static void setup_file_in_str(struct in_str *i, FILE *f)
862 static void setup_string_in_str(struct in_str *i, const char *s)
864 i->peek = static_peek;
871 static void mark_open(int fd)
873 struct close_me *new = xmalloc(sizeof(struct close_me));
875 new->next = close_me_head;
879 static void mark_closed(int fd)
881 struct close_me *tmp;
882 if (close_me_head == NULL || close_me_head->fd != fd)
883 error_msg_and_die("corrupt close_me");
885 close_me_head = close_me_head->next;
889 static void close_all()
892 for (c=close_me_head; c; c=c->next) {
895 close_me_head = NULL;
898 /* squirrel != NULL means we squirrel away copies of stdin, stdout,
899 * and stderr if they are redirected. */
900 static int setup_redirects(struct child_prog *prog, int squirrel[])
903 struct redir_struct *redir;
905 for (redir=prog->redirects; redir; redir=redir->next) {
906 if (redir->dup == -1) {
907 mode=redir_table[redir->type].mode;
908 openfd = open(redir->word.gl_pathv[0], mode, 0666);
910 /* this could get lost if stderr has been redirected, but
911 bash and ash both lose it as well (though zsh doesn't!) */
912 fprintf(stderr,"error opening %s: %s\n", redir->word.gl_pathv[0],
920 if (openfd != redir->fd) {
921 if (squirrel && redir->fd < 3) {
922 squirrel[redir->fd] = dup(redir->fd);
924 dup2(openfd, redir->fd);
931 static void restore_redirects(int squirrel[])
934 for (i=0; i<3; i++) {
937 /* No error checking. I sure wouldn't know what
938 * to do with an error if I found one! */
945 /* XXX this definitely needs some more thought, work, and
946 * cribbing from other shells */
947 static int pipe_wait(struct pipe *pi)
949 int rcode=0, i, pid, running, status;
950 running = pi->num_progs;
952 pid=waitpid(-1, &status, 0);
953 if (pid < 0) perror_msg_and_die("waitpid");
954 for (i=0; i < pi->num_progs; i++) {
955 if (pi->progs[i].pid == pid) {
956 if (i==pi->num_progs-1) rcode=WEXITSTATUS(status);
957 pi->progs[i].pid = 0;
966 /* very simple version for testing */
967 static void pseudo_exec(struct child_prog *child)
970 struct built_in_command *x;
973 * Check if the command matches any of the builtins.
974 * Depending on context, this might be redundant. But it's
975 * easier to waste a few CPU cycles than it is to figure out
976 * if this is one of those cases.
978 for (x = bltins; x->cmd; x++) {
979 if (strcmp(child->argv[0], x->cmd) == 0 ) {
980 debug_printf("builtin exec %s\n", child->argv[0]);
981 exit(x->function(child));
985 /* Check if the command matches any busybox internal commands
987 * FIXME: This feature is not 100% safe, since
988 * BusyBox is not fully reentrant, so we have no guarantee the things
989 * from the .bss are still zeroed, or that things from .data are still
990 * at their defaults. We could exec ourself from /proc/self/exe, but I
991 * really dislike relying on /proc for things. We could exec ourself
992 * from global_argv[0], but if we are in a chroot, we may not be able
993 * to find ourself... */
994 #ifdef BB_FEATURE_SH_STANDALONE_SHELL
997 char** argv_l=child->argv;
998 char *name = child->argv[0];
1000 #ifdef BB_FEATURE_SH_APPLETS_ALWAYS_WIN
1001 /* Following discussions from November 2000 on the busybox mailing
1002 * list, the default configuration, (without
1003 * get_last_path_component()) lets the user force use of an
1004 * external command by specifying the full (with slashes) filename.
1005 * If you enable BB_FEATURE_SH_APPLETS_ALWAYS_WIN, then applets
1006 * _aways_ override external commands, so if you want to run
1007 * /bin/cat, it will use BusyBox cat even if /bin/cat exists on the
1008 * filesystem and is _not_ busybox. Some systems may want this,
1010 name = get_last_path_component(name);
1012 /* Count argc for use in a second... */
1013 for(argc_l=0;*argv_l!=NULL; argv_l++, argc_l++);
1015 debug_printf("running applet %s\n", name);
1016 run_applet_by_name(name, argc_l, child->argv);
1020 debug_printf("exec of %s\n",child->argv[0]);
1021 execvp(child->argv[0],child->argv);
1024 } else if (child->group) {
1025 debug_printf("runtime nesting to group\n");
1026 interactive=0; /* crucial!!!! */
1027 rcode = run_list_real(child->group);
1028 /* OK to leak memory by not calling run_list_test,
1029 * since this process is about to exit */
1032 /* Can happen. See what bash does with ">foo" by itself. */
1033 debug_printf("trying to pseudo_exec null command\n");
1038 static void insert_bg_job(struct pipe *pi)
1040 struct pipe *thejob;
1042 /* Linear search for the ID of the job to use */
1044 for (thejob = job_list->head; thejob; thejob = thejob->next)
1045 if (thejob->jobid >= pi->jobid)
1046 pi->jobid = thejob->jobid + 1;
1048 /* add thejob to the list of running jobs */
1049 if (!job_list->head) {
1050 thejob = job_list->head = xmalloc(sizeof(*thejob));
1052 for (thejob = job_list->head; thejob->next; thejob = thejob->next) /* nothing */;
1053 thejob->next = xmalloc(sizeof(*thejob));
1054 thejob = thejob->next;
1057 /* physically copy the struct job */
1059 thejob->next = NULL;
1060 thejob->running_progs = thejob->num_progs;
1061 thejob->stopped_progs = 0;
1063 /* we don't wait for background thejobs to return -- append it
1064 to the list of backgrounded thejobs and leave it alone */
1065 printf("[%d] %d\n", pi->jobid, pi->pgrp);
1066 last_bg_pid = pi->pgrp;
1069 /* remove a backgrounded job from a jobset */
1070 static void remove_bg_job(struct pipe *pi)
1072 struct pipe *prev_pipe;
1075 if (pi == job_list->head) {
1076 job_list->head = pi->next;
1078 prev_pipe = job_list->head;
1079 while (prev_pipe->next != pi)
1080 prev_pipe = prev_pipe->next;
1081 prev_pipe->next = pi->next;
1087 /* free up all memory from a pipe */
1088 static void free_pipe(struct pipe *pi)
1092 for (i = 0; i < pi->num_progs; i++) {
1093 free(pi->progs[i].argv);
1094 if (pi->progs[i].redirects)
1095 free(pi->progs[i].redirects);
1103 memset(pi, 0, sizeof(struct pipe));
1106 /* Checks to see if any background processes have exited -- if they
1107 have, figure out why and see if a job has completed */
1108 static void checkjobs()
1115 while ((childpid = waitpid(-1, &status, WNOHANG | WUNTRACED)) > 0) {
1116 for (pi = job_list->head; pi; pi = pi->next) {
1118 while (prognum < pi->num_progs &&
1119 pi->progs[prognum].pid != childpid) prognum++;
1120 if (prognum < pi->num_progs)
1124 if (WIFEXITED(status) || WIFSIGNALED(status)) {
1126 pi->running_progs--;
1127 pi->progs[prognum].pid = 0;
1129 if (!pi->running_progs) {
1130 printf(JOB_STATUS_FORMAT, pi->jobid, "Done", pi->text);
1135 pi->stopped_progs++;
1136 pi->progs[prognum].is_stopped = 1;
1138 if (pi->stopped_progs == pi->num_progs) {
1139 printf(JOB_STATUS_FORMAT, pi->jobid, "Stopped",
1145 /* move the shell to the foreground */
1146 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1147 perror_msg("tcsetpgrp");
1149 if (childpid == -1 && errno != ECHILD)
1150 perror_msg("waitpid");
1153 /* run_pipe_real() starts all the jobs, but doesn't wait for anything
1154 * to finish. See pipe_wait().
1156 * return code is normally -1, when the caller has to wait for children
1157 * to finish to determine the exit status of the pipe. If the pipe
1158 * is a simple builtin command, however, the action is done by the
1159 * time run_pipe_real returns, and the exit code is provided as the
1162 * The input of the pipe is always stdin, the output is always
1163 * stdout. The outpipe[] mechanism in BusyBox-0.48 lash is bogus,
1164 * because it tries to avoid running the command substitution in
1165 * subshell, when that is in fact necessary. The subshell process
1166 * now has its stdout directed to the input of the appropriate pipe,
1167 * so this routine is noticeably simpler.
1169 static int run_pipe_real(struct pipe *pi)
1172 int nextin, nextout;
1173 int pipefds[2]; /* pipefds[0] is for reading */
1174 struct child_prog *child;
1175 struct built_in_command *x;
1180 /* Check if this is a simple builtin (not part of a pipe).
1181 * Builtins within pipes have to fork anyway, and are handled in
1182 * pseudo_exec. "echo foo | read bar" doesn't work on bash, either.
1184 if (pi->num_progs == 1 && pi->progs[0].argv != NULL) {
1185 child = & (pi->progs[0]);
1186 if (child->group && ! child->subshell) {
1187 int squirrel[] = {-1, -1, -1};
1189 debug_printf("non-subshell grouping\n");
1190 setup_redirects(child, squirrel);
1191 /* XXX could we merge code with following builtin case,
1192 * by creating a pseudo builtin that calls run_list_real? */
1193 rcode = run_list_real(child->group);
1194 restore_redirects(squirrel);
1197 for (x = bltins; x->cmd; x++) {
1198 if (strcmp(child->argv[0], x->cmd) == 0 ) {
1199 int squirrel[] = {-1, -1, -1};
1201 debug_printf("builtin inline %s\n", child->argv[0]);
1202 /* XXX setup_redirects acts on file descriptors, not FILEs.
1203 * This is perfect for work that comes after exec().
1204 * Is it really safe for inline use? Experimentally,
1205 * things seem to work with glibc. */
1206 setup_redirects(child, squirrel);
1207 rcode = x->function(child);
1208 restore_redirects(squirrel);
1214 for (i = 0; i < pi->num_progs; i++) {
1215 child = & (pi->progs[i]);
1217 /* pipes are inserted between pairs of commands */
1218 if ((i + 1) < pi->num_progs) {
1219 if (pipe(pipefds)<0) perror_msg_and_die("pipe");
1220 nextout = pipefds[1];
1226 /* XXX test for failed fork()? */
1227 if (!(child->pid = fork())) {
1228 signal(SIGTTOU, SIG_DFL);
1240 if (pipefds[0]!=-1) {
1241 close(pipefds[0]); /* opposite end of our output pipe */
1244 /* Like bash, explicit redirects override pipes,
1245 * and the pipe fd is available for dup'ing. */
1246 setup_redirects(child,NULL);
1251 /* Put our child in the process group whose leader is the
1252 * first process in this pipe. */
1254 pi->pgrp = child->pid;
1256 /* Don't check for errors. The child may be dead already,
1257 * in which case setpgid returns error code EACCES. */
1258 setpgid(child->pid, pi->pgrp);
1260 /* In the non-interactive case, do nothing. Leave the children
1261 * with the process group that they inherited from us. */
1268 /* If there isn't another process, nextin is garbage
1269 but it doesn't matter */
1270 nextin = pipefds[0];
1275 static int run_list_real(struct pipe *pi)
1278 int if_code=0, next_if_code=0; /* need double-buffer to handle elif */
1279 reserved_style rmode, skip_more_in_this_rmode=RES_XXXX;
1280 for (;pi;pi=pi->next) {
1282 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);
1283 if (rmode == skip_more_in_this_rmode) continue;
1284 skip_more_in_this_rmode = RES_XXXX;
1285 if (rmode == RES_THEN || rmode == RES_ELSE) if_code = next_if_code;
1286 if (rmode == RES_THEN && if_code) continue;
1287 if (rmode == RES_ELSE && !if_code) continue;
1288 if (rmode == RES_ELIF && !if_code) continue;
1289 if (pi->num_progs == 0) continue;
1290 rcode = run_pipe_real(pi);
1292 /* We only ran a builtin: rcode was set by the return value
1293 * of run_pipe_real(), and we don't need to wait for anything. */
1294 } else if (pi->followup==PIPE_BG) {
1295 /* XXX check bash's behavior with nontrivial pipes */
1296 /* XXX compute jobid */
1297 /* XXX what does bash do with attempts to background builtins? */
1299 printf("[%d] %d\n", pi->jobid, pi->pgrp);
1300 last_bg_pid = pi->pgrp;
1303 rcode = EXIT_SUCCESS;
1306 /* move the new process group into the foreground */
1307 /* suppress messages when run from /linuxrc mag@sysgo.de */
1308 //signal(SIGTTIN, SIG_IGN);
1309 //signal(SIGTTOU, SIG_IGN);
1310 if (tcsetpgrp(0, pi->pgrp) && errno != ENOTTY)
1311 perror_msg("tcsetpgrp");
1312 rcode = pipe_wait(pi);
1313 if (tcsetpgrp(0, getpgrp()) && errno != ENOTTY)
1314 perror_msg("tcsetpgrp");
1315 //signal(SIGTTIN, SIG_DFL);
1316 //signal(SIGTTOU, SIG_DFL);
1318 rcode = pipe_wait(pi);
1321 last_return_code=rcode;
1322 if ( rmode == RES_IF || rmode == RES_ELIF )
1323 next_if_code=rcode; /* can be overwritten a number of times */
1324 if ( (rcode==EXIT_SUCCESS && pi->followup==PIPE_OR) ||
1325 (rcode!=EXIT_SUCCESS && pi->followup==PIPE_AND) )
1326 skip_more_in_this_rmode=rmode;
1327 /* return rcode; */ /* XXX broken if list is part of if/then/else */
1333 /* broken, of course, but OK for testing */
1334 static char *indenter(int i)
1336 static char blanks[]=" ";
1337 return &blanks[sizeof(blanks)-i-1];
1340 /* return code is the exit status of the pipe */
1341 static int run_pipe_test(struct pipe *pi, int indent)
1344 struct child_prog *child;
1345 struct redir_struct *r, *rnext;
1346 int a, i, ret_code=0;
1347 char *ind = indenter(indent);
1348 final_printf("%s run pipe: (pid %d)\n",ind,getpid());
1349 for (i=0; i<pi->num_progs; i++) {
1350 child = &pi->progs[i];
1351 final_printf("%s command %d:\n",ind,i);
1353 for (a=0,p=child->argv; *p; a++,p++) {
1354 final_printf("%s argv[%d] = %s\n",ind,a,*p);
1356 globfree(&child->glob_result);
1358 } else if (child->group) {
1359 final_printf("%s begin group (subshell:%d)\n",ind, child->subshell);
1360 ret_code = run_list_test(child->group,indent+3);
1361 final_printf("%s end group\n",ind);
1363 final_printf("%s (nil)\n",ind);
1365 for (r=child->redirects; r; r=rnext) {
1366 final_printf("%s redirect %d%s", ind, r->fd, redir_table[r->type].descrip);
1368 final_printf(" %s\n", *r->word.gl_pathv);
1371 final_printf("&%d\n", r->dup);
1376 child->redirects=NULL;
1378 free(pi->progs); /* children are an array, they get freed all at once */
1383 static int run_list_test(struct pipe *head, int indent)
1385 int rcode=0; /* if list has no members */
1386 struct pipe *pi, *next;
1387 char *ind = indenter(indent);
1388 for (pi=head; pi; pi=next) {
1389 if (pi->num_progs == 0) break;
1390 final_printf("%s pipe reserved mode %d\n", ind, pi->r_mode);
1391 rcode = run_pipe_test(pi, indent);
1392 final_printf("%s pipe followup code %d\n", ind, pi->followup);
1400 /* Select which version we will use */
1401 static int run_list(struct pipe *pi)
1405 rcode = run_list_real(pi);
1407 /* run_list_test has the side effect of clearing memory
1408 * In the long run that function can be merged with run_list_real,
1409 * but doing that now would hobble the debugging effort. */
1410 run_list_test(pi,0);
1414 /* The API for glob is arguably broken. This routine pushes a non-matching
1415 * string into the output structure, removing non-backslashed backslashes.
1416 * If someone can prove me wrong, by performing this function within the
1417 * original glob(3) api, feel free to rewrite this routine into oblivion.
1418 * Return code (0 vs. GLOB_NOSPACE) matches glob(3).
1419 * XXX broken if the last character is '\\', check that before calling.
1421 static int globhack(const char *src, int flags, glob_t *pglob)
1426 for (cnt=1, s=src; *s; s++) {
1427 if (*s == '\\') s++;
1431 if (!dest) return GLOB_NOSPACE;
1432 if (!(flags & GLOB_APPEND)) {
1433 pglob->gl_pathv=NULL;
1438 pathc = ++pglob->gl_pathc;
1439 pglob->gl_pathv = realloc(pglob->gl_pathv, (pathc+1)*sizeof(*pglob->gl_pathv));
1440 if (pglob->gl_pathv == NULL) return GLOB_NOSPACE;
1441 pglob->gl_pathv[pathc-1]=dest;
1442 pglob->gl_pathv[pathc]=NULL;
1443 for (s=src; *s; s++, dest++) {
1444 if (*s == '\\') s++;
1451 /* XXX broken if the last character is '\\', check that before calling */
1452 static int glob_needed(const char *s)
1455 if (*s == '\\') s++;
1456 if (strchr("*[?",*s)) return 1;
1462 static void globprint(glob_t *pglob)
1465 debug_printf("glob_t at %p:\n", pglob);
1466 debug_printf(" gl_pathc=%d gl_pathv=%p gl_offs=%d gl_flags=%d\n",
1467 pglob->gl_pathc, pglob->gl_pathv, pglob->gl_offs, pglob->gl_flags);
1468 for (i=0; i<pglob->gl_pathc; i++)
1469 debug_printf("pglob->gl_pathv[%d] = %p = %s\n", i,
1470 pglob->gl_pathv[i], pglob->gl_pathv[i]);
1474 static int xglob(o_string *dest, int flags, glob_t *pglob)
1478 /* short-circuit for null word */
1479 /* we can code this better when the debug_printf's are gone */
1480 if (dest->length == 0) {
1481 if (dest->nonnull) {
1482 /* bash man page calls this an "explicit" null */
1483 gr = globhack(dest->data, flags, pglob);
1484 debug_printf("globhack returned %d\n",gr);
1488 } else if (glob_needed(dest->data)) {
1489 gr = glob(dest->data, flags, NULL, pglob);
1490 debug_printf("glob returned %d\n",gr);
1491 if (gr == GLOB_NOMATCH) {
1492 /* quote removal, or more accurately, backslash removal */
1493 gr = globhack(dest->data, flags, pglob);
1494 debug_printf("globhack returned %d\n",gr);
1497 gr = globhack(dest->data, flags, pglob);
1498 debug_printf("globhack returned %d\n",gr);
1500 if (gr == GLOB_NOSPACE) {
1501 fprintf(stderr,"out of memory during glob\n");
1504 if (gr != 0) { /* GLOB_ABORTED ? */
1505 fprintf(stderr,"glob(3) error %d\n",gr);
1507 /* globprint(glob_target); */
1511 /* the src parameter allows us to peek forward to a possible &n syntax
1512 * for file descriptor duplication, e.g., "2>&1".
1513 * Return code is 0 normally, 1 if a syntax error is detected in src.
1514 * Resource errors (in xmalloc) cause the process to exit */
1515 static int setup_redirect(struct p_context *ctx, int fd, redir_type style,
1516 struct in_str *input)
1518 struct child_prog *child=ctx->child;
1519 struct redir_struct *redir = child->redirects;
1520 struct redir_struct *last_redir=NULL;
1522 /* Create a new redir_struct and drop it onto the end of the linked list */
1527 redir = xmalloc(sizeof(struct redir_struct));
1530 last_redir->next=redir;
1532 child->redirects=redir;
1536 redir->fd= (fd==-1) ? redir_table[style].default_fd : fd ;
1538 debug_printf("Redirect type %d%s\n", redir->fd, redir_table[style].descrip);
1540 /* Check for a '2>&1' type redirect */
1541 redir->dup = redirect_dup_num(input);
1542 if (redir->dup == -2) return 1; /* syntax error */
1543 if (redir->dup != -1) {
1544 /* Erik had a check here that the file descriptor in question
1545 * is legit; I postpone that to "run time" */
1546 debug_printf("Duplicating redirect '%d>&%d'\n", redir->fd, redir->dup);
1548 /* We do _not_ try to open the file that src points to,
1549 * since we need to return and let src be expanded first.
1550 * Set ctx->pending_redirect, so we know what to do at the
1551 * end of the next parsed word.
1553 ctx->pending_redirect = redir;
1558 struct pipe *new_pipe(void) {
1560 pi = xmalloc(sizeof(struct pipe));
1564 pi->followup = 0; /* invalid */
1568 static void initialize_context(struct p_context *ctx)
1571 ctx->pending_redirect=NULL;
1573 ctx->list_head=new_pipe();
1574 ctx->pipe=ctx->list_head;
1577 done_command(ctx); /* creates the memory for working child */
1580 /* normal return is 0
1581 * if a reserved word is found, and processed, return 1
1582 * should handle if, then, elif, else, fi, for, while, until, do, done.
1583 * case, function, and select are obnoxious, save those for later.
1585 int reserved_word(o_string *dest, struct p_context *ctx)
1587 struct reserved_combo {
1592 /* Mostly a list of accepted follow-up reserved words.
1593 * FLAG_END means we are done with the sequence, and are ready
1594 * to turn the compound list into a command.
1595 * FLAG_START means the word must start a new compound list.
1597 static struct reserved_combo reserved_list[] = {
1598 { "if", RES_IF, FLAG_THEN | FLAG_START },
1599 { "then", RES_THEN, FLAG_ELIF | FLAG_ELSE | FLAG_FI },
1600 { "elif", RES_ELIF, FLAG_THEN },
1601 { "else", RES_ELSE, FLAG_FI },
1602 { "fi", RES_FI, FLAG_END },
1603 { "for", RES_FOR, FLAG_DO | FLAG_START },
1604 { "while", RES_WHILE, FLAG_DO | FLAG_START },
1605 { "until", RES_UNTIL, FLAG_DO | FLAG_START },
1606 { "do", RES_DO, FLAG_DONE },
1607 { "done", RES_DONE, FLAG_END }
1609 struct reserved_combo *r;
1610 for (r=reserved_list;
1611 #define NRES sizeof(reserved_list)/sizeof(struct reserved_combo)
1612 r<reserved_list+NRES; r++) {
1613 if (strcmp(dest->data, r->literal) == 0) {
1614 debug_printf("found reserved word %s, code %d\n",r->literal,r->code);
1615 if (r->flag & FLAG_START) {
1616 struct p_context *new = xmalloc(sizeof(struct p_context));
1617 debug_printf("push stack\n");
1618 *new = *ctx; /* physical copy */
1619 initialize_context(ctx);
1621 } else if ( ctx->w == RES_NONE || ! (ctx->old_flag & (1<<r->code))) {
1628 ctx->old_flag = r->flag;
1629 if (ctx->old_flag & FLAG_END) {
1630 struct p_context *old;
1631 debug_printf("pop stack\n");
1633 old->child->group = ctx->list_head;
1634 *ctx = *old; /* physical copy */
1645 /* normal return is 0.
1646 * Syntax or xglob errors return 1. */
1647 static int done_word(o_string *dest, struct p_context *ctx)
1649 struct child_prog *child=ctx->child;
1650 glob_t *glob_target;
1653 debug_printf("done_word: %s %p\n", dest->data, child);
1654 if (dest->length == 0 && !dest->nonnull) {
1655 debug_printf(" true null, ignored\n");
1658 if (ctx->pending_redirect) {
1659 glob_target = &ctx->pending_redirect->word;
1663 return 1; /* syntax error, groups and arglists don't mix */
1666 debug_printf("checking %s for reserved-ness\n",dest->data);
1667 if (reserved_word(dest,ctx)) return ctx->w==RES_SNTX;
1669 glob_target = &child->glob_result;
1670 if (child->argv) flags |= GLOB_APPEND;
1672 gr = xglob(dest, flags, glob_target);
1673 if (gr != 0) return 1;
1676 if (ctx->pending_redirect) {
1677 ctx->pending_redirect=NULL;
1678 if (glob_target->gl_pathc != 1) {
1679 fprintf(stderr, "ambiguous redirect\n");
1683 child->argv = glob_target->gl_pathv;
1688 /* The only possible error here is out of memory, in which case
1690 static int done_command(struct p_context *ctx)
1692 /* The child is really already in the pipe structure, so
1693 * advance the pipe counter and make a new, null child.
1694 * Only real trickiness here is that the uncommitted
1695 * child structure, to which ctx->child points, is not
1696 * counted in pi->num_progs. */
1697 struct pipe *pi=ctx->pipe;
1698 struct child_prog *prog=ctx->child;
1700 if (prog && prog->group == NULL
1701 && prog->argv == NULL
1702 && prog->redirects == NULL) {
1703 debug_printf("done_command: skipping null command\n");
1707 debug_printf("done_command: num_progs incremented to %d\n",pi->num_progs);
1709 debug_printf("done_command: initializing\n");
1711 pi->progs = xrealloc(pi->progs, sizeof(*pi->progs) * (pi->num_progs+1));
1713 prog = pi->progs + pi->num_progs;
1714 prog->redirects = NULL;
1716 prog->is_stopped = 0;
1718 prog->glob_result.gl_pathv = NULL;
1722 /* but ctx->pipe and ctx->list_head remain unchanged */
1726 static int done_pipe(struct p_context *ctx, pipe_style type)
1729 done_command(ctx); /* implicit closure of previous command */
1730 debug_printf("done_pipe, type %d\n", type);
1731 ctx->pipe->followup = type;
1732 ctx->pipe->r_mode = ctx->w;
1734 ctx->pipe->next = new_p;
1737 done_command(ctx); /* set up new pipe to accept commands */
1741 /* peek ahead in the in_str to find out if we have a "&n" construct,
1742 * as in "2>&1", that represents duplicating a file descriptor.
1743 * returns either -2 (syntax error), -1 (no &), or the number found.
1745 static int redirect_dup_num(struct in_str *input)
1749 if (ch != '&') return -1;
1751 b_getch(input); /* get the & */
1752 while (ch=b_peek(input),isdigit(ch)) {
1759 fprintf(stderr, "ambiguous redirect\n");
1763 /* If a redirect is immediately preceded by a number, that number is
1764 * supposed to tell which file descriptor to redirect. This routine
1765 * looks for such preceding numbers. In an ideal world this routine
1766 * needs to handle all the following classes of redirects...
1767 * echo 2>foo # redirects fd 2 to file "foo", nothing passed to echo
1768 * echo 49>foo # redirects fd 49 to file "foo", nothing passed to echo
1769 * echo -2>foo # redirects fd 1 to file "foo", "-2" passed to echo
1770 * echo 49x>foo # redirects fd 1 to file "foo", "49x" passed to echo
1771 * A -1 output from this program means no valid number was found, so the
1772 * caller should use the appropriate default for this redirection.
1774 static int redirect_opt_num(o_string *o)
1778 if (o->length==0) return -1;
1779 for(num=0; num<o->length; num++) {
1780 if (!isdigit(*(o->data+num))) {
1784 /* reuse num (and save an int) */
1790 FILE *generate_stream_from_list(struct pipe *head)
1794 int pid, channel[2];
1795 if (pipe(channel)<0) perror_msg_and_die("pipe");
1798 perror_msg_and_die("fork");
1799 } else if (pid==0) {
1801 if (channel[1] != 1) {
1806 #define SURROGATE "surrogate response"
1807 write(1,SURROGATE,sizeof(SURROGATE));
1808 exit(run_list(head));
1810 exit(run_list_real(head)); /* leaks memory */
1813 debug_printf("forked child %d\n",pid);
1815 pf = fdopen(channel[0],"r");
1816 debug_printf("pipe on FILE *%p\n",pf);
1818 run_list_test(head,0);
1819 pf=popen("echo surrogate response","r");
1820 debug_printf("started fake pipe on FILE *%p\n",pf);
1825 /* this version hacked for testing purposes */
1826 /* return code is exit status of the process that is run. */
1827 static int process_command_subs(o_string *dest, struct p_context *ctx, struct in_str *input, int subst_end)
1830 o_string result=NULL_O_STRING;
1831 struct p_context inner;
1833 struct in_str pipe_str;
1834 initialize_context(&inner);
1836 /* recursion to generate command */
1837 retcode = parse_stream(&result, &inner, input, subst_end);
1838 if (retcode != 0) return retcode; /* syntax error or EOF */
1839 done_word(&result, &inner);
1840 done_pipe(&inner, PIPE_SEQ);
1843 p=generate_stream_from_list(inner.list_head);
1844 if (p==NULL) return 1;
1845 mark_open(fileno(p));
1846 setup_file_in_str(&pipe_str, p);
1848 /* now send results of command back into original context */
1849 retcode = parse_stream(dest, ctx, &pipe_str, '\0');
1850 /* XXX In case of a syntax error, should we try to kill the child?
1851 * That would be tough to do right, so just read until EOF. */
1853 while (b_getch(&pipe_str)!=EOF) { /* discard */ };
1856 debug_printf("done reading from pipe, pclose()ing\n");
1857 /* This is the step that wait()s for the child. Should be pretty
1858 * safe, since we just read an EOF from its stdout. We could try
1859 * to better, by using wait(), and keeping track of background jobs
1860 * at the same time. That would be a lot of work, and contrary
1861 * to the KISS philosophy of this program. */
1862 mark_closed(fileno(p));
1864 debug_printf("pclosed, retcode=%d\n",retcode);
1865 /* XXX this process fails to trim a single trailing newline */
1869 static int parse_group(o_string *dest, struct p_context *ctx,
1870 struct in_str *input, int ch)
1873 struct p_context sub;
1874 struct child_prog *child = ctx->child;
1877 return 1; /* syntax error, groups and arglists don't mix */
1879 initialize_context(&sub);
1881 case '(': endch=')'; child->subshell=1; break;
1882 case '{': endch='}'; break;
1883 default: syntax(); /* really logic error */
1885 rcode=parse_stream(dest,&sub,input,endch);
1886 done_word(dest,&sub); /* finish off the final word in the subcontext */
1887 done_pipe(&sub, PIPE_SEQ); /* and the final command there, too */
1888 child->group = sub.list_head;
1890 /* child remains "open", available for possible redirects */
1893 /* basically useful version until someone wants to get fancier,
1894 * see the bash man page under "Parameter Expansion" */
1895 static void lookup_param(o_string *dest, struct p_context *ctx, o_string *src)
1898 if (src->data) p = getenv(src->data);
1899 if (p) parse_string(dest, ctx, p); /* recursion */
1903 /* return code: 0 for OK, 1 for syntax error */
1904 static int handle_dollar(o_string *dest, struct p_context *ctx, struct in_str *input)
1907 o_string alt=NULL_O_STRING;
1909 int ch = input->peek(input); /* first character after the $ */
1910 debug_printf("handle_dollar: ch=%c\n",ch);
1912 while(ch=b_peek(input),isalnum(ch) || ch=='_') {
1916 lookup_param(dest, ctx, &alt);
1917 } else if (isdigit(ch)) {
1918 i = ch-'0'; /* XXX is $0 special? */
1919 if (i<global_argc) {
1920 parse_string(dest, ctx, global_argv[i]); /* recursion */
1923 } else switch (ch) {
1925 b_adduint(dest,getpid());
1929 if (last_bg_pid > 0) b_adduint(dest, last_bg_pid);
1933 b_adduint(dest,last_return_code);
1937 b_adduint(dest,global_argc ? global_argc-1 : 0);
1942 /* XXX maybe someone will try to escape the '}' */
1943 while(ch=b_getch(input),ch!=EOF && ch!='}') {
1950 lookup_param(dest, ctx, &alt);
1953 process_command_subs(dest, ctx, input, ')');
1957 for (i=1; i<global_argc; i++) {
1958 parse_string(dest, ctx, global_argv[i]);
1959 if (i+1 < global_argc) parse_string(dest, ctx, sep);
1965 /* still unhandled, but should be eventually */
1966 fprintf(stderr,"unhandled syntax: $%c\n",ch);
1970 b_addqchr(dest,'$',dest->quote);
1972 /* Eat the character if the flag was set. If the compiler
1973 * is smart enough, we could substitute "b_getch(input);"
1974 * for all the "advance = 1;" above, and also end up with
1975 * a nice size-optimized program. Hah! That'll be the day.
1977 if (advance) b_getch(input);
1981 int parse_string(o_string *dest, struct p_context *ctx, const char *src)
1984 setup_string_in_str(&foo, src);
1985 return parse_stream(dest, ctx, &foo, '\0');
1988 /* return code is 0 for normal exit, 1 for syntax error */
1989 int parse_stream(o_string *dest, struct p_context *ctx,
1990 struct in_str *input, int end_trigger)
1994 redir_type redir_style;
1997 /* Only double-quote state is handled in the state variable dest->quote.
1998 * A single-quote triggers a bypass of the main loop until its mate is
1999 * found. When recursing, quote state is passed in via dest->quote. */
2001 debug_printf("parse_stream, end_trigger=%d\n",end_trigger);
2002 while ((ch=b_getch(input))!=EOF) {
2004 next = (ch == '\n') ? 0 : b_peek(input);
2005 debug_printf("parse_stream: ch=%c (%d) m=%d quote=%d\n",
2006 ch,ch,m,dest->quote);
2007 if (m==0 || ((m==1 || m==2) && dest->quote)) {
2008 b_addqchr(dest, ch, dest->quote);
2010 if (m==2) { /* unquoted IFS */
2011 done_word(dest, ctx);
2012 if (ch=='\n') done_pipe(ctx,PIPE_SEQ);
2014 if (ch == end_trigger && !dest->quote && ctx->w==RES_NONE) {
2015 debug_printf("leaving parse_stream\n");
2020 /* Yahoo! Time to run with it! */
2021 done_pipe(ctx,PIPE_SEQ);
2022 run_list(ctx->list_head);
2023 initialize_context(ctx);
2026 if (m!=2) switch (ch) {
2028 if (dest->length == 0 && !dest->quote) {
2029 while(ch=b_peek(input),ch!=EOF && ch!='\n') { b_getch(input); }
2031 b_addqchr(dest, ch, dest->quote);
2039 b_addqchr(dest, '\\', dest->quote);
2040 b_addqchr(dest, b_getch(input), dest->quote);
2043 if (handle_dollar(dest, ctx, input)!=0) return 1;
2047 while(ch=b_getch(input),ch!=EOF && ch!='\'') {
2057 dest->quote = !dest->quote;
2060 process_command_subs(dest, ctx, input, '`');
2063 redir_fd = redirect_opt_num(dest);
2064 done_word(dest, ctx);
2065 redir_style=REDIRECT_OVERWRITE;
2067 redir_style=REDIRECT_APPEND;
2069 } else if (next == '(') {
2070 syntax(); /* until we support >(list) Process Substitution */
2073 setup_redirect(ctx, redir_fd, redir_style, input);
2076 redir_fd = redirect_opt_num(dest);
2077 done_word(dest, ctx);
2078 redir_style=REDIRECT_INPUT;
2080 redir_style=REDIRECT_HEREIS;
2082 } else if (next == '>') {
2083 redir_style=REDIRECT_IO;
2085 } else if (next == '(') {
2086 syntax(); /* until we support <(list) Process Substitution */
2089 setup_redirect(ctx, redir_fd, redir_style, input);
2092 done_word(dest, ctx);
2093 done_pipe(ctx,PIPE_SEQ);
2096 done_word(dest, ctx);
2099 done_pipe(ctx,PIPE_AND);
2101 done_pipe(ctx,PIPE_BG);
2105 done_word(dest, ctx);
2108 done_pipe(ctx,PIPE_OR);
2110 /* we could pick up a file descriptor choice here
2111 * with redirect_opt_num(), but bash doesn't do it.
2112 * "echo foo 2| cat" yields "foo 2". */
2118 if (parse_group(dest, ctx, input, ch)!=0) return 1;
2122 syntax(); /* Proper use of this character caught by end_trigger */
2126 syntax(); /* this is really an internal logic error */
2131 /* complain if quote? No, maybe we just finished a command substitution
2132 * that was quoted. Example:
2133 * $ echo "`cat foo` plus more"
2134 * and we just got the EOF generated by the subshell that ran "cat foo"
2135 * The only real complaint is if we got an EOF when end_trigger != '\0',
2136 * that is, we were really supposed to get end_trigger, and never got
2137 * one before the EOF. Can't use the standard "syntax error" return code,
2138 * so that parse_stream_outer can distinguish the EOF and exit smoothly. */
2139 if (end_trigger != '\0') return -1;
2143 void mapset(const unsigned char *set, int code)
2145 const unsigned char *s;
2146 for (s=set; *s; s++) map[*s] = code;
2149 void update_ifs_map(void)
2151 /* char *ifs and char map[256] are both globals. */
2152 ifs = getenv("IFS");
2153 if (ifs == NULL) ifs=" \t\n";
2154 /* Precompute a list of 'flow through' behavior so it can be treated
2155 * quickly up front. Computation is necessary because of IFS.
2156 * Special case handling of IFS == " \t\n" is not implemented.
2157 * The map[] array only really needs two bits each, and on most machines
2158 * that would be faster because of the reduced L1 cache footprint.
2160 memset(map,0,256); /* most characters flow through always */
2161 mapset("\\$'\"`", 3); /* never flow through */
2162 mapset("<>;&|(){}#", 1); /* flow through if quoted */
2163 mapset(ifs, 2); /* also flow through if quoted */
2166 /* most recursion does not come through here, the exeception is
2167 * from builtin_source() */
2168 int parse_stream_outer(struct in_str *inp)
2171 struct p_context ctx;
2172 o_string temp=NULL_O_STRING;
2175 initialize_context(&ctx);
2178 rcode = parse_stream(&temp, &ctx, inp, '\n');
2179 done_word(&temp, &ctx);
2180 done_pipe(&ctx,PIPE_SEQ);
2181 run_list(ctx.list_head);
2182 } while (rcode != -1); /* loop on syntax errors, return on EOF */
2186 static int parse_string_outer(const char *s)
2188 struct in_str input;
2189 setup_string_in_str(&input, s);
2190 return parse_stream_outer(&input);
2193 static int parse_file_outer(FILE *f)
2196 struct in_str input;
2197 setup_file_in_str(&input, f);
2198 rcode = parse_stream_outer(&input);
2202 int shell_main(int argc, char **argv)
2206 struct jobset joblist_end = { NULL, NULL };
2207 job_list = &joblist_end;
2209 last_return_code=EXIT_SUCCESS;
2211 /* XXX what should these be while sourcing /etc/profile? */
2215 /* don't pay any attention to this signal; it just confuses
2216 things and isn't really meant for shells anyway */
2217 signal(SIGTTOU, SIG_IGN);
2219 if (argv[0] && argv[0][0] == '-') {
2220 debug_printf("\nsourcing /etc/profile\n");
2221 input = xfopen("/etc/profile", "r");
2222 mark_open(fileno(input));
2223 parse_file_outer(input);
2224 mark_closed(fileno(input));
2229 /* initialize the cwd -- this is never freed...*/
2231 #ifdef BB_FEATURE_COMMAND_EDITING
2232 cmdedit_set_initial_prompt();
2237 while ((opt = getopt(argc, argv, "c:xif")) > 0) {
2241 global_argv = argv+optind;
2242 global_argc = argc-optind;
2243 opt = parse_string_outer(optarg);
2254 fprintf(stderr, "Usage: sh [FILE]...\n"
2255 " or: sh -c command [args]...\n\n");
2259 /* A shell is interactive if the `-i' flag was given, or if all of
2260 * the following conditions are met:
2262 * no arguments remaining or the -s flag given
2263 * standard input is a terminal
2264 * standard output is a terminal
2265 * Refer to Posix.2, the description of the `sh' utility. */
2266 if (argv[optind]==NULL && input==stdin &&
2267 isatty(fileno(stdin)) && isatty(fileno(stdout))) {
2271 debug_printf("\ninteractive=%d\n", interactive);
2273 /* Looks like they want an interactive shell */
2274 fprintf(stdout, "\nhush -- the humble shell v0.01 (testing)\n\n");
2275 opt=parse_file_outer(stdin);
2279 debug_printf("\nrunning script '%s'\n", argv[optind]);
2280 global_argv = argv+optind;
2281 global_argc = argc-optind;
2282 input = xfopen(argv[optind], "r");
2283 opt = parse_file_outer(input);
2285 #ifdef BB_FEATURE_CLEAN_UP
2290 return(opt?opt:last_return_code);