CA-408492: Add back receive_start2 for backwards compat

This function was introduced during the development of inbound SXM for
SMAPIv3, but was used in SMAPIv1 migrations as well as SMAPIv1 ->
SMAPIv3 migration, so add this back to SMAPIv2 for backwards
compatibility.

Migrations from xapi-(25.3.0 -- 25.17.0) would otherwise be broken if
they were migrating to the latest version of xapi. Yangtze, however, is
not affected.

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

Author: Vincent-lau

ocaml/xapi-idl/storage/storage_interface.ml

@@ -1124,6 +1124,24 @@ module StorageAPI (R : RPC) = struct
           @-> returning result 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_start2 during SXM. 
+        Use the receive_start3 function instead. 
+      *)
+      let receive_start2 =
+        let similar_p = Param.mk ~name:"similar" Mirror.similars in
+        let result = Param.mk ~name:"result" Mirror.mirror_receive_result in
+        declare "DATA.MIRROR.receive_start2" []
+          (dbg_p
+          @-> sr_p
+          @-> VDI.vdi_info_p
+          @-> id_p
+          @-> similar_p
+          @-> vm_p
+          @-> returning result err
+          )
+
       (** Called on the receiving end to prepare for receipt of the storage. This
       function should be used in conjunction with [receive_finalize2]*)
       let receive_start3 =
@@ -1274,6 +1292,16 @@ module type MIRROR = sig
     -> similar:Mirror.similars
     -> Mirror.mirror_receive_result
 
+  val receive_start2 :
+       context
+    -> dbg:debug_info
+    -> sr:sr
+    -> vdi_info:vdi_info
+    -> id:Mirror.id
+    -> similar:Mirror.similars
+    -> vm:vm
+    -> Mirror.mirror_receive_result
+
   val receive_start3 :
        context
     -> dbg:debug_info
@@ -1772,6 +1800,9 @@ module Server (Impl : Server_impl) () = struct
     S.DATA.MIRROR.receive_start (fun dbg sr vdi_info id similar ->
         Impl.DATA.MIRROR.receive_start () ~dbg ~sr ~vdi_info ~id ~similar
     ) ;
