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$");
60 #include "bootstrap.h"
63 #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
67 * The goal is to emulate a subset of the upstream Lua FileSystem library, as
68 * faithfully as possible in the boot environment. Only APIs that seem useful
73 * for file in lfs.dir("/boot") do
82 * The other available API is lfs.attributes(), which functions somewhat like
83 * stat(2) and returns a table of values. Example code:
85 * attrs, errormsg, errorcode = lfs.attributes("/boot")
86 * if attrs == nil then
91 * for k, v in pairs(attrs) do
92 * print(k .. ":\t" .. v)
96 * Prints (on success):
98 * change: 140737488342640
102 * dev: 140737488342544
103 * modification: 140737488342576
105 * access: 140737488342560
111 #define DIR_METATABLE "directory iterator metatable"
114 lua_dir_iter_next(lua_State *L)
116 struct dirent *entry;
119 dpp = (DIR **)luaL_checkudata(L, 1, DIR_METATABLE);
121 luaL_argcheck(L, dp != NULL, 1, "closed directory");
123 entry = readdirfd(dp->fd);
130 lua_pushstring(L, entry->d_name);
135 lua_dir_iter_close(lua_State *L)
139 dpp = (DIR **)lua_touserdata(L, 1);
150 lua_dir(lua_State *L)
155 if (lua_gettop(L) != 1) {
160 path = luaL_checkstring(L, 1);
167 lua_pushcfunction(L, lua_dir_iter_next);
168 *(DIR **)lua_newuserdata(L, sizeof(DIR **)) = dp;
169 luaL_getmetatable(L, DIR_METATABLE);
170 lua_setmetatable(L, -2);
175 register_metatable(lua_State *L)
178 * Create so-called metatable for iterator object returned by
181 luaL_newmetatable(L, DIR_METATABLE);
184 lua_pushcfunction(L, lua_dir_iter_next);
185 lua_setfield(L, -2, "next");
186 lua_pushcfunction(L, lua_dir_iter_close);
187 lua_setfield(L, -2, "close");
189 /* Magically associate anonymous method table with metatable. */
190 lua_setfield(L, -2, "__index");
191 /* Implement magic destructor method */
192 lua_pushcfunction(L, lua_dir_iter_close);
193 lua_setfield(L, -2, "__gc");
198 #define PUSH_INTEGER(lname, stname) \
200 push_st_ ## lname (lua_State *L, struct stat *sb) \
202 lua_pushinteger(L, (lua_Integer)sb->st_ ## stname); \
204 PUSH_INTEGER(dev, dev)
205 PUSH_INTEGER(ino, ino)
206 PUSH_INTEGER(nlink, nlink)
207 PUSH_INTEGER(uid, uid)
208 PUSH_INTEGER(gid, gid)
209 PUSH_INTEGER(rdev, rdev)
210 PUSH_INTEGER(access, atime)
211 PUSH_INTEGER(modification, mtime)
212 PUSH_INTEGER(change, ctime)
213 PUSH_INTEGER(size, size)
217 push_st_mode(lua_State *L, struct stat *sb)
222 mode = (sb->st_mode & S_IFMT);
225 else if (S_ISDIR(mode))
226 mode_s = "directory";
227 else if (S_ISLNK(mode))
229 else if (S_ISSOCK(mode))
231 else if (S_ISFIFO(mode))
233 else if (S_ISCHR(mode))
234 mode_s = "char device";
235 else if (S_ISBLK(mode))
236 mode_s = "block device";
240 lua_pushstring(L, mode_s);
244 push_st_permissions(lua_State *L, struct stat *sb)
250 * Could actually format as "-rwxrwxrwx" -- do we care?
252 snprintf(buf, sizeof(buf), "%o", sb->st_mode & ~S_IFMT);
253 lua_pushstring(L, buf);
256 #define PUSH_ENTRY(n) { #n, push_st_ ## n }
257 struct stat_members {
259 void (*push)(lua_State *, struct stat *);
269 PUSH_ENTRY(modification),
272 PUSH_ENTRY(permissions),
277 lua_attributes(lua_State *L)
280 const char *path, *member;
284 path = luaL_checkstring(L, 1);
287 lua_pushfstring(L, "cannot convert first argument to string");
288 lua_pushinteger(L, EINVAL);
292 rc = stat(path, &sb);
296 "cannot obtain information from file '%s': %s", path,
298 lua_pushinteger(L, errno);
302 if (lua_isstring(L, 2)) {
303 member = lua_tostring(L, 2);
304 for (i = 0; i < nitems(members); i++) {
305 if (strcmp(members[i].name, member) != 0)
308 members[i].push(L, &sb);
311 return luaL_error(L, "invalid attribute name '%s'", member);
314 /* Create or reuse existing table */
316 if (!lua_istable(L, 2))
319 /* Export all stat data to caller */
320 for (i = 0; i < nitems(members); i++) {
321 lua_pushstring(L, members[i].name);
322 members[i].push(L, &sb);
328 #define REG_SIMPLE(n) { #n, lua_ ## n }
329 static const struct luaL_Reg fslib[] = {
330 REG_SIMPLE(attributes),
337 luaopen_lfs(lua_State *L)
339 register_metatable(L);
340 luaL_newlib(L, fslib);