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