filesetup.c

   1 #include <unistd.h>
   2 #include <fcntl.h>
   3 #include <string.h>
   4 #include <assert.h>
   5 #include <dirent.h>
   6 #include <sys/stat.h>
   7 #include <sys/mman.h>
   8 #include <sys/types.h>
   9
  10 #include "fio.h"
  11
  12 static int root_warn;
  13
  14 static int extend_file(struct thread_data *td, struct fio_file *f)
  15 {
  16         int r, new_layout = 0, unlink_file = 0, flags;
  17         unsigned long long left;
  18         unsigned int bs;
  19         char *b;
  20
  21         /*
  22          * check if we need to lay the file out complete again. fio
  23          * does that for operations involving reads, or for writes
  24          * where overwrite is set
  25          */
  26         if (td_read(td) || (td_write(td) && td->o.overwrite))
  27                 new_layout = 1;
  28         if (td_write(td) && !td->o.overwrite)
  29                 unlink_file = 1;
  30
  31         if ((unlink_file || new_layout) && (f->flags & FIO_FILE_EXISTS)) {
  32                 if (unlink(f->file_name) < 0) {
  33                         td_verror(td, errno, "unlink");
  34                         return 1;
  35                 }
  36         }
  37
  38         flags = O_WRONLY | O_CREAT;
  39         if (new_layout)
  40                 flags |= O_TRUNC;
  41
  42         f->fd = open(f->file_name, flags, 0644);
  43         if (f->fd < 0) {
  44                 td_verror(td, errno, "open");
  45                 return 1;
  46         }
  47
  48         if (ftruncate(f->fd, f->real_file_size) == -1) {
  49                 td_verror(td, errno, "ftruncate");
  50                 goto err;
  51         }
  52
  53         if (!new_layout)
  54                 goto done;
  55
  56         if (posix_fallocate(f->fd, 0, f->real_file_size) < 0) {
  57                 td_verror(td, errno, "posix_fallocate");
  58                 goto err;
  59         }
  60
  61         b = malloc(td->o.max_bs[DDIR_WRITE]);
  62         memset(b, 0, td->o.max_bs[DDIR_WRITE]);
  63
  64         left = f->real_file_size;
  65         while (left && !td->terminate) {
  66                 bs = td->o.max_bs[DDIR_WRITE];
  67                 if (bs > left)
  68                         bs = left;
  69
  70                 r = write(f->fd, b, bs);
  71
  72                 if (r == (int) bs) {
  73                         left -= bs;
  74                         continue;
  75                 } else {
  76                         if (r < 0)
  77                                 td_verror(td, errno, "write");
  78                         else
  79                                 td_verror(td, EIO, "write");
  80
  81                         break;
  82                 }
  83         }
  84
  85         if (td->terminate)
  86                 unlink(f->file_name);
  87         else if (td->o.create_fsync)
  88                 fsync(f->fd);
  89
  90         free(b);
  91 done:
  92         close(f->fd);
  93         f->fd = -1;
  94         return 0;
  95 err:
  96         close(f->fd);
  97         f->fd = -1;
  98         return 1;
  99 }
 100
 101 static unsigned long long get_rand_file_size(struct thread_data *td)
 102 {
 103         unsigned long long ret;
 104         long r;
 105
 106         r = os_random_long(&td->file_size_state);
 107         ret = td->o.file_size_low + (unsigned long long) ((double) (td->o.file_size_high - td->o.file_size_low) * (r / (RAND_MAX + 1.0)));
 108         ret -= (ret % td->o.rw_min_bs);
 109         return ret;
 110 }
 111
 112 static int file_size(struct thread_data *td, struct fio_file *f)
 113 {
 114         struct stat st;
 115
 116         if (fstat(f->fd, &st) == -1) {
 117                 td_verror(td, errno, "fstat");
 118                 return 1;
 119         }
 120
 121         f->real_file_size = st.st_size;
 122         return 0;
 123 }
 124
 125 static int bdev_size(struct thread_data *td, struct fio_file *f)
 126 {
 127         unsigned long long bytes;
 128         int r;
 129
 130         r = blockdev_size(f->fd, &bytes);
 131         if (r) {
 132                 td_verror(td, r, "blockdev_size");
 133                 return 1;
 134         }
 135
 136         f->real_file_size = bytes;
 137         return 0;
 138 }
 139
 140 static int get_file_size(struct thread_data *td, struct fio_file *f)
 141 {
 142         int ret = 0;
 143
 144         if (f->flags & FIO_SIZE_KNOWN)
 145                 return 0;
 146
 147         if (f->filetype == FIO_TYPE_FILE)
 148                 ret = file_size(td, f);
 149         else if (f->filetype == FIO_TYPE_BD)
 150                 ret = bdev_size(td, f);
 151         else
 152                 f->real_file_size = -1;
 153
 154         if (ret)
 155                 return ret;
 156
 157         if (f->file_offset > f->real_file_size) {
 158                 log_err("%s: offset extends end (%Lu > %Lu)\n", td->o.name, f->file_offset, f->real_file_size);
 159                 return 1;
 160         }
 161
 162         f->flags |= FIO_SIZE_KNOWN;
 163         return 0;
 164 }
 165
 166 int file_invalidate_cache(struct thread_data *td, struct fio_file *f)
 167 {
 168         int ret = 0;
 169
 170         if (td->o.odirect)
 171                 return 0;
 172
 173         /*
 174          * FIXME: add blockdev flushing too
 175          */
 176         if (f->mmap)
 177                 ret = madvise(f->mmap, f->io_size, MADV_DONTNEED);
 178         else if (f->filetype == FIO_TYPE_FILE)
 179                 ret = fadvise(f->fd, f->file_offset, f->io_size, POSIX_FADV_DONTNEED);
 180         else if (f->filetype == FIO_TYPE_BD) {
 181                 ret = blockdev_invalidate_cache(f->fd);
 182                 if (ret < 0 && errno == EACCES && geteuid()) {
 183                         if (!root_warn) {
 184                                 log_err("fio: only root may flush block devices. Cache flush bypassed!\n");
 185                                 root_warn = 1;
 186                         }
 187                         ret = 0;
 188                 }
 189         } else if (f->filetype == FIO_TYPE_CHAR || f->filetype == FIO_TYPE_PIPE)
 190                 ret = 0;
 191
 192         if (ret < 0) {
 193                 td_verror(td, errno, "invalidate_cache");
 194                 return 1;
 195         }
 196
 197         return ret;
 198 }
 199
 200 void generic_close_file(struct thread_data fio_unused *td, struct fio_file *f)
 201 {
 202         close(f->fd);
 203         f->fd = -1;
 204 }
 205
 206 int generic_open_file(struct thread_data *td, struct fio_file *f)
 207 {
 208         int is_std = 0;
 209         int flags = 0;
 210
 211         if (!strcmp(f->file_name, "-")) {
 212                 if (td_rw(td)) {
 213                         log_err("fio: can't read/write to stdin/out\n");
 214                         return 1;
 215                 }
 216                 is_std = 1;
 217
 218                 /*
 219                  * move output logging to stderr, if we are writing to stdout
 220                  */
 221                 if (td_write(td))
 222                         f_out = stderr;
 223         }
 224
 225         if (td->o.odirect)
 226                 flags |= OS_O_DIRECT;
 227         if (td->o.sync_io)
 228                 flags |= O_SYNC;
 229
 230         if (td_write(td)) {
 231                 flags |= O_RDWR;
 232
 233                 if (f->filetype == FIO_TYPE_FILE)
 234                         flags |= O_CREAT;
 235
 236                 if (is_std)
 237                         f->fd = dup(STDOUT_FILENO);
 238                 else
 239                         f->fd = open(f->file_name, flags, 0600);
 240         } else {
 241                 if (f->filetype == FIO_TYPE_CHAR)
 242                         flags |= O_RDWR;
 243                 else
 244                         flags |= O_RDONLY;
 245
 246                 if (is_std)
 247                         f->fd = dup(STDIN_FILENO);
 248                 else
 249                         f->fd = open(f->file_name, flags);
 250         }
 251
 252         if (f->fd == -1) {
 253                 char buf[FIO_VERROR_SIZE];
 254                 int __e = errno;
 255
 256                 snprintf(buf, sizeof(buf) - 1, "open(%s)", f->file_name);
 257
 258                 td_verror(td, __e, buf);
 259         }
 260
 261         if (get_file_size(td, f))
 262                 goto err;
 263
 264         return 0;
 265 err:
 266         close(f->fd);
 267         return 1;
 268 }
 269
 270 int open_files(struct thread_data *td)
 271 {
 272         struct fio_file *f;
 273         unsigned int i;
 274         int err = 0;
 275
 276         for_each_file(td, f, i) {
 277                 err = td_io_open_file(td, f);
 278                 if (err) {
 279                         if (td->error == EMFILE) {
 280                                 log_err("fio: limited open files to: %d\n", td->nr_open_files);
 281                                 td->o.open_files = td->nr_open_files;
 282                                 err = 0;
 283                                 clear_error(td);
 284                         }
 285                         break;
 286                 }
 287
 288                 if (td->o.open_files == td->nr_open_files)
 289                         break;
 290         }
 291
 292         if (!err)
 293                 return 0;
 294
 295         for_each_file(td, f, i)
 296                 td_io_close_file(td, f);
 297
 298         return err;
 299 }
 300
 301 /*
 302  * open/close all files, so that ->real_file_size gets set
 303  */
 304 static int get_file_sizes(struct thread_data *td)
 305 {
 306         struct fio_file *f;
 307         unsigned int i;
 308         int err = 0;
 309
 310         for_each_file(td, f, i) {
 311                 if (td->io_ops->open_file(td, f)) {
 312                         if (td->error != ENOENT) {
 313                                 log_err("%s\n", td->verror);
 314                                 err = 1;
 315                         }
 316                         clear_error(td);
 317                 } else {
 318                         if (td->io_ops->close_file)
 319                                 td->io_ops->close_file(td, f);
 320                 }
 321
 322                 if (f->real_file_size == -1ULL && td->o.size)
 323                         f->real_file_size = td->o.size / td->o.nr_files;
 324         }
 325
 326         return err;
 327 }
 328
 329 /*
 330  * Open the files and setup files sizes, creating files if necessary.
 331  */
 332 int setup_files(struct thread_data *td)
 333 {
 334         unsigned long long total_size, extend_size;
 335         struct fio_file *f;
 336         unsigned int i;
 337         int err = 0, need_extend;
 338
 339         /*
 340          * if ioengine defines a setup() method, it's responsible for
 341          * opening the files and setting f->real_file_size to indicate
 342          * the valid range for that file.
 343          */
 344         if (td->io_ops->setup)
 345                 err = td->io_ops->setup(td);
 346         else
 347                 err = get_file_sizes(td);
 348
 349         if (err)
 350                 return err;
 351
 352         /*
 353          * check sizes. if the files/devices do not exist and the size
 354          * isn't passed to fio, abort.
 355          */
 356         total_size = 0;
 357         for_each_file(td, f, i) {
 358                 if (f->real_file_size == -1ULL)
 359                         total_size = -1ULL;
 360                 else
 361                         total_size += f->real_file_size;
 362         }
 363
 364         /*
 365          * device/file sizes are zero and no size given, punt
 366          */
 367         if ((!total_size || total_size == -1ULL) && !td->o.size) {
 368                 log_err("%s: you need to specify size=\n", td->o.name);
 369                 td_verror(td, EINVAL, "total_file_size");
 370                 return 1;
 371         }
 372
 373         /*
 374          * now file sizes are known, so we can set ->io_size. if size= is
 375          * not given, ->io_size is just equal to ->real_file_size. if size
 376          * is given, ->io_size is size / nr_files.
 377          */
 378         extend_size = total_size = 0;
 379         need_extend = 0;
 380         for_each_file(td, f, i) {
 381                 f->file_offset = td->o.start_offset;
 382
 383                 if (!td->o.file_size_low) {
 384                         /*
 385                          * no file size range given, file size is equal to
 386                          * total size divided by number of files. if that is
 387                          * zero, set it to the real file size.
 388                          */
 389                         f->io_size = td->o.size / td->o.nr_files;
 390                         if (!f->io_size) {
 391                                 if (f->file_offset > f->real_file_size)
 392                                         goto err_offset;
 393                                 f->io_size = f->real_file_size - f->file_offset;
 394                         }
 395                 } else if (f->real_file_size < td->o.file_size_low ||
 396                            f->real_file_size > td->o.file_size_high) {
 397                         if (f->file_offset > td->o.file_size_low)
 398                                 goto err_offset;
 399                         /*
 400                          * file size given. if it's fixed, use that. if it's a
 401                          * range, generate a random size in-between.
 402                          */
 403                         if (td->o.file_size_low == td->o.file_size_high)
 404                                 f->io_size = td->o.file_size_low - f->file_offset;
 405                         else
 406                                 f->io_size = get_rand_file_size(td) - f->file_offset;
 407                 } else if (f->file_offset > f->real_file_size)
 408                         goto err_offset;
 409                 else
 410                         f->io_size = f->real_file_size - f->file_offset;
 411
 412                 if (f->io_size == -1ULL)
 413                         total_size = -1ULL;
 414                 else
 415                         total_size += f->io_size;
 416
 417                 if (f->filetype == FIO_TYPE_FILE &&
 418                     (f->io_size + f->file_offset) > f->real_file_size &&
 419                     !(td->io_ops->flags & FIO_DISKLESSIO)) {
 420                         need_extend++;
 421                         extend_size += (f->io_size + f->file_offset);
 422                         f->flags |= FIO_FILE_EXTEND;
 423                 }
 424         }
 425
 426         if (!td->o.size || td->o.size > total_size)
 427                 td->o.size = total_size;
 428
 429         /*
 430          * See if we need to extend some files
 431          */
 432         if (need_extend) {
 433                 temp_stall_ts = 1;
 434                 log_info("%s: Laying out IO file(s) (%u files / %LuMiB)\n",
 435                         td->o.name, need_extend, extend_size >> 20);
 436
 437                 for_each_file(td, f, i) {
 438                         if (!(f->flags & FIO_FILE_EXTEND))
 439                                 continue;
 440
 441                         assert(f->filetype == FIO_TYPE_FILE);
 442                         f->flags &= ~FIO_FILE_EXTEND;
 443                         f->real_file_size = (f->io_size + f->file_offset);
 444                         err = extend_file(td, f);
 445                         if (err)
 446                                 break;
 447                 }
 448                 temp_stall_ts = 0;
 449         }
 450
 451         if (err)
 452                 return err;
 453
 454         if (!td->o.zone_size)
 455                 td->o.zone_size = td->o.size;
 456
 457         td->total_io_size = td->o.size * td->o.loops;
 458         return 0;
 459 err_offset:
 460         log_err("%s: you need to specify valid offset=\n", td->o.name);
 461         return 1;
 462 }
 463
 464 int init_random_map(struct thread_data *td)
 465 {
 466         int num_maps, blocks;
 467         struct fio_file *f;
 468         unsigned int i;
 469
 470         if (td->o.norandommap)
 471                 return 0;
 472
 473         for_each_file(td, f, i) {
 474                 blocks = (f->real_file_size + td->o.rw_min_bs - 1) / td->o.rw_min_bs;
 475                 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
 476                 f->file_map = malloc(num_maps * sizeof(long));
 477                 if (!f->file_map) {
 478                         log_err("fio: failed allocating random map. If running a large number of jobs, try the 'norandommap' option\n");
 479                         return 1;
 480                 }
 481                 f->num_maps = num_maps;
 482                 memset(f->file_map, 0, num_maps * sizeof(long));
 483         }
 484
 485         return 0;
 486 }
 487
 488 void close_files(struct thread_data *td)
 489 {
 490         struct fio_file *f;
 491         unsigned int i;
 492
 493         for_each_file(td, f, i) {
 494                 if (td->o.unlink && f->filetype == FIO_TYPE_FILE)
 495                         unlink(f->file_name);
 496
 497                 td_io_close_file(td, f);
 498
 499                 free(f->file_name);
 500                 f->file_name = NULL;
 501
 502                 if (f->file_map) {
 503                         free(f->file_map);
 504                         f->file_map = NULL;
 505                 }
 506         }
 507
 508         td->o.filename = NULL;
 509         free(td->files);
 510         td->files = NULL;
 511         td->o.nr_files = 0;
 512 }
 513
 514 static void get_file_type(struct fio_file *f)
 515 {
 516         struct stat sb;
 517
 518         if (!strcmp(f->file_name, "-"))
 519                 f->filetype = FIO_TYPE_PIPE;
 520         else
 521                 f->filetype = FIO_TYPE_FILE;
 522
 523         if (!lstat(f->file_name, &sb)) {
 524                 if (S_ISBLK(sb.st_mode))
 525                         f->filetype = FIO_TYPE_BD;
 526                 else if (S_ISCHR(sb.st_mode))
 527                         f->filetype = FIO_TYPE_CHAR;
 528                 else if (S_ISFIFO(sb.st_mode))
 529                         f->filetype = FIO_TYPE_PIPE;
 530         }
 531 }
 532
 533 int add_file(struct thread_data *td, const char *fname)
 534 {
 535         int cur_files = td->files_index;
 536         char file_name[PATH_MAX];
 537         struct fio_file *f;
 538         int len = 0;
 539
 540         td->files = realloc(td->files, (cur_files + 1) * sizeof(*f));
 541
 542         f = &td->files[cur_files];
 543         memset(f, 0, sizeof(*f));
 544         f->fd = -1;
 545
 546         /*
 547          * init function, io engine may not be loaded yet
 548          */
 549         if (td->io_ops && (td->io_ops->flags & FIO_DISKLESSIO))
 550                 f->real_file_size = -1ULL;
 551
 552         if (td->o.directory)
 553                 len = sprintf(file_name, "%s/", td->o.directory);
 554
 555         sprintf(file_name + len, "%s", fname);
 556         f->file_name = strdup(file_name);
 557
 558         get_file_type(f);
 559
 560         td->files_index++;
 561         if (f->filetype == FIO_TYPE_FILE)
 562                 td->nr_normal_files++;
 563
 564         return cur_files;
 565 }
 566
 567 void get_file(struct fio_file *f)
 568 {
 569         assert(f->flags & FIO_FILE_OPEN);
 570         f->references++;
 571 }
 572
 573 void put_file(struct thread_data *td, struct fio_file *f)
 574 {
 575         if (!(f->flags & FIO_FILE_OPEN))
 576                 return;
 577
 578         assert(f->references);
 579         if (--f->references)
 580                 return;
 581
 582         if (should_fsync(td) && td->o.fsync_on_close)
 583                 fsync(f->fd);
 584
 585         if (td->io_ops->close_file)
 586                 td->io_ops->close_file(td, f);
 587
 588         td->nr_open_files--;
 589         f->flags &= ~FIO_FILE_OPEN;
 590 }
 591
 592 static int recurse_dir(struct thread_data *td, const char *dirname)
 593 {
 594         struct dirent *dir;
 595         int ret = 0;
 596         DIR *D;
 597
 598         D = opendir(dirname);
 599         if (!D) {
 600                 char buf[FIO_VERROR_SIZE];
 601
 602                 snprintf(buf, FIO_VERROR_SIZE - 1, "opendir(%s)", dirname);
 603                 td_verror(td, errno, buf);
 604                 return 1;
 605         }
 606
 607         while ((dir = readdir(D)) != NULL) {
 608                 char full_path[PATH_MAX];
 609                 struct stat sb;
 610
 611                 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
 612                         continue;
 613
 614                 sprintf(full_path, "%s/%s", dirname, dir->d_name);
 615
 616                 if (lstat(full_path, &sb) == -1) {
 617                         if (errno != ENOENT) {
 618                                 td_verror(td, errno, "stat");
 619                                 return 1;
 620                         }
 621                 }
 622
 623                 if (S_ISREG(sb.st_mode)) {
 624                         add_file(td, full_path);
 625                         td->o.nr_files++;
 626                         continue;
 627                 }
 628                 if (!S_ISDIR(sb.st_mode))
 629                         continue;
 630
 631                 if ((ret = recurse_dir(td, full_path)) != 0)
 632                         break;
 633         }
 634
 635         closedir(D);
 636         return ret;
 637 }
 638
 639 int add_dir_files(struct thread_data *td, const char *path)
 640 {
 641         int ret = recurse_dir(td, path);
 642
 643         if (!ret)
 644                 log_info("fio: opendir added %d files\n", td->o.nr_files);
 645
 646         return ret;
 647 }
 648
 649 void dup_files(struct thread_data *td, struct thread_data *org)
 650 {
 651         struct fio_file *f;
 652         unsigned int i;
 653         size_t bytes;
 654
 655         if (!org->files)
 656                 return;
 657
 658         bytes = org->files_index * sizeof(*f);
 659         td->files = malloc(bytes);
 660         memcpy(td->files, org->files, bytes);
 661
 662         for_each_file(td, f, i) {
 663                 if (f->file_name)
 664                         f->file_name = strdup(f->file_name);
 665         }
 666 }
 667
 668 /*
 669  * Returns the index that matches the filename, or -1 if not there
 670  */
 671 int get_fileno(struct thread_data *td, const char *fname)
 672 {
 673         struct fio_file *f;
 674         unsigned int i;
 675
 676         for_each_file(td, f, i)
 677                 if (!strcmp(f->file_name, fname))
 678                         return i;
 679
 680         return -1;
 681 }
 682
 683 /*
 684  * For log usage, where we add/open/close files automatically
 685  */
 686 void free_release_files(struct thread_data *td)
 687 {
 688         close_files(td);
 689         td->files_index = 0;
 690         td->nr_normal_files = 0;
 691 }