Merge feature branch expose_more_system_info into master (#6713)

robhoes · web-flow · commit 8c49449507ce · 2025-10-17T09:29:22.000Z
diff --git a/ocaml/idl/datamodel_host.ml b/ocaml/idl/datamodel_host.ml
@@ -2536,6 +2536,22 @@ let latest_synced_updates_applied_state =
       ]
     )
 
+let get_tracked_user_agents =
+  call ~name:"get_tracked_user_agents" ~lifecycle:[]
+    ~doc:
+      "Get the (name, version) list of tracked user agents on this host. If \
+       different versions of the same name are seen, keep the last-seen \
+       version. The oldest entry will be removed if reach the max num. Note \
+       that the list is cleared after host/XAPI restart"
+    ~params:[(Ref _host, "self", "The host")]
+    ~allowed_roles:_R_READ_ONLY
+    ~result:
+      ( Map (String, String)
+      , "The (name, version) list of user agents that have been tracked on \
+         this host"
+      )
+    ()
+
 (** Hosts *)
 let t =
   create_obj ~in_db:true
@@ -2680,6 +2696,7 @@ let t =
       ; set_ssh_enabled_timeout
       ; set_console_idle_timeout
       ; set_ssh_auto_mode
+      ; get_tracked_user_agents
       ]
     ~contents:
       ([
diff --git a/ocaml/tests/common/test_common.ml b/ocaml/tests/common/test_common.ml
@@ -43,6 +43,7 @@ let default_cpu_info =
     ("cpu_count", "0")
   ; ("socket_count", "0")
   ; ("threads_per_core", "0")
+  ; ("nr_nodes", "0")
   ; ("vendor", "Abacus")
   ; ("speed", "")
   ; ("modelname", "")
@@ -79,6 +80,7 @@ let make_localhost ~__context ?(features = Features.all_features) () =
             cpu_count= 1
           ; socket_count= 1
           ; threads_per_core= 1
+          ; nr_nodes= 1
           ; vendor= ""
           ; speed= ""
           ; modelname= ""
diff --git a/ocaml/tests/suite_alcotest.ml b/ocaml/tests/suite_alcotest.ml
@@ -70,4 +70,5 @@ let () =
     @ Test_session.tests
     @ Test_xapi_cmd_result.tests
     @ Test_extauth_plugin_ADwinbind.tests
+    @ Test_tracked_user_agents.tests
     )
diff --git a/ocaml/tests/test_tracked_user_agents.ml b/ocaml/tests/test_tracked_user_agents.ml
@@ -0,0 +1,102 @@
+(*
+ * Copyright (C) Cloud Software Group
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation; version 2.1 only. with the special
+ * exception on linking described in file LICENSE.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *)
+
+let make_ctx ~user_agent ~client_ip =
+  let open Context in
+  let additional_headers =
+    client_ip
+    |> Option.fold ~none:[] ~some:(fun x ->
+           [("STUNNEL_PROXY", Printf.sprintf "TCP6 %s another_ip 443 80" x)]
+       )
+  in
+  let rq = {Http.Request.empty with user_agent; additional_headers} in
+  (* it doesn't matter which fd is used to here, we are just satisying the
+     type system. we use stderr because then we don't need to worry about
+     closing it *)
+  make ~origin:(Http (rq, Unix.stderr)) "text_ctx"
+
+let test_tracked_user_agents ~agents ~expected () =
+  Xapi_tracked_user_agents.reset () ;
+  List.iter
+    (fun user_agent ->
+      let __context =
+        make_ctx ~user_agent:(Some user_agent) ~client_ip:(Some "1.2.3.4")
+      in
+      Xapi_tracked_user_agents.track ~__context
+    )
+    agents ;
+  let compare ua1 ua2 = String.compare (fst ua1) (fst ua2) in
+  Alcotest.(check (list (pair string string)))
+    "new user agents are equal to expected"
+    (List.sort compare expected)
+    (Xapi_tracked_user_agents.get () |> List.sort compare)
+
+let tests =
+  [
+    ( "tracked_user_agents_base"
+    , [
+        ( "test_tracked_user_agents_base"
+        , `Quick
+        , test_tracked_user_agents
+            ~agents:["XenCenter/2025.2.0.8315"]
+            ~expected:[("XenCenter", "2025.2.0.8315")]
+        )
+      ; ( "test_tracked_user_agents_version_last_seen"
+        , `Quick
+        , test_tracked_user_agents
+            ~agents:
+              [
+                "XenCenter/2025.2.0.8315"
+              ; "XenAPI/2.15"
+              ; "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
+              ; "XenCenter/2025.2.0.8316"
+              ]
+            ~expected:
+              [
+                ("XenCenter", "2025.2.0.8316")
+              ; ("XenAPI", "2.15")
+              ; ("Mozilla", "5.0")
+              ]
+        )
+      ; ( "test_tracked_user_agents_no_version"
+        , `Quick
+        , test_tracked_user_agents ~agents:["XenCenter"]
+            ~expected:[("XenCenter", "")]
+        )
+      ; ( "test_tracked_user_agents_no_slash"
+        , `Quick
+        , test_tracked_user_agents
+            ~agents:["XenCenter 2025.2.0.8315"]
+            ~expected:[("XenCenter", "")]
+        )
+      ; ( "test_tracked_user_agents_exceeding_maxstrlen"
+        , `Quick
+        , test_tracked_user_agents
+            ~agents:
+              [
+                "XenCenter/2025.2.0.8315.11111111111111111111111111111111111111111"
+              ]
+            ~expected:[]
+        )
+      ; ( "test_tracked_user_agents_exceeding_max_num"
+        , `Quick
+        , test_tracked_user_agents
+            ~agents:(List.init 130 (Printf.sprintf "Agent%d/1.0"))
+            ~expected:
+              (List.init 128 (fun i -> (Printf.sprintf "Agent%d" (i + 2), "1.0"))
+              )
+        )
+      ]
+    )
+  ]
diff --git a/ocaml/xapi-idl/xen/xenops_interface.ml b/ocaml/xapi-idl/xen/xenops_interface.ml
@@ -453,6 +453,7 @@ module Host = struct
       cpu_count: int
     ; socket_count: int
     ; threads_per_core: int
+    ; nr_nodes: int
     ; vendor: string
     ; speed: string
     ; modelname: string
diff --git a/ocaml/xapi/cpuid_helpers.ml b/ocaml/xapi/cpuid_helpers.ml
@@ -42,6 +42,8 @@ let socket_count = Map_check.(field "socket_count" int)
 
 let threads_per_core = Map_check.(field "threads_per_core" int)
 
+let nr_nodes = Map_check.(field "nr_nodes" int)
+
 let vendor = Map_check.(field "vendor" string)
 
 let get_flags_for_vm ~__context domain_type cpu_info =
diff --git a/ocaml/xapi/cpuid_helpers.mli b/ocaml/xapi/cpuid_helpers.mli
@@ -31,6 +31,8 @@ val socket_count : int Map_check.field
 
 val threads_per_core : int Map_check.field
 
+val nr_nodes : int Map_check.field
+
 val features : [`vm] Xenops_interface.CPU_policy.t Map_check.field
 
 val features_pv : [`host] Xenops_interface.CPU_policy.t Map_check.field
diff --git a/ocaml/xapi/create_misc.ml b/ocaml/xapi/create_misc.ml
@@ -48,11 +48,11 @@ type host_info = {
 
 (** The format of the response looks like
  *  # xen-livepatch list
- *   ID                                     | status
- *  ----------------------------------------+------------
- *  hp_1_1                                  | CHECKED
- *  hp_2_1                                  | APPLIED
- *  hp_3_2                                  | APPLIED *)
+ *   ID                                     | status     | metadata
+ *  ----------------------------------------+------------+---------------
+ *  hp_1_1                                  | CHECKED    |
+ *  hp_2_1                                  | APPLIED    |
+ *  hp_3_2                                  | APPLIED    | *)
 let make_xen_livepatch_list () =
   let lines =
     try
@@ -63,8 +63,8 @@ let make_xen_livepatch_list () =
   let patches =
     List.fold_left
       (fun acc l ->
-        match List.map String.trim (Xstringext.String.split ~limit:2 '|' l) with
-        | [key; "APPLIED"] ->
+        match List.map String.trim (String.split_on_char '|' l) with
+        | key :: "APPLIED" :: _ ->
             key :: acc
         | _ ->
             acc
@@ -76,10 +76,12 @@ let make_xen_livepatch_list () =
 (** The format of the response looks like
  *  # kpatch list
  *  Loaded patch modules:
- *  kpatch_hp_1_1
- *  kpatch_hp_2_1
-
- *  Installed patch modules: *)
+ *  lp_4_19_19__8_0_32_xs8__4_19_19__8_0_33_xs8 [enabled]
+ *  lp_4_19_19__8_0_20_xs8__4_19_19__8_0_21_xs8 [enabled]
+ *
+ *  Installed patch modules:
+ *
+ *  Only patch name are returned, status are excluded. *)
 let make_kpatch_list () =
   let start_line = "Loaded patch modules:" in
   let end_line = "Installed patch modules:" in
@@ -99,7 +101,14 @@ let make_kpatch_list () =
     | line :: rest ->
         let line' = String.trim line in
         if line' <> "" && started then
-          loop (line' :: acc) true rest
+          let patch_name =
+            match String.split_on_char ' ' line' with
+            | patch :: _ ->
+                patch
+            | [] ->
+                line'
+          in
+          loop (patch_name :: acc) true rest
         else
           loop acc started rest
   in
@@ -567,6 +576,7 @@ let create_host_cpu ~__context host_info =
           ("cpu_count", string_of_int cpu_info.cpu_count)
         ; ("socket_count", string_of_int cpu_info.socket_count)
         ; ("threads_per_core", string_of_int cpu_info.threads_per_core)
+        ; ("nr_nodes", string_of_int cpu_info.nr_nodes)
         ; ("vendor", cpu_info.vendor)
         ; ("speed", cpu_info.speed)
         ; ("modelname", cpu_info.modelname)
@@ -592,11 +602,12 @@ let create_host_cpu ~__context host_info =
       let old_cpu_info = Db.Host.get_cpu_info ~__context ~self:host in
       debug
         "create_host_cpuinfo: setting host cpuinfo: socket_count=%d, \
-         cpu_count=%d, threads_per_core=%d, features_hvm=%s, features_pv=%s, \
-         features_hvm_host=%s, features_pv_host=%s"
+         cpu_count=%d, threads_per_core=%d, nr_nodes=%d, features_hvm=%s, \
+         features_pv=%s, features_hvm_host=%s, features_pv_host=%s"
         (Map_check.getf socket_count cpu)
         (Map_check.getf cpu_count cpu)
         (Map_check.getf threads_per_core cpu)
+        (Map_check.getf nr_nodes cpu)
         (Map_check.getf features_hvm cpu |> CPU_policy.to_string)
         (Map_check.getf features_pv cpu |> CPU_policy.to_string)
         (Map_check.getf features_hvm_host cpu |> CPU_policy.to_string)
diff --git a/ocaml/xapi/message_forwarding.ml b/ocaml/xapi/message_forwarding.ml
@@ -4116,6 +4116,13 @@ functor
         let local_fn = Local.Host.set_ssh_auto_mode ~self ~value in
         let remote_fn = Client.Host.set_ssh_auto_mode ~self ~value in
         do_op_on ~local_fn ~__context ~host:self ~remote_fn
+
+      let get_tracked_user_agents ~__context ~self =
+        info "Host.get_tracked_user_agents: host = '%s'"
+          (host_uuid ~__context self) ;
+        let local_fn = Local.Host.get_tracked_user_agents ~self in
+        let remote_fn = Client.Host.get_tracked_user_agents ~self in
+        do_op_on ~local_fn ~__context ~host:self ~remote_fn
     end
 
     module Host_crashdump = struct
diff --git a/ocaml/xapi/repository.ml b/ocaml/xapi/repository.ml
@@ -702,7 +702,8 @@ let apply_livepatch ~__context ~host:_ ~component ~base_build_id ~base_version
   with
   | Some livepatch_file ->
       Livepatch.apply ~component:component' ~livepatch_file ~base_build_id
-        ~base_version ~base_release ~to_version ~to_release
+        ~base_version ~base_release ~to_version ~to_release ;
+      Create_misc.create_software_version ~__context ()
   | None ->
       Helpers.internal_error ~log_err:true "No expected livepatch file for %s"
         component
diff --git a/ocaml/xapi/xapi_globs.ml b/ocaml/xapi/xapi_globs.ml
@@ -907,6 +907,8 @@ let xen_livepatch_list = ref "/usr/sbin/xen-livepatch list"
 
 let kpatch_list = ref "/usr/sbin/kpatch list"
 
+let guest_service_keys = ref ["pvs_target/target_software_version"]
+
 let modprobe_path = ref "/usr/sbin/modprobe"
 
 let usb_path = "usb_path"
diff --git a/ocaml/xapi/xapi_guest_agent.ml b/ocaml/xapi/xapi_guest_agent.ml
@@ -345,7 +345,21 @@ let get_initial_guest_metrics (lookup : string -> string option)
          ; networks "xenserver/attr" "net-sriov-vf" list
          ]
       )
