summaryrefslogtreecommitdiffstats
path: root/virt-top/virt_top_utils.mli
diff options
context:
space:
mode:
Diffstat (limited to 'virt-top/virt_top_utils.mli')
-rw-r--r--virt-top/virt_top_utils.mli54
1 files changed, 54 insertions, 0 deletions
diff --git a/virt-top/virt_top_utils.mli b/virt-top/virt_top_utils.mli
new file mode 100644
index 0000000..9cce00e
--- /dev/null
+++ b/virt-top/virt_top_utils.mli
@@ -0,0 +1,54 @@
+(* 'top'-like tool for libvirt domains.
+ (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.
+
+ This file contains utility functions.
+*)
+
+(* Filename concatenation. *)
+val (//) : string -> string -> string
+
+(* Read a configuration file as a list of (lineno, key, value) pairs.
+ * If the config file is missing this returns an empty list.
+ *)
+val read_config_file : string -> (int * string * string) list
+
+(* Pad or truncate a string to a fixed width. *)
+val pad : int -> string -> string
+
+(* Int64 operators for convenience. *)
+val (+^) : int64 -> int64 -> int64
+val (-^) : int64 -> int64 -> int64
+val ( *^ ) : int64 -> int64 -> int64
+val (/^) : int64 -> int64 -> int64
+
+(* Utility functions for formating numbers as short strings. *)
+module Show : sig
+ val percent : float -> string
+ val int64_option : int64 option -> string
+ val int64 : int64 -> string
+ val time : int64 -> string
+end
+
+(* Helpers for manipulating block_stats & interface_stats. *)
+open Libvirt.Domain
+
+val sum_block_stats : block_stats list -> block_stats
+val diff_block_stats : block_stats -> block_stats -> block_stats
+
+val sum_interface_stats : interface_stats list -> interface_stats
+val diff_interface_stats : interface_stats -> interface_stats -> interface_stats