]> rtime.felk.cvut.cz Git - frescor/fosa.git/blobdiff - src_marte/fosa_mutexes_and_condvars.c
Migrating FOSA trunk to d-ac2v2. Phase 1 moving FRSH-FOSA to FOSA
[frescor/fosa.git] / src_marte / fosa_mutexes_and_condvars.c
index 9c72c5617828a69b63c238ae2e06f011418e0edb..e8b4123f6cbf5f81409b4c316f2ea3c729149f8a 100644 (file)
@@ -1,5 +1,5 @@
-// -----------------------------------------------------------------------
-//  Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+//----------------------------------------------------------------------
+//  Copyright (C) 2006 - 2007 by the FRESCOR consortium:
 //
 //    Universidad de Cantabria,              SPAIN
 //    University of York,                    UK
 //    Visual Tools S.A.                      SPAIN
 //    Rapita Systems Ltd                     UK
 //    Evidence                               ITALY
-//    
-//    See http://www.frescor.org for a link to partners' websites
 //
-//           FRESCOR project (FP6/2005/IST/5-034026) is funded
+//    See http://www.frescor.org
+//
+//        The FRESCOR project (FP6/2005/IST/5-034026) is funded
 //        in part by the European Union Sixth Framework Programme
 //        The European Union is not liable of any use that may be
 //        made of this code.
 //
-//  This file is part of the FRSH implementation
 //
-//  FRSH 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, or (at  your option)
-//  any later version.
+//  based on previous work (FSF) done in the FIRST project
+//
+//   Copyright (C) 2005  Mälardalen University, SWEDEN
+//                       Scuola Superiore S.Anna, ITALY
+//                       Universidad de Cantabria, SPAIN
+//                       University of York, UK
 //
-//  FRSH  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.
+// This file is part of FOSA (Frsh Operating System Abstraction)
 //
-//  You should have  received a  copy of  the  GNU  General Public License
-//  distributed  with  FRSH;  see file COPYING.   If not,  write to the
-//  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
-//  02111-1307, USA.
+// FOSA is free software; you can redistribute it and/or modify it
+// under terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 2, or (at your option) any
+// later version.  FOSA 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 FOSA; see file
+// COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,
+// Cambridge, MA 02139, USA.
 //
+// As a special exception, including FOSA header files in a file,
+// instantiating FOSA generics or templates, or linking other files
+// with FOSA objects to produce an executable application, does not
+// by itself cause the resulting executable application 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 Public License.
 // -----------------------------------------------------------------------
 //fosa_mutexes_and_condvars.c
 //==============================================
@@ -47,7 +58,7 @@
 //  **////  /**    ** ////////** /**//////**
 //  **      /**    **        /** /**     /**
 //  **      /**    **  ********  /**     /**
-//  //       /******/  ////////   //      // 
+//  //       /******/  ////////   //      //
 //
 // FOSA(Frescor Operating System Adaptation layer)
 //================================================
  *
  * Initialize a frsh mutex
  *
- * The mutex pointed to by mutex is initialized as a mutex using 
+ * The mutex pointed to by mutex is initialized as a mutex using
  * the priority ceiling protocol. A priority ceiling of prioceiling
  * is assigned to this mutex.
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *    EINVAL: the value of prioceiling is invalid
  *    EAGAIN: the system lacked the necessary resources to create the mutex
  * notify it to the system console and then terminate the FRSH
  * implementation and dependant applications
  **/
