git: de1d7d7b87cf - main - flua: add freebsd module implementing kldload/kldunload

From: Baptiste Daroussin <bapt_at_FreeBSD.org>
Date: Fri, 06 Sep 2024 15:29:14 UTC
The branch main has been updated by bapt:

URL: https://cgit.FreeBSD.org/src/commit/?id=de1d7d7b87cfa31a1d6c7bcf1acd27de8139cab3

commit de1d7d7b87cfa31a1d6c7bcf1acd27de8139cab3
Author:     Baptiste Daroussin <bapt@FreeBSD.org>
AuthorDate: 2024-09-06 09:00:50 +0000
Commit:     Baptiste Daroussin <bapt@FreeBSD.org>
CommitDate: 2024-09-06 15:25:54 +0000

    flua: add freebsd module implementing kldload/kldunload
    
    Reviewed by:    markj, imp
    Approved by:    imp
    Differential Revision:  https://reviews.freebsd.org/D46558
---
 etc/mtree/BSD.usr.dist                             |   4 +
 lib/flua/libfreebsd/Makefile                       |   3 +
 lib/flua/libfreebsd/sys/Makefile                   |   4 +
 lib/flua/libfreebsd/sys/linker/Makefile            |  12 +++
 .../libfreebsd/sys/linker/freebsd.sys.linker.3lua  |  67 +++++++++++++
 .../libfreebsd/sys/linker/lua_freebsd_sys_linker.c | 104 +++++++++++++++++++++
 6 files changed, 194 insertions(+)

diff --git a/etc/mtree/BSD.usr.dist b/etc/mtree/BSD.usr.dist
index 13541aac1dd4..60d458f5d336 100644
--- a/etc/mtree/BSD.usr.dist
+++ b/etc/mtree/BSD.usr.dist
@@ -74,6 +74,10 @@
         engines-3
         ..
         flua
+            freebsd
+                sys
+                ..
+            ..
         ..
         i18n
         ..
