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 cli = require("cli")
33 local core = require("core")
34 local color = require("color")
35 local config = require("config")
36 local screen = require("screen")
37 local drawer = require("drawer")
42 local return_menu_entry = {
43 entry_type = core.MENU_RETURN,
44 name = "Back to main menu" .. color.highlight(" [Backspace]"),
47 local function OnOff(str, value)
49 return str .. color.escapefg(color.GREEN) .. "On" ..
52 return str .. color.escapefg(color.RED) .. "off" ..
57 local function bootenvSet(env)
58 loader.setenv("vfs.root.mountfrom", env)
59 loader.setenv("currdev", env .. ":")
65 -- Menu handlers take the current menu and selected entry as parameters,
66 -- and should return a boolean indicating whether execution should
67 -- continue or not. The return value may be omitted if this entry should
68 -- have no bearing on whether we continue or not, indicating that we
69 -- should just continue after execution.
70 [core.MENU_ENTRY] = function(_, entry)
74 [core.MENU_CAROUSEL_ENTRY] = function(_, entry)
75 -- carousel (rotating) functionality
76 local carid = entry.carousel_id
77 local caridx = config.getCarouselIndex(carid)
78 local choices = entry.items
79 if type(choices) == "function" then
83 caridx = (caridx % #choices) + 1
84 config.setCarouselIndex(carid, caridx)
85 entry.func(caridx, choices[caridx], choices)
88 [core.MENU_SUBMENU] = function(_, entry)
89 menu.process(entry.submenu)
91 [core.MENU_RETURN] = function(_, entry)
92 -- allow entry to have a function/side effect
93 if entry.func ~= nil then
99 -- loader menu tree is rooted at menu.welcome
101 menu.boot_environments = {
103 -- return to welcome menu
106 entry_type = core.MENU_CAROUSEL_ENTRY,
107 carousel_id = "be_active",
108 items = core.bootenvList,
109 name = function(idx, choice, all_choices)
110 if #all_choices == 0 then
114 local is_default = (idx == 1)
115 local bootenv_name = ""
118 name_color = color.escapefg(color.GREEN)
120 name_color = color.escapefg(color.BLUE)
122 bootenv_name = bootenv_name .. name_color ..
123 choice .. color.resetfg()
124 return color.highlight("A").."ctive: " ..
125 bootenv_name .. " (" .. idx .. " of " ..
128 func = function(_, choice, _)
134 entry_type = core.MENU_ENTRY,
136 return core.isRewinded() == false
139 return color.highlight("b") .. "ootfs: " ..
140 core.bootenvDefault()
143 -- Reset active boot environment to the default
144 config.setCarouselIndex("be_active", 1)
145 bootenvSet(core.bootenvDefault())
152 menu.boot_options = {
154 -- return to welcome menu
158 entry_type = core.MENU_ENTRY,
159 name = "Load System " .. color.highlight("D") ..
161 func = core.setDefaults,
165 entry_type = core.MENU_SEPARATOR,
168 entry_type = core.MENU_SEPARATOR,
169 name = "Boot Options:",
173 entry_type = core.MENU_ENTRY,
174 visible = core.isSystem386,
176 return OnOff(color.highlight("A") ..
184 entry_type = core.MENU_ENTRY,
186 return OnOff("Safe " .. color.highlight("M") ..
189 func = core.setSafeMode,
194 entry_type = core.MENU_ENTRY,
196 return OnOff(color.highlight("S") ..
197 "ingle user:", core.su)
199 func = core.setSingleUser,
204 entry_type = core.MENU_ENTRY,
206 return OnOff(color.highlight("V") ..
207 "erbose :", core.verbose)
209 func = core.setVerbose,
217 local menu_entries = menu.welcome.all_entries
218 local multi_user = menu_entries.multi_user
219 local single_user = menu_entries.single_user
220 local boot_entry_1, boot_entry_2
221 if core.isSingleUserBoot() then
222 -- Swap the first two menu items on single user boot.
223 -- We'll cache the alternate entries for performance.
224 local alts = menu_entries.alts
226 single_user = core.deepCopyTable(single_user)
227 multi_user = core.deepCopyTable(multi_user)
228 single_user.name = single_user.alternate_name
229 multi_user.name = multi_user.alternate_name
230 menu_entries.alts = {
231 single_user = single_user,
232 multi_user = multi_user,
235 single_user = alts.single_user
236 multi_user = alts.multi_user
238 boot_entry_1, boot_entry_2 = single_user, multi_user
240 boot_entry_1, boot_entry_2 = multi_user, single_user
247 menu_entries.console,
249 entry_type = core.MENU_SEPARATOR,
252 entry_type = core.MENU_SEPARATOR,
255 menu_entries.kernel_options,
256 menu_entries.boot_options,
257 menu_entries.zpool_checkpoints,
258 menu_entries.boot_envs,
259 menu_entries.chainload,
264 entry_type = core.MENU_ENTRY,
265 name = color.highlight("B") .. "oot Multi user " ..
266 color.highlight("[Enter]"),
267 -- Not a standard menu entry function!
268 alternate_name = color.highlight("B") ..
271 core.setSingleUser(false)
277 entry_type = core.MENU_ENTRY,
278 name = "Boot " .. color.highlight("S") .. "ingle user",
279 -- Not a standard menu entry function!
280 alternate_name = "Boot " .. color.highlight("S") ..
281 "ingle user " .. color.highlight("[Enter]"),
283 core.setSingleUser(true)
289 entry_type = core.MENU_ENTRY,
291 return color.highlight("C") .. "ons: " .. core.getConsoleName()
294 core.nextConsoleChoice()
299 entry_type = core.MENU_RETURN,
300 name = color.highlight("Esc") .. "ape to loader prompt",
302 loader.setenv("autoboot_delay", "NO")
304 alias = {core.KEYSTR_ESCAPE},
307 entry_type = core.MENU_ENTRY,
308 name = color.highlight("R") .. "eboot",
310 loader.perform("reboot")
315 entry_type = core.MENU_CAROUSEL_ENTRY,
316 carousel_id = "kernel",
317 items = core.kernelList,
318 name = function(idx, choice, all_choices)
319 if #all_choices == 0 then
323 local is_default = (idx == 1)
324 local kernel_name = ""
327 name_color = color.escapefg(color.GREEN)
328 kernel_name = "default/"
330 name_color = color.escapefg(color.BLUE)
332 kernel_name = kernel_name .. name_color ..
333 choice .. color.resetfg()
334 return color.highlight("K") .. "ernel: " ..
335 kernel_name .. " (" .. idx .. " of " ..
338 func = function(_, choice, _)
339 if loader.getenv("kernelname") ~= nil then
340 loader.perform("unload")
342 config.selectKernel(choice)
347 entry_type = core.MENU_SUBMENU,
348 name = "Boot " .. color.highlight("O") .. "ptions",
349 submenu = menu.boot_options,
352 zpool_checkpoints = {
353 entry_type = core.MENU_ENTRY,
356 if core.isRewinded() then
359 return "Rewind ZFS " .. color.highlight("C") ..
360 "heckpoint: " .. rewind
363 core.changeRewindCheckpoint()
364 if core.isRewinded() then
366 core.bootenvDefaultRewinded())
368 bootenvSet(core.bootenvDefault())
370 config.setCarouselIndex("be_active", 1)
373 return core.isZFSBoot() and
374 core.isCheckpointed()
379 entry_type = core.MENU_SUBMENU,
381 return core.isZFSBoot() and
382 #core.bootenvList() > 1
384 name = "Boot " .. color.highlight("E") .. "nvironments",
385 submenu = menu.boot_environments,
389 entry_type = core.MENU_ENTRY,
391 return 'Chain' .. color.highlight("L") ..
392 "oad " .. loader.getenv('chain_disk')
395 loader.perform("chain " ..
396 loader.getenv('chain_disk'))
399 return loader.getenv('chain_disk') ~= nil
406 menu.default = menu.welcome
407 -- current_alias_table will be used to keep our alias table consistent across
408 -- screen redraws, instead of relying on whatever triggered the redraw to update
409 -- the local alias_table in menu.process.
410 menu.current_alias_table = {}
412 function menu.draw(menudef)
413 -- Clear the screen, reset the cursor, then draw
415 menu.current_alias_table = drawer.drawscreen(menudef)
420 -- 'keypress' allows the caller to indicate that a key has been pressed that we
421 -- should process as our initial input.
422 function menu.process(menudef, keypress)
423 assert(menudef ~= nil)
425 if drawn_menu ~= menudef then
430 local key = keypress or io.getchar()
433 -- Special key behaviors
434 if (key == core.KEY_BACKSPACE or key == core.KEY_DELETE) and
435 menudef ~= menu.default then
437 elseif key == core.KEY_ENTER then
439 -- Should not return. If it does, escape menu handling
440 -- and drop to loader prompt.
444 key = string.char(key)
445 -- check to see if key is an alias
446 local sel_entry = nil
447 for k, v in pairs(menu.current_alias_table) do
454 -- if we have an alias do the assigned action:
455 if sel_entry ~= nil then
456 local handler = menu.handlers[sel_entry.entry_type]
457 assert(handler ~= nil)
458 -- The handler's return value indicates if we
459 -- need to exit this menu. An omitted or true
460 -- return value means to continue.
461 if handler(menudef, sel_entry) == false then
464 -- If we got an alias key the screen is out of date...
473 local delay = loader.getenv("autoboot_delay")
475 if delay ~= nil and delay:lower() == "no" then
478 delay = tonumber(delay) or 10
486 menu.draw(menu.default)
489 autoboot_key = menu.autoboot(delay)
491 -- autoboot_key should return the key pressed. It will only
492 -- return nil if we hit the timeout and executed the timeout
493 -- command. Bail out.
494 if autoboot_key == nil then
499 menu.process(menu.default, autoboot_key)
503 print("Exiting menu!")
506 function menu.autoboot(delay)
507 local x = loader.getenv("loader_menu_timeout_x") or 4
508 local y = loader.getenv("loader_menu_timeout_y") or 23
509 local endtime = loader.time() + delay
513 time = endtime - loader.time()
514 if last == nil or last ~= time then
516 screen.setcursor(x, y)
517 print("Autoboot in " .. time ..
518 " seconds, hit [Enter] to boot" ..
519 " or any other key to stop ")
523 local ch = io.getchar()
524 if ch == core.KEY_ENTER then
527 -- erase autoboot msg
528 screen.setcursor(0, y)
529 print(string.rep(" ", 80))
538 local cmd = loader.getenv("menu_timeout_command") or "boot"
539 cli_execute_unparsed(cmd)