xref: /dragonfly/sys/netinet/tcp_sack.c (revision 8accc937)

/*
 * Copyright (c) 2003, 2004 Jeffrey M. Hsu.  All rights reserved.
 * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Jeffrey M. Hsu.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $DragonFly: src/sys/netinet/tcp_sack.c,v 1.8 2008/08/15 21:37:16 nth Exp $
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/queue.h>
#include <sys/thread.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/socketvar.h>

#include <net/if.h>

#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <netinet/ip.h>
#include <netinet/in_var.h>
#include <netinet/in_pcb.h>
#include <netinet/ip_var.h>
#include <netinet/tcp.h>
#include <netinet/tcp_seq.h>
#include <netinet/tcp_var.h>

/*
 * Implemented:
 *
 * RFC 2018
 * RFC 2883
 * RFC 3517
 * RFC 6675
 */

struct sackblock {
	tcp_seq			sblk_start;
	tcp_seq			sblk_end;
	TAILQ_ENTRY(sackblock)	sblk_list;
};

#define	MAXSAVEDBLOCKS	8			/* per connection limit */

static int insert_block(struct scoreboard *scb,
			const struct raw_sackblock *raw_sb, boolean_t *update);

static MALLOC_DEFINE(M_SACKBLOCK, "sblk", "sackblock struct");

/*
 * Per-tcpcb initialization.
 */
void
tcp_sack_tcpcb_init(struct tcpcb *tp)
{
	struct scoreboard *scb = &tp->scb;

	scb->nblocks = 0;
	TAILQ_INIT(&scb->sackblocks);
	scb->lastfound = NULL;
}

/*
 * Find the SACK block containing or immediately preceding "seq".
 * The boolean result indicates whether the sequence is actually
 * contained in the SACK block.
 */
static boolean_t
sack_block_lookup(struct scoreboard *scb, tcp_seq seq, struct sackblock **sb)
{
	struct sackblock *hint = scb->lastfound;
	struct sackblock *cur, *last, *prev;

	if (TAILQ_EMPTY(&scb->sackblocks)) {
		*sb = NULL;
		return FALSE;
	}

	if (hint == NULL) {
		/* No hint.  Search from start to end. */
		cur = TAILQ_FIRST(&scb->sackblocks);
		last = NULL;
		prev = TAILQ_LAST(&scb->sackblocks, sackblock_list);
	} else  {
		if (SEQ_GEQ(seq, hint->sblk_start)) {
			/* Search from hint to end of list. */
			cur = hint;
			last = NULL;
			prev = TAILQ_LAST(&scb->sackblocks, sackblock_list);
		} else {
			/* Search from front of list to hint. */
			cur = TAILQ_FIRST(&scb->sackblocks);
			last = hint;
			prev = TAILQ_PREV(hint, sackblock_list, sblk_list);
		}
	}

	do {
		if (SEQ_GT(cur->sblk_end, seq)) {
			if (SEQ_GEQ(seq, cur->sblk_start)) {
				*sb = scb->lastfound = cur;
				return TRUE;
			} else {
				*sb = scb->lastfound =
				    TAILQ_PREV(cur, sackblock_list, sblk_list);
				return FALSE;
			}
		}
		cur = TAILQ_NEXT(cur, sblk_list);
	} while (cur != last);

	*sb = scb->lastfound = prev;
	return FALSE;
}

/*
 * Allocate a SACK block.
 */
static __inline struct sackblock *
alloc_sackblock(struct scoreboard *scb, const struct raw_sackblock *raw_sb)
{
	struct sackblock *sb;

	if (scb->freecache != NULL) {
		sb = scb->freecache;
		scb->freecache = NULL;
		tcpstat.tcps_sacksbfast++;
	} else {
		sb = kmalloc(sizeof(struct sackblock), M_SACKBLOCK, M_NOWAIT);
		if (sb == NULL) {
			tcpstat.tcps_sacksbfailed++;
			return NULL;
		}
	}
	sb->sblk_start = raw_sb->rblk_start;
	sb->sblk_end = raw_sb->rblk_end;
	return sb;
}

