Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / test1_3.C
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 // $Id: test1_3.C,v 1.1 2008/10/30 19:18:54 legendre Exp $
33 /*
34  * #Name: test1_3
35  * #Desc: Mutator Side (passing variables to a function)
36  * #Arch: all
37  * #Dep: 
38  * #Note: Mutatee fortran
39  */
40
41 // TODO Make build system stitch these #includes onto the beginning of the
42 // test file
43
44 #include "BPatch.h"
45 #include "BPatch_Vector.h"
46 #include "BPatch_thread.h"
47 #include "BPatch_snippet.h"
48
49 #include "test_lib.h"
50
51 // ********************************************************************
52 // *** Everything above this line should be automatically generated ***
53 // ********************************************************************
54
55 #include "dyninst_comp.h"
56
57 class test1_3_Mutator : public DyninstMutator {
58         virtual test_results_t executeTest();
59 };
60
61 extern "C" DLLEXPORT  TestMutator *test1_3_factory() 
62 {
63         return new test1_3_Mutator();
64 }
65
66 //
67 // Start Test Case #3 - mutator side (passing variables to function)
68 //
69
70 test_results_t test1_3_Mutator::executeTest() 
71 {
72         // Find the entry point to the procedure "func3_1"
73         const char *funcName = "test1_3_func3_1";
74
75         BPatch_Vector<BPatch_function *> found_funcs;
76         if ((NULL == appImage->findFunction(funcName, found_funcs))
77                         || !found_funcs.size()) 
78         {
79                 logerror("    Unable to find function %s\n", funcName);
80                 return FAILED;
81         }
82
83         if (1 < found_funcs.size()) 
84         {
85                 logerror("%s[%d]:  WARNING  : found %d functions named %s.  Using the first.\n", 
86                                 __FILE__, __LINE__, found_funcs.size(), funcName);
87         }
88
89         BPatch_Vector<BPatch_point *> *point3_1 = found_funcs[0]->findPoint(BPatch_entry);
90
91         if (!point3_1 || ((*point3_1).size() == 0)) 
92         {
93                 logerror("Unable to find entry point to \"%s.\"\n", funcName);
94                 return FAILED;
95         }
96
97         BPatch_Vector<BPatch_function *> bpfv;
98         char *fn = "test1_3_call3_1";
99
100         if (NULL == appImage->findFunction(fn, bpfv) || !bpfv.size()
101                         || NULL == bpfv[0])
102         {
103                 logerror("    Unable to find function %s\n", fn);
104                 return FAILED;
105         }
106
107         if (1 < bpfv.size()) 
108         {
109                 logerror("%s[%d]:  WARNING  : found %d functions named %s.  Using the first.\n", 
110                                 __FILE__, __LINE__, bpfv.size(), fn);
111         }
112
113         BPatch_function *call3_func = bpfv[0];
114
115         BPatch_Vector<BPatch_snippet *> call3_args;
116
117         BPatch_Vector<BPatch_point *> *call3_1 = call3_func->findPoint(BPatch_subroutine);
118
119         if (!call3_1 || ((*call3_1).size() == 0)) 
120         {
121                 logerror("    Unable to find subroutine calls in \"call3_1.\"\n");
122                 return FAILED;
123         }
124
125         const char *globalVar = "test1_3_globalVariable3_1";
126
127         BPatch_variableExpr *expr3_1 = findVariable(appImage, globalVar, call3_1);
128
129         if (!expr3_1) 
130         {
131                 logerror("**Failed** test #3 (passing variables)\n");
132                 logerror("    Unable to locate variable %s\n", globalVar);
133                 return FAILED;
134         }
135
136         // see if we can find the address
137         if (expr3_1->getBaseAddr() <= 0) 
138         {
139                 logerror("*Error*: address %p for %s is not valid\n",
140                                 expr3_1->getBaseAddr(), globalVar);
141         }
142
143         BPatch_variableExpr *expr3_2 = appAddrSpace->malloc(*appImage->findType("int"));
144
145         if (!expr3_2) 
146         {
147                 logerror("**Failed** test #3 (passing variables)\n");
148                 logerror("    Unable to create new int variable\n");
149                 return FAILED;
150         }
151
152         BPatch_constExpr expr3_3 (expr3_1->getBaseAddr ());
153         BPatch_constExpr expr3_4 (expr3_2->getBaseAddr ());
154
155         int mutateeFortran = isMutateeFortran(appImage);
156
157         if (mutateeFortran) 
158         {
159                 call3_args.push_back (&expr3_3);
160                 call3_args.push_back (&expr3_4);
161         } 
162         else 
163         {
164                 call3_args.push_back(expr3_1);
165                 call3_args.push_back(expr3_2);
166         }
167
168         BPatch_funcCallExpr call3Expr(*call3_func, call3_args);
169         checkCost(call3Expr);
170         appAddrSpace->insertSnippet(call3Expr, *point3_1);
171
172         BPatch_arithExpr expr3_5(BPatch_assign, *expr3_2, BPatch_constExpr(32));
173         checkCost(expr3_5);
174         appAddrSpace->insertSnippet(expr3_5, *point3_1);
175
176         dprintf("Inserted snippet3\n");
177
178         return PASSED;
179 }