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