src/xnnpack/common.h

// Copyright (c) Facebook, Inc. and its affiliates.
// All rights reserved.
//
// Copyright 2019 Google LLC
//
// This source code is licensed under the BSD-style license found in the
// LICENSE file in the root directory of this source tree.

#pragma once


// Define architecture indentification macros

#if defined(__i386__) || defined(__i486__) || defined(__i586__) || defined(__i686__) || defined(_M_IX86)
  #define XNN_ARCH_X86 1
#endif

#if defined(__x86_64__) || defined(__x86_64) || defined(_M_X64) || defined(_M_AMD64)
  #define XNN_ARCH_X86_64 1
#endif

#if defined(__arm__) || defined(_M_ARM)
  #define XNN_ARCH_ARM 1
#endif

#if defined(__aarch64__) || defined(_M_ARM64)
  #define XNN_ARCH_ARM64 1
#endif

#if defined(__PPC64__) || defined(__ppc64__) || defined(__powerpc64__) || defined(_ARCH_PPC64)
  #define XNN_ARCH_PPC64 1
#endif

#if defined(__pnacl__)
  #define XNN_ARCH_PNACL 1
#endif

#if defined(__asmjs__)
  #define XNN_ARCH_ASMJS 1
#endif

#if defined(__wasm__)
  #if defined(__wasm_simd128__)
    #define XNN_ARCH_WASMSIMD 1
  #else
    #define XNN_ARCH_WASM 1
  #endif
#endif

// Ensure each architecture indentification macro is always defined, as either 0 or 1

#ifndef XNN_ARCH_X86
  #define XNN_ARCH_X86 0
#endif

#ifndef XNN_ARCH_X86_64
  #define XNN_ARCH_X86_64 0
#endif

#ifndef XNN_ARCH_ARM
  #define XNN_ARCH_ARM 0
#endif

#ifndef XNN_ARCH_ARM64
  #define XNN_ARCH_ARM64 0
#endif

#ifndef XNN_ARCH_PPC64
  #define XNN_ARCH_PPC64 0
#endif

#ifndef XNN_ARCH_PNACL
  #define XNN_ARCH_PNACL 0
#endif

#ifndef XNN_ARCH_ASMJS
  #define XNN_ARCH_ASMJS 0
#endif

#ifndef XNN_ARCH_WASM
  #define XNN_ARCH_WASM 0
#endif

#ifndef XNN_ARCH_WASMSIMD
  #define XNN_ARCH_WASMSIMD 0
#endif


#if defined(__GNUC__)
  #if defined(__clang__) || (__GNUC__ > 4 || __GNUC__ == 4 && __GNUC_MINOR__ >= 5)
    #define XNN_UNREACHABLE do { __builtin_unreachable(); } while (0)
  #else
    #define XNN_UNREACHABLE do { __builtin_trap(); } while (0)
  #endif
#elif defined(_MSC_VER)
  #define XNN_UNREACHABLE __assume(0)
#else
  #define XNN_UNREACHABLE do { } while (0)
#endif

#define XNN_ALIGN(alignment) __attribute__((__aligned__(alignment)))

#define XNN_COUNT_OF(array) (sizeof(array) / sizeof(0[array]))

#if defined(__GNUC__)
  #define XNN_LIKELY(condition) (__builtin_expect(!!(condition), 1))
  #define XNN_UNLIKELY(condition) (__builtin_expect(!!(condition), 0))
#else
  #define XNN_LIKELY(condition) (!!(condition))
  #define XNN_UNLIKELY(condition) (!!(condition))
#endif

// TODO - __builtin_expect_with_probability for GCC 9+
#if defined(__clang__)
  #if __has_builtin(__builtin_unpredictable)
    #define XNN_UNPREDICTABLE(condition) (__builtin_unpredictable(!!(condition)))
  #else
    #define XNN_UNPREDICTABLE(condition) (!!(condition))
  #endif
#else
  #define XNN_UNPREDICTABLE(condition) (!!(condition))
#endif

#if defined(__GNUC__)
  #define XNN_INLINE inline __attribute__((__always_inline__))
#else
  #define XNN_INLINE inline
#endif

#ifndef XNN_INTERNAL
  #if defined(__ELF__)
    #define XNN_INTERNAL __attribute__((__visibility__("internal")))
  #elif defined(__MACH__)
    #define XNN_INTERNAL __attribute__((__visibility__("hidden")))
  #else
    #define XNN_INTERNAL
  #endif
#endif

#ifndef XNN_PRIVATE
  #if defined(__ELF__)
    #define XNN_PRIVATE __attribute__((__visibility__("hidden")))
  #elif defined(__MACH__)
    #define XNN_PRIVATE __attribute__((__visibility__("hidden")))
  #else
    #define XNN_PRIVATE
  #endif
#endif