diff --git a/trace-fuchsia/Trace_fuchsia/index.html b/trace-fuchsia/Trace_fuchsia/index.html index 4a583ae..4f8ce23 100644 --- a/trace-fuchsia/Trace_fuchsia/index.html +++ b/trace-fuchsia/Trace_fuchsia/index.html @@ -1,5 +1,5 @@ -Trace_fuchsia (trace-fuchsia.Trace_fuchsia)

Module Trace_fuchsia

val collector : +Trace_fuchsia (trace-fuchsia.Trace_fuchsia)

Module Trace_fuchsia

Fuchsia trace collector.

This provides a collector for traces that emits data into a file using the compact binary Fuchsia trace format. This reduces the tracing overhead compared to trace-tef, at the expense of simplicity.

val collector : out:[ `File of string | `Stderr | `Stdout ] -> unit -> - Trace_core.collector

Make a collector that writes into the given output. See setup for more details.

type output = [
  1. | `Stdout
  2. | `Stderr
  3. | `File of string
]

Output for tracing.

  • `Stdout will enable tracing and print events on stdout
  • `Stderr will enable tracing and print events on stderr
  • `File "foo" will enable tracing and print events into file named "foo"
val setup : ?out:[ output | `Env ] -> unit -> unit

setup () installs the collector depending on out.

  • parameter out

    can take different values:

    • regular output value to specify where events go
    • `Env will enable tracing if the environment variable "TRACE" is set.
    • If it's set to "1", then the file is "trace.fxt".
    • If it's set to "stdout", then logging happens on stdout (since 0.2)
    • If it's set to "stderr", then logging happens on stdout (since 0.2)
    • Otherwise, if it's set to a non empty string, the value is taken to be the file path into which to write.
val with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a

with_setup () f (optionally) sets a collector up, calls f(), and makes sure to shutdown before exiting. since 0.2 a () argument was added.

\ No newline at end of file + Trace_core.collector

Make a collector that writes into the given output. See setup for more details.

type output = [
  1. | `Stdout
  2. | `Stderr
  3. | `File of string
]

Output for tracing.

  • `Stdout will enable tracing and print events on stdout
  • `Stderr will enable tracing and print events on stderr
  • `File "foo" will enable tracing and print events into file named "foo"
val setup : ?out:[ output | `Env ] -> unit -> unit

setup () installs the collector depending on out.

  • parameter out

    can take different values:

    • regular output value to specify where events go
    • `Env will enable tracing if the environment variable "TRACE" is set.
    • If it's set to "1", then the file is "trace.fxt".
    • If it's set to "stdout", then logging happens on stdout (since 0.2)
    • If it's set to "stderr", then logging happens on stdout (since 0.2)
    • Otherwise, if it's set to a non empty string, the value is taken to be the file path into which to write.
val with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a

with_setup () f (optionally) sets a collector up, calls f(), and makes sure to shutdown before exiting.

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Argument/index.html b/trace-fuchsia/Trace_fuchsia_write/Argument/index.html deleted file mode 100644 index 480eeaf..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Argument/index.html +++ /dev/null @@ -1,19 +0,0 @@ - -Argument (trace-fuchsia.Trace_fuchsia_write.Argument)

Module Trace_fuchsia_write.Argument

type 'a t = string * [< user_data | `Kid of int ] as 'a
val check_valid : 'a -> unit
val is_i32_ : int -> bool
val size_word : - [< `Bool of bool & 'a - | `Float of float & 'b - | `Int of int - | `Kid of int & 'c - | `None - | `String of string ] - t -> - int
val encode : - Buf.t -> - [< `Bool of bool & 'a - | `Float of float & 'b - | `Int of int - | `Kid of int & 'c - | `None - | `String of string ] - t -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Arguments/index.html b/trace-fuchsia/Trace_fuchsia_write/Arguments/index.html deleted file mode 100644 index 50fa497..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Arguments/index.html +++ /dev/null @@ -1,35 +0,0 @@ - -Arguments (trace-fuchsia.Trace_fuchsia_write.Arguments)

