include/osl/statement.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                         statement.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_STATEMENT_H
  65 # define OSL_STATEMENT_H
  66
  67 # include <stdio.h>
  68 # include <osl/relation.h>
  69 # include <osl/relation_list.h>
  70 # include <osl/names.h>
  71 # include <osl/interface.h>
  72 # include <osl/generic.h>
  73 # include "body.h"
  74 # include "extensions/extbody.h"
  75
  76 # if defined(__cplusplus)
  77 extern "C"
  78   {
  79 # endif
  80
  81
  82 /**
  83  * The osl_statement_t structure stores a list of statement. Each node
  84  * contains the useful informations for a given statement to process it
  85  * within a polyhedral framework. The order in the list may matter for naming
  86  * conventions (e.g. "S1" for the first statement in the list).
  87  */
  88 struct osl_statement {
  89   osl_relation_p domain;       /**< Iteration domain of the statement */
  90   osl_relation_p scattering;   /**< Scattering relation of the statement*/
  91   osl_relation_list_p access;  /**< Access information */
  92   osl_generic_p extension;     /**< A list of statement extensions */
  93   void * usr;                  /**< A user-defined field, not touched
  94                                     AT ALL by the OpenScop Library. */
  95   struct osl_statement * next; /**< Next statement in the linked list */
  96 };
  97 typedef struct osl_statement   osl_statement_t;
  98 typedef struct osl_statement * osl_statement_p;
  99
 100
 101 /*+***************************************************************************
 102  *                          Structure display function                       *
 103  *****************************************************************************/
 104 void            osl_statement_idump(FILE *, osl_statement_p, int);
 105 void            osl_statement_dump(FILE *, osl_statement_p);
 106 void            osl_statement_pprint(FILE *, osl_statement_p, osl_names_p);
 107 void            osl_statement_print(FILE *, osl_statement_p);
 108
 109 // SCoPLib Compatibility
 110 void            osl_statement_pprint_scoplib(FILE *, osl_statement_p,
 111                                              osl_names_p);
 112
 113 /*****************************************************************************
 114  *                              Reading function                             *
 115  *****************************************************************************/
 116 osl_statement_p osl_statement_pread(FILE *, osl_interface_p, int);
 117 osl_statement_p osl_statement_read(FILE *);
 118
 119
 120 /*+***************************************************************************
 121  *                   Memory allocation/deallocation function                 *
 122  *****************************************************************************/
 123 osl_statement_p osl_statement_malloc();
 124 void            osl_statement_free(osl_statement_p);
 125
 126
 127 /*+***************************************************************************
 128  *                           Processing functions                            *
 129  *****************************************************************************/
 130 void            osl_statement_add(osl_statement_p *, osl_statement_p);
 131 void            osl_statement_compact(osl_statement_p, int);
 132 int             osl_statement_number(osl_statement_p);
 133 osl_statement_p osl_statement_nclone(osl_statement_p, int);
 134 osl_statement_p osl_statement_clone(osl_statement_p);
 135 osl_statement_p osl_statement_remove_unions(osl_statement_p);
 136 int             osl_statement_equal(osl_statement_p, osl_statement_p);
 137 int             osl_statement_integrity_check(osl_statement_p, int);
 138 int             osl_statement_get_nb_iterators(osl_statement_p);
 139 void            osl_statement_get_attributes(osl_statement_p, int *, int *,
 140                                              int *, int *, int *);
 141 osl_body_p      osl_statement_get_body(osl_statement_p);
 142
 143 # if defined(__cplusplus)
 144   }
 145 # endif
 146 #endif /* define OSL_STATEMENT_H */