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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  *
  23  */
  24
  25 #include <string.h>
  26 #include <signal.h>
  27 #include <stdint.h>
  28 #include <locale.h>
  29 #include <fcntl.h>
  30
  31 #include "fio.h"
  32 #include "smalloc.h"
  33 #include "os/os.h"
  34 #include "filelock.h"
  35 #include "helper_thread.h"
  36 #include "filehash.h"
  37 #include "target.h"
  38
  39 FLIST_HEAD(disk_list);
  40
  41 unsigned long arch_flags = 0;
  42
  43 uintptr_t page_mask = 0;
  44 uintptr_t page_size = 0;
  45
  46 /* see os/os.h */
  47 static const char *fio_os_strings[os_nr] = {
  48         "Invalid",
  49         "Linux",
  50         "AIX",
  51         "FreeBSD",
  52         "HP-UX",
  53         "OSX",
  54         "NetBSD",
  55         "OpenBSD",
  56         "Solaris",
  57         "Windows",
  58         "Android",
  59         "DragonFly",
  60 };
  61
  62 /* see arch/arch.h */
  63 static const char *fio_arch_strings[arch_nr] = {
  64         "Invalid",
  65         "x86-64",
  66         "x86",
  67         "ppc",
  68         "ia64",
  69         "s390",
  70         "alpha",
  71         "sparc",
  72         "sparc64",
  73         "arm",
  74         "sh",
  75         "hppa",
  76         "mips",
  77         "aarch64",
  78         "generic"
  79 };
  80
  81 static void reset_io_counters(struct thread_data *td, int all)
  82 {
  83         int ddir;
  84
  85         if (all) {
  86                 for (ddir = 0; ddir < DDIR_RWDIR_CNT; ddir++) {
  87                         td->stat_io_bytes[ddir] = 0;
  88                         td->this_io_bytes[ddir] = 0;
  89                         td->stat_io_blocks[ddir] = 0;
  90                         td->this_io_blocks[ddir] = 0;
  91                         td->rate_bytes[ddir] = 0;
  92                         td->rate_blocks[ddir] = 0;
  93                         td->bytes_done[ddir] = 0;
  94                         td->rate_io_issue_bytes[ddir] = 0;
  95                         td->rate_next_io_time[ddir] = 0;
  96                         td->last_usec[ddir] = 0;
  97                 }
  98         }
  99
 100         td->zone_bytes = 0;
 101
 102         td->last_was_sync = false;
 103         td->rwmix_issues = 0;
 104
 105         /*
 106          * reset file done count if we are to start over
 107          */
 108         if (td->o.time_based || td->o.loops || td->o.do_verify)
 109                 td->nr_done_files = 0;
 110 }
 111
 112 void clear_io_state(struct thread_data *td, int all)
 113 {
 114         struct fio_file *f;
 115         unsigned int i;
 116
 117         reset_io_counters(td, all);
 118
 119         close_files(td);
 120         for_each_file(td, f, i) {
 121                 fio_file_clear_done(f);
 122                 f->file_offset = get_start_offset(td, f);
 123         }
 124
 125         /*
 126          * Re-Seed random number generator if rand_repeatable is true
 127          */
 128         if (td->o.rand_repeatable)
 129                 td_fill_rand_seeds(td);
 130 }
 131
 132 void reset_all_stats(struct thread_data *td)
 133 {
 134         int i;
 135
 136         reset_io_counters(td, 1);
 137
 138         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 139                 td->io_bytes[i] = 0;
 140                 td->io_blocks[i] = 0;
 141                 td->io_issues[i] = 0;
 142                 td->ts.total_io_u[i] = 0;
 143                 td->ts.runtime[i] = 0;
 144                 td->rwmix_issues = 0;
 145         }
 146
 147         set_epoch_time(td, td->o.log_unix_epoch);
 148         memcpy(&td->start, &td->epoch, sizeof(td->epoch));
 149         memcpy(&td->iops_sample_time, &td->epoch, sizeof(td->epoch));
 150         memcpy(&td->bw_sample_time, &td->epoch, sizeof(td->epoch));
 151         memcpy(&td->ss.prev_time, &td->epoch, sizeof(td->epoch));
 152
 153         lat_target_reset(td);
 154         clear_rusage_stat(td);
 155         helper_reset();
 156 }
 157
 158 void reset_fio_state(void)
 159 {
 160         groupid = 0;
 161         thread_number = 0;
 162         stat_number = 0;
 163         done_secs = 0;
 164 }
 165
 166 const char *fio_get_os_string(int nr)
 167 {
 168         if (nr < os_nr)
 169                 return fio_os_strings[nr];
 170
 171         return NULL;
 172 }
 173
 174 const char *fio_get_arch_string(int nr)
 175 {
 176         if (nr < arch_nr)
 177                 return fio_arch_strings[nr];
 178
 179         return NULL;
 180 }
 181
 182 static const char *td_runstates[] = {
 183         "NOT_CREATED",
 184         "CREATED",
 185         "INITIALIZED",
 186         "RAMP",
 187         "SETTING_UP",
 188         "RUNNING",
 189         "PRE_READING",
 190         "VERIFYING",
 191         "FSYNCING",
 192         "FINISHING",
 193         "EXITED",
 194         "REAPED",
 195 };
 196
 197 const char *runstate_to_name(int runstate)
 198 {
 199         compiletime_assert(TD_LAST == 12, "td runstate list");
 200         if (runstate >= 0 && runstate < TD_LAST)
 201                 return td_runstates[runstate];
 202
 203         return "invalid";
 204 }
 205
 206 void td_set_runstate(struct thread_data *td, int runstate)
 207 {
 208         if (td->runstate == runstate)
 209                 return;
 210
 211         dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
 212                                                 runstate_to_name(td->runstate),
 213                                                 runstate_to_name(runstate));
 214         td->runstate = runstate;
 215 }
 216
 217 int td_bump_runstate(struct thread_data *td, int new_state)
 218 {
 219         int old_state = td->runstate;
 220
 221         td_set_runstate(td, new_state);
 222         return old_state;
 223 }
 224
 225 void td_restore_runstate(struct thread_data *td, int old_state)
 226 {
 227         td_set_runstate(td, old_state);
 228 }
 229
 230 void fio_mark_td_terminate(struct thread_data *td)
 231 {
 232         fio_gettime(&td->terminate_time, NULL);
 233         write_barrier();
 234         td->terminate = true;
 235 }
 236
 237 void fio_terminate_threads(unsigned int group_id)
 238 {
 239         struct thread_data *td;
 240         pid_t pid = getpid();
 241         int i;
 242
 243         dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
 244
 245         for_each_td(td, i) {
 246                 if (group_id == TERMINATE_ALL || group_id == td->groupid) {
 247                         dprint(FD_PROCESS, "setting terminate on %s/%d\n",
 248                                                 td->o.name, (int) td->pid);
 249
 250                         if (td->terminate)
 251                                 continue;
 252
 253                         fio_mark_td_terminate(td);
 254                         td->o.start_delay = 0;
 255
 256                         /*
 257                          * if the thread is running, just let it exit
 258                          */
 259                         if (!td->pid || pid == td->pid)
 260                                 continue;
 261                         else if (td->runstate < TD_RAMP)
 262                                 kill(td->pid, SIGTERM);
 263                         else {
 264                                 struct ioengine_ops *ops = td->io_ops;
 265
 266                                 if (ops && ops->terminate)
 267                                         ops->terminate(td);
 268                         }
 269                 }
 270         }
 271 }
 272
 273 int fio_running_or_pending_io_threads(void)
 274 {
 275         struct thread_data *td;
 276         int i;
 277         int nr_io_threads = 0;
 278
 279         for_each_td(td, i) {
 280                 if (td->io_ops_init && td_ioengine_flagged(td, FIO_NOIO))
 281                         continue;
 282                 nr_io_threads++;
 283                 if (td->runstate < TD_EXITED)
 284                         return 1;
 285         }
 286
 287         if (!nr_io_threads)
 288                 return -1; /* we only had cpuio threads to begin with */
 289         return 0;
 290 }
 291
 292 int fio_set_fd_nonblocking(int fd, const char *who)
 293 {
 294         int flags;
 295
 296         flags = fcntl(fd, F_GETFL);
 297         if (flags < 0)
 298                 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 299         else {
 300                 int new_flags = flags | O_NONBLOCK;
 301
 302                 new_flags = fcntl(fd, F_SETFL, new_flags);
 303                 if (new_flags < 0)
 304                         log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 305         }
 306
 307         return flags;
 308 }
 309
 310 enum {
 311         ENDIAN_INVALID_BE = 1,
 312         ENDIAN_INVALID_LE,
 313         ENDIAN_INVALID_CONFIG,
 314         ENDIAN_BROKEN,
 315 };
 316
 317 static int endian_check(void)
 318 {
 319         union {
 320                 uint8_t c[8];
 321                 uint64_t v;
 322         } u;
 323         int le = 0, be = 0;
 324
 325         u.v = 0x12;
 326         if (u.c[7] == 0x12)
 327                 be = 1;
 328         else if (u.c[0] == 0x12)
 329                 le = 1;
 330
 331 #if defined(CONFIG_LITTLE_ENDIAN)
 332         if (be)
 333                 return ENDIAN_INVALID_BE;
 334 #elif defined(CONFIG_BIG_ENDIAN)
 335         if (le)
 336                 return ENDIAN_INVALID_LE;
 337 #else
 338         return ENDIAN_INVALID_CONFIG;
 339 #endif
 340
 341         if (!le && !be)
 342                 return ENDIAN_BROKEN;
 343
 344         return 0;
 345 }
 346
 347 int initialize_fio(char *envp[])
 348 {
 349         long ps;
 350         int err;
 351
 352         /*
 353          * We need these to be properly 64-bit aligned, otherwise we
 354          * can run into problems on archs that fault on unaligned fp
 355          * access (ARM).
 356          */
 357         compiletime_assert((offsetof(struct thread_data, ts) % sizeof(void *)) == 0, "ts");
 358         compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
 359         compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
 360         compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
 361         compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
 362         compiletime_assert((offsetof(struct thread_data, ts.clat_stat) % 8) == 0, "ts.clat_stat");
 363         compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
 364         compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
 365         compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
 366         compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
 367         compiletime_assert((offsetof(struct jobs_eta, m_rate) % 8) == 0, "m_rate");
 368
 369         compiletime_assert(__TD_F_LAST <= TD_ENG_FLAG_SHIFT, "TD_ENG_FLAG_SHIFT");
 370         compiletime_assert(BSSPLIT_MAX <= ZONESPLIT_MAX, "bsssplit/zone max");
 371
 372         err = endian_check();
 373         if (err) {
 374                 log_err("fio: endianness settings appear wrong.\n");
 375                 switch (err) {
 376                 case ENDIAN_INVALID_BE:
 377                         log_err("fio: got big-endian when configured for little\n");
 378                         break;
 379                 case ENDIAN_INVALID_LE:
 380                         log_err("fio: got little-endian when configured for big\n");
 381                         break;
 382                 case ENDIAN_INVALID_CONFIG:
 383                         log_err("fio: not configured to any endianness\n");
 384                         break;
 385                 case ENDIAN_BROKEN:
 386                         log_err("fio: failed to detect endianness\n");
 387                         break;
 388                 default:
 389                         assert(0);
 390                         break;
 391                 }
 392                 log_err("fio: please report this to fio@vger.kernel.org\n");
 393                 return 1;
 394         }
 395
 396 #if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
 397 #error "No available clock source!"
 398 #endif
 399
 400         arch_init(envp);
 401
 402         sinit();
 403
 404         if (fio_filelock_init()) {
 405                 log_err("fio: failed initializing filelock subsys\n");
 406                 return 1;
 407         }
 408
 409         file_hash_init();
 410
 411         /*
 412          * We need locale for number printing, if it isn't set then just
 413          * go with the US format.
 414          */
 415         if (!getenv("LC_NUMERIC"))
 416                 setlocale(LC_NUMERIC, "en_US");
 417
 418         ps = sysconf(_SC_PAGESIZE);
 419         if (ps < 0) {
 420                 log_err("Failed to get page size\n");
 421                 return 1;
 422         }
 423
 424         page_size = ps;
 425         page_mask = ps - 1;
 426
 427         fio_keywords_init();
 428         return 0;
 429 }
 430
 431 void deinitialize_fio(void)
 432 {
 433         fio_keywords_exit();
 434 }