X-Git-Url: http://git.annexia.org/?p=virt-mem.git;a=blobdiff_plain;f=lib%2Fvirt_mem.ml;h=0a956f1257b8fd9bb6b45c5726a4f389978428b6;hp=82e0b37e820e7f1a7f389685d0fb92cf46201cf8;hb=89d41f7614612cf991d6005e7c1e20cd502a5404;hpb=5ce06c3326a2672e82dc656b35eb7a3e6616539a diff --git a/lib/virt_mem.ml b/lib/virt_mem.ml index 82e0b37..0a956f1 100644 --- a/lib/virt_mem.ml +++ b/lib/virt_mem.ml @@ -1,4 +1,4 @@ -(* Memory info command for virtual domains. +(* Memory info for virtual domains. (C) Copyright 2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ @@ -20,14 +20,137 @@ open Unix 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 +open Virt_mem_types + +(* 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 *) -(* Main program. *) -let () = - (* Verbose messages. *) - let verbose = ref false in +(* When tools register themselves, they are added to this list. + * Later, we will alphabetize the list. + *) +let tools = ref [] + +(* Registration function used by the 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. + *) +let main () = + (* Get the registered tools, alphabetically. *) + let tools = !tools in + let tools = List.sort ~cmp:(fun (a,_) (b,_) -> compare a b) tools in + + (* Which tool did the user want to run? Look at the executable + * name (eg. 'virt-dmesg' => tool == dmesg). If we don't recognise + * the executable name then we must look for the first parameter + * which doesn't begin with a '-' character. + * + * Note that we must do all of this before using the OCaml Arg + * module to properly parse the command line (below), so that + * we can have a usage message ready. + *) + 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" *) + try Filename.chop_extension prog with Invalid_argument _ -> prog in + let prog = (* eg. "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), false + with Not_found -> + let arg1 = (* First non-option argument. *) + match Array.to_list Sys.argv with + | [] -> None + | _::args -> + let rec loop = function + | [] -> None + | a::args when String.length a > 0 && a.[0] = '-' -> loop args + | a::_ -> Some a + in + loop args in + match arg1 with + | None -> None, false + | Some prog -> (* Recognisable first argument? *) + let prog = + try Filename.chop_extension prog with Invalid_argument _ -> prog in + let prog = + if String.starts_with prog "virt-" then + String.sub prog 5 (String.length prog - 5) + else prog 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, _, 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 = + List.fold_left max 0 (List.map String.length (List.map fst tools)) in + let tools = List.map (fun (l,r) -> pad max_width l, r) tools in + let tools = List.map (fun (l,r) -> " " ^ l ^ " - " ^ r) tools in + let tools = String.concat "\n" tools in + + sprintf (f_"\ + +virt-mem: Tools for providing information about virtual machines + +Currently available tools include: +%s + +General usage is: + [-options] [domains...] + +To display extra help for a single tool, do: + virt-mem help + +Options:") tools + + (* Tool-specific usage message. *) + | Some (name, summary, description, external_cmd, _, _, _, _) -> + let cmd = + if external_cmd then "virt-" ^ name else "virt-mem " ^ name in + + sprintf (f_"\ + +%s: %s + +Description: +%s + +Options:") cmd summary description in + + (* Now begin proper parsing of the command line arguments. *) + let debug = ref false in + let testimages = ref [] in + let uri = ref "" in + let anon_args = ref [] in (* Default wordsize. *) let def_wordsize = ref None in @@ -35,7 +158,7 @@ let () = | "32" -> def_wordsize := Some W32 | "64" -> def_wordsize := Some W64 | "auto" -> def_wordsize := None - | str -> failwith (sprintf "set_wordsize: %s: unknown wordsize" str) + | str -> failwith (sprintf (f_"set_wordsize: %s: unknown wordsize") str) in (* Default endianness. *) @@ -43,10 +166,10 @@ let () = let set_endian = function | "auto" -> def_endian := None | "le" | "little" | "littleendian" | "intel" -> - def_endian := Some Bitmatch.LittleEndian + def_endian := Some Bitstring.LittleEndian | "be" | "big" | "bigendian" | "motorola" -> - def_endian := Some Bitmatch.BigEndian - | str -> failwith (sprintf "set_endian: %s: unknown endianness" str) + def_endian := Some Bitstring.BigEndian + | str -> failwith (sprintf (f_"set_endian: %s: unknown endianness") str) in (* Default architecture. *) @@ -69,50 +192,230 @@ let () = | str -> def_text_addr := Int64.of_string str in - (* List of kernel images. *) - let images = ref [] in - + (* Handle -t option. *) let memory_image filename = - images := + testimages := (!def_wordsize, !def_endian, !def_architecture, !def_text_addr, filename) - :: !images + :: !testimages in - let argspec = Arg.align [ - "-A", Arg.String set_architecture, - "arch " ^ "Set kernel architecture, endianness and word size"; - "-E", Arg.String set_endian, - "endian " ^ "Set kernel endianness"; - "-T", Arg.String set_text_addr, - "addr " ^ "Set kernel text address"; - "-W", Arg.String set_wordsize, - "addr " ^ "Set kernel word size"; - "-t", Arg.String memory_image, - "image " ^ "Use saved kernel memory image"; - "-verbose", Arg.Set verbose, - " " ^ "Verbose messages"; - ] in - - let anon_fun str = - raise (Arg.Bad (sprintf "%s: unknown parameter" str)) in - let usage_msg = "virt-mem: shows memory information for guests + (* Handle --version option. *) + let version () = + printf "virt-mem %s\n" Virt_mem_version.version; -SUMMARY - virt-mem [-options] - -OPTIONS" in + 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 - Arg.parse argspec anon_fun usage_msg; + (* 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 testimages = !testimages 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, _, _, _, _, argcheck, beforeksyms, run = + match tool with + | Some t -> t + | None -> + prerr_endline (s_"\ +virt-mem: I could not work out which tool you are trying to run. +Use 'virt-mem --help' for more help or read the manual page virt-mem(1)"); + exit 1 + in + if debug then eprintf "tool = %s\n%!" name; - let images = !images in - let verbose = !verbose in + (* Optional argument checking in the tool. *) + (match argcheck with + | None -> () + | Some argcheck -> argcheck debug + ); (* Get the kernel images. *) let images = - if images = [] then - (* XXX use libvirt to get images *) - failwith "libvirt: not yet implemented" - else + if testimages = [] 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 id = D.get_id dom in + 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 = Virt_mem_mmap.of_string str !def_text_addr in + + (* Force the wordsize and endianness. *) + let mem = Virt_mem_mmap.set_wordsize mem wordsize in + let mem = Virt_mem_mmap.set_endian mem endian in + + ((Some id, name, arch, mem) : image0) + ) 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 @@ -123,14 +426,14 @@ OPTIONS" in match wordsize with | None -> failwith - (sprintf "%s: use -W to define word size for this image" + (sprintf (f_"%s: use -W to define word size for this image") filename); | Some ws -> ws in let endian = match endian with | None -> failwith - (sprintf "%s: use -E to define endianness for this image" + (sprintf (f_"%s: use -E to define endianness for this image") filename); | Some e -> e in @@ -139,174 +442,73 @@ OPTIONS" in | Some I386 -> I386 | Some X86_64 -> X86_64 | _ -> failwith - (sprintf "%s: use -A to define architecture (i386/x86-64 only) for this image" filename) in + (sprintf (f_"%s: use -A to define architecture (i386/x86-64 only) for this image") filename) in if text_addr = 0L then failwith - (sprintf "%s: use -T to define kernel load address for this image" + (sprintf (f_"%s: use -T to define kernel load address for this image") filename); (* Map the virtual memory. *) let fd = openfile filename [O_RDONLY] 0 in - let mem = MMap.of_file fd text_addr in + let mem = Virt_mem_mmap.of_file fd text_addr in (* Force the wordsize and endianness. *) - let mem = MMap.set_wordsize mem wordsize in - let mem = MMap.set_endian mem endian in - - (filename, (arch, mem)) - ) images in - - List.iter ( - fun (name, (arch, mem)) -> - (* Look for some common entries in the symbol table and from - * that find the symbol table itself. These are just supposed to - * be symbols which are very likely to be present in any Linux - * kernel, although we only need one of them to be present to - * find the symbol table. - * - * NB. Must not be __initdata. - *) - let common_ksyms = [ - "init_task"; (* first task_struct *) - "root_mountflags"; (* flags for mounting root fs *) - "init_uts_ns"; (* uname strings *) - "sys_open"; (* open(2) entry point *) - "sys_chdir"; (* chdir(2) entry point *) - "sys_chroot"; (* chroot(2) entry point *) - "sys_umask"; (* umask(2) entry point *) - "schedule"; (* scheduler entry point *) - ] in - (* Searching for string *) - let common_ksyms = List.map (sprintf "\000%s\000") common_ksyms in - - (* Search for these strings in the memory image. *) - let ksym_strings = List.map (MMap.find_all mem) common_ksyms in - let ksym_strings = List.concat ksym_strings in - (* Adjust found addresses to start of the string (skip ). *) - let ksym_strings = List.map Int64.succ ksym_strings in - - (* For any we found, try to look up the symbol table - * base addr and size. - *) - let ksymtabs = List.map ( - fun addr -> - (* Search for 'addr' appearing in the image. *) - let addrs = MMap.find_pointer_all mem addr in - - (* Now consider each of these addresses and search back - * until we reach the beginning of the (possible) symbol - * table. - * - * Kernel symbol table struct is: - * struct kernel_symbol { - * unsigned long value; - * const char *name; <-- initial pointer - * } symbols[]; - *) - let pred_long2 addr = MMap.pred_long mem (MMap.pred_long mem addr) in - let base_addrs = List.map ( - fun addr -> - let rec loop addr = - (* '*addr' should point to a C identifier. If it does, - * step backwards to the previous symbol table entry. - *) - let addrp = MMap.follow_pointer mem addr in - if MMap.is_C_identifier mem addrp then - loop (pred_long2 addr) - else - MMap.succ_long mem addr - in - loop addr - ) addrs in - - (* Also look for the end of the symbol table and - * calculate its size. - *) - let base_addrs_sizes = List.map ( - fun base_addr -> - let rec loop addr = - let addr2 = MMap.succ_long mem addr in - let addr2p = MMap.follow_pointer mem addr2 in - if MMap.is_C_identifier mem addr2p then - loop (MMap.succ_long mem addr2) - else - addr - in - let end_addr = loop base_addr in - base_addr, end_addr -^ base_addr - ) base_addrs in - - base_addrs_sizes - ) ksym_strings in - let ksymtabs = List.concat ksymtabs in - - (* Simply ignore any symbol table candidates which are too small. *) - let ksymtabs = List.filter (fun (_, size) -> size > 64L) ksymtabs in - - if verbose then ( - printf "name %s:\n" name; - List.iter ( - fun (addr, size) -> - printf "\t%Lx\t%Lx\t%!" addr size; - printf "first symbol: %s\n%!" - (MMap.get_string mem - (MMap.follow_pointer mem - (MMap.succ_long mem addr))) - ) ksymtabs - ); - - (* Vote for the most popular symbol table candidate. *) - let freqs = frequency ksymtabs in - match freqs with - | [] -> - eprintf "%s: cannot find start of kernel symbol table\n" name - | (_, (ksymtab_addr, ksymtab_size)) :: _ -> - if verbose then - printf "%s: Kernel symbol table found at %Lx, size %Lx bytes\n%!" - name ksymtab_addr ksymtab_size; - - (* Load the whole symbol table as a bitstring. *) - let ksymtab = - Bitmatch.bitstring_of_string - (MMap.get_bytes mem ksymtab_addr (Int64.to_int ksymtab_size)) in - - (* Function to look up an address in the symbol table. *) - let lookup_ksym sym = - let bits = bits_of_wordsize (MMap.get_wordsize mem) in - let e = MMap.get_endian mem in - let rec loop bs = - bitmatch bs with - | { value : bits : endian(e); - name_ptr : bits : endian(e) } - when MMap.get_string mem name_ptr = sym -> - value - | { _ : bits : endian(e); - _ : bits : endian(e); - bs : -1 : bitstring } -> - loop bs - | { _ } -> raise Not_found + let mem = Virt_mem_mmap.set_wordsize mem wordsize in + let mem = Virt_mem_mmap.set_endian mem endian in + + ((None, filename, arch, mem) : image0) + ) testimages + ) 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; + + (* Do the kernel symbol analysis. *) + let images = + List.map ( + fun image -> + + (* Look for ordinary kernel symbols: *) + let image = Virt_mem_ksyms.find_kernel_symbols debug image in + (* Look for kallsyms: *) + let image = Virt_mem_kallsyms.find_kallsyms debug image in + + (* Finally, just wrap the lookup_ksym call in something + * which prints the query when debug is set. + *) + let image = + if debug then + let (domid, name, arch, mem, lookup_ksym) = image in + let lookup_ksym sym = + try + let value = lookup_ksym sym in + eprintf "lookup_ksym %S = %Lx\n%!" sym value; + value + with Not_found -> + eprintf "lookup_ksym %S failed\n%!" sym; + raise Not_found in - loop ksymtab - in - - if verbose then ( - (* This just tests looking up kernel symbols. *) - printf "init_task = %Lx\n" (lookup_ksym "init_task"); - printf "schedule = %Lx\n" (lookup_ksym "schedule"); - printf "system_utsname = %s\n" - (try - let addr = lookup_ksym "system_utsname" in - sprintf "%Lx" addr - with Not_found -> "not found"); - printf "init_uts_ns = %s\n" - (try - let addr = lookup_ksym "init_uts_ns" in - sprintf "%Lx" addr - with Not_found -> "not found"); - ); - - - - - ) images + (domid, name, arch, mem, lookup_ksym) + else + image in + + image + ) images in + + (* Run the tool's main function. *) + (match run with + | None -> () + | Some run -> + run debug images + )