Struct libreda_lefdef::lef_ast::LEF

pub struct LEF {
    pub version: Option<String>,
    pub busbitchars: (char, char),
    pub dividerchar: char,
    pub vias: BTreeMap<String, ViaDefinition>,
    pub sites: BTreeMap<String, SiteDefinition>,
    pub technology: TechnologyLef,
    pub library: LibraryLef,
    pub extensions: BTreeMap<String, ()>,
}

Top-level structure of a LEF library.

Fields

version: Option<String>

LEF version.

busbitchars: (char, char)

Characters used to indicate bus bits. Default is [ and ].

dividerchar: char

Character used as path separator. Default is /.

vias: BTreeMap<String, ViaDefinition>

Definitions of fixed VIAs by name.

sites: BTreeMap<String, SiteDefinition>

All SITE definitions by name.

technology: TechnologyLef

Technology information of the design.

library: LibraryLef

Cell and macro information.

extensions: BTreeMap<String, ()>

Extensions as defined by BEGINEXT blocks.

Implementations

impl LEF

pub fn load<R: Read>(reader: &mut R) -> Result<LEF, LefDefParseError>

Deserialize a LEF from a Write trait object.

pub fn load_file(path: impl AsRef<Path>) -> Result<LEF, LefDefParseError>

Shortcut for reading a LEF library from a file.

Trait Implementations

impl Clone for LEF

fn clone(&self) -> LEF

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LEF

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LEF

fn default() -> Self

Returns the “default value” for a type.

impl HierarchyBase for LEF

type NameType = String

Type for names of cells, instances, etc.

fn cell_by_name(&self, name: &str) -> Option<Self::CellId>

Find a cell by its name. Return the cell with the given name. Returns None if the cell does not exist.

fn cell_instance_by_name( &self, parent_cell: &Self::CellId, name: &str ) -> Option<Self::CellInstId>

Find a cell instance by its name. Returns None if the name does not exist.

fn cell_name(&self, CellId: &Self::CellId) -> Self::NameType

Get the name of the cell.

fn cell_instance_name( &self, cell_inst: &Self::CellInstId ) -> Option<Self::NameType>

Get the name of the cell instance.

fn parent_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the parent cell of this instance.

fn template_cell(&self, cell_instance: &Self::CellInstId) -> Self::CellId

Get the ID of the template cell of this instance.

fn for_each_cell<F>(&self, f: F)where F: FnMut(Self::CellId),

Call a function on each cell of the netlist.

fn for_each_cell_instance<F>(&self, cell: &Self::CellId, f: F)where F: FnMut(Self::CellInstId),

Call a function on each instance in this cell.

fn for_each_cell_dependency<F>(&self, cell: &Self::CellId, f: F)where F: FnMut(Self::CellId),

Call a function for each cell that is a child of this cell.

fn for_each_dependent_cell<F>(&self, cell: &Self::CellId, f: F)where F: FnMut(Self::CellId),

Call a function for each cell that directly depends on cell.

fn for_each_cell_reference<F>(&self, cell: &Self::CellId, f: F)where F: FnMut(Self::CellInstId),

Iterate over all instances of this cell, i.e. instances that use this cell as a template.

fn num_child_instances(&self, cell: &Self::CellId) -> usize

Get the number of cell instances inside the cell.

fn num_cells(&self) -> usize

Get the number of cell templates.

fn each_cell_vec(&self) -> Vec<Self::CellId, Global>

Get a Vec of all cell IDs in this netlist.

fn each_cell(&self) -> Box<dyn Iterator<Item = Self::CellId>, Global>

Iterate over all cells.

fn each_cell_instance_vec( &self, cell: &Self::CellId ) -> Vec<Self::CellInstId, Global>

Get a Vec of the IDs of all instances in this cell.

fn each_cell_instance( &self, cell: &Self::CellId ) -> Box<dyn Iterator<Item = Self::CellInstId>, Global>

Iterate over all instances in a cell.

fn each_cell_dependency_vec( &self, cell: &Self::CellId ) -> Vec<Self::CellId, Global>

Get a Vec of each cell that is a child of this cell.

fn each_cell_dependency<'a>( &'a self, cell: &Self::CellId ) -> Box<dyn Iterator<Item = Self::CellId> + 'a, Global>

Iterate over all cells that are instantiated in this cell.

fn num_cell_dependencies(&self, cell: &Self::CellId) -> usize

Count all cells that are dependencies of cell.

fn each_dependent_cell_vec( &self, cell: &Self::CellId ) -> Vec<Self::CellId, Global>

Get a Vec of each cell that directly depends on cell.

fn each_dependent_cell<'a>( &'a self, cell: &Self::CellId ) -> Box<dyn Iterator<Item = Self::CellId> + 'a, Global>

Iterate over each cell that directly depends on cell.

fn num_dependent_cells(&self, cell: &Self::CellId) -> usize

Count all cells that are directly dependent on cell, i.e. contain an instance of cell.

fn each_cell_reference_vec( &self, cell: &Self::CellId ) -> Vec<Self::CellInstId, Global>

Get a Vec with all cell instances referencing this cell.

fn each_cell_reference( &self, cell: &Self::CellId ) -> Box<dyn Iterator<Item = Self::CellInstId>, Global>

Iterate over all instances of this cell, i.e. instances that use this cell as a template.

fn num_cell_references(&self, cell: &Self::CellId) -> usize

Count all instantiations of cell.

fn get_chip_property(&self, key: &Self::NameType) -> Option<PropertyValue>

Get a property of the top-level chip data structure.

fn get_cell_property( &self, cell: &Self::CellId, key: &Self::NameType ) -> Option<PropertyValue>

Get a property of a cell.

fn get_cell_instance_property( &self, inst: &Self::CellInstId, key: &Self::NameType ) -> Option<PropertyValue>

Get a property of a cell instance.

impl HierarchyIds for LEF

type CellId = CellId

Cell/module identifier type.

type CellInstId = ()

Cell instance identifier type.

impl LayoutBase for LEF

fn dbu(&self) -> Self::Coord

Get the distance unit used in this layout in ‘pixels per micron’.

fn each_layer(&self) -> Box<dyn Iterator<Item = Self::LayerId> + '_>

Iterate over all defined layers.

fn layer_info(&self, layer: &Self::LayerId) -> LayerInfo<Self::NameType>

Get the LayerInfo data structure for this layer.

fn find_layer(&self, index: u32, datatype: u32) -> Option<Self::LayerId>

Find layer index by the (index, data type) tuple.

fn layer_by_name(&self, name: &str) -> Option<Self::LayerId>

Find layer index by the name.

fn bounding_box_per_layer( &self, cell: &Self::CellId, layer: &Self::LayerId ) -> Option<Rect<Self::Coord>>

Compute the bounding box of the shapes on one layer. The bounding box also includes all child cell instances.

fn each_shape_id( &self, cell: &Self::CellId, layer: &Self::LayerId ) -> Box<dyn Iterator<Item = Self::ShapeId>>

Iterate over the IDs of all shapes in the cell on a specific layer.

fn for_each_shape<F>(&self, CellId: &Self::CellId, layer: &Self::LayerId, f: F)where F: FnMut(&Self::ShapeId, &Geometry<Self::Coord>),

Call a function for each shape on this layer.

fn with_shape<F, R>(&self, shape_id: &Self::ShapeId, f: F) -> Rwhere F: FnMut(&Self::LayerId, &Geometry<Self::Coord>) -> R,

Access a shape by its ID.

fn parent_of_shape( &self, shape_id: &Self::ShapeId ) -> (Self::CellId, Self::LayerId)

Get the parent cell and the layer of a shape as a (cell, layer) tuple.

