2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * $xMach: xargs.c,v 1.6 2002/02/23 05:27:47 tim Exp $
39 static const char copyright[] =
40 "@(#) Copyright (c) 1990, 1993\n\
41 The Regents of the University of California. All rights reserved.\n";
45 static char sccsid[] = "@(#)xargs.c 8.1 (Berkeley) 6/6/93";
48 #include <sys/cdefs.h>
49 __FBSDID("$FreeBSD$");
51 #include <sys/types.h>
54 #include <sys/limits.h>
55 #include <sys/resource.h>
70 #include "pathnames.h"
72 static void parse_input(int, char *[]);
73 static void prerun(int, char *[]);
74 static int prompt(void);
75 static void run(char **);
76 static void usage(void);
77 bool strnsubst(char **, const char *, const char *, size_t);
78 static pid_t xwait(int block, int *status);
79 static void xexit(const char *, const int);
80 static void waitchildren(const char *, int);
81 static void pids_init(void);
82 static int pids_empty(void);
83 static int pids_full(void);
84 static void pids_add(pid_t pid);
85 static int pids_remove(pid_t pid);
86 static int findslot(pid_t pid);
87 static int findfreeslot(void);
88 static void clearslot(int slot);
90 static char echo[] = _PATH_ECHO;
91 static char **av, **bxp, **ep, **endxp, **xp;
92 static char *argp, *bbp, *ebp, *inpline, *p, *replstr;
93 static const char *eofstr;
94 static int count, insingle, indouble, oflag, pflag, tflag, Rflag, rval, zflag;
95 static int cnt, Iflag, jfound, Lflag, Sflag, wasquoted, xflag;
96 static int curprocs, maxprocs;
97 static pid_t *childpids;
99 static volatile int childerr;
101 extern char **environ;
103 static const char *optstr = "+0E:I:J:L:n:oP:pR:S:s:rtx";
105 static const struct option long_options[] =
107 {"exit", no_argument, NULL, 'x'},
108 {"interactive", no_argument, NULL, 'p'},
109 {"max-args", required_argument, NULL, 'n'},
110 {"max-chars", required_argument, NULL, 's'},
111 {"max-procs", required_argument, NULL, 'P'},
112 {"no-run-if-empty", no_argument, NULL, 'r'},
113 {"null", no_argument, NULL, '0'},
114 {"verbose", no_argument, NULL, 't'},
116 {NULL, no_argument, NULL, 0},
120 main(int argc, char *argv[])
123 int ch, Jflag, nargs, nflag, nline;
129 inpline = replstr = NULL;
134 (void)setlocale(LC_ALL, "");
137 * POSIX.2 limits the exec line length to ARG_MAX - 2K. Running that
138 * caused some E2BIG errors, so it was changed to ARG_MAX - 4K. Given
139 * that the smallest argument is 2 bytes in length, this means that
140 * the number of arguments is limited to:
142 * (ARG_MAX - 4K - LENGTH(utility + arguments)) / 2.
144 * We arbitrarily limit the number of arguments to 5000. This is
145 * allowed by POSIX.2 as long as the resulting minimum exec line is
146 * at least LINE_MAX. Realloc'ing as necessary is possible, but
147 * probably not worthwhile.
150 if ((arg_max = sysconf(_SC_ARG_MAX)) == -1)
151 errx(1, "sysconf(_SC_ARG_MAX) failed");
152 nline = arg_max - 4 * 1024;
153 while (*ep != NULL) {
154 /* 1 byte for each '\0' */
155 nline -= strlen(*ep++) + 1 + sizeof(*ep);
158 while ((ch = getopt_long(argc, argv, optstr, long_options, NULL)) != -1)
175 Lflag = strtonum(optarg, 0, INT_MAX, &errstr);
177 errx(1, "-L %s: %s", optarg, errstr);
181 nargs = strtonum(optarg, 1, INT_MAX, &errstr);
183 errx(1, "-n %s: %s", optarg, errstr);
189 maxprocs = strtonum(optarg, 0, INT_MAX, &errstr);
191 errx(1, "-P %s: %s", optarg, errstr);
192 if (getrlimit(RLIMIT_NPROC, &rl) != 0)
193 errx(1, "getrlimit failed");
194 if (maxprocs == 0 || maxprocs > rl.rlim_cur)
195 maxprocs = rl.rlim_cur;
201 Rflag = strtol(optarg, &endptr, 10);
203 errx(1, "replacements must be a number");
206 /* GNU compatibility */
209 Sflag = strtoul(optarg, &endptr, 10);
211 errx(1, "replsize must be a number");
214 nline = strtonum(optarg, 0, INT_MAX, &errstr);
216 errx(1, "-s %s: %s", optarg, errstr);
246 if (replstr != NULL && *replstr == '\0')
247 errx(1, "replstr may not be empty");
252 * Allocate pointers for the utility name, the utility arguments,
253 * the maximum arguments to be read from stdin and the trailing
256 linelen = 1 + argc + nargs + 1;
257 if ((av = bxp = malloc(linelen * sizeof(char *))) == NULL)
258 errx(1, "malloc failed");
261 * Use the user's name for the utility as argv[0], just like the
262 * shell. Echo is the default. Set up pointers for the user's
266 cnt = strlen(*bxp++ = echo);
269 if (Jflag && strcmp(*argv, replstr) == 0) {
273 for (avj = argv; *avj; avj++)
274 cnt += strlen(*avj) + 1;
277 cnt += strlen(*bxp++ = *argv) + 1;
278 } while (*++argv != NULL);
282 * Set up begin/end/traversing pointers into the array. The -n
283 * count doesn't include the trailing NULL pointer, so the malloc
284 * added in an extra slot.
286 endxp = (xp = bxp) + nargs;
289 * Allocate buffer space for the arguments read from stdin and the
290 * trailing NULL. Buffer space is defined as the default or specified
291 * space, minus the length of the utility name and arguments. Set up
292 * begin/end/traversing pointers into the array. The -s count does
293 * include the trailing NULL, so the malloc didn't add in an extra
298 errx(1, "insufficient space for command");
300 if ((bbp = malloc((size_t)(nline + 1))) == NULL)
301 errx(1, "malloc failed");
302 ebp = (argp = p = bbp) + nline - 1;
304 parse_input(argc, argv);
308 parse_input(int argc, char *argv[])
315 switch (ch = getchar()) {
317 /* No arguments since last exec. */
319 waitchildren(*av, 1);
325 /* Quotes escape tabs and spaces. */
326 if (insingle || indouble || zflag)
332 * Increment 'count', so that nulls will be treated
333 * as end-of-line, as well as end-of-argument. This
334 * is needed so -0 works properly with -I and -L.
343 count++; /* Indicate end-of-line (used by -L) */
345 /* Quotes do not escape newlines. */
346 arg1: if (insingle || indouble) {
347 warnx("unterminated quote");
351 foundeof = *eofstr != '\0' &&
352 strncmp(argp, eofstr, p - argp) == 0;
354 /* Do not make empty args unless they are quoted */
355 if ((argp != p || wasquoted) && !foundeof) {
365 * If this string is not zero
366 * length, append a space for
367 * separation before the next
370 if ((curlen = strlen(inpline)))
371 strcat(inpline, " ");
375 * Allocate enough to hold what we will
376 * be holding in a second, and to append
377 * a space next time through, if we have
380 inpline = realloc(inpline, curlen + 2 +
382 if (inpline == NULL) {
383 warnx("realloc failed");
387 strcpy(inpline, argp);
389 strcat(inpline, argp);
394 * If max'd out on args or buffer, or reached EOF,
395 * run the command. If xflag and max'd out on buffer
396 * but not on args, object. Having reached the limit
397 * of input lines, as specified by -L is the same as
398 * maxing out on arguments.
400 if (xp == endxp || p > ebp || ch == EOF ||
401 (Lflag <= count && xflag) || foundeof) {
402 if (xflag && xp != endxp && p > ebp) {
403 warnx("insufficient space for arguments");
407 for (avj = argv; *avj; avj++)
411 if (ch == EOF || foundeof) {
412 waitchildren(*av, 1);
423 if (indouble || zflag)
425 insingle = !insingle;
429 if (insingle || zflag)
431 indouble = !indouble;
437 /* Backslash escapes anything, is escaped by quotes. */
438 if (!insingle && !indouble && (ch = getchar()) == EOF) {
439 warnx("backslash at EOF");
444 addch: if (p < ebp) {
449 /* If only one argument, not enough buffer space. */
451 warnx("insufficient space for argument");
454 /* Didn't hit argument limit, so if xflag object. */
456 warnx("insufficient space for arguments");
461 for (avj = argv; *avj; avj++)
467 memcpy(bbp, argp, (size_t)cnt);
468 p = (argp = bbp) + cnt;
475 * Do things necessary before run()'ing, such as -I substitution,
476 * and then call run().
479 prerun(int argc, char *argv[])
481 char **tmp, **tmp2, **avj;
486 if (argc == 0 || repls == 0) {
495 * Allocate memory to hold the argument list, and
496 * a NULL at the tail.
498 tmp = malloc((argc + 1) * sizeof(char *));
500 warnx("malloc failed");
506 * Save the first argument and iterate over it, we
507 * cannot do strnsubst() to it.
509 if ((*tmp++ = strdup(*avj++)) == NULL) {
510 warnx("strdup failed");
515 * For each argument to utility, if we have not used up
516 * the number of replacements we are allowed to do, and
517 * if the argument contains at least one occurrence of
518 * replstr, call strnsubst(), else just save the string.
519 * Iterations over elements of avj and tmp are done
524 if (repls && strstr(*tmp, replstr) != NULL) {
525 if (strnsubst(tmp++, replstr, inpline, (size_t)Sflag)) {
526 warnx("comamnd line cannot be assembled, too long");
532 if ((*tmp = strdup(*tmp)) == NULL) {
533 warnx("strdup failed");
547 * Walk from the tail to the head, free along the way.
549 for (; tmp2 != tmp; tmp--)
552 * Now free the list itself.
557 * Free the input line buffer, if we have one.
559 if (inpline != NULL) {
573 * If the user wants to be notified of each command before it is
574 * executed, notify them. If they want the notification to be
575 * followed by a prompt, then prompt them.
577 if (tflag || pflag) {
578 (void)fprintf(stderr, "%s", *argv);
579 for (avec = argv + 1; *avec != NULL; ++avec)
580 (void)fprintf(stderr, " %s", *avec);
582 * If the user has asked to be prompted, do so.
586 * If they asked not to exec, return without execution
587 * but if they asked to, go to the execution. If we
588 * could not open their tty, break the switch and drop
589 * back to -t behaviour.
599 (void)fprintf(stderr, "\n");
600 (void)fflush(stderr);
604 switch (pid = vfork()) {
610 if ((fd = open(_PATH_TTY, O_RDONLY)) == -1)
611 err(1, "can't open /dev/tty");
613 fd = open(_PATH_DEVNULL, O_RDONLY);
615 if (fd > STDIN_FILENO) {
616 if (dup2(fd, STDIN_FILENO) != 0)
617 err(1, "can't dup2 to stdin");
620 execvp(argv[0], argv);
625 waitchildren(*argv, 0);
629 * Wait for a tracked child to exit and return its pid and exit status.
631 * Ignores (discards) all untracked child processes.
632 * Returns -1 and sets errno to ECHILD if no tracked children exist.
633 * If block is set, waits indefinitely for a child process to exit.
634 * If block is not set and no children have exited, returns 0 immediately.
637 xwait(int block, int *status) {
645 while ((pid = waitpid(-1, status, block ? 0 : WNOHANG)) > 0)
646 if (pids_remove(pid))
653 xexit(const char *name, const int exit_code) {
654 waitchildren(name, 1);
659 waitchildren(const char *name, int waitall)
665 while ((pid = xwait(waitall || pids_full(), &status)) > 0) {
667 * If we couldn't invoke the utility or if utility exited
668 * because of a signal or with a value of 255, warn (per
669 * POSIX), and then wait until all other children have
670 * exited before exiting 1-125. POSIX requires us to stop
671 * reading if child exits because of a signal or with 255,
672 * but it does not require us to exit immediately; waiting
673 * is preferable to orphaning.
675 if (childerr != 0 && cause_exit == 0) {
678 cause_exit = errno == ENOENT ? 127 : 126;
680 } else if (WIFSIGNALED(status)) {
681 waitall = cause_exit = 1;
682 warnx("%s: terminated with signal %d; aborting",
683 name, WTERMSIG(status));
684 } else if (WEXITSTATUS(status) == 255) {
685 waitall = cause_exit = 1;
686 warnx("%s: exited with status 255; aborting", name);
687 } else if (WEXITSTATUS(status))
693 if (pid == -1 && errno != ECHILD)
704 if ((childpids = malloc(maxprocs * sizeof(*childpids))) == NULL)
705 errx(1, "malloc failed");
707 for (i = 0; i < maxprocs; i++)
715 return (curprocs == 0);
722 return (curprocs >= maxprocs);
730 slot = findfreeslot();
731 childpids[slot] = pid;
736 pids_remove(pid_t pid)
740 if ((slot = findslot(pid)) < 0)
753 if ((slot = findslot(NOPID)) < 0)
754 errx(1, "internal error: no free pid slot");
763 for (slot = 0; slot < maxprocs; slot++)
764 if (childpids[slot] == pid)
773 childpids[slot] = NOPID;
777 * Prompt the user about running a command.
788 if ((ttyfp = fopen(_PATH_TTY, "r")) == NULL)
789 return (2); /* Indicate that the TTY failed to open. */
790 (void)fprintf(stderr, "?...");
791 (void)fflush(stderr);
792 if ((response = fgetln(ttyfp, &rsize)) == NULL ||
793 regcomp(&cre, nl_langinfo(YESEXPR), REG_EXTENDED) != 0) {
797 response[rsize - 1] = '\0';
798 match = regexec(&cre, response, 0, NULL, 0);
809 "usage: xargs [-0opt] [-E eofstr] [-I replstr [-R replacements] [-S replsize]]\n"
810 " [-J replstr] [-L number] [-n number [-x]] [-P maxprocs]\n"
811 " [-s size] [utility [argument ...]]\n");