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 || f->filetype == FIO_TYPE_PIPE)
 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 is_std = 0;
 204         int flags = 0;
 205
 206         if (!strcmp(f->file_name, "-")) {
 207                 if (td_rw(td)) {
 208                         log_err("fio: can't read/write to stdin/out\n");
 209                         return 1;
 210                 }
 211                 is_std = 1;
 212
 213                 /*
 214                  * move output logging to stderr, if we are writing to stdout
 215                  */
 216                 if (td_write(td))
 217                         f_out = stderr;
 218         }
 219
 220         if (td->o.odirect)
 221                 flags |= OS_O_DIRECT;
 222         if (td->o.sync_io)
 223                 flags |= O_SYNC;
 224
 225         if (td_write(td)) {
 226                 flags |= O_RDWR;
 227
 228                 if (f->filetype == FIO_TYPE_FILE)
 229                         flags |= O_CREAT;
 230
 231                 if (is_std)
 232                         f->fd = dup(STDOUT_FILENO);
 233                 else
 234                         f->fd = open(f->file_name, flags, 0600);
 235         } else {
 236                 if (f->filetype == FIO_TYPE_CHAR)
 237                         flags |= O_RDWR;
 238                 else
 239                         flags |= O_RDONLY;
 240
 241                 if (is_std)
 242                         f->fd = dup(STDIN_FILENO);
 243                 else
 244                         f->fd = open(f->file_name, flags);
 245         }
 246
 247         if (f->fd == -1) {
 248                 char buf[FIO_VERROR_SIZE];
 249                 int __e = errno;
 250
 251                 snprintf(buf, sizeof(buf) - 1, "open(%s)", f->file_name);
 252
 253                 td_verror(td, __e, buf);
 254         }
 255
 256         if (get_file_size(td, f))
 257                 goto err;
 258
 259         return 0;
 260 err:
 261         close(f->fd);
 262         return 1;
 263 }
 264
 265 int open_files(struct thread_data *td)
 266 {
 267         struct fio_file *f;
 268         unsigned int i;
 269         int err = 0;
 270
 271         for_each_file(td, f, i) {
 272                 err = td_io_open_file(td, f);
 273                 if (err) {
 274                         if (td->error == EMFILE) {
 275                                 log_err("fio: limited open files to: %d\n", td->nr_open_files);
 276                                 td->o.open_files = td->nr_open_files;
 277                                 err = 0;
 278                                 clear_error(td);
 279                         }
 280                         break;
 281                 }
 282
 283                 if (td->o.open_files == td->nr_open_files)
 284                         break;
 285         }
 286
 287         if (!err)
 288                 return 0;
 289
 290         for_each_file(td, f, i)
 291                 td_io_close_file(td, f);
 292
 293         return err;
 294 }
 295
 296 /*
 297  * open/close all files, so that ->real_file_size gets set
 298  */
 299 static int get_file_sizes(struct thread_data *td)
 300 {
 301         struct fio_file *f;
 302         unsigned int i;
 303         int err = 0;
 304
 305         for_each_file(td, f, i) {
 306                 if (td->io_ops->open_file(td, f)) {
 307                         if (td->error != ENOENT) {
 308                                 log_err("%s\n", td->verror);
 309                                 err = 1;
 310                         }
 311                         clear_error(td);
 312                 } else {
 313                         if (td->io_ops->close_file)
 314                                 td->io_ops->close_file(td, f);
 315                 }
 316
 317                 if (f->real_file_size == -1ULL && td->o.size)
 318                         f->real_file_size = td->o.size / td->o.nr_files;
 319         }
 320
 321         return err;
 322 }
 323
 324 /*
 325  * Open the files and setup files sizes, creating files if necessary.
 326  */
 327 int setup_files(struct thread_data *td)
 328 {
 329         unsigned long long total_size, extend_size;
 330         struct fio_file *f;
 331         unsigned int i;
 332         int err = 0, need_extend;
 333
 334         /*
 335          * if ioengine defines a setup() method, it's responsible for
 336          * opening the files and setting f->real_file_size to indicate
 337          * the valid range for that file.
 338          */
 339         if (td->io_ops->setup)
 340                 err = td->io_ops->setup(td);
 341         else
 342                 err = get_file_sizes(td);
 343
 344         if (err)
 345                 return err;
 346
 347         /*
 348          * check sizes. if the files/devices do not exist and the size
 349          * isn't passed to fio, abort.
 350          */
 351         total_size = 0;
 352         for_each_file(td, f, i) {
 353                 if (f->real_file_size == -1ULL)
 354                         total_size = -1ULL;
 355                 else
 356                         total_size += f->real_file_size;
 357         }
 358
 359         /*
 360          * device/file sizes are zero and no size given, punt
 361          */
 362         if ((!total_size || total_size == -1ULL) && !td->o.size) {
 363                 log_err("%s: you need to specify size=\n", td->o.name);
 364                 td_verror(td, EINVAL, "total_file_size");
 365                 return 1;
 366         }
 367
 368         /*
 369          * now file sizes are known, so we can set ->io_size. if size= is
 370          * not given, ->io_size is just equal to ->real_file_size. if size
 371          * is given, ->io_size is size / nr_files.
 372          */
 373         extend_size = total_size = 0;
 374         need_extend = 0;
 375         for_each_file(td, f, i) {
 376                 if (!td->o.file_size_low) {
 377                         /*
 378                          * no file size range given, file size is equal to
 379                          * total size divided by number of files. if that is
 380                          * zero, set it to the real file size.
 381                          */
 382                         f->io_size = td->o.size / td->o.nr_files;
 383                         if (!f->io_size)
 384                                 f->io_size = f->real_file_size;
 385                 } else if (f->real_file_size < td->o.file_size_low ||
 386                            f->real_file_size > td->o.file_size_high) {
 387                         /*
 388                          * file size given. if it's fixed, use that. if it's a
 389                          * range, generate a random size in-between.
 390                          */
 391                         if (td->o.file_size_low == td->o.file_size_high)
 392                                 f->io_size = td->o.file_size_low;
 393                         else
 394                                 f->io_size = get_rand_file_size(td);
 395                 } else
 396                         f->io_size = f->real_file_size;
 397
 398                 if (f->io_size == -1ULL)
 399                         total_size = -1ULL;
 400                 else
 401                         total_size += f->io_size;
 402
 403                 if (f->filetype == FIO_TYPE_FILE &&
 404                     f->io_size > f->real_file_size &&
 405                     !(td->io_ops->flags & FIO_DISKLESSIO)) {
 406                         need_extend++;
 407                         extend_size += f->io_size;
 408                         f->flags |= FIO_FILE_EXTEND;
 409                 }
 410         }
 411
 412         if (!td->o.size)
 413                 td->o.size = total_size;
 414
 415         /*
 416          * See if we need to extend some files
 417          */
 418         if (need_extend) {
 419                 temp_stall_ts = 1;
 420                 log_info("%s: Laying out IO file(s) (%u files / %LuMiB)\n",
 421                         td->o.name, need_extend, extend_size >> 20);
 422
 423                 for_each_file(td, f, i) {
 424                         if (!(f->flags & FIO_FILE_EXTEND))
 425                                 continue;
 426
 427                         assert(f->filetype == FIO_TYPE_FILE);
 428                         f->flags &= ~FIO_FILE_EXTEND;
 429                         f->real_file_size = f->io_size;
 430                         err = extend_file(td, f);
 431                         if (err)
 432                                 break;
 433                 }
 434                 temp_stall_ts = 0;
 435         }
 436
 437         if (err)
 438                 return err;
 439
 440         if (!td->o.zone_size)
 441                 td->o.zone_size = td->o.size;
 442
 443         td->total_io_size = td->o.size * td->o.loops;
 444         return 0;
 445 }
 446
 447 int init_random_map(struct thread_data *td)
 448 {
 449         int num_maps, blocks;
 450         struct fio_file *f;
 451         unsigned int i;
 452
 453         if (td->o.norandommap)
 454                 return 0;
 455
 456         for_each_file(td, f, i) {
 457                 blocks = (f->real_file_size + td->o.rw_min_bs - 1) / td->o.rw_min_bs;
 458                 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
 459                 f->file_map = malloc(num_maps * sizeof(long));
 460                 if (!f->file_map) {
 461                         log_err("fio: failed allocating random map. If running a large number of jobs, try the 'norandommap' option\n");
 462                         return 1;
 463                 }
 464                 f->num_maps = num_maps;
 465                 memset(f->file_map, 0, num_maps * sizeof(long));
 466         }
 467
 468         return 0;
 469 }
 470
 471 void close_files(struct thread_data *td)
 472 {
 473         struct fio_file *f;
 474         unsigned int i;
 475
 476         for_each_file(td, f, i) {
 477                 if ((f->flags & FIO_FILE_UNLINK) &&
 478                     f->filetype == FIO_TYPE_FILE)
 479                         unlink(f->file_name);
 480
 481                 td_io_close_file(td, f);
 482
 483                 free(f->file_name);
 484                 f->file_name = NULL;
 485
 486                 if (f->file_map) {
 487                         free(f->file_map);
 488                         f->file_map = NULL;
 489                 }
 490         }
 491
 492         td->o.filename = NULL;
 493         free(td->files);
 494         td->files = NULL;
 495         td->o.nr_files = 0;
 496 }
 497
 498 static void get_file_type(struct fio_file *f)
 499 {
 500         struct stat sb;
 501
 502         if (!strcmp(f->file_name, "-"))
 503                 f->filetype = FIO_TYPE_PIPE;
 504         else
 505                 f->filetype = FIO_TYPE_FILE;
 506
 507         if (!lstat(f->file_name, &sb)) {
 508                 if (S_ISBLK(sb.st_mode))
 509                         f->filetype = FIO_TYPE_BD;
 510                 else if (S_ISCHR(sb.st_mode))
 511                         f->filetype = FIO_TYPE_CHAR;
 512                 else if (S_ISFIFO(sb.st_mode))
 513                         f->filetype = FIO_TYPE_PIPE;
 514         }
 515 }
 516
 517 void add_file(struct thread_data *td, const char *fname)
 518 {
 519         int cur_files = td->files_index;
 520         char file_name[PATH_MAX];
 521         struct fio_file *f;
 522         int len = 0;
 523
 524         td->files = realloc(td->files, (cur_files + 1) * sizeof(*f));
 525
 526         f = &td->files[cur_files];
 527         memset(f, 0, sizeof(*f));
 528         f->fd = -1;
 529
 530         /*
 531          * init function, io engine may not be loaded yet
 532          */
 533         if (td->io_ops && (td->io_ops->flags & FIO_DISKLESSIO))
 534                 f->real_file_size = -1ULL;
 535
 536         if (td->o.directory)
 537                 len = sprintf(file_name, "%s/", td->o.directory);
 538
 539         sprintf(file_name + len, "%s", fname);
 540         f->file_name = strdup(file_name);
 541
 542         get_file_type(f);
 543
 544         td->files_index++;
 545         if (f->filetype == FIO_TYPE_FILE)
 546                 td->nr_normal_files++;
 547 }
 548
 549 void get_file(struct fio_file *f)
 550 {
 551         f->references++;
 552 }
 553
 554 void put_file(struct thread_data *td, struct fio_file *f)
 555 {
 556         if (!(f->flags & FIO_FILE_OPEN))
 557                 return;
 558
 559         assert(f->references);
 560         if (--f->references)
 561                 return;
 562
 563         if (should_fsync(td) && td->o.fsync_on_close)
 564                 fsync(f->fd);
 565
 566         if (td->io_ops->close_file)
 567                 td->io_ops->close_file(td, f);
 568
 569         td->nr_open_files--;
 570         f->flags &= ~FIO_FILE_OPEN;
 571 }
 572
 573 static int recurse_dir(struct thread_data *td, const char *dirname)
 574 {
 575         struct dirent *dir;
 576         int ret = 0;
 577         DIR *D;
 578
 579         D = opendir(dirname);
 580         if (!D) {
 581                 char buf[FIO_VERROR_SIZE];
 582
 583                 snprintf(buf, FIO_VERROR_SIZE - 1, "opendir(%s)", dirname);
 584                 td_verror(td, errno, buf);
 585                 return 1;
 586         }
 587
 588         while ((dir = readdir(D)) != NULL) {
 589                 char full_path[PATH_MAX];
 590                 struct stat sb;
 591
 592                 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
 593                         continue;
 594
 595                 sprintf(full_path, "%s/%s", dirname, dir->d_name);
 596
 597                 if (lstat(full_path, &sb) == -1) {
 598                         if (errno != ENOENT) {
 599                                 td_verror(td, errno, "stat");
 600                                 return 1;
 601                         }
 602                 }
 603
 604                 if (S_ISREG(sb.st_mode)) {
 605                         add_file(td, full_path);
 606                         td->o.nr_files++;
 607                         continue;
 608                 }
 609                 if (!S_ISDIR(sb.st_mode))
 610                         continue;
 611
 612                 if ((ret = recurse_dir(td, full_path)) != 0)
 613                         break;
 614         }
 615
 616         closedir(D);
 617         return ret;
 618 }
 619
 620 int add_dir_files(struct thread_data *td, const char *path)
 621 {
 622         int ret = recurse_dir(td, path);
 623
 624         if (!ret)
 625                 log_info("fio: opendir added %d files\n", td->o.nr_files);
 626
 627         return ret;
 628 }
 629
 630 void dup_files(struct thread_data *td, struct thread_data *org)
 631 {
 632         struct fio_file *f;
 633         unsigned int i;
 634         size_t bytes;
 635
 636         if (!org->files)
 637                 return;
 638
 639         bytes = org->files_index * sizeof(*f);
 640         td->files = malloc(bytes);
 641         memcpy(td->files, org->files, bytes);
 642
 643         for_each_file(td, f, i) {
 644                 if (f->file_name)
 645                         f->file_name = strdup(f->file_name);
 646         }
 647 }