Ignore config.cache (./configure -C)
[virt-top.git] / virt-top / virt_top.ml
old mode 100644 (file)
new mode 100755 (executable)
index cd1ce64..b3e2628
@@ -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
@@ -21,18 +36,19 @@ let parse_device_xml : (int -> [>`R] D.t -> string list * string list) ref =
 (* Hooks for CSV support (see virt_top_csv.ml). *)
 let csv_start : (string -> unit) ref =
   ref (
-    fun _ -> failwith "virt-top was compiled without support for CSV"
+    fun _ -> failwith "virt-top was compiled without support for CSV files"
   )
 let csv_write : (string list -> unit) ref =
   ref (
     fun _ -> ()
   )
 
-(* Int64 operators for convenience. *)
-let (+^) = Int64.add
-let (-^) = Int64.sub
-let ( *^ ) = Int64.mul
-let (/^) = Int64.div
+(* Hook for calendar support (see virt_top_calendar.ml). *)
+let parse_date_time : (string -> float) ref =
+  ref (
+    fun _ ->
+      failwith "virt-top was compiled without support for dates and times"
+  )
 
 (* Sort order. *)
 type sort_order =
@@ -95,6 +111,7 @@ let quit = ref false
 let delay = ref 3000 (* milliseconds *)
 let historical_cpu_delay = ref 20 (* secs *)
 let iterations = ref (-1)
+let end_time = ref None
 let batch_mode = ref false
 let secure_mode = ref false
 let sort_order = ref Processor
@@ -108,6 +125,11 @@ 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. *)
@@ -125,6 +147,7 @@ let start_up () =
     csv_enabled := true
   and no_init_file () = init_file := NoInitFile
   and set_init_file filename = init_file := InitFile filename
+  and set_end_time time = end_time := Some ((!parse_date_time) time)
   in
   let argspec = Arg.align [
     "-1", Arg.Unit set_pcpu_mode, " Start by displaying pCPUs (default: tasks)";
@@ -139,6 +162,7 @@ let start_up () =
     "--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";
+    "--end-time", Arg.String set_end_time, "time Exit at given time";
     "--hist-cpu", Arg.Set_int historical_cpu_delay, "secs Historical CPU delay";
     "--init-file", Arg.String set_init_file, "file Set name of init file";
     "--no-init-file", Arg.Unit no_init_file, " Do not read init file";
@@ -175,6 +199,7 @@ OPTIONS" in
       | _, "batch", b -> batch_mode := bool_of_string b
       | _, "secure", b -> secure_mode := bool_of_string b
       | _, "script", b -> script_mode := bool_of_string b
+      | _, "end-time", t -> set_end_time t
       | _, "overwrite-init-file", "false" -> no_init_file ()
       | lineno, key, _ ->
          eprintf "%s:%d: configuration item ``%s'' ignored\n%!"
@@ -216,7 +241,7 @@ OPTIONS" in
     (* qemu:/// and other URIs didn't support virConnectGetHostname until
      * libvirt 0.3.3.  Before that they'd throw a virterror. *)
     | Libvirt.Virterror _
-    | Invalid_argument "virConnectGetHostname not supported" -> "unknown" in
+    | Libvirt.Not_supported "virConnectGetHostname" -> "unknown" in
 
   let libvirt_version =
     let v, _ = Libvirt.get_version () in
@@ -263,54 +288,6 @@ OPTIONS" in
    node_info, hostname, libvirt_version (* info that doesn't change *)
   )
 
-(* 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
-  )
-
 (* Show a domain state (the 'S' column). *)
 let show_state = function
   | D.InfoNoState -> '?'
@@ -321,67 +298,12 @@ 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
+(* Sleep in seconds. *)
+let sleep = Unix.sleep
+
+(* Sleep in milliseconds. *)
+let usleep n =
+  ignore (Unix.select [] [] [] (float n /. 1000.))
 
 (* The curses getstr/getnstr functions are just weird.
  * This helper function also enables echo temporarily.
@@ -401,13 +323,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 *)
@@ -490,7 +405,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
@@ -519,12 +433,12 @@ let collect, clear_pcpu_display_data =
              let block_stats =
                try List.map (fun dev -> dev, D.block_stats dom dev) blkdevs
                with
-               | Invalid_argument "virDomainBlockStats not supported"
+               | Libvirt.Not_supported "virDomainBlockStats"
                | Libvirt.Virterror _ -> [] in
              let interface_stats =
                try List.map (fun dev -> dev, D.interface_stats dom dev) netifs
                with
-               | Invalid_argument "virDomainInterfaceStats not supported"
+               | Libvirt.Not_supported "virDomainInterfaceStats"
                | Libvirt.Virterror _ -> [] in
 
              let prev_info, prev_block_stats, prev_interface_stats =
@@ -803,6 +717,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
@@ -896,16 +813,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
@@ -952,7 +869,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 (
@@ -965,7 +882,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
@@ -1055,19 +972,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"
@@ -1163,19 +1080,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"
@@ -1318,16 +1235,31 @@ let rec main_loop ((_, batch_mode, script_mode, csv_enabled, _, _, _)
     (* Clear up unused virDomainPtr objects. *)
     Gc.compact ();
 
+    (* Get next key.  This does the sleep. *)
     if not batch_mode && not script_mode then
-      get_key_press setup
-    else (* Batch mode or script mode - just sleep, ignore keys. *)
-      Unix.sleep (!delay / 1000);
+      get_key_press setup;
 
     (* Max iterations? *)
     if !iterations >= 0 then (
       decr iterations;
       if !iterations = 0 then quit := true
     );
+
+    (* End time? *)
+    (match !end_time with
+     | None -> ()
+     | Some end_time ->
+        let (_, time, _, _, _, _, _, _) = state in
+        let delay_secs = float !delay /. 1000. in
+        if end_time <= time +. delay_secs then quit := true
+    );
+
+    (* Batch mode or script mode.  We didn't call get_key_press above, so
+     * we didn't sleep.  Sleep now, unless we are about to quit.
+     *)
+    if batch_mode || script_mode then
+      if not !quit then
+       usleep !delay;
   done
 
 and get_key_press setup =
@@ -1369,6 +1301,7 @@ and change_delay () =
     with
       Failure "float_of_string" ->
        print_msg "Not a valid number"; true in
+  refresh ();
   sleep (if error then 2 else 1)
 
 and change_sort_order () =
@@ -1458,7 +1391,10 @@ and change_sort_order () =
         sort_order := new_order;
         print_msg (sprintf "Sort order changed to: %s"
                      (printable_sort_order new_order));
-        if not loop then sleep 1
+        if not loop then (
+          refresh ();
+          sleep 1
+        )
     );
 
     if loop then change_sort_order ()
@@ -1555,11 +1491,14 @@ and _write_init_file filename =
     (* Rename filename.new to filename. *)
     Unix.rename (filename ^ ".new") filename;
 
-    print_msg (sprintf "Wrote settings to %s" filename); sleep 2
+    print_msg (sprintf "Wrote settings to %s" filename);
+    refresh ();
+    sleep 2
   with
-  | Sys_error err -> print_msg "Error: %s"; sleep 2
+  | Sys_error err -> print_msg "Error: %s"; refresh (); sleep 2
   | Unix.Unix_error (err, fn, str) ->
       print_msg (sprintf "Error: %s %s %s" (Unix.error_message err) fn str);
+      refresh ();
       sleep 2
 
 and show_help (_, _, _, _, _, hostname,
@@ -1651,4 +1590,5 @@ and show_help (_, _, _, _, _, hostname,
 
 and unknown_command k =
   print_msg "Unknown command - try 'h' for help";
+  refresh ();
   sleep 1