[mirror_edk2.git] / StdLib / Include / sys / time.h

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