- Added more comments.
- Removed DRD_() wrapper from around local functions and variables.
- Removed some obsolete code.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@9320 a5019735-40e9-0310-863c-91ae7b9d1cf9
diff --git a/drd/drd_thread.c b/drd/drd_thread.c
index 5a8b130..7d5134a 100644
--- a/drd/drd_thread.c
+++ b/drd/drd_thread.c
@@ -47,68 +47,72 @@
/* Local functions. */
-static void DRD_(thread_append_segment)(const DrdThreadId tid,
- Segment* const sg);
-static void DRD_(thread_discard_segment)(const DrdThreadId tid,
- Segment* const sg);
-static Bool DRD_(thread_conflict_set_up_to_date)(const DrdThreadId tid);
-static void DRD_(thread_compute_conflict_set)(struct bitmap** conflict_set,
- const DrdThreadId tid);
+static void thread_append_segment(const DrdThreadId tid, Segment* const sg);
+static void thread_discard_segment(const DrdThreadId tid, Segment* const sg);
+static void thread_compute_conflict_set(struct bitmap** conflict_set,
+ const DrdThreadId tid);
/* Local variables. */
-static ULong DRD_(s_context_switch_count);
-static ULong DRD_(s_discard_ordered_segments_count);
-static ULong DRD_(s_update_conflict_set_count);
-static ULong DRD_(s_conflict_set_new_segment_count);
-static ULong DRD_(s_conflict_set_combine_vc_count);
-static ULong DRD_(s_conflict_set_bitmap_creation_count);
-static ULong DRD_(s_conflict_set_bitmap2_creation_count);
-static ThreadId DRD_(s_vg_running_tid) = VG_INVALID_THREADID;
+static ULong s_context_switch_count;
+static ULong s_discard_ordered_segments_count;
+static ULong s_update_conflict_set_count;
+static ULong s_conflict_set_new_segment_count;
+static ULong s_conflict_set_combine_vc_count;
+static ULong s_conflict_set_bitmap_creation_count;
+static ULong s_conflict_set_bitmap2_creation_count;
+static ThreadId s_vg_running_tid = VG_INVALID_THREADID;
DrdThreadId DRD_(g_drd_running_tid) = DRD_INVALID_THREADID;
ThreadInfo DRD_(g_threadinfo)[DRD_N_THREADS];
struct bitmap* DRD_(g_conflict_set);
-static Bool DRD_(s_trace_context_switches) = False;
-static Bool DRD_(s_trace_conflict_set) = False;
-static Bool DRD_(s_trace_fork_join) = False;
-static Bool DRD_(s_segment_merging) = True;
+static Bool s_trace_context_switches = False;
+static Bool s_trace_conflict_set = False;
+static Bool s_trace_fork_join = False;
+static Bool s_segment_merging = True;
/* Function definitions. */
+/** Enables/disables context switch tracing. */
void DRD_(thread_trace_context_switches)(const Bool t)
{
tl_assert(t == False || t == True);
- DRD_(s_trace_context_switches) = t;
+ s_trace_context_switches = t;
}
+/** Enables/disables conflict set tracing. */
void DRD_(thread_trace_conflict_set)(const Bool t)
{
tl_assert(t == False || t == True);
- DRD_(s_trace_conflict_set) = t;
+ s_trace_conflict_set = t;
}
+/** Report whether fork/join tracing is enabled. */
Bool DRD_(thread_get_trace_fork_join)(void)
{
- return DRD_(s_trace_fork_join);
+ return s_trace_fork_join;
}
+/** Enables/disables fork/join tracing. */
void DRD_(thread_set_trace_fork_join)(const Bool t)
{
tl_assert(t == False || t == True);
- DRD_(s_trace_fork_join) = t;
+ s_trace_fork_join = t;
}
+/** Enables/disables segment merging. */
void DRD_(thread_set_segment_merging)(const Bool m)
{
tl_assert(m == False || m == True);
- DRD_(s_segment_merging) = m;
+ s_segment_merging = m;
}
/**
- * Convert Valgrind's ThreadId into a DrdThreadId. Report failure if
- * Valgrind's ThreadId does not yet exist.
+ * Convert Valgrind's ThreadId into a DrdThreadId.
+ *
+ * @return DRD thread ID upon success and DRD_INVALID_THREADID if the passed
+ * Valgrind ThreadId does not yet exist.
*/
DrdThreadId DRD_(VgThreadIdToDrdThreadId)(const ThreadId tid)
{
@@ -129,6 +133,7 @@
return DRD_INVALID_THREADID;
}
+/** Allocate a new DRD thread ID for the specified Valgrind thread ID. */
static DrdThreadId DRD_(VgThreadIdToNewDrdThreadId)(const ThreadId tid)
{
int i;
@@ -141,6 +146,8 @@
&& DRD_(g_threadinfo)[i].posix_thread_exists == False
&& DRD_(g_threadinfo)[i].detached_posix_thread == False)
{
+ tl_assert(! DRD_(IsValidDrdThreadId)(i));
+
DRD_(g_threadinfo)[i].vg_thread_exists = True;
DRD_(g_threadinfo)[i].vg_threadid = tid;
DRD_(g_threadinfo)[i].pt_threadid = INVALID_POSIX_THREADID;
@@ -150,10 +157,11 @@
DRD_(g_threadinfo)[i].stack_max = 0;
DRD_(g_threadinfo)[i].is_recording = True;
DRD_(g_threadinfo)[i].synchr_nesting = 0;
- if (DRD_(g_threadinfo)[i].first != 0)
- VG_(printf)("drd thread id = %d\n", i);
tl_assert(DRD_(g_threadinfo)[i].first == 0);
tl_assert(DRD_(g_threadinfo)[i].last == 0);
+
+ tl_assert(DRD_(IsValidDrdThreadId)(i));
+
return i;
}
}
@@ -163,6 +171,7 @@
return DRD_INVALID_THREADID;
}
+/** Convert a POSIX thread ID into a DRD thread ID. */
DrdThreadId DRD_(PtThreadIdToDrdThreadId)(const PThreadId tid)
{
int i;
@@ -180,6 +189,7 @@
return DRD_INVALID_THREADID;
}
+/** Convert a DRD thread ID into a Valgrind thread ID. */
ThreadId DRD_(DrdThreadIdToVgThreadId)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -221,6 +231,11 @@
* VG_(track_pre_thread_ll_create)(). The Valgrind core invokes this handler
* from the context of the creator thread, before the new thread has been
* created.
+ *
+ * @param[in] creator DRD thread ID of the creator thread.
+ * @param[in] vg_created Valgrind thread ID of the created thread.
+ *
+ * @return DRD thread ID of the created thread.
*/
DrdThreadId DRD_(thread_pre_create)(const DrdThreadId creator,
const ThreadId vg_created)
@@ -234,16 +249,20 @@
tl_assert(DRD_(g_threadinfo)[created].first == 0);
tl_assert(DRD_(g_threadinfo)[created].last == 0);
- DRD_(thread_append_segment)(created, DRD_(sg_new)(creator, created));
+ thread_append_segment(created, DRD_(sg_new)(creator, created));
return created;
}
/**
- * Initialize DRD_(g_threadinfo)[] for a newly created thread. Must be called after
- * the thread has been created and before any client instructioins are run
+ * Initialize DRD_(g_threadinfo)[] for a newly created thread. Must be called
+ * after the thread has been created and before any client instructions are run
* on the newly created thread, e.g. from the handler installed via
* VG_(track_pre_thread_first_insn)().
+ *
+ * @param[in] vg_created Valgrind thread ID of the newly created thread.
+ *
+ * @return DRD thread ID for the new thread.
*/
DrdThreadId DRD_(thread_post_create)(const ThreadId vg_created)
{
@@ -274,7 +293,7 @@
DRD_(thread_combine_vc)(drd_joiner, drd_joinee);
DRD_(thread_new_segment)(drd_joiner);
- if (DRD_(s_trace_fork_join))
+ if (s_trace_fork_join)
{
const ThreadId joiner = DRD_(DrdThreadIdToVgThreadId)(drd_joiner);
const ThreadId joinee = DRD_(DrdThreadIdToVgThreadId)(drd_joinee);
@@ -323,6 +342,7 @@
DRD_(g_threadinfo)[tid].stack_startup = stack_startup;
}
+/** Return the stack pointer for the specified thread. */
Addr DRD_(thread_get_stack_min)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -330,6 +350,10 @@
return DRD_(g_threadinfo)[tid].stack_min;
}
+/**
+ * Return the lowest value that was ever assigned to the stack pointer
+ * for the specified thread.
+ */
Addr DRD_(thread_get_stack_min_min)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -337,6 +361,7 @@
return DRD_(g_threadinfo)[tid].stack_min_min;
}
+/** Return the top address for the stack of the specified thread. */
Addr DRD_(thread_get_stack_max)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -344,6 +369,7 @@
return DRD_(g_threadinfo)[tid].stack_max;
}
+/** Return the maximum stack size for the specified thread. */
SizeT DRD_(thread_get_stack_size)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -360,8 +386,8 @@
Segment* sg;
Segment* sg_prev;
- tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
- && tid != DRD_INVALID_THREADID);
+ tl_assert(DRD_(IsValidDrdThreadId)(tid));
+
tl_assert(DRD_(g_threadinfo)[tid].synchr_nesting >= 0);
for (sg = DRD_(g_threadinfo)[tid].last; sg; sg = sg_prev)
{
@@ -375,6 +401,8 @@
tl_assert(DRD_(g_threadinfo)[tid].detached_posix_thread == False);
DRD_(g_threadinfo)[tid].first = 0;
DRD_(g_threadinfo)[tid].last = 0;
+
+ tl_assert(! DRD_(IsValidDrdThreadId)(tid));
}
/**
@@ -413,6 +441,7 @@
DRD_(g_threadinfo)[tid].synchr_nesting = 0;
}
+/** Store the POSIX thread ID for the specified thread. */
void DRD_(thread_set_pthreadid)(const DrdThreadId tid, const PThreadId ptid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -423,6 +452,7 @@
DRD_(g_threadinfo)[tid].pt_threadid = ptid;
}
+/** Returns true for joinable threads and false for detached threads. */
Bool DRD_(thread_get_joinable)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -430,6 +460,7 @@
return ! DRD_(g_threadinfo)[tid].detached_posix_thread;
}
+/** Store the thread mode: joinable or detached. */
void DRD_(thread_set_joinable)(const DrdThreadId tid, const Bool joinable)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -446,54 +477,70 @@
DRD_(g_threadinfo)[tid].detached_posix_thread = ! joinable;
}
+/**
+ * Update s_vg_running_tid, DRD_(g_drd_running_tid) and recalculate the
+ * conflict set.
+ */
void DRD_(thread_set_vg_running_tid)(const ThreadId vg_tid)
{
tl_assert(vg_tid != VG_INVALID_THREADID);
- if (vg_tid != DRD_(s_vg_running_tid))
+ if (vg_tid != s_vg_running_tid)
{
DRD_(thread_set_running_tid)(vg_tid,
DRD_(VgThreadIdToDrdThreadId)(vg_tid));
}
- tl_assert(DRD_(s_vg_running_tid) != VG_INVALID_THREADID);
+ tl_assert(s_vg_running_tid != VG_INVALID_THREADID);
tl_assert(DRD_(g_drd_running_tid) != DRD_INVALID_THREADID);
}
+/**
+ * Update s_vg_running_tid, DRD_(g_drd_running_tid) and recalculate the
+ * conflict set.
+ */
void DRD_(thread_set_running_tid)(const ThreadId vg_tid,
const DrdThreadId drd_tid)
{
tl_assert(vg_tid != VG_INVALID_THREADID);
tl_assert(drd_tid != DRD_INVALID_THREADID);
- if (vg_tid != DRD_(s_vg_running_tid))
+ if (vg_tid != s_vg_running_tid)
{
- if (DRD_(s_trace_context_switches)
+ if (s_trace_context_switches
&& DRD_(g_drd_running_tid) != DRD_INVALID_THREADID)
{
VG_(message)(Vg_DebugMsg,
"Context switch from thread %d/%d to thread %d/%d;"
" segments: %llu",
- DRD_(s_vg_running_tid), DRD_(g_drd_running_tid),
+ s_vg_running_tid, DRD_(g_drd_running_tid),
DRD_(DrdThreadIdToVgThreadId)(drd_tid), drd_tid,
DRD_(sg_get_segments_alive_count)());
}
- DRD_(s_vg_running_tid) = vg_tid;
+ s_vg_running_tid = vg_tid;
DRD_(g_drd_running_tid) = drd_tid;
- DRD_(thread_compute_conflict_set)(&DRD_(g_conflict_set), drd_tid);
- DRD_(s_context_switch_count)++;
+ thread_compute_conflict_set(&DRD_(g_conflict_set), drd_tid);
+ s_context_switch_count++;
}
- tl_assert(DRD_(s_vg_running_tid) != VG_INVALID_THREADID);
+ tl_assert(s_vg_running_tid != VG_INVALID_THREADID);
tl_assert(DRD_(g_drd_running_tid) != DRD_INVALID_THREADID);
}
+/**
+ * Increase the synchronization nesting counter. Must be called before the
+ * client calls a synchronization function.
+ */
int DRD_(thread_enter_synchr)(const DrdThreadId tid)
{
tl_assert(DRD_(IsValidDrdThreadId)(tid));
return DRD_(g_threadinfo)[tid].synchr_nesting++;
}
+/**
+ * Decrease the synchronization nesting counter. Must be called after the
+ * client left a synchronization function.
+ */
int DRD_(thread_leave_synchr)(const DrdThreadId tid)
{
tl_assert(DRD_(IsValidDrdThreadId)(tid));
@@ -501,6 +548,7 @@
return --DRD_(g_threadinfo)[tid].synchr_nesting;
}
+/** Returns the synchronization nesting counter. */
int DRD_(thread_get_synchr_nesting_count)(const DrdThreadId tid)
{
tl_assert(DRD_(IsValidDrdThreadId)(tid));
@@ -509,7 +557,7 @@
/** Append a new segment at the end of the segment list. */
static
-void DRD_(thread_append_segment)(const DrdThreadId tid, Segment* const sg)
+void thread_append_segment(const DrdThreadId tid, Segment* const sg)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
&& tid != DRD_INVALID_THREADID);
@@ -529,7 +577,7 @@
* associated memory.
*/
static
-void DRD_(thread_discard_segment)(const DrdThreadId tid, Segment* const sg)
+void thread_discard_segment(const DrdThreadId tid, Segment* const sg)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
&& tid != DRD_INVALID_THREADID);
@@ -548,6 +596,10 @@
//tl_assert(DRD_(sane_ThreadInfo)(&DRD_(g_threadinfo)[tid]));
}
+/**
+ * Returns a pointer to the vector clock of the most recent segment associated
+ * with thread 'tid'.
+ */
VectorClock* DRD_(thread_get_vc)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -573,6 +625,7 @@
/**
* Compute the minimum of all latest vector clocks of all threads
* (Michiel Ronsse calls this "clock snooping" in his papers about DIOTA).
+ *
* @param vc pointer to a vectorclock, holds result upon return.
*/
static void DRD_(thread_compute_minimum_vc)(VectorClock* vc)
@@ -597,6 +650,11 @@
}
}
+/**
+ * Compute the maximum of all latest vector clocks of all threads.
+ *
+ * @param vc pointer to a vectorclock, holds result upon return.
+ */
static void DRD_(thread_compute_maximum_vc)(VectorClock* vc)
{
unsigned i;
@@ -621,7 +679,7 @@
/**
* Discard all segments that have a defined order against the latest vector
- * clock of every thread -- these segments can no longer be involved in a
+ * clock of all threads -- these segments can no longer be involved in a
* data race.
*/
static void DRD_(thread_discard_ordered_segments)(void)
@@ -629,7 +687,7 @@
unsigned i;
VectorClock thread_vc_min;
- DRD_(s_discard_ordered_segments_count)++;
+ s_discard_ordered_segments_count++;
DRD_(vc_init)(&thread_vc_min, 0, 0);
DRD_(thread_compute_minimum_vc)(&thread_vc_min);
@@ -661,7 +719,7 @@
sg && (sg_next = sg->next) && DRD_(vc_lte)(&sg->vc, &thread_vc_min);
sg = sg_next)
{
- DRD_(thread_discard_segment)(i, sg);
+ thread_discard_segment(i, sg);
}
}
DRD_(vc_cleanup)(&thread_vc_min);
@@ -696,7 +754,7 @@
{
/* Merge sg and sg->next into sg. */
DRD_(sg_merge)(sg, sg->next);
- DRD_(thread_discard_segment)(i, sg->next);
+ thread_discard_segment(i, sg->next);
}
}
@@ -705,75 +763,6 @@
}
/**
- * Every change in the vector clock of a thread may cause segments that
- * were previously ordered to this thread to become unordered. Hence,
- * it may be necessary to recalculate the conflict set if the vector clock
- * of the current thread is updated. This function check whether such a
- * recalculation is necessary.
- *
- * @param tid Thread ID of the thread to which a new segment has been
- * appended.
- * @param new_sg Pointer to the most recent segment of thread tid.
- */
-static Bool conflict_set_update_needed(const DrdThreadId tid,
- const Segment* const new_sg)
-{
-#if 0
- unsigned i;
- const Segment* old_sg;
-
- tl_assert(new_sg);
-
- /* If a new segment was added to another thread than the running thread, */
- /* just tell the caller to update the conflict set. */
- if (tid != DRD_(g_drd_running_tid))
- return True;
-
- /* Always let the caller update the conflict set after creation of the */
- /* first segment. */
- old_sg = new_sg->prev;
- if (old_sg == 0)
- return True;
-
- for (i = 0; i < sizeof(DRD_(g_threadinfo)) / sizeof(DRD_(g_threadinfo)[0]);
- i++)
- {
- Segment* q;
-
- if (i == DRD_(g_drd_running_tid))
- continue;
-
- for (q = DRD_(g_threadinfo)[i].last; q; q = q->prev)
- {
- /* If the expression below evaluates to false, this expression will */
- /* also evaluate to false for all subsequent iterations. So stop */
- /* iterating. */
- if (DRD_(vc_lte)(&q->vc, &old_sg->vc))
- break;
- /* If the vector clock of the 2nd the last segment is not ordered */
- /* to the vector clock of segment q, and the last segment is, ask */
- /* the caller to update the conflict set. */
- if (! DRD_(vc_lte)(&old_sg->vc, &q->vc))
- {
- return True;
- }
- /* If the vector clock of the last segment is not ordered to the */
- /* vector clock of segment q, ask the caller to update the conflict */
- /* set. */
- if (! DRD_(vc_lte)(&q->vc, &new_sg->vc) && ! DRD_(vc_lte)(&new_sg->vc, &q->vc))
- {
- return True;
- }
- }
- }
-
- return False;
-#else
- return True;
-#endif
-}
-
-/**
* Create a new segment for the specified thread, and discard any segments
* that cannot cause races anymore.
*/
@@ -785,22 +774,14 @@
&& tid != DRD_INVALID_THREADID);
new_sg = DRD_(sg_new)(tid, tid);
- DRD_(thread_append_segment)(tid, new_sg);
+ thread_append_segment(tid, new_sg);
- if (conflict_set_update_needed(tid, new_sg))
- {
- DRD_(thread_compute_conflict_set)(&DRD_(g_conflict_set),
- DRD_(g_drd_running_tid));
- DRD_(s_conflict_set_new_segment_count)++;
- }
- else if (tid == DRD_(g_drd_running_tid))
- {
- tl_assert(DRD_(thread_conflict_set_up_to_date)(DRD_(g_drd_running_tid)));
- }
+ thread_compute_conflict_set(&DRD_(g_conflict_set), DRD_(g_drd_running_tid));
+ s_conflict_set_new_segment_count++;
DRD_(thread_discard_ordered_segments)();
- if (DRD_(s_segment_merging))
+ if (s_segment_merging)
{
thread_merge_segments();
}
@@ -822,7 +803,7 @@
if (joiner == DRD_(g_drd_running_tid))
{
- DRD_(thread_compute_conflict_set)(&DRD_(g_conflict_set), joiner);
+ thread_compute_conflict_set(&DRD_(g_conflict_set), joiner);
}
}
@@ -838,9 +819,9 @@
tl_assert(DRD_(g_threadinfo)[tid].last);
tl_assert(vc);
DRD_(vc_combine)(&DRD_(g_threadinfo)[tid].last->vc, vc);
- DRD_(thread_compute_conflict_set)(&DRD_(g_conflict_set), tid);
+ thread_compute_conflict_set(&DRD_(g_conflict_set), tid);
DRD_(thread_discard_ordered_segments)();
- DRD_(s_conflict_set_combine_vc_count)++;
+ s_conflict_set_combine_vc_count++;
}
/**
@@ -881,11 +862,12 @@
if (other_user != DRD_INVALID_THREADID
&& DRD_(bm_has_any_access)(DRD_(g_conflict_set), a1, a2))
{
- DRD_(thread_compute_conflict_set)(&DRD_(g_conflict_set),
+ thread_compute_conflict_set(&DRD_(g_conflict_set),
DRD_(thread_get_running_tid)());
}
}
+/** Start recording memory access information. */
void DRD_(thread_start_recording)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -894,6 +876,7 @@
DRD_(g_threadinfo)[tid].is_recording = True;
}
+/** Stop recording memory access information. */
void DRD_(thread_stop_recording)(const DrdThreadId tid)
{
tl_assert(0 <= (int)tid && tid < DRD_N_THREADS
@@ -902,6 +885,11 @@
DRD_(g_threadinfo)[tid].is_recording = False;
}
+/**
+ * Print the segment information for all threads.
+ *
+ * This function is only used for debugging purposes.
+ */
void DRD_(thread_print_all)(void)
{
unsigned i;
@@ -929,6 +917,7 @@
}
}
+/** Show a call stack involved in a data race. */
static void show_call_stack(const DrdThreadId tid,
const Char* const msg,
ExeContext* const callstack)
@@ -955,6 +944,7 @@
}
}
+/** Print information about the segments involved in a data race. */
static void
thread_report_conflicting_segments_segment(const DrdThreadId tid,
const Addr addr,
@@ -1001,6 +991,7 @@
}
}
+/** Print information about all segments involved in a data race. */
void DRD_(thread_report_conflicting_segments)(const DrdThreadId tid,
const Addr addr,
const SizeT size,
@@ -1022,35 +1013,11 @@
}
/**
- * Verify whether the conflict set for thread tid is up to date. Only perform
- * the check if the environment variable DRD_VERIFY_CONFLICT_SET has been set.
- */
-static Bool DRD_(thread_conflict_set_up_to_date)(const DrdThreadId tid)
-{
- static int do_verify_conflict_set = -1;
- Bool result;
- struct bitmap* computed_conflict_set = 0;
-
- if (do_verify_conflict_set < 0)
- {
- //VG_(message)(Vg_DebugMsg, "%s", VG_(getenv)("DRD_VERIFY_CONFLICT_SET"));
- do_verify_conflict_set = VG_(getenv)("DRD_VERIFY_CONFLICT_SET") != 0;
- }
- if (do_verify_conflict_set == 0)
- return True;
-
- DRD_(thread_compute_conflict_set)(&computed_conflict_set, tid);
- result = DRD_(bm_equal)(DRD_(g_conflict_set), computed_conflict_set);
- DRD_(bm_delete)(computed_conflict_set);
- return result;
-}
-
-/**
* Compute a bitmap that represents the union of all memory accesses of all
* segments that are unordered to the current segment of the thread tid.
*/
-static void DRD_(thread_compute_conflict_set)(struct bitmap** conflict_set,
- const DrdThreadId tid)
+static void thread_compute_conflict_set(struct bitmap** conflict_set,
+ const DrdThreadId tid)
{
Segment* p;
@@ -1058,9 +1025,9 @@
&& tid != DRD_INVALID_THREADID);
tl_assert(tid == DRD_(g_drd_running_tid));
- DRD_(s_update_conflict_set_count)++;
- DRD_(s_conflict_set_bitmap_creation_count) -= DRD_(bm_get_bitmap_creation_count)();
- DRD_(s_conflict_set_bitmap2_creation_count) -= DRD_(bm_get_bitmap2_creation_count)();
+ s_update_conflict_set_count++;
+ s_conflict_set_bitmap_creation_count -= DRD_(bm_get_bitmap_creation_count)();
+ s_conflict_set_bitmap2_creation_count -= DRD_(bm_get_bitmap2_creation_count)();
if (*conflict_set)
{
@@ -1068,7 +1035,7 @@
}
*conflict_set = DRD_(bm_new)();
- if (DRD_(s_trace_conflict_set))
+ if (s_trace_conflict_set)
{
char msg[256];
@@ -1085,7 +1052,7 @@
{
unsigned j;
- if (DRD_(s_trace_conflict_set))
+ if (s_trace_conflict_set)
{
char msg[256];
@@ -1107,7 +1074,7 @@
{
if (! DRD_(vc_lte)(&q->vc, &p->vc) && ! DRD_(vc_lte)(&p->vc, &q->vc))
{
- if (DRD_(s_trace_conflict_set))
+ if (s_trace_conflict_set)
{
char msg[256];
VG_(snprintf)(msg, sizeof(msg),
@@ -1121,7 +1088,7 @@
}
else
{
- if (DRD_(s_trace_conflict_set))
+ if (s_trace_conflict_set)
{
char msg[256];
VG_(snprintf)(msg, sizeof(msg),
@@ -1137,10 +1104,10 @@
}
}
- DRD_(s_conflict_set_bitmap_creation_count) += DRD_(bm_get_bitmap_creation_count)();
- DRD_(s_conflict_set_bitmap2_creation_count) += DRD_(bm_get_bitmap2_creation_count)();
+ s_conflict_set_bitmap_creation_count += DRD_(bm_get_bitmap_creation_count)();
+ s_conflict_set_bitmap2_creation_count += DRD_(bm_get_bitmap2_creation_count)();
- if (0 && DRD_(s_trace_conflict_set))
+ if (0 && s_trace_conflict_set)
{
VG_(message)(Vg_UserMsg, "[%d] new conflict set:", tid);
DRD_(bm_print)(*conflict_set);
@@ -1148,31 +1115,42 @@
}
}
+/** Report the number of context switches performed. */
ULong DRD_(thread_get_context_switch_count)(void)
{
- return DRD_(s_context_switch_count);
+ return s_context_switch_count;
}
+/** Report the number of ordered segments that have been discarded. */
ULong DRD_(thread_get_discard_ordered_segments_count)(void)
{
- return DRD_(s_discard_ordered_segments_count);
+ return s_discard_ordered_segments_count;
}
+/** Return how many times the conflict set has been updated. */
ULong DRD_(thread_get_update_conflict_set_count)(ULong* dsnsc, ULong* dscvc)
{
tl_assert(dsnsc);
tl_assert(dscvc);
- *dsnsc = DRD_(s_conflict_set_new_segment_count);
- *dscvc = DRD_(s_conflict_set_combine_vc_count);
- return DRD_(s_update_conflict_set_count);
+ *dsnsc = s_conflict_set_new_segment_count;
+ *dscvc = s_conflict_set_combine_vc_count;
+ return s_update_conflict_set_count;
}
+/**
+ * Return the number of first-level bitmaps that have been created during
+ * conflict set updates.
+ */
ULong DRD_(thread_get_conflict_set_bitmap_creation_count)(void)
{
- return DRD_(s_conflict_set_bitmap_creation_count);
+ return s_conflict_set_bitmap_creation_count;
}
+/**
+ * Return the number of second-level bitmaps that have been created during
+ * conflict set updates.
+ */
ULong DRD_(thread_get_conflict_set_bitmap2_creation_count)(void)
{
- return DRD_(s_conflict_set_bitmap2_creation_count);
+ return s_conflict_set_bitmap2_creation_count;
}
diff --git a/drd/drd_thread.h b/drd/drd_thread.h
index 07e9dc4..919ca92 100644
--- a/drd/drd_thread.h
+++ b/drd/drd_thread.h
@@ -31,35 +31,45 @@
#include "drd_basics.h"
#include "drd_segment.h"
#include "pub_drd_bitmap.h"
-#include "pub_tool_libcassert.h" // tl_assert()
-#include "pub_tool_stacktrace.h" // StackTrace
-#include "pub_tool_threadstate.h" // VG_N_THREADS
+#include "pub_tool_libcassert.h" /* tl_assert() */
+#include "pub_tool_stacktrace.h" /* typedef StackTrace */
+#include "pub_tool_threadstate.h" /* VG_N_THREADS */
/* Defines. */
+/** Maximum number of threads DRD keeps information about. */
#define DRD_N_THREADS VG_N_THREADS
+/** A number different from any valid DRD thread ID. */
#define DRD_INVALID_THREADID 0
-/* Note: the PThreadId typedef and the INVALID_POSIX_THREADID depend on the */
-/* operating system and threading library in use. PThreadId must contain at */
-/* least the same number of bits as pthread_t, and INVALID_POSIX_THREADID */
-/* must be a value that will never be returned by pthread_self(). */
-
+/**
+ * A number different from any valid POSIX thread ID.
+ *
+ * @note The PThreadId typedef and the INVALID_POSIX_THREADID depend on the
+ * operating system and threading library in use. PThreadId must contain at
+ * least as many bits as pthread_t, and INVALID_POSIX_THREADID
+ * must be a value that will never be returned by pthread_self().
+ */
#define INVALID_POSIX_THREADID ((PThreadId)0)
/* Type definitions. */
+/**
+ * POSIX thread ID. The type PThreadId must be at least as wide as
+ * pthread_t.
+ */
typedef UWord PThreadId;
+/** Per-thread information managed by DRD. */
typedef struct
{
- Segment* first;
- Segment* last;
- ThreadId vg_threadid;
- PThreadId pt_threadid;
+ Segment* first; /**< Pointer to first segment. */
+ Segment* last; /**< Pointer to last segment. */
+ ThreadId vg_threadid; /**< Valgrind thread ID. */
+ PThreadId pt_threadid; /**< POSIX thread ID. */
Addr stack_min_min; /**< Lowest value stack pointer ever had. */
Addr stack_min; /**< Current stack pointer. */
Addr stack_startup; /**<Stack pointer after pthread_create() finished.*/
@@ -86,8 +96,15 @@
* can be accessed by inline functions.
*/
+/**
+ * DRD thread ID of the currently running thread. It is crucial for correct
+ * operation of DRD that this number is always in sync with
+ * VG_(get_running_tid)().
+ */
extern DrdThreadId DRD_(g_drd_running_tid);
+/** Per-thread information managed by DRD. */
extern ThreadInfo DRD_(g_threadinfo)[DRD_N_THREADS];
+/** Conflict set for the currently running thread. */
extern struct bitmap* DRD_(g_conflict_set);
@@ -152,6 +169,15 @@
/* Inline function definitions. */
+/**
+ * Whether or not the specified DRD thread ID is valid.
+ *
+ * A DRD thread ID is valid if and only if the following conditions are met:
+ * - The ID is a valid index of the DRD_(g_threadinfo)[] array.
+ * - The ID is not equal to DRD_INVALID_THREADID.
+ * - The ID refers either to a thread known by the Valgrind core, a joinable
+ * thread that has not yet been joined or a detached thread.
+ */
static __inline__
Bool DRD_(IsValidDrdThreadId)(const DrdThreadId tid)
{
@@ -161,6 +187,7 @@
&& DRD_(g_threadinfo)[tid].detached_posix_thread == False));
}
+/** Returns the DRD thread ID of the currently running thread. */
static __inline__
DrdThreadId DRD_(thread_get_running_tid)(void)
{
@@ -168,12 +195,17 @@
return DRD_(g_drd_running_tid);
}
+/** Returns a pointer to the conflict set for the currently running thread. */
static __inline__
struct bitmap* DRD_(thread_get_conflict_set)(void)
{
return DRD_(g_conflict_set);
}
+/**
+ * Reports whether or not memory access recording is enabled for the
+ * currently running thread.
+ */
static __inline__
Bool DRD_(running_thread_is_recording)(void)
{
@@ -185,6 +217,10 @@
&& DRD_(g_threadinfo)[DRD_(g_drd_running_tid)].is_recording);
}
+/**
+ * Update the information about the lowest stack address that has ever been
+ * accessed by a thread.
+ */
static __inline__
void DRD_(thread_set_stack_min)(const DrdThreadId tid, const Addr stack_min)
{
@@ -236,4 +272,4 @@
return DRD_(thread_get_segment)(DRD_(g_drd_running_tid));
}
-#endif // __THREAD_H
+#endif /* __THREAD_H */