1/* Communication between GCC and libgomp. 2 3 Copyright (C) 2014-2020 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_4 (1 << 6) 44#define GOMP_MAP_FLAG_SPECIAL (GOMP_MAP_FLAG_SPECIAL_1 \ 45 | GOMP_MAP_FLAG_SPECIAL_0) 46#define GOMP_MAP_DEEP_COPY (GOMP_MAP_FLAG_SPECIAL_4 \ 47 | GOMP_MAP_FLAG_SPECIAL_2) 48/* Flag to force a specific behavior (or else, trigger a run-time error). */ 49#define GOMP_MAP_FLAG_FORCE (1 << 7) 50 51enum gomp_map_kind 52 { 53 /* If not already present, allocate. */ 54 GOMP_MAP_ALLOC = 0, 55 /* ..., and copy to device. */ 56 GOMP_MAP_TO = (GOMP_MAP_ALLOC | GOMP_MAP_FLAG_TO), 57 /* ..., and copy from device. */ 58 GOMP_MAP_FROM = (GOMP_MAP_ALLOC | GOMP_MAP_FLAG_FROM), 59 /* ..., and copy to and from device. */ 60 GOMP_MAP_TOFROM = (GOMP_MAP_TO | GOMP_MAP_FROM), 61 /* The following kind is an internal only map kind, used for pointer based 62 array sections. OMP_CLAUSE_SIZE for these is not the pointer size, 63 which is implicitly POINTER_SIZE_UNITS, but the bias. */ 64 GOMP_MAP_POINTER = (GOMP_MAP_FLAG_SPECIAL_0 | 0), 65 /* Also internal, behaves like GOMP_MAP_TO, but additionally any 66 GOMP_MAP_POINTER records consecutive after it which have addresses 67 falling into that range will not be ignored if GOMP_MAP_TO_PSET wasn't 68 mapped already. 69 For OpenACC attach operations (e.g. copyin of struct members), 70 GOMP_MAP_TO_PSET is followed by a single GOMP_MAP_ATTACH mapping 71 instead. */ 72 GOMP_MAP_TO_PSET = (GOMP_MAP_FLAG_SPECIAL_0 | 1), 73 /* Must already be present. */ 74 GOMP_MAP_FORCE_PRESENT = (GOMP_MAP_FLAG_SPECIAL_0 | 2), 75 /* Deallocate a mapping, without copying from device. */ 76 GOMP_MAP_DELETE = (GOMP_MAP_FLAG_SPECIAL_0 | 3), 77 /* Is a device pointer. OMP_CLAUSE_SIZE for these is unused; is implicitly 78 POINTER_SIZE_UNITS. */ 79 GOMP_MAP_FORCE_DEVICEPTR = (GOMP_MAP_FLAG_SPECIAL_1 | 0), 80 /* OpenACC device_resident. */ 81 GOMP_MAP_DEVICE_RESIDENT = (GOMP_MAP_FLAG_SPECIAL_1 | 1), 82 /* OpenACC link. */ 83 GOMP_MAP_LINK = (GOMP_MAP_FLAG_SPECIAL_1 | 2), 84 /* Use device data if present, fall back to host address otherwise. */ 85 GOMP_MAP_IF_PRESENT = (GOMP_MAP_FLAG_SPECIAL_1 | 3), 86 /* Do not map, copy bits for firstprivate instead. */ 87 GOMP_MAP_FIRSTPRIVATE = (GOMP_MAP_FLAG_SPECIAL | 0), 88 /* Similarly, but store the value in the pointer rather than 89 pointed by the pointer. */ 90 GOMP_MAP_FIRSTPRIVATE_INT = (GOMP_MAP_FLAG_SPECIAL | 1), 91 /* Pointer translate host address into device address and copy that 92 back to host. */ 93 GOMP_MAP_USE_DEVICE_PTR = (GOMP_MAP_FLAG_SPECIAL | 2), 94 /* Allocate a zero length array section. Prefer next non-zero length 95 mapping over previous non-zero length mapping over zero length mapping 96 at the address. If not already mapped, do nothing (and pointer translate 97 to NULL). */ 98 GOMP_MAP_ZERO_LEN_ARRAY_SECTION = (GOMP_MAP_FLAG_SPECIAL | 3), 99 /* Allocate. */ 100 GOMP_MAP_FORCE_ALLOC = (GOMP_MAP_FLAG_FORCE | GOMP_MAP_ALLOC), 101 /* ..., and copy to device. */ 102 GOMP_MAP_FORCE_TO = (GOMP_MAP_FLAG_FORCE | GOMP_MAP_TO), 103 /* ..., and copy from device. */ 104 GOMP_MAP_FORCE_FROM = (GOMP_MAP_FLAG_FORCE | GOMP_MAP_FROM), 105 /* ..., and copy to and from device. */ 106 GOMP_MAP_FORCE_TOFROM = (GOMP_MAP_FLAG_FORCE | GOMP_MAP_TOFROM), 107 /* Like GOMP_MAP_USE_DEVICE_PTR above, translate a host to a device 108 address. If translation fails because the target is not mapped, 109 continue using the host address. */ 110 GOMP_MAP_USE_DEVICE_PTR_IF_PRESENT = (GOMP_MAP_FLAG_SPECIAL_2 | 0), 111 /* If not already present, allocate. And unconditionally copy to 112 device. */ 113 GOMP_MAP_ALWAYS_TO = (GOMP_MAP_FLAG_SPECIAL_2 | GOMP_MAP_TO), 114 /* If not already present, allocate. And unconditionally copy from 115 device. */ 116 GOMP_MAP_ALWAYS_FROM = (GOMP_MAP_FLAG_SPECIAL_2 117 | GOMP_MAP_FROM), 118 /* If not already present, allocate. And unconditionally copy to and from 119 device. */ 120 GOMP_MAP_ALWAYS_TOFROM = (GOMP_MAP_FLAG_SPECIAL_2 121 | GOMP_MAP_TOFROM), 122 /* Map a sparse struct; the address is the base of the structure, alignment 123 it's required alignment, and size is the number of adjacent entries 124 that belong to the struct. The adjacent entries should be sorted by 125 increasing address, so it is easy to determine lowest needed address 126 (address of the first adjacent entry) and highest needed address 127 (address of the last adjacent entry plus its size). */ 128 GOMP_MAP_STRUCT = (GOMP_MAP_FLAG_SPECIAL_2 129 | GOMP_MAP_FLAG_SPECIAL | 0), 130 /* On a location of a pointer/reference that is assumed to be already mapped 131 earlier, store the translated address of the preceeding mapping. 132 No refcount is bumped by this, and the store is done unconditionally. */ 133 GOMP_MAP_ALWAYS_POINTER = (GOMP_MAP_FLAG_SPECIAL_2 134 | GOMP_MAP_FLAG_SPECIAL | 1), 135 /* Forced deallocation of zero length array section. */ 136 GOMP_MAP_DELETE_ZERO_LEN_ARRAY_SECTION 137 = (GOMP_MAP_FLAG_SPECIAL_2 138 | GOMP_MAP_FLAG_SPECIAL | 3), 139 /* Decrement usage count and deallocate if zero. */ 140 GOMP_MAP_RELEASE = (GOMP_MAP_FLAG_SPECIAL_2 141 | GOMP_MAP_DELETE), 142 /* The attach/detach mappings below use the OMP_CLAUSE_SIZE field as a 143 bias. This will typically be zero, except when mapping an array slice 144 with a non-zero base. In that case the bias will indicate the 145 (positive) difference between the start of the actual mapped data and 146 the "virtual" origin of the array. 147 In OpenACC, attach a pointer to a mapped struct field. */ 148 GOMP_MAP_ATTACH = (GOMP_MAP_DEEP_COPY | 0), 149 /* In OpenACC, detach a pointer to a mapped struct field. */ 150 GOMP_MAP_DETACH = (GOMP_MAP_DEEP_COPY | 1), 151 /* In OpenACC, detach a pointer to a mapped struct field. */ 152 GOMP_MAP_FORCE_DETACH = (GOMP_MAP_DEEP_COPY 153 | GOMP_MAP_FLAG_FORCE | 1), 154 155 /* Internal to GCC, not used in libgomp. */ 156 /* Do not map, but pointer assign a pointer instead. */ 157 GOMP_MAP_FIRSTPRIVATE_POINTER = (GOMP_MAP_LAST | 1), 158 /* Do not map, but pointer assign a reference instead. */ 159 GOMP_MAP_FIRSTPRIVATE_REFERENCE = (GOMP_MAP_LAST | 2), 160 /* An attach or detach operation. Rewritten to the appropriate type during 161 gimplification, depending on directive (i.e. "enter data" or 162 parallel/kernels region vs. "exit data"). */ 163 GOMP_MAP_ATTACH_DETACH = (GOMP_MAP_LAST | 3) 164 }; 165 166#define GOMP_MAP_COPY_TO_P(X) \ 167 (!((X) & GOMP_MAP_FLAG_SPECIAL) \ 168 && ((X) & GOMP_MAP_FLAG_TO)) 169 170#define GOMP_MAP_COPY_FROM_P(X) \ 171 (!((X) & GOMP_MAP_FLAG_SPECIAL) \ 172 && ((X) & GOMP_MAP_FLAG_FROM)) 173 174#define GOMP_MAP_POINTER_P(X) \ 175 ((X) == GOMP_MAP_POINTER) 176 177#define GOMP_MAP_ALWAYS_TO_P(X) \ 178 (((X) == GOMP_MAP_ALWAYS_TO) || ((X) == GOMP_MAP_ALWAYS_TOFROM)) 179 180#define GOMP_MAP_ALWAYS_FROM_P(X) \ 181 (((X) == GOMP_MAP_ALWAYS_FROM) || ((X) == GOMP_MAP_ALWAYS_TOFROM)) 182 183#define GOMP_MAP_ALWAYS_P(X) \ 184 (GOMP_MAP_ALWAYS_TO_P (X) || ((X) == GOMP_MAP_ALWAYS_FROM)) 185 186 187/* Asynchronous behavior. Keep in sync with 188 libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_async_t. */ 189 190#define GOMP_ASYNC_NOVAL -1 191#define GOMP_ASYNC_SYNC -2 192 193 194/* Device codes. Keep in sync with 195 libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_device_t as well as 196 libgomp/libgomp-plugin.h. */ 197#define GOMP_DEVICE_NONE 0 198#define GOMP_DEVICE_DEFAULT 1 199#define GOMP_DEVICE_HOST 2 200/* #define GOMP_DEVICE_HOST_NONSHM 3 removed. */ 201#define GOMP_DEVICE_NOT_HOST 4 202#define GOMP_DEVICE_NVIDIA_PTX 5 203#define GOMP_DEVICE_INTEL_MIC 6 204#define GOMP_DEVICE_HSA 7 205#define GOMP_DEVICE_GCN 8 206 207#define GOMP_DEVICE_ICV -1 208#define GOMP_DEVICE_HOST_FALLBACK -2 209 210/* GOMP_task/GOMP_taskloop* flags argument. */ 211#define GOMP_TASK_FLAG_UNTIED (1 << 0) 212#define GOMP_TASK_FLAG_FINAL (1 << 1) 213#define GOMP_TASK_FLAG_MERGEABLE (1 << 2) 214#define GOMP_TASK_FLAG_DEPEND (1 << 3) 215#define GOMP_TASK_FLAG_PRIORITY (1 << 4) 216#define GOMP_TASK_FLAG_UP (1 << 8) 217#define GOMP_TASK_FLAG_GRAINSIZE (1 << 9) 218#define GOMP_TASK_FLAG_IF (1 << 10) 219#define GOMP_TASK_FLAG_NOGROUP (1 << 11) 220#define GOMP_TASK_FLAG_REDUCTION (1 << 12) 221 222/* GOMP_target{_ext,update_ext,enter_exit_data} flags argument. */ 223#define GOMP_TARGET_FLAG_NOWAIT (1 << 0) 224#define GOMP_TARGET_FLAG_EXIT_DATA (1 << 1) 225/* Internal to libgomp. */ 226#define GOMP_TARGET_FLAG_UPDATE (1U << 31) 227 228 229/* OpenACC construct flags. */ 230 231/* Force host fallback execution. */ 232#define GOACC_FLAG_HOST_FALLBACK (1 << 0) 233 234/* For legacy reasons, in the ABI, the GOACC_FLAGs are encoded as an inverted 235 bitmask. */ 236#define GOACC_FLAGS_MARSHAL_OP BIT_NOT_EXPR 237#define GOACC_FLAGS_UNMARSHAL(X) (~(X)) 238 239 240/* Versions of libgomp and device-specific plugins. GOMP_VERSION 241 should be incremented whenever an ABI-incompatible change is introduced 242 to the plugin interface defined in libgomp/libgomp.h. */ 243#define GOMP_VERSION 1 244#define GOMP_VERSION_NVIDIA_PTX 1 245#define GOMP_VERSION_INTEL_MIC 0 246#define GOMP_VERSION_HSA 0 247#define GOMP_VERSION_GCN 1 248 249#define GOMP_VERSION_PACK(LIB, DEV) (((LIB) << 16) | (DEV)) 250#define GOMP_VERSION_LIB(PACK) (((PACK) >> 16) & 0xffff) 251#define GOMP_VERSION_DEV(PACK) ((PACK) & 0xffff) 252 253#define GOMP_DIM_GANG 0 254#define GOMP_DIM_WORKER 1 255#define GOMP_DIM_VECTOR 2 256#define GOMP_DIM_MAX 3 257#define GOMP_DIM_MASK(X) (1u << (X)) 258 259/* Varadic launch arguments. End of list is marked by a zero. */ 260#define GOMP_LAUNCH_DIM 1 /* Launch dimensions, op = mask */ 261#define GOMP_LAUNCH_ASYNC 2 /* Async, op = cst val if not MAX */ 262#define GOMP_LAUNCH_WAIT 3 /* Waits, op = num waits. */ 263#define GOMP_LAUNCH_CODE_SHIFT 28 264#define GOMP_LAUNCH_DEVICE_SHIFT 16 265#define GOMP_LAUNCH_OP_SHIFT 0 266#define GOMP_LAUNCH_PACK(CODE,DEVICE,OP) \ 267 (((CODE) << GOMP_LAUNCH_CODE_SHIFT) \ 268 | ((DEVICE) << GOMP_LAUNCH_DEVICE_SHIFT) \ 269 | ((OP) << GOMP_LAUNCH_OP_SHIFT)) 270#define GOMP_LAUNCH_CODE(X) (((X) >> GOMP_LAUNCH_CODE_SHIFT) & 0xf) 271#define GOMP_LAUNCH_DEVICE(X) (((X) >> GOMP_LAUNCH_DEVICE_SHIFT) & 0xfff) 272#define GOMP_LAUNCH_OP(X) (((X) >> GOMP_LAUNCH_OP_SHIFT) & 0xffff) 273#define GOMP_LAUNCH_OP_MAX 0xffff 274 275/* Bitmask to apply in order to find out the intended device of a target 276 argument. */ 277#define GOMP_TARGET_ARG_DEVICE_MASK ((1 << 7) - 1) 278/* The target argument is significant for all devices. */ 279#define GOMP_TARGET_ARG_DEVICE_ALL 0 280 281/* Flag set when the subsequent element in the device-specific argument 282 values. */ 283#define GOMP_TARGET_ARG_SUBSEQUENT_PARAM (1 << 7) 284 285/* Bitmask to apply to a target argument to find out the value identifier. */ 286#define GOMP_TARGET_ARG_ID_MASK (((1 << 8) - 1) << 8) 287/* Target argument index of NUM_TEAMS. */ 288#define GOMP_TARGET_ARG_NUM_TEAMS (1 << 8) 289/* Target argument index of THREAD_LIMIT. */ 290#define GOMP_TARGET_ARG_THREAD_LIMIT (2 << 8) 291 292/* If the value is directly embeded in target argument, it should be a 16-bit 293 at most and shifted by this many bits. */ 294#define GOMP_TARGET_ARG_VALUE_SHIFT 16 295 296/* Dependence types in omp_depend_t objects. */ 297#define GOMP_DEPEND_IN 1 298#define GOMP_DEPEND_OUT 2 299#define GOMP_DEPEND_INOUT 3 300#define GOMP_DEPEND_MUTEXINOUTSET 4 301 302/* HSA specific data structures. */ 303 304/* Identifiers of device-specific target arguments. */ 305#define GOMP_TARGET_ARG_HSA_KERNEL_ATTRIBUTES (1 << 8) 306 307#endif 308