blob: 16fe562daa7cc956858a010093ffdddff6bc2130 [file] [log] [blame]
barte7d58722008-02-28 19:08:04 +00001/*
bart86562bd2009-02-16 19:43:56 +00002 This file is part of drd, a thread error detector.
barte7d58722008-02-28 19:08:04 +00003
sewardjb3a1e4b2015-08-21 11:32:26 +00004 Copyright (C) 2006-2015 Bart Van Assche <bvanassche@acm.org>.
barte7d58722008-02-28 19:08:04 +00005
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
bart195e41f2009-02-15 11:34:57 +000029#include "drd_basics.h" /* DrdThreadId */
bart9d5b7962008-05-14 12:25:00 +000030#include "drd_clientreq.h" /* MutexT */
barte7d58722008-02-28 19:08:04 +000031#include "pub_tool_basics.h"
bart9d5b7962008-05-14 12:25:00 +000032#include "pub_tool_execontext.h" /* ExeContext */
bart28230a32008-02-29 17:27:03 +000033#include "pub_tool_oset.h"
bart3e017fa2008-12-17 19:20:13 +000034#include "pub_tool_xarray.h"
barte7d58722008-02-28 19:08:04 +000035
36
bart195e41f2009-02-15 11:34:57 +000037/* Forward declarations. */
barte7d58722008-02-28 19:08:04 +000038
39union drd_clientobj;
40
41
bart195e41f2009-02-15 11:34:57 +000042/* Type definitions. */
barte7d58722008-02-28 19:08:04 +000043
bart28230a32008-02-29 17:27:03 +000044typedef enum {
bartbedfd232009-03-26 19:07:15 +000045 ClientMutex = 1,
46 ClientCondvar = 2,
bart62cc2322010-03-07 10:54:21 +000047 ClientHbvar = 3,
48 ClientSemaphore = 4,
49 ClientBarrier = 5,
50 ClientRwlock = 6,
bart28230a32008-02-29 17:27:03 +000051} ObjType;
barte7d58722008-02-28 19:08:04 +000052
53struct any
54{
bartbedfd232009-03-26 19:07:15 +000055 Addr a1;
56 ObjType type;
57 void (*cleanup)(union drd_clientobj*);
58 void (*delete_thread)(union drd_clientobj*, DrdThreadId);
59 ExeContext* first_observed_at;
barte7d58722008-02-28 19:08:04 +000060};
61
62struct mutex_info
63{
bartbedfd232009-03-26 19:07:15 +000064 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.
bart3cc26202014-06-09 09:19:26 +000071 Bool ignore_ordering;
bartbedfd232009-03-26 19:07:15 +000072 DrdThreadId owner; // owner if locked, last owner if free.
73 struct segment* last_locked_segment;
74 ULong acquiry_time_ms;
75 ExeContext* acquired_at;
barte7d58722008-02-28 19:08:04 +000076};
77
bart28230a32008-02-29 17:27:03 +000078struct cond_info
79{
bartbedfd232009-03-26 19:07:15 +000080 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
bart62cc2322010-03-07 10:54:21 +000087 // null if no client threads are currently waiting on this cond.var.
88};
89
90struct 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.
bart28230a32008-02-29 17:27:03 +000098};
99
100struct semaphore_info
101{
bartbedfd232009-03-26 19:07:15 +0000102 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.
bart28230a32008-02-29 17:27:03 +0000113};
114
115struct barrier_info
116{
bartbedfd232009-03-26 19:07:15 +0000117 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.
bartd61580e2011-07-29 12:39:44 +0000128 OSet* oset[2]; // Per-thread barrier information for the latest
129 // two barrier iterations.
bart777f7fe2008-03-02 17:43:18 +0000130};
131
132struct rwlock_info
133{
bartbedfd232009-03-26 19:07:15 +0000134 Addr a1;
135 ObjType type;
136 void (*cleanup)(union drd_clientobj*);
137 void (*delete_thread)(union drd_clientobj*, DrdThreadId);
138 ExeContext* first_observed_at;
bartc8441502009-07-27 16:03:51 +0000139 RwLockT rwlock_type;
bartbedfd232009-03-26 19:07:15 +0000140 OSet* thread_info;
141 ULong acquiry_time_ms;
142 ExeContext* acquired_at;
bart28230a32008-02-29 17:27:03 +0000143};
144
barte7d58722008-02-28 19:08:04 +0000145typedef union drd_clientobj
146{
bartbedfd232009-03-26 19:07:15 +0000147 struct any any;
148 struct mutex_info mutex;
149 struct cond_info cond;
bart62cc2322010-03-07 10:54:21 +0000150 struct hb_info hb;
bartbedfd232009-03-26 19:07:15 +0000151 struct semaphore_info semaphore;
152 struct barrier_info barrier;
153 struct rwlock_info rwlock;
barte7d58722008-02-28 19:08:04 +0000154} DrdClientobj;
155
156
bart195e41f2009-02-15 11:34:57 +0000157/* Function declarations. */
barte7d58722008-02-28 19:08:04 +0000158
bart195e41f2009-02-15 11:34:57 +0000159void DRD_(clientobj_set_trace)(const Bool trace);
160void DRD_(clientobj_init)(void);
161void DRD_(clientobj_cleanup)(void);
162DrdClientobj* DRD_(clientobj_get_any)(const Addr addr);
163DrdClientobj* DRD_(clientobj_get)(const Addr addr, const ObjType t);
164Bool DRD_(clientobj_present)(const Addr a1, const Addr a2);
165DrdClientobj* DRD_(clientobj_add)(const Addr a1, const ObjType t);
166Bool DRD_(clientobj_remove)(const Addr addr, const ObjType t);
167void DRD_(clientobj_stop_using_mem)(const Addr a1, const Addr a2);
bartd2c5eae2009-02-21 15:27:04 +0000168void DRD_(clientobj_delete_thread)(const DrdThreadId tid);
florian19f91bb2012-11-10 22:29:54 +0000169const HChar* DRD_(clientobj_type_name)(const ObjType t);
bart391d9dc2008-07-03 10:57:30 +0000170
barte7d58722008-02-28 19:08:04 +0000171
172#endif /* __DRD_CLIENTOBJ_H */