[thirdparty/gcc.git] / libgomp / openacc.h

/* OpenACC Runtime Library User-facing Declarations

   Copyright (C) 2013-2024 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 _OPENACC_H
#define _OPENACC_H 1

/* The OpenACC standard is silent on whether or not including <openacc.h>
   might or must not include other header files.  We chose to include
   some.  */
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

#if __cplusplus >= 201103
# define __GOACC_NOTHROW noexcept
#elif __cplusplus
# define __GOACC_NOTHROW throw ()
#else /* Not C++ */
# define __GOACC_NOTHROW __attribute__ ((__nothrow__))
#endif

/* Types */
typedef enum acc_device_t {
  /* Keep in sync with include/gomp-constants.h.  */
  acc_device_current = -1,
  acc_device_none = 0,
  acc_device_default = 1,
  acc_device_host = 2,
  /* acc_device_host_nonshm = 3 removed.  */
  acc_device_not_host = 4,
  acc_device_nvidia = 5,
  acc_device_radeon = 8,
  _ACC_device_hwm,
  /* Ensure enumeration is layout compatible with int.  */
  _ACC_highest = __INT_MAX__,
  _ACC_neg = -1
} acc_device_t;

typedef enum acc_device_property_t {
  /* Keep in sync with 'libgomp/libgomp-plugin.h:goacc_property'.  */
  acc_property_memory = 1,
  acc_property_free_memory = 2,
  acc_property_name = 0x10001,
  acc_property_vendor = 0x10002,
  acc_property_driver = 0x10003
} acc_device_property_t;

typedef enum acc_async_t {
  /* Keep in sync with include/gomp-constants.h.  */
  acc_async_noval = -1,
  acc_async_sync  = -2
} acc_async_t;

int acc_get_num_devices (acc_device_t) __GOACC_NOTHROW;
void acc_set_device_type (acc_device_t) __GOACC_NOTHROW;
acc_device_t acc_get_device_type (void) __GOACC_NOTHROW;
void acc_set_device_num (int, acc_device_t) __GOACC_NOTHROW;
int acc_get_device_num (acc_device_t) __GOACC_NOTHROW;
size_t acc_get_property
  (int, acc_device_t, acc_device_property_t) __GOACC_NOTHROW;
const char *acc_get_property_string
  (int, acc_device_t, acc_device_property_t) __GOACC_NOTHROW;
int acc_async_test (int) __GOACC_NOTHROW;
int acc_async_test_all (void) __GOACC_NOTHROW;
void acc_wait (int) __GOACC_NOTHROW;
void acc_async_wait (int) __GOACC_NOTHROW;
void acc_wait_async (int, int) __GOACC_NOTHROW;
void acc_wait_all (void) __GOACC_NOTHROW;
void acc_async_wait_all (void) __GOACC_NOTHROW;
void acc_wait_all_async (int) __GOACC_NOTHROW;
void acc_init (acc_device_t) __GOACC_NOTHROW;
void acc_shutdown (acc_device_t) __GOACC_NOTHROW;
#ifdef __cplusplus
int acc_on_device (int __arg) __GOACC_NOTHROW;
#else
int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW;
#endif
void *acc_malloc (size_t) __GOACC_NOTHROW;
void acc_free (void *) __GOACC_NOTHROW;
/* Some of these would be more correct with const qualifiers, but
   the standard specifies otherwise.  */
void *acc_copyin (void *, size_t) __GOACC_NOTHROW;
void *acc_present_or_copyin (void *, size_t) __GOACC_NOTHROW;
void *acc_pcopyin (void *, size_t) __GOACC_NOTHROW;
void *acc_create (void *, size_t) __GOACC_NOTHROW;
void *acc_present_or_create (void *, size_t) __GOACC_NOTHROW;
void *acc_pcreate (void *, size_t) __GOACC_NOTHROW;
void acc_copyout (void *, size_t) __GOACC_NOTHROW;
void acc_delete (void *, size_t) __GOACC_NOTHROW;
void acc_update_device (void *, size_t) __GOACC_NOTHROW;
void acc_update_self (void *, size_t) __GOACC_NOTHROW;
void acc_map_data (void *, void *, size_t) __GOACC_NOTHROW;
void acc_unmap_data (void *) __GOACC_NOTHROW;
void *acc_deviceptr (void *) __GOACC_NOTHROW;
void *acc_hostptr (void *) __GOACC_NOTHROW;
int acc_is_present (void *, size_t) __GOACC_NOTHROW;
void acc_memcpy_to_device (void *, void *, size_t) __GOACC_NOTHROW;
void acc_memcpy_from_device (void *, void *, size_t) __GOACC_NOTHROW;
void acc_attach (void **) __GOACC_NOTHROW;
void acc_attach_async (void **, int) __GOACC_NOTHROW;
void acc_detach (void **) __GOACC_NOTHROW;
void acc_detach_async (void **, int) __GOACC_NOTHROW;

