Be more verbose on endianness detection failure
[fio.git] / libfio.c
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>
26 #include <sys/types.h>
27 #include <signal.h>
28 #include <stdint.h>
29 #include <locale.h>
30 #include <fcntl.h>
31
32 #include "fio.h"
33 #include "smalloc.h"
34 #include "os/os.h"
35 #include "filelock.h"
36 #include "helper_thread.h"
37 #include "filehash.h"
38
39 /*
40  * Just expose an empty list, if the OS does not support disk util stats
41  */
42 #ifndef FIO_HAVE_DISK_UTIL
43 FLIST_HEAD(disk_list);
44 #endif
45
46 unsigned long arch_flags = 0;
47
48 uintptr_t page_mask = 0;
49 uintptr_t page_size = 0;
50
51 /* see os/os.h */
52 static const char *fio_os_strings[os_nr] = {
53         "Invalid",
54         "Linux",
55         "AIX",
56         "FreeBSD",
57         "HP-UX",
58         "OSX",
59         "NetBSD",
60         "OpenBSD",
61         "Solaris",
62         "Windows",
63         "Android",
64         "DragonFly",
65 };
66
67 /* see arch/arch.h */
68 static 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",
81         "mips",
82         "aarch64",
83         "generic"
84 };
85
86 static void reset_io_counters(struct thread_data *td, int all)
87 {
88         int ddir;
89
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                 }
102         }
103
104         td->zone_bytes = 0;
105
106         td->last_was_sync = 0;
107         td->rwmix_issues = 0;
108
109         /*
110          * reset file done count if we are to start over
111          */
112         if (td->o.time_based || td->o.loops || td->o.do_verify)
113                 td->nr_done_files = 0;
114 }
115
116 void clear_io_state(struct thread_data *td, int all)
117 {
118         struct fio_file *f;
119         unsigned int i;
120
121         reset_io_counters(td, all);
122
123         close_files(td);
124         for_each_file(td, f, i) {
125                 fio_file_clear_done(f);
126                 f->file_offset = get_start_offset(td, f);
127         }
128
129         /*
130          * Re-Seed random number generator if rand_repeatable is true
131          */
132         if (td->o.rand_repeatable)
133                 td_fill_rand_seeds(td);
134 }
135
136 void reset_all_stats(struct thread_data *td)
137 {
138         int i;
139
140         reset_io_counters(td, 1);
141
142         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
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;
147                 td->ts.runtime[i] = 0;
148                 td->rwmix_issues = 0;
149         }
150
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));
155         memcpy(&td->ss.prev_time, &td->epoch, sizeof(struct timeval));
156
157         lat_target_reset(td);
158         clear_rusage_stat(td);
159         helper_reset();
160 }
161
162 void reset_fio_state(void)
163 {
164         groupid = 0;
165         thread_number = 0;
166         stat_number = 0;
167         done_secs = 0;
168 }
169
170 const 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
178 const 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
186 static 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
201 const char *runstate_to_name(int runstate)
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
210 void td_set_runstate(struct thread_data *td, int runstate)
211 {
212         if (td->runstate == runstate)
213                 return;
214
215         dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
216                                                 runstate_to_name(td->runstate),
217                                                 runstate_to_name(runstate));
218         td->runstate = runstate;
219 }
220
221 int 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
229 void td_restore_runstate(struct thread_data *td, int old_state)
230 {
231         td_set_runstate(td, old_state);
232 }
233
234 void 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
241 void fio_terminate_threads(unsigned int group_id)
242 {
243         struct thread_data *td;
244         pid_t pid = getpid();
245         int i;
246
247         dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
248
249         for_each_td(td, i) {
250                 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
251                         dprint(FD_PROCESS, "setting terminate on %s/%d\n",
252                                                 td->o.name, (int) td->pid);
253
254                         if (td->terminate)
255                                 continue;
256
257                         fio_mark_td_terminate(td);
258                         td->o.start_delay = 0;
259
260                         /*
261                          * if the thread is running, just let it exit
262                          */
263                         if (!td->pid || pid == td->pid)
264                                 continue;
265                         else if (td->runstate < TD_RAMP)
266                                 kill(td->pid, SIGTERM);
267                         else {
268                                 struct ioengine_ops *ops = td->io_ops;
269
270                                 if (ops && ops->terminate)
271                                         ops->terminate(td);
272                         }
273                 }
274         }
275 }
276
277 int fio_running_or_pending_io_threads(void)
278 {
279         struct thread_data *td;
280         int i;
281         int nr_io_threads = 0;
282
283         for_each_td(td, i) {
284                 if (td->flags & TD_F_NOIO)
285                         continue;
286                 nr_io_threads++;
287                 if (td->runstate < TD_EXITED)
288                         return 1;
289         }
290
291         if (!nr_io_threads)
292                 return -1; /* we only had cpuio threads to begin with */
293         return 0;
294 }
295
296 int fio_set_fd_nonblocking(int fd, const char *who)
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 {
304                 int new_flags = flags | O_NONBLOCK;
305
306                 new_flags = fcntl(fd, F_SETFL, new_flags);
307                 if (new_flags < 0)
308                         log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
309         }
310
311         return flags;
312 }
313
314 enum {
315         ENDIAN_INVALID_BE = 1,
316         ENDIAN_INVALID_LE,
317         ENDIAN_INVALID_CONFIG,
318         ENDIAN_BROKEN,
319 };
320
321 static int endian_check(void)
322 {
323         union {
324                 uint8_t c[8];
325                 uint64_t v;
326         } u;
327         int le = 0, be = 0;
328
329         u.v = 0x12;
330         if (u.c[7] == 0x12)
331                 be = 1;
332         else if (u.c[0] == 0x12)
333                 le = 1;
334
335 #if defined(CONFIG_LITTLE_ENDIAN)
336         if (be)
337                 return ENDIAN_INVALID_BE;
338 #elif defined(CONFIG_BIG_ENDIAN)
339         if (le)
340                 return ENDIAN_INVALID_LE;
341 #else
342         return ENDIAN_INVALID_CONFIG;
343 #endif
344
345         if (!le && !be)
346                 return ENDIAN_BROKEN;
347
348         return 0;
349 }
350
351 int initialize_fio(char *envp[])
352 {
353         long ps;
354         int err;
355
356         /*
357          * We need these to be properly 64-bit aligned, otherwise we
358          * can run into problems on archs that fault on unaligned fp
359          * access (ARM).
360          */
361         compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
362         compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
363         compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
364         compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
365         compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
366         compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
367         compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
368         compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
369
370         err = endian_check();
371         if (err) {
372                 log_err("fio: endianness settings appear wrong.\n");
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                 }
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
402         if (fio_filelock_init()) {
403                 log_err("fio: failed initializing filelock subsys\n");
404                 return 1;
405         }
406
407         file_hash_init();
408
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;
424
425         fio_keywords_init();
426         return 0;
427 }
428
429 void deinitialize_fio(void)
430 {
431         fio_keywords_exit();
432 }