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 config = require("config")
33 local hook = require("hook")
37 local function composeLoaderCmd(cmd_name, argstr)
39 cmd_name = cmd_name .. " " .. argstr
45 -- try_include will return the loaded module on success, or nil on failure.
46 -- A message will also be printed on failure, with one exception: non-verbose
47 -- loading will suppress 'module not found' errors.
48 function try_include(module)
49 local status, ret = pcall(require, module)
50 -- ret is the module if we succeeded.
54 -- Otherwise, ret is just a message; filter out ENOENT unless we're
55 -- doing a verbose load. As a consequence, try_include prior to loading
56 -- configuration will not display 'module not found'. All other errors
57 -- in loading will be printed.
58 if config.verbose or ret:match("^module .+ not found") == nil then
65 -- Commonly appearing constants
66 core.KEY_BACKSPACE = 8
70 -- Note that this is a decimal representation, despite the leading 0 that in
71 -- other contexts (outside of Lua) may mean 'octal'
72 core.KEYSTR_ESCAPE = "\027"
73 core.KEYSTR_CSI = core.KEYSTR_ESCAPE .. "["
75 core.MENU_RETURN = "return"
76 core.MENU_ENTRY = "entry"
77 core.MENU_SEPARATOR = "separator"
78 core.MENU_SUBMENU = "submenu"
79 core.MENU_CAROUSEL_ENTRY = "carousel_entry"
81 function core.setVerbose(verbose)
82 if verbose == nil then
83 verbose = not core.verbose
87 loader.setenv("boot_verbose", "YES")
89 loader.unsetenv("boot_verbose")
91 core.verbose = verbose
94 function core.setSingleUser(single_user)
95 if single_user == nil then
96 single_user = not core.su
100 loader.setenv("boot_single", "YES")
102 loader.unsetenv("boot_single")
104 core.su = single_user
107 function core.getACPIPresent(checking_system_defaults)
108 local c = loader.getenv("hint.acpi.0.rsdp")
111 if checking_system_defaults then
114 -- Otherwise, respect disabled if it's set
115 c = loader.getenv("hint.acpi.0.disabled")
116 return c == nil or tonumber(c) ~= 1
121 function core.setACPI(acpi)
127 loader.setenv("acpi_load", "YES")
128 loader.setenv("hint.acpi.0.disabled", "0")
129 loader.unsetenv("loader.acpi_disabled_by_user")
131 loader.unsetenv("acpi_load")
132 loader.setenv("hint.acpi.0.disabled", "1")
133 loader.setenv("loader.acpi_disabled_by_user", "1")
138 function core.setSafeMode(safe_mode)
139 if safe_mode == nil then
140 safe_mode = not core.sm
143 loader.setenv("kern.smp.disabled", "1")
144 loader.setenv("hw.ata.ata_dma", "0")
145 loader.setenv("hw.ata.atapi_dma", "0")
146 loader.setenv("hw.ata.wc", "0")
147 loader.setenv("hw.eisa_slots", "0")
148 loader.setenv("kern.eventtimer.periodic", "1")
149 loader.setenv("kern.geom.part.check_integrity", "0")
151 loader.unsetenv("kern.smp.disabled")
152 loader.unsetenv("hw.ata.ata_dma")
153 loader.unsetenv("hw.ata.atapi_dma")
154 loader.unsetenv("hw.ata.wc")
155 loader.unsetenv("hw.eisa_slots")
156 loader.unsetenv("kern.eventtimer.periodic")
157 loader.unsetenv("kern.geom.part.check_integrity")
162 function core.clearCachedKernels()
163 -- Clear the kernel cache on config changes, autodetect might have
164 -- changed or if we've switched boot environments then we could have
166 core.cached_kernels = nil
169 function core.kernelList()
170 if core.cached_kernels ~= nil then
171 return core.cached_kernels
174 local k = loader.getenv("kernel")
175 local v = loader.getenv("kernels")
176 local autodetect = loader.getenv("kernels_autodetect") or ""
188 for n in v:gmatch("([^; ]+)[; ]?") do
189 if unique[n] == nil then
197 -- Base whether we autodetect kernels or not on a loader.conf(5)
198 -- setting, kernels_autodetect. If it's set to 'yes', we'll add
199 -- any kernels we detect based on the criteria described.
200 if autodetect:lower() ~= "yes" then
201 core.cached_kernels = kernels
202 return core.cached_kernels
205 -- Automatically detect other bootable kernel directories using a
206 -- heuristic. Any directory in /boot that contains an ordinary file
207 -- named "kernel" is considered eligible.
208 for file in lfs.dir("/boot") do
209 local fname = "/boot/" .. file
211 if file == "." or file == ".." then
215 if lfs.attributes(fname, "mode") ~= "directory" then
219 if lfs.attributes(fname .. "/kernel", "mode") ~= "file" then
223 if unique[file] == nil then
231 core.cached_kernels = kernels
232 return core.cached_kernels
235 function core.bootenvDefault()
236 return loader.getenv("zfs_be_active")
239 function core.bootenvList()
240 local bootenv_count = tonumber(loader.getenv("bootenvs_count"))
246 if bootenv_count == nil or bootenv_count <= 0 then
250 -- Currently selected bootenv is always first/default
251 curenv = core.bootenvDefault()
252 if curenv ~= nil then
253 envcount = envcount + 1
254 bootenvs[envcount] = curenv
255 unique[curenv] = true
258 for curenv_idx = 0, bootenv_count - 1 do
259 curenv = loader.getenv("bootenvs[" .. curenv_idx .. "]")
260 if curenv ~= nil and unique[curenv] == nil then
261 envcount = envcount + 1
262 bootenvs[envcount] = curenv
263 unique[curenv] = true
269 function core.setDefaults()
270 core.setACPI(core.getACPIPresent(true))
271 core.setSafeMode(false)
272 core.setSingleUser(false)
273 core.setVerbose(false)
276 function core.autoboot(argstr)
277 -- loadelf() only if we've not already loaded a kernel
278 if loader.getenv("kernelname") == nil then
281 loader.perform(composeLoaderCmd("autoboot", argstr))
284 function core.boot(argstr)
285 -- loadelf() only if we've not already loaded a kernel
286 if loader.getenv("kernelname") == nil then
289 loader.perform(composeLoaderCmd("boot", argstr))
292 function core.isSingleUserBoot()
293 local single_user = loader.getenv("boot_single")
294 return single_user ~= nil and single_user:lower() == "yes"
297 function core.isUEFIBoot()
298 local efiver = loader.getenv("efi-version")
303 function core.isZFSBoot()
304 local c = loader.getenv("currdev")
307 return c:match("^zfs:") ~= nil
312 function core.isSerialBoot()
313 local c = loader.getenv("console")
316 if c:find("comconsole") ~= nil then
321 local s = loader.getenv("boot_serial")
326 local m = loader.getenv("boot_multicons")
333 function core.isSystem386()
334 return loader.machine_arch == "i386"
337 -- Is the menu skipped in the environment in which we've booted?
338 function core.isMenuSkipped()
339 if core.isSerialBoot() then
342 local c = string.lower(loader.getenv("console") or "")
343 if c:match("^efi[ ;]") ~= nil or c:match("[ ;]efi[ ;]") ~= nil then
347 c = string.lower(loader.getenv("beastie_disable") or "")
351 -- This may be a better candidate for a 'utility' module.
352 function core.deepCopyTable(tbl)
354 for k, v in pairs(tbl) do
355 if type(v) == "table" then
356 new_tbl[k] = core.deepCopyTable(v)
364 -- XXX This should go away if we get the table lib into shape for importing.
365 -- As of now, it requires some 'os' functions, so we'll implement this in lua
367 function core.popFrontTable(tbl)
368 -- Shouldn't reasonably happen
371 elseif #tbl == 1 then
375 local first_value = tbl[1]
377 -- This is not a cheap operation
378 for k, v in ipairs(tbl) do
384 return first_value, new_tbl
387 -- On i386, hint.acpi.0.rsdp will be set before we're loaded. On !i386, it will
388 -- generally be set upon execution of the kernel. Because of this, we can't (or
389 -- don't really want to) detect/disable ACPI on !i386 reliably. Just set it
390 -- enabled if we detect it and leave well enough alone if we don't.
391 if core.isSystem386() and core.getACPIPresent(false) then
395 hook.register("config.reloaded", core.clearCachedKernels)