sys/dev/cxgbe/tom/t4_tom.h

   1 /*-
   2  * Copyright (c) 2012, 2015 Chelsio Communications, Inc.
   3  * All rights reserved.
   4  * Written by: Navdeep Parhar <np@FreeBSD.org>
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  *
  29  */
  30
  31 #ifndef __T4_TOM_H__
  32 #define __T4_TOM_H__
  33 #include <sys/vmem.h>
  34
  35 #define LISTEN_HASH_SIZE 32
  36
  37 /*
  38  * Min receive window.  We want it to be large enough to accommodate receive
  39  * coalescing, handle jumbo frames, and not trigger sender SWS avoidance.
  40  */
  41 #define MIN_RCV_WND (24 * 1024U)
  42
  43 /*
  44  * Max receive window supported by HW in bytes.  Only a small part of it can
  45  * be set through option0, the rest needs to be set through RX_DATA_ACK.
  46  */
  47 #define MAX_RCV_WND ((1U << 27) - 1)
  48
  49 #define DDP_RSVD_WIN (16 * 1024U)
  50 #define SB_DDP_INDICATE SB_IN_TOE       /* soreceive must respond to indicate */
  51
  52 #define USE_DDP_RX_FLOW_CONTROL
  53
  54 #define PPOD_SZ(n)      ((n) * sizeof(struct pagepod))
  55 #define PPOD_SIZE       (PPOD_SZ(1))
  56
  57 /* TOE PCB flags */
  58 enum {
  59         TPF_ATTACHED       = (1 << 0),  /* a tcpcb refers to this toepcb */
  60         TPF_FLOWC_WR_SENT  = (1 << 1),  /* firmware flow context WR sent */
  61         TPF_TX_DATA_SENT   = (1 << 2),  /* some data sent */
  62         TPF_TX_SUSPENDED   = (1 << 3),  /* tx suspended for lack of resources */
  63         TPF_SEND_FIN       = (1 << 4),  /* send FIN after all pending data */
  64         TPF_FIN_SENT       = (1 << 5),  /* FIN has been sent */
  65         TPF_ABORT_SHUTDOWN = (1 << 6),  /* connection abort is in progress */
  66         TPF_CPL_PENDING    = (1 << 7),  /* haven't received the last CPL */
  67         TPF_SYNQE          = (1 << 8),  /* synq_entry, not really a toepcb */
  68         TPF_SYNQE_NEEDFREE = (1 << 9),  /* synq_entry was malloc'd separately */
  69         TPF_SYNQE_TCPDDP   = (1 << 10), /* ulp_mode TCPDDP in toepcb */
  70         TPF_SYNQE_EXPANDED = (1 << 11), /* toepcb ready, tid context updated */
  71         TPF_SYNQE_HAS_L2TE = (1 << 12), /* we've replied to PASS_ACCEPT_REQ */
  72 };
  73
  74 enum {
  75         DDP_OK          = (1 << 0),     /* OK to turn on DDP */
  76         DDP_SC_REQ      = (1 << 1),     /* state change (on/off) requested */
  77         DDP_ON          = (1 << 2),     /* DDP is turned on */
  78         DDP_BUF0_ACTIVE = (1 << 3),     /* buffer 0 in use (not invalidated) */
  79         DDP_BUF1_ACTIVE = (1 << 4),     /* buffer 1 in use (not invalidated) */
  80         DDP_TASK_ACTIVE = (1 << 5),     /* requeue task is queued / running */
  81         DDP_DEAD        = (1 << 6),     /* toepcb is shutting down */
  82 };
  83
  84 struct ofld_tx_sdesc {
  85         uint32_t plen;          /* payload length */
  86         uint8_t tx_credits;     /* firmware tx credits (unit is 16B) */
  87 };
  88
  89 struct ppod_region {
  90         u_int pr_start;
  91         u_int pr_len;
  92         u_int pr_page_shift[4];
  93         uint32_t pr_tag_mask;           /* hardware tagmask for this region. */
  94         uint32_t pr_invalid_bit;        /* OR with this to invalidate tag. */
  95         uint32_t pr_alias_mask;         /* AND with tag to get alias bits. */
  96         u_int pr_alias_shift;           /* shift this much for first alias bit. */
  97         vmem_t *pr_arena;
  98 };
  99
 100 struct ppod_reservation {
 101         struct ppod_region *prsv_pr;
 102         uint32_t prsv_tag;              /* Full tag: pgsz, alias, tag, color */
 103         u_int prsv_nppods;
 104 };
 105
 106 struct pageset {
 107         TAILQ_ENTRY(pageset) link;
 108         vm_page_t *pages;
 109         int npages;
 110         int flags;
 111         int offset;             /* offset in first page */
 112         int len;
 113         struct ppod_reservation prsv;
 114         struct vmspace *vm;
 115         vm_offset_t start;
 116         u_int vm_timestamp;
 117 };
 118
 119 TAILQ_HEAD(pagesetq, pageset);
 120
 121 #define PS_WIRED                0x0001  /* Pages wired rather than held. */
 122 #define PS_PPODS_WRITTEN        0x0002  /* Page pods written to the card. */
 123
 124 #define EXT_FLAG_AIOTX          EXT_FLAG_VENDOR1
 125
 126 struct ddp_buffer {
 127         struct pageset *ps;
 128
 129         struct kaiocb *job;
 130         int cancel_pending;
 131 };
 132
 133 struct ddp_pcb {
 134         u_int flags;
 135         struct ddp_buffer db[2];
 136         TAILQ_HEAD(, pageset) cached_pagesets;
 137         TAILQ_HEAD(, kaiocb) aiojobq;
 138         u_int waiting_count;
 139         u_int active_count;
 140         u_int cached_count;
 141         int active_id;  /* the currently active DDP buffer */
 142         struct task requeue_task;
 143         struct kaiocb *queueing;
 144         struct mtx lock;
 145 };
 146
 147 struct aiotx_buffer {
 148         struct pageset ps;
 149         struct kaiocb *job;
 150         int refcount;
 151 };
 152
 153 struct toepcb {
 154         TAILQ_ENTRY(toepcb) link; /* toep_list */
 155         u_int flags;            /* miscellaneous flags */
 156         int refcount;
 157         struct tom_data *td;
 158         struct inpcb *inp;      /* backpointer to host stack's PCB */
 159         struct vnet *vnet;
 160         struct vi_info *vi;     /* virtual interface */
 161         struct sge_wrq *ofld_txq;
 162         struct sge_ofld_rxq *ofld_rxq;
 163         struct sge_wrq *ctrlq;
 164         struct l2t_entry *l2te; /* L2 table entry used by this connection */
 165         struct clip_entry *ce;  /* CLIP table entry used by this tid */
 166         int tid;                /* Connection identifier */
 167
 168         /* tx credit handling */
 169         u_int tx_total;         /* total tx WR credits (in 16B units) */
 170         u_int tx_credits;       /* tx WR credits (in 16B units) available */
 171         u_int tx_nocompl;       /* tx WR credits since last compl request */
 172         u_int plen_nocompl;     /* payload since last compl request */
 173
 174         /* rx credit handling */
 175         u_int sb_cc;            /* last noted value of so_rcv->sb_cc */
 176         int rx_credits;         /* rx credits (in bytes) to be returned to hw */
 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
 186         TAILQ_HEAD(, kaiocb) aiotx_jobq;
 187         struct task aiotx_task;
 188         bool aiotx_task_active;
 189
 190         /* Tx software descriptor */
 191         uint8_t txsd_total;
 192         uint8_t txsd_pidx;
 193         uint8_t txsd_cidx;
 194         uint8_t txsd_avail;
 195         struct ofld_tx_sdesc txsd[];
 196 };
 197
 198 #define DDP_LOCK(toep)          mtx_lock(&(toep)->ddp.lock)
 199 #define DDP_UNLOCK(toep)        mtx_unlock(&(toep)->ddp.lock)
 200 #define DDP_ASSERT_LOCKED(toep) mtx_assert(&(toep)->ddp.lock, MA_OWNED)
 201
 202 struct flowc_tx_params {
 203         uint32_t snd_nxt;
 204         uint32_t rcv_nxt;
 205         unsigned int snd_space;
 206         unsigned int mss;
 207 };
 208
 209 #define DDP_RETRY_WAIT  5       /* seconds to wait before re-enabling DDP */
 210 #define DDP_LOW_SCORE   1
 211 #define DDP_HIGH_SCORE  3
 212
 213 /*
 214  * Compressed state for embryonic connections for a listener.  Barely fits in
 215  * 64B, try not to grow it further.
 216  */
 217 struct synq_entry {
 218         TAILQ_ENTRY(synq_entry) link;   /* listen_ctx's synq link */
 219         int flags;                      /* same as toepcb's tp_flags */
 220         int tid;
 221         struct listen_ctx *lctx;        /* backpointer to listen ctx */
 222         struct mbuf *syn;
 223         uint32_t iss;
 224         uint32_t ts;
 225         volatile uintptr_t wr;
 226         volatile u_int refcnt;
 227         uint16_t l2e_idx;
 228         uint16_t rcv_bufsize;
 229 };
 230
 231 /* listen_ctx flags */
 232 #define LCTX_RPL_PENDING 1      /* waiting for a CPL_PASS_OPEN_RPL */
 233
 234 struct listen_ctx {
 235         LIST_ENTRY(listen_ctx) link;    /* listen hash linkage */
 236         volatile int refcount;
 237         int stid;
 238         struct stid_region stid_region;
 239         int flags;
 240         struct inpcb *inp;              /* listening socket's inp */
 241         struct vnet *vnet;
 242         struct sge_wrq *ctrlq;
 243         struct sge_ofld_rxq *ofld_rxq;
 244         struct clip_entry *ce;
 245         TAILQ_HEAD(, synq_entry) synq;
 246 };
 247
 248 struct clip_entry {
 249         TAILQ_ENTRY(clip_entry) link;
 250         struct in6_addr lip;    /* local IPv6 address */
 251         u_int refcount;
 252 };
 253
 254 TAILQ_HEAD(clip_head, clip_entry);
 255 struct tom_data {
 256         struct toedev tod;
 257
 258         /* toepcb's associated with this TOE device */
 259         struct mtx toep_list_lock;
 260         TAILQ_HEAD(, toepcb) toep_list;
 261
 262         struct mtx lctx_hash_lock;
 263         LIST_HEAD(, listen_ctx) *listen_hash;
 264         u_long listen_mask;
 265         int lctx_count;         /* # of lctx in the hash table */
 266
 267         struct ppod_region pr;
 268
 269         struct mtx clip_table_lock;
 270         struct clip_head clip_table;
 271         int clip_gen;
 272
 273         /* WRs that will not be sent to the chip because L2 resolution failed */
 274         struct mtx unsent_wr_lock;
 275         STAILQ_HEAD(, wrqe) unsent_wr_list;
 276         struct task reclaim_wr_resources;
 277 };
 278
 279 static inline struct tom_data *
 280 tod_td(struct toedev *tod)
 281 {
 282
 283         return (__containerof(tod, struct tom_data, tod));
 284 }
 285
 286 static inline struct adapter *
 287 td_adapter(struct tom_data *td)
 288 {
 289
 290         return (td->tod.tod_softc);
 291 }
 292
 293 static inline void
 294 set_mbuf_ulp_submode(struct mbuf *m, uint8_t ulp_submode)
 295 {
 296
 297         M_ASSERTPKTHDR(m);
 298         m->m_pkthdr.PH_per.eight[0] = ulp_submode;
 299 }
 300
 301 static inline uint8_t
 302 mbuf_ulp_submode(struct mbuf *m)
 303 {
 304
 305         M_ASSERTPKTHDR(m);
 306         return (m->m_pkthdr.PH_per.eight[0]);
 307 }
 308
 309 /* t4_tom.c */
 310 struct toepcb *alloc_toepcb(struct vi_info *, int, int, int);
 311 struct toepcb *hold_toepcb(struct toepcb *);
 312 void free_toepcb(struct toepcb *);
 313 void offload_socket(struct socket *, struct toepcb *);
 314 void undo_offload_socket(struct socket *);
 315 void final_cpl_received(struct toepcb *);
 316 void insert_tid(struct adapter *, int, void *, int);
 317 void *lookup_tid(struct adapter *, int);
 318 void update_tid(struct adapter *, int, void *);
 319 void remove_tid(struct adapter *, int, int);
 320 void release_tid(struct adapter *, int, struct sge_wrq *);
 321 int find_best_mtu_idx(struct adapter *, struct in_conninfo *, int);
 322 u_long select_rcv_wnd(struct socket *);
 323 int select_rcv_wscale(void);
 324 uint64_t calc_opt0(struct socket *, struct vi_info *, struct l2t_entry *,
 325     int, int, int, int);
 326 uint64_t select_ntuple(struct vi_info *, struct l2t_entry *);
 327 void set_tcpddp_ulp_mode(struct toepcb *);
 328 int negative_advice(int);
 329 struct clip_entry *hold_lip(struct tom_data *, struct in6_addr *,
 330     struct clip_entry *);
 331 void release_lip(struct tom_data *, struct clip_entry *);
 332
 333 /* t4_connect.c */
 334 void t4_init_connect_cpl_handlers(void);
 335 void t4_uninit_connect_cpl_handlers(void);
 336 int t4_connect(struct toedev *, struct socket *, struct rtentry *,
 337     struct sockaddr *);
 338 void act_open_failure_cleanup(struct adapter *, u_int, u_int);
 339
 340 /* t4_listen.c */
 341 void t4_init_listen_cpl_handlers(void);
 342 void t4_uninit_listen_cpl_handlers(void);
 343 int t4_listen_start(struct toedev *, struct tcpcb *);
 344 int t4_listen_stop(struct toedev *, struct tcpcb *);
 345 void t4_syncache_added(struct toedev *, void *);
 346 void t4_syncache_removed(struct toedev *, void *);
 347 int t4_syncache_respond(struct toedev *, void *, struct mbuf *);
 348 int do_abort_req_synqe(struct sge_iq *, const struct rss_header *,
 349     struct mbuf *);
 350 int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *,
 351     struct mbuf *);
 352 void t4_offload_socket(struct toedev *, void *, struct socket *);
 353
 354 /* t4_cpl_io.c */
 355 void aiotx_init_toep(struct toepcb *);
 356 int t4_aio_queue_aiotx(struct socket *, struct kaiocb *);
 357 void t4_init_cpl_io_handlers(void);
 358 void t4_uninit_cpl_io_handlers(void);
 359 void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int);
 360 void send_flowc_wr(struct toepcb *, struct flowc_tx_params *);
 361 void send_reset(struct adapter *, struct toepcb *, uint32_t);
 362 void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t);
 363 void t4_rcvd(struct toedev *, struct tcpcb *);
 364 void t4_rcvd_locked(struct toedev *, struct tcpcb *);
 365 int t4_tod_output(struct toedev *, struct tcpcb *);
 366 int t4_send_fin(struct toedev *, struct tcpcb *);
 367 int t4_send_rst(struct toedev *, struct tcpcb *);
 368 void t4_set_tcb_field(struct adapter *, struct sge_wrq *, int, uint16_t,
 369     uint64_t, uint64_t, int, int, int);
 370 void t4_push_frames(struct adapter *sc, struct toepcb *toep, int drop);
 371 void t4_push_pdus(struct adapter *sc, struct toepcb *toep, int drop);
 372 int do_set_tcb_rpl(struct sge_iq *, const struct rss_header *, struct mbuf *);
 373
 374 /* t4_ddp.c */
 375 int t4_init_ppod_region(struct ppod_region *, struct t4_range *, u_int,
 376     const char *);
 377 void t4_free_ppod_region(struct ppod_region *);
 378 int t4_alloc_page_pods_for_ps(struct ppod_region *, struct pageset *);
 379 int t4_alloc_page_pods_for_buf(struct ppod_region *, vm_offset_t, int,
 380     struct ppod_reservation *);
 381 int t4_write_page_pods_for_ps(struct adapter *, struct sge_wrq *, int,
 382     struct pageset *);
 383 int t4_write_page_pods_for_buf(struct adapter *, struct sge_wrq *, int tid,
 384     struct ppod_reservation *, vm_offset_t, int);
 385 void t4_free_page_pods(struct ppod_reservation *);
 386 int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *,
 387     struct mbuf **, struct mbuf **, int *);
 388 int t4_aio_queue_ddp(struct socket *, struct kaiocb *);
 389 int t4_ddp_mod_load(void);
 390 void t4_ddp_mod_unload(void);
 391 void ddp_assert_empty(struct toepcb *);
 392 void ddp_init_toep(struct toepcb *);
 393 void ddp_uninit_toep(struct toepcb *);
 394 void ddp_queue_toep(struct toepcb *);
 395 void release_ddp_resources(struct toepcb *toep);
 396 void handle_ddp_close(struct toepcb *, struct tcpcb *, uint32_t);
 397 void handle_ddp_indicate(struct toepcb *);
 398 void handle_ddp_tcb_rpl(struct toepcb *, const struct cpl_set_tcb_rpl *);
 399 void insert_ddp_data(struct toepcb *, uint32_t);
 400
 401 #endif