fix: bump abi version

Signed-off-by: Tomasz Andrzejak <andreiltd@gmail.com>

Author: andreiltd

CHANGELOG.md

@@ -30,7 +30,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
   the configured level is above `OFF` rather than whether the tracing state was
   allocated.
 * **Breaking:** Virtqueue rings and pools occupy host-owned scratch before page
-  tables. Snapshots use ABI 4 and config schema v2. Existing snapshots must be
+  tables. Snapshots use ABI 5 and config schema v3. Existing snapshots must be
   regenerated.
 * Host virtqueue access uses checked copies and atomics across mapped scratch.
   Snapshot admission checks geometry, canonical ring state, and H2G buffer shape.
@@ -46,7 +46,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 * Require guest logs and all host and guest function calls to use virtqueues.
 * Keep registered Rust guest return values typed until transport encoding so
   external byte results avoid intermediate FlatBuffer copies.
-* Store canonical virtqueue rings in versioned OCI transport layers. Config v2
+* Store canonical virtqueue rings in versioned OCI transport layers. Config v3
   rejects snapshots without transport state.
 * Running snapshots checkpoint dirty virtqueues before capture. Ordinary calls
   keep their deferred result path.

docs/snapshot-oci-format.md

@@ -32,7 +32,7 @@ Four blob kinds per tag:
 * **manifest** (`application/vnd.oci.image.manifest.v1+json`). Tiny JSON
   pointer record selected via `index.json`. References one config and
   two layers by digest.
-* **config** (`application/vnd.hyperlight.snapshot.config.v2+json`). The
+* **config** (`application/vnd.hyperlight.snapshot.config.v3+json`). The
   snapshot descriptor: arch, hypervisor, CPU vendor, ABI version,
   resume address and captured registers, memory and transport layout,
   registered host functions, and snapshot generation counter. Loaded

docs/snapshot-versioning.md

@@ -27,14 +27,16 @@ A snapshot carries four independently evolvable version markers:
   (`application/vnd.hyperlight.snapshot.transport.v1`), aliased as
   `MT_TRANSPORT_CURRENT`. This is the binary encoding of canonical
   virtqueue state stored outside the memory layer.
-* **Config schema**, `MT_CONFIG_V2`
-  (`application/vnd.hyperlight.snapshot.config.v2+json`), aliased as
+* **Config schema**, `MT_CONFIG_V3`
+  (`application/vnd.hyperlight.snapshot.config.v3+json`), aliased as
   `MT_CONFIG_CURRENT`. This is the JSON shape of the config blob:
   field names, types, required vs optional, the descriptors the loader
   needs in order to reconstruct the sandbox (memory sizes, buffer
   sizes, `abi_version`, `hyperlight_version`, etc.). Renaming a field,
   changing its type, or adding a required field is a schema change and
-  bumps this constant. Version 2 requires a transport layer.
+  bumps this constant. Version 3 describes the virtqueue-only memory layout
+  and requires a transport layer. Config v1 and v2 are incompatible with
+  the current ABI.
 
 The `OCI_LAYOUT_VERSION` constant is pinned by the OCI image-layout
 spec at `1.0.0`.

fuzz/fuzz_targets/virtq_roundtrip.rs

