include/fosa_clocks_and_timers.h

   1 // -----------------------------------------------------------------------
   2 //  Copyright (C) 2006 - 2007 FRESCOR consortium partners:
   3 //
   4 //    Universidad de Cantabria,              SPAIN
   5 //    University of York,                    UK
   6 //    Scuola Superiore Sant'Anna,            ITALY
   7 //    Kaiserslautern University,             GERMANY
   8 //    Univ. Politecnica  Valencia,           SPAIN
   9 //    Czech Technical University in Prague,  CZECH REPUBLIC
  10 //    ENEA                                   SWEDEN
  11 //    Thales Communication S.A.              FRANCE
  12 //    Visual Tools S.A.                      SPAIN
  13 //    Rapita Systems Ltd                     UK
  14 //    Evidence                               ITALY
  15 //
  16 //    See http://www.frescor.org for a link to partners' websites
  17 //
  18 //           FRESCOR project (FP6/2005/IST/5-034026) is funded
  19 //        in part by the European Union Sixth Framework Programme
  20 //        The European Union is not liable of any use that may be
  21 //        made of this code.
  22 //
  23 //  This file is part of the FRSH implementation
  24 //
  25 //  FRSH is free software; you can  redistribute it and/or  modify
  26 //  it under the terms of  the GNU General Public License as published by
  27 //  the Free Software Foundation;  either  version 2, or (at  your option)
  28 //  any later version.
  29 //
  30 //  FRSH  is distributed  in  the hope  that  it  will  be useful,  but
  31 //  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  32 //  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  33 //  General Public License for more details.
  34 //
  35 //  You should have  received a  copy of  the  GNU  General Public License
  36 //  distributed  with  FRSH;  see file COPYING.   If not,  write to the
  37 //  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  38 //  02111-1307, USA.
  39 //
  40 //  As a special exception, if you include this header file into source
  41 //  files to be compiled, this header file does not by itself cause
  42 //  the resulting executable to be covered by the GNU General Public
  43 //  License.  This exception does not however invalidate any other
  44 //  reasons why the executable file might be covered by the GNU General
  45 //  Public License.
  46 // -----------------------------------------------------------------------
  47 //fosa_clocks_and_timers.h
  48 //==============================================
  49 //  ********  ******    ********  **********
  50 //  **///// /**    **  **//////  /**     /**
  51 //  **      /**    ** /**        /**     /**
  52 //  ******* /**    ** /********* /**********
  53 //  **////  /**    ** ////////** /**//////**
  54 //  **      /**    **        /** /**     /**
  55 //  **      /**    **  ********  /**     /**
  56 //  //       /******/  ////////   //      //
  57 //
  58 // FOSA(Frescor Operating System Adaptation layer)
  59 //================================================
  60
  61
  62 #ifndef         FOSA_CLOCKS_AND_TIMERS_H_
  63 #define         FOSA_CLOCKS_AND_TIMERS_H_
  64
  65 #include "fosa_types.h"
  66 #include "fosa_configuration_parameters.h"
  67
  68 /**
  69  * @defgroup clocksandtimers Clocks and Timers
  70  * @ingroup fosa
  71  *
  72  * This module defines the types and functions to abstract clocks and
  73  * timers for the FRSH implementation.
  74  *
  75  * @{
  76  **/
  77
  78
  79
  80 /*************************
  81  * Timing: Clocks
  82  *************************/
  83
  84 /**
  85  * fosa_get_time()
  86  *
  87  * Get the time from a clock
  88  *
  89  * This function sets the variable pointed to by current_time to the
  90  * current value of the clock specified by clockid, which may be the
  91  * FOSA_CLOCK_REALTIME constant or a value obtained with
  92  * fosa_get_cputime_clock()
  93  *
  94  * Returns 0 if successful; otherwise it returns an error code:
  95  *     EINVAL: the value of clockid is invalid
  96  *
  97  * Alternatively, in case of error the implementation is allowed to
  98  * notify it to the system console and then terminate the FRSH
  99  * implementation and dependant applications
 100  **/
 101 int fosa_clock_get_time(fosa_clock_id_t clockid, struct timespec *current_time);
 102
 103
 104 /**
 105  * fosa_get_cputime_clock()
 106  *
 107  * Get the identifier of a cpu-time clock
 108  *
 109  * This function stores in the variable pointed to by clockid the
 110  * identifier of a cpu-time clock for the thread specified by tid.
 111  *
 112  * Returns 0 if successful; otherwise it returns an error code:
 113  *    EINVAL: the value of tid is invalid
 114  *
 115  * Alternatively, in case of error the implementation is allowed to
 116  * notify it to the system console and then terminate the FRSH
 117  * implementation and dependant applications
 118  **/
 119 int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid);
 120
 121
 122 /*************************
 123  * Timing: Timers
 124  *************************/
 125
 126 /**
 127  * fosa_timer_create()
 128  *
 129  * Create a one-shot timer
 130  *
 131  * This function creates a timer based on the clock specified by clock,
 132  * and associates to this timer a notification mechanism consisting of
 133  * a signal and associated information. Initially, the timer is in the
 134  * disarmed state, i.e., not counting time. It can be armed to start
 135  * counting time with fosa_timer_arm().
 136  *
 137  * The function stores the identifier of the newly created timer in the
 138  * variable pointed to by timerid.
 139  *
 140  * When the timer expires, the signal number specified by signal will be
 141  * sent together with the information specified by info, to the thread
 142  * that armed the timer (@see fosa_timer_arm()).
 143  *
 144  * In those implementations that do not support queueing a
 145  * signal with information to a thread (such as POSIX), the signal may
 146  * be sent to any thread that is waiting for this signal via
 147  * fosa_signal_wait(). Portability can be ensured by having the receiver
 148  * thread be the one who is waiting for the signal.
 149  *
 150  * Returns 0 if successful; otherwise it returns an error code:
 151  *     EINVAL: the value of clockid or signal is invalid
 152  *
 153  *     EAGAIN: the system lacks enough resources to create the timer
 154  *
 155  * Alternatively, in case of error the implementation is allowed to
 156  * notify it to the system console and then terminate the FRSH
 157  * implementation and dependant applications
 158  **/
 159  int fosa_timer_create
 160       (fosa_clock_id_t clockid, frsh_signal_t signal, frsh_signal_info_t info,
 161        fosa_timer_id_t *timerid);
 162
 163 /**
 164  * fosa_timer_delete()
 165  *
 166  * Delete a timer
 167  *
 168  * The function deletes the timer specified by timerid, which becomes
 169  * unusable. If the timer was armed, it is automatically disarmed before
 170  * deletion.
 171  *
 172  * Returns 0 if successful; otherwise it returns an error code:
 173  *     EINVAL: the value of timerid is not valid
 174  *
 175  * Alternatively, in case of error the implementation is allowed to
 176  * notify it to the system console and then terminate the FRSH
 177  * implementation and dependant applications
 178  **/
 179 int fosa_timer_delete(fosa_timer_id_t timerid);
 180
 181 /**
 182  * fosa_timer_arm()
 183  *
 184  * Arm a timer
 185  *
 186  * The timer specified by timer is armed and starts counting time.
 187  *
 188  * If abstime is true, the value pointed to by value is the absolute
 189  * time at which the timer will expire. If value specifies a time instant
 190  * in the past, the timer expires immediately.
 191  *
 192  * If abstime is false, the value pointed to by value is the relative interval
 193  * that must elapse for the timer to expire.
 194  *
 195  * In both cases, absolute or relative, the time is measured with the clock
 196  * associated with the timer when it was created.
 197  *
 198  * If the timer was already armed, the previous time or interval is discarded
 199  * and the timer is rearmed with the new value.
 200  *
 201  * When the timer expires, it is disarmed.
 202  *
 203  * Returns 0 if successful; otherwise it returns an error code:
 204  *    EINVAL: the value of timerid or value is invalid
 205  *
 206  * Alternatively, in case of error the implementation is allowed to
 207  * notify it to the system console and then terminate the FRSH
 208  * implementation and dependant applications
 209  **/
 210 int fosa_timer_arm
 211       (fosa_timer_id_t timerid, bool abstime,
 212        const struct timespec *value);
 213
 214 /**
 215  * fosa_timer_get_remaining_time()
 216  *
 217  * Get the remaining time for timer expiration
 218  *
 219  * Returns the relative remaining time for timer expiration.  If the
 220  * clock is a CPU clock it returns the time as if the thread was
 221  * executing constantly.
 222  *
 223  * If the timer is disarmed it returns 0.
 224  *
 225  * Returns 0 if successful; otherwise it returns an error code:
 226  *    EINVAL: the value of timerid or value is invalid
 227  *
 228  * Alternatively, in case of error the implementation is allowed to
 229  * notify it to the system console and then terminate the FRSH
 230  * implementation and dependant applications
 231  **/
 232 int fosa_timer_get_remaining_time
 233     (fosa_timer_id_t timerid, struct timespec *remaining_time);
 234
 235
 236
 237
 238 /**
 239  * fosa_timer_disarm()
 240  *
 241  * Disarm a timer and optionally obtain remaining time before expiration
 242  *
 243  * The timer specified by timer is disarmed, and will not expire unless
 244  * it is rearmed. If the timer was already disramed, the function has
 245  * no effect.
 246  *
 247  * If the pointer remaining_time is != NULL, the remaining time before
 248  * expiration will be returned in that pointer.  If the timer was
 249  * disarmed a 0 value will be set.
 250  *
 251  * Returns 0 if successful; otherwise it returns an error code:
 252  *    EINVAL: the value of timerid or value is invalid
 253  *
 254  * Alternatively, in case of error the implementation is allowed to
 255  * notify it to the system console and then terminate the FRSH
 256  * implementation and dependant applications
 257  **/
 258 int fosa_timer_disarm(fosa_timer_id_t timerid, struct timespec
 259                            *remaining_time);
 260
 261
 262 /*@}*/
 263
 264
 265 #endif      /* !FOSA_CLOCKS_AND_TIMERS_H_ */