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