OSDN Git Service

fortran/
[pf3gnuchains/gcc-fork.git] / gcc / fortran / trans.h
1 /* Header for code translation functions
2    Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3    Contributed by Paul Brook
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
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 expresson */
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   /* Scalarization parameters.  */
71   struct gfc_se *parent;
72   struct gfc_ss *ss;
73   struct gfc_loopinfo *loop;
74 }
75 gfc_se;
76
77
78 /* Scalarisation State chain.  Created by walking an expression tree before
79    creating the scalarization loops. Then passed as part of a gfc_se structure
80    to translate the expression inside the loop.  Note that these chains are
81    terminated by gfc_se_terminator, not NULL.  A NULL pointer in a gfc_se
82    indicates to gfc_conv_* that this is a scalar expression.
83    Note that some member arrays correspond to scalarizer rank and others
84    are the variable rank.  */
85
86 typedef struct gfc_ss_info
87 {
88   int dimen;
89   /* The ref that holds information on this section.  */
90   gfc_ref *ref;
91   /* The descriptor of this array.  */
92   tree descriptor;
93   /* holds the pointer to the data array.  */
94   tree data;
95   /* To move some of the array index calculation out of the innermost loop.  */
96   tree offset;
97   tree saved_offset;
98   tree stride0;
99   /* Holds the SS for a subscript.  Indexed by actual dimension.  */
100   struct gfc_ss *subscript[GFC_MAX_DIMENSIONS];
101
102   /* stride and delta are used to access this inside a scalarization loop.
103      start is used in the calculation of these.  Indexed by scalarizer
104      dimension.  */
105   tree start[GFC_MAX_DIMENSIONS];
106   tree stride[GFC_MAX_DIMENSIONS];
107   tree delta[GFC_MAX_DIMENSIONS];
108
109   /* Translation from scalariser dimensions to actual dimensions.
110      actual = dim[scalarizer]  */
111   int dim[GFC_MAX_DIMENSIONS];
112 }
113 gfc_ss_info;
114
115 typedef enum
116 {
117   /* A scalar value.  This will be evaluated before entering the
118      scalarization loop.  */
119   GFC_SS_SCALAR,
120
121   /* Like GFC_SS_SCALAR except it evaluates a pointer the the expression.
122      Used for elemental function parameters.  */
123   GFC_SS_REFERENCE,
124
125   /* An array section.  Scalarization indices will be substituted during
126      expression translation.  */
127   GFC_SS_SECTION,
128
129   /* A non-elemental function call returning an array.  The call is executed
130      before entering the scalarization loop, storing the result in a
131      temporary.  This temporary is then used inside the scalarization loop.
132      Simple assignments, eg. a(:) = fn() are handles without a temporary
133      as a special case.  */
134   GFC_SS_FUNCTION,
135
136   /* An array constructor.  The current implementation is sub-optimal in
137      many cases.  It allocated a temporary, assigns the values to it, then
138      uses this temporary inside the scalarization loop.  */
139   GFC_SS_CONSTRUCTOR,
140
141   /* A vector subscript.  Only used as the SS chain for a subscript.
142      Similar int format to a GFC_SS_SECTION.  */
143   GFC_SS_VECTOR,
144
145   /* A temporary array allocated by the scalarizer.  Its rank can be less
146      than that of the assignment expression.  */
147   GFC_SS_TEMP,
148
149   /* An intrinsic function call.  Many intrinsic functions which map directly
150      to library calls are created as GFC_SS_FUNCTION nodes.  */
151   GFC_SS_INTRINSIC,
152   
153   /* A component of a derived type.  */
154   GFC_SS_COMPONENT
155 }
156 gfc_ss_type;
157
158 /* SS structures can only belong to a single loopinfo.  They must be added
159    otherwise they will not get freed.  */
160 typedef struct gfc_ss
161 {
162   gfc_ss_type type;
163   gfc_expr *expr;
164   mpz_t *shape;
165   tree string_length;
166   union
167   {
168     /* If type is GFC_SS_SCALAR or GFC_SS_REFERENCE.  */
169     struct
170     {
171       tree expr;
172     }
173     scalar;
174
175     /* GFC_SS_TEMP.  */
176     struct
177     {
178       /* The rank of the temporary.  May be less than the rank of the
179          assigned expression.  */
180       int dimen;
181       tree type;
182     }
183     temp;
184     /* All other types.  */
185     gfc_ss_info info;
186   }
187   data;
188
189   /* All the SS in a loop and linked through loop_chain.  The SS for an
190      expression are linked by the next pointer.  */
191   struct gfc_ss *loop_chain;
192   struct gfc_ss *next;
193
194   /* This is used by assignments requiring teporaries. The bits specify which
195      loops the terms appear in.  This will be 1 for the RHS expressions,
196      2 for the LHS expressions, and 3(=1|2) for the temporary.  */
197   unsigned useflags:2;
198 }
199 gfc_ss;
200 #define gfc_get_ss() gfc_getmem(sizeof(gfc_ss))
201
202 /* The contents of this aren't actualy used.  A NULL SS chain indicates a
203    scalar expression, so this pointer is used to terminate SS chains.  */
204 extern gfc_ss * const gfc_ss_terminator;
205
206 /* Holds information about an expression while it is being scalarized.  */
207 typedef struct gfc_loopinfo
208 {
209   stmtblock_t pre;
210   stmtblock_t post;
211
212   int dimen;
213
214   /* All the SS involved with this loop.  */
215   gfc_ss *ss;
216   /* The SS describing the teporary used in an assignment.  */
217   gfc_ss *temp_ss;
218
219   /* The scalarization loop index variables.  */
220   tree loopvar[GFC_MAX_DIMENSIONS];
221
222   /* The bounds of the scalarization loops.  */
223   tree from[GFC_MAX_DIMENSIONS];
224   tree to[GFC_MAX_DIMENSIONS];
225   gfc_ss *specloop[GFC_MAX_DIMENSIONS];
226
227   /* The code member contains the code for the body of the next outer loop.  */
228   stmtblock_t code[GFC_MAX_DIMENSIONS];
229
230   /* Order in which the dimensions should be looped, innermost first.  */
231   int order[GFC_MAX_DIMENSIONS];
232
233   /* The number of dimensions for which a temporary is used.  */
234   int temp_dim;
235
236   /* If set we don't need the loop variables.  */
237   unsigned array_parameter:1;
238 }
239 gfc_loopinfo;
240
241
242 /* Information about a symbol that has been shadowed by a temporary.  */
243 typedef struct
244 {
245   symbol_attribute attr;
246   tree decl;
247 }
248 gfc_saved_var;
249
250
251 /* Advance the SS chain to the next term.  */
252 void gfc_advance_se_ss_chain (gfc_se *);
253
254 /* Call this to initialise a gfc_se structure before use
255    first parameter is structure to initialise, second is
256    parent to get scalarization data from, or NULL.  */
257 void gfc_init_se (gfc_se *, gfc_se *);
258
259 /* Create an artificial variable decl and add it to the current scope.  */
260 tree gfc_create_var (tree, const char *);
261 /* Like above but doesn't add it to the current scope.  */
262 tree gfc_create_var_np (tree, const char *);
263
264 /* Store the result of an expression in a temp variable so it can be used
265    repeatedly even if the original changes */
266 void gfc_make_safe_expr (gfc_se * se);
267
268 /* Makes sure se is suitable for passing as a function string parameter.  */
269 void gfc_conv_string_parameter (gfc_se * se);
270
271 /* Add an item to the end of TREE_LIST.  */
272 tree gfc_chainon_list (tree, tree);
273
274 /* When using the gfc_conv_* make sure you understand what they do, ie.
275    when a POST chain may be created, and what the retured expression may be
276    used for.  Note that character strings have special handling.  This
277    should not be a problem as most statements/operations only deal with
278    numeric/logical types.  */
279
280 /* Entry point for expression translation.  */
281 void gfc_conv_expr (gfc_se * se, gfc_expr * expr);
282 /* Like gfc_conv_expr, but the POST block is guaranteed to be empty for
283    numeric expressions.  */
284 void gfc_conv_expr_val (gfc_se * se, gfc_expr * expr);
285 /* Like gfc_conv_expr_val, but the value is also suitable for use in the lhs of
286    an assignment.  */
287 void gfc_conv_expr_lhs (gfc_se * se, gfc_expr * expr);
288 /* Converts an expression so that it can be passed be reference.  */
289 void gfc_conv_expr_reference (gfc_se * se, gfc_expr *);
290 /* Equivalent to convert(type, gfc_conv_expr_val(se, expr)).  */
291 void gfc_conv_expr_type (gfc_se * se, gfc_expr *, tree);
292 /* If the value is not constant, Create a temporary and copy the value.  */
293 tree gfc_evaluate_now (tree, stmtblock_t *);
294
295 /* Intrinsic function handling.  */
296 void gfc_conv_intrinsic_function (gfc_se *, gfc_expr *);
297
298 /* Does an intrinsic map directly to an external library call.  */
299 int gfc_is_intrinsic_libcall (gfc_expr *);
300
301 /* Also used to CALL subroutines.  */
302 void gfc_conv_function_call (gfc_se *, gfc_symbol *, gfc_actual_arglist *);
303 /* gfc_trans_* shouldn't call push/poplevel, use gfc_push/pop_scope */
304
305 /* Generate code for a scalar assignment.  */
306 tree gfc_trans_scalar_assign (gfc_se *, gfc_se *, bt);
307
308 /* Translate COMMON blocks.  */
309 void gfc_trans_common (gfc_namespace *);
310
311 /* Translate a derived type constructor. */
312 void gfc_conv_structure (gfc_se *, gfc_expr *, int);
313
314 /* Return an expression which determines if a dummy parameter is present.  */
315 tree gfc_conv_expr_present (gfc_symbol *);
316
317 /* Generate code to allocate a string temporary.  */
318 tree gfc_conv_string_tmp (gfc_se *, tree, tree);
319 /* Initialize a string length variable.  */
320 void gfc_trans_init_string_length (gfc_charlen *, stmtblock_t *);
321
322 /* Add an expression to the end of a block.  */
323 void gfc_add_expr_to_block (stmtblock_t *, tree);
324 /* Add a block to the end of a block.  */
325 void gfc_add_block_to_block (stmtblock_t *, stmtblock_t *);
326 /* Add a MODIFY_EXPR to a block.  */
327 void gfc_add_modify_expr (stmtblock_t *, tree, tree);
328
329 /* Initialize a statement block.  */
330 void gfc_init_block (stmtblock_t *);
331 /* Start a new satement block.  Like gfc_init_block but also starts a new
332    variable scope.  */
333 void gfc_start_block (stmtblock_t *);
334 /* Finish a statement block.  Also closes the scope if the block was created
335    with gfc_start_block.  */
336 tree gfc_finish_block (stmtblock_t *);
337 /* Merge the scope of a block with its parent.  */
338 void gfc_merge_block_scope (stmtblock_t * block);
339
340 /* Return the backend label decl.  */
341 tree gfc_get_label_decl (gfc_st_label *);
342
343 /* Return the decl for an external function.  */
344 tree gfc_get_extern_function_decl (gfc_symbol *);
345
346 /* Return the decl for a function.  */
347 tree gfc_get_function_decl (gfc_symbol *);
348
349 /* Build a CALL_EXPR.  */
350 tree gfc_build_function_call (tree, tree);
351
352 /* Build an ADDR_EXPR.  */
353 tree gfc_build_addr_expr (tree, tree);
354
355 /* Build an INDIRECT_REF.  */
356 tree gfc_build_indirect_ref (tree);
357
358 /* Build an ARRAY_REF.  */
359 tree gfc_build_array_ref (tree, tree);
360
361 /* Creates an label.  Decl is artificial if label_id == NULL_TREE.  */
362 tree gfc_build_label_decl (tree);
363
364 /* Return the decl used to hold the function return value.
365    Do not use if the function has an explicit result variable.  */
366 tree gfc_get_fake_result_decl (gfc_symbol *);
367
368 /* Get the return label for the current function.  */
369 tree gfc_get_return_label (void);
370
371 /* Add a decl to the binding level for the current function.  */
372 void gfc_add_decl_to_function (tree);
373
374 /* Make prototypes for runtime library functions.  */
375 void gfc_build_builtin_function_decls (void);
376
377 /* Return the variable decl for a symbol.  */
378 tree gfc_get_symbol_decl (gfc_symbol *);
379
380 /* Build a static initializer.  */
381 tree gfc_conv_initializer (gfc_expr *, gfc_typespec *, tree, bool, bool);
382
383 /* Substitute a temporary variable in place of the real one.  */
384 void gfc_shadow_sym (gfc_symbol *, tree, gfc_saved_var *);
385
386 /* Restore the original variable.  */
387 void gfc_restore_sym (gfc_symbol *, gfc_saved_var *);
388
389 /* Allocate the lang-spcific part of a decl node.  */
390 void gfc_allocate_lang_decl (tree);
391
392 /* Advance along a TREE_CHAIN.  */
393 tree gfc_advance_chain (tree, int);
394
395 /* Create a decl for a function.  */
396 void gfc_create_function_decl (gfc_namespace *);
397 /* Generate the code for a function.  */
398 void gfc_generate_function_code (gfc_namespace *);
399 /* Output a BLOCK DATA program unit.  */
400 void gfc_generate_block_data (gfc_namespace *);
401 /* Output a decl for a module variable.  */
402 void gfc_generate_module_vars (gfc_namespace *);
403
404 /* Get and set the current location.  */
405 void gfc_set_backend_locus (locus *);
406 void gfc_get_backend_locus (locus *);
407
408 /* Handle static constructor functions.  */
409 extern GTY(()) tree gfc_static_ctors;
410 void gfc_generate_constructors (void);
411
412 /* Generate a runtime error check.  */
413 void gfc_trans_runtime_check (tree, tree, stmtblock_t *);
414
415 /* Generate code for an assigment, includes scalarization.  */
416 tree gfc_trans_assignment (gfc_expr *, gfc_expr *);
417
418 /* Generate code for an pointer assignment.  */
419 tree gfc_trans_pointer_assignment (gfc_expr *, gfc_expr *);
420
421 /* Initialize function decls for library functions.  */
422 void gfc_build_intrinsic_lib_fndecls (void);
423 /* Create function decls for IO library functions.  */
424 void gfc_build_io_library_fndecls (void);
425 /* Build a function decl for a library function.  */
426 tree gfc_build_library_function_decl (tree, tree, int, ...);
427
428 /* somewhere! */
429 tree pushdecl (tree);
430 tree pushdecl_top_level (tree);
431 void pushlevel (int);
432 tree poplevel (int, int, int);
433 tree getdecls (void);
434 tree gfc_truthvalue_conversion (tree);
435 tree builtin_function (const char *, tree, int, enum built_in_class,
436                        const char *, tree);
437
438 /* Runtime library function decls.  */
439 extern GTY(()) tree gfor_fndecl_internal_malloc;
440 extern GTY(()) tree gfor_fndecl_internal_malloc64;
441 extern GTY(()) tree gfor_fndecl_internal_free;
442 extern GTY(()) tree gfor_fndecl_allocate;
443 extern GTY(()) tree gfor_fndecl_allocate64;
444 extern GTY(()) tree gfor_fndecl_deallocate;
445 extern GTY(()) tree gfor_fndecl_pause_numeric;
446 extern GTY(()) tree gfor_fndecl_pause_string;
447 extern GTY(()) tree gfor_fndecl_stop_numeric;
448 extern GTY(()) tree gfor_fndecl_stop_string;
449 extern GTY(()) tree gfor_fndecl_select_string;
450 extern GTY(()) tree gfor_fndecl_runtime_error;
451 extern GTY(()) tree gfor_fndecl_in_pack;
452 extern GTY(()) tree gfor_fndecl_in_unpack;
453 extern GTY(()) tree gfor_fndecl_associated;
454
455 /* Math functions.  Many other math functions are handled in
456    trans-intrinsic.c.  */
457
458 typedef struct gfc_powdecl_list GTY(())
459 {
460   tree integer;
461   tree real;
462   tree cmplx;
463 }
464 gfc_powdecl_list;
465
466 extern GTY(()) gfc_powdecl_list gfor_fndecl_math_powi[3][2];
467 extern GTY(()) tree gfor_fndecl_math_cpowf;
468 extern GTY(()) tree gfor_fndecl_math_cpow;
469 extern GTY(()) tree gfor_fndecl_math_ishftc4;
470 extern GTY(()) tree gfor_fndecl_math_ishftc8;
471 extern GTY(()) tree gfor_fndecl_math_exponent4;
472 extern GTY(()) tree gfor_fndecl_math_exponent8;
473
474 /* String functions.  */
475 extern GTY(()) tree gfor_fndecl_copy_string;
476 extern GTY(()) tree gfor_fndecl_compare_string;
477 extern GTY(()) tree gfor_fndecl_concat_string;
478 extern GTY(()) tree gfor_fndecl_string_len_trim;
479 extern GTY(()) tree gfor_fndecl_string_index;
480 extern GTY(()) tree gfor_fndecl_string_scan;
481 extern GTY(()) tree gfor_fndecl_string_verify;
482 extern GTY(()) tree gfor_fndecl_string_trim;
483 extern GTY(()) tree gfor_fndecl_string_repeat;
484 extern GTY(()) tree gfor_fndecl_adjustl;
485 extern GTY(()) tree gfor_fndecl_adjustr;
486
487 /* Other misc. runtime library functions.  */
488 extern GTY(()) tree gfor_fndecl_size0;
489 extern GTY(()) tree gfor_fndecl_size1;
490 extern GTY(()) tree gfor_fndecl_iargc;
491
492 /* Implemented in FORTRAN.  */
493 extern GTY(()) tree gfor_fndecl_si_kind;
494 extern GTY(()) tree gfor_fndecl_sr_kind;
495
496
497 /* True if node is an integer constant.  */
498 #define INTEGER_CST_P(node) (TREE_CODE(node) == INTEGER_CST)
499
500 /* G95-specific declaration information.  */
501
502 /* Array types only.  */
503 struct lang_type                GTY(())
504 {
505   int rank;
506   tree lbound[GFC_MAX_DIMENSIONS];
507   tree ubound[GFC_MAX_DIMENSIONS];
508   tree stride[GFC_MAX_DIMENSIONS];
509   tree size;
510   tree offset;
511   tree dtype;
512   tree dataptr_type;
513 };
514
515 struct lang_decl                GTY(())
516 {
517   /* Dummy variables.  */
518   tree saved_descriptor;
519   /* Assigned integer nodes.  Stringlength is the IO format string's length.
520      Addr is the address of the string or the target label. Stringlength is
521      initialized to -2 and assiged to -1 when addr is assigned to the
522      address of target label.  */
523   tree stringlen;
524   tree addr;
525 };
526
527
528 #define GFC_DECL_ASSIGN_ADDR(node) DECL_LANG_SPECIFIC(node)->addr
529 #define GFC_DECL_STRING_LEN(node) DECL_LANG_SPECIFIC(node)->stringlen
530 #define GFC_DECL_SAVED_DESCRIPTOR(node) \
531   (DECL_LANG_SPECIFIC(node)->saved_descriptor)
532 #define GFC_DECL_PACKED_ARRAY(node) DECL_LANG_FLAG_0(node)
533 #define GFC_DECL_PARTIAL_PACKED_ARRAY(node) DECL_LANG_FLAG_1(node)
534 #define GFC_DECL_ASSIGN(node) DECL_LANG_FLAG_2(node)
535
536 /* An array descriptor.  */
537 #define GFC_DESCRIPTOR_TYPE_P(node) TYPE_LANG_FLAG_1(node)
538 /* An array without a descriptor.  */
539 #define GFC_ARRAY_TYPE_P(node) TYPE_LANG_FLAG_2(node)
540 /* The GFC_TYPE_ARRAY_* members are present in both descriptor and
541    descriptorless array types.  */
542 #define GFC_TYPE_ARRAY_LBOUND(node, dim) \
543   (TYPE_LANG_SPECIFIC(node)->lbound[dim])
544 #define GFC_TYPE_ARRAY_UBOUND(node, dim) \
545   (TYPE_LANG_SPECIFIC(node)->ubound[dim])
546 #define GFC_TYPE_ARRAY_STRIDE(node, dim) \
547   (TYPE_LANG_SPECIFIC(node)->stride[dim])
548 #define GFC_TYPE_ARRAY_RANK(node) (TYPE_LANG_SPECIFIC(node)->rank)
549 #define GFC_TYPE_ARRAY_SIZE(node) (TYPE_LANG_SPECIFIC(node)->size)
550 #define GFC_TYPE_ARRAY_OFFSET(node) (TYPE_LANG_SPECIFIC(node)->offset)
551 #define GFC_TYPE_ARRAY_DTYPE(node) (TYPE_LANG_SPECIFIC(node)->dtype)
552 #define GFC_TYPE_ARRAY_DATAPTR_TYPE(node) \
553   (TYPE_LANG_SPECIFIC(node)->dataptr_type)
554
555 /* I changed this from sorry(...) because it should not return.  */
556 /* TODO: Remove gfc_todo_error before releasing version 1.0.  */
557 #define gfc_todo_error(args...) fatal_error("gfc_todo: Not Implemented: " args)
558
559 /* Build an expression with void type.  */
560 #define build1_v(code, arg) build(code, void_type_node, arg)
561 #define build2_v(code, arg1, arg2) build2(code, void_type_node, \
562                                           arg1, arg2)
563 #define build3_v(code, arg1, arg2, arg3) build3(code, void_type_node, \
564                                                 arg1, arg2, arg3)
565
566 /* flag for alternative return labels.  */
567 extern int has_alternate_specifier;  /* for caller */
568 #endif /* GFC_TRANS_H */