gcc/fortran/trans.h

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