env_posix.cc 47.8 KB
Newer Older
1 2 3 4 5
//  Copyright (c) 2013, Facebook, Inc.  All rights reserved.
//  This source code is licensed under the BSD-style license found in the
//  LICENSE file in the root directory of this source tree. An additional grant
//  of patent rights can be found in the PATENTS file in the same directory.
//
J
jorlow@chromium.org 已提交
6 7 8 9 10
// Copyright (c) 2011 The LevelDB Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file. See the AUTHORS file for names of contributors.

#include <deque>
11
#include <set>
J
jorlow@chromium.org 已提交
12 13 14 15 16 17 18
#include <dirent.h>
#include <errno.h>
#include <fcntl.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
19
#include <sys/ioctl.h>
J
jorlow@chromium.org 已提交
20 21
#include <sys/mman.h>
#include <sys/stat.h>
K
kailiu 已提交
22
#ifdef OS_LINUX
A
Abhishek Kona 已提交
23
#include <sys/statfs.h>
K
kailiu 已提交
24
#endif
J
jorlow@chromium.org 已提交
25 26 27 28
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
29 30
#if defined(OS_LINUX)
#include <linux/fs.h>
31
#include <fcntl.h>
32
#endif
J
jorlow@chromium.org 已提交
33 34 35
#if defined(LEVELDB_PLATFORM_ANDROID)
#include <sys/stat.h>
#endif
L
Lei Jin 已提交
36 37
#include <signal.h>
#include <algorithm>
38 39
#include "rocksdb/env.h"
#include "rocksdb/slice.h"
J
jorlow@chromium.org 已提交
40
#include "port/port.h"
41
#include "util/coding.h"
J
jorlow@chromium.org 已提交
42
#include "util/logging.h"
43
#include "util/posix_logger.h"
44
#include "util/random.h"
45
#include "util/iostats_context_imp.h"
L
Lei Jin 已提交
46
#include "util/rate_limiter.h"
J
jorlow@chromium.org 已提交
47

K
kailiu 已提交
48 49 50 51 52 53
// Get nano time for mach systems
#ifdef __MACH__
#include <mach/clock.h>
#include <mach/mach.h>
#endif

A
Abhishek Kona 已提交
54 55 56 57 58 59 60 61 62 63
#if !defined(TMPFS_MAGIC)
#define TMPFS_MAGIC 0x01021994
#endif
#if !defined(XFS_SUPER_MAGIC)
#define XFS_SUPER_MAGIC 0x58465342
#endif
#if !defined(EXT4_SUPER_MAGIC)
#define EXT4_SUPER_MAGIC 0xEF53
#endif

K
kailiu 已提交
64 65 66 67 68 69 70 71 72 73
// For non linux platform, the following macros are used only as place
// holder.
#ifndef OS_LINUX
#define POSIX_FADV_NORMAL 0 /* [MC1] no further special treatment */
#define POSIX_FADV_RANDOM 1 /* [MC1] expect random page refs */
#define POSIX_FADV_SEQUENTIAL 2 /* [MC1] expect sequential page refs */
#define POSIX_FADV_WILLNEED 3 /* [MC1] will need these pages */
#define POSIX_FADV_DONTNEED 4 /* [MC1] dont need these pages */
#endif

74 75
// This is only set from db_stress.cc and for testing only.
// If non-zero, kill at various points in source code with probability 1/this
76
int rocksdb_kill_odds = 0;
77

78
namespace rocksdb {
J
jorlow@chromium.org 已提交
79 80 81

namespace {

K
kailiu 已提交
82 83 84 85 86 87 88 89 90 91
// A wrapper for fadvise, if the platform doesn't support fadvise,
// it will simply return Status::NotSupport.
int Fadvise(int fd, off_t offset, size_t len, int advice) {
#ifdef OS_LINUX
  return posix_fadvise(fd, offset, len, advice);
#else
  return 0;  // simply do nothing.
#endif
}

92 93 94 95
// list of pathnames that are locked
static std::set<std::string> lockedFiles;
static port::Mutex mutex_lockedFiles;

96 97 98 99
static Status IOError(const std::string& context, int err_number) {
  return Status::IOError(context, strerror(err_number));
}

100 101
#ifdef NDEBUG
// empty in release build
102
#define TEST_KILL_RANDOM(rocksdb_kill_odds)
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
#else

// Kill the process with probablity 1/odds for testing.
static void TestKillRandom(int odds, const std::string& srcfile,
                           int srcline) {
  time_t curtime = time(nullptr);
  Random r((uint32_t)curtime);

  assert(odds > 0);
  bool crash = r.OneIn(odds);
  if (crash) {
    fprintf(stdout, "Crashing at %s:%d\n", srcfile.c_str(), srcline);
    fflush(stdout);
    kill(getpid(), SIGTERM);
  }
}

// To avoid crashing always at some frequently executed codepaths (during
// kill random test), use this factor to reduce odds
#define REDUCE_ODDS 2
#define REDUCE_ODDS2 4

125 126 127
#define TEST_KILL_RANDOM(rocksdb_kill_odds) {   \
  if (rocksdb_kill_odds > 0) { \
    TestKillRandom(rocksdb_kill_odds, __FILE__, __LINE__);     \
128 129 130 131 132
  } \
}

#endif

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
#if defined(OS_LINUX)
namespace {
  static size_t GetUniqueIdFromFile(int fd, char* id, size_t max_size) {
    if (max_size < kMaxVarint64Length*3) {
      return 0;
    }

    struct stat buf;
    int result = fstat(fd, &buf);
    if (result == -1) {
      return 0;
    }

    long version = 0;
    result = ioctl(fd, FS_IOC_GETVERSION, &version);
    if (result == -1) {
      return 0;
    }
    uint64_t uversion = (uint64_t)version;

    char* rid = id;
    rid = EncodeVarint64(rid, buf.st_dev);
    rid = EncodeVarint64(rid, buf.st_ino);
    rid = EncodeVarint64(rid, uversion);
    assert(rid >= id);
    return static_cast<size_t>(rid-id);
  }
}
#endif

J
jorlow@chromium.org 已提交
163 164 165 166
class PosixSequentialFile: public SequentialFile {
 private:
  std::string filename_;
  FILE* file_;
167
  int fd_;
168
  bool use_os_buffer_;
J
jorlow@chromium.org 已提交
169 170

 public:
171 172
  PosixSequentialFile(const std::string& fname, FILE* f,
      const EnvOptions& options)
173
      : filename_(fname), file_(f), fd_(fileno(f)),
H
Haobo Xu 已提交
174
        use_os_buffer_(options.use_os_buffer) {
175
  }
J
jorlow@chromium.org 已提交
176 177 178 179
  virtual ~PosixSequentialFile() { fclose(file_); }

  virtual Status Read(size_t n, Slice* result, char* scratch) {
    Status s;
180
    size_t r = 0;
I
Igor Canadi 已提交
181 182
    do {
      r = fread_unlocked(scratch, 1, n, file_);
183
    } while (r == 0 && ferror(file_) && errno == EINTR);
184
    IOSTATS_ADD(bytes_read, r);
J
jorlow@chromium.org 已提交
185 186 187 188
    *result = Slice(scratch, r);
    if (r < n) {
      if (feof(file_)) {
        // We leave status as ok if we hit the end of the file
189 190 191
        // We also clear the error so that the reads can continue
        // if a new data is written to the file
        clearerr(file_);
J
jorlow@chromium.org 已提交
192 193
      } else {
        // A partial read with an error: return a non-ok status
194
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
195 196
      }
    }
197
    if (!use_os_buffer_) {
198 199
      // we need to fadvise away the entire range of pages because
      // we do not want readahead pages to be cached.
K
kailiu 已提交
200
      Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED); // free OS pages
201
    }
J
jorlow@chromium.org 已提交
202 203
    return s;
  }
204 205 206

  virtual Status Skip(uint64_t n) {
    if (fseek(file_, n, SEEK_CUR)) {
207
      return IOError(filename_, errno);
208 209 210
    }
    return Status::OK();
  }
211 212

  virtual Status InvalidateCache(size_t offset, size_t length) {
K
kailiu 已提交
213 214 215
#ifndef OS_LINUX
    return Status::OK();
#else
216
    // free OS pages
K
kailiu 已提交
217
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
218 219 220 221
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
222
#endif
223
  }
J
jorlow@chromium.org 已提交
224 225
};

226
// pread() based random-access
J
jorlow@chromium.org 已提交
227 228 229 230
class PosixRandomAccessFile: public RandomAccessFile {
 private:
  std::string filename_;
  int fd_;
231
  bool use_os_buffer_;
J
jorlow@chromium.org 已提交
232 233

