- Spectrum Development - spectrum-os.org

Vhost-guest (was virtio vhost-user) vs virtio-msg
by Demi Marie Obenour 28 May '26

28 May '26

On 5/28/26 01:47, Manos Pitsidianakis wrote: > On Thu, May 28, 2026 at 8:22 AM Parav Pandit <parav(a)nvidia.com> wrote: >> >> >>> From: Demi Marie Obenour <demiobenour(a)gmail.com> >>> Sent: 28 May 2026 05:23 AM >>> To: virtio-comment(a)lists.linux.dev >>> Subject: MSI-X vector limits and reserving a virtio device ID >>> >>> I'd like to reserve a virtio device ID for virtio vhost-guest, >>> formally virtio vhost-user. Would this be possible? >>> >> Vhost user is an implementation of the device. >> I believe it stays as implementation and not a new device type. > > This exactly. > > Furthermore, we already have a mechanism for "providing" an arbitrary > virtio device; it's called a transport. > > Demi, I suggest you look into virtio-msg transport, which would allow > you to do what you want. I'm aware of virtio-msg, and in fact considered using it. However, I found that virtio-msg doesn't meet my requirements. 1. Virtio-msg needs to run over a transport of its own. None of the proposed transports support KVM guests on x86. FF-A is the only one that would make sense with KVM, but FF-A is specific to Arm. 2. Virtio-msg isn't compatible with existing frontend VMMs. Vhost-guest can be used with any frontend VMM that implements vhost-user. 3. Virtio-msg isn't compatible with existing frontend drivers. While I expect that drivers for Linux will eventually be upstreamed, I doubt that drivers for Windows or *BSD will ever be written. I don't even know if the Windows Driver Framework provides enough to write one. I don't need this myself, but I suspect that this is enough to make virtio-msg unsuitable in many environments. 4. Virtio-msg requires invasive changes to existing userspace device implementations. The project I work on doesn't use QEMU, and the existing frontends are targeted at server use-cases. Using the vhost-user protocol lets me reuse these with little effort. 5. To the best of my knowledge, virtio-msg doesn't support live migration of frontend VMs. Vhost-guest uses the vhost-user protocol, which has supported this for a very long time. I don't need live migration myself, but for many server use-cases, not having live migration is a dealbreaker. 6. I don't know if virtio-msg can achieve comparable performance. It appears to be optimized for reliability and isolation, not processing tens of gigabits of network traffic per second. Vhost-guest is designed with performance in mind. Vhost-guest is designed for storage and networking appliances on servers, whereas virtio-msg is designed for safety-critical embedded systems. These domains have very different requirements, and as a result they arrived at very different solutions. I work on Spectrum (https://spectrum-os.org) which uses Cloud Hypervisor. As the name implies, Cloud Hypervisor is primarily intended for cloud workloads, though it can also be used on clients. I don't think that an implementation of virtio-msg would be accepted, as it benefits none of Cloud Hypervisor's other users. -- Sincerely, Demi Marie Obenour (she/her/hers)

4 3

[PATCH v1] Documentation: render the whole site through Jekyll
by Valentin Gagarin 28 May '26

28 May '26

With the website merged in, there's no longer a reason to handle the landing pages and the documentation through separate pipelines. Also reinstate the relevant parts of the www README for the static pages for the time being, and update the license informaton accordingly. To keep behavior as it is and the diff minimal, patch the documentation site header to point to the documentation instead of the toplevel. --- Documentation/README | 30 ++++++++++++++++++ Documentation/README.license | 1 + Documentation/_config.yml | 3 +- Documentation/_plugins/site_title_link.rb | 10 ++++++ Documentation/{www => }/bibliography.html | 0 Documentation/{www => }/contributing.html | 0 Documentation/default.nix | 4 ++- Documentation/{www => }/design.html | 0 .../{ => doc}/about/architecture.adoc | 0 Documentation/{ => doc}/about/index.adoc | 0 .../{ => doc}/about/requirements.adoc | 0 Documentation/{ => doc}/contributing/b4.adoc | 0 .../contributing/building-documentation.adoc | 0 .../{ => doc}/contributing/communication.adoc | 0 .../{ => doc}/contributing/first-patch.adoc | 0 .../{ => doc}/contributing/index.adoc | 0 .../{ => doc}/contributing/replying.adoc | 0 .../contributing/reviewing-patches.adoc | 0 .../contributing/testing-patches.adoc | 0 .../contributing/working-with-patches.adoc | 0 .../contributing/writing_documentation.adoc | 0 ...architecture-decision-record-template.adoc | 0 .../decisions/001-host-update-mechanism.adoc | 0 .../decisions/002-install-options.adoc | 0 .../{ => doc}/decisions/003-partitioning.adoc | 0 .../004-data-at-rest-encryption.adoc | 0 .../005-virtual-machine-monitor.adoc | 0 .../decisions/006-drivers-on-host.adoc | 0 .../decisions/007-usb-virtual-machines.adoc | 0 ...008-inter-vm-communication-mechanisms.adoc | 0 Documentation/{ => doc}/decisions/index.adoc | 0 .../development/build-configuration.adoc | 0 .../{ => doc}/development/built-in-vms.adoc | 0 .../{ => doc}/development/checks.adoc | 0 .../{ => doc}/development/debugging.adoc | 0 .../{ => doc}/development/index.adoc | 0 .../development/persistent-storage.adoc | 0 .../{ => doc}/development/release.adoc | 0 .../{ => doc}/development/updates.adoc | 0 .../{ => doc}/development/uuid-reference.adoc | 0 Documentation/{ => doc}/index.adoc | 0 .../{ => doc}/installation/binary-cache.adoc | 0 .../installation/getting-spectrum.adoc | 0 .../{ => doc}/installation/index.adoc | 0 .../using-spectrum/creating-custom-vms.adoc | 0 .../{ => doc}/using-spectrum/index.adoc | 0 .../{ => doc}/using-spectrum/running-vms.adoc | 0 .../using-spectrum/vm-file-access.adoc | 0 Documentation/{www => }/impressum.html | 0 Documentation/{www => }/index.html | 0 Documentation/{www => }/logo/index.html | 0 Documentation/{www => }/logo/logo140.png | Bin .../{www => }/logo/logo140.png.license | 0 Documentation/{www => }/logo/logo200.png | Bin .../{www => }/logo/logo200.png.license | 0 Documentation/{www => }/logo/logo400.png | Bin .../{www => }/logo/logo400.png.license | 0 Documentation/{www => }/logo/logo70.png | Bin .../{www => }/logo/logo70.png.license | 0 Documentation/{www => }/logo/logo_html.svg | 0 Documentation/{www => }/logo/logo_mesh.svg | 0 Documentation/{www => }/motivation.html | 0 .../software/cloud-hypervisor/index.html | 0 Documentation/{www => }/software/index.html | 0 Documentation/{www => }/style.css | 0 Documentation/www/README | 12 ------- release/checks/doc-links.nix | 6 ++-- 67 files changed, 47 insertions(+), 19 deletions(-) create mode 100644 Documentation/_plugins/site_title_link.rb rename Documentation/{www => }/bibliography.html (100%) rename Documentation/{www => }/contributing.html (100%) rename Documentation/{www => }/design.html (100%) rename Documentation/{ => doc}/about/architecture.adoc (100%) rename Documentation/{ => doc}/about/index.adoc (100%) rename Documentation/{ => doc}/about/requirements.adoc (100%) rename Documentation/{ => doc}/contributing/b4.adoc (100%) rename Documentation/{ => doc}/contributing/building-documentation.adoc (100%) rename Documentation/{ => doc}/contributing/communication.adoc (100%) rename Documentation/{ => doc}/contributing/first-patch.adoc (100%) rename Documentation/{ => doc}/contributing/index.adoc (100%) rename Documentation/{ => doc}/contributing/replying.adoc (100%) rename Documentation/{ => doc}/contributing/reviewing-patches.adoc (100%) rename Documentation/{ => doc}/contributing/testing-patches.adoc (100%) rename Documentation/{ => doc}/contributing/working-with-patches.adoc (100%) rename Documentation/{ => doc}/contributing/writing_documentation.adoc (100%) rename Documentation/{ => doc}/decisions/000-lightweight-architecture-decision-record-template.adoc (100%) rename Documentation/{ => doc}/decisions/001-host-update-mechanism.adoc (100%) rename Documentation/{ => doc}/decisions/002-install-options.adoc (100%) rename Documentation/{ => doc}/decisions/003-partitioning.adoc (100%) rename Documentation/{ => doc}/decisions/004-data-at-rest-encryption.adoc (100%) rename Documentation/{ => doc}/decisions/005-virtual-machine-monitor.adoc (100%) rename Documentation/{ => doc}/decisions/006-drivers-on-host.adoc (100%) rename Documentation/{ => doc}/decisions/007-usb-virtual-machines.adoc (100%) rename Documentation/{ => doc}/decisions/008-inter-vm-communication-mechanisms.adoc (100%) rename Documentation/{ => doc}/decisions/index.adoc (100%) rename Documentation/{ => doc}/development/build-configuration.adoc (100%) rename Documentation/{ => doc}/development/built-in-vms.adoc (100%) rename Documentation/{ => doc}/development/checks.adoc (100%) rename Documentation/{ => doc}/development/debugging.adoc (100%) rename Documentation/{ => doc}/development/index.adoc (100%) rename Documentation/{ => doc}/development/persistent-storage.adoc (100%) rename Documentation/{ => doc}/development/release.adoc (100%) rename Documentation/{ => doc}/development/updates.adoc (100%) rename Documentation/{ => doc}/development/uuid-reference.adoc (100%) rename Documentation/{ => doc}/index.adoc (100%) rename Documentation/{ => doc}/installation/binary-cache.adoc (100%) rename Documentation/{ => doc}/installation/getting-spectrum.adoc (100%) rename Documentation/{ => doc}/installation/index.adoc (100%) rename Documentation/{ => doc}/using-spectrum/creating-custom-vms.adoc (100%) rename Documentation/{ => doc}/using-spectrum/index.adoc (100%) rename Documentation/{ => doc}/using-spectrum/running-vms.adoc (100%) rename Documentation/{ => doc}/using-spectrum/vm-file-access.adoc (100%) rename Documentation/{www => }/impressum.html (100%) rename Documentation/{www => }/index.html (100%) rename Documentation/{www => }/logo/index.html (100%) rename Documentation/{www => }/logo/logo140.png (100%) rename Documentation/{www => }/logo/logo140.png.license (100%) rename Documentation/{www => }/logo/logo200.png (100%) rename Documentation/{www => }/logo/logo200.png.license (100%) rename Documentation/{www => }/logo/logo400.png (100%) rename Documentation/{www => }/logo/logo400.png.license (100%) rename Documentation/{www => }/logo/logo70.png (100%) rename Documentation/{www => }/logo/logo70.png.license (100%) rename Documentation/{www => }/logo/logo_html.svg (100%) rename Documentation/{www => }/logo/logo_mesh.svg (100%) rename Documentation/{www => }/motivation.html (100%) rename Documentation/{www => }/software/cloud-hypervisor/index.html (100%) rename Documentation/{www => }/software/index.html (100%) rename Documentation/{www => }/style.css (100%) delete mode 100644 Documentation/www/README diff --git a/Documentation/README b/Documentation/README index 85673f0..8c7af40 100644 --- a/Documentation/README +++ b/Documentation/README @@ -1,2 +1,32 @@ +These files contain the static portion of the website accessible at +<https://spectrum-os.org/>. CGit, Mailman, etc, are run seperately. + +If you would like to contribute to the Spectrum operating system itself, please +refer to the contributing.html file. + If you'd like to contribute to the documentation, see building-documentation.adoc for how to get started. + +Design tweaks, content updates, fixes (both factual and grammatical), +and new content for the Spectrum website are all welcomed. + +Try to keep lines at around 70 characters, HTML out of the way as much +as possible while still being valid (did you know <p> can +self-close?), and CSS to a minimum. We want to optimise for the +website being as nice as possible to navigate in a text editor, to +encourage people to edit and improve the website. + +For any changes that are likely to be copyrightable (i.e. those that +involve any amount of creative input from you), please add an +SPDX-FileCopyrightText header to the file so we can keep track of +copyright holders. Every file should already have at least one +example of these that you can use as a template. If you'd rather not +list your email address in the copyright notice, it's fine to omit +that. + +The content of these web pages may be redistributed under the terms of +either the CC-BY-SA license (version 4.0 or later), or the GNU Free +Documentation License (version 1.2 or later), at your option. + +The source code of these web pages may be redistributed under the +terms of the GNU General Public License (version 3.0 or later). diff --git a/Documentation/README.license b/Documentation/README.license index b50fd9e..857eeba 100644 --- a/Documentation/README.license +++ b/Documentation/README.license @@ -1,2 +1,3 @@ SPDX-FileCopyrightText: Unikie +SPDX-FileCopyrightText: 2019 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/_config.yml b/Documentation/_config.yml index 277992d..df84cb5 100644 --- a/Documentation/_config.yml +++ b/Documentation/_config.yml @@ -2,7 +2,7 @@ # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> --- title: Spectrum documentation -logo: "https://spectrum-os.org/logo/logo_html.svg" +logo: /logo/logo_html.svg theme: just-the-docs aux_links: Home: @@ -15,7 +15,6 @@ exclude: - '*.license' - '*.nix' - /scripts - - /www - README - result* asciidoctor: diff --git a/Documentation/_plugins/site_title_link.rb b/Documentation/_plugins/site_title_link.rb new file mode 100644 index 0000000..4095701 --- /dev/null +++ b/Documentation/_plugins/site_title_link.rb @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin(a)gagarin.work> + +# Just the Docs hardcodes the site header link to `/`. +# https://github.com/just-the-docs/just-the-docs/blob/v0.10.1/_includes/compo… +# Make it point to the docs root, not the top-level site. +Jekyll::Hooks.register [:pages, :documents], :post_render do |item| + item.output.sub!('<a href="/" class="site-title', + '<a href="/doc/" class="site-title') +end diff --git a/Documentation/www/bibliography.html b/Documentation/bibliography.html similarity index 100% rename from Documentation/www/bibliography.html rename to Documentation/bibliography.html diff --git a/Documentation/www/contributing.html b/Documentation/contributing.html similarity index 100% rename from Documentation/www/contributing.html rename to Documentation/contributing.html diff --git a/Documentation/default.nix b/Documentation/default.nix index 8453e87..3b9e973 100644 --- a/Documentation/default.nix +++ b/Documentation/default.nix @@ -17,10 +17,12 @@ stdenvNoCC.mkDerivation { buildPhase = '' runHook preBuild - jekyll build --disable-disk-cache -b /doc -d $out + jekyll build --disable-disk-cache -d $out runHook postBuild ''; + # The fixup phase would move `doc` to `share/doc` and we don't want that. + dontFixup = true; dontInstall = true; nativeBuildInputs = [ (callSpectrumPackage ./jekyll.nix {}) ]; diff --git a/Documentation/www/design.html b/Documentation/design.html similarity index 100% rename from Documentation/www/design.html rename to Documentation/design.html diff --git a/Documentation/about/architecture.adoc b/Documentation/doc/about/architecture.adoc similarity index 100% rename from Documentation/about/architecture.adoc rename to Documentation/doc/about/architecture.adoc diff --git a/Documentation/about/index.adoc b/Documentation/doc/about/index.adoc similarity index 100% rename from Documentation/about/index.adoc rename to Documentation/doc/about/index.adoc diff --git a/Documentation/about/requirements.adoc b/Documentation/doc/about/requirements.adoc similarity index 100% rename from Documentation/about/requirements.adoc rename to Documentation/doc/about/requirements.adoc diff --git a/Documentation/contributing/b4.adoc b/Documentation/doc/contributing/b4.adoc similarity index 100% rename from Documentation/contributing/b4.adoc rename to Documentation/doc/contributing/b4.adoc diff --git a/Documentation/contributing/building-documentation.adoc b/Documentation/doc/contributing/building-documentation.adoc similarity index 100% rename from Documentation/contributing/building-documentation.adoc rename to Documentation/doc/contributing/building-documentation.adoc diff --git a/Documentation/contributing/communication.adoc b/Documentation/doc/contributing/communication.adoc similarity index 100% rename from Documentation/contributing/communication.adoc rename to Documentation/doc/contributing/communication.adoc diff --git a/Documentation/contributing/first-patch.adoc b/Documentation/doc/contributing/first-patch.adoc similarity index 100% rename from Documentation/contributing/first-patch.adoc rename to Documentation/doc/contributing/first-patch.adoc diff --git a/Documentation/contributing/index.adoc b/Documentation/doc/contributing/index.adoc similarity index 100% rename from Documentation/contributing/index.adoc rename to Documentation/doc/contributing/index.adoc diff --git a/Documentation/contributing/replying.adoc b/Documentation/doc/contributing/replying.adoc similarity index 100% rename from Documentation/contributing/replying.adoc rename to Documentation/doc/contributing/replying.adoc diff --git a/Documentation/contributing/reviewing-patches.adoc b/Documentation/doc/contributing/reviewing-patches.adoc similarity index 100% rename from Documentation/contributing/reviewing-patches.adoc rename to Documentation/doc/contributing/reviewing-patches.adoc diff --git a/Documentation/contributing/testing-patches.adoc b/Documentation/doc/contributing/testing-patches.adoc similarity index 100% rename from Documentation/contributing/testing-patches.adoc rename to Documentation/doc/contributing/testing-patches.adoc diff --git a/Documentation/contributing/working-with-patches.adoc b/Documentation/doc/contributing/working-with-patches.adoc similarity index 100% rename from Documentation/contributing/working-with-patches.adoc rename to Documentation/doc/contributing/working-with-patches.adoc diff --git a/Documentation/contributing/writing_documentation.adoc b/Documentation/doc/contributing/writing_documentation.adoc similarity index 100% rename from Documentation/contributing/writing_documentation.adoc rename to Documentation/doc/contributing/writing_documentation.adoc diff --git a/Documentation/decisions/000-lightweight-architecture-decision-record-template.adoc b/Documentation/doc/decisions/000-lightweight-architecture-decision-record-template.adoc similarity index 100% rename from Documentation/decisions/000-lightweight-architecture-decision-record-template.adoc rename to Documentation/doc/decisions/000-lightweight-architecture-decision-record-template.adoc diff --git a/Documentation/decisions/001-host-update-mechanism.adoc b/Documentation/doc/decisions/001-host-update-mechanism.adoc similarity index 100% rename from Documentation/decisions/001-host-update-mechanism.adoc rename to Documentation/doc/decisions/001-host-update-mechanism.adoc diff --git a/Documentation/decisions/002-install-options.adoc b/Documentation/doc/decisions/002-install-options.adoc similarity index 100% rename from Documentation/decisions/002-install-options.adoc rename to Documentation/doc/decisions/002-install-options.adoc diff --git a/Documentation/decisions/003-partitioning.adoc b/Documentation/doc/decisions/003-partitioning.adoc similarity index 100% rename from Documentation/decisions/003-partitioning.adoc rename to Documentation/doc/decisions/003-partitioning.adoc diff --git a/Documentation/decisions/004-data-at-rest-encryption.adoc b/Documentation/doc/decisions/004-data-at-rest-encryption.adoc similarity index 100% rename from Documentation/decisions/004-data-at-rest-encryption.adoc rename to Documentation/doc/decisions/004-data-at-rest-encryption.adoc diff --git a/Documentation/decisions/005-virtual-machine-monitor.adoc b/Documentation/doc/decisions/005-virtual-machine-monitor.adoc similarity index 100% rename from Documentation/decisions/005-virtual-machine-monitor.adoc rename to Documentation/doc/decisions/005-virtual-machine-monitor.adoc diff --git a/Documentation/decisions/006-drivers-on-host.adoc b/Documentation/doc/decisions/006-drivers-on-host.adoc similarity index 100% rename from Documentation/decisions/006-drivers-on-host.adoc rename to Documentation/doc/decisions/006-drivers-on-host.adoc diff --git a/Documentation/decisions/007-usb-virtual-machines.adoc b/Documentation/doc/decisions/007-usb-virtual-machines.adoc similarity index 100% rename from Documentation/decisions/007-usb-virtual-machines.adoc rename to Documentation/doc/decisions/007-usb-virtual-machines.adoc diff --git a/Documentation/decisions/008-inter-vm-communication-mechanisms.adoc b/Documentation/doc/decisions/008-inter-vm-communication-mechanisms.adoc similarity index 100% rename from Documentation/decisions/008-inter-vm-communication-mechanisms.adoc rename to Documentation/doc/decisions/008-inter-vm-communication-mechanisms.adoc diff --git a/Documentation/decisions/index.adoc b/Documentation/doc/decisions/index.adoc similarity index 100% rename from Documentation/decisions/index.adoc rename to Documentation/doc/decisions/index.adoc diff --git a/Documentation/development/build-configuration.adoc b/Documentation/doc/development/build-configuration.adoc similarity index 100% rename from Documentation/development/build-configuration.adoc rename to Documentation/doc/development/build-configuration.adoc diff --git a/Documentation/development/built-in-vms.adoc b/Documentation/doc/development/built-in-vms.adoc similarity index 100% rename from Documentation/development/built-in-vms.adoc rename to Documentation/doc/development/built-in-vms.adoc diff --git a/Documentation/development/checks.adoc b/Documentation/doc/development/checks.adoc similarity index 100% rename from Documentation/development/checks.adoc rename to Documentation/doc/development/checks.adoc diff --git a/Documentation/development/debugging.adoc b/Documentation/doc/development/debugging.adoc similarity index 100% rename from Documentation/development/debugging.adoc rename to Documentation/doc/development/debugging.adoc diff --git a/Documentation/development/index.adoc b/Documentation/doc/development/index.adoc similarity index 100% rename from Documentation/development/index.adoc rename to Documentation/doc/development/index.adoc diff --git a/Documentation/development/persistent-storage.adoc b/Documentation/doc/development/persistent-storage.adoc similarity index 100% rename from Documentation/development/persistent-storage.adoc rename to Documentation/doc/development/persistent-storage.adoc diff --git a/Documentation/development/release.adoc b/Documentation/doc/development/release.adoc similarity index 100% rename from Documentation/development/release.adoc rename to Documentation/doc/development/release.adoc diff --git a/Documentation/development/updates.adoc b/Documentation/doc/development/updates.adoc similarity index 100% rename from Documentation/development/updates.adoc rename to Documentation/doc/development/updates.adoc diff --git a/Documentation/development/uuid-reference.adoc b/Documentation/doc/development/uuid-reference.adoc similarity index 100% rename from Documentation/development/uuid-reference.adoc rename to Documentation/doc/development/uuid-reference.adoc diff --git a/Documentation/index.adoc b/Documentation/doc/index.adoc similarity index 100% rename from Documentation/index.adoc rename to Documentation/doc/index.adoc diff --git a/Documentation/installation/binary-cache.adoc b/Documentation/doc/installation/binary-cache.adoc similarity index 100% rename from Documentation/installation/binary-cache.adoc rename to Documentation/doc/installation/binary-cache.adoc diff --git a/Documentation/installation/getting-spectrum.adoc b/Documentation/doc/installation/getting-spectrum.adoc similarity index 100% rename from Documentation/installation/getting-spectrum.adoc rename to Documentation/doc/installation/getting-spectrum.adoc diff --git a/Documentation/installation/index.adoc b/Documentation/doc/installation/index.adoc similarity index 100% rename from Documentation/installation/index.adoc rename to Documentation/doc/installation/index.adoc diff --git a/Documentation/using-spectrum/creating-custom-vms.adoc b/Documentation/doc/using-spectrum/creating-custom-vms.adoc similarity index 100% rename from Documentation/using-spectrum/creating-custom-vms.adoc rename to Documentation/doc/using-spectrum/creating-custom-vms.adoc diff --git a/Documentation/using-spectrum/index.adoc b/Documentation/doc/using-spectrum/index.adoc similarity index 100% rename from Documentation/using-spectrum/index.adoc rename to Documentation/doc/using-spectrum/index.adoc diff --git a/Documentation/using-spectrum/running-vms.adoc b/Documentation/doc/using-spectrum/running-vms.adoc similarity index 100% rename from Documentation/using-spectrum/running-vms.adoc rename to Documentation/doc/using-spectrum/running-vms.adoc diff --git a/Documentation/using-spectrum/vm-file-access.adoc b/Documentation/doc/using-spectrum/vm-file-access.adoc similarity index 100% rename from Documentation/using-spectrum/vm-file-access.adoc rename to Documentation/doc/using-spectrum/vm-file-access.adoc diff --git a/Documentation/www/impressum.html b/Documentation/impressum.html similarity index 100% rename from Documentation/www/impressum.html rename to Documentation/impressum.html diff --git a/Documentation/www/index.html b/Documentation/index.html similarity index 100% rename from Documentation/www/index.html rename to Documentation/index.html diff --git a/Documentation/www/logo/index.html b/Documentation/logo/index.html similarity index 100% rename from Documentation/www/logo/index.html rename to Documentation/logo/index.html diff --git a/Documentation/www/logo/logo140.png b/Documentation/logo/logo140.png similarity index 100% rename from Documentation/www/logo/logo140.png rename to Documentation/logo/logo140.png diff --git a/Documentation/www/logo/logo140.png.license b/Documentation/logo/logo140.png.license similarity index 100% rename from Documentation/www/logo/logo140.png.license rename to Documentation/logo/logo140.png.license diff --git a/Documentation/www/logo/logo200.png b/Documentation/logo/logo200.png similarity index 100% rename from Documentation/www/logo/logo200.png rename to Documentation/logo/logo200.png diff --git a/Documentation/www/logo/logo200.png.license b/Documentation/logo/logo200.png.license similarity index 100% rename from Documentation/www/logo/logo200.png.license rename to Documentation/logo/logo200.png.license diff --git a/Documentation/www/logo/logo400.png b/Documentation/logo/logo400.png similarity index 100% rename from Documentation/www/logo/logo400.png rename to Documentation/logo/logo400.png diff --git a/Documentation/www/logo/logo400.png.license b/Documentation/logo/logo400.png.license similarity index 100% rename from Documentation/www/logo/logo400.png.license rename to Documentation/logo/logo400.png.license diff --git a/Documentation/www/logo/logo70.png b/Documentation/logo/logo70.png similarity index 100% rename from Documentation/www/logo/logo70.png rename to Documentation/logo/logo70.png diff --git a/Documentation/www/logo/logo70.png.license b/Documentation/logo/logo70.png.license similarity index 100% rename from Documentation/www/logo/logo70.png.license rename to Documentation/logo/logo70.png.license diff --git a/Documentation/www/logo/logo_html.svg b/Documentation/logo/logo_html.svg similarity index 100% rename from Documentation/www/logo/logo_html.svg rename to Documentation/logo/logo_html.svg diff --git a/Documentation/www/logo/logo_mesh.svg b/Documentation/logo/logo_mesh.svg similarity index 100% rename from Documentation/www/logo/logo_mesh.svg rename to Documentation/logo/logo_mesh.svg diff --git a/Documentation/www/motivation.html b/Documentation/motivation.html similarity index 100% rename from Documentation/www/motivation.html rename to Documentation/motivation.html diff --git a/Documentation/www/software/cloud-hypervisor/index.html b/Documentation/software/cloud-hypervisor/index.html similarity index 100% rename from Documentation/www/software/cloud-hypervisor/index.html rename to Documentation/software/cloud-hypervisor/index.html diff --git a/Documentation/www/software/index.html b/Documentation/software/index.html similarity index 100% rename from Documentation/www/software/index.html rename to Documentation/software/index.html diff --git a/Documentation/www/style.css b/Documentation/style.css similarity index 100% rename from Documentation/www/style.css rename to Documentation/style.css diff --git a/Documentation/www/README b/Documentation/www/README deleted file mode 100644 index 5723fb8..0000000 --- a/Documentation/www/README +++ /dev/null @@ -1,12 +0,0 @@ -SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> -SPDX-License-Identifier: CC0-1.0 - -These files contain the static portion of the website accessible at -<https://spectrum-os.org/>. CGit, Mailman, etc, are run separately. - -The content of these web pages may be redistributed under the terms of -either the CC-BY-SA license (version 4.0 or later), or the GNU Free -Documentation License (version 1.2 or later), at your option. - -The source code of these web pages may be redistributed under the -terms of the GNU General Public License (version 3.0 or later). diff --git a/release/checks/doc-links.nix b/release/checks/doc-links.nix index 882a0d5..77102d6 100644 --- a/release/checks/doc-links.nix +++ b/release/checks/doc-links.nix @@ -8,10 +8,8 @@ runCommand "spectrum-doc-links" { doc = callSpectrumPackage ../../Documentation {}; nativeBuildInputs = [ bozohttpd wget ]; } '' - mkdir root - ln -s $doc root/doc - httpd -bI 4000 root - wget -r -nv --delete-after --no-parent --retry-connrefused http://localhost:4000/doc/ + httpd -bI 4000 $doc + wget -r -nv --delete-after --no-parent --retry-connrefused http://localhost:4000/ touch $out '' ) (_: {}) -- 2.51.2

1 0

[PATCH] Documentation: add logo to site header
by Valentin Gagarin 27 May '26

27 May '26

Also spell out the title. The stylesheet adjustment makes the logo align properly with the longer title text for different display widths. Signed-off-by: Valentin Gagarin <valentin(a)gagarin.work> --- Documentation/_config.yml | 3 ++- Documentation/_sass/custom/custom.scss | 13 +++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/Documentation/_config.yml b/Documentation/_config.yml index 90018ba..192633b 100644 --- a/Documentation/_config.yml +++ b/Documentation/_config.yml @@ -1,7 +1,8 @@ # SPDX-License-Identifier: CC0-1.0 # SPDX-FileCopyrightText: 2022 Alyssa Ross <hi(a)alyssa.is> --- -title: Spectrum Docs +title: Spectrum OS documentation +logo: "https://spectrum-os.org/logo/logo_html.svg" theme: just-the-docs aux_links: Home: diff --git a/Documentation/_sass/custom/custom.scss b/Documentation/_sass/custom/custom.scss index fd5a676..75e3f16 100644 --- a/Documentation/_sass/custom/custom.scss +++ b/Documentation/_sass/custom/custom.scss @@ -20,3 +20,16 @@ margin-left: 2ch; } } + +.site-logo { + width: 3rem; +} + +@media (min-width: 50rem) { + .site-logo { + width: 5.5rem; + } + .site-title { + font-size: 1.25rem !important; + } +} -- 2.51.2

3 11

[PATCH] host/rootfs: Add scripts to access a VM by name
by Demi Marie Obenour 27 May '26

27 May '26

This is much more convenient than having to find a VM's ID. In the future, the programs that take a VM ID should be the suffixed ones, but this change avoids having to change any tests and so is simpler. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/rootfs/file-list.mk | 3 +++ host/rootfs/image/usr/bin/vm-console-by-name | 9 +++++++++ host/rootfs/image/usr/bin/vm-start-by-name | 9 +++++++++ host/rootfs/image/usr/bin/vm-stop-by-name | 9 +++++++++ 4 files changed, 30 insertions(+) diff --git a/host/rootfs/file-list.mk b/host/rootfs/file-list.mk index df22bce87f4685eda26382b4e0b0b6fd21025c7a..fd21034320a3de6f96a8eb229214b041612709e8 100644 --- a/host/rootfs/file-list.mk +++ b/host/rootfs/file-list.mk @@ -59,9 +59,12 @@ FILES = \ image/usr/bin/run-vmm \ image/usr/bin/spectrum-update \ image/usr/bin/vm-console \ + image/usr/bin/vm-console-by-name \ image/usr/bin/vm-import \ image/usr/bin/vm-start \ + image/usr/bin/vm-start-by-name \ image/usr/bin/vm-stop \ + image/usr/bin/vm-stop-by-name \ image/usr/bin/xdg-open \ image/usr/libexec/net-add \ image/usr/share/dbus-1/services/org.freedesktop.portal.Documents.service diff --git a/host/rootfs/image/usr/bin/vm-console-by-name b/host/rootfs/image/usr/bin/vm-console-by-name new file mode 100755 index 0000000000000000000000000000000000000000..a302b463ef1bd2c9ae180b6b2b9eae45a26856d6 --- /dev/null +++ b/host/rootfs/image/usr/bin/vm-console-by-name @@ -0,0 +1,9 @@ +#!/bin/execlineb -WS1 +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +# SPDX-FileCopyrightText: 2022-2023, 2025 Alyssa Ross <hi(a)alyssa.is> +backtick -E vm_id { + backtick -E id_path { readlink /run/vm/by-name/${1} } + basename -- $id_path +} +vm-console $vm_id diff --git a/host/rootfs/image/usr/bin/vm-start-by-name b/host/rootfs/image/usr/bin/vm-start-by-name new file mode 100755 index 0000000000000000000000000000000000000000..438a4a4610ddc9dea3394503e8d5e635468fbddd --- /dev/null +++ b/host/rootfs/image/usr/bin/vm-start-by-name @@ -0,0 +1,9 @@ +#!/bin/execlineb -WS1 +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +# SPDX-FileCopyrightText: 2022-2023, 2025 Alyssa Ross <hi(a)alyssa.is> +backtick -E vm_id { + backtick -E id_path { readlink /run/vm/by-name/${1} } + basename -- $id_path +} +vm-start $vm_id diff --git a/host/rootfs/image/usr/bin/vm-stop-by-name b/host/rootfs/image/usr/bin/vm-stop-by-name new file mode 100755 index 0000000000000000000000000000000000000000..07ca686b5ace86aceb0fdc0f9ace8ff3859f2b37 --- /dev/null +++ b/host/rootfs/image/usr/bin/vm-stop-by-name @@ -0,0 +1,9 @@ +#!/bin/execlineb -WS1 +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2025 Demi Marie Obenour <demiobenour(a)gmail.com> +# SPDX-FileCopyrightText: 2022-2023, 2025 Alyssa Ross <hi(a)alyssa.is> +backtick -E vm_id { + backtick -E id_path { readlink /run/vm/by-name/${1} } + basename -- $id_path +} +vm-stop $vm_id --- base-commit: a13d3403c1ddbb8dbbbdb05416350b2846162ed1 change-id: 20251201-vm-ops-by-name-6a5cb600f726 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 1

[PATCH] Don't rely on /bin/sh for running scripts
by Alyssa Ross 27 May '26

27 May '26

/bin/sh might be too old to run our scripts. We probably have a modern shell available via Nix though, so we can avoid causing problems for users of stale distros by using sh from path instead of /bin/sh. I've left the scripts with /bin/sh shebangs because I don't think there's a great alternative (using /usr/bin/env doesn't seem much better when there are features of env that might or might not be available), but those shebangs should now never be used as part of a build. Reported-by: Dan Connolly <dckc(a)madmode.com> Link: https://inbox.spectrum-os.org/spectrum-discuss/CAD2YivbRwDUzgXv32A2Otetunny… Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- Dan, thanks again for your report. I've been giving this a lot of thought in the background over the last few weeks. I don't think there's one solution that's better in every way than all the others, but I think this is the best compromise. Documentation/development/built-in-vms.adoc | 2 +- host/initramfs/Makefile | 8 ++++---- host/rootfs/Makefile | 10 +++++----- img/app/Makefile | 8 ++++---- lib/common.mk | 5 ++++- release/checks/integration/lib.c | 7 ++++--- release/checks/integration/meson.build | 2 +- release/live/Makefile | 8 ++++---- vm/sys/net/Makefile | 8 ++++---- 9 files changed, 31 insertions(+), 27 deletions(-) diff --git a/Documentation/development/built-in-vms.adoc b/Documentation/development/built-in-vms.adoc index d044e75..fb6b947 100644 --- a/Documentation/development/built-in-vms.adoc +++ b/Documentation/development/built-in-vms.adoc @@ -46,7 +46,7 @@ if the only change to the Nix files is modifying the packages installed in the VM. The list of files used for images is stored in a separate file, -file-list.mk. To update it, run scripts/genfiles.sh, which will +file-list.mk. To update it, run `sh scripts/genfiles.sh`, which will regenerate it from the output of `git ls-files`. This script uses Git's index to generate the list, so only staged changes will be reflected in its output. diff --git a/host/initramfs/Makefile b/host/initramfs/Makefile index 89f9a39..523b4b3 100644 --- a/host/initramfs/Makefile +++ b/host/initramfs/Makefile @@ -36,9 +36,9 @@ build/mountpoints: find build/mountpoints -mindepth 1 -exec touch -d @0 {} ';' build/live.img: ../../scripts/format-uuid.sh ../../scripts/make-gpt.sh ../../scripts/sfdisk-field.awk $(ROOT_FS_IMAGES) - ../../scripts/make-gpt.sh $@.tmp \ - $(ROOT_FS_VERITY):verity:$$(../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity' \ - $(ROOT_FS_IMAGE):root:$$(../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION)' + $(SHELL) ../../scripts/make-gpt.sh $@.tmp \ + $(ROOT_FS_VERITY):verity:$$($(SHELL) ../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity' \ + $(ROOT_FS_IMAGE):root:$$($(SHELL) ../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION)' mv $@.tmp $@ clean: @@ -46,7 +46,7 @@ clean: .PHONY: clean run: $(dest) $(ROOT_FS_VERITY_ROOTHASH) $(RUN_IMAGE) - @../../scripts/run-qemu.sh -m 4G \ + @$(SHELL) ../../scripts/run-qemu.sh -m 4G \ -machine virtualization=on \ -kernel $(KERNEL) \ -initrd $(dest) \ diff --git a/host/rootfs/Makefile b/host/rootfs/Makefile index 4f01e3e..dbfe65e 100644 --- a/host/rootfs/Makefile +++ b/host/rootfs/Makefile @@ -74,7 +74,7 @@ $(ROOT_FS_IMAGE): ../../scripts/make-erofs.sh $(PACKAGES_FILE) $(FILES) $(BUILD_ for file in $(BUILD_FILES); do printf '%s\n%s\n' $$file $${file#build/}; done ;\ printf 'build/empty\n%s\n' $(DIRS) ;\ printf 'build/fifo\n%s\n' $(FIFOS) ;\ - } | ../../scripts/make-erofs.sh $@ + } | $(SHELL) ../../scripts/make-erofs.sh $@ build/etc/update-url: mkdir -p build/etc @@ -113,9 +113,9 @@ clean: .PHONY: clean build/live.img: ../../scripts/format-uuid.sh ../../scripts/make-gpt.sh ../../scripts/sfdisk-field.awk build/verity-timestamp $(ROOT_FS_IMAGES) - ../../scripts/make-gpt.sh $@.tmp \ - $(ROOT_FS_VERITY):verity:$$(../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity' \ - $(ROOT_FS_IMAGE):root:$$(../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION)' + $(SHELL) ../../scripts/make-gpt.sh $@.tmp \ + $(ROOT_FS_VERITY):verity:$$($(SHELL) ../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity' \ + $(ROOT_FS_IMAGE):root:$$($(SHELL) ../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION)' mv $@.tmp $@ debug: @@ -133,7 +133,7 @@ run: build/empty build/live.img $(ROOTFS_VERITY_ROOTHASH) exec 3<>"$$ext" && \ rm -f "$$ext" && \ set +x && \ - exec ../../scripts/run-qemu.sh -cpu max -m 4G \ + exec $(SHELL) ../../scripts/run-qemu.sh -cpu max -m 4G \ -machine virtualization=on \ -kernel $(KERNEL) \ -initrd $(INITRAMFS) \ diff --git a/img/app/Makefile b/img/app/Makefile index 1de1b04..db453d4 100644 --- a/img/app/Makefile +++ b/img/app/Makefile @@ -26,7 +26,7 @@ $(imgdir)/appvm/vmlinux: $(KERNEL) $(imgdir)/appvm/blk/root.img: ../../scripts/make-gpt.sh ../../scripts/sfdisk-field.awk build/rootfs.erofs mkdir -p $$(dirname $@) - ../../scripts/make-gpt.sh $@.tmp \ + $(SHELL) ../../scripts/make-gpt.sh $@.tmp \ build/rootfs.erofs:root:5460386f-2203-4911-8694-91400125c604:root mv $@.tmp $@ @@ -54,7 +54,7 @@ build/rootfs.erofs: ../../scripts/make-erofs.sh $(PACKAGES_FILE) $(FILES) $(BUIL for file in $(BUILD_FILES); do printf '%s\n%s\n' $$file $${file#build/}; done ;\ printf 'build/empty\n%s\n' $(DIRS) ;\ printf 'build/fifo\n%s\n' $(FIFOS) ;\ - } | ../../scripts/make-erofs.sh $@ + } | $(SHELL) ../../scripts/make-erofs.sh $@ build/etc/s6-rc: $(S6_RC_FILES) file-list.mk @@ -91,7 +91,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 max -kernel $(KERNEL) -vga none \ + @$(SHELL) ../../scripts/run-qemu.sh -m 256 -cpu max -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 \ @@ -113,7 +113,7 @@ run-qemu: $(imgdir)/appvm/blk/root.img start-vhost-user-net start-virtiofsd run-cloud-hypervisor: $(imgdir)/appvm/blk/root.img start-vhost-user-gpu start-vhost-user-net start-virtiofsd rm -f build/vmm.sock build/vsock.sock - @../../scripts/run-cloud-hypervisor.sh \ + @$(SHELL) ../../scripts/run-cloud-hypervisor.sh \ --api-socket path=build/vmm.sock \ --memory size=1G,shared=on \ --disk path=$(imgdir)/appvm/blk/root.img,readonly=on \ diff --git a/lib/common.mk b/lib/common.mk index 84091a8..9896efe 100644 --- a/lib/common.mk +++ b/lib/common.mk @@ -1,5 +1,8 @@ # SPDX-License-Identifier: EUPL-1.2+ -# SPDX-FileCopyrightText: 2021, 2023, 2025 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2021, 2023, 2025-2026 Alyssa Ross <hi(a)alyssa.is> + +# Use sh from path — easier to make sure it's up to date than /bin/sh. +SHELL = sh BACKGROUND = background CPIO = cpio diff --git a/release/checks/integration/lib.c b/release/checks/integration/lib.c index 3a7ecdf..0f898f4 100644 --- a/release/checks/integration/lib.c +++ b/release/checks/integration/lib.c @@ -190,6 +190,7 @@ struct vm *start_qemu(struct config c) struct utsname u; int console_listener, console_conn; char *arch, *args[] = { + "sh", (char *)c.run_qemu, "-drive", nullptr, "-drive", nullptr, @@ -214,8 +215,8 @@ struct vm *start_qemu(struct config c) c.serial.optval ? (char *)c.serial.optval : "chardev:socket", nullptr, }; - char **efi_arg = &args[2], **img_arg = &args[4], - **user_data_arg = &args[6], **console_arg = &args[8]; + char **efi_arg = &args[3], **img_arg = &args[5], + **user_data_arg = &args[7], **console_arg = &args[9]; struct vm *r = malloc(sizeof *r); if (!r) { @@ -252,7 +253,7 @@ struct vm *start_qemu(struct config c) exit(EXIT_FAILURE); } - execv(c.run_qemu, args); + execvp(args[0], args); perror("execv"); exit(EXIT_FAILURE); } diff --git a/release/checks/integration/meson.build b/release/checks/integration/meson.build index 7bf8f51..f0ef334 100644 --- a/release/checks/integration/meson.build +++ b/release/checks/integration/meson.build @@ -7,7 +7,7 @@ project('spectrum-integration-tests', 'c', add_project_arguments('-D_GNU_SOURCE', language : 'c') -run_qemu = find_program('../../../scripts/run-qemu.sh') +run_qemu = files('../../../scripts/run-qemu.sh') lib = static_library('spectrum-integration-test', 'lib.c') diff --git a/release/live/Makefile b/release/live/Makefile index 85319d0..4bf38a0 100644 --- a/release/live/Makefile +++ b/release/live/Makefile @@ -8,10 +8,10 @@ include ../../lib/common.mk dest = build/live.img $(dest): ../../scripts/format-uuid.sh ../../scripts/make-gpt.sh ../../scripts/sfdisk-field.awk build/boot.fat $(ROOT_FS_IMAGES) - ../../scripts/make-gpt.sh $@.tmp \ + $(SHELL) ../../scripts/make-gpt.sh $@.tmp \ build/boot.fat:c12a7328-f81f-11d2-ba4b-00a0c93ec93b \ - $(ROOT_FS_VERITY):verity:$$(../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity:162' \ - $(ROOT_FS_IMAGE):root:$$(../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION):20000' \ + $(ROOT_FS_VERITY):verity:$$($(SHELL) ../../scripts/format-uuid.sh "$$(dd if=$(ROOT_FS_VERITY_ROOTHASH) bs=32 skip=1 count=1 status=none)"):Spectrum_'$(VERSION).verity:162' \ + $(ROOT_FS_IMAGE):root:$$($(SHELL) ../../scripts/format-uuid.sh "$$(head -c 32 $(ROOT_FS_VERITY_ROOTHASH))"):Spectrum_'$(VERSION):20000' \ /dev/null:verity:18f2ccff-92f1-4bb1-a80e-24f76ecda90c:_empty:162 \ /dev/null:root:ec0c5ff3-f6b1-4adf-82b4-61336c4d135f:_empty:20000 mv $@.tmp $@ @@ -43,7 +43,7 @@ run: build/empty $(dest) exec 4<>"$$userdata" && \ rm -f "$$userdata" && \ set +x && \ - exec ../../scripts/run-qemu.sh -m 4G \ + exec $(SHELL) ../../scripts/run-qemu.sh -m 4G \ -machine virtualization=on \ -cpu max \ -smbios type=11,value=io.systemd.stub.kernel-cmdline-extra=console=hvc0 \ diff --git a/vm/sys/net/Makefile b/vm/sys/net/Makefile index 7ad5e5c..e080954 100644 --- a/vm/sys/net/Makefile +++ b/vm/sys/net/Makefile @@ -25,7 +25,7 @@ $(vmdir)/netvm/vmlinux: $(KERNEL) $(vmdir)/netvm/blk/root.img: ../../../scripts/make-gpt.sh ../../../scripts/sfdisk-field.awk build/rootfs.erofs mkdir -p $$(dirname $@) - ../../../scripts/make-gpt.sh $@.tmp \ + $(SHELL) ../../../scripts/make-gpt.sh $@.tmp \ build/rootfs.erofs:root:ea21da27-0391-48da-9235-9d2ab2ca7844:root mv $@.tmp $@ @@ -43,7 +43,7 @@ build/rootfs.erofs: ../../../scripts/make-erofs.sh $(PACKAGES_FILE) $(FILES) $(B for file in $(FILES) $(LINKS); do printf '%s\n%s\n' $$file "$${file#image/}"; done ;\ for file in $(BUILD_FILES); do printf '%s\n%s\n' $$file $${file#build/}; done ;\ printf 'build/empty\n%s\n' $(DIRS) ;\ - } | ../../../scripts/make-erofs.sh $@ + } | $(SHELL) ../../../scripts/make-erofs.sh $@ build/etc/s6-rc: $(S6_RC_FILES) file-list.mk mkdir -p $$(dirname $@) @@ -65,7 +65,7 @@ start-vhost-user-net: ../../../scripts/start-passt.elb run-qemu: $(vmdir)/netvm/blk/root.img - @../../../scripts/run-qemu.sh -m 256 -cpu max -kernel $(KERNEL) -vga none \ + @$(SHELL)../../../scripts/run-qemu.sh -m 256 -cpu max -kernel $(KERNEL) -vga none \ -drive file=$(vmdir)/netvm/blk/root.img,if=virtio,format=raw,readonly=on \ -append "root=PARTLABEL=root nokaslr" \ -gdb unix:build/gdb.sock,server,nowait \ @@ -82,7 +82,7 @@ run-qemu: $(vmdir)/netvm/blk/root.img run-cloud-hypervisor: $(vmdir)/netvm/blk/root.img start-vhost-user-net rm -f build/vmm.sock @../../../scripts/with-taps.elb \ - ../../../scripts/run-cloud-hypervisor.sh \ + $(SHELL) ../../../scripts/run-cloud-hypervisor.sh \ --api-socket path=build/vmm.sock \ --memory size=256M,shared=on \ --disk path=$(vmdir)/netvm/blk/root.img,readonly=on \ base-commit: 5b3151fd08d1f1e3e166a328449fe6fe5092f316 -- 2.54.0

