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 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/io/channel.h>
#include <aws/common/atomics.h>
#include <aws/common/clock.h>
#include <aws/common/mutex.h>
#include <aws/io/event_loop.h>
#include <aws/io/logging.h>
#include <aws/io/message_pool.h>
#include <aws/io/statistics.h>
#ifdef _MSC_VER
# pragma warning(disable : 4204) /* non-constant aggregate initializer */
#endif
static size_t s_message_pool_key = 0; /* Address of variable serves as key in hash table */
enum {
KB_16 = 16 * 1024,
};
size_t g_aws_channel_max_fragment_size = KB_16;
#define INITIAL_STATISTIC_LIST_SIZE 5
enum aws_channel_state {
AWS_CHANNEL_SETTING_UP,
AWS_CHANNEL_ACTIVE,
AWS_CHANNEL_SHUTTING_DOWN,
AWS_CHANNEL_SHUT_DOWN,
};
struct aws_shutdown_notification_task {
struct aws_task task;
int error_code;
struct aws_channel_slot *slot;
bool shutdown_immediately;
};
struct shutdown_task {
struct aws_channel_task task;
struct aws_channel *channel;
int error_code;
bool shutdown_immediately;
};
struct aws_channel {
struct aws_allocator *alloc;
struct aws_event_loop *loop;
struct aws_channel_slot *first;
struct aws_message_pool *msg_pool;
enum aws_channel_state channel_state;
struct aws_shutdown_notification_task shutdown_notify_task;
aws_channel_on_shutdown_completed_fn *on_shutdown_completed;
void *shutdown_user_data;
struct aws_atomic_var refcount;
struct aws_task deletion_task;
struct aws_task statistics_task;
struct aws_crt_statistics_handler *statistics_handler;
uint64_t statistics_interval_start_time_ms;
struct aws_array_list statistic_list;
struct {
struct aws_linked_list list;
} channel_thread_tasks;
struct {
struct aws_mutex lock;
struct aws_linked_list list;
struct aws_task scheduling_task;
struct shutdown_task shutdown_task;
bool is_channel_shut_down;
} cross_thread_tasks;
size_t window_update_batch_emit_threshold;
struct aws_channel_task window_update_task;
bool read_back_pressure_enabled;
bool window_update_scheduled;
};
struct channel_setup_args {
struct aws_allocator *alloc;
struct aws_channel *channel;
aws_channel_on_setup_completed_fn *on_setup_completed;
void *user_data;
struct aws_task task;
};
static void s_on_msg_pool_removed(struct aws_event_loop_local_object *object) {
struct aws_message_pool *msg_pool = object->object;
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"static: message pool %p has been purged "
"from the event-loop: likely because of shutdown",
(void *)msg_pool);
struct aws_allocator *alloc = msg_pool->alloc;
aws_message_pool_clean_up(msg_pool);
aws_mem_release(alloc, msg_pool);
aws_mem_release(alloc, object);
}
static void s_on_channel_setup_complete(struct aws_task *task, void *arg, enum aws_task_status task_status) {
(void)task;
struct channel_setup_args *setup_args = arg;
struct aws_message_pool *message_pool = NULL;
struct aws_event_loop_local_object *local_object = NULL;
AWS_LOGF_DEBUG(AWS_LS_IO_CHANNEL, "id=%p: setup complete, notifying caller.", (void *)setup_args->channel);
if (task_status == AWS_TASK_STATUS_RUN_READY) {
struct aws_event_loop_local_object stack_obj;
AWS_ZERO_STRUCT(stack_obj);
local_object = &stack_obj;
if (aws_event_loop_fetch_local_object(setup_args->channel->loop, &s_message_pool_key, local_object)) {
local_object = aws_mem_calloc(setup_args->alloc, 1, sizeof(struct aws_event_loop_local_object));
if (!local_object) {
goto cleanup_setup_args;
}
message_pool = aws_mem_acquire(setup_args->alloc, sizeof(struct aws_message_pool));
if (!message_pool) {
goto cleanup_local_obj;
}
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL,
"id=%p: no message pool is currently stored in the event-loop "
"local storage, adding %p with max message size %zu, "
"message count 4, with 4 small blocks of 128 bytes.",
(void *)setup_args->channel,
(void *)message_pool,
g_aws_channel_max_fragment_size);
struct aws_message_pool_creation_args creation_args = {
.application_data_msg_data_size = g_aws_channel_max_fragment_size,
.application_data_msg_count = 4,
.small_block_msg_count = 4,
.small_block_msg_data_size = 128,
};
if (aws_message_pool_init(message_pool, setup_args->alloc, &creation_args)) {
goto cleanup_msg_pool_mem;
}
local_object->key = &s_message_pool_key;
local_object->object = message_pool;
local_object->on_object_removed = s_on_msg_pool_removed;
if (aws_event_loop_put_local_object(setup_args->channel->loop, local_object)) {
goto cleanup_msg_pool;
}
} else {
message_pool = local_object->object;
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL,
"id=%p: message pool %p found in event-loop local storage: using it.",
(void *)setup_args->channel,
(void *)message_pool);
}
setup_args->channel->msg_pool = message_pool;
setup_args->channel->channel_state = AWS_CHANNEL_ACTIVE;
setup_args->on_setup_completed(setup_args->channel, AWS_OP_SUCCESS, setup_args->user_data);
aws_channel_release_hold(setup_args->channel);
aws_mem_release(setup_args->alloc, setup_args);
return;
}
goto cleanup_setup_args;
cleanup_msg_pool:
aws_message_pool_clean_up(message_pool);
cleanup_msg_pool_mem:
aws_mem_release(setup_args->alloc, message_pool);
cleanup_local_obj:
aws_mem_release(setup_args->alloc, local_object);
cleanup_setup_args:
setup_args->on_setup_completed(setup_args->channel, AWS_OP_ERR, setup_args->user_data);
aws_channel_release_hold(setup_args->channel);
aws_mem_release(setup_args->alloc, setup_args);
}
static void s_schedule_cross_thread_tasks(struct aws_task *task, void *arg, enum aws_task_status status);
static void s_destroy_partially_constructed_channel(struct aws_channel *channel) {
if (channel == NULL) {
return;
}
aws_array_list_clean_up(&channel->statistic_list);
aws_mem_release(channel->alloc, channel);
}
struct aws_channel *aws_channel_new(struct aws_allocator *alloc, const struct aws_channel_options *creation_args) {
AWS_PRECONDITION(creation_args);
AWS_PRECONDITION(creation_args->event_loop);
AWS_PRECONDITION(creation_args->on_setup_completed);
struct aws_channel *channel = aws_mem_calloc(alloc, 1, sizeof(struct aws_channel));
if (!channel) {
return NULL;
}
AWS_LOGF_DEBUG(AWS_LS_IO_CHANNEL, "id=%p: Beginning creation and setup of new channel.", (void *)channel);
channel->alloc = alloc;
channel->loop = creation_args->event_loop;
channel->on_shutdown_completed = creation_args->on_shutdown_completed;
channel->shutdown_user_data = creation_args->shutdown_user_data;
if (aws_array_list_init_dynamic(
&channel->statistic_list, alloc, INITIAL_STATISTIC_LIST_SIZE, sizeof(struct aws_crt_statistics_base *))) {
goto on_error;
}
/* Start refcount at 2:
* 1 for self-reference, released from aws_channel_destroy()
* 1 for the setup task, released when task executes */
aws_atomic_init_int(&channel->refcount, 2);
struct channel_setup_args *setup_args = aws_mem_calloc(alloc, 1, sizeof(struct channel_setup_args));
if (!setup_args) {
goto on_error;
}
channel->channel_state = AWS_CHANNEL_SETTING_UP;
aws_linked_list_init(&channel->channel_thread_tasks.list);
aws_linked_list_init(&channel->cross_thread_tasks.list);
channel->cross_thread_tasks.lock = (struct aws_mutex)AWS_MUTEX_INIT;
if (creation_args->enable_read_back_pressure) {
channel->read_back_pressure_enabled = true;
/* we probably only need room for one fragment, but let's avoid potential deadlocks
* on things like tls that need extra head-room. */
channel->window_update_batch_emit_threshold = g_aws_channel_max_fragment_size * 2;
}
aws_task_init(
&channel->cross_thread_tasks.scheduling_task,
s_schedule_cross_thread_tasks,
channel,
"schedule_cross_thread_tasks");
setup_args->alloc = alloc;
setup_args->channel = channel;
setup_args->on_setup_completed = creation_args->on_setup_completed;
setup_args->user_data = creation_args->setup_user_data;
aws_task_init(&setup_args->task, s_on_channel_setup_complete, setup_args, "on_channel_setup_complete");
aws_event_loop_schedule_task_now(creation_args->event_loop, &setup_args->task);
return channel;
on_error:
s_destroy_partially_constructed_channel(channel);
return NULL;
}
static void s_cleanup_slot(struct aws_channel_slot *slot) {
if (slot) {
if (slot->handler) {
aws_channel_handler_destroy(slot->handler);
}
aws_mem_release(slot->alloc, slot);
}
}
void aws_channel_destroy(struct aws_channel *channel) {
AWS_LOGF_DEBUG(AWS_LS_IO_CHANNEL, "id=%p: destroying channel.", (void *)channel);
aws_channel_release_hold(channel);
}
static void s_final_channel_deletion_task(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)task;
(void)status;
struct aws_channel *channel = arg;
struct aws_channel_slot *current = channel->first;
if (!current || !current->handler) {
/* Allow channels with no valid slots to skip shutdown process */
channel->channel_state = AWS_CHANNEL_SHUT_DOWN;
}
AWS_ASSERT(channel->channel_state == AWS_CHANNEL_SHUT_DOWN);
while (current) {
struct aws_channel_slot *tmp = current->adj_right;
s_cleanup_slot(current);
current = tmp;
}
aws_array_list_clean_up(&channel->statistic_list);
aws_channel_set_statistics_handler(channel, NULL);
aws_mem_release(channel->alloc, channel);
}
void aws_channel_acquire_hold(struct aws_channel *channel) {
size_t prev_refcount = aws_atomic_fetch_add(&channel->refcount, 1);
AWS_ASSERT(prev_refcount != 0);
(void)prev_refcount;
}
void aws_channel_release_hold(struct aws_channel *channel) {
size_t prev_refcount = aws_atomic_fetch_sub(&channel->refcount, 1);
AWS_ASSERT(prev_refcount != 0);
if (prev_refcount == 1) {
/* Refcount is now 0, finish cleaning up channel memory. */
if (aws_channel_thread_is_callers_thread(channel)) {
s_final_channel_deletion_task(NULL, channel, AWS_TASK_STATUS_RUN_READY);
} else {
aws_task_init(&channel->deletion_task, s_final_channel_deletion_task, channel, "final_channel_deletion");
aws_event_loop_schedule_task_now(channel->loop, &channel->deletion_task);
}
}
}
struct channel_shutdown_task_args {
struct aws_channel *channel;
struct aws_allocator *alloc;
int error_code;
struct aws_task task;
};
static int s_channel_shutdown(struct aws_channel *channel, int error_code, bool shutdown_immediately);
static void s_on_shutdown_completion_task(struct aws_task *task, void *arg, enum aws_task_status status);
static void s_shutdown_task(struct aws_channel_task *task, void *arg, enum aws_task_status status) {
(void)task;
(void)status;
struct shutdown_task *shutdown_task = arg;
struct aws_channel *channel = shutdown_task->channel;
int error_code = shutdown_task->error_code;
bool shutdown_immediately = shutdown_task->shutdown_immediately;
if (channel->channel_state < AWS_CHANNEL_SHUTTING_DOWN) {
AWS_LOGF_DEBUG(AWS_LS_IO_CHANNEL, "id=%p: beginning shutdown process", (void *)channel);
struct aws_channel_slot *slot = channel->first;
channel->channel_state = AWS_CHANNEL_SHUTTING_DOWN;
if (slot) {
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: shutting down slot %p (the first one) in the read direction",
(void *)channel,
(void *)slot);
aws_channel_slot_shutdown(slot, AWS_CHANNEL_DIR_READ, error_code, shutdown_immediately);
return;
}
channel->channel_state = AWS_CHANNEL_SHUT_DOWN;
AWS_LOGF_TRACE(AWS_LS_IO_CHANNEL, "id=%p: shutdown completed", (void *)channel);
aws_mutex_lock(&channel->cross_thread_tasks.lock);
channel->cross_thread_tasks.is_channel_shut_down = true;
aws_mutex_unlock(&channel->cross_thread_tasks.lock);
if (channel->on_shutdown_completed) {
channel->shutdown_notify_task.task.fn = s_on_shutdown_completion_task;
channel->shutdown_notify_task.task.arg = channel;
channel->shutdown_notify_task.error_code = error_code;
aws_event_loop_schedule_task_now(channel->loop, &channel->shutdown_notify_task.task);
}
}
}
static int s_channel_shutdown(struct aws_channel *channel, int error_code, bool shutdown_immediately) {
bool need_to_schedule = true;
aws_mutex_lock(&channel->cross_thread_tasks.lock);
if (channel->cross_thread_tasks.shutdown_task.task.task_fn) {
need_to_schedule = false;
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL, "id=%p: Channel shutdown is already pending, not scheduling another.", (void *)channel);
} else {
aws_channel_task_init(
&channel->cross_thread_tasks.shutdown_task.task,
s_shutdown_task,
&channel->cross_thread_tasks.shutdown_task,
"channel_shutdown");
channel->cross_thread_tasks.shutdown_task.shutdown_immediately = shutdown_immediately;
channel->cross_thread_tasks.shutdown_task.channel = channel;
channel->cross_thread_tasks.shutdown_task.error_code = error_code;
}
aws_mutex_unlock(&channel->cross_thread_tasks.lock);
if (need_to_schedule) {
AWS_LOGF_TRACE(AWS_LS_IO_CHANNEL, "id=%p: channel shutdown task is scheduled", (void *)channel);
aws_channel_schedule_task_now(channel, &channel->cross_thread_tasks.shutdown_task.task);
}
return AWS_OP_SUCCESS;
}
int aws_channel_shutdown(struct aws_channel *channel, int error_code) {
return s_channel_shutdown(channel, error_code, false);
}
struct aws_io_message *aws_channel_acquire_message_from_pool(
struct aws_channel *channel,
enum aws_io_message_type message_type,
size_t size_hint) {
struct aws_io_message *message = aws_message_pool_acquire(channel->msg_pool, message_type, size_hint);
if (AWS_LIKELY(message)) {
message->owning_channel = channel;
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: acquired message %p of capacity %zu from pool %p. Requested size was %zu",
(void *)channel,
(void *)message,
message->message_data.capacity,
(void *)channel->msg_pool,
size_hint);
}
return message;
}
struct aws_channel_slot *aws_channel_slot_new(struct aws_channel *channel) {
struct aws_channel_slot *new_slot = aws_mem_calloc(channel->alloc, 1, sizeof(struct aws_channel_slot));
if (!new_slot) {
return NULL;
}
AWS_LOGF_TRACE(AWS_LS_IO_CHANNEL, "id=%p: creating new slot %p.", (void *)channel, (void *)new_slot);
new_slot->alloc = channel->alloc;
new_slot->channel = channel;
if (!channel->first) {
channel->first = new_slot;
}
return new_slot;
}
int aws_channel_current_clock_time(struct aws_channel *channel, uint64_t *time_nanos) {
return aws_event_loop_current_clock_time(channel->loop, time_nanos);
}
int aws_channel_fetch_local_object(
struct aws_channel *channel,
const void *key,
struct aws_event_loop_local_object *obj) {
return aws_event_loop_fetch_local_object(channel->loop, (void *)key, obj);
}
int aws_channel_put_local_object(
struct aws_channel *channel,
const void *key,
const struct aws_event_loop_local_object *obj) {
(void)key;
return aws_event_loop_put_local_object(channel->loop, (struct aws_event_loop_local_object *)obj);
}
int aws_channel_remove_local_object(
struct aws_channel *channel,
const void *key,
struct aws_event_loop_local_object *removed_obj) {
return aws_event_loop_remove_local_object(channel->loop, (void *)key, removed_obj);
}
static void s_channel_task_run(struct aws_task *task, void *arg, enum aws_task_status status) {
struct aws_channel_task *channel_task = AWS_CONTAINER_OF(task, struct aws_channel_task, wrapper_task);
struct aws_channel *channel = arg;
/* Any task that runs after shutdown completes is considered canceled */
if (channel->channel_state == AWS_CHANNEL_SHUT_DOWN) {
status = AWS_TASK_STATUS_CANCELED;
}
aws_linked_list_remove(&channel_task->node);
channel_task->task_fn(channel_task, channel_task->arg, status);
}
static void s_schedule_cross_thread_tasks(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)task;
struct aws_channel *channel = arg;
struct aws_linked_list cross_thread_task_list;
aws_linked_list_init(&cross_thread_task_list);
/* Grab contents of cross-thread task list while we have the lock */
aws_mutex_lock(&channel->cross_thread_tasks.lock);
aws_linked_list_swap_contents(&channel->cross_thread_tasks.list, &cross_thread_task_list);
aws_mutex_unlock(&channel->cross_thread_tasks.lock);
/* If the channel has shut down since the cross-thread tasks were scheduled, run tasks immediately as canceled */
if (channel->channel_state == AWS_CHANNEL_SHUT_DOWN) {
status = AWS_TASK_STATUS_CANCELED;
}
while (!aws_linked_list_empty(&cross_thread_task_list)) {
struct aws_linked_list_node *node = aws_linked_list_pop_front(&cross_thread_task_list);
struct aws_channel_task *channel_task = AWS_CONTAINER_OF(node, struct aws_channel_task, node);
if ((channel_task->wrapper_task.timestamp == 0) || (status == AWS_TASK_STATUS_CANCELED)) {
/* Run "now" tasks, and canceled tasks, immediately */
channel_task->task_fn(channel_task, channel_task->arg, status);
} else {
/* "Future" tasks are scheduled with the event-loop. */
aws_linked_list_push_back(&channel->channel_thread_tasks.list, &channel_task->node);
aws_event_loop_schedule_task_future(
channel->loop, &channel_task->wrapper_task, channel_task->wrapper_task.timestamp);
}
}
}
void aws_channel_task_init(
struct aws_channel_task *channel_task,
aws_channel_task_fn *task_fn,
void *arg,
const char *type_tag) {
AWS_ZERO_STRUCT(*channel_task);
channel_task->task_fn = task_fn;
channel_task->arg = arg;
channel_task->type_tag = type_tag;
}
static void s_register_pending_task_in_event_loop(
struct aws_channel *channel,
struct aws_channel_task *channel_task,
uint64_t run_at_nanos) {
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: scheduling task with wrapper task id %p.",
(void *)channel,
(void *)&channel_task->wrapper_task);
/* If channel is shut down, run task immediately as canceled */
if (channel->channel_state == AWS_CHANNEL_SHUT_DOWN) {
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL,
"id=%p: Running %s channel task immediately as canceled due to shut down channel",
(void *)channel,
channel_task->type_tag);
channel_task->task_fn(channel_task, channel_task->arg, AWS_TASK_STATUS_CANCELED);
return;
}
aws_linked_list_push_back(&channel->channel_thread_tasks.list, &channel_task->node);
if (run_at_nanos == 0) {
aws_event_loop_schedule_task_now(channel->loop, &channel_task->wrapper_task);
} else {
aws_event_loop_schedule_task_future(
channel->loop, &channel_task->wrapper_task, channel_task->wrapper_task.timestamp);
}
}
static void s_register_pending_task_cross_thread(struct aws_channel *channel, struct aws_channel_task *channel_task) {
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: scheduling task with wrapper task id %p from "
"outside the event-loop thread.",
(void *)channel,
(void *)&channel_task->wrapper_task);
/* Outside event-loop thread... */
bool should_cancel_task = false;
/* Begin Critical Section */
aws_mutex_lock(&channel->cross_thread_tasks.lock);
if (channel->cross_thread_tasks.is_channel_shut_down) {
should_cancel_task = true; /* run task outside critical section to avoid deadlock */
} else {
bool list_was_empty = aws_linked_list_empty(&channel->cross_thread_tasks.list);
aws_linked_list_push_back(&channel->cross_thread_tasks.list, &channel_task->node);
if (list_was_empty) {
aws_event_loop_schedule_task_now(channel->loop, &channel->cross_thread_tasks.scheduling_task);
}
}
aws_mutex_unlock(&channel->cross_thread_tasks.lock);
/* End Critical Section */
if (should_cancel_task) {
channel_task->task_fn(channel_task, channel_task->arg, AWS_TASK_STATUS_CANCELED);
}
}
static void s_reset_pending_channel_task(
struct aws_channel *channel,
struct aws_channel_task *channel_task,
uint64_t run_at_nanos) {
/* Reset every property on channel task other than user's fn & arg.*/
aws_task_init(&channel_task->wrapper_task, s_channel_task_run, channel, channel_task->type_tag);
channel_task->wrapper_task.timestamp = run_at_nanos;
aws_linked_list_node_reset(&channel_task->node);
}
/* Common functionality for scheduling "now" and "future" tasks.
* For "now" tasks, pass 0 for `run_at_nanos` */
static void s_register_pending_task(
struct aws_channel *channel,
struct aws_channel_task *channel_task,
uint64_t run_at_nanos) {
s_reset_pending_channel_task(channel, channel_task, run_at_nanos);
if (aws_channel_thread_is_callers_thread(channel)) {
s_register_pending_task_in_event_loop(channel, channel_task, run_at_nanos);
} else {
s_register_pending_task_cross_thread(channel, channel_task);
}
}
void aws_channel_schedule_task_now(struct aws_channel *channel, struct aws_channel_task *task) {
s_register_pending_task(channel, task, 0);
}
void aws_channel_schedule_task_now_serialized(struct aws_channel *channel, struct aws_channel_task *task) {
s_reset_pending_channel_task(channel, task, 0);
s_register_pending_task_cross_thread(channel, task);
}
void aws_channel_schedule_task_future(
struct aws_channel *channel,
struct aws_channel_task *task,
uint64_t run_at_nanos) {
s_register_pending_task(channel, task, run_at_nanos);
}
bool aws_channel_thread_is_callers_thread(struct aws_channel *channel) {
return aws_event_loop_thread_is_callers_thread(channel->loop);
}
static void s_update_channel_slot_message_overheads(struct aws_channel *channel) {
size_t overhead = 0;
struct aws_channel_slot *slot_iter = channel->first;
while (slot_iter) {
slot_iter->upstream_message_overhead = overhead;
if (slot_iter->handler) {
overhead += slot_iter->handler->vtable->message_overhead(slot_iter->handler);
}
slot_iter = slot_iter->adj_right;
}
}
int aws_channel_slot_set_handler(struct aws_channel_slot *slot, struct aws_channel_handler *handler) {
slot->handler = handler;
slot->handler->slot = slot;
s_update_channel_slot_message_overheads(slot->channel);
return aws_channel_slot_increment_read_window(slot, slot->handler->vtable->initial_window_size(handler));
}
int aws_channel_slot_remove(struct aws_channel_slot *slot) {
if (slot->adj_right) {
slot->adj_right->adj_left = slot->adj_left;
if (slot == slot->channel->first) {
slot->channel->first = slot->adj_right;
}
}
if (slot->adj_left) {
slot->adj_left->adj_right = slot->adj_right;
}
if (slot == slot->channel->first) {
slot->channel->first = NULL;
}
s_update_channel_slot_message_overheads(slot->channel);
s_cleanup_slot(slot);
return AWS_OP_SUCCESS;
}
int aws_channel_slot_replace(struct aws_channel_slot *remove, struct aws_channel_slot *new_slot) {
new_slot->adj_left = remove->adj_left;
if (remove->adj_left) {
remove->adj_left->adj_right = new_slot;
}
new_slot->adj_right = remove->adj_right;
if (remove->adj_right) {
remove->adj_right->adj_left = new_slot;
}
if (remove == remove->channel->first) {
remove->channel->first = new_slot;
}
s_update_channel_slot_message_overheads(remove->channel);
s_cleanup_slot(remove);
return AWS_OP_SUCCESS;
}
int aws_channel_slot_insert_right(struct aws_channel_slot *slot, struct aws_channel_slot *to_add) {
to_add->adj_right = slot->adj_right;
if (slot->adj_right) {
slot->adj_right->adj_left = to_add;
}
slot->adj_right = to_add;
to_add->adj_left = slot;
return AWS_OP_SUCCESS;
}
int aws_channel_slot_insert_end(struct aws_channel *channel, struct aws_channel_slot *to_add) {
/* It's actually impossible there's not a first if the user went through the aws_channel_slot_new() function.
* But also check that a user didn't call insert_end if it's the first slot in the channel since first would already
* have been set. */
if (AWS_LIKELY(channel->first && channel->first != to_add)) {
struct aws_channel_slot *cur = channel->first;
while (cur->adj_right) {
cur = cur->adj_right;
}
return aws_channel_slot_insert_right(cur, to_add);
}
AWS_ASSERT(0);
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
int aws_channel_slot_insert_left(struct aws_channel_slot *slot, struct aws_channel_slot *to_add) {
to_add->adj_left = slot->adj_left;
if (slot->adj_left) {
slot->adj_left->adj_right = to_add;
}
slot->adj_left = to_add;
to_add->adj_right = slot;
if (slot == slot->channel->first) {
slot->channel->first = to_add;
}
return AWS_OP_SUCCESS;
}
int aws_channel_slot_send_message(
struct aws_channel_slot *slot,
struct aws_io_message *message,
enum aws_channel_direction dir) {
if (dir == AWS_CHANNEL_DIR_READ) {
AWS_ASSERT(slot->adj_right);
AWS_ASSERT(slot->adj_right->handler);
if (!slot->channel->read_back_pressure_enabled || slot->adj_right->window_size >= message->message_data.len) {
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: sending read message of size %zu, "
"from slot %p to slot %p with handler %p.",
(void *)slot->channel,
message->message_data.len,
(void *)slot,
(void *)slot->adj_right,
(void *)slot->adj_right->handler);
slot->adj_right->window_size -= message->message_data.len;
return aws_channel_handler_process_read_message(slot->adj_right->handler, slot->adj_right, message);
}
AWS_LOGF_ERROR(
AWS_LS_IO_CHANNEL,
"id=%p: sending message of size %zu, "
"from slot %p to slot %p with handler %p, but this would exceed the channel's "
"read window, this is always a programming error.",
(void *)slot->channel,
message->message_data.len,
(void *)slot,
(void *)slot->adj_right,
(void *)slot->adj_right->handler);
return aws_raise_error(AWS_IO_CHANNEL_READ_WOULD_EXCEED_WINDOW);
}
AWS_ASSERT(slot->adj_left);
AWS_ASSERT(slot->adj_left->handler);
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: sending write message of size %zu, "
"from slot %p to slot %p with handler %p.",
(void *)slot->channel,
message->message_data.len,
(void *)slot,
(void *)slot->adj_left,
(void *)slot->adj_left->handler);
return aws_channel_handler_process_write_message(slot->adj_left->handler, slot->adj_left, message);
}
struct aws_io_message *aws_channel_slot_acquire_max_message_for_write(struct aws_channel_slot *slot) {
AWS_PRECONDITION(slot);
AWS_PRECONDITION(slot->channel);
AWS_PRECONDITION(aws_channel_thread_is_callers_thread(slot->channel));
const size_t overhead = aws_channel_slot_upstream_message_overhead(slot);
if (overhead >= g_aws_channel_max_fragment_size) {
AWS_LOGF_ERROR(
AWS_LS_IO_CHANNEL, "id=%p: Upstream overhead exceeds channel's max message size.", (void *)slot->channel);
aws_raise_error(AWS_ERROR_INVALID_STATE);
return NULL;
}
const size_t size_hint = g_aws_channel_max_fragment_size - overhead;
return aws_channel_acquire_message_from_pool(slot->channel, AWS_IO_MESSAGE_APPLICATION_DATA, size_hint);
}
static void s_window_update_task(struct aws_channel_task *channel_task, void *arg, enum aws_task_status status) {
(void)channel_task;
struct aws_channel *channel = arg;
channel->window_update_scheduled = false;
if (status == AWS_TASK_STATUS_RUN_READY && channel->channel_state < AWS_CHANNEL_SHUTTING_DOWN) {
/* get the right-most slot to start the updates. */
struct aws_channel_slot *slot = channel->first;
while (slot->adj_right) {
slot = slot->adj_right;
}
while (slot->adj_left) {
struct aws_channel_slot *upstream_slot = slot->adj_left;
if (upstream_slot->handler) {
slot->window_size = aws_add_size_saturating(slot->window_size, slot->current_window_update_batch_size);
size_t update_size = slot->current_window_update_batch_size;
slot->current_window_update_batch_size = 0;
if (aws_channel_handler_increment_read_window(upstream_slot->handler, upstream_slot, update_size)) {
AWS_LOGF_ERROR(
AWS_LS_IO_CHANNEL,
"channel %p: channel update task failed with status %d",
(void *)slot->channel,
aws_last_error());
aws_channel_shutdown(channel, aws_last_error());
return;
}
}
slot = slot->adj_left;
}
}
}
int aws_channel_slot_increment_read_window(struct aws_channel_slot *slot, size_t window) {
if (slot->channel->read_back_pressure_enabled && slot->channel->channel_state < AWS_CHANNEL_SHUTTING_DOWN) {
slot->current_window_update_batch_size =
aws_add_size_saturating(slot->current_window_update_batch_size, window);
if (!slot->channel->window_update_scheduled &&
slot->window_size <= slot->channel->window_update_batch_emit_threshold) {
slot->channel->window_update_scheduled = true;
aws_channel_task_init(
&slot->channel->window_update_task, s_window_update_task, slot->channel, "window update task");
aws_channel_schedule_task_now(slot->channel, &slot->channel->window_update_task);
}
}
return AWS_OP_SUCCESS;
}
int aws_channel_slot_shutdown(
struct aws_channel_slot *slot,
enum aws_channel_direction dir,
int err_code,
bool free_scarce_resources_immediately) {
AWS_ASSERT(slot->handler);
AWS_LOGF_TRACE(
AWS_LS_IO_CHANNEL,
"id=%p: shutting down slot %p, with handler %p "
"in %s direction with error code %d",
(void *)slot->channel,
(void *)slot,
(void *)slot->handler,
(dir == AWS_CHANNEL_DIR_READ) ? "read" : "write",
err_code);
return aws_channel_handler_shutdown(slot->handler, slot, dir, err_code, free_scarce_resources_immediately);
}
static void s_on_shutdown_completion_task(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)status;
struct aws_shutdown_notification_task *shutdown_notify = (struct aws_shutdown_notification_task *)task;
struct aws_channel *channel = arg;
AWS_ASSERT(channel->channel_state == AWS_CHANNEL_SHUT_DOWN);
/* Cancel tasks that have been scheduled with the event loop */
while (!aws_linked_list_empty(&channel->channel_thread_tasks.list)) {
struct aws_linked_list_node *node = aws_linked_list_front(&channel->channel_thread_tasks.list);
struct aws_channel_task *channel_task = AWS_CONTAINER_OF(node, struct aws_channel_task, node);
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL,
"id=%p: during shutdown, canceling task %p",
(void *)channel,
(void *)&channel_task->wrapper_task);
/* The task will remove itself from the list when it's canceled */
aws_event_loop_cancel_task(channel->loop, &channel_task->wrapper_task);
}
/* Cancel off-thread tasks, which haven't made it to the event-loop thread yet */
aws_mutex_lock(&channel->cross_thread_tasks.lock);
bool cancel_cross_thread_tasks = !aws_linked_list_empty(&channel->cross_thread_tasks.list);
aws_mutex_unlock(&channel->cross_thread_tasks.lock);
if (cancel_cross_thread_tasks) {
aws_event_loop_cancel_task(channel->loop, &channel->cross_thread_tasks.scheduling_task);
}
AWS_ASSERT(aws_linked_list_empty(&channel->channel_thread_tasks.list));
AWS_ASSERT(aws_linked_list_empty(&channel->cross_thread_tasks.list));
channel->on_shutdown_completed(channel, shutdown_notify->error_code, channel->shutdown_user_data);
}
static void s_run_shutdown_write_direction(struct aws_task *task, void *arg, enum aws_task_status status) {
(void)arg;
(void)status;
struct aws_shutdown_notification_task *shutdown_notify = (struct aws_shutdown_notification_task *)task;
task->fn = NULL;
task->arg = NULL;
struct aws_channel_slot *slot = shutdown_notify->slot;
aws_channel_handler_shutdown(
slot->handler, slot, AWS_CHANNEL_DIR_WRITE, shutdown_notify->error_code, shutdown_notify->shutdown_immediately);
}
int aws_channel_slot_on_handler_shutdown_complete(
struct aws_channel_slot *slot,
enum aws_channel_direction dir,
int err_code,
bool free_scarce_resources_immediately) {
AWS_LOGF_DEBUG(
AWS_LS_IO_CHANNEL,
"id=%p: handler %p shutdown in %s dir completed.",
(void *)slot->channel,
(void *)slot->handler,
(dir == AWS_CHANNEL_DIR_READ) ? "read" : "write");
if (slot->channel->channel_state == AWS_CHANNEL_SHUT_DOWN) {
return AWS_OP_SUCCESS;
}
if (dir == AWS_CHANNEL_DIR_READ) {
if (slot->adj_right && slot->adj_right->handler) {
return aws_channel_handler_shutdown(
slot->adj_right->handler, slot->adj_right, dir, err_code, free_scarce_resources_immediately);
}
/* break the shutdown sequence so we don't have handlers having to deal with their memory disappearing out from
* under them during a shutdown process. */
slot->channel->shutdown_notify_task.slot = slot;
slot->channel->shutdown_notify_task.shutdown_immediately = free_scarce_resources_immediately;
slot->channel->shutdown_notify_task.error_code = err_code;
slot->channel->shutdown_notify_task.task.fn = s_run_shutdown_write_direction;
slot->channel->shutdown_notify_task.task.arg = NULL;
aws_event_loop_schedule_task_now(slot->channel->loop, &slot->channel->shutdown_notify_task.task);
return AWS_OP_SUCCESS;
}
if (slot->adj_left && slot->adj_left->handler) {
return aws_channel_handler_shutdown(
slot->adj_left->handler, slot->adj_left, dir, err_code, free_scarce_resources_immediately);
}
if (slot->channel->first == slot) {
slot->channel->channel_state = AWS_CHANNEL_SHUT_DOWN;
aws_mutex_lock(&slot->channel->cross_thread_tasks.lock);
slot->channel->cross_thread_tasks.is_channel_shut_down = true;
aws_mutex_unlock(&slot->channel->cross_thread_tasks.lock);
if (slot->channel->on_shutdown_completed) {
slot->channel->shutdown_notify_task.task.fn = s_on_shutdown_completion_task;
slot->channel->shutdown_notify_task.task.arg = slot->channel;
slot->channel->shutdown_notify_task.error_code = err_code;
aws_event_loop_schedule_task_now(slot->channel->loop, &slot->channel->shutdown_notify_task.task);
}
}
return AWS_OP_SUCCESS;
}
size_t aws_channel_slot_downstream_read_window(struct aws_channel_slot *slot) {
AWS_ASSERT(slot->adj_right);
return slot->channel->read_back_pressure_enabled ? slot->adj_right->window_size : SIZE_MAX;
}
size_t aws_channel_slot_upstream_message_overhead(struct aws_channel_slot *slot) {
return slot->upstream_message_overhead;
}
void aws_channel_handler_destroy(struct aws_channel_handler *handler) {
AWS_ASSERT(handler->vtable && handler->vtable->destroy);
handler->vtable->destroy(handler);
}
int aws_channel_handler_process_read_message(
struct aws_channel_handler *handler,
struct aws_channel_slot *slot,
struct aws_io_message *message) {
AWS_ASSERT(handler->vtable && handler->vtable->process_read_message);
return handler->vtable->process_read_message(handler, slot, message);
}
int aws_channel_handler_process_write_message(
struct aws_channel_handler *handler,
struct aws_channel_slot *slot,
struct aws_io_message *message) {
AWS_ASSERT(handler->vtable && handler->vtable->process_write_message);
return handler->vtable->process_write_message(handler, slot, message);
}
int aws_channel_handler_increment_read_window(
struct aws_channel_handler *handler,
struct aws_channel_slot *slot,
size_t size) {
AWS_ASSERT(handler->vtable && handler->vtable->increment_read_window);
return handler->vtable->increment_read_window(handler, slot, size);
}
int aws_channel_handler_shutdown(
struct aws_channel_handler *handler,
struct aws_channel_slot *slot,
enum aws_channel_direction dir,
int error_code,
bool free_scarce_resources_immediately) {
AWS_ASSERT(handler->vtable && handler->vtable->shutdown);
return handler->vtable->shutdown(handler, slot, dir, error_code, free_scarce_resources_immediately);
}
size_t aws_channel_handler_initial_window_size(struct aws_channel_handler *handler) {
AWS_ASSERT(handler->vtable && handler->vtable->initial_window_size);
return handler->vtable->initial_window_size(handler);
}
struct aws_channel_slot *aws_channel_get_first_slot(struct aws_channel *channel) {
return channel->first;
}
static void s_reset_statistics(struct aws_channel *channel) {
AWS_FATAL_ASSERT(aws_channel_thread_is_callers_thread(channel));
struct aws_channel_slot *current_slot = channel->first;
while (current_slot) {
struct aws_channel_handler *handler = current_slot->handler;
if (handler != NULL && handler->vtable->reset_statistics != NULL) {
handler->vtable->reset_statistics(handler);
}
current_slot = current_slot->adj_right;
}
}
static void s_channel_gather_statistics_task(struct aws_task *task, void *arg, enum aws_task_status status) {
if (status != AWS_TASK_STATUS_RUN_READY) {
return;
}
struct aws_channel *channel = arg;
if (channel->statistics_handler == NULL) {
return;
}
if (channel->channel_state == AWS_CHANNEL_SHUTTING_DOWN || channel->channel_state == AWS_CHANNEL_SHUT_DOWN) {
return;
}
uint64_t now_ns = 0;
if (aws_channel_current_clock_time(channel, &now_ns)) {
return;
}
uint64_t now_ms = aws_timestamp_convert(now_ns, AWS_TIMESTAMP_NANOS, AWS_TIMESTAMP_MILLIS, NULL);
struct aws_array_list *statistics_list = &channel->statistic_list;
aws_array_list_clear(statistics_list);
struct aws_channel_slot *current_slot = channel->first;
while (current_slot) {
struct aws_channel_handler *handler = current_slot->handler;
if (handler != NULL && handler->vtable->gather_statistics != NULL) {
handler->vtable->gather_statistics(handler, statistics_list);
}
current_slot = current_slot->adj_right;
}
struct aws_crt_statistics_sample_interval sample_interval = {
.begin_time_ms = channel->statistics_interval_start_time_ms, .end_time_ms = now_ms};
aws_crt_statistics_handler_process_statistics(
channel->statistics_handler, &sample_interval, statistics_list, channel);
s_reset_statistics(channel);
uint64_t reschedule_interval_ns = aws_timestamp_convert(
aws_crt_statistics_handler_get_report_interval_ms(channel->statistics_handler),
AWS_TIMESTAMP_MILLIS,
AWS_TIMESTAMP_NANOS,
NULL);
aws_event_loop_schedule_task_future(channel->loop, task, now_ns + reschedule_interval_ns);
channel->statistics_interval_start_time_ms = now_ms;
}
int aws_channel_set_statistics_handler(struct aws_channel *channel, struct aws_crt_statistics_handler *handler) {
AWS_FATAL_ASSERT(aws_channel_thread_is_callers_thread(channel));
if (channel->statistics_handler) {
aws_crt_statistics_handler_destroy(channel->statistics_handler);
aws_event_loop_cancel_task(channel->loop, &channel->statistics_task);
channel->statistics_handler = NULL;
}
if (handler != NULL) {
aws_task_init(&channel->statistics_task, s_channel_gather_statistics_task, channel, "gather_statistics");
uint64_t now_ns = 0;
if (aws_channel_current_clock_time(channel, &now_ns)) {
return AWS_OP_ERR;
}
uint64_t report_time_ns = now_ns + aws_timestamp_convert(
aws_crt_statistics_handler_get_report_interval_ms(handler),
AWS_TIMESTAMP_MILLIS,
AWS_TIMESTAMP_NANOS,
NULL);
channel->statistics_interval_start_time_ms =
aws_timestamp_convert(now_ns, AWS_TIMESTAMP_NANOS, AWS_TIMESTAMP_MILLIS, NULL);
s_reset_statistics(channel);
aws_event_loop_schedule_task_future(channel->loop, &channel->statistics_task, report_time_ns);
}
channel->statistics_handler = handler;
return AWS_OP_SUCCESS;
}
struct aws_event_loop *aws_channel_get_event_loop(struct aws_channel *channel) {
return channel->loop;
}
int aws_channel_trigger_read(struct aws_channel *channel) {
if (channel == NULL) {
return aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
}
if (!aws_channel_thread_is_callers_thread(channel)) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
struct aws_channel_slot *slot = channel->first;
if (slot == NULL) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
struct aws_channel_handler *handler = slot->handler;
if (handler == NULL) {
return aws_raise_error(AWS_ERROR_INVALID_STATE);
}
if (handler->vtable->trigger_read != NULL) {
handler->vtable->trigger_read(handler);
}
return AWS_OP_SUCCESS;
}
|