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
34 #define OVS_DBG_MOD OVS_DBG_SWITCH
37 POVS_SWITCH_CONTEXT gOvsSwitchContext;
38 LONG volatile gOvsInAttach;
39 UINT64 ovsTimeIncrementPerTick;
41 extern NDIS_HANDLE gOvsExtDriverHandle;
42 extern NDIS_HANDLE gOvsExtDriverObject;
43 extern PDEVICE_OBJECT gOvsDeviceObject;
46 * Reference count used to prevent premature deallocation of the global switch
47 * context structure, gOvsSwitchContext.
49 volatile LONG gOvsSwitchContextRefCount = 0;
51 static NDIS_STATUS OvsCreateSwitch(NDIS_HANDLE ndisFilterHandle,
52 POVS_SWITCH_CONTEXT *switchContextOut);
53 static NDIS_STATUS OvsInitSwitchContext(POVS_SWITCH_CONTEXT switchContext);
54 static VOID OvsDeleteSwitch(POVS_SWITCH_CONTEXT switchContext);
55 static VOID OvsUninitSwitchContext(POVS_SWITCH_CONTEXT switchContext);
56 static NDIS_STATUS OvsActivateSwitch(POVS_SWITCH_CONTEXT switchContext);
60 * --------------------------------------------------------------------------
61 * Implements filter driver's FilterAttach function.
63 * This function allocates the switch context, and initializes its necessary
65 * --------------------------------------------------------------------------
68 OvsExtAttach(NDIS_HANDLE ndisFilterHandle,
69 NDIS_HANDLE filterDriverContext,
70 PNDIS_FILTER_ATTACH_PARAMETERS attachParameters)
72 NDIS_STATUS status = NDIS_STATUS_FAILURE;
73 NDIS_FILTER_ATTRIBUTES ovsExtAttributes;
74 POVS_SWITCH_CONTEXT switchContext = NULL;
76 UNREFERENCED_PARAMETER(filterDriverContext);
78 OVS_LOG_TRACE("Enter: ndisFilterHandle %p", ndisFilterHandle);
80 ASSERT(filterDriverContext == (NDIS_HANDLE)gOvsExtDriverObject);
81 if (attachParameters->MiniportMediaType != NdisMedium802_3) {
82 status = NDIS_STATUS_INVALID_PARAMETER;
86 if (gOvsExtDriverHandle == NULL) {
87 OVS_LOG_TRACE("Exit: OVSEXT driver is not loaded.");
92 if (gOvsSwitchContext) {
93 OVS_LOG_TRACE("Exit: Failed to create OVS Switch, only one datapath is"
94 "supported, %p.", gOvsSwitchContext);
98 if (InterlockedCompareExchange(&gOvsInAttach, 1, 0)) {
99 /* Just fail the request. */
100 OVS_LOG_TRACE("Exit: Failed to create OVS Switch, since another attach"
101 "instance is in attach process.");
105 status = OvsInitIpHelper(ndisFilterHandle);
106 if (status != STATUS_SUCCESS) {
107 OVS_LOG_ERROR("Exit: Failed to initialize IP helper.");
111 status = OvsCreateSwitch(ndisFilterHandle, &switchContext);
112 if (status != NDIS_STATUS_SUCCESS) {
113 OvsCleanupIpHelper();
116 ASSERT(switchContext);
119 * Register the switch context with NDIS so NDIS can pass it back to the
120 * FilterXXX callback functions as the 'FilterModuleContext' parameter.
122 RtlZeroMemory(&ovsExtAttributes, sizeof(NDIS_FILTER_ATTRIBUTES));
123 ovsExtAttributes.Header.Revision = NDIS_FILTER_ATTRIBUTES_REVISION_1;
124 ovsExtAttributes.Header.Size = sizeof(NDIS_FILTER_ATTRIBUTES);
125 ovsExtAttributes.Header.Type = NDIS_OBJECT_TYPE_FILTER_ATTRIBUTES;
126 ovsExtAttributes.Flags = 0;
128 NDIS_DECLARE_FILTER_MODULE_CONTEXT(OVS_SWITCH_CONTEXT);
129 status = NdisFSetAttributes(ndisFilterHandle, switchContext, &ovsExtAttributes);
130 if (status != NDIS_STATUS_SUCCESS) {
131 OVS_LOG_ERROR("Failed to set attributes.");
132 OvsCleanupIpHelper();
136 /* Setup the state machine. */
137 switchContext->controlFlowState = OvsSwitchAttached;
138 switchContext->dataFlowState = OvsSwitchPaused;
140 gOvsSwitchContextRefCount = 1;
141 gOvsSwitchContext = switchContext;
145 gOvsInAttach = FALSE;
146 if (status != NDIS_STATUS_SUCCESS) {
147 if (switchContext != NULL) {
148 OvsDeleteSwitch(switchContext);
151 OVS_LOG_TRACE("Exit: status %x", status);
158 * --------------------------------------------------------------------------
159 * This function allocated the switch context, and initializes its necessary
161 * --------------------------------------------------------------------------
164 OvsCreateSwitch(NDIS_HANDLE ndisFilterHandle,
165 POVS_SWITCH_CONTEXT *switchContextOut)
168 POVS_SWITCH_CONTEXT switchContext;
169 NDIS_SWITCH_CONTEXT hostSwitchContext;
170 NDIS_SWITCH_OPTIONAL_HANDLERS hostSwitchHandler;
172 OVS_LOG_TRACE("Enter: Create switch object");
174 switchContext = (POVS_SWITCH_CONTEXT) OvsAllocateMemoryWithTag(
175 sizeof(OVS_SWITCH_CONTEXT), OVS_SWITCH_POOL_TAG);
176 if (switchContext == NULL) {
177 status = NDIS_STATUS_RESOURCES;
178 goto create_switch_done;
180 RtlZeroMemory(switchContext, sizeof(OVS_SWITCH_CONTEXT));
182 /* Initialize the switch. */
183 hostSwitchHandler.Header.Type = NDIS_OBJECT_TYPE_SWITCH_OPTIONAL_HANDLERS;
184 hostSwitchHandler.Header.Size = NDIS_SIZEOF_SWITCH_OPTIONAL_HANDLERS_REVISION_1;
185 hostSwitchHandler.Header.Revision = NDIS_SWITCH_OPTIONAL_HANDLERS_REVISION_1;
187 status = NdisFGetOptionalSwitchHandlers(ndisFilterHandle,
190 if (status != NDIS_STATUS_SUCCESS) {
191 OVS_LOG_ERROR("OvsExtAttach: Extension is running in "
192 "non-switch environment.");
193 OvsFreeMemoryWithTag(switchContext, OVS_SWITCH_POOL_TAG);
194 goto create_switch_done;
197 switchContext->NdisFilterHandle = ndisFilterHandle;
198 switchContext->NdisSwitchContext = hostSwitchContext;
199 RtlCopyMemory(&switchContext->NdisSwitchHandlers, &hostSwitchHandler,
200 sizeof(NDIS_SWITCH_OPTIONAL_HANDLERS));
202 status = OvsInitSwitchContext(switchContext);
203 if (status != NDIS_STATUS_SUCCESS) {
204 OvsFreeMemoryWithTag(switchContext, OVS_SWITCH_POOL_TAG);
205 switchContext = NULL;
206 goto create_switch_done;
209 status = OvsInitTunnelFilter(gOvsExtDriverObject, gOvsDeviceObject);
210 if (status != NDIS_STATUS_SUCCESS) {
211 OvsUninitSwitchContext(switchContext);
212 goto create_switch_done;
215 status = OvsInitSttDefragmentation();
216 if (status != STATUS_SUCCESS) {
217 OVS_LOG_ERROR("Exit: Failed to initialize Stt Defragmentation");
218 goto create_switch_done;
221 *switchContextOut = switchContext;
224 OVS_LOG_TRACE("Exit: switchContext: %p status: %#lx",
225 switchContext, status);
231 * --------------------------------------------------------------------------
232 * Implements filter driver's FilterDetach function.
233 * --------------------------------------------------------------------------
235 _Use_decl_annotations_
237 OvsExtDetach(NDIS_HANDLE filterModuleContext)
239 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
241 OVS_LOG_TRACE("Enter: filterModuleContext %p", filterModuleContext);
243 ASSERT(switchContext->dataFlowState == OvsSwitchPaused);
244 switchContext->controlFlowState = OvsSwitchDetached;
246 while(switchContext->pendingOidCount > 0) {
249 OvsDeleteSwitch(switchContext);
250 OvsCleanupIpHelper();
251 OvsCleanupSttDefragmentation();
252 /* This completes the cleanup, and a new attach can be handled now. */
254 OVS_LOG_TRACE("Exit: OvsDetach Successfully");
259 * --------------------------------------------------------------------------
260 * This function deletes the switch by freeing all memory previously allocated.
261 * XXX need synchronization with other path.
262 * --------------------------------------------------------------------------
265 OvsDeleteSwitch(POVS_SWITCH_CONTEXT switchContext)
267 UINT32 dpNo = (UINT32) -1;
269 OVS_LOG_TRACE("Enter: switchContext:%p", switchContext);
273 dpNo = switchContext->dpNo;
274 OvsClearAllSwitchVports(switchContext);
275 OvsUninitTunnelFilter(gOvsExtDriverObject);
276 OvsUninitSwitchContext(switchContext);
278 OVS_LOG_TRACE("Exit: deleted switch %p dpNo: %d", switchContext, dpNo);
283 * --------------------------------------------------------------------------
284 * Implements filter driver's FilterRestart function.
285 * --------------------------------------------------------------------------
287 _Use_decl_annotations_
289 OvsExtRestart(NDIS_HANDLE filterModuleContext,
290 PNDIS_FILTER_RESTART_PARAMETERS filterRestartParameters)
292 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
293 NDIS_STATUS status = NDIS_STATUS_SUCCESS;
294 BOOLEAN switchActive;
296 UNREFERENCED_PARAMETER(filterRestartParameters);
298 OVS_LOG_TRACE("Enter: filterModuleContext %p",
299 filterModuleContext);
301 /* Activate the switch if this is the first restart. */
302 if (!switchContext->isActivated && !switchContext->isActivateFailed) {
303 status = OvsQuerySwitchActivationComplete(switchContext,
305 if (status != NDIS_STATUS_SUCCESS) {
306 switchContext->isActivateFailed = TRUE;
307 status = NDIS_STATUS_RESOURCES;
312 status = OvsActivateSwitch(switchContext);
314 if (status != NDIS_STATUS_SUCCESS) {
315 OVS_LOG_WARN("Failed to activate switch, dpNo:%d",
316 switchContext->dpNo);
317 status = NDIS_STATUS_RESOURCES;
323 ASSERT(switchContext->dataFlowState == OvsSwitchPaused);
324 switchContext->dataFlowState = OvsSwitchRunning;
327 OVS_LOG_TRACE("Exit: Restart switch:%p, dpNo: %d, status: %#x",
328 switchContext, switchContext->dpNo, status);
334 * --------------------------------------------------------------------------
335 * Implements filter driver's FilterPause function
336 * --------------------------------------------------------------------------
339 OvsExtPause(NDIS_HANDLE filterModuleContext,
340 PNDIS_FILTER_PAUSE_PARAMETERS pauseParameters)
342 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
344 UNREFERENCED_PARAMETER(pauseParameters);
345 OVS_LOG_TRACE("Enter: filterModuleContext %p",
346 filterModuleContext);
348 ASSERT(switchContext->dataFlowState == OvsSwitchRunning);
349 switchContext->dataFlowState = OvsSwitchPaused;
351 while(switchContext->pendingOidCount > 0) {
355 OVS_LOG_TRACE("Exit: OvsDetach Successfully");
356 return NDIS_STATUS_SUCCESS;
360 OvsInitSwitchContext(POVS_SWITCH_CONTEXT switchContext)
365 OVS_LOG_TRACE("Enter: switchContext: %p", switchContext);
367 switchContext->dispatchLock =
368 NdisAllocateRWLock(switchContext->NdisFilterHandle);
370 switchContext->portNoHashArray = (PLIST_ENTRY)OvsAllocateMemoryWithTag(
371 sizeof(LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE, OVS_SWITCH_POOL_TAG);
372 switchContext->ovsPortNameHashArray = (PLIST_ENTRY)OvsAllocateMemoryWithTag(
373 sizeof(LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE, OVS_SWITCH_POOL_TAG);
374 switchContext->portIdHashArray= (PLIST_ENTRY)OvsAllocateMemoryWithTag(
375 sizeof(LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE, OVS_SWITCH_POOL_TAG);
376 switchContext->pidHashArray = (PLIST_ENTRY)OvsAllocateMemoryWithTag(
377 sizeof(LIST_ENTRY) * OVS_MAX_PID_ARRAY_SIZE, OVS_SWITCH_POOL_TAG);
378 switchContext->tunnelVportsArray = (PLIST_ENTRY)OvsAllocateMemoryWithTag(
379 sizeof(LIST_ENTRY) * OVS_MAX_VPORT_ARRAY_SIZE, OVS_SWITCH_POOL_TAG);
380 status = OvsAllocateFlowTable(&switchContext->datapath, switchContext);
382 if (status == NDIS_STATUS_SUCCESS) {
383 status = OvsInitBufferPool(switchContext);
385 if (status != NDIS_STATUS_SUCCESS ||
386 switchContext->dispatchLock == NULL ||
387 switchContext->portNoHashArray == NULL ||
388 switchContext->ovsPortNameHashArray == NULL ||
389 switchContext->portIdHashArray== NULL ||
390 switchContext->pidHashArray == NULL ||
391 switchContext->tunnelVportsArray == NULL) {
392 if (switchContext->dispatchLock) {
393 NdisFreeRWLock(switchContext->dispatchLock);
395 if (switchContext->portNoHashArray) {
396 OvsFreeMemoryWithTag(switchContext->portNoHashArray,
397 OVS_SWITCH_POOL_TAG);
399 if (switchContext->ovsPortNameHashArray) {
400 OvsFreeMemoryWithTag(switchContext->ovsPortNameHashArray,
401 OVS_SWITCH_POOL_TAG);
403 if (switchContext->portIdHashArray) {
404 OvsFreeMemoryWithTag(switchContext->portIdHashArray,
405 OVS_SWITCH_POOL_TAG);
407 if (switchContext->pidHashArray) {
408 OvsFreeMemoryWithTag(switchContext->pidHashArray,
409 OVS_SWITCH_POOL_TAG);
412 if (switchContext->tunnelVportsArray) {
413 OvsFreeMemory(switchContext->tunnelVportsArray);
416 OvsDeleteFlowTable(&switchContext->datapath);
417 OvsCleanupBufferPool(switchContext);
419 OVS_LOG_TRACE("Exit: Failed to init switchContext");
420 return NDIS_STATUS_RESOURCES;
423 for (i = 0; i < OVS_MAX_VPORT_ARRAY_SIZE; i++) {
424 InitializeListHead(&switchContext->ovsPortNameHashArray[i]);
425 InitializeListHead(&switchContext->portIdHashArray[i]);
426 InitializeListHead(&switchContext->portNoHashArray[i]);
427 InitializeListHead(&switchContext->tunnelVportsArray[i]);
430 for (i = 0; i < OVS_MAX_PID_ARRAY_SIZE; i++) {
431 InitializeListHead(&switchContext->pidHashArray[i]);
434 NdisAllocateSpinLock(&(switchContext->pidHashLock));
435 switchContext->isActivated = FALSE;
436 switchContext->isActivateFailed = FALSE;
437 switchContext->dpNo = OVS_DP_NUMBER;
438 ovsTimeIncrementPerTick = KeQueryTimeIncrement() / 10000;
440 OVS_LOG_TRACE("Exit: Succesfully initialized switchContext: %p",
442 return NDIS_STATUS_SUCCESS;
446 OvsUninitSwitchContext(POVS_SWITCH_CONTEXT switchContext)
448 OvsReleaseSwitchContext(switchContext);
452 * --------------------------------------------------------------------------
453 * Frees up the contents of and also the switch context.
454 * --------------------------------------------------------------------------
457 OvsDeleteSwitchContext(POVS_SWITCH_CONTEXT switchContext)
459 OVS_LOG_TRACE("Enter: Delete switchContext:%p", switchContext);
461 /* We need to do cleanup for tunnel port here. */
462 ASSERT(switchContext->numHvVports == 0);
463 ASSERT(switchContext->numNonHvVports == 0);
465 NdisFreeRWLock(switchContext->dispatchLock);
466 switchContext->dispatchLock = NULL;
467 NdisFreeSpinLock(&(switchContext->pidHashLock));
468 OvsFreeMemoryWithTag(switchContext->ovsPortNameHashArray,
469 OVS_SWITCH_POOL_TAG);
470 switchContext->ovsPortNameHashArray = NULL;
471 OvsFreeMemoryWithTag(switchContext->portIdHashArray,
472 OVS_SWITCH_POOL_TAG);
473 switchContext->portIdHashArray = NULL;
474 OvsFreeMemoryWithTag(switchContext->portNoHashArray,
475 OVS_SWITCH_POOL_TAG);
476 switchContext->portNoHashArray = NULL;
477 OvsFreeMemoryWithTag(switchContext->pidHashArray,
478 OVS_SWITCH_POOL_TAG);
479 switchContext->pidHashArray = NULL;
480 OvsFreeMemory(switchContext->tunnelVportsArray);
481 switchContext->tunnelVportsArray = NULL;
482 OvsDeleteFlowTable(&switchContext->datapath);
483 OvsCleanupBufferPool(switchContext);
485 OvsFreeMemoryWithTag(switchContext, OVS_SWITCH_POOL_TAG);
486 OVS_LOG_TRACE("Exit: Delete switchContext: %p", switchContext);
490 OvsReleaseSwitchContext(POVS_SWITCH_CONTEXT switchContext)
497 ref = gOvsSwitchContextRefCount;
498 newRef = (0 == ref) ? 0 : ref - 1;
499 icxRef = InterlockedCompareExchange(&gOvsSwitchContextRefCount,
502 } while (icxRef != ref);
505 OvsDeleteSwitchContext(switchContext);
506 gOvsSwitchContext = NULL;
511 OvsAcquireSwitchContext(VOID)
519 ref = gOvsSwitchContextRefCount;
520 newRef = (0 == ref) ? 0 : ref + 1;
521 icxRef = InterlockedCompareExchange(&gOvsSwitchContextRefCount,
524 } while (icxRef != ref);
534 * --------------------------------------------------------------------------
535 * This function activates the switch by initializing it with all the runtime
536 * state. First it queries all of the MAC addresses set as custom switch policy
537 * to allow sends from, and adds tme to the property list. Then it queries the
538 * NIC list and verifies it can support all of the NICs currently connected to
539 * the switch, and adds the NICs to the NIC list.
540 * --------------------------------------------------------------------------
543 OvsActivateSwitch(POVS_SWITCH_CONTEXT switchContext)
547 ASSERT(!switchContext->isActivated);
549 OVS_LOG_TRACE("Enter: activate switch %p, dpNo: %ld",
550 switchContext, switchContext->dpNo);
552 switchContext->isActivated = TRUE;
553 status = OvsAddConfiguredSwitchPorts(switchContext);
555 if (status != NDIS_STATUS_SUCCESS) {
556 OVS_LOG_WARN("Failed to add configured switch ports");
560 status = OvsInitConfiguredSwitchNics(switchContext);
562 if (status != NDIS_STATUS_SUCCESS) {
563 OVS_LOG_WARN("Failed to add configured vports");
564 OvsClearAllSwitchVports(switchContext);
569 if (status != NDIS_STATUS_SUCCESS) {
570 switchContext->isActivated = TRUE;
573 OVS_LOG_TRACE("Exit: activate switch:%p, isActivated: %s, status = %lx",
575 (switchContext->isActivated ? "TRUE" : "FALSE"), status);
581 * --------------------------------------------------------------------------
582 * Implements filter driver's FilterNetPnPEvent function.
583 * --------------------------------------------------------------------------
586 OvsExtNetPnPEvent(NDIS_HANDLE filterModuleContext,
587 PNET_PNP_EVENT_NOTIFICATION netPnPEvent)
589 NDIS_STATUS status = NDIS_STATUS_SUCCESS;
590 POVS_SWITCH_CONTEXT switchContext = (POVS_SWITCH_CONTEXT)filterModuleContext;
592 OVS_LOG_TRACE("Enter: filterModuleContext: %p, NetEvent: %d",
593 filterModuleContext, (netPnPEvent->NetPnPEvent).NetEvent);
595 * The only interesting event is the NetEventSwitchActivate. It provides
596 * an asynchronous notification of the switch completing activation.
598 if (netPnPEvent->NetPnPEvent.NetEvent == NetEventSwitchActivate) {
599 ASSERT(switchContext->isActivated == FALSE);
600 if (switchContext->isActivated == FALSE) {
601 status = OvsActivateSwitch(switchContext);
602 OVS_LOG_TRACE("OvsExtNetPnPEvent: activated switch: %p "
603 "status: %s", switchContext,
604 status ? "TRUE" : "FALSE");
608 status = NdisFNetPnPEvent(switchContext->NdisFilterHandle,
610 OVS_LOG_TRACE("Exit: OvsExtNetPnPEvent");