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