xref: /netbsd-src/external/gpl3/gcc.old/dist/gcc/fortran/trans-array.h (revision 4c3eb207d36f67d31994830c0a694161fc1ca39b)
1 /* Header for array handling functions
2    Copyright (C) 2002-2020 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 3, 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 COPYING3.  If not see
19 <http://www.gnu.org/licenses/>.  */
20 
21 /* Generate code to initialize and allocate an array.  Statements are added to
22    se, which should contain an expression for the array descriptor.  */
23 bool gfc_array_allocate (gfc_se *, gfc_expr *, tree, tree, tree, tree,
24 			 tree, tree *, gfc_expr *, tree, bool);
25 
26 /* Allow the bounds of a loop to be set from a callee's array spec.  */
27 void gfc_set_loop_bounds_from_array_spec (gfc_interface_mapping *,
28 					  gfc_se *, gfc_array_spec *);
29 
30 /* Generate code to create a temporary array.  */
31 tree gfc_trans_create_temp_array (stmtblock_t *, stmtblock_t *, gfc_ss *,
32 				  tree, tree, bool, bool, bool, locus *);
33 
34 /* Generate function entry code for allocation of compiler allocated array
35    variables.  */
36 void gfc_trans_auto_array_allocation (tree, gfc_symbol *, gfc_wrapped_block *);
37 /* Generate entry and exit code for dummy array parameters.  */
38 void gfc_trans_dummy_array_bias (gfc_symbol *, tree, gfc_wrapped_block *);
39 /* Generate entry and exit code for g77 calling convention arrays.  */
40 void gfc_trans_g77_array (gfc_symbol *, gfc_wrapped_block *);
41 
42 tree gfc_full_array_size (stmtblock_t *, tree, int);
43 
44 tree gfc_duplicate_allocatable (tree, tree, tree, int, tree);
45 
46 tree gfc_copy_allocatable_data (tree dest, tree src, tree type, int rank);
47 
48 tree gfc_duplicate_allocatable_nocopy (tree, tree, tree, int);
49 
50 bool gfc_caf_is_dealloc_only (int);
51 
52 tree gfc_nullify_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
53 
54 tree gfc_deallocate_alloc_comp (gfc_symbol *, tree, int, int cm = 0);
55 tree gfc_bcast_alloc_comp (gfc_symbol *, gfc_expr *, int, tree,
56 			   tree, tree, tree);
57 tree gfc_deallocate_alloc_comp_no_caf (gfc_symbol *, tree, int);
58 tree gfc_reassign_alloc_comp_caf (gfc_symbol *, tree, tree);
59 
60 tree gfc_copy_alloc_comp (gfc_symbol *, tree, tree, int, int);
61 
62 tree gfc_copy_only_alloc_comp (gfc_symbol *, tree, tree, int);
63 
64 tree gfc_allocate_pdt_comp (gfc_symbol *, tree, int, gfc_actual_arglist *);
65 tree gfc_deallocate_pdt_comp (gfc_symbol *, tree, int);
66 tree gfc_check_pdt_dummy (gfc_symbol *, tree, int, gfc_actual_arglist *);
67 
68 tree gfc_alloc_allocatable_for_assignment (gfc_loopinfo*, gfc_expr*, gfc_expr*);
69 
70 /* Add initialization for deferred arrays.  */
71 void gfc_trans_deferred_array (gfc_symbol *, gfc_wrapped_block *);
72 /* Generate an initializer for a static pointer or allocatable array.  */
73 void gfc_trans_static_array_pointer (gfc_symbol *);
74 
75 /* Get the procedure interface for a function call.  */
76 gfc_symbol *gfc_get_proc_ifc_for_expr (gfc_expr *);
77 /* Generate scalarization information for an expression.  */
78 gfc_ss *gfc_walk_expr (gfc_expr *);
79 /* Workhorse for gfc_walk_expr.  */
80 gfc_ss *gfc_walk_subexpr (gfc_ss *, gfc_expr *);
81 /* Workhorse for gfc_walk_variable_expr.  */
82 gfc_ss *gfc_walk_array_ref (gfc_ss *, gfc_expr *, gfc_ref * ref);
83 /* Walk the arguments of an elemental function.  */
84 gfc_ss *gfc_walk_elemental_function_args (gfc_ss *, gfc_actual_arglist *,
85 					  gfc_symbol *, gfc_ss_type);
86 /* Walk an intrinsic function.  */
87 gfc_ss *gfc_walk_intrinsic_function (gfc_ss *, gfc_expr *,
88 				     gfc_intrinsic_sym *);
89 /* Reverse the order of an SS chain.  */
90 gfc_ss *gfc_reverse_ss (gfc_ss *);
91 
92 /* Free the SS associated with a loop.  */
93 void gfc_cleanup_loop (gfc_loopinfo *);
94 /* Associate a SS chain with a loop.  */
95 void gfc_add_ss_to_loop (gfc_loopinfo *, gfc_ss *);
96 /* Mark a SS chain as used in this loop.  */
97 void gfc_mark_ss_chain_used (gfc_ss *, unsigned);
98 /* Free a gfc_ss chain.  */
99 void gfc_free_ss_chain (gfc_ss *);
100 /* Free a single gfc_ss element.  */
101 void gfc_free_ss (gfc_ss *);
102 /* Allocate a new array type ss.  */
103 gfc_ss *gfc_get_array_ss (gfc_ss *, gfc_expr *, int, gfc_ss_type);
104 /* Allocate a new temporary type ss.  */
105 gfc_ss *gfc_get_temp_ss (tree, tree, int);
106 /* Allocate a new scalar type ss.  */
107 gfc_ss *gfc_get_scalar_ss (gfc_ss *, gfc_expr *);
108 
109 bool gfc_scalar_elemental_arg_saved_as_reference (gfc_ss_info *);
110 
111 /* Calculates the lower bound and stride of array sections.  */
112 void gfc_conv_ss_startstride (gfc_loopinfo *);
113 
114 void gfc_init_loopinfo (gfc_loopinfo *);
115 void gfc_copy_loopinfo_to_se (gfc_se *, gfc_loopinfo *);
116 
117 /* Marks the start of a scalarized expression, and declares loop variables.  */
118 void gfc_start_scalarized_body (gfc_loopinfo *, stmtblock_t *);
119 /* Generates one actual loop for a scalarized expression.  */
120 void  gfc_trans_scalarized_loop_end (gfc_loopinfo *, int, stmtblock_t *);
121 /* Generates the actual loops for a scalarized expression.  */
122 void gfc_trans_scalarizing_loops (gfc_loopinfo *, stmtblock_t *);
123 /* Mark the end of the main loop body and the start of the copying loop.  */
124 void gfc_trans_scalarized_loop_boundary (gfc_loopinfo *, stmtblock_t *);
125 /* Initialize the scalarization loop parameters.  */
126 void gfc_conv_loop_setup (gfc_loopinfo *, locus *);
127 /* Set each array's delta.  */
128 void gfc_set_delta (gfc_loopinfo *);
129 /* Resolve array assignment dependencies.  */
130 void gfc_conv_resolve_dependencies (gfc_loopinfo *, gfc_ss *, gfc_ss *);
131 /* Build a null array descriptor constructor.  */
132 tree gfc_build_null_descriptor (tree);
133 
134 /* Get a single array element.  */
135 void gfc_conv_array_ref (gfc_se *, gfc_array_ref *, gfc_expr *, locus *);
136 /* Translate a reference to a temporary array.  */
137 void gfc_conv_tmp_array_ref (gfc_se * se);
138 /* Translate a reference to an array temporary.  */
139 void gfc_conv_tmp_ref (gfc_se *);
140 
141 /* Calculate the overall offset, including subreferences.  */
142 void gfc_get_dataptr_offset (stmtblock_t*, tree, tree, tree, bool, gfc_expr*);
143 /* Obtain the span of an array.  */
144 tree gfc_get_array_span (tree, gfc_expr *);
145 /* Evaluate an array expression.  */
146 void gfc_conv_expr_descriptor (gfc_se *, gfc_expr *);
147 /* Convert an array for passing as an actual function parameter.  */
148 void gfc_conv_array_parameter (gfc_se *, gfc_expr *, bool,
149 			       const gfc_symbol *, const char *, tree *);
150 /* Evaluate and transpose a matrix expression.  */
151 void gfc_conv_array_transpose (gfc_se *, gfc_expr *);
152 
153 /* These work with both descriptors and descriptorless arrays.  */
154 tree gfc_conv_array_data (tree);
155 tree gfc_conv_array_offset (tree);
156 /* Return either an INT_CST or an expression for that part of the descriptor.  */
157 tree gfc_conv_array_stride (tree, int);
158 tree gfc_conv_array_lbound (tree, int);
159 tree gfc_conv_array_ubound (tree, int);
160 
161 /* Set cobounds of an array.  */
162 void gfc_trans_array_cobounds (tree, stmtblock_t *, const gfc_symbol *);
163 
164 /* Build expressions for accessing components of an array descriptor.  */
165 void gfc_get_descriptor_offsets_for_info (const_tree, tree *, tree *, tree *, tree *,
166 					  tree *, tree *, tree *, tree *);
167 
168 tree gfc_conv_descriptor_data_get (tree);
169 tree gfc_conv_descriptor_data_addr (tree);
170 tree gfc_conv_descriptor_offset_get (tree);
171 tree gfc_conv_descriptor_span_get (tree);
172 tree gfc_conv_descriptor_dtype (tree);
173 tree gfc_conv_descriptor_rank (tree);
174 tree gfc_conv_descriptor_elem_len (tree);
175 tree gfc_conv_descriptor_attribute (tree);
176 tree gfc_get_descriptor_dimension (tree);
177 tree gfc_conv_descriptor_stride_get (tree, tree);
178 tree gfc_conv_descriptor_lbound_get (tree, tree);
179 tree gfc_conv_descriptor_ubound_get (tree, tree);
180 tree gfc_conv_descriptor_token (tree);
181 
182 void gfc_conv_descriptor_data_set (stmtblock_t *, tree, tree);
183 void gfc_conv_descriptor_offset_set (stmtblock_t *, tree, tree);
184 void gfc_conv_descriptor_span_set (stmtblock_t *, tree, tree);
185 void gfc_conv_descriptor_stride_set (stmtblock_t *, tree, tree, tree);
186 void gfc_conv_descriptor_lbound_set (stmtblock_t *, tree, tree, tree);
187 void gfc_conv_descriptor_ubound_set (stmtblock_t *, tree, tree, tree);
188 
189 /* Shift lower bound of descriptor, updating ubound and offset.  */
190 void gfc_conv_shift_descriptor_lbound (stmtblock_t*, tree, int, tree);
191 
192 /* Add pre-loop scalarization code for intrinsic functions which require
193    special handling.  */
194 void gfc_add_intrinsic_ss_code (gfc_loopinfo *, gfc_ss *);
195 
196 /* Functions for constant array constructor processing.  */
197 unsigned HOST_WIDE_INT gfc_constant_array_constructor_p (gfc_constructor_base);
198 tree gfc_build_constant_array_constructor (gfc_expr *, tree);
199 
200 /* Copy a string from src to dest.  */
201 void gfc_trans_string_copy (stmtblock_t *, tree, tree, int, tree, tree, int);
202 
203 /* Calculate extent / size of an array.  */
204 tree gfc_conv_array_extent_dim (tree, tree, tree*);
205 tree gfc_conv_descriptor_size (tree, int);
206 tree gfc_conv_descriptor_cosize (tree, int, int);
207