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