- Spectrum Development - spectrum-os.org

[PATCH v4 0/2] Fix build of forwarder, then improve it
by Demi Marie Obenour 25 Oct '25

25 Oct '25

The first patch fixes the build of the XDP forwarder and ensures it does not include any libc headers. The second patch is a significant cleanup and also should improve performance a tiny amount. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Changes in v4: - Use find_program instead of passing clang path as Meson option. - Use path to Linux kernel package instead of path to include directory. - Split the patch into two parts: a minimal one that just fixes the build, and a bigger one that refactors the BPF programs. - Link to v3: https://spectrum-os.org/lists/archives/spectrum-devel/20251008-fix-forwarde… Changes in v3: - Fix build. - Clean up XDP programs. - Link to v2: https://spectrum-os.org/lists/archives/spectrum-devel/20251006-fix-forwarde… Changes in v2: - Rewrite the programs to not use the helpers. - This doesn't build. Link to v1: https://spectrum-os.org/lists/archives/spectrum-devel/20251003-fix-forwarde… --- Demi Marie Obenour (2): tools/xdp-forwarder: Do not include libc headers in eBPF programs tools/xdp-forwarder: Simplify forwarder programs tools/default.nix | 11 +- tools/meson.options | 4 + tools/xdp-forwarder/helpers.h | 54 +++++++ tools/xdp-forwarder/meson.build | 11 +- tools/xdp-forwarder/parsing_helpers.h | 274 ---------------------------------- tools/xdp-forwarder/prog_physical.c | 52 ++++--- tools/xdp-forwarder/prog_router.c | 48 ++++-- tools/xdp-forwarder/rewrite_helpers.h | 146 ------------------ 8 files changed, 138 insertions(+), 462 deletions(-) --- base-commit: c5d5786d3dc938af0b279c542d1e43bce381b4b9 change-id: 20251003-fix-forwarder-build-2889ea9aec91 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 4

Re: [systemd-devel] With UEFI secure boot and dm-verity, how does one find the user data partition?
by Demi Marie Obenour 20 Oct '25

20 Oct '25

On 10/20/25 14:20, Andrei Borzenkov wrote: > 20.10.2025 21:02, Demi Marie Obenour wrote: >> On 10/20/25 13:57, Andrei Borzenkov wrote: >>> 20.10.2025 20:33, Demi Marie Obenour wrote: >>>> On 10/19/25 11:36, Feli Flitzberg wrote: >>>>> Hi, long time watcher, first time poster. If the bootloader supports the Discoverable Partitions Specification, all that's needed is the correct partition GUID assigned to every partition. After that, you don't need to pass any partitions or use /etc/fstab as the bootloader will read the disk it came from to mount everything. The only major limitation is that your bootloader partition MUST live on the same disk as root and usr, otherwise they won't be found. Hope this helps! >>>> >>>> How can the OS know which block device the system was booted from? >>>> >>> >>> >>> Bootloader compliant with BLI sets the LoaderDevicePartUUID EFI >>> variable. Otherwise I assume it possible to get the current boot entry >>> number from the BootCurrent EFI variable and parse the corresponding >>> BootXXXX entry. >> >> Is this EFI variable the partition table UUID (which identifies a device) >> or a partition UUID (which does not)? > > It is what is printed by lsblk as partuuid. Unfortunately this isn't what is needed. Looks like UEFI variable storage is the best option. -- Sincerely, Demi Marie Obenour (she/her/hers)

3 3

[PATCH] tools/xdp-forwarder: Fix build
by Demi Marie Obenour 18 Oct '25

18 Oct '25

Clang complains that it can't fine gnu-stubs32.h. Drop the ICMP parsing code to avoid this error. No functional change as the code is not actually used. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- tools/xdp-forwarder/parsing_helpers.h | 57 ----------------------------------- 1 file changed, 57 deletions(-) diff --git a/tools/xdp-forwarder/parsing_helpers.h b/tools/xdp-forwarder/parsing_helpers.h index da099346008bd58485af8308feb4d3391ceef8f5..1ea822100fdb9a75c2d28d34d93e6bb2b5d3ae26 100644 --- a/tools/xdp-forwarder/parsing_helpers.h +++ b/tools/xdp-forwarder/parsing_helpers.h @@ -26,8 +26,6 @@ #include <linux/if_packet.h> #include <linux/ip.h> #include <linux/ipv6.h> -#include <linux/icmp.h> -#include <linux/icmpv6.h> #include <linux/udp.h> #include <linux/tcp.h> @@ -46,16 +44,6 @@ struct vlan_hdr { __be16 h_vlan_encapsulated_proto; }; -/* - * Struct icmphdr_common represents the common part of the icmphdr and icmp6hdr - * structures. - */ -struct icmphdr_common { - __u8 type; - __u8 code; - __sum16 cksum; -}; - /* Allow users of header file to redefine VLAN max depth */ #ifndef VLAN_MAX_DEPTH #define VLAN_MAX_DEPTH 2 @@ -175,51 +163,6 @@ static __always_inline int parse_iphdr(struct hdr_cursor *nh, return iph->protocol; } -static __always_inline int parse_icmp6hdr(struct hdr_cursor *nh, - void *data_end, - struct icmp6hdr **icmp6hdr) -{ - struct icmp6hdr *icmp6h = nh->pos; - - if (icmp6h + 1 > data_end) - return -1; - - nh->pos = icmp6h + 1; - *icmp6hdr = icmp6h; - - return icmp6h->icmp6_type; -} - -static __always_inline int parse_icmphdr(struct hdr_cursor *nh, - void *data_end, - struct icmphdr **icmphdr) -{ - struct icmphdr *icmph = nh->pos; - - if (icmph + 1 > data_end) - return -1; - - nh->pos = icmph + 1; - *icmphdr = icmph; - - return icmph->type; -} - -static __always_inline int parse_icmphdr_common(struct hdr_cursor *nh, - void *data_end, - struct icmphdr_common **icmphdr) -{ - struct icmphdr_common *h = nh->pos; - - if (h + 1 > data_end) - return -1; - - nh->pos = h + 1; - *icmphdr = h; - - return h->type; -} - /* * parse_udphdr: parse the udp header and return the length of the udp payload */ --- base-commit: c5d5786d3dc938af0b279c542d1e43bce381b4b9 change-id: 20251003-fix-forwarder-build-2889ea9aec91 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 6

Build failures against staging
by Yureka 12 Oct '25

12 Oct '25

Hello everyone, I attempted to build a spectrum (rev. c5d5786d3dc938af0b279c542d1e43bce381b4b9) image against nixpkgs staging (rev eb681f8139a93020f51b8256fc7dfe057b44747f) on x86_64. Here are the derivations which failed to build, for further investigation: - /nix/store/cbjmszj7r5r0abka3jsr6pijxba0sd2q-iproute2-6.17.0.drv (pkgsMusl.iproute2) - /nix/store/f1cc5abbfjslqvy6wkzrzsmsjj4hpk6h-openssl-static-x86_64-unknown-linux-musl-3.6.0.drv (pkgsStatic.openssl) The following also fail, but seem to have no specific connection spectrum or pkgsMusl/pkgsStatic (the GNU counterparts are broken on staging with the same error): - /nix/store/g0bklsp2daxxq74pkb3mqjcrb919194i-python3.13-inkex-1.4.2.drv (python3.pkgs.inkex) - /nix/store/nfwcjnbp6rv4cgzrxdqljc1k1h72z3kk-python3.13-cryptography-vectors-46.0.1.drv (python3.pkgs.cryptography.vectors) - /nix/store/36674wi2rkanm2ds2bx1183w7knj9mr0-wasilibc-static-wasm32-unknown-wasi-27.drv (pkgsCross.wasi32.stdenv.cc.libc, needed for firefox) I hope this is useful to catch any problems affecting spectrum before the following staging-next cycle. — Yureka

2 2

[PATCH 0/4] Generate file lists from a script
by Demi Marie Obenour 03 Oct '25

03 Oct '25

Right now, the makefiles in host/rootfs, vm/sys/net, and img/app have manually-maintained lists of files and symlinks. These duplicate the information in the git repository and can easily get out of sync or cause unnecessary merge conflicts. Avoid this problem by moving the files used in the erofs images to an image/ directory and using what Git knows about this directory to generate the lists via a script. This makes maintenance easier and avoids conflating code used in the build (anything not in image/) and code for the image (anything that is in image/). This reveals that there is a lot of duplicated make logic around image generation, so consolidate it in a single makefile that is included by all three of the makefiles. This, in turn, makes tree-wide changes easier, as shown by the final patch in this series. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Demi Marie Obenour (4): Move all files for the image into a subdirectory Generate makefile file lists from a script Common make rules for building erofs images Use /etc/s6-rc/compiled for compiled s6-rc directory Documentation/development/built-in-vms.adoc | 7 + host/rootfs/Makefile | 144 +-------------------- host/rootfs/default.nix | 1 + host/rootfs/file-list.mk | 100 ++++++++++++++ host/rootfs/{ => image}/bin | 0 host/rootfs/{ => image}/etc/fonts/fonts.conf | 0 host/rootfs/{ => image}/etc/fstab | 0 host/rootfs/{ => image}/etc/group | 0 host/rootfs/{ => image}/etc/group.license | 0 host/rootfs/{ => image}/etc/init | 0 host/rootfs/{ => image}/etc/login | 0 host/rootfs/{ => image}/etc/mdev.conf | 0 host/rootfs/{ => image}/etc/mdev/listen | 0 host/rootfs/{ => image}/etc/mdev/net/add | 0 host/rootfs/{ => image}/etc/mdev/wait | 0 host/rootfs/{ => image}/etc/parse-devname | 0 host/rootfs/{ => image}/etc/passwd | 0 host/rootfs/{ => image}/etc/passwd.license | 0 .../etc/s6-linux-init/env/WAYLAND_DISPLAY | 0 .../etc/s6-linux-init/env/WAYLAND_DISPLAY.license | 0 .../etc/s6-linux-init/env/XDG_RUNTIME_DIR | 0 .../etc/s6-linux-init/env/XDG_RUNTIME_DIR.license | 0 .../etc/s6-linux-init/run-image/opengl-driver | 0 .../run-image/service/dbus/notification-fd | 0 .../run-image/service/dbus/notification-fd.license | 0 .../etc/s6-linux-init/run-image/service/dbus/run | 0 .../service/dbus/template/notification-fd | 0 .../service/dbus/template/notification-fd.license | 0 .../run-image/service/dbus/template/run | 0 .../s6-linux-init/run-image/service/getty-tty1/run | 0 .../s6-linux-init/run-image/service/getty-tty2/run | 0 .../s6-linux-init/run-image/service/getty-tty3/run | 0 .../s6-linux-init/run-image/service/getty-tty4/run | 0 .../service/s6-svscan-log/notification-fd | 0 .../service/s6-svscan-log/notification-fd.license | 0 .../run-image/service/s6-svscan-log/run | 0 .../run-image/service/serial-getty-generator/run | 0 .../run-image/service/serial-getty/notification-fd | 0 .../service/serial-getty/notification-fd.license | 0 .../run-image/service/serial-getty/run | 0 .../run-image/service/serial-getty/template/run | 0 .../service/vhost-user-fs/notification-fd | 0 .../service/vhost-user-fs/notification-fd.license | 0 .../run-image/service/vhost-user-fs/run | 0 .../service/vhost-user-fs/template/notification-fd | 0 .../vhost-user-fs/template/notification-fd.license | 0 .../run-image/service/vhost-user-fs/template/run | 0 .../service/vhost-user-gpu/notification-fd | 0 .../service/vhost-user-gpu/notification-fd.license | 0 .../run-image/service/vhost-user-gpu/run | 0 .../service/vhost-user-gpu/template/data/check | 0 .../vhost-user-gpu/template/notification-fd | 0 .../template/notification-fd.license | 0 .../run-image/service/vhost-user-gpu/template/run | 0 .../run-image/service/vhost-user-gpu/template/type | 0 .../service/vhost-user-gpu/template/type.license | 0 .../run-image/service/vmm/notification-fd | 0 .../run-image/service/vmm/notification-fd.license | 0 .../etc/s6-linux-init/run-image/service/vmm/run | 0 .../run-image/service/vmm/template/notification-fd | 0 .../service/vmm/template/notification-fd.license | 0 .../run-image/service/vmm/template/run | 0 .../notification-fd | 0 .../notification-fd.license | 0 .../service/xdg-desktop-portal-spectrum-host/run | 0 .../template/notification-fd | 0 .../template/notification-fd.license | 0 .../xdg-desktop-portal-spectrum-host/template/run | 0 .../{ => image}/etc/s6-linux-init/scripts/rc.init | 2 +- host/rootfs/{ => image}/etc/s6-rc/card0/type | 0 .../{ => image}/etc/s6-rc/card0/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/card0/up | 0 host/rootfs/{ => image}/etc/s6-rc/core/type | 0 .../rootfs/{ => image}/etc/s6-rc/core/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/core/up | 0 host/rootfs/{ => image}/etc/s6-rc/kvm/timeout-up | 0 .../{ => image}/etc/s6-rc/kvm/timeout-up.license | 0 host/rootfs/{ => image}/etc/s6-rc/kvm/type | 0 host/rootfs/{ => image}/etc/s6-rc/kvm/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/kvm/up | 0 .../etc/s6-rc/mdevd-coldplug/dependencies | 0 .../{ => image}/etc/s6-rc/mdevd-coldplug/type | 0 .../etc/s6-rc/mdevd-coldplug/type.license | 0 .../rootfs/{ => image}/etc/s6-rc/mdevd-coldplug/up | 0 .../{ => image}/etc/s6-rc/mdevd/notification-fd | 0 .../etc/s6-rc/mdevd/notification-fd.license | 0 host/rootfs/{ => image}/etc/s6-rc/mdevd/run | 0 host/rootfs/{ => image}/etc/s6-rc/mdevd/type | 0 .../{ => image}/etc/s6-rc/mdevd/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/ok-all/contents | 0 host/rootfs/{ => image}/etc/s6-rc/ok-all/type | 0 .../{ => image}/etc/s6-rc/ok-all/type.license | 0 .../rootfs/{ => image}/etc/s6-rc/static-nodes/type | 0 .../etc/s6-rc/static-nodes/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/static-nodes/up | 0 .../{ => image}/etc/s6-rc/sys-vmms/dependencies | 0 host/rootfs/{ => image}/etc/s6-rc/sys-vmms/type | 0 .../{ => image}/etc/s6-rc/sys-vmms/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/sys-vmms/up | 0 host/rootfs/{ => image}/etc/s6-rc/vm-env/contents | 0 host/rootfs/{ => image}/etc/s6-rc/vm-env/type | 0 .../{ => image}/etc/s6-rc/vm-env/type.license | 0 host/rootfs/{ => image}/etc/s6-rc/vmm-env/contents | 0 host/rootfs/{ => image}/etc/s6-rc/vmm-env/type | 0 .../{ => image}/etc/s6-rc/vmm-env/type.license | 0 .../{ => image}/etc/s6-rc/weston/dependencies | 0 .../{ => image}/etc/s6-rc/weston/notification-fd | 0 .../etc/s6-rc/weston/notification-fd.license | 0 host/rootfs/{ => image}/etc/s6-rc/weston/run | 0 host/rootfs/{ => image}/etc/s6-rc/weston/type | 0 .../{ => image}/etc/s6-rc/weston/type.license | 0 host/rootfs/{ => image}/etc/xdg/weston/autolaunch | 0 host/rootfs/{ => image}/etc/xdg/weston/weston.ini | 0 host/rootfs/{ => image}/lib | 0 host/rootfs/{ => image}/sbin | 0 host/rootfs/{ => image}/usr/bin/assign-devices | 0 .../{ => image}/usr/bin/create-vm-dependencies | 0 host/rootfs/{ => image}/usr/bin/run-appimage | 0 host/rootfs/{ => image}/usr/bin/run-vmm | 0 host/rootfs/{ => image}/usr/bin/vm-console | 0 host/rootfs/{ => image}/usr/bin/vm-import | 0 host/rootfs/{ => image}/usr/bin/vm-start | 0 host/rootfs/{ => image}/usr/bin/vm-stop | 0 host/rootfs/{ => image}/usr/bin/xdg-open | 0 .../org.freedesktop.portal.Documents.service | 0 img/app/Makefile | 98 +------------- img/app/default.nix | 1 + img/app/file-list.mk | 65 ++++++++++ img/app/{ => image}/bin | 0 img/app/{ => image}/etc/dbus-1/session.conf | 0 img/app/{ => image}/etc/fonts/fonts.conf | 0 img/app/{ => image}/etc/fstab | 0 img/app/{ => image}/etc/init | 0 img/app/{ => image}/etc/mdev.conf | 0 img/app/{ => image}/etc/mdev/iface | 0 img/app/{ => image}/etc/mdev/listen | 0 img/app/{ => image}/etc/mdev/virtiofs | 0 img/app/{ => image}/etc/mdev/wait | 0 img/app/{ => image}/etc/passwd | 0 img/app/{ => image}/etc/passwd.license | 0 img/app/{ => image}/etc/pipewire/pipewire.conf | 0 img/app/{ => image}/etc/resolv.conf | 0 .../etc/s6-linux-init/env/DBUS_SESSION_BUS_ADDRESS | 0 .../env/DBUS_SESSION_BUS_ADDRESS.license | 0 img/app/{ => image}/etc/s6-linux-init/env/DISPLAY | 0 .../etc/s6-linux-init/env/DISPLAY.license | 0 .../etc/s6-linux-init/env/GTK_USE_PORTAL | 0 .../etc/s6-linux-init/env/GTK_USE_PORTAL.license | 0 .../s6-linux-init/env/NIX_XDG_DESKTOP_PORTAL_DIR | 0 .../env/NIX_XDG_DESKTOP_PORTAL_DIR.license | 0 .../etc/s6-linux-init/env/WAYLAND_DISPLAY | 0 .../etc/s6-linux-init/env/WAYLAND_DISPLAY.license | 0 .../etc/s6-linux-init/env/XDG_RUNTIME_DIR | 0 .../etc/s6-linux-init/env/XDG_RUNTIME_DIR.license | 0 .../s6-linux-init/run-image/service/getty-hvc0/run | 0 .../s6-linux-init-shutdownd/notification-fd | 0 .../notification-fd.license | 0 .../run-image/service/s6-linux-init-shutdownd/run | 0 .../{ => image}/etc/s6-linux-init/scripts/rc.init | 2 +- .../etc/s6-linux-init/scripts/rc.shutdown | 0 .../etc/s6-linux-init/scripts/rc.shutdown.final | 0 .../{ => image}/etc/s6-rc/app/dependencies.d/dbus | 0 .../etc/s6-rc/app/dependencies.d/pipewire | 0 .../s6-rc/app/dependencies.d/wayland-proxy-virtwl | 0 img/app/{ => image}/etc/s6-rc/app/run | 0 img/app/{ => image}/etc/s6-rc/app/type | 0 img/app/{ => image}/etc/s6-rc/app/type.license | 0 img/app/{ => image}/etc/s6-rc/dbus/notification-fd | 0 .../etc/s6-rc/dbus/notification-fd.license | 0 img/app/{ => image}/etc/s6-rc/dbus/run | 0 img/app/{ => image}/etc/s6-rc/dbus/type | 0 img/app/{ => image}/etc/s6-rc/dbus/type.license | 0 .../etc/s6-rc/mdevd-coldplug/dependencies | 0 img/app/{ => image}/etc/s6-rc/mdevd-coldplug/type | 0 .../etc/s6-rc/mdevd-coldplug/type.license | 0 img/app/{ => image}/etc/s6-rc/mdevd-coldplug/up | 0 .../{ => image}/etc/s6-rc/mdevd/notification-fd | 0 .../etc/s6-rc/mdevd/notification-fd.license | 0 img/app/{ => image}/etc/s6-rc/mdevd/run | 0 img/app/{ => image}/etc/s6-rc/mdevd/type | 0 img/app/{ => image}/etc/s6-rc/mdevd/type.license | 0 img/app/{ => image}/etc/s6-rc/ok-all/contents | 0 img/app/{ => image}/etc/s6-rc/ok-all/type | 0 img/app/{ => image}/etc/s6-rc/ok-all/type.license | 0 .../{ => image}/etc/s6-rc/pipewire/notification-fd | 0 .../etc/s6-rc/pipewire/notification-fd.license | 0 img/app/{ => image}/etc/s6-rc/pipewire/run | 0 img/app/{ => image}/etc/s6-rc/pipewire/type | 0 .../{ => image}/etc/s6-rc/pipewire/type.license | 0 .../etc/s6-rc/wayland-proxy-virtwl/notification-fd | 0 .../wayland-proxy-virtwl/notification-fd.license | 0 .../{ => image}/etc/s6-rc/wayland-proxy-virtwl/run | 0 .../etc/s6-rc/wayland-proxy-virtwl/type | 0 .../etc/s6-rc/wayland-proxy-virtwl/type.license | 0 .../etc/s6-rc/wireplumber/dependencies.d/dbus | 0 .../etc/s6-rc/wireplumber/dependencies.d/pipewire | 0 img/app/{ => image}/etc/s6-rc/wireplumber/run | 0 img/app/{ => image}/etc/s6-rc/wireplumber/type | 0 .../{ => image}/etc/s6-rc/wireplumber/type.license | 0 .../{ => image}/etc/ssl/certs/ca-certificates.crt | 0 .../wireplumber.conf.d/99_spectrum.conf | 0 .../etc/xdg/xdg-desktop-portal/portals.conf | 0 img/app/{ => image}/sbin | 0 lib/common.mk | 1 + lib/erofs.mk | 51 ++++++++ scripts/genfiles.awk | 115 ++++++++++++++++ vm/sys/net/Makefile | 68 +--------- vm/sys/net/default.nix | 1 + vm/sys/net/file-list.mk | 41 ++++++ vm/sys/net/{ => image}/bin | 0 vm/sys/net/{ => image}/etc/dbus-1/system.conf | 0 vm/sys/net/{ => image}/etc/fstab | 0 vm/sys/net/{ => image}/etc/init | 0 vm/sys/net/{ => image}/etc/mdev.conf | 0 vm/sys/net/{ => image}/etc/mdev/iface | 0 vm/sys/net/{ => image}/etc/nftables.conf | 0 vm/sys/net/{ => image}/etc/passwd | 0 vm/sys/net/{ => image}/etc/passwd.license | 0 .../s6-linux-init/run-image/service/getty-hvc0/run | 0 .../{ => image}/etc/s6-linux-init/scripts/rc.init | 2 +- .../net/{ => image}/etc/s6-rc/connman/dependencies | 0 vm/sys/net/{ => image}/etc/s6-rc/connman/run | 0 vm/sys/net/{ => image}/etc/s6-rc/connman/type | 0 .../net/{ => image}/etc/s6-rc/connman/type.license | 0 .../net/{ => image}/etc/s6-rc/dbus/notification-fd | 0 .../etc/s6-rc/dbus/notification-fd.license | 0 vm/sys/net/{ => image}/etc/s6-rc/dbus/run | 0 vm/sys/net/{ => image}/etc/s6-rc/dbus/type | 0 vm/sys/net/{ => image}/etc/s6-rc/dbus/type.license | 0 .../etc/s6-rc/mdevd-coldplug/dependencies | 0 .../net/{ => image}/etc/s6-rc/mdevd-coldplug/type | 0 .../etc/s6-rc/mdevd-coldplug/type.license | 0 vm/sys/net/{ => image}/etc/s6-rc/mdevd-coldplug/up | 0 .../{ => image}/etc/s6-rc/mdevd/notification-fd | 0 .../etc/s6-rc/mdevd/notification-fd.license | 0 vm/sys/net/{ => image}/etc/s6-rc/mdevd/run | 0 vm/sys/net/{ => image}/etc/s6-rc/mdevd/type | 0 .../net/{ => image}/etc/s6-rc/mdevd/type.license | 0 vm/sys/net/{ => image}/etc/s6-rc/nftables/type | 0 .../{ => image}/etc/s6-rc/nftables/type.license | 0 vm/sys/net/{ => image}/etc/s6-rc/nftables/up | 0 vm/sys/net/{ => image}/etc/s6-rc/ok-all/contents | 0 vm/sys/net/{ => image}/etc/s6-rc/ok-all/type | 0 .../net/{ => image}/etc/s6-rc/ok-all/type.license | 0 vm/sys/net/{ => image}/etc/s6-rc/sysctl/type | 0 .../net/{ => image}/etc/s6-rc/sysctl/type.license | 0 vm/sys/net/{ => image}/etc/s6-rc/sysctl/up | 0 vm/sys/net/{ => image}/etc/sysctl.conf | 0 vm/sys/net/{ => image}/lib | 0 vm/sys/net/{ => image}/sbin | 0 vm/sys/net/{ => image}/var/run | 0 251 files changed, 400 insertions(+), 299 deletions(-) --- base-commit: 0ac65013a1a29e91ea8476f39113e3598eb0e535 change-id: 20250831-genfiles-46787fc10869 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 50

[PATCH 0/2] scripts/make-erofs.sh: run mkdir/chmod less
by Alyssa Ross 30 Sep '25

30 Sep '25

This is an alternative to Demi's proposal[1] to speed this up. This implementation has the advantage that it does not impose an ordering requirement on the inputs. Nevertheless, it runs just as fast, if not faster (first commit is main; second is Demi's patch; third is this series): | Command | Mean [s] | Min [s] | Max [s] | Relative | |---------------------------+----------------+---------+---------+-------------| | =make (commit = 2551f9e)= | 13.275 ± 0.853 | 11.881 | 16.074 | 1.18 ± 0.11 | | =make (commit = 28fc640)= | 11.467 ± 0.729 | 10.063 | 14.588 | 1.02 ± 0.09 | | =make (commit = 6c3d020)= | 11.215 ± 0.720 | 9.947 | 15.616 | 1.00 | Link: https://spectrum-os.org/lists/archives/spectrum-devel/20250919-less-dirname… [1] Alyssa Ross (2): scripts/make-erofs.sh: run chmod less scripts/make-erofs.sh: run mkdir less scripts/make-erofs.sh | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) base-commit: 2551f9eb1a6c9245699ff5cf77f9957d1e2d14be -- 2.51.0

3 6

This Week in Spectrum, 2025-W39
by Alyssa Ross 29 Sep '25

29 Sep '25

The big news this week is that review of Yureka's XDP forwarding program is complete, and has now been committed to the Spectrum repo[1]. We also saw the usual couple of small cleanups from Demi, several new versions of her script to automatically generate file lists for Makefiles[2], and just a few hours ago, a new version of the udev switch[3]. [1]: https://spectrum-os.org/git/spectrum/commit/?id=535b6bec89a1aae6b0ee9579f9b… [2]: https://spectrum-os.org/lists/archives/spectrum-devel/20250927-genfiles-v6-… [3]: https://spectrum-os.org/lists/archives/spectrum-devel/20250924-udev-v2-0-60… On Friday I gave a talk at the Qubes OS Summit called "Rethinking the Compartmentalization Experience"[4]. Tomorrow (Tuesday, 08:30 UTC) I'll be doing another talk at XDC called "An Upstream-first Approach to Application Virtualization", which will be streamed[5], and on the way back home I'll be stopping by Systems Meetup Dresden[6], where I'll do a lightning talk. [4]: https://www.youtube.com/live/HwisqKFEQ0g?feature=shared&t=16880 [5]: https://live.video.tuwien.ac.at/watch?l=hsJNWfHvxZPnonNLxYNU5Z [6]: https://ukvly.org/

1 0

[PATCH v6 0/4] xdp-forwarder
by Yureka Lilian 27 Sep '25

27 Sep '25

The patches up to and including "vm/sys/net: build against pkgsMusl" can be applied right away, while the last commit ("vm/sys/net: integrate xdp-forwarder") does not make sense without the router. Changes since v5: - fix pkg-tests clang-tidy - re-add hardeningDisable which was accidentally removed in v5 Changes since v4: - Ensure all patches have my Signed-off-by - add native: true to the find_prog(clang) - Remove merge conflicts artifacts in the integration commit Changes since v3: - Apply suggestions from Demi in meson recipe, prog_*.c - Split out the appSupport -> guestSupport rename into a seperate commit - Split out the switch to pkgsMusl into a separate commit with reasoning - rename set_router_iface to set-router-iface Changes since v2: - Switch xdp-forwarder build to meson - Add guest build variant of spectrum-tools Changes since v1: - rebased - apply new uncrustify config - moved xdp-forwarder to tools/ - split integration into separate commit - use linuxHeaders instead of vmlinux.h - use original xdp-tutorial {parsing,rewrite}_helpers.h - inlined the load scripts into /etc/iface/mdev, using /usr/lib/xdp as fixed prefix for finding the XDP progs - removed the README, added a paragraph to architecture doc instead Yureka Lilian (4): tools: add xdp-forwarder docs/architecture: add paragraph about networking vm/sys/net: build against pkgsMusl vm/sys/net: integrate xdp-forwarder Documentation/about/architecture.adoc | 20 ++ pkgs/default.nix | 4 + release/checks/pkg-tests.nix | 1 + tools/default.nix | 21 +- tools/meson.build | 4 + tools/meson_options.txt | 3 + tools/xdp-forwarder/meson.build | 48 +++ tools/xdp-forwarder/parsing_helpers.h | 274 ++++++++++++++++++ tools/xdp-forwarder/prog_physical.c | 39 +++ tools/xdp-forwarder/prog_router.c | 42 +++ tools/xdp-forwarder/rewrite_helpers.h | 146 ++++++++++ tools/xdp-forwarder/set_router_iface.c | 30 ++ vm/sys/net/Makefile | 8 +- vm/sys/net/default.nix | 23 +- vm/sys/net/image/etc/fstab | 2 + vm/sys/net/image/etc/mdev/iface | 27 +- vm/sys/net/image/etc/nftables.conf | 8 - vm/sys/net/image/etc/s6-rc/connman/type | 1 - .../net/image/etc/s6-rc/connman/type.license | 2 - .../net/image/etc/s6-rc/mdevd-coldplug/type | 1 - .../net/image/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/image/etc/s6-rc/nftables/up | 6 - 22 files changed, 652 insertions(+), 60 deletions(-) create mode 100644 tools/xdp-forwarder/meson.build create mode 100644 tools/xdp-forwarder/parsing_helpers.h create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/set_router_iface.c delete mode 100644 vm/sys/net/image/etc/nftables.conf delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/mdevd-coldplug/type delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/up -- 2.51.0

5 14

[PATCH] Use contents.d for bundles
by Demi Marie Obenour 27 Sep '25

27 Sep '25

contents files are deprecated. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/rootfs/Makefile | 12 ++++++++---- host/rootfs/image/etc/s6-rc/ok-all/contents | 6 ------ host/rootfs/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug | 0 host/rootfs/image/etc/s6-rc/ok-all/contents.d/sys-vmms | 0 host/rootfs/image/etc/s6-rc/ok-all/contents.d/vm-env | 0 host/rootfs/image/etc/s6-rc/vm-env/contents | 5 ----- host/rootfs/image/etc/s6-rc/vm-env/contents.d/static-nodes | 0 host/rootfs/image/etc/s6-rc/vm-env/contents.d/weston | 0 host/rootfs/image/etc/s6-rc/vmm-env/contents | 6 ------ host/rootfs/image/etc/s6-rc/vmm-env/contents.d/core | 0 host/rootfs/image/etc/s6-rc/vmm-env/contents.d/kvm | 0 host/rootfs/image/etc/s6-rc/vmm-env/contents.d/static-nodes | 0 img/app/Makefile | 4 +++- img/app/image/etc/s6-rc/ok-all/contents | 6 ------ img/app/image/etc/s6-rc/ok-all/contents.d/app | 0 img/app/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug | 0 img/app/image/etc/s6-rc/ok-all/contents.d/wireplumber | 0 vm/sys/net/Makefile | 3 ++- vm/sys/net/image/etc/s6-rc/ok-all/contents | 5 ----- vm/sys/net/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug | 0 vm/sys/net/image/etc/s6-rc/ok-all/contents.d/sysctl | 0 21 files changed, 13 insertions(+), 34 deletions(-) diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index 1c6220031ed727c3a3686a43ead37aada6e15b4f..7652515ca27c8feb87e77d0fd79750eda9675c97 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -142,22 +142,26 @@ S6_RC_FILES = \ image/etc/s6-rc/mdevd/notification-fd \ image/etc/s6-rc/mdevd/run \ image/etc/s6-rc/mdevd/type \ - image/etc/s6-rc/ok-all/contents \ + image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug \ + image/etc/s6-rc/ok-all/contents.d/sys-vmms \ + image/etc/s6-rc/ok-all/contents.d/vm-env \ image/etc/s6-rc/ok-all/type \ image/etc/s6-rc/static-nodes/type \ image/etc/s6-rc/static-nodes/up \ image/etc/s6-rc/sys-vmms/dependencies.d/vmm-env \ image/etc/s6-rc/sys-vmms/type \ image/etc/s6-rc/sys-vmms/up \ - image/etc/s6-rc/vm-env/contents \ + image/etc/s6-rc/vm-env/contents.d/static-nodes \ + image/etc/s6-rc/vm-env/contents.d/weston \ image/etc/s6-rc/vm-env/type \ - image/etc/s6-rc/vmm-env/contents \ + image/etc/s6-rc/vmm-env/contents.d/core \ + image/etc/s6-rc/vmm-env/contents.d/kvm \ + image/etc/s6-rc/vmm-env/contents.d/static-nodes \ image/etc/s6-rc/vmm-env/type \ image/etc/s6-rc/weston/dependencies.d/card0 \ image/etc/s6-rc/weston/notification-fd \ image/etc/s6-rc/weston/run \ image/etc/s6-rc/weston/type - # s6-rc-compile's input is a directory, but that doesn't play nice # with Make, because it won't know to update if some file in the # directory is changed, or a file is created or removed in a diff --git a/host/rootfs/image/etc/s6-rc/ok-all/contents b/host/rootfs/image/etc/s6-rc/ok-all/contents deleted file mode 100644 index 9f8b0ed66ceedd591ed2f1a7e164d9abcc54cc53..0000000000000000000000000000000000000000 --- a/host/rootfs/image/etc/s6-rc/ok-all/contents +++ /dev/null @@ -1,6 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -mdevd-coldplug -sys-vmms -vm-env diff --git a/host/rootfs/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug b/host/rootfs/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/ok-all/contents.d/sys-vmms b/host/rootfs/image/etc/s6-rc/ok-all/contents.d/sys-vmms new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/ok-all/contents.d/vm-env b/host/rootfs/image/etc/s6-rc/ok-all/contents.d/vm-env new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/vm-env/contents b/host/rootfs/image/etc/s6-rc/vm-env/contents deleted file mode 100644 index 580795b1b02bb7a8dff7f872723c678141d4bb70..0000000000000000000000000000000000000000 --- a/host/rootfs/image/etc/s6-rc/vm-env/contents +++ /dev/null @@ -1,5 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -static-nodes -weston diff --git a/host/rootfs/image/etc/s6-rc/vm-env/contents.d/static-nodes b/host/rootfs/image/etc/s6-rc/vm-env/contents.d/static-nodes new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/vm-env/contents.d/weston b/host/rootfs/image/etc/s6-rc/vm-env/contents.d/weston new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/vmm-env/contents b/host/rootfs/image/etc/s6-rc/vmm-env/contents deleted file mode 100644 index ee1e3cfc39d1a6545bbefc3692782b9de6b3ade3..0000000000000000000000000000000000000000 --- a/host/rootfs/image/etc/s6-rc/vmm-env/contents +++ /dev/null @@ -1,6 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -core -kvm -static-nodes diff --git a/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/core b/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/core new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/kvm b/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/kvm new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/static-nodes b/host/rootfs/image/etc/s6-rc/vmm-env/contents.d/static-nodes new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/img/app/Makefile b/img/app/Makefile index 8b9ecf990fe10adb7aa19b46935826d684f10686..db9b53e434b2d018d76d92f7672bdd0718180fbd 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -100,7 +100,9 @@ VM_S6_RC_FILES = \ image/etc/s6-rc/mdevd/notification-fd \ image/etc/s6-rc/mdevd/run \ image/etc/s6-rc/mdevd/type \ - image/etc/s6-rc/ok-all/contents \ + image/etc/s6-rc/ok-all/contents.d/app \ + image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug \ + image/etc/s6-rc/ok-all/contents.d/wireplumber \ image/etc/s6-rc/ok-all/type \ image/etc/s6-rc/pipewire/notification-fd \ image/etc/s6-rc/pipewire/run \ diff --git a/img/app/image/etc/s6-rc/ok-all/contents b/img/app/image/etc/s6-rc/ok-all/contents deleted file mode 100644 index 6788e54384f065890d00d77378ea5c45ec89f61c..0000000000000000000000000000000000000000 --- a/img/app/image/etc/s6-rc/ok-all/contents +++ /dev/null @@ -1,6 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -mdevd-coldplug -wireplumber -app diff --git a/img/app/image/etc/s6-rc/ok-all/contents.d/app b/img/app/image/etc/s6-rc/ok-all/contents.d/app new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/img/app/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug b/img/app/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/img/app/image/etc/s6-rc/ok-all/contents.d/wireplumber b/img/app/image/etc/s6-rc/ok-all/contents.d/wireplumber new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 0277b16f5acfac6c9eaed5f128333d1545e7c9ab..38a9af765683f287d621d5a2107a78c84b9b166e 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -73,7 +73,8 @@ VM_S6_RC_FILES = \ image/etc/s6-rc/mdevd/type \ image/etc/s6-rc/nftables/type \ image/etc/s6-rc/nftables/up \ - image/etc/s6-rc/ok-all/contents \ + image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug \ + image/etc/s6-rc/ok-all/contents.d/sysctl \ image/etc/s6-rc/ok-all/type \ image/etc/s6-rc/sysctl/type \ image/etc/s6-rc/sysctl/up diff --git a/vm/sys/net/image/etc/s6-rc/ok-all/contents b/vm/sys/net/image/etc/s6-rc/ok-all/contents deleted file mode 100644 index 221d1429a8293738125f150dfaf5370672814b52..0000000000000000000000000000000000000000 --- a/vm/sys/net/image/etc/s6-rc/ok-all/contents +++ /dev/null @@ -1,5 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -mdevd-coldplug -sysctl diff --git a/vm/sys/net/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug b/vm/sys/net/image/etc/s6-rc/ok-all/contents.d/mdevd-coldplug new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/vm/sys/net/image/etc/s6-rc/ok-all/contents.d/sysctl b/vm/sys/net/image/etc/s6-rc/ok-all/contents.d/sysctl new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 --- base-commit: 2a6f0ff71f78a19d3227efc460d519cf9c9dfd39 change-id: 20250926-contents-d-21e21701fd35 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