Module Trace_fuchsia_write.Arguments

type 'a t = 'a Argument.t list
val len : - [< `Bool of bool - | `Float of float - | `Int of int - | `Kid of int - | `None - | `String of string ] - t -> - int
val check_valid : - [< `Bool of bool - | `Float of float - | `Int of int - | `Kid of int - | `None - | `String of string ] - t -> - unit
val size_word : - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - t -> - int
val encode : - Buf.t -> - [< `Bool of bool & 'a & 'b & 'c - | `Float of float & 'd & 'e & 'f - | `Int of int - | `Kid of int & 'g & 'h & 'i - | `None - | `String of string ] - t -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Buf/index.html b/trace-fuchsia/Trace_fuchsia_write/Buf/index.html deleted file mode 100644 index 4e45874..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Buf/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Buf (trace-fuchsia.Trace_fuchsia_write.Buf)

Module Trace_fuchsia_write.Buf

type t = {
  1. buf : bytes;
  2. mutable offset : int;
}
val empty : t
val create : int -> t
val clear : t -> unit
val available : t -> int
val size : t -> int
val add_i64 : t -> int64 -> unit
val add_string : t -> string -> unit
val to_string : t -> string
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Buf_pool/List_with_len/index.html b/trace-fuchsia/Trace_fuchsia_write/Buf_pool/List_with_len/index.html deleted file mode 100644 index c6a8c2c..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Buf_pool/List_with_len/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -List_with_len (trace-fuchsia.Trace_fuchsia_write.Buf_pool.List_with_len)

Module Buf_pool.List_with_len

type +'a t =
  1. | Nil
  2. | Cons of int * 'a * 'a t
val empty : 'a t
val len : 'a t -> int
val cons : 'a -> 'b t -> 'b t
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Buf_pool/index.html b/trace-fuchsia/Trace_fuchsia_write/Buf_pool/index.html deleted file mode 100644 index 30a639b..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Buf_pool/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Buf_pool (trace-fuchsia.Trace_fuchsia_write.Buf_pool)

Module Trace_fuchsia_write.Buf_pool

module List_with_len : sig ... end
type t = {
  1. max_len : int;
  2. buf_size : int;
  3. bufs : Buf.t List_with_len.t {A}1.t;
}
val create : ?max_len:int -> ?buf_size:int -> unit -> t
val alloc : t -> Buf.t
val recycle : t -> Buf.t -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Async_begin/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Async_begin/index.html deleted file mode 100644 index 59e235f..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Async_begin/index.html +++ /dev/null @@ -1,29 +0,0 @@ - -Async_begin (trace-fuchsia.Trace_fuchsia_write.Event.Async_begin)

Module Event.Async_begin

type=5

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - async_id:int -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Async_end/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Async_end/index.html deleted file mode 100644 index 90ef4d8..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Async_end/index.html +++ /dev/null @@ -1,29 +0,0 @@ - -Async_end (trace-fuchsia.Trace_fuchsia_write.Event.Async_end)

Module Event.Async_end

type=7

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - async_id:int -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Counter/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Counter/index.html deleted file mode 100644 index 8ef25ce..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Counter/index.html +++ /dev/null @@ -1,28 +0,0 @@ - -Counter (trace-fuchsia.Trace_fuchsia_write.Event.Counter)

Module Event.Counter

type=1

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_begin/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Duration_begin/index.html deleted file mode 100644 index a7a18f5..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_begin/index.html +++ /dev/null @@ -1,28 +0,0 @@ - -Duration_begin (trace-fuchsia.Trace_fuchsia_write.Event.Duration_begin)

Module Event.Duration_begin

type=2

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_complete/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Duration_complete/index.html deleted file mode 100644 index c0e4101..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_complete/index.html +++ /dev/null @@ -1,29 +0,0 @@ - -Duration_complete (trace-fuchsia.Trace_fuchsia_write.Event.Duration_complete)

