[apple/xnu.git] / bsd / netinet / tcp_cc.h

/*
 * Copyright (c) 2010-2018 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 2008 Swinburne University of Technology, Melbourne, Australia
 * All rights reserved.
 *
 * This software was developed at the Centre for Advanced Internet
 * Architectures, Swinburne University, by Lawrence Stewart and James Healy,
 * made possible in part by a grant from the Cisco University Research Program
 * Fund at Community Foundation Silicon Valley.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 * $FreeBSD$
 */

#ifndef _NETINET_CC_H_
#define _NETINET_CC_H_

#ifdef PRIVATE

#include <netinet/in.h>

/*
 * Data structure to collect and display congestion control debug information
 */
struct tcp_cc_debug_state {
	u_int64_t ccd_tsns;
	char ccd_srcaddr[INET6_ADDRSTRLEN];
	uint16_t ccd_srcport;
	char ccd_destaddr[INET6_ADDRSTRLEN];
	uint16_t ccd_destport;
	uint32_t ccd_snd_cwnd;
	uint32_t ccd_snd_wnd;
	uint32_t ccd_snd_ssthresh;
	uint32_t ccd_pipeack;
	uint32_t ccd_rttcur;
	uint32_t ccd_rxtcur;
	uint32_t ccd_srtt;
	uint32_t ccd_event;
	uint32_t ccd_sndcc;
	uint32_t ccd_sndhiwat;
	uint32_t ccd_bytes_acked;
	u_int8_t ccd_cc_index;
	u_int8_t ccd_unused_1__;
	u_int16_t ccd_unused_2__;
	union {
		struct {
			uint32_t ccd_last_max;
			uint32_t ccd_tcp_win;
			uint32_t ccd_target_win;
			uint32_t ccd_avg_lastmax;
			uint32_t ccd_mean_deviation;
		} cubic_state;
		struct {
			u_int32_t led_base_rtt;
		} ledbat_state;
	} u;
};

/*
 * Values of ccd_cc_index
 */
#define TCP_CC_ALGO_NONE                0
#define TCP_CC_ALGO_NEWRENO_INDEX       1
#define TCP_CC_ALGO_BACKGROUND_INDEX    2 /* CC for background transport */
#define TCP_CC_ALGO_CUBIC_INDEX         3 /* default CC algorithm */
#define TCP_CC_ALGO_COUNT               4 /* Count of CC algorithms */

/*
 * Values of ccd_event
 */
#define TCP_CC_EVENT_LIST                       \
	X(TCP_CC_CWND_INIT)                     \
	X(TCP_CC_INSEQ_ACK_RCVD)                \
	X(TCP_CC_ACK_RCVD)                      \
	X(TCP_CC_ENTER_FASTRECOVERY)            \
	X(TCP_CC_IN_FASTRECOVERY)               \
	X(TCP_CC_EXIT_FASTRECOVERY)             \
	X(TCP_CC_PARTIAL_ACK)                   \
	X(TCP_CC_IDLE_TIMEOUT)                  \
	X(TCP_CC_REXMT_TIMEOUT)                 \
	X(TCP_CC_ECN_RCVD)                      \
	X(TCP_CC_BAD_REXMT_RECOVERY)            \
	X(TCP_CC_OUTPUT_ERROR)                  \
	X(TCP_CC_CHANGE_ALGO)                   \
	X(TCP_CC_FLOW_CONTROL)                  \
	X(TCP_CC_SUSPEND)                       \
	X(TCP_CC_LIMITED_TRANSMIT)              \
	X(TCP_CC_EARLY_RETRANSMIT)              \
	X(TCP_CC_TLP_RECOVERY)                  \
	X(TCP_CC_TLP_RECOVER_LASTPACKET)        \
	X(TCP_CC_DELAY_FASTRECOVERY)            \
	X(TCP_CC_TLP_IN_FASTRECOVERY)           \
	X(TCP_CC_DSACK_BAD_REXMT)               \
	X(TCP_CC_FIRST_REXMT)                   \
	X(MAX_TCP_CC_EVENTS)

