Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / test_fork_12.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: test_fork_12.C,v 1.1 2008/10/30 19:21:32 legendre Exp $
33 /*
34  * #Name: test7_8
35  * #Desc: Memory deallocate in child
36  * #Arch: all
37  * #Dep: 
38  */
39
40 #include "BPatch.h"
41 #include "BPatch_Vector.h"
42 #include "BPatch_thread.h"
43 #include "BPatch_snippet.h"
44
45 #include "test_lib.h"
46 #include "test_lib_test7.h"
47
48 #include "dyninst_comp.h"
49 class test_fork_12_Mutator : public DyninstMutator {
50 private:
51   BPatch *bpatch;
52
53 public:
54   virtual bool hasCustomExecutionPath() { return true; }
55   virtual test_results_t setup(ParameterDict &param);
56   virtual test_results_t executeTest();
57 };
58 extern "C" DLLEXPORT TestMutator *test_fork_12_factory() {
59   return new test_fork_12_Mutator();
60 }
61
62 static bool parentDone;
63 static bool childDone;
64 static bool passedTest;
65 static BPatch_thread *parentThread;
66 static BPatch_thread *childThread;
67 static int msgid;
68
69
70 /* Verify that if a variable in the child process is freed with 
71    BPatch_thread::free, the corresponding variable in the parent process
72    isn't also deleted.
73
74    parent/child: malloc a variable
75    parent/child: oneTimeCode(snippetA)  (malloced variable = 10)
76    --- fork ---
77    parent: insert snippet B  (malloced_var += 3);
78    child:  free(getInheritedVariable(malloced_var))
79    --- run  ---
80    parent: verify malloced_var = 13
81    (no way to verify the child variable has indeed been freed)
82 */
83
84 static BPatch_variableExpr *var7_8p;
85
86 static void prepareTestCase8(procType proc_type, BPatch_thread *thread, forkWhen when)
87 {
88    if(proc_type == Parent_p  &&  when == PreFork) {
89       BPatch_image *parImage = thread->getImage();
90       var7_8p = thread->malloc(*(parImage->findType("int")));
91       if(doError(&passedTest, (var7_8p==NULL),
92                  "  Unable to malloc variable in parent\n")) return;
93
94       BPatch_arithExpr a_expr7_8p(BPatch_assign, *var7_8p,
95                                   BPatch_constExpr(10));
96       thread->oneTimeCode(a_expr7_8p);
97    } else if(proc_type == Parent_p  &&  when == PostFork) {
98       BPatch_image *parImage = thread->getImage();
99
100       BPatch_Vector<BPatch_function *> found_funcs;
101       const char *inFunction = "test_fork_12_func1";
102       if ((NULL == parImage->findFunction(inFunction, found_funcs, 1)) || !found_funcs.size()) {
103         logerror("    Unable to find function %s\n",
104                 inFunction);
105         exit(1);
106       }
107       
108       if (1 < found_funcs.size()) {
109         logerror("%s[%d]:  WARNING  : found %d functions named %s.  Using the first.\n", 
110                 __FILE__, __LINE__, found_funcs.size(), inFunction);
111       }
112       
113       BPatch_Vector<BPatch_point *> *points7_8p = found_funcs[0]->findPoint(BPatch_entry);
114
115       if(doError(&passedTest, !points7_8p || ((*points7_8p).size() == 0),
116                  "  Unable to find entry point to \"test_fork_12_func1\".\n")) return;
117       BPatch_point *point7_8p = (*points7_8p)[0];
118
119       BPatch_arithExpr a_expr7_8p(BPatch_plus, *var7_8p, BPatch_constExpr(3));
120       BPatch_arithExpr b_expr7_8p(BPatch_assign, *var7_8p, a_expr7_8p);
121
122       thread->insertSnippet(b_expr7_8p, *point7_8p, BPatch_callBefore);
123    } else if(proc_type == Child_p  &&  when == PostFork) {
124       BPatch_variableExpr *var7_8c = thread->getInheritedVariable(*var7_8p);
125       thread->free(*var7_8c);
126    }
127 }
128
129 static void checkTestCase8(procType proc_type, BPatch_thread * /*thread*/) {
130    char varname[50];
131    sprintf(varname,"test%d malloced var",8);
132    if(proc_type == Parent_p) {
133       if(! verifyProcMemory(varname, var7_8p, 13, proc_type)) {
134          passedTest = false;
135       }
136    }
137 }
138
139
140 /* We make changes at post-fork */
141 static void postForkFunc(BPatch_thread *parent, BPatch_thread *child)
142 {
143     //dprintf("in postForkFunc\n");
144     /* For later identification */
145     childThread = child;
146     dprintf("Preparing tests on parent\n");
147     prepareTestCase8(Parent_p, parent, PostFork);
148     dprintf("Preparing tests on child\n");
149     prepareTestCase8(Child_p,  child,  PostFork);
150     dprintf("Fork handler finished (parent %p, child %p)\n", parent, child);
151 }
152
153 /* And verify them when they exit */
154 static void exitFunc(BPatch_thread *thread, BPatch_exitType exit_type) {
155     dprintf("Exit func called\n");
156     if (thread == parentThread) {
157         dprintf("Parent exit reached, checking...\n");
158         checkTestCase8(Parent_p, thread);
159         parentDone = true;
160         dprintf("Parent done\n");
161     }
162     else if (thread == childThread) {
163         dprintf("Child exit reached, checking...\n");
164         checkTestCase8(Child_p, thread);
165         dprintf("Child done\n");
166         childDone = true;
167     }
168     else {
169         dprintf("Thread ptr 0x%x, parent 0x%x, child 0x%x\n",
170                 thread, parentThread, childThread);
171         assert(0 && "Unexpected BPatch_thread in exitFunc");
172     }
173     return;
174 }
175
176 static void initialPreparation(BPatch_thread *parent)
177 {
178    //cerr << "in initialPreparation\n";
179    assert(parent->isStopped());
180
181    //cerr << "ok, inserting instr\n";
182    prepareTestCase8(Parent_p, parent, PreFork);
183 }
184
185 static int mutatorTest(BPatch *bpatch, BPatch_thread *appThread)
186 {
187     if ( !setupMessaging(&msgid) )
188     {
189        passedTest = false;
190        return passedTest;
191     }
192
193     parentThread = appThread;
194
195     initialPreparation(parentThread);
196     /* ok, do the fork */;
197     parentThread->continueExecution();
198
199     /* the rest of the execution occurs in postForkFunc() */
200     /* Secondary test: we should not have to manually continue
201        either parent or child at any point */
202
203     while ( !parentThread->isTerminated() ) 
204     {
205        bpatch->waitForStatusChange();
206     }
207
208     // At this point if childThread == NULL the postfork handler failed
209     // to run.  Fail gracefully instead of segfaulting on 
210     // childThread->isTerminated()
211     if (doError(&passedTest, childThread == NULL,
212              "childThread == NULL: postForkFunc must not have run\n") )
213     {
214        return passedTest;
215     }
216     
217     if ( !childThread->isTerminated() )
218     {
219        bpatch->waitForStatusChange();
220     }
221
222     return passedTest;
223 }
224
225 test_results_t test_fork_12_Mutator::executeTest() {
226   // Initialize global variables
227   parentDone = false;
228   childDone = false;
229   passedTest = true;
230   parentThread = NULL;
231   childThread = NULL;
232   msgid = -1;
233
234   // Register callbacks
235   bpatch->registerPostForkCallback(postForkFunc);
236   bpatch->registerExitCallback(exitFunc);
237
238   bool passed = mutatorTest(bpatch, appThread);
239
240   // Remove callbacks upon test completion
241   bpatch->registerPostForkCallback(NULL);
242   bpatch->registerExitCallback(NULL);
243
244   showFinalResults(passed, 8);
245   if ( passed )
246     return PASSED;
247   else
248     return FAILED;
249 }
250
251
252 test_results_t test_fork_12_Mutator::setup(ParameterDict &param) {
253 #ifdef os_windows_test
254   return SKIPPED;
255 #else
256   bpatch = (BPatch *)(param["bpatch"]->getPtr());
257   appThread = (BPatch_thread *)(param["appThread"]->getPtr());
258
259   return PASSED;
260 #endif
261 }