datapath-windows/ovsext/Switch.h

   1 /*
   2  * Copyright (c) 2014 VMware, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /*
  18  * This file contains the definition of the switch object for the OVS.
  19  */
  20
  21 #ifndef __SWITCH_H_
  22 #define __SWITCH_H_ 1
  23
  24 #include "NetProto.h"
  25 #include "BufferMgmt.h"
  26 #define OVS_MAX_VPORT_ARRAY_SIZE 1024
  27 #define OVS_MAX_PID_ARRAY_SIZE   1024
  28
  29 #define OVS_VPORT_MASK (OVS_MAX_VPORT_ARRAY_SIZE - 1)
  30 #define OVS_PID_MASK (OVS_MAX_PID_ARRAY_SIZE - 1)
  31
  32 #define OVS_INTERNAL_VPORT_DEFAULT_INDEX 0
  33
  34 //Tunnel port indicies
  35 #define RESERVED_START_INDEX1    1
  36 #define OVS_TUNNEL_INDEX_START RESERVED_START_INDEX1
  37 #define OVS_VXLAN_VPORT_INDEX    2
  38 #define OVS_GRE_VPORT_INDEX      3
  39 #define OVS_GRE64_VPORT_INDEX    4
  40 #define OVS_TUNNEL_INDEX_END OVS_GRE64_VPORT_INDEX
  41
  42 #define OVS_MAX_PHYS_ADAPTERS    32
  43 #define OVS_MAX_IP_VPOR          32
  44
  45 #define OVS_HASH_BASIS   0x13578642
  46
  47 typedef struct _OVS_VPORT_ENTRY *POVS_VPORT_ENTRY;
  48
  49 typedef struct _OVS_DATAPATH
  50 {
  51    PLIST_ENTRY             flowTable;       // Contains OvsFlows.
  52    UINT32                  nFlows;          // Number of entries in flowTable.
  53
  54    // List_Links              queues[64];      // Hash table of queue IDs.
  55
  56    /* Statistics. */
  57    UINT64                  hits;            // Number of flow table hits.
  58    UINT64                  misses;          // Number of flow table misses.
  59    UINT64                  lost;            // Number of dropped misses.
  60
  61    /* Used to protect the flows in the flowtable. */
  62    PNDIS_RW_LOCK_EX        lock;
  63 } OVS_DATAPATH, *POVS_DATAPATH;
  64
  65 /*
  66  * OVS_SWITCH_CONTEXT
  67  *
  68  * The context allocated per switch., For OVS, we only
  69  * support one switch which corresponding to one datapath.
  70  * Each datapath can have multiple logical bridges configured
  71  * which is maintained by vswitchd.
  72  */
  73
  74 typedef enum OVS_SWITCH_DATAFLOW_STATE
  75 {
  76     OvsSwitchPaused,
  77     OvsSwitchRunning
  78 } OVS_SWITCH_DATAFLOW_STATE, *POVS_SWITCH_DATAFLOW_STATE;
  79
  80 typedef enum OVS_SWITCH_CONTROFLOW_STATE
  81 {
  82     OvsSwitchUnknown,
  83     OvsSwitchAttached,
  84     OvsSwitchDetached
  85 } OVS_SWITCH_CONTROLFLOW_STATE, *POVS_SWITCH_CONTROLFLOW_STATE;
  86
  87 // XXX: Take care of alignment and grouping members by cacheline
  88 typedef struct _OVS_SWITCH_CONTEXT
  89 {
  90     /* Coarse and fine-grained switch states. */
  91     OVS_SWITCH_DATAFLOW_STATE dataFlowState;
  92     OVS_SWITCH_CONTROLFLOW_STATE controlFlowState;
  93     BOOLEAN                 isActivated;
  94     BOOLEAN                 isActivateFailed;
  95
  96     UINT32                  dpNo;
  97
  98     NDIS_SWITCH_PORT_ID     externalPortId;
  99     NDIS_SWITCH_PORT_ID     internalPortId;
 100     POVS_VPORT_ENTRY        externalVport;  // the virtual adapter vport
 101     POVS_VPORT_ENTRY        internalVport;
 102
 103     /*
 104      * XXX when we support multiple VXLAN ports, we will need a list entry
 105      * instead
 106      */
 107     POVS_VPORT_ENTRY        vxlanVport;
 108
 109     PLIST_ENTRY             ovsPortNameHashArray;   // based on ovsName
 110     PLIST_ENTRY             portIdHashArray;        // based on portId
 111     PLIST_ENTRY             portNoHashArray;        // based on ovs port number
 112     PLIST_ENTRY             pidHashArray;           // based on packet pids
 113
 114     UINT32                  numPhysicalNics;
 115     UINT32                  numVports;     // include validation port
 116     UINT32                  lastPortIndex;
 117
 118     /* Lock taken over the switch. This protects the ports on the switch. */
 119     PNDIS_RW_LOCK_EX        dispatchLock;
 120
 121     /* The flowtable. */
 122     OVS_DATAPATH            datapath;
 123
 124     /* Handle to the OVSExt filter driver. Same as 'gOvsExtDriverHandle'. */
 125     NDIS_HANDLE NdisFilterHandle;
 126
 127     /* Handle and callbacks exposed by the underlying hyper-v switch. */
 128     NDIS_SWITCH_CONTEXT NdisSwitchContext;
 129     NDIS_SWITCH_OPTIONAL_HANDLERS NdisSwitchHandlers;
 130
 131     volatile LONG pendingInjectedNblCount;
 132     volatile LONG pendingOidCount;
 133
 134     OVS_NBL_POOL            ovsPool;
 135 } OVS_SWITCH_CONTEXT, *POVS_SWITCH_CONTEXT;
 136
 137
 138 static __inline VOID
 139 OvsAcquireDatapathRead(OVS_DATAPATH *datapath,
 140                        LOCK_STATE_EX *lockState,
 141                        BOOLEAN dispatch)
 142 {
 143     ASSERT(datapath);
 144     NdisAcquireRWLockRead(datapath->lock, lockState,
 145                           dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
 146 }
 147
 148 static __inline VOID
 149 OvsAcquireDatapathWrite(OVS_DATAPATH *datapath,
 150                         LOCK_STATE_EX *lockState,
 151                         BOOLEAN dispatch)
 152 {
 153     ASSERT(datapath);
 154     NdisAcquireRWLockWrite(datapath->lock, lockState,
 155                            dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
 156 }
 157
 158
 159 static __inline VOID
 160 OvsReleaseDatapath(OVS_DATAPATH *datapath,
 161                    LOCK_STATE_EX *lockState)
 162 {
 163     ASSERT(datapath);
 164     NdisReleaseRWLock(datapath->lock, lockState);
 165 }
 166
 167
 168 PVOID OvsGetExternalVport();
 169
 170 #endif /* __SWITCH_H_ */