2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, 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 #include "ofp-print.h"
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
42 #include "unaligned.h"
43 #include "type-props.h"
46 VLOG_DEFINE_THIS_MODULE(ofp_util);
48 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
49 * in the peer and so there's not much point in showing a lot of them. */
50 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
52 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
53 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
56 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
57 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
58 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
59 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
62 ofputil_wcbits_to_netmask(int wcbits)
65 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
68 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
69 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
70 * between 0 and 32 inclusive.
72 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
73 * still be in the valid range but isn't otherwise meaningful. */
75 ofputil_netmask_to_wcbits(ovs_be32 netmask)
77 return 32 - ip_count_cidr_bits(netmask);
80 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
81 * flow_wildcards in 'wc' for use in struct match. It is the caller's
82 * responsibility to handle the special case where the flow match's dl_vlan is
83 * set to OFP_VLAN_NONE. */
85 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
87 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
89 /* Initialize most of wc. */
90 flow_wildcards_init_catchall(wc);
92 if (!(ofpfw & OFPFW10_IN_PORT)) {
93 wc->masks.in_port = UINT16_MAX;
96 if (!(ofpfw & OFPFW10_NW_TOS)) {
97 wc->masks.nw_tos |= IP_DSCP_MASK;
100 if (!(ofpfw & OFPFW10_NW_PROTO)) {
101 wc->masks.nw_proto = UINT8_MAX;
103 wc->masks.nw_src = ofputil_wcbits_to_netmask(ofpfw
104 >> OFPFW10_NW_SRC_SHIFT);
105 wc->masks.nw_dst = ofputil_wcbits_to_netmask(ofpfw
106 >> OFPFW10_NW_DST_SHIFT);
108 if (!(ofpfw & OFPFW10_TP_SRC)) {
109 wc->masks.tp_src = htons(UINT16_MAX);
111 if (!(ofpfw & OFPFW10_TP_DST)) {
112 wc->masks.tp_dst = htons(UINT16_MAX);
115 if (!(ofpfw & OFPFW10_DL_SRC)) {
116 memset(wc->masks.dl_src, 0xff, ETH_ADDR_LEN);
118 if (!(ofpfw & OFPFW10_DL_DST)) {
119 memset(wc->masks.dl_dst, 0xff, ETH_ADDR_LEN);
121 if (!(ofpfw & OFPFW10_DL_TYPE)) {
122 wc->masks.dl_type = htons(UINT16_MAX);
126 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
127 wc->masks.vlan_tci |= htons(VLAN_PCP_MASK | VLAN_CFI);
129 if (!(ofpfw & OFPFW10_DL_VLAN)) {
130 wc->masks.vlan_tci |= htons(VLAN_VID_MASK | VLAN_CFI);
134 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
136 ofputil_match_from_ofp10_match(const struct ofp10_match *ofmatch,
139 uint32_t ofpfw = ntohl(ofmatch->wildcards) & OFPFW10_ALL;
141 /* Initialize match->wc. */
142 memset(match->flow.zeros, 0, sizeof match->flow.zeros);
143 ofputil_wildcard_from_ofpfw10(ofpfw, &match->wc);
145 /* Initialize most of match->flow. */
146 match->flow.nw_src = ofmatch->nw_src;
147 match->flow.nw_dst = ofmatch->nw_dst;
148 match->flow.in_port = ntohs(ofmatch->in_port);
149 match->flow.dl_type = ofputil_dl_type_from_openflow(ofmatch->dl_type);
150 match->flow.tp_src = ofmatch->tp_src;
151 match->flow.tp_dst = ofmatch->tp_dst;
152 memcpy(match->flow.dl_src, ofmatch->dl_src, ETH_ADDR_LEN);
153 memcpy(match->flow.dl_dst, ofmatch->dl_dst, ETH_ADDR_LEN);
154 match->flow.nw_tos = ofmatch->nw_tos & IP_DSCP_MASK;
155 match->flow.nw_proto = ofmatch->nw_proto;
157 /* Translate VLANs. */
158 if (!(ofpfw & OFPFW10_DL_VLAN) &&
159 ofmatch->dl_vlan == htons(OFP10_VLAN_NONE)) {
160 /* Match only packets without 802.1Q header.
162 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
164 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
165 * because we can't have a specific PCP without an 802.1Q header.
166 * However, older versions of OVS treated this as matching packets
167 * withut an 802.1Q header, so we do here too. */
168 match->flow.vlan_tci = htons(0);
169 match->wc.masks.vlan_tci = htons(0xffff);
171 ovs_be16 vid, pcp, tci;
173 vid = ofmatch->dl_vlan & htons(VLAN_VID_MASK);
174 pcp = htons((ofmatch->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
175 tci = vid | pcp | htons(VLAN_CFI);
176 match->flow.vlan_tci = tci & match->wc.masks.vlan_tci;
180 match_zero_wildcarded_fields(match);
183 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
185 ofputil_match_to_ofp10_match(const struct match *match,
186 struct ofp10_match *ofmatch)
188 const struct flow_wildcards *wc = &match->wc;
191 /* Figure out most OpenFlow wildcards. */
193 if (!wc->masks.in_port) {
194 ofpfw |= OFPFW10_IN_PORT;
196 if (!wc->masks.dl_type) {
197 ofpfw |= OFPFW10_DL_TYPE;
199 if (!wc->masks.nw_proto) {
200 ofpfw |= OFPFW10_NW_PROTO;
202 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_src)
203 << OFPFW10_NW_SRC_SHIFT);
204 ofpfw |= (ofputil_netmask_to_wcbits(wc->masks.nw_dst)
205 << OFPFW10_NW_DST_SHIFT);
206 if (!(wc->masks.nw_tos & IP_DSCP_MASK)) {
207 ofpfw |= OFPFW10_NW_TOS;
209 if (!wc->masks.tp_src) {
210 ofpfw |= OFPFW10_TP_SRC;
212 if (!wc->masks.tp_dst) {
213 ofpfw |= OFPFW10_TP_DST;
215 if (eth_addr_is_zero(wc->masks.dl_src)) {
216 ofpfw |= OFPFW10_DL_SRC;
218 if (eth_addr_is_zero(wc->masks.dl_dst)) {
219 ofpfw |= OFPFW10_DL_DST;
222 /* Translate VLANs. */
223 ofmatch->dl_vlan = htons(0);
224 ofmatch->dl_vlan_pcp = 0;
225 if (match->wc.masks.vlan_tci == htons(0)) {
226 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
227 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
228 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
229 ofmatch->dl_vlan = htons(OFP10_VLAN_NONE);
230 ofpfw |= OFPFW10_DL_VLAN_PCP;
232 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
233 ofpfw |= OFPFW10_DL_VLAN;
235 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
238 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
239 ofpfw |= OFPFW10_DL_VLAN_PCP;
241 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
245 /* Compose most of the match structure. */
246 ofmatch->wildcards = htonl(ofpfw);
247 ofmatch->in_port = htons(match->flow.in_port);
248 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
249 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
250 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
251 ofmatch->nw_src = match->flow.nw_src;
252 ofmatch->nw_dst = match->flow.nw_dst;
253 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
254 ofmatch->nw_proto = match->flow.nw_proto;
255 ofmatch->tp_src = match->flow.tp_src;
256 ofmatch->tp_dst = match->flow.tp_dst;
257 memset(ofmatch->pad1, '\0', sizeof ofmatch->pad1);
258 memset(ofmatch->pad2, '\0', sizeof ofmatch->pad2);
262 ofputil_pull_ofp11_match(struct ofpbuf *buf, struct match *match,
263 uint16_t *padded_match_len)
265 struct ofp11_match_header *omh = buf->data;
268 if (buf->size < sizeof *omh) {
269 return OFPERR_OFPBMC_BAD_LEN;
272 match_len = ntohs(omh->length);
274 switch (ntohs(omh->type)) {
275 case OFPMT_STANDARD: {
276 struct ofp11_match *om;
278 if (match_len != sizeof *om || buf->size < sizeof *om) {
279 return OFPERR_OFPBMC_BAD_LEN;
281 om = ofpbuf_pull(buf, sizeof *om);
282 if (padded_match_len) {
283 *padded_match_len = match_len;
285 return ofputil_match_from_ofp11_match(om, match);
289 if (padded_match_len) {
290 *padded_match_len = ROUND_UP(match_len, 8);
292 return oxm_pull_match(buf, match);
295 return OFPERR_OFPBMC_BAD_TYPE;
299 /* Converts the ofp11_match in 'match' into a struct match in 'match. Returns
300 * 0 if successful, otherwise an OFPERR_* value. */
302 ofputil_match_from_ofp11_match(const struct ofp11_match *ofmatch,
305 uint16_t wc = ntohl(ofmatch->wildcards);
306 uint8_t dl_src_mask[ETH_ADDR_LEN];
307 uint8_t dl_dst_mask[ETH_ADDR_LEN];
311 match_init_catchall(match);
313 if (!(wc & OFPFW11_IN_PORT)) {
317 error = ofputil_port_from_ofp11(ofmatch->in_port, &ofp_port);
319 return OFPERR_OFPBMC_BAD_VALUE;
321 match_set_in_port(match, ofp_port);
324 for (i = 0; i < ETH_ADDR_LEN; i++) {
325 dl_src_mask[i] = ~ofmatch->dl_src_mask[i];
327 match_set_dl_src_masked(match, ofmatch->dl_src, dl_src_mask);
329 for (i = 0; i < ETH_ADDR_LEN; i++) {
330 dl_dst_mask[i] = ~ofmatch->dl_dst_mask[i];
332 match_set_dl_dst_masked(match, ofmatch->dl_dst, dl_dst_mask);
334 if (!(wc & OFPFW11_DL_VLAN)) {
335 if (ofmatch->dl_vlan == htons(OFPVID11_NONE)) {
336 /* Match only packets without a VLAN tag. */
337 match->flow.vlan_tci = htons(0);
338 match->wc.masks.vlan_tci = htons(UINT16_MAX);
340 if (ofmatch->dl_vlan == htons(OFPVID11_ANY)) {
341 /* Match any packet with a VLAN tag regardless of VID. */
342 match->flow.vlan_tci = htons(VLAN_CFI);
343 match->wc.masks.vlan_tci = htons(VLAN_CFI);
344 } else if (ntohs(ofmatch->dl_vlan) < 4096) {
345 /* Match only packets with the specified VLAN VID. */
346 match->flow.vlan_tci = htons(VLAN_CFI) | ofmatch->dl_vlan;
347 match->wc.masks.vlan_tci = htons(VLAN_CFI | VLAN_VID_MASK);
350 return OFPERR_OFPBMC_BAD_VALUE;
353 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
354 if (ofmatch->dl_vlan_pcp <= 7) {
355 match->flow.vlan_tci |= htons(ofmatch->dl_vlan_pcp
357 match->wc.masks.vlan_tci |= htons(VLAN_PCP_MASK);
360 return OFPERR_OFPBMC_BAD_VALUE;
366 if (!(wc & OFPFW11_DL_TYPE)) {
367 match_set_dl_type(match,
368 ofputil_dl_type_from_openflow(ofmatch->dl_type));
371 ipv4 = match->flow.dl_type == htons(ETH_TYPE_IP);
372 arp = match->flow.dl_type == htons(ETH_TYPE_ARP);
374 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
375 if (ofmatch->nw_tos & ~IP_DSCP_MASK) {
377 return OFPERR_OFPBMC_BAD_VALUE;
380 match_set_nw_dscp(match, ofmatch->nw_tos);
384 if (!(wc & OFPFW11_NW_PROTO)) {
385 match_set_nw_proto(match, ofmatch->nw_proto);
387 match_set_nw_src_masked(match, ofmatch->nw_src, ~ofmatch->nw_src_mask);
388 match_set_nw_dst_masked(match, ofmatch->nw_dst, ~ofmatch->nw_dst_mask);
391 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
392 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
393 switch (match->flow.nw_proto) {
395 /* "A.2.3 Flow Match Structures" in OF1.1 says:
397 * The tp_src and tp_dst fields will be ignored unless the
398 * network protocol specified is as TCP, UDP or SCTP.
400 * but I'm pretty sure we should support ICMP too, otherwise
401 * that's a regression from OF1.0. */
402 if (!(wc & OFPFW11_TP_SRC)) {
403 uint16_t icmp_type = ntohs(ofmatch->tp_src);
404 if (icmp_type < 0x100) {
405 match_set_icmp_type(match, icmp_type);
407 return OFPERR_OFPBMC_BAD_FIELD;
410 if (!(wc & OFPFW11_TP_DST)) {
411 uint16_t icmp_code = ntohs(ofmatch->tp_dst);
412 if (icmp_code < 0x100) {
413 match_set_icmp_code(match, icmp_code);
415 return OFPERR_OFPBMC_BAD_FIELD;
422 if (!(wc & (OFPFW11_TP_SRC))) {
423 match_set_tp_src(match, ofmatch->tp_src);
425 if (!(wc & (OFPFW11_TP_DST))) {
426 match_set_tp_dst(match, ofmatch->tp_dst);
431 /* We don't support SCTP and it seems that we should tell the
432 * controller, since OF1.1 implementations are supposed to. */
433 return OFPERR_OFPBMC_BAD_FIELD;
436 /* OF1.1 says explicitly to ignore this. */
441 if (match->flow.dl_type == htons(ETH_TYPE_MPLS) ||
442 match->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
443 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
445 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
446 /* MPLS not supported. */
447 return OFPERR_OFPBMC_BAD_TAG;
451 match_set_metadata_masked(match, ofmatch->metadata,
452 ~ofmatch->metadata_mask);
457 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
459 ofputil_match_to_ofp11_match(const struct match *match,
460 struct ofp11_match *ofmatch)
465 memset(ofmatch, 0, sizeof *ofmatch);
466 ofmatch->omh.type = htons(OFPMT_STANDARD);
467 ofmatch->omh.length = htons(OFPMT11_STANDARD_LENGTH);
469 if (!match->wc.masks.in_port) {
470 wc |= OFPFW11_IN_PORT;
472 ofmatch->in_port = ofputil_port_to_ofp11(match->flow.in_port);
475 memcpy(ofmatch->dl_src, match->flow.dl_src, ETH_ADDR_LEN);
476 for (i = 0; i < ETH_ADDR_LEN; i++) {
477 ofmatch->dl_src_mask[i] = ~match->wc.masks.dl_src[i];
480 memcpy(ofmatch->dl_dst, match->flow.dl_dst, ETH_ADDR_LEN);
481 for (i = 0; i < ETH_ADDR_LEN; i++) {
482 ofmatch->dl_dst_mask[i] = ~match->wc.masks.dl_dst[i];
485 if (match->wc.masks.vlan_tci == htons(0)) {
486 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
487 } else if (match->wc.masks.vlan_tci & htons(VLAN_CFI)
488 && !(match->flow.vlan_tci & htons(VLAN_CFI))) {
489 ofmatch->dl_vlan = htons(OFPVID11_NONE);
490 wc |= OFPFW11_DL_VLAN_PCP;
492 if (!(match->wc.masks.vlan_tci & htons(VLAN_VID_MASK))) {
493 ofmatch->dl_vlan = htons(OFPVID11_ANY);
495 ofmatch->dl_vlan = htons(vlan_tci_to_vid(match->flow.vlan_tci));
498 if (!(match->wc.masks.vlan_tci & htons(VLAN_PCP_MASK))) {
499 wc |= OFPFW11_DL_VLAN_PCP;
501 ofmatch->dl_vlan_pcp = vlan_tci_to_pcp(match->flow.vlan_tci);
505 if (!match->wc.masks.dl_type) {
506 wc |= OFPFW11_DL_TYPE;
508 ofmatch->dl_type = ofputil_dl_type_to_openflow(match->flow.dl_type);
511 if (!(match->wc.masks.nw_tos & IP_DSCP_MASK)) {
512 wc |= OFPFW11_NW_TOS;
514 ofmatch->nw_tos = match->flow.nw_tos & IP_DSCP_MASK;
517 if (!match->wc.masks.nw_proto) {
518 wc |= OFPFW11_NW_PROTO;
520 ofmatch->nw_proto = match->flow.nw_proto;
523 ofmatch->nw_src = match->flow.nw_src;
524 ofmatch->nw_src_mask = ~match->wc.masks.nw_src;
525 ofmatch->nw_dst = match->flow.nw_dst;
526 ofmatch->nw_dst_mask = ~match->wc.masks.nw_dst;
528 if (!match->wc.masks.tp_src) {
529 wc |= OFPFW11_TP_SRC;
531 ofmatch->tp_src = match->flow.tp_src;
534 if (!match->wc.masks.tp_dst) {
535 wc |= OFPFW11_TP_DST;
537 ofmatch->tp_dst = match->flow.tp_dst;
540 /* MPLS not supported. */
541 wc |= OFPFW11_MPLS_LABEL;
542 wc |= OFPFW11_MPLS_TC;
544 ofmatch->metadata = match->flow.metadata;
545 ofmatch->metadata_mask = ~match->wc.masks.metadata;
547 ofmatch->wildcards = htonl(wc);
550 /* Given a 'dl_type' value in the format used in struct flow, returns the
551 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
554 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
556 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
557 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
561 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
562 * structure, returns the corresponding 'dl_type' value for use in struct
565 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
567 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
568 ? htons(FLOW_DL_TYPE_NONE)
574 struct proto_abbrev {
575 enum ofputil_protocol protocol;
579 /* Most users really don't care about some of the differences between
580 * protocols. These abbreviations help with that. */
581 static const struct proto_abbrev proto_abbrevs[] = {
582 { OFPUTIL_P_ANY, "any" },
583 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
584 { OFPUTIL_P_NXM_ANY, "NXM" },
586 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
588 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
592 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
594 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
595 * connection that has negotiated the given 'version'. 'version' should
596 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
597 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
598 * outside the valid range. */
599 enum ofputil_protocol
600 ofputil_protocol_from_ofp_version(enum ofp_version version)
604 return OFPUTIL_P_OF10;
606 return OFPUTIL_P_OF12;
613 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
614 * OFP11_VERSION or OFP12_VERSION) that corresponds to 'protocol'. */
616 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
620 case OFPUTIL_P_OF10_TID:
622 case OFPUTIL_P_NXM_TID:
623 return OFP10_VERSION;
625 return OFP12_VERSION;
631 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
634 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
636 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
639 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
640 * extension turned on or off if 'enable' is true or false, respectively.
642 * This extension is only useful for protocols whose "standard" version does
643 * not allow specific tables to be modified. In particular, this is true of
644 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
645 * specifies a table ID and so there is no need for such an extension. When
646 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
647 * extension, this function just returns its 'protocol' argument unchanged
648 * regardless of the value of 'enable'. */
649 enum ofputil_protocol
650 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
654 case OFPUTIL_P_OF10_TID:
655 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
658 case OFPUTIL_P_NXM_TID:
659 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
662 return OFPUTIL_P_OF12;
669 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
670 * some extension to a standard protocol version, the return value is the
671 * standard version of that protocol without any extension. If 'protocol' is a
672 * standard protocol version, returns 'protocol' unchanged. */
673 enum ofputil_protocol
674 ofputil_protocol_to_base(enum ofputil_protocol protocol)
676 return ofputil_protocol_set_tid(protocol, false);
679 /* Returns 'new_base' with any extensions taken from 'cur'. */
680 enum ofputil_protocol
681 ofputil_protocol_set_base(enum ofputil_protocol cur,
682 enum ofputil_protocol new_base)
684 bool tid = (cur & OFPUTIL_P_TID) != 0;
688 case OFPUTIL_P_OF10_TID:
689 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
692 case OFPUTIL_P_NXM_TID:
693 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
696 return ofputil_protocol_set_tid(OFPUTIL_P_OF12, tid);
703 /* Returns a string form of 'protocol', if a simple form exists (that is, if
704 * 'protocol' is either a single protocol or it is a combination of protocols
705 * that have a single abbreviation). Otherwise, returns NULL. */
707 ofputil_protocol_to_string(enum ofputil_protocol protocol)
709 const struct proto_abbrev *p;
711 /* Use a "switch" statement for single-bit names so that we get a compiler
712 * warning if we forget any. */
715 return "NXM-table_id";
717 case OFPUTIL_P_NXM_TID:
718 return "NXM+table_id";
721 return "OpenFlow10-table_id";
723 case OFPUTIL_P_OF10_TID:
724 return "OpenFlow10+table_id";
730 /* Check abbreviations. */
731 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
732 if (protocol == p->protocol) {
740 /* Returns a string that represents 'protocols'. The return value might be a
741 * comma-separated list if 'protocols' doesn't have a simple name. The return
742 * value is "none" if 'protocols' is 0.
744 * The caller must free the returned string (with free()). */
746 ofputil_protocols_to_string(enum ofputil_protocol protocols)
750 assert(!(protocols & ~OFPUTIL_P_ANY));
751 if (protocols == 0) {
752 return xstrdup("none");
757 const struct proto_abbrev *p;
761 ds_put_char(&s, ',');
764 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
765 if ((protocols & p->protocol) == p->protocol) {
766 ds_put_cstr(&s, p->name);
767 protocols &= ~p->protocol;
772 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
773 enum ofputil_protocol bit = 1u << i;
775 if (protocols & bit) {
776 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
785 return ds_steal_cstr(&s);
788 static enum ofputil_protocol
789 ofputil_protocol_from_string__(const char *s, size_t n)
791 const struct proto_abbrev *p;
794 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
795 enum ofputil_protocol bit = 1u << i;
796 const char *name = ofputil_protocol_to_string(bit);
798 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
803 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
804 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
812 /* Returns the nonempty set of protocols represented by 's', which can be a
813 * single protocol name or abbreviation or a comma-separated list of them.
815 * Aborts the program with an error message if 's' is invalid. */
816 enum ofputil_protocol
817 ofputil_protocols_from_string(const char *s)
819 const char *orig_s = s;
820 enum ofputil_protocol protocols;
824 enum ofputil_protocol p;
833 p = ofputil_protocol_from_string__(s, n);
835 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
843 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
849 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
851 switch (packet_in_format) {
852 case NXPIF_OPENFLOW10:
861 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
863 switch (packet_in_format) {
864 case NXPIF_OPENFLOW10:
874 ofputil_packet_in_format_from_string(const char *s)
876 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
877 : !strcmp(s, "nxm") ? NXPIF_NXM
882 regs_fully_wildcarded(const struct flow_wildcards *wc)
886 for (i = 0; i < FLOW_N_REGS; i++) {
887 if (wc->masks.regs[i] != 0) {
894 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'match'
895 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
896 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
897 * use OpenFlow 1.0 protocol for backward compatibility. */
898 enum ofputil_protocol
899 ofputil_usable_protocols(const struct match *match)
901 const struct flow_wildcards *wc = &match->wc;
903 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
905 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
906 if (!eth_mask_is_exact(wc->masks.dl_src)
907 && !eth_addr_is_zero(wc->masks.dl_src)) {
908 return OFPUTIL_P_NXM_ANY;
910 if (!eth_mask_is_exact(wc->masks.dl_dst)
911 && !eth_addr_is_zero(wc->masks.dl_dst)) {
912 return OFPUTIL_P_NXM_ANY;
915 /* NXM and OF1.1+ support matching metadata. */
916 if (wc->masks.metadata != htonll(0)) {
917 return OFPUTIL_P_NXM_ANY;
920 /* Only NXM supports matching ARP hardware addresses. */
921 if (!eth_addr_is_zero(wc->masks.arp_sha) ||
922 !eth_addr_is_zero(wc->masks.arp_tha)) {
923 return OFPUTIL_P_NXM_ANY;
926 /* Only NXM supports matching IPv6 traffic. */
927 if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
928 return OFPUTIL_P_NXM_ANY;
931 /* Only NXM supports matching registers. */
932 if (!regs_fully_wildcarded(wc)) {
933 return OFPUTIL_P_NXM_ANY;
936 /* Only NXM supports matching tun_id. */
937 if (wc->masks.tun_id != htonll(0)) {
938 return OFPUTIL_P_NXM_ANY;
941 /* Only NXM supports matching fragments. */
942 if (wc->masks.nw_frag) {
943 return OFPUTIL_P_NXM_ANY;
946 /* Only NXM supports matching IPv6 flow label. */
947 if (wc->masks.ipv6_label) {
948 return OFPUTIL_P_NXM_ANY;
951 /* Only NXM supports matching IP ECN bits. */
952 if (wc->masks.nw_tos & IP_ECN_MASK) {
953 return OFPUTIL_P_NXM_ANY;
956 /* Only NXM supports matching IP TTL/hop limit. */
957 if (wc->masks.nw_ttl) {
958 return OFPUTIL_P_NXM_ANY;
961 /* Only NXM supports non-CIDR IPv4 address masks. */
962 if (!ip_is_cidr(wc->masks.nw_src) || !ip_is_cidr(wc->masks.nw_dst)) {
963 return OFPUTIL_P_NXM_ANY;
966 /* Only NXM supports bitwise matching on transport port. */
967 if ((wc->masks.tp_src && wc->masks.tp_src != htons(UINT16_MAX)) ||
968 (wc->masks.tp_dst && wc->masks.tp_dst != htons(UINT16_MAX))) {
969 return OFPUTIL_P_NXM_ANY;
972 /* Other formats can express this rule. */
973 return OFPUTIL_P_ANY;
976 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
977 * protocol is 'current', at least partly transitions the protocol to 'want'.
978 * Stores in '*next' the protocol that will be in effect on the OpenFlow
979 * connection if the switch processes the returned message correctly. (If
980 * '*next != want' then the caller will have to iterate.)
982 * If 'current == want', returns NULL and stores 'current' in '*next'. */
984 ofputil_encode_set_protocol(enum ofputil_protocol current,
985 enum ofputil_protocol want,
986 enum ofputil_protocol *next)
988 enum ofputil_protocol cur_base, want_base;
989 bool cur_tid, want_tid;
991 cur_base = ofputil_protocol_to_base(current);
992 want_base = ofputil_protocol_to_base(want);
993 if (cur_base != want_base) {
994 *next = ofputil_protocol_set_base(current, want_base);
998 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1000 case OFPUTIL_P_OF10:
1001 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1003 case OFPUTIL_P_OF12:
1004 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW12);
1006 case OFPUTIL_P_OF10_TID:
1007 case OFPUTIL_P_NXM_TID:
1012 cur_tid = (current & OFPUTIL_P_TID) != 0;
1013 want_tid = (want & OFPUTIL_P_TID) != 0;
1014 if (cur_tid != want_tid) {
1015 *next = ofputil_protocol_set_tid(current, want_tid);
1016 return ofputil_make_flow_mod_table_id(want_tid);
1019 assert(current == want);
1025 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1026 * format to 'nxff'. */
1028 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1030 struct nx_set_flow_format *sff;
1033 assert(ofputil_nx_flow_format_is_valid(nxff));
1035 msg = ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT, OFP10_VERSION, 0);
1036 sff = ofpbuf_put_zeros(msg, sizeof *sff);
1037 sff->format = htonl(nxff);
1042 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1044 enum ofputil_protocol
1045 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1047 switch (flow_format) {
1048 case NXFF_OPENFLOW10:
1049 return OFPUTIL_P_OF10;
1052 return OFPUTIL_P_NXM;
1054 case NXFF_OPENFLOW12:
1055 return OFPUTIL_P_OF12;
1062 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1064 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1066 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1069 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1072 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1074 switch (flow_format) {
1075 case NXFF_OPENFLOW10:
1076 return "openflow10";
1079 case NXFF_OPENFLOW12:
1080 return "openflow12";
1087 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1089 struct nx_set_packet_in_format *spif;
1092 msg = ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION, 0);
1093 spif = ofpbuf_put_zeros(msg, sizeof *spif);
1094 spif->format = htonl(packet_in_format);
1099 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1100 * extension on or off (according to 'flow_mod_table_id'). */
1102 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1104 struct nx_flow_mod_table_id *nfmti;
1107 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION, 0);
1108 nfmti = ofpbuf_put_zeros(msg, sizeof *nfmti);
1109 nfmti->set = flow_mod_table_id;
1113 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1114 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1117 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1118 * The caller must initialize 'ofpacts' and retains ownership of it.
1119 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1121 * Does not validate the flow_mod actions. The caller should do that, with
1122 * ofpacts_check(). */
1124 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1125 const struct ofp_header *oh,
1126 enum ofputil_protocol protocol,
1127 struct ofpbuf *ofpacts)
1133 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1134 raw = ofpraw_pull_assert(&b);
1135 if (raw == OFPRAW_OFPT11_FLOW_MOD) {
1136 /* Standard OpenFlow 1.1 flow_mod. */
1137 const struct ofp11_flow_mod *ofm;
1140 ofm = ofpbuf_pull(&b, sizeof *ofm);
1142 error = ofputil_pull_ofp11_match(&b, &fm->match, NULL);
1147 error = ofpacts_pull_openflow11_instructions(&b, b.size, ofpacts);
1152 /* Translate the message. */
1153 fm->priority = ntohs(ofm->priority);
1154 if (ofm->command == OFPFC_ADD) {
1155 fm->cookie = htonll(0);
1156 fm->cookie_mask = htonll(0);
1157 fm->new_cookie = ofm->cookie;
1160 fm->cookie = ofm->cookie;
1161 fm->cookie_mask = ofm->cookie_mask;
1162 fm->new_cookie = htonll(UINT64_MAX);
1164 fm->command = ofm->command;
1165 fm->table_id = ofm->table_id;
1166 fm->idle_timeout = ntohs(ofm->idle_timeout);
1167 fm->hard_timeout = ntohs(ofm->hard_timeout);
1168 fm->buffer_id = ntohl(ofm->buffer_id);
1169 error = ofputil_port_from_ofp11(ofm->out_port, &fm->out_port);
1173 if (ofm->out_group != htonl(OFPG_ANY)) {
1174 return OFPERR_OFPFMFC_UNKNOWN;
1176 fm->flags = ntohs(ofm->flags);
1178 if (raw == OFPRAW_OFPT10_FLOW_MOD) {
1179 /* Standard OpenFlow 1.0 flow_mod. */
1180 const struct ofp10_flow_mod *ofm;
1183 /* Get the ofp10_flow_mod. */
1184 ofm = ofpbuf_pull(&b, sizeof *ofm);
1186 /* Translate the rule. */
1187 ofputil_match_from_ofp10_match(&ofm->match, &fm->match);
1188 ofputil_normalize_match(&fm->match);
1190 /* Now get the actions. */
1191 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1196 /* OpenFlow 1.0 says that exact-match rules have to have the
1197 * highest possible priority. */
1198 fm->priority = (ofm->match.wildcards & htonl(OFPFW10_ALL)
1199 ? ntohs(ofm->priority)
1202 /* Translate the message. */
1203 command = ntohs(ofm->command);
1204 fm->cookie = htonll(0);
1205 fm->cookie_mask = htonll(0);
1206 fm->new_cookie = ofm->cookie;
1207 fm->idle_timeout = ntohs(ofm->idle_timeout);
1208 fm->hard_timeout = ntohs(ofm->hard_timeout);
1209 fm->buffer_id = ntohl(ofm->buffer_id);
1210 fm->out_port = ntohs(ofm->out_port);
1211 fm->flags = ntohs(ofm->flags);
1212 } else if (raw == OFPRAW_NXT_FLOW_MOD) {
1213 /* Nicira extended flow_mod. */
1214 const struct nx_flow_mod *nfm;
1217 /* Dissect the message. */
1218 nfm = ofpbuf_pull(&b, sizeof *nfm);
1219 error = nx_pull_match(&b, ntohs(nfm->match_len),
1220 &fm->match, &fm->cookie, &fm->cookie_mask);
1224 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1229 /* Translate the message. */
1230 command = ntohs(nfm->command);
1231 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1232 /* Flow additions may only set a new cookie, not match an
1233 * existing cookie. */
1234 return OFPERR_NXBRC_NXM_INVALID;
1236 fm->priority = ntohs(nfm->priority);
1237 fm->new_cookie = nfm->cookie;
1238 fm->idle_timeout = ntohs(nfm->idle_timeout);
1239 fm->hard_timeout = ntohs(nfm->hard_timeout);
1240 fm->buffer_id = ntohl(nfm->buffer_id);
1241 fm->out_port = ntohs(nfm->out_port);
1242 fm->flags = ntohs(nfm->flags);
1247 if (protocol & OFPUTIL_P_TID) {
1248 fm->command = command & 0xff;
1249 fm->table_id = command >> 8;
1251 fm->command = command;
1252 fm->table_id = 0xff;
1256 fm->ofpacts = ofpacts->data;
1257 fm->ofpacts_len = ofpacts->size;
1263 ofputil_tid_command(const struct ofputil_flow_mod *fm,
1264 enum ofputil_protocol protocol)
1266 return htons(protocol & OFPUTIL_P_TID
1267 ? (fm->command & 0xff) | (fm->table_id << 8)
1271 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1272 * 'protocol' and returns the message. */
1274 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1275 enum ofputil_protocol protocol)
1280 case OFPUTIL_P_OF12: {
1281 struct ofp11_flow_mod *ofm;
1283 msg = ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD, OFP12_VERSION,
1284 NXM_TYPICAL_LEN + fm->ofpacts_len);
1285 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1286 ofm->cookie = fm->new_cookie;
1287 ofm->cookie_mask = fm->cookie_mask;
1288 ofm->table_id = fm->table_id;
1289 ofm->command = fm->command;
1290 ofm->idle_timeout = htons(fm->idle_timeout);
1291 ofm->hard_timeout = htons(fm->hard_timeout);
1292 ofm->priority = htons(fm->priority);
1293 ofm->buffer_id = htonl(fm->buffer_id);
1294 ofm->out_port = ofputil_port_to_ofp11(fm->out_port);
1295 ofm->out_group = htonl(OFPG11_ANY);
1296 ofm->flags = htons(fm->flags);
1297 oxm_put_match(msg, &fm->match);
1298 ofpacts_put_openflow11_instructions(fm->ofpacts, fm->ofpacts_len, msg);
1302 case OFPUTIL_P_OF10:
1303 case OFPUTIL_P_OF10_TID: {
1304 struct ofp10_flow_mod *ofm;
1306 msg = ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD, OFP10_VERSION,
1308 ofm = ofpbuf_put_zeros(msg, sizeof *ofm);
1309 ofputil_match_to_ofp10_match(&fm->match, &ofm->match);
1310 ofm->cookie = fm->new_cookie;
1311 ofm->command = ofputil_tid_command(fm, protocol);
1312 ofm->idle_timeout = htons(fm->idle_timeout);
1313 ofm->hard_timeout = htons(fm->hard_timeout);
1314 ofm->priority = htons(fm->priority);
1315 ofm->buffer_id = htonl(fm->buffer_id);
1316 ofm->out_port = htons(fm->out_port);
1317 ofm->flags = htons(fm->flags);
1318 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1323 case OFPUTIL_P_NXM_TID: {
1324 struct nx_flow_mod *nfm;
1327 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MOD, OFP10_VERSION,
1328 NXM_TYPICAL_LEN + fm->ofpacts_len);
1329 nfm = ofpbuf_put_zeros(msg, sizeof *nfm);
1330 nfm->command = ofputil_tid_command(fm, protocol);
1331 nfm->cookie = fm->new_cookie;
1332 match_len = nx_put_match(msg, &fm->match, fm->cookie, fm->cookie_mask);
1334 nfm->idle_timeout = htons(fm->idle_timeout);
1335 nfm->hard_timeout = htons(fm->hard_timeout);
1336 nfm->priority = htons(fm->priority);
1337 nfm->buffer_id = htonl(fm->buffer_id);
1338 nfm->out_port = htons(fm->out_port);
1339 nfm->flags = htons(fm->flags);
1340 nfm->match_len = htons(match_len);
1341 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1349 ofpmsg_update_length(msg);
1353 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1354 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1355 * 0-bit for each protocol that is inadequate.
1357 * (The return value will have at least one 1-bit.) */
1358 enum ofputil_protocol
1359 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1362 enum ofputil_protocol usable_protocols;
1365 usable_protocols = OFPUTIL_P_ANY;
1366 for (i = 0; i < n_fms; i++) {
1367 const struct ofputil_flow_mod *fm = &fms[i];
1369 usable_protocols &= ofputil_usable_protocols(&fm->match);
1370 if (fm->table_id != 0xff) {
1371 usable_protocols &= OFPUTIL_P_TID;
1374 /* Matching of the cookie is only supported through NXM. */
1375 if (fm->cookie_mask != htonll(0)) {
1376 usable_protocols &= OFPUTIL_P_NXM_ANY;
1379 assert(usable_protocols);
1381 return usable_protocols;
1385 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request *fsr,
1386 const struct ofp10_flow_stats_request *ofsr,
1389 fsr->aggregate = aggregate;
1390 ofputil_match_from_ofp10_match(&ofsr->match, &fsr->match);
1391 fsr->out_port = ntohs(ofsr->out_port);
1392 fsr->table_id = ofsr->table_id;
1393 fsr->cookie = fsr->cookie_mask = htonll(0);
1399 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request *fsr,
1400 struct ofpbuf *b, bool aggregate)
1402 const struct ofp11_flow_stats_request *ofsr;
1405 ofsr = ofpbuf_pull(b, sizeof *ofsr);
1406 fsr->aggregate = aggregate;
1407 fsr->table_id = ofsr->table_id;
1408 error = ofputil_port_from_ofp11(ofsr->out_port, &fsr->out_port);
1412 if (ofsr->out_group != htonl(OFPG11_ANY)) {
1413 return OFPERR_OFPFMFC_UNKNOWN;
1415 fsr->cookie = ofsr->cookie;
1416 fsr->cookie_mask = ofsr->cookie_mask;
1417 error = ofputil_pull_ofp11_match(b, &fsr->match, NULL);
1426 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1427 struct ofpbuf *b, bool aggregate)
1429 const struct nx_flow_stats_request *nfsr;
1432 nfsr = ofpbuf_pull(b, sizeof *nfsr);
1433 error = nx_pull_match(b, ntohs(nfsr->match_len), &fsr->match,
1434 &fsr->cookie, &fsr->cookie_mask);
1439 return OFPERR_OFPBRC_BAD_LEN;
1442 fsr->aggregate = aggregate;
1443 fsr->out_port = ntohs(nfsr->out_port);
1444 fsr->table_id = nfsr->table_id;
1449 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1450 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1451 * successful, otherwise an OpenFlow error code. */
1453 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1454 const struct ofp_header *oh)
1459 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1460 raw = ofpraw_pull_assert(&b);
1461 switch ((int) raw) {
1462 case OFPRAW_OFPST10_FLOW_REQUEST:
1463 return ofputil_decode_ofpst10_flow_request(fsr, b.data, false);
1465 case OFPRAW_OFPST10_AGGREGATE_REQUEST:
1466 return ofputil_decode_ofpst10_flow_request(fsr, b.data, true);
1468 case OFPRAW_OFPST11_FLOW_REQUEST:
1469 return ofputil_decode_ofpst11_flow_request(fsr, &b, false);
1471 case OFPRAW_OFPST11_AGGREGATE_REQUEST:
1472 return ofputil_decode_ofpst11_flow_request(fsr, &b, true);
1474 case OFPRAW_NXST_FLOW_REQUEST:
1475 return ofputil_decode_nxst_flow_request(fsr, &b, false);
1477 case OFPRAW_NXST_AGGREGATE_REQUEST:
1478 return ofputil_decode_nxst_flow_request(fsr, &b, true);
1481 /* Hey, the caller lied. */
1486 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1487 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1488 * 'protocol', and returns the message. */
1490 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1491 enum ofputil_protocol protocol)
1497 case OFPUTIL_P_OF12: {
1498 struct ofp11_flow_stats_request *ofsr;
1500 raw = (fsr->aggregate
1501 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
1502 : OFPRAW_OFPST11_FLOW_REQUEST);
1503 msg = ofpraw_alloc(raw, OFP12_VERSION, NXM_TYPICAL_LEN);
1504 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1505 ofsr->table_id = fsr->table_id;
1506 ofsr->out_port = ofputil_port_to_ofp11(fsr->out_port);
1507 ofsr->out_group = htonl(OFPG11_ANY);
1508 ofsr->cookie = fsr->cookie;
1509 ofsr->cookie_mask = fsr->cookie_mask;
1510 oxm_put_match(msg, &fsr->match);
1514 case OFPUTIL_P_OF10:
1515 case OFPUTIL_P_OF10_TID: {
1516 struct ofp10_flow_stats_request *ofsr;
1518 raw = (fsr->aggregate
1519 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
1520 : OFPRAW_OFPST10_FLOW_REQUEST);
1521 msg = ofpraw_alloc(raw, OFP10_VERSION, 0);
1522 ofsr = ofpbuf_put_zeros(msg, sizeof *ofsr);
1523 ofputil_match_to_ofp10_match(&fsr->match, &ofsr->match);
1524 ofsr->table_id = fsr->table_id;
1525 ofsr->out_port = htons(fsr->out_port);
1530 case OFPUTIL_P_NXM_TID: {
1531 struct nx_flow_stats_request *nfsr;
1534 raw = (fsr->aggregate
1535 ? OFPRAW_NXST_AGGREGATE_REQUEST
1536 : OFPRAW_NXST_FLOW_REQUEST);
1537 msg = ofpraw_alloc(raw, OFP10_VERSION, NXM_TYPICAL_LEN);
1538 ofpbuf_put_zeros(msg, sizeof *nfsr);
1539 match_len = nx_put_match(msg, &fsr->match,
1540 fsr->cookie, fsr->cookie_mask);
1543 nfsr->out_port = htons(fsr->out_port);
1544 nfsr->match_len = htons(match_len);
1545 nfsr->table_id = fsr->table_id;
1556 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1557 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1559 * (The return value will have at least one 1-bit.) */
1560 enum ofputil_protocol
1561 ofputil_flow_stats_request_usable_protocols(
1562 const struct ofputil_flow_stats_request *fsr)
1564 enum ofputil_protocol usable_protocols;
1566 usable_protocols = ofputil_usable_protocols(&fsr->match);
1567 if (fsr->cookie_mask != htonll(0)) {
1568 usable_protocols &= OFPUTIL_P_NXM_ANY;
1570 return usable_protocols;
1573 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1574 * ofputil_flow_stats in 'fs'.
1576 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1577 * OpenFlow message. Calling this function multiple times for a single 'msg'
1578 * iterates through the replies. The caller must initially leave 'msg''s layer
1579 * pointers null and not modify them between calls.
1581 * Most switches don't send the values needed to populate fs->idle_age and
1582 * fs->hard_age, so those members will usually be set to 0. If the switch from
1583 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1584 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1585 * 'idle_age' and 'hard_age' members in 'fs'.
1587 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
1588 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
1589 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
1591 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1592 * otherwise a positive errno value. */
1594 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1596 bool flow_age_extension,
1597 struct ofpbuf *ofpacts)
1603 ? ofpraw_decode(&raw, msg->l2)
1604 : ofpraw_pull(&raw, msg));
1611 } else if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1612 const struct ofp11_flow_stats *ofs;
1614 uint16_t padded_match_len;
1616 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1618 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1619 "bytes at end", msg->size);
1623 length = ntohs(ofs->length);
1624 if (length < sizeof *ofs) {
1625 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1626 "length %zu", length);
1630 if (ofputil_pull_ofp11_match(msg, &fs->match, &padded_match_len)) {
1631 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad match");
1635 if (ofpacts_pull_openflow11_instructions(msg, length - sizeof *ofs -
1636 padded_match_len, ofpacts)) {
1637 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply bad instructions");
1641 fs->priority = ntohs(ofs->priority);
1642 fs->table_id = ofs->table_id;
1643 fs->duration_sec = ntohl(ofs->duration_sec);
1644 fs->duration_nsec = ntohl(ofs->duration_nsec);
1645 fs->idle_timeout = ntohs(ofs->idle_timeout);
1646 fs->hard_timeout = ntohs(ofs->hard_timeout);
1649 fs->cookie = ofs->cookie;
1650 fs->packet_count = ntohll(ofs->packet_count);
1651 fs->byte_count = ntohll(ofs->byte_count);
1652 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1653 const struct ofp10_flow_stats *ofs;
1656 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1658 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1659 "bytes at end", msg->size);
1663 length = ntohs(ofs->length);
1664 if (length < sizeof *ofs) {
1665 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1666 "length %zu", length);
1670 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
1674 fs->cookie = get_32aligned_be64(&ofs->cookie);
1675 ofputil_match_from_ofp10_match(&ofs->match, &fs->match);
1676 fs->priority = ntohs(ofs->priority);
1677 fs->table_id = ofs->table_id;
1678 fs->duration_sec = ntohl(ofs->duration_sec);
1679 fs->duration_nsec = ntohl(ofs->duration_nsec);
1680 fs->idle_timeout = ntohs(ofs->idle_timeout);
1681 fs->hard_timeout = ntohs(ofs->hard_timeout);
1684 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1685 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1686 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1687 const struct nx_flow_stats *nfs;
1688 size_t match_len, actions_len, length;
1690 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1692 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1693 "bytes at end", msg->size);
1697 length = ntohs(nfs->length);
1698 match_len = ntohs(nfs->match_len);
1699 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1700 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1701 "claims invalid length %zu", match_len, length);
1704 if (nx_pull_match(msg, match_len, &fs->match, NULL, NULL)) {
1708 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
1709 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
1713 fs->cookie = nfs->cookie;
1714 fs->table_id = nfs->table_id;
1715 fs->duration_sec = ntohl(nfs->duration_sec);
1716 fs->duration_nsec = ntohl(nfs->duration_nsec);
1717 fs->priority = ntohs(nfs->priority);
1718 fs->idle_timeout = ntohs(nfs->idle_timeout);
1719 fs->hard_timeout = ntohs(nfs->hard_timeout);
1722 if (flow_age_extension) {
1723 if (nfs->idle_age) {
1724 fs->idle_age = ntohs(nfs->idle_age) - 1;
1726 if (nfs->hard_age) {
1727 fs->hard_age = ntohs(nfs->hard_age) - 1;
1730 fs->packet_count = ntohll(nfs->packet_count);
1731 fs->byte_count = ntohll(nfs->byte_count);
1736 fs->ofpacts = ofpacts->data;
1737 fs->ofpacts_len = ofpacts->size;
1742 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1744 * We use this in situations where OVS internally uses UINT64_MAX to mean
1745 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1747 unknown_to_zero(uint64_t count)
1749 return count != UINT64_MAX ? count : 0;
1752 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1753 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1754 * have been initialized with ofputil_start_stats_reply(). */
1756 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1757 struct list *replies)
1759 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
1760 size_t start_ofs = reply->size;
1763 ofpraw_decode_partial(&raw, reply->data, reply->size);
1764 if (raw == OFPRAW_OFPST11_FLOW_REPLY) {
1765 struct ofp11_flow_stats *ofs;
1767 ofpbuf_put_uninit(reply, sizeof *ofs);
1768 oxm_put_match(reply, &fs->match);
1769 ofpacts_put_openflow11_instructions(fs->ofpacts, fs->ofpacts_len,
1772 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1773 ofs->length = htons(reply->size - start_ofs);
1774 ofs->table_id = fs->table_id;
1776 ofs->duration_sec = htonl(fs->duration_sec);
1777 ofs->duration_nsec = htonl(fs->duration_nsec);
1778 ofs->priority = htons(fs->priority);
1779 ofs->idle_timeout = htons(fs->idle_timeout);
1780 ofs->hard_timeout = htons(fs->hard_timeout);
1781 memset(ofs->pad2, 0, sizeof ofs->pad2);
1782 ofs->cookie = fs->cookie;
1783 ofs->packet_count = htonll(unknown_to_zero(fs->packet_count));
1784 ofs->byte_count = htonll(unknown_to_zero(fs->byte_count));
1785 } else if (raw == OFPRAW_OFPST10_FLOW_REPLY) {
1786 struct ofp10_flow_stats *ofs;
1788 ofpbuf_put_uninit(reply, sizeof *ofs);
1789 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1791 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
1792 ofs->length = htons(reply->size - start_ofs);
1793 ofs->table_id = fs->table_id;
1795 ofputil_match_to_ofp10_match(&fs->match, &ofs->match);
1796 ofs->duration_sec = htonl(fs->duration_sec);
1797 ofs->duration_nsec = htonl(fs->duration_nsec);
1798 ofs->priority = htons(fs->priority);
1799 ofs->idle_timeout = htons(fs->idle_timeout);
1800 ofs->hard_timeout = htons(fs->hard_timeout);
1801 memset(ofs->pad2, 0, sizeof ofs->pad2);
1802 put_32aligned_be64(&ofs->cookie, fs->cookie);
1803 put_32aligned_be64(&ofs->packet_count,
1804 htonll(unknown_to_zero(fs->packet_count)));
1805 put_32aligned_be64(&ofs->byte_count,
1806 htonll(unknown_to_zero(fs->byte_count)));
1807 } else if (raw == OFPRAW_NXST_FLOW_REPLY) {
1808 struct nx_flow_stats *nfs;
1811 ofpbuf_put_uninit(reply, sizeof *nfs);
1812 match_len = nx_put_match(reply, &fs->match, 0, 0);
1813 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
1815 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
1816 nfs->length = htons(reply->size - start_ofs);
1817 nfs->table_id = fs->table_id;
1819 nfs->duration_sec = htonl(fs->duration_sec);
1820 nfs->duration_nsec = htonl(fs->duration_nsec);
1821 nfs->priority = htons(fs->priority);
1822 nfs->idle_timeout = htons(fs->idle_timeout);
1823 nfs->hard_timeout = htons(fs->hard_timeout);
1824 nfs->idle_age = htons(fs->idle_age < 0 ? 0
1825 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1827 nfs->hard_age = htons(fs->hard_age < 0 ? 0
1828 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1830 nfs->match_len = htons(match_len);
1831 nfs->cookie = fs->cookie;
1832 nfs->packet_count = htonll(fs->packet_count);
1833 nfs->byte_count = htonll(fs->byte_count);
1838 ofpmp_postappend(replies, start_ofs);
1841 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1842 * NXST_AGGREGATE reply matching 'request', and returns the message. */
1844 ofputil_encode_aggregate_stats_reply(
1845 const struct ofputil_aggregate_stats *stats,
1846 const struct ofp_header *request)
1848 struct ofp_aggregate_stats_reply *asr;
1849 uint64_t packet_count;
1850 uint64_t byte_count;
1854 ofpraw_decode(&raw, request);
1855 if (raw == OFPRAW_OFPST10_AGGREGATE_REQUEST) {
1856 packet_count = unknown_to_zero(stats->packet_count);
1857 byte_count = unknown_to_zero(stats->byte_count);
1859 packet_count = stats->packet_count;
1860 byte_count = stats->byte_count;
1863 msg = ofpraw_alloc_stats_reply(request, 0);
1864 asr = ofpbuf_put_zeros(msg, sizeof *asr);
1865 put_32aligned_be64(&asr->packet_count, htonll(packet_count));
1866 put_32aligned_be64(&asr->byte_count, htonll(byte_count));
1867 asr->flow_count = htonl(stats->flow_count);
1873 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats *stats,
1874 const struct ofp_header *reply)
1876 struct ofp_aggregate_stats_reply *asr;
1879 ofpbuf_use_const(&msg, reply, ntohs(reply->length));
1880 ofpraw_pull_assert(&msg);
1883 stats->packet_count = ntohll(get_32aligned_be64(&asr->packet_count));
1884 stats->byte_count = ntohll(get_32aligned_be64(&asr->byte_count));
1885 stats->flow_count = ntohl(asr->flow_count);
1890 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1891 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1892 * an OpenFlow error code. */
1894 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1895 const struct ofp_header *oh)
1900 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1901 raw = ofpraw_pull_assert(&b);
1902 if (raw == OFPRAW_OFPT11_FLOW_REMOVED) {
1903 const struct ofp12_flow_removed *ofr;
1906 ofr = ofpbuf_pull(&b, sizeof *ofr);
1908 error = ofputil_pull_ofp11_match(&b, &fr->match, NULL);
1913 fr->priority = ntohs(ofr->priority);
1914 fr->cookie = ofr->cookie;
1915 fr->reason = ofr->reason;
1916 /* XXX: ofr->table_id is ignored */
1917 fr->duration_sec = ntohl(ofr->duration_sec);
1918 fr->duration_nsec = ntohl(ofr->duration_nsec);
1919 fr->idle_timeout = ntohs(ofr->idle_timeout);
1920 fr->hard_timeout = ntohs(ofr->hard_timeout);
1921 fr->packet_count = ntohll(ofr->packet_count);
1922 fr->byte_count = ntohll(ofr->byte_count);
1923 } else if (raw == OFPRAW_OFPT10_FLOW_REMOVED) {
1924 const struct ofp_flow_removed *ofr;
1926 ofr = ofpbuf_pull(&b, sizeof *ofr);
1928 ofputil_match_from_ofp10_match(&ofr->match, &fr->match);
1929 fr->priority = ntohs(ofr->priority);
1930 fr->cookie = ofr->cookie;
1931 fr->reason = ofr->reason;
1932 fr->duration_sec = ntohl(ofr->duration_sec);
1933 fr->duration_nsec = ntohl(ofr->duration_nsec);
1934 fr->idle_timeout = ntohs(ofr->idle_timeout);
1935 fr->hard_timeout = 0;
1936 fr->packet_count = ntohll(ofr->packet_count);
1937 fr->byte_count = ntohll(ofr->byte_count);
1938 } else if (raw == OFPRAW_NXT_FLOW_REMOVED) {
1939 struct nx_flow_removed *nfr;
1942 nfr = ofpbuf_pull(&b, sizeof *nfr);
1943 error = nx_pull_match(&b, ntohs(nfr->match_len), &fr->match,
1949 return OFPERR_OFPBRC_BAD_LEN;
1952 fr->priority = ntohs(nfr->priority);
1953 fr->cookie = nfr->cookie;
1954 fr->reason = nfr->reason;
1955 fr->duration_sec = ntohl(nfr->duration_sec);
1956 fr->duration_nsec = ntohl(nfr->duration_nsec);
1957 fr->idle_timeout = ntohs(nfr->idle_timeout);
1958 fr->hard_timeout = 0;
1959 fr->packet_count = ntohll(nfr->packet_count);
1960 fr->byte_count = ntohll(nfr->byte_count);
1968 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1969 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1972 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1973 enum ofputil_protocol protocol)
1978 case OFPUTIL_P_OF12: {
1979 struct ofp12_flow_removed *ofr;
1981 msg = ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED,
1982 ofputil_protocol_to_ofp_version(protocol),
1983 htonl(0), NXM_TYPICAL_LEN);
1984 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
1985 ofr->cookie = fr->cookie;
1986 ofr->priority = htons(fr->priority);
1987 ofr->reason = fr->reason;
1989 ofr->duration_sec = htonl(fr->duration_sec);
1990 ofr->duration_nsec = htonl(fr->duration_nsec);
1991 ofr->idle_timeout = htons(fr->idle_timeout);
1992 ofr->hard_timeout = htons(fr->hard_timeout);
1993 ofr->packet_count = htonll(fr->packet_count);
1994 ofr->byte_count = htonll(fr->byte_count);
1995 oxm_put_match(msg, &fr->match);
1999 case OFPUTIL_P_OF10:
2000 case OFPUTIL_P_OF10_TID: {
2001 struct ofp_flow_removed *ofr;
2003 msg = ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED, OFP10_VERSION,
2005 ofr = ofpbuf_put_zeros(msg, sizeof *ofr);
2006 ofputil_match_to_ofp10_match(&fr->match, &ofr->match);
2007 ofr->cookie = fr->cookie;
2008 ofr->priority = htons(fr->priority);
2009 ofr->reason = fr->reason;
2010 ofr->duration_sec = htonl(fr->duration_sec);
2011 ofr->duration_nsec = htonl(fr->duration_nsec);
2012 ofr->idle_timeout = htons(fr->idle_timeout);
2013 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2014 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2019 case OFPUTIL_P_NXM_TID: {
2020 struct nx_flow_removed *nfr;
2023 msg = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED, OFP10_VERSION,
2024 htonl(0), NXM_TYPICAL_LEN);
2025 nfr = ofpbuf_put_zeros(msg, sizeof *nfr);
2026 match_len = nx_put_match(msg, &fr->match, 0, 0);
2029 nfr->cookie = fr->cookie;
2030 nfr->priority = htons(fr->priority);
2031 nfr->reason = fr->reason;
2032 nfr->duration_sec = htonl(fr->duration_sec);
2033 nfr->duration_nsec = htonl(fr->duration_nsec);
2034 nfr->idle_timeout = htons(fr->idle_timeout);
2035 nfr->match_len = htons(match_len);
2036 nfr->packet_count = htonll(fr->packet_count);
2037 nfr->byte_count = htonll(fr->byte_count);
2049 ofputil_decode_packet_in_finish(struct ofputil_packet_in *pin,
2050 struct match *match, struct ofpbuf *b)
2052 pin->packet = b->data;
2053 pin->packet_len = b->size;
2055 pin->fmd.in_port = match->flow.in_port;
2056 pin->fmd.tun_id = match->flow.tun_id;
2057 pin->fmd.metadata = match->flow.metadata;
2058 memcpy(pin->fmd.regs, match->flow.regs, sizeof pin->fmd.regs);
2062 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2063 const struct ofp_header *oh)
2068 memset(pin, 0, sizeof *pin);
2070 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2071 raw = ofpraw_pull_assert(&b);
2072 if (raw == OFPRAW_OFPT12_PACKET_IN) {
2073 const struct ofp12_packet_in *opi;
2077 opi = ofpbuf_pull(&b, sizeof *opi);
2078 error = oxm_pull_match_loose(&b, &match);
2083 if (!ofpbuf_try_pull(&b, 2)) {
2084 return OFPERR_OFPBRC_BAD_LEN;
2087 pin->reason = opi->reason;
2088 pin->table_id = opi->table_id;
2090 pin->buffer_id = ntohl(opi->buffer_id);
2091 pin->total_len = ntohs(opi->total_len);
2093 ofputil_decode_packet_in_finish(pin, &match, &b);
2094 } else if (raw == OFPRAW_OFPT10_PACKET_IN) {
2095 const struct ofp_packet_in *opi;
2097 opi = ofpbuf_pull(&b, offsetof(struct ofp_packet_in, data));
2099 pin->packet = opi->data;
2100 pin->packet_len = b.size;
2102 pin->fmd.in_port = ntohs(opi->in_port);
2103 pin->reason = opi->reason;
2104 pin->buffer_id = ntohl(opi->buffer_id);
2105 pin->total_len = ntohs(opi->total_len);
2106 } else if (raw == OFPRAW_NXT_PACKET_IN) {
2107 const struct nx_packet_in *npi;
2111 npi = ofpbuf_pull(&b, sizeof *npi);
2112 error = nx_pull_match_loose(&b, ntohs(npi->match_len), &match, NULL,
2118 if (!ofpbuf_try_pull(&b, 2)) {
2119 return OFPERR_OFPBRC_BAD_LEN;
2122 pin->reason = npi->reason;
2123 pin->table_id = npi->table_id;
2124 pin->cookie = npi->cookie;
2126 pin->buffer_id = ntohl(npi->buffer_id);
2127 pin->total_len = ntohs(npi->total_len);
2129 ofputil_decode_packet_in_finish(pin, &match, &b);
2138 ofputil_packet_in_to_match(const struct ofputil_packet_in *pin,
2139 struct match *match)
2143 match_init_catchall(match);
2144 if (pin->fmd.tun_id != htonll(0)) {
2145 match_set_tun_id(match, pin->fmd.tun_id);
2147 if (pin->fmd.metadata != htonll(0)) {
2148 match_set_metadata(match, pin->fmd.metadata);
2151 for (i = 0; i < FLOW_N_REGS; i++) {
2152 if (pin->fmd.regs[i]) {
2153 match_set_reg(match, i, pin->fmd.regs[i]);
2157 match_set_in_port(match, pin->fmd.in_port);
2160 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2161 * in the format specified by 'packet_in_format'. */
2163 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2164 enum ofputil_protocol protocol,
2165 enum nx_packet_in_format packet_in_format)
2167 size_t send_len = MIN(pin->send_len, pin->packet_len);
2168 struct ofpbuf *packet;
2170 /* Add OFPT_PACKET_IN. */
2171 if (protocol == OFPUTIL_P_OF12) {
2172 struct ofp12_packet_in *opi;
2175 ofputil_packet_in_to_match(pin, &match);
2177 /* The final argument is just an estimate of the space required. */
2178 packet = ofpraw_alloc_xid(OFPRAW_OFPT12_PACKET_IN, OFP12_VERSION,
2179 htonl(0), (sizeof(struct flow_metadata) * 2
2181 ofpbuf_put_zeros(packet, sizeof *opi);
2182 oxm_put_match(packet, &match);
2183 ofpbuf_put_zeros(packet, 2);
2184 ofpbuf_put(packet, pin->packet, send_len);
2187 opi->buffer_id = htonl(pin->buffer_id);
2188 opi->total_len = htons(pin->total_len);
2189 opi->reason = pin->reason;
2190 opi->table_id = pin->table_id;
2191 } else if (packet_in_format == NXPIF_OPENFLOW10) {
2192 struct ofp_packet_in *opi;
2194 packet = ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN, OFP10_VERSION,
2195 htonl(0), send_len);
2196 opi = ofpbuf_put_zeros(packet, offsetof(struct ofp_packet_in, data));
2197 opi->total_len = htons(pin->total_len);
2198 opi->in_port = htons(pin->fmd.in_port);
2199 opi->reason = pin->reason;
2200 opi->buffer_id = htonl(pin->buffer_id);
2202 ofpbuf_put(packet, pin->packet, send_len);
2203 } else if (packet_in_format == NXPIF_NXM) {
2204 struct nx_packet_in *npi;
2208 ofputil_packet_in_to_match(pin, &match);
2210 /* The final argument is just an estimate of the space required. */
2211 packet = ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN, OFP10_VERSION,
2212 htonl(0), (sizeof(struct flow_metadata) * 2
2214 ofpbuf_put_zeros(packet, sizeof *npi);
2215 match_len = nx_put_match(packet, &match, 0, 0);
2216 ofpbuf_put_zeros(packet, 2);
2217 ofpbuf_put(packet, pin->packet, send_len);
2220 npi->buffer_id = htonl(pin->buffer_id);
2221 npi->total_len = htons(pin->total_len);
2222 npi->reason = pin->reason;
2223 npi->table_id = pin->table_id;
2224 npi->cookie = pin->cookie;
2225 npi->match_len = htons(match_len);
2229 ofpmsg_update_length(packet);
2235 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2237 static char s[INT_STRLEN(int) + 1];
2244 case OFPR_INVALID_TTL:
2245 return "invalid_ttl";
2247 case OFPR_N_REASONS:
2249 sprintf(s, "%d", (int) reason);
2255 ofputil_packet_in_reason_from_string(const char *s,
2256 enum ofp_packet_in_reason *reason)
2260 for (i = 0; i < OFPR_N_REASONS; i++) {
2261 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2269 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2272 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2273 * message's actions. The caller must initialize 'ofpacts' and retains
2274 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2276 * Returns 0 if successful, otherwise an OFPERR_* value. */
2278 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2279 const struct ofp_header *oh,
2280 struct ofpbuf *ofpacts)
2285 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2286 raw = ofpraw_pull_assert(&b);
2288 if (raw == OFPRAW_OFPT11_PACKET_OUT) {
2290 const struct ofp11_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2292 po->buffer_id = ntohl(opo->buffer_id);
2293 error = ofputil_port_from_ofp11(opo->in_port, &po->in_port);
2298 error = ofpacts_pull_openflow11_actions(&b, ntohs(opo->actions_len),
2303 } else if (raw == OFPRAW_OFPT10_PACKET_OUT) {
2305 const struct ofp_packet_out *opo = ofpbuf_pull(&b, sizeof *opo);
2307 po->buffer_id = ntohl(opo->buffer_id);
2308 po->in_port = ntohs(opo->in_port);
2310 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2318 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2319 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2320 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2322 return OFPERR_OFPBRC_BAD_PORT;
2325 po->ofpacts = ofpacts->data;
2326 po->ofpacts_len = ofpacts->size;
2328 if (po->buffer_id == UINT32_MAX) {
2329 po->packet = b.data;
2330 po->packet_len = b.size;
2339 /* ofputil_phy_port */
2341 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2342 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2343 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2344 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2345 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2346 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2347 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2348 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2350 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2351 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2352 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2353 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2354 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2355 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2357 static enum netdev_features
2358 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2360 uint32_t ofp10 = ntohl(ofp10_);
2361 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2365 netdev_port_features_to_ofp10(enum netdev_features features)
2367 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2370 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2371 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2372 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2373 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2374 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2375 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2376 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2377 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2378 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2379 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2380 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2381 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2382 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2383 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2384 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2385 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2387 static enum netdev_features
2388 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2390 return ntohl(ofp11) & 0xffff;
2394 netdev_port_features_to_ofp11(enum netdev_features features)
2396 return htonl(features & 0xffff);
2400 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2401 const struct ofp10_phy_port *opp)
2403 memset(pp, 0, sizeof *pp);
2405 pp->port_no = ntohs(opp->port_no);
2406 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2407 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2409 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2410 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2412 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2413 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2414 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2415 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2417 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2418 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2424 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2425 const struct ofp11_port *op)
2429 memset(pp, 0, sizeof *pp);
2431 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2435 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2436 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2438 pp->config = ntohl(op->config) & OFPPC11_ALL;
2439 pp->state = ntohl(op->state) & OFPPC11_ALL;
2441 pp->curr = netdev_port_features_from_ofp11(op->curr);
2442 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2443 pp->supported = netdev_port_features_from_ofp11(op->supported);
2444 pp->peer = netdev_port_features_from_ofp11(op->peer);
2446 pp->curr_speed = ntohl(op->curr_speed);
2447 pp->max_speed = ntohl(op->max_speed);
2453 ofputil_get_phy_port_size(enum ofp_version ofp_version)
2455 switch (ofp_version) {
2457 return sizeof(struct ofp10_phy_port);
2460 return sizeof(struct ofp11_port);
2467 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2468 struct ofp10_phy_port *opp)
2470 memset(opp, 0, sizeof *opp);
2472 opp->port_no = htons(pp->port_no);
2473 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2474 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2476 opp->config = htonl(pp->config & OFPPC10_ALL);
2477 opp->state = htonl(pp->state & OFPPS10_ALL);
2479 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2480 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2481 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2482 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2486 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2487 struct ofp11_port *op)
2489 memset(op, 0, sizeof *op);
2491 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2492 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2493 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2495 op->config = htonl(pp->config & OFPPC11_ALL);
2496 op->state = htonl(pp->state & OFPPS11_ALL);
2498 op->curr = netdev_port_features_to_ofp11(pp->curr);
2499 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2500 op->supported = netdev_port_features_to_ofp11(pp->supported);
2501 op->peer = netdev_port_features_to_ofp11(pp->peer);
2503 op->curr_speed = htonl(pp->curr_speed);
2504 op->max_speed = htonl(pp->max_speed);
2508 ofputil_put_phy_port(enum ofp_version ofp_version,
2509 const struct ofputil_phy_port *pp, struct ofpbuf *b)
2511 switch (ofp_version) {
2512 case OFP10_VERSION: {
2513 struct ofp10_phy_port *opp;
2514 if (b->size + sizeof *opp <= UINT16_MAX) {
2515 opp = ofpbuf_put_uninit(b, sizeof *opp);
2516 ofputil_encode_ofp10_phy_port(pp, opp);
2522 case OFP12_VERSION: {
2523 struct ofp11_port *op;
2524 if (b->size + sizeof *op <= UINT16_MAX) {
2525 op = ofpbuf_put_uninit(b, sizeof *op);
2526 ofputil_encode_ofp11_port(pp, op);
2537 ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
2538 const struct ofputil_phy_port *pp,
2539 struct list *replies)
2541 switch (ofp_version) {
2542 case OFP10_VERSION: {
2543 struct ofp10_phy_port *opp;
2545 opp = ofpmp_append(replies, sizeof *opp);
2546 ofputil_encode_ofp10_phy_port(pp, opp);
2551 case OFP12_VERSION: {
2552 struct ofp11_port *op;
2554 op = ofpmp_append(replies, sizeof *op);
2555 ofputil_encode_ofp11_port(pp, op);
2564 /* ofputil_switch_features */
2566 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2567 OFPC_IP_REASM | OFPC_QUEUE_STATS)
2568 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2569 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2570 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2571 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2572 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2573 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2575 struct ofputil_action_bit_translation {
2576 enum ofputil_action_bitmap ofputil_bit;
2580 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2581 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2582 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2583 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2584 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2585 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2586 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2587 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2588 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2589 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2590 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2591 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2592 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2596 static enum ofputil_action_bitmap
2597 decode_action_bits(ovs_be32 of_actions,
2598 const struct ofputil_action_bit_translation *x)
2600 enum ofputil_action_bitmap ofputil_actions;
2602 ofputil_actions = 0;
2603 for (; x->ofputil_bit; x++) {
2604 if (of_actions & htonl(1u << x->of_bit)) {
2605 ofputil_actions |= x->ofputil_bit;
2608 return ofputil_actions;
2612 ofputil_capabilities_mask(enum ofp_version ofp_version)
2614 /* Handle capabilities whose bit is unique for all Open Flow versions */
2615 switch (ofp_version) {
2618 return OFPC_COMMON | OFPC_ARP_MATCH_IP;
2620 return OFPC_COMMON | OFPC12_PORT_BLOCKED;
2622 /* Caller needs to check osf->header.version itself */
2627 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2628 * abstract representation in '*features'. Initializes '*b' to iterate over
2629 * the OpenFlow port structures following 'osf' with later calls to
2630 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2631 * OFPERR_* value. */
2633 ofputil_decode_switch_features(const struct ofp_header *oh,
2634 struct ofputil_switch_features *features,
2637 const struct ofp_switch_features *osf;
2640 ofpbuf_use_const(b, oh, ntohs(oh->length));
2641 raw = ofpraw_pull_assert(b);
2643 osf = ofpbuf_pull(b, sizeof *osf);
2644 features->datapath_id = ntohll(osf->datapath_id);
2645 features->n_buffers = ntohl(osf->n_buffers);
2646 features->n_tables = osf->n_tables;
2648 features->capabilities = ntohl(osf->capabilities) &
2649 ofputil_capabilities_mask(oh->version);
2651 if (b->size % ofputil_get_phy_port_size(oh->version)) {
2652 return OFPERR_OFPBRC_BAD_LEN;
2655 if (raw == OFPRAW_OFPT10_FEATURES_REPLY) {
2656 if (osf->capabilities & htonl(OFPC10_STP)) {
2657 features->capabilities |= OFPUTIL_C_STP;
2659 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2660 } else if (raw == OFPRAW_OFPT11_FEATURES_REPLY) {
2661 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2662 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2664 features->actions = 0;
2666 return OFPERR_OFPBRC_BAD_VERSION;
2672 /* Returns true if the maximum number of ports are in 'oh'. */
2674 max_ports_in_features(const struct ofp_header *oh)
2676 size_t pp_size = ofputil_get_phy_port_size(oh->version);
2677 return ntohs(oh->length) + pp_size > UINT16_MAX;
2680 /* Given a buffer 'b' that contains a Features Reply message, checks if
2681 * it contains the maximum number of ports that will fit. If so, it
2682 * returns true and removes the ports from the message. The caller
2683 * should then send an OFPST_PORT_DESC stats request to get the ports,
2684 * since the switch may have more ports than could be represented in the
2685 * Features Reply. Otherwise, returns false.
2688 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2690 struct ofp_header *oh = b->data;
2692 if (max_ports_in_features(oh)) {
2693 /* Remove all the ports. */
2694 b->size = (sizeof(struct ofp_header)
2695 + sizeof(struct ofp_switch_features));
2696 ofpmsg_update_length(b);
2705 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2706 const struct ofputil_action_bit_translation *x)
2708 uint32_t of_actions;
2711 for (; x->ofputil_bit; x++) {
2712 if (ofputil_actions & x->ofputil_bit) {
2713 of_actions |= 1 << x->of_bit;
2716 return htonl(of_actions);
2719 /* Returns a buffer owned by the caller that encodes 'features' in the format
2720 * required by 'protocol' with the given 'xid'. The caller should append port
2721 * information to the buffer with subsequent calls to
2722 * ofputil_put_switch_features_port(). */
2724 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2725 enum ofputil_protocol protocol, ovs_be32 xid)
2727 struct ofp_switch_features *osf;
2729 enum ofp_version version;
2732 version = ofputil_protocol_to_ofp_version(protocol);
2735 raw = OFPRAW_OFPT10_FEATURES_REPLY;
2739 raw = OFPRAW_OFPT11_FEATURES_REPLY;
2744 b = ofpraw_alloc_xid(raw, version, xid, 0);
2745 osf = ofpbuf_put_zeros(b, sizeof *osf);
2746 osf->datapath_id = htonll(features->datapath_id);
2747 osf->n_buffers = htonl(features->n_buffers);
2748 osf->n_tables = features->n_tables;
2750 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2751 osf->capabilities = htonl(features->capabilities &
2752 ofputil_capabilities_mask(version));
2755 if (features->capabilities & OFPUTIL_C_STP) {
2756 osf->capabilities |= htonl(OFPC10_STP);
2758 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2762 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2763 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2773 /* Encodes 'pp' into the format required by the switch_features message already
2774 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2775 * and appends the encoded version to 'b'. */
2777 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2780 const struct ofp_header *oh = b->data;
2782 ofputil_put_phy_port(oh->version, pp, b);
2785 /* ofputil_port_status */
2787 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2788 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2790 ofputil_decode_port_status(const struct ofp_header *oh,
2791 struct ofputil_port_status *ps)
2793 const struct ofp_port_status *ops;
2797 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2798 ofpraw_pull_assert(&b);
2799 ops = ofpbuf_pull(&b, sizeof *ops);
2801 if (ops->reason != OFPPR_ADD &&
2802 ops->reason != OFPPR_DELETE &&
2803 ops->reason != OFPPR_MODIFY) {
2804 return OFPERR_NXBRC_BAD_REASON;
2806 ps->reason = ops->reason;
2808 retval = ofputil_pull_phy_port(oh->version, &b, &ps->desc);
2809 assert(retval != EOF);
2813 /* Converts the abstract form of a "port status" message in '*ps' into an
2814 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2815 * a buffer owned by the caller. */
2817 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2818 enum ofputil_protocol protocol)
2820 struct ofp_port_status *ops;
2822 enum ofp_version version;
2825 version = ofputil_protocol_to_ofp_version(protocol);
2828 raw = OFPRAW_OFPT10_PORT_STATUS;
2833 raw = OFPRAW_OFPT11_PORT_STATUS;
2840 b = ofpraw_alloc_xid(raw, version, htonl(0), 0);
2841 ops = ofpbuf_put_zeros(b, sizeof *ops);
2842 ops->reason = ps->reason;
2843 ofputil_put_phy_port(version, &ps->desc, b);
2844 ofpmsg_update_length(b);
2848 /* ofputil_port_mod */
2850 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2851 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2853 ofputil_decode_port_mod(const struct ofp_header *oh,
2854 struct ofputil_port_mod *pm)
2859 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2860 raw = ofpraw_pull_assert(&b);
2862 if (raw == OFPRAW_OFPT10_PORT_MOD) {
2863 const struct ofp10_port_mod *opm = b.data;
2865 pm->port_no = ntohs(opm->port_no);
2866 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2867 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2868 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2869 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2870 } else if (raw == OFPRAW_OFPT11_PORT_MOD) {
2871 const struct ofp11_port_mod *opm = b.data;
2874 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2879 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2880 pm->config = ntohl(opm->config) & OFPPC11_ALL;
2881 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2882 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2884 return OFPERR_OFPBRC_BAD_TYPE;
2887 pm->config &= pm->mask;
2891 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2892 * message suitable for 'protocol', and returns that encoded form in a buffer
2893 * owned by the caller. */
2895 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2896 enum ofputil_protocol protocol)
2898 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
2901 switch (ofp_version) {
2902 case OFP10_VERSION: {
2903 struct ofp10_port_mod *opm;
2905 b = ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD, ofp_version, 0);
2906 opm = ofpbuf_put_zeros(b, sizeof *opm);
2907 opm->port_no = htons(pm->port_no);
2908 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2909 opm->config = htonl(pm->config & OFPPC10_ALL);
2910 opm->mask = htonl(pm->mask & OFPPC10_ALL);
2911 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2916 case OFP12_VERSION: {
2917 struct ofp11_port_mod *opm;
2919 b = ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD, ofp_version, 0);
2920 opm = ofpbuf_put_zeros(b, sizeof *opm);
2921 opm->port_no = ofputil_port_to_ofp11(pm->port_no);
2922 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2923 opm->config = htonl(pm->config & OFPPC11_ALL);
2924 opm->mask = htonl(pm->mask & OFPPC11_ALL);
2925 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2939 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats *in,
2943 enum ofp_flow_wildcards wc10;
2944 enum oxm12_ofb_match_fields mf12;
2947 static const struct wc_map wc_map[] = {
2948 { OFPFW10_IN_PORT, OFPXMT12_OFB_IN_PORT },
2949 { OFPFW10_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
2950 { OFPFW10_DL_SRC, OFPXMT12_OFB_ETH_SRC },
2951 { OFPFW10_DL_DST, OFPXMT12_OFB_ETH_DST},
2952 { OFPFW10_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
2953 { OFPFW10_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
2954 { OFPFW10_TP_SRC, OFPXMT12_OFB_TCP_SRC },
2955 { OFPFW10_TP_DST, OFPXMT12_OFB_TCP_DST },
2956 { OFPFW10_NW_SRC_MASK, OFPXMT12_OFB_IPV4_SRC },
2957 { OFPFW10_NW_DST_MASK, OFPXMT12_OFB_IPV4_DST },
2958 { OFPFW10_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
2959 { OFPFW10_NW_TOS, OFPXMT12_OFB_IP_DSCP },
2962 struct ofp10_table_stats *out;
2963 const struct wc_map *p;
2965 out = ofpbuf_put_uninit(buf, sizeof *out);
2966 out->table_id = in->table_id;
2967 strcpy(out->name, in->name);
2969 for (p = wc_map; p < &wc_map[ARRAY_SIZE(wc_map)]; p++) {
2970 if (in->wildcards & htonll(1ULL << p->mf12)) {
2971 out->wildcards |= htonl(p->wc10);
2974 out->max_entries = in->max_entries;
2975 out->active_count = in->active_count;
2976 put_32aligned_be64(&out->lookup_count, in->lookup_count);
2977 put_32aligned_be64(&out->matched_count, in->matched_count);
2981 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12)
2984 enum ofp11_flow_match_fields fmf11;
2985 enum oxm12_ofb_match_fields mf12;
2988 static const struct map map[] = {
2989 { OFPFMF11_IN_PORT, OFPXMT12_OFB_IN_PORT },
2990 { OFPFMF11_DL_VLAN, OFPXMT12_OFB_VLAN_VID },
2991 { OFPFMF11_DL_VLAN_PCP, OFPXMT12_OFB_VLAN_PCP },
2992 { OFPFMF11_DL_TYPE, OFPXMT12_OFB_ETH_TYPE },
2993 { OFPFMF11_NW_TOS, OFPXMT12_OFB_IP_DSCP },
2994 { OFPFMF11_NW_PROTO, OFPXMT12_OFB_IP_PROTO },
2995 { OFPFMF11_TP_SRC, OFPXMT12_OFB_TCP_SRC },
2996 { OFPFMF11_TP_DST, OFPXMT12_OFB_TCP_DST },
2997 { OFPFMF11_MPLS_LABEL, OFPXMT12_OFB_MPLS_LABEL },
2998 { OFPFMF11_MPLS_TC, OFPXMT12_OFB_MPLS_TC },
2999 /* I don't know what OFPFMF11_TYPE means. */
3000 { OFPFMF11_DL_SRC, OFPXMT12_OFB_ETH_SRC },
3001 { OFPFMF11_DL_DST, OFPXMT12_OFB_ETH_DST },
3002 { OFPFMF11_NW_SRC, OFPXMT12_OFB_IPV4_SRC },
3003 { OFPFMF11_NW_DST, OFPXMT12_OFB_IPV4_DST },
3004 { OFPFMF11_METADATA, OFPXMT12_OFB_METADATA },
3007 const struct map *p;
3011 for (p = map; p < &map[ARRAY_SIZE(map)]; p++) {
3012 if (oxm12 & htonll(1ULL << p->mf12)) {
3016 return htonl(fmf11);
3020 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats *in,
3023 struct ofp11_table_stats *out;
3025 out = ofpbuf_put_uninit(buf, sizeof *out);
3026 out->table_id = in->table_id;
3027 strcpy(out->name, in->name);
3028 out->wildcards = oxm12_to_ofp11_flow_match_fields(in->wildcards);
3029 out->match = oxm12_to_ofp11_flow_match_fields(in->match);
3030 out->instructions = in->instructions;
3031 out->write_actions = in->write_actions;
3032 out->apply_actions = in->apply_actions;
3033 out->config = in->config;
3034 out->max_entries = in->max_entries;
3035 out->active_count = in->active_count;
3036 out->lookup_count = in->lookup_count;
3037 out->matched_count = in->matched_count;
3041 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats[], int n,
3042 const struct ofp_header *request)
3044 struct ofpbuf *reply;
3047 reply = ofpraw_alloc_stats_reply(request, n * sizeof *stats);
3049 switch ((enum ofp_version) request->version) {
3051 for (i = 0; i < n; i++) {
3052 ofputil_put_ofp10_table_stats(&stats[i], reply);
3057 for (i = 0; i < n; i++) {
3058 ofputil_put_ofp11_table_stats(&stats[i], reply);
3063 ofpbuf_put(reply, stats, n * sizeof *stats);
3073 /* ofputil_flow_monitor_request */
3075 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3076 * ofputil_flow_monitor_request in 'rq'.
3078 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3079 * message. Calling this function multiple times for a single 'msg' iterates
3080 * through the requests. The caller must initially leave 'msg''s layer
3081 * pointers null and not modify them between calls.
3083 * Returns 0 if successful, EOF if no requests were left in this 'msg',
3084 * otherwise an OFPERR_* value. */
3086 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3089 struct nx_flow_monitor_request *nfmr;
3093 msg->l2 = msg->data;
3094 ofpraw_pull_assert(msg);
3101 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3103 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3104 "leftover bytes at end", msg->size);
3105 return OFPERR_OFPBRC_BAD_LEN;
3108 flags = ntohs(nfmr->flags);
3109 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3110 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3111 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3112 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3114 return OFPERR_NXBRC_FM_BAD_FLAGS;
3117 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3118 return OFPERR_NXBRC_MUST_BE_ZERO;
3121 rq->id = ntohl(nfmr->id);
3123 rq->out_port = ntohs(nfmr->out_port);
3124 rq->table_id = nfmr->table_id;
3126 return nx_pull_match(msg, ntohs(nfmr->match_len), &rq->match, NULL, NULL);
3130 ofputil_append_flow_monitor_request(
3131 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3133 struct nx_flow_monitor_request *nfmr;
3138 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION, msg);
3141 start_ofs = msg->size;
3142 ofpbuf_put_zeros(msg, sizeof *nfmr);
3143 match_len = nx_put_match(msg, &rq->match, htonll(0), htonll(0));
3145 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3146 nfmr->id = htonl(rq->id);
3147 nfmr->flags = htons(rq->flags);
3148 nfmr->out_port = htons(rq->out_port);
3149 nfmr->match_len = htons(match_len);
3150 nfmr->table_id = rq->table_id;
3153 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3154 * into an abstract ofputil_flow_update in 'update'. The caller must have
3155 * initialized update->match to point to space allocated for a match.
3157 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3158 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3159 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3160 * will point into the 'ofpacts' buffer.
3162 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3163 * this function multiple times for a single 'msg' iterates through the
3164 * updates. The caller must initially leave 'msg''s layer pointers null and
3165 * not modify them between calls.
3167 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3168 * otherwise an OFPERR_* value. */
3170 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3171 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3173 struct nx_flow_update_header *nfuh;
3174 unsigned int length;
3177 msg->l2 = msg->data;
3178 ofpraw_pull_assert(msg);
3185 if (msg->size < sizeof(struct nx_flow_update_header)) {
3190 update->event = ntohs(nfuh->event);
3191 length = ntohs(nfuh->length);
3192 if (length > msg->size || length % 8) {
3196 if (update->event == NXFME_ABBREV) {
3197 struct nx_flow_update_abbrev *nfua;
3199 if (length != sizeof *nfua) {
3203 nfua = ofpbuf_pull(msg, sizeof *nfua);
3204 update->xid = nfua->xid;
3206 } else if (update->event == NXFME_ADDED
3207 || update->event == NXFME_DELETED
3208 || update->event == NXFME_MODIFIED) {
3209 struct nx_flow_update_full *nfuf;
3210 unsigned int actions_len;
3211 unsigned int match_len;
3214 if (length < sizeof *nfuf) {
3218 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3219 match_len = ntohs(nfuf->match_len);
3220 if (sizeof *nfuf + match_len > length) {
3224 update->reason = ntohs(nfuf->reason);
3225 update->idle_timeout = ntohs(nfuf->idle_timeout);
3226 update->hard_timeout = ntohs(nfuf->hard_timeout);
3227 update->table_id = nfuf->table_id;
3228 update->cookie = nfuf->cookie;
3229 update->priority = ntohs(nfuf->priority);
3231 error = nx_pull_match(msg, match_len, update->match, NULL, NULL);
3236 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3237 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3242 update->ofpacts = ofpacts->data;
3243 update->ofpacts_len = ofpacts->size;
3246 VLOG_WARN_RL(&bad_ofmsg_rl,
3247 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3248 ntohs(nfuh->event));
3249 return OFPERR_OFPET_BAD_REQUEST;
3253 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3254 "leftover bytes at end", msg->size);
3255 return OFPERR_OFPBRC_BAD_LEN;
3259 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3261 const struct nx_flow_monitor_cancel *cancel = ofpmsg_body(oh);
3263 return ntohl(cancel->id);
3267 ofputil_encode_flow_monitor_cancel(uint32_t id)
3269 struct nx_flow_monitor_cancel *nfmc;
3272 msg = ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION, 0);
3273 nfmc = ofpbuf_put_uninit(msg, sizeof *nfmc);
3274 nfmc->id = htonl(id);
3279 ofputil_start_flow_update(struct list *replies)
3283 msg = ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
3287 list_push_back(replies, &msg->list_node);
3291 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3292 struct list *replies)
3294 struct nx_flow_update_header *nfuh;
3298 msg = ofpbuf_from_list(list_back(replies));
3299 start_ofs = msg->size;
3301 if (update->event == NXFME_ABBREV) {
3302 struct nx_flow_update_abbrev *nfua;
3304 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3305 nfua->xid = update->xid;
3307 struct nx_flow_update_full *nfuf;
3310 ofpbuf_put_zeros(msg, sizeof *nfuf);
3311 match_len = nx_put_match(msg, update->match, htonll(0), htonll(0));
3312 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3314 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3315 nfuf->reason = htons(update->reason);
3316 nfuf->priority = htons(update->priority);
3317 nfuf->idle_timeout = htons(update->idle_timeout);
3318 nfuf->hard_timeout = htons(update->hard_timeout);
3319 nfuf->match_len = htons(match_len);
3320 nfuf->table_id = update->table_id;
3321 nfuf->cookie = update->cookie;
3324 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3325 nfuh->length = htons(msg->size - start_ofs);
3326 nfuh->event = htons(update->event);
3328 ofpmp_postappend(replies, start_ofs);
3332 ofputil_encode_packet_out(const struct ofputil_packet_out *po,
3333 enum ofputil_protocol protocol)
3335 enum ofp_version ofp_version = ofputil_protocol_to_ofp_version(protocol);
3339 size = po->ofpacts_len;
3340 if (po->buffer_id == UINT32_MAX) {
3341 size += po->packet_len;
3344 switch (ofp_version) {
3345 case OFP10_VERSION: {
3346 struct ofp_packet_out *opo;
3349 msg = ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT, OFP10_VERSION, size);
3350 ofpbuf_put_zeros(msg, sizeof *opo);
3351 actions_ofs = msg->size;
3352 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3355 opo->buffer_id = htonl(po->buffer_id);
3356 opo->in_port = htons(po->in_port);
3357 opo->actions_len = htons(msg->size - actions_ofs);
3362 case OFP12_VERSION: {
3363 struct ofp11_packet_out *opo;
3366 msg = ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT, ofp_version, size);
3367 ofpbuf_put_zeros(msg, sizeof *opo);
3368 len = ofpacts_put_openflow11_actions(po->ofpacts, po->ofpacts_len, msg);
3371 opo->buffer_id = htonl(po->buffer_id);
3372 opo->in_port = ofputil_port_to_ofp11(po->in_port);
3373 opo->actions_len = htons(len);
3381 if (po->buffer_id == UINT32_MAX) {
3382 ofpbuf_put(msg, po->packet, po->packet_len);
3385 ofpmsg_update_length(msg);
3390 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3392 make_echo_request(enum ofp_version ofp_version)
3394 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, ofp_version,
3398 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3399 * OFPT_ECHO_REQUEST message in 'rq'. */
3401 make_echo_reply(const struct ofp_header *rq)
3403 struct ofpbuf rq_buf;
3404 struct ofpbuf *reply;
3406 ofpbuf_use_const(&rq_buf, rq, ntohs(rq->length));
3407 ofpraw_pull_assert(&rq_buf);
3409 reply = ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY, rq, rq_buf.size);
3410 ofpbuf_put(reply, rq_buf.data, rq_buf.size);
3415 ofputil_encode_barrier_request(enum ofp_version ofp_version)
3419 switch (ofp_version) {
3422 type = OFPRAW_OFPT11_BARRIER_REQUEST;
3426 type = OFPRAW_OFPT10_BARRIER_REQUEST;
3433 return ofpraw_alloc(type, ofp_version, 0);
3437 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3439 switch (flags & OFPC_FRAG_MASK) {
3440 case OFPC_FRAG_NORMAL: return "normal";
3441 case OFPC_FRAG_DROP: return "drop";
3442 case OFPC_FRAG_REASM: return "reassemble";
3443 case OFPC_FRAG_NX_MATCH: return "nx-match";
3450 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3452 if (!strcasecmp(s, "normal")) {
3453 *flags = OFPC_FRAG_NORMAL;
3454 } else if (!strcasecmp(s, "drop")) {
3455 *flags = OFPC_FRAG_DROP;
3456 } else if (!strcasecmp(s, "reassemble")) {
3457 *flags = OFPC_FRAG_REASM;
3458 } else if (!strcasecmp(s, "nx-match")) {
3459 *flags = OFPC_FRAG_NX_MATCH;
3466 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3467 * port number and stores the latter in '*ofp10_port', for the purpose of
3468 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3469 * otherwise an OFPERR_* number.
3471 * See the definition of OFP11_MAX for an explanation of the mapping. */
3473 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3475 uint32_t ofp11_port_h = ntohl(ofp11_port);
3477 if (ofp11_port_h < OFPP_MAX) {
3478 *ofp10_port = ofp11_port_h;
3480 } else if (ofp11_port_h >= OFPP11_MAX) {
3481 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3484 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3485 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3486 ofp11_port_h, OFPP_MAX - 1,
3487 (uint32_t) OFPP11_MAX, UINT32_MAX);
3488 return OFPERR_OFPBAC_BAD_OUT_PORT;
3492 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3493 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3495 * See the definition of OFP11_MAX for an explanation of the mapping. */
3497 ofputil_port_to_ofp11(uint16_t ofp10_port)
3499 return htonl(ofp10_port < OFPP_MAX
3501 : ofp10_port + OFPP11_OFFSET);
3504 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3505 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3506 * 'port' is valid, otherwise an OpenFlow return code. */
3508 ofputil_check_output_port(uint16_t port, int max_ports)
3516 case OFPP_CONTROLLER:
3522 if (port < max_ports) {
3525 return OFPERR_OFPBAC_BAD_OUT_PORT;
3529 #define OFPUTIL_NAMED_PORTS \
3530 OFPUTIL_NAMED_PORT(IN_PORT) \
3531 OFPUTIL_NAMED_PORT(TABLE) \
3532 OFPUTIL_NAMED_PORT(NORMAL) \
3533 OFPUTIL_NAMED_PORT(FLOOD) \
3534 OFPUTIL_NAMED_PORT(ALL) \
3535 OFPUTIL_NAMED_PORT(CONTROLLER) \
3536 OFPUTIL_NAMED_PORT(LOCAL) \
3537 OFPUTIL_NAMED_PORT(NONE)
3539 /* Returns the port number represented by 's', which may be an integer or, for
3540 * reserved ports, the standard OpenFlow name for the port (e.g. "LOCAL").
3542 * Returns 0 if 's' is not a valid OpenFlow port number or name. The caller
3543 * should issue an error message in this case, because this function usually
3544 * does not. (This gives the caller an opportunity to look up the port name
3545 * another way, e.g. by contacting the switch and listing the names of all its
3548 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
3549 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
3550 * range as described in include/openflow/openflow-1.1.h. */
3552 ofputil_port_from_string(const char *s)
3554 unsigned int port32;
3556 if (str_to_uint(s, 10, &port32)) {
3558 VLOG_WARN("port 0 is not a valid OpenFlow port number");
3560 } else if (port32 < OFPP_MAX) {
3562 } else if (port32 < OFPP_FIRST_RESV) {
3563 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
3564 "be translated to %u when talking to an OF1.1 or "
3565 "later controller", port32, port32 + OFPP11_OFFSET);
3567 } else if (port32 <= OFPP_LAST_RESV) {
3571 ofputil_format_port(port32, &s);
3572 VLOG_WARN("port %u is better referred to as %s, for compatibility "
3573 "with future versions of OpenFlow",
3574 port32, ds_cstr(&s));
3578 } else if (port32 < OFPP11_MAX) {
3579 VLOG_WARN("port %u is outside the supported range 0 through "
3580 "%"PRIx16"or 0x%x through 0x%"PRIx32, port32,
3581 UINT16_MAX, (unsigned int) OFPP11_MAX, UINT32_MAX);
3584 return port32 - OFPP11_OFFSET;
3591 static const struct pair pairs[] = {
3592 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3594 #undef OFPUTIL_NAMED_PORT
3596 const struct pair *p;
3598 for (p = pairs; p < &pairs[ARRAY_SIZE(pairs)]; p++) {
3599 if (!strcasecmp(s, p->name)) {
3607 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3608 * Most ports' string representation is just the port number, but for special
3609 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3611 ofputil_format_port(uint16_t port, struct ds *s)
3616 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3618 #undef OFPUTIL_NAMED_PORT
3621 ds_put_format(s, "%"PRIu16, port);
3624 ds_put_cstr(s, name);
3627 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3628 * 'ofp_version', tries to pull the first element from the array. If
3629 * successful, initializes '*pp' with an abstract representation of the
3630 * port and returns 0. If no ports remain to be decoded, returns EOF.
3631 * On an error, returns a positive OFPERR_* value. */
3633 ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *b,
3634 struct ofputil_phy_port *pp)
3636 switch (ofp_version) {
3637 case OFP10_VERSION: {
3638 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3639 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3642 case OFP12_VERSION: {
3643 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3644 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3651 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3652 * 'ofp_version', returns the number of elements. */
3653 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3655 return b->size / ofputil_get_phy_port_size(ofp_version);
3658 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3659 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3660 * 'name' is not the name of any action.
3662 * ofp-util.def lists the mapping from names to action. */
3664 ofputil_action_code_from_name(const char *name)
3666 static const char *names[OFPUTIL_N_ACTIONS] = {
3668 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3669 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
3670 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3671 #include "ofp-util.def"
3676 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3677 if (*p && !strcasecmp(name, *p)) {
3684 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3685 * action. Initializes the parts of 'action' that identify it as having type
3686 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3687 * have variable length, the length used and cleared is that of struct
3690 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3693 case OFPUTIL_ACTION_INVALID:
3696 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3697 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3698 #define OFPAT11_ACTION OFPAT10_ACTION
3699 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3700 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3701 #include "ofp-util.def"
3706 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3708 ofputil_init_##ENUM(struct STRUCT *s) \
3710 memset(s, 0, sizeof *s); \
3711 s->type = htons(ENUM); \
3712 s->len = htons(sizeof *s); \
3716 ofputil_put_##ENUM(struct ofpbuf *buf) \
3718 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3719 ofputil_init_##ENUM(s); \
3722 #define OFPAT11_ACTION OFPAT10_ACTION
3723 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3725 ofputil_init_##ENUM(struct STRUCT *s) \
3727 memset(s, 0, sizeof *s); \
3728 s->type = htons(OFPAT10_VENDOR); \
3729 s->len = htons(sizeof *s); \
3730 s->vendor = htonl(NX_VENDOR_ID); \
3731 s->subtype = htons(ENUM); \
3735 ofputil_put_##ENUM(struct ofpbuf *buf) \
3737 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3738 ofputil_init_##ENUM(s); \
3741 #include "ofp-util.def"
3744 ofputil_normalize_match__(struct match *match, bool may_log)
3747 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3748 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3749 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3750 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3751 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3752 MAY_ARP_THA = 1 << 5, /* arp_tha */
3753 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3754 MAY_ND_TARGET = 1 << 7 /* nd_target */
3757 struct flow_wildcards wc;
3759 /* Figure out what fields may be matched. */
3760 if (match->flow.dl_type == htons(ETH_TYPE_IP)) {
3761 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3762 if (match->flow.nw_proto == IPPROTO_TCP ||
3763 match->flow.nw_proto == IPPROTO_UDP ||
3764 match->flow.nw_proto == IPPROTO_ICMP) {
3765 may_match |= MAY_TP_ADDR;
3767 } else if (match->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3768 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3769 if (match->flow.nw_proto == IPPROTO_TCP ||
3770 match->flow.nw_proto == IPPROTO_UDP) {
3771 may_match |= MAY_TP_ADDR;
3772 } else if (match->flow.nw_proto == IPPROTO_ICMPV6) {
3773 may_match |= MAY_TP_ADDR;
3774 if (match->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3775 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3776 } else if (match->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3777 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3780 } else if (match->flow.dl_type == htons(ETH_TYPE_ARP)) {
3781 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3786 /* Clear the fields that may not be matched. */
3788 if (!(may_match & MAY_NW_ADDR)) {
3789 wc.masks.nw_src = wc.masks.nw_dst = htonl(0);
3791 if (!(may_match & MAY_TP_ADDR)) {
3792 wc.masks.tp_src = wc.masks.tp_dst = htons(0);
3794 if (!(may_match & MAY_NW_PROTO)) {
3795 wc.masks.nw_proto = 0;
3797 if (!(may_match & MAY_IPVx)) {
3798 wc.masks.nw_tos = 0;
3799 wc.masks.nw_ttl = 0;
3801 if (!(may_match & MAY_ARP_SHA)) {
3802 memset(wc.masks.arp_sha, 0, ETH_ADDR_LEN);
3804 if (!(may_match & MAY_ARP_THA)) {
3805 memset(wc.masks.arp_tha, 0, ETH_ADDR_LEN);
3807 if (!(may_match & MAY_IPV6)) {
3808 wc.masks.ipv6_src = wc.masks.ipv6_dst = in6addr_any;
3809 wc.masks.ipv6_label = htonl(0);
3811 if (!(may_match & MAY_ND_TARGET)) {
3812 wc.masks.nd_target = in6addr_any;
3815 /* Log any changes. */
3816 if (!flow_wildcards_equal(&wc, &match->wc)) {
3817 bool log = may_log && !VLOG_DROP_INFO(&bad_ofmsg_rl);
3818 char *pre = log ? match_to_string(match, OFP_DEFAULT_PRIORITY) : NULL;
3821 match_zero_wildcarded_fields(match);
3824 char *post = match_to_string(match, OFP_DEFAULT_PRIORITY);
3825 VLOG_INFO("normalization changed ofp_match, details:");
3826 VLOG_INFO(" pre: %s", pre);
3827 VLOG_INFO("post: %s", post);
3834 /* "Normalizes" the wildcards in 'match'. That means:
3836 * 1. If the type of level N is known, then only the valid fields for that
3837 * level may be specified. For example, ARP does not have a TOS field,
3838 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
3839 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3840 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
3843 * 2. If the type of level N is not known (or not understood by Open
3844 * vSwitch), then no fields at all for that level may be specified. For
3845 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3846 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
3849 * If this function changes 'match', it logs a rate-limited informational
3852 ofputil_normalize_match(struct match *match)
3854 ofputil_normalize_match__(match, true);
3857 /* Same as ofputil_normalize_match() without the logging. Thus, this function
3858 * is suitable for a program's internal use, whereas ofputil_normalize_match()
3859 * sense for use on flows received from elsewhere (so that a bug in the program
3860 * that sent them can be reported and corrected). */
3862 ofputil_normalize_match_quiet(struct match *match)
3864 ofputil_normalize_match__(match, false);
3867 /* Parses a key or a key-value pair from '*stringp'.
3869 * On success: Stores the key into '*keyp'. Stores the value, if present, into
3870 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
3871 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
3872 * are substrings of '*stringp' created by replacing some of its bytes by null
3873 * terminators. Returns true.
3875 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3876 * NULL and returns false. */
3878 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3880 char *pos, *key, *value;
3884 pos += strspn(pos, ", \t\r\n");
3886 *keyp = *valuep = NULL;
3891 key_len = strcspn(pos, ":=(, \t\r\n");
3892 if (key[key_len] == ':' || key[key_len] == '=') {
3893 /* The value can be separated by a colon. */
3896 value = key + key_len + 1;
3897 value_len = strcspn(value, ", \t\r\n");
3898 pos = value + value_len + (value[value_len] != '\0');
3899 value[value_len] = '\0';
3900 } else if (key[key_len] == '(') {
3901 /* The value can be surrounded by balanced parentheses. The outermost
3902 * set of parentheses is removed. */
3906 value = key + key_len + 1;
3907 for (value_len = 0; level > 0; value_len++) {
3908 switch (value[value_len]) {
3922 value[value_len - 1] = '\0';
3923 pos = value + value_len;
3925 /* There might be no value at all. */
3926 value = key + key_len; /* Will become the empty string below. */
3927 pos = key + key_len + (key[key_len] != '\0');
3929 key[key_len] = '\0';