gcc/fortran/trans.h

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