static __inline struct sackblock *
alloc_sackblock_limit(struct scoreboard *scb,
    const struct raw_sackblock *raw_sb)
{
	if (scb->nblocks == MAXSAVEDBLOCKS) {
		/*
		 * Should try to kick out older blocks XXX JH
		 * May be able to coalesce with existing block.
		 * Or, go other way and free all blocks if we hit
		 * this limit.
		 */
		tcpstat.tcps_sacksboverflow++;
		return NULL;
	}
	return alloc_sackblock(scb, raw_sb);
}

/*
 * Free a SACK block.
 */
static __inline void
free_sackblock(struct scoreboard *scb, struct sackblock *s)
{
	if (scb->freecache == NULL) {
		/* YYY Maybe use the latest freed block? */
		scb->freecache = s;
		return;
	}
	kfree(s, M_SACKBLOCK);
}

/*
 * Free up SACK blocks for data that's been acked.
 */
static void
tcp_sack_ack_blocks(struct tcpcb *tp, tcp_seq th_ack)
{
	struct scoreboard *scb = &tp->scb;
	struct sackblock *sb, *nb;

	sb = TAILQ_FIRST(&scb->sackblocks);
	while (sb && SEQ_LEQ(sb->sblk_end, th_ack)) {
		nb = TAILQ_NEXT(sb, sblk_list);
		if (scb->lastfound == sb)
			scb->lastfound = NULL;
		TAILQ_REMOVE(&scb->sackblocks, sb, sblk_list);
		free_sackblock(scb, sb);
		--scb->nblocks;
		KASSERT(scb->nblocks >= 0,
		    ("SACK block count underflow: %d < 0", scb->nblocks));
		sb = nb;
	}
	if (sb && SEQ_GEQ(th_ack, sb->sblk_start)) {
		/* Other side reneged? XXX */
		tcpstat.tcps_sackrenege++;
		tcp_sack_discard(tp);
	}
}

/*
 * Delete and free SACK blocks saved in scoreboard.
 */
static void
tcp_sack_cleanup(struct scoreboard *scb)
{
	struct sackblock *sb, *nb;

	TAILQ_FOREACH_MUTABLE(sb, &scb->sackblocks, sblk_list, nb) {
		free_sackblock(scb, sb);
		--scb->nblocks;
	}
	KASSERT(scb->nblocks == 0,
	    ("SACK block %d count not zero", scb->nblocks));
	TAILQ_INIT(&scb->sackblocks);
	scb->lastfound = NULL;
}

/*
 * Discard SACK scoreboard, HighRxt, RescueRxt and LostSeq.
 */
void
tcp_sack_discard(struct tcpcb *tp)
{
	tcp_sack_cleanup(&tp->scb);
	tp->rexmt_high = tp->snd_una;
	tp->sack_flags &= ~TSACK_F_SACKRESCUED;
	tp->scb.lostseq = tp->snd_una;
}

/*
 * Delete and free SACK blocks saved in scoreboard.
 * Delete the one slot block cache.
 */
void
tcp_sack_destroy(struct scoreboard *scb)
{
	tcp_sack_cleanup(scb);
	if (scb->freecache != NULL) {
		kfree(scb->freecache, M_SACKBLOCK);
		scb->freecache = NULL;
	}
}

/*
 * Cleanup the reported SACK block information
 */
void
tcp_sack_report_cleanup(struct tcpcb *tp)
{
	tp->sack_flags &=
	    ~(TSACK_F_DUPSEG | TSACK_F_ENCLOSESEG | TSACK_F_SACKLEFT);
	tp->reportblk.rblk_start = tp->reportblk.rblk_end;
}

/*
 * Returns	0 if not D-SACK block,
 *		1 if D-SACK,
 *		2 if duplicate of out-of-order D-SACK block.
 */
