Add optee-utee-build crate #156

ivila · 2024-12-20T09:05:40Z

add optee-utee-build crate to make building process simpler
use optee-utee-build to build hello_world example
fix pipeline

this PR relates to #155, and should resolves #135 too.

b49020 · 2024-12-20T09:18:05Z

add optee-utee-build crate to make building process simpler

use optee-utee-build to build hello_world example

Split these into separate commits and also add documentation as a separate commit to describe APIs exposed by optee-utee-build for TA developers.

fix pipeline

I suppose it's independent of this PR which is something @DemesneGH should be able to fix in the dockerfile with required dependencies for CI. We want to keep testing with latest OP-TEE mainline build rather than sticking to a stable release.

ivila · 2024-12-20T09:39:00Z

also add documentation as a separate commit

@b49020 May I ask what the documentation you points to, the README.md or the comments in rust codes?

b49020 · 2024-12-20T09:44:53Z

also add documentation as a separate commit

@b49020 May I ask what the documentation you points to, the README.md or the comments in rust codes?

I will suggest to create a dedicated document titled something like "Tutorial: Writing Rust TAs using optee-utee-build" under https://github.com/apache/incubator-teaclave-trustzone-sdk/tree/main/docs

DemesneGH · 2024-12-20T13:58:55Z

I suppose it's independent of this PR which is something @DemesneGH should be able to fix in the dockerfile with required dependencies for CI.

Sure, I'm working on that.

ivila · 2024-12-20T17:38:18Z

I still have some changes to make and I am writing the document of how to use this crate, everything should be done in 3 days, so we can pause reviewing this PR and wait until I am finish with it.

ivila · 2024-12-23T03:20:36Z

@b49020 @DemesneGH PR fixed.

ivila · 2024-12-23T06:55:59Z

Update to remove the confusing extra properties of gp.ta.version and gp.ta.description, as in this commit jforissier said they are just misleading TA properties:

DemesneGH · 2024-12-24T09:37:58Z

I suppose it's independent of this PR which is something @DemesneGH should be able to fix in the dockerfile with required dependencies for CI.

Sure, I'm working on that.

The PR for CI fix: #157.

ivila · 2024-12-24T13:47:05Z

update to use latest ci

docs/migrating-to-new-building-env.md

docs/writing-rust-tas-using-optee-utee-build.md

optee-utee-build/Cargo.toml

.licenserc.yaml

examples/hello_world-rs/ta/Makefile

optee-utee-build/src/linker.rs

optee-utee-build/src/ta_config.rs

optee-utee-build/Cargo.toml

optee-utee-build/src/linker.rs

optee-utee-build/src/ta_config.rs

b49020 · 2024-12-27T06:13:56Z

Thanks @ivila for your efforts addressing review comments, the last one pending for me is here. With that addressed, feel free to add:

Reviewed-by: Sumit Garg <[email protected]>

b49020 · 2024-12-27T07:42:21Z

Once this PR gets merged, let's make all the examples to use optee-utee-build crate too which can be a followup PR.

ivila · 2024-12-31T01:10:40Z

Is there anything I miss? I think this PR is inactive for a long time.😐

docs/migrating-to-new-building-env.md

optee-utee-build/src/ta_config.rs

optee-utee-build/src/error.rs

optee-utee-build/src/linker.rs

DemesneGH

After some minor recommendations resolved please feel free to add: Reviewed-by: Yuan Zhuang <[email protected]>

1. introduce build method to make building process simpler. 2. introduce Builder struct for developers who want to customize the building process. 3. introduce HeaderFileGenerator struct for developers who want to generate a header file only. 4. introduce Linker struct for developers who want to handle linking stuff only. Signed-off-by: ivila <[email protected]> Reviewed-by: Sumit Garg <[email protected]> Reviewed-by: Yuan Zhuang <[email protected]>

ivila · 2024-12-31T02:49:10Z

update to add reviewer

DemesneGH · 2024-12-31T02:50:24Z

Thanks! Will merge after the CI passed.

DemesneGH · 2024-12-31T02:57:04Z

@ivila CI failed because:

