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