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.
17 #ifndef __DP_INTERNAL_H_
18 #define __DP_INTERNAL_H_ 1
21 #define IFNAMSIZ IF_NAMESIZE
22 #include "../ovsext/Netlink/Netlink.h"
24 #define OVS_DP_NUMBER ((uint32_t) 0)
26 typedef __declspec(align(8)) uint64_t Ovs64AlignedU64;
27 typedef __declspec(align(8)) ovs_be64 Ovs64AlignedBe64;
30 #define OVS_MAX_PORT_NAME_LENGTH IFNAMSIZ
32 typedef struct _OVS_VPORT_GET {
35 char name[OVS_MAX_PORT_NAME_LENGTH];
36 } OVS_VPORT_GET, *POVS_VPORT_GET;
38 #define OVS_MAX_VM_UUID_LEN 128
39 #define OVS_MAX_VIF_UUID_LEN 128
41 typedef struct _OVS_VPORT_EXT_INFO {
44 uint8_t macAddress[ETH_ADDR_LEN];
45 uint8_t permMACAddress[ETH_ADDR_LEN];
46 uint8_t vmMACAddress[ETH_ADDR_LEN];
51 char name[OVS_MAX_PORT_NAME_LENGTH];
53 char vmUUID[OVS_MAX_VM_UUID_LEN];
54 char vifUUID[OVS_MAX_VIF_UUID_LEN];
55 } OVS_VPORT_EXT_INFO, *POVS_VPORT_EXT_INFO;
59 #define OVSWIN_VLAN_CFI 0x1000
61 /* Used for OvsFlowKey's dlType member for frames that have no Ethernet type,
62 * that is, pure 802.2 frames. */
63 #define OVSWIN_DL_TYPE_NONE 0x5ff
65 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
66 #define OVSWIN_NW_FRAG_ANY (1 << 0) /* Set for any IP frag. */
67 #define OVSWIN_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero
69 #define OVSWIN_NW_FRAG_MASK (OVSWIN_NW_FRAG_ANY | OVSWIN_NW_FRAG_LATER)
71 typedef struct L4Key {
72 ovs_be16 tpSrc; /* TCP/UDP/SCTP source port. */
73 ovs_be16 tpDst; /* TCP/UDP/SCTP destination port. */
76 typedef struct Ipkey {
77 ovs_be32 nwSrc; /* IPv4 source address. */
78 ovs_be32 nwDst; /* IPv4 destination address. */
79 uint8_t nwProto; /* IP protocol or low 8 bits of ARP opcode. */
80 uint8_t nwTos; /* IP ToS (including DSCP and ECN). */
81 uint8_t nwTtl; /* IP TTL/Hop Limit. */
82 uint8_t nwFrag; /* FLOW_FRAG_* flags. */
84 } IpKey; /* Size of 16 byte. */
86 typedef struct ArpKey {
87 ovs_be32 nwSrc; /* IPv4 source address. */
88 ovs_be32 nwDst; /* IPv4 destination address. */
89 uint8_t arpSha[6]; /* ARP/ND source hardware address. */
90 uint8_t arpTha[6]; /* ARP/ND target hardware address. */
91 uint8_t nwProto; /* IP protocol or low 8 bits of ARP opcode. */
93 } ArpKey; /* Size of 24 byte. */
95 typedef struct Ipv6Key {
96 struct in6_addr ipv6Src; /* IPv6 source address. */
97 struct in6_addr ipv6Dst; /* IPv6 destination address. */
98 ovs_be32 ipv6Label; /* IPv6 flow label. */
99 uint8_t nwProto; /* IP protocol or low 8 bits of ARP opcode. */
100 uint8_t nwTos; /* IP ToS (including DSCP and ECN). */
101 uint8_t nwTtl; /* IP TTL/Hop Limit. */
102 uint8_t nwFrag; /* FLOW_FRAG_* flags. */
105 } Ipv6Key; /* Size of 48 byte. */
107 typedef struct Icmp6Key {
108 struct in6_addr ipv6Src; /* IPv6 source address. */
109 struct in6_addr ipv6Dst; /* IPv6 destination address. */
110 ovs_be32 ipv6Label; /* IPv6 flow label. */
111 uint8_t nwProto; /* IP protocol or low 8 bits of ARP opcode. */
112 uint8_t nwTos; /* IP ToS (including DSCP and ECN). */
113 uint8_t nwTtl; /* IP TTL/Hop Limit. */
114 uint8_t nwFrag; /* FLOW_FRAG_* flags. */
116 uint8_t arpSha[6]; /* ARP/ND source hardware address. */
117 uint8_t arpTha[6]; /* ARP/ND target hardware address. */
118 struct in6_addr ndTarget; /* IPv6 neighbor discovery (ND) target. */
119 } Icmp6Key; /* Size of 72 byte. */
121 typedef struct L2Key {
122 uint32_t inPort; /* Port number of input port. */
130 uint8_t dlSrc[6]; /* Ethernet source address. */
131 uint8_t dlDst[6]; /* Ethernet destination address. */
132 ovs_be16 vlanTci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
133 ovs_be16 dlType; /* Ethernet frame type. */
134 } L2Key; /* Size of 24 byte. */
136 /* Number of packet attributes required to store OVS tunnel key. */
137 #define NUM_PKT_ATTR_REQUIRED 3
139 typedef union OvsIPv4TunnelKey {
155 uint64_t attr[NUM_PKT_ATTR_REQUIRED];
158 typedef __declspec(align(8)) struct OvsFlowKey {
159 OvsIPv4TunnelKey tunKey; /* 24 bytes */
160 L2Key l2; /* 24 bytes */
162 IpKey ipKey; /* size 16 */
163 ArpKey arpKey; /* size 24 */
164 Ipv6Key ipv6Key; /* size 48 */
165 Icmp6Key icmp6Key; /* size 72 */
169 #define OVS_WIN_TUNNEL_KEY_SIZE (sizeof (OvsIPv4TunnelKey))
170 #define OVS_L2_KEY_SIZE (sizeof (L2Key))
171 #define OVS_IP_KEY_SIZE (sizeof (IpKey))
172 #define OVS_IPV6_KEY_SIZE (sizeof (Ipv6Key))
173 #define OVS_ARP_KEY_SIZE (sizeof (ArpKey))
174 #define OVS_ICMPV6_KEY_SIZE (sizeof (Icmp6Key))
176 typedef struct OvsFlowStats {
177 Ovs64AlignedU64 packetCount;
178 Ovs64AlignedU64 byteCount;
183 typedef struct OvsFlowInfo {
185 struct OvsFlowStats stats;
191 FLOW_GET_KEY = 0x00000001,
192 FLOW_GET_STATS = 0x00000010,
193 FLOW_GET_ACTIONS = 0x00000100,
196 typedef struct OvsFlowDumpInput {
198 uint32_t position[2]; /* Offset hint to the start of flow dump. */
199 /* 0 - index of the hash table.
200 * 1 - nth element in the hash table index. */
201 uint32_t getFlags; /* Information to get in addition to keys. */
206 typedef struct OvsFlowDumpOutput {
207 /* Hint for the next flow dump operation. */
208 uint32_t position[2];
210 /* #flows (currently 0 or 1). In case the buffer is too small to output all
211 * actions, this field indicates actual size needed to dump all actions. */
217 typedef struct OvsFlowGetInput {
220 uint32_t getFlags; /* Information to get in addition to keys. */
221 uint32_t actionsLen; /* Sizeof of buffer for actions. */
224 typedef struct OvsFlowGetOutput {
225 OvsFlowInfo info; /* Variable length. */
229 typedef enum OvsFlowPutFlags {
230 OVSWIN_FLOW_PUT_CREATE = 1 << 0,
231 OVSWIN_FLOW_PUT_MODIFY = 1 << 1,
232 OVSWIN_FLOW_PUT_DELETE = 1 << 2,
234 OVSWIN_FLOW_PUT_CLEAR = 1 << 3
238 typedef struct OvsFlowPut {
246 #define OVS_MIN_PACKET_SIZE 60
247 typedef struct _OVS_PACKET_INFO {
249 uint32_t userDataLen;
254 OvsIPv4TunnelKey tunnelKey;
256 /* Includes user data defined as chain of netlink attributes followed by the
259 } OVS_PACKET_INFO, *POVS_PACKET_INFO;
261 typedef struct OvsPacketExecute {
272 typedef struct _OVS_EVENT_SUBSCRIBE {
277 } OVS_EVENT_SUBSCRIBE, *POVS_EVENT_SUBSCRIBE;
279 typedef struct _OVS_EVENT_POLL {
282 } OVS_EVENT_POLL, *POVS_EVENT_POLL;
285 OVS_EVENT_CONNECT = ((uint32_t)0x1 << 0),
286 OVS_EVENT_DISCONNECT = ((uint32_t)0x1 << 1),
287 OVS_EVENT_LINK_UP = ((uint32_t)0x1 << 2),
288 OVS_EVENT_LINK_DOWN = ((uint32_t)0x1 << 3),
289 OVS_EVENT_MAC_CHANGE = ((uint32_t)0x1 << 4),
290 OVS_EVENT_MTU_CHANGE = ((uint32_t)0x1 << 5),
291 OVS_EVENT_MASK_ALL = 0x3f,
295 typedef struct _OVS_EVENT_ENTRY {
298 } OVS_EVENT_ENTRY, *POVS_EVENT_ENTRY;
300 #define OVS_DEFAULT_PORT_NO 0xffffffff
301 #define OVS_DEFAULT_EVENT_STATUS 0xffffffff
303 typedef struct _OVS_EVENT_STATUS {
304 uint32_t numberEntries;
305 OVS_EVENT_ENTRY eventEntries[0];
306 } OVS_EVENT_STATUS, *POVS_EVENT_STATUS;
310 #endif /* __DP_INTERNAL_H_ */