summaryrefslogtreecommitdiff
path: root/tools/debug_mutex.h
blob: 0802c7cc7e93b2e77f3e44ff84dcee697ae95531 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/*
 * debug_mutex.h: debugging wrappers for pthread_mutex_ functions
 *
 * See the main source file 'xineliboutput.c' for copyright information and
 * how to reach the author.
 *
 * $Id: debug_mutex.h,v 1.3 2007-03-14 11:50:08 phintuka Exp $
 *
 */

#ifndef DEBUG_MUTEX_H
#define DEBUG_MUTEX_H

#ifndef _PTHREAD_H
#  error pthread.h must be included before debug_mutex.h
#endif

/*
 * Override pthread_mutex_ calls:
 *
 * Change type of each mutex to PTHREAD_MUTEX_ERRORCHECK_NP
 *
 * Store line number of last succeed pthread_mutex_lock call 
 * for each initialized mutex
 *
 * Check every pthread_mutex_ call for errors and log all errors
 *
 * To help detecting deadlocks and minimize logging:
 * - Try locking first in pthread_mutex_lock
 * - If pthread_mutex_trylock fails, log a message and retry.
 * - When trylock failed, log another message when lock is acquired.
 *
 *
 * NOTE: debugging itself is not thread-safe and may indicate wrong line numbers !
 *
 */

#define MAX_DBG_MUTEX 64
static struct {
  pthread_mutex_t *lock;
  int line;
  int tid;
} dbgdata[MAX_DBG_MUTEX+1] = {{NULL,0}};

static void dbg_setdata(pthread_mutex_t *mutex, int line)
{
  int i;
  for(i=0; i<MAX_DBG_MUTEX; i++)
    if(dbgdata[i].lock == mutex) {
      dbgdata[i].line = line;
      dbgdata[i].tid = syscall(__NR_gettid);
      return;
    }

  LOGMSG("********** dbg_setdata: new entry (0x%lx at %d)", (unsigned long int)mutex, line);
  for(i=0; i<MAX_DBG_MUTEX; i++)
    if(!dbgdata[i].lock) {
      dbgdata[i].lock = mutex;
      dbgdata[i].line = line;
      dbgdata[i].tid = syscall(__NR_gettid);
      return;
    }

  LOGMSG("********** dbg_setdata: table full !");
}

static int dbg_getdata(pthread_mutex_t *mutex, int line)
{
  int i;
  for(i=0; i<MAX_DBG_MUTEX; i++)
    if(dbgdata[i].lock == mutex)
      return dbgdata[i].line;

  LOGMSG("********** dbg_getdata: NO ENTRY ! (%d)", line);
  return -1;
}

static void dbg_deldata(pthread_mutex_t *mutex, int line)
{
  int i;
  for(i=0; i<MAX_DBG_MUTEX; i++)
    if(dbgdata[i].lock == mutex) {
      dbgdata[i].lock = NULL;
      return;
    }

  LOGMSG("********** dbg_deldata: NO ENTRY ! (%d)", line);
  return;
}

static int dbg_init(pthread_mutex_t *mutex, pthread_mutexattr_t *pattr, int line)
{
  int r;

  errno = 0;
  if(!pattr) {
    pthread_mutexattr_t attr;
    pthread_mutexattr_init(&attr);
    pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK_NP);
    r = pthread_mutex_init(mutex, &attr);
  } else {
    LOGMSG("********** dbg_init: mutex attribute already given !");
    r = pthread_mutex_init(mutex, pattr);
  }

  if(r) 
    LOGERR("********** dbg_init: pthread_mutex_init FAILED at %d", line);

  dbg_setdata(mutex, line);

  return r;
}

static int dbg_free(pthread_mutex_t *mutex, int line)
{
  int r;

  errno = 0;
  r = pthread_mutex_destroy(mutex);

  if(r) 
    LOGERR("********** dbg_free: pthread_mutex_destroy FAILED at %d ; last lock at %d", 
	   line, dbg_getdata(mutex, line));
  dbg_deldata(mutex, line);

  return r;
}

static int dbg_lock(pthread_mutex_t *mutex, int line)
{
  int r;
  /*struct timespec abs_timeout;*/

  /* try lock first to reduce logging */
  errno = 0;
  r = pthread_mutex_trylock(mutex);
  if(!r) {
    dbg_setdata(mutex,line);
    return r;
  }

  /* try failed - we're going to wait, so log at wait start and end to detect deadlocks */
  LOGERR("********** dbg_lock: pthread_mutex_trylock failed at %d (locked at %d)", 
	 line, dbg_getdata(mutex, line));

  /*  int pthread_mutex_timedlock(pthread_mutex_t *restrict mutex,
      const struct timespec *restrict abs_timeout); */

  errno = 0;
  r = pthread_mutex_lock(mutex);

  if(r) 
    LOGERR("********** dbg_lock: pthread_mutex_lock FAILED at %d", line);
  
  dbg_setdata(mutex, line);
  LOGMSG("********** dbg_lock: pthread_mutex_lock done at %d", line);
  
 return r;
}

static int dbg_trylock(pthread_mutex_t *mutex, int line)
{
  int r;
  /*struct timespec abs_timeout;*/

  /* try lock first to reduce logging */
  errno = 0;
  r = pthread_mutex_trylock(mutex);
  if(!r) {
    dbg_setdata(mutex,line);
    return r;
  }

  LOGERR("********** dbg_trylock: pthread_mutex_trylock failed at %d (locked at %d)", 
	 line, dbg_getdata(mutex, line));
  
  return r;
}

static int dbg_unlock(pthread_mutex_t *mutex, int line)
{
  int r;

  errno = 0;
  r = pthread_mutex_unlock(mutex);

  if(r) 
    LOGERR("********** dbg_unlock: pthread_mutex_unlock FAILED at %d (last locket at %d)", 
	   line, dbg_getdata(mutex, line));

  //else
  //  dbg_setdata(mutex, 0);

  return r;
}

/* override pthread_ functions with own ones */
#define pthread_mutex_init(l,a)  dbg_init(l, a, __LINE__)
#define pthread_mutex_lock(l)    dbg_lock(l, __LINE__)
#define pthread_mutex_trylock(l) dbg_trylock(l, __LINE__)
#define pthread_mutex_unlock(l)  dbg_unlock(l, __LINE__)
#define pthread_mutex_destroy(l) dbg_free(l, __LINE__)

#else
#  error debug_mutex.h included twice
#endif /* DEBUG_MUTEX_H */