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