/* Finalize versions of copyout/delete functions, specified in OpenACC 2.5.  */
void acc_copyout_finalize (void *, size_t) __GOACC_NOTHROW;
void acc_copyout_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_delete_finalize (void *, size_t) __GOACC_NOTHROW;
void acc_delete_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_detach_finalize (void **) __GOACC_NOTHROW;
void acc_detach_finalize_async (void **, int) __GOACC_NOTHROW;

/* Async functions, specified in OpenACC 2.5.  */
void acc_copyin_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_create_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_copyout_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_delete_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_update_device_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_update_self_async (void *, size_t, int) __GOACC_NOTHROW;
void acc_memcpy_to_device_async (void *, void *, size_t, int) __GOACC_NOTHROW;
void acc_memcpy_from_device_async (void *, void *, size_t, int) __GOACC_NOTHROW;

/* CUDA-specific routines.  */
void *acc_get_current_cuda_device (void) __GOACC_NOTHROW;
void *acc_get_current_cuda_context (void) __GOACC_NOTHROW;
void *acc_get_cuda_stream (int) __GOACC_NOTHROW;
int acc_set_cuda_stream (int, void *) __GOACC_NOTHROW;

#ifdef __cplusplus
}

/* Forwarding function with correctly typed arg.  */

#pragma acc routine seq
inline int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW
{
  return acc_on_device ((int) __arg);
}
#endif

#endif /* _OPENACC_H */
Commit	Line	Data
41dbbb37 TS	1	/* OpenACC Runtime Library User-facing Declarations
41dbbb37 TS	2
a945c346	3	Copyright (C) 2013-2024 Free Software Foundation, Inc.
41dbbb37 TS	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 _OPENACC_H
	30	#define _OPENACC_H 1
	31
	32	/* The OpenACC standard is silent on whether or not including <openacc.h>
	33	might or must not include other header files. We chose to include
	34	some. */
	35	#include <stddef.h>
	36
	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
	41	#if __cplusplus >= 201103
1be0899d	42	# define __GOACC_NOTHROW noexcept
41dbbb37 TS	43	#elif __cplusplus
	44	# define __GOACC_NOTHROW throw ()
	45	#else /* Not C++ */
	46	# define __GOACC_NOTHROW __attribute__ ((__nothrow__))
	47	#endif
	48
	49	/* Types */
a0e701d8 NS	50	typedef enum acc_device_t {
a0e701d8 NS	51	/* Keep in sync with include/gomp-constants.h. */
a5d0bc12	52	acc_device_current = -1,
a0e701d8 NS	53	acc_device_none = 0,
	54	acc_device_default = 1,
	55	acc_device_host = 2,
	56	/* acc_device_host_nonshm = 3 removed. */
	57	acc_device_not_host = 4,
	58	acc_device_nvidia = 5,
6687d13a	59	acc_device_radeon = 8,
a0e701d8 NS	60	_ACC_device_hwm,
	61	/* Ensure enumeration is layout compatible with int. */
	62	_ACC_highest = __INT_MAX__,
	63	_ACC_neg = -1
	64	} acc_device_t;
	65
6c84c8bf	66	typedef enum acc_device_property_t {
6fc0385c	67	/* Keep in sync with 'libgomp/libgomp-plugin.h:goacc_property'. */
6c84c8bf MR	68	acc_property_memory = 1,
	69	acc_property_free_memory = 2,
	70	acc_property_name = 0x10001,
	71	acc_property_vendor = 0x10002,
	72	acc_property_driver = 0x10003
	73	} acc_device_property_t;
	74
a0e701d8 NS	75	typedef enum acc_async_t {
	76	/* Keep in sync with include/gomp-constants.h. */
	77	acc_async_noval = -1,
	78	acc_async_sync = -2
	79	} acc_async_t;
41dbbb37 TS	80
	81	int acc_get_num_devices (acc_device_t) __GOACC_NOTHROW;
	82	void acc_set_device_type (acc_device_t) __GOACC_NOTHROW;
	83	acc_device_t acc_get_device_type (void) __GOACC_NOTHROW;
	84	void acc_set_device_num (int, acc_device_t) __GOACC_NOTHROW;
	85	int acc_get_device_num (acc_device_t) __GOACC_NOTHROW;
6c84c8bf MR	86	size_t acc_get_property
	87	(int, acc_device_t, acc_device_property_t) __GOACC_NOTHROW;
	88	const char *acc_get_property_string
	89	(int, acc_device_t, acc_device_property_t) __GOACC_NOTHROW;
41dbbb37 TS	90	int acc_async_test (int) __GOACC_NOTHROW;
	91	int acc_async_test_all (void) __GOACC_NOTHROW;
	92	void acc_wait (int) __GOACC_NOTHROW;
