Add more states for SXM

Adding a few more states that will be tracked by the send_state and
receive_state. These will be used later on for SMAPIv3 outbound
migration.

We do need to give them a default value in case the deserialisation
of the on-disk copy does not have these values.

These are not used yet, so no functional change.

Signed-off-by: Vincent Liu <shuntian.liu2@cloud.com>

Author: Vincent-lau

ocaml/tests/test_storage_migrate_state.ml

@@ -41,6 +41,9 @@ let sample_send_state =
           )
     ; failed= false
     ; watchdog= None
+    ; live_vm= Storage_interface.Vm.of_string "0"
+    ; mirror_key= None
+    ; vdi= Storage_interface.Vdi.of_string ""
     }
 
 let sample_receive_state =
@@ -54,6 +57,8 @@ let sample_receive_state =
     ; parent_vdi= Vdi.of_string "parent_vdi"
     ; remote_vdi= Vdi.of_string "remote_vdi"
     ; mirror_vm= Vm.of_string "mirror_vm"
+    ; url= ""
+    ; verify_dest= false
     }
 
 let sample_copy_state =

ocaml/xapi-storage-cli/main.ml

@@ -315,6 +315,8 @@ let mirror_vm = Vm.of_string "SXM_mirror"
 
 let copy_vm = Vm.of_string "SXM_copy"
 
+let live_vm = Vm.of_string "live_vm"
+
 let mirror_start common_opts sr vdi dp url dest verify_dest =
   on_vdi'
     (fun sr vdi ->
@@ -323,7 +325,8 @@ let mirror_start common_opts sr vdi dp url dest verify_dest =
       let url = get_opt url "Need a URL" in
       let dest = get_opt dest "Need a destination SR" in
       let task =
-        Storage_migrate.start ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~url
+        Storage_migrate.start ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~live_vm
+          ~url
           ~dest:(Storage_interface.Sr.of_string dest)
           ~verify_dest
       in

ocaml/xapi/storage_migrate.ml

@@ -261,7 +261,7 @@ module MigrateLocal = struct
       raise
         (Storage_error (Migration_preparation_failure (Printexc.to_string e)))
 
-  let start ~task_id ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~url ~dest
+  let start ~task_id ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~live_vm ~url ~dest
       ~verify_dest =
     SXM.info
       "%s sr:%s vdi:%s dp: %s mirror_vm: %s copy_vm: %s url:%s dest:%s \
@@ -292,6 +292,9 @@ module MigrateLocal = struct
         ; tapdev= None
         ; failed= false
         ; watchdog= None
+        ; live_vm
+        ; vdi
+        ; mirror_key= None
         }
     in
 
@@ -608,13 +611,14 @@ let copy ~dbg ~sr ~vdi ~vm ~url ~dest ~verify_dest =
         ~sr ~vdi ~vm ~url ~dest ~verify_dest
   )
 
-let start ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~url ~dest ~verify_dest =
+let start ~dbg ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~live_vm ~url ~dest ~verify_dest
+    =
   with_dbg ~name:__FUNCTION__ ~dbg @@ fun dbg ->
   with_task_and_thread ~dbg (fun task ->
       MigrateLocal.start
         ~task_id:(Storage_task.id_of_handle task)
-        ~dbg:dbg.Debug_info.log ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~url ~dest
-        ~verify_dest
+        ~dbg:dbg.Debug_info.log ~sr ~vdi ~dp ~mirror_vm ~copy_vm ~live_vm ~url
+        ~dest ~verify_dest
   )
 
 (* XXX: PR-1255: copy the xenopsd 'raise Exception' pattern *)

ocaml/xapi/storage_migrate_helper.ml

@@ -36,6 +36,8 @@ module State = struct
       ; parent_vdi: Vdi.t
       ; remote_vdi: Vdi.t
       ; mirror_vm: Vm.t
+      ; url: string [@default ""]
+      ; verify_dest: bool [@default false]
     }
     [@@deriving rpcty]
 
@@ -92,6 +94,11 @@ module State = struct
       ; tapdev: tapdev option
       ; mutable failed: bool
       ; mutable watchdog: handle option
+      ; vdi: Vdi.t [@default Vdi.of_string ""] (* source vdi *)
+      ; live_vm: Vm.t
+            [@default Vm.of_string "0"]
+            (* vm to which the source vdi is attached *)
+      ; mirror_key: Mirror.operation option [@default None]
     }
     [@@deriving rpcty]
 

ocaml/xapi/storage_migrate_helper.mli

@@ -28,6 +28,8 @@ module State : sig
       ; parent_vdi: Storage_interface.vdi
       ; remote_vdi: Storage_interface.vdi
       ; mirror_vm: Storage_interface.vm
+      ; url: string
+      ; verify_dest: bool
     }
 
     val t_sr : (Storage_interface.sr, t) Rpc.Types.field
@@ -89,6 +91,9 @@ module State : sig
       ; tapdev: tapdev option
       ; mutable failed: bool
       ; mutable watchdog: handle option
+      ; vdi: Vdi.t [@default Vdi.of_string ""]
+      ; live_vm: Vm.t [@default Vm.of_string "0"]
+      ; mirror_key: Mirror.operation option [@default None]
     }
 
     val t_url : (string, t) Rpc.Types.field

ocaml/xapi/storage_smapiv1_migrate.ml

