hint/hint_8h_source.html

// SPDX-FileCopyrightText: 2024, 2026 Edward Kmett <ekmett@gmail.com>

// SPDX-License-Identifier: BSD-2-Clause OR Apache-2.0

#pragma once


#ifdef __cplusplus


#ifdef __has_attribute

  #define hint_has_attribute(x) __has_attribute(x)

#else

  #define hint_has_attribute(__x) 0

#endif


#if hint_has_attribute(diagnose_if)

  #define hint_diagnose_if(condition,message) \

    _Pragma("clang diagnostic push") \

    _Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \

    __attribute__((diagnose_if(condition,message,"error"))) \

    _Pragma("clang diagnostic pop")

#else

  #define hint_diagnose_if(condition,message)

#endif


#if defined(_MSC_VER)

  #define hint_has_declspec_attribute(__x) 1

#elif defined(HINT_USE_DECLSPEC) && defined(__has_declspec_attribute)

  #define hint_has_declspec_attribute(x) __has_declspec_attribute(x)

#else

  #define hint_has_declspec_attribute(__x) 0

#endif


#if hint_has_declspec_attribute(empty_bases)

  #define hint_empty_bases __declspec(empty_bases)

#else

  #define hint_empty_bases

#endif


#if hint_has_attribute(const)

  #define hint_const __attribute__((const))

#else

  #define hint_const

#endif


#if hint_has_attribute(pure)

  #define hint_pure __attribute__((pure))

#else

  #define hint_pure

#endif


#if hint_has_attribute(lifetimebound)

  #define hint_lifetimebound [[clang::lifetimebound]]

#else

  #define hint_lifetimebound

#endif


#if hint_has_attribute(noescape)

  #define hint_noescape __attribute__((noescape))

#else

  #define hint_noescape

#endif


#if hint_has_attribute(always_inline)

  #define hint_inline inline __attribute__((always_inline))

#elif defined _WIN32

  #define hint_inline __forceinline

#else

  #define hint_inline inline

#endif


#if hint_has_attribute(flatten)

  #define hint_flatten __attribute__((flatten))

#else

  #define hint_flatten

#endif


#if hint_has_attribute(artificial)

  #define hint_artificial __attribute__((artificial))

#elif hint_has_attribute(__artificial__)

  #define hint_artificial __attribute__((__artificial__))

#else

  #define hint_artificial

  #warning "[[artificial]] is not supported"

#endif


#if hint_has_attribute(noinline)

  #define hint_noinline __attribute__((noinline))

#else

  #define hint_noinline

#endif


#if hint_has_attribute(optnone)

  #define hint_optnone __attribute__((optnone))

#else

  #define hint_optnone

#endif


#if hint_has_attribute(weak)

  #define hint_weak __attribute__((weak))

#else

  #define hint_weak

#endif


#if hint_has_attribute(internal_linkage)

  #define hint_internal_linkage __attribute__((internal_linkage))

#else

  #define hint_internal_linkage

#endif


#if __has_cpp_attribute(clang::preferred_name)

  #define hint_preferred_name(x) [[clang::preferred_name(x)]]

#else

  #define hint_preferred_name(x)

#endif


#if hint_has_attribute(__visibility__)

  #define hint_visibility(...) __attribute__((__visibility__(__VA_ARGS__)))

#else

  #define hint_visibility(...)

  #warning "[[visibility]] is not supported"

#endif


#if hint_has_attribute(exclude_from_explicit_instantiation)

  #define hint_exclude_from_explicit_instantiation __attribute__((exclude_from_explicit_instantiation))

#else

  #define hint_exclude_from_explicit_instantiation

  #warning "[[exclude_from_explicit_instantiation]] is not supported"

#endif


#define hint_hidden hint_visibility("hidden") hint_exclude_from_explicit_instantiation


#if __cpp_constinit

  #define hint_constinit constinit

#elif hint_has_attribute(require_constant_initialization)

  #define hint_constinit __attribute__((require_constant_initialization))

#else

  #define hint_constinit

#endif


#if hint_has_attribute(uninitialized)

  #define hint_uninitialized __attribute__((uninitialized))

#else

  #define hint_uninitialized

#endif


#if __has_cpp_attribute(clang::reinitializes)

  #define hint_reinitializes [[clang::reinitializes]]

#else

  #define hint_reinitializes

