1 /* Header for code translation functions
2 Copyright (C) 2002-2014 Free Software Foundation, Inc.
3 Contributed by Paul Brook
5 This file is part of GCC.
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
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
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/>. */
24 #include "predict.h" /* For enum br_predictor and PRED_*. */
26 /* Mangled symbols take the form __module__name. */
27 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
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. */
35 unsigned int has_scope
:1;
39 /* a simplified expression */
42 /* Code blocks to be executed before and after using the value. */
46 /* the result of the expression */
49 /* The length of a character string value. */
52 /* If set gfc_conv_variable will return an expression for the array
53 descriptor. When set, want_pointer should also be set.
54 If not set scalarizing variables will be substituted. */
55 unsigned descriptor_only
:1;
57 /* When this is set gfc_conv_expr returns the address of a variable. Only
58 applies to EXPR_VARIABLE nodes.
59 Also used by gfc_conv_array_parameter. When set this indicates a pointer
60 to the descriptor should be returned, rather than the descriptor itself.
62 unsigned want_pointer
:1;
64 /* An array function call returning without a temporary. Also used for array
65 pointer assignments. */
66 unsigned direct_byref
:1;
68 /* If direct_byref is set, do work out the descriptor as in that case but
69 do still create a new descriptor variable instead of using an
70 existing one. This is useful for special pointer assignments like
71 rank remapping where we have to process the descriptor before
72 assigning to final one. */
73 unsigned byref_noassign
:1;
75 /* Ignore absent optional arguments. Used for some intrinsics. */
76 unsigned ignore_optional
:1;
78 /* When this is set the data and offset fields of the returned descriptor
79 are NULL. Used by intrinsic size. */
80 unsigned data_not_needed
:1;
82 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
83 unsigned no_function_call
:1;
85 /* If set, we will force the creation of a temporary. Useful to disable
86 non-copying procedure argument passing optimizations, when some function
90 /* Unconditionally calculate offset for array segments and constant
91 arrays in gfc_conv_expr_descriptor. */
92 unsigned use_offset
:1;
94 unsigned want_coarray
:1;
96 /* Scalarization parameters. */
97 struct gfc_se
*parent
;
99 struct gfc_loopinfo
*loop
;
104 /* Denotes different types of coarray.
105 Please keep in sync with libgfortran/caf/libcaf.h. */
108 GFC_CAF_COARRAY_STATIC
,
109 GFC_CAF_COARRAY_ALLOC
,
116 /* The array-specific scalarization information. The array members of
117 this struct are indexed by actual array index, and thus can be sparse. */
119 typedef struct gfc_array_info
123 /* The ref that holds information on this section. */
125 /* The descriptor of this array. */
127 /* holds the pointer to the data array. */
129 /* To move some of the array index calculation out of the innermost loop. */
133 /* Holds the SS for a subscript. Indexed by actual dimension. */
134 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
136 /* stride and delta are used to access this inside a scalarization loop.
137 start is used in the calculation of these. Indexed by scalarizer
139 tree start
[GFC_MAX_DIMENSIONS
];
140 tree end
[GFC_MAX_DIMENSIONS
];
141 tree stride
[GFC_MAX_DIMENSIONS
];
142 tree delta
[GFC_MAX_DIMENSIONS
];
148 /* A scalar value. This will be evaluated before entering the
149 scalarization loop. */
152 /* Like GFC_SS_SCALAR it evaluates the expression outside the
153 loop. Is always evaluated as a reference to the temporary, unless
154 temporary evaluation can result in a NULL pointer dereferencing (case of
155 optional arguments). Used for elemental function arguments. */
158 /* An array section. Scalarization indices will be substituted during
159 expression translation. */
162 /* A non-elemental function call returning an array. The call is executed
163 before entering the scalarization loop, storing the result in a
164 temporary. This temporary is then used inside the scalarization loop.
165 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
166 as a special case. */
169 /* An array constructor. The current implementation is sub-optimal in
170 many cases. It allocated a temporary, assigns the values to it, then
171 uses this temporary inside the scalarization loop. */
174 /* A vector subscript. The vector's descriptor is cached in the
175 "descriptor" field of the associated gfc_ss_info. */
178 /* A temporary array allocated by the scalarizer. Its rank can be less
179 than that of the assignment expression. */
182 /* An intrinsic function call. Many intrinsic functions which map directly
183 to library calls are created as GFC_SS_FUNCTION nodes. */
186 /* A component of a derived type. */
192 typedef struct gfc_ss_info
201 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
215 /* All other types. */
216 gfc_array_info array
;
220 /* This is used by assignments requiring temporaries. The bits specify which
221 loops the terms appear in. This will be 1 for the RHS expressions,
222 2 for the LHS expressions, and 3(=1|2) for the temporary. */
225 /* Suppresses precalculation of scalars in WHERE assignments. */
228 /* Tells whether the SS is for an actual argument which can be a NULL
229 reference. In other words, the associated dummy argument is OPTIONAL.
230 Used to handle elemental procedures. */
231 bool can_be_null_ref
;
235 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
238 /* Scalarization State chain. Created by walking an expression tree before
239 creating the scalarization loops. Then passed as part of a gfc_se structure
240 to translate the expression inside the loop. Note that these chains are
241 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
242 indicates to gfc_conv_* that this is a scalar expression.
243 SS structures can only belong to a single loopinfo. They must be added
244 otherwise they will not get freed. */
246 typedef struct gfc_ss
251 /* Translation from loop dimensions to actual array dimensions.
252 actual_dim = dim[loop_dim] */
253 int dim
[GFC_MAX_DIMENSIONS
];
255 /* All the SS in a loop and linked through loop_chain. The SS for an
256 expression are linked by the next pointer. */
257 struct gfc_ss
*loop_chain
;
260 /* Non-null if the ss is part of a nested loop. */
261 struct gfc_ss
*parent
;
263 /* If the evaluation of an expression requires a nested loop (for example
264 if the sum intrinsic is evaluated inline), this points to the nested
266 struct gfc_ss
*nested_ss
;
268 /* The loop this gfc_ss is in. */
269 struct gfc_loopinfo
*loop
;
271 unsigned is_alloc_lhs
:1;
274 #define gfc_get_ss() XCNEW (gfc_ss)
276 /* The contents of this aren't actually used. A NULL SS chain indicates a
277 scalar expression, so this pointer is used to terminate SS chains. */
278 extern gfc_ss
* const gfc_ss_terminator
;
280 /* Holds information about an expression while it is being scalarized. */
281 typedef struct gfc_loopinfo
288 /* All the SS involved with this loop. */
290 /* The SS describing the temporary used in an assignment. */
293 /* Non-null if this loop is nested in another one. */
294 struct gfc_loopinfo
*parent
;
296 /* Chain of nested loops. */
297 struct gfc_loopinfo
*nested
, *next
;
299 /* The scalarization loop index variables. */
300 tree loopvar
[GFC_MAX_DIMENSIONS
];
302 /* The bounds of the scalarization loops. */
303 tree from
[GFC_MAX_DIMENSIONS
];
304 tree to
[GFC_MAX_DIMENSIONS
];
305 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
307 /* The code member contains the code for the body of the next outer loop. */
308 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
310 /* Order in which the dimensions should be looped, innermost first. */
311 int order
[GFC_MAX_DIMENSIONS
];
313 /* Enum to control loop reversal. */
314 gfc_reverse reverse
[GFC_MAX_DIMENSIONS
];
316 /* The number of dimensions for which a temporary is used. */
319 /* If set we don't need the loop variables. */
320 unsigned array_parameter
:1;
324 #define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
326 /* Information about a symbol that has been shadowed by a temporary. */
329 symbol_attribute attr
;
335 /* Store information about a block of code together with special
336 initialization and clean-up code. This can be used to incrementally add
337 init and cleanup, and in the end put everything together to a
338 try-finally expression. */
347 /* Class API functions. */
348 tree
gfc_class_data_get (tree
);
349 tree
gfc_class_vptr_get (tree
);
350 void gfc_reset_vptr (stmtblock_t
*, gfc_expr
*);
351 tree
gfc_class_set_static_fields (tree
, tree
, tree
);
352 tree
gfc_vtable_hash_get (tree
);
353 tree
gfc_vtable_size_get (tree
);
354 tree
gfc_vtable_extends_get (tree
);
355 tree
gfc_vtable_def_init_get (tree
);
356 tree
gfc_vtable_copy_get (tree
);
357 tree
gfc_vtable_final_get (tree
);
358 tree
gfc_get_vptr_from_expr (tree
);
359 tree
gfc_get_class_array_ref (tree
, tree
);
360 tree
gfc_copy_class_to_class (tree
, tree
, tree
);
361 bool gfc_add_finalizer_call (stmtblock_t
*, gfc_expr
*);
362 bool gfc_add_comp_finalizer_call (stmtblock_t
*, tree
, gfc_component
*, bool);
364 void gfc_conv_derived_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, tree
, bool,
366 void gfc_conv_class_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, bool, bool,
369 /* Initialize an init/cleanup block. */
370 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
371 /* Add a pair of init/cleanup code to the block. Each one might be a
372 NULL_TREE if not required. */
373 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
374 /* Finalize the block, that is, create a single expression encapsulating the
375 original code together with init and clean-up code. */
376 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
379 /* Advance the SS chain to the next term. */
380 void gfc_advance_se_ss_chain (gfc_se
*);
382 /* Call this to initialize a gfc_se structure before use
383 first parameter is structure to initialize, second is
384 parent to get scalarization data from, or NULL. */
385 void gfc_init_se (gfc_se
*, gfc_se
*);
387 /* Create an artificial variable decl and add it to the current scope. */
388 tree
gfc_create_var (tree
, const char *);
389 /* Like above but doesn't add it to the current scope. */
390 tree
gfc_create_var_np (tree
, const char *);
392 /* Store the result of an expression in a temp variable so it can be used
393 repeatedly even if the original changes */
394 void gfc_make_safe_expr (gfc_se
* se
);
396 /* Makes sure se is suitable for passing as a function string parameter. */
397 void gfc_conv_string_parameter (gfc_se
* se
);
399 /* Compare two strings. */
400 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
402 /* When using the gfc_conv_* make sure you understand what they do, i.e.
403 when a POST chain may be created, and what the returned expression may be
404 used for. Note that character strings have special handling. This
405 should not be a problem as most statements/operations only deal with
406 numeric/logical types. See the implementations in trans-expr.c
407 for details of the individual functions. */
409 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
410 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
411 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
412 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
413 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
415 tree
gfc_conv_scalar_to_descriptor (gfc_se
*, tree
, symbol_attribute
);
419 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
420 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
421 tree
gfc_get_tree_for_caf_expr (gfc_expr
*);
423 /* Find the decl containing the auxiliary variables for assigned variables. */
424 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
425 /* If the value is not constant, Create a temporary and copy the value. */
426 tree
gfc_evaluate_now_loc (location_t
, tree
, stmtblock_t
*);
427 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
429 /* Find the appropriate variant of a math intrinsic. */
430 tree
gfc_builtin_decl_for_float_kind (enum built_in_function
, int);
432 tree
size_of_string_in_bytes (int, tree
);
434 /* Intrinsic procedure handling. */
435 tree
gfc_conv_intrinsic_subroutine (gfc_code
*);
436 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
438 /* Does an intrinsic map directly to an external library call
439 This is true for array-returning intrinsics, unless
440 gfc_inline_intrinsic_function_p returns true. */
441 int gfc_is_intrinsic_libcall (gfc_expr
*);
443 /* Used to call ordinary functions/subroutines
444 and procedure pointer components. */
445 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
446 gfc_expr
*, vec
<tree
, va_gc
> *);
448 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
450 /* Generate code for a scalar assignment. */
451 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
454 /* Translate COMMON blocks. */
455 void gfc_trans_common (gfc_namespace
*);
457 /* Translate a derived type constructor. */
458 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
460 /* Return an expression which determines if a dummy parameter is present. */
461 tree
gfc_conv_expr_present (gfc_symbol
*);
462 /* Convert a missing, dummy argument into a null or zero. */
463 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
465 /* Generate code to allocate a string temporary. */
466 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
467 /* Get the string length variable belonging to an expression. */
468 tree
gfc_get_expr_charlen (gfc_expr
*);
469 /* Initialize a string length variable. */
470 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
471 /* Ensure type sizes can be gimplified. */
472 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
474 /* Add an expression to the end of a block. */
475 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
476 /* Add an expression to the beginning of a block. */
477 void gfc_prepend_expr_to_block (stmtblock_t
*, tree
);
478 /* Add a block to the end of a block. */
479 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
480 /* Add a MODIFY_EXPR to a block. */
481 void gfc_add_modify_loc (location_t
, stmtblock_t
*, tree
, tree
);
482 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
484 /* Initialize a statement block. */
485 void gfc_init_block (stmtblock_t
*);
486 /* Start a new statement block. Like gfc_init_block but also starts a new
488 void gfc_start_block (stmtblock_t
*);
489 /* Finish a statement block. Also closes the scope if the block was created
490 with gfc_start_block. */
491 tree
gfc_finish_block (stmtblock_t
*);
492 /* Merge the scope of a block with its parent. */
493 void gfc_merge_block_scope (stmtblock_t
* block
);
495 /* Return the backend label decl. */
496 tree
gfc_get_label_decl (gfc_st_label
*);
498 /* Return the decl for an external function. */
499 tree
gfc_get_extern_function_decl (gfc_symbol
*);
501 /* Return the decl for a function. */
502 tree
gfc_get_function_decl (gfc_symbol
*);
504 /* Build an ADDR_EXPR. */
505 tree
gfc_build_addr_expr (tree
, tree
);
507 /* Build an ARRAY_REF. */
508 tree
gfc_build_array_ref (tree
, tree
, tree
);
510 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
511 tree
gfc_build_label_decl (tree
);
513 /* Return the decl used to hold the function return value.
514 Do not use if the function has an explicit result variable. */
515 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
517 /* Add a decl to the binding level for the current function. */
518 void gfc_add_decl_to_function (tree
);
520 /* Make prototypes for runtime library functions. */
521 void gfc_build_builtin_function_decls (void);
523 /* Set the backend source location of a decl. */
524 void gfc_set_decl_location (tree
, locus
*);
526 /* Get a module symbol backend_decl if possible. */
527 bool gfc_get_module_backend_decl (gfc_symbol
*);
529 /* Return the variable decl for a symbol. */
530 tree
gfc_get_symbol_decl (gfc_symbol
*);
532 /* Build a static initializer. */
533 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool, bool);
535 /* Assign a default initializer to a derived type. */
536 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
538 /* Substitute a temporary variable in place of the real one. */
539 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
541 /* Restore the original variable. */
542 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
544 /* Setting a decl assembler name, mangling it according to target rules
545 (like Windows @NN decorations). */
546 void gfc_set_decl_assembler_name (tree
, tree
);
548 /* Returns true if a variable of specified size should go on the stack. */
549 int gfc_can_put_var_on_stack (tree
);
551 /* Set GFC_DECL_SCALAR_* on decl from sym if needed. */
552 void gfc_finish_decl_attrs (tree
, symbol_attribute
*);
554 /* Allocate the lang-specific part of a decl node. */
555 void gfc_allocate_lang_decl (tree
);
557 /* Advance along a TREE_CHAIN. */
558 tree
gfc_advance_chain (tree
, int);
560 /* Create a decl for a function. */
561 void gfc_create_function_decl (gfc_namespace
*, bool);
562 /* Generate the code for a function. */
563 void gfc_generate_function_code (gfc_namespace
*);
564 /* Output a BLOCK DATA program unit. */
565 void gfc_generate_block_data (gfc_namespace
*);
566 /* Output a decl for a module variable. */
567 void gfc_generate_module_vars (gfc_namespace
*);
568 /* Get the appropriate return statement for a procedure. */
569 tree
gfc_generate_return (void);
571 struct GTY(()) module_htab_entry
{
574 htab_t
GTY ((param_is (union tree_node
))) decls
;
577 struct module_htab_entry
*gfc_find_module (const char *);
578 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
580 /* Get and set the current location. */
581 void gfc_save_backend_locus (locus
*);
582 void gfc_set_backend_locus (locus
*);
583 void gfc_restore_backend_locus (locus
*);
585 /* Handle static constructor functions. */
586 extern GTY(()) tree gfc_static_ctors
;
587 void gfc_generate_constructors (void);
589 /* Get the string length of an array constructor. */
590 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
592 /* Mark a condition as likely or unlikely. */
593 tree
gfc_likely (tree
, enum br_predictor
);
594 tree
gfc_unlikely (tree
, enum br_predictor
);
596 /* Return the string length of a deferred character length component. */
597 bool gfc_deferred_strlen (gfc_component
*, tree
*);
599 /* Generate a runtime error call. */
600 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
602 /* Generate a runtime warning/error check. */
603 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
606 /* Generate a runtime check for same string length. */
607 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
610 /* Generate a call to free() after checking that its arg is non-NULL. */
611 tree
gfc_call_free (tree
);
613 /* Allocate memory after performing a few checks. */
614 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
616 /* Build a memcpy call. */
617 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
619 /* Allocate memory for allocatable variables, with optional status variable. */
620 void gfc_allocate_allocatable (stmtblock_t
*, tree
, tree
, tree
, tree
,
621 tree
, tree
, tree
, gfc_expr
*);
623 /* Allocate memory, with optional status variable. */
624 void gfc_allocate_using_malloc (stmtblock_t
*, tree
, tree
, tree
);
626 /* Generate code to deallocate an array. */
627 tree
gfc_deallocate_with_status (tree
, tree
, tree
, tree
, tree
, bool,
629 tree
gfc_deallocate_scalar_with_status (tree
, tree
, bool, gfc_expr
*, gfc_typespec
);
631 /* Generate code to call realloc(). */
632 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
634 /* Generate code for an assignment, includes scalarization. */
635 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
637 /* Generate code for a pointer assignment. */
638 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
640 /* Initialize function decls for library functions. */
641 void gfc_build_intrinsic_lib_fndecls (void);
642 /* Create function decls for IO library functions. */
643 void gfc_build_io_library_fndecls (void);
644 /* Build a function decl for a library function. */
645 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
646 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
647 tree rettype
, int nargs
, ...);
649 /* Process the local variable decls of a block construct. */
650 void gfc_process_block_locals (gfc_namespace
*);
652 /* Output initialization/clean-up code that was deferred. */
653 void gfc_trans_deferred_vars (gfc_symbol
*, gfc_wrapped_block
*);
656 tree
pushdecl (tree
);
657 tree
pushdecl_top_level (tree
);
658 void pushlevel (void);
659 tree
poplevel (int, int);
660 tree
getdecls (void);
662 /* In trans-types.c. */
663 struct array_descr_info
;
664 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
666 /* In trans-openmp.c */
667 bool gfc_omp_privatize_by_reference (const_tree
);
668 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
669 tree
gfc_omp_report_decl (tree
);
670 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
671 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
672 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
673 tree
gfc_omp_clause_linear_ctor (tree
, tree
, tree
, tree
);
674 tree
gfc_omp_clause_dtor (tree
, tree
);
675 void gfc_omp_finish_clause (tree
, gimple_seq
*);
676 bool gfc_omp_disregard_value_expr (tree
, bool);
677 bool gfc_omp_private_debug_clause (tree
, bool);
678 bool gfc_omp_private_outer_ref (tree
);
679 struct gimplify_omp_ctx
;
680 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
682 /* Runtime library function decls. */
683 extern GTY(()) tree gfor_fndecl_pause_numeric
;
684 extern GTY(()) tree gfor_fndecl_pause_string
;
685 extern GTY(()) tree gfor_fndecl_stop_numeric
;
686 extern GTY(()) tree gfor_fndecl_stop_numeric_f08
;
687 extern GTY(()) tree gfor_fndecl_stop_string
;
688 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
689 extern GTY(()) tree gfor_fndecl_error_stop_string
;
690 extern GTY(()) tree gfor_fndecl_runtime_error
;
691 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
692 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
693 extern GTY(()) tree gfor_fndecl_os_error
;
694 extern GTY(()) tree gfor_fndecl_generate_error
;
695 extern GTY(()) tree gfor_fndecl_set_fpe
;
696 extern GTY(()) tree gfor_fndecl_set_options
;
697 extern GTY(()) tree gfor_fndecl_ttynam
;
698 extern GTY(()) tree gfor_fndecl_ctime
;
699 extern GTY(()) tree gfor_fndecl_fdate
;
700 extern GTY(()) tree gfor_fndecl_in_pack
;
701 extern GTY(()) tree gfor_fndecl_in_unpack
;
702 extern GTY(()) tree gfor_fndecl_associated
;
703 extern GTY(()) tree gfor_fndecl_system_clock4
;
704 extern GTY(()) tree gfor_fndecl_system_clock8
;
707 /* Coarray run-time library function decls. */
708 extern GTY(()) tree gfor_fndecl_caf_init
;
709 extern GTY(()) tree gfor_fndecl_caf_finalize
;
710 extern GTY(()) tree gfor_fndecl_caf_this_image
;
711 extern GTY(()) tree gfor_fndecl_caf_num_images
;
712 extern GTY(()) tree gfor_fndecl_caf_register
;
713 extern GTY(()) tree gfor_fndecl_caf_deregister
;
714 extern GTY(()) tree gfor_fndecl_caf_get
;
715 extern GTY(()) tree gfor_fndecl_caf_send
;
716 extern GTY(()) tree gfor_fndecl_caf_sendget
;
717 extern GTY(()) tree gfor_fndecl_caf_critical
;
718 extern GTY(()) tree gfor_fndecl_caf_end_critical
;
719 extern GTY(()) tree gfor_fndecl_caf_sync_all
;
720 extern GTY(()) tree gfor_fndecl_caf_sync_images
;
721 extern GTY(()) tree gfor_fndecl_caf_error_stop
;
722 extern GTY(()) tree gfor_fndecl_caf_error_stop_str
;
723 extern GTY(()) tree gfor_fndecl_co_max
;
724 extern GTY(()) tree gfor_fndecl_co_min
;
725 extern GTY(()) tree gfor_fndecl_co_sum
;
728 /* Math functions. Many other math functions are handled in
729 trans-intrinsic.c. */
731 typedef struct GTY(()) gfc_powdecl_list
{
738 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
739 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
740 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
741 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
743 /* BLAS functions. */
744 extern GTY(()) tree gfor_fndecl_sgemm
;
745 extern GTY(()) tree gfor_fndecl_dgemm
;
746 extern GTY(()) tree gfor_fndecl_cgemm
;
747 extern GTY(()) tree gfor_fndecl_zgemm
;
749 /* String functions. */
750 extern GTY(()) tree gfor_fndecl_compare_string
;
751 extern GTY(()) tree gfor_fndecl_concat_string
;
752 extern GTY(()) tree gfor_fndecl_string_len_trim
;
753 extern GTY(()) tree gfor_fndecl_string_index
;
754 extern GTY(()) tree gfor_fndecl_string_scan
;
755 extern GTY(()) tree gfor_fndecl_string_verify
;
756 extern GTY(()) tree gfor_fndecl_string_trim
;
757 extern GTY(()) tree gfor_fndecl_string_minmax
;
758 extern GTY(()) tree gfor_fndecl_adjustl
;
759 extern GTY(()) tree gfor_fndecl_adjustr
;
760 extern GTY(()) tree gfor_fndecl_select_string
;
761 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
762 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
763 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
764 extern GTY(()) tree gfor_fndecl_string_index_char4
;
765 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
766 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
767 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
768 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
769 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
770 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
771 extern GTY(()) tree gfor_fndecl_select_string_char4
;
773 /* Conversion between character kinds. */
774 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
775 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
777 /* Other misc. runtime library functions. */
778 extern GTY(()) tree gfor_fndecl_size0
;
779 extern GTY(()) tree gfor_fndecl_size1
;
780 extern GTY(()) tree gfor_fndecl_iargc
;
782 /* Implemented in Fortran. */
783 extern GTY(()) tree gfor_fndecl_sc_kind
;
784 extern GTY(()) tree gfor_fndecl_si_kind
;
785 extern GTY(()) tree gfor_fndecl_sr_kind
;
788 /* True if node is an integer constant. */
789 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
791 /* gfortran-specific declaration information, the _CONT versions denote
792 arrays with CONTIGUOUS attribute. */
797 GFC_ARRAY_ASSUMED_SHAPE
,
798 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
799 GFC_ARRAY_ASSUMED_RANK
,
800 GFC_ARRAY_ASSUMED_RANK_CONT
,
801 GFC_ARRAY_ALLOCATABLE
,
803 GFC_ARRAY_POINTER_CONT
806 /* Array types only. */
807 struct GTY(()) lang_type
{
809 enum gfc_array_kind akind
;
810 tree lbound
[GFC_MAX_DIMENSIONS
];
811 tree ubound
[GFC_MAX_DIMENSIONS
];
812 tree stride
[GFC_MAX_DIMENSIONS
];
819 tree nonrestricted_type
;
824 struct GTY(()) lang_decl
{
825 /* Dummy variables. */
826 tree saved_descriptor
;
827 /* Assigned integer nodes. Stringlength is the IO format string's length.
828 Addr is the address of the string or the target label. Stringlength is
829 initialized to -2 and assigned to -1 when addr is assigned to the
830 address of target label. */
834 /* For assumed-shape coarrays. */
835 tree token
, caf_offset
;
836 unsigned int scalar_allocatable
: 1;
837 unsigned int scalar_pointer
: 1;
841 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
842 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
843 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
844 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
845 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
846 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
847 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
848 #define GFC_DECL_SCALAR_ALLOCATABLE(node) \
849 (DECL_LANG_SPECIFIC (node)->scalar_allocatable)
850 #define GFC_DECL_SCALAR_POINTER(node) \
851 (DECL_LANG_SPECIFIC (node)->scalar_pointer)
852 #define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
853 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
854 #define GFC_DECL_GET_SCALAR_POINTER(node) \
855 (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
856 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
857 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
858 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
859 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
860 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
861 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
862 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
863 #define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
864 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
866 /* An array descriptor. */
867 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
868 /* An array without a descriptor. */
869 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
870 /* Fortran CLASS type. */
871 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
872 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
873 descriptorless array types. */
874 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
875 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
876 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
877 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
878 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
879 (TYPE_LANG_SPECIFIC(node)->stride[dim])
880 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
881 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
882 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
883 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
884 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
885 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
886 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
887 /* Code should use gfc_get_dtype instead of accessing this directly. It may
888 not be known when the type is created. */
889 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
890 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
891 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
892 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
893 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
894 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
897 /* Build an expression with void type. */
898 #define build1_v(code, arg) \
899 fold_build1_loc (input_location, code, void_type_node, arg)
900 #define build2_v(code, arg1, arg2) \
901 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
902 #define build3_v(code, arg1, arg2, arg3) \
903 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
904 #define build4_v(code, arg1, arg2, arg3, arg4) \
905 build4_loc (input_location, code, void_type_node, arg1, arg2, \
908 /* This group of functions allows a caller to evaluate an expression from
909 the callee's interface. It establishes a mapping between the interface's
910 dummy arguments and the caller's actual arguments, then applies that
911 mapping to a given gfc_expr.
913 You can initialize a mapping structure like so:
915 gfc_interface_mapping mapping;
917 gfc_init_interface_mapping (&mapping);
919 You should then evaluate each actual argument into a temporary
920 gfc_se structure, here called "se", and map the result to the
921 dummy argument's symbol, here called "sym":
923 gfc_add_interface_mapping (&mapping, sym, &se);
925 After adding all mappings, you should call:
927 gfc_finish_interface_mapping (&mapping, pre, post);
929 where "pre" and "post" are statement blocks for initialization
930 and finalization code respectively. You can then evaluate an
931 interface expression "expr" as follows:
933 gfc_apply_interface_mapping (&mapping, se, expr);
935 Once you've evaluated all expressions, you should free
936 the mapping structure with:
938 gfc_free_interface_mapping (&mapping); */
941 /* This structure represents a mapping from OLD to NEW, where OLD is a
942 dummy argument symbol and NEW is a symbol that represents the value
943 of an actual argument. Mappings are linked together using NEXT
944 (in no particular order). */
945 typedef struct gfc_interface_sym_mapping
947 struct gfc_interface_sym_mapping
*next
;
949 gfc_symtree
*new_sym
;
952 gfc_interface_sym_mapping
;
955 /* This structure is used by callers to evaluate an expression from
956 a callee's interface. */
957 typedef struct gfc_interface_mapping
959 /* Maps the interface's dummy arguments to the values that the caller
960 is passing. The whole list is owned by this gfc_interface_mapping. */
961 gfc_interface_sym_mapping
*syms
;
963 /* A list of gfc_charlens that were needed when creating copies of
964 expressions. The whole list is owned by this gfc_interface_mapping. */
965 gfc_charlen
*charlens
;
967 gfc_interface_mapping
;
969 void gfc_init_interface_mapping (gfc_interface_mapping
*);
970 void gfc_free_interface_mapping (gfc_interface_mapping
*);
971 void gfc_add_interface_mapping (gfc_interface_mapping
*,
972 gfc_symbol
*, gfc_se
*, gfc_expr
*);
973 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
974 stmtblock_t
*, stmtblock_t
*);
975 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
976 gfc_se
*, gfc_expr
*);
979 /* Standard error messages used in all the trans-*.c files. */
980 extern const char gfc_msg_fault
[];
981 extern const char gfc_msg_wrong_return
[];
983 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
984 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
985 construct is not workshared. */
986 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
987 to create parallel loops. */
988 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
989 extern int ompws_flags
;
991 #endif /* GFC_TRANS_H */