Merge pull request #2198 from huizh/CP-10531

CP-10531: Update vm_guest_metrics to implement PV drivers update

Author: robhoes

ocaml/client_records/records.ml

@@ -848,6 +848,10 @@ let vm_record rpc session_id vm =
 			make_field ~name:"networks"
 				~get:(fun () -> default nid (may (fun m -> Record_util.s2sm_to_string "; " m.API.vM_guest_metrics_networks) (xgm ()) ))
 				~get_map:(fun () -> default [] (may (fun m -> m.API.vM_guest_metrics_networks) (xgm ()))) ();
+			make_field ~name:"network-paths-optimized"
+				~get:(fun () -> default nid (may (fun m -> string_of_bool m.API.vM_guest_metrics_network_paths_optimized) (xgm ()) )) ();
+			make_field ~name:"storage-paths-optimized"
+				~get:(fun () -> default nid (may (fun m -> string_of_bool m.API.vM_guest_metrics_storage_paths_optimized) (xgm ()) )) ();
 			make_field ~name:"other"
 				~get:(fun () -> default nid (may (fun m -> Record_util.s2sm_to_string "; " m.API.vM_guest_metrics_other) (xgm ()) ))
 				~get_map:(fun () -> default [] (may (fun m -> m.API.vM_guest_metrics_other) (xgm()))) ();

ocaml/idl/datamodel.ml

@@ -7050,9 +7050,22 @@ let vm_guest_metrics =
       field ~qualifier:DynamicRO ~ty:(Map(String, String)) "os_version" "version of the OS";
       field ~qualifier:DynamicRO ~ty:(Map(String, String)) "PV_drivers_version" 
 	"version of the PV drivers";
