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