@@ -386,8 +386,9 @@ module Copy = struct
         raise (Storage_error (Internal_error (Printexc.to_string e)))
 end
 
-let mirror_pass_fds ~dbg ~dp ~sr ~vdi ~mirror_vm ~mirror_id ~url ~dest_sr
-    ~verify_dest ~(remote_mirror : Mirror.mirror_receive_result_vhd_t) =
+let mirror_pass_fds ~dbg ~dp ~sr ~vdi ~mirror_vm ~live_vm ~mirror_id ~url
+    ~dest_sr ~verify_dest ~(remote_mirror : Mirror.mirror_receive_result_vhd_t)
+    =
   let remote_vdi = remote_mirror.mirror_vdi.vdi in
   let mirror_dp = remote_mirror.mirror_datapath in
 
@@ -470,6 +471,9 @@ let mirror_pass_fds ~dbg ~dp ~sr ~vdi ~mirror_vm ~mirror_id ~url ~dest_sr
       ; tapdev= Some tapdev
       ; failed= false
       ; watchdog= None
+      ; vdi
+      ; live_vm
+      ; mirror_key= None
       }
   in
   State.add mirror_id (State.Send_op alm) ;
@@ -549,7 +553,7 @@ module MIRROR : SMAPIv2_MIRROR = struct
   type context = unit
 
   let send_start _ctx ~dbg ~task_id ~dp ~sr ~vdi ~mirror_vm ~mirror_id
-      ~local_vdi ~copy_vm ~live_vm:_ ~url ~remote_mirror ~dest_sr ~verify_dest =
+      ~local_vdi ~copy_vm ~live_vm ~url ~remote_mirror ~dest_sr ~verify_dest =
     let (module Remote) =
       Storage_migrate_helper.get_remote_backend url verify_dest
     in
@@ -564,8 +568,8 @@ module MIRROR : SMAPIv2_MIRROR = struct
           )
     | Mirror.Vhd_mirror mirror_res ->
         let tapdev =
-          mirror_pass_fds ~dbg ~dp ~sr ~vdi ~mirror_vm ~mirror_id ~url ~dest_sr
-            ~verify_dest ~remote_mirror:mirror_res
+          mirror_pass_fds ~dbg ~dp ~sr ~vdi ~mirror_vm ~live_vm ~mirror_id ~url
+            ~dest_sr ~verify_dest ~remote_mirror:mirror_res
         in
 
         let snapshot = mirror_snapshot ~dbg ~sr ~dp ~mirror_id ~local_vdi in
@@ -663,6 +667,8 @@ module MIRROR : SMAPIv2_MIRROR = struct
               ; parent_vdi= parent.vdi
               ; remote_vdi= vdi_info.vdi
               ; mirror_vm= vm
+              ; url= ""
+              ; verify_dest= false
               }
         ) ;
       let nearest_content_id = Option.map (fun x -> x.content_id) nearest in

ocaml/xapi/storage_smapiv1_migrate.mli

@@ -56,6 +56,7 @@ val mirror_pass_fds :
   -> sr:Storage_interface.sr
   -> vdi:Storage_interface.vdi
   -> mirror_vm:Storage_interface.vm
+  -> live_vm:Storage_interface.vm
   -> mirror_id:string
   -> url:string
   -> dest_sr:Storage_interface.sr

ocaml/xapi/xapi_vm_migrate.ml

@@ -1030,14 +1030,29 @@ let vdi_copy_fun __context dbg vdi_map remote is_intra_pool remote_vdis so_far
         let id =
           Storage_migrate_helper.State.mirror_id_of (vconf.sr, vconf.location)
         in
-        debug "%s mirror_vm is %s copy_vm is %s" __FUNCTION__
+        let live_vm =
+          match Db.VDI.get_VBDs ~__context ~self:vconf.vdi with
+          | [] ->
+              Storage_migrate_helper.failwith_fmt
+                "VDI %s does not have a corresponding VBD"
+                (Ref.string_of vconf.vdi)
+          | vbd_ref :: _ ->
+              (* XX Is it possible that this VDI might be used as multiple VBDs attached to different VMs? *)
+              let vm_ref = Db.VBD.get_VM ~__context ~self:vbd_ref in
+              let domid =
+                Db.VM.get_domid ~__context ~self:vm_ref |> Int64.to_string
+              in
+              Vm.of_string domid
+        in
+        debug "%s mirror_vm is %s copy_vm is %s live_vm is %s" __FUNCTION__
           (Vm.string_of vconf.mirror_vm)
-          (Vm.string_of vconf.copy_vm) ;
+          (Vm.string_of vconf.copy_vm)
+          (Vm.string_of live_vm) ;
         (* Layering violation!! *)
         ignore (Storage_access.register_mirror __context id) ;
         Storage_migrate.start ~dbg ~sr:vconf.sr ~vdi:vconf.location ~dp:new_dp
-          ~mirror_vm:vconf.mirror_vm ~copy_vm:vconf.copy_vm ~url:remote.sm_url
-          ~dest:dest_sr ~verify_dest:is_intra_pool
+          ~mirror_vm:vconf.mirror_vm ~copy_vm:vconf.copy_vm ~live_vm
+          ~url:remote.sm_url ~dest:dest_sr ~verify_dest:is_intra_pool
     in
     let mapfn x =
       let total = Int64.to_float total_size in