xref: /freebsd-12.1/stand/lua/cli.lua (revision eca5ca66)
1--
2-- Copyright (c) 2018 Kyle Evans <[email protected]>
3-- All rights reserved.
4--
5-- Redistribution and use in source and binary forms, with or without
6-- modification, are permitted provided that the following conditions
7-- are met:
8-- 1. Redistributions of source code must retain the above copyright
9--    notice, this list of conditions and the following disclaimer.
10-- 2. Redistributions in binary form must reproduce the above copyright
11--    notice, this list of conditions and the following disclaimer in the
12--    documentation and/or other materials provided with the distribution.
13--
14-- THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15-- ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17-- ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18-- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19-- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20-- OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21-- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22-- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23-- OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24-- SUCH DAMAGE.
25--
26-- $FreeBSD$
27--
28
29local config = require("config")
30local core = require("core")
31
32local cli = {}
33
34-- Internal function
35-- Parses arguments to boot and returns two values: kernel_name, argstr
36-- Defaults to nil and "" respectively.
37-- This will also parse arguments to autoboot, but the with_kernel argument
38-- will need to be explicitly overwritten to false
39local parse_boot_args = function(argv, with_kernel)
40	if with_kernel == nil then
41		with_kernel = true
42	end
43	if #argv == 0 then
44		if with_kernel then
45			return nil, ""
46		else
47			return ""
48		end
49	end
50	local kernel_name
51	local argstr = ""
52
53	for k, v in ipairs(argv) do
54		if with_kernel and v:sub(1,1) ~= "-" then
55			kernel_name = v
56		else
57			argstr = argstr .. " " .. v
58		end
59	end
60	if with_kernel then
61		return kernel_name, argstr
62	else
63		return argstr
64	end
65end
66
67-- Globals
68
69function boot(...)
70	local cmd_name, argv = cli.arguments(...)
71	local kernel, argstr = parse_boot_args(argv)
72	if kernel ~= nil then
73		loader.perform("unload")
74		config.selectkernel(kernel)
75	end
76	core.boot(argstr)
77end
78
79function autoboot(...)
80	local cmd_name, argv = cli.arguments(...)
81	local argstr = parse_boot_args(argv, false)
82	core.autoboot(argstr)
83end
84
85-- Declares a global function cli_execute that attempts to dispatch the
86-- arguments passed as a lua function. This gives lua a chance to intercept
87-- builtin CLI commands like "boot"
88function cli_execute(...)
89	local argv = {...}
90	-- Just in case...
91	if #argv == 0 then
92		loader.command(...)
93		return
94	end
95
96	local cmd_name = argv[1]
97	local cmd = _G[cmd_name]
98	if cmd ~= nil and type(cmd) == "function" then
99		-- Pass argv wholesale into cmd. We could omit argv[0] since the
100		-- traditional reasons for including it don't necessarily apply,
101		-- it may not be totally redundant if we want to have one global
102		-- handling multiple commands
103		cmd(...)
104	else
105		loader.command(...)
106	end
107
108end
109
110-- Module exports
111
112function cli.arguments(...)
113	local argv = {...}
114	local cmd_name = ""
115	cmd_name, argv = core.popFrontTable(argv)
116	return cmd_name, argv
117end
118
119return cli
120