1 // Copyright (c) 2016 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef QUICHE_QUIC_CORE_FRAMES_QUIC_FRAME_H_ 6 #define QUICHE_QUIC_CORE_FRAMES_QUIC_FRAME_H_ 7 8 #include <ostream> 9 #include <vector> 10 11 #include "net/third_party/quiche/src/quic/core/frames/quic_ack_frame.h" 12 #include "net/third_party/quiche/src/quic/core/frames/quic_blocked_frame.h" 13 #include "net/third_party/quiche/src/quic/core/frames/quic_connection_close_frame.h" 14 #include "net/third_party/quiche/src/quic/core/frames/quic_crypto_frame.h" 15 #include "net/third_party/quiche/src/quic/core/frames/quic_goaway_frame.h" 16 #include "net/third_party/quiche/src/quic/core/frames/quic_handshake_done_frame.h" 17 #include "net/third_party/quiche/src/quic/core/frames/quic_max_streams_frame.h" 18 #include "net/third_party/quiche/src/quic/core/frames/quic_message_frame.h" 19 #include "net/third_party/quiche/src/quic/core/frames/quic_mtu_discovery_frame.h" 20 #include "net/third_party/quiche/src/quic/core/frames/quic_new_connection_id_frame.h" 21 #include "net/third_party/quiche/src/quic/core/frames/quic_new_token_frame.h" 22 #include "net/third_party/quiche/src/quic/core/frames/quic_padding_frame.h" 23 #include "net/third_party/quiche/src/quic/core/frames/quic_path_challenge_frame.h" 24 #include "net/third_party/quiche/src/quic/core/frames/quic_path_response_frame.h" 25 #include "net/third_party/quiche/src/quic/core/frames/quic_ping_frame.h" 26 #include "net/third_party/quiche/src/quic/core/frames/quic_retire_connection_id_frame.h" 27 #include "net/third_party/quiche/src/quic/core/frames/quic_rst_stream_frame.h" 28 #include "net/third_party/quiche/src/quic/core/frames/quic_stop_sending_frame.h" 29 #include "net/third_party/quiche/src/quic/core/frames/quic_stop_waiting_frame.h" 30 #include "net/third_party/quiche/src/quic/core/frames/quic_stream_frame.h" 31 #include "net/third_party/quiche/src/quic/core/frames/quic_streams_blocked_frame.h" 32 #include "net/third_party/quiche/src/quic/core/frames/quic_window_update_frame.h" 33 #include "net/third_party/quiche/src/quic/core/quic_types.h" 34 #include "net/third_party/quiche/src/quic/platform/api/quic_containers.h" 35 #include "net/third_party/quiche/src/quic/platform/api/quic_export.h" 36 37 namespace quic { 38 39 struct QUIC_EXPORT_PRIVATE QuicFrame { 40 QuicFrame(); 41 // Please keep the constructors in the same order as the union below. 42 explicit QuicFrame(QuicPaddingFrame padding_frame); 43 explicit QuicFrame(QuicMtuDiscoveryFrame frame); 44 explicit QuicFrame(QuicPingFrame frame); 45 explicit QuicFrame(QuicMaxStreamsFrame frame); 46 explicit QuicFrame(QuicStopWaitingFrame frame); 47 explicit QuicFrame(QuicStreamsBlockedFrame frame); 48 explicit QuicFrame(QuicStreamFrame stream_frame); 49 explicit QuicFrame(QuicHandshakeDoneFrame handshake_done_frame); 50 51 explicit QuicFrame(QuicAckFrame* frame); 52 explicit QuicFrame(QuicRstStreamFrame* frame); 53 explicit QuicFrame(QuicConnectionCloseFrame* frame); 54 explicit QuicFrame(QuicGoAwayFrame* frame); 55 explicit QuicFrame(QuicWindowUpdateFrame* frame); 56 explicit QuicFrame(QuicBlockedFrame* frame); 57 explicit QuicFrame(QuicNewConnectionIdFrame* frame); 58 explicit QuicFrame(QuicRetireConnectionIdFrame* frame); 59 explicit QuicFrame(QuicNewTokenFrame* frame); 60 explicit QuicFrame(QuicPathResponseFrame* frame); 61 explicit QuicFrame(QuicPathChallengeFrame* frame); 62 explicit QuicFrame(QuicStopSendingFrame* frame); 63 explicit QuicFrame(QuicMessageFrame* message_frame); 64 explicit QuicFrame(QuicCryptoFrame* crypto_frame); 65 66 QUIC_EXPORT_PRIVATE friend std::ostream& operator<<(std::ostream& os, 67 const QuicFrame& frame); 68 69 union { 70 // Inlined frames. 71 // Overlapping inlined frames have a |type| field at the same 0 offset as 72 // QuicFrame does for out of line frames below, allowing use of the 73 // remaining 7 bytes after offset for frame-type specific fields. 74 QuicPaddingFrame padding_frame; 75 QuicMtuDiscoveryFrame mtu_discovery_frame; 76 QuicPingFrame ping_frame; 77 QuicMaxStreamsFrame max_streams_frame; 78 QuicStopWaitingFrame stop_waiting_frame; 79 QuicStreamsBlockedFrame streams_blocked_frame; 80 QuicStreamFrame stream_frame; 81 QuicHandshakeDoneFrame handshake_done_frame; 82 83 // Out of line frames. 84 struct { 85 QuicFrameType type; 86 87 // TODO(wub): These frames can also be inlined without increasing the size 88 // of QuicFrame: QuicRstStreamFrame, QuicWindowUpdateFrame, 89 // QuicBlockedFrame, QuicPathResponseFrame, QuicPathChallengeFrame and 90 // QuicStopSendingFrame. 91 union { 92 QuicAckFrame* ack_frame; 93 QuicRstStreamFrame* rst_stream_frame; 94 QuicConnectionCloseFrame* connection_close_frame; 95 QuicGoAwayFrame* goaway_frame; 96 QuicWindowUpdateFrame* window_update_frame; 97 QuicBlockedFrame* blocked_frame; 98 QuicNewConnectionIdFrame* new_connection_id_frame; 99 QuicRetireConnectionIdFrame* retire_connection_id_frame; 100 QuicPathResponseFrame* path_response_frame; 101 QuicPathChallengeFrame* path_challenge_frame; 102 QuicStopSendingFrame* stop_sending_frame; 103 QuicMessageFrame* message_frame; 104 QuicCryptoFrame* crypto_frame; 105 QuicNewTokenFrame* new_token_frame; 106 }; 107 }; 108 }; 109 }; 110 111 static_assert(sizeof(QuicFrame) <= 24, 112 "Frames larger than 24 bytes should be referenced by pointer."); 113 static_assert(offsetof(QuicStreamFrame, type) == offsetof(QuicFrame, type), 114 "Offset of |type| must match in QuicFrame and QuicStreamFrame"); 115 116 // A inline size of 1 is chosen to optimize the typical use case of 117 // 1-stream-frame in QuicTransmissionInfo.retransmittable_frames. 118 typedef QuicInlinedVector<QuicFrame, 1> QuicFrames; 119 120 // Deletes all the sub-frames contained in |frames|. 121 QUIC_EXPORT_PRIVATE void DeleteFrames(QuicFrames* frames); 122 123 // Delete the sub-frame contained in |frame|. 124 QUIC_EXPORT_PRIVATE void DeleteFrame(QuicFrame* frame); 125 126 // Deletes all the QuicStreamFrames for the specified |stream_id|. 127 QUIC_EXPORT_PRIVATE void RemoveFramesForStream(QuicFrames* frames, 128 QuicStreamId stream_id); 129 130 // Returns true if |type| is a retransmittable control frame. 131 QUIC_EXPORT_PRIVATE bool IsControlFrame(QuicFrameType type); 132 133 // Returns control_frame_id of |frame|. Returns kInvalidControlFrameId if 134 // |frame| does not have a valid control_frame_id. 135 QUIC_EXPORT_PRIVATE QuicControlFrameId 136 GetControlFrameId(const QuicFrame& frame); 137 138 // Sets control_frame_id of |frame| to |control_frame_id|. 139 QUIC_EXPORT_PRIVATE void SetControlFrameId(QuicControlFrameId control_frame_id, 140 QuicFrame* frame); 141 142 // Returns a copy of |frame|. 143 QUIC_EXPORT_PRIVATE QuicFrame 144 CopyRetransmittableControlFrame(const QuicFrame& frame); 145 146 // Returns a copy of |frame|. 147 QUIC_EXPORT_PRIVATE QuicFrame CopyQuicFrame(QuicBufferAllocator* allocator, 148 const QuicFrame& frame); 149 150 // Returns a copy of |frames|. 151 QUIC_EXPORT_PRIVATE QuicFrames CopyQuicFrames(QuicBufferAllocator* allocator, 152 const QuicFrames& frames); 153 154 // Human-readable description suitable for logging. 155 QUIC_EXPORT_PRIVATE std::string QuicFramesToString(const QuicFrames& frames); 156 157 } // namespace quic 158 159 #endif // QUICHE_QUIC_CORE_FRAMES_QUIC_FRAME_H_ 160