[thirdparty/gcc.git] / include / gomp-constants.h

/* Communication between GCC and libgomp.

   Copyright (C) 2014-2019 Free Software Foundation, Inc.

   Contributed by Mentor Embedded.

   This file is part of the GNU Offloading and Multi Processing Library
   (libgomp).

   Libgomp is free software; you can redistribute it and/or modify it
   under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3, or (at your option)
   any later version.

   Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
   FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
   more details.

   Under Section 7 of GPL version 3, you are granted additional
   permissions described in the GCC Runtime Library Exception, version
   3.1, as published by the Free Software Foundation.

   You should have received a copy of the GNU General Public License and
   a copy of the GCC Runtime Library Exception along with this program;
   see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
   <http://www.gnu.org/licenses/>.  */

#ifndef GOMP_CONSTANTS_H
#define GOMP_CONSTANTS_H 1

/* Memory mapping types.  */

/* One byte.  */
#define GOMP_MAP_LAST			(1 << 8)

#define GOMP_MAP_FLAG_TO		(1 << 0)
#define GOMP_MAP_FLAG_FROM		(1 << 1)
/* Special map kinds, enumerated starting here.  */
#define GOMP_MAP_FLAG_SPECIAL_0		(1 << 2)
#define GOMP_MAP_FLAG_SPECIAL_1		(1 << 3)
#define GOMP_MAP_FLAG_SPECIAL_2		(1 << 4)
#define GOMP_MAP_FLAG_SPECIAL		(GOMP_MAP_FLAG_SPECIAL_1 \
					 | GOMP_MAP_FLAG_SPECIAL_0)
/* Flag to force a specific behavior (or else, trigger a run-time error).  */
#define GOMP_MAP_FLAG_FORCE		(1 << 7)

