summaryrefslogtreecommitdiff
path: root/include/mach/time_value.h
blob: 3a816b225c6238616fa037d05de022da68d5e800 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */

#ifndef	_MACH_TIME_VALUE_H_
#define	_MACH_TIME_VALUE_H_

#include <mach/machine/vm_types.h>

/*
 *	Time value returned by kernel.
 */

struct rpc_time_value {
	/* TODO: this should be 64 bits regardless of the arch to be Y2038 proof. */
	rpc_long_integer_t seconds;
	integer_t microseconds;
};
typedef struct rpc_time_value rpc_time_value_t;

/*
 *	Time value used by kernel interfaces. Ideally they should be migrated
 *	to use time_value64 below.
 */
struct time_value {
	long_integer_t	seconds;
	integer_t	microseconds;
};
typedef	struct time_value	time_value_t;

/*
 * Time value used internally by the kernel that uses 64 bits to track seconds
 * and nanoseconds. Note that the current resolution is only microseconds.
 */
struct time_value64 {
	int64_t seconds;
	int64_t nanoseconds;
};
typedef struct time_value64 time_value64_t;

/**
 * Functions used by Mig to perform user to kernel conversion and vice-versa.
 * We only do this because we may run a 64 bit kernel with a 32 bit user space.
 */
static __inline__ rpc_time_value_t convert_time_value_to_user(time_value_t tv)
{
	rpc_time_value_t user = {.seconds = tv.seconds, .microseconds = tv.microseconds};
	return user;
}
static __inline__ time_value_t convert_time_value_from_user(rpc_time_value_t tv)
{
	time_value_t kernel = {.seconds = tv.seconds, .microseconds = tv.microseconds};
	return kernel;
}

/*
 *	Macros to manipulate time values.  Assume that time values
 *	are normalized (microseconds <= 999999).
 */
#define	TIME_MICROS_MAX	(1000000)
#define	TIME_NANOS_MAX	(1000000000)

#define time_value_assert(val)			\
  assert(0 <= (val)->microseconds && (val)->microseconds < TIME_MICROS_MAX);

#define time_value64_assert(val)			\
  assert(0 <= (val)->nanoseconds && (val)->nanoseconds < TIME_NANOS_MAX);

#define	time_value_add_usec(val, micros)	{	\
	time_value_assert(val);				\
	if (((val)->microseconds += (micros))		\
		>= TIME_MICROS_MAX) {			\
	    (val)->microseconds -= TIME_MICROS_MAX;	\
	    (val)->seconds++;				\
	}						\
	time_value_assert(val);				\
}

#define	time_value64_add_nanos(val, nanos)	{	\
	time_value64_assert(val);			\
	if (((val)->nanoseconds += (nanos))		\
		>= TIME_NANOS_MAX) {			\
	    (val)->nanoseconds -= TIME_NANOS_MAX;	\
	    (val)->seconds++;				\
	}						\
	time_value64_assert(val);			\
}

#define	time_value64_sub_nanos(val, nanos)	{	\
	time_value64_assert(val);			\
	if (((val)->nanoseconds -= (nanos)) < 0) {	\
	    (val)->nanoseconds += TIME_NANOS_MAX;	\
	    (val)->seconds--;				\
	}						\
	time_value64_assert(val);				\
}

#define	time_value_add(result, addend) {			\
    time_value_assert(addend);					\
    (result)->seconds += (addend)->seconds;			\
    time_value_add_usec(result, (addend)->microseconds);	\
  }

#define	time_value64_add(result, addend) {									\
    time_value64_assert(addend);														\
    (result)->seconds += (addend)->seconds;									\
    time_value64_add_nanos(result, (addend)->nanoseconds);	\
  }

#define	time_value64_sub(result, subtrahend) {									\
    time_value64_assert(subtrahend);														\
    (result)->seconds -= (subtrahend)->seconds;									\
    time_value64_sub_nanos(result, (subtrahend)->nanoseconds);	\
  }

#define TIME_VALUE64_TO_TIME_VALUE(tv64, tv) do {			\
		(tv)->seconds = (tv64)->seconds;									\
		(tv)->microseconds = (tv64)->nanoseconds / 1000;	\
} while(0)

#define TIME_VALUE_TO_TIME_VALUE64(tv, tv64) do {			\
		(tv64)->seconds = (tv)->seconds;									\
		(tv64)->nanoseconds = (tv)->microseconds * 1000;	\
} while(0)

/*
 *	Time value available through the mapped-time interface.
 *	Read this mapped value with
 *		do {
 *			secs = mtime->seconds;
 *			__sync_synchronize();
 *			usecs = mtime->microseconds;
 *			__sync_synchronize();
 *		} while (secs != mtime->check_seconds);
 */

typedef struct mapped_time_value {
	integer_t seconds;
	integer_t microseconds;
	integer_t check_seconds;
	struct time_value64 time_value;
	int64_t check_seconds64;
} mapped_time_value_t;

/* Macros for converting between struct timespec and time_value_t. */

#define TIME_VALUE_TO_TIMESPEC(tv, ts) do {                             \
        (ts)->tv_sec = (tv)->seconds;                                   \
        (ts)->tv_nsec = (tv)->microseconds * 1000;                      \
} while(0)

#define TIMESPEC_TO_TIME_VALUE(tv, ts) do {                             \
        (tv)->seconds = (ts)->tv_sec;                                   \
        (tv)->microseconds = (ts)->tv_nsec / 1000;                      \
} while(0)

#endif	/* _MACH_TIME_VALUE_H_ */