c++11知识点2_thread_mutex锁类型

1.概述
1.1.std::lock_guard
与 Mutex RAII 相关，方便线程对互斥量上锁。


构造函数:
(1)lock_guard 对象管理 Mutex 对象 m，并在构造时对 m 进行上锁（调用 m.lock()）。
explicit lock_guard (mutex_type& m);
(2)lock_guard 对象管理 Mutex 对象 m，与 locking 初始化(1) 不同的是， Mutex 对象 m 已被当前线程锁住。
lock_guard (mutex_type& m, adopt_lock_t tag);
(3)lock_guard 对象的拷贝构造和移动构造(move construction)均被禁用，因此 lock_guard 对象不可被拷贝构造或移动构造。
lock_guard (const lock_guard&) = delete;


实例详见2.1.lock_guard例子1。


1.2.std::unique_lock
与 Mutex RAII 相关，方便线程对互斥量上锁，但提供了更好的上锁和解锁控制。
unique_lock 对象以独占所有权的方式（ unique owership）管理 mutex 对象的上锁和解锁操作，所谓独占所有权，就是没有其
他的 unique_lock 对象同时拥有某个 mutex 对象的所有权。


在构造(或移动(move)赋值)时，unique_lock 对象需要传递一个 Mutex 对象作为它的参数，新创建的 unique_lock 对象负责
传入的 Mutex 对象的上锁和解锁操作。


std::unique_lock 对象也能保证在其自身析构时它所管理的 Mutex 对象能够被正确地解锁（即使没有显式地调用 unlock 函数）。
因此，和 lock_guard 一样，这也是一种简单而又安全的上锁和解锁方式，尤其是在程序抛出异常后先前已被上锁的 Mutex 对象可以
正确进行解锁操作，极大地简化了程序员编写与 Mutex 相关的异常处理代码。


值得注意的是，unique_lock 对象同样也不负责管理 Mutex 对象的生命周期，unique_lock 对象只是简化了 Mutex 对象的上锁和
解锁操作，方便线程对互斥量上锁，即在某个 unique_lock 对象的声明周期内，它所管理的锁对象会一直保持上锁状态；而 unique_lock 的生命周期结束之后，它所管理的锁对象会被解锁，这一点和 lock_guard 类似，但 unique_lock 给程序员提供了更多的自由，我会
在下面的内容中给大家介绍 unique_lock 的用法。


另外，与 lock_guard 一样，模板参数 Mutex 代表互斥量类型，例如 std::mutex 类型，它应该是一个基本的 BasicLockable 
类型，标准库中定义几种基本的 BasicLockable 类型，分别 std::mutex, std::recursive_mutex, std::timed_mutex，
std::recursive_timed_mutex。 
注：BasicLockable 类型的对象只需满足两种操作，lock 和 unlock，另外还有 Lockable 类型，在 BasicLockable 类型的
  基础上新增了 try_lock 操作，因此一个满足 Lockable 的对象应支持三种操作：lock，unlock 和 try_lock；最后还有一种 
  TimedLockable 对象，在 Lockable 类型的基础上又新增了 try_lock_for 和 try_lock_until 两种操作，因此一个满足 
  TimedLockable 的对象应支持五种操作：lock, unlock, try_lock, try_lock_for, try_lock_until。


构造函数:
(1) 默认构造函数
新创建的 unique_lock 对象不管理任何 Mutex 对象。
unique_lock() noexcept;


(2) locking 初始化
新创建的 unique_lock 对象管理 Mutex 对象 m，并尝试调用 m.lock() 对 Mutex 对象进行上锁，如果此时另外某个 
unique_lock 对象已经管理了该 Mutex 对象 m，则当前线程将会被阻塞。
explicit unique_lock(mutex_type& m);


(3) try-locking 初始化
新创建的 unique_lock 对象管理 Mutex 对象 m，并尝试调用 m.try_lock() 对 Mutex 对象进行上锁，但如果上锁不成功，
并不会阻塞当前线程。
unique_lock(mutex_type& m, try_to_lock_t tag);


(4) deferred 初始化
新创建的 unique_lock 对象管理 Mutex 对象 m，但是在初始化的时候并不锁住 Mutex 对象。 m 应该是一个没有当前线程锁住的 Mutex 对象。
unique_lock(mutex_type& m, defer_lock_t tag) noexcept;


(5) adopting 初始化
新创建的 unique_lock 对象管理 Mutex 对象 m， m 应该是一个已经被当前线程锁住的 Mutex 对象。(并且当前新创建的 
unique_lock 对象拥有对锁(Lock)的所有权)。
unique_lock(mutex_type& m, adopt_lock_t tag);