 public:
234 235
  PosixRandomAccessFile(const std::string& fname, int fd,
                        const EnvOptions& options)
H
Haobo Xu 已提交
236 237
      : filename_(fname), fd_(fd), use_os_buffer_(options.use_os_buffer) {
    assert(!options.use_mmap_reads);
238
  }
J
jorlow@chromium.org 已提交
239 240 241 242 243
  virtual ~PosixRandomAccessFile() { close(fd_); }

  virtual Status Read(uint64_t offset, size_t n, Slice* result,
                      char* scratch) const {
    Status s;
I
Igor Canadi 已提交
244 245 246 247
    ssize_t r = -1;
    do {
      r = pread(fd_, scratch, n, static_cast<off_t>(offset));
    } while (r < 0 && errno == EINTR);
248
    IOSTATS_ADD_IF_POSITIVE(bytes_read, r);
J
jorlow@chromium.org 已提交
249 250 251
    *result = Slice(scratch, (r < 0) ? 0 : r);
    if (r < 0) {
      // An error: return a non-ok status
252
      s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
253
    }
254
    if (!use_os_buffer_) {
255 256
      // we need to fadvise away the entire range of pages because
      // we do not want readahead pages to be cached.
K
kailiu 已提交
257
      Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED); // free OS pages
258
    }
J
jorlow@chromium.org 已提交
259 260
    return s;
  }
261

K
kailiu 已提交
262
#ifdef OS_LINUX
263
  virtual size_t GetUniqueId(char* id, size_t max_size) const {
264
    return GetUniqueIdFromFile(fd_, id, max_size);
265 266
  }
#endif
267 268 269 270

  virtual void Hint(AccessPattern pattern) {
    switch(pattern) {
      case NORMAL:
K
kailiu 已提交
271
        Fadvise(fd_, 0, 0, POSIX_FADV_NORMAL);
272 273
        break;
      case RANDOM:
K
kailiu 已提交
274
        Fadvise(fd_, 0, 0, POSIX_FADV_RANDOM);
275 276
        break;
      case SEQUENTIAL:
K
kailiu 已提交
277
        Fadvise(fd_, 0, 0, POSIX_FADV_SEQUENTIAL);
278 279
        break;
      case WILLNEED:
K
kailiu 已提交
280
        Fadvise(fd_, 0, 0, POSIX_FADV_WILLNEED);
281 282
        break;
      case DONTNEED:
K
kailiu 已提交
283
        Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED);
284 285 286 287 288 289 290
        break;
      default:
        assert(false);
        break;
    }
  }

291
  virtual Status InvalidateCache(size_t offset, size_t length) {
K
kailiu 已提交
292 293 294
#ifndef OS_LINUX
    return Status::OK();
#else
295
    // free OS pages
K
kailiu 已提交
296
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
297 298 299 300
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
301
#endif
302
  }
J
jorlow@chromium.org 已提交
303 304
};

305 306 307
// mmap() based random-access
class PosixMmapReadableFile: public RandomAccessFile {
 private:
308
  int fd_;
309 310 311 312 313 314
  std::string filename_;
  void* mmapped_region_;
  size_t length_;

 public:
  // base[0,length-1] contains the mmapped contents of the file.
315 316
  PosixMmapReadableFile(const int fd, const std::string& fname,
                        void* base, size_t length,
317
                        const EnvOptions& options)
318
      : fd_(fd), filename_(fname), mmapped_region_(base), length_(length) {
K
kailiu 已提交
319
    fd_ = fd_ + 0;  // suppress the warning for used variables
H
Haobo Xu 已提交
320 321
    assert(options.use_mmap_reads);
    assert(options.use_os_buffer);
322
  }
S
Siying Dong 已提交
323
  virtual ~PosixMmapReadableFile() {
324 325 326 327 328
    int ret = munmap(mmapped_region_, length_);
    if (ret != 0) {
      fprintf(stdout, "failed to munmap %p length %zu \n",
              mmapped_region_, length_);
    }
S
Siying Dong 已提交
329
  }
330 331 332 333 334 335 336 337 338 339 340 341

  virtual Status Read(uint64_t offset, size_t n, Slice* result,
                      char* scratch) const {
    Status s;
    if (offset + n > length_) {
      *result = Slice();
      s = IOError(filename_, EINVAL);
    } else {
      *result = Slice(reinterpret_cast<char*>(mmapped_region_) + offset, n);
    }
    return s;
  }
342
  virtual Status InvalidateCache(size_t offset, size_t length) {
K
kailiu 已提交
343 344 345
#ifndef OS_LINUX
    return Status::OK();
#else
346
    // free OS pages
K
kailiu 已提交
347
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
348 349 350 351
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
352
#endif
353
  }
354 355
};

J
jorlow@chromium.org 已提交
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
// We preallocate up to an extra megabyte and use memcpy to append new
// data to the file.  This is safe since we either properly close the
// file before reading from it, or for log files, the reading code
// knows enough to skip zero suffixes.
class PosixMmapFile : public WritableFile {
 private:
  std::string filename_;
  int fd_;
  size_t page_size_;
  size_t map_size_;       // How much extra memory to map at a time
  char* base_;            // The mapped region
  char* limit_;           // Limit of the mapped region
  char* dst_;             // Where to write next  (in range [base_,limit_])
  char* last_sync_;       // Where have we synced up to
  uint64_t file_offset_;  // Offset of base_ in file
  // Have we done an munmap of unsynced data?
  bool pending_sync_;
I
Igor Canadi 已提交
373
#ifdef ROCKSDB_FALLOCATE_PRESENT
I
Igor Canadi 已提交
374
  bool fallocate_with_keep_size_;
I
Igor Canadi 已提交
375
#endif
J
jorlow@chromium.org 已提交
376 377 378 379 380 381 382 383 384 385 386 387

  // Roundup x to a multiple of y
  static size_t Roundup(size_t x, size_t y) {
    return ((x + y - 1) / y) * y;
  }

  size_t TruncateToPageBoundary(size_t s) {
    s -= (s & (page_size_ - 1));
    assert((s % page_size_) == 0);
    return s;
  }

388 389
  bool UnmapCurrentRegion() {
    bool result = true;
390
    TEST_KILL_RANDOM(rocksdb_kill_odds);
A
Abhishek Kona 已提交
391
    if (base_ != nullptr) {
J
jorlow@chromium.org 已提交
392 393 394 395
      if (last_sync_ < limit_) {
        // Defer syncing this data until next Sync() call, if any
        pending_sync_ = true;
      }
396 397 398
      if (munmap(base_, limit_ - base_) != 0) {
        result = false;
      }
J
jorlow@chromium.org 已提交
399
      file_offset_ += limit_ - base_;
A
Abhishek Kona 已提交
400 401 402 403
      base_ = nullptr;
      limit_ = nullptr;
      last_sync_ = nullptr;
      dst_ = nullptr;
J
jorlow@chromium.org 已提交
404 405 406 407 408 409

      // Increase the amount we map the next time, but capped at 1MB
      if (map_size_ < (1<<20)) {
        map_size_ *= 2;
      }
    }
410
    return result;
J
jorlow@chromium.org 已提交
411 412
  }

A
Abhishek Kona 已提交
413
  Status MapNewRegion() {
414
#ifdef ROCKSDB_FALLOCATE_PRESENT
A
Abhishek Kona 已提交
415
    assert(base_ == nullptr);
A
Abhishek Kona 已提交
416

417
    TEST_KILL_RANDOM(rocksdb_kill_odds);
I
Igor Canadi 已提交
418 419 420 421 422 423
    // we can't fallocate with FALLOC_FL_KEEP_SIZE here
    int alloc_status = fallocate(fd_, 0, file_offset_, map_size_);
    if (alloc_status != 0) {
      // fallback to posix_fallocate
      alloc_status = posix_fallocate(fd_, file_offset_, map_size_);
    }
A
Abhishek Kona 已提交
424 425 426
    if (alloc_status != 0) {
      return Status::IOError("Error allocating space to file : " + filename_ +
        "Error : " + strerror(alloc_status));
J
jorlow@chromium.org 已提交
427
    }
A
Abhishek Kona 已提交
428

429
    TEST_KILL_RANDOM(rocksdb_kill_odds);
A
Abhishek Kona 已提交
430
    void* ptr = mmap(nullptr, map_size_, PROT_READ | PROT_WRITE, MAP_SHARED,
J
jorlow@chromium.org 已提交
431 432
                     fd_, file_offset_);
    if (ptr == MAP_FAILED) {
A
Abhishek Kona 已提交
433
      return Status::IOError("MMap failed on " + filename_);
J
jorlow@chromium.org 已提交
434
    }
435

436
    TEST_KILL_RANDOM(rocksdb_kill_odds);
437

J
jorlow@chromium.org 已提交
438 439 440 441
    base_ = reinterpret_cast<char*>(ptr);
    limit_ = base_ + map_size_;
    dst_ = base_;
    last_sync_ = base_;
A
Abhishek Kona 已提交
442
    return Status::OK();
K
kailiu 已提交
443 444 445
#else
    return Status::NotSupported("This platform doesn't support fallocate()");
#endif
J
jorlow@chromium.org 已提交
446 447 448
  }

