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_FAILEXEC = "Failed to exec '%s'"
43 local MSG_FAILSETENV = "Failed to '%s' with value: %s"
44 local MSG_FAILOPENCFG = "Failed to open config: '%s'"
45 local MSG_FAILREADCFG = "Failed to read config: '%s'"
46 local MSG_FAILPARSECFG = "Failed to parse config: '%s'"
47 local MSG_FAILEXBEF = "Failed to execute '%s' before loading '%s'"
48 local MSG_FAILEXAF = "Failed to execute '%s' after loading '%s'"
49 local MSG_MALFORMED = "Malformed line (%d):\n\t'%s'"
50 local MSG_DEFAULTKERNFAIL = "No kernel set, failed to load from module_path"
51 local MSG_KERNFAIL = "Failed to load kernel '%s'"
52 local MSG_XENKERNFAIL = "Failed to load Xen kernel '%s'"
53 local MSG_XENKERNLOADING = "Loading Xen kernel..."
54 local MSG_KERNLOADING = "Loading kernel..."
55 local MSG_MODLOADING = "Loading configured modules..."
56 local MSG_MODBLACKLIST = "Not loading blacklisted module '%s'"
58 local MODULEEXPR = '([%w-_]+)'
59 local QVALEXPR = "\"([%w%s%p]-)\""
60 local QVALREPL = QVALEXPR:gsub('%%', '%%%%')
61 local WORDEXPR = "([%w]+)"
62 local WORDREPL = WORDEXPR:gsub('%%', '%%%%')
64 -- Entries that should never make it into the environment; each one should have
65 -- a documented reason for its existence, and these should all be implementation
66 -- details of the config module.
67 local loader_env_restricted_table = {
68 -- loader_conf_files should be considered write-only, and consumers
69 -- should not rely on any particular value; it's a loader implementation
70 -- detail. Moreover, it's not a particularly useful variable to have in
71 -- the kenv. Save the overhead, let it get fetched other ways.
72 loader_conf_files = true,
75 local function restoreEnv()
76 -- Examine changed environment variables
77 for k, v in pairs(env_changed) do
78 local restore_value = env_restore[k]
79 if restore_value == nil then
80 -- This one doesn't need restored for some reason
83 local current_value = loader.getenv(k)
84 if current_value ~= v then
85 -- This was overwritten by some action taken on the menu
86 -- most likely; we'll leave it be.
89 restore_value = restore_value.value
90 if restore_value ~= nil then
91 loader.setenv(k, restore_value)
102 -- XXX This getEnv/setEnv should likely be exported at some point. We can save
103 -- the call back into loader.getenv for any variable that's been set or
104 -- overridden by any loader.conf using this implementation with little overhead
105 -- since we're already tracking the values.
106 local function getEnv(key)
107 if loader_env_restricted_table[key] ~= nil or
108 env_changed[key] ~= nil then
109 return env_changed[key]
112 return loader.getenv(key)
115 local function setEnv(key, value)
116 env_changed[key] = value
118 if loader_env_restricted_table[key] ~= nil then
122 -- Track the original value for this if we haven't already
123 if env_restore[key] == nil then
124 env_restore[key] = {value = loader.getenv(key)}
127 return loader.setenv(key, value)
130 -- name here is one of 'name', 'type', flags', 'before', 'after', or 'error.'
131 -- These are set from lines in loader.conf(5): ${key}_${name}="${value}" where
132 -- ${key} is a module name.
133 local function setKey(key, name, value)
134 if modules[key] == nil then
137 modules[key][name] = value
140 -- Escapes the named value for use as a literal in a replacement pattern.
141 -- e.g. dhcp.host-name gets turned into dhcp%.host%-name to remove the special
143 local function escapeName(name)
144 return name:gsub("([%p])", "%%%1")
147 local function processEnvVar(value)
148 for name in value:gmatch("${([^}]+)}") do
149 local replacement = loader.getenv(name) or ""
150 value = value:gsub("${" .. escapeName(name) .. "}", replacement)
152 for name in value:gmatch("$([%w%p]+)%s*") do
153 local replacement = loader.getenv(name) or ""
154 value = value:gsub("$" .. escapeName(name), replacement)
159 local function checkPattern(line, pattern)
160 local function _realCheck(_line, _pattern)
161 return _line:match(_pattern)
164 if pattern:find('$VALUE') then
166 k, v, c = _realCheck(line, pattern:gsub('$VALUE', QVALREPL))
170 return _realCheck(line, pattern:gsub('$VALUE', WORDREPL))
172 return _realCheck(line, pattern)
176 -- str in this table is a regex pattern. It will automatically be anchored to
177 -- the beginning of a line and any preceding whitespace will be skipped. The
178 -- pattern should have no more than two captures patterns, which correspond to
179 -- the two parameters (usually 'key' and 'value') that are passed to the
180 -- process function. All trailing characters will be validated. Any $VALUE
181 -- token included in a pattern will be tried first with a quoted value capture
182 -- group, then a single-word value capture group. This is our kludge for Lua
183 -- regex not supporting branching.
185 -- We have two special entries in this table: the first is the first entry,
186 -- a full-line comment. The second is for 'exec' handling. Both have a single
187 -- capture group, but the difference is that the full-line comment pattern will
188 -- match the entire line. This does not run afoul of the later end of line
189 -- validation that we'll do after a match. However, the 'exec' pattern will.
190 -- We document the exceptions with a special 'groups' index that indicates
191 -- the number of capture groups, if not two. We'll use this later to do
192 -- validation on the proper entry.
194 local pattern_table = {
197 process = function(_, _) end,
200 -- module_load="value"
202 str = MODULEEXPR .. "_load%s*=%s*$VALUE",
203 process = function(k, v)
204 if modules[k] == nil then
207 modules[k].load = v:upper()
210 -- module_name="value"
212 str = MODULEEXPR .. "_name%s*=%s*$VALUE",
213 process = function(k, v)
217 -- module_type="value"
219 str = MODULEEXPR .. "_type%s*=%s*$VALUE",
220 process = function(k, v)
224 -- module_flags="value"
226 str = MODULEEXPR .. "_flags%s*=%s*$VALUE",
227 process = function(k, v)
228 setKey(k, "flags", v)
231 -- module_before="value"
233 str = MODULEEXPR .. "_before%s*=%s*$VALUE",
234 process = function(k, v)
235 setKey(k, "before", v)
238 -- module_after="value"
240 str = MODULEEXPR .. "_after%s*=%s*$VALUE",
241 process = function(k, v)
242 setKey(k, "after", v)
245 -- module_error="value"
247 str = MODULEEXPR .. "_error%s*=%s*$VALUE",
248 process = function(k, v)
249 setKey(k, "error", v)
254 str = "exec%s*=%s*" .. QVALEXPR,
255 process = function(k, _)
256 if cli_execute_unparsed(k) ~= 0 then
257 print(MSG_FAILEXEC:format(k))
264 str = "([%w%p]+)%s*=%s*$VALUE",
265 process = function(k, v)
266 if setEnv(k, processEnvVar(v)) ~= 0 then
267 print(MSG_FAILSETENV:format(k, v))
273 str = "([%w%p]+)%s*=%s*(-?%d+)",
274 process = function(k, v)
275 if setEnv(k, processEnvVar(v)) ~= 0 then
276 print(MSG_FAILSETENV:format(k, tostring(v)))
282 local function isValidComment(line)
284 local s = line:match("^%s*#.*")
286 s = line:match("^%s*$")
295 local function getBlacklist()
297 local blacklist_str = loader.getenv('module_blacklist')
298 if blacklist_str == nil then
302 for mod in blacklist_str:gmatch("[;, ]?([%w-_]+)[;, ]?") do
303 blacklist[mod] = true
308 local function loadModule(mod, silent)
310 local blacklist = getBlacklist()
312 for k, v in pairs(mod) do
313 if v.load ~= nil and v.load:lower() == "yes" then
314 local module_name = v.name or k
315 if not v.force and blacklist[module_name] ~= nil then
317 print(MSG_MODBLACKLIST:format(module_name))
322 loader.printc(module_name .. "...")
325 if v.type ~= nil then
326 str = str .. "-t " .. v.type .. " "
328 str = str .. module_name
329 if v.flags ~= nil then
330 str = str .. " " .. v.flags
332 if v.before ~= nil then
333 pstatus = cli_execute_unparsed(v.before) == 0
334 if not pstatus and not silent then
335 print(MSG_FAILEXBEF:format(v.before, k))
337 status = status and pstatus
340 if cli_execute_unparsed(str) ~= 0 then
341 -- XXX Temporary shim: don't break the boot if
342 -- loader hadn't been recompiled with this
344 if loader.command_error then
345 print(loader.command_error())
350 if v.error ~= nil then
351 cli_execute_unparsed(v.error)
354 elseif v.after ~= nil then
355 pstatus = cli_execute_unparsed(v.after) == 0
356 if not pstatus and not silent then
357 print(MSG_FAILEXAF:format(v.after, k))
362 status = status and pstatus
371 local function readFile(name, silent)
372 local f = io.open(name)
375 print(MSG_FAILOPENCFG:format(name))
380 local text, _ = io.read(f)
381 -- We might have read in the whole file, this won't be needed any more.
384 if text == nil and not silent then
385 print(MSG_FAILREADCFG:format(name))
390 local function checkNextboot()
391 local nextboot_file = loader.getenv("nextboot_conf")
392 local nextboot_enable = loader.getenv("nextboot_enable")
394 if nextboot_file == nil then
398 -- is nextboot_enable set in nvstore?
399 if nextboot_enable == "NO" then
403 local text = readFile(nextboot_file, true)
408 if nextboot_enable == nil and
409 text:match("^nextboot_enable=\"NO\"") ~= nil then
410 -- We're done; nextboot is not enabled
414 if not config.parse(text) then
415 print(MSG_FAILPARSECFG:format(nextboot_file))
418 -- Attempt to rewrite the first line and only the first line of the
419 -- nextboot_file. We overwrite it with nextboot_enable="NO", then
420 -- check for that on load.
421 -- It's worth noting that this won't work on every filesystem, so we
422 -- won't do anything notable if we have any errors in this process.
423 local nfile = io.open(nextboot_file, 'w')
425 -- We need the trailing space here to account for the extra
426 -- character taken up by the string nextboot_enable="YES"
427 -- Or new end quotation mark lands on the S, and we want to
428 -- rewrite the entirety of the first line.
429 io.write(nfile, "nextboot_enable=\"NO\" ")
432 loader.setenv("nextboot_enable", "NO")
436 config.verbose = false
438 -- The first item in every carousel is always the default item.
439 function config.getCarouselIndex(id)
440 return carousel_choices[id] or 1
443 function config.setCarouselIndex(id, idx)
444 carousel_choices[id] = idx
447 -- Returns true if we processed the file successfully, false if we did not.
448 -- If 'silent' is true, being unable to read the file is not considered a
450 function config.processFile(name, silent)
451 if silent == nil then
455 local text = readFile(name, silent)
460 return config.parse(text)
463 -- silent runs will not return false if we fail to open the file
464 function config.parse(text)
468 for line in text:gmatch("([^\n]+)") do
469 if line:match("^%s*$") == nil then
470 for _, val in ipairs(pattern_table) do
471 local pattern = '^%s*' .. val.str .. '%s*(.*)';
472 local cgroups = val.groups or 2
473 local k, v, c = checkPattern(line, pattern)
475 -- Offset by one, drats
481 if isValidComment(c) then
490 print(MSG_MALFORMED:format(n, line))
500 function config.readConf(file, loaded_files)
501 if loaded_files == nil then
505 if loaded_files[file] ~= nil then
509 print("Loading " .. file)
511 -- The final value of loader_conf_files is not important, so just
512 -- clobber it here. We'll later check if it's no longer nil and process
513 -- the new value for files to read.
514 setEnv("loader_conf_files", nil)
516 -- These may or may not exist, and that's ok. Do a
517 -- silent parse so that we complain on parse errors but
518 -- not for them simply not existing.
519 if not config.processFile(file, true) then
520 print(MSG_FAILPARSECFG:format(file))
523 loaded_files[file] = true
525 -- Going to process "loader_conf_files" extra-files
526 local loader_conf_files = getEnv("loader_conf_files")
527 if loader_conf_files ~= nil then
528 for name in loader_conf_files:gmatch("[%w%p]+") do
529 config.readConf(name, loaded_files)
534 -- other_kernel is optionally the name of a kernel to load, if not the default
535 -- or autoloaded default from the module_path
536 function config.loadKernel(other_kernel)
537 local flags = loader.getenv("kernel_options") or ""
538 local kernel = other_kernel or loader.getenv("kernel")
540 local function tryLoad(names)
541 for name in names:gmatch("([^;]+)%s*;?") do
542 local r = loader.perform("load " .. name ..
551 local function getModulePath()
552 local module_path = loader.getenv("module_path")
553 local kernel_path = loader.getenv("kernel_path")
555 if kernel_path == nil then
559 -- Strip the loaded kernel path from module_path. This currently assumes
560 -- that the kernel path will be prepended to the module_path when it's
562 kernel_path = escapeName(kernel_path .. ';')
563 return module_path:gsub(kernel_path, '')
566 local function loadBootfile()
567 local bootfile = loader.getenv("bootfile")
569 -- append default kernel name
570 if bootfile == nil then
573 bootfile = bootfile .. ";kernel"
576 return tryLoad(bootfile)
579 -- kernel not set, try load from default module_path
580 if kernel == nil then
581 local res = loadBootfile()
584 -- Default kernel is loaded
585 config.kernel_loaded = nil
588 print(MSG_DEFAULTKERNFAIL)
592 -- Use our cached module_path, so we don't end up with multiple
593 -- automatically added kernel paths to our final module_path
594 local module_path = getModulePath()
597 if other_kernel ~= nil then
598 kernel = other_kernel
600 -- first try load kernel with module_path = /boot/${kernel}
601 -- then try load with module_path=${kernel}
602 local paths = {"/boot/" .. kernel, kernel}
604 for _, v in pairs(paths) do
605 loader.setenv("module_path", v)
608 -- succeeded, add path to module_path
610 config.kernel_loaded = kernel
611 if module_path ~= nil then
612 loader.setenv("module_path", v .. ";" ..
614 loader.setenv("kernel_path", v)
620 -- failed to load with ${kernel} as a directory
622 res = tryLoad(kernel)
624 config.kernel_loaded = kernel
627 print(MSG_KERNFAIL:format(kernel))
633 function config.selectKernel(kernel)
634 config.kernel_selected = kernel
637 function config.load(file, reloading)
639 file = "/boot/defaults/loader.conf"
642 config.readConf(file)
646 local verbose = loader.getenv("verbose_loading") or "no"
647 config.verbose = verbose:lower() == "yes"
648 if not reloading then
649 hook.runAll("config.loaded")
653 -- Reload configuration
654 function config.reload(file)
657 config.load(file, true)
658 hook.runAll("config.reloaded")
661 function config.loadelf()
662 local xen_kernel = loader.getenv('xen_kernel')
663 local kernel = config.kernel_selected or config.kernel_loaded
666 if xen_kernel ~= nil then
667 print(MSG_XENKERNLOADING)
668 if cli_execute_unparsed('load ' .. xen_kernel) ~= 0 then
669 print(MSG_XENKERNFAIL:format(xen_kernel))
673 print(MSG_KERNLOADING)
674 if not config.loadKernel(kernel) then
677 hook.runAll("kernel.loaded")
679 print(MSG_MODLOADING)
680 status = loadModule(modules, not config.verbose)
681 hook.runAll("modules.loaded")
685 function config.enableModule(modname)
686 if modules[modname] == nil then
687 modules[modname] = {}
688 elseif modules[modname].load == "YES" then
689 modules[modname].force = true
693 modules[modname].load = "YES"
694 modules[modname].force = true
698 function config.disableModule(modname)
699 if modules[modname] == nil then
701 elseif modules[modname].load ~= "YES" then
705 modules[modname].load = "NO"
706 modules[modname].force = nil
710 function config.isModuleEnabled(modname)
711 local mod = modules[modname]
712 if not mod or mod.load ~= "YES" then
720 local blacklist = getBlacklist()
721 return not blacklist[modname]
724 function config.getModuleInfo()
727 blacklist = getBlacklist()
731 hook.registerType("config.loaded")
732 hook.registerType("config.reloaded")
733 hook.registerType("kernel.loaded")
734 hook.registerType("modules.loaded")