gcc/fortran/trans.h

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