enum tcp_cc_event {
#define X(name, ...) name,
	TCP_CC_EVENT_LIST
#undef X
};

/*
 * Kernel control ID
 */
#define TCP_CC_CONTROL_NAME     "com.apple.network.tcp_ccdebug"

#endif /* PRIVATE */

#ifdef KERNEL_PRIVATE

#include <netinet/tcp.h>
#include <netinet/tcp_var.h>
#include <kern/zalloc.h>

/*
 * Maximum characters in the name of a CC algorithm
 */
#define TCP_CA_NAME_MAX 16

extern int tcp_recv_bg;

/*
 * Structure to hold definition various actions defined by a congestion
 * control algorithm for TCP. This can be used to change the congestion
 * control on a connection based on the user settings of priority of a
 * connection.
 */
struct tcp_cc_algo {
	char name[TCP_CA_NAME_MAX];
	uint32_t num_sockets;
	uint32_t flags;

	/* init the congestion algorithm for the specified control block */
	int (*init) (struct tcpcb *tp);

	/*
	 * cleanup any state that is stored in the connection
	 * related to the algorithm
	 */
	int (*cleanup) (struct tcpcb *tp);

	/* initialize cwnd at the start of a connection */
	void (*cwnd_init) (struct tcpcb *tp);

	/*
	 * called on the receipt of in-sequence ack during congestion
	 * avoidance phase
	 */
	void (*congestion_avd) (struct tcpcb *tp, struct tcphdr *th);

	/* called on the receipt of a valid ack */
	void (*ack_rcvd) (struct tcpcb *tp, struct tcphdr *th);

	/* called before entering FR */
	void (*pre_fr) (struct tcpcb *tp);

	/*  after exiting FR */
	void (*post_fr) (struct tcpcb *tp, struct tcphdr *th);

	/* perform tasks when data transfer resumes after an idle period */
	void (*after_idle) (struct tcpcb *tp);

	/* perform tasks when the connection's retransmit timer expires */
	void (*after_timeout) (struct tcpcb *tp);

	/* Whether or not to delay the ack */
	int (*delay_ack)(struct tcpcb *tp, struct tcphdr *th);

	/* Switch a connection to this CC algorithm after sending some packets */
	void (*switch_to)(struct tcpcb *tp, uint16_t old_cc_index);
} __attribute__((aligned(4)));

extern struct zone *tcp_cc_zone;

extern struct tcp_cc_algo* tcp_cc_algo_list[TCP_CC_ALGO_COUNT];

#define CC_ALGO(tp) (tcp_cc_algo_list[tp->tcp_cc_index])
#define TCP_CC_CWND_INIT_PKTS 10
#define TCP_CC_CWND_INIT_BYTES  4380
/*
 * The congestion window will have to be reset after a
 * non-validated period -- currently set to 3 minutes
 */
#define TCP_CC_CWND_NONVALIDATED_PERIOD (3 * 60 * TCP_RETRANSHZ)

extern void     tcp_cc_init(void);
extern void tcp_cc_resize_sndbuf(struct tcpcb *tp);
extern void tcp_bad_rexmt_fix_sndbuf(struct tcpcb *tp);
extern void tcp_cc_cwnd_init_or_reset(struct tcpcb *tp);
extern int tcp_cc_delay_ack(struct tcpcb *tp, struct tcphdr *th);
extern void tcp_ccdbg_trace(struct tcpcb *tp, struct tcphdr *th,
    int32_t event);
