xref: /xnu-8020.121.3/osfmk/mach/time_value.h (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions /*
2*fdd8201dSApple OSS Distributions  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3*fdd8201dSApple OSS Distributions  *
4*fdd8201dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*fdd8201dSApple OSS Distributions  *
6*fdd8201dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*fdd8201dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*fdd8201dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*fdd8201dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*fdd8201dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*fdd8201dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*fdd8201dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*fdd8201dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*fdd8201dSApple OSS Distributions  *
15*fdd8201dSApple OSS Distributions  * Please obtain a copy of the License at
16*fdd8201dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*fdd8201dSApple OSS Distributions  *
18*fdd8201dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*fdd8201dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*fdd8201dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*fdd8201dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*fdd8201dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*fdd8201dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*fdd8201dSApple OSS Distributions  * limitations under the License.
25*fdd8201dSApple OSS Distributions  *
26*fdd8201dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*fdd8201dSApple OSS Distributions  */
28*fdd8201dSApple OSS Distributions /*
29*fdd8201dSApple OSS Distributions  * @OSF_COPYRIGHT@
30*fdd8201dSApple OSS Distributions  */
31*fdd8201dSApple OSS Distributions /*
32*fdd8201dSApple OSS Distributions  * Mach Operating System
33*fdd8201dSApple OSS Distributions  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
34*fdd8201dSApple OSS Distributions  * All Rights Reserved.
35*fdd8201dSApple OSS Distributions  *
36*fdd8201dSApple OSS Distributions  * Permission to use, copy, modify and distribute this software and its
37*fdd8201dSApple OSS Distributions  * documentation is hereby granted, provided that both the copyright
38*fdd8201dSApple OSS Distributions  * notice and this permission notice appear in all copies of the
39*fdd8201dSApple OSS Distributions  * software, derivative works or modified versions, and any portions
40*fdd8201dSApple OSS Distributions  * thereof, and that both notices appear in supporting documentation.
41*fdd8201dSApple OSS Distributions  *
42*fdd8201dSApple OSS Distributions  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43*fdd8201dSApple OSS Distributions  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44*fdd8201dSApple OSS Distributions  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45*fdd8201dSApple OSS Distributions  *
46*fdd8201dSApple OSS Distributions  * Carnegie Mellon requests users of this software to return to
47*fdd8201dSApple OSS Distributions  *
48*fdd8201dSApple OSS Distributions  *  Software Distribution Coordinator  or  [email protected]
49*fdd8201dSApple OSS Distributions  *  School of Computer Science
50*fdd8201dSApple OSS Distributions  *  Carnegie Mellon University
51*fdd8201dSApple OSS Distributions  *  Pittsburgh PA 15213-3890
52*fdd8201dSApple OSS Distributions  *
53*fdd8201dSApple OSS Distributions  * any improvements or extensions that they make and grant Carnegie Mellon
54*fdd8201dSApple OSS Distributions  * the rights to redistribute these changes.
55*fdd8201dSApple OSS Distributions  */
56*fdd8201dSApple OSS Distributions 
57*fdd8201dSApple OSS Distributions #ifndef _MACH_TIME_VALUE_H_
58*fdd8201dSApple OSS Distributions #define _MACH_TIME_VALUE_H_
59*fdd8201dSApple OSS Distributions 
60*fdd8201dSApple OSS Distributions #include <mach/machine/vm_types.h>
61*fdd8201dSApple OSS Distributions 
62*fdd8201dSApple OSS Distributions /*
63*fdd8201dSApple OSS Distributions  *	Time value returned by kernel.
64*fdd8201dSApple OSS Distributions  */
65*fdd8201dSApple OSS Distributions 
66*fdd8201dSApple OSS Distributions struct time_value {
67*fdd8201dSApple OSS Distributions 	integer_t seconds;
68*fdd8201dSApple OSS Distributions 	integer_t microseconds;
69*fdd8201dSApple OSS Distributions };
70*fdd8201dSApple OSS Distributions 
71*fdd8201dSApple OSS Distributions typedef struct time_value       time_value_t;
72*fdd8201dSApple OSS Distributions 
73*fdd8201dSApple OSS Distributions /*
74*fdd8201dSApple OSS Distributions  *	Macros to manipulate time values.  Assume that time values
75*fdd8201dSApple OSS Distributions  *	are normalized (microseconds <= 999999).
76*fdd8201dSApple OSS Distributions  */
77*fdd8201dSApple OSS Distributions #define TIME_MICROS_MAX (1000000)
78*fdd8201dSApple OSS Distributions 
79*fdd8201dSApple OSS Distributions #define time_value_add_usec(val, micros)        {       \
80*fdd8201dSApple OSS Distributions 	if (((val)->microseconds += (micros))           \
81*fdd8201dSApple OSS Distributions 	        >= TIME_MICROS_MAX) {                   \
82*fdd8201dSApple OSS Distributions 	    (val)->microseconds -= TIME_MICROS_MAX;     \
83*fdd8201dSApple OSS Distributions 	    (val)->seconds++;                           \
84*fdd8201dSApple OSS Distributions 	}                                               \
85*fdd8201dSApple OSS Distributions }
86*fdd8201dSApple OSS Distributions 
87*fdd8201dSApple OSS Distributions #define time_value_add(result, addend)          {               \
88*fdd8201dSApple OSS Distributions 	(result)->microseconds += (addend)->microseconds;       \
89*fdd8201dSApple OSS Distributions 	(result)->seconds += (addend)->seconds;                 \
90*fdd8201dSApple OSS Distributions 	if ((result)->microseconds >= TIME_MICROS_MAX) {        \
91*fdd8201dSApple OSS Distributions 	    (result)->microseconds -= TIME_MICROS_MAX;          \
92*fdd8201dSApple OSS Distributions 	    (result)->seconds++;                                \
93*fdd8201dSApple OSS Distributions 	}                                                       \
94*fdd8201dSApple OSS Distributions }
95*fdd8201dSApple OSS Distributions 
96*fdd8201dSApple OSS Distributions #endif  /* _MACH_TIME_VALUE_H_ */
97