CA-408492: Add back receive_finalize2

Similar to receive_start2

Signed-off-by: Vincent Liu <[email protected]>

Author: Vincent-lau

ocaml/xapi-idl/storage/storage_interface.ml

@@ -1168,6 +1168,15 @@ module StorageAPI (R : RPC) = struct
         declare "DATA.MIRROR.receive_finalize" []
           (dbg_p @-> id_p @-> returning unit_p err)
 
+      (** 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
@@ -1316,6 +1325,8 @@ module type MIRROR = sig
 
   val receive_finalize : context -> dbg:debug_info -> id:Mirror.id -> unit
 
+  val receive_finalize2 : context -> dbg:debug_info -> id:Mirror.id -> unit
+
   val receive_finalize3 :
        context
     -> dbg:debug_info
@@ -1817,6 +1828,9 @@ 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 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

ocaml/xapi-idl/storage/storage_skeleton.ml

@@ -178,6 +178,8 @@ module DATA = struct
 
     let receive_finalize ctx ~dbg ~id = u "DATA.MIRROR.receive_finalize"
 
+    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"
 

ocaml/xapi-storage-script/main.ml

@@ -1925,6 +1925,7 @@ let bind ~volume_script_dir =
   S.DATA.MIRROR.receive_start2 (u "DATA.MIRROR.receive_start2") ;
   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") ;

ocaml/xapi/storage_mux.ml

@@ -861,6 +861,11 @@ 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 ~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__
 

ocaml/xapi/storage_smapiv1.ml

@@ -1153,6 +1153,8 @@ module SMAPIv1 : Server_impl = struct
 
       let receive_finalize _context ~dbg:_ ~id:_ = assert false
 
+      let receive_finalize2 _context ~dbg:_ ~id:_ = assert false
+
       let receive_finalize3 _context ~dbg:_ ~mirror_id:_ ~sr:_ ~url:_
           ~verify_dest:_ =
         assert false

ocaml/xapi/storage_smapiv1_migrate.ml

@@ -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_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
+  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

ocaml/xapi/storage_smapiv1_wrapper.ml

@@ -1218,6 +1218,10 @@ 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 ~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 *)

ocaml/xapi/storage_smapiv3_migrate.ml

@@ -35,6 +35,8 @@ module MIRROR : SMAPIv2_MIRROR = struct
 
   let receive_finalize _ctx = u __FUNCTION__
 
+  let receive_finalize2 _ctx = u __FUNCTION__
+
   let receive_finalize3 _ctx = u __FUNCTION__
 
   let receive_cancel _ctx = u __FUNCTION__