Zen

Translation

English
where ``FILENAME`` is the name of the binary file where profiling events are written.
77/850 · 85
English Russian Actions
LuaJIT memory profiler
Профилировщик памяти LuaJIT
Starting from version :doc:`2.7.1 </release/2.7.1>`, Tarantool has a built‑in module called ``misc.memprof`` that implements a LuaJIT memory profiler (which we will just call *the profiler* in this section). The profiler provides a memory allocation report that helps analyze Lua code and find the places that put the most pressure on the Lua garbage collector (GC).
В Tarantool, начиная с версии :doc:`2.7.1 </release/2.7.1>`, есть встроенный модуль ``misc.memprof``, реализующий профилировщик памяти LuaJIT (далее в разделе — *профилировщик*). Профилировщик предоставляет отчет об аллокации памяти, который помогает проанализовать Lua-код и выявить области наибольшей нагрузки на сборщик мусора на Lua.
Working with the profiler
Использование профилировщика
Usage of the profiler involves two steps:
Работа с профилировщиком состоит из двух этапов:
:ref:`Collecting <profiler_usage_get>` a binary profile of allocations, reallocations, and deallocations in memory related to Lua (further, *binary memory profile* or *binary profile* for short).
События аллокации, реаллокации и деаллокации в Lua :ref:`собираются <profiler_usage_get>` в бинарный профиль (далее по тексту — *бинарный профиль памяти* или просто *бинарный профиль*).
:ref:`Parsing <profiler_usage_parse>` the collected binary profile to get a human-readable profiling report.
Выполняется :ref:`парсинг <profiler_usage_parse>` собранного бинарного профиля. В результате формируется отчет о профилировании в удобном для чтения формате.
Collecting binary profile
Сбор бинарного профиля
To collect a binary profile for a particular part of the Lua code, you need to place this part between two ``misc.memprof`` functions, namely, ``misc.memprof.start()`` and ``misc.memprof.stop()``, and then execute the code under Tarantool.
Чтобы сформировать бинарный профиль для определенного участка кода на Lua, вставьте этот участок кода между функциями ``misc.memprof.start()`` и ``misc.memprof.stop()``, а затем выполните его в Tarantool.
Below is a chunk of Lua code named ``test.lua`` to illustrate this.
Для наглядности ниже приведен фрагмент кода на Lua под названием ``test.lua``.
-- Prevent allocations on traces.
jit.off()
local str, err = misc.memprof.start("memprof_new.bin")
-- Lua doesn't create a new frame to call string.rep, and all allocations
-- are attributed not to the append() function but to the parent scope.
local function append(str, rep)
return string.rep(str, rep)
end

local t = {}
for i = 1, 1e4 do
-- table.insert is the built-in function and all corresponding
-- allocations are reported in the scope of the main chunk.
table.insert(t,
append('q', i)
)
end
local stp, err = misc.memprof.stop()
-- Отключение аллокации на трассах
jit.off()
local str, err = misc.memprof.start("memprof_new.bin")
-- Lua не создает стековый фрейм для вызова string.rep,
-- поэтому все события аллокации
-- приписываются не функции append(), а родительской области
local function append(str, rep)
return string.rep(str, rep)
end

