sapling/eden/fs/inodes/Overlay.h

/*
 *  Copyright (c) 2016-present, 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.
 *
 */
#pragma once
#include <folly/File.h>
#include <folly/Optional.h>
#include <folly/Range.h>
#include "TreeInode.h"
#include "eden/fs/utils/DirType.h"
#include "eden/fs/utils/PathFuncs.h"
#include "eden/fs/utils/PathMap.h"

namespace facebook {
namespace eden {

namespace overlay {
class OverlayDir;
}

/** Manages the write overlay storage area.
 *
 * The overlay is where we store files that are not yet part of a snapshot.
 *
 * The contents of this storage layer are overlaid on top of the object store
 * snapshot that is active in a given mount point.
 *
 * There is one overlay area associated with each eden client instance.
 *
 * We use the Overlay to manage mutating the structure of the checkout;
 * each time we create or delete a directory entry, we do so through
 * the overlay class.
 *
 * The Overlay class keeps track of the mutated tree; if we mutate some
 * file "foo/bar/baz" then the Overlay records metadata about the list
 * of files in the root, the list of files in "foo", the list of files in
 * "foo/bar" and finally materializes "foo/bar/baz".
 */
class Overlay {
 public:
  explicit Overlay(AbsolutePathPiece localDir);

  /** Returns the path to the root of the Overlay storage area */
  const AbsolutePath& getLocalDir() const;

  void saveOverlayDir(
      fusell::InodeNumber inodeNumber,
      const TreeInode::Dir* dir);
  folly::Optional<TreeInode::Dir> loadOverlayDir(
      fusell::InodeNumber inodeNumber) const;

  void removeOverlayData(fusell::InodeNumber inodeNumber) const;

  /**
   * Get the path to the overlay file for the given inode
   */
  AbsolutePath getFilePath(fusell::InodeNumber inodeNumber) const;
  /**
   * Creates header for the files stored in Overlay
   */
  static folly::IOBuf createHeader(
      folly::StringPiece identifier,
      uint32_t version,
      const struct timespec& atime,
      const struct timespec& ctime,
      const struct timespec& mtime);

  /**
   * Helper function that opens an existing overlay file,
   * checks if the file has valid header
   * populates st_atim, st_mtim, st_ctim and returns the file.
   */
  static folly::File openFile(
      folly::StringPiece filePath,
      folly::StringPiece headerId,
      InodeTimestamps& timestamps);

  /**
   * Helper function that creates a new overlay file and adds header to it
   */
  folly::File createOverlayFile(
      fusell::InodeNumber childNumber,
      timespec ctime);

  /**
   * Updates the timestamps of an overlay file appropriately
   * while unloading an inode.
   */
  static void updateTimestampToHeader(
      int fd,
      const InodeTimestamps& timeStamps);

  /**
   * Get the maximum inode number stored in the overlay.
   *
   * This is called when opening a mount point, to make sure that new inodes
   * handed out from this point forwards are always greater than any inodes
   * already tracked in the overlay.
   */
  fusell::InodeNumber getMaxRecordedInode();

  /**
   * Constants for an header in overlay file.
   */
  static constexpr folly::StringPiece kHeaderIdentifierDir{"OVDR"};
  static constexpr folly::StringPiece kHeaderIdentifierFile{"OVFL"};
  static constexpr uint32_t kHeaderVersion = 1;
  static constexpr size_t kHeaderLength = 64;

 private:
  void initOverlay();
  bool isOldFormatOverlay() const;
  void readExistingOverlay(int infoFD);
  void initNewOverlay();
  folly::Optional<overlay::OverlayDir> deserializeOverlayDir(
      fusell::InodeNumber inodeNumber,
      InodeTimestamps& timeStamps) const;
  /**
   * Helper function to add header to the overlay file
   */
  static void addHeaderToOverlayFile(int fd, timespec ctime);

  /**
   * Parses, validates and reads Timestamps from the header.
   */
  static void parseHeader(
      folly::StringPiece header,
      folly::StringPiece headerId,
      InodeTimestamps& timeStamps);

  /** path to ".eden/CLIENT/local" */
  AbsolutePath localDir_;

  /**
   * An open file descriptor to the overlay info file.
   *
   * This is primarily used to hold a lock on the overlay for as long as we are
   * using it.  We want to ensure that only one eden process
   */
  folly::File infoFile_;
};
} // namespace eden
} // namespace facebook