3 * SPDX-License-Identifier: BSD-3-Clause
5 * Copyright (c) 2018-2019
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * __FBSDID("$FreeBSD$");
33 * Author: Randall Stewart <rrs@netflix.com>
35 #ifndef __tcp_ratelimit_h__
36 #define __tcp_ratelimit_h__
40 /* Flags on an individual rate */
41 #define HDWRPACE_INITED 0x0001
42 #define HDWRPACE_TAGPRESENT 0x0002
43 #define HDWRPACE_IFPDEPARTED 0x0004
44 struct tcp_hwrate_limit_table {
45 const struct tcp_rate_set *ptbl; /* Pointer to parent table */
46 struct m_snd_tag *tag; /* Send tag if needed (chelsio) */
47 uint64_t rate; /* Rate we get in Bytes per second (Bps) */
48 uint32_t time_between; /* Time-Gap between packets at this rate */
53 #define RS_IS_DEFF 0x0001 /* Its a lagg, do a double lookup */
54 #define RS_IS_INTF 0x0002 /* Its a plain interface */
55 #define RS_NO_PRE 0x0004 /* The interfacd has set rates */
56 #define RS_INT_TBL 0x0010 /*
57 * The table is the internal version
58 * which has special setup requirements.
60 #define RS_IS_DEAD 0x0020 /* The RS is dead list */
61 #define RS_FUNERAL_SCHD 0x0040 /* Is a epoch call scheduled to bury this guy?*/
62 #define RS_INTF_NO_SUP 0x0100 /* The interface does not support the ratelimiting */
65 struct sysctl_ctx_list sysctl_ctx;
66 CK_LIST_ENTRY(tcp_rate_set) next;
68 struct tcp_hwrate_limit_table *rs_rlt;
69 uint64_t rs_flows_using;
70 uint64_t rs_flow_limit;
78 struct epoch_context rs_epoch_ctx;
81 CK_LIST_HEAD(head_tcp_rate_set, tcp_rate_set);
84 #define RS_PACING_EXACT_MATCH 0x0001 /* Need an exact match for rate */
85 #define RS_PACING_GT 0x0002 /* Greater than requested */
86 #define RS_PACING_GEQ 0x0004 /* Greater than or equal too */
87 #define RS_PACING_LT 0x0008 /* Less than requested rate */
88 #define RS_PACING_SUB_OK 0x0010 /* If a rate can't be found get the
89 * next best rate (highest or lowest). */
92 #define DETAILED_RATELIMIT_SYSCTL 1 /*
93 * Undefine this if you don't want
94 * detailed rates to appear in
96 * With the defintion each rate
97 * shows up in your sysctl tree
101 const struct tcp_hwrate_limit_table *
102 tcp_set_pacing_rate(struct tcpcb *tp, struct ifnet *ifp,
103 uint64_t bytes_per_sec, int flags, int *error);
105 const struct tcp_hwrate_limit_table *
106 tcp_chg_pacing_rate(const struct tcp_hwrate_limit_table *crte,
107 struct tcpcb *tp, struct ifnet *ifp,
108 uint64_t bytes_per_sec, int flags, int *error);
110 tcp_rel_pacing_rate(const struct tcp_hwrate_limit_table *crte,
113 static inline const struct tcp_hwrate_limit_table *
114 tcp_set_pacing_rate(struct tcpcb *tp, struct ifnet *ifp,
115 uint64_t bytes_per_sec, int flags, int *error)
122 static inline const struct tcp_hwrate_limit_table *
123 tcp_chg_pacing_rate(const struct tcp_hwrate_limit_table *crte,
124 struct tcpcb *tp, struct ifnet *ifp,
125 uint64_t bytes_per_sec, int flags, int *error)
133 tcp_rel_pacing_rate(const struct tcp_hwrate_limit_table *crte,