extern void tcp_cc_allocate_state(struct tcpcb *tp);
extern void tcp_cc_after_idle_stretchack(struct tcpcb *tp);
extern uint32_t tcp_cc_is_cwnd_nonvalidated(struct tcpcb *tp);
extern void tcp_cc_adjust_nonvalidated_cwnd(struct tcpcb *tp);
extern u_int32_t tcp_get_max_pipeack(struct tcpcb *tp);
extern void tcp_clear_pipeack_state(struct tcpcb *tp);

static inline uint32_t
tcp_initial_cwnd(struct tcpcb *tp)
{
	if (tcp_cubic_minor_fixes) {
		return TCP_CC_CWND_INIT_PKTS * tp->t_maxseg;
	} else {
		return TCP_CC_CWND_INIT_BYTES;
	}
}

#endif /* KERNEL_PRIVATE */
#endif /* _NETINET_CC_H_ */
Commit	Line	Data
6d2010ae	1	/*
cb323159	2	* Copyright (c) 2010-2018 Apple Inc. All rights reserved.
6d2010ae A	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28	/*-
	29	* Copyright (c) 2008 Swinburne University of Technology, Melbourne, Australia
	30	* All rights reserved.
	31	*
	32	* This software was developed at the Centre for Advanced Internet
	33	* Architectures, Swinburne University, by Lawrence Stewart and James Healy,
	34	* made possible in part by a grant from the Cisco University Research Program
	35	* Fund at Community Foundation Silicon Valley.
	36	*
	37	* Redistribution and use in source and binary forms, with or without
	38	* modification, are permitted provided that the following conditions
	39	* are met:
	40	* 1. Redistributions of source code must retain the above copyright
	41	* notice, this list of conditions and the following disclaimer.
	42	* 2. Redistributions in binary form must reproduce the above copyright
	43	* notice, this list of conditions and the following disclaimer in the
	44	* documentation and/or other materials provided with the distribution.
	45	*
	46	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	47	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	48	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	49	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	50	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	51	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	52	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	53	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	54	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	55	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	56	* SUCH DAMAGE.
	57	*
	58	* $FreeBSD$
	59	*/
	60
	61	#ifndef _NETINET_CC_H_
	62	#define _NETINET_CC_H_
	63
cb323159 A	64	#ifdef PRIVATE
	65
	66	#include <netinet/in.h>
	67
	68	/*
	69	* Data structure to collect and display congestion control debug information
	70	*/
	71	struct tcp_cc_debug_state {
	72	u_int64_t ccd_tsns;
	73	char ccd_srcaddr[INET6_ADDRSTRLEN];
	74	uint16_t ccd_srcport;
	75	char ccd_destaddr[INET6_ADDRSTRLEN];
	76	uint16_t ccd_destport;
	77	uint32_t ccd_snd_cwnd;
	78	uint32_t ccd_snd_wnd;
	79	uint32_t ccd_snd_ssthresh;
	80	uint32_t ccd_pipeack;
	81	uint32_t ccd_rttcur;
	82	uint32_t ccd_rxtcur;
	83	uint32_t ccd_srtt;
	84	uint32_t ccd_event;
	85	uint32_t ccd_sndcc;
	86	uint32_t ccd_sndhiwat;
	87	uint32_t ccd_bytes_acked;
	88	u_int8_t ccd_cc_index;
	89	u_int8_t ccd_unused_1__;
	90	u_int16_t ccd_unused_2__;
	91	union {
	92	struct {
	93	uint32_t ccd_last_max;
	94	uint32_t ccd_tcp_win;
	95	uint32_t ccd_target_win;
	96	uint32_t ccd_avg_lastmax;
	97	uint32_t ccd_mean_deviation;
	98	} cubic_state;
	99	struct {
	100	u_int32_t led_base_rtt;
	101	} ledbat_state;
	102	} u;
	103	};
6d2010ae	104
cb323159 A	105	/*
	106	* Values of ccd_cc_index
	107	*/
