summaryrefslogtreecommitdiff
path: root/lib9p_util
diff options
context:
space:
mode:
Diffstat (limited to 'lib9p_util')
-rw-r--r--lib9p_util/CMakeLists.txt13
-rw-r--r--lib9p_util/include/util9p/static.h85
-rw-r--r--lib9p_util/static.c234
3 files changed, 332 insertions, 0 deletions
diff --git a/lib9p_util/CMakeLists.txt b/lib9p_util/CMakeLists.txt
new file mode 100644
index 0000000..feeada7
--- /dev/null
+++ b/lib9p_util/CMakeLists.txt
@@ -0,0 +1,13 @@
+# lib9p_util/CMakeLists.txt - Utilities for using the lib9p server
+#
+# Copyright (C) 2025 Luke T. Shumaker <lukeshu@lukeshu.com>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+add_library(lib9p_util INTERFACE)
+target_include_directories(lib9p_util PUBLIC INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_sources(lib9p_util INTERFACE
+ static.c
+)
+target_link_libraries(lib9p_util INTERFACE
+ lib9p_srv
+)
diff --git a/lib9p_util/include/util9p/static.h b/lib9p_util/include/util9p/static.h
new file mode 100644
index 0000000..0b391b8
--- /dev/null
+++ b/lib9p_util/include/util9p/static.h
@@ -0,0 +1,85 @@
+/* util9p/static.h - Serve static files over 9P
+ *
+ * Copyright (C) 2024-2025 Luke T. Shumaker <lukeshu@lukeshu.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+#ifndef _UTIL9P_STATIC_H_
+#define _UTIL9P_STATIC_H_
+
+#include <lib9p/srv.h>
+
+#define util9p_box(nam, obj) \
+ ((struct lib9p_srv_file){ \
+ .self = obj, \
+ .vtable = (void*)&_lo_##nam##_lib9p_srv_file_vtable, \
+ })
+
+#define UTIL9P_ATIME 1728337905
+#define UTIL9P_MTIME 1728337904
+
+/* Common *********************************************************************/
+
+typedef struct {
+ char *u_name;
+ uint32_t u_num;
+ char *g_name;
+ uint32_t g_num;
+ char *m_name;
+ uint32_t m_num;
+
+ uint64_t pathnum;
+ char *name;
+ lib9p_dm_t perm;
+ uint32_t atime, mtime;
+} _util9p_static_common;
+
+#define UTIL9P_STATIC_COMMON(PATH, STRNAME, MODE) \
+ { \
+ .u_name = "root", .u_num = 0, /* owner user */ \
+ .g_name = "root", .g_num = 0, /* owner group */ \
+ .m_name = "root", .m_num = 0, /* last-modified-by user */ \
+ \
+ .pathnum = PATH, \
+ .name = STRNAME, \
+ .perm = MODE, \
+ .atime = UTIL9P_ATIME, \
+ .mtime = UTIL9P_MTIME, \
+ }
+
+/* Dir ************************************************************************/
+
+struct util9p_static_dir {
+ _util9p_static_common;
+
+ /* NULL-terminated */
+ lo_interface lib9p_srv_file members[];
+};
+LO_IMPLEMENTATION_H(lib9p_srv_file, struct util9p_static_dir, util9p_static_dir);
+#define lo_box_util9p_static_dir_as_lib9p_srv_file(obj) util9p_box(util9p_static_dir, obj)
+
+#define UTIL9P_STATIC_DIR(PATH, STRNAME, ...) \
+ lo_box_util9p_static_dir_as_lib9p_srv_file(&((struct util9p_static_dir){ \
+ ._util9p_static_common = UTIL9P_STATIC_COMMON(PATH, STRNAME, 0555), \
+ .members = { __VA_ARGS__ LO_NULL(lib9p_srv_file) }, \
+ }))
+
+/* File ***********************************************************************/
+
+struct util9p_static_file {
+ _util9p_static_common;
+
+ char *data_start; /* must not be NULL */
+ char *data_end; /* may be NULL, in which case data_size is used */
+ size_t data_size; /* only used if .data_end==NULL */
+};
+LO_IMPLEMENTATION_H(lib9p_srv_file, struct util9p_static_file, util9p_static_file);
+#define lo_box_util9p_static_file_as_lib9p_srv_file(obj) util9p_box(util9p_static_file, obj)
+
+#define UTIL9P_STATIC_FILE(PATH, STRNAME, ...) \
+ lo_box_util9p_static_file_as_lib9p_srv_file(&((struct util9p_static_file){ \
+ ._util9p_static_common = UTIL9P_STATIC_COMMON(PATH, STRNAME, 0444), \
+ __VA_ARGS__ \
+ }))
+
+#endif /* _UTIL9P_STATIC_H_ */
diff --git a/lib9p_util/static.c b/lib9p_util/static.c
new file mode 100644
index 0000000..1726319
--- /dev/null
+++ b/lib9p_util/static.c
@@ -0,0 +1,234 @@
+/* lib9p_util/static.c - Serve static files over 9P
+ *
+ * Copyright (C) 2024-2025 Luke T. Shumaker <lukeshu@lukeshu.com>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+#include <libmisc/assert.h>
+#include <libmisc/macro.h>
+
+#include <util9p/static.h>
+
+LO_IMPLEMENTATION_C(lib9p_srv_file, struct util9p_static_dir, util9p_static_dir, static);
+LO_IMPLEMENTATION_C(lib9p_srv_file, struct util9p_static_file, util9p_static_file, static);
+
+LO_IMPLEMENTATION_H(lib9p_srv_dio, struct util9p_static_dir, util9p_static_dir);
+LO_IMPLEMENTATION_C(lib9p_srv_dio, struct util9p_static_dir, util9p_static_dir, static);
+
+LO_IMPLEMENTATION_H(lib9p_srv_fio, struct util9p_static_file, util9p_static_file);
+LO_IMPLEMENTATION_C(lib9p_srv_fio, struct util9p_static_file, util9p_static_file, static);
+
+/* dir ************************************************************************/
+
+static void util9p_static_dir_free(struct util9p_static_dir *self) {
+ assert(self);
+}
+static struct lib9p_qid util9p_static_dir_qid(struct util9p_static_dir *self) {
+ assert(self);
+
+ return (struct lib9p_qid){
+ .type = LIB9P_QT_DIR,
+ .vers = 1,
+ .path = self->pathnum,
+ };
+}
+
+static struct lib9p_srv_stat util9p_static_dir_stat(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx) {
+ assert(self);
+ assert(ctx);
+
+ return (struct lib9p_srv_stat){
+ .qid = util9p_static_dir_qid(self),
+ .mode = LIB9P_DM_DIR | (self->perm & 0555),
+ .atime_sec = self->atime,
+ .mtime_sec = self->mtime,
+ .size = 0,
+ .name = lib9p_str(self->name),
+ .owner_uid = { .name = lib9p_str(self->u_name), .num = self->u_num },
+ .owner_gid = { .name = lib9p_str(self->g_name), .num = self->g_num },
+ .last_modifier_uid = { .name = lib9p_str(self->m_name), .num = self->m_num },
+ .extension = lib9p_str(NULL),
+ };
+}
+static void util9p_static_dir_wstat(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx,
+ struct lib9p_srv_stat) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+}
+static void util9p_static_dir_remove(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+}
+
+static lo_interface lib9p_srv_file util9p_static_dir_dwalk(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx,
+ struct lib9p_s childname) {
+ assert(self);
+ assert(ctx);
+
+ for (size_t i = 0; !LO_IS_NULL(self->members[i]); i++) {
+ lo_interface lib9p_srv_file file = self->members[i];
+ struct lib9p_srv_stat stat = LO_CALL(file, stat, ctx);
+ if (lib9p_ctx_has_error(&ctx->basectx))
+ break;
+ lib9p_srv_stat_assert(stat);
+ if (lib9p_str_eq(stat.name, childname))
+ return file;
+ }
+ lib9p_error(&ctx->basectx,
+ LIB9P_ERRNO_L_ENOENT, "no such file or directory");
+ return LO_NULL(lib9p_srv_file);
+}
+
+static lo_interface lib9p_srv_file util9p_static_dir_dcreate(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx,
+ struct lib9p_s LM_UNUSED(childname),
+ struct lib9p_srv_userid *LM_UNUSED(user),
+ struct lib9p_srv_userid *LM_UNUSED(group),
+ lib9p_dm_t LM_UNUSED(perm)) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+ return LO_NULL(lib9p_srv_file);
+}
+
+LIB9P_SRV_NOTFILE(struct util9p_static_dir, util9p_static_dir);
+
+static lo_interface lib9p_srv_dio util9p_static_dir_dopen(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx) {
+ assert(self);
+ assert(ctx);
+ return lo_box_util9p_static_dir_as_lib9p_srv_dio(self);
+}
+static void util9p_static_dir_iofree(struct util9p_static_dir *self) {
+ assert(self);
+}
+static struct lib9p_srv_dirent util9p_static_dir_dread(struct util9p_static_dir *self, struct lib9p_srv_ctx *ctx, size_t idx) {
+ assert(self);
+ assert(ctx);
+
+ lo_interface lib9p_srv_file file = self->members[idx];
+ if (LO_IS_NULL(file))
+ return (struct lib9p_srv_dirent){};
+
+ struct lib9p_srv_stat stat = LO_CALL(file, stat, ctx);
+ if (lib9p_ctx_has_error(&ctx->basectx))
+ return (struct lib9p_srv_dirent){};
+ lib9p_srv_stat_assert(stat);
+
+ return (struct lib9p_srv_dirent){
+ .qid = stat.qid,
+ .name = stat.name,
+ };
+}
+
+/* file ***********************************************************************/
+
+static void util9p_static_file_free(struct util9p_static_file *self) {
+ assert(self);
+}
+static struct lib9p_qid util9p_static_file_qid(struct util9p_static_file *self) {
+ assert(self);
+
+ return (struct lib9p_qid){
+ .type = LIB9P_QT_FILE,
+ .vers = 1,
+ .path = self->pathnum,
+ };
+}
+
+static inline size_t util9p_static_file_size(struct util9p_static_file *file) {
+ assert(file);
+
+#if __unix__
+ assert(file->data_start);
+#endif
+ if (!file->data_end)
+ return file->data_size;
+ return (size_t)((uintptr_t)file->data_end - (uintptr_t)file->data_start);
+}
+
+
+static struct lib9p_srv_stat util9p_static_file_stat(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx) {
+ assert(self);
+ assert(ctx);
+
+ return (struct lib9p_srv_stat){
+ .qid = util9p_static_file_qid(self),
+ .mode = self->perm & 0444,
+ .atime_sec = self->atime,
+ .mtime_sec = self->mtime,
+ .size = (uint64_t)util9p_static_file_size(self),
+ .name = lib9p_str(self->name),
+ .owner_uid = { .name = lib9p_str(self->u_name), .num = self->u_num },
+ .owner_gid = { .name = lib9p_str(self->g_name), .num = self->g_num },
+ .last_modifier_uid = { .name = lib9p_str(self->m_name), .num = self->m_num },
+ .extension = lib9p_str(NULL),
+ };
+}
+static void util9p_static_file_wstat(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx,
+ struct lib9p_srv_stat) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+}
+static void util9p_static_file_remove(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+}
+
+LIB9P_SRV_NOTDIR(struct util9p_static_file, util9p_static_file);
+
+static lo_interface lib9p_srv_fio util9p_static_file_fopen(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx,
+ bool rd, bool wr, bool trunc) {
+ assert(self);
+ assert(ctx);
+ assert(rd);
+ assert(!wr);
+ assert(!trunc);
+ return lo_box_util9p_static_file_as_lib9p_srv_fio(self);
+}
+static void util9p_static_file_iofree(struct util9p_static_file *self) {
+ assert(self);
+}
+static uint32_t util9p_static_file_iounit(struct util9p_static_file *self) {
+ assert(self);
+ return 0;
+}
+static void util9p_static_file_pread(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx,
+ uint32_t byte_count, uint64_t byte_offset,
+ struct iovec *ret) {
+ assert(self);
+ assert(ctx);
+ assert(ret);
+
+ size_t data_size = util9p_static_file_size(self);
+
+ if (byte_offset > (uint64_t)data_size) {
+ lib9p_error(&ctx->basectx,
+ LIB9P_ERRNO_L_EINVAL, "offset is past end-of-file length");
+ return;
+ }
+
+ size_t beg_off = (size_t)byte_offset;
+ size_t end_off = beg_off + (size_t)byte_count;
+ if (end_off > data_size)
+ end_off = data_size;
+ ret->iov_base = &self->data_start[beg_off];
+ ret->iov_len = end_off-beg_off;
+}
+static uint32_t util9p_static_file_pwrite(struct util9p_static_file *self, struct lib9p_srv_ctx *ctx,
+ void *LM_UNUSED(buf),
+ uint32_t LM_UNUSED(byte_count),
+ uint64_t LM_UNUSED(byte_offset)) {
+ assert(self);
+ assert(ctx);
+
+ lib9p_error(&ctx->basectx, LIB9P_ERRNO_L_EROFS, "read-only part of filesystem");
+ return 0;
+}
generated by cgit v1.2.3-2-g168b (git 2.25.1) at 2025-04-21 22:13:32 +0000