mutex implementation

src/lib/mutex.c

@@ -0,0 +1,44 @@
+/*
+  mutex.c  -  mutex
+
+  Copyright (C)         CinelerraCV
+    2007,               Christian Thaeter <ct@pipapo.org>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "lib/mutex.h"
+
+CinelerraMutex
+cinelerra_mutex_init (CinelerraMutex self)
+{
+  if (self)
+    {
+      pthread_mutex_init (&self->mutex, NULL);
+    }
+  return self;
+}
+
+CinelerraMutex
+cinelerra_mutex_destroy (CinelerraMutex self)
+{
+  if (self)
+    {
+      if (pthread_mutex_destroy (&self->mutex))
+        CINELERRA_DIE;
+    }
+  return self;
+}
+

src/lib/mutex.h

@@ -0,0 +1,136 @@
+/*
+  mutex.h  -  mutal exclusion locking
+
+  Copyright (C)         CinelerraCV
+    2007,               Christian Thaeter <ct@pipapo.org>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef CINELERRA_MUTEX_H
+#define CINELERRA_MUTEX_H
+
+#include "lib/locking.h"
+
+/**
+ * Mutex.
+ *
+ */
+struct cinelerra_mutex_struct
+{
+  pthread_mutex_t mutex;
+};
+typedef struct cinelerra_mutex_struct cinelerra_mutex;
+typedef cinelerra_mutex* CinelerraMutex;
+
+
+/**
+ * Initialize a mutex variable
+ * @param self is a pointer to the mutex to be initialized
+ * @return self as given
+ */
+CinelerraMutex
+cinelerra_mutex_init (CinelerraMutex self);
+
+
+/**
+ * Destroy a mutex variable
+ * @param self is a pointer to the mutex to be destroyed
+ * @return self as given
+ */
+CinelerraMutex
+cinelerra_mutex_destroy (CinelerraMutex self);
+
+
+
+/**
+ * mutexlock used to manage the state of a mutex variable.
+ */
+struct cinelerra_mutexlock_struct
+{
+  CinelerraMutex mutex;
+  enum cinelerra_lockstate  state;
+};
+typedef struct cinelerra_mutexlock_struct cinelerra_mutexlock;
+typedef struct cinelerra_mutexlock_struct* CinelerraMutexlock;
+
+/* helper function for nobug */
+static inline void
+cinelerra_mutexlock_ensureunlocked (CinelerraMutexlock self)
+{
+  ENSURE (self->state == CINELERRA_UNLOCKED, "forgot to unlock mutex");
+}
+
+/* override with a macro to use the cleanup checker */
+#define cinelerra_mutexlock \
+cinelerra_mutexlock NOBUG_CLEANUP(cinelerra_mutexlock_ensureunlocked)
+
+
+/**
+ * initialize a mutexlock state
+ * @param self mutexlock to be initialized, must be an automatic variable
+ * @param mutex associated mutex
+ * @param state initial state of the mutex, either CINELERRA_LOCKED or CINELERRA_UNLOCKED
+ * @return self as given
+ * errors are fatal
+ */
+static inline CinelerraMutexlock
+cinelerra_mutexlock_init (CinelerraMutexlock self, CinelerraMutex mutex, enum cinelerra_lockstate state)
+{
+  REQUIRE (self);
+  REQUIRE (mutex);
+  self->mutex = mutex;
+  self->state = state;
+  if (state == CINELERRA_LOCKED)
+    if (pthread_mutex_lock (&mutex->mutex))
+      CINELERRA_DIE;
+
+  return self;
+}
+
+/**
+ * lock the mutex.
+ * must not already be locked
+ * @param self mutexlock associated with a mutex variable
+ */
+static inline void
+cinelerra_mutexlock_lock (CinelerraMutexlock self)
+{
+  REQUIRE (self);
+  REQUIRE (self->state == CINELERRA_UNLOCKED, "mutex already locked");
+
+  if (pthread_mutex_lock (&self->mutex->mutex))
+    CINELERRA_DIE;
+
+  self->state = CINELERRA_LOCKED;
+}
+
+
+/**
+ * release mutex.
+ * a mutexlock must be unlocked before leaving scope
+ * @param self mutexlock associated with a mutex variable
+ */
+static inline int
+cinelerra_mutexlock_unlock (CinelerraMutexlock self)
+{
+  REQUIRE (self);
+  REQUIRE (self->state == CINELERRA_LOCKED, "mutex was not locked");
+  if (pthread_mutex_unlock (&self->mutex->mutex))
+    CINELERRA_DIE;
+  self->state = CINELERRA_UNLOCKED;
+}
+
+#endif