1 0

[PATCH] host/rootfs: Automatically select card node
by Demi Marie Obenour 26 May '26

26 May '26

This allows Weston to launch even if there if /dev/dri/card0 does not exist. This requires a shell script for string processing. It could be written in Rust, but that's not worth it for a temporary workaround. It also prevents waiting for the card to be ready. Instead, let s6 restart Weston over and over until Weston finally runs. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- This makes Spectrum work on my AMD system. --- host/rootfs/file-list.mk | 1 + host/rootfs/image/etc/s6-rc/weston/run | 6 +++--- host/rootfs/image/usr/bin/run-weston | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/host/rootfs/file-list.mk b/host/rootfs/file-list.mk index 3899d620717fc97f42e669e5313c4100dcf5b1cd..0ece8e08a0e2d367fe124e90896355aa98a58cb8 100644 --- a/host/rootfs/file-list.mk +++ b/host/rootfs/file-list.mk @@ -62,6 +62,7 @@ FILES = \ image/usr/bin/run-appimage \ image/usr/bin/run-flatpak \ image/usr/bin/run-vmm \ + image/usr/bin/run-weston \ image/usr/bin/spectrum-update \ image/usr/bin/vm-console \ image/usr/bin/vm-import \ diff --git a/host/rootfs/image/etc/s6-rc/weston/run b/host/rootfs/image/etc/s6-rc/weston/run index fd59586c719391deb546c29578341e16a61ed4ce..6c0aac4a2326b5d56b9c09f82589dfbcc78eaabd 100644 --- a/host/rootfs/image/etc/s6-rc/weston/run +++ b/host/rootfs/image/etc/s6-rc/weston/run @@ -2,7 +2,7 @@ # SPDX-License-Identifier: EUPL-1.2+ # SPDX-FileCopyrightText: 2021, 2025 Alyssa Ross <hi(a)alyssa.is> -importas -Siu WAYLAND_DISPLAY +importas -Si WAYLAND_DISPLAY piperw 4 3 background { @@ -40,7 +40,6 @@ redirfd -r 0 /dev/tty1 importas -i home HOME cd $home -if { udevadm wait /dev/dri/card0 } s6-setuidgid wayland bwrap # no --unshare-net, breaks udev hotplug @@ -88,4 +87,5 @@ bwrap --bind /run/user/0 /run/user/0 --bind /run/wayland /run/wayland -- -weston -S $WAYLAND_DISPLAY + elglob -w0 CARD "/dev/dri/card[0-9]*" + /usr/bin/run-weston $CARD diff --git a/host/rootfs/image/usr/bin/run-weston b/host/rootfs/image/usr/bin/run-weston new file mode 100755 index 0000000000000000000000000000000000000000..6a14f905d2e9e5533d00aac1ee7f920ebf55fac3 --- /dev/null +++ b/host/rootfs/image/usr/bin/run-weston @@ -0,0 +1,32 @@ +#!/usr/bin/sh -- +# SPDX-License-Identifier: EUPL-1.2+ +# SPDX-FileCopyrightText: 2026 Demi Marie Obenour <demiobenour(a)gmail.com> +set -euf +case ${1-} in +/dev/dri/card[0-9]*) + first_dev=${1#/dev/dri/} extra_cards= + shift + ;; +*) + echo 'No card nodes found, cannot run Weston' >&2 + exit 1 + ;; +esac +for i; do + case $i in + *,*) continue ;; + /dev/dri/card[0-9]*) : ;; + *) + echo 'Bad name from execline script' >&2 + exit 1 + ;; + esac + card_name=${i#/dev/dri/} + case $card_name in */*) continue ;; esac + if [ -z "$extra_cards" ]; then + extra_cards=--additional-devices=$card_name + else + extra_cards=$extra_cards,$card_name + fi +done +exec weston --backend=drm "--drm-device=$first_dev" $extra_cards -S "$WAYLAND_DISPLAY" --- base-commit: 4827f7591e945f331a945fb53a9fd4e8ebfdbc12 change-id: 20260523-weston-card-fix-725c98d5245f -- Sincerely, Demi Marie Obenour (she/her/hers)

