Модуль Gc

Счетчики управления памятью возвращаются в записи stat. Эти счетчики дают значения для всей программы.

Общее количество памяти, выделенной программой с момента запуска (в словах) minor_words + major_words - promoted_words. Умножьте на размер слова (4 на 32-разрядной машине, 8 на 64-разрядной машине), чтобы получить количество байт.

Параметры сборщика мусора задаются как control запись. Обратите внимание, что эти параметры также можно инициализировать, установив переменную окружения OCAMLRUNPARAM. См. документацию ocamlrun.

Возвращает текущие значения счётчиков управления памятью в stat записи, которая представляет общую статистику памяти программы. Эта функция вызывает полный основной сбор мусора.

Аналогично stat, за исключением того, что live_words, live_blocks, free_words, free_blocks, largest_free, и fragments установлены в 0. Из-за буферов по областям он может представлять только состояние общего использования памяти программы с момента последнего малого сбора мусора или основного цикла. Эта функция намного быстрее, чем stat, потому что ей не нужно вызывать полный основной сбор мусора.

Возвращает (minor_words, promoted_words, major_words) для текущей области или потенциальных предыдущих областей. Эта функция так же быстра, как quick_stat.

Количество слов, выделенных в малом куске памяти этой областью или потенциально предыдущими областями. Это число точно в программах байткода, но только приблизительное в программах, скомпилированных в машинный код.

В программах машинного кода эта функция не выделяет память.

Возвращает текущие значения параметров сборщика мусора в control записи.

set r изменяет параметры сборщика мусора в соответствии с control записью r. Обычное использование: Gc.set { (Gc.get()) with Gc.verbose = 0x00d }

Запустить сбор мусора малого размера.

major_slice n Выполнить небольшую коллекцию и срез большой коллекции. n — размер среза: сборщик мусора выполнит достаточно работы, чтобы освободить (в среднем) n слов памяти. Если n = 0, сборщик мусора попытается выполнить достаточно работы, чтобы гарантировать, что следующий автоматический срез не потребует работы. Эта функция возвращает неопределённое целое число (в настоящее время: 0).

Выполнить небольшую коллекцию и завершить текущий цикл основной коллекции.

Выполнить небольшую коллекцию, завершить текущий цикл основной коллекции и выполнить новый полный цикл. Это соберет все в настоящее время недостижимые блоки.

Выполнить полную основную коллекцию и уплотнить кучу. Обратите внимание, что уплотнение кучи — длительная операция.

Вывести текущие значения счётчиков управления памятью (в удобочитаемой форме) всей программы в аргумент канала.

Возвращает количество байтов, выделенных этой областью, и потенциально предыдущей областью. Возвращается как float для предотвращения проблем переполнения с int на 32-разрядных машинах.

Возвращает текущий размер свободного места внутри меньшей кучи этой области.

finalise f v регистрирует f как функцию завершения для v. v должна быть выделена в куче. f будет вызвана с v в качестве аргумента в какой-то момент между первым временем, когда v становится недостижимой (включая через слабые ссылки) и временем, когда v собирается сборщиком мусора. Для одного значения могут быть зарегистрированы несколько функций, или даже несколько экземпляров одной функции. Каждый экземпляр будет вызван один раз (или никогда, если программа завершится до того, как v станет недостижимой).

Сборщик мусора вызовет функции завершения в порядке освобождения. Когда несколько значений становятся недостижимыми одновременно (т.е. во время одного цикла сборки мусора), функции завершения будут вызваны в обратном порядке соответствующих вызовов finalise. Если finalise вызывается в том же порядке, что и выделение значений, это означает, что каждое значение завершается перед значениями, от которых оно зависит. Конечно, это становится ложным, если вводятся дополнительные зависимости присваиваниями.

В присутствии нескольких потоков OCaml следует предположить, что любая конкретная функция завершения может быть выполнена в любом из потоков.

Всё, что достижимо из замыкания функций завершения, считается достижимым, поэтому следующий код не будет работать как ожидается:

