Move oak_runtime and oak_loader crates

Make them top-level crates, and fix imports transitively This is more in line with standard Rust conventions, and also makes the code more organized and easier to navigate. Move proto folder to top level too. Use more explicit dependencies between local crates (using `path`).
project-oak · Aug 18, 2020 · 84b09af · 84b09af
1 parent 81861ed
commit 84b09af
Show file tree

Hide file tree

Showing 90 changed files with 2,059 additions and 148 deletions.
diff --git a/.github/workflows/upload_coverage.yaml b/.github/workflows/upload_coverage.yaml
@@ -35,4 +35,4 @@ jobs:
 
       - name: Upload to codecov.io
         run: |
-          bash <(curl -s https://codecov.io/bash) -f ./oak/server/target/debug/lcov.info
+          bash <(curl -s https://codecov.io/bash) -f ./oak_loader/target/debug/lcov.info
diff --git a/docs/programming-oak.md b/docs/programming-oak.md
@@ -292,7 +292,7 @@ the following script:
 The Oak Application is then started using the Oak Loader:
 
 ```bash
-./oak/server/target/x86_64-unknown-linux-musl/release/oak_loader --application=./examples/hello_world/bin/hello_world.oak
+./oak_loader/target/x86_64-unknown-linux-musl/release/oak_loader --application=./examples/hello_world/bin/hello_world.oak
 ```
 
 The Oak Loader will launch an [Oak Runtime](concepts.md#oak-runtime), and this

diff --git a/docs/sdk.md b/docs/sdk.md
@@ -129,8 +129,7 @@ as a `Duration` since the UNIX epoch.
 
 ### `oak::proto` Module
 
-The
-[`oak::proto`](https://project-oak.github.io/oak/sdk/doc/oak/proto/index.html)
+The [`oak::proto`](https://project-oak.github.io/oak/sdk/doc/proto/index.html)
 module holds auto-generated submodules for dealing with protocol buffers.
 
 ### `oak::logger` Module

diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -40,7 +40,7 @@ oak = { path = "../sdk/rust/oak" }
 oak_abi = { path = "../oak_abi" }
 oak_derive = { path = "../sdk/rust/oak_derive" }
 oak_io = { path = "../oak_io" }
-oak_runtime = { path = "../oak/server/rust/oak_runtime" }
+oak_runtime = { path = "../oak_runtime" }
 oak_services = { path = "../oak_services" }
 oak_tests = { path = "../sdk/rust/oak_tests" }
 oak_utils = { path = "../oak_utils" }

diff --git a/examples/aggregator/scripts/docker_build_and_push b/examples/aggregator/scripts/docker_build_and_push
@@ -14,7 +14,7 @@ readonly BACKEND_DOCKER_IMAGE_NAME='gcr.io/oak-ci/oak-aggregator-backend'
   # Build aggregator image
 
   # Build the base server.
-  docker build --tag=oak_docker --file=./oak/server/Dockerfile ./oak/server
+  docker build --tag=oak_docker --file=./oak_loader/Dockerfile ./oak_loader
   # Build and save the example
   docker build --tag=aggregator --file=./examples/Dockerfile "./examples/aggregator"
   docker tag aggregator "${AGGREGATOR_DOCKER_IMAGE_NAME}":latest

diff --git a/examples/aggregator/scripts/run_server b/examples/aggregator/scripts/run_server
@@ -8,7 +8,7 @@ source "${GLOBAL_SCRIPTS_DIR}/common"
 "${GLOBAL_SCRIPTS_DIR}/build_example" -e aggregator
 
 readonly APPLICATION="${PWD}/examples/aggregator/bin/aggregator.oak"
-exec cargo run --release --target=x86_64-unknown-linux-musl --manifest-path=oak/server/rust/oak_loader/Cargo.toml -- \
+exec cargo run --release --target=x86_64-unknown-linux-musl --manifest-path=oak_loader/Cargo.toml -- \
   --application="${APPLICATION}" \
   --grpc-tls-private-key="${GLOBAL_SCRIPTS_DIR}/../examples/certs/local/local.key" \
   --grpc-tls-certificate="${GLOBAL_SCRIPTS_DIR}/../examples/certs/local/local.pem" \

diff --git a/examples/authentication/README.md b/examples/authentication/README.md
@@ -21,7 +21,7 @@ The Oak server can be run with the OpenID Connect authentication service enabled
 using the --oidc-client flag:
 
 ```bash
-cargo run --manifest-path=oak/server/rust/oak_loader/Cargo.toml -- \
+cargo run --manifest-path=oak_loader/Cargo.toml -- \
     --application=<APP_CONFIG_PATH> \
     --grpc-tls-private-key=<PRIVATE_KEY_PATH> \
     --grpc-tls-certificate=<CERTIFICATE_PATH> \

diff --git a/examples/authentication/client/build.rs b/examples/authentication/client/build.rs
@@ -18,7 +18,7 @@ use oak_utils::{generate_grpc_code, CodegenOptions};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     generate_grpc_code(
-        "../../../oak/proto",
+        "../../../proto",
         &["authentication.proto"],
         CodegenOptions {
             build_client: true,

diff --git a/examples/chat/proto/BUILD b/examples/chat/proto/BUILD
@@ -27,8 +27,8 @@ proto_library(
     name = "chat_proto",
     srcs = ["chat.proto"],
     deps = [
-        "//oak/proto:handle_proto",
         "//oak_services/proto:grpc_encap_proto",
+        "//proto:handle_proto",
         "@com_google_protobuf//:empty_proto",
     ],
 )

diff --git a/examples/chat/proto/chat.proto b/examples/chat/proto/chat.proto
@@ -19,7 +19,7 @@ syntax = "proto3";
 package oak.examples.chat;
 
 import "google/protobuf/empty.proto";
-import "oak/proto/handle.proto";
+import "proto/handle.proto";
 import "oak_services/proto/grpc_encap.proto";
 
 message CreateRoomRequest {

diff --git a/examples/hello_world/client/android/java/com/google/oak/hello_world/MainActivity.java b/examples/hello_world/client/android/java/com/google/oak/hello_world/MainActivity.java
@@ -44,9 +44,9 @@
 
 /** Main activity for the Oak Android "Hello, World" app. */
 public class MainActivity extends Activity {
-  // Keep in sync with /oak/server/rust/oak_runtime/src/node/grpc/server/mod.rs.
+  // Keep in sync with /oak_runtime/src/node/grpc/server/mod.rs.
   private static final String OAK_LABEL_GRPC_METADATA_KEY = "x-oak-label-bin";
-  
+
   private HandlerThread backgroundHandlerThread;
   private Handler backgroundHandler;
 

diff --git a/examples/hello_world/client/nodejs/index.js b/examples/hello_world/client/nodejs/index.js
@@ -23,7 +23,7 @@ const CERT_PATH = __dirname + '/../../../certs/local/ca.pem';
 const SERVICE_PROTO_PATH = __dirname + '/../../proto/hello_world.proto';
 const OAK_LABEL_PROTO_PATH = __dirname + '/../../../../oak_abi/proto/label.proto';
 
-// Keep in sync with /oak/server/rust/oak_runtime/src/node/grpc/server/mod.rs.
+// Keep in sync with /oak_runtime/src/node/grpc/server/mod.rs.
 const oakLabelGrpcMetadataKey = 'x-oak-label-bin';
 
 async function main() {
@@ -52,31 +52,29 @@ async function main() {
     return metaData;
   }
 
-  const helloWorldProto = grpc.loadPackageDefinition(helloWorldDefinition).oak
-    .examples.hello_world;
+  const helloWorldProto = grpc.loadPackageDefinition(helloWorldDefinition).oak.examples.hello_world;
   const credentials = grpc.credentials.createSsl(fs.readFileSync(CERT_PATH));
 
   const client = new helloWorldProto.HelloWorld('localhost:8080', credentials);
 
   // For documentation on client calls see the `@grpc/grpc-js` documentation:
   // https://grpc.github.io/grpc/node/grpc.Client.html#~CallProperties
   client.sayHello(
-    // The arguments passed to the gRPC service. Corresponds to the
-    // `HelloRequest` message type in hello_world.proto file.
-    { greeting: 'Node.js' },
-    // The metadata for this gRPC call.
-    getGrpcMetadata(),
-    // Callback invoked with the response.
-    (error, response) => {
-      if (error) {
-        console.error(error);
-        process.exit(1);
-      } else {
-        console.log(response.reply);
-        process.exit(0);
-      }
-    }
-  );
+      // The arguments passed to the gRPC service. Corresponds to the
+      // `HelloRequest` message type in hello_world.proto file.
+      {greeting: 'Node.js'},
+      // The metadata for this gRPC call.
+      getGrpcMetadata(),
+      // Callback invoked with the response.
+      (error, response) => {
+        if (error) {
+          console.error(error);
+          process.exit(1);
+        } else {
+          console.log(response.reply);
+          process.exit(0);
+        }
+      });
 }
 
 main();
diff --git a/examples/hello_world/module/cpp/BUILD b/examples/hello_world/module/cpp/BUILD
@@ -28,6 +28,6 @@ cc_binary(
         "//oak/module:oak_abi",
         "//oak/module:oak_main",
         # TODO(#422): Sort out inclusion of protobuf files
-        # "//oak/proto:oak_api_cc_proto",
+        # "//proto:oak_api_cc_proto",
     ],
 )
diff --git a/examples/injection/proto/BUILD b/examples/injection/proto/BUILD
@@ -27,7 +27,7 @@ proto_library(
     name = "injection_proto",
     srcs = ["injection.proto"],
     deps = [
-        "//oak/proto:handle_proto",
+        "//proto:handle_proto",
         "@com_google_protobuf//:empty_proto",
     ],
 )

diff --git a/examples/injection/proto/injection.proto b/examples/injection/proto/injection.proto
@@ -16,7 +16,7 @@
 
 syntax = "proto3";
 
-import "oak/proto/handle.proto";
+import "proto/handle.proto";
 
 package oak.examples.injection;
 

diff --git a/examples/tensorflow/module/cpp/BUILD b/examples/tensorflow/module/cpp/BUILD
@@ -48,7 +48,7 @@ cc_binary(
         "//oak/module:oak_main",
         "//oak/module:placeholders",
         # TODO(#422): Sort out inclusion of protobuf files
-        # "//oak/proto:oak_api_cc_proto",
+        # "//proto:oak_api_cc_proto",
         "@org_tensorflow//tensorflow/lite:framework",
         "@org_tensorflow//tensorflow/lite/kernels:builtin_ops",
     ],
@@ -82,7 +82,7 @@ cc_binary(
         "//oak/module:oak_main",
         "//oak/module:placeholders",
         # TODO(#422): Sort out inclusion of protobuf files
-        # "//oak/proto:oak_api_cc_proto",
+        # "//proto:oak_api_cc_proto",
         "@org_tensorflow//tensorflow/lite/micro:micro_framework",
         "@org_tensorflow//tensorflow/lite/micro/kernels:all_ops_resolver",
     ],

diff --git a/examples/translator/client/translator.go b/examples/translator/client/translator.go
@@ -35,7 +35,7 @@ var (
 	caCert  = flag.String("ca_cert", "", "Path to the PEM-encoded CA root certificate")
 )
 
-// Keep in sync with /oak/server/rust/oak_runtime/src/node/grpc/server/mod.rs.
+// Keep in sync with /oak_runtime/src/node/grpc/server/mod.rs.
 const oakLabelGrpcMetadataKey = "x-oak-label-bin"
 
 func translate(ctx context.Context, client translator_pb.TranslatorClient, text, fromLang, toLang string) {

diff --git a/oak/common/label.cc b/oak/common/label.cc
@@ -24,7 +24,7 @@ namespace oak {
 //
 // See https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md.
 //
-// Keep in sync with /oak/server/rust/oak_runtime/src/node/grpc/server/mod.rs.
+// Keep in sync with /oak_runtime/src/node/grpc/server/mod.rs.
 const char kOakLabelGrpcMetadataKey[] = "x-oak-label-bin";
 
 // The `-bin` suffix allows sending binary data for this metadata key.

diff --git a/oak/module/oak_main.h b/oak/module/oak_main.h
@@ -28,7 +28,7 @@ extern "C" void process_invocation(const uint8_t* req_buf, uint32_t req_size,
                                    oak_abi::Handle rsp_handle);
 
 // TODO(#422): Sort out inclusion of protobuf files
-// #include "oak/proto/oak_api.pb.h"
+// #include "proto/oak_api.pb.h"
 
 // Placeholder main entrypoint for C++ Oak Modules that have simple unary
 // method semantics.  The Oak Module needs to provide an implementation

diff --git a/oak/server/Cargo.toml b/oak/server/Cargo.toml
diff --git a/oak_abi/Cargo.toml b/oak_abi/Cargo.toml
@@ -9,14 +9,15 @@ license = "Apache-2.0"
 
 [dependencies]
 log = "*"
-prost = "*"
-prost-types = "*"
+prost = { path = "../third_party/prost" }
+prost-types = { path = "../third_party/prost/prost-types" }
 
 [build-dependencies]
 oak_utils = { path = "../oak_utils" }
-prost-build = "*"
+prost-build = { path = "../third_party/prost/prost-build" }
 
 [patch.crates-io]
-prost-build = { path = "../third_party/prost/prost-build" }
 prost = { path = "../third_party/prost" }
+prost-build = { path = "../third_party/prost/prost-build" }
+prost-derive = { path = "../third_party/prost/prost-derive" }
 prost-types = { path = "../third_party/prost/prost-types" }
diff --git a/oak_io/Cargo.lock b/oak_io/Cargo.lock
diff --git a/oak_io/Cargo.toml b/oak_io/Cargo.toml
@@ -9,3 +9,9 @@ license = "Apache-2.0"
 
 [dependencies]
 oak_abi = { path = "../oak_abi" }
+
+[patch.crates-io]
+prost = { path = "../third_party/prost" }
+prost-build = { path = "../third_party/prost/prost-build" }
+prost-derive = { path = "../third_party/prost/prost-derive" }
+prost-types = { path = "../third_party/prost/prost-types" }
diff --git a/oak/server/.dockerignore → oak_loader/.dockerignore b/oak/server/.dockerignore → oak_loader/.dockerignore
diff --git a/oak/server/Cargo.lock → oak_loader/Cargo.lock b/oak/server/Cargo.lock → oak_loader/Cargo.lock