Fix README regarding fio snapshots
[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
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
JA
39/*
40 * Just expose an empty list, if the OS does not support disk util stats
41 */
42#ifndef FIO_HAVE_DISK_UTIL
43FLIST_HEAD(disk_list);
44#endif
45
46unsigned long arch_flags = 0;
47
a569b45f
JA
48uintptr_t page_mask = 0;
49uintptr_t page_size = 0;
50
c6da2c34 51/* see os/os.h */
2e1df07d
JA
52static const char *fio_os_strings[os_nr] = {
53 "Invalid",
54 "Linux",
55 "AIX",
56 "FreeBSD",
57 "HP-UX",
58 "OSX",
59 "NetBSD",
1c7eaa7b 60 "OpenBSD",
2e1df07d 61 "Solaris",
1c7eaa7b
JA
62 "Windows",
63 "Android",
239b2882 64 "DragonFly",
2e1df07d
JA
65};
66
c6da2c34 67/* see arch/arch.h */
2e1df07d
JA
68static const char *fio_arch_strings[arch_nr] = {
69 "Invalid",
70 "x86-64",
71 "x86",
72 "ppc",
73 "ia64",
74 "s390",
75 "alpha",
76 "sparc",
77 "sparc64",
78 "arm",
79 "sh",
80 "hppa",
c6da2c34
TK
81 "mips",
82 "aarch64",
2e1df07d
JA
83 "generic"
84};
85
ac28d905 86static void reset_io_counters(struct thread_data *td, int all)
2e1df07d 87{
6eaf09d6 88 int ddir;
bcd5abfa 89
ac28d905
JA
90 if (all) {
91 for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
92 td->stat_io_bytes[ddir] = 0;
93 td->this_io_bytes[ddir] = 0;
94 td->stat_io_blocks[ddir] = 0;
95 td->this_io_blocks[ddir] = 0;
96 td->rate_bytes[ddir] = 0;
97 td->rate_blocks[ddir] = 0;
98 td->bytes_done[ddir] = 0;
99 td->rate_io_issue_bytes[ddir] = 0;
100 td->rate_next_io_time[ddir] = 0;
101 }
6eaf09d6 102 }
ac28d905 103
2e1df07d 104 td->zone_bytes = 0;
2e1df07d
JA
105
106 td->last_was_sync = 0;
bcd5abfa 107 td->rwmix_issues = 0;
2e1df07d
JA
108
109 /*
110 * reset file done count if we are to start over
111 */
44cbc6da 112 if (td->o.time_based || td->o.loops || td->o.do_verify)
2e1df07d
JA
113 td->nr_done_files = 0;
114}
115
ac28d905 116void clear_io_state(struct thread_data *td, int all)
2e1df07d
JA
117{
118 struct fio_file *f;
119 unsigned int i;
120
ac28d905 121 reset_io_counters(td, all);
2e1df07d
JA
122
123 close_files(td);
ec803e97 124 for_each_file(td, f, i) {
2e1df07d 125 fio_file_clear_done(f);
ec803e97
BF
126 f->file_offset = get_start_offset(td, f);
127 }
2e1df07d
JA
128
129 /*
1520f26e 130 * Re-Seed random number generator if rand_repeatable is true
2e1df07d 131 */
1520f26e
D
132 if (td->o.rand_repeatable)
133 td_fill_rand_seeds(td);
2e1df07d
JA
134}
135
136void reset_all_stats(struct thread_data *td)
137{
2e1df07d
JA
138 int i;
139
ac28d905 140 reset_io_counters(td, 1);
2e1df07d 141
6eaf09d6 142 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
2e1df07d
JA
143 td->io_bytes[i] = 0;
144 td->io_blocks[i] = 0;
145 td->io_issues[i] = 0;
146 td->ts.total_io_u[i] = 0;
6eaf09d6 147 td->ts.runtime[i] = 0;
5b3faae6 148 td->rwmix_issues = 0;
2e1df07d
JA
149 }
150
3aea75b1
KC
151 set_epoch_time(td, td->o.log_unix_epoch);
152 memcpy(&td->start, &td->epoch, sizeof(struct timeval));
153 memcpy(&td->iops_sample_time, &td->epoch, sizeof(struct timeval));
154 memcpy(&td->bw_sample_time, &td->epoch, sizeof(struct timeval));
c7334fa3 155 memcpy(&td->ss.prev_time, &td->epoch, sizeof(struct timeval));
3e260a46 156
6bb58215 157 lat_target_reset(td);
210dd0fc 158 clear_rusage_stat(td);
a47591e4 159 helper_reset();
2e1df07d
JA
160}
161
162void reset_fio_state(void)
163{
164 groupid = 0;
165 thread_number = 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();
238 td->terminate = 1;
239}
240
d883efbd 241void fio_terminate_threads(unsigned int group_id)
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) {
d883efbd 250 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
2e1df07d
JA
251 dprint(FD_PROCESS, "setting terminate on %s/%d\n",
252 td->o.name, (int) td->pid);
cba5460c
JA
253
254 if (td->terminate)
255 continue;
256
ebea2133 257 fio_mark_td_terminate(td);
2e1df07d
JA
258 td->o.start_delay = 0;
259
260 /*
261 * if the thread is running, just let it exit
262 */
36d80bc7 263 if (!td->pid || pid == td->pid)
2e1df07d
JA
264 continue;
265 else if (td->runstate < TD_RAMP)
266 kill(td->pid, SIGTERM);
36d80bc7 267 else {
2e1df07d
JA
268 struct ioengine_ops *ops = td->io_ops;
269
36d80bc7
JA
270 if (ops && ops->terminate)
271 ops->terminate(td);
2e1df07d
JA
272 }
273 }
274 }
275}
276
046395d7
JA
277int fio_running_or_pending_io_threads(void)
278{
279 struct thread_data *td;
280 int i;
a691d82f 281 int nr_io_threads = 0;
046395d7
JA
282
283 for_each_td(td, i) {
284 if (td->flags & TD_F_NOIO)
285 continue;
a691d82f 286 nr_io_threads++;
046395d7
JA
287 if (td->runstate < TD_EXITED)
288 return 1;
289 }
290
a691d82f
TK
291 if (!nr_io_threads)
292 return -1; /* we only had cpuio threads to begin with */
046395d7
JA
293 return 0;
294}
295
3a35845f 296int fio_set_fd_nonblocking(int fd, const char *who)
4a851614
JA
297{
298 int flags;
299
300 flags = fcntl(fd, F_GETFL);
301 if (flags < 0)
302 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
303 else {
3a35845f
JA
304 int new_flags = flags | O_NONBLOCK;
305
306 new_flags = fcntl(fd, F_SETFL, new_flags);
307 if (new_flags < 0)
4a851614
JA
308 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
309 }
3a35845f
JA
310
311 return flags;
4a851614
JA
312}
313
a569b45f
JA
314static int endian_check(void)
315{
316 union {
317 uint8_t c[8];
318 uint64_t v;
319 } u;
320 int le = 0, be = 0;
321
322 u.v = 0x12;
323 if (u.c[7] == 0x12)
324 be = 1;
325 else if (u.c[0] == 0x12)
326 le = 1;
327
328#if defined(CONFIG_LITTLE_ENDIAN)
329 if (be)
330 return 1;
331#elif defined(CONFIG_BIG_ENDIAN)
332 if (le)
333 return 1;
334#else
335 return 1;
336#endif
337
338 if (!le && !be)
339 return 1;
340
341 return 0;
342}
343
344int initialize_fio(char *envp[])
345{
346 long ps;
347
976a7756
JA
348 /*
349 * We need these to be properly 64-bit aligned, otherwise we
350 * can run into problems on archs that fault on unaligned fp
351 * access (ARM).
352 */
24ffb6f8 353 compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
3d0ebb30
GG
354 compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
355 compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
24ffb6f8
JA
356 compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
357 compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
358 compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
359 compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
b8c6b4de 360 compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
976a7756 361
a569b45f
JA
362 if (endian_check()) {
363 log_err("fio: endianness settings appear wrong.\n");
364 log_err("fio: please report this to fio@vger.kernel.org\n");
365 return 1;
366 }
367
368#if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
369#error "No available clock source!"
370#endif
371
372 arch_init(envp);
373
374 sinit();
375
243bfe19
JA
376 if (fio_filelock_init()) {
377 log_err("fio: failed initializing filelock subsys\n");
378 return 1;
379 }
380
d619275c
JA
381 file_hash_init();
382
a569b45f
JA
383 /*
384 * We need locale for number printing, if it isn't set then just
385 * go with the US format.
386 */
387 if (!getenv("LC_NUMERIC"))
388 setlocale(LC_NUMERIC, "en_US");
389
390 ps = sysconf(_SC_PAGESIZE);
391 if (ps < 0) {
392 log_err("Failed to get page size\n");
393 return 1;
394 }
395
396 page_size = ps;
397 page_mask = ps - 1;
2e1df07d 398
a569b45f
JA
399 fio_keywords_init();
400 return 0;
401}
af1dc266
JA
402
403void deinitialize_fio(void)
404{
405 fio_keywords_exit();
406}