env_posix.cc 48.4 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>
24
#include <sys/syscall.h>
K
kailiu 已提交
25
#endif
J
jorlow@chromium.org 已提交
26 27 28 29
#include <sys/time.h>
#include <sys/types.h>
#include <time.h>
#include <unistd.h>
30 31
#if defined(OS_LINUX)
#include <linux/fs.h>
J
jorlow@chromium.org 已提交
32
#endif
L
Lei Jin 已提交
33 34
#include <signal.h>
#include <algorithm>
35 36
#include "rocksdb/env.h"
#include "rocksdb/slice.h"
J
jorlow@chromium.org 已提交
37
#include "port/port.h"
38
#include "util/coding.h"
J
jorlow@chromium.org 已提交
39
#include "util/logging.h"
40
#include "util/posix_logger.h"
41
#include "util/random.h"
42
#include "util/iostats_context_imp.h"
A
agiardullo 已提交
43
#include "util/string_util.h"
44
#include "util/sync_point.h"
45 46
#include "util/thread_status_updater.h"
#include "util/thread_status_util.h"
J
jorlow@chromium.org 已提交
47

I
Islam AbdelRahman 已提交
48 49 50
// Get nano time includes
#if defined(OS_LINUX) || defined(OS_FREEBSD)
#elif defined(__MACH__)
K
kailiu 已提交
51 52
#include <mach/clock.h>
#include <mach/mach.h>
I
Islam AbdelRahman 已提交
53 54
#else
#include <chrono>
K
kailiu 已提交
55 56
#endif

A
Abhishek Kona 已提交
57 58 59 60 61 62 63 64 65 66
#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 已提交
67 68
// For non linux platform, the following macros are used only as place
// holder.
S
sdong 已提交
69
#if !(defined OS_LINUX) && !(defined CYGWIN)
K
kailiu 已提交
70 71 72 73 74 75 76
#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

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
ThreadStatusUpdater* CreateThreadStatusUpdater() {
  return new ThreadStatusUpdater();
}

96 97 98 99
// list of pathnames that are locked
static std::set<std::string> lockedFiles;
static port::Mutex mutex_lockedFiles;

100 101 102 103
static Status IOError(const std::string& context, int err_number) {
  return Status::IOError(context, strerror(err_number));
}

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
#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 已提交
134 135 136 137
class PosixSequentialFile: public SequentialFile {
 private:
  std::string filename_;
  FILE* file_;
138
  int fd_;
139
  bool use_os_buffer_;
J
jorlow@chromium.org 已提交
140 141

 public:
142 143
  PosixSequentialFile(const std::string& fname, FILE* f,
      const EnvOptions& options)
144
      : filename_(fname), file_(f), fd_(fileno(f)),
H
Haobo Xu 已提交
145
        use_os_buffer_(options.use_os_buffer) {
146
  }
J
jorlow@chromium.org 已提交
147 148
  virtual ~PosixSequentialFile() { fclose(file_); }

I
Igor Sugak 已提交
149
  virtual Status Read(size_t n, Slice* result, char* scratch) override {
J
jorlow@chromium.org 已提交
150
    Status s;
151
    size_t r = 0;
I
Igor Canadi 已提交
152 153
    do {
      r = fread_unlocked(scratch, 1, n, file_);
154
    } while (r == 0 && ferror(file_) && errno == EINTR);
J
jorlow@chromium.org 已提交
155 156 157 158
    *result = Slice(scratch, r);
    if (r < n) {
      if (feof(file_)) {
        // We leave status as ok if we hit the end of the file
159 160 161
        // 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 已提交
162 163
      } else {
        // A partial read with an error: return a non-ok status
164
        s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
165 166
      }
    }
167
    if (!use_os_buffer_) {
168 169
      // we need to fadvise away the entire range of pages because
      // we do not want readahead pages to be cached.
K
kailiu 已提交
170
      Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED); // free OS pages
171
    }
J
jorlow@chromium.org 已提交
172 173
    return s;
  }
174

I
Igor Sugak 已提交
175
  virtual Status Skip(uint64_t n) override {
176
    if (fseek(file_, static_cast<long int>(n), SEEK_CUR)) {
177
      return IOError(filename_, errno);
178 179 180
    }
    return Status::OK();
  }
181

I
Igor Sugak 已提交
182
  virtual Status InvalidateCache(size_t offset, size_t length) override {
K
kailiu 已提交
183 184 185
#ifndef OS_LINUX
    return Status::OK();
#else
186
    // free OS pages
K
kailiu 已提交
187
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
188 189 190 191
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
192
#endif
193
  }
J
jorlow@chromium.org 已提交
194 195
};

196
// pread() based random-access
J
jorlow@chromium.org 已提交
197 198 199 200
class PosixRandomAccessFile: public RandomAccessFile {
 private:
  std::string filename_;
  int fd_;
201
  bool use_os_buffer_;
J
jorlow@chromium.org 已提交
202 203

 public:
204 205
  PosixRandomAccessFile(const std::string& fname, int fd,
                        const EnvOptions& options)
H
Haobo Xu 已提交
206
      : filename_(fname), fd_(fd), use_os_buffer_(options.use_os_buffer) {
207
    assert(!options.use_mmap_reads || sizeof(void*) < 8);
208
  }
J
jorlow@chromium.org 已提交
209 210 211
  virtual ~PosixRandomAccessFile() { close(fd_); }

  virtual Status Read(uint64_t offset, size_t n, Slice* result,
I
Igor Sugak 已提交
212
                      char* scratch) const override {
J
jorlow@chromium.org 已提交
213
    Status s;
I
Igor Canadi 已提交
214
    ssize_t r = -1;
215 216 217
    size_t left = n;
    char* ptr = scratch;
    while (left > 0) {
218
      r = pread(fd_, ptr, left, static_cast<off_t>(offset));
K
krad 已提交
219

220 221 222 223 224 225 226 227 228 229 230 231
      if (r <= 0) {
        if (errno == EINTR) {
          continue;
        }
        break;
      }
      ptr += r;
      offset += r;
      left -= r;
    }

    *result = Slice(scratch, (r < 0) ? 0 : n - left);
J
jorlow@chromium.org 已提交
232 233
    if (r < 0) {
      // An error: return a non-ok status
234
      s = IOError(filename_, errno);
J
jorlow@chromium.org 已提交
235
    }
236
    if (!use_os_buffer_) {
237 238
      // we need to fadvise away the entire range of pages because
      // we do not want readahead pages to be cached.
K
kailiu 已提交
239
      Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED); // free OS pages
240
    }
J
jorlow@chromium.org 已提交
241 242
    return s;
  }
243

K
kailiu 已提交
244
#ifdef OS_LINUX
I
Igor Sugak 已提交
245
  virtual size_t GetUniqueId(char* id, size_t max_size) const override {
246
    return GetUniqueIdFromFile(fd_, id, max_size);
247 248
  }
#endif
249

