include/openscop/relation.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                          relation.h                             **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 30/04/2008                     **
   8      **-----------------------------------------------------------------**
   9
  10
  11  *****************************************************************************
  12  * OpenScop: Structures and formats for polyhedral tools to talk together    *
  13  *****************************************************************************
  14  *    ,___,,_,__,,__,,__,,__,,_,__,,_,__,,__,,___,_,__,,_,__,                *
  15  *    /   / /  //  //  //  // /   / /  //  //   / /  // /  /|,_,             *
  16  *   /   / /  //  //  //  // /   / /  //  //   / /  // /  / / /\             *
  17  *  |~~~|~|~~~|~~~|~~~|~~~|~|~~~|~|~~~|~~~|~~~|~|~~~|~|~~~|/_/  \            *
  18  *  | G |C| P | = | L | P |=| = |C| = | = | = |=| = |=| C |\  \ /\           *
  19  *  | R |l| o | = | e | l |=| = |a| = | = | = |=| = |=| L | \# \ /\          *
  20  *  | A |a| l | = | t | u |=| = |n| = | = | = |=| = |=| o | |\# \  \         *
  21  *  | P |n| l | = | s | t |=| = |d| = | = | = | |   |=| o | | \# \  \        *
  22  *  | H | | y |   | e | o | | = |l|   |   | = | |   | | G | |  \  \  \       *
  23  *  | I | |   |   | e |   | |   | |   |   |   | |   | |   | |   \  \  \      *
  24  *  | T | |   |   |   |   | |   | |   |   |   | |   | |   | |    \  \  \     *
  25  *  | E | |   |   |   |   | |   | |   |   |   | |   | |   | |     \  \  \    *
  26  *  | * |*| * | * | * | * |*| * |*| * | * | * |*| * |*| * | /      \* \  \   *
  27  *  | O |p| e | n | S | c |o| p |-| L | i | b |r| a |r| y |/        \  \ /   *
  28  *  '---'-'---'---'---'---'-'---'-'---'---'---'-'---'-'---'          '--'    *
  29  *                                                                           *
  30  * Copyright (C) 2008 University Paris-Sud 11 and INRIA                      *
  31  *                                                                           *
  32  * (3-clause BSD license)                                                    *
  33  * Redistribution and use in source  and binary forms, with or without       *
  34  * modification, are permitted provided that the following conditions        *
  35  * are met:                                                                  *
  36  *                                                                           *
  37  * 1. Redistributions of source code must retain the above copyright notice, *
  38  *    this list of conditions and the following disclaimer.                  *
  39  * 2. Redistributions in binary form must reproduce the above copyright      *
  40  *    notice, this list of conditions and the following disclaimer in the    *
  41  *    documentation and/or other materials provided with the distribution.   *
  42  * 3. The name of the author may not be used to endorse or promote products  *
  43  *    derived from this software without specific prior written permission.  *
  44  *                                                                           *
  45  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR      *
  46  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES *
  47  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.   *
  48  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,          *
  49  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT  *
  50  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, *
  51  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
  52  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
  53  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF  *
  54  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.         *
  55  *                                                                           *
  56  * OpenScop Library, a library to manipulate OpenScop formats and data       *
  57  * structures. Written by:                                                   *
  58  * Cedric Bastoul     <Cedric.Bastoul@u-psud.fr> and                         *
  59  * Louis-Noel Pouchet <Louis-Noel.pouchet@inria.fr>                          *
  60  *                                                                           *
  61  *****************************************************************************/
  62
  63
  64 #ifndef OPENSCOP_RELATION_H
  65 # define OPENSCOP_RELATION_H
  66
  67 # include <stdio.h>
  68 # include <openscop/macros.h>
  69 # include <openscop/int.h>
  70 # include <openscop/util.h>
  71 # include <openscop/names.h>
  72 # include <openscop/vector.h>
  73
  74
  75 # if defined(__cplusplus)
  76 extern "C"
  77   {
  78 # endif
  79
  80
  81 /**
  82  * The openscop_relation_t structure stores a union of relations. It is a
  83  * NULL-terminated linked list of relations. Each relation is described
  84  * using a matrix where each row represents a linear constraint. The entries
  85  * of each row are organised in the following order:
  86  * - An equality/inequality tag: 0 means the row corresponds to an
  87  *   equality constraint == 0, 1 means it is an inequality >= 0.
  88  * - The coefficients of the output dimensions.
  89  * - The coefficients of the input dimensions (0 for a set).
  90  * - The coefficients of the local (existentially quantified) dimensions.
  91  * - The coefficients of the parameters.
  92  * - The coefficient of the constant.
  93  * Thus we have the following invariant: nb_columns =
  94  * 1 + nb_output_dims + nb_input_dims + dims + nb_parameters + 1.
  95  * Moreover we use the following conventions:
  96  * - Sets (e.g., iteration domains) are the images of relations with a
  97  *   zero-dimensional domain, hence the number of input dimensions is 0.
  98  * - The first output dimension of any access relations corresponds to
  99  *   the name of the array.
 100  * The type field may provide some semantics about the relation, it may be:
 101  * - Undefined : OPENSCOP_UNDEFINED,
 102  * - An iteration domain : OPENSCOP_TYPE_DOMAIN,
 103  * - A scattering relation : OPENSCOP_TYPE_SCATTERING,
 104  * - An access relation : OPENSCOP_TYPE_ACCESS.
 105  */
 106 struct openscop_relation {
 107   int type;                        /**< Semantics about the relation */
 108   int precision;                   /**< Precision of relation matrix elements*/
 109   int nb_rows;                     /**< Number of rows */
 110   int nb_columns;                  /**< Number of columns */
 111   int nb_output_dims;              /**< Number of output dimensions */
 112   int nb_input_dims;               /**< Number of input dimensions */
 113   int nb_local_dims;               /**< Number of local (existentially
 114                                         quantified) dimensions */
 115   int nb_parameters;               /**< Number of parameters */
 116   void ** m;                       /**< An array of pointers to the beginning
 117                                         of each row of the relation matrix */
 118   struct openscop_relation * next; /**< Pointer to the next relation in the
 119                                         union of relations (NULL if none) */
 120 };
 121 typedef struct openscop_relation   openscop_relation_t;
 122 typedef struct openscop_relation * openscop_relation_p;
 123
 124
 125 /*+***************************************************************************
 126  *                          Structure display function                       *
 127  *****************************************************************************/
 128 void                openscop_relation_idump(FILE *,
 129                                         openscop_relation_p, int);
 130 void                openscop_relation_dump(FILE *, openscop_relation_p);
 131 char *              openscop_relation_expression(
 132                                         openscop_relation_p relation,
 133                                         int row, openscop_names_p names);
 134 void                openscop_relation_print(FILE *,
 135                                         openscop_relation_p,
 136                                         openscop_names_p);
 137
 138
 139 /*****************************************************************************
 140  *                               Reading function                            *
 141  *****************************************************************************/
 142 openscop_relation_p openscop_relation_read(FILE *);
 143 openscop_relation_p openscop_relation_read_arrays(FILE *, char ***, int *);
 144
 145
 146 /*+***************************************************************************
 147  *                    Memory allocation/deallocation function                *
 148  *****************************************************************************/
 149 openscop_relation_p openscop_relation_pmalloc(int, int, int);
 150 openscop_relation_p openscop_relation_malloc(int, int);
 151 void                openscop_relation_free_inside(openscop_relation_p);
 152 void                openscop_relation_free(openscop_relation_p);
 153
 154
 155 /*+***************************************************************************
 156  *                            Processing functions                           *
 157  *****************************************************************************/
 158 openscop_relation_p openscop_relation_ncopy(openscop_relation_p, int);
 159 openscop_relation_p openscop_relation_clone(openscop_relation_p);
 160 void                openscop_relation_replace_vector(openscop_relation_p,
 161                                         openscop_vector_p, int);
 162 void                openscop_relation_insert_vector(openscop_relation_p,
 163                                         openscop_vector_p, int);
 164 void                openscop_relation_add_vector(openscop_relation_p,
 165                                         openscop_vector_p, int);
 166 void                openscop_relation_sub_vector(openscop_relation_p,
 167                                         openscop_vector_p, int);
 168 openscop_relation_p openscop_relation_from_vector(openscop_vector_p);
 169 void                openscop_relation_replace_constraints(openscop_relation_p,
 170                                         openscop_relation_p, int);
 171 void                openscop_relation_insert_constraints(openscop_relation_p,
 172                                         openscop_relation_p, int);
 173 openscop_relation_p openscop_relation_concat_constraints(openscop_relation_p,
 174                                         openscop_relation_p);
 175 int                 openscop_relation_equal(openscop_relation_p,
 176                                         openscop_relation_p);
 177 int                 openscop_relation_integrity_check(openscop_relation_p,
 178                                         int, int, int, int);
 179 openscop_relation_p openscop_relation_union(openscop_relation_p,
 180                                         openscop_relation_p);
 181 void                openscop_relation_set_type(openscop_relation_p, int);
 182 int                 openscop_relation_get_array_id(openscop_relation_p);
 183 int                 openscop_relation_is_access(openscop_relation_p);
 184
 185
 186 # if defined(__cplusplus)
 187   }
 188 # endif
 189 #endif /* define OPENSCOP_RELATION_H */