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 local function restoreEnv()
65 -- Examine changed environment variables
66 for k, v in pairs(env_changed) do
67 local restore_value = env_restore[k]
68 if restore_value == nil then
69 -- This one doesn't need restored for some reason
72 local current_value = loader.getenv(k)
73 if current_value ~= v then
74 -- This was overwritten by some action taken on the menu
75 -- most likely; we'll leave it be.
78 restore_value = restore_value.value
79 if restore_value ~= nil then
80 loader.setenv(k, restore_value)
91 local function setEnv(key, value)
92 -- Track the original value for this if we haven't already
93 if env_restore[key] == nil then
94 env_restore[key] = {value = loader.getenv(key)}
97 env_changed[key] = value
99 return loader.setenv(key, value)
102 -- name here is one of 'name', 'type', flags', 'before', 'after', or 'error.'
103 -- These are set from lines in loader.conf(5): ${key}_${name}="${value}" where
104 -- ${key} is a module name.
105 local function setKey(key, name, value)
106 if modules[key] == nil then
109 modules[key][name] = value
112 -- Escapes the named value for use as a literal in a replacement pattern.
113 -- e.g. dhcp.host-name gets turned into dhcp%.host%-name to remove the special
115 local function escapeName(name)
116 return name:gsub("([%p])", "%%%1")
119 local function processEnvVar(value)
120 for name in value:gmatch("${([^}]+)}") do
121 local replacement = loader.getenv(name) or ""
122 value = value:gsub("${" .. escapeName(name) .. "}", replacement)
124 for name in value:gmatch("$([%w%p]+)%s*") do
125 local replacement = loader.getenv(name) or ""
126 value = value:gsub("$" .. escapeName(name), replacement)
131 local function checkPattern(line, pattern)
132 local function _realCheck(_line, _pattern)
133 return _line:match(_pattern)
136 if pattern:find('$VALUE') then
138 k, v, c = _realCheck(line, pattern:gsub('$VALUE', QVALREPL))
142 return _realCheck(line, pattern:gsub('$VALUE', WORDREPL))
144 return _realCheck(line, pattern)
148 -- str in this table is a regex pattern. It will automatically be anchored to
149 -- the beginning of a line and any preceding whitespace will be skipped. The
150 -- pattern should have no more than two captures patterns, which correspond to
151 -- the two parameters (usually 'key' and 'value') that are passed to the
152 -- process function. All trailing characters will be validated. Any $VALUE
153 -- token included in a pattern will be tried first with a quoted value capture
154 -- group, then a single-word value capture group. This is our kludge for Lua
155 -- regex not supporting branching.
157 -- We have two special entries in this table: the first is the first entry,
158 -- a full-line comment. The second is for 'exec' handling. Both have a single
159 -- capture group, but the difference is that the full-line comment pattern will
160 -- match the entire line. This does not run afoul of the later end of line
161 -- validation that we'll do after a match. However, the 'exec' pattern will.
162 -- We document the exceptions with a special 'groups' index that indicates
163 -- the number of capture groups, if not two. We'll use this later to do
164 -- validation on the proper entry.
166 local pattern_table = {
169 process = function(_, _) end,
172 -- module_load="value"
174 str = MODULEEXPR .. "_load%s*=%s*$VALUE",
175 process = function(k, v)
176 if modules[k] == nil then
179 modules[k].load = v:upper()
182 -- module_name="value"
184 str = MODULEEXPR .. "_name%s*=%s*$VALUE",
185 process = function(k, v)
189 -- module_type="value"
191 str = MODULEEXPR .. "_type%s*=%s*$VALUE",
192 process = function(k, v)
196 -- module_flags="value"
198 str = MODULEEXPR .. "_flags%s*=%s*$VALUE",
199 process = function(k, v)
200 setKey(k, "flags", v)
203 -- module_before="value"
205 str = MODULEEXPR .. "_before%s*=%s*$VALUE",
206 process = function(k, v)
207 setKey(k, "before", v)
210 -- module_after="value"
212 str = MODULEEXPR .. "_after%s*=%s*$VALUE",
213 process = function(k, v)
214 setKey(k, "after", v)
217 -- module_error="value"
219 str = MODULEEXPR .. "_error%s*=%s*$VALUE",
220 process = function(k, v)
221 setKey(k, "error", v)
226 str = "exec%s*=%s*" .. QVALEXPR,
227 process = function(k, _)
228 if cli_execute_unparsed(k) ~= 0 then
229 print(MSG_FAILEXEC:format(k))
236 str = "([%w%p]+)%s*=%s*$VALUE",
237 process = function(k, v)
238 if setEnv(k, processEnvVar(v)) ~= 0 then
239 print(MSG_FAILSETENV:format(k, v))
245 str = "([%w%p]+)%s*=%s*(-?%d+)",
246 process = function(k, v)
247 if setEnv(k, processEnvVar(v)) ~= 0 then
248 print(MSG_FAILSETENV:format(k, tostring(v)))
254 local function isValidComment(line)
256 local s = line:match("^%s*#.*")
258 s = line:match("^%s*$")
267 local function getBlacklist()
269 local blacklist_str = loader.getenv('module_blacklist')
270 if blacklist_str == nil then
274 for mod in blacklist_str:gmatch("[;, ]?([%w-_]+)[;, ]?") do
275 blacklist[mod] = true
280 local function loadModule(mod, silent)
282 local blacklist = getBlacklist()
284 for k, v in pairs(mod) do
285 if v.load ~= nil and v.load:lower() == "yes" then
286 local module_name = v.name or k
287 if blacklist[module_name] ~= nil then
289 print(MSG_MODBLACKLIST:format(module_name))
294 loader.printc(module_name .. "...")
297 if v.type ~= nil then
298 str = str .. "-t " .. v.type .. " "
300 str = str .. module_name
301 if v.flags ~= nil then
302 str = str .. " " .. v.flags
304 if v.before ~= nil then
305 pstatus = cli_execute_unparsed(v.before) == 0
306 if not pstatus and not silent then
307 print(MSG_FAILEXBEF:format(v.before, k))
309 status = status and pstatus
312 if cli_execute_unparsed(str) ~= 0 then
313 -- XXX Temporary shim: don't break the boot if
314 -- loader hadn't been recompiled with this
316 if loader.command_error then
317 print(loader.command_error())
322 if v.error ~= nil then
323 cli_execute_unparsed(v.error)
326 elseif v.after ~= nil then
327 pstatus = cli_execute_unparsed(v.after) == 0
328 if not pstatus and not silent then
329 print(MSG_FAILEXAF:format(v.after, k))
334 status = status and pstatus
343 local function readConfFiles(loaded_files)
344 local f = loader.getenv("loader_conf_files")
346 for name in f:gmatch("([%w%p]+)%s*") do
347 if loaded_files[name] ~= nil then
351 local prefiles = loader.getenv("loader_conf_files")
353 print("Loading " .. name)
354 -- These may or may not exist, and that's ok. Do a
355 -- silent parse so that we complain on parse errors but
356 -- not for them simply not existing.
357 if not config.processFile(name, true) then
358 print(MSG_FAILPARSECFG:format(name))
361 loaded_files[name] = true
362 local newfiles = loader.getenv("loader_conf_files")
363 if prefiles ~= newfiles then
364 readConfFiles(loaded_files)
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 if nextboot_file == nil then
396 local text = readFile(nextboot_file, true)
401 if text:match("^nextboot_enable=\"NO\"") ~= nil then
402 -- We're done; nextboot is not enabled
406 if not config.parse(text) then
407 print(MSG_FAILPARSECFG:format(nextboot_file))
410 -- Attempt to rewrite the first line and only the first line of the
411 -- nextboot_file. We overwrite it with nextboot_enable="NO", then
412 -- check for that on load.
413 -- It's worth noting that this won't work on every filesystem, so we
414 -- won't do anything notable if we have any errors in this process.
415 local nfile = io.open(nextboot_file, 'w')
417 -- We need the trailing space here to account for the extra
418 -- character taken up by the string nextboot_enable="YES"
419 -- Or new end quotation mark lands on the S, and we want to
420 -- rewrite the entirety of the first line.
421 io.write(nfile, "nextboot_enable=\"NO\" ")
427 config.verbose = false
429 -- The first item in every carousel is always the default item.
430 function config.getCarouselIndex(id)
431 return carousel_choices[id] or 1
434 function config.setCarouselIndex(id, idx)
435 carousel_choices[id] = idx
438 -- Returns true if we processed the file successfully, false if we did not.
439 -- If 'silent' is true, being unable to read the file is not considered a
441 function config.processFile(name, silent)
442 if silent == nil then
446 local text = readFile(name, silent)
451 return config.parse(text)
454 -- silent runs will not return false if we fail to open the file
455 function config.parse(text)
459 for line in text:gmatch("([^\n]+)") do
460 if line:match("^%s*$") == nil then
461 for _, val in ipairs(pattern_table) do
462 local pattern = '^%s*' .. val.str .. '%s*(.*)';
463 local cgroups = val.groups or 2
464 local k, v, c = checkPattern(line, pattern)
466 -- Offset by one, drats
472 if isValidComment(c) then
481 print(MSG_MALFORMED:format(n, line))
491 -- other_kernel is optionally the name of a kernel to load, if not the default
492 -- or autoloaded default from the module_path
493 function config.loadKernel(other_kernel)
494 local flags = loader.getenv("kernel_options") or ""
495 local kernel = other_kernel or loader.getenv("kernel")
497 local function tryLoad(names)
498 for name in names:gmatch("([^;]+)%s*;?") do
499 local r = loader.perform("load " .. name ..
508 local function getModulePath()
509 local module_path = loader.getenv("module_path")
510 local kernel_path = loader.getenv("kernel_path")
512 if kernel_path == nil then
516 -- Strip the loaded kernel path from module_path. This currently assumes
517 -- that the kernel path will be prepended to the module_path when it's
519 kernel_path = escapeName(kernel_path .. ';')
520 return module_path:gsub(kernel_path, '')
523 local function loadBootfile()
524 local bootfile = loader.getenv("bootfile")
526 -- append default kernel name
527 if bootfile == nil then
530 bootfile = bootfile .. ";kernel"
533 return tryLoad(bootfile)
536 -- kernel not set, try load from default module_path
537 if kernel == nil then
538 local res = loadBootfile()
541 -- Default kernel is loaded
542 config.kernel_loaded = nil
545 print(MSG_DEFAULTKERNFAIL)
549 -- Use our cached module_path, so we don't end up with multiple
550 -- automatically added kernel paths to our final module_path
551 local module_path = getModulePath()
554 if other_kernel ~= nil then
555 kernel = other_kernel
557 -- first try load kernel with module_path = /boot/${kernel}
558 -- then try load with module_path=${kernel}
559 local paths = {"/boot/" .. kernel, kernel}
561 for _, v in pairs(paths) do
562 loader.setenv("module_path", v)
565 -- succeeded, add path to module_path
567 config.kernel_loaded = kernel
568 if module_path ~= nil then
569 loader.setenv("module_path", v .. ";" ..
571 loader.setenv("kernel_path", v)
577 -- failed to load with ${kernel} as a directory
579 res = tryLoad(kernel)
581 config.kernel_loaded = kernel
584 print(MSG_KERNFAIL:format(kernel))
590 function config.selectKernel(kernel)
591 config.kernel_selected = kernel
594 function config.load(file, reloading)
596 file = "/boot/defaults/loader.conf"
599 if not config.processFile(file) then
600 print(MSG_FAILPARSECFG:format(file))
603 local loaded_files = {file = true}
604 readConfFiles(loaded_files)
608 local verbose = loader.getenv("verbose_loading") or "no"
609 config.verbose = verbose:lower() == "yes"
610 if not reloading then
611 hook.runAll("config.loaded")
615 -- Reload configuration
616 function config.reload(file)
619 config.load(file, true)
620 hook.runAll("config.reloaded")
623 function config.loadelf()
624 local xen_kernel = loader.getenv('xen_kernel')
625 local kernel = config.kernel_selected or config.kernel_loaded
628 if xen_kernel ~= nil then
629 print(MSG_XENKERNLOADING)
630 if cli_execute_unparsed('load ' .. xen_kernel) ~= 0 then
631 print(MSG_XENKERNFAIL:format(xen_kernel))
635 print(MSG_KERNLOADING)
636 loaded = config.loadKernel(kernel)
642 print(MSG_MODLOADING)
643 return loadModule(modules, not config.verbose)
646 hook.registerType("config.loaded")
647 hook.registerType("config.reloaded")