/usr/include/cxxtools/mutex.h is in libcxxtools-dev 2.0-4ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 | /*
* Copyright (C) 2005-2008 by Marc Boris Duerner
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef cxxtools_Mutex_h
#define cxxtools_Mutex_h
#include <cxxtools/api.h>
#include <cxxtools/atomicity.h>
#include <cxxtools/noncopyable.h>
#include <cxxtools/thread.h>
namespace cxxtools {
/** @brief Mutual exclusion device.
A Mutex is a mutual exclusion device. It is used to synchronize
the access to data which is accessed by more than one thread or
process at the same time. Mutexes are not recursive, that is the
same thread can not lock a mutex multiple times without deadlocking.
*/
class CXXTOOLS_API Mutex : private NonCopyable
{
private:
class MutexImpl* _impl;
public:
//! @brief Default constructor.
Mutex();
/** @brief Destructor.
The destructor destroys the mutex. The mutex must be in unlocked
state when the destructor is called.
*/
~Mutex();
/** @brief Lock the mutex.
If the mutex is currently locked by another
thread, the calling thread suspends until no other thread holds
a lock on it. If the mutex is already locked by the calling
thread a deadlock occurs.
*/
void lock();
bool tryLock();
//! @brief Unlocks the mutex.
void unlock();
/** @brief Unlocks the mutex.
This method does not throw an exception if unlocking the mutex
fails but simply returns false.
*/
bool unlockNoThrow();
//! @internal @brief Access to platform specific implementation
MutexImpl& impl()
{ return *_impl; }
};
/** @brief MutexLock class for Mutex.
The MutexLock class adds functionality for scoped
locking. In the constructor of a MutexLock, the mutex is locked
and in the destructor it is unlocked. This way if for example an
exception occures in the protected section the Mutex will be unlocked
during stack unwinding when the MutexLock is destructed.
@code
// example how to make a member function thread-safe
#include <cxxtools/System/Mutex.h>
class MyClass
{
public:
void function()
{
MutexLock lock(_mtx);
//
// protected operations
//
// dtor of MutexLock unlocks _mtx
}
private:
cxxtools::System::Mutex _mtx;
};
@endcode
*/
class MutexLock : private NonCopyable
{
public:
/** @brief Construct to guard a %Mutex
Constructs a MutexLock object and locks the enclosing mutex
if \a doLock is true. If \a isLocked is true, the %MutexLock
will only unlock the given mutex in the destructor, but not
lock it in the constructor.
*/
MutexLock(Mutex& m, bool doLock = true, bool isLocked = false)
: _mutex(m)
, _isLocked(isLocked)
{
if(doLock)
this->lock();
}
//! @brief Unlocks the mutex unless %unlock() was called
~MutexLock()
{
if(_isLocked)
_mutex.unlockNoThrow();
}
void lock()
{
if(!_isLocked)
{
_mutex.lock();
_isLocked = true;
}
}
//! @brief Unlock so that the destructor does not unlock
void unlock()
{
if(_isLocked)
{
_mutex.unlock();
_isLocked = false;
}
}
//! @brief Returns the guarded the mutex object
Mutex& mutex()
{ return _mutex; }
//! @brief Returns the guarded the mutex object
const Mutex& mutex() const
{ return _mutex; }
private:
Mutex& _mutex;
bool _isLocked;
};
/** @brief Recursive mutual exclusion device
*/
class CXXTOOLS_API RecursiveMutex : private NonCopyable
{
private:
class MutexImpl* _impl;
public:
RecursiveMutex();
~RecursiveMutex();
void lock();
bool tryLock();
/** @brief Unlocks the mutex.
If the mutex was locked more than one time by the
same thread unlock decrements the lock-count. The mutex is actually
unlocked when the lock-count is zero.
**/
void unlock();
bool unlockNoThrow();
};
/** @brief Lock class for recursive mutexes.
*/
class RecursiveLock : private NonCopyable
{
public:
/** @brief Construct to guard a %RecursiveMutex
Constructs a %RecursiveLock object and locks the enclosing
recursive mutex if \a doLock is true. If \a isLocked is true,
the %RecursiveLock will only unlock the given mutex in the
destructor, but not lock it in the constructor.
*/
RecursiveLock(RecursiveMutex& m, bool doLock = true, bool isLocked = false)
: _mutex(m)
, _isLocked(isLocked)
{
if(doLock)
this->lock();
}
//! @brief Unlocks the mutex unless %unlock() was called
~RecursiveLock()
{
if(_isLocked)
_mutex.unlockNoThrow();
}
void lock()
{
if(!_isLocked)
{
_mutex.lock();
_isLocked = true;
}
}
//! @brief Unlock so that the destructor does not unlock
void unlock()
{
if(_isLocked)
{
_mutex.unlock();
_isLocked = false;
}
}
//! @brief Returns the guarded the mutex object
RecursiveMutex& mutex()
{ return _mutex; }
//! @brief Returns the guarded the mutex object
const RecursiveMutex& mutex() const
{ return _mutex; }
private:
RecursiveMutex& _mutex;
bool _isLocked;
};
/** @brief Synchronisation device similar to a POSIX rwlock
A %ReadWriteMutex allows multiple concurrent readers or one exclusive writer to
access a resource.
*/
class CXXTOOLS_API ReadWriteMutex : private NonCopyable
{
public:
//! @brief Creates the Reader/Writer lock.
ReadWriteMutex();
//! @brief Destroys the Reader/Writer lock.
~ReadWriteMutex();
void readLock();
/** @brief Acquires a read lock.
If another thread currently holds a write lock, this method
waits until the write lock is released.
*/
bool tryReadLock();
/** @brief Acquires a write lock.
If one or more other threads currently hold locks, this method
waits until all locks are released. The results are undefined
if the same thread already holds a read or write lock.
*/
void writeLock();
/** @brief Tries to acquire a write lock.
Immediately returns true if successful, or false if one or more
other threads currently hold locks. The result is undefined if
the same thread already holds a read or write lock.
*/
bool tryWriteLock();
//! @brief Releases the read or write lock.
void unlock();
bool unlockNoThrow();
private:
//! @internal
class ReadWriteMutexImpl* _impl;
};
class ReadLock : private NonCopyable
{
public:
ReadLock(ReadWriteMutex& m, bool doLock = true, bool isLocked = false)
: _mutex(m)
, _locked(isLocked)
{
if(doLock)
this->lock();
}
~ReadLock()
{
if(_locked)
_mutex.unlockNoThrow();
}
void lock()
{
if( ! _locked )
{
_mutex.readLock();
_locked = true;
}
}
void unlock()
{
if( _locked)
{
_mutex.unlock();
_locked = false;
}
}
ReadWriteMutex& mutex()
{ return _mutex; }
private:
ReadWriteMutex& _mutex;
bool _locked;
};
class WriteLock : private NonCopyable
{
public:
WriteLock(ReadWriteMutex& m, bool doLock = true, bool isLocked = false)
: _mutex(m)
, _locked(isLocked)
{
if(doLock)
this->lock();
}
~WriteLock()
{
if(_locked)
_mutex.unlockNoThrow();
}
void lock()
{
if( ! _locked )
{
_mutex.writeLock();
_locked = true;
}
}
void unlock()
{
if( _locked)
{
_mutex.unlock();
_locked = false;
}
}
ReadWriteMutex& mutex()
{ return _mutex; }
private:
ReadWriteMutex& _mutex;
bool _locked;
};
/** @brief Spinmutex class.
The most lightweight synchronisation object is the Spinlock. It is
usually implemented with a status variable that can be set to Locked
and Unlocked and atomic operations to change and inspect the status.
When Spinlock::lock is called, the status is changed to Locked.
Subsequent calls of Spinlock::lock from other threads will block until
the first thread has called Spinlock::unlock and the state of
the Spinlock has changed to Unlocked. Note that Spinlocks are not recursive.
When a Spinlock::lock blocks a busy-wait happens, therefore a Spinlock is only
usable in cases where resources need to be locked for a very short time, but in
these cases a higher performance can be achieved.
*/
class SpinMutex : private NonCopyable
{
public:
//! @brief Default Constructor.
SpinMutex()
: _count(0)
{}
//! @brief Destructor.
~SpinMutex()
{}
/** @brief Lock.
Locks the Spinlock. If the Spinlock is currently locked
by another thread, the calling thread suspends until no
other thread holds a lock on it. This happens
performing a busy-wait. Spinlocks are not recursive
locking it multiple times before unlocking it is undefined.
*/
inline void lock()
{
// busy loop until unlock
while( atomicCompareExchange(_count, 1, 0) )
{
Thread::yield();
}
}
bool tryLock()
{
return ! atomicCompareExchange(_count, 1, 0);
}
//! @brief Unlocks the Spinlock.
void unlock()
{
// set unlocked
atomicExchange(_count, 0);
}
//! @internal for unit test only
bool testIsLocked() const
{ return _count != 0; }
private:
volatile cxxtools::atomic_t _count;
};
class SpinLock : private NonCopyable
{
public:
SpinLock(SpinMutex& m, bool doLock = true, bool isLocked = false)
: _mutex(m)
, _locked(isLocked)
{
if(doLock)
this->lock();
}
~SpinLock()
{
if(_locked)
this->unlock();
}
void lock()
{
if( ! _locked )
{
_mutex.lock();
_locked = true;
}
}
void unlock()
{
if( _locked)
{
_mutex.unlock();
_locked = false;
}
}
private:
SpinMutex& _mutex;
bool _locked;
};
} // !namespace cxxtools
#endif
|