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 implementation of the management functionality of the
29 #include "TunnelIntf.h"
35 #define OVS_DBG_MOD OVS_DBG_SWITCH
38 POVS_SWITCH_CONTEXT gOvsSwitchContext;
40 UINT64 ovsTimeIncrementPerTick;
42 extern PNDIS_SPIN_LOCK gOvsCtrlLock;
43 extern NDIS_HANDLE gOvsExtDriverHandle;
44 extern NDIS_HANDLE gOvsExtDriverObject;
46 static NDIS_STATUS OvsCreateSwitch(NDIS_HANDLE ndisFilterHandle,
47 POVS_SWITCH_CONTEXT *switchContextOut);
48 static NDIS_STATUS OvsInitSwitchContext(POVS_SWITCH_CONTEXT switchContext);
49 static VOID OvsDeleteSwitch(POVS_SWITCH_CONTEXT switchContext);
50 static VOID OvsCleanupSwitchContext(POVS_SWITCH_CONTEXT switchContext);
51 static NDIS_STATUS OvsActivateSwitch(POVS_SWITCH_CONTEXT switchContext);
55 * --------------------------------------------------------------------------
56 * Implements filter driver's FilterAttach function.
58 * This function allocates the switch context, and initializes its necessary
60 * --------------------------------------------------------------------------
63 OvsExtAttach(NDIS_HANDLE ndisFilterHandle,
64 NDIS_HANDLE filterDriverContext,
65 PNDIS_FILTER_ATTACH_PARAMETERS attachParameters)
67 NDIS_STATUS status = NDIS_STATUS_FAILURE;
68 NDIS_FILTER_ATTRIBUTES ovsExtAttributes;
69 POVS_SWITCH_CONTEXT switchContext = NULL;
71 UNREFERENCED_PARAMETER(filterDriverContext);
73 OVS_LOG_TRACE("Enter: ndisFilterHandle %p", ndisFilterHandle);
75 ASSERT(filterDriverContext == (NDIS_HANDLE)gOvsExtDriverObject);
76 if (attachParameters->MiniportMediaType != NdisMedium802_3) {
77 status = NDIS_STATUS_INVALID_PARAMETER;
81 if (gOvsExtDriverHandle == NULL) {
82 OVS_LOG_TRACE("Exit: OVSEXT driver is not loaded.");
87 NdisAcquireSpinLock(gOvsCtrlLock);
88 if (gOvsSwitchContext) {
89 NdisReleaseSpinLock(gOvsCtrlLock);
90 OVS_LOG_TRACE("Exit: Failed to create OVS Switch, only one datapath is"
91 "supported, %p.", gOvsSwitchContext);
95 NdisReleaseSpinLock(gOvsCtrlLock);
96 /* Just fail the request. */
97 OVS_LOG_TRACE("Exit: Failed to create OVS Switch, since another attach"
98 "instance is in attach process.");
102 NdisReleaseSpinLock(gOvsCtrlLock);
104 status = OvsInitIpHelper(ndisFilterHandle);
105 if (status != STATUS_SUCCESS) {
106 OVS_LOG_ERROR("Exit: Failed to initialize IP helper.");
110 status = OvsCreateSwitch(ndisFilterHandle, &switchContext);
111 if (status != NDIS_STATUS_SUCCESS) {
112 OvsCleanupIpHelper();
115 ASSERT(switchContext);
118 * Register the switch context with NDIS so NDIS can pass it back to the
119 * Filterxxx callback functions as the 'FilterModuleContext' parameter.
121 RtlZeroMemory(&ovsExtAttributes, sizeof(NDIS_FILTER_ATTRIBUTES));
122 ovsExtAttributes.Header.Revision = NDIS_FILTER_ATTRIBUTES_REVISION_1;
123 ovsExtAttributes.Header.Size = sizeof(NDIS_FILTER_ATTRIBUTES);
124 ovsExtAttributes.Header.Type = NDIS_OBJECT_TYPE_FILTER_ATTRIBUTES;
125 ovsExtAttributes.Flags = 0;
127 NDIS_DECLARE_FILTER_MODULE_CONTEXT(OVS_SWITCH_CONTEXT);
128 status = NdisFSetAttributes(ndisFilterHandle, switchContext, &ovsExtAttributes);
129 if (status != NDIS_STATUS_SUCCESS) {
130 OVS_LOG_ERROR("Failed to set attributes.");
131 OvsCleanupIpHelper();
135 /* Setup the state machine. */
136 switchContext->controlFlowState = OvsSwitchAttached;
137 switchContext->dataFlowState = OvsSwitchPaused;
139 gOvsSwitchContext = switchContext;
143 gOvsInAttach = FALSE;
144 if (status != NDIS_STATUS_SUCCESS) {
145 if (switchContext != NULL) {
146 OvsDeleteSwitch(switchContext);
149 OVS_LOG_TRACE("Exit: status %x", status);
156 * --------------------------------------------------------------------------
157 * This function allocated the switch context, and initializes its necessary
159 * --------------------------------------------------------------------------
162 OvsCreateSwitch(NDIS_HANDLE ndisFilterHandle,
163 POVS_SWITCH_CONTEXT *switchContextOut)
166 POVS_SWITCH_CONTEXT switchContext;
167 NDIS_SWITCH_CONTEXT hostSwitchContext;
168 NDIS_SWITCH_OPTIONAL_HANDLERS hostSwitchHandler;
170 OVS_LOG_TRACE("Enter: Create switch object");
173 (POVS_SWITCH_CONTEXT) OvsAllocateMemory(sizeof(OVS_SWITCH_CONTEXT));
174 if (switchContext == NULL) {
175 status = NDIS_STATUS_RESOURCES;
176 goto create_switch_done;
178 RtlZeroMemory(switchContext, sizeof(OVS_SWITCH_CONTEXT));
180 /* Initialize the switch. */
181 hostSwitchHandler.Header.Type = NDIS_OBJECT_TYPE_SWITCH_OPTIONAL_HANDLERS;
182 hostSwitchHandler.Header.Size = NDIS_SIZEOF_SWITCH_OPTIONAL_HANDLERS_REVISION_1;
183 hostSwitchHandler.Header.Revision = NDIS_SWITCH_OPTIONAL_HANDLERS_REVISION_1;
185 status = NdisFGetOptionalSwitchHandlers(ndisFilterHandle,
188 if (status != NDIS_STATUS_SUCCESS) {
189 OVS_LOG_ERROR("OvsExtAttach: Extension is running in "
190 "non-switch environment.");
191 OvsFreeMemory(switchContext);
192 goto create_switch_done;
195 switchContext->NdisFilterHandle = ndisFilterHandle;
196 switchContext->NdisSwitchContext = hostSwitchContext;
197 RtlCopyMemory(&switchContext->NdisSwitchHandlers, &hostSwitchHandler,
198 sizeof(NDIS_SWITCH_OPTIONAL_HANDLERS));
200 status = OvsInitSwitchContext(switchContext);
201 if (status != NDIS_STATUS_SUCCESS) {
202 OvsFreeMemory(switchContext);
203 goto create_switch_done;
206 status = OvsTunnelFilterInitialize(gOvsExtDriverObject);
207 if (status != NDIS_STATUS_SUCCESS) {
208 OvsFreeMemory(switchContext);
209 goto create_switch_done;
211 *switchContextOut = switchContext;
214 OVS_LOG_TRACE("Exit: switchContext: %p status: %#lx",
215 switchContext, status);
221 * --------------------------------------------------------------------------
222 * Implements filter driver's FilterDetach function.
223 * --------------------------------------------------------------------------
225 _Use_decl_annotations_
227 OvsExtDetach(NDIS_HANDLE filterModuleContext)
229 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
231 OVS_LOG_TRACE("Enter: filterModuleContext %p", filterModuleContext);
233 ASSERT(switchContext->dataFlowState == OvsSwitchPaused);
234 switchContext->controlFlowState = OvsSwitchDetached;
236 while(switchContext->pendingOidCount > 0) {
239 OvsDeleteSwitch(switchContext);
240 OvsCleanupIpHelper();
241 gOvsSwitchContext = NULL;
242 /* This completes the cleanup, and a new attach can be handled now. */
244 OVS_LOG_TRACE("Exit: OvsDetach Successfully");
249 * --------------------------------------------------------------------------
250 * This function deletes the switch by freeing all memory previously allocated.
251 * XXX need synchronization with other path.
252 * --------------------------------------------------------------------------
255 OvsDeleteSwitch(POVS_SWITCH_CONTEXT switchContext)
257 UINT32 dpNo = switchContext->dpNo;
259 OVS_LOG_TRACE("Enter: switchContext:%p", switchContext);
261 OvsTunnelFilterUninitialize(gOvsExtDriverObject);
262 OvsClearAllSwitchVports(switchContext);
263 OvsCleanupSwitchContext(switchContext);
264 OvsFreeMemory(switchContext);
265 OVS_LOG_TRACE("Exit: deleted switch %p dpNo: %d", switchContext, dpNo);
270 * --------------------------------------------------------------------------
271 * Implements filter driver's FilterRestart function.
272 * --------------------------------------------------------------------------
274 _Use_decl_annotations_
276 OvsExtRestart(NDIS_HANDLE filterModuleContext,
277 PNDIS_FILTER_RESTART_PARAMETERS filterRestartParameters)
279 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
280 NDIS_STATUS status = NDIS_STATUS_SUCCESS;
281 BOOLEAN switchActive;
283 UNREFERENCED_PARAMETER(filterRestartParameters);
285 OVS_LOG_TRACE("Enter: filterModuleContext %p",
286 filterModuleContext);
288 /* Activate the switch if this is the first restart. */
289 if (!switchContext->isActivated && !switchContext->isActivateFailed) {
290 status = OvsQuerySwitchActivationComplete(switchContext,
292 if (status != NDIS_STATUS_SUCCESS) {
293 switchContext->isActivateFailed = TRUE;
294 status = NDIS_STATUS_RESOURCES;
299 status = OvsActivateSwitch(switchContext);
301 if (status != NDIS_STATUS_SUCCESS) {
302 OVS_LOG_WARN("Failed to activate switch, dpNo:%d",
303 switchContext->dpNo);
304 status = NDIS_STATUS_RESOURCES;
310 ASSERT(switchContext->dataFlowState == OvsSwitchPaused);
311 switchContext->dataFlowState = OvsSwitchRunning;
314 OVS_LOG_TRACE("Exit: Restart switch:%p, dpNo: %d, status: %#x",
315 switchContext, switchContext->dpNo, status);
321 * --------------------------------------------------------------------------
322 * Implements filter driver's FilterPause function
323 * --------------------------------------------------------------------------
326 OvsExtPause(NDIS_HANDLE filterModuleContext,
327 PNDIS_FILTER_PAUSE_PARAMETERS pauseParameters)
329 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
331 UNREFERENCED_PARAMETER(pauseParameters);
332 OVS_LOG_TRACE("Enter: filterModuleContext %p",
333 filterModuleContext);
335 ASSERT(switchContext->dataFlowState == OvsSwitchRunning);
336 switchContext->dataFlowState = OvsSwitchPaused;
338 while(switchContext->pendingOidCount > 0) {
342 OVS_LOG_TRACE("Exit: OvsDetach Successfully");
343 return NDIS_STATUS_SUCCESS;
347 OvsInitSwitchContext(POVS_SWITCH_CONTEXT switchContext)
352 OVS_LOG_TRACE("Enter: switchContext: %p", switchContext);
354 switchContext->dispatchLock =
355 NdisAllocateRWLock(switchContext->NdisFilterHandle);
357 switchContext->portNoHashArray = (PLIST_ENTRY)
358 OvsAllocateMemory(sizeof(LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE);
359 switchContext->ovsPortNameHashArray = (PLIST_ENTRY)
360 OvsAllocateMemory(sizeof (LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE);
361 switchContext->portIdHashArray= (PLIST_ENTRY)
362 OvsAllocateMemory(sizeof (LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE);
363 status = OvsAllocateFlowTable(&switchContext->datapath, switchContext);
365 if (status == NDIS_STATUS_SUCCESS) {
366 status = OvsInitBufferPool(switchContext);
368 if (status != NDIS_STATUS_SUCCESS ||
369 switchContext->dispatchLock == NULL ||
370 switchContext->portNoHashArray == NULL ||
371 switchContext->ovsPortNameHashArray == NULL ||
372 switchContext->portIdHashArray== NULL) {
373 if (switchContext->dispatchLock) {
374 NdisFreeRWLock(switchContext->dispatchLock);
376 if (switchContext->portNoHashArray) {
377 OvsFreeMemory(switchContext->portNoHashArray);
379 if (switchContext->ovsPortNameHashArray) {
380 OvsFreeMemory(switchContext->ovsPortNameHashArray);
382 if (switchContext->portIdHashArray) {
383 OvsFreeMemory(switchContext->portIdHashArray);
385 OvsDeleteFlowTable(&switchContext->datapath);
386 OvsCleanupBufferPool(switchContext);
388 OVS_LOG_TRACE("Exit: Failed to init switchContext");
389 return NDIS_STATUS_RESOURCES;
392 for (i = 0; i < OVS_MAX_VPORT_ARRAY_SIZE; i++) {
393 InitializeListHead(&switchContext->ovsPortNameHashArray[i]);
395 for (i = 0; i < OVS_MAX_VPORT_ARRAY_SIZE; i++) {
396 InitializeListHead(&switchContext->portIdHashArray[i]);
398 for (i = 0; i < OVS_MAX_VPORT_ARRAY_SIZE; i++) {
399 InitializeListHead(&switchContext->portNoHashArray[i]);
402 switchContext->isActivated = FALSE;
403 switchContext->isActivateFailed = FALSE;
404 switchContext->dpNo = OVS_DP_NUMBER;
405 ovsTimeIncrementPerTick = KeQueryTimeIncrement() / 10000;
406 OVS_LOG_TRACE("Exit: Succesfully initialized switchContext: %p",
408 return NDIS_STATUS_SUCCESS;
412 OvsCleanupSwitchContext(POVS_SWITCH_CONTEXT switchContext)
414 OVS_LOG_TRACE("Enter: Delete switchContext:%p", switchContext);
416 /* We need to do cleanup for tunnel port here. */
417 ASSERT(switchContext->numVports == 0);
419 NdisFreeRWLock(switchContext->dispatchLock);
420 OvsFreeMemory(switchContext->ovsPortNameHashArray);
421 OvsFreeMemory(switchContext->portIdHashArray);
422 OvsFreeMemory(switchContext->portNoHashArray);
423 OvsDeleteFlowTable(&switchContext->datapath);
424 OvsCleanupBufferPool(switchContext);
425 OVS_LOG_TRACE("Exit: Delete switchContext: %p", switchContext);
429 * --------------------------------------------------------------------------
430 * This function activates the switch by initializing it with all the runtime
431 * state. First it queries all of the MAC addresses set as custom switch policy
432 * to allow sends from, and adds tme to the property list. Then it queries the
433 * NIC list and verifies it can support all of the NICs currently connected to
434 * the switch, and adds the NICs to the NIC list.
435 * --------------------------------------------------------------------------
438 OvsActivateSwitch(POVS_SWITCH_CONTEXT switchContext)
442 ASSERT(!switchContext->isActivated);
444 OVS_LOG_TRACE("Enter: activate switch %p, dpNo: %ld",
445 switchContext, switchContext->dpNo);
447 status = OvsAddConfiguredSwitchPorts(switchContext);
449 if (status != NDIS_STATUS_SUCCESS) {
450 OVS_LOG_WARN("Failed to add configured switch ports");
454 status = OvsInitConfiguredSwitchNics(switchContext);
456 if (status != NDIS_STATUS_SUCCESS) {
457 OVS_LOG_WARN("Failed to add configured vports");
458 OvsClearAllSwitchVports(switchContext);
461 switchContext->isActivated = TRUE;
462 OvsPostEvent(OVS_DEFAULT_PORT_NO, OVS_DEFAULT_EVENT_STATUS);
465 OVS_LOG_TRACE("Exit: activate switch:%p, isActivated: %s, status = %lx",
467 (switchContext->isActivated ? "TRUE" : "FALSE"), status);
472 OvsGetExternalVport()
474 return gOvsSwitchContext->externalVport;
479 * --------------------------------------------------------------------------
480 * Implements filter driver's FilterNetPnPEvent function.
481 * --------------------------------------------------------------------------
484 OvsExtNetPnPEvent(NDIS_HANDLE filterModuleContext,
485 PNET_PNP_EVENT_NOTIFICATION netPnPEvent)
487 NDIS_STATUS status = NDIS_STATUS_SUCCESS;
488 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
489 BOOLEAN switchActive;
491 OVS_LOG_TRACE("Enter: filterModuleContext: %p, NetEvent: %d",
492 filterModuleContext, (netPnPEvent->NetPnPEvent).NetEvent);
494 * The only interesting event is the NetEventSwitchActivate. It provides
495 * an asynchronous notification of the switch completing activation.
497 if (netPnPEvent->NetPnPEvent.NetEvent == NetEventSwitchActivate) {
498 status = OvsQuerySwitchActivationComplete(switchContext, &switchActive);
499 if (status != NDIS_STATUS_SUCCESS) {
500 switchContext->isActivateFailed = TRUE;
502 ASSERT(switchContext->isActivated == FALSE);
503 ASSERT(switchActive == TRUE);
504 if (switchContext->isActivated == FALSE && switchActive == TRUE) {
505 status = OvsActivateSwitch(switchContext);
506 OVS_LOG_TRACE("OvsExtNetPnPEvent: activated switch: %p "
507 "status: %s", switchContext,
508 status ? "TRUE" : "FALSE");
513 if (status == NDIS_STATUS_SUCCESS) {
514 status = NdisFNetPnPEvent(switchContext->NdisFilterHandle,
517 OVS_LOG_TRACE("Exit: OvsExtNetPnPEvent");