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