tools/rbd: add support of new device type for ubbd

yangdongsheng · yangdongsheng · commit 54853a5ae760 · 2023-05-18T12:35:39.000Z
ubbd (Userspace Backend Block Device) is a method to build block device and handle IO by process started in userspace. That means we can provide a generic block device to user and handle IO requests by librbd in linux. This way, we can allow user to use rbd image as a linux block device supporting full image features, especial the journaling feature, which is not supported by krbd. For more information: https://github.com/DataTravelGuide/ubbd Signed-off-by: Dongsheng Yang <dongsheng.yang.linux@gmail.com>
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -270,6 +270,14 @@ CMAKE_DEPENDENT_OPTION(WITH_RBD_SSD_CACHE "Enable librbd persistent write back c
 CMAKE_DEPENDENT_OPTION(WITH_SYSTEM_PMDK "Require and build with system PMDK" OFF
   "WITH_RBD_RWL OR WITH_BLUESTORE_PMEM" OFF)
 
+CMAKE_DEPENDENT_OPTION(WITH_RBD_UBBD "Enable ubbd support for rbd device utility" OFF
+    "WITH_RBD" OFF)
+
+if(WITH_RBD_UBBD)
+  include(BuildUBBD)
+  build_ubbd()
+endif()
+
 if(WITH_BLUESTORE_PMEM)
   set(HAVE_BLUESTORE_PMEM ON)
 endif()
diff --git a/cmake/modules/BuildUBBD.cmake b/cmake/modules/BuildUBBD.cmake
@@ -0,0 +1,22 @@
+function(build_ubbd)
+  include(FindMake)
+  find_make("MAKE_EXECUTABLE" "make_cmd")
+
+  include(ExternalProject)
+  ExternalProject_Add(ubbd_ext
+    UPDATE_COMMAND "" # this disables rebuild on each run
+    GIT_REPOSITORY "https://github.com/DataTravelGuide/ubbd.git"
+    GIT_CONFIG advice.detachedHead=false
+    GIT_SHALLOW 1
+    GIT_TAG "v0.1.4"
+    SOURCE_DIR "${CMAKE_BINARY_DIR}/src/ubbd"
+    BUILD_IN_SOURCE 1
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ${make_cmd} libubbd
+    INSTALL_COMMAND ""
+    LOG_CONFIGURE ON
+    LOG_BUILD ON
+    LOG_INSTALL ON
+    LOG_MERGED_STDOUTERR ON
+    LOG_OUTPUT_ON_FAILURE ON)
+endfunction()
diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
@@ -260,7 +260,7 @@ Commands
 
 :command:`device map` [-t | --device-type *device-type*] [--cookie *device-cookie*] [--show-cookie] [--snap-id *snap-id*] [--read-only] [--exclusive] [-o | --options *device-options*] *image-spec* | *snap-spec*
   Map the specified image to a block device via the rbd kernel module
-  (default) or other supported device (*nbd* on Linux or *ggate* on
+  (default) or other supported device (*nbd* or *ubbd* on Linux or *ggate* on
   FreeBSD).
 
   The --options argument is a comma separated list of device type
diff --git a/src/include/config-h.in.cmake b/src/include/config-h.in.cmake
@@ -148,6 +148,9 @@
 /* define if kernel rbd enabled */
 #cmakedefine WITH_KRBD
 
+/* define if rbd ubbd enabled */
+#cmakedefine WITH_RBD_UBBD
+
 /* define if key-value-store is enabled */
 #cmakedefine WITH_KVS
 
diff --git a/src/test/cli/rbd/help.t b/src/test/cli/rbd/help.t
@@ -594,7 +594,7 @@
                              ])
   
   Optional arguments
-    -t [ --device-type ] arg device type [ggate, krbd (default), nbd]
+    -t [ --device-type ] arg device type [ggate, krbd (default), nbd, ubbd]
     -p [ --pool ] arg        pool name
     --namespace arg          namespace name
     --image arg              image name
@@ -625,7 +625,7 @@
                                     p-name>] or <device-path>
   
   Optional arguments
-    -t [ --device-type ] arg        device type [ggate, krbd (default), nbd]
+    -t [ --device-type ] arg        device type [ggate, krbd (default), nbd, ubbd]
     -p [ --pool ] arg               pool name
     --namespace arg                 namespace name
     --image arg                     image name
@@ -640,7 +640,7 @@
   List mapped rbd images.
   
   Optional arguments
-    -t [ --device-type ] arg device type [ggate, krbd (default), nbd]
+    -t [ --device-type ] arg device type [ggate, krbd (default), nbd, ubbd]
     --format arg             output format (plain, json, or xml) [default: plain]
     --pretty-format          pretty formatting (json and xml)
   
