+++ /dev/null
-// -----------------------------------------------------------------------
-// Copyright (C) 2006 - 2007 FRESCOR consortium partners:
-//
-// Universidad de Cantabria, SPAIN
-// University of York, UK
-// Scuola Superiore Sant'Anna, ITALY
-// Kaiserslautern University, GERMANY
-// Univ. Politecnica 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
-// 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.
-//
-// 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.
-//
-// 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.
-//
-// 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_clocks_and_timers.h
-//==============================================
-// ******** ****** ******** **********
-// **///// /** ** **////// /** /**
-// ** /** ** /** /** /**
-// ******* /** ** /********* /**********
-// **//// /** ** ////////** /**//////**
-// ** /** ** /** /** /**
-// ** /** ** ******** /** /**
-// // /******/ //////// // //
-//
-// FOSA(Frescor Operating System Adaptation layer)
-//================================================
-
-
-#ifndef FOSA_CLOCKS_AND_TIMERS_H_
-#define FOSA_CLOCKS_AND_TIMERS_H_
-
-/**
- * @defgroup clocksandtimers Clocks and Timers
- * @ingroup fosa
- *
- * This module defines the types and functions to abstract clocks and
- * timers for the FRSH implementation.
- *
- * @{
- **/
-
-
-
-/*************************
- * Timing: Clocks
- *************************/
-
-/**
- * fosa_get_time()
- *
- * Get the time from a clock
- *
- * This function sets the variable pointed to by current_time to the
- * current value of the clock specified by clockid, which may be the
- * FOSA_CLOCK_REALTIME constant or a value obtained with
- * fosa_get_cputime_clock()
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of clockid is invalid
- *
- * 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_clock_get_time(fosa_clock_id_t clockid, struct timespec current_time);
-extern inline int fosa_clock_get_time(fosa_clock_id_t clockid, struct timespec current_time){
- return clock_gettime(clockid, current_time);
-}
-
-
-/**
- * fosa_get_cputime_clock()
- *
- * Get the identifier of a cpu-time clock
- *
- * This function stores in the variable pointed to by clockid the
- * identifier of a cpu-time clock for the thread specified by tid.
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of tid is invalid
- *
- * 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_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid);
-extern inline int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid){
- return pthread_getcpuclockid(tid, clockid);
-}
-
-
-/*************************
- * Timing: Timers
- *************************/
-
-/**
- * fosa_create_timer()
- *
- * Create a one-shot timer
- *
- * This function creates a timer based on the clock specified by clock,
- * and associates to this timer a notification mechanism consisting of
- * a signal and associated information. Initially, the timer is in the
- * disarmed state, i.e., not counting time. It can be armed to start
- * counting time with fosa_timer_arm().
- *
- * The function stores the identifier of the newly created timer in the
- * variable pointed to by timerid.
- *
- * When the timer expires, the signal number specified by signal will be
- * sent together with the information specified by info, to the thread
- * that armed the timer (@see fosa_timer_arm()).
- *
- * In those implementations that do not support queueing a
- * signal with information to a thread (such as POSIX), the signal may
- * be sent to any thread that is waiting for this signal via
- * fosa_signal_wait(). Portability can be ensured by having the receiver
- * thread be the one who is waiting for the signal.
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of clockid or signal is invalid
- *
- * EAGAIN: the system lacks enough resources to create the timer
- *
- * 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_timer_create
-// (fosa_clock_id_t clockid, frsh_signal_t signal, frsh_signal_info_t info,
-// fosa_timer_id_t *timerid);
-extern inline int fosa_timer_create(fosa_clock_id_t clockid, frsh_signal_t signal, frsh_signal_info_t info,
- fosa_timer_id_t *timerid){
- struct sigevent event;
-
- event.sigev_notify = SIGEV_SIGNAL;
- event.sigev_signo = signal;
- event.sigval.sival_ptr = info;
-
- return timer_create(clockid, &event, timerid);
-}
-
-/**
- * Delete a timer
- *
- * The function deletes the timer specified by timerid, which becomes
- * unusable. If the timer was armed, it is automatically disarmed before
- * deletion.
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid is not valid
- *
- * 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_timer_delete(fosa_timer_id_t timerid);
-extern inline int fosa_timer_delete(_timerid_) timer_delete(_timerid_);
-
-
-/**
- * fosa_timer_arm()
- *
- * Arm a timer
- *
- * The timer specified by timer is armed and starts counting time.
- *
- * If abstime is true, the value pointed to by value is the absolute
- * time at which the timer will expire. If value specifies a time instant
- * in the past, the timer expires immediately.
- *
- * If abstime is false, the value pointed to by value is the relative interval
- * that must elapse for the timer to expire.
- *
- * In both cases, absolute or relative, the time is measured with the clock
- * associated with the timer when it was created.
- *
- * If the timer was already armed, the previous time or interval is discarded
- * and the timer is rearmed with the new value.
- *
- * When the timer expires, it is disarmed.
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid or value is invalid
- *
- * 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_timer_arm
-// (fosa_timer_id_t timerid, bool abstime,
-// const struct timespec *value);
-
-extern inline int fosa_timer_arm (fosa_timer_id_t timerid, bool abstime,
- const struct timespec *value){
-
- struct itimerspec when;
-
- when.it_value = *value; // Just one shot.
- when.it_interval.tv_sec = 0; // No periodic behabiour.
- when.it_interval.tv_nsec = 0;
-
- return timer_settime(timerid, abstime , &when, NULL);
-}
-
-/**
- * fosa_timer_disarm()
- *
- * Disarm a timer
- *
- * The timer specified by timer is disarmed, and will not expire unless
- * it is rearmed. If the timer was already disramed, the function has
- * no effect.
- *
- * Returns 0 if successful; otherwise it returns an error code:
- * EINVAL: the value of timerid or value is invalid
- *
- * 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_timer_disarm(fosa_timer_id_t timerid);
-
-
-extern inline int fosa_timer_disarm(fosa_timer_id_t timerid){
- struct itimerspec when;
-
- when.it_value.tv_sec = 0;
- when.it_value.tv_nsec = 0;
- when.it_interval = when.it_value; // Not needed but safe.
-
- return timer_settime(timerid, TIMER_ABSTIME , &when, NULL);
-}
-
-/*@}*/
-
-
-#endif /* !FOSA_CLOCKS_AND_TIMERS_H_ */
projects / frescor / fosa.git / blobdiff