Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

don't allocate a wire.Header when parsing short header packets #2928

Closed
wants to merge 7 commits into from
Closed

don't allocate a wire.Header when parsing short header packets #2928

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1766218
use separate trace functions for sending long and short header packets
marten-seemann Nov 25, 2020
1055228
use separate trace functions for receiving long and short header packets
marten-seemann Nov 25, 2020
2f8f0a5
add a function to distinguish between short and long header packets
marten-seemann Dec 6, 2020
e7af894
add a function to check the value of the short header resevered bits
marten-seemann Dec 6, 2020
90cf773
add a function to read the key phase bit in short header packets
marten-seemann Dec 6, 2020
0ab2ef3
add a function to parse the packet number
marten-seemann Dec 6, 2020
ff69ca6
avoid allocation a wire.Header when parsing short header packets
marten-seemann Dec 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions integrationtests/self/key_update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,11 @@ func (t *connTracer) SentShortHeaderPacket(_ logging.ConnectionID, _ logging.Pac
}
func (t *connTracer) ReceivedVersionNegotiationPacket(*logging.Header, []logging.VersionNumber) {}
func (t *connTracer) ReceivedRetry(*logging.Header) {}
func (t *connTracer) ReceivedPacket(hdr *logging.ExtendedHeader, size logging.ByteCount, frames []logging.Frame) {
receivedKeyPhases = append(receivedKeyPhases, hdr.KeyPhase)
func (t *connTracer) ReceivedLongHeaderPacket(*logging.ExtendedHeader, logging.ByteCount, []logging.Frame) {
}

func (t *connTracer) ReceivedShortHeaderPacket(_ logging.ConnectionID, _ logging.PacketNumber, kp logging.KeyPhaseBit, _ logging.ByteCount, _ []logging.Frame) {
receivedKeyPhases = append(receivedKeyPhases, kp)
}
func (t *connTracer) BufferedPacket(logging.PacketType) {}
func (t *connTracer) DroppedPacket(logging.PacketType, logging.ByteCount, logging.PacketDropReason) {}
Expand Down
24 changes: 18 additions & 6 deletions internal/mocks/logging/connection_tracer.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion logging/interface.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ type ConnectionTracer interface {
SentShortHeaderPacket(destConnID ConnectionID, pn PacketNumber, kp KeyPhaseBit, size ByteCount, ack *AckFrame, frames []Frame)
ReceivedVersionNegotiationPacket(*Header, []VersionNumber)
ReceivedRetry(*Header)
ReceivedPacket(hdr *ExtendedHeader, size ByteCount, frames []Frame)
ReceivedLongHeaderPacket(hdr *ExtendedHeader, size ByteCount, frames []Frame)
ReceivedShortHeaderPacket(destConnID ConnectionID, pn PacketNumber, kp KeyPhaseBit, size ByteCount, frames []Frame)
BufferedPacket(PacketType)
DroppedPacket(PacketType, ByteCount, PacketDropReason)
UpdatedMetrics(rttStats *RTTStats, cwnd, bytesInFlight ByteCount, packetsInFlight int)
Expand Down
24 changes: 18 additions & 6 deletions logging/mock_connection_tracer_test.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions logging/multiplex.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,15 @@ func (m *connTracerMultiplexer) ReceivedRetry(hdr *Header) {
}
}

func (m *connTracerMultiplexer) ReceivedPacket(hdr *ExtendedHeader, size ByteCount, frames []Frame) {
func (m *connTracerMultiplexer) ReceivedLongHeaderPacket(hdr *ExtendedHeader, size ByteCount, frames []Frame) {
for _, t := range m.tracers {
t.ReceivedPacket(hdr, size, frames)
t.ReceivedLongHeaderPacket(hdr, size, frames)
}
}

func (m *connTracerMultiplexer) ReceivedShortHeaderPacket(destConnID ConnectionID, pn PacketNumber, kp KeyPhaseBit, size ByteCount, frames []Frame) {
for _, t := range m.tracers {
t.ReceivedShortHeaderPacket(destConnID, pn, kp, size, frames)
}
}

Expand Down
15 changes: 11 additions & 4 deletions logging/multiplex_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,19 @@ var _ = Describe("Tracing", func() {
tracer.ReceivedRetry(hdr)
})

It("traces the ReceivedPacket event", func() {
It("traces the ReceivedLongHeaderPacket event", func() {
hdr := &ExtendedHeader{Header: Header{DestConnectionID: ConnectionID{1, 2, 3}}}
ping := &PingFrame{}
tr1.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping})
tr2.EXPECT().ReceivedPacket(hdr, ByteCount(1337), []Frame{ping})
tracer.ReceivedPacket(hdr, 1337, []Frame{ping})
tr1.EXPECT().ReceivedLongHeaderPacket(hdr, ByteCount(1337), []Frame{ping})
tr2.EXPECT().ReceivedLongHeaderPacket(hdr, ByteCount(1337), []Frame{ping})
tracer.ReceivedLongHeaderPacket(hdr, 1337, []Frame{ping})
})

It("traces the ReceivedShortHeaderPacket event", func() {
ping := &PingFrame{}
tr1.EXPECT().ReceivedShortHeaderPacket(ConnectionID{1, 2, 3}, PacketNumber(123), KeyPhaseOne, ByteCount(1337), []Frame{ping})
tr2.EXPECT().ReceivedShortHeaderPacket(ConnectionID{1, 2, 3}, PacketNumber(123), KeyPhaseOne, ByteCount(1337), []Frame{ping})
tracer.ReceivedShortHeaderPacket(ConnectionID{1, 2, 3}, 123, KeyPhaseOne, 1337, []Frame{ping})
})

It("traces the BufferedPacket event", func() {
Expand Down
5 changes: 4 additions & 1 deletion metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,10 @@ func (t *connTracer) SentShortHeaderPacket(logging.ConnectionID, logging.PacketN
}
func (t *connTracer) ReceivedVersionNegotiationPacket(*logging.Header, []logging.VersionNumber) {}
func (t *connTracer) ReceivedRetry(*logging.Header) {}
func (t *connTracer) ReceivedPacket(*logging.ExtendedHeader, logging.ByteCount, []logging.Frame) {
func (t *connTracer) ReceivedLongHeaderPacket(*logging.ExtendedHeader, logging.ByteCount, []logging.Frame) {
}

func (t *connTracer) ReceivedShortHeaderPacket(logging.ConnectionID, logging.PacketNumber, logging.KeyPhaseBit, logging.ByteCount, []logging.Frame) {
}
func (t *connTracer) BufferedPacket(logging.PacketType) {}
func (t *connTracer) DroppedPacket(logging.PacketType, logging.ByteCount, logging.PacketDropReason) {}
Expand Down
21 changes: 20 additions & 1 deletion qlog/qlog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ func (t *connectionTracer) SentShortHeaderPacket(destConnID logging.ConnectionID
t.mutex.Unlock()
}

func (t *connectionTracer) ReceivedPacket(hdr *wire.ExtendedHeader, packetSize protocol.ByteCount, frames []logging.Frame) {
func (t *connectionTracer) ReceivedLongHeaderPacket(hdr *wire.ExtendedHeader, packetSize protocol.ByteCount, frames []logging.Frame) {
fs := make([]frame, len(frames))
for i, f := range frames {
fs[i] = frame{Frame: f}
Expand All @@ -272,6 +272,25 @@ func (t *connectionTracer) ReceivedPacket(hdr *wire.ExtendedHeader, packetSize p
t.mutex.Unlock()
}

func (t *connectionTracer) ReceivedShortHeaderPacket(destConnID logging.ConnectionID, pn logging.PacketNumber, kp logging.KeyPhaseBit, size protocol.ByteCount, frames []logging.Frame) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As before: If you're constructing the Header{} struct anyway, why not do that when calling this function? That would make things more symmetrical with the LongHeader version, and may even allow you to call the Short version from the Long function?

fs := make([]frame, len(frames))
for i, f := range frames {
fs[i] = frame{Frame: f}
}
t.mutex.Lock()
t.recordEvent(time.Now(), &eventPacketReceived{
Header: packetHeader{
PacketType: logging.PacketType1RTT,
DestConnectionID: destConnID,
PacketNumber: pn,
KeyPhaseBit: kp,
PacketSize: size,
},
Frames: fs,
})
t.mutex.Unlock()
}

func (t *connectionTracer) ReceivedRetry(hdr *wire.Header) {
t.mutex.Lock()
t.recordEvent(time.Now(), &eventRetryReceived{
Expand Down
30 changes: 28 additions & 2 deletions qlog/qlog_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,8 +440,8 @@ var _ = Describe("Tracing", func() {
Expect(frames[1].(map[string]interface{})).To(HaveKeyWithValue("frame_type", "max_data"))
})

It("records a received packet", func() {
tracer.ReceivedPacket(
It("records a received long header packet", func() {
tracer.ReceivedLongHeaderPacket(
&logging.ExtendedHeader{
Header: logging.Header{
IsLongHeader: true,
Expand Down Expand Up @@ -476,6 +476,32 @@ var _ = Describe("Tracing", func() {
Expect(ev["frames"].([]interface{})).To(HaveLen(2))
})

It("records a received short header packet", func() {
tracer.ReceivedShortHeaderPacket(
protocol.ConnectionID{1, 2, 3, 4, 5, 6, 7, 8},
1337,
logging.KeyPhaseOne,
789,
[]logging.Frame{
&logging.MaxStreamDataFrame{StreamID: 42, MaximumStreamData: 987},
&logging.StreamFrame{StreamID: 123, Offset: 1234, Length: 6, Fin: true},
},
)
entry := exportAndParseSingle()
Expect(entry.Time).To(BeTemporally("~", time.Now(), scaleDuration(10*time.Millisecond)))
Expect(entry.Name).To(Equal("transport:packet_received"))
ev := entry.Event
Expect(ev).To(HaveKey("header"))
hdr := ev["header"].(map[string]interface{})
Expect(hdr).To(HaveKeyWithValue("packet_type", "1RTT"))
Expect(hdr).To(HaveKeyWithValue("packet_size", float64(789)))
Expect(hdr).To(HaveKeyWithValue("packet_number", float64(1337)))
Expect(hdr).To(HaveKeyWithValue("key_phase_bit", "1"))
Expect(hdr).ToNot(HaveKey("scid"))
Expect(ev).To(HaveKey("frames"))
Expect(ev["frames"].([]interface{})).To(HaveLen(2))
})

It("records a received Retry packet", func() {
tracer.ReceivedRetry(
&logging.Header{
Expand Down
6 changes: 5 additions & 1 deletion session.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,11 @@ func (s *session) handleUnpackedPacket(
for i, frame := range frames {
fs[i] = logutils.ConvertFrame(frame)
}
s.tracer.ReceivedPacket(packet.hdr, packetSize, fs)
if packet.hdr.IsLongHeader {
s.tracer.ReceivedLongHeaderPacket(packet.hdr, packetSize, fs)
} else {
s.tracer.ReceivedShortHeaderPacket(packet.hdr.DestConnectionID, packet.hdr.PacketNumber, packet.hdr.KeyPhase, packetSize, fs)
}
for _, frame := range frames {
if err := s.handleFrame(frame, packet.encryptionLevel, packet.hdr.DestConnectionID); err != nil {
return err
Expand Down