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