Non-idempotent RUN+= scripts
by Demi Marie Obenour 25 Sep '25

25 Sep '25

There are cases where a RUN+= script needs to do something exactly once each time a device appears, such as binding a different driver to the device. If the udev rule matches based on a property (such as PCI device information) that is set only by the kernel, is it okay to use ACTION=="add" in the rule? The only other options I know of are to either 1. Add additional code to the script to make sure it is idempotent. This might require adding a lock. 2. Use a persistent daemon. Which of these approaches is best? -- Sincerely, Demi Marie Obenour (she/her/hers)

3 3

[PATCH v4 0/5]
by Yureka Lilian 24 Sep '25

24 Sep '25

The patches up to and including "vm/sys/net: build against pkgsMusl" can be applied right away, while the last commit ("vm/sys/net: integrate xdp-forwarder") does not make sense without the router. Changes since v3: - Apply suggestions from Demi in meson recipe, prog_*.c - Split out the appSupport -> guestSupport rename into a seperate commit - Split out the switch to pkgsMusl into a separate commit with reasoning - rename set_router_iface to set-router-iface Changes since v2: - Switch xdp-forwarder build to meson - Add guest build variant of spectrum-tools Changes since v1: - rebased - apply new uncrustify config - moved xdp-forwarder to tools/ - split integration into separate commit - use linuxHeaders instead of vmlinux.h - use original xdp-tutorial {parsing,rewrite}_helpers.h - inlined the load scripts into /etc/iface/mdev, using /usr/lib/xdp as fixed prefix for finding the XDP progs - removed the README, added a paragraph to architecture doc instead Yureka Lilian (5): tools: rename guestSupport -> appSupport tools: add xdp-forwarder docs/architecture: add paragraph about networking vm/sys/net: build against pkgsMusl vm/sys/net: integrate xdp-forwarder Documentation/about/architecture.adoc | 20 ++ img/app/default.nix | 4 +- pkgs/default.nix | 8 +- release/checks/pkg-tests.nix | 3 +- tools/default.nix | 21 +- tools/meson.build | 6 +- tools/meson_options.txt | 7 +- tools/shell.nix | 2 +- tools/xdp-forwarder/include/parsing_helpers.h | 274 ++++++++++++++++++ tools/xdp-forwarder/include/rewrite_helpers.h | 146 ++++++++++ tools/xdp-forwarder/meson.build | 48 +++ tools/xdp-forwarder/prog_physical.c | 39 +++ tools/xdp-forwarder/prog_router.c | 43 +++ tools/xdp-forwarder/set_router_iface.c | 30 ++ vm/sys/net/Makefile | 19 +- vm/sys/net/default.nix | 23 +- vm/sys/net/image/etc/fstab | 2 + vm/sys/net/image/etc/mdev/iface | 27 +- vm/sys/net/image/etc/nftables.conf | 8 - vm/sys/net/image/etc/s6-rc/connman/type | 1 - .../net/image/etc/s6-rc/connman/type.license | 2 - .../net/image/etc/s6-rc/mdevd-coldplug/type | 1 - .../net/image/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/image/etc/s6-rc/nftables/up | 6 - 24 files changed, 676 insertions(+), 66 deletions(-) create mode 100644 tools/xdp-forwarder/include/parsing_helpers.h create mode 100644 tools/xdp-forwarder/include/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/meson.build create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/set_router_iface.c delete mode 100644 vm/sys/net/image/etc/nftables.conf delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/mdevd-coldplug/type delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/up -- 2.51.0

4 15

[PATCH 0/3] Optimize scripts/make-erofs.sh
by Demi Marie Obenour 23 Sep '25

23 Sep '25

In the future this will hopefully be replaced by mkfs.erofs improvements or a C program that calls the erofs library. However, optimizing the script is much simpler for now. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Demi Marie Obenour (3): scripts/make-erofs.sh: Avoid unneeded calls to awk and chmod scripts/make-erofs.sh: Avoid calls to dirname scripts/make-erofs.sh: Avoid unneeded calls to mkdir scripts/make-erofs.sh | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) --- base-commit: 15ca6c4684313fcc9fcde3bda97d64698bb267ea change-id: 20250919-less-dirname-2218643e73a6 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 16

[PATCH v5 0/4] xdp-forwarder
by Yureka Lilian 23 Sep '25

23 Sep '25

The patches up to and including "vm/sys/net: build against pkgsMusl" can be applied right away, while the last commit ("vm/sys/net: integrate xdp-forwarder") does not make sense without the router. Changes since v4: - Ensure all patches have my Signed-off-by - add native: true to the find_prog(clang) - Remove merge conflicts artifacts in the integration commit Changes since v3: - Apply suggestions from Demi in meson recipe, prog_*.c - Split out the appSupport -> guestSupport rename into a seperate commit - Split out the switch to pkgsMusl into a separate commit with reasoning - rename set_router_iface to set-router-iface Changes since v2: - Switch xdp-forwarder build to meson - Add guest build variant of spectrum-tools Changes since v1: - rebased - apply new uncrustify config - moved xdp-forwarder to tools/ - split integration into separate commit - use linuxHeaders instead of vmlinux.h - use original xdp-tutorial {parsing,rewrite}_helpers.h - inlined the load scripts into /etc/iface/mdev, using /usr/lib/xdp as fixed prefix for finding the XDP progs - removed the README, added a paragraph to architecture doc instead Yureka Lilian (4): tools: add xdp-forwarder docs/architecture: add paragraph about networking vm/sys/net: build against pkgsMusl vm/sys/net: integrate xdp-forwarder Documentation/about/architecture.adoc | 20 ++ pkgs/default.nix | 4 + release/checks/pkg-tests.nix | 1 + tools/default.nix | 14 +- tools/meson.build | 4 + tools/meson_options.txt | 3 + tools/xdp-forwarder/include/parsing_helpers.h | 274 ++++++++++++++++++ tools/xdp-forwarder/include/rewrite_helpers.h | 146 ++++++++++ tools/xdp-forwarder/meson.build | 48 +++ tools/xdp-forwarder/prog_physical.c | 39 +++ tools/xdp-forwarder/prog_router.c | 43 +++ tools/xdp-forwarder/set_router_iface.c | 30 ++ vm/sys/net/Makefile | 8 +- vm/sys/net/default.nix | 23 +- vm/sys/net/image/etc/fstab | 2 + vm/sys/net/image/etc/mdev/iface | 27 +- vm/sys/net/image/etc/nftables.conf | 8 - vm/sys/net/image/etc/s6-rc/connman/type | 1 - .../net/image/etc/s6-rc/connman/type.license | 2 - .../net/image/etc/s6-rc/mdevd-coldplug/type | 1 - .../net/image/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/image/etc/s6-rc/nftables/up | 6 - 22 files changed, 647 insertions(+), 59 deletions(-) create mode 100644 tools/xdp-forwarder/include/parsing_helpers.h create mode 100644 tools/xdp-forwarder/include/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/meson.build create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/set_router_iface.c delete mode 100644 vm/sys/net/image/etc/nftables.conf delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/image/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/mdevd-coldplug/type delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/image/etc/s6-rc/nftables/up -- 2.51.0

2 5

[PATCH] tools/start-vmm: Add additional warning options
by Demi Marie Obenour 23 Sep '25

23 Sep '25

This detected a missing prototype. No functional change. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- tools/meson.build | 2 ++ tools/start-vmm/ch.h | 1 + 2 files changed, 3 insertions(+) diff --git a/tools/meson.build b/tools/meson.build index 9cebd03e323531fca7600cacf120161a98de16c5..8262f3e01d7bd56561306d7dd4650a22ca40ebe7 100644 --- a/tools/meson.build +++ b/tools/meson.build @@ -9,6 +9,8 @@ project('spectrum-tools', 'c', }) add_project_arguments('-Wno-error=attributes', language : 'c') +add_project_arguments('-Werror=missing-prototypes', language : 'c') +add_project_arguments('-Werror=missing-declarations', language : 'c') if get_option('host') add_languages('rust') diff --git a/tools/start-vmm/ch.h b/tools/start-vmm/ch.h index 7230913ef0abf41a4f712ac4a543c7f7fdecec0f..5431365e6e2894cdebae22a9a44e2ccf1222e0d2 100644 --- a/tools/start-vmm/ch.h +++ b/tools/start-vmm/ch.h @@ -8,3 +8,4 @@ struct net_config { char id[18]; uint8_t mac[6]; }; +struct net_config net_setup(const char name[static 1], int name_len); --- base-commit: edd53bb5dd9b682fec744d6df7921b64e0f56565 change-id: 20250918-more-c-warnings-1-239a405997c0 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 9

Re: [PATCH v4 2/5] tools: add xdp-forwarder
by Alyssa Ross 23 Sep '25

23 Sep '25

Yureka <yuka(a)yuka.dev> writes: > On 9/23/25 17:14, Alyssa Ross wrote: >> Yureka Lilian <yureka(a)cyberchaos.dev> writes: >>> @@ -88,12 +94,15 @@ stdenv.mkDerivation (finalAttrs: { >>> mesonFlags = [ >>> (lib.mesonBool "app" appSupport) >>> (lib.mesonBool "host" hostSupport) >>> + (lib.mesonBool "driver" driverSupport) >>> "-Dhostfsrootdir=/run/virtiofs/virtiofs0" >>> "-Dtests=false" >>> "-Dunwind=false" >>> "-Dwerror=true" >>> ]; >>> >>> + hardeningDisable = lib.optionals driverSupport [ "zerocallusedregs" ]; >>> + >> Could we instead do this in bpf_o_cmd, so it's not disabled for >> userspace programs? > This environment variable works on the stdenv level, so it is difficult > to mix it in from the meson recipe. Any way to do this would add NixOS > specifics to the meson recipe and doesn't feel quite right. The environment variable in stdenv just adds -fzero-call-used-regs=used-gpr to the compiler flags, before the ones given on the command line, so I was thinking we could just add -fzero-call-used-regs=skip (the default) to bpf_o_cmd, to explicitly say we don't want it for these compiler invocations. It'll override the option given by the compiler wrapper, and won't do anything Nix-specific — it would be the right thing for other distros that change compiler defaults as well, which I think is not that uncommon. >>> diff --git a/tools/xdp-forwarder/meson.build b/tools/xdp-forwarder/meson.build >>> new file mode 100644 >>> index 0000000..e6d91ca >>> --- /dev/null >>> +++ b/tools/xdp-forwarder/meson.build >>> @@ -0,0 +1,48 @@ >>> +# SPDX-License-Identifier: EUPL-1.2+ >>> +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> >>> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> >>> + >>> +libbpf = dependency('libbpf', version : '1.6.2') >>> + >>> +executable('set-router-iface', 'set_router_iface.c', >>> + dependencies : libbpf, >>> + install : true) >>> + >>> +clang = find_program('clang') >> Should be native: true I think. > I can't find a parameter 'native' for find_program() in the meson docs. > Can you explain why this option is needed? Is it to prevent passing two > --target args when cross-compiling? It's to prevent it trying to execute clang for the system you're building for. You'd use find_program(…, native: false) (the default) if you wanted to embed the path to that program in your binary, for example. Documentation is here: https://mesonbuild.com/Reference-manual_functions.html#find_program_native

2 2

[PATCH 00/20] Many image fixes and systemd integration
by Demi Marie Obenour 21 Sep '25

21 Sep '25

Patches 1 through 19 are all fixes or enhancements to the image build process. There are other changes that need to be done around error handling, but these are all useful regardless. See the individual commit messages for details. Notably, one of these patches standardizes file modes so that they are not dependent on the permissions in the user's git repository (except for whether the executable bit is set, which git stores). This is because that depends on things like the user's umask, and thus should have no effect on the image. Patch 20 switches from s6-linux-init to systemd. This is not intended for merging, at least not yet. However, it *is* meant to show the beginning of how Spectrum could benefit from systemd's features. Notably, this patch reduces the amount of code. This is despite all Spectrum-specific services still being managed by s6 and additional complexity in the Nix files being needed to work around nixpkgs not using standard directories to find things like systemd unit files and PAM modules. It's also worth noting that at least GNOME has a fairly hard dependency on systemd, but I doubt COSMIC will as parts of it are even used on Redox, which definitely does not run systemd! Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Demi Marie Obenour (20): scripts/make-erofs.sh: Ensure that / is world-readable scripts/make-erofs.sh: Do not read one byte at a time scripts/make-erofs.sh: Avoid unneeded calls to awk and chmod scripts/make-erofs.sh: Validate all paths scripts/make-erofs.sh: Avoid unneeded calls to dirname scripts/make-erofs.sh: Avoid unneeded calls to mkdir scripts/make-erofs.sh: Standardize file modes in images Standardize directories and symlinks in images Add os-release file host/rootfs: Set -eu in build Add /dev/fd and /dev/std* host/rootfs: Do not read from /dev/tty1 host/rootfs: pass API socket as fd 3, not fd 0 host/rootfs: Disable unneeded BusyBox tools host/rootfs: Use real less, not BusyBox less host/rootfs: explicitly set PATH in network add script Use /etc/s6-rc/compiled for compiled s6-rc directory host/rootfs: virtiofsd: Do not use FD 0 as the socket host/rootfs: Disable unneeded busybox stuff host/rootfs: Switch to systemd LICENSES/ISC.txt | 11 - host/initramfs/etc/init | 7 +- host/rootfs/Makefile | 186 +++++------ host/rootfs/bin | 1 - host/rootfs/default.nix | 347 +++++++++++++++------ host/rootfs/etc/group | 1 - host/rootfs/etc/init | 10 +- host/rootfs/etc/machine-id | 0 host/rootfs/etc/mdev.conf | 7 - host/rootfs/etc/mdev/listen | 11 - host/rootfs/etc/mdev/net/add | 1 + host/rootfs/etc/mdev/wait | 14 - host/rootfs/etc/os-release | 12 + host/rootfs/etc/os-release.license | 2 + host/rootfs/etc/pam.d/login | 9 + host/rootfs/etc/passwd | 1 - host/rootfs/etc/s6-linux-init/env/WAYLAND_DISPLAY | 1 - .../etc/s6-linux-init/env/WAYLAND_DISPLAY.license | 2 - host/rootfs/etc/s6-linux-init/env/XDG_RUNTIME_DIR | 1 - .../etc/s6-linux-init/env/XDG_RUNTIME_DIR.license | 2 - .../etc/s6-linux-init/run-image/opengl-driver | 1 - .../s6-linux-init/run-image/service/getty-tty1/run | 5 - .../s6-linux-init/run-image/service/getty-tty2/run | 5 - .../s6-linux-init/run-image/service/getty-tty3/run | 5 - .../s6-linux-init/run-image/service/getty-tty4/run | 5 - .../run-image/service/s6-svscan-log/run | 6 - .../run-image/service/serial-getty-generator/run | 43 --- .../run-image/service/serial-getty/template/run | 5 - .../run-image/service/vmm/template/run | 1 - .../notification-fd.license | 2 - .../service/xdg-desktop-portal-spectrum-host/run | 5 - .../template/notification-fd | 1 - host/rootfs/etc/s6-linux-init/scripts/rc.init | 10 - host/rootfs/etc/s6-rc/card0/type | 1 - host/rootfs/etc/s6-rc/card0/type.license | 2 - host/rootfs/etc/s6-rc/card0/up | 4 - host/rootfs/etc/s6-rc/core/type | 1 - host/rootfs/etc/s6-rc/core/type.license | 2 - host/rootfs/etc/s6-rc/kvm/timeout-up | 1 - host/rootfs/etc/s6-rc/kvm/timeout-up.license | 2 - host/rootfs/etc/s6-rc/kvm/type | 1 - host/rootfs/etc/s6-rc/kvm/type.license | 2 - host/rootfs/etc/s6-rc/kvm/up | 4 - host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies | 4 - host/rootfs/etc/s6-rc/mdevd-coldplug/type | 1 - host/rootfs/etc/s6-rc/mdevd-coldplug/type.license | 2 - host/rootfs/etc/s6-rc/mdevd-coldplug/up | 4 - host/rootfs/etc/s6-rc/mdevd/notification-fd | 1 - .../rootfs/etc/s6-rc/mdevd/notification-fd.license | 2 - host/rootfs/etc/s6-rc/mdevd/run | 5 - host/rootfs/etc/s6-rc/mdevd/type | 1 - host/rootfs/etc/s6-rc/mdevd/type.license | 2 - host/rootfs/etc/s6-rc/ok-all/contents | 3 +- host/rootfs/etc/s6-rc/static-nodes/type | 1 - host/rootfs/etc/s6-rc/static-nodes/type.license | 2 - host/rootfs/etc/s6-rc/static-nodes/up | 26 -- host/rootfs/etc/s6-rc/sys-vmms/dependencies | 4 - host/rootfs/etc/s6-rc/vm-env/contents | 5 - host/rootfs/etc/s6-rc/vm-env/type | 1 - host/rootfs/etc/s6-rc/vm-env/type.license | 2 - host/rootfs/etc/s6-rc/vmm-env/contents | 6 - host/rootfs/etc/s6-rc/vmm-env/type | 1 - host/rootfs/etc/s6-rc/vmm-env/type.license | 2 - host/rootfs/etc/s6-rc/weston/dependencies | 4 - host/rootfs/etc/s6-rc/weston/run | 7 +- host/rootfs/etc/security/namespace.conf | 0 .../etc/{s6-rc/core/up => sysctl.d/spectrum.conf} | 3 +- .../systemd-veritysetup-generator | 1 + .../etc/systemd/system.conf.d/zspectrum.conf | 25 ++ host/rootfs/etc/systemd/system/-.slice | 5 + .../default.target.requires/s6-init-start.service | 1 + .../s6-init-start.service | 1 + .../s6-init-start.service | 1 + .../etc/systemd/system/s6-init-start.service | 25 ++ .../system/serial-getty@.service.d/90_force.conf | 6 + .../90_spectrum.conf | 4 + .../system/user@.service.d/99_spectrum-uid.conf | 4 + host/rootfs/etc/tmpfiles.d/99-spectrum.conf | 8 + host/rootfs/etc/udev/rules.d/99-spectrum-kvm.rules | 8 + host/rootfs/lib | 1 - host/rootfs/sbin | 1 - host/rootfs/shell.nix | 3 +- host/rootfs/usr/bin/run-appimage | 2 +- host/rootfs/usr/bin/run-vmm | 5 +- host/rootfs/usr/bin/vm-start | 2 +- host/rootfs/usr/lib/spectrum/s6-start | 5 + .../share/spectrum}/service/dbus/notification-fd | 0 .../spectrum}/service/dbus/notification-fd.license | 0 .../share/spectrum}/service/dbus/run | 0 .../share/spectrum/service/dbus/template/log/run | 4 + .../service/dbus/template/notification-fd | 0 .../service/dbus/template/notification-fd.license | 0 .../share/spectrum}/service/dbus/template/run | 2 +- .../service/s6-svscan-log/notification-fd | 0 .../service/s6-svscan-log/notification-fd.license | 0 .../usr/share/spectrum/service/s6-svscan-log/run | 4 + .../service/vhost-user-fs}/notification-fd | 0 .../service/vhost-user-fs}/notification-fd.license | 0 .../share/spectrum/service/vhost-user-fs}/run | 0 .../service/vhost-user-fs/template/log/run | 4 + .../vhost-user-fs/template}/notification-fd | 0 .../vhost-user-fs/template/notification-fd.license | 0 .../spectrum}/service/vhost-user-fs/template/run | 5 +- .../service/vhost-user-gpu}/notification-fd | 0 .../vhost-user-gpu}/notification-fd.license | 0 .../share/spectrum/service/vhost-user-gpu}/run | 0 .../service/vhost-user-gpu/template/data/check | 0 .../service/vhost-user-gpu/template/log/run | 4 + .../vhost-user-gpu/template}/notification-fd | 0 .../template/notification-fd.license | 0 .../spectrum}/service/vhost-user-gpu/template/run | 0 .../spectrum}/service/vhost-user-gpu/template/type | 0 .../service/vhost-user-gpu/template/type.license | 0 host/rootfs/usr/share/spectrum/service/vmm/log/run | 4 + .../share/spectrum/service/vmm}/notification-fd | 0 .../spectrum/service/vmm}/notification-fd.license | 0 .../share/spectrum/service/vmm}/run | 0 .../share/spectrum/service/vmm/template/log/run | 4 + .../spectrum/service/vmm/template}/notification-fd | 0 .../service/vmm/template}/notification-fd.license | 0 .../usr/share/spectrum/service/vmm/template/run | 1 + .../xdg-desktop-portal-spectrum-host/log/run | 4 + .../notification-fd | 0 .../notification-fd.license | 0 .../service/xdg-desktop-portal-spectrum-host}/run | 0 .../template/log/run | 4 + .../template}/notification-fd | 0 .../template/notification-fd.license | 0 .../xdg-desktop-portal-spectrum-host/template/run | 0 img/app/Makefile | 15 +- img/app/bin | 1 - img/app/default.nix | 101 +++--- img/app/etc/os-release | 12 + img/app/etc/os-release.license | 2 + img/app/etc/s6-linux-init/scripts/rc.init | 2 +- img/app/sbin | 1 - release/checks/integration/networking.c | 2 +- release/checks/integration/portal.c | 2 +- scripts/make-erofs.sh | 152 ++++++++- vm/sys/net/Makefile | 15 +- vm/sys/net/bin | 1 - vm/sys/net/default.nix | 2 + vm/sys/net/etc/os-release | 12 + vm/sys/net/etc/os-release.license | 2 + vm/sys/net/etc/s6-linux-init/scripts/rc.init | 7 +- vm/sys/net/lib | 1 - vm/sys/net/sbin | 1 - vm/sys/net/var/run | 1 - 148 files changed, 754 insertions(+), 555 deletions(-) --- base-commit: 0ac65013a1a29e91ea8476f39113e3598eb0e535 change-id: 20250815-systemd-2cdd0b578a86 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 65

[PATCH] Do not ignore errors from tar
by Demi Marie Obenour 21 Sep '25

21 Sep '25

These would be ignored due to a missing -o pipefail in the shell script. As a result, listing nonexistent s6-rc-compile inputs would cause a broken image to be successfully built. Also remove newlines that broke Vim syntax highlighting. Reported-by: Alyssa Ross <hi(a)alyssa.is> Link: https://spectrum-os.org/lists/archives/spectrum-devel/87segu879h.fsf@alyssa… Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/rootfs/Makefile | 5 ++--- img/app/Makefile | 5 ++--- vm/sys/net/Makefile | 5 ++--- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index b11ba50f369c3440572e06a7eaca429fbe6746a1..322d75026dbcba4301f26abfbf74efa8cc68cdfd 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -168,9 +168,8 @@ S6_RC_FILES = \ build/etc/s6-rc: $(S6_RC_FILES) mkdir -p $$(dirname $@) rm -rf $@ - - dir=$$(mktemp -d) && \ - tar -c $(S6_RC_FILES) | tar -C $$dir -x --strip-components 3 && \ + set -uo pipefail && dir=$$(mktemp -d) && \ + { tar -c $(S6_RC_FILES) | tar -C $$dir -x --strip-components 3; } && \ s6-rc-compile $@ $$dir; \ exit=$$?; rm -r $$dir; exit $$exit diff --git a/img/app/Makefile b/img/app/Makefile index c83b37364c16576e2609f5005b8a6092b644867b..8b9ecf990fe10adb7aa19b46935826d684f10686 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -116,9 +116,8 @@ VM_S6_RC_FILES = \ build/etc/s6-rc: $(VM_S6_RC_FILES) mkdir -p $$(dirname $@) rm -rf $@ - - dir=$$(mktemp -d) && \ - tar -c $(VM_S6_RC_FILES) | tar -C $$dir -x --strip-components 3 && \ + set -uo pipefail && dir=$$(mktemp -d) && \ + { tar -c $(VM_S6_RC_FILES) | tar -C $$dir -x --strip-components 3; } && \ s6-rc-compile $@ $$dir; \ exit=$$?; rm -r $$dir; exit $$exit diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 79be242ea26e37d6f02af8761320de27d69d5b69..0193cc8c09f895a6021de0d02fde20362818e185 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -81,9 +81,8 @@ VM_S6_RC_FILES = \ build/etc/s6-rc: $(VM_S6_RC_FILES) mkdir -p $$(dirname $@) rm -rf $@ - - dir=$$(mktemp -d) && \ - tar -c $(VM_S6_RC_FILES) | tar -C $$dir -x --strip-components 3 && \ + set -uo pipefail && dir=$$(mktemp -d) && \ + { tar -c $(VM_S6_RC_FILES) | tar -C $$dir -x --strip-components 3; } && \ s6-rc-compile $@ $$dir; \ exit=$$?; rm -r $$dir; exit $$exit --- base-commit: 15ca6c4684313fcc9fcde3bda97d64698bb267ea change-id: 20250919-no-ignore-tar-errors-cea4c781cbbf -- Sincerely, Demi Marie Obenour (she/her/hers)

3 2

Sandboxing strategy
by Demi Marie Obenour 19 Sep '25

19 Sep '25

I was thinking about how to sandbox the various per-VM daemons and came up with the following strategy: - Each VM gets its own PID and mount namespace and set of user IDs. - Mount namespace includes /proc, /sys, /dev, and the host rootfs. - Each service gets its own /tmp and /dev/shm if they are needed at all. - virtiofsd gets r/w access to the VM private storage. - IPC namespaces are irrelevant because the kernel is built without System V IPC or POSIX message queues. - Sending signals between services in the namespace is blocked by Landlock. Landlock also blocks ptrace() and other nastiness, as well as communication via abstract AF_UNIX sockets. - Since AF_UNIX abstract sockets between services are blocked by Landlock and Spectrum builds without IP or even Ethernet on the host there is no need for network namespacing. - The sandbox manager is PID 1 in the VM's PID namespace. When s6 tells it to shut down, it tries to gracefully shut down the VM. After a timeout or once the VM has shut down, it exits, and Linux automatically kills all the processes and cleans up the mount namespace. - The sandbox manager uses prctl(PR_SET_PDEATHSIG) to ensure it dies if the parent s6 process dies. This requires s6 to provide its own PID to avoid races, but that is easy to implement. All of this behavior will be hard-coded into C and Rust source code, so it will be vastly simpler than a generic program that must support many use-cases. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 7

[PATCH] tools/start-vmm: Don't disable improper_ctypes
by Demi Marie Obenour 19 Sep '25

19 Sep '25

The code didn't use improper ctypes. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- tools/start-vmm/net.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/tools/start-vmm/net.rs b/tools/start-vmm/net.rs index c6f5ff1baf2ecedc099ac529e6dbf2711aaae385..1e4665ceb02c9a8899231a100e631f6ce425994d 100644 --- a/tools/start-vmm/net.rs +++ b/tools/start-vmm/net.rs @@ -42,7 +42,6 @@ extern "C" { /// The rest of the result is only valid if the returned fd is not -1. // SAFETY: &Path is sized, so it's okay to pass a reference to it // to C, as long as it's opaque to C. - #[allow(improper_ctypes)] pub fn net_setup(name: *const c_char, len: c_int) -> NetConfigC; } --- base-commit: edd53bb5dd9b682fec744d6df7921b64e0f56565 change-id: 20250918-no-improper-ctypes-72bdc9037e4e -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH 0/3] Minor improvements to the Spectrum OS boot process
by Demi Marie Obenour 19 Sep '25

19 Sep '25

These are all very minor changes. Patch 1 switches from Busybox switch_root to the util-linux version. Since util-linux moves /dev, /sys, and /proc to the root filesystem, three calls to mount go away. Patch 2 adds /dev/fd, /dev/stdin, /dev/stdout, and /dev/stderr symlinks, to avoid compatibility problems with Spectrum OS's third-party dependencies. Patch 3 avoids mounting /proc and /sys in the main system, as the initramfs already did this. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Demi Marie Obenour (3): host/initramfs: Use util-linux switch_root Add /dev/fd and /dev/std* host/rootfs: Avoid redundant mounts of /proc and /sys host/initramfs/default.nix | 3 ++- host/initramfs/etc/init | 4 ---- host/rootfs/etc/fstab | 2 -- host/rootfs/etc/init | 8 ++++++++ vm/sys/net/etc/init | 8 ++++++++ 5 files changed, 18 insertions(+), 7 deletions(-) --- base-commit: f14abeb3db2c1c47658fa1809f3fde379e41d632 change-id: 20250914-util-linux-switch-root-10034b149e45 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 13

Partition sizing
by Demi Marie Obenour 18 Sep '25

18 Sep '25

What size should the A and B partitions be? I can’t think of any reasonable way to size them that is also future-proof. Android had the same problem, and they solved it by using device mapper. Unfortunately, I doubt LVM meets our security goals, which means a whole new userspace implementation would be required. That would not be fun, especially since a bug would require a reinstall to correct. Other image-based Linux distros generally don't have this problem because they use filesystem or ostree snapshots, rather than separate partitions. Chromium OS has a whole team of paid developers, so I think they can deal with constraints a bit better than we can :). One horrifying worst-case option is to add a file on the user data partition, create a loop device based on it, and then add it to the dm-verity table. I really don't want to do that if there is any other option, though. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 2

[PATCH] Use dependencies.d to declare s6-rc dependencies
by Demi Marie Obenour 17 Sep '25

17 Sep '25

Using a dependencies file is deprecated. No functional change intended. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Except for whitespace and comments, the files removed in this change can only be written in one way. Therefore, they have no creative expression in them, meaning they are not eligible for copyright protection. I thus didn't bother to port over the copyright notices. --- host/rootfs/Makefile | 6 +++--- host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies | 4 ---- host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd | 0 host/rootfs/etc/s6-rc/sys-vmms/dependencies | 4 ---- host/rootfs/etc/s6-rc/sys-vmms/dependencies.d/vmm-env | 0 host/rootfs/etc/s6-rc/weston/dependencies | 4 ---- host/rootfs/etc/s6-rc/weston/dependencies.d/card0 | 0 img/app/Makefile | 2 +- img/app/etc/s6-rc/mdevd-coldplug/dependencies | 4 ---- img/app/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd | 0 vm/sys/net/Makefile | 4 ++-- vm/sys/net/etc/s6-rc/connman/dependencies | 4 ---- vm/sys/net/etc/s6-rc/connman/dependencies.d/dbus | 0 vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies | 4 ---- vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd | 0 15 files changed, 6 insertions(+), 30 deletions(-) diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index e96458dba06ae31129b115b2b649962f8d88187a..367e824622053fa216cf81658d5c84eeb3db6470 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -136,7 +136,7 @@ S6_RC_FILES = \ etc/s6-rc/kvm/timeout-up \ etc/s6-rc/kvm/type \ etc/s6-rc/kvm/up \ - etc/s6-rc/mdevd-coldplug/dependencies \ + etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd \ etc/s6-rc/mdevd-coldplug/type \ etc/s6-rc/mdevd-coldplug/up \ etc/s6-rc/mdevd/notification-fd \ @@ -146,14 +146,14 @@ S6_RC_FILES = \ etc/s6-rc/ok-all/type \ etc/s6-rc/static-nodes/type \ etc/s6-rc/static-nodes/up \ - etc/s6-rc/sys-vmms/dependencies \ + etc/s6-rc/sys-vmms/dependencies.d/vmm-env \ etc/s6-rc/sys-vmms/type \ etc/s6-rc/sys-vmms/up \ etc/s6-rc/vm-env/contents \ etc/s6-rc/vm-env/type \ etc/s6-rc/vmm-env/contents \ etc/s6-rc/vmm-env/type \ - etc/s6-rc/weston/dependencies \ + etc/s6-rc/weston/dependencies.d/card0 \ etc/s6-rc/weston/notification-fd \ etc/s6-rc/weston/run \ etc/s6-rc/weston/type diff --git a/host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies b/host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies deleted file mode 100644 index 59b02b7356ea0d88ac446cea74791a9cd3303de4..0000000000000000000000000000000000000000 --- a/host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> -# -mdevd diff --git a/host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd b/host/rootfs/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/etc/s6-rc/sys-vmms/dependencies b/host/rootfs/etc/s6-rc/sys-vmms/dependencies deleted file mode 100644 index cdc42d5beaa12ff5dfbccf07dacf33a0e5bef9ce..0000000000000000000000000000000000000000 --- a/host/rootfs/etc/s6-rc/sys-vmms/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2024 Alyssa Ross <hi(a)alyssa.is> -# -vmm-env diff --git a/host/rootfs/etc/s6-rc/sys-vmms/dependencies.d/vmm-env b/host/rootfs/etc/s6-rc/sys-vmms/dependencies.d/vmm-env new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/host/rootfs/etc/s6-rc/weston/dependencies b/host/rootfs/etc/s6-rc/weston/dependencies deleted file mode 100644 index 8470c0fabc5c85b2529ee26ad82d3910e95f23cb..0000000000000000000000000000000000000000 --- a/host/rootfs/etc/s6-rc/weston/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> -# -card0 diff --git a/host/rootfs/etc/s6-rc/weston/dependencies.d/card0 b/host/rootfs/etc/s6-rc/weston/dependencies.d/card0 new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/img/app/Makefile b/img/app/Makefile index 9665a6b7158f2d8b183831202a4559ae06d53d16..595540c35982b9bbb9b681042338849a9d6318f6 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -94,7 +94,7 @@ VM_S6_RC_FILES = \ etc/s6-rc/dbus/notification-fd \ etc/s6-rc/dbus/run \ etc/s6-rc/dbus/type \ - etc/s6-rc/mdevd-coldplug/dependencies \ + etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd \ etc/s6-rc/mdevd-coldplug/type \ etc/s6-rc/mdevd-coldplug/up \ etc/s6-rc/mdevd/notification-fd \ diff --git a/img/app/etc/s6-rc/mdevd-coldplug/dependencies b/img/app/etc/s6-rc/mdevd-coldplug/dependencies deleted file mode 100644 index 59b02b7356ea0d88ac446cea74791a9cd3303de4..0000000000000000000000000000000000000000 --- a/img/app/etc/s6-rc/mdevd-coldplug/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> -# -mdevd diff --git a/img/app/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd b/img/app/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 755b145175199aa97049dbd7feadc0e76230cf30..8ff0db74e9426e75d7ef76a9f0b0b8bfe491bd9b 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -59,13 +59,13 @@ build/rootfs.erofs: ../../../scripts/make-erofs.sh $(PACKAGES_FILE) $(VM_FILES) ) | ../../../scripts/make-erofs.sh $@ VM_S6_RC_FILES = \ - etc/s6-rc/connman/dependencies \ + etc/s6-rc/connman/dependencies.d/dbus \ etc/s6-rc/connman/run \ etc/s6-rc/connman/type \ etc/s6-rc/dbus/notification-fd \ etc/s6-rc/dbus/run \ etc/s6-rc/dbus/type \ - etc/s6-rc/mdevd-coldplug/dependencies \ + etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd \ etc/s6-rc/mdevd-coldplug/type \ etc/s6-rc/mdevd-coldplug/up \ etc/s6-rc/mdevd/notification-fd \ diff --git a/vm/sys/net/etc/s6-rc/connman/dependencies b/vm/sys/net/etc/s6-rc/connman/dependencies deleted file mode 100644 index 23bda199ae908f6738f11546e088dfaa6748da6a..0000000000000000000000000000000000000000 --- a/vm/sys/net/etc/s6-rc/connman/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> -# -dbus diff --git a/vm/sys/net/etc/s6-rc/connman/dependencies.d/dbus b/vm/sys/net/etc/s6-rc/connman/dependencies.d/dbus new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies b/vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies deleted file mode 100644 index 59b02b7356ea0d88ac446cea74791a9cd3303de4..0000000000000000000000000000000000000000 --- a/vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies +++ /dev/null @@ -1,4 +0,0 @@ -# SPDX-License-Identifier: CC0-1.0 -# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> -# -mdevd diff --git a/vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd b/vm/sys/net/etc/s6-rc/mdevd-coldplug/dependencies.d/mdevd new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 --- base-commit: 636a47c9243a8cf0387b6e2e4fbb7d8972e501f4 change-id: 20250913-no-deprecated-s6-rc-aa91c5891277 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH] host/rootfs: Remove type file from template
by Demi Marie Obenour 13 Sep '25

13 Sep '25

The type file is only looked at by s6-rc-compile, so it is ignored for templates. No functional change. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- .../etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type | 1 - .../run-image/service/vhost-user-gpu/template/type.license | 2 -- 2 files changed, 3 deletions(-) diff --git a/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type b/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type deleted file mode 100644 index 5883cff0cd1514b2836f4ffa39fdac769a5213cb..0000000000000000000000000000000000000000 --- a/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type +++ /dev/null @@ -1 +0,0 @@ -longrun diff --git a/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type.license b/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type.license deleted file mode 100644 index 2241beb42f7ff1f0ce993d8c8a0f0c6b6d32115b..0000000000000000000000000000000000000000 --- a/host/rootfs/etc/s6-linux-init/run-image/service/vhost-user-gpu/template/type.license +++ /dev/null @@ -1,2 +0,0 @@ -SPDX-License-Identifier: CC0-1.0 -SPDX-FileCopyrightText: 2022 Unikie --- base-commit: 636a47c9243a8cf0387b6e2e4fbb7d8972e501f4 change-id: 20250913-missing-file-9c93a3da82b0 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH] Prefer definition-before-use in Nix
by Demi Marie Obenour 09 Sep '25

09 Sep '25