 public:
449 450
  PosixMmapFile(const std::string& fname, int fd, size_t page_size,
                const EnvOptions& options)
J
jorlow@chromium.org 已提交
451 452 453 454
      : filename_(fname),
        fd_(fd),
        page_size_(page_size),
        map_size_(Roundup(65536, page_size)),
A
Abhishek Kona 已提交
455 456 457 458
        base_(nullptr),
        limit_(nullptr),
        dst_(nullptr),
        last_sync_(nullptr),
J
jorlow@chromium.org 已提交
459
        file_offset_(0),
I
Igor Canadi 已提交
460 461 462 463
        pending_sync_(false) {
#ifdef ROCKSDB_FALLOCATE_PRESENT
    fallocate_with_keep_size_ = options.fallocate_with_keep_size;
#endif
J
jorlow@chromium.org 已提交
464
    assert((page_size & (page_size - 1)) == 0);
H
Haobo Xu 已提交
465
    assert(options.use_mmap_writes);
J
jorlow@chromium.org 已提交
466 467 468 469 470 471 472 473 474 475 476 477
  }


  ~PosixMmapFile() {
    if (fd_ >= 0) {
      PosixMmapFile::Close();
    }
  }

  virtual Status Append(const Slice& data) {
    const char* src = data.data();
    size_t left = data.size();
478
    TEST_KILL_RANDOM(rocksdb_kill_odds * REDUCE_ODDS);
479
    PrepareWrite(GetFileSize(), left);
J
jorlow@chromium.org 已提交
480 481 482 483 484
    while (left > 0) {
      assert(base_ <= dst_);
      assert(dst_ <= limit_);
      size_t avail = limit_ - dst_;
      if (avail == 0) {
A
Abhishek Kona 已提交
485 486 487 488 489
        if (UnmapCurrentRegion()) {
          Status s = MapNewRegion();
          if (!s.ok()) {
            return s;
          }
490
          TEST_KILL_RANDOM(rocksdb_kill_odds);
491
        }
J
jorlow@chromium.org 已提交
492 493 494 495
      }

      size_t n = (left <= avail) ? left : avail;
      memcpy(dst_, src, n);
496
      IOSTATS_ADD(bytes_written, n);
J
jorlow@chromium.org 已提交
497 498 499 500
      dst_ += n;
      src += n;
      left -= n;
    }
501
    TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
502 503 504 505 506 507
    return Status::OK();
  }

  virtual Status Close() {
    Status s;
    size_t unused = limit_ - dst_;
508

509
    TEST_KILL_RANDOM(rocksdb_kill_odds);
510

511 512 513
    if (!UnmapCurrentRegion()) {
      s = IOError(filename_, errno);
    } else if (unused > 0) {
J
jorlow@chromium.org 已提交
514 515
      // Trim the extra space at the end of the file
      if (ftruncate(fd_, file_offset_ - unused) < 0) {
516
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
517 518 519
      }
    }

520
    TEST_KILL_RANDOM(rocksdb_kill_odds);
521

J
jorlow@chromium.org 已提交
522 523
    if (close(fd_) < 0) {
      if (s.ok()) {
524
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
525 526 527 528
      }
    }

    fd_ = -1;
A
Abhishek Kona 已提交
529 530
    base_ = nullptr;
    limit_ = nullptr;
J
jorlow@chromium.org 已提交
531 532 533 534
    return s;
  }

  virtual Status Flush() {
535
    TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
536 537 538 539 540 541 542 543
    return Status::OK();
  }

  virtual Status Sync() {
    Status s;

    if (pending_sync_) {
      // Some unmapped data was not synced
544
      TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
545 546
      pending_sync_ = false;
      if (fdatasync(fd_) < 0) {
547
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
548
      }
549
      TEST_KILL_RANDOM(rocksdb_kill_odds * REDUCE_ODDS);
J
jorlow@chromium.org 已提交
550 551 552 553 554 555 556 557
    }

    if (dst_ > last_sync_) {
      // Find the beginnings of the pages that contain the first and last
      // bytes to be synced.
      size_t p1 = TruncateToPageBoundary(last_sync_ - base_);
      size_t p2 = TruncateToPageBoundary(dst_ - base_ - 1);
      last_sync_ = dst_;
558
      TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
559
      if (msync(base_ + p1, p2 - p1 + page_size_, MS_SYNC) < 0) {
560
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
561
      }
562
      TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
563 564 565 566
    }

    return s;
  }
567 568 569 570 571 572 573

  /**
   * Flush data as well as metadata to stable storage.
   */
  virtual Status Fsync() {
    if (pending_sync_) {
      // Some unmapped data was not synced
574
      TEST_KILL_RANDOM(rocksdb_kill_odds);
575 576 577 578
      pending_sync_ = false;
      if (fsync(fd_) < 0) {
        return IOError(filename_, errno);
      }
579
      TEST_KILL_RANDOM(rocksdb_kill_odds);
580 581 582 583 584
    }
    // This invocation to Sync will not issue the call to
    // fdatasync because pending_sync_ has already been cleared.
    return Sync();
  }
585 586 587 588 589 590 591 592 593 594

