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