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
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include "aws/s3/private/s3_auto_ranged_get.h"
#include "aws/s3/private/s3_client_impl.h"
#include "aws/s3/private/s3_meta_request_impl.h"
#include "aws/s3/private/s3_request_messages.h"
#include "aws/s3/private/s3_util.h"
#include <aws/common/string.h>
#include <inttypes.h>
const uint32_t s_conservative_max_requests_in_flight = 8;
const struct aws_byte_cursor g_application_xml_value = AWS_BYTE_CUR_INIT_FROM_STRING_LITERAL("application/xml");
static void s_s3_meta_request_auto_ranged_get_destroy(struct aws_s3_meta_request *meta_request);
static bool s_s3_auto_ranged_get_update(
struct aws_s3_meta_request *meta_request,
uint32_t flags,
struct aws_s3_request **out_request);
static struct aws_future_void *s_s3_auto_ranged_get_prepare_request(struct aws_s3_request *request);
static void s_s3_auto_ranged_get_request_finished(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
int error_code);
static struct aws_s3_meta_request_vtable s_s3_auto_ranged_get_vtable = {
.update = s_s3_auto_ranged_get_update,
.send_request_finish = aws_s3_meta_request_send_request_finish_default,
.prepare_request = s_s3_auto_ranged_get_prepare_request,
.init_signing_date_time = aws_s3_meta_request_init_signing_date_time_default,
.sign_request = aws_s3_meta_request_sign_request_default,
.finished_request = s_s3_auto_ranged_get_request_finished,
.destroy = s_s3_meta_request_auto_ranged_get_destroy,
.finish = aws_s3_meta_request_finish_default,
};
static int s_s3_auto_ranged_get_success_status(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
AWS_PRECONDITION(auto_ranged_get);
if (auto_ranged_get->initial_message_has_range_header) {
return AWS_HTTP_STATUS_CODE_206_PARTIAL_CONTENT;
}
return AWS_HTTP_STATUS_CODE_200_OK;
}
/* Allocate a new auto-ranged-get meta request. */
struct aws_s3_meta_request *aws_s3_meta_request_auto_ranged_get_new(
struct aws_allocator *allocator,
struct aws_s3_client *client,
size_t part_size,
const struct aws_s3_meta_request_options *options) {
AWS_PRECONDITION(allocator);
AWS_PRECONDITION(client);
AWS_PRECONDITION(options);
AWS_PRECONDITION(options->message);
struct aws_s3_auto_ranged_get *auto_ranged_get =
aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_auto_ranged_get));
/* Try to initialize the base type. */
if (aws_s3_meta_request_init_base(
allocator,
client,
part_size,
false,
options,
auto_ranged_get,
&s_s3_auto_ranged_get_vtable,
&auto_ranged_get->base)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not initialize base type for Auto-Ranged-Get Meta Request.",
(void *)auto_ranged_get);
aws_mem_release(allocator, auto_ranged_get);
return NULL;
}
struct aws_http_headers *headers = aws_http_message_get_headers(auto_ranged_get->base.initial_request_message);
AWS_ASSERT(headers != NULL);
if (aws_http_headers_has(headers, g_range_header_name)) {
auto_ranged_get->initial_message_has_range_header = true;
if (aws_s3_parse_request_range_header(
headers,
&auto_ranged_get->initial_message_has_start_range,
&auto_ranged_get->initial_message_has_end_range,
&auto_ranged_get->initial_range_start,
&auto_ranged_get->initial_range_end)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not parse Range header for Auto-Ranged-Get Meta Request.",
(void *)auto_ranged_get);
goto on_error;
}
}
auto_ranged_get->initial_message_has_if_match_header = aws_http_headers_has(headers, g_if_match_header_name);
auto_ranged_get->synced_data.first_part_size = auto_ranged_get->base.part_size;
if (options->object_size_hint != NULL) {
auto_ranged_get->object_size_hint_available = true;
auto_ranged_get->object_size_hint = *options->object_size_hint;
}
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST, "id=%p Created new Auto-Ranged Get Meta Request.", (void *)&auto_ranged_get->base);
return &auto_ranged_get->base;
on_error:
/* This will also clean up the auto_ranged_get */
aws_s3_meta_request_release(&(auto_ranged_get->base));
return NULL;
}
static void s_s3_meta_request_auto_ranged_get_destroy(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->impl);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
aws_string_destroy(auto_ranged_get->etag);
aws_mem_release(meta_request->allocator, auto_ranged_get);
}
/*
* This function returns the type of first request which we will also use to discover overall object size.
*/
static enum aws_s3_auto_ranged_get_request_type s_s3_get_request_type_for_discovering_object_size(
const struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
AWS_ASSERT(auto_ranged_get);
/*
* When we attempt to download an empty file using the `AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE`
* request type, the request fails with an empty file error. We then reset `object_range_known`
* (`object_range_empty` is set to true) and try to download the file again with
* `AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1`. We send another request, even though there is
* no body, to provide successful response headers to the user. If the file is still empty, successful response
* headers will be provided to the users. Otherwise, the newer version of the file will be downloaded.
*/
if (auto_ranged_get->synced_data.object_range_empty != 0) {
auto_ranged_get->synced_data.object_range_empty = 0;
return AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1;
}
/*
* If a range header exists but has no start-range (i.e. Range: bytes=-100), we perform a HeadRequest. If the
* start-range is unknown, we could potentially execute a request from the end-range and keep that request around
* until the meta request finishes. However, this approach involves the complexity of managing backpressure. For
* simplicity, we execute a HeadRequest if the start-range is not specified.
*/
if (auto_ranged_get->initial_message_has_range_header != 0) {
return auto_ranged_get->initial_message_has_start_range
? AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE
: AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT;
}
/* If we don't need checksum validation, then discover the size of the object while trying to get the first part. */
if (!meta_request->checksum_config.validate_response_checksum) {
return AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE;
}
/* If the object_size_hint indicates that it is a small one part file, then try to get the file directly
* TODO: Bypass memory limiter so that we don't overallocate memory for small files
*/
if (auto_ranged_get->object_size_hint_available && auto_ranged_get->object_size_hint <= meta_request->part_size) {
return AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1;
}
/* Otherwise, do a headObject so that we can validate checksum if the file was uploaded as a single part */
return AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT;
}
static bool s_s3_auto_ranged_get_update(
struct aws_s3_meta_request *meta_request,
uint32_t flags,
struct aws_s3_request **out_request) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(out_request);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
struct aws_s3_request *request = NULL;
bool work_remaining = false;
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
/* If nothing has set the "finish result" then this meta request is still in progress, and we can potentially
* send additional requests. */
if (!aws_s3_meta_request_has_finish_result_synced(meta_request)) {
if ((flags & AWS_S3_META_REQUEST_UPDATE_FLAG_CONSERVATIVE) != 0) {
uint32_t num_requests_in_flight =
(auto_ranged_get->synced_data.num_parts_requested -
auto_ranged_get->synced_data.num_parts_completed) +
(uint32_t)aws_priority_queue_size(&meta_request->synced_data.pending_body_streaming_requests);
/* auto-ranged-gets make use of body streaming, which will hold onto response bodies if parts earlier in
* the file haven't arrived yet. This can potentially create a lot of backed up requests, causing us to
* hit our global request limit. To help mitigate this, when the "conservative" flag is passed in, we
* only allow the total amount of requests being sent/streamed to be inside a set limit. */
if (num_requests_in_flight > s_conservative_max_requests_in_flight) {
goto has_work_remaining;
}
}
/* If the overall range of the object that we are trying to retrieve isn't known yet, then we need to send a
* request to figure that out. */
if (!auto_ranged_get->synced_data.object_range_known) {
if (auto_ranged_get->synced_data.head_object_sent ||
auto_ranged_get->synced_data.num_parts_requested > 0) {
goto has_work_remaining;
}
struct aws_s3_buffer_pool_ticket *ticket = NULL;
switch (s_s3_get_request_type_for_discovering_object_size(meta_request)) {
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT:
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p: Doing a HeadObject to discover the size of the object",
(void *)meta_request);
request = aws_s3_request_new(
meta_request,
AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT,
AWS_S3_REQUEST_TYPE_HEAD_OBJECT,
0 /*part_number*/,
AWS_S3_REQUEST_FLAG_RECORD_RESPONSE_HEADERS);
auto_ranged_get->synced_data.head_object_sent = true;
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1:
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p: Doing a 'GET_OBJECT_WITH_PART_NUMBER_1' to discover the size of the object and get "
"the first part",
(void *)meta_request);
ticket = aws_s3_buffer_pool_reserve(meta_request->client->buffer_pool, meta_request->part_size);
if (ticket == NULL) {
goto has_work_remaining;
}
request = aws_s3_request_new(
meta_request,
AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1,
AWS_S3_REQUEST_TYPE_GET_OBJECT,
1 /*part_number*/,
AWS_S3_REQUEST_FLAG_RECORD_RESPONSE_HEADERS | AWS_S3_REQUEST_FLAG_PART_SIZE_RESPONSE_BODY);
request->ticket = ticket;
++auto_ranged_get->synced_data.num_parts_requested;
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE:
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p: Doing a 'GET_OBJECT_WITH_RANGE' to discover the size of the object and get the "
"first part",
(void *)meta_request);
uint64_t part_range_start = 0;
uint64_t first_part_size = meta_request->part_size;
if (auto_ranged_get->initial_message_has_range_header) {
/*
* Currently, we only discover the size of the object when the initial range header includes
* a start-range. If we ever implement skipping the HeadRequest for a Range request without
* a start-range, this will need to update.
*/
AWS_ASSERT(auto_ranged_get->initial_message_has_start_range);
part_range_start = auto_ranged_get->initial_range_start;
if (auto_ranged_get->initial_message_has_end_range) {
first_part_size = aws_min_u64(
first_part_size,
auto_ranged_get->initial_range_end - auto_ranged_get->initial_range_start + 1);
}
auto_ranged_get->synced_data.first_part_size = first_part_size;
}
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p: Doing a ranged get to discover the size of the object and get the first part",
(void *)meta_request);
ticket = aws_s3_buffer_pool_reserve(meta_request->client->buffer_pool, (size_t)first_part_size);
if (ticket == NULL) {
goto has_work_remaining;
}
request = aws_s3_request_new(
meta_request,
AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE,
AWS_S3_REQUEST_TYPE_GET_OBJECT,
1 /*part_number*/,
AWS_S3_REQUEST_FLAG_RECORD_RESPONSE_HEADERS | AWS_S3_REQUEST_FLAG_PART_SIZE_RESPONSE_BODY);
request->ticket = ticket;
request->part_range_start = part_range_start;
request->part_range_end = part_range_start + first_part_size - 1; /* range-end is inclusive */
++auto_ranged_get->synced_data.num_parts_requested;
break;
default:
AWS_FATAL_ASSERT(
0 && "s_s3_get_request_type_for_discovering_object_size returned unexpected discover "
"object size request type");
}
request->discovers_object_size = true;
goto has_work_remaining;
}
/* If there are still more parts to be requested */
if (auto_ranged_get->synced_data.num_parts_requested < auto_ranged_get->synced_data.total_num_parts) {
if (meta_request->client->enable_read_backpressure) {
/* Don't start a part until we have enough window to send bytes to the user.
*
* Note that we start a part once we have enough window to deliver ANY of its bytes.
* If we waited until the window was large enough for the WHOLE part,
* we could end up stuck in a situation where the user is
* waiting for more bytes before they'll open the window,
* and this implementation is waiting for more window before it will send more parts. */
uint64_t read_data_requested =
auto_ranged_get->synced_data.num_parts_requested * meta_request->part_size;
if (read_data_requested >= meta_request->synced_data.read_window_running_total) {
/* Avoid spamming users with this DEBUG message */
if (auto_ranged_get->synced_data.read_window_warning_issued == 0) {
auto_ranged_get->synced_data.read_window_warning_issued = 1;
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Download paused because read window is zero. "
"You must increment to window to continue.",
(void *)meta_request);
}
goto has_work_remaining;
}
auto_ranged_get->synced_data.read_window_warning_issued = 0;
}
struct aws_s3_buffer_pool_ticket *ticket =
aws_s3_buffer_pool_reserve(meta_request->client->buffer_pool, meta_request->part_size);
if (ticket == NULL) {
goto has_work_remaining;
}
request = aws_s3_request_new(
meta_request,
AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE,
AWS_S3_REQUEST_TYPE_GET_OBJECT,
auto_ranged_get->synced_data.num_parts_requested + 1 /*part_number*/,
AWS_S3_REQUEST_FLAG_PART_SIZE_RESPONSE_BODY);
request->ticket = ticket;
aws_s3_calculate_auto_ranged_get_part_range(
auto_ranged_get->synced_data.object_range_start,
auto_ranged_get->synced_data.object_range_end,
meta_request->part_size,
auto_ranged_get->synced_data.first_part_size,
request->part_number,
&request->part_range_start,
&request->part_range_end);
++auto_ranged_get->synced_data.num_parts_requested;
goto has_work_remaining;
}
/* If there are parts that have not attempted delivery to the caller, then there is still work being done.
*/
if (meta_request->synced_data.num_parts_delivery_completed < auto_ranged_get->synced_data.total_num_parts) {
goto has_work_remaining;
}
} else {
/* Else, if there is a finish result set, make sure that all work-in-progress winds down before the meta
* request completely exits. */
if (auto_ranged_get->synced_data.head_object_sent && !auto_ranged_get->synced_data.head_object_completed) {
goto has_work_remaining;
}
/* Wait for all requests to complete (successfully or unsuccessfully) before finishing.*/
if (auto_ranged_get->synced_data.num_parts_completed < auto_ranged_get->synced_data.num_parts_requested) {
goto has_work_remaining;
}
/* If some parts are still being delivered to the caller, then wait for those to finish. */
if (meta_request->synced_data.num_parts_delivery_completed <
meta_request->synced_data.num_parts_delivery_sent) {
goto has_work_remaining;
}
}
goto no_work_remaining;
has_work_remaining:
work_remaining = true;
if (request != NULL) {
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Returning request %p for part %d of %d",
(void *)meta_request,
(void *)request,
request->part_number,
auto_ranged_get->synced_data.total_num_parts);
}
no_work_remaining:
/* If some events are still being delivered to caller, then wait for those to finish */
if (!work_remaining && aws_s3_meta_request_are_events_out_for_delivery_synced(meta_request)) {
work_remaining = true;
}
if (!work_remaining) {
aws_s3_meta_request_set_success_synced(meta_request, s_s3_auto_ranged_get_success_status(meta_request));
if (auto_ranged_get->synced_data.num_parts_checksum_validated ==
auto_ranged_get->synced_data.num_parts_requested) {
/* If we have validated the checksum for every part, we set the meta request level checksum validation
* result.*/
meta_request->synced_data.finish_result.did_validate = true;
meta_request->synced_data.finish_result.validation_algorithm = auto_ranged_get->validation_algorithm;
}
}
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
if (work_remaining) {
*out_request = request;
} else {
AWS_ASSERT(request == NULL);
aws_s3_meta_request_finish(meta_request);
}
return work_remaining;
}
/* Given a request, prepare it for sending based on its description.
* Currently, this is actually synchronous. */
static struct aws_future_void *s_s3_auto_ranged_get_prepare_request(struct aws_s3_request *request) {
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
/* Generate a new ranged get request based on the original message. */
struct aws_http_message *message = NULL;
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
bool success = false;
switch (request->request_tag) {
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT:
/* A head object will be a copy of the original headers but with a HEAD request method. */
message = aws_s3_message_util_copy_http_message_no_body_all_headers(
meta_request->allocator, meta_request->initial_request_message);
if (message) {
aws_http_message_set_request_method(message, g_head_method);
}
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE:
message = aws_s3_ranged_get_object_message_new(
meta_request->allocator,
meta_request->initial_request_message,
request->part_range_start,
request->part_range_end);
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1:
message = aws_s3_message_util_copy_http_message_no_body_all_headers(
meta_request->allocator, meta_request->initial_request_message);
if (message) {
aws_s3_message_util_set_multipart_request_path(
meta_request->allocator, NULL, request->part_number, false, message);
}
break;
}
if (message == NULL) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not create message for request with tag %d for auto-ranged-get meta request.",
(void *)meta_request,
request->request_tag);
goto finish;
}
if (meta_request->checksum_config.validate_response_checksum) {
aws_http_headers_set(aws_http_message_get_headers(message), g_request_validation_mode, g_enabled);
}
if (!auto_ranged_get->initial_message_has_if_match_header && auto_ranged_get->etag) {
/* Add the if_match to the request */
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Added the If-Match header to request %p for part %d",
(void *)meta_request,
(void *)request,
request->part_number);
aws_http_headers_set(
aws_http_message_get_headers(message),
g_if_match_header_name,
aws_byte_cursor_from_string(auto_ranged_get->etag));
}
aws_s3_request_setup_send_data(request, message);
aws_http_message_release(message);
/* Success! */
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Created request %p for part %d part sized %d",
(void *)meta_request,
(void *)request,
request->part_number,
request->has_part_size_response_body);
success = true;
finish:;
struct aws_future_void *future = aws_future_void_new(meta_request->allocator);
if (success) {
aws_future_void_set_result(future);
} else {
aws_future_void_set_error(future, aws_last_error_or_unknown());
}
return future;
}
/* Check the finish result of meta request.
* Return true if the request failed because it downloaded an empty file.
* Return false if the request failed for any other reason */
static bool s_check_empty_file_download_error(struct aws_s3_request *failed_request) {
struct aws_http_headers *failed_headers = failed_request->send_data.response_headers;
struct aws_byte_buf failed_body = failed_request->send_data.response_body;
if (failed_headers && failed_body.capacity > 0) {
struct aws_byte_cursor content_type;
AWS_ZERO_STRUCT(content_type);
if (!aws_http_headers_get(failed_headers, g_content_type_header_name, &content_type)) {
/* Content type found */
if (aws_byte_cursor_eq_ignore_case(&content_type, &g_application_xml_value)) {
/* XML response */
struct aws_byte_cursor xml_doc = aws_byte_cursor_from_buf(&failed_body);
const char *path_to_size[] = {"Error", "ActualObjectSize", NULL};
struct aws_byte_cursor size = {0};
aws_xml_get_body_at_path(failed_request->allocator, xml_doc, path_to_size, &size);
if (aws_byte_cursor_eq_c_str(&size, "0")) {
return true;
}
}
}
}
return false;
}
static int s_discover_object_range_and_size(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
int error_code,
uint64_t *out_object_range_start,
uint64_t *out_object_range_end,
uint64_t *out_object_size,
uint64_t *out_first_part_size,
bool *out_empty_file_error) {
AWS_PRECONDITION(out_object_size);
AWS_PRECONDITION(out_object_range_start);
AWS_PRECONDITION(out_object_range_end);
AWS_PRECONDITION(out_first_part_size);
int result = AWS_OP_ERR;
uint64_t content_length = 0;
uint64_t object_size = 0;
uint64_t object_range_start = 0;
uint64_t object_range_end = 0;
uint64_t first_part_size = 0;
AWS_ASSERT(request->discovers_object_size);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
switch (request->request_tag) {
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT:
if (error_code != AWS_ERROR_SUCCESS) {
/* If the head request failed, there's nothing we can do, so resurface the error code. */
aws_raise_error(error_code);
break;
}
/* There should be a Content-Length header that indicates the total size of the range.*/
if (aws_s3_parse_content_length_response_header(
meta_request->allocator, request->send_data.response_headers, &content_length)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not find content-length header for request %p",
(void *)meta_request,
(void *)request);
break;
}
/* if the inital message had a ranged header, there should also be a Content-Range header that specifies the
* object range and total object size. Otherwise, the size and range should be equal to the
* total_content_length. */
if (!auto_ranged_get->initial_message_has_range_header) {
object_size = content_length;
if (content_length > 0) {
object_range_end = content_length - 1; /* range-end is inclusive */
}
} else if (aws_s3_parse_content_range_response_header(
meta_request->allocator,
request->send_data.response_headers,
&object_range_start,
&object_range_end,
&object_size)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not find content-range header for request %p",
(void *)meta_request,
(void *)request);
break;
}
result = AWS_OP_SUCCESS;
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1:
AWS_ASSERT(request->part_number == 1);
AWS_ASSERT(request->send_data.response_headers != NULL);
/* There should be a Content-Length header that indicates the size of first part. */
if (aws_s3_parse_content_length_response_header(
meta_request->allocator, request->send_data.response_headers, &content_length)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not find content-length header for request %p",
(void *)meta_request,
(void *)request);
break;
}
first_part_size = content_length;
if (first_part_size > 0) {
/* Parse the object size from the part response. */
if (aws_s3_parse_content_range_response_header(
meta_request->allocator, request->send_data.response_headers, NULL, NULL, &object_size)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not find content-range header for request %p",
(void *)meta_request,
(void *)request);
break;
}
/* When discovering the object size via GET_OBJECT_WITH_PART_NUMBER_1, the object range is the entire
* object. */
object_range_start = 0;
object_range_end = object_size - 1; /* range-end is inclusive */
}
result = AWS_OP_SUCCESS;
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE:
AWS_ASSERT(request->part_number == 1);
if (error_code != AWS_ERROR_SUCCESS) {
/* If we hit an empty file while trying to discover the object-size via part, then this request
failure
* is as designed. */
if (!auto_ranged_get->initial_message_has_range_header && s_check_empty_file_download_error(request)) {
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p Detected empty file with request %p. Sending new request without range header.",
(void *)meta_request,
(void *)request);
object_size = 0ULL;
*out_empty_file_error = true;
result = AWS_OP_SUCCESS;
} else {
/* Otherwise, resurface the error code. */
aws_raise_error(error_code);
}
break;
}
AWS_ASSERT(request->send_data.response_headers != NULL);
/* Parse the object size from the part response. */
if (aws_s3_parse_content_range_response_header(
meta_request->allocator,
request->send_data.response_headers,
&object_range_start,
&object_range_end,
&object_size)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not find content-range header for request %p",
(void *)meta_request,
(void *)request);
break;
}
if (auto_ranged_get->initial_message_has_range_header) {
if (auto_ranged_get->initial_message_has_end_range) {
object_range_end = aws_min_u64(object_size - 1, auto_ranged_get->initial_range_end);
} else {
object_range_end = object_size - 1;
}
} else {
/* When discovering the object size via GET_OBJECT_WITH_RANGE, the object range is the entire object. */
object_range_start = 0;
object_range_end = object_size - 1; /* range-end is inclusive */
}
result = AWS_OP_SUCCESS;
break;
default:
AWS_ASSERT(false);
break;
}
if (result == AWS_OP_SUCCESS) {
*out_object_size = object_size;
*out_object_range_start = object_range_start;
*out_object_range_end = object_range_end;
*out_first_part_size = first_part_size;
}
return result;
}
static void s_s3_auto_ranged_get_request_finished(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
int error_code) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->impl);
AWS_PRECONDITION(request);
struct aws_s3_auto_ranged_get *auto_ranged_get = meta_request->impl;
AWS_PRECONDITION(auto_ranged_get);
uint64_t object_range_start = 0ULL;
uint64_t object_range_end = 0ULL;
uint64_t object_size = 0ULL;
uint64_t first_part_size = 0ULL;
bool found_object_size = false;
bool request_failed = error_code != AWS_ERROR_SUCCESS;
bool first_part_size_mismatch = (error_code == AWS_ERROR_S3_INTERNAL_PART_SIZE_MISMATCH_RETRYING_WITH_RANGE);
bool empty_file_error = false;
if (request->discovers_object_size) {
/* Try to discover the object-range and object-size.*/
if (s_discover_object_range_and_size(
meta_request,
request,
error_code,
&object_range_start,
&object_range_end,
&object_size,
&first_part_size,
&empty_file_error)) {
error_code = aws_last_error_or_unknown();
goto update_synced_data;
}
if ((!request_failed || first_part_size_mismatch) && !auto_ranged_get->initial_message_has_if_match_header) {
AWS_ASSERT(auto_ranged_get->etag == NULL);
struct aws_byte_cursor etag_header_value;
if (aws_http_headers_get(request->send_data.response_headers, g_etag_header_name, &etag_header_value)) {
aws_raise_error(AWS_ERROR_S3_MISSING_ETAG);
error_code = AWS_ERROR_S3_MISSING_ETAG;
goto update_synced_data;
}
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST,
"id=%p Etag received for the meta request. value is: " PRInSTR "",
(void *)meta_request,
AWS_BYTE_CURSOR_PRI(etag_header_value));
auto_ranged_get->etag = aws_string_new_from_cursor(auto_ranged_get->base.allocator, &etag_header_value);
}
/* If we were able to discover the object-range/content length successfully, then any error code that was passed
* into this function is being handled and does not indicate an overall failure.*/
error_code = AWS_ERROR_SUCCESS;
found_object_size = true;
if (!empty_file_error && meta_request->headers_callback != NULL) {
struct aws_http_headers *response_headers = aws_http_headers_new(meta_request->allocator);
copy_http_headers(request->send_data.response_headers, response_headers);
if (request->request_tag == AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE ||
request->request_tag == AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1) {
if (auto_ranged_get->initial_message_has_range_header) {
/* Populate the header with object_range */
char content_range_buffer[64] = "";
snprintf(
content_range_buffer,
sizeof(content_range_buffer),
"bytes %" PRIu64 "-%" PRIu64 "/%" PRIu64,
object_range_start,
object_range_end,
object_size);
aws_http_headers_set(
response_headers,
g_content_range_header_name,
aws_byte_cursor_from_c_str(content_range_buffer));
} else {
/* content range isn't applicable. */
aws_http_headers_erase(response_headers, g_content_range_header_name);
}
}
uint64_t content_length = object_size ? object_range_end - object_range_start + 1 : 0;
char content_length_buffer[64] = "";
snprintf(content_length_buffer, sizeof(content_length_buffer), "%" PRIu64, content_length);
aws_http_headers_set(
response_headers, g_content_length_header_name, aws_byte_cursor_from_c_str(content_length_buffer));
if (meta_request->headers_callback(
meta_request,
response_headers,
s_s3_auto_ranged_get_success_status(meta_request),
meta_request->user_data)) {
error_code = aws_last_error_or_unknown();
}
meta_request->headers_callback = NULL;
aws_http_headers_release(response_headers);
}
}
update_synced_data:
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
bool finishing_metrics = true;
/* If the object range was found, then record it. */
if (found_object_size) {
AWS_ASSERT(!auto_ranged_get->synced_data.object_range_known);
auto_ranged_get->synced_data.object_range_known = true;
auto_ranged_get->synced_data.object_range_empty = (object_size == 0);
auto_ranged_get->synced_data.object_range_start = object_range_start;
auto_ranged_get->synced_data.object_range_end = object_range_end;
if (!first_part_size_mismatch && first_part_size) {
auto_ranged_get->synced_data.first_part_size = first_part_size;
}
if (auto_ranged_get->synced_data.object_range_empty == 0) {
auto_ranged_get->synced_data.total_num_parts = aws_s3_calculate_auto_ranged_get_num_parts(
meta_request->part_size,
auto_ranged_get->synced_data.first_part_size,
object_range_start,
object_range_end);
}
}
switch (request->request_tag) {
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_HEAD_OBJECT:
auto_ranged_get->synced_data.head_object_completed = true;
AWS_LOGF_DEBUG(AWS_LS_S3_META_REQUEST, "id=%p Head object completed.", (void *)meta_request);
break;
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1:
AWS_LOGF_DEBUG(AWS_LS_S3_META_REQUEST, "id=%p Get Part Number completed.", (void *)meta_request);
if (first_part_size_mismatch && found_object_size) {
/* We canceled GET_OBJECT_WITH_PART_NUMBER_1 request because the Content-Length was bigger than
* part_size. Try to fetch the first part again as a ranged get */
auto_ranged_get->synced_data.num_parts_requested = 0;
break;
}
/* fall through */
case AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_RANGE:
if (empty_file_error) {
/*
* Try to download the object again using GET_OBJECT_WITH_PART_NUMBER_1. If the file is still
* empty, successful response headers will be provided to users. If not, the newer version of the
* file will be downloaded.
*/
auto_ranged_get->synced_data.num_parts_requested = 0;
auto_ranged_get->synced_data.object_range_known = 0;
break;
}
++auto_ranged_get->synced_data.num_parts_completed;
if (!request_failed) {
/* Record the number of parts that checksum has been validated */
if (request->did_validate) {
if (auto_ranged_get->validation_algorithm == AWS_SCA_NONE) {
auto_ranged_get->validation_algorithm = request->validation_algorithm;
}
/* They should be the same. */
AWS_ASSERT(auto_ranged_get->validation_algorithm == request->validation_algorithm);
++auto_ranged_get->synced_data.num_parts_checksum_validated;
}
++auto_ranged_get->synced_data.num_parts_successful;
/* Send progress_callback for delivery on io_event_loop thread */
if (meta_request->progress_callback != NULL) {
struct aws_s3_meta_request_event event = {.type = AWS_S3_META_REQUEST_EVENT_PROGRESS};
event.u.progress.info.bytes_transferred = request->send_data.response_body.len;
if (auto_ranged_get->synced_data.object_range_empty) {
event.u.progress.info.content_length = 0;
} else {
/* Note that range-end is inclusive */
event.u.progress.info.content_length = auto_ranged_get->synced_data.object_range_end + 1 -
auto_ranged_get->synced_data.object_range_start;
}
aws_s3_meta_request_add_event_for_delivery_synced(meta_request, &event);
}
aws_s3_meta_request_stream_response_body_synced(meta_request, request);
/* The body of the request is queued to be streamed, don't finish the metrics yet. */
finishing_metrics = false;
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: %d out of %d parts have completed.",
(void *)meta_request,
(auto_ranged_get->synced_data.num_parts_successful +
auto_ranged_get->synced_data.num_parts_failed),
auto_ranged_get->synced_data.total_num_parts);
} else {
++auto_ranged_get->synced_data.num_parts_failed;
}
break;
}
if (error_code != AWS_ERROR_SUCCESS) {
if (error_code == AWS_ERROR_S3_INVALID_RESPONSE_STATUS &&
request->send_data.response_status == AWS_HTTP_STATUS_CODE_412_PRECONDITION_FAILED &&
!auto_ranged_get->initial_message_has_if_match_header) {
/* Use more clear error code as we added the if-match header under the hood. */
error_code = AWS_ERROR_S3_OBJECT_MODIFIED;
}
aws_s3_meta_request_set_fail_synced(meta_request, request, error_code);
if (error_code == AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH) {
/* It's a mismatch of checksum, tell user that we validated the checksum and the algorithm we validated
*/
meta_request->synced_data.finish_result.did_validate = true;
meta_request->synced_data.finish_result.validation_algorithm = request->validation_algorithm;
}
}
if (finishing_metrics) {
aws_s3_request_finish_up_metrics_synced(request, meta_request);
}
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
}
|