2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012, 2015 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
36 #include "common/t4_hw.h"
37 #include "common/t4_msg.h"
38 #include "tom/t4_tls.h"
40 #define LISTEN_HASH_SIZE 32
43 * Min receive window. We want it to be large enough to accommodate receive
44 * coalescing, handle jumbo frames, and not trigger sender SWS avoidance.
46 #define MIN_RCV_WND (24 * 1024U)
49 * Max receive window supported by HW in bytes. Only a small part of it can
50 * be set through option0, the rest needs to be set through RX_DATA_ACK.
52 #define MAX_RCV_WND ((1U << 27) - 1)
54 #define DDP_RSVD_WIN (16 * 1024U)
55 #define SB_DDP_INDICATE SB_IN_TOE /* soreceive must respond to indicate */
57 #define USE_DDP_RX_FLOW_CONTROL
59 #define PPOD_SZ(n) ((n) * sizeof(struct pagepod))
60 #define PPOD_SIZE (PPOD_SZ(1))
64 TPF_ATTACHED = (1 << 0), /* a tcpcb refers to this toepcb */
65 TPF_FLOWC_WR_SENT = (1 << 1), /* firmware flow context WR sent */
66 TPF_TX_DATA_SENT = (1 << 2), /* some data sent */
67 TPF_TX_SUSPENDED = (1 << 3), /* tx suspended for lack of resources */
68 TPF_SEND_FIN = (1 << 4), /* send FIN after all pending data */
69 TPF_FIN_SENT = (1 << 5), /* FIN has been sent */
70 TPF_ABORT_SHUTDOWN = (1 << 6), /* connection abort is in progress */
71 TPF_CPL_PENDING = (1 << 7), /* haven't received the last CPL */
72 TPF_SYNQE = (1 << 8), /* synq_entry, not really a toepcb */
73 TPF_SYNQE_EXPANDED = (1 << 9), /* toepcb ready, tid context updated */
74 TPF_FORCE_CREDITS = (1 << 10), /* always send credits */
75 TPF_KTLS = (1 << 11), /* send TLS records from KTLS */
76 TPF_INITIALIZED = (1 << 12), /* init_toepcb has been called */
77 TPF_TLS_RECEIVE = (1 << 13), /* should receive TLS records */
78 TPF_TLS_ESTABLISHED = (1 << 14), /* TLS handshake timer initialized */
82 DDP_OK = (1 << 0), /* OK to turn on DDP */
83 DDP_SC_REQ = (1 << 1), /* state change (on/off) requested */
84 DDP_ON = (1 << 2), /* DDP is turned on */
85 DDP_BUF0_ACTIVE = (1 << 3), /* buffer 0 in use (not invalidated) */
86 DDP_BUF1_ACTIVE = (1 << 4), /* buffer 1 in use (not invalidated) */
87 DDP_TASK_ACTIVE = (1 << 5), /* requeue task is queued / running */
88 DDP_DEAD = (1 << 6), /* toepcb is shutting down */
92 struct offload_settings;
95 * Connection parameters for an offloaded connection. These are mostly (but not
96 * all) hardware TOE parameters.
111 int16_t txq_idx; /* ofld_txq = &sc->sge.ofld_txq[txq_idx] */
112 int16_t rxq_idx; /* ofld_rxq = &sc->sge.ofld_rxq[rxq_idx] */
115 uint16_t opt0_bufsize;
116 u_int sndbuf; /* controls TP tx pages */
119 struct ofld_tx_sdesc {
120 uint32_t plen; /* payload length */
121 uint8_t tx_credits; /* firmware tx credits (unit is 16B) */
122 void *iv_buffer; /* optional buffer holding IVs for TLS */
128 u_int pr_page_shift[4];
129 uint32_t pr_tag_mask; /* hardware tagmask for this region. */
130 uint32_t pr_invalid_bit; /* OR with this to invalidate tag. */
131 uint32_t pr_alias_mask; /* AND with tag to get alias bits. */
132 u_int pr_alias_shift; /* shift this much for first alias bit. */
136 struct ppod_reservation {
137 struct ppod_region *prsv_pr;
138 uint32_t prsv_tag; /* Full tag: pgsz, alias, tag, color */
143 TAILQ_ENTRY(pageset) link;
147 int offset; /* offset in first page */
149 struct ppod_reservation prsv;
155 TAILQ_HEAD(pagesetq, pageset);
157 #define PS_PPODS_WRITTEN 0x0001 /* Page pods written to the card. */
168 struct ddp_buffer db[2];
169 TAILQ_HEAD(, pageset) cached_pagesets;
170 TAILQ_HEAD(, kaiocb) aiojobq;
174 int active_id; /* the currently active DDP buffer */
175 struct task requeue_task;
176 struct kaiocb *queueing;
182 struct inpcb *inp; /* backpointer to host stack's PCB */
183 u_int flags; /* miscellaneous flags */
184 TAILQ_ENTRY(toepcb) link; /* toep_list */
187 struct vi_info *vi; /* virtual interface */
188 struct sge_wrq *ofld_txq;
189 struct sge_ofld_rxq *ofld_rxq;
190 struct sge_wrq *ctrlq;
191 struct l2t_entry *l2te; /* L2 table entry used by this connection */
192 struct clip_entry *ce; /* CLIP table entry used by this tid */
193 int tid; /* Connection identifier */
195 /* tx credit handling */
196 u_int tx_total; /* total tx WR credits (in 16B units) */
197 u_int tx_credits; /* tx WR credits (in 16B units) available */
198 u_int tx_nocompl; /* tx WR credits since last compl request */
199 u_int plen_nocompl; /* payload since last compl request */
201 struct conn_params params;
205 struct mbufq ulp_pduq; /* PDUs waiting to be sent out. */
206 struct mbufq ulp_pdu_reclaimq;
209 struct tls_ofld_info tls;
211 TAILQ_HEAD(, kaiocb) aiotx_jobq;
212 struct task aiotx_task;
213 struct socket *aiotx_so;
215 /* Tx software descriptor */
220 struct ofld_tx_sdesc txsd[];
224 ulp_mode(struct toepcb *toep)
227 return (toep->params.ulp_mode);
230 #define DDP_LOCK(toep) mtx_lock(&(toep)->ddp.lock)
231 #define DDP_UNLOCK(toep) mtx_unlock(&(toep)->ddp.lock)
232 #define DDP_ASSERT_LOCKED(toep) mtx_assert(&(toep)->ddp.lock, MA_OWNED)
235 * Compressed state for embryonic connections for a listener.
238 struct listen_ctx *lctx; /* backpointer to listen ctx */
240 int flags; /* same as toepcb's tp_flags */
241 volatile int ok_to_respond;
242 volatile u_int refcnt;
248 __be16 tcp_opt; /* from cpl_pass_establish */
251 struct conn_params params;
254 /* listen_ctx flags */
255 #define LCTX_RPL_PENDING 1 /* waiting for a CPL_PASS_OPEN_RPL */
258 LIST_ENTRY(listen_ctx) link; /* listen hash linkage */
259 volatile int refcount;
261 struct stid_region stid_region;
263 struct inpcb *inp; /* listening socket's inp */
265 struct sge_wrq *ctrlq;
266 struct sge_ofld_rxq *ofld_rxq;
267 struct clip_entry *ce;
270 /* tcb_histent flags */
271 #define TE_RPL_PENDING 1
274 /* bits in one 8b tcb_histent sample. */
275 #define TS_RTO (1 << 0)
276 #define TS_DUPACKS (1 << 1)
277 #define TS_FASTREXMT (1 << 2)
278 #define TS_SND_BACKLOGGED (1 << 3)
279 #define TS_CWND_LIMITED (1 << 4)
280 #define TS_ECN_ECE (1 << 5)
281 #define TS_ECN_CWR (1 << 6)
282 #define TS_RESERVED (1 << 7) /* Unused. */
286 struct callout te_callout;
287 uint64_t te_tcb[TCB_SIZE / sizeof(uint64_t)];
288 struct adapter *te_adapter;
292 uint8_t te_sample[100];
298 /* toepcb's associated with this TOE device */
299 struct mtx toep_list_lock;
300 TAILQ_HEAD(, toepcb) toep_list;
302 struct mtx lctx_hash_lock;
303 LIST_HEAD(, listen_ctx) *listen_hash;
305 int lctx_count; /* # of lctx in the hash table */
307 struct ppod_region pr;
309 struct rwlock tcb_history_lock __aligned(CACHE_LINE_SIZE);
310 struct tcb_histent **tcb_history;
311 int dupack_threshold;
313 /* WRs that will not be sent to the chip because L2 resolution failed */
314 struct mtx unsent_wr_lock;
315 STAILQ_HEAD(, wrqe) unsent_wr_list;
316 struct task reclaim_wr_resources;
319 static inline struct tom_data *
320 tod_td(struct toedev *tod)
323 return (__containerof(tod, struct tom_data, tod));
326 static inline struct adapter *
327 td_adapter(struct tom_data *td)
330 return (td->tod.tod_softc);
334 set_mbuf_ulp_submode(struct mbuf *m, uint8_t ulp_submode)
338 m->m_pkthdr.PH_per.eight[0] = ulp_submode;
341 static inline uint8_t
342 mbuf_ulp_submode(struct mbuf *m)
346 return (m->m_pkthdr.PH_per.eight[0]);
350 struct toepcb *alloc_toepcb(struct vi_info *, int);
351 int init_toepcb(struct vi_info *, struct toepcb *);
352 struct toepcb *hold_toepcb(struct toepcb *);
353 void free_toepcb(struct toepcb *);
354 void offload_socket(struct socket *, struct toepcb *);
355 void undo_offload_socket(struct socket *);
356 void final_cpl_received(struct toepcb *);
357 void insert_tid(struct adapter *, int, void *, int);
358 void *lookup_tid(struct adapter *, int);
359 void update_tid(struct adapter *, int, void *);
360 void remove_tid(struct adapter *, int, int);
361 u_long select_rcv_wnd(struct socket *);
362 int select_rcv_wscale(void);
363 void init_conn_params(struct vi_info *, struct offload_settings *,
364 struct in_conninfo *, struct socket *, const struct tcp_options *, int16_t,
365 struct conn_params *cp);
366 __be64 calc_options0(struct vi_info *, struct conn_params *);
367 __be32 calc_options2(struct vi_info *, struct conn_params *);
368 uint64_t select_ntuple(struct vi_info *, struct l2t_entry *);
369 int negative_advice(int);
370 int add_tid_to_history(struct adapter *, u_int);
373 void t4_init_connect_cpl_handlers(void);
374 void t4_uninit_connect_cpl_handlers(void);
375 int t4_connect(struct toedev *, struct socket *, struct nhop_object *,
377 void act_open_failure_cleanup(struct adapter *, u_int, u_int);
380 void t4_init_listen_cpl_handlers(void);
381 void t4_uninit_listen_cpl_handlers(void);
382 int t4_listen_start(struct toedev *, struct tcpcb *);
383 int t4_listen_stop(struct toedev *, struct tcpcb *);
384 void t4_syncache_added(struct toedev *, void *);
385 void t4_syncache_removed(struct toedev *, void *);
386 int t4_syncache_respond(struct toedev *, void *, struct mbuf *);
387 int do_abort_req_synqe(struct sge_iq *, const struct rss_header *,
389 int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *,
391 void t4_offload_socket(struct toedev *, void *, struct socket *);
392 void synack_failure_cleanup(struct adapter *, int);
395 void aiotx_init_toep(struct toepcb *);
396 int t4_aio_queue_aiotx(struct socket *, struct kaiocb *);
397 void t4_init_cpl_io_handlers(void);
398 void t4_uninit_cpl_io_handlers(void);
399 void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int);
400 void send_flowc_wr(struct toepcb *, struct tcpcb *);
401 void send_reset(struct adapter *, struct toepcb *, uint32_t);
402 int send_rx_credits(struct adapter *, struct toepcb *, int);
403 void send_rx_modulate(struct adapter *, struct toepcb *);
404 void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t);
405 int t4_close_conn(struct adapter *, struct toepcb *);
406 void t4_rcvd(struct toedev *, struct tcpcb *);
407 void t4_rcvd_locked(struct toedev *, struct tcpcb *);
408 int t4_tod_output(struct toedev *, struct tcpcb *);
409 int t4_send_fin(struct toedev *, struct tcpcb *);
410 int t4_send_rst(struct toedev *, struct tcpcb *);
411 void t4_set_tcb_field(struct adapter *, struct sge_wrq *, struct toepcb *,
412 uint16_t, uint64_t, uint64_t, int, int);
413 void t4_push_frames(struct adapter *, struct toepcb *, int);
414 void t4_push_pdus(struct adapter *, struct toepcb *, int);
417 int t4_init_ppod_region(struct ppod_region *, struct t4_range *, u_int,
419 void t4_free_ppod_region(struct ppod_region *);
420 int t4_alloc_page_pods_for_ps(struct ppod_region *, struct pageset *);
421 int t4_alloc_page_pods_for_buf(struct ppod_region *, vm_offset_t, int,
422 struct ppod_reservation *);
423 int t4_write_page_pods_for_ps(struct adapter *, struct sge_wrq *, int,
425 int t4_write_page_pods_for_buf(struct adapter *, struct sge_wrq *, int tid,
426 struct ppod_reservation *, vm_offset_t, int);
427 void t4_free_page_pods(struct ppod_reservation *);
428 int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *,
429 struct mbuf **, struct mbuf **, int *);
430 int t4_aio_queue_ddp(struct socket *, struct kaiocb *);
431 void t4_ddp_mod_load(void);
432 void t4_ddp_mod_unload(void);
433 void ddp_assert_empty(struct toepcb *);
434 void ddp_init_toep(struct toepcb *);
435 void ddp_uninit_toep(struct toepcb *);
436 void ddp_queue_toep(struct toepcb *);
437 void release_ddp_resources(struct toepcb *toep);
438 void handle_ddp_close(struct toepcb *, struct tcpcb *, uint32_t);
439 void handle_ddp_indicate(struct toepcb *);
440 void insert_ddp_data(struct toepcb *, uint32_t);
441 const struct offload_settings *lookup_offload_policy(struct adapter *, int,
442 struct mbuf *, uint16_t, struct inpcb *);
445 bool can_tls_offload(struct adapter *);
446 void do_rx_data_tls(const struct cpl_rx_data *, struct toepcb *, struct mbuf *);
447 int t4_ctloutput_tls(struct socket *, struct sockopt *);
448 void t4_push_tls_records(struct adapter *, struct toepcb *, int);
449 void t4_push_ktls(struct adapter *, struct toepcb *, int);
450 void t4_tls_mod_load(void);
451 void t4_tls_mod_unload(void);
452 void tls_detach(struct toepcb *);
453 void tls_establish(struct toepcb *);
454 void tls_init_toep(struct toepcb *);
455 int tls_rx_key(struct toepcb *);
456 void tls_stop_handshake_timer(struct toepcb *);
457 int tls_tx_key(struct toepcb *);
458 void tls_uninit_toep(struct toepcb *);
459 int tls_alloc_ktls(struct toepcb *, struct ktls_session *, int);