Stdlib.Gc
Memory management control and statistics; finalised values.
type stat = {
}
The memory management counters are returned in a stat
record.
The total amount of memory allocated by the program since it was started is (in words) minor_words + major_words - promoted_words
. Multiply by the word size (4 on a 32-bit machine, 8 on a 64-bit machine) to get the number of bytes.
type control = {
}
The GC parameters are given as a control
record. Note that these parameters can also be initialised by setting the OCAMLRUNPARAM environment variable. See the documentation of ocamlrun
.
val stat : unit -> stat
Return the current values of the memory management counters in a stat
record. This function examines every heap block to get the statistics.
val quick_stat : unit -> stat
Same as stat
except that live_words
, live_blocks
, free_words
, free_blocks
, largest_free
, and fragments
are set to 0. This function is much faster than stat
because it does not need to go through the heap.
Return (minor_words, promoted_words, major_words)
. This function is as fast as quick_stat
.
Number of words allocated in the minor heap since the program was started. This number is accurate in byte-code programs, but only an approximation in programs compiled to native code.
In native code this function does not allocate.
val get : unit -> control
Return the current values of the GC parameters in a control
record.
val set : control -> unit
set r
changes the GC parameters according to the control
record r
. The normal usage is: Gc.set { (Gc.get()) with Gc.verbose = 0x00d }
major_slice n
Do a minor collection and a slice of major collection. n
is the size of the slice: the GC will do enough work to free (on average) n
words of memory. If n
= 0, the GC will try to do enough work to ensure that the next automatic slice has no work to do. This function returns an unspecified integer (currently: 0).
Do a minor collection, finish the current major collection cycle, and perform a complete new cycle. This will collect all currently unreachable blocks.
Perform a full major collection and compact the heap. Note that heap compaction is a lengthy operation.
val print_stat : out_channel -> unit
Print the current values of the memory management counters (in human-readable form) into the channel argument.
Return the total number of bytes allocated since the program was started. It is returned as a float
to avoid overflow problems with int
on 32-bit machines.
get_bucket n
returns the current size of the n
-th future bucket of the GC smoothing system. The unit is one millionth of a full GC.
get_credit ()
returns the current size of the "work done in advance" counter of the GC smoothing system. The unit is one millionth of a full GC.
Return the number of times we tried to map huge pages and had to fall back to small pages. This is always 0 if OCAMLRUNPARAM
contains H=1
.
finalise f v
registers f
as a finalisation function for v
. v
must be heap-allocated. f
will be called with v
as argument at some point between the first time v
becomes unreachable (including through weak pointers) and the time v
is collected by the GC. Several functions can be registered for the same value, or even several instances of the same function. Each instance will be called once (or never, if the program terminates before v
becomes unreachable).
The GC will call the finalisation functions in the order of deallocation. When several values become unreachable at the same time (i.e. during the same GC cycle), the finalisation functions will be called in the reverse order of the corresponding calls to finalise
. If finalise
is called in the same order as the values are allocated, that means each value is finalised before the values it depends upon. Of course, this becomes false if additional dependencies are introduced by assignments.
In the presence of multiple OCaml threads it should be assumed that any particular finaliser may be executed in any of the threads.
Anything reachable from the closure of finalisation functions is considered reachable, so the following code will not work as expected:
let v = ... in Gc.finalise (fun _ -> ...v...) v
Instead you should make sure that v
is not in the closure of the finalisation function by writing:
let f = fun x -> ... let v = ... in Gc.finalise f v
The f
function can use all features of OCaml, including assignments that make the value reachable again. It can also loop forever (in this case, the other finalisation functions will not be called during the execution of f, unless it calls finalise_release
). It can call finalise
on v
or other values to register other functions or even itself. It can raise an exception; in this case the exception will interrupt whatever the program was doing when the function was called.
finalise
will raise Invalid_argument
if v
is not guaranteed to be heap-allocated. Some examples of values that are not heap-allocated are integers, constant constructors, booleans, the empty array, the empty list, the unit value. The exact list of what is heap-allocated or not is implementation-dependent. Some constant values can be heap-allocated but never deallocated during the lifetime of the program, for example a list of integer constants; this is also implementation-dependent. Note that values of types float
are sometimes allocated and sometimes not, so finalising them is unsafe, and finalise
will also raise Invalid_argument
for them. Values of type 'a Lazy.t
(for any 'a
) are like float
in this respect, except that the compiler sometimes optimizes them in a way that prevents finalise
from detecting them. In this case, it will not raise Invalid_argument
, but you should still avoid calling finalise
on lazy values.
The results of calling String.make
, Bytes.make
, Bytes.create
, Array.make
, and Stdlib.ref
are guaranteed to be heap-allocated and non-constant except when the length argument is 0
.
same as finalise
except the value is not given as argument. So you can't use the given value for the computation of the finalisation function. The benefit is that the function is called after the value is unreachable for the last time instead of the first time. So contrary to finalise
the value will never be reachable again or used again. In particular every weak pointer and ephemeron that contained this value as key or data is unset before running the finalisation function. Moreover the finalisation functions attached with finalise
are always called before the finalisation functions attached with finalise_last
.
A finalisation function may call finalise_release
to tell the GC that it can launch the next finalisation function without waiting for the current one to return.
An alarm is a piece of data that calls a user function at the end of each major GC cycle. The following functions are provided to create and delete alarms.
val create_alarm : (unit -> unit) -> alarm
create_alarm f
will arrange for f
to be called at the end of each major GC cycle, starting with the current cycle or the next one. A value of type alarm
is returned that you can use to call delete_alarm
.
val delete_alarm : alarm -> unit
delete_alarm a
will stop the calls to the function associated to a
. Calling delete_alarm a
again has no effect.
eventlog_pause ()
will pause the collection of traces in the runtime. Traces are collected if the program is linked to the instrumented runtime and started with the environment variable OCAML_EVENTLOG_ENABLED. Events are flushed to disk after pausing, and no new events will be recorded until eventlog_resume
is called.
eventlog_resume ()
will resume the collection of traces in the runtime. Traces are collected if the program is linked to the instrumented runtime and started with the environment variable OCAML_EVENTLOG_ENABLED. This call can be used after calling eventlog_pause
, or if the program was started with OCAML_EVENTLOG_ENABLED=p. (which pauses the collection of traces before the first event.)
module Memprof : sig ... end
Memprof
is a sampling engine for allocated memory words. Every allocated word has a probability of being sampled equal to a configurable sampling rate. Once a block is sampled, it becomes tracked. A tracked block triggers a user-defined callback as soon as it is allocated, promoted or deallocated.