StdLib/Include/sys/time.h

   1 /** @file
   2     System-specific declarations and macros related to time.
   3
   4     Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
   5     This program and the accompanying materials are licensed and made available under
   6     the terms and conditions of the BSD License that accompanies this distribution.
   7     The full text of the license may be found at
   8     http://opensource.org/licenses/bsd-license.
   9
  10     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13     Copyright (c) 1982, 1986, 1993
  14     The Regents of the University of California.  All rights reserved.
  15
  16     Redistribution and use in source and binary forms, with or without
  17     modification, are permitted provided that the following conditions
  18     are met:
  19     1. Redistributions of source code must retain the above copyright
  20       notice, this list of conditions and the following disclaimer.
  21     2. Redistributions in binary form must reproduce the above copyright
  22       notice, this list of conditions and the following disclaimer in the
  23       documentation and/or other materials provided with the distribution.
  24     3. Neither the name of the University nor the names of its contributors
  25       may be used to endorse or promote products derived from this software
  26       without specific prior written permission.
  27
  28     THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31     ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38     SUCH DAMAGE.
  39
  40     time.h  8.5 (Berkeley) 5/4/95
  41     NetBSD: time.h,v 1.56 2006/06/18 21:09:24 uwe Exp
  42  */
  43 #ifndef _SYS_TIME_H_
  44 #define _SYS_TIME_H_
  45
  46 #include  <Uefi.h>
  47 #include  <sys/featuretest.h>
  48 #include  <sys/types.h>
  49
  50 /*
  51  * Traditional *nix structure returned by gettimeofday(2) system call,
  52  * and used in other calls.
  53  */
  54 struct timeval {
  55   LONG32    tv_sec;   /* seconds */
  56   LONG32    tv_usec;  /* and microseconds */
  57 };
  58
  59 /*
  60  * Structure defined by POSIX.1b to be like a timeval.
  61  * This works within EFI since the times really are time_t.
  62  * Note that this is not exactly POSIX compliant since tv_nsec
  63  * is a UINT32 instead of the compliant long.
  64  */
  65 struct timespec {
  66   time_t  tv_sec;   /* seconds */
  67   UINT32  tv_nsec;  /* and nanoseconds */
  68 };
  69
  70 #define TIMEVAL_TO_TIMESPEC(tv, ts) do {        \
  71   (ts)->tv_sec = (tv)->tv_sec;          \
  72   (ts)->tv_nsec = (tv)->tv_usec * 1000;       \
  73 } while (/*CONSTCOND*/0)
  74
  75 #define TIMESPEC_TO_TIMEVAL(tv, ts) do {        \
  76   (tv)->tv_sec = (ts)->tv_sec;          \
  77   (tv)->tv_usec = (ts)->tv_nsec / 1000;       \
  78 } while (/*CONSTCOND*/0)
  79
  80 /* Operations on timevals. */
  81 #define timerclear(tvp)   (tvp)->tv_sec = (tvp)->tv_usec = 0
  82 #define timerisset(tvp)   ((tvp)->tv_sec || (tvp)->tv_usec)
  83
  84 #define timercmp(tvp, uvp, cmp)           \
  85   (((tvp)->tv_sec == (uvp)->tv_sec) ?       \
  86       ((tvp)->tv_usec cmp (uvp)->tv_usec) :     \
  87       ((tvp)->tv_sec cmp (uvp)->tv_sec))
  88
  89 #define timeradd(tvp, uvp, vvp)           \
  90   do {                \
  91     (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec;    \
  92     (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
  93     if ((vvp)->tv_usec >= 1000000) {      \
  94       (vvp)->tv_sec++;        \
  95       (vvp)->tv_usec -= 1000000;      \
  96     }             \
  97   } while (/* CONSTCOND */ 0)
  98
  99 #define timersub(tvp, uvp, vvp)           \
 100   do {                \
 101     (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec;    \
 102     (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
 103     if ((vvp)->tv_usec < 0) {       \
 104       (vvp)->tv_sec--;        \
 105       (vvp)->tv_usec += 1000000;      \
 106     }             \
 107   } while (/* CONSTCOND */ 0)
 108
 109 /* Operations on timespecs. */
 110 #define timespecclear(tsp)    (tsp)->tv_sec = (tsp)->tv_nsec = 0
 111 #define timespecisset(tsp)    ((tsp)->tv_sec || (tsp)->tv_nsec)
 112
 113 #define timespeccmp(tsp, usp, cmp)          \
 114   (((tsp)->tv_sec == (usp)->tv_sec) ?       \
 115       ((tsp)->tv_nsec cmp (usp)->tv_nsec) :     \
 116       ((tsp)->tv_sec cmp (usp)->tv_sec))
 117
 118 #define timespecadd(tsp, usp, vsp)          \
 119   do {                \
 120     (vsp)->tv_sec = (tsp)->tv_sec + (usp)->tv_sec;    \
 121     (vsp)->tv_nsec = (tsp)->tv_nsec + (usp)->tv_nsec; \
 122     if ((vsp)->tv_nsec >= 1000000000L) {      \
 123       (vsp)->tv_sec++;        \
 124       (vsp)->tv_nsec -= 1000000000L;      \
 125     }             \
 126   } while (/* CONSTCOND */ 0)
 127
 128 #define timespecsub(tsp, usp, vsp)          \
 129   do {                \
 130     (vsp)->tv_sec = (tsp)->tv_sec - (usp)->tv_sec;    \
 131     (vsp)->tv_nsec = (tsp)->tv_nsec - (usp)->tv_nsec; \
 132     if ((vsp)->tv_nsec < 0) {       \
 133       (vsp)->tv_sec--;        \
 134       (vsp)->tv_nsec += 1000000000L;      \
 135     }             \
 136   } while (/* CONSTCOND */ 0)
 137
 138 /*
 139  * Names of the interval timers, and structure
 140  * defining a timer setting.
 141  */
 142 #define ITIMER_REAL     0
 143 #define ITIMER_VIRTUAL  1
 144 #define ITIMER_PROF     2
 145
 146 struct  itimerval {
 147   struct  timeval it_interval;  /* timer interval */
 148   struct  timeval it_value; /* current value */
 149 };
 150
 151 /*
 152  * Structure defined by POSIX.1b to be like a itimerval, but with
 153  * timespecs. Used in the timer_*() system calls.
 154  */
 155 struct  itimerspec {
 156   struct  timespec it_interval;
 157   struct  timespec it_value;
 158 };
 159
 160 #define CLOCK_REALTIME  0
 161 #define CLOCK_VIRTUAL   1
 162 #define CLOCK_PROF      2
 163 #define CLOCK_MONOTONIC 3
 164
 165 #define TIMER_RELTIME   0x0 /* relative timer */
 166 #define TIMER_ABSTIME   0x1 /* absolute timer */
 167
 168 #if 0
 169   #if (_POSIX_C_SOURCE - 0) >= 200112L || \
 170       (defined(_XOPEN_SOURCE) && defined(_XOPEN_SOURCE_EXTENDED)) || \
 171       (_XOPEN_SOURCE - 0) >= 500 || defined(_NETBSD_SOURCE)
 172     #include  <sys/select.h>
 173   #endif
 174 #endif  /* if 0 */
 175
 176 #include  <sys/EfiCdefs.h>
 177 #include  <time.h>
 178
 179 /* Functions useful for dealing with EFI */
 180 __BEGIN_DECLS
 181
 182 /* Convert an EFI_TIME structure into a time_t value. */
 183 time_t  Efi2Time( EFI_TIME *EfiBDtime);
 184
 185 /* Convert an EFI_TIME structure into a C Standard tm structure. */
 186 void    Efi2Tm( EFI_TIME *EfiBDtime, struct tm *NewTime);
 187
 188 __END_DECLS
 189
 190 /* BSD compatibility functions */
 191 int gettimeofday (struct timeval *tp, void *ignore);
 192 /* POSIX compatibility functions */
 193 int getitimer (int which, struct itimerval *value);
 194 int setitimer (int which, const struct itimerval *value, struct itimerval *ovalue);
 195
 196 #endif /* !_SYS_TIME_H_ */