0a7de745 A	108	#define TCP_CC_ALGO_NONE 0
	109	#define TCP_CC_ALGO_NEWRENO_INDEX 1
	110	#define TCP_CC_ALGO_BACKGROUND_INDEX 2 /* CC for background transport */
	111	#define TCP_CC_ALGO_CUBIC_INDEX 3 /* default CC algorithm */
	112	#define TCP_CC_ALGO_COUNT 4 /* Count of CC algorithms */
6d2010ae	113
cb323159 A	114	/*
	115	* Values of ccd_event
	116	*/
	117	#define TCP_CC_EVENT_LIST \
	118	X(TCP_CC_CWND_INIT) \
	119	X(TCP_CC_INSEQ_ACK_RCVD) \
	120	X(TCP_CC_ACK_RCVD) \
	121	X(TCP_CC_ENTER_FASTRECOVERY) \
	122	X(TCP_CC_IN_FASTRECOVERY) \
	123	X(TCP_CC_EXIT_FASTRECOVERY) \
	124	X(TCP_CC_PARTIAL_ACK) \
	125	X(TCP_CC_IDLE_TIMEOUT) \
	126	X(TCP_CC_REXMT_TIMEOUT) \
	127	X(TCP_CC_ECN_RCVD) \
	128	X(TCP_CC_BAD_REXMT_RECOVERY) \
	129	X(TCP_CC_OUTPUT_ERROR) \
	130	X(TCP_CC_CHANGE_ALGO) \
	131	X(TCP_CC_FLOW_CONTROL) \
	132	X(TCP_CC_SUSPEND) \
	133	X(TCP_CC_LIMITED_TRANSMIT) \
	134	X(TCP_CC_EARLY_RETRANSMIT) \
	135	X(TCP_CC_TLP_RECOVERY) \
	136	X(TCP_CC_TLP_RECOVER_LASTPACKET) \
	137	X(TCP_CC_DELAY_FASTRECOVERY) \
	138	X(TCP_CC_TLP_IN_FASTRECOVERY) \
	139	X(TCP_CC_DSACK_BAD_REXMT) \
	140	X(TCP_CC_FIRST_REXMT) \
	141	X(MAX_TCP_CC_EVENTS)
	142
	143	enum tcp_cc_event {
	144	#define X(name, ...) name,
	145	TCP_CC_EVENT_LIST
	146	#undef X
	147	};
	148
	149	/*
	150	* Kernel control ID
	151	*/
	152	#define TCP_CC_CONTROL_NAME "com.apple.network.tcp_ccdebug"
	153
	154	#endif /* PRIVATE */
	155
	156	#ifdef KERNEL_PRIVATE
	157
	158	#include <netinet/tcp.h>
	159	#include <netinet/tcp_var.h>
	160	#include <kern/zalloc.h>
	161
	162	/*
	163	* Maximum characters in the name of a CC algorithm
	164	*/
	165	#define TCP_CA_NAME_MAX 16
