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 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/io/event_loop.h>
#include <aws/common/atomics.h>
#include <aws/common/clock.h>
#include <aws/common/mutex.h>
#include <aws/common/task_scheduler.h>
#include <aws/common/thread.h>
#include <aws/io/logging.h>
#include <Windows.h>
/* The next set of struct definitions are taken directly from the
windows documentation. We can't include the header files directly
due to winsock. Also some of the definitions here aren't in the public API
but it's the only way to do the thing we need to do. So we just declare it
here and use dynamic binding to do the voodoo magic. */
struct FILE_BASIC_INFORMATION {
LARGE_INTEGER CreationTime;
LARGE_INTEGER LastAccessTime;
LARGE_INTEGER LastWriteTime;
LARGE_INTEGER ChangeTime;
DWORD FileAttributes;
};
struct FILE_COMPLETION_INFORMATION {
HANDLE Port;
PVOID Key;
};
struct IO_STATUS_BLOCK {
union {
NTSTATUS Status;
PVOID Pointer;
} status_block;
ULONG_PTR Information;
};
enum FILE_INFORMATION_CLASS {
FileReplaceCompletionInformation = 0x3D,
};
typedef NTSTATUS(NTAPI NTSetInformationFile)(
HANDLE file_handle,
struct IO_STATUS_BLOCK *io_status_block,
void *file_information,
ULONG length,
enum FILE_INFORMATION_CLASS file_information_class);
NTSetInformationFile *s_set_info_fn = NULL;
/* END of windows hackery here. */
typedef enum event_thread_state {
EVENT_THREAD_STATE_READY_TO_RUN,
EVENT_THREAD_STATE_RUNNING,
EVENT_THREAD_STATE_STOPPING,
} event_thread_state;
struct iocp_loop {
HANDLE iocp_handle;
struct aws_thread thread_created_on;
aws_thread_id_t thread_joined_to;
struct aws_atomic_var running_thread_id;
/* synced_data holds things that must be communicated across threads.
* When the event-thread is running, the mutex must be locked while anyone touches anything in synced_data.
* If this data is modified outside the event-thread, the thread is signaled via activity on a pipe. */
struct {
struct aws_mutex mutex;
bool thread_signaled; /* whether thread has been signaled about changes to synced_data */
struct aws_linked_list tasks_to_schedule;
event_thread_state state;
} synced_data;
/* thread_data holds things which, when the event-thread is running, may only be touched by the thread */
struct {
struct aws_task_scheduler scheduler;
/* These variables duplicate ones in synced_data.
* We move values out while holding the mutex and operate on them later */
event_thread_state state;
} thread_data;
struct aws_thread_options thread_options;
};
enum {
DEFAULT_TIMEOUT_MS = 100000,
/* Max I/O completion packets to process per loop of the event-thread */
MAX_COMPLETION_PACKETS_PER_LOOP = 100,
};
static void s_destroy(struct aws_event_loop *event_loop);
static int s_run(struct aws_event_loop *event_loop);
static int s_stop(struct aws_event_loop *event_loop);
static int s_wait_for_stop_completion(struct aws_event_loop *event_loop);
static void s_schedule_task_now(struct aws_event_loop *event_loop, struct aws_task *task);
static void s_schedule_task_future(struct aws_event_loop *event_loop, struct aws_task *task, uint64_t run_at_nanos);
static void s_cancel_task(struct aws_event_loop *event_loop, struct aws_task *task);
static int s_connect_to_io_completion_port(struct aws_event_loop *event_loop, struct aws_io_handle *handle);
static bool s_is_event_thread(struct aws_event_loop *event_loop);
static int s_unsubscribe_from_io_events(struct aws_event_loop *event_loop, struct aws_io_handle *handle);
static void s_free_io_event_resources(void *user_data);
static void aws_event_loop_thread(void *user_data);
void aws_overlapped_init(
struct aws_overlapped *overlapped,
aws_event_loop_on_completion_fn *on_completion,
void *user_data) {
AWS_ASSERT(overlapped);
AWS_ZERO_STRUCT(overlapped->overlapped);
overlapped->on_completion = on_completion;
overlapped->user_data = user_data;
}
void aws_overlapped_reset(struct aws_overlapped *overlapped) {
AWS_ASSERT(overlapped);
AWS_ZERO_STRUCT(overlapped->overlapped);
}
struct _OVERLAPPED *aws_overlapped_to_windows_overlapped(struct aws_overlapped *overlapped) {
return (struct _OVERLAPPED *)&overlapped->overlapped;
}
struct aws_event_loop_vtable s_iocp_vtable = {
.destroy = s_destroy,
.run = s_run,
.stop = s_stop,
.wait_for_stop_completion = s_wait_for_stop_completion,
.schedule_task_now = s_schedule_task_now,
.schedule_task_future = s_schedule_task_future,
.cancel_task = s_cancel_task,
.connect_to_io_completion_port = s_connect_to_io_completion_port,
.is_on_callers_thread = s_is_event_thread,
.unsubscribe_from_io_events = s_unsubscribe_from_io_events,
.free_io_event_resources = s_free_io_event_resources,
};
struct aws_event_loop *aws_event_loop_new_default_with_options(
struct aws_allocator *alloc,
const struct aws_event_loop_options *options) {
AWS_ASSERT(alloc);
AWS_ASSERT(options);
AWS_ASSERT(options->clock);
if (!s_set_info_fn) {
HMODULE ntdll = GetModuleHandleA("ntdll.dll");
if (!ntdll) {
AWS_LOGF_FATAL(AWS_LS_IO_EVENT_LOOP, "static: failed to load ntdll.dll");
AWS_ASSERT(0);
exit(-1);
}
s_set_info_fn = (NTSetInformationFile *)GetProcAddress(ntdll, "NtSetInformationFile");
if (!s_set_info_fn) {
AWS_LOGF_FATAL(AWS_LS_IO_EVENT_LOOP, "static: failed to load NtSetInformationFile()");
AWS_ASSERT(0);
exit(-1);
}
}
int err = 0;
struct aws_event_loop *event_loop = NULL;
bool clean_up_event_loop_base = false;
struct iocp_loop *impl = NULL;
bool clean_up_iocp_handle = false;
bool clean_up_thread = false;
bool clean_up_mutex = false;
bool clean_up_scheduler = false;
event_loop = aws_mem_acquire(alloc, sizeof(struct aws_event_loop));
if (!event_loop) {
return NULL;
}
AWS_LOGF_INFO(AWS_LS_IO_EVENT_LOOP, "id=%p: Initializing IO Completion Port", (void *)event_loop);
err = aws_event_loop_init_base(event_loop, alloc, options->clock);
if (err) {
goto clean_up;
}
clean_up_event_loop_base = true;
impl = aws_mem_calloc(alloc, 1, sizeof(struct iocp_loop));
if (!impl) {
goto clean_up;
}
if (options->thread_options) {
impl->thread_options = *options->thread_options;
} else {
impl->thread_options = *aws_default_thread_options();
}
/* initialize thread id to NULL. This will be updated once the event loop thread starts. */
aws_atomic_init_ptr(&impl->running_thread_id, NULL);
impl->iocp_handle = CreateIoCompletionPort(
INVALID_HANDLE_VALUE, /* FileHandle: passing invalid handle creates a new IOCP */
NULL, /* ExistingCompletionPort: should be NULL when file handle is invalid. */
0, /* CompletionKey: should be 0 when file handle is invalid */
1); /* NumberOfConcurrentThreads */
if (impl->iocp_handle == NULL) {
AWS_LOGF_FATAL(
AWS_LS_IO_EVENT_LOOP,
"id=%p: CreateIOCompletionPort failed with error %d",
(void *)event_loop,
(int)GetLastError());
aws_raise_error(AWS_ERROR_SYS_CALL_FAILURE);
goto clean_up;
}
clean_up_iocp_handle = true;
err = aws_thread_init(&impl->thread_created_on, alloc);
if (err) {
goto clean_up;
}
clean_up_thread = true;
err = aws_mutex_init(&impl->synced_data.mutex);
if (err) {
goto clean_up;
}
clean_up_mutex = true;
aws_linked_list_init(&impl->synced_data.tasks_to_schedule);
err = aws_task_scheduler_init(&impl->thread_data.scheduler, alloc);
if (err) {
goto clean_up;
}
clean_up_scheduler = true;
event_loop->impl_data = impl;
event_loop->vtable = &s_iocp_vtable;
return event_loop;
clean_up:
if (clean_up_scheduler) {
aws_task_scheduler_clean_up(&impl->thread_data.scheduler);
}
if (clean_up_mutex) {
aws_mutex_clean_up(&impl->synced_data.mutex);
}
if (clean_up_thread) {
aws_thread_clean_up(&impl->thread_created_on);
}
if (clean_up_iocp_handle) {
CloseHandle(impl->iocp_handle);
}
if (impl) {
aws_mem_release(alloc, impl);
}
if (clean_up_event_loop_base) {
aws_event_loop_clean_up_base(event_loop);
}
if (event_loop) {
aws_mem_release(alloc, event_loop);
}
return NULL;
}
/* Should not be called from event-thread */
static void s_destroy(struct aws_event_loop *event_loop) {
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: destroying event-loop", (void *)event_loop);
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
/* Stop the event-thread. This might have already happened. It's safe to call multiple times. */
aws_event_loop_stop(event_loop);
int err = aws_event_loop_wait_for_stop_completion(event_loop);
if (err) {
AWS_LOGF_ERROR(
AWS_LS_IO_EVENT_LOOP,
"id=%p: Failed to destroy event-thread, resources have been leaked.",
(void *)event_loop);
AWS_ASSERT(0 && "Failed to destroy event-thread, resources have been leaked.");
return;
}
/* setting this so that canceled tasks don't blow up when asking if they're on the event-loop thread. */
impl->thread_joined_to = aws_thread_current_thread_id();
aws_atomic_store_ptr(&impl->running_thread_id, &impl->thread_joined_to);
/* Clean up task-related stuff first.
* It's possible the a cancelled task adds further tasks to this event_loop, these new tasks would end up in
* synced_data.tasks_to_schedule, so clean that up last */
aws_task_scheduler_clean_up(&impl->thread_data.scheduler); /* cancels remaining tasks in scheduler */
while (!aws_linked_list_empty(&impl->synced_data.tasks_to_schedule)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(&impl->synced_data.tasks_to_schedule);
struct aws_task *task = AWS_CONTAINER_OF(node, struct aws_task, node);
task->fn(task, task->arg, AWS_TASK_STATUS_CANCELED);
}
/* Clean up everything else */
bool close_iocp_success = CloseHandle(impl->iocp_handle);
AWS_ASSERT(close_iocp_success);
(void)close_iocp_success;
aws_mutex_clean_up(&impl->synced_data.mutex);
aws_thread_clean_up(&impl->thread_created_on);
aws_mem_release(event_loop->alloc, impl);
aws_event_loop_clean_up_base(event_loop);
aws_mem_release(event_loop->alloc, event_loop);
}
/* Called from any thread.
/* Signal to the event-loop thread that synced_data has changed.
* This should only be called after changing synced_data.thread_signaled from false to true. */
static void s_signal_synced_data_changed(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: notified of cross-thread tasks to schedule", (void *)event_loop);
/* Enqueue a special completion packet to inform the event-loop that synced_data has changed.
* We identify the special packet by using the iocp handle as the completion key.
* This wakes the event-loop thread if it was idle. */
ULONG_PTR completion_key = (ULONG_PTR)impl->iocp_handle;
PostQueuedCompletionStatus(
impl->iocp_handle, /* CompletionPort */
0, /* dwNumberOfBytesTransferred */
completion_key, /* dwCompletionKey */
NULL); /* lpOverlapped */
}
static int s_run(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
/* Since thread isn't running it's ok to touch thread_data,
* and it's ok to touch synced_data without locking the mutex */
/* If asserts hit, you must call stop() and wait_for_stop_completion() before calling run() again */
AWS_ASSERT(impl->thread_data.state == EVENT_THREAD_STATE_READY_TO_RUN);
impl->synced_data.state = EVENT_THREAD_STATE_RUNNING;
AWS_LOGF_INFO(AWS_LS_IO_EVENT_LOOP, "id=%p: Starting event-loop thread.", (void *)event_loop);
aws_thread_increment_unjoined_count();
int err = aws_thread_launch(&impl->thread_created_on, aws_event_loop_thread, event_loop, &impl->thread_options);
if (err) {
aws_thread_decrement_unjoined_count();
AWS_LOGF_FATAL(AWS_LS_IO_EVENT_LOOP, "id=%p: thread creation failed.", (void *)event_loop);
goto clean_up;
}
return AWS_OP_SUCCESS;
clean_up:
impl->synced_data.state = EVENT_THREAD_STATE_READY_TO_RUN;
return AWS_OP_ERR;
}
/* Called from any thread */
static int s_stop(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
bool signal_thread = false;
AWS_LOGF_INFO(AWS_LS_IO_EVENT_LOOP, "id=%p: Stopping event-loop thread.", (void *)event_loop);
{ /* Begin critical section */
aws_mutex_lock(&impl->synced_data.mutex);
if (impl->synced_data.state == EVENT_THREAD_STATE_RUNNING) {
impl->synced_data.state = EVENT_THREAD_STATE_STOPPING;
signal_thread = !impl->synced_data.thread_signaled;
impl->synced_data.thread_signaled = true;
}
aws_mutex_unlock(&impl->synced_data.mutex);
} /* End critical section */
if (signal_thread) {
s_signal_synced_data_changed(event_loop);
}
return AWS_OP_SUCCESS;
}
/* Should not be called from event-thread */
static int s_wait_for_stop_completion(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
#ifdef DEBUG_BUILD
aws_mutex_lock(&impl->synced_data.mutex);
/* call stop() before wait_for_stop_completion() or you'll wait forever */
AWS_ASSERT(impl->synced_data.state != EVENT_THREAD_STATE_RUNNING);
aws_mutex_unlock(&impl->synced_data.mutex);
#endif
int err = aws_thread_join(&impl->thread_created_on);
aws_thread_decrement_unjoined_count();
if (err) {
return AWS_OP_ERR;
}
/* Since thread is no longer running it's ok to touch thread_data,
* and it's ok to touch synced_data without locking the mutex */
impl->synced_data.state = EVENT_THREAD_STATE_READY_TO_RUN;
impl->thread_data.state = EVENT_THREAD_STATE_READY_TO_RUN;
return AWS_OP_SUCCESS;
}
/* Common function used by schedule_task_now() and schedule_task_future().
* When run_at_nanos is 0, it's treated as a "now" task.
* Called from any thread */
static void s_schedule_task_common(struct aws_event_loop *event_loop, struct aws_task *task, uint64_t run_at_nanos) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
AWS_ASSERT(task);
/* If we're on the event-thread, just schedule it directly */
if (s_is_event_thread(event_loop)) {
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: scheduling task %p in-thread for timestamp %llu",
(void *)event_loop,
(void *)task,
(unsigned long long)run_at_nanos);
if (run_at_nanos == 0) {
aws_task_scheduler_schedule_now(&impl->thread_data.scheduler, task);
} else {
aws_task_scheduler_schedule_future(&impl->thread_data.scheduler, task, run_at_nanos);
}
return;
}
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: Scheduling task %p cross-thread for timestamp %llu",
(void *)event_loop,
(void *)task,
(unsigned long long)run_at_nanos);
/* Otherwise, add it to synced_data.tasks_to_schedule and signal the event-thread to process it */
task->timestamp = run_at_nanos;
bool should_signal_thread = false;
{ /* Begin critical section */
aws_mutex_lock(&impl->synced_data.mutex);
aws_linked_list_push_back(&impl->synced_data.tasks_to_schedule, &task->node);
/* Signal thread that synced_data has changed (unless it's been signaled already) */
if (!impl->synced_data.thread_signaled) {
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: Waking up event-loop thread", (void *)event_loop);
should_signal_thread = true;
impl->synced_data.thread_signaled = true;
}
aws_mutex_unlock(&impl->synced_data.mutex);
} /* End critical section */
if (should_signal_thread) {
s_signal_synced_data_changed(event_loop);
}
}
/* Called from any thread */
static void s_schedule_task_now(struct aws_event_loop *event_loop, struct aws_task *task) {
s_schedule_task_common(event_loop, task, 0 /* use zero to denote it's a "now" task */);
}
/* Called from any thread */
static void s_schedule_task_future(struct aws_event_loop *event_loop, struct aws_task *task, uint64_t run_at_nanos) {
s_schedule_task_common(event_loop, task, run_at_nanos);
}
static void s_cancel_task(struct aws_event_loop *event_loop, struct aws_task *task) {
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: cancelling task %p", (void *)event_loop, (void *)task);
struct iocp_loop *iocp_loop = event_loop->impl_data;
aws_task_scheduler_cancel_task(&iocp_loop->thread_data.scheduler, task);
}
/* Called from any thread */
static bool s_is_event_thread(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
aws_thread_id_t *el_thread_id = aws_atomic_load_ptr(&impl->running_thread_id);
return el_thread_id && aws_thread_thread_id_equal(*el_thread_id, aws_thread_current_thread_id());
}
/* Called from any thread */
static int s_connect_to_io_completion_port(struct aws_event_loop *event_loop, struct aws_io_handle *handle) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
AWS_ASSERT(handle);
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: subscribing to events on handle %p",
(void *)event_loop,
(void *)handle->data.handle);
const HANDLE iocp_handle = CreateIoCompletionPort(
handle->data.handle, /* FileHandle */
impl->iocp_handle, /* ExistingCompletionPort */
0, /* CompletionKey */
1); /* NumberOfConcurrentThreads */
/* iocp_handle should be the event loop's handle if this succeeded */
bool iocp_associated = iocp_handle == impl->iocp_handle;
/* clang-format off */
#if defined(AWS_SUPPORT_WIN7)
/*
* When associating named pipes, it is possible to open the same pipe in the same
* process for read and write, causing multiple attempts to associate. This will
* return ERROR_INVALID_PARAMETER from GetLastError on the second association on Win7,
* but the prior association will continue. Detecting this before attempting to
* associate requires the DDK API.
*/
const bool already_associated =
GetLastError() == ERROR_INVALID_PARAMETER &&
/* Both handles should be valid prior to the above call. If they are,
* and we got ERROR_INVALID_PARAMETER, the file handle already has an IOCP association */
handle->data.handle != INVALID_HANDLE_VALUE && impl->iocp_handle != INVALID_HANDLE_VALUE;
iocp_associated |= already_associated;
#endif
/* clang-format on */
if (!iocp_associated) {
AWS_LOGF_ERROR(
AWS_LS_IO_EVENT_LOOP,
"id=%p: CreateIoCompletionPort() failed with error %d",
(void *)event_loop,
(int)GetLastError());
return aws_raise_error(AWS_ERROR_SYS_CALL_FAILURE);
}
/* As an optimization, tell Windows not to bother signaling the handle when async I/O completes.
* We're using I/O completion ports, we don't need further mechanisms to know when I/O completes. */
SetFileCompletionNotificationModes(handle->data.handle, FILE_SKIP_SET_EVENT_ON_HANDLE);
/* iocp_event_loop has no need to store additional data per aws_io_handle */
handle->additional_data = NULL;
return AWS_OP_SUCCESS;
}
/* Called from event-thread.
* Takes tasks from tasks_to_schedule and adds them to the scheduler. */
static void s_process_tasks_to_schedule(struct aws_event_loop *event_loop, struct aws_linked_list *tasks_to_schedule) {
struct iocp_loop *impl = event_loop->impl_data;
AWS_ASSERT(impl);
while (!aws_linked_list_empty(tasks_to_schedule)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(tasks_to_schedule);
struct aws_task *task = AWS_CONTAINER_OF(node, struct aws_task, node);
/* We use timestamp of 0 to denote that it's a "now" task */
if (task->timestamp == 0) {
aws_task_scheduler_schedule_now(&impl->thread_data.scheduler, task);
} else {
aws_task_scheduler_schedule_future(&impl->thread_data.scheduler, task, task->timestamp);
}
}
}
/* Runs on the event-thread. */
static void s_process_synced_data(struct aws_event_loop *event_loop) {
struct iocp_loop *impl = event_loop->impl_data;
/* If there are tasks to schedule, grab them all out of synced_data.tasks_to_schedule.
* We'll process them later, so that we minimize time spent holding the mutex. */
struct aws_linked_list tasks_to_schedule;
aws_linked_list_init(&tasks_to_schedule);
{ /* Begin critical section */
aws_mutex_lock(&impl->synced_data.mutex);
impl->synced_data.thread_signaled = false;
bool initiate_stop = (impl->synced_data.state == EVENT_THREAD_STATE_STOPPING) &&
(impl->thread_data.state == EVENT_THREAD_STATE_RUNNING);
if (AWS_UNLIKELY(initiate_stop)) {
impl->thread_data.state = EVENT_THREAD_STATE_STOPPING;
}
aws_linked_list_swap_contents(&impl->synced_data.tasks_to_schedule, &tasks_to_schedule);
aws_mutex_unlock(&impl->synced_data.mutex);
} /* End critical section */
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: notified of cross-thread tasks to schedule", (void *)event_loop);
s_process_tasks_to_schedule(event_loop, &tasks_to_schedule);
}
static int s_unsubscribe_from_io_events(struct aws_event_loop *event_loop, struct aws_io_handle *handle) {
(void)event_loop;
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: un-subscribing from events on handle %p",
(void *)event_loop,
(void *)handle->data.handle);
struct FILE_COMPLETION_INFORMATION file_completion_info;
file_completion_info.Key = NULL;
file_completion_info.Port = NULL;
struct IO_STATUS_BLOCK status_block;
AWS_ZERO_STRUCT(status_block);
NTSTATUS status = s_set_info_fn(
handle->data.handle,
&status_block,
&file_completion_info,
sizeof(file_completion_info),
FileReplaceCompletionInformation);
if (!status) {
return AWS_OP_SUCCESS;
}
AWS_LOGF_ERROR(
AWS_LS_IO_EVENT_LOOP,
"id=%p: failed to un-subscribe from events on handle %p",
(void *)event_loop,
(void *)handle->data.handle);
return aws_raise_error(AWS_ERROR_SYS_CALL_FAILURE);
}
static void s_free_io_event_resources(void *user_data) {
/* iocp has no additional data stored to handle I/O events */
(void)user_data;
}
/**
* This just calls GetQueuedCompletionStatusEx()
*
* We broke this out into its own function so that the stacktrace clearly shows
* what this thread is doing. We've had a lot of cases where users think this
* thread is deadlocked because it's stuck here. We want it to be clear
* that it's doing nothing on purpose. It's waiting for events to happen...
*/
AWS_NO_INLINE
static bool aws_event_loop_listen_for_io_events(
HANDLE iocp_handle,
OVERLAPPED_ENTRY completion_packets[MAX_COMPLETION_PACKETS_PER_LOOP],
ULONG *num_entries,
DWORD timeout_ms) {
return GetQueuedCompletionStatusEx(
iocp_handle, /* Completion port */
completion_packets, /* Out: completion port entries */
MAX_COMPLETION_PACKETS_PER_LOOP, /* max number of entries to remove */
num_entries, /* Out: number of entries removed */
timeout_ms, /* Timeout in ms. If timeout reached then FALSE is returned. */
false); /* Alertable */
}
/* Called from event-thread */
static void aws_event_loop_thread(void *user_data) {
struct aws_event_loop *event_loop = user_data;
AWS_LOGF_INFO(AWS_LS_IO_EVENT_LOOP, "id=%p: main loop started", (void *)event_loop);
struct iocp_loop *impl = event_loop->impl_data;
/* Set thread id to event loop thread id. */
aws_atomic_store_ptr(&impl->running_thread_id, &impl->thread_created_on.thread_id);
AWS_ASSERT(impl->thread_data.state == EVENT_THREAD_STATE_READY_TO_RUN);
impl->thread_data.state = EVENT_THREAD_STATE_RUNNING;
DWORD timeout_ms = DEFAULT_TIMEOUT_MS;
OVERLAPPED_ENTRY completion_packets[MAX_COMPLETION_PACKETS_PER_LOOP];
AWS_ZERO_ARRAY(completion_packets);
AWS_LOGF_INFO(AWS_LS_IO_EVENT_LOOP, "id=%p: default timeout %d", (void *)event_loop, (int)timeout_ms);
while (impl->thread_data.state == EVENT_THREAD_STATE_RUNNING) {
ULONG num_entries = 0;
bool should_process_synced_data = false;
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: waiting for a maximum of %d ms", (void *)event_loop, timeout_ms);
bool has_completion_entries = aws_event_loop_listen_for_io_events(
impl->iocp_handle, /* Completion port */
completion_packets, /* Out: completion port entries */
&num_entries, /* Out: number of entries removed */
timeout_ms); /* Timeout in ms. If timeout reached then FALSE is returned. */
aws_event_loop_register_tick_start(event_loop);
if (has_completion_entries) {
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: wake up with %lu events to process.",
(void *)event_loop,
(unsigned long)num_entries);
for (ULONG i = 0; i < num_entries; ++i) {
OVERLAPPED_ENTRY *completion = &completion_packets[i];
/* Is this a special completion packet which signals that synced_data has changed?
* (We use iocp_handle's value as the completion key for these special packets) */
if (completion->lpCompletionKey == (ULONG_PTR)impl->iocp_handle) {
should_process_synced_data = true;
} else {
/* Otherwise this was a normal completion on a connected aws_io_handle.
* Get our hands on the aws_overlapped which owns this OVERLAPPED,
* and invoke its callback */
struct aws_overlapped *overlapped =
AWS_CONTAINER_OF(completion->lpOverlapped, struct aws_overlapped, overlapped);
if (overlapped->on_completion) {
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: invoking handler.", (void *)event_loop);
overlapped->on_completion(
event_loop,
overlapped,
(int)overlapped->overlapped.Internal, /* Status code for the completed request */
completion->dwNumberOfBytesTransferred);
}
}
}
} else {
/* If no completion entries were dequeued then the timeout must have triggered */
AWS_ASSERT(GetLastError() == WAIT_TIMEOUT);
}
/* Process synced_data */
if (should_process_synced_data) {
s_process_synced_data(event_loop);
}
/* Run scheduled tasks */
uint64_t now_ns = 0;
event_loop->clock(&now_ns); /* If clock fails, now_ns will be 0 and tasks scheduled for a specific time
will not be run. That's ok, we'll handle them next time around. */
AWS_LOGF_TRACE(AWS_LS_IO_EVENT_LOOP, "id=%p: running scheduled tasks.", (void *)event_loop);
aws_task_scheduler_run_all(&impl->thread_data.scheduler, now_ns);
/* Set timeout for next GetQueuedCompletionStatus() call.
* If clock fails, or scheduler has no tasks, use default timeout */
bool use_default_timeout = false;
int err = event_loop->clock(&now_ns);
if (err) {
use_default_timeout = true;
}
uint64_t next_run_time_ns;
if (!aws_task_scheduler_has_tasks(&impl->thread_data.scheduler, &next_run_time_ns)) {
use_default_timeout = true;
}
if (use_default_timeout) {
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP, "id=%p: no more scheduled tasks using default timeout.", (void *)event_loop);
timeout_ms = DEFAULT_TIMEOUT_MS;
} else {
/* Translate timestamp (in nanoseconds) to timeout (in milliseconds) */
uint64_t timeout_ns = (next_run_time_ns > now_ns) ? (next_run_time_ns - now_ns) : 0;
uint64_t timeout_ms64 = aws_timestamp_convert(timeout_ns, AWS_TIMESTAMP_NANOS, AWS_TIMESTAMP_MILLIS, NULL);
timeout_ms = timeout_ms64 > MAXDWORD ? MAXDWORD : (DWORD)timeout_ms64;
AWS_LOGF_TRACE(
AWS_LS_IO_EVENT_LOOP,
"id=%p: detected more scheduled tasks with the next occurring at "
"%llu, using timeout of %d.",
(void *)event_loop,
(unsigned long long)next_run_time_ns,
(int)timeout_ms);
}
aws_event_loop_register_tick_end(event_loop);
}
AWS_LOGF_DEBUG(AWS_LS_IO_EVENT_LOOP, "id=%p: exiting main loop", (void *)event_loop);
/* set back to NULL. This should be updated again in destroy, right before task cancelation happens. */
aws_atomic_store_ptr(&impl->running_thread_id, NULL);
}
|