Instruction API initial integration part 2 of 3: removal of spurious InstrucIter...
[dyninst.git] / dyninstAPI / src / parRegion.h
1 /*
2  * Copyright (c) 1996-2006 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41  
42
43 #ifndef PARREGION_H
44 #define PARREGION_H
45
46 #include <string>
47 #include "common/h/Vector.h"
48 #include "common/h/Types.h"
49 #include "common/h/Pair.h"
50 #include "codeRange.h"
51 #include "arch.h" // instruction
52 #include "dyninstAPI/h/BPatch_Set.h"
53 #include "dyninstAPI/h/BPatch_parRegion.h"
54 #include "common/h/Dictionary.h"
55 #include <map>
56
57 class process;
58 class mapped_module;
59 class mapped_object;
60
61 class pdmodule;
62 class image_func;
63
64 /*
65 typedef enum{
66   OMP_NONE, OMP_PARALLEL, OMP_DO_FOR,OMP_DO_FOR_LOOP_BODY, OMP_SECTIONS, OMP_SINGLE, 
67     OMP_PAR_DO, OMP_PAR_SECTIONS, OMP_MASTER, OMP_CRITICAL,
68     OMP_BARRIER, OMP_ATOMIC, OMP_FLUSH, OMP_ORDERED
69     } parRegType;
70 */
71
72 struct ltstr
73 {
74   bool operator()(const char* s1, const char* s2) const
75   {
76     return strcmp(s1, s2) < 0;
77   }
78 };
79
80
81 class image_parRegion : public codeRange {
82  public:
83   image_parRegion(image_func * imageFunc);
84   image_parRegion(Address firstOffset, image_func * imageFunc);
85  
86   Address firstInsnOffset() const { return firstInsnOffset_; }
87
88   void setLastInsn(Address last) { lastInsnOffset_ = last;}
89   Address lastInsnOffset() const { return lastInsnOffset_; }
90   Address getSize() const { return lastInsnOffset_ - firstInsnOffset_; }
91
92   Address get_address() const {return firstInsnOffset_; }
93   unsigned int get_size() const {return 0;}
94
95   parRegType getRegionType(){return regionType;}
96
97   void setRegionType(parRegType rt); 
98
99   image_func * getAssociatedFunc();
100
101   void setParentFunc(image_func * parentFunc){parentIf_ = parentFunc;}
102   image_func * getParentFunc(){return parentIf_;}
103
104   void setClause(const char * key, int value);
105   int getClause(const char * key);
106
107   void setClauseLoc(const char * key, Address value);
108   Address getClauseLoc(const char * key);
109   
110   void printDetails();
111
112   void decodeClauses(int bitmap);
113
114  private:
115   image_func *regionIf_;
116   image_func *parentIf_;
117   Address firstInsnOffset_;
118   Address lastInsnOffset_;
119   parRegType regionType;
120   std::map<const char*, int, ltstr> clauses;
121   std::map<const char*, Address, ltstr> clause_locations;
122 };
123
124
125 class int_parRegion {
126  public:
127   int_parRegion(image_parRegion *ip, Address baseAddr, int_function * );
128   ~int_parRegion();
129
130   Address firstInsnAddr() {return addr_;}
131   Address endAddr() {return endAddr_;}
132
133   const image_parRegion * imagePar() const { return ip_; }
134   
135   void printDetails() { ip_->printDetails(); }
136
137   const int_function * intFunc() { return intFunc_;}
138
139   int getClause(const char * key);
140   Address getClauseLoc(const char * key);
141
142   int replaceOMPParameter(const char * key, int value);
143
144   Address addr_; /* Absolute address of start of region */
145   Address endAddr_; /* Address of end of region */
146
147   int_function * intFunc_;
148
149   image_parRegion *ip_;
150 };
151
152
153
154
155 #endif /*PARREGION_H */