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