-      field ~qualifier:DynamicRO ~ty:Bool ~in_oss_since:None "PV_drivers_up_to_date"
-	"true if the PV drivers appear to be up to date";
-
+      field ~qualifier:DynamicRO ~ty:Bool ~in_oss_since:None
+        ~lifecycle:[
+          Published, rel_rio, "true if the PV drivers appear to be up to date";
+          Deprecated, rel_dundee, "Deprecated in favour of network_paths_optimized and storage_paths_optimized, and redefined in terms of them"
+        ]
+      "PV_drivers_up_to_date" "Logical AND of network_paths_optimized and storage_paths_optimized";
+      field ~qualifier:DynamicRO ~ty:Bool ~in_oss_since:None ~default_value:(Some (VBool false))
+        ~lifecycle:[
+          Published, rel_dundee, "Network paths are optimized with backend";
+        ]
+      "network_paths_optimized" "True if the network paths are optimized with PV driver";
+      field ~qualifier:DynamicRO ~ty:Bool ~in_oss_since:None ~default_value:(Some (VBool false))
+        ~lifecycle:[
+          Published, rel_dundee, "Storage paths are optimized with backend";
+        ]
+      "storage_paths_optimized" "True if the storage paths are optimized with PV driver";
       field ~qualifier:DynamicRO ~ty:(Map(String, String))
         ~lifecycle:[
           Published, rel_rio, "free/used/total";

ocaml/xapi/import.ml

@@ -532,6 +532,8 @@ module GuestMetrics : HandlerTools = struct
 			~memory:gm_record.API.vM_guest_metrics_memory
 			~disks:gm_record.API.vM_guest_metrics_disks
 			~networks:gm_record.API.vM_guest_metrics_networks
+			~network_paths_optimized:gm_record.API.vM_guest_metrics_network_paths_optimized
+			~storage_paths_optimized:gm_record.API.vM_guest_metrics_storage_paths_optimized
 			~other:gm_record.API.vM_guest_metrics_other
 			~last_updated:gm_record.API.vM_guest_metrics_last_updated
 			~other_config:gm_record.API.vM_guest_metrics_other_config

ocaml/xapi/xapi_guest_agent.ml

@@ -55,6 +55,8 @@ let memory =
 
 let device_id = [ "data/device_id", "device_id"]
 
+let extend base str = Printf.sprintf "%s/%s" base str
+
 (* This function is passed the 'attr' node and a function it can use to
  * find the directory listing of sub-nodes. It will return a map where the
  * keys are the xenstore paths of the VM's IP addresses, and the values are
@@ -65,7 +67,6 @@ let device_id = [ "data/device_id", "device_id"]
  * attr/eth0/ipv6/1/addr -> 0/ipv6/1
  * *)
 let networks path (list: string -> string list) =
-	let extend base str = Printf.sprintf "%s/%s" base str in
 	(* Find all ipv6 addresses under a path. *)
 	let find_ipv6 path prefix = List.map
 		(fun str -> (extend (extend path str) "addr", extend prefix str))
@@ -97,6 +98,33 @@ let networks path (list: string -> string list) =
 		|> List.map (fun (path, prefix) -> find_all_ips path prefix)
 		|> List.concat
 
+(* This function is passed the "device/vif" node, a function it can use to
+ * find the directory listing of sub-nodes and a function to retrieve the value
+ * with the given path.
+ * If "state" of all VIFs are "4", the return value is true
+ * which means the network paths are optimized.
+ * Or else the return value is false.
+ *)
+let network_paths_optimized path (list: string -> string list) (lookup: string -> string option) =
+	List.fold_left (fun result vif_id ->
+		let vif_state = lookup (extend (extend path vif_id) "state") in
+		result && (vif_state = Some "4")
+	) true (list path)
+
+(* This function is passed the "device/vbd" node, a function it can use to
+ * find the directory listing of sub-nodes and a function to retrieve the value
+ * with the given path.
+ * If "state" of all VBDs (except cdrom) are "4", the return value is true
+ * which means the storage paths are optimized.
+ * Or else the return value is false.
+ *)
+let storage_paths_optimized path (list: string -> string list) (lookup: string -> string option) =
+	List.fold_left (fun result vbd_id ->
+		let vbd_state = lookup (extend (extend path vbd_id) "state") in
+		let vbd_type = lookup (extend (extend path vbd_id) "device-type") in
+		result && (vbd_state = Some "4" || vbd_type = Some "cdrom")
+	) true (list path)
+
 (* One key is placed in the other map per control/* key in xenstore. This
    catches keys like "feature-shutdown" "feature-hibernate" "feature-reboot"
    "feature-sysrq" *)
@@ -110,7 +138,7 @@ let other all_control =
     the results of these lookups differ *)
 
 type m = (string * string) list
-let cache : (int, (m*m*m*m*m*m*float)) Hashtbl.t = Hashtbl.create 20
+let cache : (int, (m*m*m*m*m*m*bool*bool*bool*float)) Hashtbl.t = Hashtbl.create 20
 let memory_targets : (int, int64) Hashtbl.t = Hashtbl.create 20
 let dead_domains : IntSet.t ref = ref IntSet.empty
 let mutex = Mutex.create ()
@@ -134,8 +162,12 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
   and networks = to_map (networks "attr" list)
   and other = List.append (to_map (other all_control)) ts
   and memory = to_map memory
+  and network_paths_optimized = network_paths_optimized "device/vif" list lookup
+  and storage_paths_optimized = storage_paths_optimized "device/vbd" list lookup
   and last_updated = Unix.gettimeofday () in
 
+  let pv_drivers_up_to_date = network_paths_optimized && storage_paths_optimized in
+  
   (* let num = Mutex.execute mutex (fun () -> Hashtbl.fold (fun _ _ c -> 1 + c) cache 0) in 
   debug "Number of entries in hashtbl: %d" num; *)
 
@@ -154,6 +186,9 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
     other_cached,
     memory_cached,
     device_id_cached,
+    network_paths_optimized_cached,
+    storage_paths_optimized_cached,
+    pv_drivers_up_to_date_cached,
     last_updated_cached
   ) = Mutex.execute mutex (fun () -> try
        Hashtbl.find cache domid 
@@ -167,7 +202,7 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 	dead_domains := IntSet.remove domid !dead_domains
       else
 	dead_domains := IntSet.add domid !dead_domains;
-      ([],[],[],[],[],[],0.0)) in
+      ([],[],[],[],[],[],false,false,false,0.0)) in
 
   (* Consider the data valid IF the data/updated key exists AND the pv_drivers_version map
      contains a major and minor version-- this prevents a migration mid-way through an update
@@ -187,7 +222,7 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
   then begin
 
       (* Only if the data is valid, cache it (CA-20353) *)
-      Mutex.execute mutex (fun () -> Hashtbl.replace cache domid (pv_drivers_version,os_version,networks,other,memory,device_id,last_updated));
+      Mutex.execute mutex (fun () -> Hashtbl.replace cache domid (pv_drivers_version,os_version,networks,other,memory,device_id,network_paths_optimized,storage_paths_optimized,pv_drivers_up_to_date,last_updated));
 
       (* We update only if any actual data has changed *)
       if ( pv_drivers_version_cached <> pv_drivers_version 
@@ -198,7 +233,13 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 	   ||
 	   other_cached <> other
      ||
-     device_id_cached <> device_id)
+     device_id_cached <> device_id
+     ||
+     network_paths_optimized_cached <> network_paths_optimized
+     ||
+     storage_paths_optimized_cached <> storage_paths_optimized
+     ||
+     pv_drivers_up_to_date_cached <> pv_drivers_up_to_date)
 (* Nb. we're ignoring the memory updates as far as the VM_guest_metrics API object is concerned. We are putting them into an RRD instead *)
 (*	   ||
 	   memory_cached <> memory)*)
@@ -213,7 +254,7 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 	      let new_ref = Ref.make () and new_uuid = Uuid.to_string (Uuid.make_uuid ()) in
 	      Db.VM_guest_metrics.create ~__context ~ref:new_ref ~uuid:new_uuid
 		~os_version:os_version ~pV_drivers_version:pv_drivers_version ~pV_drivers_up_to_date:false ~memory:[] ~disks:[] ~networks:networks ~other:other
-		~last_updated:(Date.of_float last_updated) ~other_config:[] ~live:true;
+		~storage_paths_optimized:false ~network_paths_optimized:false ~last_updated:(Date.of_float last_updated) ~other_config:[] ~live:true;
 	      Db.VM.set_guest_metrics ~__context ~self ~value:new_ref; 
 	      (* We've just set the thing to live, let's make sure it's not in the dead list *)
 		  let sl xs = String.concat "; " (List.map (fun (k, v) -> k ^ ": " ^ v) xs) in
@@ -233,6 +274,15 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 	    Db.VM_guest_metrics.set_other ~__context ~self:gm ~value:other;
 	    Helpers.call_api_functions ~__context (fun rpc session_id -> Client.Client.VM.update_allowed_operations rpc session_id self);
 	  end;
+	  if(network_paths_optimized_cached <> network_paths_optimized) then begin
+	  	Db.VM_guest_metrics.set_network_paths_optimized ~__context ~self:gm ~value:network_paths_optimized;
+	  end;
+	  if(storage_paths_optimized_cached <> storage_paths_optimized) then begin
+	  	Db.VM_guest_metrics.set_storage_paths_optimized ~__context ~self:gm ~value:storage_paths_optimized;
+	  end;
+	  if(pv_drivers_up_to_date_cached <> pv_drivers_up_to_date) then begin
+	  	Db.VM_guest_metrics.set_PV_drivers_up_to_date ~__context ~self:gm ~value:pv_drivers_up_to_date;
+	  end;
 (*	  if(memory_cached <> memory) then
 	    Db.VM_guest_metrics.set_memory ~__context ~self:gm ~value:memory; *)
 
@@ -256,7 +306,6 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 	  (* Update the 'up to date' flag afterwards *)
 	  let gmr = Db.VM_guest_metrics.get_record_internal ~__context ~self:gm in
 	  let up_to_date = Xapi_pv_driver_version.is_up_to_date (Xapi_pv_driver_version.of_guest_metrics (Some gmr)) in
-	  Db.VM_guest_metrics.set_PV_drivers_up_to_date ~__context ~self:gm ~value:up_to_date;
 
 	  (* CA-18034: If viridian flag isn't in there and we have current PV drivers then shove it in the metadata for next boot... *)
 	  if up_to_date then begin
@@ -288,6 +337,9 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 		  other, (* not the cached version *)
 		  memory_cached,
 		  device_id_cached,
+		  network_paths_optimized_cached,
+		  storage_paths_optimized_cached,
+		  pv_drivers_up_to_date_cached,
 		  last_updated)); (* not a cached version *)
 
 	  let gm =
@@ -305,6 +357,8 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 				  ~disks:[]
 				  ~networks:networks_cached
 				  ~other:other
+				  ~storage_paths_optimized:false
+				  ~network_paths_optimized:false
 				  ~last_updated:(Date.of_float last_updated)
 				  ~other_config:[]
 				  ~live:false;
@@ -321,6 +375,9 @@ let all (lookup: string -> string option) (list: string -> string list) ~__conte
 				  other, (* current version *)
 				  [], (* memory *)
 				  device_id_cached,
+				  network_paths_optimized_cached,
+				  storage_paths_optimized_cached,
+				  pv_drivers_up_to_date_cached,
 				  last_updated)); (* not a cached version *)
 			  new_ref
 	  in

ocaml/xapi/xapi_vm_helpers.ml

@@ -906,6 +906,8 @@ let copy_guest_metrics ~__context ~vm =
 			~memory:all.API.vM_guest_metrics_memory
 			~disks:all.API.vM_guest_metrics_disks
 			~networks:all.API.vM_guest_metrics_networks
+			~network_paths_optimized:all.API.vM_guest_metrics_network_paths_optimized
+			~storage_paths_optimized:all.API.vM_guest_metrics_storage_paths_optimized
 			~other:all.API.vM_guest_metrics_other
 			~last_updated:all.API.vM_guest_metrics_last_updated
 			~other_config:all.API.vM_guest_metrics_other_config