openvm_circuit/
lib.rs

1#![cfg_attr(feature = "tco", allow(incomplete_features))]
2#![cfg_attr(feature = "tco", feature(explicit_tail_calls))]
3#![cfg_attr(feature = "tco", allow(internal_features))]
4#![cfg_attr(feature = "tco", feature(core_intrinsics))]
5
6// Ensure features "tco" and "aot" are mutually exclusive
7#[cfg(all(feature = "tco", feature = "aot"))]
8compile_error!("Features \"tco\" and \"aot\" cannot be enabled at the same time");
9
10// If "aot" feature is enabled but we're not on x86_64, throw a compile error
11#[cfg(all(feature = "aot", not(target_arch = "x86_64")))]
12compile_error!("Feature \"aot\" is only supported on x86_64 targets");
13
14extern crate self as openvm_circuit;
15
16pub use openvm_circuit_derive as derive;
17pub use openvm_circuit_primitives as primitives;
18pub use openvm_circuit_primitives_derive as circuit_derive;
19#[cfg(all(feature = "test-utils", feature = "cuda"))]
20pub use openvm_cuda_backend;
21#[cfg(feature = "test-utils")]
22pub use openvm_stark_sdk;
23
24/// Traits and constructs for the OpenVM architecture.
25pub mod arch;
26/// Instrumentation metrics for performance analysis and debugging
27#[cfg(feature = "metrics")]
28pub mod metrics;
29/// System chips that are always required by the architecture.
30/// (The [PhantomChip](system::phantom::PhantomChip) is not technically required for a functioning
31/// VM, but there is almost always a need for it.)
32pub mod system;
33/// Utility functions and test utils
34pub mod utils;
35
36#[cfg(feature = "cuda")]
37pub(crate) mod cuda_abi;