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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
/*
* Waitable timers management
*
* Copyright (C) 1999 Alexandre Julliard
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include "config.h"
#include "wine/port.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/types.h>
#include <stdarg.h>
#include "ntstatus.h"
#define WIN32_NO_STATUS
#include "windef.h"
#include "winternl.h"
#include "file.h"
#include "handle.h"
#include "request.h"
struct timer
{
struct object obj; /* object header */
int manual; /* manual reset */
int signaled; /* current signaled state */
unsigned int period; /* timer period in ms */
timeout_t when; /* next expiration */
struct timeout_user *timeout; /* timeout user */
struct thread *thread; /* thread that set the APC function */
client_ptr_t callback; /* callback APC function */
client_ptr_t arg; /* callback argument */
};
static void timer_dump( struct object *obj, int verbose );
static struct object_type *timer_get_type( struct object *obj );
static int timer_signaled( struct object *obj, struct thread *thread );
static int timer_satisfied( struct object *obj, struct thread *thread );
static unsigned int timer_map_access( struct object *obj, unsigned int access );
static void timer_destroy( struct object *obj );
static const struct object_ops timer_ops =
{
sizeof(struct timer), /* size */
timer_dump, /* dump */
timer_get_type, /* get_type */
add_queue, /* add_queue */
remove_queue, /* remove_queue */
timer_signaled, /* signaled */
timer_satisfied, /* satisfied */
no_signal, /* signal */
no_get_fd, /* get_fd */
timer_map_access, /* map_access */
default_get_sd, /* get_sd */
default_set_sd, /* set_sd */
no_lookup_name, /* lookup_name */
no_open_file, /* open_file */
no_close_handle, /* close_handle */
timer_destroy /* destroy */
};
/* create a timer object */
static struct timer *create_timer( struct directory *root, const struct unicode_str *name,
unsigned int attr, int manual )
{
struct timer *timer;
if ((timer = create_named_object_dir( root, name, attr, &timer_ops )))
{
if (get_error() != STATUS_OBJECT_NAME_EXISTS)
{
/* initialize it if it didn't already exist */
timer->manual = manual;
timer->signaled = 0;
timer->when = 0;
timer->period = 0;
timer->timeout = NULL;
timer->thread = NULL;
}
}
return timer;
}
/* callback on timer expiration */
static void timer_callback( void *private )
{
struct timer *timer = (struct timer *)private;
/* queue an APC */
if (timer->thread)
{
apc_call_t data;
memset( &data, 0, sizeof(data) );
if (timer->callback)
{
data.type = APC_TIMER;
data.timer.func = timer->callback;
data.timer.time = timer->when;
data.timer.arg = timer->arg;
}
else data.type = APC_NONE; /* wake up only */
if (!thread_queue_apc( timer->thread, &timer->obj, &data ))
{
release_object( timer->thread );
timer->thread = NULL;
}
}
if (timer->period) /* schedule the next expiration */
{
timer->when += (timeout_t)timer->period * 10000;
timer->timeout = add_timeout_user( timer->when, timer_callback, timer );
}
else timer->timeout = NULL;
/* wake up waiters */
timer->signaled = 1;
wake_up( &timer->obj, 0 );
}
/* cancel a running timer */
static int cancel_timer( struct timer *timer )
{
int signaled = timer->signaled;
if (timer->timeout)
{
remove_timeout_user( timer->timeout );
timer->timeout = NULL;
}
if (timer->thread)
{
thread_cancel_apc( timer->thread, &timer->obj, APC_TIMER );
release_object( timer->thread );
timer->thread = NULL;
}
return signaled;
}
/* set the timer expiration and period */
static int set_timer( struct timer *timer, timeout_t expire, unsigned int period,
client_ptr_t callback, client_ptr_t arg )
{
int signaled = cancel_timer( timer );
if (timer->manual)
{
period = 0; /* period doesn't make any sense for a manual timer */
timer->signaled = 0;
}
timer->when = (expire <= 0) ? current_time - expire : max( expire, current_time );
timer->period = period;
timer->callback = callback;
timer->arg = arg;
if (callback) timer->thread = (struct thread *)grab_object( current );
timer->timeout = add_timeout_user( timer->when, timer_callback, timer );
return signaled;
}
static void timer_dump( struct object *obj, int verbose )
{
struct timer *timer = (struct timer *)obj;
assert( obj->ops == &timer_ops );
fprintf( stderr, "Timer manual=%d when=%s period=%u ",
timer->manual, get_timeout_str(timer->when), timer->period );
dump_object_name( &timer->obj );
fputc( '\n', stderr );
}
static struct object_type *timer_get_type( struct object *obj )
{
static const WCHAR name[] = {'T','i','m','e','r'};
static const struct unicode_str str = { name, sizeof(name) };
return get_object_type( &str );
}
static int timer_signaled( struct object *obj, struct thread *thread )
{
struct timer *timer = (struct timer *)obj;
assert( obj->ops == &timer_ops );
return timer->signaled;
}
static int timer_satisfied( struct object *obj, struct thread *thread )
{
struct timer *timer = (struct timer *)obj;
assert( obj->ops == &timer_ops );
if (!timer->manual) timer->signaled = 0;
return 0;
}
static unsigned int timer_map_access( struct object *obj, unsigned int access )
{
if (access & GENERIC_READ) access |= STANDARD_RIGHTS_READ | SYNCHRONIZE | TIMER_QUERY_STATE;
if (access & GENERIC_WRITE) access |= STANDARD_RIGHTS_WRITE | TIMER_MODIFY_STATE;
if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
if (access & GENERIC_ALL) access |= TIMER_ALL_ACCESS;
return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
}
static void timer_destroy( struct object *obj )
{
struct timer *timer = (struct timer *)obj;
assert( obj->ops == &timer_ops );
if (timer->timeout) remove_timeout_user( timer->timeout );
if (timer->thread) release_object( timer->thread );
}
/* create a timer */
DECL_HANDLER(create_timer)
{
struct timer *timer;
struct unicode_str name;
struct directory *root = NULL;
reply->handle = 0;
get_req_unicode_str( &name );
if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
return;
if ((timer = create_timer( root, &name, req->attributes, req->manual )))
{
reply->handle = alloc_handle( current->process, timer, req->access, req->attributes );
release_object( timer );
}
if (root) release_object( root );
}
/* open a handle to a timer */
DECL_HANDLER(open_timer)
{
struct unicode_str name;
struct directory *root = NULL;
struct timer *timer;
get_req_unicode_str( &name );
if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
return;
if ((timer = open_object_dir( root, &name, req->attributes, &timer_ops )))
{
reply->handle = alloc_handle( current->process, &timer->obj, req->access, req->attributes );
release_object( timer );
}
if (root) release_object( root );
}
/* set a waitable timer */
DECL_HANDLER(set_timer)
{
struct timer *timer;
if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
TIMER_MODIFY_STATE, &timer_ops )))
{
reply->signaled = set_timer( timer, req->expire, req->period, req->callback, req->arg );
release_object( timer );
}
}
/* cancel a waitable timer */
DECL_HANDLER(cancel_timer)
{
struct timer *timer;
if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
TIMER_MODIFY_STATE, &timer_ops )))
{
reply->signaled = cancel_timer( timer );
release_object( timer );
}
}
/* Get information on a waitable timer */
DECL_HANDLER(get_timer_info)
{
struct timer *timer;
if ((timer = (struct timer *)get_handle_obj( current->process, req->handle,
TIMER_QUERY_STATE, &timer_ops )))
{
reply->when = timer->when;
reply->signaled = timer->signaled;
release_object( timer );
}
}