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