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 /* Scalarization State chain. Created by walking an expression tree before
112 creating the scalarization loops. Then passed as part of a gfc_se structure
113 to translate the expression inside the loop. Note that these chains are
114 terminated by gfc_se_terminator, not NULL. A NULL pointer in a gfc_se
115 indicates to gfc_conv_* that this is a scalar expression.
116 Note that some member arrays correspond to scalarizer rank and others
117 are the variable rank. */
119 typedef struct gfc_ss_info
122 /* The ref that holds information on this section. */
124 /* The descriptor of this array. */
126 /* holds the pointer to the data array. */
128 /* To move some of the array index calculation out of the innermost loop. */
132 /* Holds the SS for a subscript. Indexed by actual dimension. */
133 struct gfc_ss
*subscript
[GFC_MAX_DIMENSIONS
];
135 /* stride and delta are used to access this inside a scalarization loop.
136 start is used in the calculation of these. Indexed by scalarizer
138 tree start
[GFC_MAX_DIMENSIONS
];
139 tree end
[GFC_MAX_DIMENSIONS
];
140 tree stride
[GFC_MAX_DIMENSIONS
];
141 tree delta
[GFC_MAX_DIMENSIONS
];
143 /* Translation from loop dimensions to actual dimensions.
144 actual_dim = dim[loop_dim] */
145 int dim
[GFC_MAX_DIMENSIONS
];
151 /* A scalar value. This will be evaluated before entering the
152 scalarization loop. */
155 /* Like GFC_SS_SCALAR it evaluates the expression outside the
156 loop. Is always evaluated as a reference to the temporary.
157 Used for elemental function arguments. */
160 /* An array section. Scalarization indices will be substituted during
161 expression translation. */
164 /* A non-elemental function call returning an array. The call is executed
165 before entering the scalarization loop, storing the result in a
166 temporary. This temporary is then used inside the scalarization loop.
167 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
168 as a special case. */
171 /* An array constructor. The current implementation is sub-optimal in
172 many cases. It allocated a temporary, assigns the values to it, then
173 uses this temporary inside the scalarization loop. */
176 /* A vector subscript. The vector's descriptor is cached in the
177 "descriptor" field of the associated gfc_ss_info. */
180 /* A temporary array allocated by the scalarizer. Its rank can be less
181 than that of the assignment expression. */
184 /* An intrinsic function call. Many intrinsic functions which map directly
185 to library calls are created as GFC_SS_FUNCTION nodes. */
188 /* A component of a derived type. */
193 /* SS structures can only belong to a single loopinfo. They must be added
194 otherwise they will not get freed. */
195 typedef struct gfc_ss
203 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
213 /* The rank of the temporary. May be less than the rank of the
214 assigned expression. */
219 /* All other types. */
224 /* All the SS in a loop and linked through loop_chain. The SS for an
225 expression are linked by the next pointer. */
226 struct gfc_ss
*loop_chain
;
229 /* This is used by assignments requiring temporaries. The bits specify which
230 loops the terms appear in. This will be 1 for the RHS expressions,
231 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit
232 'where' suppresses precalculation of scalars in WHERE assignments. */
233 unsigned useflags
:2, where
:1, is_alloc_lhs
:1;
236 #define gfc_get_ss() XCNEW (gfc_ss)
238 /* The contents of this aren't actually used. A NULL SS chain indicates a
239 scalar expression, so this pointer is used to terminate SS chains. */
240 extern gfc_ss
* const gfc_ss_terminator
;
242 /* Holds information about an expression while it is being scalarized. */
243 typedef struct gfc_loopinfo
250 /* All the SS involved with this loop. */
252 /* The SS describing the temporary used in an assignment. */
255 /* The scalarization loop index variables. */
256 tree loopvar
[GFC_MAX_DIMENSIONS
];
258 /* The bounds of the scalarization loops. */
259 tree from
[GFC_MAX_DIMENSIONS
];
260 tree to
[GFC_MAX_DIMENSIONS
];
261 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
263 /* The code member contains the code for the body of the next outer loop. */
264 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
266 /* Order in which the dimensions should be looped, innermost first. */
267 int order
[GFC_MAX_DIMENSIONS
];
269 /* Enum to control loop reversal. */
270 gfc_reverse reverse
[GFC_MAX_DIMENSIONS
];
272 /* The number of dimensions for which a temporary is used. */
275 /* If set we don't need the loop variables. */
276 unsigned array_parameter
:1;
281 /* Information about a symbol that has been shadowed by a temporary. */
284 symbol_attribute attr
;
290 /* Store information about a block of code together with special
291 initialization and clean-up code. This can be used to incrementally add
292 init and cleanup, and in the end put everything together to a
293 try-finally expression. */
303 /* Initialize an init/cleanup block. */
304 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
305 /* Add a pair of init/cleanup code to the block. Each one might be a
306 NULL_TREE if not required. */
307 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
308 /* Finalize the block, that is, create a single expression encapsulating the
309 original code together with init and clean-up code. */
310 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
313 /* Advance the SS chain to the next term. */
314 void gfc_advance_se_ss_chain (gfc_se
*);
316 /* Call this to initialize a gfc_se structure before use
317 first parameter is structure to initialize, second is
318 parent to get scalarization data from, or NULL. */
319 void gfc_init_se (gfc_se
*, gfc_se
*);
321 /* Create an artificial variable decl and add it to the current scope. */
322 tree
gfc_create_var (tree
, const char *);
323 /* Like above but doesn't add it to the current scope. */
324 tree
gfc_create_var_np (tree
, const char *);
326 /* Store the result of an expression in a temp variable so it can be used
327 repeatedly even if the original changes */
328 void gfc_make_safe_expr (gfc_se
* se
);
330 /* Makes sure se is suitable for passing as a function string parameter. */
331 void gfc_conv_string_parameter (gfc_se
* se
);
333 /* Compare two strings. */
334 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
336 /* When using the gfc_conv_* make sure you understand what they do, i.e.
337 when a POST chain may be created, and what the returned expression may be
338 used for. Note that character strings have special handling. This
339 should not be a problem as most statements/operations only deal with
340 numeric/logical types. See the implementations in trans-expr.c
341 for details of the individual functions. */
343 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
344 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
345 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
346 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
347 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
350 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
351 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
353 /* Find the decl containing the auxiliary variables for assigned variables. */
354 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
355 /* If the value is not constant, Create a temporary and copy the value. */
356 tree
gfc_evaluate_now_loc (location_t
, tree
, stmtblock_t
*);
357 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
359 /* Find the appropriate variant of a math intrinsic. */
360 tree
gfc_builtin_decl_for_float_kind (enum built_in_function
, int);
362 /* Intrinsic procedure handling. */
363 tree
gfc_conv_intrinsic_subroutine (gfc_code
*);
364 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
366 /* Is the intrinsic expanded inline. */
367 bool gfc_inline_intrinsic_function_p (gfc_expr
*);
369 /* Does an intrinsic map directly to an external library call
370 This is true for array-returning intrinsics, unless
371 gfc_inline_intrinsic_function_p returns true. */
372 int gfc_is_intrinsic_libcall (gfc_expr
*);
374 /* Used to call ordinary functions/subroutines
375 and procedure pointer components. */
376 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
377 gfc_expr
*, VEC(tree
,gc
) *);
379 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
381 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
383 /* Generate code for a scalar assignment. */
384 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
387 /* Translate COMMON blocks. */
388 void gfc_trans_common (gfc_namespace
*);
390 /* Translate a derived type constructor. */
391 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
393 /* Return an expression which determines if a dummy parameter is present. */
394 tree
gfc_conv_expr_present (gfc_symbol
*);
395 /* Convert a missing, dummy argument into a null or zero. */
396 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
398 /* Generate code to allocate a string temporary. */
399 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
400 /* Get the string length variable belonging to an expression. */
401 tree
gfc_get_expr_charlen (gfc_expr
*);
402 /* Initialize a string length variable. */
403 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
404 /* Ensure type sizes can be gimplified. */
405 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
407 /* Add an expression to the end of a block. */
408 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
409 /* Add an expression to the beginning of a block. */
410 void gfc_prepend_expr_to_block (stmtblock_t
*, tree
);
411 /* Add a block to the end of a block. */
412 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
413 /* Add a MODIFY_EXPR to a block. */
414 void gfc_add_modify_loc (location_t
, stmtblock_t
*, tree
, tree
);
415 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
417 /* Initialize a statement block. */
418 void gfc_init_block (stmtblock_t
*);
419 /* Start a new statement block. Like gfc_init_block but also starts a new
421 void gfc_start_block (stmtblock_t
*);
422 /* Finish a statement block. Also closes the scope if the block was created
423 with gfc_start_block. */
424 tree
gfc_finish_block (stmtblock_t
*);
425 /* Merge the scope of a block with its parent. */
426 void gfc_merge_block_scope (stmtblock_t
* block
);
428 /* Return the backend label decl. */
429 tree
gfc_get_label_decl (gfc_st_label
*);
431 /* Return the decl for an external function. */
432 tree
gfc_get_extern_function_decl (gfc_symbol
*);
434 /* Return the decl for a function. */
435 tree
gfc_get_function_decl (gfc_symbol
*);
437 /* Build an ADDR_EXPR. */
438 tree
gfc_build_addr_expr (tree
, tree
);
440 /* Build an ARRAY_REF. */
441 tree
gfc_build_array_ref (tree
, tree
, tree
);
443 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
444 tree
gfc_build_label_decl (tree
);
446 /* Return the decl used to hold the function return value.
447 Do not use if the function has an explicit result variable. */
448 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
450 /* Add a decl to the binding level for the current function. */
451 void gfc_add_decl_to_function (tree
);
453 /* Make prototypes for runtime library functions. */
454 void gfc_build_builtin_function_decls (void);
456 /* Set the backend source location of a decl. */
457 void gfc_set_decl_location (tree
, locus
*);
459 /* Get a module symbol backend_decl if possible. */
460 bool gfc_get_module_backend_decl (gfc_symbol
*);
462 /* Return the variable decl for a symbol. */
463 tree
gfc_get_symbol_decl (gfc_symbol
*);
465 /* Build a static initializer. */
466 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool, bool);
468 /* Assign a default initializer to a derived type. */
469 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
471 /* Substitute a temporary variable in place of the real one. */
472 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
474 /* Restore the original variable. */
475 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
477 /* Setting a decl assembler name, mangling it according to target rules
478 (like Windows @NN decorations). */
479 void gfc_set_decl_assembler_name (tree
, tree
);
481 /* Returns true if a variable of specified size should go on the stack. */
482 int gfc_can_put_var_on_stack (tree
);
484 /* Allocate the lang-specific part of a decl node. */
485 void gfc_allocate_lang_decl (tree
);
487 /* Advance along a TREE_CHAIN. */
488 tree
gfc_advance_chain (tree
, int);
490 /* Create a decl for a function. */
491 void gfc_create_function_decl (gfc_namespace
*, bool);
492 /* Generate the code for a function. */
493 void gfc_generate_function_code (gfc_namespace
*);
494 /* Output a BLOCK DATA program unit. */
495 void gfc_generate_block_data (gfc_namespace
*);
496 /* Output a decl for a module variable. */
497 void gfc_generate_module_vars (gfc_namespace
*);
498 /* Get the appropriate return statement for a procedure. */
499 tree
gfc_generate_return (void);
501 struct GTY(()) module_htab_entry
{
504 htab_t
GTY ((param_is (union tree_node
))) decls
;
507 struct module_htab_entry
*gfc_find_module (const char *);
508 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
510 /* Get and set the current location. */
511 void gfc_save_backend_locus (locus
*);
512 void gfc_set_backend_locus (locus
*);
513 void gfc_restore_backend_locus (locus
*);
515 /* Handle static constructor functions. */
516 extern GTY(()) tree gfc_static_ctors
;
517 void gfc_generate_constructors (void);
519 /* Get the string length of an array constructor. */
520 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
522 /* Mark a condition as likely or unlikely. */
523 tree
gfc_likely (tree
);
524 tree
gfc_unlikely (tree
);
526 /* Generate a runtime error call. */
527 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
529 /* Generate a runtime warning/error check. */
530 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
533 /* Generate a runtime check for same string length. */
534 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
537 /* Generate a call to free() after checking that its arg is non-NULL. */
538 tree
gfc_call_free (tree
);
540 /* Allocate memory after performing a few checks. */
541 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
543 /* Build a memcpy call. */
544 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
546 /* Allocate memory for allocatable variables, with optional status variable. */
547 void gfc_allocate_allocatable (stmtblock_t
*, tree
, tree
, tree
,
548 tree
, tree
, tree
, gfc_expr
*);
550 /* Allocate memory, with optional status variable. */
551 void gfc_allocate_using_malloc (stmtblock_t
*, tree
, tree
, tree
);
553 /* Generate code to deallocate an array. */
554 tree
gfc_deallocate_with_status (tree
, tree
, bool, gfc_expr
*);
555 tree
gfc_deallocate_scalar_with_status (tree
, tree
, bool, gfc_expr
*, gfc_typespec
);
557 /* Generate code to call realloc(). */
558 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
560 /* Generate code for an assignment, includes scalarization. */
561 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
563 /* Generate code for a pointer assignment. */
564 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
566 /* Initialize function decls for library functions. */
567 void gfc_build_intrinsic_lib_fndecls (void);
568 /* Create function decls for IO library functions. */
569 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
570 void gfc_build_io_library_fndecls (void);
571 /* Build a function decl for a library function. */
572 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
573 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
574 tree rettype
, int nargs
, ...);
576 /* Process the local variable decls of a block construct. */
577 void gfc_process_block_locals (gfc_namespace
*);
579 /* Output initialization/clean-up code that was deferred. */
580 void gfc_trans_deferred_vars (gfc_symbol
*, gfc_wrapped_block
*);
583 tree
pushdecl (tree
);
584 tree
pushdecl_top_level (tree
);
585 void pushlevel (int);
586 tree
poplevel (int, int, int);
587 tree
getdecls (void);
588 tree
gfc_truthvalue_conversion (tree
);
589 tree
gfc_builtin_function (tree
);
591 /* In trans-types.c. */
592 struct array_descr_info
;
593 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
595 /* In trans-openmp.c */
596 bool gfc_omp_privatize_by_reference (const_tree
);
597 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
598 tree
gfc_omp_report_decl (tree
);
599 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
600 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
601 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
602 tree
gfc_omp_clause_dtor (tree
, tree
);
603 bool gfc_omp_disregard_value_expr (tree
, bool);
604 bool gfc_omp_private_debug_clause (tree
, bool);
605 bool gfc_omp_private_outer_ref (tree
);
606 struct gimplify_omp_ctx
;
607 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
609 /* Runtime library function decls. */
610 extern GTY(()) tree gfor_fndecl_pause_numeric
;
611 extern GTY(()) tree gfor_fndecl_pause_string
;
612 extern GTY(()) tree gfor_fndecl_stop_numeric
;
613 extern GTY(()) tree gfor_fndecl_stop_numeric_f08
;
614 extern GTY(()) tree gfor_fndecl_stop_string
;
615 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
616 extern GTY(()) tree gfor_fndecl_error_stop_string
;
617 extern GTY(()) tree gfor_fndecl_runtime_error
;
618 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
619 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
620 extern GTY(()) tree gfor_fndecl_os_error
;
621 extern GTY(()) tree gfor_fndecl_generate_error
;
622 extern GTY(()) tree gfor_fndecl_set_fpe
;
623 extern GTY(()) tree gfor_fndecl_set_options
;
624 extern GTY(()) tree gfor_fndecl_ttynam
;
625 extern GTY(()) tree gfor_fndecl_ctime
;
626 extern GTY(()) tree gfor_fndecl_fdate
;
627 extern GTY(()) tree gfor_fndecl_in_pack
;
628 extern GTY(()) tree gfor_fndecl_in_unpack
;
629 extern GTY(()) tree gfor_fndecl_associated
;
632 /* Coarray run-time library function decls. */
633 extern GTY(()) tree gfor_fndecl_caf_init
;
634 extern GTY(()) tree gfor_fndecl_caf_finalize
;
635 extern GTY(()) tree gfor_fndecl_caf_register
;
636 extern GTY(()) tree gfor_fndecl_caf_critical
;
637 extern GTY(()) tree gfor_fndecl_caf_end_critical
;
638 extern GTY(()) tree gfor_fndecl_caf_sync_all
;
639 extern GTY(()) tree gfor_fndecl_caf_sync_images
;
640 extern GTY(()) tree gfor_fndecl_caf_error_stop
;
641 extern GTY(()) tree gfor_fndecl_caf_error_stop_str
;
643 /* Coarray global variables for num_images/this_image. */
644 extern GTY(()) tree gfort_gvar_caf_num_images
;
645 extern GTY(()) tree gfort_gvar_caf_this_image
;
648 /* Math functions. Many other math functions are handled in
649 trans-intrinsic.c. */
651 typedef struct GTY(()) gfc_powdecl_list
{
658 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
659 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
660 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
661 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
663 /* BLAS functions. */
664 extern GTY(()) tree gfor_fndecl_sgemm
;
665 extern GTY(()) tree gfor_fndecl_dgemm
;
666 extern GTY(()) tree gfor_fndecl_cgemm
;
667 extern GTY(()) tree gfor_fndecl_zgemm
;
669 /* String functions. */
670 extern GTY(()) tree gfor_fndecl_compare_string
;
671 extern GTY(()) tree gfor_fndecl_concat_string
;
672 extern GTY(()) tree gfor_fndecl_string_len_trim
;
673 extern GTY(()) tree gfor_fndecl_string_index
;
674 extern GTY(()) tree gfor_fndecl_string_scan
;
675 extern GTY(()) tree gfor_fndecl_string_verify
;
676 extern GTY(()) tree gfor_fndecl_string_trim
;
677 extern GTY(()) tree gfor_fndecl_string_minmax
;
678 extern GTY(()) tree gfor_fndecl_adjustl
;
679 extern GTY(()) tree gfor_fndecl_adjustr
;
680 extern GTY(()) tree gfor_fndecl_select_string
;
681 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
682 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
683 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
684 extern GTY(()) tree gfor_fndecl_string_index_char4
;
685 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
686 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
687 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
688 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
689 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
690 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
691 extern GTY(()) tree gfor_fndecl_select_string_char4
;
693 /* Conversion between character kinds. */
694 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
695 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
697 /* Other misc. runtime library functions. */
698 extern GTY(()) tree gfor_fndecl_size0
;
699 extern GTY(()) tree gfor_fndecl_size1
;
700 extern GTY(()) tree gfor_fndecl_iargc
;
702 /* Implemented in Fortran. */
703 extern GTY(()) tree gfor_fndecl_sc_kind
;
704 extern GTY(()) tree gfor_fndecl_si_kind
;
705 extern GTY(()) tree gfor_fndecl_sr_kind
;
708 /* True if node is an integer constant. */
709 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
711 /* gfortran-specific declaration information, the _CONT versions denote
712 arrays with CONTIGUOUS attribute. */
717 GFC_ARRAY_ASSUMED_SHAPE
,
718 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
719 GFC_ARRAY_ALLOCATABLE
,
721 GFC_ARRAY_POINTER_CONT
724 /* Array types only. */
725 /* FIXME: the variable_size annotation here is needed because these types are
726 variable-sized in some other frontends. Due to gengtype deficiency the GTY
727 options of such types have to agree across all frontends. */
728 struct GTY((variable_size
)) lang_type
{
730 enum gfc_array_kind akind
;
731 tree lbound
[GFC_MAX_DIMENSIONS
];
732 tree ubound
[GFC_MAX_DIMENSIONS
];
733 tree stride
[GFC_MAX_DIMENSIONS
];
740 tree nonrestricted_type
;
745 struct GTY((variable_size
)) lang_decl
{
746 /* Dummy variables. */
747 tree saved_descriptor
;
748 /* Assigned integer nodes. Stringlength is the IO format string's length.
749 Addr is the address of the string or the target label. Stringlength is
750 initialized to -2 and assigned to -1 when addr is assigned to the
751 address of target label. */
755 /* For assumed-shape coarrays. */
756 tree token
, caf_offset
;
760 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
761 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
762 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
763 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
764 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
765 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
766 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
767 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
768 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
769 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
770 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
771 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
772 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
773 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
775 /* An array descriptor. */
776 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
777 /* An array without a descriptor. */
778 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
779 /* Fortran POINTER type. */
780 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
781 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
782 descriptorless array types. */
783 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
784 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
785 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
786 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
787 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
788 (TYPE_LANG_SPECIFIC(node)->stride[dim])
789 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
790 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
791 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
792 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
793 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
794 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
795 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
796 /* Code should use gfc_get_dtype instead of accessing this directly. It may
797 not be known when the type is created. */
798 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
799 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
800 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
801 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
802 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
803 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
806 /* Build an expression with void type. */
807 #define build1_v(code, arg) \
808 fold_build1_loc (input_location, code, void_type_node, arg)
809 #define build2_v(code, arg1, arg2) \
810 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
811 #define build3_v(code, arg1, arg2, arg3) \
812 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
813 #define build4_v(code, arg1, arg2, arg3, arg4) \
814 build4_loc (input_location, code, void_type_node, arg1, arg2, \
817 /* This group of functions allows a caller to evaluate an expression from
818 the callee's interface. It establishes a mapping between the interface's
819 dummy arguments and the caller's actual arguments, then applies that
820 mapping to a given gfc_expr.
822 You can initialize a mapping structure like so:
824 gfc_interface_mapping mapping;
826 gfc_init_interface_mapping (&mapping);
828 You should then evaluate each actual argument into a temporary
829 gfc_se structure, here called "se", and map the result to the
830 dummy argument's symbol, here called "sym":
832 gfc_add_interface_mapping (&mapping, sym, &se);
834 After adding all mappings, you should call:
836 gfc_finish_interface_mapping (&mapping, pre, post);
838 where "pre" and "post" are statement blocks for initialization
839 and finalization code respectively. You can then evaluate an
840 interface expression "expr" as follows:
842 gfc_apply_interface_mapping (&mapping, se, expr);
844 Once you've evaluated all expressions, you should free
845 the mapping structure with:
847 gfc_free_interface_mapping (&mapping); */
850 /* This structure represents a mapping from OLD to NEW, where OLD is a
851 dummy argument symbol and NEW is a symbol that represents the value
852 of an actual argument. Mappings are linked together using NEXT
853 (in no particular order). */
854 typedef struct gfc_interface_sym_mapping
856 struct gfc_interface_sym_mapping
*next
;
858 gfc_symtree
*new_sym
;
861 gfc_interface_sym_mapping
;
864 /* This structure is used by callers to evaluate an expression from
865 a callee's interface. */
866 typedef struct gfc_interface_mapping
868 /* Maps the interface's dummy arguments to the values that the caller
869 is passing. The whole list is owned by this gfc_interface_mapping. */
870 gfc_interface_sym_mapping
*syms
;
872 /* A list of gfc_charlens that were needed when creating copies of
873 expressions. The whole list is owned by this gfc_interface_mapping. */
874 gfc_charlen
*charlens
;
876 gfc_interface_mapping
;
878 void gfc_init_interface_mapping (gfc_interface_mapping
*);
879 void gfc_free_interface_mapping (gfc_interface_mapping
*);
880 void gfc_add_interface_mapping (gfc_interface_mapping
*,
881 gfc_symbol
*, gfc_se
*, gfc_expr
*);
882 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
883 stmtblock_t
*, stmtblock_t
*);
884 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
885 gfc_se
*, gfc_expr
*);
888 /* Standard error messages used in all the trans-*.c files. */
889 extern const char gfc_msg_fault
[];
890 extern const char gfc_msg_wrong_return
[];
892 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
893 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
894 construct is not workshared. */
895 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
896 to create parallel loops. */
897 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
898 extern int ompws_flags
;
900 #endif /* GFC_TRANS_H */