gcc/fortran/trans.h

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