busybox/findutils/xargs.c

575 lines
14 KiB
C
Raw Normal View History

/* vi: set sw=4 ts=4: */
/*
* Mini xargs implementation for busybox
2003-10-10 17:40:18 +05:30
* Options are supported: "-prtx -n max_arg -s max_chars -e[ouf_str]"
*
2003-10-10 17:40:18 +05:30
* (C) 2002,2003 by Vladimir Oleynik <dzo@simtreas.ru>
*
2003-10-10 17:40:18 +05:30
* Special thanks
* - Mark Whitley and Glenn McGrath for stimulus to rewrite :)
2003-10-10 17:40:18 +05:30
* - Mike Rendell <michael@cs.mun.ca>
* and David MacKenzie <djm@gnu.ai.mit.edu>.
*
* Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
*
* xargs is described in the Single Unix Specification v3 at
* http://www.opengroup.org/onlinepubs/007904975/utilities/xargs.html
*
*/
2000-09-23 01:31:23 +05:30
//kbuild:lib-$(CONFIG_XARGS) += xargs.o
//config:
//config:config XARGS
//config: bool "xargs"
//config: default y
//config: help
//config: xargs is used to execute a specified command for
//config: every item from standard input.
//config:
//config:config FEATURE_XARGS_SUPPORT_CONFIRMATION
//config: bool "Enable -p: prompt and confirmation"
//config: default y
//config: depends on XARGS
//config: help
//config: Support -p: prompt the user whether to run each command
//config: line and read a line from the terminal.
//config:
//config:config FEATURE_XARGS_SUPPORT_QUOTES
//config: bool "Enable single and double quotes and backslash"
//config: default y
//config: depends on XARGS
//config: help
//config: Support quoting in the input.
//config:
//config:config FEATURE_XARGS_SUPPORT_TERMOPT
//config: bool "Enable -x: exit if -s or -n is exceeded"
//config: default y
//config: depends on XARGS
//config: help
//config: Support -x: exit if the command size (see the -s or -n option)
//config: is exceeded.
//config:
//config:config FEATURE_XARGS_SUPPORT_ZERO_TERM
//config: bool "Enable -0: NUL-terminated input"
//config: default y
//config: depends on XARGS
//config: help
//config: Support -0: input items are terminated by a NUL character
//config: instead of whitespace, and the quotes and backslash
//config: are not special.
#include "libbb.h"
2000-09-23 01:31:23 +05:30
/* This is a NOEXEC applet. Be very careful! */
2003-10-10 17:40:18 +05:30
/* COMPAT: SYSV version defaults size (and has a max value of) to 470.
We try to make it as large as possible. */
#if !defined(ARG_MAX) && defined(_SC_ARG_MAX)
# define ARG_MAX sysconf(_SC_ARG_MAX)
2003-10-10 17:40:18 +05:30
#endif
#if !defined(ARG_MAX)
# define ARG_MAX 470
2003-10-10 17:40:18 +05:30
#endif
#ifdef TEST
# ifndef ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION
# define ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION 1
2003-10-10 17:40:18 +05:30
# endif
# ifndef ENABLE_FEATURE_XARGS_SUPPORT_QUOTES
# define ENABLE_FEATURE_XARGS_SUPPORT_QUOTES 1
2003-10-10 17:40:18 +05:30
# endif
# ifndef ENABLE_FEATURE_XARGS_SUPPORT_TERMOPT
# define ENABLE_FEATURE_XARGS_SUPPORT_TERMOPT 1
2003-10-10 17:40:18 +05:30
# endif
# ifndef ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM
# define ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM 1
2003-10-10 17:40:18 +05:30
# endif
#endif
/*
2006-09-29 13:50:30 +05:30
This function has special algorithm.
Don't use fork and include to main!
*/
static int xargs_exec(char **args)
{
2006-09-29 13:50:30 +05:30
int status;
2003-10-31 04:17:16 +05:30
status = spawn_and_wait(args);
if (status < 0) {
bb_simple_perror_msg(args[0]);
return errno == ENOENT ? 127 : 126;
}
if (status == 255) {
2006-09-29 13:50:30 +05:30
bb_error_msg("%s: exited with status 255; aborting", args[0]);
return 124;
}
if (status >= 0x180) {
2006-09-29 13:50:30 +05:30
bb_error_msg("%s: terminated by signal %d",
args[0], status - 0x180);
2006-09-29 13:50:30 +05:30
return 125;
}
if (status)
2006-09-29 13:50:30 +05:30
return 123;
return 0;
}
typedef struct xlist_t {
struct xlist_t *link;
2007-04-15 14:08:50 +05:30
size_t length;
char xstr[1];
2003-10-10 17:40:18 +05:30
} xlist_t;
static smallint eof_stdin_detected;
2003-10-10 17:40:18 +05:30
#define ISBLANK(c) ((c) == ' ' || (c) == '\t')
2006-09-29 13:50:30 +05:30
#define ISSPACE(c) (ISBLANK(c) || (c) == '\n' || (c) == '\r' \
2003-10-10 17:40:18 +05:30
|| (c) == '\f' || (c) == '\v')
#if ENABLE_FEATURE_XARGS_SUPPORT_QUOTES
static xlist_t *process_stdin(xlist_t *list_arg,
const char *eof_str, size_t mc, char *buf)
2000-09-23 01:31:23 +05:30
{
2003-10-10 17:40:18 +05:30
#define NORM 0
#define QUOTE 1
#define BACKSLASH 2
#define SPACE 4
char *s = NULL; /* start word */
char *p = NULL; /* pointer to end word */
2007-04-15 14:08:50 +05:30
char q = '\0'; /* quote char */
2003-10-31 04:17:16 +05:30
char state = NORM;
char eof_str_detected = 0;
size_t line_l = 0; /* size loaded args line */
int c; /* current char */
2003-10-31 04:17:16 +05:30
xlist_t *cur;
xlist_t *prev;
prev = cur = list_arg;
while (1) {
if (!cur) break;
prev = cur;
line_l += cur->length;
cur = cur->link;
2003-10-10 17:40:18 +05:30
}
2003-10-31 04:17:16 +05:30
while (!eof_stdin_detected) {
c = getchar();
if (c == EOF) {
eof_stdin_detected = 1;
2003-10-31 04:17:16 +05:30
if (s)
goto unexpected_eof;
break;
2003-10-10 17:40:18 +05:30
}
2003-10-31 04:17:16 +05:30
if (eof_str_detected)
continue;
if (state == BACKSLASH) {
state = NORM;
goto set;
} else if (state == QUOTE) {
2007-04-15 14:08:50 +05:30
if (c != q)
2003-10-31 04:17:16 +05:30
goto set;
2007-04-15 14:08:50 +05:30
q = '\0';
state = NORM;
2007-04-12 06:02:05 +05:30
} else { /* if (state == NORM) */
2003-10-31 04:17:16 +05:30
if (ISSPACE(c)) {
if (s) {
2007-04-15 14:08:50 +05:30
unexpected_eof:
2003-10-31 04:17:16 +05:30
state = SPACE;
2007-04-15 14:08:50 +05:30
c = '\0';
2003-10-31 04:17:16 +05:30
goto set;
}
} else {
if (s == NULL)
s = p = buf;
if (c == '\\') {
state = BACKSLASH;
} else if (c == '\'' || c == '"') {
q = c;
state = QUOTE;
} else {
2007-04-15 14:08:50 +05:30
set:
if ((size_t)(p - buf) >= mc)
2003-10-31 04:17:16 +05:30
bb_error_msg_and_die("argument line too long");
*p++ = c;
}
}
}
if (state == SPACE) { /* word's delimiter or EOF detected */
if (q) {
bb_error_msg_and_die("unmatched %s quote",
q == '\'' ? "single" : "double");
}
2003-10-31 04:17:16 +05:30
/* word loaded */
if (eof_str) {
eof_str_detected = (strcmp(s, eof_str) == 0);
2003-10-31 04:17:16 +05:30
}
if (!eof_str_detected) {
size_t length = (p - buf);
2007-04-15 14:08:50 +05:30
/* Dont xzalloc - it can be quite big */
cur = xmalloc(offsetof(xlist_t, xstr) + length);
cur->link = NULL;
cur->length = length;
2007-04-15 14:08:50 +05:30
memcpy(cur->xstr, s, length);
2003-10-31 04:17:16 +05:30
if (prev == NULL) {
list_arg = cur;
} else {
prev->link = cur;
}
prev = cur;
line_l += length;
2003-10-31 04:17:16 +05:30
if (line_l > mc) {
/* stop memory usage :-) */
break;
}
}
s = NULL;
state = NORM;
2003-10-10 17:40:18 +05:30
}
}
2003-10-31 04:17:16 +05:30
return list_arg;
2003-10-10 17:40:18 +05:30
}
#else
/* The variant does not support single quotes, double quotes or backslash */
static xlist_t *process_stdin(xlist_t *list_arg,
const char *eof_str, size_t mc, char *buf)
2003-10-10 17:40:18 +05:30
{
int c; /* current char */
char eof_str_detected = 0;
char *s = NULL; /* start word */
char *p = NULL; /* pointer to end word */
size_t line_l = 0; /* size loaded args line */
2003-10-31 04:17:16 +05:30
xlist_t *cur;
xlist_t *prev;
prev = cur = list_arg;
while (1) {
if (!cur) break;
prev = cur;
line_l += cur->length;
cur = cur->link;
2003-10-10 17:40:18 +05:30
}
2003-10-31 04:17:16 +05:30
while (!eof_stdin_detected) {
c = getchar();
if (c == EOF) {
eof_stdin_detected = 1;
2003-10-10 17:40:18 +05:30
}
2003-10-31 04:17:16 +05:30
if (eof_str_detected)
continue;
if (c == EOF || ISSPACE(c)) {
if (s == NULL)
continue;
c = EOF;
}
if (s == NULL)
s = p = buf;
if ((size_t)(p - buf) >= mc)
2003-10-31 04:17:16 +05:30
bb_error_msg_and_die("argument line too long");
2007-04-15 14:08:50 +05:30
*p++ = (c == EOF ? '\0' : c);
if (c == EOF) { /* word's delimiter or EOF detected */
2003-10-31 04:17:16 +05:30
/* word loaded */
if (eof_str) {
eof_str_detected = (strcmp(s, eof_str) == 0);
2003-10-31 04:17:16 +05:30
}
if (!eof_str_detected) {
size_t length = (p - buf);
2007-04-15 14:08:50 +05:30
/* Dont xzalloc - it can be quite big */
cur = xmalloc(offsetof(xlist_t, xstr) + length);
cur->link = NULL;
cur->length = length;
2007-04-15 14:08:50 +05:30
memcpy(cur->xstr, s, length);
2003-10-31 04:17:16 +05:30
if (prev == NULL) {
list_arg = cur;
} else {
prev->link = cur;
}
prev = cur;
line_l += length;
2003-10-31 04:17:16 +05:30
if (line_l > mc) {
/* stop memory usage :-) */
break;
}
s = NULL;
}
2003-10-10 17:40:18 +05:30
}
2003-10-09 16:36:45 +05:30
}
2003-10-31 04:17:16 +05:30
return list_arg;
2003-10-10 17:40:18 +05:30
}
#endif /* FEATURE_XARGS_SUPPORT_QUOTES */
2003-10-10 17:40:18 +05:30
#if ENABLE_FEATURE_XARGS_SUPPORT_CONFIRMATION
2003-10-10 17:40:18 +05:30
/* Prompt the user for a response, and
if the user responds affirmatively, return true;
otherwise, return false. Uses "/dev/tty", not stdin. */
2003-10-31 04:17:16 +05:30
static int xargs_ask_confirmation(void)
2003-10-10 17:40:18 +05:30
{
FILE *tty_stream;
2003-10-31 04:17:16 +05:30
int c, savec;
tty_stream = xfopen_for_read(CURRENT_TTY);
2003-10-31 04:17:16 +05:30
fputs(" ?...", stderr);
fflush_all();
2003-10-31 04:17:16 +05:30
c = savec = getc(tty_stream);
while (c != EOF && c != '\n')
c = getc(tty_stream);
fclose(tty_stream);
return (savec == 'y' || savec == 'Y');
2003-10-10 17:40:18 +05:30
}
2003-10-09 16:36:45 +05:30
#else
2003-10-10 17:40:18 +05:30
# define xargs_ask_confirmation() 1
#endif /* FEATURE_XARGS_SUPPORT_CONFIRMATION */
2003-10-10 17:40:18 +05:30
#if ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM
static xlist_t *process0_stdin(xlist_t *list_arg,
2008-07-05 14:48:54 +05:30
const char *eof_str UNUSED_PARAM, size_t mc, char *buf)
2003-10-10 17:40:18 +05:30
{
int c; /* current char */
char *s = NULL; /* start word */
char *p = NULL; /* pointer to end word */
size_t line_l = 0; /* size loaded args line */
2003-10-31 04:17:16 +05:30
xlist_t *cur;
xlist_t *prev;
prev = cur = list_arg;
while (1) {
if (!cur) break;
prev = cur;
line_l += cur->length;
cur = cur->link;
2003-10-09 16:36:45 +05:30
}
2003-10-31 04:17:16 +05:30
while (!eof_stdin_detected) {
c = getchar();
if (c == EOF) {
eof_stdin_detected = 1;
2003-10-31 04:17:16 +05:30
if (s == NULL)
break;
2007-04-15 14:08:50 +05:30
c = '\0';
2003-10-10 17:40:18 +05:30
}
2003-10-31 04:17:16 +05:30
if (s == NULL)
s = p = buf;
if ((size_t)(p - buf) >= mc)
2003-10-31 04:17:16 +05:30
bb_error_msg_and_die("argument line too long");
*p++ = c;
2007-04-15 14:08:50 +05:30
if (c == '\0') { /* word's delimiter or EOF detected */
2003-10-31 04:17:16 +05:30
/* word loaded */
size_t length = (p - buf);
2007-04-15 14:08:50 +05:30
/* Dont xzalloc - it can be quite big */
cur = xmalloc(offsetof(xlist_t, xstr) + length);
cur->link = NULL;
cur->length = length;
2007-04-15 14:08:50 +05:30
memcpy(cur->xstr, s, length);
2003-10-31 04:17:16 +05:30
if (prev == NULL) {
list_arg = cur;
} else {
prev->link = cur;
}
prev = cur;
line_l += length;
2003-10-31 04:17:16 +05:30
if (line_l > mc) {
/* stop memory usage :-) */
break;
}
s = NULL;
2003-10-10 17:40:18 +05:30
}
}
2003-10-31 04:17:16 +05:30
return list_arg;
2003-10-10 17:40:18 +05:30
}
#endif /* FEATURE_XARGS_SUPPORT_ZERO_TERM */
2003-10-10 17:40:18 +05:30
2006-09-29 13:50:30 +05:30
/* Correct regardless of combination of CONFIG_xxx */
enum {
OPTBIT_VERBOSE = 0,
OPTBIT_NO_EMPTY,
OPTBIT_UPTO_NUMBER,
OPTBIT_UPTO_SIZE,
OPTBIT_EOF_STRING,
OPTBIT_EOF_STRING1,
IF_FEATURE_XARGS_SUPPORT_CONFIRMATION(OPTBIT_INTERACTIVE,)
IF_FEATURE_XARGS_SUPPORT_TERMOPT( OPTBIT_TERMINATE ,)
IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( OPTBIT_ZEROTERM ,)
2006-09-29 13:50:30 +05:30
OPT_VERBOSE = 1 << OPTBIT_VERBOSE ,
OPT_NO_EMPTY = 1 << OPTBIT_NO_EMPTY ,
OPT_UPTO_NUMBER = 1 << OPTBIT_UPTO_NUMBER,
OPT_UPTO_SIZE = 1 << OPTBIT_UPTO_SIZE ,
OPT_EOF_STRING = 1 << OPTBIT_EOF_STRING , /* GNU: -e[<param>] */
OPT_EOF_STRING1 = 1 << OPTBIT_EOF_STRING1, /* SUS: -E<param> */
OPT_INTERACTIVE = IF_FEATURE_XARGS_SUPPORT_CONFIRMATION((1 << OPTBIT_INTERACTIVE)) + 0,
OPT_TERMINATE = IF_FEATURE_XARGS_SUPPORT_TERMOPT( (1 << OPTBIT_TERMINATE )) + 0,
OPT_ZEROTERM = IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( (1 << OPTBIT_ZEROTERM )) + 0,
2006-09-29 13:50:30 +05:30
};
#define OPTION_STR "+trn:s:e::E:" \
IF_FEATURE_XARGS_SUPPORT_CONFIRMATION("p") \
IF_FEATURE_XARGS_SUPPORT_TERMOPT( "x") \
IF_FEATURE_XARGS_SUPPORT_ZERO_TERM( "0")
int xargs_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
2003-10-31 04:17:16 +05:30
int xargs_main(int argc, char **argv)
2003-10-10 17:40:18 +05:30
{
2003-10-31 04:17:16 +05:30
char **args;
2006-09-29 13:50:30 +05:30
int i, n;
2003-10-31 04:17:16 +05:30
xlist_t *list = NULL;
xlist_t *cur;
int child_error = 0;
char *max_args, *max_chars;
int n_max_arg;
const char *eof_str = NULL;
unsigned opt;
2003-10-31 04:17:16 +05:30
size_t n_max_chars;
2006-09-29 13:50:30 +05:30
#if ENABLE_FEATURE_XARGS_SUPPORT_ZERO_TERM
xlist_t* (*read_args)(xlist_t*, const char*, size_t, char*) = process_stdin;
#else
#define read_args process_stdin
2003-10-10 17:40:18 +05:30
#endif
opt = getopt32(argv, OPTION_STR, &max_args, &max_chars, &eof_str, &eof_str);
2003-10-10 17:40:18 +05:30
/* -E ""? You may wonder why not just omit -E?
* This is used for portability:
* old xargs was using "_" as default for -E / -e */
if ((opt & OPT_EOF_STRING1) && eof_str[0] == '\0')
eof_str = NULL;
2006-09-29 13:50:30 +05:30
if (opt & OPT_ZEROTERM)
IF_FEATURE_XARGS_SUPPORT_ZERO_TERM(read_args = process0_stdin);
2003-10-31 04:17:16 +05:30
argv += optind;
argc -= optind;
2006-09-29 13:50:30 +05:30
if (!argc) {
2003-10-31 04:17:16 +05:30
/* default behavior is to echo all the filenames */
*argv = (char*)"echo";
2006-09-29 13:50:30 +05:30
argc++;
2003-10-31 04:17:16 +05:30
}
n_max_chars = ARG_MAX; /* might be calling sysconf(_SC_ARG_MAX) */
if (n_max_chars < 4*1024); /* paranoia */
n_max_chars = LONG_MAX;
/* The Open Group Base Specifications Issue 6:
* "The xargs utility shall limit the command line length such that
* when the command line is invoked, the combined argument
* and environment lists (see the exec family of functions
* in the System Interfaces volume of IEEE Std 1003.1-2001)
* shall not exceed {ARG_MAX}-2048 bytes".
*/
n_max_chars -= 2048;
/* Sanity check for systems with huge ARG_MAX defines (e.g., Suns which
* have it at 1 meg). Things will work fine with a large ARG_MAX but it
* will probably hurt the system more than it needs to; an array of this
* size is allocated.
*/
if (n_max_chars > 20 * 1024)
n_max_chars = 20 * 1024;
2006-09-29 13:50:30 +05:30
if (opt & OPT_UPTO_SIZE) {
size_t n_chars = 0;
n_max_chars = xatoul_range(max_chars, 1, n_max_chars);
2006-09-29 13:50:30 +05:30
for (i = 0; i < argc; i++) {
2003-10-31 04:17:16 +05:30
n_chars += strlen(*argv) + 1;
}
if (n_max_chars <= n_chars) {
bb_error_msg_and_die("can't fit single argument within argument list size limit");
2003-10-31 04:17:16 +05:30
}
n_max_chars -= n_chars;
}
2003-10-31 04:17:16 +05:30
max_chars = xmalloc(n_max_chars);
2006-09-29 13:50:30 +05:30
if (opt & OPT_UPTO_NUMBER) {
2006-10-08 18:19:22 +05:30
n_max_arg = xatoul_range(max_args, 1, INT_MAX);
2003-10-31 04:17:16 +05:30
} else {
n_max_arg = n_max_chars;
}
2003-10-10 17:40:18 +05:30
2006-09-29 13:50:30 +05:30
while ((list = read_args(list, eof_str, n_max_chars, max_chars)) != NULL ||
!(opt & OPT_NO_EMPTY))
{
size_t n_chars = 0;
2003-10-31 04:17:16 +05:30
opt |= OPT_NO_EMPTY;
n = 0;
#if ENABLE_FEATURE_XARGS_SUPPORT_TERMOPT
2003-10-31 04:17:16 +05:30
for (cur = list; cur;) {
n_chars += cur->length;
2003-10-31 04:17:16 +05:30
n++;
cur = cur->link;
if (n_chars > n_max_chars || (n == n_max_arg && cur)) {
if (opt & OPT_TERMINATE)
bb_error_msg_and_die("argument list too long");
break;
}
}
2003-10-09 16:36:45 +05:30
#else
2003-10-31 04:17:16 +05:30
for (cur = list; cur; cur = cur->link) {
n_chars += cur->length;
2003-10-31 04:17:16 +05:30
n++;
if (n_chars > n_max_chars || n == n_max_arg) {
break;
}
}
#endif /* FEATURE_XARGS_SUPPORT_TERMOPT */
2003-10-31 04:17:16 +05:30
2006-09-29 13:50:30 +05:30
/* allocate pointers for execvp:
argc*arg, n*arg from stdin, NULL */
args = xzalloc((n + argc + 1) * sizeof(char *));
2003-10-31 04:17:16 +05:30
2006-09-29 13:50:30 +05:30
/* store the command to be executed
2003-10-31 04:17:16 +05:30
(taken from the command line) */
2006-09-29 13:50:30 +05:30
for (i = 0; i < argc; i++)
2003-10-31 04:17:16 +05:30
args[i] = argv[i];
/* (taken from stdin) */
for (cur = list; n; cur = cur->link) {
2007-04-15 14:08:50 +05:30
args[i++] = cur->xstr;
2003-10-31 04:17:16 +05:30
n--;
}
2003-10-10 17:40:18 +05:30
2006-09-29 13:50:30 +05:30
if (opt & (OPT_INTERACTIVE | OPT_VERBOSE)) {
2003-10-31 04:17:16 +05:30
for (i = 0; args[i]; i++) {
if (i)
fputc(' ', stderr);
fputs(args[i], stderr);
}
2006-09-29 13:50:30 +05:30
if (!(opt & OPT_INTERACTIVE))
2003-10-31 04:17:16 +05:30
fputc('\n', stderr);
}
2006-09-29 13:50:30 +05:30
if (!(opt & OPT_INTERACTIVE) || xargs_ask_confirmation()) {
2003-10-31 04:17:16 +05:30
child_error = xargs_exec(args);
}
2003-10-31 04:17:16 +05:30
/* clean up */
2006-09-29 13:50:30 +05:30
for (i = argc; args[i]; i++) {
2003-10-31 04:17:16 +05:30
cur = list;
list = list->link;
free(cur);
}
free(args);
if (child_error > 0 && child_error != 123) {
break;
}
} /* while */
if (ENABLE_FEATURE_CLEAN_UP)
free(max_chars);
2003-10-31 04:17:16 +05:30
return child_error;
2003-10-10 17:40:18 +05:30
}
#ifdef TEST
2006-10-04 02:30:43 +05:30
const char *applet_name = "debug stuff usage";
2003-10-10 17:40:18 +05:30
void bb_show_usage(void)
{
fprintf(stderr, "Usage: %s [-p] [-r] [-t] -[x] [-n max_arg] [-s max_chars]\n",
2006-10-04 02:30:43 +05:30
applet_name);
exit(EXIT_FAILURE);
2003-10-10 17:40:18 +05:30
}
int main(int argc, char **argv)
{
2003-10-31 04:17:16 +05:30
return xargs_main(argc, argv);
2000-09-23 01:31:23 +05:30
}
#endif /* TEST */