dali/internal/common/mutex-impl.h

   1 #ifndef __DALI_INTERNAL_MUTEX_H__
   2 #define __DALI_INTERNAL_MUTEX_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 #include <pthread.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 /**
  31  * @brief Namespace to ensure mutex locking is done correctly.
  32  *
  33  * Displays warnings if two mutex locks are not held by the same thread at any given time which can lead to deadlock.
  34  * This can lead to deadlock and should be avoided.
  35  *
  36  * @note lock backtrace needs to be enabled to see the warnings.
  37  */
  38 namespace Mutex
  39 {
  40
  41 /**
  42  * @brief Locks the given mutex.
  43  *
  44  * Increments a thread-local storage counter.
  45  *
  46  * @param A pointer to the mutex that should be locked.
  47  *
  48  * @note If the counter is > 1 and lock backtrace is enabled, then the backtrace for all locks will be shown as a warning.
  49  */
  50 void Lock( pthread_mutex_t* mutex );
  51
  52 /**
  53  * @brief Unlocks the given mutex.
  54  *
  55  * @param A pointer to the mutex that should be unlocked.
  56  *
  57  * Decrements a thread-local storage counter.
  58  */
  59 void Unlock( pthread_mutex_t* mutex );
  60
  61 } // namespace Mutex
  62
  63 } // namespace Internal
  64
  65 } // namespace Dali
  66
  67 #endif // __DALI_INTERNAL_MUTEX_H__