package gperftools

  1. Overview
  2. Docs
Bindings to gperftools

Install 

dune-project
 Dependency

ygrek.org Edit opam file Versions (3)

Authors

  1. Y
    ygrek

Maintainers

  1. Y
    ygrek@autistici.org

Sources

ocaml-gperftools-0.5.tar.gz
md5=5948cedd4a93b6f2d690c0dedf5f1e80
sha256=8561e22bdff686142f3fc43861196cb4a0dc5575b174632647b8bab639caceac
sha512=5c71ebf79db5e261560dbdc2847584dbacfa5c00ba3b4ae43b87630c72af8b91aa61ff2d04495f35df98c4ceacfd1ca20d9e6af2b997c0eafa020286f90d644f

doc/gperftools/Gperftools/index.html

Module GperftoolsSource

Bindings to gperftools. Monitor memory usage and control behaviour of tcmalloc.

  • author ygrek\@autistici.org

malloc interface

Sourceval release_free_memory : unit -> unit

Release as much memory as possible to operating system

Sourceval set_memory_release_rate : float -> unit

Sets the rate at which we release unused memory to the system. Zero means we never release memory back to the system. Increase this flag to return memory faster; decrease it to return memory slower. Reasonable rates are in the range [0,10]. (Currently only implemented in tcmalloc).

Sourceval get_memory_release_rate : unit -> float

Gets the release rate. Returns a value < 0 if unknown.

Sourceexception Invalid_property of string
Sourceval set_numeric_property : string -> int -> unit
  • raises Invalid_property

    if the property is not a valid property name for the current malloc implementation, or is not writable

Sourceval get_numeric_property : string -> int
  • raises Invalid_property

    if the property is not a valid property name for the current malloc implementation

Sourceval known_properties : string list

Some currently useful properties :

  • generic.current_allocated_bytes - number of bytes used by the application. This will not typically match the memory use reported by the OS, because it does not include TCMalloc overhead or memory fragmentation.
  • generic.heap_size - bytes of system memory reserved by TCMalloc.
  • tcmalloc.pageheap_free_bytes - number of bytes in free, mapped pages in page heap. These bytes can be used to fulfill allocation requests. They always count towards virtual memory usage, and unless the underlying memory is swapped out by the OS, they also count towards physical memory usage.
  • tcmalloc.pageheap_unmapped_bytes - number of bytes in free, unmapped pages in page heap. These are bytes that have been released back to the OS, possibly by one of the MallocExtension "Release" calls. They can be used to fulfill allocation requests, but typically incur a page fault. They always count towards virtual memory usage, and depending on the OS, typically do not count towards physical memory usage.
  • tcmalloc.max_total_thread_cache_bytes - a limit to how much memory TCMalloc dedicates for small objects. Higher numbers trade off more memory use for -- in some situations -- improved efficiency. Writable.
  • tcmalloc.current_total_thread_cache_bytes - a measure of some of the memory TCMalloc is using (for small objects).
  • tcmalloc.aggressive_memory_decommit - when returning chunk of memory to system, try to return all neighboring free chunks as well. Writable.
Sourceval version : unit -> string * int * int * string

Heap profiler

Sourceval heap_profiler_start : string -> unit
Sourceval is_heap_profiler_running : unit -> bool
Sourceval heap_profiler_stop : unit -> unit
Sourceval heap_profiler_dump : string -> unit
Sourceval get_heap_profile : unit -> string