src_aquosa/fosa_clocks_and_timers.c

   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 //
  48 //==============================================
  49 //  ********  ******    ********  **********
  50 //  **///// /**    **  **//////  /**     /**
  51 //  **      /**    ** /**        /**     /**
  52 //  ******* /**    ** /********* /**********
  53 //  **////  /**    ** ////////** /**//////**
  54 //  **      /**    **        /** /**     /**
  55 //  **      /**    **  ********  /**     /**
  56 //  //       /******/  ////////   //      //
  57 //
  58 // FOSA(Frescor Operating System Adaptation layer)
  59 //================================================
  60
  61 #include "fosa_time.h"
  62 #include "fosa_clocks_and_timers.h"
  63
  64 static const struct timespec zero_time={0,0};
  65
  66
  67 /*************************
  68  * Timing: Clocks
  69  *************************/
  70
  71 /**
  72  * fosa_get_time()
  73  *
  74  * Get the time from a clock
  75  *
  76  * This function sets the variable pointed to by current_time to the
  77  * current value of the clock specified by clockid, which may be the
  78  * FOSA_CLOCK_REALTIME constant or a value obtained with
  79  * fosa_get_cputime_clock()
  80  *
  81  * Returns 0 if successful; otherwise it returns an error code:
  82  *     EINVAL: the value of clockid is invalid
  83  **/
  84 int fosa_clock_get_time(fosa_clock_id_t clockid,
  85                         fosa_abs_time_t *current_time)
  86 {
  87         int ret;
  88         struct timespec current_time_tspec;
  89
  90         ret = clock_gettime(clockid, &current_time_tspec);
  91         *current_time = fosa_timespec_to_abs_time(current_time_tspec);
  92
  93         return ret;
  94 }
  95
  96 /**
  97  * fosa_get_cputime_clock()
  98  *
  99  * Get the identifier of a cpu-time clock
 100  *
 101  * This function stores in the variable pointed to by clockid the
 102  * identifier of a cpu-time clock for the thread specified by tid.
 103  *
 104  * Returns 0 if successful; otherwise it returns an error code:
 105  *    EINVAL: the value of tid is invalid
 106  **/
 107 int fosa_thread_get_cputime_clock(fosa_thread_id_t tid,
 108                                   fosa_clock_id_t *clockid)
 109 {
 110         if (tid.linux_pid == tid.linux_tid) {
 111                 /* standard UNIX process */
 112                 return clock_getcpuclockid(tid.linux_pid, clockid);
 113         } else {
 114                 /* POSIX thread */
 115                 return pthread_getcpuclockid(tid.pthread_id, clockid);
 116         }
 117 }
 118
 119 /*************************
 120  * Timing: Timers
 121  *************************/
 122
 123 /**
 124  * fosa_create_timer()
 125  *
 126  * Create a one-shot timer
 127  *
 128  * This function creates a timer based on the clock specified by clock,
 129  * and associates to this timer a notification mechanism consisting of
 130  * a signal and associated information. Initially, the timer is in the
 131  * disarmed state, i.e., not counting time. It can be armed to start
 132  * counting time with fosa_timer_arm().
 133  *
 134  * The function stores the identifier of the newly created timer in the
 135  * variable pointed to by timerid.
 136  *
 137  * When the timer expires, the signal number specified by signal will be
 138  * sent together with the information specified by info, to the thread
 139  * that armed the timer (@see fosa_timer_arm()).
 140  *
 141  * Note that, since this is a POSIX implementation, the signal will be sent
 142  * to any thread waiting fot it (in a given UNIX process).
 143  * No signal-waiting thread or similar strategy is implemented, the specific
 144  * thread can be choosed (for example) by means of the signal number.
 145  *
 146  * Returns 0 if successful; otherwise it returns an error code:
 147  *     EINVAL: the value of clockid or signal is invalid
 148  *
 149  *     EAGAIN: the system lacks enough resources to create the timer
 150  **/
 151 int fosa_timer_create(fosa_clock_id_t clockid,
 152                       fosa_signal_t signal,
 153                       fosa_signal_info_t info,
 154                       fosa_timer_id_t *timerid)
 155 {
 156         struct sigevent event;
 157
 158         event.sigev_notify = SIGEV_SIGNAL;
 159         event.sigev_signo = signal;
 160         event.sigev_value = *((union sigval*) &info);
 161
 162         return timer_create(clockid, &event, timerid);
 163 }
 164
 165 /**
 166  * fosa_timer_create_with_receiver()
 167  *
 168  * Create a one-shot timer with a specific signal receiver thread
 169  *
 170  * This function creates a timer in the same way as fosa_timer_create,
 171  * except that the signal generated when the timer expires is sent to
 172  * the thread specified by receiver
 173  *
 174  * You have to use the "simple" fosa_timer_create.
 175  **/
 176  int fosa_timer_create_with_receiver(fosa_clock_id_t clockid,
 177                                      fosa_signal_t signal,
 178                                      fosa_signal_info_t info,
 179                                      fosa_timer_id_t *timerid,
 180                                      fosa_thread_id_t receiver)
 181 {
 182         struct sigevent event;
 183
 184         event.sigev_notify = SIGEV_SIGNAL;
 185         event.sigev_signo = signal;
 186         event.sigev_value = *((union sigval*) &info);
 187         event.sigev_notify = SIGEV_THREAD_ID | SIGEV_SIGNAL;
 188         event._sigev_un._tid = receiver.linux_tid;
 189
 190         return timer_create(clockid, &event, timerid);
 191 }
 192
 193 /**
 194  * Delete a timer
 195  *
 196  * The function deletes the timer specified by timerid, which becomes
 197  * unusable. If the timer was armed, it is automatically disarmed before
 198  * deletion.
 199  *
 200  * Returns 0 if successful; otherwise it returns an error code:
 201  *     EINVAL: the value of timerid is not valid
 202  **/
 203 int fosa_timer_delete(fosa_timer_id_t  timerid)
 204 {
 205         return timer_delete(timerid);
 206 }
 207
 208 /**
 209  * fosa_rel_timer_arm()
 210  *
 211  * Arm a timer with a relative time interval
 212  *
 213  * The timer specified by timer is armed and starts counting time.
 214  *
 215  * The value pointed to by value is the relative interval that must
 216  * elapse for the timer to expire.  Negative values cause the timer to
 217  * expire immediately.
 218  *
 219  * The time is measured with the clock associated with the timer when
 220  * it was created.
 221  *
 222  * If the timer was already armed, the previous time or interval is discarded
 223  * and the timer is rearmed with the new value.
 224  *
 225  * When the timer expires, it is disarmed.
 226  *
 227  * Returns 0 if successful; otherwise it returns an error code:
 228  *    FOSA_EINVAL: the value of timerid or value is invalid
 229  *
 230  * Alternatively, in case of error the implementation is allowed to
 231  * notify it to the system console and then terminate the FRSH
 232  * implementation and dependant applications
 233  **/
 234 int fosa_rel_timer_arm (fosa_timer_id_t timerid, const fosa_rel_time_t *value)
 235 {
 236         struct itimerspec when;
 237
 238         /* non-periodic one shot timer */
 239         when.it_value = fosa_abs_time_to_timespec(*value);
 240         when.it_interval = zero_time;
 241
 242         return timer_settime(timerid, 0, &when, NULL);
 243 }
 244
 245
 246 /**
 247  * fosa_abs_timer_arm()
 248  *
 249  * Arm a timer that will expire in an absolute time instant.
 250  *
 251  * The timer specified by timer is armed and starts counting time.
 252  *
 253  * The value pointed to by value is the absolute time at which the
 254  * timer will expire. If value specifies a time instant in the past,
 255  * the timer expires immediately.
 256  *
 257  * The time is measured with the clock associated with the timer when
 258  * it was created.
 259  *
 260  * If the timer was already armed, the previous time or interval is discarded
 261  * and the timer is rearmed with the new value.
 262  *
 263  * When the timer expires, it is disarmed.
 264  *
 265  * Returns 0 if successful; otherwise it returns an error code:
 266  *    FOSA_EINVAL: the value of timerid or value is invalid
 267  *
 268  * Alternatively, in case of error the implementation is allowed to
 269  * notify it to the system console and then terminate the FRSH
 270  * implementation and dependant applications
 271  **/
 272 int fosa_abs_timer_arm(fosa_timer_id_t timerid, const fosa_abs_time_t *value)
 273 {
 274         struct itimerspec when;
 275
 276         /* non-periodic one shot timer */
 277         when.it_value= fosa_abs_time_to_timespec(*value);
 278         when.it_interval=zero_time;
 279
 280         return timer_settime(timerid, TIMER_ABSTIME, &when, NULL);
 281 }
 282
 283 /**
 284  * fosa_timer_get_remaining_time()
 285  *
 286  * Get the remaining time for timer expiration
 287  *
 288  * Returns the relative remaining time for timer expiration.  If the
 289  * clock is a CPU clock it returns the time as if the thread was
 290  * executing constantly.
 291  *
 292  * If the timer is disarmed it returns 0.
 293  *
 294  * Returns 0 if successful; otherwise it returns an error code:
 295  *    EINVAL: the value of timerid or value is invalid
 296  **/
 297 int fosa_timer_get_remaining_time(fosa_timer_id_t timerid,
 298                                   fosa_rel_time_t *remaining_time)
 299 {
 300         int ret;
 301         struct itimerspec time;
 302
 303         if (remaining_time == NULL)
 304                 return FOSA_EINVAL;
 305
 306         ret = timer_gettime(timerid, &time);
 307         *remaining_time = fosa_timespec_to_rel_time(time.it_value);
 308
 309         return ret;
 310 }
 311
 312 /**
 313  * fosa_timer_disarm()
 314  *
 315  * Disarm a timer
 316  *
 317  * The timer specified by timer is disarmed, and will not expire unless
 318  * it is rearmed. If the timer was already disramed, the function has
 319  * no effect.
 320  *
 321  * If the pointer remaining_time is != NULL, the remaining time before
 322  * expiration will be returned in that pointer.  If the timer was
 323  * disarmed a 0 value will be set.
 324  *
 325  * Returns 0 if successful; otherwise it returns an error code:
 326  *    EINVAL: the value of timerid or value is invalid
 327  **/
 328 int fosa_timer_disarm(fosa_timer_id_t timerid,
 329                       struct timespec *remaining_time)
 330 {
 331         int ret;
 332         struct itimerspec time;
 333
 334         if (remaining_time == NULL)
 335                 return FOSA_EINVAL;
 336
 337         ret = timer_gettime(timerid, &time);
 338         *remaining_time = fosa_timespec_to_rel_time(time.it_value);
 339         if (ret < 0)
 340                 return ret;
 341
 342         time.it_value = zero_time;
 343         time.it_interval = zero_time;
 344
 345         return timer_settime(timerid, 0, &time, NULL);
 346 }
 347