xref: /freebsd/stand/common/interp_lua.c (revision 2f513db72b034fd5ef7f080b11be5c711c15186a)
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 __FBSDID("$FreeBSD$");
30 
31 #include <stand.h>
32 #include "bootstrap.h"
33 
34 #define lua_c
35 
36 #include "lstd.h"
37 
38 #include <lua.h>
39 #include <ldebug.h>
40 #include <lauxlib.h>
41 #include <lualib.h>
42 
43 #include <lerrno.h>
44 #include <lfs.h>
45 #include <lutils.h>
46 
47 struct interp_lua_softc {
48 	lua_State	*luap;
49 };
50 
51 static struct interp_lua_softc lua_softc;
52 
53 #ifdef LUA_DEBUG
54 #define	LDBG(...)	do {			\
55 	printf("%s(%d): ", __func__, __LINE__);	\
56 	printf(__VA_ARGS__);			\
57 	printf("\n");				\
58 } while (0)
59 #else
60 #define	LDBG(...)
61 #endif
62 
63 #define	LOADER_LUA	LUA_PATH "/loader.lua"
64 
65 INTERP_DEFINE("lua");
66 
67 static void *
68 interp_lua_realloc(void *ud __unused, void *ptr, size_t osize __unused, size_t nsize)
69 {
70 
71 	if (nsize == 0) {
72 		free(ptr);
73 		return NULL;
74 	}
75 	return realloc(ptr, nsize);
76 }
77 
78 /*
79  * The libraries commented out below either lack the proper
80  * support from libsa, or they are unlikely to be useful
81  * in the bootloader, so have been commented out.
82  */
83 static const luaL_Reg loadedlibs[] = {
84   {"_G", luaopen_base},
85   {LUA_LOADLIBNAME, luaopen_package},
86 //  {LUA_COLIBNAME, luaopen_coroutine},
87 //  {LUA_TABLIBNAME, luaopen_table},
88   {LUA_STRLIBNAME, luaopen_string},
89 //  {LUA_IOLIBNAME, luaopen_io},
90 //  {LUA_OSLIBNAME, luaopen_os},
91 //  {LUA_MATHLIBNAME, luaopen_math},
92 //  {LUA_UTF8LIBNAME, luaopen_utf8},
93 //  {LUA_DBLIBNAME, luaopen_debug},
94   {"errno", luaopen_errno},
95   {"io", luaopen_io},
96   {"lfs", luaopen_lfs},
97   {"loader", luaopen_loader},
98   {NULL, NULL}
99 };
100 
101 void
102 interp_init(void)
103 {
104 	lua_State *luap;
105 	struct interp_lua_softc	*softc = &lua_softc;
106 	const char *filename;
107 	const luaL_Reg *lib;
108 
109 	setenv("script.lang", "lua", 1);
110 	LDBG("creating context");
111 
112 	luap = lua_newstate(interp_lua_realloc, NULL);
113 	if (luap == NULL) {
114 		printf("problem initializing the Lua interpreter\n");
115 		abort();
116 	}
117 	softc->luap = luap;
118 
119 	/* "require" functions from 'loadedlibs' and set results to global table */
120 	for (lib = loadedlibs; lib->func; lib++) {
121 		luaL_requiref(luap, lib->name, lib->func, 1);
122 		lua_pop(luap, 1);  /* remove lib */
123 	}
124 
125 	filename = LOADER_LUA;
126 	if (interp_include(filename) != 0) {
127 		const char *errstr = lua_tostring(luap, -1);
128 		errstr = errstr == NULL ? "unknown" : errstr;
129 		printf("Startup error in %s:\nLUA ERROR: %s.\n", filename, errstr);
130 		lua_pop(luap, 1);
131 		setenv("autoboot_delay", "NO", 1);
132 	}
133 }
134 
135 int
136 interp_run(const char *line)
137 {
138 	int	argc, nargc;
139 	char	**argv;
140 	lua_State *luap;
141 	struct interp_lua_softc	*softc = &lua_softc;
142 	int status, ret;
143 
144 	luap = softc->luap;
145 	LDBG("executing line...");
146 	if ((status = luaL_dostring(luap, line)) != 0) {
147 		lua_pop(luap, 1);
148 		/*
149 		 * The line wasn't executable as lua; run it through parse to
150 		 * to get consistent parsing of command line arguments, then
151 		 * run it through cli_execute. If that fails, then we'll try it
152 		 * as a builtin.
153 		 */
154 		command_errmsg = NULL;
155 		if (parse(&argc, &argv, line) == 0) {
156 			lua_getglobal(luap, "cli_execute");
157 			for (nargc = 0; nargc < argc; ++nargc) {
158 				lua_pushstring(luap, argv[nargc]);
159 			}
160 			status = lua_pcall(luap, argc, 1, 0);
161 			ret = lua_tointeger(luap, 1);
162 			lua_pop(luap, 1);
163 			if (status != 0 || ret != 0) {
164 				/*
165 				 * Lua cli_execute will pass the function back
166 				 * through loader.command, which is a proxy to
167 				 * interp_builtin_cmd. If we failed to interpret
168 				 * the command, though, then there's a chance
169 				 * that didn't happen. Call interp_builtin_cmd
170 				 * directly if our lua_pcall was not successful.
171 				 */
172 				status = interp_builtin_cmd(argc, argv);
173 			}
174 			if (status != 0) {
175 				if (command_errmsg != NULL)
176 					printf("%s\n", command_errmsg);
177 				else
178 					printf("Command failed\n");
179 				status = CMD_ERROR;
180 			}
181 			free(argv);
182 		} else {
183 			printf("Failed to parse \'%s\'\n", line);
184 			status = CMD_ERROR;
185 		}
186 	}
187 
188 	return (status == 0 ? CMD_OK : CMD_ERROR);
189 }
190 
191 int
192 interp_include(const char *filename)
193 {
194 	struct interp_lua_softc	*softc = &lua_softc;
195 
196 	LDBG("loading file %s", filename);
197 
198 	return (luaL_dofile(softc->luap, filename));
199 }
200