int
tcp_sack_ndsack_blocks(const struct raw_sackblock *blocks, const int numblocks,
    tcp_seq snd_una)
{
	if (numblocks == 0)
		return 0;

	if (SEQ_LT(blocks[0].rblk_start, snd_una))
		return 1;

	/* block 0 inside block 1 */
	if (numblocks > 1 &&
	    SEQ_GEQ(blocks[0].rblk_start, blocks[1].rblk_start) &&
	    SEQ_LEQ(blocks[0].rblk_end, blocks[1].rblk_end))
		return 2;

	return 0;
}

/*
 * Update scoreboard on new incoming ACK.
 */
static void
tcp_sack_add_blocks(struct tcpcb *tp, struct tcpopt *to)
{
	const int numblocks = to->to_nsackblocks;
	struct raw_sackblock *blocks = to->to_sackblocks;
	struct scoreboard *scb = &tp->scb;
	int startblock, i;

	if (tcp_sack_ndsack_blocks(blocks, numblocks, tp->snd_una) > 0)
		startblock = 1;
	else
		startblock = 0;

	to->to_flags |= TOF_SACK_REDUNDANT;
	for (i = startblock; i < numblocks; i++) {
		struct raw_sackblock *newsackblock = &blocks[i];
		boolean_t update;
		int error;

		/* Guard against ACK reordering */
		if (SEQ_LEQ(newsackblock->rblk_start, tp->snd_una))
			continue;

		/* Don't accept bad SACK blocks */
		if (SEQ_GT(newsackblock->rblk_end, tp->snd_max)) {
			tcpstat.tcps_rcvbadsackopt++;
			break;		/* skip all other blocks */
		}
		tcpstat.tcps_sacksbupdate++;

		error = insert_block(scb, newsackblock, &update);
		if (update)
			to->to_flags &= ~TOF_SACK_REDUNDANT;
		if (error)
			break;
	}
}

void
tcp_sack_update_scoreboard(struct tcpcb *tp, struct tcpopt *to)
{
	struct scoreboard *scb = &tp->scb;
	int rexmt_high_update = 0;

	tcp_sack_ack_blocks(tp, tp->snd_una);
	tcp_sack_add_blocks(tp, to);
	tcp_sack_update_lostseq(scb, tp->snd_una, tp->t_maxseg,
	    tp->t_rxtthresh);
	if (SEQ_LT(tp->rexmt_high, tp->snd_una)) {
		tp->rexmt_high = tp->snd_una;
		rexmt_high_update = 1;
	}
	if (tp->sack_flags & TSACK_F_SACKRESCUED) {
		if (SEQ_LEQ(tp->rexmt_rescue, tp->snd_una)) {
			tp->sack_flags &= ~TSACK_F_SACKRESCUED;
		} else if (tcp_aggressive_rescuesack && rexmt_high_update &&
		    SEQ_LT(tp->rexmt_rescue, tp->rexmt_high)) {
			/* Drag RescueRxt along with HighRxt */
			tp->rexmt_rescue = tp->rexmt_high;
		}
	}
}

/*
 * Insert SACK block into sender's scoreboard.
 */
