xref: /freebsd/stand/common/interp_lua.c (revision 02e9120893770924227138ba49df1edb3896112a)
1 /*-
2  * Copyright (c) 2011 Wojciech A. Koszek <wkoszek@FreeBSD.org>
3  * Copyright (c) 2014 Pedro Souza <pedrosouza@freebsd.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 #include <stand.h>
30 #include "bootstrap.h"
31 
32 #define lua_c
33 
34 #include "lstd.h"
35 
36 #include <lua.h>
37 #include <ldebug.h>
38 #include <lauxlib.h>
39 #include <lualib.h>
40 
41 #include <lerrno.h>
42 #include <lfs.h>
43 #include <lutils.h>
44 
45 struct interp_lua_softc {
46 	lua_State	*luap;
47 };
48 
49 static struct interp_lua_softc lua_softc;
50 
51 #ifdef LUA_DEBUG
52 #define	LDBG(...)	do {			\
53 	printf("%s(%d): ", __func__, __LINE__);	\
54 	printf(__VA_ARGS__);			\
55 	printf("\n");				\
56 } while (0)
57 #else
58 #define	LDBG(...)
59 #endif
60 
61 #define	LOADER_LUA	LUA_PATH "/loader.lua"
62 
63 INTERP_DEFINE("lua");
64 
65 static void *
66 interp_lua_realloc(void *ud __unused, void *ptr, size_t osize __unused, size_t nsize)
67 {
68 
69 	if (nsize == 0) {
70 		free(ptr);
71 		return NULL;
72 	}
73 	return realloc(ptr, nsize);
74 }
75 
76 /*
77  * The libraries commented out below either lack the proper
78  * support from libsa, or they are unlikely to be useful
79  * in the bootloader, so have been commented out.
80  */
81 static const luaL_Reg loadedlibs[] = {
82   {"_G", luaopen_base},
83   {LUA_LOADLIBNAME, luaopen_package},
84 //  {LUA_COLIBNAME, luaopen_coroutine},
85 //  {LUA_TABLIBNAME, luaopen_table},
86   {LUA_STRLIBNAME, luaopen_string},
87 //  {LUA_IOLIBNAME, luaopen_io},
88 //  {LUA_OSLIBNAME, luaopen_os},
89 //  {LUA_MATHLIBNAME, luaopen_math},
90 //  {LUA_UTF8LIBNAME, luaopen_utf8},
91 //  {LUA_DBLIBNAME, luaopen_debug},
92   {"errno", luaopen_errno},
93   {"io", luaopen_io},
94   {"lfs", luaopen_lfs},
95   {"loader", luaopen_loader},
96   {"pager", luaopen_pager},
97   {NULL, NULL}
98 };
99 
100 void
101 interp_init(void)
102 {
103 	lua_State *luap;
104 	struct interp_lua_softc	*softc = &lua_softc;
105 	const char *filename;
106 	const luaL_Reg *lib;
107 
108 	TSENTER();
109 
110 	setenv("script.lang", "lua", 1);
111 	LDBG("creating context");
112 
113 	luap = lua_newstate(interp_lua_realloc, NULL);
114 	if (luap == NULL) {
115 		printf("problem initializing the Lua interpreter\n");
116 		abort();
117 	}
118 	softc->luap = luap;
119 
120 	/* "require" functions from 'loadedlibs' and set results to global table */
121 	for (lib = loadedlibs; lib->func; lib++) {
122 		luaL_requiref(luap, lib->name, lib->func, 1);
123 		lua_pop(luap, 1);  /* remove lib */
124 	}
125 
126 	filename = LOADER_LUA;
127 	if (interp_include(filename) != 0) {
128 		const char *errstr = lua_tostring(luap, -1);
129 		errstr = errstr == NULL ? "unknown" : errstr;
130 		printf("ERROR: %s.\n", errstr);
131 		lua_pop(luap, 1);
132 		setenv("autoboot_delay", "NO", 1);
133 	}
134 
135 	TSEXIT();
136 }
137 
138 int
139 interp_run(const char *line)
140 {
141 	int	argc, nargc;
142 	char	**argv;
143 	lua_State *luap;
144 	struct interp_lua_softc	*softc = &lua_softc;
145 	int status, ret;
146 
147 	TSENTER();
148 	luap = softc->luap;
149 	LDBG("executing line...");
150 	if ((status = luaL_dostring(luap, line)) != 0) {
151 		lua_pop(luap, 1);
152 		/*
153 		 * The line wasn't executable as lua; run it through parse to
154 		 * to get consistent parsing of command line arguments, then
155 		 * run it through cli_execute. If that fails, then we'll try it
156 		 * as a builtin.
157 		 */
158 		command_errmsg = NULL;
159 		if (parse(&argc, &argv, line) == 0) {
160 			lua_getglobal(luap, "cli_execute");
161 			for (nargc = 0; nargc < argc; ++nargc) {
162 				lua_pushstring(luap, argv[nargc]);
163 			}
164 			status = lua_pcall(luap, argc, 1, 0);
165 			ret = lua_tointeger(luap, 1);
166 			lua_pop(luap, 1);
167 			if (status != 0 || ret != 0) {
168 				/*
169 				 * Lua cli_execute will pass the function back
170 				 * through loader.command, which is a proxy to
171 				 * interp_builtin_cmd. If we failed to interpret
172 				 * the command, though, then there's a chance
173 				 * that didn't happen. Call interp_builtin_cmd
174 				 * directly if our lua_pcall was not successful.
175 				 */
176 				status = interp_builtin_cmd(argc, argv);
177 			}
178 			if (status != 0) {
179 				if (command_errmsg != NULL)
180 					printf("%s\n", command_errmsg);
181 				else
182 					printf("Command failed\n");
183 				status = CMD_ERROR;
184 			}
185 			free(argv);
186 		} else {
187 			printf("Failed to parse \'%s\'\n", line);
188 			status = CMD_ERROR;
189 		}
190 	}
191 
192 	TSEXIT();
193 	return (status == 0 ? CMD_OK : CMD_ERROR);
194 }
195 
196 int
197 interp_include(const char *filename)
198 {
199 	struct interp_lua_softc	*softc = &lua_softc;
200 
201 	LDBG("loading file %s", filename);
202 
203 	return (luaL_dofile(softc->luap, filename));
204 }
205