1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _VNET_GEN_H 28 #define _VNET_GEN_H 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 #include <sys/vgen_stats.h> 35 36 #define VGEN_SUCCESS (0) /* successful return */ 37 #define VGEN_FAILURE (-1) /* unsuccessful return */ 38 39 #define VGEN_NUM_VER 1 /* max # of vgen versions */ 40 41 #define VGEN_LOCAL 1 /* local ldc end-point */ 42 #define VGEN_PEER 2 /* peer ldc end-point */ 43 44 /* vgen_t flags */ 45 #define VGEN_STOPPED 0x0 46 #define VGEN_STARTED 0x1 47 48 #define KMEM_FREE(_p) kmem_free((_p), sizeof (*(_p))) 49 50 #define VGEN_INIT_MCTAB_SIZE 16 /* initial size of multicast table */ 51 52 #define READ_ENTER(x) rw_enter(x, RW_READER) 53 #define WRITE_ENTER(x) rw_enter(x, RW_WRITER) 54 #define RW_EXIT(x) rw_exit(x) 55 56 /* channel flags */ 57 #define CHANNEL_ATTACHED 0x1 58 #define CHANNEL_STARTED 0x2 59 60 /* transmit return values */ 61 #define VGEN_TX_SUCCESS 0 /* transmit success */ 62 #define VGEN_TX_FAILURE 1 /* transmit failure */ 63 #define VGEN_TX_NORESOURCES 2 /* out of tbufs/txds */ 64 65 /* private descriptor flags */ 66 #define VGEN_PRIV_DESC_FREE 0x0 /* desc is available */ 67 #define VGEN_PRIV_DESC_BUSY 0x1 /* desc in use */ 68 69 #define LDC_TO_VNET(ldcp) ((ldcp)->portp->vgenp->vnetp) 70 #define LDC_TO_VGEN(ldcp) ((ldcp)->portp->vgenp) 71 72 /* receive thread flags */ 73 #define VGEN_WTHR_RUNNING 0x01 /* worker thread running */ 74 #define VGEN_WTHR_DATARCVD 0x02 /* data received */ 75 #define VGEN_WTHR_STOP 0x04 /* stop worker thread request */ 76 #define VGEN_WTHR_PROCESSING 0x08 /* worker thread awake & processing */ 77 78 #define VGEN_LDC_UP_DELAY 100 /* usec delay between ldc_up retries */ 79 #define VGEN_LDC_CLOSE_DELAY 100 /* usec delay between ldc_cl retries */ 80 81 #define VGEN_NUM_VMPOOLS 3 /* number of vio mblk pools */ 82 83 #define VGEN_DBLK_SZ_128 128 /* data buffer size 128 bytes */ 84 #define VGEN_DBLK_SZ_256 256 /* data buffer size 256 bytes */ 85 #define VGEN_DBLK_SZ_2048 2048 /* data buffer size 2K bytes */ 86 #define VGEN_NRBUFS 512 /* number of receive bufs */ 87 88 #define VGEN_TXDBLK_SZ 2048 /* Tx data buffer size */ 89 90 /* get the address of next tbuf */ 91 #define NEXTTBUF(ldcp, tbufp) (((tbufp) + 1) == (ldcp)->tbufendp \ 92 ? (ldcp)->tbufp : ((tbufp) + 1)) 93 94 /* increment recv index */ 95 #define INCR_RXI(i, ldcp) \ 96 ((i) = (((i) + 1) & ((ldcp)->num_rxds - 1))) 97 98 /* decrement recv index */ 99 #define DECR_RXI(i, ldcp) \ 100 ((i) = (((i) - 1) & ((ldcp)->num_rxds - 1))) 101 102 /* increment tx index */ 103 #define INCR_TXI(i, ldcp) \ 104 ((i) = (((i) + 1) & ((ldcp)->num_txds - 1))) 105 106 /* decrement tx index */ 107 #define DECR_TXI(i, ldcp) \ 108 ((i) = (((i) - 1) & ((ldcp)->num_txds - 1))) 109 110 /* bounds check rx index */ 111 #define CHECK_RXI(i, ldcp) \ 112 (((i) >= 0) && ((i) < (ldcp)->num_rxds)) 113 114 /* bounds check tx index */ 115 #define CHECK_TXI(i, ldcp) \ 116 (((i) >= 0) && ((i) < (ldcp)->num_txds)) 117 118 /* private descriptor */ 119 typedef struct vgen_priv_desc { 120 uint64_t flags; /* flag bits */ 121 vnet_public_desc_t *descp; /* associated public desc */ 122 ldc_mem_handle_t memhandle; /* mem handle for data */ 123 caddr_t datap; /* prealloc'd tx data buffer */ 124 uint64_t datalen; /* total actual datalen */ 125 uint64_t ncookies; /* num ldc_mem_cookies */ 126 ldc_mem_cookie_t memcookie[MAX_COOKIES]; /* data cookies */ 127 } vgen_private_desc_t; 128 129 /* 130 * Handshake parameters (per vio_mailbox.h) of each ldc end point, used 131 * during handshake negotiation. 132 */ 133 typedef struct vgen_handshake_params { 134 /* version specific params */ 135 uint16_t ver_major; /* major version number */ 136 uint16_t ver_minor; /* minor version number */ 137 uint8_t dev_class; /* device class */ 138 139 /* attributes specific params */ 140 uint64_t mtu; /* max transfer unit size */ 141 uint64_t addr; /* address of the device */ 142 uint8_t addr_type; /* type of address */ 143 uint8_t xfer_mode; /* SHM or PKT */ 144 uint16_t ack_freq; /* dring data ack freq */ 145 146 /* descriptor ring params */ 147 uint32_t num_desc; /* # of descriptors in ring */ 148 uint32_t desc_size; /* size of descriptor */ 149 ldc_mem_cookie_t dring_cookie; /* desc ring cookie */ 150 uint32_t num_dcookies; /* # of dring cookies */ 151 uint64_t dring_ident; /* ident=0 for INFO msg */ 152 boolean_t dring_ready; /* dring ready flag */ 153 } vgen_hparams_t; 154 155 /* version info */ 156 typedef struct vgen_ver { 157 uint16_t ver_major; /* major version number */ 158 uint16_t ver_minor; /* minor version number */ 159 } vgen_ver_t; 160 161 /* 162 * vnet-protocol-version dependent function prototypes. 163 */ 164 typedef int (*vgen_ldctx_t) (void *, mblk_t *); 165 typedef void (*vgen_ldcrx_pktdata_t) (void *, void *, uint32_t); 166 167 /* Channel information associated with a vgen-port */ 168 typedef struct vgen_ldc { 169 170 struct vgen_ldc *nextp; /* next ldc in the list */ 171 struct vgen_port *portp; /* associated port */ 172 173 /* 174 * Locks: 175 * locking hierarchy when more than one lock is held concurrently: 176 * cblock > rxlock > txlock > tclock. 177 */ 178 kmutex_t cblock; /* sync callback processing */ 179 kmutex_t txlock; /* protect txd alloc */ 180 kmutex_t tclock; /* tx reclaim lock */ 181 kmutex_t wrlock; /* sync transmits */ 182 kmutex_t rxlock; /* sync reception */ 183 184 /* channel info from ldc layer */ 185 uint64_t ldc_id; /* channel number */ 186 uint64_t ldc_handle; /* channel handle */ 187 ldc_status_t ldc_status; /* channel status */ 188 189 /* handshake info */ 190 vgen_ver_t vgen_versions[VGEN_NUM_VER]; /* versions */ 191 int hphase; /* handshake phase */ 192 int hstate; /* handshake state bits */ 193 uint32_t local_sid; /* local session id */ 194 uint32_t peer_sid; /* session id of peer */ 195 vgen_hparams_t local_hparams; /* local handshake params */ 196 vgen_hparams_t peer_hparams; /* peer's handshake params */ 197 timeout_id_t htid; /* handshake wd timeout id */ 198 timeout_id_t cancel_htid; /* cancel handshake watchdog */ 199 200 /* transmit and receive descriptor ring info */ 201 ldc_dring_handle_t tx_dhandle; /* tx descriptor ring handle */ 202 ldc_mem_cookie_t tx_dcookie; /* tx descriptor ring cookie */ 203 ldc_dring_handle_t rx_dhandle; /* mapped rx dhandle */ 204 ldc_mem_cookie_t rx_dcookie; /* rx descriptor ring cookie */ 205 vnet_public_desc_t *txdp; /* transmit frame descriptors */ 206 vnet_public_desc_t *txdendp; /* txd ring end */ 207 vgen_private_desc_t *tbufp; /* associated tx resources */ 208 vgen_private_desc_t *tbufendp; /* tbuf ring end */ 209 vgen_private_desc_t *next_tbufp; /* next free tbuf */ 210 vgen_private_desc_t *cur_tbufp; /* next reclaim tbuf */ 211 uint64_t next_txseq; /* next tx sequence number */ 212 uint32_t num_txdcookies; /* # of tx dring cookies */ 213 uint32_t num_rxdcookies; /* # of rx dring cookies */ 214 uint8_t dring_mtype; /* dring mem map type */ 215 uint32_t next_txi; /* next tx descriptor index */ 216 uint32_t num_txds; /* number of tx descriptors */ 217 clock_t reclaim_lbolt; /* time of last tx reclaim */ 218 timeout_id_t wd_tid; /* tx watchdog timeout id */ 219 vnet_public_desc_t *rxdp; /* receive frame descriptors */ 220 uint64_t next_rxseq; /* next expected recv seqnum */ 221 uint32_t next_rxi; /* next expected recv index */ 222 uint32_t num_rxds; /* number of rx descriptors */ 223 caddr_t tx_datap; /* prealloc'd tx data area */ 224 size_t tx_data_sz; /* alloc'd size of tx databuf */ 225 vio_multi_pool_t vmp; /* rx mblk pools */ 226 uint32_t max_rxpool_size; /* max size of rxpool in use */ 227 uint64_t *ldcmsg; /* msg buffer for ldc_read() */ 228 uint64_t msglen; /* size of ldcmsg */ 229 230 /* misc */ 231 uint32_t flags; /* flags */ 232 boolean_t need_resched; /* reschedule tx */ 233 boolean_t need_ldc_reset; /* ldc_reset needed */ 234 uint32_t hretries; /* handshake retry count */ 235 boolean_t resched_peer; /* send tx msg to peer */ 236 uint32_t resched_peer_txi; /* tx index to resched peer */ 237 238 vgen_ldctx_t tx; /* transmit function */ 239 vgen_ldcrx_pktdata_t rx_pktdata; /* process rx raw data msg */ 240 241 /* receive thread field */ 242 kthread_t *rcv_thread; /* receive thread */ 243 uint32_t rcv_thr_flags; /* receive thread flags */ 244 kmutex_t rcv_thr_lock; /* lock for receive thread */ 245 kcondvar_t rcv_thr_cv; /* cond.var for recv thread */ 246 247 /* channel statistics */ 248 vgen_stats_t stats; /* channel statistics */ 249 kstat_t *ksp; /* channel kstats */ 250 251 } vgen_ldc_t; 252 253 /* Channel list structure */ 254 typedef struct vgen_ldclist_s { 255 vgen_ldc_t *headp; /* head of the list */ 256 krwlock_t rwlock; /* sync access to the list */ 257 } vgen_ldclist_t; 258 259 /* port information structure */ 260 typedef struct vgen_port { 261 struct vgen_port *nextp; /* next port in the list */ 262 struct vgen *vgenp; /* associated vgen_t */ 263 int port_num; /* port number */ 264 int num_ldcs; /* # of channels in this port */ 265 uint64_t *ldc_ids; /* channel ids */ 266 vgen_ldclist_t ldclist; /* list of ldcs for this port */ 267 ether_addr_t macaddr; /* mac address of peer */ 268 uint16_t pvid; /* port vlan id (untagged) */ 269 uint16_t *vids; /* vlan ids (tagged) */ 270 uint16_t nvids; /* # of vids */ 271 mod_hash_t *vlan_hashp; /* vlan hash table */ 272 uint32_t vlan_nchains; /* # of vlan hash chains */ 273 uint32_t use_vsw_port; /* Use vsw_port or not */ 274 uint32_t flags; /* status of this port */ 275 vio_net_callbacks_t vcb; /* vnet callbacks */ 276 vio_net_handle_t vhp; /* handle from vnet */ 277 kmutex_t lock; /* synchornize ops */ 278 } vgen_port_t; 279 280 /* port list structure */ 281 typedef struct vgen_portlist { 282 vgen_port_t *headp; /* head of ports */ 283 vgen_port_t *tailp; /* tail */ 284 krwlock_t rwlock; /* sync access to the port list */ 285 } vgen_portlist_t; 286 287 /* vgen instance information */ 288 typedef struct vgen { 289 vnet_t *vnetp; /* associated vnet instance */ 290 int instance; /* vnet instance */ 291 dev_info_t *vnetdip; /* dip of vnet */ 292 uint64_t regprop; /* "reg" property */ 293 ether_addr_t macaddr; /* mac addr of vnet */ 294 kmutex_t lock; /* synchornize ops */ 295 int flags; /* flags */ 296 vgen_portlist_t vgenports; /* Port List */ 297 mdeg_node_spec_t *mdeg_parentp; 298 mdeg_handle_t mdeg_dev_hdl; /* mdeg cb handle for device */ 299 mdeg_handle_t mdeg_port_hdl; /* mdeg cb handle for port */ 300 vgen_port_t *vsw_portp; /* port connected to vsw */ 301 struct ether_addr *mctab; /* multicast addr table */ 302 uint32_t mcsize; /* allocated size of mctab */ 303 uint32_t mccount; /* # of valid addrs in mctab */ 304 vio_mblk_pool_t *rmp; /* rx mblk pools to be freed */ 305 uint32_t pri_num_types; /* # of priority eth types */ 306 uint16_t *pri_types; /* priority eth types */ 307 vio_mblk_pool_t *pri_tx_vmp; /* tx priority mblk pool */ 308 uint32_t max_frame_size; /* max frame size supported */ 309 310 uint32_t vsw_port_refcnt; /* refcnt for vsw_port */ 311 } vgen_t; 312 313 #ifdef __cplusplus 314 } 315 #endif 316 317 #endif /* _VNET_GEN_H */ 318