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 OSL_RELATION_H 65# define OSL_RELATION_H 66 67# include <stdio.h> 68# include <osl/names.h> 69# include <osl/vector.h> 70 71# if defined(__cplusplus) 72extern "C" 73 { 74# endif 75 76 77/** 78 * The osl_relation_t structure stores a union of relations. It is a 79 * NULL-terminated linked list of relations. Each relation is described 80 * using a matrix where each row represents a linear constraint. The entries 81 * of each row are organised in the following order: 82 * - An equality/inequality tag: 0 means the row corresponds to an 83 * equality constraint == 0, 1 means it is an inequality >= 0. 84 * - The coefficients of the output dimensions. 85 * - The coefficients of the input dimensions (0 for a set). 86 * - The coefficients of the local (existentially quantified) dimensions. 87 * - The coefficients of the parameters. 88 * - The coefficient of the constant. 89 * Thus we have the following invariant: nb_columns = 90 * 1 + nb_output_dims + nb_input_dims + dims + nb_parameters + 1. 91 * Moreover we use the following conventions: 92 * - Sets (e.g., iteration domains) are the images of relations with a 93 * zero-dimensional domain, hence the number of input dimensions is 0. 94 * - The first output dimension of any access relations corresponds to 95 * the name of the array. 96 * The type field may provide some semantics about the relation, it may be: 97 * - Undefined : OSL_UNDEFINED, 98 * - An iteration domain : OSL_TYPE_DOMAIN, 99 * - A scattering relation : OSL_TYPE_SCATTERING, 100 * - An access relation : OSL_TYPE_ACCESS. 101 */ 102struct osl_relation { 103 int type; /**< Semantics about the relation */ 104 int precision; /**< Precision of relation matrix elements*/ 105 int nb_rows; /**< Number of rows */ 106 int nb_columns; /**< Number of columns */ 107 int nb_output_dims; /**< Number of output dimensions */ 108 int nb_input_dims; /**< Number of input dimensions */ 109 int nb_local_dims; /**< Number of local (existentially 110 quantified) dimensions */ 111 int nb_parameters; /**< Number of parameters */ 112 void ** m; /**< An array of pointers to the beginning 113 of each row of the relation matrix */ 114 struct osl_relation * next; /**< Pointer to the next relation in the 115 union of relations (NULL if none) */ 116}; 117typedef struct osl_relation osl_relation_t; 118typedef struct osl_relation * osl_relation_p; 119 120 121/*+*************************************************************************** 122 * Structure display function * 123 *****************************************************************************/ 124void osl_relation_idump(FILE *, osl_relation_p, int); 125void osl_relation_dump(FILE *, osl_relation_p); 126char * osl_relation_expression(osl_relation_p relation, 127 int row, char ** names); 128char * osl_relation_spprint_polylib(osl_relation_p, osl_names_p); 129char * osl_relation_spprint(osl_relation_p, osl_names_p); 130void osl_relation_pprint(FILE *, osl_relation_p, osl_names_p); 131void osl_relation_print(FILE *, osl_relation_p); 132 133 134/***************************************************************************** 135 * Reading function * 136 *****************************************************************************/ 137osl_relation_p osl_relation_pread(FILE *, int); 138osl_relation_p osl_relation_read(FILE *); 139osl_relation_p osl_relation_read_arrays(FILE *, char ***, int *); 140 141 142/*+*************************************************************************** 143 * Memory allocation/deallocation function * 144 *****************************************************************************/ 145osl_relation_p osl_relation_pmalloc(int, int, int); 146osl_relation_p osl_relation_malloc(int, int); 147void osl_relation_free_inside(osl_relation_p); 148void osl_relation_free(osl_relation_p); 149 150 151/*+*************************************************************************** 152 * Processing functions * 153 *****************************************************************************/ 154osl_relation_p osl_relation_nclone(osl_relation_p, int); 155osl_relation_p osl_relation_clone(osl_relation_p); 156void osl_relation_add(osl_relation_p *, osl_relation_p); 157osl_relation_p osl_relation_union(osl_relation_p, osl_relation_p); 158void osl_relation_replace_vector(osl_relation_p, osl_vector_p, int); 159void osl_relation_insert_vector(osl_relation_p, osl_vector_p, int); 160osl_relation_p osl_relation_concat_vector(osl_relation_p, osl_vector_p); 161void osl_relation_insert_blank_row(osl_relation_p, int); 162void osl_relation_insert_blank_column(osl_relation_p, int); 163void osl_relation_add_vector(osl_relation_p, osl_vector_p, int); 164void osl_relation_sub_vector(osl_relation_p, osl_vector_p, int); 165osl_relation_p osl_relation_from_vector(osl_vector_p); 166void osl_relation_replace_constraints(osl_relation_p, 167 osl_relation_p, int); 168void osl_relation_insert_constraints(osl_relation_p, 169 osl_relation_p, int); 170void osl_relation_remove_row(osl_relation_p, int); 171void osl_relation_remove_column(osl_relation_p, int); 172void osl_relation_insert_columns(osl_relation_p, osl_relation_p,int); 173osl_relation_p osl_relation_concat_constraints(osl_relation_p, osl_relation_p); 174int osl_relation_equal(osl_relation_p, osl_relation_p); 175int osl_relation_integrity_check(osl_relation_p, int, int, int,int); 176void osl_relation_set_attributes_one(osl_relation_p, 177 int, int, int, int); 178void osl_relation_set_attributes(osl_relation_p, int, int, int, int); 179void osl_relation_set_type(osl_relation_p, int); 180int osl_relation_get_array_id(osl_relation_p); 181int osl_relation_is_access(osl_relation_p); 182void osl_relation_get_attributes(osl_relation_p, 183 int *, int *, int *, int *, int *); 184osl_relation_p osl_relation_extend_output(osl_relation_p, int); 185 186 187# if defined(__cplusplus) 188 } 189# endif 190#endif /* define OSL_RELATION_H */ 191