sys/dev/cxgbe/tom/t4_tom.h

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