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