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