@@ -51,12 +51,9 @@ fuzz_target!(|data: &[u8]| -> Corpus {
         Layout::from_base(BASE_ADDR, NonZeroU16::new(QUEUE_SIZE as u16).unwrap()).unwrap()
     };
 
-    let pool = SlotPool::new(SlotLayout::new(
-        BASE_ADDR + ring_bytes as u64,
-        SLOT_SIZE,
-        QUEUE_SIZE,
-    ))
-    .unwrap();
+    let pool_layout =
+        SlotLayout::new(BASE_ADDR + ring_bytes as u64, SLOT_SIZE, QUEUE_SIZE).unwrap();
+    let pool = SlotPool::new(pool_layout).unwrap();
 
     let mut producer = VirtqProducer::new(layout, mem.clone(), NoopNotifier, pool.clone());
     let mut consumer = VirtqConsumer::new(layout, mem, NoopNotifier);

src/hyperlight_guest/src/transport/mem.rs

@@ -295,7 +295,8 @@ mod tests {
         let base = backing.as_mut_ptr() as u64;
         // SAFETY: Backing remains live until all mapped views are dropped.
         let mem = unsafe { GuestMemOps::from_raw_parts(base, 8) };
-        let pool = SlotPool::new(SlotLayout::new(base, 8, 1)).unwrap();
+        let layout = SlotLayout::new(base, 8, 1).unwrap();
+        let pool = SlotPool::new(layout).unwrap();
         let allocation = pool.alloc(8).unwrap();
         let lease = BufferLease::new(pool.clone(), allocation);
 
@@ -320,7 +321,8 @@ mod tests {
         let base = backing.as_mut_ptr() as u64;
         // SAFETY: Backing remains mapped for the accessor's lifetime.
         let mem = unsafe { GuestMemOps::from_raw_parts(base, 8) };
-        let pool = SlotPool::new(SlotLayout::new(base + 8, 8, 1)).unwrap();
+        let layout = SlotLayout::new(base + 8, 8, 1).unwrap();
+        let pool = SlotPool::new(layout).unwrap();
         let allocation = pool.alloc(8).unwrap();
         let lease = BufferLease::new(pool.clone(), allocation);
 

src/hyperlight_host/src/sandbox/snapshot/file/config.rs

@@ -153,7 +153,7 @@ impl CpuVendor {
 
 /// Top-level Hyperlight snapshot config JSON. Lives at
 /// `blobs/sha256/<config-digest>` with media type
-/// `application/vnd.hyperlight.snapshot.config.v2+json`.
+/// `application/vnd.hyperlight.snapshot.config.v3+json`.
 ///
 /// In OCI terms this is the "image config" blob that the manifest's
 /// `config` descriptor points to. It describes the accompanying
@@ -907,7 +907,7 @@ mod schema_pin {
     const PINNED_CALL: &str = r#"{
   "hyperlight_version": "x.y.z",
   "arch": "x86_64",
-  "abi_version": 4,
+  "abi_version": 5,
   "hypervisor": "mshv",
   "cpu_vendor": "intel",
   "stack_top_gva": 3735928559,
@@ -1097,7 +1097,7 @@ mod schema_pin {
     const PINNED_CALL: &str = r#"{
   "hyperlight_version": "x.y.z",
   "arch": "aarch64",
-  "abi_version": 4,
+  "abi_version": 5,
   "hypervisor": "mshv",
   "cpu_vendor": "intel",
   "stack_top_gva": 3735928559,

src/hyperlight_host/src/sandbox/snapshot/file/media_types.rs

@@ -8,7 +8,9 @@ pub(in crate::sandbox::snapshot) const MT_CONFIG_V1: &str =
     "application/vnd.hyperlight.snapshot.config.v1+json";
 pub(in crate::sandbox::snapshot) const MT_CONFIG_V2: &str =
     "application/vnd.hyperlight.snapshot.config.v2+json";
-pub(in crate::sandbox::snapshot) const MT_CONFIG_CURRENT: &str = MT_CONFIG_V2;
+pub(in crate::sandbox::snapshot) const MT_CONFIG_V3: &str =
+    "application/vnd.hyperlight.snapshot.config.v3+json";
+pub(in crate::sandbox::snapshot) const MT_CONFIG_CURRENT: &str = MT_CONFIG_V3;
 pub(in crate::sandbox::snapshot) const MT_SNAPSHOT_V1: &str =
     "application/vnd.hyperlight.snapshot.memory.v1";
 pub(in crate::sandbox::snapshot) const MT_SNAPSHOT_CURRENT: &str = MT_SNAPSHOT_V1;
@@ -19,7 +21,7 @@ pub(in crate::sandbox::snapshot) const MT_TRANSPORT_CURRENT: &str = MT_TRANSPORT
 /// ABI version for the snapshot memory blob. Bumped when the
 /// host-guest contract for the snapshot bytes changes. See
 /// docs/snapshot-versioning.md.
-pub(in crate::sandbox::snapshot) const SNAPSHOT_ABI_VERSION: u32 = 4;
+pub(in crate::sandbox::snapshot) const SNAPSHOT_ABI_VERSION: u32 = 5;
 
 /// OCI standard annotation key for a manifest's tag inside an image
 /// index. Set on the manifest descriptor in `index.json`, not on the

src/hyperlight_host/src/sandbox/snapshot/file/mod.rs

@@ -27,8 +27,8 @@ use self::media_types::{
     ANNOTATION_ARCH, ANNOTATION_CPU, ANNOTATION_HYPERVISOR, ANNOTATION_REF_NAME,
 };
 pub(super) use self::media_types::{
-    MT_CONFIG_CURRENT, MT_CONFIG_V1, MT_CONFIG_V2, MT_SNAPSHOT_CURRENT, MT_SNAPSHOT_V1,
-    MT_TRANSPORT_CURRENT, MT_TRANSPORT_V1, SNAPSHOT_ABI_VERSION,
+    MT_CONFIG_CURRENT, MT_CONFIG_V1, MT_CONFIG_V2, MT_CONFIG_V3, MT_SNAPSHOT_CURRENT,
+    MT_SNAPSHOT_V1, MT_TRANSPORT_CURRENT, MT_TRANSPORT_V1, SNAPSHOT_ABI_VERSION,
 };
 use self::reference::{OciDigest, OciReference, OciTag};
 use super::{NextAction, Snapshot};
@@ -771,18 +771,19 @@ impl Snapshot {
         // Loader dispatch on config media type.
         let cfg_media = cfg_desc.media_type().to_string();
         match cfg_media.as_str() {
-            MT_CONFIG_V2 => {}
-            MT_CONFIG_V1 => {
+            MT_CONFIG_V3 => {}
+            MT_CONFIG_V1 | MT_CONFIG_V2 => {
                 return Err(crate::new_error!(
-                    "snapshot config v1 is incompatible with snapshot ABI {}",
+                    "snapshot config media type {:?} is incompatible with snapshot ABI {}",
+                    cfg_media,
                     SNAPSHOT_ABI_VERSION
                 ));
             }
             other => {
                 return Err(crate::new_error!(
                     "unexpected config media type {:?} (supported: {:?})",
                     other,
-                    MT_CONFIG_V2
+                    MT_CONFIG_V3
                 ));
             }
         }

src/hyperlight_host/src/sandbox/snapshot/file_tests.rs

@@ -1984,17 +1984,21 @@ fn unknown_config_media_type_rejected() {
 }
 
 #[test]
-fn config_v1_rejected() {
-    let (_dir, path) = save_for_mutation();
-    rewrite_manifest(&path, |m| {
-        m["config"]["mediaType"] =
-            Value::from("application/vnd.hyperlight.snapshot.config.v1+json");
-    });
-    let err = unwrap_err_snapshot(Snapshot::checked_load(
-        &path,
-        OciTag::new("latest").unwrap(),
-    ));
-    assert_err_contains(err, "incompatible with snapshot ABI 4");
+fn legacy_config_versions_rejected() {
+    for media_type in [
+        "application/vnd.hyperlight.snapshot.config.v1+json",
+        "application/vnd.hyperlight.snapshot.config.v2+json",
+    ] {
+        let (_dir, path) = save_for_mutation();
+        rewrite_manifest(&path, |m| {
+            m["config"]["mediaType"] = Value::from(media_type);
+        });
+        let err = unwrap_err_snapshot(Snapshot::checked_load(
+            &path,
+            OciTag::new("latest").unwrap(),
+        ));
+        assert_err_contains(err, "incompatible with snapshot ABI 5");
+    }
 }
 
 #[test]
@@ -2500,7 +2504,7 @@ fn manifest_uses_correct_config_and_layer_media_types() {
         serde_json::from_slice(&std::fs::read(manifest_path(&path)).unwrap()).unwrap();
     assert_eq!(
         manifest["config"]["mediaType"].as_str().unwrap(),
-        "application/vnd.hyperlight.snapshot.config.v2+json"
+        "application/vnd.hyperlight.snapshot.config.v3+json"
     );
     assert_eq!(manifest["layers"].as_array().unwrap().len(), 2);
     assert_eq!(
@@ -2516,7 +2520,7 @@ fn manifest_uses_correct_config_and_layer_media_types() {
     // that falls back to `config.mediaType` sees the same value.
     assert_eq!(
         manifest["artifactType"].as_str().unwrap(),
-        "application/vnd.hyperlight.snapshot.config.v2+json"
+        "application/vnd.hyperlight.snapshot.config.v3+json"
     );
 }
 

src/hyperlight_host/src/sandbox/snapshot/tripwires.rs

@@ -16,8 +16,8 @@ use super::file::{
     SNAPSHOT_ABI_VERSION,
 };
 
-const EXPECTED_ABI_VERSION: u32 = 4;
-const EXPECTED_MT_CONFIG: &str = "application/vnd.hyperlight.snapshot.config.v2+json";
+const EXPECTED_ABI_VERSION: u32 = 5;
+const EXPECTED_MT_CONFIG: &str = "application/vnd.hyperlight.snapshot.config.v3+json";
 const EXPECTED_MT_SNAPSHOT: &str = "application/vnd.hyperlight.snapshot.memory.v1";
 const EXPECTED_MT_TRANSPORT: &str = "application/vnd.hyperlight.snapshot.transport.v1";
 const EXPECTED_OCI_LAYOUT_VERSION: &str = "1.0.0";