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