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 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
|
/**
* 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_auto_ranged_put.h"
#include "aws/s3/private/s3_checksums.h"
#include "aws/s3/private/s3_client_impl.h"
#include "aws/s3/private/s3_meta_request_impl.h"
#include "aws/s3/private/s3_parallel_input_stream.h"
#include "aws/s3/private/s3_request_messages.h"
#include "aws/s3/private/s3_util.h"
#include "aws/s3/s3express_credentials_provider.h"
#include <aws/auth/signable.h>
#include <aws/auth/signing.h>
#include <aws/auth/signing_config.h>
#include <aws/auth/signing_result.h>
#include <aws/common/clock.h>
#include <aws/common/encoding.h>
#include <aws/common/file.h>
#include <aws/common/string.h>
#include <aws/common/system_info.h>
#include <aws/io/async_stream.h>
#include <aws/io/event_loop.h>
#include <aws/io/retry_strategy.h>
#include <aws/io/socket.h>
#include <aws/io/stream.h>
#include <errno.h>
#include <inttypes.h>
static const size_t s_dynamic_body_initial_buf_size = KB_TO_BYTES(1);
static const size_t s_default_body_streaming_priority_queue_size = 16;
static const size_t s_default_event_delivery_array_size = 16;
static int s_s3_request_priority_queue_pred(const void *a, const void *b);
static void s_s3_meta_request_destroy(void *user_data);
static void s_s3_meta_request_init_signing_date_time(
struct aws_s3_meta_request *meta_request,
struct aws_date_time *date_time);
static void s_s3_meta_request_sign_request(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_signing_complete_fn *on_signing_complete,
void *user_data);
static void s_s3_meta_request_request_on_signed(
struct aws_signing_result *signing_result,
int error_code,
void *user_data);
static int s_s3_meta_request_incoming_body(
struct aws_http_stream *stream,
const struct aws_byte_cursor *data,
void *user_data);
static int s_s3_meta_request_incoming_headers(
struct aws_http_stream *stream,
enum aws_http_header_block header_block,
const struct aws_http_header *headers,
size_t headers_count,
void *user_data);
static int s_s3_meta_request_headers_block_done(
struct aws_http_stream *stream,
enum aws_http_header_block header_block,
void *user_data);
static void s_s3_meta_request_stream_metrics(
struct aws_http_stream *stream,
const struct aws_http_stream_metrics *metrics,
void *user_data);
static void s_s3_meta_request_stream_complete(struct aws_http_stream *stream, int error_code, void *user_data);
static void s_s3_meta_request_send_request_finish(
struct aws_s3_connection *connection,
struct aws_http_stream *stream,
int error_code);
static bool s_s3_meta_request_read_from_pending_async_writes(
struct aws_s3_meta_request *meta_request,
struct aws_byte_buf *dest);
void aws_s3_meta_request_lock_synced_data(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
aws_mutex_lock(&meta_request->synced_data.lock);
}
void aws_s3_meta_request_unlock_synced_data(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
aws_mutex_unlock(&meta_request->synced_data.lock);
}
/* True if the checksum validated and matched, false otherwise. */
static bool s_validate_checksum(
struct aws_s3_checksum *checksum_to_validate,
struct aws_byte_buf *expected_encoded_checksum) {
struct aws_byte_buf response_body_sum;
struct aws_byte_buf encoded_response_body_sum;
AWS_ZERO_STRUCT(response_body_sum);
AWS_ZERO_STRUCT(encoded_response_body_sum);
bool validated = false;
size_t encoded_checksum_len = 0;
if (aws_base64_compute_encoded_len(checksum_to_validate->digest_size, &encoded_checksum_len)) {
goto done;
}
aws_byte_buf_init(&encoded_response_body_sum, checksum_to_validate->allocator, encoded_checksum_len);
aws_byte_buf_init(&response_body_sum, checksum_to_validate->allocator, checksum_to_validate->digest_size);
if (aws_checksum_finalize(checksum_to_validate, &response_body_sum)) {
goto done;
}
struct aws_byte_cursor response_body_sum_cursor = aws_byte_cursor_from_buf(&response_body_sum);
if (aws_base64_encode(&response_body_sum_cursor, &encoded_response_body_sum)) {
goto done;
}
if (aws_byte_buf_eq(&encoded_response_body_sum, expected_encoded_checksum)) {
validated = true;
}
done:
aws_byte_buf_clean_up(&response_body_sum);
aws_byte_buf_clean_up(&encoded_response_body_sum);
return validated;
}
/* Prepare the finish request when we validate the checksum */
static void s_validate_meta_request_checksum_on_finish(
struct aws_s3_meta_request *meta_request,
struct aws_s3_meta_request_result *meta_request_result) {
if (meta_request_result->error_code == AWS_OP_SUCCESS && meta_request->meta_request_level_running_response_sum) {
meta_request_result->did_validate = true;
meta_request_result->validation_algorithm = meta_request->meta_request_level_running_response_sum->algorithm;
if (!s_validate_checksum(
meta_request->meta_request_level_running_response_sum,
&meta_request->meta_request_level_response_header_checksum)) {
meta_request_result->error_code = AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH;
AWS_LOGF_ERROR(AWS_LS_S3_META_REQUEST, "id=%p Checksum mismatch!", (void *)meta_request);
}
}
aws_checksum_destroy(meta_request->meta_request_level_running_response_sum);
aws_byte_buf_clean_up(&meta_request->meta_request_level_response_header_checksum);
}
int aws_s3_meta_request_init_base(
struct aws_allocator *allocator,
struct aws_s3_client *client,
size_t part_size,
bool should_compute_content_md5,
const struct aws_s3_meta_request_options *options,
void *impl,
struct aws_s3_meta_request_vtable *vtable,
struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(allocator);
AWS_PRECONDITION(options);
AWS_PRECONDITION(options->message);
AWS_PRECONDITION(impl);
AWS_PRECONDITION(meta_request);
AWS_ZERO_STRUCT(*meta_request);
AWS_ASSERT(vtable->update);
AWS_ASSERT(vtable->prepare_request);
AWS_ASSERT(vtable->destroy);
AWS_ASSERT(vtable->sign_request);
AWS_ASSERT(vtable->init_signing_date_time);
AWS_ASSERT(vtable->finished_request);
AWS_ASSERT(vtable->send_request_finish);
meta_request->allocator = allocator;
meta_request->type = options->type;
/* Set up reference count. */
aws_ref_count_init(&meta_request->ref_count, meta_request, s_s3_meta_request_destroy);
aws_linked_list_init(&meta_request->synced_data.cancellable_http_streams_list);
if (part_size == SIZE_MAX) {
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
goto error;
}
if (aws_mutex_init(&meta_request->synced_data.lock)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST, "id=%p Could not initialize mutex for meta request", (void *)meta_request);
goto error;
}
if (aws_priority_queue_init_dynamic(
&meta_request->synced_data.pending_body_streaming_requests,
meta_request->allocator,
s_default_body_streaming_priority_queue_size,
sizeof(struct aws_s3_request *),
s_s3_request_priority_queue_pred)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST, "id=%p Could not initialize priority queue for meta request", (void *)meta_request);
/* Priority queue */
goto error;
}
aws_array_list_init_dynamic(
&meta_request->synced_data.event_delivery_array,
meta_request->allocator,
s_default_event_delivery_array_size,
sizeof(struct aws_s3_meta_request_event));
aws_array_list_init_dynamic(
&meta_request->io_threaded_data.event_delivery_array,
meta_request->allocator,
s_default_event_delivery_array_size,
sizeof(struct aws_s3_meta_request_event));
*((size_t *)&meta_request->part_size) = part_size;
*((bool *)&meta_request->should_compute_content_md5) = should_compute_content_md5;
if (aws_checksum_config_storage_init(
meta_request->allocator,
&meta_request->checksum_config,
options->checksum_config,
options->message,
(void *)meta_request)) {
goto error;
}
if (options->signing_config) {
meta_request->cached_signing_config = aws_cached_signing_config_new(client, options->signing_config);
}
/* Client is currently optional to allow spinning up a meta_request without a client in a test. */
if (client != NULL) {
meta_request->client = aws_s3_client_acquire(client);
meta_request->io_event_loop = aws_event_loop_group_get_next_loop(client->body_streaming_elg);
meta_request->synced_data.read_window_running_total = client->initial_read_window;
}
/* Keep original message around, for headers, method, and synchronous body-stream (if any) */
meta_request->initial_request_message = aws_http_message_acquire(options->message);
if (options->recv_filepath.len > 0) {
meta_request->recv_filepath = aws_string_new_from_cursor(allocator, &options->recv_filepath);
switch (options->recv_file_option) {
case AWS_S3_RECV_FILE_CREATE_OR_REPLACE:
meta_request->recv_file = aws_fopen(aws_string_c_str(meta_request->recv_filepath), "wb");
break;
case AWS_S3_RECV_FILE_CREATE_NEW:
if (aws_path_exists(meta_request->recv_filepath)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Cannot receive file via CREATE_NEW: file already exists",
(void *)meta_request);
aws_raise_error(AWS_ERROR_S3_RECV_FILE_ALREADY_EXISTS);
break;
} else {
meta_request->recv_file = aws_fopen(aws_string_c_str(meta_request->recv_filepath), "wb");
break;
}
case AWS_S3_RECV_FILE_CREATE_OR_APPEND:
meta_request->recv_file = aws_fopen(aws_string_c_str(meta_request->recv_filepath), "ab");
break;
case AWS_S3_RECV_FILE_WRITE_TO_POSITION:
if (!aws_path_exists(meta_request->recv_filepath)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Cannot receive file via WRITE_TO_POSITION: file not found.",
(void *)meta_request);
aws_raise_error(AWS_ERROR_S3_RECV_FILE_NOT_FOUND);
break;
} else {
meta_request->recv_file = aws_fopen(aws_string_c_str(meta_request->recv_filepath), "r+");
if (meta_request->recv_file &&
aws_fseek(meta_request->recv_file, options->recv_file_position, SEEK_SET) != AWS_OP_SUCCESS) {
/* error out. */
goto error;
}
break;
}
default:
AWS_ASSERT(false);
aws_raise_error(AWS_ERROR_INVALID_ARGUMENT);
break;
}
if (!meta_request->recv_file) {
goto error;
}
}
/* If the request's body is being passed in some other way, set that up.
* (we checked earlier that the request body is not being passed multiple ways) */
if (options->send_filepath.len > 0) {
/* Create parallel read stream from file */
meta_request->request_body_parallel_stream =
client->vtable->parallel_input_stream_new_from_file(allocator, options->send_filepath);
if (meta_request->request_body_parallel_stream == NULL) {
goto error;
}
} else if (options->send_async_stream != NULL) {
meta_request->request_body_async_stream = aws_async_input_stream_acquire(options->send_async_stream);
} else if (options->send_using_async_writes == true) {
meta_request->request_body_using_async_writes = true;
}
meta_request->synced_data.next_streaming_part = 1;
meta_request->meta_request_level_running_response_sum = NULL;
meta_request->user_data = options->user_data;
meta_request->progress_callback = options->progress_callback;
meta_request->telemetry_callback = options->telemetry_callback;
meta_request->upload_review_callback = options->upload_review_callback;
meta_request->headers_callback = options->headers_callback;
meta_request->body_callback = options->body_callback;
meta_request->finish_callback = options->finish_callback;
/* Nothing can fail after here. Leave the impl not affected by failure of initializing base. */
meta_request->impl = impl;
meta_request->vtable = vtable;
return AWS_OP_SUCCESS;
error:
s_s3_meta_request_destroy((void *)meta_request);
return AWS_OP_ERR;
}
void aws_s3_meta_request_increment_read_window(struct aws_s3_meta_request *meta_request, uint64_t bytes) {
AWS_PRECONDITION(meta_request);
if (bytes == 0) {
return;
}
if (!meta_request->client->enable_read_backpressure) {
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Ignoring call to increment read window. This client has not enabled read backpressure.",
(void *)meta_request);
return;
}
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p: Incrementing read window by %" PRIu64, (void *)meta_request, bytes);
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
/* Response will never approach UINT64_MAX, so do a saturating sum instead of worrying about overflow */
meta_request->synced_data.read_window_running_total =
aws_add_u64_saturating(bytes, meta_request->synced_data.read_window_running_total);
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
/* Schedule the work task, to continue processing the meta-request */
aws_s3_client_schedule_process_work(meta_request->client);
}
void aws_s3_meta_request_cancel(struct aws_s3_meta_request *meta_request) {
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
aws_s3_meta_request_set_fail_synced(meta_request, NULL, AWS_ERROR_S3_CANCELED);
aws_s3_meta_request_cancel_cancellable_requests_synced(meta_request, AWS_ERROR_S3_CANCELED);
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
/* Schedule the work task, to continue processing the meta-request */
aws_s3_client_schedule_process_work(meta_request->client);
}
int aws_s3_meta_request_pause(
struct aws_s3_meta_request *meta_request,
struct aws_s3_meta_request_resume_token **out_resume_token) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
*out_resume_token = NULL;
if (!meta_request->vtable->pause) {
return aws_raise_error(AWS_ERROR_UNSUPPORTED_OPERATION);
}
return meta_request->vtable->pause(meta_request, out_resume_token);
}
void aws_s3_meta_request_set_fail_synced(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *failed_request,
int error_code) {
AWS_PRECONDITION(meta_request);
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
/* Protect against bugs */
if (error_code == AWS_ERROR_SUCCESS) {
AWS_ASSERT(false);
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Meta request failed but error code not set, AWS_ERROR_UNKNOWN will be reported",
(void *)meta_request);
error_code = AWS_ERROR_UNKNOWN;
}
if (meta_request->synced_data.finish_result_set) {
return;
}
meta_request->synced_data.finish_result_set = true;
if ((error_code == AWS_ERROR_S3_INVALID_RESPONSE_STATUS || error_code == AWS_ERROR_S3_NON_RECOVERABLE_ASYNC_ERROR ||
error_code == AWS_ERROR_S3_OBJECT_MODIFIED) &&
failed_request != NULL) {
aws_s3_meta_request_result_setup(
meta_request,
&meta_request->synced_data.finish_result,
failed_request,
failed_request->send_data.response_status,
error_code);
} else {
AWS_ASSERT(error_code != AWS_ERROR_S3_INVALID_RESPONSE_STATUS);
aws_s3_meta_request_result_setup(meta_request, &meta_request->synced_data.finish_result, NULL, 0, error_code);
}
}
void aws_s3_meta_request_set_success_synced(struct aws_s3_meta_request *meta_request, int response_status) {
AWS_PRECONDITION(meta_request);
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
if (meta_request->synced_data.finish_result_set) {
return;
}
meta_request->synced_data.finish_result_set = true;
aws_s3_meta_request_result_setup(
meta_request, &meta_request->synced_data.finish_result, NULL, response_status, AWS_ERROR_SUCCESS);
}
bool aws_s3_meta_request_has_finish_result(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
bool is_finishing = aws_s3_meta_request_has_finish_result_synced(meta_request);
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
return is_finishing;
}
bool aws_s3_meta_request_has_finish_result_synced(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
if (!meta_request->synced_data.finish_result_set) {
return false;
}
return true;
}
struct aws_s3_meta_request *aws_s3_meta_request_acquire(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
aws_ref_count_acquire(&meta_request->ref_count);
return meta_request;
}
struct aws_s3_meta_request *aws_s3_meta_request_release(struct aws_s3_meta_request *meta_request) {
if (meta_request != NULL) {
aws_ref_count_release(&meta_request->ref_count);
}
return NULL;
}
static void s_s3_meta_request_destroy(void *user_data) {
struct aws_s3_meta_request *meta_request = user_data;
AWS_PRECONDITION(meta_request);
void *log_id = meta_request;
AWS_LOGF_DEBUG(AWS_LS_S3_META_REQUEST, "id=%p Cleaning up meta request", (void *)meta_request);
/* Clean up our initial http message */
aws_checksum_config_storage_cleanup(&meta_request->checksum_config);
meta_request->request_body_async_stream = aws_async_input_stream_release(meta_request->request_body_async_stream);
meta_request->initial_request_message = aws_http_message_release(meta_request->initial_request_message);
void *meta_request_user_data = meta_request->user_data;
aws_s3_meta_request_shutdown_fn *shutdown_callback = meta_request->shutdown_callback;
aws_cached_signing_config_destroy(meta_request->cached_signing_config);
aws_string_destroy(meta_request->s3express_session_host);
aws_mutex_clean_up(&meta_request->synced_data.lock);
/* endpoint should have already been released and set NULL by the meta request finish call.
* But call release() again, just in case we're tearing down a half-initialized meta request */
aws_s3_endpoint_release(meta_request->endpoint);
if (meta_request->recv_file) {
fclose(meta_request->recv_file);
meta_request->recv_file = NULL;
if (meta_request->recv_file_delete_on_failure) {
/* If the meta request succeed, the file should be closed from finish call. So it must be failing. */
aws_file_delete(meta_request->recv_filepath);
}
}
aws_string_destroy(meta_request->recv_filepath);
/* Client may be NULL if meta request failed mid-creation (or this some weird testing mock with no client) */
if (meta_request->client != NULL) {
aws_s3_buffer_pool_release_ticket(
meta_request->client->buffer_pool, meta_request->synced_data.async_write.buffered_data_ticket);
meta_request->client = aws_s3_client_release(meta_request->client);
}
AWS_ASSERT(aws_priority_queue_size(&meta_request->synced_data.pending_body_streaming_requests) == 0);
aws_priority_queue_clean_up(&meta_request->synced_data.pending_body_streaming_requests);
AWS_ASSERT(aws_array_list_length(&meta_request->synced_data.event_delivery_array) == 0);
aws_array_list_clean_up(&meta_request->synced_data.event_delivery_array);
AWS_ASSERT(aws_array_list_length(&meta_request->io_threaded_data.event_delivery_array) == 0);
aws_array_list_clean_up(&meta_request->io_threaded_data.event_delivery_array);
AWS_ASSERT(aws_linked_list_empty(&meta_request->synced_data.cancellable_http_streams_list));
aws_s3_meta_request_result_clean_up(meta_request, &meta_request->synced_data.finish_result);
if (meta_request->vtable != NULL) {
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p Calling virtual meta request destroy function.", log_id);
meta_request->vtable->destroy(meta_request);
}
meta_request = NULL;
if (shutdown_callback != NULL) {
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p Calling meta request shutdown callback.", log_id);
shutdown_callback(meta_request_user_data);
}
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p Meta request clean up finished.", log_id);
}
static int s_s3_request_priority_queue_pred(const void *a, const void *b) {
const struct aws_s3_request *const *request_a = a;
AWS_PRECONDITION(request_a);
AWS_PRECONDITION(*request_a);
const struct aws_s3_request *const *request_b = b;
AWS_PRECONDITION(request_b);
AWS_PRECONDITION(*request_b);
return (*request_a)->part_number > (*request_b)->part_number;
}
bool aws_s3_meta_request_update(
struct aws_s3_meta_request *meta_request,
uint32_t flags,
struct aws_s3_request **out_request) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_PRECONDITION(meta_request->vtable->update);
return meta_request->vtable->update(meta_request, flags, out_request);
}
bool aws_s3_meta_request_is_active(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
bool active = meta_request->synced_data.state == AWS_S3_META_REQUEST_STATE_ACTIVE;
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
return active;
}
bool aws_s3_meta_request_is_finished(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
bool is_finished = meta_request->synced_data.state == AWS_S3_META_REQUEST_STATE_FINISHED;
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
return is_finished;
}
/* TODO: document how this is final step in prepare-request sequence.
* Could be invoked on any thread. */
static void s_s3_prepare_request_payload_callback_and_destroy(
struct aws_s3_prepare_request_payload *payload,
int error_code) {
AWS_PRECONDITION(payload);
AWS_PRECONDITION(payload->request);
struct aws_s3_meta_request *meta_request = payload->request->meta_request;
AWS_PRECONDITION(meta_request);
++payload->request->num_times_prepared;
if (error_code) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not prepare request %p due to error %d (%s).",
(void *)meta_request,
(void *)payload->request,
error_code,
aws_error_str(error_code));
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
aws_s3_meta_request_set_fail_synced(meta_request, payload->request, error_code);
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
}
if (payload->callback != NULL) {
payload->callback(meta_request, payload->request, error_code, payload->user_data);
}
aws_future_void_release(payload->asyncstep_prepare_request);
aws_mem_release(payload->allocator, payload);
}
static void s_s3_meta_request_schedule_prepare_request_default(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_s3_meta_request_prepare_request_callback_fn *callback,
void *user_data) {
/* By default, don't do any parallel. */
aws_s3_meta_request_schedule_prepare_request_default_impl(
meta_request, request, false /*parallel*/, callback, user_data);
}
void aws_s3_meta_request_prepare_request(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_s3_meta_request_prepare_request_callback_fn *callback,
void *user_data) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
if (meta_request->vtable->schedule_prepare_request) {
meta_request->vtable->schedule_prepare_request(meta_request, request, callback, user_data);
} else {
s_s3_meta_request_schedule_prepare_request_default(meta_request, request, callback, user_data);
}
}
static void s_s3_meta_request_prepare_request_task(struct aws_task *task, void *arg, enum aws_task_status task_status);
static void s_s3_meta_request_on_request_prepared(void *user_data);
void aws_s3_meta_request_schedule_prepare_request_default_impl(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
bool parallel,
aws_s3_meta_request_prepare_request_callback_fn *callback,
void *user_data) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(request);
struct aws_s3_client *client = meta_request->client;
AWS_PRECONDITION(client);
struct aws_allocator *allocator = client->allocator;
AWS_PRECONDITION(allocator);
struct aws_s3_prepare_request_payload *payload =
aws_mem_calloc(allocator, 1, sizeof(struct aws_s3_prepare_request_payload));
payload->allocator = allocator;
payload->request = request;
payload->callback = callback;
payload->user_data = user_data;
aws_task_init(
&payload->task, s_s3_meta_request_prepare_request_task, payload, "s3_meta_request_prepare_request_task");
if (parallel) {
/* To support reading in parallel, schedule task on any I/O thread in the streaming elg.
* Otherwise, we wouldn't get any parallelism. */
struct aws_event_loop *loop = aws_event_loop_group_get_next_loop(client->body_streaming_elg);
aws_event_loop_schedule_task_now(loop, &payload->task);
} else {
aws_event_loop_schedule_task_now(meta_request->io_event_loop, &payload->task);
}
}
static void s_s3_meta_request_prepare_request_task(struct aws_task *task, void *arg, enum aws_task_status task_status) {
(void)task;
(void)task_status;
struct aws_s3_prepare_request_payload *payload = arg;
AWS_PRECONDITION(payload);
struct aws_s3_request *request = payload->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
const struct aws_s3_meta_request_vtable *vtable = meta_request->vtable;
AWS_PRECONDITION(vtable);
/* Client owns this event loop group. A cancel should not be possible. */
AWS_ASSERT(task_status == AWS_TASK_STATUS_RUN_READY);
if (!request->always_send && aws_s3_meta_request_has_finish_result(meta_request)) {
s_s3_prepare_request_payload_callback_and_destroy(payload, AWS_ERROR_S3_CANCELED);
return;
}
/* Kick off the async vtable->prepare_request()
* Each subclass has its own implementation of this. */
payload->asyncstep_prepare_request = vtable->prepare_request(request);
aws_future_void_register_callback(
payload->asyncstep_prepare_request, s_s3_meta_request_on_request_prepared, payload);
return;
}
/* Called after vtable->prepare_request has succeeded or failed. */
static void s_s3_meta_request_on_request_prepared(void *user_data) {
struct aws_s3_prepare_request_payload *payload = user_data;
struct aws_s3_request *request = payload->request;
struct aws_s3_meta_request *meta_request = request->meta_request;
int error_code = aws_future_void_get_error(payload->asyncstep_prepare_request);
if (error_code) {
s_s3_prepare_request_payload_callback_and_destroy(payload, error_code);
return;
}
aws_s3_add_user_agent_header(meta_request->allocator, request->send_data.message);
/* Next step is to sign the newly created message (completion callback could happen on any thread) */
s_s3_meta_request_sign_request(meta_request, request, s_s3_meta_request_request_on_signed, payload);
}
static void s_s3_meta_request_init_signing_date_time(
struct aws_s3_meta_request *meta_request,
struct aws_date_time *date_time) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_PRECONDITION(meta_request->vtable->init_signing_date_time);
meta_request->vtable->init_signing_date_time(meta_request, date_time);
}
void aws_s3_meta_request_init_signing_date_time_default(
struct aws_s3_meta_request *meta_request,
struct aws_date_time *date_time) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(date_time);
(void)meta_request;
aws_date_time_init_now(date_time);
}
static void s_s3_meta_request_sign_request(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_signing_complete_fn *on_signing_complete,
void *user_data) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_PRECONDITION(meta_request->vtable->sign_request);
if (request->send_data.metrics) {
struct aws_s3_request_metrics *metric = request->send_data.metrics;
aws_high_res_clock_get_ticks((uint64_t *)&metric->time_metrics.sign_start_timestamp_ns);
}
meta_request->vtable->sign_request(meta_request, request, on_signing_complete, user_data);
}
struct aws_get_s3express_credentials_user_data {
/* Keep our own reference to allocator, because the meta request can be gone after the callback invoked. */
struct aws_allocator *allocator;
struct aws_s3_meta_request *meta_request;
struct aws_s3_request *request;
aws_signing_complete_fn *on_signing_complete;
const struct aws_credentials *original_credentials;
struct aws_signing_config_aws base_signing_config;
struct aws_credentials_properties_s3express properties;
void *user_data;
};
static void s_aws_get_s3express_credentials_user_data_destroy(struct aws_get_s3express_credentials_user_data *context) {
aws_s3_meta_request_release(context->meta_request);
aws_credentials_release(context->original_credentials);
aws_mem_release(context->allocator, context);
}
static void s_get_s3express_credentials_callback(struct aws_credentials *credentials, int error_code, void *user_data) {
struct aws_get_s3express_credentials_user_data *context = user_data;
struct aws_signing_config_aws signing_config = context->base_signing_config;
if (error_code) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Failed to get S3 Express credentials %p. due to error code %d (%s)",
(void *)context->meta_request,
(void *)context->request,
error_code,
aws_error_str(error_code));
context->on_signing_complete(NULL, error_code, context->user_data);
goto done;
}
s_s3_meta_request_init_signing_date_time(context->meta_request, &signing_config.date);
/* Override the credentials */
signing_config.credentials = credentials;
signing_config.algorithm = AWS_SIGNING_ALGORITHM_V4_S3EXPRESS;
if (aws_sign_request_aws(
context->allocator,
context->request->send_data.signable,
(struct aws_signing_config_base *)&signing_config,
context->on_signing_complete,
context->user_data)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not sign request %p. due to error code %d (%s)",
(void *)context->meta_request,
(void *)context->request,
aws_last_error_or_unknown(),
aws_error_str(aws_last_error_or_unknown()));
context->on_signing_complete(NULL, aws_last_error_or_unknown(), context->user_data);
}
done:
s_aws_get_s3express_credentials_user_data_destroy(context);
}
static void s_get_original_credentials_callback(struct aws_credentials *credentials, int error_code, void *user_data) {
struct aws_get_s3express_credentials_user_data *context = user_data;
struct aws_s3_meta_request *meta_request = context->meta_request;
if (error_code) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Failed to get S3 Express credentials %p. due to error code %d (%s)",
(void *)context->meta_request,
(void *)context->request,
error_code,
aws_error_str(error_code));
context->on_signing_complete(NULL, error_code, context->user_data);
s_aws_get_s3express_credentials_user_data_destroy(context);
return;
}
context->original_credentials = credentials;
aws_credentials_acquire(context->original_credentials);
/**
* Derive the credentials for S3 Express.
*/
struct aws_s3_client *client = meta_request->client;
if (aws_s3express_credentials_provider_get_credentials(
client->s3express_provider,
context->original_credentials,
&context->properties,
s_get_s3express_credentials_callback,
context)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not get S3 Express credentials %p",
(void *)meta_request,
(void *)context->request);
context->on_signing_complete(NULL, aws_last_error_or_unknown(), user_data);
s_aws_get_s3express_credentials_user_data_destroy(context);
}
}
static void s_meta_request_resolve_signing_config(
struct aws_signing_config_aws *out_signing_config,
struct aws_s3_request *request,
struct aws_s3_meta_request *meta_request) {
struct aws_s3_client *client = meta_request->client;
if (meta_request->cached_signing_config != NULL) {
*out_signing_config = meta_request->cached_signing_config->config;
if (out_signing_config->credentials == NULL && out_signing_config->credentials_provider == NULL) {
/* When no credentials available from meta request level override, we use the credentials from client */
out_signing_config->credentials = client->cached_signing_config->config.credentials;
out_signing_config->credentials_provider = client->cached_signing_config->config.credentials_provider;
}
} else if (client->cached_signing_config != NULL) {
*out_signing_config = client->cached_signing_config->config;
} else {
/* Not possible to have no cached signing config from both client and request */
AWS_FATAL_ASSERT(false);
}
/* If the checksum is configured to be added to the trailer, the payload will be aws-chunked encoded. The
* payload will need to be streaming signed/unsigned. */
if (meta_request->checksum_config.location == AWS_SCL_TRAILER &&
aws_byte_cursor_eq(&out_signing_config->signed_body_value, &g_aws_signed_body_value_unsigned_payload)) {
out_signing_config->signed_body_value = g_aws_signed_body_value_streaming_unsigned_payload_trailer;
}
/* However the initial request for a multipart upload does not have a trailing checksum and is not chunked so it
* must have an unsigned_payload signed_body value*/
if (request->part_number == 0 &&
aws_byte_cursor_eq(
&out_signing_config->signed_body_value, &g_aws_signed_body_value_streaming_unsigned_payload_trailer)) {
out_signing_config->signed_body_value = g_aws_signed_body_value_unsigned_payload;
}
/**
* In case of the signing was skipped for anonymous credentials, or presigned URL.
*/
request->send_data.require_streaming_unsigned_payload_header = aws_byte_cursor_eq(
&out_signing_config->signed_body_value, &g_aws_signed_body_value_streaming_unsigned_payload_trailer);
}
void aws_s3_meta_request_sign_request_default_impl(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_signing_complete_fn *on_signing_complete,
void *user_data,
bool disable_s3_express_signing) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(request);
AWS_PRECONDITION(on_signing_complete);
struct aws_s3_client *client = meta_request->client;
AWS_ASSERT(client);
struct aws_signing_config_aws signing_config;
s_meta_request_resolve_signing_config(&signing_config, request, meta_request);
request->send_data.signable = aws_signable_new_http_request(meta_request->allocator, request->send_data.message);
if (request->send_data.signable == NULL) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not allocate signable for request %p",
(void *)meta_request,
(void *)request);
on_signing_complete(NULL, aws_last_error_or_unknown(), user_data);
return;
}
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST,
"id=%p Created signable %p for request %p with message %p",
(void *)meta_request,
(void *)request->send_data.signable,
(void *)request,
(void *)request->send_data.message);
if (signing_config.algorithm == AWS_SIGNING_ALGORITHM_V4_S3EXPRESS && !disable_s3_express_signing) {
/* Fetch credentials from S3 Express provider. */
struct aws_get_s3express_credentials_user_data *context =
aws_mem_calloc(meta_request->allocator, 1, sizeof(struct aws_get_s3express_credentials_user_data));
context->allocator = meta_request->allocator;
context->base_signing_config = signing_config;
context->meta_request = aws_s3_meta_request_acquire(meta_request);
context->on_signing_complete = on_signing_complete;
context->request = request;
context->user_data = user_data;
context->properties.host = aws_byte_cursor_from_string(meta_request->s3express_session_host);
context->properties.region = signing_config.region;
context->properties.headers = aws_http_message_get_headers(meta_request->initial_request_message);
if (signing_config.credentials) {
context->original_credentials = signing_config.credentials;
aws_credentials_acquire(context->original_credentials);
/**
* Derive the credentials for S3 Express.
*/
if (aws_s3express_credentials_provider_get_credentials(
client->s3express_provider,
context->original_credentials,
&context->properties,
s_get_s3express_credentials_callback,
context)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not get S3 Express credentials %p",
(void *)meta_request,
(void *)request);
on_signing_complete(NULL, aws_last_error_or_unknown(), user_data);
s_aws_get_s3express_credentials_user_data_destroy(context);
return;
}
} else if (signing_config.credentials_provider) {
/* Get the credentials from provider first. */
if (aws_credentials_provider_get_credentials(
signing_config.credentials_provider, s_get_original_credentials_callback, context)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not get S3 Express credentials %p",
(void *)meta_request,
(void *)request);
on_signing_complete(NULL, aws_last_error_or_unknown(), user_data);
s_aws_get_s3express_credentials_user_data_destroy(context);
return;
}
}
} else {
/* Regular signing. */
if (disable_s3_express_signing) {
signing_config.algorithm = AWS_SIGNING_ALGORITHM_V4;
}
s_s3_meta_request_init_signing_date_time(meta_request, &signing_config.date);
if (aws_sign_request_aws(
meta_request->allocator,
request->send_data.signable,
(struct aws_signing_config_base *)&signing_config,
on_signing_complete,
user_data)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST, "id=%p: Could not sign request %p", (void *)meta_request, (void *)request);
on_signing_complete(NULL, aws_last_error_or_unknown(), user_data);
return;
}
}
}
/* Handles signing a message for the caller. */
void aws_s3_meta_request_sign_request_default(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
aws_signing_complete_fn *on_signing_complete,
void *user_data) {
aws_s3_meta_request_sign_request_default_impl(meta_request, request, on_signing_complete, user_data, false);
}
/* Handle the signing result */
static void s_s3_meta_request_request_on_signed(
struct aws_signing_result *signing_result,
int error_code,
void *user_data) {
struct aws_s3_prepare_request_payload *payload = user_data;
AWS_PRECONDITION(payload);
struct aws_s3_request *request = payload->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
if (error_code != AWS_ERROR_SUCCESS) {
goto finish;
}
if (signing_result != NULL &&
aws_apply_signing_result_to_http_request(request->send_data.message, meta_request->allocator, signing_result)) {
error_code = aws_last_error_or_unknown();
goto finish;
}
/**
* Add "x-amz-content-sha256: STREAMING-UNSIGNED-PAYLOAD-TRAILER" header to support trailing checksum.
*/
if (request->send_data.require_streaming_unsigned_payload_header) {
struct aws_http_headers *headers = aws_http_message_get_headers(request->send_data.message);
AWS_ASSERT(headers != NULL);
if (aws_http_headers_set(
headers,
aws_byte_cursor_from_c_str("x-amz-content-sha256"),
g_aws_signed_body_value_streaming_unsigned_payload_trailer)) {
error_code = aws_last_error_or_unknown();
goto finish;
}
}
if (request->send_data.metrics) {
struct aws_s3_request_metrics *metric = request->send_data.metrics;
aws_high_res_clock_get_ticks((uint64_t *)&metric->time_metrics.sign_end_timestamp_ns);
AWS_ASSERT(metric->time_metrics.sign_start_timestamp_ns != 0);
metric->time_metrics.signing_duration_ns =
metric->time_metrics.sign_end_timestamp_ns - metric->time_metrics.sign_start_timestamp_ns;
}
finish:
if (error_code != AWS_ERROR_SUCCESS) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Meta request could not sign HTTP request due to error code %d (%s)",
(void *)meta_request,
error_code,
aws_error_str(error_code));
}
s_s3_prepare_request_payload_callback_and_destroy(payload, error_code);
}
void aws_s3_meta_request_send_request(struct aws_s3_meta_request *meta_request, struct aws_s3_connection *connection) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(connection);
AWS_PRECONDITION(connection->http_connection);
struct aws_s3_client *client = meta_request->client;
AWS_PRECONDITION(client);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
/* Now that we have a signed request and a connection, go ahead and issue the request. */
struct aws_http_make_request_options options;
AWS_ZERO_STRUCT(options);
options.self_size = sizeof(struct aws_http_make_request_options);
options.request = request->send_data.message;
options.user_data = connection;
options.on_response_headers = s_s3_meta_request_incoming_headers;
options.on_response_header_block_done = s_s3_meta_request_headers_block_done;
options.on_response_body = s_s3_meta_request_incoming_body;
if (request->send_data.metrics) {
options.on_metrics = s_s3_meta_request_stream_metrics;
}
options.on_complete = s_s3_meta_request_stream_complete;
if (request->request_type == AWS_S3_REQUEST_TYPE_UPLOAD_PART) {
options.response_first_byte_timeout_ms = aws_atomic_load_int(&meta_request->client->upload_timeout_ms);
request->upload_timeout_ms = (size_t)options.response_first_byte_timeout_ms;
}
struct aws_http_stream *stream =
client->vtable->http_connection_make_request(connection->http_connection, &options);
if (stream == NULL) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST, "id=%p: Could not make HTTP request %p", (void *)meta_request, (void *)request);
goto error_finish;
}
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p: Sending request %p", (void *)meta_request, (void *)request);
if (!request->always_send) {
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
if (aws_s3_meta_request_has_finish_result_synced(meta_request)) {
/* The meta request has finish result already, for this request, treat it as canceled. */
aws_raise_error(AWS_ERROR_S3_CANCELED);
aws_s3_meta_request_unlock_synced_data(meta_request);
goto error_finish;
}
/* Activate the stream within the lock as once the activate invoked, the HTTP level callback can happen
* right after. */
if (aws_http_stream_activate(stream) != AWS_OP_SUCCESS) {
aws_s3_meta_request_unlock_synced_data(meta_request);
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not activate HTTP stream %p",
(void *)meta_request,
(void *)request);
goto error_finish;
}
aws_linked_list_push_back(
&meta_request->synced_data.cancellable_http_streams_list, &request->cancellable_http_streams_list_node);
request->synced_data.cancellable_http_stream = stream;
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
} else {
/* If the request always send, it is not cancellable. We simply activate the stream. */
if (aws_http_stream_activate(stream) != AWS_OP_SUCCESS) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Could not activate HTTP stream %p",
(void *)meta_request,
(void *)request);
goto error_finish;
}
}
return;
error_finish:
if (stream) {
aws_http_stream_release(stream);
stream = NULL;
}
s_s3_meta_request_send_request_finish(connection, NULL, aws_last_error_or_unknown());
}
static int s_s3_meta_request_error_code_from_response_status(int response_status) {
int error_code = AWS_ERROR_UNKNOWN;
switch (response_status) {
case AWS_HTTP_STATUS_CODE_200_OK:
case AWS_HTTP_STATUS_CODE_206_PARTIAL_CONTENT:
case AWS_HTTP_STATUS_CODE_204_NO_CONTENT:
error_code = AWS_ERROR_SUCCESS;
break;
case AWS_HTTP_STATUS_CODE_500_INTERNAL_SERVER_ERROR:
error_code = AWS_ERROR_S3_INTERNAL_ERROR;
break;
case AWS_HTTP_STATUS_CODE_503_SERVICE_UNAVAILABLE:
/* S3 response 503 for throttling, slow down the sending */
error_code = AWS_ERROR_S3_SLOW_DOWN;
break;
default:
error_code = AWS_ERROR_S3_INVALID_RESPONSE_STATUS;
break;
}
return error_code;
}
static bool s_header_value_from_list(
const struct aws_http_header *headers,
size_t headers_count,
const struct aws_byte_cursor name,
struct aws_byte_cursor *out_value) {
for (size_t i = 0; i < headers_count; ++i) {
if (aws_byte_cursor_eq(&headers[i].name, &name)) {
*out_value = headers[i].value;
return true;
}
}
return false;
}
static void s_get_part_response_headers_checksum_helper(
struct aws_s3_connection *connection,
struct aws_s3_meta_request *meta_request,
const struct aws_http_header *headers,
size_t headers_count) {
for (size_t i = 0; i < AWS_ARRAY_SIZE(s_checksum_algo_priority_list); i++) {
enum aws_s3_checksum_algorithm algorithm = s_checksum_algo_priority_list[i];
if (!aws_s3_meta_request_checksum_config_has_algorithm(meta_request, algorithm)) {
/* If user doesn't select this algorithm, skip */
continue;
}
const struct aws_byte_cursor algorithm_header_name =
aws_get_http_header_name_from_checksum_algorithm(algorithm);
struct aws_byte_cursor header_sum;
if (s_header_value_from_list(headers, headers_count, algorithm_header_name, &header_sum)) {
size_t encoded_len = 0;
aws_base64_compute_encoded_len(aws_get_digest_size_from_checksum_algorithm(algorithm), &encoded_len);
if (header_sum.len == encoded_len - 1) {
aws_byte_buf_init_copy_from_cursor(
&connection->request->request_level_response_header_checksum, meta_request->allocator, header_sum);
connection->request->request_level_running_response_sum =
aws_checksum_new(meta_request->allocator, algorithm);
AWS_ASSERT(connection->request->request_level_running_response_sum != NULL);
}
break;
}
}
}
static int s_s3_meta_request_incoming_headers(
struct aws_http_stream *stream,
enum aws_http_header_block header_block,
const struct aws_http_header *headers,
size_t headers_count,
void *user_data) {
(void)header_block;
AWS_PRECONDITION(stream);
struct aws_s3_connection *connection = user_data;
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
if (aws_http_stream_get_incoming_response_status(stream, &request->send_data.response_status)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Could not get incoming response status for request %p",
(void *)meta_request,
(void *)request);
}
if (request->send_data.metrics) {
/* Record the headers to the metrics */
struct aws_s3_request_metrics *s3_metrics = request->send_data.metrics;
if (s3_metrics->req_resp_info_metrics.response_headers == NULL) {
s3_metrics->req_resp_info_metrics.response_headers = aws_http_headers_new(meta_request->allocator);
}
for (size_t i = 0; i < headers_count; ++i) {
const struct aws_byte_cursor *name = &headers[i].name;
const struct aws_byte_cursor *value = &headers[i].value;
if (aws_byte_cursor_eq(name, &g_request_id_header_name)) {
s3_metrics->req_resp_info_metrics.request_id =
aws_string_new_from_cursor(connection->request->allocator, value);
}
aws_http_headers_add(s3_metrics->req_resp_info_metrics.response_headers, *name, *value);
}
s3_metrics->req_resp_info_metrics.response_status = request->send_data.response_status;
}
bool successful_response =
s_s3_meta_request_error_code_from_response_status(request->send_data.response_status) == AWS_ERROR_SUCCESS;
if (successful_response && meta_request->checksum_config.validate_response_checksum &&
request->request_type == AWS_S3_REQUEST_TYPE_GET_OBJECT) {
/* We have `struct aws_http_header *` array instead of `struct aws_http_headers *` :) */
s_get_part_response_headers_checksum_helper(connection, meta_request, headers, headers_count);
}
/* Only record headers if an error has taken place, or if the request_desc has asked for them. */
bool should_record_headers = !successful_response || request->record_response_headers;
if (should_record_headers) {
if (request->send_data.response_headers == NULL) {
request->send_data.response_headers = aws_http_headers_new(meta_request->allocator);
}
for (size_t i = 0; i < headers_count; ++i) {
const struct aws_byte_cursor *name = &headers[i].name;
const struct aws_byte_cursor *value = &headers[i].value;
aws_http_headers_add(request->send_data.response_headers, *name, *value);
}
}
return AWS_OP_SUCCESS;
}
static int s_s3_meta_request_headers_block_done(
struct aws_http_stream *stream,
enum aws_http_header_block header_block,
void *user_data) {
(void)stream;
if (header_block != AWS_HTTP_HEADER_BLOCK_MAIN) {
return AWS_OP_SUCCESS;
}
struct aws_s3_connection *connection = user_data;
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
/*
* When downloading parts via partNumber, if the size is larger than expected, cancel the request immediately so
* we don't end up downloading more into memory than we can handle. We'll retry the download using ranged gets
* instead.
*/
if (request->request_type == AWS_S3_REQUEST_TYPE_GET_OBJECT &&
request->request_tag == AWS_S3_AUTO_RANGE_GET_REQUEST_TYPE_GET_OBJECT_WITH_PART_NUMBER_1) {
uint64_t content_length;
if (!aws_s3_parse_content_length_response_header(
request->allocator, request->send_data.response_headers, &content_length) &&
content_length > meta_request->part_size) {
return aws_raise_error(AWS_ERROR_S3_INTERNAL_PART_SIZE_MISMATCH_RETRYING_WITH_RANGE);
}
}
return AWS_OP_SUCCESS;
}
/*
* Small helper to either do a static or dynamic append.
* TODO: something like this would be useful in common.
*/
static int s_response_body_append(struct aws_byte_buf *buf, const struct aws_byte_cursor *data) {
return buf->allocator != NULL ? aws_byte_buf_append_dynamic(buf, data) : aws_byte_buf_append(buf, data);
}
static int s_s3_meta_request_incoming_body(
struct aws_http_stream *stream,
const struct aws_byte_cursor *data,
void *user_data) {
(void)stream;
struct aws_s3_connection *connection = user_data;
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST,
"id=%p Incoming body for request %p. Response status: %d. Data Size: %" PRIu64 ". connection: %p.",
(void *)meta_request,
(void *)request,
request->send_data.response_status,
(uint64_t)data->len,
(void *)connection);
bool successful_response =
s_s3_meta_request_error_code_from_response_status(request->send_data.response_status) == AWS_ERROR_SUCCESS;
if (!successful_response) {
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "response body: \n" PRInSTR "\n", AWS_BYTE_CURSOR_PRI(*data));
}
if (meta_request->checksum_config.validate_response_checksum && request->request_level_running_response_sum) {
/* Update the request level checksum. */
aws_checksum_update(request->request_level_running_response_sum, data);
}
if (request->send_data.response_body.capacity == 0) {
if (request->has_part_size_response_body && request->ticket != NULL) {
request->send_data.response_body =
aws_s3_buffer_pool_acquire_buffer(request->meta_request->client->buffer_pool, request->ticket);
} else {
size_t buffer_size = s_dynamic_body_initial_buf_size;
aws_byte_buf_init(&request->send_data.response_body, meta_request->allocator, buffer_size);
}
}
/* Note: not having part sized response body means the buffer is dynamic and
* can grow. */
if (s_response_body_append(&request->send_data.response_body, data)) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Request %p could not append to response body due to error %d (%s)",
(void *)meta_request,
(void *)request,
aws_last_error_or_unknown(),
aws_error_str(aws_last_error_or_unknown()));
return AWS_OP_ERR;
}
return AWS_OP_SUCCESS;
}
static void s_s3_meta_request_stream_metrics(
struct aws_http_stream *stream,
const struct aws_http_stream_metrics *http_metrics,
void *user_data) {
(void)stream;
struct aws_s3_connection *connection = user_data;
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
AWS_ASSERT(request->send_data.metrics);
struct aws_s3_request_metrics *s3_metrics = request->send_data.metrics;
/* Copy over the time metrics from aws_http_stream_metrics to aws_s3_request_metrics */
s3_metrics->time_metrics.send_start_timestamp_ns = http_metrics->send_start_timestamp_ns;
s3_metrics->time_metrics.send_end_timestamp_ns = http_metrics->send_end_timestamp_ns;
s3_metrics->time_metrics.sending_duration_ns = http_metrics->sending_duration_ns;
s3_metrics->time_metrics.receive_start_timestamp_ns = http_metrics->receive_start_timestamp_ns;
s3_metrics->time_metrics.receive_end_timestamp_ns = http_metrics->receive_end_timestamp_ns;
s3_metrics->time_metrics.receiving_duration_ns = http_metrics->receiving_duration_ns;
s3_metrics->crt_info_metrics.stream_id = http_metrics->stream_id;
/* Also related metrics from the request/response. */
s3_metrics->crt_info_metrics.connection_id = (void *)connection->http_connection;
const struct aws_socket_endpoint *endpoint = aws_http_connection_get_remote_endpoint(connection->http_connection);
request->send_data.metrics->crt_info_metrics.ip_address =
aws_string_new_from_c_str(request->allocator, endpoint->address);
AWS_ASSERT(request->send_data.metrics->crt_info_metrics.ip_address != NULL);
s3_metrics->crt_info_metrics.thread_id = aws_thread_current_thread_id();
}
/* Finish up the processing of the request work. */
static void s_s3_meta_request_stream_complete(struct aws_http_stream *stream, int error_code, void *user_data) {
struct aws_s3_connection *connection = user_data;
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
struct aws_s3_meta_request *meta_request = request->meta_request;
if (meta_request->checksum_config.validate_response_checksum) {
/* finish the request level checksum validation. */
if (error_code == AWS_OP_SUCCESS && request->request_level_running_response_sum) {
request->did_validate = true;
request->validation_algorithm = request->request_level_running_response_sum->algorithm;
request->checksum_match = s_validate_checksum(
request->request_level_running_response_sum, &request->request_level_response_header_checksum);
if (!request->checksum_match) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Checksum mismatch! (request=%p, response status=%d)",
(void *)meta_request,
(void *)request,
request->send_data.response_status);
error_code = AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH;
}
} else {
request->did_validate = false;
}
aws_checksum_destroy(request->request_level_running_response_sum);
aws_byte_buf_clean_up(&request->request_level_response_header_checksum);
request->request_level_running_response_sum = NULL;
}
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
if (request->synced_data.cancellable_http_stream) {
aws_linked_list_remove(&request->cancellable_http_streams_list_node);
request->synced_data.cancellable_http_stream = NULL;
}
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
s_s3_meta_request_send_request_finish(connection, stream, error_code);
}
static void s_s3_meta_request_send_request_finish(
struct aws_s3_connection *connection,
struct aws_http_stream *stream,
int error_code) {
AWS_PRECONDITION(connection);
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
struct aws_s3_meta_request_vtable *vtable = meta_request->vtable;
AWS_PRECONDITION(vtable);
vtable->send_request_finish(connection, stream, error_code);
}
/* Return whether the response to this request might contain an error, even though we got 200 OK.
* see: https://repost.aws/knowledge-center/s3-resolve-200-internalerror */
static bool s_should_check_for_error_despite_200_OK(const struct aws_s3_request *request) {
/* We handle async error for every thing EXCEPT GetObject.
*
* Note that we check the aws_s3_request_type (not the aws_s3_meta_request_type),
* in case someone is using a DEFAULT meta-request to send GetObject */
if (request->request_type == AWS_S3_REQUEST_TYPE_GET_OBJECT) {
return false;
}
return true;
}
/**
* Check the response detail, returns:
* - AWS_ERROR_SUCCESS for successfully response
* - AWS_ERROR_S3_NON_RECOVERABLE_ASYNC_ERROR 200 response with error in the body that is non-recoverable
* - AWS_ERROR_S3_INVALID_RESPONSE_STATUS for all other non-recoverable response.
* - Specific error code for recoverable response.
*/
static int s_s3_meta_request_error_code_from_response(struct aws_s3_request *request) {
AWS_PRECONDITION(request);
int error_code_from_status = s_s3_meta_request_error_code_from_response_status(request->send_data.response_status);
/* Response body might be XML with an <Error><Code> inside.
* The is very likely when status-code is bad.
* In some cases, it's even possible after 200 OK. */
int error_code_from_xml = AWS_ERROR_SUCCESS;
if (error_code_from_status != AWS_ERROR_SUCCESS || s_should_check_for_error_despite_200_OK(request)) {
if (request->send_data.response_body.len > 0) {
/* Attempt to read as XML, it's fine if this fails. */
struct aws_byte_cursor xml_doc = aws_byte_cursor_from_buf(&request->send_data.response_body);
struct aws_byte_cursor error_code_string = {0};
const char *xml_path[] = {"Error", "Code", NULL};
if (aws_xml_get_body_at_path(request->allocator, xml_doc, xml_path, &error_code_string) == AWS_OP_SUCCESS) {
/* Found an <Error><Code> string! Map it to CRT error code if retry-able. */
error_code_from_xml =
aws_s3_crt_error_code_from_recoverable_server_error_code_string(error_code_string);
}
}
}
if (error_code_from_status == AWS_ERROR_SUCCESS) {
/* Status-code was OK, so assume everything's good, unless we found an <Error><Code> in the XML */
switch (error_code_from_xml) {
case AWS_ERROR_SUCCESS:
return AWS_ERROR_SUCCESS;
case AWS_ERROR_UNKNOWN:
return AWS_ERROR_S3_NON_RECOVERABLE_ASYNC_ERROR;
default:
return error_code_from_xml;
}
} else {
/* Return error based on status-code, unless we got something more specific from XML */
switch (error_code_from_xml) {
case AWS_ERROR_SUCCESS:
return error_code_from_status;
case AWS_ERROR_UNKNOWN:
return error_code_from_status;
default:
return error_code_from_xml;
}
}
}
void aws_s3_meta_request_send_request_finish_default(
struct aws_s3_connection *connection,
struct aws_http_stream *stream,
int error_code) {
struct aws_s3_request *request = connection->request;
AWS_PRECONDITION(request);
struct aws_s3_meta_request *meta_request = request->meta_request;
AWS_PRECONDITION(meta_request);
struct aws_s3_client *client = meta_request->client;
AWS_PRECONDITION(client);
int response_status = request->send_data.response_status;
/* If our error code is currently success, then we have some other calls to make that could still indicate a
* failure. */
if (error_code == AWS_ERROR_SUCCESS) {
error_code = s_s3_meta_request_error_code_from_response(request);
if (error_code != AWS_ERROR_SUCCESS) {
aws_raise_error(error_code);
}
}
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Request %p finished with error code %d (%s) and response status %d",
(void *)meta_request,
(void *)request,
error_code,
aws_error_debug_str(error_code),
response_status);
enum aws_s3_connection_finish_code finish_code = AWS_S3_CONNECTION_FINISH_CODE_FAILED;
if (error_code == AWS_ERROR_SUCCESS) {
finish_code = AWS_S3_CONNECTION_FINISH_CODE_SUCCESS;
} else {
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
bool meta_request_finishing = aws_s3_meta_request_has_finish_result_synced(meta_request);
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
/* If the request failed due to an invalid (ie: unrecoverable) response status, or the meta request already
* has a result, then make sure that this request isn't retried. */
if (error_code == AWS_ERROR_S3_INVALID_RESPONSE_STATUS ||
error_code == AWS_ERROR_S3_INTERNAL_PART_SIZE_MISMATCH_RETRYING_WITH_RANGE ||
error_code == AWS_ERROR_S3_NON_RECOVERABLE_ASYNC_ERROR ||
error_code == AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH || meta_request_finishing) {
finish_code = AWS_S3_CONNECTION_FINISH_CODE_FAILED;
if (error_code == AWS_ERROR_S3_INTERNAL_PART_SIZE_MISMATCH_RETRYING_WITH_RANGE) {
/* Log at info level instead of error as it's expected and not a fatal error */
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p Cancelling the request because of error %d (%s). (request=%p, response status=%d)",
(void *)meta_request,
error_code,
aws_error_str(error_code),
(void *)request,
response_status);
} else {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Meta request cannot recover from error %d (%s). (request=%p, response status=%d)",
(void *)meta_request,
error_code,
aws_error_str(error_code),
(void *)request,
response_status);
}
} else {
if (error_code == AWS_ERROR_HTTP_RESPONSE_FIRST_BYTE_TIMEOUT) {
/* Log at info level instead of error as it's somewhat expected. */
AWS_LOGF_INFO(
AWS_LS_S3_META_REQUEST,
"id=%p Request failed from error %d (%s). (request=%p). Try to setup a retry.",
(void *)meta_request,
error_code,
aws_error_str(error_code),
(void *)request);
} else {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Request failed from error %d (%s). (request=%p, response status=%d). Try to setup a "
"retry.",
(void *)meta_request,
error_code,
aws_error_str(error_code),
(void *)request,
response_status);
}
/* Otherwise, set this up for a retry if the meta request is active. */
finish_code = AWS_S3_CONNECTION_FINISH_CODE_RETRY;
}
}
if (stream != NULL) {
aws_http_stream_release(stream);
stream = NULL;
}
aws_s3_client_notify_connection_finished(client, connection, error_code, finish_code);
}
void aws_s3_meta_request_finished_request(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request,
int error_code) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_PRECONDITION(meta_request->vtable->finished_request);
meta_request->vtable->finished_request(meta_request, request, error_code);
}
/* Pushes a request into the body streaming priority queue. Derived meta request types should not call this--they
* should instead call aws_s3_meta_request_stream_response_body_synced.*/
static void s_s3_meta_request_body_streaming_push_synced(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request);
/* Pops the next available request from the body streaming priority queue. If the parts previous the next request in
* the priority queue have not been placed in the priority queue yet, the priority queue will remain the same, and
* NULL will be returned. (Should not be needed to be called by derived types.) */
static struct aws_s3_request *s_s3_meta_request_body_streaming_pop_next_synced(
struct aws_s3_meta_request *meta_request);
static void s_s3_meta_request_event_delivery_task(struct aws_task *task, void *arg, enum aws_task_status task_status);
void aws_s3_meta_request_stream_response_body_synced(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request) {
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(request);
AWS_PRECONDITION(request->part_number > 0);
/* Push it into the priority queue. */
s_s3_meta_request_body_streaming_push_synced(meta_request, request);
struct aws_s3_client *client = meta_request->client;
AWS_PRECONDITION(client);
aws_atomic_fetch_add(&client->stats.num_requests_stream_queued_waiting, 1);
/* Grab any requests that can be streamed back to the caller
* and send them for delivery on io_event_loop thread. */
uint32_t num_streaming_requests = 0;
struct aws_s3_request *next_streaming_request;
while ((next_streaming_request = s_s3_meta_request_body_streaming_pop_next_synced(meta_request)) != NULL) {
struct aws_s3_meta_request_event event = {.type = AWS_S3_META_REQUEST_EVENT_RESPONSE_BODY};
event.u.response_body.completed_request = next_streaming_request;
aws_s3_meta_request_add_event_for_delivery_synced(meta_request, &event);
++num_streaming_requests;
}
if (num_streaming_requests == 0) {
return;
}
aws_atomic_fetch_add(&client->stats.num_requests_streaming_response, num_streaming_requests);
aws_atomic_fetch_sub(&client->stats.num_requests_stream_queued_waiting, num_streaming_requests);
meta_request->synced_data.num_parts_delivery_sent += num_streaming_requests;
}
void aws_s3_meta_request_add_event_for_delivery_synced(
struct aws_s3_meta_request *meta_request,
const struct aws_s3_meta_request_event *event) {
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
aws_array_list_push_back(&meta_request->synced_data.event_delivery_array, event);
/* If the array was empty before, schedule task to deliver all events in the array.
* If the array already had things in it, then the task is already scheduled and will run soon. */
if (aws_array_list_length(&meta_request->synced_data.event_delivery_array) == 1) {
aws_s3_meta_request_acquire(meta_request);
aws_task_init(
&meta_request->synced_data.event_delivery_task,
s_s3_meta_request_event_delivery_task,
meta_request,
"s3_meta_request_event_delivery");
aws_event_loop_schedule_task_now(meta_request->io_event_loop, &meta_request->synced_data.event_delivery_task);
}
}
bool aws_s3_meta_request_are_events_out_for_delivery_synced(struct aws_s3_meta_request *meta_request) {
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
return aws_array_list_length(&meta_request->synced_data.event_delivery_array) > 0 ||
meta_request->synced_data.event_delivery_active;
}
void aws_s3_meta_request_cancel_cancellable_requests_synced(struct aws_s3_meta_request *meta_request, int error_code) {
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
while (!aws_linked_list_empty(&meta_request->synced_data.cancellable_http_streams_list)) {
struct aws_linked_list_node *request_node =
aws_linked_list_pop_front(&meta_request->synced_data.cancellable_http_streams_list);
struct aws_s3_request *request =
AWS_CONTAINER_OF(request_node, struct aws_s3_request, cancellable_http_streams_list_node);
AWS_ASSERT(!request->always_send);
aws_http_stream_cancel(request->synced_data.cancellable_http_stream, error_code);
request->synced_data.cancellable_http_stream = NULL;
}
}
static struct aws_s3_request_metrics *s_s3_request_finish_up_and_release_metrics(
struct aws_s3_request_metrics *metrics,
struct aws_s3_meta_request *meta_request) {
if (metrics != NULL) {
/* Request is done streaming the body, complete the metrics for the request now. */
if (metrics->time_metrics.end_timestamp_ns == -1) {
aws_high_res_clock_get_ticks((uint64_t *)&metrics->time_metrics.end_timestamp_ns);
metrics->time_metrics.total_duration_ns =
metrics->time_metrics.end_timestamp_ns - metrics->time_metrics.start_timestamp_ns;
}
if (meta_request->telemetry_callback != NULL) {
/* We already in the meta request event thread, invoke the telemetry callback directly */
meta_request->telemetry_callback(meta_request, metrics, meta_request->user_data);
}
aws_s3_request_metrics_release(metrics);
}
return NULL;
}
/* Deliver events in event_delivery_array.
* This task runs on the meta-request's io_event_loop thread. */
static void s_s3_meta_request_event_delivery_task(struct aws_task *task, void *arg, enum aws_task_status task_status) {
(void)task;
(void)task_status;
struct aws_s3_meta_request *meta_request = arg;
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
struct aws_s3_client *client = meta_request->client;
AWS_PRECONDITION(client);
/* Client owns this event loop group. A cancel should not be possible. */
AWS_ASSERT(task_status == AWS_TASK_STATUS_RUN_READY);
/* Swap contents of synced_data.event_delivery_array into this pre-allocated array-list, then process events */
struct aws_array_list *event_delivery_array = &meta_request->io_threaded_data.event_delivery_array;
AWS_FATAL_ASSERT(aws_array_list_length(event_delivery_array) == 0);
/* If an error occurs, don't fire callbacks anymore. */
int error_code = AWS_ERROR_SUCCESS;
uint32_t num_parts_delivered = 0;
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
aws_array_list_swap_contents(event_delivery_array, &meta_request->synced_data.event_delivery_array);
meta_request->synced_data.event_delivery_active = true;
if (aws_s3_meta_request_has_finish_result_synced(meta_request)) {
error_code = AWS_ERROR_S3_CANCELED;
}
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
/* Deliver all events */
for (size_t event_i = 0; event_i < aws_array_list_length(event_delivery_array); ++event_i) {
struct aws_s3_meta_request_event event;
aws_array_list_get_at(event_delivery_array, &event, event_i);
switch (event.type) {
case AWS_S3_META_REQUEST_EVENT_RESPONSE_BODY: {
struct aws_s3_request *request = event.u.response_body.completed_request;
AWS_ASSERT(meta_request == request->meta_request);
struct aws_byte_cursor response_body = aws_byte_cursor_from_buf(&request->send_data.response_body);
AWS_ASSERT(request->part_number >= 1);
if (error_code == AWS_ERROR_SUCCESS && response_body.len > 0) {
if (meta_request->meta_request_level_running_response_sum) {
if (aws_checksum_update(
meta_request->meta_request_level_running_response_sum, &response_body)) {
error_code = aws_last_error();
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Failed to update checksum. last error:%s",
(void *)meta_request,
aws_error_name(error_code));
}
}
if (error_code == AWS_ERROR_SUCCESS) {
if (meta_request->recv_file) {
/* Write the data directly to the file. No need to seek, since the event will always be
* delivered with the right order. */
if (fwrite((void *)response_body.ptr, response_body.len, 1, meta_request->recv_file) < 1) {
int errno_value = ferror(meta_request->recv_file) ? errno : 0; /* Always cache errno */
aws_translate_and_raise_io_error_or(errno_value, AWS_ERROR_FILE_WRITE_FAILURE);
error_code = aws_last_error();
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Failed writing to file. errno:%d. aws-error:%s",
(void *)meta_request,
errno_value,
aws_error_name(error_code));
}
if (meta_request->client->enable_read_backpressure) {
aws_s3_meta_request_increment_read_window(meta_request, response_body.len);
}
} else if (
meta_request->body_callback != NULL &&
meta_request->body_callback(
meta_request, &response_body, request->part_range_start, meta_request->user_data)) {
error_code = aws_last_error_or_unknown();
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p Response body callback raised error %d (%s).",
(void *)meta_request,
error_code,
aws_error_str(error_code));
}
}
}
aws_atomic_fetch_sub(&client->stats.num_requests_streaming_response, 1);
++num_parts_delivered;
request->send_data.metrics =
s_s3_request_finish_up_and_release_metrics(request->send_data.metrics, meta_request);
aws_s3_request_release(request);
} break;
case AWS_S3_META_REQUEST_EVENT_PROGRESS: {
if (error_code == AWS_ERROR_SUCCESS && meta_request->progress_callback != NULL) {
/* Don't report 0 byte progress events.
* The reasoning behind this is:
*
* In some code paths, when no data is transferred, there are no progress events,
* but in other code paths there might be one progress event of 0 bytes.
* We want to be consistent, either:
* - REPORT AT LEAST ONCE: even if no data is being transferred.
* This would require finding every code path where no progress events are sent,
* and sending an appropriate progress event, even if it's for 0 bytes.
* One example of ending early is: when resuming a paused upload,
* we do ListParts on the UploadID, and if that 404s we assume the
* previous "paused" meta-request actually completed,
* and so we immediately end the "resuming" meta-request
* as successful without sending any further HTTP requests.
* It would be tough to accurately report progress here because
* we don't know the total size, since we never read the request body,
* and didn't get any info about the previous upload.
* OR
* - NEVER REPORT ZERO BYTES: even if that means no progress events at all.
* This is easy to do. We'd only send progress events when data is transferred,
* and if a 0 byte event slips through somehow, just check before firing the callback.
* Since the NEVER REPORT ZERO BYTES path is simpler to implement, we went with that. */
if (event.u.progress.info.bytes_transferred > 0) {
meta_request->progress_callback(meta_request, &event.u.progress.info, meta_request->user_data);
}
}
} break;
case AWS_S3_META_REQUEST_EVENT_TELEMETRY: {
struct aws_s3_request_metrics *metrics = event.u.telemetry.metrics;
AWS_FATAL_ASSERT(meta_request->telemetry_callback != NULL);
AWS_FATAL_ASSERT(metrics != NULL);
event.u.telemetry.metrics =
s_s3_request_finish_up_and_release_metrics(event.u.telemetry.metrics, meta_request);
} break;
default:
AWS_FATAL_ASSERT(false);
}
}
/* Done delivering events */
aws_array_list_clear(event_delivery_array);
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
if (error_code != AWS_ERROR_SUCCESS) {
aws_s3_meta_request_set_fail_synced(meta_request, NULL, error_code);
}
meta_request->synced_data.num_parts_delivery_completed += num_parts_delivered;
meta_request->synced_data.event_delivery_active = false;
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
aws_s3_client_schedule_process_work(client);
aws_s3_meta_request_release(meta_request);
}
static void s_s3_meta_request_body_streaming_push_synced(
struct aws_s3_meta_request *meta_request,
struct aws_s3_request *request) {
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(request);
AWS_ASSERT(request->meta_request == meta_request);
aws_s3_request_acquire(request);
aws_priority_queue_push(&meta_request->synced_data.pending_body_streaming_requests, &request);
}
static struct aws_s3_request *s_s3_meta_request_body_streaming_pop_next_synced(
struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
ASSERT_SYNCED_DATA_LOCK_HELD(meta_request);
if (0 == aws_priority_queue_size(&meta_request->synced_data.pending_body_streaming_requests)) {
return NULL;
}
struct aws_s3_request **top_request = NULL;
aws_priority_queue_top(&meta_request->synced_data.pending_body_streaming_requests, (void **)&top_request);
AWS_ASSERT(top_request);
AWS_FATAL_ASSERT(*top_request);
if ((*top_request)->part_number != meta_request->synced_data.next_streaming_part) {
return NULL;
}
struct aws_s3_request *request = NULL;
aws_priority_queue_pop(&meta_request->synced_data.pending_body_streaming_requests, (void **)&request);
++meta_request->synced_data.next_streaming_part;
return request;
}
void aws_s3_meta_request_finish(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(meta_request->vtable);
AWS_PRECONDITION(meta_request->vtable->finish);
meta_request->vtable->finish(meta_request);
}
void aws_s3_meta_request_finish_default(struct aws_s3_meta_request *meta_request) {
AWS_PRECONDITION(meta_request);
bool already_finished = false;
struct aws_linked_list release_request_list;
aws_linked_list_init(&release_request_list);
aws_simple_completion_callback *pending_async_write_waker = NULL;
void *pending_async_write_waker_user_data = NULL;
struct aws_s3_meta_request_result finish_result;
AWS_ZERO_STRUCT(finish_result);
/* BEGIN CRITICAL SECTION */
{
aws_s3_meta_request_lock_synced_data(meta_request);
if (meta_request->synced_data.state == AWS_S3_META_REQUEST_STATE_FINISHED) {
already_finished = true;
goto unlock;
}
meta_request->synced_data.state = AWS_S3_META_REQUEST_STATE_FINISHED;
/* Clean out the pending-stream-to-caller priority queue*/
while (aws_priority_queue_size(&meta_request->synced_data.pending_body_streaming_requests) > 0) {
struct aws_s3_request *request = NULL;
aws_priority_queue_pop(&meta_request->synced_data.pending_body_streaming_requests, (void **)&request);
AWS_FATAL_ASSERT(request != NULL);
aws_linked_list_push_back(&release_request_list, &request->node);
}
/* Clean out any pending async-write future */
if (meta_request->synced_data.async_write.waker != NULL) {
pending_async_write_waker = meta_request->synced_data.async_write.waker;
pending_async_write_waker_user_data = meta_request->synced_data.async_write.waker_user_data;
meta_request->synced_data.async_write.waker = NULL;
meta_request->synced_data.async_write.waker_user_data = NULL;
}
finish_result = meta_request->synced_data.finish_result;
AWS_ZERO_STRUCT(meta_request->synced_data.finish_result);
unlock:
aws_s3_meta_request_unlock_synced_data(meta_request);
}
/* END CRITICAL SECTION */
if (already_finished) {
return;
}
if (pending_async_write_waker != NULL) {
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST,
"id=%p: Invoking write waker, due to meta request's early finish",
(void *)meta_request);
pending_async_write_waker(pending_async_write_waker_user_data);
}
if (meta_request->recv_file) {
fclose(meta_request->recv_file);
meta_request->recv_file = NULL;
if (finish_result.error_code && meta_request->recv_file_delete_on_failure) {
aws_file_delete(meta_request->recv_filepath);
}
}
while (!aws_linked_list_empty(&release_request_list)) {
struct aws_linked_list_node *request_node = aws_linked_list_pop_front(&release_request_list);
struct aws_s3_request *release_request = AWS_CONTAINER_OF(request_node, struct aws_s3_request, node);
AWS_FATAL_ASSERT(release_request != NULL);
/* This pending-body-streaming request was never moved to the event-delivery queue,
* so its metrics were never finished. Finish them now. */
release_request->send_data.metrics =
s_s3_request_finish_up_and_release_metrics(release_request->send_data.metrics, meta_request);
aws_s3_request_release(release_request);
}
if (meta_request->headers_callback && finish_result.error_response_headers) {
if (meta_request->headers_callback(
meta_request,
finish_result.error_response_headers,
finish_result.response_status,
meta_request->user_data)) {
finish_result.error_code = aws_last_error_or_unknown();
}
meta_request->headers_callback = NULL;
}
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p Meta request finished with error code %d (%s)",
(void *)meta_request,
finish_result.error_code,
aws_error_str(finish_result.error_code));
/* As the meta request has been finished with any HTTP message, we can safely release the http message that
* hold. So that, the downstream high level language doesn't need to wait for shutdown to clean related resource
* (eg: input stream) */
meta_request->request_body_async_stream = aws_async_input_stream_release(meta_request->request_body_async_stream);
meta_request->request_body_parallel_stream =
aws_parallel_input_stream_release(meta_request->request_body_parallel_stream);
meta_request->initial_request_message = aws_http_message_release(meta_request->initial_request_message);
if (meta_request->checksum_config.validate_response_checksum) {
/* validate checksum finish */
s_validate_meta_request_checksum_on_finish(meta_request, &finish_result);
}
if (meta_request->finish_callback != NULL) {
meta_request->finish_callback(meta_request, &finish_result, meta_request->user_data);
}
aws_s3_meta_request_result_clean_up(meta_request, &finish_result);
aws_s3_endpoint_release(meta_request->endpoint);
meta_request->endpoint = NULL;
meta_request->io_event_loop = NULL;
}
struct aws_future_bool *aws_s3_meta_request_read_body(
struct aws_s3_meta_request *meta_request,
uint64_t offset,
struct aws_byte_buf *buffer) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(buffer);
/* If async-stream, simply call read_to_fill() */
if (meta_request->request_body_async_stream != NULL) {
return aws_async_input_stream_read_to_fill(meta_request->request_body_async_stream, buffer);
}
/* If parallel-stream, simply call read(), which must fill the buffer and/or EOF */
if (meta_request->request_body_parallel_stream != NULL) {
return aws_parallel_input_stream_read(meta_request->request_body_parallel_stream, offset, buffer);
}
/* Further techniques are synchronous... */
struct aws_future_bool *synchronous_read_future = aws_future_bool_new(meta_request->allocator);
/* If using async-writes, call function which fills the buffer and/or hits EOF */
if (meta_request->request_body_using_async_writes == true) {
bool eof = s_s3_meta_request_read_from_pending_async_writes(meta_request, buffer);
aws_future_bool_set_result(synchronous_read_future, eof);
return synchronous_read_future;
}
/* Else synchronous aws_input_stream */
struct aws_input_stream *synchronous_stream =
aws_http_message_get_body_stream(meta_request->initial_request_message);
AWS_FATAL_ASSERT(synchronous_stream);
/* Keep calling read() until we fill the buffer, or hit EOF */
struct aws_stream_status status = {.is_end_of_stream = false, .is_valid = true};
while ((buffer->len < buffer->capacity) && !status.is_end_of_stream) {
/* Read from stream */
if (aws_input_stream_read(synchronous_stream, buffer) != AWS_OP_SUCCESS) {
aws_future_bool_set_error(synchronous_read_future, aws_last_error());
goto synchronous_read_done;
}
/* Check if stream is done */
if (aws_input_stream_get_status(synchronous_stream, &status) != AWS_OP_SUCCESS) {
aws_future_bool_set_error(synchronous_read_future, aws_last_error());
goto synchronous_read_done;
}
}
aws_future_bool_set_result(synchronous_read_future, status.is_end_of_stream);
synchronous_read_done:
return synchronous_read_future;
}
void aws_s3_meta_request_result_setup(
struct aws_s3_meta_request *meta_request,
struct aws_s3_meta_request_result *result,
struct aws_s3_request *failed_request,
int response_status,
int error_code) {
if (failed_request != NULL) {
if (failed_request->send_data.response_headers != NULL) {
result->error_response_headers = failed_request->send_data.response_headers;
aws_http_headers_acquire(result->error_response_headers);
}
if (failed_request->send_data.response_body.capacity > 0) {
result->error_response_body = aws_mem_calloc(meta_request->allocator, 1, sizeof(struct aws_byte_buf));
aws_byte_buf_init_copy(
result->error_response_body, meta_request->allocator, &failed_request->send_data.response_body);
}
result->error_response_operation_name =
aws_string_new_from_string(meta_request->allocator, failed_request->operation_name);
}
result->response_status = response_status;
result->error_code = error_code;
}
struct aws_s3_meta_request_poll_write_result aws_s3_meta_request_poll_write(
struct aws_s3_meta_request *meta_request,
struct aws_byte_cursor data,
bool eof,
aws_simple_completion_callback *waker,
void *user_data) {
AWS_ASSERT(meta_request);
AWS_ASSERT(waker);
struct aws_s3_meta_request_poll_write_result result;
AWS_ZERO_STRUCT(result);
/* Set this true, while lock is held, if we're ready to send data */
bool ready_to_send = false;
/* Set this true, while lock is held, if write() was called illegally
* and the meta-request should terminate */
bool illegal_usage_terminate_meta_request = false;
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
if (aws_s3_meta_request_has_finish_result_synced(meta_request)) {
/* The meta-request is already complete */
AWS_LOGF_DEBUG(
AWS_LS_S3_META_REQUEST,
"id=%p: Ignoring write(), the meta request is already complete.",
(void *)meta_request);
result.error_code = AWS_ERROR_S3_REQUEST_HAS_COMPLETED;
} else if (!meta_request->request_body_using_async_writes) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Illegal call to write(). The meta-request must be configured to send-using-data-writes.",
(void *)meta_request);
illegal_usage_terminate_meta_request = true;
} else if (meta_request->synced_data.async_write.waker != NULL) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST,
"id=%p: Illegal call to write(). A waker is already registered.",
(void *)meta_request);
illegal_usage_terminate_meta_request = true;
} else if (meta_request->synced_data.async_write.eof) {
AWS_LOGF_ERROR(
AWS_LS_S3_META_REQUEST, "id=%p: Illegal call to write(). EOF already set.", (void *)meta_request);
illegal_usage_terminate_meta_request = true;
} else if (meta_request->synced_data.async_write.buffered_data.len == meta_request->part_size) {
/* Can't write more until buffered data is sent. Store waker */
AWS_LOGF_TRACE(AWS_LS_S3_META_REQUEST, "id=%p: write() pending, waker registered ...", (void *)meta_request);
meta_request->synced_data.async_write.waker = waker;
meta_request->synced_data.async_write.waker_user_data = user_data;
result.is_pending = true;
} else {
/* write call is OK */
/* If we don't already have a buffer, grab one from the pool. */
if (meta_request->synced_data.async_write.buffered_data_ticket == NULL) {
/* NOTE: we acquire a forced-buffer because there's a risk of deadlock if we
* waited for a normal ticket reservation, respecting the pool's memory limit.
* (See "test_s3_many_async_uploads_without_data" for description of deadlock scenario) */
meta_request->synced_data.async_write.buffered_data = aws_s3_buffer_pool_acquire_forced_buffer(
meta_request->client->buffer_pool,
meta_request->part_size,
&meta_request->synced_data.async_write.buffered_data_ticket /*out_new_ticket*/);
}
/* Copy as much data as we can into the buffer */
struct aws_byte_cursor processed_data =
aws_byte_buf_write_to_capacity(&meta_request->synced_data.async_write.buffered_data, &data);
/* Don't store EOF unless we've consumed all data */
if ((data.len == 0) && eof) {
meta_request->synced_data.async_write.eof = true;
}
/* This write makes us ready to send (EOF, or we have enough data now to send at least 1 part) */
if (meta_request->synced_data.async_write.eof ||
meta_request->synced_data.async_write.buffered_data.len == meta_request->part_size) {
meta_request->synced_data.async_write.ready_to_send = true;
ready_to_send = true;
}
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST,
"id=%p: write(data=%zu, eof=%d) processed=%zu remainder:%zu previously-buffered=%zu. %s"
"part...",
(void *)meta_request,
data.len + processed_data.len /*original data.len*/,
eof /*eof*/,
processed_data.len /*processed*/,
data.len /*remainder*/,
meta_request->synced_data.async_write.buffered_data.len - processed_data.len /*previously-buffered*/,
ready_to_send ? "Ready to upload part..." : "Not enough data to upload." /*msg*/);
result.bytes_processed = processed_data.len;
}
if (illegal_usage_terminate_meta_request) {
result.error_code = AWS_ERROR_INVALID_STATE;
aws_s3_meta_request_set_fail_synced(meta_request, NULL, AWS_ERROR_INVALID_STATE);
}
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
if (ready_to_send || illegal_usage_terminate_meta_request) {
/* Schedule the work task, to continue processing the meta-request */
aws_s3_client_schedule_process_work(meta_request->client);
}
/* Assert that exactly 1 result field is set (OR they're all zero because data.len was zero) */
AWS_ASSERT(
(result.is_pending ^ result.error_code ^ result.bytes_processed) ||
(!result.is_pending && !result.error_code && !result.bytes_processed && !data.len));
return result;
}
struct aws_s3_meta_request_async_write_job {
struct aws_s3_meta_request *meta_request;
struct aws_future_void *write_future;
struct aws_byte_cursor data;
bool eof;
};
/* Do async job where, under the hood, aws_s3_meta_request_write()
* calls aws_s3_meta_request_poll_write() in a loop until all data is written */
static void s_s3_meta_request_async_write_job_loop(void *user_data) {
struct aws_s3_meta_request_async_write_job *job = user_data;
int error_code = 0;
/* Call poll_write() until we can't anymore.
* It MUST be called at least once, hence the do-while */
do {
struct aws_s3_meta_request_poll_write_result poll_result = aws_s3_meta_request_poll_write(
job->meta_request,
job->data,
job->eof,
s_s3_meta_request_async_write_job_loop /*waker*/,
job /*user_data*/);
if (poll_result.is_pending) {
/* We'll resume this loop when waker fires */
return;
} else if (poll_result.error_code) {
error_code = poll_result.error_code;
} else {
aws_byte_cursor_advance(&job->data, poll_result.bytes_processed);
}
} while (error_code == AWS_ERROR_SUCCESS && job->data.len > 0);
/* cleanup */
struct aws_allocator *allocator = job->meta_request->allocator;
if (error_code) {
aws_future_void_set_error(job->write_future, error_code);
} else {
aws_future_void_set_result(job->write_future);
}
aws_future_void_release(job->write_future);
aws_mem_release(allocator, job);
}
struct aws_future_void *aws_s3_meta_request_write(
struct aws_s3_meta_request *meta_request,
struct aws_byte_cursor data,
bool eof) {
struct aws_future_void *write_future = aws_future_void_new(meta_request->allocator);
struct aws_s3_meta_request_async_write_job *job =
aws_mem_calloc(meta_request->allocator, 1, sizeof(struct aws_s3_meta_request_async_write_job));
job->meta_request = meta_request;
job->write_future = aws_future_void_acquire(write_future);
job->data = data;
job->eof = eof;
s_s3_meta_request_async_write_job_loop(job);
return write_future;
}
/* For async-writes this is only called after aws_s3_meta_request_poll_write()
* already filled a buffer with enough data for the next part.
* In fact, the dest buffer being passed in is the same one we already filled. */
static bool s_s3_meta_request_read_from_pending_async_writes(
struct aws_s3_meta_request *meta_request,
struct aws_byte_buf *dest) {
/* BEGIN CRITICAL SECTION */
aws_s3_meta_request_lock_synced_data(meta_request);
/* Assert that dest buffer is in fact the same one we already filled */
AWS_ASSERT(
meta_request->synced_data.async_write.buffered_data.len == dest->len &&
meta_request->synced_data.async_write.buffered_data.buffer == dest->buffer);
(void)dest;
/* Assert that ticket for this buffer is no longer owned by the aws_s3_meta_request
* (ownership was moved to aws_s3_request) */
AWS_ASSERT(meta_request->synced_data.async_write.buffered_data_ticket == NULL);
/* Assert we filled the dest buffer, unless this is the final write */
AWS_ASSERT(dest->len == dest->capacity || meta_request->synced_data.async_write.eof);
/* Reset things so we're ready to receive the next aws_s3_meta_request_poll_write() */
meta_request->synced_data.async_write.ready_to_send = false;
AWS_ZERO_STRUCT(meta_request->synced_data.async_write.buffered_data);
bool eof = meta_request->synced_data.async_write.eof;
aws_simple_completion_callback *waker = meta_request->synced_data.async_write.waker;
meta_request->synced_data.async_write.waker = NULL;
void *waker_user_data = meta_request->synced_data.async_write.waker_user_data;
meta_request->synced_data.async_write.waker_user_data = NULL;
aws_s3_meta_request_unlock_synced_data(meta_request);
/* END CRITICAL SECTION */
/* Don't hold locks while triggering the user's waker callback */
if (waker != NULL) {
AWS_LOGF_TRACE(
AWS_LS_S3_META_REQUEST, "id=%p: Invoking write waker. Ready for more data", (void *)meta_request);
waker(waker_user_data);
}
return eof;
}
void aws_s3_meta_request_result_clean_up(
struct aws_s3_meta_request *meta_request,
struct aws_s3_meta_request_result *result) {
AWS_PRECONDITION(meta_request);
AWS_PRECONDITION(result);
aws_http_headers_release(result->error_response_headers);
if (result->error_response_body != NULL) {
aws_byte_buf_clean_up(result->error_response_body);
aws_mem_release(meta_request->allocator, result->error_response_body);
}
aws_string_destroy(result->error_response_operation_name);
AWS_ZERO_STRUCT(*result);
}
bool aws_s3_meta_request_checksum_config_has_algorithm(
struct aws_s3_meta_request *meta_request,
enum aws_s3_checksum_algorithm algorithm) {
AWS_PRECONDITION(meta_request);
switch (algorithm) {
case AWS_SCA_CRC64NVME:
return meta_request->checksum_config.response_checksum_algorithms.crc64nvme;
case AWS_SCA_CRC32C:
return meta_request->checksum_config.response_checksum_algorithms.crc32c;
case AWS_SCA_CRC32:
return meta_request->checksum_config.response_checksum_algorithms.crc32;
case AWS_SCA_SHA1:
return meta_request->checksum_config.response_checksum_algorithms.sha1;
case AWS_SCA_SHA256:
return meta_request->checksum_config.response_checksum_algorithms.sha256;
default:
return false;
}
}
|