static int
insert_block(struct scoreboard *scb, const struct raw_sackblock *raw_sb,
    boolean_t *update)
{
	struct sackblock *sb, *workingblock;
	boolean_t overlap_front;

	*update = TRUE;
	if (TAILQ_EMPTY(&scb->sackblocks)) {
		struct sackblock *newblock;

		KASSERT(scb->nblocks == 0, ("emply scb w/ blocks"));

		newblock = alloc_sackblock(scb, raw_sb);
		if (newblock == NULL)
			return ENOMEM;
		TAILQ_INSERT_HEAD(&scb->sackblocks, newblock, sblk_list);
		scb->nblocks = 1;
		return 0;
	}

	KASSERT(scb->nblocks > 0, ("insert_block() called w/ no blocks"));
	KASSERT(scb->nblocks <= MAXSAVEDBLOCKS,
	    ("too many SACK blocks %d", scb->nblocks));

	overlap_front = sack_block_lookup(scb, raw_sb->rblk_start, &sb);

	if (sb == NULL) {
		workingblock = alloc_sackblock_limit(scb, raw_sb);
		if (workingblock == NULL)
			return ENOMEM;
		TAILQ_INSERT_HEAD(&scb->sackblocks, workingblock, sblk_list);
		++scb->nblocks;
	} else {
		if (overlap_front || sb->sblk_end == raw_sb->rblk_start) {
			tcpstat.tcps_sacksbreused++;

			/* Extend old block */
			workingblock = sb;
			if (SEQ_GT(raw_sb->rblk_end, sb->sblk_end)) {
				sb->sblk_end = raw_sb->rblk_end;
			} else {
				/* Exact match, nothing to consolidate */
				*update = FALSE;
				return 0;
			}
		} else {
			workingblock = alloc_sackblock_limit(scb, raw_sb);
			if (workingblock == NULL)
				return ENOMEM;
			TAILQ_INSERT_AFTER(&scb->sackblocks, sb, workingblock,
			    sblk_list);
			++scb->nblocks;
		}
	}

	/* Consolidate right-hand side. */
	sb = TAILQ_NEXT(workingblock, sblk_list);
	while (sb != NULL &&
	    SEQ_GEQ(workingblock->sblk_end, sb->sblk_end)) {
		struct sackblock *nextblock;

		nextblock = TAILQ_NEXT(sb, sblk_list);
		if (scb->lastfound == sb)
			scb->lastfound = NULL;
		/* Remove completely overlapped block */
		TAILQ_REMOVE(&scb->sackblocks, sb, sblk_list);
		free_sackblock(scb, sb);
		--scb->nblocks;
		KASSERT(scb->nblocks > 0,
		    ("removed overlapped block: %d blocks left", scb->nblocks));
		sb = nextblock;
	}
	if (sb != NULL &&
	    SEQ_GEQ(workingblock->sblk_end, sb->sblk_start)) {
		/* Extend new block to cover partially overlapped old block. */
		workingblock->sblk_end = sb->sblk_end;
		if (scb->lastfound == sb)
			scb->lastfound = NULL;
		TAILQ_REMOVE(&scb->sackblocks, sb, sblk_list);
		free_sackblock(scb, sb);
		--scb->nblocks;
		KASSERT(scb->nblocks > 0,
		    ("removed partial right: %d blocks left", scb->nblocks));
	}
	return 0;
}

#ifdef DEBUG_SACK_BLOCKS
static void
tcp_sack_dump_blocks(const struct scoreboard *scb)
{
	const struct sackblock *sb;

	kprintf("%d blocks:", scb->nblocks);
	TAILQ_FOREACH(sb, &scb->sackblocks, sblk_list)
		kprintf(" [%u, %u)", sb->sblk_start, sb->sblk_end);
	kprintf("\n");
}
#else
static __inline void
tcp_sack_dump_blocks(const struct scoreboard *scb)
{
}
#endif

/*
 * Optimization to quickly determine which packets are lost.
 */
void
tcp_sack_update_lostseq(struct scoreboard *scb, tcp_seq snd_una, u_int maxseg,
    int rxtthresh)
{
	struct sackblock *sb;
	int nsackblocks = 0;
	int bytes_sacked = 0;
	int rxtthresh_bytes;

	if (tcp_do_rfc6675)
		rxtthresh_bytes = (rxtthresh - 1) * maxseg;
	else
		rxtthresh_bytes = rxtthresh * maxseg;

	sb = TAILQ_LAST(&scb->sackblocks, sackblock_list);
	while (sb != NULL) {
		++nsackblocks;
		bytes_sacked += sb->sblk_end - sb->sblk_start;
		if (nsackblocks == rxtthresh ||
		    bytes_sacked >= rxtthresh_bytes) {
			scb->lostseq = sb->sblk_start;
			return;
		}
		sb = TAILQ_PREV(sb, sackblock_list, sblk_list);
	}
	scb->lostseq = snd_una;
}

