// Copyright 2020 Google LLC // SPDX-License-Identifier: Apache-2.0 // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Main header required before using vector types. // IWYU pragma: begin_exports #include "hwy/base.h" #include "hwy/detect_compiler_arch.h" #include "hwy/detect_targets.h" #include "hwy/highway_export.h" #include "hwy/targets.h" // IWYU pragma: end_exports #if HWY_CXX_LANG < 201703L #define HWY_DISPATCH_MAP … #else #define HWY_DISPATCH_MAP … #endif // This include guard is checked by foreach_target, so avoid the usual _H_ // suffix to prevent copybara from renaming it. NOTE: ops/*-inl.h are included // after/outside this include guard. #ifndef HWY_HIGHWAY_INCLUDED #define HWY_HIGHWAY_INCLUDED namespace hwy { //------------------------------------------------------------------------------ // Shorthand for tags (defined in shared-inl.h) used to select overloads. // Note that ScalableTag<T> is preferred over HWY_FULL, and CappedTag<T, N> over // HWY_CAPPED(T, N). // HWY_FULL(T[,LMUL=1]) is a native vector/group. LMUL is the number of // registers in the group, and is ignored on targets that do not support groups. #define HWY_FULL1(T) … #define HWY_FULL2(T, LMUL) … #define HWY_3TH_ARG(arg1, arg2, arg3, ...) … // Workaround for MSVC grouping __VA_ARGS__ into a single argument #define HWY_FULL_RECOMPOSER(args_with_paren) … // Trailing comma avoids -pedantic false alarm #define HWY_CHOOSE_FULL(...) … #define HWY_FULL(...) … // Vector of up to MAX_N lanes. It's better to use full vectors where possible. #define HWY_CAPPED(T, MAX_N) … //------------------------------------------------------------------------------ // Export user functions for static/dynamic dispatch // Evaluates to 0 inside a translation unit if it is generating anything but the // static target (the last one if multiple targets are enabled). Used to prevent // redefinitions of HWY_EXPORT. Unless foreach_target.h is included, we only // compile once anyway, so this is 1 unless it is or has been included. #ifndef HWY_ONCE #define HWY_ONCE … #endif // HWY_STATIC_DISPATCH(FUNC_NAME) is the namespace-qualified FUNC_NAME for // HWY_STATIC_TARGET (the only defined namespace unless HWY_TARGET_INCLUDE is // defined), and can be used to deduce the return type of Choose*. #if HWY_STATIC_TARGET == HWY_SCALAR #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_EMU128 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_RVV #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_WASM_EMU256 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_WASM #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_NEON_WITHOUT_AES #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_NEON #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_NEON_BF16 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SVE #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SVE2 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SVE_256 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SVE2_128 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_PPC8 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_PPC9 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_PPC10 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_Z14 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_Z15 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SSE2 #define HWY_STATIC_DISPATCH(FUNC_NAME) … #elif HWY_STATIC_TARGET == HWY_SSSE3 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_SSE4 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_AVX2 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_AVX3 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_AVX3_DL #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_AVX3_ZEN4 #define HWY_STATIC_DISPATCH … #elif HWY_STATIC_TARGET == HWY_AVX3_SPR #define HWY_STATIC_DISPATCH … #endif // HWY_CHOOSE_*(FUNC_NAME) expands to the function pointer for that target or // nullptr is that target was not compiled. #if HWY_TARGETS & HWY_EMU128 #define HWY_CHOOSE_FALLBACK … #elif HWY_TARGETS & HWY_SCALAR #define HWY_CHOOSE_FALLBACK … #else // When HWY_SCALAR/HWY_EMU128 are not present and other targets were disabled at // runtime, fall back to the baseline with HWY_STATIC_DISPATCH(). #define HWY_CHOOSE_FALLBACK(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_WASM_EMU256 #define HWY_CHOOSE_WASM_EMU256 … #else #define HWY_CHOOSE_WASM_EMU256(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_WASM #define HWY_CHOOSE_WASM … #else #define HWY_CHOOSE_WASM(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_RVV #define HWY_CHOOSE_RVV … #else #define HWY_CHOOSE_RVV(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_NEON_WITHOUT_AES #define HWY_CHOOSE_NEON_WITHOUT_AES … #else #define HWY_CHOOSE_NEON_WITHOUT_AES(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_NEON #define HWY_CHOOSE_NEON … #else #define HWY_CHOOSE_NEON(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_NEON_BF16 #define HWY_CHOOSE_NEON_BF16 … #else #define HWY_CHOOSE_NEON_BF16(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_SVE #define HWY_CHOOSE_SVE … #else #define HWY_CHOOSE_SVE(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_SVE2 #define HWY_CHOOSE_SVE2 … #else #define HWY_CHOOSE_SVE2(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_SVE_256 #define HWY_CHOOSE_SVE_256 … #else #define HWY_CHOOSE_SVE_256(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_SVE2_128 #define HWY_CHOOSE_SVE2_128 … #else #define HWY_CHOOSE_SVE2_128(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_PPC8 #define HWY_CHOOSE_PPC8 … #else #define HWY_CHOOSE_PPC8(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_PPC9 #define HWY_CHOOSE_PPC9 … #else #define HWY_CHOOSE_PPC9(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_PPC10 #define HWY_CHOOSE_PPC10 … #else #define HWY_CHOOSE_PPC10(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_Z14 #define HWY_CHOOSE_Z14 … #else #define HWY_CHOOSE_Z14(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_Z15 #define HWY_CHOOSE_Z15 … #else #define HWY_CHOOSE_Z15(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_SSE2 #define HWY_CHOOSE_SSE2(FUNC_NAME) … #else #define HWY_CHOOSE_SSE2 … #endif #if HWY_TARGETS & HWY_SSSE3 #define HWY_CHOOSE_SSSE3(FUNC_NAME) … #else #define HWY_CHOOSE_SSSE3 … #endif #if HWY_TARGETS & HWY_SSE4 #define HWY_CHOOSE_SSE4(FUNC_NAME) … #else #define HWY_CHOOSE_SSE4 … #endif #if HWY_TARGETS & HWY_AVX2 #define HWY_CHOOSE_AVX2(FUNC_NAME) … #else #define HWY_CHOOSE_AVX2 … #endif #if HWY_TARGETS & HWY_AVX3 #define HWY_CHOOSE_AVX3(FUNC_NAME) … #else #define HWY_CHOOSE_AVX3 … #endif #if HWY_TARGETS & HWY_AVX3_DL #define HWY_CHOOSE_AVX3_DL … #else #define HWY_CHOOSE_AVX3_DL(FUNC_NAME) … #endif #if HWY_TARGETS & HWY_AVX3_ZEN4 #define HWY_CHOOSE_AVX3_ZEN4(FUNC_NAME) … #else #define HWY_CHOOSE_AVX3_ZEN4 … #endif #if HWY_TARGETS & HWY_AVX3_SPR #define HWY_CHOOSE_AVX3_SPR(FUNC_NAME) … #else #define HWY_CHOOSE_AVX3_SPR … #endif // MSVC 2017 workaround: the non-type template parameter to ChooseAndCall // apparently cannot be an array. Use a function pointer instead, which has the // disadvantage that we call the static (not best) target on the first call to // any HWY_DYNAMIC_DISPATCH. #if (HWY_COMPILER_MSVC && HWY_COMPILER_MSVC < 1915) || \ (HWY_COMPILER_GCC_ACTUAL && HWY_COMPILER_GCC_ACTUAL < 700) #define HWY_DISPATCH_WORKAROUND … #else #define HWY_DISPATCH_WORKAROUND … #endif #if HWY_DISPATCH_MAP struct AllExports { template <class FuncPtr, class ExportsKey, uint64_t kHash> static const FuncPtr*& GetRefToExportsPtr() { static const FuncPtr* s_exports = nullptr; return s_exports; } }; #endif // Provides a static member function which is what is called during the first // HWY_DYNAMIC_DISPATCH, where GetIndex is still zero, and instantiations of // this function are the first entry in the tables created by HWY_EXPORT[_T]. template <typename RetType, typename... Args> struct FunctionCache { … }; // Used to deduce the template parameters RetType and Args from a function. template <typename RetType, typename... Args> FunctionCache<RetType, Args...> DeduceFunctionCache(RetType (*)(Args...)) { … } #define HWY_DISPATCH_TABLE(FUNC_NAME) … // HWY_EXPORT(FUNC_NAME); expands to a static array that is used by // HWY_DYNAMIC_DISPATCH() to call the appropriate function at runtime. // After being exported, it can be called from other parts of the same source // file using HWY_DYNAMIC_DISPATCH(), in particular from a function wrapper // like in the following example: // // #include "hwy/highway.h" // HWY_BEFORE_NAMESPACE(); // namespace skeleton { // namespace HWY_NAMESPACE { // // void MyFunction(int a, char b, const char* c) { ... } // // // NOLINTNEXTLINE(google-readability-namespace-comments) // } // namespace HWY_NAMESPACE // } // namespace skeleton // HWY_AFTER_NAMESPACE(); // // namespace skeleton { // HWY_EXPORT(MyFunction); // Defines the dispatch table in this scope. // // void MyFunction(int a, char b, const char* c) { // return HWY_DYNAMIC_DISPATCH(MyFunction)(a, b, c); // } // } // namespace skeleton // // For templated code with a single type parameter, instead use HWY_EXPORT_T and // its HWY_DYNAMIC_DISPATCH_T counterpart: // // template <typename T> // void MyFunctionCaller(T ...) { // // First argument to both HWY_EXPORT_T and HWY_DYNAMIC_DISPATCH_T is an // // arbitrary table name; you must provide the same name for each call. // // It is fine to have multiple HWY_EXPORT_T in a function, but a 64-bit // // FNV hash collision among *any* table names will trigger HWY_ABORT. // HWY_EXPORT_T(Table1, MyFunction<T>) // HWY_DYNAMIC_DISPATCH_T(Table1)(a, b, c); // } // // Note that HWY_EXPORT_T must be invoked inside a template (in the above // example: `MyFunctionCaller`), so that a separate table will be created for // each template instantiation. For convenience, we also provide a macro that // combines both steps and avoids the need to pick a table name: // // template <typename T> // void MyFunctionCaller(T ...) { // // Table name is automatically chosen. Note that this variant must be // // called in statement context; it is not a valid expression. // HWY_EXPORT_AND_DYNAMIC_DISPATCH_T(MyFunction<T>)(a, b, c); // } // Simplified version for IDE or the dynamic dispatch case with only one target. #if HWY_IDE || ((HWY_TARGETS & (HWY_TARGETS - 1)) == 0) // We use a table to provide the same compile error conditions as with the // non-simplified case, but the table only has a single entry. #define HWY_EXPORT_T … // Use the table, not just STATIC_DISPATCH as in DYNAMIC_DISPATCH, because // TABLE_NAME might not match the function name. #define HWY_DYNAMIC_DISPATCH_T … #define HWY_EXPORT … #define HWY_DYNAMIC_POINTER … #define HWY_DYNAMIC_DISPATCH … #else // not simplified: full table // Pre-C++17 workaround: non-type template arguments must have linkage, which // means we cannot pass &table as a template argument to ChooseAndCall. // ChooseAndCall must find a way to access the table in order to dispatch to the // chosen target: // 0) Skipping this by dispatching to the static target would be surprising to // users and may have serious performance implications. // 1) An extra function parameter would be unacceptable because it changes the // user-visible function signature. // 2) Declaring a table, then defining a pointer to it would work, but requires // an additional DECLARE step outside the function so that the pointer has // linkage, which breaks existing code. // 3) We instead associate the function with the table using an instance of an // unnamed struct and the hash of the table name as the key. Because // ChooseAndCall has the type information, it can then cast to the function // pointer type. However, we cannot simply pass the name as a template // argument to ChooseAndCall because this requires char*, which hits the same // linkage problem. We instead hash the table name, which assumes the // function names do not have collisions. #if HWY_DISPATCH_MAP static constexpr uint64_t FNV(const char* name) { return *name ? static_cast<uint64_t>(static_cast<uint8_t>(*name)) ^ (0x100000001b3ULL * FNV(name + 1)) : 0xcbf29ce484222325ULL; } template <uint64_t kHash> struct AddExport { template <class ExportsKey, class FuncPtr> AddExport(ExportsKey /*exports_key*/, const char* table_name, const FuncPtr* table) { using FuncCache = decltype(DeduceFunctionCache(hwy::DeclVal<FuncPtr>())); static_assert( hwy::IsSame<RemoveCvRef<FuncPtr>, typename FuncCache::FuncPtr>(), "FuncPtr should be same type as FuncCache::FuncPtr"); const FuncPtr*& exports_ptr = AllExports::template GetRefToExportsPtr< RemoveCvRef<FuncPtr>, RemoveCvRef<ExportsKey>, kHash>(); if (exports_ptr && exports_ptr != table) { HWY_ABORT("Hash collision for %s, rename the function\n", table_name); } else { exports_ptr = table; } } }; // Dynamic dispatch: defines table of function pointers. This must be invoked // from inside the function template that calls the template we are exporting. // TABLE_NAME must match the one passed to HWY_DYNAMIC_DISPATCH_T. This // argument allows multiple exports within one function. #define HWY_EXPORT_T … // For non-template functions. Not necessarily invoked within a function, hence // we derive the string and variable names from FUNC_NAME, not HWY_FUNCTION. #if HWY_DISPATCH_WORKAROUND #define HWY_EXPORT … #else #define HWY_EXPORT … #endif // HWY_DISPATCH_WORKAROUND #else // !HWY_DISPATCH_MAP // Zero-overhead, but requires C++17 for non-type template arguments without // linkage, because HWY_EXPORT_T tables are local static variables. #define HWY_EXPORT_T(TABLE_NAME, FUNC_NAME) … #define HWY_EXPORT(FUNC_NAME) … #endif // HWY_DISPATCH_MAP // HWY_DISPATCH_MAP only affects how tables are created, not their usage. // Evaluates to the function pointer for the chosen target. #define HWY_DYNAMIC_POINTER(FUNC_NAME) … // Calls the function pointer for the chosen target. #define HWY_DYNAMIC_DISPATCH(FUNC_NAME) … // Same as DISPATCH, but provide a different arg name to clarify usage. #define HWY_DYNAMIC_DISPATCH_T(TABLE_NAME) … #endif // HWY_IDE || ((HWY_TARGETS & (HWY_TARGETS - 1)) == 0) // Returns the name of an anonymous dispatch table that is only shared with // macro invocations coming from the same source line. #define HWY_DISPATCH_TABLE_T() … // For templated code, combines export and dispatch using an anonymous table. #define HWY_EXPORT_AND_DYNAMIC_DISPATCH_T(FUNC_NAME) … // DEPRECATED names; please use HWY_HAVE_* instead. #define HWY_CAP_INTEGER64 … #define HWY_CAP_FLOAT16 … #define HWY_CAP_FLOAT64 … } // namespace hwy #endif // HWY_HIGHWAY_INCLUDED //------------------------------------------------------------------------------ // NOTE: the following definitions and ops/*.h depend on HWY_TARGET, so we want // to include them once per target, which is ensured by the toggle check. // Because ops/*.h are included under it, they do not need their own guard. #if defined(HWY_HIGHWAY_PER_TARGET) == defined(HWY_TARGET_TOGGLE) #ifdef HWY_HIGHWAY_PER_TARGET #undef HWY_HIGHWAY_PER_TARGET #else #define HWY_HIGHWAY_PER_TARGET #endif // These define ops inside namespace hwy::HWY_NAMESPACE. #if HWY_TARGET == HWY_SSE2 || HWY_TARGET == HWY_SSSE3 || HWY_TARGET == HWY_SSE4 #include "hwy/ops/x86_128-inl.h" #elif HWY_TARGET == HWY_AVX2 #include "hwy/ops/x86_256-inl.h" #elif HWY_TARGET == HWY_AVX3 || HWY_TARGET == HWY_AVX3_DL || \ HWY_TARGET == HWY_AVX3_ZEN4 || HWY_TARGET == HWY_AVX3_SPR #include "hwy/ops/x86_512-inl.h" #elif HWY_TARGET == HWY_Z14 || HWY_TARGET == HWY_Z15 || \ (HWY_TARGET & HWY_ALL_PPC) #include "hwy/ops/ppc_vsx-inl.h" #elif HWY_TARGET & HWY_ALL_NEON #include "hwy/ops/arm_neon-inl.h" #elif HWY_TARGET & HWY_ALL_SVE #include "hwy/ops/arm_sve-inl.h" #elif HWY_TARGET == HWY_WASM_EMU256 #include "hwy/ops/wasm_256-inl.h" #elif HWY_TARGET == HWY_WASM #include "hwy/ops/wasm_128-inl.h" #elif HWY_TARGET == HWY_RVV #include "hwy/ops/rvv-inl.h" #elif HWY_TARGET == HWY_EMU128 #include "hwy/ops/emu128-inl.h" #elif HWY_TARGET == HWY_SCALAR #include "hwy/ops/scalar-inl.h" #else #pragma message("HWY_TARGET does not match any known target") #endif // HWY_TARGET #include "hwy/ops/generic_ops-inl.h" #endif // HWY_HIGHWAY_PER_TARGET
Codebase Browser
chromium