Add use-trace-processor-shell flag to automate large trace processing

src/dune

@@ -15,7 +15,7 @@
  (foreign_stubs
  (language c)
  (names breakpoint_stubs boot_time_stubs ptrace_stubs))
- (libraries core async core_unix.filename_unix fzf re shell
+ (libraries core async async_shell core_unix.filename_unix fzf re shell
  core_unix.sys_unix cohttp cohttp_static_handler core_unix.signal_unix
  tracing magic_trace magic_trace_core)
  (inline_tests)

src/trace.ml

@@ -561,6 +561,32 @@ module Make_commands (Backend : Backend_intf.S) = struct
  { Decode_opts.output_config; decode_opts; print_events }
  ;;
 
+ let open_url_flags =
+ let open Command.Param in
+ flag
+ "open-url"
+ (optional string)
+ ~doc:
+ "opens a url to display trace. options are local, magic, or android to open \
+ http://localhost:10000, https://magic-trace.org, or https://ui.perfetto.dev \
+ respectively"
+ |> map ~f:(fun user_input ->
+ Option.map user_input ~f:(fun user_choice ->
+ match user_choice with
+ | "local" -> "http://localhost:10000"
+ | "magic" -> "https://magic-trace.org"
+ | "android" -> "https://ui.perfetto.dev"
+ | _ -> raise_s [%message "unkown user input" (user_choice : string)]))
+ ;;
+
+ let use_processor_flag =
+ let open Command.Param in
+ flag
+ "use-processor-exe"
+ (optional string)
+ ~doc:"path for standalone processor exe to use to process trace file"
+ ;;
+
  let run_command =
  Command.async_or_error
  ~summary:"Runs a command and traces it."
@@ -573,11 +599,16 @@ module Make_commands (Backend : Backend_intf.S) = struct
  magic-trace run -multi-thread ./program -- arg1 arg2\n\n\
  # Run a process, tracing its entire execution (only practical for short-lived \
  processes)\n\
- magic-trace run -full-execution ./program\n")
+ magic-trace run -full-execution ./program\n\
+ # Run a process that generates a large trace file, and view it on \
+ magic-trace.org magic-trace run ./program -open-url magic -use-processor-exe \
+ ~/local-trace-processor\n")
  (let%map_open.Command record_opt_fn = record_flags
  and decode_opts = decode_flags
  and debug_print_perf_commands = debug_print_perf_commands
  and prog = anon ("COMMAND" %: string)
+ and trace_processor_exe = use_processor_flag
+ and url = open_url_flags
  and argv =
  flag "--" escape ~doc:"ARGS Arguments for the command. Ignored by magic-trace."
  in
@@ -589,31 +620,53 @@ module Make_commands (Backend : Backend_intf.S) = struct
  | Some path -> path
  | None -> failwithf "Can't find executable for %s" prog ()
  in
- record_opt_fn ~executable ~f:(fun opts ->
- let elf = Elf.create opts.executable in
- let%bind range_symbols =
- evaluate_trace_filter ~trace_filter:opts.trace_filter ~elf
- in
- let%bind pid =
- let argv = prog :: List.concat (Option.to_list argv) in
- run_and_record
- opts
+ let%bind () =
+ record_opt_fn ~executable ~f:(fun opts ->
+ let elf = Elf.create opts.executable in
+ let%bind range_symbols =
+ evaluate_trace_filter ~trace_filter:opts.trace_filter ~elf
+ in
+ let%bind pid =
+ let argv = prog :: List.concat (Option.to_list argv) in
+ run_and_record
+ opts
+ ~elf
+ ~debug_print_perf_commands
+ ~prog
+ ~argv
+ ~collection_mode:opts.collection_mode
+ in
+ let%bind.Deferred perf_maps = Perf_map.Table.load_by_pids [ pid ] in
+ decode_to_trace
+ ~perf_maps
+ ?range_symbols
  ~elf
+ ~trace_scope:opts.trace_scope
  ~debug_print_perf_commands
- ~prog
- ~argv
+ ~record_dir:opts.record_dir
  ~collection_mode:opts.collection_mode
- in
- let%bind.Deferred perf_maps = Perf_map.Table.load_by_pids [ pid ] in
- decode_to_trace
- ~perf_maps
- ?range_symbols
- ~elf
- ~trace_scope:opts.trace_scope
- ~debug_print_perf_commands
- ~record_dir:opts.record_dir
- ~collection_mode:opts.collection_mode
- decode_opts))
+ decode_opts)
+ in
+ let%bind.Deferred () =
+ match url with
+ | None -> Deferred.return ()
+ | Some url -> Async_shell.run "open" [ url ]
+ in
+ let output_config = decode_opts.Decode_opts.output_config in
+ let output = Tracing_tool_output.output output_config in
+ let output_file =
+ match output with
+ | `Sexp _ -> failwith "unimplemented"
+ | `Fuchsia store_path -> store_path
+ in
+ let%bind.Deferred () =
+ match trace_processor_exe with
+ | None ->
+ print_endline "warning: must use local processor on large trace files";
+ Deferred.return ()
+ | Some processor_path -> Async_shell.run processor_path [ "-D"; output_file ]
+ in
+ return ())
  ;;
 
  let select_pid () =

src/tracing_tool_output.ml

@@ -85,7 +85,7 @@ module Serve = struct
  let handler ~body addr request =
  let path = request_path request in
  (* Uncomment this to debug routing *)
- (* Core.printf "%s\n%!" path; *)
+ Core.printf "%s\n%!" path;
  match path with
  | "" | "/" | "/index.html" -> respond_index t ~filename
  (* Serve the trace under any name under /trace/ so only the HTML has to change *)
@@ -116,6 +116,7 @@ type t =
  { serve : Serve.t
  ; output : [ `Fuchsia of string | `Sexp of string ]
  }
+[@@deriving fields]
 
 let store_path = function
  | `Fuchsia store_path | `Sexp store_path -> store_path

src/tracing_tool_output.mli

@@ -3,6 +3,8 @@ open! Async
 
 type t
 
+val output : t -> [ `Fuchsia of string | `Sexp of string ]
+
 (** Offers configuration parameters for where to save a file and whether to serve it *)
 val param : t Command.Param.t