2 * Copyright (c) 2018 Conrad Meyer <cem@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
26 * Portions derived from https://github.com/keplerproject/luafilesystem under
27 * the terms of the MIT license:
29 * Copyright (c) 2003-2014 Kepler Project.
31 * Permission is hereby granted, free of charge, to any person
32 * obtaining a copy of this software and associated documentation
33 * files (the "Software"), to deal in the Software without
34 * restriction, including without limitation the rights to use, copy,
35 * modify, merge, publish, distribute, sublicense, and/or sell copies
36 * of the Software, and to permit persons to whom the Software is
37 * furnished to do so, subject to the following conditions:
39 * The above copyright notice and this permission notice shall be
40 * included in all copies or substantial portions of the Software.
42 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
43 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
44 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
45 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
46 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
47 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
48 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
52 #include <sys/cdefs.h>
53 __FBSDID("$FreeBSD$");
71 #include "bootstrap.h"
75 #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
79 * The goal is to emulate a subset of the upstream Lua FileSystem library, as
80 * faithfully as possible in the boot environment. Only APIs that seem useful
85 * for file in lfs.dir("/boot") do
94 * The other available API is lfs.attributes(), which functions somewhat like
95 * stat(2) and returns a table of values. Example code:
97 * attrs, errormsg, errorcode = lfs.attributes("/boot")
98 * if attrs == nil then
103 * for k, v in pairs(attrs) do
104 * print(k .. ":\t" .. v)
108 * Prints (on success):
110 * change: 140737488342640
114 * dev: 140737488342544
115 * modification: 140737488342576
117 * access: 140737488342560
123 #define DIR_METATABLE "directory iterator metatable"
126 lua_dir_iter_pushtype(lua_State *L __unused, const struct dirent *ent __unused)
130 * This is a non-standard extension to luafilesystem for loader's
131 * benefit. The extra stat() calls to determine the entry type can
132 * be quite expensive on some systems, so this speeds up enumeration of
133 * /boot greatly by providing the type up front.
135 * This extension is compatible enough with luafilesystem, in that we're
136 * just using an extra return value for the iterator.
139 lua_pushinteger(L, ent->d_type);
147 lua_dir_iter_next(lua_State *L)
149 struct dirent *entry;
152 dpp = (DIR **)luaL_checkudata(L, 1, DIR_METATABLE);
154 luaL_argcheck(L, dp != NULL, 1, "closed directory");
157 entry = readdirfd(dp->fd);
167 lua_pushstring(L, entry->d_name);
168 return 1 + lua_dir_iter_pushtype(L, entry);
172 lua_dir_iter_close(lua_State *L)
176 dpp = (DIR **)lua_touserdata(L, 1);
187 lua_dir(lua_State *L)
192 if (lua_gettop(L) != 1) {
197 path = luaL_checkstring(L, 1);
204 lua_pushcfunction(L, lua_dir_iter_next);
205 *(DIR **)lua_newuserdata(L, sizeof(DIR **)) = dp;
206 luaL_getmetatable(L, DIR_METATABLE);
207 lua_setmetatable(L, -2);
212 register_metatable(lua_State *L)
215 * Create so-called metatable for iterator object returned by
218 luaL_newmetatable(L, DIR_METATABLE);
221 lua_pushcfunction(L, lua_dir_iter_next);
222 lua_setfield(L, -2, "next");
223 lua_pushcfunction(L, lua_dir_iter_close);
224 lua_setfield(L, -2, "close");
226 /* Magically associate anonymous method table with metatable. */
227 lua_setfield(L, -2, "__index");
228 /* Implement magic destructor method */
229 lua_pushcfunction(L, lua_dir_iter_close);
230 lua_setfield(L, -2, "__gc");
235 #define PUSH_INTEGER(lname, stname) \
237 push_st_ ## lname (lua_State *L, struct stat *sb) \
239 lua_pushinteger(L, (lua_Integer)sb->st_ ## stname); \
241 PUSH_INTEGER(dev, dev)
242 PUSH_INTEGER(ino, ino)
243 PUSH_INTEGER(nlink, nlink)
244 PUSH_INTEGER(uid, uid)
245 PUSH_INTEGER(gid, gid)
246 PUSH_INTEGER(rdev, rdev)
247 PUSH_INTEGER(access, atime)
248 PUSH_INTEGER(modification, mtime)
249 PUSH_INTEGER(change, ctime)
250 PUSH_INTEGER(size, size)
254 push_st_mode(lua_State *L, struct stat *sb)
259 mode = (sb->st_mode & S_IFMT);
262 else if (S_ISDIR(mode))
263 mode_s = "directory";
264 else if (S_ISLNK(mode))
266 else if (S_ISSOCK(mode))
268 else if (S_ISFIFO(mode))
270 else if (S_ISCHR(mode))
271 mode_s = "char device";
272 else if (S_ISBLK(mode))
273 mode_s = "block device";
277 lua_pushstring(L, mode_s);
281 push_st_permissions(lua_State *L, struct stat *sb)
287 * Could actually format as "-rwxrwxrwx" -- do we care?
289 snprintf(buf, sizeof(buf), "%o", sb->st_mode & ~S_IFMT);
290 lua_pushstring(L, buf);
293 #define PUSH_ENTRY(n) { #n, push_st_ ## n }
294 struct stat_members {
296 void (*push)(lua_State *, struct stat *);
306 PUSH_ENTRY(modification),
309 PUSH_ENTRY(permissions),
314 lua_attributes(lua_State *L)
317 const char *path, *member;
321 path = luaL_checkstring(L, 1);
324 lua_pushfstring(L, "cannot convert first argument to string");
325 lua_pushinteger(L, EINVAL);
329 rc = stat(path, &sb);
333 "cannot obtain information from file '%s': %s", path,
335 lua_pushinteger(L, errno);
339 if (lua_isstring(L, 2)) {
340 member = lua_tostring(L, 2);
341 for (i = 0; i < nitems(members); i++) {
342 if (strcmp(members[i].name, member) != 0)
345 members[i].push(L, &sb);
348 return luaL_error(L, "invalid attribute name '%s'", member);
351 /* Create or reuse existing table */
353 if (!lua_istable(L, 2))
356 /* Export all stat data to caller */
357 for (i = 0; i < nitems(members); i++) {
358 lua_pushstring(L, members[i].name);
359 members[i].push(L, &sb);
366 #define lfs_mkdir_impl(path) (mkdir((path), \
367 S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | \
371 lua_mkdir(lua_State *L)
376 path = luaL_checkstring(L, 1);
379 lua_pushfstring(L, "cannot convert first argument to string");
380 lua_pushinteger(L, EINVAL);
384 error = lfs_mkdir_impl(path);
386 /* Save it; unclear what other libc functions may be invoked */
389 lua_pushfstring(L, strerror(serrno));
390 lua_pushinteger(L, serrno);
394 lua_pushboolean(L, 1);
399 lua_rmdir(lua_State *L)
404 path = luaL_checkstring(L, 1);
407 lua_pushfstring(L, "cannot convert first argument to string");
408 lua_pushinteger(L, EINVAL);
414 /* Save it; unclear what other libc functions may be invoked */
417 lua_pushfstring(L, strerror(serrno));
418 lua_pushinteger(L, serrno);
422 lua_pushboolean(L, 1);
427 #define REG_SIMPLE(n) { #n, lua_ ## n }
428 static const struct luaL_Reg fslib[] = {
429 REG_SIMPLE(attributes),
440 luaopen_lfs(lua_State *L)
442 register_metatable(L);
443 luaL_newlib(L, fslib);
445 /* Non-standard extension for loader, used with lfs.dir(). */
446 lua_pushinteger(L, DT_DIR);
447 lua_setfield(L, -2, "DT_DIR");