about summary refs log tree commit diff
path: root/src/libstd/sys/windows/mutex.rs
blob: 0847f3b52bfabe171e370bed4e1b6a43cb75bfa5 (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
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use prelude::v1::*;

use cell::UnsafeCell;
use sys::sync as ffi;

pub struct Mutex { inner: UnsafeCell<ffi::SRWLOCK> }

pub const MUTEX_INIT: Mutex = Mutex {
    inner: UnsafeCell { value: ffi::SRWLOCK_INIT }
};

unsafe impl Send for Mutex {}
unsafe impl Sync for Mutex {}

#[inline]
pub unsafe fn raw(m: &Mutex) -> ffi::PSRWLOCK {
    m.inner.get()
}

// So you might be asking why we're using SRWLock instead of CriticalSection?
//
// 1. SRWLock is several times faster than CriticalSection according to
//    benchmarks performed on both Windows 8 and Windows 7.
//
// 2. CriticalSection allows recursive locking while SRWLock deadlocks. The Unix
//    implementation deadlocks so consistency is preferred. See #19962 for more
//    details.
//
// 3. While CriticalSection is fair and SRWLock is not, the current Rust policy
//    is there there are no guarantees of fairness.

impl Mutex {
    #[inline]
    pub unsafe fn lock(&self) {
        ffi::AcquireSRWLockExclusive(self.inner.get())
    }
    #[inline]
    pub unsafe fn try_lock(&self) -> bool {
        ffi::TryAcquireSRWLockExclusive(self.inner.get()) != 0
    }
    #[inline]
    pub unsafe fn unlock(&self) {
        ffi::ReleaseSRWLockExclusive(self.inner.get())
    }
    #[inline]
    pub unsafe fn destroy(&self) {
        // ...
    }
}