main.c revision 299529
1/*
2 * Copyright (c) 2003-2009 Tim Kientzle
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#include "test.h"
27#include "test_utils.h"
28#ifdef HAVE_SYS_IOCTL_H
29#include <sys/ioctl.h>
30#endif
31#ifdef HAVE_SYS_TIME_H
32#include <sys/time.h>
33#endif
34#include <errno.h>
35#ifdef HAVE_ICONV_H
36#include <iconv.h>
37#endif
38/*
39 * Some Linux distributions have both linux/ext2_fs.h and ext2fs/ext2_fs.h.
40 * As the include guards don't agree, the order of include is important.
41 */
42#ifdef HAVE_LINUX_EXT2_FS_H
43#include <linux/ext2_fs.h>      /* for Linux file flags */
44#endif
45#if defined(HAVE_EXT2FS_EXT2_FS_H) && !defined(__CYGWIN__)
46#include <ext2fs/ext2_fs.h>     /* Linux file flags, broken on Cygwin */
47#endif
48#include <limits.h>
49#include <locale.h>
50#ifdef HAVE_SIGNAL_H
51#include <signal.h>
52#endif
53#include <stdarg.h>
54#include <time.h>
55
56/*
57 * This same file is used pretty much verbatim for all test harnesses.
58 *
59 * The next few lines are the only differences.
60 * TODO: Move this into a separate configuration header, have all test
61 * suites share one copy of this file.
62 */
63__FBSDID("$FreeBSD: head/contrib/libarchive/libarchive/test/main.c 299529 2016-05-12 10:16:16Z mm $");
64#define KNOWNREF	"test_compat_gtar_1.tar.uu"
65#define	ENVBASE "LIBARCHIVE" /* Prefix for environment variables. */
66#undef	PROGRAM              /* Testing a library, not a program. */
67#define	LIBRARY	"libarchive"
68#define	EXTRA_DUMP(x)	archive_error_string((struct archive *)(x))
69#define	EXTRA_ERRNO(x)	archive_errno((struct archive *)(x))
70#define	EXTRA_VERSION	archive_version_details()
71
72/*
73 *
74 * Windows support routines
75 *
76 * Note: Configuration is a tricky issue.  Using HAVE_* feature macros
77 * in the test harness is dangerous because they cover up
78 * configuration errors.  The classic example of this is omitting a
79 * configure check.  If libarchive and libarchive_test both look for
80 * the same feature macro, such errors are hard to detect.  Platform
81 * macros (e.g., _WIN32 or __GNUC__) are a little better, but can
82 * easily lead to very messy code.  It's best to limit yourself
83 * to only the most generic programming techniques in the test harness
84 * and thus avoid conditionals altogether.  Where that's not possible,
85 * try to minimize conditionals by grouping platform-specific tests in
86 * one place (e.g., test_acl_freebsd) or by adding new assert()
87 * functions (e.g., assertMakeHardlink()) to cover up platform
88 * differences.  Platform-specific coding in libarchive_test is often
89 * a symptom that some capability is missing from libarchive itself.
90 */
91#if defined(_WIN32) && !defined(__CYGWIN__)
92#include <io.h>
93#include <direct.h>
94#include <windows.h>
95#ifndef F_OK
96#define F_OK (0)
97#endif
98#ifndef S_ISDIR
99#define S_ISDIR(m)  ((m) & _S_IFDIR)
100#endif
101#ifndef S_ISREG
102#define S_ISREG(m)  ((m) & _S_IFREG)
103#endif
104#if !defined(__BORLANDC__)
105#define access _access
106#undef chdir
107#define chdir _chdir
108#endif
109#ifndef fileno
110#define fileno _fileno
111#endif
112/*#define fstat _fstat64*/
113#if !defined(__BORLANDC__)
114#define getcwd _getcwd
115#endif
116#define lstat stat
117/*#define lstat _stat64*/
118/*#define stat _stat64*/
119#define rmdir _rmdir
120#if !defined(__BORLANDC__)
121#define strdup _strdup
122#define umask _umask
123#endif
124#define int64_t __int64
125#endif
126
127#if defined(HAVE__CrtSetReportMode)
128# include <crtdbg.h>
129#endif
130
131/* Path to working directory for current test */
132const char *testworkdir;
133#ifdef PROGRAM
134/* Pathname of exe to be tested. */
135const char *testprogfile;
136/* Name of exe to use in printf-formatted command strings. */
137/* On Windows, this includes leading/trailing quotes. */
138const char *testprog;
139#endif
140
141#if defined(_WIN32) && !defined(__CYGWIN__)
142static void	*GetFunctionKernel32(const char *);
143static int	 my_CreateSymbolicLinkA(const char *, const char *, int);
144static int	 my_CreateHardLinkA(const char *, const char *);
145static int	 my_GetFileInformationByName(const char *,
146		     BY_HANDLE_FILE_INFORMATION *);
147
148static void *
149GetFunctionKernel32(const char *name)
150{
151	static HINSTANCE lib;
152	static int set;
153	if (!set) {
154		set = 1;
155		lib = LoadLibrary("kernel32.dll");
156	}
157	if (lib == NULL) {
158		fprintf(stderr, "Can't load kernel32.dll?!\n");
159		exit(1);
160	}
161	return (void *)GetProcAddress(lib, name);
162}
163
164static int
165my_CreateSymbolicLinkA(const char *linkname, const char *target, int flags)
166{
167	static BOOLEAN (WINAPI *f)(LPCSTR, LPCSTR, DWORD);
168	static int set;
169	if (!set) {
170		set = 1;
171		f = GetFunctionKernel32("CreateSymbolicLinkA");
172	}
173	return f == NULL ? 0 : (*f)(linkname, target, flags);
174}
175
176static int
177my_CreateHardLinkA(const char *linkname, const char *target)
178{
179	static BOOLEAN (WINAPI *f)(LPCSTR, LPCSTR, LPSECURITY_ATTRIBUTES);
180	static int set;
181	if (!set) {
182		set = 1;
183		f = GetFunctionKernel32("CreateHardLinkA");
184	}
185	return f == NULL ? 0 : (*f)(linkname, target, NULL);
186}
187
188static int
189my_GetFileInformationByName(const char *path, BY_HANDLE_FILE_INFORMATION *bhfi)
190{
191	HANDLE h;
192	int r;
193
194	memset(bhfi, 0, sizeof(*bhfi));
195	h = CreateFile(path, FILE_READ_ATTRIBUTES, 0, NULL,
196		OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
197	if (h == INVALID_HANDLE_VALUE)
198		return (0);
199	r = GetFileInformationByHandle(h, bhfi);
200	CloseHandle(h);
201	return (r);
202}
203#endif
204
205#if defined(HAVE__CrtSetReportMode) && !defined(__WATCOMC__)
206static void
207invalid_parameter_handler(const wchar_t * expression,
208    const wchar_t * function, const wchar_t * file,
209    unsigned int line, uintptr_t pReserved)
210{
211	/* nop */
212}
213#endif
214
215/*
216 *
217 * OPTIONS FLAGS
218 *
219 */
220
221/* Enable core dump on failure. */
222static int dump_on_failure = 0;
223/* Default is to remove temp dirs and log data for successful tests. */
224static int keep_temp_files = 0;
225/* Default is to run the specified tests once and report errors. */
226static int until_failure = 0;
227/* Default is to just report pass/fail for each test. */
228static int verbosity = 0;
229#define	VERBOSITY_SUMMARY_ONLY -1 /* -q */
230#define VERBOSITY_PASSFAIL 0   /* Default */
231#define VERBOSITY_LIGHT_REPORT 1 /* -v */
232#define VERBOSITY_FULL 2 /* -vv */
233/* A few places generate even more output for verbosity > VERBOSITY_FULL,
234 * mostly for debugging the test harness itself. */
235/* Cumulative count of assertion failures. */
236static int failures = 0;
237/* Cumulative count of reported skips. */
238static int skips = 0;
239/* Cumulative count of assertions checked. */
240static int assertions = 0;
241
242/* Directory where uuencoded reference files can be found. */
243static const char *refdir;
244
245/*
246 * Report log information selectively to console and/or disk log.
247 */
248static int log_console = 0;
249static FILE *logfile;
250static void
251vlogprintf(const char *fmt, va_list ap)
252{
253#ifdef va_copy
254	va_list lfap;
255	va_copy(lfap, ap);
256#endif
257	if (log_console)
258		vfprintf(stdout, fmt, ap);
259	if (logfile != NULL)
260#ifdef va_copy
261		vfprintf(logfile, fmt, lfap);
262	va_end(lfap);
263#else
264		vfprintf(logfile, fmt, ap);
265#endif
266}
267
268static void
269logprintf(const char *fmt, ...)
270{
271	va_list ap;
272	va_start(ap, fmt);
273	vlogprintf(fmt, ap);
274	va_end(ap);
275}
276
277/* Set up a message to display only if next assertion fails. */
278static char msgbuff[4096];
279static const char *msg, *nextmsg;
280void
281failure(const char *fmt, ...)
282{
283	va_list ap;
284	if (fmt == NULL) {
285		nextmsg = NULL;
286	} else {
287		va_start(ap, fmt);
288		vsprintf(msgbuff, fmt, ap);
289		va_end(ap);
290		nextmsg = msgbuff;
291	}
292}
293
294/*
295 * Copy arguments into file-local variables.
296 * This was added to permit vararg assert() functions without needing
297 * variadic wrapper macros.  Turns out that the vararg capability is almost
298 * never used, so almost all of the vararg assertions can be simplified
299 * by removing the vararg capability and reworking the wrapper macro to
300 * pass __FILE__, __LINE__ directly into the function instead of using
301 * this hook.  I suspect this machinery is used so rarely that we
302 * would be better off just removing it entirely.  That would simplify
303 * the code here noticeably.
304 */
305static const char *skipping_filename;
306static int skipping_line;
307void skipping_setup(const char *filename, int line)
308{
309	skipping_filename = filename;
310	skipping_line = line;
311}
312
313/* Called at the beginning of each assert() function. */
314static void
315assertion_count(const char *file, int line)
316{
317	(void)file; /* UNUSED */
318	(void)line; /* UNUSED */
319	++assertions;
320	/* Proper handling of "failure()" message. */
321	msg = nextmsg;
322	nextmsg = NULL;
323	/* Uncomment to print file:line after every assertion.
324	 * Verbose, but occasionally useful in tracking down crashes. */
325	/* printf("Checked %s:%d\n", file, line); */
326}
327
328/*
329 * For each test source file, we remember how many times each
330 * assertion was reported.  Cleared before each new test,
331 * used by test_summarize().
332 */
333static struct line {
334	int count;
335	int skip;
336}  failed_lines[10000];
337const char *failed_filename;
338
339/* Count this failure, setup up log destination and handle initial report. */
340static void
341failure_start(const char *filename, int line, const char *fmt, ...)
342{
343	va_list ap;
344
345	/* Record another failure for this line. */
346	++failures;
347	failed_filename = filename;
348	failed_lines[line].count++;
349
350	/* Determine whether to log header to console. */
351	switch (verbosity) {
352	case VERBOSITY_LIGHT_REPORT:
353		log_console = (failed_lines[line].count < 2);
354		break;
355	default:
356		log_console = (verbosity >= VERBOSITY_FULL);
357	}
358
359	/* Log file:line header for this failure */
360	va_start(ap, fmt);
361#if _MSC_VER
362	logprintf("%s(%d): ", filename, line);
363#else
364	logprintf("%s:%d: ", filename, line);
365#endif
366	vlogprintf(fmt, ap);
367	va_end(ap);
368	logprintf("\n");
369
370	if (msg != NULL && msg[0] != '\0') {
371		logprintf("   Description: %s\n", msg);
372		msg = NULL;
373	}
374
375	/* Determine whether to log details to console. */
376	if (verbosity == VERBOSITY_LIGHT_REPORT)
377		log_console = 0;
378}
379
380/* Complete reporting of failed tests. */
381/*
382 * The 'extra' hook here is used by libarchive to include libarchive
383 * error messages with assertion failures.  It could also be used
384 * to add strerror() output, for example.  Just define the EXTRA_DUMP()
385 * macro appropriately.
386 */
387static void
388failure_finish(void *extra)
389{
390	(void)extra; /* UNUSED (maybe) */
391#ifdef EXTRA_DUMP
392	if (extra != NULL) {
393		logprintf("    errno: %d\n", EXTRA_ERRNO(extra));
394		logprintf("   detail: %s\n", EXTRA_DUMP(extra));
395	}
396#endif
397
398	if (dump_on_failure) {
399		fprintf(stderr,
400		    " *** forcing core dump so failure can be debugged ***\n");
401		abort();
402	}
403}
404
405/* Inform user that we're skipping some checks. */
406void
407test_skipping(const char *fmt, ...)
408{
409	char buff[1024];
410	va_list ap;
411
412	va_start(ap, fmt);
413	vsprintf(buff, fmt, ap);
414	va_end(ap);
415	/* Use failure() message if set. */
416	msg = nextmsg;
417	nextmsg = NULL;
418	/* failure_start() isn't quite right, but is awfully convenient. */
419	failure_start(skipping_filename, skipping_line, "SKIPPING: %s", buff);
420	--failures; /* Undo failures++ in failure_start() */
421	/* Don't failure_finish() here. */
422	/* Mark as skip, so doesn't count as failed test. */
423	failed_lines[skipping_line].skip = 1;
424	++skips;
425}
426
427/*
428 *
429 * ASSERTIONS
430 *
431 */
432
433/* Generic assert() just displays the failed condition. */
434int
435assertion_assert(const char *file, int line, int value,
436    const char *condition, void *extra)
437{
438	assertion_count(file, line);
439	if (!value) {
440		failure_start(file, line, "Assertion failed: %s", condition);
441		failure_finish(extra);
442	}
443	return (value);
444}
445
446/* chdir() and report any errors */
447int
448assertion_chdir(const char *file, int line, const char *pathname)
449{
450	assertion_count(file, line);
451	if (chdir(pathname) == 0)
452		return (1);
453	failure_start(file, line, "chdir(\"%s\")", pathname);
454	failure_finish(NULL);
455	return (0);
456
457}
458
459/* Verify two integers are equal. */
460int
461assertion_equal_int(const char *file, int line,
462    long long v1, const char *e1, long long v2, const char *e2, void *extra)
463{
464	assertion_count(file, line);
465	if (v1 == v2)
466		return (1);
467	failure_start(file, line, "%s != %s", e1, e2);
468	logprintf("      %s=%lld (0x%llx, 0%llo)\n", e1, v1, v1, v1);
469	logprintf("      %s=%lld (0x%llx, 0%llo)\n", e2, v2, v2, v2);
470	failure_finish(extra);
471	return (0);
472}
473
474/*
475 * Utility to convert a single UTF-8 sequence.
476 */
477static int
478_utf8_to_unicode(uint32_t *pwc, const char *s, size_t n)
479{
480	static const char utf8_count[256] = {
481		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 00 - 0F */
482		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 10 - 1F */
483		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 20 - 2F */
484		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 30 - 3F */
485		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 40 - 4F */
486		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 50 - 5F */
487		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 60 - 6F */
488		 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,/* 70 - 7F */
489		 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,/* 80 - 8F */
490		 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,/* 90 - 9F */
491		 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,/* A0 - AF */
492		 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,/* B0 - BF */
493		 0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,/* C0 - CF */
494		 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,/* D0 - DF */
495		 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3,/* E0 - EF */
496		 4, 4, 4, 4, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 /* F0 - FF */
497	};
498	int ch;
499	int cnt;
500	uint32_t wc;
501
502	*pwc = 0;
503
504	/* Sanity check. */
505	if (n == 0)
506		return (0);
507	/*
508	 * Decode 1-4 bytes depending on the value of the first byte.
509	 */
510	ch = (unsigned char)*s;
511	if (ch == 0)
512		return (0); /* Standard:  return 0 for end-of-string. */
513	cnt = utf8_count[ch];
514
515	/* Invalide sequence or there are not plenty bytes. */
516	if (n < (size_t)cnt)
517		return (-1);
518
519	/* Make a Unicode code point from a single UTF-8 sequence. */
520	switch (cnt) {
521	case 1:	/* 1 byte sequence. */
522		*pwc = ch & 0x7f;
523		return (cnt);
524	case 2:	/* 2 bytes sequence. */
525		if ((s[1] & 0xc0) != 0x80) return (-1);
526		*pwc = ((ch & 0x1f) << 6) | (s[1] & 0x3f);
527		return (cnt);
528	case 3:	/* 3 bytes sequence. */
529		if ((s[1] & 0xc0) != 0x80) return (-1);
530		if ((s[2] & 0xc0) != 0x80) return (-1);
531		wc = ((ch & 0x0f) << 12)
532		    | ((s[1] & 0x3f) << 6)
533		    | (s[2] & 0x3f);
534		if (wc < 0x800)
535			return (-1);/* Overlong sequence. */
536		break;
537	case 4:	/* 4 bytes sequence. */
538		if (n < 4)
539			return (-1);
540		if ((s[1] & 0xc0) != 0x80) return (-1);
541		if ((s[2] & 0xc0) != 0x80) return (-1);
542		if ((s[3] & 0xc0) != 0x80) return (-1);
543		wc = ((ch & 0x07) << 18)
544		    | ((s[1] & 0x3f) << 12)
545		    | ((s[2] & 0x3f) << 6)
546		    | (s[3] & 0x3f);
547		if (wc < 0x10000)
548			return (-1);/* Overlong sequence. */
549		break;
550	default:
551		return (-1);
552	}
553
554	/* The code point larger than 0x10FFFF is not leagal
555	 * Unicode values. */
556	if (wc > 0x10FFFF)
557		return (-1);
558	/* Correctly gets a Unicode, returns used bytes. */
559	*pwc = wc;
560	return (cnt);
561}
562
563static void strdump(const char *e, const char *p, int ewidth, int utf8)
564{
565	const char *q = p;
566
567	logprintf("      %*s = ", ewidth, e);
568	if (p == NULL) {
569		logprintf("NULL\n");
570		return;
571	}
572	logprintf("\"");
573	while (*p != '\0') {
574		unsigned int c = 0xff & *p++;
575		switch (c) {
576		case '\a': logprintf("\\a"); break;
577		case '\b': logprintf("\\b"); break;
578		case '\n': logprintf("\\n"); break;
579		case '\r': logprintf("\\r"); break;
580		default:
581			if (c >= 32 && c < 127)
582				logprintf("%c", c);
583			else
584				logprintf("\\x%02X", c);
585		}
586	}
587	logprintf("\"");
588	logprintf(" (length %d)", q == NULL ? -1 : (int)strlen(q));
589
590	/*
591	 * If the current string is UTF-8, dump its code points.
592	 */
593	if (utf8) {
594		size_t len;
595		uint32_t uc;
596		int n;
597		int cnt = 0;
598
599		p = q;
600		len = strlen(p);
601		logprintf(" [");
602		while ((n = _utf8_to_unicode(&uc, p, len)) > 0) {
603			if (p != q)
604				logprintf(" ");
605			logprintf("%04X", uc);
606			p += n;
607			len -= n;
608			cnt++;
609		}
610		logprintf("]");
611		logprintf(" (count %d", cnt);
612		if (n < 0) {
613			logprintf(",unknown %d bytes", len);
614		}
615		logprintf(")");
616
617	}
618	logprintf("\n");
619}
620
621/* Verify two strings are equal, dump them if not. */
622int
623assertion_equal_string(const char *file, int line,
624    const char *v1, const char *e1,
625    const char *v2, const char *e2,
626    void *extra, int utf8)
627{
628	int l1, l2;
629
630	assertion_count(file, line);
631	if (v1 == v2 || (v1 != NULL && v2 != NULL && strcmp(v1, v2) == 0))
632		return (1);
633	failure_start(file, line, "%s != %s", e1, e2);
634	l1 = (int)strlen(e1);
635	l2 = (int)strlen(e2);
636	if (l1 < l2)
637		l1 = l2;
638	strdump(e1, v1, l1, utf8);
639	strdump(e2, v2, l1, utf8);
640	failure_finish(extra);
641	return (0);
642}
643
644static void
645wcsdump(const char *e, const wchar_t *w)
646{
647	logprintf("      %s = ", e);
648	if (w == NULL) {
649		logprintf("(null)");
650		return;
651	}
652	logprintf("\"");
653	while (*w != L'\0') {
654		unsigned int c = *w++;
655		if (c >= 32 && c < 127)
656			logprintf("%c", c);
657		else if (c < 256)
658			logprintf("\\x%02X", c);
659		else if (c < 0x10000)
660			logprintf("\\u%04X", c);
661		else
662			logprintf("\\U%08X", c);
663	}
664	logprintf("\"\n");
665}
666
667#ifndef HAVE_WCSCMP
668static int
669wcscmp(const wchar_t *s1, const wchar_t *s2)
670{
671
672	while (*s1 == *s2++) {
673		if (*s1++ == L'\0')
674			return 0;
675	}
676	if (*s1 > *--s2)
677		return 1;
678	else
679		return -1;
680}
681#endif
682
683/* Verify that two wide strings are equal, dump them if not. */
684int
685assertion_equal_wstring(const char *file, int line,
686    const wchar_t *v1, const char *e1,
687    const wchar_t *v2, const char *e2,
688    void *extra)
689{
690	assertion_count(file, line);
691	if (v1 == v2)
692		return (1);
693	if (v1 != NULL && v2 != NULL && wcscmp(v1, v2) == 0)
694		return (1);
695	failure_start(file, line, "%s != %s", e1, e2);
696	wcsdump(e1, v1);
697	wcsdump(e2, v2);
698	failure_finish(extra);
699	return (0);
700}
701
702/*
703 * Pretty standard hexdump routine.  As a bonus, if ref != NULL, then
704 * any bytes in p that differ from ref will be highlighted with '_'
705 * before and after the hex value.
706 */
707static void
708hexdump(const char *p, const char *ref, size_t l, size_t offset)
709{
710	size_t i, j;
711	char sep;
712
713	if (p == NULL) {
714		logprintf("(null)\n");
715		return;
716	}
717	for(i=0; i < l; i+=16) {
718		logprintf("%04x", (unsigned)(i + offset));
719		sep = ' ';
720		for (j = 0; j < 16 && i + j < l; j++) {
721			if (ref != NULL && p[i + j] != ref[i + j])
722				sep = '_';
723			logprintf("%c%02x", sep, 0xff & (int)p[i+j]);
724			if (ref != NULL && p[i + j] == ref[i + j])
725				sep = ' ';
726		}
727		for (; j < 16; j++) {
728			logprintf("%c  ", sep);
729			sep = ' ';
730		}
731		logprintf("%c", sep);
732		for (j=0; j < 16 && i + j < l; j++) {
733			int c = p[i + j];
734			if (c >= ' ' && c <= 126)
735				logprintf("%c", c);
736			else
737				logprintf(".");
738		}
739		logprintf("\n");
740	}
741}
742
743/* Verify that two blocks of memory are the same, display the first
744 * block of differences if they're not. */
745int
746assertion_equal_mem(const char *file, int line,
747    const void *_v1, const char *e1,
748    const void *_v2, const char *e2,
749    size_t l, const char *ld, void *extra)
750{
751	const char *v1 = (const char *)_v1;
752	const char *v2 = (const char *)_v2;
753	size_t offset;
754
755	assertion_count(file, line);
756	if (v1 == v2 || (v1 != NULL && v2 != NULL && memcmp(v1, v2, l) == 0))
757		return (1);
758	if (v1 == NULL || v2 == NULL)
759		return (0);
760
761	failure_start(file, line, "%s != %s", e1, e2);
762	logprintf("      size %s = %d\n", ld, (int)l);
763	/* Dump 48 bytes (3 lines) so that the first difference is
764	 * in the second line. */
765	offset = 0;
766	while (l > 64 && memcmp(v1, v2, 32) == 0) {
767		/* Two lines agree, so step forward one line. */
768		v1 += 16;
769		v2 += 16;
770		l -= 16;
771		offset += 16;
772	}
773	logprintf("      Dump of %s\n", e1);
774	hexdump(v1, v2, l < 128 ? l : 128, offset);
775	logprintf("      Dump of %s\n", e2);
776	hexdump(v2, v1, l < 128 ? l : 128, offset);
777	logprintf("\n");
778	failure_finish(extra);
779	return (0);
780}
781
782/* Verify that a block of memory is filled with the specified byte. */
783int
784assertion_memory_filled_with(const char *file, int line,
785    const void *_v1, const char *vd,
786    size_t l, const char *ld,
787    char b, const char *bd, void *extra)
788{
789	const char *v1 = (const char *)_v1;
790	size_t c = 0;
791	size_t i;
792	(void)ld; /* UNUSED */
793
794	assertion_count(file, line);
795
796	for (i = 0; i < l; ++i) {
797		if (v1[i] == b) {
798			++c;
799		}
800	}
801	if (c == l)
802		return (1);
803
804	failure_start(file, line, "%s (size %d) not filled with %s", vd, (int)l, bd);
805	logprintf("   Only %d bytes were correct\n", (int)c);
806	failure_finish(extra);
807	return (0);
808}
809
810/* Verify that the named file exists and is empty. */
811int
812assertion_empty_file(const char *filename, int line, const char *f1)
813{
814	char buff[1024];
815	struct stat st;
816	ssize_t s;
817	FILE *f;
818
819	assertion_count(filename, line);
820
821	if (stat(f1, &st) != 0) {
822		failure_start(filename, line, "Stat failed: %s", f1);
823		failure_finish(NULL);
824		return (0);
825	}
826	if (st.st_size == 0)
827		return (1);
828
829	failure_start(filename, line, "File should be empty: %s", f1);
830	logprintf("    File size: %d\n", (int)st.st_size);
831	logprintf("    Contents:\n");
832	f = fopen(f1, "rb");
833	if (f == NULL) {
834		logprintf("    Unable to open %s\n", f1);
835	} else {
836		s = ((off_t)sizeof(buff) < st.st_size) ?
837		    (ssize_t)sizeof(buff) : (ssize_t)st.st_size;
838		s = fread(buff, 1, s, f);
839		hexdump(buff, NULL, s, 0);
840		fclose(f);
841	}
842	failure_finish(NULL);
843	return (0);
844}
845
846/* Verify that the named file exists and is not empty. */
847int
848assertion_non_empty_file(const char *filename, int line, const char *f1)
849{
850	struct stat st;
851
852	assertion_count(filename, line);
853
854	if (stat(f1, &st) != 0) {
855		failure_start(filename, line, "Stat failed: %s", f1);
856		failure_finish(NULL);
857		return (0);
858	}
859	if (st.st_size == 0) {
860		failure_start(filename, line, "File empty: %s", f1);
861		failure_finish(NULL);
862		return (0);
863	}
864	return (1);
865}
866
867/* Verify that two files have the same contents. */
868/* TODO: hexdump the first bytes that actually differ. */
869int
870assertion_equal_file(const char *filename, int line, const char *fn1, const char *fn2)
871{
872	char buff1[1024];
873	char buff2[1024];
874	FILE *f1, *f2;
875	int n1, n2;
876
877	assertion_count(filename, line);
878
879	f1 = fopen(fn1, "rb");
880	f2 = fopen(fn2, "rb");
881	if (f1 == NULL || f2 == NULL) {
882		if (f1) fclose(f1);
883		if (f2) fclose(f2);
884		return (0);
885	}
886	for (;;) {
887		n1 = (int)fread(buff1, 1, sizeof(buff1), f1);
888		n2 = (int)fread(buff2, 1, sizeof(buff2), f2);
889		if (n1 != n2)
890			break;
891		if (n1 == 0 && n2 == 0) {
892			fclose(f1);
893			fclose(f2);
894			return (1);
895		}
896		if (memcmp(buff1, buff2, n1) != 0)
897			break;
898	}
899	fclose(f1);
900	fclose(f2);
901	failure_start(filename, line, "Files not identical");
902	logprintf("  file1=\"%s\"\n", fn1);
903	logprintf("  file2=\"%s\"\n", fn2);
904	failure_finish(NULL);
905	return (0);
906}
907
908/* Verify that the named file does exist. */
909int
910assertion_file_exists(const char *filename, int line, const char *f)
911{
912	assertion_count(filename, line);
913
914#if defined(_WIN32) && !defined(__CYGWIN__)
915	if (!_access(f, 0))
916		return (1);
917#else
918	if (!access(f, F_OK))
919		return (1);
920#endif
921	failure_start(filename, line, "File should exist: %s", f);
922	failure_finish(NULL);
923	return (0);
924}
925
926/* Verify that the named file doesn't exist. */
927int
928assertion_file_not_exists(const char *filename, int line, const char *f)
929{
930	assertion_count(filename, line);
931
932#if defined(_WIN32) && !defined(__CYGWIN__)
933	if (_access(f, 0))
934		return (1);
935#else
936	if (access(f, F_OK))
937		return (1);
938#endif
939	failure_start(filename, line, "File should not exist: %s", f);
940	failure_finish(NULL);
941	return (0);
942}
943
944/* Compare the contents of a file to a block of memory. */
945int
946assertion_file_contents(const char *filename, int line, const void *buff, int s, const char *fn)
947{
948	char *contents;
949	FILE *f;
950	int n;
951
952	assertion_count(filename, line);
953
954	f = fopen(fn, "rb");
955	if (f == NULL) {
956		failure_start(filename, line,
957		    "File should exist: %s", fn);
958		failure_finish(NULL);
959		return (0);
960	}
961	contents = malloc(s * 2);
962	n = (int)fread(contents, 1, s * 2, f);
963	fclose(f);
964	if (n == s && memcmp(buff, contents, s) == 0) {
965		free(contents);
966		return (1);
967	}
968	failure_start(filename, line, "File contents don't match");
969	logprintf("  file=\"%s\"\n", fn);
970	if (n > 0)
971		hexdump(contents, buff, n > 512 ? 512 : n, 0);
972	else {
973		logprintf("  File empty, contents should be:\n");
974		hexdump(buff, NULL, s > 512 ? 512 : s, 0);
975	}
976	failure_finish(NULL);
977	free(contents);
978	return (0);
979}
980
981/* Check the contents of a text file, being tolerant of line endings. */
982int
983assertion_text_file_contents(const char *filename, int line, const char *buff, const char *fn)
984{
985	char *contents;
986	const char *btxt, *ftxt;
987	FILE *f;
988	int n, s;
989
990	assertion_count(filename, line);
991	f = fopen(fn, "r");
992	if (f == NULL) {
993		failure_start(filename, line,
994		    "File doesn't exist: %s", fn);
995		failure_finish(NULL);
996		return (0);
997	}
998	s = (int)strlen(buff);
999	contents = malloc(s * 2 + 128);
1000	n = (int)fread(contents, 1, s * 2 + 128 - 1, f);
1001	if (n >= 0)
1002		contents[n] = '\0';
1003	fclose(f);
1004	/* Compare texts. */
1005	btxt = buff;
1006	ftxt = (const char *)contents;
1007	while (*btxt != '\0' && *ftxt != '\0') {
1008		if (*btxt == *ftxt) {
1009			++btxt;
1010			++ftxt;
1011			continue;
1012		}
1013		if (btxt[0] == '\n' && ftxt[0] == '\r' && ftxt[1] == '\n') {
1014			/* Pass over different new line characters. */
1015			++btxt;
1016			ftxt += 2;
1017			continue;
1018		}
1019		break;
1020	}
1021	if (*btxt == '\0' && *ftxt == '\0') {
1022		free(contents);
1023		return (1);
1024	}
1025	failure_start(filename, line, "Contents don't match");
1026	logprintf("  file=\"%s\"\n", fn);
1027	if (n > 0) {
1028		hexdump(contents, buff, n, 0);
1029		logprintf("  expected\n", fn);
1030		hexdump(buff, contents, s, 0);
1031	} else {
1032		logprintf("  File empty, contents should be:\n");
1033		hexdump(buff, NULL, s, 0);
1034	}
1035	failure_finish(NULL);
1036	free(contents);
1037	return (0);
1038}
1039
1040/* Verify that a text file contains the specified lines, regardless of order */
1041/* This could be more efficient if we sorted both sets of lines, etc, but
1042 * since this is used only for testing and only ever deals with a dozen or so
1043 * lines at a time, this relatively crude approach is just fine. */
1044int
1045assertion_file_contains_lines_any_order(const char *file, int line,
1046    const char *pathname, const char *lines[])
1047{
1048	char *buff;
1049	size_t buff_size;
1050	size_t expected_count, actual_count, i, j;
1051	char **expected = NULL;
1052	char *p, **actual = NULL;
1053	char c;
1054	int expected_failure = 0, actual_failure = 0;
1055
1056	assertion_count(file, line);
1057
1058	buff = slurpfile(&buff_size, "%s", pathname);
1059	if (buff == NULL) {
1060		failure_start(pathname, line, "Can't read file: %s", pathname);
1061		failure_finish(NULL);
1062		return (0);
1063	}
1064
1065	/* Make a copy of the provided lines and count up the expected
1066	 * file size. */
1067	for (i = 0; lines[i] != NULL; ++i) {
1068	}
1069	expected_count = i;
1070	if (expected_count) {
1071		expected = malloc(sizeof(char *) * expected_count);
1072		if (expected == NULL) {
1073			failure_start(pathname, line, "Can't allocate memory");
1074			failure_finish(NULL);
1075			free(expected);
1076			return (0);
1077		}
1078		for (i = 0; lines[i] != NULL; ++i) {
1079			expected[i] = strdup(lines[i]);
1080		}
1081	}
1082
1083	/* Break the file into lines */
1084	actual_count = 0;
1085	for (c = '\0', p = buff; p < buff + buff_size; ++p) {
1086		if (*p == '\x0d' || *p == '\x0a')
1087			*p = '\0';
1088		if (c == '\0' && *p != '\0')
1089			++actual_count;
1090		c = *p;
1091	}
1092	if (actual_count) {
1093		actual = calloc(sizeof(char *), actual_count);
1094		if (actual == NULL) {
1095			failure_start(pathname, line, "Can't allocate memory");
1096			failure_finish(NULL);
1097			free(expected);
1098			return (0);
1099		}
1100		for (j = 0, p = buff; p < buff + buff_size;
1101		    p += 1 + strlen(p)) {
1102			if (*p != '\0') {
1103				actual[j] = p;
1104				++j;
1105			}
1106		}
1107	}
1108
1109	/* Erase matching lines from both lists */
1110	for (i = 0; i < expected_count; ++i) {
1111		if (expected[i] == NULL)
1112			continue;
1113		for (j = 0; j < actual_count; ++j) {
1114			if (actual[j] == NULL)
1115				continue;
1116			if (strcmp(expected[i], actual[j]) == 0) {
1117				free(expected[i]);
1118				expected[i] = NULL;
1119				actual[j] = NULL;
1120				break;
1121			}
1122		}
1123	}
1124
1125	/* If there's anything left, it's a failure */
1126	for (i = 0; i < expected_count; ++i) {
1127		if (expected[i] != NULL)
1128			++expected_failure;
1129	}
1130	for (j = 0; j < actual_count; ++j) {
1131		if (actual[j] != NULL)
1132			++actual_failure;
1133	}
1134	if (expected_failure == 0 && actual_failure == 0) {
1135		free(buff);
1136		free(expected);
1137		free(actual);
1138		return (1);
1139	}
1140	failure_start(file, line, "File doesn't match: %s", pathname);
1141	for (i = 0; i < expected_count; ++i) {
1142		if (expected[i] != NULL) {
1143			logprintf("  Expected but not present: %s\n", expected[i]);
1144			free(expected[i]);
1145		}
1146	}
1147	for (j = 0; j < actual_count; ++j) {
1148		if (actual[j] != NULL)
1149			logprintf("  Present but not expected: %s\n", actual[j]);
1150	}
1151	failure_finish(NULL);
1152	free(buff);
1153	free(expected);
1154	free(actual);
1155	return (0);
1156}
1157
1158/* Test that two paths point to the same file. */
1159/* As a side-effect, asserts that both files exist. */
1160static int
1161is_hardlink(const char *file, int line,
1162    const char *path1, const char *path2)
1163{
1164#if defined(_WIN32) && !defined(__CYGWIN__)
1165	BY_HANDLE_FILE_INFORMATION bhfi1, bhfi2;
1166	int r;
1167
1168	assertion_count(file, line);
1169	r = my_GetFileInformationByName(path1, &bhfi1);
1170	if (r == 0) {
1171		failure_start(file, line, "File %s can't be inspected?", path1);
1172		failure_finish(NULL);
1173		return (0);
1174	}
1175	r = my_GetFileInformationByName(path2, &bhfi2);
1176	if (r == 0) {
1177		failure_start(file, line, "File %s can't be inspected?", path2);
1178		failure_finish(NULL);
1179		return (0);
1180	}
1181	return (bhfi1.dwVolumeSerialNumber == bhfi2.dwVolumeSerialNumber
1182		&& bhfi1.nFileIndexHigh == bhfi2.nFileIndexHigh
1183		&& bhfi1.nFileIndexLow == bhfi2.nFileIndexLow);
1184#else
1185	struct stat st1, st2;
1186	int r;
1187
1188	assertion_count(file, line);
1189	r = lstat(path1, &st1);
1190	if (r != 0) {
1191		failure_start(file, line, "File should exist: %s", path1);
1192		failure_finish(NULL);
1193		return (0);
1194	}
1195	r = lstat(path2, &st2);
1196	if (r != 0) {
1197		failure_start(file, line, "File should exist: %s", path2);
1198		failure_finish(NULL);
1199		return (0);
1200	}
1201	return (st1.st_ino == st2.st_ino && st1.st_dev == st2.st_dev);
1202#endif
1203}
1204
1205int
1206assertion_is_hardlink(const char *file, int line,
1207    const char *path1, const char *path2)
1208{
1209	if (is_hardlink(file, line, path1, path2))
1210		return (1);
1211	failure_start(file, line,
1212	    "Files %s and %s are not hardlinked", path1, path2);
1213	failure_finish(NULL);
1214	return (0);
1215}
1216
1217int
1218assertion_is_not_hardlink(const char *file, int line,
1219    const char *path1, const char *path2)
1220{
1221	if (!is_hardlink(file, line, path1, path2))
1222		return (1);
1223	failure_start(file, line,
1224	    "Files %s and %s should not be hardlinked", path1, path2);
1225	failure_finish(NULL);
1226	return (0);
1227}
1228
1229/* Verify a/b/mtime of 'pathname'. */
1230/* If 'recent', verify that it's within last 10 seconds. */
1231static int
1232assertion_file_time(const char *file, int line,
1233    const char *pathname, long t, long nsec, char type, int recent)
1234{
1235	long long filet, filet_nsec;
1236	int r;
1237
1238#if defined(_WIN32) && !defined(__CYGWIN__)
1239#define EPOC_TIME	(116444736000000000ULL)
1240	FILETIME fxtime, fbirthtime, fatime, fmtime;
1241	ULARGE_INTEGER wintm;
1242	HANDLE h;
1243	fxtime.dwLowDateTime = 0;
1244	fxtime.dwHighDateTime = 0;
1245
1246	assertion_count(file, line);
1247	/* Note: FILE_FLAG_BACKUP_SEMANTICS applies to open
1248	 * a directory file. If not, CreateFile() will fail when
1249	 * the pathname is a directory. */
1250	h = CreateFile(pathname, FILE_READ_ATTRIBUTES, 0, NULL,
1251	    OPEN_EXISTING, FILE_FLAG_BACKUP_SEMANTICS, NULL);
1252	if (h == INVALID_HANDLE_VALUE) {
1253		failure_start(file, line, "Can't access %s\n", pathname);
1254		failure_finish(NULL);
1255		return (0);
1256	}
1257	r = GetFileTime(h, &fbirthtime, &fatime, &fmtime);
1258	switch (type) {
1259	case 'a': fxtime = fatime; break;
1260	case 'b': fxtime = fbirthtime; break;
1261	case 'm': fxtime = fmtime; break;
1262	}
1263	CloseHandle(h);
1264	if (r == 0) {
1265		failure_start(file, line, "Can't GetFileTime %s\n", pathname);
1266		failure_finish(NULL);
1267		return (0);
1268	}
1269	wintm.LowPart = fxtime.dwLowDateTime;
1270	wintm.HighPart = fxtime.dwHighDateTime;
1271	filet = (wintm.QuadPart - EPOC_TIME) / 10000000;
1272	filet_nsec = ((wintm.QuadPart - EPOC_TIME) % 10000000) * 100;
1273	nsec = (nsec / 100) * 100; /* Round the request */
1274#else
1275	struct stat st;
1276
1277	assertion_count(file, line);
1278	r = lstat(pathname, &st);
1279	if (r != 0) {
1280		failure_start(file, line, "Can't stat %s\n", pathname);
1281		failure_finish(NULL);
1282		return (0);
1283	}
1284	switch (type) {
1285	case 'a': filet = st.st_atime; break;
1286	case 'm': filet = st.st_mtime; break;
1287	case 'b': filet = 0; break;
1288	default: fprintf(stderr, "INTERNAL: Bad type %c for file time", type);
1289		exit(1);
1290	}
1291#if defined(__FreeBSD__)
1292	switch (type) {
1293	case 'a': filet_nsec = st.st_atimespec.tv_nsec; break;
1294	case 'b': filet = st.st_birthtime;
1295		filet_nsec = st.st_birthtimespec.tv_nsec; break;
1296	case 'm': filet_nsec = st.st_mtimespec.tv_nsec; break;
1297	default: fprintf(stderr, "INTERNAL: Bad type %c for file time", type);
1298		exit(1);
1299	}
1300	/* FreeBSD generally only stores to microsecond res, so round. */
1301	filet_nsec = (filet_nsec / 1000) * 1000;
1302	nsec = (nsec / 1000) * 1000;
1303#else
1304	filet_nsec = nsec = 0;	/* Generic POSIX only has whole seconds. */
1305	if (type == 'b') return (1); /* Generic POSIX doesn't have birthtime */
1306#if defined(__HAIKU__)
1307	if (type == 'a') return (1); /* Haiku doesn't have atime. */
1308#endif
1309#endif
1310#endif
1311	if (recent) {
1312		/* Check that requested time is up-to-date. */
1313		time_t now = time(NULL);
1314		if (filet < now - 10 || filet > now + 1) {
1315			failure_start(file, line,
1316			    "File %s has %ctime %lld, %lld seconds ago\n",
1317			    pathname, type, filet, now - filet);
1318			failure_finish(NULL);
1319			return (0);
1320		}
1321	} else if (filet != t || filet_nsec != nsec) {
1322		failure_start(file, line,
1323		    "File %s has %ctime %lld.%09lld, expected %lld.%09lld",
1324		    pathname, type, filet, filet_nsec, t, nsec);
1325		failure_finish(NULL);
1326		return (0);
1327	}
1328	return (1);
1329}
1330
1331/* Verify atime of 'pathname'. */
1332int
1333assertion_file_atime(const char *file, int line,
1334    const char *pathname, long t, long nsec)
1335{
1336	return assertion_file_time(file, line, pathname, t, nsec, 'a', 0);
1337}
1338
1339/* Verify atime of 'pathname' is up-to-date. */
1340int
1341assertion_file_atime_recent(const char *file, int line, const char *pathname)
1342{
1343	return assertion_file_time(file, line, pathname, 0, 0, 'a', 1);
1344}
1345
1346/* Verify birthtime of 'pathname'. */
1347int
1348assertion_file_birthtime(const char *file, int line,
1349    const char *pathname, long t, long nsec)
1350{
1351	return assertion_file_time(file, line, pathname, t, nsec, 'b', 0);
1352}
1353
1354/* Verify birthtime of 'pathname' is up-to-date. */
1355int
1356assertion_file_birthtime_recent(const char *file, int line,
1357    const char *pathname)
1358{
1359	return assertion_file_time(file, line, pathname, 0, 0, 'b', 1);
1360}
1361
1362/* Verify mtime of 'pathname'. */
1363int
1364assertion_file_mtime(const char *file, int line,
1365    const char *pathname, long t, long nsec)
1366{
1367	return assertion_file_time(file, line, pathname, t, nsec, 'm', 0);
1368}
1369
1370/* Verify mtime of 'pathname' is up-to-date. */
1371int
1372assertion_file_mtime_recent(const char *file, int line, const char *pathname)
1373{
1374	return assertion_file_time(file, line, pathname, 0, 0, 'm', 1);
1375}
1376
1377/* Verify number of links to 'pathname'. */
1378int
1379assertion_file_nlinks(const char *file, int line,
1380    const char *pathname, int nlinks)
1381{
1382#if defined(_WIN32) && !defined(__CYGWIN__)
1383	BY_HANDLE_FILE_INFORMATION bhfi;
1384	int r;
1385
1386	assertion_count(file, line);
1387	r = my_GetFileInformationByName(pathname, &bhfi);
1388	if (r != 0 && bhfi.nNumberOfLinks == (DWORD)nlinks)
1389		return (1);
1390	failure_start(file, line, "File %s has %d links, expected %d",
1391	    pathname, bhfi.nNumberOfLinks, nlinks);
1392	failure_finish(NULL);
1393	return (0);
1394#else
1395	struct stat st;
1396	int r;
1397
1398	assertion_count(file, line);
1399	r = lstat(pathname, &st);
1400	if (r == 0 && (int)st.st_nlink == nlinks)
1401			return (1);
1402	failure_start(file, line, "File %s has %d links, expected %d",
1403	    pathname, st.st_nlink, nlinks);
1404	failure_finish(NULL);
1405	return (0);
1406#endif
1407}
1408
1409/* Verify size of 'pathname'. */
1410int
1411assertion_file_size(const char *file, int line, const char *pathname, long size)
1412{
1413	int64_t filesize;
1414	int r;
1415
1416	assertion_count(file, line);
1417#if defined(_WIN32) && !defined(__CYGWIN__)
1418	{
1419		BY_HANDLE_FILE_INFORMATION bhfi;
1420		r = !my_GetFileInformationByName(pathname, &bhfi);
1421		filesize = ((int64_t)bhfi.nFileSizeHigh << 32) + bhfi.nFileSizeLow;
1422	}
1423#else
1424	{
1425		struct stat st;
1426		r = lstat(pathname, &st);
1427		filesize = st.st_size;
1428	}
1429#endif
1430	if (r == 0 && filesize == size)
1431			return (1);
1432	failure_start(file, line, "File %s has size %ld, expected %ld",
1433	    pathname, (long)filesize, (long)size);
1434	failure_finish(NULL);
1435	return (0);
1436}
1437
1438/* Assert that 'pathname' is a dir.  If mode >= 0, verify that too. */
1439int
1440assertion_is_dir(const char *file, int line, const char *pathname, int mode)
1441{
1442	struct stat st;
1443	int r;
1444
1445#if defined(_WIN32) && !defined(__CYGWIN__)
1446	(void)mode; /* UNUSED */
1447#endif
1448	assertion_count(file, line);
1449	r = lstat(pathname, &st);
1450	if (r != 0) {
1451		failure_start(file, line, "Dir should exist: %s", pathname);
1452		failure_finish(NULL);
1453		return (0);
1454	}
1455	if (!S_ISDIR(st.st_mode)) {
1456		failure_start(file, line, "%s is not a dir", pathname);
1457		failure_finish(NULL);
1458		return (0);
1459	}
1460#if !defined(_WIN32) || defined(__CYGWIN__)
1461	/* Windows doesn't handle permissions the same way as POSIX,
1462	 * so just ignore the mode tests. */
1463	/* TODO: Can we do better here? */
1464	if (mode >= 0 && (mode_t)mode != (st.st_mode & 07777)) {
1465		failure_start(file, line, "Dir %s has wrong mode", pathname);
1466		logprintf("  Expected: 0%3o\n", mode);
1467		logprintf("  Found: 0%3o\n", st.st_mode & 07777);
1468		failure_finish(NULL);
1469		return (0);
1470	}
1471#endif
1472	return (1);
1473}
1474
1475/* Verify that 'pathname' is a regular file.  If 'mode' is >= 0,
1476 * verify that too. */
1477int
1478assertion_is_reg(const char *file, int line, const char *pathname, int mode)
1479{
1480	struct stat st;
1481	int r;
1482
1483#if defined(_WIN32) && !defined(__CYGWIN__)
1484	(void)mode; /* UNUSED */
1485#endif
1486	assertion_count(file, line);
1487	r = lstat(pathname, &st);
1488	if (r != 0 || !S_ISREG(st.st_mode)) {
1489		failure_start(file, line, "File should exist: %s", pathname);
1490		failure_finish(NULL);
1491		return (0);
1492	}
1493#if !defined(_WIN32) || defined(__CYGWIN__)
1494	/* Windows doesn't handle permissions the same way as POSIX,
1495	 * so just ignore the mode tests. */
1496	/* TODO: Can we do better here? */
1497	if (mode >= 0 && (mode_t)mode != (st.st_mode & 07777)) {
1498		failure_start(file, line, "File %s has wrong mode", pathname);
1499		logprintf("  Expected: 0%3o\n", mode);
1500		logprintf("  Found: 0%3o\n", st.st_mode & 07777);
1501		failure_finish(NULL);
1502		return (0);
1503	}
1504#endif
1505	return (1);
1506}
1507
1508/* Check whether 'pathname' is a symbolic link.  If 'contents' is
1509 * non-NULL, verify that the symlink has those contents. */
1510static int
1511is_symlink(const char *file, int line,
1512    const char *pathname, const char *contents)
1513{
1514#if defined(_WIN32) && !defined(__CYGWIN__)
1515	(void)pathname; /* UNUSED */
1516	(void)contents; /* UNUSED */
1517	assertion_count(file, line);
1518	/* Windows sort-of has real symlinks, but they're only usable
1519	 * by privileged users and are crippled even then, so there's
1520	 * really not much point in bothering with this. */
1521	return (0);
1522#else
1523	char buff[300];
1524	struct stat st;
1525	ssize_t linklen;
1526	int r;
1527
1528	assertion_count(file, line);
1529	r = lstat(pathname, &st);
1530	if (r != 0) {
1531		failure_start(file, line,
1532		    "Symlink should exist: %s", pathname);
1533		failure_finish(NULL);
1534		return (0);
1535	}
1536	if (!S_ISLNK(st.st_mode))
1537		return (0);
1538	if (contents == NULL)
1539		return (1);
1540	linklen = readlink(pathname, buff, sizeof(buff));
1541	if (linklen < 0) {
1542		failure_start(file, line, "Can't read symlink %s", pathname);
1543		failure_finish(NULL);
1544		return (0);
1545	}
1546	buff[linklen] = '\0';
1547	if (strcmp(buff, contents) != 0)
1548		return (0);
1549	return (1);
1550#endif
1551}
1552
1553/* Assert that path is a symlink that (optionally) contains contents. */
1554int
1555assertion_is_symlink(const char *file, int line,
1556    const char *path, const char *contents)
1557{
1558	if (is_symlink(file, line, path, contents))
1559		return (1);
1560	if (contents)
1561		failure_start(file, line, "File %s is not a symlink to %s",
1562		    path, contents);
1563	else
1564		failure_start(file, line, "File %s is not a symlink", path);
1565	failure_finish(NULL);
1566	return (0);
1567}
1568
1569
1570/* Create a directory and report any errors. */
1571int
1572assertion_make_dir(const char *file, int line, const char *dirname, int mode)
1573{
1574	assertion_count(file, line);
1575#if defined(_WIN32) && !defined(__CYGWIN__)
1576	(void)mode; /* UNUSED */
1577	if (0 == _mkdir(dirname))
1578		return (1);
1579#else
1580	if (0 == mkdir(dirname, mode))
1581		return (1);
1582#endif
1583	failure_start(file, line, "Could not create directory %s", dirname);
1584	failure_finish(NULL);
1585	return(0);
1586}
1587
1588/* Create a file with the specified contents and report any failures. */
1589int
1590assertion_make_file(const char *file, int line,
1591    const char *path, int mode, int csize, const void *contents)
1592{
1593#if defined(_WIN32) && !defined(__CYGWIN__)
1594	/* TODO: Rework this to set file mode as well. */
1595	FILE *f;
1596	(void)mode; /* UNUSED */
1597	assertion_count(file, line);
1598	f = fopen(path, "wb");
1599	if (f == NULL) {
1600		failure_start(file, line, "Could not create file %s", path);
1601		failure_finish(NULL);
1602		return (0);
1603	}
1604	if (contents != NULL) {
1605		size_t wsize;
1606
1607		if (csize < 0)
1608			wsize = strlen(contents);
1609		else
1610			wsize = (size_t)csize;
1611		if (wsize != fwrite(contents, 1, wsize, f)) {
1612			fclose(f);
1613			failure_start(file, line,
1614			    "Could not write file %s", path);
1615			failure_finish(NULL);
1616			return (0);
1617		}
1618	}
1619	fclose(f);
1620	return (1);
1621#else
1622	int fd;
1623	assertion_count(file, line);
1624	fd = open(path, O_CREAT | O_WRONLY, mode >= 0 ? mode : 0644);
1625	if (fd < 0) {
1626		failure_start(file, line, "Could not create %s", path);
1627		failure_finish(NULL);
1628		return (0);
1629	}
1630	if (contents != NULL) {
1631		ssize_t wsize;
1632
1633		if (csize < 0)
1634			wsize = (ssize_t)strlen(contents);
1635		else
1636			wsize = (ssize_t)csize;
1637		if (wsize != write(fd, contents, wsize)) {
1638			close(fd);
1639			failure_start(file, line,
1640			    "Could not write to %s", path);
1641			failure_finish(NULL);
1642			return (0);
1643		}
1644	}
1645	close(fd);
1646	return (1);
1647#endif
1648}
1649
1650/* Create a hardlink and report any failures. */
1651int
1652assertion_make_hardlink(const char *file, int line,
1653    const char *newpath, const char *linkto)
1654{
1655	int succeeded;
1656
1657	assertion_count(file, line);
1658#if defined(_WIN32) && !defined(__CYGWIN__)
1659	succeeded = my_CreateHardLinkA(newpath, linkto);
1660#elif HAVE_LINK
1661	succeeded = !link(linkto, newpath);
1662#else
1663	succeeded = 0;
1664#endif
1665	if (succeeded)
1666		return (1);
1667	failure_start(file, line, "Could not create hardlink");
1668	logprintf("   New link: %s\n", newpath);
1669	logprintf("   Old name: %s\n", linkto);
1670	failure_finish(NULL);
1671	return(0);
1672}
1673
1674/* Create a symlink and report any failures. */
1675int
1676assertion_make_symlink(const char *file, int line,
1677    const char *newpath, const char *linkto)
1678{
1679#if defined(_WIN32) && !defined(__CYGWIN__)
1680	int targetIsDir = 0;  /* TODO: Fix this */
1681	assertion_count(file, line);
1682	if (my_CreateSymbolicLinkA(newpath, linkto, targetIsDir))
1683		return (1);
1684#elif HAVE_SYMLINK
1685	assertion_count(file, line);
1686	if (0 == symlink(linkto, newpath))
1687		return (1);
1688#endif
1689	failure_start(file, line, "Could not create symlink");
1690	logprintf("   New link: %s\n", newpath);
1691	logprintf("   Old name: %s\n", linkto);
1692	failure_finish(NULL);
1693	return(0);
1694}
1695
1696/* Set umask, report failures. */
1697int
1698assertion_umask(const char *file, int line, int mask)
1699{
1700	assertion_count(file, line);
1701	(void)file; /* UNUSED */
1702	(void)line; /* UNUSED */
1703	umask(mask);
1704	return (1);
1705}
1706
1707/* Set times, report failures. */
1708int
1709assertion_utimes(const char *file, int line,
1710    const char *pathname, long at, long at_nsec, long mt, long mt_nsec)
1711{
1712	int r;
1713
1714#if defined(_WIN32) && !defined(__CYGWIN__)
1715#define WINTIME(sec, nsec) ((Int32x32To64(sec, 10000000) + EPOC_TIME)\
1716	 + (((nsec)/1000)*10))
1717	HANDLE h;
1718	ULARGE_INTEGER wintm;
1719	FILETIME fatime, fmtime;
1720	FILETIME *pat, *pmt;
1721
1722	assertion_count(file, line);
1723	h = CreateFileA(pathname,GENERIC_READ | GENERIC_WRITE,
1724		    FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING,
1725		    FILE_FLAG_BACKUP_SEMANTICS, NULL);
1726	if (h == INVALID_HANDLE_VALUE) {
1727		failure_start(file, line, "Can't access %s\n", pathname);
1728		failure_finish(NULL);
1729		return (0);
1730	}
1731
1732	if (at > 0 || at_nsec > 0) {
1733		wintm.QuadPart = WINTIME(at, at_nsec);
1734		fatime.dwLowDateTime = wintm.LowPart;
1735		fatime.dwHighDateTime = wintm.HighPart;
1736		pat = &fatime;
1737	} else
1738		pat = NULL;
1739	if (mt > 0 || mt_nsec > 0) {
1740		wintm.QuadPart = WINTIME(mt, mt_nsec);
1741		fmtime.dwLowDateTime = wintm.LowPart;
1742		fmtime.dwHighDateTime = wintm.HighPart;
1743		pmt = &fmtime;
1744	} else
1745		pmt = NULL;
1746	if (pat != NULL || pmt != NULL)
1747		r = SetFileTime(h, NULL, pat, pmt);
1748	else
1749		r = 1;
1750	CloseHandle(h);
1751	if (r == 0) {
1752		failure_start(file, line, "Can't SetFileTime %s\n", pathname);
1753		failure_finish(NULL);
1754		return (0);
1755	}
1756	return (1);
1757#else /* defined(_WIN32) && !defined(__CYGWIN__) */
1758	struct stat st;
1759	struct timeval times[2];
1760
1761#if !defined(__FreeBSD__)
1762	mt_nsec = at_nsec = 0;	/* Generic POSIX only has whole seconds. */
1763#endif
1764	if (mt == 0 && mt_nsec == 0 && at == 0 && at_nsec == 0)
1765		return (1);
1766
1767	r = lstat(pathname, &st);
1768	if (r < 0) {
1769		failure_start(file, line, "Can't stat %s\n", pathname);
1770		failure_finish(NULL);
1771		return (0);
1772	}
1773
1774	if (mt == 0 && mt_nsec == 0) {
1775		mt = st.st_mtime;
1776#if defined(__FreeBSD__)
1777		mt_nsec = st.st_mtimespec.tv_nsec;
1778		/* FreeBSD generally only stores to microsecond res, so round. */
1779		mt_nsec = (mt_nsec / 1000) * 1000;
1780#endif
1781	}
1782	if (at == 0 && at_nsec == 0) {
1783		at = st.st_atime;
1784#if defined(__FreeBSD__)
1785		at_nsec = st.st_atimespec.tv_nsec;
1786		/* FreeBSD generally only stores to microsecond res, so round. */
1787		at_nsec = (at_nsec / 1000) * 1000;
1788#endif
1789	}
1790
1791	times[1].tv_sec = mt;
1792	times[1].tv_usec = mt_nsec / 1000;
1793
1794	times[0].tv_sec = at;
1795	times[0].tv_usec = at_nsec / 1000;
1796
1797#ifdef HAVE_LUTIMES
1798	r = lutimes(pathname, times);
1799#else
1800	r = utimes(pathname, times);
1801#endif
1802	if (r < 0) {
1803		failure_start(file, line, "Can't utimes %s\n", pathname);
1804		failure_finish(NULL);
1805		return (0);
1806	}
1807	return (1);
1808#endif /* defined(_WIN32) && !defined(__CYGWIN__) */
1809}
1810
1811/* Set nodump, report failures. */
1812int
1813assertion_nodump(const char *file, int line, const char *pathname)
1814{
1815#if defined(HAVE_STRUCT_STAT_ST_FLAGS) && defined(UF_NODUMP)
1816	int r;
1817
1818	assertion_count(file, line);
1819	r = chflags(pathname, UF_NODUMP);
1820	if (r < 0) {
1821		failure_start(file, line, "Can't set nodump %s\n", pathname);
1822		failure_finish(NULL);
1823		return (0);
1824	}
1825#elif defined(EXT2_IOC_GETFLAGS) && defined(HAVE_WORKING_EXT2_IOC_GETFLAGS)\
1826	 && defined(EXT2_NODUMP_FL)
1827	int fd, r, flags;
1828
1829	assertion_count(file, line);
1830	fd = open(pathname, O_RDONLY | O_NONBLOCK);
1831	if (fd < 0) {
1832		failure_start(file, line, "Can't open %s\n", pathname);
1833		failure_finish(NULL);
1834		return (0);
1835	}
1836	r = ioctl(fd, EXT2_IOC_GETFLAGS, &flags);
1837	if (r < 0) {
1838		failure_start(file, line, "Can't get flags %s\n", pathname);
1839		failure_finish(NULL);
1840		return (0);
1841	}
1842	flags |= EXT2_NODUMP_FL;
1843	r = ioctl(fd, EXT2_IOC_SETFLAGS, &flags);
1844	if (r < 0) {
1845		failure_start(file, line, "Can't set nodump %s\n", pathname);
1846		failure_finish(NULL);
1847		return (0);
1848	}
1849	close(fd);
1850#else
1851	(void)pathname; /* UNUSED */
1852	assertion_count(file, line);
1853#endif
1854	return (1);
1855}
1856
1857/*
1858 *
1859 *  UTILITIES for use by tests.
1860 *
1861 */
1862
1863/*
1864 * Check whether platform supports symlinks.  This is intended
1865 * for tests to use in deciding whether to bother testing symlink
1866 * support; if the platform doesn't support symlinks, there's no point
1867 * in checking whether the program being tested can create them.
1868 *
1869 * Note that the first time this test is called, we actually go out to
1870 * disk to create and verify a symlink.  This is necessary because
1871 * symlink support is actually a property of a particular filesystem
1872 * and can thus vary between directories on a single system.  After
1873 * the first call, this returns the cached result from memory, so it's
1874 * safe to call it as often as you wish.
1875 */
1876int
1877canSymlink(void)
1878{
1879	/* Remember the test result */
1880	static int value = 0, tested = 0;
1881	if (tested)
1882		return (value);
1883
1884	++tested;
1885	assertion_make_file(__FILE__, __LINE__, "canSymlink.0", 0644, 1, "a");
1886	/* Note: Cygwin has its own symlink() emulation that does not
1887	 * use the Win32 CreateSymbolicLink() function. */
1888#if defined(_WIN32) && !defined(__CYGWIN__)
1889	value = my_CreateSymbolicLinkA("canSymlink.1", "canSymlink.0", 0)
1890	    && is_symlink(__FILE__, __LINE__, "canSymlink.1", "canSymlink.0");
1891#elif HAVE_SYMLINK
1892	value = (0 == symlink("canSymlink.0", "canSymlink.1"))
1893	    && is_symlink(__FILE__, __LINE__, "canSymlink.1","canSymlink.0");
1894#endif
1895	return (value);
1896}
1897
1898/* Platform-dependent options for hiding the output of a subcommand. */
1899#if defined(_WIN32) && !defined(__CYGWIN__)
1900static const char *redirectArgs = ">NUL 2>NUL"; /* Win32 cmd.exe */
1901#else
1902static const char *redirectArgs = ">/dev/null 2>/dev/null"; /* POSIX 'sh' */
1903#endif
1904/*
1905 * Can this platform run the bzip2 program?
1906 */
1907int
1908canBzip2(void)
1909{
1910	static int tested = 0, value = 0;
1911	if (!tested) {
1912		tested = 1;
1913		if (systemf("bzip2 -d -V %s", redirectArgs) == 0)
1914			value = 1;
1915	}
1916	return (value);
1917}
1918
1919/*
1920 * Can this platform run the grzip program?
1921 */
1922int
1923canGrzip(void)
1924{
1925	static int tested = 0, value = 0;
1926	if (!tested) {
1927		tested = 1;
1928		if (systemf("grzip -V %s", redirectArgs) == 0)
1929			value = 1;
1930	}
1931	return (value);
1932}
1933
1934/*
1935 * Can this platform run the gzip program?
1936 */
1937int
1938canGzip(void)
1939{
1940	static int tested = 0, value = 0;
1941	if (!tested) {
1942		tested = 1;
1943		if (systemf("gzip -V %s", redirectArgs) == 0)
1944			value = 1;
1945	}
1946	return (value);
1947}
1948
1949/*
1950 * Can this platform run the lrzip program?
1951 */
1952int
1953canRunCommand(const char *cmd)
1954{
1955  static int tested = 0, value = 0;
1956  if (!tested) {
1957    tested = 1;
1958    if (systemf("%s %s", cmd, redirectArgs) == 0)
1959      value = 1;
1960  }
1961  return (value);
1962}
1963
1964int
1965canLrzip(void)
1966{
1967	static int tested = 0, value = 0;
1968	if (!tested) {
1969		tested = 1;
1970		if (systemf("lrzip -V %s", redirectArgs) == 0)
1971			value = 1;
1972	}
1973	return (value);
1974}
1975
1976/*
1977 * Can this platform run the lz4 program?
1978 */
1979int
1980canLz4(void)
1981{
1982	static int tested = 0, value = 0;
1983	if (!tested) {
1984		tested = 1;
1985		if (systemf("lz4 -V %s", redirectArgs) == 0)
1986			value = 1;
1987	}
1988	return (value);
1989}
1990
1991/*
1992 * Can this platform run the lzip program?
1993 */
1994int
1995canLzip(void)
1996{
1997	static int tested = 0, value = 0;
1998	if (!tested) {
1999		tested = 1;
2000		if (systemf("lzip -V %s", redirectArgs) == 0)
2001			value = 1;
2002	}
2003	return (value);
2004}
2005
2006/*
2007 * Can this platform run the lzma program?
2008 */
2009int
2010canLzma(void)
2011{
2012	static int tested = 0, value = 0;
2013	if (!tested) {
2014		tested = 1;
2015		if (systemf("lzma -V %s", redirectArgs) == 0)
2016			value = 1;
2017	}
2018	return (value);
2019}
2020
2021/*
2022 * Can this platform run the lzop program?
2023 */
2024int
2025canLzop(void)
2026{
2027	static int tested = 0, value = 0;
2028	if (!tested) {
2029		tested = 1;
2030		if (systemf("lzop -V %s", redirectArgs) == 0)
2031			value = 1;
2032	}
2033	return (value);
2034}
2035
2036/*
2037 * Can this platform run the xz program?
2038 */
2039int
2040canXz(void)
2041{
2042	static int tested = 0, value = 0;
2043	if (!tested) {
2044		tested = 1;
2045		if (systemf("xz -V %s", redirectArgs) == 0)
2046			value = 1;
2047	}
2048	return (value);
2049}
2050
2051/*
2052 * Can this filesystem handle nodump flags.
2053 */
2054#if defined(HAVE_STRUCT_STAT_ST_FLAGS) && defined(UF_NODUMP)
2055
2056int
2057canNodump(void)
2058{
2059	const char *path = "cannodumptest";
2060	struct stat sb;
2061
2062	assertion_make_file(__FILE__, __LINE__, path, 0644, 0, NULL);
2063	if (chflags(path, UF_NODUMP) < 0)
2064		return (0);
2065	if (stat(path, &sb) < 0)
2066		return (0);
2067	if (sb.st_flags & UF_NODUMP)
2068		return (1);
2069	return (0);
2070}
2071
2072#elif defined(EXT2_IOC_GETFLAGS) && defined(HAVE_WORKING_EXT2_IOC_GETFLAGS)\
2073	 && defined(EXT2_NODUMP_FL)
2074
2075int
2076canNodump(void)
2077{
2078	const char *path = "cannodumptest";
2079	int fd, r, flags;
2080
2081	assertion_make_file(__FILE__, __LINE__, path, 0644, 0, NULL);
2082	fd = open(path, O_RDONLY | O_NONBLOCK);
2083	if (fd < 0)
2084		return (0);
2085	r = ioctl(fd, EXT2_IOC_GETFLAGS, &flags);
2086	if (r < 0)
2087		return (0);
2088	flags |= EXT2_NODUMP_FL;
2089	r = ioctl(fd, EXT2_IOC_SETFLAGS, &flags);
2090	if (r < 0)
2091		return (0);
2092	close(fd);
2093	fd = open(path, O_RDONLY | O_NONBLOCK);
2094	if (fd < 0)
2095		return (0);
2096	r = ioctl(fd, EXT2_IOC_GETFLAGS, &flags);
2097	if (r < 0)
2098		return (0);
2099	close(fd);
2100	if (flags & EXT2_NODUMP_FL)
2101		return (1);
2102	return (0);
2103}
2104
2105#else
2106
2107int
2108canNodump()
2109{
2110	return (0);
2111}
2112
2113#endif
2114
2115/*
2116 * Sleep as needed; useful for verifying disk timestamp changes by
2117 * ensuring that the wall-clock time has actually changed before we
2118 * go back to re-read something from disk.
2119 */
2120void
2121sleepUntilAfter(time_t t)
2122{
2123	while (t >= time(NULL))
2124#if defined(_WIN32) && !defined(__CYGWIN__)
2125		Sleep(500);
2126#else
2127		sleep(1);
2128#endif
2129}
2130
2131/*
2132 * Call standard system() call, but build up the command line using
2133 * sprintf() conventions.
2134 */
2135int
2136systemf(const char *fmt, ...)
2137{
2138	char buff[8192];
2139	va_list ap;
2140	int r;
2141
2142	va_start(ap, fmt);
2143	vsprintf(buff, fmt, ap);
2144	if (verbosity > VERBOSITY_FULL)
2145		logprintf("Cmd: %s\n", buff);
2146	r = system(buff);
2147	va_end(ap);
2148	return (r);
2149}
2150
2151/*
2152 * Slurp a file into memory for ease of comparison and testing.
2153 * Returns size of file in 'sizep' if non-NULL, null-terminates
2154 * data in memory for ease of use.
2155 */
2156char *
2157slurpfile(size_t * sizep, const char *fmt, ...)
2158{
2159	char filename[8192];
2160	struct stat st;
2161	va_list ap;
2162	char *p;
2163	ssize_t bytes_read;
2164	FILE *f;
2165	int r;
2166
2167	va_start(ap, fmt);
2168	vsprintf(filename, fmt, ap);
2169	va_end(ap);
2170
2171	f = fopen(filename, "rb");
2172	if (f == NULL) {
2173		/* Note: No error; non-existent file is okay here. */
2174		return (NULL);
2175	}
2176	r = fstat(fileno(f), &st);
2177	if (r != 0) {
2178		logprintf("Can't stat file %s\n", filename);
2179		fclose(f);
2180		return (NULL);
2181	}
2182	p = malloc((size_t)st.st_size + 1);
2183	if (p == NULL) {
2184		logprintf("Can't allocate %ld bytes of memory to read file %s\n",
2185		    (long int)st.st_size, filename);
2186		fclose(f);
2187		return (NULL);
2188	}
2189	bytes_read = fread(p, 1, (size_t)st.st_size, f);
2190	if (bytes_read < st.st_size) {
2191		logprintf("Can't read file %s\n", filename);
2192		fclose(f);
2193		free(p);
2194		return (NULL);
2195	}
2196	p[st.st_size] = '\0';
2197	if (sizep != NULL)
2198		*sizep = (size_t)st.st_size;
2199	fclose(f);
2200	return (p);
2201}
2202
2203/*
2204 * Slurp a file into memory for ease of comparison and testing.
2205 * Returns size of file in 'sizep' if non-NULL, null-terminates
2206 * data in memory for ease of use.
2207 */
2208void
2209dumpfile(const char *filename, void *data, size_t len)
2210{
2211	ssize_t bytes_written;
2212	FILE *f;
2213
2214	f = fopen(filename, "wb");
2215	if (f == NULL) {
2216		logprintf("Can't open file %s for writing\n", filename);
2217		return;
2218	}
2219	bytes_written = fwrite(data, 1, len, f);
2220	if (bytes_written < (ssize_t)len)
2221		logprintf("Can't write file %s\n", filename);
2222	fclose(f);
2223}
2224
2225/* Read a uuencoded file from the reference directory, decode, and
2226 * write the result into the current directory. */
2227#define VALID_UUDECODE(c) (c >= 32 && c <= 96)
2228#define	UUDECODE(c) (((c) - 0x20) & 0x3f)
2229void
2230extract_reference_file(const char *name)
2231{
2232	char buff[1024];
2233	FILE *in, *out;
2234
2235	sprintf(buff, "%s/%s.uu", refdir, name);
2236	in = fopen(buff, "r");
2237	failure("Couldn't open reference file %s", buff);
2238	assert(in != NULL);
2239	if (in == NULL)
2240		return;
2241	/* Read up to and including the 'begin' line. */
2242	for (;;) {
2243		if (fgets(buff, sizeof(buff), in) == NULL) {
2244			/* TODO: This is a failure. */
2245			return;
2246		}
2247		if (memcmp(buff, "begin ", 6) == 0)
2248			break;
2249	}
2250	/* Now, decode the rest and write it. */
2251	out = fopen(name, "wb");
2252	while (fgets(buff, sizeof(buff), in) != NULL) {
2253		char *p = buff;
2254		int bytes;
2255
2256		if (memcmp(buff, "end", 3) == 0)
2257			break;
2258
2259		bytes = UUDECODE(*p++);
2260		while (bytes > 0) {
2261			int n = 0;
2262			/* Write out 1-3 bytes from that. */
2263			if (bytes > 0) {
2264				assert(VALID_UUDECODE(p[0]));
2265				assert(VALID_UUDECODE(p[1]));
2266				n = UUDECODE(*p++) << 18;
2267				n |= UUDECODE(*p++) << 12;
2268				fputc(n >> 16, out);
2269				--bytes;
2270			}
2271			if (bytes > 0) {
2272				assert(VALID_UUDECODE(p[0]));
2273				n |= UUDECODE(*p++) << 6;
2274				fputc((n >> 8) & 0xFF, out);
2275				--bytes;
2276			}
2277			if (bytes > 0) {
2278				assert(VALID_UUDECODE(p[0]));
2279				n |= UUDECODE(*p++);
2280				fputc(n & 0xFF, out);
2281				--bytes;
2282			}
2283		}
2284	}
2285	fclose(out);
2286	fclose(in);
2287}
2288
2289void
2290copy_reference_file(const char *name)
2291{
2292	char buff[1024];
2293	FILE *in, *out;
2294	size_t rbytes;
2295
2296	sprintf(buff, "%s/%s", refdir, name);
2297	in = fopen(buff, "rb");
2298	failure("Couldn't open reference file %s", buff);
2299	assert(in != NULL);
2300	if (in == NULL)
2301		return;
2302	/* Now, decode the rest and write it. */
2303	/* Not a lot of error checking here; the input better be right. */
2304	out = fopen(name, "wb");
2305	while ((rbytes = fread(buff, 1, sizeof(buff), in)) > 0) {
2306		if (fwrite(buff, 1, rbytes, out) != rbytes) {
2307			logprintf("Error: fwrite\n");
2308			break;
2309		}
2310	}
2311	fclose(out);
2312	fclose(in);
2313}
2314
2315int
2316is_LargeInode(const char *file)
2317{
2318#if defined(_WIN32) && !defined(__CYGWIN__)
2319	BY_HANDLE_FILE_INFORMATION bhfi;
2320	int r;
2321
2322	r = my_GetFileInformationByName(file, &bhfi);
2323	if (r != 0)
2324		return (0);
2325	return (bhfi.nFileIndexHigh & 0x0000FFFFUL);
2326#else
2327	struct stat st;
2328	int64_t ino;
2329
2330	if (stat(file, &st) < 0)
2331		return (0);
2332	ino = (int64_t)st.st_ino;
2333	return (ino > 0xffffffff);
2334#endif
2335}
2336
2337void
2338extract_reference_files(const char **names)
2339{
2340	while (names && *names)
2341		extract_reference_file(*names++);
2342}
2343
2344/*
2345 *
2346 * TEST management
2347 *
2348 */
2349
2350/*
2351 * "list.h" is simply created by "grep DEFINE_TEST test_*.c"; it has
2352 * a line like
2353 *      DEFINE_TEST(test_function)
2354 * for each test.
2355 */
2356
2357/* Use "list.h" to declare all of the test functions. */
2358#undef DEFINE_TEST
2359#define	DEFINE_TEST(name) void name(void);
2360#include "list.h"
2361
2362/* Use "list.h" to create a list of all tests (functions and names). */
2363#undef DEFINE_TEST
2364#define	DEFINE_TEST(n) { n, #n, 0 },
2365struct test_list_t tests[] = {
2366	#include "list.h"
2367};
2368
2369/*
2370 * Summarize repeated failures in the just-completed test.
2371 */
2372static void
2373test_summarize(int failed, int skips_num)
2374{
2375	unsigned int i;
2376
2377	switch (verbosity) {
2378	case VERBOSITY_SUMMARY_ONLY:
2379		printf(failed ? "E" : ".");
2380		fflush(stdout);
2381		break;
2382	case VERBOSITY_PASSFAIL:
2383		printf(failed ? "FAIL\n" : skips_num ? "ok (S)\n" : "ok\n");
2384		break;
2385	}
2386
2387	log_console = (verbosity == VERBOSITY_LIGHT_REPORT);
2388
2389	for (i = 0; i < sizeof(failed_lines)/sizeof(failed_lines[0]); i++) {
2390		if (failed_lines[i].count > 1 && !failed_lines[i].skip)
2391			logprintf("%s:%d: Summary: Failed %d times\n",
2392			    failed_filename, i, failed_lines[i].count);
2393	}
2394	/* Clear the failure history for the next file. */
2395	failed_filename = NULL;
2396	memset(failed_lines, 0, sizeof(failed_lines));
2397}
2398
2399/*
2400 * Actually run a single test, with appropriate setup and cleanup.
2401 */
2402static int
2403test_run(int i, const char *tmpdir)
2404{
2405	char workdir[1024];
2406	char logfilename[64];
2407	int failures_before = failures;
2408	int skips_before = skips;
2409	int oldumask;
2410
2411	switch (verbosity) {
2412	case VERBOSITY_SUMMARY_ONLY: /* No per-test reports at all */
2413		break;
2414	case VERBOSITY_PASSFAIL: /* rest of line will include ok/FAIL marker */
2415		printf("%3d: %-64s", i, tests[i].name);
2416		fflush(stdout);
2417		break;
2418	default: /* Title of test, details will follow */
2419		printf("%3d: %s\n", i, tests[i].name);
2420	}
2421
2422	/* Chdir to the top-level work directory. */
2423	if (!assertChdir(tmpdir)) {
2424		fprintf(stderr,
2425		    "ERROR: Can't chdir to top work dir %s\n", tmpdir);
2426		exit(1);
2427	}
2428	/* Create a log file for this test. */
2429	sprintf(logfilename, "%s.log", tests[i].name);
2430	logfile = fopen(logfilename, "w");
2431	fprintf(logfile, "%s\n\n", tests[i].name);
2432	/* Chdir() to a work dir for this specific test. */
2433	snprintf(workdir, sizeof(workdir), "%s/%s", tmpdir, tests[i].name);
2434	testworkdir = workdir;
2435	if (!assertMakeDir(testworkdir, 0755)
2436	    || !assertChdir(testworkdir)) {
2437		fprintf(stderr,
2438		    "ERROR: Can't chdir to work dir %s\n", testworkdir);
2439		exit(1);
2440	}
2441	/* Explicitly reset the locale before each test. */
2442	setlocale(LC_ALL, "C");
2443	/* Record the umask before we run the test. */
2444	umask(oldumask = umask(0));
2445	/*
2446	 * Run the actual test.
2447	 */
2448	(*tests[i].func)();
2449	/*
2450	 * Clean up and report afterwards.
2451	 */
2452	testworkdir = NULL;
2453	/* Restore umask */
2454	umask(oldumask);
2455	/* Reset locale. */
2456	setlocale(LC_ALL, "C");
2457	/* Reset directory. */
2458	if (!assertChdir(tmpdir)) {
2459		fprintf(stderr, "ERROR: Couldn't chdir to temp dir %s\n",
2460		    tmpdir);
2461		exit(1);
2462	}
2463	/* Report per-test summaries. */
2464	tests[i].failures = failures - failures_before;
2465	test_summarize(tests[i].failures, skips - skips_before);
2466	/* Close the per-test log file. */
2467	fclose(logfile);
2468	logfile = NULL;
2469	/* If there were no failures, we can remove the work dir and logfile. */
2470	if (tests[i].failures == 0) {
2471		if (!keep_temp_files && assertChdir(tmpdir)) {
2472#if defined(_WIN32) && !defined(__CYGWIN__)
2473			/* Make sure not to leave empty directories.
2474			 * Sometimes a processing of closing files used by tests
2475			 * is not done, then rmdir will be failed and it will
2476			 * leave a empty test directory. So we should wait a few
2477			 * seconds and retry rmdir. */
2478			int r, t;
2479			for (t = 0; t < 10; t++) {
2480				if (t > 0)
2481					Sleep(1000);
2482				r = systemf("rmdir /S /Q %s", tests[i].name);
2483				if (r == 0)
2484					break;
2485			}
2486			systemf("del %s", logfilename);
2487#else
2488			systemf("rm -rf %s", tests[i].name);
2489			systemf("rm %s", logfilename);
2490#endif
2491		}
2492	}
2493	/* Return appropriate status. */
2494	return (tests[i].failures);
2495}
2496
2497/*
2498 *
2499 *
2500 * MAIN and support routines.
2501 *
2502 *
2503 */
2504
2505static void
2506usage(const char *program)
2507{
2508	static const int limit = sizeof(tests) / sizeof(tests[0]);
2509	int i;
2510
2511	printf("Usage: %s [options] <test> <test> ...\n", program);
2512	printf("Default is to run all tests.\n");
2513	printf("Otherwise, specify the numbers of the tests you wish to run.\n");
2514	printf("Options:\n");
2515	printf("  -d  Dump core after any failure, for debugging.\n");
2516	printf("  -k  Keep all temp files.\n");
2517	printf("      Default: temp files for successful tests deleted.\n");
2518#ifdef PROGRAM
2519	printf("  -p <path>  Path to executable to be tested.\n");
2520	printf("      Default: path taken from " ENVBASE " environment variable.\n");
2521#endif
2522	printf("  -q  Quiet.\n");
2523	printf("  -r <dir>   Path to dir containing reference files.\n");
2524	printf("      Default: Current directory.\n");
2525	printf("  -u  Keep running specifies tests until one fails.\n");
2526	printf("  -v  Verbose.\n");
2527	printf("Available tests:\n");
2528	for (i = 0; i < limit; i++)
2529		printf("  %d: %s\n", i, tests[i].name);
2530	exit(1);
2531}
2532
2533static char *
2534get_refdir(const char *d)
2535{
2536	char tried[512] = { '\0' };
2537	char buff[128];
2538	char *pwd, *p;
2539
2540	/* If a dir was specified, try that */
2541	if (d != NULL) {
2542		pwd = NULL;
2543		snprintf(buff, sizeof(buff), "%s", d);
2544		p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2545		if (p != NULL) goto success;
2546		strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2547		strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2548		goto failure;
2549	}
2550
2551	/* Get the current dir. */
2552#ifdef PATH_MAX
2553	pwd = getcwd(NULL, PATH_MAX);/* Solaris getcwd needs the size. */
2554#else
2555	pwd = getcwd(NULL, 0);
2556#endif
2557	while (pwd[strlen(pwd) - 1] == '\n')
2558		pwd[strlen(pwd) - 1] = '\0';
2559
2560	/* Look for a known file. */
2561	snprintf(buff, sizeof(buff), "%s", pwd);
2562	p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2563	if (p != NULL) goto success;
2564	strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2565	strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2566
2567	snprintf(buff, sizeof(buff), "%s/test", pwd);
2568	p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2569	if (p != NULL) goto success;
2570	strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2571	strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2572
2573#if defined(LIBRARY)
2574	snprintf(buff, sizeof(buff), "%s/%s/test", pwd, LIBRARY);
2575#else
2576	snprintf(buff, sizeof(buff), "%s/%s/test", pwd, PROGRAM);
2577#endif
2578	p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2579	if (p != NULL) goto success;
2580	strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2581	strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2582
2583#if defined(PROGRAM_ALIAS)
2584	snprintf(buff, sizeof(buff), "%s/%s/test", pwd, PROGRAM_ALIAS);
2585	p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2586	if (p != NULL) goto success;
2587	strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2588	strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2589#endif
2590
2591	if (memcmp(pwd, "/usr/obj", 8) == 0) {
2592		snprintf(buff, sizeof(buff), "%s", pwd + 8);
2593		p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2594		if (p != NULL) goto success;
2595		strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2596		strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2597
2598		snprintf(buff, sizeof(buff), "%s/test", pwd + 8);
2599		p = slurpfile(NULL, "%s/%s", buff, KNOWNREF);
2600		if (p != NULL) goto success;
2601		strncat(tried, buff, sizeof(tried) - strlen(tried) - 1);
2602		strncat(tried, "\n", sizeof(tried) - strlen(tried) - 1);
2603	}
2604
2605failure:
2606	printf("Unable to locate known reference file %s\n", KNOWNREF);
2607	printf("  Checked following directories:\n%s\n", tried);
2608	printf("Use -r option to specify full path to reference directory\n");
2609#if defined(_WIN32) && !defined(__CYGWIN__) && defined(_DEBUG)
2610	DebugBreak();
2611#endif
2612	exit(1);
2613
2614success:
2615	free(p);
2616	free(pwd);
2617	return strdup(buff);
2618}
2619
2620int
2621main(int argc, char **argv)
2622{
2623	static const int limit = sizeof(tests) / sizeof(tests[0]);
2624	int test_set[sizeof(tests) / sizeof(tests[0])];
2625	int i = 0, j = 0, tests_run = 0, tests_failed = 0, option;
2626	time_t now;
2627	char *refdir_alloc = NULL;
2628	const char *progname;
2629	char **saved_argv;
2630	const char *tmp, *option_arg, *p;
2631	char tmpdir[256], *pwd, *testprogdir, *tmp2 = NULL, *vlevel = NULL;
2632	char tmpdir_timestamp[256];
2633
2634	(void)argc; /* UNUSED */
2635
2636	/* Get the current dir. */
2637#ifdef PATH_MAX
2638	pwd = getcwd(NULL, PATH_MAX);/* Solaris getcwd needs the size. */
2639#else
2640	pwd = getcwd(NULL, 0);
2641#endif
2642	while (pwd[strlen(pwd) - 1] == '\n')
2643		pwd[strlen(pwd) - 1] = '\0';
2644
2645#if defined(HAVE__CrtSetReportMode) && !defined(__WATCOMC__)
2646	/* To stop to run the default invalid parameter handler. */
2647	_set_invalid_parameter_handler(invalid_parameter_handler);
2648	/* Disable annoying assertion message box. */
2649	_CrtSetReportMode(_CRT_ASSERT, 0);
2650#endif
2651
2652	/*
2653	 * Name of this program, used to build root of our temp directory
2654	 * tree.
2655	 */
2656	progname = p = argv[0];
2657	if ((testprogdir = (char *)malloc(strlen(progname) + 1)) == NULL)
2658	{
2659		fprintf(stderr, "ERROR: Out of memory.");
2660		exit(1);
2661	}
2662	strcpy(testprogdir, progname);
2663	while (*p != '\0') {
2664		/* Support \ or / dir separators for Windows compat. */
2665		if (*p == '/' || *p == '\\')
2666		{
2667			progname = p + 1;
2668			i = j;
2669		}
2670		++p;
2671		j++;
2672	}
2673	testprogdir[i] = '\0';
2674#if defined(_WIN32) && !defined(__CYGWIN__)
2675	if (testprogdir[0] != '/' && testprogdir[0] != '\\' &&
2676	    !(((testprogdir[0] >= 'a' && testprogdir[0] <= 'z') ||
2677	       (testprogdir[0] >= 'A' && testprogdir[0] <= 'Z')) &&
2678		testprogdir[1] == ':' &&
2679		(testprogdir[2] == '/' || testprogdir[2] == '\\')))
2680#else
2681	if (testprogdir[0] != '/')
2682#endif
2683	{
2684		/* Fixup path for relative directories. */
2685		if ((testprogdir = (char *)realloc(testprogdir,
2686			strlen(pwd) + 1 + strlen(testprogdir) + 1)) == NULL)
2687		{
2688			fprintf(stderr, "ERROR: Out of memory.");
2689			exit(1);
2690		}
2691		memmove(testprogdir + strlen(pwd) + 1, testprogdir,
2692		    strlen(testprogdir) + 1);
2693		memcpy(testprogdir, pwd, strlen(pwd));
2694		testprogdir[strlen(pwd)] = '/';
2695	}
2696
2697#ifdef PROGRAM
2698	/* Get the target program from environment, if available. */
2699	testprogfile = getenv(ENVBASE);
2700#endif
2701
2702	if (getenv("TMPDIR") != NULL)
2703		tmp = getenv("TMPDIR");
2704	else if (getenv("TMP") != NULL)
2705		tmp = getenv("TMP");
2706	else if (getenv("TEMP") != NULL)
2707		tmp = getenv("TEMP");
2708	else if (getenv("TEMPDIR") != NULL)
2709		tmp = getenv("TEMPDIR");
2710	else
2711		tmp = "/tmp";
2712
2713	/* Allow -d to be controlled through the environment. */
2714	if (getenv(ENVBASE "_DEBUG") != NULL)
2715		dump_on_failure = 1;
2716
2717	/* Allow -v to be controlled through the environment. */
2718	if (getenv("_VERBOSITY_LEVEL") != NULL)
2719	{
2720		vlevel = getenv("_VERBOSITY_LEVEL");
2721		verbosity = atoi(vlevel);
2722		if (verbosity < VERBOSITY_SUMMARY_ONLY || verbosity > VERBOSITY_FULL)
2723		{
2724			/* Unsupported verbosity levels are silently ignored */
2725			vlevel = NULL;
2726			verbosity = VERBOSITY_PASSFAIL;
2727		}
2728	}
2729
2730	/* Get the directory holding test files from environment. */
2731	refdir = getenv(ENVBASE "_TEST_FILES");
2732
2733	/*
2734	 * Parse options, without using getopt(), which isn't available
2735	 * on all platforms.
2736	 */
2737	++argv; /* Skip program name */
2738	while (*argv != NULL) {
2739		if (**argv != '-')
2740			break;
2741		p = *argv++;
2742		++p; /* Skip '-' */
2743		while (*p != '\0') {
2744			option = *p++;
2745			option_arg = NULL;
2746			/* If 'opt' takes an argument, parse that. */
2747			if (option == 'p' || option == 'r') {
2748				if (*p != '\0')
2749					option_arg = p;
2750				else if (*argv == NULL) {
2751					fprintf(stderr,
2752					    "Option -%c requires argument.\n",
2753					    option);
2754					usage(progname);
2755				} else
2756					option_arg = *argv++;
2757				p = ""; /* End of this option word. */
2758			}
2759
2760			/* Now, handle the option. */
2761			switch (option) {
2762			case 'd':
2763				dump_on_failure = 1;
2764				break;
2765			case 'k':
2766				keep_temp_files = 1;
2767				break;
2768			case 'p':
2769#ifdef PROGRAM
2770				testprogfile = option_arg;
2771#else
2772				fprintf(stderr, "-p option not permitted\n");
2773				usage(progname);
2774#endif
2775				break;
2776			case 'q':
2777				if (!vlevel)
2778					verbosity--;
2779				break;
2780			case 'r':
2781				refdir = option_arg;
2782				break;
2783			case 'u':
2784				until_failure++;
2785				break;
2786			case 'v':
2787				if (!vlevel)
2788					verbosity++;
2789				break;
2790			default:
2791				fprintf(stderr, "Unrecognized option '%c'\n",
2792				    option);
2793				usage(progname);
2794			}
2795		}
2796	}
2797
2798	/*
2799	 * Sanity-check that our options make sense.
2800	 */
2801#ifdef PROGRAM
2802	if (testprogfile == NULL)
2803	{
2804		if ((tmp2 = (char *)malloc(strlen(testprogdir) + 1 +
2805			strlen(PROGRAM) + 1)) == NULL)
2806		{
2807			fprintf(stderr, "ERROR: Out of memory.");
2808			exit(1);
2809		}
2810		strcpy(tmp2, testprogdir);
2811		strcat(tmp2, "/");
2812		strcat(tmp2, PROGRAM);
2813		testprogfile = tmp2;
2814	}
2815
2816	{
2817		char *testprg;
2818#if defined(_WIN32) && !defined(__CYGWIN__)
2819		/* Command.com sometimes rejects '/' separators. */
2820		testprg = strdup(testprogfile);
2821		for (i = 0; testprg[i] != '\0'; i++) {
2822			if (testprg[i] == '/')
2823				testprg[i] = '\\';
2824		}
2825		testprogfile = testprg;
2826#endif
2827		/* Quote the name that gets put into shell command lines. */
2828		testprg = malloc(strlen(testprogfile) + 3);
2829		strcpy(testprg, "\"");
2830		strcat(testprg, testprogfile);
2831		strcat(testprg, "\"");
2832		testprog = testprg;
2833	}
2834#endif
2835
2836#if !defined(_WIN32) && defined(SIGPIPE)
2837	{   /* Ignore SIGPIPE signals */
2838		struct sigaction sa;
2839		sa.sa_handler = SIG_IGN;
2840		sigemptyset(&sa.sa_mask);
2841		sa.sa_flags = 0;
2842		sigaction(SIGPIPE, &sa, NULL);
2843	}
2844#endif
2845
2846	/*
2847	 * Create a temp directory for the following tests.
2848	 * Include the time the tests started as part of the name,
2849	 * to make it easier to track the results of multiple tests.
2850	 */
2851	now = time(NULL);
2852	for (i = 0; ; i++) {
2853		strftime(tmpdir_timestamp, sizeof(tmpdir_timestamp),
2854		    "%Y-%m-%dT%H.%M.%S",
2855		    localtime(&now));
2856		sprintf(tmpdir, "%s/%s.%s-%03d", tmp, progname,
2857		    tmpdir_timestamp, i);
2858		if (assertMakeDir(tmpdir,0755))
2859			break;
2860		if (i >= 999) {
2861			fprintf(stderr,
2862			    "ERROR: Unable to create temp directory %s\n",
2863			    tmpdir);
2864			exit(1);
2865		}
2866	}
2867
2868	/*
2869	 * If the user didn't specify a directory for locating
2870	 * reference files, try to find the reference files in
2871	 * the "usual places."
2872	 */
2873	refdir = refdir_alloc = get_refdir(refdir);
2874
2875	/*
2876	 * Banner with basic information.
2877	 */
2878	printf("\n");
2879	printf("If tests fail or crash, details will be in:\n");
2880	printf("   %s\n", tmpdir);
2881	printf("\n");
2882	if (verbosity > VERBOSITY_SUMMARY_ONLY) {
2883		printf("Reference files will be read from: %s\n", refdir);
2884#ifdef PROGRAM
2885		printf("Running tests on: %s\n", testprog);
2886#endif
2887		printf("Exercising: ");
2888		fflush(stdout);
2889		printf("%s\n", EXTRA_VERSION);
2890	} else {
2891		printf("Running ");
2892		fflush(stdout);
2893	}
2894
2895	/*
2896	 * Run some or all of the individual tests.
2897	 */
2898	saved_argv = argv;
2899	do {
2900		argv = saved_argv;
2901		do {
2902			int test_num;
2903
2904			test_num = get_test_set(test_set, limit, *argv, tests);
2905			if (test_num < 0) {
2906				printf("*** INVALID Test %s\n", *argv);
2907				free(refdir_alloc);
2908				free(testprogdir);
2909				usage(progname);
2910				return (1);
2911			}
2912			for (i = 0; i < test_num; i++) {
2913				tests_run++;
2914				if (test_run(test_set[i], tmpdir)) {
2915					tests_failed++;
2916					if (until_failure)
2917						goto finish;
2918				}
2919			}
2920			if (*argv != NULL)
2921				argv++;
2922		} while (*argv != NULL);
2923	} while (until_failure);
2924
2925finish:
2926	/* Must be freed after all tests run */
2927	free(tmp2);
2928	free(testprogdir);
2929	free(pwd);
2930
2931	/*
2932	 * Report summary statistics.
2933	 */
2934	if (verbosity > VERBOSITY_SUMMARY_ONLY) {
2935		printf("\n");
2936		printf("Totals:\n");
2937		printf("  Tests run:         %8d\n", tests_run);
2938		printf("  Tests failed:      %8d\n", tests_failed);
2939		printf("  Assertions checked:%8d\n", assertions);
2940		printf("  Assertions failed: %8d\n", failures);
2941		printf("  Skips reported:    %8d\n", skips);
2942	}
2943	if (failures) {
2944		printf("\n");
2945		printf("Failing tests:\n");
2946		for (i = 0; i < limit; ++i) {
2947			if (tests[i].failures)
2948				printf("  %d: %s (%d failures)\n", i,
2949				    tests[i].name, tests[i].failures);
2950		}
2951		printf("\n");
2952		printf("Details for failing tests: %s\n", tmpdir);
2953		printf("\n");
2954	} else {
2955		if (verbosity == VERBOSITY_SUMMARY_ONLY)
2956			printf("\n");
2957		printf("%d tests passed, no failures\n", tests_run);
2958	}
2959
2960	free(refdir_alloc);
2961
2962	/* If the final tmpdir is empty, we can remove it. */
2963	/* This should be the usual case when all tests succeed. */
2964	assertChdir("..");
2965	rmdir(tmpdir);
2966
2967	return (tests_failed ? 1 : 0);
2968}
2969