include/osl/extensions/loop.h

   1
   2     /*+-----------------------------------------------------------------**
   3      **                       OpenScop Library                          **
   4      **-----------------------------------------------------------------**
   5      **                      extensions/loop.h                          **
   6      **-----------------------------------------------------------------**
   7      **                   First version: 03/06/2013                     **
   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_LOOP_H
  65 # define OSL_LOOP_H
  66
  67 # include <stdio.h>
  68 # include <osl/strings.h>
  69 # include <osl/interface.h>
  70
  71 # if defined(__cplusplus)
  72 extern "C"
  73   {
  74 # endif
  75
  76
  77 # define OSL_URI_LOOP        "loop"
  78
  79 //loop direcrives
  80 # define OSL_LOOP_DIRECTIVE_NONE     0
  81 # define OSL_LOOP_DIRECTIVE_PARALLEL 1
  82 # define OSL_LOOP_DIRECTIVE_MPI      2
  83 # define OSL_LOOP_DIRECTIVE_VECTOR   4
  84 # define OSL_LOOP_DIRECTIVE_USER     8
  85
  86
  87
  88 /**
  89  * The osl_loop_t structure stores information about loops in the program
  90  * in the extension part of the OpenScop representation. Containing the
  91  * information about the statements in the loop, its iterator and openmp
  92  * directives, it serves to communicate such information among different
  93  * tools in the polyhedral chain.
  94  */
  95 struct osl_loop {
  96   char * iter;              /**< \brief \0 terminated iterator name */
  97   int    nb_stmts;          /**< \brief Number of statements in the loop */
  98   int  * stmt_ids;          /**< \brief Array of statement identifiers. */
  99   char * private_vars;      /**< \brief \0 terminated variable names */
 100   int    directive;         /**< \brief Loop directive to implement */
 101   char * user;              /**< \brief \0 terminated user string */
 102   struct osl_loop * next;
 103 };
 104 typedef struct osl_loop   osl_loop_t;
 105 typedef struct osl_loop * osl_loop_p;
 106
 107
 108
 109 /*+***************************************************************************
 110  *                          Structure display function                       *
 111  *****************************************************************************/
 112 void            osl_loop_idump(FILE * file, osl_loop_p loop, int level);
 113 void            osl_loop_dump(FILE * file, osl_loop_p loop);
 114 char *          osl_loop_sprint(osl_loop_p loop);
 115
 116
 117 /*****************************************************************************
 118  *                               Reading function                            *
 119  *****************************************************************************/
 120 osl_loop_p      osl_loop_sread(char ** input);
 121
 122
 123 /*+***************************************************************************
 124  *                    Memory allocation/deallocation function                *
 125  *****************************************************************************/
 126 osl_loop_p      osl_loop_malloc();
 127 void            osl_loop_free(osl_loop_p loop);
 128
 129
 130 /*+***************************************************************************
 131  *                            Processing functions                           *
 132  *****************************************************************************/
 133 osl_loop_p      osl_loop_clone_one(osl_loop_p loop);
 134 osl_loop_p      osl_loop_clone(osl_loop_p loop);
 135 int             osl_loop_equal_one(osl_loop_p a1, osl_loop_p a2);
 136 int             osl_loop_equal(osl_loop_p a1, osl_loop_p a2);
 137 osl_strings_p   osl_loop_to_strings(osl_loop_p);
 138 osl_interface_p osl_loop_interface();
 139
 140 void            osl_loop_add(osl_loop_p loop, osl_loop_p *ll);
 141 int             osl_loop_count(osl_loop_p ll);
 142
 143 # if defined(__cplusplus)
 144   }
 145 # endif
 146
 147 #endif /* define OSL_LOOP_H */