package ackhandler import ( "errors" "time" "github.com/lucas-clemente/quic-go/frames" "github.com/lucas-clemente/quic-go/protocol" ) var ( // ErrDuplicateOrOutOfOrderAck occurs when a duplicate or an out-of-order ACK is received ErrDuplicateOrOutOfOrderAck = errors.New("SentPacketHandler: Duplicate or out-of-order ACK") // ErrEntropy occurs when an ACK with incorrect entropy is received ErrEntropy = errors.New("SentPacketHandler: Wrong entropy") // ErrMapAccess occurs when a NACK contains invalid NACK ranges ErrMapAccess = errors.New("SentPacketHandler: Packet does not exist in PacketHistory") ) var ( errAckForUnsentPacket = errors.New("SentPacketHandler: Received ACK for an unsent package") retransmissionThreshold = uint8(3) ) type sentPacketHandler struct { lastSentPacketNumber protocol.PacketNumber lastSentPacketEntropy EntropyAccumulator highestInOrderAckedPacketNumber protocol.PacketNumber LargestObserved protocol.PacketNumber LargestObservedEntropy EntropyAccumulator // TODO: Move into separate class as in chromium packetHistory map[protocol.PacketNumber]*Packet retransmissionQueue []*Packet // ToDo: use better data structure stopWaitingManager StopWaitingManager bytesInFlight protocol.ByteCount } // NewSentPacketHandler creates a new sentPacketHandler func NewSentPacketHandler(stopWaitingManager StopWaitingManager) SentPacketHandler { return &sentPacketHandler{ packetHistory: make(map[protocol.PacketNumber]*Packet), stopWaitingManager: stopWaitingManager, } } func (h *sentPacketHandler) ackPacket(packetNumber protocol.PacketNumber) *Packet { packet, ok := h.packetHistory[packetNumber] if ok && !packet.Retransmitted { h.bytesInFlight -= packet.Length } delete(h.packetHistory, packetNumber) // TODO: add tests h.stopWaitingManager.ReceivedAckForPacketNumber(packetNumber) return packet } func (h *sentPacketHandler) nackPacket(packetNumber protocol.PacketNumber) (*Packet, error) { packet, ok := h.packetHistory[packetNumber] if !ok { return nil, ErrMapAccess } // If the packet has already been retransmitted, do nothing. // We're probably only receiving another NACK for this packet because the // retransmission has not yet arrived at the client. if packet.Retransmitted { return nil, nil } packet.MissingReports++ if packet.MissingReports > retransmissionThreshold { h.queuePacketForRetransmission(packet) return packet, nil } return nil, nil } func (h *sentPacketHandler) queuePacketForRetransmission(packet *Packet) { h.bytesInFlight -= packet.Length h.retransmissionQueue = append(h.retransmissionQueue, packet) packet.Retransmitted = true } func (h *sentPacketHandler) SentPacket(packet *Packet) error { _, ok := h.packetHistory[packet.PacketNumber] if ok { return errors.New("Packet number already exists in Packet History") } if h.lastSentPacketNumber+1 != packet.PacketNumber { return errors.New("Packet number must be increased by exactly 1") } packet.sendTime = time.Now() if packet.Length == 0 { panic("SentPacketHandler: packet cannot be empty") } h.bytesInFlight += packet.Length h.lastSentPacketEntropy.Add(packet.PacketNumber, packet.EntropyBit) packet.Entropy = h.lastSentPacketEntropy h.lastSentPacketNumber = packet.PacketNumber h.packetHistory[packet.PacketNumber] = packet return nil } func (h *sentPacketHandler) calculateExpectedEntropy(ackFrame *frames.AckFrame) (EntropyAccumulator, error) { packet, ok := h.packetHistory[ackFrame.LargestObserved] if !ok { return 0, ErrMapAccess } expectedEntropy := packet.Entropy if ackFrame.HasNACK() { // if the packet has NACKs, the entropy value has to be calculated nackRangeIndex := 0 nackRange := ackFrame.NackRanges[nackRangeIndex] for i := ackFrame.LargestObserved; i > ackFrame.GetHighestInOrderPacketNumber(); i-- { if i < nackRange.FirstPacketNumber { nackRangeIndex++ if nackRangeIndex < len(ackFrame.NackRanges) { nackRange = ackFrame.NackRanges[nackRangeIndex] } } if nackRange.ContainsPacketNumber(i) { packet, ok := h.packetHistory[i] if !ok { return 0, ErrMapAccess } expectedEntropy.Subtract(i, packet.EntropyBit) } } } return expectedEntropy, nil } // TODO: Simplify return types func (h *sentPacketHandler) ReceivedAck(ackFrame *frames.AckFrame) (time.Duration, []*Packet, []*Packet, error) { if ackFrame.LargestObserved > h.lastSentPacketNumber { return 0, nil, nil, errAckForUnsentPacket } if ackFrame.LargestObserved <= h.LargestObserved { // duplicate or out-of-order AckFrame return 0, nil, nil, ErrDuplicateOrOutOfOrderAck } expectedEntropy, err := h.calculateExpectedEntropy(ackFrame) if err != nil { return 0, nil, nil, err } if byte(expectedEntropy) != ackFrame.Entropy { return 0, nil, nil, ErrEntropy } // Entropy ok. Now actually process the ACK packet h.LargestObserved = ackFrame.LargestObserved highestInOrderAckedPacketNumber := ackFrame.GetHighestInOrderPacketNumber() // Calculate the RTT timeDelta := time.Now().Sub(h.packetHistory[h.LargestObserved].sendTime) var ackedPackets []*Packet var lostPackets []*Packet // ACK all packets below the highestInOrderAckedPacketNumber for i := h.highestInOrderAckedPacketNumber; i <= highestInOrderAckedPacketNumber; i++ { p := h.ackPacket(i) if p != nil { ackedPackets = append(ackedPackets, p) } } if ackFrame.HasNACK() { nackRangeIndex := 0 nackRange := ackFrame.NackRanges[nackRangeIndex] for i := ackFrame.LargestObserved; i > ackFrame.GetHighestInOrderPacketNumber(); i-- { if i < nackRange.FirstPacketNumber { nackRangeIndex++ if nackRangeIndex < len(ackFrame.NackRanges) { nackRange = ackFrame.NackRanges[nackRangeIndex] } } if nackRange.ContainsPacketNumber(i) { p, err := h.nackPacket(i) if err != nil { return 0, nil, nil, err } if p != nil { lostPackets = append(lostPackets, p) } } else { p := h.ackPacket(i) if p != nil { ackedPackets = append(ackedPackets, p) } } } } h.highestInOrderAckedPacketNumber = highestInOrderAckedPacketNumber return timeDelta, ackedPackets, lostPackets, nil } func (h *sentPacketHandler) DequeuePacketForRetransmission() (packet *Packet) { if len(h.retransmissionQueue) == 0 { return nil } packet = h.retransmissionQueue[0] h.retransmissionQueue = h.retransmissionQueue[1:] return packet } func (h *sentPacketHandler) BytesInFlight() protocol.ByteCount { return h.bytesInFlight }