halide_error_code_t

enum halide_error_code_t

The error codes that may be returned by a Halide pipeline.

Values:

enumerator halide_error_code_success

There was no error.

This is the value returned by Halide on success.

enumerator halide_error_code_generic_error

An uncategorized error occurred.

Refer to the string passed to halide_error.

enumerator halide_error_code_explicit_bounds_too_small

A Func was given an explicit bound via Func::bound, but this was not large enough to encompass the region that is used of the Func by the rest of the pipeline.

enumerator halide_error_code_bad_type

The elem_size field of a halide_buffer_t does not match the size in bytes of the type of that ImageParam.

Probable type mismatch.

enumerator halide_error_code_access_out_of_bounds

A pipeline would access memory outside of the halide_buffer_t passed in.

enumerator halide_error_code_buffer_allocation_too_large

A halide_buffer_t was given that spans more than 2GB of memory.

enumerator halide_error_code_buffer_extents_too_large

A halide_buffer_t was given with extents that multiply to a number greater than 2^31-1.

enumerator halide_error_code_constraints_make_required_region_smaller

Applying explicit constraints on the size of an input or output buffer shrank the size of that buffer below what will be accessed by the pipeline.

enumerator halide_error_code_constraint_violated

A constraint on a size or stride of an input or output buffer was not met by the halide_buffer_t passed in.

enumerator halide_error_code_param_too_small

A scalar parameter passed in was smaller than its minimum declared value.

enumerator halide_error_code_param_too_large

A scalar parameter passed in was greater than its minimum declared value.

enumerator halide_error_code_out_of_memory

A call to halide_malloc returned NULL.

enumerator halide_error_code_buffer_argument_is_null

A halide_buffer_t pointer passed in was NULL.

enumerator halide_error_code_debug_to_file_failed

debug_to_file failed to open or write to the specified file.

enumerator halide_error_code_copy_to_host_failed

The Halide runtime encountered an error while trying to copy from device to host.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_copy_to_device_failed

The Halide runtime encountered an error while trying to copy from host to device.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_device_malloc_failed

The Halide runtime encountered an error while trying to allocate memory on device.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_device_sync_failed

The Halide runtime encountered an error while trying to synchronize with a device.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_device_free_failed

The Halide runtime encountered an error while trying to free a device allocation.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_no_device_interface

Buffer has a non-zero device but no device interface, which violates a Halide invariant.

enumerator halide_error_code_unimplemented

This part of the Halide runtime is unimplemented on this platform.

enumerator halide_error_code_symbol_not_found

A runtime symbol could not be loaded.

enumerator halide_error_code_internal_error

There is a bug in the Halide compiler.

enumerator halide_error_code_device_run_failed

The Halide runtime encountered an error while trying to launch a GPU kernel.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_unaligned_host_ptr

The Halide runtime encountered a host pointer that violated the alignment set for it by way of a call to set_host_alignment.

enumerator halide_error_code_bad_fold

A fold_storage directive was used on a dimension that is not accessed in a monotonically increasing or decreasing fashion.

enumerator halide_error_code_fold_factor_too_small

A fold_storage directive was used with a fold factor that was too small to store all the values of a producer needed by the consumer.

enumerator halide_error_code_requirement_failed

User-specified require() expression was not satisfied.

enumerator halide_error_code_buffer_extents_negative

At least one of the buffer’s extents are negative.

enumerator halide_error_code_gpu_device_error

Call(s) to a GPU backend API failed.

enumerator halide_error_code_trace_failed

Failure recording trace packets for one of the halide_target_feature_trace features.

enumerator halide_error_code_specialize_fail

A specialize_fail() schedule branch was selected at runtime.

enumerator halide_error_code_device_wrap_native_failed

The Halide runtime encountered an error while trying to wrap a native device handle.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_device_detach_native_failed

The Halide runtime encountered an error while trying to detach a native device handle.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_host_is_null

The host field on an input or output was null, the device field was not zero, and the pipeline tries to use the buffer on the host.

You may be passing a GPU-only buffer to a pipeline which is scheduled to use it on the CPU.

enumerator halide_error_code_bad_extern_fold

A folded buffer was passed to an extern stage, but the region touched wraps around the fold boundary.

enumerator halide_error_code_device_interface_no_device

Buffer has a non-null device_interface but device is 0, which violates a Halide invariant.

enumerator halide_error_code_host_and_device_dirty

Buffer has both host and device dirty bits set, which violates a Halide invariant.

enumerator halide_error_code_buffer_is_null

The halide_buffer_t * passed to a halide runtime routine is nullptr and this is not allowed.

enumerator halide_error_code_device_buffer_copy_failed

The Halide runtime encountered an error while trying to copy from one buffer to another.

Turn on -debug in your target string to see more details.

enumerator halide_error_code_device_crop_unsupported

Attempted to make cropped/sliced alias of a buffer with a device field, but the device_interface does not support cropping.

enumerator halide_error_code_device_crop_failed

Cropping/slicing a buffer failed for some other reason.

Turn on -debug in your target string.

enumerator halide_error_code_incompatible_device_interface

An operation on a buffer required an allocation on a particular device interface, but a device allocation already existed on a different device interface.

Free the old one first.

enumerator halide_error_code_bad_dimensions

The dimensions field of a halide_buffer_t does not match the dimensions of that ImageParam.

enumerator halide_error_code_device_dirty_with_no_device_support

A buffer with the device_dirty flag set was passed to a pipeline compiled with no device backends enabled, so it doesn’t know how to copy the data back from device memory to host memory.

Either call copy_to_host before calling the Halide pipeline, or enable the appropriate device backend.

enumerator halide_error_code_storage_bound_too_small

An explicit storage bound provided is too small to store all the values produced by the function.

enumerator halide_error_code_split_factor_not_positive

A factor used to split a loop was discovered to be zero or negative at runtime.

enumerator halide_error_code_vscale_invalid

“vscale” value of Scalable Vector detected in runtime does not match the vscale value used in compilation.

enumerator halide_error_code_cannot_profile_pipeline

Profiling failed for a pipeline invocation.

enumerator halide_error_code_streaming_vscale_invalid

“vscale” value of Streaming Scalable Vector detected in runtime does not match the streaming vscale value used in compilation.