/usr/src/usr.bin/xargs/xargs.c

Bug Summary

File:	src/usr.bin/xargs/xargs.c
Warning:	line 207, column 17 Null pointer passed as 2nd argument to string comparison function

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple amd64-unknown-openbsd7.4 -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name xargs.c -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 1 -pic-is-pie -mframe-pointer=all -relaxed-aliasing -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -target-feature +retpoline-indirect-calls -target-feature +retpoline-indirect-branches -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/usr.bin/xargs/obj -resource-dir /usr/local/llvm16/lib/clang/16 -internal-isystem /usr/local/llvm16/lib/clang/16/include -internal-externc-isystem /usr/include -O2 -fdebug-compilation-dir=/usr/src/usr.bin/xargs/obj -ferror-limit 19 -fwrapv -D_RET_PROTECTOR -ret-protector -fcf-protection=branch -fno-jump-tables -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/scan/2024-01-11-140451-98009-1 -x c /usr/src/usr.bin/xargs/xargs.c

1/*	$OpenBSD: xargs.c,v 1.38 2023/12/23 15:58:58 millert Exp $	*/
2/*	$FreeBSD: xargs.c,v 1.51 2003/05/03 19:09:11 obrien Exp $	*/

4/*-
* Copyright (c) 1990, 1993
*	The Regents of the University of California.  All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* John B. Roll Jr.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $xMach: xargs.c,v 1.6 2002/02/23 05:27:47 tim Exp $
*/

38#include <sys/wait.h>

40#include <ctype.h>
41#include <err.h>
42#include <errno(*__errno()).h>
43#include <fcntl.h>
44#include <paths.h>
45#include <signal.h>
46#include <stdio.h>
47#include <stdlib.h>
48#include <string.h>
49#include <unistd.h>
50#include <limits.h>

52#include "pathnames.h"

54static void	parse_input(int, char *[]);
55static void	prerun(int, char *[]);
56static int	prompt(void);
57static void	run(char **);
58static void	usage(void);
59void		strnsubst(char **, const char *, const char *, size_t);
60static void	waitchildren(const char *, int);

62static char **av, **bxp, **ep, **endxp, **xp;
63static char *argp, *bbp, *ebp, *inpline, *p, *replstr;
64static const char *eofstr;
65static int count, insingle, indouble, oflag, pflag, tflag, Rflag, rval, zflag;
66static int cnt, Iflag, jfound, Lflag, wasquoted, xflag, runeof = 1;
67static int curprocs, maxprocs;
68static size_t inpsize;

70extern char **environ;

