CA-408492: Add back receive_finalize2 as well (#6465)

edwintorok · web-flow · commit 62852225a7b0 · 2025-05-13T08:15:57.000Z
Sorry guys, forgot about `receive_finalize2` 🤪. I hope there is no
more....
diff --git a/ocaml/xapi-idl/storage/storage_interface.ml b/ocaml/xapi-idl/storage/storage_interface.ml
@@ -1143,7 +1143,7 @@ module StorageAPI (R : RPC) = struct
           )
 
       (** Called on the receiving end to prepare for receipt of the storage. This
-      function should be used in conjunction with [receive_finalize2]*)
+      function should be used in conjunction with [receive_finalize3]*)
       let receive_start3 =
         let similar_p = Param.mk ~name:"similar" Mirror.similars in
         let result = Param.mk ~name:"result" Mirror.mirror_receive_result in
@@ -1162,18 +1162,27 @@ module StorageAPI (R : RPC) = struct
       (** Called on the receiving end 
         @deprecated This function is deprecated, and is only here to keep backward 
         compatibility with old xapis that call Remote.DATA.MIRROR.receive_finalize
-        during SXM.  Use the receive_finalize2 function instead. 
+        during SXM.  Use the receive_finalize3 function instead. 
       *)
       let receive_finalize =
         declare "DATA.MIRROR.receive_finalize" []
           (dbg_p @-> id_p @-> returning unit_p err)
 
