code.vuplus.com Git - vuplus_xbmc/blob - xbmc/threads/Lockables.h

   1 /*
   2  *      Copyright (C) 2005-2013 Team XBMC
   3  *      http://www.xbmc.org
   4  *
   5  *  This Program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This Program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with XBMC; see the file COPYING.  If not, see
  17  *  <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 #pragma once
  22
  23 #include "threads/Helpers.h"
  24
  25 namespace XbmcThreads
  26 {
  27
  28   /**
  29    * This template will take any implementation of the "Lockable" concept
  30    * and allow it to be used as an "Exitable Lockable."
  31    *
  32    * Something that implements the "Lockable concept" simply means that
  33    * it has the three methods:
  34    *
  35    *   lock();
  36    *   try_lock();
  37    *   unlock();
  38    *
  39    * "Exitable" specifially means that, no matter how deep the recursion
  40    * on the mutex/critical section, we can exit from it and then restore
  41    * the state.
  42    *
  43    * This requires us to extend the Lockable so that we can keep track of the
  44    * number of locks that have been recursively acquired so that we can
  45    * undo it, and then restore that (See class CSingleExit).
  46    *
  47    * All xbmc code expects Lockables to be recursive.
  48    */
  49   template<class L> class CountingLockable : public NonCopyable
  50   {
  51   protected:
  52     L mutex;
  53     unsigned int count;
  54
  55   public:
  56     inline CountingLockable() : count(0) {}
  57
  58     // boost::thread Lockable concept
  59     inline void lock() { mutex.lock(); count++; }
  60     inline bool try_lock() { return mutex.try_lock() ? count++, true : false; }
  61     inline void unlock() { count--; mutex.unlock(); }
  62
  63     /**
  64      * This implements the "exitable" behavior mentioned above.
  65      */
  66     inline unsigned int exit()
  67     {
  68       // it's possibe we don't actually own the lock
  69       // so we will try it.
  70       unsigned int ret = 0;
  71       if (try_lock())
  72       {
  73         ret = count - 1;  // The -1 is because we don't want
  74                           //  to count the try_lock increment.
  75         // We must NOT compare "count" in this loop since
  76         // as soon as the last unlock is called another thread
  77         // can modify it.
  78         for (unsigned int i = 0; i <= ret; i++) // This will also unlock the try_lock.
  79           unlock();
  80       }
  81
  82       return ret;
  83     }
  84
  85     /**
  86      * Restore a previous exit to the provided level.
  87      */
  88     inline void restore(unsigned int restoreCount)
  89     {
  90       for (unsigned int i = 0; i < restoreCount; i++)
  91         lock();
  92     }
  93
  94     /**
  95      * Some implementations (see pthreads) require access to the underlying
  96      *  CCriticalSection, which is also implementation specific. This
  97      *  provides access to it through the same method on the guard classes
  98      *  UniqueLock, and SharedLock.
  99      *
 100      * There really should be no need for the users of the threading library
 101      *  to call this method.
 102      */
 103     inline L& get_underlying() { return mutex; }
 104   };
 105
 106
 107   /**
 108    * This template can be used to define the base implementation for any UniqueLock
 109    * (such as CSingleLock) that uses a Lockable as its mutex/critical section.
 110    */
 111   template<typename L> class UniqueLock : public NonCopyable
 112   {
 113   protected:
 114     L& mutex;
 115     bool owns;
 116     inline UniqueLock(L& lockable) : mutex(lockable), owns(true) { mutex.lock(); }
 117     inline UniqueLock(L& lockable, bool try_to_lock_discrim ) : mutex(lockable) { owns = mutex.try_lock(); }
 118     inline ~UniqueLock() { if (owns) mutex.unlock(); }
 119
 120   public:
 121
 122     inline bool owns_lock() const { return owns; }
 123
 124     //This also implements lockable
 125     inline void lock() { mutex.lock(); owns=true; }
 126     inline bool try_lock() { return (owns = mutex.try_lock()); }
 127     inline void unlock() { if (owns) { mutex.unlock(); owns=false; } }
 128
 129     /**
 130      * See the note on the same method on CountingLockable
 131      */
 132     inline L& get_underlying() { return mutex; }
 133   };
 134
 135   /**
 136    * This template can be used to define the base implementation for any SharedLock
 137    * (such as CSharedLock) that uses a Shared Lockable as its mutex/critical section.
 138    *
 139    * Something that implements the "Shared Lockable" concept has all of the methods
 140    * required by the Lockable concept and also:
 141    *
 142    * void lock_shared();
 143    * bool try_lock_shared();
 144    * void unlock_shared();
 145    */
 146   template<typename L> class SharedLock : public NonCopyable
 147   {
 148   protected:
 149     L& mutex;
 150     bool owns;
 151     inline SharedLock(L& lockable) : mutex(lockable), owns(true) { mutex.lock_shared(); }
 152     inline ~SharedLock() { if (owns) mutex.unlock_shared(); }
 153
 154     inline bool owns_lock() const { return owns; }
 155     inline void lock() { mutex.lock_shared(); owns = true; }
 156     inline bool try_lock() { return (owns = mutex.try_lock_shared()); }
 157     inline void unlock() { if (owns) mutex.unlock_shared(); owns = false; }
 158
 159     /**
 160      * See the note on the same method on CountingLockable
 161      */
 162     inline L& get_underlying() { return mutex; }
 163   };
 164
 165
 166 }