Merge branch 'evelu-fix-engines' of https://github.com/ErwanAliasr1/fio
[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 26#include <signal.h>
a569b45f
JA
27#include <stdint.h>
28#include <locale.h>
4a851614 29#include <fcntl.h>
a569b45f 30
2e1df07d 31#include "fio.h"
a569b45f
JA
32#include "smalloc.h"
33#include "os/os.h"
243bfe19 34#include "filelock.h"
a39fb9ea 35#include "helper_thread.h"
d619275c 36#include "filehash.h"
2e1df07d 37
a3efc919 38FLIST_HEAD(disk_list);
a3efc919
JA
39
40unsigned long arch_flags = 0;
41
a569b45f
JA
42uintptr_t page_mask = 0;
43uintptr_t page_size = 0;
44
c6da2c34 45/* see os/os.h */
2e1df07d
JA
46static const char *fio_os_strings[os_nr] = {
47 "Invalid",
48 "Linux",
49 "AIX",
50 "FreeBSD",
51 "HP-UX",
52 "OSX",
53 "NetBSD",
1c7eaa7b 54 "OpenBSD",
2e1df07d 55 "Solaris",
1c7eaa7b
JA
56 "Windows",
57 "Android",
239b2882 58 "DragonFly",
2e1df07d
JA
59};
60
c6da2c34 61/* see arch/arch.h */
2e1df07d
JA
62static const char *fio_arch_strings[arch_nr] = {
63 "Invalid",
64 "x86-64",
65 "x86",
66 "ppc",
67 "ia64",
68 "s390",
69 "alpha",
70 "sparc",
71 "sparc64",
72 "arm",
73 "sh",
74 "hppa",
c6da2c34
TK
75 "mips",
76 "aarch64",
2e1df07d
JA
77 "generic"
78};
79
ac28d905 80static void reset_io_counters(struct thread_data *td, int all)
2e1df07d 81{
6eaf09d6 82 int ddir;
bcd5abfa 83
ac28d905
JA
84 if (all) {
85 for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
86 td->stat_io_bytes[ddir] = 0;
87 td->this_io_bytes[ddir] = 0;
88 td->stat_io_blocks[ddir] = 0;
89 td->this_io_blocks[ddir] = 0;
90 td->rate_bytes[ddir] = 0;
91 td->rate_blocks[ddir] = 0;
92 td->bytes_done[ddir] = 0;
93 td->rate_io_issue_bytes[ddir] = 0;
94 td->rate_next_io_time[ddir] = 0;
182cab24 95 td->last_usec[ddir] = 0;
ac28d905 96 }
6eaf09d6 97 }
ac28d905 98
2e1df07d 99 td->zone_bytes = 0;
2e1df07d 100
2ea93f98 101 td->last_was_sync = false;
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{
2fbe1e19
JA
159 int i;
160
2e1df07d
JA
161 groupid = 0;
162 thread_number = 0;
2fbe1e19
JA
163 cur_segment = 0;
164 for (i = 0; i < nr_segments; i++)
165 segments[i].nr_threads = 0;
2caefeec 166 stat_number = 0;
2e1df07d
JA
167 done_secs = 0;
168}
169
170const char *fio_get_os_string(int nr)
171{
172 if (nr < os_nr)
173 return fio_os_strings[nr];
174
175 return NULL;
176}
177
178const char *fio_get_arch_string(int nr)
179{
180 if (nr < arch_nr)
181 return fio_arch_strings[nr];
182
183 return NULL;
184}
185
6e760cf3
JA
186static const char *td_runstates[] = {
187 "NOT_CREATED",
188 "CREATED",
189 "INITIALIZED",
190 "RAMP",
191 "SETTING_UP",
192 "RUNNING",
193 "PRE_READING",
194 "VERIFYING",
195 "FSYNCING",
196 "FINISHING",
197 "EXITED",
198 "REAPED",
199};
200
9cc8cb91 201const char *runstate_to_name(int runstate)
6e760cf3
JA
202{
203 compiletime_assert(TD_LAST == 12, "td runstate list");
204 if (runstate >= 0 && runstate < TD_LAST)
205 return td_runstates[runstate];
206
207 return "invalid";
208}
209
2e1df07d
JA
210void td_set_runstate(struct thread_data *td, int runstate)
211{
212 if (td->runstate == runstate)
213 return;
214
6e760cf3
JA
215 dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
216 runstate_to_name(td->runstate),
217 runstate_to_name(runstate));
2e1df07d
JA
218 td->runstate = runstate;
219}
220
8edd973d
JA
221int td_bump_runstate(struct thread_data *td, int new_state)
222{
223 int old_state = td->runstate;
224
225 td_set_runstate(td, new_state);
226 return old_state;
227}
228
229void td_restore_runstate(struct thread_data *td, int old_state)
230{
231 td_set_runstate(td, old_state);
232}
233
ebea2133
JA
234void fio_mark_td_terminate(struct thread_data *td)
235{
236 fio_gettime(&td->terminate_time, NULL);
237 write_barrier();
2ea93f98 238 td->terminate = true;
ebea2133
JA
239}
240
64402a8a 241void fio_terminate_threads(unsigned int group_id, unsigned int terminate)
2e1df07d
JA
242{
243 struct thread_data *td;
41fa20ec 244 pid_t pid = getpid();
2e1df07d
JA
245 int i;
246
247 dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
248
249 for_each_td(td, i) {
64402a8a
HW
250 if ((terminate == TERMINATE_GROUP && group_id == TERMINATE_ALL) ||
251 (terminate == TERMINATE_GROUP && group_id == td->groupid) ||
252 (terminate == TERMINATE_STONEWALL && td->runstate >= TD_RUNNING) ||
253 (terminate == TERMINATE_ALL)) {
2e1df07d
JA
254 dprint(FD_PROCESS, "setting terminate on %s/%d\n",
255 td->o.name, (int) td->pid);
cba5460c
JA
256
257 if (td->terminate)
258 continue;
259
ebea2133 260 fio_mark_td_terminate(td);
2e1df07d
JA
261 td->o.start_delay = 0;
262
263 /*
264 * if the thread is running, just let it exit
265 */
36d80bc7 266 if (!td->pid || pid == td->pid)
2e1df07d
JA
267 continue;
268 else if (td->runstate < TD_RAMP)
269 kill(td->pid, SIGTERM);
36d80bc7 270 else {
2e1df07d
JA
271 struct ioengine_ops *ops = td->io_ops;
272
36d80bc7
JA
273 if (ops && ops->terminate)
274 ops->terminate(td);
2e1df07d
JA
275 }
276 }
277 }
278}
279
046395d7
JA
280int fio_running_or_pending_io_threads(void)
281{
282 struct thread_data *td;
283 int i;
a691d82f 284 int nr_io_threads = 0;
046395d7
JA
285
286 for_each_td(td, i) {
356ef1a1 287 if (td->io_ops_init && td_ioengine_flagged(td, FIO_NOIO))
046395d7 288 continue;
a691d82f 289 nr_io_threads++;
046395d7
JA
290 if (td->runstate < TD_EXITED)
291 return 1;
292 }
293
a691d82f
TK
294 if (!nr_io_threads)
295 return -1; /* we only had cpuio threads to begin with */
046395d7
JA
296 return 0;
297}
298
3a35845f 299int fio_set_fd_nonblocking(int fd, const char *who)
4a851614
JA
300{
301 int flags;
302
303 flags = fcntl(fd, F_GETFL);
304 if (flags < 0)
305 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
306 else {
3a35845f
JA
307 int new_flags = flags | O_NONBLOCK;
308
309 new_flags = fcntl(fd, F_SETFL, new_flags);
310 if (new_flags < 0)
4a851614
JA
311 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
312 }
3a35845f
JA
313
314 return flags;
4a851614
JA
315}
316
1a50e7f0
TK
317enum {
318 ENDIAN_INVALID_BE = 1,
319 ENDIAN_INVALID_LE,
320 ENDIAN_INVALID_CONFIG,
321 ENDIAN_BROKEN,
322};
323
a569b45f
JA
324static int endian_check(void)
325{
326 union {
327 uint8_t c[8];
328 uint64_t v;
329 } u;
330 int le = 0, be = 0;
331
332 u.v = 0x12;
333 if (u.c[7] == 0x12)
334 be = 1;
335 else if (u.c[0] == 0x12)
336 le = 1;
337
338#if defined(CONFIG_LITTLE_ENDIAN)
339 if (be)
1a50e7f0 340 return ENDIAN_INVALID_BE;
a569b45f
JA
341#elif defined(CONFIG_BIG_ENDIAN)
342 if (le)
1a50e7f0 343 return ENDIAN_INVALID_LE;
a569b45f 344#else
1a50e7f0 345 return ENDIAN_INVALID_CONFIG;
a569b45f
JA
346#endif
347
348 if (!le && !be)
1a50e7f0 349 return ENDIAN_BROKEN;
a569b45f
JA
350
351 return 0;
352}
353
354int initialize_fio(char *envp[])
355{
356 long ps;
1a50e7f0 357 int err;
a569b45f 358
976a7756
JA
359 /*
360 * We need these to be properly 64-bit aligned, otherwise we
361 * can run into problems on archs that fault on unaligned fp
362 * access (ARM).
363 */
dbf285f7 364 compiletime_assert((offsetof(struct thread_data, ts) % sizeof(void *)) == 0, "ts");
24ffb6f8 365 compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
3d0ebb30
GG
366 compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
367 compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
24ffb6f8 368 compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
dbf285f7 369 compiletime_assert((offsetof(struct thread_data, ts.clat_stat) % 8) == 0, "ts.clat_stat");
24ffb6f8
JA
370 compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
371 compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
372 compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
b8c6b4de 373 compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
dbf285f7 374 compiletime_assert((offsetof(struct jobs_eta, m_rate) % 8) == 0, "m_rate");
976a7756 375
9c6f1e75 376 compiletime_assert(__TD_F_LAST <= TD_ENG_FLAG_SHIFT, "TD_ENG_FLAG_SHIFT");
3154f1ed 377 compiletime_assert(BSSPLIT_MAX <= ZONESPLIT_MAX, "bsssplit/zone max");
9c6f1e75 378
1a50e7f0
TK
379 err = endian_check();
380 if (err) {
a569b45f 381 log_err("fio: endianness settings appear wrong.\n");
1a50e7f0
TK
382 switch (err) {
383 case ENDIAN_INVALID_BE:
384 log_err("fio: got big-endian when configured for little\n");
385 break;
386 case ENDIAN_INVALID_LE:
387 log_err("fio: got little-endian when configured for big\n");
388 break;
389 case ENDIAN_INVALID_CONFIG:
390 log_err("fio: not configured to any endianness\n");
391 break;
392 case ENDIAN_BROKEN:
393 log_err("fio: failed to detect endianness\n");
394 break;
395 default:
396 assert(0);
397 break;
398 }
a569b45f
JA
399 log_err("fio: please report this to fio@vger.kernel.org\n");
400 return 1;
401 }
402
403#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
404#error "No available clock source!"
405#endif
406
407 arch_init(envp);
408
409 sinit();
410
243bfe19
JA
411 if (fio_filelock_init()) {
412 log_err("fio: failed initializing filelock subsys\n");
413 return 1;
414 }
415
d619275c
JA
416 file_hash_init();
417
a569b45f
JA
418 /*
419 * We need locale for number printing, if it isn't set then just
420 * go with the US format.
421 */
422 if (!getenv("LC_NUMERIC"))
423 setlocale(LC_NUMERIC, "en_US");
424
425 ps = sysconf(_SC_PAGESIZE);
426 if (ps < 0) {
427 log_err("Failed to get page size\n");
428 return 1;
429 }
430
431 page_size = ps;
432 page_mask = ps - 1;
2e1df07d 433
a569b45f
JA
434 fio_keywords_init();
435 return 0;
436}
af1dc266
JA
437
438void deinitialize_fio(void)
439{
440 fio_keywords_exit();
441}