/*
 * Return whether the given sequence number is considered lost.
 */
boolean_t
tcp_sack_islost(const struct scoreboard *scb, tcp_seq seqnum)
{
	return SEQ_LT(seqnum, scb->lostseq);
}

/*
 * True if at least "amount" has been SACKed.  Used by Early Retransmit.
 */
boolean_t
tcp_sack_has_sacked(const struct scoreboard *scb, u_int amount)
{
	const struct sackblock *sb;
	int bytes_sacked = 0;

	TAILQ_FOREACH(sb, &scb->sackblocks, sblk_list) {
		bytes_sacked += sb->sblk_end - sb->sblk_start;
		if (bytes_sacked >= amount)
			return TRUE;
	}
	return FALSE;
}

/*
 * Number of bytes SACKed below seq.
 */
int
tcp_sack_bytes_below(const struct scoreboard *scb, tcp_seq seq)
{
	const struct sackblock *sb;
	int bytes_sacked = 0;

	sb = TAILQ_FIRST(&scb->sackblocks);
	while (sb && SEQ_GT(seq, sb->sblk_start)) {
		bytes_sacked += seq_min(seq, sb->sblk_end) - sb->sblk_start;
		sb = TAILQ_NEXT(sb, sblk_list);
	}
	return bytes_sacked;
}

/*
 * Return estimate of the number of bytes outstanding in the network.
 */
uint32_t
tcp_sack_compute_pipe(const struct tcpcb *tp)
{
	const struct scoreboard *scb = &tp->scb;
	const struct sackblock *sb;
	int nlost, nretransmitted;
	tcp_seq end;

	nlost = tp->snd_max - scb->lostseq;
	nretransmitted = tp->rexmt_high - tp->snd_una;

	TAILQ_FOREACH(sb, &scb->sackblocks, sblk_list) {
		if (SEQ_LT(sb->sblk_start, tp->rexmt_high)) {
			end = seq_min(sb->sblk_end, tp->rexmt_high);
			nretransmitted -= end - sb->sblk_start;
		}
		if (SEQ_GEQ(sb->sblk_start, scb->lostseq))
			nlost -= sb->sblk_end - sb->sblk_start;
	}

	return (nlost + nretransmitted);
}

/*
 * Return the sequence number and length of the next segment to transmit
 * when in Fast Recovery.
 */
