Commit | Line | Data |
---|---|---|
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" |
ef3c94b6 | 33 | #include "fio_time.h" |
a7346816 | 34 | #include "gettime.h" |
f87cc561 | 35 | #include "oslib/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" |
2ae0b204 | 42 | #include "io_u_queue.h" |
a9da8ab2 | 43 | #include "workqueue.h" |
ebac4655 | 44 | |
4700b234 | 45 | #ifdef CONFIG_SOLARISAIO |
417f0068 JA |
46 | #include <sys/asynch.h> |
47 | #endif | |
48 | ||
67bf9823 | 49 | #ifdef CONFIG_LIBNUMA |
d0b937ed YR |
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 | ||
38dad62d JA |
59 | /* |
60 | * offset generator types | |
61 | */ | |
62 | enum { | |
63 | RW_SEQ_SEQ = 0, | |
64 | RW_SEQ_IDENT, | |
65 | }; | |
66 | ||
d72be545 | 67 | enum { |
10941167 JA |
68 | TD_F_VER_BACKLOG = 1U << 0, |
69 | TD_F_TRIM_BACKLOG = 1U << 1, | |
70 | TD_F_READ_IOLOG = 1U << 2, | |
71 | TD_F_REFILL_BUFFERS = 1U << 3, | |
72 | TD_F_SCRAMBLE_BUFFERS = 1U << 4, | |
73 | TD_F_VER_NONE = 1U << 5, | |
74 | TD_F_PROFILE_OPS = 1U << 6, | |
75 | TD_F_COMPRESS = 1U << 7, | |
76 | TD_F_NOIO = 1U << 8, | |
77 | TD_F_COMPRESS_LOG = 1U << 9, | |
78 | TD_F_VSTATE_SAVED = 1U << 10, | |
79 | TD_F_NEED_LOCK = 1U << 11, | |
80 | TD_F_CHILD = 1U << 12, | |
263775ad | 81 | TD_F_NO_PROGRESS = 1U << 13, |
1fed2080 | 82 | TD_F_REGROW_LOGS = 1U << 14, |
d72be545 JA |
83 | }; |
84 | ||
d24945f0 JA |
85 | enum { |
86 | FIO_RAND_BS_OFF = 0, | |
87 | FIO_RAND_VER_OFF, | |
88 | FIO_RAND_MIX_OFF, | |
89 | FIO_RAND_FILE_OFF, | |
90 | FIO_RAND_BLOCK_OFF, | |
91 | FIO_RAND_FILE_SIZE_OFF, | |
92 | FIO_RAND_TRIM_OFF, | |
93 | FIO_RAND_BUF_OFF, | |
d9472271 JA |
94 | FIO_RAND_SEQ_RAND_READ_OFF, |
95 | FIO_RAND_SEQ_RAND_WRITE_OFF, | |
96 | FIO_RAND_SEQ_RAND_TRIM_OFF, | |
23ed19b0 | 97 | FIO_RAND_START_DELAY, |
5c94b008 | 98 | FIO_DEDUPE_OFF, |
e7b24047 | 99 | FIO_RAND_POISSON_OFF, |
e0a04ac1 | 100 | FIO_RAND_ZONE_OFF, |
d24945f0 JA |
101 | FIO_RAND_NR_OFFS, |
102 | }; | |
103 | ||
a9da8ab2 JA |
104 | enum { |
105 | IO_MODE_INLINE = 0, | |
6de65959 JA |
106 | IO_MODE_OFFLOAD = 1, |
107 | ||
108 | RATE_PROCESS_LINEAR = 0, | |
109 | RATE_PROCESS_POISSON = 1, | |
a9da8ab2 JA |
110 | }; |
111 | ||
2a2804c9 JA |
112 | /* |
113 | * Per-thread/process specific data. Only used for the network client | |
114 | * for now. | |
115 | */ | |
24660963 JA |
116 | struct sk_out; |
117 | void sk_out_assign(struct sk_out *); | |
118 | void sk_out_drop(void); | |
2a2804c9 | 119 | |
e0a04ac1 JA |
120 | struct zone_split_index { |
121 | uint8_t size_perc; | |
122 | uint8_t size_perc_prev; | |
123 | }; | |
124 | ||
16e56d25 VF |
125 | /* |
126 | * For steady state detection | |
127 | */ | |
128 | struct steadystate_data { | |
129 | double limit; | |
130 | unsigned long long dur; | |
131 | unsigned long long ramp_time; | |
132 | bool (*evaluate)(unsigned long, unsigned long, struct thread_data *); | |
133 | bool check_iops; | |
134 | bool check_slope; | |
135 | bool pct; | |
136 | ||
137 | int attained; | |
138 | int last_in_group; | |
139 | int ramp_time_over; | |
140 | ||
141 | unsigned int head; | |
142 | unsigned int tail; | |
143 | unsigned long *cache; | |
144 | ||
145 | double criterion; | |
146 | ||
147 | unsigned long long sum_y; | |
148 | unsigned long long sum_x; | |
149 | unsigned long long sum_x_sq; | |
150 | unsigned long long sum_xy; | |
151 | unsigned long long oldest_y; | |
152 | ||
153 | struct timeval prev_time; | |
154 | unsigned long long prev_iops; | |
155 | unsigned long long prev_bytes; | |
156 | }; | |
157 | ||
158 | ||
2dc1bbeb JA |
159 | /* |
160 | * This describes a single thread/process executing a fio job. | |
161 | */ | |
162 | struct thread_data { | |
c2292325 | 163 | struct flist_head opt_list; |
d72be545 | 164 | unsigned long flags; |
d7e9266c | 165 | struct thread_options o; |
de890a1e | 166 | void *eo; |
2dc1bbeb | 167 | pthread_t thread; |
2f122b13 | 168 | unsigned int thread_number; |
69bdd6ba | 169 | unsigned int subjob_number; |
2f122b13 | 170 | unsigned int groupid; |
2dc1bbeb | 171 | struct thread_stat ts; |
7b9f733a | 172 | |
46bcd498 JA |
173 | int client_type; |
174 | ||
7b9f733a JA |
175 | struct io_log *slat_log; |
176 | struct io_log *clat_log; | |
1e613c9c | 177 | struct io_log *clat_hist_log; |
7b9f733a JA |
178 | struct io_log *lat_log; |
179 | struct io_log *bw_log; | |
c8eeb9df | 180 | struct io_log *iops_log; |
7b9f733a | 181 | |
155f2f02 | 182 | struct workqueue log_compress_wq; |
aee2ab67 | 183 | |
a9da8ab2 JA |
184 | struct thread_data *parent; |
185 | ||
6eaf09d6 | 186 | uint64_t stat_io_bytes[DDIR_RWDIR_CNT]; |
c8eeb9df JA |
187 | struct timeval bw_sample_time; |
188 | ||
6eaf09d6 | 189 | uint64_t stat_io_blocks[DDIR_RWDIR_CNT]; |
c8eeb9df | 190 | struct timeval iops_sample_time; |
f0505a14 | 191 | |
c97f1ad6 JA |
192 | volatile int update_rusage; |
193 | struct fio_mutex *rusage_sem; | |
c8aaba19 JA |
194 | struct rusage ru_start; |
195 | struct rusage ru_end; | |
196 | ||
126d65c6 | 197 | struct fio_file **files; |
d7df1d13 | 198 | unsigned char *file_locks; |
dd87b2c9 | 199 | unsigned int files_size; |
2dc1bbeb JA |
200 | unsigned int files_index; |
201 | unsigned int nr_open_files; | |
1020a139 | 202 | unsigned int nr_done_files; |
2dc1bbeb JA |
203 | unsigned int nr_normal_files; |
204 | union { | |
205 | unsigned int next_file; | |
d6b72507 | 206 | struct frand_state next_file_state; |
2dc1bbeb | 207 | }; |
8c07860d JA |
208 | union { |
209 | struct zipf_state next_file_zipf; | |
210 | struct gauss_state next_file_gauss; | |
211 | }; | |
212 | union { | |
213 | double zipf_theta; | |
214 | double pareto_h; | |
215 | double gauss_dev; | |
216 | }; | |
2dc1bbeb | 217 | int error; |
a5e371a6 | 218 | int sig; |
20e354ef | 219 | int done; |
ca09be4b | 220 | int stop_io; |
2dc1bbeb JA |
221 | pid_t pid; |
222 | char *orig_buffer; | |
223 | size_t orig_buffer_size; | |
224 | volatile int terminate; | |
225 | volatile int runstate; | |
2dc1bbeb | 226 | unsigned int last_was_sync; |
9e144189 | 227 | enum fio_ddir last_ddir; |
2dc1bbeb | 228 | |
2dc1bbeb JA |
229 | int mmapfd; |
230 | ||
843a7413 JA |
231 | void *iolog_buf; |
232 | FILE *iolog_f; | |
ebac4655 | 233 | |
da86774e | 234 | char *sysfs_root; |
da86774e | 235 | |
d24945f0 | 236 | unsigned long rand_seeds[FIO_RAND_NR_OFFS]; |
5bfc35d7 | 237 | |
d6b72507 JA |
238 | struct frand_state bsrange_state; |
239 | struct frand_state verify_state; | |
240 | struct frand_state trim_state; | |
241 | struct frand_state delay_state; | |
ebac4655 | 242 | |
3545a109 | 243 | struct frand_state buf_state; |
5c94b008 JA |
244 | struct frand_state buf_state_prev; |
245 | struct frand_state dedupe_state; | |
e0a04ac1 JA |
246 | struct frand_state zone_state; |
247 | ||
248 | struct zone_split_index **zone_state_index; | |
3545a109 | 249 | |
9e144189 | 250 | unsigned int verify_batch; |
0d29de83 | 251 | unsigned int trim_batch; |
9e144189 | 252 | |
ca09be4b JA |
253 | struct thread_io_list *vstate; |
254 | ||
ebac4655 JA |
255 | int shm_id; |
256 | ||
e9c047a0 JA |
257 | /* |
258 | * IO engine hooks, contains everything needed to submit an io_u | |
259 | * to any of the available IO engines. | |
260 | */ | |
2866c82d | 261 | struct ioengine_ops *io_ops; |
ebac4655 | 262 | |
565e784d TK |
263 | /* |
264 | * IO engine private data and dlhandle. | |
265 | */ | |
266 | void *io_ops_data; | |
267 | void *io_ops_dlhandle; | |
268 | ||
e9c047a0 | 269 | /* |
422f9e4b | 270 | * Queue depth of io_u's that fio MIGHT do |
e9c047a0 | 271 | */ |
ebac4655 | 272 | unsigned int cur_depth; |
422f9e4b RM |
273 | |
274 | /* | |
275 | * io_u's about to be committed | |
276 | */ | |
d8005759 | 277 | unsigned int io_u_queued; |
422f9e4b RM |
278 | |
279 | /* | |
280 | * io_u's submitted but not completed yet | |
281 | */ | |
282 | unsigned int io_u_in_flight; | |
283 | ||
284 | /* | |
285 | * List of free and busy io_u's | |
286 | */ | |
2ae0b204 JA |
287 | struct io_u_ring io_u_requeues; |
288 | struct io_u_queue io_u_freelist; | |
289 | struct io_u_queue io_u_all; | |
e8462bd8 JA |
290 | pthread_mutex_t io_u_lock; |
291 | pthread_cond_t free_cond; | |
292 | ||
293 | /* | |
294 | * async verify offload | |
295 | */ | |
296 | struct flist_head verify_list; | |
297 | pthread_t *verify_threads; | |
298 | unsigned int nr_verify_threads; | |
299 | pthread_cond_t verify_cond; | |
300 | int verify_thread_exit; | |
ebac4655 | 301 | |
e9c047a0 JA |
302 | /* |
303 | * Rate state | |
304 | */ | |
bdb6d20a | 305 | uint64_t rate_bps[DDIR_RWDIR_CNT]; |
50a8ce86 | 306 | unsigned long rate_next_io_time[DDIR_RWDIR_CNT]; |
6eaf09d6 SL |
307 | unsigned long rate_bytes[DDIR_RWDIR_CNT]; |
308 | unsigned long rate_blocks[DDIR_RWDIR_CNT]; | |
50a8ce86 | 309 | unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT]; |
6eaf09d6 | 310 | struct timeval lastrate[DDIR_RWDIR_CNT]; |
e7b24047 JA |
311 | int64_t last_usec; |
312 | struct frand_state poisson_state; | |
ebac4655 | 313 | |
a9da8ab2 JA |
314 | /* |
315 | * Enforced rate submission/completion workqueue | |
316 | */ | |
317 | struct workqueue io_wq; | |
318 | ||
bdb6d20a JA |
319 | uint64_t total_io_size; |
320 | uint64_t fill_device_size; | |
ebac4655 | 321 | |
74d6277f JA |
322 | /* |
323 | * Issue side | |
324 | */ | |
ca09be4b | 325 | uint64_t io_issues[DDIR_RWDIR_CNT]; |
74d6277f | 326 | uint64_t io_issue_bytes[DDIR_RWDIR_CNT]; |
cf8a46a7 | 327 | uint64_t loops; |
74d6277f JA |
328 | |
329 | /* | |
330 | * Completions | |
331 | */ | |
bdb6d20a JA |
332 | uint64_t io_blocks[DDIR_RWDIR_CNT]; |
333 | uint64_t this_io_blocks[DDIR_RWDIR_CNT]; | |
334 | uint64_t io_bytes[DDIR_RWDIR_CNT]; | |
bdb6d20a | 335 | uint64_t this_io_bytes[DDIR_RWDIR_CNT]; |
55312f9f | 336 | uint64_t io_skip_bytes; |
bdb6d20a | 337 | uint64_t zone_bytes; |
cdd18ad8 | 338 | struct fio_mutex *mutex; |
55312f9f | 339 | uint64_t bytes_done[DDIR_RWDIR_CNT]; |
ebac4655 | 340 | |
e9c047a0 JA |
341 | /* |
342 | * State for random io, a bitmap of blocks done vs not done | |
343 | */ | |
d6b72507 | 344 | struct frand_state random_state; |
ebac4655 | 345 | |
ebac4655 JA |
346 | struct timeval start; /* start of this loop */ |
347 | struct timeval epoch; /* time job was started */ | |
a61eddec | 348 | struct timeval last_issue; |
df8fb609 | 349 | long time_offset; |
993bf48b | 350 | struct timeval tv_cache; |
cba5460c | 351 | struct timeval terminate_time; |
993bf48b JA |
352 | unsigned int tv_cache_nr; |
353 | unsigned int tv_cache_mask; | |
721938ae | 354 | unsigned int ramp_time_over; |
ebac4655 | 355 | |
3e260a46 JA |
356 | /* |
357 | * Time since last latency_window was started | |
358 | */ | |
359 | struct timeval latency_ts; | |
360 | unsigned int latency_qd; | |
361 | unsigned int latency_qd_high; | |
362 | unsigned int latency_qd_low; | |
363 | unsigned int latency_failed; | |
364 | uint64_t latency_ios; | |
6bb58215 | 365 | int latency_end_run; |
3e260a46 | 366 | |
e9c047a0 JA |
367 | /* |
368 | * read/write mixed workload state | |
369 | */ | |
d6b72507 | 370 | struct frand_state rwmix_state; |
e4928662 | 371 | unsigned long rwmix_issues; |
e9c047a0 | 372 | enum fio_ddir rwmix_ddir; |
5736c10d | 373 | unsigned int ddir_seq_nr; |
a6ccc7be | 374 | |
211c9b89 JA |
375 | /* |
376 | * rand/seq mixed workload state | |
377 | */ | |
d6b72507 | 378 | struct frand_state seq_rand_state[DDIR_RWDIR_CNT]; |
211c9b89 | 379 | |
e9c047a0 | 380 | /* |
8de8f047 JA |
381 | * IO history logs for verification. We use a tree for sorting, |
382 | * if we are overwriting. Otherwise just use a fifo. | |
e9c047a0 | 383 | */ |
4b87898e | 384 | struct rb_root io_hist_tree; |
01743ee1 | 385 | struct flist_head io_hist_list; |
9e144189 | 386 | unsigned long io_hist_len; |
8de8f047 JA |
387 | |
388 | /* | |
389 | * For IO replaying | |
390 | */ | |
01743ee1 | 391 | struct flist_head io_log_list; |
433afcb4 | 392 | |
0d29de83 JA |
393 | /* |
394 | * For tracking/handling discards | |
395 | */ | |
396 | struct flist_head trim_list; | |
397 | unsigned long trim_entries; | |
398 | ||
1ae83d45 JA |
399 | struct flist_head next_rand_list; |
400 | ||
1907dbc6 JA |
401 | /* |
402 | * for fileservice, how often to switch to a new file | |
403 | */ | |
404 | unsigned int file_service_nr; | |
405 | unsigned int file_service_left; | |
406 | struct fio_file *file_service_file; | |
9c60ce64 | 407 | |
44f29692 JA |
408 | unsigned int sync_file_range_nr; |
409 | ||
9c60ce64 JA |
410 | /* |
411 | * For generating file sizes | |
412 | */ | |
d6b72507 | 413 | struct frand_state file_size_state; |
f2bba182 RR |
414 | |
415 | /* | |
416 | * Error counts | |
417 | */ | |
418 | unsigned int total_err_count; | |
419 | int first_error; | |
15dc1934 | 420 | |
9e684a49 DE |
421 | struct fio_flow *flow; |
422 | ||
15dc1934 JA |
423 | /* |
424 | * Can be overloaded by profiles | |
425 | */ | |
7eb36574 | 426 | struct prof_io_ops prof_io_ops; |
58c55ba0 | 427 | void *prof_data; |
9a3f1100 JA |
428 | |
429 | void *pinned_mem; | |
d7e9266c | 430 | |
16e56d25 VF |
431 | struct steadystate_data ss; |
432 | ||
d7e9266c | 433 | char verror[FIO_VERROR_SIZE]; |
ebac4655 JA |
434 | }; |
435 | ||
e592a06b AC |
436 | /* |
437 | * when should interactive ETA output be generated | |
438 | */ | |
439 | enum { | |
440 | FIO_ETA_AUTO, | |
441 | FIO_ETA_ALWAYS, | |
442 | FIO_ETA_NEVER, | |
443 | }; | |
444 | ||
e1161c32 | 445 | #define __td_verror(td, err, msg, func) \ |
ebac4655 | 446 | do { \ |
21beb609 | 447 | unsigned int ____e = (err); \ |
19abcd3d JA |
448 | if ((td)->error) \ |
449 | break; \ | |
8271963e | 450 | (td)->error = ____e; \ |
f2bba182 | 451 | if (!(td)->first_error) \ |
98ffb8f3 | 452 | snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \ |
ebac4655 JA |
453 | } while (0) |
454 | ||
b990b5c0 | 455 | |
a9da8ab2 JA |
456 | #define td_clear_error(td) do { \ |
457 | (td)->error = 0; \ | |
458 | if ((td)->parent) \ | |
459 | (td)->parent->error = 0; \ | |
460 | } while (0) | |
461 | ||
462 | #define td_verror(td, err, func) do { \ | |
463 | __td_verror((td), (err), strerror((err)), (func)); \ | |
464 | if ((td)->parent) \ | |
465 | __td_verror((td)->parent, (err), strerror((err)), (func)); \ | |
466 | } while (0) | |
467 | ||
468 | #define td_vmsg(td, err, msg, func) do { \ | |
469 | __td_verror((td), (err), (msg), (func)); \ | |
470 | if ((td)->parent) \ | |
471 | __td_verror((td)->parent, (err), (msg), (func)); \ | |
472 | } while (0) | |
b990b5c0 | 473 | |
81179eec JA |
474 | #define __fio_stringify_1(x) #x |
475 | #define __fio_stringify(x) __fio_stringify_1(x) | |
476 | ||
ebac4655 | 477 | extern int exitall_on_terminate; |
11e950bd | 478 | extern unsigned int thread_number; |
108fea77 | 479 | extern unsigned int stat_number; |
ebac4655 JA |
480 | extern int shm_id; |
481 | extern int groupid; | |
f3afa57e | 482 | extern int output_format; |
2b8c71b0 | 483 | extern int append_terse_output; |
53cdc686 | 484 | extern int temp_stall_ts; |
7078106d | 485 | extern uintptr_t page_mask, page_size; |
4241ea8f | 486 | extern int read_only; |
e592a06b | 487 | extern int eta_print; |
e382e661 | 488 | extern int eta_new_line; |
d3eeeabc | 489 | extern unsigned long done_secs; |
01f06b63 | 490 | extern char *job_section; |
be4ecfdf JA |
491 | extern int fio_gtod_offload; |
492 | extern int fio_gtod_cpu; | |
c223da83 | 493 | extern enum fio_cs fio_clock_source; |
fa80feae | 494 | extern int fio_clock_source_set; |
a9523c6f | 495 | extern int warnings_fatal; |
f57a9c59 | 496 | extern int terse_version; |
5c341e9a | 497 | extern int is_backend; |
a37f69b7 | 498 | extern int nr_clients; |
e46d8091 | 499 | extern int log_syslog; |
06464907 | 500 | extern int status_interval; |
5e726d0a | 501 | extern const char fio_version_string[]; |
ca09be4b JA |
502 | extern char *trigger_file; |
503 | extern char *trigger_cmd; | |
b63efd30 | 504 | extern char *trigger_remote_cmd; |
ca09be4b | 505 | extern long long trigger_timeout; |
d264264a | 506 | extern char *aux_path; |
ebac4655 | 507 | |
16e56d25 VF |
508 | extern bool steadystate; |
509 | #define STEADYSTATE_MSEC (1000) | |
510 | ||
ebac4655 JA |
511 | extern struct thread_data *threads; |
512 | ||
effd6ff0 | 513 | static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u) |
7101d9c2 JA |
514 | { |
515 | assert(!(io_u->ddir == DDIR_WRITE && !td_write(td))); | |
516 | } | |
517 | ||
fca70358 | 518 | #define REAL_MAX_JOBS 2048 |
ebac4655 | 519 | |
87dc1ab1 JA |
520 | static inline int should_fsync(struct thread_data *td) |
521 | { | |
522 | if (td->last_was_sync) | |
523 | return 0; | |
2dc1bbeb | 524 | if (td_write(td) || td_rw(td) || td->o.override_sync) |
87dc1ab1 JA |
525 | return 1; |
526 | ||
527 | return 0; | |
528 | } | |
529 | ||
8914a9d8 | 530 | /* |
214e1eca | 531 | * Init/option functions |
8914a9d8 | 532 | */ |
0420ba6a | 533 | extern int __must_check fio_init_options(void); |
72cb971b | 534 | extern int __must_check parse_options(int, char **); |
46bcd498 JA |
535 | extern int parse_jobs_ini(char *, int, int, int); |
536 | extern int parse_cmd_line(int, char **, int); | |
24660963 | 537 | extern int fio_backend(struct sk_out *); |
50d16976 | 538 | extern void reset_fio_state(void); |
ac28d905 | 539 | extern void clear_io_state(struct thread_data *, int); |
c2292325 | 540 | extern int fio_options_parse(struct thread_data *, char **, int); |
74929ac2 | 541 | extern void fio_keywords_init(void); |
af1dc266 | 542 | extern void fio_keywords_exit(void); |
214e1eca | 543 | extern int fio_cmd_option_parse(struct thread_data *, const char *, char *); |
de890a1e | 544 | extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *); |
214e1eca JA |
545 | extern void fio_fill_default_options(struct thread_data *); |
546 | extern int fio_show_option_help(const char *); | |
de890a1e | 547 | extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td); |
214e1eca | 548 | extern void fio_options_dup_and_init(struct option *); |
de890a1e SL |
549 | extern void fio_options_mem_dupe(struct thread_data *); |
550 | extern void options_mem_dupe(void *data, struct fio_option *options); | |
5bfc35d7 | 551 | extern void td_fill_rand_seeds(struct thread_data *); |
8f380de2 | 552 | extern void td_fill_verify_state_seed(struct thread_data *); |
46bcd498 | 553 | extern void add_job_opts(const char **, int); |
ca09be4b | 554 | extern char *num2str(uint64_t, int, int, int, int); |
de890a1e | 555 | extern int ioengine_load(struct thread_data *); |
f9633d72 | 556 | extern int parse_dryrun(void); |
046395d7 | 557 | extern int fio_running_or_pending_io_threads(void); |
3a35845f | 558 | extern int fio_set_fd_nonblocking(int, const char *); |
d2235e56 | 559 | extern void sig_show_status(int sig); |
66e19a38 | 560 | extern struct thread_data *get_global_options(void); |
1ec3d69b | 561 | |
a569b45f JA |
562 | extern uintptr_t page_mask; |
563 | extern uintptr_t page_size; | |
564 | extern int initialize_fio(char *envp[]); | |
af1dc266 | 565 | extern void deinitialize_fio(void); |
a569b45f | 566 | |
de890a1e SL |
567 | #define FIO_GETOPT_JOB 0x89000000 |
568 | #define FIO_GETOPT_IOENGINE 0x98000000 | |
07b3232d | 569 | #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128) |
8914a9d8 | 570 | |
263e529f JA |
571 | /* |
572 | * ETA/status stuff | |
573 | */ | |
574 | extern void print_thread_status(void); | |
575 | extern void print_status_init(int); | |
0a428b23 | 576 | extern char *fio_uint_to_kmg(unsigned int val); |
263e529f JA |
577 | |
578 | /* | |
579 | * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it | |
580 | * will never back again. It may cycle between running/verififying/fsyncing. | |
581 | * Once the thread reaches TD_EXITED, it is just waiting for the core to | |
582 | * reap it. | |
583 | */ | |
584 | enum { | |
585 | TD_NOT_CREATED = 0, | |
586 | TD_CREATED, | |
587 | TD_INITIALIZED, | |
b29ee5b3 | 588 | TD_RAMP, |
36d80bc7 | 589 | TD_SETTING_UP, |
263e529f | 590 | TD_RUNNING, |
b0f65863 | 591 | TD_PRE_READING, |
263e529f JA |
592 | TD_VERIFYING, |
593 | TD_FSYNCING, | |
3d434057 | 594 | TD_FINISHING, |
263e529f JA |
595 | TD_EXITED, |
596 | TD_REAPED, | |
6e760cf3 | 597 | TD_LAST, |
9b87f09b | 598 | TD_NR, |
263e529f JA |
599 | }; |
600 | ||
9b87f09b JA |
601 | #define TD_ENG_FLAG_SHIFT 16 |
602 | #define TD_ENG_FLAG_MASK ((1U << 16) - 1) | |
603 | ||
604 | static inline enum fio_ioengine_flags td_ioengine_flags(struct thread_data *td) | |
605 | { | |
606 | return (td->flags >> TD_ENG_FLAG_SHIFT) & TD_ENG_FLAG_MASK; | |
607 | } | |
608 | ||
609 | static inline void td_set_ioengine_flags(struct thread_data *td) | |
610 | { | |
611 | td->flags |= (td->io_ops->flags << TD_ENG_FLAG_SHIFT); | |
612 | } | |
613 | ||
614 | static inline bool td_ioengine_flagged(struct thread_data *td, unsigned int val) | |
615 | { | |
616 | return ((td->flags >> TD_ENG_FLAG_SHIFT) & val) != 0; | |
617 | } | |
618 | ||
b29ee5b3 | 619 | extern void td_set_runstate(struct thread_data *, int); |
8edd973d JA |
620 | extern int td_bump_runstate(struct thread_data *, int); |
621 | extern void td_restore_runstate(struct thread_data *, int); | |
9cc8cb91 | 622 | extern const char *runstate_to_name(int runstate); |
8edd973d | 623 | |
cba5460c JA |
624 | /* |
625 | * Allow 60 seconds for a job to quit on its own, otherwise reap with | |
626 | * a vengeance. | |
627 | */ | |
628 | #define FIO_REAP_TIMEOUT 60 | |
629 | ||
d883efbd JA |
630 | #define TERMINATE_ALL (-1U) |
631 | extern void fio_terminate_threads(unsigned int); | |
ebea2133 | 632 | extern void fio_mark_td_terminate(struct thread_data *); |
b29ee5b3 | 633 | |
2f9ade3c JA |
634 | /* |
635 | * Memory helpers | |
636 | */ | |
9a3f1100 JA |
637 | extern int __must_check fio_pin_memory(struct thread_data *); |
638 | extern void fio_unpin_memory(struct thread_data *); | |
b2fdda43 | 639 | extern int __must_check allocate_io_mem(struct thread_data *); |
2f9ade3c | 640 | extern void free_io_mem(struct thread_data *); |
2bb3f0a7 | 641 | extern void free_threads_shm(void); |
2f9ade3c | 642 | |
b29ee5b3 JA |
643 | /* |
644 | * Reset stats after ramp time completes | |
645 | */ | |
646 | extern void reset_all_stats(struct thread_data *); | |
647 | ||
fb7b71a3 JA |
648 | /* |
649 | * blktrace support | |
650 | */ | |
5e62c22a | 651 | #ifdef FIO_HAVE_BLKTRACE |
d95b34a6 JA |
652 | extern int is_blktrace(const char *, int *); |
653 | extern int load_blktrace(struct thread_data *, const char *, int); | |
5e62c22a | 654 | #endif |
fb7b71a3 | 655 | |
40511301 JA |
656 | extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret, |
657 | enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify, | |
658 | struct timeval *comp_time); | |
659 | ||
3e260a46 JA |
660 | /* |
661 | * Latency target helpers | |
662 | */ | |
663 | extern void lat_target_check(struct thread_data *); | |
664 | extern void lat_target_init(struct thread_data *); | |
6bb58215 | 665 | extern void lat_target_reset(struct thread_data *); |
3e260a46 | 666 | |
34572e28 JA |
667 | #define for_each_td(td, i) \ |
668 | for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++) | |
53cdc686 | 669 | #define for_each_file(td, f, i) \ |
691c8fb0 JA |
670 | if ((td)->files_index) \ |
671 | for ((i) = 0, (f) = (td)->files[0]; \ | |
672 | (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \ | |
673 | (i)++) | |
53cdc686 | 674 | |
0032bf9f JA |
675 | #define fio_assert(td, cond) do { \ |
676 | if (!(cond)) { \ | |
340fd243 | 677 | int *__foo = NULL; \ |
0032bf9f | 678 | fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \ |
ac18ea38 | 679 | td_set_runstate((td), TD_EXITED); \ |
437c9b71 | 680 | (td)->error = EFAULT; \ |
340fd243 | 681 | *__foo = 0; \ |
0032bf9f JA |
682 | } \ |
683 | } while (0) | |
684 | ||
12d9d841 JA |
685 | static inline int fio_fill_issue_time(struct thread_data *td) |
686 | { | |
687 | if (td->o.read_iolog_file || | |
688 | !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw) | |
689 | return 1; | |
690 | ||
691 | return 0; | |
692 | } | |
693 | ||
581e7141 JA |
694 | static inline int __should_check_rate(struct thread_data *td, |
695 | enum fio_ddir ddir) | |
696 | { | |
697 | struct thread_options *o = &td->o; | |
698 | ||
699 | /* | |
700 | * If some rate setting was given, we need to check it | |
701 | */ | |
702 | if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] || | |
703 | o->rate_iops_min[ddir]) | |
704 | return 1; | |
705 | ||
706 | return 0; | |
707 | } | |
708 | ||
55312f9f | 709 | static inline int should_check_rate(struct thread_data *td) |
581e7141 JA |
710 | { |
711 | int ret = 0; | |
712 | ||
55312f9f | 713 | if (td->bytes_done[DDIR_READ]) |
6eaf09d6 | 714 | ret |= __should_check_rate(td, DDIR_READ); |
55312f9f | 715 | if (td->bytes_done[DDIR_WRITE]) |
6eaf09d6 | 716 | ret |= __should_check_rate(td, DDIR_WRITE); |
55312f9f | 717 | if (td->bytes_done[DDIR_TRIM]) |
6eaf09d6 | 718 | ret |= __should_check_rate(td, DDIR_TRIM); |
581e7141 JA |
719 | |
720 | return ret; | |
721 | } | |
722 | ||
74f4b020 JA |
723 | static inline unsigned int td_max_bs(struct thread_data *td) |
724 | { | |
725 | unsigned int max_bs; | |
726 | ||
727 | max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]); | |
728 | return max(td->o.max_bs[DDIR_TRIM], max_bs); | |
729 | } | |
730 | ||
8d916c94 JA |
731 | static inline unsigned int td_min_bs(struct thread_data *td) |
732 | { | |
733 | unsigned int min_bs; | |
734 | ||
735 | min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]); | |
736 | return min(td->o.min_bs[DDIR_TRIM], min_bs); | |
737 | } | |
738 | ||
1651e431 | 739 | static inline bool td_async_processing(struct thread_data *td) |
a9da8ab2 JA |
740 | { |
741 | return (td->flags & TD_F_NEED_LOCK) != 0; | |
742 | } | |
743 | ||
e8462bd8 JA |
744 | /* |
745 | * We currently only need to do locking if we have verifier threads | |
746 | * accessing our internal structures too | |
747 | */ | |
748 | static inline void td_io_u_lock(struct thread_data *td) | |
749 | { | |
a9da8ab2 | 750 | if (td_async_processing(td)) |
e8462bd8 JA |
751 | pthread_mutex_lock(&td->io_u_lock); |
752 | } | |
753 | ||
754 | static inline void td_io_u_unlock(struct thread_data *td) | |
755 | { | |
a9da8ab2 | 756 | if (td_async_processing(td)) |
e8462bd8 JA |
757 | pthread_mutex_unlock(&td->io_u_lock); |
758 | } | |
759 | ||
760 | static inline void td_io_u_free_notify(struct thread_data *td) | |
761 | { | |
a9da8ab2 | 762 | if (td_async_processing(td)) |
e8462bd8 JA |
763 | pthread_cond_signal(&td->free_cond); |
764 | } | |
765 | ||
1651e431 JA |
766 | static inline void td_flags_clear(struct thread_data *td, unsigned int *flags, |
767 | unsigned int value) | |
768 | { | |
769 | if (!td_async_processing(td)) | |
770 | *flags &= ~value; | |
771 | else | |
772 | __sync_fetch_and_and(flags, ~value); | |
773 | } | |
774 | ||
775 | static inline void td_flags_set(struct thread_data *td, unsigned int *flags, | |
776 | unsigned int value) | |
777 | { | |
778 | if (!td_async_processing(td)) | |
779 | *flags |= value; | |
780 | else | |
781 | __sync_fetch_and_or(flags, value); | |
782 | } | |
783 | ||
cca84643 JA |
784 | extern const char *fio_get_arch_string(int); |
785 | extern const char *fio_get_os_string(int); | |
786 | ||
e2c81040 | 787 | #ifdef FIO_INTERNAL |
71deafc6 RP |
788 | #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0]))) |
789 | #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f)) | |
e2c81040 | 790 | #endif |
05775438 | 791 | |
f3afa57e | 792 | enum { |
129fb2d4 JA |
793 | __FIO_OUTPUT_TERSE = 0, |
794 | __FIO_OUTPUT_JSON = 1, | |
795 | __FIO_OUTPUT_NORMAL = 2, | |
513e37ee VF |
796 | __FIO_OUTPUT_JSON_PLUS = 3, |
797 | FIO_OUTPUT_NR = 4, | |
129fb2d4 JA |
798 | |
799 | FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE, | |
800 | FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON, | |
801 | FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL, | |
513e37ee | 802 | FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS, |
f3afa57e JA |
803 | }; |
804 | ||
e25839d4 JA |
805 | enum { |
806 | FIO_RAND_DIST_RANDOM = 0, | |
807 | FIO_RAND_DIST_ZIPF, | |
925fee33 | 808 | FIO_RAND_DIST_PARETO, |
56d9fa4b | 809 | FIO_RAND_DIST_GAUSS, |
e0a04ac1 | 810 | FIO_RAND_DIST_ZONED, |
e25839d4 JA |
811 | }; |
812 | ||
c95f9404 JA |
813 | #define FIO_DEF_ZIPF 1.1 |
814 | #define FIO_DEF_PARETO 0.2 | |
815 | ||
8055e41d JA |
816 | enum { |
817 | FIO_RAND_GEN_TAUSWORTHE = 0, | |
818 | FIO_RAND_GEN_LFSR, | |
c3546b53 | 819 | FIO_RAND_GEN_TAUSWORTHE64, |
8055e41d JA |
820 | }; |
821 | ||
c2acfbac JA |
822 | enum { |
823 | FIO_CPUS_SHARED = 0, | |
824 | FIO_CPUS_SPLIT, | |
825 | }; | |
826 | ||
16e56d25 VF |
827 | enum { |
828 | FIO_STEADYSTATE_IOPS = 0, | |
829 | FIO_STEADYSTATE_IOPS_SLOPE, | |
830 | FIO_STEADYSTATE_BW, | |
831 | FIO_STEADYSTATE_BW_SLOPE, | |
832 | }; | |
833 | ||
834 | ||
ca09be4b JA |
835 | extern void exec_trigger(const char *); |
836 | extern void check_trigger_file(void); | |
837 | ||
ebac4655 | 838 | #endif |