Module Event.Duration_complete

type=4

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - end_time_ns:int64 -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_end/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Duration_end/index.html deleted file mode 100644 index 34dbd6f..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Duration_end/index.html +++ /dev/null @@ -1,28 +0,0 @@ - -Duration_end (trace-fuchsia.Trace_fuchsia_write.Event.Duration_end)

Module Event.Duration_end

type=3

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/Instant/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/Instant/index.html deleted file mode 100644 index 9a897ed..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/Instant/index.html +++ /dev/null @@ -1,28 +0,0 @@ - -Instant (trace-fuchsia.Trace_fuchsia_write.Event.Instant)

Module Event.Instant

type=0

val size_word : - name:string -> - t_ref:Thread_ref.t -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
val encode : - Output.t -> - name:string -> - t_ref:Thread_ref.t -> - time_ns:int64 -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Event/index.html b/trace-fuchsia/Trace_fuchsia_write/Event/index.html deleted file mode 100644 index fa86666..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Event/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Event (trace-fuchsia.Trace_fuchsia_write.Event)

Module Trace_fuchsia_write.Event

record type = 4

module Instant : sig ... end

type=0

module Counter : sig ... end

type=1

module Duration_begin : sig ... end

type=2

module Duration_end : sig ... end

type=3

module Duration_complete : sig ... end

type=4

module Async_begin : sig ... end

type=5

module Async_end : sig ... end

type=7

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/I64/index.html b/trace-fuchsia/Trace_fuchsia_write/I64/index.html deleted file mode 100644 index 8b1ae21..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/I64/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -I64 (trace-fuchsia.Trace_fuchsia_write.I64)

Module Trace_fuchsia_write.I64

include module type of struct include Stdlib.Int64 end
val zero : int64
val one : int64
val minus_one : int64
val neg : int64 -> int64
val add : int64 -> int64 -> int64
val sub : int64 -> int64 -> int64
val mul : int64 -> int64 -> int64
val div : int64 -> int64 -> int64
val unsigned_div : int64 -> int64 -> int64
val rem : int64 -> int64 -> int64
val unsigned_rem : int64 -> int64 -> int64
val succ : int64 -> int64
val pred : int64 -> int64
val abs : int64 -> int64
val max_int : int64
val min_int : int64
val logand : int64 -> int64 -> int64
val logor : int64 -> int64 -> int64
val logxor : int64 -> int64 -> int64
val lognot : int64 -> int64
val shift_left : int64 -> int -> int64
val shift_right : int64 -> int -> int64
val shift_right_logical : int64 -> int -> int64
val of_int : int -> int64
val to_int : int64 -> int
val unsigned_to_int : int64 -> int option
val of_float : float -> int64
val to_float : int64 -> float
val of_int32 : int32 -> int64
val to_int32 : int64 -> int32
val of_nativeint : nativeint -> int64
val to_nativeint : int64 -> nativeint
val of_string : string -> int64
val of_string_opt : string -> int64 option
val to_string : int64 -> string
val bits_of_float : float -> int64
val float_of_bits : int64 -> float
type t = int64
val compare : t -> t -> int
val unsigned_compare : t -> t -> int
val equal : t -> t -> bool
val min : t -> t -> t
val max : t -> t -> t
val (+) : int64 -> int64 -> int64
val (-) : int64 -> int64 -> int64
val (=) : t -> t -> bool
val (land) : int64 -> int64 -> int64
val (lor) : int64 -> int64 -> int64
val lnot : int64 -> int64
val (lsl) : int64 -> int -> int64
val (lsr) : int64 -> int -> int64
val (asr) : int64 -> int -> int64
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Kernel_object/index.html b/trace-fuchsia/Trace_fuchsia_write/Kernel_object/index.html deleted file mode 100644 index 66caca8..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Kernel_object/index.html +++ /dev/null @@ -1,27 +0,0 @@ - -Kernel_object (trace-fuchsia.Trace_fuchsia_write.Kernel_object)

