Back out "remove recas backing store"

Reviewed By: zzl0

Differential Revision: D88781365

fbshipit-source-id: fc8c945925af31deeefdee29d1098fbfa28ccc24

Author: muirdm

eden/fs/cli/config.py

@@ -104,6 +104,7 @@
     "git": "refs/heads/master",
     "hg": "first(present(master) + .)",
     "filteredhg": "first(present(master) + .)",
+    "recas": "",
     "http": "",
 }
 
@@ -221,6 +222,7 @@ class CheckoutConfig(typing.NamedTuple):
     predictive_prefetch_num_dirs: int
     enable_sqlite_overlay: bool
     use_write_back_cache: bool
+    re_use_case: str
     enable_windows_symlinks: bool
     inode_catalog_type: Optional[str]
     off_mount_repo_dir: bool
@@ -1493,6 +1495,9 @@ def save_config(self, checkout_config: CheckoutConfig) -> None:
             "predictive-prefetch": {
                 "predictive-prefetch-active": checkout_config.predictive_prefetch_profiles_active,
             },
+            "recas": {
+                "use-case": checkout_config.re_use_case,
+            },
         }
 
         if checkout_config.predictive_prefetch_num_dirs:
@@ -1645,6 +1650,12 @@ def get_field(key: str) -> str:
         if not isinstance(use_write_back_cache, bool):
             use_write_back_cache = False
 
+        re_use_case = "buck2-default"
+        recas = config.get("recas")
+        if recas is not None:
+            if recas.get("use-case") is not None:
+                re_use_case = str(recas.get("use-case"))
+
         enable_windows_symlinks = repository.get("enable-windows-symlinks")
         if not isinstance(enable_windows_symlinks, bool):
             enable_windows_symlinks = False
@@ -1697,6 +1708,7 @@ def get_field(key: str) -> str:
             predictive_prefetch_num_dirs=predictive_num_dirs,
             enable_sqlite_overlay=enable_sqlite_overlay,
             use_write_back_cache=use_write_back_cache,
+            re_use_case=re_use_case,
             enable_windows_symlinks=enable_windows_symlinks,
             inode_catalog_type=inode_catalog_type,
             off_mount_repo_dir=off_mount_repo_dir,
@@ -2216,6 +2228,7 @@ def get_repo_info(
     case_sensitive: bool,
     overlay_type: Optional[str],
     backing_store_type: Optional[str] = None,
+    re_use_case: Optional[str] = None,
     enable_windows_symlinks: bool = False,
     off_mount_repo_dir: bool = False,
 ) -> Tuple[util.Repo, CheckoutConfig]:
@@ -2248,6 +2261,7 @@ def get_repo_info(
         case_sensitive,
         overlay_type,
         backing_store_type=backing_store_type,
+        re_use_case=re_use_case,
         enable_windows_symlinks=enable_windows_symlinks,
         off_mount_repo_dir=off_mount_repo_dir,
     )
@@ -2262,6 +2276,7 @@ def create_checkout_config(
     case_sensitive: bool,
     overlay_type: Optional[str],
     backing_store_type: Optional[str] = None,
+    re_use_case: Optional[str] = None,
     enable_windows_symlinks: bool = False,
     off_mount_repo_dir: bool = False,
 ) -> CheckoutConfig:
