Daily bump.
[official-gcc.git] / libgomp / oacc-mem.c
blobc21508f3739986631946c4952502e359ccc51421
1 /* OpenACC Runtime initialization routines
3 Copyright (C) 2013-2021 Free Software Foundation, Inc.
5 Contributed by Mentor Embedded.
7 This file is part of the GNU Offloading and Multi Processing Library
8 (libgomp).
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.
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.
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.
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/>. */
29 #include "openacc.h"
30 #include "libgomp.h"
31 #include "gomp-constants.h"
32 #include "oacc-int.h"
33 #include <string.h>
34 #include <assert.h>
36 /* Return block containing [H->S), or NULL if not contained. The device lock
37 for DEV must be locked on entry, and remains locked on exit. */
39 static splay_tree_key
40 lookup_host (struct gomp_device_descr *dev, void *h, size_t s)
42 struct splay_tree_key_s node;
43 splay_tree_key key;
45 node.host_start = (uintptr_t) h;
46 node.host_end = (uintptr_t) h + s;
48 key = splay_tree_lookup (&dev->mem_map, &node);
50 return key;
53 /* Helper for lookup_dev. Iterate over splay tree. */
55 static splay_tree_key
56 lookup_dev_1 (splay_tree_node node, uintptr_t d, size_t s)
58 splay_tree_key key = &node->key;
59 if (d >= key->tgt->tgt_start && d + s <= key->tgt->tgt_end)
60 return key;
62 key = NULL;
63 if (node->left)
64 key = lookup_dev_1 (node->left, d, s);
65 if (!key && node->right)
66 key = lookup_dev_1 (node->right, d, s);
68 return key;
71 /* Return block containing [D->S), or NULL if not contained.
73 This iterates over the splay tree. This is not expected to be a common
74 operation.
76 The device lock associated with MEM_MAP must be locked on entry, and remains
77 locked on exit. */
79 static splay_tree_key
80 lookup_dev (splay_tree mem_map, void *d, size_t s)
82 if (!mem_map || !mem_map->root)
83 return NULL;
85 return lookup_dev_1 (mem_map->root, (uintptr_t) d, s);
89 /* OpenACC is silent on how memory exhaustion is indicated. We return
90 NULL. */
92 void *
93 acc_malloc (size_t s)
95 if (!s)
96 return NULL;
98 goacc_lazy_initialize ();
100 struct goacc_thread *thr = goacc_thread ();
102 assert (thr->dev);
104 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
105 return malloc (s);
107 acc_prof_info prof_info;
108 acc_api_info api_info;
109 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
111 void *res = thr->dev->alloc_func (thr->dev->target_id, s);
113 if (profiling_p)
115 thr->prof_info = NULL;
116 thr->api_info = NULL;
119 return res;
122 void
123 acc_free (void *d)
125 splay_tree_key k;
127 if (!d)
128 return;
130 struct goacc_thread *thr = goacc_thread ();
132 assert (thr && thr->dev);
134 struct gomp_device_descr *acc_dev = thr->dev;
136 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
137 return free (d);
139 acc_prof_info prof_info;
140 acc_api_info api_info;
141 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
143 gomp_mutex_lock (&acc_dev->lock);
145 /* We don't have to call lazy open here, as the ptr value must have
146 been returned by acc_malloc. It's not permitted to pass NULL in
147 (unless you got that null from acc_malloc). */
148 if ((k = lookup_dev (&acc_dev->mem_map, d, 1)))
150 void *offset = d - k->tgt->tgt_start + k->tgt_offset;
151 void *h = k->host_start + offset;
152 size_t h_size = k->host_end - k->host_start;
153 gomp_mutex_unlock (&acc_dev->lock);
154 /* PR92503 "[OpenACC] Behavior of 'acc_free' if the memory space is still
155 used in a mapping". */
156 gomp_fatal ("refusing to free device memory space at %p that is still"
157 " mapped at [%p,+%d]",
158 d, h, (int) h_size);
160 else
161 gomp_mutex_unlock (&acc_dev->lock);
163 if (!acc_dev->free_func (acc_dev->target_id, d))
164 gomp_fatal ("error in freeing device memory in %s", __FUNCTION__);
166 if (profiling_p)
168 thr->prof_info = NULL;
169 thr->api_info = NULL;
173 static void
174 memcpy_tofrom_device (bool from, void *d, void *h, size_t s, int async,
175 const char *libfnname)
177 /* No need to call lazy open here, as the device pointer must have
178 been obtained from a routine that did that. */
179 struct goacc_thread *thr = goacc_thread ();
181 assert (thr && thr->dev);
183 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
185 if (from)
186 memmove (h, d, s);
187 else
188 memmove (d, h, s);
189 return;
192 acc_prof_info prof_info;
193 acc_api_info api_info;
194 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
195 if (profiling_p)
197 prof_info.async = async;
198 prof_info.async_queue = prof_info.async;
201 goacc_aq aq = get_goacc_asyncqueue (async);
202 if (from)
203 gomp_copy_dev2host (thr->dev, aq, h, d, s);
204 else
205 gomp_copy_host2dev (thr->dev, aq, d, h, s, /* TODO: cbuf? */ NULL);
207 if (profiling_p)
209 thr->prof_info = NULL;
210 thr->api_info = NULL;
214 void
215 acc_memcpy_to_device (void *d, void *h, size_t s)
217 memcpy_tofrom_device (false, d, h, s, acc_async_sync, __FUNCTION__);
220 void
221 acc_memcpy_to_device_async (void *d, void *h, size_t s, int async)
223 memcpy_tofrom_device (false, d, h, s, async, __FUNCTION__);
226 void
227 acc_memcpy_from_device (void *h, void *d, size_t s)
229 memcpy_tofrom_device (true, d, h, s, acc_async_sync, __FUNCTION__);
232 void
233 acc_memcpy_from_device_async (void *h, void *d, size_t s, int async)
235 memcpy_tofrom_device (true, d, h, s, async, __FUNCTION__);
238 /* Return the device pointer that corresponds to host data H. Or NULL
239 if no mapping. */
241 void *
242 acc_deviceptr (void *h)
244 splay_tree_key n;
245 void *d;
246 void *offset;
248 goacc_lazy_initialize ();
250 struct goacc_thread *thr = goacc_thread ();
251 struct gomp_device_descr *dev = thr->dev;
253 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
254 return h;
256 /* In the following, no OpenACC Profiling Interface events can possibly be
257 generated. */
259 gomp_mutex_lock (&dev->lock);
261 n = lookup_host (dev, h, 1);
263 if (!n)
265 gomp_mutex_unlock (&dev->lock);
266 return NULL;
269 offset = h - n->host_start;
271 d = n->tgt->tgt_start + n->tgt_offset + offset;
273 gomp_mutex_unlock (&dev->lock);
275 return d;
278 /* Return the host pointer that corresponds to device data D. Or NULL
279 if no mapping. */
281 void *
282 acc_hostptr (void *d)
284 splay_tree_key n;
285 void *h;
286 void *offset;
288 goacc_lazy_initialize ();
290 struct goacc_thread *thr = goacc_thread ();
291 struct gomp_device_descr *acc_dev = thr->dev;
293 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
294 return d;
296 /* In the following, no OpenACC Profiling Interface events can possibly be
297 generated. */
299 gomp_mutex_lock (&acc_dev->lock);
301 n = lookup_dev (&acc_dev->mem_map, d, 1);
303 if (!n)
305 gomp_mutex_unlock (&acc_dev->lock);
306 return NULL;
309 offset = d - n->tgt->tgt_start + n->tgt_offset;
311 h = n->host_start + offset;
313 gomp_mutex_unlock (&acc_dev->lock);
315 return h;
318 /* Return 1 if host data [H,+S] is present on the device. */
321 acc_is_present (void *h, size_t s)
323 splay_tree_key n;
325 if (!s || !h)
326 return 0;
328 goacc_lazy_initialize ();
330 struct goacc_thread *thr = goacc_thread ();
331 struct gomp_device_descr *acc_dev = thr->dev;
333 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
334 return h != NULL;
336 /* In the following, no OpenACC Profiling Interface events can possibly be
337 generated. */
339 gomp_mutex_lock (&acc_dev->lock);
341 n = lookup_host (acc_dev, h, s);
343 if (n && ((uintptr_t)h < n->host_start
344 || (uintptr_t)h + s > n->host_end
345 || s > n->host_end - n->host_start))
346 n = NULL;
348 gomp_mutex_unlock (&acc_dev->lock);
350 return n != NULL;
353 /* Create a mapping for host [H,+S] -> device [D,+S] */
355 void
356 acc_map_data (void *h, void *d, size_t s)
358 size_t mapnum = 1;
359 void *hostaddrs = h;
360 void *devaddrs = d;
361 size_t sizes = s;
362 unsigned short kinds = GOMP_MAP_ALLOC;
364 goacc_lazy_initialize ();
366 struct goacc_thread *thr = goacc_thread ();
367 struct gomp_device_descr *acc_dev = thr->dev;
369 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
371 if (d != h)
372 gomp_fatal ("cannot map data on shared-memory system");
374 else
376 struct goacc_thread *thr = goacc_thread ();
378 if (!d || !h || !s)
379 gomp_fatal ("[%p,+%d]->[%p,+%d] is a bad map",
380 (void *)h, (int)s, (void *)d, (int)s);
382 acc_prof_info prof_info;
383 acc_api_info api_info;
384 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
386 gomp_mutex_lock (&acc_dev->lock);
388 if (lookup_host (acc_dev, h, s))
390 gomp_mutex_unlock (&acc_dev->lock);
391 gomp_fatal ("host address [%p, +%d] is already mapped", (void *)h,
392 (int)s);
395 if (lookup_dev (&thr->dev->mem_map, d, s))
397 gomp_mutex_unlock (&acc_dev->lock);
398 gomp_fatal ("device address [%p, +%d] is already mapped", (void *)d,
399 (int)s);
402 gomp_mutex_unlock (&acc_dev->lock);
404 struct target_mem_desc *tgt
405 = goacc_map_vars (acc_dev, NULL, mapnum, &hostaddrs, &devaddrs, &sizes,
406 &kinds, true, GOMP_MAP_VARS_ENTER_DATA);
407 assert (tgt);
408 assert (tgt->list_count == 1);
409 splay_tree_key n = tgt->list[0].key;
410 assert (n);
411 assert (n->refcount == 1);
412 assert (n->dynamic_refcount == 0);
413 /* Special reference counting behavior. */
414 n->refcount = REFCOUNT_INFINITY;
416 if (profiling_p)
418 thr->prof_info = NULL;
419 thr->api_info = NULL;
424 void
425 acc_unmap_data (void *h)
427 struct goacc_thread *thr = goacc_thread ();
428 struct gomp_device_descr *acc_dev = thr->dev;
430 /* No need to call lazy open, as the address must have been mapped. */
432 /* This is a no-op on shared-memory targets. */
433 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
434 return;
436 acc_prof_info prof_info;
437 acc_api_info api_info;
438 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
440 gomp_mutex_lock (&acc_dev->lock);
442 splay_tree_key n = lookup_host (acc_dev, h, 1);
444 if (!n)
446 gomp_mutex_unlock (&acc_dev->lock);
447 gomp_fatal ("%p is not a mapped block", (void *)h);
450 size_t host_size = n->host_end - n->host_start;
452 if (n->host_start != (uintptr_t) h)
454 gomp_mutex_unlock (&acc_dev->lock);
455 gomp_fatal ("[%p,%d] surrounds %p",
456 (void *) n->host_start, (int) host_size, (void *) h);
458 /* TODO This currently doesn't catch 'REFCOUNT_INFINITY' usage different from
459 'acc_map_data'. Maybe 'dynamic_refcount' can be used for disambiguating
460 the different 'REFCOUNT_INFINITY' cases, or simply separate
461 'REFCOUNT_INFINITY' values per different usage ('REFCOUNT_ACC_MAP_DATA'
462 etc.)? */
463 else if (n->refcount != REFCOUNT_INFINITY)
465 gomp_mutex_unlock (&acc_dev->lock);
466 gomp_fatal ("refusing to unmap block [%p,+%d] that has not been mapped"
467 " by 'acc_map_data'",
468 (void *) h, (int) host_size);
471 struct target_mem_desc *tgt = n->tgt;
473 if (tgt->refcount == REFCOUNT_INFINITY)
475 gomp_mutex_unlock (&acc_dev->lock);
476 gomp_fatal ("cannot unmap target block");
479 /* Above, we've verified that the mapping must have been set up by
480 'acc_map_data'. */
481 assert (tgt->refcount == 1);
483 /* Nullifying these fields prevents 'gomp_unmap_tgt' via 'gomp_remove_var'
484 from freeing the target memory. */
485 tgt->tgt_end = 0;
486 tgt->to_free = NULL;
488 bool is_tgt_unmapped = gomp_remove_var (acc_dev, n);
489 assert (is_tgt_unmapped);
491 gomp_mutex_unlock (&acc_dev->lock);
493 if (profiling_p)
495 thr->prof_info = NULL;
496 thr->api_info = NULL;
501 /* Helper function to map a single dynamic data item, represented by a single
502 mapping. The acc_dev->lock should be held on entry, and remains locked on
503 exit. */
505 static void *
506 goacc_map_var_existing (struct gomp_device_descr *acc_dev, void *hostaddr,
507 size_t size, splay_tree_key n)
509 assert (n);
511 /* Present. */
512 void *d = (void *) (n->tgt->tgt_start + n->tgt_offset + hostaddr
513 - n->host_start);
515 if (hostaddr + size > (void *) n->host_end)
517 gomp_mutex_unlock (&acc_dev->lock);
518 gomp_fatal ("[%p,+%d] not mapped", hostaddr, (int) size);
521 assert (n->refcount != REFCOUNT_LINK);
522 if (n->refcount != REFCOUNT_INFINITY)
523 n->refcount++;
524 n->dynamic_refcount++;
526 return d;
529 /* Enter dynamic mapping for a single datum. Return the device pointer. */
531 static void *
532 goacc_enter_datum (void **hostaddrs, size_t *sizes, void *kinds, int async)
534 void *d;
535 splay_tree_key n;
537 if (!hostaddrs[0] || !sizes[0])
538 gomp_fatal ("[%p,+%d] is a bad range", hostaddrs[0], (int) sizes[0]);
540 goacc_lazy_initialize ();
542 struct goacc_thread *thr = goacc_thread ();
543 struct gomp_device_descr *acc_dev = thr->dev;
545 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
546 return hostaddrs[0];
548 acc_prof_info prof_info;
549 acc_api_info api_info;
550 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
551 if (profiling_p)
553 prof_info.async = async;
554 prof_info.async_queue = prof_info.async;
557 gomp_mutex_lock (&acc_dev->lock);
559 n = lookup_host (acc_dev, hostaddrs[0], sizes[0]);
560 if (n)
562 d = goacc_map_var_existing (acc_dev, hostaddrs[0], sizes[0], n);
563 gomp_mutex_unlock (&acc_dev->lock);
565 else
567 const size_t mapnum = 1;
569 gomp_mutex_unlock (&acc_dev->lock);
571 goacc_aq aq = get_goacc_asyncqueue (async);
573 struct target_mem_desc *tgt
574 = goacc_map_vars (acc_dev, aq, mapnum, hostaddrs, NULL, sizes,
575 kinds, true, GOMP_MAP_VARS_ENTER_DATA);
576 assert (tgt);
577 assert (tgt->list_count == 1);
578 n = tgt->list[0].key;
579 assert (n);
580 assert (n->refcount == 1);
581 assert (n->dynamic_refcount == 0);
582 n->dynamic_refcount++;
584 d = (void *) tgt->tgt_start;
587 if (profiling_p)
589 thr->prof_info = NULL;
590 thr->api_info = NULL;
593 return d;
596 void *
597 acc_create (void *h, size_t s)
599 unsigned short kinds[1] = { GOMP_MAP_ALLOC };
600 return goacc_enter_datum (&h, &s, &kinds, acc_async_sync);
603 void
604 acc_create_async (void *h, size_t s, int async)
606 unsigned short kinds[1] = { GOMP_MAP_ALLOC };
607 goacc_enter_datum (&h, &s, &kinds, async);
610 /* acc_present_or_create used to be what acc_create is now. */
611 /* acc_pcreate is acc_present_or_create by a different name. */
612 #ifdef HAVE_ATTRIBUTE_ALIAS
613 strong_alias (acc_create, acc_present_or_create)
614 strong_alias (acc_create, acc_pcreate)
615 #else
616 void *
617 acc_present_or_create (void *h, size_t s)
619 return acc_create (h, s);
622 void *
623 acc_pcreate (void *h, size_t s)
625 return acc_create (h, s);
627 #endif
629 void *
630 acc_copyin (void *h, size_t s)
632 unsigned short kinds[1] = { GOMP_MAP_TO };
633 return goacc_enter_datum (&h, &s, &kinds, acc_async_sync);
636 void
637 acc_copyin_async (void *h, size_t s, int async)
639 unsigned short kinds[1] = { GOMP_MAP_TO };
640 goacc_enter_datum (&h, &s, &kinds, async);
643 /* acc_present_or_copyin used to be what acc_copyin is now. */
644 /* acc_pcopyin is acc_present_or_copyin by a different name. */
645 #ifdef HAVE_ATTRIBUTE_ALIAS
646 strong_alias (acc_copyin, acc_present_or_copyin)
647 strong_alias (acc_copyin, acc_pcopyin)
648 #else
649 void *
650 acc_present_or_copyin (void *h, size_t s)
652 return acc_copyin (h, s);
655 void *
656 acc_pcopyin (void *h, size_t s)
658 return acc_copyin (h, s);
660 #endif
663 /* Helper function to unmap a single data item. Device lock should be held on
664 entry, and remains locked on exit. */
666 static void
667 goacc_exit_datum_1 (struct gomp_device_descr *acc_dev, void *h, size_t s,
668 unsigned short kind, splay_tree_key n, goacc_aq aq)
670 assert (kind != GOMP_MAP_DETACH
671 && kind != GOMP_MAP_FORCE_DETACH);
673 if ((uintptr_t) h < n->host_start || (uintptr_t) h + s > n->host_end)
675 size_t host_size = n->host_end - n->host_start;
676 gomp_mutex_unlock (&acc_dev->lock);
677 gomp_fatal ("[%p,+%d] outside mapped block [%p,+%d]",
678 (void *) h, (int) s, (void *) n->host_start, (int) host_size);
681 bool finalize = (kind == GOMP_MAP_FORCE_FROM
682 || kind == GOMP_MAP_DELETE);
684 assert (n->refcount != REFCOUNT_LINK);
685 if (n->refcount != REFCOUNT_INFINITY
686 && n->refcount < n->dynamic_refcount)
688 gomp_mutex_unlock (&acc_dev->lock);
689 gomp_fatal ("Dynamic reference counting assert fail\n");
692 if (finalize)
694 if (n->refcount != REFCOUNT_INFINITY)
695 n->refcount -= n->dynamic_refcount;
696 n->dynamic_refcount = 0;
698 else if (n->dynamic_refcount)
700 if (n->refcount != REFCOUNT_INFINITY)
701 n->refcount--;
702 n->dynamic_refcount--;
705 if (n->refcount == 0)
707 bool copyout = (kind == GOMP_MAP_FROM
708 || kind == GOMP_MAP_FORCE_FROM);
709 if (copyout)
711 void *d = (void *) (n->tgt->tgt_start + n->tgt_offset
712 + (uintptr_t) h - n->host_start);
713 gomp_copy_dev2host (acc_dev, aq, h, d, s);
716 if (aq)
717 /* TODO We can't do the 'is_tgt_unmapped' checking -- see the
718 'gomp_unref_tgt' comment in
719 <http://mid.mail-archive.com/878snl36eu.fsf@euler.schwinge.homeip.net>;
720 PR92881. */
721 gomp_remove_var_async (acc_dev, n, aq);
722 else
724 size_t num_mappings = 0;
725 /* If the target_mem_desc represents a single data mapping, we can
726 check that it is freed when this splay tree key's refcount reaches
727 zero. Otherwise (e.g. for a 'GOMP_MAP_STRUCT' mapping with
728 multiple members), fall back to skipping the test. */
729 for (size_t l_i = 0; l_i < n->tgt->list_count; ++l_i)
730 if (n->tgt->list[l_i].key
731 && !n->tgt->list[l_i].is_attach)
732 ++num_mappings;
733 bool is_tgt_unmapped = gomp_remove_var (acc_dev, n);
734 assert (is_tgt_unmapped || num_mappings > 1);
740 /* Exit a dynamic mapping for a single variable. */
742 static void
743 goacc_exit_datum (void *h, size_t s, unsigned short kind, int async)
745 /* No need to call lazy open, as the data must already have been
746 mapped. */
748 kind &= 0xff;
750 struct goacc_thread *thr = goacc_thread ();
751 struct gomp_device_descr *acc_dev = thr->dev;
753 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
754 return;
756 acc_prof_info prof_info;
757 acc_api_info api_info;
758 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
759 if (profiling_p)
761 prof_info.async = async;
762 prof_info.async_queue = prof_info.async;
765 gomp_mutex_lock (&acc_dev->lock);
767 splay_tree_key n = lookup_host (acc_dev, h, s);
768 /* Non-present data is a no-op: PR92726, RP92970, PR92984. */
769 if (n)
771 goacc_aq aq = get_goacc_asyncqueue (async);
772 goacc_exit_datum_1 (acc_dev, h, s, kind, n, aq);
775 gomp_mutex_unlock (&acc_dev->lock);
777 if (profiling_p)
779 thr->prof_info = NULL;
780 thr->api_info = NULL;
784 void
785 acc_delete (void *h , size_t s)
787 goacc_exit_datum (h, s, GOMP_MAP_RELEASE, acc_async_sync);
790 void
791 acc_delete_async (void *h , size_t s, int async)
793 goacc_exit_datum (h, s, GOMP_MAP_RELEASE, async);
796 void
797 acc_delete_finalize (void *h , size_t s)
799 goacc_exit_datum (h, s, GOMP_MAP_DELETE, acc_async_sync);
802 void
803 acc_delete_finalize_async (void *h , size_t s, int async)
805 goacc_exit_datum (h, s, GOMP_MAP_DELETE, async);
808 void
809 acc_copyout (void *h, size_t s)
811 goacc_exit_datum (h, s, GOMP_MAP_FROM, acc_async_sync);
814 void
815 acc_copyout_async (void *h, size_t s, int async)
817 goacc_exit_datum (h, s, GOMP_MAP_FROM, async);
820 void
821 acc_copyout_finalize (void *h, size_t s)
823 goacc_exit_datum (h, s, GOMP_MAP_FORCE_FROM, acc_async_sync);
826 void
827 acc_copyout_finalize_async (void *h, size_t s, int async)
829 goacc_exit_datum (h, s, GOMP_MAP_FORCE_FROM, async);
832 static void
833 update_dev_host (int is_dev, void *h, size_t s, int async)
835 splay_tree_key n;
836 void *d;
838 goacc_lazy_initialize ();
840 struct goacc_thread *thr = goacc_thread ();
841 struct gomp_device_descr *acc_dev = thr->dev;
843 if (acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
844 return;
846 /* Fortran optional arguments that are non-present result in a
847 NULL host address here. This can safely be ignored as it is
848 not possible to 'update' a non-present optional argument. */
849 if (h == NULL)
850 return;
852 acc_prof_info prof_info;
853 acc_api_info api_info;
854 bool profiling_p = GOACC_PROFILING_SETUP_P (thr, &prof_info, &api_info);
855 if (profiling_p)
857 prof_info.async = async;
858 prof_info.async_queue = prof_info.async;
861 gomp_mutex_lock (&acc_dev->lock);
863 n = lookup_host (acc_dev, h, s);
865 if (!n)
867 gomp_mutex_unlock (&acc_dev->lock);
868 gomp_fatal ("[%p,%d] is not mapped", h, (int)s);
871 d = (void *) (n->tgt->tgt_start + n->tgt_offset
872 + (uintptr_t) h - n->host_start);
874 goacc_aq aq = get_goacc_asyncqueue (async);
876 if (is_dev)
877 gomp_copy_host2dev (acc_dev, aq, d, h, s, /* TODO: cbuf? */ NULL);
878 else
879 gomp_copy_dev2host (acc_dev, aq, h, d, s);
881 gomp_mutex_unlock (&acc_dev->lock);
883 if (profiling_p)
885 thr->prof_info = NULL;
886 thr->api_info = NULL;
890 void
891 acc_update_device (void *h, size_t s)
893 update_dev_host (1, h, s, acc_async_sync);
896 void
897 acc_update_device_async (void *h, size_t s, int async)
899 update_dev_host (1, h, s, async);
902 void
903 acc_update_self (void *h, size_t s)
905 update_dev_host (0, h, s, acc_async_sync);
908 void
909 acc_update_self_async (void *h, size_t s, int async)
911 update_dev_host (0, h, s, async);
914 void
915 acc_attach_async (void **hostaddr, int async)
917 struct goacc_thread *thr = goacc_thread ();
918 struct gomp_device_descr *acc_dev = thr->dev;
919 goacc_aq aq = get_goacc_asyncqueue (async);
921 struct splay_tree_key_s cur_node;
922 splay_tree_key n;
924 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
925 return;
927 gomp_mutex_lock (&acc_dev->lock);
929 cur_node.host_start = (uintptr_t) hostaddr;
930 cur_node.host_end = cur_node.host_start + sizeof (void *);
931 n = splay_tree_lookup (&acc_dev->mem_map, &cur_node);
933 if (n == NULL)
935 gomp_mutex_unlock (&acc_dev->lock);
936 gomp_fatal ("struct not mapped for acc_attach");
939 gomp_attach_pointer (acc_dev, aq, &acc_dev->mem_map, n, (uintptr_t) hostaddr,
940 0, NULL);
942 gomp_mutex_unlock (&acc_dev->lock);
945 void
946 acc_attach (void **hostaddr)
948 acc_attach_async (hostaddr, acc_async_sync);
951 static void
952 goacc_detach_internal (void **hostaddr, int async, bool finalize)
954 struct goacc_thread *thr = goacc_thread ();
955 struct gomp_device_descr *acc_dev = thr->dev;
956 struct splay_tree_key_s cur_node;
957 splay_tree_key n;
958 struct goacc_asyncqueue *aq = get_goacc_asyncqueue (async);
960 if (thr->dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
961 return;
963 gomp_mutex_lock (&acc_dev->lock);
965 cur_node.host_start = (uintptr_t) hostaddr;
966 cur_node.host_end = cur_node.host_start + sizeof (void *);
967 n = splay_tree_lookup (&acc_dev->mem_map, &cur_node);
969 if (n == NULL)
971 gomp_mutex_unlock (&acc_dev->lock);
972 gomp_fatal ("struct not mapped for acc_detach");
975 gomp_detach_pointer (acc_dev, aq, n, (uintptr_t) hostaddr, finalize, NULL);
977 gomp_mutex_unlock (&acc_dev->lock);
980 void
981 acc_detach (void **hostaddr)
983 goacc_detach_internal (hostaddr, acc_async_sync, false);
986 void
987 acc_detach_async (void **hostaddr, int async)
989 goacc_detach_internal (hostaddr, async, false);
992 void
993 acc_detach_finalize (void **hostaddr)
995 goacc_detach_internal (hostaddr, acc_async_sync, true);
998 void
999 acc_detach_finalize_async (void **hostaddr, int async)
1001 goacc_detach_internal (hostaddr, async, true);
1004 /* Some types of (pointer) variables use several consecutive mappings, which
1005 must be treated as a group for enter/exit data directives. This function
1006 returns the last mapping in such a group (inclusive), or POS for singleton
1007 mappings. */
1009 static int
1010 find_group_last (int pos, size_t mapnum, size_t *sizes, unsigned short *kinds)
1012 unsigned char kind0 = kinds[pos] & 0xff;
1013 int first_pos = pos;
1015 switch (kind0)
1017 case GOMP_MAP_TO_PSET:
1018 if (pos + 1 < mapnum
1019 && (kinds[pos + 1] & 0xff) == GOMP_MAP_ATTACH)
1020 return pos + 1;
1022 while (pos + 1 < mapnum
1023 && (kinds[pos + 1] & 0xff) == GOMP_MAP_POINTER)
1024 pos++;
1025 /* We expect at least one GOMP_MAP_POINTER (if not a single
1026 GOMP_MAP_ATTACH) after a GOMP_MAP_TO_PSET. */
1027 assert (pos > first_pos);
1028 break;
1030 case GOMP_MAP_STRUCT:
1031 pos += sizes[pos];
1032 break;
1034 case GOMP_MAP_POINTER:
1035 case GOMP_MAP_ALWAYS_POINTER:
1036 /* These mappings are only expected after some other mapping. If we
1037 see one by itself, something has gone wrong. */
1038 gomp_fatal ("unexpected mapping");
1039 break;
1041 case GOMP_MAP_ATTACH:
1042 break;
1044 default:
1045 /* GOMP_MAP_ALWAYS_POINTER can only appear directly after some other
1046 mapping. */
1047 if (pos + 1 < mapnum)
1049 unsigned char kind1 = kinds[pos + 1] & 0xff;
1050 if (kind1 == GOMP_MAP_ALWAYS_POINTER)
1051 return pos + 1;
1054 /* We can have a single GOMP_MAP_ATTACH mapping after a to/from
1055 mapping. */
1056 if (pos + 1 < mapnum
1057 && (kinds[pos + 1] & 0xff) == GOMP_MAP_ATTACH)
1058 return pos + 1;
1060 /* We can have zero or more GOMP_MAP_POINTER mappings after a to/from
1061 (etc.) mapping. */
1062 while (pos + 1 < mapnum
1063 && (kinds[pos + 1] & 0xff) == GOMP_MAP_POINTER)
1064 pos++;
1067 return pos;
1070 /* Map variables for OpenACC "enter data". We can't just call
1071 goacc_map_vars once, because individual mapped variables might have
1072 "exit data" called for them at different times. */
1074 static void
1075 goacc_enter_data_internal (struct gomp_device_descr *acc_dev, size_t mapnum,
1076 void **hostaddrs, size_t *sizes,
1077 unsigned short *kinds, goacc_aq aq)
1079 gomp_mutex_lock (&acc_dev->lock);
1081 for (size_t i = 0; i < mapnum; i++)
1083 splay_tree_key n;
1084 size_t group_last = find_group_last (i, mapnum, sizes, kinds);
1085 bool struct_p = false;
1086 size_t size, groupnum = (group_last - i) + 1;
1088 switch (kinds[i] & 0xff)
1090 case GOMP_MAP_STRUCT:
1092 size = (uintptr_t) hostaddrs[group_last] + sizes[group_last]
1093 - (uintptr_t) hostaddrs[i];
1094 struct_p = true;
1096 break;
1098 case GOMP_MAP_ATTACH:
1099 size = sizeof (void *);
1100 break;
1102 default:
1103 size = sizes[i];
1106 n = lookup_host (acc_dev, hostaddrs[i], size);
1108 if (n && struct_p)
1110 for (size_t j = i + 1; j <= group_last; j++)
1112 struct splay_tree_key_s cur_node;
1113 cur_node.host_start = (uintptr_t) hostaddrs[j];
1114 cur_node.host_end = cur_node.host_start + sizes[j];
1115 splay_tree_key n2
1116 = splay_tree_lookup (&acc_dev->mem_map, &cur_node);
1117 if (!n2
1118 || n2->tgt != n->tgt
1119 || n2->host_start - n->host_start
1120 != n2->tgt_offset - n->tgt_offset)
1122 gomp_mutex_unlock (&acc_dev->lock);
1123 gomp_fatal ("Trying to map into device [%p..%p) structure "
1124 "element when other mapped elements from the "
1125 "same structure weren't mapped together with "
1126 "it", (void *) cur_node.host_start,
1127 (void *) cur_node.host_end);
1130 /* This is a special case because we must increment the refcount by
1131 the number of mapped struct elements, rather than by one. */
1132 if (n->refcount != REFCOUNT_INFINITY)
1133 n->refcount += groupnum - 1;
1134 n->dynamic_refcount += groupnum - 1;
1136 else if (n && groupnum == 1)
1138 void *h = hostaddrs[i];
1139 size_t s = sizes[i];
1141 if ((kinds[i] & 0xff) == GOMP_MAP_ATTACH)
1143 gomp_attach_pointer (acc_dev, aq, &acc_dev->mem_map, n,
1144 (uintptr_t) h, s, NULL);
1145 /* OpenACC 'attach'/'detach' doesn't affect structured/dynamic
1146 reference counts ('n->refcount', 'n->dynamic_refcount'). */
1148 else
1149 goacc_map_var_existing (acc_dev, h, s, n);
1151 else if (n && groupnum > 1)
1153 assert (n->refcount != REFCOUNT_INFINITY
1154 && n->refcount != REFCOUNT_LINK);
1156 for (size_t j = i + 1; j <= group_last; j++)
1157 if ((kinds[j] & 0xff) == GOMP_MAP_ATTACH)
1159 splay_tree_key m
1160 = lookup_host (acc_dev, hostaddrs[j], sizeof (void *));
1161 gomp_attach_pointer (acc_dev, aq, &acc_dev->mem_map, m,
1162 (uintptr_t) hostaddrs[j], sizes[j], NULL);
1165 bool processed = false;
1167 struct target_mem_desc *tgt = n->tgt;
1168 for (size_t j = 0; j < tgt->list_count; j++)
1169 if (tgt->list[j].key == n)
1171 /* We are processing a group of mappings (e.g.
1172 [GOMP_MAP_TO, GOMP_MAP_TO_PSET, GOMP_MAP_POINTER]).
1173 Find the right group in the target_mem_desc's variable
1174 list, and increment the refcounts for each item in that
1175 group. */
1176 for (size_t k = 0; k < groupnum; k++)
1177 if (j + k < tgt->list_count
1178 && tgt->list[j + k].key
1179 && !tgt->list[j + k].is_attach)
1181 tgt->list[j + k].key->refcount++;
1182 tgt->list[j + k].key->dynamic_refcount++;
1184 processed = true;
1185 break;
1188 if (!processed)
1190 gomp_mutex_unlock (&acc_dev->lock);
1191 gomp_fatal ("dynamic refcount incrementing failed for "
1192 "pointer/pset");
1195 else if (hostaddrs[i])
1197 /* The data is not mapped already. Map it now, unless the first
1198 member in the group has a NULL pointer (e.g. a non-present
1199 optional parameter). */
1200 gomp_mutex_unlock (&acc_dev->lock);
1202 struct target_mem_desc *tgt
1203 = goacc_map_vars (acc_dev, aq, groupnum, &hostaddrs[i], NULL,
1204 &sizes[i], &kinds[i], true,
1205 GOMP_MAP_VARS_ENTER_DATA);
1206 assert (tgt);
1208 gomp_mutex_lock (&acc_dev->lock);
1210 for (size_t j = 0; j < tgt->list_count; j++)
1212 n = tgt->list[j].key;
1213 if (n && !tgt->list[j].is_attach)
1214 n->dynamic_refcount++;
1218 i = group_last;
1221 gomp_mutex_unlock (&acc_dev->lock);
1224 /* Unmap variables for OpenACC "exit data". */
1226 static void
1227 goacc_exit_data_internal (struct gomp_device_descr *acc_dev, size_t mapnum,
1228 void **hostaddrs, size_t *sizes,
1229 unsigned short *kinds, goacc_aq aq)
1231 gomp_mutex_lock (&acc_dev->lock);
1233 /* Handle "detach" before copyback/deletion of mapped data. */
1234 for (size_t i = 0; i < mapnum; ++i)
1236 unsigned char kind = kinds[i] & 0xff;
1237 bool finalize = false;
1238 switch (kind)
1240 case GOMP_MAP_FORCE_DETACH:
1241 finalize = true;
1242 /* Fallthrough. */
1244 case GOMP_MAP_DETACH:
1246 struct splay_tree_key_s cur_node;
1247 uintptr_t hostaddr = (uintptr_t) hostaddrs[i];
1248 cur_node.host_start = hostaddr;
1249 cur_node.host_end = cur_node.host_start + sizeof (void *);
1250 splay_tree_key n
1251 = splay_tree_lookup (&acc_dev->mem_map, &cur_node);
1253 if (n == NULL)
1255 gomp_mutex_unlock (&acc_dev->lock);
1256 gomp_fatal ("struct not mapped for detach operation");
1259 gomp_detach_pointer (acc_dev, aq, n, hostaddr, finalize, NULL);
1261 break;
1262 default:
1267 for (size_t i = 0; i < mapnum; ++i)
1269 unsigned char kind = kinds[i] & 0xff;
1271 switch (kind)
1273 case GOMP_MAP_FROM:
1274 case GOMP_MAP_FORCE_FROM:
1275 case GOMP_MAP_TO_PSET:
1276 case GOMP_MAP_POINTER:
1277 case GOMP_MAP_DELETE:
1278 case GOMP_MAP_RELEASE:
1280 struct splay_tree_key_s cur_node;
1281 size_t size;
1282 if (kind == GOMP_MAP_POINTER)
1283 size = sizeof (void *);
1284 else
1285 size = sizes[i];
1286 cur_node.host_start = (uintptr_t) hostaddrs[i];
1287 cur_node.host_end = cur_node.host_start + size;
1288 splay_tree_key n
1289 = splay_tree_lookup (&acc_dev->mem_map, &cur_node);
1291 if (n == NULL)
1292 continue;
1294 goacc_exit_datum_1 (acc_dev, hostaddrs[i], size, kind, n, aq);
1296 break;
1298 case GOMP_MAP_STRUCT:
1299 /* Skip the 'GOMP_MAP_STRUCT' itself, and use the regular processing
1300 for all its entries. This special handling exists for GCC 10.1
1301 compatibility; afterwards, we're not generating these no-op
1302 'GOMP_MAP_STRUCT's anymore. */
1303 break;
1305 case GOMP_MAP_DETACH:
1306 case GOMP_MAP_FORCE_DETACH:
1307 /* OpenACC 'attach'/'detach' doesn't affect structured/dynamic
1308 reference counts ('n->refcount', 'n->dynamic_refcount'). */
1309 break;
1311 default:
1312 gomp_fatal (">>>> goacc_exit_data_internal UNHANDLED kind 0x%.2x",
1313 kind);
1317 gomp_mutex_unlock (&acc_dev->lock);
1320 static void
1321 goacc_enter_exit_data_internal (int flags_m, size_t mapnum, void **hostaddrs,
1322 size_t *sizes, unsigned short *kinds,
1323 bool data_enter, int async, int num_waits,
1324 va_list *ap)
1326 int flags = GOACC_FLAGS_UNMARSHAL (flags_m);
1328 struct goacc_thread *thr;
1329 struct gomp_device_descr *acc_dev;
1331 goacc_lazy_initialize ();
1333 thr = goacc_thread ();
1334 acc_dev = thr->dev;
1336 bool profiling_p = GOACC_PROFILING_DISPATCH_P (true);
1338 acc_prof_info prof_info;
1339 if (profiling_p)
1341 thr->prof_info = &prof_info;
1343 prof_info.event_type
1344 = data_enter ? acc_ev_enter_data_start : acc_ev_exit_data_start;
1345 prof_info.valid_bytes = _ACC_PROF_INFO_VALID_BYTES;
1346 prof_info.version = _ACC_PROF_INFO_VERSION;
1347 prof_info.device_type = acc_device_type (acc_dev->type);
1348 prof_info.device_number = acc_dev->target_id;
1349 prof_info.thread_id = -1;
1350 prof_info.async = async;
1351 prof_info.async_queue = prof_info.async;
1352 prof_info.src_file = NULL;
1353 prof_info.func_name = NULL;
1354 prof_info.line_no = -1;
1355 prof_info.end_line_no = -1;
1356 prof_info.func_line_no = -1;
1357 prof_info.func_end_line_no = -1;
1359 acc_event_info enter_exit_data_event_info;
1360 if (profiling_p)
1362 enter_exit_data_event_info.other_event.event_type
1363 = prof_info.event_type;
1364 enter_exit_data_event_info.other_event.valid_bytes
1365 = _ACC_OTHER_EVENT_INFO_VALID_BYTES;
1366 enter_exit_data_event_info.other_event.parent_construct
1367 = data_enter ? acc_construct_enter_data : acc_construct_exit_data;
1368 enter_exit_data_event_info.other_event.implicit = 0;
1369 enter_exit_data_event_info.other_event.tool_info = NULL;
1371 acc_api_info api_info;
1372 if (profiling_p)
1374 thr->api_info = &api_info;
1376 api_info.device_api = acc_device_api_none;
1377 api_info.valid_bytes = _ACC_API_INFO_VALID_BYTES;
1378 api_info.device_type = prof_info.device_type;
1379 api_info.vendor = -1;
1380 api_info.device_handle = NULL;
1381 api_info.context_handle = NULL;
1382 api_info.async_handle = NULL;
1385 if (profiling_p)
1386 goacc_profiling_dispatch (&prof_info, &enter_exit_data_event_info,
1387 &api_info);
1389 if ((acc_dev->capabilities & GOMP_OFFLOAD_CAP_SHARED_MEM)
1390 || (flags & GOACC_FLAG_HOST_FALLBACK))
1392 prof_info.device_type = acc_device_host;
1393 api_info.device_type = prof_info.device_type;
1395 goto out_prof;
1398 if (num_waits)
1399 goacc_wait (async, num_waits, ap);
1401 goacc_aq aq = get_goacc_asyncqueue (async);
1403 if (data_enter)
1404 goacc_enter_data_internal (acc_dev, mapnum, hostaddrs, sizes, kinds, aq);
1405 else
1406 goacc_exit_data_internal (acc_dev, mapnum, hostaddrs, sizes, kinds, aq);
1408 out_prof:
1409 if (profiling_p)
1411 prof_info.event_type
1412 = data_enter ? acc_ev_enter_data_end : acc_ev_exit_data_end;
1413 enter_exit_data_event_info.other_event.event_type = prof_info.event_type;
1414 goacc_profiling_dispatch (&prof_info, &enter_exit_data_event_info,
1415 &api_info);
1417 thr->prof_info = NULL;
1418 thr->api_info = NULL;
1422 /* Legacy entry point (GCC 11 and earlier). */
1424 void
1425 GOACC_enter_exit_data (int flags_m, size_t mapnum, void **hostaddrs,
1426 size_t *sizes, unsigned short *kinds, int async,
1427 int num_waits, ...)
1429 /* Determine if this is an OpenACC "enter data". */
1430 bool data_enter = false;
1431 for (size_t i = 0; i < mapnum; ++i)
1433 unsigned char kind = kinds[i] & 0xff;
1435 if (kind == GOMP_MAP_POINTER
1436 || kind == GOMP_MAP_TO_PSET
1437 || kind == GOMP_MAP_STRUCT)
1438 continue;
1440 if (kind == GOMP_MAP_FORCE_ALLOC
1441 || kind == GOMP_MAP_FORCE_PRESENT
1442 || kind == GOMP_MAP_ATTACH
1443 || kind == GOMP_MAP_FORCE_TO
1444 || kind == GOMP_MAP_TO
1445 || kind == GOMP_MAP_ALLOC)
1447 data_enter = true;
1448 break;
1451 if (kind == GOMP_MAP_RELEASE
1452 || kind == GOMP_MAP_DELETE
1453 || kind == GOMP_MAP_DETACH
1454 || kind == GOMP_MAP_FORCE_DETACH
1455 || kind == GOMP_MAP_FROM
1456 || kind == GOMP_MAP_FORCE_FROM)
1457 break;
1459 gomp_fatal (">>>> GOACC_enter_exit_data UNHANDLED kind 0x%.2x",
1460 kind);
1463 va_list ap;
1464 va_start (ap, num_waits);
1465 goacc_enter_exit_data_internal (flags_m, mapnum, hostaddrs, sizes, kinds,
1466 data_enter, async, num_waits, &ap);
1467 va_end (ap);
1470 void
1471 GOACC_enter_data (int flags_m, size_t mapnum, void **hostaddrs,
1472 size_t *sizes, unsigned short *kinds, int async,
1473 int num_waits, ...)
1475 va_list ap;
1476 va_start (ap, num_waits);
1477 goacc_enter_exit_data_internal (flags_m, mapnum, hostaddrs, sizes, kinds,
1478 true, async, num_waits, &ap);
1479 va_end (ap);
1482 void
1483 GOACC_exit_data (int flags_m, size_t mapnum, void **hostaddrs,
1484 size_t *sizes, unsigned short *kinds, int async,
1485 int num_waits, ...)
1487 va_list ap;
1488 va_start (ap, num_waits);
1489 goacc_enter_exit_data_internal (flags_m, mapnum, hostaddrs, sizes, kinds,
1490 false, async, num_waits, &ap);
1491 va_end (ap);
1494 void
1495 GOACC_declare (int flags_m, size_t mapnum,
1496 void **hostaddrs, size_t *sizes, unsigned short *kinds)
1498 for (size_t i = 0; i < mapnum; i++)
1500 unsigned char kind = kinds[i] & 0xff;
1502 if (kind == GOMP_MAP_POINTER || kind == GOMP_MAP_TO_PSET)
1503 continue;
1505 switch (kind)
1507 case GOMP_MAP_ALLOC:
1508 if (acc_is_present (hostaddrs[i], sizes[i]))
1509 continue;
1510 /* FALLTHRU */
1511 case GOMP_MAP_FORCE_ALLOC:
1512 case GOMP_MAP_TO:
1513 case GOMP_MAP_FORCE_TO:
1514 goacc_enter_exit_data_internal (flags_m, 1, &hostaddrs[i], &sizes[i],
1515 &kinds[i], true, GOMP_ASYNC_SYNC, 0, NULL);
1516 break;
1518 case GOMP_MAP_FROM:
1519 case GOMP_MAP_FORCE_FROM:
1520 case GOMP_MAP_RELEASE:
1521 case GOMP_MAP_DELETE:
1522 goacc_enter_exit_data_internal (flags_m, 1, &hostaddrs[i], &sizes[i],
1523 &kinds[i], false, GOMP_ASYNC_SYNC, 0, NULL);
1524 break;
1526 case GOMP_MAP_FORCE_DEVICEPTR:
1527 break;
1529 case GOMP_MAP_FORCE_PRESENT:
1530 if (!acc_is_present (hostaddrs[i], sizes[i]))
1531 gomp_fatal ("[%p,%ld] is not mapped", hostaddrs[i],
1532 (unsigned long) sizes[i]);
1533 break;
1535 default:
1536 assert (0);
1537 break;