From e557cd7d08fb8f5d6ddf4afedb5447c1e8ce23bf Mon Sep 17 00:00:00 2001 From: james Date: Sat, 24 Oct 2026 12:09:35 +0100 Subject: [PATCH] feat(cli): expose capture replay and watch commands with regression checks --- bin/dune | 4 + bin/main.ml | 309 ++++++++++++++++++++++++++++++++++++++++++++++++++ test/check.ml | 273 ++++++++++++++++++++++++++++++++++++++++++++ test/cli.py | 75 ++++++++++++ test/dune | 8 ++ 5 files changed, 669 insertions(+) create mode 100644 bin/dune create mode 100644 bin/main.ml create mode 100644 test/check.ml create mode 100644 test/cli.py create mode 100644 test/dune diff --git a/bin/dune b/bin/dune new file mode 100644 index 0000000000000000000000000000000000000000..aead6b3b673e727464521c2d944dce242e633eb4 --- /dev/null +++ b/bin/dune @@ -0,0 +1,4 @@ +(executable + (name main) + (public_name scope) + (libraries scope unix)) diff --git a/bin/main.ml b/bin/main.ml new file mode 100644 index 0000000000000000000000000000000000000000..ecaf731d181fcfe4cb81b1f54b929630c37a9595 --- /dev/null +++ b/bin/main.ml @@ -0,0 +1,309 @@ +open Scope +open Model + +exception Usage of string +exception Interrupted of int + +let usage = "scope 0.1.0\n\n\ + scope info CAPTURE\n\ + scope walk CAPTURE ADDRESS\n\ + scope explain CAPTURE ADDRESS --access read|write|execute --privilege supervisor|user\n\ + scope mappings CAPTURE\n\ + scope aliases CAPTURE\n\ + scope diff BEFORE AFTER [--include-ad]\n\ + scope capture DOMAIN OUTPUT --vcpu N --phys-bits N --nx on|off --gb-pages on|off [--pause]\n\ + scope watch DOMAIN DIRECTORY --vcpu N --phys-bits N --nx on|off --gb-pages on|off [--pause]\n\ + scope import TRANSCRIPT OUTPUT\n\ + scope demo DIRECTORY\n\n\ +addresses are unsigned decimal or 0x-prefixed hexadecimal\n\ +exit status: 0 success, 1 fault or findings, 2 incomplete or operational failure, 64 usage\n" + +type options = { + mutable json : bool; + mutable root : int64 option; + mutable max_entries : int; + mutable max_pages : int; + mutable max_pairs : int; + mutable include_ad : bool; + mutable access : access option; + mutable privilege : privilege option; + mutable ac : bool option; + mutable vcpu : int option; + mutable phys_bits : int option; + mutable nx : bool option; + mutable gb_pages : bool option; + mutable pause : bool; + mutable first : int64 option; + mutable last : int64 option; + mutable source : string; + mutable interval : float; + mutable count : int; + mutable retain : int; + mutable scan_aliases : bool; +} + +let boolean = function "on" -> true | "off" -> false | _ -> raise (Usage "expected on or off") +let required name = function Some value -> value | None -> raise (Usage ("missing " ^ name)) + +let parse () = + let options = { json = false; root = None; max_entries = 2_000_000; max_pages = 65536; + max_pairs = 100_000; include_ad = false; access = None; privilege = None; ac = None; + vcpu = None; phys_bits = None; nx = None; gb_pages = None; pause = false; + first = None; last = None; source = "offline import"; + interval = 2.; count = 0; retain = 32; scan_aliases = false } in + let positional = ref [] in + let seen = Hashtbl.create 16 in + let wrap flag action = fun value -> + if Hashtbl.mem seen flag then raise (Usage ("duplicate option " ^ flag)); + Hashtbl.add seen flag (); + action value + in + let specs = [ + "--interval", Arg.Float (wrap "--interval" (fun n -> options.interval <- n)), "SECONDS delay after each watch sample"; + "--count", Arg.Int (wrap "--count" (fun n -> options.count <- n)), "N watch samples, zero means until interrupted"; + "--retain", Arg.Int (wrap "--retain" (fun n -> options.retain <- n)), "N evidence pairs to retain"; + "--aliases", Arg.Unit (wrap "--aliases" (fun () -> options.scan_aliases <- true)), " scan writable/executable aliases while watching"; + "--json", Arg.Unit (wrap "--json" (fun () -> options.json <- true)), " emit scope.report.v1 json"; + "--root", Arg.String (wrap "--root" (fun s -> options.root <- Some (Address.parse s))), "ADDRESS select root while preserving captured cr3"; + "--max-entries", Arg.Int (wrap "--max-entries" (fun n -> options.max_entries <- n)), "N traversal budget"; + "--max-pages", Arg.Int (wrap "--max-pages" (fun n -> options.max_pages <- n)), "N capture page budget"; + "--max-pairs", Arg.Int (wrap "--max-pairs" (fun n -> options.max_pairs <- n)), "N alias output budget"; + "--include-ad", Arg.Unit (wrap "--include-ad" (fun () -> options.include_ad <- true)), " include accessed and dirty changes"; + "--access", Arg.Symbol (["read"; "write"; "execute"], wrap "--access" (fun s -> + options.access <- Some (match s with "read" -> Read | "write" -> Write | _ -> Execute))), " requested access"; + "--privilege", Arg.Symbol (["supervisor"; "user"], wrap "--privilege" (fun s -> + options.privilege <- Some (if s = "user" then User else Supervisor))), " access privilege"; + "--ac", Arg.String (wrap "--ac" (fun s -> options.ac <- Some (boolean s))), "on|off override captured ac for explicit data accesses"; + "--vcpu", Arg.Int (wrap "--vcpu" (fun n -> options.vcpu <- Some n)), "N vcpu to capture"; + "--phys-bits", Arg.Int (wrap "--phys-bits" (fun n -> options.phys_bits <- Some n)), "N guest maxphyaddr"; + "--nx", Arg.String (wrap "--nx" (fun s -> options.nx <- Some (boolean s))), "on|off guest nx capability"; + "--gb-pages", Arg.String (wrap "--gb-pages" (fun s -> options.gb_pages <- Some (boolean s))), "on|off guest 1 gib page capability"; + "--pause", Arg.Unit (wrap "--pause" (fun () -> options.pause <- true)), " hold a controller pause during capture"; + "--start", Arg.String (wrap "--start" (fun s -> options.first <- Some (Address.parse s))), "ADDRESS select overlapping regions"; + "--end", Arg.String (wrap "--end" (fun s -> options.last <- Some (Address.parse s))), "ADDRESS inclusive range end"; + "--source", Arg.String (wrap "--source" (fun s -> options.source <- s)), "TEXT import provenance"; + ] in + Arg.parse_argv Sys.argv specs (fun value -> positional := value :: !positional) usage; + if options.max_entries < 1 || options.max_pages < 1 || options.max_pairs < 1 then raise (Usage "budgets must be positive"); + if not (Float.is_finite options.interval) || options.interval <= 0. || options.count < 0 || options.retain < 1 then + raise (Usage "watch interval and retention must be positive; count must be nonnegative"); + (match options.first, options.last with Some a, Some b when Address.compare a b > 0 -> + raise (Usage "range start exceeds range end") | _ -> ()); + options, List.rev !positional, seen + +let selected options (region : Paging.region) = + (match options.first with None -> true | Some first -> Address.compare (Paging.last region) first >= 0) && + (match options.last with None -> true | Some last -> Address.compare region.start last <= 0) + +let complete regions = List.for_all (fun (region : Paging.region) -> + match region.state with Paging.Unknown _ -> false | _ -> true) regions + +let invalid regions = List.exists (fun (region : Paging.region) -> + match region.state with Paging.Broken _ -> true | _ -> false) regions + +let run options positional seen = + let command = match positional with command :: _ -> command | [] -> raise (Usage usage) in + let allowed = ["--json"] @ (match command with + | "info" -> [] + | "walk" -> ["--root"] + | "explain" -> ["--root"; "--access"; "--privilege"; "--ac"] + | "mappings" -> ["--root"; "--max-entries"; "--start"; "--end"] + | "aliases" -> ["--root"; "--max-entries"; "--max-pairs"; "--start"; "--end"] + | "diff" -> ["--root"; "--max-entries"; "--start"; "--end"; "--include-ad"] + | "capture" -> ["--root"; "--max-pages"; "--vcpu"; "--phys-bits"; "--nx"; "--gb-pages"; "--pause"] + | "watch" -> ["--root"; "--max-pages"; "--max-entries"; "--max-pairs"; "--vcpu"; "--phys-bits"; + "--nx"; "--gb-pages"; "--pause"; "--interval"; "--count"; "--retain"; "--aliases"; + "--include-ad"; "--start"; "--end"] + | "import" -> ["--source"] + | "demo" -> [] + | _ -> raise (Usage ("unknown command: " ^ command))) in + Hashtbl.iter (fun flag () -> if not (List.mem flag allowed) then raise (Usage (flag ^ " does not apply to " ^ command))) seen; + let load path = + let capture = Capture.load path in + match options.root with None -> capture | Some root -> Capture.with_root capture root + in + let enumerate capture = Paging.enumerate ~max_entries:options.max_entries (Capture.context capture) (Capture.read capture) in + let output_context capture = if not options.json then Report.print_context (Capture.context capture) in + let emit capture complete fields = Json.print (Report.envelope command (Capture.context capture) complete fields) in + match positional with + | ["watch"; domain; directory] -> + let domid = try int_of_string domain with Failure _ -> raise (Usage "invalid domain id") in + let vcpu = required "--vcpu" options.vcpu in + let features = { phys_bits = required "--phys-bits" options.phys_bits; + nx = required "--nx" options.nx; gb_pages = required "--gb-pages" options.gb_pages } in + let capture () = Xen.capture ~domid ~vcpu ~pause:options.pause ~features ~root:options.root ~max_pages:options.max_pages in + let emit (event : Watch.event) = + let context = Capture.context event.after in + if options.json then Json.print (Report.envelope "watch" context event.complete [ + "event", Json.String event.kind; "sample", Json.Int event.sample; + "time", Json.String (Printf.sprintf "%.6f" event.time); + "evidence", (if event.directory = "" then Json.Null else Json.String event.directory); + "summary", Json.Object ["mappings", Json.Int event.mappings; "mapped_virtual_bytes", Json.hex event.bytes; + "executable", Json.Int event.executable; "writable", Json.Int event.writable; "huge", Json.Int event.huge]; + "context_changes", Json.List (List.map Json.string event.context_changes); + "changes", Json.List (List.map Report.change event.changes); + "aliases", Json.List (List.map Report.alias event.aliases)]) + else begin + Printf.printf "time=%.3f sample=%d event=%s root=%s mappings=%d bytes=%s executable=%d writable=%d huge=%d complete=%b\n" + event.time event.sample event.kind (Address.hex (Address.Physical.to_int64 (Model.root context))) + event.mappings (Address.hex event.bytes) event.executable event.writable event.huge event.complete; + List.iter (fun (change : Analysis.change) -> + Printf.printf " %s length=%s changes=%s\n" (Address.hex change.start) (Address.hex change.length) + (String.concat "," change.kinds); + List.iter (fun (label, state) -> match state with + | Some (Paging.Present m) -> Printf.printf " %s physical=%s page_size=%s %s\n" + label (Address.hex (Address.Physical.to_int64 m.physical_address)) (Address.hex m.size) (Report.rights m.permissions) + | _ -> ()) ["before", change.before; "after", change.after]) event.changes; + if event.directory <> "" then Printf.printf " evidence=%S aliases=%d context_changes=%s\n" + event.directory (List.length event.aliases) (String.concat "," event.context_changes); + if event.directory <> "" then List.iter (fun (alias : Analysis.alias) -> + Printf.printf " alias physical=%s length=%s writable=%s executable=%s\n" + (Address.hex alias.physical) (Address.hex alias.length) + (Address.hex (Address.Virtual.to_int64 alias.writable.virtual_address)) + (Address.hex (Address.Virtual.to_int64 alias.executable.virtual_address))) event.aliases + end; + flush stdout + in + (try Watch.run ~capture ~wait:Unix.sleepf ~emit ~directory ~interval:options.interval + ~count:options.count ~retain:options.retain ~max_entries:options.max_entries ~max_pairs:options.max_pairs + ~include_ad:options.include_ad ~scan_aliases:options.scan_aliases ~selected:(selected options) () + with Interrupted _ -> 0) + | ["demo"; directory] -> + Demo.write directory; + if options.json then Json.print (Json.Object ["schema", Json.String "scope.report.v1"; + "command", Json.String "demo"; "directory", Json.String directory]) + else Printf.printf "captures=%s/before,%s/after source=synthetic\n" directory directory; + 0 + | ["import"; transcript; destination] -> + let capture = Capture.import ~source:options.source transcript in + let complete = Capture.complete capture in + Capture.save destination capture; + if options.json then emit capture complete ["path", Json.String destination; "pages", Json.Int (Capture.pages capture)] + else Printf.printf "capture=%s pages=%d complete=%b\n" destination (Capture.pages capture) complete; + if complete then 0 else 2 + | ["capture"; domain; destination] -> + let domid = try int_of_string domain with Failure _ -> raise (Usage "invalid domain id") in + let vcpu = required "--vcpu" options.vcpu in + let features = { phys_bits = required "--phys-bits" options.phys_bits; + nx = required "--nx" options.nx; gb_pages = required "--gb-pages" options.gb_pages } in + let capture = Xen.capture ~domid ~vcpu ~pause:options.pause ~features ~root:options.root ~max_pages:options.max_pages in + let complete = Capture.complete capture in + Capture.save destination capture; + output_context capture; + if options.json then emit capture complete ["path", Json.String destination; "pages", Json.Int (Capture.pages capture)] + else Printf.printf "capture=%s pages=%d complete=%b\n" destination (Capture.pages capture) complete; + if complete then 0 else 2 + | ["info"; path] -> + let capture = load path in + let complete = Capture.complete capture in + output_context capture; + if options.json then emit capture complete ["pages", Json.Int (Capture.pages capture); "xen_available", Json.Bool (Xen.available ())] + else Printf.printf "pages=%d complete=%b xen_available=%b\n" (Capture.pages capture) complete (Xen.available ()); + if complete then 0 else 2 + | [("walk" | "explain"); path; address] -> + let capture = load path in + let context = Capture.context capture in + let address = Address.Virtual.of_int64 (Address.parse address) in + let request = if command = "walk" then None else Some { + access = required "--access" options.access; + privilege = required "--privilege" options.privilege; + ac = Option.value options.ac ~default:(Address.bit context.registers.rflags 18) } in + let result = match request with + | None -> Paging.walk context (Capture.read capture) address + | Some request -> Paging.explain context (Capture.read capture) address request + in + let complete = match result.outcome with Incomplete _ -> false | _ -> true in + output_context capture; + if options.json then emit capture complete [ + "address", Json.hex (Address.Virtual.to_int64 address); + "error_code_scope", Json.String (if request = None then "structural_bits_only" else "request"); + "request", Json.option (fun (request : request) -> Json.Object ["access", Json.String (access_name request.access); + "privilege", Json.String (privilege_name request.privilege); "ac", Json.Bool request.ac]) request; + "trace", Json.List (List.map Report.step result.trace); "result", Report.outcome result.outcome] + else begin + if request = None then print_endline "access=unspecified error_code=structural-bits-only"; + Option.iter (fun (request : request) -> Printf.printf "access=%s privilege=%s ac=%b\n" + (access_name request.access) (privilege_name request.privilege) request.ac) request; + Report.print_result result + end; + (match result.outcome with Mapped _ -> 0 | Fault _ -> 1 | Incomplete _ -> 2) + | ["mappings"; path] -> + let capture = load path in + let regions = enumerate capture |> List.filter (selected options) in + let complete = complete regions in + output_context capture; + if options.json then emit capture complete ["regions", Json.List (List.map Report.region regions)] + else List.iter Report.print_region regions; + if not complete then 2 else if invalid regions then 1 else 0 + | ["aliases"; path] -> + let capture = load path in + let regions = enumerate capture |> List.filter (selected options) in + let complete = complete regions in + let aliases = Analysis.aliases ~max_pairs:options.max_pairs regions in + output_context capture; + if options.json then emit capture complete ["aliases", Json.List (List.map Report.alias aliases); + "regions", Json.List (List.filter_map (fun region -> + match region.Paging.state with Paging.Present _ -> None | _ -> Some (Report.region region)) regions)] + else begin + List.iter (fun (alias : Analysis.alias) -> + Printf.printf "physical=%s length=%s writable=%s executable=%s\n" + (Address.hex alias.physical) (Address.hex alias.length) + (Address.hex (Address.Virtual.to_int64 alias.writable.virtual_address)) + (Address.hex (Address.Virtual.to_int64 alias.executable.virtual_address)); + List.iter Report.print_step alias.writable.trace; + List.iter Report.print_step alias.executable.trace) aliases; + List.iter (fun region -> match region.Paging.state with Paging.Present _ -> () | _ -> Report.print_region region) regions + end; + if not complete then 2 else if aliases = [] && not (invalid regions) then 0 else 1 + | ["diff"; before; after] -> + let a = load before and b = load after in + let context_changes = Model.context_changes (Capture.context a) (Capture.context b) in + let ra = enumerate a and rb = enumerate b in + let changes = Analysis.diff ~include_ad:options.include_ad ra rb |> List.filter (fun (c : Analysis.change) -> + selected options { Paging.start = c.start; length = c.length; state = Paging.Unknown "" }) in + let complete = not (List.exists (fun (c : Analysis.change) -> List.mem "incomplete" c.kinds) changes) in + if options.json then emit a complete ["after_context", Report.context (Capture.context b); + "context_changes", Json.List (List.map Json.string context_changes); + "include_ad", Json.Bool options.include_ad; "changes", Json.List (List.map Report.change changes)] + else begin + Report.print_context (Capture.context a); + print_endline "after:"; + Report.print_context (Capture.context b); + Printf.printf "context_changes=%s include_ad=%b\n" (String.concat "," context_changes) options.include_ad; + List.iter (fun (c : Analysis.change) -> + Printf.printf "%s length=%s changes=%s\n" (Address.hex c.start) (Address.hex c.length) (String.concat "," c.kinds); + let print label = function + | None -> Printf.printf " %s absent\n" label + | Some (Paging.Present m) -> Printf.printf " %s physical=%s page_size=%s %s leaf=%s\n" label + (Address.hex (Address.Physical.to_int64 m.physical_address)) (Address.hex m.size) + (Report.rights m.permissions) (Address.hex m.leaf) + | Some (Paging.Unknown reason) -> Printf.printf " %s incomplete=%s\n" label reason + | Some (Paging.Broken reason) -> Printf.printf " %s invalid=%s\n" label reason + in + print "before" c.before; + print "after" c.after) changes + end; + if not complete then 2 else if changes = [] && context_changes = [] then 0 else 1 + | _ -> raise (Usage ("wrong arguments for " ^ command ^ "\n" ^ usage)) + +let () = + Sys.set_signal Sys.sigint (Sys.Signal_handle (fun signal -> raise (Interrupted signal))); + Sys.set_signal Sys.sigterm (Sys.Signal_handle (fun signal -> raise (Interrupted signal))); + let json = Array.exists ((=) "--json") Sys.argv in + let fail code reason = + if json then Json.output stderr (Json.Object ["schema", Json.String "scope.report.v1"; + "error", Json.String reason; "complete", Json.Bool false]) + else Printf.eprintf "scope: %s\n" reason; + if json then output_char stderr '\n'; + exit code + in + try + let options, positional, seen = parse () in + exit (run options positional seen) + with + | Usage reason | Arg.Bad reason -> fail 64 reason + | Arg.Help text -> print_string text; exit 0 + | Invalid_argument reason | Failure reason | Sys_error reason | Model.Limit reason -> fail 2 reason + | Fun.Finally_raised exn -> fail 2 ("cleanup failed: " ^ Printexc.to_string exn) + | Unix.Unix_error (error, operation, path) -> fail 2 (operation ^ " " ^ path ^ ": " ^ Unix.error_message error) + | Interrupted signal -> fail 2 (Printf.sprintf "interrupted by signal %d" signal) diff --git a/test/check.ml b/test/check.ml new file mode 100644 index 0000000000000000000000000000000000000000..b1dfe8553ac7a2b54eef60c9796b1d9387d8faad --- /dev/null +++ b/test/check.ml @@ -0,0 +1,273 @@ +open Scope +open Model + +let count = ref 0 +let check condition message = incr count; if not condition then failwith message +let virtual_address = Address.Virtual.of_int64 +let physical_address = Address.Physical.of_int64 +let supervisor access = { access; privilege = Supervisor; ac = false } +let user access = { access; privilege = User; ac = false } + +let capture ?(context = Demo.context) pages = + Capture.make context (List.map (fun (address, page) -> physical_address address, Ok page) pages) + +let tables ?(upper = 7L) ?(middle = 7L) ?(parent = 7L) ?(leaf = 7L) () = [ + 0x1000L, Demo.page [0, Int64.logor 0x2000L upper]; + 0x2000L, Demo.page [0, Int64.logor 0x3000L middle]; + 0x3000L, Demo.page [0, Int64.logor 0x4000L parent]; + 0x4000L, Demo.page [0, Int64.logor 0x9000L leaf] ] + +let explain capture ?(address = 0L) request = + Paging.explain (Capture.context capture) (Capture.read capture) (virtual_address address) request + +let expect_fault ?level vector code result = match result.outcome with + | Fault f -> + check (f.vector = vector) "fault vector"; + check (f.error_code = code) (Printf.sprintf "error code: expected %x got %x (%s)" code f.error_code f.reason); + Option.iter (fun level -> check (f.level = Some level) "fault level") level + | _ -> failwith "expected fault" + +let expect_mapped result = match result.outcome with + | Mapped m -> check true "mapped"; m + | Fault f -> failwith ("unexpected fault: " ^ f.reason) + | Incomplete reason -> failwith ("unexpected incomplete: " ^ reason) + +let rejects action = + check (try action (); false with Invalid_argument _ | Model.Limit _ -> true) "expected rejection" + +let permissions () = + for upper = 0 to 7 do + for middle = 0 to 7 do + for parent = 0 to 7 do + for leaf = 0 to 7 do + let flags x = Int64.of_int (1 lor ((x land 1) lsl 1) lor ((x land 2) lsl 1)) + |> fun bits -> if x land 4 <> 0 then Int64.logor bits Int64.min_int else bits in + let capture = capture (tables ~upper:(flags upper) ~middle:(flags middle) + ~parent:(flags parent) ~leaf:(flags leaf) ()) in + let mapping = expect_mapped (Paging.walk (Capture.context capture) (Capture.read capture) (virtual_address 0L)) in + check (mapping.permissions.writable = (upper land middle land parent land leaf land 1 <> 0)) "write accumulation"; + check (mapping.permissions.user = (upper land middle land parent land leaf land 2 <> 0)) "user accumulation"; + check (mapping.permissions.executable = ((upper lor middle lor parent lor leaf) land 4 = 0)) "nx accumulation" + done + done + done + done; + let c = capture (tables ~parent:5L ()) in + expect_fault ~level:2 14 3 (explain c (supervisor Write)); + expect_fault ~level:2 14 7 (explain c (user Write)); + let context = { Demo.context with registers = { Demo.context.registers with cr0 = 0x80000001L } } in + ignore (expect_mapped (explain (capture ~context (tables ~parent:5L ())) (supervisor Write))); + expect_fault 14 5 (explain (capture (tables ~upper:3L ())) (user Read)); + expect_fault 14 17 (explain (capture (tables ~parent:0x8000000000000007L ())) (supervisor Execute)); + let context = { Demo.context with registers = { Demo.context.registers with cr4 = 0x100020L } } in + expect_fault 14 17 (explain (capture ~context (tables ())) (supervisor Execute)); + let context = { Demo.context with registers = { Demo.context.registers with cr4 = 0x200020L } } in + let c = capture ~context (tables ()) in + expect_fault 14 1 (explain c (supervisor Read)); + expect_fault 14 3 (explain c (supervisor Write)); + ignore (expect_mapped (explain c { access = Write; privilege = Supervisor; ac = true })); + ignore (expect_mapped (explain c (supervisor Execute))) + +let translation () = + let c = capture (tables ()) in + let m = expect_mapped (explain c ~address:0xabcL (supervisor Read)) in + check (Address.Physical.to_int64 m.physical_address = 0x9abcL) "4k offset"; + expect_fault 13 0 (explain c ~address:0x0000800000000000L (supervisor Read)); + expect_fault 13 0 (explain c ~address:0xffff7fffffffffffL (supervisor Read)); + let c = capture [0x1000L, Demo.page [511, 0x2007L]; 0x2000L, Demo.page [511, 0x3007L]; + 0x3000L, Demo.page [511, 0x4007L]; 0x4000L, Demo.page [511, 0x9007L]] in + let m = expect_mapped (explain c ~address:(-1L) (supervisor Read)) in + check (Address.Physical.to_int64 m.physical_address = 0x9fffL) "upper canonical address"; + let regions = Paging.enumerate (Capture.context c) (Capture.read c) in + check (List.length regions = 1 && (List.hd regions).start = 0xfffffffffffff000L) "upper enumeration"; + let c = capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x3007L]; + 0x3000L, Demo.page [0, 0x201087L]] in + let m = expect_mapped (explain c ~address:0x1fffffL (supervisor Read)) in + check (m.size = 0x200000L && Address.Physical.to_int64 m.physical_address = 0x3fffffL) "2m pat and offset"; + let c = capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x40001087L]] in + let m = expect_mapped (explain c ~address:0x3fffffffL (supervisor Read)) in + check (m.size = 0x40000000L && Address.Physical.to_int64 m.physical_address = 0x7fffffffL) "1g pat and offset"; + let c = capture (tables ~leaf:0x87L ()) in + ignore (expect_mapped (explain c (supervisor Read))); + let context = { Demo.context with registers = { Demo.context.registers with cr3 = 0x1abcL; cr4 = 0x20020L } } in + ignore (expect_mapped (explain (capture ~context (tables ())) (supervisor Read))) + +let invalid () = + expect_fault ~level:4 14 9 (explain (capture (tables ~upper:0x87L ())) (supervisor Read)); + expect_fault ~level:1 14 9 (explain (capture (tables ~leaf:0x1000000000007L ())) (supervisor Read)); + let context = { Demo.context with registers = { Demo.context.registers with efer = 0x500L } } in + expect_fault 14 9 (explain (capture ~context (tables ~leaf:0x8000000000000007L ())) (supervisor Read)); + let context = { Demo.context with features = { Demo.context.features with gb_pages = false } } in + let c = capture ~context [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x87L]] in + expect_fault 14 9 (explain c (supervisor Read)); + let c = capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x3007L]; 0x3000L, Demo.page [0, 0x2087L]] in + expect_fault 14 9 (explain c (supervisor Read)); + let c = capture (tables ~parent:0L ()) in + expect_fault ~level:2 14 0 (explain c (supervisor Read)); + let c = capture (tables ~parent:0L ~upper:1L ()) in + expect_fault ~level:2 14 6 (explain c (user Write)); + List.iter (fun bit -> rejects (fun () -> + Model.validate { Demo.context with registers = { Demo.context.registers with cr4 = Int64.logor 0x20L (Int64.shift_left 1L bit) } })) [12; 22; 23; 24]; + let context = { Demo.context with registers = { Demo.context.registers with cr3 = 0x1abcL } } in + ignore (expect_mapped (explain (capture ~context (tables ())) (supervisor Read))); + rejects (fun () -> ignore (Address.parse "-1")); + rejects (fun () -> ignore (Address.parse "18446744073709551616")); + check (Address.parse "18446744073709551615" = -1L) "unsigned decimal parsing" + +let incomplete () = + let c = capture [0x1000L, Demo.page [0, 0x2007L]] in + check (match (explain c (supervisor Read)).outcome with Incomplete _ -> true | _ -> false) "missing table is incomplete"; + let regions = Paging.enumerate (Capture.context c) (Capture.read c) in + check (List.length regions = 1 && (List.hd regions).length = 0x8000000000L) "missing subtree range"; + let c = Capture.make Demo.context [] in + let regions = Paging.enumerate Demo.context (Capture.read c) in + check (List.length regions = 2) "missing root covers both canonical halves"; + let c = Demo.capture ~after:false in + rejects (fun () -> ignore (Paging.enumerate ~max_entries:1 Demo.context (Capture.read c))); + rejects (fun () -> ignore (Capture.collect ~max_pages:1 Demo.context (Capture.read c))); + let reads = ref 0 in + let collected = Capture.collect Demo.context (fun address -> incr reads; Capture.read c address) in + check (!reads = 5 && Capture.pages collected = 5) "capture memoises table frames" + +let regions capture = Paging.enumerate (Capture.context capture) (Capture.read capture) + +let diff () = + let a = Demo.capture ~after:false and b = Demo.capture ~after:true in + let changes = Analysis.diff (regions a) (regions b) in + check (List.length changes = 2) "demo diff count"; + check ((List.hd changes).kinds = ["permissions"]) "parent permission diff"; + check ((List.nth changes 1).kinds = ["backing"]) "backing diff"; + check (Analysis.diff (regions a) (regions a) = []) "identity diff"; + let a = capture (tables ()) in + let b = capture (tables ~leaf:0x67L ()) in + check (Analysis.diff (regions a) (regions b) = []) "ignore ad by default"; + check ((List.hd (Analysis.diff ~include_ad:true (regions a) (regions b))).kinds = ["accessed_dirty"]) "include ad"; + let huge = capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x3007L]; 0x3000L, Demo.page [0, 0x87L]] in + let small = capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x3007L]; + 0x3000L, Demo.page [0, 0x4007L]; 0x4000L, Demo.page (List.init 512 (fun index -> index, Int64.logor 7L (Int64.of_int (index * 4096))))] in + let changes = Analysis.diff (regions huge) (regions small) in + check (List.length changes = 512 && List.for_all (fun (c : Analysis.change) -> c.kinds = ["page_size"]) changes) "huge split preserves backing"; + let partial = Capture.make Demo.context [] in + let changes = Analysis.diff (regions partial) (regions a) in + check (List.for_all (fun (c : Analysis.change) -> c.kinds = ["incomplete"]) changes) "incomplete is not removal" + +let aliases () = + let pairs = Analysis.aliases (regions (Demo.capture ~after:false)) in + check (List.length pairs = 1) "demo alias"; + let pair = List.hd pairs in + check (pair.physical = 0x9000L && pair.length = 4096L) "alias overlap"; + check (Analysis.aliases (regions (Demo.capture ~after:true)) = []) "demo resolved alias"; + let make_mapping va pa size permissions = { + virtual_address = virtual_address va; physical_address = physical_address pa; + size; permissions; leaf = 0L; trace = [] } in + let writable = { unrestricted with executable = false } in + let executable = { unrestricted with writable = false } in + let a = make_mapping 0L 0x200000L 0x200000L executable in + let b = make_mapping 0x800000L 0x201000L 4096L writable in + let pairs = Analysis.aliases [ + { Paging.start = 0L; length = a.size; state = Paging.Present a }; + { Paging.start = 0x800000L; length = b.size; state = Paging.Present b } ] in + check (List.length pairs = 1 && (List.hd pairs).physical = 0x201000L && (List.hd pairs).length = 4096L) "partial huge alias" + +let codec () = + let path = Filename.temp_file "scope" ".capture" in + Fun.protect ~finally:(fun () -> Sys.remove path) (fun () -> + let original = Demo.capture ~after:false in + Capture.save path original; + let loaded = Capture.load path in + check (Capture.context original = Capture.context loaded) "context roundtrip"; + check (regions original = regions loaded) "table roundtrip"; + let channel = open_out_gen [Open_wronly; Open_binary] 0o600 path in + seek_out channel 32; + output_char channel '\255'; + close_out channel; + rejects (fun () -> ignore (Capture.load path))); + rejects (fun () -> ignore (Capture.make Demo.context [physical_address 0x1000L, Ok "short"])); + rejects (fun () -> ignore (Capture.make Demo.context [physical_address 0x1001L, Ok (Demo.page [])])); + rejects (fun () -> ignore (capture [0x1000L, Demo.page []; 0x1000L, Demo.page []])) + +let generated () = + let random = Random.State.make [|0x5c0; 0x2026|] in + let generate () = + let entries = List.init 64 (fun index -> + let frame = Random.State.int random 16 in + let flags = Int64.of_int (1 lor (Random.State.int random 4 lsl 1)) in + let flags = if Random.State.bool random then Int64.logor flags Int64.min_int else flags in + index, if Random.State.int random 4 = 0 then 0L else Int64.logor (Int64.of_int (frame * 4096)) flags) in + capture [0x1000L, Demo.page [0, 0x2007L]; 0x2000L, Demo.page [0, 0x3007L]; + 0x3000L, Demo.page [0, 0x4007L]; 0x4000L, Demo.page entries] + in + for _ = 1 to 64 do + let a = generate () and b = generate () in + let changes = Analysis.diff (regions a) (regions b) in + for index = 0 to 63 do + let address = Int64.of_int (index * 4096) in + let state capture = match (explain capture ~address (supervisor Read)).outcome with + | Mapped m -> Some (Paging.Present m) + | Fault _ -> None + | Incomplete _ -> failwith "generated graph unexpectedly incomplete" + in + let expected = Analysis.differences ~include_ad:false (state a) (state b) in + let observed = List.find_opt (fun (c : Analysis.change) -> + Address.compare address c.start >= 0 && Address.compare address (Int64.pred (Int64.add c.start c.length)) <= 0) changes + |> Option.map (fun (c : Analysis.change) -> c.kinds) |> Option.value ~default:[] in + check (expected = observed) "interval diff agrees with point translations" + done; + let mappings = regions a |> List.filter_map (fun r -> match r.Paging.state with Paging.Present m -> Some m | _ -> None) in + let physical m = Address.Physical.to_int64 m.physical_address in + let virtual_raw m = Address.Virtual.to_int64 m.virtual_address in + let expected = List.concat_map (fun w -> List.filter_map (fun x -> + if w.permissions.writable && x.permissions.executable && virtual_raw w <> virtual_raw x && physical w = physical x then + Some (physical w, 4096L, virtual_raw w, virtual_raw x) else None) mappings) mappings |> List.sort compare in + let actual = Analysis.aliases (regions a) |> List.map (fun (a : Analysis.alias) -> + a.physical, a.length, virtual_raw a.writable, virtual_raw a.executable) |> List.sort compare in + check (expected = actual) "alias sweep agrees with pairwise overlap oracle" + done; + let self = capture [0x1000L, Demo.page [0, 0x1007L]] in + let reads = ref 0 in + let closed = Capture.collect Demo.context (fun address -> incr reads; Capture.read self address) in + check (!reads = 1 && Capture.pages closed = 1) "recursive mapping is read once across levels"; + ignore (expect_mapped (explain closed (supervisor Read))); + let context = { Demo.context with registers = { Demo.context.registers with cr3 = 0x1000L } } in + let exploding = capture ~context [0x1000L, Demo.page (List.init 512 (fun index -> index, 0x1007L))] in + rejects (fun () -> ignore (Paging.enumerate ~max_entries:4096 context (Capture.read exploding))) + +let watch () = + let base = Filename.temp_file "scopewatch" "" in + Sys.remove base; + let a = Demo.capture ~after:false and b = Demo.capture ~after:true in + let switched = capture ~context:{ Demo.context with registers = { Demo.context.registers with cr3 = 0x6000L } } + ((0x6000L, Demo.page [0, 0x2007L]) :: Demo.frames ~after:true) in + let samples = ref [a; b; b; Capture.make Demo.context []; b; switched] in + let events = ref [] in + let capture () = match !samples with x :: xs -> samples := xs; x | [] -> failwith "sample exhaustion" in + let status = Watch.run ~capture ~wait:(fun _ -> ()) ~emit:(fun event -> events := event :: !events) + ~directory:base ~interval:0.1 ~count:6 ~retain:2 ~max_entries:10000 ~max_pairs:100 + ~include_ad:false ~scan_aliases:true ~selected:(fun _ -> true) () in + check (status = 2) "watch remembers incomplete samples"; + let events = List.rev !events in + check (List.map (fun (e : Watch.event) -> e.kind) events = + ["baseline"; "change"; "sample"; "incomplete"; "sample"; "address_space"]) "watch transitions"; + check (List.length (List.nth events 1).changes = 2) "watch semantic changes"; + check ((List.hd events).mappings = 2 && (List.hd events).bytes = 8192L) "watch statistics"; + check (List.length (List.hd events).aliases = 1) "watch alias baseline"; + check (Array.length (Sys.readdir base) = 2) "watch bounded retention"; + let pair = Filename.concat base "00000006" in + check (Capture.context (Capture.load (Filename.concat pair "before")) = Capture.context b) "watch preserves last complete baseline"; + check ((List.nth events 5).changes = []) "watch does not diff unrelated roots"; + Array.iter (fun name -> let path = Filename.concat base name in + Array.iter (fun child -> Sys.remove (Filename.concat path child)) (Sys.readdir path); + Unix.rmdir path) (Sys.readdir base); + Unix.rmdir base + +let () = + permissions (); + translation (); + invalid (); + incomplete (); + diff (); + aliases (); + codec (); + generated (); + watch (); + Printf.printf "%d checks passed\n" !count diff --git a/test/cli.py b/test/cli.py new file mode 100644 index 0000000000000000000000000000000000000000..e228c66271f0baa6f5b83f5f93d636d9b2ac0706 --- /dev/null +++ b/test/cli.py @@ -0,0 +1,75 @@ +import json +from pathlib import Path +import subprocess +import sys +import tempfile + + +executable = str(Path(sys.argv[1]).resolve()) +checks = 0 + + +def run(*args, status=0, structured=True): + global checks + command = [executable, *map(str, args)] + if structured: + command.append("--json") + result = subprocess.run(command, capture_output=True, text=True, timeout=10) + assert result.returncode == status, (command, result.returncode, result.stdout, result.stderr) + checks += 1 + if structured: + value = json.loads(result.stdout if result.stdout else result.stderr) + assert value["schema"] == "scope.report.v1" + return value + return result.stdout + + +with tempfile.TemporaryDirectory(prefix="scope") as directory: + root = Path(directory) + run("demo", root) + before, after = root / "before", root / "after" + assert run("info", before)["pages"] == 5 + result = run("walk", before, "0x400abc") + assert result["result"]["mapping"]["physical"] == "0x0000000000009abc" + result = run("explain", before, "0x400000", "--access", "write", "--privilege", "supervisor", status=1) + assert result["result"]["fault"]["level"] == 2 + assert result["result"]["fault"]["error_code"] == 3 + assert len(run("aliases", before, status=1)["aliases"]) == 1 + assert run("aliases", after)["aliases"] == [] + assert len(run("diff", before, after, status=1)["changes"]) == 2 + assert run("diff", before, before)["changes"] == [] + assert len(run("mappings", before, "--start", "0x800000")["regions"]) == 1 + assert run("walk", before, "0x800000000000", status=1)["result"]["fault"]["vector"] == 13 + overridden = run("walk", before, "0x400000", "--root", "0x6000", status=2) + assert overridden["complete"] is False + assert overridden["context"]["registers"]["cr3"] == "0x0000000000001000" + assert overridden["context"]["root"] == "0x0000000000006000" + run("explain", before, "0x400000", status=64) + run("walk", before, "0x400000", "--include-ad", status=64) + run("walk", before, "0x400000", "--root", "0x1000", "--root", "0x2000", status=64) + run("mappings", before, "--max-entries", "1", status=2) + run("capture", "0", root / "capture", "--vcpu", "0", "--phys-bits", "48", "--nx", "on", "--gb-pages", "on", status=2) + run("walk", before, "-1", status=64) + run("unknown", status=64) + run("watch", "7", root / "history", "--interval", "nan", status=64) + run("watch", "7", root / "history", "--retain", "0", status=64) + run("walk", before, "0x400000", "--count", "2", status=64) + run("info", root / "missing", status=2) + text = run("explain", before, "0x400000", "--access", "write", "--privilege", "supervisor", status=1, structured=False) + assert "level=2" in text and "error=0x3" in text + damaged = root / "damaged" + damaged.write_bytes(before.read_bytes()[:-1]) + run("info", damaged, status=2) + transcript = root / "transcript" + transcript.write_text("context 0x80010001 0x0 0x1000 0x20 0xd00 0x2 0x0 48 1 1\nmissing 0x1000 permission denied\n") + run("import", transcript, root / "partial", "--source", 'quote" and newline\n', status=2) + assert run("walk", root / "partial", "0x0", status=2)["result"]["reason"] == "permission denied" + partial = run("diff", before, root / "partial", status=2) + assert all(change["kinds"] == ["incomplete"] for change in partial["changes"]) + page = (0x83).to_bytes(8, "little") + bytes(4088) + transcript.write_text("context 0x80010001 0x0 0x1000 0x20 0xd00 0x2 0x0 48 1 1\npage 0x1000 " + page.hex() + "\n") + run("import", transcript, root / "invalid") + assert run("mappings", root / "invalid", status=1)["regions"][0]["state"]["status"] == "invalid" + assert run("aliases", root / "invalid", status=1)["aliases"] == [] + +print(f"{checks} cli checks passed") diff --git a/test/dune b/test/dune new file mode 100644 index 0000000000000000000000000000000000000000..395c959295522afa9448ac83f640f5ae964e2033 --- /dev/null +++ b/test/dune @@ -0,0 +1,8 @@ +(test + (name check) + (libraries scope unix)) + +(rule + (alias runtest) + (deps cli.py) + (action (run python3 %{dep:cli.py} %{exe:../bin/main.exe})))