OSDN Git Service

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