=======================
Nim's Memory Management
=======================

.. default-role:: code
.. include:: rstcommon.rst

:Author: Andreas Rumpf
:Version: |nimversion|

..


  "The road to hell is paved with good intentions."


Introduction
============

A memory-management algorithm optimal for every use-case cannot exist.
Nim provides multiple paradigms for needs ranging from large multi-threaded
applications, to games, hard-realtime systems and small microcontrollers.

This document describes how the management strategies work;
How to tune the garbage collectors for your needs, like (soft) `realtime systems`:idx:,
and how the memory management strategies other than garbage collectors work.

.. note:: the default GC is incremental, thread-local and not "stop-the-world"

Multi-paradigm Memory Management Strategies
===========================================

.. default-role:: option

To choose the memory management strategy use the `--gc:` switch.

--gc:refc    This is the default GC. It's a
  deferred reference counting based garbage collector
  with a simple Mark&Sweep backup GC in order to collect cycles. Heaps are thread-local.
--gc:markAndSweep  Simple Mark-And-Sweep based garbage collector.
  Heaps are thread-local.
--gc:boehm    Boehm based garbage collector, it offers a shared heap.
--gc:go    Go's garbage collector, useful for interoperability with Go.
  Offers a shared heap.
--gc:arc    Plain reference counting with
  `move semantic optimizations <destructors.html#move-semantics>`_, offers a shared heap.
  It offers deterministic performance for `hard realtime`:idx: systems. Reference cycles
  cause memory leaks, beware.

--gc:orc    Same as `--gc:arc` but adds a cycle collector based on "trial deletion".
  Unfortunately, that makes its performance profile hard to reason about so it is less
  useful for hard real-time systems.

--gc:none    No memory management strategy nor a garbage collector. Allocated memory is
  simply never freed. You should use `--gc:arc` instead.


================== ======== ================= ============== ===================
Memory Management  Heap     Reference Cycles  Stop-The-World Command line switch
================== ======== ================= ============== ===================
RefC               Local    Cycle Collector   No             `--gc:refc`
Mark & Sweep       Local    Cycle Collector   No             `--gc:markAndSweep`
ARC                Shared   Leak              No             `--gc:arc`
ORC                Shared   Cycle Collector   No             `--gc:orc`
Boehm              Shared   Cycle Collector   Yes            `--gc:boehm`
Go                 Shared   Cycle Collector   Yes            `--gc:go`
None               Manual   Manual            Manual         `--gc:none`
================== ======== ================= ============== ===================

.. default-role:: code
.. include:: rstcommon.rst

JavaScript's garbage collector is used for the `JavaScript and NodeJS
<backends.html#backends-the-javascript-target>`_ compilation targets.
The `NimScript <nims.html>`_ target uses the memory management strategy built into
the Nim compiler.


Tweaking the refc GC
====================

Cycle collector
---------------

The cycle collector can be en-/disabled independently from the other parts of
the garbage collector with `GC_enableMarkAndSweep` and `GC_disableMarkAndSweep`.


Soft real-time support
----------------------

To enable real-time support, the symbol `useRealtimeGC`:idx: needs to be
defined via `--define:useRealtimeGC`:option: (you can put this into your config
file as well).
With this switch the garbage collector supports the following operations:

.. code-block:: nim
  proc GC_setMaxPause*(maxPauseInUs: int)
  proc GC_step*(us: int, strongAdvice = false, stackSize = -1)

The unit of the parameters `maxPauseInUs` and `us` is microseconds.

These two procs are the two modus operandi of the real-time garbage collector:

(1) GC_SetMaxPause Mode

    You can call `GC_SetMaxPause` at program startup and then each triggered
    garbage collector run tries to not take longer than `maxPause` time. However, it is
    possible (and common) that the work is nevertheless not evenly distributed
    as each call to `new` can trigger the garbage collector and thus take  `maxPause`
    time.

(2) GC_step Mode

    This allows the garbage collector to perform some work for up to `us` time.
    This is useful to call in the main loop to ensure the garbage collector can do its work.
    To bind all garbage collector activity to a `GC_step` call,
    deactivate the garbage collector with `GC_disable` at program startup.
    If `strongAdvice` is set to `true`,
    then the garbage collector will be forced to perform the collection cycle.
    Otherwise, the garbage collector may decide not to do anything,
    if there is not much garbage to collect.
    You may also specify the current stack size via `stackSize` parameter.
    It can improve performance when you know that there are no unique Nim references
    below a certain point on the stack. Make sure the size you specify is greater
    than the potential worst-case size.

    It can improve performance when you know that there are no unique Nim
    references below a certain point on the stack. Make sure the size you specify
    is greater than the potential worst-case size.

These procs provide a "best effort" real-time guarantee; in particular the
cycle collector is not aware of deadlines. Deactivate it to get more
predictable real-time behaviour. Tests show that a 1ms max pause
time will be met in almost all cases on modern CPUs (with the cycle collector
disabled).


Time measurement with garbage collectors
----------------------------------------

The garbage collectors' way of measuring time uses
(see ``lib/system/timers.nim`` for the implementation):

1) `QueryPerformanceCounter` and `QueryPerformanceFrequency` on Windows.
2) `mach_absolute_time` on Mac OS X.
3) `gettimeofday` on Posix systems.

As such it supports a resolution of nanoseconds internally; however, the API
uses microseconds for convenience.

Define the symbol `reportMissedDeadlines` to make the
garbage collector output whenever it missed a deadline.
The reporting will be enhanced and supported by the API in later versions of the collector.


Tweaking the garbage collector
------------------------------

The collector checks whether there is still time left for its work after
every `workPackage`'th iteration. This is currently set to 100 which means
that up to 100 objects are traversed and freed before it checks again. Thus
`workPackage` affects the timing granularity and may need to be tweaked in
highly specialized environments or for older hardware.


Keeping track of memory
=======================

If you need to pass around memory allocated by Nim to C, you can use the
procs `GC_ref` and `GC_unref` to mark objects as referenced to avoid them
being freed by the garbage collector.
Other useful procs from `system <system.html>`_ you can use to keep track of memory are:

* `getTotalMem()` Returns the amount of total memory managed by the garbage collector.
* `getOccupiedMem()` Bytes reserved by the garbage collector and used by objects.
* `getFreeMem()` Bytes reserved by the garbage collector and not in use.
* `GC_getStatistics()` Garbage collector statistics as a human-readable string.

These numbers are usually only for the running thread, not for the whole heap,
with the exception of `--gc:boehm`:option: and `--gc:go`:option:.

In addition to `GC_ref` and `GC_unref` you can avoid the garbage collector by manually
allocating memory with procs like `alloc`, `alloc0`, `allocShared`, `allocShared0` or `allocCStringArray`.
The garbage collector won't try to free them, you need to call their respective *dealloc* pairs
(`dealloc`, `deallocShared`, `deallocCStringArray`, etc)
when you are done with them or they will leak.


Heap dump
=========

The heap dump feature is still in its infancy, but it already proved
useful for us, so it might be useful for you. To get a heap dump, compile
with `-d:nimTypeNames`:option: and call `dumpNumberOfInstances`
at a strategic place in your program.
This produces a list of the used types in your program and for every type
the total amount of object instances for this type as well as the total
amount of bytes these instances take up.

The numbers count the number of objects in all garbage collector heaps, they refer to
all running threads, not only to the current thread. (The current thread
would be the thread that calls `dumpNumberOfInstances`.) This might
change in later versions.