2 3

[PATCH] release/checks/whitespace: skip binary files
by Valentin Gagarin 25 May '26

25 May '26

Trailing whitespace is meaningful only for text. Signed-off-by: Valentin Gagarin <valentin(a)gagarin.work> --- release/checks/whitespace.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release/checks/whitespace.nix b/release/checks/whitespace.nix index 56710b6..3929c8f 100644 --- a/release/checks/whitespace.nix +++ b/release/checks/whitespace.nix @@ -9,6 +9,6 @@ runCommand "spectrum-whitespace" { fileset = srcWithNix; }; } '' - grep --color=always --exclude='*.patch' -r "[[:space:]]$" $src || touch $out + grep --color=always --binary-files=without-match --exclude='*.patch' -r "[[:space:]]$" $src || touch $out '' ) (_: {}) -- 2.51.2

3 5

Re: [PATCH net] vsock/virtio: fix potential unbounded skb queue
by Demi Marie Obenour 25 May '26

25 May '26

On 5/8/26 06:11, Stefano Garzarella wrote: > On Fri, May 08, 2026 at 05:58:06AM -0400, Michael S. Tsirkin wrote: >> On Fri, May 08, 2026 at 11:41:21AM +0200, Stefano Garzarella wrote: >>> On Thu, May 07, 2026 at 06:48:47PM -0400, Michael S. Tsirkin wrote: >>>> On Thu, May 07, 2026 at 02:59:13PM +0200, Stefano Garzarella wrote: >>>>> On Thu, May 07, 2026 at 07:45:10AM -0400, Michael S. Tsirkin wrote: >>>>>> On Thu, May 07, 2026 at 11:09:47AM +0200, Stefano Garzarella wrote: >>> >>> [...] >>> >>>>>>> For now, we're already doing something: >>>>>>> merging the skuffs if they don't have EOM set. >>>>>> >>>>>> >>>>>> Right that's good. You could go further and merge with EOM too >>>>>> if you stick the info about message boundaries somewhere else. >>>>> >>>>> This adds a lot of complexity IMO, but we can try. >>>>> >>>>> Do you have something in mind? >>>> >>>> BER is clearly overkill but here's a POC that claude made for me, >>>> just to give u an idea. It's clearly has a ton of issues, >>>> for example I dislike how GFP_ATOMIC is handled. >>> >>> Okay, I somewhat understand, but clearly this isn't net material >> >> I doubt we have many other options given reverting the regression was >> ruled out. > > As Eric pointed out, we can't revert it. Could there be an option to disable the mitigation in guests, for the situation where the host is trusted? There are VMMs that implement AF_VSOCK in userspace with a backing AF_UNIX socket. >>> so for now >>> I think the best thing to do is to merge the fixup I sent (or something >>> similar): >>> https://lore.kernel.org/netdev/20260508092330.69690-1-sgarzare@redhat.com/ >> >> I reviewed that one, problem is it's a spec violation/change that we'll >> have to support forever. > > I have a few points to make on this, but let's discuss them there. > >> >>> This is a major change that should be merged with more caution. >>> Could this have too much of an impact on performance? >>> >>> Thanks, >>> Stefano >> >> It's really a POC, real patch is left as an excersise for the reader >> :). > > eheh, I see, but honestly, this overcomplication scares me. I'll try to > think it over. > >> The correct approach IMHO is to only start using this >> when we wasted a lot of memory on small packets. >> >> For example, if sum(truesize) >= buf size. >> >> then we'll not see a perf impact unless it's already pathological. > > Agree on this, which is similar to what I'm doing in that patch. > Reducing the advertised buf_alloc only in pathological cases (e.g. > overhead > buf_alloc). This isn't enough to prevent data loss due to race conditions. I'm CCing the virtio-comment list and a few others. Right now, any application that needs to send massive amount of data over a vsock is simply broken. This isn't just theoretical. It's causing real-world problems for users of Waypipe. Waypipe forwards Wayland protocol messages over AF_VSOCK, so it can send a large amount of traffic over the socket. See https://gitlab.freedesktop.org/mstoceckl/waypipe/work_items/165. If one is willing to mutate the ring buffer in-place, or to maintain an auxiliary counter, it's possible to store all messages with bounded (in practice) overhead. Specifically: - If the first byte of a block of data is nonzero, it's a variable-length length. 1 byte for messages less than 128 bytes. - If the first byte of a block of data is zero, the subsequent bytes are a variable-length counter that stores the number of consecutive zero-byte messages. That adds a lot of complexity, which is very unfortunate for something that needs to be backported to stable kernels. I also suspect it requires all access to the ring buffer to take a lock rather than being lock-free. But it's the only approach that I can think of that can work with the current spec. Could there at least be a normative note stating that drivers and devices should treat each message as consuming 1024 bytes + the size of the message itself, and warning that anything that doesn't is going to be broken in practice? I'm CCing Val Packet (of Invisible Things Lab) and Alyssa Ross (of Spectrum) because both of them are working on systems that rely critically on vsock. -- Sincerely, Demi Marie Obenour (she/her/hers)

