gcc/fortran/trans-array.h

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