From: Demi Marie Obenour <demiobenour@gmail.com>
To: Spectrum OS Development <devel@spectrum-os.org>
Cc: Demi Marie Obenour <demiobenour@gmail.com>, Alyssa Ross <hi@alyssa.is>
Subject: [PATCH v4 1/2] tools: Add adapter tool for services using sd_notify
Date: Fri, 03 Oct 2025 17:42:55 -0400 [thread overview]
Message-ID: <20251003-udev-v4-1-7d7344b14d11@gmail.com> (raw)
In-Reply-To: <20251003-udev-v4-0-7d7344b14d11@gmail.com>
This adapts programs using sd_notify for use with s6 readiness
notification. stdin and stdout are hard-coded for simplicity.
Signed-off-by: Demi Marie Obenour <demiobenour@gmail.com>
---
systemd readiness notification has two
strict advantages over the s6 version:
1. It allows reliable reloading.
2. It allows providing a status message that the service manager
can show in status output.
s6 would actually benefit from both of these features.
---
Changes since v1:
- Hard-code file descriptors.
- Run wrapper as background process.
- Massively reduce code size.
- Use // instead of /* */ for comments.
- Check that the notification FD is a pipe and that the listening socket
is a socket.
- Rely on s6-ipc-socketbinder to create the listening socket.
- Do not unlink the listening socket.
---
tools/default.nix | 1 +
tools/meson.build | 1 +
tools/sd-notify-adapter/meson.build | 4 +
tools/sd-notify-adapter/sd-notify-adapter.c | 114 ++++++++++++++++++++++++++++
4 files changed, 120 insertions(+)
diff --git a/tools/default.nix b/tools/default.nix
index 2c6846c80073e7b64fb7a19488103f6cf97a4420..4971e8bf6d84163b665ba0fb2af570cafa3171f5 100644
--- a/tools/default.nix
+++ b/tools/default.nix
@@ -77,6 +77,7 @@ stdenv.mkDerivation (finalAttrs: {
./lsvm
./start-vmm
./subprojects
+ ./sd-notify-adapter
] ++ lib.optionals driverSupport [
./xdp-forwarder
]));
diff --git a/tools/meson.build b/tools/meson.build
index 186008dbc9dd2b63adbce7475c375fb0de5c2c6a..5d0ae81042fd3d77646594500f32cb1d48a6af0c 100644
--- a/tools/meson.build
+++ b/tools/meson.build
@@ -27,6 +27,7 @@ if get_option('host')
subdir('lsvm')
subdir('start-vmm')
+ subdir('sd-notify-adapter')
endif
if get_option('app')
diff --git a/tools/sd-notify-adapter/meson.build b/tools/sd-notify-adapter/meson.build
new file mode 100644
index 0000000000000000000000000000000000000000..6032a3a7704d49cae0655b43d0189444d3b15e4d
--- /dev/null
+++ b/tools/sd-notify-adapter/meson.build
@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: ISC
+# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour@gmail.com>
+
+executable('sd-notify-adapter', 'sd-notify-adapter.c', install: true)
diff --git a/tools/sd-notify-adapter/sd-notify-adapter.c b/tools/sd-notify-adapter/sd-notify-adapter.c
new file mode 100644
index 0000000000000000000000000000000000000000..10f4e05eb602491540a792c7fb5620d66d5bb989
--- /dev/null
+++ b/tools/sd-notify-adapter/sd-notify-adapter.c
@@ -0,0 +1,114 @@
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour@gmail.com>
+
+#define _GNU_SOURCE 1
+#include <assert.h>
+#include <errno.h>
+#include <limits.h>
+#include <signal.h>
+#include <stdarg.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <err.h>
+#include <fcntl.h>
+#include <poll.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <sys/un.h>
+#include <unistd.h>
+
+#define ARRAY_SIZE(s) (sizeof(s)/sizeof(s[0]))
+
+enum {
+ socket_fd,
+ notification_fd,
+};
+
+#define READY "READY=1"
+#define READY_SIZE (sizeof(READY) - 1)
+
+static void process_notification(struct iovec *const msg)
+{
+ ssize_t first_recv_size = recv(socket_fd, msg->iov_base, msg->iov_len,
+ MSG_DONTWAIT | MSG_TRUNC | MSG_PEEK);
+ if (first_recv_size == -1) {
+ if (errno == EINTR)
+ return; // signal caught
+ if (errno == EAGAIN || errno == EWOULDBLOCK)
+ return; // spurious wakeup
+ err(EXIT_FAILURE, "recv from notification socket");
+ }
+ assert(first_recv_size >= 0);
+ size_t size = (size_t)first_recv_size;
+ if (size == 0)
+ return; // avoid arithmetic on NULL pointer
+ if (size > msg->iov_len) {
+ msg->iov_base = realloc(msg->iov_base, size);
+ if (msg->iov_base == NULL)
+ err(EXIT_FAILURE, "allocation failure");
+ msg->iov_len = size;
+ }
+ ssize_t second_recv_size = recv(socket_fd, msg->iov_base, msg->iov_len,
+ MSG_CMSG_CLOEXEC | MSG_TRUNC);
+ if (second_recv_size == -1) {
+ if (errno == EINTR)
+ return;
+ err(EXIT_FAILURE, "recv from notification socket");
+ }
+ assert(first_recv_size == second_recv_size);
+ for (char *next, *cursor = msg->iov_base, *end = cursor + size;
+ cursor != NULL; cursor = (next == NULL ? NULL : next + 1)) {
+ next = memchr(cursor, '\n', (size_t)(end - cursor));
+ size_t message_size = (size_t)((next == NULL ? end : next) - cursor);
+ if (message_size == READY_SIZE &&
+ memcmp(cursor, READY, READY_SIZE) == 0) {
+ ssize_t write_size = write(notification_fd, "\n", 1);
+ if (write_size != 1)
+ err(EXIT_FAILURE, "writing to notification descriptor");
+ exit(0);
+ }
+ }
+}
+
+int main(int argc, char **)
+{
+ if (argc != 1)
+ errx(EXIT_FAILURE, "stdin is listening socket, stdout is notification pipe");
+ // Main event loop.
+ struct iovec v = {
+ .iov_base = NULL,
+ .iov_len = 0,
+ };
+ for (;;) {
+ struct pollfd p[] = {
+ {
+ .fd = socket_fd,
+ .events = POLLIN,
+ .revents = 0,
+ },
+ {
+ .fd = notification_fd,
+ .events = 0,
+ .revents = 0,
+ },
+ };
+ int r = poll(p, ARRAY_SIZE(p), -1);
+ if (r < 0) {
+ if (errno == EINTR)
+ continue;
+ err(EXIT_FAILURE, "poll");
+ }
+ if (p[0].revents) {
+ if (p[0].revents & POLLERR)
+ errx(EXIT_FAILURE, "unexpected POLLERR");
+ if (p[0].revents & POLLIN)
+ process_notification(&v);
+ }
+ if (p[1].revents)
+ errx(EXIT_FAILURE, "s6 closed its pipe before the child was ready");
+ }
+}
--
2.51.0
next prev parent reply other threads:[~2025-10-03 21:43 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-14 3:16 [PATCH 0/3] Switch from mdevd to systemd-udevd in root filesystem Demi Marie Obenour
2025-09-14 3:16 ` [PATCH 1/3] host/rootfs: Add early serial output Demi Marie Obenour
2025-09-17 11:45 ` Alyssa Ross
2025-09-18 2:44 ` Demi Marie Obenour
2025-09-19 14:21 ` Alyssa Ross
2025-09-19 14:49 ` Alyssa Ross
2025-09-14 3:16 ` [PATCH 2/3] tools: Add adapter tool for services using sd_notify Demi Marie Obenour
2025-09-14 3:16 ` [PATCH 3/3] host/rootfs: switch to systemd-udevd Demi Marie Obenour
2025-09-19 14:12 ` Alyssa Ross
2025-09-19 19:32 ` Demi Marie Obenour
2025-09-21 12:18 ` Alyssa Ross
2025-09-21 17:02 ` Demi Marie Obenour
2025-09-21 16:27 ` Demi Marie Obenour
2025-09-21 16:28 ` Demi Marie Obenour
2025-09-23 18:39 ` Alyssa Ross
2025-09-23 19:18 ` Demi Marie Obenour
2025-09-24 10:32 ` [PATCH v2 0/3] Switch from mdevd to systemd-udevd in root filesystem Demi Marie Obenour
2025-09-24 10:32 ` [PATCH v2 1/3] tools: Add adapter tool for services using sd_notify Demi Marie Obenour
2025-09-25 10:29 ` Alyssa Ross
2025-09-25 16:54 ` Demi Marie Obenour
2025-09-24 10:32 ` [PATCH v2 2/3] host/rootfs: Switch to systemd-udevd Demi Marie Obenour
2025-09-25 10:53 ` Alyssa Ross
2025-09-25 17:53 ` Demi Marie Obenour
2025-09-26 14:56 ` Alyssa Ross
2025-09-28 22:51 ` [PATCH v3 0/2] Switch from mdevd to systemd-udevd in root filesystem Demi Marie Obenour
2025-09-28 22:51 ` [PATCH v3 1/2] tools: Add adapter tool for services using sd_notify Demi Marie Obenour
2025-10-01 16:06 ` Alyssa Ross
2025-09-28 22:51 ` [PATCH v3 2/2] host/rootfs: Switch to systemd-udevd Demi Marie Obenour
2025-10-01 14:24 ` Alyssa Ross
2025-10-01 14:39 ` Alyssa Ross
2025-10-01 17:40 ` Demi Marie Obenour
2025-10-02 9:53 ` Alyssa Ross
2025-10-02 10:34 ` Alyssa Ross
2025-10-02 10:36 ` [PATCH v3 0/2] Switch from mdevd to systemd-udevd in root filesystem Alyssa Ross
2025-10-03 21:42 ` [PATCH v4 " Demi Marie Obenour
2025-10-03 21:42 ` Demi Marie Obenour [this message]
2025-10-28 15:38 ` [PATCH v4 1/2] tools: Add adapter tool for services using sd_notify Alyssa Ross
2025-10-28 22:56 ` Demi Marie Obenour
2025-10-29 11:26 ` Alyssa Ross
2025-10-31 4:34 ` Demi Marie Obenour
2025-10-31 8:54 ` Alyssa Ross
2025-11-01 18:23 ` Demi Marie Obenour
2025-10-03 21:42 ` [PATCH v4 2/2] host/rootfs: Switch to systemd-udevd Demi Marie Obenour
2025-10-28 16:02 ` Alyssa Ross
2025-10-28 22:56 ` Demi Marie Obenour
2025-10-29 9:31 ` Alyssa Ross
2025-10-29 9:55 ` Demi Marie Obenour
2025-09-24 10:32 ` [PATCH v2 3/3] host/rootfs: Simplify s6-rc dependencies Demi Marie Obenour
2025-09-25 11:07 ` Alyssa Ross
2025-09-25 15:50 ` Demi Marie Obenour
2025-10-02 10:37 ` Alyssa Ross
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251003-udev-v4-1-7d7344b14d11@gmail.com \
--to=demiobenour@gmail.com \
--cc=devel@spectrum-os.org \
--cc=hi@alyssa.is \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://spectrum-os.org/git/crosvm
https://spectrum-os.org/git/doc
https://spectrum-os.org/git/mktuntap
https://spectrum-os.org/git/nixpkgs
https://spectrum-os.org/git/spectrum
https://spectrum-os.org/git/ucspi-vsock
https://spectrum-os.org/git/www
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).