A base class for GPU backends that require C-like shader output. More...

#include <CodeGen_GPU_Dev.h>

Inheritance diagram for Halide::Internal::CodeGen_GPU_C:

Public Types
enum class	VectorDeclarationStyle { CLikeSyntax = 0 , OpenCLSyntax = 1 , WGSLSyntax = 2 }
	OpenCL and WGSL use different syntax than C for immediate vectors. More...

Public Types inherited from Halide::Internal::CodeGen_C
enum	OutputKind { CHeader , CPlusPlusHeader , CImplementation , CPlusPlusImplementation , CExternDecl , CPlusPlusExternDecl , CPlusPlusFunctionInfoHeader }

Public Member Functions
	CodeGen_GPU_C (std::ostream &s, Target t)

Public Member Functions inherited from Halide::Internal::CodeGen_C
	CodeGen_C (std::ostream &dest, const Target &target, OutputKind output_kind=CImplementation, const std::string &include_guard="")
	Initialize a C code generator pointing at a particular output stream (e.g.

	~CodeGen_C () override

void	compile (const Module &module)
	Emit the declarations contained in the module as C code.

const Target &	get_target () const
	The target we're generating code for.

Public Member Functions inherited from Halide::Internal::IRPrinter
	IRPrinter (std::ostream &)
	Construct an IRPrinter pointed at a given output stream (e.g.

void	print (const Expr &)
	emit an expression on the output stream

void	print_no_parens (const Expr &)
	Emit an expression on the output stream without enclosing parens.

void	print (const Stmt &)
	emit a statement on the output stream

void	print_list (const std::vector< Expr > &exprs)
	emit a comma delimited list of exprs, without any leading or trailing punctuation.

Public Member Functions inherited from Halide::Internal::IRVisitor
	IRVisitor ()=default

virtual	~IRVisitor ()=default

Protected Member Functions
void	visit (const Shuffle *op) override

void	visit (const Call *op) override

void	visit (const Variable *) override

void	visit (const IntImm *) override

void	visit (const UIntImm *) override

void	visit (const StringImm *) override

void	visit (const FloatImm *) override

void	visit (const Cast *) override

void	visit (const Reinterpret *) override

void	visit (const Add *) override

void	visit (const Sub *) override

void	visit (const Mul *) override

void	visit (const Div *) override

void	visit (const Mod *) override

void	visit (const Max *) override

void	visit (const Min *) override

void	visit (const EQ *) override

void	visit (const NE *) override

void	visit (const LT *) override

void	visit (const LE *) override

void	visit (const GT *) override

void	visit (const GE *) override

void	visit (const And *) override

void	visit (const Or *) override

void	visit (const Not *) override

void	visit (const Select *) override

void	visit (const Load *) override

void	visit (const Store *) override

void	visit (const Let *) override

void	visit (const LetStmt *) override

void	visit (const AssertStmt *) override

void	visit (const ProducerConsumer *) override

void	visit (const For *) override

void	visit (const Ramp *) override

void	visit (const Broadcast *) override

void	visit (const Provide *) override

void	visit (const Allocate *) override

void	visit (const Free *) override

void	visit (const Realize *) override

void	visit (const IfThenElse *) override

void	visit (const Evaluate *) override

void	visit (const Prefetch *) override

void	visit (const Fork *) override

void	visit (const Acquire *) override

void	visit (const Atomic *) override

void	visit (const VectorReduce *) override

void	visit (const Block *) override

void	visit (const HoistedStorage *) override

Protected Member Functions inherited from Halide::Internal::CodeGen_C
void	compile (const LoweredFunc &func, const MetadataNameMap &metadata_name_map)
	Emit a declaration.

void	compile (const Buffer<> &buffer)

virtual Stmt	preprocess_function_body (const Stmt &stmt)
	This is a hook that subclasses can use to transform a function body just before it is emitted – e.g., to transform the IR to code that is easier to recognize and emit.

std::string	print_expr (const Expr &)
	Emit an expression as an assignment, then return the id of the resulting var.

std::string	print_cast_expr (const Type &, const Expr &)
	Like print_expr, but cast the Expr to the given Type.

void	print_stmt (const Stmt &)
	Emit a statement.

void	create_assertion (const std::string &id_cond, const Expr &message)

void	create_assertion (const Expr &cond, const Expr &message)

Expr	scalarize_vector_reduce (const VectorReduce *op)

virtual std::string	print_type (Type, AppendSpaceIfNeeded space_option=DoNotAppendSpace)
	Emit the C name for a halide type.

virtual std::string	print_reinterpret (Type, const Expr &)
	Emit a statement to reinterpret an expression as another type.

virtual std::string	print_name (const std::string &)
	Emit a version of a string that is a valid identifier in C (.

virtual void	add_platform_prologue ()
	Add platform specific prologue.

virtual void	add_vector_typedefs (const std::set< Type > &vector_types)
	Add typedefs for vector types.

virtual std::string	print_extern_call (const Call *op)
	Bottleneck to allow customization of calls to generic Extern/PureExtern calls.

std::string	print_scalarized_expr (const Expr &e)
	Convert a vector Expr into a series of scalar Exprs, then reassemble into vector of original type.

virtual std::string	print_assignment (Type t, const std::string &rhs)
	Emit an SSA-style assignment, and set id to the freshly generated name.

void	print_heap_free (const std::string &alloc_name)
	Emit free for the heap allocation.

bool	is_header ()
	Return true if only generating an interface, which may be extern "C" or C++.

bool	is_extern_decl ()
	Return true if only generating an interface, which may be extern "C" or C++.

bool	is_header_or_extern_decl ()
	Return true if only generating an interface, which may be extern "C" or C++.

bool	is_c_plus_plus_interface ()
	Return true if generating C++ linkage.

void	open_scope ()
	Open a new C scope (i.e.

void	close_scope (const std::string &comment)
	Close a C scope (i.e.

void	forward_declare_type_if_needed (const Type &t)
	If the Type is a handle type, emit a forward-declaration for it if we haven't already.

void	set_name_mangling_mode (NameMangling mode)

void	visit_binop (Type t, const Expr &a, const Expr &b, const char *op)

void	visit_relop (Type t, const Expr &a, const Expr &b, const char scalar_op, const char vector_op)

virtual bool	is_stack_private_to_thread () const
	Some architectures have private memory for the call stack; this means a thread cannot hand pointers to stack memory to another thread.

void	emit_argv_wrapper (const std::string &function_name, const std::vector< LoweredArgument > &args)

void	emit_metadata_getter (const std::string &function_name, const std::vector< LoweredArgument > &args, const MetadataNameMap &metadata_name_map)

void	emit_constexpr_function_info (const std::string &function_name, const std::vector< LoweredArgument > &args, const MetadataNameMap &metadata_name_map)

void	emit_halide_free_helper (const std::string &alloc_name, const std::string &free_function)

Protected Member Functions inherited from Halide::Internal::IRPrinter
Indentation	get_indent () const

void	open ()
	Either emits "(" or "", depending on the value of implicit_parens.

void	close ()
	Either emits ")" or "", depending on the value of implicit_parens.

void	print_lets (const Let *let)
	A helper for printing a chain of lets with line breaks.

void	visit (const IntImm *) override

void	visit (const UIntImm *) override

void	visit (const FloatImm *) override

void	visit (const StringImm *) override

void	visit (const Cast *) override

void	visit (const Reinterpret *) override

void	visit (const Variable *) override

void	visit (const Add *) override

void	visit (const Sub *) override

void	visit (const Mul *) override

void	visit (const Div *) override

void	visit (const Mod *) override

void	visit (const Min *) override

void	visit (const Max *) override

void	visit (const EQ *) override

void	visit (const NE *) override

void	visit (const LT *) override

void	visit (const LE *) override

void	visit (const GT *) override

void	visit (const GE *) override

void	visit (const And *) override

void	visit (const Or *) override

void	visit (const Not *) override

void	visit (const Select *) override

void	visit (const Load *) override

void	visit (const Ramp *) override

void	visit (const Broadcast *) override

void	visit (const Call *) override

void	visit (const Let *) override

void	visit (const LetStmt *) override

void	visit (const AssertStmt *) override

void	visit (const ProducerConsumer *) override

void	visit (const For *) override

void	visit (const Acquire *) override

void	visit (const Store *) override

void	visit (const Provide *) override

void	visit (const Allocate *) override

void	visit (const Free *) override

void	visit (const Realize *) override

void	visit (const Block *) override

void	visit (const Fork *) override

void	visit (const IfThenElse *) override

void	visit (const Evaluate *) override

void	visit (const Shuffle *) override

void	visit (const VectorReduce *) override

void	visit (const Prefetch *) override

void	visit (const Atomic *) override

void	visit (const HoistedStorage *) override

Protected Member Functions inherited from Halide::Internal::IRVisitor

Protected Attributes
VectorDeclarationStyle	vector_declaration_style = VectorDeclarationStyle::CLikeSyntax

Protected Attributes inherited from Halide::Internal::CodeGen_C
IntegerSuffixStyle	integer_suffix_style = IntegerSuffixStyle::PlainC
	How to emit 64-bit integer constants.

std::string	id
	An ID for the most recently generated ssa variable.

Target	target
	The target being generated for.

OutputKind	output_kind
	Controls whether this instance is generating declarations or definitions and whether the interface us extern "C" or C++.

std::map< std::string, std::string >	cache
	A cache of generated values in scope.

Scope< Allocation >	allocations
	Track the types of allocations to avoid unnecessary casts.

Scope	heap_allocations
	Track which allocations actually went on the heap.

bool	have_user_context
	True if there is a void * __user_context parameter in the arguments.

bool	extern_c_open = false
	Track current calling convention scope.

bool	uses_gpu_for_loops
	True if at least one gpu-based for loop is used.

std::set< const halide_handle_cplusplus_type * >	forward_declared
	Track which handle types have been forward-declared already.

bool	inside_atomic_mutex_node = false
	Are we inside an atomic node that uses mutex locks? This is used for detecting deadlocks from nested atomics.

bool	emit_atomic_stores = false
	Emit atomic store instructions?

bool	using_vector_typedefs = false
	true if add_vector_typedefs() has been called.

Protected Attributes inherited from Halide::Internal::IRPrinter
std::ostream &	stream
	The stream on which we're outputting.

int	indent = 0
	The current indentation level, useful for pretty-printing statements.

bool	implicit_parens = false
	Certain expressions do not need parens around them, e.g.

Scope	known_type
	The symbols whose types can be inferred from values printed already.

Additional Inherited Members
Static Public Member Functions inherited from Halide::Internal::CodeGen_C
static void	test ()

Static Public Member Functions inherited from Halide::Internal::IRPrinter
static void	test ()

Protected Types inherited from Halide::Internal::CodeGen_C
enum class	IntegerSuffixStyle { PlainC = 0 , OpenCL = 1 , HLSL = 2 }

enum	AppendSpaceIfNeeded { DoNotAppendSpace , AppendSpace }

Static Protected Member Functions inherited from Halide::Internal::CodeGen_C
template<typename T >
static std::string	with_sep (const std::vector< T > &v, const std::string &sep)

template<typename T >
static std::string	with_commas (const std::vector< T > &v)

Detailed Description

A base class for GPU backends that require C-like shader output.

GPU backends derive from and specialize this class.

Definition at line 84 of file CodeGen_GPU_Dev.h.

Member Enumeration Documentation

◆ VectorDeclarationStyle

enum class Halide::Internal::CodeGen_GPU_C::VectorDeclarationStyle

strong

OpenCL and WGSL use different syntax than C for immediate vectors.

This enum defines which style should be used by the backend.

Enumerator
CLikeSyntax
OpenCLSyntax
WGSLSyntax

Definition at line 88 of file CodeGen_GPU_Dev.h.

Constructor & Destructor Documentation

◆ CodeGen_GPU_C()

Halide::Internal::CodeGen_GPU_C::CodeGen_GPU_C	(	std::ostream &	s,
		Target	t )

inline

Definition at line 94 of file CodeGen_GPU_Dev.h.

Member Function Documentation

◆ visit() [1/48]

void Halide::Internal::CodeGen_GPU_C::visit ( const Shuffle * op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [2/48]

void Halide::Internal::CodeGen_GPU_C::visit ( const Call * op )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [3/48]

void Halide::Internal::CodeGen_C::visit ( const Variable * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [4/48]

void Halide::Internal::CodeGen_C::visit ( const IntImm * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [5/48]

void Halide::Internal::CodeGen_C::visit ( const UIntImm * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [6/48]

void Halide::Internal::CodeGen_C::visit ( const StringImm * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [7/48]

void Halide::Internal::CodeGen_C::visit ( const FloatImm * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [8/48]

void Halide::Internal::CodeGen_C::visit ( const Cast * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [9/48]

void Halide::Internal::CodeGen_C::visit ( const Reinterpret * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [10/48]

void Halide::Internal::CodeGen_C::visit ( const Add * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [11/48]

void Halide::Internal::CodeGen_C::visit ( const Sub * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [12/48]

void Halide::Internal::CodeGen_C::visit ( const Mul * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [13/48]

void Halide::Internal::CodeGen_C::visit ( const Div * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [14/48]

void Halide::Internal::CodeGen_C::visit ( const Mod * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [15/48]

void Halide::Internal::CodeGen_C::visit ( const Max * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [16/48]

void Halide::Internal::CodeGen_C::visit ( const Min * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [17/48]

void Halide::Internal::CodeGen_C::visit ( const EQ * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [18/48]

void Halide::Internal::CodeGen_C::visit ( const NE * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [19/48]

void Halide::Internal::CodeGen_C::visit ( const LT * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [20/48]

void Halide::Internal::CodeGen_C::visit ( const LE * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [21/48]

void Halide::Internal::CodeGen_C::visit ( const GT * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [22/48]

void Halide::Internal::CodeGen_C::visit ( const GE * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [23/48]

void Halide::Internal::CodeGen_C::visit ( const And * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [24/48]

void Halide::Internal::CodeGen_C::visit ( const Or * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [25/48]

void Halide::Internal::CodeGen_C::visit ( const Not * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [26/48]

void Halide::Internal::CodeGen_C::visit ( const Select * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [27/48]

void Halide::Internal::CodeGen_C::visit ( const Load * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [28/48]

void Halide::Internal::CodeGen_C::visit ( const Store * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [29/48]

void Halide::Internal::CodeGen_C::visit ( const Let * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [30/48]

void Halide::Internal::CodeGen_C::visit ( const LetStmt * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [31/48]

void Halide::Internal::CodeGen_C::visit ( const AssertStmt * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [32/48]

void Halide::Internal::CodeGen_C::visit ( const ProducerConsumer * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [33/48]

void Halide::Internal::CodeGen_C::visit ( const For * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [34/48]

void Halide::Internal::CodeGen_C::visit ( const Ramp * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [35/48]

void Halide::Internal::CodeGen_C::visit ( const Broadcast * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [36/48]

void Halide::Internal::CodeGen_C::visit ( const Provide * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [37/48]

void Halide::Internal::CodeGen_C::visit ( const Allocate * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [38/48]

void Halide::Internal::CodeGen_C::visit ( const Free * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [39/48]

void Halide::Internal::CodeGen_C::visit ( const Realize * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [40/48]

void Halide::Internal::CodeGen_C::visit ( const IfThenElse * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [41/48]

void Halide::Internal::CodeGen_C::visit ( const Evaluate * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [42/48]

void Halide::Internal::CodeGen_C::visit ( const Prefetch * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [43/48]

void Halide::Internal::CodeGen_C::visit ( const Fork * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [44/48]

void Halide::Internal::CodeGen_C::visit ( const Acquire * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [45/48]

void Halide::Internal::CodeGen_C::visit ( const Atomic * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [46/48]

void Halide::Internal::CodeGen_C::visit ( const VectorReduce * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [47/48]

void Halide::Internal::IRPrinter::visit ( const Block * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

◆ visit() [48/48]

void Halide::Internal::IRPrinter::visit ( const HoistedStorage * )

overrideprotectedvirtual

Reimplemented from Halide::Internal::CodeGen_C.

Member Data Documentation

◆ vector_declaration_style

VectorDeclarationStyle Halide::Internal::CodeGen_GPU_C::vector_declaration_style = VectorDeclarationStyle::CLikeSyntax

protected

Definition at line 103 of file CodeGen_GPU_Dev.h.

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

src/CodeGen_GPU_Dev.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ VectorDeclarationStyle

Constructor & Destructor Documentation

◆ CodeGen_GPU_C()

Member Function Documentation

◆ visit() [1/48]

◆ visit() [2/48]

◆ visit() [3/48]

◆ visit() [4/48]

◆ visit() [5/48]

◆ visit() [6/48]

◆ visit() [7/48]

◆ visit() [8/48]

◆ visit() [9/48]

◆ visit() [10/48]

◆ visit() [11/48]

◆ visit() [12/48]

◆ visit() [13/48]

◆ visit() [14/48]

◆ visit() [15/48]

◆ visit() [16/48]

◆ visit() [17/48]

◆ visit() [18/48]

◆ visit() [19/48]

◆ visit() [20/48]

◆ visit() [21/48]

◆ visit() [22/48]

◆ visit() [23/48]

◆ visit() [24/48]

◆ visit() [25/48]

◆ visit() [26/48]

◆ visit() [27/48]

◆ visit() [28/48]

◆ visit() [29/48]

◆ visit() [30/48]

◆ visit() [31/48]

◆ visit() [32/48]

◆ visit() [33/48]

◆ visit() [34/48]

◆ visit() [35/48]

◆ visit() [36/48]

◆ visit() [37/48]

◆ visit() [38/48]

◆ visit() [39/48]

◆ visit() [40/48]

◆ visit() [41/48]

◆ visit() [42/48]

◆ visit() [43/48]

◆ visit() [44/48]

◆ visit() [45/48]

◆ visit() [46/48]

◆ visit() [47/48]

◆ visit() [48/48]

Member Data Documentation

◆ vector_declaration_style