Remove old Makefile system; testsuite is currently unmodified.
[dyninst.git] / codeCoverage / h / CCOnDemandInstrument.h
1 /*
2  * See the dyninst/COPYRIGHT file for copyright information.
3  * 
4  * We provide the Paradyn Tools (below described as "Paradyn")
5  * on an AS IS basis, and do not warrant its validity or performance.
6  * We reserve the right to update, modify, or discontinue this
7  * software at any time.  We shall have no obligation to supply such
8  * updates or modifications or any other form of support to you.
9  * 
10  * By your use of Paradyn, you understand and agree that we (or any
11  * other person or entity with proprietary rights in Paradyn) are
12  * under no obligation to provide either maintenance services,
13  * update services, notices of latent defects, or correction of
14  * defects for Paradyn.
15  * 
16  * This library is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU Lesser General Public
18  * License as published by the Free Software Foundation; either
19  * version 2.1 of the License, or (at your option) any later version.
20  * 
21  * This library is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * Lesser General Public License for more details.
25  * 
26  * You should have received a copy of the GNU Lesser General Public
27  * License along with this library; if not, write to the Free Software
28  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
29  */
30
31 #ifndef _CCOnDemandInstrument_h_
32 #define _CCOnDemandInstrument_h_
33
34 #include <CodeCoverage.h>
35
36 /** class that inherits code coverage class for the code coverage
37   * that instruments a function in the executable that has
38   * line information available when the function is called first time.
39   * Due to the difference between initial instrumentation and the method 
40   * to run the program from the preisntrumentation this
41   * class is added to the software
42   */
43
44
45 class CCOnDemandInstrument : public CodeCoverage {
46 private:
47
48         /** field to identify which functions are actually
49           * executed during the run (instrumented).
50           */
51         bool* isExecuted;
52
53         /** instrumentation code to identify which function
54           * is called (executed) fro the first time. One for each.
55           */
56         BPatchSnippetHandle** firstInstrumentationHandles;
57
58         /** variable that stores the identifer of the function
59           * that is just called (executed).
60           */
61         BPatch_variableExpr* currentFunctionId;
62
63         /** method that handles the actions during the deletion
64           * intervals which happens in fixed time intervals
65           */
66         int deletionIntervalCallback();
67
68         /** method that returns true if a function is instrumented
69           * for code coverage. The argument given is the id of the
70           * function in the array kept in parent class
71           * @param i identifier of the function from the array of functions
72           */
73         bool isInstrumented(int i);     
74
75 public:
76
77         /** constructor of the class */
78         CCOnDemandInstrument();
79         
80         /** method to do the initial instrumentation to the functions
81           * whose source line information is available. Initial
82           * instrumentation is the instrumentation done before the
83           * the execution of the mutatee starts
84           */
85         int instrumentInitial(); 
86
87         /** method that run the mutatee program after the initial
88           * instrumentation
89           */
90         int run();
91
92         /** destructor of the class */
93         ~CCOnDemandInstrument();
94 };
95
96 #endif /* _CCOnDemandInstrument_h_ */