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 /* 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 /* Scalarization parameters. */
90 struct gfc_se *parent;
92 struct gfc_loopinfo *loop;
97 /* Scalarization State chain. Created by walking an expression tree before
98 creating the scalarization loops. Then passed as part of a gfc_se structure
99 to translate the expression inside the loop. Note that these chains are
100 terminated by gfc_se_terminator, not NULL. A NULL pointer in a gfc_se
101 indicates to gfc_conv_* that this is a scalar expression.
102 Note that some member arrays correspond to scalarizer rank and others
103 are the variable rank. */
105 typedef struct gfc_ss_info
108 /* The ref that holds information on this section. */
110 /* The descriptor of this array. */
112 /* holds the pointer to the data array. */
114 /* To move some of the array index calculation out of the innermost loop. */
118 /* Holds the SS for a subscript. Indexed by actual dimension. */
119 struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
121 /* stride and delta are used to access this inside a scalarization loop.
122 start is used in the calculation of these. Indexed by scalarizer
124 tree start[GFC_MAX_DIMENSIONS];
125 tree end[GFC_MAX_DIMENSIONS];
126 tree stride[GFC_MAX_DIMENSIONS];
127 tree delta[GFC_MAX_DIMENSIONS];
129 /* Translation from loop dimensions to actual dimensions.
130 actual_dim = dim[loop_dim] */
131 int dim[GFC_MAX_DIMENSIONS];
137 /* A scalar value. This will be evaluated before entering the
138 scalarization loop. */
141 /* Like GFC_SS_SCALAR it evaluates the expression outside the
142 loop. Is always evaluated as a reference to the temporary.
143 Used for elemental function arguments. */
146 /* An array section. Scalarization indices will be substituted during
147 expression translation. */
150 /* A non-elemental function call returning an array. The call is executed
151 before entering the scalarization loop, storing the result in a
152 temporary. This temporary is then used inside the scalarization loop.
153 Simple assignments, e.g. a(:) = fn(), are handled without a temporary
154 as a special case. */
157 /* An array constructor. The current implementation is sub-optimal in
158 many cases. It allocated a temporary, assigns the values to it, then
159 uses this temporary inside the scalarization loop. */
162 /* A vector subscript. The vector's descriptor is cached in the
163 "descriptor" field of the associated gfc_ss_info. */
166 /* A temporary array allocated by the scalarizer. Its rank can be less
167 than that of the assignment expression. */
170 /* An intrinsic function call. Many intrinsic functions which map directly
171 to library calls are created as GFC_SS_FUNCTION nodes. */
174 /* A component of a derived type. */
179 /* SS structures can only belong to a single loopinfo. They must be added
180 otherwise they will not get freed. */
181 typedef struct gfc_ss
189 /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE. */
199 /* The rank of the temporary. May be less than the rank of the
200 assigned expression. */
205 /* All other types. */
210 /* All the SS in a loop and linked through loop_chain. The SS for an
211 expression are linked by the next pointer. */
212 struct gfc_ss *loop_chain;
215 /* This is used by assignments requiring temporaries. The bits specify which
216 loops the terms appear in. This will be 1 for the RHS expressions,
217 2 for the LHS expressions, and 3(=1|2) for the temporary. The bit
218 'where' suppresses precalculation of scalars in WHERE assignments. */
219 unsigned useflags:2, where:1, is_alloc_lhs:1;
222 #define gfc_get_ss() XCNEW (gfc_ss)
224 /* The contents of this aren't actually used. A NULL SS chain indicates a
225 scalar expression, so this pointer is used to terminate SS chains. */
226 extern gfc_ss * const gfc_ss_terminator;
228 /* Holds information about an expression while it is being scalarized. */
229 typedef struct gfc_loopinfo
236 /* All the SS involved with this loop. */
238 /* The SS describing the temporary used in an assignment. */
241 /* The scalarization loop index variables. */
242 tree loopvar[GFC_MAX_DIMENSIONS];
244 /* The bounds of the scalarization loops. */
245 tree from[GFC_MAX_DIMENSIONS];
246 tree to[GFC_MAX_DIMENSIONS];
247 gfc_ss *specloop[GFC_MAX_DIMENSIONS];
249 /* The code member contains the code for the body of the next outer loop. */
250 stmtblock_t code[GFC_MAX_DIMENSIONS];
252 /* Order in which the dimensions should be looped, innermost first. */
253 int order[GFC_MAX_DIMENSIONS];
255 /* Enum to control loop reversal. */
256 gfc_reverse reverse[GFC_MAX_DIMENSIONS];
258 /* The number of dimensions for which a temporary is used. */
261 /* If set we don't need the loop variables. */
262 unsigned array_parameter:1;
267 /* Information about a symbol that has been shadowed by a temporary. */
270 symbol_attribute attr;
276 /* Store information about a block of code together with special
277 initialization and clean-up code. This can be used to incrementally add
278 init and cleanup, and in the end put everything together to a
279 try-finally expression. */
289 /* Initialize an init/cleanup block. */
290 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
291 /* Add a pair of init/cleanup code to the block. Each one might be a
292 NULL_TREE if not required. */
293 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
294 /* Finalize the block, that is, create a single expression encapsulating the
295 original code together with init and clean-up code. */
296 tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
299 /* Advance the SS chain to the next term. */
300 void gfc_advance_se_ss_chain (gfc_se *);
302 /* Call this to initialize a gfc_se structure before use
303 first parameter is structure to initialize, second is
304 parent to get scalarization data from, or NULL. */
305 void gfc_init_se (gfc_se *, gfc_se *);
307 /* Create an artificial variable decl and add it to the current scope. */
308 tree gfc_create_var (tree, const char *);
309 /* Like above but doesn't add it to the current scope. */
310 tree gfc_create_var_np (tree, const char *);
312 /* Store the result of an expression in a temp variable so it can be used
313 repeatedly even if the original changes */
314 void gfc_make_safe_expr (gfc_se * se);
316 /* Makes sure se is suitable for passing as a function string parameter. */
317 void gfc_conv_string_parameter (gfc_se * se);
319 /* Compare two strings. */
320 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
322 /* Add an item to the end of TREE_LIST. */
323 tree gfc_chainon_list (tree, tree);
325 /* When using the gfc_conv_* make sure you understand what they do, i.e.
326 when a POST chain may be created, and what the returned expression may be
327 used for. Note that character strings have special handling. This
328 should not be a problem as most statements/operations only deal with
329 numeric/logical types. See the implementations in trans-expr.c
330 for details of the individual functions. */
332 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
333 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
334 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
335 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
336 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
339 void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
340 tree gfc_string_to_single_character (tree len, tree str, int kind);
342 /* Find the decl containing the auxiliary variables for assigned variables. */
343 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
344 /* If the value is not constant, Create a temporary and copy the value. */
345 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
346 tree gfc_evaluate_now (tree, stmtblock_t *);
348 /* Find the appropriate variant of a math intrinsic. */
349 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
351 /* Intrinsic function handling. */
352 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
354 /* Is the intrinsic expanded inline. */
355 bool gfc_inline_intrinsic_function_p (gfc_expr *);
357 /* Does an intrinsic map directly to an external library call
358 This is true for array-returning intrinsics, unless
359 gfc_inline_intrinsic_function_p returns true. */
360 int gfc_is_intrinsic_libcall (gfc_expr *);
362 tree gfc_conv_intrinsic_move_alloc (gfc_code *);
364 /* Used to call ordinary functions/subroutines
365 and procedure pointer components. */
366 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
367 gfc_expr *, VEC(tree,gc) *);
369 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool);
371 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
373 /* Generate code for a scalar assignment. */
374 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
377 /* Translate COMMON blocks. */
378 void gfc_trans_common (gfc_namespace *);
380 /* Translate a derived type constructor. */
381 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
383 /* Return an expression which determines if a dummy parameter is present. */
384 tree gfc_conv_expr_present (gfc_symbol *);
385 /* Convert a missing, dummy argument into a null or zero. */
386 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
388 /* Generate code to allocate a string temporary. */
389 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
390 /* Get the string length variable belonging to an expression. */
391 tree gfc_get_expr_charlen (gfc_expr *);
392 /* Initialize a string length variable. */
393 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
394 /* Ensure type sizes can be gimplified. */
395 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
397 /* Add an expression to the end of a block. */
398 void gfc_add_expr_to_block (stmtblock_t *, tree);
399 /* Add a block to the end of a block. */
400 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
401 /* Add a MODIFY_EXPR to a block. */
402 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
403 void gfc_add_modify (stmtblock_t *, tree, tree);
405 /* Initialize a statement block. */
406 void gfc_init_block (stmtblock_t *);
407 /* Start a new statement block. Like gfc_init_block but also starts a new
409 void gfc_start_block (stmtblock_t *);
410 /* Finish a statement block. Also closes the scope if the block was created
411 with gfc_start_block. */
412 tree gfc_finish_block (stmtblock_t *);
413 /* Merge the scope of a block with its parent. */
414 void gfc_merge_block_scope (stmtblock_t * block);
416 /* Return the backend label decl. */
417 tree gfc_get_label_decl (gfc_st_label *);
419 /* Return the decl for an external function. */
420 tree gfc_get_extern_function_decl (gfc_symbol *);
422 /* Return the decl for a function. */
423 tree gfc_get_function_decl (gfc_symbol *);
425 /* Build an ADDR_EXPR. */
426 tree gfc_build_addr_expr (tree, tree);
428 /* Build an ARRAY_REF. */
429 tree gfc_build_array_ref (tree, tree, tree);
431 /* Creates a label. Decl is artificial if label_id == NULL_TREE. */
432 tree gfc_build_label_decl (tree);
434 /* Return the decl used to hold the function return value.
435 Do not use if the function has an explicit result variable. */
436 tree gfc_get_fake_result_decl (gfc_symbol *, int);
438 /* Add a decl to the binding level for the current function. */
439 void gfc_add_decl_to_function (tree);
441 /* Make prototypes for runtime library functions. */
442 void gfc_build_builtin_function_decls (void);
444 /* Set the backend source location of a decl. */
445 void gfc_set_decl_location (tree, locus *);
447 /* Get a module symbol backend_decl if possible. */
448 bool gfc_get_module_backend_decl (gfc_symbol *);
450 /* Return the variable decl for a symbol. */
451 tree gfc_get_symbol_decl (gfc_symbol *);
453 /* Build a static initializer. */
454 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
456 /* Assign a default initializer to a derived type. */
457 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
459 /* Substitute a temporary variable in place of the real one. */
460 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
462 /* Restore the original variable. */
463 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
465 /* Setting a decl assembler name, mangling it according to target rules
466 (like Windows @NN decorations). */
467 void gfc_set_decl_assembler_name (tree, tree);
469 /* Returns true if a variable of specified size should go on the stack. */
470 int gfc_can_put_var_on_stack (tree);
472 /* Allocate the lang-specific part of a decl node. */
473 void gfc_allocate_lang_decl (tree);
475 /* Advance along a TREE_CHAIN. */
476 tree gfc_advance_chain (tree, int);
478 /* Create a decl for a function. */
479 void gfc_create_function_decl (gfc_namespace *, bool);
480 /* Generate the code for a function. */
481 void gfc_generate_function_code (gfc_namespace *);
482 /* Output a BLOCK DATA program unit. */
483 void gfc_generate_block_data (gfc_namespace *);
484 /* Output a decl for a module variable. */
485 void gfc_generate_module_vars (gfc_namespace *);
486 /* Get the appropriate return statement for a procedure. */
487 tree gfc_generate_return (void);
489 struct GTY(()) module_htab_entry {
492 htab_t GTY ((param_is (union tree_node))) decls;
495 struct module_htab_entry *gfc_find_module (const char *);
496 void gfc_module_add_decl (struct module_htab_entry *, tree);
498 /* Get and set the current location. */
499 void gfc_save_backend_locus (locus *);
500 void gfc_set_backend_locus (locus *);
501 void gfc_restore_backend_locus (locus *);
503 /* Handle static constructor functions. */
504 extern GTY(()) tree gfc_static_ctors;
505 void gfc_generate_constructors (void);
507 /* Get the string length of an array constructor. */
508 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
510 /* Generate a runtime error call. */
511 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
513 /* Generate a runtime warning/error check. */
514 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
517 /* Generate a runtime check for same string length. */
518 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
521 /* Generate a call to free() after checking that its arg is non-NULL. */
522 tree gfc_call_free (tree);
524 /* Allocate memory after performing a few checks. */
525 tree gfc_call_malloc (stmtblock_t *, tree, tree);
527 /* Build a memcpy call. */
528 tree gfc_build_memcpy_call (tree, tree, tree);
530 /* Allocate memory for arrays, with optional status variable. */
531 tree gfc_allocate_array_with_status (stmtblock_t*, tree, tree, tree, gfc_expr*);
533 /* Allocate memory, with optional status variable. */
534 tree gfc_allocate_with_status (stmtblock_t *, tree, tree);
536 /* Generate code to deallocate an array. */
537 tree gfc_deallocate_with_status (tree, tree, bool, gfc_expr*);
538 tree gfc_deallocate_scalar_with_status (tree, tree, bool, gfc_expr*, gfc_typespec);
540 /* Generate code to call realloc(). */
541 tree gfc_call_realloc (stmtblock_t *, tree, tree);
543 /* Generate code for an assignment, includes scalarization. */
544 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool);
546 /* Generate code for a pointer assignment. */
547 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
549 /* Initialize function decls for library functions. */
550 void gfc_build_intrinsic_lib_fndecls (void);
551 /* Create function decls for IO library functions. */
552 void gfc_trans_io_runtime_check (tree, tree, int, const char *, stmtblock_t *);
553 void gfc_build_io_library_fndecls (void);
554 /* Build a function decl for a library function. */
555 tree gfc_build_library_function_decl (tree, tree, int, ...);
556 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
557 tree rettype, int nargs, ...);
559 /* Process the local variable decls of a block construct. */
560 void gfc_process_block_locals (gfc_namespace*);
562 /* Output initialization/clean-up code that was deferred. */
563 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
566 tree pushdecl (tree);
567 tree pushdecl_top_level (tree);
568 void pushlevel (int);
569 tree poplevel (int, int, int);
570 tree getdecls (void);
571 tree gfc_truthvalue_conversion (tree);
572 tree gfc_builtin_function (tree);
574 /* In trans-types.c. */
575 struct array_descr_info;
576 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
578 /* In trans-openmp.c */
579 bool gfc_omp_privatize_by_reference (const_tree);
580 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
581 tree gfc_omp_report_decl (tree);
582 tree gfc_omp_clause_default_ctor (tree, tree, tree);
583 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
584 tree gfc_omp_clause_assign_op (tree, tree, tree);
585 tree gfc_omp_clause_dtor (tree, tree);
586 bool gfc_omp_disregard_value_expr (tree, bool);
587 bool gfc_omp_private_debug_clause (tree, bool);
588 bool gfc_omp_private_outer_ref (tree);
589 struct gimplify_omp_ctx;
590 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
592 /* Runtime library function decls. */
593 extern GTY(()) tree gfor_fndecl_pause_numeric;
594 extern GTY(()) tree gfor_fndecl_pause_string;
595 extern GTY(()) tree gfor_fndecl_stop_numeric;
596 extern GTY(()) tree gfor_fndecl_stop_numeric_f08;
597 extern GTY(()) tree gfor_fndecl_stop_string;
598 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
599 extern GTY(()) tree gfor_fndecl_error_stop_string;
600 extern GTY(()) tree gfor_fndecl_runtime_error;
601 extern GTY(()) tree gfor_fndecl_runtime_error_at;
602 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
603 extern GTY(()) tree gfor_fndecl_os_error;
604 extern GTY(()) tree gfor_fndecl_generate_error;
605 extern GTY(()) tree gfor_fndecl_set_fpe;
606 extern GTY(()) tree gfor_fndecl_set_options;
607 extern GTY(()) tree gfor_fndecl_ttynam;
608 extern GTY(()) tree gfor_fndecl_ctime;
609 extern GTY(()) tree gfor_fndecl_fdate;
610 extern GTY(()) tree gfor_fndecl_in_pack;
611 extern GTY(()) tree gfor_fndecl_in_unpack;
612 extern GTY(()) tree gfor_fndecl_associated;
614 /* Math functions. Many other math functions are handled in
615 trans-intrinsic.c. */
617 typedef struct GTY(()) gfc_powdecl_list {
624 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
625 extern GTY(()) tree gfor_fndecl_math_ishftc4;
626 extern GTY(()) tree gfor_fndecl_math_ishftc8;
627 extern GTY(()) tree gfor_fndecl_math_ishftc16;
629 /* BLAS functions. */
630 extern GTY(()) tree gfor_fndecl_sgemm;
631 extern GTY(()) tree gfor_fndecl_dgemm;
632 extern GTY(()) tree gfor_fndecl_cgemm;
633 extern GTY(()) tree gfor_fndecl_zgemm;
635 /* String functions. */
636 extern GTY(()) tree gfor_fndecl_compare_string;
637 extern GTY(()) tree gfor_fndecl_concat_string;
638 extern GTY(()) tree gfor_fndecl_string_len_trim;
639 extern GTY(()) tree gfor_fndecl_string_index;
640 extern GTY(()) tree gfor_fndecl_string_scan;
641 extern GTY(()) tree gfor_fndecl_string_verify;
642 extern GTY(()) tree gfor_fndecl_string_trim;
643 extern GTY(()) tree gfor_fndecl_string_minmax;
644 extern GTY(()) tree gfor_fndecl_adjustl;
645 extern GTY(()) tree gfor_fndecl_adjustr;
646 extern GTY(()) tree gfor_fndecl_select_string;
647 extern GTY(()) tree gfor_fndecl_compare_string_char4;
648 extern GTY(()) tree gfor_fndecl_concat_string_char4;
649 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
650 extern GTY(()) tree gfor_fndecl_string_index_char4;
651 extern GTY(()) tree gfor_fndecl_string_scan_char4;
652 extern GTY(()) tree gfor_fndecl_string_verify_char4;
653 extern GTY(()) tree gfor_fndecl_string_trim_char4;
654 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
655 extern GTY(()) tree gfor_fndecl_adjustl_char4;
656 extern GTY(()) tree gfor_fndecl_adjustr_char4;
657 extern GTY(()) tree gfor_fndecl_select_string_char4;
659 /* Conversion between character kinds. */
660 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
661 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
663 /* Other misc. runtime library functions. */
664 extern GTY(()) tree gfor_fndecl_size0;
665 extern GTY(()) tree gfor_fndecl_size1;
666 extern GTY(()) tree gfor_fndecl_iargc;
668 /* Implemented in Fortran. */
669 extern GTY(()) tree gfor_fndecl_sc_kind;
670 extern GTY(()) tree gfor_fndecl_si_kind;
671 extern GTY(()) tree gfor_fndecl_sr_kind;
674 /* True if node is an integer constant. */
675 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
677 /* gfortran-specific declaration information, the _CONT versions denote
678 arrays with CONTIGUOUS attribute. */
683 GFC_ARRAY_ASSUMED_SHAPE,
684 GFC_ARRAY_ASSUMED_SHAPE_CONT,
685 GFC_ARRAY_ALLOCATABLE,
687 GFC_ARRAY_POINTER_CONT
690 /* Array types only. */
691 /* FIXME: the variable_size annotation here is needed because these types are
692 variable-sized in some other frontends. Due to gengtype deficiency the GTY
693 options of such types have to agree across all frontends. */
694 struct GTY((variable_size)) lang_type {
696 enum gfc_array_kind akind;
697 tree lbound[GFC_MAX_DIMENSIONS];
698 tree ubound[GFC_MAX_DIMENSIONS];
699 tree stride[GFC_MAX_DIMENSIONS];
706 tree nonrestricted_type;
709 struct GTY((variable_size)) lang_decl {
710 /* Dummy variables. */
711 tree saved_descriptor;
712 /* Assigned integer nodes. Stringlength is the IO format string's length.
713 Addr is the address of the string or the target label. Stringlength is
714 initialized to -2 and assigned to -1 when addr is assigned to the
715 address of target label. */
722 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
723 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
724 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
725 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
726 (DECL_LANG_SPECIFIC(node)->saved_descriptor)
727 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
728 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
729 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
730 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
731 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
732 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
733 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
735 /* An array descriptor. */
736 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
737 /* An array without a descriptor. */
738 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
739 /* Fortran POINTER type. */
740 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
741 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
742 descriptorless array types. */
743 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
744 (TYPE_LANG_SPECIFIC(node)->lbound[dim])
745 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
746 (TYPE_LANG_SPECIFIC(node)->ubound[dim])
747 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
748 (TYPE_LANG_SPECIFIC(node)->stride[dim])
749 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
750 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
751 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
752 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
753 /* Code should use gfc_get_dtype instead of accessing this directly. It may
754 not be known when the type is created. */
755 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
756 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
757 (TYPE_LANG_SPECIFIC(node)->dataptr_type)
758 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
759 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
760 (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
763 /* Build an expression with void type. */
764 #define build1_v(code, arg) \
765 fold_build1_loc (input_location, code, void_type_node, arg)
766 #define build2_v(code, arg1, arg2) \
767 fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
768 #define build3_v(code, arg1, arg2, arg3) \
769 fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
770 #define build4_v(code, arg1, arg2, arg3, arg4) \
771 build4_loc (input_location, code, void_type_node, arg1, arg2, \
774 /* This group of functions allows a caller to evaluate an expression from
775 the callee's interface. It establishes a mapping between the interface's
776 dummy arguments and the caller's actual arguments, then applies that
777 mapping to a given gfc_expr.
779 You can initialize a mapping structure like so:
781 gfc_interface_mapping mapping;
783 gfc_init_interface_mapping (&mapping);
785 You should then evaluate each actual argument into a temporary
786 gfc_se structure, here called "se", and map the result to the
787 dummy argument's symbol, here called "sym":
789 gfc_add_interface_mapping (&mapping, sym, &se);
791 After adding all mappings, you should call:
793 gfc_finish_interface_mapping (&mapping, pre, post);
795 where "pre" and "post" are statement blocks for initialization
796 and finalization code respectively. You can then evaluate an
797 interface expression "expr" as follows:
799 gfc_apply_interface_mapping (&mapping, se, expr);
801 Once you've evaluated all expressions, you should free
802 the mapping structure with:
804 gfc_free_interface_mapping (&mapping); */
807 /* This structure represents a mapping from OLD to NEW, where OLD is a
808 dummy argument symbol and NEW is a symbol that represents the value
809 of an actual argument. Mappings are linked together using NEXT
810 (in no particular order). */
811 typedef struct gfc_interface_sym_mapping
813 struct gfc_interface_sym_mapping *next;
815 gfc_symtree *new_sym;
818 gfc_interface_sym_mapping;
821 /* This structure is used by callers to evaluate an expression from
822 a callee's interface. */
823 typedef struct gfc_interface_mapping
825 /* Maps the interface's dummy arguments to the values that the caller
826 is passing. The whole list is owned by this gfc_interface_mapping. */
827 gfc_interface_sym_mapping *syms;
829 /* A list of gfc_charlens that were needed when creating copies of
830 expressions. The whole list is owned by this gfc_interface_mapping. */
831 gfc_charlen *charlens;
833 gfc_interface_mapping;
835 void gfc_init_interface_mapping (gfc_interface_mapping *);
836 void gfc_free_interface_mapping (gfc_interface_mapping *);
837 void gfc_add_interface_mapping (gfc_interface_mapping *,
838 gfc_symbol *, gfc_se *, gfc_expr *);
839 void gfc_finish_interface_mapping (gfc_interface_mapping *,
840 stmtblock_t *, stmtblock_t *);
841 void gfc_apply_interface_mapping (gfc_interface_mapping *,
842 gfc_se *, gfc_expr *);
845 /* Standard error messages used in all the trans-*.c files. */
846 extern const char gfc_msg_fault[];
847 extern const char gfc_msg_wrong_return[];
849 #define OMPWS_WORKSHARE_FLAG 1 /* Set if in a workshare construct. */
850 #define OMPWS_CURR_SINGLEUNIT 2 /* Set if current gfc_code in workshare
851 construct is not workshared. */
852 #define OMPWS_SCALARIZER_WS 4 /* Set if scalarizer should attempt
853 to create parallel loops. */
854 #define OMPWS_NOWAIT 8 /* Use NOWAIT on OMP_FOR. */
855 extern int ompws_flags;
857 #endif /* GFC_TRANS_H */