gcc/fortran/trans.h

   1 /* Header for code translation functions
   2    Copyright (C) 2002-2018 Free Software Foundation, Inc.
   3    Contributed by Paul Brook
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GFC_TRANS_H
  22 #define GFC_TRANS_H
  23
  24 #include "predict.h"  /* For enum br_predictor and PRED_*.  */
  25
  26 /* Mangled symbols take the form __module__name.  */
  27 #define GFC_MAX_MANGLED_SYMBOL_LEN  (GFC_MAX_SYMBOL_LEN*2+4)
  28
  29 /* Struct for holding a block of statements.  It should be treated as an
  30    opaque entity and not modified directly.  This allows us to change the
  31    underlying representation of statement lists.  */
  32 typedef struct
  33 {
  34   tree head;
  35   unsigned int has_scope:1;
  36 }
  37 stmtblock_t;
  38
  39 /* a simplified expression */
  40 typedef struct gfc_se
  41 {
  42   /* Code blocks to be executed before and after using the value.  */
  43   stmtblock_t pre;
  44   stmtblock_t post;
  45
  46   /* the result of the expression */
  47   tree expr;
  48
  49   /* The length of a character string value.  */
  50   tree string_length;
  51
  52   /* When expr is a reference to a class object, store its vptr access
  53      here.  */
  54   tree class_vptr;
  55
  56   /* If set gfc_conv_variable will return an expression for the array
  57      descriptor. When set, want_pointer should also be set.
  58      If not set scalarizing variables will be substituted.  */
  59   unsigned descriptor_only:1;
  60
  61   /* When this is set gfc_conv_expr returns the address of a variable.  Only
  62      applies to EXPR_VARIABLE nodes.
  63      Also used by gfc_conv_array_parameter. When set this indicates a pointer
  64      to the descriptor should be returned, rather than the descriptor itself.
  65    */
  66   unsigned want_pointer:1;
  67
  68   /* An array function call returning without a temporary.  Also used for array
  69      pointer assignments.  */
  70   unsigned direct_byref:1;
  71
  72   /* If direct_byref is set, do work out the descriptor as in that case but
  73      do still create a new descriptor variable instead of using an
  74      existing one.  This is useful for special pointer assignments like
  75      rank remapping where we have to process the descriptor before
  76      assigning to final one.  */
  77   unsigned byref_noassign:1;
  78
  79   /* Ignore absent optional arguments.  Used for some intrinsics.  */
  80   unsigned ignore_optional:1;
  81
  82   /* When this is set the data and offset fields of the returned descriptor
  83      are NULL.  Used by intrinsic size.  */
  84   unsigned data_not_needed:1;
  85
  86   /* If set, gfc_conv_procedure_call does not put byref calls into se->pre.  */
  87   unsigned no_function_call:1;
  88
  89   /* If set, we will force the creation of a temporary. Useful to disable
  90      non-copying procedure argument passing optimizations, when some function
  91      args alias.  */
  92   unsigned force_tmp:1;
  93
  94   /* Unconditionally calculate offset for array segments and constant
  95      arrays in gfc_conv_expr_descriptor.  */
  96   unsigned use_offset:1;
  97
  98   unsigned want_coarray:1;
  99
 100   /* Scalarization parameters.  */
 101   struct gfc_se *parent;
 102   struct gfc_ss *ss;
 103   struct gfc_loopinfo *loop;
 104 }
 105 gfc_se;
 106
 107
 108 /* Denotes different types of coarray.
 109    Please keep in sync with libgfortran/caf/libcaf.h.  */
 110 enum gfc_coarray_regtype
 111 {
 112   GFC_CAF_COARRAY_STATIC,
 113   GFC_CAF_COARRAY_ALLOC,
 114   GFC_CAF_LOCK_STATIC,
 115   GFC_CAF_LOCK_ALLOC,
 116   GFC_CAF_CRITICAL,
 117   GFC_CAF_EVENT_STATIC,
 118   GFC_CAF_EVENT_ALLOC,
 119   GFC_CAF_COARRAY_ALLOC_REGISTER_ONLY,
 120   GFC_CAF_COARRAY_ALLOC_ALLOCATE_ONLY
 121 };
 122
 123
 124 /* Describes the action to take on _caf_deregister.  Keep in sync with
 125    gcc/fortran/trans.h.  The negative values are not valid for the library and
 126    are used by the drivers for building the correct call.  */
 127 enum gfc_coarray_deregtype {
 128   /* This is no coarray, i.e. build a call to a free ().  */
 129   GFC_CAF_COARRAY_NOCOARRAY = -2,
 130   /* The driver is to analyze which _caf_deregister ()-call to generate.  */
 131   GFC_CAF_COARRAY_ANALYZE = -1,
 132   GFC_CAF_COARRAY_DEREGISTER = 0,
 133   GFC_CAF_COARRAY_DEALLOCATE_ONLY
 134 };
 135
 136
 137 /* Specify the type of ref handed to the caf communication functions.
 138    Please keep in sync with libgfortran/caf/libcaf.h.  */
 139 enum gfc_caf_ref_type_t {
 140   GFC_CAF_REF_COMPONENT,
 141   GFC_CAF_REF_ARRAY,
 142   GFC_CAF_REF_STATIC_ARRAY
 143 };
 144
 145
 146 /* Give the reference type of an array ref.
 147    Please keep in sync with libgfortran/caf/libcaf.h.  */
 148 enum gfc_caf_array_ref_t {
 149   GFC_CAF_ARR_REF_NONE = 0,
 150   GFC_CAF_ARR_REF_VECTOR,
 151   GFC_CAF_ARR_REF_FULL,
 152   GFC_CAF_ARR_REF_RANGE,
 153   GFC_CAF_ARR_REF_SINGLE,
 154   GFC_CAF_ARR_REF_OPEN_END,
 155   GFC_CAF_ARR_REF_OPEN_START
 156 };
 157
 158
 159 /* trans-array (structure_alloc_comps) caf_mode bits.  */
 160 enum gfc_structure_caf_mode_t {
 161   GFC_STRUCTURE_CAF_MODE_ENABLE_COARRAY = 1 << 0,
 162   GFC_STRUCTURE_CAF_MODE_IN_COARRAY = 1 << 1,
 163   GFC_STRUCTURE_CAF_MODE_DEALLOC_ONLY = 1 << 2
 164 };
 165
 166
 167 /* The array-specific scalarization information.  The array members of
 168    this struct are indexed by actual array index, and thus can be sparse.  */
 169
 170 typedef struct gfc_array_info
 171 {
 172   mpz_t *shape;
 173
 174   /* The ref that holds information on this section.  */
 175   gfc_ref *ref;
 176   /* The descriptor of this array.  */
 177   tree descriptor;
 178   /* holds the pointer to the data array.  */
 179   tree data;
 180   /* To move some of the array index calculation out of the innermost loop.  */
 181   tree offset;
 182   tree saved_offset;
 183   tree stride0;
 184   /* Holds the SS for a subscript.  Indexed by actual dimension.  */
 185   struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
 186
 187   /* stride and delta are used to access this inside a scalarization loop.
 188      start is used in the calculation of these.  Indexed by scalarizer
 189      dimension.  */
 190   tree start[GFC_MAX_DIMENSIONS];
 191   tree end[GFC_MAX_DIMENSIONS];
 192   tree stride[GFC_MAX_DIMENSIONS];
 193   tree delta[GFC_MAX_DIMENSIONS];
 194 }
 195 gfc_array_info;
 196
 197 enum gfc_ss_type
 198 {
 199   /* A scalar value.  This will be evaluated before entering the
 200      scalarization loop.  */
 201   GFC_SS_SCALAR,
 202
 203   /* Like GFC_SS_SCALAR it evaluates the expression outside the
 204      loop.  Is always evaluated as a reference to the temporary, unless
 205      temporary evaluation can result in a NULL pointer dereferencing (case of
 206      optional arguments).  Used for elemental function arguments.  */
 207   GFC_SS_REFERENCE,
 208
 209   /* An array section.  Scalarization indices will be substituted during
 210      expression translation.  */
 211   GFC_SS_SECTION,
 212
 213   /* A non-elemental function call returning an array.  The call is executed
 214      before entering the scalarization loop, storing the result in a
 215      temporary.  This temporary is then used inside the scalarization loop.
 216      Simple assignments, e.g. a(:) = fn(), are handled without a temporary
 217      as a special case.  */
 218   GFC_SS_FUNCTION,
 219
 220   /* An array constructor.  The current implementation is sub-optimal in
 221      many cases.  It allocated a temporary, assigns the values to it, then
 222      uses this temporary inside the scalarization loop.  */
 223   GFC_SS_CONSTRUCTOR,
 224
 225   /* A vector subscript.  The vector's descriptor is cached in the
 226      "descriptor" field of the associated gfc_ss_info.  */
 227   GFC_SS_VECTOR,
 228
 229   /* A temporary array allocated by the scalarizer.  Its rank can be less
 230      than that of the assignment expression.  */
 231   GFC_SS_TEMP,
 232
 233   /* An intrinsic function call.  Many intrinsic functions which map directly
 234      to library calls are created as GFC_SS_FUNCTION nodes.  */
 235   GFC_SS_INTRINSIC,
 236
 237   /* A component of a derived type.  */
 238   GFC_SS_COMPONENT
 239 };
 240
 241
 242 typedef struct gfc_ss_info
 243 {
 244   int refcount;
 245   gfc_ss_type type;
 246   gfc_expr *expr;
 247   tree string_length;
 248
 249   union
 250   {
 251     /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE.  */
 252     struct
 253     {
 254       /* If the scalar is passed as actual argument to an (elemental) procedure,
 255          this is the symbol of the corresponding dummy argument.  */
 256       gfc_symbol *dummy_arg;
 257       tree value;
 258       /* Tells that the scalar is a reference to a variable that might
 259          be present on the lhs, so that we should evaluate the value
 260          itself before the loop, not just the reference.  */
 261       unsigned needs_temporary:1;
 262     }
 263     scalar;
 264
 265     /* GFC_SS_TEMP.  */
 266     struct
 267     {
 268       tree type;
 269     }
 270     temp;
 271
 272     /* All other types.  */
 273     gfc_array_info array;
 274   }
 275   data;
 276
 277   /* This is used by assignments requiring temporaries.  The bits specify which
 278      loops the terms appear in.  This will be 1 for the RHS expressions,
 279      2 for the LHS expressions, and 3(=1|2) for the temporary.  */
 280   unsigned useflags:2;
 281
 282   /* Suppresses precalculation of scalars in WHERE assignments.  */
 283   unsigned where:1;
 284
 285   /* This set for an elemental function that contains expressions for
 286      external arrays, thereby triggering creation of a temporary.  */
 287   unsigned array_outer_dependency:1;
 288
 289   /* Tells whether the SS is for an actual argument which can be a NULL
 290      reference.  In other words, the associated dummy argument is OPTIONAL.
 291      Used to handle elemental procedures.  */
 292   bool can_be_null_ref;
 293 }
 294 gfc_ss_info;
 295
 296 #define gfc_get_ss_info() XCNEW (gfc_ss_info)
 297
 298
 299 /* Scalarization State chain.  Created by walking an expression tree before
 300    creating the scalarization loops.  Then passed as part of a gfc_se structure
 301    to translate the expression inside the loop.  Note that these chains are
 302    terminated by gfc_ss_terminator, not NULL.  A NULL pointer in a gfc_se
 303    indicates to gfc_conv_* that this is a scalar expression.
 304    SS structures can only belong to a single loopinfo.  They must be added
 305    otherwise they will not get freed.  */
 306
 307 typedef struct gfc_ss
 308 {
 309   gfc_ss_info *info;
 310
 311   int dimen;
 312   /* Translation from loop dimensions to actual array dimensions.
 313      actual_dim = dim[loop_dim]  */
 314   int dim[GFC_MAX_DIMENSIONS];
 315
 316   /* All the SS in a loop and linked through loop_chain.  The SS for an
 317      expression are linked by the next pointer.  */
 318   struct gfc_ss *loop_chain;
 319   struct gfc_ss *next;
 320
 321   /* Non-null if the ss is part of a nested loop.  */
 322   struct gfc_ss *parent;
 323
 324   /* If the evaluation of an expression requires a nested loop (for example
 325      if the sum intrinsic is evaluated inline), this points to the nested
 326      loop's gfc_ss.  */
 327   struct gfc_ss *nested_ss;
 328
 329   /* The loop this gfc_ss is in.  */
 330   struct gfc_loopinfo *loop;
 331
 332   unsigned is_alloc_lhs:1;
 333   unsigned no_bounds_check:1;
 334 }
 335 gfc_ss;
 336 #define gfc_get_ss() XCNEW (gfc_ss)
 337
 338 /* The contents of this aren't actually used.  A NULL SS chain indicates a
 339    scalar expression, so this pointer is used to terminate SS chains.  */
 340 extern gfc_ss * const gfc_ss_terminator;
 341
 342 /* Holds information about an expression while it is being scalarized.  */
 343 typedef struct gfc_loopinfo
 344 {
 345   stmtblock_t pre;
 346   stmtblock_t post;
 347
 348   int dimen;
 349
 350   /* All the SS involved with this loop.  */
 351   gfc_ss *ss;
 352   /* The SS describing the temporary used in an assignment.  */
 353   gfc_ss *temp_ss;
 354
 355   /* Non-null if this loop is nested in another one.  */
 356   struct gfc_loopinfo *parent;
 357
 358   /* Chain of nested loops.  */
 359   struct gfc_loopinfo *nested, *next;
 360
 361   /* The scalarization loop index variables.  */
 362   tree loopvar[GFC_MAX_DIMENSIONS];
 363
 364   /* The bounds of the scalarization loops.  */
 365   tree from[GFC_MAX_DIMENSIONS];
 366   tree to[GFC_MAX_DIMENSIONS];
 367   gfc_ss *specloop[GFC_MAX_DIMENSIONS];
 368
 369   /* The code member contains the code for the body of the next outer loop.  */
 370   stmtblock_t code[GFC_MAX_DIMENSIONS];
 371
 372   /* Order in which the dimensions should be looped, innermost first.  */
 373   int order[GFC_MAX_DIMENSIONS];
 374
 375   /* Enum to control loop reversal.  */
 376   gfc_reverse reverse[GFC_MAX_DIMENSIONS];
 377
 378   /* The number of dimensions for which a temporary is used.  */
 379   int temp_dim;
 380
 381   /* If set we don't need the loop variables.  */
 382   unsigned array_parameter:1;
 383 }
 384 gfc_loopinfo;
 385
 386 #define gfc_get_loopinfo() XCNEW (gfc_loopinfo)
 387
 388 /* Information about a symbol that has been shadowed by a temporary.  */
 389 typedef struct
 390 {
 391   symbol_attribute attr;
 392   tree decl;
 393 }
 394 gfc_saved_var;
 395
 396
 397 /* Store information about a block of code together with special
 398    initialization and clean-up code.  This can be used to incrementally add
 399    init and cleanup, and in the end put everything together to a
 400    try-finally expression.  */
 401 typedef struct
 402 {
 403   tree init;
 404   tree cleanup;
 405   tree code;
 406 }
 407 gfc_wrapped_block;
 408
 409 /* Class API functions.  */
 410 tree gfc_class_set_static_fields (tree, tree, tree);
 411 tree gfc_class_data_get (tree);
 412 tree gfc_class_vptr_get (tree);
 413 tree gfc_class_len_get (tree);
 414 tree gfc_class_len_or_zero_get (tree);
 415 gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *);
 416 /* Get an accessor to the class' vtab's * field, when a class handle is
 417    available.  */
 418 tree gfc_class_vtab_hash_get (tree);
 419 tree gfc_class_vtab_size_get (tree);
 420 tree gfc_class_vtab_extends_get (tree);
 421 tree gfc_class_vtab_def_init_get (tree);
 422 tree gfc_class_vtab_copy_get (tree);
 423 tree gfc_class_vtab_final_get (tree);
 424 /* Get an accessor to the vtab's * field, when a vptr handle is present.  */
 425 tree gfc_vtpr_hash_get (tree);
 426 tree gfc_vptr_size_get (tree);
 427 tree gfc_vptr_extends_get (tree);
 428 tree gfc_vptr_def_init_get (tree);
 429 tree gfc_vptr_copy_get (tree);
 430 tree gfc_vptr_final_get (tree);
 431 tree gfc_vptr_deallocate_get (tree);
 432 void gfc_reset_vptr (stmtblock_t *, gfc_expr *);
 433 void gfc_reset_len (stmtblock_t *, gfc_expr *);
 434 tree gfc_get_vptr_from_expr (tree);
 435 tree gfc_get_class_array_ref (tree, tree, tree, bool);
 436 tree gfc_copy_class_to_class (tree, tree, tree, bool);
 437 bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *);
 438 bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool);
 439
 440 void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool,
 441                                 bool);
 442 void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool,
 443                               bool, bool);
 444
 445 /* Initialize an init/cleanup block.  */
 446 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
 447 /* Add a pair of init/cleanup code to the block.  Each one might be a
 448    NULL_TREE if not required.  */
 449 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
 450 /* Finalize the block, that is, create a single expression encapsulating the
 451    original code together with init and clean-up code.  */
 452 tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
 453
 454
 455 /* Advance the SS chain to the next term.  */
 456 void gfc_advance_se_ss_chain (gfc_se *);
 457
 458 /* Call this to initialize a gfc_se structure before use
 459    first parameter is structure to initialize, second is
 460    parent to get scalarization data from, or NULL.  */
 461 void gfc_init_se (gfc_se *, gfc_se *);
 462
 463 /* Create an artificial variable decl and add it to the current scope.  */
 464 tree gfc_create_var (tree, const char *);
 465 /* Like above but doesn't add it to the current scope.  */
 466 tree gfc_create_var_np (tree, const char *);
 467
 468 /* Store the result of an expression in a temp variable so it can be used
 469    repeatedly even if the original changes */
 470 void gfc_make_safe_expr (gfc_se * se);
 471
 472 /* Makes sure se is suitable for passing as a function string parameter.  */
 473 void gfc_conv_string_parameter (gfc_se * se);
 474
 475 /* Compare two strings.  */
 476 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
 477
 478 /* When using the gfc_conv_* make sure you understand what they do, i.e.
 479    when a POST chain may be created, and what the returned expression may be
 480    used for.  Note that character strings have special handling.  This
 481    should not be a problem as most statements/operations only deal with
 482    numeric/logical types.  See the implementations in trans-expr.c
 483    for details of the individual functions.  */
 484
 485 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
 486 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
 487 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
 488 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
 489 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
 490
 491
 492 /* trans-expr.c */
 493 tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute);
 494 tree gfc_get_ultimate_alloc_ptr_comps_caf_token (gfc_se *, gfc_expr *);
 495 void gfc_conv_scalar_char_value (gfc_symbol *sym, gfc_se *se, gfc_expr **expr);
 496 tree gfc_string_to_single_character (tree len, tree str, int kind);
 497 tree gfc_get_tree_for_caf_expr (gfc_expr *);
 498 void gfc_get_caf_token_offset (gfc_se*, tree *, tree *, tree, tree, gfc_expr *);
 499 tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree);
 500
 501 /* Find the decl containing the auxiliary variables for assigned variables.  */
 502 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
 503 /* If the value is not constant, Create a temporary and copy the value.  */
 504 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
 505 tree gfc_evaluate_now (tree, stmtblock_t *);
 506
 507 /* Find the appropriate variant of a math intrinsic.  */
 508 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
 509
 510 tree size_of_string_in_bytes (int, tree);
 511
 512 /* Intrinsic procedure handling.  */
 513 tree gfc_conv_intrinsic_subroutine (gfc_code *);
 514 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
 515 bool gfc_conv_ieee_arithmetic_function (gfc_se *, gfc_expr *);
 516 tree gfc_save_fp_state (stmtblock_t *);
 517 void gfc_restore_fp_state (stmtblock_t *, tree);
 518
 519 bool gfc_expr_is_variable (gfc_expr *);
 520
 521 /* Does an intrinsic map directly to an external library call
 522    This is true for array-returning intrinsics, unless
 523    gfc_inline_intrinsic_function_p returns true.  */
 524 int gfc_is_intrinsic_libcall (gfc_expr *);
 525
 526 /* Used to call ordinary functions/subroutines
 527    and procedure pointer components.  */
 528 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
 529                              gfc_expr *, vec<tree, va_gc> *);
 530
 531 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool);
 532
 533 /* Generate code for a scalar assignment.  */
 534 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
 535                               bool c = false);
 536
 537 /* Translate COMMON blocks.  */
 538 void gfc_trans_common (gfc_namespace *);
 539
 540 /* Translate a derived type constructor.  */
 541 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
 542
 543 /* Return an expression which determines if a dummy parameter is present.  */
 544 tree gfc_conv_expr_present (gfc_symbol *);
 545 /* Convert a missing, dummy argument into a null or zero.  */
 546 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
 547
 548 /* Generate code to allocate a string temporary.  */
 549 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
 550 /* Get the string length variable belonging to an expression.  */
 551 tree gfc_get_expr_charlen (gfc_expr *);
 552 /* Initialize a string length variable.  */
 553 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
 554 /* Ensure type sizes can be gimplified.  */
 555 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
 556
 557 /* Add an expression to the end of a block.  */
 558 void gfc_add_expr_to_block (stmtblock_t *, tree);
 559 /* Add an expression to the beginning of a block.  */
 560 void gfc_prepend_expr_to_block (stmtblock_t *, tree);
 561 /* Add a block to the end of a block.  */
 562 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
 563 /* Add a MODIFY_EXPR to a block.  */
 564 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
 565 void gfc_add_modify (stmtblock_t *, tree, tree);
 566
 567 /* Initialize a statement block.  */
 568 void gfc_init_block (stmtblock_t *);
 569 /* Start a new statement block.  Like gfc_init_block but also starts a new
 570    variable scope.  */
 571 void gfc_start_block (stmtblock_t *);
 572 /* Finish a statement block.  Also closes the scope if the block was created
 573    with gfc_start_block.  */
 574 tree gfc_finish_block (stmtblock_t *);
 575 /* Merge the scope of a block with its parent.  */
 576 void gfc_merge_block_scope (stmtblock_t * block);
 577
 578 /* Return the backend label decl.  */
 579 tree gfc_get_label_decl (gfc_st_label *);
 580
 581 /* Return the decl for an external function.  */
 582 tree gfc_get_extern_function_decl (gfc_symbol *);
 583
 584 /* Return the decl for a function.  */
 585 tree gfc_get_function_decl (gfc_symbol *);
 586
 587 /* Build an ADDR_EXPR.  */
 588 tree gfc_build_addr_expr (tree, tree);
 589
 590 /* Build an ARRAY_REF.  */
 591 tree gfc_build_array_ref (tree, tree, tree, tree vptr = NULL_TREE);
 592
 593 /* Creates a label.  Decl is artificial if label_id == NULL_TREE.  */
 594 tree gfc_build_label_decl (tree);
 595
 596 /* Return the decl used to hold the function return value.
 597    Do not use if the function has an explicit result variable.  */
 598 tree gfc_get_fake_result_decl (gfc_symbol *, int);
 599
 600 /* Add a decl to the binding level for the current function.  */
 601 void gfc_add_decl_to_function (tree);
 602
 603 /* Make prototypes for runtime library functions.  */
 604 void gfc_build_builtin_function_decls (void);
 605
 606 /* Set the backend source location of a decl.  */
 607 void gfc_set_decl_location (tree, locus *);
 608
 609 /* Get a module symbol backend_decl if possible.  */
 610 bool gfc_get_module_backend_decl (gfc_symbol *);
 611
 612 /* Return the variable decl for a symbol.  */
 613 tree gfc_get_symbol_decl (gfc_symbol *);
 614
 615 /* Build a static initializer.  */
 616 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
 617
 618 /* Assign a default initializer to a derived type.  */
 619 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
 620
 621 /* Substitute a temporary variable in place of the real one.  */
 622 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
 623
 624 /* Restore the original variable.  */
 625 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
 626
 627 /* Setting a decl assembler name, mangling it according to target rules
 628    (like Windows @NN decorations).  */
 629 void gfc_set_decl_assembler_name (tree, tree);
 630
 631 /* Returns true if a variable of specified size should go on the stack.  */
 632 int gfc_can_put_var_on_stack (tree);
 633
 634 /* Set GFC_DECL_SCALAR_* on decl from sym if needed.  */
 635 void gfc_finish_decl_attrs (tree, symbol_attribute *);
 636
 637 /* Allocate the lang-specific part of a decl node.  */
 638 void gfc_allocate_lang_decl (tree);
 639
 640 /* Advance along a TREE_CHAIN.  */
 641 tree gfc_advance_chain (tree, int);
 642
 643 /* Create a decl for a function.  */
 644 void gfc_create_function_decl (gfc_namespace *, bool);
 645 /* Generate the code for a function.  */
 646 void gfc_generate_function_code (gfc_namespace *);
 647 /* Output a BLOCK DATA program unit.  */
 648 void gfc_generate_block_data (gfc_namespace *);
 649 /* Output a decl for a module variable.  */
 650 void gfc_generate_module_vars (gfc_namespace *);
 651 /* Get the appropriate return statement for a procedure.  */
 652 tree gfc_generate_return (void);
 653
 654 struct module_decl_hasher : ggc_ptr_hash<tree_node>
 655 {
 656   typedef const char *compare_type;
 657
 658   static hashval_t hash (tree);
 659   static bool equal (tree, const char *);
 660 };
 661
 662 struct GTY((for_user)) module_htab_entry {
 663   const char *name;
 664   tree namespace_decl;
 665   hash_table<module_decl_hasher> *GTY (()) decls;
 666 };
 667
 668 struct module_htab_entry *gfc_find_module (const char *);
 669 void gfc_module_add_decl (struct module_htab_entry *, tree);
 670
 671 /* Get and set the current location.  */
 672 void gfc_save_backend_locus (locus *);
 673 void gfc_set_backend_locus (locus *);
 674 void gfc_restore_backend_locus (locus *);
 675
 676 /* Handle static constructor functions.  */
 677 extern GTY(()) tree gfc_static_ctors;
 678 void gfc_generate_constructors (void);
 679
 680 /* Get the string length of an array constructor.  */
 681 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
 682
 683 /* Mark a condition as likely or unlikely.  */
 684 tree gfc_likely (tree, enum br_predictor);
 685 tree gfc_unlikely (tree, enum br_predictor);
 686
 687 /* Return the string length of a deferred character length component.  */
 688 bool gfc_deferred_strlen (gfc_component *, tree *);
 689
 690 /* Generate a runtime error call.  */
 691 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
 692
 693 /* Generate a runtime warning/error check.  */
 694 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
 695                               const char *, ...);
 696
 697 /* Generate a runtime check for same string length.  */
 698 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
 699                                   stmtblock_t*);
 700
 701 /* Generate a call to free().  */
 702 tree gfc_call_free (tree);
 703
 704 /* Allocate memory after performing a few checks.  */
 705 tree gfc_call_malloc (stmtblock_t *, tree, tree);
 706
 707 /* Build a memcpy call.  */
 708 tree gfc_build_memcpy_call (tree, tree, tree);
 709
 710 /* Register memory with the coarray library.  */
 711 void gfc_allocate_using_caf_lib (stmtblock_t *, tree, tree, tree, tree, tree,
 712                                  tree, gfc_coarray_regtype);
 713
 714 /* Allocate memory for allocatable variables, with optional status variable.  */
 715 void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree,
 716                                tree, tree, tree, gfc_expr*, int);
 717
 718 /* Allocate memory, with optional status variable.  */
 719 void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
 720
 721 /* Generate code to deallocate an array.  */
 722 tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool,
 723                                  gfc_expr *, int, tree a = NULL_TREE,
 724                                  tree c = NULL_TREE);
 725 tree gfc_deallocate_scalar_with_status (tree, tree, tree, bool, gfc_expr*,
 726                                         gfc_typespec, bool c = false);
 727
 728 /* Generate code to call realloc().  */
 729 tree gfc_call_realloc (stmtblock_t *, tree, tree);
 730
 731 /* Assign a derived type constructor to a variable.  */
 732 tree gfc_trans_structure_assign (tree, gfc_expr *, bool, bool c = false);
 733
 734 /* Generate code for an assignment, includes scalarization.  */
 735 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool, bool p = false,
 736                            bool a = true);
 737
 738 /* Generate code for a pointer assignment.  */
 739 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
 740
 741 /* Initialize function decls for library functions.  */
 742 void gfc_build_intrinsic_lib_fndecls (void);
 743 /* Create function decls for IO library functions.  */
 744 void gfc_build_io_library_fndecls (void);
 745 /* Build a function decl for a library function.  */
 746 tree gfc_build_library_function_decl (tree, tree, int, ...);
 747 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
 748                                                 tree rettype, int nargs, ...);
 749
 750 /* Process the local variable decls of a block construct.  */
 751 void gfc_process_block_locals (gfc_namespace*);
 752
 753 /* Output initialization/clean-up code that was deferred.  */
 754 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
 755
 756 /* In f95-lang.c.  */
 757 tree pushdecl (tree);
 758 tree pushdecl_top_level (tree);
 759 void pushlevel (void);
 760 tree poplevel (int, int);
 761 tree getdecls (void);
 762
 763 /* In trans-types.c.  */
 764 struct array_descr_info;
 765 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
 766
 767 /* In trans-openmp.c */
 768 bool gfc_omp_privatize_by_reference (const_tree);
 769 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
 770 tree gfc_omp_report_decl (tree);
 771 tree gfc_omp_clause_default_ctor (tree, tree, tree);
 772 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
 773 tree gfc_omp_clause_assign_op (tree, tree, tree);
 774 tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree);
 775 tree gfc_omp_clause_dtor (tree, tree);
 776 void gfc_omp_finish_clause (tree, gimple_seq *);
 777 bool gfc_omp_scalar_p (tree);
 778 bool gfc_omp_disregard_value_expr (tree, bool);
 779 bool gfc_omp_private_debug_clause (tree, bool);
 780 bool gfc_omp_private_outer_ref (tree);
 781 struct gimplify_omp_ctx;
 782 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
 783
 784 /* Runtime library function decls.  */
 785 extern GTY(()) tree gfor_fndecl_pause_numeric;
 786 extern GTY(()) tree gfor_fndecl_pause_string;
 787 extern GTY(()) tree gfor_fndecl_stop_numeric;
 788 extern GTY(()) tree gfor_fndecl_stop_string;
 789 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
 790 extern GTY(()) tree gfor_fndecl_error_stop_string;
 791 extern GTY(()) tree gfor_fndecl_runtime_error;
 792 extern GTY(()) tree gfor_fndecl_runtime_error_at;
 793 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
 794 extern GTY(()) tree gfor_fndecl_os_error;
 795 extern GTY(()) tree gfor_fndecl_generate_error;
 796 extern GTY(()) tree gfor_fndecl_set_fpe;
 797 extern GTY(()) tree gfor_fndecl_set_options;
 798 extern GTY(()) tree gfor_fndecl_ttynam;
 799 extern GTY(()) tree gfor_fndecl_ctime;
 800 extern GTY(()) tree gfor_fndecl_fdate;
 801 extern GTY(()) tree gfor_fndecl_in_pack;
 802 extern GTY(()) tree gfor_fndecl_in_unpack;
 803 extern GTY(()) tree gfor_fndecl_associated;
 804 extern GTY(()) tree gfor_fndecl_system_clock4;
 805 extern GTY(()) tree gfor_fndecl_system_clock8;
 806
 807
 808 /* Coarray run-time library function decls.  */
 809 extern GTY(()) tree gfor_fndecl_caf_init;
 810 extern GTY(()) tree gfor_fndecl_caf_finalize;
 811 extern GTY(()) tree gfor_fndecl_caf_this_image;
 812 extern GTY(()) tree gfor_fndecl_caf_num_images;
 813 extern GTY(()) tree gfor_fndecl_caf_register;
 814 extern GTY(()) tree gfor_fndecl_caf_deregister;
 815 extern GTY(()) tree gfor_fndecl_caf_get;
 816 extern GTY(()) tree gfor_fndecl_caf_send;
 817 extern GTY(()) tree gfor_fndecl_caf_sendget;
 818 extern GTY(()) tree gfor_fndecl_caf_get_by_ref;
 819 extern GTY(()) tree gfor_fndecl_caf_send_by_ref;
 820 extern GTY(()) tree gfor_fndecl_caf_sendget_by_ref;
 821 extern GTY(()) tree gfor_fndecl_caf_sync_all;
 822 extern GTY(()) tree gfor_fndecl_caf_sync_memory;
 823 extern GTY(()) tree gfor_fndecl_caf_sync_images;
 824 extern GTY(()) tree gfor_fndecl_caf_stop_numeric;
 825 extern GTY(()) tree gfor_fndecl_caf_stop_str;
 826 extern GTY(()) tree gfor_fndecl_caf_error_stop;
 827 extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
 828 extern GTY(()) tree gfor_fndecl_caf_atomic_def;
 829 extern GTY(()) tree gfor_fndecl_caf_atomic_ref;
 830 extern GTY(()) tree gfor_fndecl_caf_atomic_cas;
 831 extern GTY(()) tree gfor_fndecl_caf_atomic_op;
 832 extern GTY(()) tree gfor_fndecl_caf_lock;
 833 extern GTY(()) tree gfor_fndecl_caf_unlock;
 834 extern GTY(()) tree gfor_fndecl_caf_event_post;
 835 extern GTY(()) tree gfor_fndecl_caf_event_wait;
 836 extern GTY(()) tree gfor_fndecl_caf_event_query;
 837 extern GTY(()) tree gfor_fndecl_caf_fail_image;
 838 extern GTY(()) tree gfor_fndecl_caf_failed_images;
 839 extern GTY(()) tree gfor_fndecl_caf_image_status;
 840 extern GTY(()) tree gfor_fndecl_caf_stopped_images;
 841 extern GTY(()) tree gfor_fndecl_caf_form_team;
 842 extern GTY(()) tree gfor_fndecl_caf_change_team;
 843 extern GTY(()) tree gfor_fndecl_caf_end_team;
 844 extern GTY(()) tree gfor_fndecl_caf_get_team;
 845 extern GTY(()) tree gfor_fndecl_caf_sync_team;
 846 extern GTY(()) tree gfor_fndecl_caf_team_number;
 847 extern GTY(()) tree gfor_fndecl_co_broadcast;
 848 extern GTY(()) tree gfor_fndecl_co_max;
 849 extern GTY(()) tree gfor_fndecl_co_min;
 850 extern GTY(()) tree gfor_fndecl_co_reduce;
 851 extern GTY(()) tree gfor_fndecl_co_sum;
 852 extern GTY(()) tree gfor_fndecl_caf_is_present;
 853
 854 /* Math functions.  Many other math functions are handled in
 855    trans-intrinsic.c.  */
 856
 857 typedef struct GTY(()) gfc_powdecl_list {
 858   tree integer;
 859   tree real;
 860   tree cmplx;
 861 }
 862 gfc_powdecl_list;
 863
 864 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
 865 extern GTY(()) tree gfor_fndecl_math_ishftc4;
 866 extern GTY(()) tree gfor_fndecl_math_ishftc8;
 867 extern GTY(()) tree gfor_fndecl_math_ishftc16;
 868
 869 /* BLAS functions.  */
 870 extern GTY(()) tree gfor_fndecl_sgemm;
 871 extern GTY(()) tree gfor_fndecl_dgemm;
 872 extern GTY(()) tree gfor_fndecl_cgemm;
 873 extern GTY(()) tree gfor_fndecl_zgemm;
 874
 875 /* String functions.  */
 876 extern GTY(()) tree gfor_fndecl_compare_string;
 877 extern GTY(()) tree gfor_fndecl_concat_string;
 878 extern GTY(()) tree gfor_fndecl_string_len_trim;
 879 extern GTY(()) tree gfor_fndecl_string_index;
 880 extern GTY(()) tree gfor_fndecl_string_scan;
 881 extern GTY(()) tree gfor_fndecl_string_verify;
 882 extern GTY(()) tree gfor_fndecl_string_trim;
 883 extern GTY(()) tree gfor_fndecl_string_minmax;
 884 extern GTY(()) tree gfor_fndecl_adjustl;
 885 extern GTY(()) tree gfor_fndecl_adjustr;
 886 extern GTY(()) tree gfor_fndecl_select_string;
 887 extern GTY(()) tree gfor_fndecl_compare_string_char4;
 888 extern GTY(()) tree gfor_fndecl_concat_string_char4;
 889 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
 890 extern GTY(()) tree gfor_fndecl_string_index_char4;
 891 extern GTY(()) tree gfor_fndecl_string_scan_char4;
 892 extern GTY(()) tree gfor_fndecl_string_verify_char4;
 893 extern GTY(()) tree gfor_fndecl_string_trim_char4;
 894 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
 895 extern GTY(()) tree gfor_fndecl_adjustl_char4;
 896 extern GTY(()) tree gfor_fndecl_adjustr_char4;
 897 extern GTY(()) tree gfor_fndecl_select_string_char4;
 898
 899 /* Conversion between character kinds.  */
 900 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
 901 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
 902
 903 /* Other misc. runtime library functions.  */
 904 extern GTY(()) tree gfor_fndecl_size0;
 905 extern GTY(()) tree gfor_fndecl_size1;
 906 extern GTY(()) tree gfor_fndecl_iargc;
 907 extern GTY(()) tree gfor_fndecl_kill;
 908 extern GTY(()) tree gfor_fndecl_kill_sub;
 909
 910 /* Implemented in Fortran.  */
 911 extern GTY(()) tree gfor_fndecl_sc_kind;
 912 extern GTY(()) tree gfor_fndecl_si_kind;
 913 extern GTY(()) tree gfor_fndecl_sr_kind;
 914
 915 /* IEEE-related.  */
 916 extern GTY(()) tree gfor_fndecl_ieee_procedure_entry;
 917 extern GTY(()) tree gfor_fndecl_ieee_procedure_exit;
 918
 919 /* RANDOM_INIT.  */
 920 extern GTY(()) tree gfor_fndecl_random_init;
 921
 922 /* True if node is an integer constant.  */
 923 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
 924
 925 /* gfortran-specific declaration information, the _CONT versions denote
 926    arrays with CONTIGUOUS attribute.  */
 927
 928 #define GFC_DTYPE_ELEM_LEN 0
 929 #define GFC_DTYPE_VERSION 1
 930 #define GFC_DTYPE_RANK 2
 931 #define GFC_DTYPE_TYPE 3
 932 #define GFC_DTYPE_ATTRIBUTE 4
 933
 934 enum gfc_array_kind
 935 {
 936   GFC_ARRAY_UNKNOWN,
 937   GFC_ARRAY_ASSUMED_SHAPE,
 938   GFC_ARRAY_ASSUMED_SHAPE_CONT,
 939   GFC_ARRAY_ASSUMED_RANK,
 940   GFC_ARRAY_ASSUMED_RANK_CONT,
 941   GFC_ARRAY_ALLOCATABLE,
 942   GFC_ARRAY_POINTER,
 943   GFC_ARRAY_POINTER_CONT
 944 };
 945
 946 /* Array types only.  */
 947 struct GTY(())  lang_type        {
 948   int rank, corank;
 949   enum gfc_array_kind akind;
 950   tree lbound[GFC_MAX_DIMENSIONS];
 951   tree ubound[GFC_MAX_DIMENSIONS];
 952   tree stride[GFC_MAX_DIMENSIONS];
 953   tree size;
 954   tree offset;
 955   tree dtype;
 956   tree dataptr_type;
 957   tree span;
 958   tree base_decl[2];
 959   tree nonrestricted_type;
 960   tree caf_token;
 961   tree caf_offset;
 962 };
 963
 964 struct GTY(()) lang_decl {
 965   /* Dummy variables.  */
 966   tree saved_descriptor;
 967   /* Assigned integer nodes.  Stringlength is the IO format string's length.
 968      Addr is the address of the string or the target label. Stringlength is
 969      initialized to -2 and assigned to -1 when addr is assigned to the
 970      address of target label.  */
 971   tree stringlen;
 972   tree addr;
 973   tree span;
 974   /* For assumed-shape coarrays.  */
 975   tree token, caf_offset;
 976   unsigned int scalar_allocatable : 1;
 977   unsigned int scalar_pointer : 1;
 978 };
 979
 980
 981 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
 982 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
 983 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
 984 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
 985 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
 986 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
 987   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
 988 #define GFC_DECL_SCALAR_ALLOCATABLE(node) \
 989   (DECL_LANG_SPECIFIC (node)->scalar_allocatable)
 990 #define GFC_DECL_SCALAR_POINTER(node) \
 991   (DECL_LANG_SPECIFIC (node)->scalar_pointer)
 992 #define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
 993   (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
 994 #define GFC_DECL_GET_SCALAR_POINTER(node) \
 995   (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
 996 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
 997 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
 998 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
 999 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
1000 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
1001 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
1002 #define GFC_DECL_PTR_ARRAY_P(node) DECL_LANG_FLAG_6(node)
1003 #define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
1004 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
1005
1006 /* An array descriptor.  */
1007 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
1008 /* An array without a descriptor.  */
1009 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
1010 /* Fortran CLASS type.  */
1011 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
1012 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
1013    descriptorless array types.  */
1014 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
1015   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
1016 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
1017   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
1018 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
1019   (TYPE_LANG_SPECIFIC(node)->stride[dim])
1020 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
1021 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
1022 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
1023 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
1024 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
1025 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
1026 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
1027 /* Code should use gfc_get_dtype instead of accessing this directly.  It may
1028    not be known when the type is created.  */
1029 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
1030 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
1031   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
1032 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
1033 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
1034   (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
1035
1036
1037 /* Build an expression with void type.  */
1038 #define build1_v(code, arg) \
1039         fold_build1_loc (input_location, code, void_type_node, arg)
1040 #define build2_v(code, arg1, arg2) \
1041         fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
1042 #define build3_v(code, arg1, arg2, arg3) \
1043         fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
1044 #define build4_v(code, arg1, arg2, arg3, arg4) \
1045         build4_loc (input_location, code, void_type_node, arg1, arg2, \
1046                     arg3, arg4)
1047
1048 /* This group of functions allows a caller to evaluate an expression from
1049    the callee's interface.  It establishes a mapping between the interface's
1050    dummy arguments and the caller's actual arguments, then applies that
1051    mapping to a given gfc_expr.
1052
1053    You can initialize a mapping structure like so:
1054
1055        gfc_interface_mapping mapping;
1056        ...
1057        gfc_init_interface_mapping (&mapping);
1058
1059    You should then evaluate each actual argument into a temporary
1060    gfc_se structure, here called "se", and map the result to the
1061    dummy argument's symbol, here called "sym":
1062
1063        gfc_add_interface_mapping (&mapping, sym, &se);
1064
1065    After adding all mappings, you should call:
1066
1067        gfc_finish_interface_mapping (&mapping, pre, post);
1068
1069    where "pre" and "post" are statement blocks for initialization
1070    and finalization code respectively.  You can then evaluate an
1071    interface expression "expr" as follows:
1072
1073        gfc_apply_interface_mapping (&mapping, se, expr);
1074
1075    Once you've evaluated all expressions, you should free
1076    the mapping structure with:
1077
1078        gfc_free_interface_mapping (&mapping); */
1079
1080
1081 /* This structure represents a mapping from OLD to NEW, where OLD is a
1082    dummy argument symbol and NEW is a symbol that represents the value
1083    of an actual argument.  Mappings are linked together using NEXT
1084    (in no particular order).  */
1085 typedef struct gfc_interface_sym_mapping
1086 {
1087   struct gfc_interface_sym_mapping *next;
1088   gfc_symbol *old;
1089   gfc_symtree *new_sym;
1090   gfc_expr *expr;
1091 }
1092 gfc_interface_sym_mapping;
1093
1094
1095 /* This structure is used by callers to evaluate an expression from
1096    a callee's interface.  */
1097 typedef struct gfc_interface_mapping
1098 {
1099   /* Maps the interface's dummy arguments to the values that the caller
1100      is passing.  The whole list is owned by this gfc_interface_mapping.  */
1101   gfc_interface_sym_mapping *syms;
1102
1103   /* A list of gfc_charlens that were needed when creating copies of
1104      expressions.  The whole list is owned by this gfc_interface_mapping.  */
1105   gfc_charlen *charlens;
1106 }
1107 gfc_interface_mapping;
1108
1109 void gfc_init_interface_mapping (gfc_interface_mapping *);
1110 void gfc_free_interface_mapping (gfc_interface_mapping *);
1111 void gfc_add_interface_mapping (gfc_interface_mapping *,
1112                                 gfc_symbol *, gfc_se *, gfc_expr *);
1113 void gfc_finish_interface_mapping (gfc_interface_mapping *,
1114                                    stmtblock_t *, stmtblock_t *);
1115 void gfc_apply_interface_mapping (gfc_interface_mapping *,
1116                                   gfc_se *, gfc_expr *);
1117
1118
1119 /* Standard error messages used in all the trans-*.c files.  */
1120 extern const char gfc_msg_fault[];
1121 extern const char gfc_msg_wrong_return[];
1122
1123 #define OMPWS_WORKSHARE_FLAG    1       /* Set if in a workshare construct.  */
1124 #define OMPWS_CURR_SINGLEUNIT   2       /* Set if current gfc_code in workshare
1125                                            construct is not workshared.  */
1126 #define OMPWS_SCALARIZER_WS     4       /* Set if scalarizer should attempt
1127                                            to create parallel loops.  */
1128 #define OMPWS_SCALARIZER_BODY   8       /* Set if handling body of potential
1129                                            parallel loop.  */
1130 #define OMPWS_NOWAIT            16      /* Use NOWAIT on OMP_FOR.  */
1131 extern int ompws_flags;
1132
1133 #endif /* GFC_TRANS_H */