2 * Copyright (c) 2014 VMware, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * This file contains the definition of the switch object for the OVS.
25 #include "BufferMgmt.h"
26 #include "TunnelIntf.h"
27 #define OVS_MAX_VPORT_ARRAY_SIZE 1024
28 #define OVS_MAX_PID_ARRAY_SIZE 1024
30 #define OVS_VPORT_MASK (OVS_MAX_VPORT_ARRAY_SIZE - 1)
31 #define OVS_PID_MASK (OVS_MAX_PID_ARRAY_SIZE - 1)
33 #define OVS_INTERNAL_VPORT_DEFAULT_INDEX 0
35 //Tunnel port indicies
36 #define RESERVED_START_INDEX1 1
37 #define OVS_TUNNEL_INDEX_START RESERVED_START_INDEX1
38 #define OVS_VXLAN_VPORT_INDEX 2
39 #define OVS_GRE_VPORT_INDEX 3
40 #define OVS_GRE64_VPORT_INDEX 4
41 #define OVS_TUNNEL_INDEX_END OVS_GRE64_VPORT_INDEX
43 #define OVS_MAX_PHYS_ADAPTERS 32
44 #define OVS_MAX_IP_VPOR 32
46 #define OVS_HASH_BASIS 0x13578642
48 typedef struct _OVS_VPORT_ENTRY *POVS_VPORT_ENTRY;
50 typedef struct _OVS_DATAPATH
52 PLIST_ENTRY flowTable; // Contains OvsFlows.
53 UINT32 nFlows; // Number of entries in flowTable.
55 // List_Links queues[64]; // Hash table of queue IDs.
58 UINT64 hits; // Number of flow table hits.
59 UINT64 misses; // Number of flow table misses.
60 UINT64 lost; // Number of dropped misses.
62 /* Used to protect the flows in the flowtable. */
63 PNDIS_RW_LOCK_EX lock;
64 } OVS_DATAPATH, *POVS_DATAPATH;
69 * The context allocated per switch., For OVS, we only
70 * support one switch which corresponding to one datapath.
71 * Each datapath can have multiple logical bridges configured
72 * which is maintained by vswitchd.
75 typedef enum OVS_SWITCH_DATAFLOW_STATE
79 } OVS_SWITCH_DATAFLOW_STATE, *POVS_SWITCH_DATAFLOW_STATE;
81 typedef enum OVS_SWITCH_CONTROFLOW_STATE
86 } OVS_SWITCH_CONTROLFLOW_STATE, *POVS_SWITCH_CONTROLFLOW_STATE;
88 // XXX: Take care of alignment and grouping members by cacheline
89 typedef struct _OVS_SWITCH_CONTEXT
91 /* Coarse and fine-grained switch states. */
92 OVS_SWITCH_DATAFLOW_STATE dataFlowState;
93 OVS_SWITCH_CONTROLFLOW_STATE controlFlowState;
95 BOOLEAN isActivateFailed;
100 * 'virtualExternalVport' represents default external interface. This is
101 * a virtual interface. The friendly name of such an interface has
102 * been observed to be: "Microsoft Default External Interface". This NIC
103 * has 'NicIndex' == 0.
105 * The "real" physical external NIC has 'NicIndex' > 0. For each
106 * external interface, virtual or physical, NDIS gives an NIC level
107 * OID callback. Note that, even though there are multile "NICs",
108 * there's only one underlying Hyper-V port. Thus, we get a single
109 * NDIS port-level callback, but multiple NDIS NIC-level callbacks.
111 * The virtual external NIC can be accessed at 'virtualExternalVport', and
112 * is assigned the name "external.defaultAdapter". The virtual external
113 * NIC is not inserted into the 'portIdHashArray' since the port must not
114 * be exposed to OVS userspace.
116 * The physical external NICs are assigned names "external.%INDEX%",
117 * where '%INDEX%' represents the 'NicIndex' of the NIC.
119 * While adding a physical external NIC in OvsInitConfiguredSwitchNics(),
120 * some required properties of the vport are available only at the
121 * NDIS port-level. So, these are copied from 'virtualExternalVport'.
122 * The vport created for the physical external NIC is inserted into the
125 * When the virtual external NIC is torn down or deleted, the
126 * corresponding physical external ports are also torn down or
127 * deleted. The number of physical external NICs is tracked by
130 NDIS_SWITCH_PORT_ID virtualExternalPortId;
131 NDIS_SWITCH_PORT_ID internalPortId;
132 POVS_VPORT_ENTRY virtualExternalVport; // the virtual adapter vport
133 POVS_VPORT_ENTRY internalVport;
136 * 'portIdHashArray' ONLY contains ports that exist on the Hyper-V switch,
137 * namely: VIF (vNIC) ports, external port and Hyper-V internal port.
138 * 'numHvVports' counts the ports in 'portIdHashArray'. If a port got
139 * deleted on the Hyper-V switch, it gets deleted from 'portIdHashArray'.
140 * The port itself will not get deallocated if it has been added from OVS
141 * userspace. 'numHvVports' is decremented when the port is deallocated.
143 * 'portNoHashArray' ONLY contains ports that are added from OVS userspace,
144 * regardless of whether that port exists on the Hyper-V switch or not.
145 * Tunnel ports and bridge-internal ports are examples of ports that do not
146 * exist on the Hyper-V switch, and 'numNonHvVports' counts such ports in
149 * 'tunnelVportsArray' contains tunnel ports that are added from OVS
150 * userspace. Currently only VXLAN tunnels are added in this list.
152 * 'ovsPortNameHashArray' contains the same entries as 'portNoHashArray' but
153 * hashed on a different key.
155 PLIST_ENTRY portIdHashArray; // based on Hyper-V portId
156 PLIST_ENTRY portNoHashArray; // based on ovs port number
157 PLIST_ENTRY tunnelVportsArray; // based on ovs dst port number
158 PLIST_ENTRY ovsPortNameHashArray; // based on ovsName
159 PLIST_ENTRY pidHashArray; // based on packet pids
160 NDIS_SPIN_LOCK pidHashLock; // Lock for pidHash table
162 UINT32 numPhysicalNics; // the number of physical
165 UINT32 numNonHvVports;
167 /* Lock taken over the switch. This protects the ports on the switch. */
168 PNDIS_RW_LOCK_EX dispatchLock;
171 OVS_DATAPATH datapath;
173 /* Handle to the OVSExt filter driver. Same as 'gOvsExtDriverHandle'. */
174 NDIS_HANDLE NdisFilterHandle;
176 /* Handle and callbacks exposed by the underlying hyper-v switch. */
177 NDIS_SWITCH_CONTEXT NdisSwitchContext;
178 NDIS_SWITCH_OPTIONAL_HANDLERS NdisSwitchHandlers;
180 volatile LONG pendingInjectedNblCount;
181 volatile LONG pendingOidCount;
183 OVS_NBL_POOL ovsPool;
184 } OVS_SWITCH_CONTEXT, *POVS_SWITCH_CONTEXT;
188 OvsAcquireDatapathRead(OVS_DATAPATH *datapath,
189 LOCK_STATE_EX *lockState,
193 NdisAcquireRWLockRead(datapath->lock, lockState,
194 dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
198 OvsAcquireDatapathWrite(OVS_DATAPATH *datapath,
199 LOCK_STATE_EX *lockState,
203 NdisAcquireRWLockWrite(datapath->lock, lockState,
204 dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
208 OvsReleaseDatapath(OVS_DATAPATH *datapath,
209 LOCK_STATE_EX *lockState)
212 NdisReleaseRWLock(datapath->lock, lockState);
216 OvsAcquireSwitchContext(VOID);
219 OvsReleaseSwitchContext(POVS_SWITCH_CONTEXT switchContext);
221 #endif /* __SWITCH_H_ */