Skip to content

RFC2 #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 20, 2025
Merged

RFC2 #22

merged 4 commits into from
Jun 20, 2025

Conversation

wmamills
Copy link
Collaborator

This is the RFC2 contents on top of the latest virtio-1.4 from upstream

stsquad and others added 4 commits June 19, 2025 17:54
Local only changes for our githib repo.
Changes to:
* make building easier for developers
* respond to local pull-requests
* automate build & publish for pushes and local PRs

Individual changes done by Alex and squashed by Bill.

github: tweak PR template for virtio-msg (!UPSTREAM)

While we are working on the virtio-msg specification in the repository
lets not confuse people by using the canned response for the upstream
repository.

REVISION: set to 1.4 working draft as a base (!UPSTREAM)

* Makefile: add some simple make automations

This is just a helpful shortcut, especially when editing the documents
within an IDE which will offer up make targets to build the documents.

make-setup-generated: optionally add GIT metadata

This isn't a full conversion to git based metadata but it allows for
local builds to add git commit and tree status to the final built
product. The normal formal build process is unaffected and uses
manually updated VERSION, REVISION and REVISION-DATE metadata.

github: add basic test build

github: add deploy step

This pushes the PDF as a release artefact.

github: add an update step before installing texlive

Otherwise you run into issues of the upstream has updated packages
since the last snapshot.

github: use a different release/publish pipeline

Having a draft means that the final asset won't be visible outside the
project which is what we want. This entails tagging a release each
time we run the steps.

github: only run the test phase on PRs

The release is done on pushes.

Signed-off-by: Alex Bennée <[email protected]>

github: use dedicated latex image

Installing all the latext tools from scratch takes some time and can
time out. Lets use an image that already has all the bits. The
texlive-full image is based on Alpin and we need to install a few
helper tools for build.

Signed-off-by: Alex Bennée <[email protected]>

github: add liberation font

We don't need it for the HTML but the full PDF needs fonts to render
properly.

Signed-off-by: Alex Bennée <[email protected]>

github: give tag and pdf names unique to owner fork and branch

The job number is not unique for different forks and this causes issues
with the tags which are global. Use the repo owners github name in the
tag and the branch as well.  Still include the job number to make unique.

Also change the pdf file name so we know where it came from.

Signed-off-by: Bill Mills <[email protected]>
Add the cover letter and a script to send the email.
Includes cover letter fixups from Bertrands suggestions.

Also: s/massage/message/

Also replace ".  " with ". " because I know it bugs Arnaud.

(Standing on soapbox: Double space after period was invented
for mono-spaced fonts and went out of style because we now normally have
variable spaced fonts.  So using double space after period should STILL be
used in code and other places that still use mono-spaced fonts.)

Signed-off-by: Bill Mills <[email protected]>
C1: Document what we have done since RFC1.
C2: mention more todo items
C3: Adjust series title

Signed-off-by: Bill Mills <[email protected]>
Add a new transport layer that is based on messages.

This transport layer still uses virtqueues as the other transport layers do
but implements transport layer operations by sending and receiving messages
instead of the "MMR" reads and writes used in virtio-mmio and virtio-pci.

This transport is useful when the device and driver are both implemented in
software but the trap and emulate operations of virtio-mmio and virtio-pci
can not be used.

This transport is intended to be used in many situations, including:
* between a host processor and its co-processors
* between two different systems (not SMP) connected via PCIe
* between normal and secure worlds
* host to vm
* vm to vm

This is an RFC and not yet intended to be merged. There are multiple
know issues including not conforming to virtio spec standards.

Signed-off-by: Bill Mills <[email protected]>
Signed-off-by: Bertrand Marquis <[email protected]>
Signed-off-by: Edgar E. Iglesias <[email protected]>
Signed-off-by: Arnaud Pouliquen <[email protected]>
@wmamills wmamills merged commit 87bb9f4 into Linaro:virtio-msg-rfc2 Jun 20, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants