Crate pliron

pliron: Programming Languages Intermediate RepresentatiON

pliron is an extensible compiler IR framework, inspired by MLIR and written in safe Rust.

Modules

• attribute
  Attributes are non-SSA data stored in Operations.
• basic_block
  A BasicBlock is a list of Operations.
• common_traits
  Utility traits such as Named, Verify etc.
• context
  Context and Ptr together provide memory management for pliron.
• debug_info
  Utilities for attaching / retrieving debug info to / from the IR.
• dialect
  Dialects are a mechanism to group related Ops, Types and Attributes.
• dialects
  Various dialects that are part of pliron. These may be separated into different crates in the future.
• error
  Utilities for error handling
• linked_list
  Provide linked-list operations for Ptr<T: LinkedList>.
• op
  An Op is a thin wrapper arround an Operation, providing API specific to the OpId of that Operation.
• operation
  An operation is the basic unit of execution in the IR. The general idea is similar to MLIR’s Operation
• parsable
  IR objects that can be parsed from their text representation.
• printable
  IR objects that are to be printed must implement Printable.
• region
  Regions are containers for BasicBlocks within an Operation.
• storage_uniquer
  Store unique instances of a rust type.
• type
  Every SSA value, such as operation results or block arguments has a type defined by the type system.
• use_def_lists
  Use-Def and Def-Use Graph.
• vec_exns
  Extend functionality of Rust vectors.

Macros

• create_err
  Specify ErrorKind and create an error from any std::error::Error object. The macro also accepts format! like arguments to create one-off errors. It may be shorter to just use verify_err! or input_err! instead.
• declare_op
  Declare an Op
• impl_attr
  impl Attribute for a rust type.
• impl_attr_interface
  Implement an Attribute Interface for an Attribute. The interface trait must define a verify function with type AttrInterfaceVerifier.
• impl_op_interface
  Implement an Op Interface for an Op. The interface trait must define a verify function with type OpInterfaceVerifier
• impl_type
  impl Type for a rust type
• indented_block
  All statements in the block are indented during fmt. Simply wraps the block with State::push_indent and State::pop_indent.
• input_err
  Create an ErrorKind::InvalidInput error from any std::error::Error object. The macro also accepts format! like arguments to create one-off errors.
• verify_err
  Create an ErrorKind::VerificationFailed error from any std::error::Error object. The macro also accepts format! like arguments to create one-off errors.