Reorganised the code to put more utility functions into virt_top_utils.
[virt-top.git] / virt-top / virt_top.ml
index 631d04f..6047f8e 100644 (file)
@@ -1,6 +1,21 @@
 (* 'top'-like tool for libvirt domains.
- * $Id: virt_top.ml,v 1.5 2007/08/30 13:52:40 rjones Exp $
- *)
+   (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
+   http://libvirt.org/
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*)
 
 open Printf
 open ExtList
@@ -28,12 +43,6 @@ let csv_write : (string list -> unit) ref =
     fun _ -> ()
   )
 
-(* Int64 operators for convenience. *)
-let (+^) = Int64.add
-let (-^) = Int64.sub
-let ( *^ ) = Int64.mul
-let (/^) = Int64.div
-
 (* Sort order. *)
 type sort_order =
   | DomainID | DomainName | Processor | Memory | Time
@@ -102,9 +111,17 @@ let display_mode = ref TaskDisplay
 let uri = ref None
 let debug_file = ref ""
 let csv_enabled = ref false
+let csv_cpu = ref true
+let csv_block = ref true
+let csv_net = ref true
 let init_file = ref DefaultInitFile
 let script_mode = ref false
 
+(* Tuple of never-changing data returned by start_up function. *)
+type setup =
+    Libvirt.ro C.t * bool * bool * bool * C.node_info * string *
+      (int * int * int)
+
 (* Function to read command line arguments and go into curses mode. *)
 let start_up () =
   (* Read command line arguments. *)
@@ -131,6 +148,9 @@ let start_up () =
     "-c", Arg.String set_uri, "uri Connect to URI (default: Xen)";
     "--connect", Arg.String set_uri, "uri Connect to URI (default: Xen)";
     "--csv", Arg.String set_csv, "file Log statistics to CSV file";
+    "--no-csv-cpu", Arg.Clear csv_cpu, " Disable CPU stats in CSV";
+    "--no-csv-block", Arg.Clear csv_block, " Disable block device stats in CSV";
+    "--no-csv-net", Arg.Clear csv_net, " Disable net stats in CSV";
     "-d", Arg.Float set_delay, "delay Delay time interval (seconds)";
     "--debug", Arg.Set_string debug_file, "file Send debug messages to file";
     "--hist-cpu", Arg.Set_int historical_cpu_delay, "secs Historical CPU delay";
@@ -163,6 +183,9 @@ OPTIONS" in
       | _, "connect", uri -> set_uri uri
       | _, "debug", filename -> debug_file := filename
       | _, "csv", filename -> set_csv filename
+      | _, "csv-cpu", b -> csv_cpu := bool_of_string b
+      | _, "csv-block", b -> csv_block := bool_of_string b
+      | _, "csv-net", b -> csv_net := bool_of_string b
       | _, "batch", b -> batch_mode := bool_of_string b
       | _, "secure", b -> secure_mode := bool_of_string b
       | _, "script", b -> script_mode := bool_of_string b
