Remove old testsuite
[dyninst.git] / testsuite / src / dyninst / test_fork_12.C
1 /*
2  * Copyright (c) 1996-2004 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  * This license is for research uses.  For such uses, there is no
12  * charge. We define "research use" to mean you may freely use it
13  * inside your organization for whatever purposes you see fit. But you
14  * may not re-distribute Paradyn or parts of Paradyn, in any form
15  * source or binary (including derivatives), electronic or otherwise,
16  * to any other organization or entity without our permission.
17  * 
18  * (for other uses, please contact us at paradyn@cs.wisc.edu)
19  * 
20  * All warranties, including without limitation, any warranty of
21  * merchantability or fitness for a particular purpose, are hereby
22  * excluded.
23  * 
24  * By your use of Paradyn, you understand and agree that we (or any
25  * other person or entity with proprietary rights in Paradyn) are
26  * under no obligation to provide either maintenance services,
27  * update services, notices of latent defects, or correction of
28  * defects for Paradyn.
29  * 
30  * Even if advised of the possibility of such damages, under no
31  * circumstances shall we (or any other person or entity with
32  * proprietary rights in the software licensed hereunder) be liable
33  * to you or any third party for direct, indirect, or consequential
34  * damages of any character regardless of type of action, including,
35  * without limitation, loss of profits, loss of use, loss of good
36  * will, or computer failure or malfunction.  You agree to indemnify
37  * us (and any other person or entity with proprietary rights in the
38  * software licensed hereunder) for any and all liability it may
39  * incur to third parties resulting from your use of Paradyn.
40  */
41
42 // $Id: test_fork_12.C,v 1.1 2008/10/30 19:21:32 legendre Exp $
43 /*
44  * #Name: test7_8
45  * #Desc: Memory deallocate in child
46  * #Arch: all
47  * #Dep: 
48  */
49
50 #include "BPatch.h"
51 #include "BPatch_Vector.h"
52 #include "BPatch_thread.h"
53 #include "BPatch_snippet.h"
54
55 #include "test_lib.h"
56 #include "test_lib_test7.h"
57
58 #include "dyninst_comp.h"
59 class test_fork_12_Mutator : public DyninstMutator {
60 private:
61   BPatch *bpatch;
62
63 public:
64   virtual bool hasCustomExecutionPath() { return true; }
65   virtual test_results_t setup(ParameterDict &param);
66   virtual test_results_t executeTest();
67 };
68 extern "C" DLLEXPORT TestMutator *test_fork_12_factory() {
69   return new test_fork_12_Mutator();
70 }
71
72 static bool parentDone;
73 static bool childDone;
74 static bool passedTest;
75 static BPatch_thread *parentThread;
76 static BPatch_thread *childThread;
77 static int msgid;
78
79
80 /* Verify that if a variable in the child process is freed with 
81    BPatch_thread::free, the corresponding variable in the parent process
82    isn't also deleted.
83
84    parent/child: malloc a variable
85    parent/child: oneTimeCode(snippetA)  (malloced variable = 10)
86    --- fork ---
87    parent: insert snippet B  (malloced_var += 3);
88    child:  free(getInheritedVariable(malloced_var))
89    --- run  ---
90    parent: verify malloced_var = 13
91    (no way to verify the child variable has indeed been freed)
92 */
93
94 static BPatch_variableExpr *var7_8p;
95
96 static void prepareTestCase8(procType proc_type, BPatch_thread *thread, forkWhen when)
97 {
98    if(proc_type == Parent_p  &&  when == PreFork) {
99       BPatch_image *parImage = thread->getImage();
100       var7_8p = thread->malloc(*(parImage->findType("int")));
101       if(doError(&passedTest, (var7_8p==NULL),
102                  "  Unable to malloc variable in parent\n")) return;
103
104       BPatch_arithExpr a_expr7_8p(BPatch_assign, *var7_8p,
105                                   BPatch_constExpr(10));
106       thread->oneTimeCode(a_expr7_8p);
107    } else if(proc_type == Parent_p  &&  when == PostFork) {
108       BPatch_image *parImage = thread->getImage();
109
110       BPatch_Vector<BPatch_function *> found_funcs;
111       const char *inFunction = "test_fork_12_func1";
112       if ((NULL == parImage->findFunction(inFunction, found_funcs, 1)) || !found_funcs.size()) {
113         logerror("    Unable to find function %s\n",
114                 inFunction);
115         exit(1);
116       }
117       
118       if (1 < found_funcs.size()) {
119         logerror("%s[%d]:  WARNING  : found %d functions named %s.  Using the first.\n", 
120                 __FILE__, __LINE__, found_funcs.size(), inFunction);
121       }
122       
123       BPatch_Vector<BPatch_point *> *points7_8p = found_funcs[0]->findPoint(BPatch_entry);
124
125       if(doError(&passedTest, !points7_8p || ((*points7_8p).size() == 0),
126                  "  Unable to find entry point to \"test_fork_12_func1\".\n")) return;
127       BPatch_point *point7_8p = (*points7_8p)[0];
128
129       BPatch_arithExpr a_expr7_8p(BPatch_plus, *var7_8p, BPatch_constExpr(3));
130       BPatch_arithExpr b_expr7_8p(BPatch_assign, *var7_8p, a_expr7_8p);
131
132       thread->insertSnippet(b_expr7_8p, *point7_8p, BPatch_callBefore);
133    } else if(proc_type == Child_p  &&  when == PostFork) {
134       BPatch_variableExpr *var7_8c = thread->getInheritedVariable(*var7_8p);
135       thread->free(*var7_8c);
136    }
137 }
138
139 static void checkTestCase8(procType proc_type, BPatch_thread * /*thread*/) {
140    char varname[50];
141    sprintf(varname,"test%d malloced var",8);
142    if(proc_type == Parent_p) {
143       if(! verifyProcMemory(varname, var7_8p, 13, proc_type)) {
144          passedTest = false;
145       }
146    }
147 }
148
149
150 /* We make changes at post-fork */
151 static void postForkFunc(BPatch_thread *parent, BPatch_thread *child)
152 {
153     //dprintf("in postForkFunc\n");
154     /* For later identification */
155     childThread = child;
156     dprintf("Preparing tests on parent\n");
157     prepareTestCase8(Parent_p, parent, PostFork);
158     dprintf("Preparing tests on child\n");
159     prepareTestCase8(Child_p,  child,  PostFork);
160     dprintf("Fork handler finished (parent %p, child %p)\n", parent, child);
161 }
162
163 /* And verify them when they exit */
164 static void exitFunc(BPatch_thread *thread, BPatch_exitType exit_type) {
165     dprintf("Exit func called\n");
166     if (thread == parentThread) {
167         dprintf("Parent exit reached, checking...\n");
168         checkTestCase8(Parent_p, thread);
169         parentDone = true;
170         dprintf("Parent done\n");
171     }
172     else if (thread == childThread) {
173         dprintf("Child exit reached, checking...\n");
174         checkTestCase8(Child_p, thread);
175         dprintf("Child done\n");
176         childDone = true;
177     }
178     else {
179         dprintf("Thread ptr 0x%x, parent 0x%x, child 0x%x\n",
180                 thread, parentThread, childThread);
181         assert(0 && "Unexpected BPatch_thread in exitFunc");
182     }
183     return;
184 }
185
186 static void initialPreparation(BPatch_thread *parent)
187 {
188    //cerr << "in initialPreparation\n";
189    assert(parent->isStopped());
190
191    //cerr << "ok, inserting instr\n";
192    prepareTestCase8(Parent_p, parent, PreFork);
193 }
194
195 static int mutatorTest(BPatch *bpatch, BPatch_thread *appThread)
196 {
197     if ( !setupMessaging(&msgid) )
198     {
199        passedTest = false;
200        return passedTest;
201     }
202
203     parentThread = appThread;
204
205     initialPreparation(parentThread);
206     /* ok, do the fork */;
207     parentThread->continueExecution();
208
209     /* the rest of the execution occurs in postForkFunc() */
210     /* Secondary test: we should not have to manually continue
211        either parent or child at any point */
212
213     while ( !parentThread->isTerminated() ) 
214     {
215        bpatch->waitForStatusChange();
216     }
217
218     // At this point if childThread == NULL the postfork handler failed
219     // to run.  Fail gracefully instead of segfaulting on 
220     // childThread->isTerminated()
221     if (doError(&passedTest, childThread == NULL,
222              "childThread == NULL: postForkFunc must not have run\n") )
223     {
224        return passedTest;
225     }
226     
227     if ( !childThread->isTerminated() )
228     {
229        bpatch->waitForStatusChange();
230     }
231
232     return passedTest;
233 }
234
235 test_results_t test_fork_12_Mutator::executeTest() {
236   // Initialize global variables
237   parentDone = false;
238   childDone = false;
239   passedTest = true;
240   parentThread = NULL;
241   childThread = NULL;
242   msgid = -1;
243
244   // Register callbacks
245   bpatch->registerPostForkCallback(postForkFunc);
246   bpatch->registerExitCallback(exitFunc);
247
248   bool passed = mutatorTest(bpatch, appThread);
249
250   // Remove callbacks upon test completion
251   bpatch->registerPostForkCallback(NULL);
252   bpatch->registerExitCallback(NULL);
253
254   showFinalResults(passed, 8);
255   if ( passed )
256     return PASSED;
257   else
258     return FAILED;
259 }
260
261
262 test_results_t test_fork_12_Mutator::setup(ParameterDict &param) {
263 #ifdef os_windows_test
264   return SKIPPED;
265 #else
266   bpatch = (BPatch *)(param["bpatch"]->getPtr());
267   appThread = (BPatch_thread *)(param["appThread"]->getPtr());
268
269   return PASSED;
270 #endif
271 }