Comment that the regex.c fix needs to stay until we no longer support Automate-1.9
[findutils.git] / xargs / xargs.c
blob1394fa39d38f355914634d9c065fce34f309bdda
1 /* xargs -- build and execute command lines from standard input
2 Copyright (C) 1990, 91, 92, 93, 94, 2000, 2003, 2004, 2005, 2006,
3 2007 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 /* Written by Mike Rendell <michael@cs.mun.ca>
20 and David MacKenzie <djm@gnu.org>.
21 Modifications by
22 James Youngman
23 Dmitry V. Levin
26 #include <config.h>
28 # ifndef PARAMS
29 # if defined PROTOTYPES || (defined __STDC__ && __STDC__)
30 # define PARAMS(Args) Args
31 # else
32 # define PARAMS(Args) ()
33 # endif
34 # endif
36 #include <ctype.h>
38 #if !defined (isascii) || defined (STDC_HEADERS)
39 #ifdef isascii
40 #undef isascii
41 #endif
42 #define isascii(c) 1
43 #endif
45 #ifdef isblank
46 #define ISBLANK(c) (isascii (c) && isblank (c))
47 #else
48 #define ISBLANK(c) ((c) == ' ' || (c) == '\t')
49 #endif
51 #define ISSPACE(c) (ISBLANK (c) || (c) == '\n' || (c) == '\r' \
52 || (c) == '\f' || (c) == '\v')
54 #include <sys/types.h>
55 #include <stdio.h>
56 #include <errno.h>
57 #include <getopt.h>
58 #include <fcntl.h>
60 #if defined STDC_HEADERS
61 #include <assert.h>
62 #endif
64 #if defined HAVE_STRING_H || defined STDC_HEADERS
65 #include <string.h>
66 #if !defined STDC_HEADERS
67 #include <memory.h>
68 #endif
69 #else
70 #include <strings.h>
71 #define memcpy(dest, source, count) (bcopy((source), (dest), (count)))
72 #endif
74 #ifndef _POSIX_SOURCE
75 #include <sys/param.h>
76 #endif
78 #ifdef HAVE_LIMITS_H
79 #include <limits.h>
80 #endif
82 #ifndef LONG_MAX
83 #define LONG_MAX (~(1 << (sizeof (long) * 8 - 1)))
84 #endif
86 /* The presence of unistd.h is assumed by gnulib these days, so we
87 * might as well assume it too.
89 #include <unistd.h>
91 #include <signal.h>
93 #if !defined(SIGCHLD) && defined(SIGCLD)
94 #define SIGCHLD SIGCLD
95 #endif
97 #include "verify.h"
98 #include "wait.h"
99 #include "quotearg.h"
100 #include "findutils-version.h"
103 #ifdef STDC_HEADERS
104 #include <stdlib.h>
105 #else
106 extern int errno;
107 #endif
109 #ifdef HAVE_LOCALE_H
110 #include <locale.h>
111 #endif
112 #if ENABLE_NLS
113 # include <libintl.h>
114 # define _(Text) gettext (Text)
115 #else
116 # define _(Text) Text
117 #define textdomain(Domain)
118 #define bindtextdomain(Package, Directory)
119 #endif
120 #ifdef gettext_noop
121 # define N_(String) gettext_noop (String)
122 #else
123 /* See locate.c for explanation as to why not use (String) */
124 # define N_(String) String
125 #endif
127 #include "buildcmd.h"
130 /* Return nonzero if S is the EOF string. */
131 #define EOF_STR(s) (eof_str && *eof_str == *s && !strcmp (eof_str, s))
133 /* Do multibyte processing if multibyte characters are supported,
134 unless multibyte sequences are search safe. Multibyte sequences
135 are search safe if searching for a substring using the byte
136 comparison function 'strstr' gives no false positives. All 8-bit
137 encodings and the UTF-8 multibyte encoding are search safe, but
138 the EUC encodings are not.
139 BeOS uses the UTF-8 encoding exclusively, so it is search safe. */
140 #if defined __BEOS__
141 # define MULTIBYTE_IS_SEARCH_SAFE 1
142 #endif
143 #define DO_MULTIBYTE (HAVE_MBLEN && ! MULTIBYTE_IS_SEARCH_SAFE)
145 #if DO_MULTIBYTE
146 # if HAVE_MBRLEN
147 # include <wchar.h>
148 # else
149 /* Simulate mbrlen with mblen as best we can. */
150 # define mbstate_t int
151 # define mbrlen(s, n, ps) mblen (s, n)
152 # endif
153 #endif
155 /* Not char because of type promotion; NeXT gcc can't handle it. */
156 typedef int boolean;
157 #define true 1
158 #define false 0
160 #if __STDC__
161 #define VOID void
162 #else
163 #define VOID char
164 #endif
166 #include <xalloc.h>
167 #include "closein.h"
168 #include "gnulib-version.h"
170 void error PARAMS ((int status, int errnum, char *message,...));
172 extern char *version_string;
174 /* The name this program was run with. */
175 char *program_name;
177 static FILE *input_stream;
179 /* Buffer for reading arguments from input. */
180 static char *linebuf;
182 static int keep_stdin = 0;
184 /* Line number in stdin since the last command was executed. */
185 static int lineno = 0;
187 static struct buildcmd_state bc_state;
188 static struct buildcmd_control bc_ctl;
190 /* Did we already complain about NUL characters in the input? */
191 static int nullwarning_given = 0;
194 /* If nonzero, when this string is read on stdin it is treated as
195 end of file.
196 IEEE Std 1003.1, 2004 Edition allows this to be NULL.
197 In findutils releases up to and including 4.2.8, this was "_".
199 static char *eof_str = NULL;
201 /* Number of chars in the initial args. */
202 /* static int initial_argv_chars = 0; */
204 /* true when building up initial arguments in `cmd_argv'. */
205 static boolean initial_args = true;
207 /* If nonzero, the maximum number of child processes that can be running
208 at once. */
209 static int proc_max = 1;
211 /* Total number of child processes that have been executed. */
212 static int procs_executed = 0;
214 /* The number of elements in `pids'. */
215 static int procs_executing = 0;
217 /* List of child processes currently executing. */
218 static pid_t *pids = NULL;
220 /* The number of allocated elements in `pids'. */
221 static int pids_alloc = 0;
223 /* Exit status; nonzero if any child process exited with a
224 status of 1-125. */
225 static volatile int child_error = 0;
227 static volatile int original_exit_value;
229 /* If true, print each command on stderr before executing it. */
230 static boolean print_command = false; /* Option -t */
232 /* If true, query the user before executing each command, and only
233 execute the command if the user responds affirmatively. */
234 static boolean query_before_executing = false;
236 /* The delimiter for input arguments. This is only consulted if the
237 * -0 or -d option had been given.
239 static char input_delimiter = '\0';
242 static struct option const longopts[] =
244 {"null", no_argument, NULL, '0'},
245 {"arg-file", required_argument, NULL, 'a'},
246 {"delimiter", required_argument, NULL, 'd'},
247 {"eof", optional_argument, NULL, 'e'},
248 {"replace", optional_argument, NULL, 'I'},
249 {"max-lines", optional_argument, NULL, 'l'},
250 {"max-args", required_argument, NULL, 'n'},
251 {"interactive", no_argument, NULL, 'p'},
252 {"no-run-if-empty", no_argument, NULL, 'r'},
253 {"max-chars", required_argument, NULL, 's'},
254 {"verbose", no_argument, NULL, 't'},
255 {"show-limits", no_argument, NULL, 'S'},
256 {"exit", no_argument, NULL, 'x'},
257 {"max-procs", required_argument, NULL, 'P'},
258 {"version", no_argument, NULL, 'v'},
259 {"help", no_argument, NULL, 'h'},
260 {NULL, no_argument, NULL, 0}
263 static int read_line PARAMS ((void));
264 static int read_string PARAMS ((void));
265 static boolean print_args PARAMS ((boolean ask));
266 /* static void do_exec PARAMS ((void)); */
267 static int xargs_do_exec (const struct buildcmd_control *cl, struct buildcmd_state *state);
268 static void exec_if_possible PARAMS ((void));
269 static void add_proc PARAMS ((pid_t pid));
270 static void wait_for_proc PARAMS ((boolean all));
271 static void wait_for_proc_all PARAMS ((void));
272 static long parse_num PARAMS ((char *str, int option, long min, long max, int fatal));
273 static void usage PARAMS ((FILE * stream));
277 static char
278 get_char_oct_or_hex_escape(const char *s)
280 const char * p;
281 int base = 8;
282 unsigned long val;
283 char *endp;
285 assert ('\\' == s[0]);
287 if ('x' == s[1])
289 /* hex */
290 p = s+2;
291 base = 16;
293 else if (isdigit(s[1]))
295 /* octal */
296 p = s+1;
297 base = 8;
299 else
301 p = NULL; /* Silence compiler warning. */
302 error(1, 0,
303 _("Invalid escape sequence %s in input delimiter specification."),
306 errno = 0;
307 endp = (char*)p;
308 val = strtoul(p, &endp, base);
310 /* This if condition is carefully constructed to do
311 * the right thing if UCHAR_MAX has the same
312 * value as ULONG_MAX. IF UCHAR_MAX==ULONG_MAX,
313 * then val can never be greater than UCHAR_MAX.
315 if ((ULONG_MAX == val && ERANGE == errno)
316 || (val > UCHAR_MAX))
318 if (16 == base)
320 error(1, 0,
321 _("Invalid escape sequence %s in input delimiter specification; character values must not exceed %lx."),
322 s, (unsigned long)UCHAR_MAX);
324 else
326 error(1, 0,
327 _("Invalid escape sequence %s in input delimiter specification; character values must not exceed %lo."),
328 s, (unsigned long)UCHAR_MAX);
332 /* check for trailing garbage */
333 if (0 != *endp)
335 error(1, 0,
336 _("Invalid escape sequence %s in input delimiter specification; trailing characters %s not recognised."),
337 s, endp);
340 return (char) val;
344 static char
345 get_input_delimiter(const char *s)
347 if (1 == strlen(s))
349 return s[0];
351 else
353 if ('\\' == s[0])
355 /* an escape code */
356 switch (s[1])
358 case 'a':
359 return '\a';
360 case 'b':
361 return '\b';
362 case 'f':
363 return '\f';
364 case 'n':
365 return '\n';
366 case 'r':
367 return '\r';
368 case 't':
369 return'\t';
370 case 'v':
371 return '\v';
372 case '\\':
373 return '\\';
374 default:
375 return get_char_oct_or_hex_escape(s);
378 else
380 error(1, 0,
381 _("Invalid input delimiter specification %s: the delimiter must be either a single character or an escape sequence starting with \\."),
383 /*NOTREACHED*/
384 return 0;
389 static void
390 noop (void)
392 /* does nothing. */
395 static void
396 fail_due_to_env_size (void)
398 error (1, 0, _("environment is too large for exec"));
403 main (int argc, char **argv)
405 int optc;
406 int show_limits = 0; /* --show-limits */
407 int always_run_command = 1;
408 char *input_file = "-"; /* "-" is stdin */
409 char *default_cmd = "/bin/echo";
410 int (*read_args) PARAMS ((void)) = read_line;
411 void (*act_on_init_result)(void) = noop;
412 enum BC_INIT_STATUS bcstatus;
413 enum { XARGS_POSIX_HEADROOM = 2048u };
415 program_name = argv[0];
416 original_exit_value = 0;
418 #ifdef HAVE_SETLOCALE
419 setlocale (LC_ALL, "");
420 #endif
421 bindtextdomain (PACKAGE, LOCALEDIR);
422 textdomain (PACKAGE);
423 atexit (close_stdin);
424 atexit (wait_for_proc_all);
426 /* xargs is required by POSIX to allow 2048 bytes of headroom
427 * for extra environment variables (that perhaps the utliity might
428 * want to set before execing something else).
430 bcstatus = bc_init_controlinfo(&bc_ctl, XARGS_POSIX_HEADROOM);
432 /* The bc_init_controlinfo call may have determined that the
433 * environment is too big. In that case, we will fail with
434 * an error message after processing the command-line options,
435 * as "xargs --help" should still work even if the environment is
436 * too big.
438 * Some of the argument processing depends on the contents of
439 * bc_ctl, which will be in an undefined state if bc_init_controlinfo()
440 * failed.
442 if (BC_INIT_ENV_TOO_BIG == bcstatus)
444 act_on_init_result = fail_due_to_env_size;
446 else if (BC_INIT_CANNOT_ACCOMODATE_HEADROOM == bcstatus)
448 /* All POSIX systems are required to support ARG_MAX of at least
449 * 4096. For everything to work the total of (command line +
450 * headroom + environment) must fit into this. POSIX requires
451 * that we use a headroom of 2048 bytes. The user is in control
452 * of the size of the environment.
454 * In general if bc_init_controlinfo() returns
455 * BC_INIT_CANNOT_ACCOMODATE_HEADROOM, its caller can try again
456 * with a smaller headroom. However, in the case of xargs, this
457 * would not be POSIX-compliant.
459 act_on_init_result = fail_due_to_env_size;
461 else
463 /* IEEE Std 1003.1, 2003 specifies that the combined argument and
464 * environment list shall not exceed {ARG_MAX}-2048 bytes. It also
465 * specifies that it shall be at least LINE_MAX.
467 #ifdef _SC_ARG_MAX
468 long val = sysconf(_SC_ARG_MAX);
469 if (val > 0)
471 /* Note that val can in fact be greater than ARG_MAX
472 * and bc_ctl.arg_max can also be greater than ARG_MAX.
474 assert (bc_ctl.arg_max <= (val-XARGS_POSIX_HEADROOM));
476 else
478 # if defined ARG_MAX
479 assert (bc_ctl.arg_max <= (ARG_MAX-XARGS_POSIX_HEADROOM));
480 # endif
482 #else
483 /* No _SC_ARG_MAX */
484 assert (bc_ctl.arg_max <= (ARG_MAX-XARGS_POSIX_HEADROOM));
485 #endif
488 #ifdef LINE_MAX
489 /* This assertion ensures that this xargs implementation
490 * conforms to the POSIX requirement that the default command
491 * line length shall be at least LINE_MAX.
493 assert (bc_ctl.arg_max >= LINE_MAX);
494 #endif
496 bc_ctl.exec_callback = xargs_do_exec;
498 /* Start with a reasonable default size, though this can be
499 * adjusted via the -s option.
501 bc_use_sensible_arg_max(&bc_ctl);
504 while ((optc = getopt_long (argc, argv, "+0a:E:e::i::I:l::L:n:prs:txP:d:",
505 longopts, (int *) 0)) != -1)
507 switch (optc)
509 case '0':
510 read_args = read_string;
511 input_delimiter = '\0';
512 break;
514 case 'd':
515 read_args = read_string;
516 input_delimiter = get_input_delimiter(optarg);
517 break;
519 case 'E': /* POSIX */
520 case 'e': /* deprecated */
521 if (optarg && (strlen(optarg) > 0))
522 eof_str = optarg;
523 else
524 eof_str = 0;
525 break;
527 case 'h':
528 usage (stdout);
529 return 0;
531 case 'I': /* POSIX */
532 case 'i': /* deprecated */
533 if (optarg)
534 bc_ctl.replace_pat = optarg;
535 else
536 bc_ctl.replace_pat = "{}";
537 /* -i excludes -n -l. */
538 bc_ctl.args_per_exec = 0;
539 bc_ctl.lines_per_exec = 0;
540 break;
542 case 'L': /* POSIX */
543 bc_ctl.lines_per_exec = parse_num (optarg, 'L', 1L, -1L, 1);
544 /* -L excludes -i -n. */
545 bc_ctl.args_per_exec = 0;
546 bc_ctl.replace_pat = NULL;
547 break;
549 case 'l': /* deprecated */
550 if (optarg)
551 bc_ctl.lines_per_exec = parse_num (optarg, 'l', 1L, -1L, 1);
552 else
553 bc_ctl.lines_per_exec = 1;
554 /* -l excludes -i -n. */
555 bc_ctl.args_per_exec = 0;
556 bc_ctl.replace_pat = NULL;
557 break;
559 case 'n':
560 bc_ctl.args_per_exec = parse_num (optarg, 'n', 1L, -1L, 1);
561 /* -n excludes -i -l. */
562 bc_ctl.lines_per_exec = 0;
563 if (bc_ctl.args_per_exec == 1 && bc_ctl.replace_pat)
564 /* ignore -n1 in '-i -n1' */
565 bc_ctl.args_per_exec = 0;
566 else
567 bc_ctl.replace_pat = NULL;
568 break;
570 /* The POSIX standard specifies that it is not an error
571 * for the -s option to specify a size that the implementation
572 * cannot support - in that case, the relevant limit is used.
574 case 's':
576 size_t arg_size;
577 act_on_init_result();
578 arg_size = parse_num (optarg, 's', 1L,
579 bc_ctl.posix_arg_size_max, 0);
580 if (arg_size > bc_ctl.posix_arg_size_max)
582 error (0, 0,
583 _("warning: value %ld for -s option is too large, "
584 "using %ld instead"),
585 arg_size, bc_ctl.posix_arg_size_max);
586 arg_size = bc_ctl.posix_arg_size_max;
588 bc_ctl.arg_max = arg_size;
590 break;
592 case 'S':
593 show_limits = true;
594 break;
596 case 't':
597 print_command = true;
598 break;
600 case 'x':
601 bc_ctl.exit_if_size_exceeded = true;
602 break;
604 case 'p':
605 query_before_executing = true;
606 print_command = true;
607 break;
609 case 'r':
610 always_run_command = 0;
611 break;
613 case 'P':
614 proc_max = parse_num (optarg, 'P', 0L, -1L, 1);
615 break;
617 case 'a':
618 input_file = optarg;
619 break;
621 case 'v':
622 display_findutils_version("xargs");
623 return 0;
625 default:
626 usage (stderr);
627 return 1;
631 /* If we had deferred failing due to problems in bc_init_controlinfo(),
632 * do it now.
634 * We issue this error message after processing command line
635 * arguments so that it is possible to use "xargs --help" even if
636 * the environment is too large.
638 act_on_init_result();
639 assert (BC_INIT_OK == bcstatus);
641 if (0 == strcmp (input_file, "-"))
643 input_stream = stdin;
645 else
647 keep_stdin = 1; /* see prep_child_for_exec() */
648 input_stream = fopen (input_file, "r");
649 if (NULL == input_stream)
651 error (1, errno,
652 _("Cannot open input file %s"),
653 quotearg_n_style(0, locale_quoting_style, input_file));
657 if (bc_ctl.replace_pat || bc_ctl.lines_per_exec)
658 bc_ctl.exit_if_size_exceeded = true;
660 if (optind == argc)
662 optind = 0;
663 argc = 1;
664 argv = &default_cmd;
667 /* We want to be able to print size_t values as unsigned long, so if
668 * the cast isn't value-preserving, we have a problem. This isn't a
669 * problem in C89, because size_t was known to be no wider than
670 * unsigned long. In C99 this is no longer the case, but there are
671 * special C99 ways to print such values. Unfortunately this
672 * program tries to work on both C89 and C99 systems.
674 #if defined SIZE_MAX
675 # if SIZE_MAX > ULONG_MAX
676 # error "I'm not sure how to print size_t values on your system"
677 # endif
678 #else
679 /* Without SIZE_MAX (i.e. limits.h) this is probably
680 * close to the best we can do.
682 verify_true (sizeof(size_t) <= sizeof(unsigned long));
683 #endif
685 if (show_limits)
687 fprintf(stderr,
688 _("Your environment variables take up %lu bytes\n"),
689 (unsigned long)bc_size_of_environment());
690 fprintf(stderr,
691 _("POSIX upper limit on argument length (this system): %lu\n"),
692 (unsigned long)bc_ctl.posix_arg_size_max);
693 fprintf(stderr,
694 _("POSIX smallest allowable upper limit on argument length (all systems): %lu\n"),
695 (unsigned long)bc_ctl.posix_arg_size_min);
696 fprintf(stderr,
697 _("Maximum length of command we could actually use: %ld\n"),
698 (unsigned long)(bc_ctl.posix_arg_size_max -
699 bc_size_of_environment()));
700 fprintf(stderr,
701 _("Size of command buffer we are actually using: %lu\n"),
702 (unsigned long)bc_ctl.arg_max);
704 if (isatty(STDIN_FILENO))
706 fprintf(stderr,
707 _("\n"
708 "Execution of xargs will continue now, and it will "
709 "try to read its input and run commands; if this is "
710 "not what you wanted to happen, please type the "
711 "end-of-file keystroke.\n"));
712 if (always_run_command)
714 fprintf(stderr,
715 _("Warning: %s will be run at least once. "
716 "If you do not want that to happen, then press "
717 "the interrupt keystroke.\n"),
718 argv[optind]);
723 linebuf = xmalloc (bc_ctl.arg_max + 1);
724 bc_state.argbuf = xmalloc (bc_ctl.arg_max + 1);
726 /* Make sure to listen for the kids. */
727 signal (SIGCHLD, SIG_DFL);
729 if (!bc_ctl.replace_pat)
731 for (; optind < argc; optind++)
732 bc_push_arg (&bc_ctl, &bc_state,
733 argv[optind], strlen (argv[optind]) + 1,
734 NULL, 0,
735 initial_args);
736 initial_args = false;
737 bc_ctl.initial_argc = bc_state.cmd_argc;
738 bc_state.cmd_initial_argv_chars = bc_state.cmd_argv_chars;
740 while ((*read_args) () != -1)
741 if (bc_ctl.lines_per_exec && lineno >= bc_ctl.lines_per_exec)
743 xargs_do_exec (&bc_ctl, &bc_state);
744 lineno = 0;
747 /* SYSV xargs seems to do at least one exec, even if the
748 input is empty. */
749 if (bc_state.cmd_argc != bc_ctl.initial_argc
750 || (always_run_command && procs_executed == 0))
751 xargs_do_exec (&bc_ctl, &bc_state);
754 else
756 int i;
757 size_t len;
758 size_t *arglen = xmalloc (sizeof (size_t) * argc);
760 for (i = optind; i < argc; i++)
761 arglen[i] = strlen(argv[i]);
762 bc_ctl.rplen = strlen (bc_ctl.replace_pat);
763 while ((len = (*read_args) ()) != -1)
765 /* Don't do insert on the command name. */
766 bc_clear_args(&bc_ctl, &bc_state);
767 bc_state.cmd_argv_chars = 0; /* begin at start of buffer */
769 bc_push_arg (&bc_ctl, &bc_state,
770 argv[optind], arglen[optind] + 1,
771 NULL, 0,
772 initial_args);
773 len--;
774 initial_args = false;
776 for (i = optind + 1; i < argc; i++)
777 bc_do_insert (&bc_ctl, &bc_state,
778 argv[i], arglen[i],
779 NULL, 0,
780 linebuf, len,
781 initial_args);
782 xargs_do_exec (&bc_ctl, &bc_state);
786 original_exit_value = child_error;
787 return child_error;
791 /* Read a line of arguments from the input and add them to the list of
792 arguments to pass to the command. Ignore blank lines and initial blanks.
793 Single and double quotes and backslashes quote metacharacters and blanks
794 as they do in the shell.
795 Return -1 if eof (either physical or logical) is reached,
796 otherwise the length of the last string read (including the null). */
798 static int
799 read_line (void)
801 /* States for read_line. */
802 enum read_line_state
804 NORM = 0,
805 SPACE = 1,
806 QUOTE = 2,
807 BACKSLASH = 3
809 static boolean eof = false;
810 /* Start out in mode SPACE to always strip leading spaces (even with -i). */
811 enum read_line_state state = SPACE; /* The type of character we last read. */
812 int prevc; /* The previous value of c. */
813 int quotc = 0; /* The last quote character read. */
814 int c = EOF;
815 boolean first = true; /* true if reading first arg on line. */
816 boolean seen_arg = false; /* true if we have seen any arg (or part of one) yet */
817 int len;
818 char *p = linebuf;
819 /* Including the NUL, the args must not grow past this point. */
820 char *endbuf = linebuf + bc_ctl.arg_max - bc_state.cmd_initial_argv_chars - 1;
822 if (eof)
823 return -1;
824 while (1)
826 prevc = c;
827 c = getc (input_stream);
829 if (c == EOF)
831 /* COMPAT: SYSV seems to ignore stuff on a line that
832 ends without a \n; we don't. */
833 eof = true;
834 if (p == linebuf)
835 return -1;
836 *p++ = '\0';
837 len = p - linebuf;
838 if (state == QUOTE)
840 exec_if_possible ();
841 error (1, 0, _("unmatched %s quote; by default quotes are special to xargs unless you use the -0 option"),
842 quotc == '"' ? _("double") : _("single"));
844 if (first && EOF_STR (linebuf))
845 return -1;
846 if (!bc_ctl.replace_pat)
847 bc_push_arg (&bc_ctl, &bc_state,
848 linebuf, len,
849 NULL, 0,
850 initial_args);
851 return len;
853 switch (state)
855 case SPACE:
856 if (ISSPACE (c))
857 continue;
858 state = NORM;
859 /* aaahhhh.... */
861 case NORM:
862 if (c == '\n')
864 if (!ISBLANK (prevc))
865 lineno++; /* For -l. */
866 if (p == linebuf)
868 if (seen_arg)
870 /* An empty argument, add it to the list as normal. */
872 else
874 /* Blank line. */
875 state = SPACE;
876 continue;
879 *p++ = '\0';
880 len = p - linebuf;
881 if (EOF_STR (linebuf))
883 eof = true;
884 return first ? -1 : len;
886 if (!bc_ctl.replace_pat)
887 bc_push_arg (&bc_ctl, &bc_state,
888 linebuf, len,
889 NULL, 0,
890 initial_args);
891 return len;
893 seen_arg = true;
895 /* POSIX: In the POSIX locale, the separators are <SPC> and
896 * <TAB>, but not <FF> or <VT>.
898 if (!bc_ctl.replace_pat && ISBLANK (c))
900 *p++ = '\0';
901 len = p - linebuf;
902 if (EOF_STR (linebuf))
904 eof = true;
905 return first ? -1 : len;
907 bc_push_arg (&bc_ctl, &bc_state,
908 linebuf, len,
909 NULL, 0,
910 initial_args);
911 p = linebuf;
912 state = SPACE;
913 first = false;
914 continue;
916 switch (c)
918 case '\\':
919 state = BACKSLASH;
920 continue;
922 case '\'':
923 case '"':
924 state = QUOTE;
925 quotc = c;
926 continue;
928 break;
930 case QUOTE:
931 if (c == '\n')
933 exec_if_possible ();
934 error (1, 0, _("unmatched %s quote; by default quotes are special to xargs unless you use the -0 option"),
935 quotc == '"' ? _("double") : _("single"));
937 if (c == quotc)
939 state = NORM;
940 seen_arg = true; /* Makes a difference for e.g. just '' or "" as the first arg on a line */
941 continue;
943 break;
945 case BACKSLASH:
946 state = NORM;
947 break;
950 if ( (0 == c) && !nullwarning_given )
952 /* This is just a warning message. We only issue it once. */
953 error (0, 0,
954 _("warning: a NUL character occurred in the input. "
955 "It cannot be passed through in the argument list. "
956 "Did you mean to use the --null option?"));
957 nullwarning_given = 1;
960 #if 1
961 if (p >= endbuf)
963 exec_if_possible ();
964 error (1, 0, _("argument line too long"));
966 *p++ = c;
967 #else
968 append_char_to_buf(&linebuf, &endbuf, &p, c);
969 #endif
973 /* Read a null-terminated string from the input and add it to the list of
974 arguments to pass to the command.
975 Return -1 if eof (either physical or logical) is reached,
976 otherwise the length of the string read (including the null). */
978 static int
979 read_string (void)
981 static boolean eof = false;
982 int len;
983 char *p = linebuf;
984 /* Including the NUL, the args must not grow past this point. */
985 char *endbuf = linebuf + bc_ctl.arg_max - bc_state.cmd_initial_argv_chars - 1;
987 if (eof)
988 return -1;
989 while (1)
991 int c = getc (input_stream);
992 if (c == EOF)
994 eof = true;
995 if (p == linebuf)
996 return -1;
997 *p++ = '\0';
998 len = p - linebuf;
999 if (!bc_ctl.replace_pat)
1000 bc_push_arg (&bc_ctl, &bc_state,
1001 linebuf, len,
1002 NULL, 0,
1003 initial_args);
1004 return len;
1006 if (c == input_delimiter)
1008 lineno++; /* For -l. */
1009 *p++ = '\0';
1010 len = p - linebuf;
1011 if (!bc_ctl.replace_pat)
1012 bc_push_arg (&bc_ctl, &bc_state,
1013 linebuf, len,
1014 NULL, 0,
1015 initial_args);
1016 return len;
1018 if (p >= endbuf)
1020 exec_if_possible ();
1021 error (1, 0, _("argument line too long"));
1023 *p++ = c;
1027 /* Print the arguments of the command to execute.
1028 If ASK is nonzero, prompt the user for a response, and
1029 if the user responds affirmatively, return true;
1030 otherwise, return false. */
1032 static boolean
1033 print_args (boolean ask)
1035 int i;
1037 for (i = 0; i < bc_state.cmd_argc - 1; i++)
1038 fprintf (stderr, "%s ", bc_state.cmd_argv[i]);
1039 if (ask)
1041 static FILE *tty_stream;
1042 int c, savec;
1044 if (!tty_stream)
1046 tty_stream = fopen ("/dev/tty", "r");
1047 if (!tty_stream)
1048 error (1, errno, "/dev/tty");
1050 fputs ("?...", stderr);
1051 fflush (stderr);
1052 c = savec = getc (tty_stream);
1053 while (c != EOF && c != '\n')
1054 c = getc (tty_stream);
1055 if (savec == 'y' || savec == 'Y')
1056 return true;
1058 else
1059 putc ('\n', stderr);
1061 return false;
1065 /* Close stdin and attach /dev/null to it.
1066 * This resolves Savannah bug #3992.
1068 static void
1069 prep_child_for_exec (void)
1071 if (!keep_stdin)
1073 const char inputfile[] = "/dev/null";
1074 /* fprintf(stderr, "attaching stdin to /dev/null\n"); */
1076 close(0);
1077 if (open(inputfile, O_RDONLY) < 0)
1079 /* This is not entirely fatal, since
1080 * executing the child with a closed
1081 * stdin is almost as good as executing it
1082 * with its stdin attached to /dev/null.
1084 error (0, errno, "%s", quotearg_n_style(0, locale_quoting_style, inputfile));
1090 /* Execute the command that has been built in `cmd_argv'. This may involve
1091 waiting for processes that were previously executed. */
1093 static int
1094 xargs_do_exec (const struct buildcmd_control *ctl, struct buildcmd_state *state)
1096 pid_t child;
1098 (void) ctl;
1099 (void) state;
1101 bc_push_arg (&bc_ctl, &bc_state,
1102 (char *) NULL, 0,
1103 NULL, 0,
1104 false); /* Null terminate the arg list. */
1106 if (!query_before_executing || print_args (true))
1108 if (proc_max && procs_executing >= proc_max)
1109 wait_for_proc (false);
1110 if (!query_before_executing && print_command)
1111 print_args (false);
1112 /* If we run out of processes, wait for a child to return and
1113 try again. */
1114 while ((child = fork ()) < 0 && errno == EAGAIN && procs_executing)
1115 wait_for_proc (false);
1116 switch (child)
1118 case -1:
1119 error (1, errno, _("cannot fork"));
1121 case 0: /* Child. */
1122 prep_child_for_exec();
1123 execvp (bc_state.cmd_argv[0], bc_state.cmd_argv);
1124 error (0, errno, "%s", bc_state.cmd_argv[0]);
1125 _exit (errno == ENOENT ? 127 : 126);
1126 /*NOTREACHED*/
1128 add_proc (child);
1131 bc_clear_args(&bc_ctl, &bc_state);
1132 return 1; /* Success */
1135 /* Execute the command if possible. */
1137 static void
1138 exec_if_possible (void)
1140 if (bc_ctl.replace_pat || initial_args ||
1141 bc_state.cmd_argc == bc_ctl.initial_argc || bc_ctl.exit_if_size_exceeded)
1142 return;
1143 xargs_do_exec (&bc_ctl, &bc_state);
1146 /* Add the process with id PID to the list of processes that have
1147 been executed. */
1149 static void
1150 add_proc (pid_t pid)
1152 int i;
1154 /* Find an empty slot. */
1155 for (i = 0; i < pids_alloc && pids[i]; i++)
1157 if (i == pids_alloc)
1159 if (pids_alloc == 0)
1161 pids_alloc = proc_max ? proc_max : 64;
1162 pids = xmalloc (sizeof (pid_t) * pids_alloc);
1164 else
1166 pids_alloc *= 2;
1167 pids = xrealloc (pids,
1168 sizeof (pid_t) * pids_alloc);
1170 memset (&pids[i], '\0', sizeof (pid_t) * (pids_alloc - i));
1172 pids[i] = pid;
1173 procs_executing++;
1174 procs_executed++;
1177 /* If ALL is true, wait for all child processes to finish;
1178 otherwise, wait for one child process to finish.
1179 Remove the processes that finish from the list of executing processes. */
1181 static void
1182 wait_for_proc (boolean all)
1184 while (procs_executing)
1186 int i, status;
1190 pid_t pid;
1192 while ((pid = wait (&status)) == (pid_t) -1)
1193 if (errno != EINTR)
1194 error (1, errno, _("error waiting for child process"));
1196 /* Find the entry in `pids' for the child process
1197 that exited. */
1198 for (i = 0; i < pids_alloc && pid != pids[i]; i++)
1201 while (i == pids_alloc); /* A child died that we didn't start? */
1203 /* Remove the child from the list. */
1204 pids[i] = 0;
1205 procs_executing--;
1207 if (WEXITSTATUS (status) == 126 || WEXITSTATUS (status) == 127)
1208 exit (WEXITSTATUS (status)); /* Can't find or run the command. */
1209 if (WEXITSTATUS (status) == 255)
1210 error (124, 0, _("%s: exited with status 255; aborting"), bc_state.cmd_argv[0]);
1211 if (WIFSTOPPED (status))
1212 error (125, 0, _("%s: stopped by signal %d"), bc_state.cmd_argv[0], WSTOPSIG (status));
1213 if (WIFSIGNALED (status))
1214 error (125, 0, _("%s: terminated by signal %d"), bc_state.cmd_argv[0], WTERMSIG (status));
1215 if (WEXITSTATUS (status) != 0)
1216 child_error = 123;
1218 if (!all)
1219 break;
1223 /* Wait for all child processes to finish. */
1225 static void
1226 wait_for_proc_all (void)
1228 static boolean waiting = false;
1230 if (waiting)
1231 return;
1233 waiting = true;
1234 wait_for_proc (true);
1235 waiting = false;
1237 if (original_exit_value != child_error)
1239 /* wait_for_proc() changed the value of child_error(). This
1240 * function is registered via atexit(), and so may have been
1241 * called from exit(). We now know that the original value
1242 * passed to exit() is no longer the exit status we require.
1243 * The POSIX standard states that the behaviour if exit() is
1244 * called more than once is undefined. Therefore we now have to
1245 * exit with _exit() instead of exit().
1247 _exit(child_error);
1252 /* Return the value of the number represented in STR.
1253 OPTION is the command line option to which STR is the argument.
1254 If the value does not fall within the boundaries MIN and MAX,
1255 Print an error message mentioning OPTION. If FATAL is true,
1256 we also exit. */
1258 static long
1259 parse_num (char *str, int option, long int min, long int max, int fatal)
1261 char *eptr;
1262 long val;
1264 val = strtol (str, &eptr, 10);
1265 if (eptr == str || *eptr)
1267 fprintf (stderr, _("%s: invalid number for -%c option\n"),
1268 program_name, option);
1269 usage (stderr);
1270 exit(1);
1272 else if (val < min)
1274 fprintf (stderr, _("%s: value for -%c option should be >= %ld\n"),
1275 program_name, option, min);
1276 if (fatal)
1278 usage (stderr);
1279 exit(1);
1281 else
1283 val = min;
1286 else if (max >= 0 && val > max)
1288 fprintf (stderr, _("%s: value for -%c option should be < %ld\n"),
1289 program_name, option, max);
1290 if (fatal)
1292 usage (stderr);
1293 exit(1);
1295 else
1297 val = max;
1300 return val;
1303 static void
1304 usage (FILE *stream)
1306 fprintf (stream, _("\
1307 Usage: %s [-0prtx] [--interactive] [--null] [-d|--delimiter=delim]\n\
1308 [-E eof-str] [-e[eof-str]] [--eof[=eof-str]]\n\
1309 [-L max-lines] [-l[max-lines]] [--max-lines[=max-lines]]\n\
1310 [-I replace-str] [-i[replace-str]] [--replace[=replace-str]]\n\
1311 [-n max-args] [--max-args=max-args]\n\
1312 [-s max-chars] [--max-chars=max-chars]\n\
1313 [-P max-procs] [--max-procs=max-procs] [--show-limits]\n\
1314 [--verbose] [--exit] [--no-run-if-empty] [--arg-file=file]\n\
1315 [--version] [--help] [command [initial-arguments]]\n"),
1316 program_name);
1317 fputs (_("\nReport bugs to <bug-findutils@gnu.org>.\n"), stream);