72int
73main(int argc, char *argv[])
74{
long arg_max;
int ch, Jflag, nargs, nflag, nline;
size_t linelen;
char *endptr;
const char *errstr;

inpline = replstr = NULL((void *)0);
ep = environ;
eofstr = "";
Jflag = nflag = 0;

/*
* POSIX.2 limits the exec line length to ARG_MAX - 2K.  Running that
* caused some E2BIG errors, so it was changed to ARG_MAX - 4K.  Given
* that the smallest argument is 2 bytes in length, this means that
* the number of arguments is limited to:
*
*	 (ARG_MAX - 4K - LENGTH(utility + arguments)) / 2.
*
* We arbitrarily limit the number of arguments to 5000.  This is
* allowed by POSIX.2 as long as the resulting minimum exec line is
* at least LINE_MAX.  Realloc'ing as necessary is possible, but
* probably not worthwhile.
*/
nargs = 5000;
if ((arg_max = sysconf(_SC_ARG_MAX1)) == -1)
1
Assuming the condition is false→
2
←
Taking false branch→
errx(1, "sysconf(_SC_ARG_MAX) failed");

if (pledge("stdio rpath proc exec", NULL((void *)0)) == -1)
3
←
Assuming the condition is false→
4
←
Taking false branch→
err(1, "pledge");

nline = arg_max - 4 * 1024;
while (*ep != NULL((void *)0)) {
5
←
Assuming the condition is false→
6
←
Loop condition is false. Execution continues on line 111→
/* 1 byte for each '\0' */
nline -= strlen(*ep++) + 1 + sizeof(*ep);
}
maxprocs = 1;
while ((ch = getopt(argc, argv, "0E:I:J:L:n:oP:pR:rs:tx")) != -1)
7
←
Value assigned to 'optarg'→
8
←
Assuming the condition is true→
9
←
Loop condition is true.  Entering loop body→
12
←
 Execution continues on line 112→
13
←
Assuming the condition is false→
14
←
Loop condition is false. Execution continues on line 175→
switch (ch) {
10
←
Control jumps to 'case 74:'  at line 123→
case 'E':
	eofstr = optarg;
	break;
case 'I':
	Jflag = 0;
	Iflag = 1;
	Lflag = 1;
	replstr = optarg;
	break;
case 'J':
	Iflag = 0;
	Jflag = 1;
	replstr = optarg;
11
←
Value assigned to 'replstr'→
	break;
case 'L':
	Lflag = strtonum(optarg, 0, INT_MAX0x7fffffff, &errstr);
	if (errstr)
		errx(1, "-L %s: %s", optarg, errstr);
	break;
case 'n':
	nflag = 1;
	nargs = strtonum(optarg, 1, INT_MAX0x7fffffff, &errstr);
	if (errstr)
		errx(1, "-n %s: %s", optarg, errstr);
	break;
case 'o':
	oflag = 1;
	break;
case 'P':
	maxprocs = strtonum(optarg, 1, INT_MAX0x7fffffff, &errstr);
	if (errstr)
		errx(1, "-P %s: %s", optarg, errstr);
	break;
case 'p':
	pflag = 1;
	break;
case 'r':
	runeof = 0;
	break;
case 'R':
	Rflag = strtol(optarg, &endptr, 10);
	if (*endptr != '\0')
		errx(1, "replacements must be a number");
	break;
case 's':
	nline = strtonum(optarg, 0, INT_MAX0x7fffffff, &errstr);
	if (errstr)
		errx(1, "-s %s: %s", optarg, errstr);
	break;
case 't':
	tflag = 1;
	break;
case 'x':
	xflag = 1;
	break;
case '0':
	zflag = 1;
	break;
default:
	usage();
}
argc -= optind;
argv += optind;

if (!Iflag14.1
'Iflag' is 0
 && Rflag)
15
←
Assuming 'Rflag' is 0→
usage();
if (Iflag15.1
'Iflag' is 0
 && !Rflag)
Rflag = 5;
if (xflag && !nflag)
16
←
Assuming 'xflag' is 0→
usage();
if (Iflag16.1
'Iflag' is 0
 || Lflag)
17
←
Assuming 'Lflag' is 0→
xflag = 1;
if (replstr != NULL((void *)0) && *replstr == '\0')
18
←
Assuming 'replstr' is equal to NULL→
errx(1, "replstr may not be empty");

/*
* Allocate pointers for the utility name, the utility arguments,
* the maximum arguments to be read from stdin and the trailing
* NULL.
*/
linelen = 1 + argc + nargs + 1;
if ((av = bxp = calloc(linelen, sizeof(char *))) == NULL((void *)0))
19
←
Assuming the condition is false→
20
←
Taking false branch→
err(1, NULL((void *)0));

/*
* Use the user's name for the utility as argv[0], just like the
* shell.  Echo is the default.  Set up pointers for the user's
* arguments.
*/
if (*argv == NULL((void *)0))
21
←
Assuming the condition is false→
cnt = strlen(*bxp++ = _PATH_ECHO"/bin/echo");
else {
do {
	if (Jflag21.1
'Jflag' is 1
 && strcmp(*argv, replstr) == 0) {
22
←
Null pointer passed as 2nd argument to string comparison function
		char **avj;
		jfound = 1;
		argv++;
		for (avj = argv; *avj; avj++)
			cnt += strlen(*avj) + 1;
		break;
	}
	cnt += strlen(*bxp++ = *argv) + 1;
} while (*++argv != NULL((void *)0));
}

/*
* Set up begin/end/traversing pointers into the array.  The -n
* count doesn't include the trailing NULL pointer, so the malloc
* added in an extra slot.
*/
endxp = (xp = bxp) + nargs;

/*
* Allocate buffer space for the arguments read from stdin and the
* trailing NULL.  Buffer space is defined as the default or specified
* space, minus the length of the utility name and arguments.  Set up
* begin/end/traversing pointers into the array.  The -s count does
* include the trailing NULL, so the malloc didn't add in an extra
* slot.
*/
nline -= cnt;
if (nline <= 0)
errx(1, "insufficient space for command");

if ((bbp = malloc((size_t)(nline + 1))) == NULL((void *)0))
err(1, NULL((void *)0));
ebp = (argp = p = bbp) + nline - 1;
for (;;)
parse_input(argc, argv);
243}

