sapling/eden/fs/inodes/EdenMount.h
Michael Bolin 7a05213f34 New Thrift endpoint: getBindMounts(mountPoint).
Summary:
Buck needs this API so that it knows which paths under a project
root it should exclude when deciding whether it can ask Eden for its
SHA-1 or if it must compute it on its own.

Reviewed By: simpkins

Differential Revision: D3840658

fbshipit-source-id: 5eddc0bef423d3b3ee165d2a4b0bbf193f94f61a
2016-09-12 18:29:15 -07:00

98 lines
2.6 KiB
C++

/*
* Copyright (c) 2016, 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 <memory>
#include "eden/utils/PathFuncs.h"
namespace facebook {
namespace eden {
namespace fusell {
class MountPoint;
}
class BindMount;
class ClientConfig;
class ObjectStore;
class Overlay;
/*
* EdenMount contains all of the data about a specific eden mount point.
*
* This contains:
* - The fusell::MountPoint object which manages our FUSE interactions with the
* kernel.
* - The ObjectStore object used for retreiving/storing object data.
* - The Overlay object used for storing local changes (that have not been
* committed/snapshotted yet).
*/
class EdenMount {
public:
EdenMount(
std::shared_ptr<fusell::MountPoint> mountPoint,
std::unique_ptr<ObjectStore> objectStore,
std::shared_ptr<Overlay> overlay,
std::unique_ptr<const ClientConfig> clientConfig);
virtual ~EdenMount();
/*
* Get the MountPoint object.
*
* This returns a raw pointer since the EdenMount owns the mount point.
* The caller should generally maintain a reference to the EdenMount object,
* and not directly to the MountPoint object itself.
*/
fusell::MountPoint* getMountPoint() const {
return mountPoint_.get();
}
/*
* Return the path to the mount point.
*/
const AbsolutePath& getPath() const;
/*
* Return bind mounts that are applied for this mount. These are based on the
* state of the ClientConfig when this EdenMount was created.
*/
const std::vector<BindMount>& getBindMounts() const;
/*
* Return the ObjectStore used by this mount point.
*
* The ObjectStore is guaranteed to be valid for the lifetime of the
* EdenMount.
*/
ObjectStore* getObjectStore() const {
return objectStore_.get();
}
const std::shared_ptr<Overlay>& getOverlay() const {
return overlay_;
}
private:
// Forbidden copy constructor and assignment operator
EdenMount(EdenMount const&) = delete;
EdenMount& operator=(EdenMount const&) = delete;
std::shared_ptr<fusell::MountPoint> mountPoint_;
std::unique_ptr<ObjectStore> objectStore_;
std::shared_ptr<Overlay> overlay_;
/*
* Note that this config will not be updated if the user modifies the
* underlying config files after the ClientConfig was created.
*/
const std::unique_ptr<const ClientConfig> clientConfig_;
};
}
}