fn get_transform( &self, _cell_inst: &Self::CellInstId ) -> SimpleTransform<Self::Coord>

Get the geometric transform that describes the location of a cell instance relative to its parent.

fn bounding_box(&self, cell: &Self::CellId) -> Option<Rect<Self::Coord>>

Compute the bounding box of the cell over all layers. The bounding box is not defined if the cell is empty. In this case return None.

fn shape_geometry(&self, shape_id: &Self::ShapeId) -> Geometry<Self::Coord>

Get a clone of the shape geometry.

fn shape_layer(&self, shape_id: &Self::ShapeId) -> Self::LayerId

Get the layer of a shape.

fn for_each_shape_recursive<F>( &self, cell: &Self::CellId, layer: &Self::LayerId, f: F )where F: FnMut(SimpleTransform<Self::Coord>, &Self::ShapeId, &Geometry<Self::Coord>),

Call a function f for each shape of this cell and its sub cells. Along to the geometric shape f also gets a transformation as argument. The transformation describes the actual position of the geometric shape relative to the cell.

fn get_shape_property( &self, shape: &Self::ShapeId, key: &Self::NameType ) -> Option<PropertyValue>

Get a property of a shape.

impl LayoutIds for LEF

type Coord = i32

Number type used for coordinates and distances.

type Area = i64

Number type for areas. This is possibly another type then Coord for the following reasons:

type LayerId = String

Layer identifier type.

type ShapeId = ShapeId

Shape identifier type.

impl NetlistBase for LEF

fn template_pin(&self, pin_instance: &Self::PinInstId) -> Self::PinId

Get the ID of the template pin of this pin instance.

fn pin_direction(&self, (cell, pin_name): &Self::PinId) -> Direction

Get the signal direction of the pin.

fn pin_name(&self, (_macro_name, pin_name): &Self::PinId) -> Self::NameType

Get the name of the pin.

fn pin_by_name( &self, parent_circuit: &Self::CellId, pin_name: &str ) -> Option<Self::PinId>

Find a pin by its name. Returns None if no such pin can be found.

fn parent_cell_of_pin(&self, (CellId, pin_name): &Self::PinId) -> Self::CellId

Get the ID of the parent circuit of this pin.

fn parent_of_pin_instance(&self, pin_inst: &Self::PinInstId) -> Self::CellInstId

Get the ID of the circuit instance that holds this pin instance.

fn parent_cell_of_net(&self, _net: &Self::NetId) -> Self::CellId

Get the ID of the parent circuit of this net.

fn net_of_pin(&self, _pin: &Self::PinId) -> Option<Self::NetId>

Get the internal net attached to this pin.

fn net_of_pin_instance( &self, _pin_instance: &Self::PinInstId ) -> Option<Self::NetId>

Get the external net attached to this pin instance.

fn net_zero(&self, parent_circuit: &Self::CellId) -> Self::NetId

Get the net of the logical constant zero.

fn net_one(&self, parent_circuit: &Self::CellId) -> Self::NetId

Get the net of the logical constant one.

fn net_by_name( &self, parent_circuit: &Self::CellId, name: &str ) -> Option<Self::NetId>

Find a net by its name inside the parent circuit. Returns None if no such net can be found.

fn net_name(&self, net: &Self::NetId) -> Option<Self::NameType>

Get the name of the net.

fn for_each_pin<F>(&self, circuit: &Self::CellId, f: F)where F: FnMut(Self::PinId),

Call a function for each pin of the circuit.

fn for_each_pin_instance<F>(&self, _circuit_inst: &Self::CellInstId, _f: F)where F: FnMut(Self::PinInstId),

Call a function for each pin instance of the circuit instance.

fn for_each_internal_net<F>(&self, _circuit: &Self::CellId, _f: F)where F: FnMut(Self::NetId),

Call a function for net of the circuit.

fn num_pins(&self, CellId: &Self::CellId) -> usize

Get the number of pins of a circuit.

