libgfortran/caf/libcaf.h

   1 /* Common declarations for all of GNU Fortran libcaf implementations.
   2    Copyright (C) 2011-2014 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 #ifndef __GNUC__
  34 #define __attribute__(x)
  35 #define likely(x)       (x)
  36 #define unlikely(x)     (x)
  37 #else
  38 #define likely(x)       __builtin_expect(!!(x), 1)
  39 #define unlikely(x)     __builtin_expect(!!(x), 0)
  40 #endif
  41
  42 /* Definitions of the Fortran 2008 standard; need to kept in sync with
  43    ISO_FORTRAN_ENV, cf. libgfortran.h.  */
  44 #define STAT_UNLOCKED           0
  45 #define STAT_LOCKED             1
  46 #define STAT_LOCKED_OTHER_IMAGE 2
  47 #define STAT_STOPPED_IMAGE      6000
  48
  49 /* Describes what type of array we are registerring. Keep in sync with
  50    gcc/fortran/trans.h.  */
  51 typedef enum caf_register_t {
  52   CAF_REGTYPE_COARRAY_STATIC,
  53   CAF_REGTYPE_COARRAY_ALLOC,
  54   CAF_REGTYPE_LOCK,
  55   CAF_REGTYPE_LOCK_COMP
  56 }
  57 caf_register_t;
  58
  59 typedef void* caf_token_t;
  60
  61 /* Linked list of static coarrays registered.  */
  62 typedef struct caf_static_t {
  63   caf_token_t token;
  64   struct caf_static_t *prev;
  65 }
  66 caf_static_t;
  67
  68
  69 void _gfortran_caf_init (int *, char ***);
  70 void _gfortran_caf_finalize (void);
  71
  72 int _gfortran_caf_this_image (int);
  73 int _gfortran_caf_num_images (int, bool);
  74
  75 void *_gfortran_caf_register (size_t, caf_register_t, caf_token_t *, int *,
  76                               char *, int);
  77 void _gfortran_caf_deregister (caf_token_t *, int *, char *, int);
  78
  79 void _gfortran_caf_sync_all (int *, char *, int);
  80 void _gfortran_caf_sync_images (int, int[], int *, char *, int);
  81
  82 /* FIXME: The CRITICAL functions should be removed;
  83    the functionality is better represented using Coarray's lock feature.  */
  84 void _gfortran_caf_critical (void);
  85 void _gfortran_caf_critical (void)  { }
  86
  87 void _gfortran_caf_end_critical (void);
  88 void _gfortran_caf_end_critical (void)  { }
  89
  90
  91 void _gfortran_caf_error_stop_str (const char *, int32_t)
  92      __attribute__ ((noreturn));
  93 void _gfortran_caf_error_stop (int32_t) __attribute__ ((noreturn));
  94
  95 #endif  /* LIBCAF_H  */