blob: 0ccf2bf6deafa9859f278f0fca29565cdd98770b [file] [log] [blame]
barte7d58722008-02-28 19:08:04 +00001/*
2 This file is part of drd, a data race detector.
3
4 Copyright (C) 2006-2008 Bart Van Assche
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#include "drd_clientobj.h"
27#include "drd_suppression.h"
28#include "pub_tool_basics.h"
29#include "pub_tool_libcassert.h"
30#include "pub_tool_libcbase.h"
bart72b751c2008-03-01 13:44:24 +000031#include "pub_tool_libcprint.h" // VG_(message)()
barte7d58722008-02-28 19:08:04 +000032#include "pub_tool_mallocfree.h"
bart72b751c2008-03-01 13:44:24 +000033#include "pub_tool_options.h" // VG_(clo_backtrace_size)
barte7d58722008-02-28 19:08:04 +000034#include "pub_tool_oset.h"
bart72b751c2008-03-01 13:44:24 +000035#include "pub_tool_stacktrace.h"
36#include "pub_tool_threadstate.h" // VG_(get_running_tid)()
barte7d58722008-02-28 19:08:04 +000037
38
39// Local variables.
40
41static OSet* s_clientobj;
bart72b751c2008-03-01 13:44:24 +000042static Bool s_trace_clientobj;
barte7d58722008-02-28 19:08:04 +000043
44
45// Function definitions.
46
bart72b751c2008-03-01 13:44:24 +000047void clientobj_set_trace(const Bool trace)
48{
49 s_trace_clientobj = trace;
50}
51
barte7d58722008-02-28 19:08:04 +000052/** Initialize the client object set. */
bart72b751c2008-03-01 13:44:24 +000053void clientobj_init(void)
barte7d58722008-02-28 19:08:04 +000054{
55 tl_assert(s_clientobj == 0);
56 s_clientobj = VG_(OSetGen_Create)(0, 0, VG_(malloc), VG_(free));
57 tl_assert(s_clientobj);
58}
59
60/** Free the memory allocated for the client object set.
61 * @pre Client object set is empty.
62 */
bart72b751c2008-03-01 13:44:24 +000063void clientobj_cleanup(void)
barte7d58722008-02-28 19:08:04 +000064{
65 tl_assert(s_clientobj);
66 tl_assert(VG_(OSetGen_Size)(s_clientobj) == 0);
67 VG_(OSetGen_Destroy)(s_clientobj);
68 s_clientobj = 0;
69}
70
71/** Return the data associated with the client object at client address addr
72 * and that has object type t. Return 0 if there is no client object in the
73 * set with the specified start address.
74 */
bart72b751c2008-03-01 13:44:24 +000075DrdClientobj* clientobj_get(const Addr addr, const ObjType t)
barte7d58722008-02-28 19:08:04 +000076{
77 DrdClientobj* p;
78 p = VG_(OSetGen_Lookup)(s_clientobj, &addr);
79 if (p && p->any.type == t)
80 return p;
81 return 0;
82}
83
84/** Return true if and only if the address range of any client object overlaps
85 * with the specified address range.
86 */
bart72b751c2008-03-01 13:44:24 +000087Bool clientobj_present(const Addr a1, const Addr a2)
barte7d58722008-02-28 19:08:04 +000088{
89 DrdClientobj *p;
90
91 tl_assert(a1 < a2);
92 VG_(OSetGen_ResetIter)(s_clientobj);
93 for ( ; (p = VG_(OSetGen_Next)(s_clientobj)) != 0; )
94 {
95 if ((a1 <= p->any.a1 && p->any.a1 < a2)
96 || (a1 < p->any.a2 && p->any.a2 <= a2))
97 {
98 return True;
99 }
100 }
101 return False;
102}
103
104/** Add state information for the client object at client address addr and
105 * of type t. Suppress data race reports on the address range [addr,addr+size[.
106 * @pre No other client object is present in the address range [addr,addr+size[.
107 */
108DrdClientobj*
bart72b751c2008-03-01 13:44:24 +0000109clientobj_add(const Addr a1, const Addr a2, const ObjType t)
barte7d58722008-02-28 19:08:04 +0000110{
111 DrdClientobj* p;
112
113 tl_assert(a1 < a2 && a1 + 4096 > a2);
bart72b751c2008-03-01 13:44:24 +0000114 tl_assert(! clientobj_present(a1, a2));
barte7d58722008-02-28 19:08:04 +0000115 tl_assert(VG_(OSetGen_Lookup)(s_clientobj, &a1) == 0);
bartbcbd7482008-02-29 19:19:39 +0000116
bart72b751c2008-03-01 13:44:24 +0000117 if (s_trace_clientobj)
118 {
119 VG_(message)(Vg_UserMsg, "Adding client object 0x%lx of type %d", a1, t);
120 }
121
barte7d58722008-02-28 19:08:04 +0000122 p = VG_(OSetGen_AllocNode)(s_clientobj, sizeof(*p));
123 VG_(memset)(p, 0, sizeof(*p));
124 p->any.a1 = a1;
125 p->any.a2 = a2;
126 p->any.type = t;
127 VG_(OSetGen_Insert)(s_clientobj, p);
128 tl_assert(VG_(OSetGen_Lookup)(s_clientobj, &a1) == p);
129 drd_start_suppression(p->any.a1, p->any.a2, "client object");
130 return p;
131}
132
bart72b751c2008-03-01 13:44:24 +0000133Bool clientobj_remove(const Addr addr, const ObjType t)
barte7d58722008-02-28 19:08:04 +0000134{
135 DrdClientobj* p;
136
bart72b751c2008-03-01 13:44:24 +0000137 if (s_trace_clientobj)
138 {
139 VG_(message)(Vg_UserMsg, "Removing client object 0x%lx of type %d",
140 addr, t);
141#if 0
142 VG_(get_and_pp_StackTrace)(VG_(get_running_tid)(),
143 VG_(clo_backtrace_size));
144#endif
145 }
146
bart28230a32008-02-29 17:27:03 +0000147 p = VG_(OSetGen_Lookup)(s_clientobj, &addr);
148 tl_assert(p->any.type == t);
barte7d58722008-02-28 19:08:04 +0000149 p = VG_(OSetGen_Remove)(s_clientobj, &addr);
150 if (p)
151 {
barte7d58722008-02-28 19:08:04 +0000152 tl_assert(VG_(OSetGen_Lookup)(s_clientobj, &addr) == 0);
153 drd_finish_suppression(p->any.a1, p->any.a2);
154 tl_assert(p->any.cleanup);
155 (*p->any.cleanup)(p);
156 VG_(OSetGen_FreeNode)(s_clientobj, p);
157 return True;
158 }
159 return False;
160}
161
bart72b751c2008-03-01 13:44:24 +0000162void clientobj_stop_using_mem(const Addr a1, const Addr a2)
barte7d58722008-02-28 19:08:04 +0000163{
bartb78312c2008-02-29 11:00:17 +0000164 Addr removed_at;
barte7d58722008-02-28 19:08:04 +0000165 DrdClientobj* p;
bartb78312c2008-02-29 11:00:17 +0000166
barte7d58722008-02-28 19:08:04 +0000167 tl_assert(s_clientobj);
168 VG_(OSetGen_ResetIter)(s_clientobj);
bartb78312c2008-02-29 11:00:17 +0000169 p = VG_(OSetGen_Next)(s_clientobj);
170 for ( ; p != 0; )
barte7d58722008-02-28 19:08:04 +0000171 {
172 if ((a1 <= p->any.a1 && p->any.a1 < a2)
173 || (a1 < p->any.a2 && p->any.a2 <= a2))
174 {
bartb78312c2008-02-29 11:00:17 +0000175 removed_at = p->any.a1;
bart72b751c2008-03-01 13:44:24 +0000176 clientobj_remove(p->any.a1, p->any.type);
bartbcbd7482008-02-29 19:19:39 +0000177 /* The above call removes an element from the oset and hence */
178 /* invalidates the iterator. Set the iterator back. */
bartb78312c2008-02-29 11:00:17 +0000179 VG_(OSetGen_ResetIter)(s_clientobj);
180 while ((p = VG_(OSetGen_Next)(s_clientobj)) != 0
181 && p->any.a1 <= removed_at)
182 { }
183 }
184 else
185 {
186 p = VG_(OSetGen_Next)(s_clientobj);
barte7d58722008-02-28 19:08:04 +0000187 }
188 }
189}
190
bart72b751c2008-03-01 13:44:24 +0000191void clientobj_resetiter(void)
barte7d58722008-02-28 19:08:04 +0000192{
193 VG_(OSetGen_ResetIter)(s_clientobj);
194}
195
bart72b751c2008-03-01 13:44:24 +0000196DrdClientobj* clientobj_next(const ObjType t)
barte7d58722008-02-28 19:08:04 +0000197{
198 DrdClientobj* p;
199 while ((p = VG_(OSetGen_Next)(s_clientobj)) != 0 && p->any.type != t)
200 ;
201 return p;
202}
203