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