1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
3 Free Software Foundation, Inc.
4 Contributed by Paul Brook
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
25 /* Mangled symbols take the form __module__name. */
26 #define GFC_MAX_MANGLED_SYMBOL_LEN (GFC_MAX_SYMBOL_LEN*2+4)
28 /* Struct for holding a block of statements. It should be treated as an
29 opaque entity and not modified directly. This allows us to change the
30 underlying representation of statement lists. */
34 unsigned int has_scope
:1;
38 /* a simplified expression */
41 /* Code blocks to be executed before and after using the value. */
45 /* the result of the expression */
48 /* The length of a character string value. */
51 /* If set gfc_conv_variable will return an expression for the array
52 descriptor. When set, want_pointer should also be set.
53 If not set scalarizing variables will be substituted. */
54 unsigned descriptor_only
:1;
56 /* When this is set gfc_conv_expr returns the address of a variable. Only
57 applies to EXPR_VARIABLE nodes.
58 Also used by gfc_conv_array_parameter. When set this indicates a pointer
59 to the descriptor should be returned, rather than the descriptor itself.
61 unsigned want_pointer
:1;
63 /* An array function call returning without a temporary. Also used for array
64 pointer assignments. */
65 unsigned direct_byref
:1;
67 /* If direct_byref is set, do work out the descriptor as in that case but
68 do still create a new descriptor variable instead of using an
69 existing one. This is useful for special pointer assignments like
70 rank remapping where we have to process the descriptor before
71 assigning to final one. */
72 unsigned byref_noassign
:1;
74 /* Ignore absent optional arguments. Used for some intrinsics. */
75 unsigned ignore_optional
:1;
77 /* When this is set the data and offset fields of the returned descriptor
78 are NULL. Used by intrinsic size. */
79 unsigned data_not_needed
:1;
81 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
82 unsigned no_function_call
:1;
84 /* If set, we will force the creation of a temporary. Useful to disable
85 non-copying procedure argument passing optimizations, when some function
89 unsigned want_coarray
:1;
91 /* Scalarization parameters. */
92 struct gfc_se
*parent
;
94 struct gfc_loopinfo
*loop
;
99 /* Denotes different types of coarray.
100 Please keep in sync with libgfortran/caf/libcaf.h. */
103 GFC_CAF_COARRAY_STATIC
,
104 GFC_CAF_COARRAY_ALLOC
,
111 /* The array-specific scalarization informations. The array members of
112 this struct are indexed by actual array index, and thus can be sparse. */
114 typedef struct gfc_array_info
118 /* The ref that holds information on this section. */
120 /* The descriptor of this array. */
122 /* holds the pointer to the data array. */
124 /* To move some of the array index calculation out of the innermost loop. */
128 /* Holds the SS for a subscript. Indexed by actual dimension. */
129 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
131 /* stride and delta are used to access this inside a scalarization loop.
132 start is used in the calculation of these. Indexed by scalarizer
134 tree start
[GFC_MAX_DIMENSIONS
];
135 tree end
[GFC_MAX_DIMENSIONS
];
136 tree stride
[GFC_MAX_DIMENSIONS
];
137 tree delta
[GFC_MAX_DIMENSIONS
];
143 /* A scalar value. This will be evaluated before entering the
144 scalarization loop. */
147 /* Like GFC_SS_SCALAR it evaluates the expression outside the
148 loop. Is always evaluated as a reference to the temporary.
149 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. */
224 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
227 /* Scalarization State chain. Created by walking an expression tree before
228 creating the scalarization loops. Then passed as part of a gfc_se structure
229 to translate the expression inside the loop. Note that these chains are
230 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
231 indicates to gfc_conv_* that this is a scalar expression.
232 SS structures can only belong to a single loopinfo. They must be added
233 otherwise they will not get freed. */
235 typedef struct gfc_ss
240 /* Translation from loop dimensions to actual array dimensions.
241 actual_dim = dim[loop_dim] */
242 int dim
[GFC_MAX_DIMENSIONS
];
244 /* All the SS in a loop and linked through loop_chain. The SS for an
245 expression are linked by the next pointer. */
246 struct gfc_ss
*loop_chain
;
249 unsigned is_alloc_lhs
:1;
252 #define gfc_get_ss() XCNEW (gfc_ss)
254 /* The contents of this aren't actually used. A NULL SS chain indicates a
255 scalar expression, so this pointer is used to terminate SS chains. */
256 extern gfc_ss
* const gfc_ss_terminator
;
258 /* Holds information about an expression while it is being scalarized. */
259 typedef struct gfc_loopinfo
266 /* All the SS involved with this loop. */
268 /* The SS describing the temporary used in an assignment. */
271 /* The scalarization loop index variables. */
272 tree loopvar
[GFC_MAX_DIMENSIONS
];
274 /* The bounds of the scalarization loops. */
275 tree from
[GFC_MAX_DIMENSIONS
];
276 tree to
[GFC_MAX_DIMENSIONS
];
277 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
279 /* The code member contains the code for the body of the next outer loop. */
280 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
282 /* Order in which the dimensions should be looped, innermost first. */
283 int order
[GFC_MAX_DIMENSIONS
];
285 /* Enum to control loop reversal. */
286 gfc_reverse reverse
[GFC_MAX_DIMENSIONS
];
288 /* The number of dimensions for which a temporary is used. */
291 /* If set we don't need the loop variables. */
292 unsigned array_parameter
:1;
297 /* Information about a symbol that has been shadowed by a temporary. */
300 symbol_attribute attr
;
306 /* Store information about a block of code together with special
307 initialization and clean-up code. This can be used to incrementally add
308 init and cleanup, and in the end put everything together to a
309 try-finally expression. */
319 /* Initialize an init/cleanup block. */
320 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
321 /* Add a pair of init/cleanup code to the block. Each one might be a
322 NULL_TREE if not required. */
323 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
324 /* Finalize the block, that is, create a single expression encapsulating the
325 original code together with init and clean-up code. */
326 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
329 /* Advance the SS chain to the next term. */
330 void gfc_advance_se_ss_chain (gfc_se
*);
332 /* Call this to initialize a gfc_se structure before use
333 first parameter is structure to initialize, second is
334 parent to get scalarization data from, or NULL. */
335 void gfc_init_se (gfc_se
*, gfc_se
*);
337 /* Create an artificial variable decl and add it to the current scope. */
338 tree
gfc_create_var (tree
, const char *);
339 /* Like above but doesn't add it to the current scope. */
340 tree
gfc_create_var_np (tree
, const char *);
342 /* Store the result of an expression in a temp variable so it can be used
343 repeatedly even if the original changes */
344 void gfc_make_safe_expr (gfc_se
* se
);
346 /* Makes sure se is suitable for passing as a function string parameter. */
347 void gfc_conv_string_parameter (gfc_se
* se
);
349 /* Compare two strings. */
350 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
352 /* When using the gfc_conv_* make sure you understand what they do, i.e.
353 when a POST chain may be created, and what the returned expression may be
354 used for. Note that character strings have special handling. This
355 should not be a problem as most statements/operations only deal with
356 numeric/logical types. See the implementations in trans-expr.c
357 for details of the individual functions. */
359 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
360 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
361 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
362 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
363 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
366 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
367 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
369 /* Find the decl containing the auxiliary variables for assigned variables. */
370 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
371 /* If the value is not constant, Create a temporary and copy the value. */
372 tree
gfc_evaluate_now_loc (location_t
, tree
, stmtblock_t
*);
373 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
375 /* Find the appropriate variant of a math intrinsic. */
376 tree
gfc_builtin_decl_for_float_kind (enum built_in_function
, int);
378 /* Intrinsic procedure handling. */
379 tree
gfc_conv_intrinsic_subroutine (gfc_code
*);
380 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
382 /* Is the intrinsic expanded inline. */
383 bool gfc_inline_intrinsic_function_p (gfc_expr
*);
385 /* Does an intrinsic map directly to an external library call
386 This is true for array-returning intrinsics, unless
387 gfc_inline_intrinsic_function_p returns true. */
388 int gfc_is_intrinsic_libcall (gfc_expr
*);
390 /* Used to call ordinary functions/subroutines
391 and procedure pointer components. */
392 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
393 gfc_expr
*, VEC(tree
,gc
) *);
395 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
397 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
399 /* Generate code for a scalar assignment. */
400 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
403 /* Translate COMMON blocks. */
404 void gfc_trans_common (gfc_namespace
*);
406 /* Translate a derived type constructor. */
407 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
409 /* Return an expression which determines if a dummy parameter is present. */
410 tree
gfc_conv_expr_present (gfc_symbol
*);
411 /* Convert a missing, dummy argument into a null or zero. */
412 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
414 /* Generate code to allocate a string temporary. */
415 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
416 /* Get the string length variable belonging to an expression. */
417 tree
gfc_get_expr_charlen (gfc_expr
*);
418 /* Initialize a string length variable. */
419 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
420 /* Ensure type sizes can be gimplified. */
421 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
423 /* Add an expression to the end of a block. */
424 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
425 /* Add an expression to the beginning of a block. */
426 void gfc_prepend_expr_to_block (stmtblock_t
*, tree
);
427 /* Add a block to the end of a block. */
428 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
429 /* Add a MODIFY_EXPR to a block. */
430 void gfc_add_modify_loc (location_t
, stmtblock_t
*, tree
, tree
);
431 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
433 /* Initialize a statement block. */
434 void gfc_init_block (stmtblock_t
*);
435 /* Start a new statement block. Like gfc_init_block but also starts a new
437 void gfc_start_block (stmtblock_t
*);
438 /* Finish a statement block. Also closes the scope if the block was created
439 with gfc_start_block. */
440 tree
gfc_finish_block (stmtblock_t
*);
441 /* Merge the scope of a block with its parent. */
442 void gfc_merge_block_scope (stmtblock_t
* block
);
444 /* Return the backend label decl. */
445 tree
gfc_get_label_decl (gfc_st_label
*);
447 /* Return the decl for an external function. */
448 tree
gfc_get_extern_function_decl (gfc_symbol
*);
450 /* Return the decl for a function. */
451 tree
gfc_get_function_decl (gfc_symbol
*);
453 /* Build an ADDR_EXPR. */
454 tree
gfc_build_addr_expr (tree
, tree
);
456 /* Build an ARRAY_REF. */
457 tree
gfc_build_array_ref (tree
, tree
, tree
);
459 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
460 tree
gfc_build_label_decl (tree
);
462 /* Return the decl used to hold the function return value.
463 Do not use if the function has an explicit result variable. */
464 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
466 /* Add a decl to the binding level for the current function. */
467 void gfc_add_decl_to_function (tree
);
469 /* Make prototypes for runtime library functions. */
470 void gfc_build_builtin_function_decls (void);
472 /* Set the backend source location of a decl. */
473 void gfc_set_decl_location (tree
, locus
*);
475 /* Get a module symbol backend_decl if possible. */
476 bool gfc_get_module_backend_decl (gfc_symbol
*);
478 /* Return the variable decl for a symbol. */
479 tree
gfc_get_symbol_decl (gfc_symbol
*);
481 /* Build a static initializer. */
482 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool, bool);
484 /* Assign a default initializer to a derived type. */
485 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
487 /* Substitute a temporary variable in place of the real one. */
488 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
490 /* Restore the original variable. */
491 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
493 /* Setting a decl assembler name, mangling it according to target rules
494 (like Windows @NN decorations). */
495 void gfc_set_decl_assembler_name (tree
, tree
);
497 /* Returns true if a variable of specified size should go on the stack. */
498 int gfc_can_put_var_on_stack (tree
);
500 /* Allocate the lang-specific part of a decl node. */
501 void gfc_allocate_lang_decl (tree
);
503 /* Advance along a TREE_CHAIN. */
504 tree
gfc_advance_chain (tree
, int);
506 /* Create a decl for a function. */
507 void gfc_create_function_decl (gfc_namespace
*, bool);
508 /* Generate the code for a function. */
509 void gfc_generate_function_code (gfc_namespace
*);
510 /* Output a BLOCK DATA program unit. */
511 void gfc_generate_block_data (gfc_namespace
*);
512 /* Output a decl for a module variable. */
513 void gfc_generate_module_vars (gfc_namespace
*);
514 /* Get the appropriate return statement for a procedure. */
515 tree
gfc_generate_return (void);
517 struct GTY(()) module_htab_entry
{
520 htab_t
GTY ((param_is (union tree_node
))) decls
;
523 struct module_htab_entry
*gfc_find_module (const char *);
524 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
526 /* Get and set the current location. */
527 void gfc_save_backend_locus (locus
*);
528 void gfc_set_backend_locus (locus
*);
529 void gfc_restore_backend_locus (locus
*);
531 /* Handle static constructor functions. */
532 extern GTY(()) tree gfc_static_ctors
;
533 void gfc_generate_constructors (void);
535 /* Get the string length of an array constructor. */
536 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
538 /* Mark a condition as likely or unlikely. */
539 tree
gfc_likely (tree
);
540 tree
gfc_unlikely (tree
);
542 /* Generate a runtime error call. */
543 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
545 /* Generate a runtime warning/error check. */
546 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
549 /* Generate a runtime check for same string length. */
550 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
553 /* Generate a call to free() after checking that its arg is non-NULL. */
554 tree
gfc_call_free (tree
);
556 /* Allocate memory after performing a few checks. */
557 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
559 /* Build a memcpy call. */
560 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
562 /* Allocate memory for allocatable variables, with optional status variable. */
563 void gfc_allocate_allocatable (stmtblock_t
*, tree
, tree
, tree
,
564 tree
, tree
, tree
, gfc_expr
*);
566 /* Allocate memory, with optional status variable. */
567 void gfc_allocate_using_malloc (stmtblock_t
*, tree
, tree
, tree
);
569 /* Generate code to deallocate an array. */
570 tree
gfc_deallocate_with_status (tree
, tree
, bool, gfc_expr
*);
571 tree
gfc_deallocate_scalar_with_status (tree
, tree
, bool, gfc_expr
*, gfc_typespec
);
573 /* Generate code to call realloc(). */
574 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
576 /* Generate code for an assignment, includes scalarization. */
577 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
579 /* Generate code for a pointer assignment. */
580 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
582 /* Initialize function decls for library functions. */
583 void gfc_build_intrinsic_lib_fndecls (void);
584 /* Create function decls for IO library functions. */
585 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
586 void gfc_build_io_library_fndecls (void);
587 /* Build a function decl for a library function. */
588 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
589 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
590 tree rettype
, int nargs
, ...);
592 /* Process the local variable decls of a block construct. */
593 void gfc_process_block_locals (gfc_namespace
*);
595 /* Output initialization/clean-up code that was deferred. */
596 void gfc_trans_deferred_vars (gfc_symbol
*, gfc_wrapped_block
*);
599 tree
pushdecl (tree
);
600 tree
pushdecl_top_level (tree
);
601 void pushlevel (int);
602 tree
poplevel (int, int, int);
603 tree
getdecls (void);
604 tree
gfc_truthvalue_conversion (tree
);
605 tree
gfc_builtin_function (tree
);
607 /* In trans-types.c. */
608 struct array_descr_info
;
609 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
611 /* In trans-openmp.c */
612 bool gfc_omp_privatize_by_reference (const_tree
);
613 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
614 tree
gfc_omp_report_decl (tree
);
615 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
616 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
617 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
618 tree
gfc_omp_clause_dtor (tree
, tree
);
619 bool gfc_omp_disregard_value_expr (tree
, bool);
620 bool gfc_omp_private_debug_clause (tree
, bool);
621 bool gfc_omp_private_outer_ref (tree
);
622 struct gimplify_omp_ctx
;
623 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
625 /* Runtime library function decls. */
626 extern GTY(()) tree gfor_fndecl_pause_numeric
;
627 extern GTY(()) tree gfor_fndecl_pause_string
;
628 extern GTY(()) tree gfor_fndecl_stop_numeric
;
629 extern GTY(()) tree gfor_fndecl_stop_numeric_f08
;
630 extern GTY(()) tree gfor_fndecl_stop_string
;
631 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
632 extern GTY(()) tree gfor_fndecl_error_stop_string
;
633 extern GTY(()) tree gfor_fndecl_runtime_error
;
634 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
635 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
636 extern GTY(()) tree gfor_fndecl_os_error
;
637 extern GTY(()) tree gfor_fndecl_generate_error
;
638 extern GTY(()) tree gfor_fndecl_set_fpe
;
639 extern GTY(()) tree gfor_fndecl_set_options
;
640 extern GTY(()) tree gfor_fndecl_ttynam
;
641 extern GTY(()) tree gfor_fndecl_ctime
;
642 extern GTY(()) tree gfor_fndecl_fdate
;
643 extern GTY(()) tree gfor_fndecl_in_pack
;
644 extern GTY(()) tree gfor_fndecl_in_unpack
;
645 extern GTY(()) tree gfor_fndecl_associated
;
648 /* Coarray run-time library function decls. */
649 extern GTY(()) tree gfor_fndecl_caf_init
;
650 extern GTY(()) tree gfor_fndecl_caf_finalize
;
651 extern GTY(()) tree gfor_fndecl_caf_register
;
652 extern GTY(()) tree gfor_fndecl_caf_critical
;
653 extern GTY(()) tree gfor_fndecl_caf_end_critical
;
654 extern GTY(()) tree gfor_fndecl_caf_sync_all
;
655 extern GTY(()) tree gfor_fndecl_caf_sync_images
;
656 extern GTY(()) tree gfor_fndecl_caf_error_stop
;
657 extern GTY(()) tree gfor_fndecl_caf_error_stop_str
;
659 /* Coarray global variables for num_images/this_image. */
660 extern GTY(()) tree gfort_gvar_caf_num_images
;
661 extern GTY(()) tree gfort_gvar_caf_this_image
;
664 /* Math functions. Many other math functions are handled in
665 trans-intrinsic.c. */
667 typedef struct GTY(()) gfc_powdecl_list
{
674 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
675 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
676 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
677 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
679 /* BLAS functions. */
680 extern GTY(()) tree gfor_fndecl_sgemm
;
681 extern GTY(()) tree gfor_fndecl_dgemm
;
682 extern GTY(()) tree gfor_fndecl_cgemm
;
683 extern GTY(()) tree gfor_fndecl_zgemm
;
685 /* String functions. */
686 extern GTY(()) tree gfor_fndecl_compare_string
;
687 extern GTY(()) tree gfor_fndecl_concat_string
;
688 extern GTY(()) tree gfor_fndecl_string_len_trim
;
689 extern GTY(()) tree gfor_fndecl_string_index
;
690 extern GTY(()) tree gfor_fndecl_string_scan
;
691 extern GTY(()) tree gfor_fndecl_string_verify
;
692 extern GTY(()) tree gfor_fndecl_string_trim
;
693 extern GTY(()) tree gfor_fndecl_string_minmax
;
694 extern GTY(()) tree gfor_fndecl_adjustl
;
695 extern GTY(()) tree gfor_fndecl_adjustr
;
696 extern GTY(()) tree gfor_fndecl_select_string
;
697 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
698 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
699 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
700 extern GTY(()) tree gfor_fndecl_string_index_char4
;
701 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
702 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
703 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
704 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
705 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
706 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
707 extern GTY(()) tree gfor_fndecl_select_string_char4
;
709 /* Conversion between character kinds. */
710 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
711 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
713 /* Other misc. runtime library functions. */
714 extern GTY(()) tree gfor_fndecl_size0
;
715 extern GTY(()) tree gfor_fndecl_size1
;
716 extern GTY(()) tree gfor_fndecl_iargc
;
718 /* Implemented in Fortran. */
719 extern GTY(()) tree gfor_fndecl_sc_kind
;
720 extern GTY(()) tree gfor_fndecl_si_kind
;
721 extern GTY(()) tree gfor_fndecl_sr_kind
;
724 /* True if node is an integer constant. */
725 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
727 /* gfortran-specific declaration information, the _CONT versions denote
728 arrays with CONTIGUOUS attribute. */
733 GFC_ARRAY_ASSUMED_SHAPE
,
734 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
735 GFC_ARRAY_ALLOCATABLE
,
737 GFC_ARRAY_POINTER_CONT
740 /* Array types only. */
741 /* FIXME: the variable_size annotation here is needed because these types are
742 variable-sized in some other frontends. Due to gengtype deficiency the GTY
743 options of such types have to agree across all frontends. */
744 struct GTY((variable_size
)) lang_type
{
746 enum gfc_array_kind akind
;
747 tree lbound
[GFC_MAX_DIMENSIONS
];
748 tree ubound
[GFC_MAX_DIMENSIONS
];
749 tree stride
[GFC_MAX_DIMENSIONS
];
756 tree nonrestricted_type
;
761 struct GTY((variable_size
)) lang_decl
{
762 /* Dummy variables. */
763 tree saved_descriptor
;
764 /* Assigned integer nodes. Stringlength is the IO format string's length.
765 Addr is the address of the string or the target label. Stringlength is
766 initialized to -2 and assigned to -1 when addr is assigned to the
767 address of target label. */
771 /* For assumed-shape coarrays. */
772 tree token
, caf_offset
;
776 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
777 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
778 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
779 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
780 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
781 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
782 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
783 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
784 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
785 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
786 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
787 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
788 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
789 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
791 /* An array descriptor. */
792 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
793 /* An array without a descriptor. */
794 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
795 /* Fortran POINTER type. */
796 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
797 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
798 descriptorless array types. */
799 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
800 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
801 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
802 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
803 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
804 (TYPE_LANG_SPECIFIC(node)->stride[dim])
805 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
806 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
807 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
808 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
809 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
810 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
811 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
812 /* Code should use gfc_get_dtype instead of accessing this directly. It may
813 not be known when the type is created. */
814 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
815 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
816 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
817 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
818 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
819 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
822 /* Build an expression with void type. */
823 #define build1_v(code, arg) \
824 fold_build1_loc (input_location, code, void_type_node, arg)
825 #define build2_v(code, arg1, arg2) \
826 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
827 #define build3_v(code, arg1, arg2, arg3) \
828 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
829 #define build4_v(code, arg1, arg2, arg3, arg4) \
830 build4_loc (input_location, code, void_type_node, arg1, arg2, \
833 /* This group of functions allows a caller to evaluate an expression from
834 the callee's interface. It establishes a mapping between the interface's
835 dummy arguments and the caller's actual arguments, then applies that
836 mapping to a given gfc_expr.
838 You can initialize a mapping structure like so:
840 gfc_interface_mapping mapping;
842 gfc_init_interface_mapping (&mapping);
844 You should then evaluate each actual argument into a temporary
845 gfc_se structure, here called "se", and map the result to the
846 dummy argument's symbol, here called "sym":
848 gfc_add_interface_mapping (&mapping, sym, &se);
850 After adding all mappings, you should call:
852 gfc_finish_interface_mapping (&mapping, pre, post);
854 where "pre" and "post" are statement blocks for initialization
855 and finalization code respectively. You can then evaluate an
856 interface expression "expr" as follows:
858 gfc_apply_interface_mapping (&mapping, se, expr);
860 Once you've evaluated all expressions, you should free
861 the mapping structure with:
863 gfc_free_interface_mapping (&mapping); */
866 /* This structure represents a mapping from OLD to NEW, where OLD is a
867 dummy argument symbol and NEW is a symbol that represents the value
868 of an actual argument. Mappings are linked together using NEXT
869 (in no particular order). */
870 typedef struct gfc_interface_sym_mapping
872 struct gfc_interface_sym_mapping
*next
;
874 gfc_symtree
*new_sym
;
877 gfc_interface_sym_mapping
;
880 /* This structure is used by callers to evaluate an expression from
881 a callee's interface. */
882 typedef struct gfc_interface_mapping
884 /* Maps the interface's dummy arguments to the values that the caller
885 is passing. The whole list is owned by this gfc_interface_mapping. */
886 gfc_interface_sym_mapping
*syms
;
888 /* A list of gfc_charlens that were needed when creating copies of
889 expressions. The whole list is owned by this gfc_interface_mapping. */
890 gfc_charlen
*charlens
;
892 gfc_interface_mapping
;
894 void gfc_init_interface_mapping (gfc_interface_mapping
*);
895 void gfc_free_interface_mapping (gfc_interface_mapping
*);
896 void gfc_add_interface_mapping (gfc_interface_mapping
*,
897 gfc_symbol
*, gfc_se
*, gfc_expr
*);
898 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
899 stmtblock_t
*, stmtblock_t
*);
900 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
901 gfc_se
*, gfc_expr
*);
904 /* Standard error messages used in all the trans-*.c files. */
905 extern const char gfc_msg_fault
[];
906 extern const char gfc_msg_wrong_return
[];
908 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
909 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
910 construct is not workshared. */
911 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
912 to create parallel loops. */
913 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
914 extern int ompws_flags
;
916 #endif /* GFC_TRANS_H */