1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012 Chelsio Communications, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _NETINET_TOE_H_ 32 #define _NETINET_TOE_H_ 33 34 #ifndef _KERNEL 35 #error "no user-serviceable parts inside" 36 #endif 37 38 #include <sys/_eventhandler.h> 39 40 struct tcpopt; 41 struct tcphdr; 42 struct in_conninfo; 43 struct tcp_info; 44 struct nhop_object; 45 struct ktls_session; 46 47 struct toedev { 48 TAILQ_ENTRY(toedev) link; /* glue for toedev_list */ 49 void *tod_softc; /* TOE driver private data */ 50 51 /* 52 * Active open. If a failure occurs, it is reported back by the driver 53 * via toe_connect_failed. 54 */ 55 int (*tod_connect)(struct toedev *, struct socket *, struct nhop_object *, 56 struct sockaddr *); 57 58 /* Passive open. */ 59 int (*tod_listen_start)(struct toedev *, struct tcpcb *); 60 int (*tod_listen_stop)(struct toedev *, struct tcpcb *); 61 62 /* 63 * The kernel uses this routine to pass on any frame it receives for an 64 * offloaded connection to the TOE driver. This is an unusual event. 65 */ 66 void (*tod_input)(struct toedev *, struct tcpcb *, struct mbuf *); 67 68 /* 69 * This is called by the kernel during pru_rcvd for an offloaded TCP 70 * connection and provides an opportunity for the TOE driver to manage 71 * its rx window and credits. 72 */ 73 void (*tod_rcvd)(struct toedev *, struct tcpcb *); 74 75 /* 76 * Transmit routine. The kernel calls this to have the TOE driver 77 * evaluate whether there is data to be transmitted, and transmit it. 78 */ 79 int (*tod_output)(struct toedev *, struct tcpcb *); 80 81 /* Immediate teardown: send RST to peer. */ 82 int (*tod_send_rst)(struct toedev *, struct tcpcb *); 83 84 /* Initiate orderly disconnect by sending FIN to the peer. */ 85 int (*tod_send_fin)(struct toedev *, struct tcpcb *); 86 87 /* Called to indicate that the kernel is done with this TCP PCB. */ 88 void (*tod_pcb_detach)(struct toedev *, struct tcpcb *); 89 90 /* 91 * The kernel calls this once it has information about an L2 entry that 92 * the TOE driver enquired about previously (via toe_l2_resolve). 93 */ 94 void (*tod_l2_update)(struct toedev *, struct ifnet *, 95 struct sockaddr *, uint8_t *, uint16_t); 96 97 /* XXX. Route has been redirected. */ 98 void (*tod_route_redirect)(struct toedev *, struct ifnet *, 99 struct nhop_object *, struct nhop_object *); 100 101 /* Syncache interaction. */ 102 void (*tod_syncache_added)(struct toedev *, void *); 103 void (*tod_syncache_removed)(struct toedev *, void *); 104 int (*tod_syncache_respond)(struct toedev *, void *, struct mbuf *); 105 void (*tod_offload_socket)(struct toedev *, void *, struct socket *); 106 107 /* TCP socket option */ 108 void (*tod_ctloutput)(struct toedev *, struct tcpcb *, int, int); 109 110 /* Update software state */ 111 void (*tod_tcp_info)(struct toedev *, struct tcpcb *, 112 struct tcp_info *); 113 114 /* Create a TLS session */ 115 int (*tod_alloc_tls_session)(struct toedev *, struct tcpcb *, 116 struct ktls_session *, int); 117 }; 118 119 typedef void (*tcp_offload_listen_start_fn)(void *, struct tcpcb *); 120 typedef void (*tcp_offload_listen_stop_fn)(void *, struct tcpcb *); 121 EVENTHANDLER_DECLARE(tcp_offload_listen_start, tcp_offload_listen_start_fn); 122 EVENTHANDLER_DECLARE(tcp_offload_listen_stop, tcp_offload_listen_stop_fn); 123 124 void init_toedev(struct toedev *); 125 int register_toedev(struct toedev *); 126 int unregister_toedev(struct toedev *); 127 128 /* 129 * General interface for looking up L2 information for an IP address. If an 130 * answer is not available right away then the TOE driver's tod_l2_update will 131 * be called later. 132 */ 133 int toe_l2_resolve(struct toedev *, struct ifnet *, struct sockaddr *, 134 uint8_t *, uint16_t *); 135 136 void toe_connect_failed(struct toedev *, struct inpcb *, int); 137 138 void toe_syncache_add(struct in_conninfo *, struct tcpopt *, struct tcphdr *, 139 struct inpcb *, void *, void *, uint8_t); 140 int toe_syncache_expand(struct in_conninfo *, struct tcpopt *, struct tcphdr *, 141 struct socket **); 142 143 int toe_4tuple_check(struct in_conninfo *, struct tcphdr *, struct ifnet *); 144 #endif 145