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