Struct substrate::context::Context

pub struct Context {
    pub executor: Arc<dyn Executor>,
    pub cache: Cache,
    /* private fields */
}

The global context.

Stores configuration such as the PDK and tool plugins to use during generation.

Cheaply clonable.

Examples

let ctx = PdkContext::new(ExamplePdk);
let handle = ctx.generate_layout(Buffer::new(5));
let cell: &Cell<Buffer> = handle.cell();

assert_eq!(cell.block(), &Buffer::new(5));
assert_eq!(cell.data().inv1.block(), &Inverter::new(5));
assert_eq!(cell.data().inv2.block(), &Inverter::new(5));

assert_eq!(
    cell.data().inv1.bbox(),
    Some(Rect::from_sides(0, 0, 100, 200))
);

assert_eq!(
    cell.data().inv2.bbox(),
    Some(Rect::from_sides(110, 0, 210, 200))
);

assert_eq!(cell.bbox(), Some(Rect::from_sides(0, 0, 210, 200)));

Fields

executor: Arc<dyn Executor>

The executor to which commands should be submitted.

cache: Cache

A cache for storing the results of expensive computations.

Implementations

impl Context

pub fn new() -> Self

Creates a new Context.

impl Context

pub fn builder() -> ContextBuilder

Creates a builder for constructing a context.

pub fn with_pdk<PDK: Pdk>(&self) -> PdkContext<PDK>

Creates a PdkContext for the given installed PDK.

The PDK must first be installed in the context.

pub fn generate_cross_schematic<S1: Schema + ?Sized, S2: FromSchema<S1> + ?Sized, B: Schematic<S1>>( &self, block: B ) -> SchemaCellHandle<S2, B>

Generates a schematic of a block in schema S1 for use in schema S2.

Can only generate a cross schematic with one layer of FromSchema indirection.

pub fn generate_schematic<S: Schema + ?Sized, T: Schematic<S>>( &self, block: T ) -> SchemaCellHandle<S, T>

Generates a schematic for block in the background.

Returns a handle to the cell being generated.

pub fn export_scir<S: Schema + ?Sized, T: Schematic<S>>( &self, block: T ) -> Result<RawLib<S>, ConvError>

Export the given block and all sub-blocks as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn export_scir_all<S: Schema + ?Sized>( &self, cells: &[&RawCell<S>] ) -> Result<RawLib<S>, ConvError>

Export the given cells and all their subcells as a SCIR library.

Returns a SCIR library and metadata for converting between SCIR and Substrate formats.

pub fn simulate<S, T>( &self, block: T, work_dir: impl Into<PathBuf> ) -> Result<T::Output>

where S: Simulator, T: Testbench<S>,

Simulate the given testbench.

The simulator must be installed in the context.

pub fn install<I>(&mut self, installation: I) -> Arc<I>

where I: PrivateInstallation,

Installs the given PrivateInstallation.

Only one installation of any given type can exist. Overwrites conflicting installations of the same type.

pub fn get_or_install<I>(&self, installation: I) -> Arc<I>

where I: PrivateInstallation,

Installs the given PrivateInstallation.

Returns the existing installation if one is present.

pub fn get_private_installation<I: PrivateInstallation>(&self) -> Option<Arc<I>>

Gets a private installation from the context installation map.

pub fn get_installation<I: Installation>(&self) -> Option<Arc<I>>

Gets an installation from the context installation map.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.