OpenScop  0.9.0
loop.h
Go to the documentation of this file.
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 
85 
86 
94 struct osl_loop {
95  char * iter;
96  int nb_stmts;
97  int * stmt_ids;
98  char * private_vars;
99  int directive;
100  struct osl_loop * next;
101 };
102 typedef struct osl_loop osl_loop_t;
103 typedef struct osl_loop * osl_loop_p;
104 
105 
106 
107 /*+***************************************************************************
108  * Structure display function *
109  *****************************************************************************/
110 void osl_loop_idump(FILE * file, osl_loop_p loop, int level);
111 void osl_loop_dump(FILE * file, osl_loop_p loop);
112 char * osl_loop_sprint(osl_loop_p loop);
113 
114 
115 /*****************************************************************************
116  * Reading function *
117  *****************************************************************************/
118 osl_loop_p osl_loop_sread(char ** input);
119 
120 
121 /*+***************************************************************************
122  * Memory allocation/deallocation function *
123  *****************************************************************************/
124 osl_loop_p osl_loop_malloc();
125 void osl_loop_free(osl_loop_p loop);
126 
127 
128 /*+***************************************************************************
129  * Processing functions *
130  *****************************************************************************/
131 osl_loop_p osl_loop_clone_one(osl_loop_p loop);
132 osl_loop_p osl_loop_clone(osl_loop_p loop);
133 int osl_loop_equal_one(osl_loop_p a1, osl_loop_p a2);
134 int osl_loop_equal(osl_loop_p a1, osl_loop_p a2);
137 
138 void osl_loop_add(osl_loop_p loop, osl_loop_p *ll);
139 int osl_loop_count(osl_loop_p ll);
140 
141 # if defined(__cplusplus)
142  }
143 # endif
144 
145 #endif /* define OSL_LOOP_H */
void osl_loop_dump(FILE *file, osl_loop_p loop)
Definition: loop.c:174
char * iter
\0 terminated iterator name
Definition: loop.h:95
osl_loop_p osl_loop_clone_one(osl_loop_p loop)
Definition: loop.c:370
int * stmt_ids
Array of statement identifiers.
Definition: loop.h:97
int directive
the OpenMP directive to implement
Definition: loop.h:99
osl_loop_p osl_loop_clone(osl_loop_p loop)
Definition: loop.c:402
int osl_loop_equal(osl_loop_p a1, osl_loop_p a2)
Definition: loop.c:501
osl_strings_p osl_loop_to_strings(osl_loop_p)
osl_interface_p osl_loop_interface()
Definition: loop.c:547
osl_loop_p osl_loop_malloc()
Definition: loop.c:320
struct osl_loop * next
Definition: loop.h:100
Definition: loop.h:94
void osl_loop_idump(FILE *file, osl_loop_p loop, int level)
Definition: loop.c:91
osl_loop_p osl_loop_sread(char **input)
Definition: loop.c:259
int osl_loop_count(osl_loop_p ll)
Definition: loop.c:586
void osl_loop_free(osl_loop_p loop)
Definition: loop.c:341
char * private_vars
\0 terminated variable names
Definition: loop.h:98
int osl_loop_equal_one(osl_loop_p a1, osl_loop_p a2)
Definition: loop.c:436
int nb_stmts
Number of statements in the loop.
Definition: loop.h:96
void osl_loop_add(osl_loop_p loop, osl_loop_p *ll)
Definition: loop.c:570
struct osl_loop * osl_loop_p
Definition: loop.h:103
char * osl_loop_sprint(osl_loop_p loop)
Definition: loop.c:186