Update copyright to LGPL on all files
[dyninst.git] / testsuite / src / dyninst / test_thread_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: test_thread_3.C,v 1.1 2008/10/30 19:22:30 legendre Exp $
33 /*
34  * #Name: test12_4
35  * #Desc: thread create callback -- doa
36  * #Dep: 
37  * #Arch: all
38  * #Notes:
39  */
40
41 #include <vector>
42 using std::vector;
43 #include "BPatch.h"
44 #include "BPatch_Vector.h"
45 #include "BPatch_thread.h"
46 #include "BPatch_snippet.h"
47
48 #include "test_lib.h"
49 #include "test12.h"
50
51 #include "dyninst_comp.h"
52 class test_thread_3_Mutator : public DyninstMutator {
53 private:
54   BPatch *bpatch;
55
56   void dumpVars();
57   bool setVar(const char *vname, void *addr, int testno, const char *testname);
58   bool getVar(const char *vname, void *addr, int len, int testno,
59               const char *testname);
60
61 public:
62   virtual bool hasCustomExecutionPath() { return true; }
63   virtual test_results_t setup(ParameterDict &param);
64   virtual test_results_t executeTest();
65 };
66 extern "C" DLLEXPORT TestMutator *test_thread_3_factory() {
67   return new test_thread_3_Mutator();
68 }
69
70 #define TESTNO 4
71 #define TESTNAME "test_thread_3"
72 #define TESTDESC "thread create callback - doa"
73
74 static int debugPrint;
75
76 void test_thread_3_Mutator::dumpVars() {
77   BPatch_Vector<BPatch_variableExpr *> vars;
78   appImage->getVariables(vars);
79   for (unsigned int i = 0; i < vars.size(); ++i) {
80     logerror("\t%s\n", vars[i]->getName());
81   }
82 }
83
84 // Returns false on success, true on error
85 bool test_thread_3_Mutator::setVar(const char *vname, void *addr, int testno,
86                                   const char *testname) {
87    BPatch_variableExpr *v;
88    void *buf = addr;
89    if (NULL == (v = appImage->findVariable(vname))) {
90       logerror("**Failed test #%d (%s)\n", testno, testname);
91       logerror("  cannot find variable %s, avail vars:\n", vname);
92       dumpVars();
93       return true;
94    }
95
96    if (! v->writeValue(buf, sizeof(int),true)) {
97       logerror("**Failed test #%d (%s)\n", testno, testname);
98       logerror("  failed to write call site var to mutatee\n");
99       return true;
100    }
101    return false;
102 }
103
104 // Returns false on success, true on error
105 bool test_thread_3_Mutator::getVar(const char *vname, void *addr, int len,
106                                    int testno, const char *testname) {
107    BPatch_variableExpr *v;
108    if (NULL == (v = appImage->findVariable(vname))) {
109       logerror("**Failed test #%d (%s)\n", testno, testname);
110       logerror("  cannot find variable %s: avail vars:\n", vname);
111       dumpVars();
112       return true;
113    }
114
115    if (! v->readValue(addr, len)) {
116       logerror("**Failed test #%d (%s)\n", testno, testname);
117       logerror("  failed to read var in mutatee\n");
118       return true;
119    }
120    return false;
121 }
122
123
124
125 static vector<unsigned long> callback_tids;
126 static int test3_threadCreateCounter = 0;
127 static void threadCreateCB(BPatch_process * proc, BPatch_thread *thr)
128 {
129   assert(thr);  
130   if (debugPrint)
131      dprintf("%s[%d]:  thread %lu start event for pid %d\n", __FILE__, __LINE__,
132                thr->getTid(), thr->getPid());
133   test3_threadCreateCounter++;
134   callback_tids.push_back(thr->getTid());
135   if (thr->isDeadOnArrival()) {
136      dprintf("%s[%d]:  thread %lu is doa \n", __FILE__, __LINE__, thr->getTid());
137   }
138 }
139
140 // static bool mutatorTest3and4(int testno, const char *testname)
141 test_results_t test_thread_3_Mutator::executeTest() {
142   test3_threadCreateCounter = 0;
143   callback_tids.clear();
144
145   unsigned int timeout = 0; // in ms
146   int err = 0;
147
148   BPatchAsyncThreadEventCallback createcb = threadCreateCB;
149   if (!bpatch->registerThreadEventCallback(BPatch_threadCreateEvent, createcb))
150   {
151     FAIL_MES(TESTNAME, TESTDESC);
152     logerror("%s[%d]:  failed to register thread callback\n",
153            __FILE__, __LINE__);
154     appThread->getProcess()->terminateExecution();
155     return FAILED;
156   }
157
158 #if 0
159   //  unset mutateeIde to trigger thread (10) spawn.
160   int zero = 0;
161   // FIXME Check the return value of setVar()
162   setVar("mutateeIdle", (void *) &zero, TESTNO, TESTDESC);
163   dprintf("%s[%d]:  continue execution for test %d\n", __FILE__, __LINE__, TESTNO);
164   appThread->continueExecution();
165 #endif
166
167   //  wait until we have received the desired number of events
168   //  (or timeout happens)
169
170   BPatch_Vector<BPatch_thread *> threads;
171   BPatch_process *appProc = appThread->getProcess();
172   assert(appProc);
173   appProc->getThreads(threads);
174   int active_threads = 11; // FIXME Magic number
175   threads.clear();
176   while (((test3_threadCreateCounter < TEST3_THREADS)
177          || (active_threads > 1))
178          && (timeout < TIMEOUT)) {
179     dprintf("%s[%d]: waiting for completion for test %d, num active threads = %d\n",
180             __FILE__, __LINE__, TESTNO, active_threads);
181     sleep_ms(SLEEP_INTERVAL/*ms*/);
182     timeout += SLEEP_INTERVAL;
183     if (appThread->isTerminated()) {
184        dprintf("%s[%d]:  BAD NEWS:  somehow the process died\n", __FILE__, __LINE__);
185        err = 1;
186        break;
187     }
188     bpatch->pollForStatusChange();
189     if (appThread->isStopped()) {
190        appThread->continueExecution();
191     }
192     appProc->getThreads(threads);
193     active_threads = threads.size();
194     threads.clear();
195   }
196
197   if (timeout >= TIMEOUT) {
198     FAIL_MES(TESTNAME, TESTDESC);
199     logerror("%s[%d]:  test timed out. got %d/10 events\n", __FILE__, __LINE__, test3_threadCreateCounter);
200     logerror("test3_createCounter is %d, expected %d; active threads %d, expected %d\n",
201             test3_threadCreateCounter, TEST3_THREADS, active_threads, 1);
202     err = 1;
203   }
204
205   dprintf("%s[%d]: ending test %d, num active threads = %d\n",
206             __FILE__, __LINE__, TESTNO, active_threads);
207   dprintf("%s[%d]:  stop execution for test %d\n", __FILE__, __LINE__, TESTNO);
208   appThread->stopExecution();
209
210   //   read all tids from the mutatee and verify that we got them all
211   unsigned long mutatee_tids[TEST3_THREADS];
212   const char *threads_varname = "test4_threads";
213   getVar(threads_varname, (void *) mutatee_tids,
214          (sizeof(unsigned long) * TEST3_THREADS),
215          TESTNO, TESTDESC);
216
217   if (debugPrint) {
218     dprintf("%s[%d]:  read following tids for test%d from mutatee\n", __FILE__, __LINE__, TESTNO);
219
220     for (unsigned int i = 0; i < TEST3_THREADS; ++i) {
221        dprintf("\t%lu\n", mutatee_tids[i]);
222     }
223   }
224
225   for (unsigned int i = 0; i < TEST3_THREADS; ++i) {
226      bool found = false;
227      for (unsigned int j = 0; j < callback_tids.size(); ++j) {
228        if (callback_tids[j] == mutatee_tids[i]) {
229          found = true;
230          break;
231        }
232      }
233
234     if (!found) {
235       FAIL_MES(TESTNAME, TESTDESC);
236       logerror("%s[%d]:  could not find record for tid %lu: have these:\n",
237              __FILE__, __LINE__, mutatee_tids[i]);
238        for (unsigned int j = 0; j < callback_tids.size(); ++j) {
239           logerror("%lu\n", callback_tids[j]);
240        }
241       err = true;
242       break;
243     }
244   }
245
246   dprintf("%s[%d]: removing thread callback\n", __FILE__, __LINE__);
247   if (!bpatch->removeThreadEventCallback(BPatch_threadCreateEvent, createcb)) {
248     FAIL_MES(TESTNAME, TESTDESC);
249     logerror("%s[%d]:  failed to remove thread callback\n",
250            __FILE__, __LINE__);
251     err = true;
252   }
253
254   if (!err)  {
255     PASS_MES(TESTNAME, TESTDESC);
256     appThread->getProcess()->terminateExecution();
257     return PASSED;
258   }
259   appThread->getProcess()->terminateExecution();
260   return FAILED;
261 }
262
263 test_results_t test_thread_3_Mutator::setup(ParameterDict &param) {
264   DyninstMutator::setup(param);
265   debugPrint = param["debugPrint"]->getInt();
266   bpatch = (BPatch *)(param["bpatch"]->getPtr());
267   return PASSED;
268 }