1 /* OpenACC Runtime Library User-facing Declarations 2 3 Copyright (C) 2013-2016 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 38 extern "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 */ 50 typedef enum acc_device_t { 51 /* Keep in sync with include/gomp-constants.h. */ 52 acc_device_none = 0, 53 acc_device_default = 1, 54 acc_device_host = 2, 55 /* acc_device_host_nonshm = 3 removed. */ 56 acc_device_not_host = 4, 57 acc_device_nvidia = 5, 58 _ACC_device_hwm, 59 /* Ensure enumeration is layout compatible with int. */ 60 _ACC_highest = __INT_MAX__, 61 _ACC_neg = -1 62 } acc_device_t; 63 64 typedef enum acc_async_t { 65 /* Keep in sync with include/gomp-constants.h. */ 66 acc_async_noval = -1, 67 acc_async_sync = -2 68 } acc_async_t; 69 70 int acc_get_num_devices (acc_device_t) __GOACC_NOTHROW; 71 void acc_set_device_type (acc_device_t) __GOACC_NOTHROW; 72 acc_device_t acc_get_device_type (void) __GOACC_NOTHROW; 73 void acc_set_device_num (int, acc_device_t) __GOACC_NOTHROW; 74 int acc_get_device_num (acc_device_t) __GOACC_NOTHROW; 75 int acc_async_test (int) __GOACC_NOTHROW; 76 int acc_async_test_all (void) __GOACC_NOTHROW; 77 void acc_wait (int) __GOACC_NOTHROW; 78 void acc_wait_async (int, int) __GOACC_NOTHROW; 79 void acc_wait_all (void) __GOACC_NOTHROW; 80 void acc_wait_all_async (int) __GOACC_NOTHROW; 81 void acc_init (acc_device_t) __GOACC_NOTHROW; 82 void acc_shutdown (acc_device_t) __GOACC_NOTHROW; 83 #ifdef __cplusplus 84 int acc_on_device (int __arg) __GOACC_NOTHROW; 85 #else 86 int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW; 87 #endif 88 void *acc_malloc (size_t) __GOACC_NOTHROW; 89 void acc_free (void *) __GOACC_NOTHROW; 90 /* Some of these would be more correct with const qualifiers, but 91 the standard specifies otherwise. */ 92 void *acc_copyin (void *, size_t) __GOACC_NOTHROW; 93 void *acc_present_or_copyin (void *, size_t) __GOACC_NOTHROW; 94 void *acc_create (void *, size_t) __GOACC_NOTHROW; 95 void *acc_present_or_create (void *, size_t) __GOACC_NOTHROW; 96 void acc_copyout (void *, size_t) __GOACC_NOTHROW; 97 void acc_delete (void *, size_t) __GOACC_NOTHROW; 98 void acc_update_device (void *, size_t) __GOACC_NOTHROW; 99 void acc_update_self (void *, size_t) __GOACC_NOTHROW; 100 void acc_map_data (void *, void *, size_t) __GOACC_NOTHROW; 101 void acc_unmap_data (void *) __GOACC_NOTHROW; 102 void *acc_deviceptr (void *) __GOACC_NOTHROW; 103 void *acc_hostptr (void *) __GOACC_NOTHROW; 104 int acc_is_present (void *, size_t) __GOACC_NOTHROW; 105 void acc_memcpy_to_device (void *, void *, size_t) __GOACC_NOTHROW; 106 void acc_memcpy_from_device (void *, void *, size_t) __GOACC_NOTHROW; 107 108 /* Old names. OpenACC does not specify whether these can or must 109 not be macros, inlines or aliases for the new names. */ 110 #define acc_pcreate acc_present_or_create 111 #define acc_pcopyin acc_present_or_copyin 112 113 /* CUDA-specific routines. */ 114 void *acc_get_current_cuda_device (void) __GOACC_NOTHROW; 115 void *acc_get_current_cuda_context (void) __GOACC_NOTHROW; 116 void *acc_get_cuda_stream (int) __GOACC_NOTHROW; 117 int acc_set_cuda_stream (int, void *) __GOACC_NOTHROW; 118 119 #ifdef __cplusplus 120 } 121 122 /* Forwarding function with correctly typed arg. */ 123 124 #pragma acc routine seq 125 inline int acc_on_device (acc_device_t __arg) __GOACC_NOTHROW 126 { 127 return acc_on_device ((int) __arg); 128 } 129 #endif 130 131 #endif /* _OPENACC_H */ 132