io_u_queue: convert rings to bool
[fio.git] / libfio.c
CommitLineData
2e1df07d
JA
1/*
2 * fio - the flexible io tester
3 *
4 * Copyright (C) 2005 Jens Axboe <axboe@suse.de>
5 * Copyright (C) 2006-2012 Jens Axboe <axboe@kernel.dk>
6 *
7 * The license below covers all files distributed with fio unless otherwise
8 * noted in the file itself.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
fa07eaa6 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2e1df07d
JA
22 *
23 */
24
25#include <string.h>
59dfce57
JA
26#include <sys/types.h>
27#include <signal.h>
a569b45f
JA
28#include <stdint.h>
29#include <locale.h>
4a851614 30#include <fcntl.h>
a569b45f 31
2e1df07d 32#include "fio.h"
a569b45f
JA
33#include "smalloc.h"
34#include "os/os.h"
243bfe19 35#include "filelock.h"
a39fb9ea 36#include "helper_thread.h"
d619275c 37#include "filehash.h"
2e1df07d 38
a3efc919 39FLIST_HEAD(disk_list);
a3efc919
JA
40
41unsigned long arch_flags = 0;
42
a569b45f
JA
43uintptr_t page_mask = 0;
44uintptr_t page_size = 0;
45
c6da2c34 46/* see os/os.h */
2e1df07d
JA
47static const char *fio_os_strings[os_nr] = {
48 "Invalid",
49 "Linux",
50 "AIX",
51 "FreeBSD",
52 "HP-UX",
53 "OSX",
54 "NetBSD",
1c7eaa7b 55 "OpenBSD",
2e1df07d 56 "Solaris",
1c7eaa7b
JA
57 "Windows",
58 "Android",
239b2882 59 "DragonFly",
2e1df07d
JA
60};
61
c6da2c34 62/* see arch/arch.h */
2e1df07d
JA
63static const char *fio_arch_strings[arch_nr] = {
64 "Invalid",
65 "x86-64",
66 "x86",
67 "ppc",
68 "ia64",
69 "s390",
70 "alpha",
71 "sparc",
72 "sparc64",
73 "arm",
74 "sh",
75 "hppa",
c6da2c34
TK
76 "mips",
77 "aarch64",
2e1df07d
JA
78 "generic"
79};
80
ac28d905 81static void reset_io_counters(struct thread_data *td, int all)
2e1df07d 82{
6eaf09d6 83 int ddir;
bcd5abfa 84
ac28d905
JA
85 if (all) {
86 for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
87 td->stat_io_bytes[ddir] = 0;
88 td->this_io_bytes[ddir] = 0;
89 td->stat_io_blocks[ddir] = 0;
90 td->this_io_blocks[ddir] = 0;
91 td->rate_bytes[ddir] = 0;
92 td->rate_blocks[ddir] = 0;
93 td->bytes_done[ddir] = 0;
94 td->rate_io_issue_bytes[ddir] = 0;
95 td->rate_next_io_time[ddir] = 0;
96 }
6eaf09d6 97 }
ac28d905 98
2e1df07d 99 td->zone_bytes = 0;
2e1df07d
JA
100
101 td->last_was_sync = 0;
bcd5abfa 102 td->rwmix_issues = 0;
2e1df07d
JA
103
104 /*
105 * reset file done count if we are to start over
106 */
44cbc6da 107 if (td->o.time_based || td->o.loops || td->o.do_verify)
2e1df07d
JA
108 td->nr_done_files = 0;
109}
110
ac28d905 111void clear_io_state(struct thread_data *td, int all)
2e1df07d
JA
112{
113 struct fio_file *f;
114 unsigned int i;
115
ac28d905 116 reset_io_counters(td, all);
2e1df07d
JA
117
118 close_files(td);
ec803e97 119 for_each_file(td, f, i) {
2e1df07d 120 fio_file_clear_done(f);
ec803e97
BF
121 f->file_offset = get_start_offset(td, f);
122 }
2e1df07d
JA
123
124 /*
1520f26e 125 * Re-Seed random number generator if rand_repeatable is true
2e1df07d 126 */
1520f26e
D
127 if (td->o.rand_repeatable)
128 td_fill_rand_seeds(td);
2e1df07d
JA
129}
130
131void reset_all_stats(struct thread_data *td)
132{
2e1df07d
JA
133 int i;
134
ac28d905 135 reset_io_counters(td, 1);
2e1df07d 136
6eaf09d6 137 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
2e1df07d
JA
138 td->io_bytes[i] = 0;
139 td->io_blocks[i] = 0;
140 td->io_issues[i] = 0;
141 td->ts.total_io_u[i] = 0;
6eaf09d6 142 td->ts.runtime[i] = 0;
5b3faae6 143 td->rwmix_issues = 0;
2e1df07d
JA
144 }
145
3aea75b1 146 set_epoch_time(td, td->o.log_unix_epoch);
8b6a404c
VF
147 memcpy(&td->start, &td->epoch, sizeof(td->epoch));
148 memcpy(&td->iops_sample_time, &td->epoch, sizeof(td->epoch));
149 memcpy(&td->bw_sample_time, &td->epoch, sizeof(td->epoch));
150 memcpy(&td->ss.prev_time, &td->epoch, sizeof(td->epoch));
3e260a46 151
6bb58215 152 lat_target_reset(td);
210dd0fc 153 clear_rusage_stat(td);
a47591e4 154 helper_reset();
2e1df07d
JA
155}
156
157void reset_fio_state(void)
158{
159 groupid = 0;
160 thread_number = 0;
2caefeec 161 stat_number = 0;
2e1df07d
JA
162 done_secs = 0;
163}
164
165const char *fio_get_os_string(int nr)
166{
167 if (nr < os_nr)
168 return fio_os_strings[nr];
169
170 return NULL;
171}
172
173const char *fio_get_arch_string(int nr)
174{
175 if (nr < arch_nr)
176 return fio_arch_strings[nr];
177
178 return NULL;
179}
180
6e760cf3
JA
181static const char *td_runstates[] = {
182 "NOT_CREATED",
183 "CREATED",
184 "INITIALIZED",
185 "RAMP",
186 "SETTING_UP",
187 "RUNNING",
188 "PRE_READING",
189 "VERIFYING",
190 "FSYNCING",
191 "FINISHING",
192 "EXITED",
193 "REAPED",
194};
195
9cc8cb91 196const char *runstate_to_name(int runstate)
6e760cf3
JA
197{
198 compiletime_assert(TD_LAST == 12, "td runstate list");
199 if (runstate >= 0 && runstate < TD_LAST)
200 return td_runstates[runstate];
201
202 return "invalid";
203}
204
2e1df07d
JA
205void td_set_runstate(struct thread_data *td, int runstate)
206{
207 if (td->runstate == runstate)
208 return;
209
6e760cf3
JA
210 dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
211 runstate_to_name(td->runstate),
212 runstate_to_name(runstate));
2e1df07d
JA
213 td->runstate = runstate;
214}
215
8edd973d
JA
216int td_bump_runstate(struct thread_data *td, int new_state)
217{
218 int old_state = td->runstate;
219
220 td_set_runstate(td, new_state);
221 return old_state;
222}
223
224void td_restore_runstate(struct thread_data *td, int old_state)
225{
226 td_set_runstate(td, old_state);
227}
228
ebea2133
JA
229void fio_mark_td_terminate(struct thread_data *td)
230{
231 fio_gettime(&td->terminate_time, NULL);
232 write_barrier();
233 td->terminate = 1;
234}
235
d883efbd 236void fio_terminate_threads(unsigned int group_id)
2e1df07d
JA
237{
238 struct thread_data *td;
41fa20ec 239 pid_t pid = getpid();
2e1df07d
JA
240 int i;
241
242 dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
243
244 for_each_td(td, i) {
d883efbd 245 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
2e1df07d
JA
246 dprint(FD_PROCESS, "setting terminate on %s/%d\n",
247 td->o.name, (int) td->pid);
cba5460c
JA
248
249 if (td->terminate)
250 continue;
251
ebea2133 252 fio_mark_td_terminate(td);
2e1df07d
JA
253 td->o.start_delay = 0;
254
255 /*
256 * if the thread is running, just let it exit
257 */
36d80bc7 258 if (!td->pid || pid == td->pid)
2e1df07d
JA
259 continue;
260 else if (td->runstate < TD_RAMP)
261 kill(td->pid, SIGTERM);
36d80bc7 262 else {
2e1df07d
JA
263 struct ioengine_ops *ops = td->io_ops;
264
36d80bc7
JA
265 if (ops && ops->terminate)
266 ops->terminate(td);
2e1df07d
JA
267 }
268 }
269 }
270}
271
046395d7
JA
272int fio_running_or_pending_io_threads(void)
273{
274 struct thread_data *td;
275 int i;
a691d82f 276 int nr_io_threads = 0;
046395d7
JA
277
278 for_each_td(td, i) {
356ef1a1 279 if (td->io_ops_init && td_ioengine_flagged(td, FIO_NOIO))
046395d7 280 continue;
a691d82f 281 nr_io_threads++;
046395d7
JA
282 if (td->runstate < TD_EXITED)
283 return 1;
284 }
285
a691d82f
TK
286 if (!nr_io_threads)
287 return -1; /* we only had cpuio threads to begin with */
046395d7
JA
288 return 0;
289}
290
3a35845f 291int fio_set_fd_nonblocking(int fd, const char *who)
4a851614
JA
292{
293 int flags;
294
295 flags = fcntl(fd, F_GETFL);
296 if (flags < 0)
297 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
298 else {
3a35845f
JA
299 int new_flags = flags | O_NONBLOCK;
300
301 new_flags = fcntl(fd, F_SETFL, new_flags);
302 if (new_flags < 0)
4a851614
JA
303 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
304 }
3a35845f
JA
305
306 return flags;
4a851614
JA
307}
308
1a50e7f0
TK
309enum {
310 ENDIAN_INVALID_BE = 1,
311 ENDIAN_INVALID_LE,
312 ENDIAN_INVALID_CONFIG,
313 ENDIAN_BROKEN,
314};
315
a569b45f
JA
316static int endian_check(void)
317{
318 union {
319 uint8_t c[8];
320 uint64_t v;
321 } u;
322 int le = 0, be = 0;
323
324 u.v = 0x12;
325 if (u.c[7] == 0x12)
326 be = 1;
327 else if (u.c[0] == 0x12)
328 le = 1;
329
330#if defined(CONFIG_LITTLE_ENDIAN)
331 if (be)
1a50e7f0 332 return ENDIAN_INVALID_BE;
a569b45f
JA
333#elif defined(CONFIG_BIG_ENDIAN)
334 if (le)
1a50e7f0 335 return ENDIAN_INVALID_LE;
a569b45f 336#else
1a50e7f0 337 return ENDIAN_INVALID_CONFIG;
a569b45f
JA
338#endif
339
340 if (!le && !be)
1a50e7f0 341 return ENDIAN_BROKEN;
a569b45f
JA
342
343 return 0;
344}
345
346int initialize_fio(char *envp[])
347{
348 long ps;
1a50e7f0 349 int err;
a569b45f 350
976a7756
JA
351 /*
352 * We need these to be properly 64-bit aligned, otherwise we
353 * can run into problems on archs that fault on unaligned fp
354 * access (ARM).
355 */
dbf285f7 356 compiletime_assert((offsetof(struct thread_data, ts) % sizeof(void *)) == 0, "ts");
24ffb6f8 357 compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
3d0ebb30
GG
358 compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
359 compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
24ffb6f8 360 compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
dbf285f7 361 compiletime_assert((offsetof(struct thread_data, ts.clat_stat) % 8) == 0, "ts.clat_stat");
24ffb6f8
JA
362 compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
363 compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
364 compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
b8c6b4de 365 compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
dbf285f7 366 compiletime_assert((offsetof(struct jobs_eta, m_rate) % 8) == 0, "m_rate");
976a7756 367
9c6f1e75
JA
368 compiletime_assert(__TD_F_LAST <= TD_ENG_FLAG_SHIFT, "TD_ENG_FLAG_SHIFT");
369
1a50e7f0
TK
370 err = endian_check();
371 if (err) {
a569b45f 372 log_err("fio: endianness settings appear wrong.\n");
1a50e7f0
TK
373 switch (err) {
374 case ENDIAN_INVALID_BE:
375 log_err("fio: got big-endian when configured for little\n");
376 break;
377 case ENDIAN_INVALID_LE:
378 log_err("fio: got little-endian when configured for big\n");
379 break;
380 case ENDIAN_INVALID_CONFIG:
381 log_err("fio: not configured to any endianness\n");
382 break;
383 case ENDIAN_BROKEN:
384 log_err("fio: failed to detect endianness\n");
385 break;
386 default:
387 assert(0);
388 break;
389 }
a569b45f
JA
390 log_err("fio: please report this to fio@vger.kernel.org\n");
391 return 1;
392 }
393
394#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
395#error "No available clock source!"
396#endif
397
398 arch_init(envp);
399
400 sinit();
401
243bfe19
JA
402 if (fio_filelock_init()) {
403 log_err("fio: failed initializing filelock subsys\n");
404 return 1;
405 }
406
d619275c
JA
407 file_hash_init();
408
a569b45f
JA
409 /*
410 * We need locale for number printing, if it isn't set then just
411 * go with the US format.
412 */
413 if (!getenv("LC_NUMERIC"))
414 setlocale(LC_NUMERIC, "en_US");
415
416 ps = sysconf(_SC_PAGESIZE);
417 if (ps < 0) {
418 log_err("Failed to get page size\n");
419 return 1;
420 }
421
422 page_size = ps;
423 page_mask = ps - 1;
2e1df07d 424
a569b45f
JA
425 fio_keywords_init();
426 return 0;
427}
af1dc266
JA
428
429void deinitialize_fio(void)
430{
431 fio_keywords_exit();
432}