dali/internal/common/mutex-trace.h

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