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