Halide::Internal::Closure Class Reference

A helper class to manage closures. More...

#include <Closure.h>

Inherits Halide::Internal::IRVisitor.

Inherited by Halide::Internal::HostClosure.

Classes
struct	Buffer
	Information about a buffer reference from a closure. More...

Public Member Functions
	Closure ()=default
	Closure (const Closure &)=delete
Closure &	operator= (const Closure &)=delete
	Closure (Closure &&)=default
Closure &	operator= (Closure &&)=default
void	include (const Stmt &s, const std::string &loop_variable="")
	Traverse a statement and find all references to external symbols. More...
Expr	pack_into_struct () const
	Pack a closure into a struct. More...
Stmt	unpack_from_struct (const Expr &, const Stmt &) const
	Unpack a closure around a Stmt, putting all the names in scope. More...
Public Member Functions inherited from Halide::Internal::IRVisitor
	IRVisitor ()=default
virtual	~IRVisitor ()=default

Public Attributes
std::map< std::string, Type >	vars
	External variables referenced. More...
std::map< std::string, Buffer >	buffers
	External allocations referenced. More...

Protected Member Functions
void	visit (const Let *op) override
void	visit (const LetStmt *op) override
void	visit (const For *op) override
void	visit (const Load *op) override
void	visit (const Store *op) override
void	visit (const Allocate *op) override
void	visit (const Variable *op) override
void	visit (const Atomic *op) override
void	found_buffer_ref (const std::string &name, Type type, bool read, bool written, const Halide::Buffer<> &image)
virtual void	visit (const IntImm *)
virtual void	visit (const UIntImm *)
virtual void	visit (const FloatImm *)
virtual void	visit (const StringImm *)
virtual void	visit (const Cast *)
virtual void	visit (const Reinterpret *)
virtual void	visit (const Variable *)
virtual void	visit (const Add *)
virtual void	visit (const Sub *)
virtual void	visit (const Mul *)
virtual void	visit (const Div *)
virtual void	visit (const Mod *)
virtual void	visit (const Min *)
virtual void	visit (const Max *)
virtual void	visit (const EQ *)
virtual void	visit (const NE *)
virtual void	visit (const LT *)
virtual void	visit (const LE *)
virtual void	visit (const GT *)
virtual void	visit (const GE *)
virtual void	visit (const And *)
virtual void	visit (const Or *)
virtual void	visit (const Not *)
virtual void	visit (const Select *)
virtual void	visit (const Load *)
virtual void	visit (const Ramp *)
virtual void	visit (const Broadcast *)
virtual void	visit (const Call *)
virtual void	visit (const Let *)
virtual void	visit (const LetStmt *)
virtual void	visit (const AssertStmt *)
virtual void	visit (const ProducerConsumer *)
virtual void	visit (const For *)
virtual void	visit (const Store *)
virtual void	visit (const Provide *)
virtual void	visit (const Allocate *)
virtual void	visit (const Free *)
virtual void	visit (const Realize *)
virtual void	visit (const Block *)
virtual void	visit (const IfThenElse *)
virtual void	visit (const Evaluate *)
virtual void	visit (const Shuffle *)
virtual void	visit (const VectorReduce *)
virtual void	visit (const Prefetch *)
virtual void	visit (const Fork *)
virtual void	visit (const Acquire *)
virtual void	visit (const Atomic *)
Protected Member Functions inherited from Halide::Internal::IRVisitor
virtual void	visit (const IntImm *)
virtual void	visit (const UIntImm *)
virtual void	visit (const FloatImm *)
virtual void	visit (const StringImm *)
virtual void	visit (const Cast *)
virtual void	visit (const Reinterpret *)
virtual void	visit (const Add *)
virtual void	visit (const Sub *)
virtual void	visit (const Mul *)
virtual void	visit (const Div *)
virtual void	visit (const Mod *)
virtual void	visit (const Min *)
virtual void	visit (const Max *)
virtual void	visit (const EQ *)
virtual void	visit (const NE *)
virtual void	visit (const LT *)
virtual void	visit (const LE *)
virtual void	visit (const GT *)
virtual void	visit (const GE *)
virtual void	visit (const And *)
virtual void	visit (const Or *)
virtual void	visit (const Not *)
virtual void	visit (const Select *)
virtual void	visit (const Ramp *)
virtual void	visit (const Broadcast *)
virtual void	visit (const Call *)
virtual void	visit (const AssertStmt *)
virtual void	visit (const ProducerConsumer *)
virtual void	visit (const Provide *)
virtual void	visit (const Free *)
virtual void	visit (const Realize *)
virtual void	visit (const Block *)
virtual void	visit (const IfThenElse *)
virtual void	visit (const Evaluate *)
virtual void	visit (const Shuffle *)
virtual void	visit (const VectorReduce *)
virtual void	visit (const Prefetch *)
virtual void	visit (const Fork *)
virtual void	visit (const Acquire *)

