Merge branch 'enable-dataplacement-scheme' of https://github.com/parkvibes/fio
[fio.git] / libfio.c
... / ...
CommitLineData
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
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 *
23 */
24
25#include <string.h>
26#include <signal.h>
27#include <stdint.h>
28#include <locale.h>
29#include <fcntl.h>
30
31#include "fio.h"
32#include "smalloc.h"
33#include "os/os.h"
34#include "filelock.h"
35#include "helper_thread.h"
36#include "filehash.h"
37
38FLIST_HEAD(disk_list);
39
40unsigned long arch_flags = 0;
41
42uintptr_t page_mask = 0;
43uintptr_t page_size = 0;
44
45/* see os/os.h */
46static const char *fio_os_strings[os_nr] = {
47 "Invalid",
48 "Linux",
49 "AIX",
50 "FreeBSD",
51 "HP-UX",
52 "OSX",
53 "NetBSD",
54 "OpenBSD",
55 "Solaris",
56 "Windows",
57 "Android",
58 "DragonFly",
59};
60
61/* see arch/arch.h */
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",
75 "mips",
76 "aarch64",
77 "loongarch64",
78 "riscv64",
79 "generic"
80};
81
82static void reset_io_counters(struct thread_data *td, int all)
83{
84 int ddir;
85
86 if (all) {
87 for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
88 td->stat_io_bytes[ddir] = 0;
89 td->this_io_bytes[ddir] = 0;
90 td->stat_io_blocks[ddir] = 0;
91 td->this_io_blocks[ddir] = 0;
92 td->last_rate_check_bytes[ddir] = 0;
93 td->last_rate_check_blocks[ddir] = 0;
94 td->bytes_done[ddir] = 0;
95 td->rate_io_issue_bytes[ddir] = 0;
96 td->rate_next_io_time[ddir] = 0;
97 td->last_usec[ddir] = 0;
98 }
99 td->bytes_verified = 0;
100 }
101
102 td->zone_bytes = 0;
103
104 td->last_was_sync = false;
105 td->rwmix_issues = 0;
106
107 /*
108 * reset file done count if we are to start over
109 */
110 if (td->o.time_based || td->loops > 1 || td->o.do_verify)
111 td->nr_done_files = 0;
112}
113
114void clear_io_state(struct thread_data *td, int all)
115{
116 struct fio_file *f;
117 unsigned int i;
118
119 reset_io_counters(td, all);
120
121 close_files(td);
122 for_each_file(td, f, i) {
123 fio_file_clear_done(f);
124 f->file_offset = get_start_offset(td, f);
125 }
126
127 /*
128 * Re-Seed random number generator if rand_repeatable is true
129 */
130 if (td->o.rand_repeatable)
131 td_fill_rand_seeds(td);
132}
133
134void reset_all_stats(struct thread_data *td)
135{
136 unsigned long long b;
137 int i;
138
139 reset_io_counters(td, 1);
140
141 b = ddir_rw_sum(td->thinktime_blocks_counter);
142 td->last_thinktime_blocks -= b;
143
144 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
145 td->io_bytes[i] = 0;
146 td->io_blocks[i] = 0;
147 td->io_issues[i] = 0;
148 td->ts.total_io_u[i] = 0;
149 td->ts.runtime[i] = 0;
150 }
151
152 set_epoch_time(td, td->o.log_alternate_epoch_clock_id, td->o.job_start_clock_id);
153 memcpy(&td->start, &td->epoch, sizeof(td->epoch));
154 memcpy(&td->iops_sample_time, &td->epoch, sizeof(td->epoch));
155 memcpy(&td->bw_sample_time, &td->epoch, sizeof(td->epoch));
156 memcpy(&td->ss.prev_time, &td->epoch, sizeof(td->epoch));
157
158 td->last_thinktime = td->epoch;
159
160 lat_target_reset(td);
161 clear_rusage_stat(td);
162 helper_reset();
163}
164
165void reset_fio_state(void)
166{
167 int i;
168
169 groupid = 0;
170 thread_number = 0;
171 cur_segment = 0;
172 for (i = 0; i < nr_segments; i++)
173 segments[i].nr_threads = 0;
174 stat_number = 0;
175 done_secs = 0;
176}
177
178const char *fio_get_os_string(int nr)
179{
180 if (nr < os_nr)
181 return fio_os_strings[nr];
182
183 return NULL;
184}
185
186const char *fio_get_arch_string(int nr)
187{
188 if (nr < arch_nr)
189 return fio_arch_strings[nr];
190
191 return NULL;
192}
193
194static const char *td_runstates[] = {
195 "NOT_CREATED",
196 "CREATED",
197 "INITIALIZED",
198 "RAMP",
199 "SETTING_UP",
200 "RUNNING",
201 "PRE_READING",
202 "VERIFYING",
203 "FSYNCING",
204 "FINISHING",
205 "EXITED",
206 "REAPED",
207};
208
209const char *runstate_to_name(int runstate)
210{
211 compiletime_assert(TD_LAST == 12, "td runstate list");
212 if (runstate >= 0 && runstate < TD_LAST)
213 return td_runstates[runstate];
214
215 return "invalid";
216}
217
218void td_set_runstate(struct thread_data *td, int runstate)
219{
220 if (td->runstate == runstate)
221 return;
222
223 dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
224 runstate_to_name(td->runstate),
225 runstate_to_name(runstate));
226 td->runstate = runstate;
227}
228
229int td_bump_runstate(struct thread_data *td, int new_state)
230{
231 int old_state = td->runstate;
232
233 td_set_runstate(td, new_state);
234 return old_state;
235}
236
237void td_restore_runstate(struct thread_data *td, int old_state)
238{
239 td_set_runstate(td, old_state);
240}
241
242void fio_mark_td_terminate(struct thread_data *td)
243{
244 fio_gettime(&td->terminate_time, NULL);
245 write_barrier();
246 td->terminate = true;
247}
248
249void fio_terminate_threads(unsigned int group_id, unsigned int terminate)
250{
251 pid_t pid = getpid();
252
253 dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
254
255 for_each_td(td) {
256 if ((terminate == TERMINATE_GROUP && group_id == TERMINATE_ALL) ||
257 (terminate == TERMINATE_GROUP && group_id == td->groupid) ||
258 (terminate == TERMINATE_STONEWALL && td->runstate >= TD_RUNNING) ||
259 (terminate == TERMINATE_ALL)) {
260 dprint(FD_PROCESS, "setting terminate on %s/%d\n",
261 td->o.name, (int) td->pid);
262
263 if (td->terminate)
264 continue;
265
266 fio_mark_td_terminate(td);
267 td->o.start_delay = 0;
268
269 /*
270 * if the thread is running, just let it exit
271 */
272 if (!td->pid || pid == td->pid)
273 continue;
274 else if (td->runstate < TD_RAMP)
275 kill(td->pid, SIGTERM);
276 else {
277 struct ioengine_ops *ops = td->io_ops;
278
279 if (ops && ops->terminate)
280 ops->terminate(td);
281 }
282 }
283 } end_for_each();
284}
285
286int fio_running_or_pending_io_threads(void)
287{
288 int nr_io_threads = 0;
289
290 for_each_td(td) {
291 if (td->io_ops_init && td_ioengine_flagged(td, FIO_NOIO))
292 continue;
293 nr_io_threads++;
294 if (td->runstate < TD_EXITED)
295 return 1;
296 } end_for_each();
297
298 if (!nr_io_threads)
299 return -1; /* we only had cpuio threads to begin with */
300 return 0;
301}
302
303int fio_set_fd_nonblocking(int fd, const char *who)
304{
305 int flags;
306
307 flags = fcntl(fd, F_GETFL);
308 if (flags < 0)
309 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
310 else {
311 int new_flags = flags | O_NONBLOCK;
312
313 new_flags = fcntl(fd, F_SETFL, new_flags);
314 if (new_flags < 0)
315 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
316 }
317
318 return flags;
319}
320
321enum {
322 ENDIAN_INVALID_BE = 1,
323 ENDIAN_INVALID_LE,
324 ENDIAN_INVALID_CONFIG,
325 ENDIAN_BROKEN,
326};
327
328static int endian_check(void)
329{
330 union {
331 uint8_t c[8];
332 uint64_t v;
333 } u;
334 int le = 0, be = 0;
335
336 u.v = 0x12;
337 if (u.c[7] == 0x12)
338 be = 1;
339 else if (u.c[0] == 0x12)
340 le = 1;
341
342#if defined(CONFIG_LITTLE_ENDIAN)
343 if (be)
344 return ENDIAN_INVALID_BE;
345#elif defined(CONFIG_BIG_ENDIAN)
346 if (le)
347 return ENDIAN_INVALID_LE;
348#else
349 return ENDIAN_INVALID_CONFIG;
350#endif
351
352 if (!le && !be)
353 return ENDIAN_BROKEN;
354
355 return 0;
356}
357
358int initialize_fio(char *envp[])
359{
360 long ps;
361 int err;
362
363 /*
364 * We need these to be properly 64-bit aligned, otherwise we
365 * can run into problems on archs that fault on unaligned fp
366 * access (ARM).
367 */
368 compiletime_assert((offsetof(struct thread_data, ts) % sizeof(void *)) == 0, "ts");
369 compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
370 compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
371 compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
372 compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
373 compiletime_assert((offsetof(struct thread_data, ts.clat_stat) % 8) == 0, "ts.clat_stat");
374 compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
375 compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
376 compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
377 compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
378 compiletime_assert((offsetof(struct jobs_eta, m_rate) % 8) == 0, "m_rate");
379
380 compiletime_assert(__TD_F_LAST <= TD_ENG_FLAG_SHIFT, "TD_ENG_FLAG_SHIFT");
381 compiletime_assert((__TD_F_LAST + __FIO_IOENGINE_F_LAST) <= 8*sizeof(((struct thread_data *)0)->flags), "td->flags");
382 compiletime_assert(BSSPLIT_MAX <= ZONESPLIT_MAX, "bsssplit/zone max");
383
384 err = endian_check();
385 if (err) {
386 log_err("fio: endianness settings appear wrong.\n");
387 switch (err) {
388 case ENDIAN_INVALID_BE:
389 log_err("fio: got big-endian when configured for little\n");
390 break;
391 case ENDIAN_INVALID_LE:
392 log_err("fio: got little-endian when configured for big\n");
393 break;
394 case ENDIAN_INVALID_CONFIG:
395 log_err("fio: not configured to any endianness\n");
396 break;
397 case ENDIAN_BROKEN:
398 log_err("fio: failed to detect endianness\n");
399 break;
400 default:
401 assert(0);
402 break;
403 }
404 log_err("fio: please report this to fio@vger.kernel.org\n");
405 return 1;
406 }
407
408#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
409#error "No available clock source!"
410#endif
411
412 arch_init(envp);
413
414 sinit();
415
416 if (fio_filelock_init()) {
417 log_err("fio: failed initializing filelock subsys\n");
418 return 1;
419 }
420
421 file_hash_init();
422
423 /*
424 * We need locale for number printing, if it isn't set then just
425 * go with the US format.
426 */
427 if (!getenv("LC_NUMERIC"))
428 setlocale(LC_NUMERIC, "en_US");
429
430 ps = sysconf(_SC_PAGESIZE);
431 if (ps < 0) {
432 log_err("Failed to get page size\n");
433 return 1;
434 }
435
436 page_size = ps;
437 page_mask = ps - 1;
438
439 fio_keywords_init();
440 return 0;
441}
442
443void deinitialize_fio(void)
444{
445 fio_keywords_exit();
446}