2 2

[PATCH] Disable panel self-refresh on AMD GPUs
by Demi Marie Obenour 23 May '26

23 May '26

KDE Linux has already done this. It works around a long-running bug in the AMD GPU driver, which I believe also affects my test laptop. Without the workaround, the system freezes and does not recover until a hard reboot. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- host/efi.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/host/efi.nix b/host/efi.nix index ecedb6bea6bf29c7a7303dc9062fe12b5c7a9fbd..a832489f3816ca66c2170f0f114a4a8e3a357e32 100644 --- a/host/efi.nix +++ b/host/efi.nix @@ -35,6 +35,6 @@ runCommand "spectrum-efi" { --linux ${kernel} \ --initrd ${initramfs} \ --os-release $'NAME="Spectrum"\n' \ - --cmdline "ro intel_iommu=on roothash=$roothash" + --cmdline "ro intel_iommu=on roothash=$roothash amdgpu.dcdebugmask=0x10" '' ) (_: {}) --- base-commit: 5b3151fd08d1f1e3e166a328449fe6fe5092f316 change-id: 20260520-disable-panel-self-refresh-6c5e1dc0bab5 -- Sincerely, Demi Marie Obenour (she/her/hers)

2 6

[PATCH] vhost-user: Guarantee that memory regions do not overlap
by Demi Marie Obenour 23 May '26

