sapling/eden/fs/inodes/TreeInode.h
Wez Furlong 174d0b9b0a eden: assign our own file handle numbers and track all file handles
Summary:
Previously we would simply report the raw pointer address to the kernel and
rely on it to return that same number to us as the file handle, and make sure
that it told us to shut down the handle when it was closed.

This meant that we had no real idea about which files were still open.

For our future live upgrade plans we need to be able to know this so that we
can transfer the appropriate information to our replacement process.

To facilitate this this diff implements a FileHandleMap class that will assign
file handle numbers and keep track of the instances.  The number assignment
strategy is the same as it used to be in the common case: we take the address
of the newly created instance and use that 64-bit number as the file handle
number.  However, in the future when we transfer the mapping to a new process,
we may experience a collision when subsequently opening a file handle.  To deal
with that, we have a bounded number of attempts to assign a random file handle
number.

We don't yet offer a means to iterate the map, but it would be trivial to
expose such an accessor when we're ready to use it.

Since we now keep track of these things via shared_ptr this changes the
appropriate portions of the fuse interface from unique_ptr to shared_ptr.

Reviewed By: simpkins

Differential Revision: D3602364

fbshipit-source-id: dd996339c2838225a2caeee9da16ef99a06c1e2b
2016-07-26 10:00:11 -07:00

100 lines
3.0 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 "eden/fuse/Inodes.h"
namespace facebook {
namespace eden {
class EdenMount;
class Hash;
class ObjectStore;
class Overlay;
class Tree;
class TreeEntry;
// Represents a Tree instance in a form that FUSE can consume
class TreeInode : public fusell::DirInode {
public:
TreeInode(
EdenMount* mount,
std::unique_ptr<Tree>&& tree,
fuse_ino_t parent,
fuse_ino_t ino);
/// Construct an inode that only has backing in the Overlay area
TreeInode(EdenMount* mount, fuse_ino_t parent, fuse_ino_t ino);
~TreeInode();
folly::Future<fusell::Dispatcher::Attr> getattr() override;
folly::Future<std::shared_ptr<fusell::InodeBase>> getChildByName(
PathComponentPiece namepiece) override;
folly::Future<std::shared_ptr<fusell::DirHandle>> opendir(
const struct fuse_file_info& fi) override;
folly::Future<folly::Unit> rename(
PathComponentPiece name,
std::shared_ptr<DirInode> newParent,
PathComponentPiece newName) override;
const Tree* getTree() const;
fuse_ino_t getParent() const;
fuse_ino_t getInode() const;
/**
* Get the EdenMount that this TreeInode belongs to.
*
* The EdenMount is guaranteed to remain valid for at least the lifetime of
* the TreeInode object.
*/
EdenMount* getMount() const;
/**
* Get the ObjectStore for this mount point.
*
* The ObjectStore is guaranteed to remain valid for at least the lifetime of
* the TreeInode object. (The ObjectStore is owned by the EdenMount.)
*/
ObjectStore* getStore() const;
const std::shared_ptr<Overlay>& getOverlay() const;
folly::Future<fusell::DirInode::CreateResult>
create(PathComponentPiece name, mode_t mode, int flags) override;
folly::Future<fuse_entry_param> mkdir(PathComponentPiece name, mode_t mode)
override;
folly::Future<folly::Unit> unlink(PathComponentPiece name) override;
folly::Future<folly::Unit> rmdir(PathComponentPiece name) override;
/** Called in a thrift context to switch the active snapshot.
* Since this is called in a thrift context, RequestData::get() won't
* return the usual results and the appropriate information must
* be passed down from the thrift server itself.
*/
void performCheckout(const Hash& hash);
fusell::InodeNameManager* getNameMgr() const;
private:
const TreeEntry* getTreeEntry(PathComponentPiece name);
// The EdenMount object that this inode belongs to.
// We store this as a raw pointer since the TreeInode is part of the mount
// point. The EdenMount should always exist longer than any inodes it
// contains. (Storing a shared_ptr to the EdenMount would introduce circular
// references which are undesirable.)
EdenMount* const mount_{nullptr};
std::unique_ptr<Tree> tree_;
fuse_ino_t parent_;
};
}
}