[Tarantool-patches] [PATCH luajit v3 2/2] misc: add Lua API for memory profiler
Sergey Kaplun
skaplun at tarantool.org
Mon Dec 28 05:05:37 MSK 2020
This patch introduces Lua API for LuaJIT memory profiler implemented in
the scope of the previous patch.
Profiler returns true value if started/stopped successfully,
returns nil on failure (plus an error message as a second result and a
system-dependent error code as a third result).
If LuaJIT is build without memory profiler both return `false`.
<lj_errmsg.h> have adjusted with three new errors
PROF_MISUSE/PROF_ISRUNNING/PROF_NOTRUNNING returned in case when
profiler has used incorrectly/started/stopped already correspondingly.
Part of tarantool/tarantool#5442
---
Changes in v3:
* Fixed lj_mem_new misuse.
* Moved buffer inside ctx.
* Codestyle fixes.
src/Makefile.dep | 5 +-
src/lib_misc.c | 166 +++++++++++++++++++++++++++++++++++++++++++++++
src/lj_errmsg.h | 7 ++
3 files changed, 176 insertions(+), 2 deletions(-)
diff --git a/src/Makefile.dep b/src/Makefile.dep
index 6813bc8..f367241 100644
--- a/src/Makefile.dep
+++ b/src/Makefile.dep
@@ -29,8 +29,9 @@ lib_jit.o: lib_jit.c lua.h luaconf.h lauxlib.h lualib.h lj_obj.h lj_def.h \
lj_vm.h lj_vmevent.h lj_lib.h luajit.h lj_libdef.h
lib_math.o: lib_math.c lua.h luaconf.h lauxlib.h lualib.h lj_obj.h \
lj_def.h lj_arch.h lj_lib.h lj_vm.h lj_libdef.h
-lib_misc.o: lib_misc.c lua.h luaconf.h lmisclib.h lj_obj.h lj_def.h lj_arch.h \
- lj_str.h lj_tab.h lj_lib.h lj_libdef.h
+lib_misc.o: lib_misc.c lua.h luaconf.h lmisclib.h lauxlib.h lj_obj.h \
+ lj_def.h lj_arch.h lj_str.h lj_tab.h lj_lib.h lj_gc.h lj_err.h \
+ lj_errmsg.h lj_memprof.h lj_wbuf.h lj_libdef.h
lib_os.o: lib_os.c lua.h luaconf.h lauxlib.h lualib.h lj_obj.h lj_def.h \
lj_arch.h lj_gc.h lj_err.h lj_errmsg.h lj_buf.h lj_str.h lj_lib.h \
lj_libdef.h
diff --git a/src/lib_misc.c b/src/lib_misc.c
index 6f7b9a9..619cfb7 100644
--- a/src/lib_misc.c
+++ b/src/lib_misc.c
@@ -8,13 +8,21 @@
#define lib_misc_c
#define LUA_LIB
+#include <stdio.h>
+#include <errno.h>
+
#include "lua.h"
#include "lmisclib.h"
+#include "lauxlib.h"
#include "lj_obj.h"
#include "lj_str.h"
#include "lj_tab.h"
#include "lj_lib.h"
+#include "lj_gc.h"
+#include "lj_err.h"
+
+#include "lj_memprof.h"
/* ------------------------------------------------------------------------ */
@@ -67,8 +75,166 @@ LJLIB_CF(misc_getmetrics)
#include "lj_libdef.h"
+/* ----- misc.memprof module ---------------------------------------------- */
+
+#define LJLIB_MODULE_misc_memprof
+
+/*
+** Yep, 8Mb. Tuned in order not to bother the platform with too often flushes.
+*/
+#define STREAM_BUFFER_SIZE (8 * 1024 * 1024)
+
+/* Structure given as ctx to memprof writer and on_stop callback. */
+struct memprof_ctx {
+ /* Output file stream for data. */
+ FILE *stream;
+ /* Profiled global_State for lj_mem_free at on_stop callback. */
+ global_State *g;
+ /* Buffer for data. */
+ uint8_t buf[STREAM_BUFFER_SIZE];
+};
+
+/*
+** Default buffer writer function.
+** Just call fwrite to the corresponding FILE.
+*/
+static size_t buffer_writer_default(const void **buf_addr, size_t len,
+ void *opt)
+{
+ struct memprof_ctx *ctx = opt;
+ FILE *stream = ctx->stream;
+ const void * const buf_start = *buf_addr;
+ const void *data = *buf_addr;
+ size_t write_total = 0;
+
+ lua_assert(len <= STREAM_BUFFER_SIZE);
+
+ for (;;) {
+ const size_t written = fwrite(data, 1, len - write_total, stream);
+
+ if (LJ_UNLIKELY(written == 0)) {
+ /* Re-tries write in case of EINTR. */
+ if (errno != EINTR) {
+ /* Will be freed as whole chunk later. */
+ *buf_addr = NULL;
+ return write_total;
+ }
+
+ errno = 0;
+ continue;
+ }
+
+ write_total += written;
+ lua_assert(write_total <= len);
+
+ if (write_total == len)
+ break;
+
+ data = (uint8_t *)data + (ptrdiff_t)written;
+ }
+
+ *buf_addr = buf_start;
+ return write_total;
+}
+
+/* Default on stop callback. Just close the corresponding stream. */
+static int on_stop_cb_default(void *opt, uint8_t *buf)
+{
+ struct memprof_ctx *ctx = opt;
+ FILE *stream = ctx->stream;
+ UNUSED(buf);
+ lj_mem_free(ctx->g, ctx, sizeof(*ctx));
+ return fclose(stream);
+}
+
+/* local started, err, errno = misc.memprof.start(fname) */
+LJLIB_CF(misc_memprof_start)
+{
+ struct lj_memprof_options opt = {0};
+ const char *fname = strdata(lj_lib_checkstr(L, 1));
+ struct memprof_ctx *ctx;
+ int memprof_status;
+
+ /*
+ ** FIXME: more elegant solution with ctx.
+ ** Throws in case of OOM.
+ */
+ ctx = lj_mem_new(L, sizeof(*ctx));
+ opt.ctx = ctx;
+ opt.buf = ctx->buf;
+ opt.writer = buffer_writer_default;
+ opt.on_stop = on_stop_cb_default;
+ opt.len = STREAM_BUFFER_SIZE;
+
+ ctx->g = G(L);
+ ctx->stream = fopen(fname, "wb");
+
+ if (ctx->stream == NULL) {
+ lj_mem_free(ctx->g, ctx, sizeof(*ctx));
+ return luaL_fileresult(L, 0, fname);
+ }
+
+ memprof_status = lj_memprof_start(L, &opt);
+
+ if (LJ_UNLIKELY(memprof_status != PROFILE_SUCCESS)) {
+ lj_mem_free(ctx->g, ctx, sizeof(*ctx));
+ switch (memprof_status) {
+ case PROFILE_ERRUSE:
+ lua_pushnil(L);
+ lua_pushstring(L, err2msg(LJ_ERR_PROF_MISUSE));
+ lua_pushinteger(L, EINVAL);
+ return 3;
+ case PROFILE_ERRRUN:
+ lua_pushnil(L);
+ lua_pushstring(L, err2msg(LJ_ERR_PROF_ISRUNNING));
+ lua_pushinteger(L, EINVAL);
+ return 3;
+ case PROFILE_ERRIO:
+ return luaL_fileresult(L, 0, fname);
+ default:
+ lua_assert(0);
+ return 0;
+ }
+ }
+ lua_pushboolean(L, 1);
+
+ return 1;
+}
+
+/* local stopped, err, errno = misc.memprof.stop() */
+LJLIB_CF(misc_memprof_stop)
+{
+ int status = lj_memprof_stop(L);
+ if (status != PROFILE_SUCCESS) {
+ switch (status) {
+ case PROFILE_ERRUSE:
+ lua_pushnil(L);
+ lua_pushstring(L, err2msg(LJ_ERR_PROF_MISUSE));
+ lua_pushinteger(L, EINVAL);
+ return 3;
+ case PROFILE_ERRRUN:
+ lua_pushnil(L);
+ lua_pushstring(L, err2msg(LJ_ERR_PROF_NOTRUNNING));
+ lua_pushinteger(L, EINVAL);
+ return 3;
+ case PROFILE_ERRIO:
+ return luaL_fileresult(L, 0, NULL);
+ default:
+ lua_assert(0);
+ return 0;
+ }
+ }
+ lua_pushboolean(L, 1);
+ return 1;
+}
+
+#include "lj_libdef.h"
+
+/* ------------------------------------------------------------------------ */
+
LUALIB_API int luaopen_misc(struct lua_State *L)
{
LJ_LIB_REG(L, LUAM_MISCLIBNAME, misc);
+ LJ_LIB_REG(L, LUAM_MISCLIBNAME ".memprof", misc_memprof);
return 1;
}
diff --git a/src/lj_errmsg.h b/src/lj_errmsg.h
index de7b867..bebe804 100644
--- a/src/lj_errmsg.h
+++ b/src/lj_errmsg.h
@@ -185,6 +185,13 @@ ERRDEF(FFI_NYIPACKBIT, "NYI: packed bit fields")
ERRDEF(FFI_NYICALL, "NYI: cannot call this C function (yet)")
#endif
+#if LJ_HASMEMPROF
+/* Profiler errors. */
+ERRDEF(PROF_MISUSE, "profiler misuse")
+ERRDEF(PROF_ISRUNNING, "profiler is running already")
+ERRDEF(PROF_NOTRUNNING, "profiler is not running")
+#endif
+
#undef ERRDEF
/* Detecting unused error messages:
--
2.28.0
More information about the Tarantool-patches
mailing list