Halide  12.0.1
Halide compiler and libraries
Target.h
Go to the documentation of this file.
1 #ifndef HALIDE_TARGET_H
2 #define HALIDE_TARGET_H
3 
4 /** \file
5  * Defines the structure that describes a Halide target.
6  */
7 
8 #include <bitset>
9 #include <cstdint>
10 #include <string>
11 
12 #include "DeviceAPI.h"
13 #include "Type.h"
14 #include "runtime/HalideRuntime.h"
15 
16 namespace Halide {
17 
18 /** A struct representing a target machine and os to generate code for. */
19 struct Target {
20  /** The operating system used by the target. Determines which
21  * system calls to generate.
22  * Corresponds to os_name_map in Target.cpp. */
23  enum OS {
24  OSUnknown = 0,
27  OSX,
29  IOS,
35 
36  /** The architecture used by the target. Determines the
37  * instruction set to use.
38  * Corresponds to arch_name_map in Target.cpp. */
39  enum Arch {
41  X86,
42  ARM,
47  RISCV
49 
50  /** The bit-width of the target machine. Must be 0 for unknown, or 32 or 64. */
51  int bits = 0;
52 
53  /** Optional features a target can have.
54  * Corresponds to feature_name_map in Target.cpp.
55  * See definitions in HalideRuntime.h for full information.
56  */
57  enum Feature {
133  };
134  Target() = default;
135  Target(OS o, Arch a, int b, const std::vector<Feature> &initial_features = std::vector<Feature>())
136  : os(o), arch(a), bits(b) {
137  for (const auto &f : initial_features) {
138  set_feature(f);
139  }
140  }
141 
142  /** Given a string of the form used in HL_TARGET
143  * (e.g. "x86-64-avx"), construct the Target it specifies. Note
144  * that this always starts with the result of get_host_target(),
145  * replacing only the parts found in the target string, so if you
146  * omit (say) an OS specification, the host OS will be used
147  * instead. An empty string is exactly equivalent to
148  * get_host_target().
149  *
150  * Invalid target strings will fail with a user_error.
151  */
152  // @{
153  explicit Target(const std::string &s);
154  explicit Target(const char *s);
155  // @}
156 
157  /** Check if a target string is valid. */
158  static bool validate_target_string(const std::string &s);
159 
160  /** Return true if any of the arch/bits/os fields are "unknown"/0;
161  return false otherwise. */
162  bool has_unknowns() const;
163 
164  void set_feature(Feature f, bool value = true);
165 
166  void set_features(const std::vector<Feature> &features_to_set, bool value = true);
167 
168  bool has_feature(Feature f) const;
169 
170  inline bool has_feature(halide_target_feature_t f) const {
171  return has_feature((Feature)f);
172  }
173 
174  bool features_any_of(const std::vector<Feature> &test_features) const;
175 
176  bool features_all_of(const std::vector<Feature> &test_features) const;
177 
178  /** Return a copy of the target with the given feature set.
179  * This is convenient when enabling certain features (e.g. NoBoundsQuery)
180  * in an initialization list, where the target to be mutated may be
181  * a const reference. */
183 
184  /** Return a copy of the target with the given feature cleared.
185  * This is convenient when disabling certain features (e.g. NoBoundsQuery)
186  * in an initialization list, where the target to be mutated may be
187  * a const reference. */
189 
190  /** Is a fully feature GPU compute runtime enabled? I.e. is
191  * Func::gpu_tile and similar going to work? Currently includes
192  * CUDA, OpenCL, Metal and D3D12Compute. We do not include OpenGL,
193  * because it is not capable of gpgpu, and is not scheduled via
194  * Func::gpu_tile.
195  * TODO: Should OpenGLCompute be included here? */
196  bool has_gpu_feature() const;
197 
198  /** Does this target allow using a certain type. Generally all
199  * types except 64-bit float and int/uint should be supported by
200  * all backends.
201  *
202  * It is likely better to call the version below which takes a DeviceAPI.
203  */
204  bool supports_type(const Type &t) const;
205 
206  /** Does this target allow using a certain type on a certain device.
207  * This is the prefered version of this routine.
208  */
209  bool supports_type(const Type &t, DeviceAPI device) const;
210 
211  /** Returns whether a particular device API can be used with this
212  * Target. */
214 
215  /** If this Target (including all Features) requires a specific DeviceAPI,
216  * return it. If it doesn't, return DeviceAPI::None. If the Target has
217  * features with multiple (different) DeviceAPI requirements, the result
218  * will be an arbitrary DeviceAPI. */
220 
221  bool operator==(const Target &other) const {
222  return os == other.os &&
223  arch == other.arch &&
224  bits == other.bits &&
225  features == other.features;
226  }
227 
228  bool operator!=(const Target &other) const {
229  return !(*this == other);
230  }
231 
232  /**
233  * Create a "greatest common denominator" runtime target that is compatible with
234  * both this target and \p other. Used by generators to conveniently select a suitable
235  * runtime when linking together multiple functions.
236  *
237  * @param other The other target from which we compute the gcd target.
238  * @param[out] result The gcd target if we return true, otherwise unmodified. Can be the same as *this.
239  * @return Whether it was possible to find a compatible target (true) or not.
240  */
241  bool get_runtime_compatible_target(const Target &other, Target &result);
242 
243  /** Convert the Target into a string form that can be reconstituted
244  * by merge_string(), which will always be of the form
245  *
246  * arch-bits-os-feature1-feature2...featureN.
247  *
248  * Note that is guaranteed that Target(t1.to_string()) == t1,
249  * but not that Target(s).to_string() == s (since there can be
250  * multiple strings that parse to the same Target)...
251  * *unless* t1 contains 'unknown' fields (in which case you'll get a string
252  * that can't be parsed, which is intentional).
253  */
254  std::string to_string() const;
255 
256  /** Given a data type, return an estimate of the "natural" vector size
257  * for that data type when compiling for this Target. */
258  int natural_vector_size(const Halide::Type &t) const;
259 
260  /** Given a data type, return an estimate of the "natural" vector size
261  * for that data type when compiling for this Target. */
262  template<typename data_t>
263  int natural_vector_size() const {
264  return natural_vector_size(type_of<data_t>());
265  }
266 
267  /** Return true iff 64 bits and has_feature(LargeBuffers). */
268  bool has_large_buffers() const {
269  return bits == 64 && has_feature(LargeBuffers);
270  }
271 
272  /** Return the maximum buffer size in bytes supported on this
273  * Target. This is 2^31 - 1 except on 64-bit targets when the LargeBuffers
274  * feature is enabled, which expands the maximum to 2^63 - 1. */
276  if (has_large_buffers()) {
277  return (((uint64_t)1) << 63) - 1;
278  } else {
279  return (((uint64_t)1) << 31) - 1;
280  }
281  }
282 
283  /** Get the minimum cuda capability found as an integer. Returns
284  * 20 (our minimum supported cuda compute capability) if no cuda
285  * features are set. */
287 
288  /** Was libHalide compiled with support for this target? */
289  bool supported() const;
290 
291  /** Return a bitset of the Featuress set in this Target (set = 1).
292  * Note that while this happens to be the current internal representation,
293  * that might not always be the case. */
294  const std::bitset<FeatureEnd> &get_features_bitset() const {
295  return features;
296  }
297 
298  /** Return the name corresponding to a given Feature, in the form
299  * used to construct Target strings (e.g., Feature::Debug is "debug" and not "Debug"). */
300  static std::string feature_to_name(Target::Feature feature);
301 
302  /** Return the feature corresponding to a given name, in the form
303  * used to construct Target strings (e.g., Feature::Debug is "debug" and not "Debug").
304  * If the string is not a known feature name, return FeatureEnd. */
305  static Target::Feature feature_from_name(const std::string &name);
306 
307 private:
308  /** A bitmask that stores the active features. */
309  std::bitset<FeatureEnd> features;
310 };
311 
312 /** Return the target corresponding to the host machine. */
314 
315 /** Return the target that Halide will use. If HL_TARGET is set it
316  * uses that. Otherwise calls \ref get_host_target */
318 
319 /** Return the target that Halide will use for jit-compilation. If
320  * HL_JIT_TARGET is set it uses that. Otherwise calls \ref
321  * get_host_target. Throws an error if the architecture, bit width,
322  * and OS of the target do not match the host target, so this is only
323  * useful for controlling the feature set. */
325 
326 /** Get the Target feature corresponding to a DeviceAPI. For device
327  * apis that do not correspond to any single target feature, returns
328  * Target::FeatureEnd */
330 
331 namespace Internal {
332 
333 void target_test();
334 }
335 
336 } // namespace Halide
337 
338 #endif
Defines DeviceAPI.
This file declares the routines used by Halide internally in its runtime.
halide_target_feature_t
Optional features a compilation Target can have.
@ halide_target_feature_large_buffers
Enable 64-bit buffer indexing to support buffers > 2GB. Ignored if bits != 64.
@ halide_target_feature_fma
Enable x86 FMA instruction.
@ halide_target_feature_wasm_bulk_memory
Enable +bulk-memory instructions for WebAssembly codegen.
@ halide_target_feature_tsan
Enable hooks for TSAN support.
@ halide_target_feature_msan
Enable hooks for MSAN support.
@ halide_target_feature_wasm_threads
Enable use of threads in WebAssembly codegen. Requires the use of a wasm runtime that provides pthrea...
@ halide_target_feature_trace_loads
Trace all loads done by the pipeline. Equivalent to calling Func::trace_loads on every non-inlined Fu...
@ halide_target_feature_enable_llvm_loop_opt
Enable loop vectorization + unrolling in LLVM. Overrides halide_target_feature_disable_llvm_loop_opt....
@ halide_target_feature_no_asserts
Disable all runtime checks, for slightly tighter code.
@ halide_target_feature_cl_doubles
Enable double support on OpenCL targets.
@ halide_target_feature_rvv
Enable RISCV "V" Vector Extension.
@ halide_target_feature_openglcompute
Enable OpenGL Compute runtime.
@ halide_target_feature_avx2
Use AVX 2 instructions. Only relevant on x86.
@ halide_target_feature_trace_realizations
Trace all realizations done by the pipeline. Equivalent to calling Func::trace_realizations on every ...
@ halide_target_feature_c_plus_plus_mangling
Generate C++ mangled names for result function, et al.
@ halide_target_feature_no_runtime
Do not include a copy of the Halide runtime in any generated object file or assembly.
@ halide_target_feature_hvx_v65
Enable Hexagon v65 architecture.
@ halide_target_feature_debug
Turn on debug info and output for runtime code.
@ halide_target_feature_embed_bitcode
Emulate clang -fembed-bitcode flag.
@ halide_target_feature_wasm_simd128
Enable +simd128 instructions for WebAssembly codegen.
@ halide_target_feature_end
A sentinel. Every target is considered to have this feature, and setting this feature does nothing.
@ halide_llvm_large_code_model
Use the LLVM large code model to compile.
@ halide_target_feature_soft_float_abi
Enable soft float ABI. This only enables the soft float ABI calling convention, which does not necess...
@ halide_target_feature_sve2
Enable ARM Scalable Vector Extensions v2.
@ halide_target_feature_disable_llvm_loop_opt
Disable loop vectorization + unrolling in LLVM. (Ignored for non-LLVM targets.)
@ halide_target_feature_d3d12compute
Enable Direct3D 12 Compute runtime.
@ halide_target_feature_matlab
Generate a mexFunction compatible with Matlab mex libraries. See tools/mex_halide....
@ halide_target_feature_avx512_skylake
Enable the AVX512 features supported by Skylake Xeon server processors. This adds AVX512-VL,...
@ halide_target_feature_avx512_cannonlake
Enable the AVX512 features expected to be supported by future Cannonlake processors....
@ halide_target_feature_metal
Enable the (Apple) Metal runtime.
@ halide_target_feature_hvx_128
Enable HVX 128 byte mode.
@ halide_target_feature_cuda_capability70
Enable CUDA compute capability 7.0 (Volta)
@ halide_target_feature_fma4
Enable x86 (AMD) FMA4 instruction set.
@ halide_target_feature_wasm_sat_float_to_int
Enable saturating (nontrapping) float-to-int instructions for WebAssembly codegen.
@ halide_target_feature_cuda_capability30
Enable CUDA compute capability 3.0 (Kepler)
@ halide_target_feature_no_neon
Avoid using NEON instructions. Only relevant for 32-bit ARM.
@ halide_target_feature_cuda_capability61
Enable CUDA compute capability 6.1 (Pascal)
@ halide_target_feature_armv7s
Generate code for ARMv7s. Only relevant for 32-bit ARM.
@ halide_target_feature_trace_pipeline
Trace the pipeline.
@ halide_target_feature_cl_atomic64
Enable 64-bit atomics operations on OpenCL targets.
@ halide_target_feature_egl
Force use of EGL support.
@ halide_target_feature_profile
Launch a sampling profiler alongside the Halide pipeline that monitors and reports the runtime used b...
@ halide_target_feature_strict_float
Turn off all non-IEEE floating-point optimization. Currently applies only to LLVM targets.
@ halide_target_feature_cuda_capability35
Enable CUDA compute capability 3.5 (Kepler)
@ halide_target_feature_asan
Enable hooks for ASAN support.
@ halide_target_feature_cl_half
Enable half support on OpenCL targets.
@ halide_target_feature_arm_dot_prod
Enable ARMv8.2-a dotprod extension (i.e. udot and sdot instructions)
@ halide_target_feature_avx512_sapphirerapids
Enable the AVX512 features supported by Sapphire Rapids processors. This include all of the Cannonlak...
@ halide_target_feature_sse41
Use SSE 4.1 and earlier instructions. Only relevant on x86.
@ halide_target_feature_power_arch_2_07
Use POWER ISA 2.07 new instructions. Only relevant on POWERPC.
@ halide_target_feature_opencl
Enable the OpenCL runtime.
@ halide_target_feature_trace_stores
Trace all stores done by the pipeline. Equivalent to calling Func::trace_stores on every non-inlined ...
@ halide_target_feature_hexagon_dma
Enable Hexagon DMA buffers.
@ halide_target_feature_avx512
Enable the base AVX512 subset supported by all AVX512 architectures. The specific feature sets are AV...
@ halide_target_feature_avx512_knl
Enable the AVX512 features supported by Knight's Landing chips, such as the Xeon Phi x200....
@ halide_target_feature_cuda_capability50
Enable CUDA compute capability 5.0 (Maxwell)
@ halide_target_feature_hvx_v62
Enable Hexagon v62 architecture.
@ halide_target_feature_hvx_use_shared_object
Deprecated.
@ halide_target_feature_cuda
Enable the CUDA runtime. Defaults to compute capability 2.0 (Fermi)
@ halide_target_feature_armv81a
Enable ARMv8.1-a instructions.
@ halide_target_feature_cuda_capability80
Enable CUDA compute capability 8.0 (Ampere)
@ halide_target_feature_f16c
Enable x86 16-bit float support.
@ halide_target_feature_cuda_capability32
Enable CUDA compute capability 3.2 (Tegra K1)
@ halide_target_feature_jit
Generate code that will run immediately inside the calling process.
@ halide_target_feature_wasm_signext
Enable +sign-ext instructions for WebAssembly codegen.
@ halide_target_feature_avx
Use AVX 1 instructions. Only relevant on x86.
@ halide_target_feature_cuda_capability75
Enable CUDA compute capability 7.5 (Turing)
@ halide_target_feature_check_unsafe_promises
Insert assertions for promises.
@ halide_target_feature_vsx
Use VSX instructions. Only relevant on POWERPC.
@ halide_target_feature_user_context
Generated code takes a user_context pointer as first argument.
@ halide_target_feature_no_bounds_query
Disable the bounds querying functionality.
@ halide_target_feature_fuzz_float_stores
On every floating point store, set the last bit of the mantissa to zero. Pipelines for which the outp...
@ halide_target_feature_sve
Enable ARM Scalable Vector Extensions.
@ halide_target_feature_hvx_v66
Enable Hexagon v66 architecture.
Defines halide types.
This file defines the class FunctionDAG, which is our representation of a Halide pipeline,...
Target get_host_target()
Return the target corresponding to the host machine.
@ Internal
Not visible externally, similar to 'static' linkage in C.
Target::Feature target_feature_for_device_api(DeviceAPI api)
Get the Target feature corresponding to a DeviceAPI.
Target get_jit_target_from_environment()
Return the target that Halide will use for jit-compilation.
DeviceAPI
An enum describing a type of device API.
Definition: DeviceAPI.h:15
Target get_target_from_environment()
Return the target that Halide will use.
unsigned __INT64_TYPE__ uint64_t
signed __INT64_TYPE__ int64_t
A struct representing a target machine and os to generate code for.
Definition: Target.h:19
bool get_runtime_compatible_target(const Target &other, Target &result)
Create a "greatest common denominator" runtime target that is compatible with both this target and ot...
bool operator==(const Target &other) const
Definition: Target.h:221
bool supports_type(const Type &t, DeviceAPI device) const
Does this target allow using a certain type on a certain device.
bool supports_device_api(DeviceAPI api) const
Returns whether a particular device API can be used with this Target.
bool has_gpu_feature() const
Is a fully feature GPU compute runtime enabled? I.e.
static std::string feature_to_name(Target::Feature feature)
Return the name corresponding to a given Feature, in the form used to construct Target strings (e....
static Target::Feature feature_from_name(const std::string &name)
Return the feature corresponding to a given name, in the form used to construct Target strings (e....
Target(OS o, Arch a, int b, const std::vector< Feature > &initial_features=std::vector< Feature >())
Definition: Target.h:135
void set_features(const std::vector< Feature > &features_to_set, bool value=true)
bool has_large_buffers() const
Return true iff 64 bits and has_feature(LargeBuffers).
Definition: Target.h:268
enum Halide::Target::Arch arch
int64_t maximum_buffer_size() const
Return the maximum buffer size in bytes supported on this Target.
Definition: Target.h:275
bool has_feature(Feature f) const
int natural_vector_size() const
Given a data type, return an estimate of the "natural" vector size for that data type when compiling ...
Definition: Target.h:263
Target()=default
Target(const std::string &s)
Given a string of the form used in HL_TARGET (e.g.
int bits
The bit-width of the target machine.
Definition: Target.h:51
enum Halide::Target::OS os
std::string to_string() const
Convert the Target into a string form that can be reconstituted by merge_string(),...
static bool validate_target_string(const std::string &s)
Check if a target string is valid.
Target without_feature(Feature f) const
Return a copy of the target with the given feature cleared.
Feature
Optional features a target can have.
Definition: Target.h:57
@ CUDACapability50
Definition: Target.h:76
@ CheckUnsafePromises
Definition: Target.h:117
@ CUDACapability70
Definition: Target.h:78
@ WasmBulkMemory
Definition: Target.h:125
@ CUDACapability35
Definition: Target.h:75
@ OpenGLCompute
Definition: Target.h:85
@ EnableLLVMLoopOpt
Definition: Target.h:119
@ TraceRealizations
Definition: Target.h:111
@ AVX512_Cannonlake
Definition: Target.h:107
@ HVX_shared_object
Definition: Target.h:100
@ CUDACapability61
Definition: Target.h:77
@ AVX512_SapphireRapids
Definition: Target.h:108
@ WasmSatFloatToInt
Definition: Target.h:123
@ NoBoundsQuery
Definition: Target.h:61
@ CUDACapability32
Definition: Target.h:74
@ DisableLLVMLoopOpt
Definition: Target.h:120
@ AVX512_Skylake
Definition: Target.h:106
@ LLVMLargeCodeModel
Definition: Target.h:129
@ CUDACapability30
Definition: Target.h:73
@ CUDACapability80
Definition: Target.h:80
@ CPlusPlusMangling
Definition: Target.h:92
@ CUDACapability75
Definition: Target.h:79
@ LargeBuffers
Definition: Target.h:93
@ FuzzFloatStores
Definition: Target.h:101
@ POWER_ARCH_2_07
Definition: Target.h:71
bool operator!=(const Target &other) const
Definition: Target.h:228
bool supported() const
Was libHalide compiled with support for this target?
DeviceAPI get_required_device_api() const
If this Target (including all Features) requires a specific DeviceAPI, return it.
bool has_feature(halide_target_feature_t f) const
Definition: Target.h:170
bool has_unknowns() const
Return true if any of the arch/bits/os fields are "unknown"/0; return false otherwise.
bool features_any_of(const std::vector< Feature > &test_features) const
void set_feature(Feature f, bool value=true)
const std::bitset< FeatureEnd > & get_features_bitset() const
Return a bitset of the Featuress set in this Target (set = 1).
Definition: Target.h:294
bool supports_type(const Type &t) const
Does this target allow using a certain type.
int get_cuda_capability_lower_bound() const
Get the minimum cuda capability found as an integer.
Target with_feature(Feature f) const
Return a copy of the target with the given feature set.
int natural_vector_size(const Halide::Type &t) const
Given a data type, return an estimate of the "natural" vector size for that data type when compiling ...
bool features_all_of(const std::vector< Feature > &test_features) const
Arch
The architecture used by the target.
Definition: Target.h:39
OS
The operating system used by the target.
Definition: Target.h:23
@ WebAssemblyRuntime
Definition: Target.h:33
Target(const char *s)
Types in the halide type system.
Definition: Type.h:269