(6) locking 一段时间(duration)
新创建的 unique_lock 对象管理 Mutex 对象 m，并试图通过调用 m.try_lock_for(rel_time) 来锁住 Mutex 对象一段时间(rel_time)。
template <class Rep, class Period>
unique_lock(mutex_type& m, const chrono::duration<Rep,Period>& rel_time);


(7) locking 直到某个时间点(time point)
新创建的 unique_lock 对象管理 Mutex 对象m，并试图通过调用 m.try_lock_until(abs_time) 来在某个时间点(abs_time)
之前锁住 Mutex 对象。
template <class Clock, class Duration>
unique_lock(mutex_type& m, const chrono::time_point<Clock,Duration>& abs_time);


(8) 拷贝构造 [被禁用]
unique_lock& operator=unique_lock(const unique_lock&) = delete;


(9) 移动(move)构造
新创建的 unique_lock 对象获得了由 x 所管理的 Mutex 对象的所有权(包括当前 Mutex 的状态)。调用 move 构造之后， 
x 对象如同通过默认构造函数所创建的，就不再管理任何 Mutex 对象了。
unique_lock& operator=unique_lock(unique_lock&& x);
详见2.4.unique_lock的赋值。


成员函数分类：
(1)上锁/解锁操作：lock，try_lock，try_lock_for，try_lock_until 和 unlock
(2)修改操作：移动赋值(move assignment)(前面已经介绍过了)，交换(swap)（与另一个 std::unique_lock 对象交换它们所管理的 Mutex 对象的所有权），释放(release)（返回指向它所管理的 Mutex 对象的指针，并释放所有权）
(3)获取属性操作：owns_lock（返回当前 std::unique_lock 对象是否获得了锁）、operator bool()（与 owns_lock 功能相同，返回当前 
std::unique_lock 对象是否获得了锁）、mutex（返回当前 std::unique_lock 对象所管理的 Mutex 对象的指针）。


主要成员函数：
(1)std::unique_lock::lock
上锁操作，调用它所管理的 Mutex 对象的 lock 函数。如果在调用  Mutex 对象的 lock 函数时该 Mutex 对象已被另一线程锁住，
则当前线程会被阻塞，直到它获得了锁。
该函数返回时，当前的 unique_lock 对象便拥有了它所管理的 Mutex 对象的锁。如果上锁操作失败，则抛出 system_error 异常。
详见2.5.unique_lock的上锁例子1。


(2)std::unique_lock::try_lock
上锁操作，调用它所管理的 Mutex 对象的 try_lock 函数，如果上锁成功，则返回 true，否则返回 false。
详见2.6.unique_lock的上锁例子2。


(3)std::unique_lock::try_lock_until
上锁操作，调用它所管理的 Mutex 对象的 try_lock_for 函数，如果上锁成功，则返回 true，否则返回 false。
详见2.7.unique_lock的上锁例子3。


(4)std::unique_lock::unlock
解锁操作，调用它所管理的 Mutex 对象的 unlock 函数。
详见2.8.unique_lock的解锁例子1。


(5)std::unique_lock::release
返回指向它所管理的 Mutex 对象的指针，并释放所有权。
详见2.9.unique_lock的释放例子。


(6)std::unique_lock::owns_lock
返回当前 std::unique_lock 对象是否获得了锁。
详见2.10.unique_lock的是否获得了锁例子1。


(7)std::unique_lock::operator bool()
与 owns_lock 功能相同，返回当前 std::unique_lock 对象是否获得了锁。
详见2.11.unique_lock的是否获得了锁例子2。


(8)std::unique_lock::mutex
返回当前 std::unique_lock 对象所管理的 Mutex 对象的指针。
详见2.12.unique_lock的管理的 Mutex 对象指针例子。


1.3.锁类型相关的 Tag 类
(1)std::adopt_lock_t
一个空的标记类，定义如下：
struct adopt_lock_t {};


该类型的常量对象adopt_lock是一个常量对象，定义如下：
constexpr adopt_lock_t adopt_lock {};


通常作为参数传入给 unique_lock 或 lock_guard 的构造函数。


(2)std::defer_lock_t
一个空的标记类，定义如下：
struct defer_lock_t {};
 
该类型的常量对象 defer_lock是一个常量对象，定义如下：
constexpr defer_lock_t defer_lock {};


通常作为参数传入给 unique_lock 或 lock_guard 的构造函数。


