1/* Header for code translation functions
2 Copyright (C) 2002-2022 Free Software Foundation, Inc.
3 Contributed by Paul Brook
4
5This file is part of GCC.
6
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
9Software Foundation; either version 3, or (at your option) any later
10version.
11
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.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GFC_TRANS_H
22#define GFC_TRANS_H
23
24#include "predict.h" /* For enum br_predictor and PRED_*. */
25
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)
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;
35 unsigned int has_scope:1;
36}
37stmtblock_t;
38
39/* a simplified expression */
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
52 /* When expr is a reference to a class object, store its vptr access
53 here. */
54 tree class_vptr;
55
56 /* Whether expr is a reference to an unlimited polymorphic object. */
57 unsigned unlimited_polymorphic:1;
58
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
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
82 /* Ignore absent optional arguments. Used for some intrinsics. */
83 unsigned ignore_optional:1;
84
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
89 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
90 unsigned no_function_call:1;
91
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
97 /* If set, will pass subref descriptors without a temporary. */
98 unsigned force_no_tmp:1;
99
100 /* Unconditionally calculate offset for array segments and constant
101 arrays in gfc_conv_expr_descriptor. */
102 unsigned use_offset:1;
103
104 unsigned want_coarray:1;
105
106 /* Scalarization parameters. */
107 struct gfc_se *parent;
108 struct gfc_ss *ss;
109 struct gfc_loopinfo *loop;
110}
111gfc_se;
112
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;
121
122/* Denotes different types of coarray.
123 Please keep in sync with libgfortran/caf/libcaf.h. */
124enum gfc_coarray_regtype
125{
126 GFC_CAF_COARRAY_STATIC,
127 GFC_CAF_COARRAY_ALLOC,
128 GFC_CAF_LOCK_STATIC,
129 GFC_CAF_LOCK_ALLOC,
130 GFC_CAF_CRITICAL,
131 GFC_CAF_EVENT_STATIC,
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
148};
149
150
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
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
181/* The array-specific scalarization information. The array members of
182 this struct are indexed by actual array index, and thus can be sparse. */
183
184typedef struct gfc_array_info
185{
186 mpz_t *shape;
187
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];
205 tree end[GFC_MAX_DIMENSIONS];
206 tree stride[GFC_MAX_DIMENSIONS];
207 tree delta[GFC_MAX_DIMENSIONS];
208}
209gfc_array_info;
210
211enum gfc_ss_type
212{
213 /* A scalar value. This will be evaluated before entering the
214 scalarization loop. */
215 GFC_SS_SCALAR,
216
217 /* Like GFC_SS_SCALAR it evaluates the expression outside the
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. */
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.
230 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
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
239 /* A vector subscript. The vector's descriptor is cached in the
240 "descriptor" field of the associated gfc_ss_info. */
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. */
249 GFC_SS_INTRINSIC,
250
251 /* A component of a derived type. */
252 GFC_SS_COMPONENT
253};
254
255
256typedef struct gfc_ss_info
257{
258 int refcount;
259 gfc_ss_type type;
260 gfc_expr *expr;
261 tree string_length;
262
263 union
264 {
265 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
266 struct
267 {
268 /* If the scalar is passed as actual argument to an (elemental) procedure,
269 this is the corresponding dummy argument. */
270 gfc_dummy_arg *dummy_arg;
271 tree value;
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;
276 }
277 scalar;
278
279 /* GFC_SS_TEMP. */
280 struct
281 {
282 tree type;
283 }
284 temp;
285
286 /* All other types. */
287 gfc_array_info array;
288 }
289 data;
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;
295
296 /* Suppresses precalculation of scalars in WHERE assignments. */
297 unsigned where:1;
298
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
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;
307}
308gfc_ss_info;
309
310#define gfc_get_ss_info() XCNEW (gfc_ss_info)
311
312
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
319 otherwise they will not get freed. */
320
321typedef struct gfc_ss
322{
323 gfc_ss_info *info;
324
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
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
335 /* Non-null if the ss is part of a nested loop. */
336 struct gfc_ss *parent;
337
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
343 /* The loop this gfc_ss is in. */
344 struct gfc_loopinfo *loop;
345
346 unsigned is_alloc_lhs:1;
347 unsigned no_bounds_check:1;
348}
349gfc_ss;
350#define gfc_get_ss() XCNEW (gfc_ss)
351
352/* The contents of this aren't actually used. A NULL SS chain indicates a
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
362 int dimen;
363
364 /* All the SS involved with this loop. */
365 gfc_ss *ss;
366 /* The SS describing the temporary used in an assignment. */
367 gfc_ss *temp_ss;
368
369 /* Non-null if this loop is nested in another one. */
370 struct gfc_loopinfo *parent;
371
372 /* Chain of nested loops. */
373 struct gfc_loopinfo *nested, *next;
374
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
389 /* Enum to control loop reversal. */
390 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
391
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
400#define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
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
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
423/* Class API functions. */
424tree gfc_class_set_static_fields (tree, tree, tree);
425tree gfc_class_data_get (tree);
426tree gfc_class_vptr_get (tree);
427tree gfc_class_len_get (tree);
428tree gfc_resize_class_size_with_len (stmtblock_t *, tree, tree);
429gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *, bool is_mold = false,
430 gfc_typespec **ts = NULL);
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);
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. */
439tree gfc_vptr_hash_get (tree);
440tree gfc_vptr_size_get (tree);
441tree gfc_vptr_def_init_get (tree);
442tree gfc_vptr_copy_get (tree);
443tree gfc_vptr_final_get (tree);
444tree gfc_vptr_deallocate_get (tree);
445void gfc_reset_vptr (stmtblock_t *, gfc_expr *);
446void gfc_reset_len (stmtblock_t *, gfc_expr *);
447tree gfc_get_class_from_gfc_expr (gfc_expr *);
448tree gfc_get_class_from_expr (tree);
449tree gfc_get_vptr_from_expr (tree);
450tree gfc_copy_class_to_class (tree, tree, tree, bool);
451bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *);
452bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool);
453
454void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool,
455 bool, tree *derived_array = NULL);
456void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool,
457 bool, bool);
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
469/* Advance the SS chain to the next term. */
470void gfc_advance_se_ss_chain (gfc_se *);
471
472/* Call this to initialize a gfc_se structure before use
473 first parameter is structure to initialize, second is
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
489/* Compare two strings. */
490tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
491
492/* When using the gfc_conv_* make sure you understand what they do, i.e.
493 when a POST chain may be created, and what the returned expression may be
494 used for. Note that character strings have special handling. This
495 should not be a problem as most statements/operations only deal with
496 numeric/logical types. See the implementations in trans-expr.cc
497 for details of the individual functions. */
498
499void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
500void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
501void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
502void gfc_conv_expr_reference (gfc_se * se, gfc_expr * expr,
503 bool add_clobber = false);
504void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
505
506
507/* trans-expr.cc */
508tree gfc_get_character_len_in_bytes (tree);
509tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute);
510tree gfc_get_ultimate_alloc_ptr_comps_caf_token (gfc_se *, gfc_expr *);
511tree gfc_string_to_single_character (tree len, tree str, int kind);
512tree gfc_get_tree_for_caf_expr (gfc_expr *);
513void gfc_get_caf_token_offset (gfc_se*, tree *, tree *, tree, tree, gfc_expr *);
514tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree);
515void gfc_simple_for_loop (stmtblock_t *, tree, tree, tree, enum tree_code, tree,
516 tree);
517
518/* Find the decl containing the auxiliary variables for assigned variables. */
519void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
520/* If the value is not constant, Create a temporary and copy the value. */
521tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
522tree gfc_evaluate_now (tree, stmtblock_t *);
523tree gfc_evaluate_now_function_scope (tree, stmtblock_t *);
524
525/* Find the appropriate variant of a math intrinsic. */
526tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
527
528tree size_of_string_in_bytes (int, tree);
529
530/* Intrinsic procedure handling. */
531tree gfc_conv_intrinsic_subroutine (gfc_code *);
532void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
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
537bool gfc_expr_is_variable (gfc_expr *);
538
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. */
542int gfc_is_intrinsic_libcall (gfc_expr *);
543
544/* Used to call ordinary functions/subroutines
545 and procedure pointer components. */
546int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
547 gfc_expr *, vec<tree, va_gc> *);
548
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,
552 gfc_symbol *sym = NULL,
553 bool check_contiguous = false);
554
555void gfc_conv_is_contiguous_expr (gfc_se *, gfc_expr *);
556
557/* Generate code for a scalar assignment. */
558tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
559 bool c = false);
560
561/* Translate COMMON blocks. */
562void gfc_trans_common (gfc_namespace *);
563
564/* Translate a derived type constructor. */
565void gfc_conv_structure (gfc_se *, gfc_expr *, int);
566
567/* Return an expression which determines if a dummy parameter is present. */
568tree gfc_conv_expr_present (gfc_symbol *, bool use_saved_decl = false);
569/* Convert a missing, dummy argument into a null or zero. */
570void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
571
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
580/* Generate code to allocate a string temporary. */
581tree gfc_conv_string_tmp (gfc_se *, tree, tree);
582/* Get the string length variable belonging to an expression. */
583tree gfc_get_expr_charlen (gfc_expr *);
584/* Initialize a string length variable. */
585void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
586/* Ensure type sizes can be gimplified. */
587void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
588
589/* Add an expression to the end of a block. */
590void gfc_add_expr_to_block (stmtblock_t *, tree);
591/* Add an expression to the beginning of a block. */
592void gfc_prepend_expr_to_block (stmtblock_t *, tree);
593/* Add a block to the end of a block. */
594void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
595/* Add a MODIFY_EXPR to a block. */
596void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
597void gfc_add_modify (stmtblock_t *, tree, tree);
598
599/* Initialize a statement block. */
600void gfc_init_block (stmtblock_t *);
601/* Start a new statement block. Like gfc_init_block but also starts a new
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. */
614tree gfc_get_extern_function_decl (gfc_symbol *,
615 gfc_actual_arglist *args = NULL,
616 const char *fnspec = NULL);
617
618/* Build an ADDR_EXPR. */
619tree gfc_build_addr_expr (tree, tree);
620
621/* Build an ARRAY_REF. */
622tree gfc_build_array_ref (tree, tree, tree,
623 bool non_negative_offset = false,
624 tree vptr = NULL_TREE);
625
626/* Build an array ref using pointer arithmetic. */
627tree gfc_build_spanned_array_ref (tree base, tree offset, tree span);
628
629/* Creates a label. Decl is artificial if label_id == NULL_TREE. */
630tree gfc_build_label_decl (tree);
631
632/* Return the decl used to hold the function return value.
633 Do not use if the function has an explicit result variable. */
634tree gfc_get_fake_result_decl (gfc_symbol *, int);
635
636/* Add a decl to the binding level for the current function. */
637void gfc_add_decl_to_function (tree);
638
639/* Make prototypes for runtime library functions. */
640void gfc_build_builtin_function_decls (void);
641
642/* Set the backend source location of a decl. */
643void gfc_set_decl_location (tree, locus *);
644
645/* Get a module symbol backend_decl if possible. */
646bool gfc_get_module_backend_decl (gfc_symbol *);
647
648/* Return the variable decl for a symbol. */
649tree gfc_get_symbol_decl (gfc_symbol *);
650
651/* Build a static initializer. */
652tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
653
654/* Assign a default initializer to a derived type. */
655void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
656
657/* Substitute a temporary variable in place of the real one. */
658void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
659
660/* Restore the original variable. */
661void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
662
663/* Setting a decl assembler name, mangling it according to target rules
664 (like Windows @NN decorations). */
665void gfc_set_decl_assembler_name (tree, tree);
666
667/* Returns true if a variable of specified size should go on the stack. */
668int gfc_can_put_var_on_stack (tree);
669
670/* Set GFC_DECL_SCALAR_* on decl from sym if needed. */
671void gfc_finish_decl_attrs (tree, symbol_attribute *);
672
673/* Allocate the lang-specific part of a decl node. */
674void gfc_allocate_lang_decl (tree);
675
676/* Get the location suitable for the ME from a gfortran locus; required to get
677 the column number right. */
678location_t gfc_get_location (locus *);
679
680/* Advance along a TREE_CHAIN. */
681tree gfc_advance_chain (tree, int);
682
683/* Create a decl for a function. */
684void gfc_create_function_decl (gfc_namespace *, bool);
685/* Generate the code for a function. */
686void gfc_generate_function_code (gfc_namespace *);
687/* Output a BLOCK DATA program unit. */
688void gfc_generate_block_data (gfc_namespace *);
689/* Output a decl for a module variable. */
690void gfc_generate_module_vars (gfc_namespace *);
691/* Get the appropriate return statement for a procedure. */
692tree gfc_generate_return (void);
693
694struct module_decl_hasher : ggc_ptr_hash<tree_node>
695{
696 typedef const char *compare_type;
697
698 static hashval_t hash (tree);
699 static bool equal (tree, const char *);
700};
701
702struct GTY((for_user)) module_htab_entry {
703 const char *name;
704 tree namespace_decl;
705 hash_table<module_decl_hasher> *GTY (()) decls;
706};
707
708struct module_htab_entry *gfc_find_module (const char *);
709void gfc_module_add_decl (struct module_htab_entry *, tree);
710
711/* Get and set the current location. */
712void gfc_save_backend_locus (locus *);
713void gfc_set_backend_locus (locus *);
714void gfc_restore_backend_locus (locus *);
715
716/* Handle static constructor functions. */
717extern GTY(()) tree gfc_static_ctors;
718void gfc_generate_constructors (void);
719
720/* Get the string length of an array constructor. */
721bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
722
723/* Mark a condition as likely or unlikely. */
724tree gfc_likely (tree, enum br_predictor);
725tree gfc_unlikely (tree, enum br_predictor);
726
727/* Return the string length of a deferred character length component. */
728bool gfc_deferred_strlen (gfc_component *, tree *);
729
730/* Generate a runtime error call. */
731tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
732
733/* Generate a runtime warning/error check. */
734void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
735 const char *, ...);
736
737/* Generate a runtime check for same string length. */
738void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
739 stmtblock_t*);
740
741/* Generate a call to free(). */
742tree gfc_call_free (tree);
743
744/* Allocate memory after performing a few checks. */
745tree gfc_call_malloc (stmtblock_t *, tree, tree);
746
747/* Build a memcpy call. */
748tree gfc_build_memcpy_call (tree, tree, tree);
749
750/* Register memory with the coarray library. */
751void gfc_allocate_using_caf_lib (stmtblock_t *, tree, tree, tree, tree, tree,
752 tree, gfc_coarray_regtype);
753
754/* Allocate memory for allocatable variables, with optional status variable. */
755void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree,
756 tree, tree, tree, gfc_expr*, int);
757
758/* Allocate memory, with optional status variable. */
759void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
760
761/* Generate code to deallocate an array. */
762tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool,
763 gfc_expr *, int, tree a = NULL_TREE,
764 tree c = NULL_TREE);
765tree gfc_deallocate_scalar_with_status (tree, tree, tree, bool, gfc_expr*,
766 gfc_typespec, bool c = false);
767
768/* Generate code to call realloc(). */
769tree gfc_call_realloc (stmtblock_t *, tree, tree);
770
771/* Assign a derived type constructor to a variable. */
772tree gfc_trans_structure_assign (tree, gfc_expr *, bool, bool c = false);
773
774/* Generate code for an assignment, includes scalarization. */
775tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool, bool p = false,
776 bool a = true);
777
778/* Generate code for a pointer assignment. */
779tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
780
781/* Initialize function decls for library functions. */
782void gfc_build_intrinsic_lib_fndecls (void);
783/* Create function decls for IO library functions. */
784void gfc_build_io_library_fndecls (void);
785/* Build a function decl for a library function. */
786tree gfc_build_library_function_decl (tree, tree, int, ...);
787tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
788 tree rettype, int nargs, ...);
789
790/* Process the local variable decls of a block construct. */
791void gfc_process_block_locals (gfc_namespace*);
792
793/* Output initialization/clean-up code that was deferred. */
794void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
795
796/* In f95-lang.cc. */
797tree pushdecl (tree);
798tree pushdecl_top_level (tree);
799void pushlevel (void);
800tree poplevel (int, int);
801tree getdecls (void);
802
803/* In trans-types.cc. */
804struct array_descr_info;
805bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
806
807/* In trans-openmp.cc */
808bool gfc_omp_is_allocatable_or_ptr (const_tree);
809tree gfc_omp_check_optional_argument (tree, bool);
810tree gfc_omp_array_data (tree, bool);
811tree gfc_omp_array_size (tree, gimple_seq *);
812bool gfc_omp_privatize_by_reference (const_tree);
813enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
814enum omp_clause_defaultmap_kind gfc_omp_predetermined_mapping (tree);
815tree gfc_omp_report_decl (tree);
816tree gfc_omp_clause_default_ctor (tree, tree, tree);
817tree gfc_omp_clause_copy_ctor (tree, tree, tree);
818tree gfc_omp_clause_assign_op (tree, tree, tree);
819tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree);
820tree gfc_omp_clause_dtor (tree, tree);
821void gfc_omp_finish_clause (tree, gimple_seq *, bool);
822bool gfc_omp_allocatable_p (tree);
823bool gfc_omp_scalar_p (tree, bool);
824bool gfc_omp_scalar_target_p (tree);
825bool gfc_omp_disregard_value_expr (tree, bool);
826bool gfc_omp_private_debug_clause (tree, bool);
827bool gfc_omp_private_outer_ref (tree);
828struct gimplify_omp_ctx;
829void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
830
831/* In trans-intrinsic.cc. */
832void gfc_conv_intrinsic_mvbits (gfc_se *, gfc_actual_arglist *,
833 gfc_loopinfo *);
834
835/* Runtime library function decls. */
836extern GTY(()) tree gfor_fndecl_pause_numeric;
837extern GTY(()) tree gfor_fndecl_pause_string;
838extern GTY(()) tree gfor_fndecl_stop_numeric;
839extern GTY(()) tree gfor_fndecl_stop_string;
840extern GTY(()) tree gfor_fndecl_error_stop_numeric;
841extern GTY(()) tree gfor_fndecl_error_stop_string;
842extern GTY(()) tree gfor_fndecl_runtime_error;
843extern GTY(()) tree gfor_fndecl_runtime_error_at;
844extern GTY(()) tree gfor_fndecl_runtime_warning_at;
845extern GTY(()) tree gfor_fndecl_os_error_at;
846extern GTY(()) tree gfor_fndecl_generate_error;
847extern GTY(()) tree gfor_fndecl_set_fpe;
848extern GTY(()) tree gfor_fndecl_set_options;
849extern GTY(()) tree gfor_fndecl_ttynam;
850extern GTY(()) tree gfor_fndecl_ctime;
851extern GTY(()) tree gfor_fndecl_fdate;
852extern GTY(()) tree gfor_fndecl_in_pack;
853extern GTY(()) tree gfor_fndecl_in_unpack;
854extern GTY(()) tree gfor_fndecl_associated;
855extern GTY(()) tree gfor_fndecl_system_clock4;
856extern GTY(()) tree gfor_fndecl_system_clock8;
857
858
859/* Coarray run-time library function decls. */
860extern GTY(()) tree gfor_fndecl_caf_init;
861extern GTY(()) tree gfor_fndecl_caf_finalize;
862extern GTY(()) tree gfor_fndecl_caf_this_image;
863extern GTY(()) tree gfor_fndecl_caf_num_images;
864extern GTY(()) tree gfor_fndecl_caf_register;
865extern GTY(()) tree gfor_fndecl_caf_deregister;
866extern GTY(()) tree gfor_fndecl_caf_get;
867extern GTY(()) tree gfor_fndecl_caf_send;
868extern GTY(()) tree gfor_fndecl_caf_sendget;
869extern GTY(()) tree gfor_fndecl_caf_get_by_ref;
870extern GTY(()) tree gfor_fndecl_caf_send_by_ref;
871extern GTY(()) tree gfor_fndecl_caf_sendget_by_ref;
872extern GTY(()) tree gfor_fndecl_caf_sync_all;
873extern GTY(()) tree gfor_fndecl_caf_sync_memory;
874extern GTY(()) tree gfor_fndecl_caf_sync_images;
875extern GTY(()) tree gfor_fndecl_caf_stop_numeric;
876extern GTY(()) tree gfor_fndecl_caf_stop_str;
877extern GTY(()) tree gfor_fndecl_caf_error_stop;
878extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
879extern GTY(()) tree gfor_fndecl_caf_atomic_def;
880extern GTY(()) tree gfor_fndecl_caf_atomic_ref;
881extern GTY(()) tree gfor_fndecl_caf_atomic_cas;
882extern GTY(()) tree gfor_fndecl_caf_atomic_op;
883extern GTY(()) tree gfor_fndecl_caf_lock;
884extern GTY(()) tree gfor_fndecl_caf_unlock;
885extern GTY(()) tree gfor_fndecl_caf_event_post;
886extern GTY(()) tree gfor_fndecl_caf_event_wait;
887extern GTY(()) tree gfor_fndecl_caf_event_query;
888extern GTY(()) tree gfor_fndecl_caf_fail_image;
889extern GTY(()) tree gfor_fndecl_caf_failed_images;
890extern GTY(()) tree gfor_fndecl_caf_image_status;
891extern GTY(()) tree gfor_fndecl_caf_stopped_images;
892extern GTY(()) tree gfor_fndecl_caf_form_team;
893extern GTY(()) tree gfor_fndecl_caf_change_team;
894extern GTY(()) tree gfor_fndecl_caf_end_team;
895extern GTY(()) tree gfor_fndecl_caf_get_team;
896extern GTY(()) tree gfor_fndecl_caf_sync_team;
897extern GTY(()) tree gfor_fndecl_caf_team_number;
898extern GTY(()) tree gfor_fndecl_co_broadcast;
899extern GTY(()) tree gfor_fndecl_co_max;
900extern GTY(()) tree gfor_fndecl_co_min;
901extern GTY(()) tree gfor_fndecl_co_reduce;
902extern GTY(()) tree gfor_fndecl_co_sum;
903extern GTY(()) tree gfor_fndecl_caf_is_present;
904
905/* Math functions. Many other math functions are handled in
906 trans-intrinsic.cc. */
907
908typedef struct GTY(()) gfc_powdecl_list {
909 tree integer;
910 tree real;
911 tree cmplx;
912}
913gfc_powdecl_list;
914
915extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
916extern GTY(()) tree gfor_fndecl_math_ishftc4;
917extern GTY(()) tree gfor_fndecl_math_ishftc8;
918extern GTY(()) tree gfor_fndecl_math_ishftc16;
919
920/* BLAS functions. */
921extern GTY(()) tree gfor_fndecl_sgemm;
922extern GTY(()) tree gfor_fndecl_dgemm;
923extern GTY(()) tree gfor_fndecl_cgemm;
924extern GTY(()) tree gfor_fndecl_zgemm;
925
926/* String functions. */
927extern GTY(()) tree gfor_fndecl_compare_string;
928extern GTY(()) tree gfor_fndecl_concat_string;
929extern GTY(()) tree gfor_fndecl_string_len_trim;
930extern GTY(()) tree gfor_fndecl_string_index;
931extern GTY(()) tree gfor_fndecl_string_scan;
932extern GTY(()) tree gfor_fndecl_string_verify;
933extern GTY(()) tree gfor_fndecl_string_trim;
934extern GTY(()) tree gfor_fndecl_string_minmax;
935extern GTY(()) tree gfor_fndecl_adjustl;
936extern GTY(()) tree gfor_fndecl_adjustr;
937extern GTY(()) tree gfor_fndecl_select_string;
938extern GTY(()) tree gfor_fndecl_compare_string_char4;
939extern GTY(()) tree gfor_fndecl_concat_string_char4;
940extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
941extern GTY(()) tree gfor_fndecl_string_index_char4;
942extern GTY(()) tree gfor_fndecl_string_scan_char4;
943extern GTY(()) tree gfor_fndecl_string_verify_char4;
944extern GTY(()) tree gfor_fndecl_string_trim_char4;
945extern GTY(()) tree gfor_fndecl_string_minmax_char4;
946extern GTY(()) tree gfor_fndecl_adjustl_char4;
947extern GTY(()) tree gfor_fndecl_adjustr_char4;
948extern GTY(()) tree gfor_fndecl_select_string_char4;
949
950/* Conversion between character kinds. */
951extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
952extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
953
954/* Other misc. runtime library functions. */
955extern GTY(()) tree gfor_fndecl_iargc;
956extern GTY(()) tree gfor_fndecl_kill;
957extern GTY(()) tree gfor_fndecl_kill_sub;
958extern GTY(()) tree gfor_fndecl_is_contiguous0;
959
960/* Implemented in Fortran. */
961extern GTY(()) tree gfor_fndecl_sc_kind;
962extern GTY(()) tree gfor_fndecl_si_kind;
963extern GTY(()) tree gfor_fndecl_sr_kind;
964
965/* IEEE-related. */
966extern GTY(()) tree gfor_fndecl_ieee_procedure_entry;
967extern GTY(()) tree gfor_fndecl_ieee_procedure_exit;
968
969/* RANDOM_INIT. */
970extern GTY(()) tree gfor_fndecl_random_init;
971extern GTY(()) tree gfor_fndecl_caf_random_init;
972
973/* True if node is an integer constant. */
974#define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
975
976/* gfortran-specific declaration information, the _CONT versions denote
977 arrays with CONTIGUOUS attribute. */
978
979#define GFC_DTYPE_ELEM_LEN 0
980#define GFC_DTYPE_VERSION 1
981#define GFC_DTYPE_RANK 2
982#define GFC_DTYPE_TYPE 3
983#define GFC_DTYPE_ATTRIBUTE 4
984
985enum gfc_array_kind
986{
987 GFC_ARRAY_UNKNOWN,
988 GFC_ARRAY_ASSUMED_SHAPE,
989 GFC_ARRAY_ASSUMED_SHAPE_CONT,
990 GFC_ARRAY_ASSUMED_RANK,
991 GFC_ARRAY_ASSUMED_RANK_CONT,
992 GFC_ARRAY_ALLOCATABLE,
993 GFC_ARRAY_POINTER,
994 GFC_ARRAY_POINTER_CONT
995};
996
997/* Array types only. */
998struct GTY(()) lang_type {
999 int rank, corank;
1000 enum gfc_array_kind akind;
1001 tree lbound[GFC_MAX_DIMENSIONS];
1002 tree ubound[GFC_MAX_DIMENSIONS];
1003 tree stride[GFC_MAX_DIMENSIONS];
1004 tree size;
1005 tree offset;
1006 tree dtype;
1007 tree dataptr_type;
1008 tree base_decl[2];
1009 tree nonrestricted_type;
1010 tree caf_token;
1011 tree caf_offset;
1012};
1013
1014struct GTY(()) lang_decl {
1015 /* Dummy variables. */
1016 tree saved_descriptor;
1017 /* Assigned integer nodes. Stringlength is the IO format string's length.
1018 Addr is the address of the string or the target label. Stringlength is
1019 initialized to -2 and assigned to -1 when addr is assigned to the
1020 address of target label. */
1021 tree stringlen;
1022 tree addr;
1023 /* For assumed-shape coarrays. */
1024 tree token, caf_offset;
1025 unsigned int scalar_allocatable : 1;
1026 unsigned int scalar_pointer : 1;
1027 unsigned int scalar_target : 1;
1028 unsigned int optional_arg : 1;
1029};
1030
1031
1032#define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
1033#define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
1034#define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
1035#define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
1036#define GFC_DECL_SAVED_DESCRIPTOR(node) \
1037 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
1038#define GFC_DECL_SCALAR_ALLOCATABLE(node) \
1039 (DECL_LANG_SPECIFIC (node)->scalar_allocatable)
1040#define GFC_DECL_SCALAR_POINTER(node) \
1041 (DECL_LANG_SPECIFIC (node)->scalar_pointer)
1042#define GFC_DECL_SCALAR_TARGET(node) \
1043 (DECL_LANG_SPECIFIC (node)->scalar_target)
1044#define GFC_DECL_OPTIONAL_ARGUMENT(node) \
1045 (DECL_LANG_SPECIFIC (node)->optional_arg)
1046#define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
1047 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
1048#define GFC_DECL_GET_SCALAR_POINTER(node) \
1049 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
1050#define GFC_DECL_GET_SCALAR_TARGET(node) \
1051 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_TARGET (node) : 0)
1052#define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
1053#define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
1054#define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
1055#define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
1056#define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
1057#define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
1058#define GFC_DECL_PTR_ARRAY_P(node) DECL_LANG_FLAG_6(node)
1059#define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
1060#define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
1061
1062/* An array descriptor. */
1063#define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
1064/* An array without a descriptor. */
1065#define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
1066/* Fortran CLASS type. */
1067#define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
1068/* The GFC_TYPE_ARRAY_* members are present in both descriptor and
1069 descriptorless array types. */
1070#define GFC_TYPE_ARRAY_LBOUND(node, dim) \
1071 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
1072#define GFC_TYPE_ARRAY_UBOUND(node, dim) \
1073 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
1074#define GFC_TYPE_ARRAY_STRIDE(node, dim) \
1075 (TYPE_LANG_SPECIFIC(node)->stride[dim])
1076#define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
1077#define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
1078#define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
1079#define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
1080#define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
1081#define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
1082#define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
1083/* Code should use gfc_get_dtype instead of accessing this directly. It may
1084 not be known when the type is created. */
1085#define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
1086#define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
1087 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
1088#define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
1089 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
1090
1091
1092/* Build an expression with void type. */
1093#define build1_v(code, arg) \
1094 fold_build1_loc (input_location, code, void_type_node, arg)
1095#define build2_v(code, arg1, arg2) \
1096 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
1097#define build3_v(code, arg1, arg2, arg3) \
1098 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
1099#define build4_v(code, arg1, arg2, arg3, arg4) \
1100 build4_loc (input_location, code, void_type_node, arg1, arg2, \
1101 arg3, arg4)
1102
1103/* This group of functions allows a caller to evaluate an expression from
1104 the callee's interface. It establishes a mapping between the interface's
1105 dummy arguments and the caller's actual arguments, then applies that
1106 mapping to a given gfc_expr.
1107
1108 You can initialize a mapping structure like so:
1109
1110 gfc_interface_mapping mapping;
1111 ...
1112 gfc_init_interface_mapping (&mapping);
1113
1114 You should then evaluate each actual argument into a temporary
1115 gfc_se structure, here called "se", and map the result to the
1116 dummy argument's symbol, here called "sym":
1117
1118 gfc_add_interface_mapping (&mapping, sym, &se);
1119
1120 After adding all mappings, you should call:
1121
1122 gfc_finish_interface_mapping (&mapping, pre, post);
1123
1124 where "pre" and "post" are statement blocks for initialization
1125 and finalization code respectively. You can then evaluate an
1126 interface expression "expr" as follows:
1127
1128 gfc_apply_interface_mapping (&mapping, se, expr);
1129
1130 Once you've evaluated all expressions, you should free
1131 the mapping structure with:
1132
1133 gfc_free_interface_mapping (&mapping); */
1134
1135
1136/* This structure represents a mapping from OLD to NEW, where OLD is a
1137 dummy argument symbol and NEW is a symbol that represents the value
1138 of an actual argument. Mappings are linked together using NEXT
1139 (in no particular order). */
1140typedef struct gfc_interface_sym_mapping
1141{
1142 struct gfc_interface_sym_mapping *next;
1143 gfc_symbol *old;
1144 gfc_symtree *new_sym;
1145 gfc_expr *expr;
1146}
1147gfc_interface_sym_mapping;
1148
1149
1150/* This structure is used by callers to evaluate an expression from
1151 a callee's interface. */
1152typedef struct gfc_interface_mapping
1153{
1154 /* Maps the interface's dummy arguments to the values that the caller
1155 is passing. The whole list is owned by this gfc_interface_mapping. */
1156 gfc_interface_sym_mapping *syms;
1157
1158 /* A list of gfc_charlens that were needed when creating copies of
1159 expressions. The whole list is owned by this gfc_interface_mapping. */
1160 gfc_charlen *charlens;
1161}
1162gfc_interface_mapping;
1163
1164void gfc_init_interface_mapping (gfc_interface_mapping *);
1165void gfc_free_interface_mapping (gfc_interface_mapping *);
1166void gfc_add_interface_mapping (gfc_interface_mapping *,
1167 gfc_symbol *, gfc_se *, gfc_expr *);
1168void gfc_apply_interface_mapping (gfc_interface_mapping *,
1169 gfc_se *, gfc_expr *);
1170
1171
1172/* Standard error messages used in all the trans-*.c files. */
1173extern const char gfc_msg_fault[];
1174
1175#define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
1176#define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
1177 construct is not workshared. */
1178#define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
1179 to create parallel loops. */
1180#define OMPWS_SCALARIZER_BODY 8 /* Set if handling body of potential
1181 parallel loop. */
1182#define OMPWS_NOWAIT 16 /* Use NOWAIT on OMP_FOR. */
1183extern int ompws_flags;
1184
1185#endif /* GFC_TRANS_H */
1186

source code of gcc/fortran/trans.h