@@ -251,54 +274,7 @@ OPTIONS" in
    *)
   (conn,
    !batch_mode, !script_mode, !csv_enabled, (* immutable modes *)
-   node_info, hostname, libvirt_version)
-
-(* Show a percentage in 4 chars. *)
-let show_percent percent =
-  if percent <= 0. then " 0.0"
-  else if percent <= 9.9 then sprintf " %1.1f" percent
-  else if percent <= 99.9 then sprintf "%2.1f" percent
-  else "100 "
-
-(* Show an int64 option in 4 chars. *)
-let rec show_int64_option = function
-  | None -> "    "
-  | Some n -> show_int64 n
-(* Show an int64 in 4 chars. *)
-and show_int64 = function
-  | n when n < 0L -> "-!!!"
-  | n when n <= 9999L ->
-      sprintf "%4Ld" n
-  | n when n /^ 1024L <= 999L ->
-      sprintf "%3LdK" (n /^ 1024L)
-  | n when n /^ 1_048_576L <= 999L ->
-      sprintf "%3LdM" (n /^ 1_048_576L)
-  | n when n /^ 1_073_741_824L <= 999L ->
-      sprintf "%3LdG" (n /^ 1_073_741_824L)
-  | _ -> ">!!!"
-
-(* Format the total time (may be large!) in 9 chars. *)
-let show_time ns =
-  let secs_in_ns = 1_000_000_000L in
-  let mins_in_ns = 60_000_000_000L in
-  let hours_in_ns = 3_600_000_000_000L in
-
-  let hours = ns /^ hours_in_ns in
-  let ns = ns -^ (hours *^ hours_in_ns) in
-  let mins = ns /^ mins_in_ns in
-  let ns = ns -^ (mins *^ mins_in_ns) in
-  let secs = ns /^ secs_in_ns in
-  let ns = ns -^ (secs *^ secs_in_ns) in
-  let pennies = ns /^ 10_000_000L in
-
-  if hours < 12L then
-    sprintf "%3Ld:%02Ld.%02Ld" (hours *^ 60L +^ mins) secs pennies
-  else if hours <= 999L then
-    sprintf "%3Ld:%02Ld:%02Ld" hours mins secs
-  else (
-    let days = hours /^ 24L in
-    let hours = hours -^ (days *^ 24L) in
-    sprintf "%3Ldd%02Ld:%02Ld" days hours mins
+   node_info, hostname, libvirt_version (* info that doesn't change *)
   )
 
 (* Show a domain state (the 'S' column). *)
@@ -311,65 +287,6 @@ let show_state = function
   | D.InfoShutoff -> 'O'
   | D.InfoCrashed -> 'X'
 
-(* Sum Domain.block_stats structures together.  Missing fields
- * get forced to 0.  Empty list returns all 0.
- *)
-let zero_block_stats =
-  { D.rd_req = 0L; rd_bytes = 0L; wr_req = 0L; wr_bytes = 0L; errs = 0L }
-let add_block_stats bs1 bs2 =
-  let add f1 f2 = if f1 >= 0L && f2 >= 0L then f1 +^ f2 else 0L in
-  { D.rd_req = add bs1.D.rd_req   bs2.D.rd_req;
-    rd_bytes = add bs1.D.rd_bytes bs2.D.rd_bytes;
-    wr_req   = add bs1.D.wr_req   bs2.D.wr_req;
-    wr_bytes = add bs1.D.wr_bytes bs2.D.wr_bytes;
-    errs     = add bs1.D.errs     bs2.D.errs }
-let sum_block_stats =
-  List.fold_left add_block_stats zero_block_stats
-
-(* Get the difference between two block_stats structures.  Missing data
- * forces the difference to -1.
- *)
-let diff_block_stats curr prev =
-  let sub f1 f2 = if f1 >= 0L && f2 >= 0L then f1 -^ f2 else -1L in
-  { D.rd_req = sub curr.D.rd_req   prev.D.rd_req;
-    rd_bytes = sub curr.D.rd_bytes prev.D.rd_bytes;
-    wr_req   = sub curr.D.wr_req   prev.D.wr_req;
-    wr_bytes = sub curr.D.wr_bytes prev.D.wr_bytes;
-    errs     = sub curr.D.errs     prev.D.errs }
-
-(* Sum Domain.interface_stats structures together.  Missing fields
- * get forced to 0.  Empty list returns all 0.
- *)
-let zero_interface_stats =
-  { D.rx_bytes = 0L; rx_packets = 0L; rx_errs = 0L; rx_drop = 0L;
-    tx_bytes = 0L; tx_packets = 0L; tx_errs = 0L; tx_drop = 0L }
-let add_interface_stats is1 is2 =
-  let add f1 f2 = if f1 >= 0L && f2 >= 0L then f1 +^ f2 else 0L in
-  { D.rx_bytes = add is1.D.rx_bytes   is2.D.rx_bytes;
-    rx_packets = add is1.D.rx_packets is2.D.rx_packets;
-    rx_errs    = add is1.D.rx_errs    is2.D.rx_errs;
-    rx_drop    = add is1.D.rx_drop    is2.D.rx_drop;
-    tx_bytes   = add is1.D.tx_bytes   is2.D.tx_bytes;
-    tx_packets = add is1.D.tx_packets is2.D.tx_packets;
-    tx_errs    = add is1.D.tx_errs    is2.D.tx_errs;
-    tx_drop    = add is1.D.tx_drop    is2.D.tx_drop }
-let sum_interface_stats =
-  List.fold_left add_interface_stats zero_interface_stats
-
-(* Get the difference between two interface_stats structures.
- * Missing data forces the difference to -1.
- *)
-let diff_interface_stats curr prev =
-  let sub f1 f2 = if f1 >= 0L && f2 >= 0L then f1 -^ f2 else -1L in
-  { D.rx_bytes = sub curr.D.rx_bytes   prev.D.rx_bytes;
-    rx_packets = sub curr.D.rx_packets prev.D.rx_packets;
-    rx_errs    = sub curr.D.rx_errs    prev.D.rx_errs;
-    rx_drop    = sub curr.D.rx_drop    prev.D.rx_drop;
-    tx_bytes   = sub curr.D.tx_bytes   prev.D.tx_bytes;
-    tx_packets = sub curr.D.tx_packets prev.D.tx_packets;
-    tx_errs    = sub curr.D.tx_errs    prev.D.tx_errs;
-    tx_drop    = sub curr.D.tx_drop    prev.D.tx_drop }
-
 (* Update the display and sleep for given number of seconds. *)
 let sleep n = refresh (); Unix.sleep n
 
@@ -391,13 +308,6 @@ let get_string maxlen =
       Not_found -> str (* it is full maxlen bytes *)
   )
 
