framework/delibs/decpp/deSpinBarrier.hpp

   1 #ifndef _DESPINBARRIER_HPP
   2 #define _DESPINBARRIER_HPP
   3 /*-------------------------------------------------------------------------
   4  * drawElements C++ Base Library
   5  * -----------------------------
   6  *
   7  * Copyright 2015 The Android Open Source Project
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  *//*!
  22  * \file
  23  * \brief Cross-thread barrier.
  24  *//*--------------------------------------------------------------------*/
  25
  26 #include "deDefs.hpp"
  27 #include "deAtomic.h"
  28
  29 namespace de
  30 {
  31
  32 /*--------------------------------------------------------------------*//*!
  33  * \brief Cross-thread barrier
  34  *
  35  * SpinBarrier provides barrier implementation that uses spin loop for
  36  * waiting for other threads. Threads may choose to wait in tight loop
  37  * (WAIT_MODE_BUSY) or yield between iterations (WAIT_MODE_YIELD).
  38  *//*--------------------------------------------------------------------*/
  39 class SpinBarrier
  40 {
  41 public:
  42         enum WaitMode
  43         {
  44                 WAIT_MODE_BUSY = 0,
  45                 WAIT_MODE_YIELD,
  46
  47                 WAIT_MODE_LAST
  48         };
  49
  50                                                 SpinBarrier             (deInt32 numThreads);
  51                                                 ~SpinBarrier    (void);
  52
  53         void                            sync                    (WaitMode mode);
  54
  55 private:
  56                                                 SpinBarrier             (const SpinBarrier&);
  57         SpinBarrier                     operator=               (const SpinBarrier&);
  58
  59         const deInt32           m_numThreads;
  60         volatile deInt32        m_numEntered;
  61         volatile deInt32        m_numLeaving;
  62 };
  63
  64 void    SpinBarrier_selfTest    (void);
  65
  66 } // de
  67
  68 #endif // _DESPINBARRIER_HPP