1 /* 2 This file is part of drd, a thread error detector. 3 4 Copyright (C) 2006-2013 Bart Van Assche <bvanassche@acm.org>. 5 6 This program is free software; you can redistribute it and/or 7 modify it under the terms of the GNU General Public License as 8 published by the Free Software Foundation; either version 2 of the 9 License, or (at your option) any later version. 10 11 This program is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with this program; if not, write to the Free Software 18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 19 02111-1307, USA. 20 21 The GNU General Public License is contained in the file COPYING. 22 */ 23 24 25 #ifndef __DRD_CLIENTOBJ_H 26 #define __DRD_CLIENTOBJ_H 27 28 29 #include "drd_basics.h" /* DrdThreadId */ 30 #include "drd_clientreq.h" /* MutexT */ 31 #include "pub_tool_basics.h" 32 #include "pub_tool_execontext.h" /* ExeContext */ 33 #include "pub_tool_oset.h" 34 #include "pub_tool_xarray.h" 35 36 37 /* Forward declarations. */ 38 39 union drd_clientobj; 40 41 42 /* Type definitions. */ 43 44 typedef enum { 45 ClientMutex = 1, 46 ClientCondvar = 2, 47 ClientHbvar = 3, 48 ClientSemaphore = 4, 49 ClientBarrier = 5, 50 ClientRwlock = 6, 51 } ObjType; 52 53 struct any 54 { 55 Addr a1; 56 ObjType type; 57 void (*cleanup)(union drd_clientobj*); 58 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 59 ExeContext* first_observed_at; 60 }; 61 62 struct mutex_info 63 { 64 Addr a1; 65 ObjType type; 66 void (*cleanup)(union drd_clientobj*); 67 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 68 ExeContext* first_observed_at; 69 MutexT mutex_type; // pthread_mutex_t or pthread_spinlock_t. 70 int recursion_count; // 0 if free, >= 1 if locked. 71 Bool ignore_ordering; 72 DrdThreadId owner; // owner if locked, last owner if free. 73 struct segment* last_locked_segment; 74 ULong acquiry_time_ms; 75 ExeContext* acquired_at; 76 }; 77 78 struct cond_info 79 { 80 Addr a1; 81 ObjType type; 82 void (*cleanup)(union drd_clientobj*); 83 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 84 ExeContext* first_observed_at; 85 int waiter_count; 86 Addr mutex; // Client mutex specified in pthread_cond_wait() call, and 87 // null if no client threads are currently waiting on this cond.var. 88 }; 89 90 struct hb_info 91 { 92 Addr a1; 93 ObjType type; 94 void (*cleanup)(union drd_clientobj*); 95 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 96 ExeContext* first_observed_at; 97 OSet* oset; // Per-thread order annotation information. 98 }; 99 100 struct semaphore_info 101 { 102 Addr a1; 103 ObjType type; 104 void (*cleanup)(union drd_clientobj*); 105 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 106 ExeContext* first_observed_at; 107 UInt waits_to_skip; // Number of sem_wait() calls to skip 108 // (due to the value assigned by sem_init()). 109 UInt value; // Semaphore value. 110 UWord waiters; // Number of threads inside sem_wait(). 111 DrdThreadId last_sem_post_tid; // Thread ID associated with last sem_post(). 112 XArray* last_sem_post_seg; // array of Segment*, used as a stack. 113 }; 114 115 struct barrier_info 116 { 117 Addr a1; 118 ObjType type; 119 void (*cleanup)(union drd_clientobj*); 120 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 121 ExeContext* first_observed_at; 122 BarrierT barrier_type; // pthread_barrier or gomp_barrier. 123 Word count; // Participant count in a barrier wait. 124 Word pre_iteration; // pre barrier completion count modulo two. 125 Word post_iteration; // post barrier completion count modulo two. 126 Word pre_waiters_left; // number of waiters left for a complete barrier. 127 Word post_waiters_left; // number of waiters left for a complete barrier. 128 OSet* oset[2]; // Per-thread barrier information for the latest 129 // two barrier iterations. 130 }; 131 132 struct rwlock_info 133 { 134 Addr a1; 135 ObjType type; 136 void (*cleanup)(union drd_clientobj*); 137 void (*delete_thread)(union drd_clientobj*, DrdThreadId); 138 ExeContext* first_observed_at; 139 RwLockT rwlock_type; 140 OSet* thread_info; 141 ULong acquiry_time_ms; 142 ExeContext* acquired_at; 143 }; 144 145 typedef union drd_clientobj 146 { 147 struct any any; 148 struct mutex_info mutex; 149 struct cond_info cond; 150 struct hb_info hb; 151 struct semaphore_info semaphore; 152 struct barrier_info barrier; 153 struct rwlock_info rwlock; 154 } DrdClientobj; 155 156 157 /* Function declarations. */ 158 159 void DRD_(clientobj_set_trace)(const Bool trace); 160 void DRD_(clientobj_init)(void); 161 void DRD_(clientobj_cleanup)(void); 162 DrdClientobj* DRD_(clientobj_get_any)(const Addr addr); 163 DrdClientobj* DRD_(clientobj_get)(const Addr addr, const ObjType t); 164 Bool DRD_(clientobj_present)(const Addr a1, const Addr a2); 165 DrdClientobj* DRD_(clientobj_add)(const Addr a1, const ObjType t); 166 Bool DRD_(clientobj_remove)(const Addr addr, const ObjType t); 167 void DRD_(clientobj_stop_using_mem)(const Addr a1, const Addr a2); 168 void DRD_(clientobj_delete_thread)(const DrdThreadId tid); 169 const HChar* DRD_(clientobj_type_name)(const ObjType t); 170 171 172 #endif /* __DRD_CLIENTOBJ_H */ 173