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
194 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
197 /* Scalarization State chain. Created by walking an expression tree before
198 creating the scalarization loops. Then passed as part of a gfc_se structure
199 to translate the expression inside the loop. Note that these chains are
200 terminated by gfc_ss_terminator, not NULL. A NULL pointer in a gfc_se
201 indicates to gfc_conv_* that this is a scalar expression.
202 SS structures can only belong to a single loopinfo. They must be added
203 otherwise they will not get freed. */
205 typedef struct gfc_ss
211 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
224 /* All other types. */
230 /* Translation from loop dimensions to actual array dimensions.
231 actual_dim = dim[loop_dim] */
232 int dim[GFC_MAX_DIMENSIONS];
234 /* All the SS in a loop and linked through loop_chain. The SS for an
235 expression are linked by the next pointer. */
236 struct gfc_ss *loop_chain;
239 /* This is used by assignments requiring temporaries. The bits specify which
240 loops the terms appear in. This will be 1 for the RHS expressions,
241 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit
242 'where' suppresses precalculation of scalars in WHERE assignments. */
243 unsigned useflags:2, where:1, is_alloc_lhs:1;
246 #define gfc_get_ss() XCNEW (gfc_ss)
248 /* The contents of this aren't actually used. A NULL SS chain indicates a
249 scalar expression, so this pointer is used to terminate SS chains. */
250 extern gfc_ss * const gfc_ss_terminator;
252 /* Holds information about an expression while it is being scalarized. */
253 typedef struct gfc_loopinfo
260 /* All the SS involved with this loop. */
262 /* The SS describing the temporary used in an assignment. */
265 /* The scalarization loop index variables. */
266 tree loopvar[GFC_MAX_DIMENSIONS];
268 /* The bounds of the scalarization loops. */
269 tree from[GFC_MAX_DIMENSIONS];
270 tree to[GFC_MAX_DIMENSIONS];
271 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
273 /* The code member contains the code for the body of the next outer loop. */
274 stmtblock_t code[GFC_MAX_DIMENSIONS];
276 /* Order in which the dimensions should be looped, innermost first. */
277 int order[GFC_MAX_DIMENSIONS];
279 /* Enum to control loop reversal. */
280 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
282 /* The number of dimensions for which a temporary is used. */
285 /* If set we don't need the loop variables. */
286 unsigned array_parameter:1;
291 /* Information about a symbol that has been shadowed by a temporary. */
294 symbol_attribute attr;
300 /* Store information about a block of code together with special
301 initialization and clean-up code. This can be used to incrementally add
302 init and cleanup, and in the end put everything together to a
303 try-finally expression. */
313 /* Initialize an init/cleanup block. */
314 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
315 /* Add a pair of init/cleanup code to the block. Each one might be a
316 NULL_TREE if not required. */
317 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
318 /* Finalize the block, that is, create a single expression encapsulating the
319 original code together with init and clean-up code. */
320 tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
323 /* Advance the SS chain to the next term. */
324 void gfc_advance_se_ss_chain (gfc_se *);
326 /* Call this to initialize a gfc_se structure before use
327 first parameter is structure to initialize, second is
328 parent to get scalarization data from, or NULL. */
329 void gfc_init_se (gfc_se *, gfc_se *);
331 /* Create an artificial variable decl and add it to the current scope. */
332 tree gfc_create_var (tree, const char *);
333 /* Like above but doesn't add it to the current scope. */
334 tree gfc_create_var_np (tree, const char *);
336 /* Store the result of an expression in a temp variable so it can be used
337 repeatedly even if the original changes */
338 void gfc_make_safe_expr (gfc_se * se);
340 /* Makes sure se is suitable for passing as a function string parameter. */
341 void gfc_conv_string_parameter (gfc_se * se);
343 /* Compare two strings. */
344 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
346 /* When using the gfc_conv_* make sure you understand what they do, i.e.
347 when a POST chain may be created, and what the returned expression may be
348 used for. Note that character strings have special handling. This
349 should not be a problem as most statements/operations only deal with
350 numeric/logical types. See the implementations in trans-expr.c
351 for details of the individual functions. */
353 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
354 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
355 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
356 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
357 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
360 void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
361 tree gfc_string_to_single_character (tree len, tree str, int kind);
363 /* Find the decl containing the auxiliary variables for assigned variables. */
364 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
365 /* If the value is not constant, Create a temporary and copy the value. */
366 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
367 tree gfc_evaluate_now (tree, stmtblock_t *);
369 /* Find the appropriate variant of a math intrinsic. */
370 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
372 /* Intrinsic procedure handling. */
373 tree gfc_conv_intrinsic_subroutine (gfc_code *);
374 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
376 /* Is the intrinsic expanded inline. */
377 bool gfc_inline_intrinsic_function_p (gfc_expr *);
379 /* Does an intrinsic map directly to an external library call
380 This is true for array-returning intrinsics, unless
381 gfc_inline_intrinsic_function_p returns true. */
382 int gfc_is_intrinsic_libcall (gfc_expr *);
384 /* Used to call ordinary functions/subroutines
385 and procedure pointer components. */
386 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
387 gfc_expr *, VEC(tree,gc) *);
389 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool);
391 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
393 /* Generate code for a scalar assignment. */
394 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
397 /* Translate COMMON blocks. */
398 void gfc_trans_common (gfc_namespace *);
400 /* Translate a derived type constructor. */
401 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
403 /* Return an expression which determines if a dummy parameter is present. */
404 tree gfc_conv_expr_present (gfc_symbol *);
405 /* Convert a missing, dummy argument into a null or zero. */
406 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
408 /* Generate code to allocate a string temporary. */
409 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
410 /* Get the string length variable belonging to an expression. */
411 tree gfc_get_expr_charlen (gfc_expr *);
412 /* Initialize a string length variable. */
413 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
414 /* Ensure type sizes can be gimplified. */
415 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
417 /* Add an expression to the end of a block. */
418 void gfc_add_expr_to_block (stmtblock_t *, tree);
419 /* Add an expression to the beginning of a block. */
420 void gfc_prepend_expr_to_block (stmtblock_t *, tree);
421 /* Add a block to the end of a block. */
422 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
423 /* Add a MODIFY_EXPR to a block. */
424 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
425 void gfc_add_modify (stmtblock_t *, tree, tree);
427 /* Initialize a statement block. */
428 void gfc_init_block (stmtblock_t *);
429 /* Start a new statement block. Like gfc_init_block but also starts a new
431 void gfc_start_block (stmtblock_t *);
432 /* Finish a statement block. Also closes the scope if the block was created
433 with gfc_start_block. */
434 tree gfc_finish_block (stmtblock_t *);
435 /* Merge the scope of a block with its parent. */
436 void gfc_merge_block_scope (stmtblock_t * block);
438 /* Return the backend label decl. */
439 tree gfc_get_label_decl (gfc_st_label *);
441 /* Return the decl for an external function. */
442 tree gfc_get_extern_function_decl (gfc_symbol *);
444 /* Return the decl for a function. */
445 tree gfc_get_function_decl (gfc_symbol *);
447 /* Build an ADDR_EXPR. */
448 tree gfc_build_addr_expr (tree, tree);
450 /* Build an ARRAY_REF. */
451 tree gfc_build_array_ref (tree, tree, tree);
453 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
454 tree gfc_build_label_decl (tree);
456 /* Return the decl used to hold the function return value.
457 Do not use if the function has an explicit result variable. */
458 tree gfc_get_fake_result_decl (gfc_symbol *, int);
460 /* Add a decl to the binding level for the current function. */
461 void gfc_add_decl_to_function (tree);
463 /* Make prototypes for runtime library functions. */
464 void gfc_build_builtin_function_decls (void);
466 /* Set the backend source location of a decl. */
467 void gfc_set_decl_location (tree, locus *);
469 /* Get a module symbol backend_decl if possible. */
470 bool gfc_get_module_backend_decl (gfc_symbol *);
472 /* Return the variable decl for a symbol. */
473 tree gfc_get_symbol_decl (gfc_symbol *);
475 /* Build a static initializer. */
476 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
478 /* Assign a default initializer to a derived type. */
479 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
481 /* Substitute a temporary variable in place of the real one. */
482 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
484 /* Restore the original variable. */
485 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
487 /* Setting a decl assembler name, mangling it according to target rules
488 (like Windows @NN decorations). */
489 void gfc_set_decl_assembler_name (tree, tree);
491 /* Returns true if a variable of specified size should go on the stack. */
492 int gfc_can_put_var_on_stack (tree);
494 /* Allocate the lang-specific part of a decl node. */
495 void gfc_allocate_lang_decl (tree);
497 /* Advance along a TREE_CHAIN. */
498 tree gfc_advance_chain (tree, int);
500 /* Create a decl for a function. */
501 void gfc_create_function_decl (gfc_namespace *, bool);
502 /* Generate the code for a function. */
503 void gfc_generate_function_code (gfc_namespace *);
504 /* Output a BLOCK DATA program unit. */
505 void gfc_generate_block_data (gfc_namespace *);
506 /* Output a decl for a module variable. */
507 void gfc_generate_module_vars (gfc_namespace *);
508 /* Get the appropriate return statement for a procedure. */
509 tree gfc_generate_return (void);
511 struct GTY(()) module_htab_entry {
514 htab_t GTY ((param_is (union tree_node))) decls;
517 struct module_htab_entry *gfc_find_module (const char *);
518 void gfc_module_add_decl (struct module_htab_entry *, tree);
520 /* Get and set the current location. */
521 void gfc_save_backend_locus (locus *);
522 void gfc_set_backend_locus (locus *);
523 void gfc_restore_backend_locus (locus *);
525 /* Handle static constructor functions. */
526 extern GTY(()) tree gfc_static_ctors;
527 void gfc_generate_constructors (void);
529 /* Get the string length of an array constructor. */
530 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
532 /* Mark a condition as likely or unlikely. */
533 tree gfc_likely (tree);
534 tree gfc_unlikely (tree);
536 /* Generate a runtime error call. */
537 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
539 /* Generate a runtime warning/error check. */
540 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
543 /* Generate a runtime check for same string length. */
544 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
547 /* Generate a call to free() after checking that its arg is non-NULL. */
548 tree gfc_call_free (tree);
550 /* Allocate memory after performing a few checks. */
551 tree gfc_call_malloc (stmtblock_t *, tree, tree);
553 /* Build a memcpy call. */
554 tree gfc_build_memcpy_call (tree, tree, tree);
556 /* Allocate memory for allocatable variables, with optional status variable. */
557 void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree,
558 tree, tree, tree, gfc_expr*);
560 /* Allocate memory, with optional status variable. */
561 void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
563 /* Generate code to deallocate an array. */
564 tree gfc_deallocate_with_status (tree, tree, bool, gfc_expr*);
565 tree gfc_deallocate_scalar_with_status (tree, tree, bool, gfc_expr*, gfc_typespec);
567 /* Generate code to call realloc(). */
568 tree gfc_call_realloc (stmtblock_t *, tree, tree);
570 /* Generate code for an assignment, includes scalarization. */
571 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool);
573 /* Generate code for a pointer assignment. */
574 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
576 /* Initialize function decls for library functions. */
577 void gfc_build_intrinsic_lib_fndecls (void);
578 /* Create function decls for IO library functions. */
579 void gfc_trans_io_runtime_check (tree, tree, int, const char *, stmtblock_t *);
580 void gfc_build_io_library_fndecls (void);
581 /* Build a function decl for a library function. */
582 tree gfc_build_library_function_decl (tree, tree, int, ...);
583 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
584 tree rettype, int nargs, ...);
586 /* Process the local variable decls of a block construct. */
587 void gfc_process_block_locals (gfc_namespace*);
589 /* Output initialization/clean-up code that was deferred. */
590 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
593 tree pushdecl (tree);
594 tree pushdecl_top_level (tree);
595 void pushlevel (int);
596 tree poplevel (int, int, int);
597 tree getdecls (void);
598 tree gfc_truthvalue_conversion (tree);
599 tree gfc_builtin_function (tree);
601 /* In trans-types.c. */
602 struct array_descr_info;
603 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
605 /* In trans-openmp.c */
606 bool gfc_omp_privatize_by_reference (const_tree);
607 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
608 tree gfc_omp_report_decl (tree);
609 tree gfc_omp_clause_default_ctor (tree, tree, tree);
610 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
611 tree gfc_omp_clause_assign_op (tree, tree, tree);
612 tree gfc_omp_clause_dtor (tree, tree);
613 bool gfc_omp_disregard_value_expr (tree, bool);
614 bool gfc_omp_private_debug_clause (tree, bool);
615 bool gfc_omp_private_outer_ref (tree);
616 struct gimplify_omp_ctx;
617 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
619 /* Runtime library function decls. */
620 extern GTY(()) tree gfor_fndecl_pause_numeric;
621 extern GTY(()) tree gfor_fndecl_pause_string;
622 extern GTY(()) tree gfor_fndecl_stop_numeric;
623 extern GTY(()) tree gfor_fndecl_stop_numeric_f08;
624 extern GTY(()) tree gfor_fndecl_stop_string;
625 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
626 extern GTY(()) tree gfor_fndecl_error_stop_string;
627 extern GTY(()) tree gfor_fndecl_runtime_error;
628 extern GTY(()) tree gfor_fndecl_runtime_error_at;
629 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
630 extern GTY(()) tree gfor_fndecl_os_error;
631 extern GTY(()) tree gfor_fndecl_generate_error;
632 extern GTY(()) tree gfor_fndecl_set_fpe;
633 extern GTY(()) tree gfor_fndecl_set_options;
634 extern GTY(()) tree gfor_fndecl_ttynam;
635 extern GTY(()) tree gfor_fndecl_ctime;
636 extern GTY(()) tree gfor_fndecl_fdate;
637 extern GTY(()) tree gfor_fndecl_in_pack;
638 extern GTY(()) tree gfor_fndecl_in_unpack;
639 extern GTY(()) tree gfor_fndecl_associated;
642 /* Coarray run-time library function decls. */
643 extern GTY(()) tree gfor_fndecl_caf_init;
644 extern GTY(()) tree gfor_fndecl_caf_finalize;
645 extern GTY(()) tree gfor_fndecl_caf_register;
646 extern GTY(()) tree gfor_fndecl_caf_critical;
647 extern GTY(()) tree gfor_fndecl_caf_end_critical;
648 extern GTY(()) tree gfor_fndecl_caf_sync_all;
649 extern GTY(()) tree gfor_fndecl_caf_sync_images;
650 extern GTY(()) tree gfor_fndecl_caf_error_stop;
651 extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
653 /* Coarray global variables for num_images/this_image. */
654 extern GTY(()) tree gfort_gvar_caf_num_images;
655 extern GTY(()) tree gfort_gvar_caf_this_image;
658 /* Math functions. Many other math functions are handled in
659 trans-intrinsic.c. */
661 typedef struct GTY(()) gfc_powdecl_list {
668 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
669 extern GTY(()) tree gfor_fndecl_math_ishftc4;
670 extern GTY(()) tree gfor_fndecl_math_ishftc8;
671 extern GTY(()) tree gfor_fndecl_math_ishftc16;
673 /* BLAS functions. */
674 extern GTY(()) tree gfor_fndecl_sgemm;
675 extern GTY(()) tree gfor_fndecl_dgemm;
676 extern GTY(()) tree gfor_fndecl_cgemm;
677 extern GTY(()) tree gfor_fndecl_zgemm;
679 /* String functions. */
680 extern GTY(()) tree gfor_fndecl_compare_string;
681 extern GTY(()) tree gfor_fndecl_concat_string;
682 extern GTY(()) tree gfor_fndecl_string_len_trim;
683 extern GTY(()) tree gfor_fndecl_string_index;
684 extern GTY(()) tree gfor_fndecl_string_scan;
685 extern GTY(()) tree gfor_fndecl_string_verify;
686 extern GTY(()) tree gfor_fndecl_string_trim;
687 extern GTY(()) tree gfor_fndecl_string_minmax;
688 extern GTY(()) tree gfor_fndecl_adjustl;
689 extern GTY(()) tree gfor_fndecl_adjustr;
690 extern GTY(()) tree gfor_fndecl_select_string;
691 extern GTY(()) tree gfor_fndecl_compare_string_char4;
692 extern GTY(()) tree gfor_fndecl_concat_string_char4;
693 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
694 extern GTY(()) tree gfor_fndecl_string_index_char4;
695 extern GTY(()) tree gfor_fndecl_string_scan_char4;
696 extern GTY(()) tree gfor_fndecl_string_verify_char4;
697 extern GTY(()) tree gfor_fndecl_string_trim_char4;
698 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
699 extern GTY(()) tree gfor_fndecl_adjustl_char4;
700 extern GTY(()) tree gfor_fndecl_adjustr_char4;
701 extern GTY(()) tree gfor_fndecl_select_string_char4;
703 /* Conversion between character kinds. */
704 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
705 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
707 /* Other misc. runtime library functions. */
708 extern GTY(()) tree gfor_fndecl_size0;
709 extern GTY(()) tree gfor_fndecl_size1;
710 extern GTY(()) tree gfor_fndecl_iargc;
712 /* Implemented in Fortran. */
713 extern GTY(()) tree gfor_fndecl_sc_kind;
714 extern GTY(()) tree gfor_fndecl_si_kind;
715 extern GTY(()) tree gfor_fndecl_sr_kind;
718 /* True if node is an integer constant. */
719 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
721 /* gfortran-specific declaration information, the _CONT versions denote
722 arrays with CONTIGUOUS attribute. */
727 GFC_ARRAY_ASSUMED_SHAPE,
728 GFC_ARRAY_ASSUMED_SHAPE_CONT,
729 GFC_ARRAY_ALLOCATABLE,
731 GFC_ARRAY_POINTER_CONT
734 /* Array types only. */
735 /* FIXME: the variable_size annotation here is needed because these types are
736 variable-sized in some other frontends. Due to gengtype deficiency the GTY
737 options of such types have to agree across all frontends. */
738 struct GTY((variable_size)) lang_type {
740 enum gfc_array_kind akind;
741 tree lbound[GFC_MAX_DIMENSIONS];
742 tree ubound[GFC_MAX_DIMENSIONS];
743 tree stride[GFC_MAX_DIMENSIONS];
750 tree nonrestricted_type;
755 struct GTY((variable_size)) lang_decl {
756 /* Dummy variables. */
757 tree saved_descriptor;
758 /* Assigned integer nodes. Stringlength is the IO format string's length.
759 Addr is the address of the string or the target label. Stringlength is
760 initialized to -2 and assigned to -1 when addr is assigned to the
761 address of target label. */
765 /* For assumed-shape coarrays. */
766 tree token, caf_offset;
770 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
771 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
772 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
773 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
774 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
775 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
776 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
777 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
778 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
779 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
780 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
781 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
782 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
783 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
785 /* An array descriptor. */
786 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
787 /* An array without a descriptor. */
788 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
789 /* Fortran POINTER type. */
790 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
791 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
792 descriptorless array types. */
793 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
794 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
795 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
796 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
797 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
798 (TYPE_LANG_SPECIFIC(node)->stride[dim])
799 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
800 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
801 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
802 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
803 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
804 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
805 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
806 /* Code should use gfc_get_dtype instead of accessing this directly. It may
807 not be known when the type is created. */
808 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
809 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
810 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
811 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
812 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
813 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
816 /* Build an expression with void type. */
817 #define build1_v(code, arg) \
818 fold_build1_loc (input_location, code, void_type_node, arg)
819 #define build2_v(code, arg1, arg2) \
820 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
821 #define build3_v(code, arg1, arg2, arg3) \
822 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
823 #define build4_v(code, arg1, arg2, arg3, arg4) \
824 build4_loc (input_location, code, void_type_node, arg1, arg2, \
827 /* This group of functions allows a caller to evaluate an expression from
828 the callee's interface. It establishes a mapping between the interface's
829 dummy arguments and the caller's actual arguments, then applies that
830 mapping to a given gfc_expr.
832 You can initialize a mapping structure like so:
834 gfc_interface_mapping mapping;
836 gfc_init_interface_mapping (&mapping);
838 You should then evaluate each actual argument into a temporary
839 gfc_se structure, here called "se", and map the result to the
840 dummy argument's symbol, here called "sym":
842 gfc_add_interface_mapping (&mapping, sym, &se);
844 After adding all mappings, you should call:
846 gfc_finish_interface_mapping (&mapping, pre, post);
848 where "pre" and "post" are statement blocks for initialization
849 and finalization code respectively. You can then evaluate an
850 interface expression "expr" as follows:
852 gfc_apply_interface_mapping (&mapping, se, expr);
854 Once you've evaluated all expressions, you should free
855 the mapping structure with:
857 gfc_free_interface_mapping (&mapping); */
860 /* This structure represents a mapping from OLD to NEW, where OLD is a
861 dummy argument symbol and NEW is a symbol that represents the value
862 of an actual argument. Mappings are linked together using NEXT
863 (in no particular order). */
864 typedef struct gfc_interface_sym_mapping
866 struct gfc_interface_sym_mapping *next;
868 gfc_symtree *new_sym;
871 gfc_interface_sym_mapping;
874 /* This structure is used by callers to evaluate an expression from
875 a callee's interface. */
876 typedef struct gfc_interface_mapping
878 /* Maps the interface's dummy arguments to the values that the caller
879 is passing. The whole list is owned by this gfc_interface_mapping. */
880 gfc_interface_sym_mapping *syms;
882 /* A list of gfc_charlens that were needed when creating copies of
883 expressions. The whole list is owned by this gfc_interface_mapping. */
884 gfc_charlen *charlens;
886 gfc_interface_mapping;
888 void gfc_init_interface_mapping (gfc_interface_mapping *);
889 void gfc_free_interface_mapping (gfc_interface_mapping *);
890 void gfc_add_interface_mapping (gfc_interface_mapping *,
891 gfc_symbol *, gfc_se *, gfc_expr *);
892 void gfc_finish_interface_mapping (gfc_interface_mapping *,
893 stmtblock_t *, stmtblock_t *);
894 void gfc_apply_interface_mapping (gfc_interface_mapping *,
895 gfc_se *, gfc_expr *);
898 /* Standard error messages used in all the trans-*.c files. */
899 extern const char gfc_msg_fault[];
900 extern const char gfc_msg_wrong_return[];
902 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
903 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
904 construct is not workshared. */
905 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
906 to create parallel loops. */
907 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
908 extern int ompws_flags;
910 #endif /* GFC_TRANS_H */