]> git.ipfire.org Git - thirdparty/gcc.git/blame_incremental - gcc/fortran/trans.h
libstdc++: Fix return type of ranges::ssize for 128-bit integer [PR 100824]
[thirdparty/gcc.git] / gcc / fortran / trans.h
... / ...
CommitLineData
1/* Header for code translation functions
2 Copyright (C) 2002-2021 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 /* If set gfc_conv_variable will return an expression for the array
57 descriptor. When set, want_pointer should also be set.
58 If not set scalarizing variables will be substituted. */
59 unsigned descriptor_only:1;
60
61 /* When this is set gfc_conv_expr returns the address of a variable. Only
62 applies to EXPR_VARIABLE nodes.
63 Also used by gfc_conv_array_parameter. When set this indicates a pointer
64 to the descriptor should be returned, rather than the descriptor itself.
65 */
66 unsigned want_pointer:1;
67
68 /* An array function call returning without a temporary. Also used for array
69 pointer assignments. */
70 unsigned direct_byref:1;
71
72 /* If direct_byref is set, do work out the descriptor as in that case but
73 do still create a new descriptor variable instead of using an
74 existing one. This is useful for special pointer assignments like
75 rank remapping where we have to process the descriptor before
76 assigning to final one. */
77 unsigned byref_noassign:1;
78
79 /* Ignore absent optional arguments. Used for some intrinsics. */
80 unsigned ignore_optional:1;
81
82 /* When this is set the data and offset fields of the returned descriptor
83 are NULL. Used by intrinsic size. */
84 unsigned data_not_needed:1;
85
86 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
87 unsigned no_function_call:1;
88
89 /* If set, we will force the creation of a temporary. Useful to disable
90 non-copying procedure argument passing optimizations, when some function
91 args alias. */
92 unsigned force_tmp:1;
93
94 /* If set, will pass subref descriptors without a temporary. */
95 unsigned force_no_tmp:1;
96
97 /* Unconditionally calculate offset for array segments and constant
98 arrays in gfc_conv_expr_descriptor. */
99 unsigned use_offset:1;
100
101 unsigned want_coarray:1;
102
103 /* Scalarization parameters. */
104 struct gfc_se *parent;
105 struct gfc_ss *ss;
106 struct gfc_loopinfo *loop;
107}
108gfc_se;
109
110typedef struct gfc_co_subroutines_args
111{
112 tree image_index;
113 tree stat;
114 tree errmsg;
115 tree errmsg_len;
116}
117gfc_co_subroutines_args;
118
119/* Denotes different types of coarray.
120 Please keep in sync with libgfortran/caf/libcaf.h. */
121enum gfc_coarray_regtype
122{
123 GFC_CAF_COARRAY_STATIC,
124 GFC_CAF_COARRAY_ALLOC,
125 GFC_CAF_LOCK_STATIC,
126 GFC_CAF_LOCK_ALLOC,
127 GFC_CAF_CRITICAL,
128 GFC_CAF_EVENT_STATIC,
129 GFC_CAF_EVENT_ALLOC,
130 GFC_CAF_COARRAY_ALLOC_REGISTER_ONLY,
131 GFC_CAF_COARRAY_ALLOC_ALLOCATE_ONLY
132};
133
134
135/* Describes the action to take on _caf_deregister. Keep in sync with
136 gcc/fortran/trans.h. The negative values are not valid for the library and
137 are used by the drivers for building the correct call. */
138enum gfc_coarray_deregtype {
139 /* This is no coarray, i.e. build a call to a free (). */
140 GFC_CAF_COARRAY_NOCOARRAY = -2,
141 /* The driver is to analyze which _caf_deregister ()-call to generate. */
142 GFC_CAF_COARRAY_ANALYZE = -1,
143 GFC_CAF_COARRAY_DEREGISTER = 0,
144 GFC_CAF_COARRAY_DEALLOCATE_ONLY
145};
146
147
148/* Specify the type of ref handed to the caf communication functions.
149 Please keep in sync with libgfortran/caf/libcaf.h. */
150enum gfc_caf_ref_type_t {
151 GFC_CAF_REF_COMPONENT,
152 GFC_CAF_REF_ARRAY,
153 GFC_CAF_REF_STATIC_ARRAY
154};
155
156
157/* Give the reference type of an array ref.
158 Please keep in sync with libgfortran/caf/libcaf.h. */
159enum gfc_caf_array_ref_t {
160 GFC_CAF_ARR_REF_NONE = 0,
161 GFC_CAF_ARR_REF_VECTOR,
162 GFC_CAF_ARR_REF_FULL,
163 GFC_CAF_ARR_REF_RANGE,
164 GFC_CAF_ARR_REF_SINGLE,
165 GFC_CAF_ARR_REF_OPEN_END,
166 GFC_CAF_ARR_REF_OPEN_START
167};
168
169
170/* trans-array (structure_alloc_comps) caf_mode bits. */
171enum gfc_structure_caf_mode_t {
172 GFC_STRUCTURE_CAF_MODE_ENABLE_COARRAY = 1 << 0,
173 GFC_STRUCTURE_CAF_MODE_IN_COARRAY = 1 << 1,
174 GFC_STRUCTURE_CAF_MODE_DEALLOC_ONLY = 1 << 2
175};
176
177
178/* The array-specific scalarization information. The array members of
179 this struct are indexed by actual array index, and thus can be sparse. */
180
181typedef struct gfc_array_info
182{
183 mpz_t *shape;
184
185 /* The ref that holds information on this section. */
186 gfc_ref *ref;
187 /* The descriptor of this array. */
188 tree descriptor;
189 /* holds the pointer to the data array. */
190 tree data;
191 /* To move some of the array index calculation out of the innermost loop. */
192 tree offset;
193 tree saved_offset;
194 tree stride0;
195 /* Holds the SS for a subscript. Indexed by actual dimension. */
196 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
197
198 /* stride and delta are used to access this inside a scalarization loop.
199 start is used in the calculation of these. Indexed by scalarizer
200 dimension. */
201 tree start[GFC_MAX_DIMENSIONS];
202 tree end[GFC_MAX_DIMENSIONS];
203 tree stride[GFC_MAX_DIMENSIONS];
204 tree delta[GFC_MAX_DIMENSIONS];
205}
206gfc_array_info;
207
208enum gfc_ss_type
209{
210 /* A scalar value. This will be evaluated before entering the
211 scalarization loop. */
212 GFC_SS_SCALAR,
213
214 /* Like GFC_SS_SCALAR it evaluates the expression outside the
215 loop. Is always evaluated as a reference to the temporary, unless
216 temporary evaluation can result in a NULL pointer dereferencing (case of
217 optional arguments). Used for elemental function arguments. */
218 GFC_SS_REFERENCE,
219
220 /* An array section. Scalarization indices will be substituted during
221 expression translation. */
222 GFC_SS_SECTION,
223
224 /* A non-elemental function call returning an array. The call is executed
225 before entering the scalarization loop, storing the result in a
226 temporary. This temporary is then used inside the scalarization loop.
227 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
228 as a special case. */
229 GFC_SS_FUNCTION,
230
231 /* An array constructor. The current implementation is sub-optimal in
232 many cases. It allocated a temporary, assigns the values to it, then
233 uses this temporary inside the scalarization loop. */
234 GFC_SS_CONSTRUCTOR,
235
236 /* A vector subscript. The vector's descriptor is cached in the
237 "descriptor" field of the associated gfc_ss_info. */
238 GFC_SS_VECTOR,
239
240 /* A temporary array allocated by the scalarizer. Its rank can be less
241 than that of the assignment expression. */
242 GFC_SS_TEMP,
243
244 /* An intrinsic function call. Many intrinsic functions which map directly
245 to library calls are created as GFC_SS_FUNCTION nodes. */
246 GFC_SS_INTRINSIC,
247
248 /* A component of a derived type. */
249 GFC_SS_COMPONENT
250};
251
252
253typedef struct gfc_ss_info
254{
255 int refcount;
256 gfc_ss_type type;
257 gfc_expr *expr;
258 tree string_length;
259
260 union
261 {
262 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
263 struct
264 {
265 /* If the scalar is passed as actual argument to an (elemental) procedure,
266 this is the symbol of the corresponding dummy argument. */
267 gfc_symbol *dummy_arg;
268 tree value;
269 /* Tells that the scalar is a reference to a variable that might
270 be present on the lhs, so that we should evaluate the value
271 itself before the loop, not just the reference. */
272 unsigned needs_temporary:1;
273 }
274 scalar;
275
276 /* GFC_SS_TEMP. */
277 struct
278 {
279 tree type;
280 }
281 temp;
282
283 /* All other types. */
284 gfc_array_info array;
285 }
286 data;
287
288 /* This is used by assignments requiring temporaries. The bits specify which
289 loops the terms appear in. This will be 1 for the RHS expressions,
290 2 for the LHS expressions, and 3(=1|2) for the temporary. */
291 unsigned useflags:2;
292
293 /* Suppresses precalculation of scalars in WHERE assignments. */
294 unsigned where:1;
295
296 /* This set for an elemental function that contains expressions for
297 external arrays, thereby triggering creation of a temporary. */
298 unsigned array_outer_dependency:1;
299
300 /* Tells whether the SS is for an actual argument which can be a NULL
301 reference. In other words, the associated dummy argument is OPTIONAL.
302 Used to handle elemental procedures. */
303 bool can_be_null_ref;
304}
305gfc_ss_info;
306
307#define gfc_get_ss_info() XCNEW (gfc_ss_info)
308
309
310/* Scalarization State chain. Created by walking an expression tree before
311 creating the scalarization loops. Then passed as part of a gfc_se structure
312 to translate the expression inside the loop. Note that these chains are
313 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
314 indicates to gfc_conv_* that this is a scalar expression.
315 SS structures can only belong to a single loopinfo. They must be added
316 otherwise they will not get freed. */
317
318typedef struct gfc_ss
319{
320 gfc_ss_info *info;
321
322 int dimen;
323 /* Translation from loop dimensions to actual array dimensions.
324 actual_dim = dim[loop_dim] */
325 int dim[GFC_MAX_DIMENSIONS];
326
327 /* All the SS in a loop and linked through loop_chain. The SS for an
328 expression are linked by the next pointer. */
329 struct gfc_ss *loop_chain;
330 struct gfc_ss *next;
331
332 /* Non-null if the ss is part of a nested loop. */
333 struct gfc_ss *parent;
334
335 /* If the evaluation of an expression requires a nested loop (for example
336 if the sum intrinsic is evaluated inline), this points to the nested
337 loop's gfc_ss. */
338 struct gfc_ss *nested_ss;
339
340 /* The loop this gfc_ss is in. */
341 struct gfc_loopinfo *loop;
342
343 unsigned is_alloc_lhs:1;
344 unsigned no_bounds_check:1;
345}
346gfc_ss;
347#define gfc_get_ss() XCNEW (gfc_ss)
348
349/* The contents of this aren't actually used. A NULL SS chain indicates a
350 scalar expression, so this pointer is used to terminate SS chains. */
351extern gfc_ss * const gfc_ss_terminator;
352
353/* Holds information about an expression while it is being scalarized. */
354typedef struct gfc_loopinfo
355{
356 stmtblock_t pre;
357 stmtblock_t post;
358
359 int dimen;
360
361 /* All the SS involved with this loop. */
362 gfc_ss *ss;
363 /* The SS describing the temporary used in an assignment. */
364 gfc_ss *temp_ss;
365
366 /* Non-null if this loop is nested in another one. */
367 struct gfc_loopinfo *parent;
368
369 /* Chain of nested loops. */
370 struct gfc_loopinfo *nested, *next;
371
372 /* The scalarization loop index variables. */
373 tree loopvar[GFC_MAX_DIMENSIONS];
374
375 /* The bounds of the scalarization loops. */
376 tree from[GFC_MAX_DIMENSIONS];
377 tree to[GFC_MAX_DIMENSIONS];
378 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
379
380 /* The code member contains the code for the body of the next outer loop. */
381 stmtblock_t code[GFC_MAX_DIMENSIONS];
382
383 /* Order in which the dimensions should be looped, innermost first. */
384 int order[GFC_MAX_DIMENSIONS];
385
386 /* Enum to control loop reversal. */
387 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
388
389 /* The number of dimensions for which a temporary is used. */
390 int temp_dim;
391
392 /* If set we don't need the loop variables. */
393 unsigned array_parameter:1;
394}
395gfc_loopinfo;
396
397#define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
398
399/* Information about a symbol that has been shadowed by a temporary. */
400typedef struct
401{
402 symbol_attribute attr;
403 tree decl;
404}
405gfc_saved_var;
406
407
408/* Store information about a block of code together with special
409 initialization and clean-up code. This can be used to incrementally add
410 init and cleanup, and in the end put everything together to a
411 try-finally expression. */
412typedef struct
413{
414 tree init;
415 tree cleanup;
416 tree code;
417}
418gfc_wrapped_block;
419
420/* Class API functions. */
421tree gfc_class_set_static_fields (tree, tree, tree);
422tree gfc_class_data_get (tree);
423tree gfc_class_vptr_get (tree);
424tree gfc_class_len_get (tree);
425tree gfc_class_len_or_zero_get (tree);
426tree gfc_resize_class_size_with_len (stmtblock_t *, tree, tree);
427gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *, bool is_mold = false,
428 gfc_typespec **ts = NULL);
429/* Get an accessor to the class' vtab's * field, when a class handle is
430 available. */
431tree gfc_class_vtab_hash_get (tree);
432tree gfc_class_vtab_size_get (tree);
433tree gfc_class_vtab_extends_get (tree);
434tree gfc_class_vtab_def_init_get (tree);
435tree gfc_class_vtab_copy_get (tree);
436tree gfc_class_vtab_final_get (tree);
437/* Get an accessor to the vtab's * field, when a vptr handle is present. */
438tree gfc_vtpr_hash_get (tree);
439tree gfc_vptr_size_get (tree);
440tree gfc_vptr_extends_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_get_class_array_ref (tree, tree, tree, bool);
451tree gfc_copy_class_to_class (tree, tree, tree, bool);
452bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *);
453bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool);
454
455void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool,
456 bool, tree *derived_array = NULL);
457void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool,
458 bool, bool);
459
460/* Initialize an init/cleanup block. */
461void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
462/* Add a pair of init/cleanup code to the block. Each one might be a
463 NULL_TREE if not required. */
464void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
465/* Finalize the block, that is, create a single expression encapsulating the
466 original code together with init and clean-up code. */
467tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
468
469
470/* Advance the SS chain to the next term. */
471void gfc_advance_se_ss_chain (gfc_se *);
472
473/* Call this to initialize a gfc_se structure before use
474 first parameter is structure to initialize, second is
475 parent to get scalarization data from, or NULL. */
476void gfc_init_se (gfc_se *, gfc_se *);
477
478/* Create an artificial variable decl and add it to the current scope. */
479tree gfc_create_var (tree, const char *);
480/* Like above but doesn't add it to the current scope. */
481tree gfc_create_var_np (tree, const char *);
482
483/* Store the result of an expression in a temp variable so it can be used
484 repeatedly even if the original changes */
485void gfc_make_safe_expr (gfc_se * se);
486
487/* Makes sure se is suitable for passing as a function string parameter. */
488void gfc_conv_string_parameter (gfc_se * se);
489
490/* Compare two strings. */
491tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
492
493/* When using the gfc_conv_* make sure you understand what they do, i.e.
494 when a POST chain may be created, and what the returned expression may be
495 used for. Note that character strings have special handling. This
496 should not be a problem as most statements/operations only deal with
497 numeric/logical types. See the implementations in trans-expr.c
498 for details of the individual functions. */
499
500void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
501void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
502void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
503void gfc_conv_expr_reference (gfc_se * se, gfc_expr * expr,
504 bool add_clobber = false);
505void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
506
507
508/* trans-expr.c */
509tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute);
510tree gfc_get_ultimate_alloc_ptr_comps_caf_token (gfc_se *, gfc_expr *);
511void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
512tree gfc_string_to_single_character (tree len, tree str, int kind);
513tree gfc_get_tree_for_caf_expr (gfc_expr *);
514void gfc_get_caf_token_offset (gfc_se*, tree *, tree *, tree, tree, gfc_expr *);
515tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree);
516
517/* Find the decl containing the auxiliary variables for assigned variables. */
518void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
519/* If the value is not constant, Create a temporary and copy the value. */
520tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
521tree gfc_evaluate_now (tree, stmtblock_t *);
522tree gfc_evaluate_now_function_scope (tree, stmtblock_t *);
523
524/* Find the appropriate variant of a math intrinsic. */
525tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
526
527tree size_of_string_in_bytes (int, tree);
528
529/* Intrinsic procedure handling. */
530tree gfc_conv_intrinsic_subroutine (gfc_code *);
531void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
532bool gfc_conv_ieee_arithmetic_function (gfc_se *, gfc_expr *);
533tree gfc_save_fp_state (stmtblock_t *);
534void gfc_restore_fp_state (stmtblock_t *, tree);
535
536bool gfc_expr_is_variable (gfc_expr *);
537
538/* Does an intrinsic map directly to an external library call
539 This is true for array-returning intrinsics, unless
540 gfc_inline_intrinsic_function_p returns true. */
541int gfc_is_intrinsic_libcall (gfc_expr *);
542
543/* Used to call ordinary functions/subroutines
544 and procedure pointer components. */
545int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
546 gfc_expr *, vec<tree, va_gc> *);
547
548void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool,
549 const gfc_symbol *fsym = NULL,
550 const char *proc_name = NULL,
551 gfc_symbol *sym = NULL,
552 bool check_contiguous = false);
553
554void gfc_conv_is_contiguous_expr (gfc_se *, gfc_expr *);
555
556/* Generate code for a scalar assignment. */
557tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
558 bool c = false);
559
560/* Translate COMMON blocks. */
561void gfc_trans_common (gfc_namespace *);
562
563/* Translate a derived type constructor. */
564void gfc_conv_structure (gfc_se *, gfc_expr *, int);
565
566/* Return an expression which determines if a dummy parameter is present. */
567tree gfc_conv_expr_present (gfc_symbol *, bool use_saved_decl = false);
568/* Convert a missing, dummy argument into a null or zero. */
569void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
570
571/* Lowering of component references. */
572void gfc_conv_component_ref (gfc_se * se, gfc_ref * ref);
573void conv_parent_component_references (gfc_se * se, gfc_ref * ref);
574
575/* Automatically dereference var. */
576tree gfc_maybe_dereference_var (gfc_symbol *, tree, bool desc_only = false,
577 bool is_classarray = false);
578
579/* Generate code to allocate a string temporary. */
580tree gfc_conv_string_tmp (gfc_se *, tree, tree);
581/* Get the string length variable belonging to an expression. */
582tree gfc_get_expr_charlen (gfc_expr *);
583/* Initialize a string length variable. */
584void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
585/* Ensure type sizes can be gimplified. */
586void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
587
588/* Add an expression to the end of a block. */
589void gfc_add_expr_to_block (stmtblock_t *, tree);
590/* Add an expression to the beginning of a block. */
591void gfc_prepend_expr_to_block (stmtblock_t *, tree);
592/* Add a block to the end of a block. */
593void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
594/* Add a MODIFY_EXPR to a block. */
595void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
596void gfc_add_modify (stmtblock_t *, tree, tree);
597
598/* Initialize a statement block. */
599void gfc_init_block (stmtblock_t *);
600/* Start a new statement block. Like gfc_init_block but also starts a new
601 variable scope. */
602void gfc_start_block (stmtblock_t *);
603/* Finish a statement block. Also closes the scope if the block was created
604 with gfc_start_block. */
605tree gfc_finish_block (stmtblock_t *);
606/* Merge the scope of a block with its parent. */
607void gfc_merge_block_scope (stmtblock_t * block);
608
609/* Return the backend label decl. */
610tree gfc_get_label_decl (gfc_st_label *);
611
612/* Return the decl for an external function. */
613tree gfc_get_extern_function_decl (gfc_symbol *,
614 gfc_actual_arglist *args = NULL,
615 const char *fnspec = NULL);
616
617/* Return the decl for a function. */
618tree gfc_get_function_decl (gfc_symbol *);
619
620/* Build an ADDR_EXPR. */
621tree gfc_build_addr_expr (tree, tree);
622
623/* Build an ARRAY_REF. */
624tree gfc_build_array_ref (tree, tree, tree, 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.c. */
797tree pushdecl (tree);
798tree pushdecl_top_level (tree);
799void pushlevel (void);
800tree poplevel (int, int);
801tree getdecls (void);
802
803/* In trans-types.c. */
804struct array_descr_info;
805bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
806
807/* In trans-openmp.c */
808bool gfc_omp_is_allocatable_or_ptr (const_tree);
809tree gfc_omp_check_optional_argument (tree, bool);
810tree gfc_omp_array_data (tree, bool);
811bool gfc_omp_privatize_by_reference (const_tree);
812enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
813enum omp_clause_defaultmap_kind gfc_omp_predetermined_mapping (tree);
814tree gfc_omp_report_decl (tree);
815tree gfc_omp_clause_default_ctor (tree, tree, tree);
816tree gfc_omp_clause_copy_ctor (tree, tree, tree);
817tree gfc_omp_clause_assign_op (tree, tree, tree);
818tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree);
819tree gfc_omp_clause_dtor (tree, tree);
820void gfc_omp_finish_clause (tree, gimple_seq *, bool);
821bool gfc_omp_scalar_p (tree);
822bool gfc_omp_disregard_value_expr (tree, bool);
823bool gfc_omp_private_debug_clause (tree, bool);
824bool gfc_omp_private_outer_ref (tree);
825struct gimplify_omp_ctx;
826void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
827
828/* In trans-intrinsic.c. */
829void gfc_conv_intrinsic_mvbits (gfc_se *, gfc_actual_arglist *,
830 gfc_loopinfo *);
831
832/* Runtime library function decls. */
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;
837extern GTY(()) tree gfor_fndecl_error_stop_numeric;
838extern GTY(()) tree gfor_fndecl_error_stop_string;
839extern GTY(()) tree gfor_fndecl_runtime_error;
840extern GTY(()) tree gfor_fndecl_runtime_error_at;
841extern GTY(()) tree gfor_fndecl_runtime_warning_at;
842extern GTY(()) tree gfor_fndecl_os_error_at;
843extern GTY(()) tree gfor_fndecl_generate_error;
844extern GTY(()) tree gfor_fndecl_set_fpe;
845extern GTY(()) tree gfor_fndecl_set_options;
846extern GTY(()) tree gfor_fndecl_ttynam;
847extern GTY(()) tree gfor_fndecl_ctime;
848extern GTY(()) tree gfor_fndecl_fdate;
849extern GTY(()) tree gfor_fndecl_in_pack;
850extern GTY(()) tree gfor_fndecl_in_unpack;
851extern GTY(()) tree gfor_fndecl_cfi_to_gfc;
852extern GTY(()) tree gfor_fndecl_gfc_to_cfi;
853extern GTY(()) tree gfor_fndecl_associated;
854extern GTY(()) tree gfor_fndecl_system_clock4;
855extern GTY(()) tree gfor_fndecl_system_clock8;
856
857
858/* Coarray run-time library function decls. */
859extern GTY(()) tree gfor_fndecl_caf_init;
860extern GTY(()) tree gfor_fndecl_caf_finalize;
861extern GTY(()) tree gfor_fndecl_caf_this_image;
862extern GTY(()) tree gfor_fndecl_caf_num_images;
863extern GTY(()) tree gfor_fndecl_caf_register;
864extern GTY(()) tree gfor_fndecl_caf_deregister;
865extern GTY(()) tree gfor_fndecl_caf_get;
866extern GTY(()) tree gfor_fndecl_caf_send;
867extern GTY(()) tree gfor_fndecl_caf_sendget;
868extern GTY(()) tree gfor_fndecl_caf_get_by_ref;
869extern GTY(()) tree gfor_fndecl_caf_send_by_ref;
870extern GTY(()) tree gfor_fndecl_caf_sendget_by_ref;
871extern GTY(()) tree gfor_fndecl_caf_sync_all;
872extern GTY(()) tree gfor_fndecl_caf_sync_memory;
873extern GTY(()) tree gfor_fndecl_caf_sync_images;
874extern GTY(()) tree gfor_fndecl_caf_stop_numeric;
875extern GTY(()) tree gfor_fndecl_caf_stop_str;
876extern GTY(()) tree gfor_fndecl_caf_error_stop;
877extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
878extern GTY(()) tree gfor_fndecl_caf_atomic_def;
879extern GTY(()) tree gfor_fndecl_caf_atomic_ref;
880extern GTY(()) tree gfor_fndecl_caf_atomic_cas;
881extern GTY(()) tree gfor_fndecl_caf_atomic_op;
882extern GTY(()) tree gfor_fndecl_caf_lock;
883extern GTY(()) tree gfor_fndecl_caf_unlock;
884extern GTY(()) tree gfor_fndecl_caf_event_post;
885extern GTY(()) tree gfor_fndecl_caf_event_wait;
886extern GTY(()) tree gfor_fndecl_caf_event_query;
887extern GTY(()) tree gfor_fndecl_caf_fail_image;
888extern GTY(()) tree gfor_fndecl_caf_failed_images;
889extern GTY(()) tree gfor_fndecl_caf_image_status;
890extern GTY(()) tree gfor_fndecl_caf_stopped_images;
891extern GTY(()) tree gfor_fndecl_caf_form_team;
892extern GTY(()) tree gfor_fndecl_caf_change_team;
893extern GTY(()) tree gfor_fndecl_caf_end_team;
894extern GTY(()) tree gfor_fndecl_caf_get_team;
895extern GTY(()) tree gfor_fndecl_caf_sync_team;
896extern GTY(()) tree gfor_fndecl_caf_team_number;
897extern GTY(()) tree gfor_fndecl_co_broadcast;
898extern GTY(()) tree gfor_fndecl_co_max;
899extern GTY(()) tree gfor_fndecl_co_min;
900extern GTY(()) tree gfor_fndecl_co_reduce;
901extern GTY(()) tree gfor_fndecl_co_sum;
902extern GTY(()) tree gfor_fndecl_caf_is_present;
903
904/* Math functions. Many other math functions are handled in
905 trans-intrinsic.c. */
906
907typedef struct GTY(()) gfc_powdecl_list {
908 tree integer;
909 tree real;
910 tree cmplx;
911}
912gfc_powdecl_list;
913
914extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
915extern GTY(()) tree gfor_fndecl_math_ishftc4;
916extern GTY(()) tree gfor_fndecl_math_ishftc8;
917extern GTY(()) tree gfor_fndecl_math_ishftc16;
918
919/* BLAS functions. */
920extern GTY(()) tree gfor_fndecl_sgemm;
921extern GTY(()) tree gfor_fndecl_dgemm;
922extern GTY(()) tree gfor_fndecl_cgemm;
923extern GTY(()) tree gfor_fndecl_zgemm;
924
925/* String functions. */
926extern GTY(()) tree gfor_fndecl_compare_string;
927extern GTY(()) tree gfor_fndecl_concat_string;
928extern GTY(()) tree gfor_fndecl_string_len_trim;
929extern GTY(()) tree gfor_fndecl_string_index;
930extern GTY(()) tree gfor_fndecl_string_scan;
931extern GTY(()) tree gfor_fndecl_string_verify;
932extern GTY(()) tree gfor_fndecl_string_trim;
933extern GTY(()) tree gfor_fndecl_string_minmax;
934extern GTY(()) tree gfor_fndecl_adjustl;
935extern GTY(()) tree gfor_fndecl_adjustr;
936extern GTY(()) tree gfor_fndecl_select_string;
937extern GTY(()) tree gfor_fndecl_compare_string_char4;
938extern GTY(()) tree gfor_fndecl_concat_string_char4;
939extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
940extern GTY(()) tree gfor_fndecl_string_index_char4;
941extern GTY(()) tree gfor_fndecl_string_scan_char4;
942extern GTY(()) tree gfor_fndecl_string_verify_char4;
943extern GTY(()) tree gfor_fndecl_string_trim_char4;
944extern GTY(()) tree gfor_fndecl_string_minmax_char4;
945extern GTY(()) tree gfor_fndecl_adjustl_char4;
946extern GTY(()) tree gfor_fndecl_adjustr_char4;
947extern GTY(()) tree gfor_fndecl_select_string_char4;
948
949/* Conversion between character kinds. */
950extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
951extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
952
953/* Other misc. runtime library functions. */
954extern GTY(()) tree gfor_fndecl_size0;
955extern GTY(()) tree gfor_fndecl_size1;
956extern GTY(()) tree gfor_fndecl_iargc;
957extern GTY(()) tree gfor_fndecl_kill;
958extern GTY(()) tree gfor_fndecl_kill_sub;
959extern GTY(()) tree gfor_fndecl_is_contiguous0;
960
961/* Implemented in Fortran. */
962extern GTY(()) tree gfor_fndecl_sc_kind;
963extern GTY(()) tree gfor_fndecl_si_kind;
964extern GTY(()) tree gfor_fndecl_sr_kind;
965
966/* IEEE-related. */
967extern GTY(()) tree gfor_fndecl_ieee_procedure_entry;
968extern GTY(()) tree gfor_fndecl_ieee_procedure_exit;
969
970/* RANDOM_INIT. */
971extern GTY(()) tree gfor_fndecl_random_init;
972extern GTY(()) tree gfor_fndecl_caf_random_init;
973
974/* True if node is an integer constant. */
975#define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
976
977/* gfortran-specific declaration information, the _CONT versions denote
978 arrays with CONTIGUOUS attribute. */
979
980#define GFC_DTYPE_ELEM_LEN 0
981#define GFC_DTYPE_VERSION 1
982#define GFC_DTYPE_RANK 2
983#define GFC_DTYPE_TYPE 3
984#define GFC_DTYPE_ATTRIBUTE 4
985
986enum gfc_array_kind
987{
988 GFC_ARRAY_UNKNOWN,
989 GFC_ARRAY_ASSUMED_SHAPE,
990 GFC_ARRAY_ASSUMED_SHAPE_CONT,
991 GFC_ARRAY_ASSUMED_RANK,
992 GFC_ARRAY_ASSUMED_RANK_CONT,
993 GFC_ARRAY_ALLOCATABLE,
994 GFC_ARRAY_POINTER,
995 GFC_ARRAY_POINTER_CONT
996};
997
998/* Array types only. */
999struct GTY(()) lang_type {
1000 int rank, corank;
1001 enum gfc_array_kind akind;
1002 tree lbound[GFC_MAX_DIMENSIONS];
1003 tree ubound[GFC_MAX_DIMENSIONS];
1004 tree stride[GFC_MAX_DIMENSIONS];
1005 tree size;
1006 tree offset;
1007 tree dtype;
1008 tree dataptr_type;
1009 tree base_decl[2];
1010 tree nonrestricted_type;
1011 tree caf_token;
1012 tree caf_offset;
1013};
1014
1015struct GTY(()) lang_decl {
1016 /* Dummy variables. */
1017 tree saved_descriptor;
1018 /* Assigned integer nodes. Stringlength is the IO format string's length.
1019 Addr is the address of the string or the target label. Stringlength is
1020 initialized to -2 and assigned to -1 when addr is assigned to the
1021 address of target label. */
1022 tree stringlen;
1023 tree addr;
1024 /* For assumed-shape coarrays. */
1025 tree token, caf_offset;
1026 unsigned int scalar_allocatable : 1;
1027 unsigned int scalar_pointer : 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_OPTIONAL_ARGUMENT(node) \
1043 (DECL_LANG_SPECIFIC (node)->optional_arg)
1044#define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
1045 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
1046#define GFC_DECL_GET_SCALAR_POINTER(node) \
1047 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
1048#define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
1049#define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
1050#define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
1051#define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
1052#define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
1053#define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
1054#define GFC_DECL_PTR_ARRAY_P(node) DECL_LANG_FLAG_6(node)
1055#define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
1056#define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
1057
1058/* An array descriptor. */
1059#define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
1060/* An array without a descriptor. */
1061#define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
1062/* Fortran CLASS type. */
1063#define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
1064/* The GFC_TYPE_ARRAY_* members are present in both descriptor and
1065 descriptorless array types. */
1066#define GFC_TYPE_ARRAY_LBOUND(node, dim) \
1067 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
1068#define GFC_TYPE_ARRAY_UBOUND(node, dim) \
1069 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
1070#define GFC_TYPE_ARRAY_STRIDE(node, dim) \
1071 (TYPE_LANG_SPECIFIC(node)->stride[dim])
1072#define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
1073#define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
1074#define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
1075#define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
1076#define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
1077#define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
1078#define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
1079/* Code should use gfc_get_dtype instead of accessing this directly. It may
1080 not be known when the type is created. */
1081#define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
1082#define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
1083 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
1084#define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
1085 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
1086
1087
1088/* Build an expression with void type. */
1089#define build1_v(code, arg) \
1090 fold_build1_loc (input_location, code, void_type_node, arg)
1091#define build2_v(code, arg1, arg2) \
1092 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
1093#define build3_v(code, arg1, arg2, arg3) \
1094 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
1095#define build4_v(code, arg1, arg2, arg3, arg4) \
1096 build4_loc (input_location, code, void_type_node, arg1, arg2, \
1097 arg3, arg4)
1098
1099/* This group of functions allows a caller to evaluate an expression from
1100 the callee's interface. It establishes a mapping between the interface's
1101 dummy arguments and the caller's actual arguments, then applies that
1102 mapping to a given gfc_expr.
1103
1104 You can initialize a mapping structure like so:
1105
1106 gfc_interface_mapping mapping;
1107 ...
1108 gfc_init_interface_mapping (&mapping);
1109
1110 You should then evaluate each actual argument into a temporary
1111 gfc_se structure, here called "se", and map the result to the
1112 dummy argument's symbol, here called "sym":
1113
1114 gfc_add_interface_mapping (&mapping, sym, &se);
1115
1116 After adding all mappings, you should call:
1117
1118 gfc_finish_interface_mapping (&mapping, pre, post);
1119
1120 where "pre" and "post" are statement blocks for initialization
1121 and finalization code respectively. You can then evaluate an
1122 interface expression "expr" as follows:
1123
1124 gfc_apply_interface_mapping (&mapping, se, expr);
1125
1126 Once you've evaluated all expressions, you should free
1127 the mapping structure with:
1128
1129 gfc_free_interface_mapping (&mapping); */
1130
1131
1132/* This structure represents a mapping from OLD to NEW, where OLD is a
1133 dummy argument symbol and NEW is a symbol that represents the value
1134 of an actual argument. Mappings are linked together using NEXT
1135 (in no particular order). */
1136typedef struct gfc_interface_sym_mapping
1137{
1138 struct gfc_interface_sym_mapping *next;
1139 gfc_symbol *old;
1140 gfc_symtree *new_sym;
1141 gfc_expr *expr;
1142}
1143gfc_interface_sym_mapping;
1144
1145
1146/* This structure is used by callers to evaluate an expression from
1147 a callee's interface. */
1148typedef struct gfc_interface_mapping
1149{
1150 /* Maps the interface's dummy arguments to the values that the caller
1151 is passing. The whole list is owned by this gfc_interface_mapping. */
1152 gfc_interface_sym_mapping *syms;
1153
1154 /* A list of gfc_charlens that were needed when creating copies of
1155 expressions. The whole list is owned by this gfc_interface_mapping. */
1156 gfc_charlen *charlens;
1157}
1158gfc_interface_mapping;
1159
1160void gfc_init_interface_mapping (gfc_interface_mapping *);
1161void gfc_free_interface_mapping (gfc_interface_mapping *);
1162void gfc_add_interface_mapping (gfc_interface_mapping *,
1163 gfc_symbol *, gfc_se *, gfc_expr *);
1164void gfc_finish_interface_mapping (gfc_interface_mapping *,
1165 stmtblock_t *, stmtblock_t *);
1166void gfc_apply_interface_mapping (gfc_interface_mapping *,
1167 gfc_se *, gfc_expr *);
1168
1169
1170/* Standard error messages used in all the trans-*.c files. */
1171extern const char gfc_msg_fault[];
1172extern const char gfc_msg_wrong_return[];
1173
1174#define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
1175#define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
1176 construct is not workshared. */
1177#define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
1178 to create parallel loops. */
1179#define OMPWS_SCALARIZER_BODY 8 /* Set if handling body of potential
1180 parallel loop. */
1181#define OMPWS_NOWAIT 16 /* Use NOWAIT on OMP_FOR. */
1182extern int ompws_flags;
1183
1184#endif /* GFC_TRANS_H */