Replace failwith (sprintf...) with failwithf
[virt-top.git] / virt-top / virt_top.ml
index a8c4839..1a39e06 100644 (file)
@@ -28,6 +28,8 @@ 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 (
@@ -78,9 +80,8 @@ let sort_order_of_cli = function
   | "netrx" -> NetRX | "nettx" -> NetTX
   | "blockrdrq" -> BlockRdRq | "blockwrrq" -> BlockWrRq
   | str ->
-      failwith
-       (sprintf (f_ "%s: sort order should be: %s")
-          str "cpu|mem|time|id|name|netrx|nettx|blockrdrq|blockwrrq")
+      failwithf (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"
@@ -101,9 +102,7 @@ let display_of_cli = function
   | "block" -> BlockDisplay
   | "net" -> NetDisplay
   | str ->
-      failwith
-       (sprintf (f_ "%s: display should be %s")
-          str "task|pcpu|block|net")
+      failwithf (f_ "%s: display should be %s") str "task|pcpu|block|net"
 let cli_of_display = function
   | TaskDisplay -> "task"
   | PCPUDisplay -> "pcpu"
@@ -155,6 +154,10 @@ let start_up () =
   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)
+  and display_version () =
+    printf "virt-top %s ocaml-libvirt %s\n"
+      Virt_top_version.version Libvirt_version.version;
+    exit 0
   in
   let argspec = Arg.align [
     "-1", Arg.Unit set_pcpu_mode,
@@ -197,6 +200,8 @@ let start_up () =
       " " ^ s_ "Secure (\"kiosk\") mode";
     "--script", Arg.Set script_mode,
       " " ^ s_ "Run from a script (no user interface)";
+    "--version", Arg.Unit display_version,
+      " " ^ s_ "Display version number and exit";
   ] in
   let anon_fun str =
     raise (Arg.Bad (sprintf (f_ "%s: unknown parameter") str)) in
@@ -238,7 +243,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
@@ -297,13 +302,13 @@ OPTIONS" in
 
   (* Curses voodoo (see ncurses(3)). *)
   if not !script_mode then (
-    initscr ();
-    cbreak ();
-    noecho ();
+    ignore (initscr ());
+    ignore (cbreak ());
+    ignore (noecho ());
     nonl ();
     let stdscr = stdscr () in
-    intrflush stdscr false;
-    keypad stdscr true;
+    ignore (intrflush stdscr false);
+    ignore (keypad stdscr true);
     ()
   );
 
@@ -337,10 +342,10 @@ let usleep n =
  * This helper function also enables echo temporarily.
  *)
 let get_string maxlen =
-  echo ();
+  ignore (echo ());
   let str = String.create maxlen in
   let ok = getstr str in (* Safe because binding calls getnstr. *)
-  noecho ();
+  ignore (noecho ());
   if not ok then ""
   else (
     (* Chop at first '\0'. *)
@@ -359,8 +364,8 @@ let header_lineno = 4
 let domains_lineno = 5
 
 (* Print in the "message area". *)
-let clear_msg () = move message_lineno 0; clrtoeol ()
-let print_msg str = clear_msg (); mvaddstr message_lineno 0 str; ()
+let clear_msg () = ignore (move message_lineno 0); clrtoeol ()
+let print_msg str = clear_msg (); ignore (mvaddstr message_lineno 0 str)
 
 (* Intermediate "domain + stats" structure that we use to collect
  * everything we know about a domain within the collect function.
@@ -746,12 +751,13 @@ let redraw =
     let lines, cols = get_size () in
 
     (* Time. *)
-    mvaddstr top_lineno 0 ("virt-top " ^ printable_time ^ " - ");
+    ignore (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
-             (node_info.C.memory /^ 1024L));
+    ignore (addstr
+             (sprintf "%s %d/%dCPU %dMHz %LdMB "
+                node_info.C.model node_info.C.cpus nr_pcpus node_info.C.mhz
+                (node_info.C.memory /^ 1024L)));
     (* Save the cursor position for when we come to draw the
      * historical CPU times (down in this function).
      *)
@@ -832,8 +838,9 @@ let redraw =
 
         (* Print domains. *)
         attron A.reverse;
-        mvaddstr header_lineno 0
-          (pad cols "   ID S RDRQ WRRQ RXBY TXBY %CPU %MEM    TIME   NAME");
+        ignore (
+          mvaddstr header_lineno 0
+            (pad cols "   ID S RDRQ WRRQ RXBY TXBY %CPU %MEM    TIME   NAME"));
         attroff A.reverse;
 
         let rec loop lineno = function
@@ -856,7 +863,7 @@ let redraw =
                   rd.rd_domid state rd_req wr_req rx_bytes tx_bytes
                   percent_cpu percent_mem time name in
                 let line = pad cols line in
-                mvaddstr lineno 0 line;
+                ignore (mvaddstr lineno 0 line);
                 loop (lineno+1) doms
               )
           | (name, Inactive) :: doms -> (* inactive domain *)
@@ -866,7 +873,7 @@ let redraw =
                     "    -                                           (%s)"
                     name in
                 let line = pad cols line in
-                mvaddstr lineno 0 line;
+                ignore (mvaddstr lineno 0 line);
                 loop (lineno+1) doms
               )
         in
