gcc/fortran/trans.h

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