OSDN Git Service

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