busybox/findutils/xargs.c
<<
>>
Prefs
   1/* vi: set sw=4 ts=4: */
   2/*
   3 * Mini xargs implementation for busybox
   4 *
   5 * (C) 2002,2003 by Vladimir Oleynik <dzo@simtreas.ru>
   6 *
   7 * Special thanks
   8 * - Mark Whitley and Glenn McGrath for stimulus to rewrite :)
   9 * - Mike Rendell <michael@cs.mun.ca>
  10 * and David MacKenzie <djm@gnu.ai.mit.edu>.
  11 *
  12 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  13 *
  14 * xargs is described in the Single Unix Specification v3 at
  15 * http://www.opengroup.org/onlinepubs/007904975/utilities/xargs.html
  16 */
  17//config:config XARGS
  18//config:       bool "xargs (7.2 kb)"
  19//config:       default y
  20//config:       help
  21//config:       xargs is used to execute a specified command for
  22//config:       every item from standard input.
  23//config:
  24//config:config FEATURE_XARGS_SUPPORT_CONFIRMATION
  25//config:       bool "Enable -p: prompt and confirmation"
  26//config:       default y
  27//config:       depends on XARGS
  28//config:       help
  29//config:       Support -p: prompt the user whether to run each command
  30//config:       line and read a line from the terminal.
  31//config:
  32//config:config FEATURE_XARGS_SUPPORT_QUOTES
  33//config:       bool "Enable single and double quotes and backslash"
  34//config:       default y
  35//config:       depends on XARGS
  36//config:       help
  37//config:       Support quoting in the input.
  38//config:
  39//config:config FEATURE_XARGS_SUPPORT_TERMOPT
  40//config:       bool "Enable -x: exit if -s or -n is exceeded"
  41//config:       default y
  42//config:       depends on XARGS
  43//config:       help
  44//config:       Support -x: exit if the command size (see the -s or -n option)
  45//config:       is exceeded.
  46//config:
  47//config:config FEATURE_XARGS_SUPPORT_ZERO_TERM
  48//config:       bool "Enable -0: NUL-terminated input"
  49//config:       default y
  50//config:       depends on XARGS
  51//config:       help
  52//config:       Support -0: input items are terminated by a NUL character
  53//config:       instead of whitespace, and the quotes and backslash
  54//config:       are not special.
  55//config:
  56//config:config FEATURE_XARGS_SUPPORT_REPL_STR
  57//config:       bool "Enable -I STR: string to replace"
  58//config:       default y
  59//config:       depends on XARGS
  60//config:       help
  61//config:       Support -I STR and -i[STR] options.
  62//config:
  63//config:config FEATURE_XARGS_SUPPORT_PARALLEL
  64//config:       bool "Enable -P N: processes to run in parallel"
  65//config:       default y
  66//config:       depends on XARGS
  67//config:
  68//config:config FEATURE_XARGS_SUPPORT_ARGS_FILE
  69//config:       bool "Enable -a FILE: use FILE instead of stdin"
  70//config:       default y
  71//config:       depends on XARGS
  72
  73//applet:IF_XARGS(APPLET_NOEXEC(xargs, xargs, BB_DIR_USR_BIN, BB_SUID_DROP, xargs))
  74
  75//kbuild:lib-$(CONFIG_XARGS) += xargs.o
  76
  77#include "libbb.h"
  78#include "common_bufsiz.h"
  79
  80/* This is a NOEXEC applet. Be very careful! */
  81
  82
  83#if 0
  84# define dbg_msg(...) bb_error_msg(__VA_ARGS__)
  85#else
  86# define dbg_msg(...) ((void)0)
  87#endif
  88
  89#ifdef TEST
  90# ifndef ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION
  91#  define ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION 1
  92# endif
  93# ifndef ENABLE_FEATURE_XARGS_SUPPORT_QUOTES
  94#  define ENABLE_FEATURE_XARGS_SUPPORT_QUOTES 1
  95# endif
  96# ifndef ENABLE_FEATURE_XARGS_SUPPORT_TERMOPT
  97#  define ENABLE_FEATURE_XARGS_SUPPORT_TERMOPT 1
  98# endif
  99# ifndef ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM
 100#  define ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM 1
 101# endif
 102#endif
 103
 104
 105struct globals {
 106        char **args;
 107#if ENABLE_FEATURE_XARGS_SUPPORT_REPL_STR
 108        char **argv;
 109        const char *repl_str;
 110        char eol_ch;
 111#endif
 112        const char *eof_str;
 113        int idx;
 114        int fd_tty;
 115        int fd_stdin;
 116#if ENABLE_FEATURE_XARGS_SUPPORT_PARALLEL
 117        int running_procs;
 118        int max_procs;
 119#endif
 120        smalluint xargs_exitcode;
 121#if ENABLE_FEATURE_XARGS_SUPPORT_QUOTES
 122#define NORM      0
 123#define QUOTE     1
 124#define BACKSLASH 2
 125#define SPACE     4
 126        smalluint process_stdin__state;
 127        char process_stdin__q;
 128#endif
 129} FIX_ALIASING;
 130#define G (*(struct globals*)bb_common_bufsiz1)
 131#define INIT_G() do { \
 132        setup_common_bufsiz(); \
 133        IF_FEATURE_XARGS_SUPPORT_REPL_STR(G.repl_str = "{}";) \
 134        IF_FEATURE_XARGS_SUPPORT_REPL_STR(G.eol_ch = '\n';) \
 135        /* Even zero values are set because we are NOEXEC applet */ \
 136        G.eof_str = NULL; \
 137        G.idx = 0; \
 138        IF_FEATURE_XARGS_SUPPORT_PARALLEL(G.running_procs = 0;) \
 139        IF_FEATURE_XARGS_SUPPORT_PARALLEL(G.max_procs = 1;) \
 140        G.xargs_exitcode = 0; \
 141        IF_FEATURE_XARGS_SUPPORT_QUOTES(G.process_stdin__state = NORM;) \
 142        IF_FEATURE_XARGS_SUPPORT_QUOTES(G.process_stdin__q = '\0';) \
 143} while (0)
 144
 145/* Correct regardless of combination of CONFIG_xxx */
 146enum {
 147        OPTBIT_VERBOSE = 0,
 148        OPTBIT_NO_EMPTY,
 149        OPTBIT_UPTO_NUMBER,
 150        OPTBIT_UPTO_SIZE,
 151        OPTBIT_EOF_STRING,
 152        OPTBIT_EOF_STRING1,
 153        OPTBIT_STDIN_TTY,
 154        IF_FEATURE_XARGS_SUPPORT_CONFIRMATION(OPTBIT_INTERACTIVE,)
 155        IF_FEATURE_XARGS_SUPPORT_TERMOPT(     OPTBIT_TERMINATE  ,)
 156        IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(   OPTBIT_ZEROTERM   ,)
 157        IF_FEATURE_XARGS_SUPPORT_REPL_STR(    OPTBIT_REPLSTR    ,)
 158        IF_FEATURE_XARGS_SUPPORT_REPL_STR(    OPTBIT_REPLSTR1   ,)
 159
 160        OPT_VERBOSE     = 1 << OPTBIT_VERBOSE    ,
 161        OPT_NO_EMPTY    = 1 << OPTBIT_NO_EMPTY   ,
 162        OPT_UPTO_NUMBER = 1 << OPTBIT_UPTO_NUMBER,
 163        OPT_UPTO_SIZE   = 1 << OPTBIT_UPTO_SIZE  ,
 164        OPT_EOF_STRING  = 1 << OPTBIT_EOF_STRING , /* GNU: -e[<param>] */
 165        OPT_EOF_STRING1 = 1 << OPTBIT_EOF_STRING1, /* SUS: -E<param> */
 166        OPT_STDIN_TTY   = 1 << OPTBIT_STDIN_TTY,
 167        OPT_INTERACTIVE = IF_FEATURE_XARGS_SUPPORT_CONFIRMATION((1 << OPTBIT_INTERACTIVE)) + 0,
 168        OPT_TERMINATE   = IF_FEATURE_XARGS_SUPPORT_TERMOPT(     (1 << OPTBIT_TERMINATE  )) + 0,
 169        OPT_ZEROTERM    = IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(   (1 << OPTBIT_ZEROTERM   )) + 0,
 170        OPT_REPLSTR     = IF_FEATURE_XARGS_SUPPORT_REPL_STR(    (1 << OPTBIT_REPLSTR    )) + 0,
 171        OPT_REPLSTR1    = IF_FEATURE_XARGS_SUPPORT_REPL_STR(    (1 << OPTBIT_REPLSTR1   )) + 0,
 172};
 173#define OPTION_STR "+trn:s:e::E:o" \
 174        IF_FEATURE_XARGS_SUPPORT_CONFIRMATION("p") \
 175        IF_FEATURE_XARGS_SUPPORT_TERMOPT(     "x") \
 176        IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(   "0") \
 177        IF_FEATURE_XARGS_SUPPORT_REPL_STR(    "I:i::") \
 178        IF_FEATURE_XARGS_SUPPORT_PARALLEL(    "P:+") \
 179        IF_FEATURE_XARGS_SUPPORT_ARGS_FILE(   "a:")
 180
 181
 182/*
 183 * Returns 0 if xargs should continue (but may set G.xargs_exitcode to 123).
 184 * Else sets G.xargs_exitcode to error code and returns nonzero.
 185 *
 186 * If G.max_procs == 0, performs final waitpid() loop for all children.
 187 */
 188static int xargs_exec(void)
 189{
 190        int status;
 191
 192        if (option_mask32 & OPT_STDIN_TTY)
 193                xdup2(G.fd_tty, STDIN_FILENO);
 194
 195#if !ENABLE_FEATURE_XARGS_SUPPORT_PARALLEL
 196        status = spawn_and_wait(G.args);
 197#else
 198        if (G.max_procs == 1) {
 199                status = spawn_and_wait(G.args);
 200        } else {
 201                pid_t pid;
 202                int wstat;
 203 again:
 204                if (G.running_procs >= G.max_procs)
 205                        pid = safe_waitpid(-1, &wstat, 0);
 206                else
 207                        pid = wait_any_nohang(&wstat);
 208                if (pid > 0) {
 209                        /* We may have children we don't know about:
 210                         * sh -c 'sleep 1 & exec xargs ...'
 211                         * Do not make G.running_procs go negative.
 212                         */
 213                        if (G.running_procs != 0)
 214                                G.running_procs--;
 215                        status = WIFSIGNALED(wstat)
 216                                ? 0x180 + WTERMSIG(wstat)
 217                                : WEXITSTATUS(wstat);
 218                        if (status > 0 && status < 255) {
 219                                /* See below why 123 does not abort */
 220                                G.xargs_exitcode = 123;
 221                                status = 0;
 222                        }
 223                        if (status == 0)
 224                                goto again; /* maybe we have more children? */
 225                        /* else: "bad" status, will bail out */
 226                } else if (G.max_procs != 0) {
 227                        /* Not in final waitpid() loop,
 228                         * and G.running_procs < G.max_procs: start more procs
 229                         */
 230                        status = spawn(G.args);
 231                        /* here "status" actually holds pid, or -1 */
 232                        if (status > 0) {
 233                                G.running_procs++;
 234                                status = 0;
 235                        }
 236                        /* else: status == -1 (failed to fork or exec) */
 237                } else {
 238                        /* final waitpid() loop: must be ECHILD "no more children" */
 239                        status = 0;
 240                }
 241        }
 242#endif
 243        /* Manpage:
 244         * """xargs exits with the following status:
 245         * 0 if it succeeds
 246         * 123 if any invocation of the command exited with status 1-125
 247         * 124 if the command exited with status 255
 248         *     ("""If any invocation of the command exits with a status of 255,
 249         *     xargs will stop immediately without reading any further input.
 250         *     An error message is issued on stderr when this happens.""")
 251         * 125 if the command is killed by a signal
 252         * 126 if the command cannot be run
 253         * 127 if the command is not found
 254         * 1 if some other error occurred."""
 255         */
 256        if (status < 0) {
 257                bb_simple_perror_msg(G.args[0]);
 258                status = (errno == ENOENT) ? 127 : 126;
 259        }
 260        else if (status >= 0x180) {
 261                bb_error_msg("'%s' terminated by signal %u",
 262                        G.args[0], status - 0x180);
 263                status = 125;
 264        }
 265        else if (status != 0) {
 266                if (status == 255) {
 267                        bb_error_msg("%s: exited with status 255; aborting", G.args[0]);
 268                        status = 124;
 269                        goto ret;
 270                }
 271                /* "123 if any invocation of the command exited with status 1-125"
 272                 * This implies that nonzero exit code is remembered,
 273                 * but does not cause xargs to stop: we return 0.
 274                 */
 275                G.xargs_exitcode = 123;
 276                status = 0;
 277        }
 278 ret:
 279        if (status != 0)
 280                G.xargs_exitcode = status;
 281        if (option_mask32 & OPT_STDIN_TTY)
 282                xdup2(G.fd_stdin, STDIN_FILENO);
 283        return status;
 284}
 285
 286/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
 287 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
 288 */
 289#define ISSPACE(a) ({ unsigned char xargs__isspace = (a) - 9; xargs__isspace == (' ' - 9) || xargs__isspace <= (13 - 9); })
 290
 291static void store_param(char *s)
 292{
 293        /* Grow by 256 elements at once */
 294        if (!(G.idx & 0xff)) { /* G.idx == N*256? */
 295                /* Enlarge, make G.args[(N+1)*256 - 1] last valid idx */
 296                G.args = xrealloc(G.args, sizeof(G.args[0]) * (G.idx + 0x100));
 297        }
 298        G.args[G.idx++] = s;
 299}
 300
 301/* process[0]_stdin:
 302 * Read characters into buf[n_max_chars+1], and when parameter delimiter
 303 * is seen, store the address of a new parameter to args[].
 304 * If reading discovers that last chars do not form the complete
 305 * parameter, the pointer to the first such "tail character" is returned.
 306 * (buf has extra byte at the end to accommodate terminating NUL
 307 * of "tail characters" string).
 308 * Otherwise, the returned pointer points to NUL byte.
 309 * On entry, buf[] may contain some "seed chars" which are to become
 310 * the beginning of the first parameter.
 311 */
 312
 313#if ENABLE_FEATURE_XARGS_SUPPORT_QUOTES
 314static char* FAST_FUNC process_stdin(int n_max_chars, int n_max_arg, char *buf)
 315{
 316#define q     G.process_stdin__q
 317#define state G.process_stdin__state
 318        char *s = buf;             /* start of the word */
 319        char *p = s + strlen(buf); /* end of the word */
 320
 321        buf += n_max_chars;        /* past buffer's end */
 322
 323        /* "goto ret" is used instead of "break" to make control flow
 324         * more obvious: */
 325
 326        while (1) {
 327                int c = getchar();
 328                if (c == EOF) {
 329                        if (p != s)
 330                                goto close_word;
 331                        goto ret;
 332                }
 333                if (state == BACKSLASH) {
 334                        state = NORM;
 335                        goto set;
 336                }
 337                if (state == QUOTE) {
 338                        if (c != q)
 339                                goto set;
 340                        q = '\0';
 341                        state = NORM;
 342                } else { /* if (state == NORM) */
 343                        if (ISSPACE(c)) {
 344                                if (p != s) {
 345 close_word:
 346                                        state = SPACE;
 347                                        c = '\0';
 348                                        goto set;
 349                                }
 350                        } else {
 351                                if (c == '\\') {
 352                                        state = BACKSLASH;
 353                                } else if (c == '\'' || c == '"') {
 354                                        q = c;
 355                                        state = QUOTE;
 356                                } else {
 357 set:
 358                                        *p++ = c;
 359                                }
 360                        }
 361                }
 362                if (state == SPACE) {   /* word's delimiter or EOF detected */
 363                        state = NORM;
 364                        if (q) {
 365                                bb_error_msg_and_die("unmatched %s quote",
 366                                        q == '\'' ? "single" : "double");
 367                        }
 368                        /* A full word is loaded */
 369                        if (G.eof_str) {
 370                                if (strcmp(s, G.eof_str) == 0) {
 371                                        while (getchar() != EOF)
 372                                                continue;
 373                                        p = s;
 374                                        goto ret;
 375                                }
 376                        }
 377                        store_param(s);
 378                        dbg_msg("args[]:'%s'", s);
 379                        s = p;
 380                        n_max_arg--;
 381                        if (n_max_arg == 0) {
 382                                goto ret;
 383                        }
 384                }
 385                if (p == buf) {
 386                        goto ret;
 387                }
 388        }
 389 ret:
 390        *p = '\0';
 391        /* store_param(NULL) - caller will do it */
 392        dbg_msg("return:'%s'", s);
 393        return s;
 394#undef q
 395#undef state
 396}
 397#else
 398/* The variant does not support single quotes, double quotes or backslash */
 399static char* FAST_FUNC process_stdin(int n_max_chars, int n_max_arg, char *buf)
 400{
 401        char *s = buf;             /* start of the word */
 402        char *p = s + strlen(buf); /* end of the word */
 403
 404        buf += n_max_chars;        /* past buffer's end */
 405
 406        while (1) {
 407                int c = getchar();
 408                if (c == EOF) {
 409                        if (p == s)
 410                                goto ret;
 411                }
 412                if (c == EOF || ISSPACE(c)) {
 413                        if (p == s)
 414                                continue;
 415                        c = EOF;
 416                }
 417                *p++ = (c == EOF ? '\0' : c);
 418                if (c == EOF) { /* word's delimiter or EOF detected */
 419                        /* A full word is loaded */
 420                        if (G.eof_str) {
 421                                if (strcmp(s, G.eof_str) == 0) {
 422                                        while (getchar() != EOF)
 423                                                continue;
 424                                        p = s;
 425                                        goto ret;
 426                                }
 427                        }
 428                        store_param(s);
 429                        dbg_msg("args[]:'%s'", s);
 430                        s = p;
 431                        n_max_arg--;
 432                        if (n_max_arg == 0) {
 433                                goto ret;
 434                        }
 435                }
 436                if (p == buf) {
 437                        goto ret;
 438                }
 439        }
 440 ret:
 441        *p = '\0';
 442        /* store_param(NULL) - caller will do it */
 443        dbg_msg("return:'%s'", s);
 444        return s;
 445}
 446#endif /* FEATURE_XARGS_SUPPORT_QUOTES */
 447
 448#if ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM
 449static char* FAST_FUNC process0_stdin(int n_max_chars, int n_max_arg, char *buf)
 450{
 451        char *s = buf;             /* start of the word */
 452        char *p = s + strlen(buf); /* end of the word */
 453
 454        buf += n_max_chars;        /* past buffer's end */
 455
 456        while (1) {
 457                int c = getchar();
 458                if (c == EOF) {
 459                        if (p == s)
 460                                goto ret;
 461                        c = '\0';
 462                }
 463                *p++ = c;
 464                if (c == '\0') {   /* NUL or EOF detected */
 465                        /* A full word is loaded */
 466                        store_param(s);
 467                        dbg_msg("args[]:'%s'", s);
 468                        s = p;
 469                        n_max_arg--;
 470                        if (n_max_arg == 0) {
 471                                goto ret;
 472                        }
 473                }
 474                if (p == buf) {
 475                        goto ret;
 476                }
 477        }
 478 ret:
 479        *p = '\0';
 480        /* store_param(NULL) - caller will do it */
 481        dbg_msg("return:'%s'", s);
 482        return s;
 483}
 484#endif /* FEATURE_XARGS_SUPPORT_ZERO_TERM */
 485
 486#if ENABLE_FEATURE_XARGS_SUPPORT_REPL_STR
 487/*
 488 * Used if -I<repl> was specified.
 489 * In this mode, words aren't appended to PROG ARGS.
 490 * Instead, entire input line is read, then <repl> string
 491 * in every PROG and ARG is replaced with the line:
 492 *  echo -e "ho ho\nhi" | xargs -I_ cmd __ _
 493 * results in "cmd 'ho hoho ho' 'ho ho'"; "cmd 'hihi' 'hi'".
 494 * -n MAX_ARGS seems to be ignored.
 495 * Tested with GNU findutils 4.5.10.
 496 */
 497//FIXME: n_max_chars is not handled the same way as in GNU findutils.
 498//FIXME: quoting is not implemented.
 499static char* FAST_FUNC process_stdin_with_replace(int n_max_chars, int n_max_arg UNUSED_PARAM, char *buf)
 500{
 501        int i;
 502        char *end, *p;
 503
 504        /* Free strings from last invocation, if any */
 505        for (i = 0; G.args && G.args[i]; i++)
 506                if (G.args[i] != G.argv[i])
 507                        free(G.args[i]);
 508
 509        end = buf + n_max_chars;
 510        p = buf;
 511
 512        while (1) {
 513                int c = getchar();
 514                if (p == buf) {
 515                        if (c == EOF)
 516                                goto ret; /* last line is empty, return "" */
 517                        if (c == G.eol_ch)
 518                                continue; /* empty line, ignore */
 519                        /* Skip leading whitespace of each line: try
 520                         * echo -e ' \t\v1 2 3 ' | xargs -I% echo '[%]'
 521                         */
 522                        if (ISSPACE(c))
 523                                continue;
 524                }
 525                if (c == EOF || c == G.eol_ch) {
 526                        c = '\0';
 527                }
 528                *p++ = c;
 529                if (c == '\0') {   /* EOL or EOF detected */
 530                        i = 0;
 531                        while (G.argv[i]) {
 532                                char *arg = G.argv[i];
 533                                int count = count_strstr(arg, G.repl_str);
 534                                if (count != 0)
 535                                        arg = xmalloc_substitute_string(arg, count, G.repl_str, buf);
 536                                store_param(arg);
 537                                dbg_msg("args[]:'%s'", arg);
 538                                i++;
 539                        }
 540                        p = buf;
 541                        goto ret;
 542                }
 543                if (p == end) {
 544                        goto ret;
 545                }
 546        }
 547 ret:
 548        *p = '\0';
 549        /* store_param(NULL) - caller will do it */
 550        dbg_msg("return:'%s'", buf);
 551        return buf;
 552}
 553#endif
 554
 555#if ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION
 556/* Prompt the user for a response, and
 557 * if user responds affirmatively, return true;
 558 * otherwise, return false. Uses "/dev/tty", not stdin.
 559 */
 560static int xargs_ask_confirmation(void)
 561{
 562        FILE *tty_stream;
 563        int r;
 564
 565        tty_stream = xfopen_for_read(CURRENT_TTY);
 566
 567        fputs(" ?...", stderr);
 568        r = bb_ask_y_confirmation_FILE(tty_stream);
 569
 570        fclose(tty_stream);
 571
 572        return r;
 573}
 574#else
 575# define xargs_ask_confirmation() 1
 576#endif
 577
 578//usage:#define xargs_trivial_usage
 579//usage:       "[OPTIONS] [PROG ARGS]"
 580//usage:#define xargs_full_usage "\n\n"
 581//usage:       "Run PROG on every item given by stdin\n"
 582//usage:        IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(
 583//usage:     "\n        -0      NUL terminated input"
 584//usage:        )
 585//usage:        IF_FEATURE_XARGS_SUPPORT_ARGS_FILE(
 586//usage:     "\n        -a FILE Read from FILE instead of stdin"
 587//usage:        )
 588//usage:     "\n        -o      Reopen stdin as /dev/tty"
 589//usage:     "\n        -r      Don't run command if input is empty"
 590//usage:     "\n        -t      Print the command on stderr before execution"
 591//usage:        IF_FEATURE_XARGS_SUPPORT_CONFIRMATION(
 592//usage:     "\n        -p      Ask user whether to run each command"
 593//usage:        )
 594//usage:     "\n        -E STR,-e[STR]  STR stops input processing"
 595//usage:        IF_FEATURE_XARGS_SUPPORT_REPL_STR(
 596//usage:     "\n        -I STR  Replace STR within PROG ARGS with input line"
 597//usage:        )
 598//usage:     "\n        -n N    Pass no more than N args to PROG"
 599//usage:     "\n        -s N    Pass command line of no more than N bytes"
 600//usage:        IF_FEATURE_XARGS_SUPPORT_PARALLEL(
 601//usage:     "\n        -P N    Run up to N PROGs in parallel"
 602//usage:        )
 603//usage:        IF_FEATURE_XARGS_SUPPORT_TERMOPT(
 604//usage:     "\n        -x      Exit if size is exceeded"
 605//usage:        )
 606//usage:#define xargs_example_usage
 607//usage:       "$ ls | xargs gzip\n"
 608//usage:       "$ find . -name '*.c' -print | xargs rm\n"
 609
 610int xargs_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 611int xargs_main(int argc UNUSED_PARAM, char **argv)
 612{
 613        int initial_idx;
 614        int i;
 615        char *max_args;
 616        char *max_chars;
 617        char *buf;
 618        unsigned opt;
 619        int n_max_chars;
 620        int n_max_arg;
 621#if ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM \
 622 || ENABLE_FEATURE_XARGS_SUPPORT_REPL_STR
 623        char* FAST_FUNC (*read_args)(int, int, char*) = process_stdin;
 624#else
 625#define read_args process_stdin
 626#endif
 627        IF_FEATURE_XARGS_SUPPORT_ARGS_FILE(char *opt_a = NULL;)
 628
 629        INIT_G();
 630
 631        opt = getopt32long(argv, OPTION_STR,
 632                "no-run-if-empty\0" No_argument "r",
 633                &max_args, &max_chars, &G.eof_str, &G.eof_str
 634                IF_FEATURE_XARGS_SUPPORT_REPL_STR(, &G.repl_str, &G.repl_str)
 635                IF_FEATURE_XARGS_SUPPORT_PARALLEL(, &G.max_procs)
 636                IF_FEATURE_XARGS_SUPPORT_ARGS_FILE(, &opt_a)
 637        );
 638
 639#if ENABLE_FEATURE_XARGS_SUPPORT_PARALLEL
 640        if (G.max_procs <= 0) /* -P0 means "run lots of them" */
 641                G.max_procs = 100; /* let's not go crazy high */
 642#endif
 643
 644#if ENABLE_FEATURE_XARGS_SUPPORT_ARGS_FILE
 645        if (opt_a)
 646                xmove_fd(xopen(opt_a, O_RDONLY), 0);
 647#endif
 648
 649        /* -E ""? You may wonder why not just omit -E?
 650         * This is used for portability:
 651         * old xargs was using "_" as default for -E / -e */
 652        if ((opt & OPT_EOF_STRING1) && G.eof_str[0] == '\0')
 653                G.eof_str = NULL;
 654
 655        if (opt & OPT_ZEROTERM) {
 656                IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(read_args = process0_stdin;)
 657                IF_FEATURE_XARGS_SUPPORT_REPL_STR(G.eol_ch = '\0';)
 658        }
 659
 660        argv += optind;
 661        //argc -= optind;
 662        if (!argv[0]) {
 663                /* default behavior is to echo all the filenames */
 664                *--argv = (char*)"echo";
 665                //argc++;
 666        }
 667
 668        /*
 669         * The Open Group Base Specifications Issue 6:
 670         * "The xargs utility shall limit the command line length such that
 671         * when the command line is invoked, the combined argument
 672         * and environment lists (see the exec family of functions
 673         * in the System Interfaces volume of IEEE Std 1003.1-2001)
 674         * shall not exceed {ARG_MAX}-2048 bytes".
 675         */
 676        n_max_chars = bb_arg_max();
 677        if (n_max_chars > 32 * 1024)
 678                n_max_chars = 32 * 1024;
 679        /*
 680         * POSIX suggests substracting 2048 bytes from sysconf(_SC_ARG_MAX)
 681         * so that the process may safely modify its environment.
 682         */
 683        n_max_chars -= 2048;
 684
 685        if (opt & OPT_UPTO_SIZE) {
 686                n_max_chars = xatou_range(max_chars, 1, INT_MAX);
 687        }
 688        /* Account for prepended fixed arguments */
 689        {
 690                size_t n_chars = 0;
 691                for (i = 0; argv[i]; i++) {
 692                        n_chars += strlen(argv[i]) + 1;
 693                }
 694                n_max_chars -= n_chars;
 695        }
 696        /* Sanity check */
 697        if (n_max_chars <= 0) {
 698                bb_simple_error_msg_and_die("can't fit single argument within argument list size limit");
 699        }
 700
 701        buf = xzalloc(n_max_chars + 1);
 702
 703        n_max_arg = n_max_chars;
 704        if (opt & OPT_UPTO_NUMBER) {
 705                n_max_arg = xatou_range(max_args, 1, INT_MAX);
 706                /* Not necessary, we use growable args[]: */
 707                /* if (n_max_arg > n_max_chars) n_max_arg = n_max_chars */
 708        }
 709
 710#if ENABLE_FEATURE_XARGS_SUPPORT_REPL_STR
 711        if (opt & (OPT_REPLSTR | OPT_REPLSTR1)) {
 712                /*
 713                 * -I<str>:
 714                 * Unmodified args are kept in G.argv[i],
 715                 * G.args[i] receives malloced G.argv[i] with <str> replaced
 716                 * with input line. Setting this up:
 717                 */
 718                G.args = NULL;
 719                G.argv = argv;
 720                read_args = process_stdin_with_replace;
 721                /* Make -I imply -r. GNU findutils seems to do the same: */
 722                /* (otherwise "echo -n | xargs -I% echo %" would SEGV) */
 723                opt |= OPT_NO_EMPTY;
 724        } else
 725#endif
 726        {
 727                /* Store the command to be executed, part 1.
 728                 * We can statically allocate (argc + n_max_arg + 1) elements
 729                 * and do not bother with resizing args[], but on 64-bit machines
 730                 * this results in args[] vector which is ~8 times bigger
 731                 * than n_max_chars! That is, with n_max_chars == 20k,
 732                 * args[] will take 160k (!), which will most likely be
 733                 * almost entirely unused.
 734                 */
 735                for (i = 0; argv[i]; i++)
 736                        store_param(argv[i]);
 737        }
 738
 739        if (opt & OPT_STDIN_TTY) {
 740                G.fd_tty = xopen(CURRENT_TTY, O_RDONLY);
 741                close_on_exec_on(G.fd_tty);
 742                G.fd_stdin = dup(STDIN_FILENO);
 743                close_on_exec_on(G.fd_stdin);
 744        }
 745
 746        initial_idx = G.idx;
 747        while (1) {
 748                char *rem;
 749
 750                G.idx = initial_idx;
 751                rem = read_args(n_max_chars, n_max_arg, buf);
 752                store_param(NULL);
 753
 754                if (!G.args[initial_idx]) { /* not even one ARG was added? */
 755                        if (*rem != '\0')
 756                                bb_simple_error_msg_and_die("argument line too long");
 757                        if (opt & OPT_NO_EMPTY)
 758                                break;
 759                }
 760                opt |= OPT_NO_EMPTY;
 761
 762                if (opt & (OPT_INTERACTIVE | OPT_VERBOSE)) {
 763                        const char *fmt = " %s" + 1;
 764                        char **args = G.args;
 765                        for (i = 0; args[i]; i++) {
 766                                fprintf(stderr, fmt, args[i]);
 767                                fmt = " %s";
 768                        }
 769                        if (!(opt & OPT_INTERACTIVE))
 770                                bb_putchar_stderr('\n');
 771                }
 772
 773                if (!(opt & OPT_INTERACTIVE) || xargs_ask_confirmation()) {
 774                        if (xargs_exec() != 0)
 775                                break; /* G.xargs_exitcode is set by xargs_exec() */
 776                }
 777
 778                overlapping_strcpy(buf, rem);
 779        } /* while */
 780
 781        if (ENABLE_FEATURE_CLEAN_UP) {
 782                free(G.args);
 783                free(buf);
 784        }
 785
 786#if ENABLE_FEATURE_XARGS_SUPPORT_PARALLEL
 787        G.max_procs = 0;
 788        xargs_exec(); /* final waitpid() loop */
 789#endif
 790
 791        return G.xargs_exitcode;
 792}
 793
 794
 795#ifdef TEST
 796
 797const char *applet_name = "debug stuff usage";
 798
 799void bb_show_usage(void)
 800{
 801        fprintf(stderr, "Usage: %s [-p] [-r] [-t] -[x] [-n max_arg] [-s max_chars]\n",
 802                applet_name);
 803        exit(EXIT_FAILURE);
 804}
 805
 806int main(int argc, char **argv)
 807{
 808        return xargs_main(argc, argv);
 809}
 810#endif /* TEST */
 811