1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
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 /* Ignore absent optional arguments. Used for some intrinsics. */
68 unsigned ignore_optional:1;
70 /* When this is set the data and offset fields of the returned descriptor
71 are NULL. Used by intrinsic size. */
72 unsigned data_not_needed:1;
74 /* If set, gfc_conv_procedure_call does not put byref calls into se->pre. */
75 unsigned no_function_call:1;
77 /* Scalarization parameters. */
78 struct gfc_se *parent;
80 struct gfc_loopinfo *loop;
85 /* Scalarization State chain. Created by walking an expression tree before
86 creating the scalarization loops. Then passed as part of a gfc_se structure
87 to translate the expression inside the loop. Note that these chains are
88 terminated by gfc_se_terminator, not NULL. A NULL pointer in a gfc_se
89 indicates to gfc_conv_* that this is a scalar expression.
90 Note that some member arrays correspond to scalarizer rank and others
91 are the variable rank. */
93 typedef struct gfc_ss_info
96 /* The ref that holds information on this section. */
98 /* The descriptor of this array. */
100 /* holds the pointer to the data array. */
102 /* To move some of the array index calculation out of the innermost loop. */
106 /* Holds the SS for a subscript. Indexed by actual dimension. */
107 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
109 /* stride and delta are used to access this inside a scalarization loop.
110 start is used in the calculation of these. Indexed by scalarizer
112 tree start[GFC_MAX_DIMENSIONS];
113 tree end[GFC_MAX_DIMENSIONS];
114 tree stride[GFC_MAX_DIMENSIONS];
115 tree delta[GFC_MAX_DIMENSIONS];
117 /* Translation from loop dimensions to actual dimensions.
118 actual_dim = dim[loop_dim] */
119 int dim[GFC_MAX_DIMENSIONS];
125 /* A scalar value. This will be evaluated before entering the
126 scalarization loop. */
129 /* Like GFC_SS_SCALAR it evaluates the expression outside the
130 loop. Is always evaluated as a reference to the temporary.
131 Used for elemental function arguments. */
134 /* An array section. Scalarization indices will be substituted during
135 expression translation. */
138 /* A non-elemental function call returning an array. The call is executed
139 before entering the scalarization loop, storing the result in a
140 temporary. This temporary is then used inside the scalarization loop.
141 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
142 as a special case. */
145 /* An array constructor. The current implementation is sub-optimal in
146 many cases. It allocated a temporary, assigns the values to it, then
147 uses this temporary inside the scalarization loop. */
150 /* A vector subscript. The vector's descriptor is cached in the
151 "descriptor" field of the associated gfc_ss_info. */
154 /* A temporary array allocated by the scalarizer. Its rank can be less
155 than that of the assignment expression. */
158 /* An intrinsic function call. Many intrinsic functions which map directly
159 to library calls are created as GFC_SS_FUNCTION nodes. */
162 /* A component of a derived type. */
167 /* SS structures can only belong to a single loopinfo. They must be added
168 otherwise they will not get freed. */
169 typedef struct gfc_ss
177 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
187 /* The rank of the temporary. May be less than the rank of the
188 assigned expression. */
193 /* All other types. */
198 /* All the SS in a loop and linked through loop_chain. The SS for an
199 expression are linked by the next pointer. */
200 struct gfc_ss *loop_chain;
203 /* This is used by assignments requiring temporaries. The bits specify which
204 loops the terms appear in. This will be 1 for the RHS expressions,
205 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit
206 'where' suppresses precalculation of scalars in WHERE assignments. */
207 unsigned useflags:2, where:1;
210 #define gfc_get_ss() XCNEW (gfc_ss)
212 /* The contents of this aren't actually used. A NULL SS chain indicates a
213 scalar expression, so this pointer is used to terminate SS chains. */
214 extern gfc_ss * const gfc_ss_terminator;
216 /* Holds information about an expression while it is being scalarized. */
217 typedef struct gfc_loopinfo
224 /* All the SS involved with this loop. */
226 /* The SS describing the temporary used in an assignment. */
229 /* The scalarization loop index variables. */
230 tree loopvar[GFC_MAX_DIMENSIONS];
232 /* The bounds of the scalarization loops. */
233 tree from[GFC_MAX_DIMENSIONS];
234 tree to[GFC_MAX_DIMENSIONS];
235 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
237 /* The code member contains the code for the body of the next outer loop. */
238 stmtblock_t code[GFC_MAX_DIMENSIONS];
240 /* Order in which the dimensions should be looped, innermost first. */
241 int order[GFC_MAX_DIMENSIONS];
243 /* Enum to control loop reversal. */
244 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
246 /* The number of dimensions for which a temporary is used. */
249 /* If set we don't need the loop variables. */
250 unsigned array_parameter:1;
255 /* Information about a symbol that has been shadowed by a temporary. */
258 symbol_attribute attr;
264 /* Store information about a block of code together with special
265 initialization and clean-up code. This can be used to incrementally add
266 init and cleanup, and in the end put everything together to a
267 try-finally expression. */
277 /* Initialize an init/cleanup block. */
278 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
279 /* Add a pair of init/cleanup code to the block. Each one might be a
280 NULL_TREE if not required. */
281 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
282 /* Finalize the block, that is, create a single expression encapsulating the
283 original code together with init and clean-up code. */
284 tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
287 /* Advance the SS chain to the next term. */
288 void gfc_advance_se_ss_chain (gfc_se *);
290 /* Call this to initialize a gfc_se structure before use
291 first parameter is structure to initialize, second is
292 parent to get scalarization data from, or NULL. */
293 void gfc_init_se (gfc_se *, gfc_se *);
295 /* Create an artificial variable decl and add it to the current scope. */
296 tree gfc_create_var (tree, const char *);
297 /* Like above but doesn't add it to the current scope. */
298 tree gfc_create_var_np (tree, const char *);
300 /* Store the result of an expression in a temp variable so it can be used
301 repeatedly even if the original changes */
302 void gfc_make_safe_expr (gfc_se * se);
304 /* Makes sure se is suitable for passing as a function string parameter. */
305 void gfc_conv_string_parameter (gfc_se * se);
307 /* Compare two strings. */
308 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
310 /* Add an item to the end of TREE_LIST. */
311 tree gfc_chainon_list (tree, tree);
313 /* When using the gfc_conv_* make sure you understand what they do, i.e.
314 when a POST chain may be created, and what the returned expression may be
315 used for. Note that character strings have special handling. This
316 should not be a problem as most statements/operations only deal with
317 numeric/logical types. See the implementations in trans-expr.c
318 for details of the individual functions. */
320 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
321 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
322 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
323 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
324 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
327 void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
328 tree gfc_string_to_single_character (tree len, tree str, int kind);
330 /* Find the decl containing the auxiliary variables for assigned variables. */
331 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
332 /* If the value is not constant, Create a temporary and copy the value. */
333 tree gfc_evaluate_now (tree, stmtblock_t *);
335 /* Intrinsic function handling. */
336 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
338 /* Does an intrinsic map directly to an external library call. */
339 int gfc_is_intrinsic_libcall (gfc_expr *);
341 tree gfc_conv_intrinsic_move_alloc (gfc_code *);
343 /* Used to call ordinary functions/subroutines
344 and procedure pointer components. */
345 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
346 gfc_expr *, VEC(tree,gc) *);
348 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool);
350 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
352 /* Generate code for a scalar assignment. */
353 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
356 /* Translate COMMON blocks. */
357 void gfc_trans_common (gfc_namespace *);
359 /* Translate a derived type constructor. */
360 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
362 /* Return an expression which determines if a dummy parameter is present. */
363 tree gfc_conv_expr_present (gfc_symbol *);
364 /* Convert a missing, dummy argument into a null or zero. */
365 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
367 /* Generate code to allocate a string temporary. */
368 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
369 /* Get the string length variable belonging to an expression. */
370 tree gfc_get_expr_charlen (gfc_expr *);
371 /* Initialize a string length variable. */
372 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
373 /* Ensure type sizes can be gimplified. */
374 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
376 /* Add an expression to the end of a block. */
377 void gfc_add_expr_to_block (stmtblock_t *, tree);
378 /* Add a block to the end of a block. */
379 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
380 /* Add a MODIFY_EXPR to a block. */
381 void gfc_add_modify (stmtblock_t *, tree, tree);
383 /* Initialize a statement block. */
384 void gfc_init_block (stmtblock_t *);
385 /* Start a new statement block. Like gfc_init_block but also starts a new
387 void gfc_start_block (stmtblock_t *);
388 /* Finish a statement block. Also closes the scope if the block was created
389 with gfc_start_block. */
390 tree gfc_finish_block (stmtblock_t *);
391 /* Merge the scope of a block with its parent. */
392 void gfc_merge_block_scope (stmtblock_t * block);
394 /* Return the backend label decl. */
395 tree gfc_get_label_decl (gfc_st_label *);
397 /* Return the decl for an external function. */
398 tree gfc_get_extern_function_decl (gfc_symbol *);
400 /* Return the decl for a function. */
401 tree gfc_get_function_decl (gfc_symbol *);
403 /* Build an ADDR_EXPR. */
404 tree gfc_build_addr_expr (tree, tree);
406 /* Build an ARRAY_REF. */
407 tree gfc_build_array_ref (tree, tree, tree);
409 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
410 tree gfc_build_label_decl (tree);
412 /* Return the decl used to hold the function return value.
413 Do not use if the function has an explicit result variable. */
414 tree gfc_get_fake_result_decl (gfc_symbol *, int);
416 /* Add a decl to the binding level for the current function. */
417 void gfc_add_decl_to_function (tree);
419 /* Make prototypes for runtime library functions. */
420 void gfc_build_builtin_function_decls (void);
422 /* Set the backend source location of a decl. */
423 void gfc_set_decl_location (tree, locus *);
425 /* Return the variable decl for a symbol. */
426 tree gfc_get_symbol_decl (gfc_symbol *);
428 /* Build a static initializer. */
429 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool);
431 /* Assign a default initializer to a derived type. */
432 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
434 /* Substitute a temporary variable in place of the real one. */
435 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
437 /* Restore the original variable. */
438 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
440 /* Setting a decl assembler name, mangling it according to target rules
441 (like Windows @NN decorations). */
442 void gfc_set_decl_assembler_name (tree, tree);
444 /* Returns true if a variable of specified size should go on the stack. */
445 int gfc_can_put_var_on_stack (tree);
447 /* Allocate the lang-specific part of a decl node. */
448 void gfc_allocate_lang_decl (tree);
450 /* Advance along a TREE_CHAIN. */
451 tree gfc_advance_chain (tree, int);
453 /* Create a decl for a function. */
454 void gfc_create_function_decl (gfc_namespace *, bool);
455 /* Generate the code for a function. */
456 void gfc_generate_function_code (gfc_namespace *);
457 /* Output a BLOCK DATA program unit. */
458 void gfc_generate_block_data (gfc_namespace *);
459 /* Output a decl for a module variable. */
460 void gfc_generate_module_vars (gfc_namespace *);
461 /* Get the appropriate return statement for a procedure. */
462 tree gfc_generate_return (void);
464 struct GTY(()) module_htab_entry {
467 htab_t GTY ((param_is (union tree_node))) decls;
470 struct module_htab_entry *gfc_find_module (const char *);
471 void gfc_module_add_decl (struct module_htab_entry *, tree);
473 /* Get and set the current location. */
474 void gfc_set_backend_locus (locus *);
475 void gfc_get_backend_locus (locus *);
477 /* Handle static constructor functions. */
478 extern GTY(()) tree gfc_static_ctors;
479 void gfc_generate_constructors (void);
481 /* Get the string length of an array constructor. */
482 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
484 /* Generate a runtime error call. */
485 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
486 tree gfc_trans_runtime_error_vararg (bool, locus*, const char*, va_list);
488 /* Generate a runtime warning/error check. */
489 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
492 /* Generate a runtime check for same string length. */
493 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
496 /* Generate a call to free() after checking that its arg is non-NULL. */
497 tree gfc_call_free (tree);
499 /* Allocate memory after performing a few checks. */
500 tree gfc_call_malloc (stmtblock_t *, tree, tree);
502 /* Build a memcpy call. */
503 tree gfc_build_memcpy_call (tree, tree, tree);
505 /* Allocate memory for arrays, with optional status variable. */
506 tree gfc_allocate_array_with_status (stmtblock_t*, tree, tree, tree, gfc_expr*);
508 /* Allocate memory, with optional status variable. */
509 tree gfc_allocate_with_status (stmtblock_t *, tree, tree);
511 /* Generate code to deallocate an array. */
512 tree gfc_deallocate_with_status (tree, tree, bool, gfc_expr*);
514 /* Generate code to call realloc(). */
515 tree gfc_call_realloc (stmtblock_t *, tree, tree);
517 /* Generate code for an assignment, includes scalarization. */
518 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool);
520 /* Generate code for a pointer assignment. */
521 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
523 /* Generate code to assign typebound procedures to a derived vtab. */
524 void gfc_trans_assign_vtab_procs (stmtblock_t*, gfc_symbol*, gfc_symbol*);
526 /* Initialize function decls for library functions. */
527 void gfc_build_intrinsic_lib_fndecls (void);
528 /* Create function decls for IO library functions. */
529 void gfc_trans_io_runtime_check (tree, tree, int, const char *, stmtblock_t *);
530 void gfc_build_io_library_fndecls (void);
531 /* Build a function decl for a library function. */
532 tree gfc_build_library_function_decl (tree, tree, int, ...);
533 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
534 tree rettype, int nargs, ...);
536 /* Process the local variable decls of a block construct. */
537 void gfc_process_block_locals (gfc_namespace*);
539 /* Output initialization/clean-up code that was deferred. */
540 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
543 tree pushdecl (tree);
544 tree pushdecl_top_level (tree);
545 void pushlevel (int);
546 tree poplevel (int, int, int);
547 tree getdecls (void);
548 tree gfc_truthvalue_conversion (tree);
549 tree gfc_builtin_function (tree);
551 /* In trans-types.c. */
552 struct array_descr_info;
553 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
555 /* In trans-openmp.c */
556 bool gfc_omp_privatize_by_reference (const_tree);
557 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
558 tree gfc_omp_report_decl (tree);
559 tree gfc_omp_clause_default_ctor (tree, tree, tree);
560 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
561 tree gfc_omp_clause_assign_op (tree, tree, tree);
562 tree gfc_omp_clause_dtor (tree, tree);
563 bool gfc_omp_disregard_value_expr (tree, bool);
564 bool gfc_omp_private_debug_clause (tree, bool);
565 bool gfc_omp_private_outer_ref (tree);
566 struct gimplify_omp_ctx;
567 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
569 /* Runtime library function decls. */
570 extern GTY(()) tree gfor_fndecl_pause_numeric;
571 extern GTY(()) tree gfor_fndecl_pause_string;
572 extern GTY(()) tree gfor_fndecl_stop_numeric;
573 extern GTY(()) tree gfor_fndecl_stop_string;
574 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
575 extern GTY(()) tree gfor_fndecl_error_stop_string;
576 extern GTY(()) tree gfor_fndecl_runtime_error;
577 extern GTY(()) tree gfor_fndecl_runtime_error_at;
578 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
579 extern GTY(()) tree gfor_fndecl_os_error;
580 extern GTY(()) tree gfor_fndecl_generate_error;
581 extern GTY(()) tree gfor_fndecl_set_fpe;
582 extern GTY(()) tree gfor_fndecl_set_options;
583 extern GTY(()) tree gfor_fndecl_ttynam;
584 extern GTY(()) tree gfor_fndecl_ctime;
585 extern GTY(()) tree gfor_fndecl_fdate;
586 extern GTY(()) tree gfor_fndecl_in_pack;
587 extern GTY(()) tree gfor_fndecl_in_unpack;
588 extern GTY(()) tree gfor_fndecl_associated;
590 /* Math functions. Many other math functions are handled in
591 trans-intrinsic.c. */
593 typedef struct GTY(()) gfc_powdecl_list {
600 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
601 extern GTY(()) tree gfor_fndecl_math_ishftc4;
602 extern GTY(()) tree gfor_fndecl_math_ishftc8;
603 extern GTY(()) tree gfor_fndecl_math_ishftc16;
605 /* BLAS functions. */
606 extern GTY(()) tree gfor_fndecl_sgemm;
607 extern GTY(()) tree gfor_fndecl_dgemm;
608 extern GTY(()) tree gfor_fndecl_cgemm;
609 extern GTY(()) tree gfor_fndecl_zgemm;
611 /* String functions. */
612 extern GTY(()) tree gfor_fndecl_compare_string;
613 extern GTY(()) tree gfor_fndecl_concat_string;
614 extern GTY(()) tree gfor_fndecl_string_len_trim;
615 extern GTY(()) tree gfor_fndecl_string_index;
616 extern GTY(()) tree gfor_fndecl_string_scan;
617 extern GTY(()) tree gfor_fndecl_string_verify;
618 extern GTY(()) tree gfor_fndecl_string_trim;
619 extern GTY(()) tree gfor_fndecl_string_minmax;
620 extern GTY(()) tree gfor_fndecl_adjustl;
621 extern GTY(()) tree gfor_fndecl_adjustr;
622 extern GTY(()) tree gfor_fndecl_select_string;
623 extern GTY(()) tree gfor_fndecl_compare_string_char4;
624 extern GTY(()) tree gfor_fndecl_concat_string_char4;
625 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
626 extern GTY(()) tree gfor_fndecl_string_index_char4;
627 extern GTY(()) tree gfor_fndecl_string_scan_char4;
628 extern GTY(()) tree gfor_fndecl_string_verify_char4;
629 extern GTY(()) tree gfor_fndecl_string_trim_char4;
630 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
631 extern GTY(()) tree gfor_fndecl_adjustl_char4;
632 extern GTY(()) tree gfor_fndecl_adjustr_char4;
633 extern GTY(()) tree gfor_fndecl_select_string_char4;
635 /* Conversion between character kinds. */
636 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
637 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
639 /* Other misc. runtime library functions. */
640 extern GTY(()) tree gfor_fndecl_size0;
641 extern GTY(()) tree gfor_fndecl_size1;
642 extern GTY(()) tree gfor_fndecl_iargc;
643 extern GTY(()) tree gfor_fndecl_clz128;
644 extern GTY(()) tree gfor_fndecl_ctz128;
646 /* Implemented in Fortran. */
647 extern GTY(()) tree gfor_fndecl_sc_kind;
648 extern GTY(()) tree gfor_fndecl_si_kind;
649 extern GTY(()) tree gfor_fndecl_sr_kind;
652 /* True if node is an integer constant. */
653 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
655 /* gfortran-specific declaration information, the _CONT versions denote
656 arrays with CONTIGUOUS attribute. */
661 GFC_ARRAY_ASSUMED_SHAPE,
662 GFC_ARRAY_ASSUMED_SHAPE_CONT,
663 GFC_ARRAY_ALLOCATABLE,
665 GFC_ARRAY_POINTER_CONT
668 /* Array types only. */
669 /* FIXME: the variable_size annotation here is needed because these types are
670 variable-sized in some other frontends. Due to gengtype deficiency the GTY
671 options of such types have to agree across all frontends. */
672 struct GTY((variable_size)) lang_type {
674 enum gfc_array_kind akind;
675 tree lbound[GFC_MAX_DIMENSIONS];
676 tree ubound[GFC_MAX_DIMENSIONS];
677 tree stride[GFC_MAX_DIMENSIONS];
686 struct GTY((variable_size)) lang_decl {
687 /* Dummy variables. */
688 tree saved_descriptor;
689 /* Assigned integer nodes. Stringlength is the IO format string's length.
690 Addr is the address of the string or the target label. Stringlength is
691 initialized to -2 and assigned to -1 when addr is assigned to the
692 address of target label. */
699 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
700 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
701 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
702 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
703 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
704 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
705 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
706 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
707 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
708 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
709 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
710 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
712 /* An array descriptor. */
713 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
714 /* An array without a descriptor. */
715 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
716 /* Fortran POINTER type. */
717 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
718 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
719 descriptorless array types. */
720 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
721 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
722 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
723 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
724 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
725 (TYPE_LANG_SPECIFIC(node)->stride[dim])
726 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
727 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
728 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
729 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
730 /* Code should use gfc_get_dtype instead of accessing this directly. It may
731 not be known when the type is created. */
732 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
733 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
734 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
735 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
736 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
737 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
739 /* Build an expression with void type. */
740 #define build1_v(code, arg) fold_build1(code, void_type_node, arg)
741 #define build2_v(code, arg1, arg2) fold_build2(code, void_type_node, \
743 #define build3_v(code, arg1, arg2, arg3) fold_build3(code, void_type_node, \
745 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
746 arg1, arg2, arg3, arg4)
748 /* This group of functions allows a caller to evaluate an expression from
749 the callee's interface. It establishes a mapping between the interface's
750 dummy arguments and the caller's actual arguments, then applies that
751 mapping to a given gfc_expr.
753 You can initialize a mapping structure like so:
755 gfc_interface_mapping mapping;
757 gfc_init_interface_mapping (&mapping);
759 You should then evaluate each actual argument into a temporary
760 gfc_se structure, here called "se", and map the result to the
761 dummy argument's symbol, here called "sym":
763 gfc_add_interface_mapping (&mapping, sym, &se);
765 After adding all mappings, you should call:
767 gfc_finish_interface_mapping (&mapping, pre, post);
769 where "pre" and "post" are statement blocks for initialization
770 and finalization code respectively. You can then evaluate an
771 interface expression "expr" as follows:
773 gfc_apply_interface_mapping (&mapping, se, expr);
775 Once you've evaluated all expressions, you should free
776 the mapping structure with:
778 gfc_free_interface_mapping (&mapping); */
781 /* This structure represents a mapping from OLD to NEW, where OLD is a
782 dummy argument symbol and NEW is a symbol that represents the value
783 of an actual argument. Mappings are linked together using NEXT
784 (in no particular order). */
785 typedef struct gfc_interface_sym_mapping
787 struct gfc_interface_sym_mapping *next;
789 gfc_symtree *new_sym;
792 gfc_interface_sym_mapping;
795 /* This structure is used by callers to evaluate an expression from
796 a callee's interface. */
797 typedef struct gfc_interface_mapping
799 /* Maps the interface's dummy arguments to the values that the caller
800 is passing. The whole list is owned by this gfc_interface_mapping. */
801 gfc_interface_sym_mapping *syms;
803 /* A list of gfc_charlens that were needed when creating copies of
804 expressions. The whole list is owned by this gfc_interface_mapping. */
805 gfc_charlen *charlens;
807 gfc_interface_mapping;
809 void gfc_init_interface_mapping (gfc_interface_mapping *);
810 void gfc_free_interface_mapping (gfc_interface_mapping *);
811 void gfc_add_interface_mapping (gfc_interface_mapping *,
812 gfc_symbol *, gfc_se *, gfc_expr *);
813 void gfc_finish_interface_mapping (gfc_interface_mapping *,
814 stmtblock_t *, stmtblock_t *);
815 void gfc_apply_interface_mapping (gfc_interface_mapping *,
816 gfc_se *, gfc_expr *);
819 /* Standard error messages used in all the trans-*.c files. */
820 extern const char gfc_msg_fault[];
821 extern const char gfc_msg_wrong_return[];
823 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
824 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
825 construct is not workshared. */
826 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
827 to create parallel loops. */
828 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
829 extern int ompws_flags;
831 #endif /* GFC_TRANS_H */