enum gomp_map_kind
  {
    /* If not already present, allocate.  */
    GOMP_MAP_ALLOC =			0,
    /* ..., and copy to device.  */
    GOMP_MAP_TO =			(GOMP_MAP_ALLOC | GOMP_MAP_FLAG_TO),
    /* ..., and copy from device.  */
    GOMP_MAP_FROM =			(GOMP_MAP_ALLOC | GOMP_MAP_FLAG_FROM),
    /* ..., and copy to and from device.  */
    GOMP_MAP_TOFROM =			(GOMP_MAP_TO | GOMP_MAP_FROM),
    /* The following kind is an internal only map kind, used for pointer based
       array sections.  OMP_CLAUSE_SIZE for these is not the pointer size,
       which is implicitly POINTER_SIZE_UNITS, but the bias.  */
    GOMP_MAP_POINTER =			(GOMP_MAP_FLAG_SPECIAL_0 | 0),
    /* Also internal, behaves like GOMP_MAP_TO, but additionally any
       GOMP_MAP_POINTER records consecutive after it which have addresses
       falling into that range will not be ignored if GOMP_MAP_TO_PSET wasn't
       mapped already.  */
    GOMP_MAP_TO_PSET =			(GOMP_MAP_FLAG_SPECIAL_0 | 1),
    /* Must already be present.  */
    GOMP_MAP_FORCE_PRESENT =		(GOMP_MAP_FLAG_SPECIAL_0 | 2),
    /* Deallocate a mapping, without copying from device.  */
    GOMP_MAP_DELETE =			(GOMP_MAP_FLAG_SPECIAL_0 | 3),
    /* Is a device pointer.  OMP_CLAUSE_SIZE for these is unused; is implicitly
       POINTER_SIZE_UNITS.  */
    GOMP_MAP_FORCE_DEVICEPTR =		(GOMP_MAP_FLAG_SPECIAL_1 | 0),
    /* OpenACC device_resident.  */
    GOMP_MAP_DEVICE_RESIDENT =		(GOMP_MAP_FLAG_SPECIAL_1 | 1),
    /* OpenACC link.  */
    GOMP_MAP_LINK =			(GOMP_MAP_FLAG_SPECIAL_1 | 2),
    /* Do not map, copy bits for firstprivate instead.  */
    GOMP_MAP_FIRSTPRIVATE =		(GOMP_MAP_FLAG_SPECIAL | 0),
    /* Similarly, but store the value in the pointer rather than
       pointed by the pointer.  */
    GOMP_MAP_FIRSTPRIVATE_INT =		(GOMP_MAP_FLAG_SPECIAL | 1),
    /* Pointer translate host address into device address and copy that
       back to host.  */
    GOMP_MAP_USE_DEVICE_PTR =		(GOMP_MAP_FLAG_SPECIAL | 2),
    /* Allocate a zero length array section.  Prefer next non-zero length
       mapping over previous non-zero length mapping over zero length mapping
       at the address.  If not already mapped, do nothing (and pointer translate
       to NULL).  */
    GOMP_MAP_ZERO_LEN_ARRAY_SECTION = 	(GOMP_MAP_FLAG_SPECIAL | 3),
    /* Allocate.  */
    GOMP_MAP_FORCE_ALLOC =		(GOMP_MAP_FLAG_FORCE | GOMP_MAP_ALLOC),
    /* ..., and copy to device.  */
    GOMP_MAP_FORCE_TO =			(GOMP_MAP_FLAG_FORCE | GOMP_MAP_TO),
    /* ..., and copy from device.  */
    GOMP_MAP_FORCE_FROM =		(GOMP_MAP_FLAG_FORCE | GOMP_MAP_FROM),
    /* ..., and copy to and from device.  */
    GOMP_MAP_FORCE_TOFROM =		(GOMP_MAP_FLAG_FORCE | GOMP_MAP_TOFROM),
    /* If not already present, allocate.  And unconditionally copy to
       device.  */
    GOMP_MAP_ALWAYS_TO =		(GOMP_MAP_FLAG_SPECIAL_2 | GOMP_MAP_TO),
    /* If not already present, allocate.  And unconditionally copy from
       device.  */
    GOMP_MAP_ALWAYS_FROM =		(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_FROM),
    /* If not already present, allocate.  And unconditionally copy to and from
       device.  */
    GOMP_MAP_ALWAYS_TOFROM =		(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_TOFROM),
    /* Map a sparse struct; the address is the base of the structure, alignment
       it's required alignment, and size is the number of adjacent entries
       that belong to the struct.  The adjacent entries should be sorted by
       increasing address, so it is easy to determine lowest needed address
       (address of the first adjacent entry) and highest needed address
       (address of the last adjacent entry plus its size).  */
    GOMP_MAP_STRUCT =			(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_FLAG_SPECIAL | 0),
    /* On a location of a pointer/reference that is assumed to be already mapped
       earlier, store the translated address of the preceeding mapping.
       No refcount is bumped by this, and the store is done unconditionally.  */
    GOMP_MAP_ALWAYS_POINTER =		(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_FLAG_SPECIAL | 1),
    /* Forced deallocation of zero length array section.  */
    GOMP_MAP_DELETE_ZERO_LEN_ARRAY_SECTION
      =					(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_FLAG_SPECIAL | 3),
    /* Decrement usage count and deallocate if zero.  */
    GOMP_MAP_RELEASE =			(GOMP_MAP_FLAG_SPECIAL_2
					 | GOMP_MAP_DELETE),

    /* Internal to GCC, not used in libgomp.  */
    /* Do not map, but pointer assign a pointer instead.  */
    GOMP_MAP_FIRSTPRIVATE_POINTER =	(GOMP_MAP_LAST | 1),
    /* Do not map, but pointer assign a reference instead.  */
    GOMP_MAP_FIRSTPRIVATE_REFERENCE =	(GOMP_MAP_LAST | 2)
  };

#define GOMP_MAP_COPY_TO_P(X) \
  (!((X) & GOMP_MAP_FLAG_SPECIAL) \
   && ((X) & GOMP_MAP_FLAG_TO))

