05406cbc9582261d27e86b4b0e8839405602d42a
[fio.git] / fio.h
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>
9 #include <errno.h>
10 #include <stdlib.h>
11 #include <stdio.h>
12 #include <unistd.h>
13 #include <string.h>
14 #include <inttypes.h>
15 #include <assert.h>
16
17 struct thread_data;
18
19 #include "compiler/compiler.h"
20 #include "thread_options.h"
21 #include "flist.h"
22 #include "fifo.h"
23 #include "lib/rbtree.h"
24 #include "arch/arch.h"
25 #include "os/os.h"
26 #include "mutex.h"
27 #include "log.h"
28 #include "debug.h"
29 #include "file.h"
30 #include "io_ddir.h"
31 #include "ioengine.h"
32 #include "iolog.h"
33 #include "helpers.h"
34 #include "options.h"
35 #include "profile.h"
36 #include "time.h"
37 #include "gettime.h"
38 #include "lib/getopt.h"
39 #include "lib/rand.h"
40 #include "client.h"
41 #include "server.h"
42 #include "stat.h"
43 #include "flow.h"
44
45 #ifdef CONFIG_SOLARISAIO
46 #include <sys/asynch.h>
47 #endif
48
49 #ifdef CONFIG_LIBNUMA
50 #include <linux/mempolicy.h>
51 #include <numa.h>
52
53 /*
54  * "local" is pseudo-policy
55  */
56 #define MPOL_LOCAL MPOL_MAX
57 #endif
58
59 /*
60  * offset generator types
61  */
62 enum {
63         RW_SEQ_SEQ      = 0,
64         RW_SEQ_IDENT,
65 };
66
67 enum {
68         TD_F_VER_BACKLOG        = 1,
69         TD_F_TRIM_BACKLOG       = 2,
70         TD_F_READ_IOLOG         = 4,
71         TD_F_REFILL_BUFFERS     = 8,
72         TD_F_SCRAMBLE_BUFFERS   = 16,
73         TD_F_VER_NONE           = 32,
74         TD_F_PROFILE_OPS        = 64,
75 };
76
77 enum {
78         FIO_RAND_BS_OFF         = 0,
79         FIO_RAND_VER_OFF,
80         FIO_RAND_MIX_OFF,
81         FIO_RAND_FILE_OFF,
82         FIO_RAND_BLOCK_OFF,
83         FIO_RAND_FILE_SIZE_OFF,
84         FIO_RAND_TRIM_OFF,
85         FIO_RAND_BUF_OFF,
86         FIO_RAND_NR_OFFS,
87 };
88
89 /*
90  * This describes a single thread/process executing a fio job.
91  */
92 struct thread_data {
93         struct thread_options o;
94         unsigned long flags;
95         void *eo;
96         char verror[FIO_VERROR_SIZE];
97         pthread_t thread;
98         unsigned int thread_number;
99         unsigned int groupid;
100         struct thread_stat ts;
101
102         int client_type;
103
104         struct io_log *slat_log;
105         struct io_log *clat_log;
106         struct io_log *lat_log;
107         struct io_log *bw_log;
108         struct io_log *iops_log;
109
110         uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
111         struct timeval bw_sample_time;
112
113         uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
114         struct timeval iops_sample_time;
115
116         struct rusage ru_start;
117         struct rusage ru_end;
118
119         struct fio_file **files;
120         unsigned char *file_locks;
121         unsigned int files_size;
122         unsigned int files_index;
123         unsigned int nr_open_files;
124         unsigned int nr_done_files;
125         unsigned int nr_normal_files;
126         union {
127                 unsigned int next_file;
128                 os_random_state_t next_file_state;
129                 struct frand_state __next_file_state;
130         };
131         int error;
132         int sig;
133         int done;
134         pid_t pid;
135         char *orig_buffer;
136         size_t orig_buffer_size;
137         volatile int terminate;
138         volatile int runstate;
139         unsigned int last_was_sync;
140         enum fio_ddir last_ddir;
141
142         int mmapfd;
143
144         void *iolog_buf;
145         FILE *iolog_f;
146
147         char *sysfs_root;
148
149         unsigned long rand_seeds[FIO_RAND_NR_OFFS];
150
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         };
163
164         struct frand_state buf_state;
165
166         unsigned int verify_batch;
167         unsigned int trim_batch;
168
169         int shm_id;
170
171         /*
172          * IO engine hooks, contains everything needed to submit an io_u
173          * to any of the available IO engines.
174          */
175         struct ioengine_ops *io_ops;
176
177         /*
178          * Queue depth of io_u's that fio MIGHT do
179          */
180         unsigned int cur_depth;
181
182         /*
183          * io_u's about to be committed
184          */
185         unsigned int io_u_queued;
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          */
195         struct flist_head io_u_freelist;
196         struct flist_head io_u_busylist;
197         struct flist_head io_u_requeues;
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;
209
210         /*
211          * Rate state
212          */
213         uint64_t rate_bps[DDIR_RWDIR_CNT];
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];
218
219         uint64_t total_io_size;
220         uint64_t fill_device_size;
221
222         unsigned long io_issues[DDIR_RWDIR_CNT];
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;
229         struct fio_mutex *mutex;
230
231         /*
232          * State for random io, a bitmap of blocks done vs not done
233          */
234         union {
235                 os_random_state_t random_state;
236                 struct frand_state __random_state;
237         };
238
239         struct timeval start;   /* start of this loop */
240         struct timeval epoch;   /* time job was started */
241         struct timeval last_issue;
242         struct timeval tv_cache;
243         unsigned int tv_cache_nr;
244         unsigned int tv_cache_mask;
245         unsigned int ramp_time_over;
246
247         /*
248          * read/write mixed workload state
249          */
250         union {
251                 os_random_state_t rwmix_state;
252                 struct frand_state __rwmix_state;
253         };
254         unsigned long rwmix_issues;
255         enum fio_ddir rwmix_ddir;
256         unsigned int ddir_seq_nr;
257
258         /*
259          * IO history logs for verification. We use a tree for sorting,
260          * if we are overwriting. Otherwise just use a fifo.
261          */
262         struct rb_root io_hist_tree;
263         struct flist_head io_hist_list;
264         unsigned long io_hist_len;
265
266         /*
267          * For IO replaying
268          */
269         struct flist_head io_log_list;
270
271         /*
272          * For tracking/handling discards
273          */
274         struct flist_head trim_list;
275         unsigned long trim_entries;
276
277         struct flist_head next_rand_list;
278
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;
285
286         unsigned int sync_file_range_nr;
287
288         /*
289          * For generating file sizes
290          */
291         union {
292                 os_random_state_t file_size_state;
293                 struct frand_state __file_size_state;
294         };
295
296         /*
297          * Error counts
298          */
299         unsigned int total_err_count;
300         int first_error;
301
302         struct fio_flow *flow;
303
304         /*
305          * Can be overloaded by profiles
306          */
307         struct prof_io_ops prof_io_ops;
308         void *prof_data;
309
310         void *pinned_mem;
311 };
312
313 /*
314  * when should interactive ETA output be generated
315  */
316 enum {
317         FIO_ETA_AUTO,
318         FIO_ETA_ALWAYS,
319         FIO_ETA_NEVER,
320 };
321
322 #define __td_verror(td, err, msg, func)                                 \
323         do {                                                            \
324                 if ((td)->error)                                        \
325                         break;                                          \
326                 int e = (err);                                          \
327                 (td)->error = e;                                        \
328                 if (!(td)->first_error)                                 \
329                         snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));           \
330         } while (0)
331
332
333 #define td_clear_error(td)              \
334         (td)->error = 0;
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))
339
340 #define __fio_stringify_1(x)    #x
341 #define __fio_stringify(x)      __fio_stringify_1(x)
342
343 extern int exitall_on_terminate;
344 extern unsigned int thread_number;
345 extern unsigned int stat_number;
346 extern int shm_id;
347 extern int groupid;
348 extern int output_format;
349 extern int temp_stall_ts;
350 extern uintptr_t page_mask, page_size;
351 extern int read_only;
352 extern int eta_print;
353 extern int eta_new_line;
354 extern unsigned long done_secs;
355 extern char *job_section;
356 extern int fio_gtod_offload;
357 extern int fio_gtod_cpu;
358 extern enum fio_cs fio_clock_source;
359 extern int fio_clock_source_set;
360 extern int warnings_fatal;
361 extern int terse_version;
362 extern int is_backend;
363 extern int nr_clients;
364 extern int log_syslog;
365 extern const char fio_version_string[];
366
367 extern struct thread_data *threads;
368
369 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
370 {
371         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
372 }
373
374 #define REAL_MAX_JOBS           2048
375
376 static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
377 {
378         if (err == EILSEQ)
379                 return ERROR_TYPE_VERIFY_BIT;
380         if (ddir == DDIR_READ)
381                 return ERROR_TYPE_READ_BIT;
382         return ERROR_TYPE_WRITE_BIT;
383 }
384
385 static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
386 static inline int td_non_fatal_error(struct thread_data *td,
387                                      enum error_type_bit etype, int err)
388 {
389         int i;
390         if (!td->o.ignore_error[etype]) {
391                 td->o.ignore_error[etype] = __NON_FATAL_ERR;
392                 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
393                         / sizeof(int);
394         }
395
396         if (!(td->o.continue_on_error & (1 << etype)))
397                 return 0;
398         for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
399                 if (td->o.ignore_error[etype][i] == err)
400                         return 1;
401         return 0;
402 }
403
404 static inline void update_error_count(struct thread_data *td, int err)
405 {
406         td->total_err_count++;
407         if (td->total_err_count == 1)
408                 td->first_error = err;
409 }
410
411 static inline int should_fsync(struct thread_data *td)
412 {
413         if (td->last_was_sync)
414                 return 0;
415         if (td_write(td) || td_rw(td) || td->o.override_sync)
416                 return 1;
417
418         return 0;
419 }
420
421 /*
422  * Init/option functions
423  */
424 extern int __must_check fio_init_options(void);
425 extern int __must_check parse_options(int, char **);
426 extern int parse_jobs_ini(char *, int, int, int);
427 extern int parse_cmd_line(int, char **, int);
428 extern int fio_backend(void);
429 extern void reset_fio_state(void);
430 extern void clear_io_state(struct thread_data *);
431 extern int fio_options_parse(struct thread_data *, char **, int);
432 extern void fio_keywords_init(void);
433 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
434 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
435 extern void fio_fill_default_options(struct thread_data *);
436 extern int fio_show_option_help(const char *);
437 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
438 extern void fio_options_dup_and_init(struct option *);
439 extern void fio_options_mem_dupe(struct thread_data *);
440 extern void options_mem_dupe(void *data, struct fio_option *options);
441 extern void td_fill_rand_seeds(struct thread_data *);
442 extern void add_job_opts(const char **, int);
443 extern char *num2str(unsigned long, int, int, int);
444 extern int ioengine_load(struct thread_data *);
445
446 extern unsigned long page_mask;
447 extern unsigned long page_size;
448 extern int initialize_fio(char *envp[]);
449
450 #define FIO_GETOPT_JOB          0x89000000
451 #define FIO_GETOPT_IOENGINE     0x98000000
452 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
453
454 /*
455  * ETA/status stuff
456  */
457 extern void print_thread_status(void);
458 extern void print_status_init(int);
459 extern char *fio_uint_to_kmg(unsigned int val);
460
461 /*
462  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
463  * will never back again. It may cycle between running/verififying/fsyncing.
464  * Once the thread reaches TD_EXITED, it is just waiting for the core to
465  * reap it.
466  */
467 enum {
468         TD_NOT_CREATED = 0,
469         TD_CREATED,
470         TD_INITIALIZED,
471         TD_RAMP,
472         TD_SETTING_UP,
473         TD_RUNNING,
474         TD_PRE_READING,
475         TD_VERIFYING,
476         TD_FSYNCING,
477         TD_EXITED,
478         TD_REAPED,
479 };
480
481 extern void td_set_runstate(struct thread_data *, int);
482 #define TERMINATE_ALL           (-1)
483 extern void fio_terminate_threads(int);
484
485 /*
486  * Memory helpers
487  */
488 extern int __must_check fio_pin_memory(struct thread_data *);
489 extern void fio_unpin_memory(struct thread_data *);
490 extern int __must_check allocate_io_mem(struct thread_data *);
491 extern void free_io_mem(struct thread_data *);
492 extern void free_threads_shm(void);
493
494 /*
495  * Reset stats after ramp time completes
496  */
497 extern void reset_all_stats(struct thread_data *);
498
499 /*
500  * blktrace support
501  */
502 #ifdef FIO_HAVE_BLKTRACE
503 extern int is_blktrace(const char *);
504 extern int load_blktrace(struct thread_data *, const char *);
505 #endif
506
507 /*
508  * Mark unused variables passed to ops functions as unused, to silence gcc
509  */
510 #define fio_unused      __attribute((__unused__))
511 #define fio_init        __attribute__((constructor))
512 #define fio_exit        __attribute__((destructor))
513
514 #define for_each_td(td, i)      \
515         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
516 #define for_each_file(td, f, i) \
517         if ((td)->files_index)                                          \
518                 for ((i) = 0, (f) = (td)->files[0];                     \
519                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
520                  (i)++)
521
522 #define fio_assert(td, cond)    do {    \
523         if (!(cond)) {                  \
524                 int *__foo = NULL;      \
525                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
526                 td_set_runstate((td), TD_EXITED);       \
527                 (td)->error = EFAULT;           \
528                 *__foo = 0;                     \
529         }       \
530 } while (0)
531
532 static inline int fio_fill_issue_time(struct thread_data *td)
533 {
534         if (td->o.read_iolog_file ||
535             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
536                 return 1;
537
538         return 0;
539 }
540
541 static inline int __should_check_rate(struct thread_data *td,
542                                       enum fio_ddir ddir)
543 {
544         struct thread_options *o = &td->o;
545
546         /*
547          * If some rate setting was given, we need to check it
548          */
549         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
550             o->rate_iops_min[ddir])
551                 return 1;
552
553         return 0;
554 }
555
556 static inline int should_check_rate(struct thread_data *td,
557                                     uint64_t *bytes_done)
558 {
559         int ret = 0;
560
561         if (bytes_done[DDIR_READ])
562                 ret |= __should_check_rate(td, DDIR_READ);
563         if (bytes_done[DDIR_WRITE])
564                 ret |= __should_check_rate(td, DDIR_WRITE);
565         if (bytes_done[DDIR_TRIM])
566                 ret |= __should_check_rate(td, DDIR_TRIM);
567
568         return ret;
569 }
570
571 static inline int is_power_of_2(unsigned int val)
572 {
573         return (val != 0 && ((val & (val - 1)) == 0));
574 }
575
576 /*
577  * We currently only need to do locking if we have verifier threads
578  * accessing our internal structures too
579  */
580 static inline void td_io_u_lock(struct thread_data *td)
581 {
582         if (td->o.verify_async)
583                 pthread_mutex_lock(&td->io_u_lock);
584 }
585
586 static inline void td_io_u_unlock(struct thread_data *td)
587 {
588         if (td->o.verify_async)
589                 pthread_mutex_unlock(&td->io_u_lock);
590 }
591
592 static inline void td_io_u_free_notify(struct thread_data *td)
593 {
594         if (td->o.verify_async)
595                 pthread_cond_signal(&td->free_cond);
596 }
597
598 extern const char *fio_get_arch_string(int);
599 extern const char *fio_get_os_string(int);
600
601 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
602
603 enum {
604         FIO_OUTPUT_TERSE        = 0,
605         FIO_OUTPUT_JSON,
606         FIO_OUTPUT_NORMAL,
607 };
608
609 enum {
610         FIO_RAND_DIST_RANDOM    = 0,
611         FIO_RAND_DIST_ZIPF,
612         FIO_RAND_DIST_PARETO,
613 };
614
615 enum {
616         FIO_RAND_GEN_TAUSWORTHE = 0,
617         FIO_RAND_GEN_LFSR,
618 };
619
620 #endif