include/openscop/scop.h.in

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                            scop.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 /*+****************************************************************************
  65  *  THIS FILE HAS BEEN AUTOMATICALLY GENERATED FROM scop.h.in BY configure    *
  66  ******************************************************************************/
  67
  68
  69 #ifndef OPENSCOP_SCOP_H
  70 # define OPENSCOP_SCOP_H
  71
  72 # include <unistd.h>
  73
  74 # define OPENSCOP_RELEASE "@PACKAGE_VERSION@"
  75 # define OPENSCOP_VERSION "@BITS@"
  76 # ifndef @OPENSCOP_INT_T@
  77 #  define @OPENSCOP_INT_T@
  78 # endif
  79
  80 # include <openscop/macros.h>
  81 # include <openscop/util.h>
  82 # include <openscop/vector.h>
  83 # include <openscop/relation.h>
  84 # include <openscop/extension.h>
  85 # include <openscop/statement.h>
  86
  87
  88 # if defined(__cplusplus)
  89 extern "C"
  90   {
  91 # endif
  92
  93
  94 /**
  95  * The scop_t structure stores the useful information of a static
  96  * control part of a program to process it within a polyhedral framework.
  97  */
  98 struct openscop_scop
  99 {
 100   int version;                    /**< Version of the data structure */
 101   int textual_names;              /**< 1 if names are strings, 0 otherwise. */
 102   int textual_extensions;         /**< 1 if extensions is a string, 0 if not.*/
 103   char * language;                /**< Target language (backend) */
 104   openscop_relation_p context;    /**< Constraints on the SCoP parameters */
 105   int nb_parameters;              /**< Number of parameters for the SCoP */
 106   int nb_iterators;               /**< Number (max) of output dimensions */
 107   int nb_scattdims;               /**< Number (max) of scattering dimensions */
 108   char ** parameters;             /**< Array of nb_parameters param names */
 109   char ** iterators;              /**< Array of nb_iterators iterator names */
 110   char ** scattdims;              /**< Array of nb_scattdims scattering
 111                                        dimension names */
 112   openscop_statement_p statement; /**< Statement list of the SCoP */
 113   void * extensions;              /**< Extensions. A 0-terminated string if
 114                                        textual_extensions is 1, an
 115                                        openscop_extension_p otherwise. */
 116   void * usr;                     /**< A user-defined field, not touched
 117                                        AT ALL by the OpenScop Library. */
 118 };
 119 typedef struct openscop_scop   openscop_scop_t;
 120 typedef struct openscop_scop * openscop_scop_p;
 121
 122
 123 /*+***************************************************************************
 124  *                          Structure display function                       *
 125  *****************************************************************************/
 126 void openscop_scop_print_structure(FILE *, openscop_scop_p, int);
 127 void openscop_scop_print(FILE *, openscop_scop_p);
 128 void openscop_scop_print_openscop(FILE *, openscop_scop_p);
 129
 130
 131 /*****************************************************************************
 132  *                               Reading function                            *
 133  *****************************************************************************/
 134 openscop_scop_p openscop_scop_read(FILE *);
 135
 136
 137 /*+***************************************************************************
 138  *                    Memory allocation/deallocation function                *
 139  *****************************************************************************/
 140 openscop_scop_p openscop_scop_malloc();
 141 void            openscop_scop_free(openscop_scop_p);
 142
 143
 144 /*+***************************************************************************
 145  *                            Processing functions                           *
 146  *****************************************************************************/
 147 openscop_scop_p openscop_scop_copy(openscop_scop_p);
 148 int             openscop_scop_equal(openscop_scop_p, openscop_scop_p);
 149 int             openscop_scop_integrity_check(openscop_scop_p);
 150
 151
 152 # if defined(__cplusplus)
 153   }
 154 # endif
 155
 156 #endif /* define OPENSCOP_SCOP_H */