@@ -889,16 +896,17 @@ let redraw =
             ) doms
           ) in
         attron A.reverse;
-        mvaddstr header_lineno 0 (pad cols ("PHYCPU %CPU " ^ dom_names));
+        ignore (
+          mvaddstr header_lineno 0 (pad cols ("PHYCPU %CPU " ^ dom_names)));
         attroff A.reverse;
 
         Array.iteri (
           fun p row ->
-            mvaddstr (p+domains_lineno) 0 (sprintf "%4d   " p);
+            ignore (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);
-            addch 32;
+            ignore (addstr (Show.percent percent_cpu));
+            ignore (addch 32);
 
             List.iteri (
               fun di (domid, name, _, _, _, _, _) ->
@@ -914,7 +922,7 @@ let redraw =
                       (if is_average then '=' else ' ')
                       (if is_running then '#' else ' ')
                   ) in
-                addstr (pad width str);
+                ignore (addstr (pad width str));
                 ()
             ) doms
         ) pcpus;
@@ -988,8 +996,9 @@ let redraw =
 
         (* Print the header for network devices. *)
         attron A.reverse;
-        mvaddstr header_lineno 0
-          (pad cols "   ID S RXBY TXBY RXPK TXPK DOMAIN       INTERFACE");
+        ignore (
+          mvaddstr header_lineno 0
+            (pad cols "   ID S RXBY TXBY RXPK TXPK DOMAIN       INTERFACE"));
         attroff A.reverse;
 
         (* Print domains and devices. *)
@@ -1021,7 +1030,7 @@ let redraw =
                   rx_packets tx_packets
                   (pad 12 name) dev in
                 let line = pad cols line in
-                mvaddstr lineno 0 line;
+                ignore (mvaddstr lineno 0 line);
                 loop (lineno+1) devs
               )
         in
@@ -1096,8 +1105,9 @@ let redraw =
 
         (* Print the header for block devices. *)
         attron A.reverse;
-        mvaddstr header_lineno 0
-          (pad cols "   ID S RDBY WRBY RDRQ WRRQ DOMAIN       DEVICE");
+        ignore (
+          mvaddstr header_lineno 0
+            (pad cols "   ID S RDBY WRBY RDRQ WRRQ DOMAIN       DEVICE"));
         attroff A.reverse;
 
         (* Print domains and devices. *)
@@ -1129,7 +1139,7 @@ let redraw =
                   rd_req wr_req
                   (pad 12 name) dev in
                 let line = pad cols line in
-                mvaddstr lineno 0 line;
+                ignore (mvaddstr lineno 0 line);
                 loop (lineno+1) devs
               )
         in
@@ -1140,16 +1150,18 @@ let redraw =
         crashed, active, inactive,
         total_cpu_time, total_memory, total_domU_memory) = totals in
 