boolean_t
tcp_sack_nextseg(struct tcpcb *tp, tcp_seq *nextrexmt, uint32_t *plen,
    boolean_t *rescue)
{
	struct scoreboard *scb = &tp->scb;
	struct socket *so = tp->t_inpcb->inp_socket;
	struct sackblock *sb;
	const struct sackblock *lastblock =
	    TAILQ_LAST(&scb->sackblocks, sackblock_list);
	tcp_seq torexmt;
	long len, off, sendwin;

	/* skip SACKed data */
	tcp_sack_skip_sacked(scb, &tp->rexmt_high);

	/* Look for lost data. */
	torexmt = tp->rexmt_high;
	*rescue = FALSE;
	if (lastblock != NULL) {
		if (SEQ_LT(torexmt, lastblock->sblk_end) &&
		    tcp_sack_islost(scb, torexmt)) {
sendunsacked:
			*nextrexmt = torexmt;
			/* If the left-hand edge has been SACKed, pull it in. */
			if (sack_block_lookup(scb, torexmt + tp->t_maxseg, &sb))
				*plen = sb->sblk_start - torexmt;
			else
				*plen = tp->t_maxseg;
			return TRUE;
		}
	}

	/* See if unsent data available within send window. */
	off = tp->snd_max - tp->snd_una;
	sendwin = min(tp->snd_wnd, tp->snd_bwnd);
	len = (long) ulmin(so->so_snd.ssb_cc, sendwin) - off;
	if (len > 0) {
		*nextrexmt = tp->snd_max;	/* Send new data. */
		*plen = tp->t_maxseg;
		return TRUE;
	}

	/* We're less certain this data has been lost. */
	if (lastblock != NULL && SEQ_LT(torexmt, lastblock->sblk_end))
		goto sendunsacked;

	/* Rescue retransmission */
	if (tcp_do_rescuesack || tcp_do_rfc6675) {
		tcpstat.tcps_sackrescue_try++;
		if (tp->sack_flags & TSACK_F_SACKRESCUED) {
			if (!tcp_aggressive_rescuesack)
				return FALSE;

			/*
			 * Aggressive variant of the rescue retransmission.
			 *
			 * The idea of the rescue retransmission is to sustain
			 * the ACK clock thus to avoid timeout retransmission.
			 *
			 * Under some situations, the conservative approach
			 * suggested in the draft
 			 * http://tools.ietf.org/html/
			 * draft-nishida-tcpm-rescue-retransmission-00
			 * could not sustain ACK clock, since it only allows
			 * one rescue retransmission before a cumulative ACK
			 * covers the segement transmitted by rescue
			 * retransmission.
			 *
			 * We try to locate the next unSACKed segment which
			 * follows the previously sent rescue segment.  If
			 * there is no such segment, we loop back to the first
			 * unacknowledged segment.
			 */

			/*
			 * Skip SACKed data, but here we follow
			 * the last transmitted rescue segment.
			 */
			torexmt = tp->rexmt_rescue;
			tcp_sack_skip_sacked(scb, &torexmt);
		}
		if (torexmt == tp->snd_max) {
			/* Nothing left to retransmit; restart */
			torexmt = tp->snd_una;
		}
		*rescue = TRUE;
		goto sendunsacked;
	} else if (tcp_do_smartsack && lastblock == NULL) {
		tcpstat.tcps_sackrescue_try++;
		*rescue = TRUE;
		goto sendunsacked;
	}

	return FALSE;
}

/*
 * Return the next sequence number higher than "*prexmt" that has
 * not been SACKed.
 */
void
tcp_sack_skip_sacked(struct scoreboard *scb, tcp_seq *prexmt)
{
	struct sackblock *sb;

	/* skip SACKed data */
	if (sack_block_lookup(scb, *prexmt, &sb))
		*prexmt = sb->sblk_end;
}

/*
 * The length of the first amount of unSACKed data
 */
uint32_t
tcp_sack_first_unsacked_len(const struct tcpcb *tp)
{
	const struct sackblock *sb;

	sb = TAILQ_FIRST(&tp->scb.sackblocks);
	if (sb == NULL)
		return tp->t_maxseg;

	KASSERT(SEQ_LT(tp->snd_una, sb->sblk_start),
	    ("invalid sb start %u, snd_una %u",
	     sb->sblk_start, tp->snd_una));
	return (sb->sblk_start - tp->snd_una);
}

#ifdef later
void
tcp_sack_save_scoreboard(struct scoreboard *scb)
{
	struct scoreboard *scb = &tp->scb;

	scb->sackblocks_prev = scb->sackblocks;
	TAILQ_INIT(&scb->sackblocks);
}

void
tcp_sack_revert_scoreboard(struct scoreboard *scb, tcp_seq snd_una,
			   u_int maxseg)
{
	struct sackblock *sb;

	scb->sackblocks = scb->sackblocks_prev;
	scb->nblocks = 0;
	TAILQ_FOREACH(sb, &scb->sackblocks, sblk_list)
		++scb->nblocks;
	tcp_sack_ack_blocks(scb, snd_una);
	scb->lastfound = NULL;
}
#endif

