blob: 8d086783ec16b3a38a5b858a6e3f57d75ab9f96f [file] [log] [blame]
bartbedfd232009-03-26 19:07:15 +00001/* -*- mode: C; c-basic-offset: 3; -*- */
sewardjaf44c822007-11-25 14:01:38 +00002/*
bart86562bd2009-02-16 19:43:56 +00003 This file is part of drd, a thread error detector.
sewardjaf44c822007-11-25 14:01:38 +00004
bart09dc13f2009-02-14 15:13:31 +00005 Copyright (C) 2006-2009 Bart Van Assche <bart.vanassche@gmail.com>.
sewardjaf44c822007-11-25 14:01:38 +00006
7 This program is free software; you can redistribute it and/or
8 modify it under the terms of the GNU General Public License as
9 published by the Free Software Foundation; either version 2 of the
10 License, or (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20 02111-1307, USA.
21
22 The GNU General Public License is contained in the file COPYING.
23*/
24
25
sewardj85642922008-01-14 11:54:56 +000026#include "drd_barrier.h"
bart4bb53d82008-02-28 19:06:34 +000027#include "drd_clientobj.h"
bart09dc13f2009-02-14 15:13:31 +000028#include "drd_clientreq.h"
sewardjaf44c822007-11-25 14:01:38 +000029#include "drd_cond.h"
30#include "drd_error.h"
bart09dc13f2009-02-14 15:13:31 +000031#include "drd_load_store.h"
sewardjaf44c822007-11-25 14:01:38 +000032#include "drd_malloc_wrappers.h"
33#include "drd_mutex.h"
bart5bd9f2d2008-03-03 20:31:58 +000034#include "drd_rwlock.h"
sewardjaf44c822007-11-25 14:01:38 +000035#include "drd_segment.h"
sewardj85642922008-01-14 11:54:56 +000036#include "drd_semaphore.h"
sewardjaf44c822007-11-25 14:01:38 +000037#include "drd_suppression.h"
38#include "drd_thread.h"
barteacd9162008-06-16 20:22:18 +000039#include "libvex_guest_offsets.h"
sewardj85642922008-01-14 11:54:56 +000040#include "pub_drd_bitmap.h"
bart024a95a2008-04-01 18:27:41 +000041#include "pub_tool_vki.h" // Must be included before pub_tool_libcproc
sewardjaf44c822007-11-25 14:01:38 +000042#include "pub_tool_basics.h"
43#include "pub_tool_debuginfo.h" // VG_(describe_IP)()
44#include "pub_tool_libcassert.h" // tl_assert()
45#include "pub_tool_libcbase.h" // VG_(strcmp)
46#include "pub_tool_libcprint.h" // VG_(printf)
47#include "pub_tool_libcproc.h"
48#include "pub_tool_machine.h"
bart024a95a2008-04-01 18:27:41 +000049#include "pub_tool_mallocfree.h" // VG_(malloc)(), VG_(free)()
sewardjaf44c822007-11-25 14:01:38 +000050#include "pub_tool_options.h" // command line options
bartceded212008-03-26 17:39:52 +000051#include "pub_tool_replacemalloc.h"
bart72b751c2008-03-01 13:44:24 +000052#include "pub_tool_threadstate.h" // VG_(get_running_tid)()
sewardjaf44c822007-11-25 14:01:38 +000053#include "pub_tool_tooliface.h"
54
55
bart1335ecc2009-02-14 16:10:53 +000056/* Local variables. */
sewardjaf44c822007-11-25 14:01:38 +000057
bart1a3b0b32009-05-03 17:07:34 +000058static Bool DRD_(s_first_race_only) = False;
bart1335ecc2009-02-14 16:10:53 +000059static Bool DRD_(s_print_stats) = False;
60static Bool DRD_(s_var_info) = False;
61static Bool DRD_(s_show_stack_usage) = False;
sewardjaf44c822007-11-25 14:01:38 +000062
63
bart1335ecc2009-02-14 16:10:53 +000064/**
65 * Implement the needs_command_line_options for drd.
66 */
67static Bool DRD_(process_cmd_line_option)(Char* arg)
sewardjaf44c822007-11-25 14:01:38 +000068{
bartbedfd232009-03-26 19:07:15 +000069 int check_stack_accesses = -1;
70 int exclusive_threshold_ms = -1;
71 int report_signal_unlocked = -1;
72 int segment_merging = -1;
73 int shared_threshold_ms = -1;
74 int show_confl_seg = -1;
75 int trace_barrier = -1;
76 int trace_clientobj = -1;
77 int trace_cond = -1;
78 int trace_csw = -1;
79 int trace_fork_join = -1;
80 int trace_conflict_set = -1;
81 int trace_mutex = -1;
82 int trace_rwlock = -1;
83 int trace_segment = -1;
84 int trace_semaphore = -1;
85 int trace_suppression = -1;
86 Char* trace_address = 0;
sewardjaf44c822007-11-25 14:01:38 +000087
bartbedfd232009-03-26 19:07:15 +000088 if VG_BOOL_CLO(arg, "--check-stack-var", check_stack_accesses) {}
89 else if VG_BOOL_CLO(arg, "--drd-stats", DRD_(s_print_stats)) {}
bart1a3b0b32009-05-03 17:07:34 +000090 else if VG_BOOL_CLO(arg, "--first-race-only", DRD_(s_first_race_only)) {}
bartbedfd232009-03-26 19:07:15 +000091 else if VG_BOOL_CLO(arg,"--report-signal-unlocked",report_signal_unlocked) {}
92 else if VG_BOOL_CLO(arg, "--segment-merging", segment_merging) {}
93 else if VG_BOOL_CLO(arg, "--show-confl-seg", show_confl_seg) {}
94 else if VG_BOOL_CLO(arg, "--show-stack-usage",
95 DRD_(s_show_stack_usage)) {}
96 else if VG_BOOL_CLO(arg, "--trace-barrier", trace_barrier) {}
97 else if VG_BOOL_CLO(arg, "--trace-clientobj", trace_clientobj) {}
98 else if VG_BOOL_CLO(arg, "--trace-cond", trace_cond) {}
99 else if VG_BOOL_CLO(arg, "--trace-conflict-set", trace_conflict_set) {}
100 else if VG_BOOL_CLO(arg, "--trace-csw", trace_csw) {}
101 else if VG_BOOL_CLO(arg, "--trace-fork-join", trace_fork_join) {}
102 else if VG_BOOL_CLO(arg, "--trace-mutex", trace_mutex) {}
103 else if VG_BOOL_CLO(arg, "--trace-rwlock", trace_rwlock) {}
104 else if VG_BOOL_CLO(arg, "--trace-segment", trace_segment) {}
105 else if VG_BOOL_CLO(arg, "--trace-semaphore", trace_semaphore) {}
106 else if VG_BOOL_CLO(arg, "--trace-suppr", trace_suppression) {}
107 else if VG_BOOL_CLO(arg, "--var-info", DRD_(s_var_info)) {}
108 else if VG_INT_CLO (arg, "--exclusive-threshold", exclusive_threshold_ms) {}
109 else if VG_INT_CLO (arg, "--shared-threshold", shared_threshold_ms) {}
110 else if VG_STR_CLO (arg, "--trace-addr", trace_address) {}
111 else
112 return VG_(replacement_malloc_process_cmd_line_option)(arg);
sewardjaf44c822007-11-25 14:01:38 +0000113
bartbedfd232009-03-26 19:07:15 +0000114 if (check_stack_accesses != -1)
115 DRD_(set_check_stack_accesses)(check_stack_accesses);
116 if (exclusive_threshold_ms != -1)
117 {
118 DRD_(mutex_set_lock_threshold)(exclusive_threshold_ms);
119 DRD_(rwlock_set_exclusive_threshold)(exclusive_threshold_ms);
120 }
121 if (report_signal_unlocked != -1)
122 {
123 DRD_(cond_set_report_signal_unlocked)(report_signal_unlocked);
124 }
125 if (shared_threshold_ms != -1)
126 {
127 DRD_(rwlock_set_shared_threshold)(shared_threshold_ms);
128 }
129 if (segment_merging != -1)
130 DRD_(thread_set_segment_merging)(segment_merging);
131 if (show_confl_seg != -1)
132 DRD_(set_show_conflicting_segments)(show_confl_seg);
133 if (trace_address)
134 {
135 const Addr addr = VG_(strtoll16)(trace_address, 0);
136 DRD_(start_tracing_address_range)(addr, addr + 1);
137 }
138 if (trace_barrier != -1)
139 DRD_(barrier_set_trace)(trace_barrier);
140 if (trace_clientobj != -1)
141 DRD_(clientobj_set_trace)(trace_clientobj);
142 if (trace_cond != -1)
143 DRD_(cond_set_trace)(trace_cond);
144 if (trace_csw != -1)
145 DRD_(thread_trace_context_switches)(trace_csw);
146 if (trace_fork_join != -1)
147 DRD_(thread_set_trace_fork_join)(trace_fork_join);
148 if (trace_conflict_set != -1)
149 DRD_(thread_trace_conflict_set)(trace_conflict_set);
150 if (trace_mutex != -1)
151 DRD_(mutex_set_trace)(trace_mutex);
152 if (trace_rwlock != -1)
153 DRD_(rwlock_set_trace)(trace_rwlock);
154 if (trace_segment != -1)
155 DRD_(sg_set_trace)(trace_segment);
156 if (trace_semaphore != -1)
157 DRD_(semaphore_set_trace)(trace_semaphore);
158 if (trace_suppression != -1)
159 DRD_(suppression_set_trace)(trace_suppression);
sewardjaf44c822007-11-25 14:01:38 +0000160
bartbedfd232009-03-26 19:07:15 +0000161 return True;
sewardjaf44c822007-11-25 14:01:38 +0000162}
163
bart1335ecc2009-02-14 16:10:53 +0000164static void DRD_(print_usage)(void)
bartbd7e56e2008-03-31 18:14:12 +0000165{
bartbedfd232009-03-26 19:07:15 +0000166 VG_(printf)(
bart0ffa4832008-04-05 12:57:01 +0000167" --check-stack-var=yes|no Whether or not to report data races on\n"
168" stack variables [no].\n"
bart9d5b7962008-05-14 12:25:00 +0000169" --exclusive-threshold=<n> Print an error message if any mutex or\n"
170" writer lock is held longer than the specified time (in milliseconds).\n"
bart1a3b0b32009-05-03 17:07:34 +0000171" --first-race-only=yes|no Only report the first data race that occurs on\n"
172" a memory location instead of all races [no].\n"
bart46b5fce2008-06-28 13:01:30 +0000173" --report-signal-unlocked=yes|no Whether to report calls to\n"
174" pthread_cond_signal() where the mutex associated\n"
175" with the signal via pthread_cond_wait() is not\n"
176" locked at the time the signal is sent [yes].\n"
bart130463a2008-04-01 17:03:33 +0000177" --segment-merging=yes|no Controls segment merging [yes].\n"
bartbd7e56e2008-03-31 18:14:12 +0000178" Segment merging is an algorithm to limit memory usage of the\n"
179" data race detection algorithm. Disabling segment merging may\n"
180" improve the accuracy of the so-called 'other segments' displayed\n"
181" in race reports but can also trigger an out of memory error.\n"
bart9d5b7962008-05-14 12:25:00 +0000182" --shared-threshold=<n> Print an error message if a reader lock\n"
183" is held longer than the specified time (in milliseconds).\n"
bart130463a2008-04-01 17:03:33 +0000184" --show-confl-seg=yes|no Show conflicting segments in race reports [yes].\n"
185" --show-stack-usage=yes|no Print stack usage at thread exit time [no].\n"
186" --var-info=yes|no Display the names of global, static and\n"
bartbd7e56e2008-03-31 18:14:12 +0000187" stack variables when a race is reported on such a variable. This\n"
188" information is by default not displayed since for big programs\n"
bart85d22532008-06-26 07:30:32 +0000189" reading in all debug information at once may cause an out of\n"
190" memory error [no].\n"
bartbd7e56e2008-03-31 18:14:12 +0000191"\n"
bartef1b9722008-07-04 15:34:23 +0000192" drd options for monitoring process behavior:\n"
bart952e1a02008-04-06 13:06:36 +0000193" --trace-addr=<address> Trace all load and store activity for the.\n"
bart130463a2008-04-01 17:03:33 +0000194" specified address [off].\n"
195" --trace-barrier=yes|no Trace all barrier activity [no].\n"
196" --trace-cond=yes|no Trace all condition variable activity [no].\n"
197" --trace-fork-join=yes|no Trace all thread fork/join activity [no].\n"
198" --trace-mutex=yes|no Trace all mutex activity [no].\n"
199" --trace-rwlock=yes|no Trace all reader-writer lock activity[no].\n"
bart130463a2008-04-01 17:03:33 +0000200" --trace-semaphore=yes|no Trace all semaphore activity [no].\n"
bartbedfd232009-03-26 19:07:15 +0000201);
bart130463a2008-04-01 17:03:33 +0000202 VG_(replacement_malloc_print_usage)();
sewardjaf44c822007-11-25 14:01:38 +0000203}
204
bart1335ecc2009-02-14 16:10:53 +0000205static void DRD_(print_debug_usage)(void)
sewardjaf44c822007-11-25 14:01:38 +0000206{
bartbedfd232009-03-26 19:07:15 +0000207 VG_(printf)(
bart130463a2008-04-01 17:03:33 +0000208" --drd-stats=yes|no Print statistics about DRD activity [no].\n"
209" --trace-clientobj=yes|no Trace all client object activity [no].\n"
210" --trace-csw=yes|no Trace all scheduler context switches [no].\n"
barte73b0aa2008-06-28 07:19:56 +0000211" --trace-conflict-set=yes|no Trace all conflict set updates [no].\n"
bart987781d2008-06-27 15:00:07 +0000212" --trace-segment=yes|no Trace segment actions [no].\n"
213" --trace-suppr=yes|no Trace all address suppression actions [no].\n"
bartbedfd232009-03-26 19:07:15 +0000214);
bart130463a2008-04-01 17:03:33 +0000215 VG_(replacement_malloc_print_debug_usage)();
sewardjaf44c822007-11-25 14:01:38 +0000216}
217
218
219//
220// Implements the thread-related core callbacks.
221//
222
sewardjaf44c822007-11-25 14:01:38 +0000223static void drd_pre_mem_read(const CorePart part,
224 const ThreadId tid,
225 Char* const s,
226 const Addr a,
227 const SizeT size)
228{
bartbedfd232009-03-26 19:07:15 +0000229 if (size > 0)
230 {
231 DRD_(trace_load)(a, size);
232 }
sewardjaf44c822007-11-25 14:01:38 +0000233}
234
bart5e85d262008-03-01 10:49:37 +0000235static void drd_pre_mem_read_asciiz(const CorePart part,
236 const ThreadId tid,
237 Char* const s,
238 const Addr a)
239{
bartbedfd232009-03-26 19:07:15 +0000240 const char* p = (void*)a;
241 SizeT size = 0;
bart5e85d262008-03-01 10:49:37 +0000242
bartbedfd232009-03-26 19:07:15 +0000243 /* Note: the expression '*p' reads client memory and may crash if the */
244 /* client provided an invalid pointer ! */
245 while (*p)
246 {
247 p++;
248 size++;
249 }
250 // To do: find out what a reasonable upper limit on 'size' is.
251 tl_assert(size < 4096);
252 if (size > 0)
253 {
254 DRD_(trace_load)(a, size);
255 }
bart5e85d262008-03-01 10:49:37 +0000256}
257
sewardjaf44c822007-11-25 14:01:38 +0000258static void drd_post_mem_write(const CorePart part,
259 const ThreadId tid,
260 const Addr a,
261 const SizeT size)
262{
bartbedfd232009-03-26 19:07:15 +0000263 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
264 if (size > 0)
265 {
266 DRD_(trace_store)(a, size);
267 }
sewardjaf44c822007-11-25 14:01:38 +0000268}
269
bart08865622008-06-06 14:31:36 +0000270static __inline__
271void drd_start_using_mem(const Addr a1, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000272{
bartbedfd232009-03-26 19:07:15 +0000273 tl_assert(a1 < a1 + len);
bart5e85d262008-03-01 10:49:37 +0000274
bartbedfd232009-03-26 19:07:15 +0000275 if (UNLIKELY(DRD_(any_address_is_traced)()))
276 {
277 DRD_(trace_mem_access)(a1, len, eStart);
278 }
sewardjaf44c822007-11-25 14:01:38 +0000279}
280
sewardj7cf4e6b2008-05-01 20:24:26 +0000281static void drd_start_using_mem_w_ecu(const Addr a1,
282 const SizeT len,
283 UInt ec_uniq)
284{
bartbedfd232009-03-26 19:07:15 +0000285 drd_start_using_mem(a1, len);
sewardj7cf4e6b2008-05-01 20:24:26 +0000286}
287
288static void drd_start_using_mem_w_tid(const Addr a1,
289 const SizeT len,
290 ThreadId tid)
291{
bartbedfd232009-03-26 19:07:15 +0000292 drd_start_using_mem(a1, len);
sewardj7cf4e6b2008-05-01 20:24:26 +0000293}
294
bart0ffa4832008-04-05 12:57:01 +0000295static __inline__
296void drd_stop_using_mem(const Addr a1, const SizeT len,
297 const Bool is_stack_mem)
sewardjaf44c822007-11-25 14:01:38 +0000298{
bartbedfd232009-03-26 19:07:15 +0000299 const Addr a2 = a1 + len;
bart5e85d262008-03-01 10:49:37 +0000300
bartbedfd232009-03-26 19:07:15 +0000301 tl_assert(a1 < a2);
bart5e85d262008-03-01 10:49:37 +0000302
bartbedfd232009-03-26 19:07:15 +0000303 if (UNLIKELY(DRD_(any_address_is_traced)()))
304 {
305 DRD_(trace_mem_access)(a1, len, eEnd);
306 }
307 if (! is_stack_mem || DRD_(get_check_stack_accesses)())
308 {
309 DRD_(thread_stop_using_mem)(a1, a2);
310 DRD_(clientobj_stop_using_mem)(a1, a2);
311 DRD_(suppression_stop_using_mem)(a1, a2);
312 }
bart0ffa4832008-04-05 12:57:01 +0000313}
314
315static __inline__
316void drd_stop_using_nonstack_mem(const Addr a1, const SizeT len)
317{
bartbedfd232009-03-26 19:07:15 +0000318 drd_stop_using_mem(a1, len, False);
sewardjaf44c822007-11-25 14:01:38 +0000319}
320
bart1335ecc2009-02-14 16:10:53 +0000321/**
bartfdaa0182009-03-10 09:25:32 +0000322 * Discard all information DRD has about memory accesses and client objects
323 * in the specified address range.
324 */
325void DRD_(clean_memory)(const Addr a1, const SizeT len)
326{
bartbedfd232009-03-26 19:07:15 +0000327 const Bool is_stack_memory = DRD_(thread_address_on_any_stack)(a1);
328 drd_stop_using_mem(a1, len, is_stack_memory);
329 drd_start_using_mem(a1, len);
bartfdaa0182009-03-10 09:25:32 +0000330}
331
332/**
bart1335ecc2009-02-14 16:10:53 +0000333 * Suppress data race reports on all addresses contained in .plt and
334 * .got.plt sections inside the address range [ a, a + len [. The data in
335 * these sections is modified by _dl_relocate_object() every time a function
336 * in a shared library is called for the first time. Since the first call
337 * to a function in a shared library can happen from a multithreaded context,
338 * such calls can cause conflicting accesses. See also Ulrich Drepper's
339 * paper "How to Write Shared Libraries" for more information about relocation
340 * (http://people.redhat.com/drepper/dsohowto.pdf).
bartcb2d0072008-05-31 07:55:51 +0000341 */
bart1335ecc2009-02-14 16:10:53 +0000342static void DRD_(suppress_relocation_conflicts)(const Addr a, const SizeT len)
bartcb2d0072008-05-31 07:55:51 +0000343{
bartbedfd232009-03-26 19:07:15 +0000344 const DebugInfo* di;
bartcb2d0072008-05-31 07:55:51 +0000345
346#if 0
bartbedfd232009-03-26 19:07:15 +0000347 VG_(printf)("Evaluating range @ 0x%lx size %ld\n", a, len);
bartcb2d0072008-05-31 07:55:51 +0000348#endif
349
bartbedfd232009-03-26 19:07:15 +0000350 for (di = VG_(next_seginfo)(0); di; di = VG_(next_seginfo)(di))
351 {
352 Addr avma;
353 SizeT size;
bartcb2d0072008-05-31 07:55:51 +0000354
bartbedfd232009-03-26 19:07:15 +0000355 avma = VG_(seginfo_get_plt_avma)(di);
356 size = VG_(seginfo_get_plt_size)(di);
357 tl_assert((avma && size) || (avma == 0 && size == 0));
358 if (size > 0)
359 {
bartcb2d0072008-05-31 07:55:51 +0000360#if 0
bartbedfd232009-03-26 19:07:15 +0000361 VG_(printf)("Suppressing .plt @ 0x%lx size %ld\n", avma, size);
bartcb2d0072008-05-31 07:55:51 +0000362#endif
bartbedfd232009-03-26 19:07:15 +0000363 tl_assert(VG_(seginfo_sect_kind)(NULL, 0, avma) == Vg_SectPLT);
364 DRD_(start_suppression)(avma, avma + size, ".plt");
365 }
bartcb2d0072008-05-31 07:55:51 +0000366
bartbedfd232009-03-26 19:07:15 +0000367 avma = VG_(seginfo_get_gotplt_avma)(di);
368 size = VG_(seginfo_get_gotplt_size)(di);
369 tl_assert((avma && size) || (avma == 0 && size == 0));
370 if (size > 0)
371 {
bartcb2d0072008-05-31 07:55:51 +0000372#if 0
bartbedfd232009-03-26 19:07:15 +0000373 VG_(printf)("Suppressing .got.plt @ 0x%lx size %ld\n", avma, size);
bartcb2d0072008-05-31 07:55:51 +0000374#endif
bartbedfd232009-03-26 19:07:15 +0000375 tl_assert(VG_(seginfo_sect_kind)(NULL, 0, avma) == Vg_SectGOTPLT);
376 DRD_(start_suppression)(avma, avma + size, ".gotplt");
377 }
378 }
bartcb2d0072008-05-31 07:55:51 +0000379}
380
bart5e85d262008-03-01 10:49:37 +0000381static
382void drd_start_using_mem_w_perms(const Addr a, const SizeT len,
sewardj9c606bd2008-09-18 18:12:50 +0000383 const Bool rr, const Bool ww, const Bool xx,
384 ULong di_handle)
bart5e85d262008-03-01 10:49:37 +0000385{
bartbedfd232009-03-26 19:07:15 +0000386 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
bartd5765912008-03-16 08:40:55 +0000387
bartbedfd232009-03-26 19:07:15 +0000388 drd_start_using_mem(a, len);
bartcb2d0072008-05-31 07:55:51 +0000389
bartbedfd232009-03-26 19:07:15 +0000390 DRD_(suppress_relocation_conflicts)(a, len);
bart5e85d262008-03-01 10:49:37 +0000391}
392
sewardjaf44c822007-11-25 14:01:38 +0000393/* Called by the core when the stack of a thread grows, to indicate that */
394/* the addresses in range [ a, a + len [ may now be used by the client. */
395/* Assumption: stacks grow downward. */
bart08865622008-06-06 14:31:36 +0000396static __inline__
397void drd_start_using_mem_stack(const Addr a, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000398{
bartbedfd232009-03-26 19:07:15 +0000399 DRD_(thread_set_stack_min)(DRD_(thread_get_running_tid)(),
400 a - VG_STACK_REDZONE_SZB);
401 drd_start_using_mem(a - VG_STACK_REDZONE_SZB,
402 len + VG_STACK_REDZONE_SZB);
sewardjaf44c822007-11-25 14:01:38 +0000403}
404
405/* Called by the core when the stack of a thread shrinks, to indicate that */
406/* the addresses [ a, a + len [ are no longer accessible for the client. */
407/* Assumption: stacks grow downward. */
bart08865622008-06-06 14:31:36 +0000408static __inline__
409void drd_stop_using_mem_stack(const Addr a, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000410{
bartbedfd232009-03-26 19:07:15 +0000411 DRD_(thread_set_stack_min)(DRD_(thread_get_running_tid)(),
412 a + len - VG_STACK_REDZONE_SZB);
413 drd_stop_using_mem(a - VG_STACK_REDZONE_SZB, len + VG_STACK_REDZONE_SZB,
414 True);
sewardjaf44c822007-11-25 14:01:38 +0000415}
416
bartbedfd232009-03-26 19:07:15 +0000417/**
418 * Callback function called by the Valgrind core before a stack area is
419 * being used by a signal handler.
420 *
421 * @param[in] a Start of address range.
422 * @param[in] len Address range length.
423 * @param[in] tid Valgrind thread ID for whom the signal frame is being
424 * constructed.
425 */
426static void drd_start_using_mem_stack_signal(const Addr a, const SizeT len,
427 ThreadId tid)
sewardjaf44c822007-11-25 14:01:38 +0000428{
bartbedfd232009-03-26 19:07:15 +0000429 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
430 drd_start_using_mem(a, len);
sewardjaf44c822007-11-25 14:01:38 +0000431}
432
bart5e85d262008-03-01 10:49:37 +0000433static void drd_stop_using_mem_stack_signal(Addr a, SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000434{
bartbedfd232009-03-26 19:07:15 +0000435 drd_stop_using_mem(a, len, True);
sewardjaf44c822007-11-25 14:01:38 +0000436}
437
438static
439void drd_pre_thread_create(const ThreadId creator, const ThreadId created)
440{
bartbedfd232009-03-26 19:07:15 +0000441 const DrdThreadId drd_creator = DRD_(VgThreadIdToDrdThreadId)(creator);
442 tl_assert(created != VG_INVALID_THREADID);
443 DRD_(thread_pre_create)(drd_creator, created);
444 if (DRD_(IsValidDrdThreadId)(drd_creator))
445 {
446 DRD_(thread_new_segment)(drd_creator);
447 }
448 if (DRD_(thread_get_trace_fork_join)())
449 {
450 VG_(message)(Vg_DebugMsg,
451 "drd_pre_thread_create creator = %d/%d, created = %d",
452 creator, drd_creator, created);
453 }
sewardjaf44c822007-11-25 14:01:38 +0000454}
455
456/* Called by Valgrind's core before any loads or stores are performed on */
457/* the context of thread "created". At startup, this function is called */
458/* with arguments (0,1). */
459static
bart0ffa4832008-04-05 12:57:01 +0000460void drd_post_thread_create(const ThreadId vg_created)
sewardjaf44c822007-11-25 14:01:38 +0000461{
bartbedfd232009-03-26 19:07:15 +0000462 DrdThreadId drd_created;
bart0ffa4832008-04-05 12:57:01 +0000463
bartbedfd232009-03-26 19:07:15 +0000464 tl_assert(vg_created != VG_INVALID_THREADID);
bart0ffa4832008-04-05 12:57:01 +0000465
bartbedfd232009-03-26 19:07:15 +0000466 drd_created = DRD_(thread_post_create)(vg_created);
467 if (DRD_(thread_get_trace_fork_join)())
468 {
469 VG_(message)(Vg_DebugMsg,
470 "drd_post_thread_create created = %d/%d",
471 vg_created, drd_created);
472 }
473 if (! DRD_(get_check_stack_accesses)())
474 {
475 DRD_(start_suppression)(DRD_(thread_get_stack_max)(drd_created)
476 - DRD_(thread_get_stack_size)(drd_created),
477 DRD_(thread_get_stack_max)(drd_created),
478 "stack");
479 }
sewardjaf44c822007-11-25 14:01:38 +0000480}
481
sewardjaf44c822007-11-25 14:01:38 +0000482/* Called after a thread has performed its last memory access. */
bartd43f8d32008-03-16 17:29:20 +0000483static void drd_thread_finished(ThreadId vg_tid)
sewardjaf44c822007-11-25 14:01:38 +0000484{
bartbedfd232009-03-26 19:07:15 +0000485 DrdThreadId drd_tid;
sewardj85642922008-01-14 11:54:56 +0000486
bartbedfd232009-03-26 19:07:15 +0000487 tl_assert(VG_(get_running_tid)() == vg_tid);
sewardj85642922008-01-14 11:54:56 +0000488
bartbedfd232009-03-26 19:07:15 +0000489 drd_tid = DRD_(VgThreadIdToDrdThreadId)(vg_tid);
490 if (DRD_(thread_get_trace_fork_join)())
491 {
492 VG_(message)(Vg_DebugMsg,
493 "drd_thread_finished tid = %d/%d%s",
494 vg_tid,
495 drd_tid,
496 DRD_(thread_get_joinable)(drd_tid)
497 ? ""
498 : " (which is a detached thread)");
499 }
500 if (DRD_(s_show_stack_usage))
501 {
502 const SizeT stack_size = DRD_(thread_get_stack_size)(drd_tid);
503 const SizeT used_stack
504 = (DRD_(thread_get_stack_max)(drd_tid)
505 - DRD_(thread_get_stack_min_min)(drd_tid));
506 VG_(message)(Vg_UserMsg,
507 "thread %d/%d%s finished and used %ld bytes out of %ld"
508 " on its stack. Margin: %ld bytes.",
509 vg_tid,
510 drd_tid,
511 DRD_(thread_get_joinable)(drd_tid)
512 ? ""
513 : " (which is a detached thread)",
514 used_stack,
515 stack_size,
516 stack_size - used_stack);
sewardjaf44c822007-11-25 14:01:38 +0000517
bartbedfd232009-03-26 19:07:15 +0000518 }
519 drd_stop_using_mem(DRD_(thread_get_stack_min)(drd_tid),
520 DRD_(thread_get_stack_max)(drd_tid)
521 - DRD_(thread_get_stack_min)(drd_tid),
522 True);
523 DRD_(thread_stop_recording)(drd_tid);
524 DRD_(thread_finished)(drd_tid);
sewardjaf44c822007-11-25 14:01:38 +0000525}
526
sewardjaf44c822007-11-25 14:01:38 +0000527//
528// Implementation of the tool interface.
529//
530
bart1335ecc2009-02-14 16:10:53 +0000531static void DRD_(post_clo_init)(void)
sewardjdcbb8d32007-11-26 21:34:30 +0000532{
bartbedfd232009-03-26 19:07:15 +0000533# if defined(VGP_x86_linux) || defined(VGP_amd64_linux) \
534 || defined(VGP_ppc32_linux) || defined(VGP_ppc64_linux)
535 /* fine */
sewardjdcbb8d32007-11-26 21:34:30 +0000536# else
bartbedfd232009-03-26 19:07:15 +0000537 VG_(printf)("\nWARNING: DRD has only been tested on Linux.\n\n");
sewardjdcbb8d32007-11-26 21:34:30 +0000538# endif
bart95761b52008-03-29 08:34:03 +0000539
bartbedfd232009-03-26 19:07:15 +0000540 if (DRD_(s_var_info))
541 {
542 VG_(needs_var_info)();
543 }
sewardjdcbb8d32007-11-26 21:34:30 +0000544}
sewardjaf44c822007-11-25 14:01:38 +0000545
sewardjaf44c822007-11-25 14:01:38 +0000546static void drd_start_client_code(const ThreadId tid, const ULong bbs_done)
547{
bartbedfd232009-03-26 19:07:15 +0000548 tl_assert(tid == VG_(get_running_tid)());
549 DRD_(thread_set_vg_running_tid)(tid);
sewardjaf44c822007-11-25 14:01:38 +0000550}
551
bart1335ecc2009-02-14 16:10:53 +0000552static void DRD_(fini)(Int exitcode)
sewardjaf44c822007-11-25 14:01:38 +0000553{
bartbedfd232009-03-26 19:07:15 +0000554 // thread_print_all();
555 if (VG_(clo_verbosity) > 1 || DRD_(s_print_stats))
556 {
557 ULong update_conflict_set_count;
558 ULong dsnsc;
559 ULong dscvc;
barte4504dd2008-04-06 15:02:58 +0000560
bartbedfd232009-03-26 19:07:15 +0000561 update_conflict_set_count
562 = DRD_(thread_get_update_conflict_set_count)(&dsnsc, &dscvc);
barte4504dd2008-04-06 15:02:58 +0000563
bartbedfd232009-03-26 19:07:15 +0000564 VG_(message)(Vg_UserMsg,
565 " thread: %lld context switches"
566 " / %lld updates of the conflict set",
567 DRD_(thread_get_context_switch_count)(),
568 update_conflict_set_count);
569 VG_(message)(Vg_UserMsg,
570 " (%lld new sg + %lld combine vc + %lld csw).",
571 dsnsc,
572 dscvc,
573 update_conflict_set_count - dsnsc - dscvc);
574 VG_(message)(Vg_UserMsg,
575 " segments: created %lld segments, max %lld alive,"
576 " %lld discard points.",
577 DRD_(sg_get_segments_created_count)(),
578 DRD_(sg_get_max_segments_alive_count)(),
579 DRD_(thread_get_discard_ordered_segments_count)());
580 VG_(message)(Vg_UserMsg,
bart1a3b0b32009-05-03 17:07:34 +0000581 " %lld merges.",
582 DRD_(sg_get_segment_merge_count)());
583 VG_(message)(Vg_UserMsg,
bartbedfd232009-03-26 19:07:15 +0000584 " (%lld m, %lld rw, %lld s, %lld b)",
585 DRD_(get_mutex_segment_creation_count)(),
586 DRD_(get_rwlock_segment_creation_count)(),
587 DRD_(get_semaphore_segment_creation_count)(),
588 DRD_(get_barrier_segment_creation_count)());
589 VG_(message)(Vg_UserMsg,
590 " bitmaps: %lld level 1 / %lld level 2 bitmap refs",
591 DRD_(bm_get_bitmap_creation_count)(),
592 DRD_(bm_get_bitmap2_node_creation_count)());
593 VG_(message)(Vg_UserMsg,
594 " and %lld level 2 bitmaps were allocated.",
595 DRD_(bm_get_bitmap2_creation_count)());
596 VG_(message)(Vg_UserMsg,
597 " mutex: %lld non-recursive lock/unlock events.",
598 DRD_(get_mutex_lock_count)());
599 DRD_(print_malloc_stats)();
600 }
sewardjaf44c822007-11-25 14:01:38 +0000601}
602
sewardjaf44c822007-11-25 14:01:38 +0000603static
604void drd_pre_clo_init(void)
605{
bartbedfd232009-03-26 19:07:15 +0000606 // Basic tool stuff.
sewardjaf44c822007-11-25 14:01:38 +0000607
bartbedfd232009-03-26 19:07:15 +0000608 VG_(details_name) ("drd");
609 VG_(details_version) (NULL);
610 VG_(details_description) ("a thread error detector");
611 VG_(details_copyright_author)("Copyright (C) 2006-2009, and GNU GPL'd,"
612 " by Bart Van Assche.");
613 VG_(details_bug_reports_to) (VG_BUGS_TO);
sewardjaf44c822007-11-25 14:01:38 +0000614
bartbedfd232009-03-26 19:07:15 +0000615 VG_(basic_tool_funcs) (DRD_(post_clo_init),
616 DRD_(instrument),
617 DRD_(fini));
sewardjaf44c822007-11-25 14:01:38 +0000618
bartbedfd232009-03-26 19:07:15 +0000619 // Command line stuff.
620 VG_(needs_command_line_options)(DRD_(process_cmd_line_option),
621 DRD_(print_usage),
622 DRD_(print_debug_usage));
sewardjaf44c822007-11-25 14:01:38 +0000623
bartbedfd232009-03-26 19:07:15 +0000624 // Error handling.
625 DRD_(register_error_handlers)();
sewardjaf44c822007-11-25 14:01:38 +0000626
bartbedfd232009-03-26 19:07:15 +0000627 // Core event tracking.
628 VG_(track_pre_mem_read) (drd_pre_mem_read);
629 VG_(track_pre_mem_read_asciiz) (drd_pre_mem_read_asciiz);
630 VG_(track_post_mem_write) (drd_post_mem_write);
631 VG_(track_new_mem_brk) (drd_start_using_mem_w_tid);
632 VG_(track_new_mem_mmap) (drd_start_using_mem_w_perms);
633 VG_(track_new_mem_stack) (drd_start_using_mem_stack);
634 VG_(track_new_mem_stack_signal) (drd_start_using_mem_stack_signal);
635 VG_(track_new_mem_startup) (drd_start_using_mem_w_perms);
636 VG_(track_die_mem_brk) (drd_stop_using_nonstack_mem);
637 VG_(track_die_mem_munmap) (drd_stop_using_nonstack_mem);
638 VG_(track_die_mem_stack) (drd_stop_using_mem_stack);
639 VG_(track_die_mem_stack_signal) (drd_stop_using_mem_stack_signal);
640 VG_(track_start_client_code) (drd_start_client_code);
641 VG_(track_pre_thread_ll_create) (drd_pre_thread_create);
642 VG_(track_pre_thread_first_insn)(drd_post_thread_create);
643 VG_(track_pre_thread_ll_exit) (drd_thread_finished);
sewardjaf44c822007-11-25 14:01:38 +0000644
bartbedfd232009-03-26 19:07:15 +0000645 // Other stuff.
646 DRD_(register_malloc_wrappers)(drd_start_using_mem_w_ecu,
647 drd_stop_using_nonstack_mem);
sewardjaf44c822007-11-25 14:01:38 +0000648
bartbedfd232009-03-26 19:07:15 +0000649 DRD_(clientreq_init)();
sewardjaf44c822007-11-25 14:01:38 +0000650
bartbedfd232009-03-26 19:07:15 +0000651 DRD_(suppression_init)();
bart4bb53d82008-02-28 19:06:34 +0000652
bartbedfd232009-03-26 19:07:15 +0000653 DRD_(clientobj_init)();
sewardjaf44c822007-11-25 14:01:38 +0000654}
655
656
657VG_DETERMINE_INTERFACE_VERSION(drd_pre_clo_init)