type ksym = string
type image =
- string
+ int option
+ * string
+ * Virt_mem_utils.architecture
+ * ([`Wordsize], [`Endian]) Virt_mem_mmap.t
+
+type image_with_ksyms =
+ int option
+ * string
* Virt_mem_utils.architecture
* ([`Wordsize], [`Endian]) Virt_mem_mmap.t
* (ksym -> MMap.addr)
(* When tools register themselves, they are added to this list.
* Later, we will alphabetize the list.
*)
-let tools = ref [
- "capture", (
- "capture",
- s_"capture memory image for post-mortem analysis",
- s_"Capture a memory image to a file for later post-mortem
-analysis. Use the '-o memoryimage' option to specify the
-output file.
-
-Other tools can load the memory image using the '-t' option.",
- false,
- (fun _ _ -> ())
- );
-]
+let tools = ref []
(* Registration function used by the tools. *)
-let register name summary description is_cmd run_fn =
- tools := (name, (name, summary, description, is_cmd, run_fn)) :: !tools
+let register ?(external_cmd = true) ?(extra_args = [])
+ ?argcheck ?beforeksyms ?run
+ name summary description =
+ tools :=
+ (name, (name, summary, description, external_cmd, extra_args,
+ argcheck, beforeksyms, run))
+ :: !tools
(* Main program, called from mem/virt_mem_main.ml when all the
* tools have had a chance to register themselves.
* module to properly parse the command line (below), so that
* we can have a usage message ready.
*)
- let tool =
+ let tool, ignore_first_anon_arg =
let prog = Sys.executable_name in (* eg. "/usr/bin/virt-dmesg.opt" *)
let prog = Filename.basename prog in(* eg. "virt-dmesg.opt" *)
let prog = (* eg. "virt-dmesg" *)
if String.starts_with prog "virt-" then
String.sub prog 5 (String.length prog - 5)
else prog in
- try Some (List.assoc prog tools)
+ try Some (List.assoc prog tools), false
with Not_found ->
let arg1 = (* First non-option argument. *)
match Array.to_list Sys.argv with
in
loop args in
match arg1 with
- | None -> None
+ | None -> None, false
| Some prog -> (* Recognisable first argument? *)
let prog =
try Filename.chop_extension prog with Invalid_argument _ -> prog in
if String.starts_with prog "virt-" then
String.sub prog 5 (String.length prog - 5)
else prog in
- (try Some (List.assoc prog tools) with Not_found -> None) in
+ (try Some (List.assoc prog tools), true
+ with Not_found -> None, false) in
(* Make a usage message. *)
let usage_msg =
match tool with
| None -> (* Generic usage message. *)
let tools = List.map (
- fun (name, (_, summary, _, is_cmd, _)) ->
- if is_cmd then "virt-"^name, summary
- else "virt-mem "^name, summary
+ fun (name, (_, summary, _, external_cmd, _, _, _, _)) ->
+ if external_cmd then "virt-"^name, summary
+ else "virt-mem "^name, summary
) tools in
(* Maximum width of field in the left hand column. *)
let max_width =
Options:") tools
(* Tool-specific usage message. *)
- | Some (name, summary, description, is_cmd, _) ->
- let cmd = if is_cmd then "virt-" ^ name else "virt-mem " ^ name in
+ | Some (name, summary, description, external_cmd, _, _, _, _) ->
+ let cmd =
+ if external_cmd then "virt-" ^ name else "virt-mem " ^ name in
sprintf (f_"\
Options:") cmd summary description in
(* Now begin proper parsing of the command line arguments. *)
-
- (* Debug messages. *)
let debug = ref false in
+ let images = ref [] in
+ let uri = ref "" in
+ let anon_args = ref [] in
(* Default wordsize. *)
let def_wordsize = ref None in
| str -> def_text_addr := Int64.of_string str
in
- (* List of kernel images. *)
- let images = ref [] in
- let uri = ref "" in
- let anon_args = ref [] in
-
+ (* Handle -t option. *)
let memory_image filename =
images :=
(!def_wordsize, !def_endian, !def_architecture, !def_text_addr, filename)
:: !images
in
+ (* Handle --version option. *)
let version () =
printf "virt-mem %s\n" Virt_mem_version.version;
exit 0
in
- let argspec = Arg.align [
- "-A", Arg.String set_architecture,
- "arch " ^ s_"Set kernel architecture, endianness and word size";
- "-E", Arg.String set_endian,
- "endian " ^ s_"Set kernel endianness";
- "-T", Arg.String set_text_addr,
- "addr " ^ s_"Set kernel text address";
- "-W", Arg.String set_wordsize,
- "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";
- "--version", Arg.Unit version,
- " " ^ s_"Display version and exit";
- ] in
-
+ (* Function to collect up any anonymous args (domain names/IDs). *)
let anon_arg str = anon_args := str :: !anon_args in
+
+ (* Construct the argspec.
+ * May include extra arguments specified by the tool.
+ *)
+ let argspec =
+ let extra_args = match tool with
+ | None -> []
+ | Some (_, _, _, _, extra_args, _, _, _) -> extra_args in
+ let argspec = [
+ "-A", Arg.String set_architecture,
+ "arch " ^ s_"Set kernel architecture, endianness and word size";
+ "-E", Arg.String set_endian,
+ "endian " ^ s_"Set kernel endianness";
+ "-T", Arg.String set_text_addr,
+ "addr " ^ s_"Set kernel text address";
+ "-W", Arg.String set_wordsize,
+ "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";
+ "--version", Arg.Unit version,
+ " " ^ s_"Display version and exit";
+ ] @ extra_args in
+
+ (* Sort options alphabetically on first alpha character. *)
+ let cmp (a,_,_) (b,_,_) =
+ let chars = "-" in
+ let a = String.strip ~chars a and b = String.strip ~chars b in
+ compare a b
+ in
+ let argspec = List.sort ~cmp argspec in
+ (* Make the options line up nicely. *)
+ Arg.align argspec in
+
+ (* Parse the command line. This will exit if --version or --help found. *)
Arg.parse argspec anon_arg usage_msg;
let images = !images in
let debug = !debug in
let uri = if !uri = "" then None else Some !uri in
+
+ (* Discard the first anonymous argument if, above, we previously
+ * found it contained the tool name.
+ *)
let anon_args = List.rev !anon_args in
+ let anon_args =
+ if ignore_first_anon_arg then List.tl anon_args else anon_args in
(* At this point, either --help was specified on the command line
* (and so the program has exited) or we must have determined tool,
* or the user didn't give us a valid tool (eg. "virt-mem foobar").
* Detect that final case now and give an error.
*)
- let name, _, _, _, run_fn =
+ let name, _, _, _, _, argcheck, beforeksyms, run =
match tool with
| Some t -> t
| None ->
in
if debug then eprintf "tool = %s\n%!" name;
+ (* Optional argument checking in the tool. *)
+ (match argcheck with
+ | None -> ()
+ | Some argcheck -> argcheck debug
+ );
+
(* Get the kernel images. *)
let images =
if images = [] then (
List.map (
fun (dom, _) ->
+ let id = D.get_id dom in
let name = D.get_name dom in
let wordsize =
let mem = MMap.set_wordsize mem wordsize in
let mem = MMap.set_endian mem endian in
- (name, arch, mem)
+ ((Some id, name, arch, mem) : image)
) xmls
) else (
(* One or more -t options passed. *)
let mem = MMap.set_wordsize mem wordsize in
let mem = MMap.set_endian mem endian in
- (filename, arch, mem)
+ ((None, filename, arch, mem) : image)
) images
) in
+ (* Optional callback into the tool before we start looking for
+ * kernel symbols.
+ *)
+ (match beforeksyms with
+ | None -> ()
+ | Some beforeksyms -> beforeksyms debug images
+ );
+
+ (* If there is no run function, then there is no point continuing
+ * with the rest of the program (kernel symbol analysis) ...
+ *)
+ if run = None then exit 0;
+
+ (* Now kernel symbol analysis starts ... *)
let images =
List.map (
- fun (name, arch, mem) ->
+ fun (domid, name, arch, mem) ->
(* Look for some common entries in the exported symbol table and
* from that find the symbol table itself. These are just
* supposed to be symbols which are very likely to be present
lookup_ksym
in
- ((name, arch, mem, lookup_ksym) : image)
+ ((domid, name, arch, mem, lookup_ksym) : image_with_ksyms)
) images in
- (* Run the actual tool. *)
- run_fn debug images
+ (* Run the tool's main function. *)
+ (match run with
+ | None -> ()
+ | Some run ->
+ run debug images
+ )
--- /dev/null
+(* Memory info command for virtual domains.
+ (C) Copyright 2008 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.
+
+ Implements 'virt-mem capture' command.
+ *)
+
+open Printf
+open ExtString
+
+open Virt_mem_gettext.Gettext
+
+(* This will contain what is passed by the user as '-o' option. *)
+let output_filename = ref ""
+
+(* Early argument check. *)
+let argcheck debug =
+ (* -o flag must have been specified. *)
+ let output_filename = !output_filename in
+ if output_filename = "" then (
+ prerr_endline (s_"virt-mem capture: '-o memoryimage' option is required");
+ exit 1
+ )
+
+(* Capture the images before kernel symbol analysis is attempted.
+ * Just save them to the output file(s).
+ *)
+let rec beforeksyms debug = function
+ | [] ->
+ prerr_endline
+ (s_"virt-mem capture: warning: no kernel images were captured")
+ | [image] ->
+ (* Single image is saved to output_filename. *)
+ save_image image !output_filename
+ | images ->
+ (* Multiple images are saved to output_filename.ID where ID
+ * is the domain ID (if known) or a mangled domain name.
+ *)
+ List.iter (
+ fun ((domid, domname, _, _) as image) ->
+ let filename =
+ !output_filename ^ "." ^
+ match domid with
+ | Some id -> string_of_int id
+ | None ->
+ let f = function
+ | ('a'..'z'|'A'..'Z'|'0'..'9'|'_' as c) -> String.make 1 c
+ | _ -> ""
+ in
+ String.replace_chars f domname in
+ save_image image filename
+ ) images
+
+and save_image (_, domname, arch, mmap) filename =
+ printf (f_"virt-mem capture: saving kernel image from %s to filename %s\n")
+ domname filename;
+
+ assert false
+
+let summary = s_"capture memory image for post-mortem analysis"
+let description = s_"Capture a memory image to a file for later post-mortem
+analysis. Use the '-o memoryimage' option to specify the
+output file.
+
+Other tools can load the memory image using the '-t' option."
+
+let extra_args = [
+ "-o", Arg.Set_string output_filename,
+ "memoryimage " ^s_"Set output filename"
+]
+
+let () =
+ Virt_mem.register
+ ~external_cmd:false ~extra_args
+ ~argcheck ~beforeksyms
+ "capture" summary description
git.annexia.org / virt-mem.git / commitdiff