Nix does not require this, but it is easier to read. No functional change intended. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- img/app/default.nix | 74 ++++++++++++++++++++++++-------------------------- vm/sys/net/default.nix | 72 ++++++++++++++++++++++++------------------------ 2 files changed, 72 insertions(+), 74 deletions(-) diff --git a/img/app/default.nix b/img/app/default.nix index d3eed1f0accdc8968d1ba5bdec74ab597789082f..71a939c1c053ebd37fc02fa4eed49b883d50ef49 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -12,6 +12,42 @@ pkgsStatic.callPackage ( }: let + kernelTarget = + if stdenvNoCC.hostPlatform.isx86 then + # vmlinux.bin is the stripped version of vmlinux. + # Confusingly, compressed/vmlinux.bin is the stripped version of + # the top-level vmlinux target, while the top-level vmlinux.bin + # is the stripped version of compressed/vmlinux. So we use + # compressed/vmlinux.bin, since we want a stripped version of + # the kernel that *hasn't* been built to be compressed. Weird! + "compressed/vmlinux.bin" + else + stdenvNoCC.hostPlatform.linux-kernel.target; + + kernel = (linux_latest.override { + structuredExtraConfig = with lib.kernel; { + DRM_FBDEV_EMULATION = lib.mkForce no; + EROFS_FS = yes; + FONTS = lib.mkForce unset; + FONT_8x8 = lib.mkForce unset; + FONT_TER16x32 = lib.mkForce unset; + FRAMEBUFFER_CONSOLE = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_DEFERRED_TAKEOVER = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_DETECT_PRIMARY = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_ROTATION = lib.mkForce unset; + RC_CORE = lib.mkForce unset; + VIRTIO = yes; + VIRTIO_BLK = yes; + VIRTIO_CONSOLE = yes; + VIRTIO_PCI = yes; + VT = no; + }; + }).overrideAttrs ({ installFlags ? [], ... }: { + installFlags = installFlags ++ [ + "KBUILD_IMAGE=$(boot)/${kernelTarget}" + ]; + }); + appimageFhsenv = (buildFHSEnv (appimageTools.defaultFhsEnvArgs // { name = "vm-fhs-env"; targetPkgs = pkgs: appimageTools.defaultFhsEnvArgs.targetPkgs pkgs ++ [ @@ -53,50 +89,12 @@ let pkgs.wireplumber ]; })).fhsenv; -in -let packagesSysroot = runCommand "packages-sysroot" {} '' mkdir -p $out/etc/ssl/certs ln -s ${appimageFhsenv}/{lib64,usr} ${kernel}/lib $out ln -s ${cacert}/etc/ssl/certs/* $out/etc/ssl/certs ''; - - kernelTarget = - if stdenvNoCC.hostPlatform.isx86 then - # vmlinux.bin is the stripped version of vmlinux. - # Confusingly, compressed/vmlinux.bin is the stripped version of - # the top-level vmlinux target, while the top-level vmlinux.bin - # is the stripped version of compressed/vmlinux. So we use - # compressed/vmlinux.bin, since we want a stripped version of - # the kernel that *hasn't* been built to be compressed. Weird! - "compressed/vmlinux.bin" - else - stdenvNoCC.hostPlatform.linux-kernel.target; - - kernel = (linux_latest.override { - structuredExtraConfig = with lib.kernel; { - DRM_FBDEV_EMULATION = lib.mkForce no; - EROFS_FS = yes; - FONTS = lib.mkForce unset; - FONT_8x8 = lib.mkForce unset; - FONT_TER16x32 = lib.mkForce unset; - FRAMEBUFFER_CONSOLE = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_DEFERRED_TAKEOVER = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_DETECT_PRIMARY = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_ROTATION = lib.mkForce unset; - RC_CORE = lib.mkForce unset; - VIRTIO = yes; - VIRTIO_BLK = yes; - VIRTIO_CONSOLE = yes; - VIRTIO_PCI = yes; - VT = no; - }; - }).overrideAttrs ({ installFlags ? [], ... }: { - installFlags = installFlags ++ [ - "KBUILD_IMAGE=$(boot)/${kernelTarget}" - ]; - }); in stdenvNoCC.mkDerivation { diff --git a/vm/sys/net/default.nix b/vm/sys/net/default.nix index b5873ebe1e80dd88c1ba997f7ebd3ee7369bb40f..7b2b8b1fbb9b9027781812307bed0551b80f5a78 100644 --- a/vm/sys/net/default.nix +++ b/vm/sys/net/default.nix @@ -14,6 +14,42 @@ let inherit (lib) concatMapStringsSep; inherit (nixosAllHardware.config.hardware) firmware; + kernelTarget = + if stdenvNoCC.hostPlatform.isx86 then + # vmlinux.bin is the stripped version of vmlinux. + # Confusingly, compressed/vmlinux.bin is the stripped version of + # the top-level vmlinux target, while the top-level vmlinux.bin + # is the stripped version of compressed/vmlinux. So we use + # compressed/vmlinux.bin, since we want a stripped version of + # the kernel that *hasn't* been built to be compressed. Weird! + "compressed/vmlinux.bin" + else + stdenvNoCC.hostPlatform.linux-kernel.target; + + kernel = (linux_latest.override { + structuredExtraConfig = with lib.kernel; { + DRM_FBDEV_EMULATION = lib.mkForce no; + EROFS_FS = yes; + FONTS = lib.mkForce unset; + FONT_8x8 = lib.mkForce unset; + FONT_TER16x32 = lib.mkForce unset; + FRAMEBUFFER_CONSOLE = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_DEFERRED_TAKEOVER = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_DETECT_PRIMARY = lib.mkForce unset; + FRAMEBUFFER_CONSOLE_ROTATION = lib.mkForce unset; + RC_CORE = lib.mkForce unset; + VIRTIO = yes; + VIRTIO_BLK = yes; + VIRTIO_CONSOLE = yes; + VIRTIO_PCI = yes; + VT = no; + }; + }).overrideAttrs ({ installFlags ? [], ... }: { + installFlags = installFlags ++ [ + "KBUILD_IMAGE=$(boot)/${kernelTarget}" + ]; + }); + connman = connmanMinimal; packages = [ @@ -58,42 +94,6 @@ let system.stateVersion = lib.trivial.release; }); - - kernelTarget = - if stdenvNoCC.hostPlatform.isx86 then - # vmlinux.bin is the stripped version of vmlinux. - # Confusingly, compressed/vmlinux.bin is the stripped version of - # the top-level vmlinux target, while the top-level vmlinux.bin - # is the stripped version of compressed/vmlinux. So we use - # compressed/vmlinux.bin, since we want a stripped version of - # the kernel that *hasn't* been built to be compressed. Weird! - "compressed/vmlinux.bin" - else - stdenvNoCC.hostPlatform.linux-kernel.target; - - kernel = (linux_latest.override { - structuredExtraConfig = with lib.kernel; { - DRM_FBDEV_EMULATION = lib.mkForce no; - EROFS_FS = yes; - FONTS = lib.mkForce unset; - FONT_8x8 = lib.mkForce unset; - FONT_TER16x32 = lib.mkForce unset; - FRAMEBUFFER_CONSOLE = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_DEFERRED_TAKEOVER = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_DETECT_PRIMARY = lib.mkForce unset; - FRAMEBUFFER_CONSOLE_ROTATION = lib.mkForce unset; - RC_CORE = lib.mkForce unset; - VIRTIO = yes; - VIRTIO_BLK = yes; - VIRTIO_CONSOLE = yes; - VIRTIO_PCI = yes; - VT = no; - }; - }).overrideAttrs ({ installFlags ? [], ... }: { - installFlags = installFlags ++ [ - "KBUILD_IMAGE=$(boot)/${kernelTarget}" - ]; - }); in stdenvNoCC.mkDerivation { --- base-commit: 8ce6039b6dde7fda98ceea018addecb8bee0e7b3 change-id: 20250908-nix-cleanup-8496862dfee9 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH] Sort file lists in makefiles
by Demi Marie Obenour 09 Sep '25

09 Sep '25

No functional change. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/rootfs/Makefile | 8 ++++---- vm/sys/net/Makefile | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index f677fe580f2e2be58113457e63468d97f49a49f6..e96458dba06ae31129b115b2b649962f8d88187a 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -54,7 +54,6 @@ FILES = \ etc/s6-linux-init/scripts/rc.init \ etc/xdg/weston/autolaunch \ etc/xdg/weston/weston.ini \ - usr/share/dbus-1/services/org.freedesktop.portal.Documents.service \ usr/bin/assign-devices \ usr/bin/create-vm-dependencies \ usr/bin/run-appimage \ @@ -63,7 +62,8 @@ FILES = \ usr/bin/vm-import \ usr/bin/vm-start \ usr/bin/vm-stop \ - usr/bin/xdg-open + usr/bin/xdg-open \ + usr/share/dbus-1/services/org.freedesktop.portal.Documents.service DIRS = \ dev \ @@ -155,8 +155,8 @@ S6_RC_FILES = \ etc/s6-rc/vmm-env/type \ etc/s6-rc/weston/dependencies \ etc/s6-rc/weston/notification-fd \ - etc/s6-rc/weston/type \ - etc/s6-rc/weston/run + etc/s6-rc/weston/run \ + etc/s6-rc/weston/type # s6-rc-compile's input is a directory, but that doesn't play nice # with Make, because it won't know to update if some file in the diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index e6819400b2079e3eaa9d24737b2fc4b816a592c8..755b145175199aa97049dbd7feadc0e76230cf30 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -39,7 +39,7 @@ VM_FILES = \ etc/s6-linux-init/run-image/service/getty-hvc0/run \ etc/s6-linux-init/scripts/rc.init \ etc/sysctl.conf -VM_DIRS = dev etc/s6-linux-init/env run proc sys var/lib/connman +VM_DIRS = dev etc/s6-linux-init/env proc run sys var/lib/connman # These are separate because they need to be included, but putting # them as make dependencies would confuse make. --- base-commit: 8ce6039b6dde7fda98ceea018addecb8bee0e7b3 change-id: 20250908-sorting-c24fb3b2bf2a -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH] scripts/make-erofs.sh: Ensure that / is world-readable
by Demi Marie Obenour 09 Sep '25

09 Sep '25

Previously it had 0700 permissions, which was hidden because everything ran as root anyway. However, dbus-broker fails to start in this case because it always drops privileges. Also set umask to 0022 to ensure that the permissions of other directories are correct. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- scripts/make-erofs.sh | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/scripts/make-erofs.sh b/scripts/make-erofs.sh index b47048ad747bd7dfcc28e0f1dfd75ec090fa7e09..5b620be77f2967e45fa1c2b06c6acfc3329e46c0 100755 --- a/scripts/make-erofs.sh +++ b/scripts/make-erofs.sh @@ -1,6 +1,7 @@ #!/bin/sh -eu # # SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> # SPDX-License-Identifier: EUPL-1.2+ # # FIXME: It would be nice to replace this script with a program that @@ -8,6 +9,7 @@ # single directory structure, and could generate an EROFS image # based on source:dest mappings directly. +umask 0022 # for permissions ex_usage() { echo "Usage: make-erofs.sh [options]... img < srcdest.txt" >&2 exit 1 @@ -18,8 +20,12 @@ if [ -z "${img-}" ]; then ex_usage fi -root="$(mktemp -d -- "$img.tmp.XXXXXXXXXX")" -trap 'chmod -R +w -- "$root" && rm -rf -- "$root"' EXIT +superroot="$(mktemp -d -- "$img.tmp.XXXXXXXXXX")" +trap 'chmod -R +w -- "$root" && rm -rf -- "$superroot"' EXIT +# $superroot has 0700 permissions, so create a subdirectory +# with correct (0755) permissions and do all work there. +root=$superroot/real_root +mkdir -- "$root" while read -r arg1; do read -r arg2 || ex_usage --- base-commit: 8ce6039b6dde7fda98ceea018addecb8bee0e7b3 change-id: 20250908-world-readable-root-87176a94d3cc -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[DO_NOT_APPLY v3 0/3] xdp-forwarder
by Yureka Lilian 08 Sep '25

08 Sep '25

Same as v1, it doesn't make sense to apply this without the router. Changes since v2: - Switch xdp-forwarder build to meson - Add guest build variant of spectrum-tools Changes since v1: - rebased - apply new uncrustify config - moved xdp-forwarder to tools/ - split integration into separate commit - use linuxHeaders instead of vmlinux.h - use original xdp-tutorial {parsing,rewrite}_helpers.h - inlined the load scripts into /etc/iface/mdev, using /usr/lib/xdp as fixed prefix for finding the XDP progs - removed the README, added a paragraph to architecture doc instead Yureka Lilian (3): add xdp-forwarder integrate xdp-forwarder into net-vm docs/architecture: add paragraph about networking Documentation/about/architecture.adoc | 20 ++ pkgs/default.nix | 5 + tools/default.nix | 15 +- tools/meson.build | 5 + tools/meson_options.txt | 4 + tools/xdp-forwarder/include/parsing_helpers.h | 273 ++++++++++++++++++ tools/xdp-forwarder/include/rewrite_helpers.h | 145 ++++++++++ tools/xdp-forwarder/prog_physical.c | 37 +++ tools/xdp-forwarder/prog_router.c | 43 +++ tools/xdp-forwarder/set_router_iface.c | 32 ++ vm/sys/net/Makefile | 8 +- vm/sys/net/default.nix | 22 +- vm/sys/net/etc/fstab | 2 + vm/sys/net/etc/mdev/iface | 27 +- vm/sys/net/etc/nftables.conf | 8 - vm/sys/net/etc/s6-rc/connman/dependencies | 4 - vm/sys/net/etc/s6-rc/connman/type | 1 - vm/sys/net/etc/s6-rc/connman/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/type | 1 - vm/sys/net/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/up | 6 - 21 files changed, 599 insertions(+), 63 deletions(-) create mode 100644 tools/xdp-forwarder/include/parsing_helpers.h create mode 100644 tools/xdp-forwarder/include/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/set_router_iface.c delete mode 100644 vm/sys/net/etc/nftables.conf delete mode 100644 vm/sys/net/etc/s6-rc/connman/dependencies delete mode 100644 vm/sys/net/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/up -- 2.50.1

4 8

[PATCH] tools: add xdp-forwarder
by Yureka Lilian 08 Sep '25

08 Sep '25

The xdp-forwarder's purpose is implementing the functionality needed within the net-vm (a VM running the Linux drivers for any physical interfaces on the spectrum system). In the future, the net-vm will load the included XDP programs on the passed-through physical interfaces as well as the downstream virtio interface going into the router (recognized by its special MAC address). The net-vm needs to multiplex between the physical interfaces, as there might be several interfaces in the same IOMMU-group. For this, the XDP program loaded on the physical interfaces (`prog_physical.o`) applies a VLAN tag corresponding to the interface id and redirects the packets to the router interface (identified by the `router_iface` bpf map). In the other direction the XDP program loaded on the router interface (`prog_router.o`) removes one layer of VLAN tagging and redirects the packets to the interface read from the VLAN tag. The helper program `set_router_iface` is used to update the `router_iface` bpf map to point to the interface passed as argument to the program. Signed-off-by: Yureka Lilian <yureka(a)cyberchaos.dev> --- pkgs/default.nix | 5 + tools/default.nix | 15 +- tools/meson.build | 5 + tools/meson_options.txt | 4 + tools/xdp-forwarder/include/parsing_helpers.h | 273 ++++++++++++++++++ tools/xdp-forwarder/include/rewrite_helpers.h | 145 ++++++++++ tools/xdp-forwarder/meson.build | 38 +++ tools/xdp-forwarder/prog_physical.c | 37 +++ tools/xdp-forwarder/prog_router.c | 43 +++ tools/xdp-forwarder/set_router_iface.c | 29 ++ 10 files changed, 591 insertions(+), 3 deletions(-) create mode 100644 tools/xdp-forwarder/include/parsing_helpers.h create mode 100644 tools/xdp-forwarder/include/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/meson.build create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/set_router_iface.c diff --git a/pkgs/default.nix b/pkgs/default.nix index 3b81339..76b2a5c 100644 --- a/pkgs/default.nix +++ b/pkgs/default.nix @@ -1,4 +1,5 @@ # SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> # SPDX-License-Identifier: MIT { ... } @ args: @@ -42,6 +43,10 @@ let guestSupport = false; hostSupport = true; }; + spectrum-driver-tools = self.callSpectrumPackage ../tools { + guestSupport = false; + driverSupport = true; + }; xdg-desktop-portal-spectrum-host = self.callSpectrumPackage ../tools/xdg-desktop-portal-spectrum-host {}; diff --git a/tools/default.nix b/tools/default.nix index 95d76a1..e664f47 100644 --- a/tools/default.nix +++ b/tools/default.nix @@ -1,13 +1,16 @@ # SPDX-License-Identifier: MIT # SPDX-FileCopyrightText: 2022-2025 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> import ../lib/call-package.nix ( { src, lib, stdenv, fetchCrate, fetchurl, runCommand, buildPackages , meson, ninja, pkg-config, rustc , clang-tools, clippy , dbus +, clang, libbpf , guestSupport ? true , hostSupport ? false +, driverSupport ? false }: let @@ -70,15 +73,18 @@ stdenv.mkDerivation (finalAttrs: { ./lsvm ./start-vmm ./subprojects + ] ++ lib.optionals driverSupport [ + ./xdp-forwarder ])); }; sourceRoot = "source/tools"; depsBuildBuild = lib.optionals hostSupport [ buildPackages.stdenv.cc ]; nativeBuildInputs = [ meson ninja ] - ++ lib.optionals guestSupport [ pkg-config ] - ++ lib.optionals hostSupport [ rustc ]; - buildInputs = lib.optionals guestSupport [ dbus ]; + ++ lib.optionals (guestSupport || driverSupport) [ pkg-config ] + ++ lib.optionals hostSupport [ rustc ] + ++ lib.optionals driverSupport [ clang ]; + buildInputs = lib.optionals guestSupport [ dbus ] ++ lib.optionals driverSupport [ libbpf ]; postPatch = lib.optionals hostSupport (lib.concatMapStringsSep "\n" (crate: '' mkdir -p subprojects/packagecache @@ -88,12 +94,15 @@ stdenv.mkDerivation (finalAttrs: { mesonFlags = [ (lib.mesonBool "guest" guestSupport) (lib.mesonBool "host" hostSupport) + (lib.mesonBool "driver" driverSupport) "-Dhostfsrootdir=/run/virtiofs/virtiofs0" "-Dtests=false" "-Dunwind=false" "-Dwerror=true" ]; + hardeningDisable = lib.optionals driverSupport [ "zerocallusedregs" ]; + passthru.tests = { clang-tidy = finalAttrs.finalPackage.overrideAttrs ( { name, src, nativeBuildInputs ? [], ... }: diff --git a/tools/meson.build b/tools/meson.build index 9cebd03..e49f27c 100644 --- a/tools/meson.build +++ b/tools/meson.build @@ -1,5 +1,6 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> project('spectrum-tools', 'c', default_options : { @@ -26,3 +27,7 @@ endif if get_option('guest') subdir('xdg-desktop-portal-spectrum') endif + +if get_option('driver') + subdir('xdp-forwarder') +endif diff --git a/tools/meson_options.txt b/tools/meson_options.txt index 4af0031..887e388 100644 --- a/tools/meson_options.txt +++ b/tools/meson_options.txt @@ -1,5 +1,6 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2022-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> option('host', type : 'boolean', value : false, description : 'Build tools for the Spectrum host') @@ -7,6 +8,9 @@ option('host', type : 'boolean', value : false, option('guest', type : 'boolean', description : 'Build tools for Spectrum guests') +option('driver', type : 'boolean', + description : 'Build tools for Spectrum driver VMs') + option('hostfsrootdir', type : 'string', value : '/run/host', description : 'Path where the virtio-fs provided by the host will be mounted') diff --git a/tools/xdp-forwarder/include/parsing_helpers.h b/tools/xdp-forwarder/include/parsing_helpers.h new file mode 100644 index 0000000..3d240cd --- /dev/null +++ b/tools/xdp-forwarder/include/parsing_helpers.h @@ -0,0 +1,273 @@ +/* SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-clause) */ +/* Vendored from https://github.com/xdp-project/xdp-tutorial/blob/d3d3eed6ea9a63d1302bfa8b5a… */ +/* + * This file contains parsing functions that are used in the packetXX XDP + * programs. The functions are marked as __always_inline, and fully defined in + * this header file to be included in the BPF program. + * + * Each helper parses a packet header, including doing bounds checking, and + * returns the type of its contents if successful, and -1 otherwise. + * + * For Ethernet and IP headers, the content type is the type of the payload + * (h_proto for Ethernet, nexthdr for IPv6), for ICMP it is the ICMP type field. + * All return values are in host byte order. + * + * The versions of the functions included here are slightly expanded versions of + * the functions in the packet01 lesson. For instance, the Ethernet header + * parsing has support for parsing VLAN tags. + */ + +#ifndef __PARSING_HELPERS_H +#define __PARSING_HELPERS_H + +#include <stddef.h> +#include <linux/if_ether.h> +#include <linux/if_packet.h> +#include <linux/ip.h> +#include <linux/ipv6.h> +#include <linux/icmp.h> +#include <linux/icmpv6.h> +#include <linux/udp.h> +#include <linux/tcp.h> + +/* Header cursor to keep track of current parsing position */ +struct hdr_cursor { + void *pos; +}; + +/* + * struct vlan_hdr - vlan header + * @h_vlan_TCI: priority and VLAN ID + * @h_vlan_encapsulated_proto: packet type ID or len + */ +struct vlan_hdr { + __be16 h_vlan_TCI; + __be16 h_vlan_encapsulated_proto; +}; + +/* + * Struct icmphdr_common represents the common part of the icmphdr and icmp6hdr + * structures. + */ +struct icmphdr_common { + __u8 type; + __u8 code; + __sum16 cksum; +}; + +/* Allow users of header file to redefine VLAN max depth */ +#ifndef VLAN_MAX_DEPTH +#define VLAN_MAX_DEPTH 2 +#endif + +#define VLAN_VID_MASK 0x0fff /* VLAN Identifier */ +/* Struct for collecting VLANs after parsing via parse_ethhdr_vlan */ +struct collect_vlans { + __u16 id[VLAN_MAX_DEPTH]; +}; + +static __always_inline int proto_is_vlan(__u16 h_proto) +{ + return !!(h_proto == bpf_htons(ETH_P_8021Q) || + h_proto == bpf_htons(ETH_P_8021AD)); +} + +/* Notice, parse_ethhdr() will skip VLAN tags, by advancing nh->pos and returns + * next header EtherType, BUT the ethhdr pointer supplied still points to the + * Ethernet header. Thus, caller can look at eth->h_proto to see if this was a + * VLAN tagged packet. + */ +static __always_inline int parse_ethhdr_vlan(struct hdr_cursor *nh, + void *data_end, + struct ethhdr **ethhdr, + struct collect_vlans *vlans) +{ + struct ethhdr *eth = nh->pos; + int hdrsize = sizeof(*eth); + struct vlan_hdr *vlh; + __u16 h_proto; + int i; + + /* Byte-count bounds check; check if current pointer + size of header + * is after data_end. + */ + if (nh->pos + hdrsize > data_end) + return -1; + + nh->pos += hdrsize; + *ethhdr = eth; + vlh = nh->pos; + h_proto = eth->h_proto; + + /* Use loop unrolling to avoid the verifier restriction on loops; + * support up to VLAN_MAX_DEPTH layers of VLAN encapsulation. + */ + #pragma unroll + for (i = 0; i < VLAN_MAX_DEPTH; i++) { + if (!proto_is_vlan(h_proto)) + break; + + if (vlh + 1 > data_end) + break; + + h_proto = vlh->h_vlan_encapsulated_proto; + if (vlans) /* collect VLAN ids */ + vlans->id[i] = + (bpf_ntohs(vlh->h_vlan_TCI) & VLAN_VID_MASK); + + vlh++; + } + + nh->pos = vlh; + return h_proto; /* network-byte-order */ +} + +static __always_inline int parse_ethhdr(struct hdr_cursor *nh, + void *data_end, + struct ethhdr **ethhdr) +{ + /* Expect compiler removes the code that collects VLAN ids */ + return parse_ethhdr_vlan(nh, data_end, ethhdr, NULL); +} + +static __always_inline int parse_ip6hdr(struct hdr_cursor *nh, + void *data_end, + struct ipv6hdr **ip6hdr) +{ + struct ipv6hdr *ip6h = nh->pos; + + /* Pointer-arithmetic bounds check; pointer +1 points to after end of + * thing being pointed to. We will be using this style in the remainder + * of the tutorial. + */ + if (ip6h + 1 > data_end) + return -1; + + nh->pos = ip6h + 1; + *ip6hdr = ip6h; + + return ip6h->nexthdr; +} + +static __always_inline int parse_iphdr(struct hdr_cursor *nh, + void *data_end, + struct iphdr **iphdr) +{ + struct iphdr *iph = nh->pos; + int hdrsize; + + if (iph + 1 > data_end) + return -1; + + hdrsize = iph->ihl * 4; + /* Sanity check packet field is valid */ + if(hdrsize < sizeof(*iph)) + return -1; + + /* Variable-length IPv4 header, need to use byte-based arithmetic */ + if (nh->pos + hdrsize > data_end) + return -1; + + nh->pos += hdrsize; + *iphdr = iph; + + return iph->protocol; +} + +static __always_inline int parse_icmp6hdr(struct hdr_cursor *nh, + void *data_end, + struct icmp6hdr **icmp6hdr) +{ + struct icmp6hdr *icmp6h = nh->pos; + + if (icmp6h + 1 > data_end) + return -1; + + nh->pos = icmp6h + 1; + *icmp6hdr = icmp6h; + + return icmp6h->icmp6_type; +} + +static __always_inline int parse_icmphdr(struct hdr_cursor *nh, + void *data_end, + struct icmphdr **icmphdr) +{ + struct icmphdr *icmph = nh->pos; + + if (icmph + 1 > data_end) + return -1; + + nh->pos = icmph + 1; + *icmphdr = icmph; + + return icmph->type; +} + +static __always_inline int parse_icmphdr_common(struct hdr_cursor *nh, + void *data_end, + struct icmphdr_common **icmphdr) +{ + struct icmphdr_common *h = nh->pos; + + if (h + 1 > data_end) + return -1; + + nh->pos = h + 1; + *icmphdr = h; + + return h->type; +} + +/* + * parse_udphdr: parse the udp header and return the length of the udp payload + */ +static __always_inline int parse_udphdr(struct hdr_cursor *nh, + void *data_end, + struct udphdr **udphdr) +{ + int len; + struct udphdr *h = nh->pos; + + if (h + 1 > data_end) + return -1; + + nh->pos = h + 1; + *udphdr = h; + + len = bpf_ntohs(h->len) - sizeof(struct udphdr); + if (len < 0) + return -1; + + return len; +} + +/* + * parse_tcphdr: parse and return the length of the tcp header + */ +static __always_inline int parse_tcphdr(struct hdr_cursor *nh, + void *data_end, + struct tcphdr **tcphdr) +{ + int len; + struct tcphdr *h = nh->pos; + + if (h + 1 > data_end) + return -1; + + len = h->doff * 4; + /* Sanity check packet field is valid */ + if(len < sizeof(*h)) + return -1; + + /* Variable-length TCP header, need to use byte-based arithmetic */ + if (nh->pos + len > data_end) + return -1; + + nh->pos += len; + *tcphdr = h; + + return len; +} + +#endif /* __PARSING_HELPERS_H */ diff --git a/tools/xdp-forwarder/include/rewrite_helpers.h b/tools/xdp-forwarder/include/rewrite_helpers.h new file mode 100644 index 0000000..2deae9a --- /dev/null +++ b/tools/xdp-forwarder/include/rewrite_helpers.h @@ -0,0 +1,145 @@ +/* SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-clause) */ +/* Vendored from https://github.com/xdp-project/xdp-tutorial/blob/d3d3eed6ea9a63d1302bfa8b5a… */ +/* + * This file contains functions that are used in the packetXX XDP programs to + * manipulate on packets data. The functions are marked as __always_inline, and + * fully defined in this header file to be included in the BPF program. + */ + +#ifndef __REWRITE_HELPERS_H +#define __REWRITE_HELPERS_H + +#include <linux/bpf.h> +#include <linux/ip.h> +#include <linux/ipv6.h> +#include <linux/if_ether.h> + +#include <bpf/bpf_helpers.h> +#include <bpf/bpf_endian.h> + +/* Pops the outermost VLAN tag off the packet. Returns the popped VLAN ID on + * success or negative errno on failure. + */ +static __always_inline int vlan_tag_pop(struct xdp_md *ctx, struct ethhdr *eth) +{ + void *data_end = (void *)(long)ctx->data_end; + struct ethhdr eth_cpy; + struct vlan_hdr *vlh; + __be16 h_proto; + int vlid; + + if (!proto_is_vlan(eth->h_proto)) + return -1; + + /* Careful with the parenthesis here */ + vlh = (void *)(eth + 1); + + /* Still need to do bounds checking */ + if (vlh + 1 > data_end) + return -1; + + /* Save vlan ID for returning, h_proto for updating Ethernet header */ + vlid = bpf_ntohs(vlh->h_vlan_TCI); + h_proto = vlh->h_vlan_encapsulated_proto; + + /* Make a copy of the outer Ethernet header before we cut it off */ + __builtin_memcpy(&eth_cpy, eth, sizeof(eth_cpy)); + + /* Actually adjust the head pointer */ + if (bpf_xdp_adjust_head(ctx, (int)sizeof(*vlh))) + return -1; + + /* Need to re-evaluate data *and* data_end and do new bounds checking + * after adjusting head + */ + eth = (void *)(long)ctx->data; + data_end = (void *)(long)ctx->data_end; + if (eth + 1 > data_end) + return -1; + + /* Copy back the old Ethernet header and update the proto type */ + __builtin_memcpy(eth, &eth_cpy, sizeof(*eth)); + eth->h_proto = h_proto; + + return vlid; +} + +/* Pushes a new VLAN tag after the Ethernet header. Returns 0 on success, + * -1 on failure. + */ +static __always_inline int vlan_tag_push(struct xdp_md *ctx, + struct ethhdr *eth, int vlid) +{ + void *data_end = (void *)(long)ctx->data_end; + struct ethhdr eth_cpy; + struct vlan_hdr *vlh; + + /* First copy the original Ethernet header */ + __builtin_memcpy(&eth_cpy, eth, sizeof(eth_cpy)); + + /* Then add space in front of the packet */ + if (bpf_xdp_adjust_head(ctx, 0 - (int)sizeof(*vlh))) + return -1; + + /* Need to re-evaluate data_end and data after head adjustment, and + * bounds check, even though we know there is enough space (as we + * increased it). + */ + data_end = (void *)(long)ctx->data_end; + eth = (void *)(long)ctx->data; + + if (eth + 1 > data_end) + return -1; + + /* Copy back Ethernet header in the right place, populate VLAN tag with + * ID and proto, and set outer Ethernet header to VLAN type. + */ + __builtin_memcpy(eth, &eth_cpy, sizeof(*eth)); + + vlh = (void *)(eth + 1); + + if (vlh + 1 > data_end) + return -1; + + vlh->h_vlan_TCI = bpf_htons(vlid); + vlh->h_vlan_encapsulated_proto = eth->h_proto; + + eth->h_proto = bpf_htons(ETH_P_8021Q); + return 0; +} + +/* + * Swaps destination and source MAC addresses inside an Ethernet header + */ +static __always_inline void swap_src_dst_mac(struct ethhdr *eth) +{ + __u8 h_tmp[ETH_ALEN]; + + __builtin_memcpy(h_tmp, eth->h_source, ETH_ALEN); + __builtin_memcpy(eth->h_source, eth->h_dest, ETH_ALEN); + __builtin_memcpy(eth->h_dest, h_tmp, ETH_ALEN); +} + +/* + * Swaps destination and source IPv6 addresses inside an IPv6 header + */ +static __always_inline void swap_src_dst_ipv6(struct ipv6hdr *ipv6) +{ + struct in6_addr tmp = ipv6->saddr; + + ipv6->saddr = ipv6->daddr; + ipv6->daddr = tmp; +} + +/* + * Swaps destination and source IPv4 addresses inside an IPv4 header + */ +static __always_inline void swap_src_dst_ipv4(struct iphdr *iphdr) +{ + __be32 tmp = iphdr->saddr; + + iphdr->saddr = iphdr->daddr; + iphdr->daddr = tmp; +} + +#endif /* __REWRITE_HELPERS_H */ diff --git a/tools/xdp-forwarder/meson.build b/tools/xdp-forwarder/meson.build new file mode 100644 index 0000000..7e60c11 --- /dev/null +++ b/tools/xdp-forwarder/meson.build @@ -0,0 +1,38 @@ +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> + +libbpf = dependency('libbpf', version : '1.6.2') + +executable('set_router_iface', 'set_router_iface.c', + dependencies : libbpf, + install : true) + +clang = find_program('clang') + +bpf_o_cmd = [ + clang.full_path(), + '-fno-stack-protector', + '-O2', + '-target', 'bpf', + '-I', meson.current_source_dir() + '/include', + '-g', + '-c', + '@INPUT@', + '-o', + '@OUTPUT@', +] + +prog_router_o = custom_target( + input : 'prog_router.c', + output : 'prog_router.o', + command : bpf_o_cmd, + install: true, + install_dir: 'lib/xdp') + +prog_physical_o = custom_target( + input : 'prog_physical.c', + output : 'prog_physical.o', + command : bpf_o_cmd, + install: true, + install_dir: 'lib/xdp') + diff --git a/tools/xdp-forwarder/prog_physical.c b/tools/xdp-forwarder/prog_physical.c new file mode 100644 index 0000000..04b5131 --- /dev/null +++ b/tools/xdp-forwarder/prog_physical.c @@ -0,0 +1,37 @@ +// SPDX-License-Identifier: EUPL-1.2+ +// SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> + +#define VLAN_MAX_DEPTH 1 + +#include <linux/bpf.h> +#include <bpf/bpf_endian.h> +#include "parsing_helpers.h" +#include "rewrite_helpers.h" + +struct { + __uint(type, BPF_MAP_TYPE_DEVMAP); + __type(key, int); + __type(value, int); + __uint(max_entries, 1); + __uint(pinning, LIBBPF_PIN_BY_NAME); +} router_iface SEC(".maps"); + +SEC("xdp") +int physical(struct xdp_md *ctx) +{ + void *data_end = (void *)(long)ctx->data_end; + void *data = (void *)(long)ctx->data; + + struct hdr_cursor nh; + nh.pos = data; + + struct ethhdr *eth; + if (parse_ethhdr(&nh, data_end, &eth) < 0) + return XDP_DROP; + + if (ctx->ingress_ifindex < 1 || ctx->ingress_ifindex > 4096) + return XDP_DROP; + + vlan_tag_push(ctx, eth, ctx->ingress_ifindex); + return bpf_redirect_map(&router_iface, 0, 0); +} diff --git a/tools/xdp-forwarder/prog_router.c b/tools/xdp-forwarder/prog_router.c new file mode 100644 index 0000000..fe6a6b5 --- /dev/null +++ b/tools/xdp-forwarder/prog_router.c @@ -0,0 +1,43 @@ +// SPDX-License-Identifier: EUPL-1.2+ +// SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> + +#define VLAN_MAX_DEPTH 1 + +#include <linux/bpf.h> +#include <bpf/bpf_endian.h> +#include "parsing_helpers.h" +#include "rewrite_helpers.h" + +// The map is actually not used by this program, but just included +// to keep the reference-counted pin alive before any physical interfaces +// are added. +struct { + __uint(type, BPF_MAP_TYPE_DEVMAP); + __type(key, int); + __type(value, int); + __uint(max_entries, 1); + __uint(pinning, LIBBPF_PIN_BY_NAME); +} router_iface SEC(".maps"); + + +SEC("xdp") +int router(struct xdp_md *ctx) +{ + void *data_end = (void *)(long)ctx->data_end; + void *data = (void *)(long)ctx->data; + + struct hdr_cursor nh; + nh.pos = data; + + struct ethhdr *eth; + int r; + if (r = parse_ethhdr(&nh, data_end, &eth) < 0) + return XDP_DROP; + + int vlid = vlan_tag_pop(ctx, eth); + if (vlid < 0) { + return XDP_DROP; + } + + return bpf_redirect(vlid, 0); +} diff --git a/tools/xdp-forwarder/set_router_iface.c b/tools/xdp-forwarder/set_router_iface.c new file mode 100644 index 0000000..32835f9 --- /dev/null +++ b/tools/xdp-forwarder/set_router_iface.c @@ -0,0 +1,29 @@ +// SPDX-License-Identifier: EUPL-1.2+ +// SPDX-FileCopyrightText: 2025 Yureka Lilian <yureka(a)cyberchaos.dev> + +#include <stdio.h> +#include <net/if.h> +#include <bpf/bpf.h> +#include <err.h> + +int main(int argc, char **argv) +{ + if (argc < 2) { + err(EXIT_FAILURE, "missing interface name"); + } + + int router_idx = if_nametoindex(argv[1]); + if (router_idx <= 0) { + err(EXIT_FAILURE, "error getting router interface"); + } + + int map_fd = bpf_obj_get("/sys/fs/bpf/router_iface"); + if (map_fd < 0) { + err(EXIT_FAILURE, "failed to open bpf map"); + } + + int id = 0; + if (bpf_map_update_elem(map_fd, &id, &router_idx, 0) < 0) { + err(EXIT_FAILURE, "failed to update bpf map"); + } +} -- 2.50.1

4 4

Re: [DO_NOT_APPLY v3 1/3] add xdp-forwarder
by Alyssa Ross 06 Sep '25

06 Sep '25

