1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012, 2015 Chelsio Communications, Inc. 5 * All rights reserved. 6 * Written by: Navdeep Parhar <np@FreeBSD.org> 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 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. 16 * 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 27 * SUCH DAMAGE. 28 * 29 * $FreeBSD$ 30 * 31 */ 32 33 #ifndef __T4_TOM_H__ 34 #define __T4_TOM_H__ 35 #include <sys/vmem.h> 36 #include "common/t4_hw.h" 37 #include "tom/t4_tls.h" 38 39 #define LISTEN_HASH_SIZE 32 40 41 /* 42 * Min receive window. We want it to be large enough to accommodate receive 43 * coalescing, handle jumbo frames, and not trigger sender SWS avoidance. 44 */ 45 #define MIN_RCV_WND (24 * 1024U) 46 47 /* 48 * Max receive window supported by HW in bytes. Only a small part of it can 49 * be set through option0, the rest needs to be set through RX_DATA_ACK. 50 */ 51 #define MAX_RCV_WND ((1U << 27) - 1) 52 53 #define DDP_RSVD_WIN (16 * 1024U) 54 #define SB_DDP_INDICATE SB_IN_TOE /* soreceive must respond to indicate */ 55 56 #define USE_DDP_RX_FLOW_CONTROL 57 58 #define PPOD_SZ(n) ((n) * sizeof(struct pagepod)) 59 #define PPOD_SIZE (PPOD_SZ(1)) 60 61 /* TOE PCB flags */ 62 enum { 63 TPF_ATTACHED = (1 << 0), /* a tcpcb refers to this toepcb */ 64 TPF_FLOWC_WR_SENT = (1 << 1), /* firmware flow context WR sent */ 65 TPF_TX_DATA_SENT = (1 << 2), /* some data sent */ 66 TPF_TX_SUSPENDED = (1 << 3), /* tx suspended for lack of resources */ 67 TPF_SEND_FIN = (1 << 4), /* send FIN after all pending data */ 68 TPF_FIN_SENT = (1 << 5), /* FIN has been sent */ 69 TPF_ABORT_SHUTDOWN = (1 << 6), /* connection abort is in progress */ 70 TPF_CPL_PENDING = (1 << 7), /* haven't received the last CPL */ 71 TPF_SYNQE = (1 << 8), /* synq_entry, not really a toepcb */ 72 TPF_SYNQE_EXPANDED = (1 << 9), /* toepcb ready, tid context updated */ 73 TPF_FORCE_CREDITS = (1 << 10), /* always send credits */ 74 }; 75 76 enum { 77 DDP_OK = (1 << 0), /* OK to turn on DDP */ 78 DDP_SC_REQ = (1 << 1), /* state change (on/off) requested */ 79 DDP_ON = (1 << 2), /* DDP is turned on */ 80 DDP_BUF0_ACTIVE = (1 << 3), /* buffer 0 in use (not invalidated) */ 81 DDP_BUF1_ACTIVE = (1 << 4), /* buffer 1 in use (not invalidated) */ 82 DDP_TASK_ACTIVE = (1 << 5), /* requeue task is queued / running */ 83 DDP_DEAD = (1 << 6), /* toepcb is shutting down */ 84 }; 85 86 struct sockopt; 87 struct offload_settings; 88 89 struct ofld_tx_sdesc { 90 uint32_t plen; /* payload length */ 91 uint8_t tx_credits; /* firmware tx credits (unit is 16B) */ 92 void *iv_buffer; /* optional buffer holding IVs for TLS */ 93 }; 94 95 struct ppod_region { 96 u_int pr_start; 97 u_int pr_len; 98 u_int pr_page_shift[4]; 99 uint32_t pr_tag_mask; /* hardware tagmask for this region. */ 100 uint32_t pr_invalid_bit; /* OR with this to invalidate tag. */ 101 uint32_t pr_alias_mask; /* AND with tag to get alias bits. */ 102 u_int pr_alias_shift; /* shift this much for first alias bit. */ 103 vmem_t *pr_arena; 104 }; 105 106 struct ppod_reservation { 107 struct ppod_region *prsv_pr; 108 uint32_t prsv_tag; /* Full tag: pgsz, alias, tag, color */ 109 u_int prsv_nppods; 110 }; 111 112 struct pageset { 113 TAILQ_ENTRY(pageset) link; 114 vm_page_t *pages; 115 int npages; 116 int flags; 117 int offset; /* offset in first page */ 118 int len; 119 struct ppod_reservation prsv; 120 struct vmspace *vm; 121 vm_offset_t start; 122 u_int vm_timestamp; 123 }; 124 125 TAILQ_HEAD(pagesetq, pageset); 126 127 #define PS_WIRED 0x0001 /* Pages wired rather than held. */ 128 #define PS_PPODS_WRITTEN 0x0002 /* Page pods written to the card. */ 129 130 struct ddp_buffer { 131 struct pageset *ps; 132 133 struct kaiocb *job; 134 int cancel_pending; 135 }; 136 137 struct ddp_pcb { 138 u_int flags; 139 struct ddp_buffer db[2]; 140 TAILQ_HEAD(, pageset) cached_pagesets; 141 TAILQ_HEAD(, kaiocb) aiojobq; 142 u_int waiting_count; 143 u_int active_count; 144 u_int cached_count; 145 int active_id; /* the currently active DDP buffer */ 146 struct task requeue_task; 147 struct kaiocb *queueing; 148 struct mtx lock; 149 }; 150 151 struct toepcb { 152 TAILQ_ENTRY(toepcb) link; /* toep_list */ 153 u_int flags; /* miscellaneous flags */ 154 int refcount; 155 struct tom_data *td; 156 struct inpcb *inp; /* backpointer to host stack's PCB */ 157 struct vnet *vnet; 158 struct vi_info *vi; /* virtual interface */ 159 struct sge_wrq *ofld_txq; 160 struct sge_ofld_rxq *ofld_rxq; 161 struct sge_wrq *ctrlq; 162 struct l2t_entry *l2te; /* L2 table entry used by this connection */ 163 struct clip_entry *ce; /* CLIP table entry used by this tid */ 164 int tid; /* Connection identifier */ 165 int tc_idx; /* traffic class that this tid is bound to */ 166 167 /* tx credit handling */ 168 u_int tx_total; /* total tx WR credits (in 16B units) */ 169 u_int tx_credits; /* tx WR credits (in 16B units) available */ 170 u_int tx_nocompl; /* tx WR credits since last compl request */ 171 u_int plen_nocompl; /* payload since last compl request */ 172 173 uint16_t opt0_rcv_bufsize; /* XXX: save full opt0/opt2 for later? */ 174 uint16_t mtu_idx; 175 uint16_t emss; 176 uint16_t tcp_opt; 177 178 u_int ulp_mode; /* ULP mode */ 179 void *ulpcb; 180 void *ulpcb2; 181 struct mbufq ulp_pduq; /* PDUs waiting to be sent out. */ 182 struct mbufq ulp_pdu_reclaimq; 183 184 struct ddp_pcb ddp; 185 struct tls_ofld_info tls; 186 187 TAILQ_HEAD(, kaiocb) aiotx_jobq; 188 struct task aiotx_task; 189 struct socket *aiotx_so; 190 191 /* Tx software descriptor */ 192 uint8_t txsd_total; 193 uint8_t txsd_pidx; 194 uint8_t txsd_cidx; 195 uint8_t txsd_avail; 196 struct ofld_tx_sdesc txsd[]; 197 }; 198 199 #define DDP_LOCK(toep) mtx_lock(&(toep)->ddp.lock) 200 #define DDP_UNLOCK(toep) mtx_unlock(&(toep)->ddp.lock) 201 #define DDP_ASSERT_LOCKED(toep) mtx_assert(&(toep)->ddp.lock, MA_OWNED) 202 203 struct flowc_tx_params { 204 uint32_t snd_nxt; 205 uint32_t rcv_nxt; 206 unsigned int snd_space; 207 unsigned int mss; 208 }; 209 210 /* 211 * Compressed state for embryonic connections for a listener. 212 */ 213 struct synq_entry { 214 struct listen_ctx *lctx; /* backpointer to listen ctx */ 215 struct mbuf *syn; 216 int flags; /* same as toepcb's tp_flags */ 217 volatile int ok_to_respond; 218 volatile u_int refcnt; 219 int tid; 220 uint32_t iss; 221 uint32_t irs; 222 uint32_t ts; 223 uint16_t txqid; 224 uint16_t rxqid; 225 uint16_t l2e_idx; 226 uint16_t ulp_mode; 227 uint16_t rcv_bufsize; 228 __be16 tcp_opt; /* from cpl_pass_establish */ 229 struct toepcb *toep; 230 }; 231 232 /* listen_ctx flags */ 233 #define LCTX_RPL_PENDING 1 /* waiting for a CPL_PASS_OPEN_RPL */ 234 235 struct listen_ctx { 236 LIST_ENTRY(listen_ctx) link; /* listen hash linkage */ 237 volatile int refcount; 238 int stid; 239 struct stid_region stid_region; 240 int flags; 241 struct inpcb *inp; /* listening socket's inp */ 242 struct vnet *vnet; 243 struct sge_wrq *ctrlq; 244 struct sge_ofld_rxq *ofld_rxq; 245 struct clip_entry *ce; 246 }; 247 248 /* tcb_histent flags */ 249 #define TE_RPL_PENDING 1 250 #define TE_ACTIVE 2 251 252 /* bits in one 8b tcb_histent sample. */ 253 #define TS_RTO (1 << 0) 254 #define TS_DUPACKS (1 << 1) 255 #define TS_FASTREXMT (1 << 2) 256 #define TS_SND_BACKLOGGED (1 << 3) 257 #define TS_CWND_LIMITED (1 << 4) 258 #define TS_ECN_ECE (1 << 5) 259 #define TS_ECN_CWR (1 << 6) 260 #define TS_RESERVED (1 << 7) /* Unused. */ 261 262 struct tcb_histent { 263 struct mtx te_lock; 264 struct callout te_callout; 265 uint64_t te_tcb[TCB_SIZE / sizeof(uint64_t)]; 266 struct adapter *te_adapter; 267 u_int te_flags; 268 u_int te_tid; 269 uint8_t te_pidx; 270 uint8_t te_sample[100]; 271 }; 272 273 struct tom_data { 274 struct toedev tod; 275 276 /* toepcb's associated with this TOE device */ 277 struct mtx toep_list_lock; 278 TAILQ_HEAD(, toepcb) toep_list; 279 280 struct mtx lctx_hash_lock; 281 LIST_HEAD(, listen_ctx) *listen_hash; 282 u_long listen_mask; 283 int lctx_count; /* # of lctx in the hash table */ 284 285 struct ppod_region pr; 286 287 struct rwlock tcb_history_lock __aligned(CACHE_LINE_SIZE); 288 struct tcb_histent **tcb_history; 289 int dupack_threshold; 290 291 /* WRs that will not be sent to the chip because L2 resolution failed */ 292 struct mtx unsent_wr_lock; 293 STAILQ_HEAD(, wrqe) unsent_wr_list; 294 struct task reclaim_wr_resources; 295 }; 296 297 static inline struct tom_data * 298 tod_td(struct toedev *tod) 299 { 300 301 return (__containerof(tod, struct tom_data, tod)); 302 } 303 304 static inline struct adapter * 305 td_adapter(struct tom_data *td) 306 { 307 308 return (td->tod.tod_softc); 309 } 310 311 static inline void 312 set_mbuf_ulp_submode(struct mbuf *m, uint8_t ulp_submode) 313 { 314 315 M_ASSERTPKTHDR(m); 316 m->m_pkthdr.PH_per.eight[0] = ulp_submode; 317 } 318 319 static inline uint8_t 320 mbuf_ulp_submode(struct mbuf *m) 321 { 322 323 M_ASSERTPKTHDR(m); 324 return (m->m_pkthdr.PH_per.eight[0]); 325 } 326 327 /* t4_tom.c */ 328 struct toepcb *alloc_toepcb(struct vi_info *, int, int, int); 329 struct toepcb *hold_toepcb(struct toepcb *); 330 void free_toepcb(struct toepcb *); 331 void offload_socket(struct socket *, struct toepcb *); 332 void undo_offload_socket(struct socket *); 333 void final_cpl_received(struct toepcb *); 334 void insert_tid(struct adapter *, int, void *, int); 335 void *lookup_tid(struct adapter *, int); 336 void update_tid(struct adapter *, int, void *); 337 void remove_tid(struct adapter *, int, int); 338 int find_best_mtu_idx(struct adapter *, struct in_conninfo *, 339 struct offload_settings *); 340 u_long select_rcv_wnd(struct socket *); 341 int select_rcv_wscale(void); 342 uint64_t calc_opt0(struct socket *, struct vi_info *, struct l2t_entry *, 343 int, int, int, int, struct offload_settings *); 344 uint64_t select_ntuple(struct vi_info *, struct l2t_entry *); 345 int select_ulp_mode(struct socket *, struct adapter *, 346 struct offload_settings *); 347 void set_ulp_mode(struct toepcb *, int); 348 int negative_advice(int); 349 int add_tid_to_history(struct adapter *, u_int); 350 351 /* t4_connect.c */ 352 void t4_init_connect_cpl_handlers(void); 353 void t4_uninit_connect_cpl_handlers(void); 354 int t4_connect(struct toedev *, struct socket *, struct rtentry *, 355 struct sockaddr *); 356 void act_open_failure_cleanup(struct adapter *, u_int, u_int); 357 358 /* t4_listen.c */ 359 void t4_init_listen_cpl_handlers(void); 360 void t4_uninit_listen_cpl_handlers(void); 361 int t4_listen_start(struct toedev *, struct tcpcb *); 362 int t4_listen_stop(struct toedev *, struct tcpcb *); 363 void t4_syncache_added(struct toedev *, void *); 364 void t4_syncache_removed(struct toedev *, void *); 365 int t4_syncache_respond(struct toedev *, void *, struct mbuf *); 366 int do_abort_req_synqe(struct sge_iq *, const struct rss_header *, 367 struct mbuf *); 368 int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *, 369 struct mbuf *); 370 void t4_offload_socket(struct toedev *, void *, struct socket *); 371 void synack_failure_cleanup(struct adapter *, int); 372 373 /* t4_cpl_io.c */ 374 void aiotx_init_toep(struct toepcb *); 375 int t4_aio_queue_aiotx(struct socket *, struct kaiocb *); 376 void t4_init_cpl_io_handlers(void); 377 void t4_uninit_cpl_io_handlers(void); 378 void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int); 379 void send_flowc_wr(struct toepcb *, struct flowc_tx_params *); 380 void send_reset(struct adapter *, struct toepcb *, uint32_t); 381 int send_rx_credits(struct adapter *, struct toepcb *, int); 382 void send_rx_modulate(struct adapter *, struct toepcb *); 383 void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t); 384 int t4_close_conn(struct adapter *, struct toepcb *); 385 void t4_rcvd(struct toedev *, struct tcpcb *); 386 void t4_rcvd_locked(struct toedev *, struct tcpcb *); 387 int t4_tod_output(struct toedev *, struct tcpcb *); 388 int t4_send_fin(struct toedev *, struct tcpcb *); 389 int t4_send_rst(struct toedev *, struct tcpcb *); 390 void t4_set_tcb_field(struct adapter *, struct sge_wrq *, struct toepcb *, 391 uint16_t, uint64_t, uint64_t, int, int); 392 void t4_push_frames(struct adapter *sc, struct toepcb *toep, int drop); 393 void t4_push_pdus(struct adapter *sc, struct toepcb *toep, int drop); 394 395 /* t4_ddp.c */ 396 int t4_init_ppod_region(struct ppod_region *, struct t4_range *, u_int, 397 const char *); 398 void t4_free_ppod_region(struct ppod_region *); 399 int t4_alloc_page_pods_for_ps(struct ppod_region *, struct pageset *); 400 int t4_alloc_page_pods_for_buf(struct ppod_region *, vm_offset_t, int, 401 struct ppod_reservation *); 402 int t4_write_page_pods_for_ps(struct adapter *, struct sge_wrq *, int, 403 struct pageset *); 404 int t4_write_page_pods_for_buf(struct adapter *, struct sge_wrq *, int tid, 405 struct ppod_reservation *, vm_offset_t, int); 406 void t4_free_page_pods(struct ppod_reservation *); 407 int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *, 408 struct mbuf **, struct mbuf **, int *); 409 int t4_aio_queue_ddp(struct socket *, struct kaiocb *); 410 void t4_ddp_mod_load(void); 411 void t4_ddp_mod_unload(void); 412 void ddp_assert_empty(struct toepcb *); 413 void ddp_init_toep(struct toepcb *); 414 void ddp_uninit_toep(struct toepcb *); 415 void ddp_queue_toep(struct toepcb *); 416 void release_ddp_resources(struct toepcb *toep); 417 void handle_ddp_close(struct toepcb *, struct tcpcb *, uint32_t); 418 void handle_ddp_indicate(struct toepcb *); 419 void insert_ddp_data(struct toepcb *, uint32_t); 420 const struct offload_settings *lookup_offload_policy(struct adapter *, int, 421 struct mbuf *, uint16_t, struct inpcb *); 422 423 /* t4_tls.c */ 424 bool can_tls_offload(struct adapter *); 425 int t4_ctloutput_tls(struct socket *, struct sockopt *); 426 void t4_push_tls_records(struct adapter *, struct toepcb *, int); 427 void t4_tls_mod_load(void); 428 void t4_tls_mod_unload(void); 429 void tls_establish(struct toepcb *); 430 void tls_init_toep(struct toepcb *); 431 int tls_rx_key(struct toepcb *); 432 void tls_stop_handshake_timer(struct toepcb *); 433 int tls_tx_key(struct toepcb *); 434 void tls_uninit_toep(struct toepcb *); 435 436 #endif 437