forked from quic-go/quic-go
add a wire.ShortHeader, implement short header parsing
The new parsing function is vastly faster than the combination of header and extended header parsing: BenchmarkShortHeaderParsing-10 44192314 26.79 ns/op 48 B/op 1 allocs/op BenchmarkShortHeaderParsingOld-10 12627363 99.99 ns/op 228 B/op 3 allocs/op
This commit is contained in:
Marten Seemann
73
internal/wire/short_header.go
Normal file
73
internal/wire/short_header.go
Normal file
@@ -0,0 +1,73 @@
|
||||
package wire
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/lucas-clemente/quic-go/internal/protocol"
|
||||
"github.com/lucas-clemente/quic-go/internal/utils"
|
||||
)
|
||||
|
||||
type ShortHeader struct {
|
||||
DestConnectionID protocol.ConnectionID
|
||||
PacketNumber protocol.PacketNumber
|
||||
PacketNumberLen protocol.PacketNumberLen
|
||||
KeyPhase protocol.KeyPhaseBit
|
||||
}
|
||||
|
||||
func ParseShortHeader(data []byte, connIDLen int) (*ShortHeader, error) {
|
||||
if len(data) == 0 {
|
||||
return nil, io.EOF
|
||||
}
|
||||
if data[0]&0x80 > 0 {
|
||||
return nil, errors.New("not a short header packet")
|
||||
}
|
||||
if data[0]&0x40 == 0 {
|
||||
return nil, errors.New("not a QUIC packet")
|
||||
}
|
||||
pnLen := protocol.PacketNumberLen(data[0]&0b11) + 1
|
||||
if len(data) < 1+int(pnLen)+connIDLen {
|
||||
return nil, io.EOF
|
||||
}
|
||||
destConnID := protocol.ParseConnectionID(data[1 : 1+connIDLen])
|
||||
|
||||
pos := 1 + connIDLen
|
||||
var pn protocol.PacketNumber
|
||||
switch pnLen {
|
||||
case protocol.PacketNumberLen1:
|
||||
pn = protocol.PacketNumber(data[pos])
|
||||
case protocol.PacketNumberLen2:
|
||||
pn = protocol.PacketNumber(utils.BigEndian.Uint16(data[pos : pos+2]))
|
||||
case protocol.PacketNumberLen3:
|
||||
pn = protocol.PacketNumber(utils.BigEndian.Uint24(data[pos : pos+3]))
|
||||
case protocol.PacketNumberLen4:
|
||||
pn = protocol.PacketNumber(utils.BigEndian.Uint32(data[pos : pos+4]))
|
||||
default:
|
||||
return nil, fmt.Errorf("invalid packet number length: %d", pnLen)
|
||||
}
|
||||
kp := protocol.KeyPhaseZero
|
||||
if data[0]&0b100 > 0 {
|
||||
kp = protocol.KeyPhaseOne
|
||||
}
|
||||
|
||||
var err error
|
||||
if data[0]&0x18 != 0 {
|
||||
err = ErrInvalidReservedBits
|
||||
}
|
||||
return &ShortHeader{
|
||||
DestConnectionID: destConnID,
|
||||
PacketNumber: pn,
|
||||
PacketNumberLen: pnLen,
|
||||
KeyPhase: kp,
|
||||
}, err
|
||||
}
|
||||
|
||||
func (h *ShortHeader) Len() protocol.ByteCount {
|
||||
return 1 + protocol.ByteCount(h.DestConnectionID.Len()) + protocol.ByteCount(h.PacketNumberLen)
|
||||
}
|
||||
|
||||
// Log logs the Header
|
||||
func (h *ShortHeader) Log(logger utils.Logger) {
|
||||
logger.Debugf("\tShort Header{DestConnectionID: %s, PacketNumber: %d, PacketNumberLen: %d, KeyPhase: %s}", h.DestConnectionID, h.PacketNumber, h.PacketNumberLen, h.KeyPhase)
|
||||
}
|
||||
110
internal/wire/short_header_test.go
Normal file
110
internal/wire/short_header_test.go
Normal file
@@ -0,0 +1,110 @@
|
||||
package wire
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"log"
|
||||
"os"
|
||||
|
||||
"github.com/lucas-clemente/quic-go/internal/protocol"
|
||||
"github.com/lucas-clemente/quic-go/internal/utils"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
var _ = Describe("Short Header", func() {
|
||||
Context("Parsing", func() {
|
||||
It("parses", func() {
|
||||
data := []byte{
|
||||
0b01000110,
|
||||
0xde, 0xad, 0xbe, 0xef,
|
||||
0x13, 0x37, 0x99,
|
||||
}
|
||||
hdr, err := ParseShortHeader(data, 4)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(hdr.DestConnectionID).To(Equal(protocol.ParseConnectionID([]byte{0xde, 0xad, 0xbe, 0xef})))
|
||||
Expect(hdr.KeyPhase).To(Equal(protocol.KeyPhaseOne))
|
||||
Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0x133799)))
|
||||
Expect(hdr.PacketNumberLen).To(Equal(protocol.PacketNumberLen3))
|
||||
})
|
||||
|
||||
It("errors when the QUIC bit is not set", func() {
|
||||
data := []byte{
|
||||
0b00000101,
|
||||
0xde, 0xad, 0xbe, 0xef,
|
||||
0x13, 0x37,
|
||||
}
|
||||
_, err := ParseShortHeader(data, 4)
|
||||
Expect(err).To(MatchError("not a QUIC packet"))
|
||||
})
|
||||
|
||||
It("errors, but returns the header, when the reserved bits are set", func() {
|
||||
data := []byte{
|
||||
0b01010101,
|
||||
0xde, 0xad, 0xbe, 0xef,
|
||||
0x13, 0x37,
|
||||
}
|
||||
hdr, err := ParseShortHeader(data, 4)
|
||||
Expect(err).To(MatchError(ErrInvalidReservedBits))
|
||||
Expect(hdr).ToNot(BeNil())
|
||||
Expect(hdr.PacketNumber).To(Equal(protocol.PacketNumber(0x1337)))
|
||||
})
|
||||
|
||||
It("errors when passed a long header packet", func() {
|
||||
_, err := ParseShortHeader([]byte{0x80}, 4)
|
||||
Expect(err).To(MatchError("not a short header packet"))
|
||||
})
|
||||
|
||||
It("errors on EOF", func() {
|
||||
data := []byte{
|
||||
0b01000110,
|
||||
0xde, 0xad, 0xbe, 0xef,
|
||||
0x13, 0x37, 0x99,
|
||||
}
|
||||
_, err := ParseShortHeader(data, 4)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
for i := range data {
|
||||
_, err := ParseShortHeader(data[:i], 4)
|
||||
Expect(err).To(MatchError(io.EOF))
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
Context("logging", func() {
|
||||
var (
|
||||
buf *bytes.Buffer
|
||||
logger utils.Logger
|
||||
)
|
||||
|
||||
BeforeEach(func() {
|
||||
buf = &bytes.Buffer{}
|
||||
logger = utils.DefaultLogger
|
||||
logger.SetLogLevel(utils.LogLevelDebug)
|
||||
log.SetOutput(buf)
|
||||
})
|
||||
|
||||
AfterEach(func() {
|
||||
log.SetOutput(os.Stdout)
|
||||
})
|
||||
|
||||
It("logs Short Headers containing a connection ID", func() {
|
||||
(&ShortHeader{
|
||||
DestConnectionID: protocol.ParseConnectionID([]byte{0xde, 0xad, 0xbe, 0xef, 0xca, 0xfe, 0x13, 0x37}),
|
||||
KeyPhase: protocol.KeyPhaseOne,
|
||||
PacketNumber: 1337,
|
||||
PacketNumberLen: 4,
|
||||
}).Log(logger)
|
||||
Expect(buf.String()).To(ContainSubstring("Short Header{DestConnectionID: deadbeefcafe1337, PacketNumber: 1337, PacketNumberLen: 4, KeyPhase: 1}"))
|
||||
})
|
||||
})
|
||||
|
||||
It("determines the length", func() {
|
||||
Expect((&ShortHeader{
|
||||
DestConnectionID: protocol.ParseConnectionID([]byte{0xde, 0xaf}),
|
||||
PacketNumber: 0x1337,
|
||||
PacketNumberLen: protocol.PacketNumberLen3,
|
||||
KeyPhase: protocol.KeyPhaseOne,
|
||||
}).Len()).To(Equal(protocol.ByteCount(1 + 2 + 3)))
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user