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