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 #include "TunnelIntf.h"
  27 #define OVS_MAX_VPORT_ARRAY_SIZE 1024
  28 #define OVS_MAX_PID_ARRAY_SIZE   1024
  29
  30 #define OVS_VPORT_MASK (OVS_MAX_VPORT_ARRAY_SIZE - 1)
  31 #define OVS_PID_MASK (OVS_MAX_PID_ARRAY_SIZE - 1)
  32
  33 #define OVS_INTERNAL_VPORT_DEFAULT_INDEX 0
  34
  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_TUNNEL_INDEX_END OVS_GRE_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     /*
  99      * 'virtualExternalVport' represents default external interface. This is
 100      * a virtual interface. The friendly name of such an interface has
 101      * been observed to be: "Microsoft Default External Interface". This NIC
 102      * has 'NicIndex' == 0.
 103      *
 104      * The "real" physical external NIC has 'NicIndex' > 0. For each
 105      * external interface, virtual or physical, NDIS gives an NIC level
 106      * OID callback. Note that, even though there are multile "NICs",
 107      * there's only one underlying Hyper-V port. Thus, we get a single
 108      * NDIS port-level callback, but multiple NDIS NIC-level callbacks.
 109      *
 110      * The virtual external NIC can be accessed at 'virtualExternalVport', and
 111      * is assigned the name "external.defaultAdapter". The virtual external
 112      * NIC is not inserted into the 'portIdHashArray' since the port must not
 113      * be exposed to OVS userspace.
 114      *
 115      * The physical external NICs are assigned names "external.%INDEX%",
 116      * where '%INDEX%' represents the 'NicIndex' of the NIC.
 117      *
 118      * While adding a physical external NIC in OvsInitConfiguredSwitchNics(),
 119      * some required properties of the vport are available only at the
 120      * NDIS port-level. So, these are copied from 'virtualExternalVport'.
 121      * The vport created for the physical external NIC is inserted into the
 122      * 'portIdHashArray'.
 123      *
 124      * When the virtual external NIC is torn down or deleted, the
 125      * corresponding physical external ports are also torn down or
 126      * deleted. The number of physical external NICs is tracked by
 127      * 'numPhysicalNics'.
 128      */
 129     NDIS_SWITCH_PORT_ID     virtualExternalPortId;
 130     NDIS_SWITCH_PORT_ID     internalPortId;
 131     POVS_VPORT_ENTRY        virtualExternalVport;   // the virtual adapter vport
 132     POVS_VPORT_ENTRY        internalVport;
 133
 134     /*
 135      * 'portIdHashArray' ONLY contains ports that exist on the Hyper-V switch,
 136      * namely: VIF (vNIC) ports, external port and Hyper-V internal port.
 137      * 'numHvVports' counts the ports in 'portIdHashArray'. If a port got
 138      * deleted on the Hyper-V switch, it gets deleted from 'portIdHashArray'.
 139      * The port itself will not get deallocated if it has been added from OVS
 140      * userspace. 'numHvVports' is decremented when the port is deallocated.
 141      *
 142      * 'portNoHashArray' ONLY contains ports that are added from OVS userspace,
 143      * regardless of whether that port exists on the Hyper-V switch or not.
 144      * Tunnel ports and bridge-internal ports are examples of ports that do not
 145      * exist on the Hyper-V switch, and 'numNonHvVports' counts such ports in
 146      * 'portNoHashArray'.
 147      *
 148      * 'tunnelVportsArray' contains tunnel ports that are added from OVS
 149      * userspace. Currently only VXLAN tunnels are added in this list.
 150      *
 151      * 'ovsPortNameHashArray' contains the same entries as 'portNoHashArray' but
 152      * hashed on a different key.
 153      */
 154     PLIST_ENTRY             portIdHashArray;        // based on Hyper-V portId
 155     PLIST_ENTRY             portNoHashArray;        // based on ovs port number
 156     PLIST_ENTRY             tunnelVportsArray;      // based on ovs dst port number
 157     PLIST_ENTRY             ovsPortNameHashArray;   // based on ovsName
 158     PLIST_ENTRY             pidHashArray;           // based on packet pids
 159     NDIS_SPIN_LOCK          pidHashLock;            // Lock for pidHash table
 160
 161     UINT32                  numPhysicalNics;        // the number of physical
 162                                                     // external NICs.
 163     UINT32                  numHvVports;
 164     UINT32                  numNonHvVports;
 165
 166     /* Lock taken over the switch. This protects the ports on the switch. */
 167     PNDIS_RW_LOCK_EX        dispatchLock;
 168
 169     /* The flowtable. */
 170     OVS_DATAPATH            datapath;
 171
 172     /* Handle to the OVSExt filter driver. Same as 'gOvsExtDriverHandle'. */
 173     NDIS_HANDLE NdisFilterHandle;
 174
 175     /* Handle and callbacks exposed by the underlying hyper-v switch. */
 176     NDIS_SWITCH_CONTEXT NdisSwitchContext;
 177     NDIS_SWITCH_OPTIONAL_HANDLERS NdisSwitchHandlers;
 178
 179     volatile LONG pendingInjectedNblCount;
 180     volatile LONG pendingOidCount;
 181
 182     OVS_NBL_POOL            ovsPool;
 183 } OVS_SWITCH_CONTEXT, *POVS_SWITCH_CONTEXT;
 184
 185
 186 static __inline VOID
 187 OvsAcquireDatapathRead(OVS_DATAPATH *datapath,
 188                        LOCK_STATE_EX *lockState,
 189                        BOOLEAN dispatch)
 190 {
 191     ASSERT(datapath);
 192     NdisAcquireRWLockRead(datapath->lock, lockState,
 193                           dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
 194 }
 195
 196 static __inline VOID
 197 OvsAcquireDatapathWrite(OVS_DATAPATH *datapath,
 198                         LOCK_STATE_EX *lockState,
 199                         BOOLEAN dispatch)
 200 {
 201     ASSERT(datapath);
 202     NdisAcquireRWLockWrite(datapath->lock, lockState,
 203                            dispatch ? NDIS_RWL_AT_DISPATCH_LEVEL : 0);
 204 }
 205
 206 static __inline VOID
 207 OvsReleaseDatapath(OVS_DATAPATH *datapath,
 208                    LOCK_STATE_EX *lockState)
 209 {
 210     ASSERT(datapath);
 211     NdisReleaseRWLock(datapath->lock, lockState);
 212 }
 213
 214 BOOLEAN
 215 OvsAcquireSwitchContext(VOID);
 216
 217 VOID
 218 OvsReleaseSwitchContext(POVS_SWITCH_CONTEXT switchContext);
 219
 220 #endif /* __SWITCH_H_ */