gcc/lambda.h

   1 /* Lambda matrix and vector interface.
   2    Copyright (C) 2003, 2004 Free Software Foundation, Inc.
   3    Contributed by Daniel Berlin <dberlin@dberlin.org>
   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 LAMBDA_H
  23 #define LAMBDA_H
  24
  25 #include "vec.h"
  26
  27 /* An integer vector.  A vector formally consists of an element of a vector
  28    space. A vector space is a set that is closed under vector addition
  29    and scalar multiplication.  In this vector space, an element is a list of
  30    integers.  */
  31 typedef int *lambda_vector;
  32 /* An integer matrix.  A matrix consists of m vectors of length n (IE
  33    all vectors are the same length).  */
  34 typedef lambda_vector *lambda_matrix;
  35
  36 /* A transformation matrix.  */
  37 typedef struct
  38 {
  39   lambda_matrix matrix;
  40   int rowsize;
  41   int colsize;
  42   int denominator;
  43 } *lambda_trans_matrix;
  44 #define LTM_MATRIX(T) ((T)->matrix)
  45 #define LTM_ROWSIZE(T) ((T)->rowsize)
  46 #define LTM_COLSIZE(T) ((T)->colsize)
  47 #define LTM_DENOMINATOR(T) ((T)->denominator)
  48
  49 /* A vector representing a statement in the body of a loop.  */
  50 typedef struct
  51 {
  52   lambda_vector coefficients;
  53   int size;
  54   int denominator;
  55 } *lambda_body_vector;
  56 #define LBV_COEFFICIENTS(T) ((T)->coefficients)
  57 #define LBV_SIZE(T) ((T)->size)
  58 #define LBV_DENOMINATOR(T) ((T)->denominator)
  59
  60 /* Piecewise linear expression.  */
  61 typedef struct lambda_linear_expression_s
  62 {
  63   lambda_vector coefficients;
  64   int constant;
  65   lambda_vector invariant_coefficients;
  66   int denominator;
  67   struct lambda_linear_expression_s *next;
  68 } *lambda_linear_expression;
  69
  70 #define LLE_COEFFICIENTS(T) ((T)->coefficients)
  71 #define LLE_CONSTANT(T) ((T)->constant)
  72 #define LLE_INVARIANT_COEFFICIENTS(T) ((T)->invariant_coefficients)
  73 #define LLE_DENOMINATOR(T) ((T)->denominator)
  74 #define LLE_NEXT(T) ((T)->next)
  75
  76 lambda_linear_expression lambda_linear_expression_new (int, int);
  77 void print_lambda_linear_expression (FILE *, lambda_linear_expression, int,
  78                                      int, char);
  79
  80 /* Loop structure.  */
  81 typedef struct lambda_loop_s
  82 {
  83   lambda_linear_expression lower_bound;
  84   lambda_linear_expression upper_bound;
  85   lambda_linear_expression linear_offset;
  86   int step;
  87 } *lambda_loop;
  88
  89 #define LL_LOWER_BOUND(T) ((T)->lower_bound)
  90 #define LL_UPPER_BOUND(T) ((T)->upper_bound)
  91 #define LL_LINEAR_OFFSET(T) ((T)->linear_offset)
  92 #define LL_STEP(T)   ((T)->step)
  93
  94 /* Loop nest structure.  */
  95 typedef struct
  96 {
  97   lambda_loop *loops;
  98   int depth;
  99   int invariants;
 100 } *lambda_loopnest;
 101
 102 #define LN_LOOPS(T) ((T)->loops)
 103 #define LN_DEPTH(T) ((T)->depth)
 104 #define LN_INVARIANTS(T) ((T)->invariants)
 105
 106 lambda_loopnest lambda_loopnest_new (int, int);
 107 lambda_loopnest lambda_loopnest_transform (lambda_loopnest, lambda_trans_matrix);
 108 struct loop;
 109 struct loops;
 110 bool perfect_nest_p (struct loop *);
 111 bool lambda_transform_legal_p (lambda_trans_matrix, int, varray_type);
 112 void print_lambda_loopnest (FILE *, lambda_loopnest, char);
 113
 114 #define lambda_loop_new() (lambda_loop) ggc_alloc_cleared (sizeof (struct lambda_loop_s))
 115
 116 void print_lambda_loop (FILE *, lambda_loop, int, int, char);
 117
 118 lambda_matrix lambda_matrix_new (int, int);
 119
 120 void lambda_matrix_id (lambda_matrix, int);
 121 bool lambda_matrix_id_p (lambda_matrix, int);
 122 void lambda_matrix_copy (lambda_matrix, lambda_matrix, int, int);
 123 void lambda_matrix_negate (lambda_matrix, lambda_matrix, int, int);
 124 void lambda_matrix_transpose (lambda_matrix, lambda_matrix, int, int);
 125 void lambda_matrix_add (lambda_matrix, lambda_matrix, lambda_matrix, int,
 126                         int);
 127 void lambda_matrix_add_mc (lambda_matrix, int, lambda_matrix, int,
 128                            lambda_matrix, int, int);
 129 void lambda_matrix_mult (lambda_matrix, lambda_matrix, lambda_matrix,
 130                          int, int, int);
 131 void lambda_matrix_delete_rows (lambda_matrix, int, int, int);
 132 void lambda_matrix_row_exchange (lambda_matrix, int, int);
 133 void lambda_matrix_row_add (lambda_matrix, int, int, int, int);
 134 void lambda_matrix_row_negate (lambda_matrix mat, int, int);
 135 void lambda_matrix_row_mc (lambda_matrix, int, int, int);
 136 void lambda_matrix_col_exchange (lambda_matrix, int, int, int);
 137 void lambda_matrix_col_add (lambda_matrix, int, int, int, int);
 138 void lambda_matrix_col_negate (lambda_matrix, int, int);
 139 void lambda_matrix_col_mc (lambda_matrix, int, int, int);
 140 int lambda_matrix_inverse (lambda_matrix, lambda_matrix, int);
 141 void lambda_matrix_hermite (lambda_matrix, int, lambda_matrix, lambda_matrix);
 142 void lambda_matrix_left_hermite (lambda_matrix, int, int, lambda_matrix, lambda_matrix);
 143 void lambda_matrix_right_hermite (lambda_matrix, int, int, lambda_matrix, lambda_matrix);
 144 int lambda_matrix_first_nz_vec (lambda_matrix, int, int, int);
 145 void lambda_matrix_project_to_null (lambda_matrix, int, int, int,
 146                                     lambda_vector);
 147 void print_lambda_matrix (FILE *, lambda_matrix, int, int);
 148
 149 lambda_trans_matrix lambda_trans_matrix_new (int, int);
 150 bool lambda_trans_matrix_nonsingular_p (lambda_trans_matrix);
 151 bool lambda_trans_matrix_fullrank_p (lambda_trans_matrix);
 152 int lambda_trans_matrix_rank (lambda_trans_matrix);
 153 lambda_trans_matrix lambda_trans_matrix_basis (lambda_trans_matrix);
 154 lambda_trans_matrix lambda_trans_matrix_padding (lambda_trans_matrix);
 155 lambda_trans_matrix lambda_trans_matrix_inverse (lambda_trans_matrix);
 156 void print_lambda_trans_matrix (FILE *, lambda_trans_matrix);
 157 void lambda_matrix_vector_mult (lambda_matrix, int, int, lambda_vector,
 158                                 lambda_vector);
 159 bool lambda_trans_matrix_id_p (lambda_trans_matrix);
 160
 161 lambda_body_vector lambda_body_vector_new (int);
 162 lambda_body_vector lambda_body_vector_compute_new (lambda_trans_matrix,
 163                                                    lambda_body_vector);
 164 void print_lambda_body_vector (FILE *, lambda_body_vector);
 165 lambda_loopnest gcc_loopnest_to_lambda_loopnest (struct loops *,
 166                                                  struct loop *,
 167                                                  VEC(tree) **,
 168                                                  VEC(tree) **,
 169                                                  bool);
 170 void lambda_loopnest_to_gcc_loopnest (struct loop *, VEC(tree) *,
 171                                       VEC(tree) *,
 172                                       lambda_loopnest,
 173                                       lambda_trans_matrix);
 174
 175
 176 static inline void lambda_vector_negate (lambda_vector, lambda_vector, int);
 177 static inline void lambda_vector_mult_const (lambda_vector, lambda_vector, int, int);
 178 static inline void lambda_vector_add (lambda_vector, lambda_vector,
 179                                       lambda_vector, int);
 180 static inline void lambda_vector_add_mc (lambda_vector, int, lambda_vector, int,
 181                                          lambda_vector, int);
 182 static inline void lambda_vector_copy (lambda_vector, lambda_vector, int);
 183 static inline bool lambda_vector_zerop (lambda_vector, int);
 184 static inline void lambda_vector_clear (lambda_vector, int);
 185 static inline bool lambda_vector_equal (lambda_vector, lambda_vector, int);
 186 static inline int lambda_vector_min_nz (lambda_vector, int, int);
 187 static inline int lambda_vector_first_nz (lambda_vector, int, int);
 188 static inline void print_lambda_vector (FILE *, lambda_vector, int);
 189
 190 /* Allocate a new vector of given SIZE.  */
 191
 192 static inline lambda_vector
 193 lambda_vector_new (int size)
 194 {
 195   return ggc_alloc_cleared (size * sizeof(int));
 196 }
 197
 198
 199
 200 /* Multiply vector VEC1 of length SIZE by a constant CONST1,
 201    and store the result in VEC2.  */
 202
 203 static inline void
 204 lambda_vector_mult_const (lambda_vector vec1, lambda_vector vec2,
 205                           int size, int const1)
 206 {
 207   int i;
 208
 209   if (const1 == 0)
 210     lambda_vector_clear (vec2, size);
 211   else
 212     for (i = 0; i < size; i++)
 213       vec2[i] = const1 * vec1[i];
 214 }
 215
 216 /* Negate vector VEC1 with length SIZE and store it in VEC2.  */
 217
 218 static inline void
 219 lambda_vector_negate (lambda_vector vec1, lambda_vector vec2,
 220                       int size)
 221 {
 222   lambda_vector_mult_const (vec1, vec2, size, -1);
 223 }
 224
 225 /* VEC3 = VEC1+VEC2, where all three the vectors are of length SIZE.  */
 226
 227 static inline void
 228 lambda_vector_add (lambda_vector vec1, lambda_vector vec2,
 229                    lambda_vector vec3, int size)
 230 {
 231   int i;
 232   for (i = 0; i < size; i++)
 233     vec3[i] = vec1[i] + vec2[i];
 234 }
 235
 236 /* VEC3 = CONSTANT1*VEC1 + CONSTANT2*VEC2.  All vectors have length SIZE.  */
 237
 238 static inline void
 239 lambda_vector_add_mc (lambda_vector vec1, int const1,
 240                       lambda_vector vec2, int const2,
 241                       lambda_vector vec3, int size)
 242 {
 243   int i;
 244   for (i = 0; i < size; i++)
 245     vec3[i] = const1 * vec1[i] + const2 * vec2[i];
 246 }
 247
 248 /* Copy the elements of vector VEC1 with length SIZE to VEC2.  */
 249
 250 static inline void
 251 lambda_vector_copy (lambda_vector vec1, lambda_vector vec2,
 252                     int size)
 253 {
 254   memcpy (vec2, vec1, size * sizeof (*vec1));
 255 }
 256
 257 /* Return true if vector VEC1 of length SIZE is the zero vector.  */
 258
 259 static inline bool
 260 lambda_vector_zerop (lambda_vector vec1, int size)
 261 {
 262   int i;
 263   for (i = 0; i < size; i++)
 264     if (vec1[i] != 0)
 265       return false;
 266   return true;
 267 }
 268
 269 /* Clear out vector VEC1 of length SIZE.  */
 270
 271 static inline void
 272 lambda_vector_clear (lambda_vector vec1, int size)
 273 {
 274   memset (vec1, 0, size * sizeof (*vec1));
 275 }
 276
 277 /* Return true if two vectors are equal.  */
 278
 279 static inline bool
 280 lambda_vector_equal (lambda_vector vec1, lambda_vector vec2, int size)
 281 {
 282   int i;
 283   for (i = 0; i < size; i++)
 284     if (vec1[i] != vec2[i])
 285       return false;
 286   return true;
 287 }
 288
 289 /* Return the minimum nonzero element in vector VEC1 between START and N.
 290    We must have START <= N.  */
 291
 292 static inline int
 293 lambda_vector_min_nz (lambda_vector vec1, int n, int start)
 294 {
 295   int j;
 296   int min = -1;
 297 #ifdef ENABLE_CHECKING
 298   if (start > n)
 299     abort ();
 300 #endif
 301   for (j = start; j < n; j++)
 302     {
 303       if (vec1[j])
 304         if (min < 0 || vec1[j] < vec1[min])
 305           min = j;
 306     }
 307
 308   if (min < 0)
 309     abort ();
 310
 311   return min;
 312 }
 313
 314 /* Return the first nonzero element of vector VEC1 between START and N.
 315    We must have START <= N.   Returns N if VEC1 is the zero vector.  */
 316
 317 static inline int
 318 lambda_vector_first_nz (lambda_vector vec1, int n, int start)
 319 {
 320   int j = start;
 321   while (j < n && vec1[j] == 0)
 322     j++;
 323   return j;
 324 }
 325
 326
 327 /* Multiply a vector by a matrix.  */
 328
 329 static inline void
 330 lambda_vector_matrix_mult (lambda_vector vect, int m, lambda_matrix mat,
 331                            int n, lambda_vector dest)
 332 {
 333   int i, j;
 334   lambda_vector_clear (dest, n);
 335   for (i = 0; i < n; i++)
 336     for (j = 0; j < m; j++)
 337       dest[i] += mat[j][i] * vect[j];
 338 }
 339
 340
 341 /* Print out a vector VEC of length N to OUTFILE.  */
 342
 343 static inline void
 344 print_lambda_vector (FILE * outfile, lambda_vector vector, int n)
 345 {
 346   int i;
 347
 348   for (i = 0; i < n; i++)
 349     fprintf (outfile, "%3d ", vector[i]);
 350   fprintf (outfile, "\n");
 351 }
 352 #endif /* LAMBDA_H  */
 353