crates/sel4-externally-shared: Rework

- Depend on a patched version of the `volatile` crate via Git instead of including the patched version in this repository. - Add some `volatile::ops::Ops` implementations and wrappers. - Add `AtomicPtr` type. Signed-off-by: Nick Spinale <[email protected]>
seL4 · Oct 20, 2023 · 0cbb794 · 0cbb794
1 parent c1f0292
commit 0cbb794
Show file tree

Hide file tree

Showing 41 changed files with 973 additions and 1,726 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/examples/microkit/banscii/pds/artist/Cargo.toml b/crates/examples/microkit/banscii/pds/artist/Cargo.toml
@@ -8,12 +8,9 @@ license = "BSD-2-Clause"
 [dependencies]
 banscii-artist-interface-types = { path = "./interface-types" }
 rsa = { version = "0.8.1", default-features = false, features = ["pem", "sha2"] }
+sel4-externally-shared = { path = "../../../../../sel4-externally-shared", features = ["unstable"] }
 sel4-microkit-message = { path = "../../../../../sel4-microkit/message" }
 
-[dependencies.sel4-externally-shared]
-path = "../../../../../sel4-externally-shared"
-features = ["unstable", "alloc"]
-
 [dependencies.sel4-microkit]
 path = "../../../../../sel4-microkit"
 default-features = false

diff --git a/crates/examples/microkit/banscii/pds/artist/src/main.rs b/crates/examples/microkit/banscii/pds/artist/src/main.rs
@@ -6,9 +6,11 @@
 
 extern crate alloc;
 
+use alloc::vec;
+
 use sel4_externally_shared::{
     access::{ReadOnly, ReadWrite},
-    ExternallySharedRef,
+    ExternallySharedRef, ExternallySharedRefExt,
 };
 use sel4_microkit::{memory_region_symbol, protection_domain, Channel, Handler, MessageInfo};
 use sel4_microkit_message::MessageInfoExt as _;
@@ -27,13 +29,11 @@ const REGION_SIZE: usize = 0x4_000;
 #[protection_domain(heap_size = 0x10000)]
 fn init() -> HandlerImpl {
     let region_in = unsafe {
-        ExternallySharedRef::<'static, [u8]>::new_read_only(
-            memory_region_symbol!(region_in_start: *mut [u8], n = REGION_SIZE),
-        )
+        ExternallySharedRef::new(memory_region_symbol!(region_in_start: *mut [u8], n = REGION_SIZE))
     };
 
     let region_out = unsafe {
-        ExternallySharedRef::<'static, [u8]>::new(
+        ExternallySharedRef::new(
             memory_region_symbol!(region_out_start: *mut [u8], n = REGION_SIZE),
         )
     };
