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 2006 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 /* 28 * This header file contains the basic data structures which the 29 * virtual switch (vsw) uses to communicate with its clients and 30 * the outside world. 31 * 32 * The virtual switch reads the machine description (MD) to 33 * determine how many port_t structures to create (each port_t 34 * can support communications to a single network device). The 35 * port_t's are maintained in a linked list. 36 * 37 * Each port in turn contains a number of logical domain channels 38 * (ldc's) which are inter domain communications channels which 39 * are used for passing small messages between the domains. Their 40 * may be an unlimited number of channels associated with each port, 41 * though most devices only use a single channel. 42 * 43 * The ldc is a bi-directional channel, which is divided up into 44 * two directional 'lanes', one outbound from the switch to the 45 * virtual network device, the other inbound to the switch. 46 * Depending on the type of device each lane may have seperate 47 * communication paramaters (such as mtu etc). 48 * 49 * For those network clients which use descriptor rings the 50 * rings are associated with the appropriate lane. I.e. rings 51 * which the switch exports are associated with the outbound lanes 52 * while those which the network clients are exporting to the switch 53 * are associated with the inbound lane. 54 * 55 * In diagram form the data structures look as follows: 56 * 57 * vsw instance 58 * | 59 * +----->port_t----->port_t----->port_t-----> 60 * | 61 * +--->ldc_t--->ldc_t--->ldc_t---> 62 * | 63 * +--->lane_t (inbound) 64 * | | 65 * | +--->dring--->dring---> 66 * | 67 * +--->lane_t (outbound) 68 * | 69 * +--->dring--->dring---> 70 * 71 */ 72 73 #ifndef _VSW_H 74 #define _VSW_H 75 76 #pragma ident "%Z%%M% %I% %E% SMI" 77 78 #ifdef __cplusplus 79 extern "C" { 80 #endif 81 82 #include <sys/vio_mailbox.h> 83 #include <sys/vnet_common.h> 84 #include <sys/ethernet.h> 85 #include <sys/vio_util.h> 86 87 /* 88 * Default message type. 89 */ 90 typedef struct def_msg { 91 uint64_t data[8]; 92 } def_msg_t; 93 94 /* 95 * Currently only support one major/minor pair. 96 */ 97 #define VSW_NUM_VER 1 98 99 typedef struct ver_sup { 100 uint32_t ver_major:16, 101 ver_minor:16; 102 } ver_sup_t; 103 104 /* 105 * Only support ETHER mtu at moment. 106 */ 107 #define VSW_MTU ETHERMAX 108 109 /* 110 * Lane states. 111 */ 112 #define VSW_LANE_INACTIV 0x0 /* No params set for lane */ 113 114 #define VSW_VER_INFO_SENT 0x1 /* Version # sent to peer */ 115 #define VSW_VER_INFO_RECV 0x2 /* Version # recv from peer */ 116 #define VSW_VER_ACK_RECV 0x4 117 #define VSW_VER_ACK_SENT 0x8 118 #define VSW_VER_NACK_RECV 0x10 119 #define VSW_VER_NACK_SENT 0x20 120 121 #define VSW_ATTR_INFO_SENT 0x40 /* Attributes sent to peer */ 122 #define VSW_ATTR_INFO_RECV 0x80 /* Peer attributes received */ 123 #define VSW_ATTR_ACK_SENT 0x100 124 #define VSW_ATTR_ACK_RECV 0x200 125 #define VSW_ATTR_NACK_SENT 0x400 126 #define VSW_ATTR_NACK_RECV 0x800 127 128 #define VSW_DRING_INFO_SENT 0x1000 /* Dring info sent to peer */ 129 #define VSW_DRING_INFO_RECV 0x2000 /* Dring info received */ 130 #define VSW_DRING_ACK_SENT 0x4000 131 #define VSW_DRING_ACK_RECV 0x8000 132 #define VSW_DRING_NACK_SENT 0x10000 133 #define VSW_DRING_NACK_RECV 0x20000 134 135 #define VSW_RDX_INFO_SENT 0x40000 /* RDX sent to peer */ 136 #define VSW_RDX_INFO_RECV 0x80000 /* RDX received from peer */ 137 #define VSW_RDX_ACK_SENT 0x100000 138 #define VSW_RDX_ACK_RECV 0x200000 139 #define VSW_RDX_NACK_SENT 0x400000 140 #define VSW_RDX_NACK_RECV 0x800000 141 142 #define VSW_MCST_INFO_SENT 0x1000000 143 #define VSW_MCST_INFO_RECV 0x2000000 144 #define VSW_MCST_ACK_SENT 0x4000000 145 #define VSW_MCST_ACK_RECV 0x8000000 146 #define VSW_MCST_NACK_SENT 0x10000000 147 #define VSW_MCST_NACK_RECV 0x20000000 148 149 #define VSW_LANE_ACTIVE 0x40000000 /* Lane open to xmit data */ 150 151 /* Handshake milestones */ 152 #define VSW_MILESTONE0 0x1 /* ver info exchanged */ 153 #define VSW_MILESTONE1 0x2 /* attribute exchanged */ 154 #define VSW_MILESTONE2 0x4 /* dring info exchanged */ 155 #define VSW_MILESTONE3 0x8 /* rdx exchanged */ 156 #define VSW_MILESTONE4 0x10 /* handshake complete */ 157 158 /* 159 * Lane direction (relative to ourselves). 160 */ 161 #define INBOUND 0x1 162 #define OUTBOUND 0x2 163 164 /* Peer session id received */ 165 #define VSW_PEER_SESSION 0x1 166 167 /* 168 * Maximum number of consecutive reads of data from channel 169 */ 170 #define VSW_MAX_CHAN_READ 50 171 172 /* 173 * LDC queue length 174 */ 175 #define VSW_LDC_QLEN 1024 176 177 /* 178 * Currently only support one ldc per port. 179 */ 180 #define VSW_PORT_MAX_LDCS 1 /* max # of ldcs per port */ 181 182 /* 183 * Used for port add/deletion. 184 */ 185 #define VSW_PORT_UPDATED 0x1 186 187 #define LDC_TX_SUCCESS 0 /* ldc transmit success */ 188 #define LDC_TX_FAILURE 1 /* ldc transmit failure */ 189 #define LDC_TX_NORESOURCES 2 /* out of descriptors */ 190 191 /* ID of the source of a frame being switched */ 192 #define VSW_PHYSDEV 1 /* physical device associated */ 193 #define VSW_VNETPORT 2 /* port connected to vnet (over ldc) */ 194 #define VSW_LOCALDEV 4 /* vsw configured as an eth interface */ 195 196 /* 197 * Descriptor ring info 198 * 199 * Each descriptor element has a pre-allocated data buffer 200 * associated with it, into which data being transmitted is 201 * copied. By pre-allocating we speed up the copying process. 202 * The buffer is re-used once the peer has indicated that it is 203 * finished with the descriptor. 204 */ 205 #define VSW_RING_NUM_EL 512 /* Num of entries in ring */ 206 #define VSW_RING_EL_DATA_SZ 2048 /* Size of data section (bytes) */ 207 #define VSW_PRIV_SIZE sizeof (vnet_private_desc_t) 208 #define VSW_PUB_SIZE sizeof (vnet_public_desc_t) 209 210 #define VSW_MAX_COOKIES ((ETHERMTU >> MMU_PAGESHIFT) + 2) 211 212 /* 213 * Size and number of mblks to be created in free pool. 214 */ 215 #define VSW_MBLK_SIZE 2048 216 #define VSW_NUM_MBLKS 1024 217 218 /* 219 * Private descriptor 220 */ 221 typedef struct vsw_private_desc { 222 /* 223 * Below lock must be held when accessing the state of 224 * a descriptor on either the private or public sections 225 * of the ring. 226 */ 227 kmutex_t dstate_lock; 228 uint64_t dstate; 229 vnet_public_desc_t *descp; 230 ldc_mem_handle_t memhandle; 231 void *datap; 232 uint64_t datalen; 233 uint64_t ncookies; 234 ldc_mem_cookie_t memcookie[VSW_MAX_COOKIES]; 235 int bound; 236 } vsw_private_desc_t; 237 238 /* 239 * Descriptor ring structure 240 */ 241 typedef struct dring_info { 242 struct dring_info *next; /* next ring in chain */ 243 kmutex_t dlock; 244 uint32_t num_descriptors; 245 uint32_t descriptor_size; 246 uint32_t options; 247 uint32_t ncookies; 248 ldc_mem_cookie_t cookie[1]; 249 250 ldc_dring_handle_t handle; 251 uint64_t ident; /* identifier sent to peer */ 252 uint64_t end_idx; /* last idx processed */ 253 int64_t last_ack_recv; 254 255 kmutex_t restart_lock; 256 boolean_t restart_reqd; /* send restart msg */ 257 258 /* 259 * base address of private and public portions of the 260 * ring (where appropriate), and data block. 261 */ 262 void *pub_addr; /* base of public section */ 263 void *priv_addr; /* base of private section */ 264 void *data_addr; /* base of data section */ 265 size_t data_sz; /* size of data section */ 266 } dring_info_t; 267 268 /* 269 * Each ldc connection is comprised of two lanes, incoming 270 * from a peer, and outgoing to that peer. Each lane shares 271 * common ldc parameters and also has private lane-specific 272 * parameters. 273 */ 274 typedef struct lane { 275 uint64_t lstate; /* Lane state */ 276 uint32_t ver_major:16, /* Version major number */ 277 ver_minor:16; /* Version minor number */ 278 kmutex_t seq_lock; 279 uint64_t seq_num; /* Sequence number */ 280 uint64_t mtu; /* ETHERMTU */ 281 uint64_t addr; /* Unique physical address */ 282 uint8_t addr_type; /* Only MAC address at moment */ 283 uint8_t xfer_mode; /* Dring or Pkt based */ 284 uint8_t ack_freq; /* Only non zero for Pkt based xfer */ 285 dring_info_t *dringp; /* List of drings for this lane */ 286 } lane_t; 287 288 /* channel drain states */ 289 #define VSW_LDC_INIT 0x1 /* Initial non-drain state */ 290 #define VSW_LDC_DRAINING 0x2 /* Channel draining */ 291 292 /* ldc information associated with a vsw-port */ 293 typedef struct vsw_ldc { 294 struct vsw_ldc *ldc_next; /* next ldc in the list */ 295 struct vsw_port *ldc_port; /* associated port */ 296 struct vsw *ldc_vswp; /* associated vsw */ 297 kmutex_t ldc_cblock; /* sync callback processing */ 298 kmutex_t ldc_txlock; /* sync transmits */ 299 uint64_t ldc_id; /* channel number */ 300 ldc_handle_t ldc_handle; /* channel handle */ 301 kmutex_t drain_cv_lock; 302 kcondvar_t drain_cv; /* channel draining */ 303 int drain_state; 304 uint32_t hphase; /* handshake phase */ 305 int hcnt; /* # handshake attempts */ 306 ldc_status_t ldc_status; /* channel status */ 307 uint64_t local_session; /* Our session id */ 308 uint64_t peer_session; /* Our peers session id */ 309 uint8_t session_status; /* Session recv'd, sent */ 310 kmutex_t hss_lock; 311 uint32_t hss_id; /* Handshake session id */ 312 uint64_t next_ident; /* Next dring ident # to use */ 313 lane_t lane_in; /* Inbound lane */ 314 lane_t lane_out; /* Outbound lane */ 315 uint8_t dev_class; /* Peer device class */ 316 vio_mblk_pool_t *rxh; /* Receive pool handle */ 317 } vsw_ldc_t; 318 319 /* list of ldcs per port */ 320 typedef struct vsw_ldc_list { 321 vsw_ldc_t *head; /* head of the list */ 322 krwlock_t lockrw; /* sync access(rw) to the list */ 323 int num_ldcs; /* number of ldcs in the list */ 324 } vsw_ldc_list_t; 325 326 /* multicast addresses port is interested in */ 327 typedef struct mcst_addr { 328 struct mcst_addr *nextp; 329 uint64_t addr; 330 } mcst_addr_t; 331 332 /* Port detach states */ 333 #define VSW_PORT_INIT 0x1 /* Initial non-detach state */ 334 #define VSW_PORT_DETACHING 0x2 /* In process of being detached */ 335 #define VSW_PORT_DETACHABLE 0x4 /* Safe to detach */ 336 337 /* port information associated with a vsw */ 338 typedef struct vsw_port { 339 int p_instance; /* port instance */ 340 struct vsw_port *p_next; /* next port in the list */ 341 struct vsw *p_vswp; /* associated vsw */ 342 vsw_ldc_list_t p_ldclist; /* list of ldcs for this port */ 343 344 kmutex_t tx_lock; /* transmit lock */ 345 int (*transmit)(vsw_ldc_t *, mblk_t *); 346 347 int state; /* port state */ 348 kmutex_t state_lock; 349 kcondvar_t state_cv; 350 351 int ref_cnt; /* # of active references */ 352 kmutex_t ref_lock; 353 kcondvar_t ref_cv; 354 355 kmutex_t mca_lock; /* multicast lock */ 356 mcst_addr_t *mcap; /* list of multicast addrs */ 357 358 /* 359 * mac address of the port & connected device 360 */ 361 struct ether_addr p_macaddr; 362 } vsw_port_t; 363 364 /* list of ports per vsw */ 365 typedef struct vsw_port_list { 366 vsw_port_t *head; /* head of the list */ 367 krwlock_t lockrw; /* sync access(rw) to the list */ 368 int num_ports; /* number of ports in the list */ 369 } vsw_port_list_t; 370 371 /* 372 * Taskq control message 373 */ 374 typedef struct vsw_ctrl_task { 375 vsw_ldc_t *ldcp; 376 def_msg_t pktp; 377 uint32_t hss_id; 378 } vsw_ctrl_task_t; 379 380 /* 381 * Number of hash chains in the multicast forwarding database. 382 */ 383 #define VSW_NCHAINS 8 384 385 /* 386 * State of interface if switch plumbed as network device. 387 */ 388 #define VSW_IF_REG 0x1 /* interface was registered */ 389 #define VSW_IF_UP 0x2 /* Interface UP */ 390 #define VSW_IF_PROMISC 0x4 /* Interface in promiscious mode */ 391 392 #define VSW_U_P(state) \ 393 (state == (VSW_IF_UP | VSW_IF_PROMISC)) 394 395 /* 396 * Switching modes. 397 */ 398 #define VSW_LAYER2 0x1 /* Layer 2 - MAC switching */ 399 #define VSW_LAYER2_PROMISC 0x2 /* Layer 2 + promisc mode */ 400 #define VSW_LAYER3 0x4 /* Layer 3 - IP switching */ 401 402 #define NUM_SMODES 3 /* number of switching modes */ 403 404 /* 405 * Bits indicating which properties we've read from MD. 406 */ 407 #define VSW_MD_PHYSNAME 0x1 408 #define VSW_MD_MACADDR 0x2 409 #define VSW_MD_SMODE 0x4 410 411 /* 412 * vsw instance state information. 413 */ 414 typedef struct vsw { 415 int instance; /* instance # */ 416 dev_info_t *dip; /* associated dev_info */ 417 struct vsw *next; /* next in list */ 418 char physname[LIFNAMSIZ]; /* phys-dev */ 419 uint8_t smode[NUM_SMODES]; /* switching mode */ 420 int smode_idx; /* curr pos in smode array */ 421 uint8_t mdprops; /* bitmask of props found */ 422 vsw_port_list_t plist; /* associated ports */ 423 ddi_taskq_t *taskq_p; /* VIO ctrl msg taskq */ 424 mod_hash_t *fdb; /* forwarding database */ 425 426 mod_hash_t *mfdb; /* multicast FDB */ 427 krwlock_t mfdbrw; /* rwlock for mFDB */ 428 429 vio_mblk_pool_t *rxh; /* Receive pool handle */ 430 431 /* mac layer */ 432 mac_handle_t mh; 433 mac_rx_handle_t mrh; 434 mac_notify_handle_t mnh; 435 const mac_txinfo_t *txinfo; /* MAC tx routine */ 436 437 /* Initial promisc setting of interface */ 438 boolean_t init_promisc; 439 440 /* Machine Description updates */ 441 mdeg_node_spec_t *inst_spec; 442 mdeg_handle_t mdeg_hdl; 443 444 /* if configured as an ethernet interface */ 445 mac_handle_t if_mh; /* MAC handle */ 446 struct ether_addr if_addr; /* interface address */ 447 krwlock_t if_lockrw; 448 uint8_t if_state; /* interface state */ 449 450 /* multicast addresses when configured as eth interface */ 451 kmutex_t mca_lock; /* multicast lock */ 452 mcst_addr_t *mcap; /* list of multicast addrs */ 453 } vsw_t; 454 455 456 /* 457 * Ethernet broadcast address definition. 458 */ 459 static struct ether_addr etherbroadcastaddr = { 460 0xff, 0xff, 0xff, 0xff, 0xff, 0xff 461 }; 462 463 #define IS_BROADCAST(ehp) \ 464 (ether_cmp(&ehp->ether_dhost, ðerbroadcastaddr) == 0) 465 #define IS_MULTICAST(ehp) \ 466 ((ehp->ether_dhost.ether_addr_octet[0] & 01) == 1) 467 468 #define READ_ENTER(x) rw_enter(x, RW_READER) 469 #define WRITE_ENTER(x) rw_enter(x, RW_WRITER) 470 #define RW_EXIT(x) rw_exit(x) 471 472 #ifdef __cplusplus 473 } 474 #endif 475 476 #endif /* _VSW_H */ 477