libgfortran/caf/libcaf.h

   1 /* Common declarations for all of GNU Fortran libcaf implementations.
   2    Copyright (C) 2011-2015 Free Software Foundation, Inc.
   3    Contributed by Tobias Burnus <burnus@net-b.de>
   4
   5 This file is part of the GNU Fortran Coarray Runtime Library (libcaf).
   6
   7 Libcaf is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3, or (at your option)
  10 any later version.
  11
  12 Libcaf is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 Under Section 7 of GPL version 3, you are granted additional
  18 permissions described in the GCC Runtime Library Exception, version
  19 3.1, as published by the Free Software Foundation.
  20
  21 You should have received a copy of the GNU General Public License and
  22 a copy of the GCC Runtime Library Exception along with this program;
  23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 <http://www.gnu.org/licenses/>.  */
  25
  26 #ifndef LIBCAF_H
  27 #define LIBCAF_H
  28
  29 #include <stdbool.h>
  30 #include <stddef.h>     /* For size_t.  */
  31 #include <stdint.h>     /* For int32_t.  */
  32
  33 #include "libgfortran.h"
  34
  35 #if 0
  36 #ifndef __GNUC__
  37 #define __attribute__(x)
  38 #define likely(x)       (x)
  39 #define unlikely(x)     (x)
  40 #else
  41 #define likely(x)       __builtin_expect(!!(x), 1)
  42 #define unlikely(x)     __builtin_expect(!!(x), 0)
  43 #endif
  44
  45 /* Definitions of the Fortran 2008 standard; need to kept in sync with
  46    ISO_FORTRAN_ENV, cf. libgfortran.h.  */
  47 #define STAT_UNLOCKED           0
  48 #define STAT_LOCKED             1
  49 #define STAT_LOCKED_OTHER_IMAGE 2
  50 #define STAT_STOPPED_IMAGE      6000
  51 #endif
  52
  53 /* Describes what type of array we are registerring. Keep in sync with
  54    gcc/fortran/trans.h.  */
  55 typedef enum caf_register_t {
  56   CAF_REGTYPE_COARRAY_STATIC,
  57   CAF_REGTYPE_COARRAY_ALLOC,
  58   CAF_REGTYPE_LOCK_STATIC,
  59   CAF_REGTYPE_LOCK_ALLOC,
  60   CAF_REGTYPE_CRITICAL
  61 }
  62 caf_register_t;
  63
  64 typedef void* caf_token_t;
  65 typedef gfc_array_void gfc_descriptor_t;
  66
  67 /* Linked list of static coarrays registered.  */
  68 typedef struct caf_static_t {
  69   caf_token_t token;
  70   struct caf_static_t *prev;
  71 }
  72 caf_static_t;
  73
  74 /* When there is a vector subscript in this dimension, nvec == 0, otherwise,
  75    lower_bound, upper_bound, stride contains the bounds relative to the declared
  76    bounds; kind denotes the integer kind of the elements of vector[].  */
  77 typedef struct caf_vector_t {
  78   size_t nvec;
  79   union {
  80     struct {
  81       void *vector;
  82       int kind;
  83     } v;
  84     struct {
  85       ptrdiff_t lower_bound, upper_bound, stride;
  86     } triplet;
  87   } u;
  88 }
  89 caf_vector_t;
  90
  91
  92 void _gfortran_caf_init (int *, char ***);
  93 void _gfortran_caf_finalize (void);
  94
  95 int _gfortran_caf_this_image (int);
  96 int _gfortran_caf_num_images (int, int);
  97
  98 void *_gfortran_caf_register (size_t, caf_register_t, caf_token_t *, int *,
  99                               char *, int);
 100 void _gfortran_caf_deregister (caf_token_t *, int *, char *, int);
 101
 102 void _gfortran_caf_sync_all (int *, char *, int);
 103 void _gfortran_caf_sync_memory (int *, char *, int);
 104 void _gfortran_caf_sync_images (int, int[], int *, char *, int);
 105
 106 void _gfortran_caf_error_stop_str (const char *, int32_t)
 107      __attribute__ ((noreturn));
 108 void _gfortran_caf_error_stop (int32_t) __attribute__ ((noreturn));
 109
 110 void _gfortran_caf_co_broadcast (gfc_descriptor_t *, int, int *, char *, int);
 111 void _gfortran_caf_co_sum (gfc_descriptor_t *, int, int *, char *, int);
 112 void _gfortran_caf_co_min (gfc_descriptor_t *, int, int *, char *, int, int);
 113 void _gfortran_caf_co_max (gfc_descriptor_t *, int, int *, char *, int, int);
 114 void _gfortran_caf_co_reduce (gfc_descriptor_t *, void* (*) (void *, void*),
 115                               int, int, int *, char *, int, int);
 116
 117 void _gfortran_caf_get (caf_token_t, size_t, int, gfc_descriptor_t *,
 118                         caf_vector_t *, gfc_descriptor_t *, int, int, bool);
 119 void _gfortran_caf_send (caf_token_t, size_t, int, gfc_descriptor_t *,
 120                          caf_vector_t *, gfc_descriptor_t *, int, int, bool);
 121 void _gfortran_caf_sendget (caf_token_t, size_t, int, gfc_descriptor_t *,
 122                             caf_vector_t *, caf_token_t, size_t, int,
 123                             gfc_descriptor_t *, caf_vector_t *, int, int, bool);
 124
 125 void _gfortran_caf_atomic_define (caf_token_t, size_t, int, void *, int *,
 126                                   int, int);
 127 void _gfortran_caf_atomic_ref (caf_token_t, size_t, int, void *, int *,
 128                                int, int);
 129 void _gfortran_caf_atomic_cas (caf_token_t, size_t, int, void *, void *,
 130                                void *, int *, int, int);
 131 void _gfortran_caf_atomic_op (int, caf_token_t, size_t, int, void *, void *,
 132                               int *, int, int);
 133
 134 void _gfortran_caf_lock (caf_token_t, size_t, int, int *, int *, char *, int);
 135 void _gfortran_caf_unlock (caf_token_t, size_t, int, int *, char *, int);
 136
 137 #endif  /* LIBCAF_H  */