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
  38 /*
  39  * Just expose an empty list, if the OS does not support disk util stats
  40  */
  41 #ifndef FIO_HAVE_DISK_UTIL
  42 FLIST_HEAD(disk_list);
  43 #endif
  44
  45 unsigned long arch_flags = 0;
  46
  47 uintptr_t page_mask = 0;
  48 uintptr_t page_size = 0;
  49
  50 static const char *fio_os_strings[os_nr] = {
  51         "Invalid",
  52         "Linux",
  53         "AIX",
  54         "FreeBSD",
  55         "HP-UX",
  56         "OSX",
  57         "NetBSD",
  58         "OpenBSD",
  59         "Solaris",
  60         "Windows",
  61         "Android",
  62         "DragonFly",
  63 };
  64
  65 static const char *fio_arch_strings[arch_nr] = {
  66         "Invalid",
  67         "x86-64",
  68         "x86",
  69         "ppc",
  70         "ia64",
  71         "s390",
  72         "alpha",
  73         "sparc",
  74         "sparc64",
  75         "arm",
  76         "sh",
  77         "hppa",
  78         "generic"
  79 };
  80
  81 static void reset_io_counters(struct thread_data *td, int all)
  82 {
  83         int ddir;
  84
  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                 }
  97         }
  98
  99         td->zone_bytes = 0;
 100
 101         td->last_was_sync = 0;
 102         td->rwmix_issues = 0;
 103
 104         /*
 105          * reset file done count if we are to start over
 106          */
 107         if (td->o.time_based || td->o.loops || td->o.do_verify)
 108                 td->nr_done_files = 0;
 109 }
 110
 111 void clear_io_state(struct thread_data *td, int all)
 112 {
 113         struct fio_file *f;
 114         unsigned int i;
 115
 116         reset_io_counters(td, all);
 117
 118         close_files(td);
 119         for_each_file(td, f, i) {
 120                 fio_file_clear_done(f);
 121                 f->file_offset = get_start_offset(td, f);
 122         }
 123
 124         /*
 125          * Re-Seed random number generator if rand_repeatable is true
 126          */
 127         if (td->o.rand_repeatable)
 128                 td_fill_rand_seeds(td);
 129 }
 130
 131 void reset_all_stats(struct thread_data *td)
 132 {
 133         struct timeval tv;
 134         int i;
 135
 136         reset_io_counters(td, 1);
 137
 138         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 139                 td->io_bytes[i] = 0;
 140                 td->io_blocks[i] = 0;
 141                 td->io_issues[i] = 0;
 142                 td->ts.total_io_u[i] = 0;
 143                 td->ts.runtime[i] = 0;
 144                 td->rwmix_issues = 0;
 145         }
 146
 147         fio_gettime(&tv, NULL);
 148         memcpy(&td->epoch, &tv, sizeof(tv));
 149         memcpy(&td->start, &tv, sizeof(tv));
 150         memcpy(&td->iops_sample_time, &tv, sizeof(tv));
 151         memcpy(&td->bw_sample_time, &tv, sizeof(tv));
 152
 153         lat_target_reset(td);
 154         clear_rusage_stat(td);
 155         helper_reset();
 156 }
 157
 158 void reset_fio_state(void)
 159 {
 160         groupid = 0;
 161         thread_number = 0;
 162         stat_number = 0;
 163         done_secs = 0;
 164 }
 165
 166 const char *fio_get_os_string(int nr)
 167 {
 168         if (nr < os_nr)
 169                 return fio_os_strings[nr];
 170
 171         return NULL;
 172 }
 173
 174 const char *fio_get_arch_string(int nr)
 175 {
 176         if (nr < arch_nr)
 177                 return fio_arch_strings[nr];
 178
 179         return NULL;
 180 }
 181
 182 static const char *td_runstates[] = {
 183         "NOT_CREATED",
 184         "CREATED",
 185         "INITIALIZED",
 186         "RAMP",
 187         "SETTING_UP",
 188         "RUNNING",
 189         "PRE_READING",
 190         "VERIFYING",
 191         "FSYNCING",
 192         "FINISHING",
 193         "EXITED",
 194         "REAPED",
 195 };
 196
 197 const char *runstate_to_name(int runstate)
 198 {
 199         compiletime_assert(TD_LAST == 12, "td runstate list");
 200         if (runstate >= 0 && runstate < TD_LAST)
 201                 return td_runstates[runstate];
 202
 203         return "invalid";
 204 }
 205
 206 void td_set_runstate(struct thread_data *td, int runstate)
 207 {
 208         if (td->runstate == runstate)
 209                 return;
 210
 211         dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
 212                                                 runstate_to_name(td->runstate),
 213                                                 runstate_to_name(runstate));
 214         td->runstate = runstate;
 215 }
 216
 217 int td_bump_runstate(struct thread_data *td, int new_state)
 218 {
 219         int old_state = td->runstate;
 220
 221         td_set_runstate(td, new_state);
 222         return old_state;
 223 }
 224
 225 void td_restore_runstate(struct thread_data *td, int old_state)
 226 {
 227         td_set_runstate(td, old_state);
 228 }
 229
 230 void fio_mark_td_terminate(struct thread_data *td)
 231 {
 232         fio_gettime(&td->terminate_time, NULL);
 233         write_barrier();
 234         td->terminate = 1;
 235 }
 236
 237 void fio_terminate_threads(unsigned int group_id)
 238 {
 239         struct thread_data *td;
 240         pid_t pid = getpid();
 241         int i;
 242
 243         dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
 244
 245         for_each_td(td, i) {
 246                 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
 247                         dprint(FD_PROCESS, "setting terminate on %s/%d\n",
 248                                                 td->o.name, (int) td->pid);
 249
 250                         if (td->terminate)
 251                                 continue;
 252
 253                         fio_mark_td_terminate(td);
 254                         td->o.start_delay = 0;
 255
 256                         /*
 257                          * if the thread is running, just let it exit
 258                          */
 259                         if (!td->pid || pid == td->pid)
 260                                 continue;
 261                         else if (td->runstate < TD_RAMP)
 262                                 kill(td->pid, SIGTERM);
 263                         else {
 264                                 struct ioengine_ops *ops = td->io_ops;
 265
 266                                 if (ops && ops->terminate)
 267                                         ops->terminate(td);
 268                         }
 269                 }
 270         }
 271 }
 272
 273 int fio_running_or_pending_io_threads(void)
 274 {
 275         struct thread_data *td;
 276         int i;
 277
 278         for_each_td(td, i) {
 279                 if (td->flags & TD_F_NOIO)
 280                         continue;
 281                 if (td->runstate < TD_EXITED)
 282                         return 1;
 283         }
 284
 285         return 0;
 286 }
 287
 288 int fio_set_fd_nonblocking(int fd, const char *who)
 289 {
 290         int flags;
 291
 292         flags = fcntl(fd, F_GETFL);
 293         if (flags < 0)
 294                 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 295         else {
 296                 int new_flags = flags | O_NONBLOCK;
 297
 298                 new_flags = fcntl(fd, F_SETFL, new_flags);
 299                 if (new_flags < 0)
 300                         log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 301         }
 302
 303         return flags;
 304 }
 305
 306 static int endian_check(void)
 307 {
 308         union {
 309                 uint8_t c[8];
 310                 uint64_t v;
 311         } u;
 312         int le = 0, be = 0;
 313
 314         u.v = 0x12;
 315         if (u.c[7] == 0x12)
 316                 be = 1;
 317         else if (u.c[0] == 0x12)
 318                 le = 1;
 319
 320 #if defined(CONFIG_LITTLE_ENDIAN)
 321         if (be)
 322                 return 1;
 323 #elif defined(CONFIG_BIG_ENDIAN)
 324         if (le)
 325                 return 1;
 326 #else
 327         return 1;
 328 #endif
 329
 330         if (!le && !be)
 331                 return 1;
 332
 333         return 0;
 334 }
 335
 336 int initialize_fio(char *envp[])
 337 {
 338         long ps;
 339
 340         /*
 341          * We need these to be properly 64-bit aligned, otherwise we
 342          * can run into problems on archs that fault on unaligned fp
 343          * access (ARM).
 344          */
 345         compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
 346         compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
 347         compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
 348         compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
 349         compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
 350         compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
 351         compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
 352         compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
 353
 354         if (endian_check()) {
 355                 log_err("fio: endianness settings appear wrong.\n");
 356                 log_err("fio: please report this to fio@vger.kernel.org\n");
 357                 return 1;
 358         }
 359
 360 #if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
 361 #error "No available clock source!"
 362 #endif
 363
 364         arch_init(envp);
 365
 366         sinit();
 367
 368         if (fio_filelock_init()) {
 369                 log_err("fio: failed initializing filelock subsys\n");
 370                 return 1;
 371         }
 372
 373         /*
 374          * We need locale for number printing, if it isn't set then just
 375          * go with the US format.
 376          */
 377         if (!getenv("LC_NUMERIC"))
 378                 setlocale(LC_NUMERIC, "en_US");
 379
 380         ps = sysconf(_SC_PAGESIZE);
 381         if (ps < 0) {
 382                 log_err("Failed to get page size\n");
 383                 return 1;
 384         }
 385
 386         page_size = ps;
 387         page_mask = ps - 1;
 388
 389         fio_keywords_init();
 390         return 0;
 391 }
 392
 393 void deinitialize_fio(void)
 394 {
 395         fio_keywords_exit();
 396 }