- Spectrum Development - spectrum-os.org

[PATCH www] Update Postorius URLs
by Alyssa Ross 14 Apr '21

14 Apr '21

These changed with a mailman-web update. I've added redirects from the old locations but it's still better to avoid them. The update also wanted to change /lists/hyperkitty to /lists/archives, but on spectrum-os.org that path is used for public-inbox, so I've patched mailman-web to keep that at /lists/hyperkitty. --- contributing.html | 2 +- participating.html | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contributing.html b/contributing.html index 25522fc..1ec0f50 100644 --- a/contributing.html +++ b/contributing.html @@ -40,7 +40,7 @@ appreciate</a>. If you've made changes you'd like to be included in the official Spectrum distribution, please send patches to the -spectrum-devel <a href="https://spectrum-os.org/lists/postorius/lists/devel.spectrum-os.org/"> +spectrum-devel <a href="https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/"> mailing list</a> (<a href="mailto:devel@spectrum-os.org">devel(a)spectrum-os.org</a>). diff --git a/participating.html b/participating.html index da96473..fc95c15 100644 --- a/participating.html +++ b/participating.html @@ -124,7 +124,7 @@ will be posted. <p> You can -subscribe <a href="https://spectrum-os.org/lists/postorius/lists/announce.spectrum-os.org/">on +subscribe <a href="https://spectrum-os.org/lists/mailman3/lists/announce.spectrum-os.org/">on the web</a>, or by sending mail to <a href="mailto:announce-subscribe@spectrum-os.org">announce-subscribe(a)spectrum-os.org</a>. @@ -135,7 +135,7 @@ This list contains high-level discussion about the project. <p> You can -subscribe <a href="https://spectrum-os.org/lists/postorius/lists/discuss.spectrum-os.org/">on +subscribe <a href="https://spectrum-os.org/lists/mailman3/lists/discuss.spectrum-os.org/">on the web</a>, or by sending mail to <a href="mailto:discuss-subscribe@spectrum-os.org">discuss-subscribe(a)spectrum-os.org</a>. @@ -152,7 +152,7 @@ discussed. <p> You can -subscribe <a href="https://spectrum-os.org/lists/postorius/lists/devel.spectrum-os.org/">on +subscribe <a href="https://spectrum-os.org/lists/mailman3/lists/devel.spectrum-os.org/">on the web</a>, or by sending mail to <a href="mailto:devel-subscribe@spectrum-os.org">devel-subscribe(a)spectrum-os.org</a>. -- 2.30.0

2 2

[RFC PATCH 0/8] Update chromiumPacakges
by Jamie McClymont 02 Apr '21

02 Apr '21

Hi all Here's a nearly-complete(?) attempt at bumping chromiumOSPackages. Everything under chromiumOSPackages and spectrumPackages builds except crosvm (and therefore spectrum-vm). I've added platform2 as a dependency (a few rust crates from there are now used) and bumped the cargoSha256, so the vendor FOD now builds happily, but the actual `cargo build` fails with: > error: the lock file /build/src/platform/crosvm/Cargo.lock needs to be updated but --frozen was passed to prevent this > If you want to try to generate the lock file without accessing the network, use the --offline flag. I haven't dealt with buildRustPackage before, so I'm not sure if this is a standard thing that any frequent buildRustPackage user will know how to fix, or if we're running in to an odd edge-case - emailing it in as-is in the hopes that it's the former :) Thanks! Jamie McClymont Jamie McClymont (8): chromiumOSPackages: update 83->89 chromiumOSPackages.cros_linux: fix config chromiumOSPackages.vm_protos: drop GN patch chromiumOSPackages.common-mk: update patches chromiumOSPackages.common-mk: disable clang-only warnings chromiumOSPackages.sommelier: drop unneeded patches chromiumOSPackages.crosvm: add platform2 dep chromiumOSPackages.crosvm: bump cargoSha256 ...-mk-don-t-leak-source-absolute-paths.patch | 14 +- .../linux/chromium-os/common-mk/default.nix | 6 +- .../linux/chromium-os/crosvm/default.nix | 3 +- ...melier-use-stable-xdg-shell-protocol.patch | 1748 ----------------- ...mmelier-make-building-demos-optional.patch | 100 - .../linux/chromium-os/sommelier/default.nix | 2 - .../linux/chromium-os/upstream-info.json | 44 +- ...03-vm_tools-proto-fix-parallel-build.patch | 39 - .../linux/chromium-os/vm_protos/default.nix | 2 - pkgs/os-specific/linux/kernel/linux-cros.nix | 6 +- 10 files changed, 40 insertions(+), 1924 deletions(-) delete mode 100644 pkgs/os-specific/linux/chromium-os/sommelier/0005-sommelier-use-stable-xdg-shell-protocol.patch delete mode 100644 pkgs/os-specific/linux/chromium-os/sommelier/0006-sommelier-make-building-demos-optional.patch delete mode 100644 pkgs/os-specific/linux/chromium-os/vm_protos/0003-vm_tools-proto-fix-parallel-build.patch -- 2.31.1

2 1

[RFC PATCH 6/8] chromiumOSPackages.sommelier: drop unneeded patches
by Jamie McClymont 02 Apr '21

02 Apr '21

The xdg-shell thing has been integrated upstream, and the demos seem to no longer exist. --- ...melier-use-stable-xdg-shell-protocol.patch | 1748 ----------------- ...mmelier-make-building-demos-optional.patch | 100 - .../linux/chromium-os/sommelier/default.nix | 2 - 3 files changed, 1850 deletions(-) delete mode 100644 pkgs/os-specific/linux/chromium-os/sommelier/0005-sommelier-use-stable-xdg-shell-protocol.patch delete mode 100644 pkgs/os-specific/linux/chromium-os/sommelier/0006-sommelier-make-building-demos-optional.patch diff --git a/pkgs/os-specific/linux/chromium-os/sommelier/0005-sommelier-use-stable-xdg-shell-protocol.patch b/pkgs/os-specific/linux/chromium-os/sommelier/0005-sommelier-use-stable-xdg-shell-protocol.patch deleted file mode 100644 index 41a42df74fd..00000000000 --- a/pkgs/os-specific/linux/chromium-os/sommelier/0005-sommelier-use-stable-xdg-shell-protocol.patch +++ /dev/null @@ -1,1748 +0,0 @@ -From d3a8f6b49e35744e71271cab1eb9ea9a5c87854d Mon Sep 17 00:00:00 2001 -From: Puck Meerburg <puck(a)puckipedia.com> -Date: Tue, 3 Dec 2019 18:06:14 +0000 -Subject: [PATCH 5/6] sommelier: use stable xdg-shell protocol - -From https://github.com/wayland-project/weston/commit/d8d9f5e6e16c8f6a3c06763d5f…: - -> Some clients like the mpv video player now request the xdg_shell -> protocol so these will fail if the compositor only provides the -> xdg_shell_unstable_v6 protocol. Compositors like mir and gnome provide -> both protocols. ---- - vm_tools/sommelier/BUILD.gn | 2 +- - ...dg-shell-unstable-v6.xml => xdg-shell.xml} | 319 ++++++++++++------ - vm_tools/sommelier/sommelier-xdg-shell.c | 233 ++++++------- - vm_tools/sommelier/sommelier.c | 211 ++++++------ - vm_tools/sommelier/sommelier.h | 17 +- - 5 files changed, 447 insertions(+), 335 deletions(-) - rename vm_tools/sommelier/protocol/{xdg-shell-unstable-v6.xml => xdg-shell.xml} (79%) - -diff --git a/vm_tools/sommelier/BUILD.gn b/vm_tools/sommelier/BUILD.gn -index 5027628d2..4330560a1 100644 ---- a/vm_tools/sommelier/BUILD.gn -+++ b/vm_tools/sommelier/BUILD.gn -@@ -68,7 +68,7 @@ wayland_protocol_library("sommelier-protocol") { - "protocol/relative-pointer-unstable-v1.xml", - "protocol/text-input-unstable-v1.xml", - "protocol/viewporter.xml", -- "protocol/xdg-shell-unstable-v6.xml", -+ "protocol/xdg-shell.xml", - ] - } - -diff --git a/vm_tools/sommelier/protocol/xdg-shell-unstable-v6.xml b/vm_tools/sommelier/protocol/xdg-shell.xml -similarity index 79% -rename from vm_tools/sommelier/protocol/xdg-shell-unstable-v6.xml -rename to vm_tools/sommelier/protocol/xdg-shell.xml -index 1c0f92452..3a87a9ed6 100644 ---- a/vm_tools/sommelier/protocol/xdg-shell-unstable-v6.xml -+++ b/vm_tools/sommelier/protocol/xdg-shell.xml -@@ -1,11 +1,13 @@ - <?xml version="1.0" encoding="UTF-8"?> --<protocol name="xdg_shell_unstable_v6"> -+<protocol name="xdg_shell"> - - <copyright> - Copyright © 2008-2013 Kristian Høgsberg - Copyright © 2013 Rafael Antognolli - Copyright © 2013 Jasper St. Pierre - Copyright © 2010-2013 Intel Corporation -+ Copyright © 2015-2017 Samsung Electronics Co., Ltd -+ Copyright © 2015-2017 Red Hat Inc. - - Permission is hereby granted, free of charge, to any person obtaining a - copy of this software and associated documentation files (the "Software"), -@@ -27,18 +29,19 @@ - DEALINGS IN THE SOFTWARE. - </copyright> - -- <interface name="zxdg_shell_v6" version="1"> -+ <interface name="xdg_wm_base" version="2"> - <description summary="create desktop-style surfaces"> -- xdg_shell allows clients to turn a wl_surface into a "real window" -- which can be dragged, resized, stacked, and moved around by the -- user. Everything about this interface is suited towards traditional -- desktop environments. -+ The xdg_wm_base interface is exposed as a global object enabling clients -+ to turn their wl_surfaces into windows in a desktop environment. It -+ defines the basic functionality needed for clients and the compositor to -+ create windows that can be dragged, resized, maximized, etc, as well as -+ creating transient windows such as popup menus. - </description> - - <enum name="error"> - <entry name="role" value="0" summary="given wl_surface has another role"/> - <entry name="defunct_surfaces" value="1" -- summary="xdg_shell was destroyed before children"/> -+ summary="xdg_wm_base was destroyed before children"/> - <entry name="not_the_topmost_popup" value="2" - summary="the client tried to map or destroy a non-topmost popup"/> - <entry name="invalid_popup_parent" value="3" -@@ -50,11 +53,11 @@ - </enum> - - <request name="destroy" type="destructor"> -- <description summary="destroy xdg_shell"> -- Destroy this xdg_shell object. -+ <description summary="destroy xdg_wm_base"> -+ Destroy this xdg_wm_base object. - -- Destroying a bound xdg_shell object while there are surfaces -- still alive created by this xdg_shell object instance is illegal -+ Destroying a bound xdg_wm_base object while there are surfaces -+ still alive created by this xdg_wm_base object instance is illegal - and will result in a protocol error. - </description> - </request> -@@ -65,7 +68,7 @@ - surfaces relative to some parent surface. See the interface description - and xdg_surface.get_popup for details. - </description> -- <arg name="id" type="new_id" interface="zxdg_positioner_v6"/> -+ <arg name="id" type="new_id" interface="xdg_positioner"/> - </request> - - <request name="get_xdg_surface"> -@@ -82,14 +85,14 @@ - See the documentation of xdg_surface for more details about what an - xdg_surface is and how it is used. - </description> -- <arg name="id" type="new_id" interface="zxdg_surface_v6"/> -+ <arg name="id" type="new_id" interface="xdg_surface"/> - <arg name="surface" type="object" interface="wl_surface"/> - </request> - - <request name="pong"> - <description summary="respond to a ping event"> - A client must respond to a ping event with a pong request or -- the client may be deemed unresponsive. See xdg_shell.ping. -+ the client may be deemed unresponsive. See xdg_wm_base.ping. - </description> - <arg name="serial" type="uint" summary="serial of the ping event"/> - </request> -@@ -98,7 +101,7 @@ - <description summary="check if the client is alive"> - The ping event asks the client if it's still alive. Pass the - serial specified in the event back to the compositor by sending -- a "pong" request back with the specified serial. See xdg_shell.ping. -+ a "pong" request back with the specified serial. See xdg_wm_base.pong. - - Compositors can use this to determine if the client is still - alive. It's unspecified what will happen if the client doesn't -@@ -106,13 +109,13 @@ - try to respond in a reasonable amount of time. - - A compositor is free to ping in any way it wants, but a client must -- always respond to any xdg_shell object it created. -+ always respond to any xdg_wm_base object it created. - </description> - <arg name="serial" type="uint" summary="pass this to the pong request"/> - </event> - </interface> - -- <interface name="zxdg_positioner_v6" version="1"> -+ <interface name="xdg_positioner" version="2"> - <description summary="child surface positioner"> - The xdg_positioner provides a collection of rules for the placement of a - child surface relative to a parent surface. Rules can be defined to ensure -@@ -162,13 +165,13 @@ - Specify the anchor rectangle within the parent surface that the child - surface will be placed relative to. The rectangle is relative to the - window geometry as defined by xdg_surface.set_window_geometry of the -- parent surface. The rectangle must be at least 1x1 large. -+ parent surface. - - When the xdg_positioner object is used to position a child surface, the - anchor rectangle may not extend outside the window geometry of the - positioned child's parent surface. - -- If a zero or negative size is set the invalid_input error is raised. -+ If a negative size is set the invalid_input error is raised. - </description> - <arg name="x" type="int" summary="x position of anchor rectangle"/> - <arg name="y" type="int" summary="y position of anchor rectangle"/> -@@ -176,63 +179,54 @@ - <arg name="height" type="int" summary="height of anchor rectangle"/> - </request> - -- <enum name="anchor" bitfield="true"> -- <entry name="none" value="0" -- summary="the center of the anchor rectangle"/> -- <entry name="top" value="1" -- summary="the top edge of the anchor rectangle"/> -- <entry name="bottom" value="2" -- summary="the bottom edge of the anchor rectangle"/> -- <entry name="left" value="4" -- summary="the left edge of the anchor rectangle"/> -- <entry name="right" value="8" -- summary="the right edge of the anchor rectangle"/> -+ <enum name="anchor"> -+ <entry name="none" value="0"/> -+ <entry name="top" value="1"/> -+ <entry name="bottom" value="2"/> -+ <entry name="left" value="3"/> -+ <entry name="right" value="4"/> -+ <entry name="top_left" value="5"/> -+ <entry name="bottom_left" value="6"/> -+ <entry name="top_right" value="7"/> -+ <entry name="bottom_right" value="8"/> - </enum> - - <request name="set_anchor"> -- <description summary="set anchor rectangle anchor edges"> -- Defines a set of edges for the anchor rectangle. These are used to -- derive an anchor point that the child surface will be positioned -- relative to. If two orthogonal edges are specified (e.g. 'top' and -- 'left'), then the anchor point will be the intersection of the edges -- (e.g. the top left position of the rectangle); otherwise, the derived -- anchor point will be centered on the specified edge, or in the center of -- the anchor rectangle if no edge is specified. -- -- If two parallel anchor edges are specified (e.g. 'left' and 'right'), -- the invalid_input error is raised. -+ <description summary="set anchor rectangle anchor"> -+ Defines the anchor point for the anchor rectangle. The specified anchor -+ is used derive an anchor point that the child surface will be -+ positioned relative to. If a corner anchor is set (e.g. 'top_left' or -+ 'bottom_right'), the anchor point will be at the specified corner; -+ otherwise, the derived anchor point will be centered on the specified -+ edge, or in the center of the anchor rectangle if no edge is specified. - </description> - <arg name="anchor" type="uint" enum="anchor" -- summary="bit mask of anchor edges"/> -+ summary="anchor"/> - </request> - -- <enum name="gravity" bitfield="true"> -- <entry name="none" value="0" -- summary="center over the anchor edge"/> -- <entry name="top" value="1" -- summary="position above the anchor edge"/> -- <entry name="bottom" value="2" -- summary="position below the anchor edge"/> -- <entry name="left" value="4" -- summary="position to the left of the anchor edge"/> -- <entry name="right" value="8" -- summary="position to the right of the anchor edge"/> -+ <enum name="gravity"> -+ <entry name="none" value="0"/> -+ <entry name="top" value="1"/> -+ <entry name="bottom" value="2"/> -+ <entry name="left" value="3"/> -+ <entry name="right" value="4"/> -+ <entry name="top_left" value="5"/> -+ <entry name="bottom_left" value="6"/> -+ <entry name="top_right" value="7"/> -+ <entry name="bottom_right" value="8"/> - </enum> - - <request name="set_gravity"> - <description summary="set child surface gravity"> - Defines in what direction a surface should be positioned, relative to -- the anchor point of the parent surface. If two orthogonal gravities are -- specified (e.g. 'bottom' and 'right'), then the child surface will be -- placed in the specified direction; otherwise, the child surface will be -- centered over the anchor point on any axis that had no gravity -- specified. -- -- If two parallel gravities are specified (e.g. 'left' and 'right'), the -- invalid_input error is raised. -+ the anchor point of the parent surface. If a corner gravity is -+ specified (e.g. 'bottom_right' or 'top_left'), then the child surface -+ will be placed towards the specified gravity; otherwise, the child -+ surface will be centered over the anchor point on any axis that had no -+ gravity specified. - </description> - <arg name="gravity" type="uint" enum="gravity" -- summary="bit mask of gravity directions"/> -+ summary="gravity direction"/> - </request> - - <enum name="constraint_adjustment" bitfield="true"> -@@ -252,7 +246,7 @@ - <entry name="none" value="0"> - <description summary="don't move the child surface when constrained"> - Don't alter the surface position even if it is constrained on some -- axis, for example partially outside the edge of a monitor. -+ axis, for example partially outside the edge of an output. - </description> - </entry> - <entry name="slide_x" value="1"> -@@ -304,6 +298,10 @@ - surface is constrained, the gravity is 'bottom' and the anchor is - 'bottom', change the gravity to 'top' and the anchor to 'top'. - -+ The adjusted position is calculated given the original anchor -+ rectangle and offset, but with the new flipped anchor and gravity -+ values. -+ - If the adjusted position also ends up being constrained, the resulting - position of the flip_y adjustment will be the one before the - adjustment. -@@ -361,7 +359,7 @@ - </request> - </interface> - -- <interface name="zxdg_surface_v6" version="1"> -+ <interface name="xdg_surface" version="2"> - <description summary="desktop user interface surface base interface"> - An interface that may be implemented by a wl_surface, for - implementations that provide a desktop-style user interface. -@@ -388,11 +386,20 @@ - manipulate a buffer prior to the first xdg_surface.configure call must - also be treated as errors. - -- For a surface to be mapped by the compositor, the following conditions -- must be met: (1) the client has assigned a xdg_surface based role to the -- surface, (2) the client has set and committed the xdg_surface state and -- the role dependent state to the surface and (3) the client has committed a -- buffer to the surface. -+ Mapping an xdg_surface-based role surface is defined as making it -+ possible for the surface to be shown by the compositor. Note that -+ a mapped surface is not guaranteed to be visible once it is mapped. -+ -+ For an xdg_surface to be mapped by the compositor, the following -+ conditions must be met: -+ (1) the client has assigned an xdg_surface-based role to the surface -+ (2) the client has set and committed the xdg_surface state and the -+ role-dependent state to the surface -+ (3) the client has committed a buffer to the surface -+ -+ A newly-unmapped surface is considered to have met condition (1) out -+ of the 3 required conditions for mapping a surface if its role surface -+ has not been destroyed. - </description> - - <enum name="error"> -@@ -416,20 +423,23 @@ - See the documentation of xdg_toplevel for more details about what an - xdg_toplevel is and how it is used. - </description> -- <arg name="id" type="new_id" interface="zxdg_toplevel_v6"/> -+ <arg name="id" type="new_id" interface="xdg_toplevel"/> - </request> - - <request name="get_popup"> - <description summary="assign the xdg_popup surface role"> -- This creates an xdg_popup object for the given xdg_surface and gives the -- associated wl_surface the xdg_popup role. -+ This creates an xdg_popup object for the given xdg_surface and gives -+ the associated wl_surface the xdg_popup role. -+ -+ If null is passed as a parent, a parent surface must be specified using -+ some other protocol, before committing the initial state. - - See the documentation of xdg_popup for more details about what an - xdg_popup is and how it is used. - </description> -- <arg name="id" type="new_id" interface="zxdg_popup_v6"/> -- <arg name="parent" type="object" interface="zxdg_surface_v6"/> -- <arg name="positioner" type="object" interface="zxdg_positioner_v6"/> -+ <arg name="id" type="new_id" interface="xdg_popup"/> -+ <arg name="parent" type="object" interface="xdg_surface" allow-null="true"/> -+ <arg name="positioner" type="object" interface="xdg_positioner"/> - </request> - - <request name="set_window_geometry"> -@@ -442,6 +452,11 @@ - The window geometry is double buffered, and will be applied at the - time wl_surface.commit of the corresponding wl_surface is called. - -+ When maintaining a position, the compositor should treat the (x, y) -+ coordinate of the window geometry as the top left corner of the window. -+ A client changing the (x, y) window geometry coordinate should in -+ general not alter the position of the window. -+ - Once the window geometry of the surface is set, it is not possible to - unset it, and it will remain the same until set_window_geometry is - called again, even if a new subsurface or buffer is attached. -@@ -513,34 +528,50 @@ - </event> - </interface> - -- <interface name="zxdg_toplevel_v6" version="1"> -+ <interface name="xdg_toplevel" version="2"> - <description summary="toplevel surface"> - This interface defines an xdg_surface role which allows a surface to, - among other things, set window-like properties such as maximize, - fullscreen, and minimize, set application-specific metadata like title and - id, and well as trigger user interactive operations such as interactive - resize and move. -+ -+ Unmapping an xdg_toplevel means that the surface cannot be shown -+ by the compositor until it is explicitly mapped again. -+ All active operations (e.g., move, resize) are canceled and all -+ attributes (e.g. title, state, stacking, ...) are discarded for -+ an xdg_toplevel surface when it is unmapped. -+ -+ Attaching a null buffer to a toplevel unmaps the surface. - </description> - - <request name="destroy" type="destructor"> - <description summary="destroy the xdg_toplevel"> -- Unmap and destroy the window. The window will be effectively -- hidden from the user's point of view, and all state like -- maximization, fullscreen, and so on, will be lost. -+ This request destroys the role surface and unmaps the surface; -+ see "Unmapping" behavior in interface section for details. - </description> - </request> - - <request name="set_parent"> - <description summary="set the parent of this surface"> -- Set the "parent" of this surface. This window should be stacked -- above a parent. The parent surface must be mapped as long as this -- surface is mapped. -+ Set the "parent" of this surface. This surface should be stacked -+ above the parent surface and all other ancestor surfaces. - - Parent windows should be set on dialogs, toolboxes, or other - "auxiliary" surfaces, so that the parent is raised when the dialog - is raised. -+ -+ Setting a null parent for a child window removes any parent-child -+ relationship for the child. Setting a null parent for a window which -+ currently has no parent is a no-op. -+ -+ If the parent is unmapped then its children are managed as -+ though the parent of the now-unmapped parent has become the -+ parent of this surface. If no parent exists for the now-unmapped -+ parent then the children are managed as though they have no -+ parent surface. - </description> -- <arg name="parent" type="object" interface="zxdg_toplevel_v6" allow-null="true"/> -+ <arg name="parent" type="object" interface="xdg_toplevel" allow-null="true"/> - </request> - - <request name="set_title"> -@@ -573,6 +604,9 @@ - For example, "org.freedesktop.FooViewer" where the .desktop file is - "org.freedesktop.FooViewer.desktop". - -+ Like other properties, a set_app_id request can be sent after the -+ xdg_toplevel has been mapped to update the property. -+ - See the desktop-entry specification [0] for more details on - application identifiers and how they relate to well-known D-Bus - names and .desktop files. -@@ -693,12 +727,18 @@ - <description summary="the surface is maximized"> - The surface is maximized. The window geometry specified in the configure - event must be obeyed by the client. -+ -+ The client should draw without shadow or other -+ decoration outside of the window geometry. - </description> - </entry> - <entry name="fullscreen" value="2" summary="the surface is fullscreen"> - <description summary="the surface is fullscreen"> -- The surface is fullscreen. The window geometry specified in the configure -- event must be obeyed by the client. -+ The surface is fullscreen. The window geometry specified in the -+ configure event is a maximum; the client cannot resize beyond it. For -+ a surface to cover the whole fullscreened area, the geometry -+ dimensions must be obeyed by the client. For more details, see -+ xdg_toplevel.set_fullscreen. - </description> - </entry> - <entry name="resizing" value="3" summary="the surface is being resized"> -@@ -716,6 +756,30 @@ - keyboard or pointer focus. - </description> - </entry> -+ <entry name="tiled_left" value="5" since="2"> -+ <description summary="the surface is tiled"> -+ The window is currently in a tiled layout and the left edge is -+ considered to be adjacent to another part of the tiling grid. -+ </description> -+ </entry> -+ <entry name="tiled_right" value="6" since="2"> -+ <description summary="the surface is tiled"> -+ The window is currently in a tiled layout and the right edge is -+ considered to be adjacent to another part of the tiling grid. -+ </description> -+ </entry> -+ <entry name="tiled_top" value="7" since="2"> -+ <description summary="the surface is tiled"> -+ The window is currently in a tiled layout and the top edge is -+ considered to be adjacent to another part of the tiling grid. -+ </description> -+ </entry> -+ <entry name="tiled_bottom" value="8" since="2"> -+ <description summary="the surface is tiled"> -+ The window is currently in a tiled layout and the bottom edge is -+ considered to be adjacent to another part of the tiling grid. -+ </description> -+ </entry> - </enum> - - <request name="set_max_size"> -@@ -805,12 +869,11 @@ - Maximize the surface. - - After requesting that the surface should be maximized, the compositor -- will respond by emitting a configure event with the "maximized" state -- and the required window geometry. The client should then update its -- content, drawing it in a maximized state, i.e. without shadow or other -- decoration outside of the window geometry. The client must also -- acknowledge the configure when committing the new content (see -- ack_configure). -+ will respond by emitting a configure event. Whether this configure -+ actually sets the window maximized is subject to compositor policies. -+ The client must then update its content, drawing in the configured -+ state. The client must also acknowledge the configure when committing -+ the new content (see ack_configure). - - It is up to the compositor to decide how and where to maximize the - surface, for example which output and what region of the screen should -@@ -818,6 +881,10 @@ - - If the surface was already maximized, the compositor will still emit - a configure event with the "maximized" state. -+ -+ If the surface is in a fullscreen state, this request has no direct -+ effect. It may alter the state the surface is returned to when -+ unmaximized unless overridden by the compositor. - </description> - </request> - -@@ -826,13 +893,13 @@ - Unmaximize the surface. - - After requesting that the surface should be unmaximized, the compositor -- will respond by emitting a configure event without the "maximized" -- state. If available, the compositor will include the window geometry -- dimensions the window had prior to being maximized in the configure -- request. The client must then update its content, drawing it in a -- regular state, i.e. potentially with shadow, etc. The client must also -- acknowledge the configure when committing the new content (see -- ack_configure). -+ will respond by emitting a configure event. Whether this actually -+ un-maximizes the window is subject to compositor policies. -+ If available and applicable, the compositor will include the window -+ geometry dimensions the window had prior to being maximized in the -+ configure event. The client must then update its content, drawing it in -+ the configured state. The client must also acknowledge the configure -+ when committing the new content (see ack_configure). - - It is up to the compositor to position the surface after it was - unmaximized; usually the position the surface had before maximizing, if -@@ -840,24 +907,63 @@ - - If the surface was already not maximized, the compositor will still - emit a configure event without the "maximized" state. -+ -+ If the surface is in a fullscreen state, this request has no direct -+ effect. It may alter the state the surface is returned to when -+ unmaximized unless overridden by the compositor. - </description> - </request> - - <request name="set_fullscreen"> -- <description summary="set the window as fullscreen on a monitor"> -+ <description summary="set the window as fullscreen on an output"> - Make the surface fullscreen. - -- You can specify an output that you would prefer to be fullscreen. -- If this value is NULL, it's up to the compositor to choose which -- display will be used to map this surface. -+ After requesting that the surface should be fullscreened, the -+ compositor will respond by emitting a configure event. Whether the -+ client is actually put into a fullscreen state is subject to compositor -+ policies. The client must also acknowledge the configure when -+ committing the new content (see ack_configure). -+ -+ The output passed by the request indicates the client's preference as -+ to which display it should be set fullscreen on. If this value is NULL, -+ it's up to the compositor to choose which display will be used to map -+ this surface. - - If the surface doesn't cover the whole output, the compositor will - position the surface in the center of the output and compensate with -- black borders filling the rest of the output. -+ with border fill covering the rest of the output. The content of the -+ border fill is undefined, but should be assumed to be in some way that -+ attempts to blend into the surrounding area (e.g. solid black). -+ -+ If the fullscreened surface is not opaque, the compositor must make -+ sure that other screen content not part of the same surface tree (made -+ up of subsurfaces, popups or similarly coupled surfaces) are not -+ visible below the fullscreened surface. - </description> - <arg name="output" type="object" interface="wl_output" allow-null="true"/> - </request> -- <request name="unset_fullscreen" /> -+ -+ <request name="unset_fullscreen"> -+ <description summary="unset the window as fullscreen"> -+ Make the surface no longer fullscreen. -+ -+ After requesting that the surface should be unfullscreened, the -+ compositor will respond by emitting a configure event. -+ Whether this actually removes the fullscreen state of the client is -+ subject to compositor policies. -+ -+ Making a surface unfullscreen sets states for the surface based on the following: -+ * the state(s) it may have had before becoming fullscreen -+ * any state(s) decided by the compositor -+ * any state(s) requested by the client while the surface was fullscreen -+ -+ The compositor may include the previous window geometry dimensions in -+ the configure event, if applicable. -+ -+ The client must also acknowledge the configure when committing the new -+ content (see ack_configure). -+ </description> -+ </request> - - <request name="set_minimized"> - <description summary="set the window as minimized"> -@@ -913,7 +1019,7 @@ - </event> - </interface> - -- <interface name="zxdg_popup_v6" version="1"> -+ <interface name="xdg_popup" version="2"> - <description summary="short-lived, popup surfaces for menus"> - A popup surface is a short-lived, temporary surface. It can be used to - implement for example menus, popovers, tooltips and other similar user -@@ -931,9 +1037,6 @@ - surface of their own is clicked should dismiss the popup using the destroy - request. - -- The parent surface must have either the xdg_toplevel or xdg_popup surface -- role. -- - A newly created xdg_popup will be stacked on top of all previously created - xdg_popup surfaces associated with the same xdg_toplevel. - -diff --git a/vm_tools/sommelier/sommelier-xdg-shell.c b/vm_tools/sommelier/sommelier-xdg-shell.c -index ecd0fc647..a3ba0d6e1 100644 ---- a/vm_tools/sommelier/sommelier-xdg-shell.c -+++ b/vm_tools/sommelier/sommelier-xdg-shell.c -@@ -7,37 +7,37 @@ - #include <assert.h> - #include <stdlib.h> - --#include "xdg-shell-unstable-v6-client-protocol.h" --#include "xdg-shell-unstable-v6-server-protocol.h" -+#include "xdg-shell-client-protocol.h" -+#include "xdg-shell-server-protocol.h" - --struct sl_host_xdg_shell { -+struct sl_host_xdg_wm_base { - struct sl_context* ctx; - struct wl_resource* resource; -- struct zxdg_shell_v6* proxy; -+ struct xdg_wm_base* proxy; - }; - - struct sl_host_xdg_surface { - struct sl_context* ctx; - struct wl_resource* resource; -- struct zxdg_surface_v6* proxy; -+ struct xdg_surface* proxy; - }; - - struct sl_host_xdg_toplevel { - struct sl_context* ctx; - struct wl_resource* resource; -- struct zxdg_toplevel_v6* proxy; -+ struct xdg_toplevel* proxy; - }; - - struct sl_host_xdg_popup { - struct sl_context* ctx; - struct wl_resource* resource; -- struct zxdg_popup_v6* proxy; -+ struct xdg_popup* proxy; - }; - - struct sl_host_xdg_positioner { - struct sl_context* ctx; - struct wl_resource* resource; -- struct zxdg_positioner_v6* proxy; -+ struct xdg_positioner* proxy; - }; - - static void sl_xdg_positioner_destroy(struct wl_client* client, -@@ -52,7 +52,7 @@ static void sl_xdg_positioner_set_size(struct wl_client* client, - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - double scale = host->ctx->scale; - -- zxdg_positioner_v6_set_size(host->proxy, width / scale, height / scale); -+ xdg_positioner_set_size(host->proxy, width / scale, height / scale); - } - - static void sl_xdg_positioner_set_anchor_rect(struct wl_client* client, -@@ -70,7 +70,7 @@ static void sl_xdg_positioner_set_anchor_rect(struct wl_client* client, - x2 = (x + width) / scale; - y2 = (y + height) / scale; - -- zxdg_positioner_v6_set_anchor_rect(host->proxy, x1, y1, x2 - x1, y2 - y1); -+ xdg_positioner_set_anchor_rect(host->proxy, x1, y1, x2 - x1, y2 - y1); - } - - static void sl_xdg_positioner_set_anchor(struct wl_client* client, -@@ -78,7 +78,7 @@ static void sl_xdg_positioner_set_anchor(struct wl_client* client, - uint32_t anchor) { - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - -- zxdg_positioner_v6_set_anchor(host->proxy, anchor); -+ xdg_positioner_set_anchor(host->proxy, anchor); - } - - static void sl_xdg_positioner_set_gravity(struct wl_client* client, -@@ -86,7 +86,7 @@ static void sl_xdg_positioner_set_gravity(struct wl_client* client, - uint32_t gravity) { - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - -- zxdg_positioner_v6_set_gravity(host->proxy, gravity); -+ xdg_positioner_set_gravity(host->proxy, gravity); - } - - static void sl_xdg_positioner_set_constraint_adjustment( -@@ -95,8 +95,8 @@ static void sl_xdg_positioner_set_constraint_adjustment( - uint32_t constraint_adjustment) { - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - -- zxdg_positioner_v6_set_constraint_adjustment(host->proxy, -- constraint_adjustment); -+ xdg_positioner_set_constraint_adjustment(host->proxy, -+ constraint_adjustment); - } - - static void sl_xdg_positioner_set_offset(struct wl_client* client, -@@ -106,10 +106,10 @@ static void sl_xdg_positioner_set_offset(struct wl_client* client, - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - double scale = host->ctx->scale; - -- zxdg_positioner_v6_set_offset(host->proxy, x / scale, y / scale); -+ xdg_positioner_set_offset(host->proxy, x / scale, y / scale); - } - --static const struct zxdg_positioner_v6_interface -+static const struct xdg_positioner_interface - sl_xdg_positioner_implementation = { - sl_xdg_positioner_destroy, - sl_xdg_positioner_set_size, -@@ -122,7 +122,7 @@ static const struct zxdg_positioner_v6_interface - static void sl_destroy_host_xdg_positioner(struct wl_resource* resource) { - struct sl_host_xdg_positioner* host = wl_resource_get_user_data(resource); - -- zxdg_positioner_v6_destroy(host->proxy); -+ xdg_positioner_destroy(host->proxy); - wl_resource_set_user_data(resource, NULL); - free(host); - } -@@ -139,19 +139,19 @@ static void sl_xdg_popup_grab(struct wl_client* client, - struct sl_host_xdg_popup* host = wl_resource_get_user_data(resource); - struct sl_host_seat* host_seat = wl_resource_get_user_data(seat_resource); - -- zxdg_popup_v6_grab(host->proxy, host_seat->proxy, serial); -+ xdg_popup_grab(host->proxy, host_seat->proxy, serial); - } - --static const struct zxdg_popup_v6_interface sl_xdg_popup_implementation = { -+static const struct xdg_popup_interface sl_xdg_popup_implementation = { - sl_xdg_popup_destroy, sl_xdg_popup_grab}; - - static void sl_xdg_popup_configure(void* data, -- struct zxdg_popup_v6* xdg_popup, -+ struct xdg_popup* xdg_popup, - int32_t x, - int32_t y, - int32_t width, - int32_t height) { -- struct sl_host_xdg_popup* host = zxdg_popup_v6_get_user_data(xdg_popup); -+ struct sl_host_xdg_popup* host = xdg_popup_get_user_data(xdg_popup); - double scale = host->ctx->scale; - int32_t x1, y1, x2, y2; - -@@ -160,23 +160,23 @@ static void sl_xdg_popup_configure(void* data, - x2 = (x + width) * scale; - y2 = (y + height) * scale; - -- zxdg_popup_v6_send_configure(host->resource, x1, y1, x2 - x1, y2 - y1); -+ xdg_popup_send_configure(host->resource, x1, y1, x2 - x1, y2 - y1); - } - - static void sl_xdg_popup_popup_done(void* data, -- struct zxdg_popup_v6* xdg_popup) { -- struct sl_host_xdg_popup* host = zxdg_popup_v6_get_user_data(xdg_popup); -+ struct xdg_popup* xdg_popup) { -+ struct sl_host_xdg_popup* host = xdg_popup_get_user_data(xdg_popup); - -- zxdg_popup_v6_send_popup_done(host->resource); -+ xdg_popup_send_popup_done(host->resource); - } - --static const struct zxdg_popup_v6_listener sl_xdg_popup_listener = { -+static const struct xdg_popup_listener sl_xdg_popup_listener = { - sl_xdg_popup_configure, sl_xdg_popup_popup_done}; - - static void sl_destroy_host_xdg_popup(struct wl_resource* resource) { - struct sl_host_xdg_popup* host = wl_resource_get_user_data(resource); - -- zxdg_popup_v6_destroy(host->proxy); -+ xdg_popup_destroy(host->proxy); - wl_resource_set_user_data(resource, NULL); - free(host); - } -@@ -193,8 +193,8 @@ static void sl_xdg_toplevel_set_parent(struct wl_client* client, - struct sl_host_xdg_toplevel* host_parent = - parent_resource ? wl_resource_get_user_data(parent_resource) : NULL; - -- zxdg_toplevel_v6_set_parent(host->proxy, -- host_parent ? host_parent->proxy : NULL); -+ xdg_toplevel_set_parent(host->proxy, -+ host_parent ? host_parent->proxy : NULL); - } - - static void sl_xdg_toplevel_set_title(struct wl_client* client, -@@ -202,7 +202,7 @@ static void sl_xdg_toplevel_set_title(struct wl_client* client, - const char* title) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_title(host->proxy, title); -+ xdg_toplevel_set_title(host->proxy, title); - } - - static void sl_xdg_toplevel_set_app_id(struct wl_client* client, -@@ -210,7 +210,7 @@ static void sl_xdg_toplevel_set_app_id(struct wl_client* client, - const char* app_id) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_app_id(host->proxy, app_id); -+ xdg_toplevel_set_app_id(host->proxy, app_id); - } - - static void sl_xdg_toplevel_show_window_menu(struct wl_client* client, -@@ -223,7 +223,7 @@ static void sl_xdg_toplevel_show_window_menu(struct wl_client* client, - struct sl_host_seat* host_seat = - seat_resource ? wl_resource_get_user_data(seat_resource) : NULL; - -- zxdg_toplevel_v6_show_window_menu( -+ xdg_toplevel_show_window_menu( - host->proxy, host_seat ? host_seat->proxy : NULL, serial, x, y); - } - -@@ -235,8 +235,8 @@ static void sl_xdg_toplevel_move(struct wl_client* client, - struct sl_host_seat* host_seat = - seat_resource ? wl_resource_get_user_data(seat_resource) : NULL; - -- zxdg_toplevel_v6_move(host->proxy, host_seat ? host_seat->proxy : NULL, -- serial); -+ xdg_toplevel_move(host->proxy, host_seat ? host_seat->proxy : NULL, -+ serial); - } - - static void sl_xdg_toplevel_resize(struct wl_client* client, -@@ -248,8 +248,8 @@ static void sl_xdg_toplevel_resize(struct wl_client* client, - struct sl_host_seat* host_seat = - seat_resource ? wl_resource_get_user_data(seat_resource) : NULL; - -- zxdg_toplevel_v6_resize(host->proxy, host_seat ? host_seat->proxy : NULL, -- serial, edges); -+ xdg_toplevel_resize(host->proxy, host_seat ? host_seat->proxy : NULL, -+ serial, edges); - } - - static void sl_xdg_toplevel_set_max_size(struct wl_client* client, -@@ -258,7 +258,7 @@ static void sl_xdg_toplevel_set_max_size(struct wl_client* client, - int32_t height) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_max_size(host->proxy, width, height); -+ xdg_toplevel_set_max_size(host->proxy, width, height); - } - - static void sl_xdg_toplevel_set_min_size(struct wl_client* client, -@@ -267,21 +267,21 @@ static void sl_xdg_toplevel_set_min_size(struct wl_client* client, - int32_t height) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_min_size(host->proxy, width, height); -+ xdg_toplevel_set_min_size(host->proxy, width, height); - } - - static void sl_xdg_toplevel_set_maximized(struct wl_client* client, - struct wl_resource* resource) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_maximized(host->proxy); -+ xdg_toplevel_set_maximized(host->proxy); - } - - static void sl_xdg_toplevel_unset_maximized(struct wl_client* client, - struct wl_resource* resource) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_unset_maximized(host->proxy); -+ xdg_toplevel_unset_maximized(host->proxy); - } - - static void sl_xdg_toplevel_set_fullscreen( -@@ -292,25 +292,25 @@ static void sl_xdg_toplevel_set_fullscreen( - struct sl_host_output* host_output = - output_resource ? wl_resource_get_user_data(output_resource) : NULL; - -- zxdg_toplevel_v6_set_fullscreen(host->proxy, -- host_output ? host_output->proxy : NULL); -+ xdg_toplevel_set_fullscreen(host->proxy, -+ host_output ? host_output->proxy : NULL); - } - - static void sl_xdg_toplevel_unset_fullscreen(struct wl_client* client, - struct wl_resource* resource) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_unset_fullscreen(host->proxy); -+ xdg_toplevel_unset_fullscreen(host->proxy); - } - - static void sl_xdg_toplevel_set_minimized(struct wl_client* client, - struct wl_resource* resource) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_set_minimized(host->proxy); -+ xdg_toplevel_set_minimized(host->proxy); - } - --static const struct zxdg_toplevel_v6_interface sl_xdg_toplevel_implementation = -+static const struct xdg_toplevel_interface sl_xdg_toplevel_implementation = - {sl_xdg_toplevel_destroy, sl_xdg_toplevel_set_parent, - sl_xdg_toplevel_set_title, sl_xdg_toplevel_set_app_id, - sl_xdg_toplevel_show_window_menu, sl_xdg_toplevel_move, -@@ -320,33 +320,33 @@ static const struct zxdg_toplevel_v6_interface sl_xdg_toplevel_implementation = - sl_xdg_toplevel_unset_fullscreen, sl_xdg_toplevel_set_minimized}; - - static void sl_xdg_toplevel_configure(void* data, -- struct zxdg_toplevel_v6* xdg_toplevel, -+ struct xdg_toplevel* xdg_toplevel, - int32_t width, - int32_t height, - struct wl_array* states) { - struct sl_host_xdg_toplevel* host = -- zxdg_toplevel_v6_get_user_data(xdg_toplevel); -+ xdg_toplevel_get_user_data(xdg_toplevel); - double scale = host->ctx->scale; - -- zxdg_toplevel_v6_send_configure(host->resource, width * scale, height * scale, -+ xdg_toplevel_send_configure(host->resource, width * scale, height * scale, - states); - } - - static void sl_xdg_toplevel_close(void* data, -- struct zxdg_toplevel_v6* xdg_toplevel) { -+ struct xdg_toplevel* xdg_toplevel) { - struct sl_host_xdg_toplevel* host = -- zxdg_toplevel_v6_get_user_data(xdg_toplevel); -+ xdg_toplevel_get_user_data(xdg_toplevel); - -- zxdg_toplevel_v6_send_close(host->resource); -+ xdg_toplevel_send_close(host->resource); - } - --static const struct zxdg_toplevel_v6_listener sl_xdg_toplevel_listener = { -+static const struct xdg_toplevel_listener sl_xdg_toplevel_listener = { - sl_xdg_toplevel_configure, sl_xdg_toplevel_close}; - - static void sl_destroy_host_xdg_toplevel(struct wl_resource* resource) { - struct sl_host_xdg_toplevel* host = wl_resource_get_user_data(resource); - -- zxdg_toplevel_v6_destroy(host->proxy); -+ xdg_toplevel_destroy(host->proxy); - wl_resource_set_user_data(resource, NULL); - free(host); - } -@@ -367,14 +367,15 @@ static void sl_xdg_surface_get_toplevel(struct wl_client* client, - - host_xdg_toplevel->ctx = host->ctx; - host_xdg_toplevel->resource = -- wl_resource_create(client, &zxdg_toplevel_v6_interface, 1, id); -+ wl_resource_create(client, &xdg_toplevel_interface, -+ wl_resource_get_version(resource), id); - wl_resource_set_implementation( - host_xdg_toplevel->resource, &sl_xdg_toplevel_implementation, - host_xdg_toplevel, sl_destroy_host_xdg_toplevel); -- host_xdg_toplevel->proxy = zxdg_surface_v6_get_toplevel(host->proxy); -- zxdg_toplevel_v6_set_user_data(host_xdg_toplevel->proxy, host_xdg_toplevel); -- zxdg_toplevel_v6_add_listener(host_xdg_toplevel->proxy, -- &sl_xdg_toplevel_listener, host_xdg_toplevel); -+ host_xdg_toplevel->proxy = xdg_surface_get_toplevel(host->proxy); -+ xdg_toplevel_set_user_data(host_xdg_toplevel->proxy, host_xdg_toplevel); -+ xdg_toplevel_add_listener(host_xdg_toplevel->proxy, -+ &sl_xdg_toplevel_listener, host_xdg_toplevel); - } - - static void sl_xdg_surface_get_popup(struct wl_client* client, -@@ -394,15 +395,16 @@ static void sl_xdg_surface_get_popup(struct wl_client* client, - - host_xdg_popup->ctx = host->ctx; - host_xdg_popup->resource = -- wl_resource_create(client, &zxdg_popup_v6_interface, 1, id); -+ wl_resource_create(client, &xdg_popup_interface, -+ wl_resource_get_version(resource), id); - wl_resource_set_implementation(host_xdg_popup->resource, - &sl_xdg_popup_implementation, host_xdg_popup, - sl_destroy_host_xdg_popup); -- host_xdg_popup->proxy = zxdg_surface_v6_get_popup( -+ host_xdg_popup->proxy = xdg_surface_get_popup( - host->proxy, host_parent->proxy, host_positioner->proxy); -- zxdg_popup_v6_set_user_data(host_xdg_popup->proxy, host_xdg_popup); -- zxdg_popup_v6_add_listener(host_xdg_popup->proxy, &sl_xdg_popup_listener, -- host_xdg_popup); -+ xdg_popup_set_user_data(host_xdg_popup->proxy, host_xdg_popup); -+ xdg_popup_add_listener(host_xdg_popup->proxy, &sl_xdg_popup_listener, -+ host_xdg_popup); - } - - static void sl_xdg_surface_set_window_geometry(struct wl_client* client, -@@ -420,7 +422,7 @@ static void sl_xdg_surface_set_window_geometry(struct wl_client* client, - x2 = (x + width) / scale; - y2 = (y + height) / scale; - -- zxdg_surface_v6_set_window_geometry(host->proxy, x1, y1, x2 - x1, y2 - y1); -+ xdg_surface_set_window_geometry(host->proxy, x1, y1, x2 - x1, y2 - y1); - } - - static void sl_xdg_surface_ack_configure(struct wl_client* client, -@@ -428,63 +430,64 @@ static void sl_xdg_surface_ack_configure(struct wl_client* client, - uint32_t serial) { - struct sl_host_xdg_surface* host = wl_resource_get_user_data(resource); - -- zxdg_surface_v6_ack_configure(host->proxy, serial); -+ xdg_surface_ack_configure(host->proxy, serial); - } - --static const struct zxdg_surface_v6_interface sl_xdg_surface_implementation = { -+static const struct xdg_surface_interface sl_xdg_surface_implementation = { - sl_xdg_surface_destroy, sl_xdg_surface_get_toplevel, - sl_xdg_surface_get_popup, sl_xdg_surface_set_window_geometry, - sl_xdg_surface_ack_configure}; - - static void sl_xdg_surface_configure(void* data, -- struct zxdg_surface_v6* xdg_surface, -+ struct xdg_surface* xdg_surface, - uint32_t serial) { -- struct sl_host_xdg_surface* host = zxdg_surface_v6_get_user_data(xdg_surface); -+ struct sl_host_xdg_surface* host = xdg_surface_get_user_data(xdg_surface); - -- zxdg_surface_v6_send_configure(host->resource, serial); -+ xdg_surface_send_configure(host->resource, serial); - } - --static const struct zxdg_surface_v6_listener sl_xdg_surface_listener = { -+static const struct xdg_surface_listener sl_xdg_surface_listener = { - sl_xdg_surface_configure}; - - static void sl_destroy_host_xdg_surface(struct wl_resource* resource) { - struct sl_host_xdg_surface* host = wl_resource_get_user_data(resource); - -- zxdg_surface_v6_destroy(host->proxy); -+ xdg_surface_destroy(host->proxy); - wl_resource_set_user_data(resource, NULL); - free(host); - } - --static void sl_xdg_shell_destroy(struct wl_client* client, -+static void sl_xdg_wm_base_destroy(struct wl_client* client, - struct wl_resource* resource) { - wl_resource_destroy(resource); - } - --static void sl_xdg_shell_create_positioner(struct wl_client* client, -+static void sl_xdg_wm_base_create_positioner(struct wl_client* client, - struct wl_resource* resource, - uint32_t id) { -- struct sl_host_xdg_shell* host = wl_resource_get_user_data(resource); -+ struct sl_host_xdg_wm_base* host = wl_resource_get_user_data(resource); - struct sl_host_xdg_positioner* host_xdg_positioner; - - host_xdg_positioner = malloc(sizeof(*host_xdg_positioner)); - assert(host_xdg_positioner); - - host_xdg_positioner->ctx = host->ctx; -- host_xdg_positioner->resource = -- wl_resource_create(client, &zxdg_positioner_v6_interface, 1, id); -+ host_xdg_positioner->resource = wl_resource_create( -+ client, &xdg_positioner_interface, -+ wl_resource_get_version(resource), id); - wl_resource_set_implementation( - host_xdg_positioner->resource, &sl_xdg_positioner_implementation, - host_xdg_positioner, sl_destroy_host_xdg_positioner); -- host_xdg_positioner->proxy = zxdg_shell_v6_create_positioner(host->proxy); -- zxdg_positioner_v6_set_user_data(host_xdg_positioner->proxy, -- host_xdg_positioner); -+ host_xdg_positioner->proxy = xdg_wm_base_create_positioner(host->proxy); -+ xdg_positioner_set_user_data(host_xdg_positioner->proxy, -+ host_xdg_positioner); - } - --static void sl_xdg_shell_get_xdg_surface(struct wl_client* client, -+static void sl_xdg_wm_base_get_xdg_surface(struct wl_client* client, - struct wl_resource* resource, - uint32_t id, - struct wl_resource* surface_resource) { -- struct sl_host_xdg_shell* host = wl_resource_get_user_data(resource); -+ struct sl_host_xdg_wm_base* host = wl_resource_get_user_data(resource); - struct sl_host_surface* host_surface = - wl_resource_get_user_data(surface_resource); - struct sl_host_xdg_surface* host_xdg_surface; -@@ -493,71 +496,75 @@ static void sl_xdg_shell_get_xdg_surface(struct wl_client* client, - assert(host_xdg_surface); - - host_xdg_surface->ctx = host->ctx; -- host_xdg_surface->resource = -- wl_resource_create(client, &zxdg_surface_v6_interface, 1, id); -+ host_xdg_surface->resource = wl_resource_create( -+ client, &xdg_surface_interface, -+ wl_resource_get_version(resource), id); - wl_resource_set_implementation(host_xdg_surface->resource, - &sl_xdg_surface_implementation, - host_xdg_surface, sl_destroy_host_xdg_surface); - host_xdg_surface->proxy = -- zxdg_shell_v6_get_xdg_surface(host->proxy, host_surface->proxy); -- zxdg_surface_v6_set_user_data(host_xdg_surface->proxy, host_xdg_surface); -- zxdg_surface_v6_add_listener(host_xdg_surface->proxy, -- &sl_xdg_surface_listener, host_xdg_surface); -+ xdg_wm_base_get_xdg_surface(host->proxy, host_surface->proxy); -+ xdg_surface_set_user_data(host_xdg_surface->proxy, host_xdg_surface); -+ xdg_surface_add_listener(host_xdg_surface->proxy, -+ &sl_xdg_surface_listener, host_xdg_surface); - host_surface->has_role = 1; - } - --static void sl_xdg_shell_pong(struct wl_client* client, -+static void sl_xdg_wm_base_pong(struct wl_client* client, - struct wl_resource* resource, - uint32_t serial) { -- struct sl_host_xdg_shell* host = wl_resource_get_user_data(resource); -+ struct sl_host_xdg_wm_base* host = wl_resource_get_user_data(resource); - -- zxdg_shell_v6_pong(host->proxy, serial); -+ xdg_wm_base_pong(host->proxy, serial); - } - --static const struct zxdg_shell_v6_interface sl_xdg_shell_implementation = { -- sl_xdg_shell_destroy, sl_xdg_shell_create_positioner, -- sl_xdg_shell_get_xdg_surface, sl_xdg_shell_pong}; -+static const struct xdg_wm_base_interface sl_xdg_wm_base_implementation = { -+ sl_xdg_wm_base_destroy, sl_xdg_wm_base_create_positioner, -+ sl_xdg_wm_base_get_xdg_surface, sl_xdg_wm_base_pong}; - --static void sl_xdg_shell_ping(void* data, -- struct zxdg_shell_v6* xdg_shell, -+static void sl_xdg_wm_base_ping(void* data, -+ struct xdg_wm_base* xdg_wm_base, - uint32_t serial) { -- struct sl_host_xdg_shell* host = zxdg_shell_v6_get_user_data(xdg_shell); -+ struct sl_host_xdg_wm_base* host = xdg_wm_base_get_user_data(xdg_wm_base); - -- zxdg_shell_v6_send_ping(host->resource, serial); -+ xdg_wm_base_send_ping(host->resource, serial); - } - --static const struct zxdg_shell_v6_listener sl_xdg_shell_listener = { -- sl_xdg_shell_ping}; -+static const struct xdg_wm_base_listener sl_xdg_wm_base_listener = { -+ sl_xdg_wm_base_ping}; - --static void sl_destroy_host_xdg_shell(struct wl_resource* resource) { -- struct sl_host_xdg_shell* host = wl_resource_get_user_data(resource); -+static void sl_destroy_host_xdg_wm_base(struct wl_resource* resource) { -+ struct sl_host_xdg_wm_base* host = wl_resource_get_user_data(resource); - -- zxdg_shell_v6_destroy(host->proxy); -+ xdg_wm_base_destroy(host->proxy); - wl_resource_set_user_data(resource, NULL); - free(host); - } - --static void sl_bind_host_xdg_shell(struct wl_client* client, -+static void sl_bind_host_xdg_wm_base(struct wl_client* client, - void* data, - uint32_t version, - uint32_t id) { - struct sl_context* ctx = (struct sl_context*)data; -- struct sl_host_xdg_shell* host; -+ struct sl_host_xdg_wm_base* host; - - host = malloc(sizeof(*host)); - assert(host); - host->ctx = ctx; -- host->resource = wl_resource_create(client, &zxdg_shell_v6_interface, 1, id); -- wl_resource_set_implementation(host->resource, &sl_xdg_shell_implementation, -- host, sl_destroy_host_xdg_shell); -+ host->resource = wl_resource_create(client, &xdg_wm_base_interface, -+ ctx->xdg_wm_base->id, id); -+ wl_resource_set_implementation(host->resource, &sl_xdg_wm_base_implementation, -+ host, sl_destroy_host_xdg_wm_base); - host->proxy = - wl_registry_bind(wl_display_get_registry(ctx->display), -- ctx->xdg_shell->id, &zxdg_shell_v6_interface, 1); -- zxdg_shell_v6_set_user_data(host->proxy, host); -- zxdg_shell_v6_add_listener(host->proxy, &sl_xdg_shell_listener, host); -+ ctx->xdg_wm_base->id, &xdg_wm_base_interface, -+ ctx->xdg_wm_base->version); -+ xdg_wm_base_set_user_data(host->proxy, host); -+ xdg_wm_base_add_listener(host->proxy, &sl_xdg_wm_base_listener, host); - } - --struct sl_global* sl_xdg_shell_global_create(struct sl_context* ctx) { -- return sl_global_create(ctx, &zxdg_shell_v6_interface, 1, ctx, -- sl_bind_host_xdg_shell); -+struct sl_global* sl_xdg_wm_base_global_create(struct sl_context* ctx) { -+ return sl_global_create(ctx, &xdg_wm_base_interface, -+ ctx->xdg_wm_base->version, ctx, -+ sl_bind_host_xdg_wm_base); - } -diff --git a/vm_tools/sommelier/sommelier.c b/vm_tools/sommelier/sommelier.c -index 98e101135..9a56f350d 100644 ---- a/vm_tools/sommelier/sommelier.c -+++ b/vm_tools/sommelier/sommelier.c -@@ -35,7 +35,7 @@ - #include "relative-pointer-unstable-v1-client-protocol.h" - #include "text-input-unstable-v1-client-protocol.h" - #include "viewporter-client-protocol.h" --#include "xdg-shell-unstable-v6-client-protocol.h" -+#include "xdg-shell-client-protocol.h" - - #define errno_assert(rv) \ - { \ -@@ -281,14 +281,14 @@ void sl_sync_point_destroy(struct sl_sync_point* sync_point) { - free(sync_point); - } - --static void sl_internal_xdg_shell_ping(void* data, -- struct zxdg_shell_v6* xdg_shell, -+static void sl_internal_xdg_wm_base_ping(void* data, -+ struct xdg_wm_base* xdg_wm_base, - uint32_t serial) { -- zxdg_shell_v6_pong(xdg_shell, serial); -+ xdg_wm_base_pong(xdg_wm_base, serial); - } - --static const struct zxdg_shell_v6_listener sl_internal_xdg_shell_listener = { -- sl_internal_xdg_shell_ping}; -+static const struct xdg_wm_base_listener sl_internal_xdg_wm_base_listener = { -+ sl_internal_xdg_wm_base_ping}; - - static void sl_send_configure_notify(struct sl_window* window) { - xcb_configure_notify_event_t event = { -@@ -451,8 +451,8 @@ int sl_process_pending_configure_acks(struct sl_window* window, - } - - if (window->xdg_surface) { -- zxdg_surface_v6_ack_configure(window->xdg_surface, -- window->pending_config.serial); -+ xdg_surface_ack_configure(window->xdg_surface, -+ window->pending_config.serial); - } - window->pending_config.serial = 0; - -@@ -463,8 +463,8 @@ int sl_process_pending_configure_acks(struct sl_window* window, - } - - static void sl_internal_xdg_surface_configure( -- void* data, struct zxdg_surface_v6* xdg_surface, uint32_t serial) { -- struct sl_window* window = zxdg_surface_v6_get_user_data(xdg_surface); -+ void* data, struct xdg_surface* xdg_surface, uint32_t serial) { -+ struct sl_window* window = xdg_surface_get_user_data(xdg_surface); - - window->next_config.serial = serial; - if (!window->pending_config.serial) { -@@ -485,16 +485,16 @@ static void sl_internal_xdg_surface_configure( - } - } - --static const struct zxdg_surface_v6_listener sl_internal_xdg_surface_listener = -+static const struct xdg_surface_listener sl_internal_xdg_surface_listener = - {sl_internal_xdg_surface_configure}; - - static void sl_internal_xdg_toplevel_configure( - void* data, -- struct zxdg_toplevel_v6* xdg_toplevel, -+ struct xdg_toplevel* xdg_toplevel, - int32_t width, - int32_t height, - struct wl_array* states) { -- struct sl_window* window = zxdg_toplevel_v6_get_user_data(xdg_toplevel); -+ struct sl_window* window = xdg_toplevel_get_user_data(xdg_toplevel); - int activated = 0; - uint32_t* state; - int i = 0; -@@ -524,21 +524,21 @@ static void sl_internal_xdg_toplevel_configure( - - window->allow_resize = 1; - wl_array_for_each(state, states) { -- if (*state == ZXDG_TOPLEVEL_V6_STATE_FULLSCREEN) { -+ if (*state == XDG_TOPLEVEL_STATE_FULLSCREEN) { - window->allow_resize = 0; - window->next_config.states[i++] = - window->ctx->atoms[ATOM_NET_WM_STATE_FULLSCREEN].value; - } -- if (*state == ZXDG_TOPLEVEL_V6_STATE_MAXIMIZED) { -+ if (*state == XDG_TOPLEVEL_STATE_MAXIMIZED) { - window->allow_resize = 0; - window->next_config.states[i++] = - window->ctx->atoms[ATOM_NET_WM_STATE_MAXIMIZED_VERT].value; - window->next_config.states[i++] = - window->ctx->atoms[ATOM_NET_WM_STATE_MAXIMIZED_HORZ].value; - } -- if (*state == ZXDG_TOPLEVEL_V6_STATE_ACTIVATED) -+ if (*state == XDG_TOPLEVEL_STATE_ACTIVATED) - activated = 1; -- if (*state == ZXDG_TOPLEVEL_V6_STATE_RESIZING) -+ if (*state == XDG_TOPLEVEL_STATE_RESIZING) - window->allow_resize = 0; - } - -@@ -554,8 +554,8 @@ static void sl_internal_xdg_toplevel_configure( - } - - static void sl_internal_xdg_toplevel_close( -- void* data, struct zxdg_toplevel_v6* xdg_toplevel) { -- struct sl_window* window = zxdg_toplevel_v6_get_user_data(xdg_toplevel); -+ void* data, struct xdg_toplevel* xdg_toplevel) { -+ struct sl_window* window = xdg_toplevel_get_user_data(xdg_toplevel); - xcb_client_message_event_t event = { - .response_type = XCB_CLIENT_MESSAGE, - .format = 32, -@@ -572,21 +572,21 @@ static void sl_internal_xdg_toplevel_close( - XCB_EVENT_MASK_NO_EVENT, (const char*)&event); - } - --static const struct zxdg_toplevel_v6_listener -+static const struct xdg_toplevel_listener - sl_internal_xdg_toplevel_listener = {sl_internal_xdg_toplevel_configure, - sl_internal_xdg_toplevel_close}; - - static void sl_internal_xdg_popup_configure(void* data, -- struct zxdg_popup_v6* xdg_popup, -+ struct xdg_popup* xdg_popup, - int32_t x, - int32_t y, - int32_t width, - int32_t height) {} - - static void sl_internal_xdg_popup_done(void* data, -- struct zxdg_popup_v6* zxdg_popup_v6) {} -+ struct xdg_popup* xdg_popup) {} - --static const struct zxdg_popup_v6_listener sl_internal_xdg_popup_listener = { -+static const struct xdg_popup_listener sl_internal_xdg_popup_listener = { - sl_internal_xdg_popup_configure, sl_internal_xdg_popup_done}; - - static void sl_window_set_wm_state(struct sl_window* window, int state) { -@@ -654,15 +654,15 @@ void sl_window_update(struct sl_window* window) { - window->aura_surface = NULL; - } - if (window->xdg_toplevel) { -- zxdg_toplevel_v6_destroy(window->xdg_toplevel); -+ xdg_toplevel_destroy(window->xdg_toplevel); - window->xdg_toplevel = NULL; - } - if (window->xdg_popup) { -- zxdg_popup_v6_destroy(window->xdg_popup); -+ xdg_popup_destroy(window->xdg_popup); - window->xdg_popup = NULL; - } - if (window->xdg_surface) { -- zxdg_surface_v6_destroy(window->xdg_surface); -+ xdg_surface_destroy(window->xdg_surface); - window->xdg_surface = NULL; - } - window->realized = 0; -@@ -673,8 +673,8 @@ void sl_window_update(struct sl_window* window) { - assert(host_surface); - assert(!host_surface->has_role); - -- assert(ctx->xdg_shell); -- assert(ctx->xdg_shell->internal); -+ assert(ctx->xdg_wm_base); -+ assert(ctx->xdg_wm_base->internal); - - if (window->managed) { - if (window->transient_for != XCB_WINDOW_NONE) { -@@ -736,11 +736,11 @@ void sl_window_update(struct sl_window* window) { - } - - if (!window->xdg_surface) { -- window->xdg_surface = zxdg_shell_v6_get_xdg_surface( -- ctx->xdg_shell->internal, host_surface->proxy); -- zxdg_surface_v6_set_user_data(window->xdg_surface, window); -- zxdg_surface_v6_add_listener(window->xdg_surface, -- &sl_internal_xdg_surface_listener, window); -+ window->xdg_surface = xdg_wm_base_get_xdg_surface( -+ ctx->xdg_wm_base->internal, host_surface->proxy); -+ xdg_surface_set_user_data(window->xdg_surface, window); -+ xdg_surface_add_listener(window->xdg_surface, -+ &sl_internal_xdg_surface_listener, window); - } - - if (ctx->aura_shell) { -@@ -770,50 +770,50 @@ void sl_window_update(struct sl_window* window) { - // window is closed. - if (ctx->xwayland || !parent) { - if (!window->xdg_toplevel) { -- window->xdg_toplevel = zxdg_surface_v6_get_toplevel(window->xdg_surface); -- zxdg_toplevel_v6_set_user_data(window->xdg_toplevel, window); -- zxdg_toplevel_v6_add_listener(window->xdg_toplevel, -+ window->xdg_toplevel = xdg_surface_get_toplevel(window->xdg_surface); -+ xdg_toplevel_set_user_data(window->xdg_toplevel, window); -+ xdg_toplevel_add_listener(window->xdg_toplevel, - &sl_internal_xdg_toplevel_listener, window); - } - if (parent) -- zxdg_toplevel_v6_set_parent(window->xdg_toplevel, parent->xdg_toplevel); -+ xdg_toplevel_set_parent(window->xdg_toplevel, parent->xdg_toplevel); - if (window->name) -- zxdg_toplevel_v6_set_title(window->xdg_toplevel, window->name); -+ xdg_toplevel_set_title(window->xdg_toplevel, window->name); - if (window->size_flags & P_MIN_SIZE) { -- zxdg_toplevel_v6_set_min_size(window->xdg_toplevel, -+ xdg_toplevel_set_min_size(window->xdg_toplevel, - window->min_width / ctx->scale, - window->min_height / ctx->scale); - } - if (window->size_flags & P_MAX_SIZE) { -- zxdg_toplevel_v6_set_max_size(window->xdg_toplevel, -+ xdg_toplevel_set_max_size(window->xdg_toplevel, - window->max_width / ctx->scale, - window->max_height / ctx->scale); - } - if (window->maximized) { -- zxdg_toplevel_v6_set_maximized(window->xdg_toplevel); -+ xdg_toplevel_set_maximized(window->xdg_toplevel); - } - } else if (!window->xdg_popup) { -- struct zxdg_positioner_v6* positioner; -+ struct xdg_positioner* positioner; - -- positioner = zxdg_shell_v6_create_positioner(ctx->xdg_shell->internal); -+ positioner = xdg_wm_base_create_positioner(ctx->xdg_wm_base->internal); - assert(positioner); -- zxdg_positioner_v6_set_anchor( -+ xdg_positioner_set_anchor( - positioner, -- ZXDG_POSITIONER_V6_ANCHOR_TOP | ZXDG_POSITIONER_V6_ANCHOR_LEFT); -- zxdg_positioner_v6_set_gravity( -+ XDG_POSITIONER_ANCHOR_TOP | XDG_POSITIONER_ANCHOR_LEFT); -+ xdg_positioner_set_gravity( - positioner, -- ZXDG_POSITIONER_V6_GRAVITY_BOTTOM | ZXDG_POSITIONER_V6_GRAVITY_RIGHT); -- zxdg_positioner_v6_set_anchor_rect( -+ XDG_POSITIONER_GRAVITY_BOTTOM | XDG_POSITIONER_GRAVITY_RIGHT); -+ xdg_positioner_set_anchor_rect( - positioner, (window->x - parent->x) / ctx->scale, - (window->y - parent->y) / ctx->scale, 1, 1); - -- window->xdg_popup = zxdg_surface_v6_get_popup( -+ window->xdg_popup = xdg_surface_get_popup( - window->xdg_surface, parent->xdg_surface, positioner); -- zxdg_popup_v6_set_user_data(window->xdg_popup, window); -- zxdg_popup_v6_add_listener(window->xdg_popup, -+ xdg_popup_set_user_data(window->xdg_popup, window); -+ xdg_popup_add_listener(window->xdg_popup, - &sl_internal_xdg_popup_listener, window); - -- zxdg_positioner_v6_destroy(positioner); -+ xdg_positioner_destroy(positioner); - } - - if ((window->size_flags & (US_POSITION | P_POSITION)) && parent && -@@ -1177,22 +1177,23 @@ static void sl_registry_handler(void* data, - data_device_manager->host_global = - sl_data_device_manager_global_create(ctx); - } -- } else if (strcmp(interface, "zxdg_shell_v6") == 0) { -- struct sl_xdg_shell* xdg_shell = malloc(sizeof(struct sl_xdg_shell)); -- assert(xdg_shell); -- xdg_shell->ctx = ctx; -- xdg_shell->id = id; -- xdg_shell->internal = NULL; -- xdg_shell->host_global = NULL; -- assert(!ctx->xdg_shell); -- ctx->xdg_shell = xdg_shell; -+ } else if (strcmp(interface, "xdg_wm_base") == 0) { -+ struct sl_xdg_wm_base* xdg_wm_base = malloc(sizeof(struct sl_xdg_wm_base)); -+ assert(xdg_wm_base); -+ xdg_wm_base->ctx = ctx; -+ xdg_wm_base->id = id; -+ xdg_wm_base->version = MIN(2, version); -+ xdg_wm_base->internal = NULL; -+ xdg_wm_base->host_global = NULL; -+ assert(!ctx->xdg_wm_base); -+ ctx->xdg_wm_base = xdg_wm_base; - if (ctx->xwayland) { -- xdg_shell->internal = -- wl_registry_bind(registry, id, &zxdg_shell_v6_interface, 1); -- zxdg_shell_v6_add_listener(xdg_shell->internal, -- &sl_internal_xdg_shell_listener, NULL); -+ xdg_wm_base->internal = -+ wl_registry_bind(registry, id, &xdg_wm_base_interface, 1); -+ xdg_wm_base_add_listener(xdg_wm_base->internal, -+ &sl_internal_xdg_wm_base_listener, NULL); - } else { -- xdg_shell->host_global = sl_xdg_shell_global_create(ctx); -+ xdg_wm_base->host_global = sl_xdg_wm_base_global_create(ctx); - } - } else if (strcmp(interface, "zaura_shell") == 0) { - if (version >= MIN_AURA_SHELL_VERSION) { -@@ -1299,13 +1300,13 @@ static void sl_registry_remover(void* data, - ctx->data_device_manager = NULL; - return; - } -- if (ctx->xdg_shell && ctx->xdg_shell->id == id) { -- if (ctx->xdg_shell->host_global) -- sl_global_destroy(ctx->xdg_shell->host_global); -- if (ctx->xdg_shell->internal) -- zxdg_shell_v6_destroy(ctx->xdg_shell->internal); -- free(ctx->xdg_shell); -- ctx->xdg_shell = NULL; -+ if (ctx->xdg_wm_base && ctx->xdg_wm_base->id == id) { -+ if (ctx->xdg_wm_base->host_global) -+ sl_global_destroy(ctx->xdg_wm_base->host_global); -+ if (ctx->xdg_wm_base->internal) -+ xdg_wm_base_destroy(ctx->xdg_wm_base->internal); -+ free(ctx->xdg_wm_base); -+ ctx->xdg_wm_base = NULL; - return; - } - if (ctx->aura_shell && ctx->aura_shell->id == id) { -@@ -1467,11 +1468,11 @@ static void sl_destroy_window(struct sl_window* window) { - } - - if (window->xdg_popup) -- zxdg_popup_v6_destroy(window->xdg_popup); -+ xdg_popup_destroy(window->xdg_popup); - if (window->xdg_toplevel) -- zxdg_toplevel_v6_destroy(window->xdg_toplevel); -+ xdg_toplevel_destroy(window->xdg_toplevel); - if (window->xdg_surface) -- zxdg_surface_v6_destroy(window->xdg_surface); -+ xdg_surface_destroy(window->xdg_surface); - if (window->aura_surface) - zaura_surface_destroy(window->aura_surface); - -@@ -1915,15 +1916,15 @@ static void sl_handle_configure_request(struct sl_context* ctx, - // that matching contents will arrive. - if (window->xdg_toplevel) { - if (window->pending_config.serial) { -- zxdg_surface_v6_ack_configure(window->xdg_surface, -- window->pending_config.serial); -+ xdg_surface_ack_configure(window->xdg_surface, -+ window->pending_config.serial); - window->pending_config.serial = 0; - window->pending_config.mask = 0; - window->pending_config.states_length = 0; - } - if (window->next_config.serial) { -- zxdg_surface_v6_ack_configure(window->xdg_surface, -- window->next_config.serial); -+ xdg_surface_ack_configure(window->xdg_surface, -+ window->next_config.serial); - window->next_config.serial = 0; - window->next_config.mask = 0; - window->next_config.states_length = 0; -@@ -2044,23 +2045,23 @@ static void sl_handle_configure_notify(struct sl_context* ctx, - static uint32_t sl_resize_edge(int net_wm_moveresize_size) { - switch (net_wm_moveresize_size) { - case NET_WM_MOVERESIZE_SIZE_TOPLEFT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP_LEFT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT; - case NET_WM_MOVERESIZE_SIZE_TOP: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP; -+ return XDG_TOPLEVEL_RESIZE_EDGE_TOP; - case NET_WM_MOVERESIZE_SIZE_TOPRIGHT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_TOP_RIGHT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT; - case NET_WM_MOVERESIZE_SIZE_RIGHT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_RIGHT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_RIGHT; - case NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM_RIGHT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT; - case NET_WM_MOVERESIZE_SIZE_BOTTOM: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM; -+ return XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM; - case NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_BOTTOM_LEFT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT; - case NET_WM_MOVERESIZE_SIZE_LEFT: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_LEFT; -+ return XDG_TOPLEVEL_RESIZE_EDGE_LEFT; - default: -- return ZXDG_TOPLEVEL_V6_RESIZE_EDGE_NONE; -+ return XDG_TOPLEVEL_RESIZE_EDGE_NONE; - } - } - -@@ -2107,15 +2108,15 @@ static void sl_handle_client_message(struct sl_context* ctx, - return; - - if (event->data.data32[2] == NET_WM_MOVERESIZE_MOVE) { -- zxdg_toplevel_v6_move(window->xdg_toplevel, seat->proxy, -+ xdg_toplevel_move(window->xdg_toplevel, seat->proxy, - seat->seat->last_serial); - } else { - uint32_t edge = sl_resize_edge(event->data.data32[2]); - -- if (edge == ZXDG_TOPLEVEL_V6_RESIZE_EDGE_NONE) -+ if (edge == XDG_TOPLEVEL_RESIZE_EDGE_NONE) - return; - -- zxdg_toplevel_v6_resize(window->xdg_toplevel, seat->proxy, -+ xdg_toplevel_resize(window->xdg_toplevel, seat->proxy, - seat->seat->last_serial, edge); - } - } -@@ -2134,24 +2135,24 @@ static void sl_handle_client_message(struct sl_context* ctx, - - if (changed[ATOM_NET_WM_STATE_FULLSCREEN]) { - if (action == NET_WM_STATE_ADD) -- zxdg_toplevel_v6_set_fullscreen(window->xdg_toplevel, NULL); -+ xdg_toplevel_set_fullscreen(window->xdg_toplevel, NULL); - else if (action == NET_WM_STATE_REMOVE) -- zxdg_toplevel_v6_unset_fullscreen(window->xdg_toplevel); -+ xdg_toplevel_unset_fullscreen(window->xdg_toplevel); - } - - if (changed[ATOM_NET_WM_STATE_MAXIMIZED_VERT] && - changed[ATOM_NET_WM_STATE_MAXIMIZED_HORZ]) { - if (action == NET_WM_STATE_ADD) -- zxdg_toplevel_v6_set_maximized(window->xdg_toplevel); -+ xdg_toplevel_set_maximized(window->xdg_toplevel); - else if (action == NET_WM_STATE_REMOVE) -- zxdg_toplevel_v6_unset_maximized(window->xdg_toplevel); -+ xdg_toplevel_unset_maximized(window->xdg_toplevel); - } - } - } else if (event->type == ctx->atoms[ATOM_WM_CHANGE_STATE].value && - event->data.data32[0] == WM_STATE_ICONIC) { - struct sl_window* window = sl_lookup_window(ctx, event->window); - if (window && window->xdg_toplevel) { -- zxdg_toplevel_v6_set_minimized(window->xdg_toplevel); -+ xdg_toplevel_set_minimized(window->xdg_toplevel); - } - } - } -@@ -2164,7 +2165,7 @@ static void sl_handle_focus_in(struct sl_context* ctx, - // window was realized. - struct sl_window* parent = sl_lookup_window(ctx, window->transient_for); - if (parent && parent->xdg_toplevel && window->xdg_toplevel) -- zxdg_toplevel_v6_set_parent(window->xdg_toplevel, parent->xdg_toplevel); -+ xdg_toplevel_set_parent(window->xdg_toplevel, parent->xdg_toplevel); - } - } - -@@ -2381,9 +2382,9 @@ static void sl_handle_property_notify(struct sl_context* ctx, - return; - - if (window->name) { -- zxdg_toplevel_v6_set_title(window->xdg_toplevel, window->name); -+ xdg_toplevel_set_title(window->xdg_toplevel, window->name); - } else { -- zxdg_toplevel_v6_set_title(window->xdg_toplevel, ""); -+ xdg_toplevel_set_title(window->xdg_toplevel, ""); - } - } else if (event->atom == XCB_ATOM_WM_CLASS) { - struct sl_window* window = sl_lookup_window(ctx, event->window); -@@ -2435,19 +2436,19 @@ static void sl_handle_property_notify(struct sl_context* ctx, - return; - - if (window->size_flags & P_MIN_SIZE) { -- zxdg_toplevel_v6_set_min_size(window->xdg_toplevel, -+ xdg_toplevel_set_min_size(window->xdg_toplevel, - window->min_width / ctx->scale, - window->min_height / ctx->scale); - } else { -- zxdg_toplevel_v6_set_min_size(window->xdg_toplevel, 0, 0); -+ xdg_toplevel_set_min_size(window->xdg_toplevel, 0, 0); - } - - if (window->size_flags & P_MAX_SIZE) { -- zxdg_toplevel_v6_set_max_size(window->xdg_toplevel, -+ xdg_toplevel_set_max_size(window->xdg_toplevel, - window->max_width / ctx->scale, - window->max_height / ctx->scale); - } else { -- zxdg_toplevel_v6_set_max_size(window->xdg_toplevel, 0, 0); -+ xdg_toplevel_set_max_size(window->xdg_toplevel, 0, 0); - } - } else if (event->atom == XCB_ATOM_WM_HINTS) { - struct sl_window* window = sl_lookup_window(ctx, event->window); -@@ -3535,7 +3536,7 @@ int main(int argc, char** argv) { - .shm = NULL, - .shell = NULL, - .data_device_manager = NULL, -- .xdg_shell = NULL, -+ .xdg_wm_base = NULL, - .aura_shell = NULL, - .viewporter = NULL, - .linux_dmabuf = NULL, -diff --git a/vm_tools/sommelier/sommelier.h b/vm_tools/sommelier/sommelier.h -index b851b5c8d..7e6daf773 100644 ---- a/vm_tools/sommelier/sommelier.h -+++ b/vm_tools/sommelier/sommelier.h -@@ -31,7 +31,7 @@ struct sl_shell; - struct sl_data_device_manager; - struct sl_data_offer; - struct sl_data_source; --struct sl_xdg_shell; -+struct sl_xdg_wm_base; - struct sl_subcompositor; - struct sl_aura_shell; - struct sl_viewporter; -@@ -99,7 +99,7 @@ struct sl_context { - struct sl_shm* shm; - struct sl_shell* shell; - struct sl_data_device_manager* data_device_manager; -- struct sl_xdg_shell* xdg_shell; -+ struct sl_xdg_wm_base* xdg_wm_base; - struct sl_aura_shell* aura_shell; - struct sl_viewporter* viewporter; - struct sl_linux_dmabuf* linux_dmabuf; -@@ -373,11 +373,12 @@ struct sl_viewporter { - struct wp_viewporter* internal; - }; - --struct sl_xdg_shell { -+struct sl_xdg_wm_base { - struct sl_context* ctx; - uint32_t id; -+ uint32_t version; - struct sl_global* host_global; -- struct zxdg_shell_v6* internal; -+ struct xdg_wm_base* internal; - }; - - struct sl_aura_shell { -@@ -476,9 +477,9 @@ struct sl_window { - int max_height; - struct sl_config next_config; - struct sl_config pending_config; -- struct zxdg_surface_v6* xdg_surface; -- struct zxdg_toplevel_v6* xdg_toplevel; -- struct zxdg_popup_v6* xdg_popup; -+ struct xdg_surface* xdg_surface; -+ struct xdg_toplevel* xdg_toplevel; -+ struct xdg_popup* xdg_popup; - struct zaura_surface* aura_surface; - struct wl_list link; - }; -@@ -522,7 +523,7 @@ struct sl_global* sl_data_device_manager_global_create(struct sl_context* ctx); - - struct sl_global* sl_viewporter_global_create(struct sl_context* ctx); - --struct sl_global* sl_xdg_shell_global_create(struct sl_context* ctx); -+struct sl_global* sl_xdg_wm_base_global_create(struct sl_context* ctx); - - struct sl_global* sl_gtk_shell_global_create(struct sl_context* ctx); - --- -2.26.2 - diff --git a/pkgs/os-specific/linux/chromium-os/sommelier/0006-sommelier-make-building-demos-optional.patch b/pkgs/os-specific/linux/chromium-os/sommelier/0006-sommelier-make-building-demos-optional.patch deleted file mode 100644 index ecc876e4bfb..00000000000 --- a/pkgs/os-specific/linux/chromium-os/sommelier/0006-sommelier-make-building-demos-optional.patch +++ /dev/null @@ -1,100 +0,0 @@ -From 6a4ccbcded19df9ec42b865218ac744e6b35d505 Mon Sep 17 00:00:00 2001 -From: Alyssa Ross <hi(a)alyssa.is> -Date: Wed, 15 Jan 2020 21:36:43 +0000 -Subject: [PATCH 6/6] sommelier: make building demos optional -MIME-Version: 1.0 -Content-Type: text/plain; charset=UTF-8 -Content-Transfer-Encoding: 8bit - -pkg-config was checked at GN evaluation time for libbrillo and -libchrome, meaning that there was no way to build sommelier without -them, even though they were only required for the demos, not for -sommelier itself. - -Making the demo optional saves having to libbrillo and libchrome for -the common case of building just sommelier, which themselves have lots -of unusual dependencies. - -Thanks-to: Tomasz Śniatowski <tsniatowski(a)vewd.com> ---- - vm_tools/sommelier/BUILD.gn | 54 ++++++++++++++++++++++--------------- - 1 file changed, 32 insertions(+), 22 deletions(-) - -diff --git a/vm_tools/sommelier/BUILD.gn b/vm_tools/sommelier/BUILD.gn -index 4330560a1..cbb752745 100644 ---- a/vm_tools/sommelier/BUILD.gn -+++ b/vm_tools/sommelier/BUILD.gn -@@ -4,12 +4,20 @@ - - import("wayland_protocol.gni") - -+declare_args() { -+ use_demos = true -+} -+ - group("all") { - deps = [ - ":sommelier", -- ":wayland_demo", -- ":x11_demo", - ] -+ if (use_demos) { -+ deps += [ -+ ":wayland_demo", -+ ":x11_demo", -+ ] -+ } - } - - if (!defined(peer_cmd_prefix)) { -@@ -123,25 +131,27 @@ executable("sommelier") { - ] - } - --executable("wayland_demo") { -- pkg_deps = [ -- "libbrillo", -- "libchrome-${libbase_ver}", -- "wayland-client", -- ] -- libs = [ "wayland-client" ] -- sources = [ -- "demos/wayland_demo.cc", -- ] --} -+if (use_demos) { -+ executable("wayland_demo") { -+ pkg_deps = [ -+ "libbrillo", -+ "libchrome-${libbase_ver}", -+ "wayland-client", -+ ] -+ libs = [ "wayland-client" ] -+ sources = [ -+ "demos/wayland_demo.cc", -+ ] -+ } - --executable("x11_demo") { -- pkg_deps = [ -- "libbrillo", -- "libchrome-${libbase_ver}", -- ] -- libs = [ "X11" ] -- sources = [ -- "demos/x11_demo.cc", -- ] -+ executable("x11_demo") { -+ pkg_deps = [ -+ "libbrillo", -+ "libchrome-${libbase_ver}", -+ ] -+ libs = [ "X11" ] -+ sources = [ -+ "demos/x11_demo.cc", -+ ] -+ } - } --- -2.26.2 - diff --git a/pkgs/os-specific/linux/chromium-os/sommelier/default.nix b/pkgs/os-specific/linux/chromium-os/sommelier/default.nix index 9bf2777bfd7..68d23444f8d 100644 --- a/pkgs/os-specific/linux/chromium-os/sommelier/default.nix +++ b/pkgs/os-specific/linux/chromium-os/sommelier/default.nix @@ -8,8 +8,6 @@ common-mk { platform2Patches = [ ./0004-sommelier-don-t-leak-source-absolute-paths.patch - ./0005-sommelier-use-stable-xdg-shell-protocol.patch - ./0006-sommelier-make-building-demos-optional.patch ]; buildInputs = [ -- 2.31.1

3 4

[RFC PATCH 5/8] chromiumOSPackages.common-mk: disable clang-only warnings
by Jamie McClymont 02 Apr '21

02 Apr '21

--- pkgs/os-specific/linux/chromium-os/common-mk/default.nix | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pkgs/os-specific/linux/chromium-os/common-mk/default.nix b/pkgs/os-specific/linux/chromium-os/common-mk/default.nix index cc72aab5d15..d617401138f 100644 --- a/pkgs/os-specific/linux/chromium-os/common-mk/default.nix +++ b/pkgs/os-specific/linux/chromium-os/common-mk/default.nix @@ -64,7 +64,11 @@ stdenv.mkDerivation ({ patchShebangs common-mk '' + (lib.optionalString (!stdenv.cc.isClang) '' substituteInPlace common-mk/BUILD.gn \ - --replace '"-Wno-c99-designator",' "" + --replace '"-Wno-c99-designator",' "" \ + --replace '"-Wstring-compare",' "" \ + --replace '"-Wstring-plus-int",' "" \ + --replace '"-Wxor-used-as-pow",' "" \ + --replace '"-Wunreachable-code-return",' "" '') + postPatch; nativeBuildInputs = [ gn pkgconfig python3 ninja ] ++ nativeBuildInputs; -- 2.31.1

2 1

[RFC PATCH 3/8] chromiumOSPackages.vm_protos: drop GN patch
by Jamie McClymont 02 Apr '21

02 Apr '21

The missing dependency has been added upstream --- ...03-vm_tools-proto-fix-parallel-build.patch | 39 ------------------- .../linux/chromium-os/vm_protos/default.nix | 2 - 2 files changed, 41 deletions(-) delete mode 100644 pkgs/os-specific/linux/chromium-os/vm_protos/0003-vm_tools-proto-fix-parallel-build.patch diff --git a/pkgs/os-specific/linux/chromium-os/vm_protos/0003-vm_tools-proto-fix-parallel-build.patch b/pkgs/os-specific/linux/chromium-os/vm_protos/0003-vm_tools-proto-fix-parallel-build.patch deleted file mode 100644 index 93fa535ac7e..00000000000 --- a/pkgs/os-specific/linux/chromium-os/vm_protos/0003-vm_tools-proto-fix-parallel-build.patch +++ /dev/null @@ -1,39 +0,0 @@ -From dfed9458bf7abc1dc8f33a3e16ee179cde88e4e2 Mon Sep 17 00:00:00 2001 -From: Alyssa Ross <hi(a)alyssa.is> -Date: Tue, 2 Jun 2020 00:21:08 +0000 -Subject: [PATCH 3/6] vm_tools: proto: fix parallel build - -fuzzer-protos depends on vm-crash-rpcs, but this dependency wasn't -declared, causing build failures like the following: - -[26/52] CXX obj/out/Release/gen/include/vm_protos/proto_bindings/libfuzzer-protos.fuzzer.grpc.pb.o -FAILED: obj/out/Release/gen/include/vm_protos/proto_bindings/libfuzzer-protos.fuzzer.grpc.pb.o -c++ -MMD -MF obj/out/Release/gen/include/vm_protos/proto_bindings/libfuzzer-protos.fuzzer.grpc.pb.o.d -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64 -Igen/include -I../../common-mk -I/usr/include -Igen -Igen -Igen -Igen -Wall -Wunused -Wno-unused-parameter -Wunreachable-code -ggdb3 -fstack-protector-strong -Wformat=2 -fvisibility=internal -Wa,--noexecstack -Wimplicit-fallthrough -Werror --sysroot= -fPIE -fvisibility=default -pthread -I/nix/store/pjl2q3lny3c18ypqjcv0q3akyq89hg2i-grpc-1.28.1/include -I/nix/store/hya0y6slws66h99njc2yiz02irfv4n62-openssl-1.1.1g-dev/include -I/nix/store/mfpg3sk5vk9rm99hbpmd3dgvxqybd391-protobuf-3.8.0/include -pthread -I/nix/store/pjl2q3lny3c18ypqjcv0q3akyq89hg2i-grpc-1.28.1/include -I/nix/store/hya0y6slws66h99njc2yiz02irfv4n62-openssl-1.1.1g-dev/include -I/nix/store/mfpg3sk5vk9rm99hbpmd3dgvxqybd391-protobuf-3.8.0/include -Wno-unreachable-code -std=gnu++14 -fno-exceptions -fno-unwind-tables -fno-asynchronous-unwind-tables -Wno-psabi -c gen/include/vm_protos/proto_bindings/fuzzer.grpc.pb.cc -o obj/out/Release/gen/include/vm_protos/proto_bindings/libfuzzer-protos.fuzzer.grpc.pb.o -In file included from gen/include/vm_protos/proto_bindings/fuzzer.grpc.pb.cc:5: -gen/include/vm_protos/proto_bindings/fuzzer.pb.h:38:10: fatal error: vm_crash.pb.h: No such file or directory - 38 | #include "vm_crash.pb.h" - | ^~~~~~~~~~~~~~~ -compilation terminated. -ninja: build stopped: subcommand failed. - -Reported-by: Cole Helbling <cole.e.helbling(a)outlook.com> -Reviewed-by: Cole Helbling <cole.e.helbling(a)outlook.com> ---- - vm_tools/proto/BUILD.gn | 1 + - 1 file changed, 1 insertion(+) - -diff --git a/vm_tools/proto/BUILD.gn b/vm_tools/proto/BUILD.gn -index 713b81853..a25265cab 100644 ---- a/vm_tools/proto/BUILD.gn -+++ b/vm_tools/proto/BUILD.gn -@@ -70,6 +70,7 @@ proto_library("fuzzer-protos") { - deps = [ - ":container-rpcs", - ":tremplin-rpcs", -+ ":vm-crash-rpcs", - ] - sources = [ - "${proto_in_dir}/fuzzer.proto", --- -2.26.2 - diff --git a/pkgs/os-specific/linux/chromium-os/vm_protos/default.nix b/pkgs/os-specific/linux/chromium-os/vm_protos/default.nix index 4f0aae3be38..e87d0c57e78 100644 --- a/pkgs/os-specific/linux/chromium-os/vm_protos/default.nix +++ b/pkgs/os-specific/linux/chromium-os/vm_protos/default.nix @@ -12,8 +12,6 @@ common-mk { "-Wno-error=deprecated-declarations" ]; - platform2Patches = [ ./0003-vm_tools-proto-fix-parallel-build.patch ]; - postPatch = '' substituteInPlace common-mk/proto_library.gni \ --replace /usr/bin/grpc_cpp_plugin ${grpc}/bin/grpc_cpp_plugin -- 2.31.1

2 1

[RFC PATCH 4/8] chromiumOSPackages.common-mk: update patches
by Jamie McClymont 02 Apr '21

02 Apr '21

--- ...ommon-mk-don-t-leak-source-absolute-paths.patch | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/pkgs/os-specific/linux/chromium-os/common-mk/0001-common-mk-don-t-leak-source-absolute-paths.patch b/pkgs/os-specific/linux/chromium-os/common-mk/0001-common-mk-don-t-leak-source-absolute-paths.patch index 4b7a2f34779..244ba8f7521 100644 --- a/pkgs/os-specific/linux/chromium-os/common-mk/0001-common-mk-don-t-leak-source-absolute-paths.patch +++ b/pkgs/os-specific/linux/chromium-os/common-mk/0001-common-mk-don-t-leak-source-absolute-paths.patch @@ -38,13 +38,11 @@ diff --git a/common-mk/pkg_config.gni b/common-mk/pkg_config.gni index af3c3fb4c..151c49e56 100644 --- a/common-mk/pkg_config.gni +++ b/common-mk/pkg_config.gni -@@ -81,12 +81,11 @@ template("generate_pkg_config") { +@@ -81,10 +81,11 @@ template("generate_pkg_config") { if (!defined(output_name)) { output_name = name } -- outputs = [ -- "${target_out_dir}/${output_name}.pc", -- ] +- outputs = [ "${target_out_dir}/${output_name}.pc" ] + lib_path = "${target_out_dir}/${output_name}.pc" + outputs = [ lib_path ] @@ -117,11 +115,11 @@ index 7fcb08341..692704288 100644 # Build protoc command line to run. script = "//common-mk/file_generator_wrapper.py" @@ -224,7 +225,7 @@ template("goproto_library") { - "--proto_path", - "${sysroot}/usr/share/proto", + args += [ "--go_out", -- "${go_out_prefix}${root_gen_dir}/${proto_out_dir}", -+ "${go_out_prefix}${proto_out_dir}", + # go_out_prefix can be empty, so we can always add a colon here. +- "${go_out_prefix}:${root_gen_dir}/${proto_out_dir}", ++ "${go_out_prefix}:${proto_out_dir}", ] foreach(source, sources) { args += [ rebase_path(source) ] -- 2.31.1

2 1

[RFC PATCH 2/8] chromiumOSPackages.cros_linux: fix config
by Jamie McClymont 02 Apr '21

02 Apr '21

The ANALOGIX_ANX7625 option no longer exists, but VIDEO_INTEL_IPU6 is now a source of build errors. --- pkgs/os-specific/linux/kernel/linux-cros.nix | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pkgs/os-specific/linux/kernel/linux-cros.nix b/pkgs/os-specific/linux/kernel/linux-cros.nix index 789a9fb6fd2..d292fe2c54a 100644 --- a/pkgs/os-specific/linux/kernel/linux-cros.nix +++ b/pkgs/os-specific/linux/kernel/linux-cros.nix @@ -29,6 +29,10 @@ buildLinux (args // rec { # Enabling this (the default) caused a build failure. If you can # archieve a successful build with this enabled, go ahead and # enable it. - ANALOGIX_ANX7625 = no; + VIDEO_INTEL_IPU6 = no; + + # RTW88_8822*E were being selected as Y when N/m/? are the only valid options + RTW88_8822BE = lib.mkForce no; + RTW88_8822CE = lib.mkForce no; } // (args.structuredExtraConfig or {}); } // (args.argsOverride or {})) -- 2.31.1

2 1

[RFC PATCH 1/8] chromiumOSPackages: update 83->89
by Jamie McClymont 02 Apr '21

02 Apr '21

--- .../linux/chromium-os/upstream-info.json | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/pkgs/os-specific/linux/chromium-os/upstream-info.json b/pkgs/os-specific/linux/chromium-os/upstream-info.json index 7755c48239c..cec5a21b1e4 100644 --- a/pkgs/os-specific/linux/chromium-os/upstream-info.json +++ b/pkgs/os-specific/linux/chromium-os/upstream-info.json @@ -1,66 +1,66 @@ { - "version": "83.13020.0.0-rc1", + "version": "89.13729.0.0-rc1", "components": { "src/aosp/external/minijail": { "name": "minijail", "url": "https://android.googlesource.com/platform/external/minijail", - "rev": "84ffabcf488bf0935f00930a9a23bbce1f34d79f", - "sha256": "0yhbklwmgqws4cb098hpaky4w8if5snpkdabridcc5hk5d7vgild" + "rev": "b49291144e126662b8c7d1551fd1dc572e1d55da", + "sha256": "19z0qrfyh7p2kmsgvm4k053vrzz2w6zysqh3bm2rx0irsdv0pnqm" }, "src/platform/crosvm": { "name": "crosvm", "url": "https://chromium.googlesource.com/chromiumos/platform/crosvm", - "rev": "664cc3ca49cb58d5bf7d936686fd211d6dd728bf", - "sha256": "0rms1hkb3r4w6j3l71gavky6ylc7gi9sfr2rq4dr82v6vc8zxbjx" + "rev": "f35d2c43ff19520855cffee761dc8899c5a439a1", + "sha256": "0fahrcw7x33d21i6azgr787afrhp002f8mvz81ich5w7vk2xjzxr" }, "src/platform/minigbm": { "name": "minigbm", "url": "https://chromium.googlesource.com/chromiumos/platform/minigbm", - "rev": "bc4f023bfcc51cf9dcfcfec5bf4177b2e607dd68", - "sha256": "08ag207199xj5cw686386rmvr7sx2mzihdckm2pnvw743w03gipr" + "rev": "9fe8c20f05116869f86d91fc542a17b9badf9ec3", + "sha256": "0gr81qngfa1g58cz3v9dlms997ry3h5dh7vcv2ak1j53dzfdzckn" }, "src/platform2": { "name": "platform2", "url": "https://chromium.googlesource.com/chromiumos/platform2", - "rev": "e45d54bedee94e0121e12cc86fded46be8b3fa4e", - "sha256": "0ag01p8ch0wn7ds9ywasrdxkbibg19qzf5rldf8nr8irk1n851n7" + "rev": "e6e2faf2abb10fcbca3b6eccdcf7cf2506bcc212", + "sha256": "1g6kxmiffizqlxwakma1rp26p9mwpjbl3cv5hn7k5zd6cn8wixj7" }, "src/third_party/adhd": { "name": "adhd", "url": "https://chromium.googlesource.com/chromiumos/third_party/adhd", - "rev": "d3af897db5540cadc439463a0ffdde07f2b8898a", - "sha256": "1h0xxf338d7fwmfwjlpsjiml8d3v426a95x3ka7qfikdapgmav3d" + "rev": "0458a459ad51cc0b386835f5b909d0d04003ab16", + "sha256": "1y1g0h2dcmgpz9nk2hc6fcb0c53ip3mf27yyf7gg6syx764pr2gb" }, "src/third_party/chromiumos-overlay": { "name": "chromiumos-overlay", "url": "https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay", - "rev": "270f5c2cfb7eadc374638076c8fdee72360a6d66", - "sha256": "1d88xvnf0qc3v5hp9b2pafxhi83rph84y2sbk1nc46rhj63m8bwi" + "rev": "dd29be74a5c6fa492411ec7feed734004c6a1ea5", + "sha256": "0pbrbbr39j9zsc10dhhhmwx1c69a40nsv4cprh7biz1b8f840l1b" }, "src/third_party/kernel/v5.4": { "name": "v5.4", "url": "https://chromium.googlesource.com/chromiumos/third_party/kernel", - "rev": "36270ae817fb576debb80bce752addb3a4cc9886", - "sha256": "0h7fj3w9vwmq8a6cx96vjcyw29v7wfamxykh1nx3lmhxxkn120f4", - "version": "5.4.28" + "rev": "eb179ec7ef3e053acb48366e72299055b2b66ca8", + "sha256": "13i7f3742cnw7lm0b2zal4lxbqrkmniajqp5c1gllvrfvxcw4a45", + "version": "5.4.88" }, "src/third_party/libqmi": { "name": "libqmi", "url": "https://chromium.googlesource.com/chromiumos/third_party/libqmi", - "rev": "20726755e60d48c70f0189a1cfe9665a87a5e6c6", - "sha256": "0w04lyd459jgcag70kx6nq1i952fbhy32nmkh6r255xjf2wrliwr" + "rev": "072abd58da99c00b79dbf7e4642fa19fb791aed9", + "sha256": "1a6x5hwghkrvi82szhabxf2by4x7x9pfk6bvpgz0ipz8yqg8fwih" }, "src/third_party/modemmanager-next": { "name": "modemmanager-next", "url": "https://chromium.googlesource.com/chromiumos/third_party/modemmanager-next", - "rev": "988f572cc882a74209fba0f5c49cf0b01b9163a6", - "sha256": "1hiqz7wn1w461sd94v179q81yahisffnw033yix3dwfwagm9ndf8" + "rev": "3eba6678dfe0d7b35f128bb58b63e71d1a3a64d4", + "sha256": "0lviwkkqsv5zmajqdlc0s83yq12ikk0gf7wq9za58p92g0970i4l" }, "src/third_party/modp_b64": { "name": "modp_b64", "url": "https://chromium.googlesource.com/aosp/platform/external/modp_b64", - "rev": "ae26ad8516036774fd3b6e84a98a89955dcf5f61", - "sha256": "03ja5fkq3wk0qcnfnqcj09lciky6n6zdj544xs1jfssjhz9yj8hi" + "rev": "467734f4870d3ab23968f5ebdd461f6112e4103b", + "sha256": "1hlk9vzivy0n3xf9hm9bhj7i09yifirc1af6pli471m00v3s0zvg" } } } -- 2.31.1

2 1

[RFC PATCH 8/8] chromiumOSPackages.crosvm: bump cargoSha256
by Jamie McClymont 02 Apr '21

02 Apr '21

--- pkgs/os-specific/linux/chromium-os/crosvm/default.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix index ab5ac518ef7..1013e7817e4 100644 --- a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix +++ b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix @@ -42,7 +42,7 @@ in ./default-seccomp-policy-dir.diff ]; - cargoSha256 = "0wzqn2n4vyv3bk39079yg1zbnriagi5xns928bzdqmq9djdcj21i"; + cargoSha256 = "02y4wvm2l54f3y0dzcfyzay4hsy7b1q8x9kshqidi9pvh09if7x4"; nativeBuildInputs = [ pkgconfig ]; -- 2.31.1

1 0

[RFC PATCH 7/8] chromiumOSPackages.crosvm: add platform2 dep
by Jamie McClymont 02 Apr '21

02 Apr '21

Several crates from under platfrom2 are now used. --- pkgs/os-specific/linux/chromium-os/crosvm/default.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix index d64dc316772..ab5ac518ef7 100644 --- a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix +++ b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix @@ -13,6 +13,7 @@ let "src/platform/crosvm" "src/third_party/adhd" "src/aosp/external/minijail" + "src/platform2" ] getSrc; in -- 2.31.1

1 0

virtio-wl on AMD graphics
by Jamie McClymont 01 Apr '21

01 Apr '21

Hello If anyone else has struggled with sepectrum-vm on AMD graphics, where the "child virtio-pci (virtio-wl)" process dies without a descriptive error, I believe the issue is fixed here: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/257… It doesn't cleanly apply (I assume the seccomp policies have been shuffled between files), but --disable-sandbox is there as a functioning workaround :) Does anyone have a branch where the chromium-os upstream-info is more up to date? I can have a go myself, but didn't want to duplicate effort :) Thanks - Jamie McClymont -- P.S. an introduction: Hi everyone! I have just started a new job where VM isolation is necessary, and have been hoping for a way to get integrated window management across VM boundaries - it looks like this is clearly the ideal approach, and I'm already a NixOS user, so am keen to contribute :)

2 1

[PATCH ucspi-vsock] vsockclient: allow null application
by Alyssa Ross 24 Mar '21

24 Mar '21

I found myself running vsockclient 2 1024 true in a situation where it just mattered that a connection was made, and no data needed to be exchanged of it. That I found myself doing this is quite a strong indicator that the program to exec into should be optional. UCSPI-1996[1] doesn't specify what should happen if no application is provided, so I think this is a reasonable interpretation. I'm not sure if I feel the same for vsockserver(d), so I haven't made the corresponding change there. I'll wait to see if there's ever a need for it. [1]: https://cr.yp.to/proto/ucspi.txt --- vsockclient.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/vsockclient.c b/vsockclient.c index 934cfa0..456810d 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -41,11 +41,9 @@ int main(int argc, char *argv[]) } } - // Check there are enough positional arguments (two for the - // address and at least one to exec into). - if (optind > argc - 3) + // Find the address (cid and port) to connect to. + if (optind > argc - 2) ex_usage(); - if (getu32(argv[optind++], 0, UINT32_MAX, &rcid)) ex_usage(); if (getu32(argv[optind++], 0, UINT32_MAX, &rport)) @@ -69,6 +67,11 @@ int main(int argc, char *argv[]) "connect to %" PRIu32 ":%" PRIu32 " failed", rcid, rport); ilog("connected to %" PRIu32 ":%" PRIu32 "!", rcid, rport); + // If we have nothing to exec into, we're done. (Sometimes + // just connecting on its own is enough.) + if (optind == argc) + return 0; + // Set up the file descriptors to the well-known UCSPI numbers. if (dup2(fd, 6) == -1) diee(EX_OSERR, "dup2"); -- 2.30.0

2 3

[PATCH ucspi-vsock] Remove unused includes
by Alyssa Ross 24 Mar '21

24 Mar '21

--- vsock.c | 1 - vsockclient.c | 3 --- 2 files changed, 4 deletions(-) diff --git a/vsock.c b/vsock.c index ab8c4bd..159a51f 100644 --- a/vsock.c +++ b/vsock.c @@ -6,7 +6,6 @@ #include "vsock.h" #include <errno.h> -#include <sys/ioctl.h> #include <sys/socket.h> #include <linux/vm_sockets.h> diff --git a/vsockclient.c b/vsockclient.c index d6cc778..934cfa0 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -8,12 +8,9 @@ #include <stdio.h> #include <stdlib.h> #include <stdnoreturn.h> -#include <sys/socket.h> #include <sysexits.h> #include <unistd.h> -#include <linux/vm_sockets.h> - #include "env.h" #include "log.h" #include "num.h" -- 2.30.0

2 2

[PATCH ucspi-vsock] configure: reject invalid arguments
by Alyssa Ross 22 Mar '21

22 Mar '21

But we preserve the autoconf behaviour of only warning on invalid options. $ ./configure --test Warning: unrecognized options: --test $ ./configure test Error: unexpected argument: test --- configure | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/configure b/configure index 38c926c..938db10 100755 --- a/configure +++ b/configure @@ -29,8 +29,11 @@ for arg; do prefix="$(printf "%s" "$arg" | cut -d= -f2-)" elif printf "%s" "$arg" | grep -q "^--bindir="; then bindir="$(printf "%s" "$arg" | cut -d= -f2-)" - else + elif printf "%s" "$arg" | grep -q "^--"; then unrecognized="$unrecognized $arg" + else + echo "Error: unexpected argument: $arg" >&2 + exit 64 # EX_USAGE fi done -- 2.30.0

2 2

[PATCH ucspi-vsock] Set up clang-format
by Alyssa Ross 22 Mar '21

22 Mar '21

--- I'm not entirely happy with the automatic formatting, but I think it's worth it. .clang-format | 10 ++++++++++ num.c | 2 +- vsock.c | 4 ++-- vsockclient.c | 5 +++-- vsockserver-socketbinder.c | 8 ++++---- vsockserver.c | 27 +++++++++++++++------------ vsockserverd.c | 9 +++++---- 7 files changed, 40 insertions(+), 25 deletions(-) create mode 100644 .clang-format diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..89313b0 --- /dev/null +++ b/.clang-format @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# SPDX-FileCopyrightText: 2021 Alyssa Ross <hi(a)alyssa.is> + +AlignOperands: DontAlign +BreakBeforeBinaryOperators: All +BreakBeforeBraces: Linux +ContinuationIndentWidth: 8 +Cpp11BracedListStyle: false +IndentWidth: 8 +UseTab: AlignWithSpaces diff --git a/num.c b/num.c index ac7f0a4..cef71ae 100644 --- a/num.c +++ b/num.c @@ -21,7 +21,7 @@ int getu32(const char *s, uint32_t min, uint32_t max, uint32_t *out) } int getul(const char *s, unsigned long min, unsigned long max, - unsigned long *out) + unsigned long *out) { char *endptr; diff --git a/vsock.c b/vsock.c index 6f1f466..ab8c4bd 100644 --- a/vsock.c +++ b/vsock.c @@ -18,8 +18,8 @@ static void fill_sockaddr(struct sockaddr_vm *addr, uint32_t cid, uint32_t port) addr->svm_port = port; } -static int fill_cid_and_port(const struct sockaddr_vm *addr, - uint32_t *cid, uint32_t *port) +static int fill_cid_and_port(const struct sockaddr_vm *addr, uint32_t *cid, + uint32_t *port) { // Check that this sockaddr info is actually for the socket // type we think it is, or we could get some very confusing diff --git a/vsockclient.c b/vsockclient.c index fbdd20e..d6cc778 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -23,7 +23,7 @@ noreturn static void ex_usage(void) { if (verbosity) fprintf(stderr, "Usage: %s [ -q | -Q | -v ] cid port prog...\n", - program_invocation_short_name); + program_invocation_short_name); exit(EX_USAGE); } @@ -63,7 +63,8 @@ int main(int argc, char *argv[]) // the same host with no backlog, so retry a few times. { int i = 0; - do fd = vsock_open(rcid, rport); + do + fd = vsock_open(rcid, rport); while (i++ < 3 && fd == -1 && errno == ETIMEDOUT); } if (fd == -1) diff --git a/vsockserver-socketbinder.c b/vsockserver-socketbinder.c index fdcdfa8..97c5442 100644 --- a/vsockserver-socketbinder.c +++ b/vsockserver-socketbinder.c @@ -5,13 +5,13 @@ #include <errno.h> #include <fcntl.h> +#include <stdint.h> #include <stdio.h> #include <stdlib.h> -#include <stdint.h> #include <stdnoreturn.h> #include <string.h> -#include <sysexits.h> #include <sys/socket.h> +#include <sysexits.h> #include <unistd.h> #include <linux/vm_sockets.h> @@ -26,7 +26,7 @@ noreturn static void ex_usage(void) { if (verbosity) fprintf(stderr, "Usage: %s cid port prog...\n", - program_invocation_short_name); + program_invocation_short_name); exit(EX_USAGE); } @@ -54,7 +54,7 @@ int main(int argc, char *argv[]) // Parse the `cid' argument. if (!strcmp(argv[optind], "-1")) cid = VMADDR_CID_ANY; - else if (getu32(argv[optind], 0, UINT32_MAX, &cid)) + else if (getu32(argv[optind], 0, UINT32_MAX, &cid)) ex_usage(); optind++; diff --git a/vsockserver.c b/vsockserver.c index b717eee..e45c2ea 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -19,8 +19,9 @@ noreturn static void ex_usage(void) { if (verbosity) - fprintf(stderr, "Usage: %s [ -1 ] [ -q | -Q | -v ] cid port prog...\n", - program_invocation_short_name); + fprintf(stderr, + "Usage: %s [ -1 ] [ -q | -Q | -v ] cid port prog...\n", + program_invocation_short_name); exit(EX_USAGE); } @@ -40,9 +41,10 @@ int main(int argc, char *argv[]) // we've parsed the arguments, so we know what our verbosity // setting is, and consequently whether we should print an // error message about the allocation failure. - alloc_failed |= - argz_add(&binder_opts, &binder_opts_len, BINDIR "/vsockserver-socketbinder") || - argz_add(&daemon_opts, &daemon_opts_len, BINDIR "/vsockserverd"); + alloc_failed |= argz_add(&binder_opts, &binder_opts_len, + BINDIR "/vsockserver-socketbinder") + || argz_add(&daemon_opts, &daemon_opts_len, + BINDIR "/vsockserverd"); while ((opt = getopt(argc, argv, "+1qQv")) != -1) { char *arg = NULL; @@ -53,9 +55,9 @@ int main(int argc, char *argv[]) case 'Q': case 'v': set_verbosity(opt); - alloc_failed |= - asprintf(&arg, "-%c", opt) == -1 || - argz_add(&daemon_opts, &daemon_opts_len, arg); + alloc_failed |= asprintf(&arg, "-%c", opt) == -1 + || argz_add(&daemon_opts, &daemon_opts_len, + arg); free(arg); break; default: @@ -78,15 +80,16 @@ int main(int argc, char *argv[]) ex_usage(); // Add `cid' and `port' arguments to binder options. - if (argz_add(&binder_opts, &binder_opts_len, "--") || - argz_add(&binder_opts, &binder_opts_len, argv[optind++]) || - argz_add(&binder_opts, &binder_opts_len, argv[optind++])) + if (argz_add(&binder_opts, &binder_opts_len, "--") + || argz_add(&binder_opts, &binder_opts_len, argv[optind++]) + || argz_add(&binder_opts, &binder_opts_len, argv[optind++])) diee(EX_OSERR, "malloc"); // Add all of daemon_opts onto the end of binder_opts. It's // okay to multiply to find the size because if it would // overflow calloc would have failed earlier. - if (argz_append(&binder_opts, &binder_opts_len, daemon_opts, daemon_opts_len)) + if (argz_append(&binder_opts, &binder_opts_len, daemon_opts, + daemon_opts_len)) diee(EX_OSERR, "malloc"); free(daemon_opts); diff --git a/vsockserverd.c b/vsockserverd.c index 1abfff9..a056bf1 100644 --- a/vsockserverd.c +++ b/vsockserverd.c @@ -23,7 +23,7 @@ noreturn static void ex_usage(void) { if (verbosity) fprintf(stderr, "Usage: %s [ -1 ] [ -q | -Q | -v ] prog...\n", - program_invocation_short_name); + program_invocation_short_name); exit(EX_USAGE); } @@ -33,8 +33,8 @@ int main(int argc, char *argv[]) int opt; pid_t child; uint32_t lcid, lport, rcid, rport; - struct pollfd poll_fd = - { .fd = STDIN_FILENO, .events = POLLIN, .revents = 0 }; + struct pollfd poll_fd + = { .fd = STDIN_FILENO, .events = POLLIN, .revents = 0 }; while ((opt = getopt(argc, argv, "+1qQv")) != -1) { switch (opt) { @@ -93,7 +93,8 @@ int main(int argc, char *argv[]) ilog("connection from %" PRIu32 " port %" PRIu32, rcid, rport); switch (child = fork()) { - case -1: diee(EX_OSERR, "fork"); + case -1: + diee(EX_OSERR, "fork"); case 0: // Set up the connection socket on prog's // stdin and stdout. This has the happy side -- 2.30.0

2 2

[PATCH ucspi-vsock 0/2] Fix clang-tidy warnings
by Alyssa Ross 21 Mar '21

21 Mar '21

clang-tidy also produced this warning: /home/src/ucspi-vsock/repro.c:43:19: warning: unused parameter 'sig' [clang-diagnostic-unused-parameter] void sig_exit(int sig) { exit(EX_UNAVAILABLE); } ^ vsock.c:27:23: warning: The left operand of '!=' is a garbage value [clang-analyzer-core.UndefinedBinaryOperatorResult] if (addr->svm_family != AF_VSOCK) { ^ vsock.c:90:6: note: Assuming the condition is false if (getsockname(fd, (struct sockaddr *)&addr, &addrlen) == -1) ^ vsock.c:90:2: note: Taking false branch if (getsockname(fd, (struct sockaddr *)&addr, &addrlen) == -1) ^ vsock.c:93:9: note: Calling 'fill_cid_and_port' return fill_cid_and_port(&addr, cid, port); ^ vsock.c:27:23: note: The left operand of '!=' is a garbage value if (addr->svm_family != AF_VSOCK) { But I think this is just warning me that the POSIX socket API violates the strict aliasing rule. (Which is true, but there's not a lot I can do about it...) It also tells me I should use memset_s instead of memset, but, well... https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Criticism Alyssa Ross (2): exec: free argv if exec fails vsockserver: fix uninitialized variable exec.c | 5 ++++- vsockserver.c | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) -- 2.30.0

2 4

[PATCH ucspi-vsock 0/7] Extract vsockserver-socketbinder and vsockserverd
by Alyssa Ross 21 Mar '21

21 Mar '21

This series breaks vsockserver apart into two smaller programs, vsockserver-socketbinder and vsockserverd. vsockserver-socketbinder binds and listens on an AF_VSOCK socket and then execs into another program with the socket as stdin. vsockserverd accepts connections to a socket provided on stdin, and for each connection runs a program with the connection socket on stdin and stdout. vsockserver is replaced with a program that builds an argv that just combines these two smaller programs and execs into it. This design is based on s6[1]'s s6-ipcserver, s6-ipcserver-socketbinder, and s6-ipcserverd programs. [1]: https://skarnet.org/software/s6/ [2]: https://skarnet.org/software/s6-rc/ Alyssa Ross (7): vsock: get cid and port instead of just cid vsock: check socket family before reading sockaddr vsockserver: switch to a non-blocking socket configure: create, to generate config.h log: add die function exec: add execzp() Extract vsockserver-socketbinder and vsockserverd .gitignore | 7 +- Makefile | 33 -------- Makefile.in | 47 +++++++++++ configure | 49 ++++++++++++ exec.c | 22 +++++ exec.h | 7 ++ log.c | 10 +++ log.h | 8 +- vsock.c | 32 ++++++-- vsock.h | 14 +++- vsockserver-socketbinder.c | 86 ++++++++++++++++++++ vsockserver.c | 137 +++++++++++++++----------------- vsockserver.c => vsockserverd.c | 73 +++++++++-------- 13 files changed, 368 insertions(+), 157 deletions(-) delete mode 100644 Makefile create mode 100644 Makefile.in create mode 100755 configure create mode 100644 exec.c create mode 100644 exec.h create mode 100644 vsockserver-socketbinder.c copy vsockserver.c => vsockserverd.c (55%) -- 2.30.0

2 14

[PATCH ucspi-vsock] Makefile: use $@ where possible
by Alyssa Ross 19 Mar '21

19 Mar '21

This is, unfortunately, the only "internal macro" POSIX requires to be available for target rules, and I do want to keep the Makefile POSIX-compatible. But this is at least a slight improvement. --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 2045cdd..e05e32f 100644 --- a/Makefile +++ b/Makefile @@ -21,9 +21,9 @@ install: $(PROGRAMS) .PHONY: install vsockclient: vsockclient.o env.o log.o num.o vsock.o - $(CC) $(LDFLAGS) -o vsockclient vsockclient.o env.o log.o num.o vsock.o $(LDLIBS) + $(CC) $(LDFLAGS) -o $@ $@.o env.o log.o num.o vsock.o $(LDLIBS) vsockserver: vsockserver.o env.o log.o num.o vsock.o - $(CC) $(LDFLAGS) -o vsockserver vsockserver.o env.o log.o num.o vsock.o $(LDLIBS) + $(CC) $(LDFLAGS) -o $@ $@.o env.o log.o num.o vsock.o $(LDLIBS) vsockclient.o: env.h log.h num.h vsock.h vsockserver.o: env.h log.h num.h vsock.h -- 2.30.0

2 2

[PATCH ucspi-vsock] Makefile: stop repeating program list
by Alyssa Ross 18 Mar '21

18 Mar '21

Using a wildcard with rm -f means that if there are no object files to remove, rm will try to remove a non-existent file named '*.c', and then ignore the failure it gets by trying to do that. Which is fine. --- Makefile | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 1a4bb10..2045cdd 100644 --- a/Makefile +++ b/Makefile @@ -10,12 +10,14 @@ INSTALL_PROGRAM = $(INSTALL) prefix = /usr/local bindir = $(prefix)/bin -all: vsockclient vsockserver +PROGRAMS = vsockclient vsockserver + +all: $(PROGRAMS) .PHONY: all -install: vsockclient vsockserver +install: $(PROGRAMS) mkdir -p $(DESTDIR)$(bindir) - $(INSTALL_PROGRAM) vsockclient vsockserver $(DESTDIR)$(bindir) + $(INSTALL_PROGRAM) $(PROGRAMS) $(DESTDIR)$(bindir) .PHONY: install vsockclient: vsockclient.o env.o log.o num.o vsock.o @@ -27,6 +29,5 @@ vsockclient.o: env.h log.h num.h vsock.h vsockserver.o: env.h log.h num.h vsock.h clean: - rm -f env.o log.o num.o vsock.o \ - vsockclient.o vsockclient vsockserver.o vsockserver + rm -f $(PROGRAMS) *.o .PHONY: clean -- 2.30.0

2 4

[PATCH ucspi-vsock] num: rename from util
by Alyssa Ross 18 Mar '21

18 Mar '21

I don't want to have anything called "util", because that will inevitably become a dumping ground for all sorts of unrelated stuff. --- Makefile | 14 +++++++------- util.c => num.c | 2 +- util.h => num.h | 0 vsockclient.c | 2 +- vsockserver.c | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) rename util.c => num.c (97%) rename util.h => num.h (100%) diff --git a/Makefile b/Makefile index 07ff09b..1a4bb10 100644 --- a/Makefile +++ b/Makefile @@ -18,15 +18,15 @@ install: vsockclient vsockserver $(INSTALL_PROGRAM) vsockclient vsockserver $(DESTDIR)$(bindir) .PHONY: install -vsockclient: vsockclient.o env.o log.o util.o vsock.o - $(CC) $(LDFLAGS) -o vsockclient vsockclient.o env.o log.o util.o vsock.o $(LDLIBS) -vsockserver: vsockserver.o env.o log.o util.o vsock.o - $(CC) $(LDFLAGS) -o vsockserver vsockserver.o env.o log.o util.o vsock.o $(LDLIBS) +vsockclient: vsockclient.o env.o log.o num.o vsock.o + $(CC) $(LDFLAGS) -o vsockclient vsockclient.o env.o log.o num.o vsock.o $(LDLIBS) +vsockserver: vsockserver.o env.o log.o num.o vsock.o + $(CC) $(LDFLAGS) -o vsockserver vsockserver.o env.o log.o num.o vsock.o $(LDLIBS) -vsockclient.o: env.h log.h util.h vsock.h -vsockserver.o: env.h log.h util.h vsock.h +vsockclient.o: env.h log.h num.h vsock.h +vsockserver.o: env.h log.h num.h vsock.h clean: - rm -f env.o log.o util.o vsock.o \ + rm -f env.o log.o num.o vsock.o \ vsockclient.o vsockclient vsockserver.o vsockserver .PHONY: clean diff --git a/util.c b/num.c similarity index 97% rename from util.c rename to num.c index 2b39df1..ac7f0a4 100644 --- a/util.c +++ b/num.c @@ -3,7 +3,7 @@ #define _GNU_SOURCE -#include "util.h" +#include "num.h" #include <ctype.h> #include <stdlib.h> diff --git a/util.h b/num.h similarity index 100% rename from util.h rename to num.h diff --git a/vsockclient.c b/vsockclient.c index d25ab13..fbdd20e 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -16,7 +16,7 @@ #include "env.h" #include "log.h" -#include "util.h" +#include "num.h" #include "vsock.h" noreturn static void ex_usage(void) diff --git a/vsockserver.c b/vsockserver.c index 4c251b0..df9d334 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -19,7 +19,7 @@ #include "env.h" #include "log.h" -#include "util.h" +#include "num.h" #include "vsock.h" noreturn static void ex_usage(void) -- 2.30.0

2 2

[PATCH ucspi-vsock] Factor out set_verbosity()
by Alyssa Ross 18 Mar '21

18 Mar '21

This will save some cognitive load when reading main functions. --- log.c | 20 +++++++++++++++++++- log.h | 5 +++++ vsockclient.c | 6 +----- vsockserver.c | 6 +----- 4 files changed, 26 insertions(+), 11 deletions(-) diff --git a/log.c b/log.c index 385d39f..cdfacd6 100644 --- a/log.c +++ b/log.c @@ -1,15 +1,33 @@ // SPDX-License-Identifier: GPL-2.0-or-later -// SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2020-2021 Alyssa Ross <hi(a)alyssa.is> #define _GNU_SOURCE #include "log.h" #include <err.h> +#include <stdbool.h> #include <stdlib.h> enum verbosity verbosity = errors; +bool set_verbosity(int opt) +{ + switch (opt) { + case 'q': + verbosity = nothing; + return true; + case 'Q': + verbosity = errors; + return true; + case 'v': + verbosity = all; + return true; + } + + return false; +} + void veloge(const char *fmt, va_list args) { if (verbosity) diff --git a/log.h b/log.h index ea9e9cf..7b40e48 100644 --- a/log.h +++ b/log.h @@ -11,6 +11,11 @@ enum verbosity { extern enum verbosity verbosity; +// If opt is a character that matches a standard UCSPI command line +// verbosity option, sets the verbosity appropriately and returns +// true. Otherwise, returns false. +_Bool set_verbosity(int opt); + // Log an error message, followed by strerrno(errno), then exit with // status eval. _Noreturn void diee(int eval, const char *fmt, ...); diff --git a/vsockclient.c b/vsockclient.c index 91e1320..d25ab13 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -35,13 +35,9 @@ int main(int argc, char *argv[]) while ((opt = getopt(argc, argv, "+qQv")) != -1) { switch (opt) { case 'q': - verbosity = nothing; - break; case 'Q': - verbosity = errors; - break; case 'v': - verbosity = all; + set_verbosity(opt); break; default: ex_usage(); diff --git a/vsockserver.c b/vsockserver.c index 03d9838..4c251b0 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -43,13 +43,9 @@ int main(int argc, char *argv[]) notify = true; break; case 'q': - verbosity = nothing; - break; case 'Q': - verbosity = errors; - break; case 'v': - verbosity = all; + set_verbosity(opt); break; default: ex_usage(); -- 2.30.0

2 2

[PATCH ucspi-vsock] vsockserver: consistently use {STDIN,STDOUT}_FILENO
by Alyssa Ross 18 Mar '21

18 Mar '21

--- vsockserver.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vsockserver.c b/vsockserver.c index 8f809ec..03d9838 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -110,7 +110,7 @@ int main(int argc, char *argv[]) diee(EX_OSERR, "dup2"); if (dup2(conn, STDOUT_FILENO) == -1) diee(EX_OSERR, "dup2"); - if (conn != 0 && conn != 1) + if (conn != STDIN_FILENO && conn != STDOUT_FILENO) close(conn); execvp(argv[optind], &argv[optind]); diee(EX_OSERR, "exec"); -- 2.30.0

2 2

[PATCH ucspi-vsock] vsockserver: consistently use diee instead of err
by Alyssa Ross 18 Mar '21

18 Mar '21

diee is our function that respects the verbosity setting. --- vsockserver.c | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/vsockserver.c b/vsockserver.c index 0317cd4..8f809ec 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -3,7 +3,6 @@ #define _GNU_SOURCE -#include <err.h> #include <errno.h> #include <inttypes.h> #include <stdbool.h> @@ -105,22 +104,22 @@ int main(int argc, char *argv[]) ilog("connection from %" PRIu32 " port %" PRIu32, rcid, rport); switch (child = fork()) { - case -1: err(EX_OSERR, "fork"); + case -1: diee(EX_OSERR, "fork"); case 0: if (dup2(conn, STDIN_FILENO) == -1) - err(EX_OSERR, "dup2"); + diee(EX_OSERR, "dup2"); if (dup2(conn, STDOUT_FILENO) == -1) - err(EX_OSERR, "dup2"); + diee(EX_OSERR, "dup2"); if (conn != 0 && conn != 1) close(conn); execvp(argv[optind], &argv[optind]); - err(EX_OSERR, "exec"); + diee(EX_OSERR, "exec"); } if (waitpid(child, NULL, 0) == -1) - err(EX_OSERR, "waitpid"); + diee(EX_OSERR, "waitpid"); close(conn); } - err(EX_OSERR, "accept"); + diee(EX_OSERR, "accept"); } -- 2.30.0

2 2

[PATCH ucspi-vsock] Use C11 noreturn instead of GNU attribute extension
by Alyssa Ross 18 Mar '21

18 Mar '21

--- log.h | 4 ++-- vsockclient.c | 8 ++++---- vsockserver.c | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/log.h b/log.h index a1b0c16..ea9e9cf 100644 --- a/log.h +++ b/log.h @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-or-later -// SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2020-2021 Alyssa Ross <hi(a)alyssa.is> #include <stdarg.h> @@ -13,7 +13,7 @@ extern enum verbosity verbosity; // Log an error message, followed by strerrno(errno), then exit with // status eval. -void diee(int eval, const char *fmt, ...) __attribute__((noreturn)); +_Noreturn void diee(int eval, const char *fmt, ...); // Log an error message. void elog(const char *fmt, ...); diff --git a/vsockclient.c b/vsockclient.c index ff8b7dc..91e1320 100644 --- a/vsockclient.c +++ b/vsockclient.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-or-later -// SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2020-2021 Alyssa Ross <hi(a)alyssa.is> #define _GNU_SOURCE @@ -7,9 +7,10 @@ #include <inttypes.h> #include <stdio.h> #include <stdlib.h> +#include <stdnoreturn.h> +#include <sys/socket.h> #include <sysexits.h> #include <unistd.h> -#include <sys/socket.h> #include <linux/vm_sockets.h> @@ -18,8 +19,7 @@ #include "util.h" #include "vsock.h" -static void ex_usage(void) __attribute__((noreturn)); -static void ex_usage(void) +noreturn static void ex_usage(void) { if (verbosity) fprintf(stderr, "Usage: %s [ -q | -Q | -v ] cid port prog...\n", diff --git a/vsockserver.c b/vsockserver.c index 2fb4f8e..0317cd4 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0-or-later -// SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2020-2021 Alyssa Ross <hi(a)alyssa.is> #define _GNU_SOURCE @@ -9,6 +9,7 @@ #include <stdbool.h> #include <stdio.h> #include <stdlib.h> +#include <stdnoreturn.h> #include <string.h> #include <sys/socket.h> #include <sys/wait.h> @@ -22,8 +23,7 @@ #include "util.h" #include "vsock.h" -static void ex_usage(void) __attribute__((noreturn)); -static void ex_usage(void) +noreturn static void ex_usage(void) { if (verbosity) fprintf(stderr, "Usage: %s [ -1 ] [ -q | -Q | -v ] cid port prog...\n", -- 2.30.0

2 2

[PATCH ucspi-vsock] Makefile: remove vsock{server,client}.o in clean
by Alyssa Ross 18 Mar '21

18 Mar '21

--- Makefile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 4f11b64..07ff09b 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-or-later -# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +# SPDX-FileCopyrightText: 2020-2021 Alyssa Ross <hi(a)alyssa.is> .POSIX: @@ -27,5 +27,6 @@ vsockclient.o: env.h log.h util.h vsock.h vsockserver.o: env.h log.h util.h vsock.h clean: - rm -f env.o log.o util.o vsock.o vsockclient vsockserver + rm -f env.o log.o util.o vsock.o \ + vsockclient.o vsockclient vsockserver.o vsockserver .PHONY: clean -- 2.30.0

2 2

[PATCH nixpkgs] spectrumPackages.spectrum-vm: fix without Wayland
by Alyssa Ross 16 Mar '21

16 Mar '21

This errored because of the undefined XDG_RUNTIME_DIR or WAYLAND_DISPLAY. I'd tried to prevent that by disabling -e around this part, but it turns out I should have disabled -u instead. --- pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in b/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in index 4fa0287a805..8d95c178689 100755 --- a/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in +++ b/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in @@ -55,7 +55,7 @@ do esac done -set +e +set +u if [ -n "$XDG_RUNTIME_DIR" ] then set -- -s "$XDG_RUNTIME_DIR" "$@" @@ -63,7 +63,7 @@ then then set -- --wayland-sock "$XDG_RUNTIME_DIR/$WAYLAND_DISPLAY" "$@" fi fi -set -e +set -u exec "$crosvm" run \ -p init=/sbin/init \ -- 2.27.0

2 4

[PATCH nixpkgs] spectrumPackages.rootfs: add /sys
by Alyssa Ross 16 Mar '21

16 Mar '21

Programs assume this and it's useful to have. --- pkgs/os-specific/linux/spectrum/rootfs/generic.nix | 2 +- pkgs/os-specific/linux/spectrum/rootfs/stage1.nix | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix index 778b18dafa0..0a99f99bd5b 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix @@ -31,7 +31,7 @@ let mkdir $out cd $out - mkdir bin sbin dev proc run tmp + mkdir bin sbin dev proc run sys tmp ln -s ${dash}/bin/dash bin/sh ln -s ${makeStage1 { inherit run; }} sbin/init cp -r ${./etc} etc diff --git a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix index 75cfed56e7f..be7853316e9 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix @@ -27,6 +27,7 @@ writeScript "init-stage1" '' if { s6-mount -t devpts -o gid=4,mode=620 none /dev/pts } if { s6-mount -t tmpfs none /dev/shm } if { s6-mount -t proc none /proc } + if { s6-mount -t sysfs none /sys } if { s6-ln -s ${mesa.drivers} /run/opengl-driver } export HOME / -- 2.30.0

2 3

[PATCH nixpkgs] spectrumPackages.rootfs: fix custom path entries
by Alyssa Ross 16 Mar '21

16 Mar '21

Stage 1 was supposed to be able to take a list of PATH entries to prepend to the default PATH, but it didn't do anything with them. Now, it properly adds them to the PATH as early as possible during boot. This mechanism isn't currently used anywhere, but is very useful for debugging. --- pkgs/os-specific/linux/spectrum/rootfs/generic.nix | 3 ++- pkgs/os-specific/linux/spectrum/rootfs/stage1.nix | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix index 0a99f99bd5b..81fb80a614f 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix @@ -8,7 +8,8 @@ let makeStage1 = import ./stage1.nix { inherit writeScript lib - execline s6 s6-portable-utils s6-linux-utils s6-linux-init busybox mesa; + execline s6 s6-portable-utils s6-linux-utils s6-linux-init busybox mesa + path; }; makeServicesDir = import ./services.nix { diff --git a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix index be7853316e9..6caf9ff93b8 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix @@ -1,16 +1,19 @@ { writeScript, lib , execline, s6, s6-portable-utils, s6-linux-utils, s6-linux-init, busybox, mesa +, path ? [] }: { run ? "true" }: let - path = [ s6 s6-portable-utils s6-linux-utils s6-linux-init busybox execline ]; + path' = path ++ [ + s6 s6-portable-utils s6-linux-utils s6-linux-init busybox execline + ]; in writeScript "init-stage1" '' #! ${execline}/bin/execlineb -P - export PATH ${lib.makeBinPath path} + export PATH ${lib.makeBinPath path'} ${s6}/bin/s6-setsid -qb -- importas -i spectrumcmd spectrumcmd -- 2.30.0

2 2

[PATCH nixpkgs] spectrumPackages.spectrum-vm: fix without Wayland
by Alyssa Ross 15 Mar '21

15 Mar '21

This errored because of the undefined XDG_RUNTIME_DIR or WAYLAND_DISPLAY. I'd tried to prevent that by disabling -e around this part, but it turns out I should have disabled -u instead. --- pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in b/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in index 4fa0287a805..8d95c178689 100755 --- a/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in +++ b/pkgs/os-specific/linux/spectrum/spectrum-vm/spectrum-vm.in @@ -55,7 +55,7 @@ do esac done -set +e +set +u if [ -n "$XDG_RUNTIME_DIR" ] then set -- -s "$XDG_RUNTIME_DIR" "$@" @@ -63,7 +63,7 @@ then then set -- --wayland-sock "$XDG_RUNTIME_DIR/$WAYLAND_DISPLAY" "$@" fi fi -set -e +set -u exec "$crosvm" run \ -p init=/sbin/init \ -- 2.30.0

1 1

[PATCH linux] usbip: tools: usbipd: add s6 readiness notification
by Alyssa Ross 15 Mar '21

15 Mar '21

This implements the s6 readiness notification protocol[1]. When the daemon has started and is listening on its socket(s), it will emit a readiness notification on a user-specified file descriptor. systemd-based systems can also use the readiness notification, using the sdnotify-wrapper program[2]. [1]: https://skarnet.org/software/s6/s6-supervise.html [2]: https://skarnet.org/software/misc/sdnotify-wrapper.c Signed-off-by: Alyssa Ross <hi(a)alyssa.is> --- This is important for us in Spectrum to be able to run usbipd to export USB devices to other VMs. I plan to add this patch to linuxPackages.usbip in Spectrum nixpkgs. I might attempt to upstream it to Linux, but I'm not sure yet -- the s6 protocol is perfect for our needs but fairly obsure, so I'm not sure if they'd like it. tools/usb/usbip/src/usbipd.c | 70 ++++++++++++++++++++++++++++-------- 1 file changed, 55 insertions(+), 15 deletions(-) diff --git a/tools/usb/usbip/src/usbipd.c b/tools/usb/usbip/src/usbipd.c index 48398a78e88af..4ee41040735f4 100644 --- a/tools/usb/usbip/src/usbipd.c +++ b/tools/usb/usbip/src/usbipd.c @@ -22,6 +22,7 @@ #include <arpa/inet.h> #include <sys/socket.h> #include <netinet/in.h> +#include <fcntl.h> #ifdef HAVE_LIBWRAP #include <tcpd.h> @@ -65,6 +66,10 @@ static const char usbipd_help_string[] = " -D, --daemon\n" " Run as a daemon process.\n" "\n" + " -nFD, --notify-fd FD\n" + " Once ready to receive connections, write a line feed\n" + " character to FD, then close it.\n" + "\n" " -d, --debug\n" " Print debugging information.\n" "\n" @@ -88,6 +93,30 @@ static void usbipd_help(void) printf("%s\n", usbipd_help_string); } +static int parse_notify_fd(char *arg) +{ + dbg("parsing notify-fd arg '%s'", arg); + char *end; + unsigned long int notify_fd = strtoul(arg, &end, 10); + + if (end == arg) { + err("notify-fd: could not parse '%s' as decimal integer", arg); + return -1; + } + + if (*end != '\0') { + err("notify-fd: garbage at end of '%s'", arg); + return -1; + } + + if (fcntl(notify_fd, F_GETFD) == -1) { + err("notify-fd: %s", strerror(errno)); + return -1; + } + + return notify_fd; +} + static int recv_request_import(int sockfd) { struct op_import_request req; @@ -488,7 +517,7 @@ static void remove_pid_file(void) } } -static int do_standalone_mode(int daemonize, int ipv4, int ipv6) +static int do_standalone_mode(int daemonize, int notify_fd, int ipv4, int ipv6) { struct addrinfo *ai_head; int sockfdlist[MAXSOCKFD]; @@ -543,6 +572,13 @@ static int do_standalone_mode(int daemonize, int ipv4, int ipv6) dbg("listening on %d address%s", nsockfd, (nsockfd == 1) ? "" : "es"); + if (notify_fd != -1) { + const char lf[] = { '\n' }; + if (write(notify_fd, lf, sizeof lf) == -1) + err("failed to notify readiness"); + close(notify_fd); + } + fds = calloc(nsockfd, sizeof(struct pollfd)); for (i = 0; i < nsockfd; i++) { fds[i].fd = sockfdlist[i]; @@ -586,17 +622,18 @@ static int do_standalone_mode(int daemonize, int ipv4, int ipv6) int main(int argc, char *argv[]) { static const struct option longopts[] = { - { "ipv4", no_argument, NULL, '4' }, - { "ipv6", no_argument, NULL, '6' }, - { "daemon", no_argument, NULL, 'D' }, - { "daemon", no_argument, NULL, 'D' }, - { "debug", no_argument, NULL, 'd' }, - { "device", no_argument, NULL, 'e' }, - { "pid", optional_argument, NULL, 'P' }, - { "tcp-port", required_argument, NULL, 't' }, - { "help", no_argument, NULL, 'h' }, - { "version", no_argument, NULL, 'v' }, - { NULL, 0, NULL, 0 } + { "ipv4", no_argument, NULL, '4' }, + { "ipv6", no_argument, NULL, '6' }, + { "daemon", no_argument, NULL, 'D' }, + { "daemon", no_argument, NULL, 'D' }, + { "notify-fd", required_argument, NULL, 'n' }, + { "debug", no_argument, NULL, 'd' }, + { "device", no_argument, NULL, 'e' }, + { "pid", optional_argument, NULL, 'P' }, + { "tcp-port", required_argument, NULL, 't' }, + { "help", no_argument, NULL, 'h' }, + { "version", no_argument, NULL, 'v' }, + { NULL, 0, NULL, 0 } }; enum { @@ -605,7 +642,7 @@ int main(int argc, char *argv[]) cmd_version } cmd; - int daemonize = 0; + int daemonize = 0, notify_fd = -1; int ipv4 = 0, ipv6 = 0; int opt, rc = -1; @@ -620,7 +657,7 @@ int main(int argc, char *argv[]) cmd = cmd_standalone_mode; driver = &host_driver; for (;;) { - opt = getopt_long(argc, argv, "46DdeP::t:hv", longopts, NULL); + opt = getopt_long(argc, argv, "46Dn:deP::t:hv", longopts, NULL); if (opt == -1) break; @@ -635,6 +672,9 @@ int main(int argc, char *argv[]) case 'D': daemonize = 1; break; + case 'n': + notify_fd = parse_notify_fd(optarg); + break; case 'd': usbip_use_debug = 1; break; @@ -665,7 +705,7 @@ int main(int argc, char *argv[]) switch (cmd) { case cmd_standalone_mode: - rc = do_standalone_mode(daemonize, ipv4, ipv6); + rc = do_standalone_mode(daemonize, notify_fd, ipv4, ipv6); remove_pid_file(); break; case cmd_version: -- 2.27.0

1 0

This Week in Spectrum, 2021-W10
by Alyssa Ross 14 Mar '21

14 Mar '21

Surprise! I sent the last This Week in Spectrum in August. Since then, it's been pretty quiet. What happened? Towards then end of last year, I was aggressively pushing to achieve a funding milestone, but was starting to struggle to keep myself going. After that last TWiS, I decided to stop posting them for a while to fully concentrate on the push. I continued like that for two more months, before getting to the point where I was so burned out I just couldn't keep going, with the milestone still not done, the work I had done so far on it unpublished (and not in a good state to be published), and time running out. Fortunately, I was able to talk to NLnet, and they agreed to extend my funding deadlines and renegotiate the milestones. With that sorted out, in late November I began a hiatus from Spectrum to allow myself to recover from the burnout. I'm very grateful to my GitHub Sponsors, thanks to whom I was able to take this time to recover. I tried to come back at the end of January, but after a single day of Spectrum work I was feeling much the same as I had been in November. This week, though, something changed! I've been working on Spectrum again for the last week, and I've been feeling great about it! Now, there were three months of work between the last TWiS in August, and the start of my hiatus. That's a lot of work I haven't written about. But I think the only way this is really going to work is if I leave that largely unwritten about for now, because TWiS tends to be thousands of words long even when it's covering a single week of work. So I'm just going to talk about what I've done in the last week, explaining context from previous work as necessary. With all that in mind, here we go! "Qubes-lite with KVM and Wayland"[1] ------------------------------------ First up is something somebody else did, which is always nice! Thomas has been doing his own great work replacing his Qubes system with a system built on NixOS, using KVM and Wayland. Thomas got in touch on the Spectrum discuss mailing list in January[2] asking some questions about how some things were implemented, and we went back and forth a bit then (although not as much as I'd have liked, due to my burnout :/). Since then, he's come up with some awesome stuff, like an OCaml implementation of a virtio-wayland proxy (equivalent to Sommelier in Chromium OS). In our further conversation prompted by Thomas's article, Thomas raised a further interesting idea[3] -- what if we had a Sommelier-like Wayland proxy, but that ran in the same security domain as the compositor. That way, we could filter to allow only the protocol extensions we want to. We could implement our own permissions when the compositor doesn't. This code would be responsible for securely handling Wayland messages from an untrusted guest, which would be beneficial because it would be a lot less code to audit, and because it could be written in a memory-safe language. This would avoid the need to write or find a secure Wayland compositor, and would in fact allow us to use virtually any compositor without having to worry nearly as much about its security credentials. I'm very excited by that idea, and I've been asking myself for the past few days why I didn't think of it before! I've thought several times "it's quite nice that Sommelier gives us a known subset of Wayland, but it's a shame we can't rely on it since it runs inside a application guest". But for some reason it just never occurred to me to follow that idea one step further, to "what if we had a similar program that run in the compositor's security domain". [1]: https://roscidus.com/blog/blog/2021/03/07/qubes-lite-with-kvm-and-wayland/ [2]: https://spectrum-os.org/lists/archives/spectrum-discuss/CAG4opy_hz_ESEpY0Tq… [3]: https://spectrum-os.org/lists/archives/spectrum-discuss/CAG4opy_JztAH3tD+ZU… uscpi-vsock ----------- ucspi-vsock[4] is a program I started writing in September. VSOCK[5] is a special Linux socket type that allows for communication between VMs, and I'm using it to allow services running in VMs (a USBIP daemon, for example), to notify the host (and by extension other VMs), when the service in the VM becomes ready to accept connections. USCPI[6] is a standard command interface for making it easy to do socket communication using standard IO primitives, without having to teach programs how to do socket connections for every kind of socket. There are several UCSPI implementations for common socket types like Internet and Unix domain sockets, but until now there was not one for VSOCK. So, for example, in a VM we can do: vsockclient 2 $port sh -c 'echo >&7' Which will connect to the host over VSOCK (in VSOCK the host is always address 2), write a newline, and close the connection. UCSPI lets us implement this with standard shell tools. There's an equivalent "vsockserver" program for the other end, that will run a command whenever a connection is received. Anyway, this week I went back to ucspi-vsock to fix some bugs[7][8][9][10]. As usual, (although I'm happy to realise this is still the case after all these months!) Cole was kind enough to review my patches. [4]: https://spectrum-os.org/git/ucspi-vsock/ [5]: https://man7.org/linux/man-pages/man7/vsock.7.html [6]: https://cr.yp.to/proto/ucspi.txt [7]: https://spectrum-os.org/lists/archives/spectrum-devel/20210309154048.14474-… [8]: https://spectrum-os.org/lists/archives/spectrum-devel/20210309171816.8589-1… [9]: https://spectrum-os.org/lists/archives/spectrum-devel/20210310204516.20041-… [10]: https://spectrum-os.org/lists/archives/spectrum-devel/20210310204555.20725-… Interguest networking --------------------- The bulk of my work this week has been in Spectrum's Nixpkgs, which is where (for now, at least) all the VM definitions and stuff live. Mostly, I've been trying to clean up months of frantic work into something I can actually publish as a series of patches, so it's out there instead of just on my computer! My focus at the moment is on doing this with the interguest networking implementation I wrote last year. The plan for this remains the same as last year: have a VM that manages all network hardware access and acts as a router for other VMs that need to talk to the outside world. Eventually, this will hopefully use virtio-vhost-user[11], which will allow us to avoid going through a networking stack on the host at all (or even having one), but until virtio-vhost-user is further along, we'll use bridge devices on the host to connect client VMs to the router. A very basic version of the latter is implemented and working for me locally -- I can run an application VM, and have it connect to another VM which runs the drivers for my ethernet port using VFIO (PCI passthrough). This code was a big ball of mud, and I'd also subtly broken it when I moved on from interguest networking last year to try to get a proof of concept going for another form of interguest communication. So I spent this week trying to page all the context I'd lost in the last few months back into my brain, making lots of partial git commits, writing commit messages, and fixing it up so that it works again. I think what I have is about ready to publish -- hopefully you'll see some patches next week. But what exists at the moment is still very limited -- the biggest limitation is that the router VM doesn't support hotplugging, so a VM that wants to connect to it actually has to be started first, before the router VM. Not good for something that should be run as a system service and likely started on boot! To overcome this limitation, I'll probably have to add support in crosvm for adding network devices at runtime using the control socket. I think this should be easy enough, and I haven't looked at what's happened in crosvm + rust-vmm since I've been away, so it's even possible somebody else will have done this already. [11]: https://wiki.qemu.org/Features/VirtioVhostUser So, the todo list for next week is getting the initial interguest networking PoC patchset posted. That'll come with a nice little demo other people will be able to try out if they want to. And then, I'll work on improving it further to the point where it's actually practical. I don't want to spend /too/ much time on this, since ultimately I do want to be using a virtio-vhost-user stack, which is quite different, but it's important to have an implementation of this so there's something to test further development (that doesn't care about the implementation details) against. My biggest worry at the moment is burning out again. Working in moderation isn't easy for me (I tend to get very sucked into things), but it's important for the project that I find a way to keep my work sustainable, so we don't lose time like this again. I'm still a little hesitant to say "this is it, I'm back for real". But the signs are looking good. Thank you for sticking with me through this.

1 0

[PATCH ucspi-vsock] vsockserver: use fclose instead of close
by Alyssa Ross 10 Mar '21

10 Mar '21

stdio can buffer output, so if we close stdout without going through stdio, there might be buffered output that is never written. --- vsockserver.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vsockserver.c b/vsockserver.c index dd9a74a..196056a 100644 --- a/vsockserver.c +++ b/vsockserver.c @@ -90,7 +90,7 @@ int main(int argc, char *argv[]) if (notify) { printf("%" PRIu32 "\n", lport); - close(STDOUT_FILENO); + fclose(stdout); } setenvf("VSOCKLOCALCID", 1, "%" PRIu32, lcid); -- 2.30.0

2 2

[PATCH ucspi-vsock] Makefile: link object files instead of source files
by Alyssa Ross 10 Mar '21

10 Mar '21

Previously this would (I assume) needlessly recompile vsockserver.c and vsockclient.c when Make has already automatically compiled those. GNU Make has an automatic variable, $+, that we could use here, but currently the Makefile is portable, and it would be a shame to require GNU Make just for that. --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index b931c89..4f11b64 100644 --- a/Makefile +++ b/Makefile @@ -19,9 +19,9 @@ install: vsockclient vsockserver .PHONY: install vsockclient: vsockclient.o env.o log.o util.o vsock.o - $(CC) $(LDFLAGS) -o vsockclient vsockclient.c env.o log.o util.o vsock.o $(LDLIBS) + $(CC) $(LDFLAGS) -o vsockclient vsockclient.o env.o log.o util.o vsock.o $(LDLIBS) vsockserver: vsockserver.o env.o log.o util.o vsock.o - $(CC) $(LDFLAGS) -o vsockserver vsockserver.c env.o log.o util.o vsock.o $(LDLIBS) + $(CC) $(LDFLAGS) -o vsockserver vsockserver.o env.o log.o util.o vsock.o $(LDLIBS) vsockclient.o: env.h log.h util.h vsock.h vsockserver.o: env.h log.h util.h vsock.h -- 2.30.0

2 1

[PATCH ucspi-vsock] vsock_accept: return fd instead of 0 on success
by Alyssa Ross 10 Mar '21

10 Mar '21

This would result in the spawned process being hooked up to stdin, instead of the vsock. Then stdin would be closed, so subsequent processes would be connected to nothing. Oops. --- I am... a bit embarassed that I didn't notice this after already fixing the exact same problem in vsock_connect[1]. Maybe I can write an integration test that runs vsockserver and vsockclient and checks they actually do the right thing... [1]: https://spectrum-os.org/lists/archives/spectrum-devel/20210309171816.8589-1… vsock.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/vsock.c b/vsock.c index d9ff3b6..e6a173c 100644 --- a/vsock.c +++ b/vsock.c @@ -32,14 +32,15 @@ int vsock_accept(int sockfd, uint32_t *cid, uint32_t *port) { struct sockaddr_vm addr = { 0 }; socklen_t addr_size = sizeof addr; + int fd; - if (accept(sockfd, (struct sockaddr *)&addr, &addr_size) == -1) + if ((fd = accept(sockfd, (struct sockaddr *)&addr, &addr_size)) == -1) return -1; *cid = addr.svm_cid; *port = addr.svm_port; - return 0; + return fd; } int vsock_connect(int fd, uint32_t cid, uint32_t port) -- 2.30.0

2 1

[PATCH ucspi-vsock] vsock_open: return fd instead of 0 on success
by Alyssa Ross 10 Mar '21

10 Mar '21

Previously, this returned the return value of connect(2), which is 0 on success. So stdin would be assigned to descriptors 6 and 7 in vsockclient instead of the socket. Oops. --- vsock.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/vsock.c b/vsock.c index 3bcd8b3..d9ff3b6 100644 --- a/vsock.c +++ b/vsock.c @@ -55,7 +55,10 @@ int vsock_open(uint32_t cid, uint32_t port) if (fd == -1) return -1; - return vsock_connect(fd, cid, port); + if (vsock_connect(fd, cid, port) == -1) + return -1; + + return fd; } int vsock_get_port(int fd, uint32_t *port) -- 2.30.0

2 1

[PATCH www] index.html: add alt text to logo
by Alyssa Ross 19 Dec '20

19 Dec '20

The empty alt text would make the image basically invisible if the user agent didn't display the image for whatever reason. This would have been fine if the image was entirely decorative, but since it's also the only way to navigate to the logo page it's important it has some fallback content so there's still something to select. --- index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 10dcdeb..4345121 100644 --- a/index.html +++ b/index.html @@ -17,8 +17,8 @@ <body> <a href="logo" style="float: left; margin: 0 1em 0.5em 0"> - <img class="logo" src="logo/logo_html.svg" width="70" height="70" alt=""> - <img class="no-logo" srcset="logo/logo140.png 140w" src="logo/logo70.png" width="70" height="70" alt="" hidden loading="lazy"> + <img class="logo" src="logo/logo_html.svg" width="70" height="70" alt="Spectrum logo"> + <img class="no-logo" srcset="logo/logo140.png 140w" src="logo/logo70.png" width="70" height="70" alt="Spectrum logo" hidden loading="lazy"> </a> <h1>Spectrum — a step towards <em>usable</em> secure computing</h1> -- 2.27.0

1 0

[PATCH www] design.html: backpedal a bit on POWER9
by Alyssa Ross 29 Nov '20

29 Nov '20

Supporting POWER9 isn't going to be as easy as I'd initially hoped. This patch aims to explain that there are blockers that I'd need help overcoming to be able to support it, even though I'd still like to. I don't want to be promising anything I can't deliver on, and I now know that it's very unlikely I'll be able to deliver on this without help. Reported-by: Molly Miller <mm(a)m-squa.red> --- design.html | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/design.html b/design.html index 181c15c..f683ed4 100644 --- a/design.html +++ b/design.html @@ -127,18 +127,26 @@ Management Engine</a> / <a href="https://en.wikipedia.org/wiki/AMD_Platform_Security_Processor">AMD Platform Security Processor</a>. -<p>So, Spectrum will additionally have -first class support for at least ppc64le. This architecture has been -chosen because it is the only other architecture that can come close -to the sheer performance x86_64 can offer at the high end, and -because, in stark contrast to x86_64, it is possible to buy a new -ppc64le (POWER9) system that does not require any proprietary firmware -that cannot be inspected and audited. It is a goal of the project to -build all packages, x86_64 and ppc64le, on POWER9 hardware. Even if a -user has to trust the x86_64 computer available to them, anti-freedom -firmware, undocumented backdoors and all, it would be a disservice to -them to force them to use packages built on other such untrustworthy -hardware. +<p> +I would like Spectrum to additionally have first class support for at +least ppc64le. This is the only other architecture that can come +close to the sheer performance x86_64 can offer at the high end, and +in stark contrast to x86_64, it is possible to buy a new ppc64le +(POWER9) system that does not require any proprietary firmware that +cannot be inspected and audited. A blocker for POWER9 support is an +support in crosvm for virtualizing that architecture, which is outside +the expertise of anybody currently working on Spectrum but would be a +very welcome contribution. + +<p> +Ideally, all Spectrum packages, x86_64 and ppc64le, would be built on +POWER9 hardware. Even if a user has to trust the x86_64 computer +available to them, anti-freedom firmware, undocumented backdoors and +all, they would be able to benefit from binary packages that were +built on trustworthy hardware without these limitations. +Unfortunately, preliminary research has shown that x86_64 +virtualization on POWER9 is not currently sufficiantly performant for +this to be feasible. <p> <small>Permission is granted to copy, distribute and/or modify this -- 2.27.0

2 6

[PATCH www 1/2] Add Spectrum logo!
by Alyssa Ross 22 Nov '20

22 Nov '20

This lovely logo was designed for us by hazelnot. The browser-compatible SVG is incompatible with Firefox, except for the version (83.0) that just came out a couple of days ago, because it uses CSS conic gradients. So for a little while we'll need an annoying PNG fallback. --- I haven't included the PNG files in this patch, since they take up a lot of space (compared to text!) and can easily be generated from the SVG like this if you want to test the fallback: inkscape -w 70 -h 70 -e logo/logo70.png logo/logo_mesh.svg inkscape -w 140 -h 140 -e logo/logo140.png logo/logo_mesh.svg inkscape -w 200 -h 200 -e logo/logo200.png logo/logo_mesh.svg inkscape -w 400 -h 400 -e logo/logo400.png logo/logo_mesh.svg index.html | 5 ++++ logo/index.html | 60 +++++++++++++++++++++++++++++++++++++++ logo/logo140.png | Bin 0 -> 21544 bytes logo/logo140.png.license | 4 +++ logo/logo200.png | Bin 0 -> 36741 bytes logo/logo200.png.license | 4 +++ logo/logo400.png | Bin 0 -> 98542 bytes logo/logo400.png.license | 4 +++ logo/logo70.png | Bin 0 -> 7285 bytes logo/logo70.png.license | 4 +++ logo/logo_html.svg | 33 +++++++++++++++++++++ logo/logo_mesh.svg | 59 ++++++++++++++++++++++++++++++++++++++ style.css | 13 +++++++++ 13 files changed, 186 insertions(+) create mode 100644 logo/index.html create mode 100644 logo/logo140.png create mode 100644 logo/logo140.png.license create mode 100644 logo/logo200.png create mode 100644 logo/logo200.png.license create mode 100644 logo/logo400.png create mode 100644 logo/logo400.png.license create mode 100644 logo/logo70.png create mode 100644 logo/logo70.png.license create mode 100644 logo/logo_html.svg create mode 100644 logo/logo_mesh.svg diff --git a/index.html b/index.html index cbea331..1a3f18e 100644 --- a/index.html +++ b/index.html @@ -15,6 +15,11 @@ <body> +<a href="logo" style="float: left; margin: 0 1em 0.5em 0"> + <img class="logo" src="logo/logo_html.svg" width="70" height="70" alt=""> + <img class="no-logo" srcset="logo/logo140.png 140w" src="logo/logo70.png" width="70" height="70" alt="" hidden loading="lazy"> +</a> + <h1>Spectrum — a step towards <em>usable</em> secure computing</h1> <p> diff --git a/logo/index.html b/logo/index.html new file mode 100644 index 0000000..93727b7 --- /dev/null +++ b/logo/index.html @@ -0,0 +1,60 @@ +<!doctype html> + + + +<html lang="en"> + +<head> + +<meta charset="utf-8"> +<meta name="viewport" content="width=device-width,initial-scale=1"> + +<link rel="stylesheet" href="../style.css"> + +<title>Spectrum logo</title> + +<body> + +<nav> + <a href="..">Spectrum</a> +</nav> + +<h1>Logo</h1> + +<p> +<img class="logo" src="logo_html.svg" width="200" height="200" alt="" style="margin: 0 auto"> +<img class="no-logo" srcset="logo400.png 400w" src="logo200.png" alt="" width="200" height="200" style="margin: 0 auto" loading="lazy" hidden> + +<p> +The Spectrum logo was designed by hazelnot, and is released under +the <a href="https://creativecommons.org/publicdomain/zero/1.0/">Creative +Commons Zero</a> license. + +<p> +Two versions of the logo are available. The first is an SVG file +suitable for web browsers, and the second is an SVG file suitable for +<a href="https://inkscape.org/">Inkscape</a>. The difference between +the versions is in how the colored ring is implemented, since standard +SVG has no way of drawing conic gradients. The browser version uses +an embedded HTML element with a CSS conic gradient, and the Inkscape +version uses the +not-yet-standard <a href="https://wiki.inkscape.org/wiki/index.php/Mesh_Gradients">SVG +Mesh Gradients</a>. + +<ul> + + <li><a href="logo_html.svg" download>logo_html.svg</a> (for web browsers) + <li><a href="logo_mesh.svg" download>logo_mesh.svg</a> (for Inkscape) + +</ul> + +<p> +<small>Permission is granted to copy, distribute and/or modify this +document under either the terms of the +<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative +Commons Attribution-ShareAlike 4.0 International License</a>, or the +<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free +Documentation License, Version 1.3</a> or any later version published +by the Free Software Foundation; with no Invariant Sections, no +Front-Cover Texts, and no Back-Cover Texts.</small> + diff --git a/logo/logo140.png b/logo/logo140.png new file mode 100644 index 0000000..5978eb9 Binary files /dev/null and b/logo/logo140.png differ diff --git a/logo/logo140.png.license b/logo/logo140.png.license new file mode 100644 index 0000000..817f6ad --- /dev/null +++ b/logo/logo140.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2020 hazelnot +SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> + +SPDX-License-Identifier: CC0-1.0 diff --git a/logo/logo200.png b/logo/logo200.png new file mode 100644 index 0000000..0cd4f1e Binary files /dev/null and b/logo/logo200.png differ diff --git a/logo/logo200.png.license b/logo/logo200.png.license new file mode 100644 index 0000000..817f6ad --- /dev/null +++ b/logo/logo200.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2020 hazelnot +SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> + +SPDX-License-Identifier: CC0-1.0 diff --git a/logo/logo400.png b/logo/logo400.png new file mode 100644 index 0000000..2cf9ecc Binary files /dev/null and b/logo/logo400.png differ diff --git a/logo/logo400.png.license b/logo/logo400.png.license new file mode 100644 index 0000000..817f6ad --- /dev/null +++ b/logo/logo400.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2020 hazelnot +SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> + +SPDX-License-Identifier: CC0-1.0 diff --git a/logo/logo70.png b/logo/logo70.png new file mode 100644 index 0000000..664aba4 Binary files /dev/null and b/logo/logo70.png differ diff --git a/logo/logo70.png.license b/logo/logo70.png.license new file mode 100644 index 0000000..817f6ad --- /dev/null +++ b/logo/logo70.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2020 hazelnot +SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> + +SPDX-License-Identifier: CC0-1.0 diff --git a/logo/logo_html.svg b/logo/logo_html.svg new file mode 100644 index 0000000..199c3ca --- /dev/null +++ b/logo/logo_html.svg @@ -0,0 +1,33 @@ + + + + +<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 100 100"> + <defs> + <filter id="ring-shadow" x="-10" y="-10" width="120" height="120" color-interpolation-filters="sRGB"> + <feGaussianBlur in="SourceGraphic" stdDeviation="5" result="blur" /> + <feComposite in="SourceGraphic" in2="offset" operator="over" /> + </filter> + + <filter id="center-shadow" x="-10" y="-10" width="120" height="120"> + <feDropShadow dx="0" dy="0" stdDeviation="6" flood-color="#DDD" /> + </filter> + + <mask id="ring-mask"> + <circle stroke="white" stroke-width="5" cx="50" cy="50" r="36" fill="none" /> + </mask> + </defs> + +  + <g filter="url(#ring-shadow)"> + <foreignObject width="100" height="100" mask="url(#ring-mask)"> + <div xmlns="http://www.w3.org/1999/xhtml" style="width: 100%; height: 100%; background: conic-gradient(from 0.25turn, red, magenta, blue, aqua, lime, yellow, red)" /> + </foreignObject> + </g> + + <circle cx="50" cy="50" r="27" fill="white" filter="url(#center-shadow)" /> +</svg> diff --git a/logo/logo_mesh.svg b/logo/logo_mesh.svg new file mode 100644 index 0000000..ccd6583 --- /dev/null +++ b/logo/logo_mesh.svg @@ -0,0 +1,59 @@ + + + + +<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 100 100"> + <defs> + <filter id="ring-shadow" x="-10" y="-10" width="120" height="120" color-interpolation-filters="sRGB"> + <feGaussianBlur in="SourceGraphic" stdDeviation="5" result="blur" /> + <feComposite in="SourceGraphic" in2="offset" operator="over" /> + </filter> + + <filter id="center-shadow" x="-10" y="-10" width="120" height="120" color-interpolation-filters="sRGB"> + <feFlood flood-opacity="1" flood-color="#DDD" result="flood" /> + <feComposite in="flood" in2="SourceGraphic" operator="in" result="composite1" /> + <feGaussianBlur in="composite1" stdDeviation="6" result="blur" /> + <feComposite in="SourceGraphic" in2="blur" operator="over" result="composite2" /> + </filter> + + <meshgradient id="ring-gradient" x="1.5" y="0.5"> + <meshrow> + <meshpatch> + <stop path="L 1 -0.36603" stop-color="red" /> + <stop path="L 0.5 0.5" stop-color="yellow" /> + <stop path="L 0.5 0.5" stop-color="yellow" /> + <stop path="L 1 0.5" stop-color="red" /> + </meshpatch> + <meshpatch> + <stop path="L 0 -0.36603" /> + <stop path="L 0.5 0.5" stop-color="lime" /> + <stop path="L 0.5 0.5" stop-color="lime" /> + </meshpatch> + <meshpatch> + <stop path="L -0.5 0.5" /> + <stop path="L 0.5 0.5" stop-color="cyan" /> + <stop path="L 0.5 0.5" stop-color="cyan" /> + </meshpatch> + <meshpatch> + <stop path="L 0 1.36603" /> + <stop path="L 0.5 0.5" stop-color="blue" /> + <stop path="L 0.5 0.5" stop-color="blue" /> + </meshpatch> + <meshpatch> + <stop path="L 1 1.36603" /> + <stop path="L 0.5 0.5" stop-color="magenta" /> + <stop path="L 0.5 0.5" stop-color="magenta" /> + </meshpatch> + <meshpatch> + <stop path="L 1.5 0.5" /> + <stop path="L 0.5 0.5" stop-color="red" /> + <stop path="L 0.5 0.5" stop-color="red" /> + </meshpatch> + </meshrow> + </meshgradient> + </defs> + + <circle cx="50" cy="50" r="36" fill="none" stroke="url(#ring-gradient)" stroke-width="5" filter="url(#ring-shadow)" /> + + <circle cx="50" cy="50" r="27" fill="white" filter="url(#center-shadow)" /> +</svg> diff --git a/style.css b/style.css index e9fd751..6463f24 100644 --- a/style.css +++ b/style.css @@ -20,3 +20,16 @@ h1, h2, h3, h4 { var { font-family: serif; } + +/* +Firefox only supports conic gradients as of 83.0, so for the time +being, we need to provide a fallback for the logo. +*/ + +.logo { display: none; } +.no-logo { display: block; } + +@supports (background: conic-gradient(from 0.25turn, red, magenta, blue, aqua, lime, yellow, red)) { + .logo { display: block; } + .no-logo { display: none; } +} -- 2.27.0

2 4

[DRAFT PATCH nixpkgs] smaller kernel
by Philipp Steinpaß 26 Aug '20

26 Aug '20

minimize spectrum-vm kernel --- pkgs/os-specific/linux/spectrum/linux/vm.nix | 449 +++++++++++++++++++ 1 file changed, 449 insertions(+) diff --git a/pkgs/os-specific/linux/spectrum/linux/vm.nix b/pkgs/os-specific/linux/spectrum/linux/vm.nix index 9c9ba78b691..c313697eeb2 100644 --- a/pkgs/os-specific/linux/spectrum/linux/vm.nix +++ b/pkgs/os-specific/linux/spectrum/linux/vm.nix @@ -4,6 +4,7 @@ with lib.kernel; linux.override { structuredExtraConfig = { + VIRTIO_CONSOLE = yes; VIRTIO_PCI = yes; VIRTIO_BLK = yes; VIRTIO_WL = yes; @@ -21,5 +22,453 @@ linux.override { NET_9P = yes; NET_9P_VIRTIO = yes; "9P_FS" = yes; + + ACPI = no; + AD525X_DPOT = no; + ADIN_PHY = no; + AF_KCM = no; + ALTERA_STAPL = no; + ALTERA_TSE = no; + AMD_PHY = no; + APDS9802ALS = no; + AQUANTIA_PHY = no; + AT803X_PHY = no; + ATA = no; + ATA_OVER_ETH = no; + ATM_DRIVERS = no; + AX88796B_PHY = no; + B53 = no; + BCM87XX_PHY = no; + BCMA = no; + BCM_KONA_USB2_PHY = no; + BLK_DEV_DRBD = no; + BLK_DEV_FD = no; + BLK_DEV_LOOP = no; + BLK_DEV_NULL_BLK = no; + BLK_DEV_RBD = no; + BROADCOM_PHY = no; + BT = no; + C2PORT = no; + CAIF = no; + CAN = no; + CDROM_PKTCDVD = no; + CHROME_PLATFORMS = no; + CICADA_PHY = no; + CMA = no; + COMEDI = no; + CORTINA_PHY = no; + COUNTER = no; + DAVICOM_PHY = no; + DEV_DAX = no; + DMADEVICES = no; + DNET = no; + DP83822_PHY = no; + DP83848_PHY = no; + DP83867_PHY = no; + DP83TC811_PHY = no; + DRM_ETNAVIV = no; + DRM_PANEL_ORIENTATION_QUIRKS = module; + DS1682 = no; + DUMMY_IRQ = no; + ECHO = no; + ENCLOSURE_SERVICES = no; + ETHOC = no; + EXT2_FS = no; + EXT4_USE_FOR_EXT2 = yes; + EXTCON = no; + FIELDBUS_DEV = no; + FPGA = no; + FW_LOADER_USER_HELPER = no; + GENERIC_PHY = no; + GNSS = no; + GREYBUS = no; + GS_FPGABOOT = no; + HAMRADIO = no; + HMC6352 = no; + HSI = no; + HVC_XEN = no; + HW_RANDOM_TIMERIOMEM = no; + HW_RANDOM_VIA = no; + I2C_ALGOPCF = no; + I2C_CHARDEV = no; + I2C_COMPAT = no; + I2C_HELPER_AUTO = no; + I2C_SLAVE_EEPROM = no; + I2C_STUB = no; + I3C = no; + I8K = no; + ICPLUS_PHY = no; + ICS932S401 = no; + IEEE802154_DRIVERS = no; + IIO = no; + INFINIBAND = no; + INPUT_JOYSTICK = no; + INPUT_KEYBOARD = no; + INPUT_MISC = no; + INPUT_MOUSE = no; + INPUT_TABLET = no; + INPUT_TOUCHSCREEN = no; + INTEL_TH = no; + INTEL_XWAY_PHY = no; + INTERCONNECT = no; + IOMMU_IOVA = module; + IOSF_MBI = module; + IPACK_BUS = no; + IPMB_DEVICE_INTERFACE = no; + IPMI_HANDLER = no; + ISL29003 = no; + ISL29020 = no; + LEDS_APU = no; + LEDS_BD2802 = no; + LEDS_BLINKM = no; + LEDS_CLASS_FLASH = no; + LEDS_CLEVO_MAIL = no; + LEDS_GPIO = no; + LEDS_LM3530 = no; + LEDS_LM3532 = no; + LEDS_LM3533 = no; + LEDS_LM355x = no; + LEDS_LM3642 = no; + LEDS_LP3944 = no; + LEDS_LP3952 = no; + LEDS_LP5521 = no; + LEDS_LP5523 = no; + LEDS_LP5562 = no; + LEDS_LP8501 = no; + LEDS_MC13783 = no; + LEDS_MENF21BMC = no; + LEDS_MLXCPLD = no; + LEDS_MLXREG = no; + LEDS_MT6323 = no; + LEDS_PCA9532 = no; + LEDS_PCA955X = no; + LEDS_PCA963X = no; + LEDS_REGULATOR = no; + LEDS_TCA6507 = no; + LEDS_TI_LMU_COMMON = no; + LEDS_TLC591XX = no; + LEDS_TRIGGER_ACTIVITY = no; + LEDS_TRIGGER_BACKLIGHT = no; + LEDS_TRIGGER_CAMERA = no; + LEDS_TRIGGER_DEFAULT_ON = no; + LEDS_TRIGGER_GPIO = no; + LEDS_TRIGGER_HEARTBEAT = no; + LEDS_TRIGGER_NETDEV = no; + LEDS_TRIGGER_ONESHOT = no; + LEDS_TRIGGER_PATTERN = no; + LEDS_TRIGGER_TIMER = no; + LEDS_TRIGGER_TRANSIENT = no; + LEDS_USER = no; + LSI_ET1011C_PHY = no; + LXT_PHY = no; + MACINTOSH_DRIVERS = no; + MAILBOX = no; + MARVELL_10G_PHY = no; + MARVELL_PHY = no; + MCB = no; + MDIO_BITBANG = no; + MDIO_MSCC_MIIM = no; + MEDIA_SUPPORT = no; + MEMSTICK = no; + MFD_CROS_EC = no; + MICREL_PHY = no; + MICROCHIP_PHY = no; + MICROCHIP_T1_PHY = no; + MICROSEMI_PHY = no; + MMC = no; + MOST = no; + MTD = no; + MWAVE = no; + NATIONAL_PHY = no; + NET_DSA_BCM_SF2 = no; + NET_DSA_LANTIQ_GSWIP = no; + NET_DSA_LOOP = no; + NET_DSA_MICROCHIP_KSZ8795 = no; + NET_DSA_MICROCHIP_KSZ9477 = no; + NET_DSA_MT7530 = no; + NET_DSA_MV88E6060 = no; + NET_DSA_MV88E6XXX = no; + NET_DSA_QCA8K = no; + NET_DSA_REALTEK_SMI = no; + NET_DSA_SMSC_LAN9303_I2C = no; + NET_DSA_SMSC_LAN9303_MDIO = no; + NET_VENDOR_ALACRITECH = no; + NET_VENDOR_AMAZON = no; + NET_VENDOR_AQUANTIA = no; + NET_VENDOR_ARC = no; + NET_VENDOR_AURORA = no; + NET_VENDOR_CADENCE = no; + NET_VENDOR_CAVIUM = no; + NET_VENDOR_CORTINA = no; + NET_VENDOR_EZCHIP = no; + NET_VENDOR_GOOGLE = no; + NET_VENDOR_HUAWEI = no; + NET_VENDOR_INTEL = no; + NET_VENDOR_MARVELL = no; + NET_VENDOR_MELLANOX = no; + NET_VENDOR_MICREL = no; + NET_VENDOR_MICROCHIP = no; + NET_VENDOR_MICROSEMI = no; + NET_VENDOR_NATSEMI = no; + NET_VENDOR_NETRONOME = no; + NET_VENDOR_NI = no; + NET_VENDOR_PENSANDO = no; + NET_VENDOR_QUALCOMM = no; + NET_VENDOR_RENESAS = no; + NET_VENDOR_ROCKER = no; + NET_VENDOR_SAMSUNG = no; + NET_VENDOR_SEEQ = no; + NET_VENDOR_SOCIONEXT = no; + NET_VENDOR_SOLARFLARE = no; + NET_VENDOR_STMICRO = no; + NET_VENDOR_SYNOPSYS = no; + NET_VENDOR_VIA = no; + NET_VENDOR_WIZNET = no; + NET_VENDOR_XILINX = no; + NFC = no; + NULL_TTY = no; + NVME_FC = no; + NVME_TARGET = no; + N_GSM = no; + PARPORT = no; + PCCARD = no; + PHY_PXA_28NM_HSIC = no; + PHY_PXA_28NM_USB2 = no; + PMBUS = no; + PM_DEBUG = no; + QSEMI_PHY = no; + RAVE_SP_EEPROM = no; + RC_CORE = no; + RD_BZIP2 = no; + RD_LZ4 = no; + RD_LZMA = no; + RD_LZO = no; + RD_XZ = no; + RENESAS_PHY = no; + RESET_CONTROLLER = no; + RFKILL = no; + RMI4_I2C = no; + RMI4_SMB = no; + ROCKCHIP_PHY = no; + RTC_DRV_88PM80X = no; + RTC_DRV_ABB5ZES3 = no; + RTC_DRV_ABEOZ9 = no; + RTC_DRV_ABX80X = no; + RTC_DRV_BQ32K = no; + RTC_DRV_BQ4802 = no; + RTC_DRV_CMOS = no; + RTC_DRV_DA9063 = no; + RTC_DRV_DS1286 = no; + RTC_DRV_DS1307 = no; + RTC_DRV_DS1374 = no; + RTC_DRV_DS1511 = no; + RTC_DRV_DS1553 = no; + RTC_DRV_DS1672 = no; + RTC_DRV_DS1685_FAMILY = no; + RTC_DRV_DS1742 = no; + RTC_DRV_DS2404 = no; + RTC_DRV_DS3232 = no; + RTC_DRV_EM3027 = no; + RTC_DRV_FM3130 = no; + RTC_DRV_FTRTC010 = no; + RTC_DRV_ISL12022 = no; + RTC_DRV_ISL1208 = no; + RTC_DRV_M41T80 = no; + RTC_DRV_M48T35 = no; + RTC_DRV_M48T59 = no; + RTC_DRV_M48T86 = no; + RTC_DRV_MAX6900 = no; + RTC_DRV_MAX8907 = no; + RTC_DRV_MC13XXX = no; + RTC_DRV_MSM6242 = no; + RTC_DRV_MT6397 = no; + RTC_DRV_PCF2127 = no; + RTC_DRV_PCF50633 = no; + RTC_DRV_PCF85063 = no; + RTC_DRV_PCF8523 = no; + RTC_DRV_PCF85363 = no; + RTC_DRV_PCF8563 = no; + RTC_DRV_PCF8583 = no; + RTC_DRV_RP5C01 = no; + RTC_DRV_RS5C372 = no; + RTC_DRV_RV3028 = no; + RTC_DRV_RV3029C2 = no; + RTC_DRV_RV8803 = no; + RTC_DRV_RX8010 = no; + RTC_DRV_RX8025 = no; + RTC_DRV_RX8581 = no; + RTC_DRV_S35390A = no; + RTC_DRV_SD3078 = no; + RTC_DRV_STK17TA8 = no; + RTC_DRV_V3020 = no; + RTC_DRV_X1205 = no; + SENSORS_ABITUGURU = no; + SENSORS_ABITUGURU3 = no; + SENSORS_AD7414 = no; + SENSORS_AD7418 = no; + SENSORS_ADC128D818 = no; + SENSORS_ADM1021 = no; + SENSORS_ADM1025 = no; + SENSORS_ADM1026 = no; + SENSORS_ADM1029 = no; + SENSORS_ADM1031 = no; + SENSORS_ADM9240 = no; + SENSORS_ADS7828 = no; + SENSORS_ADT7410 = no; + SENSORS_ADT7411 = no; + SENSORS_ADT7462 = no; + SENSORS_ADT7470 = no; + SENSORS_ADT7475 = no; + SENSORS_AMC6821 = no; + SENSORS_APDS990X = no; + SENSORS_APPLESMC = no; + SENSORS_AS370 = no; + SENSORS_ASB100 = no; + SENSORS_ASC7621 = no; + SENSORS_ASPEED = no; + SENSORS_ATXP1 = no; + SENSORS_BH1770 = no; + SENSORS_CORETEMP = no; + SENSORS_DME1737 = no; + SENSORS_DS1621 = no; + SENSORS_DS620 = no; + SENSORS_EMC1403 = no; + SENSORS_EMC2103 = no; + SENSORS_EMC6W201 = no; + SENSORS_F71805F = no; + SENSORS_F71882FG = no; + SENSORS_F75375S = no; + SENSORS_FSCHMD = no; + SENSORS_G760A = no; + SENSORS_G762 = no; + SENSORS_GL518SM = no; + SENSORS_GL520SM = no; + SENSORS_HIH6130 = no; + SENSORS_INA209 = no; + SENSORS_INA2XX = no; + SENSORS_INA3221 = no; + SENSORS_IT87 = no; + SENSORS_JC42 = no; + SENSORS_LINEAGE = no; + SENSORS_LIS3_I2C = no; + SENSORS_LIS3_SPI = module; + SENSORS_LM63 = no; + SENSORS_LM73 = no; + SENSORS_LM75 = no; + SENSORS_LM77 = no; + SENSORS_LM78 = no; + SENSORS_LM80 = no; + SENSORS_LM83 = no; + SENSORS_LM85 = no; + SENSORS_LM87 = no; + SENSORS_LM90 = no; + SENSORS_LM92 = no; + SENSORS_LM93 = no; + SENSORS_LM95234 = no; + SENSORS_LM95241 = no; + SENSORS_LM95245 = no; + SENSORS_LTC2945 = no; + SENSORS_LTC2990 = no; + SENSORS_LTC4151 = no; + SENSORS_LTC4215 = no; + SENSORS_LTC4222 = no; + SENSORS_LTC4245 = no; + SENSORS_LTC4260 = no; + SENSORS_LTC4261 = no; + SENSORS_MAX16065 = no; + SENSORS_MAX1619 = no; + SENSORS_MAX1668 = no; + SENSORS_MAX197 = no; + SENSORS_MAX31790 = no; + SENSORS_MAX6621 = no; + SENSORS_MAX6639 = no; + SENSORS_MAX6642 = no; + SENSORS_MAX6650 = no; + SENSORS_MAX6697 = no; + SENSORS_MC13783_ADC = no; + SENSORS_MCP3021 = no; + SENSORS_MENF21BMC_HWMON = no; + SENSORS_NCT6683 = no; + SENSORS_NCT6775 = no; + SENSORS_NCT7802 = no; + SENSORS_NCT7904 = no; + SENSORS_NPCM7XX = no; + SENSORS_NTC_THERMISTOR = no; + SENSORS_PC87360 = no; + SENSORS_PC87427 = no; + SENSORS_PCF8591 = no; + SENSORS_POWR1220 = no; + SENSORS_SHT15 = no; + SENSORS_SHT21 = no; + SENSORS_SHT3x = no; + SENSORS_SHTC1 = no; + SENSORS_SMM665 = no; + SENSORS_SMSC47B397 = no; + SENSORS_SMSC47M1 = no; + SENSORS_SMSC47M192 = no; + SENSORS_STTS751 = no; + SENSORS_TC654 = no; + SENSORS_TC74 = no; + SENSORS_THMC50 = no; + SENSORS_TMP102 = no; + SENSORS_TMP103 = no; + SENSORS_TMP108 = no; + SENSORS_TMP401 = no; + SENSORS_TMP421 = no; + SENSORS_TSL2550 = no; + SENSORS_VIA_CPUTEMP = no; + SENSORS_VT1211 = no; + SENSORS_W83627EHF = no; + SENSORS_W83627HF = no; + SENSORS_W83773G = no; + SENSORS_W83781D = no; + SENSORS_W83791D = no; + SENSORS_W83792D = no; + SENSORS_W83793 = no; + SENSORS_W83795 = no; + SENSORS_W83L785TS = no; + SENSORS_W83L786NG = no; + SERIAL_NONSTANDARD = no; + SFP = no; + SIOX = no; + SLIMBUS = no; + SLIP = no; + SND_HDA_INTEL_DETECT_DMIC = no; + SND_SOC = no; + SND_X86 = no; + SND_XEN_FRONTEND = no; + SPI_MEM = no; + SPMI = no; + STE10XP = no; + STM = no; + TARGET_CORE = no; + TCG_ATMEL = no; + TCG_NSC = no; + TCG_TIS_ST33ZP24_I2C = no; + TCG_VTPM_PROXY = no; + TCG_XEN = no; + TELCLOCK = no; + TERANETICS_PHY = no; + THERMAL = no; + THUNDERBOLT = no; + TRACE_SINK = no; + UIO_PRUSS = no; + USB_SUPPORT = no; + UWB = no; + VIRTUALIZATION = no; + VITESSE_PHY = no; + WATCHDOG = no; + WIMAX = no; + WIRELESS = no; + WLAN = no; + X86_EXTENDED_PLATFORM = no; + X86_INTEL_MEMORY_PROTECTION_KEYS = no; + X86_PLATFORM_DEVICES = no; + XEN_BACKEND = no; + XEN_BLKDEV_FRONTEND = no; + XEN_NETDEV_FRONTEND = no; + XEN_XENBUS_FRONTEND = module; + XILINX_GMII2RGMII = no; + XILINX_SDFEC = no; }; } -- So here is a first draft for a more minimal kernel. It brings down the kernel build time from around 40 minutes to around 10 minutes on my machine (while watching videos on the side, so ymmv). What I did was taking the kernel .config from a running spectrum vm and worked with menuconfig and diffconfig from the kernel source tree. I tried to remove as much support for physical devices as possible, on top of that I removed support for virtual hosting and virtual guest for everything that isn't kvm/virtio. I tested the kernel by booting it up succesfully and confirming that video acceleration still works. I'm not satisfied with the missing documentation right now, but I'm not sure how to practically improve on that, the sheer number of needed changes seems to make that pretty hard, so I'd be happy for any suggestions. Cheers, Philipp

1 0

This (and Last) Week in Spectrum, 2020-W34 & 2020-W35
by Alyssa Ross 26 Aug '20

26 Aug '20

Last week I wasn't feeling well, so there was no This Week in Spectrum. crosvm ------ Where we left off, I had been attempting to port vhost-user-net support from cloud-hypervisor to crosvm. I'd been trying to port the first incarnation of the code in cloud-hypervisor to the contemporary version of crosvm from when it was added, thinking that that would be easier because the two codebases together. But I ran into the problem that this earliest incarnation of the vhost-user-net code from cloud-hypervisor didn't actually work (at least with the backend I was attempting to test it with). I'd been attempting to figure out exactly which changes were required to make it work, but hadn't been successful with that yet, and I thought I'd probably need to start the port over, from the latest cloud-hypervisor and crosvm code. The next day, I decided to give my previous strategy one more try, though, and an hour or two later, I found the required cloud-hypervisor change, applied it to crosvm, and it worked! So I now have a crosvm tree capable of vhost-user-net[1]. This means that it's looking good for my plans for inter-guest networking, and network hardware isolation. With that in place, I decided to start thinking about other kinds of hardware isolation and inter-VM communication, and that's what I did for most of the last two weeks. Let's go through them: Files will be shared between VMs using virtio-fs. This has the unique feature of (soon) being able to bypass guest page caches, and have only a single shared cache between VMs. This brings a performance improvement, but as I understand it, should also reduce memory consumption because each VM won't have to maintain its own copy of a disk-backed page. Of course, this feature (DAX) is also a big side channel, so it won't be appropriate for all use cases. But I think for some things people want to do with Spectrum, this will be very important. The problem with this is that, because it uses the page cache of the host kernel, the host has to know about the filesystem that's being shared -- there's no running virtiofsd in a VM if we want DAX. But I'd really like it if a (non-boot) block device could be used as a filesystem without the host having to actually talk to the device. I was stuck here, but edef pointed out to me that we could use the kernel's 9P support to attach the block device to a VM, and then mounting the filesystem in the host over 9P, either over a network connection or (ideally) vsock. It looks like the kernel should be able to handle 9P over vsock, but I haven't tested yet. We can use existing virtiofsd and 9P software (there are promising Rust implementations of each), and harden them against potential vulnerabilites like directory traversals using kernel features like RESOLVE_BENEATH and RESOLVE_NO_XDEV. For the boot device, maybe there's no reason not to just mount it using the host kernel, or maybe there's something to be gained by just reading a small bootstrap payload into memory from the start of the disk once, and then making all future communication go via a VM. I'm not really sure yet. But the important thing is we'll have mechanisms for all this in place. Maybe we'll decide that non-boot devices should just go over inter-VM 9P, but in any case, we'll still need all these pieces. GPU isolation should be possible by forwarding the GPU to a VM, but there are a few problems here. The first is that it would mean rendered surfaces have to be copied via shared memory to the VM with the GPU, before being sent to the GPU. Additionally, sharing the GPU between VMs for rendering at all would require significantly more work. The result of this is that graphics performance using an isolated GPU will probably be poor, at least for now. The final problem is that passthrough of integrated GPUs seems to be very difficult to get right. I will probably need to acquire some hardware that I've sene a report of this working on, so I can figure out what I've been doing wrong on the two computers I've tried it on so far. I suspect that I will get GPU isolation working, but I'm not sure how reliable or performant it will be. For generic USB devices, I expect to be able to take an approach similar to Qubes[2], having a VM to handle interactions with the hardware USB controller, and exposing individual USB devices over USB/IP to other VMs. It would be nice if I could use vsock for this too. [1]: https://spectrum-os.org/git/crosvm/?h=vhost-user-net [2]: https://www.qubes-os.org/doc/usb-devices/ spectrum-os.org --------------- Philipp registered a Matrix room and bridged it to the #spectrum IRC channel. I'm told that this should make it easier for Matrix users to join the room, since some bug in Matrix's IRC bridge prevents people from joining from Matrix the usual way. Philipp also sent a patch[3] to improve the instructions for Matrix users joining the channel on the website. Thanks Philipp! [3]: https://spectrum-os.org/lists/archives/spectrum-devel/87wo247zu7.fsf@alyssa… QEMU ---- I sent the previously requested patch[4] to resolve ambiguities in the vhost-user spec. No response yet, though. I'll probably resend it some time soon. [4]: https://lore.kernel.org/qemu-devel/20200813094847.4288-1-hi@alyssa.is/ I'm finding it hard to keep going at the moment. The stuff I'm doing now is probably the hardest part of implementing Spectrum, and it's frustrating to realise that not everything I want to do is going to be possible. So much of the KVM ecosystem assumes that things will be host<->guest, and there's not always an easy solution. But, whatever we end up with, it's going to be a lot better than what I'm using today, and what lots of other people are using today. I think I'm going to be able to deliver a good experience with a fairly high degree of protection against malicious hardware. But it's not going to be perfect. I'm pushing quite hard to make it over the line with my hardware isolation funding milestone. I'm so close, and I'm about to need the money. But once I've hit that, I think I'm going to need a break. This stuff is gruelling.

2 1

[PATCH nixpkgs] spectrumPackages.rootfs: add /sys
by Alyssa Ross 25 Aug '20

25 Aug '20

Programs assume this and it's useful to have. --- pkgs/os-specific/linux/spectrum/rootfs/generic.nix | 2 +- pkgs/os-specific/linux/spectrum/rootfs/stage1.nix | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix index 778b18dafa0..0a99f99bd5b 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/generic.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/generic.nix @@ -31,7 +31,7 @@ let mkdir $out cd $out - mkdir bin sbin dev proc run tmp + mkdir bin sbin dev proc run sys tmp ln -s ${dash}/bin/dash bin/sh ln -s ${makeStage1 { inherit run; }} sbin/init cp -r ${./etc} etc diff --git a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix index 75cfed56e7f..be7853316e9 100644 --- a/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix +++ b/pkgs/os-specific/linux/spectrum/rootfs/stage1.nix @@ -27,6 +27,7 @@ writeScript "init-stage1" '' if { s6-mount -t devpts -o gid=4,mode=620 none /dev/pts } if { s6-mount -t tmpfs none /dev/shm } if { s6-mount -t proc none /proc } + if { s6-mount -t sysfs none /sys } if { s6-ln -s ${mesa.drivers} /run/opengl-driver } export HOME / -- 2.27.0

1 0

Improving kernel build time
by Philipp Steinpaß 25 Aug '20

25 Aug '20

Hi! I read that development ist struggeling with long kernel build times right now and as a former gentoo kid, I feel somewhat qualified to help with that. I had a look at the current way, nixos is building the kernel and I think it's somewhat over engineered for spectrums needs right now, so I propose to do the following: * Exctract the current generic kernel .config from nixos * make menuconfig with that on a generic linux kernel of the version currently used in spectrum and remove as many modules as I can * Circumvent the current nixos kernel configuration pretty much entirely and supply the kernel .config by adding it directly to the git repository for faster iteration When a more elaborate kernel configuration scheme is needed again in the future, the nixos one is still there and can be properly ported to spectrums needs but right now I feel like it would only slow the process down. However I don't have much experience with the code, so when I get told here that it's probably better to keep closer to nixpkgs, I'll give my best with that, too. Philipp

1 0

[PATCH] Add and clarify matrix workarounds.
by Philipp 21 Aug '20

21 Aug '20

I'm a matrix user and fiddled around with the room there a bit. My findings were that the room itself seems to be fine, but the pretty alias is broken in some way that I don't understand. I came up with two ways to join the room via the internal ID and I also took the liberty to modify the old workaround a little and made it more precise. --- participating.html | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/participating.html b/participating.html index 811fcf4..58f2ff3 100644 --- a/participating.html +++ b/participating.html @@ -78,13 +78,15 @@ the web. <h3>Note for Matrix users</h3> <p> -There appears to be an issue with Matrix's IRC bridge that prevents -Matrix users from joining #spectrum. The workaround is as follows: +There appears to be an issue with Matrix's IRC bridged room that prevents +Matrix users from joining the channel with the normal alias <q>#freenode_#spectrum:matrix.org</q>. There are the following workarounds: + +<ul> + <li>Join the room via it's internal name: <q>/join !ZsIiqZmCTSWHpTQWaw:matrix.org</q>. + <li>Join the room via <a href="https://matrix.to/#/!ZsIiqZmCTSWHpTQWaw:matrix.org">matrix.to link</a>.</li> + <li>Ask the bridges appservice to invite you to the room: <q>/msg @appservice-irc:matrix.org !join #spectrum</q> and accept the invite.</li> +</ul> -<ol> - <li>Post <q>!join #spectrum</q> in your "Freenode IRC Bridge" chat.</li> - <li>Accept the invitation you are sent.</li> -</ol> <p> If you experience this issue, kindly report it to the people who run -- 2.28.0

3 5

[PATCH www] CONTRIBUTING: ask people to add copyright headers
by Alyssa Ross 12 Aug '20

12 Aug '20

I want to make sure we're collecting copyright information right from the start, because it's much easier to keep track of this as content is created, rather than try to piece it together after the fact should we ever need to. --- CONTRIBUTING | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING b/CONTRIBUTING index b2941cf..6cbc106 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -17,6 +17,14 @@ 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. + Please send patches to devel(a)spectrum-os.org. Instructions for how to do this are provided in the contributing.html file. -- 2.27.0

2 2

[PATCH www] Become REUSE 3.0 compliant
by Alyssa Ross 11 Aug '20

11 Aug '20

See <https://reuse.software/>. NLnet are quite keen on this. --- CONTRIBUTING | 3 + LICENSES/CC-BY-SA-4.0.txt | 350 ++++++++++++++++++ LICENSES/CC0-1.0.txt | 119 +++++++ LICENSES/GFDL-1.3-or-later.txt | 416 ++++++++++++++++++++++ LICENSES/GPL-3.0-or-later.txt | 625 +++++++++++++++++++++++++++++++++ README | 7 +- bibliography.html | 3 + contributing.html | 3 + design.html | 3 + doc/index.html | 3 + index.html | 3 + motivation.html | 3 + participating.html | 3 + style.css | 3 + todo.html | 3 + 15 files changed, 1543 insertions(+), 4 deletions(-) create mode 100644 LICENSES/CC-BY-SA-4.0.txt create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/GFDL-1.3-or-later.txt create mode 100644 LICENSES/GPL-3.0-or-later.txt diff --git a/CONTRIBUTING b/CONTRIBUTING index 7ec8fba..b2941cf 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,3 +1,6 @@ +SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> +SPDX-License-Identifier: CC0-1.0 + ---------------------------------------------------------------------- This file provides instructions for contributing to the website hosted at <https://spectrum-os.org/>. If you would like to contribute to the diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt new file mode 100644 index 0000000..f50cdd3 --- /dev/null +++ b/LICENSES/CC-BY-SA-4.0.txt @@ -0,0 +1,350 @@ +Creative Commons Attribution-ShareAlike 4.0 International Creative Commons +Corporation ("Creative Commons") is not a law firm and does not provide legal +services or legal advice. Distribution of Creative Commons public licenses +does not create a lawyer-client or other relationship. Creative Commons makes +its licenses and related information available on an "as-is" basis. Creative +Commons gives no warranties regarding its licenses, any material licensed +under their terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the fullest +extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. + +Although not required by our licenses, you are encouraged to respect those +requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees + +Creative Commons Attribution-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, +approved by Creative Commons as essentially the equivalent of this Public +License. + +d. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +e. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +f. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +g. License Elements means the license attributes listed in the name of a Creative +Commons Public License. The License Elements of this Public License are Attribution +and ShareAlike. + +h. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +i. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +j. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +k. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +l. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +m. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. Additional offer from the Licensor – Adapted Material. Every recipient +of Adapted Material from You automatically receives an offer from the Licensor +to exercise the Licensed Rights in the Adapted Material under the conditions +of the Adapter's License You apply. + +C. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +b. ShareAlike.In addition to the conditions in Section 3(a), if You Share +Adapted Material You produce, the following conditions also apply. + +1. The Adapter's License You apply must be a Creative Commons license with +the same License Elements, this version or later, or a BY-SA Compatible License. + +2. You must include the text of, or the URI or hyperlink to, the Adapter's +License You apply. You may satisfy this condition in any reasonable manner +based on the medium, means, and context in which You Share Adapted Material. + +3. You may not offer or impose any additional or different terms or conditions +on, or apply any Effective Technological Measures to, Adapted Material that +restrict exercise of the rights granted under the Adapter's License You apply. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material, including for purposes of Section 3(b); and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..a343ccd --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,119 @@ +Creative Commons Legal Code + +CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES +NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE +AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION +ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE +OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS +LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION +OR WORKS PROVIDED HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer exclusive +Copyright and Related Rights (defined below) upon the creator and subsequent +owner(s) (each and all, an "owner") of an original work of authorship and/or +a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later claims +of infringement build upon, modify, incorporate in other works, reuse and +redistribute as freely as possible in any form whatsoever and for any purposes, +including without limitation commercial purposes. These owners may contribute +to the Commons to promote the ideal of a free culture and the further production +of creative, cultural and scientific works, or to gain reputation or greater +distribution for their Work in part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with +a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or +her Copyright and Related Rights in the Work and the meaning and intended +legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be protected +by copyright and related or neighboring rights ("Copyright and Related Rights"). +Copyright and Related Rights include, but are not limited to, the following: + +i. the right to reproduce, adapt, distribute, perform, display, communicate, +and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + +iii. publicity and privacy rights pertaining to a person's image or likeness +depicted in a Work; + +iv. rights protecting against unfair competition in regards to a Work, subject +to the limitations in paragraph 4(a), below; + +v. rights protecting the extraction, dissemination, use and reuse of data +in a Work; + +vi. database rights (such as those arising under Directive 96/9/EC of the +European Parliament and of the Council of 11 March 1996 on the legal protection +of databases, and under any national implementation thereof, including any +amended or successor version of such directive); and + +vii. other similar, equivalent or corresponding rights throughout the world +based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time extensions), +(iii) in any current or future medium and for any number of copies, and (iv) +for any purpose whatsoever, including without limitation commercial, advertising +or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the +benefit of each member of the public at large and to the detriment of Affirmer's +heirs and successors, fully intending that such Waiver shall not be subject +to revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account Affirmer's +express Statement of Purpose. In addition, to the extent the Waiver is so +judged Affirmer hereby grants to each affected person a royalty-free, non +transferable, non sublicensable, non exclusive, irrevocable and unconditional +license to exercise Affirmer's Copyright and Related Rights in the Work (i) +in all territories worldwide, (ii) for the maximum duration provided by applicable +law or treaty (including future time extensions), (iii) in any current or +future medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional purposes +(the "License"). The License shall be deemed effective as of the date CC0 +was applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder of +the License, and in such case Affirmer hereby affirms that he or she will +not (i) exercise any of his or her remaining Copyright and Related Rights +in the Work or (ii) assert any associated claims and causes of action with +respect to the Work, in either case contrary to Affirmer's express Statement +of Purpose. + + 4. Limitations and Disclaimers. + +a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, +licensed or otherwise affected by this document. + +b. Affirmer offers the Work as-is and makes no representations or warranties +of any kind concerning the Work, express, implied, statutory or otherwise, +including without limitation warranties of title, merchantability, fitness +for a particular purpose, non infringement, or the absence of latent or other +defects, accuracy, or the present or absence of errors, whether or not discoverable, +all to the greatest extent permissible under applicable law. + +c. Affirmer disclaims responsibility for clearing rights of other persons +that may apply to the Work or any use thereof, including without limitation +any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims +responsibility for obtaining any necessary consents, permissions or other +rights required for any use of the Work. + +d. Affirmer understands and acknowledges that Creative Commons is not a party +to this document and has no duty or obligation with respect to this CC0 or +use of the Work. diff --git a/LICENSES/GFDL-1.3-or-later.txt b/LICENSES/GFDL-1.3-or-later.txt new file mode 100644 index 0000000..90f814d --- /dev/null +++ b/LICENSES/GFDL-1.3-or-later.txt @@ -0,0 +1,416 @@ +GNU Free Documentation License + +Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free +Software Foundation, Inc. <http://fsf.org/> + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + + 0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other functional +and useful document "free" in the sense of freedom: to assure everyone the +effective freedom to copy and redistribute it, with or without modifying it, +either commercially or noncommercially. Secondarily, this License preserves +for the author and publisher a way to get credit for their work, while not +being considered responsible for modifications made by others. + +This License is a kind of "copyleft", which means that derivative works of +the document must themselves be free in the same sense. It complements the +GNU General Public License, which is a copyleft license designed for free +software. + +We have designed this License in order to use it for manuals for free software, +because free software needs free documentation: a free program should come +with manuals providing the same freedoms that the software does. But this +License is not limited to software manuals; it can be used for any textual +work, regardless of subject matter or whether it is published as a printed +book. We recommend this License principally for works whose purpose is instruction +or reference. + + 1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that contains +a notice placed by the copyright holder saying it can be distributed under +the terms of this License. Such a notice grants a world-wide, royalty-free +license, unlimited in duration, to use that work under the conditions stated +herein. The "Document", below, refers to any such manual or work. Any member +of the public is a licensee, and is addressed as "you". You accept the license +if you copy, modify or distribute the work in a way requiring permission under +copyright law. + +A "Modified Version" of the Document means any work containing the Document +or a portion of it, either copied verbatim, or with modifications and/or translated +into another language. + +A "Secondary Section" is a named appendix or a front-matter section of the +Document that deals exclusively with the relationship of the publishers or +authors of the Document to the Document's overall subject (or to related matters) +and contains nothing that could fall directly within that overall subject. +(Thus, if the Document is in part a textbook of mathematics, a Secondary Section +may not explain any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, commercial, +philosophical, ethical or political position regarding them. + +The "Invariant Sections" are certain Secondary Sections whose titles are designated, +as being those of Invariant Sections, in the notice that says that the Document +is released under this License. If a section does not fit the above definition +of Secondary then it is not allowed to be designated as Invariant. The Document +may contain zero Invariant Sections. If the Document does not identify any +Invariant Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, as Front-Cover +Texts or Back-Cover Texts, in the notice that says that the Document is released +under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover +Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, represented +in a format whose specification is available to the general public, that is +suitable for revising the document straightforwardly with generic text editors +or (for images composed of pixels) generic paint programs or (for drawings) +some widely available drawing editor, and that is suitable for input to text +formatters or for automatic translation to a variety of formats suitable for +input to text formatters. A copy made in an otherwise Transparent file format +whose markup, or absence of markup, has been arranged to thwart or discourage +subsequent modification by readers is not Transparent. An image format is +not Transparent if used for any substantial amount of text. A copy that is +not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain ASCII without +markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly +available DTD, and standard-conforming simple HTML, PostScript or PDF designed +for human modification. Examples of transparent image formats include PNG, +XCF and JPG. Opaque formats include proprietary formats that can be read and +edited only by proprietary word processors, SGML or XML for which the DTD +and/or processing tools are not generally available, and the machine-generated +HTML, PostScript or PDF produced by some word processors for output purposes +only. + +The "Title Page" means, for a printed book, the title page itself, plus such +following pages as are needed to hold, legibly, the material this License +requires to appear in the title page. For works in formats which do not have +any title page as such, "Title Page" means the text near the most prominent +appearance of the work's title, preceding the beginning of the body of the +text. + +The "publisher" means any person or entity that distributes copies of the +Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose title +either is precisely XYZ or contains XYZ in parentheses following text that +translates XYZ in another language. (Here XYZ stands for a specific section +name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", +or "History".) To "Preserve the Title" of such a section when you modify the +Document means that it remains a section "Entitled XYZ" according to this +definition. + +The Document may include Warranty Disclaimers next to the notice which states +that this License applies to the Document. These Warranty Disclaimers are +considered to be included by reference in this License, but only as regards +disclaiming warranties: any other implication that these Warranty Disclaimers +may have is void and has no effect on the meaning of this License. + + 2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either commercially +or noncommercially, provided that this License, the copyright notices, and +the license notice saying this License applies to the Document are reproduced +in all copies, and that you add no other conditions whatsoever to those of +this License. You may not use technical measures to obstruct or control the +reading or further copying of the copies you make or distribute. However, +you may accept compensation in exchange for copies. If you distribute a large +enough number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and you +may publicly display copies. + + 3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have printed +covers) of the Document, numbering more than 100, and the Document's license +notice requires Cover Texts, you must enclose the copies in covers that carry, +clearly and legibly, all these Cover Texts: Front-Cover Texts on the front +cover, and Back-Cover Texts on the back cover. Both covers must also clearly +and legibly identify you as the publisher of these copies. The front cover +must present the full title with all words of the title equally prominent +and visible. You may add other material on the covers in addition. Copying +with changes limited to the covers, as long as they preserve the title of +the Document and satisfy these conditions, can be treated as verbatim copying +in other respects. + +If the required texts for either cover are too voluminous to fit legibly, +you should put the first ones listed (as many as fit reasonably) on the actual +cover, and continue the rest onto adjacent pages. + +If you publish or distribute Opaque copies of the Document numbering more +than 100, you must either include a machine-readable Transparent copy along +with each Opaque copy, or state in or with each Opaque copy a computer-network +location from which the general network-using public has access to download +using public-standard network protocols a complete Transparent copy of the +Document, free of added material. If you use the latter option, you must take +reasonably prudent steps, when you begin distribution of Opaque copies in +quantity, to ensure that this Transparent copy will remain thus accessible +at the stated location until at least one year after the last time you distribute +an Opaque copy (directly or through your agents or retailers) of that edition +to the public. + +It is requested, but not required, that you contact the authors of the Document +well before redistributing any large number of copies, to give them a chance +to provide you with an updated version of the Document. + + 4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under the conditions +of sections 2 and 3 above, provided that you release the Modified Version +under precisely this License, with the Modified Version filling the role of +the Document, thus licensing distribution and modification of the Modified +Version to whoever possesses a copy of it. In addition, you must do these +things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct from +that of the Document, and from those of previous versions (which should, if +there were any, be listed in the History section of the Document). You may +use the same title as a previous version if the original publisher of that +version gives permission. + +B. List on the Title Page, as authors, one or more persons or entities responsible +for authorship of the modifications in the Modified Version, together with +at least five of the principal authors of the Document (all of its principal +authors, if it has fewer than five), unless they release you from this requirement. + +C. State on the Title page the name of the publisher of the Modified Version, +as the publisher. + + D. Preserve all the copyright notices of the Document. + +E. Add an appropriate copyright notice for your modifications adjacent to +the other copyright notices. + +F. Include, immediately after the copyright notices, a license notice giving +the public permission to use the Modified Version under the terms of this +License, in the form shown in the Addendum below. + +G. Preserve in that license notice the full lists of Invariant Sections and +required Cover Texts given in the Document's license notice. H. Include an +unaltered copy of this License. + +I. Preserve the section Entitled "History", Preserve its Title, and add to +it an item stating at least the title, year, new authors, and publisher of +the Modified Version as given on the Title Page. If there is no section Entitled +"History" in the Document, create one stating the title, year, authors, and +publisher of the Document as given on its Title Page, then add an item describing +the Modified Version as stated in the previous sentence. + +J. Preserve the network location, if any, given in the Document for public +access to a Transparent copy of the Document, and likewise the network locations +given in the Document for previous versions it was based on. These may be +placed in the "History" section. You may omit a network location for a work +that was published at least four years before the Document itself, or if the +original publisher of the version it refers to gives permission. + +K. For any section Entitled "Acknowledgements" or "Dedications", Preserve +the Title of the section, and preserve in the section all the substance and +tone of each of the contributor acknowledgements and/or dedications given +therein. + +L. Preserve all the Invariant Sections of the Document, unaltered in their +text and in their titles. Section numbers or the equivalent are not considered +part of the section titles. + +M. Delete any section Entitled "Endorsements". Such a section may not be included +in the Modified Version. + +N. Do not retitle any existing section to be Entitled "Endorsements" or to +conflict in title with any Invariant Section. + + O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or appendices that +qualify as Secondary Sections and contain no material copied from the Document, +you may at your option designate some or all of these sections as invariant. +To do this, add their titles to the list of Invariant Sections in the Modified +Version's license notice. These titles must be distinct from any other section +titles. + +You may add a section Entitled "Endorsements", provided it contains nothing +but endorsements of your Modified Version by various parties--for example, +statements of peer review or that the text has been approved by an organization +as the authoritative definition of a standard. + +You may add a passage of up to five words as a Front-Cover Text, and a passage +of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts +in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover +Text may be added by (or through arrangements made by) any one entity. If +the Document already includes a cover text for the same cover, previously +added by you or by arrangement made by the same entity you are acting on behalf +of, you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License give +permission to use their names for publicity for or to assert or imply endorsement +of any Modified Version. + + 5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this License, +under the terms defined in section 4 above for modified versions, provided +that you include in the combination all of the Invariant Sections of all of +the original documents, unmodified, and list them all as Invariant Sections +of your combined work in its license notice, and that you preserve all their +Warranty Disclaimers. + +The combined work need only contain one copy of this License, and multiple +identical Invariant Sections may be replaced with a single copy. If there +are multiple Invariant Sections with the same name but different contents, +make the title of each such section unique by adding at the end of it, in +parentheses, the name of the original author or publisher of that section +if known, or else a unique number. Make the same adjustment to the section +titles in the list of Invariant Sections in the license notice of the combined +work. + +In the combination, you must combine any sections Entitled "History" in the +various original documents, forming one section Entitled "History"; likewise +combine any sections Entitled "Acknowledgements", and any sections Entitled +"Dedications". You must delete all sections Entitled "Endorsements". + + 6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents released +under this License, and replace the individual copies of this License in the +various documents with a single copy that is included in the collection, provided +that you follow the rules of this License for verbatim copying of each of +the documents in all other respects. + +You may extract a single document from such a collection, and distribute it +individually under this License, provided you insert a copy of this License +into the extracted document, and follow this License in all other respects +regarding verbatim copying of that document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate and independent +documents or works, in or on a volume of a storage or distribution medium, +is called an "aggregate" if the copyright resulting from the compilation is +not used to limit the legal rights of the compilation's users beyond what +the individual works permit. When the Document is included in an aggregate, +this License does not apply to the other works in the aggregate which are +not themselves derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these copies of +the Document, then if the Document is less than one half of the entire aggregate, +the Document's Cover Texts may be placed on covers that bracket the Document +within the aggregate, or the electronic equivalent of covers if the Document +is in electronic form. Otherwise they must appear on printed covers that bracket +the whole aggregate. + + 8. TRANSLATION + +Translation is considered a kind of modification, so you may distribute translations +of the Document under the terms of section 4. Replacing Invariant Sections +with translations requires special permission from their copyright holders, +but you may include translations of some or all Invariant Sections in addition +to the original versions of these Invariant Sections. You may include a translation +of this License, and all the license notices in the Document, and any Warranty +Disclaimers, provided that you also include the original English version of +this License and the original versions of those notices and disclaimers. In +case of a disagreement between the translation and the original version of +this License or a notice or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", "Dedications", +or "History", the requirement (section 4) to Preserve its Title (section 1) +will typically require changing the actual title. + + 9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense, or distribute it is void, and will automatically terminate your +rights under this License. + +However, if you cease all violation of this License, then your license from +a particular copyright holder is reinstated (a) provisionally, unless and +until the copyright holder explicitly and finally terminates your license, +and (b) permanently, if the copyright holder fails to notify you of the violation +by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, +this is the first time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the violation prior +to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. +If your rights have been terminated and not permanently reinstated, receipt +of a copy of some or all of the same material does not give you any rights +to use it. + + 10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the GNU +Free Documentation License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. See http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. If the +Document specifies that a particular numbered version of this License "or +any later version" applies to it, you have the option of following the terms +and conditions either of that specified version or of any later version that +has been published (not as a draft) by the Free Software Foundation. If the +Document does not specify a version number of this License, you may choose +any version ever published (not as a draft) by the Free Software Foundation. +If the Document specifies that a proxy can decide which future versions of +this License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Document. + + 11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide +Web server that publishes copyrightable works and also provides prominent +facilities for anybody to edit those works. A public wiki that anybody can +edit is an example of such a server. A "Massive Multiauthor Collaboration" +(or "MMC") contained in the site means any set of copyrightable works thus +published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license +published by Creative Commons Corporation, a not-for-profit corporation with +a principal place of business in San Francisco, California, as well as future +copyleft versions of that license published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in part, +as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this License, +and if all works that were first published under this License somewhere other +than this MMC, and subsequently incorporated in whole or in part into the +MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated +prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site under +CC-BY-SA on the same site at any time before August 1, 2009, provided the +MMC is eligible for relicensing. ADDENDUM: How to use this License for your +documents + +To use this License in a document you have written, include a copy of the +License in the document and put the following copyright and license notices +just after the title page: + +Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or +modify this document under the terms of the GNU Free Documentation License, +Version 1.3 or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free Documentation +License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace +the "with...Texts." line with this: + +with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover +Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other combination +of the three, merge those two alternatives to suit the situation. + +If your document contains nontrivial examples of program code, we recommend +releasing these examples in parallel under your choice of free software license, +such as the GNU General Public License, to permit their use in free software. diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txt new file mode 100644 index 0000000..e142a52 --- /dev/null +++ b/LICENSES/GPL-3.0-or-later.txt @@ -0,0 +1,625 @@ +GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/> + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The GNU General Public License is a free, copyleft license for software and +other kinds of works. + +The licenses for most software and other practical works are designed to take +away your freedom to share and change the works. By contrast, the GNU General +Public License is intended to guarantee your freedom to share and change all +versions of a program--to make sure it remains free software for all its users. +We, the Free Software Foundation, use the GNU General Public License for most +of our software; it applies also to any other work released this way by its +authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for them if you wish), that +you receive source code or can get it if you want it, that you can change +the software or use pieces of it in new free programs, and that you know you +can do these things. + +To protect your rights, we need to prevent others from denying you these rights +or asking you to surrender the rights. Therefore, you have certain responsibilities +if you distribute copies of the software, or if you modify it: responsibilities +to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must pass on to the recipients the same freedoms that you received. +You must make sure that they, too, receive or can get the source code. And +you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert +copyright on the software, and (2) offer you this License giving you legal +permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that +there is no warranty for this free software. For both users' and authors' +sake, the GPL requires that modified versions be marked as changed, so that +their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified +versions of the software inside them, although the manufacturer can do so. +This is fundamentally incompatible with the aim of protecting users' freedom +to change the software. The systematic pattern of such abuse occurs in the +area of products for individuals to use, which is precisely where it is most +unacceptable. Therefore, we have designed this version of the GPL to prohibit +the practice for those products. If such problems arise substantially in other +domains, we stand ready to extend this provision to those domains in future +versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States +should not allow patents to restrict development and use of software on general-purpose +computers, but in those that do, we wish to avoid the special danger that +patents applied to a free program could make it effectively proprietary. To +prevent this, the GPL assures that patents cannot be used to render the program +non-free. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of works, +such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this License. +Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals +or organizations. + +To "modify" a work means to copy from or adapt all or part of the work in +a fashion requiring copyright permission, other than the making of an exact +copy. The resulting work is called a "modified version" of the earlier work +or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based on the +Program. + +To "propagate" a work means to do anything with it that, without permission, +would make you directly or secondarily liable for infringement under applicable +copyright law, except executing it on a computer or modifying a private copy. +Propagation includes copying, distribution (with or without modification), +making available to the public, and in some countries other activities as +well. + +To "convey" a work means any kind of propagation that enables other parties +to make or receive copies. Mere interaction with a user through a computer +network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" to the +extent that it includes a convenient and prominently visible feature that +(1) displays an appropriate copyright notice, and (2) tells the user that +there is no warranty for the work (except to the extent that warranties are +provided), that licensees may convey the work under this License, and how +to view a copy of this License. If the interface presents a list of user commands +or options, such as a menu, a prominent item in the list meets this criterion. + + 1. Source Code. + +The "source code" for a work means the preferred form of the work for making +modifications to it. "Object code" means any non-source form of a work. + +A "Standard Interface" means an interface that either is an official standard +defined by a recognized standards body, or, in the case of interfaces specified +for a particular programming language, one that is widely used among developers +working in that language. + +The "System Libraries" of an executable work include anything, other than +the work as a whole, that (a) is included in the normal form of packaging +a Major Component, but which is not part of that Major Component, and (b) +serves only to enable use of the work with that Major Component, or to implement +a Standard Interface for which an implementation is available to the public +in source code form. A "Major Component", in this context, means a major essential +component (kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to produce +the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all the source +code needed to generate, install, and (for an executable work) run the object +code and to modify the work, including scripts to control those activities. +However, it does not include the work's System Libraries, or general-purpose +tools or generally available free programs which are used unmodified in performing +those activities but which are not part of the work. For example, Corresponding +Source includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically linked +subprograms that the work is specifically designed to require, such as by +intimate data communication or control flow between those subprograms and +other parts of the work. + +The Corresponding Source need not include anything that users can regenerate +automatically from other parts of the Corresponding Source. + + The Corresponding Source for a work in source code form is that same work. + + 2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright +on the Program, and are irrevocable provided the stated conditions are met. +This License explicitly affirms your unlimited permission to run the unmodified +Program. The output from running a covered work is covered by this License +only if the output, given its content, constitutes a covered work. This License +acknowledges your rights of fair use or other equivalent, as provided by copyright +law. + +You may make, run and propagate covered works that you do not convey, without +conditions so long as your license otherwise remains in force. You may convey +covered works to others for the sole purpose of having them make modifications +exclusively for you, or provide you with facilities for running those works, +provided that you comply with the terms of this License in conveying all material +for which you do not control copyright. Those thus making or running the covered +works for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of your copyrighted +material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions +stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure +under any applicable law fulfilling obligations under article 11 of the WIPO +copyright treaty adopted on 20 December 1996, or similar laws prohibiting +or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention +of technological measures to the extent such circumvention is effected by +exercising rights under this License with respect to the covered work, and +you disclaim any intention to limit operation or modification of the work +as a means of enforcing, against the work's users, your or third parties' +legal rights to forbid circumvention of technological measures. + + 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive +it, in any medium, provided that you conspicuously and appropriately publish +on each copy an appropriate copyright notice; keep intact all notices stating +that this License and any non-permissive terms added in accord with section +7 apply to the code; keep intact all notices of the absence of any warranty; +and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you +may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce +it from the Program, in the form of source code under the terms of section +4, provided that you also meet all of these conditions: + +a) The work must carry prominent notices stating that you modified it, and +giving a relevant date. + +b) The work must carry prominent notices stating that it is released under +this License and any conditions added under section 7. This requirement modifies +the requirement in section 4 to "keep intact all notices". + +c) You must license the entire work, as a whole, under this License to anyone +who comes into possession of a copy. This License will therefore apply, along +with any applicable section 7 additional terms, to the whole of the work, +and all its parts, regardless of how they are packaged. This License gives +no permission to license the work in any other way, but it does not invalidate +such permission if you have separately received it. + +d) If the work has interactive user interfaces, each must display Appropriate +Legal Notices; however, if the Program has interactive interfaces that do +not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, +which are not by their nature extensions of the covered work, and which are +not combined with it such as to form a larger program, in or on a volume of +a storage or distribution medium, is called an "aggregate" if the compilation +and its resulting copyright are not used to limit the access or legal rights +of the compilation's users beyond what the individual works permit. Inclusion +of a covered work in an aggregate does not cause this License to apply to +the other parts of the aggregate. + + 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections +4 and 5, provided that you also convey the machine-readable Corresponding +Source under the terms of this License, in one of these ways: + +a) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by the Corresponding Source fixed +on a durable physical medium customarily used for software interchange. + +b) Convey the object code in, or embodied in, a physical product (including +a physical distribution medium), accompanied by a written offer, valid for +at least three years and valid for as long as you offer spare parts or customer +support for that product model, to give anyone who possesses the object code +either (1) a copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical medium customarily +used for software interchange, for a price no more than your reasonable cost +of physically performing this conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge. + +c) Convey individual copies of the object code with a copy of the written +offer to provide the Corresponding Source. This alternative is allowed only +occasionally and noncommercially, and only if you received the object code +with such an offer, in accord with subsection 6b. + +d) Convey the object code by offering access from a designated place (gratis +or for a charge), and offer equivalent access to the Corresponding Source +in the same way through the same place at no further charge. You need not +require recipients to copy the Corresponding Source along with the object +code. If the place to copy the object code is a network server, the Corresponding +Source may be on a different server (operated by you or a third party) that +supports equivalent copying facilities, provided you maintain clear directions +next to the object code saying where to find the Corresponding Source. Regardless +of what server hosts the Corresponding Source, you remain obligated to ensure +that it is available for as long as needed to satisfy these requirements. + +e) Convey the object code using peer-to-peer transmission, provided you inform +other peers where the object code and Corresponding Source of the work are +being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from +the Corresponding Source as a System Library, need not be included in conveying +the object code work. + +A "User Product" is either (1) a "consumer product", which means any tangible +personal property which is normally used for personal, family, or household +purposes, or (2) anything designed or sold for incorporation into a dwelling. +In determining whether a product is a consumer product, doubtful cases shall +be resolved in favor of coverage. For a particular product received by a particular +user, "normally used" refers to a typical or common use of that class of product, +regardless of the status of the particular user or of the way in which the +particular user actually uses, or expects or is expected to use, the product. +A product is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent the +only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, procedures, +authorization keys, or other information required to install and execute modified +versions of a covered work in that User Product from a modified version of +its Corresponding Source. The information must suffice to ensure that the +continued functioning of the modified object code is in no case prevented +or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically +for use in, a User Product, and the conveying occurs as part of a transaction +in which the right of possession and use of the User Product is transferred +to the recipient in perpetuity or for a fixed term (regardless of how the +transaction is characterized), the Corresponding Source conveyed under this +section must be accompanied by the Installation Information. But this requirement +does not apply if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has been installed +in ROM). + +The requirement to provide Installation Information does not include a requirement +to continue to provide support service, warranty, or updates for a work that +has been modified or installed by the recipient, or for the User Product in +which it has been modified or installed. Access to a network may be denied +when the modification itself materially and adversely affects the operation +of the network or violates the rules and protocols for communication across +the network. + +Corresponding Source conveyed, and Installation Information provided, in accord +with this section must be in a format that is publicly documented (and with +an implementation available to the public in source code form), and must require +no special password or key for unpacking, reading or copying. + + 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this License +by making exceptions from one or more of its conditions. Additional permissions +that are applicable to the entire Program shall be treated as though they +were included in this License, to the extent that they are valid under applicable +law. If additional permissions apply only to part of the Program, that part +may be used separately under those permissions, but the entire Program remains +governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any +additional permissions from that copy, or from any part of it. (Additional +permissions may be written to require their own removal in certain cases when +you modify the work.) You may place additional permissions on material, added +by you to a covered work, for which you have or can give appropriate copyright +permission. + +Notwithstanding any other provision of this License, for material you add +to a covered work, you may (if authorized by the copyright holders of that +material) supplement the terms of this License with terms: + +a) Disclaiming warranty or limiting liability differently from the terms of +sections 15 and 16 of this License; or + +b) Requiring preservation of specified reasonable legal notices or author +attributions in that material or in the Appropriate Legal Notices displayed +by works containing it; or + +c) Prohibiting misrepresentation of the origin of that material, or requiring +that modified versions of such material be marked in reasonable ways as different +from the original version; or + +d) Limiting the use for publicity purposes of names of licensors or authors +of the material; or + +e) Declining to grant rights under trademark law for use of some trade names, +trademarks, or service marks; or + +f) Requiring indemnification of licensors and authors of that material by +anyone who conveys the material (or modified versions of it) with contractual +assumptions of liability to the recipient, for any liability that these contractual +assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered "further restrictions" +within the meaning of section 10. If the Program as you received it, or any +part of it, contains a notice stating that it is governed by this License +along with a term that is a further restriction, you may remove that term. +If a license document contains a further restriction but permits relicensing +or conveying under this License, you may add to a covered work material governed +by the terms of that license document, provided that the further restriction +does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, +in the relevant source files, a statement of the additional terms that apply +to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form +of a separately written license, or stated as exceptions; the above requirements +apply either way. + + 8. Termination. + +You may not propagate or modify a covered work except as expressly provided +under this License. Any attempt otherwise to propagate or modify it is void, +and will automatically terminate your rights under this License (including +any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from +a particular copyright holder is reinstated (a) provisionally, unless and +until the copyright holder explicitly and finally terminates your license, +and (b) permanently, if the copyright holder fails to notify you of the violation +by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, +this is the first time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the violation prior +to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. +If your rights have been terminated and not permanently reinstated, you do +not qualify to receive new licenses for the same material under section 10. + + 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy +of the Program. Ancillary propagation of a covered work occurring solely as +a consequence of using peer-to-peer transmission to receive a copy likewise +does not require acceptance. However, nothing other than this License grants +you permission to propagate or modify any covered work. These actions infringe +copyright if you do not accept this License. Therefore, by modifying or propagating +a covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives +a license from the original licensors, to run, modify and propagate that work, +subject to this License. You are not responsible for enforcing compliance +by third parties with this License. + +An "entity transaction" is a transaction transferring control of an organization, +or substantially all assets of one, or subdividing an organization, or merging +organizations. If propagation of a covered work results from an entity transaction, +each party to that transaction who receives a copy of the work also receives +whatever licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the Corresponding +Source of the work from the predecessor in interest, if the predecessor has +it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights +granted or affirmed under this License. For example, you may not impose a +license fee, royalty, or other charge for exercise of rights granted under +this License, and you may not initiate litigation (including a cross-claim +or counterclaim in a lawsuit) alleging that any patent claim is infringed +by making, using, selling, offering for sale, or importing the Program or +any portion of it. + + 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this License +of the Program or a work on which the Program is based. The work thus licensed +is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned or controlled +by the contributor, whether already acquired or hereafter acquired, that would +be infringed by some manner, permitted by this License, of making, using, +or selling its contributor version, but do not include claims that would be +infringed only as a consequence of further modification of the contributor +version. For purposes of this definition, "control" includes the right to +grant patent sublicenses in a manner consistent with the requirements of this +License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent +license under the contributor's essential patent claims, to make, use, sell, +offer for sale, import and otherwise run, modify and propagate the contents +of its contributor version. + +In the following three paragraphs, a "patent license" is any express agreement +or commitment, however denominated, not to enforce a patent (such as an express +permission to practice a patent or covenant not to sue for patent infringement). +To "grant" such a patent license to a party means to make such an agreement +or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the +Corresponding Source of the work is not available for anyone to copy, free +of charge and under the terms of this License, through a publicly available +network server or other readily accessible means, then you must either (1) +cause the Corresponding Source to be so available, or (2) arrange to deprive +yourself of the benefit of the patent license for this particular work, or +(3) arrange, in a manner consistent with the requirements of this License, +to extend the patent license to downstream recipients. "Knowingly relying" +means you have actual knowledge that, but for the patent license, your conveying +the covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that country +that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, +you convey, or propagate by procuring conveyance of, a covered work, and grant +a patent license to some of the parties receiving the covered work authorizing +them to use, propagate, modify or convey a specific copy of the covered work, +then the patent license you grant is automatically extended to all recipients +of the covered work and works based on it. + +A patent license is "discriminatory" if it does not include within the scope +of its coverage, prohibits the exercise of, or is conditioned on the non-exercise +of one or more of the rights that are specifically granted under this License. +You may not convey a covered work if you are a party to an arrangement with +a third party that is in the business of distributing software, under which +you make payment to the third party based on the extent of your activity of +conveying the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by you +(or copies made from those copies), or (b) primarily for and in connection +with specific products or compilations that contain the covered work, unless +you entered into that arrangement, or that patent license was granted, prior +to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied +license or other defenses to infringement that may otherwise be available +to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or otherwise) +that contradict the conditions of this License, they do not excuse you from +the conditions of this License. If you cannot convey a covered work so as +to satisfy simultaneously your obligations under this License and any other +pertinent obligations, then as a consequence you may not convey it at all. +For example, if you agree to terms that obligate you to collect a royalty +for further conveying from those to whom you convey the Program, the only +way you could satisfy both those terms and this License would be to refrain +entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to +link or combine any covered work with a work licensed under version 3 of the +GNU Affero General Public License into a single combined work, and to convey +the resulting work. The terms of this License will continue to apply to the +part which is the covered work, but the special requirements of the GNU Affero +General Public License, section 13, concerning interaction through a network +will apply to the combination as such. + + 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the +GNU General Public License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies +that a certain numbered version of the GNU General Public License "or any +later version" applies to it, you have the option of following the terms and +conditions either of that numbered version or of any later version published +by the Free Software Foundation. If the Program does not specify a version +number of the GNU General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of +the GNU General Public License can be used, that proxy's public statement +of acceptance of a version permanently authorizes you to choose that version +for the Program. + +Later license versions may give you additional or different permissions. However, +no additional obligations are imposed on any author or copyright holder as +a result of your choosing to follow a later version. + + 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE +LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM +PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + + 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL +ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM +AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, +INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO +USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED +INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE +PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot +be given local legal effect according to their terms, reviewing courts shall +apply local law that most closely approximates an absolute waiver of all civil +liability in connection with the Program, unless a warranty or assumption +of liability accompanies a copy of the Program in return for a fee. END OF +TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively state the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + +<one line to give the program's name and a brief idea of what it does.> + +Copyright (C) <year> <name of author> + +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation, either version 3 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like +this when it starts in an interactive mode: + +<program> Copyright (C) <year> <name of author> + +This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + +This is free software, and you are welcome to redistribute it under certain +conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands might +be different; for a GUI interface, you would use an "about box". + +You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. For +more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. + +The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General Public +License instead of this License. But first, please read <https://www.gnu.org/ +licenses /why-not-lgpl.html>. diff --git a/README b/README index 156141b..359ada0 100644 --- a/README +++ b/README @@ -1,3 +1,6 @@ +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 seperately. @@ -10,7 +13,3 @@ 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). - -CC-BY-SA: <https://creativecommons.org/licenses/by-sa/4.0/> -GNU Free Documentation License: <https://www.gnu.org/licenses/gfdl.html> -GNU General Public License: <https://www.gnu.org/licenses/gpl-3.0.en.html> \ No newline at end of file diff --git a/bibliography.html b/bibliography.html index b2ccd0a..ff80215 100644 --- a/bibliography.html +++ b/bibliography.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/contributing.html b/contributing.html index 8999fee..25522fc 100644 --- a/contributing.html +++ b/contributing.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/design.html b/design.html index e725989..181c15c 100644 --- a/design.html +++ b/design.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/doc/index.html b/doc/index.html index c6acecc..a77d4ac 100644 --- a/doc/index.html +++ b/doc/index.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/index.html b/index.html index 08974b1..cbea331 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/motivation.html b/motivation.html index c7d5667..4076263 100644 --- a/motivation.html +++ b/motivation.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/participating.html b/participating.html index 2d9acab..811fcf4 100644 --- a/participating.html +++ b/participating.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> diff --git a/style.css b/style.css index b2b23c0..e9fd751 100644 --- a/style.css +++ b/style.css @@ -1,3 +1,6 @@ +/* SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> */ +/* SPDX-License-Identifier: GPL-3.0-or-later */ + /* Less is more. */ diff --git a/todo.html b/todo.html index 077f20a..d293664 100644 --- a/todo.html +++ b/todo.html @@ -1,4 +1,7 @@ <!doctype html> + + + <html lang="en"> <head> -- 2.27.0

2 2

This (Last) Week in Spectrum, 2020-W32
by Alyssa Ross 11 Aug '20

11 Aug '20

Last week, I'd just finished getting the cloud-hypervisor vhost-user-net frontend code to build as part of crosvm, and the next step was testing it. crosvm ------ I wrote some hacky code that replaced the virtio-net device creation in crosvm with an instance of the ported vhost-user-net code. When I booted crosvm, there were some of the expected simple oversights of mine that needed to be addressed, but once those were taken care of, it still didn't quite work. The VM boots, sees a network interface, and even communicates with the vhost-user-net backend! But, it doesn't quite work. The vhost-user-net code never realises/gets told that it has traffic, and so it's never processed. Unsure of what to do about this, I decided to turn to cloud-hypervisor and look at how the code ran there. cloud-hypervisor ---------------- I wanted to try running the cloud-hypervisor v-u-n backend I was using for testing (because it's much simpler than DPDK -- it just sends traffic to a TAP device) with QEMU as the frontend, because QEMU is a VMM I'm familiar with (much more so than cloud-hypervisor as the frontend), and I thought it would be useful to have a working frontend/backend combination to compare to. I had some problems, though, because apparently nobody had ever wanted to use QEMU with the cloud-hypervisor vhost-user-net backend before -- or if they had, they hadn't wanted to enough to make it work. The cloud-hypervisor backend didn't implement the vhost-user spec correctly in a few subtle ways that made it incompatible with QEMU. I won't explain every subtle issue, but I ended up writing a few patches[1][2] for cloud-hypervisor and the "vhost" crate it depends on (that is in the process of being moved under the rust-vmm umbrella). One interesting issue I will go into a little detail of was that the wording in the spec was a little unclear, and QEMU interpreted it one way, and cloud-hypervisor the other. I ended up sending an email[3] to the author of the spec asking for clarification. He answered my question, and we discussed how the wording could be improved. He liked my second attempt at improving my working, and asked me to send a patch, but preferably not right now, because QEMU is currently gearing up for a release, scheduled for next week if everything goes well. Since I wrote these cloud-hypervisor patches, and had to test them, I ended up having to learn how to use cloud-hypervisor anyway to make sure I hadn't broken it in fixing the backend up to work with QEMU. Oh well. Once this was done, I could use both QEMU and cloud-hypervisor with the backend, but not crosvm. But it was a little more complex than that. When I ported the v-u-n code to crosvm, I ported the first version of it that was added to the cloud-hypervisor tree, rather than the latest version. The theory here was that the earlier version would be closer to crosvm, because cloud-hypervisor would have had less time to diverge. Then, once I had that working, I could add on the later changes gradually. What I didn't account for here is that the initial version of the v-u-n frontend in cloud-hypervisor didn't really work properly, and needed some time to bake before it did. So having now had this experience I think it might be better to try to port the latest version, and accept that porting might be a bit harder, but the end result is more likely to work. [1]: https://github.com/cloud-hypervisor/vhost/pull/22 [2]: https://github.com/cloud-hypervisor/cloud-hypervisor/pull/1565 [3]: https://lore.kernel.org/qemu-devel/87sgd1ktx9.fsf@alyssa.is/ libgit2 ------- While bisecting cloud-hypervisor to see if I could figure out when the v-u-n frontend started working properly, I encountered a large section of commits that I couldn't build any more, because Cargo couldn't resolve a git dependency. The dependency was locked to a commit that was no longer in the branch it had been in when the cloud-hypervisor commit was from. Despite knowing the exact commit it needed, Cargo fetched the branch the commit used to be on. This is because it is generally not possible to fetch arbitrary commits with git. Some servers, like GitHub, do however allow this, and I wondered why Cargo wouldn't at least fall back to trying that. As it turns out, it actually couldn't do that, though! Cargo uses libgit2, and libgit2 doesn't support fetching arbitrary commits. So I wrote a quick patch to libgit2 to support this[4]. It's only a partial implementation, though, because I don't find libgit2 to be a particularly easy codebase to work in (although it's better than git!). So I'm hoping somebody who knows more about it than me will help me figure out how to finish it. [4]: https://github.com/libgit2/libgit2/pull/5603 Next week, I'm hoping that I'll be able to get to vhost-user-net in crosvm working. I think this will probably mean porting the code again, using the latest version. Which is a bit of a shame, but at least I have an idea of what to do next. I am, overall, feeling pretty optimistic, though. I'm pretty confident that we can get some sort of decent but imperfect network hardware isolation even though virtio-vhost-user might not be ready yet, which was something I was worried about before. I don't want to really go into detail in that now though because this is already a long email and it's already a day late because I was tired yesterday, but essentially, we could forward the network device to a VM that would run the driver, and forward traffic back to the host over virtio-net. The host could handle this either in kernelspace or userspace with DPDK, but the important thing is that the only network driver it would need to support would be virtio-net. No talking to hundreds of different Wi-Fi cards and hoping that none of the drivers have a vulnerability. So, not perfect compared to proper guest<->guest networking, but a step in the right direction, and one that should be as simple as possible to upgrade to virtio-vhost-user once that becomes possible.

1 0

This Week in Spectrum, 2020-W31
by Alyssa Ross 02 Aug '20

02 Aug '20

DPDK ---- Last week, I'd just figured out how to do a normal vhost-user setup with a QEMU VM connected to DPDK. This week, I wanted to try to move DPDK into another VM using the experimental virtio-vhost-user driver, taking the host system out of the networking equation altogether. In theory this should have been a very simple change, but I couldn't get it to work. DPDK claimed to be forwarding packets to the ethernet device I'd attached to the backend VM (the one running DPDK), but networking in the frontend VM (what you might think of as the application VM) didn't work at all. It tried and failed to do DHCP, and so couldn't progress beyond that. A breakthrough came when I thought to look at the logs of my local DHCP server. I saw that it was actually receiving requests from the VM, and assigning it an IP address. Once I realised this, I hypothesised that outgoing traffic was working, but not incoming. Finally having something to look for, I had a look through the DPDK virtio-vhost-user driver[1], and my suspicion was confirmed in an unexpected way. It looks like incoming traffic (from the perspective of the virtio-vhost-user frontend) is not actually implemented at all! But with outbound traffic working, this means that I'm confident enough I understand virtio-vhost-user enough to be able to leave this here for now. From Spectrum's side, I can now be pretty sure that everything should be workable, so we can just wait a bit for virtio-vhost-user to get a bit further along and then revisit it. And since the frontend has no idea it's talking to virtio-vhost-user instead of normal vhost-user, we can use normal (host-based) vhost-user for now, and drop virtio-vhost-user in down the line. A couple of outstanding questions I still don't know the answer to about DPDK are: - How will routing work if I have multiple frontend VMs with multiple virtio-vhost-user connections all wanting to use the same network device? Will I want to use something like Open vSwitch[2] for that? - DPDK by default uses a busyloop to check for data to process, for efficiency. This is obviously not appropriate for a workstation-focused operating system. There is an interrupt-based mode, though, but I don't know how to use it yet. Since I consider the concept proven, though, I'm going to punt on these for now. The longer I leave these questions, the more likely it is that a kernel driver for virtio-vhost-user will emerge and we can use that instead. That's not to say I want to leave inter-guest networking hanging forever, but I have other inter-guest networking bits I can switch focus to for now, and once those are down I can revisit the virtio-vhost-user backend situation. [1]: https://github.com/ndragazis/dpdk-next-virtio/blob/2d60e63/drivers/virtio_v… [2]: https://www.openvswitch.org/ crosvm ------ I started integrating the vhost-user-net code from Cloud Hypervisor into crosvm. I'm at the point where I can get all the copied Cloud Hypervisor code to compile in crosvm, which is pretty good! I have not yet written the code to actually start one of these devices yet, though, so I haven't been able to test it yet. It's been interesting to look at Cloud Hypervisor because it's a codebase that is heavily based on crosvm (even more so than Firecracker is), but that has also evolved and diverged from it. It's especially interesting to see stuff where parallel evolution occurred between the crosvm and Cloud Hypervisor codebases, or when Cloud Hypervisor changed how some crosvm code worked, and then later changed it back again. The codebases were still similar enough that I could have the cloud-hypervisor device integrated into the crosvm codebase in a day, although there's lots of code duplication that will have to be dealt with -- I copied over a bunch of supporting code rather than trying to integrate it into the crosvm equivalents to get the code running for the first time in an environment as similar as possible to the one it was designed for. I expect that when I test the device in crosvm it'll probably work fairly quickly if not first try. The more complicated part will be a bit of a change to how crosvm does guest memory that isn't strictly necessary but is important for security. crosvm allocates all guest memory in a single memfd. This means that, to share guest memory with another process, like when using vhost-user, the only option is to share all of guest memory. This would sort of defeat the purpose of hardware isolation in Spectrum! But from what I could tell -- I'm not 100% on this -- the guest memory abstraction in cloud-hypervisor is more advanced, and I think it might support multiple memfds backing guest memory for this sort of thing. I'll have to adapt crosvm to that model to be able to use vhost-user securely. website ------- The new "Bibliography" page is up[3]! Lots of links to relevant resources about concepts important to Spectrum. :) [3]: https://spectrum-os.org/bibliography.html It's a bit of a relief to have returned from the uncertain world of DPDK to the familiar territory of crosvm. I'm confident that the next bit of work here (vhost-user in crosvm) won't be that much of a big deal. Hopefully, we'll have at interim networking to a reasonable degree fairly soon. After that, I plan to look at file sharing, possibly with vhost-user-fs (virtio-fs over vhost-user), which I noticed cloud-hypervisor implements today. That should be pretty similar to the networking stuff, although I don't think any virtio-fs virtio-vhost-user code exists at the moment.

1 0

[PATCH doc] Become REUSE 3.0 compliant
by Alyssa Ross 31 Jul '20

31 Jul '20

See <https://reuse.software/>. NLnet are quite keen on this. Cc: Cole Helbling <cole.e.helbling(a)outlook.com> --- Cole, are you happy with how you're listed as a copyright holder in developer-manual.adoc here? The year and email address are both technically optional, so if you'd rather not have your email address listed that would be okay. .gitignore | 5 +- LICENSES/CC-BY-SA-4.0 | 428 ------------------------------- LICENSES/CC-BY-SA-4.0.txt | 350 +++++++++++++++++++++++++ LICENSES/CC0-1.0.txt | 119 +++++++++ LICENSES/GFDL-1.3 | 451 --------------------------------- LICENSES/GFDL-1.3-or-later.txt | 416 ++++++++++++++++++++++++++++++ LICENSES/MIT | 17 -- LICENSES/MIT.txt | 19 ++ Makefile | 1 + default.nix | 1 + developer-manual.adoc | 10 +- 11 files changed, 919 insertions(+), 898 deletions(-) delete mode 100644 LICENSES/CC-BY-SA-4.0 create mode 100644 LICENSES/CC-BY-SA-4.0.txt create mode 100644 LICENSES/CC0-1.0.txt delete mode 100644 LICENSES/GFDL-1.3 create mode 100644 LICENSES/GFDL-1.3-or-later.txt delete mode 100644 LICENSES/MIT create mode 100644 LICENSES/MIT.txt diff --git a/.gitignore b/.gitignore index 71d0225..bc46bd4 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ -/developer-manual.html \ No newline at end of file +# SPDX-FileCopyrightText: Alyssa Ross <hi(a)alyssa.is> +# SPDX-License-Identifier: CC0-1.0 + +/developer-manual.html diff --git a/LICENSES/CC-BY-SA-4.0 b/LICENSES/CC-BY-SA-4.0 deleted file mode 100644 index a73481c..0000000 --- a/LICENSES/CC-BY-SA-4.0 +++ /dev/null @@ -1,428 +0,0 @@ -Attribution-ShareAlike 4.0 International - -======================================================================= - -Creative Commons Corporation ("Creative Commons") is not a law firm and -does not provide legal services or legal advice. Distribution of -Creative Commons public licenses does not create a lawyer-client or -other relationship. Creative Commons makes its licenses and related -information available on an "as-is" basis. Creative Commons gives no -warranties regarding its licenses, any material licensed under their -terms and conditions, or any related information. Creative Commons -disclaims all liability for damages resulting from their use to the -fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and -conditions that creators and other rights holders may use to share -original works of authorship and other material subject to copyright -and certain other rights specified in the public license below. The -following considerations are for informational purposes only, are not -exhaustive, and do not form part of our licenses. - - Considerations for licensors: Our public licenses are - intended for use by those authorized to give the public - permission to use material in ways otherwise restricted by - copyright and certain other rights. Our licenses are - irrevocable. Licensors should read and understand the terms - and conditions of the license they choose before applying it. - Licensors should also secure all rights necessary before - applying our licenses so that the public can reuse the - material as expected. Licensors should clearly mark any - material not subject to the license. This includes other CC- - licensed material, or material used under an exception or - limitation to copyright. More considerations for licensors: - wiki.creativecommons.org/Considerations_for_licensors - - Considerations for the public: By using one of our public - licenses, a licensor grants the public permission to use the - licensed material under specified terms and conditions. If - the licensor's permission is not necessary for any reason--for - example, because of any applicable exception or limitation to - copyright--then that use is not regulated by the license. Our - licenses grant only permissions under copyright and certain - other rights that a licensor has authority to grant. Use of - the licensed material may still be restricted for other - reasons, including because others have copyright or other - rights in the material. A licensor may make special requests, - such as asking that all changes be marked or described. - Although not required by our licenses, you are encouraged to - respect those requests where reasonable. More considerations - for the public: - wiki.creativecommons.org/Considerations_for_licensees - -======================================================================= - -Creative Commons Attribution-ShareAlike 4.0 International Public -License - -By exercising the Licensed Rights (defined below), You accept and agree -to be bound by the terms and conditions of this Creative Commons -Attribution-ShareAlike 4.0 International Public License ("Public -License"). To the extent this Public License may be interpreted as a -contract, You are granted the Licensed Rights in consideration of Your -acceptance of these terms and conditions, and the Licensor grants You -such rights in consideration of benefits the Licensor receives from -making the Licensed Material available under these terms and -conditions. - - -Section 1 -- Definitions. - - a. Adapted Material means material subject to Copyright and Similar - Rights that is derived from or based upon the Licensed Material - and in which the Licensed Material is translated, altered, - arranged, transformed, or otherwise modified in a manner requiring - permission under the Copyright and Similar Rights held by the - Licensor. For purposes of this Public License, where the Licensed - Material is a musical work, performance, or sound recording, - Adapted Material is always produced where the Licensed Material is - synched in timed relation with a moving image. - - b. Adapter's License means the license You apply to Your Copyright - and Similar Rights in Your contributions to Adapted Material in - accordance with the terms and conditions of this Public License. - - c. BY-SA Compatible License means a license listed at - creativecommons.org/compatiblelicenses, approved by Creative - Commons as essentially the equivalent of this Public License. - - d. Copyright and Similar Rights means copyright and/or similar rights - closely related to copyright including, without limitation, - performance, broadcast, sound recording, and Sui Generis Database - Rights, without regard to how the rights are labeled or - categorized. For purposes of this Public License, the rights - specified in Section 2(b)(1)-(2) are not Copyright and Similar - Rights. - - e. Effective Technological Measures means those measures that, in the - absence of proper authority, may not be circumvented under laws - fulfilling obligations under Article 11 of the WIPO Copyright - Treaty adopted on December 20, 1996, and/or similar international - agreements. - - f. Exceptions and Limitations means fair use, fair dealing, and/or - any other exception or limitation to Copyright and Similar Rights - that applies to Your use of the Licensed Material. - - g. License Elements means the license attributes listed in the name - of a Creative Commons Public License. The License Elements of this - Public License are Attribution and ShareAlike. - - h. Licensed Material means the artistic or literary work, database, - or other material to which the Licensor applied this Public - License. - - i. Licensed Rights means the rights granted to You subject to the - terms and conditions of this Public License, which are limited to - all Copyright and Similar Rights that apply to Your use of the - Licensed Material and that the Licensor has authority to license. - - j. Licensor means the individual(s) or entity(ies) granting rights - under this Public License. - - k. Share means to provide material to the public by any means or - process that requires permission under the Licensed Rights, such - as reproduction, public display, public performance, distribution, - dissemination, communication, or importation, and to make material - available to the public including in ways that members of the - public may access the material from a place and at a time - individually chosen by them. - - l. Sui Generis Database Rights means rights other than copyright - resulting from Directive 96/9/EC of the European Parliament and of - the Council of 11 March 1996 on the legal protection of databases, - as amended and/or succeeded, as well as other essentially - equivalent rights anywhere in the world. - - m. You means the individual or entity exercising the Licensed Rights - under this Public License. Your has a corresponding meaning. - - -Section 2 -- Scope. - - a. License grant. - - 1. Subject to the terms and conditions of this Public License, - the Licensor hereby grants You a worldwide, royalty-free, - non-sublicensable, non-exclusive, irrevocable license to - exercise the Licensed Rights in the Licensed Material to: - - a. reproduce and Share the Licensed Material, in whole or - in part; and - - b. produce, reproduce, and Share Adapted Material. - - 2. Exceptions and Limitations. For the avoidance of doubt, where - Exceptions and Limitations apply to Your use, this Public - License does not apply, and You do not need to comply with - its terms and conditions. - - 3. Term. The term of this Public License is specified in Section - 6(a). - - 4. Media and formats; technical modifications allowed. The - Licensor authorizes You to exercise the Licensed Rights in - all media and formats whether now known or hereafter created, - and to make technical modifications necessary to do so. The - Licensor waives and/or agrees not to assert any right or - authority to forbid You from making technical modifications - necessary to exercise the Licensed Rights, including - technical modifications necessary to circumvent Effective - Technological Measures. For purposes of this Public License, - simply making modifications authorized by this Section 2(a) - (4) never produces Adapted Material. - - 5. Downstream recipients. - - a. Offer from the Licensor -- Licensed Material. Every - recipient of the Licensed Material automatically - receives an offer from the Licensor to exercise the - Licensed Rights under the terms and conditions of this - Public License. - - b. Additional offer from the Licensor -- Adapted Material. - Every recipient of Adapted Material from You - automatically receives an offer from the Licensor to - exercise the Licensed Rights in the Adapted Material - under the conditions of the Adapter's License You apply. - - c. No downstream restrictions. You may not offer or impose - any additional or different terms or conditions on, or - apply any Effective Technological Measures to, the - Licensed Material if doing so restricts exercise of the - Licensed Rights by any recipient of the Licensed - Material. - - 6. No endorsement. Nothing in this Public License constitutes or - may be construed as permission to assert or imply that You - are, or that Your use of the Licensed Material is, connected - with, or sponsored, endorsed, or granted official status by, - the Licensor or others designated to receive attribution as - provided in Section 3(a)(1)(A)(i). - - b. Other rights. - - 1. Moral rights, such as the right of integrity, are not - licensed under this Public License, nor are publicity, - privacy, and/or other similar personality rights; however, to - the extent possible, the Licensor waives and/or agrees not to - assert any such rights held by the Licensor to the limited - extent necessary to allow You to exercise the Licensed - Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this - Public License. - - 3. To the extent possible, the Licensor waives any right to - collect royalties from You for the exercise of the Licensed - Rights, whether directly or through a collecting society - under any voluntary or waivable statutory or compulsory - licensing scheme. In all other cases the Licensor expressly - reserves any right to collect such royalties. - - -Section 3 -- License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the -following conditions. - - a. Attribution. - - 1. If You Share the Licensed Material (including in modified - form), You must: - - a. retain the following if it is supplied by the Licensor - with the Licensed Material: - - i. identification of the creator(s) of the Licensed - Material and any others designated to receive - attribution, in any reasonable manner requested by - the Licensor (including by pseudonym if - designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of - warranties; - - v. a URI or hyperlink to the Licensed Material to the - extent reasonably practicable; - - b. indicate if You modified the Licensed Material and - retain an indication of any previous modifications; and - - c. indicate the Licensed Material is licensed under this - Public License, and include the text of, or the URI or - hyperlink to, this Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any - reasonable manner based on the medium, means, and context in - which You Share the Licensed Material. For example, it may be - reasonable to satisfy the conditions by providing a URI or - hyperlink to a resource that includes the required - information. - - 3. If requested by the Licensor, You must remove any of the - information required by Section 3(a)(1)(A) to the extent - reasonably practicable. - - b. ShareAlike. - - In addition to the conditions in Section 3(a), if You Share - Adapted Material You produce, the following conditions also apply. - - 1. The Adapter's License You apply must be a Creative Commons - license with the same License Elements, this version or - later, or a BY-SA Compatible License. - - 2. You must include the text of, or the URI or hyperlink to, the - Adapter's License You apply. You may satisfy this condition - in any reasonable manner based on the medium, means, and - context in which You Share Adapted Material. - - 3. You may not offer or impose any additional or different terms - or conditions on, or apply any Effective Technological - Measures to, Adapted Material that restrict exercise of the - rights granted under the Adapter's License You apply. - - -Section 4 -- Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that -apply to Your use of the Licensed Material: - - a. for the avoidance of doubt, Section 2(a)(1) grants You the right - to extract, reuse, reproduce, and Share all or a substantial - portion of the contents of the database; - - b. if You include all or a substantial portion of the database - contents in a database in which You have Sui Generis Database - Rights, then the database in which You have Sui Generis Database - Rights (but not its individual contents) is Adapted Material, - - including for purposes of Section 3(b); and - c. You must comply with the conditions in Section 3(a) if You Share - all or a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not -replace Your obligations under this Public License where the Licensed -Rights include other Copyright and Similar Rights. - - -Section 5 -- Disclaimer of Warranties and Limitation of Liability. - - a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - - b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - - c. The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - - -Section 6 -- Term and Termination. - - a. This Public License applies for the term of the Copyright and - Similar Rights licensed here. However, if You fail to comply with - this Public License, then Your rights under this Public License - terminate automatically. - - b. Where Your right to use the Licensed Material has terminated under - Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided - it is cured within 30 days of Your discovery of the - violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any - right the Licensor may have to seek remedies for Your violations - of this Public License. - - c. For the avoidance of doubt, the Licensor may also offer the - Licensed Material under separate terms or conditions or stop - distributing the Licensed Material at any time; however, doing so - will not terminate this Public License. - - d. Sections 1, 5, 6, 7, and 8 survive termination of this Public - License. - - -Section 7 -- Other Terms and Conditions. - - a. The Licensor shall not be bound by any additional or different - terms or conditions communicated by You unless expressly agreed. - - b. Any arrangements, understandings, or agreements regarding the - Licensed Material not stated herein are separate from and - independent of the terms and conditions of this Public License. - - -Section 8 -- Interpretation. - - a. For the avoidance of doubt, this Public License does not, and - shall not be interpreted to, reduce, limit, restrict, or impose - conditions on any use of the Licensed Material that could lawfully - be made without permission under this Public License. - - b. To the extent possible, if any provision of this Public License is - deemed unenforceable, it shall be automatically reformed to the - minimum extent necessary to make it enforceable. If the provision - cannot be reformed, it shall be severed from this Public License - without affecting the enforceability of the remaining terms and - conditions. - - c. No term or condition of this Public License will be waived and no - failure to comply consented to unless expressly agreed to by the - Licensor. - - d. Nothing in this Public License constitutes or may be interpreted - as a limitation upon, or waiver of, any privileges and immunities - that apply to the Licensor or You, including from the legal - processes of any jurisdiction or authority. - - -======================================================================= - -Creative Commons is not a party to its public -licenses. Notwithstanding, Creative Commons may elect to apply one of -its public licenses to material it publishes and in those instances -will be considered the “Licensor.” The text of the Creative Commons -public licenses is dedicated to the public domain under the CC0 Public -Domain Dedication. Except for the limited purpose of indicating that -material is shared under a Creative Commons public license or as -otherwise permitted by the Creative Commons policies published at -creativecommons.org/policies, Creative Commons does not authorize the -use of the trademark "Creative Commons" or any other trademark or logo -of Creative Commons without its prior written consent including, -without limitation, in connection with any unauthorized modifications -to any of its public licenses or any other arrangements, -understandings, or agreements concerning use of licensed material. For -the avoidance of doubt, this paragraph does not form part of the -public licenses. - -Creative Commons may be contacted at creativecommons.org. - diff --git a/LICENSES/CC-BY-SA-4.0.txt b/LICENSES/CC-BY-SA-4.0.txt new file mode 100644 index 0000000..f50cdd3 --- /dev/null +++ b/LICENSES/CC-BY-SA-4.0.txt @@ -0,0 +1,350 @@ +Creative Commons Attribution-ShareAlike 4.0 International Creative Commons +Corporation ("Creative Commons") is not a law firm and does not provide legal +services or legal advice. Distribution of Creative Commons public licenses +does not create a lawyer-client or other relationship. Creative Commons makes +its licenses and related information available on an "as-is" basis. Creative +Commons gives no warranties regarding its licenses, any material licensed +under their terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the fullest +extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. + +Although not required by our licenses, you are encouraged to respect those +requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees + +Creative Commons Attribution-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, +approved by Creative Commons as essentially the equivalent of this Public +License. + +d. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +e. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +f. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +g. License Elements means the license attributes listed in the name of a Creative +Commons Public License. The License Elements of this Public License are Attribution +and ShareAlike. + +h. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +i. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +j. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +k. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +l. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +m. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. Additional offer from the Licensor – Adapted Material. Every recipient +of Adapted Material from You automatically receives an offer from the Licensor +to exercise the Licensed Rights in the Adapted Material under the conditions +of the Adapter's License You apply. + +C. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +b. ShareAlike.In addition to the conditions in Section 3(a), if You Share +Adapted Material You produce, the following conditions also apply. + +1. The Adapter's License You apply must be a Creative Commons license with +the same License Elements, this version or later, or a BY-SA Compatible License. + +2. You must include the text of, or the URI or hyperlink to, the Adapter's +License You apply. You may satisfy this condition in any reasonable manner +based on the medium, means, and context in which You Share Adapted Material. + +3. You may not offer or impose any additional or different terms or conditions +on, or apply any Effective Technological Measures to, Adapted Material that +restrict exercise of the rights granted under the Adapter's License You apply. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material, including for purposes of Section 3(b); and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..a343ccd --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,119 @@ +Creative Commons Legal Code + +CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES +NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE +AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION +ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE +OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS +LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION +OR WORKS PROVIDED HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer exclusive +Copyright and Related Rights (defined below) upon the creator and subsequent +owner(s) (each and all, an "owner") of an original work of authorship and/or +a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later claims +of infringement build upon, modify, incorporate in other works, reuse and +redistribute as freely as possible in any form whatsoever and for any purposes, +including without limitation commercial purposes. These owners may contribute +to the Commons to promote the ideal of a free culture and the further production +of creative, cultural and scientific works, or to gain reputation or greater +distribution for their Work in part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with +a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or +her Copyright and Related Rights in the Work and the meaning and intended +legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be protected +by copyright and related or neighboring rights ("Copyright and Related Rights"). +Copyright and Related Rights include, but are not limited to, the following: + +i. the right to reproduce, adapt, distribute, perform, display, communicate, +and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + +iii. publicity and privacy rights pertaining to a person's image or likeness +depicted in a Work; + +iv. rights protecting against unfair competition in regards to a Work, subject +to the limitations in paragraph 4(a), below; + +v. rights protecting the extraction, dissemination, use and reuse of data +in a Work; + +vi. database rights (such as those arising under Directive 96/9/EC of the +European Parliament and of the Council of 11 March 1996 on the legal protection +of databases, and under any national implementation thereof, including any +amended or successor version of such directive); and + +vii. other similar, equivalent or corresponding rights throughout the world +based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time extensions), +(iii) in any current or future medium and for any number of copies, and (iv) +for any purpose whatsoever, including without limitation commercial, advertising +or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the +benefit of each member of the public at large and to the detriment of Affirmer's +heirs and successors, fully intending that such Waiver shall not be subject +to revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account Affirmer's +express Statement of Purpose. In addition, to the extent the Waiver is so +judged Affirmer hereby grants to each affected person a royalty-free, non +transferable, non sublicensable, non exclusive, irrevocable and unconditional +license to exercise Affirmer's Copyright and Related Rights in the Work (i) +in all territories worldwide, (ii) for the maximum duration provided by applicable +law or treaty (including future time extensions), (iii) in any current or +future medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional purposes +(the "License"). The License shall be deemed effective as of the date CC0 +was applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder of +the License, and in such case Affirmer hereby affirms that he or she will +not (i) exercise any of his or her remaining Copyright and Related Rights +in the Work or (ii) assert any associated claims and causes of action with +respect to the Work, in either case contrary to Affirmer's express Statement +of Purpose. + + 4. Limitations and Disclaimers. + +a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, +licensed or otherwise affected by this document. + +b. Affirmer offers the Work as-is and makes no representations or warranties +of any kind concerning the Work, express, implied, statutory or otherwise, +including without limitation warranties of title, merchantability, fitness +for a particular purpose, non infringement, or the absence of latent or other +defects, accuracy, or the present or absence of errors, whether or not discoverable, +all to the greatest extent permissible under applicable law. + +c. Affirmer disclaims responsibility for clearing rights of other persons +that may apply to the Work or any use thereof, including without limitation +any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims +responsibility for obtaining any necessary consents, permissions or other +rights required for any use of the Work. + +d. Affirmer understands and acknowledges that Creative Commons is not a party +to this document and has no duty or obligation with respect to this CC0 or +use of the Work. diff --git a/LICENSES/GFDL-1.3 b/LICENSES/GFDL-1.3 deleted file mode 100644 index bf128be..0000000 --- a/LICENSES/GFDL-1.3 +++ /dev/null @@ -1,451 +0,0 @@ - - GNU Free Documentation License - Version 1.3, 3 November 2008 - - - Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. - <https://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -0. PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document "free" in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The "Document", below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as "you". You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML, PostScript or PDF designed for human modification. Examples of -transparent image formats include PNG, XCF and JPG. Opaque formats -include proprietary formats that can be read and edited only by -proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -The "publisher" means any person or entity that distributes copies of -the Document to the public. - -A section "Entitled XYZ" means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as "Acknowledgements", -"Dedications", "Endorsements", or "History".) To "Preserve the Title" -of such a section when you modify the Document means that it remains a -section "Entitled XYZ" according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no -other conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to -give them a chance to provide you with an updated version of the -Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has fewer than five), - unless they release you from this requirement. -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section Entitled "History", Preserve its Title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section Entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. For any section Entitled "Acknowledgements" or "Dedications", - Preserve the Title of the section, and preserve in the section all - the substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section Entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section to be Entitled "Endorsements" - or to conflict in title with any Invariant Section. -O. Preserve any Warranty Disclaimers. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled "History" -in the various original documents, forming one section Entitled -"History"; likewise combine any sections Entitled "Acknowledgements", -and any sections Entitled "Dedications". You must delete all sections -Entitled "Endorsements". - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other -documents released under this License, and replace the individual -copies of this License in the various documents with a single copy -that is included in the collection, provided that you follow the rules -of this License for verbatim copying of each of the documents in all -other respects. - -You may extract a single document from such a collection, and -distribute it individually under this License, provided you insert a -copy of this License into the extracted document, and follow this -License in all other respects regarding verbatim copying of that -document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an "aggregate" if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled "Acknowledgements", -"Dedications", or "History", the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions of the -GNU Free Documentation License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. See -https://www.gnu.org/licenses/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. - -11. RELICENSING - -"Massive Multiauthor Collaboration Site" (or "MMC Site") means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -"Massive Multiauthor Collaboration" (or "MMC") contained in the site -means any set of copyrightable works thus published on the MMC site. - -"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. - -"Incorporate" means to publish or republish a Document, in whole or in -part, as part of another Document. - -An MMC is "eligible for relicensing" if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole or -in part into the MMC, (1) had no cover texts or invariant sections, and -(2) were thus incorporated prior to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. diff --git a/LICENSES/GFDL-1.3-or-later.txt b/LICENSES/GFDL-1.3-or-later.txt new file mode 100644 index 0000000..90f814d --- /dev/null +++ b/LICENSES/GFDL-1.3-or-later.txt @@ -0,0 +1,416 @@ +GNU Free Documentation License + +Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free +Software Foundation, Inc. <http://fsf.org/> + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + + 0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other functional +and useful document "free" in the sense of freedom: to assure everyone the +effective freedom to copy and redistribute it, with or without modifying it, +either commercially or noncommercially. Secondarily, this License preserves +for the author and publisher a way to get credit for their work, while not +being considered responsible for modifications made by others. + +This License is a kind of "copyleft", which means that derivative works of +the document must themselves be free in the same sense. It complements the +GNU General Public License, which is a copyleft license designed for free +software. + +We have designed this License in order to use it for manuals for free software, +because free software needs free documentation: a free program should come +with manuals providing the same freedoms that the software does. But this +License is not limited to software manuals; it can be used for any textual +work, regardless of subject matter or whether it is published as a printed +book. We recommend this License principally for works whose purpose is instruction +or reference. + + 1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that contains +a notice placed by the copyright holder saying it can be distributed under +the terms of this License. Such a notice grants a world-wide, royalty-free +license, unlimited in duration, to use that work under the conditions stated +herein. The "Document", below, refers to any such manual or work. Any member +of the public is a licensee, and is addressed as "you". You accept the license +if you copy, modify or distribute the work in a way requiring permission under +copyright law. + +A "Modified Version" of the Document means any work containing the Document +or a portion of it, either copied verbatim, or with modifications and/or translated +into another language. + +A "Secondary Section" is a named appendix or a front-matter section of the +Document that deals exclusively with the relationship of the publishers or +authors of the Document to the Document's overall subject (or to related matters) +and contains nothing that could fall directly within that overall subject. +(Thus, if the Document is in part a textbook of mathematics, a Secondary Section +may not explain any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, commercial, +philosophical, ethical or political position regarding them. + +The "Invariant Sections" are certain Secondary Sections whose titles are designated, +as being those of Invariant Sections, in the notice that says that the Document +is released under this License. If a section does not fit the above definition +of Secondary then it is not allowed to be designated as Invariant. The Document +may contain zero Invariant Sections. If the Document does not identify any +Invariant Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, as Front-Cover +Texts or Back-Cover Texts, in the notice that says that the Document is released +under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover +Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, represented +in a format whose specification is available to the general public, that is +suitable for revising the document straightforwardly with generic text editors +or (for images composed of pixels) generic paint programs or (for drawings) +some widely available drawing editor, and that is suitable for input to text +formatters or for automatic translation to a variety of formats suitable for +input to text formatters. A copy made in an otherwise Transparent file format +whose markup, or absence of markup, has been arranged to thwart or discourage +subsequent modification by readers is not Transparent. An image format is +not Transparent if used for any substantial amount of text. A copy that is +not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain ASCII without +markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly +available DTD, and standard-conforming simple HTML, PostScript or PDF designed +for human modification. Examples of transparent image formats include PNG, +XCF and JPG. Opaque formats include proprietary formats that can be read and +edited only by proprietary word processors, SGML or XML for which the DTD +and/or processing tools are not generally available, and the machine-generated +HTML, PostScript or PDF produced by some word processors for output purposes +only. + +The "Title Page" means, for a printed book, the title page itself, plus such +following pages as are needed to hold, legibly, the material this License +requires to appear in the title page. For works in formats which do not have +any title page as such, "Title Page" means the text near the most prominent +appearance of the work's title, preceding the beginning of the body of the +text. + +The "publisher" means any person or entity that distributes copies of the +Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose title +either is precisely XYZ or contains XYZ in parentheses following text that +translates XYZ in another language. (Here XYZ stands for a specific section +name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", +or "History".) To "Preserve the Title" of such a section when you modify the +Document means that it remains a section "Entitled XYZ" according to this +definition. + +The Document may include Warranty Disclaimers next to the notice which states +that this License applies to the Document. These Warranty Disclaimers are +considered to be included by reference in this License, but only as regards +disclaiming warranties: any other implication that these Warranty Disclaimers +may have is void and has no effect on the meaning of this License. + + 2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either commercially +or noncommercially, provided that this License, the copyright notices, and +the license notice saying this License applies to the Document are reproduced +in all copies, and that you add no other conditions whatsoever to those of +this License. You may not use technical measures to obstruct or control the +reading or further copying of the copies you make or distribute. However, +you may accept compensation in exchange for copies. If you distribute a large +enough number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and you +may publicly display copies. + + 3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have printed +covers) of the Document, numbering more than 100, and the Document's license +notice requires Cover Texts, you must enclose the copies in covers that carry, +clearly and legibly, all these Cover Texts: Front-Cover Texts on the front +cover, and Back-Cover Texts on the back cover. Both covers must also clearly +and legibly identify you as the publisher of these copies. The front cover +must present the full title with all words of the title equally prominent +and visible. You may add other material on the covers in addition. Copying +with changes limited to the covers, as long as they preserve the title of +the Document and satisfy these conditions, can be treated as verbatim copying +in other respects. + +If the required texts for either cover are too voluminous to fit legibly, +you should put the first ones listed (as many as fit reasonably) on the actual +cover, and continue the rest onto adjacent pages. + +If you publish or distribute Opaque copies of the Document numbering more +than 100, you must either include a machine-readable Transparent copy along +with each Opaque copy, or state in or with each Opaque copy a computer-network +location from which the general network-using public has access to download +using public-standard network protocols a complete Transparent copy of the +Document, free of added material. If you use the latter option, you must take +reasonably prudent steps, when you begin distribution of Opaque copies in +quantity, to ensure that this Transparent copy will remain thus accessible +at the stated location until at least one year after the last time you distribute +an Opaque copy (directly or through your agents or retailers) of that edition +to the public. + +It is requested, but not required, that you contact the authors of the Document +well before redistributing any large number of copies, to give them a chance +to provide you with an updated version of the Document. + + 4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under the conditions +of sections 2 and 3 above, provided that you release the Modified Version +under precisely this License, with the Modified Version filling the role of +the Document, thus licensing distribution and modification of the Modified +Version to whoever possesses a copy of it. In addition, you must do these +things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct from +that of the Document, and from those of previous versions (which should, if +there were any, be listed in the History section of the Document). You may +use the same title as a previous version if the original publisher of that +version gives permission. + +B. List on the Title Page, as authors, one or more persons or entities responsible +for authorship of the modifications in the Modified Version, together with +at least five of the principal authors of the Document (all of its principal +authors, if it has fewer than five), unless they release you from this requirement. + +C. State on the Title page the name of the publisher of the Modified Version, +as the publisher. + + D. Preserve all the copyright notices of the Document. + +E. Add an appropriate copyright notice for your modifications adjacent to +the other copyright notices. + +F. Include, immediately after the copyright notices, a license notice giving +the public permission to use the Modified Version under the terms of this +License, in the form shown in the Addendum below. + +G. Preserve in that license notice the full lists of Invariant Sections and +required Cover Texts given in the Document's license notice. H. Include an +unaltered copy of this License. + +I. Preserve the section Entitled "History", Preserve its Title, and add to +it an item stating at least the title, year, new authors, and publisher of +the Modified Version as given on the Title Page. If there is no section Entitled +"History" in the Document, create one stating the title, year, authors, and +publisher of the Document as given on its Title Page, then add an item describing +the Modified Version as stated in the previous sentence. + +J. Preserve the network location, if any, given in the Document for public +access to a Transparent copy of the Document, and likewise the network locations +given in the Document for previous versions it was based on. These may be +placed in the "History" section. You may omit a network location for a work +that was published at least four years before the Document itself, or if the +original publisher of the version it refers to gives permission. + +K. For any section Entitled "Acknowledgements" or "Dedications", Preserve +the Title of the section, and preserve in the section all the substance and +tone of each of the contributor acknowledgements and/or dedications given +therein. + +L. Preserve all the Invariant Sections of the Document, unaltered in their +text and in their titles. Section numbers or the equivalent are not considered +part of the section titles. + +M. Delete any section Entitled "Endorsements". Such a section may not be included +in the Modified Version. + +N. Do not retitle any existing section to be Entitled "Endorsements" or to +conflict in title with any Invariant Section. + + O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or appendices that +qualify as Secondary Sections and contain no material copied from the Document, +you may at your option designate some or all of these sections as invariant. +To do this, add their titles to the list of Invariant Sections in the Modified +Version's license notice. These titles must be distinct from any other section +titles. + +You may add a section Entitled "Endorsements", provided it contains nothing +but endorsements of your Modified Version by various parties--for example, +statements of peer review or that the text has been approved by an organization +as the authoritative definition of a standard. + +You may add a passage of up to five words as a Front-Cover Text, and a passage +of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts +in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover +Text may be added by (or through arrangements made by) any one entity. If +the Document already includes a cover text for the same cover, previously +added by you or by arrangement made by the same entity you are acting on behalf +of, you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License give +permission to use their names for publicity for or to assert or imply endorsement +of any Modified Version. + + 5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this License, +under the terms defined in section 4 above for modified versions, provided +that you include in the combination all of the Invariant Sections of all of +the original documents, unmodified, and list them all as Invariant Sections +of your combined work in its license notice, and that you preserve all their +Warranty Disclaimers. + +The combined work need only contain one copy of this License, and multiple +identical Invariant Sections may be replaced with a single copy. If there +are multiple Invariant Sections with the same name but different contents, +make the title of each such section unique by adding at the end of it, in +parentheses, the name of the original author or publisher of that section +if known, or else a unique number. Make the same adjustment to the section +titles in the list of Invariant Sections in the license notice of the combined +work. + +In the combination, you must combine any sections Entitled "History" in the +various original documents, forming one section Entitled "History"; likewise +combine any sections Entitled "Acknowledgements", and any sections Entitled +"Dedications". You must delete all sections Entitled "Endorsements". + + 6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents released +under this License, and replace the individual copies of this License in the +various documents with a single copy that is included in the collection, provided +that you follow the rules of this License for verbatim copying of each of +the documents in all other respects. + +You may extract a single document from such a collection, and distribute it +individually under this License, provided you insert a copy of this License +into the extracted document, and follow this License in all other respects +regarding verbatim copying of that document. + + 7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate and independent +documents or works, in or on a volume of a storage or distribution medium, +is called an "aggregate" if the copyright resulting from the compilation is +not used to limit the legal rights of the compilation's users beyond what +the individual works permit. When the Document is included in an aggregate, +this License does not apply to the other works in the aggregate which are +not themselves derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these copies of +the Document, then if the Document is less than one half of the entire aggregate, +the Document's Cover Texts may be placed on covers that bracket the Document +within the aggregate, or the electronic equivalent of covers if the Document +is in electronic form. Otherwise they must appear on printed covers that bracket +the whole aggregate. + + 8. TRANSLATION + +Translation is considered a kind of modification, so you may distribute translations +of the Document under the terms of section 4. Replacing Invariant Sections +with translations requires special permission from their copyright holders, +but you may include translations of some or all Invariant Sections in addition +to the original versions of these Invariant Sections. You may include a translation +of this License, and all the license notices in the Document, and any Warranty +Disclaimers, provided that you also include the original English version of +this License and the original versions of those notices and disclaimers. In +case of a disagreement between the translation and the original version of +this License or a notice or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", "Dedications", +or "History", the requirement (section 4) to Preserve its Title (section 1) +will typically require changing the actual title. + + 9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except as +expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense, or distribute it is void, and will automatically terminate your +rights under this License. + +However, if you cease all violation of this License, then your license from +a particular copyright holder is reinstated (a) provisionally, unless and +until the copyright holder explicitly and finally terminates your license, +and (b) permanently, if the copyright holder fails to notify you of the violation +by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently +if the copyright holder notifies you of the violation by some reasonable means, +this is the first time you have received notice of violation of this License +(for any work) from that copyright holder, and you cure the violation prior +to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses +of parties who have received copies or rights from you under this License. +If your rights have been terminated and not permanently reinstated, receipt +of a copy of some or all of the same material does not give you any rights +to use it. + + 10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the GNU +Free Documentation License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. See http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. If the +Document specifies that a particular numbered version of this License "or +any later version" applies to it, you have the option of following the terms +and conditions either of that specified version or of any later version that +has been published (not as a draft) by the Free Software Foundation. If the +Document does not specify a version number of this License, you may choose +any version ever published (not as a draft) by the Free Software Foundation. +If the Document specifies that a proxy can decide which future versions of +this License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the Document. + + 11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide +Web server that publishes copyrightable works and also provides prominent +facilities for anybody to edit those works. A public wiki that anybody can +edit is an example of such a server. A "Massive Multiauthor Collaboration" +(or "MMC") contained in the site means any set of copyrightable works thus +published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license +published by Creative Commons Corporation, a not-for-profit corporation with +a principal place of business in San Francisco, California, as well as future +copyleft versions of that license published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in part, +as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this License, +and if all works that were first published under this License somewhere other +than this MMC, and subsequently incorporated in whole or in part into the +MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated +prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site under +CC-BY-SA on the same site at any time before August 1, 2009, provided the +MMC is eligible for relicensing. ADDENDUM: How to use this License for your +documents + +To use this License in a document you have written, include a copy of the +License in the document and put the following copyright and license notices +just after the title page: + +Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or +modify this document under the terms of the GNU Free Documentation License, +Version 1.3 or any later version published by the Free Software Foundation; +with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free Documentation +License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace +the "with...Texts." line with this: + +with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover +Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other combination +of the three, merge those two alternatives to suit the situation. + +If your document contains nontrivial examples of program code, we recommend +releasing these examples in parallel under your choice of free software license, +such as the GNU General Public License, to permit their use in free software. diff --git a/LICENSES/MIT b/LICENSES/MIT deleted file mode 100644 index 7215f69..0000000 --- a/LICENSES/MIT +++ /dev/null @@ -1,17 +0,0 @@ -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 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. \ No newline at end of file diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) <year> <copyright holders> + +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. diff --git a/Makefile b/Makefile index b923b17..b595def 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,4 @@ +# SPDX-FileCopyrightText: 2020 Alyssa Ross # SPDX-License-Identifier: MIT ASCIIDOCTOR = asciidoctor diff --git a/default.nix b/default.nix index 3f3b4aa..dc920b5 100644 --- a/default.nix +++ b/default.nix @@ -1,3 +1,4 @@ +# SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> # SPDX-License-Identifier: MIT with import <nixpkgs> {}; diff --git a/developer-manual.adoc b/developer-manual.adoc index 0f4b30f..da37ef0 100644 --- a/developer-manual.adoc +++ b/developer-manual.adoc @@ -1,5 +1,10 @@ +// SPDX-FileCopyrightText: 2020 Alyssa Ross <hi(a)alyssa.is> +// SPDX-FileCopyrightText: 2020 Cole Helbling <cole.e.helbling(a)outlook.com> // SPDX-License-Identifier: GFDL-1.3-or-later OR CC-BY-SA-4.0 +// XXX: Remember to add new copyright notices to the +// "Copyright and License" section of the content, too! + = Spectrum Developers’ Guide Alyssa Ross <hi(a)alyssa.is> :toc: left @@ -320,7 +325,10 @@ directly required by Spectrum's use case for the program. [appendix] == Copyright and License -Copyright 2020 Alyssa Ross. +Copyright 2020 Alyssa Ross <hi(a)alyssa.is>. + +Copyright 2020 Cole Helbling <cole.e.helbling(a)outlook.com>. + +// XXX: Remember to add new copyright notices as +// SPDX-FileCopyrightText comments at the top of the file, too! Permission is granted to copy, distribute and/or modify this document under either the terms of the -- 2.27.0

2 2

[PATCH www] Fix index links on top-level pages
by Alyssa Ross 31 Jul '20

31 Jul '20

Linking to .. means linking to the directory above these pages, when we actually want to link to the directory these pages are in (which should display index.html). This doesn't have any effect on <https://spectrum-os.org/>, because the site is already at the top level, but it would cause a problem if the site was elsewhere -- for example, when viewing it locally while working on it. --- contributing.html | 2 +- design.html | 2 +- motivation.html | 2 +- participating.html | 2 +- todo.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/contributing.html b/contributing.html index 430c52e..8999fee 100644 --- a/contributing.html +++ b/contributing.html @@ -13,7 +13,7 @@ <body> <nav> - <a href="..">Spectrum</a> + <a href=".">Spectrum</a> </nav> <h1>Contributing to Spectrum</h1> diff --git a/design.html b/design.html index 234f656..e725989 100644 --- a/design.html +++ b/design.html @@ -13,7 +13,7 @@ <body> <nav> - <a href="..">Spectrum</a> + <a href=".">Spectrum</a> </nav> <h1>Spectrum Design</h1> diff --git a/motivation.html b/motivation.html index af8e045..c7d5667 100644 --- a/motivation.html +++ b/motivation.html @@ -13,7 +13,7 @@ <body> <nav> - <a href="..">Spectrum</a> + <a href=".">Spectrum</a> </nav> <h1>Motivation for Spectrum</h1> diff --git a/participating.html b/participating.html index 18f940b..2d9acab 100644 --- a/participating.html +++ b/participating.html @@ -13,7 +13,7 @@ <body> <nav> - <a href="..">Spectrum</a> + <a href=".">Spectrum</a> </nav> <h1>Participating in Spectrum</h1> diff --git a/todo.html b/todo.html index 977179f..077f20a 100644 --- a/todo.html +++ b/todo.html @@ -13,7 +13,7 @@ <body> <nav> - <a href="..">Spectrum</a> + <a href=".">Spectrum</a> </nav> <h1>Contribution ideas</h1> -- 2.27.0

2 2

[PATCH www] bibliography.html: create
by Alyssa Ross 31 Jul '20

31 Jul '20

I thought it might be useful to have a place to collect links that are particularly relevant to Spectrum. This serves two purposes: to provide further external reading for people learning about Spectrum from the website; and to make it easy for us to find links we refer to often. At some point I might add author names, etc. to these links, and make them a bit more like proper citations, but for now I wanted to get an initial version of this out there rather than bikeshedding citation formats. --- bibliography.html | 111 ++++++++++++++++++++++++++++++++++++++++++++++ index.html | 1 + 2 files changed, 112 insertions(+) create mode 100644 bibliography.html diff --git a/bibliography.html b/bibliography.html new file mode 100644 index 0000000..e90f0be --- /dev/null +++ b/bibliography.html @@ -0,0 +1,111 @@ +<!doctype html> +<html lang="en"> + +<head> + +<meta charset="utf-8"> +<meta name="viewport" content="width=device-width,initial-scale=1"> + +<link rel="stylesheet" href="style.css"> + +<title>Spectrum Bibliography</title> + +<body> + +<nav> + <a href="..">Spectrum</a> +</nav> + +<h1>Bibliography</h1> + +<ul> + + <li><cite><a href="https://flatkill.org/">Flatpak — a security + nightmare</a></cite> + + <li><cite><a href="https://blog.invisiblethings.org/papers/2015/x86_harmful.pdf">Intel + x86 Considered Harmful</a></cite> + + <li><cite><a href="https://www.qubes-os.org/">Qubes OS</a></cite> + + <li><cite><a href="https://doi.org/10.1145/3132747.3132763">My VM is + Lighter (and Safer) than your Container</a></cite> + + <li><cite><a href="https://doi.org/10.1145/3342195.3387526">A Linux + in Unikernel Clothing</a></cite> + + <li><cite><a href="https://www.ozlabs.org/~rusty/virtio-spec/virtio-paper.pdf">virtio: + Towards a De-Facto Standard For Virtual I/O Devices</a></cite> + + <li><cite><a href="https://docs.oasis-open.org/virtio/virtio/v1.1/virtio-v1.1.html">Virtual + I/O Device (VIRTIO) Version 1.1</a></cite> + + <li><cite><a href="https://lwn.net/Articles/474088/">Safe device + assignment with VFIO</a></cite> + + <li><cite><a href="https://lists.ozlabs.org/pipermail/lguest/2008-March/001064.html">Inter-guest + virtio I/O example with lguest</a></cite> + + <li><cite><a href="https://lwn.net/Articles/610174/">Supporting + filesystems in persistent memory</a></cite> + + <li><cite><a href="https://lwn.net/Articles/788333/">A filesystem + for virtualization</a></cite> + + <li><cite><a href="https://www.phoronix.com/scan.php?page=news_item&px=VirtIO-DRM-Window-Server">VirtIO + DRM Window Server Support: Letting Guest VMs Interface With Host's + Compositor</a></cite> + + <li><cite><a href="https://www.qemu.org/docs/master/interop/vhost-user.html">Vhost-user + Protocol</a></cite> + + <li><cite><a href="https://wiki.qemu.org/Features/VirtioVhostUser">Features/VirtioVhostUser + — QEMU</a></cite> + + <li><cite><a href="https://chromium.googlesource.com/chromiumos/third_party/kernel/+/refs/head…">Wayland + Virtio Driver</a></cite> + + <li><cite><a href="https://lwn.net/Articles/694291/">An initial + release of Flatpak portals for GNOME</a></cite> + + <li><cite><a href="https://users.ece.cmu.edu/~ganger/712.fall02/papers/p761-thompson.pdf">Reflections + on Trusting Trust</a></cite> + + <li><cite><a href="https://dwheeler.com/trusting-trust/dissertation/wheeler-trusting-trust-ddc…">Fully + Countering Trusting Trust through Diverse Double-Compiling</a></cite> + + <li><cite><a href="https://reproducible-builds.org/docs/buy-in/">Reproducible + Builds — Buy-in</a></cite> + + <li><cite><a href="https://edolstra.github.io/pubs/phd-thesis.pdf">The + Purely Functional Software Deployment Model</a></cite> + + <li><cite><a href="https://nixos.org/features.html">NixOS — + Features</a></cite> + + <li><cite><a href="https://hal.inria.fr/hal-00824004/document">Functional + Package Management with Guix</a></cite> + + <li><cite><a href="https://chromium.googlesource.com/chromiumos/platform/crosvm">Chrome + OS Virtual Machine Monitor</a></cite> + + <li><cite><a href="https://prilik.com/blog/2019/05/16/crosvm-paravirt.html">Paravirtualized + Devices in crosvm — a Performance Panacea for Modern Virtual + Machines</a></cite> + + <li><cite><a href="https://assets.amazon.science/96/c6/302e527240a3b1f86c86c3e8fc3d/firecracke…">Firecracker: + Lightweight Virtualization for Serverless Applications</a></cite> + + <li><cite><a href="https://github.com/cloud-hypervisor/cloud-hypervisor">cloud-hypervisor</a></cite> + +</ul> + +<p> +<small>Permission is granted to copy, distribute and/or modify this +document under either the terms of the +<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative +Commons Attribution-ShareAlike 4.0 International License</a>, or the +<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free +Documentation License, Version 1.3</a> or any later version published +by the Free Software Foundation; with no Invariant Sections, no +Front-Cover Texts, and no Back-Cover Texts.</small> diff --git a/index.html b/index.html index e98443b..08974b1 100644 --- a/index.html +++ b/index.html @@ -52,6 +52,7 @@ Commission. <ul> <li><a href="motivation.html">Motivation for Spectrum</a> <li><a href="design.html">Design</a> + <li><a href="bibliography.html">Bibliography</a> </ul> <h2>Development progress</h2> -- 2.27.0

2 2

[PATCH mktuntap] Become REUSE 3.0 compliant
by Alyssa Ross 31 Jul '20

31 Jul '20

See <https://reuse.software/>. NLnet are quite keen on this. --- .editorconfig | 3 + .gitignore | 7 +- COPYING | 339 ---------------------------------- LICENSES/CC0-1.0.txt | 119 ++++++++++++ LICENSES/GPL-2.0-only.txt | 319 ++++++++++++++++++++++++++++++++ LICENSES/GPL-2.0-or-later.txt | 319 ++++++++++++++++++++++++++++++++ Makefile | 20 +- README | 6 + TODO | 3 + mktuntap.8 | 16 +- mktuntap.c | 28 +-- 11 files changed, 787 insertions(+), 392 deletions(-) delete mode 100644 COPYING create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/GPL-2.0-only.txt create mode 100644 LICENSES/GPL-2.0-or-later.txt diff --git a/.editorconfig b/.editorconfig index 35c5fb2..49f3188 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> +# SPDX-License-Identifier: CC0-1.0 + root = true [*] diff --git a/.gitignore b/.gitignore index 7e27746..9106912 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,9 @@ +# SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> +# SPDX-License-Identifier: CC0-1.0 + result result-* *.o -/mktuntap \ No newline at end of file +/mktuntap +bindunix +socketpair diff --git a/COPYING b/COPYING deleted file mode 100644 index d159169..0000000 --- a/COPYING +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..a343ccd --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,119 @@ +Creative Commons Legal Code + +CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES +NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE +AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION +ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE +OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS +LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION +OR WORKS PROVIDED HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer exclusive +Copyright and Related Rights (defined below) upon the creator and subsequent +owner(s) (each and all, an "owner") of an original work of authorship and/or +a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later claims +of infringement build upon, modify, incorporate in other works, reuse and +redistribute as freely as possible in any form whatsoever and for any purposes, +including without limitation commercial purposes. These owners may contribute +to the Commons to promote the ideal of a free culture and the further production +of creative, cultural and scientific works, or to gain reputation or greater +distribution for their Work in part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with +a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or +her Copyright and Related Rights in the Work and the meaning and intended +legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be protected +by copyright and related or neighboring rights ("Copyright and Related Rights"). +Copyright and Related Rights include, but are not limited to, the following: + +i. the right to reproduce, adapt, distribute, perform, display, communicate, +and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + +iii. publicity and privacy rights pertaining to a person's image or likeness +depicted in a Work; + +iv. rights protecting against unfair competition in regards to a Work, subject +to the limitations in paragraph 4(a), below; + +v. rights protecting the extraction, dissemination, use and reuse of data +in a Work; + +vi. database rights (such as those arising under Directive 96/9/EC of the +European Parliament and of the Council of 11 March 1996 on the legal protection +of databases, and under any national implementation thereof, including any +amended or successor version of such directive); and + +vii. other similar, equivalent or corresponding rights throughout the world +based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time extensions), +(iii) in any current or future medium and for any number of copies, and (iv) +for any purpose whatsoever, including without limitation commercial, advertising +or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the +benefit of each member of the public at large and to the detriment of Affirmer's +heirs and successors, fully intending that such Waiver shall not be subject +to revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account Affirmer's +express Statement of Purpose. In addition, to the extent the Waiver is so +judged Affirmer hereby grants to each affected person a royalty-free, non +transferable, non sublicensable, non exclusive, irrevocable and unconditional +license to exercise Affirmer's Copyright and Related Rights in the Work (i) +in all territories worldwide, (ii) for the maximum duration provided by applicable +law or treaty (including future time extensions), (iii) in any current or +future medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional purposes +(the "License"). The License shall be deemed effective as of the date CC0 +was applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder of +the License, and in such case Affirmer hereby affirms that he or she will +not (i) exercise any of his or her remaining Copyright and Related Rights +in the Work or (ii) assert any associated claims and causes of action with +respect to the Work, in either case contrary to Affirmer's express Statement +of Purpose. + + 4. Limitations and Disclaimers. + +a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, +licensed or otherwise affected by this document. + +b. Affirmer offers the Work as-is and makes no representations or warranties +of any kind concerning the Work, express, implied, statutory or otherwise, +including without limitation warranties of title, merchantability, fitness +for a particular purpose, non infringement, or the absence of latent or other +defects, accuracy, or the present or absence of errors, whether or not discoverable, +all to the greatest extent permissible under applicable law. + +c. Affirmer disclaims responsibility for clearing rights of other persons +that may apply to the Work or any use thereof, including without limitation +any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims +responsibility for obtaining any necessary consents, permissions or other +rights required for any use of the Work. + +d. Affirmer understands and acknowledges that Creative Commons is not a party +to this document and has no duty or obligation with respect to this CC0 or +use of the Work. diff --git a/LICENSES/GPL-2.0-only.txt b/LICENSES/GPL-2.0-only.txt new file mode 100644 index 0000000..0f3d641 --- /dev/null +++ b/LICENSES/GPL-2.0-only.txt @@ -0,0 +1,319 @@ +GNU GENERAL PUBLIC LICENSE + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. + +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software +is covered by the GNU Lesser General Public License instead.) You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for this service if you +wish), that you receive source code or can get it if you want it, that you +can change the software or use pieces of it in new free programs; and that +you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to +deny you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of +the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must give the recipients all the rights that you have. You +must make sure that they, too, receive or can get the source code. And you +must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If +the software is modified by someone else and passed on, we want its recipients +to know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will individually +obtain patent licenses, in effect making the program proprietary. To prevent +this, we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms +of this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation +in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered +by this License; they are outside its scope. The act of running the Program +is not restricted, and the output from the Program is covered only if its +contents constitute a work based on the Program (independent of having been +made by running the Program). Whether that is true depends on what the Program +does. + +1. You may copy and distribute verbatim copies of the Program's source code +as you receive it, in any medium, provided that you conspicuously and appropriately +publish on each copy an appropriate copyright notice and disclaimer of warranty; +keep intact all the notices that refer to this License and to the absence +of any warranty; and give any other recipients of the Program a copy of this +License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you +may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, +thus forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all +of these conditions: + +a) You must cause the modified files to carry prominent notices stating that +you changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or +in part contains or is derived from the Program or any part thereof, to be +licensed as a whole at no charge to all third parties under the terms of this +License. + +c) If the modified program normally reads commands interactively when run, +you must cause it, when started running for such interactive use in the most +ordinary way, to print or display an announcement including an appropriate +copyright notice and a notice that there is no warranty (or else, saying that +you provide a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this License. +(Exception: if the Program itself is interactive but does not normally print +such an announcement, your work based on the Program is not required to print +an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be +on the terms of this License, whose permissions for other licensees extend +to the entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise +the right to control the distribution of derivative or collective works based +on the Program. + +In addition, mere aggregation of another work not based on the Program with +the Program (or with a work based on the Program) on a volume of a storage +or distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under Section +2) in object code or executable form under the terms of Sections 1 and 2 above +provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source code, +which must be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give +any third party, for a charge no more than your cost of physically performing +source distribution, a complete machine-readable copy of the corresponding +source code, to be distributed under the terms of Sections 1 and 2 above on +a medium customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code distributed +need not include anything that is normally distributed (in either source or +binary form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component itself +accompanies the executable. + +If distribution of executable or object code is made by offering access to +copy from a designated place, then offering equivalent access to copy the +source code from the same place counts as distribution of the source code, +even though third parties are not compelled to copy the source along with +the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except +as expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses terminated +so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed +it. However, nothing else grants you permission to modify or distribute the +Program or its derivative works. These actions are prohibited by law if you +do not accept this License. Therefore, by modifying or distributing the Program +(or any work based on the Program), you indicate your acceptance of this License +to do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor +to copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of +the rights granted herein. You are not responsible for enforcing compliance +by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), conditions are imposed +on you (whether by court order, agreement or otherwise) that contradict the +conditions of this License, they do not excuse you from the conditions of +this License. If you cannot distribute so as to satisfy simultaneously your +obligations under this License and any other pertinent obligations, then as +a consequence you may not distribute the Program at all. For example, if a +patent license would not permit royalty-free redistribution of the Program +by all those who receive copies directly or indirectly through you, then the +only way you could satisfy both it and this License would be to refrain entirely +from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents +or other property right claims or to contest validity of any such claims; +this section has the sole purpose of protecting the integrity of the free +software distribution system, which is implemented by public license practices. +Many people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose +that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original copyright +holder who places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is +permitted only in or among countries not thus excluded. In such case, this +License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of +the General Public License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies +a version number of this License which applies to it and "any later version", +you have the option of following the terms and conditions either of that version +or of any later version published by the Free Software Foundation. If the +Program does not specify a version number of this License, you may choose +any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing and reuse +of software generally. + + NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM +"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, +BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE +OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE +OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA +OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES +OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH +HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + +<one line to give the program's name and an idea of what it does.> + +Copyright (C)< yyyy> <name of author> + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program; if not, write to the Free Software Foundation, Inc., 51 Franklin +Street, Fifth Floor, Boston, MA 02110-1301, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when +it starts in an interactive mode: + +Gnomovision version 69, Copyright (C) year name of author Gnomovision comes +with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, +and you are welcome to redistribute it under certain conditions; type `show +c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than `show w' and `show c'; they could even be mouse-clicks +or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + +Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' +(which makes passes at compilers) written by James Hacker. + +<signature of Ty Coon >, 1 April 1989 Ty Coon, President of Vice This General +Public License does not permit incorporating your program into proprietary +programs. If your program is a subroutine library, you may consider it more +useful to permit linking proprietary applications with the library. If this +is what you want to do, use the GNU Lesser General Public License instead +of this License. diff --git a/LICENSES/GPL-2.0-or-later.txt b/LICENSES/GPL-2.0-or-later.txt new file mode 100644 index 0000000..1d80ac3 --- /dev/null +++ b/LICENSES/GPL-2.0-or-later.txt @@ -0,0 +1,319 @@ +GNU GENERAL PUBLIC LICENSE + +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. + +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license +document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share +and change it. By contrast, the GNU General Public License is intended to +guarantee your freedom to share and change free software--to make sure the +software is free for all its users. This General Public License applies to +most of the Free Software Foundation's software and to any other program whose +authors commit to using it. (Some other Free Software Foundation software +is covered by the GNU Lesser General Public License instead.) You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our +General Public Licenses are designed to make sure that you have the freedom +to distribute copies of free software (and charge for this service if you +wish), that you receive source code or can get it if you want it, that you +can change the software or use pieces of it in new free programs; and that +you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to +deny you these rights or to ask you to surrender the rights. These restrictions +translate to certain responsibilities for you if you distribute copies of +the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or +for a fee, you must give the recipients all the rights that you have. You +must make sure that they, too, receive or can get the source code. And you +must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) +offer you this license which gives you legal permission to copy, distribute +and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that +everyone understands that there is no warranty for this free software. If +the software is modified by someone else and passed on, we want its recipients +to know that what they have is not the original, so that any problems introduced +by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We +wish to avoid the danger that redistributors of a free program will individually +obtain patent licenses, in effect making the program proprietary. To prevent +this, we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification +follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice +placed by the copyright holder saying it may be distributed under the terms +of this General Public License. The "Program", below, refers to any such program +or work, and a "work based on the Program" means either the Program or any +derivative work under copyright law: that is to say, a work containing the +Program or a portion of it, either verbatim or with modifications and/or translated +into another language. (Hereinafter, translation is included without limitation +in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered +by this License; they are outside its scope. The act of running the Program +is not restricted, and the output from the Program is covered only if its +contents constitute a work based on the Program (independent of having been +made by running the Program). Whether that is true depends on what the Program +does. + +1. You may copy and distribute verbatim copies of the Program's source code +as you receive it, in any medium, provided that you conspicuously and appropriately +publish on each copy an appropriate copyright notice and disclaimer of warranty; +keep intact all the notices that refer to this License and to the absence +of any warranty; and give any other recipients of the Program a copy of this +License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you +may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, +thus forming a work based on the Program, and copy and distribute such modifications +or work under the terms of Section 1 above, provided that you also meet all +of these conditions: + +a) You must cause the modified files to carry prominent notices stating that +you changed the files and the date of any change. + +b) You must cause any work that you distribute or publish, that in whole or +in part contains or is derived from the Program or any part thereof, to be +licensed as a whole at no charge to all third parties under the terms of this +License. + +c) If the modified program normally reads commands interactively when run, +you must cause it, when started running for such interactive use in the most +ordinary way, to print or display an announcement including an appropriate +copyright notice and a notice that there is no warranty (or else, saying that +you provide a warranty) and that users may redistribute the program under +these conditions, and telling the user how to view a copy of this License. +(Exception: if the Program itself is interactive but does not normally print +such an announcement, your work based on the Program is not required to print +an announcement.) + +These requirements apply to the modified work as a whole. If identifiable +sections of that work are not derived from the Program, and can be reasonably +considered independent and separate works in themselves, then this License, +and its terms, do not apply to those sections when you distribute them as +separate works. But when you distribute the same sections as part of a whole +which is a work based on the Program, the distribution of the whole must be +on the terms of this License, whose permissions for other licensees extend +to the entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest your +rights to work written entirely by you; rather, the intent is to exercise +the right to control the distribution of derivative or collective works based +on the Program. + +In addition, mere aggregation of another work not based on the Program with +the Program (or with a work based on the Program) on a volume of a storage +or distribution medium does not bring the other work under the scope of this +License. + +3. You may copy and distribute the Program (or a work based on it, under Section +2) in object code or executable form under the terms of Sections 1 and 2 above +provided that you also do one of the following: + +a) Accompany it with the complete corresponding machine-readable source code, +which must be distributed under the terms of Sections 1 and 2 above on a medium +customarily used for software interchange; or, + +b) Accompany it with a written offer, valid for at least three years, to give +any third party, for a charge no more than your cost of physically performing +source distribution, a complete machine-readable copy of the corresponding +source code, to be distributed under the terms of Sections 1 and 2 above on +a medium customarily used for software interchange; or, + +c) Accompany it with the information you received as to the offer to distribute +corresponding source code. (This alternative is allowed only for noncommercial +distribution and only if you received the program in object code or executable +form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making +modifications to it. For an executable work, complete source code means all +the source code for all modules it contains, plus any associated interface +definition files, plus the scripts used to control compilation and installation +of the executable. However, as a special exception, the source code distributed +need not include anything that is normally distributed (in either source or +binary form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component itself +accompanies the executable. + +If distribution of executable or object code is made by offering access to +copy from a designated place, then offering equivalent access to copy the +source code from the same place counts as distribution of the source code, +even though third parties are not compelled to copy the source along with +the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except +as expressly provided under this License. Any attempt otherwise to copy, modify, +sublicense or distribute the Program is void, and will automatically terminate +your rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses terminated +so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed +it. However, nothing else grants you permission to modify or distribute the +Program or its derivative works. These actions are prohibited by law if you +do not accept this License. Therefore, by modifying or distributing the Program +(or any work based on the Program), you indicate your acceptance of this License +to do so, and all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), +the recipient automatically receives a license from the original licensor +to copy, distribute or modify the Program subject to these terms and conditions. +You may not impose any further restrictions on the recipients' exercise of +the rights granted herein. You are not responsible for enforcing compliance +by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement +or for any other reason (not limited to patent issues), conditions are imposed +on you (whether by court order, agreement or otherwise) that contradict the +conditions of this License, they do not excuse you from the conditions of +this License. If you cannot distribute so as to satisfy simultaneously your +obligations under this License and any other pertinent obligations, then as +a consequence you may not distribute the Program at all. For example, if a +patent license would not permit royalty-free redistribution of the Program +by all those who receive copies directly or indirectly through you, then the +only way you could satisfy both it and this License would be to refrain entirely +from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply and +the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents +or other property right claims or to contest validity of any such claims; +this section has the sole purpose of protecting the integrity of the free +software distribution system, which is implemented by public license practices. +Many people have made generous contributions to the wide range of software +distributed through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing to +distribute software through any other system and a licensee cannot impose +that choice. + +This section is intended to make thoroughly clear what is believed to be a +consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain +countries either by patents or by copyrighted interfaces, the original copyright +holder who places the Program under this License may add an explicit geographical +distribution limitation excluding those countries, so that distribution is +permitted only in or among countries not thus excluded. In such case, this +License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of +the General Public License from time to time. Such new versions will be similar +in spirit to the present version, but may differ in detail to address new +problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies +a version number of this License which applies to it and "any later version", +you have the option of following the terms and conditions either of that version +or of any later version published by the Free Software Foundation. If the +Program does not specify a version number of this License, you may choose +any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs +whose distribution conditions are different, write to the author to ask for +permission. For software which is copyrighted by the Free Software Foundation, +write to the Free Software Foundation; we sometimes make exceptions for this. +Our decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing and reuse +of software generally. + + NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR +THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE +STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM +"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, +BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE +OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE +OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA +OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES +OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH +HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible +use to the public, the best way to achieve this is to make it free software +which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach +them to the start of each source file to most effectively convey the exclusion +of warranty; and each file should have at least the "copyright" line and a +pointer to where the full notice is found. + +<one line to give the program's name and an idea of what it does.> + +Copyright (C) <yyyy> <name of author> + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free Software +Foundation; either version 2 of the License, or (at your option) any later +version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program; if not, write to the Free Software Foundation, Inc., 51 Franklin +Street, Fifth Floor, Boston, MA 02110-1301, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when +it starts in an interactive mode: + +Gnomovision version 69, Copyright (C) year name of author Gnomovision comes +with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, +and you are welcome to redistribute it under certain conditions; type `show +c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may be +called something other than `show w' and `show c'; they could even be mouse-clicks +or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, +if any, to sign a "copyright disclaimer" for the program, if necessary. Here +is a sample; alter the names: + +Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' +(which makes passes at compilers) written by James Hacker. + +<signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General +Public License does not permit incorporating your program into proprietary +programs. If your program is a subroutine library, you may consider it more +useful to permit linking proprietary applications with the library. If this +is what you want to do, use the GNU Lesser General Public License instead +of this License. diff --git a/Makefile b/Makefile index ff52ac4..9e6c8aa 100644 --- a/Makefile +++ b/Makefile @@ -1,21 +1,7 @@ +# SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> # SPDX-License-Identifier: GPL-2.0-or-later -# Copyright 2019 Alyssa Ross -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <https://www.gnu.org/licenses/>. - -all: mktuntap +all: bindunix mktuntap socketpair .PHONY: all prefix = /usr/local @@ -32,6 +18,8 @@ MKDIR_P = mkdir -p CFLAGS = -g +bindunix socketpair: util.o + install-dirs: $(MKDIR_P) $(DESTDIR)$(bindir) $(DESTDIR)$(man8dir) .PHONY: install-dirs diff --git a/README b/README index 5f19bec..5a62791 100644 --- a/README +++ b/README @@ -1,3 +1,6 @@ +SPDX-FileCopyrightText: 2019-2020 Alyssa Ross <hi(a)alyssa.is> +SPDX-License-Identifier: GPL-2.0-or-later + mktuntap -------- @@ -19,3 +22,6 @@ published by the Free Software Foundation. Other source files are licensed under the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version. + +Some utility files (.gitignore, etc.) are licensed under the CC0 +1.0 Universal Public Domain Dedication. diff --git a/TODO b/TODO index 7a72fe4..a3dd911 100644 --- a/TODO +++ b/TODO @@ -1 +1,4 @@ +SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> +SPDX-License-Identifier: CC0-1.0 + * Reimplement tap_alloc for compatibility with newer GPLs diff --git a/mktuntap.8 b/mktuntap.8 index 9bbfb78..0f9aaf8 100644 --- a/mktuntap.8 +++ b/mktuntap.8 @@ -1,19 +1,5 @@ +.\" SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> .\" SPDX-License-Identifier: GPL-2.0-or-later -.\" -.\" Copyright 2019 Alyssa Ross -.\" -.\" This program is free software: you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation, either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with this program. If not, see <https://www.gnu.org/licenses/>. .Dd December 15, 2019 .Dt MKTUNTAP 8 .Os Linux diff --git a/mktuntap.c b/mktuntap.c index 53a47de..b150dc7 100644 --- a/mktuntap.c +++ b/mktuntap.c @@ -1,20 +1,6 @@ +// SPDX-FileCopyrightText: 2019 Alyssa Ross <hi(a)alyssa.is> // SPDX-License-Identifier: GPL-2.0-only -/* - * This program is free software; you can redistribute it and/or modify - * it under the terms of version 2 of the GNU General Public License as - * published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - */ - #include <errno.h> #include <fcntl.h> #include <limits.h> @@ -116,7 +102,7 @@ int main(int argc, char **argv) char *target_fd_end; long int target_fd_l = strtol(argv[optind], &target_fd_end, 10); if (errno) { - fprintf(stderr, "mktuntap: %s\n", strerror(errno)); + perror("mktuntap"); return EX_USAGE; } if (argv[optind][0] == '\0' || target_fd_end[0] != '\0') { @@ -139,30 +125,30 @@ int main(int argc, char **argv) ifr_flags_ |= IFF_VNET_HDR; int tuntap_fd = tuntap_alloc(ifr_name_, open_flags, ifr_flags_); if (tuntap_fd < 0) { - fprintf(stderr, "mktuntap: failed to open tuntap device: %s\n", strerror(errno)); + perror("mktuntap: failed to open tuntap device"); return EX_IOERR; } if (tuntap_fd != target_fd) { if (dup2(tuntap_fd, target_fd) == -1) { - fprintf(stderr, "mktuntap: %s\n", strerror(errno)); + perror("mktuntap"); return EX_IOERR; } if (close(tuntap_fd) == -1) { - fprintf(stderr, "mktuntap: %s\n", strerror(errno)); + perror("mktuntap"); return EX_IOERR; } } if (name_env) { if (setenv("TUNTAP_NAME", ifr_name_, 1) == -1) { - fprintf(stderr, "mktuntap: %s\n", strerror(errno)); + perror("mktunap"); return EX_OSERR; } } execvp(argv[optind + 1], &argv[optind + 1]); - fprintf(stderr, "failed to exec: %s\n", strerror(errno)); + perror("failed to exec"); return EX_OSERR; } -- 2.27.0

2 3

[PATCH wayland] Support virtio_wl display sockets
by Alyssa Ross 27 Jul '20

27 Jul '20

This patch adds libvirtio_wl, which exposes reimplementations of the sendmsg(2) and recvmsg(2) for virtio_wl socket fds. Tests for as much libvirtio_wl functionality as is reasonably possible to test without requiring a working virtio_wl connection are included. (Testing further would require running tests in a VM so that they could talk to the virtio_wl kernel driver, which would be prohibitively complex. virtio_wl socket fds do not actually point to sockets, but to special virtio_wl files. Whenever a display socket operation calls sendmsg() or recvmsg() with a file descriptor and receives an ENOTSOCK error, it retries the operation with the equivalent libvirtio_wl function, in case the file descriptor is a virtio_wl. This is the least invasive way to implement virtio_wl support -- if a normal socket is being used, there will be no change in behaviour. Because virtio_wl doesn't implement every socket feature, some workarounds are currently required to accomodate everything Wayland expects of sockets: * virtio_wl_recvmsg implements the MSG_DONTWAIT flag by setting O_NONBLOCK on the fd, attempting the VIRTWL_IOCTL_RECV operation, and then restoring the fd's original flags. This is obviously race-prone, but there is no reasonable alternative at present. * virtio_wl_sendmsg requires MSG_NOSIGNAL to be set, and ignores it. This is because I think from looking at the code that virtio_wl does not generate SIGPIPE signals, nor does it ever return EPIPE. I could be wrong about this, though. * virtio_wl does not support credential passing -- what would it even mean, considering the other end of the connection is on another (virtual) machine? So wl_client's ucred member will have pid, uid, and gid all set to -1 for a client connected over virtio_wl. * virtio_wl sockets do not support accept(2), so a fallback is used. A proxy program on the host accept(2) on a host socket. When it receives a connection, it attaches the connection socket to the VM, then sends the name of the connected socket over the Wayland display socket. Wayland then receives this name, looks up the connection socket, and uses that as the client connection socket. Additionally, virtio_wl memfd-like file descriptors don't support mremap(2), so for virtio_wl sockets Wayland will munmap(2) the memfd, and then mmap(2) it again. This should be at least mostly okay because Wayland only ever calls mremap with MREMAP_MAYMOVE, but it is still race-prone. To be able to do this, memfds are no longer closed after being mmaped, but are kept around in the wl_shm_pool struct, so that they can be passed to mmap() if required. --- src/connection.c | 4 + src/meson.build | 16 +- src/virtio_wl.c | 344 +++++++++++++++++++++++ src/virtio_wl.h | 23 ++ src/wayland-os.c | 23 ++ src/wayland-os.h | 3 + src/wayland-server.c | 20 +- src/wayland-shm.c | 24 +- tests/meson.build | 1 + tests/virtio_wl-test.c | 615 +++++++++++++++++++++++++++++++++++++++++ 10 files changed, 1064 insertions(+), 9 deletions(-) create mode 100644 src/virtio_wl.c create mode 100644 src/virtio_wl.h create mode 100644 tests/virtio_wl-test.c diff --git a/src/connection.c b/src/connection.c index d0c7d9f..1bfbd8c 100644 --- a/src/connection.c +++ b/src/connection.c @@ -40,6 +40,7 @@ #include <time.h> #include <ffi.h> +#include "virtio_wl.h" #include "wayland-util.h" #include "wayland-private.h" #include "wayland-os.h" @@ -314,6 +315,9 @@ wl_connection_flush(struct wl_connection *connection) do { len = sendmsg(connection->fd, &msg, MSG_NOSIGNAL | MSG_DONTWAIT); + if (len == -1 && errno == ENOTSOCK) + len = virtio_wl_sendmsg(connection->fd, &msg, + MSG_NOSIGNAL | MSG_DONTWAIT); } while (len == -1 && errno == EINTR); if (len == -1) diff --git a/src/meson.build b/src/meson.build index 2d1485c..cca1d93 100644 --- a/src/meson.build +++ b/src/meson.build @@ -71,13 +71,26 @@ if get_option('libraries') mathlib_dep = cc.find_library('m', required: false) threads_dep = dependency('threads', required: false) + virtio_wl = library( + 'virtio_wl', + sources: [ + 'virtio_wl.c', + ], + version: '0.1.0', + install: true, + ) + + virtio_wl_dep = declare_dependency( + link_with: virtio_wl, + ) + wayland_private = static_library( 'wayland-private', sources: [ 'connection.c', 'wayland-os.c' ], - dependencies: [ ffi_dep, ] + dependencies: [ ffi_dep, virtio_wl_dep ] ) wayland_private_dep = declare_dependency( @@ -230,5 +243,6 @@ if get_option('libraries') 'wayland-server-core.h', 'wayland-client.h', 'wayland-client-core.h', + 'virtio_wl.h', ]) endif diff --git a/src/virtio_wl.c b/src/virtio_wl.c new file mode 100644 index 0000000..a1ee8ee --- /dev/null +++ b/src/virtio_wl.c @@ -0,0 +1,344 @@ +/* Copyright 2020 Alyssa Ross + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ + +#define _POSIX_C_SOURCE 200809L + +#include <errno.h> +#include <fcntl.h> +#include <limits.h> +#include <linux/virtwl.h> +#include <stdint.h> +#include <stdlib.h> +#include <string.h> +#include <sys/ioctl.h> +#include <sys/socket.h> +#include <unistd.h> + +#include "virtio_wl.h" + +// This is essentially vendored reusable library code, so I consider +// it exempt from the Wayland style guide. :) + +#if defined(__GNUC__) && __GNUC__ >= 4 +#define VIRTIO_WL_EXPORT __attribute__ ((visibility("default"))) +#else +#define VIRTIO_WL_EXPORT +#endif + +static int +set_nonblocking(int fd) +{ + int fl = fcntl(fd, F_GETFL); + if (fl == -1) + return -1; + if (!(fl & O_NONBLOCK)) + if (fcntl(fd, F_SETFL, fl | O_NONBLOCK) == -1) + return -1; + return fl; +} + +// Returns the total size of all buffers in an iovec. +// A return value of -1 means that the total overflowed. +static ssize_t +iov_len(const struct iovec iov[], size_t n) +{ + size_t len = 0; + for (size_t i = 0; i < n; i++) { + if (SSIZE_MAX - len < iov[i].iov_len) + return -1; + len += iov[i].iov_len; + } + return len; +} + +// Copies from an iovec array into a buffer. +// The buffer is assumed to be large enough to hold all the data. +// This length can be calculated with the iov_len function. +static size_t +iov_flatten(void *buf, size_t buflen, const struct iovec *iov, size_t iovlen) +{ + size_t off = 0; + + for (size_t index = 0; index < iovlen && off < buflen; index++) { + const struct iovec *i = &iov[index]; + size_t rem = buflen - off; + size_t len = i->iov_len < rem ? i->iov_len : rem; + + memcpy((unsigned char *)buf + off, i->iov_base, len); + off += len; + } + + return off; +} + +// Copies from a buffer into an iovec array. +// Returns number of bytes copied. +static size_t +iov_fill(struct iovec *iov, size_t iovlen, const void *buf, size_t buflen) +{ + size_t off = 0; + + for (size_t index = 0; index < iovlen && off < buflen; index++) { + struct iovec *i = &iov[index]; + size_t rem = buflen - off; + size_t len = i->iov_len < rem ? i->iov_len : rem; + + memcpy(i->iov_base, (const unsigned char *)buf + off, len); + off += len; + } + + return off; +} + +static ssize_t +cmsg_to_fdbuf(int *buf, size_t buflen, const struct msghdr *msg) +{ + size_t next_fd = 0; + + for (struct cmsghdr *cmsg = CMSG_FIRSTHDR(msg); + cmsg != NULL; cmsg = CMSG_NXTHDR(msg, cmsg)) { + size_t size = cmsg->cmsg_len - CMSG_LEN(0); + + // Check the cmsg can be handled. + if (cmsg->cmsg_level != SOL_SOCKET || + cmsg->cmsg_type != SCM_RIGHTS || + size % sizeof(int) != 0) { + errno = EINVAL; + return -1; + } + + size_t rem = sizeof(int) * (buflen - next_fd); + size_t len = size > rem ? rem : size; + + // Copy the fds to the buffer. + memcpy(buf + next_fd, CMSG_DATA(cmsg), len); + next_fd += len / sizeof(int); + + if (size > rem) + break; + } + + return next_fd > SSIZE_MAX ? SSIZE_MAX : next_fd; +} + +static size_t +fdbuf_to_cmsg(struct msghdr *msg, const int *buf, size_t buflen) +{ + // Check msg->msg_control is long enough to fit at least one fd. + if (msg->msg_controllen < CMSG_SPACE(sizeof(int))) { + + // If there's at least one fd in buf, set MSG_CTRUNC. + size_t i = 0; + while (i < buflen && !(msg->msg_flags & MSG_CTRUNC)) + if (buf[i++] != -1) + msg->msg_flags |= MSG_CTRUNC; + + return 0; + } + + // cmsg(3): + // > When initializing a buffer that will contain a series of cmsghdr + // > structures (e.g., to be sent with sendmsg(2)), that buffer should + // > first be zero-initialized to en‐ sure the correct operation of + // > CMSG_NXTHDR(). + memset(msg->msg_control, 0, msg->msg_controllen); + + // Set up the cmsg. + struct cmsghdr *cmsg = CMSG_FIRSTHDR(msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + + // Copy as many fds as fit into cmsg. + size_t len = 0; + for (size_t i = 0; i < buflen; i++) { + if (buf[i] == -1) + continue; + + if (CMSG_LEN((len + 1) * sizeof(int)) > msg->msg_controllen) { + msg->msg_flags |= MSG_CTRUNC; + break; + } + + memcpy(CMSG_DATA(cmsg) + sizeof(int) * len, &buf[i], sizeof(int)); + len++; + } + + cmsg->cmsg_len = CMSG_LEN(len * sizeof(int)); + return len; +} + +VIRTIO_WL_EXPORT int +virtio_wl_connect(const char *name, uint32_t flags) +{ + static int wl_fd = -1; + if (wl_fd < 0) + wl_fd = open("/dev/wl0", O_RDWR | O_CLOEXEC); + if (wl_fd < 0) + return wl_fd; + + struct virtwl_ioctl_new new_ctx = { + .type = name ? VIRTWL_IOCTL_NEW_CTX_NAMED : VIRTWL_IOCTL_NEW_CTX, + .fd = -1, + .flags = flags, + }; + // Device assumes name 32 bytes long if not null terminated. + if (name) + strncpy(new_ctx.name, name, sizeof(new_ctx.name)); + + if (ioctl(wl_fd, VIRTWL_IOCTL_NEW, &new_ctx)) + return -1; + + return new_ctx.fd; +} + +VIRTIO_WL_EXPORT int +virtio_wl_send_raw(int sockfd, struct virtwl_ioctl_txn *ioctl_txn) +{ + return ioctl(sockfd, VIRTWL_IOCTL_SEND, ioctl_txn); +} + +static int +msghdr_to_txn(const struct msghdr *msg, struct virtwl_ioctl_txn **txn) +{ + // Make sure that if there's an error and the caller tries to free *txn + // anyway it doesn't end up freeing an invalid address. + *txn = NULL; + + // Figure out how big the txn needs to be. + ssize_t len = iov_len(msg->msg_iov, msg->msg_iovlen); + if (len < 0 || len > UINT32_MAX) { + errno = ENOMEM; + return -1; + } + + // Allocate the txn. + *txn = malloc(sizeof(**txn) + len); + if (!*txn) + return -1; + + // Set the len member of the txn. + (*txn)->len = len; + + // Copy data from the iovec into the transaction. + iov_flatten((*txn)->data, len, msg->msg_iov, msg->msg_iovlen); + + // Copy file descriptors to the txn. + ssize_t fd_count = cmsg_to_fdbuf((*txn)->fds, VIRTWL_SEND_MAX_ALLOCS, msg); + if (fd_count == -1) { + free(*txn); + *txn = NULL; + return -1; + } + + // Fill the rest of the fd buffer with -1. + while (fd_count < VIRTWL_SEND_MAX_ALLOCS) + (*txn)->fds[fd_count++] = -1; + + return 0; +} + +static void +txn_to_msghdr(struct msghdr *msg, const struct virtwl_ioctl_txn *txn) +{ + // Copy txn data to iovecs. + iov_fill(msg->msg_iov, msg->msg_iovlen, txn->data, txn->len); + + // Copy fds to cmsg. + fdbuf_to_cmsg(msg, txn->fds, VIRTWL_SEND_MAX_ALLOCS); +} + +VIRTIO_WL_EXPORT ssize_t +virtio_wl_sendmsg(int sockfd, const struct msghdr *msg, int flags) +{ + int sockfl; + + if ((flags & ~MSG_DONTWAIT) != MSG_NOSIGNAL) { + errno = EINVAL; + return -1; + } + + struct virtwl_ioctl_txn *txn; + if (msghdr_to_txn(msg, &txn) == -1) + return -1; + + if (flags & MSG_DONTWAIT) { + sockfl = set_nonblocking(sockfd); + if (sockfl == -1) { + free(txn); + return -1; + } + } + + int rv = virtio_wl_send_raw(sockfd, txn); + + if ((flags & MSG_DONTWAIT) && !(sockfl & O_NONBLOCK)) { + if (fcntl(sockfd, F_SETFL, sockfl) == -1) { + free(txn); + return -1; + } + } + + if (rv != -1) + rv = txn->len; + + free(txn); + return rv; +} + +VIRTIO_WL_EXPORT int +virtio_wl_recv_raw(int sockfd, struct virtwl_ioctl_txn *ioctl_txn) +{ + return ioctl(sockfd, VIRTWL_IOCTL_RECV, ioctl_txn); +} + +VIRTIO_WL_EXPORT ssize_t +virtio_wl_recvmsg(int sockfd, struct msghdr *msg, int flags) +{ + int sockfl; + + if ((flags & ~MSG_DONTWAIT) != MSG_CMSG_CLOEXEC) { + errno = EINVAL; + return -1; + } + + ssize_t len = iov_len(msg->msg_iov, msg->msg_iovlen); + if (len < 0 || len > UINT32_MAX) { + errno = ENOMEM; + return -1; + } + + struct virtwl_ioctl_txn *txn = malloc(sizeof(*txn) + len); + if (!txn) + return -1; + + txn->len = len; + + if (flags & MSG_DONTWAIT) { + sockfl = set_nonblocking(sockfd); + if (sockfl == -1) { + free(txn); + return -1; + } + } + + ssize_t rv = virtio_wl_recv_raw(sockfd, txn); + + if ((flags & MSG_DONTWAIT) && !(sockfl & O_NONBLOCK)) + if (fcntl(sockfd, F_SETFL, sockfl) == -1) + rv = -1; + + if (rv == -1) { + for (size_t i = 0; i < VIRTWL_SEND_MAX_ALLOCS; i++) + if (txn->fds[i] == -1) + close(txn->fds[i]); + } else { + txn_to_msghdr(msg, txn); + rv = txn->len; + } + + free(txn); + return rv; +} diff --git a/src/virtio_wl.h b/src/virtio_wl.h new file mode 100644 index 0000000..80bcd38 --- /dev/null +++ b/src/virtio_wl.h @@ -0,0 +1,23 @@ +/* Copyright 2020 Alyssa Ross + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ + +#ifndef UTIL_VIRTIO_WL_H +#define UTIL_VIRTIO_WL_H + +#include <sys/types.h> + +struct virtwl_ioctl_txn; +struct msghdr; + +int virtio_wl_connect(const char *name, uint32_t flags); + +ssize_t virtio_wl_sendmsg(int sockfd, const struct msghdr *, int flags); +int virtio_wl_send_raw(int sockfd, struct virtwl_ioctl_txn *); + +ssize_t virtio_wl_recvmsg(int sockfd, struct msghdr *, int flags); +int virtio_wl_recv_raw(int sockfd, struct virtwl_ioctl_txn *); + +#endif diff --git a/src/wayland-os.c b/src/wayland-os.c index 93b6f5f..c92aaae 100644 --- a/src/wayland-os.c +++ b/src/wayland-os.c @@ -31,6 +31,9 @@ #include <fcntl.h> #include <errno.h> #include <sys/epoll.h> +#include <virtio_wl.h> +#include <string.h> +#include <stdio.h> #include "../config.h" #include "wayland-os.h" @@ -126,6 +129,10 @@ wl_os_recvmsg_cloexec(int sockfd, struct msghdr *msg, int flags) len = recvmsg(sockfd, msg, flags | MSG_CMSG_CLOEXEC); if (len >= 0) return len; + + if (errno == ENOTSOCK) + return virtio_wl_recvmsg(sockfd, msg, flags | MSG_CMSG_CLOEXEC); + if (errno != EINVAL) return -1; @@ -165,3 +172,19 @@ wl_os_accept_cloexec(int sockfd, struct sockaddr *addr, socklen_t *addrlen) fd = accept(sockfd, addr, addrlen); return set_cloexec_or_close(fd); } + +int +wl_virtio_accept_cloexec(int sockfd) +{ + char name[32]; + size_t offset = 0; + + while (offset < sizeof name) { + ssize_t size = read(sockfd, name + offset, sizeof name - offset); + if (size < 0) + return size; + offset += size; + } + + return virtio_wl_connect(name, 0); +} diff --git a/src/wayland-os.h b/src/wayland-os.h index f51efaa..899ac8e 100644 --- a/src/wayland-os.h +++ b/src/wayland-os.h @@ -41,6 +41,9 @@ wl_os_epoll_create_cloexec(void); int wl_os_accept_cloexec(int sockfd, struct sockaddr *addr, socklen_t *addrlen); +int +wl_virtio_accept_cloexec(int sockfd); + /* * The following are for wayland-os.c and the unit tests. diff --git a/src/wayland-server.c b/src/wayland-server.c index 3f48dfe..0146ca8 100644 --- a/src/wayland-server.c +++ b/src/wayland-server.c @@ -531,8 +531,18 @@ wl_client_create(struct wl_display *display, int fd) len = sizeof client->ucred; if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, - &client->ucred, &len) < 0) - goto err_source; + &client->ucred, &len) < 0 && errno != ENOTSOCK) { + if (errno == ENOTSOCK) { + // Probably a virtio_wl socket. + // We don't have credential information, so fill with + // values that should never match real ones. + client->ucred.pid = -1; + client->ucred.uid = -1; + client->ucred.gid = -1; + } else { + goto err_source; + } + } client->connection = wl_connection_create(fd); if (client->connection == NULL) @@ -1419,6 +1429,9 @@ socket_data(int fd, uint32_t mask, void *data) length = sizeof name; client_fd = wl_os_accept_cloexec(fd, (struct sockaddr *) &name, &length); + if (client_fd < 0 && errno == ENOTSOCK) + client_fd = wl_virtio_accept_cloexec(fd); + if (client_fd < 0) wl_log("failed to accept: %s\n", strerror(errno)); else @@ -1603,7 +1616,8 @@ wl_display_add_socket_fd(struct wl_display *display, int sock_fd) struct stat buf; /* Require a valid fd or fail */ - if (sock_fd < 0 || fstat(sock_fd, &buf) < 0 || !S_ISSOCK(buf.st_mode)) { + if (sock_fd < 0 || fstat(sock_fd, &buf) < 0 || + ((buf.st_mode & S_IFMT) && !S_ISSOCK(buf.st_mode))) { return -1; } diff --git a/src/wayland-shm.c b/src/wayland-shm.c index b85e5a7..636ee7a 100644 --- a/src/wayland-shm.c +++ b/src/wayland-shm.c @@ -61,6 +61,7 @@ struct wl_shm_pool { int internal_refcount; int external_refcount; char *data; + int fd; int32_t size; int32_t new_size; bool sigbus_is_impossible; @@ -91,14 +92,27 @@ shm_pool_finish_resize(struct wl_shm_pool *pool) data = mremap(pool->data, pool->size, pool->new_size, MREMAP_MAYMOVE); if (data == MAP_FAILED) { - wl_resource_post_error(pool->resource, - WL_SHM_ERROR_INVALID_FD, - "failed mremap"); - return; + if (errno != EFAULT) + goto fail; + + if (munmap(pool->data, pool->size) == -1) + goto fail; + + data = mmap(pool->data, pool->new_size, PROT_READ | PROT_WRITE, + MAP_SHARED, pool->fd, 0); + if (data == MAP_FAILED) + goto fail; } pool->data = data; pool->size = pool->new_size; + + return; + + fail: + wl_resource_post_error(pool->resource, + WL_SHM_ERROR_INVALID_FD, + "failed mremap"); } static void @@ -291,6 +305,7 @@ shm_create_pool(struct wl_client *client, struct wl_resource *resource, pool->external_refcount = 0; pool->size = size; pool->new_size = size; + pool->fd = fd; pool->data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); if (pool->data == MAP_FAILED) { @@ -300,7 +315,6 @@ shm_create_pool(struct wl_client *client, struct wl_resource *resource, strerror(errno)); goto err_free; } - close(fd); pool->resource = wl_resource_create(client, &wl_shm_pool_interface, 1, id); diff --git a/tests/meson.build b/tests/meson.build index 224f48d..6ee2b49 100644 --- a/tests/meson.build +++ b/tests/meson.build @@ -148,6 +148,7 @@ tests = { 'headers-protocol-core-test.c', ], 'os-wrappers-test': [], + 'virtio_wl-test': [], } foreach test_name, test_extra_sources: tests diff --git a/tests/virtio_wl-test.c b/tests/virtio_wl-test.c new file mode 100644 index 0000000..16c7a93 --- /dev/null +++ b/tests/virtio_wl-test.c @@ -0,0 +1,615 @@ +#define _GNU_SOURCE +#include <assert.h> + +#include "test-runner.h" +#include "virtio_wl.c" + +TEST(iov_len_fit) +{ + int f1[] = { 1, 2 }; + int f2[] = { 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof(f1) }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof(f2) }, + }; + + assert(iov_len(iov, sizeof(iov) / sizeof(*iov)) == 3 * sizeof(int)); +} + +TEST(iov_len_overflow) +{ + struct iovec iov[] = { + { .iov_base = NULL, .iov_len = SIZE_MAX }, + { .iov_base = NULL, .iov_len = SIZE_MAX }, + }; + + assert(iov_len(iov, sizeof(iov) / sizeof(*iov)) == -1); +} + +TEST(iov_flatten_test) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof(f1) }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof(f2) }, + }; + + int buf[2]; + iov_flatten(buf, sizeof(buf), iov, sizeof(iov) / sizeof(*iov)); + assert(buf[0] == 1); + assert(buf[1] == 2); +} + +TEST(iov_flatten_zero_iov) +{ + unsigned char buf[] = { 0xFF }; + assert(iov_flatten(buf, 1, NULL, 0) == 0); +} + +TEST(iov_flatten_null_iov) +{ + unsigned char buf[] = { 0xFF }; + struct iovec iov[] = { { .iov_base = NULL, .iov_len = 0 } }; + + assert(iov_flatten(buf, sizeof buf, iov, sizeof(iov) / sizeof(*iov)) == 0); +} + +TEST(iov_flatten_zero_buf) +{ + unsigned char f1[] = { 0 }; + struct iovec iov[] = { { .iov_base = f1, .iov_len = sizeof f1 } }; + + assert(iov_flatten(NULL, 0, iov, sizeof(iov) / sizeof(*iov)) == 0); +} + +TEST(iov_flatten_short_iov) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7, 6 }; + + assert(iov_flatten(buf, sizeof buf, iov, sizeof(iov) / sizeof(*iov)) == 12); + assert(buf[0] == 1); + assert(buf[1] == 2); + assert(buf[2] == 3); + assert(buf[3] == 6); +} + +TEST(iov_flatten_exact_iov) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7 }; + + assert(iov_flatten(buf, sizeof buf, iov, sizeof(iov) / sizeof(*iov)) == 12); + assert(f1[0] == 1); + assert(f2[0] == 2); + assert(f2[1] == 3); +} + +TEST(iov_flatten_long_iov) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3, 4 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7 }; + + assert(iov_flatten(buf, sizeof buf, iov, sizeof(iov) / sizeof(*iov)) == 12); + assert(buf[0] == 1); + assert(buf[1] == 2); + assert(buf[2] == 3); +} + +TEST(iov_fill_zero_iov) +{ + unsigned char buf[] = { 0xFF }; + assert(iov_fill(NULL, 0, buf, 1) == 0); +} + +TEST(iov_fill_null_iov) +{ + unsigned char buf[] = { 0xFF }; + struct iovec iov[] = { { .iov_base = NULL, .iov_len = 0 } }; + + assert(iov_fill(iov, sizeof(iov) / sizeof(*iov), buf, sizeof buf) == 0); +} + +TEST(iov_fill_zero_buf) +{ + unsigned char f1[] = { 0 }; + struct iovec iov[] = { { .iov_base = f1, .iov_len = sizeof f1 } }; + + assert(iov_fill(iov, sizeof(iov) / sizeof(*iov), NULL, 0) == 0); +} + +TEST(iov_fill_short_iov) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7, 6 }; + + assert(iov_fill(iov, sizeof(iov) / sizeof(*iov), buf, sizeof buf) == 12); + assert(f1[0] == 9); + assert(f2[0] == 8); + assert(f2[1] == 7); +} + +TEST(iov_fill_exact) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7 }; + + assert(iov_fill(iov, sizeof(iov) / sizeof(*iov), buf, sizeof buf) == 12); + assert(f1[0] == 9); + assert(f2[0] == 8); + assert(f2[1] == 7); +} + +TEST(iov_fill_long_iov) +{ + int f1[] = { 1 }; + int f2[] = { 2, 3, 4 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = NULL, .iov_len = 0 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + int buf[] = { 9, 8, 7 }; + + assert(iov_fill(iov, sizeof(iov) / sizeof(*iov), buf, sizeof buf) == 12); + assert(f1[0] == 9); + assert(f2[0] == 8); + assert(f2[1] == 7); + assert(f2[2] == 4); +} + +TEST(cmsg_to_fdbuf_zero_buf) +{ + int fds[] = { 0 }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + + assert(cmsg_to_fdbuf(NULL, 0, &msg) == 0); +} + +TEST(cmsg_to_fdbuf_zero_cmsg) +{ + int fds[2] = { 0 }; + struct msghdr msg = { 0 }; + assert(cmsg_to_fdbuf(fds, sizeof fds, &msg) == 0); +} + +TEST(cmsg_to_fdbuf_small_buf) +{ + int fds[] = { 0, 1 }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + + int buf[] = { 0xFF }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == 1); + assert(buf[0] == 0); +} + +TEST(cmsg_to_fdbuf_exact) +{ + int fds[] = { 0, 1 }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + + int buf[] = { 0xFF, 0xFE }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == 2); + assert(buf[0] == 0); + assert(buf[1] == 1); +} + +TEST(cmsg_to_fdbuf_small_cmsg) +{ + int fds[] = { 0 }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + + int buf[] = { 0xFF, 0xFE }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == 1); + assert(buf[0] == 0); + assert(buf[1] == 0xFE); +} + +TEST(cmsg_to_fdbuf_multiple_cmsg) +{ + int f1[] = { 0 }; + int f2[] = { 1 }; + + union { + char buf[CMSG_SPACE(sizeof f1) + CMSG_SPACE(sizeof f2)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg1 = CMSG_FIRSTHDR(&msg); + cmsg1->cmsg_level = SOL_SOCKET; + cmsg1->cmsg_type = SCM_RIGHTS; + cmsg1->cmsg_len = CMSG_LEN(sizeof f1); + memcpy(CMSG_DATA(cmsg1), f1, sizeof f1); + + struct cmsghdr *cmsg2 = CMSG_NXTHDR(&msg, cmsg1); + cmsg2->cmsg_level = SOL_SOCKET; + cmsg2->cmsg_type = SCM_RIGHTS; + cmsg2->cmsg_len = CMSG_LEN(sizeof f2); + memcpy(CMSG_DATA(cmsg2), f2, sizeof f2); + + int buf[] = { 0xFF, 0xFE }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == 2); + assert(buf[0] == 0); + assert(buf[1] == 1); +} + +TEST(cmsg_to_fdbuf_other_cmsg) +{ + struct ucred cred = { + .pid = getpid(), + .uid = getuid(), + .gid = getgid(), + }; + + int fds[] = { 0, 1 }; + + union { + char buf[CMSG_SPACE(sizeof cred) + CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg1 = CMSG_FIRSTHDR(&msg); + cmsg1->cmsg_level = SOL_SOCKET; + cmsg1->cmsg_type = SCM_CREDENTIALS; + cmsg1->cmsg_len = CMSG_LEN(sizeof cred); + memcpy(CMSG_DATA(cmsg1), &cred, sizeof cred); + + struct cmsghdr *cmsg2 = CMSG_NXTHDR(&msg, cmsg1); + cmsg2->cmsg_level = SOL_SOCKET; + cmsg2->cmsg_type = SCM_RIGHTS; + cmsg2->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg2), fds, sizeof fds); + + int buf[] = { 0xFF, 0xFE }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == -1); + assert(errno == EINVAL); +} + +TEST(cmsg_to_fdbuf_misaligned) +{ + int fds[] = { 0, 1 }; + + union { + char buf[CMSG_SPACE(sizeof fds + 1)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof(fds) + 1); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + CMSG_DATA(cmsg)[sizeof(fds)] = 0; + + int buf[] = { 0xFF, 0xFE }; + assert(cmsg_to_fdbuf(buf, sizeof(buf) / sizeof(*buf), &msg) == -1); + assert(errno == EINVAL); +} + +TEST(fdbuf_to_cmsg_null_cmsg) +{ + struct msghdr msg = { 0 }; + int fds[] = { 1 }; + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 0); + assert(msg.msg_flags & MSG_CTRUNC); +} + +TEST(fdbuf_to_cmsg_empty_both) +{ + struct msghdr msg = { 0 }; + int fds[] = { -1 }; + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 0); + assert(!(msg.msg_flags & MSG_CTRUNC)); +} + +TEST(fdbuf_to_cmsg_null_buf) +{ + union { + char buf[CMSG_SPACE(sizeof(int))]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + assert(fdbuf_to_cmsg(&msg, NULL, 0) == 0); + assert(!(msg.msg_flags & MSG_CTRUNC)); +} + +TEST(fdbuf_to_cmsg_tiny_msg) +{ + union { + char buf[1]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + int fds[] = { 1 }; + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 0); + assert(msg.msg_flags & MSG_CTRUNC); +} + +TEST(fdbuf_to_cmsg_small_msg) +{ + union { + char buf[CMSG_SPACE(sizeof(int))]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + int fds[] = { 1, 2, 3 }; + assert(CMSG_SPACE(sizeof fds) != sizeof u.buf); + + // CMSG_SPACE(sizeof(int)) can equal CMSG_SPACE(sizeof(int) * 2) + size_t n = fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)); + assert(CMSG_SPACE(n * sizeof(int)) == sizeof u.buf); + assert(msg.msg_flags & MSG_CTRUNC); +} + +TEST(fdbuf_to_cmsg_equal) +{ + int fds[] = { 1, 2 }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 2); + assert(!memcmp(CMSG_DATA(CMSG_FIRSTHDR(&msg)), fds, sizeof fds)); + assert(!(msg.msg_flags & MSG_CTRUNC)); +} + +TEST(fdbuf_to_cmsg_negative_one) +{ + int fds[] = { 1, -1, -1, 2 }; + + union { + char buf[CMSG_SPACE(2 * sizeof(int))]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 2); + + unsigned char *data = CMSG_DATA(CMSG_FIRSTHDR(&msg)); + assert(!memcmp(data, &fds[0], sizeof(int))); + assert(!memcmp(data + sizeof(int), &fds[3], sizeof(int))); + assert(!(msg.msg_flags & MSG_CTRUNC)); +} + +TEST(fdbuf_to_cmsg_small_buf) +{ + int fds[] = { 1 }; + + union { + char buf[CMSG_SPACE(2 * sizeof fds)]; + struct cmsghdr align; + } u = { 0 }; + + struct msghdr msg = { 0 }; + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + assert(fdbuf_to_cmsg(&msg, fds, sizeof(fds) / sizeof(*fds)) == 1); + assert(!memcmp(CMSG_DATA(CMSG_FIRSTHDR(&msg)), fds, sizeof fds)); + assert(!(msg.msg_flags & MSG_CTRUNC)); +} + +TEST(msghdr_to_txn_test) +{ + struct virtwl_ioctl_txn *txn; + + int f1[] = { 1 }; + int f2[] = { 2, 3 }; + + const int fds[] = { 0, 1, 2 }; + + struct iovec iov[] = { + { .iov_base = f1, .iov_len = sizeof f1 }, + { .iov_base = f2, .iov_len = sizeof f2 }, + }; + + union { + char buf[CMSG_SPACE(sizeof fds)]; + struct cmsghdr align; + } u; + + struct msghdr msg = { 0 }; + msg.msg_iov = iov; + msg.msg_iovlen = sizeof(iov) / sizeof(*iov); + msg.msg_control = u.buf; + msg.msg_controllen = sizeof u.buf; + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof fds); + memcpy(CMSG_DATA(cmsg), fds, sizeof fds); + + assert(!msghdr_to_txn(&msg, &txn)); + + assert(txn->len == sizeof(f1) + sizeof(f2)); + assert(!memcmp(txn->fds, fds, sizeof fds)); + for (size_t i = sizeof(fds) / sizeof(*fds); + i < VIRTWL_SEND_MAX_ALLOCS; i++) + assert(txn->fds[i] == -1); + assert(!memcmp(txn->data, f1, sizeof f1)); + assert(!memcmp(txn->data + sizeof f1, f2, sizeof f2)); +} + +TEST(txn_to_msghdr_test) +{ + const int data[] = { 1, 2, 3 }; + + size_t len = sizeof(data); + struct virtwl_ioctl_txn *txn = malloc(sizeof(*txn) + len); + assert(txn); + + txn->len = len; + + const int fds[] = { 0, 1, 2 }; + memcpy(txn->fds, fds, sizeof fds); + for (int i = sizeof(fds) / sizeof(*fds); i < VIRTWL_SEND_MAX_ALLOCS; i++) + txn->fds[i] = -1; + + memcpy(txn->data, data, sizeof data); + + int buf1[1], buf2[2]; + + struct iovec iov[] = { + { .iov_base = buf1, .iov_len = sizeof buf1 }, + { .iov_base = buf2, .iov_len = sizeof buf2 }, + }; + + unsigned char cmsg_buf[VIRTWL_SEND_MAX_ALLOCS]; + + struct msghdr msg = { 0 }; + msg.msg_iov = iov; + msg.msg_iovlen = sizeof(iov) / sizeof(*iov); + msg.msg_control = cmsg_buf; + msg.msg_controllen = sizeof cmsg_buf; + + txn_to_msghdr(&msg, txn); + + assert(!memcmp(buf1, data, sizeof buf1)); + assert(!memcmp(buf2, (unsigned char *)data + sizeof buf1, sizeof buf2)); + + struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg); + assert(cmsg->cmsg_level == SOL_SOCKET); + assert(cmsg->cmsg_type == SCM_RIGHTS); + assert(cmsg->cmsg_len == CMSG_LEN(3 * sizeof(int))); + for (int i = 0; i < 3; i++) + assert(!memcmp(CMSG_DATA(cmsg), fds, sizeof fds)); + + assert(!CMSG_NXTHDR(&msg, cmsg)); +} -- 2.26.2

2 4

This Week in Spectrum, 2020-W30
by Alyssa Ross 27 Jul '20

27 Jul '20

Feels like there's a pretty clear path forward. Nice feeling. :) QEMU ---- Last week, as I wrote TWiS, I had just discovered virtio-vhost-user, which looked like a very promising mechanism for getting a VM to take care of networking for other VMs. This week, I've been researching it further, and trying to test and evaluate it. The first thing I tried to do, naturally, was to build the patched QEMU tree and boot a VM with a virtio-vhost-user device attached. This was not as easy as I'd hoped, because adding the virtio-vhost-user device to my QEMU command line made the VM kernel panic at boot, with an error message about an invalid memory access. I spent most of the week trying to figure this out -- I wasn't doing anything different to the example[1] on the QEMU wiki, so it should have worked, and it felt like if I could just get past whatever was going wrong here, it would be worth it, because virtio-vhost-user otherwise seems so suited for what we need here. I emailed the patch author[2], but he didn't know what was up either. An early breakthrough came when I got frustrated with kernel builds taking hours on my 8-year-old laptop, and so decided to work on a more powerful computer instead. Once I got everything set up on that computer, I started up the VM, and it worked. Perhaps in setting it up over here I'd done something different? I copied over the exact VM disk/kernel/initrd/command line that I was running on my laptop, and the other computer booted it just fine. I had -cpu host in the QEMU command line, so I thought maybe the different kind of virtual CPU was causing it. Tried setting it to a specific value on both machines, and still the laptop VM panicked and the other didn't. So it sounded like whether it worked or not depended on the host hardware. I put together a Nix derivation that would automatically build the custom QEMU and output a script that would run a VM, and then asked people in #spectrum to test it out on various computers. After getting some further data, a pattern started to emerge, where Intel processors Ivy Bridge and older would fail, and Skylake and newer would succeed (I didn't encounter any AMD processors that failed, nor did I have data at the time for generations between Ivy Bridge and Skylake). This theory had a convenient explanation for why nobody else had seen this problem -- I doubt people at Red Hat are working on 7-year-old hardware. This was a good clue, but still didn't put me much closer to having a working system. I do have a more recent laptop around, but for reasons that are out of scope here it would be very inconvenient to decide to just move over to it. I could see that the kernel was panicking the first time it tried to access the PCI BARs of the virtio-vhost-user, which led me to believe that the problem was probably in how that memory was being set up. I found the function that did that[3], and stared at it for a long time. I tried to read the rest of the QEMU code, but it became clear that my domain knowledge here isn't good enough to be able to keep track of what's meant to be happening. I added some debug prints, which were vaguely helpful in making that understanding a little better. I was hoping to find the guest address each PCI BAR was mapped to so that I could check the kernel was trying to write to the right location, but didn't manage to do that. While attempting to, though, I did add a debug print that printed the size of each PCI bar as it was allocated. I noticed that most were small -- 16 MiB at most, but one was huge, at 64 GiB! The code that allocated this BAR was part of the function I'd been staring at. As far as I could tell, the choice of size was pretty arbitrary -- this big memory region was used as backing memory for all sorts of small objects on the fly. On a whim, I tried changing the BAR size from 1ULL << 36 to 1ULL << 26, and recompiled QEMU. The VM booted. The comment above the bar_size definition that I'd been looking at for so long said: /* TODO If the BAR is too large the guest won't have address space to map * it! */ I don't know if that's exactly what went wrong here, though. I suspect it's more like the host architecture doesn't have enough address space? The affected machines all reported 36 bit physical address size, and 48 bit virtual address size. So maybe what's happening is that the processor interprets PCI addresses in the hardware-assisted VM as physical addresses, and therefore runs out of space because all of it is taken up by this one PCI bar? I'm not really sure. Lowering the bar size to 2^35 or 2^34 (has to be a power of two) depending on the QEMU version made the problem go away, and that's good enough for now. I'm not very enthusiastic about this up-front allocation of a huge amount of memory that might not even fit in the available address space. I don't know if there's a better way of doing it in this case, but I certainly hope so. In general I think this perhaps demonstrates why this code is not considered suitable for "production" yet. The bet I'm taking here is that by the time Spectrum is further along, things will have moved on for virtio-vhost-user too. As I said, at some point we will want to implement it in crosvm to avoid having QEMU in the TCB, but it would be a bad idea to do that now while virtio-vhost-user is still going through the back-and-forth of making its way into the Virtio spec. [1]: https://wiki.qemu.org/Features/VirtioVhostUser [2]: https://lore.kernel.org/qemu-devel/87h7u1s5k1.fsf@alyssa.is/T/#u [3]: https://github.com/ndragazis/qemu/blob/f9ab08c0c8/hw/virtio/virtio-vhost-us… DPDK ---- Once I was able to boot a VM with the virtio-vhost-user device, I tried to connect another QEMU VM to it through vhost-user -- I'll want to have this working first as a reference before I start porting Cloud Hypervisor's vhost-user implementation to crosvm. But the "frontend" (vhost-user) QEMU process hung waiting for a reply on the vhost-user socket from the backend one. Not really knowing what to do about this, I decided that maybe I'd been a bit too ambitious in going straight for vhost-user <-> virtio-vhost-user when I'd never actually used vhost-user before, so maybe I should try a more conventional vhost-user setup first. As far as I can tell, vhost-user is usually used for connecting a VM to a userspace networking stack. And usually, this networking stack is DPDK, the "Data Plane Development Kit"[4]. DPDK was also used in the virtio-vhost-user examples, so I figured my next step would be to try it there as well, and therefore it was worth the time in learning how to do a very basic setup with it. Quick start -style documentation for this was pretty lacking, but I did eventually manage to make this work. Here's what I did, for my own future reference as much as anything else: (1) Make some hugepages available. 1GiB for DPDK and 1GiB for QEMU: echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages (2) Take my ethernet interface offline so it could be used with DPDK: nmcli d disconnect enp0s25 (3) Load the vfio-pci module, which allows PCI devices to be exported to userspace rather than managed by the kernel: mobprobe vfio-pci (4) Export the ethernet interface: usertools/dpdk-devbind.py -b vfio-pci enp0s25 (5) Run testpmd, a program that comes with DPDK mostly used for debugging and tracing it seems, but that with no special arguments acts as a simple packet forwarder. Here I create a vhost-user socket, and forward traffic between vhost-user and my ethernet interface: build/app/dpdk-testpmd -l 0,1 -w 00:19.0 \ --vdev net_vhost0,iface=/run/vhost-user0.sock The -w value is the PCI address of the ethernet interface. Note how "00:19" corresponds to "p0s25". (19 in hex is 25 is decimal.) (6) Start a VM. The relevant QEMU flags appear to be: -chardev socket,id=char0,path=/run/vhost-user0.sock \ -netdev type=vhost-user,id=net0,chardev=char0,vhostforce \ -device virtio-net-pci,netdev=net0 \ -object memory-backend-file,id=mem0,size=1024M,mem-path=/dev/hugepages,share=on \ -numa node,memdev=mem0 \ -mem-prealloc I figured this all out mostly from a guide for a DPDK benchmark[5]. I have not yet experimented with variations on the QEMU flags yet. I'm not sure if all the memory flags are required -- -mem-prealloc might just be there because it was important for a benchmark, for example. So this is the point I'm at with this exploration. Next up, I'll be trying with DPDK inside a VM with a virtio-vhost-user device. I think that maybe, despite the virtio-vhost-user device showing up as an ethernet device inside the VM, it needs some special support which is available for DPDK as a patchset, but that has not been written for the kernel yet. I was a bit worried about this, because unlike the kernel, DPDK isn't going to have things that Wi-Fi drivers for all sorts of different hardware, and so using DPDK instead of the kernel network stack would be a problem. But then I learned that DPDK has a component called the Kernel Native Interface (KNI) which allows it to use network interfaces from the kernel, so a hybrid approach would be possible, and is what I think we'll end up using for now. Then, once virtio-vhost-user is a bit more mature, a kernel driver will probably show up, and we can use that instead and drop DPDK. [4]: https://dpdk.org/ [5]: https://doc.dpdk.org/guides/howto/pvp_reference_benchmark.html?highlight=pvp Website ------- I was having a conversation about Spectrum yesterday, and I found myself sending over a bunch of links to articles and papers that I often find myself referring to when talking to somebody about Spectrum. This made me think that maybe there should be some place where we keep all these relevant articles. So I mined the IRC logs, the TWiS archive, and my blog, and added whatever I could pull from my brain, and wrote a Spectrum bibliography, containing 27 links to interesting articles and papers that are particularly relevant to Spectrum. This isn't on the website quite yet, but I did sent this as a patch[6] to the mailing list, if you want an early look. I also posted a patch to fix a minor issue where I'd mistakenly used ".." instead of "." as href values, to no user-visible effect[7]. [6]: https://spectrum-os.org/lists/archives/spectrum-devel/20200726045701.32259-… [7]: https://spectrum-os.org/lists/archives/spectrum-devel/20200726055410.20641-… Documentation ------------- On Monday, I had a call with the Free Software Foundation Europe. They're a part of NGI Zero (where my funding comes from), and they are promoting their new "REUSE" specification[8] for license information in free software projects to NGI Zero projects. It basically covers standardised per-file license and copyright annotations, and a standard way of including license texts. I think this is really cool! It's something I've been unsure of how to handle because it's all vague conventions that are different in different circles, and it's nice to see something formalised about it. They also have an automated tool[9] for checking compliance and semi-automatically adding license information, which is great! So I'm enthusiastically adopting the REUSE specification. I decided that our smaller, first-party repositories (the documentation, the website, etc.) would be a good place to get started, and so I posted a patch[10] that makes the documentation repository REUSE-compliant. [8]: https://reuse.software/ [9]: https://git.fsfe.org/reuse/tool [10]: https://spectrum-os.org/lists/archives/spectrum-devel/20200726105527.27432-… mktuntap -------- I posted a patch[11] to make mktuntap REUSE-compliant. [11]: https://spectrum-os.org/lists/archives/spectrum-devel/20200726110123.30159-… The thing that's most on my mind this week is the extent to which I'm learning about and working on software like QEMU and DPDK that I don't see having a place in Spectrum in the long run. It's counterintuitive, but this is definitely worth it. There's no point writing a kernel driver for virtio-vhost-user (should such a thing be required) right now, because if I use DPDK for now instead, at some point either virtio-vhost-user will end up not being the thing that gets adopted by the ecosystem and we'll have to move to something else, or (more likely) it gets widely adopted and somebody else writes a kernel driver. Similarly, using QEMU for network VMs is the smart choice even though I don't want it to end up in the TCB, because even though I'm probably going to end up implementing virtio-vhost-user in crosvm later, swapping out QEMU is going to be so easy later that it would be a very bad idea to implement that now in case virtio-vhost-user doesn't take off. But it still /feels/ weird to be using QEMU for this stuff, you know?

1 0

This Week in Spectrum, 2020-W29
by Alyssa Ross 20 Jul '20

20 Jul '20

This has been a week of thinking I wanted to do one thing, not being sure how to do it, and finding out that there was a better way. I'll write it up in the order it happened. crosvm ------ Last week, I described that I wanted to implement a virtio proxy to be able to allow a kernel in an application VM to use a virtual device in another VM. I was wondering how to manage virtio buffers, and thought that I probably wanted an allocator to be able to manage throwing buffers of different sizes around. This turned out to be a case of the XY problem[1]. I couldn't find a good solution, but it turned out that an allocator wasn't what I wanted anyway. edef pointed out that I could just make the shared memory I allocated as big as necessary to hold buffers of the maximum size I wanted to support. The kernel will only actually allocate pages as they are written to, and I could use fallocate[2] with FALLOC_FL_PUNCH_HOLE to tell the kernel it can drop pages when I'm done with them. This would mean that an unusually large buffer would only take up lots of memory while it was in use, and as soon as it was done with, the kernel would be able to take back the memory. So exactly what I wanted from an allocator, but with no need for an allocator at all! This made the implementation much simpler, and by Friday I was able to get the proxy into a state where it could pass unit tests that transported messages in both directions through it. And then it was suggested to me that maybe a virtio proxy is not what I want after all. The main disadvantage to a virtio proxy is that it requires context switching to the host to send data between VMs. This is a trade-off I was aware of, but a virtio proxy is pretty straightforward to write as inter-VM communication systems go, and I was not aware of anything else that would be up to the job. As it turns out, there is something. vhost-user is a mechanism for connecting, say, a virtio device to a userspace network stack in a performant way. I was aware of this, but what I was not aware of was virtio-vhost-user[3]. virtio-vhost-user is a proposed mechanism to allow a VMM to forward a vhost-user backend to a VM. This means that two VMs could directly share virtqueues, with no host copy step. This would mean there would be no opportunity for the host to mediate communication between two guests, but that wasn't really on the cards anyway -- if it's ever required, a virtio proxy would probably be the way to go. For all the other cases, virtio-vhost-user would be a faster, cleaner way of sharing network devices between VMs. The main problem with virtio-vhost-user is that it's still in its infancy. There's a patchset[4] implementing it for QEMU that's a couple of years old, but that has not been accepted upstream. The main blocker for this seems to be first standardising it in the Virtio spec[5][6]. The good news here is that the standardisation process seems to be progressing actively at the moment. It's being discussed on the virtio-dev mailing list basically right now, with the most recent emails dated Friday (unfortunately, I don't know of a good web archive with virtio-dev, but you can find the thread on Gmane if you're interested but not subscribed to the list). The good news is that virtio-vhost-user mostly works by composing things that already exist. There's no kernel work required, because devices are just exposed by the VMM as regular virtio devices. The frontend VM (i.e. the one that uses the virtual device, as opposed to the one that provides it) doesn't need any special virtio-vhost-user support, because it just needs to speak normal vhost-user. Only the backend VM needs support for virtio-vhost-user, because its VMM needs to expose the vhost-user backend from the host to that VM. This means that provisionally using virtio-vhost-user in Spectrum actually looks very feasible, with a couple of compromises. For evaluation purposes, it's not worth writing a virtio-vhost-user device for crosvm. But, the VMs that need that device are the ones that are very specialised -- VMs that manage networking or block devices or similar. So for these VMs, for now, we could use QEMU, with the virtio-vhost-user patch. I investigated what it would take to port it to the most recent QEMU version, and the answer appears to be "not much at all". Obviously having two VMMs in the Trusted Computing Base (TCB) isn't something we'd want in the long term, but it would be fine for, say, reaching the next funding milestone. If we decide that virtio-vhost-user is the way to go after all, support in crosvm can be added then -- in general, adding a new virtio device to crosvm isn't a huge undertaking. Earlier, I said that the application side of the communication doesn't need anything special, because to that it's just regular vhost-user. This is true, but I glossed over there that crosvm doesn't actually implement vhost-user. Implementing vhost-user in crosvm would probably be a big deal at this stage, and not something I feel would be a good use of my time. BUT! Remember, crosvm has two children: Amazon's Firecracker[7], and at so-called "serverless" computing; and Intel's Cloud Hypervisor[8], which aims at traditional, full system server virtualisation. And both of these children inherited the crosvm device model from their parents, and Cloud Hypervisor implements vhost-user[9]. So I _think_ it should be possible to pretty much lift the vhost-user implementation from Cloud Hypervisor, and use it in crosvm. Pretty neat! So, the setup I'd like to evaluate is QEMU with the virtio-vhost-user patch on one side, and crosvm with Cloud Hypervisor's vhost-user implementation on the other. It might well be that there are complications here. If there are, I'll probably just finish the proxy and move on for now, because I want to keep up the pace. I do think that virtio-vhost-user is probably the way to do interguest networking in the long-term, though. Another thing that I've realised is that I don't need to worry about pulling bits out of crosvm to run in other VMs. I focused a lot on that towards the beginning of the year, mostly motivated by Wayland, because the virtio wayland implementation in crosvm is the only one there is. Now that that works in a different way, though, there's no need to continue down this path, because things like networking can be done in more normal ways through virtio and the device VM kernel. [1]: https://en.wikipedia.org/wiki/XY_problem [2]: https://man7.org/linux/man-pages/man2/fallocate.2.html [3]: https://wiki.qemu.org/Features/VirtioVhostUser [4]: https://github.com/stefanha/qemu/compare/master...virtio-vhost-user [5]: https://lists.nongnu.org/archive/html/qemu-devel/2019-04/msg03082.html [6]: https://docs.oasis-open.org/virtio/virtio/v1.1/csprd01/virtio-v1.1-csprd01.… [7]: https://firecracker-microvm.github.io/ [8]: https://github.com/cloud-hypervisor/cloud-hypervisor [9]: https://github.com/cloud-hypervisor/cloud-hypervisor/blob/b4d04bdff6a7e2c3d… Overall, it's been frustrating for me to try things, and discover they're not going to work, or not going to work as well as some other thing, and make a call on whether to keep going on something I know is the worse option or switch to the better thing. I have to keep reminding myself that Spectrum is a research project, and there are always going to be false starts like this. Lots of what we're doing is either very unusual (virtio-vhost-user) or brand new (interguest Wayland), after all.

1 0

This Week in Spectrum,
by Alyssa Ross 13 Jul '20

13 Jul '20

After I got an isolated Wayland compositor working last week, I wasn't really sure what to do next -- this was a big piece of work that I'd been very focused on for a while. The funding milestone I'm closest to is to do with implementing hardware isolation, which the Wayland work was a part of, so I decided to keep going with that, and explore other types of isolation. More on that in a bit. Wayland ------- Posted my patch for virtio_wl display socket support in libwayland-server[1]. This is what allows it to run in a VM, and receive connections from clients in other VMs. The patch description is very extensive, so I recommend reading it for more detail if you're interested. It introduces a libvirtio_wl, which should also be useful for porting other programs that we might want to communicate with across a VM boundary, if they are written with normal Unix sockets in mind (including transferring file descriptors). This is the evolution of code I previously had put in wlroots, moved to Wayland for convenience. If it ever acquires another user (or maybe even if it doesn't) it might make sense to make it its own package, since virtio_wl is useful even if Wayland isn't involved. [1]: https://spectrum-os.org/lists/archives/spectrum-devel/SJ0PR03MB5581479F3388… crosvm ------ I pushed all my crosvm changes to get the isolated compositor working to the work-in-progress "interguest" branch[2]. Remember, I only got it working last week right before I needed to start writing the TWiS email, so I hadn't even done that yet! I also posted some patches[3] to the list to fix a bug in my previous crosvm deadlock fix, and to improve some related documentation. As usual, these were kindly reviewed by Cole. Next, I turned my attention to other forms of hardware isolation. Wayland was a bit special, because despite crosvm including a virtual "Wayland device", it's not really hardware, and so it required an approach to isolation that will be quite different to other crosvm virtual devices. My hope is that other virtual devices should all be substantially similar to each other. The basic idea for actual hardware isolation is that rather than having drivers in the host kernel for USB, network devices, etc. those will be exposed to dedicated VMs as virtual PCI devices. This should substantially reduce host kernel attack surface. crosvm virtual devices will be run in these device VMs, and communicate over virtio with application VMs as normal. This will require implementing in crosvm a virtio proxy device, than allows for the crosvm running an application VM to forward virtio communication to the virtual device running in userspace in the driver VM. (The reason devices aren't attached to application VMs directly but run in seperate device VMs is that hardware is probably not going to be very happy if multiple kernels are trying to talk to it at the same time. Additionally, this indirection means that application VMs only have to use the one virtio driver for that device category, rather than any of the hundreds of drivers for different hardware in that category. If one of those drivers had a vulnerability, this should help to contain it to the device VM.) So I started writing this virtio proxy. The basic idea is to copy virtio buffers from application VM guest memory into memory that can be shared with the userspace virtual device in the device VM. I can't find any prior art on this (which is not unusual -- not many systems isolate drivers in this way), so this has required a lot of looking back at the virtio paper[4] and spec[5] to make sure I understand what to do here. As I write this, the next problem to solve is integrating some sort of memory allocator that can manage buffer allocations in the shared memory that the virtual device looks at. This is a new area for me that I'd appreciate advice on if anybody can give it -- think of it like, I have a memfd, mmaped into my process, and I would like to dynamically allocate and release memory buffers of dynamic sizes in that region. I'm sure there's a library I'll be able to plug in for this. [2]: https://spectrum-os.org/git/crosvm/?h=interguest [3]: https://spectrum-os.org/lists/archives/spectrum-devel/SJ0PR03MB55819DE7E13B… [4]: https://www.ozlabs.org/~rusty/virtio-spec/virtio-paper.pdf [5]: https://docs.oasis-open.org/virtio/virtio/v1.1/csprd01/virtio-v1.1-csprd01.… As usual, big thank you to Cole for reviewing patches, and for finding room for improvement even in languages/areas he isn't familiar with. It feels nice to have done some thinking about the project at a slightly higher level than I have been recently, and to know where I am on the way to the next milestone. Having taken a lot of time away from the milestone list this year to work on fundamentals, it's good to feel like I'm getting back on track.

1 0

[PATCH crosvm 0/2] Fix deadlock on early VmRequest
by Alyssa Ross 09 Jul '20

09 Jul '20

This is the problem you might have seen me complaining about on IRC a couple of days ago. A detailed explanation of the issue and the fix can be found in the second patch message. The fix consists of two patches. The first just adds an API that's needed by the refactored, fixed code. The actual bug fix is in the second patch. Alyssa Ross (2): msg_socket: introduce UnixSeqpacketExt crosvm: fix deadlock on early VmRequest devices/src/virtio/block.rs | 5 + msg_socket/src/lib.rs | 52 ++++++---- src/linux.rs | 201 ++++++++++++++++++++++++++++++------ vm_control/src/lib.rs | 57 +++++++--- 4 files changed, 245 insertions(+), 70 deletions(-) -- 2.26.2

3 10

[PATCH crosvm 1/2] sys_util: make UnixSeqpacket::recv use libc::recv
by Alyssa Ross 08 Jul '20

08 Jul '20

It's very surprising that a method called "recv" would end up calling read(). When UnixSeqpacket was introduced in 1d44223f9, the method was called "read", so this behaviour made more sense. It was renamed to "recv" in b7196e2a1, but the implementation was not changed to call libc::recv. In most cases, according to recv(2), the difference between read() and recv() doesn't matter: > The only difference between recv() and read(2) is the presence of > flags. With a zero flags argument, recv() is generally equivalent > to read(2) (but see NOTES). But the NOTES section explains that > If a zero-length datagram is pending, read(2) and recv() with a > flags argument of zero provide different behavior. In this > circumstance, read(2) has no effect (the datagram remains pending), > while recv() consumes the pending datagram. This means that, while we might expect UnixSeqpacket::recv(&mut []) to mirror the behaviour of recv() and discard a message despite the empty buffer, it would actually leave it there. This became relevant when I implemented the startup message queue in 5bd2e7f60, because I used an empty recv to drop the ready message from the socket, since it was only used for polling and I didn't care about the content. But, it turns out that my UnixSeqpacket::recv call did nothing, and left the message on the socket. This wasn't immediately noticeable, but it meant that when a message came through on the control socket later, it would actually get the ready message from UnixSeqpacket::recv, rather than the expected message on the control socket. For example, trying to use crosvm disk resize would print a message like the following: > [ERROR:vm_control/src/lib.rs:649] unexpected disk socket result: Ready > [ERROR:devices/src/virtio/block.rs:334] Attempted to resize read-only block device We can see that it does try to process the received message, but first it tries to do something with the Ready message, which should have been discarded by now. With this fix applied, we can see that it now receives and tries to process the correct message (but then fails because the VM I tested didn't support disk resizing!): > [ERROR:devices/src/virtio/block.rs:334] Attempted to resize read-only block device Fixes: b7196e2a1c1eb7123e7eace5418b7eb4a3e24dbe Fixes: 5bd2e7f606b726b598fdc26fe26a9b4029fab6d3 Cc: Cole Helbling <cole.e.helbling(a)outlook.com> --- This is the fix I described in This Week in Spectrum[1]. [1]: https://spectrum-os.org/lists/archives/spectrum-discuss/8736654ij2.fsf@alys… sys_util/src/net.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sys_util/src/net.rs b/sys_util/src/net.rs index 71ab3eeb5..82b4f5bb0 100644 --- a/sys_util/src/net.rs +++ b/sys_util/src/net.rs @@ -197,7 +197,7 @@ impl UnixSeqpacket { } } - /// Read data from the socket fd to a given buffer + /// Receive data from the socket fd to a given buffer. /// /// # Arguments /// * `buf` - A mut reference to the data buffer. @@ -206,11 +206,11 @@ impl UnixSeqpacket { /// * `usize` - The size of bytes read to the buffer. /// /// # Errors - /// Returns error when `libc::read` failed. + /// Returns error when `libc::recv` failed. pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> { // Safe since we make sure the input `count` == `buf.len()` and handle the returned error. unsafe { - let ret = libc::read(self.fd, buf.as_mut_ptr() as *mut _, buf.len()); + let ret = libc::recv(self.fd, buf.as_mut_ptr() as *mut _, buf.len(), 0); if ret < 0 { Err(io::Error::last_os_error()) } else { -- 2.26.2

2 6

This Week in Spectrum, 2020-W27
by Alyssa Ross 06 Jul '20

06 Jul '20

I really didn't want this to be another week where I posted about how I was still trying to patch Wayland to do virtio_wl, and I am delighted to have just discovered it's not going to be! crosvm ------ I realised that emulating accept(2) for the Wayland compositor socket in the way I'd planned would require some crosvm rework. I want to have a host proxy program that accepts the connection, then connects the connection socket to crosvm. I had made it possible to dynamically add sockets to the crosvm Wl device through the control socket, but this turned out not be enough, because crosvm would store virtio_wl sockets in a BTreeMap<String, PathBuf>, and then use connect(2) to connect to the socket when asked to by the guest kernel. This works fine for e.g. connecting to a host Wayland compositor, which is what crosvm was designed for, but it wouldn't work for opening a connection socket from accept(2), because you can only connect to a listening socket. So instead, I modified the `crosvm wl add' command to take a file descriptor pointing to the connection socket. I made crosvm store sockets as an enum that looks like this: enum WaylandSocket { Listening(PathBuf), NonListening(UnixStream), } This way, when it gets asked by the VM to connect to a socket, it can either connect to a listening socket at its path using connect(2), or just use the existing file descriptor if it's a non-listening socket. A NonListening socket will be consumed by a connection, so when the VM close(2)s it, it'll go away, and on the host side the connection will finish as expected. Listening sockets can be connected to repeatedly, as before. I also added support to `crosvm add wl' for dynamic socket names. So it's possible to do `crosvm add wl wl-conn-%d', and connections will be added with names like `wl-conn-0', `wl-conn-1', etc. So it's easy to get unique names for connection sockets. The chosen name is printed by the command, so the caller knows what name to tell the VM to connect to. I also found and fixed a bug with the previous crosvm deadlock fix[1]. I had assumed that device_sock.recv(&mut []) would drop a message from the (SOCK_SEQPACKET) socket, without having to read any of it. But UnixSeqpacket::recv calls libc::read, and read(2) tells us that: > In the absence of any errors, or if read() does not check for errors, > a read() with a count of 0 returns zero and has no other effects. So this was in fact doing nothing at all. I don't know why crosvm's UnixSeqpacket::recv calls read() instead of recv(), but it's always been like that and I'm guessing this sort of thing (from recv(2)) might have something to do with it: > The only difference between recv() and read(2) is the presence of > flags. With a zero flags argument, recv() is generally equivalent to > read(2) (but see NOTES). So probably read() just looked like a nicer way to recv() when no flags were needed. But, unfortunately, zero-byte reads are when the aforementioned NOTES section becomes relevant: > If a zero-length datagram is pending, read(2) and recv() with a flags > argument of zero provide different behavior. In this circumstance, > read(2) has no effect (the datagram remains pending), while recv() > consumes the pending datagram. So, my assumption that UnixSeqpacket::recv(&mut []) would consume a message turned out to be quite reasonable -- the surprising thing was that a method called `recv' would call read() rather than recv(). I think the best fix here will be to just make it call recv() instead, rather than modifying my code to do UnixSeqpacket::recv(&mut [0]) or something, to prevent further nasty surprises with this in future. [1]: https://spectrum-os.org/lists/archives/spectrum-devel/20200614114344.22642-… Wayland ------- I created API-compatible implementations of the libc sendmsg(2) and recvmsg(2) functions for virtio_wl sockets. This was quite an achievement, because the API (which allows you to send and receive data and file descriptors, as well as other things I don't intend to support) is rather arcane (see the example in cmsg(3) if you're not familiar with them). I wrote unit tests for them, and it took a long time before they worked reliably. Once I had these, though, I could find the places where Wayland called sendmsg() and recvmsg() and fall back to the virtio_wl-based implementations if the standard functions failed with ENOTSOCK. I stubbed out some stuff that isn't going to work over virtio_wl, like looking up the pid of the Wayland client through getsockopt(2). I also had to resort to a few hacks, like faking support for MSG_DONTWAIT by using fcntl(2) to set O_NONBLOCK on the socket, recv()ing from it, and then removing O_NONBLOCK again, or faking mremap(2) by munmap()-ing and mmap()-ing. We will want to clean these up later by implementing the required missing functionality in the virtio_wl kernel module. In the first case, at least, this should be pretty straightforward, because it supports non-blocking operations if the socket is O_NONBLOCK -- it just needs to accept a MSG_DONTWAIT option as well. The VIRTWL_IOCTL_{SEND,RECV} syscalls don't currently have a flags argument, so that'll need to be added. I implemented this bit by bit, at every step trying to run Alacritty on my host system, connected to the virtio_wl Wayland server socket through the accept() proxy, and using strace and some printf()-debugging to see where the Wayland compositor in the VM would get stuck, and about an hour ago, it finally worked! For the first time, a Wayland compositor running in a VM can display an application running outside of it. (Obviously we'll want the application to be running in another VM rather than on the host, but that's similar enough that it probably works already -- I just haven't tested it yet.) This feels like a huge achievement. I've been working towards it for so long. Next week, I'll be cleaning up this code and posting patches for all of it. Then I'll probably move on to other sorts of device virtualization, like running a virtual network device in a VM. I'm feeling so much more positive about the direction of the project than I was before. It's been difficult to make myself keep going making little progress for the last couple of weeks, and it's great that I've managed to pick things up again so much. I hope that the level of detail in this email is enough to make up for the brevity of last week's! I'm sending late again, too, but only by a couple of minutes -- I didn't expect this email to take over an hour to write, but there we go. Thanks for reading! I hope you're looking forward to seeing where things go from here as much as I am.

1 0

This (Last) Week in Spectrum, 2020-W26
by Alyssa Ross 29 Jun '20

29 Jun '20

This is going to be a very short one, and it's coming a day late, because I have been busy and didn't want to stop yesterday. 2020-W22's TWiS was sent a day early, so the delay is balanced out. :) Wayland ------- I'm finally making progress with the Wayland stuff I've been staring at for the past two weeks! Now that I'm unblocked, things feel like they're moving very quickly. I've modified a Wayland compositor and libwayland-server to use a virtio_wl socket. I've also implemented the compositor side of the accept(2) fallback. Just now, I finished writing a proxy program that implements the host side of that. Next up is testing it. After that, I think we might be there? But it's also possible I have my head so deep in it there's another bit that I've forgotten.

1 0

This Week in Spectrum, 2020-W25
by Alyssa Ross 21 Jun '20

21 Jun '20

Another week that ended up being a detour from the Wayland work I wanted to do, unfortunately. I think this will be the end of it, though. crosvm ------ Fixed[1] an error in my crosvm deadlock fix[2] from last week. Due to an oversight (obvious as soon as I tried to test the affected devices, and from looking at the code in retrospect), this actually broke the devices that were *not* affected by the deadlock, which I had neglected to properly test. Fortunately, it was a very small and easy fix. I also had an interesting (and ongoing) conversation[3] with Cole about the deadlock fix in the mailing list thread. It's one of those situations where getting to talk about the code with another person and having to explain things is going to result in much better code. So we'll end up with a much tidier fix than what I came up with on my own. Thanks to Cole for his feedback and this opportunity. It's great to know that somebody else is passing an eye over my code. [1]: https://spectrum-os.org/git/crosvm/commit/?id=ca5bdd2ac3e473e9b082c44c2870f… [2]: https://spectrum-os.org/lists/archives/spectrum-devel/20200614114344.22642-… [3]: https://spectrum-os.org/lists/archives/spectrum-devel/CH2PR14MB357902F38908… Wayland ------- My current area of attention is modifying Wayland to use a virtio_wl socket as the display socket. Preparing to start implementing that this week, it occurred to me that working on it using my current setup was going to be extremely time consuming. Up until now, I've been doing Nix VM rebuilds when I want to test a change to, for example, wlroots. This means rebuilding, in that case, wlroots and all dependencies (i.e. Wayfire). In the case of wlroots, it's not so bad because rebuilding two packages doesn't take all that long, but it wasn't going to work for Wayland. So I decided that the best way forward would be to create a VM running a traditional Linux distribution, in which I could hack on Wayland without having to restart the VM or rebuild all of its dependents. To that end, I spent much of this week setting up an Alpine VM that can be run under both crosvm and QEMU. (Configuring networking with crosvm is hard for a one-off like this, but QEMU has a built-in userspace networking stack[4] that makes it easy, so when I want to, e.g. install a package, I can boot with QEMU to do that, and then go back to crosvm for testing virtio_wl things.) This resulted in a Nixpkgs pull request[5] to package Alpine's apk package manager, which was used in building the VM image. As of this afternoon, I have this VM all set up and ready to go. I have a script that runs it under crosvm with a virtio_wl socket available to try to connect Wayland to, and another virtio_wl socket connected to the host Wayland compositor for testing. It also sets up some limited networking that allows me to SSH into the VM, but does not allow the VM to access the internet. A separate script runs the VM under QEMU with full networking. The VM has Wayland, wlroots, and Sway (the choice of wlroots-based compositor is irrelevant to this work, and Sway is easier to build) installed from source, and because I can SSH to it I can edit files in the VM easily from my host Emacs using TRAMP[6]. All of this will allow me to iterate on the Wayland work without having to wait upwards of an hour to test each change. This was actually the first time I'd ever booted a VM image in crosvm that I hadn't generated specifically for that purpose myself with Nix. I improved my understanding of crosvm in a few ways in the process (although not anything concrete enough I can think of to write down here). [4]: https://wiki.qemu.org/Documentation/Networking#User_Networking_.28SLIRP.29 [5]: https://github.com/NixOS/nixpkgs/pull/90676 [6]: https://www.gnu.org/software/tramp/ Next week, I'll continue with the Wayland work. It shouldn't be all that much work in the end, but getting set up to actually be able to do it has been annoyingly complicated.

1 0

This Week in Spectrum, 2020-W24
by Alyssa Ross 14 Jun '20

14 Jun '20

An interesting week. Didn't go quite in the direction I expected it to. Documentation ------------- Cole kindly provided[1] some documentation[2] for spectrum-vm for the developer manual. This was especially nice, because it marked the first time I was able to remove[3] an item from the Contribution Ideas page[4] because somebody had done the contribution! Thanks Cole! [1]: https://spectrum-os.org/lists/archives/spectrum-devel/87zh97coks.fsf@alyssa… [2]: https://spectrum-os.org/doc/developer-manual.html#_spectrum_vm [3]: https://spectrum-os.org/git/www/commit/?id=bf7cde0ddd06455f212fb39092b87313… [4]: https://spectrum-os.org/todo.html crosvm ------ My main goal for this week was to start modifying libwayland-server to use a virtio_wl socket as the display socket, as described last week[5]. So, in pursuit of this goal, I started the week by trying to write a test program that would start a VM running a compositor, create a socket, attach one end to that VM, and then start another VM running a Wayland client, and attach the other end of the socket to that VM. Then, in theory, all I had to do was the libwayland-server modifications, and then the compositor and client would be able to talk to each other. Unfortunately, I didn't get that far. The program froze after starting the first VM. I assumed I must have done something wrong, so I rewrote it, and had the same problem. I did it again, and same problem. Some further debugging revealed that the command to add the socket to the first VM was hanging. And also, crosvm was hanging. Running the command outside this program worked fine, though. It returned immediately, and crosvm kept running with the new socket added. What I eventually realised was that the crosvm hang only happened if the command was sent to it early enough. After some intense staring at the crosvm code, I realised that there was a deadlock resulting from trying to wait for a response from a virtual device before the device had been initialized. Despite this issue manifesting with adding Wayland sockets, which is a feature unique to crosvm, a lot of the code for that is adapted from the code for resizing virtual block devices, which is an upstream feature. And that had the same issue, so this is actually an upstream bug. The fix was not easy, and required some fairly substantial refactoring. It's described in detail in the patch message[6]. I think it's probably a pretty interesting read. I also merged in the latest upstream crosvm changes. [5]: https://spectrum-os.org/lists/archives/spectrum-discuss/87tuzm287b.fsf@alys… [6]: https://spectrum-os.org/lists/archives/spectrum-devel/20200614114344.22642-… Nixpkgs ------- I spent a few more hours trying to get libvda (an optional dependency of crosvm; required for virtio-video) to build, and I got it to work, thanks to some help from Puck. There's still a hack in there I'll tidy up before I push it, but it's cool to have this packaged for future experimentation with this crosvm feature. With the crosvm issue out of the way, which ended up taking most of the week to identify and fix, hopefully next week I'll be able to actually get going on those libwayland-server changes.

1 0

[PATCH doc v2] Document spectrum-vm
by Cole Helbling 13 Jun '20

13 Jun '20

spectrum-vm is a handy way to start a crosvm instance for testing crosvm itself, the kernel, or the rootfs. This commit adds some fledgling documentation on its functionality and usage. --- Takes into account review suggestions and tweaks a bit of wording here and there. Specifically, I clarified that rootfs means the root filesystem, added an aside that the serial console can be used to run privileged commands, dropped the full `spectrum-vm --help` text, and moved and reformatted the usage examples. developer-manual.adoc | 53 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/developer-manual.adoc b/developer-manual.adoc index b7eb2cb..a98330f 100644 --- a/developer-manual.adoc +++ b/developer-manual.adoc @@ -106,6 +106,59 @@ the https://spectrum-os.org/doc/crosvm/crosvm/[crosvm documentation] for the version currently used by Spectrum is hosted on the Spectrum website. +==== spectrum-vm + +`spectrum-vm` is a shell script that allows for testing various Spectrum +VM components, including crosvm, the kernel, and the root filesystem +("rootfs" for short). The simplest way to use this tool is by running +`nix-shell -I nixpkgs=/path/to/nixpkgs-spectrum -p +spectrumPackages.spectrum-vm --run spectrum-vm` in a terminal, which +will start up an instance of crosvm from Nixpkgs running Wayfire in a +new window. + +**** +Be advised that Wayfire's default keymap is set to Dvorak +https://spectrum-os.org/git/nixpkgs/tree/pkgs/os-specific/linux/spectrum/rootfs/default.nix[inside +of the rootfs] -- to change this to your preferred keymap, just set the +`xkb_layout` option (or remove it altogether for a default of QWERTY). +**** + +Once you are ready to end your crosvm session, switch back to where you +ran `spectrum-vm` and type `reboot` (not `poweroff`). This window is not +limited to just stopping the VM, however; it is a functional serial +console where you can even run commands like `env` and `cat +/etc/passwd`. + +**** +Although it is currently not possible to execute commands as root inside +the graphical environment, one can instead use the serial console to run +privileged commands. +**** + +===== Examples + +As mentioned above, `spectrum-vm` also supports options that allow you +to specify custom components or run arbitrary commands before exiting: + +---- +nix-shell -I nixpkgs=/path/to/nixpkgs-spectrum -p spectrumPackages.spectrum-vm + +# display the currently supported options for spectrum-vm +nix-shell$ spectrum-vm --help + +# run a command that will print out the VM's PATH to the serial terminal and exit +nix-shell$ spectrum-vm -c 'echo $PATH' + +# use the specified crosvm and disable sandboxing +nix-shell$ spectrum-vm -C target/debug/crosvm -- --disable-sandbox + +# use the specified kernel image +nix-shell$ spectrum-vm -k result/bzImage + +# use the specified squashfs as the root filesystem image +nix-shell$ spectrum-vm -f squashfs +---- + ==== Hacking on crosvm There are a few ways to get a crosvm development environment. You can -- 2.26.2

2 1

[PATCH doc] Document spectrum-vm
by Cole Helbling 10 Jun '20

10 Jun '20

spectrum-vm is a handy way to start a crosvm instance for testing crosvm itself, the kernel, or the rootfs. This commit adds some fledgling documentation on its functionality and usage. --- I feel like this is mostly a rough draft, so give me all your suggestions/criticisms/what have you. I put this section above the "Hacking on crosvm" section so that it will be introduced before it is used in an example. developer-manual.adoc | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/developer-manual.adoc b/developer-manual.adoc index b7eb2cb..739dc83 100644 --- a/developer-manual.adoc +++ b/developer-manual.adoc @@ -106,6 +106,49 @@ the https://spectrum-os.org/doc/crosvm/crosvm/[crosvm documentation] for the version currently used by Spectrum is hosted on the Spectrum website. +==== spectrum-vm + +`spectrum-vm` is a shell script that allows for testing various Spectrum +VM components, including crosvm, the kernel, and the rootfs. The +simplest way to use this tool is by running `nix-shell -I +nixpkgs=/path/to/nixpkgs-spectrum -p spectrumPackages.spectrum-vm --run +spectrum-vm` in a terminal, which will start up an instance of crosvm +from Nixpkgs running Wayfire in a new window. + +**** +Be advised that Wayfire's default keymap is set to Dvorak +https://spectrum-os.org/git/nixpkgs/tree/pkgs/os-specific/linux/spectrum/rootfs/default.nix[inside +of the rootfs] -- to change this to your preferred keymap, just set the +`xkb_layout` option (or remove it altogether for a default of QWERTY). +**** + +Once you are ready to end your crosvm session, switch back to where you +ran `spectrum-vm` and type `reboot` (not `poweroff`). This window is not +limited to just stopping the VM, however; it is a functional serial +console and you can even run commands like `env` and `cat +/etc/passwd`. + +As mentioned above, `spectrum-vm` also supports options that allow you +to specify custom components or run arbitrary commands before exiting: + +---- +nix-shell -I nixpkgs=/path/to/nixpkgs-spectrum -p spectrumPackages.spectrum-vm + +nix-shell$ spectrum-vm --help +Usage: spectrum-vm [OPTION]... [-- CROSVM_OPTIONS] + + -c COMMAND shell command to run inside VM + -C, --crosvm PATH path to custom crosvm executable + -k, --kernel PATH path to custom kernel image + -f, --rootfs PATH path to custom root file system image + -- CROSVM_OPTIONS extra arguments to pass to crosvm + +nix-shell$ spectrum-vm -c 'echo $PATH' # print out the VM's PATH to the serial terminal and exit +nix-shell$ spectrum-vm -C target/debug/crosvm -- --disable-sandbox # use the specified crosvm and disable sandboxing +nix-shell$ spectrum-vm -k result/bzImage # use the specified kernel image +nix-shell$ spectrum-vm -f squashfs # use the specified squashfs as the root filesystem image +---- + ==== Hacking on crosvm There are a few ways to get a crosvm development environment. You can -- 2.26.2

2 1

This Week in Spectrum, 2020-W23
by Alyssa Ross 07 Jun '20

07 Jun '20

I wasn't quite back up to normal speed after being sick last week, I think, but we're getting somewhere and I did some cool stuff! Infrastructure -------------- Upgraded Mailman. Most significantly, the Hyperkitty UI has some nice improvements, which I think will make it easier to navigate. :) Nixpkgs ------- I integrated and committed last week's wlroots patch (to make it use virtio_wl-compatible memfds). Spent quite a lot the start of the week working on packaging more Chromium OS components to build some optional crosvm features. They just added support for virtio-video[1], which sounds pretty cool. I managed to get libchrome working again, which I previously had to remove because I couldn't get it to build! I haven't committed any of this yet, because I haven't got to the point where it's useful for building optional crosvm features, and I don't want to add packages that aren't useful for anything, but I did make quite a lot of progress. After a couple of days of this, though, I put it aside to focus on other things, since it would be useful to have, but its not a priority right now. [1]: https://chromium.googlesource.com/chromiumos/platform/crosvm/+/57df6a0ab23c… crosvm ------ I posted a patch[2] to make listing a directory shared with --shared-dir not crash crosvm when sandboxing was enabled. I'd been reluctant to fix this, because --shared-dir (which exposes a host file system to a crosvm guest) is not going to be useful in Spectrum, where shared directories should come from another VM. But it's useful enough in development that not fixing it was more frustrating than just fixing it. I spent a lot of time this week thinking about Wayland connections. My original plan for inter-VM communication was to make it possible to run crosvm devices as standalone programs inside VMs. I still think this is the right track for most virtio devices, but for Wayland it's starting to feel less and less like it makes sense, because the Wayland device is basically a wrapper around a socket, and both ends will be hooked up to sockets. So what I now plan is that a VM running a Wayland client application will connect to a host socket, with the other end connected to a VM running the compositor. The client applications will be run under Sommelier, and so will be able to run unmodified. The compositor will be modified to use a virtio_wl socket. A slight complication here is that a Wayland compositor usually accepts on a socket to receive client connections, but you can't accept on a virtio_wl context. So instead, what we can do is emulate accept by attaching a new virtio_wl socket, and then sending the name of that socket over the main socket. This can be wrapped inside the VM to look very much like an accept. Unfortunately, crosvm virtio_wl sockets could only be set at startup time. So today I fixed that[3]. Adding support for adding virtio_wl sockets at runtime was pleasantly straightforward. I feel very energized now that I managed to bang that out in a day. :D [2]: https://spectrum-os.org/lists/archives/spectrum-devel/20200605234757.28848-… [3]: https://spectrum-os.org/git/crosvm/commit/?h=interguest This is one of those weeks where I can feel writing this that it might not make much sense to anybody else. But the important thing with these weekly updates is that I write _something_ we can refer back to in future, and communicate that things are happening. If you'd like to better understand what I'm talking about here, I'm happy to try walking through it on IRC. Next week, I'm going to work on getting libwayland-server to speak this weird virtio_wl faux-accept.

1 0

[PATCH crosvm] seccomp: allow getdents64 if getdents is allowed
by Alyssa Ross 05 Jun '20

05 Jun '20

This fixes a crash where crosvm would crash if run on x86_64 with --shared-dir when running ls in the shared directory. I suspect whether getdents or getdents64 is used depends on the host libc, so allow both of them. I suspect upstream's libc uses getdents, and that's why they haven't fixed the problem. --- This finally annoyed me enough that I decided to fix it. Michael, I think you'd also run into this issue. Want to test the fix? seccomp/x86_64/9p_device.policy | 1 + seccomp/x86_64/gpu_device.policy | 1 + seccomp/x86_64/xhci.policy | 1 + 3 files changed, 3 insertions(+) diff --git a/seccomp/x86_64/9p_device.policy b/seccomp/x86_64/9p_device.policy index 114ea11..271d244 100644 --- a/seccomp/x86_64/9p_device.policy +++ b/seccomp/x86_64/9p_device.policy @@ -18,6 +18,7 @@ unlink: 1 rename: 1 pread64: 1 getdents: 1 +getdents64: 1 mkdir: 1 rmdir: 1 fsync: 1 diff --git a/seccomp/x86_64/gpu_device.policy b/seccomp/x86_64/gpu_device.policy index 331fc49..99d2a8d 100644 --- a/seccomp/x86_64/gpu_device.policy +++ b/seccomp/x86_64/gpu_device.policy @@ -52,6 +52,7 @@ fstat: 1 # Used to set of size new memfd. ftruncate: 1 getdents: 1 +getdents64: 1 geteuid: 1 getrandom: 1 getuid: 1 diff --git a/seccomp/x86_64/xhci.policy b/seccomp/x86_64/xhci.policy index 4b4fc3d..3448ce2 100644 --- a/seccomp/x86_64/xhci.policy +++ b/seccomp/x86_64/xhci.policy @@ -38,4 +38,5 @@ ioctl: arg1 == 0xc0185500 || arg1 == 0x41045508 || arg1 == 0x8004550f || arg1 == fstat: 1 getrandom: 1 getdents: 1 +getdents64: 1 lseek: 1 -- 2.26.2

1 0

[PATCH 1/2] chromiumOSPackages: improve update.py repo compat
by Alyssa Ross 02 Jun '20

02 Jun '20

These changes make chromiumOSPackages.updateScript better understand the Repo manifest format[1]. It now properly distinguishes between paths in the Chromium OS source tree and paths on the git servers, which are usually not the same. For example, chromiumos-overlay is located in the source tree at src/third_party/chromiumos-overlay, but on chromium.googlesource.com it's located at chromiumos/overlays/chromiumos-overlays. Components are now keyed by their location in the Chromium OS source tree (and packages have all been updated for this change.) Additionally, it now understands Repo remotes. This means that it is now possible to use a Chromium OS component like Minijail, which is hosted on android.googlesource.com rather than chromiumos.googlesource.com. This was not previously possible. [1]: https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md --- .../linux/chromium-os/common-mk/default.nix | 2 +- .../linux/chromium-os/crosvm/default.nix | 4 +- .../os-specific/linux/chromium-os/default.nix | 2 +- .../linux/chromium-os/libqmi/default.nix | 2 +- .../linux/chromium-os/minigbm/default.nix | 2 +- .../linux/chromium-os/modem-manager/next.nix | 2 +- .../linux/chromium-os/modp_b64/default.nix | 2 +- pkgs/os-specific/linux/chromium-os/update.py | 56 ++++++++++++------- .../linux/chromium-os/upstream-info.json | 40 ++++++------- pkgs/os-specific/linux/kernel/linux-cros.nix | 2 +- 10 files changed, 64 insertions(+), 50 deletions(-) diff --git a/pkgs/os-specific/linux/chromium-os/common-mk/default.nix b/pkgs/os-specific/linux/chromium-os/common-mk/default.nix index f07e418b56f..73862bcaa97 100644 --- a/pkgs/os-specific/linux/chromium-os/common-mk/default.nix +++ b/pkgs/os-specific/linux/chromium-os/common-mk/default.nix @@ -24,7 +24,7 @@ , ... } @ args: let - platform2 = fetchFromGitiles upstreamInfo.components."chromiumos/platform2"; + platform2 = fetchFromGitiles upstreamInfo.components."src/platform2"; attrsToGnList = lib.mapAttrsToList (name: value: "${name}=${toGn value}"); diff --git a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix index 3813e3eb75a..8698ef67a83 100644 --- a/pkgs/os-specific/linux/chromium-os/crosvm/default.nix +++ b/pkgs/os-specific/linux/chromium-os/crosvm/default.nix @@ -9,10 +9,10 @@ let else throw "no seccomp policy files available for host platform"; crosvmSrc = fetchFromGitiles - upstreamInfo.components."chromiumos/platform/crosvm"; + upstreamInfo.components."src/platform/crosvm"; adhdSrc = fetchFromGitiles - upstreamInfo.components."chromiumos/third_party/adhd"; + upstreamInfo.components."src/third_party/adhd"; in rustPlatform.buildRustPackage rec { diff --git a/pkgs/os-specific/linux/chromium-os/default.nix b/pkgs/os-specific/linux/chromium-os/default.nix index f9c6c88d072..db719e8b0f1 100644 --- a/pkgs/os-specific/linux/chromium-os/default.nix +++ b/pkgs/os-specific/linux/chromium-os/default.nix @@ -9,7 +9,7 @@ let upstreamInfo = lib.importJSON ./upstream-info.json; chromiumos-overlay = (fetchFromGitiles - upstreamInfo.components."chromiumos/overlays/chromiumos-overlay") // { + upstreamInfo.components."src/third_party/chromiumos-overlay") // { passthru.updateScript = ./update.py; }; diff --git a/pkgs/os-specific/linux/chromium-os/libqmi/default.nix b/pkgs/os-specific/linux/chromium-os/libqmi/default.nix index ac444848b81..ec4f44c7047 100644 --- a/pkgs/os-specific/linux/chromium-os/libqmi/default.nix +++ b/pkgs/os-specific/linux/chromium-os/libqmi/default.nix @@ -8,7 +8,7 @@ libqmi.overrideAttrs ( pname = "libqmi-unstable"; version = "2019-12-16"; - src = fetchFromGitiles upstreamInfo.components."chromiumos/third_party/libqmi"; + src = fetchFromGitiles upstreamInfo.components."src/third_party/libqmi"; nativeBuildInputs = nativeBuildInputs ++ [ autoreconfHook autoconf-archive gtk-doc docbook-xsl-nons ]; diff --git a/pkgs/os-specific/linux/chromium-os/minigbm/default.nix b/pkgs/os-specific/linux/chromium-os/minigbm/default.nix index 0a3cbf15997..6c532a4deb2 100644 --- a/pkgs/os-specific/linux/chromium-os/minigbm/default.nix +++ b/pkgs/os-specific/linux/chromium-os/minigbm/default.nix @@ -4,7 +4,7 @@ stdenv.mkDerivation { name = "minigbm"; inherit (upstreamInfo) version; - src = fetchFromGitiles upstreamInfo.components."chromiumos/platform/minigbm"; + src = fetchFromGitiles upstreamInfo.components."src/platform/minigbm"; nativeBuildInputs = [ pkg-config ]; buildInputs = [ libdrm ]; diff --git a/pkgs/os-specific/linux/chromium-os/modem-manager/next.nix b/pkgs/os-specific/linux/chromium-os/modem-manager/next.nix index a074e82ff4b..91aa18b3846 100644 --- a/pkgs/os-specific/linux/chromium-os/modem-manager/next.nix +++ b/pkgs/os-specific/linux/chromium-os/modem-manager/next.nix @@ -9,7 +9,7 @@ modemmanager.overrideAttrs ( version = "2019-10-17"; src = fetchFromGitiles - upstreamInfo.components."chromiumos/third_party/modemmanager-next"; + upstreamInfo.components."src/third_party/modemmanager-next"; nativeBuildInputs = nativeBuildInputs ++ [ autoreconfHook libqmi libxslt ]; diff --git a/pkgs/os-specific/linux/chromium-os/modp_b64/default.nix b/pkgs/os-specific/linux/chromium-os/modp_b64/default.nix index 50d91479193..557769336ce 100644 --- a/pkgs/os-specific/linux/chromium-os/modp_b64/default.nix +++ b/pkgs/os-specific/linux/chromium-os/modp_b64/default.nix @@ -3,7 +3,7 @@ common-mk { platformSubdir = "modp_b64"; - src = fetchFromGitiles upstreamInfo.components."aosp/platform/external/modp_b64"; + src = fetchFromGitiles upstreamInfo.components."src/third_party/modp_b64"; installPhase = '' mkdir -p $out/lib diff --git a/pkgs/os-specific/linux/chromium-os/update.py b/pkgs/os-specific/linux/chromium-os/update.py index 1405c534d8b..58a15dbb8e8 100755 --- a/pkgs/os-specific/linux/chromium-os/update.py +++ b/pkgs/os-specific/linux/chromium-os/update.py @@ -13,16 +13,16 @@ from re import MULTILINE, fullmatch, match, search from urllib.request import urlopen # ChromiumOS components used in Nixpkgs -components = [ - 'aosp/platform/external/modp_b64', - 'chromiumos/overlays/chromiumos-overlay', - 'chromiumos/platform/crosvm', - 'chromiumos/platform/minigbm', - 'chromiumos/platform2', - 'chromiumos/third_party/adhd', - 'chromiumos/third_party/kernel', - 'chromiumos/third_party/libqmi', - 'chromiumos/third_party/modemmanager-next', +component_paths = [ + 'src/platform/crosvm', + 'src/platform/minigbm', + 'src/platform2', + 'src/third_party/adhd', + 'src/third_party/chromiumos-overlay', + 'src/third_party/kernel/v5.4', + 'src/third_party/libqmi', + 'src/third_party/modemmanager-next', + 'src/third_party/modp_b64', ] git_root = 'https://chromium.googlesource.com/' @@ -65,14 +65,28 @@ with urlopen(f'{buildspecs_url}{chrome_major_version}/?format=TEXT') as resp: buildspecs.sort(reverse=True) buildspec = splitext(buildspecs[0])[0] -revisions = {} +components = {} # Read the buildspec, and extract the git revisions for each component. with urlopen(f'{buildspecs_url}{chrome_major_version}/{buildspec}.xml?format=TEXT') as resp: xml = base64.decodebytes(resp.read()) root = etree.fromstring(xml) + + default_remote = root.find('default').get('remote') + remotes = {} + for remote in root.findall('remote'): + remotes[remote.get('name')] = remote.get('fetch') + for project in root.findall('project'): - revisions[project.get('name')] = project.get('revision') + name = project.get('name') + path = project.get('path') + remote_name = project.get('remote') or default_remote + remote = remotes[remote_name] + + components[path] = { + 'revision': project.get('revision'), + 'url': f'{remote}/{name}', + } # Initialize the data that will be output from this script. Leave the # rc number in buildspec so nobody else is subject to the same level @@ -84,15 +98,15 @@ paths = {} # Fill in the 'components' dictionary with the output from # nix-prefetch-git, which can be passed straight to fetchGit when # imported by Nix. -for component in components: - name = component.split('/')[-1] - url = f'{git_root}{component}' - rev = revisions[component] +for path in component_paths: + name = path.split('/')[-1] + url = components[path]['url'] + rev = components[path]['revision'] tarball = f'{url}/+archive/{rev}.tar.gz' output = subprocess.check_output(['nix-prefetch-url', '--print-path', '--unpack', '--name', name, tarball]) - (sha256, path) = output.decode('utf-8').splitlines() - paths[component] = path - data['components'][component] = { + (sha256, store_path) = output.decode('utf-8').splitlines() + paths[path] = store_path + data['components'][path] = { 'name': name, 'url': url, 'rev': rev, @@ -100,14 +114,14 @@ for component in components: } # Get the version number of the kernel. -kernel = paths['chromiumos/third_party/kernel'] +kernel = paths['src/third_party/kernel/v5.4'] makefile = open(f'{kernel}/Makefile').read() version = search(r'^VERSION = (.+)$', makefile, MULTILINE)[1] patchlevel = search(r'^PATCHLEVEL = (.*?)$', makefile, MULTILINE)[1] sublevel = search(r'^SUBLEVEL = (.*?)$', makefile, MULTILINE)[1] extra = search(r'^EXTRAVERSION =[ \t]*(.*?)$', makefile, MULTILINE)[1] full_ver = '.'.join(filter(None, [version, patchlevel, sublevel])) + extra -data['components']['chromiumos/third_party/kernel']['version'] = full_ver +data['components']['src/third_party/kernel/v5.4']['version'] = full_ver # Finally, write the output. with open(dirname(__file__) + '/upstream-info.json', 'w') as out: diff --git a/pkgs/os-specific/linux/chromium-os/upstream-info.json b/pkgs/os-specific/linux/chromium-os/upstream-info.json index 5264a72a6c9..842912800bc 100644 --- a/pkgs/os-specific/linux/chromium-os/upstream-info.json +++ b/pkgs/os-specific/linux/chromium-os/upstream-info.json @@ -1,60 +1,60 @@ { "version": "81.12871.0.0-rc1", "components": { - "aosp/platform/external/modp_b64": { - "name": "modp_b64", - "url": "https://chromium.googlesource.com/aosp/platform/external/modp_b64", - "rev": "ae26ad8516036774fd3b6e84a98a89955dcf5f61", - "sha256": "03ja5fkq3wk0qcnfnqcj09lciky6n6zdj544xs1jfssjhz9yj8hi" - }, - "chromiumos/overlays/chromiumos-overlay": { - "name": "chromiumos-overlay", - "url": "https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay", - "rev": "be285b729ef2af700cc248f741af20c387b5a1bc", - "sha256": "18y2icdb3hxqxxaaz8sylw21q2qwcpjyns75ig7ahc4vc1k5hg7s" - }, - "chromiumos/platform/crosvm": { + "src/platform/crosvm": { "name": "crosvm", "url": "https://chromium.googlesource.com/chromiumos/platform/crosvm", "rev": "8b8c01e1ad31718932491e4aee63f56109a138e2", "sha256": "1qmf1k06pwynh15c3nr9m6v90z2pkk930xniwvlvbvnazrk4rllg" }, - "chromiumos/platform/minigbm": { + "src/platform/minigbm": { "name": "minigbm", "url": "https://chromium.googlesource.com/chromiumos/platform/minigbm", "rev": "fbfb338e7db246f05ae68da97141fbd49481584b", "sha256": "11p6v4nmqivyqyc8lmypbwqv9q819lhx6v3igfsv3455mmq02kcb" }, - "chromiumos/platform2": { + "src/platform2": { "name": "platform2", "url": "https://chromium.googlesource.com/chromiumos/platform2", "rev": "6e0d88d0bea8e7cb28a310298cc8c77ed742f60a", "sha256": "13vrbnl3ck8cxiyifc58cs9i0yby92vp5si27ihrx33v6bdlir4s" }, - "chromiumos/third_party/adhd": { + "src/third_party/adhd": { "name": "adhd", "url": "https://chromium.googlesource.com/chromiumos/third_party/adhd", "rev": "f361d5b02623274723bff251dafa1e2a2887b013", "sha256": "1p8iwjwgmcgmzri03ik2jaid8l0ch0bzn6z9z64dix1hlrvrlliw" }, - "chromiumos/third_party/kernel": { - "name": "kernel", + "src/third_party/chromiumos-overlay": { + "name": "chromiumos-overlay", + "url": "https://chromium.googlesource.com/chromiumos/overlays/chromiumos-overlay", + "rev": "be285b729ef2af700cc248f741af20c387b5a1bc", + "sha256": "18y2icdb3hxqxxaaz8sylw21q2qwcpjyns75ig7ahc4vc1k5hg7s" + }, + "src/third_party/kernel/v5.4": { + "name": "v5.4", "url": "https://chromium.googlesource.com/chromiumos/third_party/kernel", "rev": "17611b6e636c8ccae25e873e659d69c20b215815", "sha256": "0an8w3660v2zf2crb68ambg7vzw2rajpjmcby1am08qy37lqsfkd", "version": "5.4.16" }, - "chromiumos/third_party/libqmi": { + "src/third_party/libqmi": { "name": "libqmi", "url": "https://chromium.googlesource.com/chromiumos/third_party/libqmi", "rev": "6267c12fef0be9a95d687bf4b476593eeffbaaf1", "sha256": "00yjjcngjkbgxmmf79ciddk9yq393a94230ahq8vszyfygzhs3rz" }, - "chromiumos/third_party/modemmanager-next": { + "src/third_party/modemmanager-next": { "name": "modemmanager-next", "url": "https://chromium.googlesource.com/chromiumos/third_party/modemmanager-next", "rev": "a4d3a4de1fdab7c282f1a188d2d3d0aaa24f0698", "sha256": "1b1l1jfiyl7fnm29pp9npi0gdlqcw1jmmbigf0qlndqdh0ly2izg" + }, + "src/third_party/modp_b64": { + "name": "modp_b64", + "url": "https://chromium.googlesource.com/aosp/platform/external/modp_b64", + "rev": "ae26ad8516036774fd3b6e84a98a89955dcf5f61", + "sha256": "03ja5fkq3wk0qcnfnqcj09lciky6n6zdj544xs1jfssjhz9yj8hi" } } } diff --git a/pkgs/os-specific/linux/kernel/linux-cros.nix b/pkgs/os-specific/linux/kernel/linux-cros.nix index 6a4a5771b38..789a9fb6fd2 100644 --- a/pkgs/os-specific/linux/kernel/linux-cros.nix +++ b/pkgs/os-specific/linux/kernel/linux-cros.nix @@ -3,7 +3,7 @@ , ... } @ args: let - versionData = upstreamInfo.components."chromiumos/third_party/kernel"; + versionData = upstreamInfo.components."src/third_party/kernel/v5.4"; in with lib; -- 2.26.2

3 15

This Week in Spectrum, 2020-W22
by Alyssa Ross 30 May '20

30 May '20

I began this week feeling very burnt out from some Nix stuff. Later in the week, I got sick as well (thankfully not with any COVID-19 symptoms) and ended up spending several days not being able to do much beyond sleep. So, not a lot from me to report this week I'm afraid. This'll be a short one. Documentation ------------- I documented the memfd server I recently added to crosvm[1]. I sent the documentation patch to the list, and was very pleased to receive reviews[2] from impaqt and Cole Helbling. This is really the first time a patch from me has gone through an actual review cycle with other people involved, so that's very exciting. Here's to more of that! :) With that documentation, I was then able to add a memfd server quota to the Contribution Ideas page[3]. This is an important feature, so if nobody is interested in working on it I'll do it myself, but it's also a nice opportunity to do a pretty self-contained bit of work on crosvm, so I'm going to leave it up for a bit in case somebody else wants to try it. [1]: https://spectrum-os.org/doc/developer-manual.html#_the_memfd_server [2]: https://spectrum-os.org/lists/archives/spectrum-devel/C312TALEYVQS.RICE3VLE… [3]: https://spectrum-os.org/todo.html Infrastructure -------------- Increased the maximum message size on devel@ to 80K from 40K, because a patch I sent was too big and got held for moderation. Nixpkgs ------- The expected Chromium OS update was released this week (instead of last as I'd expected). crosvm now wants the minijail source code, which isn't hosted on chromium.googlesource.com. This required making the update script a bit smarter. I posted the patch series improving the update script and then updating chromiumOSPackages to the list[1]. More details there. Another shout out to Cole for having a go at doing this update, even if he didn't get all the way because he needed the cores on his computer for other things. Thanks Cole! [1]: https://spectrum-os.org/lists/archives/spectrum-devel/20200530190028.6388-1… I'm mostly feeling better now (although still getting tired very easily), so hopefully things will go faster again next week. Too early to be certain, though. I'm happy to have at least got the chromiumOSPackages update out the way, and delighted to have received the reviews on the documentation patch.

1 0

[PATCH www] todo.html: add request for memfd server ceiling
by Alyssa Ross 29 May '20

29 May '20

--- I pushed this already, but I'm posting it here in case anybody is interested in doing it. ;) todo.html | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/todo.html b/todo.html index abb9c11..417b3c3 100644 --- a/todo.html +++ b/todo.html @@ -48,6 +48,11 @@ might be able to help out. <a href="https://spectrum-os.org/git/nixpkgs/tree/pkgs/development/libraries/wlroots…">patch</a> wlroots to downgrade it to an older protocol. + <li> + Implement a ceiling for host memory allocated by the + crosvm <a href="https://spectrum-os.org/doc/developer-manual.html#_the_memfd_server">memfd + server</a>. + <li> Create a minimal VM kernel configuration. This will make it much easier to iterate on the VM kernel, by substantially reducing clean -- 2.26.2

1 0

[PATCH doc] Document crosvm memfd server
by Alyssa Ross 29 May '20

29 May '20

--- Looking for another set of eyes on this to check it makes sense to people who haven't dedicated several weeks of their life to thinking about it. ;) developer-manual.adoc | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/developer-manual.adoc b/developer-manual.adoc index a538437..5a5f80d 100644 --- a/developer-manual.adoc +++ b/developer-manual.adoc @@ -194,6 +194,31 @@ compile the policy files into the crosvm binary so paths don't have to be hardcoded. +==== The memfd server + +Spectrum's crosvm has been augmented with a feature called the +"`memfd server`", (currently only on the +https://spectrum-os.org/git/crosvm/log/?h=interguest[interguest] +branch). This is a small server that listens on a Unix stream socket. +It receives a request consisting of a name and a size, uses those to +allocate a receives requests for a +https://man7.org/linux/man-pages/man2/memfd_create.2.html[memfd], and +then sends the resulting memfd file descriptor back over the socket in +response, along with a single byte status code. + +The purpose of this is that it can be exposed to the guest over +virtio_wl. This means that the guest can request and receive +allocations of host memory. This is important, because virtio_wl only +allows file descriptors pointing to host memory to be sent over +virtio_wl -- a memfd allocated in a guest cannot be sent over virtio_wl. +It is rare that a guest needs to be able to allocate and send shared +memory in this way, but it is important for a Wayland compositor +running in a guest to be able to do this. + +The memfd server is disabled by default, but is enabled at startup +time with the `--wl-memfd` flag. + + === Sommelier https://chromium.googlesource.com/chromiumos/platform2/+/master/vm_tools/so… -- 2.26.2

3 6

This Week in Spectrum, 2020-W21
by Alyssa Ross 24 May '20

24 May '20

A week of results! Infrastructure -------------- Fixed a misconfigured spam filter that allowed an obvious spam message through to devel@. Oops. crosvm ------ Integrated the memfd server[1] on the interguest branch. It's now all sandboxed, and optionally enabled with a command line argument to crosvm run. Not all that much to say here, but it's what took me most of the week! Getting the sandbox working was a bit weird. When I tried to get it to log seccomp failures, it seemed to just disable the sandbox. I had to track them down with strace instead. Annoying. But the sandbox does work in normal operation. I still haven't limited how much memory can be requested this way. I think implementing that would be relatively straightforward for another contributor, so I think I'll add it to the ideas list[2] and see if a patch is forthcoming. Otherwise I'll do it myself. [1]: https://spectrum-os.org/git/crosvm/commit/?h=interguest [2]: https://spectrum-os.org/todo.html wlroots ------- I took my standalone virtio_wl test program, and integrated it into wlroots' allocate_shm_file function. This has the result that, when running under Sommelier, this patched wlroots will request shared memory from the host, rather than allocating it itself. Porting from the standalone test program was nice, because it meant that this all just worked, first try! (Once I got it to compile under Nixpkgs' or wlroots' strict compiler errors, at least.) This will allow that memory to be sent between VMs! I haven't pushed the patch yet because I haven't integrated it into Spectrum's Nixpkgs yet. I plan to do that next week. I'm starting to think about moving the stuff specific to Spectrum VMs into an overlay, but I need to think a bit about how to structure that. Nixpkgs ------- There's no sign of the expected Chromium OS release so far, so I backported[3] support for multiple virtio_wl sockets from a more recent Chromium OS kernel to the one in Spectrum's Nixpkgs. We need this to be able to dedicate a named socket to the memfd server. [3]: https://spectrum-os.org/git/nixpkgs/commit/?id=f24d310275909265de32cbc831d5… It's been another week where I've been very focused on one task. I'm quite excited about the direction this is all going. It's looking like we'll be able to do almost everything inside VMs, which means it might be possible to have a host kernel that does almost nothing apart from KVM and PCI passthrough?? This would mean we'd end up with a tiny Linux a little bit (but not all that much) like a microkernel, with most hardware interaction and all user programs running in VMs. Cool stuff! It's not clear to me yet the exact extent to which this is achievable, but it's a nice vision to keep in mind. It might also make it easier for us to transition to a true microkernel at some point in the future. I'm hoping that I'll hit an NLnet milestone related to this stuff fairly soon. Until I do, I'm now living on the money I've received in the past six months through GitHub Sponsors. Thank you so much to everyone who is helping to make it possible for me to spend this time on the fundamentals so we have a good foundation to build Spectrum on. <3

1 0

Spam on this list
by Alyssa Ross 18 May '20

18 May '20

Hi, Apologies for the recent spam message on the list. It got through due to a misconfigured spam filter. Should be fixed now. Let me know if you see anything else unusual. :)

1 0

This Week in Spectrum, 2020-W20
by Alyssa Ross 17 May '20

17 May '20

It feels like things are finally starting to come together. Infrastructure -------------- Server memory upgraded. We should now be able to handle more than one person cloning Spectrum's nixpkgs repo at once! Documentation ------------- I added a much requested page[1] to the website with a few tasks a potential contributor might want to look into. More to come here, too! [1]: https://spectrum-os.org/todo.html virtio_wl --------- I wrote a simple guest C program that connected to a host socket over virtio_wl, and sent some messages back and forth. In doing this, I've ended up with a nice set of generic functions for interacting with virtio_wl -- virtio_wl_connect(), virtio_wl_send(), etc. This is nice, because it allows me to treat virtio_wl inside a guest much like a regular socket (albeit one that can only be interacted with using a custom set of functions). Otherwise, I'd have to do ioctl operations every time (which seems to be what the various virtio_wl-using Chromium OS components do). Having a simple test program (rather than integrating directly into wlroots) gives me a more simple environment with which to test the other end of this connection. crosvm ------ I implemented a little Rust server that listens on a Unix stream socket. When it receives a message (consisting of an identifier {for debug purposes} and a size), it will allocate a memfd of the requested size, and then send that back to the socket, along with a status byte indicating success or failure. I then integrated this program into crosvm, so it is started as part of the VM initialization, and exposed over virtio_wl as an additional socket. Integrating this into crosvm required some careful thought, because there's no precedent in crosvm for a virtio_wl server of this sort. It has almost nothing with the existing concept in crosvm of a "device", which is something that communicates with a guest kernel driver over PCI. So Spectrum's crosvm now has the concept of "servers". I can see us wanting to provide other VM services over virtio_wl in the future. It allows us to exchange various resources between host and guest (or between guests) without having to write a kernel driver specific to each task. This all now works well enough that my program inside the VM can request a chunk of memory, and receive back something that looks a bit like a memfd, that can then be sent back to the host over a virtio_wl socket. It was great to see this working the first time! One thing crosvm devices do that I would also like to apply to this type of server is sandboxing. The sandboxing mechanism used in crosvm is pretty generic (it's really just a thin wrapper around Minijail[2]), so it should be straightforward to reuse. I just have to understand a bit better how to use it. The other crosvm change I still need to make is to put this functionality behind a command line flag. Most VMs should not be able to give themselves extra memory this way -- really only the Wayland compositor should be using it. I should also impose some upper bound on how much memory is allowed to be allocated this way. Such a limit will probably get harder to add (from a testing point of view) the longer I wait. [2]: https://lwn.net/Articles/700557/ So, at lot of very focused progress this week. From here I plan to finish up the crosvm stuff, and then integrate this protocol into wlroots. Then, not too long from now, we'll finally be able to move the Wayland compositor into its own VM, separate from applications. Exciting! There will also probably be a Chromium OS release next week, which will require some updates in Spectrum. If all goes well, I won't actually be the one doing that this time. ;)

1 0

[PATCH www] todo.html: fix 'appears' -> 'appeals'
by Vincent Ambo 15 May '20

15 May '20

Hello world o/ --- todo.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/todo.html b/todo.html index fd8bc04..b8c091a 100644 --- a/todo.html +++ b/todo.html @@ -26,7 +26,7 @@ system available to experiment with yet. <p> Here are some ideas for contributions, roughly ordered by priority. -If working on any of these appears to you, even if you don't +If working on any of these appeals to you, even if you don't understand all the parts involved, we'd be happy to provide mentorship and support. Just reach out on <a href="participating.html#irc">IRC</a> or email -- 2.26.2.761.g0e0b3e54be-goog

2 1

oops
by impaqt 13 May '20

13 May '20

sorry, this isn't devel-subscribe...

1 0

sign me up
by impaqt 13 May '20

13 May '20

1 0

This Week in Spectrum, 2020-W19
by Alyssa Ross 10 May '20

10 May '20

This week, I want to give a special shoutout to Cole Helbling, who sent three patches to improve our documentation. Non-Alyssa Spectrum patches are quite rare at the moment, so it was very very nice to get these all at once. Thanks Cole! This week has mostly been tidying up loose ends and working on documentation. But there's some good, concrete progress as well. Website ------- <https://spectrum-os.org/> now links directly to my blog and This Week in Spectrum, so that people who come to the website can more easily see that development is ongoing and progress is being made[1]. I've also made it a little more obvious how to find the IRC channel and mailing lists from the homepage[2], because a conversation on the fediverse made me realise that wasn't clear at all before. Cole fixed the advice in the website's CONTRIBUTING file on sending patches for the website[3]. I had written to set Git's "sendemail.subjectPrefix" configuration option, but the option is actually called "format.subjectPrefix". Cole fixed a broken link[4], and I made the incorrect URL redirect to the right one as well, just in case. [1]: https://spectrum-os.org/git/www/commit/?id=8f37213cfd4d5dbd4a982bfc1899a3b3… [2]: https://spectrum-os.org/git/www/commit/?id=6d1ce779016cd84c0413b225355715e5… [3]: https://spectrum-os.org/git/www/commit/?id=8f37213cfd4d5dbd4a982bfc1899a3b3… [4]: https://spectrum-os.org/git/www/commit/?id=13c860e1e5bb02fce683012b851c4451… Developer manual ---------------- Did you know there's a developer manual[5] for Spectrum? There's not a lot in there yet, so for now it might not be all that useful, but it will be one day! I added a section about how to hack on Spectrum's crosvm, because it can be a bit non-obvious how to get up and running with it. I got some great feedback on it on IRC, and a diff from Cole with some fixes. Thanks to everybody who gave me feedback and helped get that documentation into shape. Setting up a crosvm build still isn't all that easy, but at least it's documented. [5]: https://spectrum-os.org/doc/developer-manual.html Infrastructure -------------- Two(?) people trying to clone all of Nixpkgs from the tiny VPS running spectrum-os.org caused the server to run out of memory and return 504 to those clones. It's quite important that people are able to get Spectrum's code, so I've arranged for the VPS to be upgraded with more memory, and so now I just need to reboot the machine so it picks it up. I plan on doing this tomorrow, since there's less likely to be mailing list traffic then than there is immediately after I send this. In the medium term I'll host all this stuff on a more sensible machine, because it's quite clear the workload on this server (which also runs some other stuff) is starting to get beyond the "tiny VPS" territory. IRC --- Activity in #spectrum has really picked up all of a sudden. Hundreds of messages were sent in the second half of this week, mostly talking either about Spectrum or about the future of secure computing in general, and I'm extremely here for all of it. The best thing is that I wasn't even around for most of these conversations! It's hugely motivating to me to feel that people are so interested in Spectrum, and it's great to have people with all sorts of useful knowledge and questions around. If you weren't there, I recommend actually checking out the logs from this period[6], because the conversations being had were just a great read full of interesting stuff. #spectrum feels like it's now at the point where you can start a discussion about secure computing, and be confident that you'll get at least a couple of extremely knowledgeable people involved in the conversation, and that's just fantastic. [6]: https://logs.spectrum-os.org/spectrum/2020-05-06 Wayfire ------- I replaced Sway in the test VM derivation with our newly packaged Wayfire. I was worried at first because wf-shell wasn't starting properly, but strace helped me realise that wf-shell likes HOME to be set, and I hadn't actually done that in the VMs yet. So now that works. There hasn't been much movement on my Wayfire PRs, or my PR to add Wayfire to upstream Nixpkgs, and that's down to me. I felt like after working on it all week last week, I needed a bit of a break. I'll try to get back to it next week so all those PRs can be gotten over the line. crosvm ------ I merged the latest crosvm changes from Google into Spectrum's crosvm tree. Doing this at the moment takes quite a while, because my work-in-progress "interguest" branch has about 50 commits that have to be rebased onto the new master, and quite a lot of those usually result in conflicts. This won't be as much of a problem once that code is ready to be included in master, because updating then will just be a single merge commit, but for now it's a bit of a pain, especially since I try to make sure every commit works. I haven't had much of a look over what's changed yet. There's usually at least one cool new toy to be excited about when I merge Google's crosvm, though, so I look forward to finding out what it is this time. I think that's it for this week, although honestly there have been so many different things going on I've probably missed something. Hopefully next week will be a bit more focused and I'll make more progress with interguest communication. This week, though, we've made some great improvements in several important areas. I'm optimistic that the increased IRC and patch volume are a sign of things to come. I'm looking forward to seeing where things will go from here. :)

1 1

[PATCH www] CONTRIBUTING: fix `git config` suggestion
by Cole Helbling 09 May '20

09 May '20

format-patch is the component that adds to the prefix, not send-email. --- CONTRIBUTING | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 2f1f8b2..7ec8fba 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -23,8 +23,8 @@ automatically prepend a prefix to the subject line of every patch message sent by it in a given repository. You can configure it by running the following command in this Git repository: - git config sendemail.subjectPrefix "PATCH www" + git config format.subjectPrefix "PATCH www" From now on, git-send-email(1) will automatically add "[PATCH www]" to the start of every patch sent for this repository, instead of the -default "[PATCH]". \ No newline at end of file +default "[PATCH]". -- 2.26.2

2 1

[PATCH] doc: fix 404ing link
by Cole Helbling 09 May '20

09 May '20

--- doc/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/index.html b/doc/index.html index c8dea1d..812793b 100644 --- a/doc/index.html +++ b/doc/index.html @@ -22,7 +22,7 @@ <ul> <li><a href="https://spectrum-os.org/doc/developer-manual.html">Developer manual</a> - <li><a href="https://spectrum-os.org/doc/crosvm">crosvm rustdoc</a> + <li><a href="https://spectrum-os.org/doc/crosvm/crosvm/">crosvm rustdoc</a> </ul> <p> -- 2.26.2

2 1

This week in Spectrum, 2020-W18
by Alyssa Ross 03 May '20

03 May '20

A belated Happy International Workers' Day. :) I had some other stuff going on this week but I'm still happy with what I got done. Wayfire ------- I've been working on packaging Wayfire in Nixpkgs so we can use it in Spectrum. (See last week's update for why I've chosen Wayfire for this.) This has required quite a bit of work on Wayfire itself, because up until now Wayfire has assumed that every component, including plugins, will be installed into Wayfire's prefix. With Nix, a package's prefix is only writable by that package, so we need to make some changes to Wayfire to support each component having its own prefix. This is necessary even for our simple case because even a basic Wayfire setup has at least one plugin to provide the desktop shell. Everything is supposed to be a plugin, after all. And we'll want to add our own plugins at some point. To implement plugins in other search paths, I added two environment variables WAYFIRE_PLUGIN_PATH (for libraries) and WAYFIRE_PLUGIN_XML_PATH (for the XML files that define Wayfire plugin options). These are then searched in addition to Wayfire's prefix. Support for plugins coming from multiple prefixes required some small changes in several parts of the Wayfire ecosystem. Wayfire has so far proven to be a very friendly upstream. They understood the problem I was having, even though it's less of an issue on traditional distributions, and I always got quick answers on IRC when I needed to ask for advice on implementing the search paths. Here's the issue I filed describing the need for search paths: https://github.com/WayfireWM/wayfire/issues/493 And here are all the pull requests I made to implement them across the ecosystem: https://github.com/WayfireWM/wayfire/pull/496 https://github.com/WayfireWM/wf-config/pull/25 https://github.com/WayfireWM/wayfire/pull/497 https://github.com/WayfireWM/wf-shell/pull/52 https://github.com/WayfireWM/wf-shell/pull/53 https://github.com/WayfireWM/wcm/pull/17 https://github.com/WayfireWM/wf-shell/pull/54 https://github.com/WayfireWM/wcm/pull/18 With these changes, I can have Wayfire all nicely packaged up. We can even provide a nice Nix interface for configuring a Wayfire with some specific plugins: (wayfireApplications.withPlugins (plugins: with plugins; [ wf-shell ])).wayfire I made a pull request to add Wayfire, with the interface demonstrated above, to Nixpkgs: https://github.com/NixOS/nixpkgs/pull/86606 Unbeknownst to me, while I was working on this, another PR was also opened to add the latest version of Wayfire to Nixpkgs: https://github.com/NixOS/nixpkgs/pull/86569 This PR does a good job of making the basic Wayfire installation work, but it doesn't support extra plugins. Still, it's likely that if this had been available before I started my work, it would have been good enough for us for now. This sort of thing is always a risk, and even if I hadn't done the Wayfire work now I'd have had to come back later anyway to do plugins, so it's not too bad. The author of that PR and I have agreed to work together from here to get Wayfire into Nixpkgs, using my PR as a base because it has the plugins support. So, hopefully by the time I write my next status update all my Wayfire pull requests will have been merged, and Wayfire will be in Nixpkgs. Reviews on the Nixpkgs PR in particular are very much appreciated. :) From here, I'll start trying to modify Wayfire/wlroots to make it request host memory rather than allocating its own, as described in last week's status update. I had a quick look, and it appears that there aren't many places these allocations are happening, so hopefully that shouldn't require too much modification. Then, we should be able to run an application in one VM, displayed on a compositor in another. :)

1 0

This Week in Spectrum, 2020-W17
by Alyssa Ross 26 Apr '20

26 Apr '20

It's been a bit of a slow week, I'm afraid. spectrum-vm ----------- As mentioned last week, it was becoming extremely inconvenient to test out custom kernel/crosvm/rootfs builds by modifying a Nix expression every time. So I wrote spectrum-vm, a small program that takes command line arguments for kernel, crosvm, and rootfs paths to use, and falls back to pre-built defaults if any of those aren't specified. This makes turnaround time on testing different kernel builds much quicker, because they can be built incrementally outside of nix sandboxes. To make things more concrete, suppose I have built a kernel in /home/src/linux/arch/x86_64/boot/bzImage, and I want to test it with the Spectrum crosvm demo setup. I can run spectrum-vm -k /home/src/linux/arch/x86_64/boot/bzImage and I get a VM booted from that kernel, with no need to nix-build anything. By default, the launched VM will run Weston Terminal inside a Wayland compositor. But you can even replace this with a custom command: spectrum-vm -c 'echo "Hello, world!"' The implementation of that last bit is quite the hack. I'll leave figuring out how it works as an exercise to the reader. ;) spectrum-vm is available now in Spectrum's Nixpkgs as spectrumPackages.spectrum-vm, as of commit 817a1a9b0de30d8bbc2ad2e80a802d87c56e96ff. Implementing this has meant that the huge start-vm.nix file that used to exist on the crosvm-demo branch had to be split up into a bunch of discreet units. This is really great, because start-vm.nix was starting to grow enormous, and experimenting with changes was becoming A Problem. Now, that's all nice and modular under the new spectrumPackages namespace. And _that_ means that the crosvm-demo branch can finally go away, and Spectrum's Nixpkgs is no longer split across two branches. (The purpose of the separation was to avoid there being a horrible start-vm.nix file in the root on master.) So in addition to a lovely helpful tool, this has also resulted in much cleaner code. Yay! One feature I would still like to add is an option that maps to crosvm run's --shared-dir, to mount a directory into a VM over 9p. That would make getting code into a VM to test it extremely convenient. I haven't gotten around to it yet though. Guest memory sharing -------------------- Last week I shared a bunch of research I had done on sharing guest-allocated buffers with other VMs. I was hoping to avoid having to patch a Wayland compositor to request buffers from the host instead of allocating them itself, but I've since come to the conclusion that avoiding that won't be feasible, for now at least. Basically, the kernel primitives aren't there yet, and it would be silly for me, with almost zero kernel development experience, to attempt to write them. There are all sorts of horrible edge cases to think about, like what happens if the guest-allocated memory moves around. Compared to this, patching a Wayland compositor doesn't seem too bad. Having to go through a request/response over a vsock to the host will be a bit of a performance overhead compared to a smarter solution, but I think this kind of allocation happens rarely enough that it probably doesn't matter anyway. A nice middle ground would have been to use virtio-gpu resources rather than a custom message over a vsock. It would have been a much cleaner way to do it, and it might not even involve writing any kernel code, but the practical benefits of it would be extremely limited when contrasted with the time it would take me to implement that. I don't expect the approach I'm taking now of patching the Wayland compositor to necessarily be permanent. As I linked to last week, there are kernel efforts happening to add the necessary primitives to share guest allocations. At some point in the future we might be able to use them. And at basically any time we could switch to using virtio-gpu resources if somebody wanted to put in the work. Patching a compositor really isn't a big deal, though. It's unlikely Spectrum will support more than one compositor anyway, because we'll need to customise it to do things like Qubes-style window borders that are coloured based on security domain. And, even then, if we're using a wlroots-based compositor, it's probably only wlroots that needs patching, so in that case any other wlroots-based compositor would probably work. Speaking of compositors... Wayfire ------- If you know what Wayfire is, you're probably surprised to see it as an item in a Spectrum status update it. If you don't, Wayfire is a Wayland compositor notable for having a bunch of over-the-top Compiz-style graphical effects, like wobbly windows and the titular fire. I recommend checking out the demo videos on https://wayfire.org/ if you haven't seen them -- it's quite something. But I bring this up not because I think support for wobbly windows is imperative to Spectrum's chances of success, but because fundamentally Wayfire is just an extremely modular Wayland compositor. Virtually everything in Wayfire is implemented as a plugin. Switching between windows is a plugin, screen zoom is a plugin, and so on. This is really cool because in Spectrum we'll want to have, for example, coloured window decorations like in Qubes. With any other compositor, we'd have to hack that into the compositor internals somehow. With Wayfire, it can just be a plugin. Wayfire is also a pleasantly simple but featureful windowing experience. You can drag windows around, put two side by side by dragging them to screen edges, have multiple workspaces, etc. I think it will be straightforward enough to not be a problem for people coming to Spectrum regardless of their computing background, and powerful enough to not get in the way of Serious Computer Business. And anything missing could of course be implemented as a plugin. ;) So, I've been doing some work to package Wayfire in Nixpkgs. This is not all that easy, because Wayfire seems to assume that plugins will be installed into Wayfire's prefix. This isn't really possible with Nix unless you compile all the plugins along with Wayfire, so I'm working some patches for Wayfire to look up plugins in a search path specified as an environment variable, which on the Nix side we can then wrap in the idiomatic wayfireWithPackages style. My initial impressions of the Wayfire codebase are that it is relatively clean, and straightforward enough to understand. The core compositor is about 13000 SLoC, which is pleasantly small. That, unfortunately, is it for this week. I didn't get as much done as I'd hoped, but I did at least have loads of good thoughts about things to do later in Spectrum's development, that aren't quite concrete enough to put into words yet.

1 0

[PR nixpkgs] crosvm: 79.12607.0.0-rc4 -> 81.12871.0.0-rc1
by Alyssa Ross 21 Apr '20

21 Apr '20

Extracted crosvm update from recent chromiumOSPackages update in Spectrum for upstreaming. https://github.com/NixOS/nixpkgs/pull/85731

1 0

This Week in Spectrum
by Alyssa Ross 19 Apr '20

19 Apr '20

Wow, a week isn't very long at all. But still, there's definitely enough to write about, even if I spent most of the week just reading mailing list threads. More on that in a bit. Spectrum Live + nixpkgs ----------------------- I did another stream. This time, we looked at updating the Chromium OS packages in Spectrum. The script I used to update them had broken -- it was stuck on an old version, so first we had to fix the script, and then fix the package builds. A lot of the Chromium OS packages aren't actually necessary at the moment, but I made them a while ago when it looked like they would be. I couldn't get one particular such package, libchrome, to build any more at all after spending quite a few hours on it, so I ended up just dropping it, along with libbrillo, which depended on it. Some other package updates had some complexity, but we managed to work through them all on the stream. This stream was much more focused on what I was working on than the last one. The last one was more about people asking general questions and me answering them and demonstrating things. This time I stayed on the package updates for the whole stream. I figure people asked all their questions last time. But there were lots of questions about specific issues in the package updates, etc. It was nice to know that I had explained things sufficiently well that people could follow along with what I was doing. Viewer numbers were up too, which was nice. We were on 15 for most of the stream. The packaging work I mostly did on the stream, and then finished up afterwards is here: https://spectrum-os.org/git/nixpkgs/log/?h=2bd191e91f097ff2146099fae8b7c8bd… And a couple of small upstream Nixpkgs PRs: https://github.com/NixOS/nixpkgs/pull/85549 https://github.com/NixOS/nixpkgs/pull/85551 crosvm still needs to be updated in upstream Nixpkgs. If you want to help out, this might be a good thing to pick up! You'd need to copy the update.py change I made in Spectrum's Nixpkgs to the crosvm update.py in upstream Nixpkgs, and then copy the changes in Spectrum nixpkgs' crosvm to upstream Nixpkgs's crosvm. If not, I'll probably get to it in a few days. crosvm ------ Last week, I said that we might me able to use Virtio Wayland as a transport for crosvm device <-> crosvm communication across a VM boundary, but that I'd just had the idea and I might decide it couldn't work. Having researched it extensively this week, reading over the code for the virtio_wl kernel driver with puck and consuming a huge number of messages on assorted kernel-adjacent mailing lists, I think we can make it work, and it's our best path forward, but I'm still not sure how exactly. The main problem is that Virtio Wayland can only send shared memory from host to guest, not the other way around. So when a Wayland compositor in a guest hands the Wayland crosvm device, it's not going to be able to pass it over the VM boundary to the crosvm instance running a Wayland client. Sharing a guest memory buffer with the host, or another guest, turns out not to be a solved problem in general. As an example, here is a very long mailing list thread about how a generic way to do this could work, from November/December, which reached no firm conclusions: https://lore.kernel.org/linux-media/20191105105456.7xbhtistnbp272lj@sirius.… I expect that for most devices, e.g. the network driver, this won't be a problem. But we're definitely going to need this for Wayland. One option would be to modify a Wayland compositor to make it ask the host for some shared memory, rather than allocating its own shared memory buffer. That would work, but it's the last resort, because it would have to be a modification made to any Wayland compositor we might want to use. At a high level, what we want to do is have a crosvm device running inside a device VM tell crosvm that a certain address in guest memory is some shared memory, and have it handle that as it would shared memory it had allocated itself. crosvm does support sending dmabufs from guest to host, because of virtio-gpu. There's a relatively new kernel API called udmabuf that converts a memfd into a dmabuf, which sounds like it should solve exactly this problem. It has no documentation in the kernel, but I did manage to find a small amount of documentation in a patch that was for some reason never applied[1]. I then managed to write a small test program that at least called all the ioctls properly and ended up with a dmabuf. Actually testing this any further will involve a VM, and testing this sort of thing in a VM at the moment is a real pain, and I want to make a small tooling improvement around that before I proceed any further with testing udmabuf. There are also good reasons to suspect that the udmabuf idea won't work anyway. puck thinks that the only dmabufs Virtio Wayland will be able to transfer are those allocated by virtio-gpu. So, not dmabufs that we just made out of a memfd given to us by a Wayland compositor. If udmabuf ends up not working, I'll want to see whether we can use virtio-gpu to allocate dmabufs. The problem with this is that I don't know how we'll bridge compositor shared memory to virtio-gpu dmabufs. It'll presumably involve writing kernel code, which I've been pleased to avoid so far. I can at least probably use the udmabuf implementation as a starting point. The third least bad option would be to modify the virtio_wl kernel driver so it supports shared memory originating from the guest. This would be very nice to use from userspace, but I just don't think there's any way I'll be able to write the required kernel code. And the fourth least bad option (the worst one) would be to modify the compositor as mentioned above. spectrum-vm ----------- The current way of running a Spectrum test VM is to build and run a file called start-vm.nix that lives in the root of a non-default branch of Spectrum's nixpkgs called crosvm-demo. Any time you want to try a custom kernel, rootfs, or crosvm, you need to modify this file. This is extremely annoying. Also, as time goes on, start-vm.nix is getting longer and longer, and more and more difficult to understand. So I think it's finally time to do something better. The something better is that we introduce derivations for a Spectrum rootfs, guest kernel, and crosvm, and then provide a program, spectrum-vm, that by default runs a VM with those three components. It would also have options for overriding those components, so if you built a custom kernel you could just drop that one in instead of the default one, for example. And finally, it would allow changing the flags passed to crosvm. I started working on this this morning, and I'm quite excited about it. It's not going to take very long at all to do, but it's going to be such a big improvement. It will also mean I no longer have a separate crosvm-demo branch, to merge Spectrum nixpkgs master into every time I update it. So I'm going to spend the next couple of days on this, and then get back into investigating udmabuf with a nice new tool. So, that's what happened this week. I feel like I just spent most of the week reading mailing lists and not making much progress, but I've managed to write quite a lot (again) so I suppose I've accomplished something! Now, I've been extremely immersed in this stuff all week, and I suspect that some of this update, especially the crosvm stuff, will not be clear to somebody who has not been similarly immersed. And, it's getting dangerously close to midnight UTC, my self-imposed This Week in Spectrum deadline. So I'm going to send this as is, even though it's probably confusing. But! I do want you to understand what's going on. So please feel free to reply and point out anything I didn't explain very well and ask me for a better explanation. Just be prepared for me not to know the answer, since I'm still trying to figure out a lot of this stuff! As a nice side effect, maybe we'll get a mailing list discussion going. :) [1]: https://lore.kernel.org/lkml/20180911134216.9760-14-kraxel@redhat.com/

1 0

This week in Spectrum
by Alyssa Ross 12 Apr '20

12 Apr '20

Before we begin, **if you are subscribed only to the discuss mailing list**, I'd like to hear from you whether you'd like future weekly development updates to come to you or not, because I'm not really sure whether this sort of update belongs on the devel mailing list, or the discuss one. So for this initial edition, I'm sending to both, but I probably won't do that going forward. So, as I wrote in the recent status update on my blog, I'm going to try weekly(?) mailing updates instead of lengthy blog posts every few months. I was going to start last week, but I ended up taking most of the week off because I'd been working every day for a long time and was starting to find it difficult to concentrate. But I'm back now, and this week has been a good one. Spectrum Live ------------- (This was actually last week, but I felt this deserved a mention.) A bit more than a week ago now, I did a live stream where I showed myself working on a fairly simple change to crosvm. Viewer numbers stabilised at around 11, and we had a lively IRC conversation, which I was pleasantly surprised by. I ended up spending most of the stream not working on that change, but instead explaining how various things in the system will work, and helping getting a couple of people started running the Spectrum code. By the end of the stream two people had succeeded in this, and that means two people who are set up to work on Spectrum. One was even starting work on trying to build a smaller kernel for Spectrum VMs! Overall I think this was extremely successful, and I'll try to do it again soon. I'll announce the stream a bit ahead of time in #spectrum on Freenode. crosvm ------ Having previously split crosvm into two separate programs -- one to run a virtual device, and one to run a device VM -- I further split it into three programs. This might sound a bit silly, but here's the idea -- one program is the crosvm that runs an application VM, the second will become part of the crosvm that runs a device VM, and the third will be the device implementation itself, that will run inside the device VM. As a reminder, the overall idea here is to put virtual devices into their own VMs, rather than being run directly on the host. I also pulled in the latest changes from Google. Of particular note is commit 146450b, which updates the msg_socket library to support dynamically sized messages. If you're paying attention, you'll recall that I just wrote my own serde-based replacement for msg_socket because I needed to do exactly this. That work might now have been superseded, but I'm not sure yet. msg_socket2 uses SOCK_STREAM sockets (which can be used between VMs or VM<->guest), while msg_socket uses SOCK_SEQPACKET, which can't. I haven't checked whether msg_socket's new implementation could work without SOCK_SEQPACKET-style preserved message boundaries -- if it can't, msg_socket2 will stick around. msg_socket2 also properly handles file descriptor lifetimes using the borrow checker. This means that safe Rust code can't send closed or non-existent file descriptors over msg_socket2. msg_socket does not do this, because it just represents file descriptors as integers with no lifetime information. Whatever happens to msg_socket2, at some point I'll want to make msg_socket do file descriptor lifetimes properly. In general, it's not clear from existing documentation how to properly handle file descriptor lifetimes in Rust, and so I plan a blog post on this topic soon. The next problem is to figure out communication between the device VM and the device crosvm. The protocols currently in use rely on being able to share memory using file descriptors, which is not possible between a VM and the host. To avoid using file descriptors, I would have to change those protocols, possibly on a per-device basis, which would be a lot of work, and might have to be done again whenever crosvm adds a new device type. But, I think I might have a better, if surprising solution. Despite its name, the Virtio Wayland protocol has almost nothing to do with Wayland. Instead, it's a fairly generic socket-like protocol that allows sending "virtual file descriptors" of certain specific types between a VM and its host. So I think I should be able to send this sort of communication over "Virtio Wayland", without requiring any changes to the communications being channeled. I just had this idea, so it's entirely possible it won't work out, but I think it's a neat unexpected reuse of a cool technology. Infrastructure -------------- The web interface for the Spectrum mailing lists has been upgraded from Django 1.11 (which is now EOL) to Django 2.2 (current LTS; Nixpkgs default). I sent this upstream as Nixpkgs PR #84896. Additionally, spectrum-os.org. now has an SPF header, which I thought was already there but apparently wasn't. This should help with mailing list deliverability. That's it for this week. Feel free to reply with any comments or insights, either on the content or the format. I'll try to be back with another development update next week.

2 1

[PATCH] start-vm: Remove rngd (unecessary since the introduction of khwrngd)
by Nicolas Braud-Santoni 29 Dec '19

29 Dec '19

khwrngd provides the same functionality as rngd here, but is integrated in the kernel, and started by default by the hwrng driver as soon as the device is initialized. It was added in Linux 3.17 by the following commit: commit be4000bc4644d027c519b6361f5ae3bbfc52c347 Author: Torsten Duwe <duwe(a)lst.de> Date: Sat Jun 14 23:46:03 2014 -0400 hwrng: create filler thread This can be viewed as the in-kernel equivalent of hwrngd; like FUSE it is a good thing to have a mechanism in user land, but for some reasons (simplicity, secrecy, integrity, speed) it may be better to have it in kernel space. This patch creates a thread once a hwrng registers, and uses the previously established add_hwgenerator_randomness() to feed its data to the input pool as long as needed. A derating factor is used to bias the entropy estimation and to disable this mechanism entirely when set to zero. --- start-vm.nix | 8 -------- 1 file changed, 8 deletions(-) diff --git a/start-vm.nix b/start-vm.nix index 442f83a8f45..66fb358cb39 100644 --- a/start-vm.nix +++ b/start-vm.nix @@ -45,14 +45,6 @@ let s6-linux-init-hpr -fr ''; } // services.".s6-svscan" or {}; - - rngd = { - run = writeScript "rngd-run" '' - #! ${execline}/bin/execlineb -P - ${rng-tools}/bin/rngd -f -x pkcs11,rdrand - ''; - } // services.rngd or {}; - } // services; in -- 2.24.0

2 1

[PATCH] start-vm.nix: implement 3-stage init
by Alyssa Ross 09 Dec '19

09 Dec '19

This uses s6-svscan as stage 2. Right now all that means is reaping zombies -- there are no services for it to supervise. The application being run in the VM (sommelier hello-wayland in this case) is just run as a direct child of init. I felt it didn't belong as a service because it shouldn't be restarted when it terminates. I don't use s6-linux-init for a couple of reasons: - A lot of the reason to use s6-linux-init comes from wanting to do clever things to seamlessly redirect logs from the console to the file system at some point during stage1. For VMs, I think we're better just logging to the console so logs can be managed in one place on the host. - s6-linux-init is a pain with Nix, because s6-linux-init-maker needs to be run as root, and it generates stuff like pipes that can't be stored in the Nix store. coreutils is only used for cp-ing stage3 to the right place. When services are implemented, this can be removed and the VMs will have one less dependency. To shutdown, we use reboot instead of poweroff because that's what actually gets crosvm to quit. reboot(RB_POWER_OFF) seems to be interpreted by the kernel as halt for some reason I have failed to determine. It prints the halt message and everything. reboot(RB_HALT_SYSTEM) does exactly the same thing. Maybe it's just something to do with running in a VM. --- I've pushed this to crosvm-demo already, but I'm posting it here for feedback and suggestions, especially from anybody with experience with inits or s6. start-vm.nix | 54 +++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/start-vm.nix b/start-vm.nix index b8d20007521..1345a5620c6 100644 --- a/start-vm.nix +++ b/start-vm.nix @@ -14,25 +14,57 @@ let DEVTMPFS_MOUNT = yes; }; }; - init = writeShellScript "init" '' - set -xe - ${coreutils}/bin/mkdir /dev/pts /dev/shm - ${utillinux}/bin/mount -t tmpfs none /tmp - ${utillinux}/bin/mount -t devpts -o gid=4,mode=620 none /dev/pts - ${utillinux}/bin/mount -t tmpfs none /dev/shm - export XDG_RUNTIME_DIR=/tmp - ${sommelier}/bin/sommelier ${hello-wayland}/bin/hello-wayland + stage1 = writeScript "stage1" '' + #! ${execline}/bin/execlineb -P + importas -i PATH PATH + export PATH ${lib.makeBinPath + [ s6-linux-init s6-portable-utils s6-linux-utils s6 execline coreutils ]} + ${s6}/bin/s6-setsid -qb -- + umask 022 + if { s6-mount -t tmpfs -o mode=0755 tmpfs /run } + if { s6-mkdir -p /run/service/.s6-svscan } + if { cp ${stage3} /run/service/.s6-svscan/finish } + emptyenv -p + + background { + s6-setsid -- + if { s6-mkdir -p /run/user/0 /dev/pts /dev/shm } + if { s6-mount -t devpts -o gid=4,mode=620 none /dev/pts } + if { s6-mount -t tmpfs none /dev/shm } + if { s6-mount -t proc none /proc } + export XDG_RUNTIME_DIR /run/user/0 + foreground { ${sommelier}/bin/sommelier ${hello-wayland}/bin/hello-wayland } + importas -i ? ? + if { echo STATUS: $? } + s6-svscanctl -6 /run/service + } + + unexport ! + cd /run/service + s6-svscan + ''; + + stage3 = writeScript "stage3" '' + #! ${execline}/bin/execlineb -S0 + foreground { s6-nuke -th } + s6-sleep -m -- 2000 + foreground { s6-nuke -k } + wait { } + s6-linux-init-hpr -fr ''; rootfs = runCommand "rootfs" {} '' - mkdir dev bin tmp + mkdir bin dev proc run tmp ln -s ${dash}/bin/sh bin - (cat ${writeReferencesToFile init}; printf "%s\n" bin dev tmp) | xargs tar -cP --hard-dereference | ${squashfs-tools-ng}/bin/tar2sqfs $out + + (cat ${writeReferencesToFile stage1}; printf "%s\n" bin dev proc run tmp) \ + | xargs tar -cP --owner root:0 --group root:0 --hard-dereference \ + | ${squashfs-tools-ng}/bin/tar2sqfs $out ''; in writeShellScript "crosvm" '' set -x - exec ${crosvm}/bin/crosvm run --wayland-sock=$XDG_RUNTIME_DIR/$WAYLAND_DISPLAY -p init=${init} --root=${rootfs} ${kernel}/bzImage + exec ${crosvm}/bin/crosvm run --wayland-sock=$XDG_RUNTIME_DIR/$WAYLAND_DISPLAY -p init=${stage1} --root=${rootfs} ${kernel}/bzImage '' -- 2.23.0

1 0

[spectrum-devel] Proposed design sketch
by Michael Raskin 21 Oct '19

21 Oct '19

Hello So I tried to look over what happens in my system, and then apply some hardening to it. The following is what I got. ///// Design sketch of a SpectrumOS prototype User starts an application with some choice of VM base image/capabilities, store paths available inside the VM, the store paths to add to environment, state directories readable/writeable in VM, external capabilities connected to the VM, internal devices visible to the applications. Single-use state directory may be designated to provide a VM with fully-owned secondary-storage-backed tmp-like space. Layout of the state directories visible to the VM can be adjusted. As a special case support there is support for generating VM-specific configuration files such as /etc/passwd (these should not be prebuilt due to per-launch UID generation). A unique UID is assigned to the VM. This UID is added to the ACLs so it can read the state directories assigned and all their subdirectories (files are world-readable by default). It also gets access to write to the writeable directories and possibly to some of the files in these directories UIDs/ACLs are tracked. The user can assign a UID to an alias for further reuse (this reduces the need for updating ACLs all the time). One-time UIDs are reused as rarely as possible. When a VM with a single-use UID quits, its UID is removed from the ACLs of the granted files. There is also a periodic enumeration of files in order to clean up long-obsolete ACLs in came of unclean shutdown or similar events. A temporary directory is created. Everything that should be visible inside the VM is bind-mounted there. This includes devices. An isolated environment is set up for the VM to run. VM is started serving the state directories and store paths to the inside via virtfs/virtio-fs. Inside VM the extra device node are removed from /dev/. Requested store paths are added to PATH and possibly to other variables like LD_LIBRARY_PATH or QT_PLUGIN_PATH as requested. Read-only state directories are bind-mounted over themselves read-only. The specified program is started normally under numerically the same UID as assigned to the VM (to avoid the need to use UID mapping). There are some predefined wrappers to launch a program requiring, for example, a D-Bus session in a VM-local D-Bus session. A special type of wrappers is restricted-environment setup, to reduce the ability of an program to attack the surrounding VM. (VM might eventually run a different OS kernel type than the host) Special kinds of resources: Expected to be handled by the VM: DRI passthrough. Sound passthrough (wrapper to launch full isolated PulseAudio). GUI is handled via virtio-wayland. Local sockets (such as ssh-agent): hopefully can be handled by the file sharing solution. Network: VM connected by socket to a virtual switch leading to a firewall VM, VM itself runs in no-network environment. Cross-VM network links do not correspond to any visible files inside the VM-surrounding isolated environment. A firewall VM per ruleset (can be shared for multiple Firefox instances with the same security profile). Firewall VMs connect via a virtual switch to the network-handling VM; it may have addressless filtering bridge VMs on both sides. External storage: considered a special case of state storage; might not support ACLs (so access control is purely by ro/rw bind mounts outside and inside the VM). Nontrivial external hardware: USB/PCI pass through?

1 0

[spectrum-devel] [PATCH www] design: state subdirectories, not block devices
by Alyssa Ross 18 Oct '19

18 Oct '19

Conversation on IRC has convinced me that this is the right thing to do after all: <https://logs.spectrum-os.org/spectrum/2019-10-15#1571117332-1571144389;> --- Jean-Phillipe, I'd be curious to hear your thoughts on the above discussion, since you recommended block devices to me when we talked. design.html | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/design.html b/design.html index 4b96a41..dc14cfe 100644 --- a/design.html +++ b/design.html @@ -43,23 +43,22 @@ one per application. Each virtual machine will be generated by a <a href="https://nixos.org/nix/">Nix</a> derivation, and will have a completely immutable root file system. Persistent storage will be -provided by virtual block devices, that arbitrary paths on the system -can be mapped to from the host. There may be other writable mount -points inside the virtual machine, but these will not persist between -reboots of the VM. Using Nix to generate virtual machines allows them -to be reproducibly built, rolled back, edited, and migrated as source -code, rather than large, opaque virtual machine images. +provided by mounting subdirectories of the global state directory into +virtual machines. There may be other writable mount points inside the +virtual machine, but these will not persist between reboots of the VM. +Using Nix to generate virtual machines allows them to be reproducibly +built, rolled back, edited, and migrated as source code, rather than +large, opaque virtual machine images. <p> -Virtual block devices will also be defined in Nix, and block devices -and applications will be <var>m</var>:<var>n</var>. Some virtual -machines may have no persistent storage, or even write access to a -disk, at all. In other cases, it might be desirable for multiple -applications to be able to access the same device, such as a local -mail store being shared by two mail clients. Other resources and -permissions, such as network cards and USB controllers, will similarly -be defined in Nix. There are three logical sections for the Nix -configuration -- applications, which are just packages, resources +State directories and applications will be <var>m</var>:<var>n</var>. +Some virtual machines may have no persistent storage, or even write +access to a disk, at all. In other cases, it might be desirable for +multiple applications to be able to access the same device, such as a +local mail store being shared by two mail clients. Other resources +and permissions, such as network cards and USB controllers, will +similarly be defined in Nix. There are three logical sections for the +Nix configuration -- applications, which are just packages, resources (virtual or physical devices), and <i>application instances</i>, which are mappings between applications and accessible resources. This structure allows users to have multiple instances of the same -- 2.23.0

2 7

[spectrum-devel] [PATCH] nlnet: software bill of materials
by Alyssa Ross 17 Oct '19

17 Oct '19

This changes the URI for the application too, but that was never published anywhere so I think it's fine. --- Anything I've missed? .../application.html | 0 nlnet-pet-2019-03/bom.txt | 8 ++++++++ 2 files changed, 8 insertions(+) rename nlnet-pet-2019-03.html => nlnet-pet-2019-03/application.html (100%) create mode 100644 nlnet-pet-2019-03/bom.txt diff --git a/nlnet-pet-2019-03.html b/nlnet-pet-2019-03/application.html similarity index 100% rename from nlnet-pet-2019-03.html rename to nlnet-pet-2019-03/application.html diff --git a/nlnet-pet-2019-03/bom.txt b/nlnet-pet-2019-03/bom.txt new file mode 100644 index 0000000..5ba36a2 --- /dev/null +++ b/nlnet-pet-2019-03/bom.txt @@ -0,0 +1,8 @@ +Spectrum -- Software Bill of Materials +====================================== + +- Linux (notably KVM): <https://kernel.org/> +- Nix: <https://nixos.org/nix/> +- Nixpkgs: <https://nixos.org/nixpkgs/> +- crosvm: <https://chromium.googlesource.com/chromiumos/platform/crosvm/> +- A Wayland compositer (undecided which one) -- 2.23.0

1 1