1/* OpenACC Runtime Library User-facing Declarations
2
3   Copyright (C) 2013-2015 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 _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
38extern "C" {
39#endif
40
41#if __cplusplus >= 201103
42# define __GOACC_NOTHROW noexcept ()
43#elif __cplusplus
44# define __GOACC_NOTHROW throw ()
45#else /* Not C++ */
46# define __GOACC_NOTHROW __attribute__ ((__nothrow__))
47#endif
48
49/* Types */
50typedef enum acc_device_t
51  {
52    /* Keep in sync with include/gomp-constants.h.  */
53    acc_device_none = 0,
54    acc_device_default = 1,
55    acc_device_host = 2,
56    acc_device_host_nonshm = 3,
57    acc_device_not_host = 4,
58    acc_device_nvidia = 5,
59    _ACC_device_hwm
60  } acc_device_t;
61
62typedef enum acc_async_t
63  {
64    /* Keep in sync with include/gomp-constants.h.  */
65    acc_async_noval = -1,
66    acc_async_sync  = -2
67  } acc_async_t;
68
69int acc_get_num_devices (acc_device_t) __GOACC_NOTHROW;
70void acc_set_device_type (acc_device_t) __GOACC_NOTHROW;
71acc_device_t acc_get_device_type (void) __GOACC_NOTHROW;
72void acc_set_device_num (int, acc_device_t) __GOACC_NOTHROW;
73int acc_get_device_num (acc_device_t) __GOACC_NOTHROW;
74int acc_async_test (int) __GOACC_NOTHROW;
75int acc_async_test_all (void) __GOACC_NOTHROW;
76void acc_wait (int) __GOACC_NOTHROW;
77void acc_wait_async (int, int) __GOACC_NOTHROW;
78void acc_wait_all (void) __GOACC_NOTHROW;
79void acc_wait_all_async (int) __GOACC_NOTHROW;
80void acc_init (acc_device_t) __GOACC_NOTHROW;
81void acc_shutdown (acc_device_t) __GOACC_NOTHROW;
82int acc_on_device (acc_device_t) __GOACC_NOTHROW;
83void *acc_malloc (size_t) __GOACC_NOTHROW;
84void acc_free (void *) __GOACC_NOTHROW;
85/* Some of these would be more correct with const qualifiers, but
86   the standard specifies otherwise.  */
87void *acc_copyin (void *, size_t) __GOACC_NOTHROW;
88void *acc_present_or_copyin (void *, size_t) __GOACC_NOTHROW;
89void *acc_create (void *, size_t) __GOACC_NOTHROW;
90void *acc_present_or_create (void *, size_t) __GOACC_NOTHROW;
91void acc_copyout (void *, size_t) __GOACC_NOTHROW;
92void acc_delete (void *, size_t) __GOACC_NOTHROW;
93void acc_update_device (void *, size_t) __GOACC_NOTHROW;
94void acc_update_self (void *, size_t) __GOACC_NOTHROW;
95void acc_map_data (void *, void *, size_t) __GOACC_NOTHROW;
96void acc_unmap_data (void *) __GOACC_NOTHROW;
97void *acc_deviceptr (void *) __GOACC_NOTHROW;
98void *acc_hostptr (void *) __GOACC_NOTHROW;
99int acc_is_present (void *, size_t) __GOACC_NOTHROW;
100void acc_memcpy_to_device (void *, void *, size_t) __GOACC_NOTHROW;
101void acc_memcpy_from_device (void *, void *, size_t) __GOACC_NOTHROW;
102
103/* Old names.  OpenACC does not specify whether these can or must
104   not be macros, inlines or aliases for the new names.  */
105#define acc_pcreate acc_present_or_create
106#define acc_pcopyin acc_present_or_copyin
107
108/* CUDA-specific routines.  */
109void *acc_get_current_cuda_device (void) __GOACC_NOTHROW;
110void *acc_get_current_cuda_context (void) __GOACC_NOTHROW;
111void *acc_get_cuda_stream (int) __GOACC_NOTHROW;
112int acc_set_cuda_stream (int, void *) __GOACC_NOTHROW;
113
114#ifdef __cplusplus
115}
116#endif
117
118#endif /* _OPENACC_H */
119