Protected Attributes
Scope	ignore

Detailed Description

A helper class to manage closures.

Walks over a statement and retrieves all the references within it to external symbols (variables and allocations). It then helps you build a struct containing the current values of these symbols that you can use as a closure if you want to migrate the body of the statement to its own function (e.g. because it's the body of a parallel for loop.

Definition at line 26 of file Closure.h.

Constructor & Destructor Documentation

Closure() [1/3]

Halide::Internal::Closure::Closure ( )

default

Closure() [2/3]

Halide::Internal::Closure::Closure ( const Closure &  )

delete

Closure() [3/3]

Halide::Internal::Closure::Closure ( Closure &&  )

default

Member Function Documentation

visit() [1/55]

void Halide::Internal::Closure::visit ( const Let *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [2/55]

void Halide::Internal::Closure::visit ( const LetStmt *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [3/55]

void Halide::Internal::Closure::visit ( const For *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

Reimplemented in Halide::Internal::HostClosure.

visit() [4/55]

void Halide::Internal::Closure::visit ( const Load *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [5/55]

void Halide::Internal::Closure::visit ( const Store *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [6/55]

void Halide::Internal::Closure::visit ( const Allocate *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [7/55]

void Halide::Internal::Closure::visit ( const Variable *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

visit() [8/55]

void Halide::Internal::Closure::visit ( const Atomic *  op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::IRVisitor.

found_buffer_ref()

void Halide::Internal::Closure::found_buffer_ref ( const std::string &  name, Type  type, bool  read, bool  written, const Halide::Buffer<> &  image  )

protected

operator=() [1/2]

Closure& Halide::Internal::Closure::operator= ( const Closure &  )

delete

operator=() [2/2]

Closure& Halide::Internal::Closure::operator= ( Closure &&  )

default

include()

void Halide::Internal::Closure::include	(	const Stmt &	s,
		const std::string &	loop_variable = ""
	)

Traverse a statement and find all references to external symbols.

When the closure encounters a read or write to 'foo', it assumes that the host pointer is found in the symbol table as 'foo.host', and any halide_buffer_t pointer is found under 'foo.buffer'.

Calling this multiple times (on multiple statements) is legal (and will produce a unified closure).

pack_into_struct()

Expr Halide::Internal::Closure::pack_into_struct

(

)

const

Pack a closure into a struct.

unpack_from_struct()

Stmt Halide::Internal::Closure::unpack_from_struct	(	const Expr &	,
		const Stmt &
	)		const

Unpack a closure around a Stmt, putting all the names in scope.

visit() [9/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [10/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [11/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [12/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [13/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [14/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [15/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [16/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [17/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [18/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [19/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [20/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [21/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [22/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [23/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [24/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [25/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [26/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [27/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [28/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [29/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [30/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [31/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [32/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [33/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [34/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [35/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [36/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [37/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [38/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [39/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [40/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [41/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [42/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [43/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [44/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [45/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [46/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [47/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [48/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [49/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [50/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [51/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [52/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [53/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [54/55]

virtual void Halide::Internal::IRVisitor::visit

protected

visit() [55/55]

virtual void Halide::Internal::IRVisitor::visit

protected

Member Data Documentation

ignore

Scope Halide::Internal::Closure::ignore

protected

Definition at line 28 of file Closure.h.

vars

std::map<std::string, Type> Halide::Internal::Closure::vars

External variables referenced.

There's code that assumes iterating over this repeatedly gives a consistent order, so don't swap out the data type for something non-deterministic.

Definition at line 94 of file Closure.h.

buffers

std::map<std::string, Buffer> Halide::Internal::Closure::buffers

External allocations referenced.

Definition at line 97 of file Closure.h.

---

The documentation for this class was generated from the following file:

• src/Closure.h