]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/fortran/trans.h
Add AMD and Ulf Adams as external authors
[thirdparty/gcc.git] / gcc / fortran / trans.h
CommitLineData
6de9cd9a 1/* Header for code translation functions
8d9254fc 2 Copyright (C) 2002-2020 Free Software Foundation, Inc.
6de9cd9a
DN
3 Contributed by Paul Brook
4
9fc4d79b 5This file is part of GCC.
6de9cd9a 6
9fc4d79b
TS
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
d234d788 9Software Foundation; either version 3, or (at your option) any later
9fc4d79b 10version.
6de9cd9a 11
9fc4d79b
TS
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
6de9cd9a
DN
16
17You should have received a copy of the GNU General Public License
d234d788
NC
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
6de9cd9a
DN
20
21#ifndef GFC_TRANS_H
22#define GFC_TRANS_H
23
ed9c79e1
JJ
24#include "predict.h" /* For enum br_predictor and PRED_*. */
25
ad690d79
AB
26/* Mangled symbols take the form __module__name or __module.submodule__name. */
27#define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*3+5)
6de9cd9a
DN
28
29/* Struct for holding a block of statements. It should be treated as an
30 opaque entity and not modified directly. This allows us to change the
31 underlying representation of statement lists. */
32typedef struct
33{
34 tree head;
b40410b9 35 unsigned int has_scope:1;
6de9cd9a
DN
36}
37stmtblock_t;
38
1f2959f0 39/* a simplified expression */
6de9cd9a
DN
40typedef struct gfc_se
41{
42 /* Code blocks to be executed before and after using the value. */
43 stmtblock_t pre;
44 stmtblock_t post;
45
46 /* the result of the expression */
47 tree expr;
48
49 /* The length of a character string value. */
50 tree string_length;
51
f3b0bb7a
AV
52 /* When expr is a reference to a class object, store its vptr access
53 here. */
54 tree class_vptr;
55
6de9cd9a
DN
56 /* If set gfc_conv_variable will return an expression for the array
57 descriptor. When set, want_pointer should also be set.
58 If not set scalarizing variables will be substituted. */
59 unsigned descriptor_only:1;
60
61 /* When this is set gfc_conv_expr returns the address of a variable. Only
62 applies to EXPR_VARIABLE nodes.
63 Also used by gfc_conv_array_parameter. When set this indicates a pointer
64 to the descriptor should be returned, rather than the descriptor itself.
65 */
66 unsigned want_pointer:1;
67
68 /* An array function call returning without a temporary. Also used for array
69 pointer assignments. */
70 unsigned direct_byref:1;
71
99d821c0
DK
72 /* If direct_byref is set, do work out the descriptor as in that case but
73 do still create a new descriptor variable instead of using an
74 existing one. This is useful for special pointer assignments like
75 rank remapping where we have to process the descriptor before
76 assigning to final one. */
77 unsigned byref_noassign:1;
78
6de9cd9a
DN
79 /* Ignore absent optional arguments. Used for some intrinsics. */
80 unsigned ignore_optional:1;
81
ad5dd90d
PT
82 /* When this is set the data and offset fields of the returned descriptor
83 are NULL. Used by intrinsic size. */
84 unsigned data_not_needed:1;
85
713485cc 86 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
0ee8e250
PT
87 unsigned no_function_call:1;
88
0b4f2770
MM
89 /* If set, we will force the creation of a temporary. Useful to disable
90 non-copying procedure argument passing optimizations, when some function
91 args alias. */
92 unsigned force_tmp:1;
93
0a524296
PT
94 /* If set, will pass subref descriptors without a temporary. */
95 unsigned force_no_tmp:1;
96
1cf43a1d
PT
97 /* Unconditionally calculate offset for array segments and constant
98 arrays in gfc_conv_expr_descriptor. */
99 unsigned use_offset:1;
100
23c3d0f9
MM
101 unsigned want_coarray:1;
102
6de9cd9a
DN
103 /* Scalarization parameters. */
104 struct gfc_se *parent;
105 struct gfc_ss *ss;
106 struct gfc_loopinfo *loop;
107}
108gfc_se;
109
c78d3425
AF
110typedef struct gfc_co_subroutines_args
111{
112 tree image_index;
113 tree stat;
114 tree errmsg;
115 tree errmsg_len;
116}
117gfc_co_subroutines_args;
6de9cd9a 118
ea6363a3
DC
119/* Denotes different types of coarray.
120 Please keep in sync with libgfortran/caf/libcaf.h. */
ba85c8c3 121enum gfc_coarray_regtype
ea6363a3
DC
122{
123 GFC_CAF_COARRAY_STATIC,
124 GFC_CAF_COARRAY_ALLOC,
bc0229f9
TB
125 GFC_CAF_LOCK_STATIC,
126 GFC_CAF_LOCK_ALLOC,
5df445a2
TB
127 GFC_CAF_CRITICAL,
128 GFC_CAF_EVENT_STATIC,
ba85c8c3
AV
129 GFC_CAF_EVENT_ALLOC,
130 GFC_CAF_COARRAY_ALLOC_REGISTER_ONLY,
131 GFC_CAF_COARRAY_ALLOC_ALLOCATE_ONLY
132};
133
134
135/* Describes the action to take on _caf_deregister. Keep in sync with
136 gcc/fortran/trans.h. The negative values are not valid for the library and
137 are used by the drivers for building the correct call. */
138enum gfc_coarray_deregtype {
139 /* This is no coarray, i.e. build a call to a free (). */
140 GFC_CAF_COARRAY_NOCOARRAY = -2,
141 /* The driver is to analyze which _caf_deregister ()-call to generate. */
142 GFC_CAF_COARRAY_ANALYZE = -1,
143 GFC_CAF_COARRAY_DEREGISTER = 0,
144 GFC_CAF_COARRAY_DEALLOCATE_ONLY
a79683d5 145};
ea6363a3
DC
146
147
3c9f5092
AV
148/* Specify the type of ref handed to the caf communication functions.
149 Please keep in sync with libgfortran/caf/libcaf.h. */
150enum gfc_caf_ref_type_t {
151 GFC_CAF_REF_COMPONENT,
152 GFC_CAF_REF_ARRAY,
153 GFC_CAF_REF_STATIC_ARRAY
154};
155
156
157/* Give the reference type of an array ref.
158 Please keep in sync with libgfortran/caf/libcaf.h. */
159enum gfc_caf_array_ref_t {
160 GFC_CAF_ARR_REF_NONE = 0,
161 GFC_CAF_ARR_REF_VECTOR,
162 GFC_CAF_ARR_REF_FULL,
163 GFC_CAF_ARR_REF_RANGE,
164 GFC_CAF_ARR_REF_SINGLE,
165 GFC_CAF_ARR_REF_OPEN_END,
166 GFC_CAF_ARR_REF_OPEN_START
167};
168
ba85c8c3
AV
169
170/* trans-array (structure_alloc_comps) caf_mode bits. */
171enum gfc_structure_caf_mode_t {
172 GFC_STRUCTURE_CAF_MODE_ENABLE_COARRAY = 1 << 0,
173 GFC_STRUCTURE_CAF_MODE_IN_COARRAY = 1 << 1,
174 GFC_STRUCTURE_CAF_MODE_DEALLOC_ONLY = 1 << 2
175};
176
177
62732c30 178/* The array-specific scalarization information. The array members of
6d63e468 179 this struct are indexed by actual array index, and thus can be sparse. */
6de9cd9a 180
6d63e468 181typedef struct gfc_array_info
6de9cd9a 182{
08dcec61
MM
183 mpz_t *shape;
184
6de9cd9a
DN
185 /* The ref that holds information on this section. */
186 gfc_ref *ref;
187 /* The descriptor of this array. */
188 tree descriptor;
189 /* holds the pointer to the data array. */
190 tree data;
191 /* To move some of the array index calculation out of the innermost loop. */
192 tree offset;
193 tree saved_offset;
194 tree stride0;
195 /* Holds the SS for a subscript. Indexed by actual dimension. */
196 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
197
198 /* stride and delta are used to access this inside a scalarization loop.
199 start is used in the calculation of these. Indexed by scalarizer
200 dimension. */
201 tree start[GFC_MAX_DIMENSIONS];
8424e0d8 202 tree end[GFC_MAX_DIMENSIONS];
6de9cd9a
DN
203 tree stride[GFC_MAX_DIMENSIONS];
204 tree delta[GFC_MAX_DIMENSIONS];
6de9cd9a 205}
6d63e468 206gfc_array_info;
6de9cd9a 207
a79683d5 208enum gfc_ss_type
6de9cd9a
DN
209{
210 /* A scalar value. This will be evaluated before entering the
211 scalarization loop. */
212 GFC_SS_SCALAR,
213
991b4da1 214 /* Like GFC_SS_SCALAR it evaluates the expression outside the
0192ef20
MM
215 loop. Is always evaluated as a reference to the temporary, unless
216 temporary evaluation can result in a NULL pointer dereferencing (case of
217 optional arguments). Used for elemental function arguments. */
6de9cd9a
DN
218 GFC_SS_REFERENCE,
219
220 /* An array section. Scalarization indices will be substituted during
221 expression translation. */
222 GFC_SS_SECTION,
223
224 /* A non-elemental function call returning an array. The call is executed
225 before entering the scalarization loop, storing the result in a
226 temporary. This temporary is then used inside the scalarization loop.
df2fba9e 227 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
6de9cd9a
DN
228 as a special case. */
229 GFC_SS_FUNCTION,
230
231 /* An array constructor. The current implementation is sub-optimal in
232 many cases. It allocated a temporary, assigns the values to it, then
233 uses this temporary inside the scalarization loop. */
234 GFC_SS_CONSTRUCTOR,
235
7a70c12d
RS
236 /* A vector subscript. The vector's descriptor is cached in the
237 "descriptor" field of the associated gfc_ss_info. */
6de9cd9a
DN
238 GFC_SS_VECTOR,
239
240 /* A temporary array allocated by the scalarizer. Its rank can be less
241 than that of the assignment expression. */
242 GFC_SS_TEMP,
243
244 /* An intrinsic function call. Many intrinsic functions which map directly
245 to library calls are created as GFC_SS_FUNCTION nodes. */
e9cfef64 246 GFC_SS_INTRINSIC,
1cf43a1d 247
e9cfef64
PB
248 /* A component of a derived type. */
249 GFC_SS_COMPONENT
a79683d5 250};
6de9cd9a 251
6d63e468 252
bcc4d4e0
MM
253typedef struct gfc_ss_info
254{
c7bf4f1e 255 int refcount;
bcc4d4e0 256 gfc_ss_type type;
f98cfd3c 257 gfc_expr *expr;
a0add3be 258 tree string_length;
99dd5a29
MM
259
260 union
261 {
262 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
263 struct
264 {
14aeb3cd
MM
265 /* If the scalar is passed as actual argument to an (elemental) procedure,
266 this is the symbol of the corresponding dummy argument. */
267 gfc_symbol *dummy_arg;
99dd5a29 268 tree value;
711d7c23
MM
269 /* Tells that the scalar is a reference to a variable that might
270 be present on the lhs, so that we should evaluate the value
271 itself before the loop, not just the reference. */
272 unsigned needs_temporary:1;
99dd5a29
MM
273 }
274 scalar;
961e73ac
MM
275
276 /* GFC_SS_TEMP. */
277 struct
278 {
279 tree type;
280 }
281 temp;
1838afec
MM
282
283 /* All other types. */
284 gfc_array_info array;
99dd5a29
MM
285 }
286 data;
7a412892
MM
287
288 /* This is used by assignments requiring temporaries. The bits specify which
289 loops the terms appear in. This will be 1 for the RHS expressions,
290 2 for the LHS expressions, and 3(=1|2) for the temporary. */
291 unsigned useflags:2;
42d0058e
MM
292
293 /* Suppresses precalculation of scalars in WHERE assignments. */
294 unsigned where:1;
9bcf7121 295
30c931de
PT
296 /* This set for an elemental function that contains expressions for
297 external arrays, thereby triggering creation of a temporary. */
298 unsigned array_outer_dependency:1;
299
9bcf7121
MM
300 /* Tells whether the SS is for an actual argument which can be a NULL
301 reference. In other words, the associated dummy argument is OPTIONAL.
302 Used to handle elemental procedures. */
303 bool can_be_null_ref;
bcc4d4e0
MM
304}
305gfc_ss_info;
306
307#define gfc_get_ss_info() XCNEW (gfc_ss_info)
308
309
6d63e468
MM
310/* Scalarization State chain. Created by walking an expression tree before
311 creating the scalarization loops. Then passed as part of a gfc_se structure
312 to translate the expression inside the loop. Note that these chains are
313 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
314 indicates to gfc_conv_* that this is a scalar expression.
315 SS structures can only belong to a single loopinfo. They must be added
6de9cd9a 316 otherwise they will not get freed. */
6d63e468 317
6de9cd9a
DN
318typedef struct gfc_ss
319{
bcc4d4e0
MM
320 gfc_ss_info *info;
321
cb4b9eae
MM
322 int dimen;
323 /* Translation from loop dimensions to actual array dimensions.
324 actual_dim = dim[loop_dim] */
325 int dim[GFC_MAX_DIMENSIONS];
326
6de9cd9a
DN
327 /* All the SS in a loop and linked through loop_chain. The SS for an
328 expression are linked by the next pointer. */
329 struct gfc_ss *loop_chain;
330 struct gfc_ss *next;
331
2eace29a
MM
332 /* Non-null if the ss is part of a nested loop. */
333 struct gfc_ss *parent;
334
4d6a0e36
MM
335 /* If the evaluation of an expression requires a nested loop (for example
336 if the sum intrinsic is evaluated inline), this points to the nested
337 loop's gfc_ss. */
338 struct gfc_ss *nested_ss;
339
4615abe8
MM
340 /* The loop this gfc_ss is in. */
341 struct gfc_loopinfo *loop;
342
42d0058e 343 unsigned is_alloc_lhs:1;
d1ecece9 344 unsigned no_bounds_check:1;
6de9cd9a
DN
345}
346gfc_ss;
ece3f663 347#define gfc_get_ss() XCNEW (gfc_ss)
6de9cd9a 348
1f2959f0 349/* The contents of this aren't actually used. A NULL SS chain indicates a
6de9cd9a
DN
350 scalar expression, so this pointer is used to terminate SS chains. */
351extern gfc_ss * const gfc_ss_terminator;
352
353/* Holds information about an expression while it is being scalarized. */
354typedef struct gfc_loopinfo
355{
356 stmtblock_t pre;
357 stmtblock_t post;
358
c6d741b8 359 int dimen;
6de9cd9a
DN
360
361 /* All the SS involved with this loop. */
362 gfc_ss *ss;
e7dc5b4f 363 /* The SS describing the temporary used in an assignment. */
6de9cd9a
DN
364 gfc_ss *temp_ss;
365
4616ef9b
MM
366 /* Non-null if this loop is nested in another one. */
367 struct gfc_loopinfo *parent;
368
9d758043
MM
369 /* Chain of nested loops. */
370 struct gfc_loopinfo *nested, *next;
371
6de9cd9a
DN
372 /* The scalarization loop index variables. */
373 tree loopvar[GFC_MAX_DIMENSIONS];
374
375 /* The bounds of the scalarization loops. */
376 tree from[GFC_MAX_DIMENSIONS];
377 tree to[GFC_MAX_DIMENSIONS];
378 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
379
380 /* The code member contains the code for the body of the next outer loop. */
381 stmtblock_t code[GFC_MAX_DIMENSIONS];
382
383 /* Order in which the dimensions should be looped, innermost first. */
384 int order[GFC_MAX_DIMENSIONS];
385
3d03ead0
PT
386 /* Enum to control loop reversal. */
387 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
388
6de9cd9a
DN
389 /* The number of dimensions for which a temporary is used. */
390 int temp_dim;
391
392 /* If set we don't need the loop variables. */
393 unsigned array_parameter:1;
394}
395gfc_loopinfo;
396
0c08de8f 397#define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
7b5b57b7
PB
398
399/* Information about a symbol that has been shadowed by a temporary. */
400typedef struct
401{
402 symbol_attribute attr;
403 tree decl;
404}
405gfc_saved_var;
406
407
0019d498
DK
408/* Store information about a block of code together with special
409 initialization and clean-up code. This can be used to incrementally add
410 init and cleanup, and in the end put everything together to a
411 try-finally expression. */
412typedef struct
413{
414 tree init;
415 tree cleanup;
416 tree code;
417}
418gfc_wrapped_block;
419
c49ea23d 420/* Class API functions. */
34d9d749 421tree gfc_class_set_static_fields (tree, tree, tree);
c49ea23d
PT
422tree gfc_class_data_get (tree);
423tree gfc_class_vptr_get (tree);
5b384b3d 424tree gfc_class_len_get (tree);
728557fd 425tree gfc_class_len_or_zero_get (tree);
ce8dcc91 426tree gfc_resize_class_size_with_len (stmtblock_t *, tree, tree);
4afe8252 427gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *, bool is_mold = false);
34d9d749
AV
428/* Get an accessor to the class' vtab's * field, when a class handle is
429 available. */
430tree gfc_class_vtab_hash_get (tree);
431tree gfc_class_vtab_size_get (tree);
432tree gfc_class_vtab_extends_get (tree);
433tree gfc_class_vtab_def_init_get (tree);
434tree gfc_class_vtab_copy_get (tree);
435tree gfc_class_vtab_final_get (tree);
436/* Get an accessor to the vtab's * field, when a vptr handle is present. */
437tree gfc_vtpr_hash_get (tree);
438tree gfc_vptr_size_get (tree);
439tree gfc_vptr_extends_get (tree);
440tree gfc_vptr_def_init_get (tree);
441tree gfc_vptr_copy_get (tree);
442tree gfc_vptr_final_get (tree);
bf9f15ee 443tree gfc_vptr_deallocate_get (tree);
4fb5478c 444void gfc_reset_vptr (stmtblock_t *, gfc_expr *);
34d9d749 445void gfc_reset_len (stmtblock_t *, gfc_expr *);
0175d45d 446tree gfc_get_class_from_gfc_expr (gfc_expr *);
56b070e3 447tree gfc_get_class_from_expr (tree);
8f75db9f 448tree gfc_get_vptr_from_expr (tree);
26219cee 449tree gfc_get_class_array_ref (tree, tree, tree, bool);
34d9d749 450tree gfc_copy_class_to_class (tree, tree, tree, bool);
ef292537 451bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *);
895a0c2d
TB
452bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool);
453
16e82b25
TB
454void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool,
455 bool);
456void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool,
457 bool, bool);
0019d498
DK
458
459/* Initialize an init/cleanup block. */
460void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
461/* Add a pair of init/cleanup code to the block. Each one might be a
462 NULL_TREE if not required. */
463void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
464/* Finalize the block, that is, create a single expression encapsulating the
465 original code together with init and clean-up code. */
466tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
467
468
6de9cd9a
DN
469/* Advance the SS chain to the next term. */
470void gfc_advance_se_ss_chain (gfc_se *);
471
aa9c57ec
KH
472/* Call this to initialize a gfc_se structure before use
473 first parameter is structure to initialize, second is
6de9cd9a
DN
474 parent to get scalarization data from, or NULL. */
475void gfc_init_se (gfc_se *, gfc_se *);
476
477/* Create an artificial variable decl and add it to the current scope. */
478tree gfc_create_var (tree, const char *);
479/* Like above but doesn't add it to the current scope. */
480tree gfc_create_var_np (tree, const char *);
481
482/* Store the result of an expression in a temp variable so it can be used
483 repeatedly even if the original changes */
484void gfc_make_safe_expr (gfc_se * se);
485
486/* Makes sure se is suitable for passing as a function string parameter. */
487void gfc_conv_string_parameter (gfc_se * se);
488
0a821a92 489/* Compare two strings. */
23b10420 490tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
0a821a92 491
13795658 492/* When using the gfc_conv_* make sure you understand what they do, i.e.
69de3b83 493 when a POST chain may be created, and what the returned expression may be
6de9cd9a
DN
494 used for. Note that character strings have special handling. This
495 should not be a problem as most statements/operations only deal with
a4f5cd44
PB
496 numeric/logical types. See the implementations in trans-expr.c
497 for details of the individual functions. */
6de9cd9a 498
6de9cd9a 499void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
6de9cd9a 500void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
6de9cd9a 501void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
056e6860
TK
502void gfc_conv_expr_reference (gfc_se * se, gfc_expr * expr,
503 bool add_clobber = false);
6de9cd9a 504void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
a4f5cd44 505
429cb994 506
e032c2a1 507/* trans-expr.c */
3c9f5092
AV
508tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute);
509tree gfc_get_ultimate_alloc_ptr_comps_caf_token (gfc_se *, gfc_expr *);
e032c2a1 510void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
d2886bc7 511tree gfc_string_to_single_character (tree len, tree str, int kind);
b5116268 512tree gfc_get_tree_for_caf_expr (gfc_expr *);
3c9f5092 513void gfc_get_caf_token_offset (gfc_se*, tree *, tree *, tree, tree, gfc_expr *);
2c69df3b 514tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree);
e032c2a1 515
ce2df7c6
FW
516/* Find the decl containing the auxiliary variables for assigned variables. */
517void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
6de9cd9a 518/* If the value is not constant, Create a temporary and copy the value. */
55bd9c35 519tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
6de9cd9a 520tree gfc_evaluate_now (tree, stmtblock_t *);
fb3f5eae 521tree gfc_evaluate_now_function_scope (tree, stmtblock_t *);
6de9cd9a 522
166d08bd
FXC
523/* Find the appropriate variant of a math intrinsic. */
524tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
525
2b3dc0db
PT
526tree size_of_string_in_bytes (int, tree);
527
da661a58
TB
528/* Intrinsic procedure handling. */
529tree gfc_conv_intrinsic_subroutine (gfc_code *);
6de9cd9a 530void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
3b7ea188
FXC
531bool gfc_conv_ieee_arithmetic_function (gfc_se *, gfc_expr *);
532tree gfc_save_fp_state (stmtblock_t *);
533void gfc_restore_fp_state (stmtblock_t *, tree);
534
711d7c23 535bool gfc_expr_is_variable (gfc_expr *);
6de9cd9a 536
712efae1
MM
537/* Does an intrinsic map directly to an external library call
538 This is true for array-returning intrinsics, unless
539 gfc_inline_intrinsic_function_p returns true. */
6de9cd9a 540int gfc_is_intrinsic_libcall (gfc_expr *);
b2a5eb75 541
713485cc
JW
542/* Used to call ordinary functions/subroutines
543 and procedure pointer components. */
544int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
9771b263 545 gfc_expr *, vec<tree, va_gc> *);
d4feb3d3 546
bf09e559
TK
547void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool,
548 const gfc_symbol *fsym = NULL,
549 const char *proc_name = NULL,
1585b483
TK
550 gfc_symbol *sym = NULL,
551 bool check_contiguous = false);
552
553void gfc_conv_is_contiguous_expr (gfc_se *, gfc_expr *);
d4feb3d3 554
6de9cd9a 555/* Generate code for a scalar assignment. */
ba85c8c3
AV
556tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
557 bool c = false);
6de9cd9a
DN
558
559/* Translate COMMON blocks. */
560void gfc_trans_common (gfc_namespace *);
561
f7b529fa 562/* Translate a derived type constructor. */
6de9cd9a
DN
563void gfc_conv_structure (gfc_se *, gfc_expr *, int);
564
565/* Return an expression which determines if a dummy parameter is present. */
892c7427 566tree gfc_conv_expr_present (gfc_symbol *, bool use_saved_decl = false);
e15e9be3 567/* Convert a missing, dummy argument into a null or zero. */
be9c3c6e 568void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
6de9cd9a 569
549188ea
JB
570/* Lowering of component references. */
571void gfc_conv_component_ref (gfc_se * se, gfc_ref * ref);
572void conv_parent_component_references (gfc_se * se, gfc_ref * ref);
573
574/* Automatically dereference var. */
575tree gfc_maybe_dereference_var (gfc_symbol *, tree, bool desc_only = false,
576 bool is_classarray = false);
577
6de9cd9a
DN
578/* Generate code to allocate a string temporary. */
579tree gfc_conv_string_tmp (gfc_se *, tree, tree);
ca2940c3
TS
580/* Get the string length variable belonging to an expression. */
581tree gfc_get_expr_charlen (gfc_expr *);
6de9cd9a 582/* Initialize a string length variable. */
4b7f8314 583void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
417ab240
JJ
584/* Ensure type sizes can be gimplified. */
585void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
6de9cd9a
DN
586
587/* Add an expression to the end of a block. */
588void gfc_add_expr_to_block (stmtblock_t *, tree);
46b2c440
MM
589/* Add an expression to the beginning of a block. */
590void gfc_prepend_expr_to_block (stmtblock_t *, tree);
6de9cd9a
DN
591/* Add a block to the end of a block. */
592void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
726a989a 593/* Add a MODIFY_EXPR to a block. */
55bd9c35 594void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
726a989a 595void gfc_add_modify (stmtblock_t *, tree, tree);
6de9cd9a
DN
596
597/* Initialize a statement block. */
598void gfc_init_block (stmtblock_t *);
69de3b83 599/* Start a new statement block. Like gfc_init_block but also starts a new
6de9cd9a
DN
600 variable scope. */
601void gfc_start_block (stmtblock_t *);
602/* Finish a statement block. Also closes the scope if the block was created
603 with gfc_start_block. */
604tree gfc_finish_block (stmtblock_t *);
605/* Merge the scope of a block with its parent. */
606void gfc_merge_block_scope (stmtblock_t * block);
607
608/* Return the backend label decl. */
609tree gfc_get_label_decl (gfc_st_label *);
610
611/* Return the decl for an external function. */
378f53c7 612tree gfc_get_extern_function_decl (gfc_symbol *,
36ec54aa
TK
613 gfc_actual_arglist *args = NULL,
614 const char *fnspec = NULL);
6de9cd9a
DN
615
616/* Return the decl for a function. */
617tree gfc_get_function_decl (gfc_symbol *);
618
6de9cd9a
DN
619/* Build an ADDR_EXPR. */
620tree gfc_build_addr_expr (tree, tree);
621
6de9cd9a 622/* Build an ARRAY_REF. */
f3b0bb7a 623tree gfc_build_array_ref (tree, tree, tree, tree vptr = NULL_TREE);
6de9cd9a 624
49de9e73 625/* Creates a label. Decl is artificial if label_id == NULL_TREE. */
6de9cd9a
DN
626tree gfc_build_label_decl (tree);
627
628/* Return the decl used to hold the function return value.
629 Do not use if the function has an explicit result variable. */
5f20c93a 630tree gfc_get_fake_result_decl (gfc_symbol *, int);
6de9cd9a 631
6de9cd9a
DN
632/* Add a decl to the binding level for the current function. */
633void gfc_add_decl_to_function (tree);
634
635/* Make prototypes for runtime library functions. */
636void gfc_build_builtin_function_decls (void);
637
c8cc8542
PB
638/* Set the backend source location of a decl. */
639void gfc_set_decl_location (tree, locus *);
640
0101807c
PT
641/* Get a module symbol backend_decl if possible. */
642bool gfc_get_module_backend_decl (gfc_symbol *);
643
6de9cd9a
DN
644/* Return the variable decl for a symbol. */
645tree gfc_get_symbol_decl (gfc_symbol *);
646
597073ac 647/* Build a static initializer. */
1d0134b3 648tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
597073ac 649
f40eccb0 650/* Assign a default initializer to a derived type. */
0019d498 651void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
f40eccb0 652
7b5b57b7
PB
653/* Substitute a temporary variable in place of the real one. */
654void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
655
656/* Restore the original variable. */
657void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
658
43ce5e52
FXC
659/* Setting a decl assembler name, mangling it according to target rules
660 (like Windows @NN decorations). */
661void gfc_set_decl_assembler_name (tree, tree);
662
bae88af6
TS
663/* Returns true if a variable of specified size should go on the stack. */
664int gfc_can_put_var_on_stack (tree);
665
92d28cbb
JJ
666/* Set GFC_DECL_SCALAR_* on decl from sym if needed. */
667void gfc_finish_decl_attrs (tree, symbol_attribute *);
668
69de3b83 669/* Allocate the lang-specific part of a decl node. */
6de9cd9a
DN
670void gfc_allocate_lang_decl (tree);
671
9c81750c
TB
672/* Get the location suitable for the ME from a gfortran locus; required to get
673 the column number right. */
674location_t gfc_get_location (locus *);
675
6de9cd9a
DN
676/* Advance along a TREE_CHAIN. */
677tree gfc_advance_chain (tree, int);
678
679/* Create a decl for a function. */
fb55ca75 680void gfc_create_function_decl (gfc_namespace *, bool);
6de9cd9a
DN
681/* Generate the code for a function. */
682void gfc_generate_function_code (gfc_namespace *);
0de4325e
TS
683/* Output a BLOCK DATA program unit. */
684void gfc_generate_block_data (gfc_namespace *);
6de9cd9a
DN
685/* Output a decl for a module variable. */
686void gfc_generate_module_vars (gfc_namespace *);
d74d8807
DK
687/* Get the appropriate return statement for a procedure. */
688tree gfc_generate_return (void);
6de9cd9a 689
ca752f39 690struct module_decl_hasher : ggc_ptr_hash<tree_node>
2a22f99c
TS
691{
692 typedef const char *compare_type;
693
694 static hashval_t hash (tree);
695 static bool equal (tree, const char *);
696};
697
698struct GTY((for_user)) module_htab_entry {
a64f5186
JJ
699 const char *name;
700 tree namespace_decl;
2a22f99c 701 hash_table<module_decl_hasher> *GTY (()) decls;
a64f5186
JJ
702};
703
704struct module_htab_entry *gfc_find_module (const char *);
705void gfc_module_add_decl (struct module_htab_entry *, tree);
706
6de9cd9a 707/* Get and set the current location. */
363aab21 708void gfc_save_backend_locus (locus *);
6de9cd9a 709void gfc_set_backend_locus (locus *);
363aab21 710void gfc_restore_backend_locus (locus *);
6de9cd9a
DN
711
712/* Handle static constructor functions. */
713extern GTY(()) tree gfc_static_ctors;
714void gfc_generate_constructors (void);
715
636da744 716/* Get the string length of an array constructor. */
b7e75771 717bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
636da744 718
4f13e17f 719/* Mark a condition as likely or unlikely. */
ed9c79e1
JJ
720tree gfc_likely (tree, enum br_predictor);
721tree gfc_unlikely (tree, enum br_predictor);
5af07930 722
2b3dc0db
PT
723/* Return the string length of a deferred character length component. */
724bool gfc_deferred_strlen (gfc_component *, tree *);
725
f25a62a5
DK
726/* Generate a runtime error call. */
727tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
f25a62a5 728
0d52899f
TB
729/* Generate a runtime warning/error check. */
730void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
731 const char *, ...);
6de9cd9a 732
fb5bc08b
DK
733/* Generate a runtime check for same string length. */
734void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
735 stmtblock_t*);
736
cd55d18e 737/* Generate a call to free(). */
1529b8d9
FXC
738tree gfc_call_free (tree);
739
740/* Allocate memory after performing a few checks. */
741tree gfc_call_malloc (stmtblock_t *, tree, tree);
742
12f681a0
DK
743/* Build a memcpy call. */
744tree gfc_build_memcpy_call (tree, tree, tree);
745
ba85c8c3
AV
746/* Register memory with the coarray library. */
747void gfc_allocate_using_caf_lib (stmtblock_t *, tree, tree, tree, tree, tree,
748 tree, gfc_coarray_regtype);
749
ea6363a3 750/* Allocate memory for allocatable variables, with optional status variable. */
5d81ddd0 751void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree,
3c9f5092 752 tree, tree, tree, gfc_expr*, int);
4376b7cf
FXC
753
754/* Allocate memory, with optional status variable. */
4f13e17f 755void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
4376b7cf
FXC
756
757/* Generate code to deallocate an array. */
5d81ddd0 758tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool,
39da5866
AV
759 gfc_expr *, int, tree a = NULL_TREE,
760 tree c = NULL_TREE);
ba85c8c3
AV
761tree gfc_deallocate_scalar_with_status (tree, tree, tree, bool, gfc_expr*,
762 gfc_typespec, bool c = false);
4376b7cf
FXC
763
764/* Generate code to call realloc(). */
765tree gfc_call_realloc (stmtblock_t *, tree, tree);
766
c16126ac 767/* Assign a derived type constructor to a variable. */
ba85c8c3 768tree gfc_trans_structure_assign (tree, gfc_expr *, bool, bool c = false);
c16126ac 769
1f2959f0 770/* Generate code for an assignment, includes scalarization. */
574284e9
AV
771tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool, bool p = false,
772 bool a = true);
6de9cd9a 773
49de9e73 774/* Generate code for a pointer assignment. */
6de9cd9a
DN
775tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
776
777/* Initialize function decls for library functions. */
778void gfc_build_intrinsic_lib_fndecls (void);
779/* Create function decls for IO library functions. */
780void gfc_build_io_library_fndecls (void);
781/* Build a function decl for a library function. */
782tree gfc_build_library_function_decl (tree, tree, int, ...);
3f34855a
TB
783tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
784 tree rettype, int nargs, ...);
6de9cd9a 785
9abe5e56 786/* Process the local variable decls of a block construct. */
6312ef45 787void gfc_process_block_locals (gfc_namespace*);
9abe5e56
DK
788
789/* Output initialization/clean-up code that was deferred. */
d74d8807 790void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
9abe5e56 791
fb55ca75 792/* In f95-lang.c. */
6de9cd9a
DN
793tree pushdecl (tree);
794tree pushdecl_top_level (tree);
87a60f68
SB
795void pushlevel (void);
796tree poplevel (int, int);
6de9cd9a 797tree getdecls (void);
fb55ca75
TB
798
799/* In trans-types.c. */
fad0afd7
JJ
800struct array_descr_info;
801bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
6de9cd9a 802
6c7a4dfd 803/* In trans-openmp.c */
08c14aaa 804bool gfc_omp_is_allocatable_or_ptr (const_tree);
a2c26c50 805tree gfc_omp_check_optional_argument (tree, bool);
92e63bd2 806tree gfc_omp_array_data (tree, bool);
58f9752a 807bool gfc_omp_privatize_by_reference (const_tree);
6c7a4dfd 808enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
93535a2b 809enum omp_clause_defaultmap_kind gfc_omp_predetermined_mapping (tree);
79943d19 810tree gfc_omp_report_decl (tree);
a68ab351
JJ
811tree gfc_omp_clause_default_ctor (tree, tree, tree);
812tree gfc_omp_clause_copy_ctor (tree, tree, tree);
813tree gfc_omp_clause_assign_op (tree, tree, tree);
da6f124d 814tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree);
a68ab351 815tree gfc_omp_clause_dtor (tree, tree);
972da557 816void gfc_omp_finish_clause (tree, gimple_seq *, bool);
b4c3a85b 817bool gfc_omp_scalar_p (tree);
6c7a4dfd
JJ
818bool gfc_omp_disregard_value_expr (tree, bool);
819bool gfc_omp_private_debug_clause (tree, bool);
a68ab351 820bool gfc_omp_private_outer_ref (tree);
6c7a4dfd
JJ
821struct gimplify_omp_ctx;
822void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
823
5c5ce609
HA
824/* In trans-intrinsic.c. */
825void gfc_conv_intrinsic_mvbits (gfc_se *, gfc_actual_arglist *,
826 gfc_loopinfo *);
827
6de9cd9a 828/* Runtime library function decls. */
6de9cd9a
DN
829extern GTY(()) tree gfor_fndecl_pause_numeric;
830extern GTY(()) tree gfor_fndecl_pause_string;
831extern GTY(()) tree gfor_fndecl_stop_numeric;
832extern GTY(()) tree gfor_fndecl_stop_string;
6d1b0f92 833extern GTY(()) tree gfor_fndecl_error_stop_numeric;
d0a4a61c 834extern GTY(()) tree gfor_fndecl_error_stop_string;
6de9cd9a 835extern GTY(()) tree gfor_fndecl_runtime_error;
f96d606f 836extern GTY(()) tree gfor_fndecl_runtime_error_at;
0d52899f 837extern GTY(()) tree gfor_fndecl_runtime_warning_at;
d74a8b05 838extern GTY(()) tree gfor_fndecl_os_error_at;
f96d606f 839extern GTY(()) tree gfor_fndecl_generate_error;
944b8b35 840extern GTY(()) tree gfor_fndecl_set_fpe;
68d2e027 841extern GTY(()) tree gfor_fndecl_set_options;
25fc05eb 842extern GTY(()) tree gfor_fndecl_ttynam;
35059811
FXC
843extern GTY(()) tree gfor_fndecl_ctime;
844extern GTY(()) tree gfor_fndecl_fdate;
6de9cd9a
DN
845extern GTY(()) tree gfor_fndecl_in_pack;
846extern GTY(()) tree gfor_fndecl_in_unpack;
bbf18dc5
PT
847extern GTY(()) tree gfor_fndecl_cfi_to_gfc;
848extern GTY(()) tree gfor_fndecl_gfc_to_cfi;
6de9cd9a 849extern GTY(()) tree gfor_fndecl_associated;
a416c4c7
FXC
850extern GTY(()) tree gfor_fndecl_system_clock4;
851extern GTY(()) tree gfor_fndecl_system_clock8;
6de9cd9a 852
60386f50
TB
853
854/* Coarray run-time library function decls. */
855extern GTY(()) tree gfor_fndecl_caf_init;
856extern GTY(()) tree gfor_fndecl_caf_finalize;
a8a5f4a9
TB
857extern GTY(()) tree gfor_fndecl_caf_this_image;
858extern GTY(()) tree gfor_fndecl_caf_num_images;
b8ff4e88 859extern GTY(()) tree gfor_fndecl_caf_register;
5d81ddd0 860extern GTY(()) tree gfor_fndecl_caf_deregister;
b5116268
TB
861extern GTY(()) tree gfor_fndecl_caf_get;
862extern GTY(()) tree gfor_fndecl_caf_send;
863extern GTY(()) tree gfor_fndecl_caf_sendget;
3c9f5092
AV
864extern GTY(()) tree gfor_fndecl_caf_get_by_ref;
865extern GTY(()) tree gfor_fndecl_caf_send_by_ref;
866extern GTY(()) tree gfor_fndecl_caf_sendget_by_ref;
60386f50 867extern GTY(()) tree gfor_fndecl_caf_sync_all;
9315dff0 868extern GTY(()) tree gfor_fndecl_caf_sync_memory;
60386f50 869extern GTY(()) tree gfor_fndecl_caf_sync_images;
0daa7ed9
AF
870extern GTY(()) tree gfor_fndecl_caf_stop_numeric;
871extern GTY(()) tree gfor_fndecl_caf_stop_str;
60386f50
TB
872extern GTY(()) tree gfor_fndecl_caf_error_stop;
873extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
42a8246d
TB
874extern GTY(()) tree gfor_fndecl_caf_atomic_def;
875extern GTY(()) tree gfor_fndecl_caf_atomic_ref;
876extern GTY(()) tree gfor_fndecl_caf_atomic_cas;
877extern GTY(()) tree gfor_fndecl_caf_atomic_op;
bc0229f9
TB
878extern GTY(()) tree gfor_fndecl_caf_lock;
879extern GTY(()) tree gfor_fndecl_caf_unlock;
5df445a2
TB
880extern GTY(()) tree gfor_fndecl_caf_event_post;
881extern GTY(()) tree gfor_fndecl_caf_event_wait;
882extern GTY(()) tree gfor_fndecl_caf_event_query;
ef78bc3c
AV
883extern GTY(()) tree gfor_fndecl_caf_fail_image;
884extern GTY(()) tree gfor_fndecl_caf_failed_images;
885extern GTY(()) tree gfor_fndecl_caf_image_status;
886extern GTY(()) tree gfor_fndecl_caf_stopped_images;
f8862a1b
DR
887extern GTY(()) tree gfor_fndecl_caf_form_team;
888extern GTY(()) tree gfor_fndecl_caf_change_team;
889extern GTY(()) tree gfor_fndecl_caf_end_team;
890extern GTY(()) tree gfor_fndecl_caf_get_team;
891extern GTY(()) tree gfor_fndecl_caf_sync_team;
892extern GTY(()) tree gfor_fndecl_caf_team_number;
a16ee379 893extern GTY(()) tree gfor_fndecl_co_broadcast;
d62cf3df
TB
894extern GTY(()) tree gfor_fndecl_co_max;
895extern GTY(()) tree gfor_fndecl_co_min;
229c5919 896extern GTY(()) tree gfor_fndecl_co_reduce;
d62cf3df 897extern GTY(()) tree gfor_fndecl_co_sum;
ba85c8c3 898extern GTY(()) tree gfor_fndecl_caf_is_present;
60386f50 899
6de9cd9a
DN
900/* Math functions. Many other math functions are handled in
901 trans-intrinsic.c. */
5b200ac2 902
d1b38208 903typedef struct GTY(()) gfc_powdecl_list {
5b200ac2
FW
904 tree integer;
905 tree real;
906 tree cmplx;
907}
908gfc_powdecl_list;
909
644cb69f 910extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
6de9cd9a
DN
911extern GTY(()) tree gfor_fndecl_math_ishftc4;
912extern GTY(()) tree gfor_fndecl_math_ishftc8;
644cb69f 913extern GTY(()) tree gfor_fndecl_math_ishftc16;
6de9cd9a 914
5a0aad31
FXC
915/* BLAS functions. */
916extern GTY(()) tree gfor_fndecl_sgemm;
917extern GTY(()) tree gfor_fndecl_dgemm;
918extern GTY(()) tree gfor_fndecl_cgemm;
919extern GTY(()) tree gfor_fndecl_zgemm;
920
6de9cd9a 921/* String functions. */
6de9cd9a
DN
922extern GTY(()) tree gfor_fndecl_compare_string;
923extern GTY(()) tree gfor_fndecl_concat_string;
924extern GTY(()) tree gfor_fndecl_string_len_trim;
925extern GTY(()) tree gfor_fndecl_string_index;
926extern GTY(()) tree gfor_fndecl_string_scan;
927extern GTY(()) tree gfor_fndecl_string_verify;
928extern GTY(()) tree gfor_fndecl_string_trim;
2263c775 929extern GTY(()) tree gfor_fndecl_string_minmax;
6de9cd9a
DN
930extern GTY(()) tree gfor_fndecl_adjustl;
931extern GTY(()) tree gfor_fndecl_adjustr;
d393bbd7 932extern GTY(()) tree gfor_fndecl_select_string;
374929b2
FXC
933extern GTY(()) tree gfor_fndecl_compare_string_char4;
934extern GTY(()) tree gfor_fndecl_concat_string_char4;
935extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
936extern GTY(()) tree gfor_fndecl_string_index_char4;
937extern GTY(()) tree gfor_fndecl_string_scan_char4;
938extern GTY(()) tree gfor_fndecl_string_verify_char4;
939extern GTY(()) tree gfor_fndecl_string_trim_char4;
940extern GTY(()) tree gfor_fndecl_string_minmax_char4;
941extern GTY(()) tree gfor_fndecl_adjustl_char4;
942extern GTY(()) tree gfor_fndecl_adjustr_char4;
d393bbd7
FXC
943extern GTY(()) tree gfor_fndecl_select_string_char4;
944
945/* Conversion between character kinds. */
946extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
947extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
6de9cd9a
DN
948
949/* Other misc. runtime library functions. */
950extern GTY(()) tree gfor_fndecl_size0;
951extern GTY(()) tree gfor_fndecl_size1;
b41b2534 952extern GTY(()) tree gfor_fndecl_iargc;
17164de4
SK
953extern GTY(()) tree gfor_fndecl_kill;
954extern GTY(()) tree gfor_fndecl_kill_sub;
419af57c 955extern GTY(()) tree gfor_fndecl_is_contiguous0;
6de9cd9a 956
a39fafac
FXC
957/* Implemented in Fortran. */
958extern GTY(()) tree gfor_fndecl_sc_kind;
6de9cd9a
DN
959extern GTY(()) tree gfor_fndecl_si_kind;
960extern GTY(()) tree gfor_fndecl_sr_kind;
961
3b7ea188
FXC
962/* IEEE-related. */
963extern GTY(()) tree gfor_fndecl_ieee_procedure_entry;
964extern GTY(()) tree gfor_fndecl_ieee_procedure_exit;
965
ddd3e26e
SK
966/* RANDOM_INIT. */
967extern GTY(()) tree gfor_fndecl_random_init;
6de9cd9a
DN
968
969/* True if node is an integer constant. */
970#define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
971
fe4e525c
TB
972/* gfortran-specific declaration information, the _CONT versions denote
973 arrays with CONTIGUOUS attribute. */
6de9cd9a 974
7fb43006
PT
975#define GFC_DTYPE_ELEM_LEN 0
976#define GFC_DTYPE_VERSION 1
977#define GFC_DTYPE_RANK 2
978#define GFC_DTYPE_TYPE 3
979#define GFC_DTYPE_ATTRIBUTE 4
980
fad0afd7
JJ
981enum gfc_array_kind
982{
983 GFC_ARRAY_UNKNOWN,
984 GFC_ARRAY_ASSUMED_SHAPE,
fe4e525c 985 GFC_ARRAY_ASSUMED_SHAPE_CONT,
c62c6622
TB
986 GFC_ARRAY_ASSUMED_RANK,
987 GFC_ARRAY_ASSUMED_RANK_CONT,
fad0afd7 988 GFC_ARRAY_ALLOCATABLE,
fe4e525c
TB
989 GFC_ARRAY_POINTER,
990 GFC_ARRAY_POINTER_CONT
fad0afd7
JJ
991};
992
6de9cd9a 993/* Array types only. */
766090c2 994struct GTY(()) lang_type {
a3935ffc 995 int rank, corank;
fad0afd7 996 enum gfc_array_kind akind;
6de9cd9a
DN
997 tree lbound[GFC_MAX_DIMENSIONS];
998 tree ubound[GFC_MAX_DIMENSIONS];
999 tree stride[GFC_MAX_DIMENSIONS];
1000 tree size;
1001 tree offset;
1002 tree dtype;
1003 tree dataptr_type;
d560566a 1004 tree base_decl[2];
b3c1b8a1 1005 tree nonrestricted_type;
b8ff4e88 1006 tree caf_token;
0c53708e 1007 tree caf_offset;
6de9cd9a
DN
1008};
1009
766090c2 1010struct GTY(()) lang_decl {
6de9cd9a
DN
1011 /* Dummy variables. */
1012 tree saved_descriptor;
1013 /* Assigned integer nodes. Stringlength is the IO format string's length.
1014 Addr is the address of the string or the target label. Stringlength is
1f2959f0 1015 initialized to -2 and assigned to -1 when addr is assigned to the
6de9cd9a
DN
1016 address of target label. */
1017 tree stringlen;
1018 tree addr;
aa13dc3c
TB
1019 /* For assumed-shape coarrays. */
1020 tree token, caf_offset;
92d28cbb
JJ
1021 unsigned int scalar_allocatable : 1;
1022 unsigned int scalar_pointer : 1;
73a28634 1023 unsigned int optional_arg : 1;
6de9cd9a
DN
1024};
1025
1026
1027#define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
1028#define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
aa13dc3c
TB
1029#define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
1030#define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
6de9cd9a
DN
1031#define GFC_DECL_SAVED_DESCRIPTOR(node) \
1032 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
92d28cbb
JJ
1033#define GFC_DECL_SCALAR_ALLOCATABLE(node) \
1034 (DECL_LANG_SPECIFIC (node)->scalar_allocatable)
1035#define GFC_DECL_SCALAR_POINTER(node) \
1036 (DECL_LANG_SPECIFIC (node)->scalar_pointer)
73a28634
KCY
1037#define GFC_DECL_OPTIONAL_ARGUMENT(node) \
1038 (DECL_LANG_SPECIFIC (node)->optional_arg)
92d28cbb
JJ
1039#define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
1040 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
1041#define GFC_DECL_GET_SCALAR_POINTER(node) \
1042 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
6de9cd9a
DN
1043#define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
1044#define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
1045#define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
6c7a4dfd
JJ
1046#define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
1047#define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
1048#define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
ff3598bc 1049#define GFC_DECL_PTR_ARRAY_P(node) DECL_LANG_FLAG_6(node)
92d28cbb 1050#define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
c49ea23d 1051#define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
6de9cd9a
DN
1052
1053/* An array descriptor. */
1054#define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
1055/* An array without a descriptor. */
1056#define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
8f75db9f
PT
1057/* Fortran CLASS type. */
1058#define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
6de9cd9a
DN
1059/* The GFC_TYPE_ARRAY_* members are present in both descriptor and
1060 descriptorless array types. */
1061#define GFC_TYPE_ARRAY_LBOUND(node, dim) \
1062 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
1063#define GFC_TYPE_ARRAY_UBOUND(node, dim) \
1064 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
1065#define GFC_TYPE_ARRAY_STRIDE(node, dim) \
1066 (TYPE_LANG_SPECIFIC(node)->stride[dim])
1067#define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
a3935ffc 1068#define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
b8ff4e88 1069#define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
0c53708e 1070#define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
6de9cd9a
DN
1071#define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
1072#define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
fad0afd7 1073#define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
df2fba9e 1074/* Code should use gfc_get_dtype instead of accessing this directly. It may
40b026d8 1075 not be known when the type is created. */
6de9cd9a
DN
1076#define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
1077#define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
1078 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
d560566a
AO
1079#define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
1080 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
6de9cd9a 1081
5d44e5c8 1082
6de9cd9a 1083/* Build an expression with void type. */
5d44e5c8
TB
1084#define build1_v(code, arg) \
1085 fold_build1_loc (input_location, code, void_type_node, arg)
1086#define build2_v(code, arg1, arg2) \
1087 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
1088#define build3_v(code, arg1, arg2, arg3) \
1089 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
1090#define build4_v(code, arg1, arg2, arg3, arg4) \
1091 build4_loc (input_location, code, void_type_node, arg1, arg2, \
1092 arg3, arg4)
62ab4a54
RS
1093
1094/* This group of functions allows a caller to evaluate an expression from
1095 the callee's interface. It establishes a mapping between the interface's
1096 dummy arguments and the caller's actual arguments, then applies that
1097 mapping to a given gfc_expr.
1098
1099 You can initialize a mapping structure like so:
1100
1101 gfc_interface_mapping mapping;
1102 ...
1103 gfc_init_interface_mapping (&mapping);
1104
1105 You should then evaluate each actual argument into a temporary
1106 gfc_se structure, here called "se", and map the result to the
1107 dummy argument's symbol, here called "sym":
1108
1109 gfc_add_interface_mapping (&mapping, sym, &se);
1110
1111 After adding all mappings, you should call:
1112
1113 gfc_finish_interface_mapping (&mapping, pre, post);
1114
1115 where "pre" and "post" are statement blocks for initialization
1116 and finalization code respectively. You can then evaluate an
1117 interface expression "expr" as follows:
1118
1119 gfc_apply_interface_mapping (&mapping, se, expr);
1120
1121 Once you've evaluated all expressions, you should free
1122 the mapping structure with:
1123
1124 gfc_free_interface_mapping (&mapping); */
1125
1126
1127/* This structure represents a mapping from OLD to NEW, where OLD is a
1128 dummy argument symbol and NEW is a symbol that represents the value
1129 of an actual argument. Mappings are linked together using NEXT
1130 (in no particular order). */
1131typedef struct gfc_interface_sym_mapping
1132{
1133 struct gfc_interface_sym_mapping *next;
1134 gfc_symbol *old;
7b901ac4 1135 gfc_symtree *new_sym;
0a164a3c 1136 gfc_expr *expr;
62ab4a54
RS
1137}
1138gfc_interface_sym_mapping;
1139
1140
1141/* This structure is used by callers to evaluate an expression from
1142 a callee's interface. */
1143typedef struct gfc_interface_mapping
1144{
1145 /* Maps the interface's dummy arguments to the values that the caller
1146 is passing. The whole list is owned by this gfc_interface_mapping. */
1147 gfc_interface_sym_mapping *syms;
1148
1149 /* A list of gfc_charlens that were needed when creating copies of
1150 expressions. The whole list is owned by this gfc_interface_mapping. */
1151 gfc_charlen *charlens;
1152}
1153gfc_interface_mapping;
1154
1155void gfc_init_interface_mapping (gfc_interface_mapping *);
1156void gfc_free_interface_mapping (gfc_interface_mapping *);
1157void gfc_add_interface_mapping (gfc_interface_mapping *,
0a164a3c 1158 gfc_symbol *, gfc_se *, gfc_expr *);
62ab4a54
RS
1159void gfc_finish_interface_mapping (gfc_interface_mapping *,
1160 stmtblock_t *, stmtblock_t *);
1161void gfc_apply_interface_mapping (gfc_interface_mapping *,
1162 gfc_se *, gfc_expr *);
1163
dd18a33b
FXC
1164
1165/* Standard error messages used in all the trans-*.c files. */
7e49f965
TS
1166extern const char gfc_msg_fault[];
1167extern const char gfc_msg_wrong_return[];
dd18a33b 1168
34d01e1d
VL
1169#define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
1170#define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
1171 construct is not workshared. */
1172#define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
1173 to create parallel loops. */
57bf3072
JJ
1174#define OMPWS_SCALARIZER_BODY 8 /* Set if handling body of potential
1175 parallel loop. */
1176#define OMPWS_NOWAIT 16 /* Use NOWAIT on OMP_FOR. */
34d01e1d 1177extern int ompws_flags;
dd18a33b 1178
6de9cd9a 1179#endif /* GFC_TRANS_H */