local t = {}
for i = 1, 1e4 do
-- table.insert — встроенная функция,
-- так что профилировщик включает все соответствующие ей
-- события аллокации в отчет по основной части кода
table.insert(t,
append('q', i)
)
end
local stp, err = misc.memprof.stop()
The Lua code for starting the profiler -- as in line 3 in the test.lua example above -- is:
В примере test.lua код для запуска профилировщика находится на строке 3:
local str, err = misc.memprof.start(FILENAME)
local str, err = misc.memprof.start(ИМЯ_ФАЙЛА)
where ``FILENAME`` is the name of the binary file where profiling events are written.
``ИМЯ_ФАЙЛА`` — имя бинарного файла, куда записываются профилируемые события.
If the operation fails, for example if it is not possible to open a file for writing or if the profiler is already running, ``misc.memprof.start()`` returns ``nil`` as the first result, an error-message string as the second result, and a system-dependent error code number as the third result. If the operation succeeds, ``misc.memprof.start()`` returns ``true``.
Если операция завершается ошибкой, функция ``misc.memprof.start()`` возвращает результат, состоящий из трех частей: ``nil``; строка с сообщением об ошибке; код ошибки в зависимости от системы. Ошибка может возникнуть, например, когда не открывается файл для записи или профилировщик уже запущен. Если операция выполняется успешно, ``misc.memprof.start()`` возвращает ``true``.
The Lua code for stopping the profiler -- as in line 18 in the test.lua example above -- is:
В примере test.lua код для остановки профилировщика находится на строке 18:
local stp, err = misc.memprof.stop()
local stp, err = misc.memprof.stop()
If the operation fails, for example if there is an error when the file descriptor is being closed or if there is a failure during reporting, ``misc.memprof.stop()`` returns ``nil`` as the first result, an error-message string as the second result, and a system-dependent error code number as the third result. If the operation succeeds, ``misc.memprof.stop()`` returns ``true``.
Если операция завершается ошибкой, функция ``misc.memprof.stop()`` возвращает результат, состоящий из трех частей: ``nil``; строка с сообщением об ошибке; код ошибки в зависимости от системы. Ошибка может возникнуть, например, когда закрыт файловый дескриптор или во время составления отчета происходит сбой. Если операция выполняется успешно, ``misc.memprof.stop()`` возвращает ``true``.
To generate the file with memory profile in binary format (in the :ref:`test.lua code example above <profiler_usage_example01>` the file name is ``memprof_new.bin``), execute the code under Tarantool:
Теперь нужно сгенерировать файл с профилем памяти в бинарном формате. В :ref:`примере test.lua <profiler_usage_example01>` имя файла — ``memprof_new.bin``. Выполните код в Tarantool:
$ tarantool test.lua
$ tarantool test.lua
Tarantool collects the allocation events in ``memprof_new.bin``, puts the file in its :ref:`working directory <cfg_basic-work_dir>`, and closes the session.
Tarantool собирает события аллокации в файл ``memprof_new.bin``, помещает его в :ref:`рабочую директорию <cfg_basic-work_dir>` и завершает сеанс.
The :ref:`test.lua code example <profiler_usage_example01>` above also illustrates the memory allocation logic in some cases that are important to understand for :ref:`reading <profiler_usage_parse>` and :ref:`analyzing <profiler_analysis>` a profiling report:
:ref:`Пример test.lua <profiler_usage_example01>` также иллюстрирует логику, по которой в некоторых случаях происходит аллокация памяти. Важно понимать эту логику, чтобы :ref:`читать <profiler_usage_parse>` и :ref:`анализировать <profiler_analysis>` отчеты о профилировании.
Line 2: It is recommended to switch the JIT compilation off by calling ``jit.off()`` before the profiler start. Refer to the following :ref:`note about jitoff <profiler_usage_internal_jitoff>` for more details.
Строка 2: Рекомендуется отключать JIT-компиляцию, вызывая ``jit.off()`` перед запуском профилировщика. За дополнительными сведениями обратитесь к :ref:`примечанию о jitoff <profiler_usage_internal_jitoff>`.
Lines 6-8: Tail call optimization doesn't create a new call frame, so all allocations inside the function called via the ``CALLT/CALLMT`` `bytecodes <http://wiki.luajit.org/Bytecode-2.0#calls-and-vararg-handling>`_ are attributed to the function's caller. See also the comments preceding these lines.
Строки 6–8: Оптимизация хвостового вызова не создает новый фрейм стека вызовов, поэтому все события аллокации в `байт-коде <http://wiki.luajit.org/Bytecode-2.0#calls-and-vararg-handling>`_ ``CALLT/CALLMT`` относятся на счет кода, вызывающего эту функцию. Обратите внимание на комментарии перед этими строками.
Lines 14-16: Usually the information about allocations inside Lua built‑ins is not really useful for developers. That's why if a Lua built‑in function is called from a Lua function, the profiler attributes all allocations to the Lua function. Otherwise, this event is attributed to a C function. See also the comments preceding these lines.
Строки 14–16: Как правило, разработчиков несильно интересует информация об аллокации во встроенных функциях LuaJIT. Поэтому если встроенная функция вызывается из функции на Lua, профилировщик собирает все события аллокации для функции на Lua. В противном случае событие относится к функции на C. Обратите внимание на комментарии перед этими строками.
Parsing binary profile and generating profiling report
Парсинг бинарного профиля и формирование отчета о профилировании
After getting the memory profile in binary format, the next step is to parse it to get a human-readable profiling report. You can do this via Tarantool by using the following command (mind the hyphen ``-`` before the filename):
Получив профиль памяти в двоичном формате, нужно выполнить парсинг, чтобы отчет было удобно читать. Парсинг можно выполнить в Tarantool, воспользовавшись следующей командой (обратите внимание на дефис ``-`` перед именем файла):
$ tarantool -e 'require("memprof")(arg)' - memprof_new.bin
$ tarantool -e 'require("memprof")(arg)' - memprof_new.bin
where ``memprof_new.bin`` is the binary profile :ref:`generated earlier <profiler_usage_generate>` by ``tarantool test.lua``. (Warning: there is a slight behavior change here, the ``tarantool -e ...`` command was slightly different in Tarantool versions prior to Tarantool 2.8.1.)
Здесь ``memprof_new.bin`` — бинарный профиль, :ref:`ранее сгенерированный <profiler_usage_generate>` командой ``tarantool test.lua``. (Внимание: в версии Tarantool 2.8.1 поведение команды ``tarantool -e`` немного изменилось.)

Loading…

User avatar None

String updated in the repository

testing_project / Documentation: reference/tooling/luajit_memprof — Russian

where ``FILENAME`` is the name of the binary file where profiling events are written.
``ИМЯ_ФАЙЛА`` — имя бинарного файла, куда записываются профилируемые события.
a year ago
Browse all string changes

Things to check

Reused translation

Other source string: “``FILENAME``—the name of the binary file where profiling events are written”

Reset

Glossary

English Russian
No related strings found in the glossary.

String information

String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
locale/ru/LC_MESSAGES/reference/tooling/luajit_memprof.po, string 13