gcc/fortran/trans.h

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