log.c

   1 /*
   2  * Code related to writing an iolog of what a thread is doing, and to
   3  * later read that back and replay
   4  */
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <assert.h>
   8 #include "list.h"
   9 #include "fio.h"
  10
  11 static const char iolog_ver2[] = "fio version 2 iolog";
  12
  13 void log_io_u(struct thread_data *td, struct io_u *io_u)
  14 {
  15         const char *act[] = { "read", "write", "sync" };
  16
  17         assert(io_u->ddir < 3);
  18
  19         if (!td->o.write_iolog_file)
  20                 return;
  21
  22         fprintf(td->iolog_f, "%s %s %llu %lu\n", io_u->file->file_name,
  23                                                 act[io_u->ddir], io_u->offset,
  24                                                 io_u->buflen);
  25 }
  26
  27 void log_file(struct thread_data *td, struct fio_file *f,
  28               enum file_log_act what)
  29 {
  30         const char *act[] = { "add", "open", "close" };
  31
  32         assert(what < 3);
  33
  34         if (!td->o.write_iolog_file)
  35                 return;
  36
  37         fprintf(td->iolog_f, "%s %s\n", f->file_name, act[what]);
  38 }
  39
  40 static void iolog_delay(struct thread_data *td, unsigned long delay)
  41 {
  42         unsigned long usec = utime_since_now(&td->last_issue);
  43
  44         if (delay < usec)
  45                 return;
  46
  47         delay -= usec;
  48
  49         /*
  50          * less than 100 usec delay, just regard it as noise
  51          */
  52         if (delay < 100)
  53                 return;
  54
  55         usec_sleep(td, delay);
  56 }
  57
  58 int read_iolog_get(struct thread_data *td, struct io_u *io_u)
  59 {
  60         struct io_piece *ipo;
  61
  62         while (!list_empty(&td->io_log_list)) {
  63                 ipo = list_entry(td->io_log_list.next, struct io_piece, list);
  64                 list_del(&ipo->list);
  65
  66                 /*
  67                  * invalid ddir, this is a file action
  68                  */
  69                 if (ipo->ddir == DDIR_INVAL) {
  70                         struct fio_file *f = td->files[ipo->fileno];
  71
  72                         if (ipo->file_action == FIO_LOG_OPEN_FILE) {
  73                                 assert(!td_io_open_file(td, f));
  74                                 free(ipo);
  75                                 continue;
  76                         } else if (ipo->file_action == FIO_LOG_CLOSE_FILE) {
  77                                 td_io_close_file(td, f);
  78                                 free(ipo);
  79                                 continue;
  80                         }
  81                 }
  82
  83                 io_u->offset = ipo->offset;
  84                 io_u->buflen = ipo->len;
  85                 io_u->ddir = ipo->ddir;
  86                 io_u->file = td->files[ipo->fileno];
  87                 get_file(io_u->file);
  88
  89                 dprint(FD_IO, "iolog: get %llu/%lu/%s\n", io_u->offset,
  90                                         io_u->buflen, io_u->file->file_name);
  91
  92                 if (ipo->delay)
  93                         iolog_delay(td, ipo->delay);
  94
  95                 free(ipo);
  96                 return 0;
  97         }
  98
  99         td->done = 1;
 100         return 1;
 101 }
 102
 103 void prune_io_piece_log(struct thread_data *td)
 104 {
 105         struct io_piece *ipo;
 106         struct rb_node *n;
 107
 108         while ((n = rb_first(&td->io_hist_tree)) != NULL) {
 109                 ipo = rb_entry(n, struct io_piece, rb_node);
 110                 rb_erase(n, &td->io_hist_tree);
 111                 free(ipo);
 112         }
 113
 114         while (!list_empty(&td->io_hist_list)) {
 115                 ipo = list_entry(td->io_hist_list.next, struct io_piece, list);
 116                 list_del(&ipo->list);
 117                 free(ipo);
 118         }
 119 }
 120
 121 /*
 122  * log a successful write, so we can unwind the log for verify
 123  */
 124 void log_io_piece(struct thread_data *td, struct io_u *io_u)
 125 {
 126         struct rb_node **p, *parent;
 127         struct io_piece *ipo, *__ipo;
 128
 129         ipo = malloc(sizeof(struct io_piece));
 130         ipo->file = io_u->file;
 131         ipo->offset = io_u->offset;
 132         ipo->len = io_u->buflen;
 133
 134         /*
 135          * We don't need to sort the entries, if:
 136          *
 137          *      Sequential writes, or
 138          *      Random writes that lay out the file as it goes along
 139          *
 140          * For both these cases, just reading back data in the order we
 141          * wrote it out is the fastest.
 142          */
 143         if (!td_random(td) || !td->o.overwrite) {
 144                 INIT_LIST_HEAD(&ipo->list);
 145                 list_add_tail(&ipo->list, &td->io_hist_list);
 146                 return;
 147         }
 148
 149         RB_CLEAR_NODE(&ipo->rb_node);
 150         p = &td->io_hist_tree.rb_node;
 151         parent = NULL;
 152
 153         /*
 154          * Sort the entry into the verification list
 155          */
 156         while (*p) {
 157                 parent = *p;
 158
 159                 __ipo = rb_entry(parent, struct io_piece, rb_node);
 160                 if (ipo->offset <= __ipo->offset)
 161                         p = &(*p)->rb_left;
 162                 else
 163                         p = &(*p)->rb_right;
 164         }
 165
 166         rb_link_node(&ipo->rb_node, parent, p);
 167         rb_insert_color(&ipo->rb_node, &td->io_hist_tree);
 168 }
 169
 170 void write_iolog_close(struct thread_data *td)
 171 {
 172         fflush(td->iolog_f);
 173         fclose(td->iolog_f);
 174         free(td->iolog_buf);
 175         td->iolog_f = NULL;
 176         td->iolog_buf = NULL;
 177 }
 178
 179 /*
 180  * Read version 2 iolog data. It is enhanced to include per-file logging,
 181  * syncs, etc.
 182  */
 183 static int read_iolog2(struct thread_data *td, FILE *f)
 184 {
 185         unsigned long long offset;
 186         unsigned int bytes;
 187         int reads, writes, fileno = 0, file_action = 0; /* stupid gcc */
 188         char *fname, *act;
 189         char *str, *p;
 190         enum fio_ddir rw;
 191
 192         free_release_files(td);
 193
 194         /*
 195          * Read in the read iolog and store it, reuse the infrastructure
 196          * for doing verifications.
 197          */
 198         str = malloc(4096);
 199         fname = malloc(256+16);
 200         act = malloc(256+16);
 201
 202         reads = writes = 0;
 203         while ((p = fgets(str, 4096, f)) != NULL) {
 204                 struct io_piece *ipo;
 205                 int r;
 206
 207                 r = sscanf(p, "%256s %256s %llu %u", fname, act, &offset,
 208                                                                         &bytes);
 209                 if (r == 4) {
 210                         /*
 211                          * Check action first
 212                          */
 213                         if (!strcmp(act, "read"))
 214                                 rw = DDIR_READ;
 215                         else if (!strcmp(act, "write"))
 216                                 rw = DDIR_WRITE;
 217                         else if (!strcmp(act, "sync"))
 218                                 rw = DDIR_SYNC;
 219                         else {
 220                                 log_err("fio: bad iolog file action: %s\n",
 221                                                                         act);
 222                                 continue;
 223                         }
 224                 } else if (r == 2) {
 225                         rw = DDIR_INVAL;
 226                         if (!strcmp(act, "add")) {
 227                                 td->o.nr_files++;
 228                                 fileno = add_file(td, fname);
 229                                 file_action = FIO_LOG_ADD_FILE;
 230                                 continue;
 231                         } else if (!strcmp(act, "open")) {
 232                                 fileno = get_fileno(td, fname);
 233                                 file_action = FIO_LOG_OPEN_FILE;
 234                         } else if (!strcmp(act, "close")) {
 235                                 fileno = get_fileno(td, fname);
 236                                 file_action = FIO_LOG_CLOSE_FILE;
 237                         } else {
 238                                 log_err("fio: bad iolog file action: %s\n",
 239                                                                         act);
 240                                 continue;
 241                         }
 242                 } else {
 243                         log_err("bad iolog2: %s", p);
 244                         continue;
 245                 }
 246
 247                 if (rw == DDIR_READ)
 248                         reads++;
 249                 else if (rw == DDIR_WRITE) {
 250                         writes++;
 251                         /*
 252                          * Don't add a write for ro mode
 253                          */
 254                         if (read_only)
 255                                 continue;
 256                 } else if (rw != DDIR_SYNC && rw != DDIR_INVAL) {
 257                         log_err("bad ddir: %d\n", rw);
 258                         continue;
 259                 }
 260
 261                 /*
 262                  * Make note of file
 263                  */
 264                 ipo = malloc(sizeof(*ipo));
 265                 memset(ipo, 0, sizeof(*ipo));
 266                 INIT_LIST_HEAD(&ipo->list);
 267                 ipo->offset = offset;
 268                 ipo->len = bytes;
 269                 ipo->ddir = rw;
 270                 if (bytes > td->o.max_bs[rw])
 271                         td->o.max_bs[rw] = bytes;
 272                 if (rw == DDIR_INVAL) {
 273                         ipo->fileno = fileno;
 274                         ipo->file_action = file_action;
 275                 }
 276                 list_add_tail(&ipo->list, &td->io_log_list);
 277                 td->total_io_size += bytes;
 278         }
 279
 280         free(str);
 281         free(act);
 282         free(fname);
 283
 284         if (writes && read_only) {
 285                 log_err("fio: <%s> skips replay of %d writes due to"
 286                         " read-only\n", td->o.name, writes);
 287                 writes = 0;
 288         }
 289
 290         if (!reads && !writes)
 291                 return 1;
 292         else if (reads && !writes)
 293                 td->o.td_ddir = TD_DDIR_READ;
 294         else if (!reads && writes)
 295                 td->o.td_ddir = TD_DDIR_WRITE;
 296         else
 297                 td->o.td_ddir = TD_DDIR_RW;
 298
 299         return 0;
 300 }
 301
 302 /*
 303  * Read version 1 iolog data.
 304  */
 305 static int read_iolog(struct thread_data *td, FILE *f)
 306 {
 307         unsigned long long offset;
 308         unsigned int bytes;
 309         char *str, *p;
 310         int reads, writes;
 311         int rw;
 312
 313         /*
 314          * Read in the read iolog and store it, reuse the infrastructure
 315          * for doing verifications.
 316          */
 317         str = malloc(4096);
 318         reads = writes = 0;
 319         while ((p = fgets(str, 4096, f)) != NULL) {
 320                 struct io_piece *ipo;
 321
 322                 if (sscanf(p, "%d,%llu,%u", &rw, &offset, &bytes) != 3) {
 323                         log_err("bad iolog: %s\n", p);
 324                         continue;
 325                 }
 326                 if (rw == DDIR_READ)
 327                         reads++;
 328                 else if (rw == DDIR_WRITE) {
 329                         writes++;
 330                         /*
 331                          * Don't add a write for ro mode
 332                          */
 333                         if (read_only)
 334                                 continue;
 335                 } else if (rw != DDIR_SYNC) {
 336                         log_err("bad ddir: %d\n", rw);
 337                         continue;
 338                 }
 339
 340                 ipo = malloc(sizeof(*ipo));
 341                 memset(ipo, 0, sizeof(*ipo));
 342                 INIT_LIST_HEAD(&ipo->list);
 343                 ipo->offset = offset;
 344                 ipo->len = bytes;
 345                 ipo->ddir = (enum fio_ddir) rw;
 346                 if (bytes > td->o.max_bs[rw])
 347                         td->o.max_bs[rw] = bytes;
 348                 list_add_tail(&ipo->list, &td->io_log_list);
 349                 td->total_io_size += bytes;
 350         }
 351
 352         free(str);
 353
 354         if (writes && read_only) {
 355                 log_err("fio: <%s> skips replay of %d writes due to"
 356                         " read-only\n", td->o.name, writes);
 357                 writes = 0;
 358         }
 359
 360         if (!reads && !writes)
 361                 return 1;
 362         else if (reads && !writes)
 363                 td->o.td_ddir = TD_DDIR_READ;
 364         else if (!reads && writes)
 365                 td->o.td_ddir = TD_DDIR_WRITE;
 366         else
 367                 td->o.td_ddir = TD_DDIR_RW;
 368
 369         return 0;
 370 }
 371
 372 /*
 373  * open iolog, check version, and call appropriate parser
 374  */
 375 static int init_iolog_read(struct thread_data *td)
 376 {
 377         char buffer[256], *p;
 378         FILE *f;
 379         int ret;
 380
 381         f = fopen(td->o.read_iolog_file, "r");
 382         if (!f) {
 383                 perror("fopen read iolog");
 384                 return 1;
 385         }
 386
 387         p = fgets(buffer, sizeof(buffer), f);
 388         if (!p) {
 389                 td_verror(td, errno, "iolog read");
 390                 log_err("fio: unable to read iolog\n");
 391                 return 1;
 392         }
 393
 394         /*
 395          * version 2 of the iolog stores a specific string as the
 396          * first line, check for that
 397          */
 398         if (!strncmp(iolog_ver2, buffer, strlen(iolog_ver2)))
 399                 ret = read_iolog2(td, f);
 400         else {
 401                 /*
 402                  * seek back to the beginning
 403                  */
 404                 if (fseek(f, 0, SEEK_SET) < 0) {
 405                         td_verror(td, errno, "iolog read");
 406                         log_err("fio: unable to read iolog\n");
 407                         return 1;
 408                 }
 409
 410                 ret = read_iolog(td, f);
 411         }
 412
 413         fclose(f);
 414         return ret;
 415 }
 416
 417 /*
 418  * Setup a log for storing io patterns.
 419  */
 420 static int init_iolog_write(struct thread_data *td)
 421 {
 422         struct fio_file *ff;
 423         FILE *f;
 424         unsigned int i;
 425
 426         f = fopen(td->o.write_iolog_file, "w+");
 427         if (!f) {
 428                 perror("fopen write iolog");
 429                 return 1;
 430         }
 431
 432         /*
 433          * That's it for writing, setup a log buffer and we're done.
 434           */
 435         td->iolog_f = f;
 436         td->iolog_buf = malloc(8192);
 437         setvbuf(f, td->iolog_buf, _IOFBF, 8192);
 438
 439         /*
 440          * write our version line
 441          */
 442         if (fprintf(f, "%s\n", iolog_ver2) < 0) {
 443                 perror("iolog init\n");
 444                 return 1;
 445         }
 446
 447         /*
 448          * add all known files
 449          */
 450         for_each_file(td, ff, i)
 451                 log_file(td, ff, FIO_LOG_ADD_FILE);
 452
 453         return 0;
 454 }
 455
 456 int init_iolog(struct thread_data *td)
 457 {
 458         int ret = 0;
 459
 460         if (td->io_ops->flags & FIO_DISKLESSIO)
 461                 return 0;
 462
 463         if (td->o.read_iolog_file) {
 464                 /*
 465                  * Check if it's a blktrace file and load that if possible.
 466                  * Otherwise assume it's a normal log file and load that.
 467                  */
 468                 if (is_blktrace(td->o.read_iolog_file))
 469                         ret = load_blktrace(td, td->o.read_iolog_file);
 470                 else
 471                         ret = init_iolog_read(td);
 472         } else if (td->o.write_iolog_file)
 473                 ret = init_iolog_write(td);
 474
 475         return ret;
 476 }
 477
 478 void setup_log(struct io_log **log)
 479 {
 480         struct io_log *l = malloc(sizeof(*l));
 481
 482         l->nr_samples = 0;
 483         l->max_samples = 1024;
 484         l->log = malloc(l->max_samples * sizeof(struct io_sample));
 485         *log = l;
 486 }
 487
 488 void __finish_log(struct io_log *log, const char *name)
 489 {
 490         unsigned int i;
 491         FILE *f;
 492
 493         f = fopen(name, "w");
 494         if (!f) {
 495                 perror("fopen log");
 496                 return;
 497         }
 498
 499         for (i = 0; i < log->nr_samples; i++) {
 500                 fprintf(f, "%lu, %lu, %u\n", log->log[i].time, log->log[i].val,
 501                                                 log->log[i].ddir);
 502         }
 503
 504         fclose(f);
 505         free(log->log);
 506         free(log);
 507 }
 508
 509 void finish_log(struct thread_data *td, struct io_log *log, const char *name)
 510 {
 511         char file_name[256];
 512
 513         snprintf(file_name, 200, "client%d_%s.log", td->thread_number, name);
 514         __finish_log(log, file_name);
 515 }