hints.h

Go to the documentation of this file.

// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
// Modified by Jeremy Retailleau.
 
#ifndef PXR_ARCH_HINTS_H
#define PXR_ARCH_HINTS_H
 
#include "./defines.h"
 
 
#if defined(ARCH_COMPILER_GCC) || defined(ARCH_COMPILER_CLANG)
 
#define ARCH_LIKELY(x) (__builtin_expect((bool)(x), true))
#define ARCH_UNLIKELY(x) (__builtin_expect((bool)(x), false))
 
#else
 
#define ARCH_LIKELY(x) (x)
#define ARCH_UNLIKELY(x) (x)
 
#endif
 
 
#if defined(ARCH_COMPILER_GCC) || \
    defined(ARCH_COMPILER_CLANG) || \
    defined(ARCH_COMPILER_ICC)
 
// Intentionally using __builtin_unreachable on clang for consistency, since
// __builtin_assume does not evaluate the expression, and our only option on gcc
// is the __builtin_unreachable branch.
 
#define ARCH_GUARANTEE_TO_COMPILER(x) \
    if (static_cast<bool>(x)) { } else { __builtin_unreachable(); }
 
#else
 
#define ARCH_GUARANTEE_TO_COMPILER(x)
 
#endif
 
 
#endif // PXR_ARCH_HINTS_H