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

The magic-trace tool can work with any binary, but using these functions allows you to easily mark places in your code to take a snapshot, and enables additional features like passing a value and marking the start of a duration.

val take_snapshot : unit -> unit

This is the default symbol that the magic-trace command will attach to and use to take a snapshot. Use it if you want to take a snapshot based on custom logic, and it will save you the step of selecting the symbol you want to stop on.

It's an external C function that does nothing and should be very fast to call. It's only a C function to ensure it has a stable and exact symbol.

val take_snapshot_with_arg : int -> unit

Passes an integer along that will show up in the resulting trace

val take_snapshot_with_time_and_arg : Time_stamp_counter.t -> int -> unit

Passes both the start tsc for the operation and an argument.

val mark_start : unit -> unit

Mark the start time of some operation which may lead to a snapshot.

module Min_duration : sig ... end

Intended for use like so:

module Private : sig ... end

Internal details about how to interact with the snapshot function from outside