Merge branch 'master' of https://github.com/celestinechen/fio
[fio.git] / iolog.c
CommitLineData
ac9b9101
JA
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>
ac9b9101 7#include <assert.h>
b26317c9
JA
8#include <sys/types.h>
9#include <sys/stat.h>
10#include <unistd.h>
aee2ab67
JA
11#ifdef CONFIG_ZLIB
12#include <zlib.h>
13#endif
14
ac9b9101
JA
15#include "flist.h"
16#include "fio.h"
ac9b9101 17#include "trim.h"
243bfe19 18#include "filelock.h"
a47591e4 19#include "smalloc.h"
a3e59412 20#include "blktrace.h"
ae626d4e 21#include "pshared.h"
b5aba537 22#include "lib/roundup.h"
ac9b9101 23
2f8f4821
AK
24#include <netinet/in.h>
25#include <netinet/tcp.h>
26#include <arpa/inet.h>
27#include <sys/stat.h>
28#include <sys/socket.h>
29#include <sys/un.h>
30
7e419452
JA
31static int iolog_flush(struct io_log *log);
32
ac9b9101 33static const char iolog_ver2[] = "fio version 2 iolog";
315bbf01 34static const char iolog_ver3[] = "fio version 3 iolog";
ac9b9101
JA
35
36void queue_io_piece(struct thread_data *td, struct io_piece *ipo)
37{
38 flist_add_tail(&ipo->list, &td->io_log_list);
39 td->total_io_size += ipo->len;
40}
41
1f440ece 42void log_io_u(const struct thread_data *td, const struct io_u *io_u)
ac9b9101 43{
e8cf24e5
MG
44 struct timespec now;
45
ac9b9101
JA
46 if (!td->o.write_iolog_file)
47 return;
48
e8cf24e5 49 fio_gettime(&now, NULL);
6d01ac19
JA
50 fprintf(td->iolog_f, "%llu %s %s %llu %llu\n",
51 (unsigned long long) utime_since_now(&td->io_log_start_time),
52 io_u->file->file_name, io_ddir_name(io_u->ddir), io_u->offset,
53 io_u->buflen);
e8cf24e5 54
ac9b9101
JA
55}
56
57void log_file(struct thread_data *td, struct fio_file *f,
58 enum file_log_act what)
59{
60 const char *act[] = { "add", "open", "close" };
e8cf24e5 61 struct timespec now;
ac9b9101
JA
62
63 assert(what < 3);
64
65 if (!td->o.write_iolog_file)
66 return;
67
68
69 /*
70 * this happens on the pre-open/close done before the job starts
71 */
72 if (!td->iolog_f)
73 return;
74
e8cf24e5 75 fio_gettime(&now, NULL);
6d01ac19
JA
76 fprintf(td->iolog_f, "%llu %s %s\n",
77 (unsigned long long) utime_since_now(&td->io_log_start_time),
78 f->file_name, act[what]);
ac9b9101
JA
79}
80
81static void iolog_delay(struct thread_data *td, unsigned long delay)
82{
df8fb609 83 uint64_t usec = utime_since_now(&td->last_issue);
f4b49c55 84 unsigned long orig_delay = delay;
8b6a404c 85 struct timespec ts;
b85c01f7 86 int ret = 0;
ac9b9101 87
df8fb609
JA
88 if (delay < td->time_offset) {
89 td->time_offset = 0;
90 return;
91 }
92
93 delay -= td->time_offset;
ac9b9101
JA
94 if (delay < usec)
95 return;
96
97 delay -= usec;
98
8b6a404c 99 fio_gettime(&ts, NULL);
30b18672 100
b85c01f7
KG
101 while (delay && !td->terminate) {
102 ret = io_u_queued_complete(td, 0);
103 if (ret < 0)
104 td_verror(td, -ret, "io_u_queued_complete");
c3c398e0
SK
105 if (td->flags & TD_F_REGROW_LOGS)
106 regrow_logs(td);
b85c01f7
KG
107 if (utime_since_now(&ts) > delay)
108 break;
30b18672 109 }
df8fb609 110
8b6a404c 111 usec = utime_since_now(&ts);
f4b49c55
JA
112 if (usec > orig_delay)
113 td->time_offset = usec - orig_delay;
df8fb609
JA
114 else
115 td->time_offset = 0;
ac9b9101
JA
116}
117
118static int ipo_special(struct thread_data *td, struct io_piece *ipo)
119{
120 struct fio_file *f;
121 int ret;
122
123 /*
124 * Not a special ipo
125 */
126 if (ipo->ddir != DDIR_INVAL)
127 return 0;
128
129 f = td->files[ipo->fileno];
130
315bbf01
MG
131 if (ipo->delay)
132 iolog_delay(td, ipo->delay);
133 if (fio_fill_issue_time(td))
134 fio_gettime(&td->last_issue, NULL);
ac9b9101
JA
135 switch (ipo->file_action) {
136 case FIO_LOG_OPEN_FILE:
96d663ad
SW
137 if (td->o.replay_redirect && fio_file_open(f)) {
138 dprint(FD_FILE, "iolog: ignoring re-open of file %s\n",
139 f->file_name);
140 break;
141 }
ac9b9101
JA
142 ret = td_io_open_file(td, f);
143 if (!ret)
144 break;
145 td_verror(td, ret, "iolog open file");
146 return -1;
147 case FIO_LOG_CLOSE_FILE:
148 td_io_close_file(td, f);
149 break;
150 case FIO_LOG_UNLINK_FILE:
38ef9c90 151 td_io_unlink_file(td, f);
ac9b9101 152 break;
315bbf01
MG
153 case FIO_LOG_ADD_FILE:
154 /*
155 * Nothing to do
156 */
157 break;
ac9b9101
JA
158 default:
159 log_err("fio: bad file action %d\n", ipo->file_action);
160 break;
161 }
162
163 return 1;
164}
165
315bbf01
MG
166static bool read_iolog(struct thread_data *td);
167
168unsigned long long delay_since_ttime(const struct thread_data *td,
169 unsigned long long time)
170{
171 double tmp;
172 double scale;
173 const unsigned long long *last_ttime = &td->io_log_last_ttime;
174
175 if (!*last_ttime || td->o.no_stall || time < *last_ttime)
176 return 0;
177 else if (td->o.replay_time_scale == 100)
178 return time - *last_ttime;
179
180
181 scale = (double) 100.0 / (double) td->o.replay_time_scale;
182 tmp = time - *last_ttime;
183 return tmp * scale;
184}
98e7161c 185
ac9b9101
JA
186int read_iolog_get(struct thread_data *td, struct io_u *io_u)
187{
188 struct io_piece *ipo;
189 unsigned long elapsed;
3c3ed070 190
ac9b9101
JA
191 while (!flist_empty(&td->io_log_list)) {
192 int ret;
b61fdc8a 193
10f74940 194 if (td->o.read_iolog_chunked) {
98e7161c 195 if (td->io_log_checkmark == td->io_log_current) {
10f74940
LS
196 if (td->io_log_blktrace) {
197 if (!read_blktrace(td))
198 return 1;
199 } else {
315bbf01 200 if (!read_iolog(td))
10f74940
LS
201 return 1;
202 }
98e7161c
AK
203 }
204 td->io_log_current--;
205 }
9342d5f8 206 ipo = flist_first_entry(&td->io_log_list, struct io_piece, list);
ac9b9101
JA
207 flist_del(&ipo->list);
208 remove_trim_entry(td, ipo);
209
210 ret = ipo_special(td, ipo);
211 if (ret < 0) {
212 free(ipo);
213 break;
214 } else if (ret > 0) {
215 free(ipo);
216 continue;
217 }
218
219 io_u->ddir = ipo->ddir;
220 if (ipo->ddir != DDIR_WAIT) {
221 io_u->offset = ipo->offset;
4fff54cc 222 io_u->verify_offset = ipo->offset;
ac9b9101
JA
223 io_u->buflen = ipo->len;
224 io_u->file = td->files[ipo->fileno];
225 get_file(io_u->file);
5fff9543 226 dprint(FD_IO, "iolog: get %llu/%llu/%s\n", io_u->offset,
ac9b9101
JA
227 io_u->buflen, io_u->file->file_name);
228 if (ipo->delay)
229 iolog_delay(td, ipo->delay);
230 } else {
231 elapsed = mtime_since_genesis();
232 if (ipo->delay > elapsed)
233 usec_sleep(td, (ipo->delay - elapsed) * 1000);
ac9b9101
JA
234 }
235
236 free(ipo);
3c3ed070 237
ac9b9101
JA
238 if (io_u->ddir != DDIR_WAIT)
239 return 0;
240 }
241
242 td->done = 1;
243 return 1;
244}
245
246void prune_io_piece_log(struct thread_data *td)
247{
248 struct io_piece *ipo;
e96c0125 249 struct fio_rb_node *n;
ac9b9101
JA
250
251 while ((n = rb_first(&td->io_hist_tree)) != NULL) {
252 ipo = rb_entry(n, struct io_piece, rb_node);
253 rb_erase(n, &td->io_hist_tree);
254 remove_trim_entry(td, ipo);
255 td->io_hist_len--;
256 free(ipo);
257 }
258
259 while (!flist_empty(&td->io_hist_list)) {
4e1020f8 260 ipo = flist_first_entry(&td->io_hist_list, struct io_piece, list);
ac9b9101
JA
261 flist_del(&ipo->list);
262 remove_trim_entry(td, ipo);
263 td->io_hist_len--;
264 free(ipo);
265 }
266}
267
268/*
269 * log a successful write, so we can unwind the log for verify
270 */
271void log_io_piece(struct thread_data *td, struct io_u *io_u)
272{
e96c0125 273 struct fio_rb_node **p, *parent;
ac9b9101
JA
274 struct io_piece *ipo, *__ipo;
275
8812d7f2 276 ipo = calloc(1, sizeof(struct io_piece));
ac9b9101
JA
277 init_ipo(ipo);
278 ipo->file = io_u->file;
279 ipo->offset = io_u->offset;
280 ipo->len = io_u->buflen;
da0a7bd2 281 ipo->numberio = io_u->numberio;
f9401285
JA
282 ipo->flags = IP_F_IN_FLIGHT;
283
284 io_u->ipo = ipo;
ac9b9101
JA
285
286 if (io_u_should_trim(td, io_u)) {
287 flist_add_tail(&ipo->trim_list, &td->trim_list);
288 td->trim_entries++;
289 }
290
291 /*
e43f210a 292 * Only sort writes if we don't have a random map in which case we need
4a06cb41
SW
293 * to check for duplicate blocks and drop the old one, which we rely on
294 * the rb insert/lookup for handling.
ac9b9101 295 */
f31feaa2 296 if (file_randommap(td, ipo->file)) {
ac9b9101
JA
297 INIT_FLIST_HEAD(&ipo->list);
298 flist_add_tail(&ipo->list, &td->io_hist_list);
299 ipo->flags |= IP_F_ONLIST;
300 td->io_hist_len++;
301 return;
302 }
303
304 RB_CLEAR_NODE(&ipo->rb_node);
305
306 /*
307 * Sort the entry into the verification list
308 */
309restart:
310 p = &td->io_hist_tree.rb_node;
311 parent = NULL;
312 while (*p) {
3b1ff869 313 int overlap = 0;
ac9b9101
JA
314 parent = *p;
315
316 __ipo = rb_entry(parent, struct io_piece, rb_node);
317 if (ipo->file < __ipo->file)
318 p = &(*p)->rb_left;
319 else if (ipo->file > __ipo->file)
320 p = &(*p)->rb_right;
3b1ff869 321 else if (ipo->offset < __ipo->offset) {
ac9b9101 322 p = &(*p)->rb_left;
3b1ff869
JE
323 overlap = ipo->offset + ipo->len > __ipo->offset;
324 }
325 else if (ipo->offset > __ipo->offset) {
ac9b9101 326 p = &(*p)->rb_right;
3b1ff869
JE
327 overlap = __ipo->offset + __ipo->len > ipo->offset;
328 }
329 else
330 overlap = 1;
331
332 if (overlap) {
7abe6a27 333 dprint(FD_IO, "iolog: overlap %llu/%lu, %llu/%lu\n",
885ac623
JA
334 __ipo->offset, __ipo->len,
335 ipo->offset, ipo->len);
ac9b9101
JA
336 td->io_hist_len--;
337 rb_erase(parent, &td->io_hist_tree);
338 remove_trim_entry(td, __ipo);
e8b74655
SW
339 if (!(__ipo->flags & IP_F_IN_FLIGHT))
340 free(__ipo);
ac9b9101
JA
341 goto restart;
342 }
343 }
344
345 rb_link_node(&ipo->rb_node, parent, p);
346 rb_insert_color(&ipo->rb_node, &td->io_hist_tree);
347 ipo->flags |= IP_F_ONRB;
348 td->io_hist_len++;
349}
350
890b6656
JA
351void unlog_io_piece(struct thread_data *td, struct io_u *io_u)
352{
353 struct io_piece *ipo = io_u->ipo;
354
66347cfa
DE
355 if (td->ts.nr_block_infos) {
356 uint32_t *info = io_u_block_info(td, io_u);
357 if (BLOCK_INFO_STATE(*info) < BLOCK_STATE_TRIM_FAILURE) {
358 if (io_u->ddir == DDIR_TRIM)
359 *info = BLOCK_INFO_SET_STATE(*info,
360 BLOCK_STATE_TRIM_FAILURE);
361 else if (io_u->ddir == DDIR_WRITE)
362 *info = BLOCK_INFO_SET_STATE(*info,
363 BLOCK_STATE_WRITE_FAILURE);
364 }
365 }
366
890b6656
JA
367 if (!ipo)
368 return;
369
370 if (ipo->flags & IP_F_ONRB)
371 rb_erase(&ipo->rb_node, &td->io_hist_tree);
372 else if (ipo->flags & IP_F_ONLIST)
373 flist_del(&ipo->list);
374
375 free(ipo);
376 io_u->ipo = NULL;
377 td->io_hist_len--;
378}
379
94a78d52 380void trim_io_piece(const struct io_u *io_u)
890b6656
JA
381{
382 struct io_piece *ipo = io_u->ipo;
383
384 if (!ipo)
385 return;
386
387 ipo->len = io_u->xfer_buflen - io_u->resid;
388}
389
ac9b9101
JA
390void write_iolog_close(struct thread_data *td)
391{
d087d28f
DLM
392 if (!td->iolog_f)
393 return;
394
ac9b9101
JA
395 fflush(td->iolog_f);
396 fclose(td->iolog_f);
397 free(td->iolog_buf);
398 td->iolog_f = NULL;
399 td->iolog_buf = NULL;
400}
401
a21ed2b5 402int64_t iolog_items_to_fetch(struct thread_data *td)
1d73ff2a
JA
403{
404 struct timespec now;
405 uint64_t elapsed;
406 uint64_t for_1s;
407 int64_t items_to_fetch;
408
409 if (!td->io_log_highmark)
410 return 10;
411
412
413 fio_gettime(&now, NULL);
414 elapsed = ntime_since(&td->io_log_highmark_time, &now);
415 if (elapsed) {
416 for_1s = (td->io_log_highmark - td->io_log_current) * 1000000000 / elapsed;
417 items_to_fetch = for_1s - td->io_log_current;
418 if (items_to_fetch < 0)
419 items_to_fetch = 0;
420 } else
421 items_to_fetch = 0;
422
423 td->io_log_highmark = td->io_log_current + items_to_fetch;
424 td->io_log_checkmark = (td->io_log_highmark + 1) / 2;
425 fio_gettime(&td->io_log_highmark_time, NULL);
426
427 return items_to_fetch;
428}
429
315bbf01
MG
430#define io_act(_td, _r) (((_td)->io_log_version == 3 && (r) == 5) || \
431 ((_td)->io_log_version == 2 && (r) == 4))
432#define file_act(_td, _r) (((_td)->io_log_version == 3 && (r) == 3) || \
433 ((_td)->io_log_version == 2 && (r) == 2))
434
ac9b9101 435/*
315bbf01 436 * Read version 2 and 3 iolog data. It is enhanced to include per-file logging,
ac9b9101
JA
437 * syncs, etc.
438 */
315bbf01 439static bool read_iolog(struct thread_data *td)
ac9b9101
JA
440{
441 unsigned long long offset;
442 unsigned int bytes;
315bbf01 443 unsigned long long delay = 0;
dd6500e9 444 int reads, writes, trims, waits, fileno = 0, file_action = 0; /* stupid gcc */
dac34079 445 char *rfname, *fname, *act;
ac9b9101
JA
446 char *str, *p;
447 enum fio_ddir rw;
71e6e5a2 448 bool realloc = false;
98e7161c 449 int64_t items_to_fetch = 0;
78c0d7a0 450 int syncs;
ac9b9101 451
98e7161c 452 if (td->o.read_iolog_chunked) {
1d73ff2a
JA
453 items_to_fetch = iolog_items_to_fetch(td);
454 if (!items_to_fetch)
455 return true;
98e7161c 456 }
1d73ff2a 457
ac9b9101
JA
458 /*
459 * Read in the read iolog and store it, reuse the infrastructure
460 * for doing verifications.
461 */
462 str = malloc(4096);
dac34079 463 rfname = fname = malloc(256+16);
ac9b9101
JA
464 act = malloc(256+16);
465
dd6500e9 466 syncs = reads = writes = trims = waits = 0;
98e7161c 467 while ((p = fgets(str, 4096, td->io_log_rfile)) != NULL) {
ac9b9101
JA
468 struct io_piece *ipo;
469 int r;
315bbf01 470 unsigned long long ttime;
ac9b9101 471
315bbf01
MG
472 if (td->io_log_version == 3) {
473 r = sscanf(p, "%llu %256s %256s %llu %u", &ttime, rfname, act,
474 &offset, &bytes);
475 delay = delay_since_ttime(td, ttime);
476 td->io_log_last_ttime = ttime;
477 /*
478 * "wait" is not allowed with version 3
479 */
480 if (!strcmp(act, "wait")) {
481 log_err("iolog: ignoring wait command with"
482 " version 3 for file %s\n", fname);
483 continue;
484 }
485 } else /* version 2 */
486 r = sscanf(p, "%256s %256s %llu %u", rfname, act, &offset, &bytes);
dac34079
JA
487
488 if (td->o.replay_redirect)
489 fname = td->o.replay_redirect;
490
315bbf01 491 if (io_act(td, r)) {
ac9b9101
JA
492 /*
493 * Check action first
494 */
495 if (!strcmp(act, "wait"))
496 rw = DDIR_WAIT;
ff6131af
H
497 else if (!strcmp(act, "read")) {
498 if (td->o.replay_skip & (1u << DDIR_READ))
499 continue;
ac9b9101 500 rw = DDIR_READ;
ff6131af
H
501 } else if (!strcmp(act, "write")) {
502 if (td->o.replay_skip & (1u << DDIR_WRITE))
503 continue;
ac9b9101 504 rw = DDIR_WRITE;
ff6131af
H
505 } else if (!strcmp(act, "sync")) {
506 if (td->o.replay_skip & (1u << DDIR_SYNC))
507 continue;
ac9b9101 508 rw = DDIR_SYNC;
ff6131af 509 } else if (!strcmp(act, "datasync"))
ac9b9101 510 rw = DDIR_DATASYNC;
ff6131af
H
511 else if (!strcmp(act, "trim")) {
512 if (td->o.replay_skip & (1u << DDIR_TRIM))
513 continue;
ac9b9101 514 rw = DDIR_TRIM;
ff6131af 515 } else {
ac9b9101
JA
516 log_err("fio: bad iolog file action: %s\n",
517 act);
518 continue;
519 }
033ace1e 520 fileno = get_fileno(td, fname);
315bbf01 521 } else if (file_act(td, r)) {
ac9b9101
JA
522 rw = DDIR_INVAL;
523 if (!strcmp(act, "add")) {
96d663ad
SW
524 if (td->o.replay_redirect &&
525 get_fileno(td, fname) != -1) {
526 dprint(FD_FILE, "iolog: ignoring"
527 " re-add of file %s\n", fname);
528 } else {
c70c7f58 529 fileno = add_file(td, fname, td->subjob_number, 1);
96d663ad
SW
530 file_action = FIO_LOG_ADD_FILE;
531 }
ac9b9101
JA
532 } else if (!strcmp(act, "open")) {
533 fileno = get_fileno(td, fname);
534 file_action = FIO_LOG_OPEN_FILE;
535 } else if (!strcmp(act, "close")) {
536 fileno = get_fileno(td, fname);
537 file_action = FIO_LOG_CLOSE_FILE;
538 } else {
539 log_err("fio: bad iolog file action: %s\n",
540 act);
541 continue;
542 }
543 } else {
315bbf01 544 log_err("bad iolog%d: %s\n", td->io_log_version, p);
ac9b9101
JA
545 continue;
546 }
547
548 if (rw == DDIR_READ)
549 reads++;
550 else if (rw == DDIR_WRITE) {
551 /*
552 * Don't add a write for ro mode
553 */
554 if (read_only)
555 continue;
556 writes++;
dd6500e9
VF
557 } else if (rw == DDIR_TRIM) {
558 /*
559 * Don't add a trim for ro mode
560 */
561 if (read_only)
562 continue;
563 trims++;
ac9b9101 564 } else if (rw == DDIR_WAIT) {
74dff443
JA
565 if (td->o.no_stall)
566 continue;
ac9b9101
JA
567 waits++;
568 } else if (rw == DDIR_INVAL) {
78c0d7a0
JA
569 } else if (ddir_sync(rw)) {
570 syncs++;
571 } else {
ac9b9101
JA
572 log_err("bad ddir: %d\n", rw);
573 continue;
574 }
575
576 /*
577 * Make note of file
578 */
8812d7f2 579 ipo = calloc(1, sizeof(*ipo));
ac9b9101
JA
580 init_ipo(ipo);
581 ipo->ddir = rw;
315bbf01
MG
582 if (td->io_log_version == 3)
583 ipo->delay = delay;
ac9b9101
JA
584 if (rw == DDIR_WAIT) {
585 ipo->delay = offset;
586 } else {
a79f17bf
SW
587 if (td->o.replay_scale)
588 ipo->offset = offset / td->o.replay_scale;
589 else
590 ipo->offset = offset;
591 ipo_bytes_align(td->o.replay_align, ipo);
592
ac9b9101 593 ipo->len = bytes;
71e6e5a2
AK
594 if (rw != DDIR_INVAL && bytes > td->o.max_bs[rw]) {
595 realloc = true;
ac9b9101 596 td->o.max_bs[rw] = bytes;
71e6e5a2 597 }
ac9b9101
JA
598 ipo->fileno = fileno;
599 ipo->file_action = file_action;
70afff59 600 td->o.size += bytes;
ac9b9101 601 }
3c3ed070 602
ac9b9101 603 queue_io_piece(td, ipo);
98e7161c
AK
604
605 if (td->o.read_iolog_chunked) {
606 td->io_log_current++;
607 items_to_fetch--;
608 if (items_to_fetch == 0)
609 break;
610 }
ac9b9101
JA
611 }
612
613 free(str);
614 free(act);
dac34079 615 free(rfname);
ac9b9101 616
98e7161c
AK
617 if (td->o.read_iolog_chunked) {
618 td->io_log_highmark = td->io_log_current;
619 td->io_log_checkmark = (td->io_log_highmark + 1) / 2;
620 fio_gettime(&td->io_log_highmark_time, NULL);
621 }
622
ac9b9101
JA
623 if (writes && read_only) {
624 log_err("fio: <%s> skips replay of %d writes due to"
625 " read-only\n", td->o.name, writes);
626 writes = 0;
627 }
78c0d7a0
JA
628 if (syncs)
629 td->flags |= TD_F_SYNCS;
ac9b9101 630
98e7161c
AK
631 if (td->o.read_iolog_chunked) {
632 if (td->io_log_current == 0) {
633 return false;
634 }
635 td->o.td_ddir = TD_DDIR_RW;
71e6e5a2
AK
636 if (realloc && td->orig_buffer)
637 {
638 io_u_quiesce(td);
639 free_io_mem(td);
6d8fe6e8
SK
640 if (init_io_u_buffers(td))
641 return false;
71e6e5a2 642 }
98e7161c
AK
643 return true;
644 }
645
dd6500e9 646 if (!reads && !writes && !waits && !trims)
b153f94a 647 return false;
dd6500e9
VF
648
649 td->o.td_ddir = 0;
650 if (reads)
651 td->o.td_ddir |= TD_DDIR_READ;
652 if (writes)
653 td->o.td_ddir |= TD_DDIR_WRITE;
654 if (trims)
655 td->o.td_ddir |= TD_DDIR_TRIM;
ac9b9101 656
b153f94a 657 return true;
ac9b9101
JA
658}
659
2f8f4821
AK
660static bool is_socket(const char *path)
661{
662 struct stat buf;
8ea203d3
JA
663 int r;
664
665 r = stat(path, &buf);
2f8f4821
AK
666 if (r == -1)
667 return false;
668
669 return S_ISSOCK(buf.st_mode);
670}
671
672static int open_socket(const char *path)
673{
2f8f4821 674 struct sockaddr_un addr;
8ea203d3
JA
675 int ret, fd;
676
677 fd = socket(AF_UNIX, SOCK_STREAM, 0);
2f8f4821
AK
678 if (fd < 0)
679 return fd;
8ea203d3 680
2f8f4821 681 addr.sun_family = AF_UNIX;
c7d23f4b 682 if (snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", path) >=
8ea203d3 683 sizeof(addr.sun_path)) {
c7d23f4b
BVA
684 log_err("%s: path name %s is too long for a Unix socket\n",
685 __func__, path);
8ea203d3
JA
686 }
687
688 ret = connect(fd, (const struct sockaddr *)&addr, strlen(path) + sizeof(addr.sun_family));
689 if (!ret)
2f8f4821 690 return fd;
8ea203d3
JA
691
692 close(fd);
2f8f4821
AK
693 return -1;
694}
695
ac9b9101
JA
696/*
697 * open iolog, check version, and call appropriate parser
698 */
22d7fdf3 699static bool init_iolog_read(struct thread_data *td, char *fname)
ac9b9101 700{
22d7fdf3 701 char buffer[256], *p;
2f8f4821 702 FILE *f = NULL;
8ea203d3 703
c70c7f58
AK
704 dprint(FD_IO, "iolog: name=%s\n", fname);
705
706 if (is_socket(fname)) {
8ea203d3
JA
707 int fd;
708
709 fd = open_socket(fname);
710 if (fd >= 0)
2f8f4821 711 f = fdopen(fd, "r");
d19c04d1 712 } else if (!strcmp(fname, "-")) {
713 f = stdin;
2f8f4821 714 } else
c70c7f58 715 f = fopen(fname, "r");
8ea203d3 716
ac9b9101
JA
717 if (!f) {
718 perror("fopen read iolog");
b153f94a 719 return false;
ac9b9101
JA
720 }
721
722 p = fgets(buffer, sizeof(buffer), f);
723 if (!p) {
724 td_verror(td, errno, "iolog read");
725 log_err("fio: unable to read iolog\n");
726 fclose(f);
b153f94a 727 return false;
ac9b9101 728 }
8ea203d3 729
ac9b9101 730 /*
315bbf01 731 * versions 2 and 3 of the iolog store a specific string as the
ac9b9101
JA
732 * first line, check for that
733 */
315bbf01
MG
734 if (!strncmp(iolog_ver2, buffer, strlen(iolog_ver2)))
735 td->io_log_version = 2;
736 else if (!strncmp(iolog_ver3, buffer, strlen(iolog_ver3)))
737 td->io_log_version = 3;
738 else {
739 log_err("fio: iolog version 1 is no longer supported\n");
740 fclose(f);
741 return false;
ac9b9101
JA
742 }
743
315bbf01
MG
744 free_release_files(td);
745 td->io_log_rfile = f;
746 return read_iolog(td);
ac9b9101
JA
747}
748
749/*
750 * Set up a log for storing io patterns.
751 */
b153f94a 752static bool init_iolog_write(struct thread_data *td)
ac9b9101
JA
753{
754 struct fio_file *ff;
755 FILE *f;
756 unsigned int i;
757
758 f = fopen(td->o.write_iolog_file, "a");
759 if (!f) {
760 perror("fopen write iolog");
b153f94a 761 return false;
ac9b9101
JA
762 }
763
764 /*
765 * That's it for writing, setup a log buffer and we're done.
766 */
767 td->iolog_f = f;
768 td->iolog_buf = malloc(8192);
769 setvbuf(f, td->iolog_buf, _IOFBF, 8192);
e8cf24e5 770 fio_gettime(&td->io_log_start_time, NULL);
ac9b9101
JA
771
772 /*
773 * write our version line
774 */
e8cf24e5 775 if (fprintf(f, "%s\n", iolog_ver3) < 0) {
ac9b9101 776 perror("iolog init\n");
b153f94a 777 return false;
ac9b9101
JA
778 }
779
780 /*
781 * add all known files
782 */
783 for_each_file(td, ff, i)
784 log_file(td, ff, FIO_LOG_ADD_FILE);
785
b153f94a 786 return true;
ac9b9101
JA
787}
788
b153f94a 789bool init_iolog(struct thread_data *td)
ac9b9101 790{
b153f94a 791 bool ret;
ac9b9101
JA
792
793 if (td->o.read_iolog_file) {
d95b34a6 794 int need_swap;
22d7fdf3 795 char * fname = get_name_by_idx(td->o.read_iolog_file, td->subjob_number);
d95b34a6 796
ac9b9101
JA
797 /*
798 * Check if it's a blktrace file and load that if possible.
799 * Otherwise assume it's a normal log file and load that.
800 */
b61fdc8a
JA
801 if (is_blktrace(fname, &need_swap)) {
802 td->io_log_blktrace = 1;
10f74940 803 ret = init_blktrace_read(td, fname, need_swap);
b61fdc8a
JA
804 } else {
805 td->io_log_blktrace = 0;
22d7fdf3 806 ret = init_iolog_read(td, fname);
b61fdc8a 807 }
3a3e5c6e 808 free(fname);
ac9b9101
JA
809 } else if (td->o.write_iolog_file)
810 ret = init_iolog_write(td);
b153f94a 811 else
43864deb 812 ret = true;
ac9b9101 813
b153f94a 814 if (!ret)
f01b34ae
JA
815 td_verror(td, EINVAL, "failed initializing iolog");
816
c492cb1a 817 init_disk_util(td);
818
ac9b9101
JA
819 return ret;
820}
821
aee2ab67
JA
822void setup_log(struct io_log **log, struct log_params *p,
823 const char *filename)
ac9b9101 824{
e75cc8f3 825 struct io_log *l;
65a4d15c
KC
826 int i;
827 struct io_u_plat_entry *entry;
828 struct flist_head *list;
ac9b9101 829
7e419452
JA
830 l = scalloc(1, sizeof(*l));
831 INIT_FLIST_HEAD(&l->io_logs);
aee2ab67
JA
832 l->log_type = p->log_type;
833 l->log_offset = p->log_offset;
03ec570f 834 l->log_prio = p->log_prio;
aee2ab67 835 l->log_gz = p->log_gz;
b26317c9 836 l->log_gz_store = p->log_gz_store;
aee2ab67 837 l->avg_msec = p->avg_msec;
1e613c9c
KC
838 l->hist_msec = p->hist_msec;
839 l->hist_coarseness = p->hist_coarseness;
cb7e0ace 840 l->filename = strdup(filename);
aee2ab67
JA
841 l->td = p->td;
842
65a4d15c
KC
843 /* Initialize histogram lists for each r/w direction,
844 * with initial io_u_plat of all zeros:
845 */
846 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
d730bc58 847 list = &l->hist_window[i].list;
65a4d15c
KC
848 INIT_FLIST_HEAD(list);
849 entry = calloc(1, sizeof(struct io_u_plat_entry));
850 flist_add(&entry->list, list);
851 }
852
1fed2080 853 if (l->td && l->td->o.io_submit_mode != IO_MODE_OFFLOAD) {
b5aba537 854 unsigned int def_samples = DEF_LOG_ENTRIES;
a43f4461 855 struct io_logs *__p;
1fed2080 856
a43f4461 857 __p = calloc(1, sizeof(*l->pending));
b5aba537
JA
858 if (l->td->o.iodepth > DEF_LOG_ENTRIES)
859 def_samples = roundup_pow2(l->td->o.iodepth);
860 __p->max_samples = def_samples;
a43f4461
JA
861 __p->log = calloc(__p->max_samples, log_entry_sz(l));
862 l->pending = __p;
1fed2080
JA
863 }
864
b26317c9 865 if (l->log_offset)
49e98daa 866 l->log_ddir_mask = LOG_OFFSET_SAMPLE_BIT;
03ec570f
DLM
867 if (l->log_prio)
868 l->log_ddir_mask |= LOG_PRIO_SAMPLE_BIT;
acc481b6
AK
869 /*
870 * The bandwidth-log option generates agg-read_bw.log,
871 * agg-write_bw.log and agg-trim_bw.log for which l->td is NULL.
872 * Check if l->td is valid before dereferencing it.
873 */
874 if (l->td && l->td->o.log_max == IO_LOG_SAMPLE_BOTH)
0e14633c 875 l->log_ddir_mask |= LOG_AVG_MAX_SAMPLE_BIT;
b26317c9 876
aee2ab67
JA
877 INIT_FLIST_HEAD(&l->chunk_list);
878
879 if (l->log_gz && !p->td)
880 l->log_gz = 0;
19417eda 881 else if (l->log_gz || l->log_gz_store) {
34febb23 882 mutex_init_pshared(&l->chunk_lock);
858bce70 883 mutex_init_pshared(&l->deferred_free_lock);
aee2ab67
JA
884 p->td->flags |= TD_F_COMPRESS_LOG;
885 }
886
ac9b9101
JA
887 *log = l;
888}
889
2e802282
JA
890#ifdef CONFIG_SETVBUF
891static void *set_file_buffer(FILE *f)
892{
893 size_t size = 1048576;
894 void *buf;
895
896 buf = malloc(size);
897 setvbuf(f, buf, _IOFBF, size);
898 return buf;
899}
900
901static void clear_file_buffer(void *buf)
902{
903 free(buf);
904}
905#else
906static void *set_file_buffer(FILE *f)
907{
908 return NULL;
909}
910
911static void clear_file_buffer(void *buf)
912{
913}
914#endif
915
518dac09 916void free_log(struct io_log *log)
cb7e0ace 917{
7e419452
JA
918 while (!flist_empty(&log->io_logs)) {
919 struct io_logs *cur_log;
920
921 cur_log = flist_first_entry(&log->io_logs, struct io_logs, list);
922 flist_del_init(&cur_log->list);
923 free(cur_log->log);
2b7625e2 924 sfree(cur_log);
7e419452
JA
925 }
926
1fed2080
JA
927 if (log->pending) {
928 free(log->pending->log);
929 free(log->pending);
930 log->pending = NULL;
931 }
932
933 free(log->pending);
cb7e0ace 934 free(log->filename);
a47591e4 935 sfree(log);
cb7e0ace
JA
936}
937
6cc0e5aa
AL
938uint64_t hist_sum(int j, int stride, uint64_t *io_u_plat,
939 uint64_t *io_u_plat_last)
548df930 940{
6cc0e5aa 941 uint64_t sum;
f2c972cc 942 int k;
548df930 943
868f6f03
KC
944 if (io_u_plat_last) {
945 for (k = sum = 0; k < stride; k++)
946 sum += io_u_plat[j + k] - io_u_plat_last[j + k];
947 } else {
948 for (k = sum = 0; k < stride; k++)
949 sum += io_u_plat[j + k];
950 }
548df930 951
1e613c9c
KC
952 return sum;
953}
954
a89ba4b1
JA
955static void flush_hist_samples(FILE *f, int hist_coarseness, void *samples,
956 uint64_t sample_size)
1e613c9c
KC
957{
958 struct io_sample *s;
959 int log_offset;
960 uint64_t i, j, nr_samples;
65a4d15c 961 struct io_u_plat_entry *entry, *entry_before;
6cc0e5aa
AL
962 uint64_t *io_u_plat;
963 uint64_t *io_u_plat_before;
1e613c9c
KC
964
965 int stride = 1 << hist_coarseness;
966
967 if (!sample_size)
968 return;
969
970 s = __get_sample(samples, 0, 0);
971 log_offset = (s->__ddir & LOG_OFFSET_SAMPLE_BIT) != 0;
972
973 nr_samples = sample_size / __log_entry_sz(log_offset);
974
975 for (i = 0; i < nr_samples; i++) {
976 s = __get_sample(samples, log_offset, i);
d730bc58 977
af2fde19 978 entry = s->data.plat_entry;
65a4d15c 979 io_u_plat = entry->io_u_plat;
d730bc58 980
65a4d15c
KC
981 entry_before = flist_first_entry(&entry->list, struct io_u_plat_entry, list);
982 io_u_plat_before = entry_before->io_u_plat;
d730bc58 983
5fff9543
JF
984 fprintf(f, "%lu, %u, %llu, ", (unsigned long) s->time,
985 io_sample_ddir(s), (unsigned long long) s->bs);
1e613c9c 986 for (j = 0; j < FIO_IO_U_PLAT_NR - stride; j += stride) {
6cc0e5aa
AL
987 fprintf(f, "%llu, ", (unsigned long long)
988 hist_sum(j, stride, io_u_plat, io_u_plat_before));
1e613c9c 989 }
6cc0e5aa 990 fprintf(f, "%llu\n", (unsigned long long)
65a4d15c 991 hist_sum(FIO_IO_U_PLAT_NR - stride, stride, io_u_plat,
d730bc58
JA
992 io_u_plat_before));
993
65a4d15c
KC
994 flist_del(&entry_before->list);
995 free(entry_before);
1e613c9c
KC
996 }
997}
998
bead01d7 999void flush_samples(FILE *f, void *samples, uint64_t sample_size)
ac9b9101 1000{
b26317c9 1001 struct io_sample *s;
0e14633c 1002 int log_offset, log_prio, log_avg_max;
b26317c9 1003 uint64_t i, nr_samples;
03ec570f
DLM
1004 unsigned int prio_val;
1005 const char *fmt;
b26317c9
JA
1006
1007 if (!sample_size)
1008 return;
1009
1010 s = __get_sample(samples, 0, 0);
49e98daa 1011 log_offset = (s->__ddir & LOG_OFFSET_SAMPLE_BIT) != 0;
03ec570f 1012 log_prio = (s->__ddir & LOG_PRIO_SAMPLE_BIT) != 0;
0e14633c 1013 log_avg_max = (s->__ddir & LOG_AVG_MAX_SAMPLE_BIT) != 0;
03ec570f
DLM
1014
1015 if (log_offset) {
0e14633c
AK
1016 if (log_prio) {
1017 if (log_avg_max)
1018 fmt = "%" PRIu64 ", %" PRId64 ", %" PRId64 ", %u, %llu, %llu, 0x%04x\n";
1019 else
1020 fmt = "%" PRIu64 ", %" PRId64 ", %u, %llu, %llu, 0x%04x\n";
1021 } else {
1022 if (log_avg_max)
1023 fmt = "%" PRIu64 ", %" PRId64 ", %" PRId64 ", %u, %llu, %llu, %u\n";
1024 else
1025 fmt = "%" PRIu64 ", %" PRId64 ", %u, %llu, %llu, %u\n";
1026 }
03ec570f 1027 } else {
0e14633c
AK
1028 if (log_prio) {
1029 if (log_avg_max)
1030 fmt = "%" PRIu64 ", %" PRId64 ", %" PRId64 ", %u, %llu, 0x%04x\n";
1031 else
1032 fmt = "%" PRIu64 ", %" PRId64 ", %u, %llu, 0x%04x\n";
1033 } else {
1034 if (log_avg_max)
1035 fmt = "%" PRIu64 ", %" PRId64 ", %" PRId64 ", %u, %llu, %u\n";
1036 else
1037 fmt = "%" PRIu64 ", %" PRId64 ", %u, %llu, %u\n";
1038 }
03ec570f 1039 }
b26317c9
JA
1040
1041 nr_samples = sample_size / __log_entry_sz(log_offset);
ac9b9101 1042
aee2ab67 1043 for (i = 0; i < nr_samples; i++) {
b26317c9 1044 s = __get_sample(samples, log_offset, i);
ac9b9101 1045
03ec570f
DLM
1046 if (log_prio)
1047 prio_val = s->priority;
1048 else
1049 prio_val = ioprio_value_is_class_rt(s->priority);
1050
aee2ab67 1051 if (!log_offset) {
0e14633c
AK
1052 if (log_avg_max)
1053 fprintf(f, fmt,
1054 s->time,
1055 s->data.val.val0,
1056 s->data.val.val1,
1057 io_sample_ddir(s), (unsigned long long) s->bs,
1058 prio_val);
1059 else
1060 fprintf(f, fmt,
1061 s->time,
1062 s->data.val.val0,
1063 io_sample_ddir(s), (unsigned long long) s->bs,
1064 prio_val);
ae588852
JA
1065 } else {
1066 struct io_sample_offset *so = (void *) s;
1067
0e14633c
AK
1068 if (log_avg_max)
1069 fprintf(f, fmt,
1070 s->time,
1071 s->data.val.val0,
1072 s->data.val.val1,
1073 io_sample_ddir(s), (unsigned long long) s->bs,
1074 (unsigned long long) so->offset,
1075 prio_val);
1076 else
1077 fprintf(f, fmt,
1078 s->time,
1079 s->data.val.val0,
1080 io_sample_ddir(s), (unsigned long long) s->bs,
1081 (unsigned long long) so->offset,
1082 prio_val);
ae588852 1083 }
ac9b9101 1084 }
aee2ab67
JA
1085}
1086
1087#ifdef CONFIG_ZLIB
97eabb2a
JA
1088
1089struct iolog_flush_data {
155f2f02 1090 struct workqueue_work work;
97eabb2a
JA
1091 struct io_log *log;
1092 void *samples;
7e419452
JA
1093 uint32_t nr_samples;
1094 bool free;
97eabb2a
JA
1095};
1096
97eabb2a
JA
1097#define GZ_CHUNK 131072
1098
1099static struct iolog_compress *get_new_chunk(unsigned int seq)
1100{
1101 struct iolog_compress *c;
1102
1103 c = malloc(sizeof(*c));
1104 INIT_FLIST_HEAD(&c->list);
1105 c->buf = malloc(GZ_CHUNK);
1106 c->len = 0;
1107 c->seq = seq;
97eabb2a
JA
1108 return c;
1109}
1110
1111static void free_chunk(struct iolog_compress *ic)
1112{
c07826cd
JA
1113 free(ic->buf);
1114 free(ic);
97eabb2a
JA
1115}
1116
b26317c9 1117static int z_stream_init(z_stream *stream, int gz_hdr)
aee2ab67 1118{
b26317c9
JA
1119 int wbits = 15;
1120
acb2a69b 1121 memset(stream, 0, sizeof(*stream));
aee2ab67
JA
1122 stream->zalloc = Z_NULL;
1123 stream->zfree = Z_NULL;
1124 stream->opaque = Z_NULL;
1125 stream->next_in = Z_NULL;
1126
1a8e7458
JA
1127 /*
1128 * zlib magic - add 32 for auto-detection of gz header or not,
1129 * if we decide to store files in a gzip friendly format.
1130 */
b26317c9
JA
1131 if (gz_hdr)
1132 wbits += 32;
1133
1134 if (inflateInit2(stream, wbits) != Z_OK)
aee2ab67
JA
1135 return 1;
1136
1137 return 0;
1138}
1139
1a8e7458 1140struct inflate_chunk_iter {
aee2ab67 1141 unsigned int seq;
dad95da1 1142 int err;
aee2ab67
JA
1143 void *buf;
1144 size_t buf_size;
1145 size_t buf_used;
1146 size_t chunk_sz;
1147};
1148
b26317c9 1149static void finish_chunk(z_stream *stream, FILE *f,
1a8e7458 1150 struct inflate_chunk_iter *iter)
aee2ab67 1151{
aee2ab67
JA
1152 int ret;
1153
1154 ret = inflateEnd(stream);
1155 if (ret != Z_OK)
50f940f1
JA
1156 log_err("fio: failed to end log inflation seq %d (%d)\n",
1157 iter->seq, ret);
aee2ab67 1158
b26317c9 1159 flush_samples(f, iter->buf, iter->buf_used);
aee2ab67
JA
1160 free(iter->buf);
1161 iter->buf = NULL;
1162 iter->buf_size = iter->buf_used = 0;
1163}
1164
1a8e7458
JA
1165/*
1166 * Iterative chunk inflation. Handles cases where we cross into a new
1167 * sequence, doing flush finish of previous chunk if needed.
1168 */
1169static size_t inflate_chunk(struct iolog_compress *ic, int gz_hdr, FILE *f,
1170 z_stream *stream, struct inflate_chunk_iter *iter)
aee2ab67 1171{
0c56718d
JA
1172 size_t ret;
1173
0f989d2e 1174 dprint(FD_COMPRESS, "inflate chunk size=%lu, seq=%u\n",
0c56718d
JA
1175 (unsigned long) ic->len, ic->seq);
1176
aee2ab67
JA
1177 if (ic->seq != iter->seq) {
1178 if (iter->seq)
b26317c9 1179 finish_chunk(stream, f, iter);
aee2ab67 1180
b26317c9 1181 z_stream_init(stream, gz_hdr);
aee2ab67
JA
1182 iter->seq = ic->seq;
1183 }
1184
1185 stream->avail_in = ic->len;
1186 stream->next_in = ic->buf;
1187
1188 if (!iter->buf_size) {
1189 iter->buf_size = iter->chunk_sz;
1190 iter->buf = malloc(iter->buf_size);
1191 }
1192
1193 while (stream->avail_in) {
b26317c9 1194 size_t this_out = iter->buf_size - iter->buf_used;
aee2ab67
JA
1195 int err;
1196
b26317c9 1197 stream->avail_out = this_out;
aee2ab67
JA
1198 stream->next_out = iter->buf + iter->buf_used;
1199
1200 err = inflate(stream, Z_NO_FLUSH);
1201 if (err < 0) {
1202 log_err("fio: failed inflating log: %d\n", err);
dad95da1 1203 iter->err = err;
aee2ab67
JA
1204 break;
1205 }
1206
b26317c9
JA
1207 iter->buf_used += this_out - stream->avail_out;
1208
1209 if (!stream->avail_out) {
1210 iter->buf_size += iter->chunk_sz;
1211 iter->buf = realloc(iter->buf, iter->buf_size);
1212 continue;
1213 }
1214
1215 if (err == Z_STREAM_END)
1216 break;
aee2ab67
JA
1217 }
1218
0c56718d
JA
1219 ret = (void *) stream->next_in - ic->buf;
1220
d0d0cf0a 1221 dprint(FD_COMPRESS, "inflated to size=%lu\n", (unsigned long) iter->buf_size);
0c56718d
JA
1222
1223 return ret;
aee2ab67
JA
1224}
1225
1a8e7458
JA
1226/*
1227 * Inflate stored compressed chunks, or write them directly to the log
1228 * file if so instructed.
1229 */
dad95da1 1230static int inflate_gz_chunks(struct io_log *log, FILE *f)
aee2ab67 1231{
1a8e7458 1232 struct inflate_chunk_iter iter = { .chunk_sz = log->log_gz, };
aee2ab67
JA
1233 z_stream stream;
1234
1235 while (!flist_empty(&log->chunk_list)) {
1236 struct iolog_compress *ic;
1237
9342d5f8 1238 ic = flist_first_entry(&log->chunk_list, struct iolog_compress, list);
aee2ab67 1239 flist_del(&ic->list);
b26317c9 1240
1a8e7458
JA
1241 if (log->log_gz_store) {
1242 size_t ret;
1243
0c56718d
JA
1244 dprint(FD_COMPRESS, "log write chunk size=%lu, "
1245 "seq=%u\n", (unsigned long) ic->len, ic->seq);
1246
1a8e7458 1247 ret = fwrite(ic->buf, ic->len, 1, f);
dad95da1
JA
1248 if (ret != 1 || ferror(f)) {
1249 iter.err = errno;
1a8e7458 1250 log_err("fio: error writing compressed log\n");
dad95da1 1251 }
1a8e7458
JA
1252 } else
1253 inflate_chunk(ic, log->log_gz_store, f, &stream, &iter);
c07826cd
JA
1254
1255 free_chunk(ic);
aee2ab67
JA
1256 }
1257
1258 if (iter.seq) {
b26317c9 1259 finish_chunk(&stream, f, &iter);
aee2ab67
JA
1260 free(iter.buf);
1261 }
dad95da1
JA
1262
1263 return iter.err;
aee2ab67
JA
1264}
1265
1a8e7458
JA
1266/*
1267 * Open compressed log file and decompress the stored chunks and
1268 * write them to stdout. The chunks are stored sequentially in the
1269 * file, so we iterate over them and do them one-by-one.
1270 */
b26317c9
JA
1271int iolog_file_inflate(const char *file)
1272{
1a8e7458 1273 struct inflate_chunk_iter iter = { .chunk_sz = 64 * 1024 * 1024, };
b26317c9
JA
1274 struct iolog_compress ic;
1275 z_stream stream;
1276 struct stat sb;
2b8b8f0d 1277 size_t ret;
f302710c
JA
1278 size_t total;
1279 void *buf;
b26317c9
JA
1280 FILE *f;
1281
a7c386ed 1282 f = fopen(file, "rb");
b26317c9
JA
1283 if (!f) {
1284 perror("fopen");
1285 return 1;
1286 }
1287
fd771971
JA
1288 if (stat(file, &sb) < 0) {
1289 fclose(f);
1290 perror("stat");
1291 return 1;
1292 }
1293
f302710c 1294 ic.buf = buf = malloc(sb.st_size);
b26317c9 1295 ic.len = sb.st_size;
b26317c9
JA
1296 ic.seq = 1;
1297
1298 ret = fread(ic.buf, ic.len, 1, f);
2b8b8f0d 1299 if (ret == 0 && ferror(f)) {
b26317c9
JA
1300 perror("fread");
1301 fclose(f);
bb1116fe 1302 free(buf);
b26317c9 1303 return 1;
2b8b8f0d 1304 } else if (ferror(f) || (!feof(f) && ret != 1)) {
b26317c9
JA
1305 log_err("fio: short read on reading log\n");
1306 fclose(f);
bb1116fe 1307 free(buf);
b26317c9
JA
1308 return 1;
1309 }
1310
1311 fclose(f);
1312
1a8e7458
JA
1313 /*
1314 * Each chunk will return Z_STREAM_END. We don't know how many
1315 * chunks are in the file, so we just keep looping and incrementing
1316 * the sequence number until we have consumed the whole compressed
1317 * file.
1318 */
f302710c
JA
1319 total = ic.len;
1320 do {
8a1db9a1 1321 size_t iret;
f302710c 1322
8a1db9a1
JA
1323 iret = inflate_chunk(&ic, 1, stdout, &stream, &iter);
1324 total -= iret;
f302710c
JA
1325 if (!total)
1326 break;
dad95da1
JA
1327 if (iter.err)
1328 break;
f302710c
JA
1329
1330 ic.seq++;
8a1db9a1
JA
1331 ic.len -= iret;
1332 ic.buf += iret;
f302710c 1333 } while (1);
b26317c9
JA
1334
1335 if (iter.seq) {
1336 finish_chunk(&stream, stdout, &iter);
1337 free(iter.buf);
1338 }
1339
f302710c 1340 free(buf);
dad95da1 1341 return iter.err;
b26317c9
JA
1342}
1343
aee2ab67
JA
1344#else
1345
dad95da1 1346static int inflate_gz_chunks(struct io_log *log, FILE *f)
aee2ab67 1347{
b7364e21 1348 return 0;
aee2ab67
JA
1349}
1350
a68c66b2
JA
1351int iolog_file_inflate(const char *file)
1352{
1353 log_err("fio: log inflation not possible without zlib\n");
1354 return 1;
1355}
1356
aee2ab67
JA
1357#endif
1358
60a25727 1359void flush_log(struct io_log *log, bool do_append)
aee2ab67
JA
1360{
1361 void *buf;
1362 FILE *f;
1363
a7c386ed 1364 /*
1365 * If log_gz_store is true, we are writing a binary file.
1366 * Set the mode appropriately (on all platforms) to avoid issues
1367 * on windows (line-ending conversions, etc.)
1368 */
3a5db920 1369 if (!do_append)
a7c386ed 1370 if (log->log_gz_store)
1371 f = fopen(log->filename, "wb");
1372 else
1373 f = fopen(log->filename, "w");
3a5db920 1374 else
a7c386ed 1375 if (log->log_gz_store)
1376 f = fopen(log->filename, "ab");
1377 else
1378 f = fopen(log->filename, "a");
aee2ab67
JA
1379 if (!f) {
1380 perror("fopen log");
1381 return;
1382 }
1383
1384 buf = set_file_buffer(f);
1385
1a8e7458 1386 inflate_gz_chunks(log, f);
aee2ab67 1387
7e419452
JA
1388 while (!flist_empty(&log->io_logs)) {
1389 struct io_logs *cur_log;
1390
1391 cur_log = flist_first_entry(&log->io_logs, struct io_logs, list);
1392 flist_del_init(&cur_log->list);
1e613c9c 1393
a9179eeb 1394 if (log->td && log == log->td->clat_hist_log)
1e613c9c 1395 flush_hist_samples(f, log->hist_coarseness, cur_log->log,
868f6f03 1396 log_sample_sz(log, cur_log));
1e613c9c 1397 else
868f6f03 1398 flush_samples(f, cur_log->log, log_sample_sz(log, cur_log));
1e613c9c 1399
90d2d53f 1400 sfree(cur_log);
7e419452 1401 }
ac9b9101
JA
1402
1403 fclose(f);
2e802282 1404 clear_file_buffer(buf);
ac9b9101
JA
1405}
1406
cb7e0ace 1407static int finish_log(struct thread_data *td, struct io_log *log, int trylock)
ac9b9101 1408{
155f2f02 1409 if (td->flags & TD_F_COMPRESS_LOG)
7e419452 1410 iolog_flush(log);
aee2ab67 1411
243bfe19 1412 if (trylock) {
cb7e0ace 1413 if (fio_trylock_file(log->filename))
243bfe19
JA
1414 return 1;
1415 } else
cb7e0ace 1416 fio_lock_file(log->filename);
243bfe19 1417
0cba0f91 1418 if (td->client_type == FIO_CLIENT_TYPE_GUI || is_backend)
cb7e0ace 1419 fio_send_iolog(td, log, log->filename);
aee2ab67 1420 else
3a5db920 1421 flush_log(log, !td->o.per_job_logs);
243bfe19 1422
cb7e0ace 1423 fio_unlock_file(log->filename);
518dac09 1424 free_log(log);
243bfe19 1425 return 0;
ac9b9101
JA
1426}
1427
0cba0f91
JA
1428size_t log_chunk_sizes(struct io_log *log)
1429{
1430 struct flist_head *entry;
1431 size_t ret;
1432
1433 if (flist_empty(&log->chunk_list))
1434 return 0;
1435
1436 ret = 0;
1437 pthread_mutex_lock(&log->chunk_lock);
1438 flist_for_each(entry, &log->chunk_list) {
1439 struct iolog_compress *c;
1440
1441 c = flist_entry(entry, struct iolog_compress, list);
1442 ret += c->len;
1443 }
1444 pthread_mutex_unlock(&log->chunk_lock);
1445 return ret;
1446}
1447
aee2ab67
JA
1448#ifdef CONFIG_ZLIB
1449
858bce70
JA
1450static void iolog_put_deferred(struct io_log *log, void *ptr)
1451{
1452 if (!ptr)
1453 return;
1454
1455 pthread_mutex_lock(&log->deferred_free_lock);
1456 if (log->deferred < IOLOG_MAX_DEFER) {
1457 log->deferred_items[log->deferred] = ptr;
1458 log->deferred++;
e2446166 1459 } else if (!fio_did_warn(FIO_WARN_IOLOG_DROP))
858bce70 1460 log_err("fio: had to drop log entry free\n");
858bce70
JA
1461 pthread_mutex_unlock(&log->deferred_free_lock);
1462}
1463
1464static void iolog_free_deferred(struct io_log *log)
1465{
1466 int i;
1467
1468 if (!log->deferred)
1469 return;
1470
1471 pthread_mutex_lock(&log->deferred_free_lock);
1472
1473 for (i = 0; i < log->deferred; i++) {
1474 free(log->deferred_items[i]);
1475 log->deferred_items[i] = NULL;
1476 }
1477
1478 log->deferred = 0;
1479 pthread_mutex_unlock(&log->deferred_free_lock);
1480}
1481
78e93aa6 1482static int gz_work(struct iolog_flush_data *data)
c143980a 1483{
040238ec 1484 struct iolog_compress *c = NULL;
aee2ab67
JA
1485 struct flist_head list;
1486 unsigned int seq;
1487 z_stream stream;
1488 size_t total = 0;
d73ac887 1489 int ret;
aee2ab67
JA
1490
1491 INIT_FLIST_HEAD(&list);
1492
7e419452 1493 memset(&stream, 0, sizeof(stream));
aee2ab67
JA
1494 stream.zalloc = Z_NULL;
1495 stream.zfree = Z_NULL;
1496 stream.opaque = Z_NULL;
1497
b26317c9 1498 ret = deflateInit(&stream, Z_DEFAULT_COMPRESSION);
b26317c9 1499 if (ret != Z_OK) {
aee2ab67 1500 log_err("fio: failed to init gz stream\n");
152ea035 1501 goto err;
aee2ab67
JA
1502 }
1503
1504 seq = ++data->log->chunk_seq;
b26317c9 1505
aee2ab67
JA
1506 stream.next_in = (void *) data->samples;
1507 stream.avail_in = data->nr_samples * log_entry_sz(data->log);
1508
d0d0cf0a
JA
1509 dprint(FD_COMPRESS, "deflate input size=%lu, seq=%u, log=%s\n",
1510 (unsigned long) stream.avail_in, seq,
1511 data->log->filename);
aee2ab67 1512 do {
040238ec 1513 if (c)
0caccfa7
JA
1514 dprint(FD_COMPRESS, "seq=%d, chunk=%lu\n", seq,
1515 (unsigned long) c->len);
aee2ab67
JA
1516 c = get_new_chunk(seq);
1517 stream.avail_out = GZ_CHUNK;
1518 stream.next_out = c->buf;
1519 ret = deflate(&stream, Z_NO_FLUSH);
1520 if (ret < 0) {
1521 log_err("fio: deflate log (%d)\n", ret);
dad95da1
JA
1522 free_chunk(c);
1523 goto err;
aee2ab67
JA
1524 }
1525
1526 c->len = GZ_CHUNK - stream.avail_out;
1527 flist_add_tail(&c->list, &list);
1528 total += c->len;
1529 } while (stream.avail_in);
1530
1531 stream.next_out = c->buf + c->len;
1532 stream.avail_out = GZ_CHUNK - c->len;
1533
1534 ret = deflate(&stream, Z_FINISH);
6fa3ad51
JA
1535 if (ret < 0) {
1536 /*
1537 * Z_BUF_ERROR is special, it just means we need more
1538 * output space. We'll handle that below. Treat any other
1539 * error as fatal.
1540 */
1541 if (ret != Z_BUF_ERROR) {
1542 log_err("fio: deflate log (%d)\n", ret);
1543 flist_del(&c->list);
1544 free_chunk(c);
1545 goto err;
1546 }
1547 }
1548
1549 total -= c->len;
1550 c->len = GZ_CHUNK - stream.avail_out;
1551 total += c->len;
0caccfa7 1552 dprint(FD_COMPRESS, "seq=%d, chunk=%lu\n", seq, (unsigned long) c->len);
040238ec 1553
6fa3ad51 1554 if (ret != Z_STREAM_END) {
aee2ab67
JA
1555 do {
1556 c = get_new_chunk(seq);
1557 stream.avail_out = GZ_CHUNK;
1558 stream.next_out = c->buf;
1559 ret = deflate(&stream, Z_FINISH);
1560 c->len = GZ_CHUNK - stream.avail_out;
0c56718d 1561 total += c->len;
aee2ab67 1562 flist_add_tail(&c->list, &list);
0caccfa7
JA
1563 dprint(FD_COMPRESS, "seq=%d, chunk=%lu\n", seq,
1564 (unsigned long) c->len);
aee2ab67
JA
1565 } while (ret != Z_STREAM_END);
1566 }
1567
0c56718d
JA
1568 dprint(FD_COMPRESS, "deflated to size=%lu\n", (unsigned long) total);
1569
aee2ab67
JA
1570 ret = deflateEnd(&stream);
1571 if (ret != Z_OK)
1572 log_err("fio: deflateEnd %d\n", ret);
1573
858bce70 1574 iolog_put_deferred(data->log, data->samples);
aee2ab67
JA
1575
1576 if (!flist_empty(&list)) {
1577 pthread_mutex_lock(&data->log->chunk_lock);
1578 flist_splice_tail(&list, &data->log->chunk_list);
1579 pthread_mutex_unlock(&data->log->chunk_lock);
1580 }
1581
dad95da1
JA
1582 ret = 0;
1583done:
7e419452 1584 if (data->free)
dab41b1c 1585 sfree(data);
dad95da1
JA
1586 return ret;
1587err:
1588 while (!flist_empty(&list)) {
1589 c = flist_first_entry(list.next, struct iolog_compress, list);
1590 flist_del(&c->list);
1591 free_chunk(c);
1592 }
1593 ret = 1;
1594 goto done;
aee2ab67
JA
1595}
1596
78e93aa6
JA
1597/*
1598 * Invoked from our compress helper thread, when logging would have exceeded
1599 * the specified memory limitation. Compresses the previously stored
1600 * entries.
1601 */
1602static int gz_work_async(struct submit_worker *sw, struct workqueue_work *work)
1603{
1604 return gz_work(container_of(work, struct iolog_flush_data, work));
1605}
1606
c08f9fe2
JA
1607static int gz_init_worker(struct submit_worker *sw)
1608{
1609 struct thread_data *td = sw->wq->td;
1610
1611 if (!fio_option_is_set(&td->o, log_gz_cpumask))
1612 return 0;
1613
1614 if (fio_setaffinity(gettid(), td->o.log_gz_cpumask) == -1) {
1615 log_err("gz: failed to set CPU affinity\n");
1616 return 1;
1617 }
1618
1619 return 0;
1620}
1621
155f2f02 1622static struct workqueue_ops log_compress_wq_ops = {
78e93aa6 1623 .fn = gz_work_async,
c08f9fe2 1624 .init_worker_fn = gz_init_worker,
24660963 1625 .nice = 1,
155f2f02
JA
1626};
1627
24660963 1628int iolog_compress_init(struct thread_data *td, struct sk_out *sk_out)
155f2f02
JA
1629{
1630 if (!(td->flags & TD_F_COMPRESS_LOG))
1631 return 0;
1632
24660963 1633 workqueue_init(td, &td->log_compress_wq, &log_compress_wq_ops, 1, sk_out);
155f2f02
JA
1634 return 0;
1635}
1636
1637void iolog_compress_exit(struct thread_data *td)
1638{
1639 if (!(td->flags & TD_F_COMPRESS_LOG))
1640 return;
1641
1642 workqueue_exit(&td->log_compress_wq);
1643}
1644
1a8e7458 1645/*
949ae6dc
JA
1646 * Queue work item to compress the existing log entries. We reset the
1647 * current log to a small size, and reference the existing log in the
1648 * data that we queue for compression. Once compression has been done,
03900b0b 1649 * this old log is freed. Will not return until the log compression
1650 * has completed, and will flush all previous logs too
1a8e7458 1651 */
7e419452 1652static int iolog_flush(struct io_log *log)
aee2ab67 1653{
aee2ab67 1654 struct iolog_flush_data *data;
aee2ab67 1655
03900b0b 1656 workqueue_flush(&log->td->log_compress_wq);
aee2ab67
JA
1657 data = malloc(sizeof(*data));
1658 if (!data)
1659 return 1;
1660
1661 data->log = log;
7e419452 1662 data->free = false;
aee2ab67 1663
7e419452
JA
1664 while (!flist_empty(&log->io_logs)) {
1665 struct io_logs *cur_log;
949ae6dc 1666
7e419452
JA
1667 cur_log = flist_first_entry(&log->io_logs, struct io_logs, list);
1668 flist_del_init(&cur_log->list);
1669
1670 data->samples = cur_log->log;
1671 data->nr_samples = cur_log->nr_samples;
1672
2b7625e2 1673 sfree(cur_log);
aee2ab67 1674
78e93aa6 1675 gz_work(data);
7e419452 1676 }
aee2ab67 1677
7e419452 1678 free(data);
aee2ab67
JA
1679 return 0;
1680}
1681
7e419452
JA
1682int iolog_cur_flush(struct io_log *log, struct io_logs *cur_log)
1683{
1684 struct iolog_flush_data *data;
1685
dab41b1c 1686 data = smalloc(sizeof(*data));
7e419452
JA
1687 if (!data)
1688 return 1;
1689
1690 data->log = log;
1691
1692 data->samples = cur_log->log;
1693 data->nr_samples = cur_log->nr_samples;
1694 data->free = true;
1695
1696 cur_log->nr_samples = cur_log->max_samples = 0;
1697 cur_log->log = NULL;
1698
1699 workqueue_enqueue(&log->td->log_compress_wq, &data->work);
858bce70
JA
1700
1701 iolog_free_deferred(log);
1702
7e419452
JA
1703 return 0;
1704}
aee2ab67
JA
1705#else
1706
7e419452
JA
1707static int iolog_flush(struct io_log *log)
1708{
1709 return 1;
1710}
1711
1712int iolog_cur_flush(struct io_log *log, struct io_logs *cur_log)
aee2ab67
JA
1713{
1714 return 1;
1715}
1716
24660963 1717int iolog_compress_init(struct thread_data *td, struct sk_out *sk_out)
52618a2a
JA
1718{
1719 return 0;
1720}
1721
1722void iolog_compress_exit(struct thread_data *td)
1723{
1724}
1725
aee2ab67
JA
1726#endif
1727
7e419452
JA
1728struct io_logs *iolog_cur_log(struct io_log *log)
1729{
1730 if (flist_empty(&log->io_logs))
1731 return NULL;
1732
1733 return flist_last_entry(&log->io_logs, struct io_logs, list);
1734}
1735
1736uint64_t iolog_nr_samples(struct io_log *iolog)
1737{
1738 struct flist_head *entry;
1739 uint64_t ret = 0;
1740
1741 flist_for_each(entry, &iolog->io_logs) {
1742 struct io_logs *cur_log;
1743
1744 cur_log = flist_entry(entry, struct io_logs, list);
1745 ret += cur_log->nr_samples;
1746 }
1747
1748 return ret;
1749}
1750
1c725e70 1751static int __write_log(struct thread_data *td, struct io_log *log, int try)
905e3d4f 1752{
1c725e70
JA
1753 if (log)
1754 return finish_log(td, log, try);
905e3d4f 1755
1c725e70
JA
1756 return 0;
1757}
905e3d4f 1758
a47591e4 1759static int write_iops_log(struct thread_data *td, int try, bool unit_log)
1c725e70 1760{
a47591e4
JA
1761 int ret;
1762
1763 if (per_unit_log(td->iops_log) != unit_log)
1764 return 0;
1765
1766 ret = __write_log(td, td->iops_log, try);
1767 if (!ret)
1768 td->iops_log = NULL;
1769
1770 return ret;
905e3d4f
JA
1771}
1772
a47591e4 1773static int write_slat_log(struct thread_data *td, int try, bool unit_log)
905e3d4f 1774{
a47591e4
JA
1775 int ret;
1776
1777 if (!unit_log)
1778 return 0;
1779
1780 ret = __write_log(td, td->slat_log, try);
1781 if (!ret)
1782 td->slat_log = NULL;
1783
1784 return ret;
905e3d4f
JA
1785}
1786
a47591e4 1787static int write_clat_log(struct thread_data *td, int try, bool unit_log)
905e3d4f 1788{
a47591e4
JA
1789 int ret;
1790
1791 if (!unit_log)
1792 return 0;
1793
1794 ret = __write_log(td, td->clat_log, try);
1795 if (!ret)
1796 td->clat_log = NULL;
1797
1798 return ret;
905e3d4f
JA
1799}
1800
1e613c9c
KC
1801static int write_clat_hist_log(struct thread_data *td, int try, bool unit_log)
1802{
1803 int ret;
1804
1805 if (!unit_log)
1806 return 0;
1807
1808 ret = __write_log(td, td->clat_hist_log, try);
1809 if (!ret)
1810 td->clat_hist_log = NULL;
1811
1812 return ret;
1813}
1814
a47591e4 1815static int write_lat_log(struct thread_data *td, int try, bool unit_log)
905e3d4f 1816{
a47591e4
JA
1817 int ret;
1818
1819 if (!unit_log)
1820 return 0;
1821
1822 ret = __write_log(td, td->lat_log, try);
1823 if (!ret)
1824 td->lat_log = NULL;
1825
1826 return ret;
905e3d4f
JA
1827}
1828
a47591e4 1829static int write_bandw_log(struct thread_data *td, int try, bool unit_log)
905e3d4f 1830{
a47591e4
JA
1831 int ret;
1832
1833 if (per_unit_log(td->bw_log) != unit_log)
1834 return 0;
1835
1836 ret = __write_log(td, td->bw_log, try);
1837 if (!ret)
1838 td->bw_log = NULL;
1839
1840 return ret;
905e3d4f
JA
1841}
1842
1843enum {
1844 BW_LOG_MASK = 1,
1845 LAT_LOG_MASK = 2,
1846 SLAT_LOG_MASK = 4,
1847 CLAT_LOG_MASK = 8,
1848 IOPS_LOG_MASK = 16,
1e613c9c 1849 CLAT_HIST_LOG_MASK = 32,
905e3d4f 1850
1e613c9c 1851 ALL_LOG_NR = 6,
905e3d4f
JA
1852};
1853
1854struct log_type {
1855 unsigned int mask;
a47591e4 1856 int (*fn)(struct thread_data *, int, bool);
905e3d4f
JA
1857};
1858
1859static struct log_type log_types[] = {
1860 {
1861 .mask = BW_LOG_MASK,
1862 .fn = write_bandw_log,
1863 },
1864 {
1865 .mask = LAT_LOG_MASK,
1866 .fn = write_lat_log,
1867 },
1868 {
1869 .mask = SLAT_LOG_MASK,
1870 .fn = write_slat_log,
1871 },
1872 {
1873 .mask = CLAT_LOG_MASK,
1874 .fn = write_clat_log,
1875 },
1876 {
1877 .mask = IOPS_LOG_MASK,
1878 .fn = write_iops_log,
1879 },
1e613c9c
KC
1880 {
1881 .mask = CLAT_HIST_LOG_MASK,
1882 .fn = write_clat_hist_log,
1883 }
905e3d4f
JA
1884};
1885
a47591e4 1886void td_writeout_logs(struct thread_data *td, bool unit_logs)
905e3d4f 1887{
ea5409f9 1888 unsigned int log_mask = 0;
905e3d4f
JA
1889 unsigned int log_left = ALL_LOG_NR;
1890 int old_state, i;
1891
1892 old_state = td_bump_runstate(td, TD_FINISHING);
1893
a47591e4 1894 finalize_logs(td, unit_logs);
905e3d4f
JA
1895
1896 while (log_left) {
1897 int prev_log_left = log_left;
1898
1899 for (i = 0; i < ALL_LOG_NR && log_left; i++) {
1900 struct log_type *lt = &log_types[i];
1901 int ret;
1902
ea5409f9 1903 if (!(log_mask & lt->mask)) {
a47591e4 1904 ret = lt->fn(td, log_left != 1, unit_logs);
905e3d4f
JA
1905 if (!ret) {
1906 log_left--;
ea5409f9 1907 log_mask |= lt->mask;
905e3d4f
JA
1908 }
1909 }
1910 }
1911
1912 if (prev_log_left == log_left)
1913 usleep(5000);
1914 }
1915
1916 td_restore_runstate(td, old_state);
1917}
a47591e4
JA
1918
1919void fio_writeout_logs(bool unit_logs)
1920{
da8f124f 1921 for_each_td(td) {
a47591e4 1922 td_writeout_logs(td, unit_logs);
da8f124f 1923 } end_for_each();
a47591e4 1924}