-
Notifications
You must be signed in to change notification settings - Fork 4.8k
/
codec_impl.cc
2363 lines (2081 loc) · 95.9 KB
/
codec_impl.cc
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
#include "source/common/http/http2/codec_impl.h"
#include <algorithm>
#include <cstdint>
#include <memory>
#include <ostream>
#include <vector>
#include "envoy/event/dispatcher.h"
#include "envoy/http/codes.h"
#include "envoy/http/header_map.h"
#include "envoy/network/connection.h"
#include "source/common/common/assert.h"
#include "source/common/common/cleanup.h"
#include "source/common/common/dump_state_utils.h"
#include "source/common/common/enum_to_int.h"
#include "source/common/common/fmt.h"
#include "source/common/common/safe_memcpy.h"
#include "source/common/common/scope_tracker.h"
#include "source/common/common/utility.h"
#include "source/common/http/codes.h"
#include "source/common/http/exception.h"
#include "source/common/http/header_utility.h"
#include "source/common/http/headers.h"
#include "source/common/http/http2/codec_stats.h"
#include "source/common/http/utility.h"
#include "source/common/runtime/runtime_features.h"
#include "absl/cleanup/cleanup.h"
#include "absl/container/fixed_array.h"
#include "quiche/common/quiche_endian.h"
#include "quiche/http2/adapter/nghttp2_adapter.h"
#include "quiche/http2/adapter/oghttp2_adapter.h"
namespace Envoy {
namespace Http {
namespace Http2 {
// for nghttp2 compatibility.
const int ERR_CALLBACK_FAILURE = -902;
const int INITIAL_CONNECTION_WINDOW_SIZE = ((1 << 16) - 1);
const int ERR_TEMPORAL_CALLBACK_FAILURE = -521;
const int ERR_REFUSED_STREAM = -533;
const int ERR_HTTP_HEADER = -531;
const int ERR_HTTP_MESSAGING = -532;
const int ERR_PROTO = -505;
const int ERR_STREAM_CLOSED = -510;
const int ERR_FLOW_CONTROL = -524;
// Changes or additions to details should be reflected in
// docs/root/configuration/http/http_conn_man/response_code_details.rst
class Http2ResponseCodeDetailValues {
public:
// Invalid HTTP header field was received and stream is going to be
// closed.
const absl::string_view ng_http2_err_http_header_ = "http2.invalid.header.field";
// Violation in HTTP messaging rule.
const absl::string_view ng_http2_err_http_messaging_ = "http2.violation.of.messaging.rule";
// none of the above
const absl::string_view ng_http2_err_unknown_ = "http2.unknown.nghttp2.error";
// oghttp2 does not provide details yet.
const absl::string_view oghttp2_err_unknown_ = "http2.unknown.oghttp2.error";
// The number of headers (or trailers) exceeded the configured limits
const absl::string_view too_many_headers = "http2.too_many_headers";
// Envoy detected an HTTP/2 frame flood from the server.
const absl::string_view outbound_frame_flood = "http2.outbound_frames_flood";
// Envoy detected an inbound HTTP/2 frame flood.
const absl::string_view inbound_empty_frame_flood = "http2.inbound_empty_frames_flood";
// Envoy was configured to drop requests with header keys beginning with underscores.
const absl::string_view invalid_underscore = "http2.unexpected_underscore";
// The peer refused the stream.
const absl::string_view remote_refused = "http2.remote_refuse";
// The peer reset the stream.
const absl::string_view remote_reset = "http2.remote_reset";
#ifdef ENVOY_NGHTTP2
const absl::string_view errorDetails(int error_code) const {
switch (error_code) {
case NGHTTP2_ERR_HTTP_HEADER:
return ng_http2_err_http_header_;
case NGHTTP2_ERR_HTTP_MESSAGING:
return ng_http2_err_http_messaging_;
default:
return ng_http2_err_unknown_;
}
}
};
const char* codec_strerror(int error_code) { return nghttp2_strerror(error_code); }
#else
const absl::string_view errorDetails(int) const { return oghttp2_err_unknown_; }
};
const char* codec_strerror(int) { return "unknown_error"; }
#endif
int reasonToReset(StreamResetReason reason) {
switch (reason) {
case StreamResetReason::LocalRefusedStreamReset:
return OGHTTP2_REFUSED_STREAM;
case StreamResetReason::ConnectError:
return OGHTTP2_CONNECT_ERROR;
default:
return OGHTTP2_NO_ERROR;
}
}
using Http2ResponseCodeDetails = ConstSingleton<Http2ResponseCodeDetailValues>;
enum Settings {
// SETTINGS_HEADER_TABLE_SIZE = 0x01,
// SETTINGS_ENABLE_PUSH = 0x02,
SETTINGS_MAX_CONCURRENT_STREAMS = 0x03,
// SETTINGS_INITIAL_WINDOW_SIZE = 0x04,
// SETTINGS_MAX_FRAME_SIZE = 0x05,
// SETTINGS_MAX_HEADER_LIST_SIZE = 0x06,
// SETTINGS_ENABLE_CONNECT_PROTOCOL = 0x08,
// SETTINGS_NO_RFC7540_PRIORITIES = 0x09
};
enum Flags {
// FLAG_NONE = 0,
FLAG_END_STREAM = 0x01,
// FLAG_END_HEADERS = 0x04,
FLAG_ACK = 0x01,
// FLAG_PADDED = 0x08,
// FLAG_PRIORITY = 0x20
};
ReceivedSettingsImpl::ReceivedSettingsImpl(
absl::Span<const http2::adapter::Http2Setting> settings) {
for (const auto& [id, value] : settings) {
if (id == SETTINGS_MAX_CONCURRENT_STREAMS) {
concurrent_stream_limit_ = value;
break;
}
}
}
bool Utility::reconstituteCrumbledCookies(const HeaderString& key, const HeaderString& value,
HeaderString& cookies) {
if (key != Headers::get().Cookie.get().c_str()) {
return false;
}
if (!cookies.empty()) {
cookies.append("; ", 2);
}
const absl::string_view value_view = value.getStringView();
cookies.append(value_view.data(), value_view.size());
return true;
}
std::unique_ptr<http2::adapter::Http2Adapter>
ProdNghttp2SessionFactory::create(ConnectionImpl* connection,
const http2::adapter::OgHttp2Adapter::Options& options) {
auto visitor = std::make_unique<ConnectionImpl::Http2Visitor>(connection);
std::unique_ptr<http2::adapter::Http2Adapter> adapter =
http2::adapter::OgHttp2Adapter::Create(*visitor, options);
connection->setVisitor(std::move(visitor));
return adapter;
}
#ifdef ENVOY_NGHTTP2
std::unique_ptr<http2::adapter::Http2Adapter>
ProdNghttp2SessionFactory::create(ConnectionImpl* connection, const nghttp2_option* options) {
auto visitor = std::make_unique<ConnectionImpl::Http2Visitor>(connection);
auto adapter = http2::adapter::NgHttp2Adapter::CreateClientAdapter(*visitor, options);
auto stream_close_listener = [p = adapter.get()](http2::adapter::Http2StreamId stream_id) {
p->RemoveStream(stream_id);
};
visitor->setStreamCloseListener(std::move(stream_close_listener));
connection->setVisitor(std::move(visitor));
return adapter;
}
#endif
void ProdNghttp2SessionFactory::init(ConnectionImpl* connection,
const envoy::config::core::v3::Http2ProtocolOptions& options) {
connection->sendSettings(options, true);
}
/**
* Helper to remove const during a cast. nghttp2 takes non-const pointers for headers even though
* it copies them.
*/
template <typename T> static T* removeConst(const void* object) {
return const_cast<T*>(reinterpret_cast<const T*>(object));
}
ConnectionImpl::StreamImpl::StreamImpl(ConnectionImpl& parent, uint32_t buffer_limit)
: MultiplexedStreamImplBase(parent.connection_.dispatcher()), parent_(parent),
pending_recv_data_(parent_.connection_.dispatcher().getWatermarkFactory().createBuffer(
[this]() -> void { this->pendingRecvBufferLowWatermark(); },
[this]() -> void { this->pendingRecvBufferHighWatermark(); },
[]() -> void { /* TODO(adisuissa): Handle overflow watermark */ })),
pending_send_data_(parent_.connection_.dispatcher().getWatermarkFactory().createBuffer(
[this]() -> void { this->pendingSendBufferLowWatermark(); },
[this]() -> void { this->pendingSendBufferHighWatermark(); },
[]() -> void { /* TODO(adisuissa): Handle overflow watermark */ })),
local_end_stream_sent_(false), remote_end_stream_(false), remote_rst_(false),
data_deferred_(false), received_noninformational_headers_(false),
pending_receive_buffer_high_watermark_called_(false),
pending_send_buffer_high_watermark_called_(false), reset_due_to_messaging_error_(false),
defer_processing_backedup_streams_(
Runtime::runtimeFeatureEnabled(Runtime::defer_processing_backedup_streams)),
extend_stream_lifetime_flag_(false) {
parent_.stats_.streams_active_.inc();
if (buffer_limit > 0) {
setWriteBufferWatermarks(buffer_limit);
}
stream_manager_.defer_processing_segment_size_ = parent.connection_.bufferLimit();
}
void ConnectionImpl::StreamImpl::destroy() {
// Cancel any pending buffered data callback for the stream.
process_buffered_data_callback_.reset();
MultiplexedStreamImplBase::destroy();
parent_.stats_.streams_active_.dec();
parent_.stats_.pending_send_bytes_.sub(pending_send_data_->length());
}
void ConnectionImpl::ServerStreamImpl::destroy() {
// Only the downstream stream should clear the downstream of the
// memory account.
// This occurs in destroy as we want to ensure the Stream does not get
// reset called on it from the account.
//
// There are cases where a corresponding upstream stream dtor might
// be called, but the downstream stream isn't going to terminate soon
// such as StreamDecoderFilterCallbacks::recreateStream().
if (buffer_memory_account_) {
buffer_memory_account_->clearDownstream();
}
StreamImpl::destroy();
}
http2::adapter::HeaderRep getRep(const HeaderString& str) {
if (str.isReference()) {
return str.getStringView();
} else {
return std::string(str.getStringView());
}
}
std::vector<http2::adapter::Header>
ConnectionImpl::StreamImpl::buildHeaders(const HeaderMap& headers) {
std::vector<http2::adapter::Header> out;
out.reserve(headers.size());
headers.iterate([&out](const HeaderEntry& header) -> HeaderMap::Iterate {
out.push_back({getRep(header.key()), getRep(header.value())});
return HeaderMap::Iterate::Continue;
});
return out;
}
void ConnectionImpl::ServerStreamImpl::encode1xxHeaders(const ResponseHeaderMap& headers) {
ASSERT(HeaderUtility::isSpecial1xx(headers));
encodeHeaders(headers, false);
}
void ConnectionImpl::StreamImpl::encodeHeadersBase(const HeaderMap& headers, bool end_stream) {
local_end_stream_ = end_stream;
submitHeaders(headers, end_stream);
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
Status ConnectionImpl::ClientStreamImpl::encodeHeaders(const RequestHeaderMap& headers,
bool end_stream) {
parent_.updateActiveStreamsOnEncode(*this);
#ifndef ENVOY_ENABLE_UHV
// Headers are now validated by UHV before encoding by the codec. Two checks below are not needed
// when UHV is enabled.
//
// Required headers must be present. This can only happen by some erroneous processing after the
// downstream codecs decode.
RETURN_IF_ERROR(HeaderUtility::checkRequiredRequestHeaders(headers));
// Verify that a filter hasn't added an invalid header key or value.
RETURN_IF_ERROR(HeaderUtility::checkValidRequestHeaders(headers));
// Extended CONNECT to H/1 upgrade transformation has moved to UHV
// This must exist outside of the scope of isUpgrade as the underlying memory is
// needed until encodeHeadersBase has been called.
Http::RequestHeaderMapPtr modified_headers;
if (Http::Utility::isUpgrade(headers)) {
modified_headers = createHeaderMap<RequestHeaderMapImpl>(headers);
upgrade_type_ = std::string(headers.getUpgradeValue());
Http::Utility::transformUpgradeRequestFromH1toH2(*modified_headers);
encodeHeadersBase(*modified_headers, end_stream);
} else if (headers.Method() && headers.Method()->value() == "CONNECT") {
modified_headers = createHeaderMap<RequestHeaderMapImpl>(headers);
modified_headers->removeScheme();
modified_headers->removePath();
modified_headers->removeProtocol();
encodeHeadersBase(*modified_headers, end_stream);
} else {
encodeHeadersBase(headers, end_stream);
}
#else
encodeHeadersBase(headers, end_stream);
#endif
return okStatus();
}
void ConnectionImpl::ServerStreamImpl::encodeHeaders(const ResponseHeaderMap& headers,
bool end_stream) {
parent_.updateActiveStreamsOnEncode(*this);
// The contract is that client codecs must ensure that :status is present.
ASSERT(headers.Status() != nullptr);
#ifndef ENVOY_ENABLE_UHV
// Extended CONNECT to H/1 upgrade transformation has moved to UHV
// This must exist outside of the scope of isUpgrade as the underlying memory is
// needed until encodeHeadersBase has been called.
Http::ResponseHeaderMapPtr modified_headers;
if (Http::Utility::isUpgrade(headers)) {
modified_headers = createHeaderMap<ResponseHeaderMapImpl>(headers);
Http::Utility::transformUpgradeResponseFromH1toH2(*modified_headers);
encodeHeadersBase(*modified_headers, end_stream);
} else {
encodeHeadersBase(headers, end_stream);
}
#else
encodeHeadersBase(headers, end_stream);
#endif
}
void ConnectionImpl::StreamImpl::encodeTrailersBase(const HeaderMap& trailers) {
parent_.updateActiveStreamsOnEncode(*this);
ASSERT(!local_end_stream_);
local_end_stream_ = true;
if (pending_send_data_->length() > 0) {
// In this case we want trailers to come after we release all pending body data that is
// waiting on window updates. We need to save the trailers so that we can emit them later.
// However, for empty trailers, we don't need to to save the trailers.
ASSERT(!pending_trailers_to_encode_);
const bool skip_encoding_empty_trailers = trailers.empty();
if (!skip_encoding_empty_trailers) {
pending_trailers_to_encode_ = cloneTrailers(trailers);
onLocalEndStream();
}
} else {
submitTrailers(trailers);
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
}
void ConnectionImpl::StreamImpl::encodeMetadata(const MetadataMapVector& metadata_map_vector) {
parent_.updateActiveStreamsOnEncode(*this);
ASSERT(parent_.allow_metadata_);
NewMetadataEncoder& metadata_encoder = getMetadataEncoder();
auto sources_vec = metadata_encoder.createSources(metadata_map_vector);
for (auto& source : sources_vec) {
parent_.adapter_->SubmitMetadata(stream_id_, 16 * 1024, std::move(source));
}
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
void ConnectionImpl::StreamImpl::processBufferedData() {
ENVOY_CONN_LOG(debug, "Stream {} processing buffered data.", parent_.connection_, stream_id_);
// Restore crash dump context when processing buffered data.
Event::Dispatcher& dispatcher = parent_.connection_.dispatcher();
// This method is only called from a callback placed directly on the
// dispatcher, as such the dispatcher shouldn't have any tracked objects.
ASSERT(dispatcher.trackedObjectStackIsEmpty());
Envoy::ScopeTrackedObjectStack stack;
stack.add(parent_.connection_);
absl::Cleanup clear_current_stream_id = [this]() { parent_.current_stream_id_.reset(); };
// TODO(kbaichoo): When we add support to *ConnectionImpl::getStream* for
// deferred closed streams we can use their stream id here.
if (!stream_manager_.buffered_on_stream_close_) {
ASSERT(!parent_.current_stream_id_.has_value());
parent_.current_stream_id_ = stream_id_;
}
stack.add(parent_);
ScopeTrackerScopeState scope{&stack, dispatcher};
if (stream_manager_.body_buffered_ && continueProcessingBufferedData()) {
decodeData();
}
if (stream_manager_.trailers_buffered_ && !stream_manager_.body_buffered_ &&
continueProcessingBufferedData()) {
decodeTrailers();
ASSERT(!stream_manager_.trailers_buffered_);
}
// Reset cases are handled by resetStream and directly invoke onStreamClose,
// which consumes the buffered_on_stream_close_ so we don't invoke
// onStreamClose twice.
if (stream_manager_.buffered_on_stream_close_ && !stream_manager_.hasBufferedBodyOrTrailers()) {
ASSERT(!reset_reason_.has_value());
ENVOY_CONN_LOG(debug, "invoking onStreamClose for stream: {} via processBufferedData",
parent_.connection_, stream_id_);
// We only buffer the onStreamClose if we had no errors.
if (Status status = parent_.onStreamClose(this, 0); !status.ok()) {
ENVOY_CONN_LOG(debug, "error invoking onStreamClose: {}", parent_.connection_,
status.message()); // LCOV_EXCL_LINE
}
}
}
void ConnectionImpl::StreamImpl::grantPeerAdditionalStreamWindow() {
parent_.adapter_->MarkDataConsumedForStream(stream_id_, unconsumed_bytes_);
unconsumed_bytes_ = 0;
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
void ConnectionImpl::StreamImpl::readDisable(bool disable) {
ENVOY_CONN_LOG(debug, "Stream {} {}, unconsumed_bytes {} read_disable_count {}",
parent_.connection_, stream_id_, (disable ? "disabled" : "enabled"),
unconsumed_bytes_, read_disable_count_);
if (disable) {
++read_disable_count_;
} else {
ASSERT(read_disable_count_ > 0);
--read_disable_count_;
if (!buffersOverrun()) {
scheduleProcessingOfBufferedData(false);
if (shouldAllowPeerAdditionalStreamWindow()) {
grantPeerAdditionalStreamWindow();
}
}
}
}
void ConnectionImpl::StreamImpl::scheduleProcessingOfBufferedData(bool schedule_next_iteration) {
if (defer_processing_backedup_streams_ && stream_manager_.hasBufferedBodyOrTrailers()) {
if (!process_buffered_data_callback_) {
process_buffered_data_callback_ = parent_.connection_.dispatcher().createSchedulableCallback(
[this]() { processBufferedData(); });
}
// We schedule processing to occur in another callback to avoid
// reentrant and deep call stacks.
if (schedule_next_iteration) {
process_buffered_data_callback_->scheduleCallbackNextIteration();
} else {
process_buffered_data_callback_->scheduleCallbackCurrentIteration();
}
}
}
void ConnectionImpl::StreamImpl::pendingRecvBufferHighWatermark() {
// If `defer_processing_backedup_streams_`, read disabling here can become
// dangerous as it can prevent us from processing buffered data.
if (!defer_processing_backedup_streams_) {
ENVOY_CONN_LOG(debug, "recv buffer over limit ", parent_.connection_);
ASSERT(!pending_receive_buffer_high_watermark_called_);
pending_receive_buffer_high_watermark_called_ = true;
readDisable(true);
}
}
void ConnectionImpl::StreamImpl::pendingRecvBufferLowWatermark() {
// If `defer_processing_backedup_streams_`, we don't read disable on
// high watermark, so we shouldn't read disable here.
if (defer_processing_backedup_streams_) {
if (shouldAllowPeerAdditionalStreamWindow()) {
// We should grant additional stream window here, in case the
// `pending_recv_buffer_` was blocking flow control updates
// from going to the peer.
grantPeerAdditionalStreamWindow();
}
} else {
ENVOY_CONN_LOG(debug, "recv buffer under limit ", parent_.connection_);
ASSERT(pending_receive_buffer_high_watermark_called_);
pending_receive_buffer_high_watermark_called_ = false;
readDisable(false);
}
}
void ConnectionImpl::StreamImpl::decodeData() {
if (defer_processing_backedup_streams_ && buffersOverrun()) {
ENVOY_CONN_LOG(trace, "Stream {} buffering decodeData() call.", parent_.connection_,
stream_id_);
stream_manager_.body_buffered_ = true;
return;
}
// Some buffered body will be consumed. If there remains buffered body after
// this call, set this to true.
stream_manager_.body_buffered_ = false;
bool already_drained_data = false;
// It's possible that we are waiting to send a deferred reset, so only raise data if local
// is not complete.
if (!deferred_reset_) {
// We should decode data in chunks only if we have defer processing enabled
// with a non-zero defer_processing_segment_size, and the buffer holds more
// data than the defer_processing_segment_size. Otherwise, push the
// entire buffer through.
const bool decode_data_in_chunk =
defer_processing_backedup_streams_ && stream_manager_.decodeAsChunks() &&
pending_recv_data_->length() > stream_manager_.defer_processing_segment_size_;
if (decode_data_in_chunk) {
Buffer::OwnedImpl chunk_buffer;
// TODO(kbaichoo): Consider implementing an approximate move for chunking.
chunk_buffer.move(*pending_recv_data_, stream_manager_.defer_processing_segment_size_);
// With the current implementation this should always be true,
// though this can change with approximation.
stream_manager_.body_buffered_ = true;
ASSERT(pending_recv_data_->length() > 0);
decoder().decodeData(chunk_buffer, sendEndStream());
already_drained_data = true;
if (!buffersOverrun()) {
scheduleProcessingOfBufferedData(true);
}
} else {
// Send the entire buffer through.
decoder().decodeData(*pending_recv_data_, sendEndStream());
}
}
if (!already_drained_data) {
pending_recv_data_->drain(pending_recv_data_->length());
}
}
void ConnectionImpl::ClientStreamImpl::decodeHeaders() {
auto& headers = absl::get<ResponseHeaderMapPtr>(headers_or_trailers_);
#ifndef ENVOY_ENABLE_UHV
const uint64_t status = Http::Utility::getResponseStatus(*headers);
// Extended CONNECT to H/1 upgrade transformation has moved to UHV
if (!upgrade_type_.empty() && headers->Status()) {
Http::Utility::transformUpgradeResponseFromH2toH1(*headers, upgrade_type_);
}
#else
// In UHV mode the :status header at this point can be malformed, as it is validated
// later on in the response_decoder_.decodeHeaders() call.
// Account for this here.
absl::optional<uint64_t> status_opt = Http::Utility::getResponseStatusOrNullopt(*headers);
if (!status_opt.has_value()) {
// In case the status is invalid or missing, the response_decoder_.decodeHeaders() will fail the
// request
response_decoder_.decodeHeaders(std::move(headers), sendEndStream());
return;
}
const uint64_t status = status_opt.value();
#endif
// Non-informational headers are non-1xx OR 101-SwitchingProtocols, since 101 implies that further
// proxying is on an upgrade path.
// TODO(#29071) determine how to handle 101, since it is not supported by HTTP/2
received_noninformational_headers_ =
!CodeUtility::is1xx(status) || status == enumToInt(Http::Code::SwitchingProtocols);
if (HeaderUtility::isSpecial1xx(*headers)) {
response_decoder_.decode1xxHeaders(std::move(headers));
} else {
response_decoder_.decodeHeaders(std::move(headers), sendEndStream());
}
}
bool ConnectionImpl::StreamImpl::maybeDeferDecodeTrailers() {
ASSERT(!deferred_reset_.has_value());
// Buffer trailers if we're deferring processing and not flushing all data
// through and either
// 1) Buffers are overrun
// 2) There's buffered body which should get processed before these trailers
// to avoid losing data.
if (defer_processing_backedup_streams_ && (buffersOverrun() || stream_manager_.body_buffered_)) {
stream_manager_.trailers_buffered_ = true;
ENVOY_CONN_LOG(trace, "Stream {} buffering decodeTrailers() call.", parent_.connection_,
stream_id_);
return true;
}
return false;
}
void ConnectionImpl::ClientStreamImpl::decodeTrailers() {
if (maybeDeferDecodeTrailers()) {
return;
}
// Consume any buffered trailers.
stream_manager_.trailers_buffered_ = false;
response_decoder_.decodeTrailers(
std::move(absl::get<ResponseTrailerMapPtr>(headers_or_trailers_)));
}
void ConnectionImpl::ServerStreamImpl::decodeHeaders() {
auto& headers = absl::get<RequestHeaderMapSharedPtr>(headers_or_trailers_);
#ifndef ENVOY_ENABLE_UHV
// Extended CONNECT to H/1 upgrade transformation has moved to UHV
if (Http::Utility::isH2UpgradeRequest(*headers)) {
Http::Utility::transformUpgradeRequestFromH2toH1(*headers);
}
#endif
request_decoder_->decodeHeaders(std::move(headers), sendEndStream());
}
void ConnectionImpl::ServerStreamImpl::decodeTrailers() {
if (maybeDeferDecodeTrailers()) {
return;
}
// Consume any buffered trailers.
stream_manager_.trailers_buffered_ = false;
request_decoder_->decodeTrailers(
std::move(absl::get<RequestTrailerMapPtr>(headers_or_trailers_)));
}
void ConnectionImpl::StreamImpl::pendingSendBufferHighWatermark() {
ENVOY_CONN_LOG(debug, "send buffer over limit ", parent_.connection_);
ASSERT(!pending_send_buffer_high_watermark_called_);
pending_send_buffer_high_watermark_called_ = true;
runHighWatermarkCallbacks();
}
void ConnectionImpl::StreamImpl::pendingSendBufferLowWatermark() {
ENVOY_CONN_LOG(debug, "send buffer under limit ", parent_.connection_);
ASSERT(pending_send_buffer_high_watermark_called_);
pending_send_buffer_high_watermark_called_ = false;
runLowWatermarkCallbacks();
}
void ConnectionImpl::StreamImpl::saveHeader(HeaderString&& name, HeaderString&& value) {
if (!Utility::reconstituteCrumbledCookies(name, value, cookies_)) {
headers().addViaMove(std::move(name), std::move(value));
}
}
void ConnectionImpl::StreamImpl::submitTrailers(const HeaderMap& trailers) {
ASSERT(local_end_stream_);
const bool skip_encoding_empty_trailers = trailers.empty();
if (skip_encoding_empty_trailers) {
ENVOY_CONN_LOG(debug, "skipping submitting trailers", parent_.connection_);
// Instead of submitting empty trailers, we send empty data instead.
Buffer::OwnedImpl empty_buffer;
encodeDataHelper(empty_buffer, /*end_stream=*/true, skip_encoding_empty_trailers);
return;
}
std::vector<http2::adapter::Header> final_headers = buildHeaders(trailers);
parent_.adapter_->SubmitTrailer(stream_id_, final_headers);
}
std::pair<int64_t, bool>
ConnectionImpl::StreamDataFrameSource::SelectPayloadLength(size_t max_length) {
if (stream_.pending_send_data_->length() == 0 && !stream_.local_end_stream_) {
ASSERT(!stream_.data_deferred_);
stream_.data_deferred_ = true;
return {kBlocked, false};
} else {
const size_t length = std::min<size_t>(max_length, stream_.pending_send_data_->length());
bool end_data = false;
if (stream_.local_end_stream_ && length == stream_.pending_send_data_->length()) {
end_data = true;
if (stream_.pending_trailers_to_encode_) {
stream_.submitTrailers(*stream_.pending_trailers_to_encode_);
stream_.pending_trailers_to_encode_.reset();
} else {
send_fin_ = true;
}
}
return {static_cast<int64_t>(length), end_data};
}
}
bool ConnectionImpl::StreamDataFrameSource::Send(absl::string_view frame_header,
size_t payload_length) {
stream_.parent_.protocol_constraints_.incrementOutboundDataFrameCount();
Buffer::OwnedImpl output;
stream_.parent_.addOutboundFrameFragment(
output, reinterpret_cast<const uint8_t*>(frame_header.data()), frame_header.size());
if (!stream_.parent_.protocol_constraints_.checkOutboundFrameLimits().ok()) {
ENVOY_CONN_LOG(debug, "error sending data frame: Too many frames in the outbound queue",
stream_.parent_.connection_);
stream_.setDetails(Http2ResponseCodeDetails::get().outbound_frame_flood);
}
stream_.parent_.stats_.pending_send_bytes_.sub(payload_length);
output.move(*stream_.pending_send_data_, payload_length);
stream_.parent_.connection_.write(output, false);
return true;
}
void ConnectionImpl::ClientStreamImpl::submitHeaders(const HeaderMap& headers, bool end_stream) {
ASSERT(stream_id_ == -1);
const bool skip_frame_source =
end_stream ||
Runtime::runtimeFeatureEnabled("envoy.reloadable_features.http2_use_visitor_for_data");
stream_id_ = parent_.adapter_->SubmitRequest(
buildHeaders(headers),
skip_frame_source ? nullptr : std::make_unique<StreamDataFrameSource>(*this), end_stream,
base());
ASSERT(stream_id_ > 0);
}
Status ConnectionImpl::ClientStreamImpl::onBeginHeaders() {
if (headers_state_ == HeadersState::Headers) {
allocTrailers();
}
return okStatus();
}
void ConnectionImpl::ClientStreamImpl::advanceHeadersState() {
RELEASE_ASSERT(
headers_state_ == HeadersState::Response || headers_state_ == HeadersState::Headers, "");
headers_state_ = HeadersState::Headers;
}
void ConnectionImpl::ServerStreamImpl::submitHeaders(const HeaderMap& headers, bool end_stream) {
ASSERT(stream_id_ != -1);
const bool skip_frame_source =
end_stream ||
Runtime::runtimeFeatureEnabled("envoy.reloadable_features.http2_use_visitor_for_data");
parent_.adapter_->SubmitResponse(
stream_id_, buildHeaders(headers),
skip_frame_source ? nullptr : std::make_unique<StreamDataFrameSource>(*this), end_stream);
}
Status ConnectionImpl::ServerStreamImpl::onBeginHeaders() {
if (headers_state_ != HeadersState::Request) {
parent_.stats_.trailers_.inc();
ASSERT(headers_state_ == HeadersState::Headers);
allocTrailers();
}
return okStatus();
}
void ConnectionImpl::ServerStreamImpl::advanceHeadersState() {
RELEASE_ASSERT(headers_state_ == HeadersState::Request || headers_state_ == HeadersState::Headers,
"");
headers_state_ = HeadersState::Headers;
}
void ConnectionImpl::StreamImpl::onPendingFlushTimer() {
ENVOY_CONN_LOG(debug, "pending stream flush timeout", parent_.connection_);
MultiplexedStreamImplBase::onPendingFlushTimer();
parent_.stats_.tx_flush_timeout_.inc();
ASSERT(local_end_stream_ && !local_end_stream_sent_);
// This will emit a reset frame for this stream and close the stream locally.
// Only the stream adapter's reset callback should run as other higher layers
// think the stream is already finished.
resetStreamWorker(StreamResetReason::LocalReset);
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
void ConnectionImpl::StreamImpl::encodeData(Buffer::Instance& data, bool end_stream) {
parent_.updateActiveStreamsOnEncode(*this);
ASSERT(!local_end_stream_);
encodeDataHelper(data, end_stream,
/*skip_encoding_empty_trailers=*/
false);
}
void ConnectionImpl::StreamImpl::encodeDataHelper(Buffer::Instance& data, bool end_stream,
bool skip_encoding_empty_trailers) {
if (skip_encoding_empty_trailers) {
ASSERT(data.length() == 0 && end_stream);
}
local_end_stream_ = end_stream;
parent_.stats_.pending_send_bytes_.add(data.length());
pending_send_data_->move(data);
if (data_deferred_) {
bool success = parent_.adapter_->ResumeStream(stream_id_);
ASSERT(success);
data_deferred_ = false;
}
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
if (local_end_stream_) {
onLocalEndStream();
}
}
void ConnectionImpl::ServerStreamImpl::resetStream(StreamResetReason reason) {
// Clear the downstream on the account since we're resetting the downstream.
if (buffer_memory_account_) {
buffer_memory_account_->clearDownstream();
}
StreamImpl::resetStream(reason);
}
void ConnectionImpl::StreamImpl::resetStream(StreamResetReason reason) {
reset_reason_ = reason;
// Higher layers expect calling resetStream() to immediately raise reset callbacks.
runResetCallbacks(reason, absl::string_view());
// If we've bufferedOnStreamClose for this stream, we shouldn't propagate this
// reset as nghttp2 will have forgotten about the stream.
if (stream_manager_.buffered_on_stream_close_) {
ENVOY_CONN_LOG(
trace, "Stopped propagating reset to codec as we've buffered onStreamClose for stream {}",
parent_.connection_, stream_id_);
// The stream didn't originally have an NGHTTP2 error, since we buffered
// its stream close.
if (Status status = parent_.onStreamClose(this, 0); !status.ok()) {
ENVOY_CONN_LOG(debug, "error invoking onStreamClose: {}", parent_.connection_,
status.message()); // LCOV_EXCL_LINE
}
return;
}
// If we submit a reset, the codec may cancel outbound frames that have not yet been sent.
// We want these frames to go out so we defer the reset until we send all of the frames that
// end the local stream. However, if we're resetting the stream due to
// overload, we should reset the stream as soon as possible to free used
// resources.
if (useDeferredReset() && local_end_stream_ && !local_end_stream_sent_ &&
reason != StreamResetReason::OverloadManager) {
ASSERT(parent_.getStreamUnchecked(stream_id_) != nullptr);
parent_.pending_deferred_reset_streams_.emplace(stream_id_, this);
deferred_reset_ = reason;
ENVOY_CONN_LOG(trace, "deferred reset stream", parent_.connection_);
} else {
resetStreamWorker(reason);
}
// We must still call sendPendingFrames() in both the deferred and not deferred path. This forces
// the cleanup logic to run which will reset the stream in all cases if all data frames could not
// be sent.
if (parent_.sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
}
void ConnectionImpl::StreamImpl::resetStreamWorker(StreamResetReason reason) {
if (stream_id_ == -1) {
// Handle the case where client streams are reset before headers are created.
return;
}
if (codec_callbacks_) {
codec_callbacks_->onCodecLowLevelReset();
}
parent_.adapter_->SubmitRst(stream_id_,
static_cast<http2::adapter::Http2ErrorCode>(reasonToReset(reason)));
}
NewMetadataEncoder& ConnectionImpl::StreamImpl::getMetadataEncoder() {
if (metadata_encoder_ == nullptr) {
metadata_encoder_ = std::make_unique<NewMetadataEncoder>();
}
return *metadata_encoder_;
}
MetadataDecoder& ConnectionImpl::StreamImpl::getMetadataDecoder() {
if (metadata_decoder_ == nullptr) {
auto cb = [this](MetadataMapPtr&& metadata_map_ptr) {
this->onMetadataDecoded(std::move(metadata_map_ptr));
};
metadata_decoder_ = std::make_unique<MetadataDecoder>(cb);
}
return *metadata_decoder_;
}
void ConnectionImpl::StreamImpl::onMetadataDecoded(MetadataMapPtr&& metadata_map_ptr) {
// Empty metadata maps should not be decoded.
if (metadata_map_ptr->empty()) {
ENVOY_CONN_LOG(debug, "decode metadata called with empty map, skipping", parent_.connection_);
parent_.stats_.metadata_empty_frames_.inc();
} else {
decoder().decodeMetadata(std::move(metadata_map_ptr));
}
}
void ConnectionImpl::StreamImpl::setAccount(Buffer::BufferMemoryAccountSharedPtr account) {
buffer_memory_account_ = account;
pending_recv_data_->bindAccount(buffer_memory_account_);
pending_send_data_->bindAccount(buffer_memory_account_);
}
ConnectionImpl::ConnectionImpl(Network::Connection& connection, CodecStats& stats,
Random::RandomGenerator& random_generator,
const envoy::config::core::v3::Http2ProtocolOptions& http2_options,
const uint32_t max_headers_kb, const uint32_t max_headers_count)
: stats_(stats), connection_(connection), max_headers_kb_(max_headers_kb),
max_headers_count_(max_headers_count),
per_stream_buffer_limit_(http2_options.initial_stream_window_size().value()),
stream_error_on_invalid_http_messaging_(
http2_options.override_stream_error_on_invalid_http_message().value()),
protocol_constraints_(stats, http2_options), dispatching_(false), raised_goaway_(false),
random_(random_generator),
last_received_data_time_(connection_.dispatcher().timeSource().monotonicTime()) {
if (http2_options.has_use_oghttp2_codec()) {
use_oghttp2_library_ = http2_options.use_oghttp2_codec().value();
} else {
use_oghttp2_library_ =
Runtime::runtimeFeatureEnabled("envoy.reloadable_features.http2_use_oghttp2");
}
if (http2_options.has_connection_keepalive()) {
keepalive_interval_ = std::chrono::milliseconds(
PROTOBUF_GET_MS_OR_DEFAULT(http2_options.connection_keepalive(), interval, 0));
keepalive_timeout_ = std::chrono::milliseconds(
PROTOBUF_GET_MS_REQUIRED(http2_options.connection_keepalive(), timeout));
keepalive_interval_jitter_percent_ = PROTOBUF_GET_WRAPPED_OR_DEFAULT(
http2_options.connection_keepalive(), interval_jitter, 15.0);
if (keepalive_interval_.count() > 0) {
keepalive_send_timer_ = connection.dispatcher().createTimer([this]() { sendKeepalive(); });
}
keepalive_timeout_timer_ =
connection.dispatcher().createTimer([this]() { onKeepaliveResponseTimeout(); });
// This call schedules the initial interval, with jitter.
onKeepaliveResponse();
}
}
ConnectionImpl::~ConnectionImpl() {
for (const auto& stream : active_streams_) {
stream->destroy();
}
}
void ConnectionImpl::sendKeepalive() {
ASSERT(keepalive_timeout_timer_);
if (keepalive_timeout_timer_->enabled()) {
ENVOY_CONN_LOG(trace, "Skipping PING: already awaiting PING ACK", connection_);
return;
}
// Include the current time as the payload to help with debugging.
SystemTime now = connection_.dispatcher().timeSource().systemTime();
uint64_t ms_since_epoch =
std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
ENVOY_CONN_LOG(trace, "Sending keepalive PING {}", connection_, ms_since_epoch);
adapter_->SubmitPing(ms_since_epoch);
if (sendPendingFramesAndHandleError()) {
// Intended to check through coverage that this error case is tested
return;
}
keepalive_timeout_timer_->enableTimer(keepalive_timeout_);
}
void ConnectionImpl::onKeepaliveResponse() {
// Check the timers for nullptr in case the peer sent an unsolicited PING ACK.
if (keepalive_timeout_timer_ != nullptr) {
keepalive_timeout_timer_->disableTimer();
}
if (keepalive_send_timer_ != nullptr && keepalive_interval_.count()) {
uint64_t interval_ms = keepalive_interval_.count();
const uint64_t jitter_percent_mod = keepalive_interval_jitter_percent_ * interval_ms / 100;
if (jitter_percent_mod > 0) {
interval_ms += random_.random() % jitter_percent_mod;
}
keepalive_send_timer_->enableTimer(std::chrono::milliseconds(interval_ms));
}
}
void ConnectionImpl::onKeepaliveResponseTimeout() {
ENVOY_CONN_LOG_EVENT(debug, "h2_ping_timeout", "Closing connection due to keepalive timeout",
connection_);
stats_.keepalive_timeout_.inc();
connection_.close(Network::ConnectionCloseType::NoFlush,
StreamInfo::LocalCloseReasons::get().Http2PingTimeout);
}
bool ConnectionImpl::slowContainsStreamId(int32_t stream_id) const {
for (const auto& stream : active_streams_) {
if (stream->stream_id_ == stream_id) {
return true;
}
}
return false;