•  let v = ... in Gc.finalise (fun _ -> ...v...) v 

Вместо этого вы должны убедиться, что v не находится в замыкании функции завершения, написав:

•  let f = fun x -> ...  let v = ... in Gc.finalise f v 

Функция f может использовать все возможности OCaml, включая присваивания, которые делают значение снова достижимым. Она также может циклиться вечно (в этом случае другие функции завершения не будут вызваны во время выполнения f, если она не вызывает finalise_release). Она может вызывать finalise на v или других значениях, чтобы зарегистрировать другие функции или даже себя. Она может вызвать исключение; в этом случае исключение прервёт всё, что делала программа, когда функция была вызвана.

finalise вызовет Invalid_argument, если v не гарантированно выделяется в куче. Некоторые примеры значений, которые не выделяются в куче, — это целые числа, константные конструкторы, булевы значения, пустой массив, пустой список, единичное значение. Точный список того, что выделяется в куче, а что нет, зависит от реализации. Некоторые константные значения могут быть выделены в куче, но никогда не освобождаться за время жизни программы, например, список константных целых чисел; это также зависит от реализации. Обратите внимание, что значения типов float иногда выделяются, а иногда нет, поэтому их завершение небезопасно, и finalise также вызовет Invalid_argument для них. Значения типа 'a Lazy.t (для любого 'a) похожи на float в этом отношении, за исключением того, что компилятор иногда оптимизирует их таким образом, чтобы finalise не мог их обнаружить. В этом случае он не вызовет Invalid_argument, но вы всё равно должны избегать вызова finalise для ленивых значений.

Результаты вызова String.make, Bytes.make, Bytes.create, Array.make и ref гарантированно выделяются в куче и не являются константными, за исключением случаев, когда аргумент длины — 0.

То же, что и Gc.finalise, за исключением того, что значение не передаётся в качестве аргумента. Таким образом, вы не можете использовать данное значение для вычисления функции завершения. Преимущество состоит в том, что функция вызывается после того, как значение стало недостижимым в последний раз вместо первого раза. Поэтому, в отличие от Gc.finalise, значение никогда не будет снова достижимым или используемым. В частности, все слабые ссылки и эфемерона, содержащие это значение в качестве ключа или данных, сбрасываются перед запуском функции завершения. Кроме того, функции завершения, прикреплённые с помощью Gc.finalise, всегда вызываются перед функциями завершения, прикреплёнными с помощью Gc.finalise_last.

Функция завершения может вызвать finalise_release чтобы сообщить сборщику мусора, что он может запустить следующую функцию завершения, не ожидая возвращения текущей.

Предупреждение — это данные, которые вызывают пользовательскую функцию в конце цикла основной сборки мусора. Следующие функции предназначены для создания и удаления предупреждений.

create_alarm f организует вызов f в конце циклов основной сборки мусора, не вызванных f самим, начиная с текущего цикла или следующего. f будет выполняться в той же области, что и создала предупреждение, до тех пор, пока область не выйдет или delete_alarm не будет вызвано. Возвращается значение типа alarm, которое вы можете использовать для вызова delete_alarm.

Не гарантируется, что предупреждение Gc выполняется в конце каждого цикла основной сборки мусора, но гарантируется, что оно будет выполнено в конечном итоге.

В качестве примера, вот грубый способ прервать функцию, если потребление памяти программы превысит заданный limit в МБ, подходящий для использования в интерактивной оболочке:

let run_with_memory_limit (limit : int) (f : unit -> 'a) : 'a =
  let limit_memory () =
    let mem = Gc.(quick_stat ()).heap_words in
    if mem / (1024 * 1024) > limit / (Sys.word_size / 8) then
      raise Out_of_memory
  in
  let alarm = Gc.create_alarm limit_memory in
  Fun.protect f ~finally:(fun () -> Gc.delete_alarm alarm ; Gc.compact ())
   

delete_alarm a остановит вызовы функции, связанной с a. Повторный вызов delete_alarm a не имеет эффекта.