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->last_rate_check_bytes[ddir] = 0;
  91                         td->last_rate_check_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                 td->bytes_verified = 0;
  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->loops > 1 || 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         unsigned long long b;
 135         int i;
 136
 137         reset_io_counters(td, 1);
 138
 139         b = ddir_rw_sum(td->thinktime_blocks_counter);
 140         td->last_thinktime_blocks -= b;
 141
 142         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
 143                 td->io_bytes[i] = 0;
 144                 td->io_blocks[i] = 0;
 145                 td->io_issues[i] = 0;
 146                 td->ts.total_io_u[i] = 0;
 147                 td->ts.runtime[i] = 0;
 148         }
 149
 150         set_epoch_time(td, td->o.log_unix_epoch | td->o.log_alternate_epoch, td->o.log_alternate_epoch_clock_id);
 151         memcpy(&td->start, &td->epoch, sizeof(td->epoch));
 152         memcpy(&td->iops_sample_time, &td->epoch, sizeof(td->epoch));
 153         memcpy(&td->bw_sample_time, &td->epoch, sizeof(td->epoch));
 154         memcpy(&td->ss.prev_time, &td->epoch, sizeof(td->epoch));
 155
 156         td->last_thinktime = td->epoch;
 157
 158         lat_target_reset(td);
 159         clear_rusage_stat(td);
 160         helper_reset();
 161 }
 162
 163 void reset_fio_state(void)
 164 {
 165         int i;
 166
 167         groupid = 0;
 168         thread_number = 0;
 169         cur_segment = 0;
 170         for (i = 0; i < nr_segments; i++)
 171                 segments[i].nr_threads = 0;
 172         stat_number = 0;
 173         done_secs = 0;
 174 }
 175
 176 const char *fio_get_os_string(int nr)
 177 {
 178         if (nr < os_nr)
 179                 return fio_os_strings[nr];
 180
 181         return NULL;
 182 }
 183
 184 const char *fio_get_arch_string(int nr)
 185 {
 186         if (nr < arch_nr)
 187                 return fio_arch_strings[nr];
 188
 189         return NULL;
 190 }
 191
 192 static const char *td_runstates[] = {
 193         "NOT_CREATED",
 194         "CREATED",
 195         "INITIALIZED",
 196         "RAMP",
 197         "SETTING_UP",
 198         "RUNNING",
 199         "PRE_READING",
 200         "VERIFYING",
 201         "FSYNCING",
 202         "FINISHING",
 203         "EXITED",
 204         "REAPED",
 205 };
 206
 207 const char *runstate_to_name(int runstate)
 208 {
 209         compiletime_assert(TD_LAST == 12, "td runstate list");
 210         if (runstate >= 0 && runstate < TD_LAST)
 211                 return td_runstates[runstate];
 212
 213         return "invalid";
 214 }
 215
 216 void td_set_runstate(struct thread_data *td, int runstate)
 217 {
 218         if (td->runstate == runstate)
 219                 return;
 220
 221         dprint(FD_PROCESS, "pid=%d: runstate %s -> %s\n", (int) td->pid,
 222                                                 runstate_to_name(td->runstate),
 223                                                 runstate_to_name(runstate));
 224         td->runstate = runstate;
 225 }
 226
 227 int td_bump_runstate(struct thread_data *td, int new_state)
 228 {
 229         int old_state = td->runstate;
 230
 231         td_set_runstate(td, new_state);
 232         return old_state;
 233 }
 234
 235 void td_restore_runstate(struct thread_data *td, int old_state)
 236 {
 237         td_set_runstate(td, old_state);
 238 }
 239
 240 void fio_mark_td_terminate(struct thread_data *td)
 241 {
 242         fio_gettime(&td->terminate_time, NULL);
 243         write_barrier();
 244         td->terminate = true;
 245 }
 246
 247 void fio_terminate_threads(unsigned int group_id, unsigned int terminate)
 248 {
 249         pid_t pid = getpid();
 250
 251         dprint(FD_PROCESS, "terminate group_id=%d\n", group_id);
 252
 253         for_each_td(td) {
 254                 if ((terminate == TERMINATE_GROUP && group_id == TERMINATE_ALL) ||
 255                     (terminate == TERMINATE_GROUP && group_id == td->groupid) ||
 256                     (terminate == TERMINATE_STONEWALL && td->runstate >= TD_RUNNING) ||
 257                     (terminate == TERMINATE_ALL)) {
 258                         dprint(FD_PROCESS, "setting terminate on %s/%d\n",
 259                                                 td->o.name, (int) td->pid);
 260
 261                         if (td->terminate)
 262                                 continue;
 263
 264                         fio_mark_td_terminate(td);
 265                         td->o.start_delay = 0;
 266
 267                         /*
 268                          * if the thread is running, just let it exit
 269                          */
 270                         if (!td->pid || pid == td->pid)
 271                                 continue;
 272                         else if (td->runstate < TD_RAMP)
 273                                 kill(td->pid, SIGTERM);
 274                         else {
 275                                 struct ioengine_ops *ops = td->io_ops;
 276
 277                                 if (ops && ops->terminate)
 278                                         ops->terminate(td);
 279                         }
 280                 }
 281         } end_for_each();
 282 }
 283
 284 int fio_running_or_pending_io_threads(void)
 285 {
 286         int nr_io_threads = 0;
 287
 288         for_each_td(td) {
 289                 if (td->io_ops_init && td_ioengine_flagged(td, FIO_NOIO))
 290                         continue;
 291                 nr_io_threads++;
 292                 if (td->runstate < TD_EXITED)
 293                         return 1;
 294         } end_for_each();
 295
 296         if (!nr_io_threads)
 297                 return -1; /* we only had cpuio threads to begin with */
 298         return 0;
 299 }
 300
 301 int fio_set_fd_nonblocking(int fd, const char *who)
 302 {
 303         int flags;
 304
 305         flags = fcntl(fd, F_GETFL);
 306         if (flags < 0)
 307                 log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 308         else {
 309                 int new_flags = flags | O_NONBLOCK;
 310
 311                 new_flags = fcntl(fd, F_SETFL, new_flags);
 312                 if (new_flags < 0)
 313                         log_err("fio: %s failed to get file flags: %s\n", who, strerror(errno));
 314         }
 315
 316         return flags;
 317 }
 318
 319 enum {
 320         ENDIAN_INVALID_BE = 1,
 321         ENDIAN_INVALID_LE,
 322         ENDIAN_INVALID_CONFIG,
 323         ENDIAN_BROKEN,
 324 };
 325
 326 static int endian_check(void)
 327 {
 328         union {
 329                 uint8_t c[8];
 330                 uint64_t v;
 331         } u;
 332         int le = 0, be = 0;
 333
 334         u.v = 0x12;
 335         if (u.c[7] == 0x12)
 336                 be = 1;
 337         else if (u.c[0] == 0x12)
 338                 le = 1;
 339
 340 #if defined(CONFIG_LITTLE_ENDIAN)
 341         if (be)
 342                 return ENDIAN_INVALID_BE;
 343 #elif defined(CONFIG_BIG_ENDIAN)
 344         if (le)
 345                 return ENDIAN_INVALID_LE;
 346 #else
 347         return ENDIAN_INVALID_CONFIG;
 348 #endif
 349
 350         if (!le && !be)
 351                 return ENDIAN_BROKEN;
 352
 353         return 0;
 354 }
 355
 356 int initialize_fio(char *envp[])
 357 {
 358         long ps;
 359         int err;
 360
 361         /*
 362          * We need these to be properly 64-bit aligned, otherwise we
 363          * can run into problems on archs that fault on unaligned fp
 364          * access (ARM).
 365          */
 366         compiletime_assert((offsetof(struct thread_data, ts) % sizeof(void *)) == 0, "ts");
 367         compiletime_assert((offsetof(struct thread_stat, percentile_list) % 8) == 0, "stat percentile_list");
 368         compiletime_assert((offsetof(struct thread_stat, total_run_time) % 8) == 0, "total_run_time");
 369         compiletime_assert((offsetof(struct thread_stat, total_err_count) % 8) == 0, "total_err_count");
 370         compiletime_assert((offsetof(struct thread_stat, latency_percentile) % 8) == 0, "stat latency_percentile");
 371         compiletime_assert((offsetof(struct thread_data, ts.clat_stat) % 8) == 0, "ts.clat_stat");
 372         compiletime_assert((offsetof(struct thread_options_pack, zipf_theta) % 8) == 0, "zipf_theta");
 373         compiletime_assert((offsetof(struct thread_options_pack, pareto_h) % 8) == 0, "pareto_h");
 374         compiletime_assert((offsetof(struct thread_options_pack, percentile_list) % 8) == 0, "percentile_list");
 375         compiletime_assert((offsetof(struct thread_options_pack, latency_percentile) % 8) == 0, "latency_percentile");
 376         compiletime_assert((offsetof(struct jobs_eta, m_rate) % 8) == 0, "m_rate");
 377
 378         compiletime_assert(__TD_F_LAST <= TD_ENG_FLAG_SHIFT, "TD_ENG_FLAG_SHIFT");
 379         compiletime_assert(BSSPLIT_MAX <= ZONESPLIT_MAX, "bsssplit/zone max");
 380
 381         err = endian_check();
 382         if (err) {
 383                 log_err("fio: endianness settings appear wrong.\n");
 384                 switch (err) {
 385                 case ENDIAN_INVALID_BE:
 386                         log_err("fio: got big-endian when configured for little\n");
 387                         break;
 388                 case ENDIAN_INVALID_LE:
 389                         log_err("fio: got little-endian when configured for big\n");
 390                         break;
 391                 case ENDIAN_INVALID_CONFIG:
 392                         log_err("fio: not configured to any endianness\n");
 393                         break;
 394                 case ENDIAN_BROKEN:
 395                         log_err("fio: failed to detect endianness\n");
 396                         break;
 397                 default:
 398                         assert(0);
 399                         break;
 400                 }
 401                 log_err("fio: please report this to fio@vger.kernel.org\n");
 402                 return 1;
 403         }
 404
 405 #if !defined(CONFIG_GETTIMEOFDAY) && !defined(CONFIG_CLOCK_GETTIME)
 406 #error "No available clock source!"
 407 #endif
 408
 409         arch_init(envp);
 410
 411         sinit();
 412
 413         if (fio_filelock_init()) {
 414                 log_err("fio: failed initializing filelock subsys\n");
 415                 return 1;
 416         }
 417
 418         file_hash_init();
 419
 420         /*
 421          * We need locale for number printing, if it isn't set then just
 422          * go with the US format.
 423          */
 424         if (!getenv("LC_NUMERIC"))
 425                 setlocale(LC_NUMERIC, "en_US");
 426
 427         ps = sysconf(_SC_PAGESIZE);
 428         if (ps < 0) {
 429                 log_err("Failed to get page size\n");
 430                 return 1;
 431         }
 432
 433         page_size = ps;
 434         page_mask = ps - 1;
 435
 436         fio_keywords_init();
 437         return 0;
 438 }
 439
 440 void deinitialize_fio(void)
 441 {
 442         fio_keywords_exit();
 443 }