#define GOMP_MAP_COPY_FROM_P(X) \
  (!((X) & GOMP_MAP_FLAG_SPECIAL) \
   && ((X) & GOMP_MAP_FLAG_FROM))

#define GOMP_MAP_POINTER_P(X) \
  ((X) == GOMP_MAP_POINTER)

#define GOMP_MAP_ALWAYS_TO_P(X) \
  (((X) == GOMP_MAP_ALWAYS_TO) || ((X) == GOMP_MAP_ALWAYS_TOFROM))

#define GOMP_MAP_ALWAYS_FROM_P(X) \
  (((X) == GOMP_MAP_ALWAYS_FROM) || ((X) == GOMP_MAP_ALWAYS_TOFROM))

#define GOMP_MAP_ALWAYS_P(X) \
  (GOMP_MAP_ALWAYS_TO_P (X) || ((X) == GOMP_MAP_ALWAYS_FROM))


/* Asynchronous behavior.  Keep in sync with
   libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_async_t.  */

#define GOMP_ASYNC_NOVAL		-1
#define GOMP_ASYNC_SYNC			-2


/* Device codes.  Keep in sync with
   libgomp/{openacc.h,openacc.f90,openacc_lib.h}:acc_device_t as well as
   libgomp/libgomp-plugin.h.  */
#define GOMP_DEVICE_NONE		0
#define GOMP_DEVICE_DEFAULT		1
#define GOMP_DEVICE_HOST		2
/* #define GOMP_DEVICE_HOST_NONSHM	3 removed.  */
#define GOMP_DEVICE_NOT_HOST		4
#define GOMP_DEVICE_NVIDIA_PTX		5
#define GOMP_DEVICE_INTEL_MIC		6
#define GOMP_DEVICE_HSA			7

#define GOMP_DEVICE_ICV			-1
#define GOMP_DEVICE_HOST_FALLBACK	-2

/* GOMP_task/GOMP_taskloop* flags argument.  */
#define GOMP_TASK_FLAG_UNTIED		(1 << 0)
#define GOMP_TASK_FLAG_FINAL		(1 << 1)
#define GOMP_TASK_FLAG_MERGEABLE	(1 << 2)
#define GOMP_TASK_FLAG_DEPEND		(1 << 3)
#define GOMP_TASK_FLAG_PRIORITY		(1 << 4)
#define GOMP_TASK_FLAG_UP		(1 << 8)
#define GOMP_TASK_FLAG_GRAINSIZE	(1 << 9)
#define GOMP_TASK_FLAG_IF		(1 << 10)
#define GOMP_TASK_FLAG_NOGROUP		(1 << 11)
#define GOMP_TASK_FLAG_REDUCTION	(1 << 12)

/* GOMP_target{_ext,update_ext,enter_exit_data} flags argument.  */
#define GOMP_TARGET_FLAG_NOWAIT		(1 << 0)
#define GOMP_TARGET_FLAG_EXIT_DATA	(1 << 1)
/* Internal to libgomp.  */
#define GOMP_TARGET_FLAG_UPDATE		(1U << 31)


/* OpenACC construct flags.  */

/* Force host fallback execution.  */
#define GOACC_FLAG_HOST_FALLBACK	(1 << 0)

/* For legacy reasons, in the ABI, the GOACC_FLAGs are encoded as an inverted
   bitmask.  */
#define GOACC_FLAGS_MARSHAL_OP		BIT_NOT_EXPR
#define GOACC_FLAGS_UNMARSHAL(X)	(~(X))


/* Versions of libgomp and device-specific plugins.  GOMP_VERSION
   should be incremented whenever an ABI-incompatible change is introduced
   to the plugin interface defined in libgomp/libgomp.h.  */
#define GOMP_VERSION	1
#define GOMP_VERSION_NVIDIA_PTX 1
#define GOMP_VERSION_INTEL_MIC 0
#define GOMP_VERSION_HSA 0

