Fixed incorrect max_memory_peek value.
[virt-mem.git] / lib / virt_mem.ml
index 4859840..dd3c18a 100644 (file)
@@ -22,6 +22,9 @@ open Printf
 open ExtList
 open ExtString
 
+module C = Libvirt.Connect
+module D = Libvirt.Domain
+
 open Virt_mem_gettext.Gettext
 open Virt_mem_utils
 module MMap = Virt_mem_mmap
@@ -29,6 +32,14 @@ module MMap = Virt_mem_mmap
 let min_kallsyms_tabsize = 1_000L
 let max_kallsyms_tabsize = 250_000L
 
+(* Make the kernel size around 16 MB, but just a bit smaller than
+ * maximum string length so we can still run this on a 32 bit platform.
+ *)
+let kernel_size =
+  if Sys.word_size = 32 then Sys.max_string_length
+  else 0x100_0000
+let max_memory_peek = 65536 (* XXX Use D.max_peek function *)
+
 type ksym = string
 
 type image =
@@ -42,8 +53,8 @@ type kallsyms_compr =
   | Uncompressed of (string * MMap.addr) list
 
 let start usage_msg =
-  (* Verbose messages. *)
-  let verbose = ref false in
+  (* Debug messages. *)
+  let debug = ref false in
 
   (* Default wordsize. *)
   let def_wordsize = ref None in
@@ -87,6 +98,8 @@ let start usage_msg =
 
   (* List of kernel images. *)
   let images = ref [] in
+  let uri = ref "" in
+  let anon_args = ref [] in
 
   let memory_image filename =
     images :=
@@ -94,35 +107,174 @@ let start usage_msg =
     :: !images
   in
 
+  let version () =
+    printf "virt-mem %s\n" Virt_mem_version.version;
+
+    let major, minor, release =
+      let v, _ = Libvirt.get_version () in
+      v / 1_000_000, (v / 1_000) mod 1_000, v mod 1_000 in
+    printf "libvirt %d.%d.%d\n" major minor release;
+    exit 0
+  in
+
   let argspec = Arg.align [
     "-A", Arg.String set_architecture,
-    "arch " ^ s_"Set kernel architecture, endianness and word size";
+      "arch " ^ s_"Set kernel architecture, endianness and word size";
     "-E", Arg.String set_endian,
-    "endian " ^ s_"Set kernel endianness";
+      "endian " ^ s_"Set kernel endianness";
     "-T", Arg.String set_text_addr,
-    "addr " ^ s_"Set kernel text address";
+      "addr " ^ s_"Set kernel text address";
     "-W", Arg.String set_wordsize,
-    "addr " ^ s_"Set kernel word size";
+      "addr " ^ s_"Set kernel word size";
+    "-c", Arg.Set_string uri,
+      "uri " ^ s_ "Connect to URI";
+    "--connect", Arg.Set_string uri,
+      "uri " ^ s_ "Connect to URI";
+    "--debug", Arg.Set debug,
+      " " ^ s_"Debug mode (default: false)";
     "-t", Arg.String memory_image,
-    "image " ^ s_"Use saved kernel memory image";
-    "-verbose", Arg.Set verbose,
-    " " ^ s_"Verbose messages";
+      "image " ^ s_"Use saved kernel memory image";
+    "--version", Arg.Unit version,
+      " " ^ s_"Display version and exit";
   ] in
 
-  let anon_fun str =
-    raise (Arg.Bad (sprintf (f_"%s: unknown parameter") str)) in
+  let anon_arg str = anon_args := str :: !anon_args in
   let usage_msg = usage_msg ^ s_"\n\nOPTIONS" in
-  Arg.parse argspec anon_fun usage_msg;
+  Arg.parse argspec anon_arg usage_msg;
 
   let images = !images in
-  let verbose = !verbose in
+  let debug = !debug in
+  let uri = if !uri = "" then None else Some !uri in
+  let anon_args = List.rev !anon_args in
 
   (* Get the kernel images. *)
   let images =
