gcc/fortran/trans.h

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