2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 Chelsio Communications, Inc.
6 * Written by: Navdeep Parhar <np@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include "opt_inet6.h"
36 #include <sys/param.h>
37 #include <sys/eventhandler.h>
38 #include <sys/kernel.h>
39 #include <sys/systm.h>
40 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/types.h>
44 #include <sys/sockopt.h>
45 #include <sys/sysctl.h>
46 #include <sys/socket.h>
48 #include <net/ethernet.h>
50 #include <net/if_var.h>
51 #include <net/if_types.h>
52 #include <net/if_vlan_var.h>
53 #include <net/if_llatbl.h>
54 #include <net/route.h>
56 #include <netinet/if_ether.h>
57 #include <netinet/in.h>
58 #include <netinet/in_pcb.h>
59 #include <netinet/in_var.h>
60 #include <netinet6/in6_var.h>
61 #include <netinet6/in6_pcb.h>
62 #include <netinet6/nd6.h>
64 #include <netinet/tcp.h>
65 #include <netinet/tcp_fsm.h>
66 #include <netinet/tcp_timer.h>
67 #include <netinet/tcp_var.h>
68 #include <netinet/tcp_syncache.h>
69 #include <netinet/tcp_offload.h>
70 #include <netinet/toecore.h>
72 static struct mtx toedev_lock;
73 static TAILQ_HEAD(, toedev) toedev_list;
74 static eventhandler_tag listen_start_eh;
75 static eventhandler_tag listen_stop_eh;
76 static eventhandler_tag lle_event_eh;
79 toedev_connect(struct toedev *tod __unused, struct socket *so __unused,
80 struct nhop_object *nh __unused, struct sockaddr *nam __unused)
87 toedev_listen_start(struct toedev *tod __unused, struct tcpcb *tp __unused)
94 toedev_listen_stop(struct toedev *tod __unused, struct tcpcb *tp __unused)
101 toedev_input(struct toedev *tod __unused, struct tcpcb *tp __unused,
110 toedev_rcvd(struct toedev *tod __unused, struct tcpcb *tp __unused)
117 toedev_output(struct toedev *tod __unused, struct tcpcb *tp __unused)
124 toedev_pcb_detach(struct toedev *tod __unused, struct tcpcb *tp __unused)
131 toedev_l2_update(struct toedev *tod __unused, struct ifnet *ifp __unused,
132 struct sockaddr *sa __unused, uint8_t *lladdr __unused,
133 uint16_t vtag __unused)
140 toedev_route_redirect(struct toedev *tod __unused, struct ifnet *ifp __unused,
141 struct nhop_object *nh0 __unused, struct nhop_object *nh1 __unused)
148 toedev_syncache_added(struct toedev *tod __unused, void *ctx __unused)
155 toedev_syncache_removed(struct toedev *tod __unused, void *ctx __unused)
162 toedev_syncache_respond(struct toedev *tod __unused, void *ctx __unused,
171 toedev_offload_socket(struct toedev *tod __unused, void *ctx __unused,
172 struct socket *so __unused)
179 toedev_ctloutput(struct toedev *tod __unused, struct tcpcb *tp __unused,
180 int sopt_dir __unused, int sopt_name __unused)
187 toedev_tcp_info(struct toedev *tod __unused, struct tcpcb *tp __unused,
188 struct tcp_info *ti __unused)
195 toedev_alloc_tls_session(struct toedev *tod __unused, struct tcpcb *tp __unused,
196 struct ktls_session *tls __unused, int direction __unused)
203 * Inform one or more TOE devices about a listening socket.
206 toe_listen_start(struct inpcb *inp, void *arg)
208 struct toedev *t, *tod;
211 INP_WLOCK_ASSERT(inp);
212 KASSERT(inp->inp_pcbinfo == &V_tcbinfo,
213 ("%s: inp is not a TCP inp", __func__));
215 if (inp->inp_flags & (INP_DROPPED | INP_TIMEWAIT))
219 if (tp->t_state != TCPS_LISTEN)
223 mtx_lock(&toedev_lock);
224 TAILQ_FOREACH(tod, &toedev_list, link) {
225 if (t == NULL || t == tod)
226 tod->tod_listen_start(tod, tp);
228 mtx_unlock(&toedev_lock);
232 toe_listen_start_event(void *arg __unused, struct tcpcb *tp)
234 struct inpcb *inp = tp->t_inpcb;
236 INP_WLOCK_ASSERT(inp);
237 KASSERT(tp->t_state == TCPS_LISTEN,
238 ("%s: t_state %s", __func__, tcpstates[tp->t_state]));
240 toe_listen_start(inp, NULL);
244 toe_listen_stop_event(void *arg __unused, struct tcpcb *tp)
248 struct inpcb *inp = tp->t_inpcb;
251 INP_WLOCK_ASSERT(inp);
252 KASSERT(tp->t_state == TCPS_LISTEN,
253 ("%s: t_state %s", __func__, tcpstates[tp->t_state]));
255 mtx_lock(&toedev_lock);
256 TAILQ_FOREACH(tod, &toedev_list, link)
257 tod->tod_listen_stop(tod, tp);
258 mtx_unlock(&toedev_lock);
262 * Fill up a freshly allocated toedev struct with reasonable defaults.
265 init_toedev(struct toedev *tod)
268 tod->tod_softc = NULL;
271 * Provide no-op defaults so that the kernel can call any toedev
272 * function without having to check whether the TOE driver supplied one
275 tod->tod_connect = toedev_connect;
276 tod->tod_listen_start = toedev_listen_start;
277 tod->tod_listen_stop = toedev_listen_stop;
278 tod->tod_input = toedev_input;
279 tod->tod_rcvd = toedev_rcvd;
280 tod->tod_output = toedev_output;
281 tod->tod_send_rst = toedev_output;
282 tod->tod_send_fin = toedev_output;
283 tod->tod_pcb_detach = toedev_pcb_detach;
284 tod->tod_l2_update = toedev_l2_update;
285 tod->tod_route_redirect = toedev_route_redirect;
286 tod->tod_syncache_added = toedev_syncache_added;
287 tod->tod_syncache_removed = toedev_syncache_removed;
288 tod->tod_syncache_respond = toedev_syncache_respond;
289 tod->tod_offload_socket = toedev_offload_socket;
290 tod->tod_ctloutput = toedev_ctloutput;
291 tod->tod_tcp_info = toedev_tcp_info;
292 tod->tod_alloc_tls_session = toedev_alloc_tls_session;
296 * Register an active TOE device with the system. This allows it to receive
297 * notifications from the kernel.
300 register_toedev(struct toedev *tod)
304 mtx_lock(&toedev_lock);
305 TAILQ_FOREACH(t, &toedev_list, link) {
307 mtx_unlock(&toedev_lock);
312 TAILQ_INSERT_TAIL(&toedev_list, tod, link);
313 registered_toedevs++;
314 mtx_unlock(&toedev_lock);
316 inp_apply_all(toe_listen_start, tod);
322 * Remove the TOE device from the global list of active TOE devices. It is the
323 * caller's responsibility to ensure that the TOE device is quiesced prior to
327 unregister_toedev(struct toedev *tod)
329 struct toedev *t, *t2;
332 mtx_lock(&toedev_lock);
333 TAILQ_FOREACH_SAFE(t, &toedev_list, link, t2) {
335 TAILQ_REMOVE(&toedev_list, tod, link);
336 registered_toedevs--;
341 KASSERT(registered_toedevs >= 0,
342 ("%s: registered_toedevs (%d) < 0", __func__, registered_toedevs));
343 mtx_unlock(&toedev_lock);
348 toe_syncache_add(struct in_conninfo *inc, struct tcpopt *to, struct tcphdr *th,
349 struct inpcb *inp, void *tod, void *todctx, uint8_t iptos)
351 struct socket *lso = inp->inp_socket;
353 INP_WLOCK_ASSERT(inp);
355 syncache_add(inc, to, th, inp, &lso, NULL, tod, todctx, iptos, htons(0));
359 toe_syncache_expand(struct in_conninfo *inc, struct tcpopt *to,
360 struct tcphdr *th, struct socket **lsop)
365 return (syncache_expand(inc, to, th, lsop, NULL, htons(0)));
369 * General purpose check to see if a 4-tuple is in use by the kernel. If a TCP
370 * header (presumably for an incoming SYN) is also provided, an existing 4-tuple
371 * in TIME_WAIT may be assassinated freeing it up for re-use.
373 * Note that the TCP header must have been run through tcp_fields_to_host() or
377 toe_4tuple_check(struct in_conninfo *inc, struct tcphdr *th, struct ifnet *ifp)
381 if (inc->inc_flags & INC_ISIPV6) {
382 inp = in6_pcblookup(&V_tcbinfo, &inc->inc6_faddr,
383 inc->inc_fport, &inc->inc6_laddr, inc->inc_lport,
384 INPLOOKUP_WLOCKPCB, ifp);
386 inp = in_pcblookup(&V_tcbinfo, inc->inc_faddr, inc->inc_fport,
387 inc->inc_laddr, inc->inc_lport, INPLOOKUP_WLOCKPCB, ifp);
390 INP_WLOCK_ASSERT(inp);
392 if ((inp->inp_flags & INP_TIMEWAIT) && th != NULL) {
393 if (!tcp_twcheck(inp, NULL, th, NULL, 0))
405 toe_lle_event(void *arg __unused, struct llentry *lle, int evt)
413 struct sockaddr_in6 sin6;
415 LLE_WLOCK_ASSERT(lle);
417 ifp = lltable_get_ifp(lle->lle_tbl);
418 family = lltable_get_af(lle->lle_tbl);
420 if (family != AF_INET && family != AF_INET6)
423 * Not interested if the interface's TOE capability is not enabled.
425 if ((family == AF_INET && !(ifp->if_capenable & IFCAP_TOE4)) ||
426 (family == AF_INET6 && !(ifp->if_capenable & IFCAP_TOE6)))
433 sa = (struct sockaddr *)&sin6;
434 lltable_fill_sa_entry(lle, sa);
438 if (evt != LLENTRY_RESOLVED) {
440 * LLENTRY_TIMEDOUT, LLENTRY_DELETED, LLENTRY_EXPIRED all mean
441 * this entry is going to be deleted.
446 KASSERT(lle->la_flags & LLE_VALID,
447 ("%s: %p resolved but not valid?", __func__, lle));
449 lladdr = (uint8_t *)lle->ll_addr;
454 tod->tod_l2_update(tod, ifp, sa, lladdr, EVL_MAKETAG(vid, pcp, 0));
458 * Returns 0 or EWOULDBLOCK on success (any other value is an error). 0 means
459 * lladdr and vtag are valid on return, EWOULDBLOCK means the TOE driver's
460 * tod_l2_update will be called later, when the entry is resolved or times out.
463 toe_l2_resolve(struct toedev *tod, struct ifnet *ifp, struct sockaddr *sa,
464 uint8_t *lladdr, uint16_t *vtag)
469 switch (sa->sa_family) {
472 rc = arpresolve(ifp, 0, NULL, sa, lladdr, NULL, NULL);
477 rc = nd6_resolve(ifp, 0, NULL, sa, lladdr, NULL, NULL);
481 return (EPROTONOSUPPORT);
487 if (ifp->if_type == IFT_L2VLAN) {
490 } else if (ifp->if_pcp != IFNET_PCP_NONE) {
494 *vtag = EVL_MAKETAG(vid, pcp, 0);
501 toe_connect_failed(struct toedev *tod, struct inpcb *inp, int err)
505 INP_WLOCK_ASSERT(inp);
507 if (!(inp->inp_flags & INP_DROPPED)) {
508 struct tcpcb *tp = intotcpcb(inp);
510 KASSERT(tp->t_flags & TF_TOE,
511 ("%s: tp %p not offloaded.", __func__, tp));
515 * Temporary failure during offload, take this PCB back.
516 * Detach from the TOE driver and do the rest of what
517 * TCP's pru_connect would have done if the connection
521 tod->tod_pcb_detach(tod, tp);
522 KASSERT(!(tp->t_flags & TF_TOE),
523 ("%s: tp %p still offloaded.", __func__, tp));
524 tcp_timer_activate(tp, TT_KEEP, TP_KEEPINIT(tp));
525 (void) tp->t_fb->tfb_tcp_output(tp);
527 tp = tcp_drop(tp, err);
529 INP_WLOCK(inp); /* re-acquire */
532 INP_WLOCK_ASSERT(inp);
539 mtx_init(&toedev_lock, "toedev lock", NULL, MTX_DEF);
540 TAILQ_INIT(&toedev_list);
542 listen_start_eh = EVENTHANDLER_REGISTER(tcp_offload_listen_start,
543 toe_listen_start_event, NULL, EVENTHANDLER_PRI_ANY);
544 listen_stop_eh = EVENTHANDLER_REGISTER(tcp_offload_listen_stop,
545 toe_listen_stop_event, NULL, EVENTHANDLER_PRI_ANY);
546 lle_event_eh = EVENTHANDLER_REGISTER(lle_event, toe_lle_event, NULL,
547 EVENTHANDLER_PRI_ANY);
556 mtx_lock(&toedev_lock);
557 if (!TAILQ_EMPTY(&toedev_list)) {
558 mtx_unlock(&toedev_lock);
562 EVENTHANDLER_DEREGISTER(tcp_offload_listen_start, listen_start_eh);
563 EVENTHANDLER_DEREGISTER(tcp_offload_listen_stop, listen_stop_eh);
564 EVENTHANDLER_DEREGISTER(lle_event, lle_event_eh);
566 mtx_unlock(&toedev_lock);
567 mtx_destroy(&toedev_lock);
573 toecore_mod_handler(module_t mod, int cmd, void *arg)
577 return (toecore_load());
579 if (cmd == MOD_UNLOAD)
580 return (toecore_unload());
585 static moduledata_t mod_data= {
591 MODULE_VERSION(toecore, 1);
592 DECLARE_MODULE(toecore, mod_data, SI_SUB_EXEC, SI_ORDER_ANY);