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