245static void
246parse_input(int argc, char *argv[])
247{
int hasblank = 0;
static int hadblank = 0;
int ch, foundeof = 0;
char **avj;

ch = getchar()(!__isthreaded ? (--((&__sF[0]))->_r < 0 ? __srget(
(&__sF[0])) : (int)(*((&__sF[0]))->_p++)) : (getc)
((&__sF[0])));
if (isblank(ch)) {
/* Quotes escape tabs and spaces. */
if (insingle || indouble)
	goto addch;
hasblank = 1;
if (zflag)
	goto addch;
goto arg2;
}

switch (ch) {
case EOF(-1):
/* No arguments since last exec. */
if (p == bbp) {
	if (runeof)
		prerun(0, av);
	waitchildren(*argv, 1);
	exit(rval);
}
goto arg1;
case '\0':
if (zflag) {
	/*
	 * Increment 'count', so that nulls will be treated
	 * as end-of-line, as well as end-of-argument.  This
	 * is needed so -0 works properly with -I and -L.
	 */
	count++;
	goto arg2;
}
goto addch;
case '\n':
if (zflag)
	goto addch;
hasblank = 1;
if (hadblank == 0)
	count++;

/* Quotes do not escape newlines. */
293arg1:		if (insingle || indouble)
	errx(1, "unterminated quote");
295arg2:
foundeof = *eofstr != '\0' &&
    strcmp(argp, eofstr) == 0;

/*
 * Do not make empty args unless they are quoted or
 * we are run as "find -0" and not at EOF.
 */
if (((zflag && ch != EOF(-1)) || argp != p || wasquoted) &&
    !foundeof) {
	*p++ = '\0';
	*xp++ = argp;
	if (Iflag) {
		size_t curlen;

		if (inpline == NULL((void *)0))
			curlen = 0;
		else {
			/*
			 * If this string is not zero
			 * length, append a space for
			 * separation before the next
			 * argument.
			 */
			if ((curlen = strlen(inpline)))
				strlcat(inpline, " ", inpsize);
		}
		curlen++;
		/*
		 * Allocate enough to hold what we will
		 * be holding in a second, and to append
		 * a space next time through, if we have
		 * to.
		 */
		inpsize = curlen + 2 + strlen(argp);
		inpline = realloc(inpline, inpsize);
		if (inpline == NULL((void *)0))
			errx(1, "realloc failed");
		if (curlen == 1)
			strlcpy(inpline, argp, inpsize);
		else
			strlcat(inpline, argp, inpsize);
	}
}

/*
 * If max'd out on args or buffer, or reached EOF,
 * run the command.  If xflag and max'd out on buffer
 * but not on args, object.  Having reached the limit
 * of input lines, as specified by -L is the same as
 * maxing out on arguments.
 */
if (xp == endxp || p > ebp || ch == EOF(-1) ||
    (Lflag <= count && xflag) || foundeof) {
	if (xflag && xp != endxp && p > ebp)
		errx(1, "insufficient space for arguments");
	if (jfound) {
		for (avj = argv; *avj; avj++)
			*xp++ = *avj;
	}
	prerun(argc, av);
	if (ch == EOF(-1) || foundeof) {
		waitchildren(*argv, 1);
		exit(rval);
	}
	p = bbp;
	xp = bxp;
	count = 0;
}
argp = p;
wasquoted = 0;
break;
case '\'':
if (indouble || zflag)
	goto addch;
insingle = !insingle;
wasquoted = 1;
break;
case '"':
if (insingle || zflag)
	goto addch;
indouble = !indouble;
wasquoted = 1;
break;
case '\\':
if (zflag)
	goto addch;
/* Backslash escapes anything, is escaped by quotes. */
if (!insingle && !indouble && (ch = getchar()(!__isthreaded ? (--((&__sF[0]))->_r < 0 ? __srget(
(&__sF[0])) : (int)(*((&__sF[0]))->_p++)) : (getc)
((&__sF[0])))) == EOF(-1))
	errx(1, "backslash at EOF");
/* FALLTHROUGH */
default:
387addch:		if (p < ebp) {
	*p++ = ch;
	break;
}

/* If only one argument, not enough buffer space. */
if (bxp == xp)
	errx(1, "insufficient space for argument");
/* Didn't hit argument limit, so if xflag object. */
if (xflag)
	errx(1, "insufficient space for arguments");

if (jfound) {
	for (avj = argv; *avj; avj++)
		*xp++ = *avj;
}
prerun(argc, av);
xp = bxp;
cnt = ebp - argp;
memmove(bbp, argp, (size_t)cnt);
p = (argp = bbp) + cnt;
*p++ = ch;
break;
}
hadblank = hasblank;
412}

