Supported image formats

ocaml/idl/datamodel.ml

@@ -5004,6 +5004,17 @@ module SR = struct
 end
 
 module SM = struct
+  let formats =
+    [
+      ("raw", "Plain disk image")
+    ; ("vhd", "Virtual Hard Disk")
+    ; ("qcow2", "Qemu Copy-On-Write version 2")
+    ]
+
+  let formats_desc = formats |> List.map fst |> String.concat ", "
+
+  let image_format_type = Enum ("image_format_type", formats)
+
   (** XXX: just make this a field and be done with it. Cowardly refusing to change the schema for now. *)
   let get_driver_filename =
     call ~name:"get_driver_filename" ~in_oss_since:None
@@ -5124,6 +5135,10 @@ module SM = struct
             ~ty:(Set String) "required_cluster_stack"
             "The storage plugin requires that one of these cluster stacks is \
              configured and running."
+        ; field ~lifecycle:[] ~qualifier:DynamicRO
+            ~default_value:(Some (VSet [])) ~ty:(Set image_format_type)
+            "supported_image_formats"
+            (Printf.sprintf "Image formats supported by the SR: %s" formats_desc)
         ]
       ()
 end
@@ -5445,7 +5460,11 @@ module VDI = struct
         [
           (Ref _vdi, "vdi", "The VDI to migrate")
         ; (Ref _sr, "sr", "The destination SR")
-        ; (Map (String, String), "options", "Other parameters")
+        ; ( Map (String, String)
+          , "options"
+          , "Extra parameters. Supports: \"dest-img-format\" (raw|vhd|qcow2) \
+             to specify the image format to use on the destination SR."
+          )
         ]
       ~result:(Ref _vdi, "The new reference of the migrated VDI.")
       ~doc:

ocaml/idl/datamodel_common.ml

@@ -10,7 +10,7 @@ open Datamodel_roles
               to leave a gap for potential hotfixes needing to increment the schema version.*)
 let schema_major_vsn = 5
 
-let schema_minor_vsn = 901
+let schema_minor_vsn = 902
 
 (* Historical schema versions just in case this is useful later *)
 let rio_schema_major_vsn = 5

ocaml/idl/datamodel_vm.ml

@@ -1715,6 +1715,13 @@ let migrate_send =
         ; param_release= inverness_release
         ; param_default= Some (VMap [])
         }
+      ; {
+          param_type= Map (Ref _vdi, String)
+        ; param_name= "vdi_format_map"
+        ; param_doc= "Map of source VDI to it's expected type on destination"
+        ; param_release= numbered_release "26.10.0-next"
+        ; param_default= Some (VMap [])
+        }
       ]
     ~result:
       (Ref _vm, "The reference of the newly created VM in the destination pool")

ocaml/idl/schematest.ml

@@ -3,7 +3,7 @@ let hash x = Digest.string x |> Digest.to_hex
 (* BEWARE: if this changes, check that schema has been bumped accordingly in
    ocaml/idl/datamodel_common.ml, usually schema_minor_vsn *)
 
-let last_known_schema_hash = "87b39cf2131c990f186bb6baa6e5ece8"
+let last_known_schema_hash = "38fbb0d68e20fc76b57e769c895af68a"
 
 let current_schema_hash : string =
   let open Datamodel_types in

ocaml/quicktest/qt_filter.ml

@@ -409,3 +409,17 @@ let memtest_iso ?(prefix = "memtest") tcs =
      | (_, iso) :: _ ->
          Printf.eprintf "Choosing ISO %S\n%!" iso.API.vDI_name_label ;
          [(name, speed, test iso)]
+
+(* We only select the first two compatible SRs and generate a single
+   migration path. This test validates that migration works in this
+   environment, but does not attempt to exhaustively test all possible
+   (src, dst) combinations. *)
+let migration_path constraints =
+  for_each (fun (name, speed, test) ->
+      let srs = SR.list_srs constraints in
+      match srs with
+      | src :: dst :: _ ->
+          [(name, speed, test (src, dst))]
+      | _ ->
+          []
+  )

