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.
22 #include "PacketParser.h"
28 #define OVS_DBG_MOD OVS_DBG_FLOW
31 #pragma warning( push )
32 #pragma warning( disable:4127 )
34 extern PNDIS_SPIN_LOCK gOvsCtrlLock;
35 extern POVS_SWITCH_CONTEXT gOvsSwitchContext;
36 extern UINT64 ovsTimeIncrementPerTick;
38 static NTSTATUS ReportFlowInfo(OvsFlow *flow, UINT32 getFlags,
40 static NTSTATUS HandleFlowPut(OvsFlowPut *put,
41 OVS_DATAPATH *datapath,
42 struct OvsFlowStats *stats);
43 static NTSTATUS OvsPrepareFlow(OvsFlow **flow, const OvsFlowPut *put,
45 static VOID RemoveFlow(OVS_DATAPATH *datapath, OvsFlow **flow);
46 static VOID DeleteAllFlows(OVS_DATAPATH *datapath);
47 static NTSTATUS AddFlow(OVS_DATAPATH *datapath, OvsFlow *flow);
48 static VOID FreeFlow(OvsFlow *flow);
49 static VOID __inline *GetStartAddrNBL(const NET_BUFFER_LIST *_pNB);
50 static NTSTATUS _MapNlToFlowPut(POVS_MESSAGE msgIn, PNL_ATTR keyAttr,
52 PNL_ATTR flowAttrClear,
53 OvsFlowPut *mappedFlow);
54 static VOID _MapKeyAttrToFlowPut(PNL_ATTR *keyAttrs,
55 PNL_ATTR *tunnelAttrs,
58 static VOID _MapTunAttrToFlowPut(PNL_ATTR *keyAttrs,
59 PNL_ATTR *tunnelAttrs,
61 static VOID _MapNlToFlowPutFlags(PGENL_MSG_HDR genlMsgHdr,
62 PNL_ATTR flowAttrClear,
63 OvsFlowPut *mappedFlow);
65 static NTSTATUS _FlowNlGetCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
67 static NTSTATUS _FlowNlDumpCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
69 static NTSTATUS _MapFlowInfoToNl(PNL_BUFFER nlBuf,
70 OvsFlowInfo *flowInfo);
71 static NTSTATUS _MapFlowStatsToNlStats(PNL_BUFFER nlBuf,
72 OvsFlowStats *flowStats);
73 static NTSTATUS _MapFlowActionToNlAction(PNL_BUFFER nlBuf,
77 static NTSTATUS _MapFlowIpv4KeyToNlKey(PNL_BUFFER nlBuf,
78 IpKey *ipv4FlowPutKey);
79 static NTSTATUS _MapFlowIpv6KeyToNlKey(PNL_BUFFER nlBuf,
80 Ipv6Key *ipv6FlowPutKey,
81 Icmp6Key *ipv6FlowPutIcmpKey);
82 static NTSTATUS _MapFlowArpKeyToNlKey(PNL_BUFFER nlBuf,
83 ArpKey *arpFlowPutKey);
85 static NTSTATUS OvsDoDumpFlows(OvsFlowDumpInput *dumpInput,
86 OvsFlowDumpOutput *dumpOutput,
90 #define OVS_FLOW_TABLE_SIZE 2048
91 #define OVS_FLOW_TABLE_MASK (OVS_FLOW_TABLE_SIZE -1)
92 #define HASH_BUCKET(hash) ((hash) & OVS_FLOW_TABLE_MASK)
94 /* Flow family related netlink policies */
96 /* For Parsing attributes in FLOW_* commands */
97 const NL_POLICY nlFlowPolicy[] = {
98 [OVS_FLOW_ATTR_KEY] = {.type = NL_A_NESTED, .optional = FALSE},
99 [OVS_FLOW_ATTR_MASK] = {.type = NL_A_NESTED, .optional = TRUE},
100 [OVS_FLOW_ATTR_ACTIONS] = {.type = NL_A_NESTED, .optional = TRUE},
101 [OVS_FLOW_ATTR_STATS] = {.type = NL_A_UNSPEC,
102 .minLen = sizeof(struct ovs_flow_stats),
103 .maxLen = sizeof(struct ovs_flow_stats),
105 [OVS_FLOW_ATTR_TCP_FLAGS] = {NL_A_U8, .optional = TRUE},
106 [OVS_FLOW_ATTR_USED] = {NL_A_U64, .optional = TRUE}
109 /* For Parsing nested OVS_FLOW_ATTR_KEY attributes.
110 * Some of the attributes like OVS_KEY_ATTR_RECIRC_ID
111 * & OVS_KEY_ATTR_MPLS are not supported yet. */
113 const NL_POLICY nlFlowKeyPolicy[] = {
114 [OVS_KEY_ATTR_ENCAP] = {.type = NL_A_VAR_LEN, .optional = TRUE},
115 [OVS_KEY_ATTR_PRIORITY] = {.type = NL_A_UNSPEC, .minLen = 4,
116 .maxLen = 4, .optional = TRUE},
117 [OVS_KEY_ATTR_IN_PORT] = {.type = NL_A_UNSPEC, .minLen = 4,
118 .maxLen = 4, .optional = FALSE},
119 [OVS_KEY_ATTR_ETHERNET] = {.type = NL_A_UNSPEC,
120 .minLen = sizeof(struct ovs_key_ethernet),
121 .maxLen = sizeof(struct ovs_key_ethernet),
123 [OVS_KEY_ATTR_VLAN] = {.type = NL_A_UNSPEC, .minLen = 2,
124 .maxLen = 2, .optional = TRUE},
125 [OVS_KEY_ATTR_ETHERTYPE] = {.type = NL_A_UNSPEC, .minLen = 2,
126 .maxLen = 2, .optional = TRUE},
127 [OVS_KEY_ATTR_IPV4] = {.type = NL_A_UNSPEC,
128 .minLen = sizeof(struct ovs_key_ipv4),
129 .maxLen = sizeof(struct ovs_key_ipv4),
131 [OVS_KEY_ATTR_IPV6] = {.type = NL_A_UNSPEC,
132 .minLen = sizeof(struct ovs_key_ipv6),
133 .maxLen = sizeof(struct ovs_key_ipv6),
135 [OVS_KEY_ATTR_TCP] = {.type = NL_A_UNSPEC,
136 .minLen = sizeof(struct ovs_key_tcp),
137 .maxLen = sizeof(struct ovs_key_tcp),
139 [OVS_KEY_ATTR_UDP] = {.type = NL_A_UNSPEC,
140 .minLen = sizeof(struct ovs_key_udp),
141 .maxLen = sizeof(struct ovs_key_udp),
143 [OVS_KEY_ATTR_ICMP] = {.type = NL_A_UNSPEC,
144 .minLen = sizeof(struct ovs_key_icmp),
145 .maxLen = sizeof(struct ovs_key_icmp),
147 [OVS_KEY_ATTR_ICMPV6] = {.type = NL_A_UNSPEC,
148 .minLen = sizeof(struct ovs_key_icmpv6),
149 .maxLen = sizeof(struct ovs_key_icmpv6),
151 [OVS_KEY_ATTR_ARP] = {.type = NL_A_UNSPEC,
152 .minLen = sizeof(struct ovs_key_arp),
153 .maxLen = sizeof(struct ovs_key_arp),
155 [OVS_KEY_ATTR_ND] = {.type = NL_A_UNSPEC,
156 .minLen = sizeof(struct ovs_key_nd),
157 .maxLen = sizeof(struct ovs_key_nd),
159 [OVS_KEY_ATTR_SKB_MARK] = {.type = NL_A_UNSPEC, .minLen = 4,
160 .maxLen = 4, .optional = TRUE},
161 [OVS_KEY_ATTR_TUNNEL] = {.type = NL_A_VAR_LEN, .optional = TRUE},
162 [OVS_KEY_ATTR_SCTP] = {.type = NL_A_UNSPEC,
163 .minLen = sizeof(struct ovs_key_sctp),
164 .maxLen = sizeof(struct ovs_key_sctp),
166 [OVS_KEY_ATTR_TCP_FLAGS] = {.type = NL_A_UNSPEC,
167 .minLen = 2, .maxLen = 2,
169 [OVS_KEY_ATTR_DP_HASH] = {.type = NL_A_UNSPEC, .minLen = 4,
170 .maxLen = 4, .optional = TRUE},
171 [OVS_KEY_ATTR_RECIRC_ID] = {.type = NL_A_UNSPEC, .minLen = 4,
172 .maxLen = 4, .optional = TRUE},
173 [OVS_KEY_ATTR_MPLS] = {.type = NL_A_VAR_LEN, .optional = TRUE}
176 /* For Parsing nested OVS_KEY_ATTR_TUNNEL attributes */
177 const NL_POLICY nlFlowTunnelKeyPolicy[] = {
178 [OVS_TUNNEL_KEY_ATTR_ID] = {.type = NL_A_UNSPEC, .minLen = 8,
179 .maxLen = 8, .optional = TRUE},
180 [OVS_TUNNEL_KEY_ATTR_IPV4_SRC] = {.type = NL_A_UNSPEC, .minLen = 4,
181 .maxLen = 4, .optional = TRUE},
182 [OVS_TUNNEL_KEY_ATTR_IPV4_DST] = {.type = NL_A_UNSPEC, .minLen = 4 ,
183 .maxLen = 4, .optional = FALSE},
184 [OVS_TUNNEL_KEY_ATTR_TOS] = {.type = NL_A_UNSPEC, .minLen = 1,
185 .maxLen = 1, .optional = TRUE},
186 [OVS_TUNNEL_KEY_ATTR_TTL] = {.type = NL_A_UNSPEC, .minLen = 1,
187 .maxLen = 1, .optional = TRUE},
188 [OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT] = {.type = NL_A_UNSPEC, .minLen = 0,
189 .maxLen = 0, .optional = TRUE},
190 [OVS_TUNNEL_KEY_ATTR_CSUM] = {.type = NL_A_UNSPEC, .minLen = 0,
191 .maxLen = 0, .optional = TRUE},
192 [OVS_TUNNEL_KEY_ATTR_OAM] = {.type = NL_A_UNSPEC, .minLen = 0,
193 .maxLen = 0, .optional = TRUE},
194 [OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS] = {.type = NL_A_VAR_LEN,
198 /* For Parsing nested OVS_FLOW_ATTR_ACTIONS attributes */
199 const NL_POLICY nlFlowActionPolicy[] = {
200 [OVS_ACTION_ATTR_OUTPUT] = {.type = NL_A_UNSPEC, .minLen = sizeof(UINT32),
201 .maxLen = sizeof(UINT32), .optional = TRUE},
202 [OVS_ACTION_ATTR_USERSPACE] = {.type = NL_A_VAR_LEN, .optional = TRUE},
203 [OVS_ACTION_ATTR_PUSH_VLAN] = {.type = NL_A_UNSPEC,
205 sizeof(struct ovs_action_push_vlan),
207 sizeof(struct ovs_action_push_vlan),
209 [OVS_ACTION_ATTR_POP_VLAN] = {.type = NL_A_UNSPEC, .optional = TRUE},
210 [OVS_ACTION_ATTR_PUSH_MPLS] = {.type = NL_A_UNSPEC,
212 sizeof(struct ovs_action_push_mpls),
214 sizeof(struct ovs_action_push_mpls),
216 [OVS_ACTION_ATTR_POP_MPLS] = {.type = NL_A_UNSPEC,
217 .minLen = sizeof(UINT16),
218 .maxLen = sizeof(UINT16),
220 [OVS_ACTION_ATTR_RECIRC] = {.type = NL_A_UNSPEC,
221 .minLen = sizeof(UINT32),
222 .maxLen = sizeof(UINT32),
224 [OVS_ACTION_ATTR_HASH] = {.type = NL_A_UNSPEC,
225 .minLen = sizeof(struct ovs_action_hash),
226 .maxLen = sizeof(struct ovs_action_hash),
228 [OVS_ACTION_ATTR_SET] = {.type = NL_A_VAR_LEN, .optional = TRUE},
229 [OVS_ACTION_ATTR_SAMPLE] = {.type = NL_A_VAR_LEN, .optional = TRUE}
233 *----------------------------------------------------------------------------
234 * Netlink interface for flow commands.
235 *----------------------------------------------------------------------------
239 *----------------------------------------------------------------------------
240 * OvsFlowNewCmdHandler --
241 * Handler for OVS_FLOW_CMD_NEW/SET/DEL command.
242 * It also handles FLUSH case (DEL w/o any key in input)
243 *----------------------------------------------------------------------------
246 OvsFlowNlCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
249 NTSTATUS rc = STATUS_SUCCESS;
251 POVS_MESSAGE msgIn = (POVS_MESSAGE)usrParamsCtx->inputBuffer;
252 POVS_MESSAGE msgOut = (POVS_MESSAGE)usrParamsCtx->outputBuffer;
253 PNL_MSG_HDR nlMsgHdr = &(msgIn->nlMsg);
254 PGENL_MSG_HDR genlMsgHdr = &(msgIn->genlMsg);
255 POVS_HDR ovsHdr = &(msgIn->ovsHdr);
256 PNL_ATTR nlAttrs[__OVS_FLOW_ATTR_MAX];
257 UINT32 attrOffset = NLMSG_HDRLEN + GENL_HDRLEN + OVS_HDRLEN;
258 OvsFlowPut mappedFlow;
260 struct ovs_flow_stats replyStats;
261 NL_ERROR nlError = NL_ERROR_SUCCESS;
264 RtlZeroMemory(&mappedFlow, sizeof(OvsFlowPut));
265 RtlZeroMemory(&stats, sizeof(stats));
266 RtlZeroMemory(&replyStats, sizeof(replyStats));
268 if (!(usrParamsCtx->outputBuffer)) {
269 /* No output buffer */
270 rc = STATUS_INVALID_BUFFER_SIZE;
274 /* Get all the top level Flow attributes */
275 if ((NlAttrParse(nlMsgHdr, attrOffset, NlMsgAttrsLen(nlMsgHdr),
276 nlFlowPolicy, nlAttrs, ARRAY_SIZE(nlAttrs)))
278 OVS_LOG_ERROR("Attr Parsing failed for msg: %p",
280 rc = STATUS_INVALID_PARAMETER;
284 /* FLOW_DEL command w/o any key input is a flush case. */
285 if ((genlMsgHdr->cmd == OVS_FLOW_CMD_DEL) &&
286 (!(nlAttrs[OVS_FLOW_ATTR_KEY]))) {
288 rc = OvsFlushFlowIoctl(ovsHdr->dp_ifindex);
290 if (rc == STATUS_SUCCESS) {
291 /* XXX: refactor this code. */
292 /* So far so good. Prepare the reply for userspace */
293 NlBufInit(&nlBuf, usrParamsCtx->outputBuffer,
294 usrParamsCtx->outputLength);
296 /* Prepare nl Msg headers */
297 ok = NlFillOvsMsg(&nlBuf, nlMsgHdr->nlmsgType, 0,
298 nlMsgHdr->nlmsgSeq, nlMsgHdr->nlmsgPid,
299 genlMsgHdr->cmd, OVS_FLOW_VERSION,
302 *replyLen = msgOut->nlMsg.nlmsgLen;
304 rc = STATUS_INVALID_BUFFER_SIZE;
311 if ((rc = _MapNlToFlowPut(msgIn, nlAttrs[OVS_FLOW_ATTR_KEY],
312 nlAttrs[OVS_FLOW_ATTR_ACTIONS], nlAttrs[OVS_FLOW_ATTR_CLEAR],
315 OVS_LOG_ERROR("Conversion to OvsFlowPut failed");
319 rc = OvsPutFlowIoctl(&mappedFlow, sizeof (struct OvsFlowPut),
321 if (rc != STATUS_SUCCESS) {
322 OVS_LOG_ERROR("OvsFlowPut failed.");
326 replyStats.n_packets = stats.packetCount;
327 replyStats.n_bytes = stats.byteCount;
329 /* So far so good. Prepare the reply for userspace */
330 NlBufInit(&nlBuf, usrParamsCtx->outputBuffer,
331 usrParamsCtx->outputLength);
333 /* Prepare nl Msg headers */
334 ok = NlFillOvsMsg(&nlBuf, nlMsgHdr->nlmsgType, 0,
335 nlMsgHdr->nlmsgSeq, nlMsgHdr->nlmsgPid,
336 genlMsgHdr->cmd, OVS_FLOW_VERSION,
339 rc = STATUS_INVALID_BUFFER_SIZE;
345 /* Append OVS_FLOW_ATTR_STATS attribute */
346 if (!NlMsgPutTailUnspec(&nlBuf, OVS_FLOW_ATTR_STATS,
347 (PCHAR)(&replyStats), sizeof(replyStats))) {
348 OVS_LOG_ERROR("Adding OVS_FLOW_ATTR_STATS attribute failed.");
349 rc = STATUS_INVALID_BUFFER_SIZE;
353 msgOut->nlMsg.nlmsgLen = NLMSG_ALIGN(NlBufSize(&nlBuf));
354 *replyLen = msgOut->nlMsg.nlmsgLen;
358 if (nlError != NL_ERROR_SUCCESS) {
359 POVS_MESSAGE_ERROR msgError = (POVS_MESSAGE_ERROR)
360 usrParamsCtx->outputBuffer;
361 NlBuildErrorMsg(msgIn, msgError, nlError);
362 *replyLen = msgError->nlMsg.nlmsgLen;
370 *----------------------------------------------------------------------------
371 * OvsFlowNlGetCmdHandler --
372 * Handler for OVS_FLOW_CMD_GET/DUMP commands.
373 *----------------------------------------------------------------------------
376 OvsFlowNlGetCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
379 NTSTATUS status = STATUS_SUCCESS;
380 NL_ERROR nlError = NL_ERROR_SUCCESS;
381 POVS_MESSAGE msgIn = (POVS_MESSAGE)usrParamsCtx->inputBuffer;
383 if (usrParamsCtx->devOp == OVS_TRANSACTION_DEV_OP) {
384 status = _FlowNlGetCmdHandler(usrParamsCtx, replyLen);
386 /* No trasanctional errors as of now.
387 * If we have something then we need to convert rc to
389 if ((nlError != NL_ERROR_SUCCESS) &&
390 (usrParamsCtx->outputBuffer)) {
391 POVS_MESSAGE_ERROR msgError = (POVS_MESSAGE_ERROR)
392 usrParamsCtx->outputBuffer;
393 NlBuildErrorMsg(msgIn, msgError, nlError);
394 *replyLen = msgError->nlMsg.nlmsgLen;
395 status = STATUS_SUCCESS;
399 status = _FlowNlDumpCmdHandler(usrParamsCtx, replyLen);
407 *----------------------------------------------------------------------------
408 * _FlowNlGetCmdHandler --
409 * Handler for OVS_FLOW_CMD_GET command.
410 *----------------------------------------------------------------------------
413 _FlowNlGetCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
416 NTSTATUS rc = STATUS_SUCCESS;
417 POVS_MESSAGE msgIn = (POVS_MESSAGE)usrParamsCtx->inputBuffer;
418 PNL_MSG_HDR nlMsgHdr = &(msgIn->nlMsg);
419 POVS_HDR ovsHdr = &(msgIn->ovsHdr);
420 PNL_MSG_HDR nlMsgOutHdr = NULL;
421 UINT32 attrOffset = NLMSG_HDRLEN + GENL_HDRLEN + OVS_HDRLEN;
422 PNL_ATTR nlAttrs[__OVS_FLOW_ATTR_MAX];
424 OvsFlowGetInput getInput;
425 OvsFlowGetOutput getOutput;
427 PNL_ATTR keyAttrs[__OVS_KEY_ATTR_MAX];
428 PNL_ATTR tunnelAttrs[__OVS_TUNNEL_KEY_ATTR_MAX];
430 NlBufInit(&nlBuf, usrParamsCtx->outputBuffer,
431 usrParamsCtx->outputLength);
432 RtlZeroMemory(&getInput, sizeof(OvsFlowGetInput));
433 RtlZeroMemory(&getOutput, sizeof(OvsFlowGetOutput));
434 UINT32 keyAttrOffset = 0;
435 UINT32 tunnelKeyAttrOffset = 0;
438 if (usrParamsCtx->inputLength > usrParamsCtx->outputLength) {
439 /* Should not be the case.
440 * We'll be copying the flow keys back from
441 * input buffer to output buffer. */
442 rc = STATUS_INVALID_PARAMETER;
443 OVS_LOG_ERROR("inputLength: %d GREATER THEN outputLength: %d",
444 usrParamsCtx->inputLength, usrParamsCtx->outputLength);
448 /* Get all the top level Flow attributes */
449 if ((NlAttrParse(nlMsgHdr, attrOffset, NlMsgAttrsLen(nlMsgHdr),
450 nlFlowPolicy, nlAttrs, ARRAY_SIZE(nlAttrs)))
452 OVS_LOG_ERROR("Attr Parsing failed for msg: %p",
454 rc = STATUS_INVALID_PARAMETER;
458 keyAttrOffset = (UINT32)((PCHAR) nlAttrs[OVS_FLOW_ATTR_KEY] -
461 /* Get flow keys attributes */
462 if ((NlAttrParseNested(nlMsgHdr, keyAttrOffset,
463 NlAttrLen(nlAttrs[OVS_FLOW_ATTR_KEY]),
464 nlFlowKeyPolicy, keyAttrs, ARRAY_SIZE(keyAttrs)))
466 OVS_LOG_ERROR("Key Attr Parsing failed for msg: %p",
468 rc = STATUS_INVALID_PARAMETER;
472 if (keyAttrs[OVS_KEY_ATTR_TUNNEL]) {
473 tunnelKeyAttrOffset = (UINT32)((PCHAR)
474 (keyAttrs[OVS_KEY_ATTR_TUNNEL])
477 /* Get tunnel keys attributes */
478 if ((NlAttrParseNested(nlMsgHdr, tunnelKeyAttrOffset,
479 NlAttrLen(keyAttrs[OVS_KEY_ATTR_TUNNEL]),
480 nlFlowTunnelKeyPolicy,
481 tunnelAttrs, ARRAY_SIZE(tunnelAttrs)))
483 OVS_LOG_ERROR("Tunnel key Attr Parsing failed for msg: %p",
485 rc = STATUS_INVALID_PARAMETER;
490 _MapKeyAttrToFlowPut(keyAttrs, tunnelAttrs,
493 getInput.dpNo = ovsHdr->dp_ifindex;
494 getInput.getFlags = FLOW_GET_STATS | FLOW_GET_ACTIONS;
496 /* 4th argument is a no op.
497 * We are keeping this argument to be compatible
498 * with our dpif-windows based interface. */
499 rc = OvsGetFlowIoctl(&getInput, &getOutput);
500 if (rc != STATUS_SUCCESS) {
501 OVS_LOG_ERROR("OvsGetFlowIoctl failed.");
505 /* Lets prepare the reply. */
506 nlMsgOutHdr = (PNL_MSG_HDR)(NlBufAt(&nlBuf, 0, 0));
508 /* Input already has all the attributes for the flow key.
509 * Lets copy the values back. */
510 ok = NlMsgPutTail(&nlBuf, (PCHAR)(usrParamsCtx->inputBuffer),
511 usrParamsCtx->inputLength);
513 OVS_LOG_ERROR("Could not copy the data to the buffer tail");
517 rc = _MapFlowStatsToNlStats(&nlBuf, &((getOutput.info).stats));
518 if (rc != STATUS_SUCCESS) {
519 OVS_LOG_ERROR("_OvsFlowMapFlowKeyToNlStats failed.");
523 rc = _MapFlowActionToNlAction(&nlBuf, ((getOutput.info).actionsLen),
524 getOutput.info.actions);
525 if (rc != STATUS_SUCCESS) {
526 OVS_LOG_ERROR("_MapFlowActionToNlAction failed.");
530 NlMsgSetSize(nlMsgOutHdr, NlBufSize(&nlBuf));
531 NlMsgAlignSize(nlMsgOutHdr);
532 *replyLen += NlMsgSize(nlMsgOutHdr);
539 *----------------------------------------------------------------------------
540 * _FlowNlDumpCmdHandler --
541 * Handler for OVS_FLOW_CMD_DUMP command.
542 *----------------------------------------------------------------------------
545 _FlowNlDumpCmdHandler(POVS_USER_PARAMS_CONTEXT usrParamsCtx,
548 NTSTATUS rc = STATUS_SUCCESS;
549 UINT32 temp = 0; /* To keep compiler happy for calling OvsDoDumpFlows */
551 POVS_OPEN_INSTANCE instance = (POVS_OPEN_INSTANCE)
552 (usrParamsCtx->ovsInstance);
554 if (usrParamsCtx->devOp == OVS_WRITE_DEV_OP) {
556 OvsSetupDumpStart(usrParamsCtx);
560 POVS_MESSAGE msgIn = instance->dumpState.ovsMsg;
561 PNL_MSG_HDR nlMsgHdr = &(msgIn->nlMsg);
562 PGENL_MSG_HDR genlMsgHdr = &(msgIn->genlMsg);
563 POVS_HDR ovsHdr = &(msgIn->ovsHdr);
564 PNL_MSG_HDR nlMsgOutHdr = NULL;
565 UINT32 hdrOffset = 0;
568 OvsFlowDumpOutput dumpOutput;
569 OvsFlowDumpInput dumpInput;
572 NlBufInit(&nlBuf, usrParamsCtx->outputBuffer,
573 usrParamsCtx->outputLength);
575 ASSERT(usrParamsCtx->devOp == OVS_READ_DEV_OP);
576 ASSERT(usrParamsCtx->outputLength);
578 RtlZeroMemory(&dumpInput, sizeof(OvsFlowDumpInput));
579 RtlZeroMemory(&dumpOutput, sizeof(OvsFlowDumpOutput));
581 dumpInput.dpNo = ovsHdr->dp_ifindex;
582 dumpInput.getFlags = FLOW_GET_KEY | FLOW_GET_STATS | FLOW_GET_ACTIONS;
584 /* Lets provide as many flows to userspace as possible. */
586 dumpInput.position[0] = instance->dumpState.index[0];
587 dumpInput.position[1] = instance->dumpState.index[1];
589 rc = OvsDoDumpFlows(&dumpInput, &dumpOutput, &temp);
590 if (rc != STATUS_SUCCESS) {
591 OVS_LOG_ERROR("OvsDoDumpFlows failed with rc: %d", rc);
595 /* Done with Dump, send NLMSG_DONE */
596 if (!(dumpOutput.n)) {
599 OVS_LOG_INFO("Dump Done");
601 nlMsgOutHdr = (PNL_MSG_HDR)(NlBufAt(&nlBuf, NlBufSize(&nlBuf), 0));
602 ok = NlFillNlHdr(&nlBuf, NLMSG_DONE, NLM_F_MULTI,
603 nlMsgHdr->nlmsgSeq, nlMsgHdr->nlmsgPid);
606 rc = STATUS_INVALID_BUFFER_SIZE;
607 OVS_LOG_ERROR("Unable to prepare DUMP_DONE reply.");
613 NlMsgAlignSize(nlMsgOutHdr);
614 *replyLen += NlMsgSize(nlMsgOutHdr);
616 FreeUserDumpState(instance);
621 hdrOffset = NlBufSize(&nlBuf);
622 nlMsgOutHdr = (PNL_MSG_HDR)(NlBufAt(&nlBuf, hdrOffset, 0));
625 ok = NlFillOvsMsg(&nlBuf, nlMsgHdr->nlmsgType, NLM_F_MULTI,
626 nlMsgHdr->nlmsgSeq, nlMsgHdr->nlmsgPid,
627 genlMsgHdr->cmd, genlMsgHdr->version,
631 /* Reset rc to success so that we can
632 * send already added messages to user space. */
637 /* Time to add attributes */
638 rc = _MapFlowInfoToNl(&nlBuf, &(dumpOutput.flow));
639 if (rc != STATUS_SUCCESS) {
640 /* Adding the attribute failed, we are out of
641 space in the buffer, remove the appended OVS header */
642 NlMsgSetSize(nlMsgOutHdr,
643 NlMsgSize(nlMsgOutHdr) -
644 sizeof(struct _OVS_MESSAGE));
646 /* Reset rc to success so that we can
647 * send already added messages to user space. */
652 NlMsgSetSize(nlMsgOutHdr, NlBufSize(&nlBuf) - hdrOffset);
653 NlMsgAlignSize(nlMsgOutHdr);
654 *replyLen += NlMsgSize(nlMsgOutHdr);
655 instance->dumpState.index[0] = dumpOutput.position[0];
656 instance->dumpState.index[1] = dumpOutput.position[1];
665 *----------------------------------------------------------------------------
666 * _MapFlowInfoToNl --
667 * Maps OvsFlowInfo to Netlink attributes.
668 *----------------------------------------------------------------------------
671 _MapFlowInfoToNl(PNL_BUFFER nlBuf, OvsFlowInfo *flowInfo)
673 NTSTATUS rc = STATUS_SUCCESS;
675 rc = MapFlowKeyToNlKey(nlBuf, &(flowInfo->key), OVS_FLOW_ATTR_KEY,
676 OVS_KEY_ATTR_TUNNEL);
677 if (rc != STATUS_SUCCESS) {
681 rc = _MapFlowStatsToNlStats(nlBuf, &(flowInfo->stats));
682 if (rc != STATUS_SUCCESS) {
686 rc = _MapFlowActionToNlAction(nlBuf, flowInfo->actionsLen,
688 if (rc != STATUS_SUCCESS) {
697 *----------------------------------------------------------------------------
698 * _MapFlowStatsToNlStats --
699 * Maps OvsFlowStats to OVS_FLOW_ATTR_STATS attribute.
700 *----------------------------------------------------------------------------
703 _MapFlowStatsToNlStats(PNL_BUFFER nlBuf, OvsFlowStats *flowStats)
705 NTSTATUS rc = STATUS_SUCCESS;
706 struct ovs_flow_stats replyStats;
708 replyStats.n_packets = flowStats->packetCount;
709 replyStats.n_bytes = flowStats->byteCount;
711 if (!NlMsgPutTailU64(nlBuf, OVS_FLOW_ATTR_USED, flowStats->used)) {
712 rc = STATUS_INVALID_BUFFER_SIZE;
716 if (!NlMsgPutTailUnspec(nlBuf, OVS_FLOW_ATTR_STATS,
717 (PCHAR)(&replyStats),
718 sizeof(struct ovs_flow_stats))) {
719 rc = STATUS_INVALID_BUFFER_SIZE;
723 if (!NlMsgPutTailU8(nlBuf, OVS_FLOW_ATTR_TCP_FLAGS, flowStats->tcpFlags)) {
724 rc = STATUS_INVALID_BUFFER_SIZE;
733 *----------------------------------------------------------------------------
734 * _MapFlowActionToNlAction --
735 * Maps flow actions to OVS_FLOW_ATTR_ACTION attribute.
736 *----------------------------------------------------------------------------
739 _MapFlowActionToNlAction(PNL_BUFFER nlBuf, uint32_t actionsLen,
742 NTSTATUS rc = STATUS_SUCCESS;
745 offset = NlMsgStartNested(nlBuf, OVS_FLOW_ATTR_ACTIONS);
747 /* Starting the nested attribute failed. */
748 rc = STATUS_INVALID_BUFFER_SIZE;
749 goto error_nested_start;
752 if (!NlBufCopyAtTail(nlBuf, (PCHAR)actions, actionsLen)) {
753 /* Adding a nested attribute failed. */
754 rc = STATUS_INVALID_BUFFER_SIZE;
759 NlMsgEndNested(nlBuf, offset);
766 *----------------------------------------------------------------------------
767 * MapFlowKeyToNlKey --
768 * Maps OvsFlowKey to OVS_FLOW_ATTR_KEY attribute.
769 *----------------------------------------------------------------------------
772 MapFlowKeyToNlKey(PNL_BUFFER nlBuf,
777 NTSTATUS rc = STATUS_SUCCESS;
778 struct ovs_key_ethernet ethKey;
781 offset = NlMsgStartNested(nlBuf, keyType);
783 /* Starting the nested attribute failed. */
784 rc = STATUS_UNSUCCESSFUL;
785 goto error_nested_start;
788 /* Ethernet header */
789 RtlCopyMemory(&(ethKey.eth_src), flowKey->l2.dlSrc, ETH_ADDR_LEN);
790 RtlCopyMemory(&(ethKey.eth_dst), flowKey->l2.dlDst, ETH_ADDR_LEN);
792 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_ETHERNET,
794 sizeof(struct ovs_key_ethernet))) {
795 rc = STATUS_UNSUCCESSFUL;
799 if (!NlMsgPutTailU32(nlBuf, OVS_KEY_ATTR_IN_PORT,
800 flowKey->l2.inPort)) {
801 rc = STATUS_UNSUCCESSFUL;
805 if (!NlMsgPutTailU16(nlBuf, OVS_KEY_ATTR_ETHERTYPE,
806 flowKey->l2.dlType)) {
807 rc = STATUS_UNSUCCESSFUL;
811 if (flowKey->l2.vlanTci) {
812 if (!NlMsgPutTailU16(nlBuf, OVS_KEY_ATTR_VLAN,
813 flowKey->l2.vlanTci)) {
814 rc = STATUS_UNSUCCESSFUL;
819 /* ==== L3 + L4 ==== */
820 switch (ntohs(flowKey->l2.dlType)) {
821 case ETH_TYPE_IPV4: {
822 IpKey *ipv4FlowPutKey = &(flowKey->ipKey);
823 rc = _MapFlowIpv4KeyToNlKey(nlBuf, ipv4FlowPutKey);
827 case ETH_TYPE_IPV6: {
828 Ipv6Key *ipv6FlowPutKey = &(flowKey->ipv6Key);
829 Icmp6Key *icmpv6FlowPutKey = &(flowKey->icmp6Key);
830 rc = _MapFlowIpv6KeyToNlKey(nlBuf, ipv6FlowPutKey,
836 case ETH_TYPE_RARP: {
837 ArpKey *arpFlowPutKey = &(flowKey->arpKey);
838 rc = _MapFlowArpKeyToNlKey(nlBuf, arpFlowPutKey);
846 if (rc != STATUS_SUCCESS) {
850 if (flowKey->tunKey.dst) {
851 rc = MapFlowTunKeyToNlKey(nlBuf, &(flowKey->tunKey),
853 if (rc != STATUS_SUCCESS) {
859 NlMsgEndNested(nlBuf, offset);
865 *----------------------------------------------------------------------------
866 * MapFlowTunKeyToNlKey --
867 * Maps OvsIPv4TunnelKey to OVS_TUNNEL_KEY_ATTR_ID attribute.
868 *----------------------------------------------------------------------------
871 MapFlowTunKeyToNlKey(PNL_BUFFER nlBuf,
872 OvsIPv4TunnelKey *tunKey,
875 NTSTATUS rc = STATUS_SUCCESS;
878 offset = NlMsgStartNested(nlBuf, tunKeyType);
880 /* Starting the nested attribute failed. */
881 rc = STATUS_UNSUCCESSFUL;
882 goto error_nested_start;
885 if (!NlMsgPutTailU64(nlBuf, OVS_TUNNEL_KEY_ATTR_ID,
887 rc = STATUS_UNSUCCESSFUL;
891 if (!NlMsgPutTailU32(nlBuf, OVS_TUNNEL_KEY_ATTR_IPV4_DST,
893 rc = STATUS_UNSUCCESSFUL;
897 if (!NlMsgPutTailU32(nlBuf, OVS_TUNNEL_KEY_ATTR_IPV4_SRC,
899 rc = STATUS_UNSUCCESSFUL;
903 if (!NlMsgPutTailU8(nlBuf, OVS_TUNNEL_KEY_ATTR_TOS,
905 rc = STATUS_UNSUCCESSFUL;
909 if (!NlMsgPutTailU8(nlBuf, OVS_TUNNEL_KEY_ATTR_TTL,
911 rc = STATUS_UNSUCCESSFUL;
916 NlMsgEndNested(nlBuf, offset);
922 *----------------------------------------------------------------------------
923 * _MapFlowTunKeyToNlKey --
924 * Maps OvsIPv4FlowPutKey to OVS_KEY_ATTR_IPV4 attribute.
925 *----------------------------------------------------------------------------
928 _MapFlowIpv4KeyToNlKey(PNL_BUFFER nlBuf, IpKey *ipv4FlowPutKey)
930 NTSTATUS rc = STATUS_SUCCESS;
931 struct ovs_key_ipv4 ipv4Key;
933 ipv4Key.ipv4_src = ipv4FlowPutKey->nwSrc;
934 ipv4Key.ipv4_dst = ipv4FlowPutKey->nwDst;
935 ipv4Key.ipv4_proto = ipv4FlowPutKey->nwProto;
936 ipv4Key.ipv4_tos = ipv4FlowPutKey->nwTos;
937 ipv4Key.ipv4_ttl = ipv4FlowPutKey->nwTtl;
938 ipv4Key.ipv4_frag = ipv4FlowPutKey->nwFrag;
940 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_IPV4,
942 sizeof(struct ovs_key_ipv4))) {
943 rc = STATUS_UNSUCCESSFUL;
947 switch (ipv4Key.ipv4_proto) {
949 struct ovs_key_tcp tcpKey;
950 tcpKey.tcp_src = ipv4FlowPutKey->l4.tpSrc;
951 tcpKey.tcp_dst = ipv4FlowPutKey->l4.tpDst;
952 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_TCP,
955 rc = STATUS_UNSUCCESSFUL;
962 struct ovs_key_udp udpKey;
963 udpKey.udp_src = ipv4FlowPutKey->l4.tpSrc;
964 udpKey.udp_dst = ipv4FlowPutKey->l4.tpDst;
965 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_UDP,
968 rc = STATUS_UNSUCCESSFUL;
975 struct ovs_key_sctp sctpKey;
976 sctpKey.sctp_src = ipv4FlowPutKey->l4.tpSrc;
977 sctpKey.sctp_dst = ipv4FlowPutKey->l4.tpDst;
978 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_SCTP,
981 rc = STATUS_UNSUCCESSFUL;
988 struct ovs_key_icmp icmpKey;
989 /* XXX: revisit to see if htons is needed */
990 icmpKey.icmp_type = (__u8)(ipv4FlowPutKey->l4.tpSrc);
991 icmpKey.icmp_code = (__u8)(ipv4FlowPutKey->l4.tpDst);
993 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_ICMP,
996 rc = STATUS_UNSUCCESSFUL;
1011 *----------------------------------------------------------------------------
1012 * _MapFlowIpv6KeyToNlKey --
1013 * Maps _MapFlowIpv6KeyToNlKey to OVS_KEY_ATTR_IPV6 attribute.
1014 *----------------------------------------------------------------------------
1017 _MapFlowIpv6KeyToNlKey(PNL_BUFFER nlBuf, Ipv6Key *ipv6FlowPutKey,
1018 Icmp6Key *icmpv6FlowPutKey)
1020 NTSTATUS rc = STATUS_SUCCESS;
1021 struct ovs_key_ipv6 ipv6Key;
1023 RtlCopyMemory(&(ipv6Key.ipv6_src), &ipv6FlowPutKey->ipv6Src,
1024 sizeof ipv6Key.ipv6_src);
1025 RtlCopyMemory(&(ipv6Key.ipv6_dst), &ipv6FlowPutKey->ipv6Dst,
1026 sizeof ipv6Key.ipv6_dst);
1028 ipv6Key.ipv6_label = ipv6FlowPutKey->ipv6Label;
1029 ipv6Key.ipv6_proto = ipv6FlowPutKey->nwProto;
1030 ipv6Key.ipv6_tclass = ipv6FlowPutKey->nwTos;
1031 ipv6Key.ipv6_hlimit = ipv6FlowPutKey->nwTtl;
1032 ipv6Key.ipv6_frag = ipv6FlowPutKey->nwFrag;
1034 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_IPV6,
1037 rc = STATUS_UNSUCCESSFUL;
1041 switch (ipv6Key.ipv6_proto) {
1043 struct ovs_key_tcp tcpKey;
1044 tcpKey.tcp_src = ipv6FlowPutKey->l4.tpSrc;
1045 tcpKey.tcp_dst = ipv6FlowPutKey->l4.tpDst;
1046 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_TCP,
1049 rc = STATUS_UNSUCCESSFUL;
1056 struct ovs_key_udp udpKey;
1057 udpKey.udp_src = ipv6FlowPutKey->l4.tpSrc;
1058 udpKey.udp_dst = ipv6FlowPutKey->l4.tpDst;
1059 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_UDP,
1062 rc = STATUS_UNSUCCESSFUL;
1068 case IPPROTO_SCTP: {
1069 struct ovs_key_sctp sctpKey;
1070 sctpKey.sctp_src = ipv6FlowPutKey->l4.tpSrc;
1071 sctpKey.sctp_dst = ipv6FlowPutKey->l4.tpDst;
1072 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_SCTP,
1075 rc = STATUS_UNSUCCESSFUL;
1081 case IPPROTO_ICMPV6: {
1082 struct ovs_key_icmpv6 icmpV6Key;
1083 struct ovs_key_nd ndKey;
1085 /* XXX: revisit to see if htons is needed */
1086 icmpV6Key.icmpv6_type = (__u8)(icmpv6FlowPutKey->l4.tpSrc);
1087 icmpV6Key.icmpv6_code = (__u8)(icmpv6FlowPutKey->l4.tpDst);
1089 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_ICMPV6,
1090 (PCHAR)(&icmpV6Key),
1091 sizeof(icmpV6Key))) {
1092 rc = STATUS_UNSUCCESSFUL;
1096 RtlCopyMemory(&(ndKey.nd_target), &icmpv6FlowPutKey->ndTarget,
1097 sizeof(icmpv6FlowPutKey->ndTarget));
1098 RtlCopyMemory(&(ndKey.nd_sll), &icmpv6FlowPutKey->arpSha,
1100 RtlCopyMemory(&(ndKey.nd_tll), &icmpv6FlowPutKey->arpTha,
1102 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_ND,
1105 rc = STATUS_UNSUCCESSFUL;
1121 *----------------------------------------------------------------------------
1122 * _MapFlowArpKeyToNlKey --
1123 * Maps _MapFlowArpKeyToNlKey to OVS_KEY_ATTR_ARP attribute.
1124 *----------------------------------------------------------------------------
1127 _MapFlowArpKeyToNlKey(PNL_BUFFER nlBuf, ArpKey *arpFlowPutKey)
1129 NTSTATUS rc = STATUS_SUCCESS;
1130 struct ovs_key_arp arpKey;
1132 arpKey.arp_sip = arpFlowPutKey->nwSrc;
1133 arpKey.arp_tip = arpFlowPutKey->nwDst;
1135 RtlCopyMemory(&(arpKey.arp_sha), arpFlowPutKey->arpSha, ETH_ADDR_LEN);
1136 RtlCopyMemory(&(arpKey.arp_tha), arpFlowPutKey->arpTha, ETH_ADDR_LEN);
1139 * Flow_Extract() stores 'nwProto' in host order for ARP since 'nwProto' is
1140 * 1 byte field and the ARP opcode is 2 bytes, and all of the kernel code
1141 * understand this while looking at an ARP key.
1142 * While we pass up the ARP key to userspace, convert from host order to
1143 * network order. Likewise, when processing an ARP key from userspace,
1144 * convert from network order to host order.
1146 * It is important to note that the flow table stores the ARP opcode field
1149 arpKey.arp_op = htons(arpFlowPutKey->nwProto);
1151 if (!NlMsgPutTailUnspec(nlBuf, OVS_KEY_ATTR_ARP,
1154 rc = STATUS_UNSUCCESSFUL;
1163 *----------------------------------------------------------------------------
1164 * _MapNlToFlowPut --
1165 * Maps input netlink message to OvsFlowPut.
1166 *----------------------------------------------------------------------------
1169 _MapNlToFlowPut(POVS_MESSAGE msgIn, PNL_ATTR keyAttr,
1170 PNL_ATTR actionAttr, PNL_ATTR flowAttrClear,
1171 OvsFlowPut *mappedFlow)
1173 NTSTATUS rc = STATUS_SUCCESS;
1174 PNL_MSG_HDR nlMsgHdr = &(msgIn->nlMsg);
1175 PGENL_MSG_HDR genlMsgHdr = &(msgIn->genlMsg);
1176 POVS_HDR ovsHdr = &(msgIn->ovsHdr);
1178 UINT32 keyAttrOffset = (UINT32)((PCHAR)keyAttr - (PCHAR)nlMsgHdr);
1179 UINT32 tunnelKeyAttrOffset;
1181 PNL_ATTR keyAttrs[__OVS_KEY_ATTR_MAX] = {NULL};
1182 PNL_ATTR tunnelAttrs[__OVS_TUNNEL_KEY_ATTR_MAX] = {NULL};
1184 /* Get flow keys attributes */
1185 if ((NlAttrParseNested(nlMsgHdr, keyAttrOffset, NlAttrLen(keyAttr),
1186 nlFlowKeyPolicy, keyAttrs, ARRAY_SIZE(keyAttrs)))
1188 OVS_LOG_ERROR("Key Attr Parsing failed for msg: %p",
1190 rc = STATUS_INVALID_PARAMETER;
1194 if (keyAttrs[OVS_KEY_ATTR_TUNNEL]) {
1195 tunnelKeyAttrOffset = (UINT32)((PCHAR)
1196 (keyAttrs[OVS_KEY_ATTR_TUNNEL])
1199 /* Get tunnel keys attributes */
1200 if ((NlAttrParseNested(nlMsgHdr, tunnelKeyAttrOffset,
1201 NlAttrLen(keyAttrs[OVS_KEY_ATTR_TUNNEL]),
1202 nlFlowTunnelKeyPolicy,
1203 tunnelAttrs, ARRAY_SIZE(tunnelAttrs)))
1205 OVS_LOG_ERROR("Tunnel key Attr Parsing failed for msg: %p",
1207 rc = STATUS_INVALID_PARAMETER;
1212 _MapKeyAttrToFlowPut(keyAttrs, tunnelAttrs,
1213 &(mappedFlow->key));
1215 /* Map the action */
1217 mappedFlow->actionsLen = NlAttrGetSize(actionAttr);
1218 mappedFlow->actions = NlAttrGet(actionAttr);
1221 mappedFlow->dpNo = ovsHdr->dp_ifindex;
1223 _MapNlToFlowPutFlags(genlMsgHdr, flowAttrClear,
1231 *----------------------------------------------------------------------------
1232 * _MapNlToFlowPutFlags --
1233 * Maps netlink message to OvsFlowPut->flags.
1234 *----------------------------------------------------------------------------
1237 _MapNlToFlowPutFlags(PGENL_MSG_HDR genlMsgHdr,
1238 PNL_ATTR flowAttrClear, OvsFlowPut *mappedFlow)
1242 switch (genlMsgHdr->cmd) {
1243 case OVS_FLOW_CMD_NEW:
1244 flags |= OVSWIN_FLOW_PUT_CREATE;
1246 case OVS_FLOW_CMD_DEL:
1247 flags |= OVSWIN_FLOW_PUT_DELETE;
1249 case OVS_FLOW_CMD_SET:
1250 flags |= OVSWIN_FLOW_PUT_MODIFY;
1256 if (flowAttrClear) {
1257 flags |= OVSWIN_FLOW_PUT_CLEAR;
1260 mappedFlow->flags = flags;
1264 *----------------------------------------------------------------------------
1265 * _MapKeyAttrToFlowPut --
1266 * Converts FLOW_KEY attribute to OvsFlowPut->key.
1267 *----------------------------------------------------------------------------
1270 _MapKeyAttrToFlowPut(PNL_ATTR *keyAttrs,
1271 PNL_ATTR *tunnelAttrs,
1272 OvsFlowKey *destKey)
1274 _MapTunAttrToFlowPut(keyAttrs, tunnelAttrs, destKey);
1276 /* ===== L2 headers ===== */
1277 destKey->l2.inPort = NlAttrGetU32(keyAttrs[OVS_KEY_ATTR_IN_PORT]);
1279 if (keyAttrs[OVS_KEY_ATTR_ETHERNET]) {
1280 const struct ovs_key_ethernet *eth_key;
1281 eth_key = NlAttrGet(keyAttrs[OVS_KEY_ATTR_ETHERNET]);
1282 RtlCopyMemory(destKey->l2.dlSrc, eth_key->eth_src, ETH_ADDR_LEN);
1283 RtlCopyMemory(destKey->l2.dlDst, eth_key->eth_dst, ETH_ADDR_LEN);
1286 /* TODO: Ideally ETHERTYPE should not be optional.
1287 * But during vswitchd bootup we are seeing FLOW_ADD
1288 * requests with no ETHERTYPE attributes.
1289 * Need to verify this. */
1290 if (keyAttrs[OVS_KEY_ATTR_ETHERTYPE]) {
1291 destKey->l2.dlType = (NlAttrGetU16(keyAttrs
1292 [OVS_KEY_ATTR_ETHERTYPE]));
1295 if (keyAttrs[OVS_KEY_ATTR_VLAN]) {
1296 destKey->l2.vlanTci = NlAttrGetU16(keyAttrs[OVS_KEY_ATTR_VLAN]);
1299 /* ==== L3 + L4. ==== */
1300 destKey->l2.keyLen = OVS_WIN_TUNNEL_KEY_SIZE + OVS_L2_KEY_SIZE
1301 - destKey->l2.offset;
1303 switch (ntohs(destKey->l2.dlType)) {
1304 case ETH_TYPE_IPV4: {
1306 if (keyAttrs[OVS_KEY_ATTR_IPV4]) {
1307 const struct ovs_key_ipv4 *ipv4Key;
1309 ipv4Key = NlAttrGet(keyAttrs[OVS_KEY_ATTR_IPV4]);
1310 IpKey *ipv4FlowPutKey = &(destKey->ipKey);
1311 ipv4FlowPutKey->nwSrc = ipv4Key->ipv4_src;
1312 ipv4FlowPutKey->nwDst = ipv4Key->ipv4_dst;
1313 ipv4FlowPutKey->nwProto = ipv4Key->ipv4_proto;
1314 ipv4FlowPutKey->nwTos = ipv4Key->ipv4_tos;
1315 ipv4FlowPutKey->nwTtl = ipv4Key->ipv4_ttl;
1316 ipv4FlowPutKey->nwFrag = ipv4Key->ipv4_frag;
1318 if (keyAttrs[OVS_KEY_ATTR_TCP]) {
1319 const struct ovs_key_tcp *tcpKey;
1320 tcpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_TCP]);
1321 ipv4FlowPutKey->l4.tpSrc = tcpKey->tcp_src;
1322 ipv4FlowPutKey->l4.tpDst = tcpKey->tcp_dst;
1325 if (keyAttrs[OVS_KEY_ATTR_UDP]) {
1326 const struct ovs_key_udp *udpKey;
1327 udpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_UDP]);
1328 ipv4FlowPutKey->l4.tpSrc = udpKey->udp_src;
1329 ipv4FlowPutKey->l4.tpDst = udpKey->udp_dst;
1332 if (keyAttrs[OVS_KEY_ATTR_SCTP]) {
1333 const struct ovs_key_sctp *sctpKey;
1334 sctpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_SCTP]);
1335 ipv4FlowPutKey->l4.tpSrc = sctpKey->sctp_src;
1336 ipv4FlowPutKey->l4.tpDst = sctpKey->sctp_dst;
1339 destKey->l2.keyLen += OVS_IP_KEY_SIZE;
1343 case ETH_TYPE_IPV6: {
1345 if (keyAttrs[OVS_KEY_ATTR_IPV6]) {
1346 const struct ovs_key_ipv6 *ipv6Key;
1348 ipv6Key = NlAttrGet(keyAttrs[OVS_KEY_ATTR_IPV6]);
1349 Ipv6Key *ipv6FlowPutKey = &(destKey->ipv6Key);
1351 RtlCopyMemory(&ipv6FlowPutKey->ipv6Src, ipv6Key->ipv6_src,
1352 sizeof ipv6Key->ipv6_src);
1353 RtlCopyMemory(&ipv6FlowPutKey->ipv6Dst, ipv6Key->ipv6_dst,
1354 sizeof ipv6Key->ipv6_dst);
1356 ipv6FlowPutKey->ipv6Label = ipv6Key->ipv6_label;
1357 ipv6FlowPutKey->nwProto = ipv6Key->ipv6_proto;
1358 ipv6FlowPutKey->nwTos = ipv6Key->ipv6_tclass;
1359 ipv6FlowPutKey->nwTtl = ipv6Key->ipv6_hlimit;
1360 ipv6FlowPutKey->nwFrag = ipv6Key->ipv6_frag;
1362 if (keyAttrs[OVS_KEY_ATTR_TCP]) {
1363 const struct ovs_key_tcp *tcpKey;
1364 tcpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_TCP]);
1365 ipv6FlowPutKey->l4.tpSrc = tcpKey->tcp_src;
1366 ipv6FlowPutKey->l4.tpDst = tcpKey->tcp_dst;
1369 if (keyAttrs[OVS_KEY_ATTR_UDP]) {
1370 const struct ovs_key_udp *udpKey;
1371 udpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_UDP]);
1372 ipv6FlowPutKey->l4.tpSrc = udpKey->udp_src;
1373 ipv6FlowPutKey->l4.tpDst = udpKey->udp_dst;
1376 if (keyAttrs[OVS_KEY_ATTR_SCTP]) {
1377 const struct ovs_key_sctp *sctpKey;
1378 sctpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_SCTP]);
1379 ipv6FlowPutKey->l4.tpSrc = sctpKey->sctp_src;
1380 ipv6FlowPutKey->l4.tpDst = sctpKey->sctp_dst;
1383 if (keyAttrs[OVS_KEY_ATTR_ICMPV6]) {
1384 const struct ovs_key_icmpv6 *icmpv6Key;
1386 Icmp6Key *icmp6FlowPutKey= &(destKey->icmp6Key);
1388 icmpv6Key = NlAttrGet(keyAttrs[OVS_KEY_ATTR_ICMPV6]);
1390 icmp6FlowPutKey->l4.tpSrc = icmpv6Key->icmpv6_type;
1391 icmp6FlowPutKey->l4.tpDst = icmpv6Key->icmpv6_code;
1393 if (keyAttrs[OVS_KEY_ATTR_ND]) {
1394 const struct ovs_key_nd *ndKey;
1396 ndKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_ND]);
1397 RtlCopyMemory(&icmp6FlowPutKey->ndTarget,
1398 ndKey->nd_target, sizeof (icmp6FlowPutKey->ndTarget));
1399 RtlCopyMemory(icmp6FlowPutKey->arpSha,
1400 ndKey->nd_sll, ETH_ADDR_LEN);
1401 RtlCopyMemory(icmp6FlowPutKey->arpTha,
1402 ndKey->nd_tll, ETH_ADDR_LEN);
1405 destKey->l2.keyLen += OVS_ICMPV6_KEY_SIZE;
1409 destKey->l2.keyLen += OVS_IPV6_KEY_SIZE;
1412 ipv6FlowPutKey->pad = 0;
1417 case ETH_TYPE_RARP: {
1419 if (keyAttrs[OVS_KEY_ATTR_ARP]) {
1420 ArpKey *arpFlowPutKey = &destKey->arpKey;
1421 const struct ovs_key_arp *arpKey;
1423 arpKey = NlAttrGet(keyAttrs[OVS_KEY_ATTR_ARP]);
1425 arpFlowPutKey->nwSrc = arpKey->arp_sip;
1426 arpFlowPutKey->nwDst = arpKey->arp_tip;
1428 RtlCopyMemory(arpFlowPutKey->arpSha, arpKey->arp_sha, ETH_ADDR_LEN);
1429 RtlCopyMemory(arpFlowPutKey->arpTha, arpKey->arp_tha, ETH_ADDR_LEN);
1430 /* Kernel datapath assumes 'arpFlowPutKey->nwProto' to be in host
1432 arpFlowPutKey->nwProto = (UINT8)ntohs((arpKey->arp_op));
1433 arpFlowPutKey->pad[0] = 0;
1434 arpFlowPutKey->pad[1] = 0;
1435 arpFlowPutKey->pad[2] = 0;
1436 destKey->l2.keyLen += OVS_ARP_KEY_SIZE;
1444 *----------------------------------------------------------------------------
1445 * _MapTunAttrToFlowPut --
1446 * Converts FLOW_TUNNEL_KEY attribute to OvsFlowKey->tunKey.
1447 *----------------------------------------------------------------------------
1450 _MapTunAttrToFlowPut(PNL_ATTR *keyAttrs,
1452 OvsFlowKey *destKey)
1454 if (keyAttrs[OVS_KEY_ATTR_TUNNEL]) {
1456 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_ID]) {
1457 destKey->tunKey.tunnelId = NlAttrGetU64
1458 (tunAttrs[OVS_TUNNEL_KEY_ATTR_ID]);
1459 destKey->tunKey.flags |= OVS_TNL_F_KEY;
1462 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_IPV4_DST]) {
1463 destKey->tunKey.dst = NlAttrGetU32
1464 (tunAttrs[OVS_TUNNEL_KEY_ATTR_IPV4_DST]);
1467 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_IPV4_SRC]) {
1468 destKey->tunKey.src = NlAttrGetU32
1469 (tunAttrs[OVS_TUNNEL_KEY_ATTR_IPV4_SRC]);
1472 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT]) {
1473 destKey->tunKey.flags |= OVS_TNL_F_DONT_FRAGMENT;
1476 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_CSUM]) {
1477 destKey->tunKey.flags |= OVS_TNL_F_CSUM;
1480 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_TOS]) {
1481 destKey->tunKey.tos = NlAttrGetU8
1482 (tunAttrs[OVS_TUNNEL_KEY_ATTR_TOS]);
1485 if (tunAttrs[OVS_TUNNEL_KEY_ATTR_TTL]) {
1486 destKey->tunKey.ttl = NlAttrGetU8
1487 (tunAttrs[OVS_TUNNEL_KEY_ATTR_TTL]);
1490 destKey->tunKey.pad = 0;
1491 destKey->l2.offset = 0;
1493 destKey->tunKey.attr[0] = 0;
1494 destKey->tunKey.attr[1] = 0;
1495 destKey->tunKey.attr[2] = 0;
1496 destKey->l2.offset = sizeof destKey->tunKey;
1501 *----------------------------------------------------------------------------
1502 * OvsDeleteFlowTable --
1504 * NDIS_STATUS_SUCCESS always.
1505 *----------------------------------------------------------------------------
1508 OvsDeleteFlowTable(OVS_DATAPATH *datapath)
1510 if (datapath == NULL || datapath->flowTable == NULL) {
1511 return NDIS_STATUS_SUCCESS;
1514 DeleteAllFlows(datapath);
1515 OvsFreeMemoryWithTag(datapath->flowTable, OVS_FLOW_POOL_TAG);
1516 datapath->flowTable = NULL;
1517 NdisFreeRWLock(datapath->lock);
1519 return NDIS_STATUS_SUCCESS;
1523 *----------------------------------------------------------------------------
1524 * OvsAllocateFlowTable --
1526 * NDIS_STATUS_SUCCESS on success.
1527 * NDIS_STATUS_RESOURCES if memory couldn't be allocated
1528 *----------------------------------------------------------------------------
1531 OvsAllocateFlowTable(OVS_DATAPATH *datapath,
1532 POVS_SWITCH_CONTEXT switchContext)
1537 datapath->flowTable = OvsAllocateMemoryWithTag(
1538 OVS_FLOW_TABLE_SIZE * sizeof(LIST_ENTRY), OVS_FLOW_POOL_TAG);
1539 if (!datapath->flowTable) {
1540 return NDIS_STATUS_RESOURCES;
1542 for (i = 0; i < OVS_FLOW_TABLE_SIZE; i++) {
1543 bucket = &(datapath->flowTable[i]);
1544 InitializeListHead(bucket);
1546 datapath->lock = NdisAllocateRWLock(switchContext->NdisFilterHandle);
1548 return NDIS_STATUS_SUCCESS;
1553 *----------------------------------------------------------------------------
1554 * GetStartAddrNBL --
1555 * Get the virtual address of the frame.
1558 * Virtual address of the frame.
1559 *----------------------------------------------------------------------------
1561 static __inline VOID *
1562 GetStartAddrNBL(const NET_BUFFER_LIST *_pNB)
1570 // Ethernet Header is a guaranteed safe access.
1571 curMdl = (NET_BUFFER_LIST_FIRST_NB(_pNB))->CurrentMdl;
1572 curBuffer = MmGetSystemAddressForMdlSafe(curMdl, LowPagePriority);
1577 curHeader = (PEthHdr)
1578 (curBuffer + (NET_BUFFER_LIST_FIRST_NB(_pNB))->CurrentMdlOffset);
1580 return (VOID *) curHeader;
1584 OvsFlowUsed(OvsFlow *flow,
1585 const NET_BUFFER_LIST *packet,
1586 const POVS_PACKET_HDR_INFO layers)
1588 LARGE_INTEGER tickCount;
1590 KeQueryTickCount(&tickCount);
1591 flow->used = tickCount.QuadPart * ovsTimeIncrementPerTick;
1592 flow->packetCount++;
1593 flow->byteCount += OvsPacketLenNBL(packet);
1594 flow->tcpFlags |= OvsGetTcpFlags(packet, &flow->key, layers);
1599 DeleteAllFlows(OVS_DATAPATH *datapath)
1604 for (i = 0; i < OVS_FLOW_TABLE_SIZE; i++) {
1606 bucket = &(datapath->flowTable[i]);
1607 while (!IsListEmpty(bucket)) {
1609 next = bucket->Flink;
1610 flow = CONTAINING_RECORD(next, OvsFlow, ListEntry);
1611 RemoveFlow(datapath, &flow);
1617 *----------------------------------------------------------------------------
1618 * Initializes 'flow' members from 'packet', 'skb_priority', 'tun_id', and
1621 * Initializes 'packet' header pointers as follows:
1623 * - packet->l2 to the start of the Ethernet header.
1625 * - packet->l3 to just past the Ethernet header, or just past the
1626 * vlan_header if one is present, to the first byte of the payload of the
1629 * - packet->l4 to just past the IPv4 header, if one is present and has a
1630 * correct length, and otherwise NULL.
1632 * - packet->l7 to just past the TCP or UDP or ICMP header, if one is
1633 * present and has a correct length, and otherwise NULL.
1635 * Returns NDIS_STATUS_SUCCESS normally. Fails only if packet data cannot be accessed
1636 * (e.g. if Pkt_CopyBytesOut() returns an error).
1637 *----------------------------------------------------------------------------
1640 OvsExtractFlow(const NET_BUFFER_LIST *packet,
1643 POVS_PACKET_HDR_INFO layers,
1644 OvsIPv4TunnelKey *tunKey)
1646 struct Eth_Header *eth;
1653 ASSERT(tunKey->dst != 0);
1654 RtlMoveMemory(&flow->tunKey, tunKey, sizeof flow->tunKey);
1655 flow->l2.offset = 0;
1657 flow->tunKey.dst = 0;
1658 flow->l2.offset = OVS_WIN_TUNNEL_KEY_SIZE;
1661 flow->l2.inPort = inPort;
1663 if ( OvsPacketLenNBL(packet) < ETH_HEADER_LEN_DIX) {
1664 flow->l2.keyLen = OVS_WIN_TUNNEL_KEY_SIZE + 8 - flow->l2.offset;
1665 return NDIS_STATUS_SUCCESS;
1669 eth = (Eth_Header *)GetStartAddrNBL((NET_BUFFER_LIST *)packet);
1670 memcpy(flow->l2.dlSrc, eth->src, ETH_ADDR_LENGTH);
1671 memcpy(flow->l2.dlDst, eth->dst, ETH_ADDR_LENGTH);
1676 vlanTagValue = NET_BUFFER_LIST_INFO(packet, Ieee8021QNetBufferListInfo);
1678 PNDIS_NET_BUFFER_LIST_8021Q_INFO vlanTag =
1679 (PNDIS_NET_BUFFER_LIST_8021Q_INFO)(PVOID *)&vlanTagValue;
1680 flow->l2.vlanTci = htons(vlanTag->TagHeader.VlanId | OVSWIN_VLAN_CFI |
1681 (vlanTag->TagHeader.UserPriority << 13));
1683 if (eth->dix.typeNBO == ETH_TYPE_802_1PQ_NBO) {
1684 Eth_802_1pq_Tag *tag= (Eth_802_1pq_Tag *)ð->dix.typeNBO;
1685 flow->l2.vlanTci = ((UINT16)tag->priority << 13) |
1687 ((UINT16)tag->vidHi << 8) | tag->vidLo;
1688 offset = sizeof (Eth_802_1pq_Tag);
1690 flow->l2.vlanTci = 0;
1694 * Please note after this point, src mac and dst mac should
1695 * not be accessed through eth
1697 eth = (Eth_Header *)((UINT8 *)eth + offset);
1703 * XXX assume that at least the first
1704 * 12 bytes of received packets are mapped. This code has the stronger
1705 * assumption that at least the first 22 bytes of 'packet' is mapped (if my
1706 * arithmetic is right).
1708 if (ETH_TYPENOT8023(eth->dix.typeNBO)) {
1709 flow->l2.dlType = eth->dix.typeNBO;
1710 layers->l3Offset = ETH_HEADER_LEN_DIX + offset;
1711 } else if (OvsPacketLenNBL(packet) >= ETH_HEADER_LEN_802_3 &&
1712 eth->e802_3.llc.dsap == 0xaa &&
1713 eth->e802_3.llc.ssap == 0xaa &&
1714 eth->e802_3.llc.control == ETH_LLC_CONTROL_UFRAME &&
1715 eth->e802_3.snap.snapOrg[0] == 0x00 &&
1716 eth->e802_3.snap.snapOrg[1] == 0x00 &&
1717 eth->e802_3.snap.snapOrg[2] == 0x00) {
1718 flow->l2.dlType = eth->e802_3.snap.snapType.typeNBO;
1719 layers->l3Offset = ETH_HEADER_LEN_802_3 + offset;
1721 flow->l2.dlType = htons(OVSWIN_DL_TYPE_NONE);
1722 layers->l3Offset = ETH_HEADER_LEN_DIX + offset;
1725 flow->l2.keyLen = OVS_WIN_TUNNEL_KEY_SIZE + OVS_L2_KEY_SIZE - flow->l2.offset;
1726 /* Network layer. */
1727 if (flow->l2.dlType == htons(ETH_TYPE_IPV4)) {
1728 struct IPHdr ip_storage;
1729 const struct IPHdr *nh;
1730 IpKey *ipKey = &flow->ipKey;
1732 flow->l2.keyLen += OVS_IP_KEY_SIZE;
1734 nh = OvsGetIp(packet, layers->l3Offset, &ip_storage);
1736 layers->l4Offset = layers->l3Offset + nh->ihl * 4;
1738 ipKey->nwSrc = nh->saddr;
1739 ipKey->nwDst = nh->daddr;
1740 ipKey->nwProto = nh->protocol;
1742 ipKey->nwTos = nh->tos;
1743 if (nh->frag_off & htons(IP_MF | IP_OFFSET)) {
1744 ipKey->nwFrag = OVSWIN_NW_FRAG_ANY;
1745 if (nh->frag_off & htons(IP_OFFSET)) {
1746 ipKey->nwFrag |= OVSWIN_NW_FRAG_LATER;
1752 ipKey->nwTtl = nh->ttl;
1753 ipKey->l4.tpSrc = 0;
1754 ipKey->l4.tpDst = 0;
1756 if (!(nh->frag_off & htons(IP_OFFSET))) {
1757 if (ipKey->nwProto == SOCKET_IPPROTO_TCP) {
1758 OvsParseTcp(packet, &ipKey->l4, layers);
1759 } else if (ipKey->nwProto == SOCKET_IPPROTO_UDP) {
1760 OvsParseUdp(packet, &ipKey->l4, layers);
1761 } else if (ipKey->nwProto == SOCKET_IPPROTO_ICMP) {
1762 ICMPHdr icmpStorage;
1763 const ICMPHdr *icmp;
1765 icmp = OvsGetIcmp(packet, layers->l4Offset, &icmpStorage);
1767 ipKey->l4.tpSrc = htons(icmp->type);
1768 ipKey->l4.tpDst = htons(icmp->code);
1769 layers->l7Offset = layers->l4Offset + sizeof *icmp;
1774 ((UINT64 *)ipKey)[0] = 0;
1775 ((UINT64 *)ipKey)[1] = 0;
1777 } else if (flow->l2.dlType == htons(ETH_TYPE_IPV6)) {
1779 flow->l2.keyLen += OVS_IPV6_KEY_SIZE;
1780 status = OvsParseIPv6(packet, flow, layers);
1781 if (status != NDIS_STATUS_SUCCESS) {
1782 memset(&flow->ipv6Key, 0, sizeof (Ipv6Key));
1786 flow->ipv6Key.l4.tpSrc = 0;
1787 flow->ipv6Key.l4.tpDst = 0;
1788 flow->ipv6Key.pad = 0;
1790 if (flow->ipv6Key.nwProto == SOCKET_IPPROTO_TCP) {
1791 OvsParseTcp(packet, &(flow->ipv6Key.l4), layers);
1792 } else if (flow->ipv6Key.nwProto == SOCKET_IPPROTO_UDP) {
1793 OvsParseUdp(packet, &(flow->ipv6Key.l4), layers);
1794 } else if (flow->ipv6Key.nwProto == SOCKET_IPPROTO_ICMPV6) {
1795 OvsParseIcmpV6(packet, flow, layers);
1796 flow->l2.keyLen += (OVS_ICMPV6_KEY_SIZE - OVS_IPV6_KEY_SIZE);
1798 } else if (flow->l2.dlType == htons(ETH_TYPE_ARP)) {
1799 EtherArp arpStorage;
1800 const EtherArp *arp;
1801 ArpKey *arpKey = &flow->arpKey;
1802 ((UINT64 *)arpKey)[0] = 0;
1803 ((UINT64 *)arpKey)[1] = 0;
1804 ((UINT64 *)arpKey)[2] = 0;
1805 flow->l2.keyLen += OVS_ARP_KEY_SIZE;
1806 arp = OvsGetArp(packet, layers->l3Offset, &arpStorage);
1807 if (arp && arp->ea_hdr.ar_hrd == htons(1) &&
1808 arp->ea_hdr.ar_pro == htons(ETH_TYPE_IPV4) &&
1809 arp->ea_hdr.ar_hln == ETH_ADDR_LENGTH &&
1810 arp->ea_hdr.ar_pln == 4) {
1811 /* We only match on the lower 8 bits of the opcode. */
1812 if (ntohs(arp->ea_hdr.ar_op) <= 0xff) {
1813 arpKey->nwProto = (UINT8)ntohs(arp->ea_hdr.ar_op);
1815 if (arpKey->nwProto == ARPOP_REQUEST
1816 || arpKey->nwProto == ARPOP_REPLY) {
1817 memcpy(&arpKey->nwSrc, arp->arp_spa, 4);
1818 memcpy(&arpKey->nwDst, arp->arp_tpa, 4);
1819 memcpy(arpKey->arpSha, arp->arp_sha, ETH_ADDR_LENGTH);
1820 memcpy(arpKey->arpTha, arp->arp_tha, ETH_ADDR_LENGTH);
1825 return NDIS_STATUS_SUCCESS;
1829 FlowEqual(UINT64 *src, UINT64 *dst, UINT32 size)
1832 ASSERT((size & 0x7) == 0);
1833 ASSERT(((UINT64)src & 0x7) == 0);
1834 ASSERT(((UINT64)dst & 0x7) == 0);
1835 for (i = 0; i < (size >> 3); i++) {
1836 if (src[i] != dst[i]) {
1845 * ----------------------------------------------------------------------------
1847 * Add a flow to flow table.
1850 * NDIS_STATUS_SUCCESS if no same flow in the flow table.
1851 * ----------------------------------------------------------------------------
1854 AddFlow(OVS_DATAPATH *datapath, OvsFlow *flow)
1858 if (OvsLookupFlow(datapath, &flow->key, &flow->hash, TRUE) != NULL) {
1859 return STATUS_INVALID_HANDLE;
1862 head = &(datapath->flowTable[HASH_BUCKET(flow->hash)]);
1864 * We need fence here to make sure flow's nextPtr is updated before
1865 * head->nextPtr is updated.
1869 //KeAcquireSpinLock(&FilterDeviceExtension->NblQueueLock, &oldIrql);
1870 InsertTailList(head, &flow->ListEntry);
1871 //KeReleaseSpinLock(&FilterDeviceExtension->NblQueueLock, oldIrql);
1875 return STATUS_SUCCESS;
1879 /* ----------------------------------------------------------------------------
1881 * Remove a flow from flow table, and added to wait list
1882 * ----------------------------------------------------------------------------
1885 RemoveFlow(OVS_DATAPATH *datapath,
1891 ASSERT(datapath->nFlows);
1893 // Remove the flow from queue
1894 RemoveEntryList(&f->ListEntry);
1900 * ----------------------------------------------------------------------------
1903 * Find flow from flow table based on flow key.
1904 * Caller should either hold portset handle or should
1905 * have a flowRef in datapath or Acquired datapath.
1908 * Flow pointer if lookup successful.
1909 * NULL if not exists.
1910 * ----------------------------------------------------------------------------
1913 OvsLookupFlow(OVS_DATAPATH *datapath,
1914 const OvsFlowKey *key,
1918 PLIST_ENTRY link, head;
1919 UINT16 offset = key->l2.offset;
1920 UINT16 size = key->l2.keyLen;
1923 ASSERT(key->tunKey.dst || offset == sizeof (OvsIPv4TunnelKey));
1924 ASSERT(!key->tunKey.dst || offset == 0);
1926 start = (UINT8 *)key + offset;
1929 *hash = OvsJhashBytes(start, size, 0);
1932 head = &datapath->flowTable[HASH_BUCKET(*hash)];
1934 while (link != head) {
1935 OvsFlow *flow = CONTAINING_RECORD(link, OvsFlow, ListEntry);
1937 if (flow->hash == *hash &&
1938 flow->key.l2.val == key->l2.val &&
1939 FlowEqual((UINT64 *)((uint8 *)&flow->key + offset),
1940 (UINT64 *)start, size)) {
1950 * ----------------------------------------------------------------------------
1952 * Calculate the hash for the given flow key.
1953 * ----------------------------------------------------------------------------
1956 OvsHashFlow(const OvsFlowKey *key)
1958 UINT16 offset = key->l2.offset;
1959 UINT16 size = key->l2.keyLen;
1962 ASSERT(key->tunKey.dst || offset == sizeof (OvsIPv4TunnelKey));
1963 ASSERT(!key->tunKey.dst || offset == 0);
1964 start = (UINT8 *)key + offset;
1965 return OvsJhashBytes(start, size, 0);
1970 * ----------------------------------------------------------------------------
1972 * Free a flow and its actions.
1973 * ----------------------------------------------------------------------------
1976 FreeFlow(OvsFlow *flow)
1979 OvsFreeMemoryWithTag(flow, OVS_FLOW_POOL_TAG);
1983 OvsDoDumpFlows(OvsFlowDumpInput *dumpInput,
1984 OvsFlowDumpOutput *dumpOutput,
1988 OVS_DATAPATH *datapath = NULL;
1990 PLIST_ENTRY node, head;
1992 UINT32 rowIndex, columnIndex;
1993 LOCK_STATE_EX dpLockState;
1994 NTSTATUS status = STATUS_SUCCESS;
1995 BOOLEAN findNextNonEmpty = FALSE;
1997 dpNo = dumpInput->dpNo;
1998 NdisAcquireSpinLock(gOvsCtrlLock);
1999 if (gOvsSwitchContext->dpNo != dpNo) {
2000 status = STATUS_INVALID_PARAMETER;
2004 rowIndex = dumpInput->position[0];
2005 if (rowIndex >= OVS_FLOW_TABLE_SIZE) {
2007 *replyLen = sizeof(*dumpOutput);
2011 columnIndex = dumpInput->position[1];
2013 datapath = &gOvsSwitchContext->datapath;
2015 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL);
2016 OvsAcquireDatapathRead(datapath, &dpLockState, TRUE);
2018 head = &datapath->flowTable[rowIndex];
2021 while (column < columnIndex) {
2030 findNextNonEmpty = TRUE;
2034 if (findNextNonEmpty) {
2035 while (head == node) {
2036 if (++rowIndex >= OVS_FLOW_TABLE_SIZE) {
2040 head = &datapath->flowTable[rowIndex];
2045 ASSERT(node != head);
2046 ASSERT(rowIndex < OVS_FLOW_TABLE_SIZE);
2048 flow = CONTAINING_RECORD(node, OvsFlow, ListEntry);
2049 status = ReportFlowInfo(flow, dumpInput->getFlags, &dumpOutput->flow);
2051 if (status == STATUS_BUFFER_TOO_SMALL) {
2052 dumpOutput->n = sizeof(OvsFlowDumpOutput) + flow->actionsLen;
2053 *replyLen = sizeof(*dumpOutput);
2055 dumpOutput->n = 1; //one flow reported.
2056 *replyLen = sizeof(*dumpOutput) + dumpOutput->flow.actionsLen;
2059 dumpOutput->position[0] = rowIndex;
2060 dumpOutput->position[1] = ++columnIndex;
2063 OvsReleaseDatapath(datapath, &dpLockState);
2066 NdisReleaseSpinLock(gOvsCtrlLock);
2071 ReportFlowInfo(OvsFlow *flow,
2075 NTSTATUS status = STATUS_SUCCESS;
2077 if (getFlags & FLOW_GET_KEY) {
2078 // always copy the tunnel key part
2079 RtlCopyMemory(&info->key, &flow->key,
2080 flow->key.l2.keyLen + flow->key.l2.offset);
2083 if (getFlags & FLOW_GET_STATS) {
2084 OvsFlowStats *stats = &info->stats;
2085 stats->packetCount = flow->packetCount;
2086 stats->byteCount = flow->byteCount;
2087 stats->used = (UINT32)flow->used;
2088 stats->tcpFlags = flow->tcpFlags;
2091 if (getFlags & FLOW_GET_ACTIONS) {
2092 if (flow->actionsLen == 0) {
2093 info->actionsLen = 0;
2095 info->actions = flow->actions;
2096 info->actionsLen = flow->actionsLen;
2104 OvsPutFlowIoctl(PVOID inputBuffer,
2106 struct OvsFlowStats *stats)
2108 NTSTATUS status = STATUS_SUCCESS;
2109 OVS_DATAPATH *datapath = NULL;
2113 LOCK_STATE_EX dpLockState;
2115 if ((inputLength < sizeof(OvsFlowPut)) || (inputBuffer == NULL)) {
2116 return STATUS_INFO_LENGTH_MISMATCH;
2119 put = (OvsFlowPut *)inputBuffer;
2120 if (put->actionsLen > 0) {
2121 actionsLen = put->actionsLen;
2127 NdisAcquireSpinLock(gOvsCtrlLock);
2128 if (gOvsSwitchContext->dpNo != dpNo) {
2129 status = STATUS_INVALID_PARAMETER;
2133 datapath = &gOvsSwitchContext->datapath;
2135 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL);
2136 OvsAcquireDatapathWrite(datapath, &dpLockState, TRUE);
2137 status = HandleFlowPut(put, datapath, stats);
2138 OvsReleaseDatapath(datapath, &dpLockState);
2141 NdisReleaseSpinLock(gOvsCtrlLock);
2146 /* Handles flow add, modify as well as delete */
2148 HandleFlowPut(OvsFlowPut *put,
2149 OVS_DATAPATH *datapath,
2150 struct OvsFlowStats *stats)
2152 BOOLEAN mayCreate, mayModify, mayDelete;
2153 OvsFlow *KernelFlow;
2155 NTSTATUS status = STATUS_SUCCESS;
2157 mayCreate = (put->flags & OVSWIN_FLOW_PUT_CREATE) != 0;
2158 mayModify = (put->flags & OVSWIN_FLOW_PUT_MODIFY) != 0;
2159 mayDelete = (put->flags & OVSWIN_FLOW_PUT_DELETE) != 0;
2161 if ((mayCreate || mayModify) == mayDelete) {
2162 return STATUS_INVALID_PARAMETER;
2165 KernelFlow = OvsLookupFlow(datapath, &put->key, &hash, FALSE);
2168 return STATUS_INVALID_PARAMETER;
2171 status = OvsPrepareFlow(&KernelFlow, put, hash);
2172 if (status != STATUS_SUCCESS) {
2173 FreeFlow(KernelFlow);
2174 return STATUS_UNSUCCESSFUL;
2177 status = AddFlow(datapath, KernelFlow);
2178 if (status != STATUS_SUCCESS) {
2179 FreeFlow(KernelFlow);
2180 return STATUS_UNSUCCESSFUL;
2183 /* Validate the flow addition */
2186 OvsFlow *flow = OvsLookupFlow(datapath, &put->key, &newHash,
2189 ASSERT(newHash == hash);
2190 if (!flow || newHash != hash) {
2191 return STATUS_UNSUCCESSFUL;
2195 stats->packetCount = KernelFlow->packetCount;
2196 stats->byteCount = KernelFlow->byteCount;
2197 stats->tcpFlags = KernelFlow->tcpFlags;
2198 stats->used = (UINT32)KernelFlow->used;
2202 status = OvsPrepareFlow(&newFlow, put, hash);
2203 if (status != STATUS_SUCCESS) {
2204 return STATUS_UNSUCCESSFUL;
2207 KernelFlow = OvsLookupFlow(datapath, &put->key, &hash, TRUE);
2209 if ((put->flags & OVSWIN_FLOW_PUT_CLEAR) == 0) {
2210 newFlow->packetCount = KernelFlow->packetCount;
2211 newFlow->byteCount = KernelFlow->byteCount;
2212 newFlow->tcpFlags = KernelFlow->tcpFlags;
2214 RemoveFlow(datapath, &KernelFlow);
2216 if ((put->flags & OVSWIN_FLOW_PUT_CLEAR) == 0) {
2217 newFlow->packetCount = stats->packetCount;
2218 newFlow->byteCount = stats->byteCount;
2219 newFlow->tcpFlags = stats->tcpFlags;
2222 status = AddFlow(datapath, newFlow);
2223 ASSERT(status == STATUS_SUCCESS);
2225 /* Validate the flow addition */
2228 OvsFlow *testflow = OvsLookupFlow(datapath, &put->key,
2231 ASSERT(newHash == hash);
2232 if (!testflow || newHash != hash) {
2234 return STATUS_UNSUCCESSFUL;
2240 RemoveFlow(datapath, &KernelFlow);
2243 /* Return success if an identical flow already exists. */
2244 /* XXX: should we return EEXIST in a netlink error? */
2245 return STATUS_SUCCESS;
2249 return STATUS_SUCCESS;
2253 OvsPrepareFlow(OvsFlow **flow,
2254 const OvsFlowPut *put,
2257 OvsFlow *localFlow = *flow;
2258 NTSTATUS status = STATUS_SUCCESS;
2262 OvsAllocateMemoryWithTag(sizeof(OvsFlow) + put->actionsLen,
2264 if (localFlow == NULL) {
2265 status = STATUS_NO_MEMORY;
2269 localFlow->key = put->key;
2270 localFlow->actionsLen = put->actionsLen;
2271 if (put->actionsLen) {
2272 NdisMoveMemory((PUCHAR)localFlow->actions, put->actions,
2275 localFlow->userActionsLen = 0; // 0 indicate no conversion is made
2276 localFlow->used = 0;
2277 localFlow->packetCount = 0;
2278 localFlow->byteCount = 0;
2279 localFlow->tcpFlags = 0;
2280 localFlow->hash = hash;
2287 OvsGetFlowIoctl(PVOID inputBuffer,
2290 NTSTATUS status = STATUS_SUCCESS;
2291 OVS_DATAPATH *datapath = NULL;
2293 UINT32 getFlags, getActionsLen;
2294 OvsFlowGetInput *getInput;
2295 OvsFlowGetOutput *getOutput;
2298 LOCK_STATE_EX dpLockState;
2300 getInput = (OvsFlowGetInput *) inputBuffer;
2301 getFlags = getInput->getFlags;
2302 getActionsLen = getInput->actionsLen;
2304 if (outputBuffer == NULL) {
2305 return STATUS_INFO_LENGTH_MISMATCH;
2308 dpNo = getInput->dpNo;
2309 NdisAcquireSpinLock(gOvsCtrlLock);
2310 if (gOvsSwitchContext->dpNo != dpNo) {
2311 status = STATUS_INVALID_PARAMETER;
2315 datapath = &gOvsSwitchContext->datapath;
2317 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL);
2318 OvsAcquireDatapathRead(datapath, &dpLockState, TRUE);
2319 flow = OvsLookupFlow(datapath, &getInput->key, &hash, FALSE);
2321 status = STATUS_INVALID_PARAMETER;
2325 getOutput = (OvsFlowGetOutput *)outputBuffer;
2326 ReportFlowInfo(flow, getFlags, &getOutput->info);
2329 OvsReleaseDatapath(datapath, &dpLockState);
2331 NdisReleaseSpinLock(gOvsCtrlLock);
2336 OvsFlushFlowIoctl(UINT32 dpNo)
2338 NTSTATUS status = STATUS_SUCCESS;
2339 OVS_DATAPATH *datapath = NULL;
2340 LOCK_STATE_EX dpLockState;
2342 NdisAcquireSpinLock(gOvsCtrlLock);
2343 if (gOvsSwitchContext->dpNo != dpNo) {
2344 status = STATUS_INVALID_PARAMETER;
2348 datapath = &gOvsSwitchContext->datapath;
2350 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL);
2351 OvsAcquireDatapathWrite(datapath, &dpLockState, TRUE);
2352 DeleteAllFlows(datapath);
2353 OvsReleaseDatapath(datapath, &dpLockState);
2356 NdisReleaseSpinLock(gOvsCtrlLock);
2361 OvsFlowKeyAttrSize(void)
2363 return NlAttrTotalSize(4) /* OVS_KEY_ATTR_PRIORITY */
2364 + NlAttrTotalSize(0) /* OVS_KEY_ATTR_TUNNEL */
2365 + OvsTunKeyAttrSize()
2366 + NlAttrTotalSize(4) /* OVS_KEY_ATTR_IN_PORT */
2367 + NlAttrTotalSize(4) /* OVS_KEY_ATTR_SKB_MARK */
2368 + NlAttrTotalSize(4) /* OVS_KEY_ATTR_DP_HASH */
2369 + NlAttrTotalSize(4) /* OVS_KEY_ATTR_RECIRC_ID */
2370 + NlAttrTotalSize(12) /* OVS_KEY_ATTR_ETHERNET */
2371 + NlAttrTotalSize(2) /* OVS_KEY_ATTR_ETHERTYPE */
2372 + NlAttrTotalSize(4) /* OVS_KEY_ATTR_VLAN */
2373 + NlAttrTotalSize(0) /* OVS_KEY_ATTR_ENCAP */
2374 + NlAttrTotalSize(2) /* OVS_KEY_ATTR_ETHERTYPE */
2375 + NlAttrTotalSize(40) /* OVS_KEY_ATTR_IPV6 */
2376 + NlAttrTotalSize(2) /* OVS_KEY_ATTR_ICMPV6 */
2377 + NlAttrTotalSize(28); /* OVS_KEY_ATTR_ND */
2381 OvsTunKeyAttrSize(void)
2383 /* Whenever adding new OVS_TUNNEL_KEY_ FIELDS, we should consider
2384 * updating this function.
2386 return NlAttrTotalSize(8) /* OVS_TUNNEL_KEY_ATTR_ID */
2387 + NlAttrTotalSize(4) /* OVS_TUNNEL_KEY_ATTR_IPV4_SRC */
2388 + NlAttrTotalSize(4) /* OVS_TUNNEL_KEY_ATTR_IPV4_DST */
2389 + NlAttrTotalSize(1) /* OVS_TUNNEL_KEY_ATTR_TOS */
2390 + NlAttrTotalSize(1) /* OVS_TUNNEL_KEY_ATTR_TTL */
2391 + NlAttrTotalSize(0) /* OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT */
2392 + NlAttrTotalSize(0) /* OVS_TUNNEL_KEY_ATTR_CSUM */
2393 + NlAttrTotalSize(0) /* OVS_TUNNEL_KEY_ATTR_OAM */
2394 + NlAttrTotalSize(256) /* OVS_TUNNEL_KEY_ATTR_GENEVE_OPTS */
2395 + NlAttrTotalSize(2) /* OVS_TUNNEL_KEY_ATTR_TP_SRC */
2396 + NlAttrTotalSize(2); /* OVS_TUNNEL_KEY_ATTR_TP_DST */
2399 #pragma warning( pop )