Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / src / parRegion.h
1 /*
2  * Copyright (c) 1996-2009 Barton P. Miller
3  * 
4  * We provide the Paradyn Parallel Performance Tools (below
5  * described as "Paradyn") on an AS IS basis, and do not warrant its
6  * validity or performance.  We reserve the right to update, modify,
7  * or discontinue this software at any time.  We shall have no
8  * obligation to supply such updates or modifications or any other
9  * form of support to you.
10  * 
11  * By your use of Paradyn, you understand and agree that we (or any
12  * other person or entity with proprietary rights in Paradyn) are
13  * under no obligation to provide either maintenance services,
14  * update services, notices of latent defects, or correction of
15  * defects for Paradyn.
16  * 
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  * 
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * Lesser General Public License for more details.
26  * 
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30  */
31  
32
33 #ifndef PARREGION_H
34 #define PARREGION_H
35
36 #include <string>
37 #include "common/h/Vector.h"
38 #include "common/h/Types.h"
39 #include "common/h/Pair.h"
40 #include "codeRange.h"
41 #include "arch.h" // instruction
42 #include "dyninstAPI/h/BPatch_Set.h"
43 #include "dyninstAPI/h/BPatch_parRegion.h"
44 #include "common/h/Dictionary.h"
45 #include <map>
46
47 class process;
48 class mapped_module;
49 class mapped_object;
50
51 class pdmodule;
52 class image_func;
53
54 /*
55 typedef enum{
56   OMP_NONE, OMP_PARALLEL, OMP_DO_FOR,OMP_DO_FOR_LOOP_BODY, OMP_SECTIONS, OMP_SINGLE, 
57     OMP_PAR_DO, OMP_PAR_SECTIONS, OMP_MASTER, OMP_CRITICAL,
58     OMP_BARRIER, OMP_ATOMIC, OMP_FLUSH, OMP_ORDERED
59     } parRegType;
60 */
61
62 struct ltstr
63 {
64   bool operator()(const char* s1, const char* s2) const
65   {
66     return strcmp(s1, s2) < 0;
67   }
68 };
69
70
71 class image_parRegion : public codeRange {
72  public:
73   image_parRegion(image_func * imageFunc);
74   image_parRegion(Address firstOffset, image_func * imageFunc);
75  
76   Address firstInsnOffset() const { return firstInsnOffset_; }
77
78   void setLastInsn(Address last) { lastInsnOffset_ = last;}
79   Address lastInsnOffset() const { return lastInsnOffset_; }
80   Address getSize() const { return lastInsnOffset_ - firstInsnOffset_; }
81
82   Address get_address() const {return firstInsnOffset_; }
83   unsigned int get_size() const {return 0;}
84
85   parRegType getRegionType(){return regionType;}
86
87   void setRegionType(parRegType rt); 
88
89   image_func * getAssociatedFunc();
90
91   void setParentFunc(image_func * parentFunc){parentIf_ = parentFunc;}
92   image_func * getParentFunc(){return parentIf_;}
93
94   void setClause(const char * key, int value);
95   int getClause(const char * key);
96
97   void setClauseLoc(const char * key, Address value);
98   Address getClauseLoc(const char * key);
99   
100   void printDetails();
101
102   void decodeClauses(int bitmap);
103
104  private:
105   image_func *regionIf_;
106   image_func *parentIf_;
107   Address firstInsnOffset_;
108   Address lastInsnOffset_;
109   parRegType regionType;
110   std::map<const char*, int, ltstr> clauses;
111   std::map<const char*, Address, ltstr> clause_locations;
112 };
113
114
115 class int_parRegion {
116  public:
117   int_parRegion(image_parRegion *ip, Address baseAddr, int_function * );
118   ~int_parRegion();
119
120   Address firstInsnAddr() {return addr_;}
121   Address endAddr() {return endAddr_;}
122
123   const image_parRegion * imagePar() const { return ip_; }
124   
125   void printDetails() { ip_->printDetails(); }
126
127   const int_function * intFunc() { return intFunc_;}
128
129   int getClause(const char * key);
130   Address getClauseLoc(const char * key);
131
132   int replaceOMPParameter(const char * key, int value);
133
134   Address addr_; /* Absolute address of start of region */
135   Address endAddr_; /* Address of end of region */
136
137   int_function * intFunc_;
138
139   image_parRegion *ip_;
140 };
141
142
143
144
145 #endif /*PARREGION_H */