package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Allocation_report : sig ... end
val measure_allocation : (Base.Unit.t -> 'a) -> 'a * Allocation_report.t

measure_allocation f measures the words allocated by running f ()

module Allocation_log : sig ... end
val measure_and_log_allocation : (Base.Unit.t -> 'a) -> 'a * Allocation_report.t * Allocation_log.t Base.List.t

measure_and_log_allocation f logs each allocation that f () performs, as well as reporting the total. (This can be slow if f allocates heavily).

This function is only supported since OCaml 4.11. On prior versions, the function always returns an empty log.

val is_zero_alloc : (Base.Unit.t -> _) -> Base.Bool.t

is_zero_alloc f runs f () and returns true if it does not allocate, or false otherwise. is_zero_alloc does not allocate.

val prepare_heap_to_count_minor_allocation : Base.Unit.t -> Base.Unit.t

prepare_heap_to_count_minor_allocation sets up the heap so that one can subsequently measure minor allocation via:

let minor_words_before = Gc.minor_words () in
(* ... do stuff ... *)
let minor_words_after = Gc.minor_words () in
let minor_words_allocated = minor_words_after - minor_words_before in

Without calling prepare_heap_to_count_minor_allocation, the resulting count may be inaccurate.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct