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