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 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_MAC_CLIENT_IMPL_H 27 #define _SYS_MAC_CLIENT_IMPL_H 28 29 #include <sys/modhash.h> 30 #include <sys/mac_client.h> 31 #include <sys/mac_provider.h> 32 #include <sys/mac.h> 33 #include <sys/mac_impl.h> 34 #include <net/if.h> 35 #include <sys/mac_flow_impl.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 extern kmem_cache_t *mac_client_impl_cache; 42 extern kmem_cache_t *mac_unicast_impl_cache; 43 extern kmem_cache_t *mac_promisc_impl_cache; 44 45 /* 46 * Need a list to chain all VIDs assigned to a client. Normally, one 47 * MAC client only has one VID. But vsw might need multiple VIDs. 48 */ 49 typedef struct mac_unicast_impl_s { /* Protected by */ 50 struct mac_unicast_impl_s *mui_next; /* SL */ 51 mac_address_t *mui_map; /* SL */ 52 uint16_t mui_vid; /* SL */ 53 } mac_unicast_impl_t; 54 55 #define MAC_CLIENT_FLAGS_PRIMARY 0X0001 56 #define MAC_CLIENT_FLAGS_VNIC_PRIMARY 0x0002 57 #define MAC_CLIENT_FLAGS_MULTI_PRIMARY 0x0004 58 #define MAC_CLIENT_FLAGS_PASSIVE_PRIMARY 0x0008 59 60 /* 61 * One of these is instantiated per MAC client promiscuous callback. 62 * 63 * Each element of this structure belongs to two linked list. One 64 * for the mac_client_impl_t (mci_promisc_list) which created allocated 65 * the callback, the other for the mac_impl_t (mi_promisc_list) corresponding 66 * to the MAC client. 67 * The former allows us to do bookkeeping, the latter allows us 68 * to more efficiently dispatch packets to the promiscuous callbacks. 69 */ 70 typedef struct mac_promisc_impl_s { /* Protected by */ 71 mac_cb_t mpi_mci_link; /* mi_promisc_lock */ 72 mac_cb_t mpi_mi_link; /* mi_promisc_lock */ 73 mac_client_promisc_type_t mpi_type; /* WO */ 74 mac_rx_t mpi_fn; /* WO */ 75 void *mpi_arg; /* WO */ 76 struct mac_client_impl_s *mpi_mcip; /* WO */ 77 boolean_t mpi_no_tx_loop; /* WO */ 78 boolean_t mpi_no_phys; /* WO */ 79 boolean_t mpi_strip_vlan_tag; /* WO */ 80 boolean_t mpi_no_copy; /* WO */ 81 } mac_promisc_impl_t; 82 83 typedef union mac_tx_percpu_s { 84 struct { 85 kmutex_t _pcpu_tx_lock; 86 uint_t _pcpu_tx_refcnt; 87 } pcpu_lr; 88 uchar_t pcpu_pad[64]; 89 } mac_tx_percpu_t; 90 91 #define pcpu_tx_lock pcpu_lr._pcpu_tx_lock 92 #define pcpu_tx_refcnt pcpu_lr._pcpu_tx_refcnt 93 94 /* 95 * One of these is instanciated for each MAC client. 96 */ 97 struct mac_client_impl_s { /* Protected by */ 98 struct mac_client_impl_s *mci_client_next; /* mi_rw_lock */ 99 char mci_name[MAXNAMELEN]; /* mi_rw_lock */ 100 /* 101 * This flow entry will contain all the internal constructs 102 * such as SRS etc. for this MAC client. The MAC client may 103 * have more than one flow corresponding to each upper client 104 * sharing this mac_client_impl_t. 105 */ 106 flow_entry_t *mci_flent; /* mi_rw_lock */ 107 struct mac_impl_s *mci_mip; /* WO */ 108 /* 109 * If this is a client that has a pass thru MAC (e.g. a VNIC), 110 * then we also keep the handle for the client's upper MAC. 111 */ 112 struct mac_impl_s *mci_upper_mip; /* WO */ 113 114 uint32_t mci_state_flags; /* WO */ 115 mac_rx_t mci_rx_fn; /* Rx Quiescence */ 116 void *mci_rx_arg; /* Rx Quiescence */ 117 mac_direct_rx_t mci_direct_rx_fn; /* SL */ 118 void *mci_direct_rx_arg; /* SL */ 119 mac_rx_t mci_rx_p_fn; /* Rx Quiescence */ 120 void *mci_rx_p_arg; /* Rx Quiescence */ 121 void *mci_p_unicast_list; 122 123 mac_cb_t *mci_promisc_list; /* mi_promisc_lock */ 124 125 mac_address_t *mci_unicast; 126 uint32_t mci_flags; /* SL */ 127 krwlock_t mci_rw_lock; 128 mac_unicast_impl_t *mci_unicast_list; /* mci_rw_lock */ 129 /* 130 * The mac_client_impl_t may be shared by multiple clients, i.e 131 * multiple VLANs sharing the same MAC client. In this case the 132 * address/vid tubles differ and are each associated with their 133 * own flow entry, but the rest underlying components SRS, etc, 134 * are common. 135 */ 136 flow_entry_t *mci_flent_list; /* mci_rw_lock */ 137 uint_t mci_nflents; /* mci_rw_lock */ 138 uint_t mci_nvids; /* mci_rw_lock */ 139 140 /* Resource Management Functions */ 141 mac_resource_add_t mci_resource_add; /* SL */ 142 mac_resource_remove_t mci_resource_remove; /* SL */ 143 mac_resource_quiesce_t mci_resource_quiesce; /* SL */ 144 mac_resource_restart_t mci_resource_restart; /* SL */ 145 mac_resource_bind_t mci_resource_bind; /* SL */ 146 void *mci_resource_arg; /* SL */ 147 148 149 /* Tx notify callback */ 150 kmutex_t mci_tx_cb_lock; 151 mac_cb_info_t mci_tx_notify_cb_info; /* cb list info */ 152 mac_cb_t *mci_tx_notify_cb_list; /* The cb list */ 153 uintptr_t mci_tx_notify_id; 154 155 /* per MAC client stats */ /* None */ 156 uint64_t mci_stat_multircv; 157 uint64_t mci_stat_brdcstrcv; 158 uint64_t mci_stat_multixmt; 159 uint64_t mci_stat_brdcstxmt; 160 uint64_t mci_stat_obytes; 161 uint64_t mci_stat_opackets; 162 uint64_t mci_stat_oerrors; 163 uint64_t mci_stat_ibytes; 164 uint64_t mci_stat_ipackets; 165 uint64_t mci_stat_ierrors; 166 167 flow_tab_t *mci_subflow_tab; /* Rx quiescence */ 168 169 /* 170 * Priority range for this MAC client. This the range 171 * corresponding to the priority configured (nr_flow_priority). 172 */ 173 pri_t mci_min_pri; 174 pri_t mci_max_pri; 175 176 /* 177 * Hybrid I/O related definitions. 178 */ 179 mac_share_handle_t mci_share; 180 181 /* for multicast support */ 182 struct mac_mcast_addrs_s *mci_mcast_addrs; /* mi_rw_lock */ 183 184 /* 185 * Protected by mci_tx_pcpu[0].pcpu_tx_lock 186 */ 187 uint_t mci_tx_flag; 188 kcondvar_t mci_tx_cv; 189 190 /* Must be last in the structure for dynamic sizing */ 191 mac_tx_percpu_t mci_tx_pcpu[1]; /* SL */ 192 }; 193 194 #define MAC_CLIENT_IMPL_SIZE \ 195 (sizeof (mac_client_impl_t) + \ 196 (mac_tx_percpu_cnt * sizeof (mac_tx_percpu_t))) 197 198 extern int mac_tx_percpu_cnt; 199 200 #define MCIP_TX_SRS(mcip) \ 201 ((mcip)->mci_flent == NULL ? NULL : (mcip)->mci_flent->fe_tx_srs) 202 203 /* Defensive coding, non-null mcip_flent could be an assert */ 204 205 #define MCIP_DATAPATH_SETUP(mcip) \ 206 ((mcip)->mci_flent == NULL ? B_FALSE : \ 207 !((mcip)->mci_flent->fe_flags & FE_MC_NO_DATAPATH)) 208 209 #define MCIP_RESOURCE_PROPS(mcip) \ 210 ((mcip)->mci_flent == NULL ? NULL : \ 211 &(mcip)->mci_flent->fe_resource_props) 212 213 #define MCIP_EFFECTIVE_PROPS(mcip) \ 214 (mcip->mci_flent == NULL ? NULL : \ 215 &(mcip)->mci_flent->fe_effective_props) 216 217 #define MCIP_RESOURCE_PROPS_MASK(mcip) \ 218 ((mcip)->mci_flent == NULL ? 0 : \ 219 (mcip)->mci_flent->fe_resource_props.mrp_mask) 220 221 #define MCIP_RESOURCE_PROPS_MAXBW(mcip) \ 222 ((mcip)->mci_flent == NULL ? 0 : \ 223 (mcip)->mci_flent->fe_resource_props.mrp_maxbw) 224 225 #define MCIP_RESOURCE_PROPS_PRIORITY(mcip) \ 226 ((mcip)->mci_flent == NULL ? 0 : \ 227 (mcip)->mci_flent->fe_resource_props.mrp_priority) 228 229 #define MCIP_RESOURCE_PROPS_CPUS(mcip) \ 230 ((mcip)->mci_flent == NULL ? 0 : \ 231 &(mcip)->mci_flent->fe_resource_props.mrp_cpus) 232 233 #define MCIP_RESOURCE_PROPS_NCPUS(mcip) \ 234 ((mcip)->mci_flent == NULL ? 0 : \ 235 (mcip)->mci_flent->fe_resource_props.mrp_ncpus) 236 237 #define MCIP_RESOURCE_PROPS_CPU(mcip) \ 238 ((mcip)->mci_flent == NULL ? 0 : \ 239 (mcip)->mci_flent->fe_resource_props.mrp_ncpu) 240 241 /* 242 * We validate the VLAN id of the packet w.r.t the client's vid, 243 * if required (i.e. !MCIS_DISABLE_TX_VID_CHECK). DLS clients 244 * will have MCIS_DISABLE_TX_VID_CHECK set. 245 * (In the case of aggr when we get back packets, due to 246 * the underlying driver being flow controlled, we won't 247 * drop the packet even if it is VLAN tagged as we 248 * don't set MCIS_DISABLE_TX_VID_CHECK for an aggr.) 249 */ 250 #define MAC_VID_CHECK_NEEDED(mcip) \ 251 (((mcip)->mci_state_flags & MCIS_DISABLE_TX_VID_CHECK) == 0 && \ 252 (mcip)->mci_mip->mi_info.mi_nativemedia == DL_ETHER) 253 254 #define MAC_VID_CHECK(mcip, mp, err) { \ 255 if (ntohs(((struct ether_header *)(mp)->b_rptr)->ether_type) == \ 256 ETHERTYPE_VLAN) { \ 257 /* \ 258 * err is set to EINVAL (so the caller can take the \ 259 * appropriate action. e.g. freemsg()) for two cases: \ 260 * -client is not responsible for filling in the vid. \ 261 * -client is responsible for filling in the vid, but \ 262 * the vid doesn't match the vid of the MAC client. \ 263 */ \ 264 (err) = EINVAL; \ 265 if (((mcip)->mci_state_flags & MCIS_TAG_DISABLE) != 0) {\ 266 struct ether_vlan_header *evhp; \ 267 uint16_t vlanid; \ 268 \ 269 evhp = (struct ether_vlan_header *)(mp)->b_rptr;\ 270 vlanid = VLAN_ID(ntohs(evhp->ether_tci)); \ 271 if (mac_client_check_flow_vid((mcip), vlanid)) \ 272 (err) = 0; \ 273 } \ 274 } \ 275 } 276 277 #define MAC_TAG_NEEDED(mcip) \ 278 (((mcip)->mci_state_flags & MCIS_TAG_DISABLE) == 0 && \ 279 (mcip)->mci_nvids == 1) \ 280 281 /* MCI state flags */ 282 #define MCIS_IS_VNIC 0x0001 283 #define MCIS_EXCLUSIVE 0x0002 284 #define MCIS_TAG_DISABLE 0x0004 285 #define MCIS_STRIP_DISABLE 0x0008 286 #define MCIS_IS_AGGR_PORT 0x0010 287 #define MCIS_CLIENT_POLL_CAPABLE 0x0020 288 #define MCIS_DESC_LOGGED 0x0040 289 #define MCIS_SHARE_BOUND 0x0080 290 #define MCIS_NO_HWRINGS 0x0100 291 #define MCIS_DISABLE_TX_VID_CHECK 0x0200 292 #define MCIS_USE_DATALINK_NAME 0x0400 293 #define MCIS_UNICAST_HW 0x0800 294 #define MCIS_REQ_HWRINGS 0x1000 295 296 /* in mac_client.c */ 297 extern void mac_promisc_client_dispatch(mac_client_impl_t *, mblk_t *); 298 extern void mac_client_init(void); 299 extern void mac_client_fini(void); 300 extern void mac_promisc_dispatch(mac_impl_t *, mblk_t *, 301 mac_client_impl_t *); 302 303 extern int mac_validate_props(mac_resource_props_t *); 304 305 extern mac_client_impl_t *mac_vnic_lower(mac_impl_t *); 306 extern mac_client_impl_t *mac_primary_client_handle(mac_impl_t *); 307 extern uint16_t i_mac_flow_vid(flow_entry_t *); 308 extern boolean_t i_mac_capab_get(mac_handle_t, mac_capab_t, void *); 309 310 extern void mac_unicast_update_clients(mac_impl_t *, mac_address_t *); 311 extern void mac_update_resources(mac_resource_props_t *, 312 mac_resource_props_t *, boolean_t); 313 314 boolean_t mac_client_check_flow_vid(mac_client_impl_t *, uint16_t); 315 316 extern boolean_t mac_is_primary_client(mac_client_impl_t *); 317 318 #ifdef __cplusplus 319 } 320 #endif 321 322 #endif /* _SYS_MAC_CLIENT_IMPL_H */ 323