ocaml/quicktest/qt_filter.mli

@@ -92,3 +92,5 @@ val sr : SR.srs -> (Qt.sr_info -> 'b, 'b) filter
 val vm_template : string -> (API.ref_VM -> 'b, 'b) filter
 
 val memtest_iso : ?prefix:string -> (API.vDI_t -> 'a, 'a) filter
+
+val migration_path : SR.srs -> (Qt.sr_info * Qt.sr_info -> 'b, 'b) filter

ocaml/quicktest/quicktest.ml

@@ -70,6 +70,7 @@ let () =
         ; ("Quicktest_vm_import_export", Quicktest_vm_import_export.tests ())
         ; ("Quicktest_vm_lifecycle", Quicktest_vm_lifecycle.tests ())
         ; ("Quicktest_vm_snapshot", Quicktest_vm_snapshot.tests ())
+        ; ("Quicktest_vm_migration", Quicktest_vm_migration.tests ())
         ; ( "Quicktest_vdi_ops_data_integrity"
           , Quicktest_vdi_ops_data_integrity.tests ()
           )

ocaml/quicktest/quicktest_vm_migration.ml

@@ -0,0 +1,77 @@
+let local_vdi_migration rpc session_id vm_template
+    ((src_sr_info, dst_sr_info) : Qt.sr_info * Qt.sr_info) () =
+  let open Client in
+  Printf.printf "Testing migration from %s to %s\n"
+    (Client.SR.get_name_label ~rpc ~session_id ~self:src_sr_info.sr)
+    (Client.SR.get_name_label ~rpc ~session_id ~self:dst_sr_info.sr) ;
+
+  (* Create a VDI on src *)
+  let vdi =
+    Client.VDI.create ~rpc ~session_id ~name_label:"[QT] testing migration"
+      ~name_description:__FILE__ ~sR:src_sr_info.sr ~virtual_size:2097152L
+      ~_type:`user ~sharable:false ~read_only:false ~other_config:[]
+      ~xenstore_data:[] ~sm_config:[] ~tags:[]
+  in
+
+  (* Track which VDI must be destroyed at cleanup time. After migration, ownership
+     moves from the original VDI to the migrated one. *)
+  let final_vdi = ref vdi in
+
+  Xapi_stdext_pervasives.Pervasiveext.finally
+    (fun () ->
+      (* We can now create the VM and perform the migration *)
+      Qt.VM.with_new rpc session_id ~template:vm_template (fun vm ->
+          (* Attach the VDI *)
+          Client.VBD.create ~rpc ~session_id ~vM:vm ~vDI:vdi ~device:""
+            ~userdevice:"0" ~bootable:false ~mode:`RW ~_type:`Disk
+            ~unpluggable:true ~empty:false ~other_config:[]
+            ~qos_algorithm_type:"" ~qos_algorithm_params:[]
+            ~currently_attached:true
+          |> ignore ;
+
+          let migrated_vdi =
+            Client.VDI.pool_migrate ~rpc ~session_id ~vdi ~sr:dst_sr_info.sr
+              ~options:[("dest-img-format", "vhd")]
+          in
+
+          final_vdi := migrated_vdi ;
+
+          let new_sr = Client.VDI.get_SR ~rpc ~session_id ~self:migrated_vdi in
+          let actual = Client.SR.get_uuid ~rpc ~session_id ~self:new_sr in
+          let expected =
+            Client.SR.get_uuid ~rpc ~session_id ~self:dst_sr_info.sr
+          in
+
+          Alcotest.(check string)
+            "VDI migrated to destination SR" expected actual
+      )
+    )
+    (fun () ->
+      try Client.VDI.destroy ~rpc ~session_id ~self:!final_vdi with _ -> ()
+    )
+
+let tests () =
+  let smapiv1_mig =
+    Qt_filter.SR.(
+      all
+      |> not_iso
+      |> smapiv1
+      |> allowed_operations [`vdi_mirror; `vdi_snapshot]
+    )
+  in
+  let smapiv3_mig =
+    Qt_filter.SR.(all |> not_iso |> smapiv3 |> allowed_operations [`vdi_mirror])
+  in
+
+  let open Qt_filter in
+  [
+    [("SMAPIv1 migration test", `Slow, local_vdi_migration)]
+    |> conn
+    |> vm_template Qt.VM.Template.other
+    |> migration_path smapiv1_mig
+  ; [("SMAPIv3 migration test", `Slow, local_vdi_migration)]
+    |> conn
+    |> vm_template Qt.VM.Template.other
+    |> migration_path smapiv3_mig
+  ]
+  |> List.concat

