gcc/fortran/trans.h

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