Yureka <yuka(a)yuka.dev> writes: >>> @@ -7,6 +8,9 @@ option('host', type : 'boolean', value : false, >>> option('guest', type : 'boolean', >>> description : 'Build tools for Spectrum guests') >>> >>> +option('driver', type : 'boolean', >>> + description : 'Build tools for Spectrum driver VMs') >>> + >> Should be grouped with host and guest (no blank line between). > > There is a blank line in between host and guest, so I don't know what > you mean exactly. I think I was confused by the diff output, sorry. Let's default it to false though — the most likely way for this to be reused would be for people running custom application VMs, so that's what should be built by default. Should also rename "guest" to "app", I think — I can do that myself before applying, if you prefer.

1 0

Arranging groups of services
by Demi Marie Obenour 05 Sep '25

05 Sep '25

I'm working on Spectrum OS (https://spectrum-os.org/) and am currently porting it from s6 (https://skarnet.org/software/s6-linux-init/) to systemd. Spectrum OS's host (which is what is being ported) is rather different from a normal system: - The root filesystem is completely read-only. There's no writable /var. I decided to put a tmpfs there for now. - There is no network access, so /etc/resolv.conf isn't needed. - The real work happens in VMs, each of which depends on a few services: - Cloud Hypervisor (https://www.cloudhypervisor.org) which runs the VM. - crosvm (https://crosvm.dev/book/) used for graphics. - virtiofsd (https://virtio-fs.gitlab.io) to provide a filesystem - Spectrum OS's own proxy for the XDG desktop portals - In the future, an instance of vhost-device-sound (https://github.com/rust-vmm/vhost-device/blob/main/vhost-device-sound/READM…) used for sound - A per-VM D-Bus daemon - An instance of xdg-desktop-portal If the Cloud Hypervisor instance is stopped or exits, the others should be stopped automatically, as they have no other use. Having BindsTo=, After=, PropagatesStopTo=, and PropagatesReloadTo= should handle most cases, but I don't know if that is sufficient if Cloud Hypervisor exits spontaneously (because the guest shut down) or crashes. Additionally, these services have different sandboxing needs. Cloud Hypervisor should only be able to connect to its own instance of the daemons that serve it, rather than to any instance. crosvm needs GPU and Wayland access and vhost-device-sound needs to connect to PipeWire. virtiofsd needs an id-mapped mount. I would also like to block abstract AF_UNIX socket access. Are there existing systemd features that can easily meet these needs? For the sockets I am thinking of placing them in RuntimeDirectory= and only giving the correct units access to those directories. Also, I would like to use `DynamicUser=` for everything where that is possible. -- Sincerely, Demi Marie Obenour (she/her/hers)

3 2

Starting programs before udev is running
by Demi Marie Obenour 02 Sep '25

02 Sep '25

Is it dangerous to start programs before udev is running, so long as all of the other dependencies of these programs (such as /var and /home being read-write) have been satisfied? Or do programs assume that udev has actually started, not merely bound to its sockets connections? The reason I ask is that I'm using systemd-udevd with a non-systemd service manager (s6 + s6-rc) and it has an incompatible method for readiness notification (writing a newline to a file descriptor). s6-rc has full support for dependencies, so I can easily have udev write to a FIFO when it picks up /dev/zero and have other things depend on that, but I'm curious if there are any other problems with this approach. In case it matters, the only programs running on the machine will be some VMs, a few programs to support them, a Wayland compositor (now Weston, eventually COSMIC), some XDG portals, and possibly a couple of others. No code not included in the (signed and dm-verity protected) root filesystem will be allowed to execute. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

Generating file lists from a script
by Demi Marie Obenour 01 Sep '25

01 Sep '25

Maintaining the lists of files and directories in the makefiles is error-prone. Would it make sense to use a script to generate them from the git repository? The script would get it right every time, whereas I tend to get it wrong more times than not. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 2

[DO_NOT_APPLY v2 0/3] xdp-forwarder
by Yureka Lilian 01 Sep '25

01 Sep '25

Same as v1, it doesn't make sense to apply this without the router. Changes since v1: - rebased - apply new uncrustify config - moved xdp-forwarder to tools/ - split integration into separate commit - use linuxHeaders instead of vmlinux.h - use original xdp-tutorial {parsing,rewrite}_helpers.h - inlined the load scripts into /etc/iface/mdev, using /usr/lib/xdp as fixed prefix for finding the XDP progs - removed the README, added a paragraph to architecture doc instead Yureka Lilian (3): add xdp-forwarder integrate xdp-forwarder into net-vm docs/architecture: add paragraph about networking Documentation/about/architecture.adoc | 20 ++ pkgs/default.nix | 1 + tools/xdp-forwarder/Makefile | 28 ++ tools/xdp-forwarder/default.nix | 24 ++ tools/xdp-forwarder/include/parsing_helpers.h | 273 ++++++++++++++++++ tools/xdp-forwarder/include/rewrite_helpers.h | 145 ++++++++++ tools/xdp-forwarder/prog_physical.c | 37 +++ tools/xdp-forwarder/prog_router.c | 43 +++ tools/xdp-forwarder/set_router_iface.c | 32 ++ vm/sys/net/Makefile | 8 +- vm/sys/net/default.nix | 19 +- vm/sys/net/etc/fstab | 2 + vm/sys/net/etc/mdev/iface | 27 +- vm/sys/net/etc/nftables.conf | 8 - vm/sys/net/etc/s6-rc/connman/dependencies | 4 - vm/sys/net/etc/s6-rc/connman/type | 1 - vm/sys/net/etc/s6-rc/connman/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/type | 1 - vm/sys/net/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/up | 6 - 20 files changed, 623 insertions(+), 60 deletions(-) create mode 100644 tools/xdp-forwarder/Makefile create mode 100644 tools/xdp-forwarder/default.nix create mode 100644 tools/xdp-forwarder/include/parsing_helpers.h create mode 100644 tools/xdp-forwarder/include/rewrite_helpers.h create mode 100644 tools/xdp-forwarder/prog_physical.c create mode 100644 tools/xdp-forwarder/prog_router.c create mode 100644 tools/xdp-forwarder/set_router_iface.c delete mode 100644 vm/sys/net/etc/nftables.conf delete mode 100644 vm/sys/net/etc/s6-rc/connman/dependencies delete mode 100644 vm/sys/net/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/up -- 2.50.1

3 6

[DO_NOT_APPLY 0/2] xdp-forwarder
by Yureka Lilian 01 Sep '25

01 Sep '25

Hi all, Since this worsens the networking situation unless combined with the userspace Router (which is to-be-done), I am formally sending this out for comments without expecting it to be applied for now. The net-vm's purpose is running the Linux drivers for any physical interfaces on the spectrum system. A net-vm (there could be multiple, one per IOMMU-group) will load the included XDP programs on the passed-through physical interfaces as well as the downstream virtio interface going into the router (recognized by its special MAC address) using mdev events. The net-vm needs to multiplex between the physical interfaces, as there might be several interfaces in the same IOMMU-group. For this, the XDP program loaded on the physical interfaces applies a VLAN tag corresponding to the interface id, and redirects the packets to the router interface (identified by the router_iface bpf map). In the other direction the XDP program loaded on the router interface removes one layer of VLAN tagging, and redirects the packets to the interface read from the VLAN tag. I have verified that when running a wpa_supplicant / iwd in the interface, a WiFi interface can correctly function as a physical interface with the XDP forwarder, assuming that the router sends packets with the correct source MAC address. Yureka Lilian (2): integrate xdp-forwarder into net-vm temporary changes for testing lib/nixpkgs.default.nix | 4 +- vm/sys/net/Makefile | 8 +- vm/sys/net/default.nix | 38 +++++-- vm/sys/net/etc/fstab | 1 + vm/sys/net/etc/mdev/iface | 23 +--- vm/sys/net/etc/nftables.conf | 8 -- vm/sys/net/etc/s6-rc/connman/dependencies | 4 - vm/sys/net/etc/s6-rc/connman/type | 1 - vm/sys/net/etc/s6-rc/connman/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/type | 1 - vm/sys/net/etc/s6-rc/nftables/type.license | 2 - vm/sys/net/etc/s6-rc/nftables/up | 6 - vm/sys/net/xdp-forwarder/README.md | 9 ++ vm/sys/net/xdp-forwarder/default.nix | 35 ++++++ .../xdp-forwarder/include/parsing_helpers.h | 38 +++++++ .../xdp-forwarder/include/rewrite_helpers.h | 103 ++++++++++++++++++ vm/sys/net/xdp-forwarder/load_physical | 4 + vm/sys/net/xdp-forwarder/load_router | 6 + vm/sys/net/xdp-forwarder/prog_physical.c | 28 +++++ vm/sys/net/xdp-forwarder/prog_router.c | 34 ++++++ vm/sys/net/xdp-forwarder/set_router_iface.c | 31 ++++++ 21 files changed, 325 insertions(+), 61 deletions(-) delete mode 100644 vm/sys/net/etc/nftables.conf delete mode 100644 vm/sys/net/etc/s6-rc/connman/dependencies delete mode 100644 vm/sys/net/etc/s6-rc/connman/type delete mode 100644 vm/sys/net/etc/s6-rc/connman/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type delete mode 100644 vm/sys/net/etc/s6-rc/nftables/type.license delete mode 100644 vm/sys/net/etc/s6-rc/nftables/up create mode 100644 vm/sys/net/xdp-forwarder/README.md create mode 100644 vm/sys/net/xdp-forwarder/default.nix create mode 100644 vm/sys/net/xdp-forwarder/include/parsing_helpers.h create mode 100644 vm/sys/net/xdp-forwarder/include/rewrite_helpers.h create mode 100755 vm/sys/net/xdp-forwarder/load_physical create mode 100755 vm/sys/net/xdp-forwarder/load_router create mode 100644 vm/sys/net/xdp-forwarder/prog_physical.c create mode 100644 vm/sys/net/xdp-forwarder/prog_router.c create mode 100644 vm/sys/net/xdp-forwarder/set_router_iface.c -- 2.50.1

3 9

[PATCH] host/rootfs: add /dev/fd and /dev/std*
by Demi Marie Obenour 31 Aug '25

31 Aug '25

This is the same as 14483e1a690c (img/app: add /dev/fd and /dev/std*), but for the host. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/rootfs/etc/s6-linux-init/scripts/rc.init | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/host/rootfs/etc/s6-linux-init/scripts/rc.init b/host/rootfs/etc/s6-linux-init/scripts/rc.init index 674fd38cc76837c7be25a5ef060f0f4d4b786394..ec654dd0ff329e01a25c03bdd80ee839e679e4d0 100755 --- a/host/rootfs/etc/s6-linux-init/scripts/rc.init +++ b/host/rootfs/etc/s6-linux-init/scripts/rc.init @@ -2,6 +2,11 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2020-2022, 2024 Alyssa Ross <hi(a)alyssa.is> +if { ln -s /proc/self/fd /dev } +if { ln -s /proc/self/fd/0 /dev/stdin } +if { ln -s /proc/self/fd/1 /dev/stdout } +if { ln -s /proc/self/fd/2 /dev/stderr } + if { s6-rc-init -c /etc/s6-rc /run/service } if { mount --make-shared /run } --- base-commit: 39baa378367d95fac6ce4d0140b25203b2ee9b53 change-id: 20250805-host-dev-fd-51d57d8341bb -- Sincerely, Demi Marie Obenour (she/her/hers)

2 3

'make clean' followed by 'make' in the same Nix shell doesn't work
by Demi Marie Obenour 31 Aug '25

31 Aug '25

The following command fails to rebuild the image: $ nix-shell --run 'make clean && make run-qemu' The following command succeeds: $ nix-shell --pure --run 'make clean' && nix-shell --pure --run 'make run-qemu' Interactive Nix shells exhibit the same problems, and adding --pure to the first invocation does not help. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 5

Speeding up image builds?
by Demi Marie Obenour 31 Aug '25

31 Aug '25

I often find myself waiting for image builds to run. What are some steps I can take to make them faster? Generally, I find that image builds are I/O bound (CPU usage remains quite low), so one option would be to use a machine with better I/O. What is the best option for this? Is this something where thin provisioning (instead of thick provisioning) causes a large performance penalty? Or is the only solution to throw hardware at the problem? If the latter, what would better hardware be? -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

Moderate Cybersecurity Concern
by ball drinker 29 Aug '25

29 Aug '25

Salutations -- I write not as another spammer talking of riches and fame but as a concerned cybersecurity student aspiring to be a graduate. YOUR OPENSSH PRIVATE KEY WAS COMPROMISED IN A GOOGLE DORK IN CASE YOU WERE NOT AWARE! I figure that now that the important part was stated, I should share some proof of it. Attached will be a series of two (2) images. These were stumbled across while I was completing an assignment for my college course. I only wanted to share the information with you considering I figured it'd be pertinent for something like this.

2 1

Spectrum OS management daemon?
by Demi Marie Obenour 22 Aug '25

22 Aug '25

I'm wondering if Spectrum OS should have a management daemon that is responsible for a few tasks: - Starting VMs when requested by the UI. - Notifying the user of various situations that require their attention, such if a VM crashes. - Suspending VMs before the host suspends, and resuming them after the host resumes. I believe Qubes OS didn't do this initially, but that led to problems so they do do this now. - Acting on devices being plugged and unplugged from system VM. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 3

Switching to udev?
by Demi Marie Obenour 20 Aug '25

20 Aug '25

I'm seriously wondering if Spectrum should switch from mdevd to udev. It's where all of the upstream device detection work happens, and it would avoid needing to statically configure sound devices for PipeWire. The current PipeWire patch statically creates devices. This works for VMs because VMs are statically configured and only have virtio devices. This was also the most challenging part of the effort, and I still had to guess some of the parameters. Supporting hotplug would require either a custom PipeWire module, a custom daemon that talked to PipeWire, keeping pw-cli running in interactive mode, or patches to PipeWire to make device lingering work. In the audio case, ALSA expects device paths of the form hw:card:device:subdevice. However, I don't believe card numbers are stable: they reflect the order in which the kernel enumerates devices, and that is not at all guaranteed. A VM that only has a virtio sound device will only ever have card 0, device 0, and subdevice 0, so hard-coding hw:0,0,0 is fine. This is not true if physical hardware is present. That requires a lot of device identification logic, and all of the upstream work on that is in udev or the systemd hardware database (which udev also uses). In the future, there may be other projects Spectrum wants to use that rely on udev for enumerating devices. Some of them might *only* support PipeWire and have no other means of configuration. Even if other means of configuration *exist*, I expect them to be very rarely used by upstream and thus poorly tested. tl;dr: you can get away without udev in VMs, but I expect problems with physical hardware, and I want to switch to udev as a preemptive measure to avoid those problems and to ease development. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 6

Re: Arranging groups of services
by James Smith 20 Aug '25

20 Aug '25

Forwarding for <Nathaniel Reindal nrr(a)corvidae.org> on this : Both systemd and s6, so I might be uniquely qualified here. (Though, I must admit that I haven't been deep in systemd's internals lately.) Any chance I can take a peek at some s6 service directories to get a better idea of how things work currently? A quick perusal of the spectrum git tree wasn't terribly enlightening. On Sat, Aug 16, 2025, 6:11 PM Demi Marie Obenour <demiobenour(a)gmail.com> wrote: I'm working on Spectrum OS (https://spectrum-os.org/) and am currently porting it from s6 (https://skarnet.org/software/s6-linux-init/) to systemd. Spectrum OS's host (which is what is being ported) is rather different from a normal system: - The root filesystem is completely read-only. There's no writable /var. I decided to put a tmpfs there for now. - There is no network access, so /etc/resolv.conf isn't needed. - The real work happens in VMs, each of which depends on a few services: - Cloud Hypervisor (https://www.cloudhypervisor.org) which runs the VM. - crosvm (https://crosvm.dev/book/) used for graphics. - virtiofsd (https://virtio-fs.gitlab.io) to provide a filesystem - Spectrum OS's own proxy for the XDG desktop portals - In the future, an instance of vhost-device-sound ( https://github.com/rust-vmm/vhost-device/blob/main/vhost-device-sound/READM… ) used for sound - A per-VM D-Bus daemon - An instance of xdg-desktop-portal If the Cloud Hypervisor instance is stopped or exits, the others should be stopped automatically, as they have no other use. Having BindsTo=, After=, PropagatesStopTo=, and PropagatesReloadTo= should handle most cases, but I don't know if that is sufficient if Cloud Hypervisor exits spontaneously (because the guest shut down) or crashes. Additionally, these services have different sandboxing needs. Cloud Hypervisor should only be able to connect to its own instance of the daemons that serve it, rather than to any instance. crosvm needs GPU and Wayland access and vhost-device-sound needs to connect to PipeWire. virtiofsd needs an id-mapped mount. I would also like to block abstract AF_UNIX socket access. Are there existing systemd features that can easily meet these needs? For the sockets I am thinking of placing them in RuntimeDirectory= and only giving the correct units access to those directories. Also, I would like to use `DynamicUser=` for everything where that is possible.

2 1

[PATCH] vm: do not require KVM to run QEMU
by Demi Marie Obenour 15 Aug '25

15 Aug '25

This prevented running QEMU on Qubes OS. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- img/app/Makefile | 2 +- scripts/run-qemu.sh | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/img/app/Makefile b/img/app/Makefile index 5380ffb76e7bdf8867dcb61560d77028bf910fa3..e458ffebb7db0718007dd15af6a17dda74d36d0a 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -148,7 +148,7 @@ start-virtiofsd: scripts/start-virtiofsd.elb .PHONY: start-virtiofsd run-qemu: $(imgdir)/appvm/blk/root.img start-vhost-user-net start-virtiofsd - @../../scripts/run-qemu.sh -m 256 -cpu host -kernel $(KERNEL) -vga none \ + @../../scripts/run-qemu.sh -m 256 -kernel $(KERNEL) -vga none \ -drive file=$(imgdir)/appvm/blk/root.img,if=virtio,format=raw,readonly=on \ -append "root=PARTLABEL=root nokaslr" \ -gdb unix:build/gdb.sock,server,nowait \ diff --git a/scripts/run-qemu.sh b/scripts/run-qemu.sh index 64fd29259ab108bc547cb7c74623ae9dc288b3b7..9fa240aed44822a0aff295d246cb23a0e1cf7b8a 100755 --- a/scripts/run-qemu.sh +++ b/scripts/run-qemu.sh @@ -5,6 +5,8 @@ # This script wraps around QEMU to paper over platform differences, # which can't be handled portably in Make language. +cpu='-cpu host' +if [ ! -f /dev/kvm ]; then cpu=; fi case "${ARCH:="$(uname -m)"}" in aarch64) machine=virt,accel=kvm:tcg,gic-version=3,iommu=smmuv3 @@ -51,7 +53,7 @@ while [ $i -lt $# ]; do virtualization=on) case "$ARCH" in aarch64) - opt="$opt,accel=tcg" + opt="$opt,accel=tcg" cpu= ;; *) continue @@ -88,4 +90,5 @@ exec ${QEMU_SYSTEM:-qemu-system-$ARCH} \ -machine "$machine" \ ${kernel:+${append:+-append "$append"}} \ ${iommu:+-device "$iommu"} \ + $cpu \ "$@" --- base-commit: 39baa378367d95fac6ce4d0140b25203b2ee9b53 change-id: 20250807-no-require-kvm-c6755f4ade76 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 4

[PATCH] Add .envrc files for use with nix-direnv
by Demi Marie Obenour 14 Aug '25

14 Aug '25

This allows automatically setting up environment variables when entering a directory. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- .envrc | 1 + .gitignore | 1 + host/initramfs/.envrc | 1 + host/rootfs/.envrc | 1 + img/app/.envrc | 1 + release/checks/wayland/surface-notify/.envrc | 1 + release/live/.envrc | 1 + tools/.envrc | 1 + tools/lseek/.envrc | 1 + vm/sys/net/.envrc | 1 + 10 files changed, 10 insertions(+) diff --git a/.envrc b/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +use nix diff --git a/.gitignore b/.gitignore index 8bb50396847bb2d64fb7db9ea230f0fab23b17b1..86ebca8ba9af2c63122364a6f2b2a5337ca0f0e5 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ target/ **/subprojects/* !**/subprojects/*.wrap !**/subprojects/packagefiles +**/.direnv/* diff --git a/host/initramfs/.envrc b/host/initramfs/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/host/initramfs/.envrc @@ -0,0 +1 @@ +use nix diff --git a/host/rootfs/.envrc b/host/rootfs/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/host/rootfs/.envrc @@ -0,0 +1 @@ +use nix diff --git a/img/app/.envrc b/img/app/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/img/app/.envrc @@ -0,0 +1 @@ +use nix diff --git a/release/checks/wayland/surface-notify/.envrc b/release/checks/wayland/surface-notify/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/release/checks/wayland/surface-notify/.envrc @@ -0,0 +1 @@ +use nix diff --git a/release/live/.envrc b/release/live/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/release/live/.envrc @@ -0,0 +1 @@ +use nix diff --git a/tools/.envrc b/tools/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/tools/.envrc @@ -0,0 +1 @@ +use nix diff --git a/tools/lseek/.envrc b/tools/lseek/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/tools/lseek/.envrc @@ -0,0 +1 @@ +use nix diff --git a/vm/sys/net/.envrc b/vm/sys/net/.envrc new file mode 100644 index 0000000000000000000000000000000000000000..1d953f4bd73593aba0a2af3db2d14178e2b8b9fe --- /dev/null +++ b/vm/sys/net/.envrc @@ -0,0 +1 @@ +use nix --- base-commit: ecafd460a61e3ecf1a084e3e66eba32a0f7865a7 change-id: 20250808-envrc-d05f5fe739d7 -- Sincerely, Demi Marie Obenour (she/her/hers)

1 1

[PATCH] Add wrapper scripts to run make in a Nix shell
by Demi Marie Obenour 08 Aug '25

08 Aug '25

It is very easy to forget to do this, and the results are confusing at best and wrong at worst. Add wrapper scripts that get it right and also automatically change to the correct directory for you. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/initramfs/run-make.sh | 1 + host/rootfs/run-make.sh | 1 + img/app/run-make.sh | 1 + release/live/run-make.sh | 1 + scripts/run-make.sh | 12 ++++++++++++ tools/lseek/run-make.sh | 1 + vm/sys/net/run-make.sh | 1 + 7 files changed, 18 insertions(+) diff --git a/host/initramfs/run-make.sh b/host/initramfs/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..2142d230828768016cf5a4a59a895448ae3b12d9 --- /dev/null +++ b/host/initramfs/run-make.sh @@ -0,0 +1 @@ +../../scripts/run-make.sh \ No newline at end of file diff --git a/host/rootfs/run-make.sh b/host/rootfs/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..2142d230828768016cf5a4a59a895448ae3b12d9 --- /dev/null +++ b/host/rootfs/run-make.sh @@ -0,0 +1 @@ +../../scripts/run-make.sh \ No newline at end of file diff --git a/img/app/run-make.sh b/img/app/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..2142d230828768016cf5a4a59a895448ae3b12d9 --- /dev/null +++ b/img/app/run-make.sh @@ -0,0 +1 @@ +../../scripts/run-make.sh \ No newline at end of file diff --git a/release/live/run-make.sh b/release/live/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..2142d230828768016cf5a4a59a895448ae3b12d9 --- /dev/null +++ b/release/live/run-make.sh @@ -0,0 +1 @@ +../../scripts/run-make.sh \ No newline at end of file diff --git a/scripts/run-make.sh b/scripts/run-make.sh new file mode 100755 index 0000000000000000000000000000000000000000..b865bb3461b5d3f192598d273cee278a76d0a6b7 --- /dev/null +++ b/scripts/run-make.sh @@ -0,0 +1,12 @@ +#!/usr/bin/env -S bash -- +# SPDX-License-Identifier: CC0-1.0 +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +set -eu +case $0 in (/*) cd "${0%/*}/";; (*/*) cd "./${0%/*}";; esac +if [ ! -f shell.nix ] || [ ! -f Makefile ]; then + echo "Must have a shell.nix and a Makefile" >&2 + exit 1 +fi +cmd='exec make' +for i; do cmd+=" '"${i//\'/\'\\\'\'}\'; done +exec nix-shell --pure --run "$cmd" diff --git a/tools/lseek/run-make.sh b/tools/lseek/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..2142d230828768016cf5a4a59a895448ae3b12d9 --- /dev/null +++ b/tools/lseek/run-make.sh @@ -0,0 +1 @@ +../../scripts/run-make.sh \ No newline at end of file diff --git a/vm/sys/net/run-make.sh b/vm/sys/net/run-make.sh new file mode 120000 index 0000000000000000000000000000000000000000..38a7b0cf91ebf669e9794d91c6962cbe882de20f --- /dev/null +++ b/vm/sys/net/run-make.sh @@ -0,0 +1 @@ +../../../scripts/run-make.sh \ No newline at end of file --- base-commit: 39baa378367d95fac6ce4d0140b25203b2ee9b53 change-id: 20250807-make-wrapper-scripts-77231ac0c0a7 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 5

[PATCH] scripts/make-erofs.sh: disable xattr support
by Demi Marie Obenour 08 Aug '25

08 Aug '25

This fixes building a Spectrum image on a BTRFS filesystem with SELinux enabled. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- scripts/make-erofs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/make-erofs.sh b/scripts/make-erofs.sh index e460874d129fe3dfe0d4bc2bca707ced01e0025e..b47048ad747bd7dfcc28e0f1dfd75ec090fa7e09 100755 --- a/scripts/make-erofs.sh +++ b/scripts/make-erofs.sh @@ -45,4 +45,4 @@ while read -r arg1; do cp -RT -- "$arg1" "$root/$arg2" done -mkfs.erofs -b4096 --all-root "$@" "$root" +mkfs.erofs -x-1 -b4096 --all-root "$@" "$root" --- base-commit: 39baa378367d95fac6ce4d0140b25203b2ee9b53 change-id: 20250807-no-erofs-xattrs-9771d6688ad7 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH v3] Run PipeWire and WirePlumber in the VMs
by Demi Marie Obenour 02 Aug '25

02 Aug '25

WirePlumber is completely overkill as a session manager here, and ideally a trivial session manager would be used instead. I did build a Spectrum OS image and found that PipeWire and WirePlumber both successfully started. PipeWire is configured to listen on the PulseAudio socket, so PulseAudio compatibility works. This does inject a large number of completely unnecessary files into the VM, notably for libcamera and Bluetooth support. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- Changes since v2: Enable PipeWire's PulseAudio emulation. img/app/Makefile | 19 +- img/app/default.nix | 3 + img/app/etc/fstab | 5 +- .../pipewire.conf.d/90_enable_pulseaudio.conf | 172 ++++++++++++++++++ .../etc/s6-rc/app/dependencies.d/wireplumber | 0 .../app/dependencies.d/wireplumber.license | 2 + img/app/etc/s6-rc/directories/type | 1 + img/app/etc/s6-rc/directories/type.license | 2 + img/app/etc/s6-rc/directories/up | 11 ++ .../s6-rc/pipewire/dependencies.d/directories | 0 .../dependencies.d/directories.license | 2 + img/app/etc/s6-rc/pipewire/notification-fd | 1 + .../s6-rc/pipewire/notification-fd.license | 2 + img/app/etc/s6-rc/pipewire/run | 20 ++ img/app/etc/s6-rc/pipewire/type | 1 + img/app/etc/s6-rc/pipewire/type.license | 2 + .../dependencies.d/directories | 0 .../dependencies.d/directories.license | 2 + img/app/etc/s6-rc/wayland-proxy-virtwl/run | 11 -- .../etc/s6-rc/wireplumber/dependencies.d/dbus | 0 .../wireplumber/dependencies.d/dbus.license | 2 + .../s6-rc/wireplumber/dependencies.d/pipewire | 0 .../dependencies.d/pipewire.license | 2 + img/app/etc/s6-rc/wireplumber/run | 4 + img/app/etc/s6-rc/wireplumber/type | 1 + img/app/etc/s6-rc/wireplumber/type.license | 2 + 26 files changed, 251 insertions(+), 16 deletions(-) create mode 100644 img/app/etc/pipewire/pipewire.conf.d/90_enable_pulseaudio.conf create mode 100644 img/app/etc/s6-rc/app/dependencies.d/wireplumber create mode 100644 img/app/etc/s6-rc/app/dependencies.d/wireplumber.license create mode 100644 img/app/etc/s6-rc/directories/type create mode 100644 img/app/etc/s6-rc/directories/type.license create mode 100644 img/app/etc/s6-rc/directories/up create mode 100644 img/app/etc/s6-rc/pipewire/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/pipewire/dependencies.d/directories.license create mode 100644 img/app/etc/s6-rc/pipewire/notification-fd create mode 100644 img/app/etc/s6-rc/pipewire/notification-fd.license create mode 100644 img/app/etc/s6-rc/pipewire/run create mode 100644 img/app/etc/s6-rc/pipewire/type create mode 100644 img/app/etc/s6-rc/pipewire/type.license create mode 100644 img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/dbus create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license create mode 100644 img/app/etc/s6-rc/wireplumber/run create mode 100644 img/app/etc/s6-rc/wireplumber/type create mode 100644 img/app/etc/s6-rc/wireplumber/type.license diff --git a/img/app/Makefile b/img/app/Makefile index f818e91..8144518 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -53,7 +53,8 @@ VM_FILES = \ etc/s6-linux-init/scripts/rc.init \ etc/s6-linux-init/scripts/rc.shutdown \ etc/s6-linux-init/scripts/rc.shutdown.final \ - etc/xdg/xdg-desktop-portal/portals.conf + etc/xdg/xdg-desktop-portal/portals.conf \ + etc/pipewire/pipewire.conf.d/90_enable_pulseaudio.conf VM_DIRS = dev run proc sys tmp \ etc/s6-linux-init/run-image/service VM_FIFOS = etc/s6-linux-init/run-image/service/s6-linux-init-shutdownd/fifo @@ -83,22 +84,34 @@ build/rootfs.erofs: ../../scripts/make-erofs.sh $(VM_FILES) $(VM_BUILD_FILES) bu VM_S6_RC_FILES = \ etc/s6-rc/app/dependencies.d/dbus \ etc/s6-rc/app/dependencies.d/wayland-proxy-virtwl \ + etc/s6-rc/app/dependencies.d/wireplumber \ etc/s6-rc/app/run \ etc/s6-rc/app/type \ etc/s6-rc/dbus/notification-fd \ etc/s6-rc/dbus/run \ etc/s6-rc/dbus/type \ + etc/s6-rc/directories/type \ + etc/s6-rc/directories/up \ etc/s6-rc/mdevd-coldplug/dependencies \ etc/s6-rc/mdevd-coldplug/type \ etc/s6-rc/mdevd-coldplug/up \ etc/s6-rc/mdevd/notification-fd \ etc/s6-rc/mdevd/run \ etc/s6-rc/mdevd/type \ + etc/s6-rc/ok-all/contents \ + etc/s6-rc/ok-all/type \ + etc/s6-rc/pipewire/dependencies.d/directories \ + etc/s6-rc/pipewire/notification-fd \ + etc/s6-rc/pipewire/run \ + etc/s6-rc/pipewire/type \ + etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories \ etc/s6-rc/wayland-proxy-virtwl/notification-fd \ etc/s6-rc/wayland-proxy-virtwl/run \ etc/s6-rc/wayland-proxy-virtwl/type \ - etc/s6-rc/ok-all/contents \ - etc/s6-rc/ok-all/type + etc/s6-rc/wireplumber/dependencies.d/dbus \ + etc/s6-rc/wireplumber/dependencies.d/pipewire \ + etc/s6-rc/wireplumber/run \ + etc/s6-rc/wireplumber/type build/etc/s6-rc: $(VM_S6_RC_FILES) mkdir -p $$(dirname $@) diff --git a/img/app/default.nix b/img/app/default.nix index 740643a..d3eed1f 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -48,6 +48,9 @@ let pkgs.xwayland pkgs.xdg-desktop-portal pkgs.xdg-desktop-portal-gtk + # Depends on pulseaudio libs + pkgs.pipewire + pkgs.wireplumber ]; })).fhsenv; in diff --git a/img/app/etc/fstab b/img/app/etc/fstab index a95088b..40aa3bd 100644 --- a/img/app/etc/fstab +++ b/img/app/etc/fstab @@ -1,7 +1,8 @@ # SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: 2020-2022 Alyssa Ross <hi(a)alyssa.is> proc /proc proc defaults 0 0 -devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 +devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 tmpfs /dev/shm tmpfs defaults 0 0 sysfs /sys sysfs defaults 0 0 -tmpfs /tmp tmpfs defaults 0 0 +tmpfs /tmp tmpfs defaults,mode=1755 0 0 +tmpfs /run tmpfs defaults 0 0 diff --git a/img/app/etc/pipewire/pipewire.conf.d/90_enable_pulseaudio.conf b/img/app/etc/pipewire/pipewire.conf.d/90_enable_pulseaudio.conf new file mode 100644 index 0000000..a5b86a6 --- /dev/null +++ b/img/app/etc/pipewire/pipewire.conf.d/90_enable_pulseaudio.conf @@ -0,0 +1,172 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans + +# Copyright © 2018 Wim Taymans +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice (including the next +# paragraph) shall be included in all copies or substantial portions of the +# Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. + +# PulseAudio config file for PipeWire version "1.4.2" # +# +# Copy and edit this file in /etc/pipewire for system-wide changes +# or in ~/.config/pipewire for local changes. +# +# It is also possible to place a file with an updated section in +# /etc/pipewire/pipewire-pulse.conf.d/ for system-wide changes or in +# ~/.config/pipewire/pipewire-pulse.conf.d/ for local changes. +# + +context.modules = [ + { name = libpipewire-module-protocol-pulse + args = { + # contents of pulse.properties can also be placed here + # to have config per server. + } + } +] + +# Extra commands can be executed here. +# load-module : loads a module with args and flags +# args = "<module-name> <module-args>" +# ( flags = [ nofail ] ) +# ( condition = [ { <key1> = <value1>, ... } ... ] ) +# conditions will check the pulse.properties key/values. +pulse.cmd = [ + { cmd = "load-module" args = "module-always-sink" flags = [ ] + condition = [ { pulse.cmd.always-sink = !false } ] } + { cmd = "load-module" args = "module-device-manager" flags = [ ] + condition = [ { pulse.cmd.device-manager = !false } ] } + { cmd = "load-module" args = "module-device-restore" flags = [ ] + condition = [ { pulse.cmd.device-restore = !false } ] } + { cmd = "load-module" args = "module-stream-restore" flags = [ ] + condition = [ { pulse.cmd.stream-restore = !false } ] } + #{ cmd = "load-module" args = "module-switch-on-connect" } + #{ cmd = "load-module" args = "module-gsettings" flags = [ nofail ] } +] + +stream.properties = { + #node.latency = 1024/48000 + #node.autoconnect = true + #resample.quality = 4 + #channelmix.normalize = false + #channelmix.mix-lfe = true + #channelmix.upmix = true + #channelmix.upmix-method = psd # none, simple + #channelmix.lfe-cutoff = 150 + #channelmix.fc-cutoff = 12000 + #channelmix.rear-delay = 12.0 + #channelmix.stereo-widen = 0.0 + #channelmix.hilbert-taps = 0 + #dither.noise = 0 +} + +pulse.properties = { + # the addresses this server listens on + server.address = [ + "unix:native" + #"unix:/tmp/something" # absolute paths may be used + #"tcp:4713" # IPv4 and IPv6 on all addresses + #"tcp:[::]:9999" # IPv6 on all addresses + #"tcp:127.0.0.1:8888" # IPv4 on a single address + # + #{ address = "tcp:4713" # address + # max-clients = 64 # maximum number of clients + # listen-backlog = 32 # backlog in the server listen queue + # client.access = "restricted" # permissions for clients + #} + ] + #server.dbus-name = "org.pulseaudio.Server" + #pulse.allow-module-loading = true + #pulse.min.req = 128/48000 # 2.7ms + #pulse.default.req = 960/48000 # 20 milliseconds + #pulse.min.frag = 128/48000 # 2.7ms + #pulse.default.frag = 96000/48000 # 2 seconds + #pulse.default.tlength = 96000/48000 # 2 seconds + #pulse.min.quantum = 128/48000 # 2.7ms + #pulse.idle.timeout = 0 # don't pause after underruns + #pulse.default.format = F32 + #pulse.default.position = [ FL FR ] +} + +pulse.properties.rules = [ + { matches = [ { cpu.vm.name = !null } ] + actions = { + update-props = { + # These overrides are only applied when running in a vm. + pulse.min.quantum = 1024/48000 # 22ms + } + } + } +] + +# client/stream specific properties +pulse.rules = [ + { + matches = [ + { + # all keys must match the value. ! negates. ~ starts regex. + #client.name = "Firefox" + #application.process.binary = "teams" + #application.name = "~speech-dispatcher.*" + } + ] + actions = { + update-props = { + #node.latency = 512/48000 + } + # Possible quirks:" + # force-s16-info forces sink and source info as S16 format + # remove-capture-dont-move removes the capture DONT_MOVE flag + # block-source-volume blocks updates to source volume + # block-sink-volume blocks updates to sink volume + #quirks = [ ] + } + } + { + # skype does not want to use devices that don't have an S16 sample format. + matches = [ + { application.process.binary = "teams" } + { application.process.binary = "teams-insiders" } + { application.process.binary = "teams-for-linux" } + { application.process.binary = "skypeforlinux" } + ] + actions = { quirks = [ force-s16-info ] } + } + { + # firefox marks the capture streams as don't move and then they + # can't be moved with pavucontrol or other tools. + matches = [ { application.process.binary = "firefox" } ] + actions = { quirks = [ remove-capture-dont-move ] } + } + { + # speech dispatcher asks for too small latency and then underruns. + matches = [ { application.name = "~speech-dispatcher.*" } ] + actions = { + update-props = { + pulse.min.req = 512/48000 # 10.6ms + pulse.min.quantum = 512/48000 # 10.6ms + pulse.idle.timeout = 5 # pause after 5 seconds of underrun + } + } + } + #{ + # matches = [ { application.process.binary = "Discord" } ] + # actions = { quirks = [ block-source-volume ] } + #} +] diff --git a/img/app/etc/s6-rc/app/dependencies.d/wireplumber b/img/app/etc/s6-rc/app/dependencies.d/wireplumber new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license b/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/directories/type b/img/app/etc/s6-rc/directories/type new file mode 100644 index 0000000..bdd22a1 --- /dev/null +++ b/img/app/etc/s6-rc/directories/type @@ -0,0 +1 @@ +oneshot diff --git a/img/app/etc/s6-rc/directories/type.license b/img/app/etc/s6-rc/directories/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/directories/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/directories/up b/img/app/etc/s6-rc/directories/up new file mode 100644 index 0000000..2396fad --- /dev/null +++ b/img/app/etc/s6-rc/directories/up @@ -0,0 +1,11 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# +# Directory creation (if it's copyrightable): +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Unikie + +if { mkdir -m 1755 /tmp/.X11-unix } +if { mkdir -m 0755 /run/user } +if { mkdir -m 0700 /run/user/0 } diff --git a/img/app/etc/s6-rc/pipewire/dependencies.d/directories b/img/app/etc/s6-rc/pipewire/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license b/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/pipewire/notification-fd b/img/app/etc/s6-rc/pipewire/notification-fd new file mode 100644 index 0000000..7ed6ff8 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/notification-fd @@ -0,0 +1 @@ +5 diff --git a/img/app/etc/s6-rc/pipewire/notification-fd.license b/img/app/etc/s6-rc/pipewire/notification-fd.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/notification-fd.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/pipewire/run b/img/app/etc/s6-rc/pipewire/run new file mode 100644 index 0000000..c0b55a1 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/run @@ -0,0 +1,20 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0 +fdmove -c 3 0 + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0-manager +fdmove -c 4 0 + +redirfd -r 0 /dev/null + +# Notify readiness. +if { fdmove 1 5 echo } +fdclose 5 + +export LISTEN_FDS 2 +getpid LISTEN_PID +pipewire diff --git a/img/app/etc/s6-rc/pipewire/type b/img/app/etc/s6-rc/pipewire/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/type @@ -0,0 +1 @@ +longrun diff --git a/img/app/etc/s6-rc/pipewire/type.license b/img/app/etc/s6-rc/pipewire/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/run b/img/app/etc/s6-rc/wayland-proxy-virtwl/run index 7b80343..c1e0e08 100755 --- a/img/app/etc/s6-rc/wayland-proxy-virtwl/run +++ b/img/app/etc/s6-rc/wayland-proxy-virtwl/run @@ -1,17 +1,6 @@ #!/bin/execlineb -P # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> -# -# Directory creation (if it's copyrightable): -# SPDX-License-Identifier: MIT -# SPDX-FileCopyrightText: 2022 Unikie - -foreground { mkdir /tmp/.X11-unix } -foreground { mkdir /run/user } -foreground { - umask 077 - mkdir /run/user/0 -} s6-ipcserver-socketbinder -B /run/user/0/wayland-0 fdmove -c 3 0 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wireplumber/run b/img/app/etc/s6-rc/wireplumber/run new file mode 100644 index 0000000..e721d8d --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/run @@ -0,0 +1,4 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +wireplumber diff --git a/img/app/etc/s6-rc/wireplumber/type b/img/app/etc/s6-rc/wireplumber/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/type @@ -0,0 +1 @@ +longrun diff --git a/img/app/etc/s6-rc/wireplumber/type.license b/img/app/etc/s6-rc/wireplumber/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> base-commit: 9090caebe25310caa80a13787ef58b1f81658a78 -- Sincerely, Demi Marie Obenour (she/her/hers)

3 80

Does Spectrum have a web submission endpoint for b4?
by Demi Marie Obenour 28 Jul '25

28 Jul '25

I'm curious if Spectrum has a web submission endpoint for b4. would lower the barrier to entry for those who have bad mail clients, like the GMail web UI. I did notice that .b4-config did not mention one. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 5

"make run-qemu" gets Wayland protocol error
by Demi Marie Obenour 20 Jul '25

20 Jul '25

If I run `make run-qemu` under a Wayland compositor (tested with both Sway and Weston), I get a Wayland protocol error ("invalid object 0") and QEMU exits. It appears that there is a problem with wayland-proxy-virtwl. I get the following error from foot: warn: main.c:437: 'C' is not a UTF-8 locale, falling back to 'C.UTF-8' warn: config.c:3520: no configuration found, using defaults Fontconfig warning: no <cachedir> elements found. Check configuration. Fontconfig warning: adding <cachedir>/var/cache/fontconfig</cachedir> Fontconfig warning: adding <cachedir prefix="xdg">fontconfig</cachedir> err: wayland.c:1714: no compositor err: wayland.c:2248: failed to flush wayland socket: Connection reset by peer And the following from wayland-proxy-virtwl: 2025-07-20 02:14:48.638 wl-proxy [WARNING]: Error handling client: Invalid_argument("invalid bounds in Cstruct.LE.get_uint32 [0,0](4096) off=0 len=4") In case it matters: - This is with some patches to allow use of TCG and others for PipeWire. I highly doubt either set are relevant here. - I tested this with both Sway and Weston. Each was added to img/app/shell.nix so that it would be available in the nix-shell environment. Both ran nested under the X11 session provided by Qubes OS. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 8

Mouse cursor losing sync
by Demi Marie Obenour 20 Jul '25

20 Jul '25

When I run the Spectrum installer in QEMU, the in-VM and out-VM mouse cursors lose sync with each other. This makes it very difficult to click the Terminal button at the top left. The problem reproduces both under Fedora 42 (KVM, KWin Wayland) and Qubes OS (Arch template, TCG, X11). -- Sincerely, Demi Marie Obenour (she/her/hers)

1 0

Cannot build release.nix without KVM
by Demi Marie Obenour 17 Jul '25

17 Jul '25

On a Qubes OS VM (which doesn't have nested virtualization), building release.nix fails because start-vmm-test (rightly) errors out. Having KVM be a *build*-time dependency of Spectrum OS seems rather strict, especially because I can always copy the generated files over to another machine and run them there. In particular, I can copy the resulting image and run it in QEMU. Ideally I could use Nix's remote build support for this. However, that is designed for the case where I am offloading work to a powerful and trusted server, whereas in my case the remote machine is for testing purposes only. Therefore, to save money, it is cheap, and it is also generally treated as untrusted because I don't hold it to the same standards I hold my highly trusted main laptop to. For instance, it doesn't have credentials to send emails. Is it possible to copy what I need for the tests (using 'nix copy' or 'nix-copy-closure' perhaps?) and skip them locally? Can I run the tests that do not need KVM while still running the rest? This is probably simple for anyone familiar with Nix, but that is not me. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 3

[PATCH] tools: mark start-vmm test as requiring KVM
by Alyssa Ross 14 Jul '25

14 Jul '25

This will tell Nix (on a correctly configured system) that if it doesn't have KVM, it can't build the package, allowing it to fall back to outsourcing it to a remote builder in that case. Ideally, we don't want to have any part of the Spectrum build requiring KVM, but until that's fixed, occurences should at least be correctly marked. Fixes: a4e3a40 ("host/start-vmm: actually run "run" test") Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Demi, if you find other occurences of derivations requiring KVM to build, please send a patch like this. :) tools/default.nix | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tools/default.nix b/tools/default.nix index 7a2926d..908ec0d 100644 --- a/tools/default.nix +++ b/tools/default.nix @@ -142,7 +142,9 @@ stdenv.mkDerivation (finalAttrs: { } ); - run = runCommand "start-vmm-test" {} '' + run = runCommand "start-vmm-test" { + requiredSystemFeatures = [ "kvm" ]; + } '' ${run-spectrum-vm.override { spectrum-host-tools = finalAttrs.finalPackage; }} > $out base-commit: 9090caebe25310caa80a13787ef58b1f81658a78 -- 2.49.0

1 0

Better FD for the host-side portal code?
by Demi Marie Obenour 14 Jul '25

14 Jul '25

I saw that the host-side portal code uses FD 0 for the listening socket. Would it be better to use a different file descriptor for that? Alternatively, I can dup() /dev/null over stdin. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

Re: [PATCH v9 0/1] virtio-media: Add device specification
by Demi Marie Obenour 09 Jul '25

09 Jul '25

On 7/9/25 05:34, Albert Esteve wrote: > New attempt of including virtio-media > device specification. > > v8->v9: > - Rebased to virtio-1.4 > > v7->v8: > - Merged DQBUF and DQEVENT into the same > item for unsupported ioctls > - Rewrote/clarified a couple paragraphs > based on previous version reviews. > > Virtio-media came from a discussion on virtio-dev > mailing list, which lead to Alex Courbot presenting > virtio-v4l2[1] specification as an alternative to > virtio-video. > > Later, virtio-v4l2 was renamed to virtio-media[2] > and published at: > > https://github.com/chromeos/virtio-media > > The repository above includes a virtio-media driver able > to pass v4l2-compliance when proxying the vivid/vicodec > virtual devices or an actual UVC camera using the > V4L2 vhost device (available in the repository). > It also includes a FFmpeg-based video encoder > device. Steps to reproduce are also detailed[3]. > > Recently, virtio-media has landed in AOSP[4]. > Also the driver patch has been sent to the > kernel, currently in its v2 [5]. > > Furthermore, virtio-media got a proposal to reserve > device ID 48, which was finally approved for > inclusion in v1.4. > > There is some overlap with virtio-video in regards > to which devices it can handle. However, they take > different approaches, potentially making them > the preferable choice for different scenarios. > Furthermore, virtio-media has matured since it > was first presented, and there are public efforts > to have upstream driver and devices. > > But mainly, given that virtio-media will be the virtualization > solution for media devices for ChromeOS, Android, and > possibly others, I think is important that it gets > standardized and included in the specification, > despite the aforementioned overlap. > > Full PDF: https://drive.google.com/file/d/1sDZXWVlvPbHKKguhekCXMzkpNZZ0g3hV/view?usp=… > PDF with the media section only: https://drive.google.com/file/d/1JjOIzecnkFFlpFBRjPQEUyAOD3BDHAdw/view?usp=… > > [1] https://mail.google.com/mail/u/0?ui=2&ik=73ebd65ebd&attid=0.1&permmsgid=msg… > [2] https://www.mail-archive.com/virtio-dev@lists.oasis-open.org/msg12665.html > [3] https://github.com/chromeos/virtio-media/blob/main/TRY_IT_OUT.md > [4] https://cs.android.com/android/platform/superproject/main/+/main:external/v… > [5] https://lore.kernel.org/lkml/20250201-virtio-media-v2-1-ac840681452d@gmail.… > > Albert Esteve (1): > virtio-media: Add virtio media device specification > > conformance.tex | 6 + > content.tex | 1 + > device-types/media/description.tex | 639 ++++++++++++++++++++++ > device-types/media/device-conformance.tex | 15 + > device-types/media/driver-conformance.tex | 11 + > 5 files changed, 672 insertions(+) > create mode 100644 device-types/media/description.tex > create mode 100644 device-types/media/device-conformance.tex > create mode 100644 device-types/media/driver-conformance.tex It's probably too late, but I have some serious concerns about this device. Specifically: 1. I don't see a reasonable way to support untrusted virtio-media devices. v4l2 has too many ioctls and I can't realistically see a way to enforce that the return values from all of them are consistent with each other. It is possible to only allow a fixed format (such as uncompressed ARGB) and only allow the video source and/or sink to provide resolutions and frame rates, but this means losing a lot of performance and abandoning any attempt at zero-copy. The use-case for untrusted virtio-media devices is not confidential computing, but rather disaggregated systems where video sources (like webcams) may be attached to untrusted virtual machines. 2. v4l2 is a chatty protocol and using it implies a lot of guest <=> host round-trips. This is bad for performance. Is this overhead actually significant, and if so, are there plans to reduce it? -- Sincerely, Demi Marie Obenour (she/her/hers)

2 2

Building image fails on btrfs due to mkfs.erofs xattr limitation
by Demi Marie Obenour 05 Jul '25

05 Jul '25

Unless extended attributes are disabled (with -x-1), mkfs.erofs fails when the source is a BTRFS filesystem. This prevents the Spectrum image from being built. Using -x-1 seems to produce a working installer, though I only smoke tested it (by trying the example VMs). -- Sincerely, Demi Marie Obenour (she/her/hers)

2 3

[PATCH] Run PipeWire and WirePlumber in the VMs
by Demi Marie Obenour 04 Jul '25

04 Jul '25

WirePlumber is completely overkill as a session manager here, and ideally a trivial session manager would be used instead. I did build a Spectrum OS image and found that PipeWire and WirePlumber both successfully started. This does *not* start pipewire-pulse, so programs using PulseAudio won't work. That will come later. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- img/app/Makefile | 16 +++++++++++++-- img/app/default.nix | 5 ++++- img/app/etc/fstab | 5 +++-- .../etc/s6-rc/app/dependencies.d/wireplumber | 0 .../app/dependencies.d/wireplumber.license | 2 ++ img/app/etc/s6-rc/directories/type | 1 + img/app/etc/s6-rc/directories/type.license | 2 ++ img/app/etc/s6-rc/directories/up | 11 ++++++++++ .../s6-rc/pipewire/dependencies.d/directories | 0 .../dependencies.d/directories.license | 2 ++ img/app/etc/s6-rc/pipewire/notification-fd | 1 + .../s6-rc/pipewire/notification-fd.license | 2 ++ img/app/etc/s6-rc/pipewire/run | 20 +++++++++++++++++++ img/app/etc/s6-rc/pipewire/type | 1 + img/app/etc/s6-rc/pipewire/type.license | 2 ++ .../dependencies.d/directories | 0 .../dependencies.d/directories.license | 2 ++ img/app/etc/s6-rc/wayland-proxy-virtwl/run | 11 ---------- .../etc/s6-rc/wireplumber/dependencies.d/dbus | 0 .../wireplumber/dependencies.d/dbus.license | 2 ++ .../s6-rc/wireplumber/dependencies.d/pipewire | 0 .../dependencies.d/pipewire.license | 2 ++ img/app/etc/s6-rc/wireplumber/run | 4 ++++ img/app/etc/s6-rc/wireplumber/type | 1 + img/app/etc/s6-rc/wireplumber/type.license | 2 ++ 25 files changed, 78 insertions(+), 16 deletions(-) create mode 100644 img/app/etc/s6-rc/app/dependencies.d/wireplumber create mode 100644 img/app/etc/s6-rc/app/dependencies.d/wireplumber.license create mode 100644 img/app/etc/s6-rc/directories/type create mode 100644 img/app/etc/s6-rc/directories/type.license create mode 100644 img/app/etc/s6-rc/directories/up create mode 100644 img/app/etc/s6-rc/pipewire/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/pipewire/dependencies.d/directories.license create mode 100644 img/app/etc/s6-rc/pipewire/notification-fd create mode 100644 img/app/etc/s6-rc/pipewire/notification-fd.license create mode 100644 img/app/etc/s6-rc/pipewire/run create mode 100644 img/app/etc/s6-rc/pipewire/type create mode 100644 img/app/etc/s6-rc/pipewire/type.license create mode 100644 img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/dbus create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license create mode 100644 img/app/etc/s6-rc/wireplumber/run create mode 100644 img/app/etc/s6-rc/wireplumber/type create mode 100644 img/app/etc/s6-rc/wireplumber/type.license diff --git a/img/app/Makefile b/img/app/Makefile index c827fd3..07fdf6f 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -83,22 +83,34 @@ build/rootfs.erofs: ../../scripts/make-erofs.sh $(VM_FILES) $(VM_BUILD_FILES) bu VM_S6_RC_FILES = \ etc/s6-rc/app/dependencies.d/dbus \ etc/s6-rc/app/dependencies.d/wayland-proxy-virtwl \ + etc/s6-rc/app/dependencies.d/wireplumber \ etc/s6-rc/app/run \ etc/s6-rc/app/type \ etc/s6-rc/dbus/notification-fd \ etc/s6-rc/dbus/run \ etc/s6-rc/dbus/type \ + etc/s6-rc/directories/type \ + etc/s6-rc/directories/up \ etc/s6-rc/mdevd-coldplug/dependencies \ etc/s6-rc/mdevd-coldplug/type \ etc/s6-rc/mdevd-coldplug/up \ etc/s6-rc/mdevd/notification-fd \ etc/s6-rc/mdevd/run \ etc/s6-rc/mdevd/type \ + etc/s6-rc/ok-all/contents \ + etc/s6-rc/ok-all/type \ + etc/s6-rc/pipewire/dependencies.d/directories \ + etc/s6-rc/pipewire/notification-fd \ + etc/s6-rc/pipewire/run \ + etc/s6-rc/pipewire/type \ + etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories \ etc/s6-rc/wayland-proxy-virtwl/notification-fd \ etc/s6-rc/wayland-proxy-virtwl/run \ etc/s6-rc/wayland-proxy-virtwl/type \ - etc/s6-rc/ok-all/contents \ - etc/s6-rc/ok-all/type + etc/s6-rc/wireplumber/dependencies.d/dbus \ + etc/s6-rc/wireplumber/dependencies.d/pipewire \ + etc/s6-rc/wireplumber/run \ + etc/s6-rc/wireplumber/type build/etc/s6-rc: $(VM_S6_RC_FILES) mkdir -p $$(dirname $@) diff --git a/img/app/default.nix b/img/app/default.nix index a196205..32ddb67 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -8,7 +8,7 @@ pkgsStatic.callPackage ( { lib, stdenvNoCC, runCommand, writeClosure , erofs-utils, jq, s6-rc, util-linux , busybox, cacert, dejavu_fonts, execline, kmod, linux_latest, mdevd, s6 -, s6-linux-init, xdg-desktop-portal-spectrum, +, s6-linux-init, xdg-desktop-portal-spectrum }: let @@ -48,6 +48,9 @@ let pkgs.xwayland pkgs.xdg-desktop-portal pkgs.xdg-desktop-portal-gtk + # Depends on pulseaudio libs + pkgs.pipewire + pkgs.wireplumber ]; })).fhsenv; in diff --git a/img/app/etc/fstab b/img/app/etc/fstab index a95088b..40aa3bd 100644 --- a/img/app/etc/fstab +++ b/img/app/etc/fstab @@ -1,7 +1,8 @@ # SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: 2020-2022 Alyssa Ross <hi(a)alyssa.is> proc /proc proc defaults 0 0 -devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 +devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 tmpfs /dev/shm tmpfs defaults 0 0 sysfs /sys sysfs defaults 0 0 -tmpfs /tmp tmpfs defaults 0 0 +tmpfs /tmp tmpfs defaults,mode=1755 0 0 +tmpfs /run tmpfs defaults 0 0 diff --git a/img/app/etc/s6-rc/app/dependencies.d/wireplumber b/img/app/etc/s6-rc/app/dependencies.d/wireplumber new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license b/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/app/dependencies.d/wireplumber.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/directories/type b/img/app/etc/s6-rc/directories/type new file mode 100644 index 0000000..bdd22a1 --- /dev/null +++ b/img/app/etc/s6-rc/directories/type @@ -0,0 +1 @@ +oneshot diff --git a/img/app/etc/s6-rc/directories/type.license b/img/app/etc/s6-rc/directories/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/directories/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/directories/up b/img/app/etc/s6-rc/directories/up new file mode 100644 index 0000000..2396fad --- /dev/null +++ b/img/app/etc/s6-rc/directories/up @@ -0,0 +1,11 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# +# Directory creation (if it's copyrightable): +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Unikie + +if { mkdir -m 1755 /tmp/.X11-unix } +if { mkdir -m 0755 /run/user } +if { mkdir -m 0700 /run/user/0 } diff --git a/img/app/etc/s6-rc/pipewire/dependencies.d/directories b/img/app/etc/s6-rc/pipewire/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license b/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/dependencies.d/directories.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/pipewire/notification-fd b/img/app/etc/s6-rc/pipewire/notification-fd new file mode 100644 index 0000000..7ed6ff8 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/notification-fd @@ -0,0 +1 @@ +5 diff --git a/img/app/etc/s6-rc/pipewire/notification-fd.license b/img/app/etc/s6-rc/pipewire/notification-fd.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/notification-fd.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/pipewire/run b/img/app/etc/s6-rc/pipewire/run new file mode 100644 index 0000000..c0b55a1 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/run @@ -0,0 +1,20 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0 +fdmove -c 3 0 + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0-manager +fdmove -c 4 0 + +redirfd -r 0 /dev/null + +# Notify readiness. +if { fdmove 1 5 echo } +fdclose 5 + +export LISTEN_FDS 2 +getpid LISTEN_PID +pipewire diff --git a/img/app/etc/s6-rc/pipewire/type b/img/app/etc/s6-rc/pipewire/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/type @@ -0,0 +1 @@ +longrun diff --git a/img/app/etc/s6-rc/pipewire/type.license b/img/app/etc/s6-rc/pipewire/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/run b/img/app/etc/s6-rc/wayland-proxy-virtwl/run index 7b80343..c1e0e08 100755 --- a/img/app/etc/s6-rc/wayland-proxy-virtwl/run +++ b/img/app/etc/s6-rc/wayland-proxy-virtwl/run @@ -1,17 +1,6 @@ #!/bin/execlineb -P # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> -# -# Directory creation (if it's copyrightable): -# SPDX-License-Identifier: MIT -# SPDX-FileCopyrightText: 2022 Unikie - -foreground { mkdir /tmp/.X11-unix } -foreground { mkdir /run/user } -foreground { - umask 077 - mkdir /run/user/0 -} s6-ipcserver-socketbinder -B /run/user/0/wayland-0 fdmove -c 3 0 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> diff --git a/img/app/etc/s6-rc/wireplumber/run b/img/app/etc/s6-rc/wireplumber/run new file mode 100644 index 0000000..e721d8d --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/run @@ -0,0 +1,4 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +wireplumber diff --git a/img/app/etc/s6-rc/wireplumber/type b/img/app/etc/s6-rc/wireplumber/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/type @@ -0,0 +1 @@ +longrun diff --git a/img/app/etc/s6-rc/wireplumber/type.license b/img/app/etc/s6-rc/wireplumber/type.license new file mode 100644 index 0000000..c4a0586 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/type.license @@ -0,0 +1,2 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> base-commit: 979bd3090215048fc6815abb2189b4d1809c98ef -- Sincerely, Demi Marie Obenour (she/her/hers)

1 0

Re: [PATCH] Documentation: request patches not to be PGP signed
by Alyssa Ross 28 Jun '25

28 Jun '25

This patch has been committed as dc112f871ccf037c918b90d813b807259b4a3ba1, which can be viewed online at https://spectrum-os.org/git/spectrum/commit/?id=dc112f871ccf037c918b90d813b…. This is an automated message. Send comments/questions/requests to: Alyssa Ross <hi(a)alyssa.is>

1 0

[PATCH 0/8] Change serial getty instances dynamically
by Alyssa Ross 28 Jun '25

28 Jun '25

The host system is supposed to provide a shell on whatever serial devices are configured as the active kernel consoles. Previously, the system made the assumption that the active console would never change after boot, but in reality devices can be added and removed later than that. One situation in which this happened is when a serial device was configured whose driver was not built in to the kernel, but loaded as a module after the console was checked by rc.init. This series fixes that by creating and destroying instances of the serial-getty service whenever the active kernel consoles change, and adds a regression test. Since this is the second test that involves running a full Spectrum system in a VM, most of the series has ended up being refactoring the first such test, so that code can be shared with this new one. Yureka, I don't know whether this is the issue you were encountering when you tried debugging the Weston issue over serial, but maybe worth a try? I suspect not though, because if I recall correctly you weren't even getting kernel logs? This was the only issue I could find trying to reproduce the problem in QEMU. Alyssa Ross (8): host/rootfs: poll active consoles for serial getty release/checks/integration: init from networking release/checks/integration: use default Meson timeout release/checks/integration: extract config struct release/checks/integration: run from tmpdir release/checks/integration: name QEMU arg pointers release/checks/integration: extract library release/checks/integration: test late serial host/rootfs/Makefile | 1 + host/rootfs/default.nix | 8 +- .../service/serial-getty-generator/run | 43 +++ host/rootfs/etc/s6-linux-init/scripts/rc.init | 9 - release/checks/default.nix | 4 +- release/checks/integration/default.nix | 88 +++++ release/checks/integration/late-serial.c | 15 + release/checks/integration/lib.c | 221 ++++++++++++ release/checks/integration/lib.h | 20 ++ release/checks/integration/meson.build | 21 ++ release/checks/integration/meson_options.txt | 6 + release/checks/integration/networking.c | 138 +++++++ release/checks/networking/default.nix | 62 ---- release/checks/networking/test.c | 337 ------------------ release/checks/pkg-tests.nix | 2 +- 15 files changed, 560 insertions(+), 415 deletions(-) create mode 100755 host/rootfs/etc/s6-linux-init/run-image/service/serial-getty-generator/run create mode 100644 release/checks/integration/default.nix create mode 100644 release/checks/integration/late-serial.c create mode 100644 release/checks/integration/lib.c create mode 100644 release/checks/integration/lib.h create mode 100644 release/checks/integration/meson.build create mode 100644 release/checks/integration/meson_options.txt create mode 100644 release/checks/integration/networking.c delete mode 100644 release/checks/networking/default.nix delete mode 100644 release/checks/networking/test.c base-commit: 42887a0331fd058ee0930fd5209fc3265565c3a8 -- 2.49.0

2 14

Virtio-IOMMU interrupt remapping design
by Demi Marie Obenour 17 Jun '25

17 Jun '25

Virtio-IOMMU interrupt remapping turned out to be much harder than I realized. The main problem is that interrupt remapping is set up very early in boot. In fact, Linux calls the interrupt remapping probe function from the APIC initialization code: x86_64_probe_apic -> enable_IR_x2apic -> irq_remapping_prepare(). This is almost certainly much before PCI has been initialized. Also, the order in which devices will be initialized is not something Linux guarantees at all, which is a problem because interrupt remapping must be initialized before drivers start setting up interrupts. Otherwise, the interrupt remapping table won't include entries for already-existing interrupts, and things will either break badly, not get the benefit of interrupt remapping security-wise, or both. The reason I expect this doesn't cause problems for address translation is that the IOMMU probably starts in bypass mode by default, meaning that all DMA is permitted. If the IOMMU is only used by VFIO or IOMMUFD, it will not be needed until userspace starts up, which is after the IOMMU has been initialized. This isn't ideal, though, as it means that kernel drivers operate without DMA protection. Is a paravirtualized IOMMU with interrupt remapping something that makes sense? Absolutely! However, the IOMMU should be considered a platform device that must be initialized very early in boot. Using virtio-IOMMU with MMIO transport as the interface might be a reasonable option, but the IOMMU needs to be enumerated via ACPI, device tree, or kernel command line argument. This allows it to be brought up before anything capable of DMA is initialized. Is this the right path to go down? What do others think about this? -- Sincerely, Demi Marie Obenour (she/her/hers)

3 8

[RFC PATCH] Run PipeWire and WirePlumber in the VMs
by Demi Marie Obenour 17 Jun '25

17 Jun '25

WirePlumber is completely overkill as a session manager here, and ideally a trivial session manager would be used instead. Also, this code has seen absolutely no testing beyond "it builds", not least because there is no way to add a virtio-sound device to Cloud Hypervisor yet and I haven't tried using QEMU TCG. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- img/app/default.nix | 5 ++++- img/app/etc/fstab | 5 +++-- .../etc/s6-rc/app/dependencies.d/wireplumber | 0 img/app/etc/s6-rc/directories/type | 1 + img/app/etc/s6-rc/directories/up | 11 ++++++++++ .../s6-rc/pipewire/dependencies.d/directories | 0 img/app/etc/s6-rc/pipewire/notification-fd | 1 + img/app/etc/s6-rc/pipewire/run | 20 +++++++++++++++++++ img/app/etc/s6-rc/pipewire/type | 1 + .../dependencies.d/directories | 0 img/app/etc/s6-rc/wayland-proxy-virtwl/run | 11 ---------- .../etc/s6-rc/wireplumber/dependencies.d/dbus | 0 .../s6-rc/wireplumber/dependencies.d/pipewire | 0 img/app/etc/s6-rc/wireplumber/run | 16 +++++++++++++++ img/app/etc/s6-rc/wireplumber/type | 1 + 15 files changed, 58 insertions(+), 14 deletions(-) create mode 100644 img/app/etc/s6-rc/app/dependencies.d/wireplumber create mode 100644 img/app/etc/s6-rc/directories/type create mode 100644 img/app/etc/s6-rc/directories/up create mode 100644 img/app/etc/s6-rc/pipewire/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/pipewire/notification-fd create mode 100644 img/app/etc/s6-rc/pipewire/run create mode 100644 img/app/etc/s6-rc/pipewire/type create mode 100644 img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/dbus create mode 100644 img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire create mode 100644 img/app/etc/s6-rc/wireplumber/run create mode 100644 img/app/etc/s6-rc/wireplumber/type diff --git a/img/app/default.nix b/img/app/default.nix index a196205..32ddb67 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -8,7 +8,7 @@ pkgsStatic.callPackage ( { lib, stdenvNoCC, runCommand, writeClosure , erofs-utils, jq, s6-rc, util-linux , busybox, cacert, dejavu_fonts, execline, kmod, linux_latest, mdevd, s6 -, s6-linux-init, xdg-desktop-portal-spectrum, +, s6-linux-init, xdg-desktop-portal-spectrum }: let @@ -48,6 +48,9 @@ let pkgs.xwayland pkgs.xdg-desktop-portal pkgs.xdg-desktop-portal-gtk + # Depends on pulseaudio libs + pkgs.pipewire + pkgs.wireplumber ]; })).fhsenv; in diff --git a/img/app/etc/fstab b/img/app/etc/fstab index a95088b..40aa3bd 100644 --- a/img/app/etc/fstab +++ b/img/app/etc/fstab @@ -1,7 +1,8 @@ # SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: 2020-2022 Alyssa Ross <hi(a)alyssa.is> proc /proc proc defaults 0 0 -devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 +devpts /dev/pts devpts defaults,gid=4,mode=620 0 0 tmpfs /dev/shm tmpfs defaults 0 0 sysfs /sys sysfs defaults 0 0 -tmpfs /tmp tmpfs defaults 0 0 +tmpfs /tmp tmpfs defaults,mode=1755 0 0 +tmpfs /run tmpfs defaults 0 0 diff --git a/img/app/etc/s6-rc/app/dependencies.d/wireplumber b/img/app/etc/s6-rc/app/dependencies.d/wireplumber new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/directories/type b/img/app/etc/s6-rc/directories/type new file mode 100644 index 0000000..bdd22a1 --- /dev/null +++ b/img/app/etc/s6-rc/directories/type @@ -0,0 +1 @@ +oneshot diff --git a/img/app/etc/s6-rc/directories/up b/img/app/etc/s6-rc/directories/up new file mode 100644 index 0000000..2396fad --- /dev/null +++ b/img/app/etc/s6-rc/directories/up @@ -0,0 +1,11 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# +# Directory creation (if it's copyrightable): +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Unikie + +if { mkdir -m 1755 /tmp/.X11-unix } +if { mkdir -m 0755 /run/user } +if { mkdir -m 0700 /run/user/0 } diff --git a/img/app/etc/s6-rc/pipewire/dependencies.d/directories b/img/app/etc/s6-rc/pipewire/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/pipewire/notification-fd b/img/app/etc/s6-rc/pipewire/notification-fd new file mode 100644 index 0000000..7ed6ff8 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/notification-fd @@ -0,0 +1 @@ +5 diff --git a/img/app/etc/s6-rc/pipewire/run b/img/app/etc/s6-rc/pipewire/run new file mode 100644 index 0000000..c0b55a1 --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/run @@ -0,0 +1,20 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0 +fdmove -c 3 0 + +s6-ipcserver-socketbinder -B /run/user/0/pipewire-0-manager +fdmove -c 4 0 + +redirfd -r 0 /dev/null + +# Notify readiness. +if { fdmove 1 5 echo } +fdclose 5 + +export LISTEN_FDS 2 +getpid LISTEN_PID +pipewire diff --git a/img/app/etc/s6-rc/pipewire/type b/img/app/etc/s6-rc/pipewire/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/pipewire/type @@ -0,0 +1 @@ +longrun diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories b/img/app/etc/s6-rc/wayland-proxy-virtwl/dependencies.d/directories new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wayland-proxy-virtwl/run b/img/app/etc/s6-rc/wayland-proxy-virtwl/run index 7b80343..c1e0e08 100755 --- a/img/app/etc/s6-rc/wayland-proxy-virtwl/run +++ b/img/app/etc/s6-rc/wayland-proxy-virtwl/run @@ -1,17 +1,6 @@ #!/bin/execlineb -P # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> -# -# Directory creation (if it's copyrightable): -# SPDX-License-Identifier: MIT -# SPDX-FileCopyrightText: 2022 Unikie - -foreground { mkdir /tmp/.X11-unix } -foreground { mkdir /run/user } -foreground { - umask 077 - mkdir /run/user/0 -} s6-ipcserver-socketbinder -B /run/user/0/wayland-0 fdmove -c 3 0 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus b/img/app/etc/s6-rc/wireplumber/dependencies.d/dbus new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire b/img/app/etc/s6-rc/wireplumber/dependencies.d/pipewire new file mode 100644 index 0000000..e69de29 diff --git a/img/app/etc/s6-rc/wireplumber/run b/img/app/etc/s6-rc/wireplumber/run new file mode 100644 index 0000000..6d6a549 --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/run @@ -0,0 +1,16 @@ +#!/bin/execlineb -P +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2023-2024 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +# +# Directory creation (if it's copyrightable): +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Unikie + +foreground { mkdir /tmp/.X11-unix } +foreground { mkdir /run/user } +foreground { + umask 077 + mkdir /run/user/0 +} + diff --git a/img/app/etc/s6-rc/wireplumber/type b/img/app/etc/s6-rc/wireplumber/type new file mode 100644 index 0000000..5883cff --- /dev/null +++ b/img/app/etc/s6-rc/wireplumber/type @@ -0,0 +1 @@ +longrun -- Sincerely, Demi Marie Obenour (she/her/hers)

