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