414/*
* Do things necessary before run()'ing, such as -I substitution,
* and then call run().
*/
418static void
419prerun(int argc, char *argv[])
420{
char **tmp, **tmp2, **avj;
int repls;

repls = Rflag;
runeof = 0;

if (argc == 0 || repls == 0) {
*xp = NULL((void *)0);
run(argv);
return;
}

avj = argv;

/*
* Allocate memory to hold the argument list, and
* a NULL at the tail.
*/
tmp = calloc(argc + 1, sizeof(char *));
if (tmp == NULL((void *)0))
err(1, NULL((void *)0));
tmp2 = tmp;

/*
* Save the first argument and iterate over it, we
* cannot do strnsubst() to it.
*/
if ((*tmp++ = strdup(*avj++)) == NULL((void *)0))
err(1, NULL((void *)0));

/*
* For each argument to utility, if we have not used up
* the number of replacements we are allowed to do, and
* if the argument contains at least one occurrence of
* replstr, call strnsubst(), else just save the string.
* Iterations over elements of avj and tmp are done
* where appropriate.
*/
while (--argc) {
*tmp = *avj++;
if (repls && strstr(*tmp, replstr) != NULL((void *)0)) {
	strnsubst(tmp++, replstr, inpline, (size_t)255);
	if (repls > 0)
		repls--;
} else {
	if ((*tmp = strdup(*tmp)) == NULL((void *)0))
		err(1, NULL((void *)0));
	tmp++;
}
}

/*
* Run it.
*/
*tmp = NULL((void *)0);
run(tmp2);

/*
* Walk from the tail to the head, free along the way.
*/
for (; tmp2 != tmp; tmp--)
free(*tmp);
/*
* Now free the list itself.
*/
free(tmp2);

/*
* Free the input line buffer, if we have one.
*/
free(inpline);
inpline = NULL((void *)0);
493}