I
Igor Sugak 已提交
250
  virtual void Hint(AccessPattern pattern) override {
251 252
    switch(pattern) {
      case NORMAL:
K
kailiu 已提交
253
        Fadvise(fd_, 0, 0, POSIX_FADV_NORMAL);
254 255
        break;
      case RANDOM:
K
kailiu 已提交
256
        Fadvise(fd_, 0, 0, POSIX_FADV_RANDOM);
257 258
        break;
      case SEQUENTIAL:
K
kailiu 已提交
259
        Fadvise(fd_, 0, 0, POSIX_FADV_SEQUENTIAL);
260 261
        break;
      case WILLNEED:
K
kailiu 已提交
262
        Fadvise(fd_, 0, 0, POSIX_FADV_WILLNEED);
263 264
        break;
      case DONTNEED:
K
kailiu 已提交
265
        Fadvise(fd_, 0, 0, POSIX_FADV_DONTNEED);
266 267 268 269 270 271 272
        break;
      default:
        assert(false);
        break;
    }
  }

I
Igor Sugak 已提交
273
  virtual Status InvalidateCache(size_t offset, size_t length) override {
K
kailiu 已提交
274 275 276
#ifndef OS_LINUX
    return Status::OK();
#else
277
    // free OS pages
K
kailiu 已提交
278
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
279 280 281 282
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
283
#endif
284
  }
J
jorlow@chromium.org 已提交
285 286
};

287 288 289
// mmap() based random-access
class PosixMmapReadableFile: public RandomAccessFile {
 private:
290
  int fd_;
291 292 293 294 295 296
  std::string filename_;
  void* mmapped_region_;
  size_t length_;

 public:
  // base[0,length-1] contains the mmapped contents of the file.
297 298
  PosixMmapReadableFile(const int fd, const std::string& fname,
                        void* base, size_t length,
299
                        const EnvOptions& options)
300
      : fd_(fd), filename_(fname), mmapped_region_(base), length_(length) {
K
kailiu 已提交
301
    fd_ = fd_ + 0;  // suppress the warning for used variables
H
Haobo Xu 已提交
302 303
    assert(options.use_mmap_reads);
    assert(options.use_os_buffer);
304
  }
S
Siying Dong 已提交
305
  virtual ~PosixMmapReadableFile() {
306 307
    int ret = munmap(mmapped_region_, length_);
    if (ret != 0) {
308
      fprintf(stdout, "failed to munmap %p length %" ROCKSDB_PRIszt " \n",
309 310
              mmapped_region_, length_);
    }
S
Siying Dong 已提交
311
  }
312 313

  virtual Status Read(uint64_t offset, size_t n, Slice* result,
I
Igor Sugak 已提交
314
                      char* scratch) const override {
315
    Status s;
316
    if (offset > length_) {
317
      *result = Slice();
318 319 320
      return IOError(filename_, EINVAL);
    } else if (offset + n > length_) {
      n = length_ - offset;
321
    }
322
    *result = Slice(reinterpret_cast<char*>(mmapped_region_) + offset, n);
323 324
    return s;
  }
I
Igor Sugak 已提交
325
  virtual Status InvalidateCache(size_t offset, size_t length) override {
K
kailiu 已提交
326 327 328
#ifndef OS_LINUX
    return Status::OK();
#else
329
    // free OS pages
K
kailiu 已提交
330
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
331 332 333 334
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
335
#endif
336
  }
337 338
};

J
jorlow@chromium.org 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
// 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
I
Igor Canadi 已提交
354
#ifdef ROCKSDB_FALLOCATE_PRESENT
355
  bool allow_fallocate_;  // If false, fallocate calls are bypassed
I
Igor Canadi 已提交
356
  bool fallocate_with_keep_size_;
I
Igor Canadi 已提交
357
#endif
J
jorlow@chromium.org 已提交
358 359 360 361 362 363 364 365 366 367 368 369

  // 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;
  }

370
  Status UnmapCurrentRegion() {
371
    TEST_KILL_RANDOM(rocksdb_kill_odds);
A
Abhishek Kona 已提交
372
    if (base_ != nullptr) {
373 374 375
      int munmap_status = munmap(base_, limit_ - base_);
      if (munmap_status != 0) {
        return IOError(filename_, munmap_status);
376
      }
J
jorlow@chromium.org 已提交
377
      file_offset_ += limit_ - base_;
A
Abhishek Kona 已提交
378 379 380 381
      base_ = nullptr;
      limit_ = nullptr;
      last_sync_ = nullptr;
      dst_ = nullptr;
J
jorlow@chromium.org 已提交
382 383 384 385 386 387

      // Increase the amount we map the next time, but capped at 1MB
      if (map_size_ < (1<<20)) {
        map_size_ *= 2;
      }
    }
388
    return Status::OK();
J
jorlow@chromium.org 已提交
389 390
  }

A
Abhishek Kona 已提交
391
  Status MapNewRegion() {
392
#ifdef ROCKSDB_FALLOCATE_PRESENT
A
Abhishek Kona 已提交
393
    assert(base_ == nullptr);
A
Abhishek Kona 已提交
394

395
    TEST_KILL_RANDOM(rocksdb_kill_odds);
I
Igor Canadi 已提交
396
    // we can't fallocate with FALLOC_FL_KEEP_SIZE here
397
    if (allow_fallocate_) {
398 399 400 401 402 403 404 405 406 407
      IOSTATS_TIMER_GUARD(allocate_nanos);
      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_);
      }
      if (alloc_status != 0) {
        return Status::IOError("Error allocating space to file : " + filename_ +
          "Error : " + strerror(alloc_status));
      }
J
jorlow@chromium.org 已提交
408
    }
A
Abhishek Kona 已提交
409

410
    TEST_KILL_RANDOM(rocksdb_kill_odds);
A
Abhishek Kona 已提交
411
    void* ptr = mmap(nullptr, map_size_, PROT_READ | PROT_WRITE, MAP_SHARED,
J
jorlow@chromium.org 已提交
412 413
                     fd_, file_offset_);
    if (ptr == MAP_FAILED) {
A
Abhishek Kona 已提交
414
      return Status::IOError("MMap failed on " + filename_);
J
jorlow@chromium.org 已提交
415
    }
416
    TEST_KILL_RANDOM(rocksdb_kill_odds);
417

J
jorlow@chromium.org 已提交
418 419 420 421
    base_ = reinterpret_cast<char*>(ptr);
    limit_ = base_ + map_size_;
    dst_ = base_;
    last_sync_ = base_;
A
Abhishek Kona 已提交
422
    return Status::OK();
K
kailiu 已提交
423 424 425
#else
    return Status::NotSupported("This platform doesn't support fallocate()");
#endif
J
jorlow@chromium.org 已提交
426 427
  }

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  Status Msync() {
    if (dst_ == last_sync_) {
      return Status::OK();
    }
    // 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_;
    TEST_KILL_RANDOM(rocksdb_kill_odds);
    if (msync(base_ + p1, p2 - p1 + page_size_, MS_SYNC) < 0) {
      return IOError(filename_, errno);
    }
    return Status::OK();
  }

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


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

I
Igor Sugak 已提交
471
  virtual Status Append(const Slice& data) override {
J
jorlow@chromium.org 已提交
472 473 474 475 476 477 478
    const char* src = data.data();
    size_t left = data.size();
    while (left > 0) {
      assert(base_ <= dst_);
      assert(dst_ <= limit_);
      size_t avail = limit_ - dst_;
      if (avail == 0) {
479 480 481 482 483 484 485
        Status s = UnmapCurrentRegion();
        if (!s.ok()) {
          return s;
        }
        s = MapNewRegion();
        if (!s.ok()) {
          return s;
486
        }
487
        TEST_KILL_RANDOM(rocksdb_kill_odds);
J
jorlow@chromium.org 已提交
488 489 490 491 492 493 494 495 496 497 498
      }

      size_t n = (left <= avail) ? left : avail;
      memcpy(dst_, src, n);
      dst_ += n;
      src += n;
      left -= n;
    }
    return Status::OK();
  }

