view util/gc.lua @ 14016:1df1782ccdfe

prosodyctl shell: Improve process exit codes This fixes a bug introduced in 3326c8a29a86 where prosodyctl shell would always exit with non-zero error codes, even on success. Now it will exit with 0 for success, or 1 if any errors were printed. It also updates the other exit codes in the shell command to help distinguish between different error cases. These are based on the sysexits.h codes, although it is not recommended to rely on that interface.
author Matthew Wild <mwild1@gmail.com>
date Fri, 19 Dec 2025 15:32:26 +0000
parents c9cc84bee17b
children
line wrap: on
line source

local set = require "prosody.util.set";

local known_options = {
	incremental = set.new { "mode", "threshold", "speed", "step_size" };
	generational = set.new { "mode", "minor_threshold", "major_threshold" };
};

if _VERSION == "Lua 5.5" then
	known_options.generational = set.new { "mode", "minor_multiplier", "minor_major_threshold", "major_minor_threshold"  };
elseif _VERSION ~= "Lua 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
			);
		elseif _VERSION == "Lua 5.5" then
			collectgarbage(mode);
			collectgarbage("param", "pause", user.threshold or defaults.threshold);
			collectgarbage("param", "stepmul", user.speed or defaults.speed);
			collectgarbage("param", "stepsize", 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
		if _VERSION == "Lua 5.4" then
			collectgarbage(mode,
				user.minor_threshold or defaults.minor_threshold,
				user.major_threshold or defaults.major_threshold
			);
		elseif _VERSION == "Lua 5.5" then
			collectgarbage(mode);
			collectgarbage("param", "minormul", user.minor_multiplier or defaults.minor_multiplier);
			collectgarbage("param", "majorminor", user.major_minor_threshold or defaults.major_minor_threshold);
			collectgarbage("param", "minormajor", user.minor_major_threshold or defaults.minor_major_threshold);
		end
	end
	return true;
end

return {
	configure = configure;
};