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