@@ -2315,6 +2330,7 @@ def create_checkout_config(
         predictive_prefetch_num_dirs=0,
         enable_sqlite_overlay=enable_sqlite_overlay,
         use_write_back_cache=False,
+        re_use_case=re_use_case or "buck2-default",
         enable_windows_symlinks=enable_windows_symlinks,
         inode_catalog_type=overlay_type,
         off_mount_repo_dir=off_mount_repo_dir,

eden/fs/cli/doctor/test/lib/fake_eden_instance.py

@@ -144,6 +144,7 @@ def create_test_mount(
             predictive_prefetch_num_dirs=0,
             enable_sqlite_overlay=True,
             use_write_back_cache=False,
+            re_use_case="buck2-default",
             enable_windows_symlinks=False,
             inode_catalog_type=None,
             off_mount_repo_dir=False,

eden/fs/cli/main.py

@@ -462,12 +462,17 @@ def setup_parser(self, parser: argparse.ArgumentParser) -> None:
             "--backing-store",
             help=(
                 "Clone the path with a specified Backing Store implementation. "
-                "Currently only supports 'filteredhg' (all), "
+                "Currently only supports 'filteredhg' (all), 'recas' (Linux), "
                 "and 'http' (Linux). Takes precedent over the inferred backing"
                 "store type from the existing repository we're cloning from."
             ),
         )
 
+        parser.add_argument(
+            "--re-use-case",
+            help="The Remote Execution use-case to use when --backing-store=recas",
+        )
+
         parser.add_argument(
             "--enable-windows-symlinks",
             action="store_true",
@@ -619,6 +624,7 @@ def is_nfs_default():
                 args.case_sensitive,
                 overlay_type=args.overlay_type,
                 backing_store_type=args.backing_store,
+                re_use_case=args.re_use_case,
                 enable_windows_symlinks=enable_windows_symlinks,
                 off_mount_repo_dir=instance.get_config_bool(
                     "clone.off-mount-repo-dir",
@@ -664,6 +670,18 @@ def is_nfs_default():
                     )
                     return 1
 
+        elif args.backing_store == "recas":
+            if sys.platform != "linux":
+                print_stderr(
+                    "error: recas backing store was passed but this feature is only available on Linux"
+                )
+                return 1
+            if args.rev is not None:
+                commit = args.rev
+            else:
+                NULL_REVISION = "0" * 40
+                # A special digest for RE CAS representing an empty folder
+                commit = f"{NULL_REVISION}:0"
         elif args.backing_store == "http":
             if sys.platform != "linux":
                 print_stderr(

eden/fs/cli/test/cli_test.py

@@ -90,6 +90,7 @@ def test_list_mounts_no_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -117,6 +118,7 @@ def test_list_mounts_no_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -144,6 +146,7 @@ def test_list_mounts_no_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -171,6 +174,7 @@ def test_list_mounts_no_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -198,6 +202,7 @@ def test_list_mounts_no_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -326,6 +331,7 @@ def test_list_mounts_no_state(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -353,6 +359,7 @@ def test_list_mounts_no_state(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -380,6 +387,7 @@ def test_list_mounts_no_state(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -499,6 +507,7 @@ def test_list_mounts_with_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,
@@ -526,6 +535,7 @@ def test_list_mounts_with_backing_repos(self) -> None:
                 predictive_prefetch_num_dirs=0,
                 enable_sqlite_overlay=False,
                 use_write_back_cache=False,
+                re_use_case="buck2-default",
                 enable_windows_symlinks=False,
                 inode_catalog_type=None,
                 off_mount_repo_dir=False,

eden/fs/cli/util.py

@@ -515,6 +515,23 @@ def get_commit_hash(self, commit: str) -> str:
         return out.strip().decode("utf-8")
 
 
+class ReCasRepo(Repo):
+    HEAD = "HEAD"
+
+    def __init__(self, source: str, working_dir: Optional[str] = None) -> None:
+        if working_dir is not None:
+            raise RuntimeError("ReCas Repo is not expected a working_dir")
+        super(ReCasRepo, self).__init__("recas", source, working_dir)
+
+    def __repr__(self) -> str:
+        return f"ReCasRepo(source={self.source!r})"
+
+    def get_commit_hash(self, commit: str) -> str:
+        raise NotImplementedError(
+            "get_commit_hash is not supposed to be called for ReCasRepo"
+        )
+
+
 class HttpRepo(Repo):
     HEAD = "HEAD"
 
@@ -591,6 +608,14 @@ def get_hg_repo(path: str, backing_type: Optional[str] = None) -> Optional[HgRep
     return HgRepo(repo_path, working_dir, backing_type)
 
 
+def get_recas_repo(path: str) -> Optional[ReCasRepo]:
+    """
+    If path points to a Re Cas dir, return a ReCasRepo object.
+    Otherwise, return None.
+    """
+    return ReCasRepo(path)
+
+
 def get_http_repo(path: str) -> Optional[HttpRepo]:
     """
     Return a HttpRepo object, with the source path.
@@ -607,6 +632,11 @@ def get_repo(path: str, backing_store_type: Optional[str] = None) -> Optional[Re
         # Skip checking if the local path exists with the repo source name.
         return get_http_repo(path)
 
+    if backing_store_type is not None and backing_store_type == "recas":
+        recas_repo = get_recas_repo(path)
+        if recas_repo is not None:
+            return recas_repo
+
     path = os.path.realpath(path)
     if not os.path.exists(path):
         return None

eden/fs/cli_rs/edenfs-client/src/checkout.rs

@@ -85,6 +85,8 @@ enum RepositoryType {
     Git,
     #[strum(serialize = "hg")]
     Hg,
+    #[strum(serialize = "recas")]
+    Recas,
     #[strum(serialize = "filteredhg")]
     FilteredHg,
 }

eden/fs/config/CheckoutConfig.cpp

@@ -45,6 +45,8 @@ constexpr folly::StringPiece kInodeCatalogType{"inode-catalog-type"};
 constexpr folly::StringPiece kRequireUtf8Path{"require-utf8-path"};
 constexpr folly::StringPiece kEnableSqliteOverlay{"enable-sqlite-overlay"};
 constexpr folly::StringPiece kUseWriteBackCache{"use-write-back-cache"};
+constexpr folly::StringPiece kReCas{"recas"};
+constexpr folly::StringPiece kReUseCase{"use-case"};
 #ifdef _WIN32
 constexpr folly::StringPiece kRepoGuid{"guid"};
 constexpr folly::StringPiece kEnableWindowsSymlinks{"enable-windows-symlinks"};
@@ -425,6 +427,14 @@ std::unique_ptr<CheckoutConfig> CheckoutConfig::loadFromClientDirectory(
   auto useWriteBackCache = repository->get_as<bool>(kUseWriteBackCache.str());
   config->useWriteBackCache_ = useWriteBackCache.value_or(false);
 
+  auto recas = configRoot->get_table(kReCas.str());
+  if (recas) {
+    auto re_use_case = recas->get_as<std::string>(kReUseCase.str());
+    if (re_use_case) {
+      config->reUseCase_ = *re_use_case;
+    }
+  }
+
 #ifdef _WIN32
   auto guid = repository->get_as<std::string>(kRepoGuid.str());
   config->repoGuid_ = guid ? Guid{*guid} : Guid::generate();

eden/fs/config/CheckoutConfig.h

@@ -28,6 +28,7 @@ namespace facebook::eden {
 constexpr BackingStoreType kSupportedRepositoryTypes[] = {
     BackingStoreType::HG,
     BackingStoreType::GIT,
+    BackingStoreType::RECAS,
     BackingStoreType::EMPTY,
     BackingStoreType::HTTP,
 };
@@ -120,7 +121,8 @@ class CheckoutConfig {
   /**
    * Get the repository type.
    *
-   * Currently supported types include "git", "hg", "filteredhg", and "empty".
+   * Currently supported types include "git", "hg", "filteredhg", "empty", and
+   * "recas".
    */
   const std::string& getRepoType() const {
     return repoType_;
@@ -203,6 +205,10 @@ class CheckoutConfig {
     return useWriteBackCache_;
   }
 
+  const std::string& getReUseCase() const {
+    return reUseCase_;
+  }
+
 #ifdef _WIN32
   /** Guid for that repository */
   Guid getRepoGuid() const {
@@ -234,6 +240,8 @@ class CheckoutConfig {
 
   bool useWriteBackCache_{false};
 
+  std::string reUseCase_{"buck2-default"};
+
 #ifdef _WIN32
   Guid repoGuid_;
   bool enableWindowsSymlinks_;

eden/fs/inodes/InodeBase.h

@@ -467,8 +467,8 @@ class InodeBase {
    * Force materialize a file or a tree and rely on the overlay as the source of
    * the files. If the inode is a symlink and followSymlink is true, its target
    * will be materialized if possible. If the inode is a tree, every child in
-   * this node will be recursively materialized. This function should be used
-   * carefully.
+   * this node will be recursively materialized. This function should be careful
+   * to be used and should be used by RECAS backing store only
    */
   [[nodiscard]] virtual ImmediateFuture<folly::Unit> ensureMaterialized(
       const ObjectFetchContextPtr& context,

eden/fs/service/BUCK

@@ -81,6 +81,7 @@ cpp_binary(
             "linux",
             [
                 "//eden/fs/store/facebook/http:http",
+                "//eden/fs/store/facebook/recas:recas",
                 "//eden/fs/telemetry/facebook:activity_recorder",
                 "//eden/fs/telemetry/facebook:scribe_logger",
                 "//services_efficiency/heap:init",