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 /*
  36  * Inline version of mbufq for use on 10.x.  Borrowed from
  37  * sys/cam/ctl/ctl_ha.c.
  38  */
  39 struct mbufq {
  40         struct mbuf *head;
  41         struct mbuf *tail;
  42 };
  43
  44 #define LISTEN_HASH_SIZE 32
  45
  46 /*
  47  * Min receive window.  We want it to be large enough to accommodate receive
  48  * coalescing, handle jumbo frames, and not trigger sender SWS avoidance.
  49  */
  50 #define MIN_RCV_WND (24 * 1024U)
  51
  52 /*
  53  * Max receive window supported by HW in bytes.  Only a small part of it can
  54  * be set through option0, the rest needs to be set through RX_DATA_ACK.
  55  */
  56 #define MAX_RCV_WND ((1U << 27) - 1)
  57
  58 #define DDP_RSVD_WIN (16 * 1024U)
  59 #define SB_DDP_INDICATE SB_IN_TOE       /* soreceive must respond to indicate */
  60
  61 #define USE_DDP_RX_FLOW_CONTROL
  62
  63 /* TOE PCB flags */
  64 enum {
  65         TPF_ATTACHED       = (1 << 0),  /* a tcpcb refers to this toepcb */
  66         TPF_FLOWC_WR_SENT  = (1 << 1),  /* firmware flow context WR sent */
  67         TPF_TX_DATA_SENT   = (1 << 2),  /* some data sent */
  68         TPF_TX_SUSPENDED   = (1 << 3),  /* tx suspended for lack of resources */
  69         TPF_SEND_FIN       = (1 << 4),  /* send FIN after all pending data */
  70         TPF_FIN_SENT       = (1 << 5),  /* FIN has been sent */
  71         TPF_ABORT_SHUTDOWN = (1 << 6),  /* connection abort is in progress */
  72         TPF_CPL_PENDING    = (1 << 7),  /* haven't received the last CPL */
  73         TPF_SYNQE          = (1 << 8),  /* synq_entry, not really a toepcb */
  74         TPF_SYNQE_NEEDFREE = (1 << 9),  /* synq_entry was malloc'd separately */
  75         TPF_SYNQE_TCPDDP   = (1 << 10), /* ulp_mode TCPDDP in toepcb */
  76         TPF_SYNQE_EXPANDED = (1 << 11), /* toepcb ready, tid context updated */
  77         TPF_SYNQE_HAS_L2TE = (1 << 12), /* we've replied to PASS_ACCEPT_REQ */
  78 };
  79
  80 enum {
  81         DDP_OK          = (1 << 0),     /* OK to turn on DDP */
  82         DDP_SC_REQ      = (1 << 1),     /* state change (on/off) requested */
  83         DDP_ON          = (1 << 2),     /* DDP is turned on */
  84         DDP_BUF0_ACTIVE = (1 << 3),     /* buffer 0 in use (not invalidated) */
  85         DDP_BUF1_ACTIVE = (1 << 4),     /* buffer 1 in use (not invalidated) */
  86 };
  87
  88 struct ofld_tx_sdesc {
  89         uint32_t plen;          /* payload length */
  90         uint8_t tx_credits;     /* firmware tx credits (unit is 16B) */
  91 };
  92
  93 struct ddp_buffer {
  94         uint32_t tag;   /* includes color, page pod addr, and DDP page size */
  95         u_int ppod_addr;
  96         int nppods;
  97         int offset;
  98         int len;
  99         int npages;
 100         vm_page_t *pages;
 101 };
 102
 103 struct toepcb {
 104         TAILQ_ENTRY(toepcb) link; /* toep_list */
 105         u_int flags;            /* miscellaneous flags */
 106         struct tom_data *td;
 107         struct inpcb *inp;      /* backpointer to host stack's PCB */
 108         struct vi_info *vi;     /* virtual interface */
 109         struct sge_wrq *ofld_txq;
 110         struct sge_ofld_rxq *ofld_rxq;
 111         struct sge_wrq *ctrlq;
 112         struct l2t_entry *l2te; /* L2 table entry used by this connection */
 113         struct clip_entry *ce;  /* CLIP table entry used by this tid */
 114         int tid;                /* Connection identifier */
 115
 116         /* tx credit handling */
 117         u_int tx_total;         /* total tx WR credits (in 16B units) */
 118         u_int tx_credits;       /* tx WR credits (in 16B units) available */
 119         u_int tx_nocompl;       /* tx WR credits since last compl request */
 120         u_int plen_nocompl;     /* payload since last compl request */
 121
 122         /* rx credit handling */
 123         u_int sb_cc;            /* last noted value of so_rcv->sb_cc */
 124         int rx_credits;         /* rx credits (in bytes) to be returned to hw */
 125
 126         u_int ulp_mode; /* ULP mode */
 127         void *ulpcb;
 128         void *ulpcb2;
 129         struct mbufq ulp_pduq;  /* PDUs waiting to be sent out. */
 130         struct mbufq ulp_pdu_reclaimq;
 131
 132         u_int ddp_flags;
 133         struct ddp_buffer *db[2];
 134         time_t ddp_disabled;
 135         uint8_t ddp_score;
 136
 137         /* Tx software descriptor */
 138         uint8_t txsd_total;
 139         uint8_t txsd_pidx;
 140         uint8_t txsd_cidx;
 141         uint8_t txsd_avail;
 142         struct ofld_tx_sdesc txsd[];
 143 };
 144
 145 struct flowc_tx_params {
 146         uint32_t snd_nxt;
 147         uint32_t rcv_nxt;
 148         unsigned int snd_space;
 149         unsigned int mss;
 150 };
 151
 152 #define DDP_RETRY_WAIT  5       /* seconds to wait before re-enabling DDP */
 153 #define DDP_LOW_SCORE   1
 154 #define DDP_HIGH_SCORE  3
 155
 156 /*
 157  * Compressed state for embryonic connections for a listener.  Barely fits in
 158  * 64B, try not to grow it further.
 159  */
 160 struct synq_entry {
 161         TAILQ_ENTRY(synq_entry) link;   /* listen_ctx's synq link */
 162         int flags;                      /* same as toepcb's tp_flags */
 163         int tid;
 164         struct listen_ctx *lctx;        /* backpointer to listen ctx */
 165         struct mbuf *syn;
 166         uint32_t iss;
 167         uint32_t ts;
 168         volatile uintptr_t wr;
 169         volatile u_int refcnt;
 170         uint16_t l2e_idx;
 171         uint16_t rcv_bufsize;
 172 };
 173
 174 /* listen_ctx flags */
 175 #define LCTX_RPL_PENDING 1      /* waiting for a CPL_PASS_OPEN_RPL */
 176
 177 struct listen_ctx {
 178         LIST_ENTRY(listen_ctx) link;    /* listen hash linkage */
 179         volatile int refcount;
 180         int stid;
 181         struct stid_region stid_region;
 182         int flags;
 183         struct inpcb *inp;              /* listening socket's inp */
 184         struct sge_wrq *ctrlq;
 185         struct sge_ofld_rxq *ofld_rxq;
 186         struct clip_entry *ce;
 187         TAILQ_HEAD(, synq_entry) synq;
 188 };
 189
 190 struct clip_entry {
 191         TAILQ_ENTRY(clip_entry) link;
 192         struct in6_addr lip;    /* local IPv6 address */
 193         u_int refcount;
 194 };
 195
 196 TAILQ_HEAD(clip_head, clip_entry);
 197 struct tom_data {
 198         struct toedev tod;
 199
 200         /* toepcb's associated with this TOE device */
 201         struct mtx toep_list_lock;
 202         TAILQ_HEAD(, toepcb) toep_list;
 203
 204         struct mtx lctx_hash_lock;
 205         LIST_HEAD(, listen_ctx) *listen_hash;
 206         u_long listen_mask;
 207         int lctx_count;         /* # of lctx in the hash table */
 208
 209         u_int ppod_start;
 210         vmem_t *ppod_arena;
 211
 212         struct mtx clip_table_lock;
 213         struct clip_head clip_table;
 214         int clip_gen;
 215
 216         /* WRs that will not be sent to the chip because L2 resolution failed */
 217         struct mtx unsent_wr_lock;
 218         STAILQ_HEAD(, wrqe) unsent_wr_list;
 219         struct task reclaim_wr_resources;
 220 };
 221
 222 static inline struct tom_data *
 223 tod_td(struct toedev *tod)
 224 {
 225
 226         return (__containerof(tod, struct tom_data, tod));
 227 }
 228
 229 static inline struct adapter *
 230 td_adapter(struct tom_data *td)
 231 {
 232
 233         return (td->tod.tod_softc);
 234 }
 235
 236 /*
 237  * XXX: Don't define these for the iWARP driver on 10 due to differences
 238  * in LinuxKPI.
 239  */
 240 #ifndef _LINUX_TYPES_H_
 241 static inline void
 242 set_mbuf_ulp_submode(struct mbuf *m, uint8_t ulp_submode)
 243 {
 244
 245         M_ASSERTPKTHDR(m);
 246         m->m_pkthdr.PH_per.eigth[0] = ulp_submode;
 247 }
 248
 249 static inline uint8_t
 250 mbuf_ulp_submode(struct mbuf *m)
 251 {
 252
 253         M_ASSERTPKTHDR(m);
 254         return (m->m_pkthdr.PH_per.eigth[0]);
 255 }
 256 #endif
 257
 258 /* t4_tom.c */
 259 struct toepcb *alloc_toepcb(struct vi_info *, int, int, int);
 260 void free_toepcb(struct toepcb *);
 261 void offload_socket(struct socket *, struct toepcb *);
 262 void undo_offload_socket(struct socket *);
 263 void final_cpl_received(struct toepcb *);
 264 void insert_tid(struct adapter *, int, void *);
 265 void *lookup_tid(struct adapter *, int);
 266 void update_tid(struct adapter *, int, void *);
 267 void remove_tid(struct adapter *, int);
 268 void release_tid(struct adapter *, int, struct sge_wrq *);
 269 int find_best_mtu_idx(struct adapter *, struct in_conninfo *, int);
 270 u_long select_rcv_wnd(struct socket *);
 271 int select_rcv_wscale(void);
 272 uint64_t calc_opt0(struct socket *, struct vi_info *, struct l2t_entry *,
 273     int, int, int, int);
 274 uint64_t select_ntuple(struct vi_info *, struct l2t_entry *);
 275 void set_tcpddp_ulp_mode(struct toepcb *);
 276 int negative_advice(int);
 277 struct clip_entry *hold_lip(struct tom_data *, struct in6_addr *);
 278 void release_lip(struct tom_data *, struct clip_entry *);
 279
 280 /* t4_connect.c */
 281 void t4_init_connect_cpl_handlers(void);
 282 int t4_connect(struct toedev *, struct socket *, struct rtentry *,
 283     struct sockaddr *);
 284 void act_open_failure_cleanup(struct adapter *, u_int, u_int);
 285
 286 /* t4_listen.c */
 287 void t4_init_listen_cpl_handlers(void);
 288 int t4_listen_start(struct toedev *, struct tcpcb *);
 289 int t4_listen_stop(struct toedev *, struct tcpcb *);
 290 void t4_syncache_added(struct toedev *, void *);
 291 void t4_syncache_removed(struct toedev *, void *);
 292 int t4_syncache_respond(struct toedev *, void *, struct mbuf *);
 293 int do_abort_req_synqe(struct sge_iq *, const struct rss_header *,
 294     struct mbuf *);
 295 int do_abort_rpl_synqe(struct sge_iq *, const struct rss_header *,
 296     struct mbuf *);
 297 void t4_offload_socket(struct toedev *, void *, struct socket *);
 298
 299 /* t4_cpl_io.c */
 300 void t4_init_cpl_io_handlers(void);
 301 void t4_uninit_cpl_io_handlers(void);
 302 void send_abort_rpl(struct adapter *, struct sge_wrq *, int , int);
 303 void send_flowc_wr(struct toepcb *, struct flowc_tx_params *);
 304 void send_reset(struct adapter *, struct toepcb *, uint32_t);
 305 void make_established(struct toepcb *, uint32_t, uint32_t, uint16_t);
 306 void t4_rcvd(struct toedev *, struct tcpcb *);
 307 int t4_tod_output(struct toedev *, struct tcpcb *);
 308 int t4_send_fin(struct toedev *, struct tcpcb *);
 309 int t4_send_rst(struct toedev *, struct tcpcb *);
 310 void t4_set_tcb_field(struct adapter *, struct sge_wrq *, int, uint16_t,
 311     uint64_t, uint64_t, int, int, int);
 312 void t4_push_frames(struct adapter *sc, struct toepcb *toep, int drop);
 313 void t4_push_pdus(struct adapter *sc, struct toepcb *toep, int drop);
 314 int do_set_tcb_rpl(struct sge_iq *, const struct rss_header *, struct mbuf *);
 315
 316 /* t4_ddp.c */
 317 void t4_init_ddp(struct adapter *, struct tom_data *);
 318 void t4_uninit_ddp(struct adapter *, struct tom_data *);
 319 int t4_soreceive_ddp(struct socket *, struct sockaddr **, struct uio *,
 320     struct mbuf **, struct mbuf **, int *);
 321 int t4_ddp_mod_load(void);
 322 void t4_ddp_mod_unload(void);
 323 void enable_ddp(struct adapter *, struct toepcb *toep);
 324 void release_ddp_resources(struct toepcb *toep);
 325 void handle_ddp_close(struct toepcb *, struct tcpcb *, struct sockbuf *,
 326     uint32_t);
 327 void insert_ddp_data(struct toepcb *, uint32_t);
 328
 329 #endif