+    S.DATA.MIRROR.receive_start2 (fun dbg sr vdi_info id similar vm ->
+        Impl.DATA.MIRROR.receive_start2 () ~dbg ~sr ~vdi_info ~id ~similar ~vm
+    ) ;
     S.DATA.MIRROR.receive_start3
       (fun dbg sr vdi_info mirror_id similar vm url verify_dest ->
         Impl.DATA.MIRROR.receive_start3 () ~dbg ~sr ~vdi_info ~mirror_id

ocaml/xapi-idl/storage/storage_skeleton.ml

@@ -169,6 +169,9 @@ module DATA = struct
     let receive_start ctx ~dbg ~sr ~vdi_info ~id ~similar =
       u "DATA.MIRROR.receive_start"
 
+    let receive_start2 ctx ~dbg ~sr ~vdi_info ~id ~similar ~vm =
+      u "DATA.MIRROR.receive_start2"
+
     let receive_start3 ctx ~dbg ~sr ~vdi_info ~mirror_id ~similar ~vm ~url
         ~verify_dest =
       u "DATA.MIRROR.receive_start3"

ocaml/xapi-storage-script/main.ml

@@ -1922,6 +1922,7 @@ let bind ~volume_script_dir =
   S.DP.stat_vdi (u "DP.stat_vdi") ;
   S.DATA.MIRROR.send_start (u "DATA.MIRROR.send_start") ;
   S.DATA.MIRROR.receive_start (u "DATA.MIRROR.receive_start") ;
+  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") ;

ocaml/xapi/storage_mux.ml

@@ -837,6 +837,20 @@ module Mux = struct
         Storage_smapiv1_migrate.MIRROR.receive_start () ~dbg ~sr ~vdi_info ~id
           ~similar
 
+      let receive_start2 () ~dbg ~sr ~vdi_info ~id ~similar ~vm =
+        with_dbg ~name:"DATA.MIRROR.receive_start2" ~dbg @@ fun _di ->
+        info "%s dbg: %s sr: %s vdi_info: %s mirror_id: %s similar: %s vm: %s"
+          __FUNCTION__ dbg (s_of_sr sr)
+          (string_of_vdi_info vdi_info)
+          id
+          (String.concat ";" similar)
+          (s_of_vm vm) ;
+        info "%s dbg:%s" __FUNCTION__ dbg ;
+        (* This goes straight to storage_smapiv1_migrate for backwards compatability
+           reasons, new code should not call receive_start any more *)
+        Storage_smapiv1_migrate.MIRROR.receive_start2 () ~dbg ~sr ~vdi_info ~id
+          ~similar ~vm
+
       (** see storage_smapiv{1,3}_migrate.receive_start3 *)
       let receive_start3 () ~dbg:_ ~sr:_ ~vdi_info:_ ~mirror_id:_ ~similar:_
           ~vm:_ =

ocaml/xapi/storage_smapiv1.ml

@@ -1143,6 +1143,10 @@ module SMAPIv1 : Server_impl = struct
       let receive_start _context ~dbg:_ ~sr:_ ~vdi_info:_ ~id:_ ~similar:_ =
         assert false
 
+      let receive_start2 _context ~dbg:_ ~sr:_ ~vdi_info:_ ~id:_ ~similar:_
+          ~vm:_ =
+        assert false
+
       let receive_start3 _context ~dbg:_ ~sr:_ ~vdi_info:_ ~mirror_id:_
           ~similar:_ ~vm:_ ~url:_ ~verify_dest:_ =
         assert false

ocaml/xapi/storage_smapiv1_migrate.ml

@@ -724,6 +724,12 @@ module MIRROR : SMAPIv2_MIRROR = struct
     receive_start_common ~dbg ~sr ~vdi_info ~id ~similar ~vm:(Vm.of_string "0")
       (module Local)
 
+  let receive_start2 _ctx ~dbg ~sr ~vdi_info ~id ~similar ~vm =
+    D.debug "%s dbg: %s sr: %s vdi: %s id: %s" __FUNCTION__ dbg (s_of_sr sr)
+      (string_of_vdi_info vdi_info)
+      id ;
+    receive_start_common ~dbg ~sr ~vdi_info ~id ~similar ~vm (module Local)
+
   let receive_start3 _ctx ~dbg ~sr ~vdi_info ~mirror_id ~similar ~vm ~url
       ~verify_dest =
     D.debug "%s dbg: %s sr: %s vdi: %s id: %s vm: %s url: %s verify_dest: %B"

ocaml/xapi/storage_smapiv1_wrapper.ml

@@ -1200,8 +1200,18 @@ functor
             (String.concat "," similar) ;
           Impl.DATA.MIRROR.receive_start context ~dbg ~sr ~vdi_info ~id ~similar
 
+        let receive_start2 context ~dbg ~sr ~vdi_info ~id ~similar ~vm =
+          info
+            "DATA.MIRROR.receive_start2 dbg:%s sr:%s id:%s similar:[%s] vm:%s"
+            dbg (s_of_sr sr) id
+            (String.concat "," similar)
+            (s_of_vm vm) ;
+          Impl.DATA.MIRROR.receive_start2 context ~dbg ~sr ~vdi_info ~id
+            ~similar ~vm
+
         let receive_start3 _context ~dbg:_ ~sr:_ ~vdi_info:_ ~mirror_id:_
             ~similar:_ ~vm:_ =
+          (* See Storage_smapiv1_migrate.receive_start3 *)
           u __FUNCTION__
 
         let receive_finalize context ~dbg ~id =

ocaml/xapi/storage_smapiv3_migrate.ml

@@ -29,6 +29,8 @@ module MIRROR : SMAPIv2_MIRROR = struct
 
   let receive_start _ctx = u __FUNCTION__
 
+  let receive_start2 _ctx = u __FUNCTION__
+
   let receive_start3 _ctx = u __FUNCTION__
 
   let receive_finalize _ctx = u __FUNCTION__