1 0

Virtio interrupt remapping
by Demi Marie Obenour 16 Jun '25

16 Jun '25

I’m working on virtio-IOMMU interrupt remapping for Spectrum OS [1], and am running into a problem. All of the current interrupt remapping drivers use __init code during initialization, and I’m not sure how to plumb the struct virtio_device * into the IOMMU initialization code. What is the proper way to do this, where “proper” means that it doesn’t do something disgusting like “stuff the virtio device in a global variable”? -- Sincerely, Demi Marie Obenour (she/her/hers)

3 4

Verified boot and filesystem choices
by Demi Marie Obenour 15 Jun '25

15 Jun '25

Bcachefs is not very stable right now, and BTRFS is not a good choice from a verified boot perspective. f2fs is what is used in Android and ext4 is used in Chromebooks, so they at least have the backing of Google's security team when it comes to vulnerabilities involving maliciously crafted filesystem images. BTRFS doesn't. The reason this matters for Spectrum is that verified boot aims to prevent system compromise from persisting across reboots, and an attacker who has compromised a Spectrum system can craft whatever image they want on the writable volume. Would it make sense to use f2fs or ext4? That means no reflinks and no snapshots, which would be annoying at least. Another option might be to use FUSE for the writable volume, with kernel filesystems only used for the (signed and dm-verity protected) root volume. This is the only option supported by Linux's upstream maintainers, who (with the notable exception of Kent Overstreet) appear to have no interest in hardening filesystems against maliciously crafted images. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 4

[PATCH] vm: link /sbin to /usr/bin
by Alyssa Ross 09 Jun '25

09 Jun '25

This is necessary because the kernel tries to load modules by running /sbin/modprobe. This should fix Intel wireless cards in netvm. It's then important to disable Busybox init because /sbin/init takes precedence over our /etc/init. Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- img/app/Makefile | 2 +- img/app/default.nix | 1 + img/app/sbin | 1 + vm/sys/net/Makefile | 2 +- vm/sys/net/default.nix | 1 + vm/sys/net/sbin | 1 + 6 files changed, 6 insertions(+), 2 deletions(-) create mode 120000 img/app/sbin create mode 120000 vm/sys/net/sbin diff --git a/img/app/Makefile b/img/app/Makefile index 5ea023e..c827fd3 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -60,7 +60,7 @@ VM_FIFOS = etc/s6-linux-init/run-image/service/s6-linux-init-shutdownd/fifo # These are separate because they need to be included, but putting # them as make dependencies would confuse make. -VM_LINKS = bin etc/ssl/certs/ca-certificates.crt +VM_LINKS = bin etc/ssl/certs/ca-certificates.crt sbin VM_BUILD_FILES = build/etc/s6-rc diff --git a/img/app/default.nix b/img/app/default.nix index 6e423f6..a196205 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -24,6 +24,7 @@ let CONFIG_FEATURE_IP_ADDRESS y CONFIG_FEATURE_IP_LINK y CONFIG_FEATURE_IP_ROUTE y + CONFIG_INIT n CONFIG_IP y ''; }) diff --git a/img/app/sbin b/img/app/sbin new file mode 120000 index 0000000..1e881ed --- /dev/null +++ b/img/app/sbin @@ -0,0 +1 @@ +usr/bin \ No newline at end of file diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 35da669..436ca6e 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -43,7 +43,7 @@ VM_DIRS = dev etc/s6-linux-init/env run proc sys var/lib/connman # These are separate because they need to be included, but putting # them as make dependencies would confuse make. -VM_LINKS = bin lib var/run +VM_LINKS = bin lib sbin var/run VM_BUILD_FILES = build/etc/s6-rc diff --git a/vm/sys/net/default.nix b/vm/sys/net/default.nix index 69f9564..b5873eb 100644 --- a/vm/sys/net/default.nix +++ b/vm/sys/net/default.nix @@ -22,6 +22,7 @@ let (busybox.override { extraConfig = '' CONFIG_DEPMOD n + CONFIG_INIT n CONFIG_INSMOD n CONFIG_LSMOD n CONFIG_MODINFO n diff --git a/vm/sys/net/sbin b/vm/sys/net/sbin new file mode 120000 index 0000000..1e881ed --- /dev/null +++ b/vm/sys/net/sbin @@ -0,0 +1 @@ +usr/bin \ No newline at end of file base-commit: b5dab0eea25e24531ac856985b8f79ef38c06366 -- 2.49.0

3 4

Camera virtualization in Spectrum
by Demi Marie Obenour 05 Jun '25

05 Jun '25

