| // Copyright 2019 The IREE Authors |
| // |
| // Licensed under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| |
| #ifndef IREE_BASE_TARGET_PLATFORM_H_ |
| #define IREE_BASE_TARGET_PLATFORM_H_ |
| |
| // The build system defines one of the following top-level platforms and then |
| // one platform+architecture pair for that platform. |
| // |
| // IREE_ARCH ("arm_32", "arm_64", etc) |
| // IREE_ARCH_ENUM (IREE_ARCH_ENUM_ARM_32, etc) |
| // IREE_ARCH_ARM_32 |
| // IREE_ARCH_ARM_64 |
| // IREE_ARCH_RISCV_32 |
| // IREE_ARCH_RISCV_64 |
| // IREE_ARCH_WASM_32 |
| // IREE_ARCH_WASM_64 |
| // IREE_ARCH_X86_32 |
| // IREE_ARCH_X86_64 |
| // |
| // IREE_ENDIANNESS_LITTLE |
| // IREE_ENDIANNESS_BIG |
| // |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED (0/1) |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_8 (0/1) |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_16 (0/1) |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_32 (0/1) |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_64 (0/1) |
| // |
| // IREE_COMPILER_CLANG |
| // IREE_COMPILER_GCC |
| // IREE_COMPILER_GCC_COMPAT |
| // IREE_COMPILER_MSVC |
| // IREE_COMPILER_MSVC_COMPAT |
| // |
| // IREE_SANITIZER_ADDRESS |
| // IREE_SANITIZER_MEMORY |
| // IREE_SANITIZER_THREAD |
| // |
| // IREE_PLATFORM_ANDROID |
| // IREE_PLATFORM_ANDROID_EMULATOR |
| // IREE_PLATFORM_APPLE (IOS | MACOS) |
| // IREE_PLATFORM_EMSCRIPTEN |
| // IREE_PLATFORM_GENERIC |
| // IREE_PLATFORM_IOS |
| // IREE_PLATFORM_IOS_SIMULATOR |
| // IREE_PLATFORM_LINUX |
| // IREE_PLATFORM_MACOS |
| // IREE_PLATFORM_WINDOWS |
| |
| //============================================================================== |
| // IREE_ARCH_* |
| //============================================================================== |
| |
| enum iree_arch_enum_e { |
| IREE_ARCH_ENUM_ARM_32, |
| IREE_ARCH_ENUM_ARM_64, |
| IREE_ARCH_ENUM_RISCV_32, |
| IREE_ARCH_ENUM_RISCV_64, |
| IREE_ARCH_ENUM_WASM_32, |
| IREE_ARCH_ENUM_WASM_64, |
| IREE_ARCH_ENUM_X86_32, |
| IREE_ARCH_ENUM_X86_64, |
| }; |
| |
| #if defined(__arm64) || defined(__aarch64__) || defined(_M_ARM64) || \ |
| defined(_M_ARM64EC) |
| #define IREE_ARCH "arm_64" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_ARM_64 |
| #define IREE_ARCH_ARM_64 1 |
| #elif defined(__arm__) || defined(__thumb__) || defined(__TARGET_ARCH_ARM) || \ |
| defined(__TARGET_ARCH_THUMB) || defined(_M_ARM) |
| #define IREE_ARCH "arm_32" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_ARM_32 |
| #define IREE_ARCH_ARM_32 1 |
| #endif // ARM |
| |
| #if defined(__riscv) && (__riscv_xlen == 32) |
| #define IREE_ARCH "riscv_32" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_RISCV_32 |
| #define IREE_ARCH_RISCV_32 1 |
| #elif defined(__riscv) && (__riscv_xlen == 64) |
| #define IREE_ARCH "riscv_64" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_RISCV_64 |
| #define IREE_ARCH_RISCV_64 1 |
| #endif // RISCV |
| |
| #if defined(__wasm32__) |
| #define IREE_ARCH "wasm_32" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_WASM_32 |
| #define IREE_ARCH_WASM_32 1 |
| #elif defined(__wasm64__) |
| #define IREE_ARCH "wasm_64" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_WASM_64 |
| #define IREE_ARCH_WASM_64 1 |
| #endif // WASM |
| |
| #if defined(__i386__) || defined(__i486__) || defined(__i586__) || \ |
| defined(__i686__) || defined(__i386) || defined(_M_IX86) || defined(_X86_) |
| #define IREE_ARCH "x86_32" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_X86_32 |
| #define IREE_ARCH_X86_32 1 |
| #elif defined(__x86_64) || defined(__x86_64__) || defined(__amd64__) || \ |
| defined(__amd64) || defined(_M_X64) |
| #define IREE_ARCH "x86_64" |
| #define IREE_ARCH_ENUM IREE_ARCH_ENUM_X86_64 |
| #define IREE_ARCH_X86_64 1 |
| #endif // X86 |
| |
| #if !defined(IREE_ARCH_ARM_32) && !defined(IREE_ARCH_ARM_64) && \ |
| !defined(IREE_ARCH_RISCV_32) && !defined(IREE_ARCH_RISCV_64) && \ |
| !defined(IREE_ARCH_WASM_32) && !defined(IREE_ARCH_WASM_64) && \ |
| !defined(IREE_ARCH_X86_32) && !defined(IREE_ARCH_X86_64) |
| #error Unknown architecture. |
| #endif // all archs |
| |
| //============================================================================== |
| // IREE_ENDIANNESS_* |
| //============================================================================== |
| // https://en.wikipedia.org/wiki/Endianness |
| |
| #if (defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && \ |
| __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) |
| #define IREE_ENDIANNESS_LITTLE 1 |
| #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && \ |
| __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__ |
| #define IREE_ENDIANNESS_BIG 1 |
| #elif defined(_WIN32) |
| #define IREE_ENDIANNESS_LITTLE 1 |
| #else |
| #error IREE endian detection needs to be set up for your compiler |
| #endif // __BYTE_ORDER__ |
| |
| //============================================================================== |
| // IREE_MEMORY_ACCESS_* |
| //============================================================================== |
| // Certain architectures have specific memory access requirements that require |
| // user-mode code changes to work at all or work at reasonable performance. |
| |
| #if !defined(IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED) |
| |
| #if defined(IREE_ARCH_ARM_32) || defined(IREE_ARCH_ARM_64) |
| |
| // Armv6‑M and Armv8-M (w/o the main extension) do not support unaligned access. |
| // The -munaligned-access and -mno-unaligned-access flags control this. |
| // https://www.keil.com/support/man/docs/armclang_ref/armclang_ref_sam1444138667173.htm |
| #if !defined(__ARM_FEATURE_UNALIGNED) |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED 1 |
| #else |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED 0 |
| #endif // !__ARM_FEATURE_UNALIGNED |
| |
| // Unaligned support is only available for singles on Armv7-M. |
| // Therefore, aligned memory access is enforced for 64-bit data types. |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_64 1 |
| |
| #elif defined(IREE_ARCH_RISCV_32) || defined(IREE_ARCH_RISCV_64) |
| |
| // Though unaligned access is part of the base spec it is allowed to be |
| // implemented with trap handlers. Bare-metal systems likely won't have these |
| // handlers and even on systems that do (linux) we don't want to be trapping for |
| // every load/store. |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED 1 |
| |
| #else |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED 0 |
| #endif // IREE_ARCH_* |
| #endif // !IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED |
| |
| // Set IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_* to the value of |
| // IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED if the former was not set before. |
| #if !defined(IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_8) |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_8 \ |
| IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED |
| #endif // !IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_8 |
| |
| #if !defined(IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_16) |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_16 \ |
| IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED |
| #endif // !IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_16 |
| |
| #if !defined(IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_32) |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_32 \ |
| IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED |
| #endif // !IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_32 |
| |
| #if !defined(IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_64) |
| #define IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_64 \ |
| IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED |
| #endif // !IREE_MEMORY_ACCESS_ALIGNMENT_REQUIRED_64 |
| |
| //============================================================================== |
| // IREE_COMPILER_* |
| //============================================================================== |
| |
| #if defined(__clang__) |
| #define IREE_COMPILER_CLANG 1 |
| #if defined(_MSC_VER) |
| // clang-cl is msvc-like (but also still clang). |
| #define IREE_COMPILER_MSVC_COMPAT 1 |
| #else |
| #define IREE_COMPILER_GCC_COMPAT 1 |
| #endif // _MSC_VER |
| #elif defined(__GNUC__) |
| #define IREE_COMPILER_GCC 1 |
| #define IREE_COMPILER_GCC_COMPAT 1 |
| #elif defined(_MSC_VER) |
| #define IREE_COMPILER_MSVC 1 |
| #define IREE_COMPILER_MSVC_COMPAT 1 |
| #else |
| #error Unrecognized compiler. |
| #endif // compiler versions |
| |
| #if defined(__has_feature) |
| #if __has_feature(address_sanitizer) |
| #define IREE_SANITIZER_ADDRESS 1 |
| #endif // __has_feature(address_sanitizer) |
| #if __has_feature(memory_sanitizer) |
| #define IREE_SANITIZER_MEMORY 1 |
| #endif // __has_feature(memory_sanitizer) |
| #if __has_feature(thread_sanitizer) |
| #define IREE_SANITIZER_THREAD 1 |
| #endif // __has_feature(thread_sanitizer) |
| #endif // defined(__has_feature) |
| |
| //============================================================================== |
| // IREE_PLATFORM_* |
| //============================================================================== |
| |
| // We allow IREE_PLATFORM_GENERIC to override all other platform detection |
| // logic so that we can purposefully compile for bare-metal devices using a |
| // target-specific toolchain (since most of our code should be using these |
| // macros instead of raw compiler-provided ones). |
| #if !defined(IREE_PLATFORM_GENERIC) |
| |
| //============================================================================== |
| // IREE_PLATFORM_ANDROID |
| //============================================================================== |
| |
| #if defined(__ANDROID__) |
| #define IREE_PLATFORM_ANDROID 1 |
| #endif // __ANDROID__ |
| |
| //============================================================================== |
| // IREE_PLATFORM_EMSCRIPTEN |
| //============================================================================== |
| |
| #if defined(__EMSCRIPTEN__) |
| #define IREE_PLATFORM_EMSCRIPTEN 1 |
| #endif // __ANDROID__ |
| |
| //============================================================================== |
| // IREE_PLATFORM_IOS | IREE_PLATFORM_MACOS |
| //============================================================================== |
| |
| #if defined(__APPLE__) |
| #include <TargetConditionals.h> // IWYU pragma: export |
| #if TARGET_OS_IPHONE |
| #define IREE_PLATFORM_IOS 1 |
| #else |
| #define IREE_PLATFORM_MACOS 1 |
| #endif // TARGET_OS_IPHONE |
| #if TARGET_IPHONE_SIMULATOR |
| #define IREE_PLATFORM_IOS_SIMULATOR 1 |
| #endif // TARGET_IPHONE_SIMULATOR |
| #endif // __APPLE__ |
| |
| #if defined(IREE_PLATFORM_IOS) || defined(IREE_PLATFORM_MACOS) |
| #define IREE_PLATFORM_APPLE 1 |
| #endif // IREE_PLATFORM_IOS || IREE_PLATFORM_MACOS |
| |
| //============================================================================== |
| // IREE_PLATFORM_LINUX |
| //============================================================================== |
| |
| #if defined(__linux__) || defined(linux) || defined(__linux) |
| #define IREE_PLATFORM_LINUX 1 |
| #endif // __linux__ |
| |
| //============================================================================== |
| // IREE_PLATFORM_WINDOWS |
| //============================================================================== |
| |
| #if defined(_WIN32) || defined(_WIN64) |
| #define IREE_PLATFORM_WINDOWS 1 |
| #endif // _WIN32 || _WIN64 |
| |
| #if defined(IREE_PLATFORM_WINDOWS) |
| |
| #if defined(_MSC_VER) |
| // Abseil compatibility: don't include incompatible winsock versions. |
| #ifndef WIN32_LEAN_AND_MEAN |
| #define WIN32_LEAN_AND_MEAN |
| #endif // WIN32_LEAN_AND_MEAN |
| // Abseil compatibility: don't define min and max macros. |
| #ifndef NOMINMAX |
| #define NOMINMAX |
| #endif // NOMINMAX |
| #endif // _MSC_VER |
| |
| #include <windows.h> // IWYU pragma: export |
| |
| // WinGDI.h defines `ERROR`, undef to avoid conflict naming. |
| #undef ERROR |
| |
| #endif // IREE_PLATFORM_WINDOWS |
| |
| //============================================================================== |
| // Fallthrough for unsupported platforms |
| //============================================================================== |
| |
| #if !defined(IREE_PLATFORM_ANDROID) && !defined(IREE_PLATFORM_EMSCRIPTEN) && \ |
| !defined(IREE_PLATFORM_GENERIC) && !defined(IREE_PLATFORM_IOS) && \ |
| !defined(IREE_PLATFORM_LINUX) && !defined(IREE_PLATFORM_MACOS) && \ |
| !defined(IREE_PLATFORM_WINDOWS) |
| #error Unknown platform. |
| #endif // all archs |
| |
| #endif // !IREE_PLATFORM_GENERIC |
| |
| #endif // IREE_BASE_TARGET_PLATFORM_H_ |
