Merge pull request #3 from fortanix/raoul/tokio-1.36.0-sgx

SGX port tokio 1.36.0
fortanix · Mar 27, 2024 · cb35896 · cb35896
2 parents eaf81ed + ab2ae6e
commit cb35896
Show file tree

Hide file tree

Showing 75 changed files with 406 additions and 67 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,7 @@
 [workspace]
 resolver = "2"
 members = [
+  "enclave-runner",
   "tokio",
   "tokio-macros",
   "tokio-test",
@@ -18,3 +19,10 @@ members = [
 [workspace.metadata.spellcheck]
 config = "spellcheck.toml"
 
+[patch.crates-io]
+async-usercalls = { git = "https://github.com/fortanix/rust-sgx.git", branch = "master" }
+enclave-runner = { git = "https://github.com/fortanix/rust-sgx", branch = "master" }
+mio = { git = "https://github.com/fortanix/mio", branch = "v0.8.10" }
+sgx-isa = { git = "https://github.com/fortanix/rust-sgx", branch = "master" }
+sgxs = { git = "https://github.com/fortanix/rust-sgx", branch = "master" }
+tokio = { path = "./tokio" }
diff --git a/benches/Cargo.toml b/benches/Cargo.toml
@@ -8,12 +8,17 @@ edition = "2021"
 test-util = ["tokio/test-util"]
 
 [dependencies]
-tokio = { version = "1.5.0", path = "../tokio", features = ["full"] }
 criterion = "0.5.1"
 rand = "0.8"
 rand_chacha = "0.3"
 num_cpus = "1.16.0"
 
+[target.'cfg(target_env = "sgx")'.dependencies]
+tokio = { version = "1.5.0", path = "../tokio", features = ["full-sgx"] }
+
+[target.'cfg(not(target_env = "sgx"))'.dependencies]
+tokio = { version = "1.5.0", path = "../tokio", features = ["full"] }
+
 [dev-dependencies]
 tokio-util = { version = "0.7.0", path = "../tokio-util", features = ["full"] }
 tokio-stream = { path = "../tokio-stream" }

diff --git a/ct.sh b/ct.sh
@@ -0,0 +1,23 @@
+#!/bin/bash -ex
+repo_root=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+cd ${repo_root}
+
+source ${repo_root}/ct_env.sh
+
+cargo test
+
+pushd tokio
+cargo test --target x86_64-fortanix-unknown-sgx --features "full-sgx"
+popd
+
+pushd tokio-macros
+cargo test --target x86_64-fortanix-unknown-sgx
+popd
+
+pushd tokio-stream
+cargo test --target x86_64-fortanix-unknown-sgx
+popd
+
+pushd stress-test
+cargo test --target x86_64-fortanix-unknown-sgx
+popd
diff --git a/ct_env.sh b/ct_env.sh
@@ -0,0 +1,10 @@
+#!/bin/bash -ex
+repo_root=$(readlink -f $(dirname ${BASH_SOURCE[0]}))
+cd ${repo_root}
+
+# Unfortunately, the `ftxsgx-runner-cargo` application doesn't enable us to point to a runner within the same workspace. We use a hack here by pointing to `enclave-runner` and making sure such an executable exists when running CI
+pushd enclave-runner
+cargo build
+popd
+
+export PATH=${repo_root}/target/debug/:${PATH}
diff --git a/enclave-runner/Cargo.toml b/enclave-runner/Cargo.toml
@@ -0,0 +1,10 @@
+[package]
+name = "enclave-runner"
+version = "0.1.0"
+edition = "2018"
+
+[dependencies]
+aesm-client = { version = "0.5", features = ["sgxs"] }
+clap = "4.4"
+enclave-runner = "0.5"
+sgxs-loaders = "0.3.0"
diff --git a/enclave-runner/src/main.rs b/enclave-runner/src/main.rs
@@ -0,0 +1,51 @@
+use aesm_client::AesmClient;
+use clap::{Command, Arg, ArgAction};
+use enclave_runner::EnclaveBuilder;
+
+#[cfg(windows)]
+use sgxs_loaders::enclaveapi::Sgx as IsgxDevice;
+#[cfg(unix)]
+use sgxs_loaders::isgx::Device as IsgxDevice;
+
+fn main() {
+    let args = Command::new("runner")
+        .arg(Arg::new("file").required(true))
+        .arg(
+            Arg::new("enclave-args")
+                .help(
+                    "Arguments passed to the enclave. \
+                    Note that this is not an appropriate channel for passing \
+                    secrets or security configurations to the enclave.",
+                )
+                .action(ArgAction::Append)
+        )
+        .get_matches();
+
+    let file = args.get_one::<String>("file").unwrap();
+
+    let mut device = IsgxDevice::new()
+        .expect("failed to open SGX device")
+        .einittoken_provider(AesmClient::new())
+        .build();
+
+    let mut enclave_builder = EnclaveBuilder::new(file.as_ref());
+    if let Err(_) = enclave_builder.coresident_signature() {
+        enclave_builder.dummy_signature();
+    }
+
+    if let Some(enclave_args) = args.get_many::<String>("enclave-args") {
+        enclave_builder.args(enclave_args);
+    }
+
+    let enclave = enclave_builder
+        .build(&mut device)
+        .expect("failed to load SGX enclave");
+
+    match enclave.run() {
+        Err(e) => {
+            eprintln!("Error while executing SGX enclave.\n{}", e);
+            std::process::exit(-1)
+        }
+        Ok(()) => {}
+    }
+}
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -27,6 +27,12 @@ rand = "0.8.3"
 [target.'cfg(windows)'.dev-dependencies.windows-sys]
 version = "0.48"
 
+[target.'cfg(not(target_env = "sgx"))'.dev-dependencies]
+tokio = { version = "1.0.0", path = "../tokio",features = ["full", "tracing"] }
+
+[target.'cfg(target_env = "sgx")'.dev-dependencies]
+tokio = { version = "1.0.0", path = "../tokio",features = ["full-sgx", "tracing"] }
+
 [[example]]
 name = "chat"
 path = "chat.rs"

diff --git a/stress-test/Cargo.toml b/stress-test/Cargo.toml
@@ -8,7 +8,12 @@ publish = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+
+[target.'cfg(not(target_env = "sgx"))'.dependencies]
 tokio = { path = "../tokio/", features = ["full"] }
 
+[target.'cfg(target_env = "sgx")'.dependencies]
+tokio = { path = "../tokio/", features = ["full-sgx"] }
+
 [dev-dependencies]
 rand = "0.8"
diff --git a/stress-test/examples/simple_echo_tcp.rs b/stress-test/examples/simple_echo_tcp.rs
@@ -3,7 +3,7 @@ use std::{thread::sleep, time::Duration};
 
 use tokio::{
     io::{AsyncReadExt, AsyncWriteExt},
-    net::{TcpListener, TcpSocket},
+    net::{TcpListener, TcpStream},
     runtime::Builder,
     sync::oneshot,
 };
@@ -30,9 +30,7 @@ fn main() {
     let (tx, mut rx) = oneshot::channel();
 
     rt2.spawn(async {
-        let addr = TCP_ENDPOINT.parse().unwrap();
-        let socket = TcpSocket::new_v4().unwrap();
-        let mut stream = socket.connect(addr).await.unwrap();
+        let mut stream = TcpStream::connect(TCP_ENDPOINT).await.unwrap();
 
         let mut buff = [0; MSG_SIZE];
         for _ in 0..NUM_MSGS {

diff --git a/tokio-macros/Cargo.toml b/tokio-macros/Cargo.toml
@@ -27,7 +27,12 @@ quote = "1"
 syn = { version = "2.0", features = ["full"] }
 
 [dev-dependencies]
+
+[target.'cfg(not(target_env = "sgx"))'.dev-dependencies]
 tokio = { version = "1.0.0", path = "../tokio", features = ["full"] }
 
+[target.'cfg(target_env = "sgx")'.dev-dependencies]
+tokio = { version = "1.0.0", path = "../tokio", features = ["full-sgx"] }
+
 [package.metadata.docs.rs]
 all-features = true
diff --git a/tokio-macros/src/lib.rs b/tokio-macros/src/lib.rs
@@ -152,6 +152,9 @@ use proc_macro::TokenStream;
 /// ### Configure the runtime to start with time paused
 ///
 /// ```rust
+/// # #[cfg(not(feature = "test-util"))]
+/// # fn main(){}
+/// # #[cfg(feature = "test-util")]
 /// #[tokio::main(flavor = "current_thread", start_paused = true)]
 /// async fn main() {
 ///     println!("Hello world");
@@ -162,6 +165,7 @@ use proc_macro::TokenStream;
 ///
 /// ```rust
 /// fn main() {
+///     # #[cfg(feature = "test-util")]
 ///     tokio::runtime::Builder::new_current_thread()
 ///         .enable_all()
 ///         .start_paused(true)

diff --git a/tokio-stream/Cargo.toml b/tokio-stream/Cargo.toml
@@ -42,12 +42,17 @@ tokio = { version = "1.15.0", path = "../tokio", features = ["sync"] }
 tokio-util = { version = "0.7.0", path = "../tokio-util", optional = true }
 
 [dev-dependencies]
-tokio = { version = "1.2.0", path = "../tokio", features = ["full", "test-util"] }
 async-stream = "0.3"
 parking_lot = "0.12.0"
 tokio-test = { path = "../tokio-test" }
 futures = { version = "0.3", default-features = false }
 
+[target.'cfg(not(target_env = "sgx"))'.dev-dependencies]
+tokio = { version = "1.2.0", path = "../tokio", features = ["full", "test-util"] }
+
+[target.'cfg(target_env = "sgx")'.dev-dependencies]
+tokio = { version = "1.2.0", path = "../tokio", features = ["full-sgx", "test-util"] }
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
@@ -56,3 +61,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 # This should allow `docsrs` to be read across projects, so that `tokio-stream`
 # can pick up stubbed types exported by `tokio`.
 rustc-args = ["--cfg", "docsrs"]
+
+[package.metadata.fortanix-sgx]
+runner = "enclave-runner"
diff --git a/tokio-test/Cargo.toml b/tokio-test/Cargo.toml
@@ -25,8 +25,13 @@ bytes = "1.0.0"
 futures-core = "0.3.0"
 
 [dev-dependencies]
-tokio = { version = "1.2.0", path = "../tokio", features = ["full"] }
 futures-util = "0.3.0"
 
+[target.'cfg(not(target_env = "sgx"))'.dev-dependencies]
+tokio = { version = "1.2.0", path = "../tokio", features = ["full"] }
+
+[target.'cfg(target_env = "sgx")'.dev-dependencies]
+tokio = { version = "1.2.0", path = "../tokio", features = ["full-sgx"] }
+
 [package.metadata.docs.rs]
 all-features = true
diff --git a/tokio-util/Cargo.toml b/tokio-util/Cargo.toml
@@ -48,7 +48,6 @@ tracing = { version = "0.1.25", default-features = false, features = ["std"], op
 hashbrown = { version = "0.14.0", optional = true }
 
 [dev-dependencies]
-tokio = { version = "1.0.0", path = "../tokio", features = ["full"] }
 tokio-test = { version = "0.4.0", path = "../tokio-test" }
 tokio-stream = { version = "0.1", path = "../tokio-stream" }
 
@@ -58,6 +57,12 @@ futures-test = "0.3.5"
 parking_lot = "0.12.0"
 tempfile = "3.1.0"
 
+[target.'cfg(not(target_env = "sgx"))'.dev-dependencies]
+tokio = { version = "1.0.0", path = "../tokio", features = ["full"] }
+
+[target.'cfg(target_env = "sgx")'.dev-dependencies]
+tokio = { version = "1.0.0", path = "../tokio", features = ["full-sgx"] }
+
 [package.metadata.docs.rs]
 all-features = true
 # enable unstable features in the documentation

diff --git a/tokio-util/tests/compat.rs b/tokio-util/tests/compat.rs
@@ -1,5 +1,5 @@
 #![cfg(feature = "compat")]
-#![cfg(not(target_os = "wasi"))] // WASI does not support all fs operations
+#![cfg(not(any(target_os = "wasi", target_env = "sgx")))] // WASI and SGX do not support all fs operations
 #![warn(rust_2018_idioms)]
 
 use futures_io::SeekFrom;

diff --git a/tokio-util/tests/time_delay_queue.rs b/tokio-util/tests/time_delay_queue.rs
@@ -1,6 +1,6 @@
 #![allow(clippy::disallowed_names)]
 #![warn(rust_2018_idioms)]
-#![cfg(feature = "full")]
+#![cfg(any(feature = "full", feature = "full-sgx"))]
 
 use futures::StreamExt;
 use tokio::time::{self, sleep, sleep_until, Duration, Instant};

diff --git a/tokio/Cargo.toml b/tokio/Cargo.toml
@@ -41,6 +41,18 @@ full = [
   "time",
 ]
 
+# everything possible in SGX
+full-sgx = [
+  "io-util",
+  "io-std",
+  "macros",
+  "net",
+  "rt",
+  "rt-multi-thread",
+  "sync",
+  "time",
+]
+
 fs = []
 io-util = ["bytes"]
 # stdin, stdout, stderr
@@ -95,11 +107,11 @@ pin-project-lite = "0.2.11"
 
 # Everything else is optional...
 bytes = { version = "1.0.0", optional = true }
-mio = { version = "0.8.9", optional = true, default-features = false }
+mio = { version = "0.8.10", optional = true, default-features = false }
 num_cpus = { version = "1.8.0", optional = true }
 parking_lot = { version = "0.12.0", optional = true }
 
-[target.'cfg(not(target_family = "wasm"))'.dependencies]
+[target.'cfg(not(any(target_family = "wasm", target_env = "sgx")))'.dependencies]
 socket2 = { version = "0.5.5", optional = true, features = [ "all" ] }
 
 # Currently unstable. The API exposed by these features may be broken at any time.
@@ -138,7 +150,7 @@ futures = { version = "0.3.0", features = ["async-await"] }
 mockall = "0.11.1"
 async-stream = "0.3"
 
-[target.'cfg(not(target_family = "wasm"))'.dev-dependencies]
+[target.'cfg(not(any(target_family = "wasm", target_env = "sgx")))'.dev-dependencies]
 socket2 = "0.5.5"
 tempfile = "3.1.0"
 
@@ -174,3 +186,10 @@ allowed_external_types = [
 
    "tokio_macros::*",
 ]
+
+# set number of threads so tests can run properly
+[package.metadata.fortanix-sgx]
+threads = 100
+heap-size = 0x4000000
+stack-size = 0x40000
+runner = "enclave-runner"
diff --git a/tokio/src/io/poll_evented.rs b/tokio/src/io/poll_evented.rs
@@ -131,6 +131,7 @@ impl<E: Source> PollEvented<E> {
 
     /// Deregisters the inner io from the registration and returns a Result containing the inner io.
     #[cfg(any(feature = "net", feature = "process"))]
+    #[cfg(not(target_env = "sgx"))]
     pub(crate) fn into_inner(mut self) -> io::Result<E> {
         let mut inner = self.io.take().unwrap(); // As io shouldn't ever be None, just unwrap here.
         self.registration.deregister(&mut inner)?;

diff --git a/tokio/src/lib.rs b/tokio/src/lib.rs
@@ -15,6 +15,7 @@
     no_crate_inject,
     attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
 ))]
+#![cfg_attr(target_env = "sgx", feature(sgx_platform))]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(docsrs, allow(unused_attributes))]
 #![cfg_attr(loom, allow(dead_code, unreachable_pub))]