sapling/eden/fs/store/BackingStore.h
Xavier Deguillard fe0ea26fdf store: avoid copying proxy hashes during prefetch
Summary:
Looking at strobelight when performing an `eden prefetch` shows that a lot of
time is spent copying data around. The list of hash to prefetch is for instance
copied 4 times, let's reduce this to only one time when converting Hash to a
ByteRange.

Reviewed By: chadaustin

Differential Revision: D30433285

fbshipit-source-id: 922e6e5c095bd700ee133e9bb219904baf2ae1ac
2021-08-23 11:05:02 -07:00

127 lines
3.9 KiB
C++

/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This software may be used and distributed according to the terms of the
* GNU General Public License version 2.
*/
#pragma once
#include <folly/Range.h>
#include <folly/futures/Future.h>
#include <memory>
#include "eden/fs/model/RootId.h"
#include "eden/fs/store/ImportPriority.h"
#include "eden/fs/store/ObjectFetchContext.h"
#include "eden/fs/utils/PathFuncs.h"
namespace folly {
template <typename T>
class Future;
}
namespace facebook::eden {
class Blob;
class Hash;
class Tree;
class TreeEntry;
enum class TreeEntryType : uint8_t;
/**
* Abstract interface for a BackingStore.
*
* A BackingStore fetches tree and blob information from an external
* authoritative data source.
*
* BackingStore implementations must be thread-safe, and perform their own
* internal locking.
*/
class BackingStore : public RootIdCodec {
public:
BackingStore() {}
virtual ~BackingStore() {}
virtual folly::SemiFuture<std::unique_ptr<Tree>> getRootTree(
const RootId& rootId,
ObjectFetchContext& context) = 0;
/**
* The API should accept object id instead of rootId. But Object is currently
* a fixed 20 bytes, so temporariorly use rootId instead.
* TODO: Replace rootID with objectId once objectId is widened.
*/
virtual folly::SemiFuture<std::unique_ptr<TreeEntry>> getTreeEntryForRootId(
const RootId& rootId,
TreeEntryType treeEntryType,
facebook::eden::PathComponentPiece pathComponentPiece,
ObjectFetchContext& context) = 0;
virtual folly::SemiFuture<std::unique_ptr<Tree>> getTree(
const Hash& id,
ObjectFetchContext& context) = 0;
virtual folly::SemiFuture<std::unique_ptr<Blob>> getBlob(
const Hash& id,
ObjectFetchContext& context) = 0;
/**
* Prefetch all the blobs represented by the HashRange.
*
* The caller is responsible for making sure that the HashRange stays valid
* for as long as the returned SemiFuture.
*/
FOLLY_NODISCARD virtual folly::SemiFuture<folly::Unit> prefetchBlobs(
HashRange /*ids*/,
ObjectFetchContext& /*context*/) {
return folly::unit;
}
virtual void periodicManagementTask() {}
/**
* Subclass of BackingStore will override these functions to record file paths
* fetched. By default, recordFetch() does nothing. After
* startRecordingFetch() is called, recordFetch() starts to records fetched
* file paths. stopRecordingFetch() will disable recordFetch()'s function and
* return the fetched files since startRecordingFetch() is called and clear
* the old records.
*
* Currently implemented in HgQueuedBackingStore.
*
* Note: Only stopRecordingFetch() clears old records. Calling
* startRecordingFetch() a second time has no effect.
*/
virtual void startRecordingFetch() {}
virtual void recordFetch(folly::StringPiece) {}
virtual std::unordered_set<std::string> stopRecordingFetch() {
return {};
}
/**
* Directly import a manifest for a root.
*
* Subclasses of BackingStore can override this to opportunistically import
* known manifests for a particular root.
*
* This is called when the hg client informs EdenFS of a root to manifest
* mapping. This is useful when the commit has just been created, as
* EdenFS won't be able to find out the manifest from the import helper
* until it re-opens the repo.
*
* TODO: When EdenFS no longer uses hg import helper subprocesses and when
* Hash is widened to variable-width, eliminating the need for proxy hashes,
* this API should be removed.
*/
virtual folly::SemiFuture<folly::Unit> importManifestForRoot(
const RootId& /*rootId*/,
const Hash& /*manifest*/) {
return folly::unit;
}
private:
// Forbidden copy constructor and assignment operator
BackingStore(BackingStore const&) = delete;
BackingStore& operator=(BackingStore const&) = delete;
};
} // namespace facebook::eden