include/gomp-constants.h

   1 /* Communication between GCC and libgomp.
   2
   3    Copyright (C) 2014-2019 Free Software Foundation, Inc.
   4
   5    Contributed by Mentor Embedded.
   6
   7    This file is part of the GNU Offloading and Multi Processing Library
   8    (libgomp).
   9
  10    Libgomp is free software; you can redistribute it and/or modify it
  11    under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3, or (at your option)
  13    any later version.
  14
  15    Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
  16    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  18    more details.
  19
  20    Under Section 7 of GPL version 3, you are granted additional
  21    permissions described in the GCC Runtime Library Exception, version
  22    3.1, as published by the Free Software Foundation.
  23
  24    You should have received a copy of the GNU General Public License and
  25    a copy of the GCC Runtime Library Exception along with this program;
  26    see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  27    <http://www.gnu.org/licenses/>.  */
  28
  29 #ifndef GOMP_CONSTANTS_H
  30 #define GOMP_CONSTANTS_H 1
  31
  32 /* Memory mapping types.  */
  33
  34 /* One byte.  */
  35 #define GOMP_MAP_LAST                   (1 << 8)
  36
  37 #define GOMP_MAP_FLAG_TO                (1 << 0)
  38 #define GOMP_MAP_FLAG_FROM              (1 << 1)
  39 /* Special map kinds, enumerated starting here.  */
  40 #define GOMP_MAP_FLAG_SPECIAL_0         (1 << 2)
  41 #define GOMP_MAP_FLAG_SPECIAL_1         (1 << 3)
  42 #define GOMP_MAP_FLAG_SPECIAL_2         (1 << 4)
  43 #define GOMP_MAP_FLAG_SPECIAL           (GOMP_MAP_FLAG_SPECIAL_1 \
  44                                          | GOMP_MAP_FLAG_SPECIAL_0)
  45 /* Flag to force a specific behavior (or else, trigger a run-time error).  */
  46 #define GOMP_MAP_FLAG_FORCE             (1 << 7)
  47
  48 enum gomp_map_kind
  49   {
  50     /* If not already present, allocate.  */
  51     GOMP_MAP_ALLOC =                    0,
  52     /* ..., and copy to device.  */
  53     GOMP_MAP_TO =                       (GOMP_MAP_ALLOC | GOMP_MAP_FLAG_TO),
  54     /* ..., and copy from device.  */
  55     GOMP_MAP_FROM =                     (GOMP_MAP_ALLOC | GOMP_MAP_FLAG_FROM),
  56     /* ..., and copy to and from device.  */
  57     GOMP_MAP_TOFROM =                   (GOMP_MAP_TO | GOMP_MAP_FROM),
  58     /* The following kind is an internal only map kind, used for pointer based
  59        array sections.  OMP_CLAUSE_SIZE for these is not the pointer size,
  60        which is implicitly POINTER_SIZE_UNITS, but the bias.  */
  61     GOMP_MAP_POINTER =                  (GOMP_MAP_FLAG_SPECIAL_0 | 0),
  62     /* Also internal, behaves like GOMP_MAP_TO, but additionally any
  63        GOMP_MAP_POINTER records consecutive after it which have addresses
  64        falling into that range will not be ignored if GOMP_MAP_TO_PSET wasn't
  65        mapped already.  */
  66     GOMP_MAP_TO_PSET =                  (GOMP_MAP_FLAG_SPECIAL_0 | 1),
  67     /* Must already be present.  */
  68     GOMP_MAP_FORCE_PRESENT =            (GOMP_MAP_FLAG_SPECIAL_0 | 2),
  69     /* Deallocate a mapping, without copying from device.  */
  70     GOMP_MAP_DELETE =                   (GOMP_MAP_FLAG_SPECIAL_0 | 3),
  71     /* Is a device pointer.  OMP_CLAUSE_SIZE for these is unused; is implicitly
  72        POINTER_SIZE_UNITS.  */
  73     GOMP_MAP_FORCE_DEVICEPTR =          (GOMP_MAP_FLAG_SPECIAL_1 | 0),
  74     /* OpenACC device_resident.  */
  75     GOMP_MAP_DEVICE_RESIDENT =          (GOMP_MAP_FLAG_SPECIAL_1 | 1),
  76     /* OpenACC link.  */
  77     GOMP_MAP_LINK =                     (GOMP_MAP_FLAG_SPECIAL_1 | 2),
  78     /* Do not map, copy bits for firstprivate instead.  */
  79     GOMP_MAP_FIRSTPRIVATE =             (GOMP_MAP_FLAG_SPECIAL | 0),
  80     /* Similarly, but store the value in the pointer rather than
  81        pointed by the pointer.  */
  82     GOMP_MAP_FIRSTPRIVATE_INT =         (GOMP_MAP_FLAG_SPECIAL | 1),
  83     /* Pointer translate host address into device address and copy that
  84        back to host.  */
  85     GOMP_MAP_USE_DEVICE_PTR =           (GOMP_MAP_FLAG_SPECIAL | 2),
  86     /* Allocate a zero length array section.  Prefer next non-zero length
  87        mapping over previous non-zero length mapping over zero length mapping
  88        at the address.  If not already mapped, do nothing (and pointer translate
  89        to NULL).  */
  90     GOMP_MAP_ZERO_LEN_ARRAY_SECTION =   (GOMP_MAP_FLAG_SPECIAL | 3),
  91     /* Allocate.  */
  92     GOMP_MAP_FORCE_ALLOC =              (GOMP_MAP_FLAG_FORCE | GOMP_MAP_ALLOC),
  93     /* ..., and copy to device.  */
  94     GOMP_MAP_FORCE_TO =                 (GOMP_MAP_FLAG_FORCE | GOMP_MAP_TO),
  95     /* ..., and copy from device.  */
  96     GOMP_MAP_FORCE_FROM =               (GOMP_MAP_FLAG_FORCE | GOMP_MAP_FROM),
  97     /* ..., and copy to and from device.  */
  98     GOMP_MAP_FORCE_TOFROM =             (GOMP_MAP_FLAG_FORCE | GOMP_MAP_TOFROM),
  99     /* If not already present, allocate.  And unconditionally copy to
 100        device.  */
 101     GOMP_MAP_ALWAYS_TO =                (GOMP_MAP_FLAG_SPECIAL_2 | GOMP_MAP_TO),
 102     /* If not already present, allocate.  And unconditionally copy from
 103        device.  */
 104     GOMP_MAP_ALWAYS_FROM =              (GOMP_MAP_FLAG_SPECIAL_2
 105                                          | GOMP_MAP_FROM),
 106     /* If not already present, allocate.  And unconditionally copy to and from
 107        device.  */
 108     GOMP_MAP_ALWAYS_TOFROM =            (GOMP_MAP_FLAG_SPECIAL_2
 109                                          | GOMP_MAP_TOFROM),
 110     /* Map a sparse struct; the address is the base of the structure, alignment
 111        it's required alignment, and size is the number of adjacent entries
 112        that belong to the struct.  The adjacent entries should be sorted by
 113        increasing address, so it is easy to determine lowest needed address
 114        (address of the first adjacent entry) and highest needed address
 115        (address of the last adjacent entry plus its size).  */
 116     GOMP_MAP_STRUCT =                   (GOMP_MAP_FLAG_SPECIAL_2
 117                                          | GOMP_MAP_FLAG_SPECIAL | 0),
 118     /* On a location of a pointer/reference that is assumed to be already mapped
 119        earlier, store the translated address of the preceeding mapping.
 120        No refcount is bumped by this, and the store is done unconditionally.  */
 121     GOMP_MAP_ALWAYS_POINTER =           (GOMP_MAP_FLAG_SPECIAL_2
 122                                          | GOMP_MAP_FLAG_SPECIAL | 1),
 123     /* Forced deallocation of zero length array section.  */
 124     GOMP_MAP_DELETE_ZERO_LEN_ARRAY_SECTION
 125       =                                 (GOMP_MAP_FLAG_SPECIAL_2
 126                                          | GOMP_MAP_FLAG_SPECIAL | 3),
 127     /* Decrement usage count and deallocate if zero.  */
 128     GOMP_MAP_RELEASE =                  (GOMP_MAP_FLAG_SPECIAL_2
 129                                          | GOMP_MAP_DELETE),
 130
 131     /* Internal to GCC, not used in libgomp.  */
 132     /* Do not map, but pointer assign a pointer instead.  */
 133     GOMP_MAP_FIRSTPRIVATE_POINTER =     (GOMP_MAP_LAST | 1),
 134     /* Do not map, but pointer assign a reference instead.  */
 135     GOMP_MAP_FIRSTPRIVATE_REFERENCE =   (GOMP_MAP_LAST | 2)
 136   };
 137
 138 #define GOMP_MAP_COPY_TO_P(X) \
 139   (!((X) & GOMP_MAP_FLAG_SPECIAL) \
 140    && ((X) & GOMP_MAP_FLAG_TO))
 141
 142 #define GOMP_MAP_COPY_FROM_P(X) \
 143   (!((X) & GOMP_MAP_FLAG_SPECIAL) \
 144    && ((X) & GOMP_MAP_FLAG_FROM))
 145
 146 #define GOMP_MAP_POINTER_P(X) \
 147   ((X) == GOMP_MAP_POINTER)
 148
 149 #define GOMP_MAP_ALWAYS_TO_P(X) \
 150   (((X) == GOMP_MAP_ALWAYS_TO) || ((X) == GOMP_MAP_ALWAYS_TOFROM))
 151
 152 #define GOMP_MAP_ALWAYS_FROM_P(X) \
 153   (((X) == GOMP_MAP_ALWAYS_FROM) || ((X) == GOMP_MAP_ALWAYS_TOFROM))
 154
 155 #define GOMP_MAP_ALWAYS_P(X) \
 156   (GOMP_MAP_ALWAYS_TO_P (X) || ((X) == GOMP_MAP_ALWAYS_FROM))
 157
 158
 159 /* Asynchronous behavior.  Keep in sync with
 160    libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_async_t.  */
 161
 162 #define GOMP_ASYNC_NOVAL                -1
 163 #define GOMP_ASYNC_SYNC                 -2
 164
 165
 166 /* Device codes.  Keep in sync with
 167    libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_device_t as well as
 168    libgomp/libgomp-plugin.h.  */
 169 #define GOMP_DEVICE_NONE                0
 170 #define GOMP_DEVICE_DEFAULT             1
 171 #define GOMP_DEVICE_HOST                2
 172 /* #define GOMP_DEVICE_HOST_NONSHM      3 removed.  */
 173 #define GOMP_DEVICE_NOT_HOST            4
 174 #define GOMP_DEVICE_NVIDIA_PTX          5
 175 #define GOMP_DEVICE_INTEL_MIC           6
 176 #define GOMP_DEVICE_HSA                 7
 177
 178 #define GOMP_DEVICE_ICV                 -1
 179 #define GOMP_DEVICE_HOST_FALLBACK       -2
 180
 181 /* GOMP_task/GOMP_taskloop* flags argument.  */
 182 #define GOMP_TASK_FLAG_UNTIED           (1 << 0)
 183 #define GOMP_TASK_FLAG_FINAL            (1 << 1)
 184 #define GOMP_TASK_FLAG_MERGEABLE        (1 << 2)
 185 #define GOMP_TASK_FLAG_DEPEND           (1 << 3)
 186 #define GOMP_TASK_FLAG_PRIORITY         (1 << 4)
 187 #define GOMP_TASK_FLAG_UP               (1 << 8)
 188 #define GOMP_TASK_FLAG_GRAINSIZE        (1 << 9)
 189 #define GOMP_TASK_FLAG_IF               (1 << 10)
 190 #define GOMP_TASK_FLAG_NOGROUP          (1 << 11)
 191 #define GOMP_TASK_FLAG_REDUCTION        (1 << 12)
 192
 193 /* GOMP_target{_ext,update_ext,enter_exit_data} flags argument.  */
 194 #define GOMP_TARGET_FLAG_NOWAIT         (1 << 0)
 195 #define GOMP_TARGET_FLAG_EXIT_DATA      (1 << 1)
 196 /* Internal to libgomp.  */
 197 #define GOMP_TARGET_FLAG_UPDATE         (1U << 31)
 198
 199
 200 /* OpenACC construct flags.  */
 201
 202 /* Force host fallback execution.  */
 203 #define GOACC_FLAG_HOST_FALLBACK        (1 << 0)
 204
 205 /* For legacy reasons, in the ABI, the GOACC_FLAGs are encoded as an inverted
 206    bitmask.  */
 207 #define GOACC_FLAGS_MARSHAL_OP          BIT_NOT_EXPR
 208 #define GOACC_FLAGS_UNMARSHAL(X)        (~(X))
 209
 210
 211 /* Versions of libgomp and device-specific plugins.  GOMP_VERSION
 212    should be incremented whenever an ABI-incompatible change is introduced
 213    to the plugin interface defined in libgomp/libgomp.h.  */
 214 #define GOMP_VERSION    1
 215 #define GOMP_VERSION_NVIDIA_PTX 1
 216 #define GOMP_VERSION_INTEL_MIC 0
 217 #define GOMP_VERSION_HSA 0
 218
 219 #define GOMP_VERSION_PACK(LIB, DEV) (((LIB) << 16) | (DEV))
 220 #define GOMP_VERSION_LIB(PACK) (((PACK) >> 16) & 0xffff)
 221 #define GOMP_VERSION_DEV(PACK) ((PACK) & 0xffff)
 222
 223 #define GOMP_DIM_GANG   0
 224 #define GOMP_DIM_WORKER 1
 225 #define GOMP_DIM_VECTOR 2
 226 #define GOMP_DIM_MAX    3
 227 #define GOMP_DIM_MASK(X) (1u << (X))
 228
 229 /* Varadic launch arguments.  End of list is marked by a zero.  */
 230 #define GOMP_LAUNCH_DIM         1  /* Launch dimensions, op = mask */
 231 #define GOMP_LAUNCH_ASYNC       2  /* Async, op = cst val if not MAX  */
 232 #define GOMP_LAUNCH_WAIT        3  /* Waits, op = num waits.  */
 233 #define GOMP_LAUNCH_CODE_SHIFT  28
 234 #define GOMP_LAUNCH_DEVICE_SHIFT 16
 235 #define GOMP_LAUNCH_OP_SHIFT 0
 236 #define GOMP_LAUNCH_PACK(CODE,DEVICE,OP)        \
 237   (((CODE) << GOMP_LAUNCH_CODE_SHIFT)           \
 238    | ((DEVICE) << GOMP_LAUNCH_DEVICE_SHIFT)     \
 239    | ((OP) << GOMP_LAUNCH_OP_SHIFT))
 240 #define GOMP_LAUNCH_CODE(X) (((X) >> GOMP_LAUNCH_CODE_SHIFT) & 0xf)
 241 #define GOMP_LAUNCH_DEVICE(X) (((X) >> GOMP_LAUNCH_DEVICE_SHIFT) & 0xfff)
 242 #define GOMP_LAUNCH_OP(X) (((X) >> GOMP_LAUNCH_OP_SHIFT) & 0xffff)
 243 #define GOMP_LAUNCH_OP_MAX 0xffff
 244
 245 /* Bitmask to apply in order to find out the intended device of a target
 246    argument.  */
 247 #define GOMP_TARGET_ARG_DEVICE_MASK             ((1 << 7) - 1)
 248 /* The target argument is significant for all devices.  */
 249 #define GOMP_TARGET_ARG_DEVICE_ALL              0
 250
 251 /* Flag set when the subsequent element in the device-specific argument
 252    values.  */
 253 #define GOMP_TARGET_ARG_SUBSEQUENT_PARAM        (1 << 7)
 254
 255 /* Bitmask to apply to a target argument to find out the value identifier.  */
 256 #define GOMP_TARGET_ARG_ID_MASK                 (((1 << 8) - 1) << 8)
 257 /* Target argument index of NUM_TEAMS.  */
 258 #define GOMP_TARGET_ARG_NUM_TEAMS               (1 << 8)
 259 /* Target argument index of THREAD_LIMIT.  */
 260 #define GOMP_TARGET_ARG_THREAD_LIMIT            (2 << 8)
 261
 262 /* If the value is directly embeded in target argument, it should be a 16-bit
 263    at most and shifted by this many bits.  */
 264 #define GOMP_TARGET_ARG_VALUE_SHIFT             16
 265
 266 /* Dependence types in omp_depend_t objects.  */
 267 #define GOMP_DEPEND_IN                  1
 268 #define GOMP_DEPEND_OUT                 2
 269 #define GOMP_DEPEND_INOUT               3
 270 #define GOMP_DEPEND_MUTEXINOUTSET       4
 271
 272 /* HSA specific data structures.  */
 273
 274 /* Identifiers of device-specific target arguments.  */
 275 #define GOMP_TARGET_ARG_HSA_KERNEL_ATTRIBUTES   (1 << 8)
 276
 277 #endif