@@ -62,11 +62,14 @@ impl Handler for HandlerImpl {
                 Ok(req) => {
                     let draft_height = req.height;
                     let draft_width = req.width;
-                    let draft = self
-                        .region_in
-                        .as_ptr()
-                        .index(req.draft_start..req.draft_start + req.draft_size)
-                        .copy_to_vec();
+                    let draft = {
+                        let mut buf = vec![0; req.draft_size];
+                        self.region_in
+                            .as_ptr()
+                            .index(req.draft_start..req.draft_start + req.draft_size)
+                            .copy_into_slice(&mut buf);
+                        buf
+                    };
 
                     let masterpiece = Masterpiece::complete(draft_height, draft_width, &draft);
 

diff --git a/crates/examples/microkit/banscii/pds/assistant/Cargo.toml b/crates/examples/microkit/banscii/pds/assistant/Cargo.toml
@@ -10,12 +10,9 @@ banscii-artist-interface-types = { path = "../artist/interface-types" }
 banscii-assistant-core = { path = "./core" }
 banscii-pl011-driver-interface-types = { path = "../pl011-driver/interface-types" }
 hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
+sel4-externally-shared = { path = "../../../../../sel4-externally-shared", features = ["unstable"] }
 sel4-microkit-message = { path = "../../../../../sel4-microkit/message" }
 
-[dependencies.sel4-externally-shared]
-path = "../../../../../sel4-externally-shared"
-features = ["unstable", "alloc"]
-
 [dependencies.sel4-microkit]
 path = "../../../../../sel4-microkit"
 default-features = false

diff --git a/crates/examples/microkit/banscii/pds/assistant/src/main.rs b/crates/examples/microkit/banscii/pds/assistant/src/main.rs
@@ -5,6 +5,7 @@
 
 extern crate alloc;
 
+use alloc::vec;
 use alloc::vec::Vec;
 use core::fmt;
 use core::fmt::Write;
@@ -13,7 +14,7 @@ use core::str;
 
 use sel4_externally_shared::{
     access::{ReadOnly, ReadWrite},
-    ExternallySharedRef,
+    ExternallySharedRef, ExternallySharedRefExt,
 };
 use sel4_microkit::{memory_region_symbol, protection_domain, Channel, Handler, MessageInfo};
 use sel4_microkit_message::MessageInfoExt as _;
@@ -32,13 +33,11 @@ const MAX_SUBJECT_LEN: usize = 16;
 #[protection_domain(heap_size = 0x10000)]
 fn init() -> impl Handler {
     let region_in = unsafe {
-        ExternallySharedRef::<'static, [u8]>::new_read_only(
-            memory_region_symbol!(region_in_start: *mut [u8], n = REGION_SIZE),
-        )
+        ExternallySharedRef::new(memory_region_symbol!(region_in_start: *mut [u8], n = REGION_SIZE))
     };
 
     let region_out = unsafe {
-        ExternallySharedRef::<'static, [u8]>::new(
+        ExternallySharedRef::new(
             memory_region_symbol!(region_out_start: *mut [u8], n = REGION_SIZE),
         )
     };
@@ -135,17 +134,23 @@ impl HandlerImpl {
         let height = resp.height;
         let width = resp.width;
 
-        let pixel_data = self
-            .region_in
-            .as_ptr()
-            .index(resp.masterpiece_start..resp.masterpiece_start + resp.masterpiece_size)
-            .copy_to_vec();
-
-        let signature = self
-            .region_in
-            .as_ptr()
-            .index(resp.signature_start..resp.signature_start + resp.signature_size)
-            .copy_to_vec();
+        let pixel_data = {
+            let mut buf = vec![0; resp.masterpiece_size];
+            self.region_in
+                .as_ptr()
+                .index(resp.masterpiece_start..resp.masterpiece_start + resp.masterpiece_size)
+                .copy_into_slice(&mut buf);
+            buf
+        };
+
+        let signature = {
+            let mut buf = vec![0; resp.signature_size];
+            self.region_in
+                .as_ptr()
+                .index(resp.signature_start..resp.signature_start + resp.signature_size)
+                .copy_into_slice(&mut buf);
+            buf
+        };
 
         newline();
 

diff --git a/crates/examples/microkit/http-server/helpers/virtio-hal-impl/src/lib.rs b/crates/examples/microkit/http-server/helpers/virtio-hal-impl/src/lib.rs
@@ -9,7 +9,7 @@ use core::ptr::{self, NonNull};
 use virtio_drivers::{BufferDirection, Hal, PhysAddr, PAGE_SIZE};
 
 use sel4_bounce_buffer_allocator::{Basic, BounceBufferAllocator};
-use sel4_externally_shared::ExternallySharedRef;
+use sel4_externally_shared::{ExternallySharedRef, ExternallySharedRefExt};
 use sel4_immediate_sync_once_cell::ImmediateSyncOnceCell;
 use sel4_sync::{GenericMutex, PanickingMutexSyncOps};
 

diff --git a/crates/examples/microkit/http-server/pds/server/Cargo.toml b/crates/examples/microkit/http-server/pds/server/Cargo.toml
@@ -16,6 +16,7 @@ sel4-async-block-io-fat = { path = "../../../../../sel4-async/block-io/fat" }
 sel4-async-network = { path = "../../../../../sel4-async/network" }
 sel4-async-time = { path = "../../../../../sel4-async/time" }
 sel4-bounce-buffer-allocator = { path = "../../../../../sel4-bounce-buffer-allocator" }
+sel4-externally-shared = { path = "../../../../../sel4-externally-shared", features = ["unstable"] }
 sel4-immediate-sync-once-cell = { path = "../../../../../sel4-immediate-sync-once-cell" }
 sel4-logging = { path = "../../../../../sel4-logging" }
 sel4-microkit-message = { path = "../../../../../sel4-microkit/message" }
@@ -36,10 +37,6 @@ path = "../virtio-net-driver/interface-types"
 [dependencies.sel4-async-single-threaded-executor]
 path = "../../../../../sel4-async/single-threaded-executor"
 
-[dependencies.sel4-externally-shared]
-path = "../../../../../sel4-externally-shared"
-features = ["unstable", "alloc"]
-
 [dependencies.sel4-microkit]
 path = "../../../../../sel4-microkit"
 default-features = false

diff --git a/crates/examples/microkit/http-server/pds/server/src/main.rs b/crates/examples/microkit/http-server/pds/server/src/main.rs
@@ -21,7 +21,7 @@ use sel4_async_block_io::{
     constant_block_sizes::BlockSize512, disk::Disk, CachedBlockIO, ConstantBlockSize,
 };
 use sel4_bounce_buffer_allocator::{Basic, BounceBufferAllocator};
-use sel4_externally_shared::ExternallySharedRef;
+use sel4_externally_shared::{ExternallySharedRef, ExternallySharedRefExt};
 use sel4_logging::{LevelFilter, Logger, LoggerBuilder};
 use sel4_microkit::{memory_region_symbol, protection_domain, var, Channel, Handler};
 use sel4_shared_ring_buffer::RingBuffers;

diff --git a/crates/examples/microkit/http-server/pds/virtio-blk-driver/src/main.rs b/crates/examples/microkit/http-server/pds/virtio-blk-driver/src/main.rs
@@ -17,7 +17,7 @@ use virtio_drivers::{
     },
 };
 
-use sel4_externally_shared::ExternallySharedRef;
+use sel4_externally_shared::{ExternallySharedRef, ExternallySharedRefExt};
 use sel4_microkit::{memory_region_symbol, protection_domain, var, Channel, Handler, MessageInfo};
 use sel4_microkit_message::MessageInfoExt as _;
 use sel4_shared_ring_buffer::{roles::Use, RingBuffers};

diff --git a/crates/examples/microkit/http-server/pds/virtio-net-driver/src/main.rs b/crates/examples/microkit/http-server/pds/virtio-net-driver/src/main.rs
@@ -12,7 +12,7 @@ use virtio_drivers::{
     },
 };
 
-use sel4_externally_shared::ExternallySharedRef;
+use sel4_externally_shared::{ExternallySharedRef, ExternallySharedRefExt};
 use sel4_microkit::{memory_region_symbol, protection_domain, var, Channel, Handler, MessageInfo};
 use sel4_microkit_message::MessageInfoExt as _;
 use sel4_shared_ring_buffer::{roles::Use, RingBuffers};

diff --git a/crates/private/meta/Cargo.toml b/crates/private/meta/Cargo.toml
@@ -40,7 +40,7 @@ sel4-sys = { path = "../../sel4/sys" }
 
 [dependencies.sel4-externally-shared]
 path = "../../sel4-externally-shared"
-features = ["alloc", "unstable", "very_unstable"]
+features = ["unstable", "very_unstable"]
 
 [target."cfg(not(target_arch = \"x86_64\"))".dependencies]
 sel4-platform-info = { path = "../../sel4-platform-info", optional = true }

diff --git a/crates/sel4-externally-shared/Cargo.toml b/crates/sel4-externally-shared/Cargo.toml
@@ -3,12 +3,15 @@ name = "sel4-externally-shared"
 version = "0.1.0"
 authors = ["Nick Spinale <[email protected]>"]
 edition = "2021"
-license = "MIT OR Apache-2.0"
+license = "BSD-2-Clause"
 
 [features]
-alloc = []
-unstable = []
-very_unstable = ["unstable"]
+unstable = ["volatile/unstable"]
+very_unstable = ["volatile/very_unstable"]
 
-[dev-dependencies]
-rand = "0.8.3"
+[dependencies]
+zerocopy = "0.7.6"
+
+[dependencies.volatile]
+git = "https://github.com/coliasgroup/volatile.git"
+tag = "keep/8aee5539716d3d38247f46eddd42b382"