-    mvaddstr summary_lineno 0
-      (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);
+    ignore (
+      mvaddstr summary_lineno 0
+       (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 (f_ "CPU: %2.1f%%  Mem: %Ld MB (%Ld MB by guests)")
-        percent_cpu (total_memory /^ 1024L) (total_domU_memory /^ 1024L));
+    ignore (
+      mvaddstr (summary_lineno+1) 0
+       (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? *)
     if time >= !historical_cpu_last_time +. float !historical_cpu_delay
@@ -1166,11 +1178,12 @@ let redraw =
        String.concat " "
          (List.map (sprintf "%2.1f%%") !historical_cpu) in
       let line = pad maxwidth line in
-      mvaddstr y x line;
+      ignore (mvaddstr y x line);
       () in
 
-    move message_lineno 0; (* Park cursor in message area, as with top. *)
-    refresh ();                   (* Refresh the display. *)
+    (* Park cursor in message area, as with top. *)
+    ignore (move message_lineno 0);
+    ignore (refresh ());               (* Refresh the display. *)
     ()
 
 (* Write CSV header row. *)
@@ -1179,7 +1192,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"; ] @
@@ -1210,6 +1225,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
@@ -1330,18 +1346,18 @@ and change_delay () =
     with
       Failure "float_of_string" ->
        print_msg (s_ "Not a valid number"); true in
-  refresh ();
+  ignore (refresh ());
   sleep (if error then 2 else 1)
 
 and change_sort_order () =
   clear ();
   let lines, cols = get_size () in
 
-  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.");
+  ignore (mvaddstr top_lineno 0 (s_ "Set sort order for main display"));
+  ignore (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");
+  ignore (mvaddstr header_lineno 0 (pad cols "KEY   Sort field"));
   attroff A.reverse;
 
   let accelerator_key = function
@@ -1369,15 +1385,15 @@ and change_sort_order () =
     fun i ord ->
       let selected = !sort_order = ord in
       if selected then selected_index := i;
-      mvaddstr (domains_lineno+i) 0
-       (sprintf "  %c %s %s %s"
-          (key_of_int i) (if selected then "*" else " ")
-          (printable_sort_order ord)
-          (accelerator_key ord))
+      ignore (mvaddstr (domains_lineno+i) 0
+               (sprintf "  %c %s %s %s"
+                  (key_of_int i) (if selected then "*" else " ")
+                  (printable_sort_order ord)
+                  (accelerator_key ord)))
   ) all_sort_fields;
 
-  move message_lineno 0;
-  refresh ();
+  ignore (move message_lineno 0);
+  ignore (refresh ());
   let k = getch () in
   if k >= 0 && k <> 32 && k <> Char.code 'q' && k <> 13 then (
     let new_order, loop =
@@ -1421,7 +1437,7 @@ and change_sort_order () =
         print_msg (sprintf "Sort order changed to: %s"
                      (printable_sort_order new_order));
         if not loop then (
-          refresh ();
+          ignore (refresh ());
           sleep 1
         )
     );
@@ -1462,7 +1478,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
@@ -1487,7 +1503,7 @@ and _write_init_file filename =
 
     let fp = fprintf in
     let nl () = fp chan "\n" in
-    let () = fp chan (f_ "# .virt-toprc virt-top configuration file\n") in
+    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);
@@ -1502,13 +1518,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 ();
-    let () = fp chan (f_ "# To send debug and error messages to a file, uncomment next line\n") in
+    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 ();
-    let () = fp chan (f_ "# Enable CSV output to the named file\n") in
+    output_string chan (s_ "# Enable CSV output to the named file\n");
     fp chan "#csv virt-top.csv\n";
     nl ();
-    let () = fp chan (f_ "# To protect this file from being overwritten, uncomment next line\n") in
+    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;
@@ -1521,14 +1537,15 @@ and _write_init_file filename =
     Unix.rename (filename ^ ".new") filename;
 
     print_msg (sprintf (f_ "Wrote settings to %s") filename);
-    refresh ();
+    ignore (refresh ());
     sleep 2
   with
   | Sys_error err ->
-      print_msg (s_ "Error" ^ ": " ^ err); refresh (); sleep 2
+      ignore (print_msg (s_ "Error" ^ ": " ^ err));
+      ignore (refresh ()); sleep 2
   | Unix.Unix_error (err, fn, str) ->
-      print_msg (s_ ("Error" ^ ": " ^ Unix.error_message err ^ fn ^ str));
-      refresh ();
+      ignore (print_msg (s_ ("Error" ^ ": " ^ Unix.error_message err ^ fn ^ str)));
+      ignore (refresh ());
       sleep 2
 
 and show_help (_, _, _, _, _, hostname,
@@ -1540,29 +1557,31 @@ and show_help (_, _, _, _, _, hostname,
 
   (* Banner at the top of the screen. *)
   let banner =
-    sprintf (f_ "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;
+  ignore (mvaddstr 0 0 banner);
   attroff A.reverse;
 
   (* Status. *)
-  mvaddstr 1 0
-    (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 (f_ "Connect: %s; Hostname: %s")
-       (match !uri with None -> "default" | Some s -> s)
-       hostname);
+  ignore (mvaddstr 1 0
+           (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)));
+  ignore (mvaddstr 2 0
+           (sprintf (f_ "Connect: %s; Hostname: %s")
+              (match !uri with None -> "default" | Some s -> s)
+              hostname));
 
   (* Misc keys on left. *)
   let banner = pad 38 (s_ "MAIN KEYS") in
   attron A.reverse;
-  mvaddstr header_lineno 1 banner;
+  ignore (mvaddstr header_lineno 1 banner);
   attroff A.reverse;
 
   let get_lineno =
@@ -1571,8 +1590,8 @@ and show_help (_, _, _, _, _, hostname,
   in
   let key keys description =
     let lineno = get_lineno () in
-    move lineno 1; attron A.bold; addstr keys; attroff A.bold;
-    move lineno 10; addstr description; ()
+    ignore (move lineno 1); attron A.bold; ignore (addstr keys); attroff A.bold;
+    ignore (move lineno 10); ignore (addstr description)
   in
   key "space ^L" (s_ "Update display");
   key "q"        (s_ "Quit");
@@ -1583,7 +1602,7 @@ and show_help (_, _, _, _, _, hostname,
   ignore (get_lineno ());
   let banner = pad 38 (s_ "SORTING") in
   attron A.reverse;
-  mvaddstr (get_lineno ()) 1 banner;
+  ignore (mvaddstr (get_lineno ()) 1 banner);
   attroff A.reverse;
 
   key "P" (s_ "Sort by %CPU");
@@ -1595,7 +1614,7 @@ and show_help (_, _, _, _, _, hostname,
   (* Display modes on right. *)
   let banner = pad 39 (s_ "DISPLAY MODES") in
   attron A.reverse;
-  mvaddstr header_lineno 40 banner;
+  ignore (mvaddstr header_lineno 40 banner);
   attroff A.reverse;
 
   let get_lineno =
@@ -1604,8 +1623,8 @@ and show_help (_, _, _, _, _, hostname,
   in
   let key keys description =
     let lineno = get_lineno () in
-    move lineno 40; attron A.bold; addstr keys; attroff A.bold;
-    move lineno 49; addstr description; ()
+    ignore (move lineno 40); attron A.bold; ignore (addstr keys); attroff A.bold;
+    ignore (move lineno 49); ignore (addstr description)
   in
   key "0" (s_ "Domains display");
   key "1" (s_ "Toggle physical CPUs");
@@ -1613,12 +1632,12 @@ and show_help (_, _, _, _, _, hostname,
   key "3" (s_ "Toggle block devices");
 
   (* Update screen and wait for key press. *)
-  mvaddstr (lines-1) 0
-    (s_ "More help in virt-top(1) man page. Press any key to return.");
-  refresh ();
+  ignore (mvaddstr (lines-1) 0
+           (s_ "More help in virt-top(1) man page. Press any key to return."));
+  ignore (refresh ());
   ignore (getch ())
 
 and unknown_command k =
   print_msg (s_ "Unknown command - try 'h' for help");
-  refresh ();
+  ignore (refresh ());
   sleep 1