[ramdevice_client] Separate IsolatedDevmgr code

Pull the IsolatedDevmgr code out into a ramdevice_client_test
library. This enables us to make the IsolatedDevmgr code testonly.

Bug: 84322

Change-Id: I96a846d2834da03b9238210d914a993bd8c5a89e
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/579541
Reviewed-by: Suraj Malhotra <surajmalhotra@google.com>
Commit-Queue: David Gilhooley <dgilhooley@google.com>

Author: gilhooleyd

src/lib/storage/ramdevice_client/cpp/BUILD.gn

@@ -17,11 +17,37 @@ shared_library("ramdevice-client") {
     "ramnand.cc",
   ]
   public_deps = [
-    # <ramdevice-client/ramnand.h> has #include <lib/driver-integration-test/fixture.h>
-    "//zircon/system/ulib/driver-integration-test:driver-integration-test-static",
+    # <ramdevice-client/ramnand.h> has #include <fuchsia/hardware/nand/c/fidl.h>
+    "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
+  ]
+  deps = [
+    "//sdk/fidl/fuchsia.device:fuchsia.device_c",
+    "//sdk/fidl/fuchsia.device:fuchsia.device_llcpp",
+    "//sdk/fidl/fuchsia.hardware.block:fuchsia.hardware.block_c",
+    "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
+    "//sdk/fidl/fuchsia.hardware.ramdisk:fuchsia.hardware.ramdisk_c",
+    "//sdk/lib/fdio",
+    "//src/lib/ddk",
+    "//zircon/public/lib/fbl",
+    "//zircon/public/lib/zx",
+    "//zircon/system/ulib/fdio-caller",
+    "//zircon/system/ulib/fzl",
+  ]
+  configs += [ "//build/config/fuchsia:static_cpp_standard_library" ]
+}
+
+shared_library("ramdevice-client-test") {
+  testonly = true
+  public_configs = [ ":headers_config" ]
+  public = [ "include/ramdevice-client-test/ramnandctl.h" ]
+  sources = [ "ramnandctl.cc" ]
+  public_deps = [
+    # <ramdevice-client-test/ramnandctl.h> has #include <lib/driver-integration-test/fixture.h>
+    ":ramdevice-client",
 
     # <ramdevice-client/ramnand.h> has #include <fuchsia/hardware/nand/c/fidl.h>
     "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
+    "//zircon/system/ulib/driver-integration-test:driver-integration-test-static",
   ]
   deps = [
     "//sdk/fidl/fuchsia.device:fuchsia.device_c",
@@ -51,17 +77,43 @@ static_library("ramdevice-client-static") {
     "ramdisk.cc",
     "ramnand.cc",
   ]
+  public_deps = [
+    # <ramdevice-client/ramnand.h> has #include <fuchsia/hardware/nand/c/fidl.h>
+    "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
+  ]
+  deps = [
+    "//sdk/fidl/fuchsia.device:fuchsia.device_c",
+    "//sdk/fidl/fuchsia.device:fuchsia.device_llcpp",
+    "//sdk/fidl/fuchsia.hardware.block:fuchsia.hardware.block_c",
+    "//sdk/fidl/fuchsia.hardware.ramdisk:fuchsia.hardware.ramdisk_c",
+    "//sdk/lib/fdio",
+    "//src/lib/ddk",
+    "//zircon/public/lib/fbl",
+    "//zircon/public/lib/zx",
+    "//zircon/system/ulib/fdio-caller",
+    "//zircon/system/ulib/fzl",
+  ]
+  configs += [ "//build/config/fuchsia:static_cpp_standard_library" ]
+}
+
+static_library("ramdevice-client-test-static") {
+  testonly = true
+  public_configs = [ ":headers_config" ]
+  public = [ "include/ramdevice-client-test/ramnandctl.h" ]
+  sources = [ "ramnandctl.cc" ]
   public_deps = [
     # <ramdevice-client/ramnand.h> has #include <lib/driver-integration-test/fixture.h>
     "//zircon/system/ulib/driver-integration-test:driver-integration-test-static",
 
     # <ramdevice-client/ramnand.h> has #include <fuchsia/hardware/nand/c/fidl.h>
+    ":ramdevice-client",
     "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
   ]
   deps = [
     "//sdk/fidl/fuchsia.device:fuchsia.device_c",
     "//sdk/fidl/fuchsia.device:fuchsia.device_llcpp",
     "//sdk/fidl/fuchsia.hardware.block:fuchsia.hardware.block_c",
+    "//sdk/fidl/fuchsia.hardware.nand:fuchsia.hardware.nand_c",
     "//sdk/fidl/fuchsia.hardware.ramdisk:fuchsia.hardware.ramdisk_c",
     "//sdk/lib/fdio",
     "//src/lib/ddk",

src/lib/storage/ramdevice_client/cpp/include/ramdevice-client-test/ramnandctl.h

@@ -0,0 +1,41 @@
+// Copyright 2021 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+#ifndef SRC_LIB_STORAGE_RAMDEVICE_CLIENT_CPP_INCLUDE_RAMDEVICE_CLIENT_TEST_RAMNANDCTL_H_
+#define SRC_LIB_STORAGE_RAMDEVICE_CLIENT_CPP_INCLUDE_RAMDEVICE_CLIENT_TEST_RAMNANDCTL_H_
+
+#include <lib/driver-integration-test/fixture.h>
+
+#include "src/lib/storage/ramdevice_client/cpp/include/ramdevice-client/ramnand.h"
+
+namespace ramdevice_client_test {
+
+using ramdevice_client::RamNand;
+
+class RamNandCtl : public fbl::RefCounted<RamNandCtl> {
+ public:
+  // Creates an isolated devmgr and spawns a ram_nand_ctl device in it.
+  static zx_status_t Create(fbl::RefPtr<RamNandCtl>* out);
+
+  static zx_status_t CreateWithRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
+                                       std::optional<RamNand>* out);
+
+  zx_status_t CreateRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
+                            std::optional<RamNand>* out);
+
+  ~RamNandCtl() = default;
+
+  const fbl::unique_fd& fd() { return ctl_; }
+  const fbl::unique_fd& devfs_root() { return devmgr_.devfs_root(); }
+
+ private:
+  RamNandCtl(driver_integration_test::IsolatedDevmgr devmgr, fbl::unique_fd ctl)
+      : devmgr_(std::move(devmgr)), ctl_(std::move(ctl)) {}
+
+  driver_integration_test::IsolatedDevmgr devmgr_;
+  fbl::unique_fd ctl_;
+};
+
+}  // namespace ramdevice_client_test
+
+#endif  // SRC_LIB_STORAGE_RAMDEVICE_CLIENT_CPP_INCLUDE_RAMDEVICE_CLIENT_TEST_RAMNANDCTL_H_

src/lib/storage/ramdevice_client/cpp/include/ramdevice-client/ramnand.h

@@ -7,7 +7,7 @@
 
 #include <fuchsia/hardware/nand/c/fidl.h>
 #include <inttypes.h>
-#include <lib/driver-integration-test/fixture.h>
+#include <lib/zx/channel.h>
 #include <zircon/compiler.h>
 
 #include <memory>
@@ -19,32 +19,6 @@
 
 namespace ramdevice_client {
 
-class RamNand;
-
-class RamNandCtl : public fbl::RefCounted<RamNandCtl> {
- public:
-  // Creates an isolated devmgr and spawns a ram_nand_ctl device in it.
-  static zx_status_t Create(fbl::RefPtr<RamNandCtl>* out);
-
-  static zx_status_t CreateWithRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
-                                       std::optional<RamNand>* out);
-
-  zx_status_t CreateRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
-                            std::optional<RamNand>* out);
-
-  ~RamNandCtl() = default;
-
-  const fbl::unique_fd& fd() { return ctl_; }
-  const fbl::unique_fd& devfs_root() { return devmgr_.devfs_root(); }
-
- private:
-  RamNandCtl(driver_integration_test::IsolatedDevmgr devmgr, fbl::unique_fd ctl)
-      : devmgr_(std::move(devmgr)), ctl_(std::move(ctl)) {}
-
-  driver_integration_test::IsolatedDevmgr devmgr_;
-  fbl::unique_fd ctl_;
-};
-
 class RamNand {
  public:
   static constexpr char kBasePath[] = "/dev/sys/platform/00:00:2e/nand-ctl";

src/lib/storage/ramdevice_client/cpp/ramnand.cc

@@ -56,84 +56,6 @@ zx_status_t WaitForFile(const fbl::unique_fd& dir, const char* file, fbl::unique
 
 namespace ramdevice_client {
 
-__EXPORT
-zx_status_t RamNandCtl::Create(fbl::RefPtr<RamNandCtl>* out) {
-  driver_integration_test::IsolatedDevmgr::Args args;
-  args.disable_block_watcher = true;
-  // TODO(surajmalhotra): Remove creation of isolated devmgr from this lib so that caller can choose
-  // their creation parameters.
-  args.board_name = "astro";
-
-  driver_integration_test::IsolatedDevmgr devmgr;
-  zx_status_t st = driver_integration_test::IsolatedDevmgr::Create(&args, &devmgr);
-  if (st != ZX_OK) {
-    fprintf(stderr, "Could not create ram_nand_ctl device, %d\n", st);
-    return st;
-  }
-
-  fbl::unique_fd ctl;
-  st = devmgr_integration_test::RecursiveWaitForFile(devmgr.devfs_root(),
-                                                     "sys/platform/00:00:2e/nand-ctl", &ctl);
-  if (st != ZX_OK) {
-    fprintf(stderr, "ram_nand_ctl device failed enumerated, %d\n", st);
-    return st;
-  }
-
-  *out = fbl::AdoptRef(new RamNandCtl(std::move(devmgr), std::move(ctl)));
-  return ZX_OK;
-}
-
-__EXPORT
-zx_status_t RamNandCtl::CreateRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
-                                      std::optional<RamNand>* out) {
-  fdio_t* io = fdio_unsafe_fd_to_io(fd().get());
-  if (io == NULL) {
-    fprintf(stderr, "Could not get fdio object\n");
-    return ZX_ERR_INTERNAL;
-  }
-  zx_handle_t ctl_svc = fdio_unsafe_borrow_channel(io);
-
-  char name[fuchsia_hardware_nand_NAME_LEN + 1];
-  size_t out_name_size;
-  zx_status_t status;
-  zx_status_t st = fuchsia_hardware_nand_RamNandCtlCreateDevice(
-      ctl_svc, config, &status, name, fuchsia_hardware_nand_NAME_LEN, &out_name_size);
-  fdio_unsafe_release(io);
-  if (st != ZX_OK || status != ZX_OK) {
-    st = st != ZX_OK ? st : status;
-    fprintf(stderr, "Could not create ram_nand device, %d\n", st);
-    return st;
-  }
-  name[out_name_size] = '\0';
-
-  // TODO(fxbug.dev/33003): We should be able to open relative to ctl->fd(), but
-  // due to a bug, we have to be relative to devfs_root instead.
-  fbl::StringBuffer<PATH_MAX> path;
-  path.Append("sys/platform/00:00:2e/nand-ctl/");
-  path.Append(name);
-  fprintf(stderr, "Trying to open (%s)\n", path.c_str());
-
-  fbl::unique_fd fd;
-  st = devmgr_integration_test::RecursiveWaitForFile(devfs_root(), path.c_str(), &fd);
-  if (st != ZX_OK) {
-    return st;
-  }
-
-  *out = RamNand(std::move(fd));
-  return ZX_OK;
-}
-
-__EXPORT
-zx_status_t RamNandCtl::CreateWithRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
-                                          std::optional<RamNand>* out) {
-  fbl::RefPtr<RamNandCtl> ctl;
-  zx_status_t st = RamNandCtl::Create(&ctl);
-  if (st != ZX_OK) {
-    return st;
-  }
-  return ctl->CreateRamNand(config, out);
-}
-
 __EXPORT
 zx_status_t RamNand::Create(const fuchsia_hardware_nand_RamNandInfo* config,
                             std::optional<RamNand>* out) {

src/lib/storage/ramdevice_client/cpp/ramnandctl.cc

@@ -0,0 +1,107 @@
+// Copyright 2021 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include <fcntl.h>
+#include <fidl/fuchsia.device/cpp/wire.h>
+#include <fuchsia/device/c/fidl.h>
+#include <fuchsia/hardware/nand/c/fidl.h>
+#include <lib/fdio/cpp/caller.h>
+#include <lib/fdio/directory.h>
+#include <lib/fdio/fd.h>
+#include <lib/fdio/fdio.h>
+#include <lib/fdio/unsafe.h>
+#include <lib/fdio/watcher.h>
+#include <limits.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/stat.h>
+#include <zircon/types.h>
+
+#include <utility>
+
+#include <fbl/string_buffer.h>
+#include <fbl/unique_fd.h>
+#include <ramdevice-client-test/ramnandctl.h>
+
+namespace ramdevice_client_test {
+
+__EXPORT
+zx_status_t RamNandCtl::Create(fbl::RefPtr<RamNandCtl>* out) {
+  driver_integration_test::IsolatedDevmgr::Args args;
+  args.disable_block_watcher = true;
+  // TODO(surajmalhotra): Remove creation of isolated devmgr from this lib so that caller can choose
+  // their creation parameters.
+  args.board_name = "astro";
+
+  driver_integration_test::IsolatedDevmgr devmgr;
+  zx_status_t st = driver_integration_test::IsolatedDevmgr::Create(&args, &devmgr);
+  if (st != ZX_OK) {
+    fprintf(stderr, "Could not create ram_nand_ctl device, %d\n", st);
+    return st;
+  }
+
+  fbl::unique_fd ctl;
+  st = devmgr_integration_test::RecursiveWaitForFile(devmgr.devfs_root(),
+                                                     "sys/platform/00:00:2e/nand-ctl", &ctl);
+  if (st != ZX_OK) {
+    fprintf(stderr, "ram_nand_ctl device failed enumerated, %d\n", st);
+    return st;
+  }
+
+  *out = fbl::AdoptRef(new RamNandCtl(std::move(devmgr), std::move(ctl)));
+  return ZX_OK;
+}
+
+__EXPORT
+zx_status_t RamNandCtl::CreateRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
+                                      std::optional<RamNand>* out) {
+  fdio_t* io = fdio_unsafe_fd_to_io(fd().get());
+  if (io == NULL) {
+    fprintf(stderr, "Could not get fdio object\n");
+    return ZX_ERR_INTERNAL;
+  }
+  zx_handle_t ctl_svc = fdio_unsafe_borrow_channel(io);
+
+  char name[fuchsia_hardware_nand_NAME_LEN + 1];
+  size_t out_name_size;
+  zx_status_t status;
+  zx_status_t st = fuchsia_hardware_nand_RamNandCtlCreateDevice(
+      ctl_svc, config, &status, name, fuchsia_hardware_nand_NAME_LEN, &out_name_size);
+  fdio_unsafe_release(io);
+  if (st != ZX_OK || status != ZX_OK) {
+    st = st != ZX_OK ? st : status;
+    fprintf(stderr, "Could not create ram_nand device, %d\n", st);
+    return st;
+  }
+  name[out_name_size] = '\0';
+
+  // TODO(fxbug.dev/33003): We should be able to open relative to ctl->fd(), but
+  // due to a bug, we have to be relative to devfs_root instead.
+  fbl::StringBuffer<PATH_MAX> path;
+  path.Append("sys/platform/00:00:2e/nand-ctl/");
+  path.Append(name);
+  fprintf(stderr, "Trying to open (%s)\n", path.c_str());
+
+  fbl::unique_fd fd;
+  st = devmgr_integration_test::RecursiveWaitForFile(devfs_root(), path.c_str(), &fd);
+  if (st != ZX_OK) {
+    return st;
+  }
+
+  *out = RamNand(std::move(fd));
+  return ZX_OK;
+}
+
+__EXPORT
+zx_status_t RamNandCtl::CreateWithRamNand(const fuchsia_hardware_nand_RamNandInfo* config,
+                                          std::optional<RamNand>* out) {
+  fbl::RefPtr<RamNandCtl> ctl;
+  zx_status_t st = RamNandCtl::Create(&ctl);
+  if (st != ZX_OK) {
+    return st;
+  }
+  return ctl->CreateRamNand(config, out);
+}
+
+}  // namespace ramdevice_client_test