2 -- SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 -- Copyright (c) 2015 Pedro Souza <pedrosouza@freebsd.org>
5 -- Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
6 -- All rights reserved.
8 -- Redistribution and use in source and binary forms, with or without
9 -- modification, are permitted provided that the following conditions
11 -- 1. Redistributions of source code must retain the above copyright
12 -- notice, this list of conditions and the following disclaimer.
13 -- 2. Redistributions in binary form must reproduce the above copyright
14 -- notice, this list of conditions and the following disclaimer in the
15 -- documentation and/or other materials provided with the distribution.
17 -- THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 -- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 -- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 -- ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 -- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 -- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 -- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 -- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 -- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 -- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 local hook = require("hook")
36 local carousel_choices = {}
37 -- Which variables we changed
38 local env_changed = {}
39 -- Values to restore env to (nil to unset)
40 local env_restore = {}
42 local MSG_FAILDIR = "Failed to load conf dir '%s': not a directory"
43 local MSG_FAILEXEC = "Failed to exec '%s'"
44 local MSG_FAILSETENV = "Failed to '%s' with value: %s"
45 local MSG_FAILOPENCFG = "Failed to open config: '%s'"
46 local MSG_FAILREADCFG = "Failed to read config: '%s'"
47 local MSG_FAILPARSECFG = "Failed to parse config: '%s'"
48 local MSG_FAILPARSEVAR = "Failed to parse variable '%s': %s"
49 local MSG_FAILEXBEF = "Failed to execute '%s' before loading '%s'"
50 local MSG_FAILEXAF = "Failed to execute '%s' after loading '%s'"
51 local MSG_MALFORMED = "Malformed line (%d):\n\t'%s'"
52 local MSG_DEFAULTKERNFAIL = "No kernel set, failed to load from module_path"
53 local MSG_KERNFAIL = "Failed to load kernel '%s'"
54 local MSG_XENKERNFAIL = "Failed to load Xen kernel '%s'"
55 local MSG_XENKERNLOADING = "Loading Xen kernel..."
56 local MSG_KERNLOADING = "Loading kernel..."
57 local MSG_MODLOADING = "Loading configured modules..."
58 local MSG_MODBLACKLIST = "Not loading blacklisted module '%s'"
60 local MSG_FAILSYN_QUOTE = "Stray quote at position '%d'"
61 local MSG_FAILSYN_EOLESC = "Stray escape at end of line"
62 local MSG_FAILSYN_EOLVAR = "Unescaped $ at end of line"
63 local MSG_FAILSYN_BADVAR = "Malformed variable expression at position '%d'"
65 local MODULEEXPR = '([-%w_]+)'
66 local QVALEXPR = '"(.*)"'
67 local QVALREPL = QVALEXPR:gsub('%%', '%%%%')
68 local WORDEXPR = "([-%w%d][-%w%d_.]*)"
69 local WORDREPL = WORDEXPR:gsub('%%', '%%%%')
71 -- Entries that should never make it into the environment; each one should have
72 -- a documented reason for its existence, and these should all be implementation
73 -- details of the config module.
74 local loader_env_restricted_table = {
75 -- loader_conf_files should be considered write-only, and consumers
76 -- should not rely on any particular value; it's a loader implementation
77 -- detail. Moreover, it's not a particularly useful variable to have in
78 -- the kenv. Save the overhead, let it get fetched other ways.
79 loader_conf_files = true,
82 local function restoreEnv()
83 -- Examine changed environment variables
84 for k, v in pairs(env_changed) do
85 local restore_value = env_restore[k]
86 if restore_value == nil then
87 -- This one doesn't need restored for some reason
90 local current_value = loader.getenv(k)
91 if current_value ~= v then
92 -- This was overwritten by some action taken on the menu
93 -- most likely; we'll leave it be.
96 restore_value = restore_value.value
97 if restore_value ~= nil then
98 loader.setenv(k, restore_value)
109 -- XXX This getEnv/setEnv should likely be exported at some point. We can save
110 -- the call back into loader.getenv for any variable that's been set or
111 -- overridden by any loader.conf using this implementation with little overhead
112 -- since we're already tracking the values.
113 local function getEnv(key)
114 if loader_env_restricted_table[key] ~= nil or
115 env_changed[key] ~= nil then
116 return env_changed[key]
119 return loader.getenv(key)
122 local function setEnv(key, value)
123 env_changed[key] = value
125 if loader_env_restricted_table[key] ~= nil then
129 -- Track the original value for this if we haven't already
130 if env_restore[key] == nil then
131 env_restore[key] = {value = loader.getenv(key)}
134 return loader.setenv(key, value)
137 -- name here is one of 'name', 'type', flags', 'before', 'after', or 'error.'
138 -- These are set from lines in loader.conf(5): ${key}_${name}="${value}" where
139 -- ${key} is a module name.
140 local function setKey(key, name, value)
141 if modules[key] == nil then
144 modules[key][name] = value
147 -- Escapes the named value for use as a literal in a replacement pattern.
148 -- e.g. dhcp.host-name gets turned into dhcp%.host%-name to remove the special
150 local function escapeName(name)
151 return name:gsub("([%p])", "%%%1")
154 local function processEnvVar(value)
155 local pval, vlen = '', #value
156 local nextpos, vdelim, vinit = 1
163 local c = value:sub(i, i)
166 return nil, MSG_FAILSYN_EOLESC
169 pval = pval .. value:sub(i + 1, i + 1)
171 return nil, MSG_FAILSYN_QUOTE:format(i)
174 return nil, MSG_FAILSYN_EOLVAR
176 if value:sub(i + 1, i + 1) == "{" then
185 vpat = "^([%w][-%w%d_.]*)"
188 local name = value:match(vpat, vinit)
190 return nil, MSG_FAILSYN_BADVAR:format(i)
192 nextpos = vinit + #name
194 nextpos = nextpos + 1
197 local repl = loader.getenv(name) or ""
210 local function checkPattern(line, pattern)
211 local function _realCheck(_line, _pattern)
212 return _line:match(_pattern)
215 if pattern:find('$VALUE') then
217 k, v, c = _realCheck(line, pattern:gsub('$VALUE', QVALREPL))
221 return _realCheck(line, pattern:gsub('$VALUE', WORDREPL))
223 return _realCheck(line, pattern)
227 -- str in this table is a regex pattern. It will automatically be anchored to
228 -- the beginning of a line and any preceding whitespace will be skipped. The
229 -- pattern should have no more than two captures patterns, which correspond to
230 -- the two parameters (usually 'key' and 'value') that are passed to the
231 -- process function. All trailing characters will be validated. Any $VALUE
232 -- token included in a pattern will be tried first with a quoted value capture
233 -- group, then a single-word value capture group. This is our kludge for Lua
234 -- regex not supporting branching.
236 -- We have two special entries in this table: the first is the first entry,
237 -- a full-line comment. The second is for 'exec' handling. Both have a single
238 -- capture group, but the difference is that the full-line comment pattern will
239 -- match the entire line. This does not run afoul of the later end of line
240 -- validation that we'll do after a match. However, the 'exec' pattern will.
241 -- We document the exceptions with a special 'groups' index that indicates
242 -- the number of capture groups, if not two. We'll use this later to do
243 -- validation on the proper entry.
245 local pattern_table = {
248 process = function(_, _) end,
251 -- module_load="value"
253 str = MODULEEXPR .. "_load%s*=%s*$VALUE",
254 process = function(k, v)
255 if modules[k] == nil then
258 modules[k].load = v:upper()
259 setEnv(k .. "_load", v:upper())
262 -- module_name="value"
264 str = MODULEEXPR .. "_name%s*=%s*$VALUE",
265 process = function(k, v)
267 setEnv(k .. "_name", v)
270 -- module_type="value"
272 str = MODULEEXPR .. "_type%s*=%s*$VALUE",
273 process = function(k, v)
275 setEnv(k .. "_type", v)
278 -- module_flags="value"
280 str = MODULEEXPR .. "_flags%s*=%s*$VALUE",
281 process = function(k, v)
282 setKey(k, "flags", v)
283 setEnv(k .. "_flags", v)
286 -- module_before="value"
288 str = MODULEEXPR .. "_before%s*=%s*$VALUE",
289 process = function(k, v)
290 setKey(k, "before", v)
291 setEnv(k .. "_before", v)
294 -- module_after="value"
296 str = MODULEEXPR .. "_after%s*=%s*$VALUE",
297 process = function(k, v)
298 setKey(k, "after", v)
299 setEnv(k .. "_after", v)
302 -- module_error="value"
304 str = MODULEEXPR .. "_error%s*=%s*$VALUE",
305 process = function(k, v)
306 setKey(k, "error", v)
307 setEnv(k .. "_error", v)
312 str = "exec%s*=%s*" .. QVALEXPR,
313 process = function(k, _)
314 if cli_execute_unparsed(k) ~= 0 then
315 print(MSG_FAILEXEC:format(k))
320 -- env_var="value" or env_var=[word|num]
322 str = "([%w][%w%d-_.]*)%s*=%s*$VALUE",
323 process = function(k, v)
324 local pv, msg = processEnvVar(v)
326 print(MSG_FAILPARSEVAR:format(k, msg))
329 if setEnv(k, pv) ~= 0 then
330 print(MSG_FAILSETENV:format(k, v))
336 local function isValidComment(line)
338 local s = line:match("^%s*#.*")
340 s = line:match("^%s*$")
349 local function getBlacklist()
351 local blacklist_str = loader.getenv('module_blacklist')
352 if blacklist_str == nil then
356 for mod in blacklist_str:gmatch("[;, ]?([-%w_]+)[;, ]?") do
357 blacklist[mod] = true
362 local function loadModule(mod, silent)
364 local blacklist = getBlacklist()
366 for k, v in pairs(mod) do
367 if v.load ~= nil and v.load:lower() == "yes" then
368 local module_name = v.name or k
369 if not v.force and blacklist[module_name] ~= nil then
371 print(MSG_MODBLACKLIST:format(module_name))
376 loader.printc(module_name .. "...")
379 if v.type ~= nil then
380 str = str .. "-t " .. v.type .. " "
382 str = str .. module_name
383 if v.flags ~= nil then
384 str = str .. " " .. v.flags
386 if v.before ~= nil then
387 pstatus = cli_execute_unparsed(v.before) == 0
388 if not pstatus and not silent then
389 print(MSG_FAILEXBEF:format(v.before, k))
391 status = status and pstatus
394 if cli_execute_unparsed(str) ~= 0 then
395 -- XXX Temporary shim: don't break the boot if
396 -- loader hadn't been recompiled with this
398 if loader.command_error then
399 print(loader.command_error())
404 if v.error ~= nil then
405 cli_execute_unparsed(v.error)
408 elseif v.after ~= nil then
409 pstatus = cli_execute_unparsed(v.after) == 0
410 if not pstatus and not silent then
411 print(MSG_FAILEXAF:format(v.after, k))
416 status = status and pstatus
425 local function readFile(name, silent)
426 local f = io.open(name)
429 print(MSG_FAILOPENCFG:format(name))
434 local text, _ = io.read(f)
435 -- We might have read in the whole file, this won't be needed any more.
438 if text == nil and not silent then
439 print(MSG_FAILREADCFG:format(name))
444 local function checkNextboot()
445 local nextboot_file = loader.getenv("nextboot_conf")
446 local nextboot_enable = loader.getenv("nextboot_enable")
448 if nextboot_file == nil then
452 -- is nextboot_enable set in nvstore?
453 if nextboot_enable == "NO" then
457 local text = readFile(nextboot_file, true)
462 if nextboot_enable == nil and
463 text:match("^nextboot_enable=\"NO\"") ~= nil then
464 -- We're done; nextboot is not enabled
468 if not config.parse(text) then
469 print(MSG_FAILPARSECFG:format(nextboot_file))
472 -- Attempt to rewrite the first line and only the first line of the
473 -- nextboot_file. We overwrite it with nextboot_enable="NO", then
474 -- check for that on load.
475 -- It's worth noting that this won't work on every filesystem, so we
476 -- won't do anything notable if we have any errors in this process.
477 local nfile = io.open(nextboot_file, 'w')
479 -- We need the trailing space here to account for the extra
480 -- character taken up by the string nextboot_enable="YES"
481 -- Or new end quotation mark lands on the S, and we want to
482 -- rewrite the entirety of the first line.
483 io.write(nfile, "nextboot_enable=\"NO\" ")
486 loader.setenv("nextboot_enable", "NO")
490 config.verbose = false
492 -- The first item in every carousel is always the default item.
493 function config.getCarouselIndex(id)
494 return carousel_choices[id] or 1
497 function config.setCarouselIndex(id, idx)
498 carousel_choices[id] = idx
501 -- Returns true if we processed the file successfully, false if we did not.
502 -- If 'silent' is true, being unable to read the file is not considered a
504 function config.processFile(name, silent)
505 if silent == nil then
509 local text = readFile(name, silent)
514 return config.parse(text)
517 -- silent runs will not return false if we fail to open the file
518 function config.parse(text)
522 for line in text:gmatch("([^\n]+)") do
523 if line:match("^%s*$") == nil then
524 for _, val in ipairs(pattern_table) do
525 local pattern = '^%s*' .. val.str .. '%s*(.*)';
526 local cgroups = val.groups or 2
527 local k, v, c = checkPattern(line, pattern)
529 -- Offset by one, drats
535 if isValidComment(c) then
544 print(MSG_MALFORMED:format(n, line))
554 function config.readConf(file, loaded_files)
555 if loaded_files == nil then
559 if loaded_files[file] ~= nil then
563 -- We'll process loader_conf_dirs at the top-level readConf
564 local load_conf_dirs = next(loaded_files) == nil
565 print("Loading " .. file)
567 -- The final value of loader_conf_files is not important, so just
568 -- clobber it here. We'll later check if it's no longer nil and process
569 -- the new value for files to read.
570 setEnv("loader_conf_files", nil)
572 -- These may or may not exist, and that's ok. Do a
573 -- silent parse so that we complain on parse errors but
574 -- not for them simply not existing.
575 if not config.processFile(file, true) then
576 print(MSG_FAILPARSECFG:format(file))
579 loaded_files[file] = true
581 -- Going to process "loader_conf_files" extra-files
582 local loader_conf_files = getEnv("loader_conf_files")
583 if loader_conf_files ~= nil then
584 for name in loader_conf_files:gmatch("[%w%p]+") do
585 config.readConf(name, loaded_files)
589 if load_conf_dirs then
590 local loader_conf_dirs = getEnv("loader_conf_dirs")
591 if loader_conf_dirs ~= nil then
592 for name in loader_conf_dirs:gmatch("[%w%p]+") do
593 if lfs.attributes(name, "mode") ~= "directory" then
594 print(MSG_FAILDIR:format(name))
597 for cfile in lfs.dir(name) do
598 if cfile:match(".conf$") then
599 local fpath = name .. "/" .. cfile
600 if lfs.attributes(fpath, "mode") == "file" then
601 config.readConf(fpath, loaded_files)
611 -- other_kernel is optionally the name of a kernel to load, if not the default
612 -- or autoloaded default from the module_path
613 function config.loadKernel(other_kernel)
614 local flags = loader.getenv("kernel_options") or ""
615 local kernel = other_kernel or loader.getenv("kernel")
617 local function tryLoad(names)
618 for name in names:gmatch("([^;]+)%s*;?") do
619 local r = loader.perform("load " .. name ..
628 local function getModulePath()
629 local module_path = loader.getenv("module_path")
630 local kernel_path = loader.getenv("kernel_path")
632 if kernel_path == nil then
636 -- Strip the loaded kernel path from module_path. This currently assumes
637 -- that the kernel path will be prepended to the module_path when it's
639 kernel_path = escapeName(kernel_path .. ';')
640 return module_path:gsub(kernel_path, '')
643 local function loadBootfile()
644 local bootfile = loader.getenv("bootfile")
646 -- append default kernel name
647 if bootfile == nil then
650 bootfile = bootfile .. ";kernel"
653 return tryLoad(bootfile)
656 -- kernel not set, try load from default module_path
657 if kernel == nil then
658 local res = loadBootfile()
661 -- Default kernel is loaded
662 config.kernel_loaded = nil
665 print(MSG_DEFAULTKERNFAIL)
669 -- Use our cached module_path, so we don't end up with multiple
670 -- automatically added kernel paths to our final module_path
671 local module_path = getModulePath()
674 if other_kernel ~= nil then
675 kernel = other_kernel
677 -- first try load kernel with module_path = /boot/${kernel}
678 -- then try load with module_path=${kernel}
679 local paths = {"/boot/" .. kernel, kernel}
681 for _, v in pairs(paths) do
682 loader.setenv("module_path", v)
685 -- succeeded, add path to module_path
687 config.kernel_loaded = kernel
688 if module_path ~= nil then
689 loader.setenv("module_path", v .. ";" ..
691 loader.setenv("kernel_path", v)
697 -- failed to load with ${kernel} as a directory
699 res = tryLoad(kernel)
701 config.kernel_loaded = kernel
704 print(MSG_KERNFAIL:format(kernel))
710 function config.selectKernel(kernel)
711 config.kernel_selected = kernel
714 function config.load(file, reloading)
716 file = "/boot/defaults/loader.conf"
719 config.readConf(file)
723 local verbose = loader.getenv("verbose_loading") or "no"
724 config.verbose = verbose:lower() == "yes"
725 if not reloading then
726 hook.runAll("config.loaded")
730 -- Reload configuration
731 function config.reload(file)
734 config.load(file, true)
735 hook.runAll("config.reloaded")
738 function config.loadelf()
739 local xen_kernel = loader.getenv('xen_kernel')
740 local kernel = config.kernel_selected or config.kernel_loaded
743 if xen_kernel ~= nil then
744 print(MSG_XENKERNLOADING)
745 if cli_execute_unparsed('load ' .. xen_kernel) ~= 0 then
746 print(MSG_XENKERNFAIL:format(xen_kernel))
750 print(MSG_KERNLOADING)
751 if not config.loadKernel(kernel) then
754 hook.runAll("kernel.loaded")
756 print(MSG_MODLOADING)
757 status = loadModule(modules, not config.verbose)
758 hook.runAll("modules.loaded")
762 function config.enableModule(modname)
763 if modules[modname] == nil then
764 modules[modname] = {}
765 elseif modules[modname].load == "YES" then
766 modules[modname].force = true
770 modules[modname].load = "YES"
771 modules[modname].force = true
775 function config.disableModule(modname)
776 if modules[modname] == nil then
778 elseif modules[modname].load ~= "YES" then
782 modules[modname].load = "NO"
783 modules[modname].force = nil
787 function config.isModuleEnabled(modname)
788 local mod = modules[modname]
789 if not mod or mod.load ~= "YES" then
797 local blacklist = getBlacklist()
798 return not blacklist[modname]
801 function config.getModuleInfo()
804 blacklist = getBlacklist()
808 hook.registerType("config.loaded")
809 hook.registerType("config.reloaded")
810 hook.registerType("kernel.loaded")
811 hook.registerType("modules.loaded")