// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
+// Copyright (C) 2006 - 2009 FRESCOR consortium partners:
//
// Universidad de Cantabria, SPAIN
// University of York, UK
// Scuola Superiore Sant'Anna, ITALY
// Kaiserslautern University, GERMANY
-// Univ. Politecnica Valencia, SPAIN
+// Univ. Politécnica Valencia, SPAIN
// Czech Technical University in Prague, CZECH REPUBLIC
// ENEA SWEDEN
// Thales Communication S.A. FRANCE
// 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
// 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.
+// FSF API web pages: http://marte.unican.es/fsf/docs
+// http://shark.sssup.it/contrib/first/docs/
//
-// 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.
+// This file is part of FOSA (Frsh Operating System Adaption)
//
-// As a special exception, if you include this header file into source
-// files to be compiled, this header 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.
+// 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.h
//==============================================
// **//// /** ** ////////** /**//////**
// ** /** ** /** /** /**
// ** /** ** ******** /** /**
-// // /******/ //////// // //
+// // /******/ //////// // //
//
// FOSA(Frescor Operating System Adaptation layer)
//================================================
#ifndef FOSA_MUTEX_AND_CONDVARS_H_
#define FOSA_MUTEX_AND_CONDVARS_H_
+
+#include "fosa_types.h"
+
+FOSA_CPP_BEGIN_DECLS
+
/**
* @defgroup mutexesandcondvars Mutexes and Condvars
+ * @ingroup fosa
*
* This module defines the types and functions to abstract mutexes and
* conditional variables for the FRSH implementation.
*
* 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
- * ENOMEM: Insufficient memory exists to initialize the mutex
- * EBUSY: The system has detected an attempt to reinitialize the mutex
+ *
+ * FOSA_EINVAL: the value of prioceiling is invalid \n
+ * FOSA_EAGAIN: the system lacked the necessary resources to create
+ * the mutex \n
+ * FOSA_ENOMEM: Insufficient memory exists to initialize the mutex \n
+ * FOSA_EBUSY: The system has detected an attempt to reinitialize the mutex
*
* 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_init(frsh_mutex_t *mutex, int prioceiling);
+int fosa_mutex_init(fosa_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)
+ *
+ * FOSA_EINVAL: the value of mutex is invalid \n
+ * FOSA_EBUSY: The mutex is in use (is locked)\n
*
* 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);
/**
* 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
+ *
+ * FOSA_EINVAL: the value of mutex or prioceiling is invalid \n
*
* 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_set_prioceiling
- (frsh_mutex_t *mutex, int new_ceiling, int *old_ceiling);
+ (fosa_mutex_t *mutex, int new_ceiling, int *old_ceiling);
/**
* 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
+ *
+ * FOSA_EINVAL: the value of mutex is invalid \n
*
* 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_get_prioceiling(const frsh_mutex_t *mutex, int *ceiling);
+int fosa_mutex_get_prioceiling(const fosa_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
- * EDEADLK: the current thread already owns this mutex
+ *
+ * Returns 0 if successful; otherwise it returns an error code: \n
+ *
+ * FOSA_EINVAL: the value of mutex is invalid, or the priority of the
+ * calling thread is higher than the priority ceiling of
+ * the mutex \n
+ *
+ * FOSA_EDEADLK: the current thread already owns this mutex \n
*
* 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_lock(frsh_mutex_t *mutex);
+int fosa_mutex_lock(fosa_mutex_t *mutex);
/**
* fosa_mutex_trylock()
* indication.
*
* 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
- * EBUSY: the mutex was already locked
+ * FOSA_EINVAL: the value of mutex is invalid, or the priority of the
+ * calling thread is higher than the priority ceiling of the
+ * mutex \n
+ * FOSA_EBUSY: the mutex was already locked \n
*
- * Alternatively, except for EBUSY, in case of error the
+ * Alternatively, except for FOSA_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
**/
-int fosa_mutex_trylock(frsh_mutex_t *mutex);
+int fosa_mutex_trylock(fosa_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
+ * FOSA_EINVAL: the value of mutex is invalid
+ * FOSA_EPERM: the calling thread is not the owner of the mutex
*
- * Alternatively, except for EBUSY, in case of error the
+ * Alternatively, except for FOSA_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);
/**********************
* fosa_cond_init()
*
* Initiatize a condition variable
- *
+ *
* The condition variable referenced by cond is initialized with
* the attributes required by the FOSA implementation.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EAGAIN: the system lacked the necessary resources to create the
+ * FOSA_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
+ * FOSA_ENOMEM: Insufficient memory exists to initialize the condition variable
+ * FOSA_EBUSY: The system has detected an attempt to reinitialize the
* condition variable
*
* Alternatively, in case of error the implementation is allowed to
* 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)
+ * FOSA_EINVAL: the value of cond is invalid
+ * FOSA_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
* waiting, the function has no effect
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of cond is invalid
+ * FOSA_EINVAL: the value of cond is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* waiting, the function has no effect.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of cond is invalid
+ * FOSA_EINVAL: the value of cond is invalid
*
* Alternatively, in case of error the implementation is allowed to
* notify it to the system console and then terminate the FRSH
* returns with the mutex locked by the calling thread.
*
* Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of cond or mutex is invalid, or different
+ * FOSA_EINVAL: the value of cond or mutex is invalid, or different
* mutexes were used for concurrent wait operations on cond, or
* the mutex was not owned by the calling thread
*
* 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);
/**
* 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
+ * FOSA_EINVAL: the value of cond or mutex or abstime is invalid, or different
* mutexes were used for concurrent wait operations on cond, or
* the mutex was not owned by the calling thread
- * ETIMEDOUT: the timeout expired
+ * FOSA_ETIMEDOUT: the timeout expired
*
- * Alternatively, except for ETIMEDOUT, in case of error the
+ * Alternatively, except for FOSA_ETIMEDOUT, 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_cond_timedwait(fosa_cond_t *cond, frsh_mutex_t *mutex,
- const struct timespec abstime);
+int fosa_cond_timedwait(fosa_cond_t *cond, fosa_mutex_t *mutex,
+ const fosa_abs_time_t *abstime);
-/*@}*/
-
+/*@}*/
+FOSA_CPP_END_DECLS
#endif /* !FOSA_MUTEX_AND_CONDVARS_H_ */
projects / frescor / fosa.git / blobdiff