diff --git a/lib/flua/libfreebsd/Makefile b/lib/flua/libfreebsd/Makefile
new file mode 100644
index 000000000000..6ed0451055ff
--- /dev/null
+++ b/lib/flua/libfreebsd/Makefile
@@ -0,0 +1,3 @@
+SUBDIR+=	sys
+
+.include <bsd.subdir.mk>
diff --git a/lib/flua/libfreebsd/sys/Makefile b/lib/flua/libfreebsd/sys/Makefile
new file mode 100644
index 000000000000..9f38294536f2
--- /dev/null
+++ b/lib/flua/libfreebsd/sys/Makefile
@@ -0,0 +1,4 @@
+SUBDIR+=	linker
+
+.include <bsd.subdir.mk>
+
diff --git a/lib/flua/libfreebsd/sys/linker/Makefile b/lib/flua/libfreebsd/sys/linker/Makefile
new file mode 100644
index 000000000000..318cc5078b33
--- /dev/null
+++ b/lib/flua/libfreebsd/sys/linker/Makefile
@@ -0,0 +1,12 @@
+SHLIB_NAME=	linker.so
+SHLIBDIR=	${LIBDIR}/flua/freebsd/sys
+
+SRCS+=		lua_freebsd_sys_linker.c
+
+CFLAGS+= \
+	-I${SRCTOP}/contrib/lua/src \
+	-I${SRCTOP}/lib/liblua \
+
+MAN=	freebsd.sys.linker.3lua
+
+.include <bsd.lib.mk>
diff --git a/lib/flua/libfreebsd/sys/linker/freebsd.sys.linker.3lua b/lib/flua/libfreebsd/sys/linker/freebsd.sys.linker.3lua
new file mode 100644
index 000000000000..0ab8f185388a
--- /dev/null
+++ b/lib/flua/libfreebsd/sys/linker/freebsd.sys.linker.3lua
@@ -0,0 +1,67 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
+.\" Copyright (c) 2024, Baptiste Daroussin <bapt@FreeBSD.org>
+.\"
+.\" 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.
+.\"
+.Dd September 6, 2024
+.Dt FREEBSD.SYS.LINKER 3lua
+.Os
+.Sh NAME
+.Nm freebsd.sys.linker
+.Nd Lua binding to
+.Fx 's
+Linker functions
+.Sh SYNOPSIS
+.Bd -literal
+local linker = require('freebsd.sys.linker')
+.Ed
+.Pp
+.Bl -tag -width XXXX -compact
+.It Dv fileid, err, errno = linker.kldload(name)
+.It Dv ok, err, errno = linker.kldunload(fileid|name)
+.El
+.Sh DESCRIPTION
+The
+.Nm
+module is a binding to the
+.Fx 's
+linker functions.
+List of functions:
+.Bl -tag -width XXXX
+.It Dv fileid, err = freebsd.sys.linker.kldload(name)
+Load the kernel module named
+.Fa name
+and return the identifier
+.Pq fileid
+as an interger.
+.It Dv ok, err, errno = freebsd.sys.linker.kldunload(fileid|name)
+Unload the kernel module identifier either by
+.Fa name
+as a string, or
+.Fa fileid
+as an integer.
+.El
+.Sh SEE ALSO
+.Xr kldload 2 ,
+.Xr kldunload 2
diff --git a/lib/flua/libfreebsd/sys/linker/lua_freebsd_sys_linker.c b/lib/flua/libfreebsd/sys/linker/lua_freebsd_sys_linker.c
new file mode 100644
index 000000000000..a2dc3b487525
--- /dev/null
+++ b/lib/flua/libfreebsd/sys/linker/lua_freebsd_sys_linker.c
@@ -0,0 +1,104 @@
+/*-
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ * Copyright (c) 2024, Baptiste Daroussin <bapt@FreeBSD.org>
+ *
+ * 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 REGENTS 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 REGENTS 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/param.h>
+#include <sys/linker.h>
+
+#include <errno.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <lua.h>
+#include <lualib.h>
+#include <lauxlib.h>
+
+int luaopen_freebsd_sys_linker(lua_State *L);
+
+static int
+lua_kldload(lua_State *L)
+{
+	const char *name;
+	int ret;
+
+	name = luaL_checkstring(L, 1);
+	ret = kldload(name);
+	if (ret == -1) {
+		lua_pushnil(L);
+		lua_pushstring(L, strerror(errno));
+		lua_pushinteger(L, errno);
+		return (3);
+	}
+	lua_pushinteger(L, ret);
+	return (1);
+}
+
+static int
+lua_kldunload(lua_State *L)
+{
+	const char *name;
+	int ret, fileid;
+
+	if (lua_isinteger(L, 1)) {
+		fileid = lua_tointeger(L, 1);
+	} else {
+		name = luaL_checkstring(L, 1);
+		fileid = kldfind(name);
+	}
+	if (fileid == -1) {
+		lua_pushnil(L);
+		lua_pushstring(L, strerror(errno));
+		lua_pushinteger(L, errno);
+		return (3);
+	}
+	ret = kldunload(fileid);
+	lua_pushinteger(L, ret);
+	if (ret == -1) {
+		lua_pushnil(L);
+		lua_pushstring(L, strerror(errno));
+		lua_pushinteger(L, errno);
+		return (3);
+	}
+	lua_pushinteger(L, 0);
+	return (1);
+}
+
+#define REG_SIMPLE(n)	{ #n, lua_ ## n }
+static const struct luaL_Reg freebsd_sys_linker[] = {
+	REG_SIMPLE(kldload),
+	REG_SIMPLE(kldunload),
+	{ NULL, NULL },
+};
+#undef REG_SIMPLE
+
+int
+luaopen_freebsd_sys_linker(lua_State *L)
+{
+	luaL_newlib(L, freebsd_sys_linker);
+
+	return (1);
+}