[PATCH] Always open the files from the job itself
[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"
20
21struct io_stat {
22 unsigned long val;
23 unsigned long val_sq;
24 unsigned long max_val;
25 unsigned long min_val;
26 unsigned long samples;
27};
28
29struct io_sample {
30 unsigned long time;
31 unsigned long val;
32 unsigned int ddir;
33};
34
35struct io_log {
36 unsigned long nr_samples;
37 unsigned long max_samples;
38 struct io_sample *log;
39};
40
41struct io_piece {
42 struct list_head list;
53cdc686 43 struct fio_file *file;
ebac4655
JA
44 unsigned long long offset;
45 unsigned int len;
aea47d44 46 int ddir;
ebac4655
JA
47};
48
49/*
50 * The io unit
51 */
52struct io_u {
53 union {
54#ifdef FIO_HAVE_LIBAIO
55 struct iocb iocb;
56#endif
57#ifdef FIO_HAVE_POSIXAIO
58 struct aiocb aiocb;
59#endif
60#ifdef FIO_HAVE_SGIO
61 struct sg_io_hdr hdr;
62#endif
63 };
64 struct timeval start_time;
65 struct timeval issue_time;
66
6b9cea23 67 void *buf;
ebac4655
JA
68 unsigned int buflen;
69 unsigned long long offset;
70
71 unsigned int resid;
72 unsigned int error;
73
ebac4655
JA
74 unsigned char ddir;
75
dfd7bc2c
JA
76 /*
77 * io engine private data
78 */
79 union {
80 unsigned int index;
81 unsigned int seen;
82 };
83
53cdc686
JA
84 struct fio_file *file;
85
ebac4655
JA
86 struct list_head list;
87};
88
89#define FIO_HDR_MAGIC 0xf00baaef
90
91enum {
92 VERIFY_NONE = 0,
93 VERIFY_MD5,
94 VERIFY_CRC32,
95};
96
97struct verify_header {
98 unsigned int fio_magic;
99 unsigned int len;
100 unsigned int verify_type;
101 union {
102 char md5_digest[MD5_HASH_WORDS * 4];
103 unsigned long crc32;
104 };
105};
106
107struct group_run_stats {
9104f874
JA
108 unsigned long long max_run[2], min_run[2];
109 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 110 unsigned long long io_kb[2];
9104f874 111 unsigned long long agg[2];
ebac4655
JA
112};
113
e9c047a0
JA
114enum fio_ddir {
115 DDIR_READ = 0,
116 DDIR_WRITE,
87dc1ab1 117 DDIR_SYNC,
e9c047a0
JA
118};
119
120/*
121 * What type of allocation to use for io buffers
122 */
123enum fio_memtype {
124 MEM_MALLOC = 0, /* ordinary malloc */
125 MEM_SHM, /* use shared memory segments */
126 MEM_MMAP, /* use anonynomous mmap */
127};
128
129/*
130 * The type of object we are working on
131 */
132enum fio_filetype {
133 FIO_TYPE_FILE = 1,
134 FIO_TYPE_BD,
135 FIO_TYPE_CHAR,
136};
137
2866c82d 138enum fio_ioengine_flags {
e9c047a0 139 FIO_SYNCIO = 1 << 0,
2866c82d
JA
140 FIO_CPUIO = 1 << 1,
141 FIO_MMAPIO = 1 << 2,
b2a15192 142 FIO_RAWIO = 1 << 3,
e9c047a0
JA
143};
144
53cdc686
JA
145struct fio_file {
146 /*
147 * A file may not be a file descriptor, let the io engine decide
148 */
149 union {
150 unsigned long file_data;
151 int fd;
152 };
153 char *file_name;
154 void *mmap;
155 unsigned long long file_size;
156 unsigned long long real_file_size;
157 unsigned long long file_offset;
158 unsigned long long last_pos;
159
160 unsigned long *file_map;
161 unsigned int num_maps;
162};
163
e9c047a0
JA
164/*
165 * This describes a single thread/process executing a fio job.
166 */
ebac4655 167struct thread_data {
b4692828 168 char *name;
ef899b63 169 char *directory;
13f8e2d2 170 char *filename;
ebac4655
JA
171 char verror[80];
172 pthread_t thread;
173 int thread_number;
174 int groupid;
e9c047a0 175 enum fio_filetype filetype;
53cdc686
JA
176 struct fio_file *files;
177 unsigned int nr_files;
13f8e2d2 178 unsigned int nr_uniq_files;
53cdc686 179 unsigned int next_file;
ebac4655 180 int error;
ebac4655
JA
181 pid_t pid;
182 char *orig_buffer;
183 size_t orig_buffer_size;
184 volatile int terminate;
185 volatile int runstate;
e9c047a0 186 enum fio_ddir ddir;
3d60d1ed 187 unsigned int iomix;
ebac4655 188 unsigned int ioprio;
87dc1ab1 189 unsigned int last_was_sync;
e9c047a0 190
9158d2f7
JA
191 unsigned int sequential;
192 unsigned int odirect;
193 unsigned int invalidate_cache;
194 unsigned int create_serialize;
195 unsigned int create_fsync;
196 unsigned int end_fsync;
197 unsigned int sync_io;
198 unsigned int verify;
199 unsigned int use_thread;
200 unsigned int unlink;
201 unsigned int do_disk_util;
202 unsigned int override_sync;
203 unsigned int rand_repeatable;
204 unsigned int write_lat_log;
205 unsigned int write_bw_log;
bb8895e0 206 unsigned int norandommap;
690adba3 207 unsigned int bs_unaligned;
e9c047a0 208
a00735e6
JA
209 unsigned int bs[2];
210 unsigned int min_bs[2];
211 unsigned int max_bs[2];
212 unsigned int rw_min_bs;
ebac4655
JA
213 unsigned int thinktime;
214 unsigned int fsync_blocks;
215 unsigned int start_delay;
906c8d75 216 unsigned long timeout;
ebac4655 217 unsigned int overwrite;
ebac4655 218 unsigned int bw_avg_time;
ebac4655 219 unsigned int loops;
20dc95c4
JA
220 unsigned long long zone_size;
221 unsigned long long zone_skip;
e9c047a0 222 enum fio_memtype mem_type;
ebac4655
JA
223 unsigned int stonewall;
224 unsigned int numjobs;
ebac4655
JA
225 unsigned int iodepth;
226 os_cpu_mask_t cpumask;
aea47d44 227 unsigned int iolog;
843a7413 228 unsigned int read_iolog;
a6ccc7be
JA
229 unsigned int rwmixcycle;
230 unsigned int rwmixread;
e1f36503 231 unsigned int rwmixwrite;
b6f4d880 232 unsigned int nice;
aea47d44 233
076efc7c
JA
234 char *read_iolog_file;
235 char *write_iolog_file;
843a7413
JA
236 void *iolog_buf;
237 FILE *iolog_f;
ebac4655 238
da86774e 239 char *sysfs_root;
da86774e
JA
240 char *ioscheduler;
241
6dfd46b9
JA
242 os_random_state_t bsrange_state;
243 os_random_state_t verify_state;
ebac4655
JA
244
245 int shm_id;
246
e9c047a0
JA
247 /*
248 * IO engine hooks, contains everything needed to submit an io_u
249 * to any of the available IO engines.
250 */
2866c82d 251 struct ioengine_ops *io_ops;
ebac4655 252
e9c047a0
JA
253 /*
254 * Current IO depth and list of free and busy io_u's.
255 */
ebac4655
JA
256 unsigned int cur_depth;
257 struct list_head io_u_freelist;
258 struct list_head io_u_busylist;
259
e9c047a0
JA
260 /*
261 * Rate state
262 */
ebac4655
JA
263 unsigned int rate;
264 unsigned int ratemin;
265 unsigned int ratecycle;
266 unsigned long rate_usec_cycle;
267 long rate_pending_usleep;
268 unsigned long rate_bytes;
269 struct timeval lastrate;
270
271 unsigned long runtime[2]; /* msec */
272 unsigned long long io_size;
53cdc686
JA
273 unsigned long long total_file_size;
274 unsigned long long start_offset;
ebac4655
JA
275 unsigned long long total_io_size;
276
9104f874
JA
277 unsigned long long io_blocks[2];
278 unsigned long long io_bytes[2];
279 unsigned long long zone_bytes;
280 unsigned long long this_io_bytes[2];
bbfd6b00 281 volatile int mutex;
ebac4655 282
e9c047a0
JA
283 /*
284 * State for random io, a bitmap of blocks done vs not done
285 */
6dfd46b9 286 os_random_state_t random_state;
ebac4655 287
b990b5c0
JA
288 /*
289 * CPU "io" cycle burner
290 */
291 unsigned int cpuload;
292 unsigned int cpucycle;
293
ebac4655
JA
294 /*
295 * bandwidth and latency stats
296 */
297 struct io_stat clat_stat[2]; /* completion latency */
298 struct io_stat slat_stat[2]; /* submission latency */
299 struct io_stat bw_stat[2]; /* bandwidth stats */
300
9104f874 301 unsigned long long stat_io_bytes[2];
ebac4655
JA
302 struct timeval stat_sample_time[2];
303
304 struct io_log *slat_log;
305 struct io_log *clat_log;
306 struct io_log *bw_log;
307
308 struct timeval start; /* start of this loop */
309 struct timeval epoch; /* time job was started */
310
e9c047a0
JA
311 /*
312 * fio system usage accounting
313 */
ebac4655
JA
314 struct rusage ru_start;
315 struct rusage ru_end;
316 unsigned long usr_time;
317 unsigned long sys_time;
318 unsigned long ctx;
319
e9c047a0
JA
320 /*
321 * read/write mixed workload state
322 */
6dfd46b9 323 os_random_state_t rwmix_state;
a6ccc7be 324 struct timeval rwmix_switch;
e9c047a0 325 enum fio_ddir rwmix_ddir;
a6ccc7be 326
4e0ba8af
JA
327 /*
328 * Pre-run and post-run shell
329 */
330 char *exec_prerun;
331 char *exec_postrun;
332
e9c047a0
JA
333 /*
334 * IO historic logs
335 */
ebac4655 336 struct list_head io_hist_list;
aea47d44 337 struct list_head io_log_list;
ebac4655
JA
338};
339
b990b5c0 340#define __td_verror(td, err, msg) \
ebac4655
JA
341 do { \
342 int e = (err); \
343 (td)->error = e; \
b990b5c0 344 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
ebac4655
JA
345 } while (0)
346
b990b5c0
JA
347
348#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
349#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
350
ebac4655
JA
351extern int exitall_on_terminate;
352extern int thread_number;
353extern int shm_id;
354extern int groupid;
c6ae0a5b 355extern int terse_output;
eb8bbf48
JA
356extern FILE *f_out;
357extern FILE *f_err;
3c9b60c1 358extern const char *fio_inst_prefix;
53cdc686 359extern int temp_stall_ts;
ebac4655
JA
360
361extern struct thread_data *threads;
362
ebac4655
JA
363#define td_read(td) ((td)->ddir == DDIR_READ)
364#define td_write(td) ((td)->ddir == DDIR_WRITE)
3d60d1ed 365#define td_rw(td) ((td)->iomix != 0)
ebac4655
JA
366
367#define BLOCKS_PER_MAP (8 * sizeof(long))
a00735e6 368#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
53cdc686
JA
369#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
370#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
371
372#define MAX_JOBS (1024)
373
87dc1ab1
JA
374static inline int should_fsync(struct thread_data *td)
375{
376 if (td->last_was_sync)
377 return 0;
378 if (td->odirect)
379 return 0;
380 if (td_write(td) || td_rw(td) || td->override_sync)
381 return 1;
382
383 return 0;
384}
385
ebac4655
JA
386struct disk_util_stat {
387 unsigned ios[2];
388 unsigned merges[2];
389 unsigned long long sectors[2];
390 unsigned ticks[2];
391 unsigned io_ticks;
392 unsigned time_in_queue;
393};
394
395struct disk_util {
396 struct list_head list;
397
398 char *name;
399 char path[256];
400 dev_t dev;
401
402 struct disk_util_stat dus;
403 struct disk_util_stat last_dus;
404
405 unsigned long msec;
406 struct timeval time;
407};
408
409struct io_completion_data {
410 int nr; /* input */
411
412 int error; /* output */
413 unsigned long bytes_done[2]; /* output */
414};
415
416#define DISK_UTIL_MSEC (250)
417
6a0106a0
JA
418#ifndef min
419#define min(a, b) ((a) < (b) ? (a) : (b))
420#endif
a00735e6
JA
421#ifndef max
422#define max(a, b) ((a) > (b) ? (a) : (b))
423#endif
6a0106a0 424
6796209a
JA
425/*
426 * Log exports
427 */
428extern int read_iolog_get(struct thread_data *, struct io_u *);
429extern void write_iolog_put(struct thread_data *, struct io_u *);
430extern int init_iolog(struct thread_data *td);
431extern void log_io_piece(struct thread_data *, struct io_u *);
432extern void prune_io_piece_log(struct thread_data *);
433extern void write_iolog_close(struct thread_data *);
434
435/*
436 * Logging
437 */
438extern void add_clat_sample(struct thread_data *, int, unsigned long);
439extern void add_slat_sample(struct thread_data *, int, unsigned long);
440extern void add_bw_sample(struct thread_data *, int);
441extern void show_run_stats(void);
442extern void init_disk_util(struct thread_data *);
443extern void update_rusage_stat(struct thread_data *);
444extern void update_io_ticks(void);
445extern void disk_util_timer_arm(void);
8914a9d8
JA
446extern void setup_log(struct io_log **);
447extern void finish_log(struct thread_data *, struct io_log *, const char *);
448extern int setup_rate(struct thread_data *);
6796209a
JA
449
450/*
451 * Time functions
452 */
263e529f 453extern void time_init(void);
6796209a
JA
454extern unsigned long utime_since(struct timeval *, struct timeval *);
455extern unsigned long mtime_since(struct timeval *, struct timeval *);
456extern unsigned long mtime_since_now(struct timeval *);
457extern unsigned long time_since_now(struct timeval *);
263e529f 458extern unsigned long mtime_since_genesis(void);
b990b5c0 459extern void __usec_sleep(unsigned int);
6796209a 460extern void usec_sleep(struct thread_data *, unsigned long);
a00735e6 461extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
6043c579 462extern void fill_start_time(struct timeval *);
6796209a 463
8914a9d8
JA
464/*
465 * Init functions
466 */
467extern int parse_options(int, char **);
468extern int init_random_state(struct thread_data *);
469
53cdc686
JA
470/*
471 * File setup/shutdown
472 */
473extern void close_files(struct thread_data *);
474extern int setup_files(struct thread_data *);
21972cde 475extern int open_files(struct thread_data *);
e5b401d4 476extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
53cdc686 477
263e529f
JA
478/*
479 * ETA/status stuff
480 */
481extern void print_thread_status(void);
482extern void print_status_init(int);
483
484/*
485 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
486 * will never back again. It may cycle between running/verififying/fsyncing.
487 * Once the thread reaches TD_EXITED, it is just waiting for the core to
488 * reap it.
489 */
490enum {
491 TD_NOT_CREATED = 0,
492 TD_CREATED,
493 TD_INITIALIZED,
494 TD_RUNNING,
495 TD_VERIFYING,
496 TD_FSYNCING,
497 TD_EXITED,
498 TD_REAPED,
499};
500
e29d1b70
JA
501/*
502 * Verify helpers
503 */
504extern void populate_verify_io_u(struct thread_data *, struct io_u *);
505extern int get_next_verify(struct thread_data *td, struct io_u *);
a9619d44 506extern int do_io_u_verify(struct thread_data *, struct io_u **);
e29d1b70 507
2f9ade3c
JA
508/*
509 * Memory helpers
510 */
511extern int fio_pin_memory(void);
512extern void fio_unpin_memory(void);
513extern int allocate_io_mem(struct thread_data *);
514extern void free_io_mem(struct thread_data *);
515
10ba535a
JA
516/*
517 * io unit handling
518 */
519#define queue_full(td) list_empty(&(td)->io_u_freelist)
520extern struct io_u *__get_io_u(struct thread_data *);
521extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
522extern void put_io_u(struct thread_data *, struct io_u *);
523extern void ios_completed(struct thread_data *, struct io_completion_data *);
524extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
525
526/*
527 * io engine entry points
528 */
8c16d840 529extern int td_io_init(struct thread_data *);
10ba535a
JA
530extern int td_io_prep(struct thread_data *, struct io_u *);
531extern int td_io_queue(struct thread_data *, struct io_u *);
532extern int td_io_sync(struct thread_data *, struct fio_file *);
533extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
534
bbfd6b00
JA
535/*
536 * This is a pretty crappy semaphore implementation, but with the use that fio
537 * has (just signalling start/go conditions), it doesn't have to be better.
538 * Naturally this would not work for any type of contended semaphore or
539 * for real locking.
540 */
1056eaad 541static inline void fio_sem_init(volatile int *sem, int val)
bbfd6b00
JA
542{
543 *sem = val;
544}
545
1056eaad 546static inline void fio_sem_down(volatile int *sem)
bbfd6b00
JA
547{
548 while (*sem == 0)
549 usleep(10000);
550
551 (*sem)--;
552}
553
1056eaad 554static inline void fio_sem_up(volatile int *sem)
bbfd6b00
JA
555{
556 (*sem)++;
557}
558
3b70d7e5
JA
559/*
560 * If logging output to a file, stderr should go to both stderr and f_err
561 */
562#define log_err(args...) do { \
563 fprintf(f_err, ##args); \
564 if (f_err != stderr) \
565 fprintf(stderr, ##args); \
566 } while (0)
567
2866c82d 568struct ioengine_ops {
5f350952 569 struct list_head list;
2866c82d
JA
570 char name[16];
571 int version;
572 int flags;
ea2877a4 573 int (*setup)(struct thread_data *);
2866c82d
JA
574 int (*init)(struct thread_data *);
575 int (*prep)(struct thread_data *, struct io_u *);
576 int (*queue)(struct thread_data *, struct io_u *);
577 int (*getevents)(struct thread_data *, int, int, struct timespec *);
578 struct io_u *(*event)(struct thread_data *, int);
579 int (*cancel)(struct thread_data *, struct io_u *);
580 void (*cleanup)(struct thread_data *);
2866c82d
JA
581 void *data;
582 void *dlhandle;
583};
584
87dc1ab1 585#define FIO_IOOPS_VERSION 3
2866c82d 586
b4692828 587extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
5f350952
JA
588extern int register_ioengine(struct ioengine_ops *);
589extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
590extern void close_ioengine(struct thread_data *);
591
592/*
593 * Mark unused variables passed to ops functions as unused, to silence gcc
594 */
595#define fio_unused __attribute((__unused__))
5f350952
JA
596#define fio_init __attribute__((constructor))
597#define fio_exit __attribute__((destructor))
2866c82d 598
34572e28
JA
599#define for_each_td(td, i) \
600 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 601#define for_each_file(td, f, i) \
34572e28 602 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
53cdc686 603
ebac4655 604#endif