L4Re – L4 Runtime Environment
__timeout.h
1 
6 /*
7  * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
8  * Alexander Warg <warg@os.inf.tu-dresden.de>,
9  * Torsten Frenzel <frenzel@os.inf.tu-dresden.de>
10  * economic rights: Technische Universität Dresden (Germany)
11  *
12  * This file is part of TUD:OS and distributed under the terms of the
13  * GNU General Public License 2.
14  * Please see the COPYING-GPL-2 file for details.
15  *
16  * As a special exception, you may use this file as part of a free software
17  * library without restriction. Specifically, if other files instantiate
18  * templates or use macros or inline functions from this file, or you compile
19  * this file and link it with other files to produce an executable, this
20  * file does not by itself cause the resulting executable to be covered by
21  * the GNU General Public License. This exception does not however
22  * invalidate any other reasons why the executable file might be covered by
23  * the GNU General Public License.
24  */
25 #ifndef L4_SYS_TIMEOUT_H__
26 #define L4_SYS_TIMEOUT_H__
27 
28 #include <l4/sys/l4int.h>
29 
47 typedef struct l4_timeout_s {
49 } __attribute__((packed)) l4_timeout_s;
50 
51 
59 typedef union l4_timeout_t {
61  struct
62  {
63 #ifdef __BIG_ENDIAN__
66 #else
69 #endif
70  } p;
72 
73 
79 #define L4_IPC_TIMEOUT_0 ((l4_timeout_s){0x0400})
80 #define L4_IPC_TIMEOUT_NEVER ((l4_timeout_s){0})
81 #define L4_IPC_NEVER_INITIALIZER {0}
82 #define L4_IPC_NEVER ((l4_timeout_t){0})
83 #define L4_IPC_RECV_TIMEOUT_0 ((l4_timeout_t){0x00000400})
84 #define L4_IPC_SEND_TIMEOUT_0 ((l4_timeout_t){0x04000000})
85 #define L4_IPC_BOTH_TIMEOUT_0 ((l4_timeout_t){0x04000400})
87 
97 L4_INLINE
98 l4_timeout_s l4_timeout_rel(unsigned man, unsigned exp) L4_NOTHROW;
99 
100 
110 L4_INLINE
111 l4_timeout_t l4_ipc_timeout(unsigned snd_man, unsigned snd_exp,
112  unsigned rcv_man, unsigned rcv_exp) L4_NOTHROW;
113 
123 L4_INLINE
125 
133 L4_INLINE
135 
143 L4_INLINE
145 
154 L4_INLINE
156 
157 
166 L4_INLINE
168 
178 L4_INLINE
180 
181 
182 /*
183  * Implementation
184  */
185 
186 L4_INLINE
187 l4_timeout_t l4_ipc_timeout(unsigned snd_man, unsigned snd_exp,
188  unsigned rcv_man, unsigned rcv_exp) L4_NOTHROW
189 {
190  l4_timeout_t t;
191  t.p.snd.t = (snd_man & 0x3ff) | ((snd_exp << 10) & 0x7c00);
192  t.p.rcv.t = (rcv_man & 0x3ff) | ((rcv_exp << 10) & 0x7c00);
193  return t;
194 }
195 
196 
197 L4_INLINE
199 {
200  l4_timeout_t t;
201  t.p.snd = snd;
202  t.p.rcv = rcv;
203  return t;
204 }
205 
206 
207 L4_INLINE
209 {
210  to->p.snd = snd;
211 }
212 
213 
214 L4_INLINE
216 {
217  to->p.rcv = rcv;
218 }
219 
220 
221 L4_INLINE
222 l4_timeout_s l4_timeout_rel(unsigned man, unsigned exp) L4_NOTHROW
223 {
224  return (l4_timeout_s){(l4_uint16_t)((man & 0x3ff) | ((exp << 10) & 0x7c00))};
225 }
226 
227 
228 L4_INLINE
230 {
231  if (to.t == 0)
232  return ~0ULL;
233  return (l4_kernel_clock_t)(to.t & 0x3ff) << ((to.t >> 10) & 0x1f);
234 }
235 
236 
237 L4_INLINE
239 {
240  return to.t & 0x8000;
241 }
242 
243 
244 L4_INLINE
246 {
247  if (l4_timeout_is_absolute(to))
248  return 0; /* We cannot retrieve the value ... */
249  else
250  return cur + l4_timeout_rel_get(to);
251 }
252 
253 
254 #endif
#define L4_NOTHROW
Mark a function declaration and definition as never throwing an exception.
Definition: compiler.h:186
l4_uint64_t l4_kernel_clock_t
Kernel clock type.
Definition: l4int.h:64
unsigned int l4_uint32_t
Unsigned 32bit value.
Definition: l4int.h:40
unsigned short int l4_uint16_t
Unsigned 16bit value.
Definition: l4int.h:38
l4_timeout_t l4_ipc_timeout(unsigned snd_man, unsigned snd_exp, unsigned rcv_man, unsigned rcv_exp) L4_NOTHROW
Convert explicit timeout values to l4_timeout_t type.
Definition: __timeout.h:187
union l4_timeout_t l4_timeout_t
Timeout pair.
l4_kernel_clock_t l4_timeout_get(l4_kernel_clock_t cur, l4_timeout_s to) L4_NOTHROW
Get clock value for a clock + a timeout.
Definition: __timeout.h:245
l4_timeout_t l4_timeout(l4_timeout_s snd, l4_timeout_s rcv) L4_NOTHROW
Combine send and receive timeout in a timeout.
Definition: __timeout.h:198
void l4_snd_timeout(l4_timeout_s snd, l4_timeout_t *to) L4_NOTHROW
Set send timeout in given to timeout.
Definition: __timeout.h:208
void l4_rcv_timeout(l4_timeout_s rcv, l4_timeout_t *to) L4_NOTHROW
Set receive timeout in given to timeout.
Definition: __timeout.h:215
l4_kernel_clock_t l4_timeout_rel_get(l4_timeout_s to) L4_NOTHROW
Get clock value of out timeout.
Definition: __timeout.h:229
unsigned l4_timeout_is_absolute(l4_timeout_s to) L4_NOTHROW
Return whether the given timeout is absolute or not.
Definition: __timeout.h:238
l4_timeout_s l4_timeout_rel(unsigned man, unsigned exp) L4_NOTHROW
Get relative timeout consisting of mantissa and exponent.
Definition: __timeout.h:222
struct l4_timeout_s l4_timeout_s
Basic timeout specification.
Basic timeout specification.
Definition: __timeout.h:47
l4_uint16_t t
timeout value
Definition: __timeout.h:48
Timeout pair.
Definition: __timeout.h:59
l4_uint32_t raw
raw value
Definition: __timeout.h:60
l4_timeout_s snd
send timeout
Definition: __timeout.h:68
struct l4_timeout_t::@14 p
combined timeout
l4_timeout_s rcv
receive timeout
Definition: __timeout.h:67