1 /* Header for code translation functions
2 Copyright (C) 2002-2013 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 /* Mangled symbols take the form __module__name. */
25 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
27 /* Struct for holding a block of statements. It should be treated as an
28 opaque entity and not modified directly. This allows us to change the
29 underlying representation of statement lists. */
33 unsigned int has_scope
:1;
37 /* a simplified expression */
40 /* Code blocks to be executed before and after using the value. */
44 /* the result of the expression */
47 /* The length of a character string value. */
50 /* If set gfc_conv_variable will return an expression for the array
51 descriptor. When set, want_pointer should also be set.
52 If not set scalarizing variables will be substituted. */
53 unsigned descriptor_only
:1;
55 /* When this is set gfc_conv_expr returns the address of a variable. Only
56 applies to EXPR_VARIABLE nodes.
57 Also used by gfc_conv_array_parameter. When set this indicates a pointer
58 to the descriptor should be returned, rather than the descriptor itself.
60 unsigned want_pointer
:1;
62 /* An array function call returning without a temporary. Also used for array
63 pointer assignments. */
64 unsigned direct_byref
:1;
66 /* If direct_byref is set, do work out the descriptor as in that case but
67 do still create a new descriptor variable instead of using an
68 existing one. This is useful for special pointer assignments like
69 rank remapping where we have to process the descriptor before
70 assigning to final one. */
71 unsigned byref_noassign
:1;
73 /* Ignore absent optional arguments. Used for some intrinsics. */
74 unsigned ignore_optional
:1;
76 /* When this is set the data and offset fields of the returned descriptor
77 are NULL. Used by intrinsic size. */
78 unsigned data_not_needed
:1;
80 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
81 unsigned no_function_call
:1;
83 /* If set, we will force the creation of a temporary. Useful to disable
84 non-copying procedure argument passing optimizations, when some function
88 unsigned want_coarray
:1;
90 /* Scalarization parameters. */
91 struct gfc_se
*parent
;
93 struct gfc_loopinfo
*loop
;
98 /* Denotes different types of coarray.
99 Please keep in sync with libgfortran/caf/libcaf.h. */
102 GFC_CAF_COARRAY_STATIC
,
103 GFC_CAF_COARRAY_ALLOC
,
110 /* The array-specific scalarization information. The array members of
111 this struct are indexed by actual array index, and thus can be sparse. */
113 typedef struct gfc_array_info
117 /* The ref that holds information on this section. */
119 /* The descriptor of this array. */
121 /* holds the pointer to the data array. */
123 /* To move some of the array index calculation out of the innermost loop. */
127 /* Holds the SS for a subscript. Indexed by actual dimension. */
128 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
130 /* stride and delta are used to access this inside a scalarization loop.
131 start is used in the calculation of these. Indexed by scalarizer
133 tree start
[GFC_MAX_DIMENSIONS
];
134 tree end
[GFC_MAX_DIMENSIONS
];
135 tree stride
[GFC_MAX_DIMENSIONS
];
136 tree delta
[GFC_MAX_DIMENSIONS
];
142 /* A scalar value. This will be evaluated before entering the
143 scalarization loop. */
146 /* Like GFC_SS_SCALAR it evaluates the expression outside the
147 loop. Is always evaluated as a reference to the temporary, unless
148 temporary evaluation can result in a NULL pointer dereferencing (case of
149 optional arguments). Used for elemental function arguments. */
152 /* An array section. Scalarization indices will be substituted during
153 expression translation. */
156 /* A non-elemental function call returning an array. The call is executed
157 before entering the scalarization loop, storing the result in a
158 temporary. This temporary is then used inside the scalarization loop.
159 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
160 as a special case. */
163 /* An array constructor. The current implementation is sub-optimal in
164 many cases. It allocated a temporary, assigns the values to it, then
165 uses this temporary inside the scalarization loop. */
168 /* A vector subscript. The vector's descriptor is cached in the
169 "descriptor" field of the associated gfc_ss_info. */
172 /* A temporary array allocated by the scalarizer. Its rank can be less
173 than that of the assignment expression. */
176 /* An intrinsic function call. Many intrinsic functions which map directly
177 to library calls are created as GFC_SS_FUNCTION nodes. */
180 /* A component of a derived type. */
186 typedef struct gfc_ss_info
195 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
209 /* All other types. */
210 gfc_array_info array
;
214 /* This is used by assignments requiring temporaries. The bits specify which
215 loops the terms appear in. This will be 1 for the RHS expressions,
216 2 for the LHS expressions, and 3(=1|2) for the temporary. */
219 /* Suppresses precalculation of scalars in WHERE assignments. */
222 /* Tells whether the SS is for an actual argument which can be a NULL
223 reference. In other words, the associated dummy argument is OPTIONAL.
224 Used to handle elemental procedures. */
225 bool can_be_null_ref
;
229 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
232 /* Scalarization State chain. Created by walking an expression tree before
233 creating the scalarization loops. Then passed as part of a gfc_se structure
234 to translate the expression inside the loop. Note that these chains are
235 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
236 indicates to gfc_conv_* that this is a scalar expression.
237 SS structures can only belong to a single loopinfo. They must be added
238 otherwise they will not get freed. */
240 typedef struct gfc_ss
245 /* Translation from loop dimensions to actual array dimensions.
246 actual_dim = dim[loop_dim] */
247 int dim
[GFC_MAX_DIMENSIONS
];
249 /* All the SS in a loop and linked through loop_chain. The SS for an
250 expression are linked by the next pointer. */
251 struct gfc_ss
*loop_chain
;
254 /* Non-null if the ss is part of a nested loop. */
255 struct gfc_ss
*parent
;
257 /* If the evaluation of an expression requires a nested loop (for example
258 if the sum intrinsic is evaluated inline), this points to the nested
260 struct gfc_ss
*nested_ss
;
262 /* The loop this gfc_ss is in. */
263 struct gfc_loopinfo
*loop
;
265 unsigned is_alloc_lhs
:1;
268 #define gfc_get_ss() XCNEW (gfc_ss)
270 /* The contents of this aren't actually used. A NULL SS chain indicates a
271 scalar expression, so this pointer is used to terminate SS chains. */
272 extern gfc_ss
* const gfc_ss_terminator
;
274 /* Holds information about an expression while it is being scalarized. */
275 typedef struct gfc_loopinfo
282 /* All the SS involved with this loop. */
284 /* The SS describing the temporary used in an assignment. */
287 /* Non-null if this loop is nested in another one. */
288 struct gfc_loopinfo
*parent
;
290 /* Chain of nested loops. */
291 struct gfc_loopinfo
*nested
, *next
;
293 /* The scalarization loop index variables. */
294 tree loopvar
[GFC_MAX_DIMENSIONS
];
296 /* The bounds of the scalarization loops. */
297 tree from
[GFC_MAX_DIMENSIONS
];
298 tree to
[GFC_MAX_DIMENSIONS
];
299 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
301 /* The code member contains the code for the body of the next outer loop. */
302 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
304 /* Order in which the dimensions should be looped, innermost first. */
305 int order
[GFC_MAX_DIMENSIONS
];
307 /* Enum to control loop reversal. */
308 gfc_reverse reverse
[GFC_MAX_DIMENSIONS
];
310 /* The number of dimensions for which a temporary is used. */
313 /* If set we don't need the loop variables. */
314 unsigned array_parameter
:1;
318 #define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
320 /* Information about a symbol that has been shadowed by a temporary. */
323 symbol_attribute attr
;
329 /* Store information about a block of code together with special
330 initialization and clean-up code. This can be used to incrementally add
331 init and cleanup, and in the end put everything together to a
332 try-finally expression. */
341 /* Class API functions. */
342 tree
gfc_class_data_get (tree
);
343 tree
gfc_class_vptr_get (tree
);
344 void gfc_reset_vptr (stmtblock_t
*, gfc_expr
*);
345 tree
gfc_class_set_static_fields (tree
, tree
, tree
);
346 tree
gfc_vtable_hash_get (tree
);
347 tree
gfc_vtable_size_get (tree
);
348 tree
gfc_vtable_extends_get (tree
);
349 tree
gfc_vtable_def_init_get (tree
);
350 tree
gfc_vtable_copy_get (tree
);
351 tree
gfc_vtable_final_get (tree
);
352 tree
gfc_get_vptr_from_expr (tree
);
353 tree
gfc_get_class_array_ref (tree
, tree
);
354 tree
gfc_copy_class_to_class (tree
, tree
, tree
);
355 bool gfc_add_finalizer_call (stmtblock_t
*, gfc_expr
*);
356 void gfc_conv_derived_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, tree
, bool,
358 void gfc_conv_class_to_class (gfc_se
*, gfc_expr
*, gfc_typespec
, bool, bool,
361 /* Initialize an init/cleanup block. */
362 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
363 /* Add a pair of init/cleanup code to the block. Each one might be a
364 NULL_TREE if not required. */
365 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
366 /* Finalize the block, that is, create a single expression encapsulating the
367 original code together with init and clean-up code. */
368 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
371 /* Advance the SS chain to the next term. */
372 void gfc_advance_se_ss_chain (gfc_se
*);
374 /* Call this to initialize a gfc_se structure before use
375 first parameter is structure to initialize, second is
376 parent to get scalarization data from, or NULL. */
377 void gfc_init_se (gfc_se
*, gfc_se
*);
379 /* Create an artificial variable decl and add it to the current scope. */
380 tree
gfc_create_var (tree
, const char *);
381 /* Like above but doesn't add it to the current scope. */
382 tree
gfc_create_var_np (tree
, const char *);
384 /* Store the result of an expression in a temp variable so it can be used
385 repeatedly even if the original changes */
386 void gfc_make_safe_expr (gfc_se
* se
);
388 /* Makes sure se is suitable for passing as a function string parameter. */
389 void gfc_conv_string_parameter (gfc_se
* se
);
391 /* Compare two strings. */
392 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
394 /* When using the gfc_conv_* make sure you understand what they do, i.e.
395 when a POST chain may be created, and what the returned expression may be
396 used for. Note that character strings have special handling. This
397 should not be a problem as most statements/operations only deal with
398 numeric/logical types. See the implementations in trans-expr.c
399 for details of the individual functions. */
401 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
402 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
403 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
404 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
405 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
407 tree
gfc_conv_scalar_to_descriptor (gfc_se
*, tree
, symbol_attribute
);
411 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
412 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
414 /* Find the decl containing the auxiliary variables for assigned variables. */
415 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
416 /* If the value is not constant, Create a temporary and copy the value. */
417 tree
gfc_evaluate_now_loc (location_t
, tree
, stmtblock_t
*);
418 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
420 /* Find the appropriate variant of a math intrinsic. */
421 tree
gfc_builtin_decl_for_float_kind (enum built_in_function
, int);
423 /* Intrinsic procedure handling. */
424 tree
gfc_conv_intrinsic_subroutine (gfc_code
*);
425 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
427 /* Does an intrinsic map directly to an external library call
428 This is true for array-returning intrinsics, unless
429 gfc_inline_intrinsic_function_p returns true. */
430 int gfc_is_intrinsic_libcall (gfc_expr
*);
432 /* Used to call ordinary functions/subroutines
433 and procedure pointer components. */
434 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
435 gfc_expr
*, vec
<tree
, va_gc
> *);
437 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
439 /* Generate code for a scalar assignment. */
440 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
443 /* Translate COMMON blocks. */
444 void gfc_trans_common (gfc_namespace
*);
446 /* Translate a derived type constructor. */
447 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
449 /* Return an expression which determines if a dummy parameter is present. */
450 tree
gfc_conv_expr_present (gfc_symbol
*);
451 /* Convert a missing, dummy argument into a null or zero. */
452 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
454 /* Generate code to allocate a string temporary. */
455 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
456 /* Get the string length variable belonging to an expression. */
457 tree
gfc_get_expr_charlen (gfc_expr
*);
458 /* Initialize a string length variable. */
459 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
460 /* Ensure type sizes can be gimplified. */
461 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
463 /* Add an expression to the end of a block. */
464 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
465 /* Add an expression to the beginning of a block. */
466 void gfc_prepend_expr_to_block (stmtblock_t
*, tree
);
467 /* Add a block to the end of a block. */
468 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
469 /* Add a MODIFY_EXPR to a block. */
470 void gfc_add_modify_loc (location_t
, stmtblock_t
*, tree
, tree
);
471 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
473 /* Initialize a statement block. */
474 void gfc_init_block (stmtblock_t
*);
475 /* Start a new statement block. Like gfc_init_block but also starts a new
477 void gfc_start_block (stmtblock_t
*);
478 /* Finish a statement block. Also closes the scope if the block was created
479 with gfc_start_block. */
480 tree
gfc_finish_block (stmtblock_t
*);
481 /* Merge the scope of a block with its parent. */
482 void gfc_merge_block_scope (stmtblock_t
* block
);
484 /* Return the backend label decl. */
485 tree
gfc_get_label_decl (gfc_st_label
*);
487 /* Return the decl for an external function. */
488 tree
gfc_get_extern_function_decl (gfc_symbol
*);
490 /* Return the decl for a function. */
491 tree
gfc_get_function_decl (gfc_symbol
*);
493 /* Build an ADDR_EXPR. */
494 tree
gfc_build_addr_expr (tree
, tree
);
496 /* Build an ARRAY_REF. */
497 tree
gfc_build_array_ref (tree
, tree
, tree
);
499 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
500 tree
gfc_build_label_decl (tree
);
502 /* Return the decl used to hold the function return value.
503 Do not use if the function has an explicit result variable. */
504 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
506 /* Add a decl to the binding level for the current function. */
507 void gfc_add_decl_to_function (tree
);
509 /* Make prototypes for runtime library functions. */
510 void gfc_build_builtin_function_decls (void);
512 /* Set the backend source location of a decl. */
513 void gfc_set_decl_location (tree
, locus
*);
515 /* Get a module symbol backend_decl if possible. */
516 bool gfc_get_module_backend_decl (gfc_symbol
*);
518 /* Return the variable decl for a symbol. */
519 tree
gfc_get_symbol_decl (gfc_symbol
*);
521 /* Build a static initializer. */
522 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool, bool);
524 /* Assign a default initializer to a derived type. */
525 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
527 /* Substitute a temporary variable in place of the real one. */
528 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
530 /* Restore the original variable. */
531 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
533 /* Setting a decl assembler name, mangling it according to target rules
534 (like Windows @NN decorations). */
535 void gfc_set_decl_assembler_name (tree
, tree
);
537 /* Returns true if a variable of specified size should go on the stack. */
538 int gfc_can_put_var_on_stack (tree
);
540 /* Allocate the lang-specific part of a decl node. */
541 void gfc_allocate_lang_decl (tree
);
543 /* Advance along a TREE_CHAIN. */
544 tree
gfc_advance_chain (tree
, int);
546 /* Create a decl for a function. */
547 void gfc_create_function_decl (gfc_namespace
*, bool);
548 /* Generate the code for a function. */
549 void gfc_generate_function_code (gfc_namespace
*);
550 /* Output a BLOCK DATA program unit. */
551 void gfc_generate_block_data (gfc_namespace
*);
552 /* Output a decl for a module variable. */
553 void gfc_generate_module_vars (gfc_namespace
*);
554 /* Get the appropriate return statement for a procedure. */
555 tree
gfc_generate_return (void);
557 struct GTY(()) module_htab_entry
{
560 htab_t
GTY ((param_is (union tree_node
))) decls
;
563 struct module_htab_entry
*gfc_find_module (const char *);
564 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
566 /* Get and set the current location. */
567 void gfc_save_backend_locus (locus
*);
568 void gfc_set_backend_locus (locus
*);
569 void gfc_restore_backend_locus (locus
*);
571 /* Handle static constructor functions. */
572 extern GTY(()) tree gfc_static_ctors
;
573 void gfc_generate_constructors (void);
575 /* Get the string length of an array constructor. */
576 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
578 /* Mark a condition as likely or unlikely. */
579 tree
gfc_likely (tree
);
580 tree
gfc_unlikely (tree
);
582 /* Generate a runtime error call. */
583 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
585 /* Generate a runtime warning/error check. */
586 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
589 /* Generate a runtime check for same string length. */
590 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
593 /* Generate a call to free() after checking that its arg is non-NULL. */
594 tree
gfc_call_free (tree
);
596 /* Allocate memory after performing a few checks. */
597 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
599 /* Build a memcpy call. */
600 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
602 /* Allocate memory for allocatable variables, with optional status variable. */
603 void gfc_allocate_allocatable (stmtblock_t
*, tree
, tree
, tree
, tree
,
604 tree
, tree
, tree
, gfc_expr
*);
606 /* Allocate memory, with optional status variable. */
607 void gfc_allocate_using_malloc (stmtblock_t
*, tree
, tree
, tree
);
609 /* Generate code to deallocate an array. */
610 tree
gfc_deallocate_with_status (tree
, tree
, tree
, tree
, tree
, bool,
612 tree
gfc_deallocate_scalar_with_status (tree
, tree
, bool, gfc_expr
*, gfc_typespec
);
614 /* Generate code to call realloc(). */
615 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
617 /* Generate code for an assignment, includes scalarization. */
618 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
620 /* Generate code for a pointer assignment. */
621 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
623 /* Initialize function decls for library functions. */
624 void gfc_build_intrinsic_lib_fndecls (void);
625 /* Create function decls for IO library functions. */
626 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
627 void gfc_build_io_library_fndecls (void);
628 /* Build a function decl for a library function. */
629 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
630 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
631 tree rettype
, int nargs
, ...);
633 /* Process the local variable decls of a block construct. */
634 void gfc_process_block_locals (gfc_namespace
*);
636 /* Output initialization/clean-up code that was deferred. */
637 void gfc_trans_deferred_vars (gfc_symbol
*, gfc_wrapped_block
*);
640 tree
pushdecl (tree
);
641 tree
pushdecl_top_level (tree
);
642 void pushlevel (void);
643 tree
poplevel (int, int);
644 tree
getdecls (void);
646 /* In trans-types.c. */
647 struct array_descr_info
;
648 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
650 /* In trans-openmp.c */
651 bool gfc_omp_privatize_by_reference (const_tree
);
652 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
653 tree
gfc_omp_report_decl (tree
);
654 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
655 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
656 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
657 tree
gfc_omp_clause_dtor (tree
, tree
);
658 bool gfc_omp_disregard_value_expr (tree
, bool);
659 bool gfc_omp_private_debug_clause (tree
, bool);
660 bool gfc_omp_private_outer_ref (tree
);
661 struct gimplify_omp_ctx
;
662 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
664 /* Runtime library function decls. */
665 extern GTY(()) tree gfor_fndecl_pause_numeric
;
666 extern GTY(()) tree gfor_fndecl_pause_string
;
667 extern GTY(()) tree gfor_fndecl_stop_numeric
;
668 extern GTY(()) tree gfor_fndecl_stop_numeric_f08
;
669 extern GTY(()) tree gfor_fndecl_stop_string
;
670 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
671 extern GTY(()) tree gfor_fndecl_error_stop_string
;
672 extern GTY(()) tree gfor_fndecl_runtime_error
;
673 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
674 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
675 extern GTY(()) tree gfor_fndecl_os_error
;
676 extern GTY(()) tree gfor_fndecl_generate_error
;
677 extern GTY(()) tree gfor_fndecl_set_fpe
;
678 extern GTY(()) tree gfor_fndecl_set_options
;
679 extern GTY(()) tree gfor_fndecl_ttynam
;
680 extern GTY(()) tree gfor_fndecl_ctime
;
681 extern GTY(()) tree gfor_fndecl_fdate
;
682 extern GTY(()) tree gfor_fndecl_in_pack
;
683 extern GTY(()) tree gfor_fndecl_in_unpack
;
684 extern GTY(()) tree gfor_fndecl_associated
;
687 /* Coarray run-time library function decls. */
688 extern GTY(()) tree gfor_fndecl_caf_init
;
689 extern GTY(()) tree gfor_fndecl_caf_finalize
;
690 extern GTY(()) tree gfor_fndecl_caf_register
;
691 extern GTY(()) tree gfor_fndecl_caf_deregister
;
692 extern GTY(()) tree gfor_fndecl_caf_critical
;
693 extern GTY(()) tree gfor_fndecl_caf_end_critical
;
694 extern GTY(()) tree gfor_fndecl_caf_sync_all
;
695 extern GTY(()) tree gfor_fndecl_caf_sync_images
;
696 extern GTY(()) tree gfor_fndecl_caf_error_stop
;
697 extern GTY(()) tree gfor_fndecl_caf_error_stop_str
;
699 /* Coarray global variables for num_images/this_image. */
700 extern GTY(()) tree gfort_gvar_caf_num_images
;
701 extern GTY(()) tree gfort_gvar_caf_this_image
;
704 /* Math functions. Many other math functions are handled in
705 trans-intrinsic.c. */
707 typedef struct GTY(()) gfc_powdecl_list
{
714 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
715 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
716 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
717 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
719 /* BLAS functions. */
720 extern GTY(()) tree gfor_fndecl_sgemm
;
721 extern GTY(()) tree gfor_fndecl_dgemm
;
722 extern GTY(()) tree gfor_fndecl_cgemm
;
723 extern GTY(()) tree gfor_fndecl_zgemm
;
725 /* String functions. */
726 extern GTY(()) tree gfor_fndecl_compare_string
;
727 extern GTY(()) tree gfor_fndecl_concat_string
;
728 extern GTY(()) tree gfor_fndecl_string_len_trim
;
729 extern GTY(()) tree gfor_fndecl_string_index
;
730 extern GTY(()) tree gfor_fndecl_string_scan
;
731 extern GTY(()) tree gfor_fndecl_string_verify
;
732 extern GTY(()) tree gfor_fndecl_string_trim
;
733 extern GTY(()) tree gfor_fndecl_string_minmax
;
734 extern GTY(()) tree gfor_fndecl_adjustl
;
735 extern GTY(()) tree gfor_fndecl_adjustr
;
736 extern GTY(()) tree gfor_fndecl_select_string
;
737 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
738 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
739 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
740 extern GTY(()) tree gfor_fndecl_string_index_char4
;
741 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
742 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
743 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
744 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
745 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
746 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
747 extern GTY(()) tree gfor_fndecl_select_string_char4
;
749 /* Conversion between character kinds. */
750 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
751 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
753 /* Other misc. runtime library functions. */
754 extern GTY(()) tree gfor_fndecl_size0
;
755 extern GTY(()) tree gfor_fndecl_size1
;
756 extern GTY(()) tree gfor_fndecl_iargc
;
758 /* Implemented in Fortran. */
759 extern GTY(()) tree gfor_fndecl_sc_kind
;
760 extern GTY(()) tree gfor_fndecl_si_kind
;
761 extern GTY(()) tree gfor_fndecl_sr_kind
;
764 /* True if node is an integer constant. */
765 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
767 /* gfortran-specific declaration information, the _CONT versions denote
768 arrays with CONTIGUOUS attribute. */
773 GFC_ARRAY_ASSUMED_SHAPE
,
774 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
775 GFC_ARRAY_ASSUMED_RANK
,
776 GFC_ARRAY_ASSUMED_RANK_CONT
,
777 GFC_ARRAY_ALLOCATABLE
,
779 GFC_ARRAY_POINTER_CONT
782 /* Array types only. */
783 /* FIXME: the variable_size annotation here is needed because these types are
784 variable-sized in some other frontends. Due to gengtype deficiency the GTY
785 options of such types have to agree across all frontends. */
786 struct GTY((variable_size
)) lang_type
{
788 enum gfc_array_kind akind
;
789 tree lbound
[GFC_MAX_DIMENSIONS
];
790 tree ubound
[GFC_MAX_DIMENSIONS
];
791 tree stride
[GFC_MAX_DIMENSIONS
];
798 tree nonrestricted_type
;
803 struct GTY((variable_size
)) lang_decl
{
804 /* Dummy variables. */
805 tree saved_descriptor
;
806 /* Assigned integer nodes. Stringlength is the IO format string's length.
807 Addr is the address of the string or the target label. Stringlength is
808 initialized to -2 and assigned to -1 when addr is assigned to the
809 address of target label. */
813 /* For assumed-shape coarrays. */
814 tree token
, caf_offset
;
818 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
819 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
820 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
821 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
822 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
823 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
824 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
825 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
826 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
827 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
828 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
829 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
830 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
831 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
832 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
834 /* An array descriptor. */
835 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
836 /* An array without a descriptor. */
837 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
838 /* Fortran POINTER type. */
839 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
840 /* Fortran CLASS type. */
841 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
842 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
843 descriptorless array types. */
844 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
845 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
846 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
847 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
848 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
849 (TYPE_LANG_SPECIFIC(node)->stride[dim])
850 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
851 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
852 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
853 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
854 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
855 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
856 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
857 /* Code should use gfc_get_dtype instead of accessing this directly. It may
858 not be known when the type is created. */
859 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
860 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
861 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
862 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
863 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
864 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
867 /* Build an expression with void type. */
868 #define build1_v(code, arg) \
869 fold_build1_loc (input_location, code, void_type_node, arg)
870 #define build2_v(code, arg1, arg2) \
871 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
872 #define build3_v(code, arg1, arg2, arg3) \
873 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
874 #define build4_v(code, arg1, arg2, arg3, arg4) \
875 build4_loc (input_location, code, void_type_node, arg1, arg2, \
878 /* This group of functions allows a caller to evaluate an expression from
879 the callee's interface. It establishes a mapping between the interface's
880 dummy arguments and the caller's actual arguments, then applies that
881 mapping to a given gfc_expr.
883 You can initialize a mapping structure like so:
885 gfc_interface_mapping mapping;
887 gfc_init_interface_mapping (&mapping);
889 You should then evaluate each actual argument into a temporary
890 gfc_se structure, here called "se", and map the result to the
891 dummy argument's symbol, here called "sym":
893 gfc_add_interface_mapping (&mapping, sym, &se);
895 After adding all mappings, you should call:
897 gfc_finish_interface_mapping (&mapping, pre, post);
899 where "pre" and "post" are statement blocks for initialization
900 and finalization code respectively. You can then evaluate an
901 interface expression "expr" as follows:
903 gfc_apply_interface_mapping (&mapping, se, expr);
905 Once you've evaluated all expressions, you should free
906 the mapping structure with:
908 gfc_free_interface_mapping (&mapping); */
911 /* This structure represents a mapping from OLD to NEW, where OLD is a
912 dummy argument symbol and NEW is a symbol that represents the value
913 of an actual argument. Mappings are linked together using NEXT
914 (in no particular order). */
915 typedef struct gfc_interface_sym_mapping
917 struct gfc_interface_sym_mapping
*next
;
919 gfc_symtree
*new_sym
;
922 gfc_interface_sym_mapping
;
925 /* This structure is used by callers to evaluate an expression from
926 a callee's interface. */
927 typedef struct gfc_interface_mapping
929 /* Maps the interface's dummy arguments to the values that the caller
930 is passing. The whole list is owned by this gfc_interface_mapping. */
931 gfc_interface_sym_mapping
*syms
;
933 /* A list of gfc_charlens that were needed when creating copies of
934 expressions. The whole list is owned by this gfc_interface_mapping. */
935 gfc_charlen
*charlens
;
937 gfc_interface_mapping
;
939 void gfc_init_interface_mapping (gfc_interface_mapping
*);
940 void gfc_free_interface_mapping (gfc_interface_mapping
*);
941 void gfc_add_interface_mapping (gfc_interface_mapping
*,
942 gfc_symbol
*, gfc_se
*, gfc_expr
*);
943 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
944 stmtblock_t
*, stmtblock_t
*);
945 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
946 gfc_se
*, gfc_expr
*);
949 /* Standard error messages used in all the trans-*.c files. */
950 extern const char gfc_msg_fault
[];
951 extern const char gfc_msg_wrong_return
[];
953 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
954 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
955 construct is not workshared. */
956 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
957 to create parallel loops. */
958 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
959 extern int ompws_flags
;
961 #endif /* GFC_TRANS_H */