Module Trace_fuchsia_write.Kernel_object

record type = 7

val size_word : - name:string -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd - | `Float of float & 'e & 'f & 'g & 'h - | `Int of int - | `Kid of int & 'i & 'j & 'k & 'l - | `None - | `String of string ] - Arguments.t -> - unit -> - int
type ty = int
val ty_process : ty
val ty_thread : ty
val encode : - Output.t -> - name:string -> - ty:ty -> - kid:int -> - args: - [< `Bool of bool & 'a & 'b & 'c & 'd & 'e & 'f & 'g - | `Float of float & 'h & 'i & 'j & 'k & 'l & 'm & 'n - | `Int of int - | `Kid of int & 'o & 'p & 'q & 'r & 's & 't & 'u - | `None - | `String of string ] - Arguments.t -> - unit -> - unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/Initialization_record/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/Initialization_record/index.html deleted file mode 100644 index 78ba8ee..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/Initialization_record/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Initialization_record (trace-fuchsia.Trace_fuchsia_write.Metadata.Initialization_record)

Module Metadata.Initialization_record

val size_word : int
val default_ticks_per_sec : int64

Default: 1 tick = 1 ns

val encode : Output.t -> ticks_per_secs:int64 -> unit -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/Magic_record/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/Magic_record/index.html deleted file mode 100644 index c10d9c0..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/Magic_record/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Magic_record (trace-fuchsia.Trace_fuchsia_write.Metadata.Magic_record)

Module Metadata.Magic_record

First record in the trace

val value : int64
val size_word : int
val encode : Output.t -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_info/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_info/index.html deleted file mode 100644 index 22ad0f6..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_info/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Provider_info (trace-fuchsia.Trace_fuchsia_write.Metadata.Provider_info)

Module Metadata.Provider_info

val size_word : name:string -> unit -> int
val encode : Output.t -> id:int -> name:string -> unit -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_section/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_section/index.html deleted file mode 100644 index 080ba66..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/Provider_section/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Provider_section (trace-fuchsia.Trace_fuchsia_write.Metadata.Provider_section)

Module Metadata.Provider_section

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/Trace_info/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/Trace_info/index.html deleted file mode 100644 index 583244c..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/Trace_info/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Trace_info (trace-fuchsia.Trace_fuchsia_write.Metadata.Trace_info)

Module Metadata.Trace_info

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Metadata/index.html b/trace-fuchsia/Trace_fuchsia_write/Metadata/index.html deleted file mode 100644 index 63704cd..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Metadata/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Metadata (trace-fuchsia.Trace_fuchsia_write.Metadata)

Module Trace_fuchsia_write.Metadata

record type = 0

module Magic_record : sig ... end

First record in the trace

module Initialization_record : sig ... end
module Provider_info : sig ... end
module Provider_section : sig ... end
module Trace_info : sig ... end
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Output/index.html b/trace-fuchsia/Trace_fuchsia_write/Output/index.html deleted file mode 100644 index 41b51bc..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Output/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Output (trace-fuchsia.Trace_fuchsia_write.Output)

Module Trace_fuchsia_write.Output

type t = {
  1. mutable buf : Buf.t;
  2. mutable send_buf : Buf.t -> unit;
  3. buf_pool : Buf_pool.t;
}
val create : buf_pool:Buf_pool.t -> send_buf:(Buf.t -> unit) -> unit -> t
val flush : t -> unit
val get_buf : t -> available_word:int -> Buf.t

Obtain a buffer with at least available bytes

val into_buffer : buf_pool:Buf_pool.t -> Stdlib.Buffer.t -> t
val dispose : t -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html b/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html deleted file mode 100644 index e560878..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Str_ref (trace-fuchsia.Trace_fuchsia_write.Str_ref)

Module Trace_fuchsia_write.Str_ref

type t = int

16 bits

