1 /* Common declarations for all of GNU Fortran libcaf implementations.
2 Copyright (C) 2011-2016 Free Software Foundation, Inc.
3 Contributed by Tobias Burnus <burnus@net-b.de>
5 This file is part of the GNU Fortran Coarray Runtime Library (libcaf).
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)
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.
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.
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/>. */
30 #include <stddef.h> /* For size_t. */
31 #include <stdint.h> /* For int32_t. */
33 #include "libgfortran.h"
37 #define __attribute__(x)
39 #define unlikely(x) (x)
41 #define likely(x) __builtin_expect(!!(x), 1)
42 #define unlikely(x) __builtin_expect(!!(x), 0)
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
49 #define STAT_LOCKED_OTHER_IMAGE 2
50 #define STAT_STOPPED_IMAGE 6000
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
,
61 CAF_REGTYPE_EVENT_STATIC
,
62 CAF_REGTYPE_EVENT_ALLOC
,
63 CAF_REGTYPE_COARRAY_ALLOC_REGISTER_ONLY
,
64 CAF_REGTYPE_COARRAY_ALLOC_ALLOCATE_ONLY
68 /* Describes the action to take on _caf_deregister. Keep in sync with
69 gcc/fortran/trans.h. */
70 typedef enum caf_deregister_t
{
71 CAF_DEREGTYPE_COARRAY_DEREGISTER
,
72 CAF_DEREGTYPE_COARRAY_DEALLOCATE_ONLY
76 typedef void* caf_token_t
;
77 typedef gfc_array_void gfc_descriptor_t
;
79 /* Linked list of static coarrays registered. */
80 typedef struct caf_static_t
{
82 struct caf_static_t
*prev
;
86 /* When there is a vector subscript in this dimension, nvec == 0, otherwise,
87 lower_bound, upper_bound, stride contains the bounds relative to the declared
88 bounds; kind denotes the integer kind of the elements of vector[]. */
89 typedef struct caf_vector_t
{
97 ptrdiff_t lower_bound
, upper_bound
, stride
;
103 typedef enum caf_ref_type_t
{
104 /* Reference a component of a derived type, either regular one or an
105 allocatable or pointer type. For regular ones idx in caf_reference_t is
108 /* Reference an allocatable array. */
110 /* Reference a non-allocatable/non-pointer array. */
114 typedef enum caf_array_ref_t
{
115 /* No array ref. This terminates the array ref. */
116 CAF_ARR_REF_NONE
= 0,
117 /* Reference array elements given by a vector. Only for this mode
118 caf_reference_t.u.a.dim[i].v is valid. */
120 /* A full array ref (:). */
122 /* Reference a range on elements given by start, end and stride. */
124 /* Only a single item is referenced given in the start member. */
126 /* An array ref of the kind (i:), where i is an arbitrary valid index in the
127 array. The index i is given in the start member. */
128 CAF_ARR_REF_OPEN_END
,
129 /* An array ref of the kind (:i), where the lower bound of the array ref
130 is given by the remote side. The index i is given in the end member. */
131 CAF_ARR_REF_OPEN_START
134 /* References to remote components of a derived type. */
135 typedef struct caf_reference_t
{
136 /* A pointer to the next ref or NULL. */
137 struct caf_reference_t
*next
;
138 /* The type of the reference. */
139 /* caf_ref_type_t, replaced by int to allow specification in fortran FE. */
141 /* The size of an item referenced in bytes. I.e. in an array ref this is
142 the factor to advance the array pointer with to get to the next item.
143 For component refs this gives just the size of the element referenced. */
147 /* The offset (in bytes) of the component in the derived type. */
149 /* The offset (in bytes) to the caf_token associated with this
150 component. NULL, when not allocatable/pointer ref. */
151 ptrdiff_t caf_token_offset
;
154 /* The mode of the array ref. See CAF_ARR_REF_*. */
155 /* caf_array_ref_t, replaced by unsigend char to allow specification in
157 unsigned char mode
[GFC_MAX_DIMENSIONS
];
158 /* The type of a static array. Unset for array's with descriptors. */
159 int static_array_type
;
160 /* Subscript refs (s) or vector refs (v). */
163 /* The start and end boundary of the ref and the stride. */
164 index_type start
, end
, stride
;
167 /* nvec entries of kind giving the elements to reference. */
169 /* The number of entries in vector. */
171 /* The integer kind used for the elements in vector. */
174 } dim
[GFC_MAX_DIMENSIONS
];
179 void _gfortran_caf_init (int *, char ***);
180 void _gfortran_caf_finalize (void);
182 int _gfortran_caf_this_image (int);
183 int _gfortran_caf_num_images (int, int);
185 void _gfortran_caf_register (size_t, caf_register_t
, caf_token_t
*,
186 gfc_descriptor_t
*, int *, char *, int);
187 void _gfortran_caf_deregister (caf_token_t
*, caf_deregister_t
, int *, char *,
190 void _gfortran_caf_sync_all (int *, char *, int);
191 void _gfortran_caf_sync_memory (int *, char *, int);
192 void _gfortran_caf_sync_images (int, int[], int *, char *, int);
194 void _gfortran_caf_stop_numeric (int32_t)
195 __attribute__ ((noreturn
));
196 void _gfortran_caf_stop_str (const char *, int32_t)
197 __attribute__ ((noreturn
));
198 void _gfortran_caf_error_stop_str (const char *, int32_t)
199 __attribute__ ((noreturn
));
200 void _gfortran_caf_error_stop (int32_t) __attribute__ ((noreturn
));
202 void _gfortran_caf_co_broadcast (gfc_descriptor_t
*, int, int *, char *, int);
203 void _gfortran_caf_co_sum (gfc_descriptor_t
*, int, int *, char *, int);
204 void _gfortran_caf_co_min (gfc_descriptor_t
*, int, int *, char *, int, int);
205 void _gfortran_caf_co_max (gfc_descriptor_t
*, int, int *, char *, int, int);
206 void _gfortran_caf_co_reduce (gfc_descriptor_t
*, void* (*) (void *, void*),
207 int, int, int *, char *, int, int);
209 void _gfortran_caf_get (caf_token_t
, size_t, int, gfc_descriptor_t
*,
210 caf_vector_t
*, gfc_descriptor_t
*, int, int, bool,
212 void _gfortran_caf_send (caf_token_t
, size_t, int, gfc_descriptor_t
*,
213 caf_vector_t
*, gfc_descriptor_t
*, int, int, bool,
215 void _gfortran_caf_sendget (caf_token_t
, size_t, int, gfc_descriptor_t
*,
216 caf_vector_t
*, caf_token_t
, size_t, int,
217 gfc_descriptor_t
*, caf_vector_t
*, int, int, bool);
219 void _gfortran_caf_get_by_ref (caf_token_t token
, int image_idx
,
220 gfc_descriptor_t
*dst
, caf_reference_t
*refs
, int dst_kind
,
221 int src_kind
, bool may_require_tmp
, bool dst_reallocatable
, int *stat
);
222 void _gfortran_caf_send_by_ref (caf_token_t token
, int image_index
,
223 gfc_descriptor_t
*src
, caf_reference_t
*refs
, int dst_kind
,
224 int src_kind
, bool may_require_tmp
, bool dst_reallocatable
, int *stat
);
225 void _gfortran_caf_sendget_by_ref (
226 caf_token_t dst_token
, int dst_image_index
, caf_reference_t
*dst_refs
,
227 caf_token_t src_token
, int src_image_index
, caf_reference_t
*src_refs
,
228 int dst_kind
, int src_kind
, bool may_require_tmp
, int *dst_stat
,
231 void _gfortran_caf_atomic_define (caf_token_t
, size_t, int, void *, int *,
233 void _gfortran_caf_atomic_ref (caf_token_t
, size_t, int, void *, int *,
235 void _gfortran_caf_atomic_cas (caf_token_t
, size_t, int, void *, void *,
236 void *, int *, int, int);
237 void _gfortran_caf_atomic_op (int, caf_token_t
, size_t, int, void *, void *,
240 void _gfortran_caf_lock (caf_token_t
, size_t, int, int *, int *, char *, int);
241 void _gfortran_caf_unlock (caf_token_t
, size_t, int, int *, char *, int);
242 void _gfortran_caf_event_post (caf_token_t
, size_t, int, int *, char *, int);
243 void _gfortran_caf_event_wait (caf_token_t
, size_t, int, int *, char *, int);
244 void _gfortran_caf_event_query (caf_token_t
, size_t, int, int *, int *);
246 int _gfortran_caf_is_present (caf_token_t
, int, caf_reference_t
*);
248 #endif /* LIBCAF_H */