Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / h / BPatch_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 #ifndef _BPatch_parRegion_h_
33 #define _BPatch_parRegion_h_
34
35 #include "BPatch_dll.h"
36 #include "BPatch_Vector.h"
37 #include "BPatch_eventLock.h"
38
39 class int_parRegion;
40 class process;
41 class InstrucIter;
42 class BPatch_function;
43 class BPatch_instruction;
44 #include "Instruction.h"
45
46 typedef enum{
47   OMP_NONE, OMP_PARALLEL, OMP_DO_FOR,OMP_DO_FOR_LOOP_BODY, OMP_SECTIONS, OMP_SINGLE, 
48     OMP_PAR_DO, OMP_PAR_SECTIONS, OMP_MASTER, OMP_CRITICAL,
49     OMP_BARRIER, OMP_ATOMIC, OMP_FLUSH, OMP_ORDERED, OMP_ANY
50     } parRegType;
51
52 #ifdef DYNINST_CLASS_NAME
53 #undef DYNINST_CLASS_NAME
54 #endif
55 #define DYNINST_CLASS_NAME BPatch_parRegion
56
57 class BPATCH_DLL_EXPORT BPatch_parRegion: public BPatch_eventLock{
58   BPatch_function * func;
59   int_parRegion * parReg;
60   
61  public:
62   BPatch_parRegion(int_parRegion * _parReg, BPatch_function *  _func);
63   ~BPatch_parRegion();
64
65   int_parRegion *lowlevel_region() const {return parReg;}
66
67   void printDetails();
68
69
70    /** BPatch_basicBlock::getClause    */
71         
72    API_EXPORT(Int, (key),
73               int, getClause, (const char * key));
74
75
76    /** BPatch_basicBlock::replaceOMPParameter    */
77         
78    API_EXPORT(Int, (key, value),
79               int, replaceOMPParameter, (const char * key, int value));
80
81
82   /** BPatch_parRegion::getInstructions   */
83   /** return the instructions that belong to the block */
84
85   API_EXPORT(Int, (),
86              BPatch_Vector<BPatch_instruction *> *,getInstructions,());
87
88   API_EXPORT(Int, (insns),
89              bool, getInstructions, (std::vector<Dyninst::InstructionAPI::Instruction::Ptr>& insns));
90
91
92   /** BPatch_parRegion::size   */
93
94    API_EXPORT(Int, (),
95               unsigned,size,() CONST_EXPORT);
96
97    /** BPatch_parRegion::getStartAddress   */
98    //these always return absolute address
99
100    API_EXPORT(Int, (),
101               unsigned long,getStartAddress,() CONST_EXPORT);
102
103    /** BPatch_basicBlock::getEndAddress    */
104         
105    API_EXPORT(Int, (),
106               unsigned long, getEndAddress, () CONST_EXPORT);
107
108    
109  private:
110    /** the instructions within this region */
111    BPatch_Vector<BPatch_instruction*> *instructions;
112
113 };
114
115 #endif