495static void
496run(char **argv)
497{
pid_t pid;
int fd;
char **avec;

/*
* If the user wants to be notified of each command before it is
* executed, notify them.  If they want the notification to be
* followed by a prompt, then prompt them.
*/
if (tflag || pflag) {
fprintf(stderr(&__sF[2]), "%s", *argv);
for (avec = argv + 1; *avec != NULL((void *)0); ++avec)
	fprintf(stderr(&__sF[2]), " %s", *avec);
/*
 * If the user has asked to be prompted, do so.
 */
if (pflag)
	/*
	 * If they asked not to exec, return without execution
	 * but if they asked to, go to the execution.  If we
	 * could not open their tty, break the switch and drop
	 * back to -t behaviour.
	 */
	switch (prompt()) {
	case 0:
		return;
	case 1:
		goto exec;
	case 2:
		break;
	}
fprintf(stderr(&__sF[2]), "\n");
fflush(stderr(&__sF[2]));
}
532exec:
switch (pid = vfork()) {
case -1:
err(1, "vfork");
case 0:
if (oflag) {
	if ((fd = open(_PATH_TTY"/dev/tty", O_RDONLY0x0000)) == -1) {
		warn("can't open /dev/tty");
		_exit(1);
	}
} else {
	fd = open(_PATH_DEVNULL"/dev/null", O_RDONLY0x0000);
}
if (fd > STDIN_FILENO0) {
	if (dup2(fd, STDIN_FILENO0) != 0) {
		warn("can't dup2 to stdin");
		_exit(1);
	}
	close(fd);
}
execvp(argv[0], argv);
warn("%s", argv[0]);
_exit(errno(*__errno()) == ENOENT2 ? 127 : 126);
}
curprocs++;
waitchildren(*argv, 0);
558}

560static void
561waitchildren(const char *name, int waitall)
562{
pid_t pid;
int status;

while ((pid = waitpid(-1, &status, !waitall && curprocs < maxprocs ?
   WNOHANG0x01 : 0)) > 0) {
curprocs--;
/*
 * According to POSIX, we have to exit if the utility exits
 * with a 255 status, or is interrupted by a signal.
 * We are allowed to return any exit status between 1 and
 * 125 in these cases, but we'll use 124 and 125, the same
 * values used by GNU xargs.
 */
if (WIFEXITED(status)(((status) & 0177) == 0)) {
	if (WEXITSTATUS(status)(int)(((unsigned)(status) >> 8) & 0xff) == 255) {
		warnx("%s exited with status 255", name);
		exit(124);
	} else if (WEXITSTATUS(status)(int)(((unsigned)(status) >> 8) & 0xff) == 127 ||
	    WEXITSTATUS(status)(int)(((unsigned)(status) >> 8) & 0xff) == 126) {
		exit(WEXITSTATUS(status)(int)(((unsigned)(status) >> 8) & 0xff));
	} else if (WEXITSTATUS(status)(int)(((unsigned)(status) >> 8) & 0xff) != 0) {
		rval = 123;
	}
} else if (WIFSIGNALED(status)(((status) & 0177) != 0177 && ((status) & 0177
) != 0)) {
	if (WTERMSIG(status)(((status) & 0177)) != SIGPIPE13) {
		if (WTERMSIG(status)(((status) & 0177)) < NSIG33)
			warnx("%s terminated by SIG%s", name,
			    sys_signame[WTERMSIG(status)(((status) & 0177))]);
		else
			warnx("%s terminated by signal %d",
			    name, WTERMSIG(status)(((status) & 0177)));
	}
	exit(125);
}
}
if (pid == -1 && errno(*__errno()) != ECHILD10)
err(1, "waitpid");
600}

602/*
* Prompt the user about running a command.
*/
605static int
606prompt(void)
607{
size_t rsize;
char *response;
FILE *ttyfp;
int doit = 0;

if ((ttyfp = fopen(_PATH_TTY"/dev/tty", "r")) == NULL((void *)0))
return (2);	/* Indicate that the TTY failed to open. */
fprintf(stderr(&__sF[2]), "?...");
fflush(stderr(&__sF[2]));
response = fgetln(ttyfp, &rsize);
doit = response != NULL((void *)0) && (*response == 'y' || *response == 'Y');
fclose(ttyfp);
return (doit);
621}

623static void
624usage(void)
625{
fprintf(stderr(&__sF[2]),
627"usage: xargs [-0oprt] [-E eofstr] [-I replstr [-R replacements]] [-J replstr]\n"
628"             [-L number] [-n number [-x]] [-P maxprocs] [-s size]\n"
629"             [utility [argument ...]]\n");
exit(1);
631}