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 unsigned want_coarray
:1;
92 /* Scalarization parameters. */
93 struct gfc_se
*parent
;
95 struct gfc_loopinfo
*loop
;
100 /* Denotes different types of coarray.
101 Please keep in sync with libgfortran/caf/libcaf.h. */
104 GFC_CAF_COARRAY_STATIC
,
105 GFC_CAF_COARRAY_ALLOC
,
112 /* The array-specific scalarization information. The array members of
113 this struct are indexed by actual array index, and thus can be sparse. */
115 typedef struct gfc_array_info
119 /* The ref that holds information on this section. */
121 /* The descriptor of this array. */
123 /* holds the pointer to the data array. */
125 /* To move some of the array index calculation out of the innermost loop. */
129 /* Holds the SS for a subscript. Indexed by actual dimension. */
130 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
132 /* stride and delta are used to access this inside a scalarization loop.
133 start is used in the calculation of these. Indexed by scalarizer
135 tree start
[GFC_MAX_DIMENSIONS
];
136 tree end
[GFC_MAX_DIMENSIONS
];
137 tree stride
[GFC_MAX_DIMENSIONS
];
138 tree delta
[GFC_MAX_DIMENSIONS
];
144 /* A scalar value. This will be evaluated before entering the
145 scalarization loop. */
148 /* Like GFC_SS_SCALAR it evaluates the expression outside the
149 loop. Is always evaluated as a reference to the temporary, unless
150 temporary evaluation can result in a NULL pointer dereferencing (case of
151 optional arguments). Used for elemental function arguments. */
154 /* An array section. Scalarization indices will be substituted during
155 expression translation. */
158 /* A non-elemental function call returning an array. The call is executed
159 before entering the scalarization loop, storing the result in a
160 temporary. This temporary is then used inside the scalarization loop.
161 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
162 as a special case. */
165 /* An array constructor. The current implementation is sub-optimal in
166 many cases. It allocated a temporary, assigns the values to it, then
167 uses this temporary inside the scalarization loop. */
170 /* A vector subscript. The vector's descriptor is cached in the
171 "descriptor" field of the associated gfc_ss_info. */
174 /* A temporary array allocated by the scalarizer. Its rank can be less
175 than that of the assignment expression. */
178 /* An intrinsic function call. Many intrinsic functions which map directly
179 to library calls are created as GFC_SS_FUNCTION nodes. */
182 /* A component of a derived type. */
188 typedef struct gfc_ss_info
197 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
211 /* All other types. */
212 gfc_array_info array
;
216 /* This is used by assignments requiring temporaries. The bits specify which
217 loops the terms appear in. This will be 1 for the RHS expressions,
218 2 for the LHS expressions, and 3(=1|2) for the temporary. */
221 /* Suppresses precalculation of scalars in WHERE assignments. */
224 /* Tells whether the SS is for an actual argument which can be a NULL
225 reference. In other words, the associated dummy argument is OPTIONAL.
226 Used to handle elemental procedures. */
227 bool can_be_null_ref
;
231 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
234 /* Scalarization State chain. Created by walking an expression tree before
235 creating the scalarization loops. Then passed as part of a gfc_se structure
236 to translate the expression inside the loop. Note that these chains are
237 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
238 indicates to gfc_conv_* that this is a scalar expression.
239 SS structures can only belong to a single loopinfo. They must be added
240 otherwise they will not get freed. */
242 typedef struct gfc_ss
247 /* Translation from loop dimensions to actual array dimensions.
248 actual_dim = dim[loop_dim] */
249 int dim
[GFC_MAX_DIMENSIONS
];
251 /* All the SS in a loop and linked through loop_chain. The SS for an
252 expression are linked by the next pointer. */
253 struct gfc_ss
*loop_chain
;
256 /* Non-null if the ss is part of a nested loop. */
257 struct gfc_ss
*parent
;
259 /* If the evaluation of an expression requires a nested loop (for example
260 if the sum intrinsic is evaluated inline), this points to the nested
262 struct gfc_ss
*nested_ss
;
264 /* The loop this gfc_ss is in. */
265 struct gfc_loopinfo
*loop
;
267 unsigned is_alloc_lhs
:1;
270 #define gfc_get_ss() XCNEW (gfc_ss)
272 /* The contents of this aren't actually used. A NULL SS chain indicates a
273 scalar expression, so this pointer is used to terminate SS chains. */
274 extern gfc_ss
* const gfc_ss_terminator
;
276 /* Holds information about an expression while it is being scalarized. */
277 typedef struct gfc_loopinfo
284 /* All the SS involved with this loop. */
286 /* The SS describing the temporary used in an assignment. */
289 /* Non-null if this loop is nested in another one. */
290 struct gfc_loopinfo
*parent
;
292 /* Chain of nested loops. */
293 struct gfc_loopinfo
*nested
, *next
;
295 /* The scalarization loop index variables. */
296 tree loopvar
[GFC_MAX_DIMENSIONS
];
298 /* The bounds of the scalarization loops. */
299 tree from
[GFC_MAX_DIMENSIONS
];
300 tree to
[GFC_MAX_DIMENSIONS
];
301 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
303 /* The code member contains the code for the body of the next outer loop. */
304 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
306 /* Order in which the dimensions should be looped, innermost first. */
307 int order
[GFC_MAX_DIMENSIONS
];
309 /* Enum to control loop reversal. */
310 gfc_reverse reverse
[GFC_MAX_DIMENSIONS
];
312 /* The number of dimensions for which a temporary is used. */
315 /* If set we don't need the loop variables. */
316 unsigned array_parameter
:1;
320 #define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
322 /* Information about a symbol that has been shadowed by a temporary. */
325 symbol_attribute attr
;
331 /* Store information about a block of code together with special
332 initialization and clean-up code. This can be used to incrementally add
333 init and cleanup, and in the end put everything together to a
334 try-finally expression. */
343 /* Class API functions. */
344 tree
gfc_class_data_get (tree
);
345 tree
gfc_class_vptr_get (tree
);
346 void gfc_reset_vptr (stmtblock_t
*, gfc_expr
*);
347 tree
gfc_class_set_static_fields (tree
, tree
, tree
);
348 tree
gfc_vtable_hash_get (tree
);
349 tree
gfc_vtable_size_get (tree
);
350 tree
gfc_vtable_extends_get (tree
);
351 tree
gfc_vtable_def_init_get (tree
);
352 tree
gfc_vtable_copy_get (tree
);
353 tree
gfc_vtable_final_get (tree
);
354 tree
gfc_get_vptr_from_expr (tree
);
355 tree
gfc_get_class_array_ref (tree
, tree
);
356 tree
gfc_copy_class_to_class (tree
, tree
, tree
);
357 bool gfc_add_finalizer_call (stmtblock_t
*, gfc_expr
*);
358 bool gfc_add_comp_finalizer_call (stmtblock_t
*, tree
, gfc_component
*, bool);
360 void gfc_conv_derived_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, tree
, bool,
362 void gfc_conv_class_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, bool, bool,
365 /* Initialize an init/cleanup block. */
366 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
367 /* Add a pair of init/cleanup code to the block. Each one might be a
368 NULL_TREE if not required. */
369 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
370 /* Finalize the block, that is, create a single expression encapsulating the
371 original code together with init and clean-up code. */
372 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
375 /* Advance the SS chain to the next term. */
376 void gfc_advance_se_ss_chain (gfc_se
*);
378 /* Call this to initialize a gfc_se structure before use
379 first parameter is structure to initialize, second is
380 parent to get scalarization data from, or NULL. */
381 void gfc_init_se (gfc_se
*, gfc_se
*);
383 /* Create an artificial variable decl and add it to the current scope. */
384 tree
gfc_create_var (tree
, const char *);
385 /* Like above but doesn't add it to the current scope. */
386 tree
gfc_create_var_np (tree
, const char *);
388 /* Store the result of an expression in a temp variable so it can be used
389 repeatedly even if the original changes */
390 void gfc_make_safe_expr (gfc_se
* se
);
392 /* Makes sure se is suitable for passing as a function string parameter. */
393 void gfc_conv_string_parameter (gfc_se
* se
);
395 /* Compare two strings. */
396 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
398 /* When using the gfc_conv_* make sure you understand what they do, i.e.
399 when a POST chain may be created, and what the returned expression may be
400 used for. Note that character strings have special handling. This
401 should not be a problem as most statements/operations only deal with
402 numeric/logical types. See the implementations in trans-expr.c
403 for details of the individual functions. */
405 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
406 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
407 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
408 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
409 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
411 tree
gfc_conv_scalar_to_descriptor (gfc_se
*, tree
, symbol_attribute
);
415 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
416 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
418 /* Find the decl containing the auxiliary variables for assigned variables. */
419 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
420 /* If the value is not constant, Create a temporary and copy the value. */
421 tree
gfc_evaluate_now_loc (location_t
, tree
, stmtblock_t
*);
422 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
424 /* Find the appropriate variant of a math intrinsic. */
425 tree
gfc_builtin_decl_for_float_kind (enum built_in_function
, int);
427 tree
size_of_string_in_bytes (int, tree
);
429 /* Intrinsic procedure handling. */
430 tree
gfc_conv_intrinsic_subroutine (gfc_code
*);
431 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
433 /* Does an intrinsic map directly to an external library call
434 This is true for array-returning intrinsics, unless
435 gfc_inline_intrinsic_function_p returns true. */
436 int gfc_is_intrinsic_libcall (gfc_expr
*);
438 /* Used to call ordinary functions/subroutines
439 and procedure pointer components. */
440 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
441 gfc_expr
*, vec
<tree
, va_gc
> *);
443 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
445 /* Generate code for a scalar assignment. */
446 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
449 /* Translate COMMON blocks. */
450 void gfc_trans_common (gfc_namespace
*);
452 /* Translate a derived type constructor. */
453 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
455 /* Return an expression which determines if a dummy parameter is present. */
456 tree
gfc_conv_expr_present (gfc_symbol
*);
457 /* Convert a missing, dummy argument into a null or zero. */
458 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
460 /* Generate code to allocate a string temporary. */
461 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
462 /* Get the string length variable belonging to an expression. */
463 tree
gfc_get_expr_charlen (gfc_expr
*);
464 /* Initialize a string length variable. */
465 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
466 /* Ensure type sizes can be gimplified. */
467 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
469 /* Add an expression to the end of a block. */
470 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
471 /* Add an expression to the beginning of a block. */
472 void gfc_prepend_expr_to_block (stmtblock_t
*, tree
);
473 /* Add a block to the end of a block. */
474 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
475 /* Add a MODIFY_EXPR to a block. */
476 void gfc_add_modify_loc (location_t
, stmtblock_t
*, tree
, tree
);
477 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
479 /* Initialize a statement block. */
480 void gfc_init_block (stmtblock_t
*);
481 /* Start a new statement block. Like gfc_init_block but also starts a new
483 void gfc_start_block (stmtblock_t
*);
484 /* Finish a statement block. Also closes the scope if the block was created
485 with gfc_start_block. */
486 tree
gfc_finish_block (stmtblock_t
*);
487 /* Merge the scope of a block with its parent. */
488 void gfc_merge_block_scope (stmtblock_t
* block
);
490 /* Return the backend label decl. */
491 tree
gfc_get_label_decl (gfc_st_label
*);
493 /* Return the decl for an external function. */
494 tree
gfc_get_extern_function_decl (gfc_symbol
*);
496 /* Return the decl for a function. */
497 tree
gfc_get_function_decl (gfc_symbol
*);
499 /* Build an ADDR_EXPR. */
500 tree
gfc_build_addr_expr (tree
, tree
);
502 /* Build an ARRAY_REF. */
503 tree
gfc_build_array_ref (tree
, tree
, tree
);
505 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
506 tree
gfc_build_label_decl (tree
);
508 /* Return the decl used to hold the function return value.
509 Do not use if the function has an explicit result variable. */
510 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
512 /* Add a decl to the binding level for the current function. */
513 void gfc_add_decl_to_function (tree
);
515 /* Make prototypes for runtime library functions. */
516 void gfc_build_builtin_function_decls (void);
518 /* Set the backend source location of a decl. */
519 void gfc_set_decl_location (tree
, locus
*);
521 /* Get a module symbol backend_decl if possible. */
522 bool gfc_get_module_backend_decl (gfc_symbol
*);
524 /* Return the variable decl for a symbol. */
525 tree
gfc_get_symbol_decl (gfc_symbol
*);
527 /* Build a static initializer. */
528 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool, bool);
530 /* Assign a default initializer to a derived type. */
531 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
533 /* Substitute a temporary variable in place of the real one. */
534 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
536 /* Restore the original variable. */
537 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
539 /* Setting a decl assembler name, mangling it according to target rules
540 (like Windows @NN decorations). */
541 void gfc_set_decl_assembler_name (tree
, tree
);
543 /* Returns true if a variable of specified size should go on the stack. */
544 int gfc_can_put_var_on_stack (tree
);
546 /* Allocate the lang-specific part of a decl node. */
547 void gfc_allocate_lang_decl (tree
);
549 /* Advance along a TREE_CHAIN. */
550 tree
gfc_advance_chain (tree
, int);
552 /* Create a decl for a function. */
553 void gfc_create_function_decl (gfc_namespace
*, bool);
554 /* Generate the code for a function. */
555 void gfc_generate_function_code (gfc_namespace
*);
556 /* Output a BLOCK DATA program unit. */
557 void gfc_generate_block_data (gfc_namespace
*);
558 /* Output a decl for a module variable. */
559 void gfc_generate_module_vars (gfc_namespace
*);
560 /* Get the appropriate return statement for a procedure. */
561 tree
gfc_generate_return (void);
563 struct GTY(()) module_htab_entry
{
566 htab_t
GTY ((param_is (union tree_node
))) decls
;
569 struct module_htab_entry
*gfc_find_module (const char *);
570 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
572 /* Get and set the current location. */
573 void gfc_save_backend_locus (locus
*);
574 void gfc_set_backend_locus (locus
*);
575 void gfc_restore_backend_locus (locus
*);
577 /* Handle static constructor functions. */
578 extern GTY(()) tree gfc_static_ctors
;
579 void gfc_generate_constructors (void);
581 /* Get the string length of an array constructor. */
582 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
584 /* Mark a condition as likely or unlikely. */
585 tree
gfc_likely (tree
, enum br_predictor
);
586 tree
gfc_unlikely (tree
, enum br_predictor
);
588 /* Return the string length of a deferred character length component. */
589 bool gfc_deferred_strlen (gfc_component
*, tree
*);
591 /* Generate a runtime error call. */
592 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
594 /* Generate a runtime warning/error check. */
595 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
598 /* Generate a runtime check for same string length. */
599 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
602 /* Generate a call to free() after checking that its arg is non-NULL. */
603 tree
gfc_call_free (tree
);
605 /* Allocate memory after performing a few checks. */
606 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
608 /* Build a memcpy call. */
609 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
611 /* Allocate memory for allocatable variables, with optional status variable. */
612 void gfc_allocate_allocatable (stmtblock_t
*, tree
, tree
, tree
, tree
,
613 tree
, tree
, tree
, gfc_expr
*);
615 /* Allocate memory, with optional status variable. */
616 void gfc_allocate_using_malloc (stmtblock_t
*, tree
, tree
, tree
);
618 /* Generate code to deallocate an array. */
619 tree
gfc_deallocate_with_status (tree
, tree
, tree
, tree
, tree
, bool,
621 tree
gfc_deallocate_scalar_with_status (tree
, tree
, bool, gfc_expr
*, gfc_typespec
);
623 /* Generate code to call realloc(). */
624 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
626 /* Generate code for an assignment, includes scalarization. */
627 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
629 /* Generate code for a pointer assignment. */
630 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
632 /* Initialize function decls for library functions. */
633 void gfc_build_intrinsic_lib_fndecls (void);
634 /* Create function decls for IO library functions. */
635 void gfc_build_io_library_fndecls (void);
636 /* Build a function decl for a library function. */
637 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
638 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
639 tree rettype
, int nargs
, ...);
641 /* Process the local variable decls of a block construct. */
642 void gfc_process_block_locals (gfc_namespace
*);
644 /* Output initialization/clean-up code that was deferred. */
645 void gfc_trans_deferred_vars (gfc_symbol
*, gfc_wrapped_block
*);
648 tree
pushdecl (tree
);
649 tree
pushdecl_top_level (tree
);
650 void pushlevel (void);
651 tree
poplevel (int, int);
652 tree
getdecls (void);
654 /* In trans-types.c. */
655 struct array_descr_info
;
656 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
658 /* In trans-openmp.c */
659 bool gfc_omp_privatize_by_reference (const_tree
);
660 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
661 tree
gfc_omp_report_decl (tree
);
662 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
663 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
664 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
665 tree
gfc_omp_clause_dtor (tree
, tree
);
666 bool gfc_omp_disregard_value_expr (tree
, bool);
667 bool gfc_omp_private_debug_clause (tree
, bool);
668 bool gfc_omp_private_outer_ref (tree
);
669 struct gimplify_omp_ctx
;
670 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
672 /* Runtime library function decls. */
673 extern GTY(()) tree gfor_fndecl_pause_numeric
;
674 extern GTY(()) tree gfor_fndecl_pause_string
;
675 extern GTY(()) tree gfor_fndecl_stop_numeric
;
676 extern GTY(()) tree gfor_fndecl_stop_numeric_f08
;
677 extern GTY(()) tree gfor_fndecl_stop_string
;
678 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
679 extern GTY(()) tree gfor_fndecl_error_stop_string
;
680 extern GTY(()) tree gfor_fndecl_runtime_error
;
681 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
682 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
683 extern GTY(()) tree gfor_fndecl_os_error
;
684 extern GTY(()) tree gfor_fndecl_generate_error
;
685 extern GTY(()) tree gfor_fndecl_set_fpe
;
686 extern GTY(()) tree gfor_fndecl_set_options
;
687 extern GTY(()) tree gfor_fndecl_ttynam
;
688 extern GTY(()) tree gfor_fndecl_ctime
;
689 extern GTY(()) tree gfor_fndecl_fdate
;
690 extern GTY(()) tree gfor_fndecl_in_pack
;
691 extern GTY(()) tree gfor_fndecl_in_unpack
;
692 extern GTY(()) tree gfor_fndecl_associated
;
695 /* Coarray run-time library function decls. */
696 extern GTY(()) tree gfor_fndecl_caf_init
;
697 extern GTY(()) tree gfor_fndecl_caf_finalize
;
698 extern GTY(()) tree gfor_fndecl_caf_register
;
699 extern GTY(()) tree gfor_fndecl_caf_deregister
;
700 extern GTY(()) tree gfor_fndecl_caf_critical
;
701 extern GTY(()) tree gfor_fndecl_caf_end_critical
;
702 extern GTY(()) tree gfor_fndecl_caf_sync_all
;
703 extern GTY(()) tree gfor_fndecl_caf_sync_images
;
704 extern GTY(()) tree gfor_fndecl_caf_error_stop
;
705 extern GTY(()) tree gfor_fndecl_caf_error_stop_str
;
707 /* Coarray global variables for num_images/this_image. */
708 extern GTY(()) tree gfort_gvar_caf_num_images
;
709 extern GTY(()) tree gfort_gvar_caf_this_image
;
712 /* Math functions. Many other math functions are handled in
713 trans-intrinsic.c. */
715 typedef struct GTY(()) gfc_powdecl_list
{
722 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
723 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
724 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
725 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
727 /* BLAS functions. */
728 extern GTY(()) tree gfor_fndecl_sgemm
;
729 extern GTY(()) tree gfor_fndecl_dgemm
;
730 extern GTY(()) tree gfor_fndecl_cgemm
;
731 extern GTY(()) tree gfor_fndecl_zgemm
;
733 /* String functions. */
734 extern GTY(()) tree gfor_fndecl_compare_string
;
735 extern GTY(()) tree gfor_fndecl_concat_string
;
736 extern GTY(()) tree gfor_fndecl_string_len_trim
;
737 extern GTY(()) tree gfor_fndecl_string_index
;
738 extern GTY(()) tree gfor_fndecl_string_scan
;
739 extern GTY(()) tree gfor_fndecl_string_verify
;
740 extern GTY(()) tree gfor_fndecl_string_trim
;
741 extern GTY(()) tree gfor_fndecl_string_minmax
;
742 extern GTY(()) tree gfor_fndecl_adjustl
;
743 extern GTY(()) tree gfor_fndecl_adjustr
;
744 extern GTY(()) tree gfor_fndecl_select_string
;
745 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
746 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
747 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
748 extern GTY(()) tree gfor_fndecl_string_index_char4
;
749 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
750 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
751 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
752 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
753 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
754 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
755 extern GTY(()) tree gfor_fndecl_select_string_char4
;
757 /* Conversion between character kinds. */
758 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
759 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
761 /* Other misc. runtime library functions. */
762 extern GTY(()) tree gfor_fndecl_size0
;
763 extern GTY(()) tree gfor_fndecl_size1
;
764 extern GTY(()) tree gfor_fndecl_iargc
;
766 /* Implemented in Fortran. */
767 extern GTY(()) tree gfor_fndecl_sc_kind
;
768 extern GTY(()) tree gfor_fndecl_si_kind
;
769 extern GTY(()) tree gfor_fndecl_sr_kind
;
772 /* True if node is an integer constant. */
773 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
775 /* gfortran-specific declaration information, the _CONT versions denote
776 arrays with CONTIGUOUS attribute. */
781 GFC_ARRAY_ASSUMED_SHAPE
,
782 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
783 GFC_ARRAY_ASSUMED_RANK
,
784 GFC_ARRAY_ASSUMED_RANK_CONT
,
785 GFC_ARRAY_ALLOCATABLE
,
787 GFC_ARRAY_POINTER_CONT
790 /* Array types only. */
791 /* FIXME: the variable_size annotation here is needed because these types are
792 variable-sized in some other frontends. Due to gengtype deficiency the GTY
793 options of such types have to agree across all frontends. */
794 struct GTY((variable_size
)) lang_type
{
796 enum gfc_array_kind akind
;
797 tree lbound
[GFC_MAX_DIMENSIONS
];
798 tree ubound
[GFC_MAX_DIMENSIONS
];
799 tree stride
[GFC_MAX_DIMENSIONS
];
806 tree nonrestricted_type
;
811 struct GTY((variable_size
)) lang_decl
{
812 /* Dummy variables. */
813 tree saved_descriptor
;
814 /* Assigned integer nodes. Stringlength is the IO format string's length.
815 Addr is the address of the string or the target label. Stringlength is
816 initialized to -2 and assigned to -1 when addr is assigned to the
817 address of target label. */
821 /* For assumed-shape coarrays. */
822 tree token
, caf_offset
;
826 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
827 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
828 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
829 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
830 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
831 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
832 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
833 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
834 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
835 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
836 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
837 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
838 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
839 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
840 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
842 /* An array descriptor. */
843 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
844 /* An array without a descriptor. */
845 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
846 /* Fortran POINTER type. */
847 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
848 /* Fortran CLASS type. */
849 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
850 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
851 descriptorless array types. */
852 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
853 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
854 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
855 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
856 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
857 (TYPE_LANG_SPECIFIC(node)->stride[dim])
858 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
859 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
860 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
861 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
862 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
863 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
864 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
865 /* Code should use gfc_get_dtype instead of accessing this directly. It may
866 not be known when the type is created. */
867 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
868 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
869 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
870 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
871 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
872 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
875 /* Build an expression with void type. */
876 #define build1_v(code, arg) \
877 fold_build1_loc (input_location, code, void_type_node, arg)
878 #define build2_v(code, arg1, arg2) \
879 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
880 #define build3_v(code, arg1, arg2, arg3) \
881 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
882 #define build4_v(code, arg1, arg2, arg3, arg4) \
883 build4_loc (input_location, code, void_type_node, arg1, arg2, \
886 /* This group of functions allows a caller to evaluate an expression from
887 the callee's interface. It establishes a mapping between the interface's
888 dummy arguments and the caller's actual arguments, then applies that
889 mapping to a given gfc_expr.
891 You can initialize a mapping structure like so:
893 gfc_interface_mapping mapping;
895 gfc_init_interface_mapping (&mapping);
897 You should then evaluate each actual argument into a temporary
898 gfc_se structure, here called "se", and map the result to the
899 dummy argument's symbol, here called "sym":
901 gfc_add_interface_mapping (&mapping, sym, &se);
903 After adding all mappings, you should call:
905 gfc_finish_interface_mapping (&mapping, pre, post);
907 where "pre" and "post" are statement blocks for initialization
908 and finalization code respectively. You can then evaluate an
909 interface expression "expr" as follows:
911 gfc_apply_interface_mapping (&mapping, se, expr);
913 Once you've evaluated all expressions, you should free
914 the mapping structure with:
916 gfc_free_interface_mapping (&mapping); */
919 /* This structure represents a mapping from OLD to NEW, where OLD is a
920 dummy argument symbol and NEW is a symbol that represents the value
921 of an actual argument. Mappings are linked together using NEXT
922 (in no particular order). */
923 typedef struct gfc_interface_sym_mapping
925 struct gfc_interface_sym_mapping
*next
;
927 gfc_symtree
*new_sym
;
930 gfc_interface_sym_mapping
;
933 /* This structure is used by callers to evaluate an expression from
934 a callee's interface. */
935 typedef struct gfc_interface_mapping
937 /* Maps the interface's dummy arguments to the values that the caller
938 is passing. The whole list is owned by this gfc_interface_mapping. */
939 gfc_interface_sym_mapping
*syms
;
941 /* A list of gfc_charlens that were needed when creating copies of
942 expressions. The whole list is owned by this gfc_interface_mapping. */
943 gfc_charlen
*charlens
;
945 gfc_interface_mapping
;
947 void gfc_init_interface_mapping (gfc_interface_mapping
*);
948 void gfc_free_interface_mapping (gfc_interface_mapping
*);
949 void gfc_add_interface_mapping (gfc_interface_mapping
*,
950 gfc_symbol
*, gfc_se
*, gfc_expr
*);
951 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
952 stmtblock_t
*, stmtblock_t
*);
953 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
954 gfc_se
*, gfc_expr
*);
957 /* Standard error messages used in all the trans-*.c files. */
958 extern const char gfc_msg_fault
[];
959 extern const char gfc_msg_wrong_return
[];
961 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
962 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
963 construct is not workshared. */
964 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
965 to create parallel loops. */
966 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
967 extern int ompws_flags
;
969 #endif /* GFC_TRANS_H */