freebsd-dev/stand/common/interp_lua.c
Kyle Evans d3d381b2b1 userboot: handle guest interpreter mismatches more intelligently
The switch to lualoader creates a problem with userboot: the host is
inclined to build userboot with Lua, but the host userboot's interpreter
must match what's available on the guest. For almost all FreeBSD guests in
the wild, Lua is not yet available and a Lua-based userboot will fail.

This revision updates userboot protocol to version 5, which adds a
swap_interpreter callback to request a different interpreter, and tries to
determine the proper interpreter to be used based on how the guest
/boot/loader is compiled. This is still a bit of a guess, but it's likely
the best possible guess we can make in order to get it right. The
interpreter is now embedded in the resulting executable, so we can open
/boot/loader on the guest and hunt that down to derive the interpreter it
was built with.

Using -l with bhyveload will not allow an intepreter swap, even if the
loader specified happens to be a userboot with the wrong interpreter. We'll
simply complain about the mismatch and bail out.

For legacy guests without the interpreter marker, we assume they're 4th.
For new guests with the interpreter marker, we'll read it and swap over
to the proper interpreter if it doesn't match what the userboot we're using
was compiled with.

Both flavors of userboot are installed by default, userboot_4th.so and
userboot_lua.so. This fixes the build WITHOUT_FORTH as a coincidence, which
was broken by userboot being forced to 4th.

Reviewed by:	imp, jhb, araujo (earlier version)
Approved by:	re (gjb)
Differential Revision:	https://reviews.freebsd.org/D16945
2018-09-01 02:23:45 +00:00

197 lines
5.3 KiB
C

/*-
* Copyright (c) 2011 Wojciech A. Koszek <wkoszek@FreeBSD.org>
* Copyright (c) 2014 Pedro Souza <pedrosouza@freebsd.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <stand.h>
#include "bootstrap.h"
#define lua_c
#include "lstd.h"
#include <lua.h>
#include <ldebug.h>
#include <lauxlib.h>
#include <lualib.h>
#include <lerrno.h>
#include <lfs.h>
#include <lutils.h>
struct interp_lua_softc {
lua_State *luap;
};
static struct interp_lua_softc lua_softc;
#ifdef LUA_DEBUG
#define LDBG(...) do { \
printf("%s(%d): ", __func__, __LINE__); \
printf(__VA_ARGS__); \
printf("\n"); \
} while (0)
#else
#define LDBG(...)
#endif
INTERP_DEFINE("lua");
static void *
interp_lua_realloc(void *ud __unused, void *ptr, size_t osize __unused, size_t nsize)
{
if (nsize == 0) {
free(ptr);
return NULL;
}
return realloc(ptr, nsize);
}
/*
* The libraries commented out below either lack the proper
* support from libsa, or they are unlikely to be useful
* in the bootloader, so have been commented out.
*/
static const luaL_Reg loadedlibs[] = {
{"_G", luaopen_base},
{LUA_LOADLIBNAME, luaopen_package},
// {LUA_COLIBNAME, luaopen_coroutine},
// {LUA_TABLIBNAME, luaopen_table},
{LUA_STRLIBNAME, luaopen_string},
// {LUA_IOLIBNAME, luaopen_io},
// {LUA_OSLIBNAME, luaopen_os},
// {LUA_MATHLIBNAME, luaopen_math},
// {LUA_UTF8LIBNAME, luaopen_utf8},
// {LUA_DBLIBNAME, luaopen_debug},
{"errno", luaopen_errno},
{"io", luaopen_io},
{"lfs", luaopen_lfs},
{"loader", luaopen_loader},
{NULL, NULL}
};
void
interp_init(void)
{
lua_State *luap;
struct interp_lua_softc *softc = &lua_softc;
const char *filename;
const luaL_Reg *lib;
setenv("script.lang", "lua", 1);
LDBG("creating context");
luap = lua_newstate(interp_lua_realloc, NULL);
if (luap == NULL) {
printf("problem initializing the Lua interpreter\n");
abort();
}
softc->luap = luap;
/* "require" functions from 'loadedlibs' and set results to global table */
for (lib = loadedlibs; lib->func; lib++) {
luaL_requiref(luap, lib->name, lib->func, 1);
lua_pop(luap, 1); /* remove lib */
}
filename = "/boot/lua/loader.lua";
if (interp_include(filename) != 0) {
const char *errstr = lua_tostring(luap, -1);
errstr = errstr == NULL ? "unknown" : errstr;
printf("Startup error in %s:\nLUA ERROR: %s.\n", filename, errstr);
lua_pop(luap, 1);
}
}
int
interp_run(const char *line)
{
int argc, nargc;
char **argv;
lua_State *luap;
struct interp_lua_softc *softc = &lua_softc;
int status, ret;
luap = softc->luap;
LDBG("executing line...");
if ((status = luaL_dostring(luap, line)) != 0) {
lua_pop(luap, 1);
/*
* The line wasn't executable as lua; run it through parse to
* to get consistent parsing of command line arguments, then
* run it through cli_execute. If that fails, then we'll try it
* as a builtin.
*/
command_errmsg = NULL;
if (parse(&argc, &argv, line) == 0) {
lua_getglobal(luap, "cli_execute");
for (nargc = 0; nargc < argc; ++nargc) {
lua_pushstring(luap, argv[nargc]);
}
status = lua_pcall(luap, argc, 1, 0);
ret = lua_tointeger(luap, 1);
lua_pop(luap, 1);
if (status != 0 || ret != 0) {
/*
* Lua cli_execute will pass the function back
* through loader.command, which is a proxy to
* interp_builtin_cmd. If we failed to interpret
* the command, though, then there's a chance
* that didn't happen. Call interp_builtin_cmd
* directly if our lua_pcall was not successful.
*/
status = interp_builtin_cmd(argc, argv);
}
if (status != 0) {
if (command_errmsg != NULL)
printf("%s\n", command_errmsg);
else
printf("Command failed\n");
status = CMD_ERROR;
}
free(argv);
} else {
printf("Failed to parse \'%s\'\n", line);
status = CMD_ERROR;
}
}
return (status == 0 ? CMD_OK : CMD_ERROR);
}
int
interp_include(const char *filename)
{
struct interp_lua_softc *softc = &lua_softc;
LDBG("loading file %s", filename);
return (luaL_dofile(softc->luap, filename));
}