499 500 501 502 503 504
  // Means Close() will properly take care of truncate
  // and it does not need any additional information
  virtual Status Truncate(uint64_t size) override {
    return Status::OK();
  }

I
Igor Sugak 已提交
505
  virtual Status Close() override {
J
jorlow@chromium.org 已提交
506 507
    Status s;
    size_t unused = limit_ - dst_;
508

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

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

    fd_ = -1;
A
Abhishek Kona 已提交
526 527
    base_ = nullptr;
    limit_ = nullptr;
J
jorlow@chromium.org 已提交
528 529 530
    return s;
  }

I
Igor Sugak 已提交
531
  virtual Status Flush() override {
J
jorlow@chromium.org 已提交
532 533 534
    return Status::OK();
  }

I
Igor Sugak 已提交
535
  virtual Status Sync() override {
536 537
    if (fdatasync(fd_) < 0) {
      return IOError(filename_, errno);
J
jorlow@chromium.org 已提交
538 539
    }

540
    return Msync();
J
jorlow@chromium.org 已提交
541
  }
542 543 544 545

  /**
   * Flush data as well as metadata to stable storage.
   */
I
Igor Sugak 已提交
546
  virtual Status Fsync() override {
547 548 549 550 551
    if (fsync(fd_) < 0) {
      return IOError(filename_, errno);
    }

    return Msync();
552
  }
553 554 555 556 557 558

  /**
   * 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.
   */
I
Igor Sugak 已提交
559
  virtual uint64_t GetFileSize() override {
560 561 562
    size_t used = dst_ - base_;
    return file_offset_ + used;
  }
563

I
Igor Sugak 已提交
564
  virtual Status InvalidateCache(size_t offset, size_t length) override {
K
kailiu 已提交
565 566 567
#ifndef OS_LINUX
    return Status::OK();
#else
568
    // free OS pages
K
kailiu 已提交
569
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
570 571 572 573
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
574
#endif
575 576
  }

