Halide 22.0.0 Halide compiler and libraries

Module.h
Go to the documentation of this file.
1#ifndef HALIDE_MODULE_H
2#define HALIDE_MODULE_H
3
4/** \file
5 *
6 * Defines Module, an IR container that fully describes a Halide program.
7 */
8
9#include <functional>
10#include <map>
11#include <memory>
12#include <string>
13
14#include "Argument.h"
15#include "Expr.h"
16#include "Function.h" // for NameMangling
17#include "ModulusRemainder.h"
18
19 namespace Halide {
20
21 template<typename T, int Dims>
22 class Buffer;
23 struct Target;
24
25/** Enums specifying various kinds of outputs that can be produced from a Halide Pipeline. */
26 enum class OutputFileType {
27 assembly,
28 bitcode,
29 c_header,
30 c_source,
31 compiler_log,
32 cpp_stub,
33 featurization,
34 function_info_header,
35 hlpipe,
36 llvm_assembly,
37 object,
38 python_extension,
39 pytorch_wrapper,
40 registration,
41 schedule,
42 static_library,
43 stmt,
44 conceptual_stmt,
45 stmt_html,
46 conceptual_stmt_html,
47 device_code,
48};
49
50/** Type of linkage a function in a lowered Halide module can have.
51 Also controls whether auxiliary functions and metadata are generated. */
52 enum class LinkageType {
53 External, ///< Visible externally.
54 ExternalPlusMetadata, ///< Visible externally. Argument metadata and an argv wrapper are also generated.
55 ExternalPlusArgv, ///< Visible externally. Argv wrapper is generated but *not* argument metadata.
56 Internal, ///< Not visible externally, similar to 'static' linkage in C.
57};
58
59 namespace Internal {
60
61 struct OutputInfo {
62 std::string name, extension;
63
64 // `is_multi` indicates how these outputs are generated
65 // when using the compile_to_multitarget_xxx() APIs (or via the
66 // Generator command-line mode):
67 //
68 // - If `is_multi` is true, then a separate file of this Output type is
69 // generated for each target in the multitarget (e.g. object files,
70 // assembly files, etc). Each of the files will have a suffix appended
71 // that is based on the specific subtarget.
72 //
73 // - If `is_multi` is false, then only one file of this Output type
74 // regardless of how many targets are in the multitarget. No additional
75 // suffix will be appended to the filename.
76 //
77 bool is_multi{false};
78};
79std::map<OutputFileType, const OutputInfo> get_output_info(const Target &target);
80
81/** Definition of an argument to a LoweredFunc. This is similar to
82 * Argument, except it enables passing extra information useful to
83 * some targets to LoweredFunc. */
84 struct LoweredArgument : public Argument {
85 /** For scalar arguments, the modulus and remainder of this
86 * argument. */
87 ModulusRemainder alignment;
88
89 LoweredArgument() = default;
90 explicit LoweredArgument(const Argument &arg)
91 : Argument(arg) {
92 }
93 LoweredArgument(const std::string &_name, Kind _kind, const Type &_type, uint8_t _dimensions, const ArgumentEstimates &argument_estimates)
94 : Argument(_name, _kind, _type, _dimensions, argument_estimates) {
95 }
96};
97
98/** Definition of a lowered function. This object provides a concrete
99 * mapping between parameters used in the function body and their
100 * declarations in the argument list. */
101 struct LoweredFunc {
102 std::string name;
103
104 /** Arguments referred to in the body of this function. */
105 std::vector<LoweredArgument> args;
106
107 /** Body of this function. */
108 Stmt body;
109
110 /** The linkage of this function. */
111 LinkageType linkage;
112
113 /** The name-mangling choice for the function. Defaults to using
114 * the Target. */
115 NameMangling name_mangling;
116
117 LoweredFunc(const std::string &name,
118 const std::vector<LoweredArgument> &args,
119 Stmt body,
120 LinkageType linkage,
121 NameMangling mangling = NameMangling::Default);
122 LoweredFunc(const std::string &name,
123 const std::vector<Argument> &args,
124 Stmt body,
125 LinkageType linkage,
126 NameMangling mangling = NameMangling::Default);
127};
128
129} // namespace Internal
130
131 namespace Internal {
132 struct ModuleContents;
133 class CompilerLogger;
134} // namespace Internal
135
136 struct AutoSchedulerResults;
137
138 using MetadataNameMap = std::map<std::string, std::string>;
139
140/** A halide module. This represents IR containing lowered function
141 * definitions and buffers. */
142 class Module {
143 Internal::IntrusivePtr<Internal::ModuleContents> contents;
144
145 public:
146 Module(const std::string &name, const Target &target, const MetadataNameMap &metadata_name_map = {});
147
148 /** Get the target this module has been lowered for. */
149 const Target &target() const;
150
151 /** The name of this module. This is used as the default filename
152 * for output operations. */
153 const std::string &name() const;
154
155 /** If this Module had an auto-generated schedule, return a read-only pointer
156 * to the AutoSchedulerResults. If not, return nullptr. */
157 const AutoSchedulerResults *get_auto_scheduler_results() const;
158
159 /** Return whether this module uses strict floating-point anywhere. */
160 bool any_strict_float() const;
161
162 /** The declarations contained in this module. */
163 // @{
164 const std::vector<Buffer<void>> &buffers() const;
165 const std::vector<Internal::LoweredFunc> &functions() const;
166 std::vector<Internal::LoweredFunc> &functions();
167 const std::vector<Module> &submodules() const;
168 // @}
169
170 /** Tries to locate the offloaded CUDA PTX assembly contained in this Module.
171 * Might return a nullptr in case such buffer is not present in this Module.
172 */
173 Buffer<> get_cuda_ptx_assembly_buffer() const;
174
175 /**
176 * Tries to locate the offloaded (GPU) Device assembly contained in this Module.
177 * This can be any of the GPU kernel sources, etc...
178 */
179 Buffer<> get_device_code_buffer() const;
180
181 /** Return the function with the given name. If no such function
182 * exists in this module, assert. */
183 Internal::LoweredFunc get_function_by_name(const std::string &name) const;
184
185 /** Add a declaration to this module. */
186 // @{
187 void append(const Buffer<void> &buffer);
188 void append(const Internal::LoweredFunc &function);
189 void append(const Module &module);
190 // @}
191
192 /** Compile a halide Module to variety of outputs, depending on
193 * the fields set in output_files. */
194 void compile(const std::map<OutputFileType, std::string> &output_files) const;
195
196 /** Compile a halide Module to in-memory object code. Currently
197 * only supports LLVM based compilation, but should be extended to
198 * handle source code backends. */
199 Buffer<uint8_t> compile_to_buffer() const;
200
201 /** Return a new module with all submodules compiled to buffers on
202 * on the result Module. */
203 Module resolve_submodules() const;
204
205 /** When generating metadata from this module, remap any occurrences
206 * of 'from' into 'to'. */
207 void remap_metadata_name(const std::string &from, const std::string &to) const;
208
209 /** Retrieve the metadata name map. */
210 MetadataNameMap get_metadata_name_map() const;
211
212 /** Set the AutoSchedulerResults for the Module. It is an error to call this
213 * multiple times for a given Module. */
214 void set_auto_scheduler_results(const AutoSchedulerResults &results);
215
216 /** Set whether this module uses strict floating-point directives anywhere. */
217 void set_any_strict_float(bool any_strict_float);
218
219 /** Remember the Stmt during lowing before device-specific offloading. */
220 void set_conceptual_code_stmt(const Internal::Stmt &stmt);
221
222 /** Get the remembered conceptual Stmt, remembered before device-specific offloading. */
223 const Internal::Stmt &get_conceptual_stmt() const;
224};
225
226/** Link a set of modules together into one module. */
227 Module link_modules(const std::string &name, const std::vector<Module> &modules);
228
229/** Create an object file containing the Halide runtime for a given target. For
230 * use with Target::NoRuntime. Standalone runtimes are only compatible with
231 * pipelines compiled by the same build of Halide used to call this function. */
232 void compile_standalone_runtime(const std::string &object_filename, const Target &t);
233
234/** Create an object and/or static library file containing the Halide runtime
235 * for a given target. For use with Target::NoRuntime. Standalone runtimes are
236 * only compatible with pipelines compiled by the same build of Halide used to
237 * call this function. Return a map with just the actual outputs filled in
238 * (typically, OutputFileType::object and/or OutputFileType::static_library).
239 */
240std::map<OutputFileType, std::string> compile_standalone_runtime(const std::map<OutputFileType, std::string> &output_files, const Target &t);
241
242 using ModuleFactory = std::function<Module(const std::string &fn_name, const Target &target)>;
243 using CompilerLoggerFactory = std::function<std::unique_ptr<Internal::CompilerLogger>(const std::string &fn_name, const Target &target)>;
244
245 void compile_multitarget(const std::string &fn_name,
246 const std::map<OutputFileType, std::string> &output_files,
247 const std::vector<Target> &targets,
248 const std::vector<std::string> &suffixes,
249 const ModuleFactory &module_factory,
250 const CompilerLoggerFactory &compiler_logger_factory = nullptr);
251
252} // namespace Halide
253
254#endif
Argument.h
Defines a type used for expressing the type signature of a generated halide pipeline.
Expr.h
Base classes for Halide expressions (Halide::Expr) and statements (Halide::Internal::Stmt)
Function.h
Defines the internal representation of a halide function and related classes.
ModulusRemainder.h
Routines for statically determining what expressions are divisible by.
Halide::Buffer<>
Halide::Module
A halide module.
Definition: Module.h:142
Halide::Module::append
void append(const Buffer< void > &buffer)
Add a declaration to this module.
Halide::Module::get_metadata_name_map
MetadataNameMap get_metadata_name_map() const
Retrieve the metadata name map.
Halide::Module::get_cuda_ptx_assembly_buffer
Buffer get_cuda_ptx_assembly_buffer() const
Tries to locate the offloaded CUDA PTX assembly contained in this Module.
Halide::Module::get_device_code_buffer
Buffer get_device_code_buffer() const
Tries to locate the offloaded (GPU) Device assembly contained in this Module.
Halide::Module::set_conceptual_code_stmt
void set_conceptual_code_stmt(const Internal::Stmt &stmt)
Remember the Stmt during lowing before device-specific offloading.
Halide::Module::name
const std::string & name() const
The name of this module.
Halide::Module::compile_to_buffer
Buffer< uint8_t > compile_to_buffer() const
Compile a halide Module to in-memory object code.
Halide::Module::set_auto_scheduler_results
void set_auto_scheduler_results(const AutoSchedulerResults &results)
Set the AutoSchedulerResults for the Module.
Halide::Module::resolve_submodules
Module resolve_submodules() const
Return a new module with all submodules compiled to buffers on on the result Module.
Halide::Module::remap_metadata_name
void remap_metadata_name(const std::string &from, const std::string &to) const
When generating metadata from this module, remap any occurrences of 'from' into 'to'.
Halide::Module::get_auto_scheduler_results
const AutoSchedulerResults * get_auto_scheduler_results() const
If this Module had an auto-generated schedule, return a read-only pointer to the AutoSchedulerResults...
Halide::Module::buffers
const std::vector< Buffer< void > > & buffers() const
The declarations contained in this module.
Halide::Module::functions
const std::vector< Internal::LoweredFunc > & functions() const
Halide::Module::compile
void compile(const std::map< OutputFileType, std::string > &output_files) const
Compile a halide Module to variety of outputs, depending on the fields set in output_files.
Halide::Module::Module
Module(const std::string &name, const Target &target, const MetadataNameMap &metadata_name_map={})
Halide::Module::target
const Target & target() const
Get the target this module has been lowered for.
Halide::Module::get_function_by_name
Internal::LoweredFunc get_function_by_name(const std::string &name) const
Return the function with the given name.
Halide::Module::submodules
const std::vector< Module > & submodules() const
Halide::Module::append
void append(const Module &module)
Halide::Module::set_any_strict_float
void set_any_strict_float(bool any_strict_float)
Set whether this module uses strict floating-point directives anywhere.
Halide::Module::any_strict_float
bool any_strict_float() const
Return whether this module uses strict floating-point anywhere.
Halide::Module::append
void append(const Internal::LoweredFunc &function)
Halide::Module::get_conceptual_stmt
const Internal::Stmt & get_conceptual_stmt() const
Get the remembered conceptual Stmt, remembered before device-specific offloading.
Halide::Module::functions
std::vector< Internal::LoweredFunc > & functions()
Halide::Internal::ArgInfoKind::Buffer
@ Buffer
Halide::Internal::get_output_info
std::map< OutputFileType, const OutputInfo > get_output_info(const Target &target)
Halide
This file defines the class FunctionDAG, which is our representation of a Halide pipeline,...
Definition: AbstractGenerator.h:19
Halide::LinkageType
LinkageType
Type of linkage a function in a lowered Halide module can have.
Definition: Module.h:52
Halide::LinkageType::ExternalPlusMetadata
@ ExternalPlusMetadata
Visible externally. Argument metadata and an argv wrapper are also generated.
Halide::LinkageType::ExternalPlusArgv
@ ExternalPlusArgv
Visible externally. Argv wrapper is generated but not argument metadata.
Halide::LinkageType::Internal
@ Internal
Not visible externally, similar to 'static' linkage in C.
Halide::LinkageType::External
@ External
Visible externally.
Halide::MetadataNameMap
std::map< std::string, std::string > MetadataNameMap
Definition: Module.h:138
Halide::CompilerLoggerFactory
std::function< std::unique_ptr< Internal::CompilerLogger >(const std::string &fn_name, const Target &target)> CompilerLoggerFactory
Definition: Module.h:243
Halide::OutputFileType
OutputFileType
Enums specifying various kinds of outputs that can be produced from a Halide Pipeline.
Definition: Module.h:26
Halide::OutputFileType::c_source
@ c_source
Halide::OutputFileType::bitcode
@ bitcode
Halide::OutputFileType::assembly
@ assembly
Halide::OutputFileType::compiler_log
@ compiler_log
Halide::OutputFileType::static_library
@ static_library
Halide::OutputFileType::stmt
@ stmt
Halide::OutputFileType::c_header
@ c_header
Halide::OutputFileType::conceptual_stmt
@ conceptual_stmt
Halide::OutputFileType::registration
@ registration
Halide::OutputFileType::llvm_assembly
@ llvm_assembly
Halide::OutputFileType::hlpipe
@ hlpipe
Halide::OutputFileType::cpp_stub
@ cpp_stub
Halide::OutputFileType::device_code
@ device_code
Halide::OutputFileType::featurization
@ featurization
Halide::OutputFileType::schedule
@ schedule
Halide::OutputFileType::stmt_html
@ stmt_html
Halide::OutputFileType::function_info_header
@ function_info_header
Halide::OutputFileType::object
@ object
Halide::OutputFileType::python_extension
@ python_extension
Halide::OutputFileType::conceptual_stmt_html
@ conceptual_stmt_html
Halide::OutputFileType::pytorch_wrapper
@ pytorch_wrapper
Halide::NameMangling
NameMangling
An enum to specify calling convention for extern stages.
Definition: Function.h:26
Halide::NameMangling::Default
@ Default
Match whatever is specified in the Target.
Halide::compile_standalone_runtime
void compile_standalone_runtime(const std::string &object_filename, const Target &t)
Create an object file containing the Halide runtime for a given target.
Halide::compile_multitarget
void compile_multitarget(const std::string &fn_name, const std::map< OutputFileType, std::string > &output_files, const std::vector< Target > &targets, const std::vector< std::string > &suffixes, const ModuleFactory &module_factory, const CompilerLoggerFactory &compiler_logger_factory=nullptr)
Halide::link_modules
Module link_modules(const std::string &name, const std::vector< Module > &modules)
Link a set of modules together into one module.
Halide::ModuleFactory
std::function< Module(const std::string &fn_name, const Target &target)> ModuleFactory
Definition: Module.h:242
uint8_t
unsigned __INT8_TYPE__ uint8_t
Definition: runtime_internal.h:29
Halide::ArgumentEstimates
Definition: Argument.h:18
Halide::Argument
A struct representing an argument to a halide-generated function.
Definition: Argument.h:37
Halide::Argument::Kind
Kind
An argument is either a primitive type (for parameters), or a buffer pointer.
Definition: Argument.h:52
Halide::Argument::argument_estimates
ArgumentEstimates argument_estimates
Definition: Argument.h:72
Halide::AutoSchedulerResults
Definition: Pipeline.h:94
Halide::Internal::IntrusivePtr< Internal::ModuleContents >
Halide::Internal::LoweredArgument
Definition of an argument to a LoweredFunc.
Definition: Module.h:84
Halide::Internal::LoweredArgument::alignment
ModulusRemainder alignment
For scalar arguments, the modulus and remainder of this argument.
Definition: Module.h:87
Halide::Internal::LoweredArgument::LoweredArgument
LoweredArgument(const Argument &arg)
Definition: Module.h:90
Halide::Internal::LoweredArgument::LoweredArgument
LoweredArgument(const std::string &_name, Kind _kind, const Type &_type, uint8_t _dimensions, const ArgumentEstimates &argument_estimates)
Definition: Module.h:93
Halide::Internal::LoweredArgument::LoweredArgument
LoweredArgument()=default
Halide::Internal::LoweredFunc
Definition of a lowered function.
Definition: Module.h:101
Halide::Internal::LoweredFunc::LoweredFunc
LoweredFunc(const std::string &name, const std::vector< LoweredArgument > &args, Stmt body, LinkageType linkage, NameMangling mangling=NameMangling::Default)
Halide::Internal::LoweredFunc::args
std::vector< LoweredArgument > args
Arguments referred to in the body of this function.
Definition: Module.h:105
Halide::Internal::LoweredFunc::LoweredFunc
LoweredFunc(const std::string &name, const std::vector< Argument > &args, Stmt body, LinkageType linkage, NameMangling mangling=NameMangling::Default)
Halide::Internal::LoweredFunc::name_mangling
NameMangling name_mangling
The name-mangling choice for the function.
Definition: Module.h:115
Halide::Internal::LoweredFunc::linkage
LinkageType linkage
The linkage of this function.
Definition: Module.h:111
Halide::Internal::LoweredFunc::name
std::string name
Definition: Module.h:102
Halide::Internal::LoweredFunc::body
Stmt body
Body of this function.
Definition: Module.h:108
Halide::Internal::ModulusRemainder
The result of modulus_remainder analysis.
Definition: ModulusRemainder.h:33
Halide::Internal::OutputInfo
Definition: Module.h:61
Halide::Internal::OutputInfo::name
std::string name
Definition: Module.h:62
Halide::Internal::OutputInfo::is_multi
bool is_multi
Definition: Module.h:77
Halide::Internal::OutputInfo::extension
std::string extension
Definition: Module.h:62
Halide::Internal::Stmt
A reference-counted handle to a statement node.
Definition: Expr.h:427
Halide::Target
A struct representing a target machine and os to generate code for.
Definition: Target.h:19
Halide::Type
Types in the halide type system.
Definition: Type.h:283