virt-top/virt_top.ml

   1 (* 'top'-like tool for libvirt domains.
   2    (C) Copyright 2007-2009 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 open Printf
  21 open ExtList
  22 open Curses
  23
  24 open Virt_top_gettext.Gettext
  25 open Virt_top_utils
  26
  27 module C = Libvirt.Connect
  28 module D = Libvirt.Domain
  29 module N = Libvirt.Network
  30
  31 let rcfile = ".virt-toprc"
  32
  33 (* Hook for XML support (see virt_top_xml.ml). *)
  34 let parse_device_xml : (int -> [>`R] D.t -> string list * string list) ref =
  35   ref (
  36     fun _ _ -> [], []
  37   )
  38
  39 (* Hooks for CSV support (see virt_top_csv.ml). *)
  40 let csv_start : (string -> unit) ref =
  41   ref (
  42     fun _ -> failwith (s_"virt-top was compiled without support for CSV files")
  43   )
  44 let csv_write : (string list -> unit) ref =
  45   ref (
  46     fun _ -> ()
  47   )
  48
  49 (* Hook for calendar support (see virt_top_calendar.ml). *)
  50 let parse_date_time : (string -> float) ref =
  51   ref (
  52     fun _ ->
  53       failwith (s_"virt-top was compiled without support for dates and times")
  54   )
  55
  56 (* Sort order. *)
  57 type sort_order =
  58   | DomainID | DomainName | Processor | Memory | Time
  59   | NetRX | NetTX | BlockRdRq | BlockWrRq
  60 let all_sort_fields = [
  61   DomainID; DomainName; Processor; Memory; Time;
  62   NetRX; NetTX; BlockRdRq; BlockWrRq
  63 ]
  64 let printable_sort_order = function
  65   | Processor -> s_"%CPU"
  66   | Memory -> s_"%MEM"
  67   | Time -> s_"TIME (CPU time)"
  68   | DomainID -> s_"Domain ID"
  69   | DomainName -> s_"Domain name"
  70   | NetRX -> s_"Net RX bytes"
  71   | NetTX -> s_"Net TX bytes"
  72   | BlockRdRq -> s_"Block read reqs"
  73   | BlockWrRq -> s_"Block write reqs"
  74 let sort_order_of_cli = function
  75   | "cpu" | "processor" -> Processor
  76   | "mem" | "memory" -> Memory
  77   | "time" -> Time
  78   | "id" -> DomainID
  79   | "name" -> DomainName
  80   | "netrx" -> NetRX | "nettx" -> NetTX
  81   | "blockrdrq" -> BlockRdRq | "blockwrrq" -> BlockWrRq
  82   | str ->
  83       failwithf (f_"%s: sort order should be: %s")
  84         str "cpu|mem|time|id|name|netrx|nettx|blockrdrq|blockwrrq"
  85 let cli_of_sort_order = function
  86   | Processor -> "cpu"
  87   | Memory -> "mem"
  88   | Time -> "time"
  89   | DomainID -> "id"
  90   | DomainName -> "name"
  91   | NetRX -> "netrx"
  92   | NetTX -> "nettx"
  93   | BlockRdRq -> "blockrdrq"
  94   | BlockWrRq -> "blockwrrq"
  95
  96 (* Current major display mode: TaskDisplay is the normal display. *)
  97 type display = TaskDisplay | PCPUDisplay | BlockDisplay | NetDisplay
  98
  99 let display_of_cli = function
 100   | "task" -> TaskDisplay
 101   | "pcpu" -> PCPUDisplay
 102   | "block" -> BlockDisplay
 103   | "net" -> NetDisplay
 104   | str ->
 105       failwithf (f_"%s: display should be %s") str "task|pcpu|block|net"
 106 let cli_of_display = function
 107   | TaskDisplay -> "task"
 108   | PCPUDisplay -> "pcpu"
 109   | BlockDisplay -> "block"
 110   | NetDisplay -> "net"
 111
 112 (* Init file. *)
 113 type init_file = NoInitFile | DefaultInitFile | InitFile of string
 114
 115 (* Settings. *)
 116 let quit = ref false
 117 let delay = ref 3000 (* milliseconds *)
 118 let historical_cpu_delay = ref 20 (* secs *)
 119 let iterations = ref (-1)
 120 let end_time = ref None
 121 let batch_mode = ref false
 122 let secure_mode = ref false
 123 let sort_order = ref Processor
 124 let display_mode = ref TaskDisplay
 125 let uri = ref None
 126 let debug_file = ref ""
 127 let csv_enabled = ref false
 128 let csv_cpu = ref true
 129 let csv_mem = ref true
 130 let csv_block = ref true
 131 let csv_net = ref true
 132 let init_file = ref DefaultInitFile
 133 let script_mode = ref false
 134 let stream_mode = ref false
 135 let block_in_bytes = ref false
 136
 137 (* Tuple of never-changing data returned by start_up function. *)
 138 type setup =
 139     Libvirt.ro C.t * bool * bool * bool * bool * C.node_info * string *
 140       (int * int * int)
 141
 142 (* Function to read command line arguments and go into curses mode. *)
 143 let start_up () =
 144   (* Read command line arguments. *)
 145   let rec set_delay newdelay =
 146     if newdelay <= 0. then
 147       failwith (s_"-d: cannot set a negative delay");
 148     delay := int_of_float (newdelay *. 1000.)
 149   and set_uri = function "" -> uri := None | u -> uri := Some u
 150   and set_sort order = sort_order := sort_order_of_cli order
 151   and set_pcpu_mode () = display_mode := PCPUDisplay
 152   and set_net_mode () = display_mode := NetDisplay
 153   and set_block_mode () = display_mode := BlockDisplay
 154   and set_csv filename =
 155     (!csv_start) filename;
 156     csv_enabled := true
 157   and no_init_file () = init_file := NoInitFile
 158   and set_init_file filename = init_file := InitFile filename
 159   and set_end_time time = end_time := Some ((!parse_date_time) time)
 160   and display_version () =
 161     printf "virt-top %s ocaml-libvirt %s\n"
 162       Virt_top_version.version Libvirt_version.version;
 163     exit 0
 164   in
 165   let argspec = Arg.align [
 166     "-1", Arg.Unit set_pcpu_mode,
 167       " " ^ s_"Start by displaying pCPUs (default: tasks)";
 168     "-2", Arg.Unit set_net_mode,
 169       " " ^ s_"Start by displaying network interfaces";
 170     "-3", Arg.Unit set_block_mode,
 171       " " ^ s_"Start by displaying block devices";
 172     "-b", Arg.Set batch_mode,
 173       " " ^ s_"Batch mode";
 174     "-c", Arg.String set_uri,
 175       "uri " ^ s_"Connect to libvirt URI";
 176     "--connect", Arg.String set_uri,
 177       "uri " ^ s_"Connect to libvirt URI";
 178     "--csv", Arg.String set_csv,
 179       "file " ^ s_"Log statistics to CSV file";
 180     "--no-csv-cpu", Arg.Clear csv_cpu,
 181       " " ^ s_"Disable CPU stats in CSV";
 182     "--no-csv-mem", Arg.Clear csv_mem,
 183       " " ^ s_"Disable memory stats in CSV";
 184     "--no-csv-block", Arg.Clear csv_block,
 185       " " ^ s_"Disable block device stats in CSV";
 186     "--no-csv-net", Arg.Clear csv_net,
 187       " " ^ s_"Disable net stats in CSV";
 188     "-d", Arg.Float set_delay,
 189       "delay " ^ s_"Delay time interval (seconds)";
 190     "--debug", Arg.Set_string debug_file,
 191       "file " ^ s_"Send debug messages to file";
 192     "--end-time", Arg.String set_end_time,
 193       "time " ^ s_"Exit at given time";
 194     "--hist-cpu", Arg.Set_int historical_cpu_delay,
 195       "secs " ^ s_"Historical CPU delay";
 196     "--init-file", Arg.String set_init_file,
 197       "file " ^ s_"Set name of init file";
 198     "--no-init-file", Arg.Unit no_init_file,
 199       " " ^ s_"Do not read init file";
 200     "-n", Arg.Set_int iterations,
 201       "iterations " ^ s_"Number of iterations to run";
 202     "-o", Arg.String set_sort,
 203       "sort " ^ sprintf (f_"Set sort order (%s)") "cpu|mem|time|id|name";
 204     "-s", Arg.Set secure_mode,
 205       " " ^ s_"Secure (\"kiosk\") mode";
 206     "--script", Arg.Set script_mode,
 207       " " ^ s_"Run from a script (no user interface)";
 208     "--stream", Arg.Set stream_mode,
 209       " " ^ s_"dump output to stdout (no userinterface)";
 210     "--block-in-bytes", Arg.Set block_in_bytes,
 211       " " ^ s_"show block device load in bytes rather than reqs";
 212     "--version", Arg.Unit display_version,
 213       " " ^ s_"Display version number and exit";
 214   ] in
 215   let anon_fun str =
 216     raise (Arg.Bad (sprintf (f_"%s: unknown parameter") str)) in
 217   let usage_msg = s_"virt-top : a 'top'-like utility for virtualization
 218
 219 SUMMARY
 220   virt-top [-options]
 221
 222 OPTIONS" in
 223   Arg.parse argspec anon_fun usage_msg;
 224
 225   (* Read the init file. *)
 226   let try_to_read_init_file filename =
 227     let config = read_config_file filename in
 228     List.iter (
 229       function
 230       | _, "display", mode -> display_mode := display_of_cli mode
 231       | _, "delay", secs -> set_delay (float_of_string secs)
 232       | _, "hist-cpu", secs -> historical_cpu_delay := int_of_string secs
 233       | _, "iterations", n -> iterations := int_of_string n
 234       | _, "sort", order -> set_sort order
 235       | _, "connect", uri -> set_uri uri
 236       | _, "debug", filename -> debug_file := filename
 237       | _, "csv", filename -> set_csv filename
 238       | _, "csv-cpu", b -> csv_cpu := bool_of_string b
 239       | _, "csv-mem", b -> csv_mem := bool_of_string b
 240       | _, "csv-block", b -> csv_block := bool_of_string b
 241       | _, "csv-net", b -> csv_net := bool_of_string b
 242       | _, "batch", b -> batch_mode := bool_of_string b
 243       | _, "secure", b -> secure_mode := bool_of_string b
 244       | _, "script", b -> script_mode := bool_of_string b
 245       | _, "stream", b -> stream_mode := bool_of_string b
 246       | _, "block-in-bytes", b -> block_in_bytes := bool_of_string b
 247       | _, "end-time", t -> set_end_time t
 248       | _, "overwrite-init-file", "false" -> no_init_file ()
 249       | lineno, key, _ ->
 250           eprintf (f_"%s:%d: configuration item ``%s'' ignored\n%!")
 251             filename lineno key
 252     ) config
 253   in
 254   (match !init_file with
 255    | NoInitFile -> ()
 256    | DefaultInitFile ->
 257        let home = try Sys.getenv "HOME" with Not_found -> "/" in
 258        let filename = home // rcfile in
 259        try_to_read_init_file filename
 260    | InitFile filename ->
 261        try_to_read_init_file filename
 262   );
 263
 264   (* Connect to the hypervisor before going into curses mode, since
 265    * this is the most likely thing to fail.
 266    *)
 267   let conn =
 268     let name = !uri in
 269     try C.connect_readonly ?name ()
 270     with
 271       Libvirt.Virterror err ->
 272         prerr_endline (Libvirt.Virterror.to_string err);
 273         (* If non-root and no explicit connection URI, print a warning. *)
 274         if Unix.geteuid () <> 0 && name = None then (
 275           print_endline (s_"NB: If you want to monitor a local hypervisor, you usually need to be root");
 276         );
 277         exit 1 in
 278
 279   (* Get the node_info.  This never changes, right?  So we get it just once. *)
 280   let node_info = C.get_node_info conn in
 281
 282   (* Hostname and libvirt library version also don't change. *)
 283   let hostname =
 284     try C.get_hostname conn
 285     with
 286     (* qemu:/// and other URIs didn't support virConnectGetHostname until
 287      * libvirt 0.3.3.  Before that they'd throw a virterror. *)
 288     | Libvirt.Virterror _
 289     | Libvirt.Not_supported "virConnectGetHostname" -> "unknown" in
 290
 291   let libvirt_version =
 292     let v, _ = Libvirt.get_version () in
 293     v / 1_000_000, (v / 1_000) mod 1_000, v mod 1_000 in
 294
 295   (* Open debug file if specified.
 296    * NB: Do this just before jumping into curses mode.
 297    *)
 298   (match !debug_file with
 299    | "" -> (* No debug file specified, send stderr to /dev/null unless
 300             * we're in script mode.
 301             *)
 302        if not !script_mode && not !stream_mode then (
 303          let fd = Unix.openfile "/dev/null" [Unix.O_WRONLY] 0o644 in
 304          Unix.dup2 fd Unix.stderr;
 305          Unix.close fd
 306        )
 307    | filename -> (* Send stderr to the named file. *)
 308        let fd =
 309          Unix.openfile filename [Unix.O_WRONLY;Unix.O_CREAT;Unix.O_TRUNC]
 310            0o644 in
 311        Unix.dup2 fd Unix.stderr;
 312        Unix.close fd
 313   );
 314
 315   (* Curses voodoo (see ncurses(3)). *)
 316   if not !script_mode && not !stream_mode then (
 317     ignore (initscr ());
 318     ignore (cbreak ());
 319     ignore (noecho ());
 320     nonl ();
 321     let stdscr = stdscr () in
 322     ignore (intrflush stdscr false);
 323     ignore (keypad stdscr true);
 324     ()
 325   );
 326
 327   (* This tuple of static information is called 'setup' in other parts
 328    * of this program, and is passed to other functions such as redraw and
 329    * main_loop.  See virt_top_main.ml.
 330    *)
 331   (conn,
 332    !batch_mode, !script_mode, !csv_enabled, !stream_mode, (* immutable modes *)
 333    node_info, hostname, libvirt_version (* info that doesn't change *)
 334   )
 335
 336 (* Show a domain state (the 'S' column). *)
 337 let show_state = function
 338   | D.InfoNoState -> '?'
 339   | D.InfoRunning -> 'R'
 340   | D.InfoBlocked -> 'S'
 341   | D.InfoPaused -> 'P'
 342   | D.InfoShutdown -> 'D'
 343   | D.InfoShutoff -> 'O'
 344   | D.InfoCrashed -> 'X'
 345
 346 (* Sleep in seconds. *)
 347 let sleep = Unix.sleep
 348
 349 (* Sleep in milliseconds. *)
 350 let millisleep n =
 351   ignore (Unix.select [] [] [] (float n /. 1000.))
 352
 353 (* The curses getstr/getnstr functions are just weird.
 354  * This helper function also enables echo temporarily.
 355  *)
 356 let get_string maxlen =
 357   ignore (echo ());
 358   let str = String.create maxlen in
 359   let ok = getstr str in (* Safe because binding calls getnstr. *)
 360   ignore (noecho ());
 361   if not ok then ""
 362   else (
 363     (* Chop at first '\0'. *)
 364     try
 365       let i = String.index str '\000' in
 366       String.sub str 0 i
 367     with
 368       Not_found -> str (* it is full maxlen bytes *)
 369   )
 370
 371 (* Line numbers. *)
 372 let top_lineno = 0
 373 let summary_lineno = 1 (* this takes 2 lines *)
 374 let message_lineno = 3
 375 let header_lineno = 4
 376 let domains_lineno = 5
 377
 378 (* Easier to use versions of curses functions addstr, mvaddstr, etc. *)
 379 let move y x = ignore (move y x)
 380 let refresh () = ignore (refresh ())
 381 let addch c = ignore (addch (int_of_char c))
 382 let addstr s = ignore (addstr s)
 383 let mvaddstr y x s = ignore (mvaddstr y x s)
 384
 385 (* Print in the "message area". *)
 386 let clear_msg () = move message_lineno 0; clrtoeol ()
 387 let print_msg str = clear_msg (); mvaddstr message_lineno 0 str
 388
 389 (* Intermediate "domain + stats" structure that we use to collect
 390  * everything we know about a domain within the collect function.
 391  *)
 392 type rd_domain = Inactive | Active of rd_active
 393 and rd_active = {
 394   rd_domid : int;                       (* Domain ID. *)
 395   rd_dom : [`R] D.t;                    (* Domain object. *)
 396   rd_info : D.info;                     (* Domain CPU info now. *)
 397   rd_block_stats : (string * D.block_stats) list;
 398                                         (* Domain block stats now. *)
 399   rd_interface_stats : (string * D.interface_stats) list;
 400                                         (* Domain net stats now. *)
 401   rd_prev_info : D.info option;         (* Domain CPU info previously. *)
 402   rd_prev_block_stats : (string * D.block_stats) list;
 403                                         (* Domain block stats prev. *)
 404   rd_prev_interface_stats : (string * D.interface_stats) list;
 405                                         (* Domain interface stats prev. *)
 406   (* The following are since the last slice, or 0 if cannot be calculated: *)
 407   rd_cpu_time : float;                  (* CPU time used in nanoseconds. *)
 408   rd_percent_cpu : float;               (* CPU time as percent of total. *)
 409   rd_mem_bytes : int64;                 (* Memory usage in bytes *)
 410   rd_mem_percent: int64;                (* Memory usage as percent of total *)
 411   (* The following are since the last slice, or None if cannot be calc'd: *)
 412   rd_block_rd_reqs : int64 option;      (* Number of block device read rqs. *)
 413   rd_block_wr_reqs : int64 option;      (* Number of block device write rqs. *)
 414   rd_block_rd_bytes : int64 option;   (* Number of bytes block device read *)
 415   rd_block_wr_bytes : int64 option;   (* Number of bytes block device write *)
 416   (* _info fields includes the number considering --block_in_bytes option *)
 417   rd_block_rd_info : int64 option;    (* Block device read info for user *)
 418   rd_block_wr_info : int64 option;    (* Block device read info for user *)
 419
 420   rd_net_rx_bytes : int64 option;       (* Number of bytes received. *)
 421   rd_net_tx_bytes : int64 option;       (* Number of bytes transmitted. *)
 422 }
 423
 424 (* Collect stats. *)
 425 let collect, clear_pcpu_display_data =
 426   (* We cache the list of block devices and interfaces for each domain
 427    * here, so we don't need to reparse the XML each time.
 428    *)
 429   let devices = Hashtbl.create 13 in
 430
 431   (* Function to get the list of block devices, network interfaces for
 432    * a particular domain.  Get it from the devices cache, and if not
 433    * there then parse the domain XML.
 434    *)
 435   let get_devices id dom =
 436     try Hashtbl.find devices id
 437     with Not_found ->
 438       let blkdevs, netifs = (!parse_device_xml) id dom in
 439       Hashtbl.replace devices id (blkdevs, netifs);
 440       blkdevs, netifs
 441   in
 442
 443   (* We save the state of domains across redraws here, which allows us
 444    * to deduce %CPU usage from the running total.
 445    *)
 446   let last_info = Hashtbl.create 13 in
 447   let last_time = ref (Unix.gettimeofday ()) in
 448
 449   (* Save pcpu_usages structures across redraws too (only for pCPU display). *)
 450   let last_pcpu_usages = Hashtbl.create 13 in
 451
 452   let clear_pcpu_display_data () =
 453     (* Clear out pcpu_usages used by PCPUDisplay display_mode
 454      * when we switch back to TaskDisplay mode.
 455      *)
 456     Hashtbl.clear last_pcpu_usages
 457   in
 458
 459   let collect (conn, _, _, _, _, node_info, _, _) =
 460     (* Number of physical CPUs (some may be disabled). *)
 461     let nr_pcpus = C.maxcpus_of_node_info node_info in
 462
 463     (* Get the current time. *)
 464     let time = Unix.gettimeofday () in
 465     let tm = Unix.localtime time in
 466     let printable_time =
 467       sprintf "%02d:%02d:%02d" tm.Unix.tm_hour tm.Unix.tm_min tm.Unix.tm_sec in
 468
 469     (* What's the total CPU time elapsed since we were last called? (ns) *)
 470     let total_cpu_per_pcpu = 1_000_000_000. *. (time -. !last_time) in
 471     (* Avoid division by zero. *)
 472     let total_cpu_per_pcpu =
 473       if total_cpu_per_pcpu <= 0. then 1. else total_cpu_per_pcpu in
 474     let total_cpu = float node_info.C.cpus *. total_cpu_per_pcpu in
 475
 476     (* Get the domains.  Match up with their last_info (if any). *)
 477     let doms =
 478       (* Active domains. *)
 479       let n = C.num_of_domains conn in
 480       let ids =
 481         if n > 0 then Array.to_list (C.list_domains conn n)
 482         else [] in
 483       let doms =
 484         List.filter_map (
 485           fun id ->
 486             try
 487               let dom = D.lookup_by_id conn id in
 488               let name = D.get_name dom in
 489               let blkdevs, netifs = get_devices id dom in
 490
 491               (* Get current CPU, block and network stats. *)
 492               let info = D.get_info dom in
 493               let block_stats =
 494                 try List.map (fun dev -> dev, D.block_stats dom dev) blkdevs
 495                 with
 496                 | Libvirt.Not_supported "virDomainBlockStats"
 497                 | Libvirt.Virterror _ -> [] in
 498               let interface_stats =
 499                 try List.map (fun dev -> dev, D.interface_stats dom dev) netifs
 500                 with
 501                 | Libvirt.Not_supported "virDomainInterfaceStats"
 502                 | Libvirt.Virterror _ -> [] in
 503
 504               let prev_info, prev_block_stats, prev_interface_stats =
 505                 try
 506                   let prev_info, prev_block_stats, prev_interface_stats =
 507                     Hashtbl.find last_info id in
 508                   Some prev_info, prev_block_stats, prev_interface_stats
 509                 with Not_found -> None, [], [] in
 510
 511               Some (name, Active {
 512                       rd_domid = id; rd_dom = dom; rd_info = info;
 513                       rd_block_stats = block_stats;
 514                       rd_interface_stats = interface_stats;
 515                       rd_prev_info = prev_info;
 516                       rd_prev_block_stats = prev_block_stats;
 517                       rd_prev_interface_stats = prev_interface_stats;
 518                       rd_cpu_time = 0.; rd_percent_cpu = 0.;
 519                       rd_mem_bytes = 0L; rd_mem_percent = 0L;
 520                       rd_block_rd_reqs = None; rd_block_wr_reqs = None;
 521                       rd_block_rd_bytes = None; rd_block_wr_bytes = None;
 522                       rd_block_rd_info = None; rd_block_wr_info = None;
 523                       rd_net_rx_bytes = None; rd_net_tx_bytes = None;
 524                     })
 525             with
 526               Libvirt.Virterror _ -> None (* ignore transient error *)
 527         ) ids in
 528
 529       (* Inactive domains. *)
 530       let doms_inactive =
 531         try
 532           let n = C.num_of_defined_domains conn in
 533           let names =
 534             if n > 0 then Array.to_list (C.list_defined_domains conn n)
 535             else [] in
 536           List.map (fun name -> name, Inactive) names
 537         with
 538           (* Ignore transient errors, in particular errors from
 539            * num_of_defined_domains if it cannot contact xend.
 540            *)
 541         | Libvirt.Virterror _ -> [] in
 542
 543       doms @ doms_inactive in
 544
 545     (* Calculate the CPU time (ns) and %CPU used by each domain. *)
 546     let doms =
 547       List.map (
 548         function
 549         (* We have previous CPU info from which to calculate it? *)
 550         | name, Active ({ rd_prev_info = Some prev_info } as rd) ->
 551             let cpu_time =
 552               Int64.to_float (rd.rd_info.D.cpu_time -^ prev_info.D.cpu_time) in
 553             let percent_cpu = 100. *. cpu_time /. total_cpu in
 554             let mem_usage = rd.rd_info.D.memory in
 555             let mem_percent =
 556                 100L *^ rd.rd_info.D.memory /^ node_info.C.memory in
 557             let rd = { rd with
 558                          rd_cpu_time = cpu_time;
 559                          rd_percent_cpu = percent_cpu;
 560                          rd_mem_bytes = mem_usage;
 561                          rd_mem_percent = mem_percent} in
 562             name, Active rd
 563         (* For all other domains we can't calculate it, so leave as 0 *)
 564         | rd -> rd
 565       ) doms in
 566
 567     (* Calculate the number of block device read/write requests across
 568      * all block devices attached to a domain.
 569      *)
 570     let doms =
 571       List.map (
 572         function
 573         (* Do we have stats from the previous slice? *)
 574         | name, Active ({ rd_prev_block_stats = ((_::_) as prev_block_stats) }
 575                           as rd) ->
 576             let block_stats = rd.rd_block_stats in (* stats now *)
 577
 578             (* Add all the devices together.  Throw away device names. *)
 579             let prev_block_stats =
 580               sum_block_stats (List.map snd prev_block_stats) in
 581             let block_stats =
 582               sum_block_stats (List.map snd block_stats) in
 583
 584             (* Calculate increase in read & write requests. *)
 585             let read_reqs =
 586               block_stats.D.rd_req -^ prev_block_stats.D.rd_req in
 587             let write_reqs =
 588               block_stats.D.wr_req -^ prev_block_stats.D.wr_req in
 589             let read_bytes =
 590               block_stats.D.rd_bytes -^ prev_block_stats.D.rd_bytes in
 591             let write_bytes =
 592               block_stats.D.wr_bytes -^ prev_block_stats.D.wr_bytes in
 593
 594             let rd = { rd with
 595                          rd_block_rd_reqs = Some read_reqs;
 596                          rd_block_wr_reqs = Some write_reqs;
 597                          rd_block_rd_bytes = Some read_bytes;
 598                          rd_block_wr_bytes = Some write_bytes;
 599             } in
 600             let rd = { rd with
 601                          rd_block_rd_info = if !block_in_bytes then
 602                          rd.rd_block_rd_bytes else rd.rd_block_rd_reqs;
 603                          rd_block_wr_info = if !block_in_bytes then
 604                          rd.rd_block_wr_bytes else rd.rd_block_wr_reqs;
 605             } in
 606             name, Active rd
 607         (* For all other domains we can't calculate it, so leave as None. *)
 608         | rd -> rd
 609       ) doms in
 610
 611     (* Calculate the same as above for network interfaces across
 612      * all network interfaces attached to a domain.
 613      *)
 614     let doms =
 615       List.map (
 616         function
 617         (* Do we have stats from the previous slice? *)
 618         | name, Active ({ rd_prev_interface_stats =
 619                               ((_::_) as prev_interface_stats) }
 620                           as rd) ->
 621             let interface_stats = rd.rd_interface_stats in (* stats now *)
 622
 623             (* Add all the devices together.  Throw away device names. *)
 624             let prev_interface_stats =
 625               sum_interface_stats (List.map snd prev_interface_stats) in
 626             let interface_stats =
 627               sum_interface_stats (List.map snd interface_stats) in
 628
 629             (* Calculate increase in rx & tx bytes. *)
 630             let rx_bytes =
 631               interface_stats.D.rx_bytes -^ prev_interface_stats.D.rx_bytes in
 632             let tx_bytes =
 633               interface_stats.D.tx_bytes -^ prev_interface_stats.D.tx_bytes in
 634
 635             let rd = { rd with
 636                          rd_net_rx_bytes = Some rx_bytes;
 637                          rd_net_tx_bytes = Some tx_bytes } in
 638             name, Active rd
 639         (* For all other domains we can't calculate it, so leave as None. *)
 640         | rd -> rd
 641       ) doms in
 642
 643     (* Collect some extra information in PCPUDisplay display_mode. *)
 644     let pcpu_display =
 645       if !display_mode = PCPUDisplay then (
 646         (* Get the VCPU info and VCPU->PCPU mappings for active domains.
 647          * Also cull some data we don't care about.
 648          *)
 649         let doms = List.filter_map (
 650           function
 651           | (name, Active rd) ->
 652               (try
 653                  let domid = rd.rd_domid in
 654                  let maplen = C.cpumaplen nr_pcpus in
 655                  let cpu_stats = D.get_cpu_stats rd.rd_dom nr_pcpus in
 656                  let rec find_usages_from_stats = function
 657                    | ("cpu_time", D.TypedFieldUInt64 usages) :: _ -> usages
 658                    | _ :: params -> find_usages_from_stats params
 659                    | [] -> 0L in
 660                  let pcpu_usages = Array.map find_usages_from_stats cpu_stats in
 661                  let maxinfo = rd.rd_info.D.nr_virt_cpu in
 662                  let nr_vcpus, vcpu_infos, cpumaps =
 663                    D.get_vcpus rd.rd_dom maxinfo maplen in
 664
 665                  (* Got previous pcpu_usages for this domain? *)
 666                  let prev_pcpu_usages =
 667                    try Some (Hashtbl.find last_pcpu_usages domid)
 668                    with Not_found -> None in
 669                  (* Update last_pcpu_usages. *)
 670                  Hashtbl.replace last_pcpu_usages domid pcpu_usages;
 671
 672                  (match prev_pcpu_usages with
 673                   | Some prev_pcpu_usages
 674                       when Array.length prev_pcpu_usages = Array.length pcpu_usages ->
 675                       Some (domid, name, nr_vcpus, vcpu_infos, pcpu_usages,
 676                             prev_pcpu_usages, cpumaps, maplen)
 677                   | _ -> None (* ignore missing / unequal length prev_vcpu_infos *)
 678                  );
 679                with
 680                  Libvirt.Virterror _ -> None(* ignore transient libvirt errs *)
 681               )
 682           | (_, Inactive) -> None (* ignore inactive doms *)
 683         ) doms in
 684         let nr_doms = List.length doms in
 685
 686         (* Rearrange the data into a matrix.  Major axis (down) is
 687          * pCPUs.  Minor axis (right) is domains.  At each node we store:
 688          *  cpu_time (on this pCPU only, nanosecs),
 689          *)
 690         let pcpus = Array.make_matrix nr_pcpus nr_doms 0L in
 691
 692         List.iteri (
 693           fun di (domid, name, nr_vcpus, vcpu_infos, pcpu_usages,
 694                   prev_pcpu_usages, cpumaps, maplen) ->
 695             (* Which pCPUs can this dom run on? *)
 696             for p = 0 to Array.length pcpu_usages - 1 do
 697               pcpus.(p).(di) <- pcpu_usages.(p) -^ prev_pcpu_usages.(p)
 698             done
 699         ) doms;
 700
 701         (* Sum the CPU time used by each pCPU, for the %CPU column. *)
 702         let pcpus_cpu_time = Array.map (
 703           fun row ->
 704             let cpu_time = ref 0L in
 705             for di = 0 to Array.length row-1 do
 706               let t = row.(di) in
 707               cpu_time := !cpu_time +^ t
 708             done;
 709             Int64.to_float !cpu_time
 710         ) pcpus in
 711
 712         Some (doms, pcpus, pcpus_cpu_time)
 713       ) else
 714         None in
 715
 716     (* Calculate totals. *)
 717     let totals = List.fold_left (
 718       fun (count, running, blocked, paused, shutdown, shutoff,
 719            crashed, active, inactive,
 720            total_cpu_time, total_memory, total_domU_memory) ->
 721         function
 722         | (name, Active rd) ->
 723             let test state orig =
 724               if rd.rd_info.D.state = state then orig+1 else orig
 725             in
 726             let running = test D.InfoRunning running in
 727             let blocked = test D.InfoBlocked blocked in
 728             let paused = test D.InfoPaused paused in
 729             let shutdown = test D.InfoShutdown shutdown in
 730             let shutoff = test D.InfoShutoff shutoff in
 731             let crashed = test D.InfoCrashed crashed in
 732
 733             let total_cpu_time = total_cpu_time +. rd.rd_cpu_time in
 734             let total_memory = total_memory +^ rd.rd_info.D.memory in
 735             let total_domU_memory = total_domU_memory +^
 736               if rd.rd_domid > 0 then rd.rd_info.D.memory else 0L in
 737
 738             (count+1, running, blocked, paused, shutdown, shutoff,
 739              crashed, active+1, inactive,
 740              total_cpu_time, total_memory, total_domU_memory)
 741
 742         | (name, Inactive) -> (* inactive domain *)
 743             (count+1, running, blocked, paused, shutdown, shutoff,
 744              crashed, active, inactive+1,
 745              total_cpu_time, total_memory, total_domU_memory)
 746     ) (0,0,0,0,0,0,0,0,0, 0.,0L,0L) doms in
 747
 748     (* Update last_time, last_info. *)
 749     last_time := time;
 750     Hashtbl.clear last_info;
 751     List.iter (
 752       function
 753       | (_, Active rd) ->
 754           let info = rd.rd_info, rd.rd_block_stats, rd.rd_interface_stats in
 755           Hashtbl.add last_info rd.rd_domid info
 756       | _ -> ()
 757     ) doms;
 758
 759     (doms,
 760      time, printable_time,
 761      nr_pcpus, total_cpu, total_cpu_per_pcpu,
 762      totals,
 763      pcpu_display)
 764   in
 765
 766   collect, clear_pcpu_display_data
 767
 768 (* Redraw the display. *)
 769 let redraw =
 770   (* Keep a historical list of %CPU usages. *)
 771   let historical_cpu = ref [] in
 772   let historical_cpu_last_time = ref (Unix.gettimeofday ()) in
 773   fun
 774   (_, _, _, _, _, node_info, _, _) (* setup *)
 775   (doms,
 776    time, printable_time,
 777    nr_pcpus, total_cpu, total_cpu_per_pcpu,
 778    totals,
 779    pcpu_display) (* state *) ->
 780     clear ();
 781
 782     (* Get the screen/window size. *)
 783     let lines, cols = get_size () in
 784
 785     (* Time. *)
 786     mvaddstr top_lineno 0 (sprintf "virt-top %s - " printable_time);
 787
 788     (* Basic node_info. *)
 789     addstr
 790       (sprintf "%s %d/%dCPU %dMHz %LdMB "
 791          node_info.C.model node_info.C.cpus nr_pcpus node_info.C.mhz
 792          (node_info.C.memory /^ 1024L));
 793     (* Save the cursor position for when we come to draw the
 794      * historical CPU times (down in this function).
 795      *)
 796     let stdscr = stdscr () in
 797     let historical_cursor = getyx stdscr in
 798
 799     (match !display_mode with
 800      | TaskDisplay -> (*---------- Showing domains ----------*)
 801          (* Sort domains on current sort_order. *)
 802          let doms =
 803            let cmp =
 804              match !sort_order with
 805              | DomainName ->
 806                  (fun _ -> 0) (* fallthrough to default name compare *)
 807              | Processor ->
 808                  (function
 809                   | Active rd1, Active rd2 ->
 810                       compare rd2.rd_percent_cpu rd1.rd_percent_cpu
 811                   | Active _, Inactive -> -1
 812                   | Inactive, Active _ -> 1
 813                   | Inactive, Inactive -> 0)
 814              | Memory ->
 815                  (function
 816                   | Active { rd_info = info1 }, Active { rd_info = info2 } ->
 817                       compare info2.D.memory info1.D.memory
 818                   | Active _, Inactive -> -1
 819                   | Inactive, Active _ -> 1
 820                   | Inactive, Inactive -> 0)
 821              | Time ->
 822                  (function
 823                   | Active { rd_info = info1 }, Active { rd_info = info2 } ->
 824                       compare info2.D.cpu_time info1.D.cpu_time
 825                   | Active _, Inactive -> -1
 826                   | Inactive, Active _ -> 1
 827                   | Inactive, Inactive -> 0)
 828              | DomainID ->
 829                  (function
 830                   | Active { rd_domid = id1 }, Active { rd_domid = id2 } ->
 831                       compare id1 id2
 832                   | Active _, Inactive -> -1
 833                   | Inactive, Active _ -> 1
 834                   | Inactive, Inactive -> 0)
 835              | NetRX ->
 836                  (function
 837                   | Active { rd_net_rx_bytes = r1 }, Active { rd_net_rx_bytes = r2 } ->
 838                       compare r2 r1
 839                   | Active _, Inactive -> -1
 840                   | Inactive, Active _ -> 1
 841                   | Inactive, Inactive -> 0)
 842              | NetTX ->
 843                  (function
 844                   | Active { rd_net_tx_bytes = r1 }, Active { rd_net_tx_bytes = r2 } ->
 845                       compare r2 r1
 846                   | Active _, Inactive -> -1
 847                   | Inactive, Active _ -> 1
 848                   | Inactive, Inactive -> 0)
 849              | BlockRdRq ->
 850                  (function
 851                   | Active { rd_block_rd_reqs = r1 }, Active { rd_block_rd_reqs = r2 } ->
 852                       compare r2 r1
 853                   | Active _, Inactive -> -1
 854                   | Inactive, Active _ -> 1
 855                   | Inactive, Inactive -> 0)
 856              | BlockWrRq ->
 857                  (function
 858                   | Active { rd_block_wr_reqs = r1 }, Active { rd_block_wr_reqs = r2 } ->
 859                       compare r2 r1
 860                   | Active _, Inactive -> -1
 861                   | Inactive, Active _ -> 1
 862                   | Inactive, Inactive -> 0)
 863            in
 864            let cmp (name1, dom1) (name2, dom2) =
 865              let r = cmp (dom1, dom2) in
 866              if r <> 0 then r
 867              else compare name1 name2
 868            in
 869            List.sort ~cmp doms in
 870
 871          (* Print domains. *)
 872          attron A.reverse;
 873          let header_string = if !block_in_bytes
 874          then "   ID S RDBY WRBY RXBY TXBY %CPU %MEM    TIME   NAME"
 875          else "   ID S RDRQ WRRQ RXBY TXBY %CPU %MEM    TIME   NAME"
 876          in
 877            mvaddstr header_lineno 0
 878             (pad cols header_string);
 879          attroff A.reverse;
 880
 881          let rec loop lineno = function
 882            | [] -> ()
 883            | (name, Active rd) :: doms ->
 884                if lineno < lines then (
 885                  let state = show_state rd.rd_info.D.state in
 886                  let rd_req = Show.int64_option rd.rd_block_rd_info in
 887                  let wr_req = Show.int64_option rd.rd_block_wr_info in
 888                  let rx_bytes = Show.int64_option rd.rd_net_rx_bytes in
 889                  let tx_bytes = Show.int64_option rd.rd_net_tx_bytes in
 890                  let percent_cpu = Show.percent rd.rd_percent_cpu in
 891                  let percent_mem = Int64.to_float rd.rd_mem_percent in
 892                  let percent_mem = Show.percent percent_mem in
 893                  let time = Show.time rd.rd_info.D.cpu_time in
 894
 895                  let line = sprintf "%5d %c %s %s %s %s %s %s %s %s"
 896                    rd.rd_domid state rd_req wr_req rx_bytes tx_bytes
 897                    percent_cpu percent_mem time name in
 898                  let line = pad cols line in
 899                  mvaddstr lineno 0 line;
 900                  loop (lineno+1) doms
 901                )
 902            | (name, Inactive) :: doms -> (* inactive domain *)
 903                if lineno < lines then (
 904                  let line =
 905                    sprintf
 906                      "    -                                           (%s)"
 907                      name in
 908                  let line = pad cols line in
 909                  mvaddstr lineno 0 line;
 910                  loop (lineno+1) doms
 911                )
 912          in
 913          loop domains_lineno doms
 914
 915      | PCPUDisplay -> (*---------- Showing physical CPUs ----------*)
 916          let doms, pcpus, pcpus_cpu_time =
 917            match pcpu_display with
 918            | Some p -> p
 919            | None -> failwith "internal error: no pcpu_display data" in
 920
 921          (* Display the pCPUs. *)
 922          let dom_names =
 923            String.concat "" (
 924              List.map (
 925                fun (_, name, _, _, _, _, _, _) ->
 926                  let len = String.length name in
 927                  let width = max (len+1) 7 in
 928                  pad width name
 929              ) doms
 930            ) in
 931          attron A.reverse;
 932          mvaddstr header_lineno 0 (pad cols ("PHYCPU %CPU " ^ dom_names));
 933          attroff A.reverse;
 934
 935          Array.iteri (
 936            fun p row ->
 937              mvaddstr (p+domains_lineno) 0 (sprintf "%4d   " p);
 938              let cpu_time = pcpus_cpu_time.(p) in (* ns used on this CPU *)
 939              let percent_cpu = 100. *. cpu_time /. total_cpu_per_pcpu in
 940              addstr (Show.percent percent_cpu);
 941              addch ' ';
 942
 943              List.iteri (
 944                fun di (domid, name, _, _, _, _, _, _) ->
 945                  let t = pcpus.(p).(di) in
 946                  let len = String.length name in
 947                  let width = max (len+1) 7 in
 948                  let str =
 949                    if t <= 0L then ""
 950                    else (
 951                      let t = Int64.to_float t in
 952                      let percent = 100. *. t /. total_cpu_per_pcpu in
 953                      sprintf "%s " (Show.percent percent)
 954                    ) in
 955                  addstr (pad width str);
 956                  ()
 957              ) doms
 958          ) pcpus;
 959
 960      | NetDisplay -> (*---------- Showing network interfaces ----------*)
 961          (* Only care about active domains. *)
 962          let doms = List.filter_map (
 963            function
 964            | (name, Active rd) -> Some (name, rd)
 965            | (_, Inactive) -> None
 966          ) doms in
 967
 968          (* For each domain we have a list of network interfaces seen
 969           * this slice, and seen in the previous slice, which we now
 970           * match up to get a list of (domain, interface) for which
 971           * we have current & previous knowledge.  (And ignore the rest).
 972           *)
 973          let devs =
 974            List.map (
 975              fun (name, rd) ->
 976                List.filter_map (
 977                  fun (dev, stats) ->
 978                    try
 979                      (* Have prev slice stats for this device? *)
 980                      let prev_stats =
 981                        List.assoc dev rd.rd_prev_interface_stats in
 982                      Some (dev, name, rd, stats, prev_stats)
 983                    with Not_found -> None
 984                ) rd.rd_interface_stats
 985            ) doms in
 986
 987          (* Finally we have a list of:
 988           * device name, domain name, rd_* stuff, curr stats, prev stats.
 989           *)
 990          let devs : (string * string * rd_active *
 991                        D.interface_stats * D.interface_stats) list =
 992            List.flatten devs in
 993
 994          (* Difference curr slice & prev slice. *)
 995          let devs = List.map (
 996            fun (dev, name, rd, curr, prev) ->
 997              dev, name, rd, diff_interface_stats curr prev
 998          ) devs in
 999
1000          (* Sort by current sort order, but map some of the standard
1001           * sort orders into ones which makes sense here.
1002           *)
1003          let devs =
1004            let cmp =
1005              match !sort_order with
1006              | DomainName ->
1007                  (fun _ -> 0) (* fallthrough to default name compare *)
1008              | DomainID ->
1009                  (fun (_, { rd_domid = id1 }, _, { rd_domid = id2 }) ->
1010                     compare id1 id2)
1011              | Processor | Memory | Time | BlockRdRq | BlockWrRq
1012                    (* fallthrough to RXBY comparison. *)
1013              | NetRX ->
1014                  (fun ({ D.rx_bytes = b1 }, _, { D.rx_bytes = b2 }, _) ->
1015                     compare b2 b1)
1016              | NetTX ->
1017                  (fun ({ D.tx_bytes = b1 }, _, { D.tx_bytes = b2 }, _) ->
1018                     compare b2 b1)
1019            in
1020            let cmp (dev1, name1, rd1, stats1) (dev2, name2, rd2, stats2) =
1021              let r = cmp (stats1, rd1, stats2, rd2) in
1022              if r <> 0 then r
1023              else compare (dev1, name1) (dev2, name2)
1024            in
1025            List.sort ~cmp devs in
1026
1027          (* Print the header for network devices. *)
1028          attron A.reverse;
1029          mvaddstr header_lineno 0
1030            (pad cols "   ID S RXBY TXBY RXPK TXPK DOMAIN       INTERFACE");
1031          attroff A.reverse;
1032
1033          (* Print domains and devices. *)
1034          let rec loop lineno = function
1035            | [] -> ()
1036            | (dev, name, rd, stats) :: devs ->
1037                if lineno < lines then (
1038                  let state = show_state rd.rd_info.D.state in
1039                  let rx_bytes =
1040                    if stats.D.rx_bytes >= 0L
1041                    then Show.int64 stats.D.rx_bytes
1042                    else "    " in
1043                  let tx_bytes =
1044                    if stats.D.tx_bytes >= 0L
1045                    then Show.int64 stats.D.tx_bytes
1046                    else "    " in
1047                  let rx_packets =
1048                    if stats.D.rx_packets >= 0L
1049                    then Show.int64 stats.D.rx_packets
1050                    else "    " in
1051                  let tx_packets =
1052                    if stats.D.tx_packets >= 0L
1053                    then Show.int64 stats.D.tx_packets
1054                    else "    " in
1055
1056                  let line = sprintf "%5d %c %s %s %s %s %-12s %s"
1057                    rd.rd_domid state
1058                    rx_bytes tx_bytes
1059                    rx_packets tx_packets
1060                    (pad 12 name) dev in
1061                  let line = pad cols line in
1062                  mvaddstr lineno 0 line;
1063                  loop (lineno+1) devs
1064                )
1065          in
1066          loop domains_lineno devs
1067
1068      | BlockDisplay -> (*---------- Showing block devices ----------*)
1069          (* Only care about active domains. *)
1070          let doms = List.filter_map (
1071            function
1072            | (name, Active rd) -> Some (name, rd)
1073            | (_, Inactive) -> None
1074          ) doms in
1075
1076          (* For each domain we have a list of block devices seen
1077           * this slice, and seen in the previous slice, which we now
1078           * match up to get a list of (domain, device) for which
1079           * we have current & previous knowledge.  (And ignore the rest).
1080           *)
1081          let devs =
1082            List.map (
1083              fun (name, rd) ->
1084                List.filter_map (
1085                  fun (dev, stats) ->
1086                    try
1087                      (* Have prev slice stats for this device? *)
1088                      let prev_stats =
1089                        List.assoc dev rd.rd_prev_block_stats in
1090                      Some (dev, name, rd, stats, prev_stats)
1091                    with Not_found -> None
1092                ) rd.rd_block_stats
1093            ) doms in
1094
1095          (* Finally we have a list of:
1096           * device name, domain name, rd_* stuff, curr stats, prev stats.
1097           *)
1098          let devs : (string * string * rd_active *
1099                        D.block_stats * D.block_stats) list =
1100            List.flatten devs in
1101
1102          (* Difference curr slice & prev slice. *)
1103          let devs = List.map (
1104            fun (dev, name, rd, curr, prev) ->
1105              dev, name, rd, diff_block_stats curr prev
1106          ) devs in
1107
1108          (* Sort by current sort order, but map some of the standard
1109           * sort orders into ones which makes sense here.
1110           *)
1111          let devs =
1112            let cmp =
1113              match !sort_order with
1114              | DomainName ->
1115                  (fun _ -> 0) (* fallthrough to default name compare *)
1116              | DomainID ->
1117                  (fun (_, { rd_domid = id1 }, _, { rd_domid = id2 }) ->
1118                     compare id1 id2)
1119              | Processor | Memory | Time | NetRX | NetTX
1120                    (* fallthrough to RDRQ comparison. *)
1121              | BlockRdRq ->
1122                  (fun ({ D.rd_req = b1 }, _, { D.rd_req = b2 }, _) ->
1123                     compare b2 b1)
1124              | BlockWrRq ->
1125                  (fun ({ D.wr_req = b1 }, _, { D.wr_req = b2 }, _) ->
1126                     compare b2 b1)
1127            in
1128            let cmp (dev1, name1, rd1, stats1) (dev2, name2, rd2, stats2) =
1129              let r = cmp (stats1, rd1, stats2, rd2) in
1130              if r <> 0 then r
1131              else compare (dev1, name1) (dev2, name2)
1132            in
1133            List.sort ~cmp devs in
1134
1135          (* Print the header for block devices. *)
1136          attron A.reverse;
1137          mvaddstr header_lineno 0
1138            (pad cols "   ID S RDBY WRBY RDRQ WRRQ DOMAIN       DEVICE");
1139          attroff A.reverse;
1140
1141          (* Print domains and devices. *)
1142          let rec loop lineno = function
1143            | [] -> ()
1144            | (dev, name, rd, stats) :: devs ->
1145                if lineno < lines then (
1146                  let state = show_state rd.rd_info.D.state in
1147                  let rd_bytes =
1148                    if stats.D.rd_bytes >= 0L
1149                    then Show.int64 stats.D.rd_bytes
1150                    else "    " in
1151                  let wr_bytes =
1152                    if stats.D.wr_bytes >= 0L
1153                    then Show.int64 stats.D.wr_bytes
1154                    else "    " in
1155                  let rd_req =
1156                    if stats.D.rd_req >= 0L
1157                    then Show.int64 stats.D.rd_req
1158                    else "    " in
1159                  let wr_req =
1160                    if stats.D.wr_req >= 0L
1161                    then Show.int64 stats.D.wr_req
1162                    else "    " in
1163
1164                  let line = sprintf "%5d %c %s %s %s %s %-12s %s"
1165                    rd.rd_domid state
1166                    rd_bytes wr_bytes
1167                    rd_req wr_req
1168                    (pad 12 name) dev in
1169                  let line = pad cols line in
1170                  mvaddstr lineno 0 line;
1171                  loop (lineno+1) devs
1172                )
1173          in
1174          loop domains_lineno devs
1175     ); (* end of display_mode conditional section *)
1176
1177     let (count, running, blocked, paused, shutdown, shutoff,
1178          crashed, active, inactive,
1179          total_cpu_time, total_memory, total_domU_memory) = totals in
1180
1181     mvaddstr summary_lineno 0
1182       (sprintf
1183          (f_"%d domains, %d active, %d running, %d sleeping, %d paused, %d inactive D:%d O:%d X:%d")
1184          count active running blocked paused inactive shutdown shutoff crashed);
1185
1186     (* Total %CPU used, and memory summary. *)
1187     let percent_cpu = 100. *. total_cpu_time /. total_cpu in
1188     mvaddstr (summary_lineno+1) 0
1189       (sprintf
1190          (f_"CPU: %2.1f%%  Mem: %Ld MB (%Ld MB by guests)")
1191          percent_cpu (total_memory /^ 1024L) (total_domU_memory /^ 1024L));
1192
1193     (* Time to grab another historical %CPU for the list? *)
1194     if time >= !historical_cpu_last_time +. float !historical_cpu_delay
1195     then (
1196       historical_cpu := percent_cpu :: List.take 10 !historical_cpu;
1197       historical_cpu_last_time := time
1198     );
1199
1200     (* Display historical CPU time. *)
1201     let () =
1202       let y, x = historical_cursor in
1203       let maxwidth = cols - x in
1204       let line =
1205         String.concat " "
1206           (List.map (sprintf "%2.1f%%") !historical_cpu) in
1207       let line = pad maxwidth line in
1208       mvaddstr y x line;
1209       () in
1210
1211     move message_lineno 0; (* Park cursor in message area, as with top. *)
1212     refresh ()             (* Refresh the display. *)
1213
1214 (* Write CSV header row. *)
1215 let write_csv_header () =
1216   (!csv_write) (
1217     [ "Hostname"; "Time"; "Arch"; "Physical CPUs";
1218       "Count"; "Running"; "Blocked"; "Paused"; "Shutdown";
1219       "Shutoff"; "Crashed"; "Active"; "Inactive";
1220       "%CPU";
1221       "Total hardware memory (KB)";
1222       "Total memory (KB)"; "Total guest memory (KB)";
1223       "Total CPU time (ns)" ] @
1224       (* These fields are repeated for each domain: *)
1225     [ "Domain ID"; "Domain name"; ] @
1226     (if !csv_cpu then [ "CPU (ns)"; "%CPU"; ] else []) @
1227     (if !csv_mem then [ "Mem (bytes)"; "%Mem";] else []) @
1228     (if !csv_block && not !block_in_bytes
1229        then [ "Block RDRQ"; "Block WRRQ"; ] else []) @
1230     (if !csv_block && !block_in_bytes
1231        then [ "Block RDBY"; "Block WRBY"; ] else []) @
1232     (if !csv_net then [ "Net RXBY"; "Net TXBY" ] else [])
1233   )
1234
1235 (* Write summary data to CSV file. *)
1236 let append_csv
1237     (_, _, _, _, _, node_info, hostname, _) (* setup *)
1238     (doms,
1239      _, printable_time,
1240      nr_pcpus, total_cpu, _,
1241      totals,
1242      _) (* state *) =
1243
1244   (* The totals / summary fields. *)
1245   let (count, running, blocked, paused, shutdown, shutoff,
1246        crashed, active, inactive,
1247        total_cpu_time, total_memory, total_domU_memory) = totals in
1248
1249   let percent_cpu = 100. *. total_cpu_time /. total_cpu in
1250
1251   let summary_fields = [
1252     hostname; printable_time; node_info.C.model; string_of_int nr_pcpus;
1253     string_of_int count; string_of_int running; string_of_int blocked;
1254     string_of_int paused; string_of_int shutdown; string_of_int shutoff;
1255     string_of_int crashed; string_of_int active; string_of_int inactive;
1256     sprintf "%2.1f" percent_cpu;
1257     Int64.to_string node_info.C.memory;
1258     Int64.to_string total_memory; Int64.to_string total_domU_memory;
1259     Int64.to_string (Int64.of_float total_cpu_time)
1260   ] in
1261
1262   (* The domains.
1263    *
1264    * Sort them by ID so that the list of relatively stable.  Ignore
1265    * inactive domains.
1266    *)
1267   let doms = List.filter_map (
1268     function
1269     | _, Inactive -> None               (* Ignore inactive domains. *)
1270     | name, Active rd -> Some (name, rd)
1271   ) doms in
1272   let cmp (_, { rd_domid = rd_domid1 }) (_, { rd_domid = rd_domid2 }) =
1273     compare rd_domid1 rd_domid2
1274   in
1275   let doms = List.sort ~cmp doms in
1276
1277   let string_of_int64_option = Option.map_default Int64.to_string "" in
1278
1279   let domain_fields = List.map (
1280     fun (domname, rd) ->
1281       [ string_of_int rd.rd_domid; domname ] @
1282         (if !csv_cpu then [
1283            string_of_float rd.rd_cpu_time; string_of_float rd.rd_percent_cpu
1284          ] else []) @
1285         (if !csv_mem then [
1286             Int64.to_string rd.rd_mem_bytes; Int64.to_string rd.rd_mem_percent
1287          ] else []) @
1288         (if !csv_block then [
1289            string_of_int64_option rd.rd_block_rd_info;
1290            string_of_int64_option rd.rd_block_wr_info;
1291          ] else []) @
1292         (if !csv_net then [
1293            string_of_int64_option rd.rd_net_rx_bytes;
1294            string_of_int64_option rd.rd_net_tx_bytes;
1295          ] else [])
1296   ) doms in
1297   let domain_fields = List.flatten domain_fields in
1298
1299   (!csv_write) (summary_fields @ domain_fields)
1300
1301 let dump_stdout
1302     (_, _, _, _, _, node_info, hostname, _) (* setup *)
1303     (doms,
1304      _, printable_time,
1305      nr_pcpus, total_cpu, _,
1306      totals,
1307      _) (* state *) =
1308
1309   (* Header for this iteration *)
1310   printf "virt-top time  %s Host %s %s %d/%dCPU %dMHz %LdMB \n"
1311     printable_time hostname node_info.C.model node_info.C.cpus nr_pcpus
1312     node_info.C.mhz (node_info.C.memory /^ 1024L);
1313   (* dump domain information one by one *)
1314    let rd, wr = if !block_in_bytes then "RDBY", "WRBY" else "RDRQ", "WRRQ"
1315    in
1316      printf "   ID S %s %s RXBY TXBY %%CPU %%MEM   TIME    NAME\n" rd wr;
1317
1318   (* sort by ID *)
1319   let doms =
1320     let compare =
1321       (function
1322        | Active {rd_domid = id1 }, Active {rd_domid = id2} ->
1323            compare id1 id2
1324        | Active _, Inactive -> -1
1325        | Inactive, Active _ -> 1
1326        | Inactive, Inactive -> 0)
1327     in
1328     let cmp  (name1, dom1) (name2, dom2) = compare(dom1, dom2) in
1329     List.sort ~cmp doms in
1330   (*Print domains *)
1331   let dump_domain = fun name rd
1332   -> begin
1333     let state = show_state rd.rd_info.D.state in
1334          let rd_req = if rd.rd_block_rd_info = None then "   0"
1335                       else Show.int64_option rd.rd_block_rd_info in
1336          let wr_req = if rd.rd_block_wr_info = None then "   0"
1337                       else Show.int64_option rd.rd_block_wr_info in
1338     let rx_bytes = if rd.rd_net_rx_bytes = None then "   0"
1339     else Show.int64_option rd.rd_net_rx_bytes in
1340     let tx_bytes = if rd.rd_net_tx_bytes = None then "   0"
1341     else Show.int64_option rd.rd_net_tx_bytes in
1342     let percent_cpu = Show.percent rd.rd_percent_cpu in
1343     let percent_mem = Int64.to_float rd.rd_mem_percent in
1344     let percent_mem = Show.percent percent_mem in
1345     let time = Show.time rd.rd_info.D.cpu_time in
1346     printf "%5d %c %s %s %s %s %s %s %s %s\n"
1347       rd.rd_domid state rd_req wr_req rx_bytes tx_bytes
1348       percent_cpu percent_mem time name;
1349   end
1350   in
1351   List.iter (
1352     function
1353     | name, Active dom -> dump_domain name dom
1354     | name, Inactive -> ()
1355   ) doms;
1356   flush stdout
1357
1358 (* Main loop. *)
1359 let rec main_loop ((_, batch_mode, script_mode, csv_enabled, stream_mode, _, _, _)
1360                      as setup) =
1361   if csv_enabled then write_csv_header ();
1362
1363   while not !quit do
1364     let state = collect setup in                (* Collect stats. *)
1365     (* Redraw display. *)
1366     if not script_mode && not stream_mode then redraw setup state;
1367     if csv_enabled then append_csv setup state; (* Update CSV file. *)
1368     if stream_mode then dump_stdout setup state; (* dump to stdout *)
1369
1370     (* Clear up unused virDomainPtr objects. *)
1371     Gc.compact ();
1372
1373     (* Max iterations? *)
1374     if !iterations >= 0 then (
1375       decr iterations;
1376       if !iterations = 0 then quit := true
1377     );
1378
1379     (* End time?  We might need to adjust the precise delay down if
1380      * the delay would be longer than the end time (RHBZ#637964).  Note
1381      * 'delay' is in milliseconds.
1382      *)
1383     let delay =
1384       match !end_time with
1385       | None ->
1386           (* No --end-time option, so use the current delay. *)
1387           !delay
1388       | Some end_time ->
1389           let (_, time, _, _, _, _, _, _) = state in
1390           let delay_secs = float !delay /. 1000. in
1391           if end_time <= time +. delay_secs then (
1392             quit := true;
1393             let delay = int_of_float (1000. *. (end_time -. time)) in
1394             if delay >= 0 then delay else 0
1395           ) else
1396             !delay in
1397     (*eprintf "adjusted delay = %d\n%!" delay;*)
1398
1399     (* Get next key.  This does the sleep. *)
1400     if not batch_mode && not script_mode && not stream_mode then
1401       get_key_press setup delay
1402     else (
1403       (* Batch mode, script mode, stream mode.  We didn't call
1404        * get_key_press, so we didn't sleep.  Sleep now, unless we are
1405        * about to quit.
1406        *)
1407       if not !quit || !end_time <> None then
1408         millisleep delay
1409     )
1410   done
1411
1412 and get_key_press setup delay =
1413   (* Read the next key, waiting up to 'delay' milliseconds. *)
1414   timeout delay;
1415   let k = getch () in
1416   timeout (-1); (* Reset to blocking mode. *)
1417
1418   if k >= 0 && k <> 32 (* ' ' *) && k <> 12 (* ^L *) && k <> Key.resize
1419   then (
1420     if k = Char.code 'q' then quit := true
1421     else if k = Char.code 'h' then show_help setup
1422     else if k = Char.code 's' || k = Char.code 'd' then change_delay ()
1423     else if k = Char.code 'M' then sort_order := Memory
1424     else if k = Char.code 'P' then sort_order := Processor
1425     else if k = Char.code 'T' then sort_order := Time
1426     else if k = Char.code 'N' then sort_order := DomainID
1427     else if k = Char.code 'F' then change_sort_order ()
1428     else if k = Char.code '0' then set_tasks_display ()
1429     else if k = Char.code '1' then toggle_pcpu_display ()
1430     else if k = Char.code '2' then toggle_net_display ()
1431     else if k = Char.code '3' then toggle_block_display ()
1432     else if k = Char.code 'W' then write_init_file ()
1433     else if k = Char.code 'B' then toggle_block_in_bytes_mode ()
1434     else unknown_command k
1435   )
1436
1437 and change_delay () =
1438   print_msg
1439     (sprintf (f_"Change delay from %.1f to: ") (float !delay /. 1000.));
1440   let str = get_string 16 in
1441   (* Try to parse the number. *)
1442   let error =
1443     try
1444       let newdelay = float_of_string str in
1445       if newdelay <= 0. then (
1446         print_msg (s_"Delay must be > 0"); true
1447       ) else (
1448         delay := int_of_float (newdelay *. 1000.); false
1449       )
1450     with
1451       Failure "float_of_string" ->
1452         print_msg (s_"Not a valid number"); true in
1453   refresh ();
1454   sleep (if error then 2 else 1)
1455
1456 and change_sort_order () =
1457   clear ();
1458   let lines, cols = get_size () in
1459
1460   mvaddstr top_lineno 0 (s_"Set sort order for main display");
1461   mvaddstr summary_lineno 0 (s_"Type key or use up and down cursor keys.");
1462
1463   attron A.reverse;
1464   mvaddstr header_lineno 0 (pad cols "KEY   Sort field");
1465   attroff A.reverse;
1466
1467   let accelerator_key = function
1468     | Memory -> "(key: M)"
1469     | Processor -> "(key: P)"
1470     | Time -> "(key: T)"
1471     | DomainID -> "(key: N)"
1472     | _ -> (* all others have to be changed from here *) ""
1473   in
1474
1475   let rec key_of_int = function
1476     | i when i < 10 -> Char.chr (i + Char.code '0')
1477     | i when i < 20 -> Char.chr (i + Char.code 'a')
1478     | _ -> assert false
1479   and int_of_key = function
1480     | k when k >= 0x30 && k <= 0x39 (* '0' - '9' *) -> k - 0x30
1481     | k when k >= 0x61 && k <= 0x7a (* 'a' - 'j' *) -> k - 0x61 + 10
1482     | k when k >= 0x41 && k <= 0x6a (* 'A' - 'J' *) -> k - 0x41 + 10
1483     | _ -> -1
1484   in
1485
1486   (* Display possible sort fields. *)
1487   let selected_index = ref 0 in
1488   List.iteri (
1489     fun i ord ->
1490       let selected = !sort_order = ord in
1491       if selected then selected_index := i;
1492       mvaddstr (domains_lineno+i) 0
1493         (sprintf "  %c %s %s %s"
1494            (key_of_int i) (if selected then "*" else " ")
1495            (printable_sort_order ord)
1496            (accelerator_key ord))
1497   ) all_sort_fields;
1498
1499   move message_lineno 0;
1500   refresh ();
1501   let k = getch () in
1502   if k >= 0 && k <> 32 && k <> Char.code 'q' && k <> 13 then (
1503     let new_order, loop =
1504       (* Redraw the display. *)
1505       if k = 12 (* ^L *) then None, true
1506       (* Make the UP and DOWN arrow keys do something useful. *)
1507       else if k = Key.up then (
1508         if !selected_index > 0 then
1509           Some (List.nth all_sort_fields (!selected_index-1)), true
1510         else
1511           None, true
1512       )
1513       else if k = Key.down then (
1514         if !selected_index < List.length all_sort_fields - 1 then
1515           Some (List.nth all_sort_fields (!selected_index+1)), true
1516         else
1517           None, true
1518       )
1519       (* Also understand the regular accelerator keys. *)
1520       else if k = Char.code 'M' then
1521         Some Memory, false
1522       else if k = Char.code 'P' then
1523         Some Processor, false
1524       else if k = Char.code 'T' then
1525         Some Time, false
1526       else if k = Char.code 'N' then
1527         Some DomainID, false
1528       else (
1529         (* It's one of the KEYs. *)
1530         let i = int_of_key k in
1531         if i >= 0 && i < List.length all_sort_fields then
1532           Some (List.nth all_sort_fields i), false
1533         else
1534           None, true
1535       ) in
1536
1537     (match new_order with
1538      | None -> ()
1539      | Some new_order ->
1540          sort_order := new_order;
1541          print_msg (sprintf "Sort order changed to: %s"
1542                       (printable_sort_order new_order));
1543          if not loop then (
1544            refresh ();
1545            sleep 1
1546          )
1547     );
1548
1549     if loop then change_sort_order ()
1550   )
1551
1552 (* Note: We need to clear_pcpu_display_data every time
1553  * we _leave_ PCPUDisplay mode.
1554  *)
1555 and set_tasks_display () =              (* key 0 *)
1556   if !display_mode = PCPUDisplay then clear_pcpu_display_data ();
1557   display_mode := TaskDisplay
1558
1559 and toggle_pcpu_display () =            (* key 1 *)
1560   display_mode :=
1561     match !display_mode with
1562     | TaskDisplay | NetDisplay | BlockDisplay -> PCPUDisplay
1563     | PCPUDisplay -> clear_pcpu_display_data (); TaskDisplay
1564
1565 and toggle_net_display () =             (* key 2 *)
1566   display_mode :=
1567     match !display_mode with
1568     | PCPUDisplay -> clear_pcpu_display_data (); NetDisplay
1569     | TaskDisplay | BlockDisplay -> NetDisplay
1570     | NetDisplay -> TaskDisplay
1571
1572 and toggle_block_display () =           (* key 3 *)
1573   display_mode :=
1574     match !display_mode with
1575     | PCPUDisplay -> clear_pcpu_display_data (); BlockDisplay
1576     | TaskDisplay | NetDisplay -> BlockDisplay
1577     | BlockDisplay -> TaskDisplay
1578
1579 and toggle_block_in_bytes_mode () =      (* key B *)
1580   block_in_bytes :=
1581     match !block_in_bytes with
1582     | false -> true
1583     | true  -> false
1584
1585 (* Write an init file. *)
1586 and write_init_file () =
1587   match !init_file with
1588   | NoInitFile -> ()                    (* Do nothing if --no-init-file *)
1589   | DefaultInitFile ->
1590       let home = try Sys.getenv "HOME" with Not_found -> "/" in
1591       let filename = home // rcfile in
1592       _write_init_file filename
1593   | InitFile filename ->
1594       _write_init_file filename
1595
1596 and _write_init_file filename =
1597   try
1598     (* Create the new file as filename.new. *)
1599     let chan = open_out (filename ^ ".new") in
1600
1601     let time = Unix.gettimeofday () in
1602     let tm = Unix.localtime time in
1603     let printable_date_time =
1604       sprintf "%04d-%02d-%02d %02d:%02d:%02d"
1605         (tm.Unix.tm_year + 1900) (tm.Unix.tm_mon+1) tm.Unix.tm_mday
1606         tm.Unix.tm_hour tm.Unix.tm_min tm.Unix.tm_sec in
1607     let username =
1608       try
1609         let uid = Unix.geteuid () in
1610         (Unix.getpwuid uid).Unix.pw_name
1611       with
1612         Not_found -> "unknown" in
1613
1614     let fp = fprintf in
1615     let nl () = fp chan "\n" in
1616     let () = fp chan (f_"# %s virt-top configuration file\n") rcfile in
1617     let () = fp chan (f_"# generated on %s by %s\n") printable_date_time username in
1618     nl ();
1619     fp chan "display %s\n" (cli_of_display !display_mode);
1620     fp chan "delay %g\n" (float !delay /. 1000.);
1621     fp chan "hist-cpu %d\n" !historical_cpu_delay;
1622     if !iterations <> -1 then fp chan "iterations %d\n" !iterations;
1623     fp chan "sort %s\n" (cli_of_sort_order !sort_order);
1624     (match !uri with
1625      | None -> ()
1626      | Some uri -> fp chan "connect %s\n" uri
1627     );
1628     if !batch_mode = true then fp chan "batch true\n";
1629     if !secure_mode = true then fp chan "secure true\n";
1630     nl ();
1631     output_string chan (s_"# To send debug and error messages to a file, uncomment next line\n");
1632     fp chan "#debug virt-top.out\n";
1633     nl ();
1634     output_string chan (s_"# Enable CSV output to the named file\n");
1635     fp chan "#csv virt-top.csv\n";
1636     nl ();
1637     output_string chan (s_"# To protect this file from being overwritten, uncomment next line\n");
1638     fp chan "#overwrite-init-file false\n";
1639
1640     close_out chan;
1641
1642     (* If the file exists, rename it as filename.old. *)
1643     (try Unix.rename filename (filename ^ ".old")
1644      with Unix.Unix_error _ -> ());
1645
1646     (* Rename filename.new to filename. *)
1647     Unix.rename (filename ^ ".new") filename;
1648
1649     print_msg (sprintf (f_"Wrote settings to %s") filename);
1650     refresh ();
1651     sleep 2
1652   with
1653   | Sys_error err ->
1654       print_msg (s_"Error" ^ ": " ^ err);
1655       refresh (); sleep 2
1656   | Unix.Unix_error (err, fn, str) ->
1657       print_msg (s_"Error" ^ ": " ^
1658                    (Unix.error_message err) ^ " " ^ fn ^ " " ^ str);
1659       refresh ();
1660       sleep 2
1661
1662 and show_help (_, _, _, _, _, _, hostname,
1663                (libvirt_major, libvirt_minor, libvirt_release)) =
1664   clear ();
1665
1666   (* Get the screen/window size. *)
1667   let lines, cols = get_size () in
1668
1669   (* Banner at the top of the screen. *)
1670   let banner =
1671     sprintf (f_"virt-top %s ocaml-libvirt %s libvirt %d.%d.%d by Red Hat")
1672       Virt_top_version.version
1673       Libvirt_version.version
1674       libvirt_major libvirt_minor libvirt_release in
1675   let banner = pad cols banner in
1676   attron A.reverse;
1677   mvaddstr 0 0 banner;
1678   attroff A.reverse;
1679
1680   (* Status. *)
1681   mvaddstr 1 0
1682     (sprintf
1683        (f_"Delay: %.1f secs; Batch: %s; Secure: %s; Sort: %s")
1684        (float !delay /. 1000.)
1685        (if !batch_mode then s_"On" else s_"Off")
1686        (if !secure_mode then s_"On" else s_"Off")
1687        (printable_sort_order !sort_order));
1688   mvaddstr 2 0
1689     (sprintf
1690        (f_"Connect: %s; Hostname: %s")
1691        (match !uri with None -> s_"default" | Some s -> s)
1692        hostname);
1693
1694   (* Misc keys on left. *)
1695   let banner = pad 38 (s_"MAIN KEYS") in
1696   attron A.reverse;
1697   mvaddstr header_lineno 1 banner;
1698   attroff A.reverse;
1699
1700   let get_lineno =
1701     let lineno = ref domains_lineno in
1702     fun () -> let i = !lineno in incr lineno; i
1703   in
1704   let key keys description =
1705     let lineno = get_lineno () in
1706     move lineno 1; attron A.bold; addstr keys; attroff A.bold;
1707     move lineno 10; addstr description
1708   in
1709   key "space ^L" (s_"Update display");
1710   key "q"        (s_"Quit");
1711   key "d s"      (s_"Set update interval");
1712   key "h"        (s_"Help");
1713   key "B"        (s_"toggle block info req/bytes");
1714
1715   (* Sort order. *)
1716   ignore (get_lineno ());
1717   let banner = pad 38 (s_"SORTING") in
1718   attron A.reverse;
1719   mvaddstr (get_lineno ()) 1 banner;
1720   attroff A.reverse;
1721
1722   key "P" (s_"Sort by %CPU");
1723   key "M" (s_"Sort by %MEM");
1724   key "T" (s_"Sort by TIME");
1725   key "N" (s_"Sort by ID");
1726   key "F" (s_"Select sort field");
1727
1728   (* Display modes on right. *)
1729   let banner = pad 39 (s_"DISPLAY MODES") in
1730   attron A.reverse;
1731   mvaddstr header_lineno 40 banner;
1732   attroff A.reverse;
1733
1734   let get_lineno =
1735     let lineno = ref domains_lineno in
1736     fun () -> let i = !lineno in incr lineno; i
1737   in
1738   let key keys description =
1739     let lineno = get_lineno () in
1740     move lineno 40; attron A.bold; addstr keys; attroff A.bold;
1741     move lineno 49; addstr description
1742   in
1743   key "0" (s_"Domains display");
1744   key "1" (s_"Toggle physical CPUs");
1745   key "2" (s_"Toggle network interfaces");
1746   key "3" (s_"Toggle block devices");
1747
1748   (* Update screen and wait for key press. *)
1749   mvaddstr (lines-1) 0
1750     (s_"More help in virt-top(1) man page. Press any key to return.");
1751   refresh ();
1752   ignore (getch ())
1753
1754 and unknown_command k =
1755   print_msg (s_"Unknown command - try 'h' for help");
1756   refresh ();
1757   sleep 1