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 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 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 /* The number of dimensions for which a temporary is used. */
246 /* If set we don't need the loop variables. */
247 unsigned array_parameter
:1;
252 /* Information about a symbol that has been shadowed by a temporary. */
255 symbol_attribute attr
;
261 /* Store information about a block of code together with special
262 initialization and clean-up code. This can be used to incrementally add
263 init and cleanup, and in the end put everything together to a
264 try-finally expression. */
274 /* Initialize an init/cleanup block. */
275 void gfc_start_wrapped_block (gfc_wrapped_block
* block
, tree code
);
276 /* Add a pair of init/cleanup code to the block. Each one might be a
277 NULL_TREE if not required. */
278 void gfc_add_init_cleanup (gfc_wrapped_block
* block
, tree init
, tree cleanup
);
279 /* Finalize the block, that is, create a single expression encapsulating the
280 original code together with init and clean-up code. */
281 tree
gfc_finish_wrapped_block (gfc_wrapped_block
* block
);
284 /* Advance the SS chain to the next term. */
285 void gfc_advance_se_ss_chain (gfc_se
*);
287 /* Call this to initialize a gfc_se structure before use
288 first parameter is structure to initialize, second is
289 parent to get scalarization data from, or NULL. */
290 void gfc_init_se (gfc_se
*, gfc_se
*);
292 /* Create an artificial variable decl and add it to the current scope. */
293 tree
gfc_create_var (tree
, const char *);
294 /* Like above but doesn't add it to the current scope. */
295 tree
gfc_create_var_np (tree
, const char *);
297 /* Store the result of an expression in a temp variable so it can be used
298 repeatedly even if the original changes */
299 void gfc_make_safe_expr (gfc_se
* se
);
301 /* Makes sure se is suitable for passing as a function string parameter. */
302 void gfc_conv_string_parameter (gfc_se
* se
);
304 /* Compare two strings. */
305 tree
gfc_build_compare_string (tree
, tree
, tree
, tree
, int, enum tree_code
);
307 /* Add an item to the end of TREE_LIST. */
308 tree
gfc_chainon_list (tree
, tree
);
310 /* When using the gfc_conv_* make sure you understand what they do, i.e.
311 when a POST chain may be created, and what the returned expression may be
312 used for. Note that character strings have special handling. This
313 should not be a problem as most statements/operations only deal with
314 numeric/logical types. See the implementations in trans-expr.c
315 for details of the individual functions. */
317 void gfc_conv_expr (gfc_se
* se
, gfc_expr
* expr
);
318 void gfc_conv_expr_val (gfc_se
* se
, gfc_expr
* expr
);
319 void gfc_conv_expr_lhs (gfc_se
* se
, gfc_expr
* expr
);
320 void gfc_conv_expr_reference (gfc_se
* se
, gfc_expr
*);
321 void gfc_conv_expr_type (gfc_se
* se
, gfc_expr
*, tree
);
324 void gfc_conv_scalar_char_value (gfc_symbol
*sym
, gfc_se
*se
, gfc_expr
**expr
);
325 tree
gfc_string_to_single_character (tree len
, tree str
, int kind
);
327 /* Find the decl containing the auxiliary variables for assigned variables. */
328 void gfc_conv_label_variable (gfc_se
* se
, gfc_expr
* expr
);
329 /* If the value is not constant, Create a temporary and copy the value. */
330 tree
gfc_evaluate_now (tree
, stmtblock_t
*);
332 /* Intrinsic function handling. */
333 void gfc_conv_intrinsic_function (gfc_se
*, gfc_expr
*);
335 /* Does an intrinsic map directly to an external library call. */
336 int gfc_is_intrinsic_libcall (gfc_expr
*);
338 /* Used to call ordinary functions/subroutines
339 and procedure pointer components. */
340 int gfc_conv_procedure_call (gfc_se
*, gfc_symbol
*, gfc_actual_arglist
*,
341 gfc_expr
*, VEC(tree
,gc
) *);
343 void gfc_conv_subref_array_arg (gfc_se
*, gfc_expr
*, int, sym_intent
, bool);
345 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
347 /* Generate code for a scalar assignment. */
348 tree
gfc_trans_scalar_assign (gfc_se
*, gfc_se
*, gfc_typespec
, bool, bool,
351 /* Translate COMMON blocks. */
352 void gfc_trans_common (gfc_namespace
*);
354 /* Translate a derived type constructor. */
355 void gfc_conv_structure (gfc_se
*, gfc_expr
*, int);
357 /* Return an expression which determines if a dummy parameter is present. */
358 tree
gfc_conv_expr_present (gfc_symbol
*);
359 /* Convert a missing, dummy argument into a null or zero. */
360 void gfc_conv_missing_dummy (gfc_se
*, gfc_expr
*, gfc_typespec
, int);
362 /* Generate code to allocate a string temporary. */
363 tree
gfc_conv_string_tmp (gfc_se
*, tree
, tree
);
364 /* Get the string length variable belonging to an expression. */
365 tree
gfc_get_expr_charlen (gfc_expr
*);
366 /* Initialize a string length variable. */
367 void gfc_conv_string_length (gfc_charlen
*, gfc_expr
*, stmtblock_t
*);
368 /* Ensure type sizes can be gimplified. */
369 void gfc_trans_vla_type_sizes (gfc_symbol
*, stmtblock_t
*);
371 /* Add an expression to the end of a block. */
372 void gfc_add_expr_to_block (stmtblock_t
*, tree
);
373 /* Add a block to the end of a block. */
374 void gfc_add_block_to_block (stmtblock_t
*, stmtblock_t
*);
375 /* Add a MODIFY_EXPR to a block. */
376 void gfc_add_modify (stmtblock_t
*, tree
, tree
);
378 /* Initialize a statement block. */
379 void gfc_init_block (stmtblock_t
*);
380 /* Start a new statement block. Like gfc_init_block but also starts a new
382 void gfc_start_block (stmtblock_t
*);
383 /* Finish a statement block. Also closes the scope if the block was created
384 with gfc_start_block. */
385 tree
gfc_finish_block (stmtblock_t
*);
386 /* Merge the scope of a block with its parent. */
387 void gfc_merge_block_scope (stmtblock_t
* block
);
389 /* Return the backend label decl. */
390 tree
gfc_get_label_decl (gfc_st_label
*);
392 /* Return the decl for an external function. */
393 tree
gfc_get_extern_function_decl (gfc_symbol
*);
395 /* Return the decl for a function. */
396 tree
gfc_get_function_decl (gfc_symbol
*);
398 /* Build an ADDR_EXPR. */
399 tree
gfc_build_addr_expr (tree
, tree
);
401 /* Build an ARRAY_REF. */
402 tree
gfc_build_array_ref (tree
, tree
, tree
);
404 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
405 tree
gfc_build_label_decl (tree
);
407 /* Return the decl used to hold the function return value.
408 Do not use if the function has an explicit result variable. */
409 tree
gfc_get_fake_result_decl (gfc_symbol
*, int);
411 /* Get the return label for the current function. */
412 tree
gfc_get_return_label (void);
414 /* Add a decl to the binding level for the current function. */
415 void gfc_add_decl_to_function (tree
);
417 /* Make prototypes for runtime library functions. */
418 void gfc_build_builtin_function_decls (void);
420 /* Set the backend source location of a decl. */
421 void gfc_set_decl_location (tree
, locus
*);
423 /* Return the variable decl for a symbol. */
424 tree
gfc_get_symbol_decl (gfc_symbol
*);
426 /* Build a static initializer. */
427 tree
gfc_conv_initializer (gfc_expr
*, gfc_typespec
*, tree
, bool, bool);
429 /* Assign a default initializer to a derived type. */
430 void gfc_init_default_dt (gfc_symbol
*, stmtblock_t
*, bool);
432 /* Substitute a temporary variable in place of the real one. */
433 void gfc_shadow_sym (gfc_symbol
*, tree
, gfc_saved_var
*);
435 /* Restore the original variable. */
436 void gfc_restore_sym (gfc_symbol
*, gfc_saved_var
*);
438 /* Setting a decl assembler name, mangling it according to target rules
439 (like Windows @NN decorations). */
440 void gfc_set_decl_assembler_name (tree
, tree
);
442 /* Returns true if a variable of specified size should go on the stack. */
443 int gfc_can_put_var_on_stack (tree
);
445 /* Allocate the lang-specific part of a decl node. */
446 void gfc_allocate_lang_decl (tree
);
448 /* Advance along a TREE_CHAIN. */
449 tree
gfc_advance_chain (tree
, int);
451 /* Create a decl for a function. */
452 void gfc_create_function_decl (gfc_namespace
*);
453 /* Generate the code for a function. */
454 void gfc_generate_function_code (gfc_namespace
*);
455 /* Output a BLOCK DATA program unit. */
456 void gfc_generate_block_data (gfc_namespace
*);
457 /* Output a decl for a module variable. */
458 void gfc_generate_module_vars (gfc_namespace
*);
460 struct GTY(()) module_htab_entry
{
463 htab_t
GTY ((param_is (union tree_node
))) decls
;
466 struct module_htab_entry
*gfc_find_module (const char *);
467 void gfc_module_add_decl (struct module_htab_entry
*, tree
);
469 /* Get and set the current location. */
470 void gfc_set_backend_locus (locus
*);
471 void gfc_get_backend_locus (locus
*);
473 /* Handle static constructor functions. */
474 extern GTY(()) tree gfc_static_ctors
;
475 void gfc_generate_constructors (void);
477 /* Get the string length of an array constructor. */
478 bool get_array_ctor_strlen (stmtblock_t
*, gfc_constructor_base
, tree
*);
480 /* Generate a runtime error call. */
481 tree
gfc_trans_runtime_error (bool, locus
*, const char*, ...);
482 tree
gfc_trans_runtime_error_vararg (bool, locus
*, const char*, va_list);
484 /* Generate a runtime warning/error check. */
485 void gfc_trans_runtime_check (bool, bool, tree
, stmtblock_t
*, locus
*,
488 /* Generate a runtime check for same string length. */
489 void gfc_trans_same_strlen_check (const char*, locus
*, tree
, tree
,
492 /* Generate a call to free() after checking that its arg is non-NULL. */
493 tree
gfc_call_free (tree
);
495 /* Allocate memory after performing a few checks. */
496 tree
gfc_call_malloc (stmtblock_t
*, tree
, tree
);
498 /* Build a memcpy call. */
499 tree
gfc_build_memcpy_call (tree
, tree
, tree
);
501 /* Allocate memory for arrays, with optional status variable. */
502 tree
gfc_allocate_array_with_status (stmtblock_t
*, tree
, tree
, tree
, gfc_expr
*);
504 /* Allocate memory, with optional status variable. */
505 tree
gfc_allocate_with_status (stmtblock_t
*, tree
, tree
);
507 /* Generate code to deallocate an array. */
508 tree
gfc_deallocate_with_status (tree
, tree
, bool, gfc_expr
*);
510 /* Generate code to call realloc(). */
511 tree
gfc_call_realloc (stmtblock_t
*, tree
, tree
);
513 /* Generate code for an assignment, includes scalarization. */
514 tree
gfc_trans_assignment (gfc_expr
*, gfc_expr
*, bool, bool);
516 /* Generate code for a pointer assignment. */
517 tree
gfc_trans_pointer_assignment (gfc_expr
*, gfc_expr
*);
519 /* Generate code to assign typebound procedures to a derived vtab. */
520 void gfc_trans_assign_vtab_procs (stmtblock_t
*, gfc_symbol
*, gfc_symbol
*);
522 /* Initialize function decls for library functions. */
523 void gfc_build_intrinsic_lib_fndecls (void);
524 /* Create function decls for IO library functions. */
525 void gfc_trans_io_runtime_check (tree
, tree
, int, const char *, stmtblock_t
*);
526 void gfc_build_io_library_fndecls (void);
527 /* Build a function decl for a library function. */
528 tree
gfc_build_library_function_decl (tree
, tree
, int, ...);
529 tree
gfc_build_library_function_decl_with_spec (tree name
, const char *spec
,
530 tree rettype
, int nargs
, ...);
532 /* Process the local variable decls of a block construct. */
533 void gfc_process_block_locals (gfc_namespace
*);
535 /* Output initialization/clean-up code that was deferred. */
536 tree
gfc_trans_deferred_vars (gfc_symbol
*, tree
);
539 tree
pushdecl (tree
);
540 tree
pushdecl_top_level (tree
);
541 void pushlevel (int);
542 tree
poplevel (int, int, int);
543 tree
getdecls (void);
544 tree
gfc_truthvalue_conversion (tree
);
545 tree
gfc_builtin_function (tree
);
546 struct array_descr_info
;
547 bool gfc_get_array_descr_info (const_tree
, struct array_descr_info
*);
549 /* In trans-openmp.c */
550 bool gfc_omp_privatize_by_reference (const_tree
);
551 enum omp_clause_default_kind
gfc_omp_predetermined_sharing (tree
);
552 tree
gfc_omp_report_decl (tree
);
553 tree
gfc_omp_clause_default_ctor (tree
, tree
, tree
);
554 tree
gfc_omp_clause_copy_ctor (tree
, tree
, tree
);
555 tree
gfc_omp_clause_assign_op (tree
, tree
, tree
);
556 tree
gfc_omp_clause_dtor (tree
, tree
);
557 bool gfc_omp_disregard_value_expr (tree
, bool);
558 bool gfc_omp_private_debug_clause (tree
, bool);
559 bool gfc_omp_private_outer_ref (tree
);
560 struct gimplify_omp_ctx
;
561 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx
*, tree
);
563 /* Runtime library function decls. */
564 extern GTY(()) tree gfor_fndecl_pause_numeric
;
565 extern GTY(()) tree gfor_fndecl_pause_string
;
566 extern GTY(()) tree gfor_fndecl_stop_numeric
;
567 extern GTY(()) tree gfor_fndecl_stop_string
;
568 extern GTY(()) tree gfor_fndecl_error_stop_numeric
;
569 extern GTY(()) tree gfor_fndecl_error_stop_string
;
570 extern GTY(()) tree gfor_fndecl_runtime_error
;
571 extern GTY(()) tree gfor_fndecl_runtime_error_at
;
572 extern GTY(()) tree gfor_fndecl_runtime_warning_at
;
573 extern GTY(()) tree gfor_fndecl_os_error
;
574 extern GTY(()) tree gfor_fndecl_generate_error
;
575 extern GTY(()) tree gfor_fndecl_set_fpe
;
576 extern GTY(()) tree gfor_fndecl_set_options
;
577 extern GTY(()) tree gfor_fndecl_ttynam
;
578 extern GTY(()) tree gfor_fndecl_ctime
;
579 extern GTY(()) tree gfor_fndecl_fdate
;
580 extern GTY(()) tree gfor_fndecl_in_pack
;
581 extern GTY(()) tree gfor_fndecl_in_unpack
;
582 extern GTY(()) tree gfor_fndecl_associated
;
584 /* Math functions. Many other math functions are handled in
585 trans-intrinsic.c. */
587 typedef struct GTY(()) gfc_powdecl_list
{
594 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi
[4][3];
595 extern GTY(()) tree gfor_fndecl_math_ishftc4
;
596 extern GTY(()) tree gfor_fndecl_math_ishftc8
;
597 extern GTY(()) tree gfor_fndecl_math_ishftc16
;
599 /* BLAS functions. */
600 extern GTY(()) tree gfor_fndecl_sgemm
;
601 extern GTY(()) tree gfor_fndecl_dgemm
;
602 extern GTY(()) tree gfor_fndecl_cgemm
;
603 extern GTY(()) tree gfor_fndecl_zgemm
;
605 /* String functions. */
606 extern GTY(()) tree gfor_fndecl_compare_string
;
607 extern GTY(()) tree gfor_fndecl_concat_string
;
608 extern GTY(()) tree gfor_fndecl_string_len_trim
;
609 extern GTY(()) tree gfor_fndecl_string_index
;
610 extern GTY(()) tree gfor_fndecl_string_scan
;
611 extern GTY(()) tree gfor_fndecl_string_verify
;
612 extern GTY(()) tree gfor_fndecl_string_trim
;
613 extern GTY(()) tree gfor_fndecl_string_minmax
;
614 extern GTY(()) tree gfor_fndecl_adjustl
;
615 extern GTY(()) tree gfor_fndecl_adjustr
;
616 extern GTY(()) tree gfor_fndecl_select_string
;
617 extern GTY(()) tree gfor_fndecl_compare_string_char4
;
618 extern GTY(()) tree gfor_fndecl_concat_string_char4
;
619 extern GTY(()) tree gfor_fndecl_string_len_trim_char4
;
620 extern GTY(()) tree gfor_fndecl_string_index_char4
;
621 extern GTY(()) tree gfor_fndecl_string_scan_char4
;
622 extern GTY(()) tree gfor_fndecl_string_verify_char4
;
623 extern GTY(()) tree gfor_fndecl_string_trim_char4
;
624 extern GTY(()) tree gfor_fndecl_string_minmax_char4
;
625 extern GTY(()) tree gfor_fndecl_adjustl_char4
;
626 extern GTY(()) tree gfor_fndecl_adjustr_char4
;
627 extern GTY(()) tree gfor_fndecl_select_string_char4
;
629 /* Conversion between character kinds. */
630 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4
;
631 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1
;
633 /* Other misc. runtime library functions. */
634 extern GTY(()) tree gfor_fndecl_size0
;
635 extern GTY(()) tree gfor_fndecl_size1
;
636 extern GTY(()) tree gfor_fndecl_iargc
;
637 extern GTY(()) tree gfor_fndecl_clz128
;
638 extern GTY(()) tree gfor_fndecl_ctz128
;
640 /* Implemented in Fortran. */
641 extern GTY(()) tree gfor_fndecl_sc_kind
;
642 extern GTY(()) tree gfor_fndecl_si_kind
;
643 extern GTY(()) tree gfor_fndecl_sr_kind
;
646 /* True if node is an integer constant. */
647 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
649 /* gfortran-specific declaration information, the _CONT versions denote
650 arrays with CONTIGUOUS attribute. */
655 GFC_ARRAY_ASSUMED_SHAPE
,
656 GFC_ARRAY_ASSUMED_SHAPE_CONT
,
657 GFC_ARRAY_ALLOCATABLE
,
659 GFC_ARRAY_POINTER_CONT
662 /* Array types only. */
663 /* FIXME: the variable_size annotation here is needed because these types are
664 variable-sized in some other frontends. Due to gengtype deficiency the GTY
665 options of such types have to agree across all frontends. */
666 struct GTY((variable_size
)) lang_type
{
668 enum gfc_array_kind akind
;
669 tree lbound
[GFC_MAX_DIMENSIONS
];
670 tree ubound
[GFC_MAX_DIMENSIONS
];
671 tree stride
[GFC_MAX_DIMENSIONS
];
680 struct GTY((variable_size
)) lang_decl
{
681 /* Dummy variables. */
682 tree saved_descriptor
;
683 /* Assigned integer nodes. Stringlength is the IO format string's length.
684 Addr is the address of the string or the target label. Stringlength is
685 initialized to -2 and assigned to -1 when addr is assigned to the
686 address of target label. */
693 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
694 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
695 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
696 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
697 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
698 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
699 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
700 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
701 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
702 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
703 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
704 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
706 /* An array descriptor. */
707 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
708 /* An array without a descriptor. */
709 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
710 /* Fortran POINTER type. */
711 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
712 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
713 descriptorless array types. */
714 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
715 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
716 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
717 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
718 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
719 (TYPE_LANG_SPECIFIC(node)->stride[dim])
720 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
721 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
722 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
723 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
724 /* Code should use gfc_get_dtype instead of accessing this directly. It may
725 not be known when the type is created. */
726 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
727 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
728 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
729 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
730 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
731 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
733 /* Build an expression with void type. */
734 #define build1_v(code, arg) fold_build1(code, void_type_node, arg)
735 #define build2_v(code, arg1, arg2) fold_build2(code, void_type_node, \
737 #define build3_v(code, arg1, arg2, arg3) fold_build3(code, void_type_node, \
739 #define build4_v(code, arg1, arg2, arg3, arg4) build4(code, void_type_node, \
740 arg1, arg2, arg3, arg4)
742 /* This group of functions allows a caller to evaluate an expression from
743 the callee's interface. It establishes a mapping between the interface's
744 dummy arguments and the caller's actual arguments, then applies that
745 mapping to a given gfc_expr.
747 You can initialize a mapping structure like so:
749 gfc_interface_mapping mapping;
751 gfc_init_interface_mapping (&mapping);
753 You should then evaluate each actual argument into a temporary
754 gfc_se structure, here called "se", and map the result to the
755 dummy argument's symbol, here called "sym":
757 gfc_add_interface_mapping (&mapping, sym, &se);
759 After adding all mappings, you should call:
761 gfc_finish_interface_mapping (&mapping, pre, post);
763 where "pre" and "post" are statement blocks for initialization
764 and finalization code respectively. You can then evaluate an
765 interface expression "expr" as follows:
767 gfc_apply_interface_mapping (&mapping, se, expr);
769 Once you've evaluated all expressions, you should free
770 the mapping structure with:
772 gfc_free_interface_mapping (&mapping); */
775 /* This structure represents a mapping from OLD to NEW, where OLD is a
776 dummy argument symbol and NEW is a symbol that represents the value
777 of an actual argument. Mappings are linked together using NEXT
778 (in no particular order). */
779 typedef struct gfc_interface_sym_mapping
781 struct gfc_interface_sym_mapping
*next
;
783 gfc_symtree
*new_sym
;
786 gfc_interface_sym_mapping
;
789 /* This structure is used by callers to evaluate an expression from
790 a callee's interface. */
791 typedef struct gfc_interface_mapping
793 /* Maps the interface's dummy arguments to the values that the caller
794 is passing. The whole list is owned by this gfc_interface_mapping. */
795 gfc_interface_sym_mapping
*syms
;
797 /* A list of gfc_charlens that were needed when creating copies of
798 expressions. The whole list is owned by this gfc_interface_mapping. */
799 gfc_charlen
*charlens
;
801 gfc_interface_mapping
;
803 void gfc_init_interface_mapping (gfc_interface_mapping
*);
804 void gfc_free_interface_mapping (gfc_interface_mapping
*);
805 void gfc_add_interface_mapping (gfc_interface_mapping
*,
806 gfc_symbol
*, gfc_se
*, gfc_expr
*);
807 void gfc_finish_interface_mapping (gfc_interface_mapping
*,
808 stmtblock_t
*, stmtblock_t
*);
809 void gfc_apply_interface_mapping (gfc_interface_mapping
*,
810 gfc_se
*, gfc_expr
*);
813 /* Standard error messages used in all the trans-*.c files. */
814 extern const char gfc_msg_fault
[];
815 extern const char gfc_msg_wrong_return
[];
817 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
818 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
819 construct is not workshared. */
820 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
821 to create parallel loops. */
822 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
823 extern int ompws_flags
;
825 #endif /* GFC_TRANS_H */