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