CP-5095:Retrieve a list of SRs required to recover a VM through xapi

Signed-off-by: Akshay Ramani <[email protected]>

Author: akshayramani

ocaml/idl/datamodel.ml

@@ -2224,6 +2224,17 @@ let vm_assert_can_be_recovered = call
   ~allowed_roles:_R_READ_ONLY
   ()
 
+let vm_required_list_of_SRs = call
+	~name:"required_list_of_SRs"
+	~in_product_since:rel_clearwater
+	~doc:"List all the SR's that are required for the VM to be recovered"
+	~params:[Ref _vm , "self" , "The VM for which the SRs have to be recovered";
+					Ref _session , "session_to" , "The session to which the SRs of the VM have to be recovered."]
+	~result:(Set(Ref _sr),"refs for SRs required to recover the VM")
+	~errs:[Api_errors.vm_requires_sr]
+	~allowed_roles:_R_READ_ONLY
+	()
+
 let vm_recover = call
   ~name:"recover"
   ~in_product_since:rel_boston
@@ -6696,6 +6707,7 @@ let vm =
 		vm_set_order;
 		vm_set_suspend_VDI;
 		vm_assert_can_be_recovered;
+		vm_required_list_of_SRs;
 		vm_recover;
 		vm_import_convert;
 		vm_set_appliance;

ocaml/xapi/message_forwarding.ml

@@ -1942,6 +1942,10 @@ module Forward = functor(Local: Custom_actions.CUSTOM_ACTIONS) -> struct
 			info "VM.assert_can_be_recovered: self = '%s';" (vm_uuid ~__context self);
 			Local.VM.assert_can_be_recovered ~__context ~self ~session_to
 
+		let required_list_of_SRs ~__context ~self ~session_to =
+			info "VM.required_list_of_SRs: self = '%s';" (vm_uuid ~__context self);
+			Local.VM.required_list_of_SRs ~__context ~self ~session_to
+
 		let recover ~__context ~self ~session_to ~force =
 			info "VM.recover: self = '%s'; force = %b;" (vm_uuid ~__context self) force;
 			(* If a VM is part of an appliance, the appliance *)

ocaml/xapi/xapi_vm.ml

@@ -778,6 +778,9 @@ let set_order ~__context ~self ~value =
 let assert_can_be_recovered ~__context ~self ~session_to =
 	Xapi_vm_helpers.assert_can_be_recovered ~__context ~self ~session_to
 
+let required_list_of_SRs ~__context ~self ~session_to =
+	Xapi_vm_helpers.required_list_of_SRs ~__context ~self ~session_to
+
 let recover ~__context ~self ~session_to ~force =
 	Xapi_dr.assert_session_allows_dr ~session_id:session_to ~action:"VM.recover";
 	(* Check the VM SRs are available. *)

ocaml/xapi/xapi_vm.mli

@@ -229,6 +229,7 @@ val set_shutdown_delay : __context:Context.t -> self:API.ref_VM -> value:int64 -
 val set_order : __context:Context.t -> self:API.ref_VM -> value:int64 -> unit
 
 val assert_can_be_recovered : __context:Context.t -> self:API.ref_VM -> session_to:API.ref_session -> unit
+val required_list_of_SRs : __context:Context.t -> self:API.ref_VM -> session_to:API.ref_session ->API.ref_SR list
 val recover : __context:Context.t -> self:API.ref_VM ->
 	session_to:API.ref_session -> force:bool -> unit
 val set_suspend_VDI : __context:Context.t -> self:API.ref_VM ->

ocaml/xapi/xapi_vm_helpers.ml

@@ -767,6 +767,23 @@ let assert_can_be_recovered ~__context ~self ~session_to =
 		raise (Api_errors.Server_error(Api_errors.vm_requires_sr,
 			[Ref.string_of self; Ref.string_of sr]))
 
+let required_list_of_SRs ~__context ~self ~session_to =
+	let required_SR_list = list_required_SRs ~__context ~self in
+	try
+		Server_helpers.exec_with_new_task ~session_id:session_to
+			"Looking for the required SRs"
+				(fun __context_to -> List.filter
+					( fun sr_ref ->
+							let pbds = Db.SR.get_PBDs ~__context:__context_to ~self:sr_ref in
+							let attached_pbds = List.filter
+								(fun pbd -> Db.PBD.get_currently_attached ~__context:__context_to ~self:pbd)
+								pbds
+							in
+							 if attached_pbds = [] then true else false
+					)
+					required_SR_list)
+	with e -> raise e;;
+
 (* BIOS strings *)
 
 let copy_bios_strings ~__context ~vm ~host =