fn for_each_pin_of_net<F>(&self, net: &Self::NetId, f: F)where F: FnMut(Self::PinId),

Call a function for each pin connected to this net.

fn for_each_pin_instance_of_net<F>(&self, net: &Self::NetId, f: F)where F: FnMut(Self::PinInstId),

Call a function for each pin instance connected to this net.

fn pin_instance( &self, cell_inst: &Self::CellInstId, pin: &Self::PinId ) -> Self::PinInstId

Get the ID of a pin instance given the cell instance and the pin ID.

fn each_pin_vec(&self, circuit: &Self::CellId) -> Vec<Self::PinId, Global>

Get a Vec with the IDs of all pins of this circuit.

fn each_pin<'a>( &'a self, circuit: &Self::CellId ) -> Box<dyn Iterator<Item = Self::PinId> + 'a, Global>

Iterate over all pins of a circuit.

fn each_pin_instance_vec( &self, circuit_instance: &Self::CellInstId ) -> Vec<Self::PinInstId, Global>

Get a Vec with the IDs of all pin instance of this circuit instance.

fn each_pin_instance<'a>( &'a self, circuit_instance: &Self::CellInstId ) -> Box<dyn Iterator<Item = Self::PinInstId> + 'a, Global>

Iterate over all pin instances of a circuit.

fn each_external_net<'a>( &'a self, circuit_instance: &Self::CellInstId ) -> Box<dyn Iterator<Item = Self::NetId> + 'a, Global>

Iterate over all external nets connected to the circuit instance. A net might appear more than once.

fn for_each_external_net<F>(&self, circuit_instance: &Self::CellInstId, f: F)where F: FnMut(Self::NetId),

Iterate over all external nets connected to the circuit instance. A net might appear more than once.

fn each_external_net_vec( &self, circuit_instance: &Self::CellInstId ) -> Vec<Self::NetId, Global>

Get a vector of all external nets connected to the circuit instance. A net might appear more than once.

fn each_internal_net_vec( &self, circuit: &Self::CellId ) -> Vec<Self::NetId, Global>

Get a Vec with all nets in this circuit.

fn each_internal_net<'a>( &'a self, circuit: &Self::CellId ) -> Box<dyn Iterator<Item = Self::NetId> + 'a, Global>

Iterate over all defined nets inside a circuit.

fn num_internal_nets(&self, circuit: &Self::CellId) -> usize

Return the number of nets defined inside a cell.

fn num_net_pins(&self, net: &Self::NetId) -> usize

Get the number of pins that are connected to this net.

fn num_net_pin_instances(&self, net: &Self::NetId) -> usize

Get the number of pin instances that are connected to this net.

fn num_net_terminals(&self, net: &Self::NetId) -> usize

Get the number of terminals that are connected to this net.

fn each_pin_of_net_vec(&self, net: &Self::NetId) -> Vec<Self::PinId, Global>

Get a Vec with all pin IDs connected to this net.

fn each_pin_of_net<'a>( &'a self, net: &Self::NetId ) -> Box<dyn Iterator<Item = Self::PinId> + 'a, Global>

Iterate over all pins of a net.

fn each_pin_instance_of_net_vec( &self, net: &Self::NetId ) -> Vec<Self::PinInstId, Global>

Get a Vec with all pin instance IDs connected to this net.

fn each_pin_instance_of_net<'a>( &'a self, net: &Self::NetId ) -> Box<dyn Iterator<Item = Self::PinInstId> + 'a, Global>

Iterate over all pins of a net.

impl NetlistIds for LEF

type PinId = (<LEF as HierarchyIds>::CellId, String)

Pin identifier type. Uniquely identifies a pin in the whole netlist.

type PinInstId = ()

Pin instance identifier type. Uniquely identifies a pin instance in the whole netlist. A pin instance is a pin of a circuit instance.

type NetId = ()

Net identifier type. Uniquely identifies a net in the whole netlist.