package magic-trace

You can search for identifiers within the package.

in-package search v0.2.0

magic-trace.magic_trace
- Magic_trace
  - Min_duration
  - Private
magic-trace.magic_trace_core
- Magic_trace_core
  - Backend_intf
    
    S
    
    Decode_opts
    
    Record_opts
    
    Recording
  - Decode_result
  - Elf
    
    Addr_table
    
    Location
    
    Stop_info
    
    Symbol_resolver
  - Elf_intf
    
    Addr_table
    
    Location
    
    Stop_info
  - Errno
  - Event
    
    Decode_error
    
    Kind
    
    Location
    
    Ok
    
    Thread
  - Perf_map
  - Perf_map_location
  - Subcommand
  - Symbol
  - Timer_resolution
  - Trace_mode
  - Trace_state_change
  - When_to_snapshot
magic-trace.magic_trace_lib
- Magic_trace_lib
  - Boot_time
  - Breakpoint
    
    Hit
  - Env_vars
  - Import
  - Perf_capabilities
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Unstable
  - Perf_tool_backend
    
    Decode_opts
    
    Perf_line
    
    Record_opts
    
    Recording
  - Pow2_pages
  - Ptrace
  - Trace
    
    For_testing
  - Trace_writer
  - Trace_writer_intf
    
    S_trace
  - Tracing_tool_output

Legend:
Library
Module
Module type
Parameter
Class
Class type

Intended for use like so:

let min_dur = Magic_trace.Min_duration.of_ns 3_000

let my_fun a b c =
  Magic_trace.mark_start ();
  (* ... *)
  if Magic_trace.Min_duration.over min_dur then Magic_trace.take_snapshot ()
;;

which allows capturing only unusually long executions without adding the ~10us breakpoint overhead on every run while magic-trace is attached.

See also the -duration-thresh flag for use in combination with this or instead of it if you can tolerate a 10us pause on every call.

type t

val of_ns : int -> t

This involves using and forcing Time_stamp_counter.calibrator so should probably be done only once at the top level as opposed to every time.

val over : t -> bool

Returns true if the time since mark_start is over the threshold