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
 156         lat_target_reset(td);
 157         clear_rusage_stat(td);
 158         helper_reset();
 159 }
 160
 161 void reset_fio_state(void)
 162 {
 163         groupid = 0;
 164         thread_number = 0;
 165         stat_number = 0;
 166         done_secs = 0;
 167 }
 168
 169 const char *fio_get_os_string(int nr)
 170 {
 171         if (nr < os_nr)
 172                 return fio_os_strings[nr];
 173
 174         return NULL;
 175 }
 176
 177 const char *fio_get_arch_string(int nr)
 178 {
 179         if (nr < arch_nr)
 180                 return fio_arch_strings[nr];
 181
 182         return NULL;
 183 }
 184
 185 static const char *td_runstates[] = {
 186         "NOT_CREATED",
 187         "CREATED",
 188         "INITIALIZED",
 189         "RAMP",
 190         "SETTING_UP",
 191         "RUNNING",
 192         "PRE_READING",
 193         "VERIFYING",
 194         "FSYNCING",
 195         "FINISHING",
 196         "EXITED",
 197         "REAPED",
 198 };
 199
 200 const char *runstate_to_name(int runstate)
 201 {
 202         compiletime_assert(TD_LAST == 12, "td runstate list");
 203         if (runstate >= 0 && runstate < TD_LAST)
 204                 return td_runstates[runstate];
 205
 206         return "invalid";
 207 }
 208
 209 void td_set_runstate(struct thread_data *td, int runstate)
 210 {
 211         if (td->runstate == runstate)
 212                 return;
 213
 214         dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
 215                                                 runstate_to_name(td->runstate),
 216                                                 runstate_to_name(runstate));
 217         td->runstate = runstate;
 218 }
 219
 220 int td_bump_runstate(struct thread_data *td, int new_state)
 221 {
 222         int old_state = td->runstate;
 223
 224         td_set_runstate(td, new_state);
 225         return old_state;
 226 }
 227
 228 void td_restore_runstate(struct thread_data *td, int old_state)
 229 {
 230         td_set_runstate(td, old_state);
 231 }
 232
 233 void fio_mark_td_terminate(struct thread_data *td)
 234 {
 235         fio_gettime(&td->terminate_time, NULL);
 236         write_barrier();
 237         td->terminate = 1;
 238 }
 239
 240 void fio_terminate_threads(unsigned int group_id)
 241 {
 242         struct thread_data *td;
 243         pid_t pid = getpid();
 244         int i;
 245
 246         dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
 247
 248         for_each_td(td, i) {
 249                 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
 250                         dprint(FD_PROCESS, "setting terminate on %s/%d\n",
 251                                                 td->o.name, (int) td->pid);
 252
 253                         if (td->terminate)
 254                                 continue;
 255
 256                         fio_mark_td_terminate(td);
 257                         td->o.start_delay = 0;
 258
 259                         /*
 260                          * if the thread is running, just let it exit
 261                          */
 262                         if (!td->pid || pid == td->pid)
 263                                 continue;
 264                         else if (td->runstate < TD_RAMP)
 265                                 kill(td->pid, SIGTERM);
 266                         else {
 267                                 struct ioengine_ops *ops = td->io_ops;
 268
 269                                 if (ops && ops->terminate)
 270                                         ops->terminate(td);
 271                         }
 272                 }
 273         }
 274 }
 275
 276 int fio_running_or_pending_io_threads(void)
 277 {
 278         struct thread_data *td;
 279         int i;
 280         int nr_io_threads = 0;
 281
 282         for_each_td(td, i) {
 283                 if (td->flags & TD_F_NOIO)
 284                         continue;
 285                 nr_io_threads++;
 286                 if (td->runstate < TD_EXITED)
 287                         return 1;
 288         }
 289
 290         if (!nr_io_threads)
 291                 return -1; /* we only had cpuio threads to begin with */
 292         return 0;
 293 }
 294
 295 int fio_set_fd_nonblocking(int fd, const char *who)
 296 {
 297         int flags;
 298
 299         flags = fcntl(fd, F_GETFL);
 300         if (flags < 0)
 301                 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 302         else {
 303                 int new_flags = flags | O_NONBLOCK;
 304
 305                 new_flags = fcntl(fd, F_SETFL, new_flags);
 306                 if (new_flags < 0)
 307                         log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 308         }
 309
 310         return flags;
 311 }
 312
 313 static int endian_check(void)
 314 {
 315         union {
 316                 uint8_t c[8];
 317                 uint64_t v;
 318         } u;
 319         int le = 0, be = 0;
 320
 321         u.v = 0x12;
 322         if (u.c[7] == 0x12)
 323                 be = 1;
 324         else if (u.c[0] == 0x12)
 325                 le = 1;
 326
 327 #if defined(CONFIG_LITTLE_ENDIAN)
 328         if (be)
 329                 return 1;
 330 #elif defined(CONFIG_BIG_ENDIAN)
 331         if (le)
 332                 return 1;
 333 #else
 334         return 1;
 335 #endif
 336
 337         if (!le && !be)
 338                 return 1;
 339
 340         return 0;
 341 }
 342
 343 int initialize_fio(char *envp[])
 344 {
 345         long ps;
 346
 347         /*
 348          * We need these to be properly 64-bit aligned, otherwise we
 349          * can run into problems on archs that fault on unaligned fp
 350          * access (ARM).
 351          */
 352         compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
 353         compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
 354         compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
 355         compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
 356         compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
 357         compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
 358         compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
 359         compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
 360
 361         if (endian_check()) {
 362                 log_err("fio: endianness settings appear wrong.\n");
 363                 log_err("fio: please report this to fio@vger.kernel.org\n");
 364                 return 1;
 365         }
 366
 367 #if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
 368 #error "No available clock source!"
 369 #endif
 370
 371         arch_init(envp);
 372
 373         sinit();
 374
 375         if (fio_filelock_init()) {
 376                 log_err("fio: failed initializing filelock subsys\n");
 377                 return 1;
 378         }
 379
 380         file_hash_init();
 381
 382         /*
 383          * We need locale for number printing, if it isn't set then just
 384          * go with the US format.
 385          */
 386         if (!getenv("LC_NUMERIC"))
 387                 setlocale(LC_NUMERIC, "en_US");
 388
 389         ps = sysconf(_SC_PAGESIZE);
 390         if (ps < 0) {
 391                 log_err("Failed to get page size\n");
 392                 return 1;
 393         }
 394
 395         page_size = ps;
 396         page_mask = ps - 1;
 397
 398         fio_keywords_init();
 399         return 0;
 400 }
 401
 402 void deinitialize_fio(void)
 403 {
 404         fio_keywords_exit();
 405 }