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