val inline : int -> t
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Thread_record/index.html b/trace-fuchsia/Trace_fuchsia_write/Thread_record/index.html deleted file mode 100644 index 7cb9636..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Thread_record/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Thread_record (trace-fuchsia.Trace_fuchsia_write.Thread_record)

Module Trace_fuchsia_write.Thread_record

record type = 3

val size_word : int
val encode : Output.t -> as_ref:int -> pid:int -> tid:int -> unit -> unit

Record that Thread_ref.ref as_ref represents the pair pid, tid

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Thread_ref/index.html b/trace-fuchsia/Trace_fuchsia_write/Thread_ref/index.html deleted file mode 100644 index b8e7360..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Thread_ref/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Thread_ref (trace-fuchsia.Trace_fuchsia_write.Thread_ref)

Module Trace_fuchsia_write.Thread_ref

type t =
  1. | Ref of int
  2. | Inline of {
    1. pid : int;
    2. tid : int;
    }
val inline : pid:int -> tid:int -> t
val ref : int -> t
val size_word : t -> int
val as_i8 : t -> int

8-bit int for the reference

\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Util/index.html b/trace-fuchsia/Trace_fuchsia_write/Util/index.html deleted file mode 100644 index 5b842e7..0000000 --- a/trace-fuchsia/Trace_fuchsia_write/Util/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Util (trace-fuchsia.Trace_fuchsia_write.Util)

Module Trace_fuchsia_write.Util

val missing_to_round : int -> int

How many bytes are missing for n to be a multiple of 8

val round_to_word : int -> int

Round up to a multiple of 8

\ No newline at end of file diff --git a/trace/Trace_core/Collector/index.html b/trace/Trace_core/Collector/index.html deleted file mode 100644 index 015d582..0000000 --- a/trace/Trace_core/Collector/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Collector (trace.Trace_core.Collector)

Module Trace_core.Collector

A global collector.

The collector, if present, is responsible for collecting messages and spans, and storing them, recording them, forward them, or offering them to other services and processes.

val dummy_span : int64
val dummy_explicit_span : Trace_core__.Types.explicit_span
module type S = sig ... end

Signature for a collector.

\ No newline at end of file diff --git a/trace/Trace_core/Collector/module-type-S/index.html b/trace/Trace_core/Collector/module-type-S/index.html deleted file mode 100644 index 254f00b..0000000 --- a/trace/Trace_core/Collector/module-type-S/index.html +++ /dev/null @@ -1,95 +0,0 @@ - -S (trace.Trace_core.Collector.S)

Module type Collector.S

Signature for a collector.

This is only relevant to implementors of tracing backends; to instrument your code you only need to look at the Trace module.

