blob: ee2076001e8f0b06016cf12769865a466f18cee8 [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
bart1335ecc2009-02-14 16:10:53 +000058static Bool DRD_(s_print_stats) = False;
59static Bool DRD_(s_var_info) = False;
60static Bool DRD_(s_show_stack_usage) = False;
sewardjaf44c822007-11-25 14:01:38 +000061
62
bart1335ecc2009-02-14 16:10:53 +000063/**
64 * Implement the needs_command_line_options for drd.
65 */
66static Bool DRD_(process_cmd_line_option)(Char* arg)
sewardjaf44c822007-11-25 14:01:38 +000067{
bartbedfd232009-03-26 19:07:15 +000068 int check_stack_accesses = -1;
69 int exclusive_threshold_ms = -1;
bartf98a5692009-05-03 17:17:37 +000070 int first_race_only = -1;
bartbedfd232009-03-26 19:07:15 +000071 int report_signal_unlocked = -1;
72 int segment_merging = -1;
bart8f822af2009-06-08 18:20:42 +000073 int segment_merge_interval = -1;
bartbedfd232009-03-26 19:07:15 +000074 int shared_threshold_ms = -1;
75 int show_confl_seg = -1;
76 int trace_barrier = -1;
77 int trace_clientobj = -1;
78 int trace_cond = -1;
79 int trace_csw = -1;
80 int trace_fork_join = -1;
81 int trace_conflict_set = -1;
bart8f822af2009-06-08 18:20:42 +000082 int trace_conflict_set_bm = -1;
bartbedfd232009-03-26 19:07:15 +000083 int trace_mutex = -1;
84 int trace_rwlock = -1;
85 int trace_segment = -1;
86 int trace_semaphore = -1;
87 int trace_suppression = -1;
88 Char* trace_address = 0;
sewardjaf44c822007-11-25 14:01:38 +000089
bartbedfd232009-03-26 19:07:15 +000090 if VG_BOOL_CLO(arg, "--check-stack-var", check_stack_accesses) {}
91 else if VG_BOOL_CLO(arg, "--drd-stats", DRD_(s_print_stats)) {}
bartf98a5692009-05-03 17:17:37 +000092 else if VG_BOOL_CLO(arg, "--first-race-only", first_race_only) {}
bart8f822af2009-06-08 18:20:42 +000093 else if VG_BOOL_CLO(arg,"--report-signal-unlocked",report_signal_unlocked)
94 {}
bartbedfd232009-03-26 19:07:15 +000095 else if VG_BOOL_CLO(arg, "--segment-merging", segment_merging) {}
bart8f822af2009-06-08 18:20:42 +000096 else if VG_INT_CLO (arg, "--segment-merging-interval", segment_merge_interval)
97 {}
bartbedfd232009-03-26 19:07:15 +000098 else if VG_BOOL_CLO(arg, "--show-confl-seg", show_confl_seg) {}
99 else if VG_BOOL_CLO(arg, "--show-stack-usage",
100 DRD_(s_show_stack_usage)) {}
101 else if VG_BOOL_CLO(arg, "--trace-barrier", trace_barrier) {}
102 else if VG_BOOL_CLO(arg, "--trace-clientobj", trace_clientobj) {}
103 else if VG_BOOL_CLO(arg, "--trace-cond", trace_cond) {}
104 else if VG_BOOL_CLO(arg, "--trace-conflict-set", trace_conflict_set) {}
bart8f822af2009-06-08 18:20:42 +0000105 else if VG_BOOL_CLO(arg, "--trace-conflict-set-bm", trace_conflict_set_bm){}
bartbedfd232009-03-26 19:07:15 +0000106 else if VG_BOOL_CLO(arg, "--trace-csw", trace_csw) {}
107 else if VG_BOOL_CLO(arg, "--trace-fork-join", trace_fork_join) {}
108 else if VG_BOOL_CLO(arg, "--trace-mutex", trace_mutex) {}
109 else if VG_BOOL_CLO(arg, "--trace-rwlock", trace_rwlock) {}
110 else if VG_BOOL_CLO(arg, "--trace-segment", trace_segment) {}
111 else if VG_BOOL_CLO(arg, "--trace-semaphore", trace_semaphore) {}
112 else if VG_BOOL_CLO(arg, "--trace-suppr", trace_suppression) {}
113 else if VG_BOOL_CLO(arg, "--var-info", DRD_(s_var_info)) {}
114 else if VG_INT_CLO (arg, "--exclusive-threshold", exclusive_threshold_ms) {}
115 else if VG_INT_CLO (arg, "--shared-threshold", shared_threshold_ms) {}
116 else if VG_STR_CLO (arg, "--trace-addr", trace_address) {}
117 else
118 return VG_(replacement_malloc_process_cmd_line_option)(arg);
sewardjaf44c822007-11-25 14:01:38 +0000119
bartbedfd232009-03-26 19:07:15 +0000120 if (check_stack_accesses != -1)
121 DRD_(set_check_stack_accesses)(check_stack_accesses);
122 if (exclusive_threshold_ms != -1)
123 {
124 DRD_(mutex_set_lock_threshold)(exclusive_threshold_ms);
125 DRD_(rwlock_set_exclusive_threshold)(exclusive_threshold_ms);
126 }
bartf98a5692009-05-03 17:17:37 +0000127 if (first_race_only != -1)
128 {
129 DRD_(set_first_race_only)(first_race_only);
130 }
bartbedfd232009-03-26 19:07:15 +0000131 if (report_signal_unlocked != -1)
132 {
133 DRD_(cond_set_report_signal_unlocked)(report_signal_unlocked);
134 }
135 if (shared_threshold_ms != -1)
136 {
137 DRD_(rwlock_set_shared_threshold)(shared_threshold_ms);
138 }
139 if (segment_merging != -1)
140 DRD_(thread_set_segment_merging)(segment_merging);
bart109d5da2009-06-22 18:06:29 +0000141 if (segment_merge_interval != -1)
bart8f822af2009-06-08 18:20:42 +0000142 DRD_(thread_set_segment_merge_interval)(segment_merge_interval);
bartbedfd232009-03-26 19:07:15 +0000143 if (show_confl_seg != -1)
144 DRD_(set_show_conflicting_segments)(show_confl_seg);
145 if (trace_address)
146 {
147 const Addr addr = VG_(strtoll16)(trace_address, 0);
148 DRD_(start_tracing_address_range)(addr, addr + 1);
149 }
150 if (trace_barrier != -1)
151 DRD_(barrier_set_trace)(trace_barrier);
152 if (trace_clientobj != -1)
153 DRD_(clientobj_set_trace)(trace_clientobj);
154 if (trace_cond != -1)
155 DRD_(cond_set_trace)(trace_cond);
156 if (trace_csw != -1)
157 DRD_(thread_trace_context_switches)(trace_csw);
158 if (trace_fork_join != -1)
159 DRD_(thread_set_trace_fork_join)(trace_fork_join);
160 if (trace_conflict_set != -1)
161 DRD_(thread_trace_conflict_set)(trace_conflict_set);
bart8f822af2009-06-08 18:20:42 +0000162 if (trace_conflict_set_bm != -1)
163 DRD_(thread_trace_conflict_set_bm)(trace_conflict_set_bm);
bartbedfd232009-03-26 19:07:15 +0000164 if (trace_mutex != -1)
165 DRD_(mutex_set_trace)(trace_mutex);
166 if (trace_rwlock != -1)
167 DRD_(rwlock_set_trace)(trace_rwlock);
168 if (trace_segment != -1)
169 DRD_(sg_set_trace)(trace_segment);
170 if (trace_semaphore != -1)
171 DRD_(semaphore_set_trace)(trace_semaphore);
172 if (trace_suppression != -1)
173 DRD_(suppression_set_trace)(trace_suppression);
sewardjaf44c822007-11-25 14:01:38 +0000174
bartbedfd232009-03-26 19:07:15 +0000175 return True;
sewardjaf44c822007-11-25 14:01:38 +0000176}
177
bart1335ecc2009-02-14 16:10:53 +0000178static void DRD_(print_usage)(void)
bartbd7e56e2008-03-31 18:14:12 +0000179{
bartbedfd232009-03-26 19:07:15 +0000180 VG_(printf)(
bart0ffa4832008-04-05 12:57:01 +0000181" --check-stack-var=yes|no Whether or not to report data races on\n"
182" stack variables [no].\n"
bart9d5b7962008-05-14 12:25:00 +0000183" --exclusive-threshold=<n> Print an error message if any mutex or\n"
184" writer lock is held longer than the specified time (in milliseconds).\n"
bart1a3b0b32009-05-03 17:07:34 +0000185" --first-race-only=yes|no Only report the first data race that occurs on\n"
186" a memory location instead of all races [no].\n"
bart46b5fce2008-06-28 13:01:30 +0000187" --report-signal-unlocked=yes|no Whether to report calls to\n"
188" pthread_cond_signal() where the mutex associated\n"
189" with the signal via pthread_cond_wait() is not\n"
190" locked at the time the signal is sent [yes].\n"
bart130463a2008-04-01 17:03:33 +0000191" --segment-merging=yes|no Controls segment merging [yes].\n"
bartbd7e56e2008-03-31 18:14:12 +0000192" Segment merging is an algorithm to limit memory usage of the\n"
193" data race detection algorithm. Disabling segment merging may\n"
194" improve the accuracy of the so-called 'other segments' displayed\n"
195" in race reports but can also trigger an out of memory error.\n"
bart8f822af2009-06-08 18:20:42 +0000196" --segment-merging-interval=<n> Perform segment merging every time n new\n"
197" segments have been created. Default: %d.\n"
bart9d5b7962008-05-14 12:25:00 +0000198" --shared-threshold=<n> Print an error message if a reader lock\n"
199" is held longer than the specified time (in milliseconds).\n"
bart130463a2008-04-01 17:03:33 +0000200" --show-confl-seg=yes|no Show conflicting segments in race reports [yes].\n"
201" --show-stack-usage=yes|no Print stack usage at thread exit time [no].\n"
bartbd7e56e2008-03-31 18:14:12 +0000202"\n"
bartef1b9722008-07-04 15:34:23 +0000203" drd options for monitoring process behavior:\n"
bart952e1a02008-04-06 13:06:36 +0000204" --trace-addr=<address> Trace all load and store activity for the.\n"
bart130463a2008-04-01 17:03:33 +0000205" specified address [off].\n"
206" --trace-barrier=yes|no Trace all barrier activity [no].\n"
207" --trace-cond=yes|no Trace all condition variable activity [no].\n"
208" --trace-fork-join=yes|no Trace all thread fork/join activity [no].\n"
209" --trace-mutex=yes|no Trace all mutex activity [no].\n"
210" --trace-rwlock=yes|no Trace all reader-writer lock activity[no].\n"
bart8f822af2009-06-08 18:20:42 +0000211" --trace-semaphore=yes|no Trace all semaphore activity [no].\n",
212DRD_(thread_get_segment_merge_interval)()
bartbedfd232009-03-26 19:07:15 +0000213);
sewardjaf44c822007-11-25 14:01:38 +0000214}
215
bart1335ecc2009-02-14 16:10:53 +0000216static void DRD_(print_debug_usage)(void)
bart31b983d2010-02-21 14:52:59 +0000217{
bartbedfd232009-03-26 19:07:15 +0000218 VG_(printf)(
bart130463a2008-04-01 17:03:33 +0000219" --drd-stats=yes|no Print statistics about DRD activity [no].\n"
220" --trace-clientobj=yes|no Trace all client object activity [no].\n"
221" --trace-csw=yes|no Trace all scheduler context switches [no].\n"
barte73b0aa2008-06-28 07:19:56 +0000222" --trace-conflict-set=yes|no Trace all conflict set updates [no].\n"
bart8f822af2009-06-08 18:20:42 +0000223" --trace-conflict-set-bm=yes|no Trace all conflict set bitmap\n"
224" updates [no]. Note: enabling this option\n"
225" will generate a lot of output !\n"
bart987781d2008-06-27 15:00:07 +0000226" --trace-segment=yes|no Trace segment actions [no].\n"
227" --trace-suppr=yes|no Trace all address suppression actions [no].\n"
bartbedfd232009-03-26 19:07:15 +0000228);
sewardjaf44c822007-11-25 14:01:38 +0000229}
230
231
232//
233// Implements the thread-related core callbacks.
234//
235
sewardjaf44c822007-11-25 14:01:38 +0000236static void drd_pre_mem_read(const CorePart part,
237 const ThreadId tid,
238 Char* const s,
239 const Addr a,
240 const SizeT size)
241{
bartbedfd232009-03-26 19:07:15 +0000242 if (size > 0)
243 {
244 DRD_(trace_load)(a, size);
245 }
sewardjaf44c822007-11-25 14:01:38 +0000246}
247
bart5e85d262008-03-01 10:49:37 +0000248static void drd_pre_mem_read_asciiz(const CorePart part,
249 const ThreadId tid,
250 Char* const s,
251 const Addr a)
252{
bartbedfd232009-03-26 19:07:15 +0000253 const char* p = (void*)a;
254 SizeT size = 0;
bart5e85d262008-03-01 10:49:37 +0000255
bartbedfd232009-03-26 19:07:15 +0000256 /* Note: the expression '*p' reads client memory and may crash if the */
257 /* client provided an invalid pointer ! */
258 while (*p)
259 {
260 p++;
261 size++;
262 }
bartbedfd232009-03-26 19:07:15 +0000263 if (size > 0)
264 {
265 DRD_(trace_load)(a, size);
266 }
bart5e85d262008-03-01 10:49:37 +0000267}
268
sewardjaf44c822007-11-25 14:01:38 +0000269static void drd_post_mem_write(const CorePart part,
270 const ThreadId tid,
271 const Addr a,
272 const SizeT size)
273{
bartbedfd232009-03-26 19:07:15 +0000274 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
275 if (size > 0)
276 {
277 DRD_(trace_store)(a, size);
278 }
sewardjaf44c822007-11-25 14:01:38 +0000279}
280
bart08865622008-06-06 14:31:36 +0000281static __inline__
282void drd_start_using_mem(const Addr a1, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000283{
bart5fd28142009-06-10 19:24:20 +0000284 tl_assert(a1 < a1 + len);
bart5e85d262008-03-01 10:49:37 +0000285
bartbedfd232009-03-26 19:07:15 +0000286 if (UNLIKELY(DRD_(any_address_is_traced)()))
287 {
288 DRD_(trace_mem_access)(a1, len, eStart);
289 }
bart31b983d2010-02-21 14:52:59 +0000290
bartdd75cdf2009-07-24 08:20:10 +0000291 if (UNLIKELY(DRD_(running_thread_inside_pthread_create)()))
292 {
293 DRD_(start_suppression)(a1, a1 + len, "pthread_create()");
294 }
sewardjaf44c822007-11-25 14:01:38 +0000295}
296
sewardj7cf4e6b2008-05-01 20:24:26 +0000297static void drd_start_using_mem_w_ecu(const Addr a1,
298 const SizeT len,
299 UInt ec_uniq)
300{
bartbedfd232009-03-26 19:07:15 +0000301 drd_start_using_mem(a1, len);
sewardj7cf4e6b2008-05-01 20:24:26 +0000302}
303
304static void drd_start_using_mem_w_tid(const Addr a1,
305 const SizeT len,
306 ThreadId tid)
307{
bartbedfd232009-03-26 19:07:15 +0000308 drd_start_using_mem(a1, len);
sewardj7cf4e6b2008-05-01 20:24:26 +0000309}
310
bart0ffa4832008-04-05 12:57:01 +0000311static __inline__
312void drd_stop_using_mem(const Addr a1, const SizeT len,
313 const Bool is_stack_mem)
sewardjaf44c822007-11-25 14:01:38 +0000314{
bartbedfd232009-03-26 19:07:15 +0000315 const Addr a2 = a1 + len;
bart5e85d262008-03-01 10:49:37 +0000316
bart5fd28142009-06-10 19:24:20 +0000317 tl_assert(a1 < a2);
bart5e85d262008-03-01 10:49:37 +0000318
bartbedfd232009-03-26 19:07:15 +0000319 if (UNLIKELY(DRD_(any_address_is_traced)()))
320 {
321 DRD_(trace_mem_access)(a1, len, eEnd);
322 }
323 if (! is_stack_mem || DRD_(get_check_stack_accesses)())
324 {
325 DRD_(thread_stop_using_mem)(a1, a2);
326 DRD_(clientobj_stop_using_mem)(a1, a2);
327 DRD_(suppression_stop_using_mem)(a1, a2);
328 }
bart0ffa4832008-04-05 12:57:01 +0000329}
330
331static __inline__
332void drd_stop_using_nonstack_mem(const Addr a1, const SizeT len)
333{
bartbedfd232009-03-26 19:07:15 +0000334 drd_stop_using_mem(a1, len, False);
sewardjaf44c822007-11-25 14:01:38 +0000335}
336
bart1335ecc2009-02-14 16:10:53 +0000337/**
bartfdaa0182009-03-10 09:25:32 +0000338 * Discard all information DRD has about memory accesses and client objects
339 * in the specified address range.
340 */
341void DRD_(clean_memory)(const Addr a1, const SizeT len)
342{
bartbedfd232009-03-26 19:07:15 +0000343 const Bool is_stack_memory = DRD_(thread_address_on_any_stack)(a1);
344 drd_stop_using_mem(a1, len, is_stack_memory);
345 drd_start_using_mem(a1, len);
bartfdaa0182009-03-10 09:25:32 +0000346}
347
348/**
bart1335ecc2009-02-14 16:10:53 +0000349 * Suppress data race reports on all addresses contained in .plt and
350 * .got.plt sections inside the address range [ a, a + len [. The data in
351 * these sections is modified by _dl_relocate_object() every time a function
352 * in a shared library is called for the first time. Since the first call
353 * to a function in a shared library can happen from a multithreaded context,
354 * such calls can cause conflicting accesses. See also Ulrich Drepper's
355 * paper "How to Write Shared Libraries" for more information about relocation
356 * (http://people.redhat.com/drepper/dsohowto.pdf).
bartcb2d0072008-05-31 07:55:51 +0000357 */
bart1335ecc2009-02-14 16:10:53 +0000358static void DRD_(suppress_relocation_conflicts)(const Addr a, const SizeT len)
bartcb2d0072008-05-31 07:55:51 +0000359{
bartbedfd232009-03-26 19:07:15 +0000360 const DebugInfo* di;
bartcb2d0072008-05-31 07:55:51 +0000361
362#if 0
bartbedfd232009-03-26 19:07:15 +0000363 VG_(printf)("Evaluating range @ 0x%lx size %ld\n", a, len);
bartcb2d0072008-05-31 07:55:51 +0000364#endif
365
sewardje3f1e592009-07-31 09:41:29 +0000366 for (di = VG_(next_DebugInfo)(0); di; di = VG_(next_DebugInfo)(di))
bartbedfd232009-03-26 19:07:15 +0000367 {
368 Addr avma;
369 SizeT size;
bartcb2d0072008-05-31 07:55:51 +0000370
sewardje3f1e592009-07-31 09:41:29 +0000371 avma = VG_(DebugInfo_get_plt_avma)(di);
372 size = VG_(DebugInfo_get_plt_size)(di);
bartbedfd232009-03-26 19:07:15 +0000373 tl_assert((avma && size) || (avma == 0 && size == 0));
374 if (size > 0)
375 {
bartcb2d0072008-05-31 07:55:51 +0000376#if 0
bartbedfd232009-03-26 19:07:15 +0000377 VG_(printf)("Suppressing .plt @ 0x%lx size %ld\n", avma, size);
bartcb2d0072008-05-31 07:55:51 +0000378#endif
sewardje3f1e592009-07-31 09:41:29 +0000379 tl_assert(VG_(DebugInfo_sect_kind)(NULL, 0, avma) == Vg_SectPLT);
bartbedfd232009-03-26 19:07:15 +0000380 DRD_(start_suppression)(avma, avma + size, ".plt");
381 }
bartcb2d0072008-05-31 07:55:51 +0000382
sewardje3f1e592009-07-31 09:41:29 +0000383 avma = VG_(DebugInfo_get_gotplt_avma)(di);
384 size = VG_(DebugInfo_get_gotplt_size)(di);
bartbedfd232009-03-26 19:07:15 +0000385 tl_assert((avma && size) || (avma == 0 && size == 0));
386 if (size > 0)
387 {
bartcb2d0072008-05-31 07:55:51 +0000388#if 0
bartbedfd232009-03-26 19:07:15 +0000389 VG_(printf)("Suppressing .got.plt @ 0x%lx size %ld\n", avma, size);
bartcb2d0072008-05-31 07:55:51 +0000390#endif
sewardje3f1e592009-07-31 09:41:29 +0000391 tl_assert(VG_(DebugInfo_sect_kind)(NULL, 0, avma) == Vg_SectGOTPLT);
bartbedfd232009-03-26 19:07:15 +0000392 DRD_(start_suppression)(avma, avma + size, ".gotplt");
393 }
394 }
bartcb2d0072008-05-31 07:55:51 +0000395}
396
bart5e85d262008-03-01 10:49:37 +0000397static
398void drd_start_using_mem_w_perms(const Addr a, const SizeT len,
sewardj9c606bd2008-09-18 18:12:50 +0000399 const Bool rr, const Bool ww, const Bool xx,
400 ULong di_handle)
bart5e85d262008-03-01 10:49:37 +0000401{
bartbedfd232009-03-26 19:07:15 +0000402 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
bartd5765912008-03-16 08:40:55 +0000403
bartbedfd232009-03-26 19:07:15 +0000404 drd_start_using_mem(a, len);
bartcb2d0072008-05-31 07:55:51 +0000405
bartbedfd232009-03-26 19:07:15 +0000406 DRD_(suppress_relocation_conflicts)(a, len);
bart5e85d262008-03-01 10:49:37 +0000407}
408
sewardjaf44c822007-11-25 14:01:38 +0000409/* Called by the core when the stack of a thread grows, to indicate that */
410/* the addresses in range [ a, a + len [ may now be used by the client. */
411/* Assumption: stacks grow downward. */
bart08865622008-06-06 14:31:36 +0000412static __inline__
413void drd_start_using_mem_stack(const Addr a, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000414{
bartbedfd232009-03-26 19:07:15 +0000415 DRD_(thread_set_stack_min)(DRD_(thread_get_running_tid)(),
416 a - VG_STACK_REDZONE_SZB);
bart31b983d2010-02-21 14:52:59 +0000417 drd_start_using_mem(a - VG_STACK_REDZONE_SZB,
bartbedfd232009-03-26 19:07:15 +0000418 len + VG_STACK_REDZONE_SZB);
sewardjaf44c822007-11-25 14:01:38 +0000419}
420
421/* Called by the core when the stack of a thread shrinks, to indicate that */
422/* the addresses [ a, a + len [ are no longer accessible for the client. */
423/* Assumption: stacks grow downward. */
bart08865622008-06-06 14:31:36 +0000424static __inline__
425void drd_stop_using_mem_stack(const Addr a, const SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000426{
bartbedfd232009-03-26 19:07:15 +0000427 DRD_(thread_set_stack_min)(DRD_(thread_get_running_tid)(),
428 a + len - VG_STACK_REDZONE_SZB);
429 drd_stop_using_mem(a - VG_STACK_REDZONE_SZB, len + VG_STACK_REDZONE_SZB,
430 True);
sewardjaf44c822007-11-25 14:01:38 +0000431}
432
bartbedfd232009-03-26 19:07:15 +0000433/**
434 * Callback function called by the Valgrind core before a stack area is
435 * being used by a signal handler.
436 *
437 * @param[in] a Start of address range.
438 * @param[in] len Address range length.
439 * @param[in] tid Valgrind thread ID for whom the signal frame is being
440 * constructed.
441 */
442static void drd_start_using_mem_stack_signal(const Addr a, const SizeT len,
443 ThreadId tid)
sewardjaf44c822007-11-25 14:01:38 +0000444{
bartbedfd232009-03-26 19:07:15 +0000445 DRD_(thread_set_vg_running_tid)(VG_(get_running_tid)());
446 drd_start_using_mem(a, len);
sewardjaf44c822007-11-25 14:01:38 +0000447}
448
bart5e85d262008-03-01 10:49:37 +0000449static void drd_stop_using_mem_stack_signal(Addr a, SizeT len)
sewardjaf44c822007-11-25 14:01:38 +0000450{
bartbedfd232009-03-26 19:07:15 +0000451 drd_stop_using_mem(a, len, True);
sewardjaf44c822007-11-25 14:01:38 +0000452}
453
454static
455void drd_pre_thread_create(const ThreadId creator, const ThreadId created)
456{
bartbedfd232009-03-26 19:07:15 +0000457 const DrdThreadId drd_creator = DRD_(VgThreadIdToDrdThreadId)(creator);
458 tl_assert(created != VG_INVALID_THREADID);
459 DRD_(thread_pre_create)(drd_creator, created);
460 if (DRD_(IsValidDrdThreadId)(drd_creator))
461 {
462 DRD_(thread_new_segment)(drd_creator);
463 }
464 if (DRD_(thread_get_trace_fork_join)())
465 {
466 VG_(message)(Vg_DebugMsg,
bart63c92ea2009-07-19 17:53:56 +0000467 "drd_pre_thread_create creator = %d, created = %d\n",
468 drd_creator, created);
bartbedfd232009-03-26 19:07:15 +0000469 }
sewardjaf44c822007-11-25 14:01:38 +0000470}
471
472/* Called by Valgrind's core before any loads or stores are performed on */
473/* the context of thread "created". At startup, this function is called */
474/* with arguments (0,1). */
475static
bart0ffa4832008-04-05 12:57:01 +0000476void drd_post_thread_create(const ThreadId vg_created)
sewardjaf44c822007-11-25 14:01:38 +0000477{
bartbedfd232009-03-26 19:07:15 +0000478 DrdThreadId drd_created;
bart0ffa4832008-04-05 12:57:01 +0000479
bartbedfd232009-03-26 19:07:15 +0000480 tl_assert(vg_created != VG_INVALID_THREADID);
bart0ffa4832008-04-05 12:57:01 +0000481
bartbedfd232009-03-26 19:07:15 +0000482 drd_created = DRD_(thread_post_create)(vg_created);
483 if (DRD_(thread_get_trace_fork_join)())
484 {
485 VG_(message)(Vg_DebugMsg,
bart63c92ea2009-07-19 17:53:56 +0000486 "drd_post_thread_create created = %d\n",
487 drd_created);
bartbedfd232009-03-26 19:07:15 +0000488 }
489 if (! DRD_(get_check_stack_accesses)())
490 {
491 DRD_(start_suppression)(DRD_(thread_get_stack_max)(drd_created)
492 - DRD_(thread_get_stack_size)(drd_created),
493 DRD_(thread_get_stack_max)(drd_created),
494 "stack");
495 }
sewardjaf44c822007-11-25 14:01:38 +0000496}
497
sewardjaf44c822007-11-25 14:01:38 +0000498/* Called after a thread has performed its last memory access. */
bartd43f8d32008-03-16 17:29:20 +0000499static void drd_thread_finished(ThreadId vg_tid)
sewardjaf44c822007-11-25 14:01:38 +0000500{
bartbedfd232009-03-26 19:07:15 +0000501 DrdThreadId drd_tid;
sewardj85642922008-01-14 11:54:56 +0000502
bartbedfd232009-03-26 19:07:15 +0000503 tl_assert(VG_(get_running_tid)() == vg_tid);
sewardj85642922008-01-14 11:54:56 +0000504
bartbedfd232009-03-26 19:07:15 +0000505 drd_tid = DRD_(VgThreadIdToDrdThreadId)(vg_tid);
506 if (DRD_(thread_get_trace_fork_join)())
507 {
508 VG_(message)(Vg_DebugMsg,
bart63c92ea2009-07-19 17:53:56 +0000509 "drd_thread_finished tid = %d%s\n",
bartbedfd232009-03-26 19:07:15 +0000510 drd_tid,
511 DRD_(thread_get_joinable)(drd_tid)
512 ? ""
513 : " (which is a detached thread)");
514 }
515 if (DRD_(s_show_stack_usage))
516 {
517 const SizeT stack_size = DRD_(thread_get_stack_size)(drd_tid);
518 const SizeT used_stack
519 = (DRD_(thread_get_stack_max)(drd_tid)
520 - DRD_(thread_get_stack_min_min)(drd_tid));
521 VG_(message)(Vg_UserMsg,
bart63c92ea2009-07-19 17:53:56 +0000522 "thread %d%s finished and used %ld bytes out of %ld"
sewardj1e29ebc2009-07-15 14:49:17 +0000523 " on its stack. Margin: %ld bytes.\n",
bartbedfd232009-03-26 19:07:15 +0000524 drd_tid,
525 DRD_(thread_get_joinable)(drd_tid)
526 ? ""
527 : " (which is a detached thread)",
528 used_stack,
529 stack_size,
530 stack_size - used_stack);
sewardjaf44c822007-11-25 14:01:38 +0000531
bartbedfd232009-03-26 19:07:15 +0000532 }
533 drd_stop_using_mem(DRD_(thread_get_stack_min)(drd_tid),
534 DRD_(thread_get_stack_max)(drd_tid)
535 - DRD_(thread_get_stack_min)(drd_tid),
536 True);
bartd45d9952009-05-31 18:53:54 +0000537 DRD_(thread_set_record_loads)(drd_tid, False);
538 DRD_(thread_set_record_stores)(drd_tid, False);
bartbedfd232009-03-26 19:07:15 +0000539 DRD_(thread_finished)(drd_tid);
sewardjaf44c822007-11-25 14:01:38 +0000540}
541
sewardjaf44c822007-11-25 14:01:38 +0000542//
543// Implementation of the tool interface.
544//
545
bart1335ecc2009-02-14 16:10:53 +0000546static void DRD_(post_clo_init)(void)
sewardjdcbb8d32007-11-26 21:34:30 +0000547{
bart0c6bf352009-07-25 14:03:53 +0000548#if defined(VGO_linux) || defined(VGO_darwin)
bartc6ef4af2009-07-23 10:10:30 +0000549 /* fine */
bartc6ef4af2009-07-23 10:10:30 +0000550#else
551 VG_(printf)("\nWARNING: DRD has not yet been tested on this operating system.\n\n");
sewardjdcbb8d32007-11-26 21:34:30 +0000552# endif
bart95761b52008-03-29 08:34:03 +0000553
bartbedfd232009-03-26 19:07:15 +0000554 if (DRD_(s_var_info))
555 {
556 VG_(needs_var_info)();
557 }
sewardjdcbb8d32007-11-26 21:34:30 +0000558}
sewardjaf44c822007-11-25 14:01:38 +0000559
sewardjaf44c822007-11-25 14:01:38 +0000560static void drd_start_client_code(const ThreadId tid, const ULong bbs_done)
561{
bartbedfd232009-03-26 19:07:15 +0000562 tl_assert(tid == VG_(get_running_tid)());
563 DRD_(thread_set_vg_running_tid)(tid);
sewardjaf44c822007-11-25 14:01:38 +0000564}
565
bart1335ecc2009-02-14 16:10:53 +0000566static void DRD_(fini)(Int exitcode)
sewardjaf44c822007-11-25 14:01:38 +0000567{
bartbedfd232009-03-26 19:07:15 +0000568 // thread_print_all();
sewardj2d9e8742009-08-07 15:46:56 +0000569 if (VG_(clo_verbosity) == 1 && !VG_(clo_xml)) {
bart31b983d2010-02-21 14:52:59 +0000570 VG_(message)(Vg_UserMsg,
sewardj2d9e8742009-08-07 15:46:56 +0000571 "For counts of detected and suppressed errors, "
572 "rerun with: -v\n");
573 }
574
575 if (VG_(clo_stats) || DRD_(s_print_stats))
bartbedfd232009-03-26 19:07:15 +0000576 {
barte5214662009-06-21 11:51:23 +0000577 ULong pu = DRD_(thread_get_update_conflict_set_count)();
578 ULong pu_seg_cr = DRD_(thread_get_update_conflict_set_new_sg_count)();
579 ULong pu_mtx_cv = DRD_(thread_get_update_conflict_set_sync_count)();
580 ULong pu_join = DRD_(thread_get_update_conflict_set_join_count)();
581
bartbedfd232009-03-26 19:07:15 +0000582 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000583 " thread: %lld context switches.\n",
bart54803fe2009-06-21 09:26:27 +0000584 DRD_(thread_get_context_switch_count)());
bartbedfd232009-03-26 19:07:15 +0000585 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000586 "confl set: %lld full updates and %lld partial updates;\n",
bart54803fe2009-06-21 09:26:27 +0000587 DRD_(thread_get_compute_conflict_set_count)(),
barte5214662009-06-21 11:51:23 +0000588 pu);
bartbedfd232009-03-26 19:07:15 +0000589 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000590 " %lld partial updates during segment creation,\n",
barte5214662009-06-21 11:51:23 +0000591 pu_seg_cr);
592 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000593 " %lld because of mutex/sema/cond.var. operations,\n",
barte5214662009-06-21 11:51:23 +0000594 pu_mtx_cv);
595 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000596 " %lld because of barrier/rwlock operations and\n",
barte5214662009-06-21 11:51:23 +0000597 pu - pu_seg_cr - pu_mtx_cv - pu_join);
598 VG_(message)(Vg_UserMsg,
599 " %lld partial updates because of thread join"
sewardj1e29ebc2009-07-15 14:49:17 +0000600 " operations.\n",
barte5214662009-06-21 11:51:23 +0000601 pu_join);
602 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000603 " segments: created %lld segments, max %lld alive,\n",
bart9dedafe2009-06-21 18:09:02 +0000604 DRD_(sg_get_segments_created_count)(),
605 DRD_(sg_get_max_segments_alive_count)());
bartbedfd232009-03-26 19:07:15 +0000606 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000607 " %lld discard points and %lld merges.\n",
bart9dedafe2009-06-21 18:09:02 +0000608 DRD_(thread_get_discard_ordered_segments_count)(),
bart1a3b0b32009-05-03 17:07:34 +0000609 DRD_(sg_get_segment_merge_count)());
610 VG_(message)(Vg_UserMsg,
bart54803fe2009-06-21 09:26:27 +0000611 "segmnt cr: %lld mutex, %lld rwlock, %lld semaphore and"
sewardj1e29ebc2009-07-15 14:49:17 +0000612 " %lld barrier.\n",
bartbedfd232009-03-26 19:07:15 +0000613 DRD_(get_mutex_segment_creation_count)(),
614 DRD_(get_rwlock_segment_creation_count)(),
615 DRD_(get_semaphore_segment_creation_count)(),
616 DRD_(get_barrier_segment_creation_count)());
617 VG_(message)(Vg_UserMsg,
bart9dedafe2009-06-21 18:09:02 +0000618 " bitmaps: %lld level one"
sewardj1e29ebc2009-07-15 14:49:17 +0000619 " and %lld level two bitmaps were allocated.\n",
bartbedfd232009-03-26 19:07:15 +0000620 DRD_(bm_get_bitmap_creation_count)(),
bartbedfd232009-03-26 19:07:15 +0000621 DRD_(bm_get_bitmap2_creation_count)());
622 VG_(message)(Vg_UserMsg,
sewardj1e29ebc2009-07-15 14:49:17 +0000623 " mutex: %lld non-recursive lock/unlock events.\n",
bartbedfd232009-03-26 19:07:15 +0000624 DRD_(get_mutex_lock_count)());
625 DRD_(print_malloc_stats)();
626 }
sewardjaf44c822007-11-25 14:01:38 +0000627}
628
sewardjaf44c822007-11-25 14:01:38 +0000629static
630void drd_pre_clo_init(void)
631{
njnf76d27a2009-05-28 01:53:07 +0000632 // Basic tool stuff.
bartbedfd232009-03-26 19:07:15 +0000633 VG_(details_name) ("drd");
634 VG_(details_version) (NULL);
635 VG_(details_description) ("a thread error detector");
636 VG_(details_copyright_author)("Copyright (C) 2006-2009, and GNU GPL'd,"
637 " by Bart Van Assche.");
638 VG_(details_bug_reports_to) (VG_BUGS_TO);
sewardjaf44c822007-11-25 14:01:38 +0000639
bartbedfd232009-03-26 19:07:15 +0000640 VG_(basic_tool_funcs) (DRD_(post_clo_init),
641 DRD_(instrument),
642 DRD_(fini));
sewardjaf44c822007-11-25 14:01:38 +0000643
bartbedfd232009-03-26 19:07:15 +0000644 // Command line stuff.
645 VG_(needs_command_line_options)(DRD_(process_cmd_line_option),
646 DRD_(print_usage),
647 DRD_(print_debug_usage));
sewardjaf44c822007-11-25 14:01:38 +0000648
bartbedfd232009-03-26 19:07:15 +0000649 // Error handling.
650 DRD_(register_error_handlers)();
sewardjaf44c822007-11-25 14:01:38 +0000651
bartbedfd232009-03-26 19:07:15 +0000652 // Core event tracking.
653 VG_(track_pre_mem_read) (drd_pre_mem_read);
654 VG_(track_pre_mem_read_asciiz) (drd_pre_mem_read_asciiz);
655 VG_(track_post_mem_write) (drd_post_mem_write);
656 VG_(track_new_mem_brk) (drd_start_using_mem_w_tid);
657 VG_(track_new_mem_mmap) (drd_start_using_mem_w_perms);
658 VG_(track_new_mem_stack) (drd_start_using_mem_stack);
659 VG_(track_new_mem_stack_signal) (drd_start_using_mem_stack_signal);
660 VG_(track_new_mem_startup) (drd_start_using_mem_w_perms);
661 VG_(track_die_mem_brk) (drd_stop_using_nonstack_mem);
662 VG_(track_die_mem_munmap) (drd_stop_using_nonstack_mem);
663 VG_(track_die_mem_stack) (drd_stop_using_mem_stack);
664 VG_(track_die_mem_stack_signal) (drd_stop_using_mem_stack_signal);
665 VG_(track_start_client_code) (drd_start_client_code);
666 VG_(track_pre_thread_ll_create) (drd_pre_thread_create);
667 VG_(track_pre_thread_first_insn)(drd_post_thread_create);
668 VG_(track_pre_thread_ll_exit) (drd_thread_finished);
sewardjaf44c822007-11-25 14:01:38 +0000669
bartbedfd232009-03-26 19:07:15 +0000670 // Other stuff.
671 DRD_(register_malloc_wrappers)(drd_start_using_mem_w_ecu,
672 drd_stop_using_nonstack_mem);
sewardjaf44c822007-11-25 14:01:38 +0000673
bartbedfd232009-03-26 19:07:15 +0000674 DRD_(clientreq_init)();
sewardjaf44c822007-11-25 14:01:38 +0000675
bartbedfd232009-03-26 19:07:15 +0000676 DRD_(suppression_init)();
bart4bb53d82008-02-28 19:06:34 +0000677
bartbedfd232009-03-26 19:07:15 +0000678 DRD_(clientobj_init)();
barte5e0efa2009-06-24 18:35:02 +0000679
680 {
681 Char* const smi = VG_(getenv)("DRD_SEGMENT_MERGING_INTERVAL");
682 if (smi)
683 DRD_(thread_set_segment_merge_interval)(VG_(strtoll10)(smi, NULL));
684 }
sewardjaf44c822007-11-25 14:01:38 +0000685}
686
687
688VG_DETERMINE_INTERFACE_VERSION(drd_pre_clo_init)