virt-top/virt_top_utils.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    This file contains utility functions.
  20 *)
  21
  22 open Printf
  23
  24 module C = Libvirt.Connect
  25 module D = Libvirt.Domain
  26 module N = Libvirt.Network
  27
  28 let (//) = Filename.concat
  29
  30 (* Int64 operators for convenience. *)
  31 let (+^) = Int64.add
  32 let (-^) = Int64.sub
  33 let ( *^ ) = Int64.mul
  34 let (/^) = Int64.div
  35
  36 (* Input a whole file as a list of lines. *)
  37 let input_all_lines chan =
  38   let lines = ref [] in
  39   (try
  40      while true; do
  41        lines := input_line chan :: !lines
  42      done
  43    with
  44      End_of_file -> ());
  45   List.rev !lines
  46
  47 (* Trim whitespace from the beginning and end of strings. *)
  48 let isspace c =
  49   c = ' '
  50   (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
  51
  52 let triml ?(test = isspace) str =
  53   let i = ref 0 in
  54   let n = ref (String.length str) in
  55   while !n > 0 && test str.[!i]; do
  56     decr n;
  57     incr i
  58   done;
  59   if !i = 0 then str
  60   else String.sub str !i !n
  61
  62 let trimr ?(test = isspace) str =
  63   let n = ref (String.length str) in
  64   while !n > 0 && test str.[!n-1]; do
  65     decr n
  66   done;
  67   if !n = String.length str then str
  68   else String.sub str 0 !n
  69
  70 let trim ?(test = isspace) str =
  71   trimr (triml str)
  72
  73 (* Read a configuration file as a list of (key, value) pairs.
  74  * If the config file is missing this returns an empty list.
  75  *)
  76 let blanks_and_comments = Str.regexp "^[ \t]*\\(#.*\\)?$"
  77
  78 let read_config_file filename =
  79   let lines =
  80     try
  81       let chan = open_in filename in
  82       let lines = input_all_lines chan in
  83       close_in chan;
  84       lines
  85     with
  86       Sys_error _ -> [] in           (* Ignore errors opening file. *)
  87
  88   (* Line numbers. *)
  89   let lines =
  90     let i = ref 0 in List.map (fun line -> (incr i; !i), line) lines in
  91
  92   (* Remove blank lines and comment lines. *)
  93   let lines =
  94     List.filter
  95       (fun (lineno, line) ->
  96          not (Str.string_match blanks_and_comments line 0)) lines in
  97
  98   (* Convert to key, value pairs. *)
  99   List.map (
 100     fun (lineno, line) ->
 101       let key, value = ExtString.String.split line " " in
 102       lineno, trim key, trim value
 103   ) lines
 104
 105 (* Pad a string to the full width with spaces.  If too long, truncate. *)
 106 let pad width str =
 107   let n = String.length str in
 108   if n = width then str
 109   else if n > width then String.sub str 0 width
 110   else (* if n < width then *) str ^ String.make (width-n) ' '
 111
 112 module Show = struct
 113   (* Show a percentage in 4 chars. *)
 114   let percent percent =
 115     if percent <= 0. then " 0.0"
 116     else if percent <= 9.9 then sprintf " %1.1f" percent
 117     else if percent <= 99.9 then sprintf "%2.1f" percent
 118     else "100 "
 119
 120   (* Show an int64 option in 4 chars. *)
 121   let rec int64_option = function
 122     | None -> "    "
 123     | Some n -> int64 n
 124   (* Show an int64 in 4 chars. *)
 125   and int64 = function
 126     | n when n < 0L -> "-!!!"
 127     | n when n <= 9999L ->
 128         sprintf "%4Ld" n
 129     | n when n /^ 1024L <= 999L ->
 130         sprintf "%3LdK" (n /^ 1024L)
 131     | n when n /^ 1_048_576L <= 999L ->
 132         sprintf "%3LdM" (n /^ 1_048_576L)
 133     | n when n /^ 1_073_741_824L <= 999L ->
 134         sprintf "%3LdG" (n /^ 1_073_741_824L)
 135     | _ -> ">!!!"
 136
 137   (* Format the total time (may be large!) in 9 chars. *)
 138   let time ns =
 139     let secs_in_ns = 1_000_000_000L in
 140     let mins_in_ns = 60_000_000_000L in
 141     let hours_in_ns = 3_600_000_000_000L in
 142
 143     let hours = ns /^ hours_in_ns in
 144     let ns = ns -^ (hours *^ hours_in_ns) in
 145     let mins = ns /^ mins_in_ns in
 146     let ns = ns -^ (mins *^ mins_in_ns) in
 147     let secs = ns /^ secs_in_ns in
 148     let ns = ns -^ (secs *^ secs_in_ns) in
 149     let pennies = ns /^ 10_000_000L in
 150
 151     if hours < 12L then
 152       sprintf "%3Ld:%02Ld.%02Ld" (hours *^ 60L +^ mins) secs pennies
 153     else if hours <= 999L then
 154       sprintf "%3Ld:%02Ld:%02Ld" hours mins secs
 155     else (
 156       let days = hours /^ 24L in
 157       let hours = hours -^ (days *^ 24L) in
 158       sprintf "%3Ldd%02Ld:%02Ld" days hours mins
 159     )
 160 end
 161
 162 (* Sum Domain.block_stats structures together.  Missing fields
 163  * get forced to 0.  Empty list returns all 0.
 164  *)
 165 let zero_block_stats =
 166   { D.rd_req = 0L; rd_bytes = 0L; wr_req = 0L; wr_bytes = 0L; errs = 0L }
 167 let add_block_stats bs1 bs2 =
 168   let add f1 f2 = if f1 >= 0L && f2 >= 0L then f1 +^ f2 else 0L in
 169   { D.rd_req = add bs1.D.rd_req   bs2.D.rd_req;
 170     rd_bytes = add bs1.D.rd_bytes bs2.D.rd_bytes;
 171     wr_req   = add bs1.D.wr_req   bs2.D.wr_req;
 172     wr_bytes = add bs1.D.wr_bytes bs2.D.wr_bytes;
 173     errs     = add bs1.D.errs     bs2.D.errs }
 174 let sum_block_stats =
 175   List.fold_left add_block_stats zero_block_stats
 176
 177 (* Get the difference between two block_stats structures.  Missing data
 178  * forces the difference to -1.
 179  *)
 180 let diff_block_stats curr prev =
 181   let sub f1 f2 = if f1 >= 0L && f2 >= 0L then f1 -^ f2 else -1L in
 182   { D.rd_req = sub curr.D.rd_req   prev.D.rd_req;
 183     rd_bytes = sub curr.D.rd_bytes prev.D.rd_bytes;
 184     wr_req   = sub curr.D.wr_req   prev.D.wr_req;
 185     wr_bytes = sub curr.D.wr_bytes prev.D.wr_bytes;
 186     errs     = sub curr.D.errs     prev.D.errs }
 187
 188 (* Sum Domain.interface_stats structures together.  Missing fields
 189  * get forced to 0.  Empty list returns all 0.
 190  *)
 191 let zero_interface_stats =
 192   { D.rx_bytes = 0L; rx_packets = 0L; rx_errs = 0L; rx_drop = 0L;
 193     tx_bytes = 0L; tx_packets = 0L; tx_errs = 0L; tx_drop = 0L }
 194 let add_interface_stats is1 is2 =
 195   let add f1 f2 = if f1 >= 0L && f2 >= 0L then f1 +^ f2 else 0L in
 196   { D.rx_bytes = add is1.D.rx_bytes   is2.D.rx_bytes;
 197     rx_packets = add is1.D.rx_packets is2.D.rx_packets;
 198     rx_errs    = add is1.D.rx_errs    is2.D.rx_errs;
 199     rx_drop    = add is1.D.rx_drop    is2.D.rx_drop;
 200     tx_bytes   = add is1.D.tx_bytes   is2.D.tx_bytes;
 201     tx_packets = add is1.D.tx_packets is2.D.tx_packets;
 202     tx_errs    = add is1.D.tx_errs    is2.D.tx_errs;
 203     tx_drop    = add is1.D.tx_drop    is2.D.tx_drop }
 204 let sum_interface_stats =
 205   List.fold_left add_interface_stats zero_interface_stats
 206
 207 (* Get the difference between two interface_stats structures.
 208  * Missing data forces the difference to -1.
 209  *)
 210 let diff_interface_stats curr prev =
 211   let sub f1 f2 = if f1 >= 0L && f2 >= 0L then f1 -^ f2 else -1L in
 212   { D.rx_bytes = sub curr.D.rx_bytes   prev.D.rx_bytes;
 213     rx_packets = sub curr.D.rx_packets prev.D.rx_packets;
 214     rx_errs    = sub curr.D.rx_errs    prev.D.rx_errs;
 215     rx_drop    = sub curr.D.rx_drop    prev.D.rx_drop;
 216     tx_bytes   = sub curr.D.tx_bytes   prev.D.tx_bytes;
 217     tx_packets = sub curr.D.tx_packets prev.D.tx_packets;
 218     tx_errs    = sub curr.D.tx_errs    prev.D.tx_errs;
 219     tx_drop    = sub curr.D.tx_drop    prev.D.tx_drop }