7ce64403	93	void acc_async_wait (int) __GOACC_NOTHROW;
41dbbb37 TS	94	void acc_wait_async (int, int) __GOACC_NOTHROW;
41dbbb37 TS	95	void acc_wait_all (void) __GOACC_NOTHROW;
7ce64403	96	void acc_async_wait_all (void) __GOACC_NOTHROW;
41dbbb37 TS	97	void acc_wait_all_async (int) __GOACC_NOTHROW;
	98	void acc_init (acc_device_t) __GOACC_NOTHROW;
	99	void acc_shutdown (acc_device_t) __GOACC_NOTHROW;
a0e701d8 NS	100	#ifdef __cplusplus
	101	int acc_on_device (int __arg) __GOACC_NOTHROW;
	102	#else
	103	int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW;
	104	#endif
41dbbb37 TS	105	void *acc_malloc (size_t) __GOACC_NOTHROW;
	106	void acc_free (void *) __GOACC_NOTHROW;
	107	/* Some of these would be more correct with const qualifiers, but
	108	the standard specifies otherwise. */
	109	void acc_copyin (void , size_t) __GOACC_NOTHROW;
	110	void acc_present_or_copyin (void , size_t) __GOACC_NOTHROW;
9b94fbc7	111	void acc_pcopyin (void , size_t) __GOACC_NOTHROW;
41dbbb37 TS	112	void acc_create (void , size_t) __GOACC_NOTHROW;
41dbbb37 TS	113	void acc_present_or_create (void , size_t) __GOACC_NOTHROW;
9b94fbc7	114	void acc_pcreate (void , size_t) __GOACC_NOTHROW;
41dbbb37 TS	115	void acc_copyout (void *, size_t) __GOACC_NOTHROW;
	116	void acc_delete (void *, size_t) __GOACC_NOTHROW;
	117	void acc_update_device (void *, size_t) __GOACC_NOTHROW;
	118	void acc_update_self (void *, size_t) __GOACC_NOTHROW;
	119	void acc_map_data (void , void , size_t) __GOACC_NOTHROW;
	120	void acc_unmap_data (void *) __GOACC_NOTHROW;
	121	void acc_deviceptr (void ) __GOACC_NOTHROW;
	122	void acc_hostptr (void ) __GOACC_NOTHROW;
	123	int acc_is_present (void *, size_t) __GOACC_NOTHROW;
	124	void acc_memcpy_to_device (void , void , size_t) __GOACC_NOTHROW;
	125	void acc_memcpy_from_device (void , void , size_t) __GOACC_NOTHROW;
5d5be7bf JB	126	void acc_attach (void **) __GOACC_NOTHROW;
	127	void acc_attach_async (void **, int) __GOACC_NOTHROW;
	128	void acc_detach (void **) __GOACC_NOTHROW;
	129	void acc_detach_async (void **, int) __GOACC_NOTHROW;
41dbbb37	130
829c6349 CLT	131	/* Finalize versions of copyout/delete functions, specified in OpenACC 2.5. */
	132	void acc_copyout_finalize (void *, size_t) __GOACC_NOTHROW;
	133	void acc_copyout_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
	134	void acc_delete_finalize (void *, size_t) __GOACC_NOTHROW;
	135	void acc_delete_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
5d5be7bf JB	136	void acc_detach_finalize (void **) __GOACC_NOTHROW;
5d5be7bf JB	137	void acc_detach_finalize_async (void **, int) __GOACC_NOTHROW;
829c6349	138
58168bbf CLT	139	/* Async functions, specified in OpenACC 2.5. */
	140	void acc_copyin_async (void *, size_t, int) __GOACC_NOTHROW;
	141	void acc_create_async (void *, size_t, int) __GOACC_NOTHROW;
	142	void acc_copyout_async (void *, size_t, int) __GOACC_NOTHROW;
	143	void acc_delete_async (void *, size_t, int) __GOACC_NOTHROW;
	144	void acc_update_device_async (void *, size_t, int) __GOACC_NOTHROW;
	145	void acc_update_self_async (void *, size_t, int) __GOACC_NOTHROW;
	146	void acc_memcpy_to_device_async (void , void , size_t, int) __GOACC_NOTHROW;
	147	void acc_memcpy_from_device_async (void , void , size_t, int) __GOACC_NOTHROW;
	148
41dbbb37 TS	149	/* CUDA-specific routines. */
	150	void *acc_get_current_cuda_device (void) __GOACC_NOTHROW;
	151	void *acc_get_current_cuda_context (void) __GOACC_NOTHROW;
	152	void *acc_get_cuda_stream (int) __GOACC_NOTHROW;
	153	int acc_set_cuda_stream (int, void *) __GOACC_NOTHROW;
	154
	155	#ifdef __cplusplus
	156	}
a0e701d8 NS	157
	158	/* Forwarding function with correctly typed arg. */
	159
e9b596c1	160	#pragma acc routine seq
a0e701d8 NS	161	inline int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW
	162	{
	163	return acc_on_device ((int) __arg);
	164	}
41dbbb37 TS	165	#endif
	166
	167	#endif /* _OPENACC_H */