Changeset 2843 for pjproject/trunk

Timestamp:

Jul 22, 2009 11:12:35 AM (15 years ago)

Author:

bennylp

Message:

Ticket #922: Option to enable mutex related logging to assist troubleshooting concurrency problems

Location:

pjproject/trunk/pjlib

Files:

• include/pj/config.h (modified) (1 diff)
• include/pj/os.h (modified) (1 diff)
• src/pj/os_core_win32.c (modified) (13 diffs)

pjproject/trunk/pjlib/include/pj/config.h

@@ -327 +327 @@
 #    define PJ_DEBUG                0
 #  endif
+#endif
+
+/**
+ * Enable this macro to activate logging to mutex/semaphore related events.
+ * This is useful to troubleshoot concurrency problems such as deadlocks.
+ * In addition, you should also add PJ_LOG_HAS_THREAD_ID flag to the
+ * log decoration to assist the troubleshooting.
+ *
+ * Default: 0
+ */
+#ifndef PJ_DEBUG_MUTEX
+#   define PJ_DEBUG_MUTEX           0
 #endif
 

pjproject/trunk/pjlib/include/pj/os.h

@@ -676 +676 @@
  * @return          Non-zero if yes.
  */
-#if defined(PJ_DEBUG) && PJ_DEBUG != 0
-   PJ_DECL(pj_bool_t) pj_mutex_is_locked(pj_mutex_t *mutex);
-#else
-#  define pj_mutex_is_locked(mutex)         1
-#endif
+PJ_DECL(pj_bool_t) pj_mutex_is_locked(pj_mutex_t *mutex);
 
 /**

pjproject/trunk/pjlib/src/pj/os_core_win32.c

@@ -39 +39 @@
 #endif
 
+/* Activate mutex related logging if PJ_DEBUG_MUTEX is set, otherwise
+ * use default level 6 logging.
+ */
+#if defined(PJ_DEBUG_MUTEX) && PJ_DEBUG_MUTEX
+#   undef PJ_DEBUG
+#   define PJ_DEBUG         1
+#   define LOG_MUTEX(expr)  PJ_LOG(5,expr)
+#else
+#   define LOG_MUTEX(expr)  PJ_LOG(6,expr)
+#endif
+
 #define THIS_FILE       "os_core_win32.c"
 
@@ -905 +916 @@
     PJ_ASSERT_RETURN(mutex, PJ_EINVAL);
 
-    PJ_LOG(6,(mutex->obj_name, "Mutex: thread %s is waiting", 
+    LOG_MUTEX((mutex->obj_name, "Mutex: thread %s is waiting", 
                                 pj_thread_this()->obj_name));
 
@@ -918 +929 @@
 
 #endif
-    PJ_LOG(6,(mutex->obj_name, 
+    LOG_MUTEX((mutex->obj_name, 
               (status==PJ_SUCCESS ? "Mutex acquired by thread %s" : "FAILED by %s"),
               pj_thread_this()->obj_name));
@@ -949 +960 @@
 #endif
 
-    PJ_LOG(6,(mutex->obj_name, "Mutex released by thread %s", 
+    LOG_MUTEX((mutex->obj_name, "Mutex released by thread %s", 
                                 pj_thread_this()->obj_name));
 
@@ -972 +983 @@
     PJ_ASSERT_RETURN(mutex, PJ_EINVAL);
 
-    PJ_LOG(6,(mutex->obj_name, "Mutex: thread %s is trying", 
+    LOG_MUTEX((mutex->obj_name, "Mutex: thread %s is trying", 
                                 pj_thread_this()->obj_name));
 
@@ -982 +993 @@
 #endif
     if (status==PJ_SUCCESS) {
-        PJ_LOG(6,(mutex->obj_name, "Mutex acquired by thread %s", 
+        LOG_MUTEX((mutex->obj_name, "Mutex acquired by thread %s", 
                                   pj_thread_this()->obj_name));
 
@@ -990 +1001 @@
 #endif
     } else {
-        PJ_LOG(6,(mutex->obj_name, "Mutex: thread %s's trylock() failed", 
+        LOG_MUTEX((mutex->obj_name, "Mutex: thread %s's trylock() failed", 
                                     pj_thread_this()->obj_name));
     }
@@ -1005 +1016 @@
     PJ_ASSERT_RETURN(mutex, PJ_EINVAL);
 
-    PJ_LOG(6,(mutex->obj_name, "Mutex destroyed"));
+    LOG_MUTEX((mutex->obj_name, "Mutex destroyed"));
 
 #if PJ_WIN32_WINNT >= 0x0400
@@ -1016 +1027 @@
 }
 
+/*
+ * pj_mutex_is_locked()
+ */
+PJ_DEF(pj_bool_t) pj_mutex_is_locked(pj_mutex_t *mutex)
+{
 #if PJ_DEBUG
-/*
- * pj_mutex_is_locked()
- */
-PJ_DEF(pj_bool_t) pj_mutex_is_locked(pj_mutex_t *mutex)
-{
     return mutex->owner == pj_thread_this();
-}
-#endif
+#else
+    pj_assert(!"PJ_DEBUG is not set!");
+    return 1;
+#endif
+}
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -1083 +1097 @@
     }
 
-    PJ_LOG(6, (sem->obj_name, "Semaphore created"));
+    LOG_MUTEX((sem->obj_name, "Semaphore created"));
 
     *sem_ptr = sem;
@@ -1096 +1110 @@
     PJ_ASSERT_RETURN(sem, PJ_EINVAL);
 
-    PJ_LOG(6, (sem->obj_name, "Semaphore: thread %s is waiting", 
+    LOG_MUTEX((sem->obj_name, "Semaphore: thread %s is waiting", 
                               pj_thread_this()->obj_name));
 
     result = WaitForSingleObject(sem->hSemaphore, timeout);
     if (result == WAIT_OBJECT_0) {
-        PJ_LOG(6, (sem->obj_name, "Semaphore acquired by thread %s", 
+        LOG_MUTEX((sem->obj_name, "Semaphore acquired by thread %s", 
                                   pj_thread_this()->obj_name));
     } else {
-        PJ_LOG(6, (sem->obj_name, "Semaphore: thread %s FAILED to acquire", 
+        LOG_MUTEX((sem->obj_name, "Semaphore: thread %s FAILED to acquire", 
                                   pj_thread_this()->obj_name));
     }
@@ -1146 +1160 @@
     PJ_ASSERT_RETURN(sem, PJ_EINVAL);
 
-    PJ_LOG(6, (sem->obj_name, "Semaphore released by thread %s",
+    LOG_MUTEX((sem->obj_name, "Semaphore released by thread %s",
                               pj_thread_this()->obj_name));
 
@@ -1163 +1177 @@
     PJ_ASSERT_RETURN(sem, PJ_EINVAL);
 
-    PJ_LOG(6, (sem->obj_name, "Semaphore destroyed by thread %s",
+    LOG_MUTEX((sem->obj_name, "Semaphore destroyed by thread %s",
                               pj_thread_this()->obj_name));