ocaml/sdk-gen/component-test/jsonrpc-client/go/main_test.go

@@ -113,6 +113,17 @@ func ConvertMapToVgpuMap(input map[string]interface{}) (map[xenapi.VGPURef]xenap
 	return output, nil
 }
 
+func ConvertMapToVdiFormatMap(input map[string]interface{}) (map[xenapi.VDIRef]string, error) {
+	output := make(map[xenapi.VDIRef]string)
+	for key, value := range input {
+		strValue, ok := value.(string)
+		if !ok {
+			return nil, fmt.Errorf("non-string value found for key %s: %v", key, value)
+		}
+		output[xenapi.VDIRef(key)] = strValue
+	}
+	return output, nil
+}
 func TestMain(m *testing.M) {
 	flag.Parse()
 	exitVal := m.Run()

ocaml/sdk-gen/component-test/jsonrpc-client/go/vm_test.go

@@ -269,13 +269,14 @@ func TestVMMigrateSend(t *testing.T) {
 
 	inputParams := spec.Key.Params["VM.migrate_send"]
 	const (
-		IndexVMRef   = 1
-		IndexDest    = 2
-		IndexLive    = 3
-		IndexVdiMap  = 4
-		IndexVifMap  = 5
-		IndexOptions = 6
-		IndexVgpuMap = 7
+		IndexVMRef        = 1
+		IndexDest         = 2
+		IndexLive         = 3
+		IndexVdiMap       = 4
+		IndexVifMap       = 5
+		IndexOptions      = 6
+		IndexVgpuMap      = 7
+		IndexVdiFormatMap = 8
 	)
 	vmRef, ok1 := inputParams[IndexVMRef].(string)
 	destOrg, ok2 := inputParams[IndexDest].(map[string]interface{})
@@ -284,7 +285,8 @@ func TestVMMigrateSend(t *testing.T) {
 	vifMapOrg, ok5 := inputParams[IndexVifMap].(map[string]interface{})
 	optionsOrg, ok6 := inputParams[IndexOptions].(map[string]interface{})
 	vgpuMapOrg, ok7 := inputParams[IndexVgpuMap].(map[string]interface{})
-	if !ok1 || !ok2 || !ok3 || !ok4 || !ok5 || !ok6 || !ok7 {
+	vdiFormatMapOrg, ok8 := inputParams[IndexVdiFormatMap].(map[string]interface{})
+	if !ok1 || !ok2 || !ok3 || !ok4 || !ok5 || !ok6 || !ok7 || !ok8 {
 		t.Log("Parameter get error from json file")
 		t.Fail()
 		return
@@ -319,8 +321,13 @@ func TestVMMigrateSend(t *testing.T) {
 		t.Fail()
 		return
 	}
-
-	result, err := xenapi.VM.MigrateSend(session, xenapi.VMRef(vmRef), dest, live, vdiMap, vifMap, options, vgpuMap)
+	vdiFormatMap, err := ConvertMapToVdiFormatMap(vdiFormatMapOrg)
+	if err != nil {
+		t.Log(err)
+		t.Fail()
+		return
+	}
+	result, err := xenapi.VM.MigrateSend(session, xenapi.VMRef(vmRef), dest, live, vdiMap, vifMap, options, vgpuMap, vdiFormatMap)
 	if err != nil {
 		t.Log(err)
 		t.Fail()

ocaml/sdk-gen/component-test/spec/xapi-24/vm_migrate_send.json

@@ -5,14 +5,15 @@
         ],
         "params": {
             "VM.migrate_send": [
-                "", 
-                "OpaqueRef:5vm2d621-7b62-f571-vm00-754341a973e5", 
-                {"name_label": "host1"}, 
-                true, 
-                {"OpaqueRef:5vdid621-7b62-f571-vdi8-754341a973e5": "OpaqueRef:5sr2d621-7b62-f571-s38r-754341a973e5"}, 
-                {"OpaqueRef:9vifb8a9-f6a3-69d2-vifb-7a7b7c81c49e": "OpaqueRef:9network-f6a3-69d2-netw-7a7b7c81c49e"}, 
-                {}, 
-                {"OpaqueRef:9vgpu8a9-f6a3-69d2-vgpu-7a7b7c81c49e": "OpaqueRef:9gpugroup-f6a3-69d2-grou-7a7b7c81c49e"}
+                "",
+                "OpaqueRef:5vm2d621-7b62-f571-vm00-754341a973e5",
+                {"name_label": "host1"},
+                true,
+                {"OpaqueRef:5vdid621-7b62-f571-vdi8-754341a973e5": "OpaqueRef:5sr2d621-7b62-f571-s38r-754341a973e5"},
+                {"OpaqueRef:9vifb8a9-f6a3-69d2-vifb-7a7b7c81c49e": "OpaqueRef:9network-f6a3-69d2-netw-7a7b7c81c49e"},
+                {},
+                {"OpaqueRef:9vgpu8a9-f6a3-69d2-vgpu-7a7b7c81c49e": "OpaqueRef:9gpugroup-f6a3-69d2-grou-7a7b7c81c49e"},
+                {"OpaqueRef:5vdid621-7b62-f571-vdi8-754341a973e5": "vhd"}
             ]
         },
         "expected_result": {
@@ -21,4 +22,4 @@
             }
         }
     }
-}
+}

ocaml/tests/common/test_common.ml

@@ -362,11 +362,12 @@ let make_sm ~__context ?(ref = Ref.make ()) ?(uuid = make_uuid ())
     ?(copyright = "") ?(version = "") ?(required_api_version = "")
     ?(capabilities = []) ?(features = default_sm_features)
     ?(host_pending_features = []) ?(configuration = []) ?(other_config = [])
-    ?(driver_filename = "/dev/null") ?(required_cluster_stack = []) () =
+    ?(driver_filename = "/dev/null") ?(required_cluster_stack = [])
+    ?(supported_image_formats = []) () =
   Db.SM.create ~__context ~ref ~uuid ~_type ~name_label ~name_description
     ~vendor ~copyright ~version ~required_api_version ~capabilities ~features
     ~host_pending_features ~configuration ~other_config ~driver_filename
-    ~required_cluster_stack ;
+    ~required_cluster_stack ~supported_image_formats ;
   ref
 
 let make_sr ~__context ?(ref = Ref.make ()) ?(uuid = make_uuid ())

ocaml/tests/test_sm_features.ml

@@ -249,6 +249,7 @@ module CreateSMObject = Generic.MakeStateful (struct
       ; features
       ; configuration= []
       ; required_cluster_stack= []
+      ; supported_image_formats= []
       ; smapi_version= SMAPIv2
       }
 

ocaml/tests/test_vdi_cbt.ml

@@ -30,6 +30,7 @@ let register_smapiv2_server (module S : Storage_interface.Server_impl) sr_ref =
       ; features= []
       ; configuration= []
       ; required_cluster_stack= []
+      ; supported_image_formats= []
       ; smapi_version= SMAPIv2
       }
   in