#define GOMP_VERSION_PACK(LIB, DEV) (((LIB) << 16) | (DEV))
#define GOMP_VERSION_LIB(PACK) (((PACK) >> 16) & 0xffff)
#define GOMP_VERSION_DEV(PACK) ((PACK) & 0xffff)

#define GOMP_DIM_GANG	0
#define GOMP_DIM_WORKER	1
#define GOMP_DIM_VECTOR	2
#define GOMP_DIM_MAX	3
#define GOMP_DIM_MASK(X) (1u << (X))

/* Varadic launch arguments.  End of list is marked by a zero.  */
#define GOMP_LAUNCH_DIM		1  /* Launch dimensions, op = mask */
#define GOMP_LAUNCH_ASYNC	2  /* Async, op = cst val if not MAX  */
#define GOMP_LAUNCH_WAIT	3  /* Waits, op = num waits.  */
#define GOMP_LAUNCH_CODE_SHIFT	28
#define GOMP_LAUNCH_DEVICE_SHIFT 16
#define GOMP_LAUNCH_OP_SHIFT 0
#define GOMP_LAUNCH_PACK(CODE,DEVICE,OP)	\
  (((CODE) << GOMP_LAUNCH_CODE_SHIFT)		\
   | ((DEVICE) << GOMP_LAUNCH_DEVICE_SHIFT)	\
   | ((OP) << GOMP_LAUNCH_OP_SHIFT))
#define GOMP_LAUNCH_CODE(X) (((X) >> GOMP_LAUNCH_CODE_SHIFT) & 0xf)
#define GOMP_LAUNCH_DEVICE(X) (((X) >> GOMP_LAUNCH_DEVICE_SHIFT) & 0xfff)
#define GOMP_LAUNCH_OP(X) (((X) >> GOMP_LAUNCH_OP_SHIFT) & 0xffff)
#define GOMP_LAUNCH_OP_MAX 0xffff

/* Bitmask to apply in order to find out the intended device of a target
   argument.  */
#define GOMP_TARGET_ARG_DEVICE_MASK		((1 << 7) - 1)
/* The target argument is significant for all devices.  */
#define GOMP_TARGET_ARG_DEVICE_ALL		0

/* Flag set when the subsequent element in the device-specific argument
   values.  */
#define GOMP_TARGET_ARG_SUBSEQUENT_PARAM	(1 << 7)

/* Bitmask to apply to a target argument to find out the value identifier.  */
#define GOMP_TARGET_ARG_ID_MASK			(((1 << 8) - 1) << 8)
/* Target argument index of NUM_TEAMS.  */
#define GOMP_TARGET_ARG_NUM_TEAMS		(1 << 8)
/* Target argument index of THREAD_LIMIT.  */
#define GOMP_TARGET_ARG_THREAD_LIMIT		(2 << 8)

/* If the value is directly embeded in target argument, it should be a 16-bit
   at most and shifted by this many bits.  */
#define GOMP_TARGET_ARG_VALUE_SHIFT		16

/* Dependence types in omp_depend_t objects.  */
#define GOMP_DEPEND_IN			1
#define GOMP_DEPEND_OUT			2
#define GOMP_DEPEND_INOUT		3
#define GOMP_DEPEND_MUTEXINOUTSET	4

/* HSA specific data structures.  */

/* Identifiers of device-specific target arguments.  */
#define GOMP_TARGET_ARG_HSA_KERNEL_ATTRIBUTES	(1 << 8)

#endif
Commit	Line	Data
ca4c3545	1	/* Communication between GCC and libgomp.
ca4c3545	2
fbd26352	3	Copyright (C) 2014-2019 Free Software Foundation, Inc.
ca4c3545	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)
9561765e	42	#define GOMP_MAP_FLAG_SPECIAL_2 (1 << 4)
ca4c3545	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. */
5cb6b0b9	70	GOMP_MAP_DELETE = (GOMP_MAP_FLAG_SPECIAL_0 \| 3),
ca4c3545	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),
2fc5e987	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),
2a0899ea	78	/* Do not map, copy bits for firstprivate instead. */
43895be5	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),
ca4c3545	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. */
43895be5	98	GOMP_MAP_FORCE_TOFROM = (GOMP_MAP_FLAG_FORCE \| GOMP_MAP_TOFROM),
	99	/* If not already present, allocate. And unconditionally copy to
	100	device. */
