timespec_operations.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. Politécnica  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 //
  24 //  based on previous work (FSF) done in the FIRST project
  25 //
  26 //   Copyright (C) 2005  Mälardalen University, SWEDEN
  27 //                       Scuola Superiore S.Anna, ITALY
  28 //                       Universidad de Cantabria, SPAIN
  29 //                       University of York, UK
  30 //
  31 //   FSF API web pages: http://marte.unican.es/fsf/docs
  32 //                      http://shark.sssup.it/contrib/first/docs/
  33 //
  34 //  This file is part of FRSH API
  35 //
  36 //  FRSH API is free software; you can  redistribute it and/or  modify
  37 //  it under the terms of  the GNU General Public License as published by
  38 //  the Free Software Foundation;  either  version 2, or (at  your option)
  39 //  any later version.
  40 //
  41 //  FRSH API  is distributed  in  the hope  that  it  will  be useful,  but
  42 //  WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  43 //  MERCHANTABILITY  or  FITNESS FOR  A  PARTICULAR PURPOSE. See  the  GNU
  44 //  General Public License for more details.
  45 //
  46 //  You should have  received a  copy of  the  GNU  General Public License
  47 //  distributed  with  FRSH API;  see file COPYING.   If not,  write to the
  48 //  Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  49 //  02111-1307, USA.
  50 //
  51 //  As a special exception, if you include this header file into source
  52 //  files to be compiled, this header file does not by itself cause
  53 //  the resulting executable to be covered by the GNU General Public
  54 //  License.  This exception does not however invalidate any other
  55 //  reasons why the executable file might be covered by the GNU General
  56 //  Public License.
  57 // -----------------------------------------------------------------------
  58 /*-----------------------------------------------------------------------
  59  *                                                         V1.0  Dec 2001
  60  *
  61  *                    't i m e s p e c _ o p e r a t i o n s'
  62  *
  63  *                                      H
  64  *
  65  * File 'timespec_operations.h'                                   by MAR.
  66  *                           (july 2002)  transformed into macros by Jul.
  67  * Some basic operations with the type 'timespec'.
  68  *
  69  * ----------------------------------------------------------------------
  70  *  Copyright (C) 2001   Universidad de Cantabria, SPAIN
  71  *
  72  *  Authors: Mario Aldea Rivas          aldeam@ctr.unican.es
  73  *           Michael Gonzalez Harbour      mgh@ctr.unican.es
  74  *
  75  * MaRTE OS  is free software; you can  redistribute it and/or  modify it
  76  * under the terms of the GNU General Public License  as published by the
  77  * Free Software Foundation;  either  version 2, or (at  your option) any
  78  * later version.
  79  *
  80  * MaRTE OS  is distributed  in the  hope  that  it will be   useful, but
  81  * WITHOUT  ANY  WARRANTY;     without  even the   implied   warranty  of
  82  * MERCHANTABILITY  or  FITNESS FOR A  PARTICULAR PURPOSE.    See the GNU
  83  * General Public License for more details.
  84  *
  85  * You should have received  a  copy of  the  GNU General Public  License
  86  * distributed with MaRTE  OS;  see file COPYING.   If not,  write to the
  87  * Free Software  Foundation,  59 Temple Place  -  Suite 330,  Boston, MA
  88  * 02111-1307, USA.
  89  *
  90  * As a  special exception, if you  link this  unit  with other  files to
  91  * produce an   executable,   this unit  does  not  by  itself cause  the
  92  * resulting executable to be covered by the  GNU General Public License.
  93  * This exception does  not however invalidate  any other reasons why the
  94  * executable file might be covered by the GNU Public License.
  95  *
  96  *---------------------------------------------------------------------------*/
  97 // 16-Jul-2007 SANGORRIN corrections to msec_addto_timespec and msec2timespec
  98 // 23-Jul-2007 SANGORRIN moved t2d and d2t from frsh_time_operations
  99 // (TODO: test for __ALL__ the functions)
 100 // -----------------------------------------------------------------------
 101
 102 #ifndef _MARTE_MISC_TIMESPEC_OPERATIONS_H_
 103 #define _MARTE_MISC_TIMESPEC_OPERATIONS_H_
 104
 105 /**
 106  * @file timespec_operations.h
 107  **/
 108
 109 #include <time.h> // for timespec
 110 #include <string.h> // for memset
 111
 112 #define smaller_timespec(t1, t2) \
 113  ( \
 114   (t1)->tv_sec < (t2)->tv_sec || ((t1)->tv_sec == (t2)->tv_sec &&   \
 115   (t1)->tv_nsec < (t2)->tv_nsec) \
 116  )
 117
 118 #define smaller_or_equal_timespec(t1, t2) \
 119  ( \
 120   (t1)->tv_sec < (t2)->tv_sec || ((t1)->tv_sec == (t2)->tv_sec &&    \
 121   (t1)->tv_nsec <= (t2)->tv_nsec) \
 122  )
 123
 124 #define incr_timespec(t1, t2) \
 125 do { \
 126   (t1)->tv_sec += (t2)->tv_sec; \
 127   (t1)->tv_nsec += (t2)->tv_nsec; \
 128   if ((t1)->tv_nsec >= 1000000000) { \
 129     (t1)->tv_sec ++; \
 130     (t1)->tv_nsec -= 1000000000; \
 131   } \
 132 } while (0)
 133
 134 #define decr_timespec(t1, t2) \
 135 do { \
 136   if ((t1)->tv_nsec < (t2)->tv_nsec) { \
 137     (t1)->tv_sec -= (t2)->tv_sec + 1; \
 138     (t1)->tv_nsec = (t1)->tv_nsec + 1000000000 - (t2)->tv_nsec; \
 139   } else { \
 140     (t1)->tv_sec -= (t2)->tv_sec; \
 141     (t1)->tv_nsec -= (t2)->tv_nsec; \
 142   } \
 143 } while (0)
 144
 145 #define  add_timespec( sum , t1 , t2 ) \
 146 do { \
 147   (sum)->tv_sec  = (t1)->tv_sec  + (t2)->tv_sec; \
 148   (sum)->tv_nsec = (t1)->tv_nsec + (t2)->tv_nsec; \
 149   if ((sum)->tv_nsec >= 1000000000) { \
 150     (sum)->tv_sec ++; \
 151     (sum)->tv_nsec -= 1000000000; \
 152   } \
 153 } while (0)
 154
 155 #define float_to_timespec( f1 , t1 ) \
 156 ( \
 157   (t1)->tv_sec = (int)(f1), \
 158   (t1)->tv_nsec = (int)(((f1)-(float)((t1)->tv_sec))*1000000000.0), \
 159   (t1) \
 160 )
 161
 162 #define float_to_timespec_value(f1, t1) \
 163 ( \
 164   (t1).tv_sec = (int)(f1), \
 165   (t1).tv_nsec = (int)(((f1)-(float)((t1).tv_sec))*1000000000.0), \
 166   (t1) \
 167 )
 168
 169 //---------------//
 170 // msec2timespec //
 171 //---------------//
 172
 173 static inline void msec2timespec(long msec, struct timespec *timespec)
 174 {
 175     memset(timespec, 0, sizeof(struct timespec));
 176
 177     if (msec >= 1000) {
 178         timespec->tv_sec = msec/1000;
 179         timespec->tv_nsec = (msec % 1000) * 1000000;
 180     } else {
 181         timespec->tv_sec = 0;
 182         timespec->tv_nsec = msec * 1000000;
 183     }
 184 }
 185
 186 static inline void timespec2msec(const struct timespec *timespec, long *msec)
 187 {
 188     *msec = 0;
 189
 190     /* We convert first the seconds checking for a possible overflow */
 191     if (timespec->tv_sec < 2147482)
 192     {
 193         *msec = timespec->tv_sec*1000;
 194     }
 195     else
 196     {
 197         *msec = -1;
 198         return;
 199     }
 200
 201     /* Now we add the contribution from the msecs with a truncation */
 202     *msec += (timespec->tv_nsec/1000000);
 203
 204 }
 205
 206 //------------------------//
 207 // timespec_lessthan_msec //
 208 //------------------------//
 209
 210 static inline int timespec_lessthan_msec(struct timespec *timespec, long msec)
 211 {
 212     struct timespec msec_timespec = {0, 0};
 213
 214     msec2timespec(msec, &msec_timespec);
 215     return smaller_timespec(timespec, &msec_timespec);
 216 }
 217
 218 //---------------------//
 219 // msec_addto_timespec //
 220 //---------------------//
 221
 222 static inline void msec_addto_timespec(long msec, struct timespec *timespec)
 223 {
 224     struct timespec msec_timespec = {0, 0};
 225
 226     msec2timespec(msec, &msec_timespec);
 227     incr_timespec(timespec, &msec_timespec);
 228 }
 229
 230 //--------------------------//
 231 // t2d (timespec to double) //
 232 //--------------------------//
 233
 234 static inline double t2d(struct timespec time)
 235 {
 236     return time.tv_nsec*0.000000001 + (double)time.tv_sec;
 237 }
 238
 239 //--------------------------//
 240 // d2t (double to timespec) //
 241 //--------------------------//
 242
 243 static inline struct timespec d2t(double time)
 244 {
 245     struct timespec tmp;
 246
 247     tmp.tv_sec = (long) time;
 248     tmp.tv_nsec = (long)((time - (double)tmp.tv_sec) * 1000000000);
 249
 250     return tmp;
 251 }
 252
 253 #endif /* _MARTE_MISC_TIMESPEC_OPERATIONS_H_ */