1/*
2 * Copyright (c) 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
16 *     contributors may be used to endorse or promote products derived from
17 *     this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Portions of this software have been released under the following terms:
31 *
32 * (c) Copyright 1989-1993 OPEN SOFTWARE FOUNDATION, INC.
33 * (c) Copyright 1989-1993 HEWLETT-PACKARD COMPANY
34 * (c) Copyright 1989-1993 DIGITAL EQUIPMENT CORPORATION
35 *
36 * To anyone who acknowledges that this file is provided "AS IS"
37 * without any express or implied warranty:
38 * permission to use, copy, modify, and distribute this file for any
39 * purpose is hereby granted without fee, provided that the above
40 * copyright notices and this notice appears in all source code copies,
41 * and that none of the names of Open Software Foundation, Inc., Hewlett-
42 * Packard Company or Digital Equipment Corporation be used
43 * in advertising or publicity pertaining to distribution of the software
44 * without specific, written prior permission.  Neither Open Software
45 * Foundation, Inc., Hewlett-Packard Company nor Digital
46 * Equipment Corporation makes any representations about the suitability
47 * of this software for any purpose.
48 *
49 * Copyright (c) 2007, Novell, Inc. All rights reserved.
50 * Redistribution and use in source and binary forms, with or without
51 * modification, are permitted provided that the following conditions
52 * are met:
53 *
54 * 1.  Redistributions of source code must retain the above copyright
55 *     notice, this list of conditions and the following disclaimer.
56 * 2.  Redistributions in binary form must reproduce the above copyright
57 *     notice, this list of conditions and the following disclaimer in the
58 *     documentation and/or other materials provided with the distribution.
59 * 3.  Neither the name of Novell Inc. nor the names of its contributors
60 *     may be used to endorse or promote products derived from this
61 *     this software without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
64 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
72 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 *
74 * @APPLE_LICENSE_HEADER_END@
75 */
76
77/*
78**
79**  NAME:
80**
81**      rpcclock.h
82**
83**  FACILITY:
84**
85**      Remote Procedure Call (RPC)
86**
87**  ABSTRACT:
88**
89**
90*/
91
92#ifndef _RPCCLOCK_H
93#define _RPCCLOCK_H	1
94
95/*
96 * Number of times per second the clock ticks (LSB weight for time values).
97 */
98
99#define  RPC_C_CLOCK_HZ             5
100
101#define  RPC_CLOCK_SEC(sec)         ((sec)*RPC_C_CLOCK_HZ)
102#define  RPC_CLOCK_MS(ms)           ((ms)/(1000/RPC_C_CLOCK_HZ))
103
104typedef time_t  rpc_clock_t, *rpc_clock_p_t;
105
106/*
107 * An absolute time, UNIX time(2) format (i.e. time since 00:00:00 GMT,
108 * Jan. 1, 1970, measured in seconds.
109 */
110
111typedef time_t  rpc_clock_unix_t, *rpc_clock_unix_p_t;
112
113#ifdef __cplusplus
114extern "C" {
115#endif
116
117/*
118 * Get the current approximate tick count.  This routine is used to
119 * timestamp data structures.  The tick count returned is only updated
120 * by the rpc_timer routines once each time through the select listen
121 * loop.  This degree of accuracy should be adequate for the purpose
122 * of tracking the age of a data structure.
123 */
124
125PRIVATE rpc_clock_t rpc__clock_stamp (void);
126
127/*
128 * A routine to determine whether a specified time interval has passed.
129 */
130PRIVATE boolean rpc__clock_aged    (
131        rpc_clock_t          /*time*/,
132        rpc_clock_t          /*interval*/
133    );
134
135/*
136 * Update the current tick count.  This routine is the only one that
137 * actually makes system calls to obtain the time, and should only be
138 * called from within the rpc_timer routines themselves.  Everyone else
139 * should use the  routine rpc_timer_get_current_time which returns an
140 * approximate tick count, or rpc_timer_aged which uses the approximate
141 * tick count.  The value returned is the current tick count just
142 * calculated.
143 */
144PRIVATE void rpc__clock_update ( void );
145
146/*
147 * Determine if a UNIX absolute time has expired
148 * (relative to the system's current time).
149 */
150
151PRIVATE boolean rpc__clock_unix_expired (
152        rpc_clock_unix_t    /*time*/
153    );
154
155/*
156 * Convert an rpc_clock_t back to a "struct timespec".
157 */
158
159PRIVATE void rpc__clock_timespec (
160	rpc_clock_t  /*clock*/,
161	struct timespec * /*ts*/
162    );
163
164#ifdef __cplusplus
165}
166#endif
167
168#endif /* _RPCCLOCK_H */
169