Alyssa and I discussed several designs for camera support in Spectrum. These included: - USB passthrough - virtio-media - v4l2loopback and a guest agent A custom PipeWire plugin in the guest is also an option. USB passthrough has serious security problems: the guest can perform actions like updating device firmware, and the guest also fully trusts the device. This means that it is only suitable for trusted guests operating on trusted devices, which is less than great. v4l2loopback is an ugly hack and neither Alyssa or I like it, so I don’t think it is going to be the approach taken. It has the advantage of being fairly easy to implement and not requiring any device emulation, which is why Qubes OS went this route, but Spectrum has infrastructure for implementing complex virtio devices in a reasonably secure way, thanks to using Rust rather than C for this. This leaves virtio-media and a fully custom solution based on PipeWire. During the discussion, the possibility of hardening virtio-media against a malicious device was considered. After the call, however, I found out that while hardening the kernel side is definitely possible, it is also insufficient. The reason is that virtio-media, as currently implemented, appears to be effectively V4L2 API passthrough, which would mean that the device can respond to V4L2 IOCTLs however it wants. Guest userspace will almost certainly treat V4L2 IOCTL outputs as trusted, so hardening the guest kernel would be of only limited value. Adding validation in the guest kernel driver would be an option, but it would add substantial complexity. Instead, I think it is necessary to add a media server. This server would expose a virtio-media output device to the VM with the camera, and would expose a virtio-media capture device to all VMs on the system, not just those authorized to receive video. This is because camera hotplug is not properly handled by at least Google Chrome, so I expect other applications to also mishandle it. Instead, a VM that does not have camera permission can be given a camera that always records black, as if the user had covered the camera. PipeWire is the only existing implementation of a media server I know of that allows custom media devices to be implemented out-of-process, so it is the best choice I know of. PipeWire is also considered the future by the entire Linux desktop community. One other factor that I did not consider at all during the discussion is the need to implement the XDG microphone and camera portals. These portals are based on PipeWire, and PipeWire cannot be directly used across VMs. This is partially because of security, but it is also because PipeWire relies on SCM_RIGHTS file descriptor passing, eventfds, and other Linux kernel APIs that do not work across the VM boundary. Therefore, it is necessary to either run PipeWire in the guest, or run a daemon in the guest that exposes the same interface PipeWire does. All portals supported in Spectrum that prompt the user require a Spectrum-specific implementation so that the prompt happens on the host. Are there any better options? This is *an* approach, which does not mean it is *the best* approach. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 2

This Week in Spectrum, 2025-W22
by Alyssa Ross 02 Jun '25

02 Jun '25

This week I was once again mostly preoccupied with arranging continuing funding. If approved, this will be the biggest funding allocation Spectrum has ever had, but with that comes a corresponding increase in the work required to make it happen. I also spent some time fixing Nixpkgs build issues that would affect Spectrum in future. That doesn't mean there hasn't been any exciting Spectrum work this week, though. Demi, whose name you may recognize from her extensive past work on Qubes OS, submitted a patch to the VIRTIO specification to add interrupt remapping capabilities to virtio-iommu on x86_64. This is an important requirement for being able to move implementations of virtual devices into their own VMs, which will in turn enable running hardware drivers in VMs rather than on the host, and it has been a longstanding wish list item in Spectrum's upcoming projects list[1]. It's very exciting to have somebody as knowledgeable as Demi working towards Spectrum's goals. [1]: https://pad.lassul.us/s/mDfFPvHjA#Cloud-Hypervisor-support-interrupt-remapp… BTW: From next week onwards, I think I'll start sending these updates only to discuss@, not devel@, because I don't think it makes sense to duplicate them.

1 0

[PATCH] Add interrupt remapping support
by Demi Marie Obenour 30 May '25

30 May '25

