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
 422 /* Find the decl containing the auxiliary variables for assigned variables.  */
 423 void gfc_conv_label_variable (gfc_se * se, gfc_expr * expr);
 424 /* If the value is not constant, Create a temporary and copy the value.  */
 425 tree gfc_evaluate_now_loc (location_t, tree, stmtblock_t *);
 426 tree gfc_evaluate_now (tree, stmtblock_t *);
 427
 428 /* Find the appropriate variant of a math intrinsic.  */
 429 tree gfc_builtin_decl_for_float_kind (enum built_in_function, int);
 430
 431 tree size_of_string_in_bytes (int, tree);
 432
 433 /* Intrinsic procedure handling.  */
 434 tree gfc_conv_intrinsic_subroutine (gfc_code *);
 435 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
 436
 437 /* Does an intrinsic map directly to an external library call
 438    This is true for array-returning intrinsics, unless
 439    gfc_inline_intrinsic_function_p returns true.  */
 440 int gfc_is_intrinsic_libcall (gfc_expr *);
 441
 442 /* Used to call ordinary functions/subroutines
 443    and procedure pointer components.  */
 444 int gfc_conv_procedure_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *,
 445                              gfc_expr *, vec<tree, va_gc> *);
 446
 447 void gfc_conv_subref_array_arg (gfc_se *, gfc_expr *, int, sym_intent, bool);
 448
 449 /* Generate code for a scalar assignment.  */
 450 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, gfc_typespec, bool, bool,
 451                               bool);
 452
 453 /* Translate COMMON blocks.  */
 454 void gfc_trans_common (gfc_namespace *);
 455
 456 /* Translate a derived type constructor.  */
 457 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
 458
 459 /* Return an expression which determines if a dummy parameter is present.  */
 460 tree gfc_conv_expr_present (gfc_symbol *);
 461 /* Convert a missing, dummy argument into a null or zero.  */
 462 void gfc_conv_missing_dummy (gfc_se *, gfc_expr *, gfc_typespec, int);
 463
 464 /* Generate code to allocate a string temporary.  */
 465 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
 466 /* Get the string length variable belonging to an expression.  */
 467 tree gfc_get_expr_charlen (gfc_expr *);
 468 /* Initialize a string length variable.  */
 469 void gfc_conv_string_length (gfc_charlen *, gfc_expr *, stmtblock_t *);
 470 /* Ensure type sizes can be gimplified.  */
 471 void gfc_trans_vla_type_sizes (gfc_symbol *, stmtblock_t *);
 472
 473 /* Add an expression to the end of a block.  */
 474 void gfc_add_expr_to_block (stmtblock_t *, tree);
 475 /* Add an expression to the beginning of a block.  */
 476 void gfc_prepend_expr_to_block (stmtblock_t *, tree);
 477 /* Add a block to the end of a block.  */
 478 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
 479 /* Add a MODIFY_EXPR to a block.  */
 480 void gfc_add_modify_loc (location_t, stmtblock_t *, tree, tree);
 481 void gfc_add_modify (stmtblock_t *, tree, tree);
 482
 483 /* Initialize a statement block.  */
 484 void gfc_init_block (stmtblock_t *);
 485 /* Start a new statement block.  Like gfc_init_block but also starts a new
 486    variable scope.  */
 487 void gfc_start_block (stmtblock_t *);
 488 /* Finish a statement block.  Also closes the scope if the block was created
 489    with gfc_start_block.  */
 490 tree gfc_finish_block (stmtblock_t *);
 491 /* Merge the scope of a block with its parent.  */
 492 void gfc_merge_block_scope (stmtblock_t * block);
 493
 494 /* Return the backend label decl.  */
 495 tree gfc_get_label_decl (gfc_st_label *);
 496
 497 /* Return the decl for an external function.  */
 498 tree gfc_get_extern_function_decl (gfc_symbol *);
 499
 500 /* Return the decl for a function.  */
 501 tree gfc_get_function_decl (gfc_symbol *);
 502
 503 /* Build an ADDR_EXPR.  */
 504 tree gfc_build_addr_expr (tree, tree);
 505
 506 /* Build an ARRAY_REF.  */
 507 tree gfc_build_array_ref (tree, tree, tree);
 508
 509 /* Creates a label.  Decl is artificial if label_id == NULL_TREE.  */
 510 tree gfc_build_label_decl (tree);
 511
 512 /* Return the decl used to hold the function return value.
 513    Do not use if the function has an explicit result variable.  */
 514 tree gfc_get_fake_result_decl (gfc_symbol *, int);
 515
 516 /* Add a decl to the binding level for the current function.  */
 517 void gfc_add_decl_to_function (tree);
 518
 519 /* Make prototypes for runtime library functions.  */
 520 void gfc_build_builtin_function_decls (void);
 521
 522 /* Set the backend source location of a decl.  */
 523 void gfc_set_decl_location (tree, locus *);
 524
 525 /* Get a module symbol backend_decl if possible.  */
 526 bool gfc_get_module_backend_decl (gfc_symbol *);
 527
 528 /* Return the variable decl for a symbol.  */
 529 tree gfc_get_symbol_decl (gfc_symbol *);
 530
 531 /* Build a static initializer.  */
 532 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool, bool);
 533
 534 /* Assign a default initializer to a derived type.  */
 535 void gfc_init_default_dt (gfc_symbol *, stmtblock_t *, bool);
 536
 537 /* Substitute a temporary variable in place of the real one.  */
 538 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
 539
 540 /* Restore the original variable.  */
 541 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
 542
 543 /* Setting a decl assembler name, mangling it according to target rules
 544    (like Windows @NN decorations).  */
 545 void gfc_set_decl_assembler_name (tree, tree);
 546
 547 /* Returns true if a variable of specified size should go on the stack.  */
 548 int gfc_can_put_var_on_stack (tree);
 549
 550 /* Allocate the lang-specific part of a decl node.  */
 551 void gfc_allocate_lang_decl (tree);
 552
 553 /* Advance along a TREE_CHAIN.  */
 554 tree gfc_advance_chain (tree, int);
 555
 556 /* Create a decl for a function.  */
 557 void gfc_create_function_decl (gfc_namespace *, bool);
 558 /* Generate the code for a function.  */
 559 void gfc_generate_function_code (gfc_namespace *);
 560 /* Output a BLOCK DATA program unit.  */
 561 void gfc_generate_block_data (gfc_namespace *);
 562 /* Output a decl for a module variable.  */
 563 void gfc_generate_module_vars (gfc_namespace *);
 564 /* Get the appropriate return statement for a procedure.  */
 565 tree gfc_generate_return (void);
 566
 567 struct GTY(()) module_htab_entry {
 568   const char *name;
 569   tree namespace_decl;
 570   htab_t GTY ((param_is (union tree_node))) decls;
 571 };
 572
 573 struct module_htab_entry *gfc_find_module (const char *);
 574 void gfc_module_add_decl (struct module_htab_entry *, tree);
 575
 576 /* Get and set the current location.  */
 577 void gfc_save_backend_locus (locus *);
 578 void gfc_set_backend_locus (locus *);
 579 void gfc_restore_backend_locus (locus *);
 580
 581 /* Handle static constructor functions.  */
 582 extern GTY(()) tree gfc_static_ctors;
 583 void gfc_generate_constructors (void);
 584
 585 /* Get the string length of an array constructor.  */
 586 bool get_array_ctor_strlen (stmtblock_t *, gfc_constructor_base, tree *);
 587
 588 /* Mark a condition as likely or unlikely.  */
 589 tree gfc_likely (tree, enum br_predictor);
 590 tree gfc_unlikely (tree, enum br_predictor);
 591
 592 /* Return the string length of a deferred character length component.  */
 593 bool gfc_deferred_strlen (gfc_component *, tree *);
 594
 595 /* Generate a runtime error call.  */
 596 tree gfc_trans_runtime_error (bool, locus*, const char*, ...);
 597
 598 /* Generate a runtime warning/error check.  */
 599 void gfc_trans_runtime_check (bool, bool, tree, stmtblock_t *, locus *,
 600                               const char *, ...);
 601
 602 /* Generate a runtime check for same string length.  */
 603 void gfc_trans_same_strlen_check (const char*, locus*, tree, tree,
 604                                   stmtblock_t*);
 605
 606 /* Generate a call to free() after checking that its arg is non-NULL.  */
 607 tree gfc_call_free (tree);
 608
 609 /* Allocate memory after performing a few checks.  */
 610 tree gfc_call_malloc (stmtblock_t *, tree, tree);
 611
 612 /* Build a memcpy call.  */
 613 tree gfc_build_memcpy_call (tree, tree, tree);
 614
 615 /* Allocate memory for allocatable variables, with optional status variable.  */
 616 void gfc_allocate_allocatable (stmtblock_t*, tree, tree, tree, tree,
 617                                tree, tree, tree, gfc_expr*);
 618
 619 /* Allocate memory, with optional status variable.  */
 620 void gfc_allocate_using_malloc (stmtblock_t *, tree, tree, tree);
 621
 622 /* Generate code to deallocate an array.  */
 623 tree gfc_deallocate_with_status (tree, tree, tree, tree, tree, bool,
 624                                  gfc_expr *, bool);
 625 tree gfc_deallocate_scalar_with_status (tree, tree, bool, gfc_expr*, gfc_typespec);
 626
 627 /* Generate code to call realloc().  */
 628 tree gfc_call_realloc (stmtblock_t *, tree, tree);
 629
 630 /* Generate code for an assignment, includes scalarization.  */
 631 tree gfc_trans_assignment (gfc_expr *, gfc_expr *, bool, bool);
 632
 633 /* Generate code for a pointer assignment.  */
 634 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
 635
 636 /* Initialize function decls for library functions.  */
 637 void gfc_build_intrinsic_lib_fndecls (void);
 638 /* Create function decls for IO library functions.  */
 639 void gfc_build_io_library_fndecls (void);
 640 /* Build a function decl for a library function.  */
 641 tree gfc_build_library_function_decl (tree, tree, int, ...);
 642 tree gfc_build_library_function_decl_with_spec (tree name, const char *spec,
 643                                                 tree rettype, int nargs, ...);
 644
 645 /* Process the local variable decls of a block construct.  */
 646 void gfc_process_block_locals (gfc_namespace*);
 647
 648 /* Output initialization/clean-up code that was deferred.  */
 649 void gfc_trans_deferred_vars (gfc_symbol*, gfc_wrapped_block *);
 650
 651 /* In f95-lang.c.  */
 652 tree pushdecl (tree);
 653 tree pushdecl_top_level (tree);
 654 void pushlevel (void);
 655 tree poplevel (int, int);
 656 tree getdecls (void);
 657
 658 /* In trans-types.c.  */
 659 struct array_descr_info;
 660 bool gfc_get_array_descr_info (const_tree, struct array_descr_info *);
 661
 662 /* In trans-openmp.c */
 663 bool gfc_omp_privatize_by_reference (const_tree);
 664 enum omp_clause_default_kind gfc_omp_predetermined_sharing (tree);
 665 tree gfc_omp_report_decl (tree);
 666 tree gfc_omp_clause_default_ctor (tree, tree, tree);
 667 tree gfc_omp_clause_copy_ctor (tree, tree, tree);
 668 tree gfc_omp_clause_assign_op (tree, tree, tree);
 669 tree gfc_omp_clause_dtor (tree, tree);
 670 bool gfc_omp_disregard_value_expr (tree, bool);
 671 bool gfc_omp_private_debug_clause (tree, bool);
 672 bool gfc_omp_private_outer_ref (tree);
 673 struct gimplify_omp_ctx;
 674 void gfc_omp_firstprivatize_type_sizes (struct gimplify_omp_ctx *, tree);
 675
 676 /* Runtime library function decls.  */
 677 extern GTY(()) tree gfor_fndecl_pause_numeric;
 678 extern GTY(()) tree gfor_fndecl_pause_string;
 679 extern GTY(()) tree gfor_fndecl_stop_numeric;
 680 extern GTY(()) tree gfor_fndecl_stop_numeric_f08;
 681 extern GTY(()) tree gfor_fndecl_stop_string;
 682 extern GTY(()) tree gfor_fndecl_error_stop_numeric;
 683 extern GTY(()) tree gfor_fndecl_error_stop_string;
 684 extern GTY(()) tree gfor_fndecl_runtime_error;
 685 extern GTY(()) tree gfor_fndecl_runtime_error_at;
 686 extern GTY(()) tree gfor_fndecl_runtime_warning_at;
 687 extern GTY(()) tree gfor_fndecl_os_error;
 688 extern GTY(()) tree gfor_fndecl_generate_error;
 689 extern GTY(()) tree gfor_fndecl_set_fpe;
 690 extern GTY(()) tree gfor_fndecl_set_options;
 691 extern GTY(()) tree gfor_fndecl_ttynam;
 692 extern GTY(()) tree gfor_fndecl_ctime;
 693 extern GTY(()) tree gfor_fndecl_fdate;
 694 extern GTY(()) tree gfor_fndecl_in_pack;
 695 extern GTY(()) tree gfor_fndecl_in_unpack;
 696 extern GTY(()) tree gfor_fndecl_associated;
 697
 698
 699 /* Coarray run-time library function decls.  */
 700 extern GTY(()) tree gfor_fndecl_caf_init;
 701 extern GTY(()) tree gfor_fndecl_caf_finalize;
 702 extern GTY(()) tree gfor_fndecl_caf_this_image;
 703 extern GTY(()) tree gfor_fndecl_caf_num_images;
 704 extern GTY(()) tree gfor_fndecl_caf_register;
 705 extern GTY(()) tree gfor_fndecl_caf_deregister;
 706 extern GTY(()) tree gfor_fndecl_caf_critical;
 707 extern GTY(()) tree gfor_fndecl_caf_end_critical;
 708 extern GTY(()) tree gfor_fndecl_caf_sync_all;
 709 extern GTY(()) tree gfor_fndecl_caf_sync_images;
 710 extern GTY(()) tree gfor_fndecl_caf_error_stop;
 711 extern GTY(()) tree gfor_fndecl_caf_error_stop_str;
 712
 713
 714 /* Math functions.  Many other math functions are handled in
 715    trans-intrinsic.c.  */
 716
 717 typedef struct GTY(()) gfc_powdecl_list {
 718   tree integer;
 719   tree real;
 720   tree cmplx;
 721 }
 722 gfc_powdecl_list;
 723
 724 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[4][3];
 725 extern GTY(()) tree gfor_fndecl_math_ishftc4;
 726 extern GTY(()) tree gfor_fndecl_math_ishftc8;
 727 extern GTY(()) tree gfor_fndecl_math_ishftc16;
 728
 729 /* BLAS functions.  */
 730 extern GTY(()) tree gfor_fndecl_sgemm;
 731 extern GTY(()) tree gfor_fndecl_dgemm;
 732 extern GTY(()) tree gfor_fndecl_cgemm;
 733 extern GTY(()) tree gfor_fndecl_zgemm;
 734
 735 /* String functions.  */
 736 extern GTY(()) tree gfor_fndecl_compare_string;
 737 extern GTY(()) tree gfor_fndecl_concat_string;
 738 extern GTY(()) tree gfor_fndecl_string_len_trim;
 739 extern GTY(()) tree gfor_fndecl_string_index;
 740 extern GTY(()) tree gfor_fndecl_string_scan;
 741 extern GTY(()) tree gfor_fndecl_string_verify;
 742 extern GTY(()) tree gfor_fndecl_string_trim;
 743 extern GTY(()) tree gfor_fndecl_string_minmax;
 744 extern GTY(()) tree gfor_fndecl_adjustl;
 745 extern GTY(()) tree gfor_fndecl_adjustr;
 746 extern GTY(()) tree gfor_fndecl_select_string;
 747 extern GTY(()) tree gfor_fndecl_compare_string_char4;
 748 extern GTY(()) tree gfor_fndecl_concat_string_char4;
 749 extern GTY(()) tree gfor_fndecl_string_len_trim_char4;
 750 extern GTY(()) tree gfor_fndecl_string_index_char4;
 751 extern GTY(()) tree gfor_fndecl_string_scan_char4;
 752 extern GTY(()) tree gfor_fndecl_string_verify_char4;
 753 extern GTY(()) tree gfor_fndecl_string_trim_char4;
 754 extern GTY(()) tree gfor_fndecl_string_minmax_char4;
 755 extern GTY(()) tree gfor_fndecl_adjustl_char4;
 756 extern GTY(()) tree gfor_fndecl_adjustr_char4;
 757 extern GTY(()) tree gfor_fndecl_select_string_char4;
 758
 759 /* Conversion between character kinds.  */
 760 extern GTY(()) tree gfor_fndecl_convert_char1_to_char4;
 761 extern GTY(()) tree gfor_fndecl_convert_char4_to_char1;
 762
 763 /* Other misc. runtime library functions.  */
 764 extern GTY(()) tree gfor_fndecl_size0;
 765 extern GTY(()) tree gfor_fndecl_size1;
 766 extern GTY(()) tree gfor_fndecl_iargc;
 767
 768 /* Implemented in Fortran.  */
 769 extern GTY(()) tree gfor_fndecl_sc_kind;
 770 extern GTY(()) tree gfor_fndecl_si_kind;
 771 extern GTY(()) tree gfor_fndecl_sr_kind;
 772
 773
 774 /* True if node is an integer constant.  */
 775 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
 776
 777 /* gfortran-specific declaration information, the _CONT versions denote
 778    arrays with CONTIGUOUS attribute.  */
 779
 780 enum gfc_array_kind
 781 {
 782   GFC_ARRAY_UNKNOWN,
 783   GFC_ARRAY_ASSUMED_SHAPE,
 784   GFC_ARRAY_ASSUMED_SHAPE_CONT,
 785   GFC_ARRAY_ASSUMED_RANK,
 786   GFC_ARRAY_ASSUMED_RANK_CONT,
 787   GFC_ARRAY_ALLOCATABLE,
 788   GFC_ARRAY_POINTER,
 789   GFC_ARRAY_POINTER_CONT
 790 };
 791
 792 /* Array types only.  */
 793 /* FIXME: the variable_size annotation here is needed because these types are
 794    variable-sized in some other frontends.  Due to gengtype deficiency the GTY
 795    options of such types have to agree across all frontends. */
 796 struct GTY((variable_size))     lang_type        {
 797   int rank, corank;
 798   enum gfc_array_kind akind;
 799   tree lbound[GFC_MAX_DIMENSIONS];
 800   tree ubound[GFC_MAX_DIMENSIONS];
 801   tree stride[GFC_MAX_DIMENSIONS];
 802   tree size;
 803   tree offset;
 804   tree dtype;
 805   tree dataptr_type;
 806   tree span;
 807   tree base_decl[2];
 808   tree nonrestricted_type;
 809   tree caf_token;
 810   tree caf_offset;
 811 };
 812
 813 struct GTY((variable_size)) lang_decl {
 814   /* Dummy variables.  */
 815   tree saved_descriptor;
 816   /* Assigned integer nodes.  Stringlength is the IO format string's length.
 817      Addr is the address of the string or the target label. Stringlength is
 818      initialized to -2 and assigned to -1 when addr is assigned to the
 819      address of target label.  */
 820   tree stringlen;
 821   tree addr;
 822   tree span;
 823   /* For assumed-shape coarrays.  */
 824   tree token, caf_offset;
 825 };
 826
 827
 828 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
 829 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
 830 #define GFC_DECL_SPAN(node) DECL_LANG_SPECIFIC(node)->span
 831 #define GFC_DECL_TOKEN(node) DECL_LANG_SPECIFIC(node)->token
 832 #define GFC_DECL_CAF_OFFSET(node) DECL_LANG_SPECIFIC(node)->caf_offset
 833 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
 834   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
 835 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
 836 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
 837 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
 838 #define GFC_DECL_COMMON_OR_EQUIV(node) DECL_LANG_FLAG_3(node)
 839 #define GFC_DECL_CRAY_POINTEE(node) DECL_LANG_FLAG_4(node)
 840 #define GFC_DECL_RESULT(node) DECL_LANG_FLAG_5(node)
 841 #define GFC_DECL_SUBREF_ARRAY_P(node) DECL_LANG_FLAG_6(node)
 842 #define GFC_DECL_CLASS(node) DECL_LANG_FLAG_8(node)
 843
 844 /* An array descriptor.  */
 845 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
 846 /* An array without a descriptor.  */
 847 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
 848 /* Fortran POINTER type.  */
 849 #define GFC_POINTER_TYPE_P(node) TYPE_LANG_FLAG_3(node)
 850 /* Fortran CLASS type.  */
 851 #define GFC_CLASS_TYPE_P(node) TYPE_LANG_FLAG_4(node)
 852 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
 853    descriptorless array types.  */
 854 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
 855   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
 856 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
 857   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
 858 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
 859   (TYPE_LANG_SPECIFIC(node)->stride[dim])
 860 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
 861 #define GFC_TYPE_ARRAY_CORANK(node) (TYPE_LANG_SPECIFIC(node)->corank)
 862 #define GFC_TYPE_ARRAY_CAF_TOKEN(node) (TYPE_LANG_SPECIFIC(node)->caf_token)
 863 #define GFC_TYPE_ARRAY_CAF_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->caf_offset)
 864 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
 865 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
 866 #define GFC_TYPE_ARRAY_AKIND(node) (TYPE_LANG_SPECIFIC(node)->akind)
 867 /* Code should use gfc_get_dtype instead of accessing this directly.  It may
 868    not be known when the type is created.  */
 869 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
 870 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
 871   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
 872 #define GFC_TYPE_ARRAY_SPAN(node) (TYPE_LANG_SPECIFIC(node)->span)
 873 #define GFC_TYPE_ARRAY_BASE_DECL(node, internal) \
 874   (TYPE_LANG_SPECIFIC(node)->base_decl[(internal)])
 875
 876
 877 /* Build an expression with void type.  */
 878 #define build1_v(code, arg) \
 879         fold_build1_loc (input_location, code, void_type_node, arg)
 880 #define build2_v(code, arg1, arg2) \
 881         fold_build2_loc (input_location, code, void_type_node, arg1, arg2)
 882 #define build3_v(code, arg1, arg2, arg3) \
 883         fold_build3_loc (input_location, code, void_type_node, arg1, arg2, arg3)
 884 #define build4_v(code, arg1, arg2, arg3, arg4) \
 885         build4_loc (input_location, code, void_type_node, arg1, arg2, \
 886                     arg3, arg4)
 887
 888 /* This group of functions allows a caller to evaluate an expression from
 889    the callee's interface.  It establishes a mapping between the interface's
 890    dummy arguments and the caller's actual arguments, then applies that
 891    mapping to a given gfc_expr.
 892
 893    You can initialize a mapping structure like so:
 894
 895        gfc_interface_mapping mapping;
 896        ...
 897        gfc_init_interface_mapping (&mapping);
 898
 899    You should then evaluate each actual argument into a temporary
 900    gfc_se structure, here called "se", and map the result to the
 901    dummy argument's symbol, here called "sym":
 902
 903        gfc_add_interface_mapping (&mapping, sym, &se);
 904
 905    After adding all mappings, you should call:
 906
 907        gfc_finish_interface_mapping (&mapping, pre, post);
 908
 909    where "pre" and "post" are statement blocks for initialization
 910    and finalization code respectively.  You can then evaluate an
 911    interface expression "expr" as follows:
 912
 913        gfc_apply_interface_mapping (&mapping, se, expr);
 914
 915    Once you've evaluated all expressions, you should free
 916    the mapping structure with:
 917
 918        gfc_free_interface_mapping (&mapping); */
 919
 920
 921 /* This structure represents a mapping from OLD to NEW, where OLD is a
 922    dummy argument symbol and NEW is a symbol that represents the value
 923    of an actual argument.  Mappings are linked together using NEXT
 924    (in no particular order).  */
 925 typedef struct gfc_interface_sym_mapping
 926 {
 927   struct gfc_interface_sym_mapping *next;
 928   gfc_symbol *old;
 929   gfc_symtree *new_sym;
 930   gfc_expr *expr;
 931 }
 932 gfc_interface_sym_mapping;
 933
 934
 935 /* This structure is used by callers to evaluate an expression from
 936    a callee's interface.  */
 937 typedef struct gfc_interface_mapping
 938 {
 939   /* Maps the interface's dummy arguments to the values that the caller
 940      is passing.  The whole list is owned by this gfc_interface_mapping.  */
 941   gfc_interface_sym_mapping *syms;
 942
 943   /* A list of gfc_charlens that were needed when creating copies of
 944      expressions.  The whole list is owned by this gfc_interface_mapping.  */
 945   gfc_charlen *charlens;
 946 }
 947 gfc_interface_mapping;
 948
 949 void gfc_init_interface_mapping (gfc_interface_mapping *);
 950 void gfc_free_interface_mapping (gfc_interface_mapping *);
 951 void gfc_add_interface_mapping (gfc_interface_mapping *,
 952                                 gfc_symbol *, gfc_se *, gfc_expr *);
 953 void gfc_finish_interface_mapping (gfc_interface_mapping *,
 954                                    stmtblock_t *, stmtblock_t *);
 955 void gfc_apply_interface_mapping (gfc_interface_mapping *,
 956                                   gfc_se *, gfc_expr *);
 957
 958
 959 /* Standard error messages used in all the trans-*.c files.  */
 960 extern const char gfc_msg_fault[];
 961 extern const char gfc_msg_wrong_return[];
 962
 963 #define OMPWS_WORKSHARE_FLAG    1       /* Set if in a workshare construct.  */
 964 #define OMPWS_CURR_SINGLEUNIT   2       /* Set if current gfc_code in workshare
 965                                            construct is not workshared.  */
 966 #define OMPWS_SCALARIZER_WS     4       /* Set if scalarizer should attempt
 967                                            to create parallel loops.  */
 968 #define OMPWS_NOWAIT            8       /* Use NOWAIT on OMP_FOR.  */
 969 extern int ompws_flags;
 970
 971 #endif /* GFC_TRANS_H */