#ifdef DEBUG_SACK_HISTORY
static void
tcp_sack_dump_history(const char *msg, const struct tcpcb *tp)
{
	int i;
	static int ndumped;

	/* only need a couple of these to debug most problems */
	if (++ndumped > 900)
		return;

	kprintf("%s:\tnsackhistory %d: ", msg, tp->nsackhistory);
	for (i = 0; i < tp->nsackhistory; ++i)
		kprintf("[%u, %u) ", tp->sackhistory[i].rblk_start,
		    tp->sackhistory[i].rblk_end);
	kprintf("\n");
}
#else
static __inline void
tcp_sack_dump_history(const char *msg, const struct tcpcb *tp)
{
}
#endif

/*
 * Remove old SACK blocks from the SACK history that have already been ACKed.
 */
static void
tcp_sack_ack_history(struct tcpcb *tp)
{
	int i, nblocks, openslot;

	tcp_sack_dump_history("before tcp_sack_ack_history", tp);
	nblocks = tp->nsackhistory;
	for (i = openslot = 0; i < nblocks; ++i) {
		if (SEQ_LEQ(tp->sackhistory[i].rblk_end, tp->rcv_nxt)) {
			--tp->nsackhistory;
			continue;
		}
		if (SEQ_LT(tp->sackhistory[i].rblk_start, tp->rcv_nxt))
			tp->sackhistory[i].rblk_start = tp->rcv_nxt;
		if (i == openslot)
			++openslot;
		else
			tp->sackhistory[openslot++] = tp->sackhistory[i];
	}
	tcp_sack_dump_history("after tcp_sack_ack_history", tp);
	KASSERT(openslot == tp->nsackhistory,
	    ("tcp_sack_ack_history miscounted: %d != %d",
	    openslot, tp->nsackhistory));
}

/*
 * Add or merge newblock into reported history.
 * Also remove or update SACK blocks that will be acked.
 */
static void
tcp_sack_update_reported_history(struct tcpcb *tp, tcp_seq start, tcp_seq end)
{
	struct raw_sackblock copy[MAX_SACK_REPORT_BLOCKS];
	int i, cindex;

	tcp_sack_dump_history("before tcp_sack_update_reported_history", tp);
	/*
	 * Six cases:
	 *	0) no overlap
	 *	1) newblock == oldblock
	 *	2) oldblock contains newblock
	 *	3) newblock contains oldblock
	 *	4) tail of oldblock overlaps or abuts start of newblock
	 *	5) tail of newblock overlaps or abuts head of oldblock
	 */
	for (i = cindex = 0; i < tp->nsackhistory; ++i) {
		struct raw_sackblock *oldblock = &tp->sackhistory[i];
		tcp_seq old_start = oldblock->rblk_start;
		tcp_seq old_end = oldblock->rblk_end;

		if (SEQ_LT(end, old_start) || SEQ_GT(start, old_end)) {
			/* Case 0:  no overlap.  Copy old block. */
			copy[cindex++] = *oldblock;
			continue;
		}

		if (SEQ_GEQ(start, old_start) && SEQ_LEQ(end, old_end)) {
			/* Cases 1 & 2.  Move block to front of history. */
			int j;

			start = old_start;
			end = old_end;
			/* no need to check rest of blocks */
			for (j = i + 1; j < tp->nsackhistory; ++j)
				copy[cindex++] = tp->sackhistory[j];
			break;
		}

		if (SEQ_GEQ(old_end, start) && SEQ_LT(old_start, start)) {
			/* Case 4:  extend start of new block. */
			start = old_start;
		} else if (SEQ_GEQ(end, old_start) && SEQ_GT(old_end, end)) {
			/* Case 5: extend end of new block */
			end = old_end;
		} else {
			/* Case 3.  Delete old block by not copying it. */
			KASSERT(SEQ_LEQ(start, old_start) &&
				SEQ_GEQ(end, old_end),
			    ("bad logic: old [%u, %u), new [%u, %u)",
			     old_start, old_end, start, end));
		}
	}

	/* insert new block */
	tp->sackhistory[0].rblk_start = start;
	tp->sackhistory[0].rblk_end = end;
	cindex = min(cindex, MAX_SACK_REPORT_BLOCKS - 1);
	for (i = 0; i < cindex; ++i)
		tp->sackhistory[i + 1] = copy[i];
	tp->nsackhistory = cindex + 1;
	tcp_sack_dump_history("after tcp_sack_update_reported_history", tp);
}

