blob: 0f1bc281d15ba418ec08f94d3b490c4d03fa214a [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
bart86562bd2009-02-16 19:43:56 +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
26#ifndef __THREAD_H
27#define __THREAD_H
28
29
bart324a23b2009-02-15 12:14:52 +000030/* Include directives. */
sewardjaf44c822007-11-25 14:01:38 +000031
bart09dc13f2009-02-14 15:13:31 +000032#include "drd_basics.h"
bartf00a85b2008-03-13 18:49:23 +000033#include "drd_segment.h"
bartd59bb0f2008-06-08 08:08:31 +000034#include "pub_drd_bitmap.h"
bart86a87df2009-03-04 19:26:47 +000035#include "pub_tool_libcassert.h" /* tl_assert() */
36#include "pub_tool_stacktrace.h" /* typedef StackTrace */
37#include "pub_tool_threadstate.h" /* VG_N_THREADS */
bartf00a85b2008-03-13 18:49:23 +000038
39
bart324a23b2009-02-15 12:14:52 +000040/* Defines. */
bartf00a85b2008-03-13 18:49:23 +000041
bart86a87df2009-03-04 19:26:47 +000042/** Maximum number of threads DRD keeps information about. */
bartf00a85b2008-03-13 18:49:23 +000043#define DRD_N_THREADS VG_N_THREADS
sewardjaf44c822007-11-25 14:01:38 +000044
bart86a87df2009-03-04 19:26:47 +000045/** A number different from any valid DRD thread ID. */
sewardjaf44c822007-11-25 14:01:38 +000046#define DRD_INVALID_THREADID 0
47
bart86a87df2009-03-04 19:26:47 +000048/**
49 * A number different from any valid POSIX thread ID.
50 *
51 * @note The PThreadId typedef and the INVALID_POSIX_THREADID depend on the
52 * operating system and threading library in use. PThreadId must contain at
53 * least as many bits as pthread_t, and INVALID_POSIX_THREADID
54 * must be a value that will never be returned by pthread_self().
55 */
sewardjaf44c822007-11-25 14:01:38 +000056#define INVALID_POSIX_THREADID ((PThreadId)0)
57
58
bart324a23b2009-02-15 12:14:52 +000059/* Type definitions. */
bartf00a85b2008-03-13 18:49:23 +000060
bart86a87df2009-03-04 19:26:47 +000061/**
62 * POSIX thread ID. The type PThreadId must be at least as wide as
63 * pthread_t.
64 */
sewardjaf44c822007-11-25 14:01:38 +000065typedef UWord PThreadId;
66
bart86a87df2009-03-04 19:26:47 +000067/** Per-thread information managed by DRD. */
bartf00a85b2008-03-13 18:49:23 +000068typedef struct
69{
bartbedfd232009-03-26 19:07:15 +000070 Segment* first; /**< Pointer to first segment. */
71 Segment* last; /**< Pointer to last segment. */
72 ThreadId vg_threadid; /**< Valgrind thread ID. */
73 PThreadId pt_threadid; /**< POSIX thread ID. */
74 Addr stack_min_min; /**< Lowest value stack pointer ever had. */
75 Addr stack_min; /**< Current stack pointer. */
76 Addr stack_startup; /**<Stack pointer after pthread_create() finished.*/
77 Addr stack_max; /**< Top of stack. */
78 SizeT stack_size; /**< Maximum size of stack. */
bartd45d9952009-05-31 18:53:54 +000079 char name[64]; /**< User-assigned thread name. */
bartbedfd232009-03-26 19:07:15 +000080 /** Indicates whether the Valgrind core knows about this thread. */
81 Bool vg_thread_exists;
82 /** Indicates whether there is an associated POSIX thread ID. */
83 Bool posix_thread_exists;
84 /**
85 * If true, indicates that there is a corresponding POSIX thread ID and
86 * a corresponding OS thread that is detached.
87 */
88 Bool detached_posix_thread;
bartd45d9952009-05-31 18:53:54 +000089 /** Wether recording of memory load accesses is currently enabled. */
90 Bool is_recording_loads;
91 /** Wether recording of memory load accesses is currently enabled. */
92 Bool is_recording_stores;
bartbedfd232009-03-26 19:07:15 +000093 /** Nesting level of synchronization functions called by the client. */
94 Int synchr_nesting;
bartf00a85b2008-03-13 18:49:23 +000095} ThreadInfo;
96
97
bart324a23b2009-02-15 12:14:52 +000098/*
99 * Local variables of drd_thread.c that are declared here such that these
100 * can be accessed by inline functions.
101 */
bartf00a85b2008-03-13 18:49:23 +0000102
bart86a87df2009-03-04 19:26:47 +0000103/**
104 * DRD thread ID of the currently running thread. It is crucial for correct
105 * operation of DRD that this number is always in sync with
106 * VG_(get_running_tid)().
107 */
bart324a23b2009-02-15 12:14:52 +0000108extern DrdThreadId DRD_(g_drd_running_tid);
bart86a87df2009-03-04 19:26:47 +0000109/** Per-thread information managed by DRD. */
bart324a23b2009-02-15 12:14:52 +0000110extern ThreadInfo DRD_(g_threadinfo)[DRD_N_THREADS];
bart86a87df2009-03-04 19:26:47 +0000111/** Conflict set for the currently running thread. */
bart324a23b2009-02-15 12:14:52 +0000112extern struct bitmap* DRD_(g_conflict_set);
bartf00a85b2008-03-13 18:49:23 +0000113
114
bart324a23b2009-02-15 12:14:52 +0000115/* Function declarations. */
sewardjaf44c822007-11-25 14:01:38 +0000116
bart62a784c2009-02-15 13:11:14 +0000117void DRD_(thread_trace_context_switches)(const Bool t);
118void DRD_(thread_trace_conflict_set)(const Bool t);
bart09dc13f2009-02-14 15:13:31 +0000119Bool DRD_(thread_get_trace_fork_join)(void);
120void DRD_(thread_set_trace_fork_join)(const Bool t);
bart62a784c2009-02-15 13:11:14 +0000121void DRD_(thread_set_segment_merging)(const Bool m);
sewardjaf44c822007-11-25 14:01:38 +0000122
bart62a784c2009-02-15 13:11:14 +0000123DrdThreadId DRD_(VgThreadIdToDrdThreadId)(const ThreadId tid);
124DrdThreadId DRD_(NewVgThreadIdToDrdThreadId)(const ThreadId tid);
125DrdThreadId DRD_(PtThreadIdToDrdThreadId)(const PThreadId tid);
126ThreadId DRD_(DrdThreadIdToVgThreadId)(const DrdThreadId tid);
127DrdThreadId DRD_(thread_pre_create)(const DrdThreadId creator,
bartbedfd232009-03-26 19:07:15 +0000128 const ThreadId vg_created);
bart62a784c2009-02-15 13:11:14 +0000129DrdThreadId DRD_(thread_post_create)(const ThreadId vg_created);
bart09dc13f2009-02-14 15:13:31 +0000130void DRD_(thread_post_join)(DrdThreadId drd_joiner, DrdThreadId drd_joinee);
bart62a784c2009-02-15 13:11:14 +0000131void DRD_(thread_delete)(const DrdThreadId tid);
132void DRD_(thread_finished)(const DrdThreadId tid);
133void DRD_(thread_pre_cancel)(const DrdThreadId tid);
bartbedfd232009-03-26 19:07:15 +0000134void DRD_(thread_set_stack_startup)(const DrdThreadId tid,
135 const Addr stack_startup);
bart62a784c2009-02-15 13:11:14 +0000136Addr DRD_(thread_get_stack_min)(const DrdThreadId tid);
137Addr DRD_(thread_get_stack_min_min)(const DrdThreadId tid);
138Addr DRD_(thread_get_stack_max)(const DrdThreadId tid);
139SizeT DRD_(thread_get_stack_size)(const DrdThreadId tid);
140void DRD_(thread_set_pthreadid)(const DrdThreadId tid, const PThreadId ptid);
141Bool DRD_(thread_get_joinable)(const DrdThreadId tid);
142void DRD_(thread_set_joinable)(const DrdThreadId tid, const Bool joinable);
bartd45d9952009-05-31 18:53:54 +0000143const char* DRD_(thread_get_name)(const DrdThreadId tid);
144void DRD_(thread_set_name)(const DrdThreadId tid, const char* const name);
bart62a784c2009-02-15 13:11:14 +0000145void DRD_(thread_set_vg_running_tid)(const ThreadId vg_tid);
146void DRD_(thread_set_running_tid)(const ThreadId vg_tid,
bartbedfd232009-03-26 19:07:15 +0000147 const DrdThreadId drd_tid);
bart62a784c2009-02-15 13:11:14 +0000148int DRD_(thread_enter_synchr)(const DrdThreadId tid);
149int DRD_(thread_leave_synchr)(const DrdThreadId tid);
150int DRD_(thread_get_synchr_nesting_count)(const DrdThreadId tid);
151void DRD_(thread_new_segment)(const DrdThreadId tid);
152VectorClock* DRD_(thread_get_vc)(const DrdThreadId tid);
153void DRD_(thread_get_latest_segment)(Segment** sg, const DrdThreadId tid);
bartbedfd232009-03-26 19:07:15 +0000154void DRD_(thread_combine_vc)(const DrdThreadId joiner,
155 const DrdThreadId joinee);
156void DRD_(thread_combine_vc2)(const DrdThreadId tid,
157 const VectorClock* const vc);
bartdfbae6e2008-06-05 08:29:53 +0000158
bart62a784c2009-02-15 13:11:14 +0000159void DRD_(thread_stop_using_mem)(const Addr a1, const Addr a2);
bartd45d9952009-05-31 18:53:54 +0000160void DRD_(thread_set_record_loads)(const DrdThreadId tid, const Bool enabled);
161void DRD_(thread_set_record_stores)(const DrdThreadId tid, const Bool enabled);
bart62a784c2009-02-15 13:11:14 +0000162void DRD_(thread_print_all)(void);
163void DRD_(thread_report_races)(const DrdThreadId tid);
164void DRD_(thread_report_races_segment)(const DrdThreadId tid,
bartbedfd232009-03-26 19:07:15 +0000165 const Segment* const p);
bart62a784c2009-02-15 13:11:14 +0000166void DRD_(thread_report_all_races)(void);
167void DRD_(thread_report_conflicting_segments)(const DrdThreadId tid,
bartbedfd232009-03-26 19:07:15 +0000168 const Addr addr,
169 const SizeT size,
170 const BmAccessTypeT access_type);
bart62a784c2009-02-15 13:11:14 +0000171ULong DRD_(thread_get_context_switch_count)(void);
172ULong DRD_(thread_get_report_races_count)(void);
173ULong DRD_(thread_get_discard_ordered_segments_count)(void);
174ULong DRD_(thread_get_update_conflict_set_count)(ULong* dsnsc, ULong* dscvc);
175ULong DRD_(thread_get_conflict_set_bitmap_creation_count)(void);
176ULong DRD_(thread_get_conflict_set_bitmap2_creation_count)(void);
sewardjaf44c822007-11-25 14:01:38 +0000177
178
bart324a23b2009-02-15 12:14:52 +0000179/* Inline function definitions. */
180
bart86a87df2009-03-04 19:26:47 +0000181/**
182 * Whether or not the specified DRD thread ID is valid.
183 *
184 * A DRD thread ID is valid if and only if the following conditions are met:
185 * - The ID is a valid index of the DRD_(g_threadinfo)[] array.
186 * - The ID is not equal to DRD_INVALID_THREADID.
187 * - The ID refers either to a thread known by the Valgrind core, a joinable
188 * thread that has not yet been joined or a detached thread.
189 */
bartbf80e122008-06-06 10:18:24 +0000190static __inline__
bart62a784c2009-02-15 13:11:14 +0000191Bool DRD_(IsValidDrdThreadId)(const DrdThreadId tid)
bartbf80e122008-06-06 10:18:24 +0000192{
bartbedfd232009-03-26 19:07:15 +0000193 return (0 <= (int)tid && tid < DRD_N_THREADS && tid != DRD_INVALID_THREADID
194 && ! (DRD_(g_threadinfo)[tid].vg_thread_exists == False
195 && DRD_(g_threadinfo)[tid].posix_thread_exists == False
196 && DRD_(g_threadinfo)[tid].detached_posix_thread == False));
bartbf80e122008-06-06 10:18:24 +0000197}
198
bart86a87df2009-03-04 19:26:47 +0000199/** Returns the DRD thread ID of the currently running thread. */
bart08865622008-06-06 14:31:36 +0000200static __inline__
bart62a784c2009-02-15 13:11:14 +0000201DrdThreadId DRD_(thread_get_running_tid)(void)
bart1ea5fff2008-03-16 08:36:23 +0000202{
bartbedfd232009-03-26 19:07:15 +0000203 tl_assert(DRD_(g_drd_running_tid) != DRD_INVALID_THREADID);
204 return DRD_(g_drd_running_tid);
bart1ea5fff2008-03-16 08:36:23 +0000205}
206
bart86a87df2009-03-04 19:26:47 +0000207/** Returns a pointer to the conflict set for the currently running thread. */
bart08865622008-06-06 14:31:36 +0000208static __inline__
bart62a784c2009-02-15 13:11:14 +0000209struct bitmap* DRD_(thread_get_conflict_set)(void)
bart1a473c72008-03-13 19:03:38 +0000210{
bartbedfd232009-03-26 19:07:15 +0000211 return DRD_(g_conflict_set);
bart1a473c72008-03-13 19:03:38 +0000212}
213
bart86a87df2009-03-04 19:26:47 +0000214/**
215 * Reports whether or not memory access recording is enabled for the
216 * currently running thread.
217 */
bart08865622008-06-06 14:31:36 +0000218static __inline__
bartd45d9952009-05-31 18:53:54 +0000219Bool DRD_(running_thread_is_recording_loads)(void)
bartf00a85b2008-03-13 18:49:23 +0000220{
bart8b4b2ee2008-06-11 13:17:56 +0000221#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
bartbedfd232009-03-26 19:07:15 +0000222 tl_assert(0 <= (int)DRD_(g_drd_running_tid)
223 && DRD_(g_drd_running_tid) < DRD_N_THREADS
224 && DRD_(g_drd_running_tid) != DRD_INVALID_THREADID);
bart589f9482008-06-09 15:08:22 +0000225#endif
bartbedfd232009-03-26 19:07:15 +0000226 return (DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].synchr_nesting == 0
bartd45d9952009-05-31 18:53:54 +0000227 && DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].is_recording_loads);
228}
229
230static __inline__
231Bool DRD_(running_thread_is_recording_stores)(void)
232{
233#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
234 tl_assert(0 <= (int)DRD_(g_drd_running_tid)
235 && DRD_(g_drd_running_tid) < DRD_N_THREADS
236 && DRD_(g_drd_running_tid) != DRD_INVALID_THREADID);
237#endif
238 return (DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].synchr_nesting == 0
239 && DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].is_recording_stores);
bart1a473c72008-03-13 19:03:38 +0000240}
241
bart86a87df2009-03-04 19:26:47 +0000242/**
243 * Update the information about the lowest stack address that has ever been
244 * accessed by a thread.
245 */
bart08865622008-06-06 14:31:36 +0000246static __inline__
bart62a784c2009-02-15 13:11:14 +0000247void DRD_(thread_set_stack_min)(const DrdThreadId tid, const Addr stack_min)
bart1ea5fff2008-03-16 08:36:23 +0000248{
bart8b4b2ee2008-06-11 13:17:56 +0000249#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
bartbedfd232009-03-26 19:07:15 +0000250 tl_assert(0 <= (int)tid
251 && tid < DRD_N_THREADS
252 && tid != DRD_INVALID_THREADID);
bart1ea5fff2008-03-16 08:36:23 +0000253#endif
bartbedfd232009-03-26 19:07:15 +0000254 DRD_(g_threadinfo)[tid].stack_min = stack_min;
bart8b4b2ee2008-06-11 13:17:56 +0000255#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
bartbedfd232009-03-26 19:07:15 +0000256 /* This function can be called after the thread has been created but */
257 /* before drd_post_thread_create() has filled in stack_max. */
258 tl_assert(DRD_(g_threadinfo)[tid].stack_min
259 < DRD_(g_threadinfo)[tid].stack_max
260 || DRD_(g_threadinfo)[tid].stack_max == 0);
bart1ea5fff2008-03-16 08:36:23 +0000261#endif
bartbedfd232009-03-26 19:07:15 +0000262 if (UNLIKELY(stack_min < DRD_(g_threadinfo)[tid].stack_min_min))
263 {
264 DRD_(g_threadinfo)[tid].stack_min_min = stack_min;
265 }
bart1ea5fff2008-03-16 08:36:23 +0000266}
267
bart324a23b2009-02-15 12:14:52 +0000268/**
269 * Return true if and only if the specified address is on the stack of the
270 * currently scheduled thread.
bart08865622008-06-06 14:31:36 +0000271 */
272static __inline__
bart62a784c2009-02-15 13:11:14 +0000273Bool DRD_(thread_address_on_stack)(const Addr a)
bart08865622008-06-06 14:31:36 +0000274{
bartbedfd232009-03-26 19:07:15 +0000275 return (DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].stack_min <= a
276 && a < DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].stack_max);
bart08865622008-06-06 14:31:36 +0000277}
278
bart0d6d5c52009-03-10 09:22:13 +0000279/**
280 * Return true if and only if the specified address is on the stack of any
281 * thread.
282 */
283static __inline__
284Bool DRD_(thread_address_on_any_stack)(const Addr a)
285{
bartbedfd232009-03-26 19:07:15 +0000286 int i;
bart0d6d5c52009-03-10 09:22:13 +0000287
bartbedfd232009-03-26 19:07:15 +0000288 for (i = 1; i < DRD_N_THREADS; i++)
289 {
290 if (DRD_(g_threadinfo)[i].vg_thread_exists
291 && DRD_(g_threadinfo)[i].stack_min <= a
292 && a < DRD_(g_threadinfo)[i].stack_max)
293 {
294 return True;
295 }
296 }
297 return False;
bart0d6d5c52009-03-10 09:22:13 +0000298}
299
bart1a473c72008-03-13 19:03:38 +0000300/** Return a pointer to the latest segment for the specified thread. */
bart08865622008-06-06 14:31:36 +0000301static __inline__
bart62a784c2009-02-15 13:11:14 +0000302Segment* DRD_(thread_get_segment)(const DrdThreadId tid)
bart1a473c72008-03-13 19:03:38 +0000303{
bart8b4b2ee2008-06-11 13:17:56 +0000304#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
bartbedfd232009-03-26 19:07:15 +0000305 tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
306 && tid != DRD_INVALID_THREADID);
307 tl_assert(DRD_(g_threadinfo)[tid].last);
bart589f9482008-06-09 15:08:22 +0000308#endif
bartbedfd232009-03-26 19:07:15 +0000309 return DRD_(g_threadinfo)[tid].last;
bartf00a85b2008-03-13 18:49:23 +0000310}
311
barta79df6e2008-03-14 17:07:51 +0000312/** Return a pointer to the latest segment for the running thread. */
bart08865622008-06-06 14:31:36 +0000313static __inline__
bart62a784c2009-02-15 13:11:14 +0000314Segment* DRD_(running_thread_get_segment)(void)
barta79df6e2008-03-14 17:07:51 +0000315{
bartbedfd232009-03-26 19:07:15 +0000316 return DRD_(thread_get_segment)(DRD_(g_drd_running_tid));
barta79df6e2008-03-14 17:07:51 +0000317}
bartf00a85b2008-03-13 18:49:23 +0000318
bart86a87df2009-03-04 19:26:47 +0000319#endif /* __THREAD_H */