Merge needed define.
[bertos.git] / kern / sem.c
old mode 100755 (executable)
new mode 100644 (file)
index 2262cb0..0f31fa0
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
- * Copyright 2001,2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of BeRTOS.
+ *
+ * Bertos 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2001, 2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 1999, 2000, 2001 Bernardo Innocenti <bernie@develer.com>
+ *
  * -->
  *
  * \brief Semaphore based synchronization services.
  * \author Bernardo Innocenti <bernie@develer.com>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.5  2004/10/21 10:48:57  bernie
- *#* sem_release(): Simplify (made by rasky on scfirm).
- *#*
- *#* Revision 1.4  2004/08/25 14:12:09  rasky
- *#* Aggiornato il comment block dei log RCS
- *#*
- *#* Revision 1.3  2004/08/08 05:53:23  bernie
- *#* Use DISABLE_IRQSAVE/ENABLE_IRQRESTORE; Cleanup documentation.
- *#*
- *#* Revision 1.2  2004/06/03 11:27:09  bernie
- *#* Add dual-license information.
- *#*
- *#* Revision 1.1  2004/05/23 17:27:00  bernie
- *#* Import kern/ subdirectory.
- *#*
- *#*/
-
 #include "sem.h"
-#include "proc.h"
-#include "proc_p.h"
-#include "signal.h"
-#include "hw.h"
+#include <kern/proc.h>
+#include <kern/proc_p.h>
+#include <kern/signal.h>
+#include <cfg/debug.h>
+
+INLINE void sem_verify(struct Semaphore *s)
+{
+       (void)s;
+       ASSERT(s);
+       LIST_ASSERT_VALID(&s->wait_queue);
+       ASSERT(s->nest_count >= 0);
+       ASSERT(s->nest_count < 128);   // heuristic max
+}
 
 
-/*!
- * \brief Initialize a Semaphore structure
+/**
+ * \brief Initialize a Semaphore structure.
  */
 void sem_init(struct Semaphore *s)
 {
-       INITLIST(&s->wait_queue);
+       LIST_INIT(&s->wait_queue);
        s->owner = NULL;
        s->nest_count = 0;
 }
 
 
-/*!
+/**
  * \brief Attempt to lock a semaphore without waiting.
  *
  * \return true in case of success, false if the semaphore
@@ -63,23 +78,23 @@ void sem_init(struct Semaphore *s)
  */
 bool sem_attempt(struct Semaphore *s)
 {
-       cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
+       bool result = false;
 
+       proc_forbid();
+       sem_verify(s);
        if ((!s->owner) || (s->owner == CurrentProcess))
        {
                s->owner = CurrentProcess;
                s->nest_count++;
-               ENABLE_INTS;
-               return true;
+               result = true;
        }
+       proc_permit();
 
-       ENABLE_IRQRESTORE(flags);
-       return false;
+       return result;
 }
 
 
-/*!
+/**
  * \brief Lock a semaphore.
  *
  * If the semaphore is already owned by another process, the caller
@@ -98,35 +113,37 @@ bool sem_attempt(struct Semaphore *s)
  */
 void sem_obtain(struct Semaphore *s)
 {
-       cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
+       proc_forbid();
+       sem_verify(s);
 
        /* Is the semaphore already locked by another process? */
        if (UNLIKELY(s->owner && (s->owner != CurrentProcess)))
        {
                /* Append calling process to the wait queue */
                ADDTAIL(&s->wait_queue, (Node *)CurrentProcess);
-               ENABLE_IRQRESTORE(flags);
 
                /*
                 * We will wake up only when the current owner calls
                 * sem_release(). Then, the semaphore will already
                 * be locked for us.
                 */
+               proc_permit();
                proc_schedule();
        }
        else
        {
+               ASSERT(LIST_EMPTY(&s->wait_queue));
+
                /* The semaphore was free: lock it */
                s->owner = CurrentProcess;
                s->nest_count++;
-               ENABLE_IRQRESTORE(flags);
+               proc_permit();
        }
 }
 
 
-/*!
- * \brief Releases a lock on a previously locked semaphore.
+/**
+ * \brief Release a lock on a previously locked semaphore.
  *
  * If the nesting count of the semaphore reaches zero,
  * the next process waiting for it will be awaken.
@@ -140,12 +157,14 @@ void sem_obtain(struct Semaphore *s)
  */
 void sem_release(struct Semaphore *s)
 {
-       cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
+       proc_forbid();
+       sem_verify(s);
+
+       ASSERT(s->owner == CurrentProcess);
 
        /*
         * Decrement nesting count and check if the semaphore
-        * has been fully unlocked
+        * has been fully unlocked.
         */
        if (--s->nest_count == 0)
        {
@@ -155,7 +174,7 @@ void sem_release(struct Semaphore *s)
                s->owner = NULL;
 
                /* Give semaphore to the first applicant, if any */
-               if ((proc = (Process*)REMHEAD(&s->wait_queue)))
+               if (UNLIKELY((proc = (Process *)list_remHead(&s->wait_queue))))
                {
                        s->nest_count = 1;
                        s->owner = proc;
@@ -163,6 +182,5 @@ void sem_release(struct Semaphore *s)
                }
        }
 
-       ENABLE_IRQRESTORE(flags);
+       proc_permit();
 }
-