annotate libgomp/openacc.h @ 136:4627f235cf2a

fix c-next example
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Thu, 08 Nov 2018 14:11:56 +0900
parents 84e7813d76e9
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 /* OpenACC Runtime Library User-facing Declarations
kono
parents:
diff changeset
2
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
3 Copyright (C) 2013-2018 Free Software Foundation, Inc.
111
kono
parents:
diff changeset
4
kono
parents:
diff changeset
5 Contributed by Mentor Embedded.
kono
parents:
diff changeset
6
kono
parents:
diff changeset
7 This file is part of the GNU Offloading and Multi Processing Library
kono
parents:
diff changeset
8 (libgomp).
kono
parents:
diff changeset
9
kono
parents:
diff changeset
10 Libgomp is free software; you can redistribute it and/or modify it
kono
parents:
diff changeset
11 under the terms of the GNU General Public License as published by
kono
parents:
diff changeset
12 the Free Software Foundation; either version 3, or (at your option)
kono
parents:
diff changeset
13 any later version.
kono
parents:
diff changeset
14
kono
parents:
diff changeset
15 Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
kono
parents:
diff changeset
16 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
kono
parents:
diff changeset
17 FOR A PARTICULAR PURPOSE. See the GNU General Public License for
kono
parents:
diff changeset
18 more details.
kono
parents:
diff changeset
19
kono
parents:
diff changeset
20 Under Section 7 of GPL version 3, you are granted additional
kono
parents:
diff changeset
21 permissions described in the GCC Runtime Library Exception, version
kono
parents:
diff changeset
22 3.1, as published by the Free Software Foundation.
kono
parents:
diff changeset
23
kono
parents:
diff changeset
24 You should have received a copy of the GNU General Public License and
kono
parents:
diff changeset
25 a copy of the GCC Runtime Library Exception along with this program;
kono
parents:
diff changeset
26 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
kono
parents:
diff changeset
27 <http://www.gnu.org/licenses/>. */
kono
parents:
diff changeset
28
kono
parents:
diff changeset
29 #ifndef _OPENACC_H
kono
parents:
diff changeset
30 #define _OPENACC_H 1
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 /* The OpenACC standard is silent on whether or not including <openacc.h>
kono
parents:
diff changeset
33 might or must not include other header files. We chose to include
kono
parents:
diff changeset
34 some. */
kono
parents:
diff changeset
35 #include <stddef.h>
kono
parents:
diff changeset
36
kono
parents:
diff changeset
37 #ifdef __cplusplus
kono
parents:
diff changeset
38 extern "C" {
kono
parents:
diff changeset
39 #endif
kono
parents:
diff changeset
40
kono
parents:
diff changeset
41 #if __cplusplus >= 201103
kono
parents:
diff changeset
42 # define __GOACC_NOTHROW noexcept
kono
parents:
diff changeset
43 #elif __cplusplus
kono
parents:
diff changeset
44 # define __GOACC_NOTHROW throw ()
kono
parents:
diff changeset
45 #else /* Not C++ */
kono
parents:
diff changeset
46 # define __GOACC_NOTHROW __attribute__ ((__nothrow__))
kono
parents:
diff changeset
47 #endif
kono
parents:
diff changeset
48
kono
parents:
diff changeset
49 /* Types */
kono
parents:
diff changeset
50 typedef enum acc_device_t {
kono
parents:
diff changeset
51 /* Keep in sync with include/gomp-constants.h. */
kono
parents:
diff changeset
52 acc_device_none = 0,
kono
parents:
diff changeset
53 acc_device_default = 1,
kono
parents:
diff changeset
54 acc_device_host = 2,
kono
parents:
diff changeset
55 /* acc_device_host_nonshm = 3 removed. */
kono
parents:
diff changeset
56 acc_device_not_host = 4,
kono
parents:
diff changeset
57 acc_device_nvidia = 5,
kono
parents:
diff changeset
58 _ACC_device_hwm,
kono
parents:
diff changeset
59 /* Ensure enumeration is layout compatible with int. */
kono
parents:
diff changeset
60 _ACC_highest = __INT_MAX__,
kono
parents:
diff changeset
61 _ACC_neg = -1
kono
parents:
diff changeset
62 } acc_device_t;
kono
parents:
diff changeset
63
kono
parents:
diff changeset
64 typedef enum acc_async_t {
kono
parents:
diff changeset
65 /* Keep in sync with include/gomp-constants.h. */
kono
parents:
diff changeset
66 acc_async_noval = -1,
kono
parents:
diff changeset
67 acc_async_sync = -2
kono
parents:
diff changeset
68 } acc_async_t;
kono
parents:
diff changeset
69
kono
parents:
diff changeset
70 int acc_get_num_devices (acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
71 void acc_set_device_type (acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
72 acc_device_t acc_get_device_type (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
73 void acc_set_device_num (int, acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
74 int acc_get_device_num (acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
75 int acc_async_test (int) __GOACC_NOTHROW;
kono
parents:
diff changeset
76 int acc_async_test_all (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
77 void acc_wait (int) __GOACC_NOTHROW;
kono
parents:
diff changeset
78 void acc_async_wait (int) __GOACC_NOTHROW;
kono
parents:
diff changeset
79 void acc_wait_async (int, int) __GOACC_NOTHROW;
kono
parents:
diff changeset
80 void acc_wait_all (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
81 void acc_async_wait_all (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
82 void acc_wait_all_async (int) __GOACC_NOTHROW;
kono
parents:
diff changeset
83 void acc_init (acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
84 void acc_shutdown (acc_device_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
85 #ifdef __cplusplus
kono
parents:
diff changeset
86 int acc_on_device (int __arg) __GOACC_NOTHROW;
kono
parents:
diff changeset
87 #else
kono
parents:
diff changeset
88 int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW;
kono
parents:
diff changeset
89 #endif
kono
parents:
diff changeset
90 void *acc_malloc (size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
91 void acc_free (void *) __GOACC_NOTHROW;
kono
parents:
diff changeset
92 /* Some of these would be more correct with const qualifiers, but
kono
parents:
diff changeset
93 the standard specifies otherwise. */
kono
parents:
diff changeset
94 void *acc_copyin (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
95 void *acc_present_or_copyin (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
96 void *acc_pcopyin (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
97 void *acc_create (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
98 void *acc_present_or_create (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
99 void *acc_pcreate (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
100 void acc_copyout (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
101 void acc_delete (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
102 void acc_update_device (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
103 void acc_update_self (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
104 void acc_map_data (void *, void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
105 void acc_unmap_data (void *) __GOACC_NOTHROW;
kono
parents:
diff changeset
106 void *acc_deviceptr (void *) __GOACC_NOTHROW;
kono
parents:
diff changeset
107 void *acc_hostptr (void *) __GOACC_NOTHROW;
kono
parents:
diff changeset
108 int acc_is_present (void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
109 void acc_memcpy_to_device (void *, void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
110 void acc_memcpy_from_device (void *, void *, size_t) __GOACC_NOTHROW;
kono
parents:
diff changeset
111
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
112 /* Finalize versions of copyout/delete functions, specified in OpenACC 2.5. */
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
113 void acc_copyout_finalize (void *, size_t) __GOACC_NOTHROW;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
114 void acc_copyout_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
115 void acc_delete_finalize (void *, size_t) __GOACC_NOTHROW;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
116 void acc_delete_finalize_async (void *, size_t, int) __GOACC_NOTHROW;
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
117
111
kono
parents:
diff changeset
118 /* CUDA-specific routines. */
kono
parents:
diff changeset
119 void *acc_get_current_cuda_device (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
120 void *acc_get_current_cuda_context (void) __GOACC_NOTHROW;
kono
parents:
diff changeset
121 void *acc_get_cuda_stream (int) __GOACC_NOTHROW;
kono
parents:
diff changeset
122 int acc_set_cuda_stream (int, void *) __GOACC_NOTHROW;
kono
parents:
diff changeset
123
kono
parents:
diff changeset
124 #ifdef __cplusplus
kono
parents:
diff changeset
125 }
kono
parents:
diff changeset
126
kono
parents:
diff changeset
127 /* Forwarding function with correctly typed arg. */
kono
parents:
diff changeset
128
kono
parents:
diff changeset
129 #pragma acc routine seq
kono
parents:
diff changeset
130 inline int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW
kono
parents:
diff changeset
131 {
kono
parents:
diff changeset
132 return acc_on_device ((int) __arg);
kono
parents:
diff changeset
133 }
kono
parents:
diff changeset
134 #endif
kono
parents:
diff changeset
135
kono
parents:
diff changeset
136 #endif /* _OPENACC_H */