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
|
/** @file
A brief file description
@section license License
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#pragma once
#include <cassert>
#include "tscore/Arena.h"
#include "tscore/CryptoHash.h"
#include "tscore/HTTPVersion.h"
#include "MIME.h"
#include "URL.h"
#include "tscore/ink_apidefs.h"
class Http2HeaderTable;
enum HTTPStatus {
HTTP_STATUS_NONE = 0,
HTTP_STATUS_CONTINUE = 100,
HTTP_STATUS_SWITCHING_PROTOCOL = 101,
HTTP_STATUS_EARLY_HINTS = 103,
HTTP_STATUS_OK = 200,
HTTP_STATUS_CREATED = 201,
HTTP_STATUS_ACCEPTED = 202,
HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION = 203,
HTTP_STATUS_NO_CONTENT = 204,
HTTP_STATUS_RESET_CONTENT = 205,
HTTP_STATUS_PARTIAL_CONTENT = 206,
HTTP_STATUS_MULTIPLE_CHOICES = 300,
HTTP_STATUS_MOVED_PERMANENTLY = 301,
HTTP_STATUS_MOVED_TEMPORARILY = 302,
HTTP_STATUS_SEE_OTHER = 303,
HTTP_STATUS_NOT_MODIFIED = 304,
HTTP_STATUS_USE_PROXY = 305,
HTTP_STATUS_TEMPORARY_REDIRECT = 307,
HTTP_STATUS_PERMANENT_REDIRECT = 308,
HTTP_STATUS_BAD_REQUEST = 400,
HTTP_STATUS_UNAUTHORIZED = 401,
HTTP_STATUS_PAYMENT_REQUIRED = 402,
HTTP_STATUS_FORBIDDEN = 403,
HTTP_STATUS_NOT_FOUND = 404,
HTTP_STATUS_METHOD_NOT_ALLOWED = 405,
HTTP_STATUS_NOT_ACCEPTABLE = 406,
HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED = 407,
HTTP_STATUS_REQUEST_TIMEOUT = 408,
HTTP_STATUS_CONFLICT = 409,
HTTP_STATUS_GONE = 410,
HTTP_STATUS_LENGTH_REQUIRED = 411,
HTTP_STATUS_PRECONDITION_FAILED = 412,
HTTP_STATUS_REQUEST_ENTITY_TOO_LARGE = 413,
HTTP_STATUS_REQUEST_URI_TOO_LONG = 414,
HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415,
HTTP_STATUS_RANGE_NOT_SATISFIABLE = 416,
HTTP_STATUS_TOO_EARLY = 425,
HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
HTTP_STATUS_NOT_IMPLEMENTED = 501,
HTTP_STATUS_BAD_GATEWAY = 502,
HTTP_STATUS_SERVICE_UNAVAILABLE = 503,
HTTP_STATUS_GATEWAY_TIMEOUT = 504,
HTTP_STATUS_HTTPVER_NOT_SUPPORTED = 505
};
enum HTTPKeepAlive {
HTTP_KEEPALIVE_UNDEFINED = 0,
HTTP_NO_KEEPALIVE,
HTTP_KEEPALIVE,
};
enum HTTPWarningCode {
HTTP_WARNING_CODE_NONE = 0,
HTTP_WARNING_CODE_RESPONSE_STALE = 110,
HTTP_WARNING_CODE_REVALIDATION_FAILED = 111,
HTTP_WARNING_CODE_DISCONNECTED_OPERATION = 112,
HTTP_WARNING_CODE_HERUISTIC_EXPIRATION = 113,
HTTP_WARNING_CODE_TRANSFORMATION_APPLIED = 114,
HTTP_WARNING_CODE_MISC_WARNING = 199
};
/* squid log codes
There is code (e.g. logstats) that depends on these errors coming at the end of this enum */
enum SquidLogCode {
SQUID_LOG_EMPTY = '0',
SQUID_LOG_TCP_HIT = '1',
SQUID_LOG_TCP_DISK_HIT = '2',
SQUID_LOG_TCP_MEM_HIT = '.', // Don't want to change others codes
SQUID_LOG_TCP_MISS = '3',
SQUID_LOG_TCP_EXPIRED_MISS = '4',
SQUID_LOG_TCP_REFRESH_HIT = '5',
SQUID_LOG_TCP_REF_FAIL_HIT = '6',
SQUID_LOG_TCP_REFRESH_MISS = '7',
SQUID_LOG_TCP_CLIENT_REFRESH = '8',
SQUID_LOG_TCP_IMS_HIT = '9',
SQUID_LOG_TCP_IMS_MISS = 'a',
SQUID_LOG_TCP_SWAPFAIL = 'b',
SQUID_LOG_TCP_DENIED = 'c',
SQUID_LOG_TCP_WEBFETCH_MISS = 'd',
SQUID_LOG_TCP_FUTURE_2 = 'f',
SQUID_LOG_TCP_HIT_REDIRECT = '[', // standard redirect
SQUID_LOG_TCP_MISS_REDIRECT = ']', // standard redirect
SQUID_LOG_TCP_HIT_X_REDIRECT = '<', // extended redirect
SQUID_LOG_TCP_MISS_X_REDIRECT = '>', // extended redirect
SQUID_LOG_UDP_HIT = 'g',
SQUID_LOG_UDP_WEAK_HIT = 'h',
SQUID_LOG_UDP_HIT_OBJ = 'i',
SQUID_LOG_UDP_MISS = 'j',
SQUID_LOG_UDP_DENIED = 'k',
SQUID_LOG_UDP_INVALID = 'l',
SQUID_LOG_UDP_RELOADING = 'm',
SQUID_LOG_UDP_FUTURE_1 = 'n',
SQUID_LOG_UDP_FUTURE_2 = 'o',
SQUID_LOG_ERR_READ_TIMEOUT = 'p',
SQUID_LOG_ERR_LIFETIME_EXP = 'q',
SQUID_LOG_ERR_POST_ENTITY_TOO_LARGE = 'L',
SQUID_LOG_ERR_NO_CLIENTS_BIG_OBJ = 'r',
SQUID_LOG_ERR_READ_ERROR = 's',
SQUID_LOG_ERR_CLIENT_ABORT = 't', // Client side abort logging
SQUID_LOG_ERR_CONNECT_FAIL = 'u',
SQUID_LOG_ERR_INVALID_REQ = 'v',
SQUID_LOG_ERR_UNSUP_REQ = 'w',
SQUID_LOG_ERR_INVALID_URL = 'x',
SQUID_LOG_ERR_NO_FDS = 'y',
SQUID_LOG_ERR_DNS_FAIL = 'z',
SQUID_LOG_ERR_NOT_IMPLEMENTED = 'A',
SQUID_LOG_ERR_CANNOT_FETCH = 'B',
SQUID_LOG_ERR_NO_RELAY = 'C',
SQUID_LOG_ERR_DISK_IO = 'D',
SQUID_LOG_ERR_ZERO_SIZE_OBJECT = 'E',
SQUID_LOG_TCP_CF_HIT = 'F', // Collapsed forwarding HIT also known as Read while write hit
SQUID_LOG_ERR_PROXY_DENIED = 'G',
SQUID_LOG_ERR_WEBFETCH_DETECTED = 'H',
SQUID_LOG_ERR_FUTURE_1 = 'I',
SQUID_LOG_ERR_CLIENT_READ_ERROR = 'J', // Client side abort logging
SQUID_LOG_ERR_LOOP_DETECTED = 'K', // Loop or cycle detected, request came back to this server
SQUID_LOG_ERR_UNKNOWN = 'Z'
};
// squid log subcodes
enum SquidSubcode {
SQUID_SUBCODE_EMPTY = '0',
SQUID_SUBCODE_NUM_REDIRECTIONS_EXCEEDED = '1',
};
/* squid hierarchy codes */
enum SquidHierarchyCode {
SQUID_HIER_EMPTY = '0',
SQUID_HIER_NONE = '1',
SQUID_HIER_DIRECT = '2',
SQUID_HIER_SIBLING_HIT = '3',
SQUID_HIER_PARENT_HIT = '4',
SQUID_HIER_DEFAULT_PARENT = '5',
SQUID_HIER_SINGLE_PARENT = '6',
SQUID_HIER_FIRST_UP_PARENT = '7',
SQUID_HIER_NO_PARENT_DIRECT = '8',
SQUID_HIER_FIRST_PARENT_MISS = '9',
SQUID_HIER_LOCAL_IP_DIRECT = 'a',
SQUID_HIER_FIREWALL_IP_DIRECT = 'b',
SQUID_HIER_NO_DIRECT_FAIL = 'c',
SQUID_HIER_SOURCE_FASTEST = 'd',
SQUID_HIER_SIBLING_UDP_HIT_OBJ = 'e',
SQUID_HIER_PARENT_UDP_HIT_OBJ = 'f',
SQUID_HIER_PASSTHROUGH_PARENT = 'g',
SQUID_HIER_SSL_PARENT_MISS = 'h',
SQUID_HIER_INVALID_CODE = 'i',
SQUID_HIER_TIMEOUT_DIRECT = 'j',
SQUID_HIER_TIMEOUT_SIBLING_HIT = 'k',
SQUID_HIER_TIMEOUT_PARENT_HIT = 'l',
SQUID_HIER_TIMEOUT_DEFAULT_PARENT = 'm',
SQUID_HIER_TIMEOUT_SINGLE_PARENT = 'n',
SQUID_HIER_TIMEOUT_FIRST_UP_PARENT = 'o',
SQUID_HIER_TIMEOUT_NO_PARENT_DIRECT = 'p',
SQUID_HIER_TIMEOUT_FIRST_PARENT_MISS = 'q',
SQUID_HIER_TIMEOUT_LOCAL_IP_DIRECT = 'r',
SQUID_HIER_TIMEOUT_FIREWALL_IP_DIRECT = 's',
SQUID_HIER_TIMEOUT_NO_DIRECT_FAIL = 't',
SQUID_HIER_TIMEOUT_SOURCE_FASTEST = 'u',
SQUID_HIER_TIMEOUT_SIBLING_UDP_HIT_OBJ = 'v',
SQUID_HIER_TIMEOUT_PARENT_UDP_HIT_OBJ = 'w',
SQUID_HIER_TIMEOUT_PASSTHROUGH_PARENT = 'x',
SQUID_HIER_TIMEOUT_TIMEOUT_SSL_PARENT_MISS = 'y',
SQUID_HIER_INVALID_ASSIGNED_CODE = 'z'
};
/* squid hit/miss codes */
enum SquidHitMissCode {
SQUID_HIT_RESERVED = '0', // Kinda wonky that this is '0', so skipping 'A' for now
SQUID_HIT_LEVEL_1 = 'B',
SQUID_HIT_LEVEL_2 = 'C',
SQUID_HIT_LEVEL_3 = 'D',
SQUID_HIT_LEVEL_4 = 'E',
SQUID_HIT_LEVEL_5 = 'F',
SQUID_HIT_LEVEL_6 = 'G',
SQUID_HIT_LEVEL_7 = 'H',
SQUID_HIT_LEVEL_8 = 'I',
SQUID_HIT_LEVEl_9 = 'J',
SQUID_MISS_NONE = '1',
SQUID_MISS_HTTP_NON_CACHE = '3',
SQUID_MISS_HTTP_NO_DLE = '5',
SQUID_MISS_HTTP_NO_LE = '6',
SQUID_MISS_HTTP_CONTENT = '7',
SQUID_MISS_PRAGMA_NOCACHE = '8',
SQUID_MISS_PASS = '9',
SQUID_MISS_PRE_EXPIRED = 'a',
SQUID_MISS_ERROR = 'b',
SQUID_MISS_CACHE_BYPASS = 'c',
SQUID_HIT_MISS_INVALID_ASSIGNED_CODE = 'z',
// These are pre-allocated with special semantics, added here for convenience
SQUID_HIT_RAM = SQUID_HIT_LEVEL_1,
SQUID_HIT_SSD = SQUID_HIT_LEVEL_2,
SQUID_HIT_DISK = SQUID_HIT_LEVEL_3,
SQUID_HIT_CLUSTER = SQUID_HIT_LEVEL_4,
SQUID_HIT_NET = SQUID_HIT_LEVEL_5,
SQUID_HIT_RWW = SQUID_HIT_LEVEL_6
};
enum HTTPType {
HTTP_TYPE_UNKNOWN,
HTTP_TYPE_REQUEST,
HTTP_TYPE_RESPONSE,
};
struct HTTPHdrImpl : public HdrHeapObjImpl {
// HdrHeapObjImpl is 4 bytes
HTTPType m_polarity; // request or response or unknown
HTTPVersion m_version; // cooked version number
// 12 bytes means 4 bytes padding here on 64-bit architectures
union {
struct {
URLImpl *m_url_impl;
const char *m_ptr_method;
uint16_t m_len_method;
int16_t m_method_wks_idx;
} req;
struct {
const char *m_ptr_reason;
uint16_t m_len_reason;
int16_t m_status;
} resp;
} u;
MIMEHdrImpl *m_fields_impl;
// Marshaling Functions
int marshal(MarshalXlate *ptr_xlate, int num_ptr, MarshalXlate *str_xlate, int num_str);
void unmarshal(intptr_t offset);
void move_strings(HdrStrHeap *new_heap);
size_t strings_length();
// Sanity Check Functions
void check_strings(HeapCheck *heaps, int num_heaps);
};
struct HTTPValAccept {
char *type;
char *subtype;
double qvalue;
};
struct HTTPValAcceptCharset {
char *charset;
double qvalue;
};
struct HTTPValAcceptEncoding {
char *encoding;
double qvalue;
};
struct HTTPValAcceptLanguage {
char *language;
double qvalue;
};
struct HTTPValFieldList {
char *name;
HTTPValFieldList *next;
};
struct HTTPValCacheControl {
const char *directive;
union {
int delta_seconds;
HTTPValFieldList *field_names;
} u;
};
struct HTTPValRange {
int start;
int end;
HTTPValRange *next;
};
struct HTTPValTE {
char *encoding;
double qvalue;
};
struct HTTPParser {
bool m_parsing_http = false;
MIMEParser m_mime_parser;
};
extern const char *HTTP_METHOD_CONNECT;
extern const char *HTTP_METHOD_DELETE;
extern const char *HTTP_METHOD_GET;
extern const char *HTTP_METHOD_HEAD;
extern const char *HTTP_METHOD_OPTIONS;
extern const char *HTTP_METHOD_POST;
extern const char *HTTP_METHOD_PURGE;
extern const char *HTTP_METHOD_PUT;
extern const char *HTTP_METHOD_TRACE;
extern const char *HTTP_METHOD_PUSH;
extern int HTTP_WKSIDX_CONNECT;
extern int HTTP_WKSIDX_DELETE;
extern int HTTP_WKSIDX_GET;
extern int HTTP_WKSIDX_HEAD;
extern int HTTP_WKSIDX_OPTIONS;
extern int HTTP_WKSIDX_POST;
extern int HTTP_WKSIDX_PURGE;
extern int HTTP_WKSIDX_PUT;
extern int HTTP_WKSIDX_TRACE;
extern int HTTP_WKSIDX_PUSH;
extern int HTTP_WKSIDX_METHODS_CNT;
extern int HTTP_LEN_CONNECT;
extern int HTTP_LEN_DELETE;
extern int HTTP_LEN_GET;
extern int HTTP_LEN_HEAD;
extern int HTTP_LEN_OPTIONS;
extern int HTTP_LEN_POST;
extern int HTTP_LEN_PURGE;
extern int HTTP_LEN_PUT;
extern int HTTP_LEN_TRACE;
extern int HTTP_LEN_PUSH;
extern const char *HTTP_VALUE_BYTES;
extern const char *HTTP_VALUE_CHUNKED;
extern const char *HTTP_VALUE_CLOSE;
extern const char *HTTP_VALUE_COMPRESS;
extern const char *HTTP_VALUE_DEFLATE;
extern const char *HTTP_VALUE_GZIP;
extern const char *HTTP_VALUE_BROTLI;
extern const char *HTTP_VALUE_IDENTITY;
extern const char *HTTP_VALUE_KEEP_ALIVE;
extern const char *HTTP_VALUE_MAX_AGE;
extern const char *HTTP_VALUE_MAX_STALE;
extern const char *HTTP_VALUE_MIN_FRESH;
extern const char *HTTP_VALUE_MUST_REVALIDATE;
extern const char *HTTP_VALUE_NONE;
extern const char *HTTP_VALUE_NO_CACHE;
extern const char *HTTP_VALUE_NO_STORE;
extern const char *HTTP_VALUE_NO_TRANSFORM;
extern const char *HTTP_VALUE_ONLY_IF_CACHED;
extern const char *HTTP_VALUE_PRIVATE;
extern const char *HTTP_VALUE_PROXY_REVALIDATE;
extern const char *HTTP_VALUE_PUBLIC;
extern const char *HTTP_VALUE_S_MAXAGE;
extern const char *HTTP_VALUE_NEED_REVALIDATE_ONCE;
extern const char *HTTP_VALUE_100_CONTINUE;
extern int HTTP_LEN_BYTES;
extern int HTTP_LEN_CHUNKED;
extern int HTTP_LEN_CLOSE;
extern int HTTP_LEN_COMPRESS;
extern int HTTP_LEN_DEFLATE;
extern int HTTP_LEN_GZIP;
extern int HTTP_LEN_BROTLI;
extern int HTTP_LEN_IDENTITY;
extern int HTTP_LEN_KEEP_ALIVE;
extern int HTTP_LEN_MAX_AGE;
extern int HTTP_LEN_MAX_STALE;
extern int HTTP_LEN_MIN_FRESH;
extern int HTTP_LEN_MUST_REVALIDATE;
extern int HTTP_LEN_NONE;
extern int HTTP_LEN_NO_CACHE;
extern int HTTP_LEN_NO_STORE;
extern int HTTP_LEN_NO_TRANSFORM;
extern int HTTP_LEN_ONLY_IF_CACHED;
extern int HTTP_LEN_PRIVATE;
extern int HTTP_LEN_PROXY_REVALIDATE;
extern int HTTP_LEN_PUBLIC;
extern int HTTP_LEN_S_MAXAGE;
extern int HTTP_LEN_NEED_REVALIDATE_ONCE;
extern int HTTP_LEN_100_CONTINUE;
/* Private */
void http_hdr_adjust(HTTPHdrImpl *hdrp, int32_t offset, int32_t length, int32_t delta);
/* Public */
void http_init();
HTTPHdrImpl *http_hdr_create(HdrHeap *heap, HTTPType polarity);
void http_hdr_init(HdrHeap *heap, HTTPHdrImpl *hh, HTTPType polarity);
HTTPHdrImpl *http_hdr_clone(HTTPHdrImpl *s_hh, HdrHeap *s_heap, HdrHeap *d_heap);
void http_hdr_copy_onto(HTTPHdrImpl *s_hh, HdrHeap *s_heap, HTTPHdrImpl *d_hh, HdrHeap *d_heap, bool inherit_strs);
int http_hdr_print(HdrHeap *heap, HTTPHdrImpl *hh, char *buf, int bufsize, int *bufindex, int *dumpoffset);
void http_hdr_describe(HdrHeapObjImpl *obj, bool recurse = true);
bool http_hdr_version_set(HTTPHdrImpl *hh, const HTTPVersion &ver);
const char *http_hdr_method_get(HTTPHdrImpl *hh, int *length);
void http_hdr_method_set(HdrHeap *heap, HTTPHdrImpl *hh, const char *method, int16_t method_wks_idx, int method_length,
bool must_copy);
void http_hdr_url_set(HdrHeap *heap, HTTPHdrImpl *hh, URLImpl *url);
// HTTPStatus http_hdr_status_get (HTTPHdrImpl *hh);
void http_hdr_status_set(HTTPHdrImpl *hh, HTTPStatus status);
const char *http_hdr_reason_get(HTTPHdrImpl *hh, int *length);
void http_hdr_reason_set(HdrHeap *heap, HTTPHdrImpl *hh, const char *value, int length, bool must_copy);
const char *http_hdr_reason_lookup(unsigned status);
void http_parser_init(HTTPParser *parser);
void http_parser_clear(HTTPParser *parser);
ParseResult http_parser_parse_req(HTTPParser *parser, HdrHeap *heap, HTTPHdrImpl *hh, const char **start, const char *end,
bool must_copy_strings, bool eof, int strict_uri_parsing, size_t max_request_line_size,
size_t max_hdr_field_size);
ParseResult validate_hdr_request_target(int method_wks_idx, URLImpl *url);
ParseResult validate_hdr_host(HTTPHdrImpl *hh);
ParseResult validate_hdr_content_length(HdrHeap *heap, HTTPHdrImpl *hh);
ParseResult http_parser_parse_resp(HTTPParser *parser, HdrHeap *heap, HTTPHdrImpl *hh, const char **start, const char *end,
bool must_copy_strings, bool eof);
HTTPStatus http_parse_status(const char *start, const char *end);
HTTPVersion http_parse_version(const char *start, const char *end);
/*
HTTPValAccept* http_parse_accept (const char *buf, Arena *arena);
HTTPValAcceptCharset* http_parse_accept_charset (const char *buf, Arena *arena);
HTTPValAcceptEncoding* http_parse_accept_encoding (const char *buf, Arena *arena);
HTTPValAcceptLanguage* http_parse_accept_language (const char *buf, Arena *arena);
HTTPValCacheControl* http_parse_cache_control (const char *buf, Arena *arena);
const char* http_parse_cache_directive (const char **buf);
HTTPValRange* http_parse_range (const char *buf, Arena *arena);
*/
HTTPValTE *http_parse_te(const char *buf, int len, Arena *arena);
bool is_http1_hdr_version_supported(const HTTPVersion &http_version);
class IOBufferReader;
class HTTPHdr : public MIMEHdr
{
public:
HTTPHdrImpl *m_http = nullptr;
// This is all cached data and so is mutable.
mutable URL m_url_cached;
mutable MIMEField *m_host_mime = nullptr;
mutable int m_host_length = 0; ///< Length of hostname.
mutable int m_port = 0; ///< Target port.
mutable bool m_target_cached = false; ///< Whether host name and port are cached.
mutable bool m_target_in_url = false; ///< Whether host name and port are in the URL.
mutable bool m_100_continue_required = false; ///< Whether 100_continue is in the Expect header.
/// Set if the port was effectively specified in the header.
/// @c true if the target (in the URL or the HOST field) also specified
/// a port. That is, @c true if whatever source had the target host
/// also had a port, @c false otherwise.
mutable bool m_port_in_header = false;
mutable bool early_data = false;
HTTPHdr() = default; // Force the creation of the default constructor
int valid() const;
void create(HTTPType polarity, HdrHeap *heap = nullptr);
void clear();
void reset();
void copy(const HTTPHdr *hdr);
void copy_shallow(const HTTPHdr *hdr);
int unmarshal(char *buf, int len, RefCountObj *block_ref);
int print(char *buf, int bufsize, int *bufindex, int *dumpoffset);
int length_get() const;
HTTPType type_get() const;
HTTPVersion version_get() const;
void version_set(HTTPVersion version);
const char *method_get(int *length);
int method_get_wksidx() const;
void method_set(const char *value, int length);
URL *url_create(URL *url);
URL *url_get() const;
URL *url_get(URL *url);
/** Get a string with the effective URL in it.
If @a length is not @c NULL then the length of the string
is stored in the int pointed to by @a length.
Note that this can be different from getting the @c URL
and invoking @c URL::string_get if the host is in a header
field and not explicitly in the URL.
*/
char *url_string_get(Arena *arena = nullptr, ///< Arena to use, or @c malloc if NULL.
int *length = nullptr ///< Store string length here.
);
/** Get a string with the effective URL in it.
This is automatically allocated if needed in the request heap.
@see url_string_get
*/
char *url_string_get_ref(int *length = nullptr ///< Store string length here.
);
/** Print the URL.
Output is not null terminated.
@return 0 on failure, non-zero on success.
*/
int url_print(char *buff, ///< Output buffer
int length, ///< Length of @a buffer
int *offset, ///< [in,out] ???
int *skip, ///< [in,out] ???
unsigned normalization_flags = URLNormalize::NONE ///< host/scheme normalized to lower case
);
/** Return the length of the URL that url_print() will create.
@return -1 on failure, non-negative on success.
*/
int url_printed_length(unsigned normalizaion_flags = URLNormalize::NONE);
/** Get the URL path.
This is a reference, not allocated.
@return A pointer to the path or @c NULL if there is no valid URL.
*/
const char *path_get(int *length ///< Storage for path length.
);
/** Get the URL matrix params.
This is a reference, not allocated.
@return A pointer to the matrix params or @c NULL if there is no valid URL.
*/
const char *params_get(int *length ///< Storage for param length.
);
/** Get the URL query.
This is a reference, not allocated.
@return A pointer to the query or @c NULL if there is no valid URL.
*/
const char *query_get(int *length ///< Storage for query length.
);
/** Get the URL fragment.
This is a reference, not allocated.
@return A pointer to the fragment or @c NULL if there is no valid URL.
*/
const char *fragment_get(int *length ///< Storage for fragment length.
);
/** Get the target host name.
The length is returned in @a length if non-NULL.
@note The results are cached so this is fast after the first call.
@return A pointer to the host name.
*/
const char *host_get(int *length = nullptr) const;
/** Get the target port.
If the target port is not found then it is adjusted to the
default port for the URL type.
@note The results are cached so this is fast after the first call.
@return The canonicalized target port.
*/
int port_get();
/** Get the URL scheme.
This is a reference, not allocated.
@return A pointer to the scheme or @c NULL if there is no valid URL.
*/
const char *scheme_get(int *length ///< Storage for path length.
);
void url_set(URL *url);
void url_set(const char *str, int length);
/// Check location of target host.
/// @return @c true if the host was in the URL, @c false otherwise.
/// @note This returns @c false if the host is missing.
bool is_target_in_url() const;
/// Check if a port was specified in the target.
/// @return @c true if the port was part of the target.
bool is_port_in_header() const;
/// If the target is in the fields and not the URL, copy it to the @a url.
/// If @a url is @c NULL the cached URL in this header is used.
/// @note In the default case the copy is avoided if the cached URL already
/// has the target. If @a url is non @c NULL the copy is always performed.
void set_url_target_from_host_field(URL *url = nullptr);
/// Mark the target cache as invalid.
/// @internal Ugly but too many places currently that touch the
/// header internals, they must be able to do this.
void mark_target_dirty() const;
HTTPStatus status_get() const;
void status_set(HTTPStatus status);
const char *reason_get(int *length);
void reason_set(const char *value, int length);
void mark_early_data(bool flag = true) const;
bool is_early_data() const;
ParseResult parse_req(HTTPParser *parser, const char **start, const char *end, bool eof, int strict_uri_parsing = 0,
size_t max_request_line_size = UINT16_MAX, size_t max_hdr_field_size = 131070);
ParseResult parse_resp(HTTPParser *parser, const char **start, const char *end, bool eof);
ParseResult parse_req(HTTPParser *parser, IOBufferReader *r, int *bytes_used, bool eof, int strict_uri_parsing = 0,
size_t max_request_line_size = UINT16_MAX, size_t max_hdr_field_size = UINT16_MAX);
ParseResult parse_resp(HTTPParser *parser, IOBufferReader *r, int *bytes_used, bool eof);
bool check_hdr_implements();
public:
// Utility routines
bool is_cache_control_set(const char *cc_directive_wks);
bool is_pragma_no_cache_set();
bool is_keep_alive_set() const;
bool expect_final_response() const;
HTTPKeepAlive keep_alive_get() const;
protected:
/** Load the target cache.
@see m_host, m_port, m_target_in_url
*/
void _fill_target_cache() const;
/** Test the cache and fill it if necessary.
@internal In contrast to @c _fill_target_cache, this method
is inline and checks whether the cache is already filled.
@ _fill_target_cache @b always does a cache fill.
*/
void _test_and_fill_target_cache() const;
static Arena *const USE_HDR_HEAP_MAGIC;
// No gratuitous copies!
HTTPHdr(const HTTPHdr &m) = delete;
HTTPHdr &operator=(const HTTPHdr &m) = delete;
private:
friend class UrlPrintHack; // don't ask.
};
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline int
HTTPHdr::valid() const
{
return (m_http && m_mime && m_heap);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::create(HTTPType polarity, HdrHeap *heap)
{
if (heap) {
m_heap = heap;
} else if (!m_heap) {
m_heap = new_HdrHeap();
}
m_http = http_hdr_create(m_heap, polarity);
m_mime = m_http->m_fields_impl;
}
inline void
HTTPHdr::clear()
{
if (m_http && m_http->m_polarity == HTTP_TYPE_REQUEST) {
m_url_cached.clear();
}
this->HdrHeapSDKHandle::clear();
m_http = nullptr;
m_mime = nullptr;
}
inline void
HTTPHdr::reset()
{
m_heap = nullptr;
m_http = nullptr;
m_mime = nullptr;
m_url_cached.reset();
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::copy(const HTTPHdr *hdr)
{
ink_assert(hdr->valid());
if (valid()) {
http_hdr_copy_onto(hdr->m_http, hdr->m_heap, m_http, m_heap, (m_heap != hdr->m_heap) ? true : false);
} else {
m_heap = new_HdrHeap();
m_http = http_hdr_clone(hdr->m_http, hdr->m_heap, m_heap);
m_mime = m_http->m_fields_impl;
}
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::copy_shallow(const HTTPHdr *hdr)
{
ink_assert(hdr->valid());
m_heap = hdr->m_heap;
m_http = hdr->m_http;
m_mime = hdr->m_mime;
if (hdr->type_get() == HTTP_TYPE_REQUEST && m_url_cached.valid())
m_url_cached.copy_shallow(&hdr->m_url_cached);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline int
HTTPHdr::print(char *buf, int bufsize, int *bufindex, int *dumpoffset)
{
ink_assert(valid());
return http_hdr_print(m_heap, m_http, buf, bufsize, bufindex, dumpoffset);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::_test_and_fill_target_cache() const
{
if (!m_target_cached)
this->_fill_target_cache();
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline const char *
HTTPHdr::host_get(int *length) const
{
this->_test_and_fill_target_cache();
if (m_target_in_url) {
return url_get()->host_get(length);
} else if (m_host_mime) {
if (length)
*length = m_host_length;
return m_host_mime->m_ptr_value;
}
if (length)
*length = 0;
return nullptr;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline int
HTTPHdr::port_get()
{
this->_test_and_fill_target_cache();
return m_port;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline bool
HTTPHdr::is_target_in_url() const
{
this->_test_and_fill_target_cache();
return m_target_in_url;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline bool
HTTPHdr::is_port_in_header() const
{
this->_test_and_fill_target_cache();
return m_port_in_header;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::mark_target_dirty() const
{
m_target_cached = false;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline HTTPType
http_hdr_type_get(HTTPHdrImpl *hh)
{
return (hh->m_polarity);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline HTTPType
HTTPHdr::type_get() const
{
ink_assert(valid());
return http_hdr_type_get(m_http);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline HTTPVersion
HTTPHdr::version_get() const
{
ink_assert(valid());
return m_http->m_version;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline static HTTPKeepAlive
is_header_keep_alive(const HTTPVersion &http_version, const MIMEField *con_hdr)
{
enum {
CON_TOKEN_NONE = 0,
CON_TOKEN_KEEP_ALIVE,
CON_TOKEN_CLOSE,
};
int con_token = CON_TOKEN_NONE;
HTTPKeepAlive keep_alive = HTTP_NO_KEEPALIVE;
// *unknown_tokens = false;
if (con_hdr) {
if (con_hdr->value_get_index("keep-alive", 10) >= 0)
con_token = CON_TOKEN_KEEP_ALIVE;
else if (con_hdr->value_get_index("close", 5) >= 0)
con_token = CON_TOKEN_CLOSE;
}
if (HTTP_1_0 == http_version) {
keep_alive = (con_token == CON_TOKEN_KEEP_ALIVE) ? (HTTP_KEEPALIVE) : (HTTP_NO_KEEPALIVE);
} else if (HTTP_1_1 == http_version) {
// We deviate from the spec here. If the we got a response where
// where there is no Connection header and the request 1.0 was
// 1.0 don't treat this as keep-alive since Netscape-Enterprise/3.6 SP1
// server doesn't
keep_alive = ((con_token == CON_TOKEN_KEEP_ALIVE) || (con_token == CON_TOKEN_NONE && HTTP_1_1 == http_version)) ?
(HTTP_KEEPALIVE) :
(HTTP_NO_KEEPALIVE);
} else {
keep_alive = HTTP_NO_KEEPALIVE;
}
return (keep_alive);
}
inline HTTPKeepAlive
HTTPHdr::keep_alive_get() const
{
HTTPKeepAlive retval = HTTP_NO_KEEPALIVE;
const MIMEField *pc = this->field_find(MIME_FIELD_PROXY_CONNECTION, MIME_LEN_PROXY_CONNECTION);
if (pc != nullptr) {
retval = is_header_keep_alive(this->version_get(), pc);
} else {
const MIMEField *c = this->field_find(MIME_FIELD_CONNECTION, MIME_LEN_CONNECTION);
retval = is_header_keep_alive(this->version_get(), c);
}
return retval;
}
inline bool
HTTPHdr::is_keep_alive_set() const
{
return this->keep_alive_get() == HTTP_KEEPALIVE;
}
/**
Check the status code is informational and expecting final response
- e.g. "100 Continue", "103 Early Hints"
Please note that "101 Switching Protocol" is not included.
*/
inline bool
HTTPHdr::expect_final_response() const
{
switch (this->status_get()) {
case HTTP_STATUS_CONTINUE:
case HTTP_STATUS_EARLY_HINTS:
return true;
default:
return false;
}
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::version_set(HTTPVersion version)
{
ink_assert(valid());
http_hdr_version_set(m_http, version);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline const char *
HTTPHdr::method_get(int *length)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
return http_hdr_method_get(m_http, length);
}
inline int
HTTPHdr::method_get_wksidx() const
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
return (m_http->u.req.m_method_wks_idx);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::method_set(const char *value, int length)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
int method_wks_idx = hdrtoken_tokenize(value, length);
http_hdr_method_set(m_heap, m_http, value, method_wks_idx, length, true);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline URL *
HTTPHdr::url_create(URL *u)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
u->set(this);
u->create(m_heap);
return (u);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline URL *
HTTPHdr::url_get() const
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
// It's entirely possible that someone changed URL in our impl
// without updating the cached copy in the C++ layer. Check
// to see if this happened before handing back the url
URLImpl *real_impl = m_http->u.req.m_url_impl;
if (m_url_cached.m_url_impl != real_impl) {
m_url_cached.set(this);
m_url_cached.m_url_impl = real_impl;
this->mark_target_dirty();
}
return (&m_url_cached);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline URL *
HTTPHdr::url_get(URL *url)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
url->set(this); // attach refcount
url->m_url_impl = m_http->u.req.m_url_impl;
return (url);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::url_set(URL *url)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
URLImpl *url_impl = m_http->u.req.m_url_impl;
::url_copy_onto(url->m_url_impl, url->m_heap, url_impl, m_heap, true);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::url_set(const char *str, int length)
{
URLImpl *url_impl;
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
url_impl = m_http->u.req.m_url_impl;
::url_clear(url_impl);
::url_parse(m_heap, url_impl, &str, str + length, true);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline HTTPStatus
http_hdr_status_get(HTTPHdrImpl *hh)
{
ink_assert(hh->m_polarity == HTTP_TYPE_RESPONSE);
return (HTTPStatus)hh->u.resp.m_status;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline HTTPStatus
HTTPHdr::status_get() const
{
ink_assert(valid());
if (m_http) {
ink_assert(m_http->m_polarity == HTTP_TYPE_RESPONSE);
return http_hdr_status_get(m_http);
}
return HTTP_STATUS_NONE;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::status_set(HTTPStatus status)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_RESPONSE);
http_hdr_status_set(m_http, status);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline const char *
HTTPHdr::reason_get(int *length)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_RESPONSE);
return http_hdr_reason_get(m_http, length);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::reason_set(const char *value, int length)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_RESPONSE);
http_hdr_reason_set(m_heap, m_http, value, length, true);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline void
HTTPHdr::mark_early_data(bool flag) const
{
ink_assert(valid());
early_data = flag;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline bool
HTTPHdr::is_early_data() const
{
ink_assert(valid());
return early_data;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline ParseResult
HTTPHdr::parse_req(HTTPParser *parser, const char **start, const char *end, bool eof, int strict_uri_parsing,
size_t max_request_line_size, size_t max_hdr_field_size)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_REQUEST);
return http_parser_parse_req(parser, m_heap, m_http, start, end, true, eof, strict_uri_parsing, max_request_line_size,
max_hdr_field_size);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline ParseResult
HTTPHdr::parse_resp(HTTPParser *parser, const char **start, const char *end, bool eof)
{
ink_assert(valid());
ink_assert(m_http->m_polarity == HTTP_TYPE_RESPONSE);
return http_parser_parse_resp(parser, m_heap, m_http, start, end, true, eof);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline bool
HTTPHdr::is_cache_control_set(const char *cc_directive_wks)
{
ink_assert(valid());
ink_assert(hdrtoken_is_wks(cc_directive_wks));
const HdrTokenHeapPrefix *prefix = hdrtoken_wks_to_prefix(cc_directive_wks);
ink_assert(prefix->wks_token_type == HDRTOKEN_TYPE_CACHE_CONTROL);
uint32_t cc_mask = prefix->wks_type_specific.u.cache_control.cc_mask;
if (get_cooked_cc_mask() & cc_mask)
return (true);
else
return (false);
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
inline bool
HTTPHdr::is_pragma_no_cache_set()
{
ink_assert(valid());
return (get_cooked_pragma_no_cache());
}
inline char *
HTTPHdr::url_string_get_ref(int *length)
{
return this->url_string_get(USE_HDR_HEAP_MAGIC, length);
}
inline const char *
HTTPHdr::path_get(int *length)
{
URL *url = this->url_get();
return url ? url->path_get(length) : nullptr;
}
inline const char *
HTTPHdr::params_get(int *length)
{
URL *url = this->url_get();
return url ? url->params_get(length) : nullptr;
}
inline const char *
HTTPHdr::query_get(int *length)
{
URL *url = this->url_get();
return url ? url->query_get(length) : nullptr;
}
inline const char *
HTTPHdr::fragment_get(int *length)
{
URL *url = this->url_get();
return url ? url->fragment_get(length) : nullptr;
}
inline const char *
HTTPHdr::scheme_get(int *length)
{
URL *url = this->url_get();
return url ? url->scheme_get(length) : nullptr;
}
/*-------------------------------------------------------------------------
-------------------------------------------------------------------------*/
enum {
CACHE_ALT_MAGIC_ALIVE = 0xabcddeed,
CACHE_ALT_MAGIC_MARSHALED = 0xdcbadeed,
CACHE_ALT_MAGIC_DEAD = 0xdeadeed,
};
// struct HTTPCacheAlt
struct HTTPCacheAlt {
HTTPCacheAlt();
void copy(HTTPCacheAlt *to_copy);
void copy_frag_offsets_from(HTTPCacheAlt *src);
void destroy();
uint32_t m_magic = CACHE_ALT_MAGIC_ALIVE;
// Writeable is set to true is we reside
// in a buffer owned by this structure.
// INVARIANT: if own the buffer this HttpCacheAlt
// we also own the buffers for the request &
// response headers
int32_t m_writeable = 1;
int32_t m_unmarshal_len = -1;
int32_t m_id = -1;
int32_t m_rid = -1;
int32_t m_object_key[sizeof(CryptoHash) / sizeof(int32_t)];
int32_t m_object_size[2];
HTTPHdr m_request_hdr;
HTTPHdr m_response_hdr;
time_t m_request_sent_time = 0;
time_t m_response_received_time = 0;
/// # of fragment offsets in this alternate.
/// @note This is one less than the number of fragments.
int m_frag_offset_count = 0;
/// Type of offset for a fragment.
typedef uint64_t FragOffset;
/// Table of fragment offsets.
/// @note The offsets are forward looking so that frag[0] is the
/// first byte past the end of fragment 0 which is also the first
/// byte of fragment 1. For this reason there is no fragment offset
/// for the last fragment.
FragOffset *m_frag_offsets = nullptr;
/// # of fragment offsets built in to object.
static int constexpr N_INTEGRAL_FRAG_OFFSETS = 4;
/// Integral fragment offset table.
FragOffset m_integral_frag_offsets[N_INTEGRAL_FRAG_OFFSETS];
// With clustering, our alt may be in cluster
// incoming channel buffer, when we are
// destroyed we decrement the refcount
// on that buffer so that it gets destroyed
// We don't want to use a ref count ptr (Ptr<>)
// since our ownership model requires explicit
// destroys and ref count pointers defeat this
RefCountObj *m_ext_buffer = nullptr;
};
class HTTPInfo
{
public:
typedef HTTPCacheAlt::FragOffset FragOffset; ///< Import type.
HTTPCacheAlt *m_alt = nullptr;
HTTPInfo() {}
~HTTPInfo() { clear(); }
void
clear()
{
m_alt = nullptr;
}
bool
valid() const
{
return m_alt != nullptr;
}
void create();
void destroy();
void copy(HTTPInfo *to_copy);
void
copy_shallow(HTTPInfo *info)
{
m_alt = info->m_alt;
}
void copy_frag_offsets_from(HTTPInfo *src);
HTTPInfo &operator=(const HTTPInfo &m);
int marshal_length();
int marshal(char *buf, int len);
static int unmarshal(char *buf, int len, RefCountObj *block_ref);
static int unmarshal_v24_1(char *buf, int len, RefCountObj *block_ref);
void set_buffer_reference(RefCountObj *block_ref);
int get_handle(char *buf, int len);
int32_t
id_get() const
{
return m_alt->m_id;
}
int32_t
rid_get()
{
return m_alt->m_rid;
}
void
id_set(int32_t id)
{
m_alt->m_id = id;
}
void
rid_set(int32_t id)
{
m_alt->m_rid = id;
}
CryptoHash object_key_get();
void object_key_get(CryptoHash *);
bool compare_object_key(const CryptoHash *);
int64_t object_size_get();
void
request_get(HTTPHdr *hdr)
{
hdr->copy_shallow(&m_alt->m_request_hdr);
}
void
response_get(HTTPHdr *hdr)
{
hdr->copy_shallow(&m_alt->m_response_hdr);
}
HTTPHdr *
request_get()
{
return &m_alt->m_request_hdr;
}
HTTPHdr *
response_get()
{
return &m_alt->m_response_hdr;
}
URL *
request_url_get(URL *url = nullptr)
{
return m_alt->m_request_hdr.url_get(url);
}
time_t
request_sent_time_get()
{
return m_alt->m_request_sent_time;
}
time_t
response_received_time_get()
{
return m_alt->m_response_received_time;
}
void object_key_set(CryptoHash &hash);
void object_size_set(int64_t size);
void
request_set(const HTTPHdr *req)
{
m_alt->m_request_hdr.copy(req);
}
void
response_set(const HTTPHdr *resp)
{
m_alt->m_response_hdr.copy(resp);
}
void
request_sent_time_set(time_t t)
{
m_alt->m_request_sent_time = t;
}
void
response_received_time_set(time_t t)
{
m_alt->m_response_received_time = t;
}
/// Get the fragment table.
FragOffset *get_frag_table();
/// Get the # of fragment offsets
/// @note This is the size of the fragment offset table, and one less
/// than the actual # of fragments.
int get_frag_offset_count();
/// Add an @a offset to the end of the fragment offset table.
void push_frag_offset(FragOffset offset);
// Sanity check functions
static bool check_marshalled(char *buf, int len);
private:
HTTPInfo(const HTTPInfo &h);
};
inline void
HTTPInfo::destroy()
{
if (m_alt) {
if (m_alt->m_writeable) {
m_alt->destroy();
} else if (m_alt->m_ext_buffer) {
if (m_alt->m_ext_buffer->refcount_dec() == 0) {
m_alt->m_ext_buffer->free();
}
}
}
clear();
}
inline HTTPInfo &
HTTPInfo::operator=(const HTTPInfo &m)
{
m_alt = m.m_alt;
return *this;
}
inline CryptoHash
HTTPInfo::object_key_get()
{
CryptoHash val;
int32_t *pi = reinterpret_cast<int32_t *>(&val);
memcpy(pi, m_alt->m_object_key, sizeof(CryptoHash));
return val;
}
inline void
HTTPInfo::object_key_get(CryptoHash *hash)
{
int32_t *pi = reinterpret_cast<int32_t *>(hash);
memcpy(pi, m_alt->m_object_key, CRYPTO_HASH_SIZE);
}
inline bool
HTTPInfo::compare_object_key(const CryptoHash *hash)
{
int32_t const *pi = reinterpret_cast<int32_t const *>(hash);
return memcmp(pi, m_alt->m_object_key, CRYPTO_HASH_SIZE) == 0;
}
inline int64_t
HTTPInfo::object_size_get()
{
int64_t val = 0; // make gcc shut up.
int32_t *pi = reinterpret_cast<int32_t *>(&val);
pi[0] = m_alt->m_object_size[0];
pi[1] = m_alt->m_object_size[1];
return val;
}
inline void
HTTPInfo::object_key_set(CryptoHash &hash)
{
int32_t *pi = reinterpret_cast<int32_t *>(&hash);
memcpy(m_alt->m_object_key, pi, CRYPTO_HASH_SIZE);
}
inline void
HTTPInfo::object_size_set(int64_t size)
{
int32_t *pi = reinterpret_cast<int32_t *>(&size);
m_alt->m_object_size[0] = pi[0];
m_alt->m_object_size[1] = pi[1];
}
inline HTTPInfo::FragOffset *
HTTPInfo::get_frag_table()
{
return m_alt ? m_alt->m_frag_offsets : nullptr;
}
inline int
HTTPInfo::get_frag_offset_count()
{
return m_alt ? m_alt->m_frag_offset_count : 0;
}
|