This adds interrupt remapping to the virtio-IOMMU device. This is needed to support deprivileged userspace drivers on x86_64 and other platforms where interrupt remapping is the job of the IOMMU. It is not needed on AArch64 and must not be supported on that platform. --- device-types/iommu/description.tex | 70 +++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) diff --git a/device-types/iommu/description.tex b/device-types/iommu/description.tex index f8cbe88..0a3bcab 100644 --- a/device-types/iommu/description.tex +++ b/device-types/iommu/description.tex @@ -3,7 +3,8 @@ \section{IOMMU device}\label{sec:Device Types / IOMMU Device} The virtio-iommu device manages Direct Memory Access (DMA) from one or more endpoints. It may act both as a proxy for physical IOMMUs managing devices assigned to the guest, and as virtual IOMMU managing emulated and -paravirtualized devices. +paravirtualized devices. On some platforms, it is also responsible for +interrupt remapping. The driver first discovers endpoints managed by the virtio-iommu device using platform specific mechanisms. It then sends requests to create @@ -74,6 +75,13 @@ \subsection{Feature bits}\label{sec:Device Types / IOMMU Device / Feature bits} whether endpoints that are attached to a domain are in bypass mode. +\item[VIRTIO_IOMMU_F_IRQ_MAP_UNMAP (7)] + Interrupt remapping is available. This is architecture specific + and MUST NOT be negotiated on architectures such as AArch64 where + interrupt remapping is not handled by the IOMMU. If this feature + is negotiated, all interrupts from endpoints that are not in + bypass mode are initially disabled. + \end{description} \drivernormative{\subsubsection}{Feature bits}{Device Types / IOMMU Device / Feature bits} @@ -531,6 +539,66 @@ \subsubsection{MAP request}\label{sec:Device Types / IOMMU Device / Device opera range mapped with VIRTIO_IOMMU_MAP_F_WRITE but not VIRTIO_IOMMU_MAP_F_READ. +\subsubsection{IRQ MAP request}\label{sec:Device Types / IOMMU Device / Device operations / IRQ MAP request} + +\begin{lstlisting} +struct virtio_iommu_req_irq_map { + struct virtio_iommu_req_head head; + le32 domain; + le64 msi_address; + le32 msi_payload; + le32 vector_id; + le32 vcpu_id; + le32 flags; + u8 reserved[4]; + struct virtio_iommu_req_tail tail; +}; +\end{lstlisting} + +Map a host MSI to a guest MSI directed at the given vCPU. vCPUs range from 0 to +$2^{32} - 2$ inclusive. $2^{32} - 1$ is reserved and means ``no vCPU'', +effectively disabling the interrupt. Any previous mapping of the MSI is overwritten. + +This request takes effect immediately. It is the device's job to flush caches if +necessary. However, any interrupts that are pending remain pending. + +The set of permitted values for \field{msi_address} and \field{msi_payload} +is architecture-dependent. Invalid values include, but are not limited to: + +\begin{itemize} +\item Values that are not in the architecture-dependent range of MSI addresses. +\item Values that have bits set that are ignored by the physical IOMMU. +\item Values that have reserved bits set. +\item Values that would cause the MSI to not be subject to interrupt remapping, + and which the host must therefore block for its own security. +\end{itemize} + +This request is only available when VIRTIO_IOMMU_F_IRQ_MAP_UNMAP has been negotiated. + +\drivernormative{\paragraph}{IRQ MAP request}{Device Types / IOMMU Device / Device operations / IRQ MAP request} + +The driver SHOULD set undefined \field{flags} bits to zero. + +The driver SHOULD NOT send IRQ MAP requests on a bypass domain. + +The driver SHOULD NOT choose values for \field{msi_address} or \field{msi_payload} +that are invalid for the CPU architecture. + +The driver SHOULD NOT choose a \field{vcpu_id} that corresponds to a vCPU that does +not exist and is not $2^{32} - 1$. + +\devicenormative{\paragraph}{IRQ MAP request}{Device Types / IOMMU Device / Device operations / IRQ MAP request} + +If \field{msi_address} or \field{msi_payload} is invalid for the CPU architecture, +the device SHOULD reject the request and set \field{status} to VIRTIO_IOMMU_S_INVAL. + +If \field{domain} does not exist, the device SHOULD reject the request and +set \field{status} to VIRTIO_IOMMU_S_NOENT. + +If \field{vcpu_id} does not correspond to a CPU that is running in the guest +and is not $2^{32} - 1$, the device SHOULD reject the request and set +\field{status} to VIRTIO_IOMMU_S_NOENT. + \subsubsection{UNMAP request}\label{sec:Device Types / IOMMU Device / Device operations / UNMAP request} \begin{lstlisting} -- Sincerely, Demi Marie Obenour

1 0

This Week in Spectrum, 2025-W21
by Alyssa Ross 25 May '25

25 May '25

Not too much to report this week. I spent most of the week either continuing with my recovery (this was a substantial fraction), or continuing work on future funding — hopefully I'll have good news to share about this at some point. I did update Cloud Hypervisor in Nixpkgs and release new a version of Spectrum's virtio-gpu patches for it. The good news is I'm now basically fully recovered, so should be back to normal from here on, once I've finished getting through the backlog of email. Until next week!

1 0

This Week in Spectrum, 2025-W20
by Alyssa Ross 18 May '25

18 May '25

I'm still recovering, and it's rough. There are some small signs of progress but it's a bit two steps forward, one step back. But here's what I managed to do this week in spite of things: • Updated[1] the binary cache builder scripts for Scaleway's block storage API migration. (The old one no longer works.) • Finished the networking test[2] I mentioned a couple of updates ago. • Deployed Anubis[3] on https://spectrum-os.org/git/ to stop the server being overloaded by AI scrapers. I'm unhappy it's come to this, but it made me feel better to realise it only activates on things that look like graphical web browsers, so curl, lynx, etc. still get through fine. • Dropped the hack[4] Spectrum had for loading device trees on aarch64 where they were spread across more than a dozen UKI extensions, thanks to systemd having dropped the limit of how many each UKI could include after I brought it up[5]. • Tested and merged a crosvm update in Nixpkgs[6]. • Finished some work to support encrypted user data partitions. This was a big blocker preventing Spectrum being really useful for anything. Currently, partitions have to be manually mounted on the command line, but I could imagine there being a nice GUI for this that runs on boot, a bit like what Tails has, since the OS itself doesn't have to be encrypted. • Discovered that the main blocker I knew about for building Spectrum for RISC-V had been resolved, so did some very early work for having Nixpkgs support RISC-V musl builds[7][8][9]. This one was a bit of a happy accident of my surgery recovery — I only tried it again on a lark because I wasn't well enough at the time to do anything else, and then made the happy discovery. Probably won't pursue this any more for a while, because apart from anything else obtaining RISC-V hardware at the moment isn't easy, but it's nice to know it's now theoretically possible. • Demi Marie Obenour helped me figure out that passthrough of Wi-Fi devices to VMs was not broken for complicated reasons to do with Cloud Hypervisor's VFIO implementation like I thought, but for simpler reasons: passthrough to a Fedora VM works, so it must just be some sort of misconfiguration in the Spectrum VM that should be relatively straightforward to narrow down and fix. I had tried to test passthrough to other guest OSes before, but since then I discovered that my main laptop has a faulty Wi-Fi card, so I suspect that produced confusing results that made me think it was something more complicated. • Continued work on arranging future funding for Spectrum. [1]: https://spectrum-os.org/git/infra/commit/?id=df2824a8e19c16a27adb951f664a53… [2]: https://spectrum-os.org/git/spectrum/tree/release/checks/networking?id=879b… [3]: https://anubis.techaro.lol/ [4]: https://spectrum-os.org/git/spectrum/commit/?id=e06b57f4fefc834f4868540a53d… [5]: https://github.com/systemd/systemd/commit/8c5b359579b0f1029edafb0bd96b5ebfb… [6]: https://github.com/NixOS/nixpkgs/pull/408305 [7]: https://github.com/NixOS/nixpkgs/pull/406797 [8]: https://github.com/NixOS/nixpkgs/pull/406966 [9]: https://github.com/NixOS/nixpkgs/pull/406996 Looking back at that list now, I'm pretty happy! Even though I was struggling for a lot of the week that's not too bad overall. Maybe I'm even happy enough with it that I feel justified including this bit again for the first time since the surgery: As a reminder, you can support my work by donating to Spectrum's development through GitHub Sponsors[10] or Liberapay[11]. This helps a lot, especially with ongoing maintenance (usually fixing upstream bugs etc.) that is difficult to fund via a grant. [10]: https://github.com/sponsors/alyssais/ [11]: https://liberapay.com/qyliss Until next week!

1 0

This Week in Spectrum, 2025-W19
by Alyssa Ross 11 May '25

11 May '25

Sadly this week has mostly been a continuation of the last — I'm still recovering from dental surgery. I spent the early part of the week in too much pain to think about much else, and the later part of the week in less pain but now struggling with side effects from painkillers. From what I understand there's not anything to worry about, but I've hit some bad luck and ended up with much worse and longer lasting pain than would usually be expected from this. So this isn't going to be the type of comprehensive report I'd like to be sending out every week, but I'll list some things I have been able to get done in those moments where I've been able to focus. • Updated Spectrum's pinned Nixpkgs and made some small improvements (mostly not committed yet) as a result of improvements in updated packages. • Got the automated test I was working on to the point where it's actually testing something useful — that networking works. Still want to polish it a bit more when I can focus better before I commit it. • Made a release of the Cloud Hypervisor virtio-gpu patches[1]. • Some long overdue work on the server that among other things hosts the Spectrum website, git repos, etc. • Reported a GTK regression that has made testing Spectrum very annoying for the last few months[2]. • Tested a crosvm update in Nixpkgs. • Worked on arranging continuing funding for Spectrum. [1]: https://spectrum-os.org/lists/archives/spectrum-discuss/877c2owzjl.fsf@alys… [2]: https://gitlab.gnome.org/GNOME/gtk/-/issues/7544 Most of this stuff has been in the last 2-3 days, so hopefully I'm on a good trajectory, but I don't know how long it's going to be before I'm back to normal.

1 0

This Week in Spectrum, 2025-W18
by Alyssa Ross 04 May '25

04 May '25

This week started off well — I was continuing working on the automated test I mentioned last week — but then I had two wisdom teeth removed and recovery has been hellish. So not much to report. I've fixed a couple of Nixpkgs things where I could but mostly I've been out of action. The other two are going to need to be removed sometime in the near future too… But hey, at least I've achieved my goal of a concise update!

1 0

This Week in Spectrum, 2025-W17
by Alyssa Ross 27 Apr '25

27 Apr '25

Apparently the last time I wrote an update like this was 2021-08-22[1]. Recently I've been missing them a lot, because I don't think it's ever been as easy to keep up with the progress being made as when I wrote weekly updates. Hopefully this time I can avoid going into quite the same level of detail, so they're more sustainable to keep writing. [1]: https://spectrum-os.org/lists/archives/spectrum-discuss/20210822213036.6lx5… So, here's what I did this week: Automated testing ----------------- For a long time I've had a branch on my computer that makes some significant changes to how networking in Spectrum works to try to resolve a longstanding race condition when starting VMs. I've found it difficult to work on, because it's hard for me to be confident when changing things around that I'm not going to subtly break something in a different way. It's been clear to me for a long time that the obvious answer to this is automated tests, but how they should work was a lot less clear. I'd like to avoid having to make a special testable version of the system, because I want to be testing the real thing. The aarch64 port I completed early this year has helped make the system just a bit more flexible, and a couple of weeks ago it clicked for me that perhaps it's time to make a serious attempt at this. So far, I have a program that starts Spectrum in QEMU. This is an unmodified Spectrum image, but the test uses systemd-stub's support for appending to the kernel command line via through SMBIOS Type 11 strings[2] to configure an extra serial console, which it then communicates with over a socket. Because this console was configured on the kernel command line, it has kernel logs printed to it, which could make trying to read command output from it messy. To work around that, the only interaction the test has with this console is to write a command into it to start a shell on a second serial console that isn't a destination for kernel logs, and then further interaction happens via that second console. (I tried lowering the kernel loglevel, but it seems some messages come through even when it's set to zero.) The test program then uses the Spectrum host shell to mount a filesystem on an attached disk image containing a custom VM configuration, import that VM, and run it. The VM just runs netcat to try to connect a server running on the host via the test program. If the host receives that connection, the test will pass, and once I have that working I can expand the test to make sure that it keeps working after restarting the different VMs involved. What's still to do is getting that server bit right — originally I planned to use QEMU's guestfwd[3] feature to forward connections to a specific IP address and port to an AF_UNIX socket, but that been broken for a long time[4], so instead I'll just use an AF_INET socket on the host. Since it has to be a non-loopback address, I also want the test to run itself in a network namespace so I'm not interfering with networking on the machine running it. Nothing that should be especially difficult. An early experiment with this led me to discover that Python's built-in socket library didn't expose the IP_FREEBIND socket option, so I sent a quick PR to do that[5], which was merged. [2]: https://www.freedesktop.org/software/systemd/man/latest/systemd-stub.html#S… [3]: https://www.qemu.org/docs/master/system/invocation.html#hxtool-5 [4]: https://gitlab.com/qemu-project/qemu/-/issues/1835 [5]: https://github.com/python/cpython/pull/132998 User-mode networking for development ------------------------------------ When developing the built-in Spectrum VMs, I run them directly on my NixOS development system. For the router VM in particular, it's important to test that it still connects to the network. Until now, that's only been possible with QEMU, which has built-in slirp-based user-mode networking — other VMMs would require privileged operations on the development system to have working networking, and it's important to me that the Spectrum development environment does not require special privileges. While I was working on the test and investigating QEMU's guestfwd feature, I discovered that there's a new option for user-mode networking: passt[6][7]. passt runs outside the VMM process, and implements a vhost-user interface, meaning that it should be possible to use from any VMM. I've changed the Spectrum development environment to use it when running VMs in Cloud Hypervisor[8], and also to run the router VM in Cloud Hypervisor by default[9], which means it's now easier to test that VM during development in an environment much more similar to the one it will ultimately run in as part of the Spectrum system. I also tried using passt with crosvm, but it didn't work due to crosvm's slightly strange interpretation of the vhost-user protocol. I sent a couple of patches[10][11] to crosvm to fix the incompatibility, which haven't been accepted yet but have prompted things to move in the right direction. I also sent a patch to passt itself to make it easier to use with an inetd/UCSPI-style super-server like s6-ipcserver, but a day later it still hasn't appeared in their list archive so I think it's probably waiting for somebody to find it in the list spam filter. [6]: https://passt.top/ [7]: https://www.qemu.org/docs/master/system/devices/net.html#using-passt-as-the… [8]: https://spectrum-os.org/git/spectrum/commit/?id=aac74f6165740a6b041a7205ec8… [9]: https://spectrum-os.org/git/spectrum/commit/?id=ca10038c080f396a6cf2649b726… [10]: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/6491650 [11]: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/6491651 Nixpkgs ------- I contributed a few fixes for build regressions that would get in the way of updating Spectrum's pinned Nixpkgs[12][13][14], and I also added debug symbols to the passt package[15]. [12]: https://github.com/NixOS/nixpkgs/pull/401563 [13]: https://github.com/NixOS/nixpkgs/pull/402027 [14]: https://github.com/NixOS/nixpkgs/pull/402055 [15]: https://github.com/NixOS/nixpkgs/pull/401971 That's it for this week. I'm at just over a thousand words, which is more than I was aiming for but better than I remember a lot of the past weekly updates being. Hopefully I'll be back with another update next week. As a reminder, you can support my work by donating to Spectrum's development through GitHub Sponsors[16] or Liberapay[17]. This helps a lot, especially with ongoing maintenance (usually fixing upstream bugs etc.) that is difficult to fund via a grant. [16]: https://github.com/sponsors/alyssais/ [17]: https://liberapay.com/qyliss

1 0

[PATCH www] Fix typo
by Jay Langford 24 Apr '25

24 Apr '25

Signed-off-by: Jay Langford <jay(a)jaylangford.net> --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 9a7d02e..cb96838 100644 --- a/index.html +++ b/index.html @@ -38,7 +38,7 @@ machines. <p> Spectrum is an upstream-first project. Wherever possible, we aim to participate in cross-project collaboration to move the entire free -desktop ecosystem forward, rather than desgining Spectrum-specific +desktop ecosystem forward, rather than designing Spectrum-specific solutions. This reduces the amount of software that Spectrum as a small project is solely responsible for maintaining, and it derisks the project — even if Spectrum does not achieve all its goals, our -- 2.39.3 (Apple Git-145)

2 2

[PATCH v3] img/app: add dejavu_fonts pkg and fontconfig file
by Samy Lahfa 01 Mar '25

01 Mar '25

Spam detection software, running on the system "atuin.qyliss.net", has identified this incoming email as possible spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: Signed-off-by: Samy Lahfa <samy%2Bspectrum(a)lahfa.xyz> This fixes the foot terminal app-vm by adding dejavu_fonts package to the nix store as well as adding the fontconfig file, so it knows which default font to use. --- img/app/Makefile | 2 ++ img/app/de [...] Content analysis details: (5.7 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid 2.0 PDS_OTHER_BAD_TLD Untrustworthy TLDs [URI: lahfa.xyz (xyz)] 2.0 FROM_SUSPICIOUS_NTLD_FP From abused NTLD 0.5 FROM_SUSPICIOUS_NTLD From abused NTLD 1.3 RDNS_NONE Delivered to internal network by a host with no rDNS -0.0 DMARC_PASS DMARC pass policy

3 2

[PATCH v2] img/app: add dejavu_fonts pkg and fontconfig file
by Samy Lahfa 20 Feb '25

20 Feb '25

Signed-off-by: Samy Lahfa <samy%2Bspectrum(a)lahfa.xyz> --- This fixes the foot terminal app-vm by adding dejavu_fonts package to the nix store as well as adding the fontconfig file, so it knows which default font to use. img/app/Makefile | 2 ++ img/app/default.nix | 3 ++- img/app/etc/fonts/fonts.conf | 21 +++++++++++++++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 img/app/etc/fonts/fonts.conf diff --git a/img/app/Makefile b/img/app/Makefile index 7887aa8..eeb17fa 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -30,6 +30,7 @@ $(imgdir)/appvm/blk/root.img: ../../scripts/make-gpt.sh ../../scripts/sfdisk-fie VM_FILES = \ etc/dbus-1/session.conf \ + etc/fonts/fonts.conf \ etc/fstab \ etc/init \ etc/mdev.conf \ @@ -52,6 +53,7 @@ VM_FILES = \ etc/s6-linux-init/scripts/rc.shutdown \ etc/s6-linux-init/scripts/rc.shutdown.final \ etc/xdg/xdg-desktop-portal/portals.conf + VM_DIRS = dev run proc sys tmp \ etc/s6-linux-init/run-image/service VM_FIFOS = etc/s6-linux-init/run-image/service/s6-linux-init-shutdownd/fifo diff --git a/img/app/default.nix b/img/app/default.nix index 6537fb2..5b58a5f 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -8,7 +8,7 @@ pkgsStatic.callPackage ( { lib, stdenvNoCC, runCommand, writeClosure , erofs-utils, jq, s6-rc, util-linux , busybox, cacert, execline, kmod, linux_latest, mdevd, s6, s6-linux-init -, xdg-desktop-portal-spectrum +, xdg-desktop-portal-spectrum, dejavu_fonts, }: let @@ -37,6 +37,7 @@ let s6-rc terminfo xdg-desktop-portal-spectrum + dejavu_fonts # Some packages can't (currently?) be built statically. diff --git a/img/app/etc/fonts/fonts.conf b/img/app/etc/fonts/fonts.conf new file mode 100644 index 0000000..0dcde54 --- /dev/null +++ b/img/app/etc/fonts/fonts.conf @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd"> +<fontconfig> + <alias binding="same"> + <family>monospace</family> + <prefer> + <family>DejaVu Sans Mono</family> + </prefer> + </alias> + + <alias binding="same"> + <family>sans-serif</family> + <prefer> + <family>DejaVu Sans</family> + </prefer> + </alias> + + <dir>/usr/share/fonts</dir> +</fontconfig> -- 2.47.2

3 5

[PATCH] fix(foot-vm): add dejavu_fonts and fontconfig
by Samy Lahfa 30 Jan '25

30 Jan '25

Signed-off-by: Samy Lahfa <samy%2Bspectrum(a)lahfa.xyz> --- img/app/Makefile | 3 ++- img/app/default.nix | 1 + img/app/etc/fonts/fonts.conf | 21 +++++++++++++++++++++ 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 img/app/etc/fonts/fonts.conf diff --git a/img/app/Makefile b/img/app/Makefile index 7887aa8..8bfb7a1 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -51,7 +51,8 @@ VM_FILES = \ etc/s6-linux-init/scripts/rc.init \ etc/s6-linux-init/scripts/rc.shutdown \ etc/s6-linux-init/scripts/rc.shutdown.final \ - etc/xdg/xdg-desktop-portal/portals.conf + etc/xdg/xdg-desktop-portal/portals.conf \ + etc/fonts/fonts.conf VM_DIRS = dev run proc sys tmp \ etc/s6-linux-init/run-image/service VM_FIFOS = etc/s6-linux-init/run-image/service/s6-linux-init-shutdownd/fifo diff --git a/img/app/default.nix b/img/app/default.nix index 6537fb2..fc2af0e 100644 --- a/img/app/default.nix +++ b/img/app/default.nix @@ -37,6 +37,7 @@ let s6-rc terminfo xdg-desktop-portal-spectrum + pkgs.dejavu_fonts # Some packages can't (currently?) be built statically. diff --git a/img/app/etc/fonts/fonts.conf b/img/app/etc/fonts/fonts.conf new file mode 100644 index 0000000..0dcde54 --- /dev/null +++ b/img/app/etc/fonts/fonts.conf @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> + + +<!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd"> +<fontconfig> + <alias binding="same"> + <family>monospace</family> + <prefer> + <family>DejaVu Sans Mono</family> + </prefer> + </alias> + + <alias binding="same"> + <family>sans-serif</family> + <prefer> + <family>DejaVu Sans</family> + </prefer> + </alias> + + <dir>/usr/share/fonts</dir> +</fontconfig> -- 2.47.2

3 2

[PATCH] release/combined: fix for __structuredAttrs
by Alyssa Ross 30 Nov '24

30 Nov '24

When I set __structuredAttrs for this derivation, these variables were no longer passed to the build, resulting in GRUB not getting installed properly. Fixes: 296ccff ("Build images with __structuredAttrs") Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- release/combined/default.nix | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/release/combined/default.nix b/release/combined/default.nix index 764e2c3..537c5ef 100644 --- a/release/combined/default.nix +++ b/release/combined/default.nix @@ -60,15 +60,22 @@ let esp = runCommand "esp.img" { nativeBuildInputs = [ grub libfaketime dosfstools mtools ]; - grubTargetDir = "${grub}/lib/grub/${grub.grubTarget}"; - # Definition copied from util/grub-install-common.c. - # Last checked: GRUB 2.06 - pkglib_DATA = [ - "efiemu32.o" "efiemu64.o" "moddep.lst" "command.lst" "fs.lst" "partmap.lst" - "parttool.lst" "video.lst" "crypto.lst" "terminal.lst" "modinfo.sh" - ]; + + env = { + grubTargetDir = "${grub}/lib/grub/${grub.grubTarget}"; + # Definition copied from util/grub-install-common.c. + # Last checked: GRUB 2.06 + pkglib_DATA = lib.escapeShellArgs [ + "efiemu32.o" "efiemu64.o" "moddep.lst" "command.lst" "fs.lst" + "partmap.lst" "parttool.lst" "video.lst" "crypto.lst" "terminal.lst" + "modinfo.sh" + ]; + }; + __structuredAttrs = true; + unsafeDiscardReferences = { out = true; }; + passthru = { inherit grubCfg; }; } '' truncate -s 15M $out base-commit: 741ed49303ffaba63c409962326ab447639e6e20 -- 2.47.0

1 0

[PATCH v1] crosvm: Rename `--vhost-user-gpu` flag in checks
by Dom Rodriguez 12 Nov '24

12 Nov '24

Following on from c9052a4, Alyssa quite rightly pointed out the remaining `--vhost-user-gpu` invocation in the release checks (Wayland). Same principle as c9052a4, just one more replacement to the crosvm flag. Signed-off-by: Dom Rodriguez <shymega(a)shymega.org.uk> --- release/checks/wayland/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release/checks/wayland/default.nix b/release/checks/wayland/default.nix index d4806db..083e60d 100644 --- a/release/checks/wayland/default.nix +++ b/release/checks/wayland/default.nix @@ -38,7 +38,7 @@ nixosTest ({ lib, pkgs, ... }: { systemd.services.crosvm = { after = [ "crosvm-gpu.service" "weston.service" ]; requires = [ "crosvm-gpu.service" "weston.service" ]; - serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user-fs /run/virtiofsd.sock,tag=virtiofs0 --vhost-user-gpu /run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; + serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user-fs /run/virtiofsd.sock,tag=virtiofs0 --vhost-user gpu,socket=/run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; serviceConfig.ExecStop = "${lib.getExe pkgs.crosvm} stop /run/crosvm"; }; -- 2.44.2

3 3

[PATCH v2] crosvm: Rename `--vhost-user-{fs,gpu}` args
by Dom Rodriguez 11 Nov '24

11 Nov '24

crosvm was producing warnings when using `--vhost-user-gpu` and `--vhost-user-fs`. In this commit, I have adjusted the `crosvm` invocations to look something like `--vhost-user $DEVICE,socket=$PATH`, where `$DEVICE` is, in this case, `gpu` or `fs`, and `$PATH` is the path to the Unix socket. Signed-off-by: Dom Rodriguez <shymega(a)shymega.org.uk> --- img/app/Makefile | 4 ++-- release/checks/wayland/default.nix | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/img/app/Makefile b/img/app/Makefile index 3adf8c4..11ef6e1 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -152,8 +152,8 @@ run-crosvm: $(imgdir)/appvm/blk/root.img start-vhost-user-gpu start-virtiofsd --disk $(RUN_IMG) \ -p "console=ttyS0 root=PARTLABEL=root" \ --net tap-name=tap0 \ - --vhost-user-fs build/virtiofsd.sock:virtiofs0 \ - --vhost-user-gpu build/vhost-user-gpu.sock \ + --vhost-user fs,socket=build/virtiofsd.sock:virtiofs0 \ + --vhost-user gpu,socket=build/vhost-user-gpu.sock \ --vsock cid=3 \ --serial type=file,hardware=serial,path=build/serial.log \ --serial type=stdout,hardware=virtio-console,stdin=true \ diff --git a/release/checks/wayland/default.nix b/release/checks/wayland/default.nix index d05aa88..a36dbab 100644 --- a/release/checks/wayland/default.nix +++ b/release/checks/wayland/default.nix @@ -29,7 +29,7 @@ nixosTest ({ lib, pkgs, ... }: { systemd.services.crosvm = { after = [ "crosvm-gpu.service" "weston.service" ]; requires = [ "crosvm-gpu.service" "weston.service" ]; - serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img --disk ${run}/blk/run.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user-gpu /run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; + serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img --disk ${run}/blk/run.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user gpu,socket=/run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; serviceConfig.ExecStop = "${lib.getExe pkgs.crosvm} stop /run/crosvm"; }; -- 2.44.1

3 10

[PATCH v4] crosvm: Rename `--vhost-user-gpu` flag
by Dom Rodriguez 11 Nov '24

11 Nov '24

crosvm was producing warnings when using `--vhost-user-gpu` and `--vhost-user-fs`, of which the former is fixable, but the latter requires some more work. The latter will be patched later on. To mitigate the former, I have adjusted the `crosvm` invocations to look something like `--vhost-user $DEVICE,socket=$PATH`, where `$DEVICE` is, in this case, `gpu`, and `$PATH` is the path to the Unix socket. Signed-off-by: Dom Rodriguez <shymega(a)shymega.org.uk> --- The typo gremlins snuck into that last v3 patch, but hopefully v4 will fix it. img/app/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/img/app/Makefile b/img/app/Makefile index 2aa78a0..d914cab 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -168,7 +168,7 @@ run-crosvm: $(imgdir)/appvm/blk/root.img start-vhost-user-gpu start-virtiofsd -p "console=ttyS0 root=PARTLABEL=root" \ --net tap-name=tap0 \ --vhost-user-fs build/virtiofsd.sock:virtiofs0 \ - --vhost-user-gpu build/vhost-user-gpu.sock \ + --vhost-user gpu,socket=build/vhost-user-gpu.sock \ --vsock cid=3 \ --serial type=file,hardware=serial,path=build/serial.log \ --serial type=stdout,hardware=virtio-console,stdin=true \ -- 2.44.1

3 3

[PATCH v3] crosvm: Rename `--vhost-user-gpu` flag
by Dom Rodriguez 09 Nov '24

09 Nov '24

crosvm was producing warnings when using `--vhost-user-gpu` and `--vhost-user-fs`, of which the former is fixable, but the latter requires some more work. The latter will be patched later on. To mitigate the former, I have adjusted the `crosvm` invocations to look something like `--vhost-user $DEVICE,socket=$PATH`, where `$DEVICE` is, in this case, `gpu`, and `$PATH` is the path to the Unix socket. Signed-off-by: Dom Rodriguez <shymega(a)shymega.org.uk> --- img/app/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/img/app/Makefile b/img/app/Makefile index 7c3e3e8..db9fbea 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -167,7 +167,7 @@ run-crosvm: $(imgdir)/appvm/blk/root.img start-vhost-user-gpu start-virtiofsd -p "console=ttyS0 root=PARTLABEL=root" \ --net tap-name=tap0 \ --vhost-user-fs build/virtiofsd.sock:virtiofs0 \ - --vhost-user-gpu build/vhost-user-gpu.sock \ + --vhost-user gpu socket=build/vhost-user-gpu.sock \ --vsock cid=3 \ --serial type=file,hardware=serial,path=build/serial.log \ --serial type=stdout,hardware=virtio-console,stdin=true \ -- 2.44.1

2 2

[PATCH] Documentation: explain Nix using too many cores
by Alyssa Ross 29 Sep '24

29 Sep '24

This is confusing to people, and will be especially so if Spectrum is the first big Nix build they've done, which is not unlikely. Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Documentation/installation/getting-spectrum.adoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc index 3620c79..29803aa 100644 --- a/Documentation/installation/getting-spectrum.adoc +++ b/Documentation/installation/getting-spectrum.adoc @@ -2,7 +2,7 @@ :page-parent: Build and Run :page-nav_order: 2 -// SPDX-FileCopyrightText: 2022-2023 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2022-2024 Alyssa Ross <hi(a)alyssa.is> // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 To get Spectrum, you need to build it from source. As long as you're @@ -16,6 +16,13 @@ TIP: Before you start, consider setting up the xref:binary-cache.adoc[Spectrum binary cache], which will save you a lot of time waiting for builds. +TIP: If you encounter build failures, especially timeouts or +out-of-memory (OOM) kills, Nix might be configured to run too many +builds at once, with too many cores per build. See Nix's +documentation for +https://nix.dev/manual/nix/2.24/advanced-topics/cores-vs-jobs.html[tuning +cores and jobs]. + == Trying Spectrum If you want to try Spectrum out to get a feel for it, without base-commit: 6e9c1f7967a44206e8f70d1d20e0f4e71987bed8 -- 2.45.2

1 0

[PATCH] lib/common.mk: move .POSIX out
by Alyssa Ross 21 Sep '24

21 Sep '24

The standard says the following, so I don't think it's specified that it's allowed to be in an include file: > If it appears as the first non-comment line in the makefile, make > shall process the makefile as specified by this section; otherwise, > the behavior of make is unspecified. Link: https://pubs.opengroup.org/onlinepubs/9799919799/utilities/make.html#tag_20… Fixes: c3fbeca ("lib/common.mk: init") Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- host/initramfs/Makefile | 2 ++ host/rootfs/Makefile | 2 ++ img/app/Makefile | 2 ++ lib/common.mk | 2 -- release/live/Makefile | 2 ++ vm/sys/net/Makefile | 2 ++ 6 files changed, 10 insertions(+), 2 deletions(-) diff --git a/host/initramfs/Makefile b/host/initramfs/Makefile index 06f69b3..8382296 100644 --- a/host/initramfs/Makefile +++ b/host/initramfs/Makefile @@ -1,6 +1,8 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021-2023 Alyssa Ross <hi(a)alyssa.is> +.POSIX: + include ../../lib/common.mk dest = build/initramfs diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index f4fb7a4..2f4445d 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -1,6 +1,8 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021-2024 Alyssa Ross <hi(a)alyssa.is> +.POSIX: + include ../../lib/common.mk dest = build/rootfs.erofs diff --git a/img/app/Makefile b/img/app/Makefile index 3adf8c4..79dd22e 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -2,6 +2,8 @@ # SPDX-FileCopyrightText: 2021-2024 Alyssa Ross <hi(a)alyssa.is> # SPDX-FileCopyrightText: 2022 Unikie +.POSIX: + include ../../lib/common.mk prefix = build/host diff --git a/lib/common.mk b/lib/common.mk index 8f11ecc..7733878 100644 --- a/lib/common.mk +++ b/lib/common.mk @@ -1,8 +1,6 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021, 2023 Alyssa Ross <hi(a)alyssa.is> -.POSIX: - # qemu-kvm is non-standard, but is present in at least Fedora and # Nixpkgs. If you don't have qemu-kvm, you'll need to set e.g. # QEMU_KVM = qemu-system-x86_64 -enable-kvm. diff --git a/release/live/Makefile b/release/live/Makefile index f45870d..a8c81c3 100644 --- a/release/live/Makefile +++ b/release/live/Makefile @@ -1,6 +1,8 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021-2023 Alyssa Ross <hi(a)alyssa.is> +.POSIX: + include ../../lib/common.mk dest = build/live.img diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 00757db..2c2f084 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -1,6 +1,8 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021-2024 Alyssa Ross <hi(a)alyssa.is> +.POSIX: + include ../../../lib/common.mk prefix = build/svc base-commit: 0f5cfe23285d31c3f7ea1d0fbca967fa8bae8d59 -- 2.45.2

2 1

[PATCH] crosvm: Rename `--vhost-user-{fs,gpu}` args
by Dom Rodriguez 21 Sep '24

21 Sep '24

crosvm was producing warnings when using `--vhost-user-gpu` and `--vhost-user-fs`. In this commit, I have adjusted the `crosvm` invocations to look something like `--vhost-user $DEVICE`, where `$DEVICE` is, in this case, `gpu` or `fs`. I have run unit tests, but would appreciate testing. Signed-off-by: Dom Rodriguez <shymega(a)shymega.org.uk> --- img/app/Makefile | 4 ++-- release/checks/wayland/default.nix | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/img/app/Makefile b/img/app/Makefile index 3adf8c4..fd8befe 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -152,8 +152,8 @@ run-crosvm: $(imgdir)/appvm/blk/root.img start-vhost-user-gpu start-virtiofsd --disk $(RUN_IMG) \ -p "console=ttyS0 root=PARTLABEL=root" \ --net tap-name=tap0 \ - --vhost-user-fs build/virtiofsd.sock:virtiofs0 \ - --vhost-user-gpu build/vhost-user-gpu.sock \ + --vhost-user fs build/virtiofsd.sock:virtiofs0 \ + --vhost-user gpu build/vhost-user-gpu.sock \ --vsock cid=3 \ --serial type=file,hardware=serial,path=build/serial.log \ --serial type=stdout,hardware=virtio-console,stdin=true \ diff --git a/release/checks/wayland/default.nix b/release/checks/wayland/default.nix index d05aa88..774c9b9 100644 --- a/release/checks/wayland/default.nix +++ b/release/checks/wayland/default.nix @@ -29,7 +29,7 @@ nixosTest ({ lib, pkgs, ... }: { systemd.services.crosvm = { after = [ "crosvm-gpu.service" "weston.service" ]; requires = [ "crosvm-gpu.service" "weston.service" ]; - serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img --disk ${run}/blk/run.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user-gpu /run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; + serviceConfig.ExecStart = "${lib.getExe pkgs.crosvm} run -s /run/crosvm --disk ${appvm}/img/appvm/blk/root.img --disk ${run}/blk/run.img -p \"console=ttyS0 root=PARTLABEL=root\" --vhost-user gpu /run/crosvm-gpu.sock --vsock cid=3 --serial type=stdout,hardware=virtio-console,stdin=true ${appvm}/img/appvm/vmlinux"; serviceConfig.ExecStop = "${lib.getExe pkgs.crosvm} stop /run/crosvm"; }; -- 2.44.1

2 4

Flake support - what are your thoughts?
by Dom (shymega) Rodriguez 09 Sep '24

09 Sep '24

Hello all! I'm picking up the Flake patch previously posted on this list, and want to get some input from developers & users alike. Do you prefer `nix-shell`/`nix-build` or Flakes? Would you be satisfied if we had compatibility shims for these tools? How do you feel about impure Flakes? Would you mind passing `--impure` to `nix $CMD` invocations? Any thoughts are welcome - feel free to DM me on Matrix/IRC if you don't want to reply to the list. My Matrix ID is: @dom:rodriguez, and my IRC nick is 'shymega[i]'. Thanks! Best wishes, -- Dom Rodriguez GPG Fingerprint: EB0D 45E6 D0DC 1BA1 A2B5 FC24 72DC F123 1E54 BD43

2 1

[PATCH v3] host/start-vmm: replace jq calls with miniserde
by Yureka 26 Aug '24

26 Aug '24

Signed-off-by: Yureka <yuka(a)yuka.dev> --- host/start-vmm/ch.rs | 50 +++++++++++++++++++------------------------- 1 file changed, 22 insertions(+), 28 deletions(-) diff --git a/host/start-vmm/ch.rs b/host/start-vmm/ch.rs index cf164c6..1ff2b26 100644 --- a/host/start-vmm/ch.rs +++ b/host/start-vmm/ch.rs @@ -1,5 +1,6 @@ // SPDX-License-Identifier: EUPL-1.2+ // SPDX-FileCopyrightText: 2022-2024 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2024 Yureka <yuka(a)yuka.dev> use std::ffi::{CStr, OsStr, OsString}; use std::io::Write; @@ -8,8 +9,9 @@ use std::num::NonZeroI32; use std::os::raw::{c_char, c_int}; use std::os::unix::prelude::*; use std::process::{Command, Stdio}; +use std::str; -use miniserde::{json, Serialize}; +use miniserde::{json, Deserialize, Serialize}; use crate::net::MacAddress; @@ -125,38 +127,30 @@ pub fn create_vm(vm_name: &str, mut config: VmConfig) -> Result<(), String> { Ok(()) } -pub fn add_net(vm_name: &str, net: &NetConfig) -> Result<OsString, NonZeroI32> { - let mut ch_remote = command(vm_name, "add-net") +pub fn add_net(vm_name: &str, net: &NetConfig) -> Result<String, NonZeroI32> { + let ch_output = command(vm_name, "add-net") .arg(format!("fd={},mac={}", net.fd, net.mac)) - .stdout(Stdio::piped()) .spawn() - .or(Err(EPERM))?; + .or(Err(EPERM))? + .wait_with_output() + .or(Err(EPROTO))?; - let jq_out = match Command::new("jq") - .args(["-j", ".id"]) - .stdin(ch_remote.stdout.take().unwrap()) - .stderr(Stdio::inherit()) - .output() - { - Ok(o) => o, - Err(_) => { - // Try not to leave a zombie. - let _ = ch_remote.kill(); - let _ = ch_remote.wait(); - return Err(EPERM); - } - }; + if !ch_output.status.success() { + return Err(EPROTO); + } - if let Ok(ch_remote_status) = ch_remote.wait() { - if ch_remote_status.success() && jq_out.status.success() { - return Ok(OsString::from_vec(jq_out.stdout)); - } + #[derive(Deserialize)] + struct AddNetOutput { + id: String, } - Err(EPROTO) + let output_str = str::from_utf8(&ch_output.stdout).map_err(|_| EPROTO)?; + let output_parsed: AddNetOutput = json::from_str(output_str).map_err(|_| EPROTO)?; + + Ok(output_parsed.id) } -pub fn remove_device(vm_name: &str, device_id: &OsStr) -> Result<(), NonZeroI32> { +pub fn remove_device(vm_name: &str, device_id: &str) -> Result<(), NonZeroI32> { let ch_remote = command(vm_name, "remove-device") .arg(device_id) .status() @@ -178,7 +172,7 @@ pub fn remove_device(vm_name: &str, device_id: &OsStr) -> Result<(), NonZeroI32> unsafe extern "C" fn add_net_c( vm_name: *const c_char, net: &NetConfig, - id: *mut *mut OsString, + id: *mut *mut String, ) -> c_int { let Ok(vm_name) = CStr::from_ptr(vm_name).to_str() else { return EINVAL.into(); @@ -202,7 +196,7 @@ unsafe extern "C" fn add_net_c( /// - `id` must be a device ID obtained by calling `add_net_c`. After /// calling `remove_device_c`, the pointer is no longer valid. #[export_name = "ch_remove_device"] -unsafe extern "C" fn remove_device_c(vm_name: *const c_char, device_id: *mut OsString) -> c_int { +unsafe extern "C" fn remove_device_c(vm_name: *const c_char, device_id: *mut String) -> c_int { let Ok(vm_name) = CStr::from_ptr(vm_name).to_str() else { return EINVAL.into(); }; @@ -220,7 +214,7 @@ unsafe extern "C" fn remove_device_c(vm_name: *const c_char, device_id: *mut OsS /// `id` must be a device ID obtained by calling `add_net_c`. After /// calling `device_free`, the pointer is no longer valid. #[export_name = "ch_device_free"] -unsafe extern "C" fn device_free(id: *mut OsString) { +unsafe extern "C" fn device_free(id: *mut String) { if !id.is_null() { drop(Box::from_raw(id)) } -- 2.45.2

2 2

[PATCH v2] host/start-vmm: replace jq calls with miniserde
by Yureka 25 Aug '24

25 Aug '24

Signed-off-by: Yureka <yuka(a)yuka.dev> --- host/start-vmm/ch.rs | 39 ++++++++++++++++----------------------- 1 file changed, 16 insertions(+), 23 deletions(-) diff --git a/host/start-vmm/ch.rs b/host/start-vmm/ch.rs index cf164c6..46b198a 100644 --- a/host/start-vmm/ch.rs +++ b/host/start-vmm/ch.rs @@ -1,5 +1,6 @@ // SPDX-License-Identifier: EUPL-1.2+ // SPDX-FileCopyrightText: 2022-2024 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2024 Yureka <yuka(a)yuka.dev> use std::ffi::{CStr, OsStr, OsString}; use std::io::Write; @@ -9,7 +10,7 @@ use std::os::raw::{c_char, c_int}; use std::os::unix::prelude::*; use std::process::{Command, Stdio}; -use miniserde::{json, Serialize}; +use miniserde::{json, Deserialize, Serialize}; use crate::net::MacAddress; @@ -126,34 +127,26 @@ pub fn create_vm(vm_name: &str, mut config: VmConfig) -> Result<(), String> { } pub fn add_net(vm_name: &str, net: &NetConfig) -> Result<OsString, NonZeroI32> { - let mut ch_remote = command(vm_name, "add-net") + let ch_output = command(vm_name, "add-net") .arg(format!("fd={},mac={}", net.fd, net.mac)) - .stdout(Stdio::piped()) .spawn() - .or(Err(EPERM))?; + .or(Err(EPERM))? + .wait_with_output() + .or(Err(EPROTO))?; - let jq_out = match Command::new("jq") - .args(["-j", ".id"]) - .stdin(ch_remote.stdout.take().unwrap()) - .stderr(Stdio::inherit()) - .output() - { - Ok(o) => o, - Err(_) => { - // Try not to leave a zombie. - let _ = ch_remote.kill(); - let _ = ch_remote.wait(); - return Err(EPERM); - } - }; + if !ch_output.status.success() { + return Err(EPROTO); + } - if let Ok(ch_remote_status) = ch_remote.wait() { - if ch_remote_status.success() && jq_out.status.success() { - return Ok(OsString::from_vec(jq_out.stdout)); - } + #[derive(Deserialize)] + struct AddNetOutput { + id: String, } - Err(EPROTO) + let output_str = std::str::from_utf8(&ch_output.stdout).map_err(|_| EPROTO)?; + let output_parsed: AddNetOutput = json::from_str(output_str).map_err(|_| EPROTO)?; + + Ok(OsString::from_vec(output_parsed.id.into())) } pub fn remove_device(vm_name: &str, device_id: &OsStr) -> Result<(), NonZeroI32> { -- 2.45.2

1 0

[PATCH] host/start-vmm: replace jq calls with miniserde
by Yureka 25 Aug '24

25 Aug '24

--- host/start-vmm/ch.rs | 38 +++++++++++++++----------------------- 1 file changed, 15 insertions(+), 23 deletions(-) diff --git a/host/start-vmm/ch.rs b/host/start-vmm/ch.rs index cf164c6..abc6a00 100644 --- a/host/start-vmm/ch.rs +++ b/host/start-vmm/ch.rs @@ -9,7 +9,7 @@ use std::os::raw::{c_char, c_int}; use std::os::unix::prelude::*; use std::process::{Command, Stdio}; -use miniserde::{json, Serialize}; +use miniserde::{json, Deserialize, Serialize}; use crate::net::MacAddress; @@ -126,34 +126,26 @@ pub fn create_vm(vm_name: &str, mut config: VmConfig) -> Result<(), String> { } pub fn add_net(vm_name: &str, net: &NetConfig) -> Result<OsString, NonZeroI32> { - let mut ch_remote = command(vm_name, "add-net") + let ch_output = command(vm_name, "add-net") .arg(format!("fd={},mac={}", net.fd, net.mac)) - .stdout(Stdio::piped()) .spawn() - .or(Err(EPERM))?; + .or(Err(EPERM))? + .wait_with_output() + .or(Err(EPROTO))?; - let jq_out = match Command::new("jq") - .args(["-j", ".id"]) - .stdin(ch_remote.stdout.take().unwrap()) - .stderr(Stdio::inherit()) - .output() - { - Ok(o) => o, - Err(_) => { - // Try not to leave a zombie. - let _ = ch_remote.kill(); - let _ = ch_remote.wait(); - return Err(EPERM); - } - }; + if !ch_output.status.success() { + return Err(EPROTO); + } - if let Ok(ch_remote_status) = ch_remote.wait() { - if ch_remote_status.success() && jq_out.status.success() { - return Ok(OsString::from_vec(jq_out.stdout)); - } + #[derive(Deserialize)] + struct AddNetOutput { + id: String, } - Err(EPROTO) + let output_str = std::str::from_utf8(&ch_output.stdout).map_err(|_| EPROTO)?; + let output_parsed: AddNetOutput = json::from_str(output_str).map_err(|_| EPROTO)?; + + Ok(OsString::from_vec(output_parsed.id.into())) } pub fn remove_device(vm_name: &str, device_id: &OsStr) -> Result<(), NonZeroI32> { -- 2.45.2

2 1

Binary cache key rotation
by Alyssa Ross 16 Aug '24

16 Aug '24

Some of you may know that a few months ago, the Spectrum binary cache builder broke, because a change to the TLS on github.com (where the builder downloaded NixOS netboot images from) meant that Vultr's iPXE was no longer able to connect to it, and Vultr told me they couldn't give a timeline on updating iPXE to include the fix[1]. In the time since then, I've been working on a new binary cache builder with no need for iPXE — more information in the commit message[2]. One of the nice things about the new design is that it allows for being a little bit more careful with the key — it's stored in Scaleway's Secret Manager[3] (which stores it encrypted), and it's never written to disk unencrypted by the builder. Given this slightly higher level of security for the key, it makes sense to transition to a new key that has never been stored outside of this arrangement. (I generated it from Tails.) So, if you have Nix configured to trust the old binary cache key, spectrum-os.org-1:rnnSumz3+Dbs5uewPlwZSTP0k3g/5SRG4hD7Wbr9YuQ=, you should replace that in your configuration with the new key, spectrum-os.org-2:foQk3r7t2VpRx92CaXb5ROyy/NBdRJQG2uX2XJMYZfU=. During the Tails session where I generated the new key, I also generated and uploaded signatures for all store paths in the binary cache that had a valid signature from the old key, so it's possible to distrust the old key without losing the ability to substitute old paths from the binary cache. In future, all store paths built by the builder will only be signed with the new key. I've updated the binary cache documentation to describe the new binary cache[4]. The rendered documentation on the website will update once the new builder has completed its first build. This is a small evolutionary step for builder security — I'd probably still want to do more before using it to build non-development images, for example having the key on an HSM rather than being on the builder's filesystem. [1]: https://github.com/ipxe/ipxe/commit/1d1cf74a5e58811822bee4b3da3cff7282fcdfca [2]: https://spectrum-os.org/git/infra/commit/?id=ef9717440ff4e000cb50009bb68ba3… [3]: https://www.scaleway.com/en/secret-manager/ [4]: https://spectrum-os.org/git/spectrum/commit/?id=f5a75c9739d9ab23323734ccdfd…

1 0

ComputingProfessionals
by info 14 Apr '24

14 Apr '24

Hello. I am currently looking to sell my domain name ComputingProfessionals (.com). My asking price for this domain name is 479 USD. The domain is registered at GoDaddy. Please let me know if you might be interested in it. Thank you!

1 0

Upcoming Wayland projects in Spectrum
by Alyssa Ross 20 Sep '23

20 Sep '23

Hi, I was asked to give an overview of what Wayland-related stuff is on the radar for the near future, so here we go: crosvm security contexts ------------------------ The Wayland security context protocol[1] is how the compositor will know which VM is responsible for which Wayland client, which will allow us to make per-VM policy decisions. crosvm is the part of Spectrum's stack that can give this information to the compositor, so we need it to implement this protocol. Puck previously created such an implementation[2], but it was for an earlier draft of the protocol. It needs to be updated and submitted upstream. [1]: https://wayland.app/protocols/security-context-v1 [2]: https://puck.moe/git/crosvm/commit/?h=wayland-security-context&id=dbdba0bf6… Customisable COSMIC ------------------- I plan to use the COSMIC[3] the compositor for Spectrum. As far as I know, it's the only serious Rust Wayland compositor, and it looks like it's targeting a good balance between wide usability and configurability. But Spectrum's compositor has some requirements that wouldn't make sense for upstream COSMIC. For example, we'll want to implement some sort of clipboard permissions system, and we're likely to want to do some sort of custom window decorations, maybe like Qubes does. Maintaining a fork of cosmic-comp wouldn't be sustainable, so what we need is some way to customize the compositor's behaviour without needing out-of-tree patches. The way I imagine this working is having cosmic-comp export a library that allows inserting hooks for things we might want to customise. Then we could write a very small program that used that library, set up whatever hooks we wanted, and then just told the library to run the compositor. Quick sketch: use cosmic_comp::{Hook, add_hook, run}; fn main() { add_hook(Hook::Paste, |ctx| { ... }); run(); } I've talked to upstream about this, and they're on board with the general concept. Doing it this way would mean the only code we'd have to maintain would be Spectrum-specific, and we wouldn't have to worry about running into merge conflicts forever. Once this is done, we can do things like implement security contexts in cosmic-comp. It wouldn't make much sense to do that first, because it wouldn't be used anywhere. [3]: https://github.com/pop-os/cosmic-epoch#cosmic-comp COSMIC title bars for wayland-proxy-virtwl Xwayland clients ----------------------------------------------------------- wayland-proxy-virtwl[4] is the program used to relay Wayland connections from the guest to the host. It implements its own unpriveleged X11 forwarding. (Normal Xwayland requires the compositor give special priveleges not given to normal Wayland clients.) For some reason, cosmic-comp does not draw title bars for these clients. It's unclear so far whether this is a cosmic-comp program or a wayland-proxy-virtwl problem. [4]: https://github.com/talex5/wayland-proxy-virtwl

1 0

[PATCH v3 0/6] Initial support for VM Wayland
by Alyssa Ross 28 Jul '23

28 Jul '23

Changes since v2: - Disable virgl for virtio-gpu devices - Ensure wayland-proxy-virtwl isn't started before card0 appears - Build everything with musl - Support testing netvm with crosvm in addition to appvms v1: https://spectrum-os.org/lists/archives/spectrum-devel/20220928170128.158379… v2: https://spectrum-os.org/lists/archives/spectrum-devel/20220930213533.171061… This series adds the Spectrum-side support for running VMs that can display Wayland windows on the host compositor, using virtio-gpu. There are various small things still to be resolved, but it's ready for other people to try out and test. The easiest way to test this out is to run "vm-start hello-wayland" on the Spectrum host. If everything goes well, a small window with a picture of a cat (hello-wayland) should appear. This window is running in a VM. Currently, Wayland clients more complex than hello-wayland are unlikely to work, due to a couple of upstream bugs: - https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4584252 - https://chromium-review.googlesource.com/c/crosvm/crosvm/+/4684048 With those two fixes applied, I've been able to run much more complex applications, e.g. Krita. But I don't want to keep this waiting any longer, so let's get the basics in, and not block on fixing the remaining upstream problems. This has felt so close for so long, so I'm not going to miss this opportunity. As for what took this so long, mostly it's been stuff that isn't part of this series. Fixing crosvm, refining my cloud-hypervisor vhost-user-gpu implementation, etc. The previous submissions of this series were marked as RFC because there were bits I just wasn't quite happy enough with to merge them at the time — having to use Glibc for certain components, having virgl always enabled, etc. Those things have all been resolved. Alyssa Ross (6): img/app: allow waiting for GPU to appear vm-lib: add mesa drivers to VM img/app: add support for testing virtio-gpu vm: add support for testing in crosvm host: add support for Wayland in VMs vm/app: add hello-wayland demo VM .../using-spectrum/creating-vms.adoc | 5 ++++ host/initramfs/extfs.nix | 4 ++- host/rootfs/Makefile | 4 +++ host/rootfs/default.nix | 6 ++-- host/rootfs/etc/s6-rc/ext-rc-init/up | 7 +++++ host/rootfs/etc/template/gpu/data/check | 5 ++++ host/rootfs/etc/template/gpu/notification-fd | 1 + .../etc/template/gpu/notification-fd.license | 2 ++ host/rootfs/etc/template/gpu/run | 9 ++++++ host/rootfs/etc/template/gpu/type | 1 + host/rootfs/etc/template/gpu/type.license | 2 ++ host/start-vm/lib.rs | 10 +++++++ img/app/Makefile | 25 +++++++++++++++- img/app/etc/mdev.conf | 3 +- img/app/shell.nix | 2 +- lib/common.mk | 3 ++ vm-lib/make-vm.nix | 12 ++++++-- vm/app/hello-wayland.nix | 29 +++++++++++++++++++ vm/sys/net/Makefile | 11 +++++++ vm/sys/net/shell.nix | 2 +- 20 files changed, 133 insertions(+), 10 deletions(-) create mode 100755 host/rootfs/etc/template/gpu/data/check create mode 100644 host/rootfs/etc/template/gpu/notification-fd create mode 100644 host/rootfs/etc/template/gpu/notification-fd.license create mode 100755 host/rootfs/etc/template/gpu/run create mode 100644 host/rootfs/etc/template/gpu/type create mode 100644 host/rootfs/etc/template/gpu/type.license create mode 100644 vm/app/hello-wayland.nix base-commit: 13bb6394205346d161fa6f1467b7c6ba81196fb0 -- 2.40.1

2 12

[PATCH v2] Documentation: fix accidental anchor links
by Alyssa Ross 29 May '23

29 May '23

The xref macro is for cross references to internal links within the documentation, not external links. xref:https://… results in an anchor link. The existing doc-links test didn't catch this, because it operates at the HTTP level. But the problem is easy to spot in the sources, so I've added a new check that just greps for this pattern. Reported-by: Ryan Lahfa <ryan(a)lahfa.xyz> Fixes: 97cceff ("Documentation: add contributing information") Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- v1: https://spectrum-os.org/lists/archives/spectrum-devel/20230527151106.201590… doc-anchors.nix didn't actually ever succeed in v1, oops. Documentation/contributing/communication.adoc | 26 +++++++++---------- Documentation/contributing/index.adoc | 2 +- .../contributing/writing_documentation.adoc | 18 ++++++------- release/checks/default.nix | 2 ++ release/checks/doc-anchors.nix | 12 +++++++++ 5 files changed, 37 insertions(+), 23 deletions(-) create mode 100644 release/checks/doc-anchors.nix diff --git a/Documentation/contributing/communication.adoc b/Documentation/contributing/communication.adoc index 506fa28..8288c99 100644 --- a/Documentation/contributing/communication.adoc +++ b/Documentation/contributing/communication.adoc @@ -27,17 +27,17 @@ Spectrum's developers, subscribe to *announce@spectrum-os.org*. You can discuss Spectrum and related topics in real time on IRC, or more long-form on spectrum-announce (_discuss@spectrum-os.org_). Finally, development work happens in Spectrum's -xref:https://spectrum-os.org/git/[source repositories], and is -discussed on spectrum-devel (_devel@spectrum-os.org_). +https://spectrum-os.org/git/[source repositories], and is discussed on +spectrum-devel (_devel@spectrum-os.org_). == Internet Relay Chat There is a single Internet Relay Chat (IRC) channel, -xref:ircs://irc.libera.chat:6697/spectrum[#spectrum] -on xref:https://libera.chat/[Libera.Chat], for all kinds of Spectrum -discussions. You can also join through xref:https://matrix.org/[Matrix] as -xref:https://matrix.to/#/#spectrum:libera.chat[#spectrum:libera.chat]. +link:ircs://irc.libera.chat:6697/spectrum[#spectrum] on +https://libera.chat/[Libera.Chat], for all kinds of Spectrum +discussions. You can also join through https://matrix.org/[Matrix] as +https://matrix.to/#/#spectrum:libera.chat[#spectrum:libera.chat]. If you are new to IRC, you might find Matrix the easiest way to get started. The channel is *logged*, but the logs are not available online yet. @@ -49,11 +49,11 @@ following along with it, the best thing to do is subscribe to one or more of the Spectrum mailing lists. If mailing lists are not your thing, that is okay! Try the -xref:https://spectrum-os.org/lists/hyperkitty/[Web UI], which allows -you to interact with the mailing lists much like a modern web forum. +https://spectrum-os.org/lists/hyperkitty/[Web UI], which allows you to +interact with the mailing lists much like a modern web forum. -Each list has xref:https://spectrum-os.org/lists/archives/[archives] -that can also be accessed via the web, NNTP or Atom. You are strongly +Each list has https://spectrum-os.org/lists/archives/[archives] that +can also be accessed via the web, NNTP or Atom. You are strongly encouraged to mirror them. [cols="1,1"] @@ -64,14 +64,14 @@ encouraged to mirror them. from Spectrum's developers will be posted. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/[on the web], +https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/[on the web], or by sending mail to *announce-subscribe@spectrum-os.org*. %7Cdiscuss(a)spectrum-os.org |This list contains high-level discussion about the project. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/[on the web], +https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/[on the web], or by sending mail to *discuss-subscribe@spectrum-os.org*. %7Cdevel(a)spectrum-os.org @@ -84,6 +84,6 @@ For more information, see xref:working-with-patches.adoc[Working with Patches]. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. +https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. |=== diff --git a/Documentation/contributing/index.adoc b/Documentation/contributing/index.adoc index 48255d8..03eac68 100644 --- a/Documentation/contributing/index.adoc +++ b/Documentation/contributing/index.adoc @@ -48,7 +48,7 @@ There is also a web interface https://spectrum-os.org/lists/hyperkitty/ that you can use to browse or even post to the mailing list. Add a Signed-off-by line to each patch you submit, to indicate your -certification of the xref:https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's Certificate of Origin] for that patch. +certification of the https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's Certificate of Origin] for that patch. The easiest way to do this is with `git commit's -s` flag. Do not be too afraid of getting it wrong the first couple of times. diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/contributing/writing_documentation.adoc index f8a69ef..cb09241 100644 --- a/Documentation/contributing/writing_documentation.adoc +++ b/Documentation/contributing/writing_documentation.adoc @@ -11,11 +11,11 @@ formatting, and organizing the Spectrum documentation. Please follow these guidelines and conventions when editing the documentation. -We use xref:https://nixos.org/manual/nix/stable/introduction.html[Nix] -and xref:https://github.com/just-the-docs/just-the-docs[Just the Docs] -for building the documentation. Sources are written in AsciiDoc -If you are new with it, -see xref:https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]. +We use https://nixos.org/manual/nix/stable/introduction.html[Nix] and +https://github.com/just-the-docs/just-the-docs[Just the Docs] for +building the documentation. Sources are written in AsciiDoc If you are +new with it, see +https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]. If you want to test your changes, see xref:../contributing/building-documentation.adoc[Building Documentation]. @@ -38,7 +38,7 @@ to suit your changing needs. == Document Layout -* xref:https://docs.asciidoctor.org/asciidoc/latest/document/header/[Document header]: +* https://docs.asciidoctor.org/asciidoc/latest/document/header/[Document header]: include your name and a revision line following the author line. Example: = Document Title @@ -64,15 +64,15 @@ abbreviations are used. ** Keep text hard-wrapped at 70-80 characters. (Most editors should be able to do this automatically.) This makes it easier to pick out specific parts in review, and also makes it easier to read in some editors. (It does not make a difference to the result as rendered in the web browser.) -** Keep the text in the description attribute hard-wrapped as well. For more information, see the xref:https://docs.asciidoctor.org/asciidoc/latest/document/metadata/#descri… Metadata] section of the Asciidoctor Docs. +** Keep the text in the description attribute hard-wrapped as well. For more information, see the https://docs.asciidoctor.org/asciidoc/latest/document/metadata/#description… Metadata] section of the Asciidoctor Docs. -* Put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. For more information, see xref:https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sente… Recommended Practices]. +* Put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. For more information, see https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-p… Recommended Practices]. == Structure * Use subheading to organize information. * One topic per article. -* To make accents, use xref:https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admon…. +* To make accents, use https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admonition…. * Use numbered lists for actions that happen in sequence. * Do not use parenthesis for additional information, make a separate sentence instead. diff --git a/release/checks/default.nix b/release/checks/default.nix index f8a3f9b..100de9a 100644 --- a/release/checks/default.nix +++ b/release/checks/default.nix @@ -8,6 +8,8 @@ import ../../lib/eval-config.nix ({ ... } @ args: doc-links = import ./doc-links.nix args; + doc-anchors = import ./doc-anchors.nix args; + pkg-tests = import ./pkg-tests.nix args; reuse = import ./reuse.nix args; diff --git a/release/checks/doc-anchors.nix b/release/checks/doc-anchors.nix new file mode 100644 index 0000000..1fae7e3 --- /dev/null +++ b/release/checks/doc-anchors.nix @@ -0,0 +1,12 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2023 Alyssa Ross <hi(a)alyssa.is> + +import ../../lib/eval-config.nix ({ config, ... }: +config.pkgs.callPackage ({ runCommand }: + +runCommand "spectrum-doc-anchors" {} '' + cd ${(import ../../Documentation { inherit config; }).src} + ! grep --color=always -r xref:http + touch $out +'' +) { }) base-commit: 1c6893145bdf023cd03b7675a18749ce8ed3803f -- 2.37.1

2 1

[PATCH] release/checks/try.nix: init
by Alyssa Ross 27 May '23

27 May '23

This is a regression test for c7f87f3 ("host/rootfs: allow growing ext partition to fail"). It's the first time we're actually doing automated tests of a Spectrum boot. For now, I'm using the NixOS test framework, but because we're not using NixOS and not setting any NixOS options, it feels to me like it doesn't actually buy us very much, so if it doesn't start adding more value as we add more (or more complex) tests, it might be simpler to just use a shell/execline script for tests. Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Documentation for reviewing patches: https://spectrum-os.org/doc/contributing/reviewing-patches.html release/checks/default.nix | 2 ++ release/checks/try.nix | 50 ++++++++++++++++++++++++++++++++++++++ release/live/default.nix | 2 +- 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 release/checks/try.nix diff --git a/release/checks/default.nix b/release/checks/default.nix index f8a3f9b..bf26b9a 100644 --- a/release/checks/default.nix +++ b/release/checks/default.nix @@ -15,4 +15,6 @@ import ../../lib/eval-config.nix ({ ... } @ args: rustfmt = import ./rustfmt.nix args; shellcheck = import ./shellcheck.nix args; + + try = import ./try.nix args; }) diff --git a/release/checks/try.nix b/release/checks/try.nix new file mode 100644 index 0000000..73539ef --- /dev/null +++ b/release/checks/try.nix @@ -0,0 +1,50 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2023 Alyssa Ross <hi(a)alyssa.is> + +import ../../lib/eval-config.nix ({ config, ... }: + +let + live = import ../live { inherit config; }; +in + +config.pkgs.nixosTest ({ pkgs, ... }: { + name = "try-spectrum-test"; + nodes = {}; + + testScript = '' + import shlex + import subprocess + + conf = subprocess.run([ + "${pkgs.mtools}/bin/mcopy", + "-i", + "${live}@@1M", + "::loader/entries/spectrum.conf", + "-", + ], stdout=subprocess.PIPE) + conf.check_returncode() + + cmdline = None + for line in conf.stdout.decode('utf-8').splitlines(): + key, value = line.split(' ', 1) + if key == 'options': + cmdline = value + + flags = " ".join(map(shlex.quote, [ + "qemu-kvm", + "-m", "512", + "-kernel", "${live.rootfs.kernel}/${pkgs.stdenv.hostPlatform.linux-kernel.target}", + "-initrd", "${live.initramfs}", + "-device", "qemu-xhci", + "-device", "usb-storage,drive=drive1,removable=true", + "-drive", "file=${live},id=drive1,format=raw,if=none,readonly=on", + "-append", f"panic=-1 {cmdline}", + ])) + + machine = create_machine({"startCommand": flags}) + + machine.start() + machine.wait_for_console_text("EXT4-fs $sda4$: mounted filesystem") + machine.crash() + ''; +})) diff --git a/release/live/default.nix b/release/live/default.nix index b7ee036..6df73d4 100644 --- a/release/live/default.nix +++ b/release/live/default.nix @@ -48,6 +48,6 @@ stdenvNoCC.mkDerivation { enableParallelBuilding = true; - passthru = { inherit rootfs; }; + passthru = { inherit initramfs rootfs; }; } ) {}) -- 2.37.1

3 7

[PATCH] Documentation: fix accidental anchor links
by Alyssa Ross 27 May '23

27 May '23

The xref macro is for cross references to internal links within the documentation, not external links. xref:https://… results in an anchor link. The existing doc-links test didn't catch this, because it operates at the HTTP level. But the problem is easy to spot in the sources, so I've added a new check that just greps for this pattern. Reported-by: Ryan Lahfa <ryan(a)lahfa.xyz> Fixes: 97cceff ("Documentation: add contributing information") Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Documentation/contributing/communication.adoc | 26 +++++++++---------- Documentation/contributing/index.adoc | 2 +- .../contributing/writing_documentation.adoc | 18 ++++++------- release/checks/default.nix | 2 ++ release/checks/doc-anchors.nix | 11 ++++++++ 5 files changed, 36 insertions(+), 23 deletions(-) create mode 100644 release/checks/doc-anchors.nix diff --git a/Documentation/contributing/communication.adoc b/Documentation/contributing/communication.adoc index 506fa28..8288c99 100644 --- a/Documentation/contributing/communication.adoc +++ b/Documentation/contributing/communication.adoc @@ -27,17 +27,17 @@ Spectrum's developers, subscribe to *announce@spectrum-os.org*. You can discuss Spectrum and related topics in real time on IRC, or more long-form on spectrum-announce (_discuss@spectrum-os.org_). Finally, development work happens in Spectrum's -xref:https://spectrum-os.org/git/[source repositories], and is -discussed on spectrum-devel (_devel@spectrum-os.org_). +https://spectrum-os.org/git/[source repositories], and is discussed on +spectrum-devel (_devel@spectrum-os.org_). == Internet Relay Chat There is a single Internet Relay Chat (IRC) channel, -xref:ircs://irc.libera.chat:6697/spectrum[#spectrum] -on xref:https://libera.chat/[Libera.Chat], for all kinds of Spectrum -discussions. You can also join through xref:https://matrix.org/[Matrix] as -xref:https://matrix.to/#/#spectrum:libera.chat[#spectrum:libera.chat]. +link:ircs://irc.libera.chat:6697/spectrum[#spectrum] on +https://libera.chat/[Libera.Chat], for all kinds of Spectrum +discussions. You can also join through https://matrix.org/[Matrix] as +https://matrix.to/#/#spectrum:libera.chat[#spectrum:libera.chat]. If you are new to IRC, you might find Matrix the easiest way to get started. The channel is *logged*, but the logs are not available online yet. @@ -49,11 +49,11 @@ following along with it, the best thing to do is subscribe to one or more of the Spectrum mailing lists. If mailing lists are not your thing, that is okay! Try the -xref:https://spectrum-os.org/lists/hyperkitty/[Web UI], which allows -you to interact with the mailing lists much like a modern web forum. +https://spectrum-os.org/lists/hyperkitty/[Web UI], which allows you to +interact with the mailing lists much like a modern web forum. -Each list has xref:https://spectrum-os.org/lists/archives/[archives] -that can also be accessed via the web, NNTP or Atom. You are strongly +Each list has https://spectrum-os.org/lists/archives/[archives] that +can also be accessed via the web, NNTP or Atom. You are strongly encouraged to mirror them. [cols="1,1"] @@ -64,14 +64,14 @@ encouraged to mirror them. from Spectrum's developers will be posted. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/[on the web], +https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/[on the web], or by sending mail to *announce-subscribe@spectrum-os.org*. %7Cdiscuss(a)spectrum-os.org |This list contains high-level discussion about the project. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/[on the web], +https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/[on the web], or by sending mail to *discuss-subscribe@spectrum-os.org*. %7Cdevel(a)spectrum-os.org @@ -84,6 +84,6 @@ For more information, see xref:working-with-patches.adoc[Working with Patches]. You can subscribe -xref:https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. +https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. |=== diff --git a/Documentation/contributing/index.adoc b/Documentation/contributing/index.adoc index 48255d8..03eac68 100644 --- a/Documentation/contributing/index.adoc +++ b/Documentation/contributing/index.adoc @@ -48,7 +48,7 @@ There is also a web interface https://spectrum-os.org/lists/hyperkitty/ that you can use to browse or even post to the mailing list. Add a Signed-off-by line to each patch you submit, to indicate your -certification of the xref:https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's Certificate of Origin] for that patch. +certification of the https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's Certificate of Origin] for that patch. The easiest way to do this is with `git commit's -s` flag. Do not be too afraid of getting it wrong the first couple of times. diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/contributing/writing_documentation.adoc index f8a69ef..cb09241 100644 --- a/Documentation/contributing/writing_documentation.adoc +++ b/Documentation/contributing/writing_documentation.adoc @@ -11,11 +11,11 @@ formatting, and organizing the Spectrum documentation. Please follow these guidelines and conventions when editing the documentation. -We use xref:https://nixos.org/manual/nix/stable/introduction.html[Nix] -and xref:https://github.com/just-the-docs/just-the-docs[Just the Docs] -for building the documentation. Sources are written in AsciiDoc -If you are new with it, -see xref:https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]. +We use https://nixos.org/manual/nix/stable/introduction.html[Nix] and +https://github.com/just-the-docs/just-the-docs[Just the Docs] for +building the documentation. Sources are written in AsciiDoc If you are +new with it, see +https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]. If you want to test your changes, see xref:../contributing/building-documentation.adoc[Building Documentation]. @@ -38,7 +38,7 @@ to suit your changing needs. == Document Layout -* xref:https://docs.asciidoctor.org/asciidoc/latest/document/header/[Document header]: +* https://docs.asciidoctor.org/asciidoc/latest/document/header/[Document header]: include your name and a revision line following the author line. Example: = Document Title @@ -64,15 +64,15 @@ abbreviations are used. ** Keep text hard-wrapped at 70-80 characters. (Most editors should be able to do this automatically.) This makes it easier to pick out specific parts in review, and also makes it easier to read in some editors. (It does not make a difference to the result as rendered in the web browser.) -** Keep the text in the description attribute hard-wrapped as well. For more information, see the xref:https://docs.asciidoctor.org/asciidoc/latest/document/metadata/#descri… Metadata] section of the Asciidoctor Docs. +** Keep the text in the description attribute hard-wrapped as well. For more information, see the https://docs.asciidoctor.org/asciidoc/latest/document/metadata/#description… Metadata] section of the Asciidoctor Docs. -* Put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. For more information, see xref:https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sente… Recommended Practices]. +* Put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. For more information, see https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-p… Recommended Practices]. == Structure * Use subheading to organize information. * One topic per article. -* To make accents, use xref:https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admon…. +* To make accents, use https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admonition…. * Use numbered lists for actions that happen in sequence. * Do not use parenthesis for additional information, make a separate sentence instead. diff --git a/release/checks/default.nix b/release/checks/default.nix index f8a3f9b..100de9a 100644 --- a/release/checks/default.nix +++ b/release/checks/default.nix @@ -8,6 +8,8 @@ import ../../lib/eval-config.nix ({ ... } @ args: doc-links = import ./doc-links.nix args; + doc-anchors = import ./doc-anchors.nix args; + pkg-tests = import ./pkg-tests.nix args; reuse = import ./reuse.nix args; diff --git a/release/checks/doc-anchors.nix b/release/checks/doc-anchors.nix new file mode 100644 index 0000000..71c2fc9 --- /dev/null +++ b/release/checks/doc-anchors.nix @@ -0,0 +1,11 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2023 Alyssa Ross <hi(a)alyssa.is> + +import ../../lib/eval-config.nix ({ config, ... }: +config.pkgs.callPackage ({ runCommand }: + +runCommand "spectrum-doc-anchors" {} '' + cd ${(import ../../Documentation { inherit config; }).src} + ! grep --color=always -r xref:http +'' +) { }) base-commit: 1c6893145bdf023cd03b7675a18749ce8ed3803f -- 2.37.1

1 0

[PATCH 00/22] Implement managing VMs with Nix
by Alyssa Ross 26 Feb '23

26 Feb '23

IMPORTANT NOTE: this series should be applied on top of v2 of my previous series "Introduce a shared base for application VMs" [1]. I'm much happier with v2 of that series, but I only posted it yesterday so I still want to leave a little more opportunity for comment before applying it. [1]: https://spectrum-os.org/lists/archives/spectrum-devel/20221009114036.463071… This series contains the final big chunk of work I had left to do on Spectrum's original NLnet grant. It adds support for managing Spectrum VMs from the Spectrum system itself using Nix. Nix is optional, and can co-exist with VMs provided in some other way. More information is included in the new documentation. Most of this work was done earlier this year, but I got stuck on some implementation details that prevented me from getting over the last hurdle until I came up with a solution. That's explained in more detail in patch 15. Patches 1–10 add support for configuring VMs with read/write access to host directories using virtiofs. Then, in patches 11–14, come various changes that make the default user data partition more suitable as a mutable filesystem, which we haven't actually used it for before. And then the remaining patches actually implement support for a VM that can run Nix and easily build VMs that are available on the host. Alyssa Ross (22): host/start-vm: use MAP_SHARED memory for VMs host/start-vm: implement shared directories host/rootfs: generate virtiofsd services Documentation: explain VM shared directories vm-lib/make-vm.nix: support shared directories img/app: add support for testing virtiofs img/app: don't block app startup on network online img/app: auto-mount virtiofs0 filesystem vm/app/mg.nix: init vm/app/mg.nix: open virtio filesystem in dired host/rootfs: move ext mounting to s6-rc service host/rootfs: automatically grow user partition host/rootfs: use a bigger test ext partition host/initramfs/extfs.nix: tar2ext4 -> mkfs.ext4 -d host/start-vm: resolve VM symlinks with /ext root host/rootfs: resolve VM symlinks with /ext root Documentation: explain /ext symlink resolution host/start-vm: increase memory size to 512M vm/app/nix: add vm-lib/make-vms.nix: add host/initramfs/extfs.nix: add example Nix-built VM Documentation: add how-to guide for Nix-built VMs .gitignore | 5 +- Documentation/_sass/custom/custom.scss | 22 ++++++ Documentation/creating-vms.adoc | 12 ++- Documentation/nix-vms.adoc | 22 ++++++ host/initramfs/extfs.nix | 29 +++++-- host/rootfs/Makefile | 13 +++- host/rootfs/default.nix | 16 +++- host/rootfs/etc/mdev/block/add | 1 - host/rootfs/etc/s6-rc/ext-rc-init/up | 19 ++++- host/rootfs/etc/s6-rc/ext/up | 5 +- host/rootfs/etc/template/fs/notification-fd | 1 + .../etc/template/fs/notification-fd.license | 2 + host/rootfs/etc/template/fs/run | 11 +++ host/rootfs/etc/template/fs/type | 1 + host/rootfs/etc/template/fs/type.license | 2 + host/start-vm/fs.c | 17 +++++ host/start-vm/fs.rs | 68 +++++++++++++++++ host/start-vm/lib.rs | 54 ++++++++++--- host/start-vm/meson.build | 2 +- host/start-vm/start-vm.rs | 15 ++-- host/start-vm/tests/meson.build | 4 + host/start-vm/tests/vm_command-basic.rs | 6 +- .../tests/vm_command-config-symlink.rs | 30 ++++++++ host/start-vm/tests/vm_command-shared-dir.rs | 43 +++++++++++ img/app/Makefile | 24 +++++- img/app/etc/mdev.conf | 3 +- img/app/etc/mdev/iface | 4 +- img/app/etc/mdev/listen | 12 +++ img/app/etc/mdev/virtiofs | 10 +++ img/app/etc/mdev/wait | 15 ++++ img/app/etc/s6-rc/ok-all/contents | 1 + img/app/shell.nix | 6 +- tools/resolve_in_root/default.nix | 23 ++++++ tools/resolve_in_root/meson.build | 10 +++ tools/resolve_in_root/resolve_in_root.c | 76 +++++++++++++++++++ tools/resolve_in_root/test.sh | 11 +++ vm-lib/make-vm.nix | 20 ++++- vm-lib/make-vms.nix | 19 +++++ vm/app/catgirl.nix | 1 + vm/app/lynx.nix | 1 + vm/app/{lynx.nix => mg.nix} | 10 ++- vm/app/nix/bin/vm-rebuild | 25 ++++++ vm/app/nix/default.nix | 43 +++++++++++ vm/app/nix/example.nix | 13 ++++ 44 files changed, 673 insertions(+), 54 deletions(-) create mode 100644 Documentation/_sass/custom/custom.scss create mode 100644 Documentation/nix-vms.adoc create mode 100644 host/rootfs/etc/template/fs/notification-fd create mode 100644 host/rootfs/etc/template/fs/notification-fd.license create mode 100755 host/rootfs/etc/template/fs/run create mode 100644 host/rootfs/etc/template/fs/type create mode 100644 host/rootfs/etc/template/fs/type.license create mode 100644 host/start-vm/fs.c create mode 100644 host/start-vm/fs.rs create mode 100644 host/start-vm/tests/vm_command-config-symlink.rs create mode 100644 host/start-vm/tests/vm_command-shared-dir.rs create mode 100755 img/app/etc/mdev/listen create mode 100755 img/app/etc/mdev/virtiofs create mode 100755 img/app/etc/mdev/wait create mode 100644 tools/resolve_in_root/default.nix create mode 100644 tools/resolve_in_root/meson.build create mode 100644 tools/resolve_in_root/resolve_in_root.c create mode 100755 tools/resolve_in_root/test.sh create mode 100644 vm-lib/make-vms.nix copy vm/app/{lynx.nix => mg.nix} (52%) create mode 100755 vm/app/nix/bin/vm-rebuild create mode 100644 vm/app/nix/default.nix create mode 100644 vm/app/nix/example.nix -- 2.37.1

2 44

[PATCH] Documentation: swap order of Creating/Running VMs
by Alyssa Ross 21 Feb '23

21 Feb '23

Somebody who's just trying out Spectrum is probably going to want to try out the built-in demo VMs (which is easy) before they get started creating their own VMs (which is hard). Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Documentation/using-spectrum/creating-vms.adoc | 2 +- Documentation/using-spectrum/running-vms.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/using-spectrum/creating-vms.adoc b/Documentation/using-spectrum/creating-vms.adoc index 2c57562..02cd3e6 100644 --- a/Documentation/using-spectrum/creating-vms.adoc +++ b/Documentation/using-spectrum/creating-vms.adoc @@ -1,6 +1,6 @@ = Creating VMs :page-parent: Using Spectrum -:page-nav_order: 1 +:page-nav_order: 2 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 diff --git a/Documentation/using-spectrum/running-vms.adoc b/Documentation/using-spectrum/running-vms.adoc index 518b00e..e6f934e 100644 --- a/Documentation/using-spectrum/running-vms.adoc +++ b/Documentation/using-spectrum/running-vms.adoc @@ -1,6 +1,6 @@ = Running VMs :page-parent: Using Spectrum -:page-nav_order: 2 +:page-nav_order: 1 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 -- 2.37.1

2 1

[PATCH] Documentation: move "Working with Patches" under "Contributing"
by Alyssa Ross 21 Feb '23

21 Feb '23

This is all information about how to contribute to Spectrum, so I think it makes more sense here than under "Development". Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Documentation/{development => contributing}/b4.adoc | 2 +- Documentation/contributing/building-documentation.adoc | 4 ++-- Documentation/contributing/communication.adoc | 2 +- .../{development => contributing}/first-patch.adoc | 2 +- Documentation/contributing/index.adoc | 6 +++--- Documentation/{development => contributing}/replying.adoc | 2 +- .../{development => contributing}/reviewing-patches.adoc | 2 +- .../{development => contributing}/testing-patches.adoc | 2 +- .../working-with-patches.adoc | 8 ++++---- Documentation/contributing/writing_documentation.adoc | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) rename Documentation/{development => contributing}/b4.adoc (98%) rename Documentation/{development => contributing}/first-patch.adoc (98%) rename Documentation/{development => contributing}/replying.adoc (97%) rename Documentation/{development => contributing}/reviewing-patches.adoc (95%) rename Documentation/{development => contributing}/testing-patches.adoc (98%) rename Documentation/{development => contributing}/working-with-patches.adoc (58%) diff --git a/Documentation/development/b4.adoc b/Documentation/contributing/b4.adoc similarity index 98% rename from Documentation/development/b4.adoc rename to Documentation/contributing/b4.adoc index 5f141e9..b41dc58 100644 --- a/Documentation/development/b4.adoc +++ b/Documentation/contributing/b4.adoc @@ -1,6 +1,6 @@ = Installing and Configuring b4 :page-parent: Working with Patches -:page-grand_parent: Development +:page-grand_parent: Contributing :page-nav_order: 1 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> diff --git a/Documentation/contributing/building-documentation.adoc b/Documentation/contributing/building-documentation.adoc index 63a3038..1beffa8 100644 --- a/Documentation/contributing/building-documentation.adoc +++ b/Documentation/contributing/building-documentation.adoc @@ -1,6 +1,6 @@ = Building Documentation :page-parent: Contributing -:page-nav_order: 3 +:page-nav_order: 4 // SPDX-FileCopyrightText: 2022 Unikie // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 @@ -49,4 +49,4 @@ modify any of those, or add new ones, run `scripts/build.sh` again to do a full rebuild of the site. After making changes to the documentation, see how to -xref:../development/first-patch.adoc[send your patch] and submit the changes for review. +xref:first-patch.adoc[send your patch] and submit the changes for review. diff --git a/Documentation/contributing/communication.adoc b/Documentation/contributing/communication.adoc index bb8aeb9..9344cdf 100644 --- a/Documentation/contributing/communication.adoc +++ b/Documentation/contributing/communication.adoc @@ -81,7 +81,7 @@ and where patches are sent. There is a separate guide for the Spectrum development process, including how patches are sent to this list and discussed. For more information, see -xref:../development/working-with-patches.adoc[Working with Patches]. +xref:working-with-patches.adoc[Working with Patches]. You can subscribe xref:https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. diff --git a/Documentation/development/first-patch.adoc b/Documentation/contributing/first-patch.adoc similarity index 98% rename from Documentation/development/first-patch.adoc rename to Documentation/contributing/first-patch.adoc index aa6ebee..13efa33 100644 --- a/Documentation/development/first-patch.adoc +++ b/Documentation/contributing/first-patch.adoc @@ -1,6 +1,6 @@ = Sending Your Patch :page-parent: Working with Patches -:page-grand_parent: Development +:page-grand_parent: Contributing :page-nav_order: 1 // SPDX-FileCopyrightText: 2022 Unikie diff --git a/Documentation/contributing/index.adoc b/Documentation/contributing/index.adoc index 4be8d69..48255d8 100644 --- a/Documentation/contributing/index.adoc +++ b/Documentation/contributing/index.adoc @@ -24,7 +24,7 @@ If you have made changes you would like to be included in the official Spectrum distribution, please send patches to the spectrum-devel mailing list (devel(a)spectrum-os.org) For more information, see -xref:../development/working-with-patches.adoc[Working with Patches]. +xref:working-with-patches.adoc[Working with Patches]. Sending patches to the list is easy — you can do it with Git, straight from the command line. You do not have to set anything up @@ -60,7 +60,7 @@ this style of collaboration can be compared to the alternatives. If you notice something that can be fixed or improved: -. xref:https://spectrum-os.org/doc/development/first-patch.html#making-change… or add any relevant documentation]. +. xref:first-patch.html#making-changes[Edit or add any relevant documentation]. + TIP: Make sure your changes are formatted correctly and consistently with the rest of the documentation. For information on writing guidelines, @@ -68,7 +68,7 @@ see xref:../contributing/writing_documentation.adoc[Documentation Style Guide]. + . xref:../contributing/building-documentation.adoc[Test your documentation]. Reread what you wrote and run a spellchecker on it to make sure you did not miss anything. -. xref:https://spectrum-os.org/doc/development/first-patch.html#submitting-ch… changes]. +. xref:first-patch.html#submitting-changes[Submit changes]. === Documentation To-Do List diff --git a/Documentation/development/replying.adoc b/Documentation/contributing/replying.adoc similarity index 97% rename from Documentation/development/replying.adoc rename to Documentation/contributing/replying.adoc index a1ad394..63fbba8 100644 --- a/Documentation/development/replying.adoc +++ b/Documentation/contributing/replying.adoc @@ -1,6 +1,6 @@ = Replying to Messages in the Mailing List Archives :page-parent: Working with Patches -:page-grand_parent: Development +:page-grand_parent: Contributing :page-nav_order: 3 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> diff --git a/Documentation/development/reviewing-patches.adoc b/Documentation/contributing/reviewing-patches.adoc similarity index 95% rename from Documentation/development/reviewing-patches.adoc rename to Documentation/contributing/reviewing-patches.adoc index ba47f25..2f7b0fc 100644 --- a/Documentation/development/reviewing-patches.adoc +++ b/Documentation/contributing/reviewing-patches.adoc @@ -1,6 +1,6 @@ = Reviewing Patches :page-parent: Working with Patches -:page-grand_parent: Development +:page-grand_parent: Contributing :page-nav_order: 2 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> diff --git a/Documentation/development/testing-patches.adoc b/Documentation/contributing/testing-patches.adoc similarity index 98% rename from Documentation/development/testing-patches.adoc rename to Documentation/contributing/testing-patches.adoc index 0c72c93..f76f873 100644 --- a/Documentation/development/testing-patches.adoc +++ b/Documentation/contributing/testing-patches.adoc @@ -1,6 +1,6 @@ = Testing Patches :page-parent: Working with Patches -:page-grand_parent: Development +:page-grand_parent: Contributing :page-nav_order: 2 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> diff --git a/Documentation/development/working-with-patches.adoc b/Documentation/contributing/working-with-patches.adoc similarity index 58% rename from Documentation/development/working-with-patches.adoc rename to Documentation/contributing/working-with-patches.adoc index a2694ed..dfd4ed5 100644 --- a/Documentation/development/working-with-patches.adoc +++ b/Documentation/contributing/working-with-patches.adoc @@ -1,6 +1,6 @@ = Working with Patches -:page-parent: Development -:page-nav_order: 3 +:page-parent: Contributing +:page-nav_order: 2 :page-has_children: true // SPDX-FileCopyrightText: 2022 Unikie @@ -8,5 +8,5 @@ Patches are the way for contributors to submit code to the Spectrum project. -Make sure to xref:../development/b4.adoc[install and configure the b4 utility] -for applying and testing other people's patches. +Make sure to xref:b4.adoc[install and configure the b4 utility] for +applying and testing other people's patches. diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/contributing/writing_documentation.adoc index a58da64..f8a69ef 100644 --- a/Documentation/contributing/writing_documentation.adoc +++ b/Documentation/contributing/writing_documentation.adoc @@ -1,6 +1,6 @@ = Documentation Style Guide :description: Channels, announcements and so on. -:page-nav_order: 2 +:page-nav_order: 3 :page-parent: Contributing // SPDX-FileCopyrightText: 2023 Unikie -- 2.37.1

2 1

[PATCH] Documentation: add more info about the installer
by Alyssa Ross 21 Feb '23

21 Feb '23

Some shortcomings in this section were reported to me privately: • It wasn't clear what the image being built was for. Was it a live image, or an installer image? (It's both.) • It wasn't clear what to do with the built image, so I've explained that it should be put on a USB drive and booted from. I've also made it clear that there's not much point going through the extra step to actually install Spectrum yet, at least until we have some sort of exposed persistent storage. Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- .../installation/getting-spectrum.adoc | 28 +++++++++++++++++-- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/installation/getting-spectrum.adoc index 6aec34f..8ee31b7 100644 --- a/Documentation/installation/getting-spectrum.adoc +++ b/Documentation/installation/getting-spectrum.adoc @@ -2,7 +2,7 @@ :page-parent: Build and Run :page-nav_order: 2 -// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2022-2023 Alyssa Ross <hi(a)alyssa.is> // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 To get Spectrum, you need to build it from source. As long as you're @@ -35,7 +35,15 @@ nix-shell -I nixpkgs=../../../nixpkgs-spectrum --run 'make run' This builds just enough of Spectrum to try it out in a VM, but it will still take a very long time. -== Building Installer +== Installing Spectrum + +To install Spectrum on a computer, you can use a USB drive as a +bootable Spectrum installer device. When booting a system from the +installer device, you will be able to choose whether to try out +Spectrum without installing it on your system (as a live image), or to +install it to your computer's internal storage. + +First, you need to build the Spectrum image: [source,shell] ---- @@ -46,7 +54,21 @@ nix-build spectrum/release/combined \ If you haven't set up the xref:binary-cache.adoc[binary cache], this will take a very long time. When it's done, a symbolic link named -"result" will appear, pointing to a Spectrum USB installer image. +"result" will appear in the current directory, pointing to the +installer image. Write that image to a USB drive, for example using +`dd` (command line) or +https://gitlab.com/bztsrc/usbimager[`usbimager`] (graphical, available +in Nixpkgs). Boot your system from the USB drive, and you should see +a menu allowing you to choose between "Try Spectrum" and "Install +Spectrum". + +NOTE: While it's possible to install Spectrum to your internal +storage, at this point in Spectrum's development there is not much +reason to, as OS updates are not yet implemented, and persistent +storage is not yet exposed to VMs. Using the "Try Spectrum" option to +boot Spectrum will let you try out everything in Spectrum, without +having to go through the additional step of reinstalling Spectrum +every time you want to use a newer version. CAUTION: Do not use Spectrum for anything important or sensitive as it is not yet suitable for real-world use. Many important security properties are -- 2.37.1

2 1

[PATCH] Documentation: add contributing information
by Jenni Nikolaenko 20 Jan '23

20 Jan '23

Hello there! I decided to create a patch from my drafts so this information will not be lost. It still needs some attention. It is a good idea to have the documentation in one place. For us this means that information from these pages https://spectrum-os.org/contributing.html, https://spectrum-os.org/participating.html -- should be moved here https://spectrum-os.org/participating.html. What I did particularly: 1. Added a new chapter "Contributing". Copied here the information from here https://spectrum-os.org/contributing.html, adapting a bit to Spectrum Docs. 2. Moved the "Building Documentation" section from "Development" to "Contributing". 3. In the "Contributing" chapter you can find the following structure: - Communication in Spectrum (copied from https://spectrum-os.org/participating.html) - Documentation Style Guide - Building Documentation I tried to fix all cross-reference links, so this new content can be used right now. Any further updates are very welcome. Signed-off-by: Jenni Nikolaenko <evgeniia.nikolaenko(a)unikie.com> --- .../building-documentation.adoc | 6 +- Documentation/contributing/communication.adoc | 89 +++++++++++++++ Documentation/contributing/index.adoc | 95 ++++++++++++++++ .../contributing/writing_documentation.adoc | 104 ++++++++++++++++++ Documentation/development/index.adoc | 7 +- Documentation/development/uuid-reference.adoc | 2 +- Documentation/index.adoc | 4 +- 7 files changed, 299 insertions(+), 8 deletions(-) rename Documentation/{development => contributing}/building-documentation.adoc (90%) create mode 100644 Documentation/contributing/communication.adoc create mode 100644 Documentation/contributing/index.adoc create mode 100644 Documentation/contributing/writing_documentation.adoc diff --git a/Documentation/development/building-documentation.adoc b/Documentation/contributing/building-documentation.adoc similarity index 90% rename from Documentation/development/building-documentation.adoc rename to Documentation/contributing/building-documentation.adoc index 4f464f5..63a3038 100644 --- a/Documentation/development/building-documentation.adoc +++ b/Documentation/contributing/building-documentation.adoc @@ -1,6 +1,6 @@ = Building Documentation -:page-parent: Development -:page-nav_order: 5 +:page-parent: Contributing +:page-nav_order: 3 // SPDX-FileCopyrightText: 2022 Unikie // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 @@ -49,4 +49,4 @@ modify any of those, or add new ones, run `scripts/build.sh` again to do a full rebuild of the site. After making changes to the documentation, see how to -xref:first-patch.adoc[send your patch] and submit the changes for review. +xref:../development/first-patch.adoc[send your patch] and submit the changes for review. diff --git a/Documentation/contributing/communication.adoc b/Documentation/contributing/communication.adoc new file mode 100644 index 0000000..8b92d56 --- /dev/null +++ b/Documentation/contributing/communication.adoc @@ -0,0 +1,89 @@ += Communication in Spectrum +:description: Channels, announcements and so on. +:page-nav_order: 1 +:page-parent: Contributing + +// SPDX-FileCopyrightText: 2023 Unikie +// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 + +There are several places online in which announcements, +discussion, and collaboration happen. Rather than tell +you about them all at once, though, it is best to tell you +which ones are relevant to you, given how you would like +to participate (or not) in the project. + +Our primary methods of communication are mailing lists and IRC. +If this is not how you are used to interacting with free +software projects, *DON'T PANIC*. + +We provide instructions for how to get started, and several +different interfaces for you to choose from depending on what workflow +(web, mail, Atom, etc.) makes you most comfortable. Details of these +will be explained further on, but first, you should figure out what +communication channels are actually relevant for you. + +If you are interested in keeping up to date with announcements from +Spectrum's developers, subscribe to *announce@spectrum-os.org*. +You can discuss Spectrum and related topics in real time on IRC, or +more long-form on spectrum-announce (_discuss@spectrum-os.org_). +Finally, development work happens in Spectrum's +xref:https://spectrum-os.org/git/[source repositories], and is +discussed on spectrum-devel (_devel@spectrum-os.org_). + + +== Internet Relay Chat + +There is a single Internet Relay Chat (IRC) channel, +xref:ircs://irc.libera.chat:6697/spectrum[spectrum:libera.chat] +on xref:https://libera.chat/[Libera.Chat], for all kinds of Spectrum +discussions.You can also join through xref:https://matrix.org/[Matrix] as +xref:https://matrix.to/#/#spectrum:libera.chat[spectrum:libera.chat]. +If you are new to IRC, you might find Matrix the easiest way to get started. +The channel is *logged*, but the logs are not available online yet. + + +== Mailing Lists + +If you are interested in participating in the project, or even just +following along with it, the best thing to do is subscribe to one or +more of the Spectrum mailing lists. + +If mailing lists are not your thing, that is okay! Try the +xref:https://spectrum-os.org/lists/hyperkitty/[Web UI], which allows +you to interact with the mailing lists much like a modern web forum. + +Each list has xref:https://spectrum-os.org/lists/archives/[archives] +that can also be accessed via the web, NNTP or Atom. You are strongly +encouraged to mirror them. + +[cols="1,1"] +|=== + %2B%7Cannounce(a)spectrum-os.org +|This is a one-way list where announcements +from Spectrum's developers will be posted. + +You can subscribe +xref:https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/[on the web], +or by sending mail to *announce-subscribe@spectrum-os.org*. + %2B%7Cdiscuss(a)spectrum-os.org +|This list contains high-level discussion about the project. + +You can subscribe +xref:https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/[on the web], +or by sending mail to *discuss-subscribe@spectrum-os.org*. + %2B%7Cdevel(a)spectrum-os.org +|This list is where low-level technical discussions happen, +and where patches are sent. + +There is a separate guide for the Spectrum development process, +including how patches are sent to this list and discussed. +For more information, see +xref:development/working-with-patches.adoc[Working with Patches]. + +You can subscribe +xref:https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/[on the web], or by sending mail to *devel-subscribe@spectrum-os.org*. + +|=== \ No newline at end of file diff --git a/Documentation/contributing/index.adoc b/Documentation/contributing/index.adoc new file mode 100644 index 0000000..71ffe0e --- /dev/null +++ b/Documentation/contributing/index.adoc @@ -0,0 +1,95 @@ += Contributing +:description: How to contribute changes to the Spectrum source repository. +:page-nav_order: 5 +:page-has_children: true + +// SPDX-FileCopyrightText: 2023 Unikie +// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 + +Thank you so much for your interest in contributing to Spectrum. +Having a healthy community of people who feel empowered to work +on the project is vital to its success. + +If you have any questions about the project, please +xref:../contributing/communication.adoc[get in touch] with +the community. We will gladly help you out! + + +== Contributing Code + +If you are interested in contributing code to Spectrum, +you can find the source repositories online: https://spectrum-os.org/git/. + +If you have made changes you would like to be included +in the official Spectrum distribution, please send patches +to the spectrum-devel mailing list (devel(a)spectrum-os.org) +For more information, see +xref:../development/working-with-patches.adoc[Working with Patches]. + +Sending patches to the list is easy — you can do it with Git, +straight from the command line. You do not have to set anything up +in your email client, and you do not have to subscribe to the list. +The only thing you need to do is probably to set up Git so it knows +how to send email using your provider's SMTP server. +These instructions https://git-send-email.io/ should be enough +to get you going. If you are still stuck, send an email +to *devel@spectrum-os.org* and we will help you out. + +Once you have Git configured correctly, sending your changes to the +list should be as simple as something like: + +[listing] +[source,shell] +git send-email origin/master --to devel(a)spectrum-os.org + +You will be CCed on replies to your posts, so you do not even have to be +subscribed to the mailing list if you are worried about too much traffic. +There is also a web interface https://spectrum-os.org/lists/hyperkitty/ +that you can use to browse or even post to the mailing list. + +Add a Signed-off-by line to each patch you submit, to indicate your +certification of the xref:https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's Certificate of Origin] for that patch. +The easiest way to do this is with `git commit's -s` flag. + +Do not be too afraid of getting it wrong the first couple of times. +This might well be a new way of collaborating for you, and everybody +understands that. Hopefully, you will soon realise just how effective +this style of collaboration can be compared to the alternatives. + +== Contributing Documentation + +If you notice something that can be fixed or improved: + +. xref:https://spectrum-os.org/doc/development/first-patch.html#making-change… or add any relevant documentation]. ++ +TIP: Make sure your changes are formatted correctly and consistently +with the rest of the documentation. For information on writing guidelines, +see xref:../contributing/writing_documentation.adoc[Documentation Style Guide]. ++ +. xref:../contributing/building-documentation.adoc[Test your documentation]. +Reread what you wrote and run a spellchecker on it to make sure you did not miss anything. +. xref:https://spectrum-os.org/doc/development/first-patch.html#submitting-ch… changes]. + + +=== Documentation To-Do List + +Spectrum documentation needs are: + +* Reporting Bugs +* Development conventions/style (code review, naming) +* Integration, code philosophy + +The list will be updated. Improvements to the documentation are welcome! + +== Contributing Other Things + +At this stage, it is difficult to say what things would be useful +to the project beyond code and documentation. Artwork will be +extremely important and valuable. But, do not let that dissuade you! +At some point, we will need all sorts of things, and we might as well +get the work done early if people are willing to do it. + +If you think you have skills to offer the project beyond writing code, +we would love to hear from you. The best thing to do is to either talk +with us on spectrum-discuss, or in real time on IRC. +For more information, see xref:../contributing/communication.adoc[Communication in Spectrum]. \ No newline at end of file diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/contributing/writing_documentation.adoc new file mode 100644 index 0000000..9c1d5fb --- /dev/null +++ b/Documentation/contributing/writing_documentation.adoc @@ -0,0 +1,104 @@ += Documentation Style Guide +:description: Channels, announcements and so on. +:page-nav_order: 2 +:page-parent: Contributing + +// SPDX-FileCopyrightText: 2023 Unikie +// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 + +Here you can find the standards we follow for writing, +formatting, and organizing the Spectrum documentation. +Please follow these guidelines and conventions +when editing the documentation. + +We use xref:https://nixos.org/manual/nix/stable/introduction.html[Nix] +and xref:https://github.com/just-the-docs/just-the-docs[Just the Docs] +for building the documentation. Sources are written in AsciiDoc +If you are new with it, +see xref:https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]. + +If you want to test your changes, +see xref:../contributing/building-documentation.adoc[Building Documentation]. + +== Philosophy + +* 1 change = 1 patch +* Update the documentation with the code. +* Organize the AsciiDoc files into subdirectories. +* Keep separate documentation for every different process +to avoid confusion. +* Do not assume that readers know everything you currently know. +* Avoid jargon and acronyms, if you can. +* Avoid multiple variations or spellings to refer to the same +function, element, and so on. +* Write short and useful documents. Cut out everything unnecessary, +while also making a habit of continually improving every doc +to suit your changing needs. + + +== Document Layout + +* xref:https://docs.asciidoctor.org/asciidoc/latest/document/header/[Document header]: +include your name and a revision line following the author line. Example: + + = Document Title + :description: Some words about the content. + Author Name <author(a)example.org> + v1.0, 2012-02-10 + //empty line that ends the document header + +* Licensing: include license information after a document header. For example: + + // SPDX-FileCopyrightText: year / Name, surname / email address or the company name + // SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 + +* Double space: the double space after the period is deliberate. +Some people find it improves readability, and others do not like it, +but the reason we use it in Spectrum documentation is that it allows +text editors (Emacs) to differentiate between the ends of sentences +and abbreviations (like "etc."), which means that you can make commands +like "move to the next sentence" work accurately even if those +abbreviations are used. + +* Character line limit: +** Keep text hard-wrapped at 70-80 characters. (Most editors should be able +to do this automatically.) This makes it easier to pick out specific parts +in review, and also makes it easier to read in some editors. (It does not make a difference to the result as rendered in the web browser.) +** Keep the text in the description attribute hard-wrapped as well. For more information, see the xref:https://docs.asciidoctor.org/asciidoc/latest/document/metadata/#descri… Metadata] section of the Asciidoctor Docs. + +* Put one sentence on each line. This makes it easy to move content around, and also easy to spot (too) long sentences. For more information, see xref:https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sente… Recommended Practices]. + +== Structure + +* Use subheading to organize information. +* One topic per article. +* To make accents, use xref:https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/[admon…. +* Use numbered lists for actions that happen in sequence. +* Do not use parenthesis for additional information, make a separate sentence instead. + + +== Language + +=== Plain English + +Plain language is a universal language that makes information clear and better to understand. + +* Short, sharp sentences. +* Use simple tenses. +* Write in an active voice. +* Understandable language, fewer gerunds. +* Do not contract the words: use cannot instead of can’t. +* Write the full name when first mentioned with the acronym in brackets. +* Use numerals for numbers. +* Do not use Latin words. For example: +** perform operations, *etc.* => perform operations, *and so on* +** *e.g.* a Microsoft SQL Server => *for example,* a Microsoft SQL Server +** *via* the system => *through* the system + +=== Spelling + +* Use standard United States (U.S.) English. In cases where US spelling differs +from UK spelling, use the US spelling. There is no need to fix one by +replacing it with the other. +* When you use filenames, URLs, and data parameters in examples, try to avoid words that are spelled differently by different groups of English speakers. +* Use serial (Oxford) commas. diff --git a/Documentation/development/index.adoc b/Documentation/development/index.adoc index 1fccdd5..6b48418 100644 --- a/Documentation/development/index.adoc +++ b/Documentation/development/index.adoc @@ -15,13 +15,16 @@ Spectrum is free software, currently under active development. * https://nixos.org/manual/nix/stable/introduction.html[Nix package manager] * https://docs.asciidoctor.org/[AsciiDoc] for writing the documentation +TIP: For information on writing guidelines, +see xref:../contributing/writing_documentation.adoc[Documentation Style Guide]. + == Mailing Lists The Spectrum project runs several -https://spectrum-os.org/participating.html#mailing-lists[mailing lists] on +xref:../contributing/communication.adoc[mailing lists] on which you can ask your questions or help other people with the questions they have. All the Spectrum developers as well as many long time Linux and Spectrum users are on the lists. For real-time feedback, use -https://spectrum-os.org/participating.html#irc[IRC/Matrix channel]. +xref:../contributing/communication.adoc[IRC/Matrix channel]. diff --git a/Documentation/development/uuid-reference.adoc b/Documentation/development/uuid-reference.adoc index 81300ee..5247726 100644 --- a/Documentation/development/uuid-reference.adoc +++ b/Documentation/development/uuid-reference.adoc @@ -55,6 +55,6 @@ The Spectrum installer system. == Finding Undocumented UUIDs -Running the Documentation/scripts/undocumented-uuids.sh script from +Running the `Documentation/scripts/undocumented-uuids.sh` script from the root of the Spectrum repository will scan the entire tree for UUIDs not mentioned in this document. diff --git a/Documentation/index.adoc b/Documentation/index.adoc index 51a6e7d..cc25fd3 100644 --- a/Documentation/index.adoc +++ b/Documentation/index.adoc @@ -28,5 +28,5 @@ Once you are up and running, see xref:development/index.adoc[Development] to understand how to work with Spectrum's code and participate in the collaborative development process. -If you are thinking of contributing to the Spectrum docs, see - xref:development/building-documentation.adoc[Building Documentation]. +If you are thinking of contributing to the Spectrum code or docs, see + xref:contributing/index.adoc[Contributing]. -- 2.34.1

3 2

[PATCH] rootfs: make rootfs kernel configurable
by Ivan Nikolaenko 10 Jan '23

10 Jan '23

This patch makes it possible to use custom linux kernel. This is needed in case of porting Spectrum OS to the other hardware than generic-x86. To override rootfs kernel, define "spectrum_kernel" in the customization overlay. Signed-off-by: Ivan Nikolaenko <ivan.nikolaenko(a)unikie.com> --- host/rootfs/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/host/rootfs/default.nix b/host/rootfs/default.nix index 0a84f55..b853250 100644 --- a/host/rootfs/default.nix +++ b/host/rootfs/default.nix @@ -81,7 +81,7 @@ let imports = [ (modulesPath + "/profiles/all-hardware.nix") ]; }); - kernel = pkgs.linux_latest; + kernel = pkgs.spectrum_kernel or pkgs.linux_latest; appvm = import ../../img/app { inherit config; -- 2.34.1

2 2

[PATCH v2 1/2] Add flakes support
by Valentin Kharin 10 Jan '23

10 Jan '23

Signed-off-by: Valentin Kharin <valentin.kharin(a)unikie.com> --- flake.lock | 43 ++++++++++++++++++++++++++++++++ flake.lock.license | 3 +++ flake.nix | 62 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 108 insertions(+) create mode 100644 flake.lock create mode 100644 flake.lock.license create mode 100644 flake.nix diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..aa4ee5e --- /dev/null +++ b/flake.lock @@ -0,0 +1,43 @@ +{ + "nodes": { + "flake-utils": { + "locked": { + "lastModified": 1667395993, + "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1669635185, + "narHash": "sha256-vYg6GjnsEWNWt/4TmfFN9WtQmSXb4S796J2UOfyTcW0=", + "ref": "refs/heads/rootfs", + "rev": "3176ddef4b4cec85faa2f49d29ce74816d452dc0", + "revCount": 429673, + "type": "git", + "url": "https://spectrum-os.org/git/nixpkgs/" + }, + "original": { + "ref": "refs/heads/rootfs", + "type": "git", + "url": "https://spectrum-os.org/git/nixpkgs/" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.lock.license b/flake.lock.license new file mode 100644 index 0000000..a8a7980 --- /dev/null +++ b/flake.lock.license @@ -0,0 +1,3 @@ +SPDX-License-Identifier: CC0-1.0 +SPDX-FileCopyrightText: 2022 Unikie + diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..ab54fed --- /dev/null +++ b/flake.nix @@ -0,0 +1,62 @@ +# SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Unikie + +{ + description = "A compartmentalized operating system"; + + # NOTE: Revision specification format is ?ref=refs%2fheads%2f<BRANCH>&rev=<COMMIT_REVISION> + inputs.nixpkgs.url = + "git+https://spectrum-os.org/git/nixpkgs/?ref=refs%2fheads%2frootfs"; + inputs.flake-utils.url = "github:numtide/flake-utils"; + + nixConfig = { + extra-substituters = [ "https://cache.dataaturservice.se/spectrum/" ]; + trusted-public-keys = [ + "cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=" + "spectrum-os.org-1:rnnSumz3+Dbs5uewPlwZSTP0k3g/5SRG4hD7Wbr9YuQ=" + ]; + }; + + outputs = { self, nixpkgs, flake-utils }: + let + supportedSystems = with flake-utils.lib.system; [ x86_64-linux aarch64-linux ]; + in flake-utils.lib.eachSystem supportedSystems (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + config = { inherit pkgs; }; + lib = pkgs.lib; + + mkEntryPoint = { name ? builtins.baseNameOf path, path + , enableShell ? true, enablePackage ? true }: + let + shell = { + # NOTE: https://stackoverflow.com/a/43850372 + devShells.${name} = + import (path + "/shell.nix") { inherit config; }; + }; + package = { packages.${name} = import path { inherit config; }; }; + in (if enableShell then shell else { }) + // (if enablePackage then package else { }); + + # Entry point is a directory with shell.nix and default.nix + # This function maps every entry point to corresponding devShell and package + mapEntryPoints = epoints: + builtins.foldl' lib.recursiveUpdate { } (map mkEntryPoint epoints); + in lib.recursiveUpdate (mapEntryPoints [ + { + path = ./.; + enablePackage = false; + } + { path = ./host/initramfs; } + { path = ./host/rootfs; } + { path = ./host/start-vm; } + { path = ./img/app; } + { path = ./release/live; } + { path = ./vm/sys/net; } + ]) { + # Add some other flake schema related stuff here. + # NOTE: flake-utils.lib.eachDefaultSystem automagically adds ${system}. + devShells.documentation = import ./Documentation { inherit config; }; + packages.documentation = import ./Documentation { inherit config; }; + }); +} -- 2.38.1

2 2