-(* Pad a string to the full width with spaces.  If too long, truncate. *)
-let pad width str =
-  let n = String.length str in
-  if n = width then str
-  else if n > width then String.sub str 0 width
-  else (* if n < width then *) str ^ String.make (width-n) ' '
-
 (* Line numbers. *)
 let top_lineno = 0
 let summary_lineno = 1 (* this takes 2 lines *)
@@ -409,14 +319,6 @@ let domains_lineno = 5
 let clear_msg () = move message_lineno 0; clrtoeol ()
 let print_msg str = clear_msg (); mvaddstr message_lineno 0 str; ()
 
-(* Write CSV header row. *)
-let write_csv_header () =
-  (!csv_write) [ "Hostname"; "Time"; "Arch"; "Physical CPUs";
-                "Count"; "Running"; "Blocked"; "Paused"; "Shutdown";
-                "Shutoff"; "Crashed"; "Active"; "Inactive";
-                "%CPU"; "Total memory KB"; "Total guest memory KB";
-                "Total CPU time ns" ]
-
 (* Intermediate "domain + stats" structure that we use to collect
  * everything we know about a domain within the collect function.
  *)
@@ -488,7 +390,6 @@ let collect, clear_pcpu_display_data =
     let tm = Unix.localtime time in
     let printable_time =
       sprintf "%02d:%02d:%02d" tm.Unix.tm_hour tm.Unix.tm_min tm.Unix.tm_sec in
