dali/integration-api/lockless-buffer.h

   1 #ifndef __DALI_INTEGRATION_LOCKLESS_BUFFER_H__
   2 #define __DALI_INTEGRATION_LOCKLESS_BUFFER_H__
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <cstring>
  25 #include <dali/public-api/common/vector-wrapper.h>
  26 #include <dali/public-api/common/dali-common.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Integration
  32 {
  33
  34 /**
  35  * The LocklessBuffer class implements double buffering eligible for multi-(two) threaded use,
  36  * where it's possible to read from one thread and write from another
  37  * without requiring a mutex lock to avoid performance hit.
  38  * It's intended to be used for reading bitmap data in render thread
  39  * while still possible to write data in another thread.
  40  *
  41  * Ideally Write() and Read() calls should be alternating, otherwise written data might be thrown away.
  42  *
  43  * The buffers are swapped in the reading thread, just before reading begins.
  44  * In case the other thread is writing at that moment, buffers are not swapped and previously available data is read.
  45  * Similarly if Write() is called before a Read() has finished the previous write buffer is overwritten.
  46  */
  47 class DALI_CORE_API LocklessBuffer
  48 {
  49
  50 public:
  51   /**
  52    * Constructor.
  53    * @param[in] size The size of buffers in bytes.
  54    */
  55   LocklessBuffer( size_t size );
  56
  57   /**
  58    * Destructor.
  59    */
  60   ~LocklessBuffer();
  61
  62   /**
  63    * Write data to buffer.
  64    * @param[in] src data source
  65    * @param[in] size size of data in bytes
  66    */
  67   void Write( const unsigned char *src, size_t size );
  68
  69   /**
  70    * Try to swap buffers and read data.
  71    * @note returned value only valid until Read() is called again or object is destroyed
  72    * @return current read buffer contents
  73    */
  74   const unsigned char* Read();
  75
  76   /**
  77    * @return the buffer size in bytes
  78    */
  79   unsigned int GetSize() const;
  80
  81 private:
  82   /**
  83    * Atomically set state.
  84    * We're always writing to one buffer and reading from the other.
  85    * Write() sets WRITING bit when started and unsets it when finished.
  86    */
  87   enum BufferState
  88   {
  89     R0W1    = 0, ///< Read from buffer 0 write to buffer 1
  90     R1W0    = 1, ///< Read from buffer 1 write to buffer 0
  91     WRITING = 2, ///< Currently writing to buffer
  92     UPDATED = 4, ///< Swapping buffer required; there is new data available
  93     WRITE_BUFFER_MASK = 1, ///< indicates which buffer to write to
  94     WRITING_MASK      = 2, ///< indicates whether currently writing
  95     UPDATED_MASK      = 4  ///< indicates whether new data is available
  96   };
  97
  98 private:
  99   LocklessBuffer(); ///< undefined default constructor, need to give size on construction
 100   LocklessBuffer( const LocklessBuffer& );            ///< undefined copy constructor
 101   LocklessBuffer& operator=( const LocklessBuffer& ); ///< undefined assignment operator
 102
 103 private:
 104   unsigned char* mBuffer[2];     ///< bitmap buffers
 105   BufferState volatile mState;   ///< readbuffer number and whether we're currently writing into writebuffer or not
 106   size_t mSize;                  ///< size of buffers
 107 };
 108
 109 } // Internal
 110
 111 } // Dali
 112
 113 #endif // __DALI_INTEGRATION_LOCKLESS_H__