vbig.cc

   1 /*
   2  * This file is part of vbig.
   3  * Copyright (C) 2011 Richard Kettlewell
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 #include <config.h>
  19 #include <cstdio>
  20 #include <cstring>
  21 #include <cstdlib>
  22 #include <cerrno>
  23 #include <cstdarg>
  24 #include <getopt.h>
  25 #include <unistd.h>
  26 #include <fcntl.h>
  27 #include <limits.h>
  28 #include <assert.h>
  29 #include <sys/stat.h>
  30 #include "Arcfour.h"
  31
  32 #define DEFAULT_SEED_LENGTH 2048;
  33
  34 // Command line options
  35 const struct option opts[] = {
  36   { "seed", required_argument, 0, 's' },
  37   { "seed-file", required_argument, 0, 'S' },
  38   { "seed-length", required_argument, 0, 'L' },
  39   { "both", no_argument, 0, 'b' },
  40   { "verify", no_argument, 0, 'v' },
  41   { "create", no_argument, 0, 'c' },
  42   { "flush", no_argument, 0, 'f' },
  43   { "entire", no_argument, 0, 'e' },
  44   { "help", no_argument, 0, 'h' },
  45   { "version", no_argument, 0, 'V' },
  46   { 0, 0, 0, 0 },
  47 };
  48
  49 // Display help message
  50 static void help(void) {
  51   printf("vbig - create or verify a large but pseudo-random file\n"
  52          "\n"
  53          "Usage:\n"
  54          "  vbig [--seed SEED] --verify|--create PATH [SIZE]\n"
  55          "\n"
  56          "Options:\n"
  57          "  --seed, -s        Specify random seed as string\n"
  58          "  --seed-file, -S   Read random seed from (start of) this file\n"
  59          "  --seed-length, -L Set (maximum) seed length to read from file\n"
  60          "  --verify, -v      Verify that PATH contains the expected contents\n"
  61          "  --create, -c      Create PATH with psuedo-random contents\n"
  62          "  --flush, -f       Flush cache\n"
  63          "  --entire, -e      Write until full; read until EOF\n"
  64          "  --help, -h        Display usage message\n"
  65          "  --version, -V     Display version string\n");
  66 }
  67
  68 // Possible modes of operation
  69 enum mode_type {
  70   VERIFY,
  71   CREATE,
  72   BOTH
  73 };
  74
  75 // Report an error and exit
  76 static void fatal(int errno_value, const char *fmt, ...) {
  77   va_list ap;
  78   fprintf(stderr, "ERROR: ");
  79   va_start(ap, fmt);
  80   vfprintf(stderr, fmt, ap);
  81   va_end(ap);
  82   if(errno_value)
  83     fprintf(stderr, ": %s", strerror(errno_value));
  84   fputc('\n', stderr);
  85   exit(1);
  86 }
  87
  88 // Evict whatever FP points to from RAM
  89 static void flushCache(FILE *fp) {
  90   // drop_caches only evicts clean pages, so first the target file is
  91   // synced.
  92   if(fsync(fileno(fp)) < 0)
  93     fatal(errno, "fsync");
  94 #if defined DROP_CACHE_FILE
  95   int fd;
  96   if((fd = open(DROP_CACHE_FILE, O_WRONLY, 0)) < 0)
  97     fatal(errno, "%s", DROP_CACHE_FILE);
  98   if(write(fd, "3\n", 2) < 0)
  99     fatal(errno, "%s", DROP_CACHE_FILE);
 100   close(fd);
 101 #elif defined PURGE_COMMAND
 102   int rc;
 103   if((rc = system(PURGE_COMMAND)) < 0)
 104     fatal(errno, "executing %s", PURGE_COMMAND);
 105   else if(rc) {
 106     if(WIFSIGNALED(rc)) {
 107       fprintf(stderr, "%s%s\n",
 108               strsignal(WTERMSIG(rc)),
 109               WCOREDUMP(rc) ? " (core dumped)" : "");
 110       exit(WTERMSIG(rc) + 128);
 111     } else
 112       exit(WEXITSTATUS(rc));
 113   }
 114 #endif
 115 }
 116
 117 static long long execute(mode_type mode, bool entire, const char *show);
 118
 119 static const char default_seed[] = "hexapodia as the key insight";
 120 static void *seed;
 121 static size_t seedlen;
 122 static const char *seedpath;
 123 static const char *path;
 124 static bool entireopt = false;
 125 static bool flush = false;
 126 static long long size;
 127
 128 int main(int argc, char **argv) {
 129   mode_type mode = BOTH;
 130   int n;
 131   char *ep;
 132   while((n = getopt_long(argc, argv, "+s:S:L:vcefhV", opts, 0)) >= 0) {
 133     switch(n) {
 134     case 's': seed = optarg; seedlen = strlen(optarg); break;
 135     case 'S': seedpath = optarg; break;
 136     case 'L':
 137       seedlen = strtoul(optarg,&ep,0);
 138       if(ep==optarg || *ep) fatal(0, "bad number for -S");
 139       break;
 140     case 'b': mode = BOTH; break;
 141     case 'v': mode = VERIFY; break;
 142     case 'c': mode = CREATE; break;
 143     case 'e': entireopt = true; break;
 144     case 'f': flush = true; break;
 145     case 'h': help(); exit(0);
 146     case 'V': puts(VERSION); exit(0);
 147     default:
 148       fatal(0, "unknown option");
 149     }
 150   }
 151   argc -= optind;
 152   argv += optind;
 153   if(argc > 2)
 154     fatal(0, "excess arguments");
 155   if(argc == 1 && mode == BOTH)
 156     entireopt = true;
 157   if(entireopt) {
 158     if(argc != 1)
 159       fatal(0, "with --entire, size should not be specified");
 160   } else {
 161     if(argc < (mode == VERIFY ? 1 : 2))
 162       fatal(0, "insufficient arguments");
 163   }
 164   if(seed && seedpath)
 165     fatal(0, "both --seed and --seed-file specified");
 166   if(seedpath) {
 167     if(!seedlen)
 168       seedlen = DEFAULT_SEED_LENGTH;
 169     FILE *seedfile = fopen(seedpath, "rb");
 170     if(!seedfile)
 171       fatal(errno, "%s", seedpath);
 172     seed = malloc(seedlen);
 173     if(!seed)
 174       fatal(errno, "allocate seed");
 175     seedlen = fread(seed, 1, seedlen, seedfile);
 176     if(ferror(seedfile))
 177       fatal(errno, "read %s", seedpath);
 178     fclose(seedfile);
 179   }
 180   if (!seed) {
 181     seed = (void*)default_seed;
 182     seedlen = sizeof(default_seed)-1;
 183   }
 184   path = argv[0];
 185   if(argc > 1) {
 186     errno = 0;
 187     char *end;
 188     size = strtoll(argv[1], &end, 10);
 189     if(errno)
 190       fatal(errno, "invalid size");
 191     if(end == argv[1])
 192       fatal(0, "invalid size");
 193     if(!strcmp(end, "K"))
 194       size *= 1024;
 195     else if(!strcmp(end, "M"))
 196       size *= 1024 * 1024;
 197     else if(!strcmp(end, "G"))
 198       size *= 1024 * 1024 * 1024;
 199     else if(*end)
 200       fatal(0, "invalid size");
 201   } else if(entireopt) {
 202     size = LONG_LONG_MAX;
 203   } else {
 204     struct stat sb;
 205     if(stat(path, &sb) < 0)
 206       fatal(errno, "stat %s", path);
 207     size = sb.st_size;
 208   }
 209   const char *show = entireopt ? (mode == CREATE ? "written" : "verified") : 0;
 210   if(mode == BOTH) {
 211     size = execute(CREATE, entireopt, 0);
 212     execute(VERIFY, false, show);
 213   } else {
 214     execute(mode, entireopt, show);
 215   }
 216   return 0;
 217 }
 218
 219 static long long execute(mode_type mode, bool entire, const char *show) {
 220   Arcfour rng((const char*)seed, seedlen);
 221   FILE *fp = fopen(path, mode == VERIFY ? "rb" : "wb");
 222   if(!fp)
 223     fatal(errno, "%s", path);
 224   if(mode == VERIFY && flush)
 225     flushCache(fp);
 226   if(mode == CREATE && entire)
 227     setvbuf(fp, 0, _IONBF, 0);
 228   char generated[4096], input[4096];
 229   long long remain = size;
 230   static const size_t rc4drop = 3072; // en.wikipedia.org/wiki/RC4#Security
 231   assert(rc4drop <= sizeof(generated));
 232   rng.stream(generated, rc4drop);
 233   while(remain > 0) {
 234     size_t bytesGenerated = (remain > (ssize_t)sizeof generated
 235                              ? sizeof generated
 236                              : remain);
 237     rng.stream(generated, bytesGenerated);
 238     if(mode == CREATE) {
 239       size_t bytesWritten = fwrite(generated, 1, bytesGenerated, fp);
 240       if(ferror(fp)) {
 241         if(!entire || errno != ENOSPC)
 242           fatal(errno, "%s", path);
 243         remain -= bytesWritten;
 244         break;
 245       }
 246       assert(bytesWritten == bytesGenerated);
 247     } else {
 248       size_t bytesRead = fread(input, 1, bytesGenerated, fp);
 249       if(ferror(fp))
 250         fatal(errno, "%s", path);
 251       if(memcmp(generated, input, bytesRead)) {
 252         for(size_t n = 0; n < bytesRead; ++n)
 253           if(generated[n] != input[n])
 254             fatal(0, "%s corrupted at %lld/%lld bytes (expected %d got %d)",
 255                     path, size - remain + n, size,
 256                     (unsigned char)generated[n], (unsigned char)input[n]);
 257       }
 258       if(bytesRead < bytesGenerated) {
 259         if(entire) {
 260           assert(feof(fp));
 261           remain -= bytesRead;
 262           break;
 263         }
 264         fatal(0, "%s: truncated at %lld/%lld bytes",
 265                 path, (size - remain + bytesRead), size);
 266       }
 267     }
 268     remain -= bytesGenerated;
 269   }
 270   if(mode == VERIFY && !entire && getc(fp) != EOF)
 271     fatal(0, "%s: extended beyond %lld bytes",
 272             path, size);
 273   if(mode == CREATE && flush) {
 274     if(fflush(fp) < 0)
 275       fatal(errno, "%s", path);
 276     flushCache(fp);
 277   }
 278   if(fclose(fp) < 0)
 279     fatal(errno, "%s", path);
 280   long long done = size - remain;
 281   if(show) {
 282     printf("%lld bytes (%lldM, %lldG) %s\n",
 283            done, done >> 20, done >> 30,
 284            show);
 285     if(ferror(stdout) || fflush(stdout))
 286       fatal(errno, "flush stdout");
 287   }
 288   return done;
 289 }