-    mvaddstr top_lineno 0 ("virt-top " ^ printable_time ^ " - ");
 
     (* What's the total CPU time elapsed since we were last called? (ns) *)
     let total_cpu_per_pcpu = 1_000_000_000. *. (time -. !last_time) in
@@ -801,6 +702,9 @@ let redraw =
     (* Get the screen/window size. *)
     let lines, cols = get_size () in
 
+    (* Time. *)
+    mvaddstr top_lineno 0 ("virt-top " ^ printable_time ^ " - ");
+
     (* Basic node_info. *)
     addstr (sprintf "%s %d/%dCPU %dMHz %LdMB "
              node_info.C.model node_info.C.cpus nr_pcpus node_info.C.mhz
@@ -894,16 +798,16 @@ let redraw =
           | (name, Active rd) :: doms ->
               if lineno < lines then (
                 let state = show_state rd.rd_info.D.state in
-                let rd_req = show_int64_option rd.rd_block_rd_reqs in
-                let wr_req = show_int64_option rd.rd_block_wr_reqs in
-                let rx_bytes = show_int64_option rd.rd_net_rx_bytes in
-                let tx_bytes = show_int64_option rd.rd_net_tx_bytes in
-                let percent_cpu = show_percent rd.rd_percent_cpu in
+                let rd_req = Show.int64_option rd.rd_block_rd_reqs in
+                let wr_req = Show.int64_option rd.rd_block_wr_reqs in
+                let rx_bytes = Show.int64_option rd.rd_net_rx_bytes in
+                let tx_bytes = Show.int64_option rd.rd_net_tx_bytes in
+                let percent_cpu = Show.percent rd.rd_percent_cpu in
                 let percent_mem =
                   100L *^ rd.rd_info.D.memory /^ node_info.C.memory in
                 let percent_mem = Int64.to_float percent_mem in
-                let percent_mem = show_percent percent_mem in
-                let time = show_time rd.rd_info.D.cpu_time in
+                let percent_mem = Show.percent percent_mem in
+                let time = Show.time rd.rd_info.D.cpu_time in
 
                 let line = sprintf "%5d %c %s %s %s %s %s %s %s %s"
                   rd.rd_domid state rd_req wr_req rx_bytes tx_bytes
@@ -950,7 +854,7 @@ let redraw =
             mvaddstr (p+domains_lineno) 0 (sprintf "%4d   " p);
             let cpu_time = pcpus_cpu_time.(p) in (* ns used on this CPU *)
             let percent_cpu = 100. *. cpu_time /. total_cpu_per_pcpu in
-            addstr (show_percent percent_cpu);
+            addstr (Show.percent percent_cpu);
             addch 32;
 
             List.iteri (
@@ -963,7 +867,7 @@ let redraw =
                   else (
                     let t = Int64.to_float t in
                     let percent = 100. *. t /. total_cpu_per_pcpu in
-                    sprintf "%s%c%c " (show_percent percent)
+                    sprintf "%s%c%c " (Show.percent percent)
                       (if is_average then '=' else ' ')
                       (if is_running then '#' else ' ')
                   ) in
@@ -1053,19 +957,19 @@ let redraw =
                 let state = show_state rd.rd_info.D.state in
                 let rx_bytes =
                   if stats.D.rx_bytes >= 0L
-                  then show_int64 stats.D.rx_bytes
+                  then Show.int64 stats.D.rx_bytes
                   else "    " in
                 let tx_bytes =
                   if stats.D.tx_bytes >= 0L
-                  then show_int64 stats.D.tx_bytes
+                  then Show.int64 stats.D.tx_bytes
                   else "    " in
                 let rx_packets =
                   if stats.D.rx_packets >= 0L
-                  then show_int64 stats.D.rx_packets
+                  then Show.int64 stats.D.rx_packets
                   else "    " in
                 let tx_packets =
                   if stats.D.tx_packets >= 0L
-                  then show_int64 stats.D.tx_packets
+                  then Show.int64 stats.D.tx_packets
                   else "    " in
 
                 let line = sprintf "%5d %c %s %s %s %s %-12s %s"
@@ -1161,19 +1065,19 @@ let redraw =
                 let state = show_state rd.rd_info.D.state in
                 let rd_bytes =
                   if stats.D.rd_bytes >= 0L
-                  then show_int64 stats.D.rd_bytes
+                  then Show.int64 stats.D.rd_bytes
                   else "    " in
                 let wr_bytes =
                   if stats.D.wr_bytes >= 0L
-                  then show_int64 stats.D.wr_bytes
+                  then Show.int64 stats.D.wr_bytes
                   else "    " in
                 let rd_req =
                   if stats.D.rd_req >= 0L
-                  then show_int64 stats.D.rd_req
+                  then Show.int64 stats.D.rd_req
                   else "    " in
                 let wr_req =
                   if stats.D.wr_req >= 0L
-                  then show_int64 stats.D.wr_req
+                  then Show.int64 stats.D.wr_req
                   else "    " in
 
                 let line = sprintf "%5d %c %s %s %s %s %-12s %s"
@@ -1226,21 +1130,38 @@ let redraw =
     refresh ();                   (* Refresh the display. *)
     ()
 
-(* Write summary data to CSV file.  See also write_csv_header (). *)
+(* Write CSV header row. *)
+let write_csv_header () =
+  (!csv_write) (
+    [ "Hostname"; "Time"; "Arch"; "Physical CPUs";
+      "Count"; "Running"; "Blocked"; "Paused"; "Shutdown";
+      "Shutoff"; "Crashed"; "Active"; "Inactive";
+      "%CPU"; "Total memory (KB)"; "Total guest memory (KB)";
+      "Total CPU time (ns)" ] @
+      (* These fields are repeated for each domain: *)
+    [ "Domain ID"; "Domain name"; ] @
+    (if !csv_cpu then [ "CPU (ns)"; "%CPU"; ] else []) @
+    (if !csv_block then [ "Block RDRQ"; "Block WRRQ"; ] else []) @
+    (if !csv_net then [ "Net RXBY"; "Net TXBY" ] else [])
+  )
+
+(* Write summary data to CSV file. *)
 let append_csv
     (_, _, _, _, node_info, hostname, _) (* setup *)
-    (_,
+    (doms,
      _, printable_time,
      nr_pcpus, total_cpu, _,
      totals,
      _) (* state *) =
+
+  (* The totals / summary fields. *)
   let (count, running, blocked, paused, shutdown, shutoff,
        crashed, active, inactive,
        total_cpu_time, total_memory, total_domU_memory) = totals in
 
   let percent_cpu = 100. *. total_cpu_time /. total_cpu in
 
-  (!csv_write) [
+  let summary_fields = [
     hostname; printable_time; node_info.C.model; string_of_int nr_pcpus;
     string_of_int count; string_of_int running; string_of_int blocked;
     string_of_int paused; string_of_int shutdown; string_of_int shutoff;
@@ -1248,7 +1169,43 @@ let append_csv
     sprintf "%2.1f" percent_cpu;
     Int64.to_string total_memory; Int64.to_string total_domU_memory;
     Int64.to_string (Int64.of_float total_cpu_time)
-  ]
+  ] in
+
+  (* The domains.
+   *
+   * Sort them by ID so that the list of relatively stable.  Ignore
+   * inactive domains.
+   *)
+  let doms = List.filter_map (
+    function
+    | _, Inactive -> None              (* Ignore inactive domains. *)
+    | name, Active rd -> Some (name, rd)
+  ) doms in
+  let cmp (_, { rd_domid = rd_domid1 }) (_, { rd_domid = rd_domid2 }) =
+    compare rd_domid1 rd_domid2
+  in
+  let doms = List.sort ~cmp doms in
+
+  let string_of_int64_option = Option.map_default Int64.to_string "" in
+
+  let domain_fields = List.map (
+    fun (domname, rd) ->
+      [ string_of_int rd.rd_domid; domname ] @
+       (if !csv_cpu then [
+          string_of_float rd.rd_cpu_time; string_of_float rd.rd_percent_cpu
+        ] else []) @
+       (if !csv_block then [
+          string_of_int64_option rd.rd_block_rd_reqs;
+          string_of_int64_option rd.rd_block_wr_reqs;
+        ] else []) @
+       (if !csv_net then [
+          string_of_int64_option rd.rd_net_rx_bytes;
+          string_of_int64_option rd.rd_net_tx_bytes;
+        ] else [])
+  ) doms in
+  let domain_fields = List.flatten domain_fields in
+
+  (!csv_write) (summary_fields @ domain_fields)
 
 (* Main loop. *)
 let rec main_loop ((_, batch_mode, script_mode, csv_enabled, _, _, _)