libgomp/oacc-host.c

   1 /* OpenACC Runtime Library: acc_device_host.
   2
   3    Copyright (C) 2013-2024 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 #include "libgomp.h"
  30 #include "oacc-int.h"
  31 #include "gomp-constants.h"
  32
  33 #include <stdbool.h>
  34 #include <stddef.h>
  35
  36 static struct gomp_device_descr host_dispatch;
  37
  38 static const char *
  39 host_get_name (void)
  40 {
  41   return host_dispatch.name;
  42 }
  43
  44 static unsigned int
  45 host_get_caps (void)
  46 {
  47   return host_dispatch.capabilities;
  48 }
  49
  50 static int
  51 host_get_type (void)
  52 {
  53   return host_dispatch.type;
  54 }
  55
  56 static int
  57 host_get_num_devices (unsigned int omp_requires_mask __attribute__((unused)))
  58 {
  59   return 1;
  60 }
  61
  62 static bool
  63 host_init_device (int n __attribute__ ((unused)))
  64 {
  65   return true;
  66 }
  67
  68 static bool
  69 host_fini_device (int n __attribute__ ((unused)))
  70 {
  71   return true;
  72 }
  73
  74 static unsigned
  75 host_version (void)
  76 {
  77   return GOMP_VERSION;
  78 }
  79
  80 static int
  81 host_load_image (int n __attribute__ ((unused)),
  82                  unsigned v __attribute__ ((unused)),
  83                  const void *t __attribute__ ((unused)),
  84                  struct addr_pair **r __attribute__ ((unused)),
  85                  uint64_t **f __attribute__ ((unused)),
  86                  uint64_t *i __attribute__ ((unused)))
  87 {
  88   return 0;
  89 }
  90
  91 static bool
  92 host_unload_image (int n __attribute__ ((unused)),
  93                    unsigned v __attribute__ ((unused)),
  94                    const void *t __attribute__ ((unused)))
  95 {
  96   return true;
  97 }
  98
  99 static void *
 100 host_alloc (int n __attribute__ ((unused)), size_t s)
 101 {
 102   return gomp_malloc (s);
 103 }
 104
 105 static bool
 106 host_free (int n __attribute__ ((unused)), void *p)
 107 {
 108   free (p);
 109   return true;
 110 }
 111
 112 static bool
 113 host_dev2host (int n __attribute__ ((unused)),
 114                void *h __attribute__ ((unused)),
 115                const void *d __attribute__ ((unused)),
 116                size_t s __attribute__ ((unused)))
 117 {
 118   return true;
 119 }
 120
 121 static bool
 122 host_host2dev (int n __attribute__ ((unused)),
 123                void *d __attribute__ ((unused)),
 124                const void *h __attribute__ ((unused)),
 125                size_t s __attribute__ ((unused)))
 126 {
 127   return true;
 128 }
 129
 130 static void
 131 host_run (int n __attribute__ ((unused)), void *fn_ptr, void *vars,
 132           void **args __attribute__((unused)))
 133 {
 134   void (*fn)(void *) = (void (*)(void *)) fn_ptr;
 135
 136   fn (vars);
 137 }
 138
 139 static void
 140 host_openacc_exec (void (*fn) (void *),
 141                    size_t mapnum __attribute__ ((unused)),
 142                    void **hostaddrs,
 143                    void **devaddrs __attribute__ ((unused)),
 144                    unsigned *dims __attribute__ ((unused)),
 145                    void *targ_mem_desc __attribute__ ((unused)))
 146 {
 147   fn (hostaddrs);
 148 }
 149
 150 static void
 151 host_openacc_async_exec (void (*fn) (void *),
 152                          size_t mapnum __attribute__ ((unused)),
 153                          void **hostaddrs,
 154                          void **devaddrs __attribute__ ((unused)),
 155                          unsigned *dims __attribute__ ((unused)),
 156                          void *targ_mem_desc __attribute__ ((unused)),
 157                          struct goacc_asyncqueue *aq __attribute__ ((unused)))
 158 {
 159   fn (hostaddrs);
 160 }
 161
 162 static int
 163 host_openacc_async_test (struct goacc_asyncqueue *aq __attribute__ ((unused)))
 164 {
 165   return 1;
 166 }
 167
 168 static bool
 169 host_openacc_async_synchronize (struct goacc_asyncqueue *aq
 170                                 __attribute__ ((unused)))
 171 {
 172   return true;
 173 }
 174
 175 static bool
 176 host_openacc_async_serialize (struct goacc_asyncqueue *aq1
 177                               __attribute__ ((unused)),
 178                               struct goacc_asyncqueue *aq2
 179                               __attribute__ ((unused)))
 180 {
 181   return true;
 182 }
 183
 184 static bool
 185 host_openacc_async_host2dev (int ord __attribute__ ((unused)),
 186                              void *dst __attribute__ ((unused)),
 187                              const void *src __attribute__ ((unused)),
 188                              size_t n __attribute__ ((unused)),
 189                              struct goacc_asyncqueue *aq
 190                              __attribute__ ((unused)))
 191 {
 192   return true;
 193 }
 194
 195 static bool
 196 host_openacc_async_dev2host (int ord __attribute__ ((unused)),
 197                              void *dst __attribute__ ((unused)),
 198                              const void *src __attribute__ ((unused)),
 199                              size_t n __attribute__ ((unused)),
 200                              struct goacc_asyncqueue *aq
 201                              __attribute__ ((unused)))
 202 {
 203   return true;
 204 }
 205
 206 static void
 207 host_openacc_async_queue_callback (struct goacc_asyncqueue *aq
 208                                    __attribute__ ((unused)),
 209                                    void (*callback_fn)(void *)
 210                                    __attribute__ ((unused)),
 211                                    void *userptr __attribute__ ((unused)))
 212 {
 213 }
 214
 215 static struct goacc_asyncqueue *
 216 host_openacc_async_construct (int device __attribute__((unused)))
 217 {
 218   /* Non-NULL 0xffff... value as opaque dummy.  */
 219   return (struct goacc_asyncqueue *) -1;
 220 }
 221
 222 static bool
 223 host_openacc_async_destruct (struct goacc_asyncqueue *aq
 224                              __attribute__ ((unused)))
 225 {
 226   return true;
 227 }
 228
 229 static union goacc_property_value
 230 host_openacc_get_property (int n, enum goacc_property prop)
 231 {
 232   union goacc_property_value nullval = { .val = 0 };
 233
 234   if (n >= host_get_num_devices (0))
 235     return nullval;
 236
 237   switch (prop)
 238     {
 239     case GOACC_PROPERTY_NAME:
 240       return (union goacc_property_value) { .ptr = "GOMP" };
 241     case GOACC_PROPERTY_VENDOR:
 242       return (union goacc_property_value) { .ptr = "GNU" };
 243     case GOACC_PROPERTY_DRIVER:
 244       return (union goacc_property_value) { .ptr = VERSION };
 245     case GOACC_PROPERTY_MEMORY:
 246     case GOACC_PROPERTY_FREE_MEMORY:
 247     default:
 248       return nullval;
 249     }
 250 }
 251
 252 static void *
 253 host_openacc_create_thread_data (int ord __attribute__ ((unused)))
 254 {
 255   return NULL;
 256 }
 257
 258 static void
 259 host_openacc_destroy_thread_data (void *tls_data __attribute__ ((unused)))
 260 {
 261 }
 262
 263 static struct gomp_device_descr host_dispatch =
 264   {
 265     .name = "host",
 266     .capabilities = (GOMP_OFFLOAD_CAP_SHARED_MEM
 267                      | GOMP_OFFLOAD_CAP_NATIVE_EXEC
 268                      | GOMP_OFFLOAD_CAP_OPENACC_200),
 269     .target_id = 0,
 270     .type = OFFLOAD_TARGET_TYPE_HOST,
 271
 272     .get_name_func = host_get_name,
 273     .get_caps_func = host_get_caps,
 274     .get_type_func = host_get_type,
 275     .get_num_devices_func = host_get_num_devices,
 276     .init_device_func = host_init_device,
 277     .fini_device_func = host_fini_device,
 278     .version_func = host_version,
 279     .load_image_func = host_load_image,
 280     .unload_image_func = host_unload_image,
 281     .alloc_func = host_alloc,
 282     .free_func = host_free,
 283     .dev2host_func = host_dev2host,
 284     .host2dev_func = host_host2dev,
 285     .memcpy2d_func = NULL,
 286     .memcpy3d_func = NULL,
 287     .run_func = host_run,
 288
 289     .mem_map = { NULL },
 290     .mem_map_rev = { NULL },
 291     /* .lock initialized in goacc_host_init.  */
 292     .state = GOMP_DEVICE_UNINITIALIZED,
 293
 294     .openacc = {
 295       .exec_func = host_openacc_exec,
 296
 297       .create_thread_data_func = host_openacc_create_thread_data,
 298       .destroy_thread_data_func = host_openacc_destroy_thread_data,
 299
 300       .async = {
 301         .construct_func = host_openacc_async_construct,
 302         .destruct_func = host_openacc_async_destruct,
 303         .test_func = host_openacc_async_test,
 304         .synchronize_func = host_openacc_async_synchronize,
 305         .serialize_func = host_openacc_async_serialize,
 306         .queue_callback_func = host_openacc_async_queue_callback,
 307         .exec_func = host_openacc_async_exec,
 308         .dev2host_func = host_openacc_async_dev2host,
 309         .host2dev_func = host_openacc_async_host2dev,
 310       },
 311
 312       .get_property_func = host_openacc_get_property,
 313
 314       .cuda = {
 315         .get_current_device_func = NULL,
 316         .get_current_context_func = NULL,
 317         .get_stream_func = NULL,
 318         .set_stream_func = NULL,
 319       }
 320     }
 321   };
 322
 323 /* Initialize and register this device type.  */
 324 void
 325 goacc_host_init (void)
 326 {
 327   gomp_mutex_init (&host_dispatch.lock);
 328   goacc_register (&host_dispatch);
 329 }