Catch the case where size= is less than the minimum block size
[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>
cd14cc10 14#include <inttypes.h>
7101d9c2 15#include <assert.h>
ebac4655 16
317b95d0 17#include "compiler/compiler.h"
8062f527 18#include "thread_options.h"
01743ee1 19#include "flist.h"
e2887563 20#include "fifo.h"
317b95d0
JA
21#include "arch/arch.h"
22#include "os/os.h"
07739b57 23#include "mutex.h"
a3d741fa
JA
24#include "log.h"
25#include "debug.h"
d6aed795
JA
26#include "file.h"
27#include "io_ddir.h"
dcefb588 28#include "ioengine.h"
5995a6a4 29#include "iolog.h"
c5c8bd5c 30#include "helpers.h"
07b3232d 31#include "options.h"
7eb36574 32#include "profile.h"
c223da83 33#include "time.h"
a7346816 34#include "gettime.h"
bf2e821a 35#include "lib/getopt.h"
2615cc4b 36#include "lib/rand.h"
7fb6d453 37#include "lib/rbtree.h"
dd366728 38#include "client.h"
37db14fe 39#include "server.h"
a64e88da 40#include "stat.h"
9e684a49 41#include "flow.h"
ebac4655 42
4700b234 43#ifdef CONFIG_SOLARISAIO
417f0068
JA
44#include <sys/asynch.h>
45#endif
46
67bf9823 47#ifdef CONFIG_LIBNUMA
d0b937ed
YR
48#include <linux/mempolicy.h>
49#include <numa.h>
50
51/*
52 * "local" is pseudo-policy
53 */
54#define MPOL_LOCAL MPOL_MAX
55#endif
56
38dad62d
JA
57/*
58 * offset generator types
59 */
60enum {
61 RW_SEQ_SEQ = 0,
62 RW_SEQ_IDENT,
63};
64
d72be545
JA
65enum {
66 TD_F_VER_BACKLOG = 1,
67 TD_F_TRIM_BACKLOG = 2,
68 TD_F_READ_IOLOG = 4,
69 TD_F_REFILL_BUFFERS = 8,
70 TD_F_SCRAMBLE_BUFFERS = 16,
71 TD_F_VER_NONE = 32,
72 TD_F_PROFILE_OPS = 64,
73};
74
d24945f0
JA
75enum {
76 FIO_RAND_BS_OFF = 0,
77 FIO_RAND_VER_OFF,
78 FIO_RAND_MIX_OFF,
79 FIO_RAND_FILE_OFF,
80 FIO_RAND_BLOCK_OFF,
81 FIO_RAND_FILE_SIZE_OFF,
82 FIO_RAND_TRIM_OFF,
83 FIO_RAND_BUF_OFF,
84 FIO_RAND_NR_OFFS,
85};
86
2dc1bbeb
JA
87/*
88 * This describes a single thread/process executing a fio job.
89 */
90struct thread_data {
91 struct thread_options o;
d72be545 92 unsigned long flags;
de890a1e 93 void *eo;
e4e33258 94 char verror[FIO_VERROR_SIZE];
2dc1bbeb 95 pthread_t thread;
2f122b13
JA
96 unsigned int thread_number;
97 unsigned int groupid;
2dc1bbeb 98 struct thread_stat ts;
7b9f733a 99
46bcd498
JA
100 int client_type;
101
7b9f733a
JA
102 struct io_log *slat_log;
103 struct io_log *clat_log;
104 struct io_log *lat_log;
105 struct io_log *bw_log;
c8eeb9df 106 struct io_log *iops_log;
7b9f733a 107
6eaf09d6 108 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
c8eeb9df
JA
109 struct timeval bw_sample_time;
110
6eaf09d6 111 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
c8eeb9df 112 struct timeval iops_sample_time;
f0505a14 113
c97f1ad6
JA
114 volatile int update_rusage;
115 struct fio_mutex *rusage_sem;
c8aaba19
JA
116 struct rusage ru_start;
117 struct rusage ru_end;
118
126d65c6 119 struct fio_file **files;
d7df1d13 120 unsigned char *file_locks;
dd87b2c9 121 unsigned int files_size;
2dc1bbeb
JA
122 unsigned int files_index;
123 unsigned int nr_open_files;
1020a139 124 unsigned int nr_done_files;
2dc1bbeb
JA
125 unsigned int nr_normal_files;
126 union {
127 unsigned int next_file;
128 os_random_state_t next_file_state;
4c07ad86 129 struct frand_state __next_file_state;
2dc1bbeb
JA
130 };
131 int error;
a5e371a6 132 int sig;
20e354ef 133 int done;
2dc1bbeb
JA
134 pid_t pid;
135 char *orig_buffer;
136 size_t orig_buffer_size;
137 volatile int terminate;
138 volatile int runstate;
2dc1bbeb 139 unsigned int last_was_sync;
9e144189 140 enum fio_ddir last_ddir;
2dc1bbeb 141
2dc1bbeb
JA
142 int mmapfd;
143
843a7413
JA
144 void *iolog_buf;
145 FILE *iolog_f;
ebac4655 146
da86774e 147 char *sysfs_root;
da86774e 148
d24945f0 149 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
5bfc35d7 150
4c07ad86
JA
151 union {
152 os_random_state_t bsrange_state;
153 struct frand_state __bsrange_state;
154 };
155 union {
156 os_random_state_t verify_state;
157 struct frand_state __verify_state;
158 };
159 union {
160 os_random_state_t trim_state;
161 struct frand_state __trim_state;
162 };
ebac4655 163
3545a109
JA
164 struct frand_state buf_state;
165
9e144189 166 unsigned int verify_batch;
0d29de83 167 unsigned int trim_batch;
9e144189 168
ebac4655
JA
169 int shm_id;
170
e9c047a0
JA
171 /*
172 * IO engine hooks, contains everything needed to submit an io_u
173 * to any of the available IO engines.
174 */
2866c82d 175 struct ioengine_ops *io_ops;
ebac4655 176
e9c047a0 177 /*
422f9e4b 178 * Queue depth of io_u's that fio MIGHT do
e9c047a0 179 */
ebac4655 180 unsigned int cur_depth;
422f9e4b
RM
181
182 /*
183 * io_u's about to be committed
184 */
d8005759 185 unsigned int io_u_queued;
422f9e4b
RM
186
187 /*
188 * io_u's submitted but not completed yet
189 */
190 unsigned int io_u_in_flight;
191
192 /*
193 * List of free and busy io_u's
194 */
01743ee1
JA
195 struct flist_head io_u_freelist;
196 struct flist_head io_u_busylist;
197 struct flist_head io_u_requeues;
e8462bd8
JA
198 pthread_mutex_t io_u_lock;
199 pthread_cond_t free_cond;
200
201 /*
202 * async verify offload
203 */
204 struct flist_head verify_list;
205 pthread_t *verify_threads;
206 unsigned int nr_verify_threads;
207 pthread_cond_t verify_cond;
208 int verify_thread_exit;
ebac4655 209
e9c047a0
JA
210 /*
211 * Rate state
212 */
bdb6d20a 213 uint64_t rate_bps[DDIR_RWDIR_CNT];
6eaf09d6
SL
214 long rate_pending_usleep[DDIR_RWDIR_CNT];
215 unsigned long rate_bytes[DDIR_RWDIR_CNT];
216 unsigned long rate_blocks[DDIR_RWDIR_CNT];
217 struct timeval lastrate[DDIR_RWDIR_CNT];
ebac4655 218
bdb6d20a
JA
219 uint64_t total_io_size;
220 uint64_t fill_device_size;
ebac4655 221
6eaf09d6 222 unsigned long io_issues[DDIR_RWDIR_CNT];
bdb6d20a
JA
223 uint64_t io_blocks[DDIR_RWDIR_CNT];
224 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
225 uint64_t io_bytes[DDIR_RWDIR_CNT];
226 uint64_t io_skip_bytes;
227 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
228 uint64_t zone_bytes;
cdd18ad8 229 struct fio_mutex *mutex;
ebac4655 230
e9c047a0
JA
231 /*
232 * State for random io, a bitmap of blocks done vs not done
233 */
4c07ad86
JA
234 union {
235 os_random_state_t random_state;
236 struct frand_state __random_state;
237 };
ebac4655 238
ebac4655
JA
239 struct timeval start; /* start of this loop */
240 struct timeval epoch; /* time job was started */
a61eddec 241 struct timeval last_issue;
993bf48b
JA
242 struct timeval tv_cache;
243 unsigned int tv_cache_nr;
244 unsigned int tv_cache_mask;
721938ae 245 unsigned int ramp_time_over;
ebac4655 246
e9c047a0
JA
247 /*
248 * read/write mixed workload state
249 */
4c07ad86
JA
250 union {
251 os_random_state_t rwmix_state;
252 struct frand_state __rwmix_state;
253 };
e4928662 254 unsigned long rwmix_issues;
e9c047a0 255 enum fio_ddir rwmix_ddir;
5736c10d 256 unsigned int ddir_seq_nr;
a6ccc7be 257
e9c047a0 258 /*
8de8f047
JA
259 * IO history logs for verification. We use a tree for sorting,
260 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 261 */
4b87898e 262 struct rb_root io_hist_tree;
01743ee1 263 struct flist_head io_hist_list;
9e144189 264 unsigned long io_hist_len;
8de8f047
JA
265
266 /*
267 * For IO replaying
268 */
01743ee1 269 struct flist_head io_log_list;
433afcb4 270
0d29de83
JA
271 /*
272 * For tracking/handling discards
273 */
274 struct flist_head trim_list;
275 unsigned long trim_entries;
276
1ae83d45
JA
277 struct flist_head next_rand_list;
278
1907dbc6
JA
279 /*
280 * for fileservice, how often to switch to a new file
281 */
282 unsigned int file_service_nr;
283 unsigned int file_service_left;
284 struct fio_file *file_service_file;
9c60ce64 285
44f29692
JA
286 unsigned int sync_file_range_nr;
287
9c60ce64
JA
288 /*
289 * For generating file sizes
290 */
4c07ad86
JA
291 union {
292 os_random_state_t file_size_state;
293 struct frand_state __file_size_state;
294 };
f2bba182
RR
295
296 /*
297 * Error counts
298 */
299 unsigned int total_err_count;
300 int first_error;
15dc1934 301
9e684a49
DE
302 struct fio_flow *flow;
303
15dc1934
JA
304 /*
305 * Can be overloaded by profiles
306 */
7eb36574 307 struct prof_io_ops prof_io_ops;
58c55ba0 308 void *prof_data;
9a3f1100
JA
309
310 void *pinned_mem;
ebac4655
JA
311};
312
e592a06b
AC
313/*
314 * when should interactive ETA output be generated
315 */
316enum {
317 FIO_ETA_AUTO,
318 FIO_ETA_ALWAYS,
319 FIO_ETA_NEVER,
320};
321
e1161c32 322#define __td_verror(td, err, msg, func) \
ebac4655 323 do { \
59358c8e 324 int e = (err); \
19abcd3d
JA
325 if ((td)->error) \
326 break; \
ebac4655 327 (td)->error = e; \
f2bba182 328 if (!(td)->first_error) \
98ffb8f3 329 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
330 } while (0)
331
b990b5c0 332
f2bba182
RR
333#define td_clear_error(td) \
334 (td)->error = 0;
e1161c32
JA
335#define td_verror(td, err, func) \
336 __td_verror((td), (err), strerror((err)), (func))
337#define td_vmsg(td, err, msg, func) \
338 __td_verror((td), (err), (msg), (func))
b990b5c0 339
81179eec
JA
340#define __fio_stringify_1(x) #x
341#define __fio_stringify(x) __fio_stringify_1(x)
342
ebac4655 343extern int exitall_on_terminate;
11e950bd 344extern unsigned int thread_number;
108fea77 345extern unsigned int stat_number;
ebac4655
JA
346extern int shm_id;
347extern int groupid;
f3afa57e 348extern int output_format;
53cdc686 349extern int temp_stall_ts;
7078106d 350extern uintptr_t page_mask, page_size;
4241ea8f 351extern int read_only;
e592a06b 352extern int eta_print;
e382e661 353extern int eta_new_line;
d3eeeabc 354extern unsigned long done_secs;
01f06b63 355extern char *job_section;
be4ecfdf
JA
356extern int fio_gtod_offload;
357extern int fio_gtod_cpu;
c223da83 358extern enum fio_cs fio_clock_source;
fa80feae 359extern int fio_clock_source_set;
a9523c6f 360extern int warnings_fatal;
f57a9c59 361extern int terse_version;
5c341e9a 362extern int is_backend;
a37f69b7 363extern int nr_clients;
e46d8091 364extern int log_syslog;
06464907 365extern int status_interval;
5e726d0a 366extern const char fio_version_string[];
ebac4655
JA
367
368extern struct thread_data *threads;
369
7101d9c2
JA
370static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
371{
372 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
373}
374
fca70358 375#define REAL_MAX_JOBS 2048
ebac4655 376
87dc1ab1
JA
377static inline int should_fsync(struct thread_data *td)
378{
379 if (td->last_was_sync)
380 return 0;
2dc1bbeb 381 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
382 return 1;
383
384 return 0;
385}
386
8914a9d8 387/*
214e1eca 388 * Init/option functions
8914a9d8 389 */
0420ba6a 390extern int __must_check fio_init_options(void);
72cb971b 391extern int __must_check parse_options(int, char **);
46bcd498
JA
392extern int parse_jobs_ini(char *, int, int, int);
393extern int parse_cmd_line(int, char **, int);
2e1df07d 394extern int fio_backend(void);
50d16976 395extern void reset_fio_state(void);
2e1df07d 396extern void clear_io_state(struct thread_data *);
3b8b7135 397extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 398extern void fio_keywords_init(void);
214e1eca 399extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 400extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
401extern void fio_fill_default_options(struct thread_data *);
402extern int fio_show_option_help(const char *);
de890a1e 403extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 404extern void fio_options_dup_and_init(struct option *);
de890a1e
SL
405extern void fio_options_mem_dupe(struct thread_data *);
406extern void options_mem_dupe(void *data, struct fio_option *options);
5bfc35d7 407extern void td_fill_rand_seeds(struct thread_data *);
46bcd498 408extern void add_job_opts(const char **, int);
73798eb2 409extern char *num2str(unsigned long, int, int, int, int);
de890a1e 410extern int ioengine_load(struct thread_data *);
1ec3d69b 411
a569b45f
JA
412extern uintptr_t page_mask;
413extern uintptr_t page_size;
414extern int initialize_fio(char *envp[]);
415
de890a1e
SL
416#define FIO_GETOPT_JOB 0x89000000
417#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d 418#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 419
263e529f
JA
420/*
421 * ETA/status stuff
422 */
423extern void print_thread_status(void);
424extern void print_status_init(int);
0a428b23 425extern char *fio_uint_to_kmg(unsigned int val);
263e529f
JA
426
427/*
428 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
429 * will never back again. It may cycle between running/verififying/fsyncing.
430 * Once the thread reaches TD_EXITED, it is just waiting for the core to
431 * reap it.
432 */
433enum {
434 TD_NOT_CREATED = 0,
435 TD_CREATED,
436 TD_INITIALIZED,
b29ee5b3 437 TD_RAMP,
36d80bc7 438 TD_SETTING_UP,
263e529f 439 TD_RUNNING,
b0f65863 440 TD_PRE_READING,
263e529f
JA
441 TD_VERIFYING,
442 TD_FSYNCING,
443 TD_EXITED,
444 TD_REAPED,
445};
446
b29ee5b3 447extern void td_set_runstate(struct thread_data *, int);
cc0df00a
JA
448#define TERMINATE_ALL (-1)
449extern void fio_terminate_threads(int);
b29ee5b3 450
2f9ade3c
JA
451/*
452 * Memory helpers
453 */
9a3f1100
JA
454extern int __must_check fio_pin_memory(struct thread_data *);
455extern void fio_unpin_memory(struct thread_data *);
b2fdda43 456extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c 457extern void free_io_mem(struct thread_data *);
2bb3f0a7 458extern void free_threads_shm(void);
2f9ade3c 459
b29ee5b3
JA
460/*
461 * Reset stats after ramp time completes
462 */
463extern void reset_all_stats(struct thread_data *);
464
fb7b71a3
JA
465/*
466 * blktrace support
467 */
5e62c22a 468#ifdef FIO_HAVE_BLKTRACE
fb7b71a3
JA
469extern int is_blktrace(const char *);
470extern int load_blktrace(struct thread_data *, const char *);
5e62c22a 471#endif
fb7b71a3 472
34572e28
JA
473#define for_each_td(td, i) \
474 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 475#define for_each_file(td, f, i) \
691c8fb0
JA
476 if ((td)->files_index) \
477 for ((i) = 0, (f) = (td)->files[0]; \
478 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
479 (i)++)
53cdc686 480
0032bf9f
JA
481#define fio_assert(td, cond) do { \
482 if (!(cond)) { \
340fd243 483 int *__foo = NULL; \
0032bf9f 484 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38 485 td_set_runstate((td), TD_EXITED); \
437c9b71 486 (td)->error = EFAULT; \
340fd243 487 *__foo = 0; \
0032bf9f
JA
488 } \
489} while (0)
490
12d9d841
JA
491static inline int fio_fill_issue_time(struct thread_data *td)
492{
493 if (td->o.read_iolog_file ||
494 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
495 return 1;
496
497 return 0;
498}
499
581e7141
JA
500static inline int __should_check_rate(struct thread_data *td,
501 enum fio_ddir ddir)
502{
503 struct thread_options *o = &td->o;
504
505 /*
506 * If some rate setting was given, we need to check it
507 */
508 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
509 o->rate_iops_min[ddir])
510 return 1;
511
512 return 0;
513}
514
515static inline int should_check_rate(struct thread_data *td,
aa83321f 516 uint64_t *bytes_done)
581e7141
JA
517{
518 int ret = 0;
519
6eaf09d6
SL
520 if (bytes_done[DDIR_READ])
521 ret |= __should_check_rate(td, DDIR_READ);
522 if (bytes_done[DDIR_WRITE])
523 ret |= __should_check_rate(td, DDIR_WRITE);
524 if (bytes_done[DDIR_TRIM])
525 ret |= __should_check_rate(td, DDIR_TRIM);
581e7141
JA
526
527 return ret;
528}
529
74f4b020
JA
530static inline unsigned int td_max_bs(struct thread_data *td)
531{
532 unsigned int max_bs;
533
534 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
535 return max(td->o.max_bs[DDIR_TRIM], max_bs);
536}
537
8d916c94
JA
538static inline unsigned int td_min_bs(struct thread_data *td)
539{
540 unsigned int min_bs;
541
542 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
543 return min(td->o.min_bs[DDIR_TRIM], min_bs);
544}
545
d529ee19
JA
546static inline int is_power_of_2(unsigned int val)
547{
548 return (val != 0 && ((val & (val - 1)) == 0));
549}
550
e8462bd8
JA
551/*
552 * We currently only need to do locking if we have verifier threads
553 * accessing our internal structures too
554 */
555static inline void td_io_u_lock(struct thread_data *td)
556{
557 if (td->o.verify_async)
558 pthread_mutex_lock(&td->io_u_lock);
559}
560
561static inline void td_io_u_unlock(struct thread_data *td)
562{
563 if (td->o.verify_async)
564 pthread_mutex_unlock(&td->io_u_lock);
565}
566
567static inline void td_io_u_free_notify(struct thread_data *td)
568{
569 if (td->o.verify_async)
570 pthread_cond_signal(&td->free_cond);
571}
572
cca84643
JA
573extern const char *fio_get_arch_string(int);
574extern const char *fio_get_os_string(int);
575
05775438
JA
576#define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
577
f3afa57e
JA
578enum {
579 FIO_OUTPUT_TERSE = 0,
580 FIO_OUTPUT_JSON,
581 FIO_OUTPUT_NORMAL,
582};
583
e25839d4
JA
584enum {
585 FIO_RAND_DIST_RANDOM = 0,
586 FIO_RAND_DIST_ZIPF,
925fee33 587 FIO_RAND_DIST_PARETO,
e25839d4
JA
588};
589
8055e41d
JA
590enum {
591 FIO_RAND_GEN_TAUSWORTHE = 0,
592 FIO_RAND_GEN_LFSR,
593};
594
ebac4655 595#endif