#endif


#define hint_target(x) __attribute__((target(x)))


#define hint_target_clones(...) __attribute__((target_clones(__VA_ARGS__)))


#if hint_has_attribute(hot)

  #define hint_hot __attribute__((hot))

#else

  #define hint_hot

#endif


#if hint_has_attribute(cold)

  #define hint_cold __attribute__((cold))

#else

  #define hint_cold

#endif


#if hint_has_attribute(consumable)

  #define hint_consumable(__x) __attribute__((consumable(__x)))

#else

  #define hint_consumable(__x)

#endif


#if hint_has_attribute(callable_when)

  #define hint_callable_when(...) __attribute__((callable_when(__VA_ARGS__)))

#else

  #define hint_callable_when(...)

#endif


#if hint_has_attribute(param_typestate)

  #define hint_param_typestate(...) __attribute__((param_typestate(__VA_ARGS__)))

#else

  #define hint_param_typestate(...)

#endif


#if hint_has_attribute(return_typestate)

  #define hint_return_typestate(...) __attribute__((return_typestate(__VA_ARGS__)))

#else

  #define hint_return_typestate(...)

#endif


#define hint_moving hint_return_typestate("consumed") hint_param_typestate("unconsumed")


#if hint_has_attribute(set_typestate)

  #define hint_set_typestate(...) __attribute__((set_typestate(__VA_ARGS__)))

#else

  #define hint_set_typestate(...)

#endif


#if hint_has_attribute(test_typestate)

  #define hint_test_typestate(...) __attribute__((test_typestate(__VA_ARGS__)))

#else

  #define hint_test_typestate(...)

#endif // hint_has_attribute(test_typestate)


#if hint_has_attribute(no_thread_safety_analysis)

  #define hint_no_thread_safety_analysis __attribute__((no_thread_safety_analysis))

#else

  #define hint_no_thread_safety_analysis

#endif


#if hint_has_attribute(lockable)

  #define hint_lockable __attribute__((lockable))

#else

  #define hint_lockable

#endif


#if hint_has_attribute(scoped_lockable)

  #define hint_scoped_lockable __attribute__((scoped_lockable))

#else

  #define hint_scoped_lockable

#endif


#if hint_has_attribute(guarded_var)

  #define hint_guarded_var __attribute__((guarded_var))

#else

  #define hint_guarded_var

#endif


#if hint_has_attribute(pt_guarded_var)

  #define hint_pt_guarded_var __attribute__((pt_guarded_var))

#else

  #define hint_pt_guarded_var

#endif


#if hint_has_attribute(guarded_by)

  #define hint_guarded_by(x) __attribute__((guarded_by(x)))

#else

  #define hint_guarded_by(x)

#endif


#if hint_has_attribute(pt_guarded_by)

  #define hint_pt_guarded_by(x) __attribute__((pt_guarded_by(x)))

#else

  #define hint_pt_guarded_by(x)

#endif


#if hint_has_attribute(acquired_before)

  #define hint_acquired_before(...) __attribute__((acquired_before(__VA_ARGS__)))

#else

  #define hint_acquired_before(...)

#endif


#if hint_has_attribute(acquired_after)

  #define hint_acquired_after(...) __attribute__((acquired_after(__VA_ARGS__)))

#else

  #define hint_acquired_after(...)

#endif


#if hint_has_attribute(exclusive_lock_function)

  #define hint_exclusive_lock_function(...) __attribute__((exclusive_lock_function(__VA_ARGS__)))

#else

  #define hint_exclusive_lock_function(...)

#endif


#if hint_has_attribute(shared_trylock_function)

  #define hint_shared_trylock_function(...) __attribute__((shared_trylock_function(__VA_ARGS__)))

#else

  #define hint_shared_trylock_function(...)

#endif


#if hint_has_attribute(unlock_function)

  #define hint_unlock_function(...) __attribute__((unlock_function(__VA_ARGS__)))

#else

  #define hint_unlock_function(...)

#endif


#if hint_has_attribute(lock_returned)

  #define hint_lock_returned(__x) __attribute__((lock_returned(__x)))

#else

  #define hint_lock_returned(__x)

#endif


#if hint_has_attribute(locks_excluded)

  #define hint_locks_excluded(...) __attribute__((locks_excluded(__VA_ARGS__)))

#else

  #define hint_locks_excluded(...)

