offload/DeviceRTL/include/DeviceUtils.h

   1 //===--- DeviceUtils.h - OpenMP device runtime utility functions -- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 //
  10 //===----------------------------------------------------------------------===//
  11
  12 #ifndef OMPTARGET_DEVICERTL_DEVICE_UTILS_H
  13 #define OMPTARGET_DEVICERTL_DEVICE_UTILS_H
  14
  15 #include "DeviceTypes.h"
  16 #include "Shared/Utils.h"
  17
  18 #pragma omp begin declare target device_type(nohost)
  19
  20 namespace utils {
  21
  22 /// Return the value \p Var from thread Id \p SrcLane in the warp if the thread
  23 /// is identified by \p Mask.
  24 int32_t shuffle(uint64_t Mask, int32_t Var, int32_t SrcLane, int32_t Width);
  25
  26 int32_t shuffleDown(uint64_t Mask, int32_t Var, uint32_t Delta, int32_t Width);
  27
  28 int64_t shuffleDown(uint64_t Mask, int64_t Var, uint32_t Delta, int32_t Width);
  29
  30 uint64_t ballotSync(uint64_t Mask, int32_t Pred);
  31
  32 /// Return \p LowBits and \p HighBits packed into a single 64 bit value.
  33 uint64_t pack(uint32_t LowBits, uint32_t HighBits);
  34
  35 /// Unpack \p Val into \p LowBits and \p HighBits.
  36 void unpack(uint64_t Val, uint32_t &LowBits, uint32_t &HighBits);
  37
  38 /// Return true iff \p Ptr is pointing into shared (local) memory (AS(3)).
  39 bool isSharedMemPtr(void *Ptr);
  40
  41 /// Return true iff \p Ptr is pointing into (thread) local memory (AS(5)).
  42 bool isThreadLocalMemPtr(void *Ptr);
  43
  44 /// A  pointer variable that has by design an `undef` value. Use with care.
  45 [[clang::loader_uninitialized]] static void *const UndefPtr;
  46
  47 #define OMP_LIKELY(EXPR) __builtin_expect((bool)(EXPR), true)
  48 #define OMP_UNLIKELY(EXPR) __builtin_expect((bool)(EXPR), false)
  49
  50 } // namespace utils
  51
  52 #pragma omp end declare target
  53
  54 #endif