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