23 May '26

Otherwise there would be an ambiguity problem. Suppose that: 1. There is a region from [0x40000, 0x50000) with mmap offset 0x500000. 2. There is a region from [0x48000, 0x58000) with mmap offset 0xA00000. A request has address 0x44000. Which mmap offset should be used? This problem appears with both guest and user addresses. Signed-off-by: Demi Marie Obenour <demiobenour(a)gmail.com> --- docs/interop/vhost-user.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst index 137c9f3669..8c122c9d21 100644 --- a/docs/interop/vhost-user.rst +++ b/docs/interop/vhost-user.rst @@ -204,6 +204,18 @@ fields at the end. :domid: a 32-bit Xen hypervisor specific domain id. +For all memory regions active at a given time: + +- ``[guest address, guest address + size)`` of one memory region never overlaps + the ``[guest address, guest address + size)`` of another memory region. + +- ``[user address, user address + size)`` of one memory region never overlaps + the ``[user address, user address + size)`` of another memory region. + +Violating any of these is a bug in the front-end. This ensures that a guest +address or user address always refers to at most one location in memory. +The front-end must remove a region before it can add an overlapping one. + Single memory region description ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -672,6 +684,15 @@ The front-end sends a list of vhost memory regions to the back-end using the ``VHOST_USER_SET_MEM_TABLE`` message. Each region has two base addresses: a guest address and a user address. +Memory regions can be added via the ``VHOST_USER_ADD_MEM_REG`` message. They +can be removed via the ``VHOST_USER_REM_MEM_REG`` message. These messages can +only be used if the ``VHOST_USER_PROTOCOL_F_CONFIGURE_MEM_SLOTS`` protocol +feature has been successfully negotiated. + +Guest addresses are physical addresses in the guest. User addresses are +arbitrary opaque values, though they typically refer to userspace addresses in +the client process. + Messages contain guest addresses and/or user addresses to reference locations within the shared memory. The mapping of these addresses works as follows. --- base-commit: f5a2438405d4ae8b62de7c9b39fac0b2155ee544 change-id: 20260522-vhost-user-dev-aa76e3955555 Best regards, -- Demi Marie Obenour <demiobenour(a)gmail.com>

1 0