aboutsummaryrefslogtreecommitdiffstats
path: root/util/gc.lua
diff options
context:
space:
mode:
authorMatthew Wild <mwild1@gmail.com>2020-06-15 14:16:10 +0100
committerMatthew Wild <mwild1@gmail.com>2020-06-15 14:16:10 +0100
commit9277a27ce4527ea17cebb9529f26203650d09056 (patch)
tree7168e8d3847c0cde1f2a83a4bda4eeaf6538a5df /util/gc.lua
parent047f03ec09c2707c9e7a0320353fecbd87a028a8 (diff)
downloadprosody-9277a27ce4527ea17cebb9529f26203650d09056.tar.gz
prosody-9277a27ce4527ea17cebb9529f26203650d09056.zip
util.gc: New module for configuring the Lua garbage collector
Diffstat (limited to 'util/gc.lua')
-rw-r--r--util/gc.lua50
1 files changed, 50 insertions, 0 deletions
diff --git a/util/gc.lua b/util/gc.lua
new file mode 100644
index 00000000..e02e85c4
--- /dev/null
+++ b/util/gc.lua
@@ -0,0 +1,50 @@
+local array = require "util.array";
+local set = require "util.set";
+
+local known_options = {
+ incremental = set.new { "mode", "threshold", "speed", "step_size" };
+ generational = set.new { "mode", "minor_threshold", "major_threshold" };
+};
+
+if _VERSION ~= "5.4" then
+ known_options.generational = nil;
+ known_options.incremental:remove("step_size");
+end
+
+local function configure(user, defaults)
+ local mode = user.mode or defaults.mode or "incremental";
+ if not known_options[mode] then
+ return nil, "GC mode not supported on ".._VERSION..": "..mode;
+ end
+
+ for k, v in pairs(user) do
+ if not known_options[mode]:contains(k) then
+ return nil, "Unknown GC parameter: "..k;
+ elseif k ~= "mode" and type(v) ~= "number" then
+ return nil, "parameter '"..k.."' should be a number";
+ end
+ end
+
+ if mode == "incremental" then
+ if _VERSION == "Lua 5.4" then
+ collectgarbage(mode,
+ user.threshold or defaults.threshold,
+ user.speed or defaults.speed,
+ user.step_size or defaults.step_size
+ );
+ else
+ collectgarbage("setpause", user.threshold or defaults.threshold);
+ collectgarbage("setstepmul", user.speed or defaults.speed);
+ end
+ elseif mode == "generational" then
+ collectgarbage(mode,
+ user.minor_threshold or defaults.minor_threshold,
+ user.major_threshold or defaults.major_threshold
+ );
+ end
+ return true;
+end
+
+return {
+ configure = configure;
+};