Update copyright to LGPL on all files
[dyninst.git] / codeCoverage / h / CCPreInstrument.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 _CCPreInstrument_h_
33 #define _CCPreInstrument_h_
34
35 #include <CodeCoverage.h>
36
37 /** class that inherits code coverage class for the code coverage
38   * that preinstruments every function in the executable that has
39   * line information available. Due to the difference between 
40   * initial instrumentation and the method to run the program this
41   * class is added to the software
42   */
43
44 class CCPreInstrument: public CodeCoverage {
45 private:
46
47         /** method that handles the actions during the deletion
48           * intervals which happens in fixed time intervals
49           */
50         int deletionIntervalCallback();
51
52         /** method that returns true if a function is instrumented
53           * for code coverage. The argument given is the id of the
54           * function in the array kept in parent class 
55           * @param i identifier of the function from the array of functions
56           */
57         bool isInstrumented(int i);
58
59 public:
60
61         /** constructor of the class */
62         CCPreInstrument();
63
64         /** method to do the initial instrumentation to the functions
65           * whose source line information is available. Initial
66           * instrumentation is the instrumentation done before the
67           * the execution of the mutatee starts
68           */
69         int instrumentInitial(); 
70
71         /** method that run the mutatee program after the initial
72           * instrumentation
73           */
74         int run();
75
76         /** destructor of the class */
77         ~CCPreInstrument();
78 };
79
80 #endif /*_CCPreInstrument_h_*/