24-12-31T02:52:27.0302935Z    Compiling ta v0.2.0 (/__w/incubator-teaclave-trustzone-sdk/incubator-teaclave-trustzone-sdk/examples/hello_world-rs/ta)
2024-12-31T02:52:27.0773416Z error[E0432]: unresolved import `optee_utee_build::TAConfig`
2024-12-31T02:52:27.0774266Z   --> build.rs:19:24
2024-12-31T02:52:27.0774662Z    |
2024-12-31T02:52:27.0775144Z 19 | use optee_utee_build::{TAConfig, RustEdition, Error};
2024-12-31T02:52:27.0776717Z    |                        ^^^^^^^^
2024-12-31T02:52:27.0777049Z    |                        |
2024-12-31T02:52:27.0777428Z    |                        no `TAConfig` in the root
2024-12-31T02:52:27.0777908Z    |                        help: a similar name exists in the module: `TaConfig`
2024-12-31T02:52:27.0778270Z 
2024-12-31T02:52:27.0819894Z For more information about this error, try `rustc --explain E0432`.
2024-12-31T02:52:27.0909479Z error: could not compile `ta` (build script) due to 1 previous error

ivila · 2024-12-31T02:58:39Z

@ivila CI failed because:

24-12-31T02:52:27.0302935Z    Compiling ta v0.2.0 (/__w/incubator-teaclave-trustzone-sdk/incubator-teaclave-trustzone-sdk/examples/hello_world-rs/ta)
2024-12-31T02:52:27.0773416Z error[E0432]: unresolved import `optee_utee_build::TAConfig`
2024-12-31T02:52:27.0774266Z   --> build.rs:19:24
2024-12-31T02:52:27.0774662Z    |
2024-12-31T02:52:27.0775144Z 19 | use optee_utee_build::{TAConfig, RustEdition, Error};
2024-12-31T02:52:27.0776717Z    |                        ^^^^^^^^
2024-12-31T02:52:27.0777049Z    |                        |
2024-12-31T02:52:27.0777428Z    |                        no `TAConfig` in the root
2024-12-31T02:52:27.0777908Z    |                        help: a similar name exists in the module: `TaConfig`
2024-12-31T02:52:27.0778270Z 
2024-12-31T02:52:27.0819894Z For more information about this error, try `rustc --explain E0432`.
2024-12-31T02:52:27.0909479Z error: could not compile `ta` (build script) due to 1 previous error

Sorry about that, I always miss the example part😂

1. add optee-utee-build in build-dependencies 2. remove uuid from build-dependencies 3. use build method from optee-utee-build instead of custom build script 4. use gcc as linker instead of ld.bfd to avoid compilation problems on Arm host 5. remove ta_static.rs file 6. remove configuration consts in src/main.rs Signed-off-by: ivila <[email protected]> Reviewed-by: Sumit Garg <[email protected]> Reviewed-by: Yuan Zhuang <[email protected]>

1. add document "Writing Rust TAs using optee-utee-build" 2. suggest developers using optee-utee-build in "Migrating to new building env" 3. add description about the supported host machines in README.md Signed-off-by: ivila <[email protected]> Reviewed-by: Sumit Garg <[email protected]> Reviewed-by: Yuan Zhuang <[email protected]>

ivila · 2024-12-31T03:01:04Z

update to fix the compilation error of hello-world example

DemesneGH · 2025-01-08T12:06:43Z

FYI the optee-utee-build crate has been published on https://crates.io/crates/optee-utee-build

ivila force-pushed the main branch from c6b591c to ca1fd94 Compare December 20, 2024 09:40

ivila force-pushed the main branch from ca1fd94 to 7267f57 Compare December 23, 2024 03:16

ivila force-pushed the main branch from 7267f57 to 227a76d Compare December 23, 2024 06:53

ivila force-pushed the main branch from 227a76d to 25327d1 Compare December 24, 2024 13:46

DemesneGH reviewed Dec 25, 2024

View reviewed changes

ivila force-pushed the main branch 2 times, most recently from 5f6e455 to f59a40a Compare December 26, 2024 06:24

b49020 reviewed Dec 26, 2024

View reviewed changes

optee-utee-build/src/linker.rs Show resolved Hide resolved

optee-utee-build/src/linker.rs Show resolved Hide resolved

DemesneGH reviewed Dec 26, 2024

View reviewed changes

optee-utee-build/src/ta_config.rs Outdated Show resolved Hide resolved

ivila force-pushed the main branch from f59a40a to ef367cd Compare December 27, 2024 02:36

ivila requested review from b49020 and DemesneGH December 27, 2024 03:23

ivila force-pushed the main branch from ef367cd to 1a6174a Compare December 27, 2024 07:30