blob: 7616376574e57440029618474579fef97cdbef82 [file] [log] [blame]
// Copyright (c) 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <cstdint>
#include <memory>
#include <string>
#include "absl/strings/string_view.h"
#include "quiche/quic/core/qpack/qpack_encoder_stream_receiver.h"
#include "quiche/quic/core/qpack/qpack_header_table.h"
#include "quiche/quic/core/qpack/qpack_instruction_decoder.h"
#include "quiche/quic/core/quic_error_codes.h"
#include "quiche/quic/core/quic_types.h"
#include "quiche/quic/platform/api/quic_export.h"
namespace quic {
class QpackDecoderHeaderTable;
// Class to decode a single header block.
class QUIC_EXPORT_PRIVATE QpackProgressiveDecoder
: public QpackInstructionDecoder::Delegate,
public QpackDecoderHeaderTable::Observer {
// Interface for receiving decoded header block from the decoder.
class QUIC_EXPORT_PRIVATE HeadersHandlerInterface {
virtual ~HeadersHandlerInterface() {}
// Called when a new header name-value pair is decoded. Multiple values for
// a given name will be emitted as multiple calls to OnHeader.
virtual void OnHeaderDecoded(absl::string_view name,
absl::string_view value) = 0;
// Called when the header block is completely decoded.
// Indicates the total number of bytes in this block.
// The decoder will not access the handler after this call.
// Note that this method might not be called synchronously when the header
// block is received on the wire, in case decoding is blocked on receiving
// entries on the encoder stream.
virtual void OnDecodingCompleted() = 0;
// Called when a decoding error has occurred. No other methods will be
// called afterwards. Implementations are allowed to destroy
// the QpackProgressiveDecoder instance synchronously.
virtual void OnDecodingErrorDetected(QuicErrorCode error_code,
absl::string_view error_message) = 0;
// Interface for keeping track of blocked streams for the purpose of enforcing
// the limit communicated to peer via QPACK_BLOCKED_STREAMS settings.
class QUIC_EXPORT_PRIVATE BlockedStreamLimitEnforcer {
virtual ~BlockedStreamLimitEnforcer() {}
// Called when the stream becomes blocked. Returns true if allowed. Returns
// false if limit is violated, in which case QpackProgressiveDecoder signals
// an error.
// Stream must not be already blocked.
virtual bool OnStreamBlocked(QuicStreamId stream_id) = 0;
// Called when the stream becomes unblocked.
// Stream must be blocked.
virtual void OnStreamUnblocked(QuicStreamId stream_id) = 0;
// Visitor to be notified when decoding is completed.
class QUIC_EXPORT_PRIVATE DecodingCompletedVisitor {
virtual ~DecodingCompletedVisitor() = default;
// Called when decoding is completed, with Required Insert Count of the
// decoded header block. Required Insert Count is defined at
virtual void OnDecodingCompleted(QuicStreamId stream_id,
uint64_t required_insert_count) = 0;
QpackProgressiveDecoder() = delete;
QpackProgressiveDecoder(QuicStreamId stream_id,
BlockedStreamLimitEnforcer* enforcer,
DecodingCompletedVisitor* visitor,
QpackDecoderHeaderTable* header_table,
HeadersHandlerInterface* handler);
QpackProgressiveDecoder(const QpackProgressiveDecoder&) = delete;
QpackProgressiveDecoder& operator=(const QpackProgressiveDecoder&) = delete;
~QpackProgressiveDecoder() override;
// Provide a data fragment to decode.
void Decode(absl::string_view data);
// Signal that the entire header block has been received and passed in
// through Decode(). No methods must be called afterwards.
void EndHeaderBlock();
// QpackInstructionDecoder::Delegate implementation.
bool OnInstructionDecoded(const QpackInstruction* instruction) override;
void OnInstructionDecodingError(QpackInstructionDecoder::ErrorCode error_code,
absl::string_view error_message) override;
// QpackDecoderHeaderTable::Observer implementation.
void OnInsertCountReachedThreshold() override;
void Cancel() override;
bool DoIndexedHeaderFieldInstruction();
bool DoIndexedHeaderFieldPostBaseInstruction();
bool DoLiteralHeaderFieldNameReferenceInstruction();
bool DoLiteralHeaderFieldPostBaseInstruction();
bool DoLiteralHeaderFieldInstruction();
bool DoPrefixInstruction();
// Called when an entry is decoded. Performs validation and calls
// HeadersHandlerInterface::OnHeaderDecoded() or OnError() as needed. Returns
// true if header value is valid, false otherwise. Skips validation if
// |value_from_static_table| is true, because static table entries are always
// valid.
bool OnHeaderDecoded(bool value_from_static_table, absl::string_view name,
absl::string_view value);
// Called as soon as EndHeaderBlock() is called and decoding is not blocked.
void FinishDecoding();
// Called on error.
void OnError(QuicErrorCode error_code, absl::string_view error_message);
// Calculates Base from |required_insert_count_|, which must be set before
// calling this method, and sign bit and Delta Base in the Header Data Prefix,
// which are passed in as arguments. Returns true on success, false on
// failure due to overflow/underflow.
bool DeltaBaseToBase(bool sign, uint64_t delta_base, uint64_t* base);
const QuicStreamId stream_id_;
// |prefix_decoder_| only decodes a handful of bytes then it can be
// destroyed to conserve memory. |instruction_decoder_|, on the other hand,
// is used until the entire header block is decoded.
std::unique_ptr<QpackInstructionDecoder> prefix_decoder_;
QpackInstructionDecoder instruction_decoder_;
BlockedStreamLimitEnforcer* const enforcer_;
DecodingCompletedVisitor* const visitor_;
QpackDecoderHeaderTable* const header_table_;
HeadersHandlerInterface* const handler_;
// Required Insert Count and Base are decoded from the Header Data Prefix.
uint64_t required_insert_count_;
uint64_t base_;
// Required Insert Count is one larger than the largest absolute index of all
// referenced dynamic table entries, or zero if no dynamic table entries are
// referenced. |required_insert_count_so_far_| starts out as zero and keeps
// track of the Required Insert Count based on entries decoded so far.
// After decoding is completed, it is compared to |required_insert_count_|.
uint64_t required_insert_count_so_far_;
// False until prefix is fully read and decoded.
bool prefix_decoded_;
// True if waiting for dynamic table entries to arrive.
bool blocked_;
// Buffer the entire header block after the prefix while decoding is blocked.
std::string buffer_;
// True until EndHeaderBlock() is called.
bool decoding_;
// True if a decoding error has been detected.
bool error_detected_;
// True if QpackDecoderHeaderTable has been destroyed
// while decoding is still blocked.
bool cancelled_;
} // namespace quic