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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/event-stream/event_stream_channel_handler.h>
#include <aws/event-stream/event_stream_rpc_client.h>
#include <aws/event-stream/private/event_stream_rpc_priv.h>
#include <aws/common/atomics.h>
#include <aws/common/hash_table.h>
#include <aws/common/mutex.h>
#include <aws/io/channel_bootstrap.h>
#include <inttypes.h>
#ifdef _MSC_VER
/* allow declared initializer using address of automatic variable */
# pragma warning(disable : 4221)
/* allow non-constant aggregate initializers */
# pragma warning(disable : 4204)
#endif
static void s_clear_continuation_table(struct aws_event_stream_rpc_client_connection *connection);
struct aws_event_stream_rpc_client_connection {
struct aws_allocator *allocator;
struct aws_hash_table continuation_table;
struct aws_client_bootstrap *bootstrap_ref;
struct aws_atomic_var ref_count;
struct aws_channel *channel;
struct aws_channel_handler *event_stream_handler;
uint32_t latest_stream_id;
struct aws_mutex stream_lock;
struct aws_atomic_var is_open;
struct aws_atomic_var handshake_state;
size_t initial_window_size;
aws_event_stream_rpc_client_on_connection_setup_fn *on_connection_setup;
aws_event_stream_rpc_client_connection_protocol_message_fn *on_connection_protocol_message;
aws_event_stream_rpc_client_on_connection_shutdown_fn *on_connection_shutdown;
void *user_data;
bool bootstrap_owned;
bool enable_read_back_pressure;
};
struct aws_event_stream_rpc_client_continuation_token {
uint32_t stream_id;
struct aws_event_stream_rpc_client_connection *connection;
aws_event_stream_rpc_client_stream_continuation_fn *continuation_fn;
aws_event_stream_rpc_client_stream_continuation_closed_fn *closed_fn;
void *user_data;
struct aws_atomic_var ref_count;
struct aws_atomic_var is_closed;
struct aws_atomic_var is_complete;
};
static void s_on_message_received(struct aws_event_stream_message *message, int error_code, void *user_data);
static int s_create_connection_on_channel(
struct aws_event_stream_rpc_client_connection *connection,
struct aws_channel *channel) {
struct aws_channel_handler *event_stream_handler = NULL;
struct aws_channel_slot *slot = NULL;
struct aws_event_stream_channel_handler_options handler_options = {
.on_message_received = s_on_message_received,
.user_data = connection,
.initial_window_size = connection->initial_window_size,
.manual_window_management = connection->enable_read_back_pressure,
};
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: creating an event-stream handler on channel %p",
(void *)connection,
(void *)channel);
event_stream_handler = aws_event_stream_channel_handler_new(connection->allocator, &handler_options);
if (!event_stream_handler) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: creating an event-stream handler failed with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto error;
}
slot = aws_channel_slot_new(channel);
if (!slot) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: creating channel slot failed with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto error;
}
aws_channel_slot_insert_end(channel, slot);
if (aws_channel_slot_set_handler(slot, event_stream_handler)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: setting handler on channel slot failed with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto error;
}
connection->event_stream_handler = event_stream_handler;
connection->channel = channel;
aws_channel_acquire_hold(channel);
return AWS_OP_SUCCESS;
error:
if (!slot && event_stream_handler) {
aws_channel_handler_destroy(event_stream_handler);
}
return AWS_OP_ERR;
}
static void s_on_channel_setup_fn(
struct aws_client_bootstrap *bootstrap,
int error_code,
struct aws_channel *channel,
void *user_data) {
(void)bootstrap;
struct aws_event_stream_rpc_client_connection *connection = user_data;
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: on_channel_setup_fn invoked with error_code %d with channel %p",
(void *)connection,
error_code,
(void *)channel);
if (!error_code) {
connection->bootstrap_owned = true;
if (s_create_connection_on_channel(connection, channel)) {
int last_error = aws_last_error();
connection->on_connection_setup(NULL, last_error, connection->user_data);
aws_channel_shutdown(channel, last_error);
return;
}
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: successful event-stream channel setup %p",
(void *)connection,
(void *)channel);
aws_event_stream_rpc_client_connection_acquire(connection);
connection->on_connection_setup(connection, AWS_OP_SUCCESS, connection->user_data);
aws_event_stream_rpc_client_connection_release(connection);
} else {
connection->on_connection_setup(NULL, error_code, connection->user_data);
aws_event_stream_rpc_client_connection_release(connection);
}
}
static void s_on_channel_shutdown_fn(
struct aws_client_bootstrap *bootstrap,
int error_code,
struct aws_channel *channel,
void *user_data) {
(void)bootstrap;
struct aws_event_stream_rpc_client_connection *connection = user_data;
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: on_channel_shutdown_fn invoked with error_code %d with channel %p",
(void *)connection,
error_code,
(void *)channel);
aws_atomic_store_int(&connection->is_open, 0u);
if (connection->bootstrap_owned) {
s_clear_continuation_table(connection);
aws_event_stream_rpc_client_connection_acquire(connection);
connection->on_connection_shutdown(connection, error_code, connection->user_data);
aws_event_stream_rpc_client_connection_release(connection);
}
aws_channel_release_hold(channel);
aws_event_stream_rpc_client_connection_release(connection);
}
/* Set each continuation's is_closed=true.
* A lock MUST be held while calling this.
* For use with aws_hash_table_foreach(). */
static int s_mark_each_continuation_closed(void *context, struct aws_hash_element *p_element) {
(void)context;
struct aws_event_stream_rpc_client_continuation_token *continuation = p_element->value;
aws_atomic_store_int(&continuation->is_closed, 1U);
return AWS_COMMON_HASH_TABLE_ITER_CONTINUE;
}
/* Invoke continuation's on_closed() callback.
* A lock must NOT be hold while calling this */
static void s_complete_continuation(struct aws_event_stream_rpc_client_continuation_token *token) {
size_t expect_not_complete = 0U;
if (aws_atomic_compare_exchange_int(&token->is_complete, &expect_not_complete, 1U)) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"token=%p: completing continuation with stream-id %" PRIu32,
(void *)token,
token->stream_id);
if (token->stream_id) {
token->closed_fn(token, token->user_data);
}
aws_event_stream_rpc_client_continuation_release(token);
}
}
static int s_complete_and_clear_each_continuation(void *context, struct aws_hash_element *p_element) {
(void)context;
struct aws_event_stream_rpc_client_continuation_token *continuation = p_element->value;
s_complete_continuation(continuation);
return AWS_COMMON_HASH_TABLE_ITER_DELETE | AWS_COMMON_HASH_TABLE_ITER_CONTINUE;
}
/* Remove each continuation from hash-table and invoke its on_closed() callback.
* The connection->is_open must be set false before calling this. */
static void s_clear_continuation_table(struct aws_event_stream_rpc_client_connection *connection) {
AWS_ASSERT(!aws_event_stream_rpc_client_connection_is_open(connection));
/* Use lock to ensure synchronization with code that adds entries to table.
* Since connection was just marked closed, no further entries will be
* added to table once we acquire the lock. */
aws_mutex_lock(&connection->stream_lock);
aws_hash_table_foreach(&connection->continuation_table, s_mark_each_continuation_closed, NULL);
aws_mutex_unlock(&connection->stream_lock);
/* Now release lock before invoking callbacks.
* It's safe to alter the table now without a lock, since no further
* entries can be added, and we've gone through the critical section
* above to ensure synchronization */
aws_hash_table_foreach(&connection->continuation_table, s_complete_and_clear_each_continuation, NULL);
}
int aws_event_stream_rpc_client_connection_connect(
struct aws_allocator *allocator,
const struct aws_event_stream_rpc_client_connection_options *conn_options) {
AWS_PRECONDITION(allocator);
AWS_PRECONDITION(conn_options);
AWS_PRECONDITION(conn_options->on_connection_protocol_message);
AWS_PRECONDITION(conn_options->on_connection_setup);
AWS_PRECONDITION(conn_options->on_connection_shutdown);
struct aws_event_stream_rpc_client_connection *connection =
aws_mem_calloc(allocator, 1, sizeof(struct aws_event_stream_rpc_client_connection));
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: creating new connection", (void *)connection);
if (!connection) {
return AWS_OP_ERR;
}
connection->allocator = allocator;
aws_atomic_init_int(&connection->ref_count, 1);
connection->bootstrap_ref = conn_options->bootstrap;
/* this is released in the connection release which gets called regardless of if this function is successful or
* not*/
aws_client_bootstrap_acquire(connection->bootstrap_ref);
aws_atomic_init_int(&connection->handshake_state, CONNECTION_HANDSHAKE_STATE_INITIALIZED);
aws_atomic_init_int(&connection->is_open, 1);
aws_mutex_init(&connection->stream_lock);
connection->on_connection_shutdown = conn_options->on_connection_shutdown;
connection->on_connection_protocol_message = conn_options->on_connection_protocol_message;
connection->on_connection_setup = conn_options->on_connection_setup;
connection->user_data = conn_options->user_data;
if (aws_hash_table_init(
&connection->continuation_table,
allocator,
64,
aws_event_stream_rpc_hash_streamid,
aws_event_stream_rpc_streamid_eq,
NULL,
NULL)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: failed initializing continuation table with error %s.",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto error;
}
struct aws_socket_channel_bootstrap_options bootstrap_options = {
.bootstrap = connection->bootstrap_ref,
.tls_options = conn_options->tls_options,
.socket_options = conn_options->socket_options,
.user_data = connection,
.host_name = conn_options->host_name,
.port = conn_options->port,
.enable_read_back_pressure = false,
.setup_callback = s_on_channel_setup_fn,
.shutdown_callback = s_on_channel_shutdown_fn,
};
if (aws_client_bootstrap_new_socket_channel(&bootstrap_options)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: failed creating new socket channel with error %s.",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto error;
}
return AWS_OP_SUCCESS;
error:
aws_event_stream_rpc_client_connection_release(connection);
return AWS_OP_ERR;
}
void aws_event_stream_rpc_client_connection_acquire(const struct aws_event_stream_rpc_client_connection *connection) {
AWS_PRECONDITION(connection);
size_t current_count = aws_atomic_fetch_add_explicit(
&((struct aws_event_stream_rpc_client_connection *)connection)->ref_count, 1, aws_memory_order_relaxed);
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connection acquired, new ref count is %zu.",
(void *)connection,
current_count + 1);
}
static void s_destroy_connection(struct aws_event_stream_rpc_client_connection *connection) {
AWS_LOGF_DEBUG(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: destroying connection.", (void *)connection);
aws_hash_table_clean_up(&connection->continuation_table);
aws_client_bootstrap_release(connection->bootstrap_ref);
aws_mem_release(connection->allocator, connection);
}
void aws_event_stream_rpc_client_connection_release(const struct aws_event_stream_rpc_client_connection *connection) {
if (!connection) {
return;
}
struct aws_event_stream_rpc_client_connection *connection_mut =
(struct aws_event_stream_rpc_client_connection *)connection;
size_t ref_count = aws_atomic_fetch_sub_explicit(&connection_mut->ref_count, 1, aws_memory_order_seq_cst);
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connection released, new ref count is %zu.",
(void *)connection,
ref_count - 1);
AWS_FATAL_ASSERT(ref_count != 0 && "Connection ref count has gone negative");
if (ref_count == 1) {
s_destroy_connection(connection_mut);
}
}
void aws_event_stream_rpc_client_connection_close(
struct aws_event_stream_rpc_client_connection *connection,
int shutdown_error_code) {
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connection close invoked with reason %s.",
(void *)connection,
aws_error_debug_str(shutdown_error_code));
size_t expect_open = 1U;
if (aws_atomic_compare_exchange_int(&connection->is_open, &expect_open, 0U)) {
aws_channel_shutdown(connection->channel, shutdown_error_code);
if (!connection->bootstrap_owned) {
s_clear_continuation_table(connection);
aws_event_stream_rpc_client_connection_release(connection);
}
} else {
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: connection already closed.", (void *)connection);
}
}
bool aws_event_stream_rpc_client_connection_is_open(const struct aws_event_stream_rpc_client_connection *connection) {
return aws_atomic_load_int(&connection->is_open) == 1U;
}
struct event_stream_connection_send_message_args {
struct aws_allocator *allocator;
struct aws_event_stream_message message;
enum aws_event_stream_rpc_message_type message_type;
struct aws_event_stream_rpc_client_connection *connection;
struct aws_event_stream_rpc_client_continuation_token *continuation;
aws_event_stream_rpc_client_message_flush_fn *flush_fn;
void *user_data;
bool end_stream;
bool terminate_connection;
};
static void s_on_protocol_message_written_fn(
struct aws_event_stream_message *message,
int error_code,
void *user_data) {
(void)message;
struct event_stream_connection_send_message_args *message_args = user_data;
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: message %p flushed to channel.",
(void *)message_args->connection,
(void *)message);
if (message_args->message_type == AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT) {
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connect message flushed to the wire.",
(void *)message_args->connection);
}
if (message_args->end_stream) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: the end stream flag was set, closing continuation %p.",
(void *)message_args->connection,
(void *)message_args->continuation);
AWS_FATAL_ASSERT(message_args->continuation && "end stream flag was set but it wasn't on a continuation");
aws_atomic_store_int(&message_args->continuation->is_closed, 1U);
aws_mutex_lock(&message_args->connection->stream_lock);
aws_hash_table_remove(
&message_args->connection->continuation_table, &message_args->continuation->stream_id, NULL, NULL);
aws_mutex_unlock(&message_args->connection->stream_lock);
/* Lock must NOT be held while invoking callback */
s_complete_continuation(message_args->continuation);
}
message_args->flush_fn(error_code, message_args->user_data);
if (message_args->terminate_connection) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: terminate_connection flag was specified. Shutting down the connection.",
(void *)message_args->connection);
aws_event_stream_rpc_client_connection_close(message_args->connection, AWS_ERROR_SUCCESS);
}
aws_event_stream_rpc_client_connection_release(message_args->connection);
if (message_args->continuation) {
aws_event_stream_rpc_client_continuation_release(message_args->continuation);
}
aws_event_stream_message_clean_up(&message_args->message);
aws_mem_release(message_args->allocator, message_args);
}
static int s_send_protocol_message(
struct aws_event_stream_rpc_client_connection *connection,
struct aws_event_stream_rpc_client_continuation_token *continuation,
struct aws_byte_cursor *operation_name,
const struct aws_event_stream_rpc_message_args *message_args,
int32_t stream_id,
aws_event_stream_rpc_client_message_flush_fn *flush_fn,
void *user_data) {
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: sending message. continuation: %p, stream id %" PRId32,
(void *)connection,
(void *)continuation,
stream_id);
size_t connect_handshake_state = aws_atomic_load_int(&connection->handshake_state);
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: handshake completion value %zu",
(void *)connection,
connect_handshake_state);
/* handshake step 1 is a connect message being received. Handshake 2 is the connect ack being sent.
* no messages other than connect and connect ack are allowed until this count reaches 2. */
if (connect_handshake_state != CONNECTION_HANDSHAKE_STATE_CONNECT_ACK_PROCESSED &&
message_args->message_type < AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: handshake not completed, only a connect message can be sent.",
(void *)connection);
return aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_PROTOCOL_ERROR);
}
struct event_stream_connection_send_message_args *args =
aws_mem_calloc(connection->allocator, 1, sizeof(struct event_stream_connection_send_message_args));
args->allocator = connection->allocator;
args->user_data = user_data;
args->message_type = message_args->message_type;
args->connection = connection;
args->flush_fn = flush_fn;
if (continuation) {
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: sending message on continuation %p",
(void *)connection,
(void *)continuation);
args->continuation = continuation;
aws_event_stream_rpc_client_continuation_acquire(continuation);
if (message_args->message_flags & AWS_EVENT_STREAM_RPC_MESSAGE_FLAG_TERMINATE_STREAM) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p:end stream flag was specified on continuation %p",
(void *)connection,
(void *)continuation);
args->end_stream = true;
}
}
if (message_args->message_type == AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT_ACK &&
!(message_args->message_flags & AWS_EVENT_STREAM_RPC_MESSAGE_FLAG_CONNECTION_ACCEPTED)) {
AWS_LOGF_DEBUG(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: terminating connection", (void *)connection);
args->terminate_connection = true;
}
if (message_args->message_type == AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: sending connect message, waiting on connect ack",
(void *)connection);
aws_atomic_store_int(&connection->handshake_state, CONNECTION_HANDSHAKE_STATE_CONNECT_PROCESSED);
}
args->flush_fn = flush_fn;
size_t headers_count = 0;
if (operation_name) {
if (aws_add_size_checked(message_args->headers_count, 4, &headers_count)) {
return AWS_OP_ERR;
}
} else {
if (aws_add_size_checked(message_args->headers_count, 3, &headers_count)) {
return AWS_OP_ERR;
}
}
struct aws_array_list headers_list;
AWS_ZERO_STRUCT(headers_list);
if (aws_array_list_init_dynamic(
&headers_list, connection->allocator, headers_count, sizeof(struct aws_event_stream_header_value_pair))) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: an error occurred while initializing the headers list %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto args_allocated_before_failure;
}
/* since we preallocated the space for the headers, these can't fail, but we'll go ahead an assert on them just in
* case */
for (size_t i = 0; i < message_args->headers_count; ++i) {
AWS_FATAL_ASSERT(!aws_array_list_push_back(&headers_list, &message_args->headers[i]));
}
AWS_FATAL_ASSERT(!aws_event_stream_add_int32_header(
&headers_list,
(const char *)aws_event_stream_rpc_message_type_name.ptr,
(uint8_t)aws_event_stream_rpc_message_type_name.len,
message_args->message_type));
AWS_FATAL_ASSERT(!aws_event_stream_add_int32_header(
&headers_list,
(const char *)aws_event_stream_rpc_message_flags_name.ptr,
(uint8_t)aws_event_stream_rpc_message_flags_name.len,
message_args->message_flags));
AWS_FATAL_ASSERT(!aws_event_stream_add_int32_header(
&headers_list,
(const char *)aws_event_stream_rpc_stream_id_name.ptr,
(uint8_t)aws_event_stream_rpc_stream_id_name.len,
stream_id));
if (operation_name) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: operation name specified " PRInSTR,
(void *)connection,
AWS_BYTE_CURSOR_PRI(*operation_name));
AWS_FATAL_ASSERT(!aws_event_stream_add_string_header(
&headers_list,
(const char *)aws_event_stream_rpc_operation_name.ptr,
(uint8_t)aws_event_stream_rpc_operation_name.len,
(const char *)operation_name->ptr,
(uint16_t)operation_name->len,
0));
}
int message_init_err_code =
aws_event_stream_message_init(&args->message, connection->allocator, &headers_list, message_args->payload);
aws_array_list_clean_up(&headers_list);
if (message_init_err_code) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: message init failed with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto args_allocated_before_failure;
}
aws_event_stream_rpc_client_connection_acquire(connection);
if (aws_event_stream_channel_handler_write_message(
connection->event_stream_handler, &args->message, s_on_protocol_message_written_fn, args)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: writing message failed with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
goto message_initialized_before_failure;
}
return AWS_OP_SUCCESS;
message_initialized_before_failure:
aws_event_stream_message_clean_up(&args->message);
args_allocated_before_failure:
aws_mem_release(args->allocator, args);
aws_event_stream_rpc_client_connection_release(connection);
return AWS_OP_ERR;
}
int aws_event_stream_rpc_client_connection_send_protocol_message(
struct aws_event_stream_rpc_client_connection *connection,
const struct aws_event_stream_rpc_message_args *message_args,
aws_event_stream_rpc_client_message_flush_fn *flush_fn,
void *user_data) {
if (!aws_event_stream_rpc_client_connection_is_open(connection)) {
return aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_CONNECTION_CLOSED);
}
return s_send_protocol_message(connection, NULL, NULL, message_args, 0, flush_fn, user_data);
}
static void s_connection_error_message_flush_fn(int error_code, void *user_data) {
(void)error_code;
struct aws_event_stream_rpc_client_connection *connection = user_data;
aws_event_stream_rpc_client_connection_close(connection, AWS_ERROR_EVENT_STREAM_RPC_PROTOCOL_ERROR);
}
static void s_send_connection_level_error(
struct aws_event_stream_rpc_client_connection *connection,
uint32_t message_type,
uint32_t message_flags,
const struct aws_byte_cursor *message) {
struct aws_byte_buf payload_buf = aws_byte_buf_from_array(message->ptr, message->len);
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: sending connection-level error\n" PRInSTR,
(void *)connection,
AWS_BYTE_BUF_PRI(payload_buf));
struct aws_event_stream_header_value_pair content_type_header =
aws_event_stream_create_string_header(s_json_content_type_name, s_json_content_type_value);
struct aws_event_stream_header_value_pair headers[] = {
content_type_header,
};
struct aws_event_stream_rpc_message_args message_args = {
.message_type = message_type,
.message_flags = message_flags,
.payload = &payload_buf,
.headers_count = 1,
.headers = headers,
};
aws_event_stream_rpc_client_connection_send_protocol_message(
connection, &message_args, s_connection_error_message_flush_fn, connection);
}
static void s_route_message_by_type(
struct aws_event_stream_rpc_client_connection *connection,
struct aws_event_stream_message *message,
struct aws_array_list *headers_list,
uint32_t stream_id,
uint32_t message_type,
uint32_t message_flags) {
struct aws_byte_buf payload_buf = aws_byte_buf_from_array(
aws_event_stream_message_payload(message), aws_event_stream_message_payload_len(message));
struct aws_event_stream_rpc_message_args message_args = {
.headers = headers_list->data,
.headers_count = aws_array_list_length(headers_list),
.payload = &payload_buf,
.message_flags = message_flags,
.message_type = message_type,
};
size_t handshake_complete = aws_atomic_load_int(&connection->handshake_state);
/* make sure if this is not a CONNECT message being received, the handshake has been completed. */
if (handshake_complete < CONNECTION_HANDSHAKE_STATE_CONNECT_ACK_PROCESSED &&
message_type != AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT_ACK) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: a message was received on this connection prior to the "
"connect handshake completing",
(void *)connection);
aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_PROTOCOL_ERROR);
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_connect_not_completed_error);
return;
}
/* stream_id being non zero ALWAYS indicates APPLICATION_DATA or APPLICATION_ERROR. */
if (stream_id > 0) {
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: stream id %" PRIu32, (void *)connection, stream_id);
struct aws_event_stream_rpc_client_continuation_token *continuation = NULL;
if (message_type > AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_APPLICATION_ERROR) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: only application messages can be sent on a stream id, "
"but this message is the incorrect type",
(void *)connection);
aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_PROTOCOL_ERROR);
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_invalid_stream_id_error);
return;
}
aws_mutex_lock(&connection->stream_lock);
struct aws_hash_element *continuation_element = NULL;
if (aws_hash_table_find(&connection->continuation_table, &stream_id, &continuation_element) ||
!continuation_element) {
bool old_stream_id = stream_id <= connection->latest_stream_id;
aws_mutex_unlock(&connection->stream_lock);
if (!old_stream_id) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: a stream id was received that was not created by this client",
(void *)connection);
aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_PROTOCOL_ERROR);
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_invalid_client_stream_id_error);
} else {
AWS_LOGF_WARN(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: a stream id was received that corresponds to an already-closed stream",
(void *)connection);
}
return;
}
continuation = continuation_element->value;
AWS_FATAL_ASSERT(continuation != NULL);
aws_event_stream_rpc_client_continuation_acquire(continuation);
aws_mutex_unlock(&connection->stream_lock);
continuation->continuation_fn(continuation, &message_args, continuation->user_data);
aws_event_stream_rpc_client_continuation_release(continuation);
/* if it was a terminal stream message purge it from the hash table. The delete will decref the continuation. */
if (message_flags & AWS_EVENT_STREAM_RPC_MESSAGE_FLAG_TERMINATE_STREAM) {
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: the terminate stream flag was specified for continuation %p",
(void *)connection,
(void *)continuation);
aws_atomic_store_int(&continuation->is_closed, 1U);
aws_mutex_lock(&connection->stream_lock);
aws_hash_table_remove(&connection->continuation_table, &stream_id, NULL, NULL);
aws_mutex_unlock(&connection->stream_lock);
/* Note that we do not invoke callback while holding lock */
s_complete_continuation(continuation);
}
} else {
if (message_type <= AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_APPLICATION_ERROR ||
message_type >= AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_COUNT) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: a zero stream id was received with an invalid message-type %" PRIu32,
(void *)connection,
message_type);
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_invalid_message_type_error);
return;
}
if (message_type == AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_CONNECT_ACK) {
if (handshake_complete != CONNECTION_HANDSHAKE_STATE_CONNECT_PROCESSED) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connect ack received but the handshake is already completed. Only one is allowed.",
(void *)connection);
/* only one connect is allowed. This would be a duplicate. */
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_connect_not_completed_error);
return;
}
aws_atomic_store_int(&connection->handshake_state, CONNECTION_HANDSHAKE_STATE_CONNECT_ACK_PROCESSED);
AWS_LOGF_INFO(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: connect ack received, connection handshake completed",
(void *)connection);
}
connection->on_connection_protocol_message(connection, &message_args, connection->user_data);
}
}
/* invoked by the event stream channel handler when a complete message has been read from the channel. */
static void s_on_message_received(struct aws_event_stream_message *message, int error_code, void *user_data) {
if (!error_code) {
struct aws_event_stream_rpc_client_connection *connection = user_data;
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: message received on connection of length %" PRIu32,
(void *)connection,
aws_event_stream_message_total_length(message));
struct aws_array_list headers;
if (aws_array_list_init_dynamic(
&headers, connection->allocator, 8, sizeof(struct aws_event_stream_header_value_pair))) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: error initializing headers %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_INTERNAL_ERROR, 0, &s_internal_error);
return;
}
if (aws_event_stream_message_headers(message, &headers)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: error fetching headers %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_INTERNAL_ERROR, 0, &s_internal_error);
goto clean_up;
}
int32_t stream_id = -1;
int32_t message_type = -1;
int32_t message_flags = -1;
struct aws_byte_buf operation_name_buf;
AWS_ZERO_STRUCT(operation_name_buf);
if (aws_event_stream_rpc_extract_message_metadata(
&headers, &stream_id, &message_type, &message_flags, &operation_name_buf)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: invalid protocol message with error %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
s_send_connection_level_error(
connection, AWS_EVENT_STREAM_RPC_MESSAGE_TYPE_PROTOCOL_ERROR, 0, &s_invalid_message_error);
goto clean_up;
}
(void)operation_name_buf;
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: routing message", (void *)connection);
s_route_message_by_type(connection, message, &headers, stream_id, message_type, message_flags);
clean_up:
aws_event_stream_headers_list_cleanup(&headers);
}
}
struct aws_event_stream_rpc_client_continuation_token *aws_event_stream_rpc_client_connection_new_stream(
struct aws_event_stream_rpc_client_connection *connection,
const struct aws_event_stream_rpc_client_stream_continuation_options *continuation_options) {
AWS_PRECONDITION(continuation_options->on_continuation_closed);
AWS_PRECONDITION(continuation_options->on_continuation);
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: creating a new stream on connection", (void *)connection);
struct aws_event_stream_rpc_client_continuation_token *continuation =
aws_mem_calloc(connection->allocator, 1, sizeof(struct aws_event_stream_rpc_client_continuation_token));
if (!continuation) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: error while allocating continuation %s",
(void *)connection,
aws_error_debug_str(aws_last_error()));
return NULL;
}
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: continuation created %p", (void *)connection, (void *)continuation);
continuation->connection = connection;
aws_event_stream_rpc_client_connection_acquire(continuation->connection);
aws_atomic_init_int(&continuation->ref_count, 1);
aws_atomic_init_int(&continuation->is_closed, 0);
aws_atomic_init_int(&continuation->is_complete, 0);
continuation->continuation_fn = continuation_options->on_continuation;
continuation->closed_fn = continuation_options->on_continuation_closed;
continuation->user_data = continuation_options->user_data;
return continuation;
}
void *aws_event_stream_rpc_client_continuation_get_user_data(
struct aws_event_stream_rpc_client_continuation_token *continuation) {
return continuation->user_data;
}
void aws_event_stream_rpc_client_continuation_acquire(
const struct aws_event_stream_rpc_client_continuation_token *continuation) {
size_t current_count = aws_atomic_fetch_add_explicit(
&((struct aws_event_stream_rpc_client_continuation_token *)continuation)->ref_count,
1u,
aws_memory_order_relaxed);
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: continuation acquired, new ref count is %zu.",
(void *)continuation,
current_count + 1);
}
void aws_event_stream_rpc_client_continuation_release(
const struct aws_event_stream_rpc_client_continuation_token *continuation) {
if (AWS_UNLIKELY(!continuation)) {
return;
}
struct aws_event_stream_rpc_client_continuation_token *continuation_mut =
(struct aws_event_stream_rpc_client_continuation_token *)continuation;
size_t ref_count = aws_atomic_fetch_sub_explicit(&continuation_mut->ref_count, 1, aws_memory_order_seq_cst);
AWS_LOGF_TRACE(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: continuation released, new ref count is %zu.",
(void *)continuation,
ref_count - 1);
AWS_FATAL_ASSERT(ref_count != 0 && "Continuation ref count has gone negative");
if (ref_count == 1) {
struct aws_allocator *allocator = continuation_mut->connection->allocator;
aws_event_stream_rpc_client_connection_release(continuation_mut->connection);
aws_mem_release(allocator, continuation_mut);
}
}
bool aws_event_stream_rpc_client_continuation_is_closed(
const struct aws_event_stream_rpc_client_continuation_token *continuation) {
return aws_atomic_load_int(&continuation->is_closed) == 1u;
}
int aws_event_stream_rpc_client_continuation_activate(
struct aws_event_stream_rpc_client_continuation_token *continuation,
struct aws_byte_cursor operation_name,
const struct aws_event_stream_rpc_message_args *message_args,
aws_event_stream_rpc_client_message_flush_fn *flush_fn,
void *user_data) {
AWS_LOGF_TRACE(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: activating continuation", (void *)continuation);
int ret_val = AWS_OP_ERR;
aws_mutex_lock(&continuation->connection->stream_lock);
if (continuation->stream_id) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: stream has already been activated", (void *)continuation);
aws_raise_error(AWS_ERROR_INVALID_STATE);
goto clean_up;
}
/* Even though is_open is atomic, we need to hold a lock while checking it.
* This lets us coordinate with code that sets is_open to false. */
if (!aws_event_stream_rpc_client_connection_is_open(continuation->connection)) {
AWS_LOGF_ERROR(AWS_LS_EVENT_STREAM_RPC_CLIENT, "id=%p: stream's connection is not open", (void *)continuation);
aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_CONNECTION_CLOSED);
goto clean_up;
}
/* we cannot update the connection's stream id until we're certain the message at least made it to the wire, because
* the next stream id must be consecutively increasing by 1. So send the message then update the connection state
* once we've made it to the wire. */
continuation->stream_id = continuation->connection->latest_stream_id + 1;
AWS_LOGF_DEBUG(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: continuation's new stream id is %" PRIu32,
(void *)continuation,
continuation->stream_id);
if (aws_hash_table_put(
&continuation->connection->continuation_table, &continuation->stream_id, continuation, NULL)) {
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: storing the new stream failed with %s",
(void *)continuation,
aws_error_debug_str(aws_last_error()));
continuation->stream_id = 0;
goto clean_up;
}
if (s_send_protocol_message(
continuation->connection,
continuation,
&operation_name,
message_args,
continuation->stream_id,
flush_fn,
user_data)) {
aws_hash_table_remove(&continuation->connection->continuation_table, &continuation->stream_id, NULL, NULL);
continuation->stream_id = 0;
AWS_LOGF_ERROR(
AWS_LS_EVENT_STREAM_RPC_CLIENT,
"id=%p: failed to flush the new stream to the channel with error %s",
(void *)continuation,
aws_error_debug_str(aws_last_error()));
goto clean_up;
}
/* The continuation table gets a ref count on the continuation. Take it here. */
aws_event_stream_rpc_client_continuation_acquire(continuation);
continuation->connection->latest_stream_id = continuation->stream_id;
ret_val = AWS_OP_SUCCESS;
clean_up:
aws_mutex_unlock(&continuation->connection->stream_lock);
return ret_val;
}
int aws_event_stream_rpc_client_continuation_send_message(
struct aws_event_stream_rpc_client_continuation_token *continuation,
const struct aws_event_stream_rpc_message_args *message_args,
aws_event_stream_rpc_client_message_flush_fn *flush_fn,
void *user_data) {
if (aws_event_stream_rpc_client_continuation_is_closed(continuation)) {
return aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_STREAM_CLOSED);
}
if (!continuation->stream_id) {
return aws_raise_error(AWS_ERROR_EVENT_STREAM_RPC_STREAM_NOT_ACTIVATED);
}
return s_send_protocol_message(
continuation->connection, continuation, NULL, message_args, continuation->stream_id, flush_fn, user_data);
}
|