1*38fd1498Szrj /* The libgomp plugin API. 2*38fd1498Szrj 3*38fd1498Szrj Copyright (C) 2014-2018 Free Software Foundation, Inc. 4*38fd1498Szrj 5*38fd1498Szrj Contributed by Mentor Embedded. 6*38fd1498Szrj 7*38fd1498Szrj This file is part of the GNU Offloading and Multi Processing Library 8*38fd1498Szrj (libgomp). 9*38fd1498Szrj 10*38fd1498Szrj Libgomp is free software; you can redistribute it and/or modify it 11*38fd1498Szrj under the terms of the GNU General Public License as published by 12*38fd1498Szrj the Free Software Foundation; either version 3, or (at your option) 13*38fd1498Szrj any later version. 14*38fd1498Szrj 15*38fd1498Szrj Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY 16*38fd1498Szrj WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 17*38fd1498Szrj FOR A PARTICULAR PURPOSE. See the GNU General Public License for 18*38fd1498Szrj more details. 19*38fd1498Szrj 20*38fd1498Szrj Under Section 7 of GPL version 3, you are granted additional 21*38fd1498Szrj permissions described in the GCC Runtime Library Exception, version 22*38fd1498Szrj 3.1, as published by the Free Software Foundation. 23*38fd1498Szrj 24*38fd1498Szrj You should have received a copy of the GNU General Public License and 25*38fd1498Szrj a copy of the GCC Runtime Library Exception along with this program; 26*38fd1498Szrj see the files COPYING3 and COPYING.RUNTIME respectively. If not, see 27*38fd1498Szrj <http://www.gnu.org/licenses/>. */ 28*38fd1498Szrj 29*38fd1498Szrj #ifndef LIBGOMP_PLUGIN_H 30*38fd1498Szrj #define LIBGOMP_PLUGIN_H 1 31*38fd1498Szrj 32*38fd1498Szrj #include <stdbool.h> 33*38fd1498Szrj #include <stddef.h> 34*38fd1498Szrj #include <stdint.h> 35*38fd1498Szrj 36*38fd1498Szrj #ifdef __cplusplus 37*38fd1498Szrj extern "C" { 38*38fd1498Szrj #endif 39*38fd1498Szrj 40*38fd1498Szrj /* Capabilities of offloading devices. */ 41*38fd1498Szrj #define GOMP_OFFLOAD_CAP_SHARED_MEM (1 << 0) 42*38fd1498Szrj #define GOMP_OFFLOAD_CAP_NATIVE_EXEC (1 << 1) 43*38fd1498Szrj #define GOMP_OFFLOAD_CAP_OPENMP_400 (1 << 2) 44*38fd1498Szrj #define GOMP_OFFLOAD_CAP_OPENACC_200 (1 << 3) 45*38fd1498Szrj 46*38fd1498Szrj /* Type of offload target device. Keep in sync with include/gomp-constants.h. */ 47*38fd1498Szrj enum offload_target_type 48*38fd1498Szrj { 49*38fd1498Szrj OFFLOAD_TARGET_TYPE_HOST = 2, 50*38fd1498Szrj /* OFFLOAD_TARGET_TYPE_HOST_NONSHM = 3 removed. */ 51*38fd1498Szrj OFFLOAD_TARGET_TYPE_NVIDIA_PTX = 5, 52*38fd1498Szrj OFFLOAD_TARGET_TYPE_INTEL_MIC = 6, 53*38fd1498Szrj OFFLOAD_TARGET_TYPE_HSA = 7 54*38fd1498Szrj }; 55*38fd1498Szrj 56*38fd1498Szrj /* Auxiliary struct, used for transferring pairs of addresses from plugin 57*38fd1498Szrj to libgomp. */ 58*38fd1498Szrj struct addr_pair 59*38fd1498Szrj { 60*38fd1498Szrj uintptr_t start; 61*38fd1498Szrj uintptr_t end; 62*38fd1498Szrj }; 63*38fd1498Szrj 64*38fd1498Szrj /* Miscellaneous functions. */ 65*38fd1498Szrj extern void *GOMP_PLUGIN_malloc (size_t) __attribute__ ((malloc)); 66*38fd1498Szrj extern void *GOMP_PLUGIN_malloc_cleared (size_t) __attribute__ ((malloc)); 67*38fd1498Szrj extern void *GOMP_PLUGIN_realloc (void *, size_t); 68*38fd1498Szrj void GOMP_PLUGIN_target_task_completion (void *); 69*38fd1498Szrj 70*38fd1498Szrj extern void GOMP_PLUGIN_debug (int, const char *, ...) 71*38fd1498Szrj __attribute__ ((format (printf, 2, 3))); 72*38fd1498Szrj extern void GOMP_PLUGIN_error (const char *, ...) 73*38fd1498Szrj __attribute__ ((format (printf, 1, 2))); 74*38fd1498Szrj extern void GOMP_PLUGIN_fatal (const char *, ...) 75*38fd1498Szrj __attribute__ ((noreturn, format (printf, 1, 2))); 76*38fd1498Szrj 77*38fd1498Szrj /* Prototypes for functions implemented by libgomp plugins. */ 78*38fd1498Szrj extern const char *GOMP_OFFLOAD_get_name (void); 79*38fd1498Szrj extern unsigned int GOMP_OFFLOAD_get_caps (void); 80*38fd1498Szrj extern int GOMP_OFFLOAD_get_type (void); 81*38fd1498Szrj extern int GOMP_OFFLOAD_get_num_devices (void); 82*38fd1498Szrj extern bool GOMP_OFFLOAD_init_device (int); 83*38fd1498Szrj extern bool GOMP_OFFLOAD_fini_device (int); 84*38fd1498Szrj extern unsigned GOMP_OFFLOAD_version (void); 85*38fd1498Szrj extern int GOMP_OFFLOAD_load_image (int, unsigned, const void *, 86*38fd1498Szrj struct addr_pair **); 87*38fd1498Szrj extern bool GOMP_OFFLOAD_unload_image (int, unsigned, const void *); 88*38fd1498Szrj extern void *GOMP_OFFLOAD_alloc (int, size_t); 89*38fd1498Szrj extern bool GOMP_OFFLOAD_free (int, void *); 90*38fd1498Szrj extern bool GOMP_OFFLOAD_dev2host (int, void *, const void *, size_t); 91*38fd1498Szrj extern bool GOMP_OFFLOAD_host2dev (int, void *, const void *, size_t); 92*38fd1498Szrj extern bool GOMP_OFFLOAD_dev2dev (int, void *, const void *, size_t); 93*38fd1498Szrj extern bool GOMP_OFFLOAD_can_run (void *); 94*38fd1498Szrj extern void GOMP_OFFLOAD_run (int, void *, void *, void **); 95*38fd1498Szrj extern void GOMP_OFFLOAD_async_run (int, void *, void *, void **, void *); 96*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_exec (void (*) (void *), size_t, void **, 97*38fd1498Szrj void **, int, unsigned *, void *); 98*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_register_async_cleanup (void *, int); 99*38fd1498Szrj extern int GOMP_OFFLOAD_openacc_async_test (int); 100*38fd1498Szrj extern int GOMP_OFFLOAD_openacc_async_test_all (void); 101*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_async_wait (int); 102*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_async_wait_async (int, int); 103*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_async_wait_all (void); 104*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_async_wait_all_async (int); 105*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_async_set_async (int); 106*38fd1498Szrj extern void *GOMP_OFFLOAD_openacc_create_thread_data (int); 107*38fd1498Szrj extern void GOMP_OFFLOAD_openacc_destroy_thread_data (void *); 108*38fd1498Szrj extern void *GOMP_OFFLOAD_openacc_cuda_get_current_device (void); 109*38fd1498Szrj extern void *GOMP_OFFLOAD_openacc_cuda_get_current_context (void); 110*38fd1498Szrj extern void *GOMP_OFFLOAD_openacc_cuda_get_stream (int); 111*38fd1498Szrj extern int GOMP_OFFLOAD_openacc_cuda_set_stream (int, void *); 112*38fd1498Szrj 113*38fd1498Szrj #ifdef __cplusplus 114*38fd1498Szrj } 115*38fd1498Szrj #endif 116*38fd1498Szrj 117*38fd1498Szrj #endif 118