bart | 922304f | 2011-03-13 12:02:44 +0000 | [diff] [blame] | 1 | /* -*- mode: C; c-basic-offset: 3; indent-tabs-mode: nil; -*- */ |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 2 | /* |
bart | 86562bd | 2009-02-16 19:43:56 +0000 | [diff] [blame] | 3 | This file is part of drd, a thread error detector. |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 4 | |
bart | 922304f | 2011-03-13 12:02:44 +0000 | [diff] [blame] | 5 | Copyright (C) 2006-2011 Bart Van Assche <bvanassche@acm.org>. |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 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 | #include "drd_clientobj.h" |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 27 | #include "drd_error.h" |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 28 | #include "drd_suppression.h" |
| 29 | #include "pub_tool_basics.h" |
| 30 | #include "pub_tool_libcassert.h" |
| 31 | #include "pub_tool_libcbase.h" |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 32 | #include "pub_tool_libcprint.h" // VG_(message)() |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 33 | #include "pub_tool_mallocfree.h" |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 34 | #include "pub_tool_options.h" // VG_(clo_backtrace_size) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 35 | #include "pub_tool_oset.h" |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 36 | #include "pub_tool_stacktrace.h" |
| 37 | #include "pub_tool_threadstate.h" // VG_(get_running_tid)() |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 38 | |
| 39 | |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 40 | /* Local variables. */ |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 41 | |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 42 | static OSet* s_clientobj_set; |
| 43 | static Bool s_trace_clientobj; |
| 44 | |
| 45 | |
| 46 | /* Local functions. */ |
| 47 | |
| 48 | static Bool clientobj_remove_obj(DrdClientobj* const p); |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 49 | |
| 50 | |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 51 | /* Function definitions. */ |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 52 | |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 53 | void DRD_(clientobj_set_trace)(const Bool trace) |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 54 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 55 | s_trace_clientobj = trace; |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 56 | } |
| 57 | |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 58 | /** Initialize the client object set. */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 59 | void DRD_(clientobj_init)(void) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 60 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 61 | tl_assert(s_clientobj_set == 0); |
| 62 | s_clientobj_set = VG_(OSetGen_Create)(0, 0, VG_(malloc), |
| 63 | "drd.clientobj.ci.1", VG_(free)); |
| 64 | tl_assert(s_clientobj_set); |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 65 | } |
| 66 | |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 67 | /** |
| 68 | * Free the memory allocated for the client object set. |
| 69 | * |
| 70 | * @pre Client object set is empty. |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 71 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 72 | void DRD_(clientobj_cleanup)(void) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 73 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 74 | tl_assert(s_clientobj_set); |
| 75 | tl_assert(VG_(OSetGen_Size)(s_clientobj_set) == 0); |
| 76 | VG_(OSetGen_Destroy)(s_clientobj_set); |
| 77 | s_clientobj_set = 0; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 78 | } |
| 79 | |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 80 | /** |
| 81 | * Return the data associated with the client object at client address addr. |
| 82 | * Return 0 if there is no client object in the set with the specified start |
| 83 | * address. |
bart | 391d9dc | 2008-07-03 10:57:30 +0000 | [diff] [blame] | 84 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 85 | DrdClientobj* DRD_(clientobj_get_any)(const Addr addr) |
bart | 391d9dc | 2008-07-03 10:57:30 +0000 | [diff] [blame] | 86 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 87 | return VG_(OSetGen_Lookup)(s_clientobj_set, &addr); |
bart | 391d9dc | 2008-07-03 10:57:30 +0000 | [diff] [blame] | 88 | } |
| 89 | |
bart | 1344d6c | 2009-02-21 16:17:50 +0000 | [diff] [blame] | 90 | /** |
| 91 | * Return the data associated with the client object at client address addr |
| 92 | * and that has object type t. Return 0 if there is no client object in the |
| 93 | * set with the specified start address. |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 94 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 95 | DrdClientobj* DRD_(clientobj_get)(const Addr addr, const ObjType t) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 96 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 97 | DrdClientobj* p; |
| 98 | p = VG_(OSetGen_Lookup)(s_clientobj_set, &addr); |
| 99 | if (p && p->any.type == t) |
| 100 | return p; |
| 101 | return 0; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | /** Return true if and only if the address range of any client object overlaps |
| 105 | * with the specified address range. |
| 106 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 107 | Bool DRD_(clientobj_present)(const Addr a1, const Addr a2) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 108 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 109 | DrdClientobj *p; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 110 | |
bart | a300398 | 2010-09-08 16:29:17 +0000 | [diff] [blame] | 111 | tl_assert(a1 <= a2); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 112 | VG_(OSetGen_ResetIter)(s_clientobj_set); |
| 113 | for ( ; (p = VG_(OSetGen_Next)(s_clientobj_set)) != 0; ) |
| 114 | { |
| 115 | if (a1 <= p->any.a1 && p->any.a1 < a2) |
| 116 | { |
bart | 31b983d | 2010-02-21 14:52:59 +0000 | [diff] [blame] | 117 | return True; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 118 | } |
| 119 | } |
| 120 | return False; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 121 | } |
| 122 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 123 | /** |
| 124 | * Add state information for the client object at client address addr and |
| 125 | * of type t. Suppress data race reports on the address range [addr,addr+size[. |
| 126 | * |
| 127 | * @pre No other client object is present in the address range [addr,addr+size[. |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 128 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 129 | DrdClientobj* DRD_(clientobj_add)(const Addr a1, const ObjType t) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 130 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 131 | DrdClientobj* p; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 132 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 133 | tl_assert(! DRD_(clientobj_present)(a1, a1 + 1)); |
| 134 | tl_assert(VG_(OSetGen_Lookup)(s_clientobj_set, &a1) == 0); |
bart | bcbd748 | 2008-02-29 19:19:39 +0000 | [diff] [blame] | 135 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 136 | if (s_trace_clientobj) |
bart | ad994e8 | 2011-10-13 18:04:30 +0000 | [diff] [blame^] | 137 | DRD_(trace_msg)("Adding client object 0x%lx of type %d", a1, t); |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 138 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 139 | p = VG_(OSetGen_AllocNode)(s_clientobj_set, sizeof(*p)); |
| 140 | VG_(memset)(p, 0, sizeof(*p)); |
| 141 | p->any.a1 = a1; |
| 142 | p->any.type = t; |
| 143 | p->any.first_observed_at = VG_(record_ExeContext)(VG_(get_running_tid)(), 0); |
| 144 | VG_(OSetGen_Insert)(s_clientobj_set, p); |
| 145 | tl_assert(VG_(OSetGen_Lookup)(s_clientobj_set, &a1) == p); |
bart | b878a73 | 2010-03-07 20:07:15 +0000 | [diff] [blame] | 146 | if (t == ClientHbvar) |
| 147 | DRD_(mark_hbvar)(a1); |
| 148 | else |
| 149 | DRD_(start_suppression)(a1, a1 + 1, "clientobj"); |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 150 | return p; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 151 | } |
| 152 | |
bart | 1344d6c | 2009-02-21 16:17:50 +0000 | [diff] [blame] | 153 | /** |
| 154 | * Remove the information that was stored about the client object. |
| 155 | * |
| 156 | * @param[in] addr Address of the client object in the client address space. |
| 157 | * @param[in] t Type of the client object. |
| 158 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 159 | Bool DRD_(clientobj_remove)(const Addr addr, const ObjType t) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 160 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 161 | DrdClientobj* p; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 162 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 163 | p = VG_(OSetGen_Lookup)(s_clientobj_set, &addr); |
| 164 | tl_assert(p); |
| 165 | tl_assert(p->any.type == t); |
| 166 | return clientobj_remove_obj(p); |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 167 | } |
| 168 | |
bart | 1344d6c | 2009-02-21 16:17:50 +0000 | [diff] [blame] | 169 | /** |
| 170 | * Remove the information that was stored about the client object p. |
| 171 | * |
| 172 | * @note The order of operations below is important. The client object is |
| 173 | * removed from the client object set after the cleanup function has been |
| 174 | * called such that if the cleanup function can still use the function |
| 175 | * DRD_(clientobj_get_any)(). This happens e.g. in the function |
| 176 | * first_observed() in drd_error.c. |
| 177 | */ |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 178 | static Bool clientobj_remove_obj(DrdClientobj* const p) |
| 179 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 180 | tl_assert(p); |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 181 | |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 182 | if (s_trace_clientobj) { |
bart | ad994e8 | 2011-10-13 18:04:30 +0000 | [diff] [blame^] | 183 | DRD_(trace_msg)("Removing client object 0x%lx of type %d", p->any.a1, |
bart | b92ff0f | 2011-10-08 08:29:29 +0000 | [diff] [blame] | 184 | p->any.type); |
bart | 9374ee3 | 2009-07-23 16:24:02 +0000 | [diff] [blame] | 185 | #if 0 |
| 186 | VG_(get_and_pp_StackTrace)(VG_(get_running_tid)(), |
| 187 | VG_(clo_backtrace_size)); |
| 188 | #endif |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 189 | } |
bart | 72b751c | 2008-03-01 13:44:24 +0000 | [diff] [blame] | 190 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 191 | tl_assert(p->any.cleanup); |
| 192 | (*p->any.cleanup)(p); |
| 193 | VG_(OSetGen_Remove)(s_clientobj_set, &p->any.a1); |
| 194 | VG_(OSetGen_FreeNode)(s_clientobj_set, p); |
| 195 | return True; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 196 | } |
| 197 | |
bart | 28be7aa | 2009-02-23 19:15:32 +0000 | [diff] [blame] | 198 | /** |
| 199 | * Clean up all client objects p for which their start address p->any.a1 fits |
| 200 | * inside the address range [ a1, a2 [. |
| 201 | * |
| 202 | * @note The implementation of this function relies on the fact that the |
| 203 | * data in s_clientobj_set is sorted on the start address of client objects. |
| 204 | */ |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 205 | void DRD_(clientobj_stop_using_mem)(const Addr a1, const Addr a2) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 206 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 207 | Addr removed_at; |
| 208 | DrdClientobj* p; |
bart | b78312c | 2008-02-29 11:00:17 +0000 | [diff] [blame] | 209 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 210 | tl_assert(s_clientobj_set); |
bart | fea6444 | 2008-03-30 16:55:40 +0000 | [diff] [blame] | 211 | |
bart | b878a73 | 2010-03-07 20:07:15 +0000 | [diff] [blame] | 212 | if (! DRD_(range_contains_suppression_or_hbvar)(a1, a2)) |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 213 | return; |
bart | fea6444 | 2008-03-30 16:55:40 +0000 | [diff] [blame] | 214 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 215 | VG_(OSetGen_ResetIterAt)(s_clientobj_set, &a1); |
| 216 | for ( ; (p = VG_(OSetGen_Next)(s_clientobj_set)) != 0 && p->any.a1 < a2; ) |
| 217 | { |
| 218 | tl_assert(a1 <= p->any.a1); |
| 219 | removed_at = p->any.a1; |
| 220 | clientobj_remove_obj(p); |
| 221 | /* |
| 222 | * The above call removes an element from the oset and hence |
| 223 | * invalidates the iterator. Restore the iterator. |
| 224 | */ |
| 225 | VG_(OSetGen_ResetIterAt)(s_clientobj_set, &removed_at); |
| 226 | } |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 227 | } |
| 228 | |
bart | d2c5eae | 2009-02-21 15:27:04 +0000 | [diff] [blame] | 229 | /** |
| 230 | * Delete the per-thread information stored in client objects for the |
| 231 | * specified thread. |
| 232 | */ |
| 233 | void DRD_(clientobj_delete_thread)(const DrdThreadId tid) |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 234 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 235 | DrdClientobj *p; |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 236 | |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 237 | VG_(OSetGen_ResetIter)(s_clientobj_set); |
| 238 | for ( ; (p = VG_(OSetGen_Next)(s_clientobj_set)) != 0; ) |
| 239 | { |
| 240 | if (p->any.delete_thread) |
| 241 | { |
| 242 | (*p->any.delete_thread)(p, tid); |
| 243 | } |
| 244 | } |
bart | e7d5872 | 2008-02-28 19:08:04 +0000 | [diff] [blame] | 245 | } |
| 246 | |
bart | 195e41f | 2009-02-15 11:34:57 +0000 | [diff] [blame] | 247 | const char* DRD_(clientobj_type_name)(const ObjType t) |
bart | 391d9dc | 2008-07-03 10:57:30 +0000 | [diff] [blame] | 248 | { |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 249 | switch (t) |
| 250 | { |
| 251 | case ClientMutex: return "mutex"; |
| 252 | case ClientCondvar: return "cond"; |
bart | 62cc232 | 2010-03-07 10:54:21 +0000 | [diff] [blame] | 253 | case ClientHbvar: return "order annotation"; |
bart | bedfd23 | 2009-03-26 19:07:15 +0000 | [diff] [blame] | 254 | case ClientSemaphore: return "semaphore"; |
| 255 | case ClientBarrier: return "barrier"; |
| 256 | case ClientRwlock: return "rwlock"; |
| 257 | } |
| 258 | return "(unknown)"; |
bart | 391d9dc | 2008-07-03 10:57:30 +0000 | [diff] [blame] | 259 | } |