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