src/collect.ml

   1 (* 'top'-like tool for libvirt domains.
   2    (C) Copyright 2007-2021 Richard W.M. Jones, Red Hat Inc.
   3    http://libvirt.org/
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 *)
  19
  20 module C = Libvirt.Connect
  21 module D = Libvirt.Domain
  22
  23 open Printf
  24
  25 open Utils
  26 open Types
  27
  28 (* Intermediate "domain + stats" structure that we use to collect
  29  * everything we know about a domain within the collect function.
  30  *)
  31 type rd_domain = Inactive | Active of rd_active
  32 and rd_active = {
  33   rd_domid : int;                       (* Domain ID. *)
  34   rd_domuuid : Libvirt.uuid;            (* Domain UUID. *)
  35   rd_dom : [`R] D.t;                    (* Domain object. *)
  36   rd_info : D.info;                     (* Domain CPU info now. *)
  37   rd_block_stats : (string * D.block_stats) list;
  38                                         (* Domain block stats now. *)
  39   rd_interface_stats : (string * D.interface_stats) list;
  40                                         (* Domain net stats now. *)
  41   rd_prev_info : D.info option;         (* Domain CPU info previously. *)
  42   rd_prev_block_stats : (string * D.block_stats) list;
  43                                         (* Domain block stats prev. *)
  44   rd_prev_interface_stats : (string * D.interface_stats) list;
  45                                         (* Domain interface stats prev. *)
  46   (* The following are since the last slice, or 0 if cannot be calculated: *)
  47   rd_cpu_time : float;                  (* CPU time used in nanoseconds. *)
  48   rd_percent_cpu : float;               (* CPU time as percent of total. *)
  49   rd_mem_bytes : int64;                 (* Memory usage in bytes *)
  50   rd_mem_percent: int64;                (* Memory usage as percent of total *)
  51   (* The following are since the last slice, or None if cannot be calc'd: *)
  52   rd_block_rd_reqs : int64 option;      (* Number of block device read rqs. *)
  53   rd_block_wr_reqs : int64 option;      (* Number of block device write rqs. *)
  54   rd_block_rd_bytes : int64 option;     (* Number of bytes block device read *)
  55   rd_block_wr_bytes : int64 option;     (* Number of bytes block device write *)
  56   rd_net_rx_bytes : int64 option;       (* Number of bytes received. *)
  57   rd_net_tx_bytes : int64 option;       (* Number of bytes transmitted. *)
  58 }
  59
  60 type stats = {
  61   rd_doms : (string * rd_domain) list;  (* List of domains. *)
  62   rd_time : float;
  63   rd_printable_time : string;
  64   rd_nr_pcpus : int;
  65   rd_total_cpu : float;
  66   rd_total_cpu_per_pcpu : float;
  67   rd_totals : (int * int * int * int * int * int * int * int * int * float *
  68                  int64 * int64);
  69 }
  70
  71 type pcpu_stats = {
  72   rd_pcpu_doms : (int * string * int *
  73                   Libvirt.Domain.vcpu_info array * int64 array array *
  74                   int64 array array * string * int) list;
  75   rd_pcpu_pcpus : int64 array array array;
  76   rd_pcpu_pcpus_cpu_time : float array
  77 }
  78
  79 (* We cache the list of block devices and interfaces for each domain
  80  * here, so we don't need to reparse the XML each time.
  81  *)
  82 let devices = Hashtbl.create 13
  83
  84 (* Function to get the list of block devices, network interfaces for
  85  * a particular domain.  Get it from the devices cache, and if not
  86  * there then parse the domain XML.
  87  *)
  88 let get_devices id dom =
  89   try Hashtbl.find devices id
  90   with Not_found ->
  91     let blkdevs, netifs = Xml.parse_device_xml dom in
  92     Hashtbl.replace devices id (blkdevs, netifs);
  93     blkdevs, netifs
  94
  95 (* We save the state of domains across redraws here, which allows us
  96  * to deduce %CPU usage from the running total.
  97  *)
  98 let last_info = Hashtbl.create 13
  99 let last_time = ref (Unix.gettimeofday ())
 100
 101 (* Save pcpu_usages structures across redraws too (only for pCPU display). *)
 102 let last_pcpu_usages = Hashtbl.create 13
 103
 104 let clear_pcpu_display_data () =
 105   Hashtbl.clear last_pcpu_usages
 106
 107 (* What to get from virConnectGetAllDomainStats. *)
 108 let what = [
 109   D.StatsState; D.StatsCpuTotal; D.StatsBalloon; D.StatsVcpu;
 110   D.StatsInterface; D.StatsBlock
 111 ]
 112 (* Which domains to get.  Empty list means return all domains:
 113  * active, inactive, persistent, transient etc.
 114  *)
 115 let who = []
 116
 117 let collect (conn, _, _, _, _, node_info, _, _) =
 118   (* Number of physical CPUs (some may be disabled). *)
 119   let nr_pcpus = C.maxcpus_of_node_info node_info in
 120
 121   (* Get the current time. *)
 122   let time = Unix.gettimeofday () in
 123   let tm = Unix.localtime time in
 124   let printable_time =
 125     sprintf "%02d:%02d:%02d" tm.Unix.tm_hour tm.Unix.tm_min tm.Unix.tm_sec in
 126
 127   (* What's the total CPU time elapsed since we were last called? (ns) *)
 128   let total_cpu_per_pcpu = 1_000_000_000. *. (time -. !last_time) in
 129   (* Avoid division by zero. *)
 130   let total_cpu_per_pcpu =
 131     if total_cpu_per_pcpu <= 0. then 1. else total_cpu_per_pcpu in
 132   let total_cpu = float node_info.C.cpus *. total_cpu_per_pcpu in
 133
 134   (* Get the domains.  Match up with their last_info (if any). *)
 135   let doms =
 136     let doms = D.get_all_domain_stats conn what who in
 137     let doms = Array.to_list doms in
 138     List.map (
 139       fun { D.dom_uuid = uuid; D.params = params } ->
 140         let nr_params = Array.length params in
 141         let get_param name =
 142           let rec loop i =
 143             if i = nr_params then None
 144             else if fst params.(i) = name then Some (snd params.(i))
 145             else loop (i+1)
 146           in
 147           loop 0
 148         in
 149         let get_param_int name default =
 150           match get_param name with
 151           | None -> None
 152           | Some (D.TypedFieldInt32 i)
 153           | Some (D.TypedFieldUInt32 i) -> Some (Int32.to_int i)
 154           | Some (D.TypedFieldInt64 i)
 155           | Some (D.TypedFieldUInt64 i) -> Some (Int64.to_int i)
 156           | _ -> default
 157         in
 158         let get_param_int64 name default =
 159           match get_param name with
 160           | None -> None
 161           | Some (D.TypedFieldInt32 i)
 162           | Some (D.TypedFieldUInt32 i) -> Some (Int64.of_int32 i)
 163           | Some (D.TypedFieldInt64 i)
 164           | Some (D.TypedFieldUInt64 i) -> Some i
 165           | _ -> default
 166         in
 167
 168         let dom = D.lookup_by_uuid conn uuid in
 169         let id = D.get_id dom in
 170         let name = D.get_name dom in
 171         let state = get_param_int "state.state" None in
 172
 173         if state = Some 5 (* VIR_DOMAIN_SHUTOFF *) then
 174           (name, Inactive)
 175         else (
 176           (* Active domain. *)
 177
 178           (* Synthesize a D.info struct out of the data we have
 179            * from virConnectGetAllDomainStats.  Doing this is an
 180            * artifact from the old APIs we used to use to fetch
 181            * stats, we could simplify here, and also return the
 182            * RSS memory. XXX
 183            *)
 184           let state =
 185             match state with
 186             | None | Some 0 -> D.InfoNoState
 187             | Some 1 -> D.InfoRunning
 188             | Some 2 -> D.InfoBlocked
 189             | Some 3 -> D.InfoPaused
 190             | Some 4 -> D.InfoShutdown
 191             | Some 5 -> D.InfoShutoff
 192             | Some 6 -> D.InfoCrashed
 193             | Some 7 -> D.InfoPaused (* XXX really VIR_DOMAIN_PMSUSPENDED *)
 194             | _ -> D.InfoNoState in
 195           let memory =
 196             match get_param_int64 "balloon.current" None with
 197             | None -> 0_L
 198             | Some m -> m in
 199           let nr_virt_cpu =
 200             match get_param_int "vcpu.current" None with
 201             | None -> 1
 202             | Some v -> v in
 203           let cpu_time =
 204             (* NB: libvirt does not return cpu.time for non-root domains. *)
 205             match get_param_int64 "cpu.time" None with
 206             | None -> 0_L
 207             | Some ns -> ns in
 208           let info = {
 209             D.state = state;
 210             max_mem = -1_L; (* not used anywhere in virt-top *)
 211             memory = memory;
 212             nr_virt_cpu = nr_virt_cpu;
 213             cpu_time = cpu_time
 214           } in
 215
 216           let nr_block_devs =
 217             match get_param_int "block.count" None with
 218             | None -> 0
 219             | Some i -> i in
 220           let block_stats =
 221             List.map (
 222               fun i ->
 223               let dev =
 224                 match get_param (sprintf "block.%d.name" i) with
 225                 | None -> sprintf "blk%d" i
 226                 | Some (D.TypedFieldString s) -> s
 227                 | _ -> assert false in
 228               dev, {
 229                 D.rd_req =
 230                   (match get_param_int64 (sprintf "block.%d.rd.reqs" i) None
 231                    with None -> 0_L | Some v -> v);
 232                 rd_bytes =
 233                   (match get_param_int64 (sprintf "block.%d.rd.bytes" i) None
 234                    with None -> 0_L | Some v -> v);
 235                 wr_req =
 236                   (match get_param_int64 (sprintf "block.%d.wr.reqs" i) None
 237                    with None -> 0_L | Some v -> v);
 238                 wr_bytes =
 239                   (match get_param_int64 (sprintf "block.%d.wr.bytes" i) None
 240                    with None -> 0_L | Some v -> v);
 241                 errs = 0_L
 242               }
 243             ) (range 0 (nr_block_devs-1)) in
 244
 245           let nr_interface_devs =
 246             match get_param_int "net.count" None with
 247             | None -> 0
 248             | Some i -> i in
 249           let interface_stats =
 250             List.map (
 251               fun i ->
 252               let dev =
 253                 match get_param (sprintf "net.%d.name" i) with
 254                 | None -> sprintf "net%d" i
 255                 | Some (D.TypedFieldString s) -> s
 256                 | _ -> assert false in
 257               dev, {
 258                 D.rx_bytes =
 259                   (match get_param_int64 (sprintf "net.%d.rx.bytes" i) None
 260                    with None -> 0_L | Some v -> v);
 261                 rx_packets =
 262                   (match get_param_int64 (sprintf "net.%d.rx.pkts" i) None
 263                    with None -> 0_L | Some v -> v);
 264                 rx_errs =
 265                   (match get_param_int64 (sprintf "net.%d.rx.errs" i) None
 266                    with None -> 0_L | Some v -> v);
 267                 rx_drop =
 268                   (match get_param_int64 (sprintf "net.%d.rx.drop" i) None
 269                    with None -> 0_L | Some v -> v);
 270                 tx_bytes =
 271                   (match get_param_int64 (sprintf "net.%d.tx.bytes" i) None
 272                    with None -> 0_L | Some v -> v);
 273                 tx_packets =
 274                   (match get_param_int64 (sprintf "net.%d.tx.pkts" i) None
 275                    with None -> 0_L | Some v -> v);
 276                 tx_errs =
 277                   (match get_param_int64 (sprintf "net.%d.tx.errs" i) None
 278                    with None -> 0_L | Some v -> v);
 279                 tx_drop =
 280                   (match get_param_int64 (sprintf "net.%d.tx.drop" i) None
 281                    with None -> 0_L | Some v -> v);
 282               }
 283             ) (range 0 (nr_interface_devs-1)) in
 284
 285           let prev_info, prev_block_stats, prev_interface_stats =
 286             try
 287               let prev_info, prev_block_stats, prev_interface_stats =
 288                 Hashtbl.find last_info uuid in
 289               Some prev_info, prev_block_stats, prev_interface_stats
 290             with Not_found -> None, [], [] in
 291
 292           (name,
 293            Active {
 294              rd_domid = id; rd_domuuid = uuid; rd_dom = dom;
 295              rd_info = info;
 296              rd_block_stats = block_stats;
 297              rd_interface_stats = interface_stats;
 298              rd_prev_info = prev_info;
 299              rd_prev_block_stats = prev_block_stats;
 300              rd_prev_interface_stats = prev_interface_stats;
 301              rd_cpu_time = 0.; rd_percent_cpu = 0.;
 302              rd_mem_bytes = 0L; rd_mem_percent = 0L;
 303              rd_block_rd_reqs = None; rd_block_wr_reqs = None;
 304              rd_block_rd_bytes = None; rd_block_wr_bytes = None;
 305              rd_net_rx_bytes = None; rd_net_tx_bytes = None;
 306            })
 307         )
 308     ) doms in
 309
 310   (* Calculate the CPU time (ns) and %CPU used by each domain. *)
 311   let doms =
 312     List.map (
 313       function
 314       (* We have previous CPU info from which to calculate it? *)
 315       | name, Active ({ rd_prev_info = Some prev_info } as rd) ->
 316          let cpu_time =
 317            Int64.to_float (rd.rd_info.D.cpu_time -^ prev_info.D.cpu_time) in
 318          let percent_cpu = 100. *. cpu_time /. total_cpu in
 319          let mem_usage = rd.rd_info.D.memory in
 320          let mem_percent =
 321            100L *^ rd.rd_info.D.memory /^ node_info.C.memory in
 322          let rd = { rd with
 323                     rd_cpu_time = cpu_time;
 324                     rd_percent_cpu = percent_cpu;
 325                     rd_mem_bytes = mem_usage;
 326                     rd_mem_percent = mem_percent} in
 327          name, Active rd
 328       (* For all other domains we can't calculate it, so leave as 0 *)
 329       | rd -> rd
 330     ) doms in
 331
 332   (* Calculate the number of block device read/write requests across
 333    * all block devices attached to a domain.
 334    *)
 335   let doms =
 336     List.map (
 337       function
 338       (* Do we have stats from the previous slice? *)
 339       | name, Active ({ rd_prev_block_stats = ((_::_) as prev_block_stats) }
 340                       as rd) ->
 341          let block_stats = rd.rd_block_stats in (* stats now *)
 342
 343          (* Add all the devices together.  Throw away device names. *)
 344          let prev_block_stats =
 345            sum_block_stats (List.map snd prev_block_stats) in
 346          let block_stats =
 347            sum_block_stats (List.map snd block_stats) in
 348
 349          (* Calculate increase in read & write requests. *)
 350          let read_reqs =
 351            block_stats.D.rd_req -^ prev_block_stats.D.rd_req in
 352          let write_reqs =
 353            block_stats.D.wr_req -^ prev_block_stats.D.wr_req in
 354          let read_bytes =
 355            block_stats.D.rd_bytes -^ prev_block_stats.D.rd_bytes in
 356          let write_bytes =
 357            block_stats.D.wr_bytes -^ prev_block_stats.D.wr_bytes in
 358
 359          let rd = { rd with
 360                     rd_block_rd_reqs = Some read_reqs;
 361                     rd_block_wr_reqs = Some write_reqs;
 362                     rd_block_rd_bytes = Some read_bytes;
 363                     rd_block_wr_bytes = Some write_bytes;
 364          } in
 365          name, Active rd
 366       (* For all other domains we can't calculate it, so leave as None. *)
 367       | rd -> rd
 368     ) doms in
 369
 370   (* Calculate the same as above for network interfaces across
 371    * all network interfaces attached to a domain.
 372    *)
 373   let doms =
 374     List.map (
 375       function
 376       (* Do we have stats from the previous slice? *)
 377       | name, Active ({ rd_prev_interface_stats =
 378                           ((_::_) as prev_interface_stats) }
 379                       as rd) ->
 380          let interface_stats = rd.rd_interface_stats in (* stats now *)
 381
 382          (* Add all the devices together.  Throw away device names. *)
 383          let prev_interface_stats =
 384            sum_interface_stats (List.map snd prev_interface_stats) in
 385          let interface_stats =
 386            sum_interface_stats (List.map snd interface_stats) in
 387
 388          (* Calculate increase in rx & tx bytes. *)
 389          let rx_bytes =
 390            interface_stats.D.rx_bytes -^ prev_interface_stats.D.rx_bytes in
 391          let tx_bytes =
 392            interface_stats.D.tx_bytes -^ prev_interface_stats.D.tx_bytes in
 393
 394          let rd = { rd with
 395                     rd_net_rx_bytes = Some rx_bytes;
 396                     rd_net_tx_bytes = Some tx_bytes } in
 397          name, Active rd
 398       (* For all other domains we can't calculate it, so leave as None. *)
 399       | rd -> rd
 400     ) doms in
 401
 402   (* Calculate totals. *)
 403   let totals =
 404     List.fold_left (
 405         fun (count, running, blocked, paused, shutdown, shutoff,
 406              crashed, active, inactive,
 407              total_cpu_time, total_memory, total_domU_memory) ->
 408         function
 409         | (name, Active rd) ->
 410            let test state orig =
 411              if rd.rd_info.D.state = state then orig+1 else orig
 412            in
 413            let running = test D.InfoRunning running in
 414            let blocked = test D.InfoBlocked blocked in
 415            let paused = test D.InfoPaused paused in
 416            let shutdown = test D.InfoShutdown shutdown in
 417            let shutoff = test D.InfoShutoff shutoff in
 418            let crashed = test D.InfoCrashed crashed in
 419
 420            let total_cpu_time = total_cpu_time +. rd.rd_cpu_time in
 421            let total_memory = total_memory +^ rd.rd_info.D.memory in
 422            let total_domU_memory =
 423              total_domU_memory +^
 424                if rd.rd_domid > 0 then rd.rd_info.D.memory else 0L in
 425
 426            (count+1, running, blocked, paused, shutdown, shutoff,
 427             crashed, active+1, inactive,
 428             total_cpu_time, total_memory, total_domU_memory)
 429
 430         | (name, Inactive) -> (* inactive domain *)
 431            (count+1, running, blocked, paused, shutdown, shutoff,
 432             crashed, active, inactive+1,
 433             total_cpu_time, total_memory, total_domU_memory)
 434     ) (0,0,0,0,0,0,0,0,0, 0.,0L,0L) doms in
 435
 436   (* Update last_time, last_info. *)
 437   last_time := time;
 438   Hashtbl.clear last_info;
 439   List.iter (
 440     function
 441     | (_, Active rd) ->
 442        let info = rd.rd_info, rd.rd_block_stats, rd.rd_interface_stats in
 443        Hashtbl.add last_info rd.rd_domuuid info
 444     | _ -> ()
 445   ) doms;
 446
 447   { rd_doms = doms;
 448     rd_time = time;
 449     rd_printable_time = printable_time;
 450     rd_nr_pcpus = nr_pcpus;
 451     rd_total_cpu = total_cpu;
 452     rd_total_cpu_per_pcpu = total_cpu_per_pcpu;
 453     rd_totals = totals }
 454
 455 (* Collect some extra information in PCPUDisplay display_mode. *)
 456 let collect_pcpu { rd_doms = doms; rd_nr_pcpus = nr_pcpus } =
 457   (* Get the VCPU info and VCPU->PCPU mappings for active domains.
 458    * Also cull some data we don't care about.
 459    *)
 460   let doms =
 461     List.filter_map (
 462       function
 463       | (name, Active rd) ->
 464          (try
 465              let domid = rd.rd_domid in
 466              let maplen = C.cpumaplen nr_pcpus in
 467              let cpu_stats = D.get_cpu_stats rd.rd_dom in
 468
 469              (* Note the terminology is confusing.
 470               *
 471               * In libvirt, cpu_time is the total time (hypervisor +
 472               * vCPU).  vcpu_time is the time only taken by the vCPU,
 473               * excluding time taken inside the hypervisor.
 474               *
 475               * For each pCPU, libvirt may return either "cpu_time"
 476               * or "vcpu_time" or neither or both.  This function
 477               * returns an array pair [|cpu_time, vcpu_time|];
 478               * if either is missing it is returned as 0.
 479               *)
 480              let find_cpu_usages params =
 481                let rec find_uint64_field name = function
 482                  | (n, D.TypedFieldUInt64 usage) :: _ when n = name ->
 483                     usage
 484                  | _ :: params -> find_uint64_field name params
 485                  | [] -> 0L
 486                in
 487                [| find_uint64_field "cpu_time" params;
 488                   find_uint64_field "vcpu_time" params |]
 489              in
 490
 491              let pcpu_usages = Array.map find_cpu_usages cpu_stats in
 492              let maxinfo = rd.rd_info.D.nr_virt_cpu in
 493              let nr_vcpus, vcpu_infos, cpumaps =
 494                D.get_vcpus rd.rd_dom maxinfo maplen in
 495
 496              (* Got previous pcpu_usages for this domain? *)
 497              let prev_pcpu_usages =
 498                try Some (Hashtbl.find last_pcpu_usages domid)
 499                with Not_found -> None in
 500              (* Update last_pcpu_usages. *)
 501              Hashtbl.replace last_pcpu_usages domid pcpu_usages;
 502
 503              (match prev_pcpu_usages with
 504               | Some prev_pcpu_usages
 505                    when Array.length prev_pcpu_usages = Array.length pcpu_usages ->
 506                  Some (domid, name, nr_vcpus, vcpu_infos, pcpu_usages,
 507                        prev_pcpu_usages, cpumaps, maplen)
 508               | _ -> None (* ignore missing / unequal length prev_vcpu_infos *)
 509              );
 510            with
 511              Libvirt.Virterror _ -> None (* ignore transient libvirt errors *)
 512          )
 513       | (_, Inactive) -> None (* ignore inactive doms *)
 514     ) doms in
 515   let nr_doms = List.length doms in
 516
 517   (* Rearrange the data into a matrix.  Major axis (down) is
 518    * pCPUs.  Minor axis (right) is domains.  At each node we store:
 519    *  cpu_time hypervisor + domain (on this pCPU only, nanosecs),
 520    *  vcpu_time domain only (on this pCPU only, nanosecs).
 521    *)
 522   let make_3d_array dimx dimy dimz e =
 523     Array.init dimx (fun _ -> Array.make_matrix dimy dimz e)
 524   in
 525   let pcpus = make_3d_array nr_pcpus nr_doms 2 0L in
 526
 527   List.iteri (
 528     fun di (domid, name, nr_vcpus, vcpu_infos, pcpu_usages,
 529             prev_pcpu_usages, cpumaps, maplen) ->
 530       (* Which pCPUs can this dom run on? *)
 531       for p = 0 to Array.length pcpu_usages - 1 do
 532         pcpus.(p).(di).(0) <-
 533           pcpu_usages.(p).(0) -^ prev_pcpu_usages.(p).(0);
 534         pcpus.(p).(di).(1) <-
 535           pcpu_usages.(p).(1) -^ prev_pcpu_usages.(p).(1)
 536       done
 537   ) doms;
 538
 539   (* Sum the total CPU time used by each pCPU, for the %CPU column. *)
 540   let pcpus_cpu_time =
 541     Array.map (
 542       fun row ->
 543         let cpu_time = ref 0L in
 544         for di = 0 to Array.length row-1 do
 545           let t = row.(di).(0) in
 546           cpu_time := !cpu_time +^ t
 547         done;
 548         Int64.to_float !cpu_time
 549     ) pcpus in
 550
 551   { rd_pcpu_doms = doms;
 552     rd_pcpu_pcpus = pcpus;
 553     rd_pcpu_pcpus_cpu_time = pcpus_cpu_time }