settings.lua

#!/usr/bin/env lua

--[[
    settings.lua: settings for sqm-autorate.lua

    Copyright (C) 2022
        Nils Andreas Svee mailto:contact@lochnair.net (github @Lochnair)
        Daniel Lakeland mailto:dlakelan@street-artists.org (github @dlakelan)
        Mark Baker mailto:mark@vpost.net (github @Fail-Safe)
        Charles Corrigan mailto:chas-iot@runegate.org (github @chas-iot)

    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at https://mozilla.org/MPL/2.0/.
]]
--
-- gets the external settings for sqm-autorate.lua
-- OpenWRT uci settings take priority, then command line arguments, finally environment variables

-- the module to be exported
local M = {}

local os = require 'os'
local util = require 'utility'

local app_version = ""
local plugin_ratecontrol = nil

-- print all of the module exported values, ignoring functions
local function print_all()
    local tmp_tbl = {}
    local name_max = 0
    local value_max = 0
    local type_max = 0
    for name, value in pairs(M) do
        if type(name) == "boolean" or type(name) == "number" then
            name = tostring(name)
        end

        local type_name = type(value)
        if type_name == "nil" then
            value = "nil"
        elseif type_name == "boolean" or type_name == "number" then
            value = tostring(value)
        elseif type_name == "table" or type_name == "function" then
            if name == "log_level" then
                value = util.get_loglevel_name()
            elseif name == "plugin_ratecontrol" and plugin_ratecontrol then
                value = plugin_ratecontrol.name
            else
                value = ""
            end
        end

        if #name > name_max then
            name_max = #name
        end

        if #value > value_max then
            value_max = #value
        end

        if type_name ~= "function" then
            tmp_tbl[#tmp_tbl + 1] = { name = name, value = value, type = type_name }
            if #type_name > type_max then
                type_max = #type_name
            end
        end
    end

    table.sort(tmp_tbl, function(a, b) return a.name < b.name end)

    local function pad(s, l, c)
        if c == nil then
            c = " "
        end
        return s .. string.rep(c, l - #s)
    end

    local string_tbl = {}
    string_tbl[1] = "\n> Internal Settings - Version " .. app_version .. " <"
    string_tbl[2] = pad("", name_max + 2, "-") .. pad("", value_max + 2, "-") .. pad("", type_max, "-")
    for i = 1, #tmp_tbl do
        string_tbl[#string_tbl + 1] = string.format("%s: %s (%s)", pad(tmp_tbl[i].name, name_max),
            pad(tmp_tbl[i].value, value_max), tmp_tbl[i].type)
    end

    string_tbl[#string_tbl + 1] = "--"
    print(table.concat(string_tbl, "\n        "))
end

local function load_reflector_list(file_path, ip_version)
    ip_version = ip_version or "4"

    local reflector_file = io.open(file_path)
    if not reflector_file then
        util.logger(util.loglevel.FATAL, "Could not open reflector file: '" .. file_path)
        os.exit(1, true)
    end

    local reflectors = {}
    local lines = reflector_file:lines()
    for line in lines do
        local tokens = {}
        for token in string.gmatch(line, "([^,]+)") do -- Split the line on commas
            tokens[#tokens + 1] = token
        end
        local ip = tokens[1]
        local vers = tokens[2]
        if ip_version == "46" or ip_version == "both" or ip_version == "all" then
            reflectors[#reflectors + 1] = ip
        elseif vers == ip_version then
            reflectors[#reflectors + 1] = ip
        end
    end
    return reflectors
end

-- a stub for plugins to retrieve their UCI settings
--  parameters
--      plugin      - the name of the plugin. Do change '-' to '_' to avoid breaking UCI
--  returns
--      uci         - a table of UCI option values
--
function M.plugin(_)
    return {}
end

-- initialises the settings
--  parameters
--      requires    - a table of modules already setup. This module depends on lanes, math, and the utilities
--      version     - the program version string
--  returns
--      M           - the module itself
--
function M.initialise(requires, version, arg_reflector_data)
    if version == nil then
        app_version = "version is not set, likely a programming error"
    else
        app_version = version
    end

    local reflector_data = assert(arg_reflector_data, 'linda for reflector data required')

    local lanes = requires.lanes
    if lanes == nil then
        if util.logger then
            util.logger(util.loglevel.FATAL, "programming error. Please inform developers that 'lanes' is missing")
        else
            print "FATAL programming error. Please inform programmers that 'logger' and 'lanes' are missing"
        end
        os.exit(1, true)
    end

    local math = requires.math
    local min = math.min
    local max = math.max
    local floor = math.floor
    local function limit(value, lowest, highest)
        return min(max(value, lowest), highest)
    end

    -- Figure out if we are running on OpenWrt here and load uci if available...
    local uci_lib
    local uci_settings
    if util.is_module_available("uci") then
        uci_lib = require("uci")
        uci_settings = uci_lib.cursor()

        M.plugin = function(plugin_name)
            return uci_settings:get_all("sqm-autorate", "@" .. plugin_name .. "[0]")
        end
    else
        util.logger(util.loglevel.WARN, "did not find uci library")
    end

    -- Try to load argparse if it's installed
    local args = nil
    if util.is_module_available("argparse") then
        local argparse = require "argparse"
        if argparse then
            local parser = argparse("sqm-autorate.lua", "CAKE with Adaptive Bandwidth - 'autorate'",
                "For more info, please visit: https://github.com/sqm-autorate/sqm-autorate")

            parser:option("--upload-interface --ul", "the device name of the upload interface; no default")
            parser:option("--download-interface --dl", "the device name of the download interface; no default")
            parser:option("--upload-base-kbits --ub", "the expected consistent rate in kbit/s of the upload " ..
                "interface; default 10000")
            parser:option("--download-base-kbits --db", "the expected consistent rate in kbit/s of the download " ..
                "interface; default 10000")
            parser:option("--upload-min-percent --up", "the worst case tolerable percentage of the kbits of the " ..
                "upload rate; range 10 to 75; default=20")
            parser:option("--download-min-percent --dp", "the worst case tolerable percentage of the kbits of the " ..
                "upload rate; range 10 to 75; default=20")
            parser:option("--upload-delay-ms --ud", "the tolerable additional delay on upload in ms; default 15")
            parser:option("--download-delay-ms --dd", "the tolerable additional delay on download in ms; default 15")
            parser:option("--log-level --ll", "the verbosity of the messages in the log file; TRACE, DEBUG, INFO, " ..
                "WARN, ERROR, FATAL; default INFO")
            parser:option("--stats-file", "the location of the output stats file; default /tmp/sqm-autorate.csv")
            parser:option("--speed-hist-file", "the location of the output speed history file; default " ..
                "/tmp/sqm-speedhist.csv")
            parser:option("--speed-hist-size", "the number of usable speeds to keep in the history; default 100")
            parser:option("--high-load-level", "the relative load ratio considered high for rate change purposes; " ..
                "range 0.67 to 0.95; default 0.8")
            parser:option("--reflector-type", "not yet operable; default icmp")
            parser:option("--plugin-ratecontrol", "load a named plugin into ratecontrol")

            parser:flag("--suppress-statistics --no-statistics --ns", "suppress output to the statistics files; " ..
                "default output statistics")

            parser:flag("-v --version", "Displays the SQM Autorate version.")
            parser:flag("-s --show-settings", "shows all of the settings values after initialisation")

            args = parser:parse()
        end
    end

    do
        local upload_interface = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "upload_interface")
        upload_interface = upload_interface or (args and args.upload_interface)
        upload_interface = upload_interface or (os.getenv("SQMA_UPLOAD_INTERFACE"))
        M.ul_if = upload_interface

        local download_interface = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "download_interface")
        download_interface = download_interface or (args and args.download_interface)
        download_interface = download_interface or (os.getenv("SQMA_DOWNLOAD_INTERFACE"))
        M.dl_if = download_interface

        if upload_interface == nil or download_interface == nil then
            util.logger(util.loglevel.FATAL,
                "No interfaces found, please check the settings for 'upload_interface' and 'download_interface'")
            os.exit(1, true)
        end
    end

    do
        local upload_base_kbits = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "upload_base_kbits")
        upload_base_kbits = upload_base_kbits or (args and args.upload_base_kbits)
        upload_base_kbits = upload_base_kbits or os.getenv("SQMA_UPLOAD_BASE_KBITS")
        M.base_ul_rate = floor(tonumber(upload_base_kbits)) or 10000
    end

    do
        local download_base_kbits = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "download_base_kbits")
        download_base_kbits = download_base_kbits or (args and args.download_base_kbits)
        download_base_kbits = download_base_kbits or (os.getenv("SQMA_DOWNLOAD_BASE_KBITS"))
        M.base_dl_rate = floor(tonumber(download_base_kbits)) or 10000
    end

    do
        local upload_min_percent = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "upload_min_percent")
        upload_min_percent = upload_min_percent or (args and args.upload_min_percent)
        upload_min_percent = upload_min_percent or (os.getenv("SQMA_UPLOAD_MIN_PERCENT"))
        if upload_min_percent == nil then
            M.min_ul_rate = floor(M.base_ul_rate / 5) -- 20%
        else
            upload_min_percent = limit(tonumber(upload_min_percent), 10, 75)
            M.min_ul_rate = floor(M.base_ul_rate * upload_min_percent / 100)
        end
    end

    do
        local download_min_percent = uci_settings and uci_settings:get("sqm-autorate", "@network[0]",
            "download_min_percent")
        download_min_percent = download_min_percent or (args and args.download_min_percent)
        download_min_percent = download_min_percent or (os.getenv("SQMA_DOWNLOAD_MIN_PERCENT"))
        if download_min_percent == nil then
            M.min_dl_rate = floor(M.base_dl_rate / 5) -- 20%
        else
            download_min_percent = limit(tonumber(download_min_percent), 10, 75)
            M.min_dl_rate = floor(M.base_dl_rate * download_min_percent / 100)
        end
    end

    do
        local stats_file = uci_settings and uci_settings:get("sqm-autorate", "@output[0]", "stats_file")
        stats_file = stats_file or (args and args.stats_file)
        stats_file = stats_file or (os.getenv("SQMA_STATS_FILE"))
        if stats_file == nil then
            stats_file = "/tmp/sqm-autorate.csv"
        end
        M.stats_file = stats_file
    end

    do
        local speed_hist_file = uci_settings and uci_settings:get("sqm-autorate", "@output[0]", "speed_hist_file")
        speed_hist_file = speed_hist_file or (args and args.speed_hist_file)
        speed_hist_file = speed_hist_file or (os.getenv("SQMA_SPEED_HIST_FILE"))
        if speed_hist_file == nil then
            speed_hist_file = "/tmp/sqm-speedhist.csv"
        end
        M.speedhist_file = speed_hist_file
    end

    do
        local log_level = uci_settings and uci_settings:get("sqm-autorate", "@output[0]", "log_level")
        log_level = log_level or (args and args.log_level)
        log_level = log_level or (os.getenv("SQMA_LOG_LEVEL"))
        if log_level == nil then
            log_level = "INFO"
        end
        log_level = string.upper(log_level)
        util.set_loglevel(log_level)
        M.log_level = util.get_loglevel()
    end

    do
        local speed_hist_size = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
            "speed_hist_size")
        speed_hist_size = speed_hist_size or (args and args.speed_hist_size)
        speed_hist_size = speed_hist_size or (os.getenv("SQMA_SPEED_HIST_SIZE"))
        if speed_hist_size == nil then
            speed_hist_size = "100"
        end
        M.histsize = floor(tonumber(speed_hist_size))
    end

    do
        local upload_delay_ms = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
            "upload_delay_ms")
        upload_delay_ms = upload_delay_ms or (args and args.upload_delay_ms)
        upload_delay_ms = upload_delay_ms or (os.getenv("SQMA_UPLOAD_DELAY_MS"))
        if upload_delay_ms == nil then
            upload_delay_ms = "15"
        end
        M.ul_max_delta_owd = tonumber(upload_delay_ms)
    end

    do
        local download_delay_ms = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
            "download_delay_ms")
        download_delay_ms = download_delay_ms or (args and args.download_delay_ms)
        download_delay_ms = download_delay_ms or (os.getenv("SQMA_DOWNLOAD_DELAY_MS"))
        if download_delay_ms == nil then
            download_delay_ms = "15"
        end
        M.dl_max_delta_owd = tonumber(download_delay_ms)
    end

    do
        local high_load_level = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
            "high_load_level")
        high_load_level = high_load_level or (args and args.high_load_level)
        high_load_level = high_load_level or (os.getenv("SQMA_HIGH_LEVEL_LOAD"))
        if high_load_level == nil then
            high_load_level = "0.8"
        end
        M.high_load_level = limit(tonumber(high_load_level), 0.67, 0.95)
    end

    do
        local rate_controller = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
            "rate_controller")
        rate_controller = rate_controller or (args and args.rate_controller)
        rate_controller = rate_controller or (os.getenv("SQMA_RATE_CONTROLLER"))
        if rate_controller == nil then
            rate_controller = "ewma"
        end
        M.rate_controller = rate_controller
    end

    do
        -- !! not supported yet, so always override !!
        -- local reflector_type = uci_settings and uci_settings:get("sqm-autorate", "@advanced_settings[0]",
        --    "reflector_type")
        -- reflector_type = reflector_type or ( args and args.reflector_type )
        -- reflector_type = reflector_type or ( os.getenv("SQMA_REFLECTOR_TYPE") )

        -- if reflector_type == nil then
        local reflector_type = "icmp"
        -- end
        M.reflector_type = reflector_type
    end

    do
        local suppress_statistics
        if uci_settings then
            suppress_statistics = tostring(uci_settings:get("sqm-autorate", "@output[0]", "suppress_statistics"))
            if suppress_statistics then
                suppress_statistics = suppress_statistics == "1" or
                    string.lower(suppress_statistics) == "true" or
                    string.lower(suppress_statistics) == "yes" or
                    string.lower(suppress_statistics) == "y"
            end
        end
        suppress_statistics = suppress_statistics or (args and args.suppress_statistics)
        if not suppress_statistics then
            suppress_statistics = tostring(os.getenv("SQMA_SUPPRESS_STATISTICS"))
            suppress_statistics = suppress_statistics == "1" or
                string.lower(suppress_statistics) == "true" or
                string.lower(suppress_statistics) == "yes" or
                string.lower(suppress_statistics) == "y"
        end
        M.output_statistics = not suppress_statistics
    end

    M.enable_verbose_baseline_output =
        util.get_loglevel_name() == "TRACE" or
        util.get_loglevel_name() == "DEBUG"

    M.tick_duration = 0.5       -- Frequency in seconds
    M.min_change_interval = 0.5 -- don't change speeds unless this many seconds has passed since last change

    M.reflector_list_icmp = "/usr/lib/sqm-autorate/reflectors-icmp.csv"
    M.reflector_list_udp = "/usr/lib/sqm-autorate/reflectors-udp.csv"

    -- Load up the reflectors temp table
    local tmp_reflectors = {}
    if M.reflector_type == "icmp" then
        tmp_reflectors = load_reflector_list(M.reflector_list_icmp, "4")
    elseif M.reflector_type == "udp" then
        tmp_reflectors = load_reflector_list(M.reflector_list_udp, "4")
    else
        util.logger(util.loglevel.FATAL, "Unknown reflector type specified: " .. M.reflector_type)
        os.exit(1, true)
    end

    -- Load up the reflectors shared tables
    -- seed the peers with a set of "good candidates", we will adjust using the peer selector through time
    reflector_data:set("reflector_tables", {
        peers = { "9.9.9.9", "8.238.120.14", "74.82.42.42", "194.242.2.2", "208.67.222.222", "94.140.14.14" },
        pool = tmp_reflectors
    })

    -- Number of reflector peers to use from the pool
    M.num_reflectors = 5

    -- Time (in minutes) before re-selection of peers from the pool
    M.peer_reselection_time = 15

    -- Only perform plugin initialization after all core settings have established values in this module
    do
        plugin_ratecontrol = uci_settings and uci_settings:get("sqm-autorate", "@plugins[0]", "ratecontrol")
        plugin_ratecontrol = plugin_ratecontrol or (args and args.plugin_ratecontrol)
        plugin_ratecontrol = plugin_ratecontrol or (os.getenv("SQMA_PLUGIN_RATECONTROL"))

        if plugin_ratecontrol then
            if util.is_module_available(plugin_ratecontrol) then
                plugin_ratecontrol = require(plugin_ratecontrol).initialise(requires, M)
                requires.plugin_ratecontrol = plugin_ratecontrol
                M.plugin_ratecontrol = plugin_ratecontrol
            else
                util.logger(util.loglevel.ERROR, "Could not find configured plugin: " .. plugin_ratecontrol)
            end
        end
    end
    M.plugin_ratecontrol = plugin_ratecontrol

    if args and (args.version or args.show_settings) then
        if args.version then print("Version " .. app_version) end
        if args.show_settings then print_all() end
        os.exit(0, true)
    end

    return M
end

return M