(3)std::try_to_lock_t
一个空的标记类，定义如下：
struct try_to_lock_t {};


该类型的常量对象 try_to_lock是一个常量对象，定义如下：
constexpr try_to_lock_t try_to_lock {};


通常作为参数传入给 unique_lock 或 lock_guard 的构造函数。




2.实例
2.1.lock_guard例子1
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::lock_guard, std::adopt_lock


std::mutex mtx;           // mutex for critical section


void print_thread_id (int id) {
  mtx.lock();
  std::lock_guard<std::mutex> lck(mtx, std::adopt_lock);
  std::cout << "thread #" << id << '\n';
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(print_thread_id,i+1);


  for (auto& th : threads) th.join();


  return 0;
}


在 print_thread_id 中，我们首先对 mtx 进行上锁操作(mtx.lock();)，然后用 mtx 对象构造一个 
lock_guard 对象(std::lock_guard<std::mutex> lck(mtx, std::adopt_lock);)，注意此时 
Tag 参数为 std::adopt_lock，表明当前线程已经获得了锁，此后 mtx 对象的解锁操作交由 lock_guard 
对象 lck 来管理，在 lck 的生命周期结束之后，mtx 对象会自动解锁。


2.2.lock_guard例子2
//在异常抛出的时候通过 lock_guard 对象管理的 Mutex 可以得到正确地解锁。
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::lock_guard
#include <stdexcept>      // std::logic_error


std::mutex mtx;


void print_even (int x) {
  if (x%2==0) std::cout << x << " is even\n";
  else throw (std::logic_error("not even"));
}


void print_thread_id (int id) {
  try {
    // using a local lock_guard to lock mtx guarantees unlocking on destruction / exception:
    std::lock_guard<std::mutex> lck (mtx);
    print_even(id);
  }
  catch (std::logic_error&) {
    std::cout << "[exception caught]\n";
  }
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(print_thread_id,i+1);


  for (auto& th : threads) th.join();


  return 0;
}


2.3.unique_lock的使用例子
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::lock, std::unique_lock
                          // std::adopt_lock, std::defer_lock
std::mutex foo,bar;


void task_a () {
  std::lock (foo,bar);         // simultaneous lock (prevents deadlock)
  std::unique_lock<std::mutex> lck1 (foo,std::adopt_lock);
  std::unique_lock<std::mutex> lck2 (bar,std::adopt_lock);
  std::cout << "task a\n";
  // (unlocked automatically on destruction of lck1 and lck2)
}


void task_b () {
  // foo.lock(); bar.lock(); // replaced by:
  std::unique_lock<std::mutex> lck1, lck2;
  lck1 = std::unique_lock<std::mutex>(bar,std::defer_lock);
  lck2 = std::unique_lock<std::mutex>(foo,std::defer_lock);
  std::lock (lck1,lck2);       // simultaneous lock (prevents deadlock)
  std::cout << "task b\n";
  // (unlocked automatically on destruction of lck1 and lck2)
}


int main (){
  std::thread th1 (task_a);
  std::thread th2 (task_b);


  th1.join();
  th2.join();


  return 0;
}


2.4.unique_lock的赋值例子
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock


std::mutex mtx;           // mutex for critical section


void print_fifty (char c) {
  std::unique_lock<std::mutex> lck;         // default-constructed
  lck = std::unique_lock<std::mutex>(mtx);  // move-assigned
  for (int i=0; i<50; ++i) { std::cout << c; }
  std::cout << '\n';
}


int main (){
  std::thread th1 (print_fifty,'*');
  std::thread th2 (print_fifty,'$');


  th1.join();
  th2.join();


  return 0;
}


2.5.unique_lock的上锁例子1
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock, std::defer_lock


std::mutex mtx;           // mutex for critical section


void print_thread_id (int id) {
  std::unique_lock<std::mutex> lck (mtx,std::defer_lock);
  // critical section (exclusive access to std::cout signaled by locking lck):
  lck.lock();
  std::cout << "thread #" << id << '\n';
  lck.unlock();
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(print_thread_id,i+1);


  for (auto& th : threads) th.join();


  return 0;
}


2.6.unique_lock的上锁例子2
#include <iostream>       // std::cout
#include <chrono>         // std::chrono::milliseconds
#include <thread>         // std::thread
#include <mutex>          // std::timed_mutex, std::unique_lock, std::defer_lock


std::timed_mutex mtx;