tests/15locking.tests

@@ -6,3 +6,11 @@ return: 134
 END
 
 
+
+
+
+TEST "mutex not unlocked asserts" mutexforgotunlock <<END
+return: 134
+END
+
+

tests/Makefile.am

@@ -18,7 +18,7 @@
 
 tests_srcdir = $(top_srcdir)/tests
 
-check_PROGRAMS += test-error test-time test-condition
+check_PROGRAMS += test-error test-time test-locking
 
 test_error_SOURCES = $(tests_srcdir)/error/errortest.c
 test_error_CPPFLAGS = $(AM_CPPFLAGS) -std=gnu99 -Wall -Werror -I$(top_srcdir)/src/
@@ -28,8 +28,11 @@ test_time_SOURCES = $(tests_srcdir)/time/test-time.c
 test_time_CPPFLAGS = $(AM_CPPFLAGS) -std=gnu99 -Wall -Werror -I$(top_srcdir)/src/
 test_time_LDADD = $(builddir)/libcin3.a -lnobugmt -lpthread -ldl -lm
 
-test_condition_SOURCES = $(tests_srcdir)/locking/test-condition.c
-test_condition_CPPFLAGS = $(AM_CPPFLAGS) -std=gnu99 -Wall -Werror -I$(top_srcdir)/src/
-test_condition_LDADD = $(builddir)/libcin3.a -lnobugmt -lpthread -ldl -lm
+test_locking_SOURCES = \
+	$(tests_srcdir)/locking/test-locking.c \
+	$(tests_srcdir)/locking/mutex.c \
+	$(tests_srcdir)/locking/condition.c
+test_locking_CPPFLAGS = $(AM_CPPFLAGS) -std=gnu99 -Wall -Werror -I$(top_srcdir)/src/
+test_locking_LDADD = $(builddir)/libcin3.a -lnobugmt -lpthread -ldl -lm
 
 TESTS = $(tests_srcdir)/test.sh

tests/locking/condition.c

@@ -0,0 +1,49 @@
+/*
+  test condition functions
+
+  Copyright (C)         CinelerraCV
+    2007,               Christian Thaeter <ct@pipapo.org>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "lib/condition.h"
+
+#if 0
+waiting_thread()
+{
+  lock;
+  wait;
+  unlock;
+}
+
+
+signaling_thread()
+{
+  signal();
+}
+#endif
+
+
+int
+conditionforgotunlock ()
+{
+  cinelerra_condition c;
+  cinelerra_condition_init (&c);
+
+  cinelerra_conditionlock l;
+  cinelerra_conditionlock_init (&l, &c, CINELERRA_LOCKED);
+  return 0;
+}

tests/locking/mutex.c

@@ -0,0 +1,32 @@
+/*
+  test mutex functions
+
+  Copyright (C)         CinelerraCV
+    2007,               Christian Thaeter <ct@pipapo.org>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "lib/mutex.h"
+
+int mutexforgotunlock()
+{
+  cinelerra_mutex m;
+  cinelerra_mutex_init (&m);
+
+  cinelerra_mutexlock l;
+  cinelerra_mutexlock_init (&l, &m, CINELERRA_LOCKED);
+  return 0;
+}

tests/locking/test-locking.c

@@ -0,0 +1,53 @@
+/*
+  test-locking.c  -  test locking functions
+
+  Copyright (C)         CinelerraCV
+    2007,               Christian Thaeter <ct@pipapo.org>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include <stdio.h>
+#include <string.h>
+
+#include "lib/error.h"
+
+CINELERRA_ERROR_DEFINE(TEST, "test error");
+
+int conditionforgotunlock ();
+int mutexforgotunlock ();
+
+
+int
+main (int argc, char** argv)
+{
+  NOBUG_INIT;
+
+  if (argc == 1)
+    return 0;
+
+  if (!strcmp(argv[1], "conditionforgotunlock"))
+    {
+      return conditionforgotunlock ();
+    }
+  if (!strcmp(argv[1], "mutexforgotunlock"))
+    {
+      return mutexforgotunlock ();
+    }
+  else
+    return 1;
+
+  return 0;
+}