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