@@ -662,7 +662,7 @@
                              ])
   
   Optional arguments
-    -t [ --device-type ] arg device type [ggate, krbd (default), nbd]
+    -t [ --device-type ] arg device type [ggate, krbd (default), nbd, ubbd]
     -p [ --pool ] arg        pool name
     --namespace arg          namespace name
     --image arg              image name
@@ -691,7 +691,7 @@
                                     p-name>] or <device-path>
   
   Optional arguments
-    -t [ --device-type ] arg        device type [ggate, krbd (default), nbd]
+    -t [ --device-type ] arg        device type [ggate, krbd (default), nbd, ubbd]
     -p [ --pool ] arg               pool name
     --namespace arg                 namespace name
     --image arg                     image name
diff --git a/src/tools/rbd/CMakeLists.txt b/src/tools/rbd/CMakeLists.txt
@@ -52,6 +52,7 @@ set(rbd_srcs
   action/Status.cc
   action/TrashPurgeSchedule.cc
   action/Trash.cc
+  action/Ubbd.cc
   action/Watch.cc
   action/Wnbd.cc)
 
@@ -73,8 +74,19 @@ if(CURSES_FOUND)
   target_link_libraries(rbd ${CURSES_LIBRARIES})
 endif()
 if(WITH_KRBD)
-  target_link_libraries(rbd 
+  target_link_libraries(rbd
     krbd)
 endif()
+if(WITH_RBD_UBBD)
+  target_link_directories(rbd
+    PRIVATE ${CMAKE_BINARY_DIR}/src/ubbd/lib/)
+  target_include_directories(rbd
+    PRIVATE ${CMAKE_BINARY_DIR}/src/ubbd/include)
+  target_include_directories(rbd
+    PRIVATE ${CMAKE_BINARY_DIR}/src/ubbd/include/ubbd-headers/)
+  target_link_libraries(rbd
+    ubbd)
+  add_dependencies(rbd ubbd_ext)
+endif()
 
 install(TARGETS rbd DESTINATION bin)
diff --git a/src/tools/rbd/action/Device.cc b/src/tools/rbd/action/Device.cc
@@ -33,6 +33,7 @@ DECLARE_DEVICE_OPERATIONS(ggate);
 DECLARE_DEVICE_OPERATIONS(kernel);
 DECLARE_DEVICE_OPERATIONS(nbd);
 DECLARE_DEVICE_OPERATIONS(wnbd);
+DECLARE_DEVICE_OPERATIONS(ubbd);
 
 namespace device {
 
@@ -83,11 +84,20 @@ const DeviceOperations wnbd_operations = {
   wnbd::execute_detach,
 };
 
+const DeviceOperations ubbd_operations = {
+  ubbd::execute_list,
+  ubbd::execute_map,
+  ubbd::execute_unmap,
+  ubbd::execute_attach,
+  ubbd::execute_detach,
+};
+
 enum device_type_t {
   DEVICE_TYPE_GGATE,
   DEVICE_TYPE_KRBD,
   DEVICE_TYPE_NBD,
   DEVICE_TYPE_WNBD,
+  DEVICE_TYPE_UBBD,
 };
 
 struct DeviceType {};
@@ -107,6 +117,8 @@ void validate(boost::any& v, const std::vector<std::string>& values,
     v = boost::any(DEVICE_TYPE_GGATE);
   } else if (s == "krbd") {
     v = boost::any(DEVICE_TYPE_KRBD);
+  } else if (s == "ubbd") {
+    v = boost::any(DEVICE_TYPE_UBBD);
   #endif /* _WIN32 */
   } else {
     throw po::validation_error(po::validation_error::invalid_option_value);
@@ -119,7 +131,7 @@ void add_device_type_option(po::options_description *options) {
 #ifdef _WIN32
      "device type [wnbd]");
 #else
-     "device type [ggate, krbd (default), nbd]");
+     "device type [ggate, krbd (default), nbd, ubbd]");
 #endif
 }
 
@@ -150,6 +162,8 @@ const DeviceOperations *get_device_operations(const po::variables_map &vm) {
     return &nbd_operations;
   case DEVICE_TYPE_WNBD:
     return &wnbd_operations;
+  case DEVICE_TYPE_UBBD:
+    return &ubbd_operations;
   default:
     ceph_abort();
     return nullptr;
diff --git a/src/tools/rbd/action/Ubbd.cc b/src/tools/rbd/action/Ubbd.cc
