Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 140 additions & 11 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/hyperlight_host/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ criterion = "0.5.1"
tracing-chrome = "0.7.2"
metrics-util = "0.19.1"
metrics-exporter-prometheus = "0.17.0"
tracing-tracy = "0.11.4"

[target.'cfg(windows)'.dev-dependencies]
windows = { version = "0.61", features = [
Expand Down
9 changes: 9 additions & 0 deletions src/hyperlight_host/examples/tracing-tracy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This is an example of using the tracing-tracy tracing-subscriber. When ran, it will generate traces that can be viewed in the tracy profiler.

You can run it with:

```console
TRACY_NO_EXIT=1 RUST_LOG=trace cargo run --package hyperlight-host --example tracing-tracy --profile release-with-debug
```

and then the client should show up in the profiler GUI.
60 changes: 60 additions & 0 deletions src/hyperlight_host/examples/tracing-tracy/main.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
Copyright 2024 The Hyperlight Authors.

Licensed 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 hyperlight_host::func::{ParameterValue, ReturnType, ReturnValue};
use hyperlight_host::sandbox::uninitialized::UninitializedSandbox;
use hyperlight_host::sandbox_state::sandbox::EvolvableSandbox;
use hyperlight_host::sandbox_state::transition::Noop;
use hyperlight_host::{GuestBinary, MultiUseSandbox, Result};
use hyperlight_testing::simple_guest_as_string;
use tracing_subscriber::layer::SubscriberExt;
use tracing_subscriber::EnvFilter;

// An example of how to get tracy tracing working with hyperlight.
// Run with:
// TRACY_NO_EXIT=1 RUST_LOG=trace cargo run --package hyperlight-host --example tracing-tracy --profile release-with-debug,
// and then open the `tracy-profiler` GUI, and there should be an option to load the client created by this example.
fn main() -> Result<()> {
tracing::subscriber::set_global_default(
tracing_subscriber::registry()
.with(EnvFilter::from_default_env())
.with(tracing_tracy::TracyLayer::default()),
)
.expect("setup tracy layer");

let simple_guest_path =
simple_guest_as_string().expect("Cannot find the guest binary at the expected location.");

// Create a new sandbox.
let usandbox =
UninitializedSandbox::new(GuestBinary::FilePath(simple_guest_path), None, None, None)?;

let mut sbox = usandbox
.evolve(Noop::<UninitializedSandbox, MultiUseSandbox>::default())
.unwrap();

// do the function call
let current_time = std::time::Instant::now();
let res = sbox.call_guest_function_by_name(
"Echo",
ReturnType::String,
Some(vec![ParameterValue::String("Hello, World!".to_string())]),
)?;
let elapsed = current_time.elapsed();
println!("Function call finished in {:?}.", elapsed);
assert!(matches!(res, ReturnValue::String(s) if s == "Hello, World!"));
Ok(())
}