Document TCS struct limitations

raoulstrackx · raoulstrackx · commit 96023c2a8c24 · 2022-09-05T13:47:15.000+02:00
diff --git a/intel-sgx/fortanix-sgx-abi/src/lib.rs b/intel-sgx/fortanix-sgx-abi/src/lib.rs
@@ -441,6 +441,9 @@ impl Usercalls {
 }
 
 /// The absolute address of a TCS in the current enclave.
+///
+/// To ensure a TCS struct will never be located at address 0, a TCS struct should not be located
+/// at the beginning of an enclave.
 // FIXME: `u8` should be some `extern type` instead.
 #[cfg_attr(feature = "rustc-dep-of-std", unstable(feature = "sgx_platform", issue = "56975"))]
 pub type Tcs = NonNull<u8>;

Original file line number	Diff line number	Diff line change
`@@ -441,6 +441,9 @@ impl Usercalls {`
`441`	`441`	`}`
`442`	`442`
`443`	`443`	`/// The absolute address of a TCS in the current enclave.`
	`444`	`+///`
	`445`	`+/// To ensure a TCS struct will never be located at address 0, a TCS struct should not be located`
	`446`	`+/// at the beginning of an enclave.`
`444`	`447`	// FIXME: `u8` should be some `extern type` instead.
`445`	`448`	`#[cfg_attr(feature = "rustc-dep-of-std", unstable(feature = "sgx_platform", issue = "56975"))]`
`446`	`449`	`pub type Tcs = NonNull<u8>;`