2 * Copyright (c) 1998-2001 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * The contents of this file constitute Original Code as defined in and
7 * are subject to the Apple Public Source License Version 1.2 (the
8 * "License"). You may not use this file except in compliance with the
9 * License. Please obtain a copy of the License at
10 * http://www.apple.com/publicsource and read it before using this file.
12 * This Original Code and all software distributed under the License are
13 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17 * License for the specific language governing rights and limitations
20 * @APPLE_LICENSE_HEADER_END@
22 * WARNING--WARNING--WARNING
23 * This is not the original fsx.c. It has been modified to run with
24 * yaffs direct. Seek out the original fsx.c if you want to do anything
30 * Author: Avadis Tevanian, Jr.
32 * File system exerciser.
34 * Rewrite and enhancements 1998-2001 Conrad Minshall -- conrad@mac.com
36 * Various features from Joe Sokol, Pat Dirks, and Clark Warner.
38 * Small changes to work under Linux -- davej@suse.de
40 * Sundry porting patches from Guy Harris 12/2001
42 * Checks for mmap last-page zero fill.
44 * Modified heavily by Charles Manning to exercise via the
45 * yaffs direct interface.
49 #include "yaffs_fsx.h"
51 #include <sys/types.h>
54 # include <sys/param.h>
76 #define NUMPRINTCOLUMNS 32 /* # columns of data to print on each line */
79 * A log entry is an operation and a bunch of arguments.
89 struct log_entry oplog[LOGSIZE]; /* the log */
90 int logptr = 0; /* current position in log */
91 int logcount = 0; /* total ops */
100 #define OP_CLOSEOPEN 4
102 #define OP_MAPWRITE 6
108 char *original_buf; /* a pointer to the original data */
109 char *good_buf; /* a pointer to the correct data */
110 char *temp_buf; /* a pointer to the current data */
112 char fname[200]; /* name of our test file */
113 char mount_name[200];
115 int fd; /* fd for our test file */
120 unsigned long testcalls = 0; /* calls to function "test" */
122 unsigned long simulatedopcount = 0; /* -b flag */
123 unsigned closeprob = 0; /* -c flag */
124 int debug = 0; /* -d flag */
125 unsigned long debugstart = 0; /* -D flag */
126 unsigned long maxfilelen = 256 * 1024; /* -l flag */
127 int sizechecks = 1; /* -n flag disables them */
128 int maxoplen = 64 * 1024; /* -o flag */
129 int quiet = 0; /* -q flag */
130 unsigned long progressinterval = 0; /* -p flag */
131 int readbdy = 1; /* -r flag */
132 int style = 0; /* -s flag */
133 int truncbdy = 1; /* -t flag */
134 int writebdy = 1; /* -w flag */
135 long monitorstart = -1; /* -m flag */
136 long monitorend = -1; /* -m flag */
137 int lite = 0; /* -L flag */
138 int randomoplen = 1; /* -O flag disables it */
139 int seed = 1; /* -S flag */
141 int mapped_writes = 0; /* yaffs direct does not support mmapped files */
142 int mapped_reads = 0;
145 FILE * fsxlogf = NULL;
153 printf("fsx wanted to exit with %d\n",x);
162 vwarnc(code, fmt, ap)
167 fprintf(stderr, "fsx: ");
169 vfprintf(stderr, fmt, ap);
170 fprintf(stderr, ": ");
172 fprintf(stderr, "%s\n", strerror(code));
177 warn(const char * fmt, ...)
181 vwarnc(errno, fmt, ap);
192 vfprintf(stdout, fmt, args);
194 vfprintf(fsxlogf, fmt, args);
201 prt("%s%s%s\n", prefix, prefix ? ": " : "", strerror(errno));
206 log4(int operation, int arg0, int arg1, int arg2)
208 struct log_entry *le;
211 le->operation = operation;
213 le->operation = ~ le->operation;
219 if (logptr >= LOGSIZE)
228 struct log_entry *lp;
230 prt("LOG DUMP (%d total operations):\n", logcount);
231 if (logcount < LOGSIZE) {
238 for ( ; count > 0; count--) {
241 opnum = i+1 + (logcount/LOGSIZE)*LOGSIZE;
242 prt("%d(%d mod 256): ", opnum, opnum%256);
244 if ((closeopen = lp->operation < 0))
245 lp->operation = ~ lp->operation;
247 switch (lp->operation) {
249 prt("MAPREAD\t0x%x thru 0x%x\t(0x%x bytes)",
250 lp->args[0], lp->args[0] + lp->args[1] - 1,
252 if (badoff >= lp->args[0] && badoff <
253 lp->args[0] + lp->args[1])
257 prt("MAPWRITE 0x%x thru 0x%x\t(0x%x bytes)",
258 lp->args[0], lp->args[0] + lp->args[1] - 1,
260 if (badoff >= lp->args[0] && badoff <
261 lp->args[0] + lp->args[1])
265 prt("READ\t0x%x thru 0x%x\t(0x%x bytes)",
266 lp->args[0], lp->args[0] + lp->args[1] - 1,
268 if (badoff >= lp->args[0] &&
269 badoff < lp->args[0] + lp->args[1])
273 prt("WRITE\t0x%x thru 0x%x\t(0x%x bytes)",
274 lp->args[0], lp->args[0] + lp->args[1] - 1,
276 if (lp->args[0] > lp->args[2])
278 else if (lp->args[0] + lp->args[1] > lp->args[2])
280 if ((badoff >= lp->args[0] || badoff >=lp->args[2]) &&
281 badoff < lp->args[0] + lp->args[1])
285 down = lp->args[0] < lp->args[1];
286 prt("TRUNCATE %s\tfrom 0x%x to 0x%x",
287 down ? "DOWN" : "UP", lp->args[1], lp->args[0]);
288 if (badoff >= lp->args[!down] &&
289 badoff < lp->args[!!down])
293 prt("SKIPPED (no operation)");
296 prt("BOGUS LOG ENTRY (operation code = %d)!",
300 prt("\n\t\tCLOSE/OPEN");
310 save_buffer(char *buffer, off_t bufferlength, int fd)
313 ssize_t byteswritten;
315 if (fd <= 0 || bufferlength == 0)
318 if (bufferlength > SSIZE_MAX) {
319 prt("fsx flaw: overflow in save_buffer\n");
323 off_t size_by_seek = yaffs_lseek(fd, (off_t)0, SEEK_END);
324 if (size_by_seek == (off_t)-1)
325 prterr("save_buffer: lseek eof");
326 else if (bufferlength > size_by_seek) {
327 warn("save_buffer: .fsxgood file too short... will save 0x%llx bytes instead of 0x%llx\n", (unsigned long long)size_by_seek,
328 (unsigned long long)bufferlength);
329 bufferlength = size_by_seek;
333 ret = yaffs_lseek(fd, (off_t)0, SEEK_SET);
334 if (ret == (off_t)-1)
335 prterr("save_buffer: lseek 0");
337 byteswritten = yaffs_write(fd, buffer, (size_t)bufferlength);
338 if (byteswritten != bufferlength) {
339 if (byteswritten == -1)
340 prterr("save_buffer write");
342 warn("save_buffer: short write, 0x%x bytes instead of 0x%llx\n",
343 (unsigned)byteswritten,
344 (unsigned long long)bufferlength);
350 report_failure(int status)
356 save_buffer(good_buf, file_size, fsxgoodfd);
357 prt("Correct content saved for comparison\n");
358 prt("(maybe hexdump \"%s\" vs \"%s.fsxgood\")\n",
363 prt("Exiting with %d\n",status);
368 #define short_at(cp) ((unsigned short)((*((unsigned char *)(cp)) << 8) | \
369 *(((unsigned char *)(cp)) + 1)))
372 check_buffers(unsigned offset, unsigned size)
380 if (memcmp(good_buf + offset, temp_buf, size) != 0) {
381 prt("READ BAD DATA: offset = 0x%x, size = 0x%x\n",
383 prt("OFFSET\tGOOD\tBAD\tRANGE\n");
385 c = good_buf[offset];
389 bad = short_at(&temp_buf[i]);
390 prt("0x%5x\t0x%04x\t0x%04x", offset,
391 short_at(&good_buf[offset]), bad);
392 op = temp_buf[offset & 1 ? i+1 : i];
404 prt("operation# (mod 256) for the bad data may be %u\n", ((unsigned)op & 0xff));
406 prt("operation# (mod 256) for the bad data unknown, check HOLE and EXTEND ops\n");
408 prt("????????????????\n");
417 struct yaffs_stat statbuf;
420 if (yaffs_fstat(fd, &statbuf)) {
421 prterr("check_size: fstat");
422 statbuf.st_size = -1;
424 size_by_seek = yaffs_lseek(fd, (off_t)0, SEEK_END);
425 if (file_size != statbuf.st_size ||
426 file_size != size_by_seek) {
427 prt("Size error: expected 0x%llx stat 0x%llx seek 0x%llx\n",
428 (unsigned long long)file_size,
429 (unsigned long long)statbuf.st_size,
430 (unsigned long long)size_by_seek);
437 check_trunc_hack(void)
439 struct yaffs_stat statbuf;
441 yaffs_ftruncate(fd, (off_t)0);
442 yaffs_ftruncate(fd, (off_t)100000);
443 yaffs_fstat(fd, &statbuf);
444 if (statbuf.st_size != (off_t)100000) {
445 prt("no extend on truncate! not posix!\n");
448 yaffs_ftruncate(fd, (off_t)0);
453 doread(unsigned offset, unsigned size)
458 offset -= offset % readbdy;
460 if (!quiet && testcalls > simulatedopcount)
461 prt("skipping zero size read\n");
462 log4(OP_SKIPPED, OP_READ, offset, size);
465 if ((off_t)(size + offset) > file_size) {
466 if (!quiet && testcalls > simulatedopcount)
467 prt("skipping seek/read past end of file\n");
468 log4(OP_SKIPPED, OP_READ, offset, size);
472 log4(OP_READ, offset, size, 0);
474 if (testcalls <= simulatedopcount)
477 if (!quiet && ((progressinterval &&
478 testcalls % progressinterval == 0) ||
480 (monitorstart == -1 ||
481 (offset + size > monitorstart &&
482 (monitorend == -1 || offset <= monitorend))))))
483 prt("%lu read\t0x%x thru\t0x%x\t(0x%x bytes)\n", testcalls,
484 offset, offset + size - 1, size);
485 ret = yaffs_lseek(fd, (off_t)offset, SEEK_SET);
486 if (ret == (off_t)-1) {
487 prterr("doread: lseek");
490 iret = yaffs_read(fd, temp_buf, size);
492 if (iret == (unsigned)(-1))
493 prterr("doread: read");
495 prt("short read: 0x%x bytes instead of 0x%x\n",
499 check_buffers(offset, size);
507 gendata(char *original_buf, char *good_buf, unsigned offset, unsigned size)
510 good_buf[offset] = testcalls % 256;
512 good_buf[offset] += original_buf[offset];
519 dowrite(unsigned offset, unsigned size)
524 offset -= offset % writebdy;
526 if (!quiet && testcalls > simulatedopcount)
527 prt("skipping zero size write\n");
528 log4(OP_SKIPPED, OP_WRITE, offset, size);
532 log4(OP_WRITE, offset, size, file_size);
534 gendata(original_buf, good_buf, offset, size);
535 if (file_size < offset + size) {
536 if (file_size < offset)
537 memset(good_buf + file_size, '\0', offset - file_size);
538 file_size = offset + size;
540 warn("Lite file size bug in fsx!");
545 if (testcalls <= simulatedopcount)
548 if (!quiet && ((progressinterval &&
549 testcalls % progressinterval == 0) ||
551 (monitorstart == -1 ||
552 (offset + size > monitorstart &&
553 (monitorend == -1 || offset <= monitorend))))))
554 prt("%lu write\t0x%x thru\t0x%x\t(0x%x bytes)\n", testcalls,
555 offset, offset + size - 1, size);
556 ret = yaffs_lseek(fd, (off_t)offset, SEEK_SET);
557 if (ret == (off_t)-1) {
558 prterr("dowrite: lseek");
561 iret = yaffs_write(fd, good_buf + offset, size);
563 if (iret == (unsigned)(-1))
564 prterr("dowrite: write");
566 prt("short write: 0x%x bytes instead of 0x%x\n",
575 dotruncate(unsigned size)
577 int oldsize = file_size;
579 size -= size % truncbdy;
580 if (size > biggest) {
582 if (!quiet && testcalls > simulatedopcount)
583 prt("truncating to largest ever: 0x%x\n", size);
586 log4(OP_TRUNCATE, size, (unsigned)file_size, 0);
588 if (size > file_size)
589 memset(good_buf + file_size, '\0', size - file_size);
592 if (testcalls <= simulatedopcount)
595 if ((progressinterval && testcalls % progressinterval == 0) ||
596 (debug && (monitorstart == -1 || monitorend == -1 ||
597 size <= monitorend)))
598 prt("%lu trunc\tfrom 0x%x to 0x%x\n", testcalls, oldsize, size);
599 if (yaffs_ftruncate(fd, (off_t)size) == -1) {
600 prt("ftruncate1: %x\n", size);
601 prterr("dotruncate: ftruncate");
612 if (yaffs_lseek(fd, (off_t)0, SEEK_SET) == (off_t)-1) {
613 prterr("writefileimage: lseek");
616 iret = yaffs_write(fd, good_buf, file_size);
617 if ((off_t)iret != file_size) {
619 prterr("writefileimage: write");
621 prt("short write: 0x%x bytes instead of 0x%llx\n",
622 iret, (unsigned long long)file_size);
625 if (lite ? 0 : yaffs_ftruncate(fd, file_size) == -1) {
626 prt("ftruncate2: %llx\n", (unsigned long long)file_size);
627 prterr("writefileimage: ftruncate");
636 if (testcalls <= simulatedopcount)
640 prt("%lu close/open\n", testcalls);
641 if (yaffs_close(fd)) {
642 prterr("docloseopen: close");
645 fd = yaffs_open(fname, O_RDWR, 0);
647 prterr("docloseopen: open");
654 yaffs_fsx_do_op(void)
656 unsigned long offset;
657 unsigned long size = maxoplen;
658 unsigned long rv = random();
659 unsigned long op = rv % (3 + !lite + mapped_writes);
661 /* turn off the map read if necessary */
663 if (op == 2 && !mapped_reads)
666 if (simulatedopcount > 0 && testcalls == simulatedopcount)
672 closeopen = (rv >> 3) < (1U << 28) / closeprob;
674 if (debugstart > 0 && testcalls >= debugstart)
677 if (!quiet && testcalls < simulatedopcount && testcalls % 100000 == 0)
678 prt("%lu...\n", testcalls);
685 * MAPWRITE: op = 3 or 4
687 if (lite ? 0 : op == 3 && (style & 1) == 0) /* vanilla truncate? */
688 dotruncate(random() % maxfilelen);
691 size = random() % (maxoplen+1);
692 if (lite ? 0 : op == 3)
696 if (op == 1 || op == (lite ? 3 : 4)) {
697 offset %= maxfilelen;
698 if (offset + size > maxfilelen)
699 size = maxfilelen - offset;
700 dowrite(offset, size);
706 if ((ssize_t)(offset + size) > file_size)
707 size = file_size - offset;
708 doread(offset, size);
712 if (sizechecks && testcalls > simulatedopcount)
724 prt("signal %d\n", sig);
725 prt("testcalls = %lu\n", testcalls);
733 fprintf(stdout, "usage: %s",
734 "fsx [-dnqLOW] [-b opnum] [-c Prob] [-l flen] [-m start:end] [-o oplen] [-p progressinterval] [-r readbdy] [-s style] [-t truncbdy] [-w writebdy] [-D startingop] [-N numops] [-P dirpath] [-S seed] fname\n\
735 -b opnum: beginning operation number (default 1)\n\
736 -c P: 1 in P chance of file close+open at each op (default infinity)\n\
737 -d: debug output for all operations\n\
738 -l flen: the upper bound on file size (default 262144)\n\
739 -m startop:endop: monitor (print debug output) specified byte range (default 0:infinity)\n\
740 -n: no verifications of file size\n\
741 -o oplen: the upper bound on operation size (default 65536)\n\
742 -p progressinterval: debug output at specified operation interval\n\
743 -q: quieter operation\n\
744 -r readbdy: 4096 would make reads page aligned (default 1)\n\
745 -s style: 1 gives smaller truncates (default 0)\n\
746 -t truncbdy: 4096 would make truncates page aligned (default 1)\n\
747 -w writebdy: 4096 would make writes page aligned (default 1)\n\
748 -D startingop: debug output starting at specified operation\n\
749 -L: fsxLite - no file creations & no file size changes\n\
750 -N numops: total # operations to do (default infinity)\n\
751 -O: use oplen (see -o flag) for every op (default random)\n\
752 -P dirpath: save .fsxlog and .fsxgood files in dirpath (default ./)\n\
753 -S seed: for random # generator (default 1) 0 gets timestamp\n\
754 fname: this filename is REQUIRED (no default)\n");
760 getnum(char *s, char **e)
765 ret = strtol(s, e, 0);
794 extern int random_seed;
795 extern int simulate_power_failure;
798 int mounted_by_fsx = 0;
801 yaffs_fsx_init(const char *mount_pt)
808 page_size = getpagesize();
809 page_mask = page_size - 1;
811 setvbuf(stdout, (char *)0, _IOLBF, 0); /* line buffered stdout */
813 strcpy(mount_name,mount_pt);
814 strcpy(fname,mount_name);
815 strcat(fname,"/fsxdata");
818 signal(SIGHUP, cleanup);
819 signal(SIGINT, cleanup);
820 signal(SIGPIPE, cleanup);
821 signal(SIGALRM, cleanup);
822 signal(SIGTERM, cleanup);
823 signal(SIGXCPU, cleanup);
824 signal(SIGXFSZ, cleanup);
825 signal(SIGVTALRM, cleanup);
826 signal(SIGUSR1, cleanup);
827 signal(SIGUSR2, cleanup);
830 initstate(seed, state, 256);
832 fd = yaffs_open(fname, O_RDWR|(lite ? 0 : O_CREAT|O_TRUNC), 0666);
837 strncat(goodfile, fname, 256);
838 strcat (goodfile, ".fsxgood");
839 fsxgoodfd = yaffs_open(goodfile, O_RDWR|O_CREAT|O_TRUNC, 0666);
844 strncat(logfile, "fsx", 256);
845 strcat (logfile, ".fsxlog");
846 fsxlogf = fopen(logfile, "w");
847 if (fsxlogf == NULL) {
853 file_size = maxfilelen = yaffs_lseek(fd, (off_t)0, SEEK_END);
854 if (file_size == (off_t)-1) {
856 warn("main: lseek eof");
859 ret = yaffs_lseek(fd, (off_t)0, SEEK_SET);
860 if (ret == (off_t)-1) {
862 warn("main: lseek 0");
866 original_buf = (char *) malloc(maxfilelen);
867 for (i = 0; i < maxfilelen; i++)
868 original_buf[i] = random() % 256;
869 good_buf = (char *) malloc(maxfilelen);
870 memset(good_buf, '\0', maxfilelen);
871 temp_buf = (char *) malloc(maxoplen);
872 memset(temp_buf, '\0', maxoplen);
873 if (lite) { /* zero entire existing file */
876 written = yaffs_write(fd, good_buf, (size_t)maxfilelen);
877 if (written != (ssize_t)maxfilelen) {
880 warn("main: error on write");
882 warn("main: short write, 0x%x bytes instead of 0x%x\n",
883 (unsigned)written, maxfilelen);
889 printf("yaffs_fsx_init done\n");
895 int yaffs_fsx_complete(void)
897 if (yaffs_close(fd)) {
902 yaffs_close(fsxgoodfd);
904 prt("All operations completed A-OK!\n");
911 yaffs_fsx_main(const char *mount_pt, int numops)
913 yaffs_fsx_init(mount_pt);
914 while (numops == -1 || numops--)
916 yaffs_fsx_complete();