9561765e	101	GOMP_MAP_ALWAYS_TO = (GOMP_MAP_FLAG_SPECIAL_2 \| GOMP_MAP_TO),
43895be5	102	/* If not already present, allocate. And unconditionally copy from
43895be5	103	device. */
9561765e	104	GOMP_MAP_ALWAYS_FROM = (GOMP_MAP_FLAG_SPECIAL_2
9561765e	105	\| GOMP_MAP_FROM),
43895be5	106	/* If not already present, allocate. And unconditionally copy to and from
43895be5	107	device. */
9561765e	108	GOMP_MAP_ALWAYS_TOFROM = (GOMP_MAP_FLAG_SPECIAL_2
9561765e	109	\| GOMP_MAP_TOFROM),
43895be5	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). */
9561765e	116	GOMP_MAP_STRUCT = (GOMP_MAP_FLAG_SPECIAL_2
43895be5	117	\| GOMP_MAP_FLAG_SPECIAL \| 0),
9561765e	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),
43895be5	123	/* Forced deallocation of zero length array section. */
43895be5	124	GOMP_MAP_DELETE_ZERO_LEN_ARRAY_SECTION
9561765e	125	= (GOMP_MAP_FLAG_SPECIAL_2
43895be5	126	\| GOMP_MAP_FLAG_SPECIAL \| 3),
43895be5	127	/* Decrement usage count and deallocate if zero. */
9561765e	128	GOMP_MAP_RELEASE = (GOMP_MAP_FLAG_SPECIAL_2
5cb6b0b9	129	\| GOMP_MAP_DELETE),
43895be5	130
	131	/* Internal to GCC, not used in libgomp. */
	132	/* Do not map, but pointer assign a pointer instead. */
9561765e	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)
ca4c3545	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
43895be5	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
9561765e	155	#define GOMP_MAP_ALWAYS_P(X) \
	156	(GOMP_MAP_ALWAYS_TO_P (X) \|\| ((X) == GOMP_MAP_ALWAYS_FROM))
	157
ca4c3545	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
f212338e	168	libgomp/libgomp-plugin.h. */
ca4c3545	169	#define GOMP_DEVICE_NONE 0
	170	#define GOMP_DEVICE_DEFAULT 1
	171	#define GOMP_DEVICE_HOST 2
f212338e	172	/* #define GOMP_DEVICE_HOST_NONSHM 3 removed. */
ca4c3545	173	#define GOMP_DEVICE_NOT_HOST 4
	174	#define GOMP_DEVICE_NVIDIA_PTX 5
	175	#define GOMP_DEVICE_INTEL_MIC 6
56686608	176	#define GOMP_DEVICE_HSA 7
ca4c3545	177
	178	#define GOMP_DEVICE_ICV -1
	179	#define GOMP_DEVICE_HOST_FALLBACK -2
	180
43895be5	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)
7e5a76c8	191	#define GOMP_TASK_FLAG_REDUCTION (1 << 12)
43895be5	192
9561765e	193	/* GOMP_target{_ext,update_ext,enter_exit_data} flags argument. */
43895be5	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
813421cd	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
1802571b	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
e561d5e1	215	#define GOMP_VERSION_NVIDIA_PTX 1
d3d8e632	216	#define GOMP_VERSION_INTEL_MIC 0
56686608	217	#define GOMP_VERSION_HSA 0
d3d8e632	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
e561d5e1	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
56686608	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
7e5a76c8	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
56686608	272	/* HSA specific data structures. */
	273
	274	/* Identifiers of device-specific target arguments. */
	275	#define GOMP_TARGET_ARG_HSA_KERNEL_ATTRIBUTES (1 << 8)
	276
ca4c3545	277	#endif