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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/common/task_scheduler.h>
#include <aws/common/logging.h>
#include <inttypes.h>
static const size_t DEFAULT_QUEUE_SIZE = 7;
void aws_task_init(struct aws_task *task, aws_task_fn *fn, void *arg, const char *type_tag) {
AWS_ZERO_STRUCT(*task);
task->fn = fn;
task->arg = arg;
task->type_tag = type_tag;
}
const char *aws_task_status_to_c_str(enum aws_task_status status) {
switch (status) {
case AWS_TASK_STATUS_RUN_READY:
return "<Running>";
case AWS_TASK_STATUS_CANCELED:
return "<Canceled>";
default:
return "<Unknown>";
}
}
void aws_task_run(struct aws_task *task, enum aws_task_status status) {
AWS_ASSERT(task->fn);
AWS_LOGF_TRACE(
AWS_LS_COMMON_TASK_SCHEDULER,
"id=%p: Running %s task with %s status",
(void *)task,
task->type_tag,
aws_task_status_to_c_str(status));
task->abi_extension.scheduled = false;
task->fn(task, task->arg, status);
}
static int s_compare_timestamps(const void *a, const void *b) {
uint64_t a_time = (*(struct aws_task **)a)->timestamp;
uint64_t b_time = (*(struct aws_task **)b)->timestamp;
return a_time > b_time; /* min-heap */
}
static void s_run_all(struct aws_task_scheduler *scheduler, uint64_t current_time, enum aws_task_status status);
int aws_task_scheduler_init(struct aws_task_scheduler *scheduler, struct aws_allocator *alloc) {
AWS_ASSERT(alloc);
AWS_ZERO_STRUCT(*scheduler);
if (aws_priority_queue_init_dynamic(
&scheduler->timed_queue, alloc, DEFAULT_QUEUE_SIZE, sizeof(struct aws_task *), &s_compare_timestamps)) {
return AWS_OP_ERR;
};
scheduler->alloc = alloc;
aws_linked_list_init(&scheduler->timed_list);
aws_linked_list_init(&scheduler->asap_list);
AWS_POSTCONDITION(aws_task_scheduler_is_valid(scheduler));
return AWS_OP_SUCCESS;
}
void aws_task_scheduler_clean_up(struct aws_task_scheduler *scheduler) {
AWS_ASSERT(scheduler);
if (aws_task_scheduler_is_valid(scheduler)) {
/* Execute all remaining tasks as CANCELED.
* Do this in a loop so that tasks scheduled by other tasks are executed */
while (aws_task_scheduler_has_tasks(scheduler, NULL)) {
s_run_all(scheduler, UINT64_MAX, AWS_TASK_STATUS_CANCELED);
}
}
aws_priority_queue_clean_up(&scheduler->timed_queue);
AWS_ZERO_STRUCT(*scheduler);
}
bool aws_task_scheduler_is_valid(const struct aws_task_scheduler *scheduler) {
return scheduler && scheduler->alloc && aws_priority_queue_is_valid(&scheduler->timed_queue) &&
aws_linked_list_is_valid(&scheduler->asap_list) && aws_linked_list_is_valid(&scheduler->timed_list);
}
bool aws_task_scheduler_has_tasks(const struct aws_task_scheduler *scheduler, uint64_t *next_task_time) {
AWS_ASSERT(scheduler);
uint64_t timestamp = UINT64_MAX;
bool has_tasks = false;
if (!aws_linked_list_empty(&scheduler->asap_list)) {
timestamp = 0;
has_tasks = true;
} else {
/* Check whether timed_list or timed_queue has the earlier task */
if (AWS_UNLIKELY(!aws_linked_list_empty(&scheduler->timed_list))) {
struct aws_linked_list_node *node = aws_linked_list_front(&scheduler->timed_list);
struct aws_task *task = AWS_CONTAINER_OF(node, struct aws_task, node);
timestamp = task->timestamp;
has_tasks = true;
}
struct aws_task **task_ptrptr = NULL;
if (aws_priority_queue_top(&scheduler->timed_queue, (void **)&task_ptrptr) == AWS_OP_SUCCESS) {
if ((*task_ptrptr)->timestamp < timestamp) {
timestamp = (*task_ptrptr)->timestamp;
}
has_tasks = true;
}
}
if (next_task_time) {
*next_task_time = timestamp;
}
return has_tasks;
}
void aws_task_scheduler_schedule_now(struct aws_task_scheduler *scheduler, struct aws_task *task) {
AWS_ASSERT(scheduler);
AWS_ASSERT(task);
AWS_ASSERT(task->fn);
AWS_LOGF_TRACE(
AWS_LS_COMMON_TASK_SCHEDULER,
"id=%p: Scheduling %s task for immediate execution",
(void *)task,
task->type_tag);
aws_priority_queue_node_init(&task->priority_queue_node);
aws_linked_list_node_reset(&task->node);
task->timestamp = 0;
aws_linked_list_push_back(&scheduler->asap_list, &task->node);
task->abi_extension.scheduled = true;
}
void aws_task_scheduler_schedule_future(
struct aws_task_scheduler *scheduler,
struct aws_task *task,
uint64_t time_to_run) {
AWS_ASSERT(scheduler);
AWS_ASSERT(task);
AWS_ASSERT(task->fn);
AWS_LOGF_TRACE(
AWS_LS_COMMON_TASK_SCHEDULER,
"id=%p: Scheduling %s task for future execution at time %" PRIu64,
(void *)task,
task->type_tag,
time_to_run);
task->timestamp = time_to_run;
aws_priority_queue_node_init(&task->priority_queue_node);
aws_linked_list_node_reset(&task->node);
int err = aws_priority_queue_push_ref(&scheduler->timed_queue, &task, &task->priority_queue_node);
if (AWS_UNLIKELY(err)) {
/* In the (very unlikely) case that we can't push into the timed_queue,
* perform a sorted insertion into timed_list. */
struct aws_linked_list_node *node_i;
for (node_i = aws_linked_list_begin(&scheduler->timed_list);
node_i != aws_linked_list_end(&scheduler->timed_list);
node_i = aws_linked_list_next(node_i)) {
struct aws_task *task_i = AWS_CONTAINER_OF(node_i, struct aws_task, node);
if (task_i->timestamp > time_to_run) {
break;
}
}
aws_linked_list_insert_before(node_i, &task->node);
}
task->abi_extension.scheduled = true;
}
void aws_task_scheduler_run_all(struct aws_task_scheduler *scheduler, uint64_t current_time) {
AWS_ASSERT(scheduler);
s_run_all(scheduler, current_time, AWS_TASK_STATUS_RUN_READY);
}
static void s_run_all(struct aws_task_scheduler *scheduler, uint64_t current_time, enum aws_task_status status) {
/* Move scheduled tasks to running_list before executing.
* This gives us the desired behavior that: if executing a task results in another task being scheduled,
* that new task is not executed until the next time run() is invoked. */
struct aws_linked_list running_list;
aws_linked_list_init(&running_list);
/* First move everything from asap_list */
aws_linked_list_swap_contents(&running_list, &scheduler->asap_list);
/* Next move tasks from timed_queue and timed_list, based on whichever's next-task is sooner.
* It's very unlikely that any tasks are in timed_list, so once it has no more valid tasks,
* break out of this complex loop in favor of a simpler one. */
while (AWS_UNLIKELY(!aws_linked_list_empty(&scheduler->timed_list))) {
struct aws_linked_list_node *timed_list_node = aws_linked_list_begin(&scheduler->timed_list);
struct aws_task *timed_list_task = AWS_CONTAINER_OF(timed_list_node, struct aws_task, node);
if (timed_list_task->timestamp > current_time) {
/* timed_list is out of valid tasks, break out of complex loop */
break;
}
/* Check if timed_queue has a task which is sooner */
struct aws_task **timed_queue_task_ptrptr = NULL;
if (aws_priority_queue_top(&scheduler->timed_queue, (void **)&timed_queue_task_ptrptr) == AWS_OP_SUCCESS) {
if ((*timed_queue_task_ptrptr)->timestamp <= current_time) {
if ((*timed_queue_task_ptrptr)->timestamp < timed_list_task->timestamp) {
/* Take task from timed_queue */
struct aws_task *timed_queue_task;
aws_priority_queue_pop(&scheduler->timed_queue, &timed_queue_task);
aws_linked_list_push_back(&running_list, &timed_queue_task->node);
continue;
}
}
}
/* Take task from timed_list */
aws_linked_list_pop_front(&scheduler->timed_list);
aws_linked_list_push_back(&running_list, &timed_list_task->node);
}
/* Simpler loop that moves remaining valid tasks from timed_queue */
struct aws_task **timed_queue_task_ptrptr = NULL;
while (aws_priority_queue_top(&scheduler->timed_queue, (void **)&timed_queue_task_ptrptr) == AWS_OP_SUCCESS) {
if ((*timed_queue_task_ptrptr)->timestamp > current_time) {
break;
}
struct aws_task *next_timed_task;
aws_priority_queue_pop(&scheduler->timed_queue, &next_timed_task);
aws_linked_list_push_back(&running_list, &next_timed_task->node);
}
/* Run tasks */
while (!aws_linked_list_empty(&running_list)) {
struct aws_linked_list_node *task_node = aws_linked_list_pop_front(&running_list);
struct aws_task *task = AWS_CONTAINER_OF(task_node, struct aws_task, node);
aws_task_run(task, status);
}
}
void aws_task_scheduler_cancel_task(struct aws_task_scheduler *scheduler, struct aws_task *task) {
/* attempt the linked lists first since those will be faster access and more likely to occur
* anyways.
*/
if (task->node.next) {
aws_linked_list_remove(&task->node);
} else if (task->abi_extension.scheduled) {
aws_priority_queue_remove(&scheduler->timed_queue, &task, &task->priority_queue_node);
}
/*
* No need to log cancellation specially; it will get logged during the run call with the canceled status
*/
aws_task_run(task, AWS_TASK_STATUS_CANCELED);
}
|