577
#ifdef ROCKSDB_FALLOCATE_PRESENT
I
Igor Sugak 已提交
578
  virtual Status Allocate(off_t offset, off_t len) override {
579
    TEST_KILL_RANDOM(rocksdb_kill_odds);
580 581 582 583 584 585
    int alloc_status = 0;
    if (allow_fallocate_) {
      alloc_status =
          fallocate(fd_, fallocate_with_keep_size_ ? FALLOC_FL_KEEP_SIZE : 0,
                    offset, len);
    }
I
Igor Canadi 已提交
586
    if (alloc_status == 0) {
587 588 589 590 591
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
592
#endif
J
jorlow@chromium.org 已提交
593 594
};

595 596 597 598 599 600
// Use posix write to write data to a file.
class PosixWritableFile : public WritableFile {
 private:
  const std::string filename_;
  int fd_;
  uint64_t filesize_;
I
Igor Canadi 已提交
601
#ifdef ROCKSDB_FALLOCATE_PRESENT
602
  bool allow_fallocate_;
I
Igor Canadi 已提交
603
  bool fallocate_with_keep_size_;
I
Igor Canadi 已提交
604
#endif
605 606

 public:
607
  PosixWritableFile(const std::string& fname, int fd, const EnvOptions& options)
608
      : filename_(fname), fd_(fd), filesize_(0) {
I
Igor Canadi 已提交
609
#ifdef ROCKSDB_FALLOCATE_PRESENT
610
    allow_fallocate_ = options.allow_fallocate;
I
Igor Canadi 已提交
611 612
    fallocate_with_keep_size_ = options.fallocate_with_keep_size;
#endif
H
Haobo Xu 已提交
613
    assert(!options.use_mmap_writes);
614 615 616 617 618 619 620 621
  }

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

I
Igor Sugak 已提交
622
  virtual Status Append(const Slice& data) override {
623
    const char* src = data.data();
624
    size_t left = data.size();
625 626 627 628 629
    while (left != 0) {
      ssize_t done = write(fd_, src, left);
      if (done < 0) {
        if (errno == EINTR) {
          continue;
630
        }
631
        return IOError(filename_, errno);
632
      }
633 634 635 636
      left -= done;
      src += done;
    }
    filesize_ += data.size();
637 638 639
    return Status::OK();
  }

640 641 642 643 644 645
  // Means Close() will properly take care of truncate
  // and it does not need any additional information
  virtual Status Truncate(uint64_t size) override {
    return Status::OK();
  }

I
Igor Sugak 已提交
646
  virtual Status Close() override {
647
    Status s;
648

649 650 651 652 653
    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
654 655
      // NOTE(ljin): we probably don't want to surface failure as an IOError,
      // but it will be nice to log these errors.
656 657
      int dummy __attribute__((unused));
      dummy = ftruncate(fd_, filesize_);
658 659 660 661 662 663 664 665 666 667 668 669
#ifdef ROCKSDB_FALLOCATE_PRESENT
      // in some file systems, ftruncate only trims trailing space if the
      // new file size is smaller than the current size. Calling fallocate
      // with FALLOC_FL_PUNCH_HOLE flag to explicitly release these unused
      // blocks. FALLOC_FL_PUNCH_HOLE is supported on at least the following
      // filesystems:
      //   XFS (since Linux 2.6.38)
      //   ext4 (since Linux 3.0)
      //   Btrfs (since Linux 3.7)
      //   tmpfs (since Linux 3.5)
      // We ignore error since failure of this operation does not affect
      // correctness.
670
      IOSTATS_TIMER_GUARD(allocate_nanos);
671 672 673 674
      if (allow_fallocate_) {
        fallocate(fd_, FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE, filesize_,
                  block_size * last_allocated_block - filesize_);
      }
675
#endif
676 677
    }

678
    if (close(fd_) < 0) {
679
      s = IOError(filename_, errno);
680 681 682 683 684 685
    }
    fd_ = -1;
    return s;
  }

  // write out the cached data to the OS cache
I
Igor Sugak 已提交
686
  virtual Status Flush() override {
687 688 689
    return Status::OK();
  }

I
Igor Sugak 已提交
690
  virtual Status Sync() override {
691
    if (fdatasync(fd_) < 0) {
692 693 694 695 696
      return IOError(filename_, errno);
    }
    return Status::OK();
  }

I
Igor Sugak 已提交
697
  virtual Status Fsync() override {
698
    if (fsync(fd_) < 0) {
699 700 701 702 703
      return IOError(filename_, errno);
    }
    return Status::OK();
  }

704 705 706 707
  virtual bool IsSyncThreadSafe() const override {
    return true;
  }

I
Igor Sugak 已提交
708
  virtual uint64_t GetFileSize() override { return filesize_; }
709

I
Igor Sugak 已提交
710
  virtual Status InvalidateCache(size_t offset, size_t length) override {
K
kailiu 已提交
711 712 713
#ifndef OS_LINUX
    return Status::OK();
#else
714
    // free OS pages
K
kailiu 已提交
715
    int ret = Fadvise(fd_, offset, length, POSIX_FADV_DONTNEED);
716 717 718 719
    if (ret == 0) {
      return Status::OK();
    }
    return IOError(filename_, errno);
K
kailiu 已提交
720
#endif
721 722
  }

723
#ifdef ROCKSDB_FALLOCATE_PRESENT
I
Igor Sugak 已提交
724
  virtual Status Allocate(off_t offset, off_t len) override {
725
    TEST_KILL_RANDOM(rocksdb_kill_odds);
726
    IOSTATS_TIMER_GUARD(allocate_nanos);
727 728 729 730 731 732
    int alloc_status = 0;
    if (allow_fallocate_) {
      alloc_status =
          fallocate(fd_, fallocate_with_keep_size_ ? FALLOC_FL_KEEP_SIZE : 0,
                    offset, len);
    }
I
Igor Canadi 已提交
733
    if (alloc_status == 0) {
734 735 736 737 738
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
739

I
Igor Sugak 已提交
740
  virtual Status RangeSync(off_t offset, off_t nbytes) override {
741 742 743 744 745 746
    if (sync_file_range(fd_, offset, nbytes, SYNC_FILE_RANGE_WRITE) == 0) {
      return Status::OK();
    } else {
      return IOError(filename_, errno);
    }
  }
I
Igor Sugak 已提交
747
  virtual size_t GetUniqueId(char* id, size_t max_size) const override {
748 749
    return GetUniqueIdFromFile(fd_, id, max_size);
  }
750
#endif
751 752
};

753 754 755 756 757 758 759
class PosixDirectory : public Directory {
 public:
  explicit PosixDirectory(int fd) : fd_(fd) {}
  ~PosixDirectory() {
    close(fd_);
  }

I
Igor Sugak 已提交
760
  virtual Status Fsync() override {
761 762 763 764 765 766 767 768 769 770
    if (fsync(fd_) == -1) {
      return IOError("directory", errno);
    }
    return Status::OK();
  }

 private:
  int fd_;
};

771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
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 已提交
793 794 795 796 797 798 799
  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
800 801 802 803 804 805 806
  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 已提交
807 808 809 810 811
}

class PosixFileLock : public FileLock {
 public:
  int fd_;
812
  std::string filename;
J
jorlow@chromium.org 已提交
813 814
};

815 816 817
void PthreadCall(const char* label, int result) {
  if (result != 0) {
    fprintf(stderr, "pthread %s: %s\n", label, strerror(result));
818
    abort();
819 820 821
  }
}

J
jorlow@chromium.org 已提交
822 823 824
class PosixEnv : public Env {
 public:
  PosixEnv();
825

826
  virtual ~PosixEnv() {
827 828 829
    for (const auto tid : threads_to_join_) {
      pthread_join(tid, nullptr);
    }
830 831 832 833 834 835
    for (int pool_id = 0; pool_id < Env::Priority::TOTAL; ++pool_id) {
      thread_pools_[pool_id].JoinAllThreads();
    }
    // All threads must be joined before the deletion of
    // thread_status_updater_.
    delete thread_status_updater_;
J
jorlow@chromium.org 已提交
836 837
  }

838
  void SetFD_CLOEXEC(int fd, const EnvOptions* options) {
H
Haobo Xu 已提交
839
    if ((options == nullptr || options->set_fd_cloexec) && fd > 0) {
840 841 842 843
      fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
    }
  }

J
jorlow@chromium.org 已提交
844
  virtual Status NewSequentialFile(const std::string& fname,
845
                                   unique_ptr<SequentialFile>* result,
I
Igor Sugak 已提交
846
                                   const EnvOptions& options) override {
847
    result->reset();
I
Igor Canadi 已提交
848 849
    FILE* f = nullptr;
    do {
850
      IOSTATS_TIMER_GUARD(open_nanos);
I
Igor Canadi 已提交
851 852
      f = fopen(fname.c_str(), "r");
    } while (f == nullptr && errno == EINTR);
A
Abhishek Kona 已提交
853 854
    if (f == nullptr) {
      *result = nullptr;
855
      return IOError(fname, errno);
J
jorlow@chromium.org 已提交
856
    } else {
857 858
      int fd = fileno(f);
      SetFD_CLOEXEC(fd, &options);
859
      result->reset(new PosixSequentialFile(fname, f, options));
J
jorlow@chromium.org 已提交
860 861 862 863 864
      return Status::OK();
    }
  }

  virtual Status NewRandomAccessFile(const std::string& fname,
865
                                     unique_ptr<RandomAccessFile>* result,
I
Igor Sugak 已提交
866
                                     const EnvOptions& options) override {
867
    result->reset();
868
    Status s;
869 870 871 872 873
    int fd;
    {
      IOSTATS_TIMER_GUARD(open_nanos);
      fd = open(fname.c_str(), O_RDONLY);
    }
874
    SetFD_CLOEXEC(fd, &options);
J
jorlow@chromium.org 已提交
875
    if (fd < 0) {
876
      s = IOError(fname, errno);
H
Haobo Xu 已提交
877
    } else if (options.use_mmap_reads && sizeof(void*) >= 8) {
878 879 880 881 882 883
      // 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 已提交
884
        void* base = mmap(nullptr, size, PROT_READ, MAP_SHARED, fd, 0);
885
        if (base != MAP_FAILED) {
886 887
          result->reset(new PosixMmapReadableFile(fd, fname, base,
                                                  size, options));
888 889 890 891 892
        } else {
          s = IOError(fname, errno);
        }
      }
      close(fd);
893
    } else {
894
      result->reset(new PosixRandomAccessFile(fname, fd, options));
J
jorlow@chromium.org 已提交
895
    }
896
    return s;
J
jorlow@chromium.org 已提交
897 898 899
  }

  virtual Status NewWritableFile(const std::string& fname,
900
                                 unique_ptr<WritableFile>* result,
I
Igor Sugak 已提交
901
                                 const EnvOptions& options) override {
902
    result->reset();
J
jorlow@chromium.org 已提交
903
    Status s;
I
Igor Canadi 已提交
904 905
    int fd = -1;
    do {
906
      IOSTATS_TIMER_GUARD(open_nanos);
I
Igor Canadi 已提交
907 908
      fd = open(fname.c_str(), O_CREAT | O_RDWR | O_TRUNC, 0644);
    } while (fd < 0 && errno == EINTR);
J
jorlow@chromium.org 已提交
909
    if (fd < 0) {
910
      s = IOError(fname, errno);
J
jorlow@chromium.org 已提交
911
    } else {
912
      SetFD_CLOEXEC(fd, &options);
H
Haobo Xu 已提交
913
      if (options.use_mmap_writes) {
914 915
        if (!checkedDiskForMmap_) {
          // this will be executed once in the program's lifetime.
A
Abhishek Kona 已提交
916
          // do not use mmapWrite on non ext-3/xfs/tmpfs systems.
917 918 919 920
          if (!SupportsFastAllocate(fname)) {
            forceMmapOff = true;
          }
          checkedDiskForMmap_ = true;
A
Abhishek Kona 已提交
921 922
        }
      }
H
Haobo Xu 已提交
923
      if (options.use_mmap_writes && !forceMmapOff) {
924
        result->reset(new PosixMmapFile(fname, fd, page_size_, options));
925
      } else {
K
kailiu 已提交
926 927 928 929
        // disable mmap writes
        EnvOptions no_mmap_writes_options = options;
        no_mmap_writes_options.use_mmap_writes = false;

930
        result->reset(new PosixWritableFile(fname, fd, no_mmap_writes_options));
931
      }
J
jorlow@chromium.org 已提交
932 933 934 935
    }
    return s;
  }

936
  virtual Status NewDirectory(const std::string& name,
I
Igor Sugak 已提交
937
                              unique_ptr<Directory>* result) override {
938
    result->reset();
939 940 941 942 943
    int fd;
    {
      IOSTATS_TIMER_GUARD(open_nanos);
      fd = open(name.c_str(), 0);
    }
944 945 946 947 948 949 950 951
    if (fd < 0) {
      return IOError(name, errno);
    } else {
      result->reset(new PosixDirectory(fd));
    }
    return Status::OK();
  }

A
agiardullo 已提交
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
  virtual Status FileExists(const std::string& fname) override {
    int result = access(fname.c_str(), F_OK);

    if (result == 0) {
      return Status::OK();
    }

    switch (errno) {
      case EACCES:
      case ELOOP:
      case ENAMETOOLONG:
      case ENOENT:
      case ENOTDIR:
        return Status::NotFound();
      default:
        assert(result == EIO || result == ENOMEM);
        return Status::IOError("Unexpected error(" + ToString(result) +
                               ") accessing file `" + fname + "' ");
    }
J
jorlow@chromium.org 已提交
971 972 973
  }

  virtual Status GetChildren(const std::string& dir,
I
Igor Sugak 已提交
974
                             std::vector<std::string>* result) override {
J
jorlow@chromium.org 已提交
975 976
    result->clear();
    DIR* d = opendir(dir.c_str());
A
Abhishek Kona 已提交
977
    if (d == nullptr) {
978
      return IOError(dir, errno);
J
jorlow@chromium.org 已提交
979 980
    }
    struct dirent* entry;
A
Abhishek Kona 已提交
981
    while ((entry = readdir(d)) != nullptr) {
J
jorlow@chromium.org 已提交
982 983 984 985 986 987
      result->push_back(entry->d_name);
    }
    closedir(d);
    return Status::OK();
  }

I
Igor Sugak 已提交
988
  virtual Status DeleteFile(const std::string& fname) override {
J
jorlow@chromium.org 已提交
989 990
    Status result;
    if (unlink(fname.c_str()) != 0) {
991
      result = IOError(fname, errno);
J
jorlow@chromium.org 已提交
992 993 994 995
    }
    return result;
  };

I
Igor Sugak 已提交
996
  virtual Status CreateDir(const std::string& name) override {
J
jorlow@chromium.org 已提交
997 998
    Status result;
    if (mkdir(name.c_str(), 0755) != 0) {
999
      result = IOError(name, errno);
J
jorlow@chromium.org 已提交
1000 1001 1002 1003
    }
    return result;
  };

I
Igor Sugak 已提交
1004
  virtual Status CreateDirIfMissing(const std::string& name) override {
1005 1006 1007 1008
    Status result;
    if (mkdir(name.c_str(), 0755) != 0) {
      if (errno != EEXIST) {
        result = IOError(name, errno);
1009 1010 1011 1012
      } 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");
1013 1014 1015 1016 1017
      }
    }
    return result;
  };