void fireworks () {
  std::unique_lock<std::timed_mutex> lck(mtx,std::defer_lock);
  // waiting to get a lock: each thread prints "-" every 200ms:
  while (!lck.try_lock_for(std::chrono::milliseconds(200))) {
    std::cout << "-";
  }
  // got a lock! - wait for 1s, then this thread prints "*"
  std::this_thread::sleep_for(std::chrono::milliseconds(1000));
  std::cout << "*\n";
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(fireworks);


  for (auto& th : threads) th.join();


  return 0;
}


2.7.unique_lock的上锁例子3
#include <iostream>       // std::cout
#include <chrono>         // std::chrono::milliseconds
#include <thread>         // std::thread
#include <mutex>          // std::timed_mutex, std::unique_lock, std::defer_lock


std::timed_mutex mtx;


void fireworks () {
  std::unique_lock<std::timed_mutex> lck(mtx,std::defer_lock);
  // waiting to get a lock: each thread prints "-" every 200ms:
  while (!lck.try_lock_for(std::chrono::milliseconds(200))) {
    std::cout << "-";
  }
  // got a lock! - wait for 1s, then this thread prints "*"
  std::this_thread::sleep_for(std::chrono::milliseconds(1000));
  std::cout << "*\n";
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(fireworks);


  for (auto& th : threads) th.join();


  return 0;
}


2.8.unique_lock的解锁例子1
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock, std::defer_lock


std::mutex mtx;           // mutex for critical section


void print_thread_id (int id) {
  std::unique_lock<std::mutex> lck (mtx,std::defer_lock);
  // critical section (exclusive access to std::cout signaled by locking lck):
  lck.lock();
  std::cout << "thread #" << id << '\n';
  lck.unlock();
}


int main (){
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(print_thread_id,i+1);


  for (auto& th : threads) th.join();


  return 0;
}


2.9.unique_lock的释放例子
#include <iostream>       // std::cout
#include <vector>         // std::vector
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock


std::mutex mtx;
int count = 0;


void print_count_and_unlock (std::mutex* p_mtx) {
  std::cout << "count: " << count << '\n';
  p_mtx->unlock();
}


void task() {
  std::unique_lock<std::mutex> lck(mtx);
  ++count;
  print_count_and_unlock(lck.release());
}


int main (){
  std::vector<std::thread> threads;
  for (int i=0; i<10; ++i)
    threads.emplace_back(task);


  for (auto& x: threads) x.join();


  return 0;
}


2.10.unique_lock的是否获得了锁例子1
#include <iostream>       // std::cout
#include <vector>         // std::vector
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock, std::try_to_lock


std::mutex mtx;           // mutex for critical section


void print_star () {
  std::unique_lock<std::mutex> lck(mtx,std::try_to_lock);
  // print '*' if successfully locked, 'x' otherwise: 
  if (lck.owns_lock())
    std::cout << '*';
  else                    
    std::cout << 'x';
}


int main ()
{
  std::vector<std::thread> threads;
  for (int i=0; i<500; ++i)
    threads.emplace_back(print_star);


  for (auto& x: threads) x.join();


  return 0;
}


2.11.unique_lock的是否获得了锁例子2
#include <iostream>       // std::cout
#include <vector>         // std::vector
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock, std::try_to_lock


std::mutex mtx;           // mutex for critical section


void print_star () {
  std::unique_lock<std::mutex> lck(mtx,std::try_to_lock);
  // print '*' if successfully locked, 'x' otherwise: 
  if (lck)
    std::cout << '*';
  else                    
    std::cout << 'x';
}


int main ()
{
  std::vector<std::thread> threads;
  for (int i=0; i<500; ++i)
    threads.emplace_back(print_star);


  for (auto& x: threads) x.join();


  return 0;
}


2.12.unique_lock的管理的 Mutex 对象指针例子
#include <iostream>       // std::cout
#include <thread>         // std::thread
#include <mutex>          // std::mutex, std::unique_lock, std::defer_lock


class MyMutex : public std::mutex {
  int _id;
public:
  MyMutex (int id) : _id(id) {}
  int id() {return _id;}
};


MyMutex mtx (101);


void print_ids (int id) {
  std::unique_lock<MyMutex> lck (mtx);
  std::cout << "thread #" << id << " locked mutex " << lck.mutex()->id() << '\n';
}


int main ()
{
  std::thread threads[10];
  // spawn 10 threads:
  for (int i=0; i<10; ++i)
    threads[i] = std::thread(print_ids,i+1);


  for (auto& th : threads) th.join();


  return 0;
}