]>
Commit | Line | Data |
---|---|---|
468af399 | 1 | /* The libgomp plugin API. |
2 | ||
fbd26352 | 3 | Copyright (C) 2014-2019 Free Software Foundation, Inc. |
995b27b9 | 4 | |
ca4c3545 | 5 | Contributed by Mentor Embedded. |
6 | ||
c35c9a62 | 7 | This file is part of the GNU Offloading and Multi Processing Library |
8 | (libgomp). | |
995b27b9 | 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 | ||
ca4c3545 | 29 | #ifndef LIBGOMP_PLUGIN_H |
30 | #define LIBGOMP_PLUGIN_H 1 | |
31 | ||
468af399 | 32 | #include <stdbool.h> |
ca4c3545 | 33 | #include <stddef.h> |
34 | #include <stdint.h> | |
35 | ||
36 | #ifdef __cplusplus | |
37 | extern "C" { | |
38 | #endif | |
995b27b9 | 39 | |
ca4c3545 | 40 | /* Capabilities of offloading devices. */ |
41 | #define GOMP_OFFLOAD_CAP_SHARED_MEM (1 << 0) | |
42 | #define GOMP_OFFLOAD_CAP_NATIVE_EXEC (1 << 1) | |
43 | #define GOMP_OFFLOAD_CAP_OPENMP_400 (1 << 2) | |
44 | #define GOMP_OFFLOAD_CAP_OPENACC_200 (1 << 3) | |
45 | ||
46 | /* Type of offload target device. Keep in sync with include/gomp-constants.h. */ | |
995b27b9 | 47 | enum offload_target_type |
48 | { | |
ca4c3545 | 49 | OFFLOAD_TARGET_TYPE_HOST = 2, |
f212338e | 50 | /* OFFLOAD_TARGET_TYPE_HOST_NONSHM = 3 removed. */ |
ca4c3545 | 51 | OFFLOAD_TARGET_TYPE_NVIDIA_PTX = 5, |
56686608 | 52 | OFFLOAD_TARGET_TYPE_INTEL_MIC = 6, |
53 | OFFLOAD_TARGET_TYPE_HSA = 7 | |
995b27b9 | 54 | }; |
55 | ||
0d8c703d | 56 | /* Auxiliary struct, used for transferring pairs of addresses from plugin |
57 | to libgomp. */ | |
58 | struct addr_pair | |
995b27b9 | 59 | { |
0d8c703d | 60 | uintptr_t start; |
61 | uintptr_t end; | |
995b27b9 | 62 | }; |
63 | ||
ca4c3545 | 64 | /* Miscellaneous functions. */ |
65 | extern void *GOMP_PLUGIN_malloc (size_t) __attribute__ ((malloc)); | |
66 | extern void *GOMP_PLUGIN_malloc_cleared (size_t) __attribute__ ((malloc)); | |
67 | extern void *GOMP_PLUGIN_realloc (void *, size_t); | |
a9833286 | 68 | void GOMP_PLUGIN_target_task_completion (void *); |
ca4c3545 | 69 | |
70 | extern void GOMP_PLUGIN_debug (int, const char *, ...) | |
71 | __attribute__ ((format (printf, 2, 3))); | |
72 | extern void GOMP_PLUGIN_error (const char *, ...) | |
73 | __attribute__ ((format (printf, 1, 2))); | |
74 | extern void GOMP_PLUGIN_fatal (const char *, ...) | |
75 | __attribute__ ((noreturn, format (printf, 1, 2))); | |
76 | ||
468af399 | 77 | /* Prototypes for functions implemented by libgomp plugins. */ |
78 | extern const char *GOMP_OFFLOAD_get_name (void); | |
79 | extern unsigned int GOMP_OFFLOAD_get_caps (void); | |
80 | extern int GOMP_OFFLOAD_get_type (void); | |
81 | extern int GOMP_OFFLOAD_get_num_devices (void); | |
82 | extern bool GOMP_OFFLOAD_init_device (int); | |
83 | extern bool GOMP_OFFLOAD_fini_device (int); | |
84 | extern unsigned GOMP_OFFLOAD_version (void); | |
85 | extern int GOMP_OFFLOAD_load_image (int, unsigned, const void *, | |
86 | struct addr_pair **); | |
87 | extern bool GOMP_OFFLOAD_unload_image (int, unsigned, const void *); | |
88 | extern void *GOMP_OFFLOAD_alloc (int, size_t); | |
89 | extern bool GOMP_OFFLOAD_free (int, void *); | |
90 | extern bool GOMP_OFFLOAD_dev2host (int, void *, const void *, size_t); | |
91 | extern bool GOMP_OFFLOAD_host2dev (int, void *, const void *, size_t); | |
92 | extern bool GOMP_OFFLOAD_dev2dev (int, void *, const void *, size_t); | |
93 | extern bool GOMP_OFFLOAD_can_run (void *); | |
94 | extern void GOMP_OFFLOAD_run (int, void *, void *, void **); | |
95 | extern void GOMP_OFFLOAD_async_run (int, void *, void *, void **, void *); | |
65caa53b | 96 | extern void GOMP_OFFLOAD_openacc_exec (void (*) (void *), size_t, void **, |
97 | void **, int, unsigned *, void *); | |
468af399 | 98 | extern void GOMP_OFFLOAD_openacc_register_async_cleanup (void *, int); |
99 | extern int GOMP_OFFLOAD_openacc_async_test (int); | |
100 | extern int GOMP_OFFLOAD_openacc_async_test_all (void); | |
101 | extern void GOMP_OFFLOAD_openacc_async_wait (int); | |
102 | extern void GOMP_OFFLOAD_openacc_async_wait_async (int, int); | |
103 | extern void GOMP_OFFLOAD_openacc_async_wait_all (void); | |
104 | extern void GOMP_OFFLOAD_openacc_async_wait_all_async (int); | |
105 | extern void GOMP_OFFLOAD_openacc_async_set_async (int); | |
106 | extern void *GOMP_OFFLOAD_openacc_create_thread_data (int); | |
107 | extern void GOMP_OFFLOAD_openacc_destroy_thread_data (void *); | |
65caa53b | 108 | extern void *GOMP_OFFLOAD_openacc_cuda_get_current_device (void); |
109 | extern void *GOMP_OFFLOAD_openacc_cuda_get_current_context (void); | |
110 | extern void *GOMP_OFFLOAD_openacc_cuda_get_stream (int); | |
111 | extern int GOMP_OFFLOAD_openacc_cuda_set_stream (int, void *); | |
468af399 | 112 | |
ca4c3545 | 113 | #ifdef __cplusplus |
114 | } | |
115 | #endif | |
116 | ||
117 | #endif |