I
Igor Sugak 已提交
1018
  virtual Status DeleteDir(const std::string& name) override {
J
jorlow@chromium.org 已提交
1019 1020
    Status result;
    if (rmdir(name.c_str()) != 0) {
1021
      result = IOError(name, errno);
J
jorlow@chromium.org 已提交
1022 1023 1024 1025
    }
    return result;
  };

I
Igor Sugak 已提交
1026 1027
  virtual Status GetFileSize(const std::string& fname,
                             uint64_t* size) override {
J
jorlow@chromium.org 已提交
1028 1029 1030 1031
    Status s;
    struct stat sbuf;
    if (stat(fname.c_str(), &sbuf) != 0) {
      *size = 0;
1032
      s = IOError(fname, errno);
J
jorlow@chromium.org 已提交
1033 1034 1035 1036 1037 1038
    } else {
      *size = sbuf.st_size;
    }
    return s;
  }

1039
  virtual Status GetFileModificationTime(const std::string& fname,
I
Igor Sugak 已提交
1040
                                         uint64_t* file_mtime) override {
1041 1042 1043 1044 1045 1046 1047
    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();
  }
I
Igor Sugak 已提交
1048 1049
  virtual Status RenameFile(const std::string& src,
                            const std::string& target) override {
J
jorlow@chromium.org 已提交
1050 1051
    Status result;
    if (rename(src.c_str(), target.c_str()) != 0) {
1052
      result = IOError(src, errno);
J
jorlow@chromium.org 已提交
1053 1054 1055 1056
    }
    return result;
  }

I
Igor Sugak 已提交
1057 1058
  virtual Status LinkFile(const std::string& src,
                          const std::string& target) override {
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
    Status result;
    if (link(src.c_str(), target.c_str()) != 0) {
      if (errno == EXDEV) {
        return Status::NotSupported("No cross FS links allowed");
      }
      result = IOError(src, errno);
    }
    return result;
  }

I
Igor Sugak 已提交
1069
  virtual Status LockFile(const std::string& fname, FileLock** lock) override {
A
Abhishek Kona 已提交
1070
    *lock = nullptr;
J
jorlow@chromium.org 已提交
1071
    Status result;
1072 1073 1074 1075 1076
    int fd;
    {
      IOSTATS_TIMER_GUARD(open_nanos);
      fd = open(fname.c_str(), O_RDWR | O_CREAT, 0644);
    }
J
jorlow@chromium.org 已提交
1077
    if (fd < 0) {
1078
      result = IOError(fname, errno);
1079
    } else if (LockOrUnlock(fname, fd, true) == -1) {
1080
      result = IOError("lock " + fname, errno);
J
jorlow@chromium.org 已提交
1081 1082
      close(fd);
    } else {
1083
      SetFD_CLOEXEC(fd, nullptr);
J
jorlow@chromium.org 已提交
1084 1085
      PosixFileLock* my_lock = new PosixFileLock;
      my_lock->fd_ = fd;
1086
      my_lock->filename = fname;
J
jorlow@chromium.org 已提交
1087 1088 1089 1090 1091
      *lock = my_lock;
    }
    return result;
  }

I
Igor Sugak 已提交
1092
  virtual Status UnlockFile(FileLock* lock) override {
J
jorlow@chromium.org 已提交
1093 1094
    PosixFileLock* my_lock = reinterpret_cast<PosixFileLock*>(lock);
    Status result;
1095
    if (LockOrUnlock(my_lock->filename, my_lock->fd_, false) == -1) {
1096
      result = IOError("unlock", errno);
J
jorlow@chromium.org 已提交
1097 1098 1099 1100 1101 1102
    }
    close(my_lock->fd_);
    delete my_lock;
    return result;
  }

1103 1104 1105 1106
  virtual void Schedule(void (*function)(void* arg1), void* arg,
                        Priority pri = LOW, void* tag = nullptr) override;

  virtual int UnSchedule(void* arg, Priority pri) override;
1107

I
Igor Sugak 已提交
1108
  virtual void StartThread(void (*function)(void* arg), void* arg) override;
J
jorlow@chromium.org 已提交
1109

I
Igor Sugak 已提交
1110
  virtual void WaitForJoin() override;
L
Lei Jin 已提交
1111

1112 1113
  virtual unsigned int GetThreadPoolQueueLen(Priority pri = LOW) const override;

