]>
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 | ||
534b5e00 | 56 | /* Opaque type to represent plugin-dependent implementation of an |
57 | OpenACC asynchronous queue. */ | |
58 | struct goacc_asyncqueue; | |
59 | ||
60 | /* Used to keep a list of active asynchronous queues. */ | |
61 | struct goacc_asyncqueue_list | |
62 | { | |
63 | struct goacc_asyncqueue *aq; | |
64 | struct goacc_asyncqueue_list *next; | |
65 | }; | |
66 | ||
67 | typedef struct goacc_asyncqueue *goacc_aq; | |
68 | typedef struct goacc_asyncqueue_list *goacc_aq_list; | |
69 | ||
0d8c703d | 70 | /* Auxiliary struct, used for transferring pairs of addresses from plugin |
71 | to libgomp. */ | |
72 | struct addr_pair | |
995b27b9 | 73 | { |
0d8c703d | 74 | uintptr_t start; |
75 | uintptr_t end; | |
995b27b9 | 76 | }; |
77 | ||
ca4c3545 | 78 | /* Miscellaneous functions. */ |
79 | extern void *GOMP_PLUGIN_malloc (size_t) __attribute__ ((malloc)); | |
80 | extern void *GOMP_PLUGIN_malloc_cleared (size_t) __attribute__ ((malloc)); | |
81 | extern void *GOMP_PLUGIN_realloc (void *, size_t); | |
a9833286 | 82 | void GOMP_PLUGIN_target_task_completion (void *); |
ca4c3545 | 83 | |
84 | extern void GOMP_PLUGIN_debug (int, const char *, ...) | |
85 | __attribute__ ((format (printf, 2, 3))); | |
86 | extern void GOMP_PLUGIN_error (const char *, ...) | |
87 | __attribute__ ((format (printf, 1, 2))); | |
88 | extern void GOMP_PLUGIN_fatal (const char *, ...) | |
89 | __attribute__ ((noreturn, format (printf, 1, 2))); | |
90 | ||
468af399 | 91 | /* Prototypes for functions implemented by libgomp plugins. */ |
92 | extern const char *GOMP_OFFLOAD_get_name (void); | |
93 | extern unsigned int GOMP_OFFLOAD_get_caps (void); | |
94 | extern int GOMP_OFFLOAD_get_type (void); | |
95 | extern int GOMP_OFFLOAD_get_num_devices (void); | |
96 | extern bool GOMP_OFFLOAD_init_device (int); | |
97 | extern bool GOMP_OFFLOAD_fini_device (int); | |
98 | extern unsigned GOMP_OFFLOAD_version (void); | |
99 | extern int GOMP_OFFLOAD_load_image (int, unsigned, const void *, | |
100 | struct addr_pair **); | |
101 | extern bool GOMP_OFFLOAD_unload_image (int, unsigned, const void *); | |
102 | extern void *GOMP_OFFLOAD_alloc (int, size_t); | |
103 | extern bool GOMP_OFFLOAD_free (int, void *); | |
104 | extern bool GOMP_OFFLOAD_dev2host (int, void *, const void *, size_t); | |
105 | extern bool GOMP_OFFLOAD_host2dev (int, void *, const void *, size_t); | |
106 | extern bool GOMP_OFFLOAD_dev2dev (int, void *, const void *, size_t); | |
107 | extern bool GOMP_OFFLOAD_can_run (void *); | |
108 | extern void GOMP_OFFLOAD_run (int, void *, void *, void **); | |
109 | extern void GOMP_OFFLOAD_async_run (int, void *, void *, void **, void *); | |
534b5e00 | 110 | |
65caa53b | 111 | extern void GOMP_OFFLOAD_openacc_exec (void (*) (void *), size_t, void **, |
534b5e00 | 112 | void **, unsigned *, void *); |
468af399 | 113 | extern void *GOMP_OFFLOAD_openacc_create_thread_data (int); |
114 | extern void GOMP_OFFLOAD_openacc_destroy_thread_data (void *); | |
534b5e00 | 115 | extern struct goacc_asyncqueue *GOMP_OFFLOAD_openacc_async_construct (void); |
116 | extern bool GOMP_OFFLOAD_openacc_async_destruct (struct goacc_asyncqueue *); | |
117 | extern int GOMP_OFFLOAD_openacc_async_test (struct goacc_asyncqueue *); | |
118 | extern bool GOMP_OFFLOAD_openacc_async_synchronize (struct goacc_asyncqueue *); | |
119 | extern bool GOMP_OFFLOAD_openacc_async_serialize (struct goacc_asyncqueue *, | |
120 | struct goacc_asyncqueue *); | |
121 | extern void GOMP_OFFLOAD_openacc_async_queue_callback (struct goacc_asyncqueue *, | |
122 | void (*)(void *), void *); | |
123 | extern void GOMP_OFFLOAD_openacc_async_exec (void (*) (void *), size_t, void **, | |
124 | void **, unsigned *, void *, | |
125 | struct goacc_asyncqueue *); | |
126 | extern bool GOMP_OFFLOAD_openacc_async_dev2host (int, void *, const void *, size_t, | |
127 | struct goacc_asyncqueue *); | |
128 | extern bool GOMP_OFFLOAD_openacc_async_host2dev (int, void *, const void *, size_t, | |
129 | struct goacc_asyncqueue *); | |
65caa53b | 130 | extern void *GOMP_OFFLOAD_openacc_cuda_get_current_device (void); |
131 | extern void *GOMP_OFFLOAD_openacc_cuda_get_current_context (void); | |
534b5e00 | 132 | extern void *GOMP_OFFLOAD_openacc_cuda_get_stream (struct goacc_asyncqueue *); |
133 | extern int GOMP_OFFLOAD_openacc_cuda_set_stream (struct goacc_asyncqueue *, | |
134 | void *); | |
468af399 | 135 | |
ca4c3545 | 136 | #ifdef __cplusplus |
137 | } | |
138 | #endif | |
139 | ||
140 | #endif |