/*
 * Fill in SACK report to return to data sender.
 */
void
tcp_sack_fill_report(struct tcpcb *tp, u_char *opt, u_int *plen)
{
	u_int optlen = *plen;
	uint32_t *lp = (uint32_t *)(opt + optlen);
	uint32_t *olp;
	tcp_seq hstart = tp->rcv_nxt, hend;
	int nblocks;

	KASSERT(TCP_MAXOLEN - optlen >=
	    TCPOLEN_SACK_ALIGNED + TCPOLEN_SACK_BLOCK,
	    ("no room for SACK header and one block: optlen %d", optlen));

	if (tp->sack_flags & TSACK_F_DUPSEG)
		tcpstat.tcps_snddsackopt++;
	else
		tcpstat.tcps_sndsackopt++;

	olp = lp++;
	optlen += TCPOLEN_SACK_ALIGNED;

	tcp_sack_ack_history(tp);
	if (tp->reportblk.rblk_start != tp->reportblk.rblk_end) {
		*lp++ = htonl(tp->reportblk.rblk_start);
		*lp++ = htonl(tp->reportblk.rblk_end);
		optlen += TCPOLEN_SACK_BLOCK;
		hstart = tp->reportblk.rblk_start;
		hend = tp->reportblk.rblk_end;
		if (tp->sack_flags & TSACK_F_ENCLOSESEG) {
			KASSERT(TCP_MAXOLEN - optlen >= TCPOLEN_SACK_BLOCK,
			    ("no room for enclosing SACK block: oplen %d",
			    optlen));
			*lp++ = htonl(tp->encloseblk.rblk_start);
			*lp++ = htonl(tp->encloseblk.rblk_end);
			optlen += TCPOLEN_SACK_BLOCK;
			hstart = tp->encloseblk.rblk_start;
			hend = tp->encloseblk.rblk_end;
		}
		if (SEQ_GT(hstart, tp->rcv_nxt))
			tcp_sack_update_reported_history(tp, hstart, hend);
	}
	if (tcp_do_smartsack && (tp->sack_flags & TSACK_F_SACKLEFT)) {
		/* Fill in from left!  Walk re-assembly queue. */
		struct tseg_qent *q;

		q = TAILQ_FIRST(&tp->t_segq);
		while (q != NULL &&
		    TCP_MAXOLEN - optlen >= TCPOLEN_SACK_BLOCK) {
			*lp++ = htonl(q->tqe_th->th_seq);
			*lp++ = htonl(TCP_SACK_BLKEND(
			    q->tqe_th->th_seq + q->tqe_len,
			    q->tqe_th->th_flags));
			optlen += TCPOLEN_SACK_BLOCK;
			q = TAILQ_NEXT(q, tqe_q);
		}
	} else {
		int n = 0;

		/* Fill in SACK blocks from right side. */
		while (n < tp->nsackhistory &&
		    TCP_MAXOLEN - optlen >= TCPOLEN_SACK_BLOCK) {
			if (tp->sackhistory[n].rblk_start != hstart) {
				*lp++ = htonl(tp->sackhistory[n].rblk_start);
				*lp++ = htonl(tp->sackhistory[n].rblk_end);
				optlen += TCPOLEN_SACK_BLOCK;
			}
			++n;
		}
	}
	tp->reportblk.rblk_start = tp->reportblk.rblk_end;
	tp->sack_flags &=
	    ~(TSACK_F_DUPSEG | TSACK_F_ENCLOSESEG | TSACK_F_SACKLEFT);
	nblocks = (lp - olp - 1) / 2;
	*olp = htonl(TCPOPT_SACK_ALIGNED |
		     (TCPOLEN_SACK + nblocks * TCPOLEN_SACK_BLOCK));
	*plen = optlen;
}