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-errors.h"
40 #include "unaligned.h"
41 #include "type-props.h"
44 VLOG_DEFINE_THIS_MODULE(ofp_util);
46 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
47 * in the peer and so there's not much point in showing a lot of them. */
48 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
50 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
51 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
54 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
55 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
56 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
57 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
60 ofputil_wcbits_to_netmask(int wcbits)
63 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
66 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
67 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
68 * between 0 and 32 inclusive.
70 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
71 * still be in the valid range but isn't otherwise meaningful. */
73 ofputil_netmask_to_wcbits(ovs_be32 netmask)
75 return 32 - ip_count_cidr_bits(netmask);
78 /* A list of the FWW_* and OFPFW10_ bits that have the same value, meaning, and
80 #define WC_INVARIANT_LIST \
81 WC_INVARIANT_BIT(IN_PORT) \
82 WC_INVARIANT_BIT(DL_TYPE) \
83 WC_INVARIANT_BIT(NW_PROTO)
85 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
86 * actually have the same names and values. */
87 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW10_##NAME);
89 #undef WC_INVARIANT_BIT
91 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
93 static const flow_wildcards_t WC_INVARIANTS = 0
94 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
96 #undef WC_INVARIANT_BIT
99 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
100 * flow_wildcards in 'wc' for use in struct cls_rule. It is the caller's
101 * responsibility to handle the special case where the flow match's dl_vlan is
102 * set to OFP_VLAN_NONE. */
104 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
106 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
108 /* Initialize most of rule->wc. */
109 flow_wildcards_init_catchall(wc);
110 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
112 /* Wildcard fields that aren't defined by ofp10_match or tun_id. */
113 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
116 if (ofpfw & OFPFW10_NW_TOS) {
117 /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
118 * the enum than we can use. */
119 wc->wildcards |= FWW_NW_DSCP;
122 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
123 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
125 if (!(ofpfw & OFPFW10_TP_SRC)) {
126 wc->tp_src_mask = htons(UINT16_MAX);
128 if (!(ofpfw & OFPFW10_TP_DST)) {
129 wc->tp_dst_mask = htons(UINT16_MAX);
132 if (!(ofpfw & OFPFW10_DL_SRC)) {
133 memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
135 if (!(ofpfw & OFPFW10_DL_DST)) {
136 memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
140 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
141 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
143 if (!(ofpfw & OFPFW10_DL_VLAN)) {
144 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
148 /* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
149 * given 'priority'. */
151 ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
152 unsigned int priority, struct cls_rule *rule)
154 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
156 /* Initialize rule->priority, rule->wc. */
157 rule->priority = !ofpfw ? UINT16_MAX : priority;
158 ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
160 /* Initialize most of rule->flow. */
161 rule->flow.nw_src = match->nw_src;
162 rule->flow.nw_dst = match->nw_dst;
163 rule->flow.in_port = ntohs(match->in_port);
164 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
165 rule->flow.tp_src = match->tp_src;
166 rule->flow.tp_dst = match->tp_dst;
167 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
168 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
169 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
170 rule->flow.nw_proto = match->nw_proto;
172 /* Translate VLANs. */
173 if (!(ofpfw & OFPFW10_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
174 /* Match only packets without 802.1Q header.
176 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
178 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
179 * because we can't have a specific PCP without an 802.1Q header.
180 * However, older versions of OVS treated this as matching packets
181 * withut an 802.1Q header, so we do here too. */
182 rule->flow.vlan_tci = htons(0);
183 rule->wc.vlan_tci_mask = htons(0xffff);
185 ovs_be16 vid, pcp, tci;
187 vid = match->dl_vlan & htons(VLAN_VID_MASK);
188 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
189 tci = vid | pcp | htons(VLAN_CFI);
190 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
194 cls_rule_zero_wildcarded_fields(rule);
197 /* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
199 ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
200 struct ofp10_match *match)
202 const struct flow_wildcards *wc = &rule->wc;
205 /* Figure out most OpenFlow wildcards. */
206 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
207 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
208 << OFPFW10_NW_SRC_SHIFT);
209 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
210 << OFPFW10_NW_DST_SHIFT);
211 if (wc->wildcards & FWW_NW_DSCP) {
212 ofpfw |= OFPFW10_NW_TOS;
214 if (!wc->tp_src_mask) {
215 ofpfw |= OFPFW10_TP_SRC;
217 if (!wc->tp_dst_mask) {
218 ofpfw |= OFPFW10_TP_DST;
220 if (eth_addr_is_zero(wc->dl_src_mask)) {
221 ofpfw |= OFPFW10_DL_SRC;
223 if (eth_addr_is_zero(wc->dl_dst_mask)) {
224 ofpfw |= OFPFW10_DL_DST;
227 /* Translate VLANs. */
228 match->dl_vlan = htons(0);
229 match->dl_vlan_pcp = 0;
230 if (rule->wc.vlan_tci_mask == htons(0)) {
231 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
232 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
233 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
234 match->dl_vlan = htons(OFP_VLAN_NONE);
236 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
237 ofpfw |= OFPFW10_DL_VLAN;
239 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
242 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
243 ofpfw |= OFPFW10_DL_VLAN_PCP;
245 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
249 /* Compose most of the match structure. */
250 match->wildcards = htonl(ofpfw);
251 match->in_port = htons(rule->flow.in_port);
252 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
253 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
254 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
255 match->nw_src = rule->flow.nw_src;
256 match->nw_dst = rule->flow.nw_dst;
257 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
258 match->nw_proto = rule->flow.nw_proto;
259 match->tp_src = rule->flow.tp_src;
260 match->tp_dst = rule->flow.tp_dst;
261 memset(match->pad1, '\0', sizeof match->pad1);
262 memset(match->pad2, '\0', sizeof match->pad2);
265 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
266 * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
268 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
269 unsigned int priority,
270 struct cls_rule *rule)
272 uint16_t wc = ntohl(match->wildcards);
273 uint8_t dl_src_mask[ETH_ADDR_LEN];
274 uint8_t dl_dst_mask[ETH_ADDR_LEN];
278 cls_rule_init_catchall(rule, priority);
280 if (!(wc & OFPFW11_IN_PORT)) {
284 error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
286 return OFPERR_OFPBMC_BAD_VALUE;
288 cls_rule_set_in_port(rule, ofp_port);
291 for (i = 0; i < ETH_ADDR_LEN; i++) {
292 dl_src_mask[i] = ~match->dl_src_mask[i];
294 cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
296 for (i = 0; i < ETH_ADDR_LEN; i++) {
297 dl_dst_mask[i] = ~match->dl_dst_mask[i];
299 cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
301 if (!(wc & OFPFW11_DL_VLAN)) {
302 if (match->dl_vlan == htons(OFPVID11_NONE)) {
303 /* Match only packets without a VLAN tag. */
304 rule->flow.vlan_tci = htons(0);
305 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
307 if (match->dl_vlan == htons(OFPVID11_ANY)) {
308 /* Match any packet with a VLAN tag regardless of VID. */
309 rule->flow.vlan_tci = htons(VLAN_CFI);
310 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
311 } else if (ntohs(match->dl_vlan) < 4096) {
312 /* Match only packets with the specified VLAN VID. */
313 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
314 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
317 return OFPERR_OFPBMC_BAD_VALUE;
320 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
321 if (match->dl_vlan_pcp <= 7) {
322 rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
324 rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
327 return OFPERR_OFPBMC_BAD_VALUE;
333 if (!(wc & OFPFW11_DL_TYPE)) {
334 cls_rule_set_dl_type(rule,
335 ofputil_dl_type_from_openflow(match->dl_type));
338 ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
339 arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
341 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
342 if (match->nw_tos & ~IP_DSCP_MASK) {
344 return OFPERR_OFPBMC_BAD_VALUE;
347 cls_rule_set_nw_dscp(rule, match->nw_tos);
351 if (!(wc & OFPFW11_NW_PROTO)) {
352 cls_rule_set_nw_proto(rule, match->nw_proto);
354 cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
355 cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
358 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
359 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
360 switch (rule->flow.nw_proto) {
362 /* "A.2.3 Flow Match Structures" in OF1.1 says:
364 * The tp_src and tp_dst fields will be ignored unless the
365 * network protocol specified is as TCP, UDP or SCTP.
367 * but I'm pretty sure we should support ICMP too, otherwise
368 * that's a regression from OF1.0. */
369 if (!(wc & OFPFW11_TP_SRC)) {
370 uint16_t icmp_type = ntohs(match->tp_src);
371 if (icmp_type < 0x100) {
372 cls_rule_set_icmp_type(rule, icmp_type);
374 return OFPERR_OFPBMC_BAD_FIELD;
377 if (!(wc & OFPFW11_TP_DST)) {
378 uint16_t icmp_code = ntohs(match->tp_dst);
379 if (icmp_code < 0x100) {
380 cls_rule_set_icmp_code(rule, icmp_code);
382 return OFPERR_OFPBMC_BAD_FIELD;
389 if (!(wc & (OFPFW11_TP_SRC))) {
390 cls_rule_set_tp_src(rule, match->tp_src);
392 if (!(wc & (OFPFW11_TP_DST))) {
393 cls_rule_set_tp_dst(rule, match->tp_dst);
398 /* We don't support SCTP and it seems that we should tell the
399 * controller, since OF1.1 implementations are supposed to. */
400 return OFPERR_OFPBMC_BAD_FIELD;
403 /* OF1.1 says explicitly to ignore this. */
408 if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
409 rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
410 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
412 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
413 /* MPLS not supported. */
414 return OFPERR_OFPBMC_BAD_TAG;
418 if (match->metadata_mask != htonll(UINT64_MAX)) {
419 /* Metadata field not yet supported because we haven't decided how to
420 * map it onto our existing fields (or whether to add a new field). */
421 return OFPERR_OFPBMC_BAD_FIELD;
427 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
429 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
430 struct ofp11_match *match)
435 memset(match, 0, sizeof *match);
436 match->omh.type = htons(OFPMT_STANDARD);
437 match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
439 if (rule->wc.wildcards & FWW_IN_PORT) {
440 wc |= OFPFW11_IN_PORT;
442 match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
446 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
447 for (i = 0; i < ETH_ADDR_LEN; i++) {
448 match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
451 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
452 for (i = 0; i < ETH_ADDR_LEN; i++) {
453 match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
456 if (rule->wc.vlan_tci_mask == htons(0)) {
457 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
458 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
459 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
460 match->dl_vlan = htons(OFPVID11_NONE);
461 wc |= OFPFW11_DL_VLAN_PCP;
463 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
464 match->dl_vlan = htons(OFPVID11_ANY);
466 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
469 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
470 wc |= OFPFW11_DL_VLAN_PCP;
472 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
476 if (rule->wc.wildcards & FWW_DL_TYPE) {
477 wc |= OFPFW11_DL_TYPE;
479 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
482 if (rule->wc.wildcards & FWW_NW_DSCP) {
483 wc |= OFPFW11_NW_TOS;
485 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
488 if (rule->wc.wildcards & FWW_NW_PROTO) {
489 wc |= OFPFW11_NW_PROTO;
491 match->nw_proto = rule->flow.nw_proto;
494 match->nw_src = rule->flow.nw_src;
495 match->nw_src_mask = ~rule->wc.nw_src_mask;
496 match->nw_dst = rule->flow.nw_dst;
497 match->nw_dst_mask = ~rule->wc.nw_dst_mask;
499 if (!rule->wc.tp_src_mask) {
500 wc |= OFPFW11_TP_SRC;
502 match->tp_src = rule->flow.tp_src;
505 if (!rule->wc.tp_dst_mask) {
506 wc |= OFPFW11_TP_DST;
508 match->tp_dst = rule->flow.tp_dst;
511 /* MPLS not supported. */
512 wc |= OFPFW11_MPLS_LABEL;
513 wc |= OFPFW11_MPLS_TC;
515 /* Metadata field not yet supported */
516 match->metadata_mask = htonll(UINT64_MAX);
518 match->wildcards = htonl(wc);
521 /* Given a 'dl_type' value in the format used in struct flow, returns the
522 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
525 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
527 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
528 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
532 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
533 * structure, returns the corresponding 'dl_type' value for use in struct
536 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
538 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
539 ? htons(FLOW_DL_TYPE_NONE)
543 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
547 static uint32_t next_xid = 1;
548 return htonl(next_xid++);
551 /* Basic parsing of OpenFlow messages. */
553 struct ofputil_msg_type {
554 enum ofputil_msg_code code; /* OFPUTIL_*. */
555 uint8_t ofp_version; /* An OpenFlow version or 0 for "any". */
556 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
557 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
558 unsigned int min_size; /* Minimum total message size in bytes. */
559 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
560 * the message may exceed 'min_size' by an even multiple of this value. */
561 unsigned int extra_multiple;
564 /* Represents a malformed OpenFlow message. */
565 static const struct ofputil_msg_type ofputil_invalid_type = {
566 OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0
569 struct ofputil_msg_category {
570 const char *name; /* e.g. "OpenFlow message" */
571 const struct ofputil_msg_type *types;
573 enum ofperr missing_error; /* Error value for missing type. */
577 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
579 switch (type->extra_multiple) {
581 if (size != type->min_size) {
582 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
583 "length %u (expected length %u)",
584 type->name, size, type->min_size);
585 return OFPERR_OFPBRC_BAD_LEN;
590 if (size < type->min_size) {
591 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
592 "length %u (expected length at least %u bytes)",
593 type->name, size, type->min_size);
594 return OFPERR_OFPBRC_BAD_LEN;
599 if (size < type->min_size
600 || (size - type->min_size) % type->extra_multiple) {
601 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
602 "length %u (must be exactly %u bytes or longer "
603 "by an integer multiple of %u bytes)",
605 type->min_size, type->extra_multiple);
606 return OFPERR_OFPBRC_BAD_LEN;
613 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
614 uint8_t version, uint32_t value,
615 const struct ofputil_msg_type **typep)
617 const struct ofputil_msg_type *type;
619 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
620 if (type->value == value
621 && (!type->ofp_version || version == type->ofp_version)) {
627 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
629 return cat->missing_error;
633 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
634 const struct ofputil_msg_type **typep)
636 static const struct ofputil_msg_type nxt_messages[] = {
637 { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION,
638 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
639 sizeof(struct nx_role_request), 0 },
641 { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION,
642 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
643 sizeof(struct nx_role_request), 0 },
645 { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION,
646 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
647 sizeof(struct nx_set_flow_format), 0 },
649 { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION,
650 NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
651 sizeof(struct nx_set_packet_in_format), 0 },
653 { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION,
654 NXT_PACKET_IN, "NXT_PACKET_IN",
655 sizeof(struct nx_packet_in), 1 },
657 { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION,
658 NXT_FLOW_MOD, "NXT_FLOW_MOD",
659 sizeof(struct nx_flow_mod), 8 },
661 { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION,
662 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
663 sizeof(struct nx_flow_removed), 8 },
665 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION,
666 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
667 sizeof(struct nx_flow_mod_table_id), 0 },
669 { OFPUTIL_NXT_FLOW_AGE, OFP10_VERSION,
670 NXT_FLOW_AGE, "NXT_FLOW_AGE",
671 sizeof(struct nicira_header), 0 },
673 { OFPUTIL_NXT_SET_ASYNC_CONFIG, OFP10_VERSION,
674 NXT_SET_ASYNC_CONFIG, "NXT_SET_ASYNC_CONFIG",
675 sizeof(struct nx_async_config), 0 },
677 { OFPUTIL_NXT_SET_CONTROLLER_ID, OFP10_VERSION,
678 NXT_SET_CONTROLLER_ID, "NXT_SET_CONTROLLER_ID",
679 sizeof(struct nx_controller_id), 0 },
682 static const struct ofputil_msg_category nxt_category = {
683 "Nicira extension message",
684 nxt_messages, ARRAY_SIZE(nxt_messages),
685 OFPERR_OFPBRC_BAD_SUBTYPE
688 const struct ofp_vendor_header *ovh;
689 const struct nicira_header *nh;
691 if (length < sizeof(struct ofp_vendor_header)) {
692 if (length == ntohs(oh->length)) {
693 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
695 return OFPERR_OFPBRC_BAD_LEN;
698 ovh = (const struct ofp_vendor_header *) oh;
699 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
700 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
701 "vendor %"PRIx32, ntohl(ovh->vendor));
702 return OFPERR_OFPBRC_BAD_VENDOR;
705 if (length < sizeof(struct nicira_header)) {
706 if (length == ntohs(oh->length)) {
707 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
708 "length %u (expected at least %zu)",
709 ntohs(ovh->header.length),
710 sizeof(struct nicira_header));
712 return OFPERR_OFPBRC_BAD_LEN;
715 nh = (const struct nicira_header *) oh;
716 return ofputil_lookup_openflow_message(&nxt_category, oh->version,
717 ntohl(nh->subtype), typep);
721 check_nxstats_msg(const struct ofp_header *oh, size_t length)
723 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
726 if (length < sizeof(struct ofp_vendor_stats_msg)) {
727 if (length == ntohs(oh->length)) {
728 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
730 return OFPERR_OFPBRC_BAD_LEN;
733 memcpy(&vendor, osm + 1, sizeof vendor);
734 if (vendor != htonl(NX_VENDOR_ID)) {
735 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
736 "unknown vendor %"PRIx32, ntohl(vendor));
737 return OFPERR_OFPBRC_BAD_VENDOR;
740 if (length < sizeof(struct nicira_stats_msg)) {
741 if (length == ntohs(osm->header.length)) {
742 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
744 return OFPERR_OFPBRC_BAD_LEN;
751 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
752 const struct ofputil_msg_type **typep)
754 static const struct ofputil_msg_type nxst_requests[] = {
755 { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION,
756 NXST_FLOW, "NXST_FLOW request",
757 sizeof(struct nx_flow_stats_request), 8 },
759 { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION,
760 NXST_AGGREGATE, "NXST_AGGREGATE request",
761 sizeof(struct nx_aggregate_stats_request), 8 },
764 static const struct ofputil_msg_category nxst_request_category = {
765 "Nicira extension statistics request",
766 nxst_requests, ARRAY_SIZE(nxst_requests),
767 OFPERR_OFPBRC_BAD_SUBTYPE
770 const struct nicira_stats_msg *nsm;
773 error = check_nxstats_msg(oh, length);
778 nsm = (struct nicira_stats_msg *) oh;
779 return ofputil_lookup_openflow_message(&nxst_request_category, oh->version,
780 ntohl(nsm->subtype), typep);
784 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
785 const struct ofputil_msg_type **typep)
787 static const struct ofputil_msg_type nxst_replies[] = {
788 { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION,
789 NXST_FLOW, "NXST_FLOW reply",
790 sizeof(struct nicira_stats_msg), 8 },
792 { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION,
793 NXST_AGGREGATE, "NXST_AGGREGATE reply",
794 sizeof(struct nx_aggregate_stats_reply), 0 },
797 static const struct ofputil_msg_category nxst_reply_category = {
798 "Nicira extension statistics reply",
799 nxst_replies, ARRAY_SIZE(nxst_replies),
800 OFPERR_OFPBRC_BAD_SUBTYPE
803 const struct nicira_stats_msg *nsm;
806 error = check_nxstats_msg(oh, length);
811 nsm = (struct nicira_stats_msg *) oh;
812 return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version,
813 ntohl(nsm->subtype), typep);
817 check_stats_msg(const struct ofp_header *oh, size_t length)
819 if (length < sizeof(struct ofp_stats_msg)) {
820 if (length == ntohs(oh->length)) {
821 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
823 return OFPERR_OFPBRC_BAD_LEN;
830 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
831 const struct ofputil_msg_type **typep)
833 static const struct ofputil_msg_type ofpst_requests[] = {
834 { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
835 OFPST_DESC, "OFPST_DESC request",
836 sizeof(struct ofp_stats_msg), 0 },
838 { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
839 OFPST_FLOW, "OFPST_FLOW request",
840 sizeof(struct ofp_flow_stats_request), 0 },
842 { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
843 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
844 sizeof(struct ofp_flow_stats_request), 0 },
846 { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
847 OFPST_TABLE, "OFPST_TABLE request",
848 sizeof(struct ofp_stats_msg), 0 },
850 { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
851 OFPST_PORT, "OFPST_PORT request",
852 sizeof(struct ofp_port_stats_request), 0 },
854 { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
855 OFPST_QUEUE, "OFPST_QUEUE request",
856 sizeof(struct ofp_queue_stats_request), 0 },
858 { OFPUTIL_OFPST_PORT_DESC_REQUEST, OFP10_VERSION,
859 OFPST_PORT_DESC, "OFPST_PORT_DESC request",
860 sizeof(struct ofp_stats_msg), 0 },
863 OFPST_VENDOR, "OFPST_VENDOR request",
864 sizeof(struct ofp_vendor_stats_msg), 1 },
867 static const struct ofputil_msg_category ofpst_request_category = {
868 "OpenFlow statistics",
869 ofpst_requests, ARRAY_SIZE(ofpst_requests),
870 OFPERR_OFPBRC_BAD_STAT
873 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
876 error = check_stats_msg(oh, length);
881 error = ofputil_lookup_openflow_message(&ofpst_request_category,
882 oh->version, ntohs(request->type),
884 if (!error && request->type == htons(OFPST_VENDOR)) {
885 error = ofputil_decode_nxst_request(oh, length, typep);
891 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
892 const struct ofputil_msg_type **typep)
894 static const struct ofputil_msg_type ofpst_replies[] = {
895 { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
896 OFPST_DESC, "OFPST_DESC reply",
897 sizeof(struct ofp_desc_stats), 0 },
899 { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
900 OFPST_FLOW, "OFPST_FLOW reply",
901 sizeof(struct ofp_stats_msg), 1 },
903 { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
904 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
905 sizeof(struct ofp_aggregate_stats_reply), 0 },
907 { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
908 OFPST_TABLE, "OFPST_TABLE reply",
909 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
911 { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION,
912 OFPST_PORT, "OFPST_PORT reply",
913 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
915 { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION,
916 OFPST_QUEUE, "OFPST_QUEUE reply",
917 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
919 { OFPUTIL_OFPST_PORT_DESC_REPLY, OFP10_VERSION,
920 OFPST_PORT_DESC, "OFPST_PORT_DESC reply",
921 sizeof(struct ofp_stats_msg), sizeof(struct ofp10_phy_port) },
924 OFPST_VENDOR, "OFPST_VENDOR reply",
925 sizeof(struct ofp_vendor_stats_msg), 1 },
928 static const struct ofputil_msg_category ofpst_reply_category = {
929 "OpenFlow statistics",
930 ofpst_replies, ARRAY_SIZE(ofpst_replies),
931 OFPERR_OFPBRC_BAD_STAT
934 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
937 error = check_stats_msg(oh, length);
942 error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version,
943 ntohs(reply->type), typep);
944 if (!error && reply->type == htons(OFPST_VENDOR)) {
945 error = ofputil_decode_nxst_reply(oh, length, typep);
951 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
952 const struct ofputil_msg_type **typep)
954 static const struct ofputil_msg_type ofpt_messages[] = {
955 { OFPUTIL_OFPT_HELLO, OFP10_VERSION,
956 OFPT_HELLO, "OFPT_HELLO",
957 sizeof(struct ofp_hello), 1 },
959 { OFPUTIL_OFPT_ERROR, 0,
960 OFPT_ERROR, "OFPT_ERROR",
961 sizeof(struct ofp_error_msg), 1 },
963 { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION,
964 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
965 sizeof(struct ofp_header), 1 },
967 { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION,
968 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
969 sizeof(struct ofp_header), 1 },
971 { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION,
972 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
973 sizeof(struct ofp_header), 0 },
975 { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION,
976 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
977 sizeof(struct ofp_switch_features), sizeof(struct ofp10_phy_port) },
978 { OFPUTIL_OFPT_FEATURES_REPLY, OFP11_VERSION,
979 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
980 sizeof(struct ofp_switch_features), sizeof(struct ofp11_port) },
982 { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION,
983 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
984 sizeof(struct ofp_header), 0 },
986 { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION,
987 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
988 sizeof(struct ofp_switch_config), 0 },
990 { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION,
991 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
992 sizeof(struct ofp_switch_config), 0 },
994 { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION,
995 OFPT_PACKET_IN, "OFPT_PACKET_IN",
996 offsetof(struct ofp_packet_in, data), 1 },
998 { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION,
999 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
1000 sizeof(struct ofp_flow_removed), 0 },
1002 { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION,
1003 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
1004 sizeof(struct ofp_port_status) + sizeof(struct ofp10_phy_port), 0 },
1005 { OFPUTIL_OFPT_PORT_STATUS, OFP11_VERSION,
1006 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
1007 sizeof(struct ofp_port_status) + sizeof(struct ofp11_port), 0 },
1009 { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
1010 OFPT10_PACKET_OUT, "OFPT_PACKET_OUT",
1011 sizeof(struct ofp_packet_out), 1 },
1013 { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
1014 OFPT10_FLOW_MOD, "OFPT_FLOW_MOD",
1015 sizeof(struct ofp_flow_mod), 1 },
1017 { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
1018 OFPT10_PORT_MOD, "OFPT_PORT_MOD",
1019 sizeof(struct ofp10_port_mod), 0 },
1020 { OFPUTIL_OFPT_PORT_MOD, OFP11_VERSION,
1021 OFPT11_PORT_MOD, "OFPT_PORT_MOD",
1022 sizeof(struct ofp11_port_mod), 0 },
1025 OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST",
1026 sizeof(struct ofp_stats_msg), 1 },
1029 OFPT10_STATS_REPLY, "OFPT_STATS_REPLY",
1030 sizeof(struct ofp_stats_msg), 1 },
1032 { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION,
1033 OFPT10_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
1034 sizeof(struct ofp_header), 0 },
1036 { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION,
1037 OFPT10_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
1038 sizeof(struct ofp_header), 0 },
1041 OFPT_VENDOR, "OFPT_VENDOR",
1042 sizeof(struct ofp_vendor_header), 1 },
1045 static const struct ofputil_msg_category ofpt_category = {
1047 ofpt_messages, ARRAY_SIZE(ofpt_messages),
1048 OFPERR_OFPBRC_BAD_TYPE
1053 error = ofputil_lookup_openflow_message(&ofpt_category, oh->version,
1056 switch ((oh->version << 8) | oh->type) {
1057 case (OFP10_VERSION << 8) | OFPT_VENDOR:
1058 case (OFP11_VERSION << 8) | OFPT_VENDOR:
1059 error = ofputil_decode_vendor(oh, length, typep);
1062 case (OFP10_VERSION << 8) | OFPT10_STATS_REQUEST:
1063 case (OFP11_VERSION << 8) | OFPT11_STATS_REQUEST:
1064 error = ofputil_decode_ofpst_request(oh, length, typep);
1067 case (OFP10_VERSION << 8) | OFPT10_STATS_REPLY:
1068 case (OFP11_VERSION << 8) | OFPT11_STATS_REPLY:
1069 error = ofputil_decode_ofpst_reply(oh, length, typep);
1078 /* Decodes the message type represented by 'oh'. Returns 0 if successful or an
1079 * OpenFlow error code on failure. Either way, stores in '*typep' a type
1080 * structure that can be inspected with the ofputil_msg_type_*() functions.
1082 * oh->length must indicate the correct length of the message (and must be at
1083 * least sizeof(struct ofp_header)).
1085 * Success indicates that 'oh' is at least as long as the minimum-length
1086 * message of its type. */
1088 ofputil_decode_msg_type(const struct ofp_header *oh,
1089 const struct ofputil_msg_type **typep)
1091 size_t length = ntohs(oh->length);
1094 error = ofputil_decode_msg_type__(oh, length, typep);
1096 error = ofputil_check_length(*typep, length);
1099 *typep = &ofputil_invalid_type;
1104 /* Decodes the message type represented by 'oh', of which only the first
1105 * 'length' bytes are available. Returns 0 if successful or an OpenFlow error
1106 * code on failure. Either way, stores in '*typep' a type structure that can
1107 * be inspected with the ofputil_msg_type_*() functions. */
1109 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
1110 const struct ofputil_msg_type **typep)
1114 error = (length >= sizeof *oh
1115 ? ofputil_decode_msg_type__(oh, length, typep)
1116 : OFPERR_OFPBRC_BAD_LEN);
1118 *typep = &ofputil_invalid_type;
1123 /* Returns an OFPUTIL_* message type code for 'type'. */
1124 enum ofputil_msg_code
1125 ofputil_msg_type_code(const struct ofputil_msg_type *type)
1132 struct proto_abbrev {
1133 enum ofputil_protocol protocol;
1137 /* Most users really don't care about some of the differences between
1138 * protocols. These abbreviations help with that. */
1139 static const struct proto_abbrev proto_abbrevs[] = {
1140 { OFPUTIL_P_ANY, "any" },
1141 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
1142 { OFPUTIL_P_NXM_ANY, "NXM" },
1144 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
1146 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
1150 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
1152 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
1153 * connection that has negotiated the given 'version'. 'version' should
1154 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
1155 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
1156 * outside the valid range. */
1157 enum ofputil_protocol
1158 ofputil_protocol_from_ofp_version(int version)
1161 case OFP10_VERSION: return OFPUTIL_P_OF10;
1166 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION or
1167 * OFP11_VERSION) that corresponds to 'protocol'. */
1169 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
1172 case OFPUTIL_P_OF10:
1173 case OFPUTIL_P_OF10_TID:
1175 case OFPUTIL_P_NXM_TID:
1176 return OFP10_VERSION;
1182 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
1185 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
1187 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
1190 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
1191 * extension turned on or off if 'enable' is true or false, respectively.
1193 * This extension is only useful for protocols whose "standard" version does
1194 * not allow specific tables to be modified. In particular, this is true of
1195 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
1196 * specifies a table ID and so there is no need for such an extension. When
1197 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
1198 * extension, this function just returns its 'protocol' argument unchanged
1199 * regardless of the value of 'enable'. */
1200 enum ofputil_protocol
1201 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
1204 case OFPUTIL_P_OF10:
1205 case OFPUTIL_P_OF10_TID:
1206 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
1209 case OFPUTIL_P_NXM_TID:
1210 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
1217 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
1218 * some extension to a standard protocol version, the return value is the
1219 * standard version of that protocol without any extension. If 'protocol' is a
1220 * standard protocol version, returns 'protocol' unchanged. */
1221 enum ofputil_protocol
1222 ofputil_protocol_to_base(enum ofputil_protocol protocol)
1224 return ofputil_protocol_set_tid(protocol, false);
1227 /* Returns 'new_base' with any extensions taken from 'cur'. */
1228 enum ofputil_protocol
1229 ofputil_protocol_set_base(enum ofputil_protocol cur,
1230 enum ofputil_protocol new_base)
1232 bool tid = (cur & OFPUTIL_P_TID) != 0;
1235 case OFPUTIL_P_OF10:
1236 case OFPUTIL_P_OF10_TID:
1237 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
1240 case OFPUTIL_P_NXM_TID:
1241 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
1248 /* Returns a string form of 'protocol', if a simple form exists (that is, if
1249 * 'protocol' is either a single protocol or it is a combination of protocols
1250 * that have a single abbreviation). Otherwise, returns NULL. */
1252 ofputil_protocol_to_string(enum ofputil_protocol protocol)
1254 const struct proto_abbrev *p;
1256 /* Use a "switch" statement for single-bit names so that we get a compiler
1257 * warning if we forget any. */
1260 return "NXM-table_id";
1262 case OFPUTIL_P_NXM_TID:
1263 return "NXM+table_id";
1265 case OFPUTIL_P_OF10:
1266 return "OpenFlow10-table_id";
1268 case OFPUTIL_P_OF10_TID:
1269 return "OpenFlow10+table_id";
1272 /* Check abbreviations. */
1273 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1274 if (protocol == p->protocol) {
1282 /* Returns a string that represents 'protocols'. The return value might be a
1283 * comma-separated list if 'protocols' doesn't have a simple name. The return
1284 * value is "none" if 'protocols' is 0.
1286 * The caller must free the returned string (with free()). */
1288 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1292 assert(!(protocols & ~OFPUTIL_P_ANY));
1293 if (protocols == 0) {
1294 return xstrdup("none");
1299 const struct proto_abbrev *p;
1303 ds_put_char(&s, ',');
1306 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1307 if ((protocols & p->protocol) == p->protocol) {
1308 ds_put_cstr(&s, p->name);
1309 protocols &= ~p->protocol;
1314 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1315 enum ofputil_protocol bit = 1u << i;
1317 if (protocols & bit) {
1318 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1327 return ds_steal_cstr(&s);
1330 static enum ofputil_protocol
1331 ofputil_protocol_from_string__(const char *s, size_t n)
1333 const struct proto_abbrev *p;
1336 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1337 enum ofputil_protocol bit = 1u << i;
1338 const char *name = ofputil_protocol_to_string(bit);
1340 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1345 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1346 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1354 /* Returns the nonempty set of protocols represented by 's', which can be a
1355 * single protocol name or abbreviation or a comma-separated list of them.
1357 * Aborts the program with an error message if 's' is invalid. */
1358 enum ofputil_protocol
1359 ofputil_protocols_from_string(const char *s)
1361 const char *orig_s = s;
1362 enum ofputil_protocol protocols;
1366 enum ofputil_protocol p;
1369 n = strcspn(s, ",");
1375 p = ofputil_protocol_from_string__(s, n);
1377 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1385 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1391 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1393 switch (packet_in_format) {
1394 case NXPIF_OPENFLOW10:
1403 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1405 switch (packet_in_format) {
1406 case NXPIF_OPENFLOW10:
1407 return "openflow10";
1416 ofputil_packet_in_format_from_string(const char *s)
1418 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1419 : !strcmp(s, "nxm") ? NXPIF_NXM
1424 regs_fully_wildcarded(const struct flow_wildcards *wc)
1428 for (i = 0; i < FLOW_N_REGS; i++) {
1429 if (wc->reg_masks[i] != 0) {
1436 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
1437 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
1438 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
1439 * use OpenFlow 1.0 protocol for backward compatibility. */
1440 enum ofputil_protocol
1441 ofputil_usable_protocols(const struct cls_rule *rule)
1443 const struct flow_wildcards *wc = &rule->wc;
1445 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 11);
1447 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
1448 if (!eth_mask_is_exact(wc->dl_src_mask)
1449 && !eth_addr_is_zero(wc->dl_src_mask)) {
1450 return OFPUTIL_P_NXM_ANY;
1452 if (!eth_mask_is_exact(wc->dl_dst_mask)
1453 && !eth_addr_is_zero(wc->dl_dst_mask)) {
1454 return OFPUTIL_P_NXM_ANY;
1457 /* Only NXM supports matching ARP hardware addresses. */
1458 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
1459 return OFPUTIL_P_NXM_ANY;
1462 /* Only NXM supports matching IPv6 traffic. */
1463 if (!(wc->wildcards & FWW_DL_TYPE)
1464 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
1465 return OFPUTIL_P_NXM_ANY;
1468 /* Only NXM supports matching registers. */
1469 if (!regs_fully_wildcarded(wc)) {
1470 return OFPUTIL_P_NXM_ANY;
1473 /* Only NXM supports matching tun_id. */
1474 if (wc->tun_id_mask != htonll(0)) {
1475 return OFPUTIL_P_NXM_ANY;
1478 /* Only NXM supports matching fragments. */
1479 if (wc->nw_frag_mask) {
1480 return OFPUTIL_P_NXM_ANY;
1483 /* Only NXM supports matching IPv6 flow label. */
1484 if (!(wc->wildcards & FWW_IPV6_LABEL)) {
1485 return OFPUTIL_P_NXM_ANY;
1488 /* Only NXM supports matching IP ECN bits. */
1489 if (!(wc->wildcards & FWW_NW_ECN)) {
1490 return OFPUTIL_P_NXM_ANY;
1493 /* Only NXM supports matching IP TTL/hop limit. */
1494 if (!(wc->wildcards & FWW_NW_TTL)) {
1495 return OFPUTIL_P_NXM_ANY;
1498 /* Only NXM supports non-CIDR IPv4 address masks. */
1499 if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
1500 return OFPUTIL_P_NXM_ANY;
1503 /* Only NXM supports bitwise matching on transport port. */
1504 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
1505 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
1506 return OFPUTIL_P_NXM_ANY;
1509 /* Other formats can express this rule. */
1510 return OFPUTIL_P_ANY;
1513 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1514 * protocol is 'current', at least partly transitions the protocol to 'want'.
1515 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1516 * connection if the switch processes the returned message correctly. (If
1517 * '*next != want' then the caller will have to iterate.)
1519 * If 'current == want', returns NULL and stores 'current' in '*next'. */
1521 ofputil_encode_set_protocol(enum ofputil_protocol current,
1522 enum ofputil_protocol want,
1523 enum ofputil_protocol *next)
1525 enum ofputil_protocol cur_base, want_base;
1526 bool cur_tid, want_tid;
1528 cur_base = ofputil_protocol_to_base(current);
1529 want_base = ofputil_protocol_to_base(want);
1530 if (cur_base != want_base) {
1531 *next = ofputil_protocol_set_base(current, want_base);
1533 switch (want_base) {
1535 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1537 case OFPUTIL_P_OF10:
1538 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1540 case OFPUTIL_P_OF10_TID:
1541 case OFPUTIL_P_NXM_TID:
1546 cur_tid = (current & OFPUTIL_P_TID) != 0;
1547 want_tid = (want & OFPUTIL_P_TID) != 0;
1548 if (cur_tid != want_tid) {
1549 *next = ofputil_protocol_set_tid(current, want_tid);
1550 return ofputil_make_flow_mod_table_id(want_tid);
1553 assert(current == want);
1559 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1560 * format to 'nxff'. */
1562 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1564 struct nx_set_flow_format *sff;
1567 assert(ofputil_nx_flow_format_is_valid(nxff));
1569 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
1570 sff->format = htonl(nxff);
1575 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1577 enum ofputil_protocol
1578 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1580 switch (flow_format) {
1581 case NXFF_OPENFLOW10:
1582 return OFPUTIL_P_OF10;
1585 return OFPUTIL_P_NXM;
1592 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1594 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1596 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1599 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1602 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1604 switch (flow_format) {
1605 case NXFF_OPENFLOW10:
1606 return "openflow10";
1615 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1617 struct nx_set_packet_in_format *spif;
1620 spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg);
1621 spif->format = htonl(packet_in_format);
1626 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1627 * extension on or off (according to 'flow_mod_table_id'). */
1629 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1631 struct nx_flow_mod_table_id *nfmti;
1634 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
1635 nfmti->set = flow_mod_table_id;
1639 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1640 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1643 * Does not validate the flow_mod actions. */
1645 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1646 const struct ofp_header *oh,
1647 enum ofputil_protocol protocol)
1649 const struct ofputil_msg_type *type;
1653 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1655 ofputil_decode_msg_type(oh, &type);
1656 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
1657 /* Standard OpenFlow flow_mod. */
1658 const struct ofp_flow_mod *ofm;
1662 /* Dissect the message. */
1663 ofm = ofpbuf_pull(&b, sizeof *ofm);
1664 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1669 /* Set priority based on original wildcards. Normally we'd allow
1670 * ofputil_cls_rule_from_match() to do this for us, but
1671 * ofputil_normalize_rule() can put wildcards where the original flow
1672 * didn't have them. */
1673 priority = ntohs(ofm->priority);
1674 if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1675 priority = UINT16_MAX;
1678 /* Translate the rule. */
1679 ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1680 ofputil_normalize_rule(&fm->cr);
1682 /* Translate the message. */
1683 command = ntohs(ofm->command);
1684 fm->cookie = htonll(0);
1685 fm->cookie_mask = htonll(0);
1686 fm->new_cookie = ofm->cookie;
1687 fm->idle_timeout = ntohs(ofm->idle_timeout);
1688 fm->hard_timeout = ntohs(ofm->hard_timeout);
1689 fm->buffer_id = ntohl(ofm->buffer_id);
1690 fm->out_port = ntohs(ofm->out_port);
1691 fm->flags = ntohs(ofm->flags);
1692 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1693 /* Nicira extended flow_mod. */
1694 const struct nx_flow_mod *nfm;
1697 /* Dissect the message. */
1698 nfm = ofpbuf_pull(&b, sizeof *nfm);
1699 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1700 &fm->cr, &fm->cookie, &fm->cookie_mask);
1704 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1709 /* Translate the message. */
1710 command = ntohs(nfm->command);
1711 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1712 /* Flow additions may only set a new cookie, not match an
1713 * existing cookie. */
1714 return OFPERR_NXBRC_NXM_INVALID;
1716 fm->new_cookie = nfm->cookie;
1717 fm->idle_timeout = ntohs(nfm->idle_timeout);
1718 fm->hard_timeout = ntohs(nfm->hard_timeout);
1719 fm->buffer_id = ntohl(nfm->buffer_id);
1720 fm->out_port = ntohs(nfm->out_port);
1721 fm->flags = ntohs(nfm->flags);
1726 if (protocol & OFPUTIL_P_TID) {
1727 fm->command = command & 0xff;
1728 fm->table_id = command >> 8;
1730 fm->command = command;
1731 fm->table_id = 0xff;
1737 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1738 * 'protocol' and returns the message. */
1740 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1741 enum ofputil_protocol protocol)
1743 size_t actions_len = fm->n_actions * sizeof *fm->actions;
1744 struct ofp_flow_mod *ofm;
1745 struct nx_flow_mod *nfm;
1750 command = (protocol & OFPUTIL_P_TID
1751 ? (fm->command & 0xff) | (fm->table_id << 8)
1755 case OFPUTIL_P_OF10:
1756 case OFPUTIL_P_OF10_TID:
1757 msg = ofpbuf_new(sizeof *ofm + actions_len);
1758 ofm = put_openflow(sizeof *ofm, OFPT10_FLOW_MOD, msg);
1759 ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1760 ofm->cookie = fm->new_cookie;
1761 ofm->command = htons(command);
1762 ofm->idle_timeout = htons(fm->idle_timeout);
1763 ofm->hard_timeout = htons(fm->hard_timeout);
1764 ofm->priority = htons(fm->cr.priority);
1765 ofm->buffer_id = htonl(fm->buffer_id);
1766 ofm->out_port = htons(fm->out_port);
1767 ofm->flags = htons(fm->flags);
1771 case OFPUTIL_P_NXM_TID:
1772 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1773 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1775 nfm->command = htons(command);
1776 nfm->cookie = fm->new_cookie;
1777 match_len = nx_put_match(msg, false, &fm->cr,
1778 fm->cookie, fm->cookie_mask);
1780 nfm->idle_timeout = htons(fm->idle_timeout);
1781 nfm->hard_timeout = htons(fm->hard_timeout);
1782 nfm->priority = htons(fm->cr.priority);
1783 nfm->buffer_id = htonl(fm->buffer_id);
1784 nfm->out_port = htons(fm->out_port);
1785 nfm->flags = htons(fm->flags);
1786 nfm->match_len = htons(match_len);
1793 ofpbuf_put(msg, fm->actions, actions_len);
1794 update_openflow_length(msg);
1798 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1799 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1800 * 0-bit for each protocol that is inadequate.
1802 * (The return value will have at least one 1-bit.) */
1803 enum ofputil_protocol
1804 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1807 enum ofputil_protocol usable_protocols;
1810 usable_protocols = OFPUTIL_P_ANY;
1811 for (i = 0; i < n_fms; i++) {
1812 const struct ofputil_flow_mod *fm = &fms[i];
1814 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1815 if (fm->table_id != 0xff) {
1816 usable_protocols &= OFPUTIL_P_TID;
1819 /* Matching of the cookie is only supported through NXM. */
1820 if (fm->cookie_mask != htonll(0)) {
1821 usable_protocols &= OFPUTIL_P_NXM_ANY;
1824 assert(usable_protocols);
1826 return usable_protocols;
1830 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1831 const struct ofp_header *oh,
1834 const struct ofp_flow_stats_request *ofsr =
1835 (const struct ofp_flow_stats_request *) oh;
1837 fsr->aggregate = aggregate;
1838 ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1839 fsr->out_port = ntohs(ofsr->out_port);
1840 fsr->table_id = ofsr->table_id;
1841 fsr->cookie = fsr->cookie_mask = htonll(0);
1847 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1848 const struct ofp_header *oh,
1851 const struct nx_flow_stats_request *nfsr;
1855 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1857 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1858 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1859 &fsr->cookie, &fsr->cookie_mask);
1864 return OFPERR_OFPBRC_BAD_LEN;
1867 fsr->aggregate = aggregate;
1868 fsr->out_port = ntohs(nfsr->out_port);
1869 fsr->table_id = nfsr->table_id;
1874 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1875 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1876 * successful, otherwise an OpenFlow error code. */
1878 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1879 const struct ofp_header *oh)
1881 const struct ofputil_msg_type *type;
1885 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1887 ofputil_decode_msg_type(oh, &type);
1888 code = ofputil_msg_type_code(type);
1890 case OFPUTIL_OFPST_FLOW_REQUEST:
1891 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1893 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1894 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1896 case OFPUTIL_NXST_FLOW_REQUEST:
1897 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1899 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1900 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1903 /* Hey, the caller lied. */
1908 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1909 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1910 * 'protocol', and returns the message. */
1912 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1913 enum ofputil_protocol protocol)
1918 case OFPUTIL_P_OF10:
1919 case OFPUTIL_P_OF10_TID: {
1920 struct ofp_flow_stats_request *ofsr;
1923 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1924 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1925 ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1926 ofsr->table_id = fsr->table_id;
1927 ofsr->out_port = htons(fsr->out_port);
1932 case OFPUTIL_P_NXM_TID: {
1933 struct nx_flow_stats_request *nfsr;
1937 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1938 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1939 match_len = nx_put_match(msg, false, &fsr->match,
1940 fsr->cookie, fsr->cookie_mask);
1943 nfsr->out_port = htons(fsr->out_port);
1944 nfsr->match_len = htons(match_len);
1945 nfsr->table_id = fsr->table_id;
1956 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1957 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1959 * (The return value will have at least one 1-bit.) */
1960 enum ofputil_protocol
1961 ofputil_flow_stats_request_usable_protocols(
1962 const struct ofputil_flow_stats_request *fsr)
1964 enum ofputil_protocol usable_protocols;
1966 usable_protocols = ofputil_usable_protocols(&fsr->match);
1967 if (fsr->cookie_mask != htonll(0)) {
1968 usable_protocols &= OFPUTIL_P_NXM_ANY;
1970 return usable_protocols;
1973 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1974 * ofputil_flow_stats in 'fs'.
1976 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1977 * OpenFlow message. Calling this function multiple times for a single 'msg'
1978 * iterates through the replies. The caller must initially leave 'msg''s layer
1979 * pointers null and not modify them between calls.
1981 * Most switches don't send the values needed to populate fs->idle_age and
1982 * fs->hard_age, so those members will usually be set to 0. If the switch from
1983 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1984 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1985 * 'idle_age' and 'hard_age' members in 'fs'.
1987 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1988 * otherwise a positive errno value. */
1990 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1992 bool flow_age_extension)
1994 const struct ofputil_msg_type *type;
1997 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1998 code = ofputil_msg_type_code(type);
2000 msg->l2 = msg->data;
2001 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
2002 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
2003 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
2004 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
2012 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
2013 const struct ofp_flow_stats *ofs;
2016 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2018 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2019 "bytes at end", msg->size);
2023 length = ntohs(ofs->length);
2024 if (length < sizeof *ofs) {
2025 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2026 "length %zu", length);
2030 if (ofputil_pull_actions(msg, length - sizeof *ofs,
2031 &fs->actions, &fs->n_actions)) {
2035 fs->cookie = get_32aligned_be64(&ofs->cookie);
2036 ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
2038 fs->table_id = ofs->table_id;
2039 fs->duration_sec = ntohl(ofs->duration_sec);
2040 fs->duration_nsec = ntohl(ofs->duration_nsec);
2041 fs->idle_timeout = ntohs(ofs->idle_timeout);
2042 fs->hard_timeout = ntohs(ofs->hard_timeout);
2045 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2046 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2047 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
2048 const struct nx_flow_stats *nfs;
2049 size_t match_len, length;
2051 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2053 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2054 "bytes at end", msg->size);
2058 length = ntohs(nfs->length);
2059 match_len = ntohs(nfs->match_len);
2060 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2061 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2062 "claims invalid length %zu", match_len, length);
2065 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
2070 if (ofputil_pull_actions(msg,
2071 length - sizeof *nfs - ROUND_UP(match_len, 8),
2072 &fs->actions, &fs->n_actions)) {
2076 fs->cookie = nfs->cookie;
2077 fs->table_id = nfs->table_id;
2078 fs->duration_sec = ntohl(nfs->duration_sec);
2079 fs->duration_nsec = ntohl(nfs->duration_nsec);
2080 fs->idle_timeout = ntohs(nfs->idle_timeout);
2081 fs->hard_timeout = ntohs(nfs->hard_timeout);
2084 if (flow_age_extension) {
2085 if (nfs->idle_age) {
2086 fs->idle_age = ntohs(nfs->idle_age) - 1;
2088 if (nfs->hard_age) {
2089 fs->hard_age = ntohs(nfs->hard_age) - 1;
2092 fs->packet_count = ntohll(nfs->packet_count);
2093 fs->byte_count = ntohll(nfs->byte_count);
2101 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2103 * We use this in situations where OVS internally uses UINT64_MAX to mean
2104 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2106 unknown_to_zero(uint64_t count)
2108 return count != UINT64_MAX ? count : 0;
2111 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2112 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2113 * have been initialized with ofputil_start_stats_reply(). */
2115 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2116 struct list *replies)
2118 size_t act_len = fs->n_actions * sizeof *fs->actions;
2119 const struct ofp_stats_msg *osm;
2121 osm = ofpbuf_from_list(list_back(replies))->data;
2122 if (osm->type == htons(OFPST_FLOW)) {
2123 size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
2124 struct ofp_flow_stats *ofs;
2126 ofs = ofputil_append_stats_reply(len, replies);
2127 ofs->length = htons(len);
2128 ofs->table_id = fs->table_id;
2130 ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
2131 ofs->duration_sec = htonl(fs->duration_sec);
2132 ofs->duration_nsec = htonl(fs->duration_nsec);
2133 ofs->priority = htons(fs->rule.priority);
2134 ofs->idle_timeout = htons(fs->idle_timeout);
2135 ofs->hard_timeout = htons(fs->hard_timeout);
2136 memset(ofs->pad2, 0, sizeof ofs->pad2);
2137 put_32aligned_be64(&ofs->cookie, fs->cookie);
2138 put_32aligned_be64(&ofs->packet_count,
2139 htonll(unknown_to_zero(fs->packet_count)));
2140 put_32aligned_be64(&ofs->byte_count,
2141 htonll(unknown_to_zero(fs->byte_count)));
2142 memcpy(ofs->actions, fs->actions, act_len);
2143 } else if (osm->type == htons(OFPST_VENDOR)) {
2144 struct nx_flow_stats *nfs;
2148 msg = ofputil_reserve_stats_reply(
2149 sizeof *nfs + NXM_MAX_LEN + act_len, replies);
2150 start_len = msg->size;
2152 nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
2153 nfs->table_id = fs->table_id;
2155 nfs->duration_sec = htonl(fs->duration_sec);
2156 nfs->duration_nsec = htonl(fs->duration_nsec);
2157 nfs->priority = htons(fs->rule.priority);
2158 nfs->idle_timeout = htons(fs->idle_timeout);
2159 nfs->hard_timeout = htons(fs->hard_timeout);
2160 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2161 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2163 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2164 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2166 nfs->match_len = htons(nx_put_match(msg, false, &fs->rule, 0, 0));
2167 nfs->cookie = fs->cookie;
2168 nfs->packet_count = htonll(fs->packet_count);
2169 nfs->byte_count = htonll(fs->byte_count);
2170 ofpbuf_put(msg, fs->actions, act_len);
2171 nfs->length = htons(msg->size - start_len);
2177 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2178 * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
2180 ofputil_encode_aggregate_stats_reply(
2181 const struct ofputil_aggregate_stats *stats,
2182 const struct ofp_stats_msg *request)
2186 if (request->type == htons(OFPST_AGGREGATE)) {
2187 struct ofp_aggregate_stats_reply *asr;
2189 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
2190 put_32aligned_be64(&asr->packet_count,
2191 htonll(unknown_to_zero(stats->packet_count)));
2192 put_32aligned_be64(&asr->byte_count,
2193 htonll(unknown_to_zero(stats->byte_count)));
2194 asr->flow_count = htonl(stats->flow_count);
2195 } else if (request->type == htons(OFPST_VENDOR)) {
2196 struct nx_aggregate_stats_reply *nasr;
2198 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
2199 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
2200 nasr->packet_count = htonll(stats->packet_count);
2201 nasr->byte_count = htonll(stats->byte_count);
2202 nasr->flow_count = htonl(stats->flow_count);
2210 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2211 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2212 * an OpenFlow error code. */
2214 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2215 const struct ofp_header *oh)
2217 const struct ofputil_msg_type *type;
2218 enum ofputil_msg_code code;
2220 ofputil_decode_msg_type(oh, &type);
2221 code = ofputil_msg_type_code(type);
2222 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
2223 const struct ofp_flow_removed *ofr;
2225 ofr = (const struct ofp_flow_removed *) oh;
2226 ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
2228 fr->cookie = ofr->cookie;
2229 fr->reason = ofr->reason;
2230 fr->duration_sec = ntohl(ofr->duration_sec);
2231 fr->duration_nsec = ntohl(ofr->duration_nsec);
2232 fr->idle_timeout = ntohs(ofr->idle_timeout);
2233 fr->packet_count = ntohll(ofr->packet_count);
2234 fr->byte_count = ntohll(ofr->byte_count);
2235 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
2236 struct nx_flow_removed *nfr;
2240 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2242 nfr = ofpbuf_pull(&b, sizeof *nfr);
2243 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
2244 &fr->rule, NULL, NULL);
2249 return OFPERR_OFPBRC_BAD_LEN;
2252 fr->cookie = nfr->cookie;
2253 fr->reason = nfr->reason;
2254 fr->duration_sec = ntohl(nfr->duration_sec);
2255 fr->duration_nsec = ntohl(nfr->duration_nsec);
2256 fr->idle_timeout = ntohs(nfr->idle_timeout);
2257 fr->packet_count = ntohll(nfr->packet_count);
2258 fr->byte_count = ntohll(nfr->byte_count);
2266 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2267 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2270 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2271 enum ofputil_protocol protocol)
2276 case OFPUTIL_P_OF10:
2277 case OFPUTIL_P_OF10_TID: {
2278 struct ofp_flow_removed *ofr;
2280 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
2282 ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
2283 ofr->cookie = fr->cookie;
2284 ofr->priority = htons(fr->rule.priority);
2285 ofr->reason = fr->reason;
2286 ofr->duration_sec = htonl(fr->duration_sec);
2287 ofr->duration_nsec = htonl(fr->duration_nsec);
2288 ofr->idle_timeout = htons(fr->idle_timeout);
2289 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2290 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2295 case OFPUTIL_P_NXM_TID: {
2296 struct nx_flow_removed *nfr;
2299 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
2300 match_len = nx_put_match(msg, false, &fr->rule, 0, 0);
2303 nfr->cookie = fr->cookie;
2304 nfr->priority = htons(fr->rule.priority);
2305 nfr->reason = fr->reason;
2306 nfr->duration_sec = htonl(fr->duration_sec);
2307 nfr->duration_nsec = htonl(fr->duration_nsec);
2308 nfr->idle_timeout = htons(fr->idle_timeout);
2309 nfr->match_len = htons(match_len);
2310 nfr->packet_count = htonll(fr->packet_count);
2311 nfr->byte_count = htonll(fr->byte_count);
2323 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2324 const struct ofp_header *oh)
2326 const struct ofputil_msg_type *type;
2327 enum ofputil_msg_code code;
2329 ofputil_decode_msg_type(oh, &type);
2330 code = ofputil_msg_type_code(type);
2331 memset(pin, 0, sizeof *pin);
2333 if (code == OFPUTIL_OFPT_PACKET_IN) {
2334 const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
2336 pin->packet = opi->data;
2337 pin->packet_len = ntohs(opi->header.length)
2338 - offsetof(struct ofp_packet_in, data);
2340 pin->fmd.in_port = ntohs(opi->in_port);
2341 pin->reason = opi->reason;
2342 pin->buffer_id = ntohl(opi->buffer_id);
2343 pin->total_len = ntohs(opi->total_len);
2344 } else if (code == OFPUTIL_NXT_PACKET_IN) {
2345 const struct nx_packet_in *npi;
2346 struct cls_rule rule;
2350 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2352 npi = ofpbuf_pull(&b, sizeof *npi);
2353 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2359 if (!ofpbuf_try_pull(&b, 2)) {
2360 return OFPERR_OFPBRC_BAD_LEN;
2363 pin->packet = b.data;
2364 pin->packet_len = b.size;
2365 pin->reason = npi->reason;
2366 pin->table_id = npi->table_id;
2367 pin->cookie = npi->cookie;
2369 pin->fmd.in_port = rule.flow.in_port;
2371 pin->fmd.tun_id = rule.flow.tun_id;
2372 pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
2374 memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
2375 memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
2376 sizeof pin->fmd.reg_masks);
2378 pin->buffer_id = ntohl(npi->buffer_id);
2379 pin->total_len = ntohs(npi->total_len);
2387 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2388 * in the format specified by 'packet_in_format'. */
2390 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2391 enum nx_packet_in_format packet_in_format)
2393 size_t send_len = MIN(pin->send_len, pin->packet_len);
2394 struct ofpbuf *packet;
2396 /* Add OFPT_PACKET_IN. */
2397 if (packet_in_format == NXPIF_OPENFLOW10) {
2398 size_t header_len = offsetof(struct ofp_packet_in, data);
2399 struct ofp_packet_in *opi;
2401 packet = ofpbuf_new(send_len + header_len);
2402 opi = ofpbuf_put_zeros(packet, header_len);
2403 opi->header.version = OFP10_VERSION;
2404 opi->header.type = OFPT_PACKET_IN;
2405 opi->total_len = htons(pin->total_len);
2406 opi->in_port = htons(pin->fmd.in_port);
2407 opi->reason = pin->reason;
2408 opi->buffer_id = htonl(pin->buffer_id);
2410 ofpbuf_put(packet, pin->packet, send_len);
2411 } else if (packet_in_format == NXPIF_NXM) {
2412 struct nx_packet_in *npi;
2413 struct cls_rule rule;
2417 /* Estimate of required PACKET_IN length includes the NPI header, space
2418 * for the match (2 times sizeof the metadata seems like enough), 2
2419 * bytes for padding, and the packet length. */
2420 packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
2423 cls_rule_init_catchall(&rule, 0);
2424 cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
2425 pin->fmd.tun_id_mask);
2427 for (i = 0; i < FLOW_N_REGS; i++) {
2428 cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
2429 pin->fmd.reg_masks[i]);
2432 cls_rule_set_in_port(&rule, pin->fmd.in_port);
2434 ofpbuf_put_zeros(packet, sizeof *npi);
2435 match_len = nx_put_match(packet, false, &rule, 0, 0);
2436 ofpbuf_put_zeros(packet, 2);
2437 ofpbuf_put(packet, pin->packet, send_len);
2440 npi->nxh.header.version = OFP10_VERSION;
2441 npi->nxh.header.type = OFPT_VENDOR;
2442 npi->nxh.vendor = htonl(NX_VENDOR_ID);
2443 npi->nxh.subtype = htonl(NXT_PACKET_IN);
2445 npi->buffer_id = htonl(pin->buffer_id);
2446 npi->total_len = htons(pin->total_len);
2447 npi->reason = pin->reason;
2448 npi->table_id = pin->table_id;
2449 npi->cookie = pin->cookie;
2450 npi->match_len = htons(match_len);
2454 update_openflow_length(packet);
2460 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2462 static char s[INT_STRLEN(int) + 1];
2469 case OFPR_INVALID_TTL:
2470 return "invalid_ttl";
2472 case OFPR_N_REASONS:
2474 sprintf(s, "%d", (int) reason);
2480 ofputil_packet_in_reason_from_string(const char *s,
2481 enum ofp_packet_in_reason *reason)
2485 for (i = 0; i < OFPR_N_REASONS; i++) {
2486 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2495 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2496 const struct ofp_packet_out *opo)
2501 po->buffer_id = ntohl(opo->buffer_id);
2502 po->in_port = ntohs(opo->in_port);
2503 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2504 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2505 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2507 return OFPERR_NXBRC_BAD_IN_PORT;
2510 ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
2511 ofpbuf_pull(&b, sizeof *opo);
2513 error = ofputil_pull_actions(&b, ntohs(opo->actions_len),
2514 &po->actions, &po->n_actions);
2519 if (po->buffer_id == UINT32_MAX) {
2520 po->packet = b.data;
2521 po->packet_len = b.size;
2530 /* ofputil_phy_port */
2532 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2533 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2534 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2535 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2536 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2537 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2538 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2539 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2541 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2542 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2543 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2544 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2545 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2546 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2548 static enum netdev_features
2549 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2551 uint32_t ofp10 = ntohl(ofp10_);
2552 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2556 netdev_port_features_to_ofp10(enum netdev_features features)
2558 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2561 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2562 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2563 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2564 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2565 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2566 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2567 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2568 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2569 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2570 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2571 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2572 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2573 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2574 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2575 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2576 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2578 static enum netdev_features
2579 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2581 return ntohl(ofp11) & 0xffff;
2585 netdev_port_features_to_ofp11(enum netdev_features features)
2587 return htonl(features & 0xffff);
2591 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2592 const struct ofp10_phy_port *opp)
2594 memset(pp, 0, sizeof *pp);
2596 pp->port_no = ntohs(opp->port_no);
2597 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2598 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2600 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2601 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2603 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2604 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2605 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2606 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2608 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2609 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2615 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2616 const struct ofp11_port *op)
2620 memset(pp, 0, sizeof *pp);
2622 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2626 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2627 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2629 pp->config = ntohl(op->config) & OFPPC11_ALL;
2630 pp->state = ntohl(op->state) & OFPPC11_ALL;
2632 pp->curr = netdev_port_features_from_ofp11(op->curr);
2633 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2634 pp->supported = netdev_port_features_from_ofp11(op->supported);
2635 pp->peer = netdev_port_features_from_ofp11(op->peer);
2637 pp->curr_speed = ntohl(op->curr_speed);
2638 pp->max_speed = ntohl(op->max_speed);
2644 ofputil_get_phy_port_size(uint8_t ofp_version)
2646 return ofp_version == OFP10_VERSION ? sizeof(struct ofp10_phy_port)
2647 : sizeof(struct ofp11_port);
2651 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2652 struct ofp10_phy_port *opp)
2654 memset(opp, 0, sizeof *opp);
2656 opp->port_no = htons(pp->port_no);
2657 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2658 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2660 opp->config = htonl(pp->config & OFPPC10_ALL);
2661 opp->state = htonl(pp->state & OFPPS10_ALL);
2663 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2664 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2665 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2666 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2670 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2671 struct ofp11_port *op)
2673 memset(op, 0, sizeof *op);
2675 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2676 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2677 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2679 op->config = htonl(pp->config & OFPPC11_ALL);
2680 op->state = htonl(pp->state & OFPPS11_ALL);
2682 op->curr = netdev_port_features_to_ofp11(pp->curr);
2683 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2684 op->supported = netdev_port_features_to_ofp11(pp->supported);
2685 op->peer = netdev_port_features_to_ofp11(pp->peer);
2687 op->curr_speed = htonl(pp->curr_speed);
2688 op->max_speed = htonl(pp->max_speed);
2692 ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
2695 if (ofp_version == OFP10_VERSION) {
2696 struct ofp10_phy_port *opp;
2697 if (b->size + sizeof *opp <= UINT16_MAX) {
2698 opp = ofpbuf_put_uninit(b, sizeof *opp);
2699 ofputil_encode_ofp10_phy_port(pp, opp);
2702 struct ofp11_port *op;
2703 if (b->size + sizeof *op <= UINT16_MAX) {
2704 op = ofpbuf_put_uninit(b, sizeof *op);
2705 ofputil_encode_ofp11_port(pp, op);
2711 ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
2712 const struct ofputil_phy_port *pp,
2713 struct list *replies)
2715 if (ofp_version == OFP10_VERSION) {
2716 struct ofp10_phy_port *opp;
2718 opp = ofputil_append_stats_reply(sizeof *opp, replies);
2719 ofputil_encode_ofp10_phy_port(pp, opp);
2721 struct ofp11_port *op;
2723 op = ofputil_append_stats_reply(sizeof *op, replies);
2724 ofputil_encode_ofp11_port(pp, op);
2728 /* ofputil_switch_features */
2730 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2731 OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
2732 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2733 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2734 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2735 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2736 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2737 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2739 struct ofputil_action_bit_translation {
2740 enum ofputil_action_bitmap ofputil_bit;
2744 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2745 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2746 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2747 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2748 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2749 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2750 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2751 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2752 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2753 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2754 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2755 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2756 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2760 static const struct ofputil_action_bit_translation of11_action_bits[] = {
2761 { OFPUTIL_A_OUTPUT, OFPAT11_OUTPUT },
2762 { OFPUTIL_A_SET_VLAN_VID, OFPAT11_SET_VLAN_VID },
2763 { OFPUTIL_A_SET_VLAN_PCP, OFPAT11_SET_VLAN_PCP },
2764 { OFPUTIL_A_SET_DL_SRC, OFPAT11_SET_DL_SRC },
2765 { OFPUTIL_A_SET_DL_DST, OFPAT11_SET_DL_DST },
2766 { OFPUTIL_A_SET_NW_SRC, OFPAT11_SET_NW_SRC },
2767 { OFPUTIL_A_SET_NW_DST, OFPAT11_SET_NW_DST },
2768 { OFPUTIL_A_SET_NW_TOS, OFPAT11_SET_NW_TOS },
2769 { OFPUTIL_A_SET_NW_ECN, OFPAT11_SET_NW_ECN },
2770 { OFPUTIL_A_SET_TP_SRC, OFPAT11_SET_TP_SRC },
2771 { OFPUTIL_A_SET_TP_DST, OFPAT11_SET_TP_DST },
2772 { OFPUTIL_A_COPY_TTL_OUT, OFPAT11_COPY_TTL_OUT },
2773 { OFPUTIL_A_COPY_TTL_IN, OFPAT11_COPY_TTL_IN },
2774 { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
2775 { OFPUTIL_A_SET_MPLS_TC, OFPAT11_SET_MPLS_TC },
2776 { OFPUTIL_A_SET_MPLS_TTL, OFPAT11_SET_MPLS_TTL },
2777 { OFPUTIL_A_DEC_MPLS_TTL, OFPAT11_DEC_MPLS_TTL },
2778 { OFPUTIL_A_PUSH_VLAN, OFPAT11_PUSH_VLAN },
2779 { OFPUTIL_A_POP_VLAN, OFPAT11_POP_VLAN },
2780 { OFPUTIL_A_PUSH_MPLS, OFPAT11_PUSH_MPLS },
2781 { OFPUTIL_A_POP_MPLS, OFPAT11_POP_MPLS },
2782 { OFPUTIL_A_SET_QUEUE, OFPAT11_SET_QUEUE },
2783 { OFPUTIL_A_GROUP, OFPAT11_GROUP },
2784 { OFPUTIL_A_SET_NW_TTL, OFPAT11_SET_NW_TTL },
2785 { OFPUTIL_A_DEC_NW_TTL, OFPAT11_DEC_NW_TTL },
2789 static enum ofputil_action_bitmap
2790 decode_action_bits(ovs_be32 of_actions,
2791 const struct ofputil_action_bit_translation *x)
2793 enum ofputil_action_bitmap ofputil_actions;
2795 ofputil_actions = 0;
2796 for (; x->ofputil_bit; x++) {
2797 if (of_actions & htonl(1u << x->of_bit)) {
2798 ofputil_actions |= x->ofputil_bit;
2801 return ofputil_actions;
2804 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2805 * abstract representation in '*features'. Initializes '*b' to iterate over
2806 * the OpenFlow port structures following 'osf' with later calls to
2807 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2808 * OFPERR_* value. */
2810 ofputil_decode_switch_features(const struct ofp_switch_features *osf,
2811 struct ofputil_switch_features *features,
2814 ofpbuf_use_const(b, osf, ntohs(osf->header.length));
2815 ofpbuf_pull(b, sizeof *osf);
2817 features->datapath_id = ntohll(osf->datapath_id);
2818 features->n_buffers = ntohl(osf->n_buffers);
2819 features->n_tables = osf->n_tables;
2821 features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
2823 if (b->size % ofputil_get_phy_port_size(osf->header.version)) {
2824 return OFPERR_OFPBRC_BAD_LEN;
2827 if (osf->header.version == OFP10_VERSION) {
2828 if (osf->capabilities & htonl(OFPC10_STP)) {
2829 features->capabilities |= OFPUTIL_C_STP;
2831 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2832 } else if (osf->header.version == OFP11_VERSION) {
2833 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2834 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2836 features->actions = decode_action_bits(osf->actions, of11_action_bits);
2838 return OFPERR_OFPBRC_BAD_VERSION;
2844 /* Returns true if the maximum number of ports are in 'osf'. */
2846 max_ports_in_features(const struct ofp_switch_features *osf)
2848 size_t pp_size = ofputil_get_phy_port_size(osf->header.version);
2849 return ntohs(osf->header.length) + pp_size > UINT16_MAX;
2852 /* Given a buffer 'b' that contains a Features Reply message, checks if
2853 * it contains the maximum number of ports that will fit. If so, it
2854 * returns true and removes the ports from the message. The caller
2855 * should then send an OFPST_PORT_DESC stats request to get the ports,
2856 * since the switch may have more ports than could be represented in the
2857 * Features Reply. Otherwise, returns false.
2860 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2862 struct ofp_switch_features *osf = b->data;
2864 if (max_ports_in_features(osf)) {
2865 /* Remove all the ports. */
2866 b->size = sizeof(*osf);
2867 update_openflow_length(b);
2876 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2877 const struct ofputil_action_bit_translation *x)
2879 uint32_t of_actions;
2882 for (; x->ofputil_bit; x++) {
2883 if (ofputil_actions & x->ofputil_bit) {
2884 of_actions |= 1 << x->of_bit;
2887 return htonl(of_actions);
2890 /* Returns a buffer owned by the caller that encodes 'features' in the format
2891 * required by 'protocol' with the given 'xid'. The caller should append port
2892 * information to the buffer with subsequent calls to
2893 * ofputil_put_switch_features_port(). */
2895 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2896 enum ofputil_protocol protocol, ovs_be32 xid)
2898 struct ofp_switch_features *osf;
2901 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
2902 osf->header.version = ofputil_protocol_to_ofp_version(protocol);
2903 osf->datapath_id = htonll(features->datapath_id);
2904 osf->n_buffers = htonl(features->n_buffers);
2905 osf->n_tables = features->n_tables;
2907 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2908 if (osf->header.version == OFP10_VERSION) {
2909 if (features->capabilities & OFPUTIL_C_STP) {
2910 osf->capabilities |= htonl(OFPC10_STP);
2912 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2914 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2915 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2917 osf->actions = encode_action_bits(features->actions, of11_action_bits);
2923 /* Encodes 'pp' into the format required by the switch_features message already
2924 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2925 * and appends the encoded version to 'b'. */
2927 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2930 const struct ofp_switch_features *osf = b->data;
2932 ofputil_put_phy_port(osf->header.version, pp, b);
2935 /* ofputil_port_status */
2937 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2938 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2940 ofputil_decode_port_status(const struct ofp_port_status *ops,
2941 struct ofputil_port_status *ps)
2946 if (ops->reason != OFPPR_ADD &&
2947 ops->reason != OFPPR_DELETE &&
2948 ops->reason != OFPPR_MODIFY) {
2949 return OFPERR_NXBRC_BAD_REASON;
2951 ps->reason = ops->reason;
2953 ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
2954 ofpbuf_pull(&b, sizeof *ops);
2955 retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
2956 assert(retval != EOF);
2960 /* Converts the abstract form of a "port status" message in '*ps' into an
2961 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2962 * a buffer owned by the caller. */
2964 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2965 enum ofputil_protocol protocol)
2967 struct ofp_port_status *ops;
2970 b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
2971 ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
2972 ops->header.version = ofputil_protocol_to_ofp_version(protocol);
2973 ops->reason = ps->reason;
2974 ofputil_put_phy_port(ops->header.version, &ps->desc, b);
2975 update_openflow_length(b);
2979 /* ofputil_port_mod */
2981 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2982 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2984 ofputil_decode_port_mod(const struct ofp_header *oh,
2985 struct ofputil_port_mod *pm)
2987 if (oh->version == OFP10_VERSION) {
2988 const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
2990 if (oh->length != htons(sizeof *opm)) {
2991 return OFPERR_OFPBRC_BAD_LEN;
2994 pm->port_no = ntohs(opm->port_no);
2995 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2996 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2997 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2998 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2999 } else if (oh->version == OFP11_VERSION) {
3000 const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
3003 if (oh->length != htons(sizeof *opm)) {
3004 return OFPERR_OFPBRC_BAD_LEN;
3007 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3012 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3013 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3014 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3015 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3017 return OFPERR_OFPBRC_BAD_VERSION;
3020 pm->config &= pm->mask;
3024 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3025 * message suitable for 'protocol', and returns that encoded form in a buffer
3026 * owned by the caller. */
3028 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3029 enum ofputil_protocol protocol)
3031 uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
3034 if (ofp_version == OFP10_VERSION) {
3035 struct ofp10_port_mod *opm;
3037 opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
3038 opm->port_no = htons(pm->port_no);
3039 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3040 opm->config = htonl(pm->config & OFPPC10_ALL);
3041 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3042 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3043 } else if (ofp_version == OFP11_VERSION) {
3044 struct ofp11_port_mod *opm;
3046 opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
3047 opm->port_no = htonl(pm->port_no);
3048 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3049 opm->config = htonl(pm->config & OFPPC11_ALL);
3050 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3051 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3060 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
3062 struct ofp_packet_out *opo;
3067 actions_len = po->n_actions * sizeof *po->actions;
3068 size = sizeof *opo + actions_len;
3069 if (po->buffer_id == UINT32_MAX) {
3070 size += po->packet_len;
3073 msg = ofpbuf_new(size);
3074 opo = put_openflow(sizeof *opo, OFPT10_PACKET_OUT, msg);
3075 opo->buffer_id = htonl(po->buffer_id);
3076 opo->in_port = htons(po->in_port);
3077 opo->actions_len = htons(actions_len);
3078 ofpbuf_put(msg, po->actions, actions_len);
3079 if (po->buffer_id == UINT32_MAX) {
3080 ofpbuf_put(msg, po->packet, po->packet_len);
3082 update_openflow_length(msg);
3087 /* Returns a string representing the message type of 'type'. The string is the
3088 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
3089 * messages, the constant is followed by "request" or "reply",
3090 * e.g. "OFPST_AGGREGATE reply". */
3092 ofputil_msg_type_name(const struct ofputil_msg_type *type)
3097 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
3098 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
3099 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
3102 * The caller is responsible for freeing '*bufferp' when it is no longer
3105 * The OpenFlow header length is initially set to 'openflow_len'; if the
3106 * message is later extended, the length should be updated with
3107 * update_openflow_length() before sending.
3109 * Returns the header. */
3111 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
3113 *bufferp = ofpbuf_new(openflow_len);
3114 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
3117 /* Similar to make_openflow() but creates a Nicira vendor extension message
3118 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3120 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
3122 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
3125 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
3126 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
3127 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
3130 * The caller is responsible for freeing '*bufferp' when it is no longer
3133 * The OpenFlow header length is initially set to 'openflow_len'; if the
3134 * message is later extended, the length should be updated with
3135 * update_openflow_length() before sending.
3137 * Returns the header. */
3139 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
3140 struct ofpbuf **bufferp)
3142 *bufferp = ofpbuf_new(openflow_len);
3143 return put_openflow_xid(openflow_len, type, xid, *bufferp);
3146 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
3147 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3149 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
3150 struct ofpbuf **bufferp)
3152 *bufferp = ofpbuf_new(openflow_len);
3153 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
3156 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
3157 * with the given 'type' and an arbitrary transaction id. Allocated bytes
3158 * beyond the header, if any, are zeroed.
3160 * The OpenFlow header length is initially set to 'openflow_len'; if the
3161 * message is later extended, the length should be updated with
3162 * update_openflow_length() before sending.
3164 * Returns the header. */
3166 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
3168 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
3171 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
3172 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
3173 * the header, if any, are zeroed.
3175 * The OpenFlow header length is initially set to 'openflow_len'; if the
3176 * message is later extended, the length should be updated with
3177 * update_openflow_length() before sending.
3179 * Returns the header. */
3181 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
3182 struct ofpbuf *buffer)
3184 struct ofp_header *oh;
3186 assert(openflow_len >= sizeof *oh);
3187 assert(openflow_len <= UINT16_MAX);
3189 oh = ofpbuf_put_uninit(buffer, openflow_len);
3190 oh->version = OFP10_VERSION;
3192 oh->length = htons(openflow_len);
3194 memset(oh + 1, 0, openflow_len - sizeof *oh);
3198 /* Similar to put_openflow() but append a Nicira vendor extension message with
3199 * the specific 'subtype'. 'subtype' should be in host byte order. */
3201 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
3203 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
3206 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
3207 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3209 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
3210 struct ofpbuf *buffer)
3212 struct nicira_header *nxh;
3214 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
3215 nxh->vendor = htonl(NX_VENDOR_ID);
3216 nxh->subtype = htonl(subtype);
3220 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
3221 * 'buffer->size'. */
3223 update_openflow_length(struct ofpbuf *buffer)
3225 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
3226 oh->length = htons(buffer->size);
3230 put_stats__(ovs_be32 xid, uint8_t ofp_type,
3231 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
3234 if (ofpst_type == htons(OFPST_VENDOR)) {
3235 struct nicira_stats_msg *nsm;
3237 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
3238 nsm->vsm.osm.type = ofpst_type;
3239 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
3240 nsm->subtype = nxst_subtype;
3242 struct ofp_stats_msg *osm;
3244 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
3245 osm->type = ofpst_type;
3249 /* Creates a statistics request message with total length 'openflow_len'
3250 * (including all headers) and the given 'ofpst_type', and stores the buffer
3251 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
3252 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
3253 * subtype (otherwise 'nxst_subtype' is ignored).
3255 * Initializes bytes following the headers to all-bits-zero.
3257 * Returns the first byte of the new message. */
3259 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
3260 uint32_t nxst_subtype, struct ofpbuf **bufferp)
3264 msg = *bufferp = ofpbuf_new(openflow_len);
3265 put_stats__(alloc_xid(), OFPT10_STATS_REQUEST,
3266 htons(ofpst_type), htonl(nxst_subtype), msg);
3267 ofpbuf_padto(msg, openflow_len);
3273 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
3275 assert(request->header.type == OFPT10_STATS_REQUEST ||
3276 request->header.type == OFPT10_STATS_REPLY);
3277 put_stats__(request->header.xid, OFPT10_STATS_REPLY, request->type,
3278 (request->type != htons(OFPST_VENDOR)
3280 : ((const struct nicira_stats_msg *) request)->subtype),
3284 /* Creates a statistics reply message with total length 'openflow_len'
3285 * (including all headers) and the same type (either a standard OpenFlow
3286 * statistics type or a Nicira extension type and subtype) as 'request', and
3287 * stores the buffer containing the new message in '*bufferp'.
3289 * Initializes bytes following the headers to all-bits-zero.
3291 * Returns the first byte of the new message. */
3293 ofputil_make_stats_reply(size_t openflow_len,
3294 const struct ofp_stats_msg *request,
3295 struct ofpbuf **bufferp)
3299 msg = *bufferp = ofpbuf_new(openflow_len);
3300 put_stats_reply__(request, msg);
3301 ofpbuf_padto(msg, openflow_len);
3306 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
3307 * replies to 'request', which should be an OpenFlow or Nicira extension
3308 * statistics request. Initially 'replies' will have a single reply message
3309 * that has only a header. The functions ofputil_reserve_stats_reply() and
3310 * ofputil_append_stats_reply() may be used to add to the reply. */
3312 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
3313 struct list *replies)
3317 msg = ofpbuf_new(1024);
3318 put_stats_reply__(request, msg);
3321 list_push_back(replies, &msg->list_node);
3324 /* Prepares to append up to 'len' bytes to the series of statistics replies in
3325 * 'replies', which should have been initialized with
3326 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
3327 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
3328 * do so with e.g. ofpbuf_put_uninit().) */
3330 ofputil_reserve_stats_reply(size_t len, struct list *replies)
3332 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3333 struct ofp_stats_msg *osm = msg->data;
3335 if (msg->size + len <= UINT16_MAX) {
3336 ofpbuf_prealloc_tailroom(msg, len);
3338 osm->flags |= htons(OFPSF_REPLY_MORE);
3340 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
3341 put_stats_reply__(osm, msg);
3342 list_push_back(replies, &msg->list_node);
3347 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
3348 * returns the first byte. */
3350 ofputil_append_stats_reply(size_t len, struct list *replies)
3352 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
3355 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
3357 ofputil_stats_body(const struct ofp_header *oh)
3359 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3360 return (const struct ofp_stats_msg *) oh + 1;
3363 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
3365 ofputil_stats_body_len(const struct ofp_header *oh)
3367 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3368 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
3371 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
3373 ofputil_nxstats_body(const struct ofp_header *oh)
3375 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3376 return ((const struct nicira_stats_msg *) oh) + 1;
3379 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
3381 ofputil_nxstats_body_len(const struct ofp_header *oh)
3383 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3384 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
3388 make_flow_mod(uint16_t command, const struct cls_rule *rule,
3391 struct ofp_flow_mod *ofm;
3392 size_t size = sizeof *ofm + actions_len;
3393 struct ofpbuf *out = ofpbuf_new(size);
3394 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
3395 ofm->header.version = OFP10_VERSION;
3396 ofm->header.type = OFPT10_FLOW_MOD;
3397 ofm->header.length = htons(size);
3399 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
3400 ofputil_cls_rule_to_ofp10_match(rule, &ofm->match);
3401 ofm->command = htons(command);
3406 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
3407 uint16_t idle_timeout, size_t actions_len)
3409 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
3410 struct ofp_flow_mod *ofm = out->data;
3411 ofm->idle_timeout = htons(idle_timeout);
3412 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
3413 ofm->buffer_id = htonl(buffer_id);
3418 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
3419 const struct ofpbuf *payload, int max_send_len)
3421 struct ofp_packet_in *opi;
3425 send_len = MIN(max_send_len, payload->size);
3426 buf = ofpbuf_new(sizeof *opi + send_len);
3427 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
3428 OFPT_PACKET_IN, 0, buf);
3429 opi->buffer_id = htonl(buffer_id);
3430 opi->total_len = htons(payload->size);
3431 opi->in_port = htons(in_port);
3432 opi->reason = reason;
3433 ofpbuf_put(buf, payload->data, send_len);
3434 update_openflow_length(buf);
3439 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3441 make_echo_request(void)
3443 struct ofp_header *rq;
3444 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
3445 rq = ofpbuf_put_uninit(out, sizeof *rq);
3446 rq->version = OFP10_VERSION;
3447 rq->type = OFPT_ECHO_REQUEST;
3448 rq->length = htons(sizeof *rq);
3453 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3454 * OFPT_ECHO_REQUEST message in 'rq'. */
3456 make_echo_reply(const struct ofp_header *rq)
3458 size_t size = ntohs(rq->length);
3459 struct ofpbuf *out = ofpbuf_new(size);
3460 struct ofp_header *reply = ofpbuf_put(out, rq, size);
3461 reply->type = OFPT_ECHO_REPLY;
3466 ofputil_encode_barrier_request(void)
3470 make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
3475 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3477 switch (flags & OFPC_FRAG_MASK) {
3478 case OFPC_FRAG_NORMAL: return "normal";
3479 case OFPC_FRAG_DROP: return "drop";
3480 case OFPC_FRAG_REASM: return "reassemble";
3481 case OFPC_FRAG_NX_MATCH: return "nx-match";
3488 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3490 if (!strcasecmp(s, "normal")) {
3491 *flags = OFPC_FRAG_NORMAL;
3492 } else if (!strcasecmp(s, "drop")) {
3493 *flags = OFPC_FRAG_DROP;
3494 } else if (!strcasecmp(s, "reassemble")) {
3495 *flags = OFPC_FRAG_REASM;
3496 } else if (!strcasecmp(s, "nx-match")) {
3497 *flags = OFPC_FRAG_NX_MATCH;
3504 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3505 * port number and stores the latter in '*ofp10_port', for the purpose of
3506 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3507 * otherwise an OFPERR_* number.
3509 * See the definition of OFP11_MAX for an explanation of the mapping. */
3511 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3513 uint32_t ofp11_port_h = ntohl(ofp11_port);
3515 if (ofp11_port_h < OFPP_MAX) {
3516 *ofp10_port = ofp11_port_h;
3518 } else if (ofp11_port_h >= OFPP11_MAX) {
3519 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3522 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3523 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3524 ofp11_port_h, OFPP_MAX - 1,
3525 (uint32_t) OFPP11_MAX, UINT32_MAX);
3526 return OFPERR_OFPBAC_BAD_OUT_PORT;
3530 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3531 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3533 * See the definition of OFP11_MAX for an explanation of the mapping. */
3535 ofputil_port_to_ofp11(uint16_t ofp10_port)
3537 return htonl(ofp10_port < OFPP_MAX
3539 : ofp10_port + OFPP11_OFFSET);
3542 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3543 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3544 * 'port' is valid, otherwise an OpenFlow return code. */
3546 ofputil_check_output_port(uint16_t port, int max_ports)
3554 case OFPP_CONTROLLER:
3560 if (port < max_ports) {
3563 return OFPERR_OFPBAC_BAD_OUT_PORT;
3567 #define OFPUTIL_NAMED_PORTS \
3568 OFPUTIL_NAMED_PORT(IN_PORT) \
3569 OFPUTIL_NAMED_PORT(TABLE) \
3570 OFPUTIL_NAMED_PORT(NORMAL) \
3571 OFPUTIL_NAMED_PORT(FLOOD) \
3572 OFPUTIL_NAMED_PORT(ALL) \
3573 OFPUTIL_NAMED_PORT(CONTROLLER) \
3574 OFPUTIL_NAMED_PORT(LOCAL) \
3575 OFPUTIL_NAMED_PORT(NONE)
3577 /* Checks whether 's' is the string representation of an OpenFlow port number,
3578 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3579 * number in '*port' and returns true. Otherwise, returns false. */
3581 ofputil_port_from_string(const char *name, uint16_t *port)
3587 static const struct pair pairs[] = {
3588 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3590 #undef OFPUTIL_NAMED_PORT
3592 static const int n_pairs = ARRAY_SIZE(pairs);
3595 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3600 for (i = 0; i < n_pairs; i++) {
3601 if (!strcasecmp(name, pairs[i].name)) {
3602 *port = pairs[i].value;
3609 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3610 * Most ports' string representation is just the port number, but for special
3611 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3613 ofputil_format_port(uint16_t port, struct ds *s)
3618 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3620 #undef OFPUTIL_NAMED_PORT
3623 ds_put_format(s, "%"PRIu16, port);
3626 ds_put_cstr(s, name);
3629 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3630 * 'ofp_version', tries to pull the first element from the array. If
3631 * successful, initializes '*pp' with an abstract representation of the
3632 * port and returns 0. If no ports remain to be decoded, returns EOF.
3633 * On an error, returns a positive OFPERR_* value. */
3635 ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
3636 struct ofputil_phy_port *pp)
3638 if (ofp_version == OFP10_VERSION) {
3639 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3640 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3642 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3643 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3647 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3648 * 'ofp_version', returns the number of elements. */
3649 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3651 return b->size / ofputil_get_phy_port_size(ofp_version);
3655 check_resubmit_table(const struct nx_action_resubmit *nar)
3657 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
3658 return OFPERR_OFPBAC_BAD_ARGUMENT;
3664 check_output_reg(const struct nx_action_output_reg *naor,
3665 const struct flow *flow)
3667 struct mf_subfield src;
3670 for (i = 0; i < sizeof naor->zero; i++) {
3671 if (naor->zero[i]) {
3672 return OFPERR_OFPBAC_BAD_ARGUMENT;
3676 nxm_decode(&src, naor->src, naor->ofs_nbits);
3677 return mf_check_src(&src, flow);
3681 validate_actions(const union ofp_action *actions, size_t n_actions,
3682 const struct flow *flow, int max_ports)
3684 const union ofp_action *a;
3687 OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
3692 code = ofputil_decode_action(a);
3695 VLOG_WARN_RL(&bad_ofmsg_rl,
3696 "action decoding error at offset %td (%s)",
3697 (a - actions) * sizeof *a, ofperr_get_name(error));
3703 switch ((enum ofputil_action_code) code) {
3704 case OFPUTIL_OFPAT10_OUTPUT:
3705 error = ofputil_check_output_port(ntohs(a->output.port),
3709 case OFPUTIL_OFPAT10_SET_VLAN_VID:
3710 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
3711 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3715 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
3716 if (a->vlan_pcp.vlan_pcp & ~7) {
3717 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3721 case OFPUTIL_OFPAT10_ENQUEUE:
3722 port = ntohs(((const struct ofp_action_enqueue *) a)->port);
3723 if (port >= max_ports && port != OFPP_IN_PORT
3724 && port != OFPP_LOCAL) {
3725 error = OFPERR_OFPBAC_BAD_OUT_PORT;
3729 case OFPUTIL_NXAST_REG_MOVE:
3730 error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
3734 case OFPUTIL_NXAST_REG_LOAD:
3735 error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
3739 case OFPUTIL_NXAST_MULTIPATH:
3740 error = multipath_check((const struct nx_action_multipath *) a,
3744 case OFPUTIL_NXAST_AUTOPATH:
3745 error = autopath_check((const struct nx_action_autopath *) a,
3749 case OFPUTIL_NXAST_BUNDLE:
3750 case OFPUTIL_NXAST_BUNDLE_LOAD:
3751 error = bundle_check((const struct nx_action_bundle *) a,
3755 case OFPUTIL_NXAST_OUTPUT_REG:
3756 error = check_output_reg((const struct nx_action_output_reg *) a,
3760 case OFPUTIL_NXAST_RESUBMIT_TABLE:
3761 error = check_resubmit_table(
3762 (const struct nx_action_resubmit *) a);
3765 case OFPUTIL_NXAST_LEARN:
3766 error = learn_check((const struct nx_action_learn *) a, flow);
3769 case OFPUTIL_NXAST_CONTROLLER:
3770 if (((const struct nx_action_controller *) a)->zero) {
3771 error = OFPERR_NXBAC_MUST_BE_ZERO;
3775 case OFPUTIL_OFPAT10_STRIP_VLAN:
3776 case OFPUTIL_OFPAT10_SET_NW_SRC:
3777 case OFPUTIL_OFPAT10_SET_NW_DST:
3778 case OFPUTIL_OFPAT10_SET_NW_TOS:
3779 case OFPUTIL_OFPAT10_SET_TP_SRC:
3780 case OFPUTIL_OFPAT10_SET_TP_DST:
3781 case OFPUTIL_OFPAT10_SET_DL_SRC:
3782 case OFPUTIL_OFPAT10_SET_DL_DST:
3783 case OFPUTIL_NXAST_RESUBMIT:
3784 case OFPUTIL_NXAST_SET_TUNNEL:
3785 case OFPUTIL_NXAST_SET_QUEUE:
3786 case OFPUTIL_NXAST_POP_QUEUE:
3787 case OFPUTIL_NXAST_NOTE:
3788 case OFPUTIL_NXAST_SET_TUNNEL64:
3789 case OFPUTIL_NXAST_EXIT:
3790 case OFPUTIL_NXAST_DEC_TTL:
3791 case OFPUTIL_NXAST_FIN_TIMEOUT:
3796 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
3797 (a - actions) * sizeof *a, ofperr_get_name(error));
3802 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
3803 (n_actions - left) * sizeof *a);
3804 return OFPERR_OFPBAC_BAD_LEN;
3809 struct ofputil_action {
3811 unsigned int min_len;
3812 unsigned int max_len;
3815 static const struct ofputil_action action_bad_type
3816 = { -OFPERR_OFPBAC_BAD_TYPE, 0, UINT_MAX };
3817 static const struct ofputil_action action_bad_len
3818 = { -OFPERR_OFPBAC_BAD_LEN, 0, UINT_MAX };
3819 static const struct ofputil_action action_bad_vendor
3820 = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX };
3822 static const struct ofputil_action *
3823 ofputil_decode_ofpat_action(const union ofp_action *a)
3825 enum ofp10_action_type type = ntohs(a->type);
3828 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3830 static const struct ofputil_action action = { \
3832 sizeof(struct STRUCT), \
3833 sizeof(struct STRUCT) \
3837 #include "ofp-util.def"
3839 case OFPAT10_VENDOR:
3841 return &action_bad_type;
3845 static const struct ofputil_action *
3846 ofputil_decode_nxast_action(const union ofp_action *a)
3848 const struct nx_action_header *nah = (const struct nx_action_header *) a;
3849 enum nx_action_subtype subtype = ntohs(nah->subtype);
3852 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3854 static const struct ofputil_action action = { \
3856 sizeof(struct STRUCT), \
3857 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT) \
3861 #include "ofp-util.def"
3863 case NXAST_SNAT__OBSOLETE:
3864 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
3866 return &action_bad_type;
3870 /* Parses 'a' to determine its type. Returns a nonnegative OFPUTIL_OFPAT10_* or
3871 * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error
3874 * The caller must have already verified that 'a''s length is correct (that is,
3875 * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
3876 * longer than the amount of space allocated to 'a').
3878 * This function verifies that 'a''s length is correct for the type of action
3879 * that it represents. */
3881 ofputil_decode_action(const union ofp_action *a)
3883 const struct ofputil_action *action;
3884 uint16_t len = ntohs(a->header.len);
3886 if (a->type != htons(OFPAT10_VENDOR)) {
3887 action = ofputil_decode_ofpat_action(a);
3889 switch (ntohl(a->vendor.vendor)) {
3891 if (len < sizeof(struct nx_action_header)) {
3892 return -OFPERR_OFPBAC_BAD_LEN;
3894 action = ofputil_decode_nxast_action(a);
3897 action = &action_bad_vendor;
3902 return (len >= action->min_len && len <= action->max_len
3904 : -OFPERR_OFPBAC_BAD_LEN);
3907 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT10_* or OFPUTIL_NXAST_*
3908 * constant. The caller must have already validated that 'a' is a valid action
3909 * understood by Open vSwitch (e.g. by a previous successful call to
3910 * ofputil_decode_action()). */
3911 enum ofputil_action_code
3912 ofputil_decode_action_unsafe(const union ofp_action *a)
3914 const struct ofputil_action *action;
3916 if (a->type != htons(OFPAT10_VENDOR)) {
3917 action = ofputil_decode_ofpat_action(a);
3919 action = ofputil_decode_nxast_action(a);
3922 return action->code;
3925 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3926 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3927 * 'name' is not the name of any action.
3929 * ofp-util.def lists the mapping from names to action. */
3931 ofputil_action_code_from_name(const char *name)
3933 static const char *names[OFPUTIL_N_ACTIONS] = {
3934 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3935 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3936 #include "ofp-util.def"
3941 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3942 if (*p && !strcasecmp(name, *p)) {
3949 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3950 * action. Initializes the parts of 'action' that identify it as having type
3951 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3952 * have variable length, the length used and cleared is that of struct
3955 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3958 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3959 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3960 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3961 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3962 #include "ofp-util.def"
3967 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3969 ofputil_init_##ENUM(struct STRUCT *s) \
3971 memset(s, 0, sizeof *s); \
3972 s->type = htons(ENUM); \
3973 s->len = htons(sizeof *s); \
3977 ofputil_put_##ENUM(struct ofpbuf *buf) \
3979 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3980 ofputil_init_##ENUM(s); \
3983 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3985 ofputil_init_##ENUM(struct STRUCT *s) \
3987 memset(s, 0, sizeof *s); \
3988 s->type = htons(OFPAT10_VENDOR); \
3989 s->len = htons(sizeof *s); \
3990 s->vendor = htonl(NX_VENDOR_ID); \
3991 s->subtype = htons(ENUM); \
3995 ofputil_put_##ENUM(struct ofpbuf *buf) \
3997 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3998 ofputil_init_##ENUM(s); \
4001 #include "ofp-util.def"
4003 /* Returns true if 'action' outputs to 'port', false otherwise. */
4005 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
4007 switch (ofputil_decode_action(action)) {
4008 case OFPUTIL_OFPAT10_OUTPUT:
4009 return action->output.port == port;
4010 case OFPUTIL_OFPAT10_ENQUEUE:
4011 return ((const struct ofp_action_enqueue *) action)->port == port;
4012 case OFPUTIL_NXAST_CONTROLLER:
4013 return port == htons(OFPP_CONTROLLER);
4019 /* "Normalizes" the wildcards in 'rule'. That means:
4021 * 1. If the type of level N is known, then only the valid fields for that
4022 * level may be specified. For example, ARP does not have a TOS field,
4023 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
4024 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4025 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
4028 * 2. If the type of level N is not known (or not understood by Open
4029 * vSwitch), then no fields at all for that level may be specified. For
4030 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4031 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
4035 ofputil_normalize_rule(struct cls_rule *rule)
4038 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4039 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4040 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4041 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4042 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4043 MAY_ARP_THA = 1 << 5, /* arp_tha */
4044 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4045 MAY_ND_TARGET = 1 << 7 /* nd_target */
4048 struct flow_wildcards wc;
4050 /* Figure out what fields may be matched. */
4051 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
4052 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4053 if (rule->flow.nw_proto == IPPROTO_TCP ||
4054 rule->flow.nw_proto == IPPROTO_UDP ||
4055 rule->flow.nw_proto == IPPROTO_ICMP) {
4056 may_match |= MAY_TP_ADDR;
4058 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4059 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4060 if (rule->flow.nw_proto == IPPROTO_TCP ||
4061 rule->flow.nw_proto == IPPROTO_UDP) {
4062 may_match |= MAY_TP_ADDR;
4063 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
4064 may_match |= MAY_TP_ADDR;
4065 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4066 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4067 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4068 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4071 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
4072 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4077 /* Clear the fields that may not be matched. */
4079 if (!(may_match & MAY_NW_ADDR)) {
4080 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
4082 if (!(may_match & MAY_TP_ADDR)) {
4083 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
4085 if (!(may_match & MAY_NW_PROTO)) {
4086 wc.wildcards |= FWW_NW_PROTO;
4088 if (!(may_match & MAY_IPVx)) {
4089 wc.wildcards |= FWW_NW_DSCP;
4090 wc.wildcards |= FWW_NW_ECN;
4091 wc.wildcards |= FWW_NW_TTL;
4093 if (!(may_match & MAY_ARP_SHA)) {
4094 wc.wildcards |= FWW_ARP_SHA;
4096 if (!(may_match & MAY_ARP_THA)) {
4097 wc.wildcards |= FWW_ARP_THA;
4099 if (!(may_match & MAY_IPV6)) {
4100 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
4101 wc.wildcards |= FWW_IPV6_LABEL;
4103 if (!(may_match & MAY_ND_TARGET)) {
4104 wc.nd_target_mask = in6addr_any;
4107 /* Log any changes. */
4108 if (!flow_wildcards_equal(&wc, &rule->wc)) {
4109 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
4110 char *pre = log ? cls_rule_to_string(rule) : NULL;
4113 cls_rule_zero_wildcarded_fields(rule);
4116 char *post = cls_rule_to_string(rule);
4117 VLOG_INFO("normalization changed ofp_match, details:");
4118 VLOG_INFO(" pre: %s", pre);
4119 VLOG_INFO("post: %s", post);
4126 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
4127 * successful, otherwise an OpenFlow error.
4129 * If successful, the first action is stored in '*actionsp' and the number of
4130 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
4131 * are stored, respectively.
4133 * This function does not check that the actions are valid (the caller should
4134 * do so, with validate_actions()). The caller is also responsible for making
4135 * sure that 'b->data' is initially aligned appropriately for "union
4138 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
4139 union ofp_action **actionsp, size_t *n_actionsp)
4141 if (actions_len % OFP_ACTION_ALIGN != 0) {
4142 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
4143 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
4147 *actionsp = ofpbuf_try_pull(b, actions_len);
4148 if (*actionsp == NULL) {
4149 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
4150 "exceeds remaining message length (%zu)",
4151 actions_len, b->size);
4155 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
4161 return OFPERR_OFPBRC_BAD_LEN;
4165 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
4166 const union ofp_action *b, size_t n_b)
4168 return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
4172 ofputil_actions_clone(const union ofp_action *actions, size_t n)
4174 return n ? xmemdup(actions, n * sizeof *actions) : NULL;
4177 /* Parses a key or a key-value pair from '*stringp'.
4179 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4180 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4181 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4182 * are substrings of '*stringp' created by replacing some of its bytes by null
4183 * terminators. Returns true.
4185 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4186 * NULL and returns false. */
4188 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4190 char *pos, *key, *value;
4194 pos += strspn(pos, ", \t\r\n");
4196 *keyp = *valuep = NULL;
4201 key_len = strcspn(pos, ":=(, \t\r\n");
4202 if (key[key_len] == ':' || key[key_len] == '=') {
4203 /* The value can be separated by a colon. */
4206 value = key + key_len + 1;
4207 value_len = strcspn(value, ", \t\r\n");
4208 pos = value + value_len + (value[value_len] != '\0');
4209 value[value_len] = '\0';
4210 } else if (key[key_len] == '(') {
4211 /* The value can be surrounded by balanced parentheses. The outermost
4212 * set of parentheses is removed. */
4216 value = key + key_len + 1;
4217 for (value_len = 0; level > 0; value_len++) {
4218 switch (value[value_len]) {
4232 value[value_len - 1] = '\0';
4233 pos = value + value_len;
4235 /* There might be no value at all. */
4236 value = key + key_len; /* Will become the empty string below. */
4237 pos = key + key_len + (key[key_len] != '\0');
4239 key[key_len] = '\0';