blob: 550daaf5352bcc56c0e53d786c7956ab41c28743 [file] [log] [blame]
sewardjaf44c822007-11-25 14:01:38 +00001/*
2 This file is part of drd, a data race detector.
3
sewardj85642922008-01-14 11:54:56 +00004 Copyright (C) 2006-2008 Bart Van Assche
sewardjaf44c822007-11-25 14:01:38 +00005 bart.vanassche@gmail.com
6
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
bartf00a85b2008-03-13 18:49:23 +000030// Includes.
sewardjaf44c822007-11-25 14:01:38 +000031
bartf00a85b2008-03-13 18:49:23 +000032#include "drd_segment.h"
33#include "pub_tool_libcassert.h" // tl_assert()
34#include "pub_tool_stacktrace.h" // StackTrace
35#include "pub_tool_threadstate.h" // VG_N_THREADS
36
37
38// Defines.
39
40#define DRD_N_THREADS VG_N_THREADS
sewardjaf44c822007-11-25 14:01:38 +000041
42#define DRD_INVALID_THREADID 0
43
44/* Note: the PThreadId typedef and the INVALID_POSIX_THREADID depend on the */
45/* operating system and threading library in use. PThreadId must contain at */
46/* least the same number of bits as pthread_t, and INVALID_POSIX_THREADID */
47/* must be a value that will never be returned by pthread_self(). */
48
49#define INVALID_POSIX_THREADID ((PThreadId)0)
50
51
bartf00a85b2008-03-13 18:49:23 +000052// Type definitions.
53
sewardjaf44c822007-11-25 14:01:38 +000054typedef UInt DrdThreadId;
55typedef UWord PThreadId;
56
bartf00a85b2008-03-13 18:49:23 +000057typedef struct
58{
59 Segment* first;
60 Segment* last;
61 ThreadId vg_threadid;
62 PThreadId pt_threadid;
63 Addr stack_min_min;
64 Addr stack_min;
65 Addr stack_startup;
66 Addr stack_max;
67 char name[32];
68 /// Indicates whether the Valgrind core knows about this thread.
69 Bool vg_thread_exists;
70 /// Indicates whether there is an associated POSIX thread ID.
71 Bool posix_thread_exists;
72 /// If true, indicates that there is a corresponding POSIX thread ID and
73 /// a corresponding OS thread that is detached.
74 Bool detached_posix_thread;
75 /// Wether recording of memory accesses is active.
76 Bool is_recording;
77 /// Nesting level of synchronization functions called by the client.
78 Int synchr_nesting;
79} ThreadInfo;
80
81
82// Local variables of drd_thread.c that are declared here such that these
83// can be accessed by inline functions.
84
85extern DrdThreadId s_drd_running_tid;
86extern ThreadInfo s_threadinfo[DRD_N_THREADS];
87
88
89// Function declarations.
sewardjaf44c822007-11-25 14:01:38 +000090
bart26f73e12008-02-24 18:37:08 +000091void thread_trace_context_switches(const Bool t);
92void thread_trace_danger_set(const Bool t);
sewardjaf44c822007-11-25 14:01:38 +000093Bool IsValidDrdThreadId(const DrdThreadId tid);
94
95DrdThreadId VgThreadIdToDrdThreadId(const ThreadId tid);
96DrdThreadId NewVgThreadIdToDrdThreadId(const ThreadId tid);
97DrdThreadId PtThreadIdToDrdThreadId(const PThreadId tid);
98ThreadId DrdThreadIdToVgThreadId(const DrdThreadId tid);
99DrdThreadId thread_pre_create(const DrdThreadId creator,
100 const ThreadId vg_created);
101DrdThreadId thread_post_create(const ThreadId vg_created);
102void thread_delete(const DrdThreadId tid);
103void thread_finished(const DrdThreadId tid);
104void thread_set_stack_startup(const DrdThreadId tid, const Addr stack_startup);
105Addr thread_get_stack_min(const DrdThreadId tid);
106void thread_set_stack_min(const DrdThreadId tid, const Addr stack_min);
107DrdThreadId thread_lookup_stackaddr(const Addr a,
108 Addr* const stack_min,
109 Addr* const stack_max);
110void thread_set_pthreadid(const DrdThreadId tid, const PThreadId ptid);
111Bool thread_get_joinable(const DrdThreadId tid);
112void thread_set_joinable(const DrdThreadId tid, const Bool joinable);
113const char* thread_get_name(const DrdThreadId tid);
114void thread_set_name(const DrdThreadId tid, const char* const name);
115void thread_set_name_fmt(const DrdThreadId tid, const char* const name,
116 const UWord arg);
117DrdThreadId thread_get_running_tid(void);
sewardj8b09d4f2007-12-04 21:27:18 +0000118void thread_set_vg_running_tid(const ThreadId vg_tid);
119void thread_set_running_tid(const ThreadId vg_tid,
120 const DrdThreadId drd_tid);
bart0268dfa2008-03-11 20:10:21 +0000121int thread_enter_synchr(const DrdThreadId tid);
122int thread_leave_synchr(const DrdThreadId tid);
123int thread_get_synchr_nesting_count(const DrdThreadId tid);
sewardjaf44c822007-11-25 14:01:38 +0000124Segment* thread_get_segment(const DrdThreadId tid);
125void thread_new_segment(const DrdThreadId tid);
126VectorClock* thread_get_vc(const DrdThreadId tid);
127void thread_combine_vc(const DrdThreadId joiner, const DrdThreadId joinee);
128void thread_combine_vc2(const DrdThreadId tid, const VectorClock* const vc);
129void thread_stop_using_mem(const Addr a1, const Addr a2);
bart0268dfa2008-03-11 20:10:21 +0000130void thread_start_recording(const DrdThreadId tid);
131void thread_stop_recording(const DrdThreadId tid);
sewardjaf44c822007-11-25 14:01:38 +0000132void thread_print_all(void);
133void thread_report_races(const DrdThreadId tid);
134void thread_report_races_segment(const DrdThreadId tid,
135 const Segment* const p);
136void thread_report_all_races(void);
137Bool thread_conflicting_access(Addr const a,
138 SizeT const size,
139 BmAccessTypeT access_type);
140void thread_report_conflicting_segments(const DrdThreadId tid,
141 const Addr addr,
142 const SizeT size,
143 const BmAccessTypeT access_type);
144ULong thread_get_context_switch_count(void);
145ULong thread_get_report_races_count(void);
146ULong thread_get_discard_ordered_segments_count(void);
147ULong thread_get_update_danger_set_count(void);
148ULong thread_get_danger_set_bitmap_creation_count(void);
149ULong thread_get_danger_set_bitmap2_creation_count(void);
150
151
bartf00a85b2008-03-13 18:49:23 +0000152static inline
153Bool running_thread_is_recording(void)
154{
155 tl_assert(0 <= s_drd_running_tid && s_drd_running_tid < DRD_N_THREADS
156 && s_drd_running_tid != DRD_INVALID_THREADID);
157 return (s_threadinfo[s_drd_running_tid].synchr_nesting == 0
158 && s_threadinfo[s_drd_running_tid].is_recording);
159}
160
161
sewardjaf44c822007-11-25 14:01:38 +0000162#endif // __THREAD_H