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