val with_span : - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - (int64 -> 'a) -> - 'a

Run the function in a new span.

This replaces the previous enter_span and exit_span which were too flexible to be efficient to implement in async contexts.

  • since 0.3
val enter_span : - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - int64

Enter a new implicit span. For many uses cases, with_span will be easier to use.

  • since NEXT_RELEASE
val exit_span : int64 -> unit

Exit span. This should be called on the same thread as the corresponding enter_span, and nest properly with other calls to enter/exit_span and with_span.

  • since NEXT_RELEASE
val enter_manual_span : - parent:Trace_core__.Types.explicit_span option -> - flavor:[ `Sync | `Async ] option -> - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - Trace_core__.Types.explicit_span

Enter an explicit span. Surrounding scope, if any, is provided by parent, and this function can store as much metadata as it wants in the hmap in the explicit_span's meta field.

This means that the collector doesn't need to implement contextual storage mapping span to scopes, metadata, etc. on its side; everything can be transmitted in the explicit_span.

  • since 0.3
val exit_manual_span : Trace_core__.Types.explicit_span -> unit

Exit an explicit span.

  • since 0.3
val add_data_to_span : - int64 -> - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - unit
  • since Adds data to the current span.

0.4

val add_data_to_manual_span : - Trace_core__.Types.explicit_span -> - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - unit

Adds data to the given span.

  • since 0.4
val message : - ?span:int64 -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - unit

Emit a message with associated metadata.

val name_thread : string -> unit

Give a name to the current thread.

val name_process : string -> unit

Give a name to the current process.

val counter_int : - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - int -> - unit

Integer counter.

val counter_float : - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - float -> - unit

Float counter.

val shutdown : unit -> unit

Shutdown collector, possibly waiting for it to finish sending data.

\ No newline at end of file diff --git a/trace/Trace_core/Meta_map/Key/index.html b/trace/Trace_core/Meta_map/Key/index.html deleted file mode 100644 index 727dd7f..0000000 --- a/trace/Trace_core/Meta_map/Key/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key (trace.Trace_core.Meta_map.Key)

Module Meta_map.Key

Keys with a type witness.

type 'a t

A key of type 'a t is used to access the portion of the map or table that associates keys of type 'a to values.

val create : unit -> 'a t

Make a new key. This is generative, so calling create () twice with the same return type will produce incompatible keys that cannot see each other's bindings.

val equal : 'a t -> 'a t -> bool

Compare two keys that have compatible types.

\ No newline at end of file diff --git a/trace/Trace_core/Meta_map/index.html b/trace/Trace_core/Meta_map/index.html deleted file mode 100644 index 27abef0..0000000 --- a/trace/Trace_core/Meta_map/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Meta_map (trace.Trace_core.Meta_map)

Module Trace_core.Meta_map

Associative containers with Heterogeneous Values

module Key : sig ... end

Keys with a type witness.

type pair =
  1. | Pair : 'a Key.t * 'a -> pair
type t

Immutable map from Key.t to values

val empty : t
val mem : _ Key.t -> t -> bool
val add : 'a Key.t -> 'a -> t -> t
val remove : _ Key.t -> t -> t
val length : t -> int
val cardinal : t -> int
val find : 'a Key.t -> t -> 'a option
val find_exn : 'a Key.t -> t -> 'a
  • raises Not_found

    if the key is not in the table.

val iter : (pair -> unit) -> t -> unit
val add_list : t -> pair list -> t
val of_list : pair list -> t
val to_list : t -> pair list
\ No newline at end of file diff --git a/trace/Trace_private_util/B_queue/index.html b/trace/Trace_private_util/B_queue/index.html deleted file mode 100644 index 193dbc8..0000000 --- a/trace/Trace_private_util/B_queue/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -B_queue (trace.Trace_private_util.B_queue)

Module Trace_private_util.B_queue

Basic Blocking Queue

type 'a t
val create : unit -> _ t
exception Closed
val push : 'a t -> 'a -> unit

push q x pushes x into q, and returns ().

  • raises Closed

    if close q was previously called.

val pop_all : 'a t -> 'a list

pop_all bq returns all items presently in bq, in the same order, and clears bq. It blocks if no element is in bq.

val close : _ t -> unit

Close the queue, meaning there won't be any more push allowed.

\ No newline at end of file diff --git a/trace/Trace_private_util/Domain_util/index.html b/trace/Trace_private_util/Domain_util/index.html deleted file mode 100644 index 2448442..0000000 --- a/trace/Trace_private_util/Domain_util/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Domain_util (trace.Trace_private_util.Domain_util)

Module Trace_private_util.Domain_util

val cpu_relax : unit -> unit
val n_domains : unit -> int
\ No newline at end of file diff --git a/trace/Trace_private_util/Mpsc_bag/index.html b/trace/Trace_private_util/Mpsc_bag/index.html deleted file mode 100644 index 0d8f1c5..0000000 --- a/trace/Trace_private_util/Mpsc_bag/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Mpsc_bag (trace.Trace_private_util.Mpsc_bag)

Module Trace_private_util.Mpsc_bag

A multi-producer, single-consumer bag

type 'a t
val create : unit -> 'a t
val add : 'a t -> 'a -> unit

add q x adds x in the bag.

val pop_all : 'a t -> 'a list option

Return all current items in the insertion order.

\ No newline at end of file