-
Notifications
You must be signed in to change notification settings - Fork 138
/
timer.pmc
429 lines (314 loc) · 11.1 KB
/
timer.pmc
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/*
Copyright (C) 2001-2014, Parrot Foundation.
=head1 NAME
src/pmc/timer.pmc - Timer PMC
=head1 SYNOPSIS
new P0, 'Timer'
set P0[.PARROT_TIMER_SEC], I_seconds # whole seconds
set P0[.PARROT_TIMER_USEC], I_micro seconds # and/or micro seconds
set P0[.PARROT_TIMER_NSEC], N_seconds_frac # or fraction in seconds
set P0[.PARROT_TIMER_REPEAT], I_repeat # 0 = one shot ...
set P0[.PARROT_TIMER_HANDLER], P_sub # set handler sub PMC
invoke P0 # start timer
set P0[.PARROT_TIMER_RUNNING], 1 # same
new P0, 'Timer', P1 # set everything
set I0, P0[.PARROT_TIMER_SEC] # query current timer status
set N0, P0[.PARROT_TIMER_NSEC]
...
set P0[.PARROT_TIMER_RUNNING], 0 # turn timer off
=head1 DESCRIPTION
This is the Timer base class
The Timer resolution is operating system dependent. It's only guaranteed
that the Timer will fire some time after the programmed interval.
The Timer stops after invoking the handler (repeat + 1) times. To create a
Timer that will run forever, set "repeat" to -1. Turning the Timer off
preserves set values; the Timer is not destroyed.
When setting both C<PARROT_TIMER_SEC> and C<PARROT_TIMER_USEC> it must
be done in that sequence, whole seconds first. If a timer is constructed
with an initializer and it should be run immediately, the
C<PARROT_TIMER_RUNNING> value has to be in the last key of the
initializer.
=head2 Functions
=over 4
=cut
*/
#include "parrot/scheduler_private.h"
#include "pmc/pmc_task.h"
/* HEADERIZER HFILE: none */
/* HEADERIZER BEGIN: static */
/* HEADERIZER END: static */
pmclass Timer provides invokable auto_attrs {
ATTR PMC *code; /* The sub to execute */
ATTR FLOATVAL birthtime; /* When the timer was created */
ATTR FLOATVAL duration; /* The duration of the timer pause */
ATTR FLOATVAL interval; /* How often to repeat */
ATTR INTVAL repeat; /* Whether to repeat:
* 0 = run once (no repeat), -1 = forever */
ATTR INTVAL started; /* 0 = delay for duration then invoke
1 = delay for interval then invoke */
ATTR INTVAL running; /* 0 = never started or since cancelled */
/*
=item C<void init()>
Initializes the timer.
=cut
*/
VTABLE void init() {
Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
SUPER();
/* Set up the core struct. */
core_struct->code = PMCNULL;
core_struct->birthtime = 0.0;
core_struct->duration = 0.0;
core_struct->interval = 0.0;
core_struct->repeat = 0;
core_struct->started = 0;
core_struct->running = 0;
}
/*
=item C<void init_pmc(PMC *init)>
Takes an even-length collection of keys and values.
=cut
*/
VTABLE void init_pmc(PMC *init) :manual_wb {
const INTVAL n = VTABLE_get_integer(INTERP, init);
INTVAL i;
SELF.init();
for (i = 0; i < n; i += 2) {
const INTVAL key = VTABLE_get_integer_keyed_int(INTERP, init, i);
switch (key) {
case PARROT_TIMER_SEC:
case PARROT_TIMER_USEC:
case PARROT_TIMER_REPEAT:
case PARROT_TIMER_RUNNING:
{
const INTVAL val = VTABLE_get_integer_keyed_int(INTERP, init, i+1);
SELF.set_integer_keyed_int(key, val);
}
break;
case PARROT_TIMER_NSEC:
case PARROT_TIMER_INTERVAL:
{
const FLOATVAL nval = VTABLE_get_number_keyed_int(INTERP, init, i+1);
SELF.set_number_keyed_int(key, nval);
}
break;
case PARROT_TIMER_HANDLER:
{
PMC * const pval = VTABLE_get_pmc_keyed_int(INTERP, init, i+1);
SELF.set_pmc_keyed_int(key, pval);
}
break;
default:
break;
}
}
}
/*
=item C<PMC *clone()>
Create a copy of the timer, resetting status, id, and birthtime.
=cut
*/
VTABLE PMC *clone() :no_wb {
PMC * const copy = Parrot_pmc_new(INTERP, SELF->vtable->base_type);
Parrot_Timer_attributes * const new_struct = PARROT_TIMER(copy);
const Parrot_Timer_attributes * const old_struct = PARROT_TIMER(SELF);
new_struct->duration = old_struct->duration;
new_struct->interval = old_struct->interval;
new_struct->repeat = old_struct->repeat;
new_struct->code = old_struct->code;
return copy;
}
/*
=item C<INTVAL get_integer_keyed_int(INTVAL key)>
Returns the timer info for C<key>.
=cut
*/
VTABLE INTVAL get_integer_keyed_int(INTVAL key) :no_wb {
const Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
const FLOATVAL absolute_time = core_struct->birthtime + core_struct->duration;
UNUSED(INTERP)
switch (key) {
case PARROT_TIMER_SEC:
return (INTVAL)absolute_time;
case PARROT_TIMER_USEC:
return (INTVAL)((absolute_time - (INTVAL)absolute_time) *1000000.0);
case PARROT_TIMER_REPEAT:
return (INTVAL) core_struct->repeat;
case PARROT_TIMER_INTERVAL:
return (INTVAL) core_struct->interval;
case PARROT_TIMER_RUNNING:
return 0;
default:
return -1;
}
}
/*
=item C<PMC *get_pmc_keyed_int(INTVAL key)>
Returns the PMC associated with C<key>.
=cut
*/
VTABLE PMC *get_pmc_keyed_int(INTVAL key) :no_wb {
UNUSED(INTERP)
if (key == PARROT_TIMER_HANDLER) {
const Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
return core_struct->code;
}
return PMCNULL;
}
/*
=item C<FLOATVAL get_number_keyed_int(INTVAL key)>
Returns the number associated with C<key>.
=cut
*/
VTABLE FLOATVAL get_number_keyed_int(INTVAL key) :no_wb {
const Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
UNUSED(INTERP)
switch (key) {
case PARROT_TIMER_NSEC:
return core_struct->birthtime + core_struct->duration;
case PARROT_TIMER_INTERVAL:
return core_struct->interval;
default:
break;
}
return -1.0;
}
/*
=item C<void set_integer_keyed_int(INTVAL key, INTVAL value)>
Sets the value associated with C<key> to C<value>.
=cut
*/
VTABLE void set_integer_keyed_int(INTVAL key, INTVAL value) {
Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
switch (key) {
case PARROT_TIMER_SEC:
core_struct->duration = value;
break;
case PARROT_TIMER_USEC:
core_struct->duration += value / 1000000.0;
break;
case PARROT_TIMER_REPEAT:
core_struct->repeat = value;
break;
case PARROT_TIMER_INTERVAL:
core_struct->interval = value;
break;
case PARROT_TIMER_RUNNING:
core_struct->running = value;
if (value)
(void) SELF.invoke(0);
break;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL,
EXCEPTION_INVALID_OPERATION,
"Unknown timer type in Timer.set_integer_keyed_int: %d",
key);
}
}
/*
=item C<void set_pmc_keyed_int(INTVAL key, PMC *value)>
Sets the PMC associated with C<key> to C<*value>.
=cut
*/
VTABLE void set_pmc_keyed_int(INTVAL key, PMC *value) :manual_wb {
if (key == PARROT_TIMER_HANDLER) {
SET_ATTR_code(INTERP, SELF, value);
PARROT_GC_WRITE_BARRIER(INTERP, SELF);
}
}
/*
=item C<opcode_t *invoke(void *next)>
Either:
Initially schedule the timer.
or
Invoke the codeblock and schedule any repeats.
=cut
*/
VTABLE opcode_t *invoke(void *next) :no_wb {
Parrot_Timer_attributes *const timer = PARROT_TIMER(SELF);
FLOATVAL now_time;
PMC* alarm;
PMC* task;
Parrot_Task_attributes *tdata;
/* If the timer has been cancelled, we're done */
if (timer->running == 0)
return (opcode_t*) next;
if (timer->started == 0) {
/* We're being called to start the timer. */
timer->started = 1;
timer->running = 1;
now_time = Parrot_floatval_time();
task = Parrot_pmc_new(INTERP, enum_class_Task);
tdata = PARROT_TASK(task);
tdata->code = SELF;
alarm = Parrot_pmc_new(INTERP, enum_class_Alarm);
VTABLE_set_number_keyed_int(INTERP, alarm, PARROT_ALARM_TIME,
now_time + timer->duration);
VTABLE_set_pmc_keyed_int(INTERP, alarm, PARROT_ALARM_TASK, task);
next = VTABLE_invoke(INTERP, alarm, next);
}
else {
/* This is the timer triggering. */
if (!PMC_IS_NULL(timer->code)) {
Parrot_ext_call(interp, timer->code, "->");
}
/* Repeat semantics as documented. */
if (timer->repeat != 0) {
if (timer->repeat > 0)
timer->repeat--;
now_time = Parrot_floatval_time();
task = Parrot_pmc_new(INTERP, enum_class_Task);
tdata = PARROT_TASK(task);
tdata->code = SELF;
alarm = Parrot_pmc_new(INTERP, enum_class_Alarm);
VTABLE_set_number_keyed_int(INTERP, alarm, PARROT_ALARM_TIME,
now_time + timer->interval);
VTABLE_set_pmc_keyed_int(INTERP, alarm, PARROT_ALARM_TASK, task);
next = VTABLE_invoke(INTERP, alarm, next);
}
}
return (opcode_t*) next;
}
/*
=item C<void set_number_keyed_int(INTVAL key, FLOATVAL value)>
Sets the floating-point value associated with C<key> to C<value>.
=cut
*/
VTABLE void set_number_keyed_int(INTVAL key, FLOATVAL value) {
Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
switch (key) {
case PARROT_TIMER_NSEC:
core_struct->duration = value;
break;
case PARROT_TIMER_INTERVAL:
core_struct->interval = value;
break;
default:
Parrot_ex_throw_from_c_args(INTERP, NULL,
EXCEPTION_INVALID_OPERATION,
"Unknown timer attribute in Timer.set_number_keyed_int: %d",
key);
}
}
/*
=item C<void mark()>
Mark any referenced strings and PMCs.
=cut
*/
VTABLE void mark() :no_wb {
if (PARROT_TIMER(SELF)) {
Parrot_Timer_attributes * const core_struct = PARROT_TIMER(SELF);
Parrot_gc_mark_PMC_alive(INTERP, core_struct->code);
}
}
}
/*
=back
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
*/