-  and services = get_guest_services lookup list
+  and services =
+    let services = get_guest_services lookup list in
+    let keys = !Xapi_globs.guest_service_keys in
+    let res =
+      List.fold_left
+        (fun acc key ->
+          match lookup ("data/" ^ key) with
+          | Some value ->
+              (key, value) :: acc
+          | None ->
+              acc
+        )
+        [] keys
+    in
+    List.rev_append services res
   and other = List.append (to_map (other all_control)) ts
   and memory = to_map memory
   and last_updated = Unix.gettimeofday () in
diff --git a/ocaml/xapi/xapi_host.ml b/ocaml/xapi/xapi_host.ml
@@ -3339,3 +3339,7 @@ let set_console_idle_timeout ~__context ~self ~value =
     error "Failed to configure console timeout: %s" (Printexc.to_string e) ;
     Helpers.internal_error "Failed to set console timeout: %Ld: %s" value
       (Printexc.to_string e)
+
+let get_tracked_user_agents ~__context ~self =
+  let _ : [`host] Ref.t = self in
+  Xapi_tracked_user_agents.get ()
diff --git a/ocaml/xapi/xapi_host.mli b/ocaml/xapi/xapi_host.mli
@@ -591,3 +591,6 @@ val schedule_disable_ssh_job :
 
 val set_ssh_auto_mode :
   __context:Context.t -> self:API.ref_host -> value:bool -> unit
+
+val get_tracked_user_agents :
+  __context:Context.t -> self:API.ref_host -> (string * string) list
diff --git a/ocaml/xapi/xapi_session.ml b/ocaml/xapi/xapi_session.ml
@@ -679,6 +679,7 @@ let login_no_password_common_create_session ~__context ~uname ~originator ~host
   (* Force the time to be updated by calling an API function with this session *)
   let rpc = Helpers.make_rpc ~__context in
   ignore (Client.Pool.get_all ~rpc ~session_id) ;
+  Xapi_tracked_user_agents.track ~__context ;
   session_id
 
 let login_no_password_common ~__context ~uname ~originator ~host ~pool
diff --git a/ocaml/xapi/xapi_tracked_user_agents.ml b/ocaml/xapi/xapi_tracked_user_agents.ml
diff --git a/ocaml/xapi/xapi_tracked_user_agents.mli b/ocaml/xapi/xapi_tracked_user_agents.mli
diff --git a/ocaml/xenopsd/lib/xenops_server_skeleton.ml b/ocaml/xenopsd/lib/xenops_server_skeleton.ml
diff --git a/ocaml/xenopsd/xc/xenctrlext.ml b/ocaml/xenopsd/xc/xenctrlext.ml
diff --git a/ocaml/xenopsd/xc/xenctrlext.mli b/ocaml/xenopsd/xc/xenctrlext.mli
diff --git a/ocaml/xenopsd/xc/xenops_server_xen.ml b/ocaml/xenopsd/xc/xenops_server_xen.ml

Original file line number	Diff line number	Diff line change
`@@ -70,4 +70,5 @@ let () =`
`70`	`70`	`@ Test_session.tests`
`71`	`71`	`@ Test_xapi_cmd_result.tests`
`72`	`72`	`@ Test_extauth_plugin_ADwinbind.tests`
	`73`	`+ @ Test_tracked_user_agents.tests`
`73`	`74`	`)`