sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 1 | /* |
| 2 | This file is part of drd, a data race detector. |
| 3 | |
sewardj | 8564292 | 2008-01-14 11:54:56 +0000 | [diff] [blame] | 4 | Copyright (C) 2006-2008 Bart Van Assche |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 5 | 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 | |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 30 | // Includes. |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 31 | |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 32 | #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 |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 41 | |
| 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 | |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 52 | // Type definitions. |
| 53 | |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 54 | typedef UInt DrdThreadId; |
| 55 | typedef UWord PThreadId; |
| 56 | |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 57 | typedef struct |
| 58 | { |
bart | 1a473c7 | 2008-03-13 19:03:38 +0000 | [diff] [blame^] | 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; |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 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 | |
| 85 | extern DrdThreadId s_drd_running_tid; |
| 86 | extern ThreadInfo s_threadinfo[DRD_N_THREADS]; |
bart | 1a473c7 | 2008-03-13 19:03:38 +0000 | [diff] [blame^] | 87 | extern struct bitmap* s_danger_set; |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 88 | |
| 89 | |
| 90 | // Function declarations. |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 91 | |
bart | 26f73e1 | 2008-02-24 18:37:08 +0000 | [diff] [blame] | 92 | void thread_trace_context_switches(const Bool t); |
| 93 | void thread_trace_danger_set(const Bool t); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 94 | Bool IsValidDrdThreadId(const DrdThreadId tid); |
| 95 | |
| 96 | DrdThreadId VgThreadIdToDrdThreadId(const ThreadId tid); |
| 97 | DrdThreadId NewVgThreadIdToDrdThreadId(const ThreadId tid); |
| 98 | DrdThreadId PtThreadIdToDrdThreadId(const PThreadId tid); |
| 99 | ThreadId DrdThreadIdToVgThreadId(const DrdThreadId tid); |
| 100 | DrdThreadId thread_pre_create(const DrdThreadId creator, |
| 101 | const ThreadId vg_created); |
| 102 | DrdThreadId thread_post_create(const ThreadId vg_created); |
| 103 | void thread_delete(const DrdThreadId tid); |
| 104 | void thread_finished(const DrdThreadId tid); |
| 105 | void thread_set_stack_startup(const DrdThreadId tid, const Addr stack_startup); |
| 106 | Addr thread_get_stack_min(const DrdThreadId tid); |
| 107 | void thread_set_stack_min(const DrdThreadId tid, const Addr stack_min); |
| 108 | DrdThreadId thread_lookup_stackaddr(const Addr a, |
| 109 | Addr* const stack_min, |
| 110 | Addr* const stack_max); |
| 111 | void thread_set_pthreadid(const DrdThreadId tid, const PThreadId ptid); |
| 112 | Bool thread_get_joinable(const DrdThreadId tid); |
| 113 | void thread_set_joinable(const DrdThreadId tid, const Bool joinable); |
| 114 | const char* thread_get_name(const DrdThreadId tid); |
| 115 | void thread_set_name(const DrdThreadId tid, const char* const name); |
| 116 | void thread_set_name_fmt(const DrdThreadId tid, const char* const name, |
| 117 | const UWord arg); |
| 118 | DrdThreadId thread_get_running_tid(void); |
sewardj | 8b09d4f | 2007-12-04 21:27:18 +0000 | [diff] [blame] | 119 | void thread_set_vg_running_tid(const ThreadId vg_tid); |
| 120 | void thread_set_running_tid(const ThreadId vg_tid, |
| 121 | const DrdThreadId drd_tid); |
bart | 0268dfa | 2008-03-11 20:10:21 +0000 | [diff] [blame] | 122 | int thread_enter_synchr(const DrdThreadId tid); |
| 123 | int thread_leave_synchr(const DrdThreadId tid); |
| 124 | int thread_get_synchr_nesting_count(const DrdThreadId tid); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 125 | void thread_new_segment(const DrdThreadId tid); |
| 126 | VectorClock* thread_get_vc(const DrdThreadId tid); |
| 127 | void thread_combine_vc(const DrdThreadId joiner, const DrdThreadId joinee); |
| 128 | void thread_combine_vc2(const DrdThreadId tid, const VectorClock* const vc); |
| 129 | void thread_stop_using_mem(const Addr a1, const Addr a2); |
bart | 0268dfa | 2008-03-11 20:10:21 +0000 | [diff] [blame] | 130 | void thread_start_recording(const DrdThreadId tid); |
| 131 | void thread_stop_recording(const DrdThreadId tid); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 132 | void thread_print_all(void); |
| 133 | void thread_report_races(const DrdThreadId tid); |
| 134 | void thread_report_races_segment(const DrdThreadId tid, |
| 135 | const Segment* const p); |
| 136 | void thread_report_all_races(void); |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 137 | void thread_report_conflicting_segments(const DrdThreadId tid, |
| 138 | const Addr addr, |
| 139 | const SizeT size, |
| 140 | const BmAccessTypeT access_type); |
| 141 | ULong thread_get_context_switch_count(void); |
| 142 | ULong thread_get_report_races_count(void); |
| 143 | ULong thread_get_discard_ordered_segments_count(void); |
| 144 | ULong thread_get_update_danger_set_count(void); |
| 145 | ULong thread_get_danger_set_bitmap_creation_count(void); |
| 146 | ULong thread_get_danger_set_bitmap2_creation_count(void); |
| 147 | |
| 148 | |
bart | 1a473c7 | 2008-03-13 19:03:38 +0000 | [diff] [blame^] | 149 | static |
| 150 | inline struct bitmap* thread_get_danger_set(void) |
| 151 | { |
| 152 | return s_danger_set; |
| 153 | } |
| 154 | |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 155 | static inline |
| 156 | Bool running_thread_is_recording(void) |
| 157 | { |
bart | 1a473c7 | 2008-03-13 19:03:38 +0000 | [diff] [blame^] | 158 | tl_assert(0 <= s_drd_running_tid && s_drd_running_tid < DRD_N_THREADS |
| 159 | && s_drd_running_tid != DRD_INVALID_THREADID); |
| 160 | return (s_threadinfo[s_drd_running_tid].synchr_nesting == 0 |
| 161 | && s_threadinfo[s_drd_running_tid].is_recording); |
| 162 | } |
| 163 | |
| 164 | /** Return a pointer to the latest segment for the specified thread. */ |
| 165 | static inline |
| 166 | Segment* thread_get_segment(const DrdThreadId tid) |
| 167 | { |
| 168 | tl_assert(0 <= tid && tid < DRD_N_THREADS |
| 169 | && tid != DRD_INVALID_THREADID); |
| 170 | tl_assert(s_threadinfo[tid].last); |
| 171 | return s_threadinfo[tid].last; |
bart | f00a85b | 2008-03-13 18:49:23 +0000 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | |
sewardj | af44c82 | 2007-11-25 14:01:38 +0000 | [diff] [blame] | 175 | #endif // __THREAD_H |