mirror of
https://github.com/facebook/sapling.git
synced 2024-10-04 22:07:44 +03:00
108b57fc36
Summary: To support better telemetry and logging in watchman we want to use Eden's components. Lets migrate and detangle the needed pieces. This change moves FileUtils and PathFuncs from eden to edencommon. NOTE: FileUtils and PathFuncs are mutally dependent so they were migrated togehter. Most of the files touched, however, was due to PathFuncs. Reviewed By: genevievehelsel Differential Revision: D54393041 fbshipit-source-id: 6dc404b1b1066704584da512220475e9ee486247
116 lines
3.0 KiB
C++
116 lines
3.0 KiB
C++
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This software may be used and distributed according to the terms of the
|
|
* GNU General Public License version 2.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <folly/File.h>
|
|
#include <folly/Range.h>
|
|
#include <folly/portability/SysStat.h>
|
|
|
|
#include "eden/common/utils/PathFuncs.h"
|
|
|
|
namespace folly {
|
|
class File;
|
|
}
|
|
|
|
namespace facebook::eden {
|
|
|
|
/**
|
|
* EdenStateDir exists for managing access to the user's .eden directory.
|
|
*
|
|
* Note that this refers to the user's main .eden directory where Eden stores
|
|
* its state, and not the virtual .eden directories that appear in all mounted
|
|
* Eden checkouts.
|
|
*/
|
|
class EdenStateDir {
|
|
public:
|
|
explicit EdenStateDir(AbsolutePathPiece path);
|
|
~EdenStateDir();
|
|
|
|
/**
|
|
* Acquire the main on-disk edenfs lock.
|
|
*
|
|
* Callers should acquire the on-disk lock before performing any other
|
|
* operations on the EdenStateDir, to ensure that only one process can use the
|
|
* state directory at a time.
|
|
*
|
|
* Returns true if the lock was acquired successfully, or false if we failed
|
|
* to acquire the lock (likely due to another process holding it).
|
|
* May throw an exception on other errors (e.g., insufficient permissions to
|
|
* create the lock file, out of disk space, etc).
|
|
*/
|
|
FOLLY_NODISCARD bool acquireLock();
|
|
|
|
/**
|
|
* Take over the lock file from another process.
|
|
*/
|
|
void takeoverLock(folly::File lockFile);
|
|
|
|
/**
|
|
* Extract the lock file without releasing it.
|
|
*
|
|
* This is primarily intended to be used to transfer the lock to another
|
|
* process. This file descriptor can be transferred to the other process,
|
|
* which will then pass it to the takeoverLock() method of their EdenStateDir
|
|
* object.
|
|
*/
|
|
folly::File extractLock();
|
|
|
|
/**
|
|
* Returns true if the Eden state directory lock is currently held by this
|
|
* EdenStateDir object.
|
|
*/
|
|
bool isLocked() const;
|
|
|
|
/**
|
|
* Returns true if the on-disk lock file is still valid. Returns false if the
|
|
* lock file file has been renamed or deleted.
|
|
*/
|
|
bool isLockValid() const;
|
|
|
|
/**
|
|
* Get the path to the state directory.
|
|
*/
|
|
AbsolutePathPiece getPath() const {
|
|
return path_;
|
|
}
|
|
|
|
/**
|
|
* Get the path to Eden's thrift socket.
|
|
*/
|
|
AbsolutePath getThriftSocketPath() const;
|
|
|
|
/**
|
|
* Get the path to Eden's takeover socket.
|
|
*/
|
|
AbsolutePath getTakeoverSocketPath() const;
|
|
|
|
/**
|
|
* Get the path to Eden's NFS mountd socket.
|
|
*/
|
|
AbsolutePath getMountdSocketPath() const;
|
|
|
|
/**
|
|
* Get the path to the directory where state for a specific checkout is
|
|
* stored.
|
|
*
|
|
* Note that the checkoutID string must meet the requirements of
|
|
* PathComponent: it must not contain internal directory separators and must
|
|
* not be "." or "..".
|
|
*/
|
|
AbsolutePath getCheckoutStateDir(folly::StringPiece checkoutID) const;
|
|
|
|
private:
|
|
static void writePidToLockFile(folly::File& lockFile);
|
|
|
|
AbsolutePath path_;
|
|
AbsolutePath lockPath_;
|
|
folly::File lockFile_;
|
|
struct stat lockFileStat_ = {};
|
|
};
|
|
} // namespace facebook::eden
|