1b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===- Mutex.cpp - Mutual Exclusion Lock ------------------------*- C++ -*-===//
2b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//
3b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//                     The LLVM Compiler Infrastructure
4b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//
54ee451de366474b9c228b4e5fa573795a715216dChris Lattner// This file is distributed under the University of Illinois Open Source
64ee451de366474b9c228b4e5fa573795a715216dChris Lattner// License. See LICENSE.TXT for details.
7b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//
8b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===----------------------------------------------------------------------===//
9b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//
10b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer// This file implements the llvm::sys::Mutex class.
11b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//
12b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===----------------------------------------------------------------------===//
13b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
14b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#include "llvm/Config/config.h"
151f6efa3996dd1929fbc129203ce5009b620e6969Michael J. Spencer#include "llvm/Support/Mutex.h"
16b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
17b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===----------------------------------------------------------------------===//
18b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//=== WARNING: Implementation here must contain only TRULY operating system
19b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===          independent code.
20b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer//===----------------------------------------------------------------------===//
21b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
2208b73a30bbb6407c7b48a734a29f65f4c8ddd782Dylan Noblesmith#if !defined(LLVM_ENABLE_THREADS) || LLVM_ENABLE_THREADS == 0
230a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer// Define all methods as no-ops if threading is explicitly disabled
246d2352249af8853c8307a7cf679017b32d27958cJeff Cohennamespace llvm {
256d2352249af8853c8307a7cf679017b32d27958cJeff Cohenusing namespace sys;
26b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::MutexImpl( bool recursive) { }
27b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::~MutexImpl() { }
28b849a4dd4bee9ad17e295691087ce09e8d77d685Owen Andersonbool MutexImpl::acquire() { return true; }
29b849a4dd4bee9ad17e295691087ce09e8d77d685Owen Andersonbool MutexImpl::release() { return true; }
30b849a4dd4bee9ad17e295691087ce09e8d77d685Owen Andersonbool MutexImpl::tryacquire() { return true; }
310a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer}
320a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer#else
330a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer
340a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer#if defined(HAVE_PTHREAD_H) && defined(HAVE_PTHREAD_MUTEX_LOCK)
356d2352249af8853c8307a7cf679017b32d27958cJeff Cohen
36b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#include <cassert>
37b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#include <pthread.h>
38b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#include <stdlib.h>
39b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
400a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencernamespace llvm {
410a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencerusing namespace sys;
420a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer
43b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer// Construct a Mutex using pthread calls
44b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::MutexImpl( bool recursive)
45b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer  : data_(0)
46b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer{
4749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Declare the pthread_mutex data structures
4849c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_t* mutex =
4949c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie    static_cast<pthread_mutex_t*>(malloc(sizeof(pthread_mutex_t)));
5049c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutexattr_t attr;
5149c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie
5249c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Initialize the mutex attributes
5349c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  int errorcode = pthread_mutexattr_init(&attr);
545b8a1db7ea6510a2589f710d50754599da742de9Duncan Sands  assert(errorcode == 0); (void)errorcode;
5549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie
5649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Initialize the mutex as a recursive mutex, if requested, or normal
5749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // otherwise.
5849c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  int kind = ( recursive  ? PTHREAD_MUTEX_RECURSIVE : PTHREAD_MUTEX_NORMAL );
5949c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  errorcode = pthread_mutexattr_settype(&attr, kind);
6049c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(errorcode == 0);
61b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
62b0f6759ab93b42570d71665b13d24ca2c4a5f276Eric Christopher#if !defined(__FreeBSD__) && !defined(__OpenBSD__) && !defined(__NetBSD__) && \
63b0f6759ab93b42570d71665b13d24ca2c4a5f276Eric Christopher    !defined(__DragonFly__) && !defined(__Bitrig__)
6449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Make it a process local mutex
6549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  errorcode = pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_PRIVATE);
6649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(errorcode == 0);
672499841461a95872a9fe15d310f1d71f94af76d9Reid Spencer#endif
68b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
6949c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Initialize the mutex
7049c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  errorcode = pthread_mutex_init(mutex, &attr);
7149c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(errorcode == 0);
72b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
7349c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Destroy the attributes
7449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  errorcode = pthread_mutexattr_destroy(&attr);
7549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(errorcode == 0);
76b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
7749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  // Assign the data member
7849c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  data_ = mutex;
79b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
80b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
81b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer// Destruct a Mutex
82b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::~MutexImpl()
83b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer{
8449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_t* mutex = static_cast<pthread_mutex_t*>(data_);
8549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(mutex != 0);
8649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_destroy(mutex);
8749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  free(mutex);
88b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
89b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
9000b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohenbool
91b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::acquire()
92b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer{
9349c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_t* mutex = static_cast<pthread_mutex_t*>(data_);
9449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(mutex != 0);
9549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie
9649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  int errorcode = pthread_mutex_lock(mutex);
9749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  return errorcode == 0;
98b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
99b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
10000b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohenbool
101b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::release()
102b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer{
10349c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_t* mutex = static_cast<pthread_mutex_t*>(data_);
10449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(mutex != 0);
10549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie
10649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  int errorcode = pthread_mutex_unlock(mutex);
10749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  return errorcode == 0;
108b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
109b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
11000b16889ab461b7ecef1c91ade101186b7f1fce2Jeff Cohenbool
111b849a4dd4bee9ad17e295691087ce09e8d77d685Owen AndersonMutexImpl::tryacquire()
112b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer{
11349c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  pthread_mutex_t* mutex = static_cast<pthread_mutex_t*>(data_);
11449c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  assert(mutex != 0);
11549c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie
11649c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  int errorcode = pthread_mutex_trylock(mutex);
11749c0a9ac989848844f0eb8894ef7ae6b8dde3495David Blaikie  return errorcode == 0;
118b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
119b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer
120b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer}
1216d2352249af8853c8307a7cf679017b32d27958cJeff Cohen
122b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#elif defined(LLVM_ON_UNIX)
123b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#include "Unix/Mutex.inc"
124b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#elif defined( LLVM_ON_WIN32)
1251f6efa3996dd1929fbc129203ce5009b620e6969Michael J. Spencer#include "Windows/Mutex.inc"
126b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#else
1272c607b665dbeb52e2ade86f0e1f191695290da3bDaniel Dunbar#warning Neither LLVM_ON_UNIX nor LLVM_ON_WIN32 was set in Support/Mutex.cpp
128b2164e5cb5086f0595e96fdbb5ffc614dea9c441Reid Spencer#endif
1290a262ba7c3250ef02833fae864459ccc905a2e9bReid Spencer#endif
130