ocaml/xapi-cli-server/cli_frontend.ml

@@ -1625,6 +1625,7 @@ let rec cmdtable_data : (string * cmd_spec) list =
           ; "compress"
           ; "vif:"
           ; "vdi:"
+          ; "image-format:"
           ]
       ; help=
           "Migrate the selected VM(s). The parameter '--live' will migrate the \
@@ -1638,7 +1639,9 @@ let rec cmdtable_data : (string * cmd_spec) list =
            'copy=true' will enable the copy mode so that a stopped vm can be \
            copied, instead of migrating, to the destination pool. The vif and \
            vdi mapping parameters take the form 'vif:<source vif uuid>=<dest \
-           network uuid>' and 'vdi:<source vdi uuid>=<dest sr uuid>'. \
+           network uuid>' and 'vdi:<source vdi uuid>=<dest sr uuid>'. You can \
+           also specify the destination image format of the VDI using \
+           'image-format:<source vdi uuid>=<destination image format>'. \
            Unfortunately, destination uuids cannot be tab-completed."
       ; implementation= No_fd Cli_operations.vm_migrate
       ; flags= [Standard; Vm_selectors]
@@ -2480,10 +2483,10 @@ let rec cmdtable_data : (string * cmd_spec) list =
   ; ( "vdi-pool-migrate"
     , {
         reqd= ["uuid"; "sr-uuid"]
-      ; optn= []
+      ; optn= ["dest-img-format"]
       ; help=
-          "Migrate a VDI to a specified SR, while the VDI is attached to a \
-           running guest."
+          "Migrate a VDI to a specified SR, while it is attached to a running \
+           guest. You can specify the image format for the destination."
       ; implementation= No_fd Cli_operations.vdi_pool_migrate
       ; flags= []
       }

ocaml/xapi-cli-server/cli_operations.ml

@@ -2128,8 +2128,11 @@ let vdi_pool_migrate printer rpc session_id params =
   and sr =
     Client.SR.get_by_uuid ~rpc ~session_id ~uuid:(List.assoc "sr-uuid" params)
   and options =
-    []
-    (* no options implemented yet *)
+    match List.assoc_opt "dest-img-format" params with
+    | Some v ->
+        [("dest-img-format", v)]
+    | None ->
+        []
   in
   let newvdi = Client.VDI.pool_migrate ~rpc ~session_id ~vdi ~sr ~options in
   let newuuid = Client.VDI.get_uuid ~rpc ~session_id ~self:newvdi in
@@ -4675,6 +4678,7 @@ let vm_migrate_sxm_params =
   ; "remote-network"
   ; "vdi"
   ; "vgpu"
+  ; "image-format"
   ]
 
 let vm_migrate printer rpc session_id params =
@@ -4982,12 +4986,23 @@ let vm_migrate printer rpc session_id params =
         let token =
           remote Client.Host.migrate_receive ~host ~network ~options
         in
+        let vdi_format_map =
+          List.map
+            (fun (vdi_uuid, vdi_fmt) ->
+              let vdi =
+                Client.VDI.get_by_uuid ~rpc ~session_id ~uuid:vdi_uuid
+              in
+              (vdi, vdi_fmt)
+            )
+            (read_map_params "image-format" params)
+        in
         let new_vm =
           do_vm_op ~include_control_vms:false ~include_template_vms:true printer
             rpc session_id
             (fun vm ->
               Client.VM.migrate_send ~rpc ~session_id ~vm:(vm.getref ())
-                ~dest:token ~live:true ~vdi_map ~vif_map ~options ~vgpu_map
+                ~dest:token ~live:true ~vdi_map ~vdi_format_map ~vif_map
+                ~options ~vgpu_map
             )
             params
             (["host"; "host-uuid"; "host-name"; "live"; "force"; "copy"]