Implement enclave memory management

common/inc/internal/trts_inst.h

@@ -89,8 +89,8 @@ uint32_t sgx_get_rsrvmm_default_perm(void);
 
 size_t get_stack_guard(void);
 
-int sgx_apply_epc_pages(void *start_address, size_t page_number);
-int sgx_trim_epc_pages(void *start_address, size_t page_number);
+int sgx_commit_rts_pages(void *start_address, size_t page_number);
+int sgx_uncommit_rts_pages(void *start_address, size_t page_number);
 
 #ifdef __cplusplus
 }

samplecode/emm/Makefile

@@ -0,0 +1,203 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+######## SGX SDK Settings ########
+
+SGX_SDK ?= /opt/intel/sgxsdk
+SGX_MODE ?= HW
+SGX_ARCH ?= x64
+
+TOP_DIR := ../..
+include $(TOP_DIR)/buildenv.mk
+
+ifeq ($(shell getconf LONG_BIT), 32)
+	SGX_ARCH := x86
+else ifeq ($(findstring -m32, $(CXXFLAGS)), -m32)
+	SGX_ARCH := x86
+endif
+
+ifeq ($(SGX_ARCH), x86)
+	SGX_COMMON_CFLAGS := -m32
+	SGX_LIBRARY_PATH := $(SGX_SDK)/lib
+	SGX_BIN_PATH := $(SGX_SDK)/bin/x86
+else
+	SGX_COMMON_CFLAGS := -m64
+	SGX_LIBRARY_PATH := $(SGX_SDK)/lib64
+	SGX_BIN_PATH := $(SGX_SDK)/bin/x64
+endif
+
+ifeq ($(SGX_DEBUG), 1)
+	SGX_COMMON_CFLAGS += -O0 -g
+	Rust_Build_Flags :=
+	Rust_Build_Out := debug
+else
+	SGX_COMMON_CFLAGS += -O2
+	Rust_Build_Flags := --release
+	Rust_Build_Out := release
+endif
+
+SGX_EDGER8R := $(SGX_BIN_PATH)/sgx_edger8r
+ifneq ($(SGX_MODE), HYPER)
+	SGX_ENCLAVE_SIGNER := $(SGX_BIN_PATH)/sgx_sign
+else
+	SGX_ENCLAVE_SIGNER := $(SGX_BIN_PATH)/sgx_sign_hyper
+	SGX_EDGER8R_MODE := --sgx-mode $(SGX_MODE)
+endif
+
+######## CUSTOM Settings ########
+
+CUSTOM_LIBRARY_PATH := ./lib
+CUSTOM_BIN_PATH := ./bin
+CUSTOM_SYSROOT_PATH := ./sysroot
+CUSTOM_EDL_PATH := $(ROOT_DIR)/sgx_edl/edl
+CUSTOM_COMMON_PATH := $(ROOT_DIR)/common
+
+######## EDL Settings ########
+
+Enclave_EDL_Files := enclave/enclave_t.c enclave/enclave_t.h app/enclave_u.c app/enclave_u.h
+
+######## APP Settings ########
+
+App_Rust_Flags := --release
+App_Src_Files := $(shell find app/ -type f -name '*.rs') $(shell find app/ -type f -name 'Cargo.toml')
+App_Include_Paths := -I ./app -I$(SGX_SDK)/include -I$(CUSTOM_COMMON_PATH)/inc -I$(CUSTOM_EDL_PATH)
+App_C_Flags := $(CFLAGS) $(SGX_COMMON_CFLAGS) -fPIC -Wno-attributes $(App_Include_Paths)
+
+App_Rust_Path := ./app/target/release
+App_Enclave_u_Object := $(CUSTOM_LIBRARY_PATH)/libenclave_u.a
+App_Name := $(CUSTOM_BIN_PATH)/app
+
+######## Enclave Settings ########
+
+# BUILD_STD=no       use no_std
+# BUILD_STD=cargo    use cargo-std-aware
+# BUILD_STD=xargo    use xargo
+BUILD_STD ?= no
+
+Rust_Build_Target := x86_64-unknown-linux-sgx
+Rust_Target_Path := $(ROOT_DIR)/rustlib
+
+ifeq ($(BUILD_STD), cargo)
+	Rust_Build_Std := $(Rust_Build_Flags) -Zbuild-std=core,alloc
+	Rust_Std_Features := --features thread
+	Rust_Target_Flags := --target $(Rust_Target_Path)/$(Rust_Build_Target).json
+	Rust_Sysroot_Path := $(CURDIR)/sysroot
+	Rust_Sysroot_Flags := RUSTFLAGS="--sysroot $(Rust_Sysroot_Path)"
+endif
+
+RustEnclave_Build_Flags := $(Rust_Build_Flags)
+RustEnclave_Src_Files := $(shell find enclave/ -type f -name '*.rs') $(shell find enclave/ -type f -name 'Cargo.toml')
+RustEnclave_Include_Paths := -I$(CUSTOM_COMMON_PATH)/inc -I$(CUSTOM_COMMON_PATH)/inc/tlibc -I$(CUSTOM_EDL_PATH)
+
+RustEnclave_Link_Libs := -L$(CUSTOM_LIBRARY_PATH) -lenclave
+RustEnclave_C_Flags := $(CFLAGS) $(ENCLAVE_CFLAGS) $(SGX_COMMON_CFLAGS) $(RustEnclave_Include_Paths)
+RustEnclave_Link_Flags := -Wl,--no-undefined -nostdlib -nodefaultlibs -nostartfiles \
+	-Wl,--start-group $(RustEnclave_Link_Libs) -Wl,--end-group \
+	-Wl,--version-script=enclave/enclave.lds \
+	$(ENCLAVE_LDFLAGS)
+
+ifeq ($(BUILD_STD), cargo)
+	RustEnclave_Out_Path := ./enclave/target/$(Rust_Build_Target)/$(Rust_Build_Out)
+else ifeq ($(BUILD_STD), xargo)
+	RustEnclave_Out_Path := ./enclave/target/$(Rust_Build_Target)/$(Rust_Build_Out)
+else
+	RustEnclave_Out_Path := ./enclave/target/$(Rust_Build_Out)
+endif
+
+RustEnclave_Lib_Name := $(RustEnclave_Out_Path)/libemmtest.a
+RustEnclave_Name := $(CUSTOM_BIN_PATH)/enclave.so
+RustEnclave_Signed_Name := $(CUSTOM_BIN_PATH)/enclave.signed.so
+
+.PHONY: all
+all: $(Enclave_EDL_Files) $(App_Name) $(RustEnclave_Signed_Name)
+
+######## EDL Objects ########
+
+$(Enclave_EDL_Files): $(SGX_EDGER8R) enclave/enclave.edl
+	$(SGX_EDGER8R) $(SGX_EDGER8R_MODE) --trusted enclave/enclave.edl --search-path $(CUSTOM_COMMON_PATH)/inc --search-path $(CUSTOM_EDL_PATH) --trusted-dir enclave
+	$(SGX_EDGER8R) $(SGX_EDGER8R_MODE) --untrusted enclave/enclave.edl --search-path $(CUSTOM_COMMON_PATH)/inc --search-path $(CUSTOM_EDL_PATH) --untrusted-dir app
+	@echo "GEN => $(Enclave_EDL_Files)"
+
+######## App Objects ########
+
+app/enclave_u.o: $(Enclave_EDL_Files)
+	@$(CC) $(App_C_Flags) -c app/enclave_u.c -o $@
+
+$(App_Enclave_u_Object): app/enclave_u.o
+	@mkdir -p $(CUSTOM_LIBRARY_PATH)
+	@$(AR) rcsD $@ $^
+
+$(App_Name): $(App_Enclave_u_Object) app
+	@mkdir -p $(CUSTOM_BIN_PATH)
+	@cp $(App_Rust_Path)/app $(CUSTOM_BIN_PATH)
+	@echo "LINK => $@"
+
+######## Enclave Objects ########
+
+enclave/enclave_t.o: $(Enclave_EDL_Files)
+	@$(CC) $(RustEnclave_C_Flags) -c enclave/enclave_t.c -o $@
+
+$(RustEnclave_Name): enclave/enclave_t.o enclave
+	@mkdir -p $(CUSTOM_LIBRARY_PATH)
+	@mkdir -p $(CUSTOM_BIN_PATH)
+	@cp $(RustEnclave_Lib_Name) $(CUSTOM_LIBRARY_PATH)/libenclave.a
+	@$(CXX) enclave/enclave_t.o -o $@ $(RustEnclave_Link_Flags)
+	@echo "LINK => $@"
+
+$(RustEnclave_Signed_Name): $(RustEnclave_Name) enclave/config.xml
+	@$(SGX_ENCLAVE_SIGNER) sign -key enclave/private.pem -enclave $(RustEnclave_Name) -out $@ -config enclave/config.xml
+	@echo "SIGN => $@"
+
+######## Build App ########
+
+.PHONY: app
+app:
+	@cd app && SGX_SDK=$(SGX_SDK) cargo build $(App_Rust_Flags)
+
+######## Build Enclave ########
+
+.PHONY: enclave
+enclave:
+ifeq ($(BUILD_STD), cargo)
+	@cd $(Rust_Target_Path)/std && cargo build $(Rust_Build_Std) $(Rust_Target_Flags) $(Rust_Std_Features)
+
+	@rm -rf $(Rust_Sysroot_Path)
+	@mkdir -p $(Rust_Sysroot_Path)/lib/rustlib/$(Rust_Build_Target)/lib
+	@cp -r $(Rust_Target_Path)/std/target/$(Rust_Build_Target)/$(Rust_Build_Out)/deps/* $(Rust_Sysroot_Path)/lib/rustlib/$(Rust_Build_Target)/lib
+
+	@cd enclave && $(Rust_Sysroot_Flags) cargo build $(Rust_Target_Flags) $(RustEnclave_Build_Flags)
+
+else ifeq ($(BUILD_STD), xargo)
+	@cd enclave && RUST_TARGET_PATH=$(Rust_Target_Path) xargo build --target $(Rust_Build_Target) $(RustEnclave_Build_Flags)
+else
+	@cd enclave && cargo build $(RustEnclave_Build_Flags)
+endif
+
+######## Run Enclave ########
+
+.PHONY: run
+run: $(App_Name) $(RustEnclave_Signed_Name)
+	@echo -e '\n===== Run Enclave =====\n'
+	@cd bin && ./app
+
+.PHONY: clean
+clean:
+	@rm -f $(App_Name) $(RustEnclave_Name) $(RustEnclave_Signed_Name) enclave/*_t.* app/*_u.*
+	@cd enclave && cargo clean
+	@cd app && cargo clean
+	@cd $(Rust_Target_Path)/std && cargo clean
+	@rm -rf $(CUSTOM_BIN_PATH) $(CUSTOM_LIBRARY_PATH) $(CUSTOM_SYSROOT_PATH)

samplecode/emm/app/Cargo.toml

@@ -0,0 +1,30 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[package]
+name = "app"
+version = "1.0.0"
+authors = ["The Teaclave Authors"]
+edition = "2021"
+
+[dependencies]
+sgx_types = { path = "../../../sgx_types" }
+sgx_urts = { path = "../../../sgx_urts" }
+
+[profile.dev]
+opt-level = 0  
+debug = true

samplecode/emm/app/build.rs

@@ -0,0 +1,37 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License..
+
+use std::env;
+
+fn main() {
+    println!("cargo:rerun-if-env-changed=SGX_MODE");
+    println!("cargo:rerun-if-changed=build.rs");
+
+    let sdk_dir = env::var("SGX_SDK").unwrap_or_else(|_| "/opt/intel/sgxsdk".to_string());
+    let mode = env::var("SGX_MODE").unwrap_or_else(|_| "HW".to_string());
+
+    println!("cargo:rustc-link-search=native=../lib");
+    println!("cargo:rustc-link-lib=static=enclave_u");
+
+    println!("cargo:rustc-link-search=native={}/lib64", sdk_dir);
+    match mode.as_ref() {
+        "SIM" | "SW" => println!("cargo:rustc-link-lib=dylib=sgx_urts_sim"),
+        "HYPER" => println!("cargo:rustc-link-lib=dylib=sgx_urts_hyper"),
+        "HW" => println!("cargo:rustc-link-lib=dylib=sgx_urts"),
+        _ => println!("cargo:rustc-link-lib=dylib=sgx_urts"),
+    }
+}

samplecode/emm/app/src/main.rs

@@ -0,0 +1,51 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License..
+
+extern crate sgx_types;
+extern crate sgx_urts;
+
+use sgx_types::error::SgxStatus;
+use sgx_types::types::*;
+use sgx_urts::enclave::SgxEnclave;
+
+static ENCLAVE_FILE: &str = "enclave.signed.so";
+
+extern "C" {
+    fn ecall_test_sgx_mm_unsafe(eid: EnclaveId, retval: *mut SgxStatus) -> SgxStatus;
+}
+
+fn main() {
+    let enclave = match SgxEnclave::create(ENCLAVE_FILE, true) {
+        Ok(enclave) => {
+            println!("[+] Init Enclave Successful {}!", enclave.eid());
+            enclave
+        }
+        Err(err) => {
+            println!("[-] Init Enclave Failed {}!", err.as_str());
+            return;
+        }
+    };
+
+    // let input_string = String::from("This is a normal world string passed into Enclave!\n");
+    let mut retval = SgxStatus::Success;
+
+    let result = unsafe { ecall_test_sgx_mm_unsafe(enclave.eid(), &mut retval) };
+    match result {
+        SgxStatus::Success => println!("[+] ECall Success..."),
+        _ => println!("[-] ECall Enclave Failed {}!", result.as_str()),
+    }
+}

samplecode/emm/enclave/Cargo.toml

@@ -0,0 +1,34 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[package]
+name = "emmtest"
+version = "1.0.0"
+authors = ["The Teaclave Authors"]
+edition = "2021"
+
+[lib]
+name = "emmtest"
+crate-type = ["staticlib"]
+
+[features]
+default = []
+
+[target.'cfg(not(target_vendor = "teaclave"))'.dependencies]
+sgx_types = { path = "../../../sgx_types"}
+sgx_tstd = { path = "../../../sgx_tstd", features = ["thread"]}
+sgx_trts = { path = "../../../sgx_trts" }

samplecode/emm/enclave/Xargo.toml

@@ -0,0 +1,23 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+[dependencies]
+alloc = {}
+
+[dependencies.std]
+path = "../../../rustlib/std"
+stage = 1