I
Igor Sugak 已提交
1114
  virtual Status GetTestDirectory(std::string* result) override {
J
jorlow@chromium.org 已提交
1115 1116 1117 1118 1119
    const char* env = getenv("TEST_TMPDIR");
    if (env && env[0] != '\0') {
      *result = env;
    } else {
      char buf[100];
1120
      snprintf(buf, sizeof(buf), "/tmp/rocksdbtest-%d", int(geteuid()));
J
jorlow@chromium.org 已提交
1121 1122 1123 1124 1125 1126 1127
      *result = buf;
    }
    // Directory may already exist
    CreateDir(*result);
    return Status::OK();
  }

1128 1129 1130 1131 1132 1133
  virtual Status GetThreadList(
      std::vector<ThreadStatus>* thread_list) override {
    assert(thread_status_updater_);
    return thread_status_updater_->GetThreadList(thread_list);
  }

1134
  static uint64_t gettid(pthread_t tid) {
J
jorlow@chromium.org 已提交
1135
    uint64_t thread_id = 0;
J
jorlow@chromium.org 已提交
1136
    memcpy(&thread_id, &tid, std::min(sizeof(thread_id), sizeof(tid)));
1137 1138
    return thread_id;
  }
J
jorlow@chromium.org 已提交
1139

1140 1141 1142 1143 1144
  static uint64_t gettid() {
    pthread_t tid = pthread_self();
    return gettid(tid);
  }

I
Islam AbdelRahman 已提交
1145
  virtual uint64_t GetThreadID() const override {
1146 1147 1148
    return gettid(pthread_self());
  }

1149
  virtual Status NewLogger(const std::string& fname,
I
Igor Sugak 已提交
1150
                           shared_ptr<Logger>* result) override {
1151 1152 1153 1154 1155
    FILE* f;
    {
      IOSTATS_TIMER_GUARD(open_nanos);
      f = fopen(fname.c_str(), "w");
    }
A
Abhishek Kona 已提交
1156
    if (f == nullptr) {
1157
      result->reset();
1158 1159
      return IOError(fname, errno);
    } else {
1160
      int fd = fileno(f);
1161
#ifdef ROCKSDB_FALLOCATE_PRESENT
1162
      fallocate(fd, FALLOC_FL_KEEP_SIZE, 0, 4 * 1024);
1163
#endif
1164
      SetFD_CLOEXEC(fd, nullptr);
I
Igor Canadi 已提交
1165
      result->reset(new PosixLogger(f, &PosixEnv::gettid, this));
1166
      return Status::OK();
J
jorlow@chromium.org 已提交
1167 1168 1169
    }
  }

I
Igor Sugak 已提交
1170
  virtual uint64_t NowMicros() override {
I
Igor Canadi 已提交
1171 1172 1173
    struct timeval tv;
    gettimeofday(&tv, nullptr);
    return static_cast<uint64_t>(tv.tv_sec) * 1000000 + tv.tv_usec;
J
jorlow@chromium.org 已提交
1174 1175
  }

I
Igor Sugak 已提交
1176
  virtual uint64_t NowNanos() override {
I
Islam AbdelRahman 已提交
1177
#if defined(OS_LINUX) || defined(OS_FREEBSD)
I
Igor Canadi 已提交
1178 1179 1180
    struct timespec ts;
    clock_gettime(CLOCK_MONOTONIC, &ts);
    return static_cast<uint64_t>(ts.tv_sec) * 1000000000 + ts.tv_nsec;
1181
#elif defined(__MACH__)
I
Igor Canadi 已提交
1182 1183 1184 1185 1186 1187
    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);
    return static_cast<uint64_t>(ts.tv_sec) * 1000000000 + ts.tv_nsec;
I
Islam AbdelRahman 已提交
1188 1189 1190 1191
#else
    return std::chrono::duration_cast<std::chrono::nanoseconds>(
       std::chrono::steady_clock::now().time_since_epoch()).count();
#endif
1192 1193
  }

I
Igor Sugak 已提交
1194
  virtual void SleepForMicroseconds(int micros) override { usleep(micros); }
J
jorlow@chromium.org 已提交
1195

I
Igor Sugak 已提交
1196
  virtual Status GetHostName(char* name, uint64_t len) override {
1197
    int ret = gethostname(name, static_cast<size_t>(len));
1198 1199 1200 1201 1202 1203 1204 1205 1206
    if (ret < 0) {
      if (errno == EFAULT || errno == EINVAL)
        return Status::InvalidArgument(strerror(errno));
      else
        return IOError("GetHostName", errno);
    }
    return Status::OK();
  }

I
Igor Sugak 已提交
1207
  virtual Status GetCurrentTime(int64_t* unix_time) override {
A
Abhishek Kona 已提交
1208
    time_t ret = time(nullptr);
1209 1210 1211 1212 1213 1214 1215 1216
    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,
I
Igor Sugak 已提交
1217
                                 std::string* output_path) override {
1218 1219 1220 1221 1222 1223 1224
    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 已提交
1225
    if (ret == nullptr) {
1226 1227 1228 1229 1230 1231 1232
      return Status::IOError(strerror(errno));
    }

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

A
Abhishek Kona 已提交
1233
  // Allow increasing the number of worker threads.
I
Igor Sugak 已提交
1234
  virtual void SetBackgroundThreads(int num, Priority pri) override {
1235 1236
    assert(pri >= Priority::LOW && pri <= Priority::HIGH);
    thread_pools_[pri].SetBackgroundThreads(num);
1237 1238
  }

1239
  // Allow increasing the number of worker threads.
I
Igor Sugak 已提交
1240
  virtual void IncBackgroundThreadsIfNeeded(int num, Priority pri) override {
1241 1242 1243 1244
    assert(pri >= Priority::LOW && pri <= Priority::HIGH);
    thread_pools_[pri].IncBackgroundThreadsIfNeeded(num);
  }

1245 1246 1247 1248 1249 1250 1251
  virtual void LowerThreadPoolIOPriority(Priority pool = LOW) override {
    assert(pool >= Priority::LOW && pool <= Priority::HIGH);
#ifdef OS_LINUX
    thread_pools_[pool].LowerIOPriority();
#endif
  }

I
Igor Sugak 已提交
1252
  virtual std::string TimeToString(uint64_t secondsSince1970) override {
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
    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;
  }

1272 1273
  EnvOptions OptimizeForLogWrite(const EnvOptions& env_options,
                                 const DBOptions& db_options) const override {
I
Igor Canadi 已提交
1274 1275
    EnvOptions optimized = env_options;
    optimized.use_mmap_writes = false;
1276
    optimized.bytes_per_sync = db_options.wal_bytes_per_sync;
I
Igor Canadi 已提交
1277 1278 1279 1280
    // 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 已提交
1281 1282 1283
    return optimized;
  }

I
Igor Sugak 已提交
1284 1285
  EnvOptions OptimizeForManifestWrite(
      const EnvOptions& env_options) const override {
I
Igor Canadi 已提交
1286 1287 1288 1289 1290 1291
    EnvOptions optimized = env_options;
    optimized.use_mmap_writes = false;
    optimized.fallocate_with_keep_size = true;
    return optimized;
  }

J
jorlow@chromium.org 已提交
1292
 private:
1293 1294
  bool checkedDiskForMmap_;
  bool forceMmapOff; // do we override Env options?
A
Abhishek Kona 已提交
1295

J
jorlow@chromium.org 已提交
1296

1297 1298 1299 1300 1301 1302 1303 1304 1305
  // 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 已提交
1306
  bool SupportsFastAllocate(const std::string& path) {
J
James Golick 已提交
1307
#ifdef ROCKSDB_FALLOCATE_PRESENT
A
Abhishek Kona 已提交
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
    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 已提交
1322 1323 1324
#else
    return false;
#endif
A
Abhishek Kona 已提交
1325 1326
  }

J
jorlow@chromium.org 已提交
1327 1328 1329
  size_t page_size_;


1330 1331
  class ThreadPool {
   public:
1332 1333 1334 1335 1336
    ThreadPool()
        : total_threads_limit_(1),
          bgthreads_(0),
          queue_(),
          queue_len_(0),
1337
          exit_all_threads_(false),
1338 1339
          low_io_priority_(false),
          env_(nullptr) {
1340 1341 1342
      PthreadCall("mutex_init", pthread_mutex_init(&mu_, nullptr));
      PthreadCall("cvar_init", pthread_cond_init(&bgsignal_, nullptr));
    }
J
jorlow@chromium.org 已提交
1343

1344
    ~ThreadPool() {
1345 1346 1347 1348
      assert(bgthreads_.size() == 0U);
    }

    void JoinAllThreads() {
1349 1350 1351 1352 1353 1354 1355 1356
      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);
      }
1357 1358 1359 1360 1361
      bgthreads_.clear();
    }

    void SetHostEnv(Env* env) {
      env_ = env;
1362
    }
