-
Notifications
You must be signed in to change notification settings - Fork 138
/
scheduler.pmc
560 lines (371 loc) · 14.3 KB
/
scheduler.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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
/*
Copyright (C) 2001-2008, The Perl Foundation.
$Id$
=head1 NAME
src/pmc/scheduler.pmc - The concurrency scheduler
=head1 DESCRIPTION
Implements the core concurrency scheduler.
=head2 Vtable Functions
=over 4
=cut
*/
#include "parrot/parrot.h"
#include "parrot/scheduler_private.h"
pmclass Scheduler need_ext {
ATTR INTVAL id; /* The scheduler's ID. */
ATTR INTVAL max_tid; /* The highest assigned task ID. */
ATTR INTVAL pending; /* A count of pending tasks (cached for fast
lookup). */
ATTR PMC *task_list; /* The current list of tasks. */
ATTR PMC *task_index; /* An index into the current list of tasks,
ordered by priority. */
ATTR PMC *wait_index; /* An unordered index of inactive tasks. */
ATTR PMC *handlers; /* The list of currently active handlers. */
ATTR PMC *messages; /* A message queue used for communication
between schedulers. */
ATTR Parrot_mutex msg_lock; /* Lock to synchronize the message queue. */
ATTR Parrot_Interp interp; /* A link to the scheduler's interpreter. */
/*
=item C<void init()>
Initializes a concurrency scheduler object.
=cut
*/
VTABLE void init() {
Parrot_Scheduler_attributes * const core_struct =
mem_allocate_zeroed_typed(Parrot_Scheduler_attributes);
/* Set flags for custom DOD mark and destroy. */
PObj_custom_mark_SET(SELF);
PObj_active_destroy_SET(SELF);
/* Set up the core struct. */
PMC_data(SELF) = core_struct;
core_struct->id = 0;
core_struct->max_tid = 0;
core_struct->task_list = pmc_new(interp, enum_class_Hash);
core_struct->task_index = pmc_new(interp, enum_class_ResizableIntegerArray);
core_struct->wait_index = pmc_new(interp, enum_class_ResizablePMCArray);
core_struct->handlers = pmc_new(interp, enum_class_ResizablePMCArray);
core_struct->messages = pmc_new(interp, enum_class_ResizablePMCArray);
core_struct->interp = INTERP;
MUTEX_INIT(core_struct->msg_lock);
}
/*
=item C<void init_pmc(PMC *data)>
Initializes a new Scheduler with a C<Hash> PMC with any or all of the keys:
=over 4
=item C<id>
An C<Integer> representing the unique identifier for this scheduler.
=back
=cut
*/
VTABLE void init_pmc(PMC *data) {
PMC *elem;
Parrot_Scheduler_attributes *core_struct;
if (!VTABLE_isa(INTERP, data, CONST_STRING(INTERP, "Hash")))
Parrot_ex_throw_from_c_args(INTERP, NULL, EXCEPTION_INVALID_OPERATION,
"Scheduler initializer must be a Hash");
SELF.init();
core_struct = PARROT_SCHEDULER(SELF);
elem = VTABLE_get_pmc_keyed_str(INTERP, data, CONST_STRING(INTERP, "id"));
if (!PMC_IS_NULL(elem))
core_struct->id = VTABLE_get_integer(INTERP, elem);
}
/*
=item C<void push_pmc(PMC *value)>
Inserts a task into the task list, giving it a task ID one higher than the
current maximum, and a birthtime of the current time.
=cut
*/
void push_pmc(PMC *task) {
Parrot_Scheduler_attributes * const core_struct = PARROT_SCHEDULER(SELF);
STRING *task_id_str;
INTVAL new_tid;
task = VTABLE_share_ro(INTERP, task);
VTABLE_set_number_native(INTERP, task, Parrot_floatval_time());
new_tid = ++(core_struct->max_tid);
VTABLE_set_integer_native(INTERP, task, new_tid);
task_id_str = string_from_int(INTERP, new_tid);
VTABLE_set_pmc_keyed_str(INTERP, core_struct->task_list,
task_id_str, task);
if (task->vtable->base_type == enum_class_Timer)
VTABLE_push_integer(INTERP, core_struct->wait_index, new_tid);
else
VTABLE_push_integer(INTERP, core_struct->task_index, new_tid);
SCHEDULER_cache_valid_CLEAR(SELF);
if (task->vtable->base_type != enum_class_Exception)
Parrot_cx_runloop_wake(core_struct->interp, SELF);
}
/*
=item C<PMC *pop_pmc()>
Retrieves the next task from the task list. If the task index is invalid,
recalculates it before retrieving the next task.
=cut
*/
VTABLE PMC *pop_pmc() {
Parrot_Scheduler_attributes * core_struct = PARROT_SCHEDULER(SELF);
PMC *task = PMCNULL;
/* Pull the next valid task off the task list, skipping expired and
* deleted tasks. */
while (PMC_IS_NULL(task)
&& VTABLE_elements(INTERP, core_struct->task_index) > 0) {
INTVAL tid = VTABLE_shift_integer(INTERP, core_struct->task_index);
if (tid > 0)
task = VTABLE_get_pmc_keyed_int(INTERP,
core_struct->task_list, tid);
}
return task;
}
/*
=item C<INTVAL get_integer()>
Retrieves the number of pending tasks in the scheduler's task list.
=cut
*/
VTABLE INTVAL get_integer() {
Parrot_Scheduler_attributes * core_struct = PARROT_SCHEDULER(SELF);
return VTABLE_elements(INTERP, core_struct->task_index);
}
/*
=item C<void delete_keyed_int(INTVAL key)>
Removes the task with the given task ID from the task list.
=cut
*/
VTABLE void delete_keyed_int(INTVAL key) {
Parrot_Scheduler_attributes *core_struct = PARROT_SCHEDULER(SELF);
STRING *task_id_str = string_from_int(INTERP, key);
VTABLE_delete_keyed_str(INTERP, core_struct->task_list, task_id_str);
SCHEDULER_cache_valid_CLEAR(SELF);
}
/*
=item C<PMC *share_ro()>
Sets this PMC as shared.
=cut
*/
VTABLE PMC *share_ro() {
PMC *shared_self;
Parrot_Scheduler_attributes *sched;
if (PObj_is_PMC_shared_TEST(SELF))
return SELF;
shared_self = pt_shared_fixup(INTERP, SELF);
sched = PARROT_SCHEDULER(shared_self);
sched->task_list = pt_shared_fixup(INTERP, sched->task_list);
sched->task_index = pt_shared_fixup(INTERP, sched->task_index);
sched->wait_index = pt_shared_fixup(INTERP, sched->wait_index);
sched->handlers = pt_shared_fixup(INTERP, sched->handlers);
sched->messages = pt_shared_fixup(INTERP, sched->messages);
return shared_self;
}
/*
=item C<void destroy()>
Frees the scheduler's underlying struct.
=cut
*/
VTABLE void destroy() {
Parrot_Scheduler_attributes * const core_struct = PARROT_SCHEDULER(SELF);
MUTEX_DESTROY(core_struct->msg_lock);
mem_sys_free(core_struct);
}
/*
=item C<void mark()>
Marks any referenced strings and PMCs as live.
=cut
*/
VTABLE void mark() {
if (PARROT_SCHEDULER(SELF)) {
Parrot_Scheduler_attributes * const core_struct = PARROT_SCHEDULER(SELF);
if (core_struct->task_list)
pobject_lives(interp, (PObj *)core_struct->task_list);
if (core_struct->task_index)
pobject_lives(interp, (PObj *)core_struct->task_index);
if (core_struct->wait_index)
pobject_lives(interp, (PObj *)core_struct->wait_index);
if (core_struct->handlers)
pobject_lives(interp, (PObj *)core_struct->handlers);
if (core_struct->messages)
pobject_lives(interp, (PObj *)core_struct->messages);
}
}
/*
=item C<void visit(visit_info *info)>
Visits the contents of the scheduler (used by freeze/thaw).
C<*info> is the visit info (see F<include/parrot/pmc_freeze.h>).
=cut
*/
VTABLE void visit(visit_info *info) {
Parrot_Scheduler_attributes * const core_struct = PARROT_SCHEDULER(SELF);
PMC **pos;
/* 1) visit task list */
pos = &core_struct->task_list;
info->thaw_ptr = pos;
(info->visit_pmc_now)(INTERP, *pos, info);
/* 2) visit the handlers */
pos = &core_struct->handlers;
info->thaw_ptr = pos;
(info->visit_pmc_now)(INTERP, *pos, info);
}
/*
=item C<void freeze(visit_info *info)>
Archives the scheduler.
=cut
*/
VTABLE void freeze(visit_info *info) {
IMAGE_IO *io = info->image_io;
Parrot_Scheduler_attributes * const core_struct = PARROT_SCHEDULER(SELF);
/* 1) freeze scheduler id */
VTABLE_push_integer(INTERP, io, core_struct->id);
/* 2) freeze maximum task id */
VTABLE_push_integer(INTERP, io, core_struct->max_tid);
}
/*
=item C<void thaw(visit_info *info)>
Unarchives the scheduler.
=cut
*/
VTABLE void thaw(visit_info *info) {
IMAGE_IO * const io = info->image_io;
/* 1. thaw scheduler id */
const INTVAL id = VTABLE_shift_integer(INTERP, io);
/* 2. thaw maximum task id */
const INTVAL max_tid = VTABLE_shift_integer(INTERP, io);
/* Allocate the scheduler's core data struct and set custom flags. */
SELF.init();
/* Set the scheduler's id to the frozen id */
PARROT_SCHEDULER(SELF)->id = id;
/* Set the scheduler's maximum task id to the frozen tid */
PARROT_SCHEDULER(SELF)->max_tid = max_tid;
}
/*
=item C<void thawfinish(visit_info *info)>
Finishes thawing the scheduler.
=cut
*/
void thawfinish(visit_info *info) {
Parrot_cx_refresh_task_list(INTERP, SELF);
}
/*
=back
=head2 Methods
=over 4
=cut
*/
/*
=item C<METHOD add_handler(PMC *handler)>
Adds a handler to the scheduler.
=cut
*/
METHOD add_handler(PMC *handler) {
Parrot_Scheduler_attributes *core_struct = PARROT_SCHEDULER(SELF);
VTABLE_unshift_pmc(INTERP, core_struct->handlers, handler);
}
/*
=item C<METHOD delete_handler(STRING *type :optional, INTVAL have_type :opt_flag)>
Deletes a handler from the scheduler.
=cut
*/
METHOD delete_handler(STRING *type :optional, INTVAL have_type :opt_flag) {
PMC *handlers;
INTVAL elements, index;
STRING *except_str = CONST_STRING(INTERP, "exception");
STRING *event_str = CONST_STRING(INTERP, "event");
GET_ATTR_handlers(INTERP, SELF, handlers);
elements = VTABLE_elements(INTERP, handlers);
if (!have_type)
VTABLE_shift_pmc(INTERP, handlers);
/* Loop from newest handler to oldest handler. */
for (index = 0; index < elements; ++index) {
PMC *handler = VTABLE_get_pmc_keyed_int(INTERP, handlers, index);
if (!PMC_IS_NULL(handler)) {
if (string_equal(INTERP, type, except_str) == 0
&& handler->vtable->base_type == enum_class_ExceptionHandler) {
VTABLE_set_pmc_keyed_int(INTERP, handlers, index, PMCNULL);
RETURN(void);
}
else if (string_equal(INTERP, type, event_str) == 0
&& handler->vtable->base_type == enum_class_EventHandler) {
VTABLE_set_pmc_keyed_int(INTERP, handlers, index, PMCNULL);
RETURN(void);
}
}
}
Parrot_ex_throw_from_c_args(interp, NULL, EXCEPTION_INVALID_OPERATION,
"No handler to delete.");
}
/*
=item C<METHOD find_handler(PMC *task)>
Searchs for a handler for the given task. If no handler is found, returns
PMCNULL.
=cut
*/
METHOD find_handler(PMC *task) {
STRING * const handled_str = CONST_STRING(interp, "handled");
STRING * const iter_str = CONST_STRING(interp, "handler_iter");
PMC *iter;
/* Exceptions store the handler iterator for rethrow, other kinds of
* tasks don't (though they could). */
if (task->vtable->base_type == enum_class_Exception
&& VTABLE_get_integer_keyed_str(interp, task, handled_str) == -1) {
iter = VTABLE_get_attr_str(interp, task, iter_str);
}
else {
PMC *handlers;
GET_ATTR_handlers(interp, SELF, handlers);
iter = VTABLE_get_iter(interp, handlers);
if (task->vtable->base_type == enum_class_Exception)
VTABLE_set_attr_str(interp, task, iter_str, iter);
}
/* Loop from newest handler to oldest handler. */
while (VTABLE_get_bool(interp, iter)) {
PMC *handler = VTABLE_shift_pmc(INTERP, iter);
INTVAL valid_handler = 0;
if (!PMC_IS_NULL(handler)) {
(INTVAL valid_handler) = PCCINVOKE(INTERP, handler, "can_handle", PMC *task);
if (valid_handler) {
if (task->vtable->base_type == enum_class_Exception)
VTABLE_set_integer_native(interp, handler, 1);
RETURN(PMC *handler);
}
}
}
RETURN(PMC *PMCNULL);
}
/*
=item C<METHOD count_handlers(STRING *type :optional, INTVAL have_type :opt_flag)>
Returns the number of handlers currently held by the scheduler. If a type
argument is passed, only counts handlers of that type (C<event>, C<exception>).
If no type argument is passed, counts all handlers.
=cut
*/
METHOD count_handlers(STRING *type :optional, INTVAL have_type :opt_flag) {
/* avoid uninitialized value warning */
PMC *handlers = NULL;
INTVAL elements = VTABLE_elements(INTERP, handlers);
INTVAL count = 0;
INTVAL index;
GET_ATTR_handlers(INTERP, SELF, handlers);
if (!have_type)
RETURN(INTVAL elements);
for (index = 0; index < elements; ++index) {
PMC *handler = VTABLE_get_pmc_keyed_int(INTERP, handlers, index);
STRING *exception = CONST_STRING(INTERP, "exception");
STRING *event = CONST_STRING(INTERP, "event");
if (!PMC_IS_NULL(handler)) {
if (((string_equal(INTERP, type, exception) == 0)
&& handler->vtable->base_type == enum_class_ExceptionHandler)
|| ((string_equal(INTERP, type, event) == 0)
&& handler->vtable->base_type == enum_class_EventHandler))
count++;
}
}
RETURN(INTVAL count);
}
}
/*
=back
=head1 SEE ALSO
F<docs/pdds/pdd25_concurrency.pod>.
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4:
*/