Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / test1_22.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_22.C,v 1.1 2008/10/30 19:18:25 legendre Exp $
33 /*
34  * #Name: test1_22
35  * #Desc: Mutator Side - Replace Function
36  * #Dep: 
37  * #Arch: sparc_sun_solaris2_4_test,i386_unknown_linux2_0_test,alpha_dec_osf4_0_test,ia64_unknown_linux2_4_test,x86_64_unknown_linux2_4_test
38  * #Notes: This test uses libNameA/B magic like test1_21
39  */
40
41 #include "BPatch.h"
42 #include "BPatch_Vector.h"
43 #include "BPatch_thread.h"
44 #include "BPatch_snippet.h"
45
46 #include "test_lib.h"
47 #include "dyninst_comp.h"
48
49 #ifdef os_windows_test
50 #define snprintf _snprintf
51 #endif
52
53
54 class test1_22_Mutator : public DyninstMutator {
55         const char *libNameAroot;
56         const char *libNameBroot;
57         char libNameA[128], libNameB[128];
58
59         public:
60         test1_22_Mutator();
61         virtual test_results_t executeTest();
62         virtual test_results_t mutatorTest22();
63 };
64
65 test1_22_Mutator::test1_22_Mutator() : libNameAroot("libtestA"),
66                                                                            libNameBroot("libtestB") 
67 {
68 }
69
70 extern "C" DLLEXPORT  TestMutator *test1_22_factory() 
71 {
72         return new test1_22_Mutator();
73 }
74
75 //
76 // Start Test Case #22 - mutator side (replace function)
77 //
78 // There is no corresponding failure (test2) testing because the only
79 // invalid input to replaceFunction is a non-existent BPatch_function.
80 // But this is already checked by the "non-existent function" test in
81 // test2.
82
83 test_results_t test1_22_Mutator::mutatorTest22() 
84 {
85         char errbuf[1024]; errbuf[0] = '\0';
86         BPatch_module *modA = NULL;
87         BPatch_module *modB = NULL;
88
89         // Assume that a prior test (mutatorTest21) has loaded the
90         // libraries libtestA.so and libtestB.so into the mutator.
91
92         BPatch_Vector<BPatch_module *> *mods = appImage->getModules();
93
94         if (!mods || mods->size() == 0) 
95         {
96                 logerror("**Failed test #22 (replace function)\n");
97                 logerror("  Mutator couldn't find shlib in mutatee\n");
98                 return FAILED;
99         }
100
101         // Lookup the libtestA.so and libtestB.so modules
102         for (unsigned int i = 0; i < mods->size() && !(modA && modB); i++) 
103         {
104                 char buf[1024];
105                 BPatch_module *m = (*mods)[i];
106                 m->getName(buf, 1024);
107                 // module names sometimes have "_module" appended
108                 if (!strcmpcase(libNameA, buf))
109                         modA = m;
110                 else if (!strcmpcase(libNameB, buf))
111                         modB = m;
112         }
113
114         if (! modA || ! modB) 
115         {
116                 logerror("**Failed test #22 (replace function)\n");
117                 logerror("  Mutator couldn't find dynamically loaded modules\n");
118                 return FAILED;
119         }
120
121         //  Mutatee function replacement scheme:
122
123         //  function      module     replaced    global
124         //                         or called?   
125
126         //  call22_1       a.out     replaced         1       global is the index
127         //  call22_2       a.out       called         1       of the global variable
128         //  call22_3       a.out     replaced         2       in test1.mutatee updated
129         //  call22_4    libtestA       called         2       by the function
130         //  call22_5A   libtestA     replaced         3
131         //  call22_5B   libtestB       called         3
132         //  call22_6    libtestA     replaced         4
133         //  call22_7       a.out       called         4
134
135         // Both of each pair of functions (e.g., call22_1, call22_2)
136         // increments a global variable.  The mutatee will test that the
137         // variable has been updated only be the "called" function.
138
139         // Replace an a.out with another a.out function
140
141         BPatch_Vector<BPatch_function *> bpfv;
142         char *fn = "test1_22_call1";
143         char *fn2 = "test1_22_call2";
144
145         if (NULL == appImage->findFunction(fn, bpfv) || !bpfv.size()
146                         || NULL == bpfv[0])
147         {
148                 logerror("**Failed test #22 (replace function)\n");
149                 logerror("    Unable to find function %s\n", fn);
150                 return FAILED;
151         }
152
153         BPatch_function *call22_1func = bpfv[0];
154
155         bpfv.clear();
156         if (NULL == appImage->findFunction(fn2, bpfv) || !bpfv.size()
157                         || NULL == bpfv[0])
158         {
159                 logerror("**Failed test #22 (replace function)\n");
160                 logerror("    Unable to find function %s\n", fn2);
161                 return FAILED;
162         }
163
164         BPatch_function *call22_2func = bpfv[0];
165
166         if (! appAddrSpace->replaceFunction(*call22_1func, *call22_2func)) 
167         {
168                 logerror("**Failed test #22 (replace function)\n");
169                 logerror("  Mutator couldn't replaceFunction (a.out -> a.out)\n");
170                 return FAILED;
171         }
172
173         // Replace an a.out function with a shlib function
174         bpfv.clear();
175         char *fn3 = "test1_22_call3";
176         if (NULL == appImage->findFunction(fn3, bpfv) || !bpfv.size()
177                         || NULL == bpfv[0]){
178                 logerror("**Failed test #22 (replace function)\n");
179                 logerror("    Unable to find function %s\n", fn3);
180                 return FAILED;
181         }
182
183         BPatch_function *call22_3func = bpfv[0];
184
185         BPatch_Vector<BPatch_function *> bpmv;
186         if (NULL == modA->findFunction("call22_4", bpmv) || !bpmv.size()) 
187         {
188                 logerror("**Failed test #22 (replace function)\n");
189                 logerror("  Mutator couldn't find functions in mutatee\n");
190                 return FAILED;
191         }
192         BPatch_function *call22_4func = bpmv[0];
193
194         if (! appAddrSpace->replaceFunction(*call22_3func, *call22_4func)) 
195         {
196                 logerror("**Failed test #22 (replace function)\n");
197                 logerror("  Mutator couldn't replaceFunction (a.out -> shlib)\n");
198                 return FAILED;
199         }
200
201         // Replace a shlib function with a shlib function
202         bpmv.clear();
203
204         if (NULL == modA->findFunction("call22_5a", bpmv) || !bpmv.size()) 
205         {
206                 logerror("**Failed test #22 (replace function)\n");
207                 logerror("  Mutator couldn't find functions in mutatee\n");
208                 return FAILED;
209         }
210
211         BPatch_function *call22_5Afunc = bpmv[0];
212
213         bpmv.clear();
214
215         if (NULL == modB->findFunction("call22_5b", bpmv) || !bpmv.size()) 
216         {
217                 logerror("**Failed test #22 (replace function)\n");
218                 logerror("  Mutator couldn't find functions in mutatee\n");
219                 return FAILED;
220         }
221
222         BPatch_function *call22_5Bfunc = bpmv[0];
223
224         if (! appAddrSpace->replaceFunction(*call22_5Afunc, *call22_5Bfunc)) 
225         {
226                 logerror("**Failed test #22 (replace function)\n");
227                 logerror("  Mutator couldn't replaceFunction (shlib -> shlib)\n");
228         }
229
230         // Replace a shlib function with an a.out function
231         bpmv.clear();
232
233         if (NULL == modA->findFunction("call22_6", bpmv) || !bpmv.size()) 
234         {
235                 logerror("**Failed test #22 (replace function)\n");
236                 logerror("  Mutator couldn't find functions in mutatee\n");
237                 return FAILED;
238         }
239
240         BPatch_function *call22_6func = bpmv[0];
241
242         bpfv.clear();
243         char *fn4 = "test1_22_call7";
244
245         if (NULL == appImage->findFunction(fn4, bpfv) || !bpfv.size()
246                         || NULL == bpfv[0])
247         {
248                 logerror("**Failed test #22 (replace function)\n");
249                 logerror("    Unable to find function %s\n", fn4);
250                 return FAILED;
251         }
252
253         BPatch_function *call22_7func = bpfv[0];
254
255         if (! appAddrSpace->replaceFunction(*call22_6func, *call22_7func)) 
256         {
257                 logerror("**Failed test #22 (replace function)\n");
258                 logerror("  Mutator couldn't replaceFunction (shlib -> a.out)\n");
259                 return FAILED;
260         }
261         return PASSED;
262 }
263
264
265 // Wrapper to call readyTest
266
267 test_results_t test1_22_Mutator::executeTest() 
268 {
269         int pointer_size = 0;
270 #if defined(arch_x86_64_test) || defined(ppc64_linux_test)
271         pointer_size = pointerSize(appImage);
272 #endif
273         strncpy(libNameA, libNameAroot, 127);
274         addLibArchExt(libNameA,127, pointer_size);
275         strncpy(libNameB, libNameBroot, 127);
276         addLibArchExt(libNameB,127, pointer_size);
277
278         char libA[128], libB[128];
279         snprintf(libA, 128, "./%s", libNameA);
280         snprintf(libB, 128, "./%s", libNameB);
281
282         if (! appAddrSpace->loadLibrary(libA)) 
283         {
284                 logerror("**Failed test1_22 (findFunction in module)\n");
285                 logerror("  Mutator couldn't load %s into mutatee\n", libA);
286                 return FAILED;
287         }
288
289         if (! appAddrSpace->loadLibrary(libB)) 
290         {
291                 logerror("**Failed test1_22 (findFunction in module)\n");
292                 logerror("  Mutator couldn't load %s into mutatee\n", libB);
293                 return FAILED;
294         }
295
296         return mutatorTest22();
297 } // test1_22_Mutator::executeTest()
298