J
jorlow@chromium.org 已提交
1363

1364 1365 1366 1367 1368 1369 1370 1371
    void LowerIOPriority() {
#ifdef OS_LINUX
      PthreadCall("lock", pthread_mutex_lock(&mu_));
      low_io_priority_ = true;
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
#endif
    }

1372 1373 1374 1375 1376 1377 1378 1379 1380
    // 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) {
1381
      return HasExcessiveThread() && thread_id == bgthreads_.size() - 1;
1382 1383 1384 1385 1386 1387 1388
    }

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

Y
Yueh-Hsuan Chiang 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
    // Return the thread priority.
    // This would allow its member-thread to know its priority.
    Env::Priority GetThreadPriority() {
      return priority_;
    }

    // Set the thread priority.
    void SetThreadPriority(Env::Priority priority) {
      priority_ = priority;
    }

1400
    void BGThread(size_t thread_id) {
1401
      bool low_io_priority = false;
1402 1403 1404
      while (true) {
        // Wait until there is an item that is ready to run
        PthreadCall("lock", pthread_mutex_lock(&mu_));
1405 1406 1407
        // 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))) {
1408 1409 1410 1411 1412 1413
          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;
        }
1414 1415 1416 1417
        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.
1418 1419
          auto terminating_thread = bgthreads_.back();
          pthread_detach(terminating_thread);
1420 1421 1422 1423 1424 1425 1426 1427
          bgthreads_.pop_back();
          if (HasExcessiveThread()) {
            // There is still at least more excessive thread to terminate.
            WakeUpAllThreads();
          }
          PthreadCall("unlock", pthread_mutex_unlock(&mu_));
          break;
        }
1428 1429 1430
        void (*function)(void*) = queue_.front().function;
        void* arg = queue_.front().arg;
        queue_.pop_front();
1431 1432
        queue_len_.store(static_cast<unsigned int>(queue_.size()),
                         std::memory_order_relaxed);
H
Haobo Xu 已提交
1433

1434
        bool decrease_io_priority = (low_io_priority != low_io_priority_);
1435
        PthreadCall("unlock", pthread_mutex_unlock(&mu_));
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457

#ifdef OS_LINUX
        if (decrease_io_priority) {
          #define IOPRIO_CLASS_SHIFT               (13)
          #define IOPRIO_PRIO_VALUE(class, data)   \
              (((class) << IOPRIO_CLASS_SHIFT) | data)
          // Put schedule into IOPRIO_CLASS_IDLE class (lowest)
          // These system calls only have an effect when used in conjunction
          // with an I/O scheduler that supports I/O priorities. As at
          // kernel 2.6.17 the only such scheduler is the Completely
          // Fair Queuing (CFQ) I/O scheduler.
          // To change scheduler:
          //  echo cfq > /sys/block/<device_name>/queue/schedule
          // Tunables to consider:
          //  /sys/block/<device_name>/queue/slice_idle
          //  /sys/block/<device_name>/queue/slice_sync
          syscall(SYS_ioprio_set,
                  1,  // IOPRIO_WHO_PROCESS
                  0,  // current thread
                  IOPRIO_PRIO_VALUE(3, 0));
          low_io_priority = true;
        }
Z
ZHANG Biao 已提交
1458 1459
#else
        (void)decrease_io_priority; // avoid 'unused variable' error
1460
#endif
1461 1462 1463
        (*function)(arg);
      }
    }
J
jorlow@chromium.org 已提交
1464

1465 1466 1467 1468 1469 1470 1471 1472
    // 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) {}
    };

1473
    static void* BGThreadWrapper(void* arg) {
1474 1475 1476
      BGThreadMetadata* meta = reinterpret_cast<BGThreadMetadata*>(arg);
      size_t thread_id = meta->thread_id_;
      ThreadPool* tp = meta->thread_pool_;
1477
#if ROCKSDB_USING_THREAD_STATUS
Y
Yueh-Hsuan Chiang 已提交
1478
      // for thread-status
1479
      ThreadStatusUtil::RegisterThread(tp->env_,
Y
Yueh-Hsuan Chiang 已提交
1480
          (tp->GetThreadPriority() == Env::Priority::HIGH ?
1481 1482
              ThreadStatus::HIGH_PRIORITY :
              ThreadStatus::LOW_PRIORITY));
1483
#endif
1484 1485
      delete meta;
      tp->BGThread(thread_id);
1486
#if ROCKSDB_USING_THREAD_STATUS
1487
      ThreadStatusUtil::UnregisterThread();
1488
#endif
1489 1490
      return nullptr;
    }
J
jorlow@chromium.org 已提交
1491

1492 1493 1494 1495
    void WakeUpAllThreads() {
      PthreadCall("signalall", pthread_cond_broadcast(&bgsignal_));
    }

1496
    void SetBackgroundThreadsInternal(int num, bool allow_reduce) {
1497
      PthreadCall("lock", pthread_mutex_lock(&mu_));
1498 1499 1500 1501
      if (exit_all_threads_) {
        PthreadCall("unlock", pthread_mutex_unlock(&mu_));
        return;
      }
1502 1503
      if (num > total_threads_limit_ ||
          (num < total_threads_limit_ && allow_reduce)) {
I
Igor Canadi 已提交
1504
        total_threads_limit_ = std::max(1, num);
1505 1506
        WakeUpAllThreads();
        StartBGThreads();
1507 1508
      }
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
J
jorlow@chromium.org 已提交
1509
    }
1510

1511 1512 1513 1514 1515 1516 1517 1518
    void IncBackgroundThreadsIfNeeded(int num) {
      SetBackgroundThreadsInternal(num, false);
    }

    void SetBackgroundThreads(int num) {
      SetBackgroundThreadsInternal(num, true);
    }