-    if images = [] then
-      (* XXX use libvirt to get images *)
-      failwith "libvirt: not yet implemented"
-    else
+    if images = [] then (
+      let conn =
+       let name = uri in
+       try C.connect_readonly ?name ()
+       with Libvirt.Virterror err ->
+         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 (s_ "NB: If you want to monitor a local Xen hypervisor, you usually need to be root");
+         );
+         exit 1 in
+
+      (* If we have a list of parameters, then it is the domain names / UUIDs /
+       * IDs ONLY that we wish to display.  Otherwise, display all active.
+       *)
+      let doms =
+       if anon_args = [] then (
+         (* List of active domains. *)
+         let nr_active_doms = C.num_of_domains conn in
+         let active_doms =
+           Array.to_list (C.list_domains conn nr_active_doms) in
+         List.map (D.lookup_by_id conn) active_doms
+       ) else (
+         List.map (
+           fun arg ->
+             let dom =
+               try D.lookup_by_uuid_string conn arg
+               with _ ->
+                 try D.lookup_by_name conn arg
+                 with _ ->
+                   try D.lookup_by_id conn (int_of_string arg)
+                   with _ ->
+                     failwith (sprintf (f_"%s: unknown domain (not a UUID, name or ID of any active domain)") arg) in
+
+             (* XXX Primitive test to see if the domain is active. *)
+             let is_active = try D.get_id dom >= 0 with _ -> false in
+             if not is_active then
+               failwith (sprintf (f_"%s: domain is not running") arg);
+
+             dom
+         ) anon_args
+       ) in
+
+      (* Get their XML. *)
+      let xmls = List.map (fun dom -> dom, D.get_xml_desc dom) doms in
+
+      (* Parse the XML. *)
+      let xmls = List.map (fun (dom, xml) ->
+                            dom, Xml.parse_string xml) xmls in
+
+      (* XXX Do something with the XML XXX
+       * such as detecting arch, wordsize, endianness.
+       * XXXXXXXXXXXXXX
+       *
+       *
+       *
+       *)
+
+
+      List.map (
+       fun (dom, _) ->
+         let name = D.get_name dom in
+
+         let wordsize =
+           match !def_wordsize with
+           | None ->
+               failwith
+                 (sprintf (f_"%s: use -W to define word size for this image")
+                    name);
+           | Some ws -> ws in
+         let endian =
+           match !def_endian with
+           | None ->
+               failwith
+                 (sprintf (f_"%s: use -E to define endianness for this image")
+                    name);
+           | Some e -> e in
+
+         let arch =
+           match !def_architecture with
+           | Some I386 -> I386 | Some X86_64 -> X86_64
+           | _ ->
+               failwith
+                 (sprintf (f_"%s: use -A to define architecture (i386/x86-64 only) for this image") name) in
+
+         if !def_text_addr = 0L then
+           failwith
+             (sprintf (f_"%s: use -T to define kernel load address for this image") name);
+
+         let start_t = gettimeofday () in
+
+         (* Read the kernel memory.
+          * Maximum 64K can be read over remote connections.
+          *)
+         let str = String.create kernel_size in
+         let rec loop i =
+           let remaining = kernel_size - i in
+           if remaining > 0 then (
+             let size = min remaining max_memory_peek in
+             D.memory_peek dom [D.Virtual]
+               (!def_text_addr +^ Int64.of_int i) size str i;
+             loop (i + size)
+           )
+         in
+         loop 0;
+
+         if debug then (
+           let end_t = gettimeofday () in
+           eprintf "timing: downloading kernel took %f seconds\n%!"
+             (end_t -. start_t)
+         );
+
+         (* Map the virtual memory. *)
+         let mem = MMap.of_string str !def_text_addr in
+
+         (* Force the wordsize and endianness. *)
+         let mem = MMap.set_wordsize mem wordsize in
+         let mem = MMap.set_endian mem endian in
+
+         (name, arch, mem)
+      ) xmls
+    ) else (
+      (* One or more -t options passed. *)
+      if anon_args <> [] then
+       failwith (s_"virt-mem: if -t given on command line, then no domain arguments should be listed");
+
       List.map (
        fun (wordsize, endian, arch, text_addr, filename) ->
          (* Quite a lot of limitations on the kernel images we can
@@ -165,7 +317,8 @@ let start usage_msg =
          let mem = MMap.set_endian mem endian in
 
          (filename, arch, mem)
-      ) images in
+      ) images
+    ) in
 
   let images =
     List.map (
@@ -191,12 +344,22 @@ let start usage_msg =
        (* Searching for <NUL>string<NUL> *)
        let common_ksyms_nul = List.map (sprintf "\000%s\000") common_ksyms in
 
+       let start_t = gettimeofday () in
+
        (* Search for these strings in the memory image. *)
        let ksym_strings = List.map (MMap.find_all mem) common_ksyms_nul in
        let ksym_strings = List.concat ksym_strings in
        (* Adjust found addresses to start of the string (skip <NUL>). *)
        let ksym_strings = List.map Int64.succ ksym_strings in
 
+       if debug then (
+         let end_t = gettimeofday () in
+         eprintf "timing: searching for common_ksyms took %f seconds\n%!"
+           (end_t -. start_t)
+       );
+
+       let start_t = gettimeofday () in
+
        (* For any we found, try to look up the symbol table
         * base addr and size.
         *)
@@ -257,12 +420,12 @@ let start usage_msg =
        (* Simply ignore any symbol table candidates which are too small. *)
        let ksymtabs = List.filter (fun (_, size) -> size > 64L) ksymtabs in
 
-       if verbose then (
-         printf "%s: candidate symbol tables at:\n" name;
+       if debug then (
+         eprintf "%s: candidate symbol tables at:\n" name;
          List.iter (
            fun (addr, size) ->
-             printf "\t%Lx\t%Lx\t%!" addr size;
-             printf "first symbol: %s\n%!"
+             eprintf "\t%Lx\t%Lx\t%!" addr size;
+             eprintf "first symbol: %s\n%!"
                (MMap.get_string mem
                   (MMap.follow_pointer mem
                      (MMap.succ_long mem addr)))
@@ -280,8 +443,8 @@ let start usage_msg =
              (fun _ -> raise Not_found)
 
          | (_, (ksymtab_addr, ksymtab_size)) :: _ ->
-             if verbose then
-               printf
+             if debug then
+               eprintf
                  "%s: Kernel symbol table found at %Lx, size %Lx bytes\n%!"
                  name ksymtab_addr ksymtab_size;
 
@@ -313,6 +476,14 @@ let start usage_msg =
              lookup_ksym
        in
 
+       if debug then (
+         let end_t = gettimeofday () in
+         eprintf "timing: searching for ordinary ksyms took %f seconds\n%!"
+           (end_t -. start_t)
+       );
+
+       let start_t = gettimeofday () in
+
        (* Now try to find the /proc/kallsyms table.  This is in an odd
         * compressed format (but not a very successful compression
         * format).  However if it exists we know that it will contain
@@ -342,8 +513,8 @@ let start usage_msg =
            (* Search upwards from address until we find the length field.
             * If found, jump backwards by length and check all addresses.
             *)
-           if verbose then
-             printf "%s: testing candidate kallsyms at %Lx\n" name addr;
+           if debug then
+             eprintf "%s: testing candidate kallsyms at %Lx\n" name addr;
            let rec loop addr =
              let addrp = MMap.follow_pointer mem addr in
              if MMap.is_mapped mem addrp then
@@ -369,8 +540,8 @@ let start usage_msg =
                    ) else
                      (* ok! *)
                      let names_addr = MMap.succ_long mem end_addr in
-                     if verbose then
-                       printf "%s: candidate kallsyms found at %Lx (names_addr at %Lx, num_entries %d)\n"
+                     if debug then
+                       eprintf "%s: candidate kallsyms found at %Lx (names_addr at %Lx, num_entries %d)\n"
                          name start_addr names_addr num_entries;
                      Some (start_addr, num_entries, names_addr)
                  in
@@ -407,7 +578,7 @@ let start usage_msg =
                        let names_addr = names_addr +^ Int64.of_int len +^ 2L in
                        let sym_value = MMap.follow_pointer mem start_addr in
                        let start_addr = MMap.succ_long mem start_addr in
-                       (*printf "%S -> %Lx\n" name sym_value;*)
+                       (*eprintf "%S -> %Lx\n" name sym_value;*)
                        names := (name, sym_value) :: !names;
                        loop names_addr start_addr (num-1)
                      )
@@ -444,16 +615,16 @@ let start usage_msg =
                  Invalid_argument _ -> None (* bad names list *)
        ) ksym_addrs in
 
-       if verbose then (
-         printf "%s: candidate kallsyms at:\n" name;
+       if debug then (
+         eprintf "%s: candidate kallsyms at:\n" name;
          List.iter (
            function
            | (start_addr, num_entries, names_addr, Uncompressed _) ->
-               printf "\t%Lx %d entries names_addr=%Lx old-style\n%!"
+               eprintf "\t%Lx %d entries names_addr=%Lx old-style\n%!"
                  start_addr num_entries names_addr
            | (start_addr, num_entries, names_addr,
               Compressed (_, markers_addr)) ->
-               printf "\t%Lx %d entries names_addr=%Lx markers_addr=%Lx\n%!"
+               eprintf "\t%Lx %d entries names_addr=%Lx markers_addr=%Lx\n%!"
                  start_addr num_entries names_addr markers_addr
          ) kallsymtabs
        );
@@ -518,7 +689,7 @@ let start usage_msg =
                   *)
                  (*let typ = name.[0] in*)
                  let name = String.sub name 1 (String.length name - 1) in
-                 (*printf "%S -> %Lx\n" name sym_value;*)
+                 (*eprintf "%S -> %Lx\n" name sym_value;*)
                  Some (name, sym_value)
              ) compressed_names in
 
@@ -531,18 +702,24 @@ let start usage_msg =
 
              lookup_ksym in
 
+       if debug then (
+         let end_t = gettimeofday () in
+         eprintf "timing: searching for kallsyms took %f seconds\n%!"
+           (end_t -. start_t)
+       );
+
        (* Just wrap the lookup_ksym call in something which prints
-        * the query when verbose is set.
+        * the query when debug is set.
         *)
        let lookup_ksym =
-         if verbose then
+         if debug then
            let lookup_ksym sym =
              try
                let value = lookup_ksym sym in
-               printf "lookup_ksym %S = %Lx\n%!" sym value;
+               eprintf "lookup_ksym %S = %Lx\n%!" sym value;
                value
              with Not_found ->
-               printf "lookup_ksym %S failed\n%!" sym;
+               eprintf "lookup_ksym %S failed\n%!" sym;
                raise Not_found
            in
            lookup_ksym
@@ -553,4 +730,4 @@ let start usage_msg =
        ((name, arch, mem, lookup_ksym) : image)
     ) images in
 
-  verbose, images
+  debug, images