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 2008 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 77 #define VGEN_LDC_UP_DELAY 100 /* usec delay between ldc_up retries */ 78 79 #define VGEN_NUM_VMPOOLS 3 /* number of vio mblk pools */ 80 81 #define VGEN_DBLK_SZ_128 128 /* data buffer size 128 bytes */ 82 #define VGEN_DBLK_SZ_256 256 /* data buffer size 256 bytes */ 83 #define VGEN_DBLK_SZ_2048 2048 /* data buffer size 2K bytes */ 84 #define VGEN_NRBUFS 512 /* number of receive bufs */ 85 86 #define VGEN_TXDBLK_SZ 2048 /* Tx data buffer size */ 87 88 /* get the address of next tbuf */ 89 #define NEXTTBUF(ldcp, tbufp) (((tbufp) + 1) == (ldcp)->tbufendp \ 90 ? (ldcp)->tbufp : ((tbufp) + 1)) 91 92 /* increment recv index */ 93 #define INCR_RXI(i, ldcp) \ 94 ((i) = (((i) + 1) & ((ldcp)->num_rxds - 1))) 95 96 /* decrement recv index */ 97 #define DECR_RXI(i, ldcp) \ 98 ((i) = (((i) - 1) & ((ldcp)->num_rxds - 1))) 99 100 /* increment tx index */ 101 #define INCR_TXI(i, ldcp) \ 102 ((i) = (((i) + 1) & ((ldcp)->num_txds - 1))) 103 104 /* decrement tx index */ 105 #define DECR_TXI(i, ldcp) \ 106 ((i) = (((i) - 1) & ((ldcp)->num_txds - 1))) 107 108 /* bounds check rx index */ 109 #define CHECK_RXI(i, ldcp) \ 110 (((i) >= 0) && ((i) < (ldcp)->num_rxds)) 111 112 /* bounds check tx index */ 113 #define CHECK_TXI(i, ldcp) \ 114 (((i) >= 0) && ((i) < (ldcp)->num_txds)) 115 116 /* private descriptor */ 117 typedef struct vgen_priv_desc { 118 uint64_t flags; /* flag bits */ 119 vnet_public_desc_t *descp; /* associated public desc */ 120 ldc_mem_handle_t memhandle; /* mem handle for data */ 121 caddr_t datap; /* prealloc'd tx data buffer */ 122 uint64_t datalen; /* total actual datalen */ 123 uint64_t ncookies; /* num ldc_mem_cookies */ 124 ldc_mem_cookie_t memcookie[MAX_COOKIES]; /* data cookies */ 125 } vgen_private_desc_t; 126 127 /* 128 * Handshake parameters (per vio_mailbox.h) of each ldc end point, used 129 * during handshake negotiation. 130 */ 131 typedef struct vgen_handshake_params { 132 /* version specific params */ 133 uint16_t ver_major; /* major version number */ 134 uint16_t ver_minor; /* minor version number */ 135 uint8_t dev_class; /* device class */ 136 137 /* attributes specific params */ 138 uint64_t mtu; /* max transfer unit size */ 139 uint64_t addr; /* address of the device */ 140 uint8_t addr_type; /* type of address */ 141 uint8_t xfer_mode; /* SHM or PKT */ 142 uint16_t ack_freq; /* dring data ack freq */ 143 144 /* descriptor ring params */ 145 uint32_t num_desc; /* # of descriptors in ring */ 146 uint32_t desc_size; /* size of descriptor */ 147 ldc_mem_cookie_t dring_cookie; /* desc ring cookie */ 148 uint32_t num_dcookies; /* # of dring cookies */ 149 uint64_t dring_ident; /* ident=0 for INFO msg */ 150 boolean_t dring_ready; /* dring ready flag */ 151 } vgen_hparams_t; 152 153 /* version info */ 154 typedef struct vgen_ver { 155 uint16_t ver_major; /* major version number */ 156 uint16_t ver_minor; /* minor version number */ 157 } vgen_ver_t; 158 159 /* 160 * vnet-protocol-version dependent function prototypes. 161 */ 162 typedef int (*vgen_ldctx_t) (void *, mblk_t *); 163 typedef void (*vgen_ldcrx_pktdata_t) (void *, void *, uint32_t); 164 165 /* Channel information associated with a vgen-port */ 166 typedef struct vgen_ldc { 167 168 struct vgen_ldc *nextp; /* next ldc in the list */ 169 struct vgen_port *portp; /* associated port */ 170 171 /* 172 * Locks: 173 * locking hierarchy when more than one lock is held concurrently: 174 * cblock > rxlock > txlock > tclock. 175 */ 176 kmutex_t cblock; /* sync callback processing */ 177 kmutex_t txlock; /* protect txd alloc */ 178 kmutex_t tclock; /* tx reclaim lock */ 179 kmutex_t wrlock; /* sync transmits */ 180 kmutex_t rxlock; /* sync reception */ 181 182 /* channel info from ldc layer */ 183 uint64_t ldc_id; /* channel number */ 184 uint64_t ldc_handle; /* channel handle */ 185 ldc_status_t ldc_status; /* channel status */ 186 187 /* handshake info */ 188 vgen_ver_t vgen_versions[VGEN_NUM_VER]; /* versions */ 189 int hphase; /* handshake phase */ 190 int hstate; /* handshake state bits */ 191 uint32_t local_sid; /* local session id */ 192 uint32_t peer_sid; /* session id of peer */ 193 vgen_hparams_t local_hparams; /* local handshake params */ 194 vgen_hparams_t peer_hparams; /* peer's handshake params */ 195 timeout_id_t htid; /* handshake wd timeout id */ 196 timeout_id_t cancel_htid; /* cancel handshake watchdog */ 197 198 /* transmit and receive descriptor ring info */ 199 ldc_dring_handle_t tx_dhandle; /* tx descriptor ring handle */ 200 ldc_mem_cookie_t tx_dcookie; /* tx descriptor ring cookie */ 201 ldc_dring_handle_t rx_dhandle; /* mapped rx dhandle */ 202 ldc_mem_cookie_t rx_dcookie; /* rx descriptor ring cookie */ 203 vnet_public_desc_t *txdp; /* transmit frame descriptors */ 204 vnet_public_desc_t *txdendp; /* txd ring end */ 205 vgen_private_desc_t *tbufp; /* associated tx resources */ 206 vgen_private_desc_t *tbufendp; /* tbuf ring end */ 207 vgen_private_desc_t *next_tbufp; /* next free tbuf */ 208 vgen_private_desc_t *cur_tbufp; /* next reclaim tbuf */ 209 uint64_t next_txseq; /* next tx sequence number */ 210 uint32_t num_txdcookies; /* # of tx dring cookies */ 211 uint32_t num_rxdcookies; /* # of rx dring cookies */ 212 uint8_t dring_mtype; /* dring mem map type */ 213 uint32_t next_txi; /* next tx descriptor index */ 214 uint32_t num_txds; /* number of tx descriptors */ 215 clock_t reclaim_lbolt; /* time of last tx reclaim */ 216 timeout_id_t wd_tid; /* tx watchdog timeout id */ 217 vnet_public_desc_t *rxdp; /* receive frame descriptors */ 218 uint64_t next_rxseq; /* next expected recv seqnum */ 219 uint32_t next_rxi; /* next expected recv index */ 220 uint32_t num_rxds; /* number of rx descriptors */ 221 caddr_t tx_datap; /* prealloc'd tx data area */ 222 size_t tx_data_sz; /* alloc'd size of tx databuf */ 223 vio_multi_pool_t vmp; /* rx mblk pools */ 224 uint32_t max_rxpool_size; /* max size of rxpool in use */ 225 uint64_t *ldcmsg; /* msg buffer for ldc_read() */ 226 uint64_t msglen; /* size of ldcmsg */ 227 228 /* misc */ 229 uint32_t flags; /* flags */ 230 boolean_t need_resched; /* reschedule tx */ 231 boolean_t need_ldc_reset; /* ldc_reset needed */ 232 uint32_t hretries; /* handshake retry count */ 233 boolean_t resched_peer; /* send tx msg to peer */ 234 uint32_t resched_peer_txi; /* tx index to resched peer */ 235 236 vgen_ldctx_t tx; /* transmit function */ 237 vgen_ldcrx_pktdata_t rx_pktdata; /* process rx raw data msg */ 238 239 /* receive thread field */ 240 kthread_t *rcv_thread; /* receive thread */ 241 uint32_t rcv_thr_flags; /* receive thread flags */ 242 kmutex_t rcv_thr_lock; /* lock for receive thread */ 243 kcondvar_t rcv_thr_cv; /* cond.var for recv thread */ 244 245 /* channel statistics */ 246 vgen_stats_t stats; /* channel statistics */ 247 kstat_t *ksp; /* channel kstats */ 248 249 } vgen_ldc_t; 250 251 /* Channel list structure */ 252 typedef struct vgen_ldclist_s { 253 vgen_ldc_t *headp; /* head of the list */ 254 krwlock_t rwlock; /* sync access to the list */ 255 } vgen_ldclist_t; 256 257 /* port information structure */ 258 typedef struct vgen_port { 259 struct vgen_port *nextp; /* next port in the list */ 260 struct vgen *vgenp; /* associated vgen_t */ 261 int port_num; /* port number */ 262 int num_ldcs; /* # of channels in this port */ 263 uint64_t *ldc_ids; /* channel ids */ 264 vgen_ldclist_t ldclist; /* list of ldcs for this port */ 265 ether_addr_t macaddr; /* mac address of peer */ 266 uint16_t pvid; /* port vlan id (untagged) */ 267 uint16_t *vids; /* vlan ids (tagged) */ 268 uint16_t nvids; /* # of vids */ 269 mod_hash_t *vlan_hashp; /* vlan hash table */ 270 uint32_t vlan_nchains; /* # of vlan hash chains */ 271 uint32_t use_vsw_port; /* Use vsw_port or not */ 272 uint32_t flags; /* status of this port */ 273 vio_net_callbacks_t vcb; /* vnet callbacks */ 274 vio_net_handle_t vhp; /* handle from vnet */ 275 kmutex_t lock; /* synchornize ops */ 276 } vgen_port_t; 277 278 /* port list structure */ 279 typedef struct vgen_portlist { 280 vgen_port_t *headp; /* head of ports */ 281 vgen_port_t *tailp; /* tail */ 282 krwlock_t rwlock; /* sync access to the port list */ 283 } vgen_portlist_t; 284 285 /* vgen instance information */ 286 typedef struct vgen { 287 vnet_t *vnetp; /* associated vnet instance */ 288 int instance; /* vnet instance */ 289 dev_info_t *vnetdip; /* dip of vnet */ 290 uint64_t regprop; /* "reg" property */ 291 ether_addr_t macaddr; /* mac addr of vnet */ 292 kmutex_t lock; /* synchornize ops */ 293 int flags; /* flags */ 294 vgen_portlist_t vgenports; /* Port List */ 295 mdeg_node_spec_t *mdeg_parentp; 296 mdeg_handle_t mdeg_dev_hdl; /* mdeg cb handle for device */ 297 mdeg_handle_t mdeg_port_hdl; /* mdeg cb handle for port */ 298 vgen_port_t *vsw_portp; /* port connected to vsw */ 299 struct ether_addr *mctab; /* multicast addr table */ 300 uint32_t mcsize; /* allocated size of mctab */ 301 uint32_t mccount; /* # of valid addrs in mctab */ 302 vio_mblk_pool_t *rmp; /* rx mblk pools to be freed */ 303 uint32_t pri_num_types; /* # of priority eth types */ 304 uint16_t *pri_types; /* priority eth types */ 305 vio_mblk_pool_t *pri_tx_vmp; /* tx priority mblk pool */ 306 uint32_t max_frame_size; /* max frame size supported */ 307 308 uint32_t vsw_port_refcnt; /* refcnt for vsw_port */ 309 } vgen_t; 310 311 #ifdef __cplusplus 312 } 313 #endif 314 315 #endif /* _VNET_GEN_H */ 316