More file creation improvements
[fio.git] / fio.h
CommitLineData
ebac4655
JA
1#ifndef FIO_H
2#define FIO_H
3
4#include <sched.h>
5#include <limits.h>
6#include <pthread.h>
7#include <sys/time.h>
8#include <sys/resource.h>
3c39a379
JA
9#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
6d6f031f 12#include <unistd.h>
34cfcdaf 13#include <string.h>
ebac4655
JA
14
15#include "list.h"
16#include "md5.h"
17#include "crc32.h"
18#include "arch.h"
19#include "os.h"
07739b57 20#include "mutex.h"
ebac4655 21
b6959b55 22#ifdef FIO_HAVE_SYSLET
a4f4fdd7 23#include "syslet.h"
b6959b55 24#endif
a4f4fdd7 25
1e97cce9
JA
26enum fio_ddir {
27 DDIR_READ = 0,
28 DDIR_WRITE,
29 DDIR_SYNC,
30};
31
413dd459 32enum td_ddir {
b1ec1da6
JA
33 TD_DDIR_READ = 1 << 0,
34 TD_DDIR_WRITE = 1 << 1,
35 TD_DDIR_RAND = 1 << 2,
36 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
37 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
7ff1c14b 38 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
b1ec1da6 39 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
413dd459
JA
40};
41
1c9e06ee
JA
42/*
43 * Use for maintaining statistics
44 */
ebac4655 45struct io_stat {
ebac4655
JA
46 unsigned long max_val;
47 unsigned long min_val;
48 unsigned long samples;
68704084
JA
49
50 double mean;
51 double S;
ebac4655
JA
52};
53
1c9e06ee
JA
54/*
55 * A single data sample
56 */
ebac4655
JA
57struct io_sample {
58 unsigned long time;
59 unsigned long val;
1e97cce9 60 enum fio_ddir ddir;
ebac4655
JA
61};
62
1c9e06ee
JA
63/*
64 * Dynamically growing data sample log
65 */
ebac4655
JA
66struct io_log {
67 unsigned long nr_samples;
68 unsigned long max_samples;
69 struct io_sample *log;
70};
71
1c9e06ee
JA
72/*
73 * When logging io actions, this matches a single sent io_u
74 */
ebac4655
JA
75struct io_piece {
76 struct list_head list;
53cdc686 77 struct fio_file *file;
ebac4655 78 unsigned long long offset;
a4f4fdd7 79 unsigned long len;
1e97cce9 80 enum fio_ddir ddir;
ebac4655
JA
81};
82
a4f4fdd7
JA
83#ifdef FIO_HAVE_SYSLET
84struct syslet_req {
5b38ee84
JA
85 struct syslet_uatom atom; /* the atom to submit */
86 struct syslet_uatom *head; /* head of the sequence */
87 long ret; /* syscall return value */
a4f4fdd7
JA
88};
89#endif
90
0c6e7517
JA
91enum {
92 IO_U_F_FREE = 1 << 0,
93 IO_U_F_FLIGHT = 1 << 1,
94};
95
ebac4655
JA
96/*
97 * The io unit
98 */
99struct io_u {
100 union {
101#ifdef FIO_HAVE_LIBAIO
102 struct iocb iocb;
103#endif
104#ifdef FIO_HAVE_POSIXAIO
105 struct aiocb aiocb;
106#endif
107#ifdef FIO_HAVE_SGIO
108 struct sg_io_hdr hdr;
a4f4fdd7
JA
109#endif
110#ifdef FIO_HAVE_SYSLET
a2e1b08a 111 struct syslet_req req;
ebac4655
JA
112#endif
113 };
114 struct timeval start_time;
115 struct timeval issue_time;
116
1c9e06ee
JA
117 /*
118 * Allocated/set buffer and length
119 */
6b9cea23 120 void *buf;
a4f4fdd7 121 unsigned long buflen;
ebac4655
JA
122 unsigned long long offset;
123
1c9e06ee
JA
124 /*
125 * IO engine state, may be different from above when we get
126 * partial transfers / residual data counts
127 */
cec6b55d 128 void *xfer_buf;
a4f4fdd7 129 unsigned long xfer_buflen;
cec6b55d 130
ebac4655
JA
131 unsigned int resid;
132 unsigned int error;
133
1e97cce9 134 enum fio_ddir ddir;
ebac4655 135
dfd7bc2c
JA
136 /*
137 * io engine private data
138 */
139 union {
140 unsigned int index;
141 unsigned int seen;
142 };
143
0c6e7517
JA
144 unsigned int flags;
145
53cdc686
JA
146 struct fio_file *file;
147
ebac4655 148 struct list_head list;
d7762cf8
JA
149
150 /*
151 * Callback for io completion
152 */
153 int (*end_io)(struct io_u *);
ebac4655
JA
154};
155
36167d82
JA
156/*
157 * io_ops->queue() return values
158 */
159enum {
160 FIO_Q_COMPLETED = 0, /* completed sync */
161 FIO_Q_QUEUED = 1, /* queued, will complete async */
755200a3 162 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
36167d82
JA
163};
164
ebac4655
JA
165#define FIO_HDR_MAGIC 0xf00baaef
166
167enum {
1c9e06ee
JA
168 VERIFY_NONE = 0, /* no verification */
169 VERIFY_MD5, /* md5 sum data blocks */
170 VERIFY_CRC32, /* crc32 sum data blocks */
ebac4655
JA
171};
172
1c9e06ee
JA
173/*
174 * A header structure associated with each checksummed data block
175 */
ebac4655
JA
176struct verify_header {
177 unsigned int fio_magic;
178 unsigned int len;
179 unsigned int verify_type;
180 union {
181 char md5_digest[MD5_HASH_WORDS * 4];
182 unsigned long crc32;
183 };
184};
185
186struct group_run_stats {
9104f874
JA
187 unsigned long long max_run[2], min_run[2];
188 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 189 unsigned long long io_kb[2];
9104f874 190 unsigned long long agg[2];
ebac4655
JA
191};
192
e9c047a0
JA
193/*
194 * What type of allocation to use for io buffers
195 */
196enum fio_memtype {
197 MEM_MALLOC = 0, /* ordinary malloc */
198 MEM_SHM, /* use shared memory segments */
74b025b0 199 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 200 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 201 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
202};
203
204/*
205 * The type of object we are working on
206 */
207enum fio_filetype {
1c9e06ee
JA
208 FIO_TYPE_FILE = 1, /* plain file */
209 FIO_TYPE_BD, /* block device */
210 FIO_TYPE_CHAR, /* character device */
e9c047a0
JA
211};
212
2866c82d 213enum fio_ioengine_flags {
1c9e06ee 214 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
ba0fbe10
JA
215 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
216 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
0263882a 217 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
62d984e2 218 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
e9c047a0
JA
219};
220
f11bd94d 221enum fio_file_flags {
0ad920e7
JA
222 FIO_FILE_OPEN = 1 << 0, /* file is open */
223 FIO_FILE_UNLINK = 1 << 1, /* unlink on close */
224 FIO_FILE_CLOSING = 1 << 2, /* file being closed */
96d32d51 225 FIO_FILE_EXISTS = 1 << 3, /* no need to create */
f11bd94d
JA
226};
227
1c9e06ee
JA
228/*
229 * Each thread_data structure has a number of files associated with it,
230 * this structure holds state information for a single file.
231 */
53cdc686 232struct fio_file {
af52b345
JA
233 enum fio_filetype filetype;
234
53cdc686
JA
235 /*
236 * A file may not be a file descriptor, let the io engine decide
237 */
238 union {
239 unsigned long file_data;
e26f8f7a 240 int fd;
53cdc686 241 };
1315a68a 242 char *file_name;
53cdc686
JA
243 void *mmap;
244 unsigned long long file_size;
245 unsigned long long real_file_size;
246 unsigned long long file_offset;
247 unsigned long long last_pos;
02bcaa8c 248 unsigned long long last_completed_pos;
53cdc686 249
1c9e06ee
JA
250 /*
251 * block map for random io
252 */
53cdc686
JA
253 unsigned long *file_map;
254 unsigned int num_maps;
1c9e06ee 255 unsigned int last_free_lookup;
9b031dc8 256
0ad920e7 257 int references;
f11bd94d 258 enum fio_file_flags flags;
53cdc686
JA
259};
260
b2560f3c
JA
261/*
262 * How many depth levels to log
263 */
264#define FIO_IO_U_MAP_NR 8
265#define FIO_IO_U_LAT_NR 12
266
079ad09b 267struct thread_stat {
756867bd
JA
268 char *name;
269 char *verror;
270 int error;
271 int groupid;
272 pid_t pid;
273 char *description;
6586ee89 274 int members;
756867bd 275
079ad09b
JA
276 struct io_log *slat_log;
277 struct io_log *clat_log;
278 struct io_log *bw_log;
279
280 /*
281 * bandwidth and latency stats
282 */
283 struct io_stat clat_stat[2]; /* completion latency */
284 struct io_stat slat_stat[2]; /* submission latency */
285 struct io_stat bw_stat[2]; /* bandwidth stats */
286
287 unsigned long long stat_io_bytes[2];
288 struct timeval stat_sample_time[2];
289
290 /*
291 * fio system usage accounting
292 */
293 struct rusage ru_start;
294 struct rusage ru_end;
295 unsigned long usr_time;
296 unsigned long sys_time;
297 unsigned long ctx;
079ad09b 298
b2560f3c
JA
299 /*
300 * IO depth and latency stats
301 */
302 unsigned int io_u_map[FIO_IO_U_MAP_NR];
303 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
b3605062 304 unsigned long total_io_u[2];
756867bd
JA
305
306 unsigned long long io_bytes[2];
307 unsigned long runtime[2];
308 unsigned long total_run_time;
b2560f3c 309};
71619dc2 310
e9c047a0
JA
311/*
312 * This describes a single thread/process executing a fio job.
313 */
ebac4655 314struct thread_data {
b1ec1da6 315 int pad;
61697c37 316 char *description;
b4692828 317 char *name;
ef899b63 318 char *directory;
13f8e2d2 319 char *filename;
09629a90 320 char *ioengine;
480936dd 321 char verror[128];
ebac4655
JA
322 pthread_t thread;
323 int thread_number;
324 int groupid;
756867bd 325 struct thread_stat ts;
53cdc686 326 struct fio_file *files;
7b4e4fe5 327 unsigned int files_index;
53cdc686 328 unsigned int nr_files;
bdb4e2e9 329 unsigned int nr_open_files;
1549441c 330 unsigned int nr_normal_files;
0aabe160
JA
331 union {
332 unsigned int next_file;
333 os_random_state_t next_file_state;
334 };
ebac4655 335 int error;
ebac4655
JA
336 pid_t pid;
337 char *orig_buffer;
338 size_t orig_buffer_size;
339 volatile int terminate;
340 volatile int runstate;
413dd459 341 enum td_ddir td_ddir;
ebac4655 342 unsigned int ioprio;
87dc1ab1 343 unsigned int last_was_sync;
e9c047a0 344
9158d2f7
JA
345 unsigned int odirect;
346 unsigned int invalidate_cache;
347 unsigned int create_serialize;
348 unsigned int create_fsync;
349 unsigned int end_fsync;
350 unsigned int sync_io;
351 unsigned int verify;
352 unsigned int use_thread;
353 unsigned int unlink;
354 unsigned int do_disk_util;
355 unsigned int override_sync;
356 unsigned int rand_repeatable;
357 unsigned int write_lat_log;
358 unsigned int write_bw_log;
bb8895e0 359 unsigned int norandommap;
690adba3 360 unsigned int bs_unaligned;
ebb1415f 361 unsigned int fsync_on_close;
e9c047a0 362
a00735e6
JA
363 unsigned int bs[2];
364 unsigned int min_bs[2];
365 unsigned int max_bs[2];
56bb17f2 366 unsigned int hugepage_size;
a00735e6 367 unsigned int rw_min_bs;
ebac4655 368 unsigned int thinktime;
48097d5c 369 unsigned int thinktime_spin;
9c1f7434 370 unsigned int thinktime_blocks;
ebac4655
JA
371 unsigned int fsync_blocks;
372 unsigned int start_delay;
906c8d75 373 unsigned long timeout;
ebac4655 374 unsigned int overwrite;
ebac4655 375 unsigned int bw_avg_time;
ebac4655 376 unsigned int loops;
20dc95c4
JA
377 unsigned long long zone_size;
378 unsigned long long zone_skip;
e9c047a0 379 enum fio_memtype mem_type;
313cb206
JA
380 char *mmapfile;
381 int mmapfd;
ebac4655
JA
382 unsigned int stonewall;
383 unsigned int numjobs;
ebac4655 384 unsigned int iodepth;
e916b390 385 unsigned int iodepth_low;
cb5ab512 386 unsigned int iodepth_batch;
ebac4655 387 os_cpu_mask_t cpumask;
aea47d44 388 unsigned int iolog;
843a7413 389 unsigned int read_iolog;
a6ccc7be
JA
390 unsigned int rwmixcycle;
391 unsigned int rwmixread;
e1f36503 392 unsigned int rwmixwrite;
b6f4d880 393 unsigned int nice;
0aabe160 394 unsigned int file_service_type;
b2560f3c 395 unsigned int group_reporting;
b5af8293 396 unsigned int open_files;
bbf6b540 397 char *opendir;
aea47d44 398
076efc7c
JA
399 char *read_iolog_file;
400 char *write_iolog_file;
843a7413
JA
401 void *iolog_buf;
402 FILE *iolog_f;
ebac4655 403
da86774e 404 char *sysfs_root;
da86774e
JA
405 char *ioscheduler;
406
6dfd46b9
JA
407 os_random_state_t bsrange_state;
408 os_random_state_t verify_state;
ebac4655
JA
409
410 int shm_id;
411
e9c047a0
JA
412 /*
413 * IO engine hooks, contains everything needed to submit an io_u
414 * to any of the available IO engines.
415 */
2866c82d 416 struct ioengine_ops *io_ops;
ebac4655 417
e9c047a0
JA
418 /*
419 * Current IO depth and list of free and busy io_u's.
420 */
ebac4655
JA
421 unsigned int cur_depth;
422 struct list_head io_u_freelist;
423 struct list_head io_u_busylist;
755200a3 424 struct list_head io_u_requeues;
cb5ab512 425 unsigned int io_u_queued;
ebac4655 426
e9c047a0
JA
427 /*
428 * Rate state
429 */
ebac4655
JA
430 unsigned int rate;
431 unsigned int ratemin;
432 unsigned int ratecycle;
433 unsigned long rate_usec_cycle;
434 long rate_pending_usleep;
435 unsigned long rate_bytes;
436 struct timeval lastrate;
437
ebac4655 438 unsigned long long io_size;
53cdc686
JA
439 unsigned long long total_file_size;
440 unsigned long long start_offset;
ebac4655
JA
441 unsigned long long total_io_size;
442
755200a3 443 unsigned long io_issues[2];
9104f874
JA
444 unsigned long long io_blocks[2];
445 unsigned long long io_bytes[2];
9104f874 446 unsigned long long this_io_bytes[2];
079ad09b 447 unsigned long long zone_bytes;
07739b57 448 struct fio_sem *mutex;
ebac4655 449
e9c047a0
JA
450 /*
451 * State for random io, a bitmap of blocks done vs not done
452 */
6dfd46b9 453 os_random_state_t random_state;
ebac4655 454
b990b5c0
JA
455 /*
456 * CPU "io" cycle burner
457 */
458 unsigned int cpuload;
459 unsigned int cpucycle;
460
ebac4655
JA
461 struct timeval start; /* start of this loop */
462 struct timeval epoch; /* time job was started */
463
e9c047a0
JA
464 /*
465 * read/write mixed workload state
466 */
6dfd46b9 467 os_random_state_t rwmix_state;
a6ccc7be 468 struct timeval rwmix_switch;
e9c047a0 469 enum fio_ddir rwmix_ddir;
a6ccc7be 470
4e0ba8af
JA
471 /*
472 * Pre-run and post-run shell
473 */
474 char *exec_prerun;
475 char *exec_postrun;
476
e9c047a0
JA
477 /*
478 * IO historic logs
479 */
ebac4655 480 struct list_head io_hist_list;
aea47d44 481 struct list_head io_log_list;
433afcb4
JA
482
483 /*
484 * timeout handling
485 */
486 struct timeval timeout_end;
487 struct itimerval timer;
1907dbc6
JA
488
489 /*
490 * for fileservice, how often to switch to a new file
491 */
492 unsigned int file_service_nr;
493 unsigned int file_service_left;
494 struct fio_file *file_service_file;
9c60ce64
JA
495
496 /*
497 * For generating file sizes
498 */
499 os_random_state_t file_size_state;
500 unsigned long long file_size_low;
501 unsigned long long file_size_high;
ebac4655
JA
502};
503
0aabe160
JA
504/*
505 * roundrobin available files, or choose one at random.
506 */
507enum {
508 FIO_FSERVICE_RANDOM = 1,
509 FIO_FSERVICE_RR = 2,
510};
511
433afcb4
JA
512/*
513 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
514 * the timer on each queue operation.
515 */
516#define IO_U_TIMEOUT_INC 5
517#define IO_U_TIMEOUT 30
518
e1161c32 519#define __td_verror(td, err, msg, func) \
ebac4655 520 do { \
19abcd3d
JA
521 if ((td)->error) \
522 break; \
ebac4655
JA
523 int e = (err); \
524 (td)->error = e; \
e1161c32 525 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
526 } while (0)
527
b990b5c0 528
e1161c32
JA
529#define td_verror(td, err, func) \
530 __td_verror((td), (err), strerror((err)), (func))
531#define td_vmsg(td, err, msg, func) \
532 __td_verror((td), (err), (msg), (func))
b990b5c0 533
ebac4655
JA
534extern int exitall_on_terminate;
535extern int thread_number;
9cedf167 536extern int nr_process, nr_thread;
ebac4655
JA
537extern int shm_id;
538extern int groupid;
c6ae0a5b 539extern int terse_output;
eb8bbf48
JA
540extern FILE *f_out;
541extern FILE *f_err;
53cdc686 542extern int temp_stall_ts;
1e97cce9 543extern unsigned long long mlock_size;
cfc99db7 544extern unsigned long page_mask, page_size;
ebac4655
JA
545
546extern struct thread_data *threads;
547
413dd459
JA
548#define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
549#define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
550#define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
551#define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
ebac4655
JA
552
553#define BLOCKS_PER_MAP (8 * sizeof(long))
a00735e6 554#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
53cdc686
JA
555#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
556#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
557
558#define MAX_JOBS (1024)
559
87dc1ab1
JA
560static inline int should_fsync(struct thread_data *td)
561{
562 if (td->last_was_sync)
563 return 0;
564 if (td->odirect)
565 return 0;
566 if (td_write(td) || td_rw(td) || td->override_sync)
567 return 1;
568
569 return 0;
570}
571
1c9e06ee
JA
572/*
573 * Disk utils as read in /sys/block/<dev>/stat
574 */
ebac4655
JA
575struct disk_util_stat {
576 unsigned ios[2];
577 unsigned merges[2];
578 unsigned long long sectors[2];
579 unsigned ticks[2];
580 unsigned io_ticks;
581 unsigned time_in_queue;
582};
583
1c9e06ee
JA
584/*
585 * Per-device disk util management
586 */
ebac4655
JA
587struct disk_util {
588 struct list_head list;
589
590 char *name;
591 char path[256];
592 dev_t dev;
593
594 struct disk_util_stat dus;
595 struct disk_util_stat last_dus;
596
597 unsigned long msec;
598 struct timeval time;
599};
600
ebac4655
JA
601#define DISK_UTIL_MSEC (250)
602
6a0106a0
JA
603#ifndef min
604#define min(a, b) ((a) < (b) ? (a) : (b))
605#endif
a00735e6
JA
606#ifndef max
607#define max(a, b) ((a) > (b) ? (a) : (b))
608#endif
6a0106a0 609
6796209a
JA
610/*
611 * Log exports
612 */
72cb971b 613extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
6796209a 614extern void write_iolog_put(struct thread_data *, struct io_u *);
72cb971b 615extern int __must_check init_iolog(struct thread_data *td);
6796209a
JA
616extern void log_io_piece(struct thread_data *, struct io_u *);
617extern void prune_io_piece_log(struct thread_data *);
618extern void write_iolog_close(struct thread_data *);
619
620/*
621 * Logging
622 */
1e97cce9
JA
623extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
624extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
625extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
6796209a
JA
626extern void show_run_stats(void);
627extern void init_disk_util(struct thread_data *);
628extern void update_rusage_stat(struct thread_data *);
629extern void update_io_ticks(void);
630extern void disk_util_timer_arm(void);
8914a9d8
JA
631extern void setup_log(struct io_log **);
632extern void finish_log(struct thread_data *, struct io_log *, const char *);
bb3884d8 633extern void __finish_log(struct io_log *, const char *);
8914a9d8 634extern int setup_rate(struct thread_data *);
bb3884d8
JA
635extern struct io_log *agg_io_log[2];
636extern int write_bw_log;
637extern void add_agg_sample(unsigned long, enum fio_ddir);
6796209a
JA
638
639/*
640 * Time functions
641 */
642extern unsigned long utime_since(struct timeval *, struct timeval *);
69008999 643extern unsigned long utime_since_now(struct timeval *);
6796209a
JA
644extern unsigned long mtime_since(struct timeval *, struct timeval *);
645extern unsigned long mtime_since_now(struct timeval *);
646extern unsigned long time_since_now(struct timeval *);
263e529f 647extern unsigned long mtime_since_genesis(void);
b990b5c0 648extern void __usec_sleep(unsigned int);
6796209a 649extern void usec_sleep(struct thread_data *, unsigned long);
413dd459 650extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
6043c579 651extern void fill_start_time(struct timeval *);
02bcaa8c 652extern void fio_gettime(struct timeval *, void *);
a2f77c9f 653extern void set_genesis_time(void);
6796209a 654
8914a9d8
JA
655/*
656 * Init functions
657 */
72cb971b 658extern int __must_check parse_options(int, char **);
8914a9d8 659
53cdc686
JA
660/*
661 * File setup/shutdown
662 */
663extern void close_files(struct thread_data *);
b2fdda43
JA
664extern int __must_check setup_files(struct thread_data *);
665extern int __must_check open_files(struct thread_data *);
666extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
b5af8293
JA
667extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
668extern void generic_close_file(struct thread_data *, struct fio_file *);
af52b345 669extern void add_file(struct thread_data *, const char *);
0ad920e7
JA
670extern void get_file(struct fio_file *);
671extern void put_file(struct thread_data *, struct fio_file *);
bbf6b540 672extern int add_dir_files(struct thread_data *, const char *);
53cdc686 673
263e529f
JA
674/*
675 * ETA/status stuff
676 */
677extern void print_thread_status(void);
678extern void print_status_init(int);
679
680/*
681 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
682 * will never back again. It may cycle between running/verififying/fsyncing.
683 * Once the thread reaches TD_EXITED, it is just waiting for the core to
684 * reap it.
685 */
686enum {
687 TD_NOT_CREATED = 0,
688 TD_CREATED,
689 TD_INITIALIZED,
690 TD_RUNNING,
691 TD_VERIFYING,
692 TD_FSYNCING,
693 TD_EXITED,
694 TD_REAPED,
695};
696
e29d1b70
JA
697/*
698 * Verify helpers
699 */
700extern void populate_verify_io_u(struct thread_data *, struct io_u *);
b2fdda43
JA
701extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
702extern int __must_check verify_io_u(struct io_u *);
e29d1b70 703
2f9ade3c
JA
704/*
705 * Memory helpers
706 */
b2fdda43 707extern int __must_check fio_pin_memory(void);
2f9ade3c 708extern void fio_unpin_memory(void);
b2fdda43 709extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
710extern void free_io_mem(struct thread_data *);
711
10ba535a
JA
712/*
713 * io unit handling
714 */
715#define queue_full(td) list_empty(&(td)->io_u_freelist)
716extern struct io_u *__get_io_u(struct thread_data *);
3d7c391d 717extern struct io_u *get_io_u(struct thread_data *);
10ba535a 718extern void put_io_u(struct thread_data *, struct io_u *);
755200a3 719extern void requeue_io_u(struct thread_data *, struct io_u **);
d7762cf8
JA
720extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
721extern long __must_check io_u_queued_complete(struct thread_data *, int);
7e77dd02 722extern void io_u_queued(struct thread_data *, struct io_u *);
5451792e 723extern void io_u_log_error(struct thread_data *, struct io_u *);
433afcb4
JA
724extern void io_u_init_timeout(void);
725extern void io_u_set_timeout(struct thread_data *);
b3605062 726extern void io_u_mark_depth(struct thread_data *, struct io_u *);
10ba535a
JA
727
728/*
729 * io engine entry points
730 */
b2fdda43
JA
731extern int __must_check td_io_init(struct thread_data *);
732extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
733extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
734extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
735extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
736extern int __must_check td_io_commit(struct thread_data *);
b5af8293
JA
737extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
738extern void td_io_close_file(struct thread_data *, struct fio_file *);
10ba535a 739
3b70d7e5
JA
740/*
741 * If logging output to a file, stderr should go to both stderr and f_err
742 */
743#define log_err(args...) do { \
744 fprintf(f_err, ##args); \
745 if (f_err != stderr) \
746 fprintf(stderr, ##args); \
747 } while (0)
748
9c60ce64
JA
749#define log_info(args...) fprintf(f_out, ##args)
750
9728ce37
JB
751FILE *get_f_out(void);
752FILE *get_f_err(void);
753
2866c82d 754struct ioengine_ops {
5f350952 755 struct list_head list;
2866c82d
JA
756 char name[16];
757 int version;
758 int flags;
ea2877a4 759 int (*setup)(struct thread_data *);
2866c82d
JA
760 int (*init)(struct thread_data *);
761 int (*prep)(struct thread_data *, struct io_u *);
762 int (*queue)(struct thread_data *, struct io_u *);
755200a3 763 int (*commit)(struct thread_data *);
2866c82d
JA
764 int (*getevents)(struct thread_data *, int, int, struct timespec *);
765 struct io_u *(*event)(struct thread_data *, int);
766 int (*cancel)(struct thread_data *, struct io_u *);
767 void (*cleanup)(struct thread_data *);
b5af8293
JA
768 int (*open_file)(struct thread_data *, struct fio_file *);
769 void (*close_file)(struct thread_data *, struct fio_file *);
2866c82d
JA
770 void *data;
771 void *dlhandle;
772};
773
b5af8293 774#define FIO_IOOPS_VERSION 6
2866c82d 775
b4692828 776extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
b2fdda43 777extern void register_ioengine(struct ioengine_ops *);
5f350952 778extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
779extern void close_ioengine(struct thread_data *);
780
781/*
782 * Mark unused variables passed to ops functions as unused, to silence gcc
783 */
784#define fio_unused __attribute((__unused__))
5f350952
JA
785#define fio_init __attribute__((constructor))
786#define fio_exit __attribute__((destructor))
2866c82d 787
34572e28
JA
788#define for_each_td(td, i) \
789 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 790#define for_each_file(td, f, i) \
1c178180 791 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->nr_files; (i)++, (f)++)
53cdc686 792
0032bf9f
JA
793#define fio_assert(td, cond) do { \
794 if (!(cond)) { \
340fd243 795 int *__foo = NULL; \
0032bf9f
JA
796 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
797 (td)->runstate = TD_EXITED; \
437c9b71 798 (td)->error = EFAULT; \
340fd243 799 *__foo = 0; \
0032bf9f
JA
800 } \
801} while (0)
802
ebac4655 803#endif