Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / snip_change_shlib_var.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
33 /*
34  * #Name: snip_change_shlib_var
35  * #Desc: use instrumentation to modify variable in shared library
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 
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 snip_change_shlib_var_Mutator : public DyninstMutator {
55         const char *libNameAroot;
56         const char *libNameBroot;
57         char libNameA[128], libNameB[128];
58
59         public:
60         snip_change_shlib_var_Mutator();
61         virtual test_results_t executeTest();
62         virtual test_results_t mutatorTest();
63 };
64
65 snip_change_shlib_var_Mutator::snip_change_shlib_var_Mutator() : libNameAroot("libtestA"),
66                                                                            libNameBroot("libtestB") 
67 {
68 }
69
70 extern "C" DLLEXPORT  TestMutator *snip_change_shlib_var_factory() 
71 {
72         return new snip_change_shlib_var_Mutator();
73 }
74
75 test_results_t snip_change_shlib_var_Mutator::mutatorTest() 
76 {
77         //  The check function returns 1 on success (value changed as expected)
78         //  or 0 on failure.
79         const char *check_fname  = "check_snip_change_shlib_var";
80         const char *inst_func_name = "scsv1";
81         BPatch_Vector<BPatch_function *> funcs;
82
83         appImage->findFunction(inst_func_name, funcs);
84         if (!funcs.size())
85         {
86                 logerror("%s[%d]:  failed to find function %s\n", FILE__, __LINE__, inst_func_name);
87                 return FAILED;
88         }
89         BPatch_function *inst_func = funcs[0];
90         funcs.clear();
91
92         appImage->findFunction(check_fname, funcs);
93         if (!funcs.size())
94         {
95                 logerror("%s[%d]:  failed to find function %s\n", FILE__, __LINE__, check_fname);
96                 return FAILED;
97         }
98         BPatch_function *check_func = funcs[0];
99
100         const char *vname = "snip_change_shlib_var";
101         BPatch_variableExpr *v = appImage->findVariable(vname);
102         if (!v)
103         {
104                 logerror("%s[%d]:  could not find variable %s\n", FILE__, __LINE__);
105                 return FAILED;
106         }
107
108         BPatch_Vector<BPatch_point *> *pts      = inst_func->findPoint(BPatch_entry);
109         if (!pts || !pts->size())
110         {
111                 logerror("%s[%d]:   failed to find entry point to %s\n", 
112                                 FILE__, __LINE__, inst_func_name);
113                 return FAILED;
114         }
115         BPatch_point *entry_point = (*pts)[0];
116
117         pts     = inst_func->findPoint(BPatch_exit);
118         if (!pts || !pts->size())
119         {
120                 logerror("%s[%d]:   failed to find exit point to %s\n", 
121                                 FILE__, __LINE__, inst_func_name);
122                 return FAILED;
123         }
124
125         BPatch_point *exit_point  = (*pts)[0];
126
127         const char *check_res_name = "gv_scsv1";
128         BPatch_variableExpr *check_result = appImage->findVariable(check_res_name);
129         if (!check_result)
130         {
131                 logerror("%s[%d]:  failed to find var %s\n", FILE__, __LINE__, check_res_name);
132                 return FAILED;
133         }
134
135         //  Snippet to assign new value to var in shared lib
136         //  inserted at entry of inst_func
137         BPatch_constExpr newval(777);
138         BPatch_arithExpr my_ass(BPatch_assign, *v, newval);
139
140         if (!appAddrSpace->insertSnippet(my_ass, *entry_point))
141         {
142                 logerror("%s[%d]:  failed to insert snippet\n", FILE__, __LINE__);
143                 return FAILED;
144         }
145
146         //  Snippet to call function in shared lib that checks the value of 
147         //  the variable that should have been properly changed.
148         //  Return value is assigned to global var in mutatee 
149         //  inserted at the exit of inst_func
150
151         BPatch_Vector<BPatch_snippet *> check_args;
152         BPatch_funcCallExpr checkCall(*check_func, check_args);
153         BPatch_arithExpr checkRes(BPatch_assign, *check_result, checkCall);
154
155         if (!appAddrSpace->insertSnippet(checkRes, *exit_point))
156         {
157                 logerror("%s[%d]:  failed to insert snippet\n", FILE__, __LINE__);
158                 return FAILED;
159         }
160
161         return PASSED;
162 }
163
164 test_results_t snip_change_shlib_var_Mutator::executeTest() 
165 {
166         int pointer_size = 0;
167 #if defined(arch_x86_64_test) || defined(ppc64_linux_test)
168         pointer_size = pointerSize(appImage);
169 #endif
170         strncpy(libNameA, libNameAroot, 128);
171         addLibArchExt(libNameA,128, pointer_size);
172         strncpy(libNameB, libNameBroot, 128);
173         addLibArchExt(libNameB,128, pointer_size);
174
175         char libA[128], libB[128];
176         snprintf(libA, 128, "./%s", libNameA);
177         snprintf(libB, 128, "./%s", libNameB);
178
179         if (! appAddrSpace->loadLibrary(libA)) 
180         {
181                 logerror("**Failed snip_change_shlib_var (findFunction in module)\n");
182                 logerror("  Mutator couldn't load %s into mutatee\n", libNameA);
183                 return FAILED;
184         }
185
186         if (! appAddrSpace->loadLibrary(libB)) 
187         {
188                 logerror("**Failed snip_change_shlib_var (findFunction in module)\n");
189                 logerror("  Mutator couldn't load %s into mutatee\n", libNameB);
190                 return FAILED;
191         }
192
193         return mutatorTest();
194 } // snip_change_shlib_var_Mutator::executeTest()
195