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