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
207
208
209
210
211
212
|
#define _GNU_SOURCE
#define _XOPEN_SOURCE 600
#include "config.h"
#include <stdio.h>
#include <string.h>
#include <stdint.h>
#include <assert.h>
#include <pthread.h>
#include <stdint.h>
#ifdef HAVE_STDATOMIC_H
# include <stdatomic.h>
#endif /* HAVE_STDATOMIC_H */
#include "error.h"
#include "lock.h"
#include "pci.h"
/**
* structure to define a lock
*/
struct pcilib_lock_s {
pthread_mutex_t mutex; /**< the pthread robust mutex itself*/
pcilib_lock_flags_t flags; /**<flag to define the property of the mutex*/
#ifdef HAVE_STDATOMIC_H
volatile atomic_uint refs; /**< approximate number of processes that may require access to this lock*/
#else /* HAVE_STDATOMIC_H */
volatile uint32_t refs;/**< approximate number of processes that may require access to this lock*/
#endif /* HAVE_STDATOMIC_H */
char name[]; /**< identifier name to search for a lock*/
};
int pcilib_init_lock(pcilib_lock_t *lock, pcilib_lock_flags_t flags, const char *lock_id) {
int err;
pthread_mutexattr_t attr;
assert(lock);
assert(lock_id);
memset(lock, 0, PCILIB_LOCK_SIZE);
if (strlen(lock_id) >= (PCILIB_LOCK_SIZE - offsetof(struct pcilib_lock_s, name))) {
pcilib_error("The supplied lock id (%s) is too long...", lock_id);
return PCILIB_ERROR_INVALID_ARGUMENT;
}
if ((err = pthread_mutexattr_init(&attr))!=0) {
pcilib_error("Can't initialize mutex attribute, errno %i", errno);
return PCILIB_ERROR_FAILED;
}
/* we declare the mutex as possibly shared amongst different processes*/
if ((err = pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_SHARED))!=0) {
pcilib_error("Can't configure a shared mutex attribute, errno %i", errno);
return PCILIB_ERROR_FAILED;
}
/* we set the mutex as robust, so it would be automatically unlocked if the application crash*/
if ((flags&PCILIB_LOCK_FLAG_PERSISTENT)==0) {
if ((err = pthread_mutexattr_setrobust(&attr, PTHREAD_MUTEX_ROBUST))!=0) {
pcilib_error("Can't configure a robust mutex attribute, errno: %i", errno);
return PCILIB_ERROR_FAILED;
}
}
if ((err = pthread_mutex_init(&lock->mutex, &attr))!=0) {
pcilib_error("Can't create mutex, errno : %i",errno);
return PCILIB_ERROR_FAILED;
}
strcpy(lock->name, lock_id);
lock->refs = 1;
lock->flags = flags;
return 0;
}
void pcilib_free_lock(pcilib_lock_t *lock) {
int err;
assert(lock);
// if (lock->refs)
// pcilib_error("Forbidding to destroy the referenced mutex...");
if ((err = pthread_mutex_destroy(&lock->mutex))==-1)
pcilib_warning("Can't destroy POSIX mutex, errno %i",errno);
}
void pcilib_lock_ref(pcilib_lock_t *lock) {
assert(lock);
#ifdef HAVE_STDATOMIC_H
atomic_fetch_add_explicit(&lock->refs, 1, memory_order_relaxed);
#else /* HAVE_STDATOMIC_H */
lock->refs++;
#endif /* HAVE_STDATOMIC_H */
}
void pcilib_lock_unref(pcilib_lock_t *lock) {
assert(lock);
if (!lock->refs) {
pcilib_warning("Lock is not referenced");
return;
}
#ifdef HAVE_STDATOMIC_H
atomic_fetch_sub_explicit(&lock->refs, 1, memory_order_relaxed);
#else /* HAVE_STDATOMIC_H */
lock->refs--;
#endif /* HAVE_STDATOMIC_H */
}
size_t pcilib_lock_get_refs(pcilib_lock_t *lock) {
return lock->refs;
}
pcilib_lock_flags_t pcilib_lock_get_flags(pcilib_lock_t *lock) {
return lock->flags;
}
const char *pcilib_lock_get_name(pcilib_lock_t *lock) {
assert(lock);
if (lock->name[0]) return lock->name;
return NULL;
}
int pcilib_lock_custom(pcilib_lock_t *lock, pcilib_lock_flags_t flags, pcilib_timeout_t timeout) {
int err;
if (!lock) {
pcilib_error("The null lock pointer is passed to lock function");
return PCILIB_ERROR_INVALID_ARGUMENT;
}
struct timespec tm;
switch (timeout) {
case PCILIB_TIMEOUT_INFINITE:
/* the process will be hold till it can gain acquire the lock*/
err = pthread_mutex_lock(&lock->mutex);
break;
case PCILIB_TIMEOUT_IMMEDIATE:
/* the function returns immediatly if it can't acquire the lock*/
err = pthread_mutex_trylock(&lock->mutex);
break;
default:
/* the process will be hold till it can acquire the lock and timeout is not reached*/
clock_gettime(CLOCK_REALTIME, &tm);
tm.tv_nsec += 1000 * (timeout%1000000);
if (tm.tv_nsec < 1000000000)
tm.tv_sec += timeout/1000000;
else {
tm.tv_sec += 1 + timeout/1000000;
tm.tv_nsec -= 1000000000;
}
err = pthread_mutex_timedlock(&lock->mutex, &tm);
}
if (!err)
return 0;
switch (err) {
case EOWNERDEAD:
/*in the case an application with a lock acquired crashes, this lock becomes inconsistent. we have so to make it consistent again to use it again.*/
err = pthread_mutex_consistent(&lock->mutex);
if (err) {
pcilib_error("Failed to mark mutex as consistent, errno %i", err);
break;
}
return 0;
case ETIMEDOUT:
case EBUSY:
return PCILIB_ERROR_TIMEOUT;
default:
pcilib_error("Failed to obtain mutex, errno %i", err);
}
return PCILIB_ERROR_FAILED;
}
int pcilib_lock(pcilib_lock_t* lock) {
return pcilib_lock_custom(lock, PCILIB_LOCK_FLAGS_DEFAULT, PCILIB_TIMEOUT_INFINITE);
}
int pcilib_try_lock(pcilib_lock_t* lock) {
return pcilib_lock_custom(lock, PCILIB_LOCK_FLAGS_DEFAULT, PCILIB_TIMEOUT_IMMEDIATE);
}
void pcilib_unlock(pcilib_lock_t *lock) {
int err;
if (!lock)
return;
if ((err = pthread_mutex_unlock(&lock->mutex)) != 0) {
switch (err) {
case EPERM:
pcilib_error("Trying to unlock not locked mutex (%s) or the mutex which was locked by a different thread", lock->name);
break;
default:
pcilib_error("Can't unlock mutex, errno %i", err);
}
}
}
|
