1 /* Header for code translation functions
2 Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
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 scalarizer dimensions to actual dimensions.
118 actual = dim[scalarizer] */
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 except it evaluates a pointer to the expression.
130 Used for elemental function parameters. */
133 /* An array section. Scalarization indices will be substituted during
134 expression translation. */
137 /* A non-elemental function call returning an array. The call is executed
138 before entering the scalarization loop, storing the result in a
139 temporary. This temporary is then used inside the scalarization loop.
140 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
141 as a special case. */
144 /* An array constructor. The current implementation is sub-optimal in
145 many cases. It allocated a temporary, assigns the values to it, then
146 uses this temporary inside the scalarization loop. */
149 /* A vector subscript. The vector's descriptor is cached in the
150 "descriptor" field of the associated gfc_ss_info. */
153 /* A temporary array allocated by the scalarizer. Its rank can be less
154 than that of the assignment expression. */
157 /* An intrinsic function call. Many intrinsic functions which map directly
158 to library calls are created as GFC_SS_FUNCTION nodes. */
161 /* A component of a derived type. */
166 /* SS structures can only belong to a single loopinfo. They must be added
167 otherwise they will not get freed. */
168 typedef struct gfc_ss
176 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
186 /* The rank of the temporary. May be less than the rank of the
187 assigned expression. */
192 /* All other types. */
197 /* All the SS in a loop and linked through loop_chain. The SS for an
198 expression are linked by the next pointer. */
199 struct gfc_ss
*loop_chain
;
202 /* This is used by assignments requiring temporaries. The bits specify which
203 loops the terms appear in. This will be 1 for the RHS expressions,
204 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit
205 'where' suppresses precalculation of scalars in WHERE assignments. */
206 unsigned useflags
:2, where
:1;
209 #define gfc_get_ss() XCNEW (gfc_ss)
211 /* The contents of this aren't actually used. A NULL SS chain indicates a
212 scalar expression, so this pointer is used to terminate SS chains. */
213 extern gfc_ss
* const gfc_ss_terminator
;
215 /* Holds information about an expression while it is being scalarized. */
216 typedef struct gfc_loopinfo
223 /* All the SS involved with this loop. */
225 /* The SS describing the temporary used in an assignment. */
228 /* The scalarization loop index variables. */
229 tree loopvar
[GFC_MAX_DIMENSIONS
];
231 /* The bounds of the scalarization loops. */
232 tree from
[GFC_MAX_DIMENSIONS
];
233 tree to
[GFC_MAX_DIMENSIONS
];
234 gfc_ss
*specloop
[GFC_MAX_DIMENSIONS
];
236 /* The code member contains the code for the body of the next outer loop. */
237 stmtblock_t code
[GFC_MAX_DIMENSIONS
];
239 /* Order in which the dimensions should be looped, innermost first. */
240 int order
[GFC_MAX_DIMENSIONS
];
242 /* The number of dimensions for which a temporary is used. */
245 /* If set we don't need the loop variables. */
246 unsigned array_parameter
:1;
251 /* Information about a symbol that has been shadowed by a temporary. */
254 symbol_attribute attr
;
260 /* Advance the SS chain to the next term. */
261 void gfc_advance_se_ss_chain (gfc_se
*);
263 /* Call this to initialize a gfc_se structure before use
264 first parameter is structure to initialize, second is
265 parent to get scalarization data from, or NULL. */
266 void gfc_init_se (gfc_se
*, gfc_se
*);
268 /* Create an artificial variable decl and add it to the current scope. */
269 tree
gfc_create_var (tree
, const char *);
270 /* Like above but doesn't add it to the current scope. */
271 tree
gfc_create_var_np (tree
, const char *);
273 /* Store the result of an expression in a temp variable so it can be used
274 repeatedly even if the original changes */
275 void gfc_make_safe_expr (gfc_se
* se
);
277 /* Makes sure se is suitable for passing as a function string parameter. */
278 void gfc_conv_string_parameter (gfc_se
* se
);
280 /* Compare two strings. */
281 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int);
283 /* Add an item to the end of TREE_LIST. */
284 tree
gfc_chainon_list (tree
, tree
);
286 /* When using the gfc_conv_* make sure you understand what they do, i.e.
287 when a POST chain may be created, and what the returned expression may be
288 used for. Note that character strings have special handling. This
289 should not be a problem as most statements/operations only deal with
290 numeric/logical types. See the implementations in trans-expr.c
291 for details of the individual functions. */
293 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
294 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
295 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
296 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
297 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
300 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
302 /* Find the decl containing the auxiliary variables for assigned variables. */
303 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
304 /* If the value is not constant, Create a temporary and copy the value. */
305 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
307 /* Intrinsic function handling. */
308 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
310 /* Does an intrinsic map directly to an external library call. */
311 int gfc_is_intrinsic_libcall (gfc_expr
*);
313 /* Used to call ordinary functions/subroutines
314 and procedure pointer components. */
315 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
318 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
);
320 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
322 /* Generate code for a scalar assignment. */
323 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool);
325 /* Translate COMMON blocks. */
326 void gfc_trans_common (gfc_namespace
*);
328 /* Translate a derived type constructor. */
329 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
331 /* Return an expression which determines if a dummy parameter is present. */
332 tree
gfc_conv_expr_present (gfc_symbol
*);
333 /* Convert a missing, dummy argument into a null or zero. */
334 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
336 /* Generate code to allocate a string temporary. */
337 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
338 /* Get the string length variable belonging to an expression. */
339 tree
gfc_get_expr_charlen (gfc_expr
*);
340 /* Initialize a string length variable. */
341 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
342 /* Ensure type sizes can be gimplified. */
343 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
345 /* Add an expression to the end of a block. */
346 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
347 /* Add a block to the end of a block. */
348 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
349 /* Add a MODIFY_EXPR to a block. */
350 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
352 /* Initialize a statement block. */
353 void gfc_init_block (stmtblock_t
*);
354 /* Start a new statement block. Like gfc_init_block but also starts a new
356 void gfc_start_block (stmtblock_t
*);
357 /* Finish a statement block. Also closes the scope if the block was created
358 with gfc_start_block. */
359 tree
gfc_finish_block (stmtblock_t
*);
360 /* Merge the scope of a block with its parent. */
361 void gfc_merge_block_scope (stmtblock_t
* block
);
363 /* Return the backend label decl. */
364 tree
gfc_get_label_decl (gfc_st_label
*);
366 /* Return the decl for an external function. */
367 tree
gfc_get_extern_function_decl (gfc_symbol
*);
369 /* Return the decl for a function. */
370 tree
gfc_get_function_decl (gfc_symbol
*);
372 /* Build an ADDR_EXPR. */
373 tree
gfc_build_addr_expr (tree
, tree
);
375 /* Build an ARRAY_REF. */
376 tree
gfc_build_array_ref (tree
, tree
, tree
);
378 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
379 tree
gfc_build_label_decl (tree
);
381 /* Return the decl used to hold the function return value.
382 Do not use if the function has an explicit result variable. */
383 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
385 /* Get the return label for the current function. */
386 tree
gfc_get_return_label (void);
388 /* Add a decl to the binding level for the current function. */
389 void gfc_add_decl_to_function (tree
);
391 /* Make prototypes for runtime library functions. */
392 void gfc_build_builtin_function_decls (void);
394 /* Set the backend source location of a decl. */
395 void gfc_set_decl_location (tree
, locus
*);
397 /* Return the variable decl for a symbol. */
398 tree
gfc_get_symbol_decl (gfc_symbol
*);
400 /* Build a static initializer. */
401 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool);
403 /* Assign a default initializer to a derived type. */
404 tree
gfc_init_default_dt (gfc_symbol
*, tree
);
406 /* Substitute a temporary variable in place of the real one. */
407 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
409 /* Restore the original variable. */
410 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
412 /* Setting a decl assembler name, mangling it according to target rules
413 (like Windows @NN decorations). */
414 void gfc_set_decl_assembler_name (tree
, tree
);
416 /* Returns true if a variable of specified size should go on the stack. */
417 int gfc_can_put_var_on_stack (tree
);
419 /* Allocate the lang-specific part of a decl node. */
420 void gfc_allocate_lang_decl (tree
);
422 /* Advance along a TREE_CHAIN. */
423 tree
gfc_advance_chain (tree
, int);
425 /* Create a decl for a function. */
426 void gfc_create_function_decl (gfc_namespace
*);
427 /* Generate the code for a function. */
428 void gfc_generate_function_code (gfc_namespace
*);
429 /* Output a BLOCK DATA program unit. */
430 void gfc_generate_block_data (gfc_namespace
*);
431 /* Output a decl for a module variable. */
432 void gfc_generate_module_vars (gfc_namespace
*);
434 struct GTY(()) module_htab_entry
{
437 htab_t
GTY ((param_is (union tree_node
))) decls
;
440 struct module_htab_entry
*gfc_find_module (const char *);
441 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
443 /* Get and set the current location. */
444 void gfc_set_backend_locus (locus
*);
445 void gfc_get_backend_locus (locus
*);
447 /* Handle static constructor functions. */
448 extern GTY(()) tree gfc_static_ctors
;
449 void gfc_generate_constructors (void);
451 /* Get the string length of an array constructor. */
452 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor
*, tree
*);
454 /* Generate a runtime error call. */
455 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
456 tree
gfc_trans_runtime_error_vararg (bool, locus
*, const char*, va_list);
458 /* Generate a runtime warning/error check. */
459 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
462 /* Generate a runtime check for same string length. */
463 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
466 /* Generate a call to free() after checking that its arg is non-NULL. */
467 tree
gfc_call_free (tree
);
469 /* Allocate memory after performing a few checks. */
470 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
472 /* Build a memcpy call. */
473 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
475 /* Allocate memory for arrays, with optional status variable. */
476 tree
gfc_allocate_array_with_status (stmtblock_t
*, tree
, tree
, tree
, gfc_expr
*);
478 /* Allocate memory, with optional status variable. */
479 tree
gfc_allocate_with_status (stmtblock_t
*, tree
, tree
);
481 /* Generate code to deallocate an array. */
482 tree
gfc_deallocate_with_status (tree
, tree
, bool, gfc_expr
*);
484 /* Generate code to call realloc(). */
485 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
487 /* Generate code for an assignment, includes scalarization. */
488 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool);
490 /* Generate code for a pointer assignment. */
491 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
493 /* Initialize function decls for library functions. */
494 void gfc_build_intrinsic_lib_fndecls (void);
495 /* Create function decls for IO library functions. */
496 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
497 void gfc_build_io_library_fndecls (void);
498 /* Build a function decl for a library function. */
499 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
501 /* Process the local variable decls of a block construct. */
502 void gfc_process_block_locals (gfc_namespace
*);
504 /* Output initialization/clean-up code that was deferred. */
505 tree
gfc_trans_deferred_vars (gfc_symbol
*, tree
);
508 tree
pushdecl (tree
);
509 tree
pushdecl_top_level (tree
);
510 void pushlevel (int);
511 tree
poplevel (int, int, int);
512 tree
getdecls (void);
513 tree
gfc_truthvalue_conversion (tree
);
514 tree
gfc_builtin_function (tree
);
515 struct array_descr_info
;
516 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
518 /* In trans-openmp.c */
519 bool gfc_omp_privatize_by_reference (const_tree
);
520 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
521 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
522 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
523 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
524 tree
gfc_omp_clause_dtor (tree
, tree
);
525 bool gfc_omp_disregard_value_expr (tree
, bool);
526 bool gfc_omp_private_debug_clause (tree
, bool);
527 bool gfc_omp_private_outer_ref (tree
);
528 struct gimplify_omp_ctx
;
529 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
531 /* Runtime library function decls. */
532 extern GTY(()) tree gfor_fndecl_pause_numeric
;
533 extern GTY(()) tree gfor_fndecl_pause_string
;
534 extern GTY(()) tree gfor_fndecl_stop_numeric
;
535 extern GTY(()) tree gfor_fndecl_stop_string
;
536 extern GTY(()) tree gfor_fndecl_runtime_error
;
537 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
538 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
539 extern GTY(()) tree gfor_fndecl_os_error
;
540 extern GTY(()) tree gfor_fndecl_generate_error
;
541 extern GTY(()) tree gfor_fndecl_set_fpe
;
542 extern GTY(()) tree gfor_fndecl_set_options
;
543 extern GTY(()) tree gfor_fndecl_ttynam
;
544 extern GTY(()) tree gfor_fndecl_ctime
;
545 extern GTY(()) tree gfor_fndecl_fdate
;
546 extern GTY(()) tree gfor_fndecl_in_pack
;
547 extern GTY(()) tree gfor_fndecl_in_unpack
;
548 extern GTY(()) tree gfor_fndecl_associated
;
550 /* Math functions. Many other math functions are handled in
551 trans-intrinsic.c. */
553 typedef struct GTY(()) gfc_powdecl_list
{
560 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
561 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
562 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
563 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
565 /* BLAS functions. */
566 extern GTY(()) tree gfor_fndecl_sgemm
;
567 extern GTY(()) tree gfor_fndecl_dgemm
;
568 extern GTY(()) tree gfor_fndecl_cgemm
;
569 extern GTY(()) tree gfor_fndecl_zgemm
;
571 /* String functions. */
572 extern GTY(()) tree gfor_fndecl_compare_string
;
573 extern GTY(()) tree gfor_fndecl_concat_string
;
574 extern GTY(()) tree gfor_fndecl_string_len_trim
;
575 extern GTY(()) tree gfor_fndecl_string_index
;
576 extern GTY(()) tree gfor_fndecl_string_scan
;
577 extern GTY(()) tree gfor_fndecl_string_verify
;
578 extern GTY(()) tree gfor_fndecl_string_trim
;
579 extern GTY(()) tree gfor_fndecl_string_minmax
;
580 extern GTY(()) tree gfor_fndecl_adjustl
;
581 extern GTY(()) tree gfor_fndecl_adjustr
;
582 extern GTY(()) tree gfor_fndecl_select_string
;
583 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
584 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
585 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
586 extern GTY(()) tree gfor_fndecl_string_index_char4
;
587 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
588 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
589 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
590 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
591 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
592 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
593 extern GTY(()) tree gfor_fndecl_select_string_char4
;
595 /* Conversion between character kinds. */
596 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
597 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
599 /* Other misc. runtime library functions. */
600 extern GTY(()) tree gfor_fndecl_size0
;
601 extern GTY(()) tree gfor_fndecl_size1
;
602 extern GTY(()) tree gfor_fndecl_iargc
;
603 extern GTY(()) tree gfor_fndecl_clz128
;
604 extern GTY(()) tree gfor_fndecl_ctz128
;
606 /* Implemented in Fortran. */
607 extern GTY(()) tree gfor_fndecl_sc_kind
;
608 extern GTY(()) tree gfor_fndecl_si_kind
;
609 extern GTY(()) tree gfor_fndecl_sr_kind
;
612 /* True if node is an integer constant. */
613 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
615 /* G95-specific declaration information. */
620 GFC_ARRAY_ASSUMED_SHAPE
,
621 GFC_ARRAY_ALLOCATABLE
,
625 /* Array types only. */
626 struct GTY(()) lang_type
{
628 enum gfc_array_kind akind
;
629 tree lbound
[GFC_MAX_DIMENSIONS
];
630 tree ubound
[GFC_MAX_DIMENSIONS
];
631 tree stride
[GFC_MAX_DIMENSIONS
];
640 struct GTY(()) lang_decl
{
641 /* Dummy variables. */
642 tree saved_descriptor
;
643 /* Assigned integer nodes. Stringlength is the IO format string's length.
644 Addr is the address of the string or the target label. Stringlength is
645 initialized to -2 and assigned to -1 when addr is assigned to the
646 address of target label. */
653 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
654 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
655 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
656 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
657 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
658 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
659 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
660 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
661 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
662 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
663 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
664 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
666 /* An array descriptor. */
667 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
668 /* An array without a descriptor. */
669 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
670 /* Fortran POINTER type. */
671 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
672 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
673 descriptorless array types. */
674 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
675 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
676 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
677 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
678 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
679 (TYPE_LANG_SPECIFIC(node)->stride[dim])
680 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
681 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
682 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
683 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
684 /* Code should use gfc_get_dtype instead of accessing this directly. It may
685 not be known when the type is created. */
686 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
687 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
688 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
689 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
690 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
691 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
693 /* Build an expression with void type. */
694 #define build1_v(code, arg) fold_build1(code, void_type_node, arg)
695 #define build2_v(code, arg1, arg2) fold_build2(code, void_type_node, \
697 #define build3_v(code, arg1, arg2, arg3) fold_build3(code, void_type_node, \
699 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
700 arg1, arg2, arg3, arg4)
702 /* This group of functions allows a caller to evaluate an expression from
703 the callee's interface. It establishes a mapping between the interface's
704 dummy arguments and the caller's actual arguments, then applies that
705 mapping to a given gfc_expr.
707 You can initialize a mapping structure like so:
709 gfc_interface_mapping mapping;
711 gfc_init_interface_mapping (&mapping);
713 You should then evaluate each actual argument into a temporary
714 gfc_se structure, here called "se", and map the result to the
715 dummy argument's symbol, here called "sym":
717 gfc_add_interface_mapping (&mapping, sym, &se);
719 After adding all mappings, you should call:
721 gfc_finish_interface_mapping (&mapping, pre, post);
723 where "pre" and "post" are statement blocks for initialization
724 and finalization code respectively. You can then evaluate an
725 interface expression "expr" as follows:
727 gfc_apply_interface_mapping (&mapping, se, expr);
729 Once you've evaluated all expressions, you should free
730 the mapping structure with:
732 gfc_free_interface_mapping (&mapping); */
735 /* This structure represents a mapping from OLD to NEW, where OLD is a
736 dummy argument symbol and NEW is a symbol that represents the value
737 of an actual argument. Mappings are linked together using NEXT
738 (in no particular order). */
739 typedef struct gfc_interface_sym_mapping
741 struct gfc_interface_sym_mapping
*next
;
743 gfc_symtree
*new_sym
;
746 gfc_interface_sym_mapping
;
749 /* This structure is used by callers to evaluate an expression from
750 a callee's interface. */
751 typedef struct gfc_interface_mapping
753 /* Maps the interface's dummy arguments to the values that the caller
754 is passing. The whole list is owned by this gfc_interface_mapping. */
755 gfc_interface_sym_mapping
*syms
;
757 /* A list of gfc_charlens that were needed when creating copies of
758 expressions. The whole list is owned by this gfc_interface_mapping. */
759 gfc_charlen
*charlens
;
761 gfc_interface_mapping
;
763 void gfc_init_interface_mapping (gfc_interface_mapping
*);
764 void gfc_free_interface_mapping (gfc_interface_mapping
*);
765 void gfc_add_interface_mapping (gfc_interface_mapping
*,
766 gfc_symbol
*, gfc_se
*, gfc_expr
*);
767 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
768 stmtblock_t
*, stmtblock_t
*);
769 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
770 gfc_se
*, gfc_expr
*);
773 /* Standard error messages used in all the trans-*.c files. */
774 extern const char gfc_msg_bounds
[];
775 extern const char gfc_msg_fault
[];
776 extern const char gfc_msg_wrong_return
[];
778 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
779 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
780 construct is not workshared. */
781 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
782 to create parallel loops. */
783 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
784 extern int ompws_flags
;
786 #endif /* GFC_TRANS_H */