1519
    void StartBGThreads() {
1520 1521 1522 1523
      // Start background thread if necessary
      while ((int)bgthreads_.size() < total_threads_limit_) {
        pthread_t t;
        PthreadCall(
1524 1525 1526
            "create thread",
            pthread_create(&t, nullptr, &ThreadPool::BGThreadWrapper,
                           new BGThreadMetadata(this, bgthreads_.size())));
1527 1528

        // Set the thread name to aid debugging
1529 1530
#if defined(_GNU_SOURCE) && defined(__GLIBC_PREREQ)
#if __GLIBC_PREREQ(2, 12)
1531
        char name_buf[16];
S
sdong 已提交
1532 1533
        snprintf(name_buf, sizeof name_buf, "rocksdb:bg%" ROCKSDB_PRIszt,
                 bgthreads_.size());
1534 1535
        name_buf[sizeof name_buf - 1] = '\0';
        pthread_setname_np(t, name_buf);
1536
#endif
1537 1538
#endif

1539 1540
        bgthreads_.push_back(t);
      }
1541 1542
    }

1543
    void Schedule(void (*function)(void* arg1), void* arg, void* tag) {
1544 1545 1546 1547 1548 1549 1550 1551
      PthreadCall("lock", pthread_mutex_lock(&mu_));

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

      StartBGThreads();
1552 1553 1554 1555 1556

      // Add to priority queue
      queue_.push_back(BGItem());
      queue_.back().function = function;
      queue_.back().arg = arg;
1557
      queue_.back().tag = tag;
1558 1559
      queue_len_.store(static_cast<unsigned int>(queue_.size()),
                       std::memory_order_relaxed);
1560

1561 1562 1563 1564 1565 1566 1567 1568
      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();
      }
1569

1570 1571
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
    }
J
jorlow@chromium.org 已提交
1572

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
    int UnSchedule(void* arg) {
      int count = 0;
      PthreadCall("lock", pthread_mutex_lock(&mu_));

      // Remove from priority queue
      BGQueue::iterator it = queue_.begin();
      while (it != queue_.end()) {
        if (arg == (*it).tag) {
          it = queue_.erase(it);
          count++;
        } else {
          it++;
        }
      }
      queue_len_.store(static_cast<unsigned int>(queue_.size()),
                       std::memory_order_relaxed);
      PthreadCall("unlock", pthread_mutex_unlock(&mu_));
      return count;
    }

1593 1594 1595 1596
    unsigned int GetQueueLen() const {
      return queue_len_.load(std::memory_order_relaxed);
    }

1597 1598
   private:
    // Entry per Schedule() call
1599 1600 1601 1602 1603
    struct BGItem {
      void* arg;
      void (*function)(void*);
      void* tag;
    };
1604 1605 1606 1607 1608 1609 1610
    typedef std::deque<BGItem> BGQueue;

    pthread_mutex_t mu_;
    pthread_cond_t bgsignal_;
    int total_threads_limit_;
    std::vector<pthread_t> bgthreads_;
    BGQueue queue_;
1611
    std::atomic_uint queue_len_;  // Queue length. Used for stats reporting
1612
    bool exit_all_threads_;
1613
    bool low_io_priority_;
Y
Yueh-Hsuan Chiang 已提交
1614
    Env::Priority priority_;
1615
    Env* env_;
1616 1617 1618 1619 1620 1621 1622 1623 1624
  };

  std::vector<ThreadPool> thread_pools_;

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

};

1625 1626 1627 1628 1629
PosixEnv::PosixEnv()
    : checkedDiskForMmap_(false),
      forceMmapOff(false),
      page_size_(getpagesize()),
      thread_pools_(Priority::TOTAL) {
1630
  PthreadCall("mutex_init", pthread_mutex_init(&mu_, nullptr));
Y
Yueh-Hsuan Chiang 已提交
1631 1632 1633
  for (int pool_id = 0; pool_id < Env::Priority::TOTAL; ++pool_id) {
    thread_pools_[pool_id].SetThreadPriority(
        static_cast<Env::Priority>(pool_id));
1634 1635
    // This allows later initializing the thread-local-env of each thread.
    thread_pools_[pool_id].SetHostEnv(this);
Y
Yueh-Hsuan Chiang 已提交
1636
  }
1637
  thread_status_updater_ = CreateThreadStatusUpdater();
1638 1639
}

1640 1641
void PosixEnv::Schedule(void (*function)(void* arg1), void* arg, Priority pri,
                        void* tag) {
1642
  assert(pri >= Priority::LOW && pri <= Priority::HIGH);
1643 1644 1645 1646 1647
  thread_pools_[pri].Schedule(function, arg, tag);
}

int PosixEnv::UnSchedule(void* arg, Priority pri) {
  return thread_pools_[pri].UnSchedule(arg);
J
jorlow@chromium.org 已提交
1648 1649
}

1650 1651 1652 1653 1654
unsigned int PosixEnv::GetThreadPoolQueueLen(Priority pri) const {
  assert(pri >= Priority::LOW && pri <= Priority::HIGH);
  return thread_pools_[pri].GetQueueLen();
}

J
jorlow@chromium.org 已提交
1655 1656 1657 1658
struct StartThreadState {
  void (*user_function)(void*);
  void* arg;
};
1659

J
jorlow@chromium.org 已提交
1660 1661 1662 1663
static void* StartThreadWrapper(void* arg) {
  StartThreadState* state = reinterpret_cast<StartThreadState*>(arg);
  state->user_function(state->arg);
  delete state;
A
Abhishek Kona 已提交
1664
  return nullptr;
J
jorlow@chromium.org 已提交
1665 1666 1667 1668 1669 1670 1671 1672
}

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 已提交
1673
              pthread_create(&t, nullptr,  &StartThreadWrapper, state));
1674
  PthreadCall("lock", pthread_mutex_lock(&mu_));
1675
  threads_to_join_.push_back(t);
1676
  PthreadCall("unlock", pthread_mutex_unlock(&mu_));
J
jorlow@chromium.org 已提交
1677 1678
}

L
Lei Jin 已提交
1679 1680 1681 1682 1683 1684 1685
void PosixEnv::WaitForJoin() {
  for (const auto tid : threads_to_join_) {
    pthread_join(tid, nullptr);
  }
  threads_to_join_.clear();
}

H
Hans Wennborg 已提交
1686
}  // namespace
J
jorlow@chromium.org 已提交
1687

M
Mayank Agarwal 已提交
1688 1689
std::string Env::GenerateUniqueId() {
  std::string uuid_file = "/proc/sys/kernel/random/uuid";
A
agiardullo 已提交
1690 1691 1692

  Status s = FileExists(uuid_file);
  if (s.ok()) {
M
Mayank Agarwal 已提交
1693
    std::string uuid;
A
agiardullo 已提交
1694
    s = ReadFileToString(this, uuid_file, &uuid);
M
Mayank Agarwal 已提交
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
    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 已提交
1705 1706 1707 1708 1709
  snprintf(uuid2,
           200,
           "%lx-%lx",
           (unsigned long)nanos_uuid_portion,
           (unsigned long)random_uuid_portion);
M
Mayank Agarwal 已提交
1710 1711 1712
  return uuid2;
}

J
jorlow@chromium.org 已提交
1713
Env* Env::Default() {
1714
  static PosixEnv default_env;
1715
  return &default_env;
J
jorlow@chromium.org 已提交
1716 1717
}

1718
}  // namespace rocksdb