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