-int fosa_mutex_init(frsh_mutex_t *mutex, int prioceiling)
+int fosa_mutex_init(fosa_mutex_t *mutex, int prioceiling)
 {
   pthread_mutexattr_t attr;
   int ret_value;
 
-  // create the attributes object and set the mutex to use the 
+  // create the attributes object and set the mutex to use the
   // priority ceiling protocol and the desired priority ceiling
   ret_value=pthread_mutexattr_init(&attr);
   if (ret_value!=0) return ret_value;
@@ -97,7 +108,7 @@ int fosa_mutex_init(frsh_mutex_t *mutex, int prioceiling)
   CHK(pthread_mutexattr_setprotocol(&attr,PTHREAD_PRIO_PROTECT));
   ret_value=pthread_mutexattr_setprioceiling(&attr,prioceiling);
 
-  if (ret_value==0) {  
+  if (ret_value==0) {
     // create the mutex
     ret_value=pthread_mutex_init(mutex,&attr);
   }
@@ -111,18 +122,18 @@ int fosa_mutex_init(frsh_mutex_t *mutex, int prioceiling)
  * fosa_mutex_destroy()
  *
  * Destroy a frsh mutex
- * 
+ *
  * The mutex pointed to by mutex is destroyed
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *    EINVAL: the value of mutex is invalid
- *    EBUSY:  The mutex is in use (is locked)  
+ *    EBUSY:  The mutex is in use (is locked)
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
  * implementation and dependant applications
  **/
-int fosa_mutex_destroy(frsh_mutex_t *mutex)
+int fosa_mutex_destroy(fosa_mutex_t *mutex)
 {
   return pthread_mutex_destroy(mutex);
 }
@@ -131,13 +142,13 @@ int fosa_mutex_destroy(frsh_mutex_t *mutex)
  * fosa_mutex_set_prioceiling()
  *
  * Dynamically set the priority ceiling of a mutex
- * 
+ *
  * This function locks the mutex (blocking the calling thread if
  * necessary) and after it is locked it changes its priority ceiling
  * to the value specified by new_ceiling, and then it unlocks the
  * mutex. The previous value of the ceiling is returned in
  * old_ceiling.
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *     EINVAL: the value of mutex or prioceiling is invalid
  *
@@ -146,7 +157,7 @@ int fosa_mutex_destroy(frsh_mutex_t *mutex)
  * implementation and dependant applications
  **/
 int fosa_mutex_set_prioceiling
-   (frsh_mutex_t *mutex, int new_ceiling, int *old_ceiling)
+   (fosa_mutex_t *mutex, int new_ceiling, int *old_ceiling)
 {
   return pthread_mutex_setprioceiling(mutex,new_ceiling,old_ceiling);
 }
@@ -154,11 +165,11 @@ int fosa_mutex_set_prioceiling
 /**
  * fosa_mutex_get_prioceiling()
  *
- * Dynamically get the priority ceiling of a mutex 
+ * Dynamically get the priority ceiling of a mutex
  *
  * This function copies into the variable pointed to by ceiling the
  * current priority ceiling of the mutex referenced by mutex
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *     EINVAL: the value of mutex is invalid
  *
@@ -166,7 +177,7 @@ int fosa_mutex_set_prioceiling
  * notify it to the system console and then terminate the FRSH
  * implementation and dependant applications
  **/
-int fosa_mutex_get_prioceiling(const frsh_mutex_t *mutex, int *ceiling)
+int fosa_mutex_get_prioceiling(const fosa_mutex_t *mutex, int *ceiling)
 {
   return pthread_mutex_getprioceiling(mutex,ceiling);
 }
@@ -175,12 +186,12 @@ int fosa_mutex_get_prioceiling(const frsh_mutex_t *mutex, int *ceiling)
  * fosa_mutex_lock()
  *
  * Lock a mutex
- * 
+ *
  * This function locks the mutex specified by mutex. If it is already
  * locked, the calling thread blocks until the mutex becomes
  * available. The operation returns with the mutex in the locked
  * state, with the calling thread as its owner.
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *    EINVAL: the value of mutex is invalid, or the priority of the
  *            calling thread is higher than the priority ceiling of the mutex
@@ -190,7 +201,7 @@ int fosa_mutex_get_prioceiling(const frsh_mutex_t *mutex, int *ceiling)
  * notify it to the system console and then terminate the FRSH
  * implementation and dependant applications
  **/
-int fosa_mutex_lock(frsh_mutex_t *mutex)
+int fosa_mutex_lock(fosa_mutex_t *mutex)
 {
   return pthread_mutex_lock(mutex);
 }
@@ -213,7 +224,7 @@ int fosa_mutex_lock(frsh_mutex_t *mutex)
  * implementation is allowed to notify it to the system console and
  * then terminate the FRSH implementation and dependant applications
  **/
-int fosa_mutex_trylock(frsh_mutex_t *mutex)
+int fosa_mutex_trylock(fosa_mutex_t *mutex)
 {
   return pthread_mutex_trylock(mutex);
 }
@@ -222,21 +233,21 @@ int fosa_mutex_trylock(frsh_mutex_t *mutex)
  * fosa_mutex_unlock()
  *
  * Unlock a mutex
- * 
+ *
  * This function must be called by the owner of the mutex referenced
  * by mutex, to unlock it. If there are threads blocked on the mutex
  * the mutex becomes available and the highest priority thread is
  * awakened to acquire the mutex.
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *     EINVAL: the value of mutex is invalid
  *     EPERM: the calling thread is not the owner of the mutex
  *
  * Alternatively, except for EBUSY, in case of error the
  * implementation is allowed to notify it to the system console and
- * then terminate the FRSH implementation and dependant applications 
+ * then terminate the FRSH implementation and dependant applications
  **/
-int fosa_mutex_unlock(frsh_mutex_t *mutex)
+int fosa_mutex_unlock(fosa_mutex_t *mutex)
 {
   return pthread_mutex_unlock(mutex);
 }
@@ -250,7 +261,7 @@ int fosa_mutex_unlock(frsh_mutex_t *mutex)
  * fosa_cond_init()
  *
  * Initiatize a condition variable
- * 
+ *
  * The condition variable referenced by cond is initialized with
  * the attributes required by the FOSA implementation.
  *
@@ -258,7 +269,7 @@ int fosa_mutex_unlock(frsh_mutex_t *mutex)
  *     EAGAIN: the system lacked the necessary resources to create the
  *             condition variable
  *     ENOMEM: Insufficient memory exists to initialize the condition variable
- *     EBUSY:  The system has detected an attempt to reinitialize the 
+ *     EBUSY:  The system has detected an attempt to reinitialize the
  *             condition variable
  *
  * Alternatively, in case of error the implementation is allowed to
@@ -268,6 +279,7 @@ int fosa_mutex_unlock(frsh_mutex_t *mutex)
 int fosa_cond_init(fosa_cond_t *cond)
 {
   // initialize condition variable with default attributes
+  // TODO: cond var attr timer to monotonic when supported by marte
   return pthread_cond_init(cond,NULL);
 }
 
@@ -277,10 +289,10 @@ int fosa_cond_init(fosa_cond_t *cond)
  * Destroy a condition variable
  *
  * The condition variable pointed to by cond is destroyed
- * 
+ *
  * Returns 0 if successful; otherwise it returns an error code:
  *     EINVAL: the value of cond is invalid
- *     EBUSY:  The condition variable is in use (a thread is waiting on it)  
+ *     EBUSY:  The condition variable is in use (a thread is waiting on it)
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -354,7 +366,7 @@ int fosa_cond_broadcast(fosa_cond_t *cond)
  * notify it to the system console and then terminate the FRSH
  * implementation and dependant applications
  **/
-int fosa_cond_wait(fosa_cond_t *cond, frsh_mutex_t *mutex)
+int fosa_cond_wait(fosa_cond_t *cond, fosa_mutex_t *mutex)
 {
   return pthread_cond_wait(cond,mutex);
 }
@@ -363,10 +375,10 @@ int fosa_cond_wait(fosa_cond_t *cond, frsh_mutex_t *mutex)
  * fosa_cond_timedwait()
  *
  * Wait at a condition variable, with a timeout
- * 
+ *
  * This function is equal to fosa_cond_wait(), except that the maximum
  * wait time is limited to the absolute time referenced by abstime, as
- * measured by the FOSA_CLOCK_REALTIME clock.
+ * measured by the FOSA_CLOCK_ABSOLUTE clock.
  *
  * Returns 0 if successful; otherwise it returns an error code:
  *     EINVAL: the value of cond or mutex or abstime is invalid, or different
@@ -378,7 +390,7 @@ int fosa_cond_wait(fosa_cond_t *cond, frsh_mutex_t *mutex)
  * implementation is allowed to notify it to the system console and
  * then terminate the FRSH implementation and dependant applications
  **/
-int fosa_cond_timedwait(fosa_cond_t *cond, frsh_mutex_t *mutex, 
+int fosa_cond_timedwait(fosa_cond_t *cond, fosa_mutex_t *mutex,
       const struct timespec *abstime)
 {
   return pthread_cond_timedwait(cond,mutex,abstime);