-      (** [receive_finalize2 dbg id] will stop the mirroring process and compose 
+      (** Called on the receiving end 
+        @deprecated This function is deprecated, and is only here to keep backward 
+        compatibility with old xapis that call Remote.DATA.MIRROR.receive_finalize
+        during SXM.  Use the receive_finalize3 function instead. 
+      *)
+      let receive_finalize2 =
+        declare "DATA.MIRROR.receive_finalize2" []
+          (dbg_p @-> id_p @-> returning unit_p err)
+
+      (** [receive_finalize3 dbg id] will stop the mirroring process and compose 
       the snapshot VDI with the mirror VDI. It also cleans up the storage resources 
       used by mirroring. It is called after the the source VM is paused. This fucntion
       should be used in conjunction with [receive_start3] *)
-      let receive_finalize2 =
-        declare "DATA.MIRROR.receive_finalize2" []
+      let receive_finalize3 =
+        declare "DATA.MIRROR.receive_finalize3" []
           (dbg_p
           @-> id_p
           @-> sr_p
@@ -1316,7 +1325,9 @@ module type MIRROR = sig
 
   val receive_finalize : context -> dbg:debug_info -> id:Mirror.id -> unit
 
-  val receive_finalize2 :
+  val receive_finalize2 : context -> dbg:debug_info -> id:Mirror.id -> unit
+
+  val receive_finalize3 :
        context
     -> dbg:debug_info
     -> mirror_id:Mirror.id
@@ -1817,8 +1828,11 @@ module Server (Impl : Server_impl) () = struct
     S.DATA.MIRROR.receive_finalize (fun dbg id ->
         Impl.DATA.MIRROR.receive_finalize () ~dbg ~id
     ) ;
-    S.DATA.MIRROR.receive_finalize2 (fun dbg mirror_id sr url verify_dest ->
-        Impl.DATA.MIRROR.receive_finalize2 () ~dbg ~mirror_id ~sr ~url
+    S.DATA.MIRROR.receive_finalize2 (fun dbg id ->
+        Impl.DATA.MIRROR.receive_finalize2 () ~dbg ~id
+    ) ;
+    S.DATA.MIRROR.receive_finalize3 (fun dbg mirror_id sr url verify_dest ->
+        Impl.DATA.MIRROR.receive_finalize3 () ~dbg ~mirror_id ~sr ~url
           ~verify_dest
     ) ;
     S.DATA.MIRROR.pre_deactivate_hook (fun dbg dp sr vdi ->
diff --git a/ocaml/xapi-idl/storage/storage_skeleton.ml b/ocaml/xapi-idl/storage/storage_skeleton.ml
@@ -178,8 +178,10 @@ module DATA = struct
 
     let receive_finalize ctx ~dbg ~id = u "DATA.MIRROR.receive_finalize"
 
-    let receive_finalize2 ctx ~dbg ~mirror_id ~sr ~url ~verify_dest =
-      u "DATA.MIRROR.receive_finalize2"
+    let receive_finalize2 ctx ~dbg ~id = u "DATA.MIRROR.receive_finalize2"
+
+    let receive_finalize3 ctx ~dbg ~mirror_id ~sr ~url ~verify_dest =
+      u "DATA.MIRROR.receive_finalize3"
 
     let receive_cancel ctx ~dbg ~id = u "DATA.MIRROR.receive_cancel"
 
diff --git a/ocaml/xapi-storage-script/main.ml b/ocaml/xapi-storage-script/main.ml
@@ -1926,6 +1926,7 @@ let bind ~volume_script_dir =
   S.DATA.MIRROR.receive_start3 (u "DATA.MIRROR.receive_start3") ;
   S.DATA.MIRROR.receive_finalize (u "DATA.MIRROR.receive_finalize") ;
   S.DATA.MIRROR.receive_finalize2 (u "DATA.MIRROR.receive_finalize2") ;
+  S.DATA.MIRROR.receive_finalize3 (u "DATA.MIRROR.receive_finalize3") ;
   S.DATA.MIRROR.receive_cancel (u "DATA.MIRROR.receive_cancel") ;
   S.DATA.MIRROR.receive_cancel2 (u "DATA.MIRROR.receive_cancel2") ;
   S.DATA.MIRROR.pre_deactivate_hook (u "DATA.MIRROR.pre_deactivate_hook") ;
diff --git a/ocaml/xapi/storage_migrate.ml b/ocaml/xapi/storage_migrate.ml
@@ -40,11 +40,11 @@ let choose_backend dbg sr =
 (** module [MigrateRemote] is similar to [MigrateLocal], but most of these functions
 tend to be executed on the receiver side. *)
 module MigrateRemote = struct
-  (** [receive_finalize2 dbg mirror_id sr url verify_dest] takes an [sr] parameter
+  (** [receive_finalize3 dbg mirror_id sr url verify_dest] takes an [sr] parameter
   which is the source sr and multiplexes based on the type of that *)
-  let receive_finalize2 ~dbg ~mirror_id ~sr ~url ~verify_dest =
+  let receive_finalize3 ~dbg ~mirror_id ~sr ~url ~verify_dest =
     let (module Migrate_Backend) = choose_backend dbg sr in
-    Migrate_Backend.receive_finalize2 () ~dbg ~mirror_id ~sr ~url ~verify_dest
+    Migrate_Backend.receive_finalize3 () ~dbg ~mirror_id ~sr ~url ~verify_dest
 
   let receive_cancel2 ~dbg ~mirror_id ~url ~verify_dest =
     let (module Remote) =
@@ -332,12 +332,12 @@ let post_deactivate_hook ~sr ~vdi ~dp:_ =
              r.remote_info
          in
          let (module Remote) = get_remote_backend r.url verify_dest in
-         debug "Calling receive_finalize2" ;
+         debug "Calling receive_finalize3" ;
          log_and_ignore_exn (fun () ->
-             MigrateRemote.receive_finalize2 ~dbg:"Mirror-cleanup" ~mirror_id:id
+             MigrateRemote.receive_finalize3 ~dbg:"Mirror-cleanup" ~mirror_id:id
                ~sr ~url:r.url ~verify_dest
          ) ;
-         debug "Finished calling receive_finalize2" ;
+         debug "Finished calling receive_finalize3" ;
          State.remove_local_mirror id ;
          debug "Removed active local mirror: %s" id ;
          Option.iter (fun id -> Scheduler.cancel scheduler id) r.watchdog
diff --git a/ocaml/xapi/storage_mux.ml b/ocaml/xapi/storage_mux.ml
@@ -861,7 +861,12 @@ module Mux = struct
         info "%s dbg: %s mirror_id: %s" __FUNCTION__ dbg id ;
         Storage_smapiv1_migrate.MIRROR.receive_finalize () ~dbg:di.log ~id
 
-      let receive_finalize2 () ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_ ~verify_dest:_ =
+      let receive_finalize2 () ~dbg ~id =
+        with_dbg ~name:"DATA.MIRROR.receive_finalize2" ~dbg @@ fun di ->
+        info "%s dbg: %s mirror_id: %s" __FUNCTION__ dbg id ;
+        Storage_smapiv1_migrate.MIRROR.receive_finalize2 () ~dbg:di.log ~id
+
+      let receive_finalize3 () ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_ ~verify_dest:_ =
         u __FUNCTION__
 
       let receive_cancel () ~dbg ~id =
diff --git a/ocaml/xapi/storage_smapiv1.ml b/ocaml/xapi/storage_smapiv1.ml
@@ -1153,7 +1153,9 @@ module SMAPIv1 : Server_impl = struct
 
       let receive_finalize _context ~dbg:_ ~id:_ = assert false
 
-      let receive_finalize2 _context ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_
+      let receive_finalize2 _context ~dbg:_ ~id:_ = assert false
+
+      let receive_finalize3 _context ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_
           ~verify_dest:_ =
         assert false
 
diff --git a/ocaml/xapi/storage_smapiv1_migrate.ml b/ocaml/xapi/storage_smapiv1_migrate.ml
@@ -681,7 +681,7 @@ module MIRROR : SMAPIv2_MIRROR = struct
          stored in memory on different hosts. If receive_start is called, by an older
          host, this State.add is run on the destination host. On the other hand, if
          receive_start3 is called, this will be stored in memory on the source host.
-         receive_finalize2 and receive_cancel2 handles this similarly. *)
+         receive_finalize3 and receive_cancel2 handles this similarly. *)
       State.add id
         State.(
           Recv_op
@@ -749,12 +749,7 @@ module MIRROR : SMAPIv2_MIRROR = struct
     Option.iter (fun r -> Local.DP.destroy dbg r.leaf_dp false) recv_state ;
     State.remove_receive_mirror id
 
-  let receive_finalize2 _ctx ~dbg ~mirror_id ~sr ~url ~verify_dest =
-    D.debug "%s dbg:%s id: %s sr: %s url: %s verify_dest: %B" __FUNCTION__ dbg
-      mirror_id (s_of_sr sr) url verify_dest ;
-    let (module Remote) =
-      Storage_migrate_helper.get_remote_backend url verify_dest
-    in
+  let receive_finalize_common ~dbg ~mirror_id (module SMAPI : SMAPIv2) =
     let recv_state = State.find_active_receive_mirror mirror_id in
     let open State.Receive_state in
     Option.iter
@@ -764,16 +759,28 @@ module MIRROR : SMAPIv2_MIRROR = struct
           __FUNCTION__ (Sr.string_of r.sr)
           (Vdi.string_of r.parent_vdi)
           (Vdi.string_of r.leaf_vdi) ;
-        Remote.DP.destroy2 dbg r.leaf_dp r.sr r.leaf_vdi r.mirror_vm false ;
-        Remote.VDI.compose dbg r.sr r.parent_vdi r.leaf_vdi ;
+        SMAPI.DP.destroy2 dbg r.leaf_dp r.sr r.leaf_vdi r.mirror_vm false ;
+        SMAPI.VDI.compose dbg r.sr r.parent_vdi r.leaf_vdi ;
         (* On SMAPIv3, compose would have removed the now invalid dummy vdi, so
            there is no need to destroy it anymore, while this is necessary on SMAPIv1 SRs. *)
-        D.log_and_ignore_exn (fun () -> Remote.VDI.destroy dbg r.sr r.dummy_vdi) ;
-        Remote.VDI.remove_from_sm_config dbg r.sr r.leaf_vdi "base_mirror"
+        D.log_and_ignore_exn (fun () -> SMAPI.VDI.destroy dbg r.sr r.dummy_vdi) ;
+        SMAPI.VDI.remove_from_sm_config dbg r.sr r.leaf_vdi "base_mirror"
       )
       recv_state ;
     State.remove_receive_mirror mirror_id
 
+  let receive_finalize2 _ctx ~dbg ~id =
+    D.debug "%s dbg:%s id: %s" __FUNCTION__ dbg id ;
+    receive_finalize_common ~dbg ~mirror_id:id (module Local)
+
+  let receive_finalize3 _ctx ~dbg ~mirror_id ~sr ~url ~verify_dest =
+    D.debug "%s dbg:%s id: %s sr: %s url: %s verify_dest: %B" __FUNCTION__ dbg
+      mirror_id (s_of_sr sr) url verify_dest ;
+    let (module Remote) =
+      Storage_migrate_helper.get_remote_backend url verify_dest
+    in
+    receive_finalize_common ~dbg ~mirror_id (module Remote)
+
   let receive_cancel _ctx ~dbg ~id =
     D.debug "%s dbg:%s mirror_id:%s" __FUNCTION__ dbg id ;
     let receive_state = State.find_active_receive_mirror id in
diff --git a/ocaml/xapi/storage_smapiv1_wrapper.ml b/ocaml/xapi/storage_smapiv1_wrapper.ml
@@ -1218,7 +1218,11 @@ functor
           info "DATA.MIRROR.receive_finalize dbg:%s id:%s" dbg id ;
           Impl.DATA.MIRROR.receive_finalize context ~dbg ~id
 
-        let receive_finalize2 _context ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_
+        let receive_finalize2 context ~dbg ~id =
+          info "DATA.MIRROR.receive_finalize2 dbg:%s id:%s" dbg id ;
+          Impl.DATA.MIRROR.receive_finalize2 context ~dbg ~id
+
+        let receive_finalize3 _context ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_
             ~verify_dest:_ =
           (* see storage_smapiv{1,3}_migrate *)
           u __FUNCTION__
diff --git a/ocaml/xapi/storage_smapiv3_migrate.ml b/ocaml/xapi/storage_smapiv3_migrate.ml
@@ -37,6 +37,8 @@ module MIRROR : SMAPIv2_MIRROR = struct
 
   let receive_finalize2 _ctx = u __FUNCTION__
 
+  let receive_finalize3 _ctx = u __FUNCTION__
+
   let receive_cancel _ctx = u __FUNCTION__
 
   let receive_cancel2 _ctx = u __FUNCTION__
