Add the real virt-top version to help display.
[virt-top.git] / virt-top / virt_top.ml
index 6047f8e..3ad7afc 100644 (file)
@@ -21,12 +21,15 @@ open Printf
 open ExtList
 open Curses
 
+open Virt_top_gettext.Gettext
 open Virt_top_utils
 
 module C = Libvirt.Connect
 module D = Libvirt.Domain
 module N = Libvirt.Network
 
+let rcfile = ".virt-toprc"
+
 (* Hook for XML support (see virt_top_xml.ml). *)
 let parse_device_xml : (int -> [>`R] D.t -> string list * string list) ref =
   ref (
@@ -36,13 +39,20 @@ 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 (s_ "virt-top was compiled without support for CSV files")
   )
 let csv_write : (string list -> unit) ref =
   ref (
     fun _ -> ()
   )
 
+(* Hook for calendar support (see virt_top_calendar.ml). *)
+let parse_date_time : (string -> float) ref =
+  ref (
+    fun _ ->
+      failwith (s_ "virt-top was compiled without support for dates and times")
+  )
+
 (* Sort order. *)
 type sort_order =
   | DomainID | DomainName | Processor | Memory | Time
@@ -52,15 +62,15 @@ let all_sort_fields = [
   NetRX; NetTX; BlockRdRq; BlockWrRq
 ]
 let printable_sort_order = function
-  | Processor -> "%CPU"
-  | Memory -> "%MEM"
-  | Time -> "TIME (CPU time)"
-  | DomainID -> "Domain ID"
-  | DomainName -> "Domain name"
-  | NetRX -> "Net RX bytes"
-  | NetTX -> "Net TX bytes"
-  | BlockRdRq -> "Block read reqs"
-  | BlockWrRq -> "Block write reqs"
+  | Processor -> s_ "%CPU"
+  | Memory -> s_ "%MEM"
+  | Time -> s_ "TIME (CPU time)"
+  | DomainID -> s_ "Domain ID"
+  | DomainName -> s_ "Domain name"
+  | NetRX -> s_ "Net RX bytes"
+  | NetTX -> s_ "Net TX bytes"
+  | BlockRdRq -> s_ "Block read reqs"
+  | BlockWrRq -> s_ "Block write reqs"
 let sort_order_of_cli = function
   | "cpu" | "processor" -> Processor
   | "mem" | "memory" -> Memory
@@ -69,7 +79,10 @@ let sort_order_of_cli = function
   | "name" -> DomainName
   | "netrx" -> NetRX | "nettx" -> NetTX
   | "blockrdrq" -> BlockRdRq | "blockwrrq" -> BlockWrRq
-  | str -> failwith (str ^ ": sort order should be: cpu|mem|time|id|name|netrx|nettx|blockrdrq|blockwrrq")
+  | str ->
+      failwith
+       (sprintf (f_ "%s: sort order should be: %s")
+          str "cpu|mem|time|id|name|netrx|nettx|blockrdrq|blockwrrq")
 let cli_of_sort_order = function
   | Processor -> "cpu"
   | Memory -> "mem"
@@ -89,7 +102,10 @@ let display_of_cli = function
   | "pcpu" -> PCPUDisplay
   | "block" -> BlockDisplay
   | "net" -> NetDisplay
-  | str -> failwith (str ^ ": display should be task|pcpu|block|net")
+  | str ->
+      failwith
+       (sprintf (f_ "%s: display should be %s")
+          str "task|pcpu|block|net")
 let cli_of_display = function
   | TaskDisplay -> "task"
   | PCPUDisplay -> "pcpu"
@@ -104,6 +120,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
@@ -127,7 +144,7 @@ let start_up () =
   (* Read command line arguments. *)
   let rec set_delay newdelay =
     if newdelay <= 0. then
-      failwith "-d: cannot set a negative delay";
+      failwith (s_ "-d: cannot set a negative delay");
     delay := int_of_float (newdelay *. 1000.)
   and set_uri = function "" -> uri := None | u -> uri := Some u
   and set_sort order = sort_order := sort_order_of_cli order
@@ -139,30 +156,53 @@ 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)";
-    "-2", Arg.Unit set_net_mode, " Start by displaying network interfaces";
-    "-3", Arg.Unit set_block_mode, " Start by displaying block devices";
-    "-b", Arg.Set batch_mode, " Batch mode";
-    "-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";
-    "--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";
-    "-n", Arg.Set_int iterations, "iterations Number of iterations to run";
-    "-o", Arg.String set_sort, "sort Set sort order (cpu|mem|time|id|name)";
-    "-s", Arg.Set secure_mode, " Secure (\"kiosk\") mode";
-    "--script", Arg.Set script_mode, " Run from a script (no user interface)";
+    "-1", Arg.Unit set_pcpu_mode,
+      " " ^ s_ "Start by displaying pCPUs (default: tasks)";
+    "-2", Arg.Unit set_net_mode,
+      " " ^ s_ "Start by displaying network interfaces";
+    "-3", Arg.Unit set_block_mode,
+      " " ^ s_ "Start by displaying block devices";
+    "-b", Arg.Set batch_mode,
+      " " ^ s_ "Batch mode";
+    "-c", Arg.String set_uri,
+      "uri " ^ s_ "Connect to URI (default: Xen)";
+    "--connect", Arg.String set_uri,
+      "uri " ^ s_ "Connect to URI (default: Xen)";
+    "--csv", Arg.String set_csv,
+      "file " ^ s_ "Log statistics to CSV file";
+    "--no-csv-cpu", Arg.Clear csv_cpu,
+      " " ^ s_ "Disable CPU stats in CSV";
+    "--no-csv-block", Arg.Clear csv_block,
+      " " ^ s_ "Disable block device stats in CSV";
+    "--no-csv-net", Arg.Clear csv_net,
+      " " ^ s_ "Disable net stats in CSV";
+    "-d", Arg.Float set_delay,
+      "delay " ^ s_ "Delay time interval (seconds)";
+    "--debug", Arg.Set_string debug_file,
+      "file " ^ s_ "Send debug messages to file";
+    "--end-time", Arg.String set_end_time,
+      "time " ^ s_ "Exit at given time";
+    "--hist-cpu", Arg.Set_int historical_cpu_delay,
+      "secs " ^ s_ "Historical CPU delay";
+    "--init-file", Arg.String set_init_file,
+      "file " ^ s_ "Set name of init file";
+    "--no-init-file", Arg.Unit no_init_file,
+      " " ^ s_ "Do not read init file";
+    "-n", Arg.Set_int iterations,
+      "iterations " ^ s_ "Number of iterations to run";
+    "-o", Arg.String set_sort,
+      "sort " ^ sprintf (f_ "Set sort order (%s)") "cpu|mem|time|id|name";
+    "-s", Arg.Set secure_mode,
+      " " ^ s_ "Secure (\"kiosk\") mode";
+    "--script", Arg.Set script_mode,
+      " " ^ s_ "Run from a script (no user interface)";
   ] in
-  let anon_fun str = raise (Arg.Bad (str ^ ": unknown parameter")) in
-  let usage_msg = "virt-top : a 'top'-like utility for virtualization
+  let anon_fun str =
+    raise (Arg.Bad (sprintf (f_ "%s: unknown parameter") str)) in
+  let usage_msg = s_ "virt-top : a 'top'-like utility for virtualization
 
 SUMMARY
   virt-top [-options]
@@ -189,9 +229,10 @@ 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%!"
+         eprintf (f_ "%s:%d: configuration item ``%s'' ignored\n%!")
            filename lineno key
     ) config
   in
@@ -199,7 +240,7 @@ OPTIONS" in
    | NoInitFile -> ()
    | DefaultInitFile ->
        let home = try Sys.getenv "HOME" with Not_found -> "/" in
-       let filename = home // ".virt-toprc" in
+       let filename = home // rcfile in
        try_to_read_init_file filename
    | InitFile filename ->
        try_to_read_init_file filename
@@ -216,7 +257,7 @@ OPTIONS" in
        prerr_endline (Libvirt.Virterror.to_string err);
        (* If non-root and no explicit connection URI, print a warning. *)
        if Unix.geteuid () <> 0 && name = None then (
-         print_endline "NB: If you want to monitor a local Xen hypervisor, you usually need to be root";
+         print_endline (s_ "NB: If you want to monitor a local Xen hypervisor, you usually need to be root");
        );
        exit 1 in
 
@@ -230,7 +271,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
@@ -287,8 +328,12 @@ let show_state = function
   | D.InfoShutoff -> 'O'
   | D.InfoCrashed -> 'X'
 
-(* 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.
@@ -418,12 +463,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 =
@@ -1098,14 +1143,14 @@ let redraw =
         total_cpu_time, total_memory, total_domU_memory) = totals in
 
     mvaddstr summary_lineno 0
-      (sprintf "%d domains, %d active, %d running, %d sleeping, %d paused, %d inactive D:%d O:%d X:%d"
+      (sprintf (f_ "%d domains, %d active, %d running, %d sleeping, %d paused, %d inactive D:%d O:%d X:%d")
         count active running blocked paused inactive shutdown shutoff
         crashed);
 
     (* Total %CPU used, and memory summary. *)
     let percent_cpu = 100. *. total_cpu_time /. total_cpu in
     mvaddstr (summary_lineno+1) 0
-      (sprintf "CPU: %2.1f%%  Mem: %Ld MB (%Ld MB by guests)"
+      (sprintf (f_ "CPU: %2.1f%%  Mem: %Ld MB (%Ld MB by guests)")
         percent_cpu (total_memory /^ 1024L) (total_domU_memory /^ 1024L));
 
     (* Time to grab another historical %CPU for the list? *)
@@ -1136,7 +1181,9 @@ let write_csv_header () =
     [ "Hostname"; "Time"; "Arch"; "Physical CPUs";
       "Count"; "Running"; "Blocked"; "Paused"; "Shutdown";
       "Shutoff"; "Crashed"; "Active"; "Inactive";
-      "%CPU"; "Total memory (KB)"; "Total guest memory (KB)";
+      "%CPU";
+      "Total hardware memory (KB)";
+      "Total memory (KB)"; "Total guest memory (KB)";
       "Total CPU time (ns)" ] @
       (* These fields are repeated for each domain: *)
     [ "Domain ID"; "Domain name"; ] @
@@ -1167,6 +1214,7 @@ let append_csv
     string_of_int paused; string_of_int shutdown; string_of_int shutoff;
     string_of_int crashed; string_of_int active; string_of_int inactive;
     sprintf "%2.1f" percent_cpu;
+    Int64.to_string node_info.C.memory;
     Int64.to_string total_memory; Int64.to_string total_domU_memory;
     Int64.to_string (Int64.of_float total_cpu_time)
   ] in
@@ -1220,16 +1268,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 =
@@ -1257,28 +1320,30 @@ and get_key_press setup =
   )
 
 and change_delay () =
-  print_msg (sprintf "Change delay from %.1f to: " (float !delay /. 1000.));
+  print_msg
+    (sprintf (f_ "Change delay from %.1f to: ") (float !delay /. 1000.));
   let str = get_string 16 in
   (* Try to parse the number. *)
   let error =
     try
       let newdelay = float_of_string str in
       if newdelay <= 0. then (
-       print_msg "Delay must be > 0"; true
+       print_msg (s_ "Delay must be > 0"); true
       ) else (
        delay := int_of_float (newdelay *. 1000.); false
       )
     with
       Failure "float_of_string" ->
-       print_msg "Not a valid number"; true in
+       print_msg (s_ "Not a valid number"); true in
+  refresh ();
   sleep (if error then 2 else 1)
 
 and change_sort_order () =
   clear ();
   let lines, cols = get_size () in
 
-  mvaddstr top_lineno 0 "Set sort order for main display";
-  mvaddstr summary_lineno 0 "Type key or use up and down cursor keys.";
+  mvaddstr top_lineno 0 (s_ "Set sort order for main display");
+  mvaddstr summary_lineno 0 (s_ "Type key or use up and down cursor keys.");
 
   attron A.reverse;
   mvaddstr header_lineno 0 (pad cols "KEY   Sort field");
@@ -1360,7 +1425,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 ()
@@ -1399,7 +1467,7 @@ and write_init_file () =
   | NoInitFile -> ()                   (* Do nothing if --no-init-file *)
   | DefaultInitFile ->
       let home = try Sys.getenv "HOME" with Not_found -> "/" in
-      let filename = home // ".virt-toprc" in
+      let filename = home // rcfile in
       _write_init_file filename
   | InitFile filename ->
       _write_init_file filename
@@ -1424,8 +1492,8 @@ and _write_init_file filename =
 
     let fp = fprintf in
     let nl () = fp chan "\n" in
-    fp chan "# .virt-toprc virt-top configuration file\n";
-    fp chan "# generated on %s by %s\n" printable_date_time username;
+    let () = fp chan (f_ "# %s virt-top configuration file\n") rcfile in
+    let () = fp chan (f_ "# generated on %s by %s\n") printable_date_time username in
     nl ();
     fp chan "display %s\n" (cli_of_display !display_mode);
     fp chan "delay %g\n" (float !delay /. 1000.);
@@ -1439,13 +1507,13 @@ and _write_init_file filename =
     if !batch_mode = true then fp chan "batch true\n";
     if !secure_mode = true then fp chan "secure true\n";
     nl ();
-    fp chan "# To send debug and error messages to a file, uncomment next line\n";
+    output_string chan (s_ "# To send debug and error messages to a file, uncomment next line\n");
     fp chan "#debug virt-top.out\n";
     nl ();
-    fp chan "# Enable CSV output to the named file\n";
+    output_string chan (s_ "# Enable CSV output to the named file\n");
     fp chan "#csv virt-top.csv\n";
     nl ();
-    fp chan "# To protect this file from being overwritten, uncomment next line\n";
+    output_string chan (s_ "# To protect this file from being overwritten, uncomment next line\n");
     fp chan "#overwrite-init-file false\n";
 
     close_out chan;
@@ -1457,11 +1525,15 @@ 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 (f_ "Wrote settings to %s") filename);
+    refresh ();
+    sleep 2
   with
-  | Sys_error err -> print_msg "Error: %s"; sleep 2
+  | Sys_error err ->
+      print_msg (s_ "Error" ^ ": " ^ err); refresh (); sleep 2
   | Unix.Unix_error (err, fn, str) ->
-      print_msg (sprintf "Error: %s %s %s" (Unix.error_message err) fn str);
+      print_msg (s_ ("Error" ^ ": " ^ Unix.error_message err ^ fn ^ str));
+      refresh ();
       sleep 2
 
 and show_help (_, _, _, _, _, hostname,
@@ -1473,8 +1545,10 @@ and show_help (_, _, _, _, _, hostname,
 
   (* Banner at the top of the screen. *)
   let banner =
-    sprintf "virt-top %s (libvirt %d.%d.%d) by Red Hat"
-      Libvirt_version.version libvirt_major libvirt_minor libvirt_release in
+    sprintf (f_ "virt-top %s ocaml-libvirt %s libvirt %d.%d.%d by Red Hat")
+      Virt_top_version.version
+      Libvirt_version.version
+      libvirt_major libvirt_minor libvirt_release in
   let banner = pad cols banner in
   attron A.reverse;
   mvaddstr 0 0 banner;
@@ -1482,18 +1556,18 @@ and show_help (_, _, _, _, _, hostname,
 
   (* Status. *)
   mvaddstr 1 0
-    (sprintf "Delay: %.1f secs; Batch: %s; Secure: %s; Sort: %s"
+    (sprintf (f_ "Delay: %.1f secs; Batch: %s; Secure: %s; Sort: %s")
        (float !delay /. 1000.)
        (if !batch_mode then "On" else "Off")
        (if !secure_mode then "On" else "Off")
        (printable_sort_order !sort_order));
   mvaddstr 2 0
-    (sprintf "Connect: %s; Hostname: %s"
+    (sprintf (f_ "Connect: %s; Hostname: %s")
        (match !uri with None -> "default" | Some s -> s)
        hostname);
 
   (* Misc keys on left. *)
-  let banner = pad 38 "MAIN KEYS" in
+  let banner = pad 38 (s_ "MAIN KEYS") in
   attron A.reverse;
   mvaddstr header_lineno 1 banner;
   attroff A.reverse;
@@ -1507,26 +1581,26 @@ and show_help (_, _, _, _, _, hostname,
     move lineno 1; attron A.bold; addstr keys; attroff A.bold;
     move lineno 10; addstr description; ()
   in
-  key "space ^L" "Update display";
-  key "q"        "Quit";
-  key "d s"      "Set update interval";
-  key "h"        "Help";
+  key "space ^L" (s_ "Update display");
+  key "q"        (s_ "Quit");
+  key "d s"      (s_ "Set update interval");
+  key "h"        (s_ "Help");
 
   (* Sort order. *)
   ignore (get_lineno ());
-  let banner = pad 38 "SORTING" in
+  let banner = pad 38 (s_ "SORTING") in
   attron A.reverse;
   mvaddstr (get_lineno ()) 1 banner;
   attroff A.reverse;
 
-  key "P" "Sort by %CPU";
-  key "M" "Sort by %MEM";
-  key "T" "Sort by TIME";
-  key "N" "Sort by ID";
-  key "F" "Select sort field";
+  key "P" (s_ "Sort by %CPU");
+  key "M" (s_ "Sort by %MEM");
+  key "T" (s_ "Sort by TIME");
+  key "N" (s_ "Sort by ID");
+  key "F" (s_ "Select sort field");
 
   (* Display modes on right. *)
-  let banner = pad 39 "DISPLAY MODES" in
+  let banner = pad 39 (s_ "DISPLAY MODES") in
   attron A.reverse;
   mvaddstr header_lineno 40 banner;
   attroff A.reverse;
@@ -1540,17 +1614,18 @@ and show_help (_, _, _, _, _, hostname,
     move lineno 40; attron A.bold; addstr keys; attroff A.bold;
     move lineno 49; addstr description; ()
   in
-  key "0" "Domains display";
-  key "1" "Toggle physical CPUs";
-  key "2" "Toggle network interfaces";
-  key "3" "Toggle block devices";
+  key "0" (s_ "Domains display");
+  key "1" (s_ "Toggle physical CPUs");
+  key "2" (s_ "Toggle network interfaces");
+  key "3" (s_ "Toggle block devices");
 
   (* Update screen and wait for key press. *)
   mvaddstr (lines-1) 0
-    "More help in virt-top(1) man page. Press any key to return.";
+    (s_ "More help in virt-top(1) man page. Press any key to return.");
   refresh ();
   ignore (getch ())
 
 and unknown_command k =
-  print_msg "Unknown command - try 'h' for help";
+  print_msg (s_ "Unknown command - try 'h' for help");
+  refresh ();
   sleep 1