Skip to main content

FuncOp

Struct FuncOp 

Source
pub struct FuncOp { /* private fields */ }
Expand description

Equivalent to LLVM’s func operation. See llvm.func.

§Attribute(s):

Note: Only attributes defined directly as part of this operation are listed here. There may be others, not listed here, defined by interface implementations.

NameStatic Name IdentifierType
llvm_func_typeATTR_KEY_LLVM_FUNC_TYPETypeAttr
llvm_function_linkageATTR_KEY_LLVM_FUNCTION_LINKAGELinkageAttr

Implementations§

Source§

impl FuncOp

Source

pub fn get_attr_llvm_func_type<'a>( &self, ctx: &'a Context, ) -> Option<Ref<'a, TypeAttr>>

Get a Ref to the value of the attribute named llvm_func_type. The Ref is a borrow of the containing Operation object.

Source

pub fn set_attr_llvm_func_type(&self, ctx: &Context, value: TypeAttr)

Set the value of the attribute named llvm_func_type.

Source

pub fn get_attr_llvm_function_linkage<'a>( &self, ctx: &'a Context, ) -> Option<Ref<'a, LinkageAttr>>

Get a Ref to the value of the attribute named llvm_function_linkage. The Ref is a borrow of the containing Operation object.

Source

pub fn set_attr_llvm_function_linkage(&self, ctx: &Context, value: LinkageAttr)

Set the value of the attribute named llvm_function_linkage.

Source§

impl FuncOp

Source

pub fn new(ctx: &mut Context, name: Identifier, ty: TypePtr<FuncType>) -> Self

Create a new empty FuncOp.

Source

pub fn get_type(&self, ctx: &Context) -> TypePtr<FuncType>

Get the function signature (type).

Source

pub fn get_entry_block(&self, ctx: &Context) -> Option<Ptr<BasicBlock>>

Get the entry block (if it exists) of this function.

Source

pub fn get_or_create_entry_block(&self, ctx: &mut Context) -> Ptr<BasicBlock>

Get the entry block of this function, creating it if it does not exist.

Trait Implementations§

Source§

impl AtMostOneRegionInterface for FuncOp

Source§

impl BlockArgRemoval for FuncOp

Source§

fn can_remove_block_args(&self, ctx: &Context, block: Ptr<BasicBlock>) -> bool

Returns true if arguments of block can be safely removed, and false otherwise.
Source§

impl Clone for FuncOp

Source§

fn clone(&self) -> FuncOp

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Hash for FuncOp

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IsDeclaration for FuncOp

Source§

fn is_declaration(&self, ctx: &Context) -> bool

Check if this global value (variable or function) is a declaration.
Source§

impl LlvmSymbolName for FuncOp

Source§

fn llvm_symbol_name(&self, ctx: &Context) -> Option<String>

Get the original LLVM symbol name, if it’s different from the pliron symbol name.
Source§

fn set_llvm_symbol_name(&self, ctx: &Context, name: String)

Set the original LLVM symbol name.
Source§

impl Op for FuncOp

Source§

fn get_operation(&self) -> Ptr<Operation>

Get the underlying IR Operation
Source§

fn get_opid(&self) -> OpId

Get this Op’s OpId
Source§

fn get_opid_static() -> OpId

Get this Op’s OpId, without self reference.
Source§

fn get_concrete_op_info() -> (fn(Ptr<Operation>) -> OpBox, TypeId)
where Self: Sized,

Get details about the concrete Op type.
Source§

fn register(ctx: &mut Context)
where Self: Sized + Parsable<Arg = Vec<(Identifier, Location)>, Parsed = OpBox>,

Register Op in Context and add it to its dialect.
Source§

fn loc(&self, ctx: &Context) -> Location

Get Op’s location
Source§

impl Parsable for FuncOp

Source§

type Arg = Vec<(Identifier, Location)>

Type of the argument that must be passed to the parser.
Source§

type Parsed = OpBox

The type of the parsed entity.
Source§

fn parse<'a>( state_stream: &mut StateStream<'a>, results: Self::Arg, ) -> ParseResult<'a, Self::Parsed>

Define a parser using existing combinators and call into on [Parser::parse_stream] to get the final ParseResult. Use state_stream.state as necessary.
Source§

fn parser<'a>( arg: Self::Arg, ) -> Box<dyn Parser<Stream<Stream<Stream<Stream<IteratorStream<CharIterator<'a>>, SourcePosition>>>, State<'a>>, PartialState = (), Output = Self::Parsed> + 'a>

Get a parser combinator that can work on StateStream as its input.
Source§

impl PartialEq for FuncOp

Source§

fn eq(&self, other: &FuncOp) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Printable for FuncOp

Source§

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

Source§

fn disp<'t, 'c>(&'t self, ctx: &'c Context) -> Box<dyn Display + 'c>
where 't: 'c,

Get a Display’able object from the given Context and default State.
Source§

fn print<'t, 'c>( &'t self, ctx: &'c Context, state: &State, ) -> Box<dyn Display + 'c>
where 't: 'c,

Get a Display’able object from the given Context and State.
Source§

impl SymbolOpInterface for FuncOp

Source§

fn get_symbol_name(&self, ctx: &Context) -> Identifier

Get the name of the symbol defined by this operation.
Source§

fn set_symbol_name(&self, ctx: &mut Context, name: Identifier)

Set a name for the symbol defined by this operation.
Source§

impl Typed for FuncOp

Source§

fn get_type(&self, ctx: &Context) -> Ptr<TypeObj>

Get the Type of the current entity.
Source§

impl Verify for FuncOp

Source§

fn verify(&self, _ctx: &Context) -> Result<()>

Source§

impl AtMostNRegionsInterface<1> for FuncOp

Source§

impl Copy for FuncOp

Source§

impl Eq for FuncOp

Source§

impl IsolatedFromAboveInterface for FuncOp

Source§

impl NOpdsInterface<0> for FuncOp

Source§

impl NResultsInterface<0> for FuncOp

Source§

impl StructuralPartialEq for FuncOp

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.