  /**
   * Get the size of valid data in the file. This will not match the
   * size that is returned from the filesystem because we use mmap
   * to extend file by map_size every time.
   */
  virtual uint64_t GetFileSize() {
    size_t used = dst_ - base_;
    return file_offset_ + used;
  }
595

596
  virtual Status InvalidateCache(size_t offset, size_t length) {
K
kailiu 已提交
597 598 599
#ifndef OS_LINUX
    return Status::OK();
#else
600
    // free OS pages
K
kailiu 已提交
601
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
602 603 604 605
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
606
#endif
607 608
  }

609
#ifdef ROCKSDB_FALLOCATE_PRESENT
610
  virtual Status Allocate(off_t offset, off_t len) {
611
    TEST_KILL_RANDOM(rocksdb_kill_odds);
I
Igor Canadi 已提交
612 613 614
    int alloc_status = fallocate(
        fd_, fallocate_with_keep_size_ ? FALLOC_FL_KEEP_SIZE : 0, offset, len);
    if (alloc_status == 0) {
615 616 617 618 619
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
620
#endif
J
jorlow@chromium.org 已提交
621 622
};

623 624 625 626 627 628 629
// Use posix write to write data to a file.
class PosixWritableFile : public WritableFile {
 private:
  const std::string filename_;
  int fd_;
  size_t cursize_;      // current size of cached data in buf_
  size_t capacity_;     // max size of buf_
M
Mayank Agarwal 已提交
630
  unique_ptr<char[]> buf_;           // a buffer to cache writes
631 632 633
  uint64_t filesize_;
  bool pending_sync_;
  bool pending_fsync_;
634
  uint64_t last_sync_size_;
H
Haobo Xu 已提交
635
  uint64_t bytes_per_sync_;
I
Igor Canadi 已提交
636
#ifdef ROCKSDB_FALLOCATE_PRESENT
I
Igor Canadi 已提交
637
  bool fallocate_with_keep_size_;
I
Igor Canadi 已提交
638
#endif
L
Lei Jin 已提交
639
  RateLimiter* rate_limiter_;
640 641

 public:
642
  PosixWritableFile(const std::string& fname, int fd, size_t capacity,
I
Igor Canadi 已提交
643 644 645 646 647 648 649 650 651 652
                    const EnvOptions& options)
      : filename_(fname),
        fd_(fd),
        cursize_(0),
        capacity_(capacity),
        buf_(new char[capacity]),
        filesize_(0),
        pending_sync_(false),
        pending_fsync_(false),
        last_sync_size_(0),
L
Lei Jin 已提交
653 654
        bytes_per_sync_(options.bytes_per_sync),
        rate_limiter_(options.rate_limiter) {
I
Igor Canadi 已提交
655 656 657
#ifdef ROCKSDB_FALLOCATE_PRESENT
    fallocate_with_keep_size_ = options.fallocate_with_keep_size;
#endif
H
Haobo Xu 已提交
658
    assert(!options.use_mmap_writes);
659 660 661 662 663 664 665 666 667
  }

  ~PosixWritableFile() {
    if (fd_ >= 0) {
      PosixWritableFile::Close();
    }
  }

  virtual Status Append(const Slice& data) {
668
    const char* src = data.data();
669 670 671 672 673
    size_t left = data.size();
    Status s;
    pending_sync_ = true;
    pending_fsync_ = true;

674
    TEST_KILL_RANDOM(rocksdb_kill_odds * REDUCE_ODDS2);
675

676
    PrepareWrite(GetFileSize(), left);
677 678 679 680 681 682 683 684 685
    // if there is no space in the cache, then flush
    if (cursize_ + left > capacity_) {
      s = Flush();
      if (!s.ok()) {
        return s;
      }
      // Increase the buffer size, but capped at 1MB
      if (capacity_ < (1<<20)) {
        capacity_ *= 2;
M
Mayank Agarwal 已提交
686
        buf_.reset(new char[capacity_]);
687 688 689 690 691 692 693
      }
      assert(cursize_ == 0);
    }

    // if the write fits into the cache, then write to cache
    // otherwise do a write() syscall to write to OS buffers.
    if (cursize_ + left <= capacity_) {
M
Mayank Agarwal 已提交
694
      memcpy(buf_.get()+cursize_, src, left);
695 696 697
      cursize_ += left;
    } else {
      while (left != 0) {
L
Lei Jin 已提交
698
        ssize_t done = write(fd_, src, RequestToken(left));
699
        if (done < 0) {
I
Igor Canadi 已提交
700 701 702
          if (errno == EINTR) {
            continue;
          }
703 704
          return IOError(filename_, errno);
        }
705
        IOSTATS_ADD(bytes_written, done);
706
        TEST_KILL_RANDOM(rocksdb_kill_odds);
707

708 709 710 711 712 713 714 715 716 717 718 719
        left -= done;
        src += done;
      }
    }
    filesize_ += data.size();
    return Status::OK();
  }

  virtual Status Close() {
    Status s;
    s = Flush(); // flush cache to OS
    if (!s.ok()) {
720
      return s;
721
    }
722

723
    TEST_KILL_RANDOM(rocksdb_kill_odds);
724

725 726 727 728 729
    size_t block_size;
    size_t last_allocated_block;
    GetPreallocationStatus(&block_size, &last_allocated_block);
    if (last_allocated_block > 0) {
      // trim the extra space preallocated at the end of the file
730 731
      int dummy __attribute__((unused));
      dummy = ftruncate(fd_, filesize_);  // ignore errors
732 733
    }

734 735 736 737 738 739 740 741 742 743 744
    if (close(fd_) < 0) {
      if (s.ok()) {
        s = IOError(filename_, errno);
      }
    }
    fd_ = -1;
    return s;
  }

  // write out the cached data to the OS cache
  virtual Status Flush() {
745
    TEST_KILL_RANDOM(rocksdb_kill_odds * REDUCE_ODDS2);
746
    size_t left = cursize_;
M
Mayank Agarwal 已提交
747
    char* src = buf_.get();
748
    while (left != 0) {
L
Lei Jin 已提交
749
      ssize_t done = write(fd_, src, RequestToken(left));
750
      if (done < 0) {
I
Igor Canadi 已提交
751 752 753
        if (errno == EINTR) {
          continue;
        }
754 755
        return IOError(filename_, errno);
      }
756
      IOSTATS_ADD(bytes_written, done);
757
      TEST_KILL_RANDOM(rocksdb_kill_odds * REDUCE_ODDS2);
758 759 760 761
      left -= done;
      src += done;
    }
    cursize_ = 0;
762

H
Haobo Xu 已提交
763 764 765 766 767 768
    // sync OS cache to disk for every bytes_per_sync_
    // TODO: give log file and sst file different options (log
    // files could be potentially cached in OS for their whole
    // life time, thus we might not want to flush at all).
    if (bytes_per_sync_ &&
        filesize_ - last_sync_size_ >= bytes_per_sync_) {
769 770 771 772
      RangeSync(last_sync_size_, filesize_ - last_sync_size_);
      last_sync_size_ = filesize_;
    }

773 774 775 776
    return Status::OK();
  }

  virtual Status Sync() {
I
Igor Canadi 已提交
777 778 779 780
    Status s = Flush();
    if (!s.ok()) {
      return s;
    }
781
    TEST_KILL_RANDOM(rocksdb_kill_odds);
782 783 784
    if (pending_sync_ && fdatasync(fd_) < 0) {
      return IOError(filename_, errno);
    }
785
    TEST_KILL_RANDOM(rocksdb_kill_odds);
786 787 788 789 790
    pending_sync_ = false;
    return Status::OK();
  }

  virtual Status Fsync() {
I
Igor Canadi 已提交
791 792 793 794
    Status s = Flush();
    if (!s.ok()) {
      return s;
    }
795
    TEST_KILL_RANDOM(rocksdb_kill_odds);
796 797 798
    if (pending_fsync_ && fsync(fd_) < 0) {
      return IOError(filename_, errno);
    }
799
    TEST_KILL_RANDOM(rocksdb_kill_odds);
800 801 802 803 804 805 806 807
    pending_fsync_ = false;
    pending_sync_ = false;
    return Status::OK();
  }

  virtual uint64_t GetFileSize() {
    return filesize_;
  }
808

809
  virtual Status InvalidateCache(size_t offset, size_t length) {
K
kailiu 已提交
810 811 812
#ifndef OS_LINUX
    return Status::OK();
#else
813
    // free OS pages
K
kailiu 已提交
814
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
815 816 817 818
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
819
#endif
820 821
  }

822
#ifdef ROCKSDB_FALLOCATE_PRESENT
823
  virtual Status Allocate(off_t offset, off_t len) {
824
    TEST_KILL_RANDOM(rocksdb_kill_odds);
I
Igor Canadi 已提交
825 826 827
    int alloc_status = fallocate(
        fd_, fallocate_with_keep_size_ ? FALLOC_FL_KEEP_SIZE : 0, offset, len);
    if (alloc_status == 0) {
828 829 830 831 832
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
833

I
Igor Canadi 已提交
834
  virtual Status RangeSync(off_t offset, off_t nbytes) {
835 836 837 838 839 840
    if (sync_file_range(fd_, offset, nbytes, SYNC_FILE_RANGE_WRITE) == 0) {
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
841 842 843
  virtual size_t GetUniqueId(char* id, size_t max_size) const {
    return GetUniqueIdFromFile(fd_, id, max_size);
  }
844
#endif
L
Lei Jin 已提交
845 846 847 848 849 850 851 852 853 854

 private:
  inline size_t RequestToken(size_t bytes) {
    if (rate_limiter_ && io_priority_ < Env::IO_TOTAL) {
      bytes = std::min(bytes,
          static_cast<size_t>(rate_limiter_->GetSingleBurstBytes()));
      rate_limiter_->Request(bytes, io_priority_);
    }
    return bytes;
  }
855 856
};

857 858 859 860 861 862
class PosixRandomRWFile : public RandomRWFile {
 private:
  const std::string filename_;
  int fd_;
  bool pending_sync_;
  bool pending_fsync_;
I
Igor Canadi 已提交
863
#ifdef ROCKSDB_FALLOCATE_PRESENT
I
Igor Canadi 已提交
864
  bool fallocate_with_keep_size_;
I
Igor Canadi 已提交
865
#endif
866 867

 public:
I
Igor Canadi 已提交
868 869 870 871
  PosixRandomRWFile(const std::string& fname, int fd, const EnvOptions& options)
      : filename_(fname),
        fd_(fd),
        pending_sync_(false),
I
Igor Canadi 已提交
872 873 874 875
        pending_fsync_(false) {
#ifdef ROCKSDB_FALLOCATE_PRESENT
    fallocate_with_keep_size_ = options.fallocate_with_keep_size;
#endif
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
    assert(!options.use_mmap_writes && !options.use_mmap_reads);
  }

  ~PosixRandomRWFile() {
    if (fd_ >= 0) {
      Close();
    }
  }

  virtual Status Write(uint64_t offset, const Slice& data) {
    const char* src = data.data();
    size_t left = data.size();
    Status s;
    pending_sync_ = true;
    pending_fsync_ = true;

    while (left != 0) {
      ssize_t done = pwrite(fd_, src, left, offset);
      if (done < 0) {
I
Igor Canadi 已提交
895 896 897
        if (errno == EINTR) {
          continue;
        }
898 899
        return IOError(filename_, errno);
      }
900
      IOSTATS_ADD(bytes_written, done);
901 902 903 904 905 906 907 908 909 910 911 912 913

      left -= done;
      src += done;
      offset += done;
    }

    return Status::OK();
  }

  virtual Status Read(uint64_t offset, size_t n, Slice* result,
                      char* scratch) const {
    Status s;
    ssize_t r = pread(fd_, scratch, n, static_cast<off_t>(offset));
914
    IOSTATS_ADD_IF_POSITIVE(bytes_read, r);
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
    *result = Slice(scratch, (r < 0) ? 0 : r);
    if (r < 0) {
      s = IOError(filename_, errno);
    }
    return s;
  }

  virtual Status Close() {
    Status s = Status::OK();
    if (fd_ >= 0 && close(fd_) < 0) {
      s = IOError(filename_, errno);
    }
    fd_ = -1;
    return s;
  }

  virtual Status Sync() {
    if (pending_sync_ && fdatasync(fd_) < 0) {
      return IOError(filename_, errno);
    }
    pending_sync_ = false;
    return Status::OK();
  }

  virtual Status Fsync() {
    if (pending_fsync_ && fsync(fd_) < 0) {
      return IOError(filename_, errno);
    }
    pending_fsync_ = false;
    pending_sync_ = false;
    return Status::OK();
  }

948
#ifdef ROCKSDB_FALLOCATE_PRESENT
949
  virtual Status Allocate(off_t offset, off_t len) {
I
Igor Canadi 已提交
950 951 952 953
    TEST_KILL_RANDOM(rocksdb_kill_odds);
    int alloc_status = fallocate(
        fd_, fallocate_with_keep_size_ ? FALLOC_FL_KEEP_SIZE : 0, offset, len);
    if (alloc_status == 0) {
954 955 956 957 958 959 960 961
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
#endif
};

962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
class PosixDirectory : public Directory {
 public:
  explicit PosixDirectory(int fd) : fd_(fd) {}
  ~PosixDirectory() {
    close(fd_);
  }

  virtual Status Fsync() {
    if (fsync(fd_) == -1) {
      return IOError("directory", errno);
    }
    return Status::OK();
  }

 private:
  int fd_;
};

980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
static int LockOrUnlock(const std::string& fname, int fd, bool lock) {
  mutex_lockedFiles.Lock();
  if (lock) {
    // If it already exists in the lockedFiles set, then it is already locked,
    // and fail this lock attempt. Otherwise, insert it into lockedFiles.
    // This check is needed because fcntl() does not detect lock conflict
    // if the fcntl is issued by the same thread that earlier acquired
    // this lock.
    if (lockedFiles.insert(fname).second == false) {
      mutex_lockedFiles.Unlock();
      errno = ENOLCK;
      return -1;
    }
  } else {
    // If we are unlocking, then verify that we had locked it earlier,
    // it should already exist in lockedFiles. Remove it from lockedFiles.
    if (lockedFiles.erase(fname) != 1) {
      mutex_lockedFiles.Unlock();
      errno = ENOLCK;
      return -1;
    }
  }
J
jorlow@chromium.org 已提交
1002 1003 1004 1005 1006 1007 1008
  errno = 0;
  struct flock f;
  memset(&f, 0, sizeof(f));
  f.l_type = (lock ? F_WRLCK : F_UNLCK);
  f.l_whence = SEEK_SET;
  f.l_start = 0;
  f.l_len = 0;        // Lock/unlock entire file
1009 1010 1011 1012 1013 1014 1015
  int value = fcntl(fd, F_SETLK, &f);
  if (value == -1 && lock) {
    // if there is an error in locking, then remove the pathname from lockedfiles
    lockedFiles.erase(fname);
  }
  mutex_lockedFiles.Unlock();
  return value;
J
jorlow@chromium.org 已提交
1016 1017 1018 1019 1020
}

class PosixFileLock : public FileLock {
 public:
  int fd_;
1021
  std::string filename;
J
jorlow@chromium.org 已提交
1022 1023
};

1024 1025 1026 1027 1028 1029 1030 1031 1032 1033

namespace {
void PthreadCall(const char* label, int result) {
  if (result != 0) {
    fprintf(stderr, "pthread %s: %s\n", label, strerror(result));
    exit(1);
  }
}
}

J
jorlow@chromium.org 已提交
1034 1035 1036
class PosixEnv : public Env {
 public:
  PosixEnv();
1037 1038

  virtual ~PosixEnv(){
1039 1040 1041
    for (const auto tid : threads_to_join_) {
      pthread_join(tid, nullptr);
    }
J
jorlow@chromium.org 已提交
1042 1043
  }

1044
  void SetFD_CLOEXEC(int fd, const EnvOptions* options) {
H
Haobo Xu 已提交
1045
    if ((options == nullptr || options->set_fd_cloexec) && fd > 0) {
1046 1047 1048 1049
      fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
    }
  }

J
jorlow@chromium.org 已提交
1050
  virtual Status NewSequentialFile(const std::string& fname,
1051 1052
                                   unique_ptr<SequentialFile>* result,
                                   const EnvOptions& options) {
1053
    result->reset();
I
Igor Canadi 已提交
1054 1055 1056 1057
    FILE* f = nullptr;
    do {
      f = fopen(fname.c_str(), "r");
    } while (f == nullptr && errno == EINTR);
A
Abhishek Kona 已提交
1058 1059
    if (f == nullptr) {
      *result = nullptr;
1060
      return IOError(fname, errno);
J
jorlow@chromium.org 已提交
1061
    } else {
1062 1063
      int fd = fileno(f);
      SetFD_CLOEXEC(fd, &options);
1064
      result->reset(new PosixSequentialFile(fname, f, options));
J
jorlow@chromium.org 已提交
1065 1066 1067 1068 1069
      return Status::OK();
    }
  }

  virtual Status NewRandomAccessFile(const std::string& fname,
1070 1071
                                     unique_ptr<RandomAccessFile>* result,
                                     const EnvOptions& options) {
1072
    result->reset();
1073
    Status s;
J
jorlow@chromium.org 已提交
1074
    int fd = open(fname.c_str(), O_RDONLY);
1075
    SetFD_CLOEXEC(fd, &options);
J
jorlow@chromium.org 已提交
1076
    if (fd < 0) {
1077
      s = IOError(fname, errno);
H
Haobo Xu 已提交
1078
    } else if (options.use_mmap_reads && sizeof(void*) >= 8) {
1079 1080 1081 1082 1083 1084
      // Use of mmap for random reads has been removed because it
      // kills performance when storage is fast.
      // Use mmap when virtual address-space is plentiful.
      uint64_t size;
      s = GetFileSize(fname, &size);
      if (s.ok()) {
A
Abhishek Kona 已提交
1085
        void* base = mmap(nullptr, size, PROT_READ, MAP_SHARED, fd, 0);
1086
        if (base != MAP_FAILED) {
1087 1088
          result->reset(new PosixMmapReadableFile(fd, fname, base,
                                                  size, options));
1089 1090 1091 1092 1093
        } else {
          s = IOError(fname, errno);
        }
      }
      close(fd);
1094
    } else {
1095
      result->reset(new PosixRandomAccessFile(fname, fd, options));
J
jorlow@chromium.org 已提交
1096
    }
1097
    return s;
J
jorlow@chromium.org 已提交
1098 1099 1100
  }

  virtual Status NewWritableFile(const std::string& fname,
1101 1102
                                 unique_ptr<WritableFile>* result,
                                 const EnvOptions& options) {
1103
    result->reset();
J
jorlow@chromium.org 已提交
1104
    Status s;
I
Igor Canadi 已提交
1105 1106 1107 1108
    int fd = -1;
    do {
      fd = open(fname.c_str(), O_CREAT | O_RDWR | O_TRUNC, 0644);
    } while (fd < 0 && errno == EINTR);
J
jorlow@chromium.org 已提交
1109
    if (fd < 0) {
1110
      s = IOError(fname, errno);
J
jorlow@chromium.org 已提交
1111
    } else {
1112
      SetFD_CLOEXEC(fd, &options);
H
Haobo Xu 已提交
1113
      if (options.use_mmap_writes) {
1114 1115
        if (!checkedDiskForMmap_) {
          // this will be executed once in the program's lifetime.
A
Abhishek Kona 已提交
1116
          // do not use mmapWrite on non ext-3/xfs/tmpfs systems.
1117 1118 1119 1120
          if (!SupportsFastAllocate(fname)) {
            forceMmapOff = true;
          }
          checkedDiskForMmap_ = true;
A
Abhishek Kona 已提交
1121 1122
        }
      }
H
Haobo Xu 已提交
1123
      if (options.use_mmap_writes && !forceMmapOff) {
1124
        result->reset(new PosixMmapFile(fname, fd, page_size_, options));
1125
      } else {
K
kailiu 已提交
1126 1127 1128 1129 1130 1131 1132
        // disable mmap writes
        EnvOptions no_mmap_writes_options = options;
        no_mmap_writes_options.use_mmap_writes = false;

        result->reset(
            new PosixWritableFile(fname, fd, 65536, no_mmap_writes_options)
        );
1133
      }
J
jorlow@chromium.org 已提交
1134 1135 1136 1137
    }
    return s;
  }

1138 1139 1140 1141
  virtual Status NewRandomRWFile(const std::string& fname,
                                 unique_ptr<RandomRWFile>* result,
                                 const EnvOptions& options) {
    result->reset();
1142 1143 1144 1145
    // no support for mmap yet
    if (options.use_mmap_writes || options.use_mmap_reads) {
      return Status::NotSupported("No support for mmap read/write yet");
    }
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
    Status s;
    const int fd = open(fname.c_str(), O_CREAT | O_RDWR, 0644);
    if (fd < 0) {
      s = IOError(fname, errno);
    } else {
      SetFD_CLOEXEC(fd, &options);
      result->reset(new PosixRandomRWFile(fname, fd, options));
    }
    return s;
  }

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
  virtual Status NewDirectory(const std::string& name,
                              unique_ptr<Directory>* result) {
    result->reset();
    const int fd = open(name.c_str(), 0);
    if (fd < 0) {
      return IOError(name, errno);
    } else {
      result->reset(new PosixDirectory(fd));
    }
    return Status::OK();
  }

J
jorlow@chromium.org 已提交
1169 1170 1171 1172 1173 1174 1175 1176
  virtual bool FileExists(const std::string& fname) {
    return access(fname.c_str(), F_OK) == 0;
  }

  virtual Status GetChildren(const std::string& dir,
                             std::vector<std::string>* result) {
    result->clear();
    DIR* d = opendir(dir.c_str());
A
Abhishek Kona 已提交
1177
    if (d == nullptr) {
1178
      return IOError(dir, errno);
J
jorlow@chromium.org 已提交
1179 1180
    }
    struct dirent* entry;
A
Abhishek Kona 已提交
1181
    while ((entry = readdir(d)) != nullptr) {
J
jorlow@chromium.org 已提交
1182 1183 1184 1185 1186 1187 1188 1189 1190
      result->push_back(entry->d_name);
    }
    closedir(d);
    return Status::OK();
  }

  virtual Status DeleteFile(const std::string& fname) {
    Status result;
    if (unlink(fname.c_str()) != 0) {
1191
      result = IOError(fname, errno);
J
jorlow@chromium.org 已提交
1192 1193 1194 1195 1196 1197 1198
    }
    return result;
  };

  virtual Status CreateDir(const std::string& name) {
    Status result;
    if (mkdir(name.c_str(), 0755) != 0) {
1199
      result = IOError(name, errno);
J
jorlow@chromium.org 已提交
1200 1201 1202 1203
    }
    return result;
  };

1204 1205 1206 1207 1208
  virtual Status CreateDirIfMissing(const std::string& name) {
    Status result;
    if (mkdir(name.c_str(), 0755) != 0) {
      if (errno != EEXIST) {
        result = IOError(name, errno);
1209 1210 1211 1212
      } else if (!DirExists(name)) { // Check that name is actually a
                                     // directory.
        // Message is taken from mkdir
        result = Status::IOError("`"+name+"' exists but is not a directory");
1213 1214 1215 1216 1217
      }
    }
    return result;
  };

J
jorlow@chromium.org 已提交
1218 1219 1220
  virtual Status DeleteDir(const std::string& name) {
    Status result;
    if (rmdir(name.c_str()) != 0) {
1221
      result = IOError(name, errno);
J
jorlow@chromium.org 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230
    }
    return result;
  };

  virtual Status GetFileSize(const std::string& fname, uint64_t* size) {
    Status s;
    struct stat sbuf;
    if (stat(fname.c_str(), &sbuf) != 0) {
      *size = 0;
1231
      s = IOError(fname, errno);
J
jorlow@chromium.org 已提交
1232 1233 1234 1235 1236 1237
    } else {
      *size = sbuf.st_size;
    }
    return s;
  }

1238 1239 1240 1241 1242 1243 1244 1245 1246
  virtual Status GetFileModificationTime(const std::string& fname,
                                         uint64_t* file_mtime) {
    struct stat s;
    if (stat(fname.c_str(), &s) !=0) {
      return IOError(fname, errno);
    }
    *file_mtime = static_cast<uint64_t>(s.st_mtime);
    return Status::OK();
  }
J
jorlow@chromium.org 已提交
1247 1248 1249
  virtual Status RenameFile(const std::string& src, const std::string& target) {
    Status result;
    if (rename(src.c_str(), target.c_str()) != 0) {
1250
      result = IOError(src, errno);
J
jorlow@chromium.org 已提交
1251 1252 1253 1254 1255
    }
    return result;
  }

  virtual Status LockFile(const std::string& fname, FileLock** lock) {
A
Abhishek Kona 已提交
1256
    *lock = nullptr;
J
jorlow@chromium.org 已提交
1257 1258 1259
    Status result;
    int fd = open(fname.c_str(), O_RDWR | O_CREAT, 0644);
    if (fd < 0) {
1260
      result = IOError(fname, errno);
1261
    } else if (LockOrUnlock(fname, fd, true) == -1) {
1262
      result = IOError("lock " + fname, errno);
J
jorlow@chromium.org 已提交
1263 1264
      close(fd);
    } else {
1265
      SetFD_CLOEXEC(fd, nullptr);
J
jorlow@chromium.org 已提交
1266 1267
      PosixFileLock* my_lock = new PosixFileLock;
      my_lock->fd_ = fd;
1268
      my_lock->filename = fname;
J
jorlow@chromium.org 已提交
1269 1270 1271 1272 1273 1274 1275 1276
      *lock = my_lock;
    }
    return result;
  }

  virtual Status UnlockFile(FileLock* lock) {
    PosixFileLock* my_lock = reinterpret_cast<PosixFileLock*>(lock);
    Status result;
1277
    if (LockOrUnlock(my_lock->filename, my_lock->fd_, false) == -1) {
1278
      result = IOError("unlock", errno);
J
jorlow@chromium.org 已提交
1279 1280 1281 1282 1283 1284
    }
    close(my_lock->fd_);
    delete my_lock;
    return result;
  }

1285
  virtual void Schedule(void (*function)(void*), void* arg, Priority pri = LOW);
1286

J
jorlow@chromium.org 已提交
1287 1288
  virtual void StartThread(void (*function)(void* arg), void* arg);

L
Lei Jin 已提交
1289 1290
  virtual void WaitForJoin();

1291 1292
  virtual unsigned int GetThreadPoolQueueLen(Priority pri = LOW) const override;

J
jorlow@chromium.org 已提交
1293 1294 1295 1296 1297 1298
  virtual Status GetTestDirectory(std::string* result) {
    const char* env = getenv("TEST_TMPDIR");
    if (env && env[0] != '\0') {
      *result = env;
    } else {
      char buf[100];
1299
      snprintf(buf, sizeof(buf), "/tmp/rocksdbtest-%d", int(geteuid()));
J
jorlow@chromium.org 已提交
1300 1301 1302 1303 1304 1305 1306
      *result = buf;
    }
    // Directory may already exist
    CreateDir(*result);
    return Status::OK();
  }

1307
  static uint64_t gettid(pthread_t tid) {
J
jorlow@chromium.org 已提交
1308
    uint64_t thread_id = 0;
J
jorlow@chromium.org 已提交
1309
    memcpy(&thread_id, &tid, std::min(sizeof(thread_id), sizeof(tid)));
1310 1311
    return thread_id;
  }
J
jorlow@chromium.org 已提交
1312

1313 1314 1315 1316 1317
  static uint64_t gettid() {
    pthread_t tid = pthread_self();
    return gettid(tid);
  }

1318 1319
  virtual Status NewLogger(const std::string& fname,
                           shared_ptr<Logger>* result) {
1320
    FILE* f = fopen(fname.c_str(), "w");
A
Abhishek Kona 已提交
1321
    if (f == nullptr) {
1322
      result->reset();
1323 1324
      return IOError(fname, errno);
    } else {
1325 1326
      int fd = fileno(f);
      SetFD_CLOEXEC(fd, nullptr);
I
Igor Canadi 已提交
1327
      result->reset(new PosixLogger(f, &PosixEnv::gettid, this));
1328
      return Status::OK();
J
jorlow@chromium.org 已提交
1329 1330 1331 1332 1333
    }
  }

  virtual uint64_t NowMicros() {
    struct timeval tv;
K
kailiu 已提交
1334
    // TODO(kailiu) MAC DON'T HAVE THIS
A
Abhishek Kona 已提交
1335
    gettimeofday(&tv, nullptr);
J
jorlow@chromium.org 已提交
1336 1337 1338
    return static_cast<uint64_t>(tv.tv_sec) * 1000000 + tv.tv_usec;
  }

1339
  virtual uint64_t NowNanos() {
K
kailiu 已提交
1340
#ifdef OS_LINUX
1341 1342 1343
    struct timespec ts;
    clock_gettime(CLOCK_MONOTONIC, &ts);
    return static_cast<uint64_t>(ts.tv_sec) * 1000000000 + ts.tv_nsec;
K
kailiu 已提交
1344 1345 1346 1347 1348 1349 1350 1351
#elif __MACH__
    clock_serv_t cclock;
    mach_timespec_t ts;
    host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock);
    clock_get_time(cclock, &ts);
    mach_port_deallocate(mach_task_self(), cclock);
#endif
    return static_cast<uint64_t>(ts.tv_sec) * 1000000000 + ts.tv_nsec;
1352 1353
  }

J
jorlow@chromium.org 已提交
1354 1355 1356 1357
  virtual void SleepForMicroseconds(int micros) {
    usleep(micros);
  }

1358
  virtual Status GetHostName(char* name, uint64_t len) {
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
    int ret = gethostname(name, len);
    if (ret < 0) {
      if (errno == EFAULT || errno == EINVAL)
        return Status::InvalidArgument(strerror(errno));
      else
        return IOError("GetHostName", errno);
    }
    return Status::OK();
  }

  virtual Status GetCurrentTime(int64_t* unix_time) {
A
Abhishek Kona 已提交
1370
    time_t ret = time(nullptr);
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
    if (ret == (time_t) -1) {
      return IOError("GetCurrentTime", errno);
    }
    *unix_time = (int64_t) ret;
    return Status::OK();
  }

  virtual Status GetAbsolutePath(const std::string& db_path,
      std::string* output_path) {
    if (db_path.find('/') == 0) {
      *output_path = db_path;
      return Status::OK();
    }

    char the_path[256];
    char* ret = getcwd(the_path, 256);
A
Abhishek Kona 已提交
1387
    if (ret == nullptr) {
1388 1389 1390 1391 1392 1393 1394
      return Status::IOError(strerror(errno));
    }

    *output_path = ret;
    return Status::OK();
  }

A
Abhishek Kona 已提交
1395
  // Allow increasing the number of worker threads.
1396 1397 1398
  virtual void SetBackgroundThreads(int num, Priority pri) {
    assert(pri >= Priority::LOW && pri <= Priority::HIGH);
    thread_pools_[pri].SetBackgroundThreads(num);
1399 1400
  }

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
  virtual std::string TimeToString(uint64_t secondsSince1970) {
    const time_t seconds = (time_t)secondsSince1970;
    struct tm t;
    int maxsize = 64;
    std::string dummy;
    dummy.reserve(maxsize);
    dummy.resize(maxsize);
    char* p = &dummy[0];
    localtime_r(&seconds, &t);
    snprintf(p, maxsize,
             "%04d/%02d/%02d-%02d:%02d:%02d ",
             t.tm_year + 1900,
             t.tm_mon + 1,
             t.tm_mday,
             t.tm_hour,
             t.tm_min,
             t.tm_sec);
    return dummy;
  }

I
Igor Canadi 已提交
1421 1422 1423
  EnvOptions OptimizeForLogWrite(const EnvOptions& env_options) const {
    EnvOptions optimized = env_options;
    optimized.use_mmap_writes = false;
I
Igor Canadi 已提交
1424 1425 1426 1427
    // TODO(icanadi) it's faster if fallocate_with_keep_size is false, but it
    // breaks TransactionLogIteratorStallAtLastRecord unit test. Fix the unit
    // test and make this false
    optimized.fallocate_with_keep_size = true;
I
Igor Canadi 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
    return optimized;
  }

  EnvOptions OptimizeForManifestWrite(const EnvOptions& env_options) const {
    EnvOptions optimized = env_options;
    optimized.use_mmap_writes = false;
    optimized.fallocate_with_keep_size = true;
    return optimized;
  }

J
jorlow@chromium.org 已提交
1438
 private:
1439 1440
  bool checkedDiskForMmap_;
  bool forceMmapOff; // do we override Env options?
A
Abhishek Kona 已提交
1441

J
jorlow@chromium.org 已提交
1442

1443 1444 1445 1446 1447 1448 1449 1450 1451
  // Returns true iff the named directory exists and is a directory.
  virtual bool DirExists(const std::string& dname) {
    struct stat statbuf;
    if (stat(dname.c_str(), &statbuf) == 0) {
      return S_ISDIR(statbuf.st_mode);
    }
    return false; // stat() failed return false
  }

A
Abhishek Kona 已提交
1452
  bool SupportsFastAllocate(const std::string& path) {
J
James Golick 已提交
1453
#ifdef ROCKSDB_FALLOCATE_PRESENT
A
Abhishek Kona 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
    struct statfs s;
    if (statfs(path.c_str(), &s)){
      return false;
    }
    switch (s.f_type) {
      case EXT4_SUPER_MAGIC:
        return true;
      case XFS_SUPER_MAGIC:
        return true;
      case TMPFS_MAGIC:
        return true;
      default:
        return false;
    }
K
kailiu 已提交
1468 1469 1470
#else
    return false;
#endif
A
Abhishek Kona 已提交
1471 1472
  }

J
jorlow@chromium.org 已提交
1473 1474 1475
  size_t page_size_;


1476 1477
  class ThreadPool {
   public:
1478 1479 1480 1481 1482 1483
    ThreadPool()
        : total_threads_limit_(1),
          bgthreads_(0),
          queue_(),
          queue_len_(0),
          exit_all_threads_(false) {
1484 1485 1486
      PthreadCall("mutex_init", pthread_mutex_init(&mu_, nullptr));
      PthreadCall("cvar_init", pthread_cond_init(&bgsignal_, nullptr));
    }
J
jorlow@chromium.org 已提交
1487

1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
    ~ThreadPool() {
      PthreadCall("lock", pthread_mutex_lock(&mu_));
      assert(!exit_all_threads_);
      exit_all_threads_ = true;
      PthreadCall("signalall", pthread_cond_broadcast(&bgsignal_));
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
      for (const auto tid : bgthreads_) {
        pthread_join(tid, nullptr);
      }
    }
J
jorlow@chromium.org 已提交
1498

1499 1500 1501 1502 1503 1504 1505 1506 1507
    // Return true if there is at least one thread needs to terminate.
    bool HasExcessiveThread() {
      return static_cast<int>(bgthreads_.size()) > total_threads_limit_;
    }

    // Return true iff the current thread is the excessive thread to terminate.
    // Always terminate the running thread that is added last, even if there are
    // more than one thread to terminate.
    bool IsLastExcessiveThread(size_t thread_id) {
1508
      return HasExcessiveThread() && thread_id == bgthreads_.size() - 1;
1509 1510 1511 1512 1513 1514 1515 1516
    }

    // Is one of the threads to terminate.
    bool IsExcessiveThread(size_t thread_id) {
      return static_cast<int>(thread_id) >= total_threads_limit_;
    }

    void BGThread(size_t thread_id) {
1517 1518 1519
      while (true) {
        // Wait until there is an item that is ready to run
        PthreadCall("lock", pthread_mutex_lock(&mu_));
1520 1521 1522
        // Stop waiting if the thread needs to do work or needs to terminate.
        while (!exit_all_threads_ && !IsLastExcessiveThread(thread_id) &&
               (queue_.empty() || IsExcessiveThread(thread_id))) {
1523 1524 1525 1526 1527 1528
          PthreadCall("wait", pthread_cond_wait(&bgsignal_, &mu_));
        }
        if (exit_all_threads_) { // mechanism to let BG threads exit safely
          PthreadCall("unlock", pthread_mutex_unlock(&mu_));
          break;
        }
1529 1530 1531 1532
        if (IsLastExcessiveThread(thread_id)) {
          // Current thread is the last generated one and is excessive.
          // We always terminate excessive thread in the reverse order of
          // generation time.
1533 1534
          auto terminating_thread = bgthreads_.back();
          pthread_detach(terminating_thread);
1535 1536 1537 1538 1539 1540
          bgthreads_.pop_back();
          if (HasExcessiveThread()) {
            // There is still at least more excessive thread to terminate.
            WakeUpAllThreads();
          }
          PthreadCall("unlock", pthread_mutex_unlock(&mu_));
1541 1542
          // TODO(sdong): temp logging. Need to help debugging. Remove it when
          // the feature is proved to be stable.
1543 1544
          fprintf(stdout, "Bg thread %zu terminates %llx\n", thread_id,
                  static_cast<long long unsigned int>(gettid()));
1545 1546
          break;
        }
1547 1548 1549
        void (*function)(void*) = queue_.front().function;
        void* arg = queue_.front().arg;
        queue_.pop_front();
1550
        queue_len_.store(queue_.size(), std::memory_order_relaxed);
H
Haobo Xu 已提交
1551

1552 1553 1554 1555
        PthreadCall("unlock", pthread_mutex_unlock(&mu_));
        (*function)(arg);
      }
    }
J
jorlow@chromium.org 已提交
1556

1557 1558 1559 1560 1561 1562 1563 1564
    // Helper struct for passing arguments when creating threads.
    struct BGThreadMetadata {
      ThreadPool* thread_pool_;
      size_t thread_id_;  // Thread count in the thread.
      explicit BGThreadMetadata(ThreadPool* thread_pool, size_t thread_id)
          : thread_pool_(thread_pool), thread_id_(thread_id) {}
    };

1565
    static void* BGThreadWrapper(void* arg) {
1566 1567 1568 1569 1570
      BGThreadMetadata* meta = reinterpret_cast<BGThreadMetadata*>(arg);
      size_t thread_id = meta->thread_id_;
      ThreadPool* tp = meta->thread_pool_;
      delete meta;
      tp->BGThread(thread_id);
1571 1572
      return nullptr;
    }
J
jorlow@chromium.org 已提交
1573

1574 1575 1576 1577
    void WakeUpAllThreads() {
      PthreadCall("signalall", pthread_cond_broadcast(&bgsignal_));
    }

1578 1579
    void SetBackgroundThreads(int num) {
      PthreadCall("lock", pthread_mutex_lock(&mu_));
1580 1581 1582 1583 1584
      if (exit_all_threads_) {
        PthreadCall("unlock", pthread_mutex_unlock(&mu_));
        return;
      }
      if (num != total_threads_limit_) {
1585
        total_threads_limit_ = num;
1586 1587
        WakeUpAllThreads();
        StartBGThreads();
1588 1589 1590
      }
      assert(total_threads_limit_ > 0);
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
J
jorlow@chromium.org 已提交
1591
    }
1592

1593
    void StartBGThreads() {
1594 1595 1596 1597
      // Start background thread if necessary
      while ((int)bgthreads_.size() < total_threads_limit_) {
        pthread_t t;
        PthreadCall(
1598 1599 1600
            "create thread",
            pthread_create(&t, nullptr, &ThreadPool::BGThreadWrapper,
                           new BGThreadMetadata(this, bgthreads_.size())));
1601 1602

        // Set the thread name to aid debugging
1603 1604
#if defined(_GNU_SOURCE) && defined(__GLIBC_PREREQ)
#if __GLIBC_PREREQ(2, 12)
1605 1606 1607 1608
        char name_buf[16];
        snprintf(name_buf, sizeof name_buf, "rocksdb:bg%zu", bgthreads_.size());
        name_buf[sizeof name_buf - 1] = '\0';
        pthread_setname_np(t, name_buf);
1609
#endif
1610 1611
#endif

1612 1613
        bgthreads_.push_back(t);
      }
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
    }

    void Schedule(void (*function)(void*), void* arg) {
      PthreadCall("lock", pthread_mutex_lock(&mu_));

      if (exit_all_threads_) {
        PthreadCall("unlock", pthread_mutex_unlock(&mu_));
        return;
      }

      StartBGThreads();
1625 1626 1627 1628 1629

      // Add to priority queue
      queue_.push_back(BGItem());
      queue_.back().function = function;
      queue_.back().arg = arg;
1630
      queue_len_.store(queue_.size(), std::memory_order_relaxed);
1631

1632 1633 1634 1635 1636 1637 1638 1639
      if (!HasExcessiveThread()) {
        // Wake up at least one waiting thread.
        PthreadCall("signal", pthread_cond_signal(&bgsignal_));
      } else {
        // Need to wake up all threads to make sure the one woken
        // up is not the one to terminate.
        WakeUpAllThreads();
      }
1640

1641 1642
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
    }
J
jorlow@chromium.org 已提交
1643

1644 1645 1646 1647
    unsigned int GetQueueLen() const {
      return queue_len_.load(std::memory_order_relaxed);
    }

1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
   private:
    // Entry per Schedule() call
    struct BGItem { void* arg; void (*function)(void*); };
    typedef std::deque<BGItem> BGQueue;

    pthread_mutex_t mu_;
    pthread_cond_t bgsignal_;
    int total_threads_limit_;
    std::vector<pthread_t> bgthreads_;
    BGQueue queue_;
1658
    std::atomic_uint queue_len_;  // Queue length. Used for stats reporting
1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678
    bool exit_all_threads_;
  };

  std::vector<ThreadPool> thread_pools_;

  pthread_mutex_t mu_;
  std::vector<pthread_t> threads_to_join_;

};

PosixEnv::PosixEnv() : checkedDiskForMmap_(false),
                       forceMmapOff(false),
                       page_size_(getpagesize()),
                       thread_pools_(Priority::TOTAL) {
  PthreadCall("mutex_init", pthread_mutex_init(&mu_, nullptr));
}

void PosixEnv::Schedule(void (*function)(void*), void* arg, Priority pri) {
  assert(pri >= Priority::LOW && pri <= Priority::HIGH);
  thread_pools_[pri].Schedule(function, arg);
J
jorlow@chromium.org 已提交
1679 1680
}

1681 1682 1683 1684 1685
unsigned int PosixEnv::GetThreadPoolQueueLen(Priority pri) const {
  assert(pri >= Priority::LOW && pri <= Priority::HIGH);
  return thread_pools_[pri].GetQueueLen();
}

J
jorlow@chromium.org 已提交
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
namespace {
struct StartThreadState {
  void (*user_function)(void*);
  void* arg;
};
}
static void* StartThreadWrapper(void* arg) {
  StartThreadState* state = reinterpret_cast<StartThreadState*>(arg);
  state->user_function(state->arg);
  delete state;
A
Abhishek Kona 已提交
1696
  return nullptr;
J
jorlow@chromium.org 已提交
1697 1698 1699 1700 1701 1702 1703 1704
}

void PosixEnv::StartThread(void (*function)(void* arg), void* arg) {
  pthread_t t;
  StartThreadState* state = new StartThreadState;
  state->user_function = function;
  state->arg = arg;
  PthreadCall("start thread",
A
Abhishek Kona 已提交
1705
              pthread_create(&t, nullptr,  &StartThreadWrapper, state));
1706
  PthreadCall("lock", pthread_mutex_lock(&mu_));
1707
  threads_to_join_.push_back(t);
1708
  PthreadCall("unlock", pthread_mutex_unlock(&mu_));
J
jorlow@chromium.org 已提交
1709 1710
}

L
Lei Jin 已提交
1711 1712 1713 1714 1715 1716 1717
void PosixEnv::WaitForJoin() {
  for (const auto tid : threads_to_join_) {
    pthread_join(tid, nullptr);
  }
  threads_to_join_.clear();
}

H
Hans Wennborg 已提交
1718
}  // namespace
J
jorlow@chromium.org 已提交
1719

M
Mayank Agarwal 已提交
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
std::string Env::GenerateUniqueId() {
  std::string uuid_file = "/proc/sys/kernel/random/uuid";
  if (FileExists(uuid_file)) {
    std::string uuid;
    Status s = ReadFileToString(this, uuid_file, &uuid);
    if (s.ok()) {
      return uuid;
    }
  }
  // Could not read uuid_file - generate uuid using "nanos-random"
  Random64 r(time(nullptr));
  uint64_t random_uuid_portion =
    r.Uniform(std::numeric_limits<uint64_t>::max());
  uint64_t nanos_uuid_portion = NowNanos();
  char uuid2[200];
K
kailiu 已提交
1735 1736 1737 1738 1739
  snprintf(uuid2,
           200,
           "%lx-%lx",
           (unsigned long)nanos_uuid_portion,
           (unsigned long)random_uuid_portion);
M
Mayank Agarwal 已提交
1740 1741 1742
  return uuid2;
}

J
jorlow@chromium.org 已提交
1743
Env* Env::Default() {
1744
  static PosixEnv default_env;
1745
  return &default_env;
J
jorlow@chromium.org 已提交
1746 1747
}

1748
}  // namespace rocksdb