6d2010ae	166
5ba3f43e A	167	extern int tcp_recv_bg;
5ba3f43e A	168
6d2010ae	169	/*
0a7de745	170	* Structure to hold definition various actions defined by a congestion
fe8ab488 A	171	* control algorithm for TCP. This can be used to change the congestion
	172	* control on a connection based on the user settings of priority of a
	173	* connection.
6d2010ae A	174	*/
	175	struct tcp_cc_algo {
	176	char name[TCP_CA_NAME_MAX];
	177	uint32_t num_sockets;
	178	uint32_t flags;
	179
	180	/* init the congestion algorithm for the specified control block */
	181	int (init) (struct tcpcb tp);
	182
fe8ab488	183	/*
0a7de745	184	* cleanup any state that is stored in the connection
fe8ab488 A	185	* related to the algorithm
fe8ab488 A	186	*/
0a7de745	187	int (cleanup) (struct tcpcb tp);
6d2010ae A	188
	189	/* initialize cwnd at the start of a connection */
	190	void (cwnd_init) (struct tcpcb tp);
	191
fe8ab488 A	192	/*
	193	* called on the receipt of in-sequence ack during congestion
	194	* avoidance phase
	195	*/
	196	void (congestion_avd) (struct tcpcb tp, struct tcphdr *th);
6d2010ae A	197
	198	/* called on the receipt of a valid ack */
	199	void (ack_rcvd) (struct tcpcb tp, struct tcphdr *th);
	200
	201	/* called before entering FR */
316670eb	202	void (pre_fr) (struct tcpcb tp);
6d2010ae A	203
	204	/* after exiting FR */
	205	void (post_fr) (struct tcpcb tp, struct tcphdr *th);
	206
	207	/* perform tasks when data transfer resumes after an idle period */
	208	void (after_idle) (struct tcpcb tp);
	209
	210	/* perform tasks when the connection's retransmit timer expires */
	211	void (after_timeout) (struct tcpcb tp);
	212
	213	/* Whether or not to delay the ack */
	214	int (delay_ack)(struct tcpcb tp, struct tcphdr *th);
	215
	216	/* Switch a connection to this CC algorithm after sending some packets */
0a7de745	217	void (switch_to)(struct tcpcb tp, uint16_t old_cc_index);
6d2010ae A	218	} __attribute__((aligned(4)));
6d2010ae A	219
0a7de745	220	extern struct zone *tcp_cc_zone;
fe8ab488	221
6d2010ae A	222	extern struct tcp_cc_algo* tcp_cc_algo_list[TCP_CC_ALGO_COUNT];
	223
	224	#define CC_ALGO(tp) (tcp_cc_algo_list[tp->tcp_cc_index])
f427ee49	225	#define TCP_CC_CWND_INIT_PKTS 10
0a7de745	226	#define TCP_CC_CWND_INIT_BYTES 4380
3e170ce0 A	227	/*
	228	* The congestion window will have to be reset after a
	229	* non-validated period -- currently set to 3 minutes
	230	*/
0a7de745	231	#define TCP_CC_CWND_NONVALIDATED_PERIOD (3 * 60 * TCP_RETRANSHZ)
6d2010ae	232
0a7de745	233	extern void tcp_cc_init(void);
316670eb A	234	extern void tcp_cc_resize_sndbuf(struct tcpcb *tp);
316670eb A	235	extern void tcp_bad_rexmt_fix_sndbuf(struct tcpcb *tp);
fe8ab488 A	236	extern void tcp_cc_cwnd_init_or_reset(struct tcpcb *tp);
	237	extern int tcp_cc_delay_ack(struct tcpcb tp, struct tcphdr th);
	238	extern void tcp_ccdbg_trace(struct tcpcb tp, struct tcphdr th,
0a7de745	239	int32_t event);
fe8ab488 A	240	extern void tcp_cc_allocate_state(struct tcpcb *tp);
fe8ab488 A	241	extern void tcp_cc_after_idle_stretchack(struct tcpcb *tp);
3e170ce0 A	242	extern uint32_t tcp_cc_is_cwnd_nonvalidated(struct tcpcb *tp);
	243	extern void tcp_cc_adjust_nonvalidated_cwnd(struct tcpcb *tp);
	244	extern u_int32_t tcp_get_max_pipeack(struct tcpcb *tp);
	245	extern void tcp_clear_pipeack_state(struct tcpcb *tp);
316670eb	246
f427ee49 A	247	static inline uint32_t
	248	tcp_initial_cwnd(struct tcpcb *tp)
	249	{
	250	if (tcp_cubic_minor_fixes) {
	251	return TCP_CC_CWND_INIT_PKTS * tp->t_maxseg;
	252	} else {
	253	return TCP_CC_CWND_INIT_BYTES;
	254	}
	255	}
	256
cb323159	257	#endif /* KERNEL_PRIVATE */
6d2010ae	258	#endif /* _NETINET_CC_H_ */