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   /* 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 corresponding dummy argument.  */
 270       gfc_dummy_arg *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_resize_class_size_with_len (stmtblock_t *, tree, tree);
 429 gfc_expr * gfc_find_and_cut_at_last_class_ref (gfc_expr *, bool is_mold = false,
 430                                                gfc_typespec **ts = NULL);
 431 /* Get an accessor to the class' vtab's * field, when a class handle is
 432    available.  */
 433 tree gfc_class_vtab_hash_get (tree);
 434 tree gfc_class_vtab_size_get (tree);
 435 tree gfc_class_vtab_def_init_get (tree);
 436 tree gfc_class_vtab_copy_get (tree);
 437 tree gfc_class_vtab_final_get (tree);
 438 /* Get an accessor to the vtab's * field, when a vptr handle is present.  */
 439 tree gfc_vptr_hash_get (tree);
 440 tree gfc_vptr_size_get (tree);
 441 tree gfc_vptr_def_init_get (tree);
 442 tree gfc_vptr_copy_get (tree);
 443 tree gfc_vptr_final_get (tree);
 444 tree gfc_vptr_deallocate_get (tree);
 445 void gfc_reset_vptr (stmtblock_t *, gfc_expr *);
 446 void gfc_reset_len (stmtblock_t *, gfc_expr *);
 447 tree gfc_get_class_from_gfc_expr (gfc_expr *);
 448 tree gfc_get_class_from_expr (tree);
 449 tree gfc_get_vptr_from_expr (tree);
 450 tree gfc_copy_class_to_class (tree, tree, tree, bool);
 451 bool gfc_add_finalizer_call (stmtblock_t *, gfc_expr *);
 452 bool gfc_add_comp_finalizer_call (stmtblock_t *, tree, gfc_component *, bool);
 453
 454 void gfc_conv_derived_to_class (gfc_se *, gfc_expr *, gfc_typespec, tree, bool,
 455                                 bool, tree *derived_array = NULL);
 456 void gfc_conv_class_to_class (gfc_se *, gfc_expr *, gfc_typespec, bool, bool,
 457                               bool, bool);
 458
 459 /* Initialize an init/cleanup block.  */
 460 void gfc_start_wrapped_block (gfc_wrapped_block* block, tree code);
 461 /* Add a pair of init/cleanup code to the block.  Each one might be a
 462    NULL_TREE if not required.  */
 463 void gfc_add_init_cleanup (gfc_wrapped_block* block, tree init, tree cleanup);
 464 /* Finalize the block, that is, create a single expression encapsulating the
 465    original code together with init and clean-up code.  */
 466 tree gfc_finish_wrapped_block (gfc_wrapped_block* block);
 467
 468
 469 /* Advance the SS chain to the next term.  */
 470 void gfc_advance_se_ss_chain (gfc_se *);
 471
 472 /* Call this to initialize a gfc_se structure before use
 473    first parameter is structure to initialize, second is
 474    parent to get scalarization data from, or NULL.  */
 475 void gfc_init_se (gfc_se *, gfc_se *);
 476
 477 /* Create an artificial variable decl and add it to the current scope.  */
 478 tree gfc_create_var (tree, const char *);
 479 /* Like above but doesn't add it to the current scope.  */
 480 tree gfc_create_var_np (tree, const char *);
 481
 482 /* Store the result of an expression in a temp variable so it can be used
 483    repeatedly even if the original changes */
 484 void gfc_make_safe_expr (gfc_se * se);
 485
 486 /* Makes sure se is suitable for passing as a function string parameter.  */
 487 void gfc_conv_string_parameter (gfc_se * se);
 488
 489 /* Compare two strings.  */
 490 tree gfc_build_compare_string (tree, tree, tree, tree, int, enum tree_code);
 491
 492 /* When using the gfc_conv_* make sure you understand what they do, i.e.
 493    when a POST chain may be created, and what the returned expression may be
 494    used for.  Note that character strings have special handling.  This
 495    should not be a problem as most statements/operations only deal with
 496    numeric/logical types.  See the implementations in trans-expr.cc
 497    for details of the individual functions.  */
 498
 499 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
 500 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
 501 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
 502 void gfc_conv_expr_reference (gfc_se * se, gfc_expr * expr);
 503 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
 504
 505
 506 /* trans-expr.cc */
 507 tree gfc_get_character_len_in_bytes (tree);
 508 tree gfc_conv_scalar_to_descriptor (gfc_se *, tree, symbol_attribute);
 509 tree gfc_get_ultimate_alloc_ptr_comps_caf_token (gfc_se *, gfc_expr *);
 510 tree gfc_string_to_single_character (tree len, tree str, int kind);
 511 tree gfc_get_tree_for_caf_expr (gfc_expr *);
 512 void gfc_get_caf_token_offset (gfc_se*, tree *, tree *, tree, tree, gfc_expr *);
 513 tree gfc_caf_get_image_index (stmtblock_t *, gfc_expr *, tree);
 514 void gfc_simple_for_loop (stmtblock_t *, tree, tree, tree, enum tree_code, tree,
 515                           tree);
 516
 517 /* Find the decl containing the auxiliary variables for assigned variables.  */
 518 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
 519 /* If the value is not constant, Create a temporary and copy the value.  */
 520 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
 521 tree gfc_evaluate_now (tree, stmtblock_t *);
 522 tree gfc_evaluate_now_function_scope (tree, stmtblock_t *);
 523
 524 /* Find the appropriate variant of a math intrinsic.  */
 525 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
 526
 527 tree size_of_string_in_bytes (int, tree);
 528
 529 /* Intrinsic procedure handling.  */
 530 tree gfc_conv_intrinsic_subroutine (gfc_code *);
 531 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
 532 bool gfc_conv_ieee_arithmetic_function (gfc_se *, gfc_expr *);
 533 tree gfc_save_fp_state (stmtblock_t *);
 534 void gfc_restore_fp_state (stmtblock_t *, tree);
 535
 536 bool gfc_expr_is_variable (gfc_expr *);
 537
 538 /* Does an intrinsic map directly to an external library call
 539    This is true for array-returning intrinsics, unless
 540    gfc_inline_intrinsic_function_p returns true.  */
 541 int gfc_is_intrinsic_libcall (gfc_expr *);
 542
 543 /* Used to call ordinary functions/subroutines
 544    and procedure pointer components.  */
 545 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
 546                              gfc_expr *, vec<tree, va_gc> *);
 547
 548 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool,
 549                                 const gfc_symbol *fsym = NULL,
 550                                 const char *proc_name = NULL,
 551                                 gfc_symbol *sym = NULL,
 552                                 bool check_contiguous = false);
 553
 554 void gfc_conv_is_contiguous_expr (gfc_se *, gfc_expr *);
 555
 556 /* Generate code for a scalar assignment.  */
 557 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
 558                               bool c = false);
 559
 560 /* Translate COMMON blocks.  */
 561 void gfc_trans_common (gfc_namespace *);
 562
 563 /* Translate a derived type constructor.  */
 564 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
 565
 566 /* Return an expression which determines if a dummy parameter is present.  */
 567 tree gfc_conv_expr_present (gfc_symbol *, bool use_saved_decl = false);
 568 /* Convert a missing, dummy argument into a null or zero.  */
 569 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
 570
 571 /* Lowering of component references.  */
 572 void gfc_conv_component_ref (gfc_se * se, gfc_ref * ref);
 573 void conv_parent_component_references (gfc_se * se, gfc_ref * ref);
 574
 575 /* Automatically dereference var.  */
 576 tree gfc_maybe_dereference_var (gfc_symbol *, tree, bool desc_only = false,
 577                                 bool is_classarray = false);
 578
 579 /* Generate code to allocate a string temporary.  */
 580 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
 581 /* Get the string length variable belonging to an expression.  */
 582 tree gfc_get_expr_charlen (gfc_expr *);
 583 /* Initialize a string length variable.  */
 584 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
 585 /* Ensure type sizes can be gimplified.  */
 586 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
 587
 588 /* Add an expression to the end of a block.  */
 589 void gfc_add_expr_to_block (stmtblock_t *, tree);
 590 /* Add an expression to the beginning of a block.  */
 591 void gfc_prepend_expr_to_block (stmtblock_t *, tree);
 592 /* Add a block to the end of a block.  */
 593 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
 594 /* Add a MODIFY_EXPR to a block.  */
 595 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
 596 void gfc_add_modify (stmtblock_t *, tree, tree);
 597
 598 /* Initialize a statement block.  */
 599 void gfc_init_block (stmtblock_t *);
 600 /* Start a new statement block.  Like gfc_init_block but also starts a new
 601    variable scope.  */
 602 void gfc_start_block (stmtblock_t *);
 603 /* Finish a statement block.  Also closes the scope if the block was created
 604    with gfc_start_block.  */
 605 tree gfc_finish_block (stmtblock_t *);
 606 /* Merge the scope of a block with its parent.  */
 607 void gfc_merge_block_scope (stmtblock_t * block);
 608
 609 /* Return the backend label decl.  */
 610 tree gfc_get_label_decl (gfc_st_label *);
 611
 612 /* Return the decl for an external function.  */
 613 tree gfc_get_extern_function_decl (gfc_symbol *,
 614                                    gfc_actual_arglist *args = NULL,
 615                                    const char *fnspec = NULL);
 616
 617 /* Build an ADDR_EXPR.  */
 618 tree gfc_build_addr_expr (tree, tree);
 619
 620 /* Build an ARRAY_REF.  */
 621 tree gfc_build_array_ref (tree, tree, tree,
 622                           bool non_negative_offset = false,
 623                           tree vptr = NULL_TREE);
 624
 625 /* Build an array ref using pointer arithmetic.  */
 626 tree gfc_build_spanned_array_ref (tree base, tree offset, tree span);
 627
 628 /* Creates a label.  Decl is artificial if label_id == NULL_TREE.  */
 629 tree gfc_build_label_decl (tree);
 630
 631 /* Return the decl used to hold the function return value.
 632    Do not use if the function has an explicit result variable.  */
 633 tree gfc_get_fake_result_decl (gfc_symbol *, int);
 634
 635 /* Add a decl to the binding level for the current function.  */
 636 void gfc_add_decl_to_function (tree);
 637
 638 /* Make prototypes for runtime library functions.  */
 639 void gfc_build_builtin_function_decls (void);
 640
 641 /* Set the backend source location of a decl.  */
 642 void gfc_set_decl_location (tree, locus *);
 643
 644 /* Get a module symbol backend_decl if possible.  */
 645 bool gfc_get_module_backend_decl (gfc_symbol *);
 646
 647 /* Return the variable decl for a symbol.  */
 648 tree gfc_get_symbol_decl (gfc_symbol *);
 649
 650 /* Build a static initializer.  */
 651 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
 652
 653 /* Assign a default initializer to a derived type.  */
 654 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
 655
 656 /* Substitute a temporary variable in place of the real one.  */
 657 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
 658
 659 /* Restore the original variable.  */
 660 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
 661
 662 /* Setting a decl assembler name, mangling it according to target rules
 663    (like Windows @NN decorations).  */
 664 void gfc_set_decl_assembler_name (tree, tree);
 665
 666 /* Returns true if a variable of specified size should go on the stack.  */
 667 int gfc_can_put_var_on_stack (tree);
 668
 669 /* Set GFC_DECL_SCALAR_* on decl from sym if needed.  */
 670 void gfc_finish_decl_attrs (tree, symbol_attribute *);
 671
 672 /* Allocate the lang-specific part of a decl node.  */
 673 void gfc_allocate_lang_decl (tree);
 674
 675 /* Get the location suitable for the ME from a gfortran locus; required to get
 676    the column number right.  */
 677 location_t gfc_get_location (locus *);
 678
 679 /* Advance along a TREE_CHAIN.  */
 680 tree gfc_advance_chain (tree, int);
 681
 682 /* Create a decl for a function.  */
 683 void gfc_create_function_decl (gfc_namespace *, bool);
 684 /* Generate the code for a function.  */
 685 void gfc_generate_function_code (gfc_namespace *);
 686 /* Output a BLOCK DATA program unit.  */
 687 void gfc_generate_block_data (gfc_namespace *);
 688 /* Output a decl for a module variable.  */
 689 void gfc_generate_module_vars (gfc_namespace *);
 690 /* Get the appropriate return statement for a procedure.  */
 691 tree gfc_generate_return (void);
 692
 693 struct module_decl_hasher : ggc_ptr_hash<tree_node>
 694 {
 695   typedef const char *compare_type;
 696
 697   static hashval_t hash (tree);
 698   static bool equal (tree, const char *);
 699 };
 700
 701 struct GTY((for_user)) module_htab_entry {
 702   const char *name;
 703   tree namespace_decl;
 704   hash_table<module_decl_hasher> *GTY (()) decls;
 705 };
 706
 707 struct module_htab_entry *gfc_find_module (const char *);
 708 void gfc_module_add_decl (struct module_htab_entry *, tree);
 709
 710 /* Get and set the current location.  */
 711 void gfc_save_backend_locus (locus *);
 712 void gfc_set_backend_locus (locus *);
 713 void gfc_restore_backend_locus (locus *);
 714
 715 /* Handle static constructor functions.  */
 716 extern GTY(()) tree gfc_static_ctors;
 717 void gfc_generate_constructors (void);
 718
 719 /* Get the string length of an array constructor.  */
 720 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
 721
 722 /* Mark a condition as likely or unlikely.  */
 723 tree gfc_likely (tree, enum br_predictor);
 724 tree gfc_unlikely (tree, enum br_predictor);
 725
 726 /* Return the string length of a deferred character length component.  */
 727 bool gfc_deferred_strlen (gfc_component *, tree *);
 728
 729 /* Generate a runtime error call.  */
 730 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
 731
 732 /* Generate a runtime warning/error check.  */
 733 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
 734                               const char *, ...);
 735
 736 /* Generate a runtime check for same string length.  */
 737 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
 738                                   stmtblock_t*);
 739
 740 /* Generate a call to free().  */
 741 tree gfc_call_free (tree);
 742
 743 /* Allocate memory after performing a few checks.  */
 744 tree gfc_call_malloc (stmtblock_t *, tree, tree);
 745
 746 /* Build a memcpy call.  */
 747 tree gfc_build_memcpy_call (tree, tree, tree);
 748
 749 /* Register memory with the coarray library.  */
 750 void gfc_allocate_using_caf_lib (stmtblock_t *, tree, tree, tree, tree, tree,
 751                                  tree, gfc_coarray_regtype);
 752
 753 /* Allocate memory for allocatable variables, with optional status variable.  */
 754 void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree,
 755                                tree, tree, tree, gfc_expr*, int);
 756
 757 /* Allocate memory, with optional status variable.  */
 758 void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
 759
 760 /* Generate code to deallocate an array.  */
 761 tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool,
 762                                  gfc_expr *, int, tree a = NULL_TREE,
 763                                  tree c = NULL_TREE);
 764 tree gfc_deallocate_scalar_with_status (tree, tree, tree, bool, gfc_expr*,
 765                                         gfc_typespec, bool c = false);
 766
 767 /* Generate code to call realloc().  */
 768 tree gfc_call_realloc (stmtblock_t *, tree, tree);
 769
 770 /* Assign a derived type constructor to a variable.  */
 771 tree gfc_trans_structure_assign (tree, gfc_expr *, bool, bool c = false);
 772
 773 /* Generate code for an assignment, includes scalarization.  */
 774 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool, bool p = false,
 775                            bool a = true);
 776
 777 /* Generate code for a pointer assignment.  */
 778 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
 779
 780 /* Initialize function decls for library functions.  */
 781 void gfc_build_intrinsic_lib_fndecls (void);
 782 /* Create function decls for IO library functions.  */
 783 void gfc_build_io_library_fndecls (void);
 784 /* Build a function decl for a library function.  */
 785 tree gfc_build_library_function_decl (tree, tree, int, ...);
 786 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
 787                                                 tree rettype, int nargs, ...);
 788
 789 /* Process the local variable decls of a block construct.  */
 790 void gfc_process_block_locals (gfc_namespace*);
 791
 792 /* Output initialization/clean-up code that was deferred.  */
 793 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
 794
 795 /* In f95-lang.cc.  */
 796 tree pushdecl (tree);
 797 tree pushdecl_top_level (tree);
 798 void pushlevel (void);
 799 tree poplevel (int, int);
 800 tree getdecls (void);
 801
 802 /* In trans-types.cc.  */
 803 struct array_descr_info;
 804 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
 805
 806 /* In trans-openmp.cc */
 807 bool gfc_omp_is_allocatable_or_ptr (const_tree);
 808 tree gfc_omp_check_optional_argument (tree, bool);
 809 tree gfc_omp_array_data (tree, bool);
 810 tree gfc_omp_array_size (tree, gimple_seq *);
 811 bool gfc_omp_privatize_by_reference (const_tree);
 812 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
 813 enum omp_clause_defaultmap_kind gfc_omp_predetermined_mapping (tree);
 814 tree gfc_omp_report_decl (tree);
 815 tree gfc_omp_clause_default_ctor (tree, tree, tree);
 816 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
 817 tree gfc_omp_clause_assign_op (tree, tree, tree);
 818 tree gfc_omp_clause_linear_ctor (tree, tree, tree, tree);
 819 tree gfc_omp_clause_dtor (tree, tree);
 820 void gfc_omp_finish_clause (tree, gimple_seq *, bool);
 821 bool gfc_omp_allocatable_p (tree);
 822 bool gfc_omp_scalar_p (tree, bool);
 823 bool gfc_omp_scalar_target_p (tree);
 824 bool gfc_omp_disregard_value_expr (tree, bool);
 825 bool gfc_omp_private_debug_clause (tree, bool);
 826 bool gfc_omp_private_outer_ref (tree);
 827 struct gimplify_omp_ctx;
 828 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
 829
 830 /* In trans-intrinsic.cc.  */
 831 void gfc_conv_intrinsic_mvbits (gfc_se *, gfc_actual_arglist *,
 832                                 gfc_loopinfo *);
 833
 834 /* Runtime library function decls.  */
 835 extern GTY(()) tree gfor_fndecl_pause_numeric;
 836 extern GTY(()) tree gfor_fndecl_pause_string;
 837 extern GTY(()) tree gfor_fndecl_stop_numeric;
 838 extern GTY(()) tree gfor_fndecl_stop_string;
 839 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
 840 extern GTY(()) tree gfor_fndecl_error_stop_string;
 841 extern GTY(()) tree gfor_fndecl_runtime_error;
 842 extern GTY(()) tree gfor_fndecl_runtime_error_at;
 843 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
 844 extern GTY(()) tree gfor_fndecl_os_error_at;
 845 extern GTY(()) tree gfor_fndecl_generate_error;
 846 extern GTY(()) tree gfor_fndecl_set_fpe;
 847 extern GTY(()) tree gfor_fndecl_set_options;
 848 extern GTY(()) tree gfor_fndecl_ttynam;
 849 extern GTY(()) tree gfor_fndecl_ctime;
 850 extern GTY(()) tree gfor_fndecl_fdate;
 851 extern GTY(()) tree gfor_fndecl_in_pack;
 852 extern GTY(()) tree gfor_fndecl_in_unpack;
 853 extern GTY(()) tree gfor_fndecl_associated;
 854 extern GTY(()) tree gfor_fndecl_system_clock4;
 855 extern GTY(()) tree gfor_fndecl_system_clock8;
 856
 857
 858 /* Coarray run-time library function decls.  */
 859 extern GTY(()) tree gfor_fndecl_caf_init;
 860 extern GTY(()) tree gfor_fndecl_caf_finalize;
 861 extern GTY(()) tree gfor_fndecl_caf_this_image;
 862 extern GTY(()) tree gfor_fndecl_caf_num_images;
 863 extern GTY(()) tree gfor_fndecl_caf_register;
 864 extern GTY(()) tree gfor_fndecl_caf_deregister;
 865 extern GTY(()) tree gfor_fndecl_caf_get;
 866 extern GTY(()) tree gfor_fndecl_caf_send;
 867 extern GTY(()) tree gfor_fndecl_caf_sendget;
 868 extern GTY(()) tree gfor_fndecl_caf_get_by_ref;
 869 extern GTY(()) tree gfor_fndecl_caf_send_by_ref;
 870 extern GTY(()) tree gfor_fndecl_caf_sendget_by_ref;
 871 extern GTY(()) tree gfor_fndecl_caf_sync_all;
 872 extern GTY(()) tree gfor_fndecl_caf_sync_memory;
 873 extern GTY(()) tree gfor_fndecl_caf_sync_images;
 874 extern GTY(()) tree gfor_fndecl_caf_stop_numeric;
 875 extern GTY(()) tree gfor_fndecl_caf_stop_str;
 876 extern GTY(()) tree gfor_fndecl_caf_error_stop;
 877 extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
 878 extern GTY(()) tree gfor_fndecl_caf_atomic_def;
 879 extern GTY(()) tree gfor_fndecl_caf_atomic_ref;
 880 extern GTY(()) tree gfor_fndecl_caf_atomic_cas;
 881 extern GTY(()) tree gfor_fndecl_caf_atomic_op;
 882 extern GTY(()) tree gfor_fndecl_caf_lock;
 883 extern GTY(()) tree gfor_fndecl_caf_unlock;
 884 extern GTY(()) tree gfor_fndecl_caf_event_post;
 885 extern GTY(()) tree gfor_fndecl_caf_event_wait;
 886 extern GTY(()) tree gfor_fndecl_caf_event_query;
 887 extern GTY(()) tree gfor_fndecl_caf_fail_image;
 888 extern GTY(()) tree gfor_fndecl_caf_failed_images;
 889 extern GTY(()) tree gfor_fndecl_caf_image_status;
 890 extern GTY(()) tree gfor_fndecl_caf_stopped_images;
 891 extern GTY(()) tree gfor_fndecl_caf_form_team;
 892 extern GTY(()) tree gfor_fndecl_caf_change_team;
 893 extern GTY(()) tree gfor_fndecl_caf_end_team;
 894 extern GTY(()) tree gfor_fndecl_caf_get_team;
 895 extern GTY(()) tree gfor_fndecl_caf_sync_team;
 896 extern GTY(()) tree gfor_fndecl_caf_team_number;
 897 extern GTY(()) tree gfor_fndecl_co_broadcast;
 898 extern GTY(()) tree gfor_fndecl_co_max;
 899 extern GTY(()) tree gfor_fndecl_co_min;
 900 extern GTY(()) tree gfor_fndecl_co_reduce;
 901 extern GTY(()) tree gfor_fndecl_co_sum;
 902 extern GTY(()) tree gfor_fndecl_caf_is_present;
 903
 904 /* Math functions.  Many other math functions are handled in
 905    trans-intrinsic.cc.  */
 906
 907 typedef struct GTY(()) gfc_powdecl_list {
 908   tree integer;
 909   tree real;
 910   tree cmplx;
 911 }
 912 gfc_powdecl_list;
 913
 914 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
 915 extern GTY(()) tree gfor_fndecl_math_ishftc4;
 916 extern GTY(()) tree gfor_fndecl_math_ishftc8;
 917 extern GTY(()) tree gfor_fndecl_math_ishftc16;
 918
 919 /* BLAS functions.  */
 920 extern GTY(()) tree gfor_fndecl_sgemm;
 921 extern GTY(()) tree gfor_fndecl_dgemm;
 922 extern GTY(()) tree gfor_fndecl_cgemm;
 923 extern GTY(()) tree gfor_fndecl_zgemm;
 924
 925 /* String functions.  */
 926 extern GTY(()) tree gfor_fndecl_compare_string;
 927 extern GTY(()) tree gfor_fndecl_concat_string;
 928 extern GTY(()) tree gfor_fndecl_string_len_trim;
 929 extern GTY(()) tree gfor_fndecl_string_index;
 930 extern GTY(()) tree gfor_fndecl_string_scan;
 931 extern GTY(()) tree gfor_fndecl_string_verify;
 932 extern GTY(()) tree gfor_fndecl_string_trim;
 933 extern GTY(()) tree gfor_fndecl_string_minmax;
 934 extern GTY(()) tree gfor_fndecl_adjustl;
 935 extern GTY(()) tree gfor_fndecl_adjustr;
 936 extern GTY(()) tree gfor_fndecl_select_string;
 937 extern GTY(()) tree gfor_fndecl_compare_string_char4;
 938 extern GTY(()) tree gfor_fndecl_concat_string_char4;
 939 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
 940 extern GTY(()) tree gfor_fndecl_string_index_char4;
 941 extern GTY(()) tree gfor_fndecl_string_scan_char4;
 942 extern GTY(()) tree gfor_fndecl_string_verify_char4;
 943 extern GTY(()) tree gfor_fndecl_string_trim_char4;
 944 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
 945 extern GTY(()) tree gfor_fndecl_adjustl_char4;
 946 extern GTY(()) tree gfor_fndecl_adjustr_char4;
 947 extern GTY(()) tree gfor_fndecl_select_string_char4;
 948
 949 /* Conversion between character kinds.  */
 950 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
 951 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
 952
 953 /* Other misc. runtime library functions.  */
 954 extern GTY(()) tree gfor_fndecl_iargc;
 955 extern GTY(()) tree gfor_fndecl_kill;
 956 extern GTY(()) tree gfor_fndecl_kill_sub;
 957 extern GTY(()) tree gfor_fndecl_is_contiguous0;
 958
 959 /* Implemented in Fortran.  */
 960 extern GTY(()) tree gfor_fndecl_sc_kind;
 961 extern GTY(()) tree gfor_fndecl_si_kind;
 962 extern GTY(()) tree gfor_fndecl_sr_kind;
 963
 964 /* IEEE-related.  */
 965 extern GTY(()) tree gfor_fndecl_ieee_procedure_entry;
 966 extern GTY(()) tree gfor_fndecl_ieee_procedure_exit;
 967
 968 /* RANDOM_INIT.  */
 969 extern GTY(()) tree gfor_fndecl_random_init;
 970 extern GTY(()) tree gfor_fndecl_caf_random_init;
 971
 972 /* True if node is an integer constant.  */
 973 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
 974
 975 /* gfortran-specific declaration information, the _CONT versions denote
 976    arrays with CONTIGUOUS attribute.  */
 977
 978 #define GFC_DTYPE_ELEM_LEN 0
 979 #define GFC_DTYPE_VERSION 1
 980 #define GFC_DTYPE_RANK 2
 981 #define GFC_DTYPE_TYPE 3
 982 #define GFC_DTYPE_ATTRIBUTE 4
 983
 984 enum gfc_array_kind
 985 {
 986   GFC_ARRAY_UNKNOWN,
 987   GFC_ARRAY_ASSUMED_SHAPE,
 988   GFC_ARRAY_ASSUMED_SHAPE_CONT,
 989   GFC_ARRAY_ASSUMED_RANK,
 990   GFC_ARRAY_ASSUMED_RANK_CONT,
 991   GFC_ARRAY_ALLOCATABLE,
 992   GFC_ARRAY_POINTER,
 993   GFC_ARRAY_POINTER_CONT
 994 };
 995
 996 /* Array types only.  */
 997 struct GTY(())  lang_type        {
 998   int rank, corank;
 999   enum gfc_array_kind akind;
1000   tree lbound[GFC_MAX_DIMENSIONS];
1001   tree ubound[GFC_MAX_DIMENSIONS];
1002   tree stride[GFC_MAX_DIMENSIONS];
1003   tree size;
1004   tree offset;
1005   tree dtype;
1006   tree dataptr_type;
1007   tree base_decl[2];
1008   tree nonrestricted_type;
1009   tree caf_token;
1010   tree caf_offset;
1011 };
1012
1013 struct GTY(()) lang_decl {
1014   /* Dummy variables.  */
1015   tree saved_descriptor;
1016   /* Assigned integer nodes.  Stringlength is the IO format string's length.
1017      Addr is the address of the string or the target label. Stringlength is
1018      initialized to -2 and assigned to -1 when addr is assigned to the
1019      address of target label.  */
1020   tree stringlen;
1021   tree addr;
1022   /* For assumed-shape coarrays.  */
1023   tree token, caf_offset;
1024   unsigned int scalar_allocatable : 1;
1025   unsigned int scalar_pointer : 1;
1026   unsigned int scalar_target : 1;
1027   unsigned int optional_arg : 1;
1028 };
1029
1030
1031 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
1032 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
1033 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
1034 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
1035 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
1036   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
1037 #define GFC_DECL_SCALAR_ALLOCATABLE(node) \
1038   (DECL_LANG_SPECIFIC (node)->scalar_allocatable)
1039 #define GFC_DECL_SCALAR_POINTER(node) \
1040   (DECL_LANG_SPECIFIC (node)->scalar_pointer)
1041 #define GFC_DECL_SCALAR_TARGET(node) \
1042   (DECL_LANG_SPECIFIC (node)->scalar_target)
1043 #define GFC_DECL_OPTIONAL_ARGUMENT(node) \
1044   (DECL_LANG_SPECIFIC (node)->optional_arg)
1045 #define GFC_DECL_GET_SCALAR_ALLOCATABLE(node) \
1046   (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_ALLOCATABLE (node) : 0)
1047 #define GFC_DECL_GET_SCALAR_POINTER(node) \
1048   (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_POINTER (node) : 0)
1049 #define GFC_DECL_GET_SCALAR_TARGET(node) \
1050   (DECL_LANG_SPECIFIC (node) ? GFC_DECL_SCALAR_TARGET (node) : 0)
1051 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
1052 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
1053 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
1054 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
1055 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
1056 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
1057 #define GFC_DECL_PTR_ARRAY_P(node) DECL_LANG_FLAG_6(node)
1058 #define GFC_DECL_ASSOCIATE_VAR_P(node) DECL_LANG_FLAG_7(node)
1059 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
1060
1061 /* An array descriptor.  */
1062 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
1063 /* An array without a descriptor.  */
1064 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
1065 /* Fortran CLASS type.  */
1066 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
1067 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
1068    descriptorless array types.  */
1069 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
1070   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
1071 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
1072   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
1073 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
1074   (TYPE_LANG_SPECIFIC(node)->stride[dim])
1075 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
1076 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
1077 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
1078 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
1079 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
1080 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
1081 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
1082 /* Code should use gfc_get_dtype instead of accessing this directly.  It may
1083    not be known when the type is created.  */
1084 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
1085 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
1086   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
1087 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
1088   (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
1089
1090
1091 /* Build an expression with void type.  */
1092 #define build1_v(code, arg) \
1093         fold_build1_loc (input_location, code, void_type_node, arg)
1094 #define build2_v(code, arg1, arg2) \
1095         fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
1096 #define build3_v(code, arg1, arg2, arg3) \
1097         fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
1098 #define build4_v(code, arg1, arg2, arg3, arg4) \
1099         build4_loc (input_location, code, void_type_node, arg1, arg2, \
1100                     arg3, arg4)
1101
1102 /* This group of functions allows a caller to evaluate an expression from
1103    the callee's interface.  It establishes a mapping between the interface's
1104    dummy arguments and the caller's actual arguments, then applies that
1105    mapping to a given gfc_expr.
1106
1107    You can initialize a mapping structure like so:
1108
1109        gfc_interface_mapping mapping;
1110        ...
1111        gfc_init_interface_mapping (&mapping);
1112
1113    You should then evaluate each actual argument into a temporary
1114    gfc_se structure, here called "se", and map the result to the
1115    dummy argument's symbol, here called "sym":
1116
1117        gfc_add_interface_mapping (&mapping, sym, &se);
1118
1119    After adding all mappings, you should call:
1120
1121        gfc_finish_interface_mapping (&mapping, pre, post);
1122
1123    where "pre" and "post" are statement blocks for initialization
1124    and finalization code respectively.  You can then evaluate an
1125    interface expression "expr" as follows:
1126
1127        gfc_apply_interface_mapping (&mapping, se, expr);
1128
1129    Once you've evaluated all expressions, you should free
1130    the mapping structure with:
1131
1132        gfc_free_interface_mapping (&mapping); */
1133
1134
1135 /* This structure represents a mapping from OLD to NEW, where OLD is a
1136    dummy argument symbol and NEW is a symbol that represents the value
1137    of an actual argument.  Mappings are linked together using NEXT
1138    (in no particular order).  */
1139 typedef struct gfc_interface_sym_mapping
1140 {
1141   struct gfc_interface_sym_mapping *next;
1142   gfc_symbol *old;
1143   gfc_symtree *new_sym;
1144   gfc_expr *expr;
1145 }
1146 gfc_interface_sym_mapping;
1147
1148
1149 /* This structure is used by callers to evaluate an expression from
1150    a callee's interface.  */
1151 typedef struct gfc_interface_mapping
1152 {
1153   /* Maps the interface's dummy arguments to the values that the caller
1154      is passing.  The whole list is owned by this gfc_interface_mapping.  */
1155   gfc_interface_sym_mapping *syms;
1156
1157   /* A list of gfc_charlens that were needed when creating copies of
1158      expressions.  The whole list is owned by this gfc_interface_mapping.  */
1159   gfc_charlen *charlens;
1160 }
1161 gfc_interface_mapping;
1162
1163 void gfc_init_interface_mapping (gfc_interface_mapping *);
1164 void gfc_free_interface_mapping (gfc_interface_mapping *);
1165 void gfc_add_interface_mapping (gfc_interface_mapping *,
1166                                 gfc_symbol *, gfc_se *, gfc_expr *);
1167 void gfc_apply_interface_mapping (gfc_interface_mapping *,
1168                                   gfc_se *, gfc_expr *);
1169
1170
1171 /* Standard error messages used in all the trans-*.c files.  */
1172 extern const char gfc_msg_fault[];
1173
1174 #define OMPWS_WORKSHARE_FLAG    1       /* Set if in a workshare construct.  */
1175 #define OMPWS_CURR_SINGLEUNIT   2       /* Set if current gfc_code in workshare
1176                                            construct is not workshared.  */
1177 #define OMPWS_SCALARIZER_WS     4       /* Set if scalarizer should attempt
1178                                            to create parallel loops.  */
1179 #define OMPWS_SCALARIZER_BODY   8       /* Set if handling body of potential
1180                                            parallel loop.  */
1181 #define OMPWS_NOWAIT            16      /* Use NOWAIT on OMP_FOR.  */
1182 extern int ompws_flags;
1183
1184 #endif /* GFC_TRANS_H */