#endif


#if hint_has_attribute(exclusive_locks_required)

  #define hint_exclusive_locks_required(...) __attribute__((exclusive_locks_required(__VA_ARGS__)))

#else

  #define hint_exclusive_locks_required(...)

#endif


#if hint_has_attribute(shared_locks_required)

  #define hint_shared_locks_required(...) __attribute__((shared_locks_required(__VA_ARGS__)))

#else

  #define hint_shared_locks_required(...)

#endif


#if __has_cpp_attribute(clang::acquire_handle)

  #define hint_acquire_handle(__x) [[clang::acquire_handle(__x)]]

#else

  #define hint_acquire_handle(__x)

#endif


#if __has_cpp_attribute(clang::release_handle)

  #define hint_release_handle(__x) [[clang::release_handle(__x)]]

#else

  #define hint_release_handle(__x)

#endif


#if __has_cpp_attribute(clang::use_handle)

  #define hint_use_handle(__x) [[clang::use_handle(__x)]]

#else

  #define hint_use_handle(__x)

#endif


#if hint_has_attribute(aligned)

  #define hint_align(x) __attribute__((aligned(x)))

#else

  #define hint_align(x)

#endif


#if hint_has_attribute(assume_aligned)

  #define hint_assume_aligned(x) __attribute__((assume_aligned(x)))

#else

  #define hint_assume_aligned(x)

#endif


#if hint_has_attribute(align_value)

  #define hint_align_value(x) __attribute__((align_value(x)))

#else

  #define hint_align_value(x)

#endif


#if hint_has_attribute(malloc)

  #define hint_malloc __attribute__((malloc))

#else

  #define hint_malloc

#endif


#if hint_has_attribute(alloc_align)

  #define hint_alloc_align(N) __attribute__((alloc_align(N)))

#else

  #define hint_alloc_align(__N)

#endif


#if hint_has_attribute(alloc_size)

  #define hint_alloc_size(N) __attribute__((alloc_size(N)))

#else

  #define hint_alloc_size(__N)

#endif


#if hint_has_attribute(null_terminated_string_arg)

  #define hint_null_terminated_string_arg(x) __attribute__((null_terminated_string_arg(x)))

#else

  #define hint_null_terminated_string_arg(x)

#endif


#if hint_has_attribute(callback)

  #define hint_callback(...) __attribute__((callback(__VA_ARGS__)))

#else

  #define hint_callback(...)

#endif


#if hint_has_attribute(noreturn)

#define hint_noreturn __attribute__((noreturn))

#else

#define hint_noreturn

#endif


#if hint_has_attribute(returns_nonnull)

  #define hint_returns_nonnull __attribute__((returns_nonnull))

#else

  #define hint_returns_nonnull

#endif


#if hint_has_attribute(nonnull)

  #define hint_nonnull(...) __attribute__((nonnull(__VA_ARGS__)))

#else

  #define hint_nonnull(...)

#endif


#ifdef __clang__

#define hint_Nonnull _Nonnull

#define hint_Nullable _Nullable

#define hint_Null_unspecified _Null_unspecified

#else

#define hint_Nonnull

#define hint_Nullable

#define hint_Null_unspecified

#endif


#ifdef __CUDACC__

#define hint_host __host__

#define hint_device __device__

#define hint_global __global__

#else

#define hint_host

#define hint_device

#define hint_global

#endif


#define hint_hd hint_host hint_device


#if hint_has_attribute(nonblocking)

  #define hint_nonblocking [[clang::nonblocking]]

  #define hint_blocking [[clang::blocking]]

  #define hint_nonallocating [[clang::nonallocating]]

  #define hint_allocating [[clang::allocating]]

  #define hint_noalloc(x) [[clang::nonallocating(x)]]

  #define hint_noblock(x) [[clang::nonblocking(x)]]

#else

  #define hint_nonblocking

  #define hint_blocking

  #define hint_nonallocating

  #define hint_allocating

  #define hint_noalloc(__x)

  #define hint_noblock(__x)

#endif


#define hint_constexpr constexpr


#else

// The shared shader declarations carry no host compiler promises.

#define hint_constexpr

#define hint_inline inline

#define hint_pure

#define hint_const

#define hint_lifetimebound

#define hint_noescape

#define hint_reinitializes

#define hint_artificial

#define hint_flatten

#endif