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
  77 # include <openscop/macros.h>
  78 # include <openscop/util.h>
  79 # include <openscop/strings.h>
  80 # include <openscop/vector.h>
  81 # include <openscop/relation.h>
  82 # include <openscop/interface.h>
  83
  84 # include <openscop/extensions/textual.h>
  85 # include <openscop/extensions/comment.h>
  86 # include <openscop/extensions/arrays.h>
  87 # include <openscop/extensions/lines.h>
  88 # include <openscop/extensions/irregular.h>
  89
  90 # include <openscop/generic.h>
  91 # include <openscop/statement.h>
  92
  93
  94 # if defined(__cplusplus)
  95 extern "C"
  96   {
  97 # endif
  98
  99
 100 /**
 101  * The scop_t structure stores a list of scops. Each node stores the useful
 102  * information of a static control part of a program to process it within a
 103  * polyhedral framework. Parameter information may be strings of characters
 104  * (char *) when the type field is OPENSCOP_TYPE_STRING or a generic pointer
 105  * to anything else (void *) when the type field is OPENSCOP_TYPE_GENERIC.
 106  * The OpenScop library does not touch AT ALL generic information: printing,
 107  * copy etc. must be done externally.
 108  */
 109 struct openscop_scop {
 110   int version;                    /**< Version of the data structure */
 111   char * language;                /**< Target language (backend) */
 112   openscop_relation_p context;    /**< Constraints on the SCoP parameters */
 113   int parameter_type;             /**< Parameter type */
 114   openscop_generic_p parameters;  /**< NULL-terminated array of parameters */
 115   openscop_statement_p statement; /**< Statement list of the SCoP */
 116   openscop_interface_p registry;  /**< Registered extensions interfaces */
 117   openscop_generic_p extension;   /**< List of extensions */
 118   void * usr;                     /**< A user-defined field, not touched
 119                                        AT ALL by the OpenScop Library */
 120   struct openscop_scop * next;    /**< Next statement in the linked list */
 121 };
 122 typedef struct openscop_scop   openscop_scop_t;
 123 typedef struct openscop_scop * openscop_scop_p;
 124
 125
 126 /*+***************************************************************************
 127  *                          Structure display function                       *
 128  *****************************************************************************/
 129 void openscop_scop_idump(FILE *, openscop_scop_p, int);
 130 void openscop_scop_dump(FILE *, openscop_scop_p);
 131 void openscop_scop_print(FILE *, openscop_scop_p);
 132
 133
 134 /*****************************************************************************
 135  *                               Reading function                            *
 136  *****************************************************************************/
 137 openscop_scop_p openscop_scop_read(FILE *);
 138
 139
 140 /*+***************************************************************************
 141  *                    Memory allocation/deallocation function                *
 142  *****************************************************************************/
 143 openscop_scop_p openscop_scop_malloc();
 144 void            openscop_scop_free(openscop_scop_p);
 145
 146
 147 /*+***************************************************************************
 148  *                            Processing functions                           *
 149  *****************************************************************************/
 150 openscop_scop_p openscop_scop_clone(openscop_scop_p);
 151 int             openscop_scop_equal(openscop_scop_p, openscop_scop_p);
 152 int             openscop_scop_integrity_check(openscop_scop_p);
 153 void            openscop_scop_register_extension(openscop_scop_p,
 154                                                  openscop_interface_p);
 155
 156
 157 # if defined(__cplusplus)
 158   }
 159 # endif
 160
 161 #endif /* define OPENSCOP_SCOP_H */