2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-print.h"
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
41 #include "unaligned.h"
42 #include "type-props.h"
45 VLOG_DEFINE_THIS_MODULE(ofp_util);
47 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
48 * in the peer and so there's not much point in showing a lot of them. */
49 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
51 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
52 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
55 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
56 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
57 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
58 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
61 ofputil_wcbits_to_netmask(int wcbits)
64 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
67 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
68 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
69 * between 0 and 32 inclusive.
71 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
72 * still be in the valid range but isn't otherwise meaningful. */
74 ofputil_netmask_to_wcbits(ovs_be32 netmask)
76 return 32 - ip_count_cidr_bits(netmask);
79 /* A list of the FWW_* and OFPFW10_ bits that have the same value, meaning, and
81 #define WC_INVARIANT_LIST \
82 WC_INVARIANT_BIT(IN_PORT) \
83 WC_INVARIANT_BIT(DL_TYPE) \
84 WC_INVARIANT_BIT(NW_PROTO)
86 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
87 * actually have the same names and values. */
88 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW10_##NAME);
90 #undef WC_INVARIANT_BIT
92 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
94 static const flow_wildcards_t WC_INVARIANTS = 0
95 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
97 #undef WC_INVARIANT_BIT
100 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
101 * flow_wildcards in 'wc' for use in struct cls_rule. It is the caller's
102 * responsibility to handle the special case where the flow match's dl_vlan is
103 * set to OFP_VLAN_NONE. */
105 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *wc)
107 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 12);
109 /* Initialize most of rule->wc. */
110 flow_wildcards_init_catchall(wc);
111 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
113 /* Wildcard fields that aren't defined by ofp10_match or tun_id. */
114 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
117 if (ofpfw & OFPFW10_NW_TOS) {
118 /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
119 * the enum than we can use. */
120 wc->wildcards |= FWW_NW_DSCP;
123 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_SRC_SHIFT);
124 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW10_NW_DST_SHIFT);
126 if (!(ofpfw & OFPFW10_TP_SRC)) {
127 wc->tp_src_mask = htons(UINT16_MAX);
129 if (!(ofpfw & OFPFW10_TP_DST)) {
130 wc->tp_dst_mask = htons(UINT16_MAX);
133 if (!(ofpfw & OFPFW10_DL_SRC)) {
134 memset(wc->dl_src_mask, 0xff, ETH_ADDR_LEN);
136 if (!(ofpfw & OFPFW10_DL_DST)) {
137 memset(wc->dl_dst_mask, 0xff, ETH_ADDR_LEN);
141 if (!(ofpfw & OFPFW10_DL_VLAN_PCP)) {
142 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
144 if (!(ofpfw & OFPFW10_DL_VLAN)) {
145 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
149 /* Converts the ofp10_match in 'match' into a cls_rule in 'rule', with the
150 * given 'priority'. */
152 ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *match,
153 unsigned int priority, struct cls_rule *rule)
155 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW10_ALL;
157 /* Initialize rule->priority, rule->wc. */
158 rule->priority = !ofpfw ? UINT16_MAX : priority;
159 ofputil_wildcard_from_ofpfw10(ofpfw, &rule->wc);
161 /* Initialize most of rule->flow. */
162 rule->flow.nw_src = match->nw_src;
163 rule->flow.nw_dst = match->nw_dst;
164 rule->flow.in_port = ntohs(match->in_port);
165 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
166 rule->flow.tp_src = match->tp_src;
167 rule->flow.tp_dst = match->tp_dst;
168 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
169 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
170 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
171 rule->flow.nw_proto = match->nw_proto;
173 /* Translate VLANs. */
174 if (!(ofpfw & OFPFW10_DL_VLAN) &&
175 match->dl_vlan == htons(OFP10_VLAN_NONE)) {
176 /* Match only packets without 802.1Q header.
178 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
180 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
181 * because we can't have a specific PCP without an 802.1Q header.
182 * However, older versions of OVS treated this as matching packets
183 * withut an 802.1Q header, so we do here too. */
184 rule->flow.vlan_tci = htons(0);
185 rule->wc.vlan_tci_mask = htons(0xffff);
187 ovs_be16 vid, pcp, tci;
189 vid = match->dl_vlan & htons(VLAN_VID_MASK);
190 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
191 tci = vid | pcp | htons(VLAN_CFI);
192 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
196 cls_rule_zero_wildcarded_fields(rule);
199 /* Convert 'rule' into the OpenFlow 1.0 match structure 'match'. */
201 ofputil_cls_rule_to_ofp10_match(const struct cls_rule *rule,
202 struct ofp10_match *match)
204 const struct flow_wildcards *wc = &rule->wc;
207 /* Figure out most OpenFlow wildcards. */
208 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
209 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_src_mask)
210 << OFPFW10_NW_SRC_SHIFT);
211 ofpfw |= (ofputil_netmask_to_wcbits(wc->nw_dst_mask)
212 << OFPFW10_NW_DST_SHIFT);
213 if (wc->wildcards & FWW_NW_DSCP) {
214 ofpfw |= OFPFW10_NW_TOS;
216 if (!wc->tp_src_mask) {
217 ofpfw |= OFPFW10_TP_SRC;
219 if (!wc->tp_dst_mask) {
220 ofpfw |= OFPFW10_TP_DST;
222 if (eth_addr_is_zero(wc->dl_src_mask)) {
223 ofpfw |= OFPFW10_DL_SRC;
225 if (eth_addr_is_zero(wc->dl_dst_mask)) {
226 ofpfw |= OFPFW10_DL_DST;
229 /* Translate VLANs. */
230 match->dl_vlan = htons(0);
231 match->dl_vlan_pcp = 0;
232 if (rule->wc.vlan_tci_mask == htons(0)) {
233 ofpfw |= OFPFW10_DL_VLAN | OFPFW10_DL_VLAN_PCP;
234 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
235 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
236 match->dl_vlan = htons(OFP10_VLAN_NONE);
238 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
239 ofpfw |= OFPFW10_DL_VLAN;
241 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
244 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
245 ofpfw |= OFPFW10_DL_VLAN_PCP;
247 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
251 /* Compose most of the match structure. */
252 match->wildcards = htonl(ofpfw);
253 match->in_port = htons(rule->flow.in_port);
254 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
255 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
256 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
257 match->nw_src = rule->flow.nw_src;
258 match->nw_dst = rule->flow.nw_dst;
259 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
260 match->nw_proto = rule->flow.nw_proto;
261 match->tp_src = rule->flow.tp_src;
262 match->tp_dst = rule->flow.tp_dst;
263 memset(match->pad1, '\0', sizeof match->pad1);
264 memset(match->pad2, '\0', sizeof match->pad2);
267 /* Converts the ofp11_match in 'match' into a cls_rule in 'rule', with the
268 * given 'priority'. Returns 0 if successful, otherwise an OFPERR_* value. */
270 ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *match,
271 unsigned int priority,
272 struct cls_rule *rule)
274 uint16_t wc = ntohl(match->wildcards);
275 uint8_t dl_src_mask[ETH_ADDR_LEN];
276 uint8_t dl_dst_mask[ETH_ADDR_LEN];
280 cls_rule_init_catchall(rule, priority);
282 if (!(wc & OFPFW11_IN_PORT)) {
286 error = ofputil_port_from_ofp11(match->in_port, &ofp_port);
288 return OFPERR_OFPBMC_BAD_VALUE;
290 cls_rule_set_in_port(rule, ofp_port);
293 for (i = 0; i < ETH_ADDR_LEN; i++) {
294 dl_src_mask[i] = ~match->dl_src_mask[i];
296 cls_rule_set_dl_src_masked(rule, match->dl_src, dl_src_mask);
298 for (i = 0; i < ETH_ADDR_LEN; i++) {
299 dl_dst_mask[i] = ~match->dl_dst_mask[i];
301 cls_rule_set_dl_dst_masked(rule, match->dl_dst, dl_dst_mask);
303 if (!(wc & OFPFW11_DL_VLAN)) {
304 if (match->dl_vlan == htons(OFPVID11_NONE)) {
305 /* Match only packets without a VLAN tag. */
306 rule->flow.vlan_tci = htons(0);
307 rule->wc.vlan_tci_mask = htons(UINT16_MAX);
309 if (match->dl_vlan == htons(OFPVID11_ANY)) {
310 /* Match any packet with a VLAN tag regardless of VID. */
311 rule->flow.vlan_tci = htons(VLAN_CFI);
312 rule->wc.vlan_tci_mask = htons(VLAN_CFI);
313 } else if (ntohs(match->dl_vlan) < 4096) {
314 /* Match only packets with the specified VLAN VID. */
315 rule->flow.vlan_tci = htons(VLAN_CFI) | match->dl_vlan;
316 rule->wc.vlan_tci_mask = htons(VLAN_CFI | VLAN_VID_MASK);
319 return OFPERR_OFPBMC_BAD_VALUE;
322 if (!(wc & OFPFW11_DL_VLAN_PCP)) {
323 if (match->dl_vlan_pcp <= 7) {
324 rule->flow.vlan_tci |= htons(match->dl_vlan_pcp
326 rule->wc.vlan_tci_mask |= htons(VLAN_PCP_MASK);
329 return OFPERR_OFPBMC_BAD_VALUE;
335 if (!(wc & OFPFW11_DL_TYPE)) {
336 cls_rule_set_dl_type(rule,
337 ofputil_dl_type_from_openflow(match->dl_type));
340 ipv4 = rule->flow.dl_type == htons(ETH_TYPE_IP);
341 arp = rule->flow.dl_type == htons(ETH_TYPE_ARP);
343 if (ipv4 && !(wc & OFPFW11_NW_TOS)) {
344 if (match->nw_tos & ~IP_DSCP_MASK) {
346 return OFPERR_OFPBMC_BAD_VALUE;
349 cls_rule_set_nw_dscp(rule, match->nw_tos);
353 if (!(wc & OFPFW11_NW_PROTO)) {
354 cls_rule_set_nw_proto(rule, match->nw_proto);
356 cls_rule_set_nw_src_masked(rule, match->nw_src, ~match->nw_src_mask);
357 cls_rule_set_nw_dst_masked(rule, match->nw_dst, ~match->nw_dst_mask);
360 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
361 if (ipv4 && (wc & OFPFW11_TP_ALL) != OFPFW11_TP_ALL) {
362 switch (rule->flow.nw_proto) {
364 /* "A.2.3 Flow Match Structures" in OF1.1 says:
366 * The tp_src and tp_dst fields will be ignored unless the
367 * network protocol specified is as TCP, UDP or SCTP.
369 * but I'm pretty sure we should support ICMP too, otherwise
370 * that's a regression from OF1.0. */
371 if (!(wc & OFPFW11_TP_SRC)) {
372 uint16_t icmp_type = ntohs(match->tp_src);
373 if (icmp_type < 0x100) {
374 cls_rule_set_icmp_type(rule, icmp_type);
376 return OFPERR_OFPBMC_BAD_FIELD;
379 if (!(wc & OFPFW11_TP_DST)) {
380 uint16_t icmp_code = ntohs(match->tp_dst);
381 if (icmp_code < 0x100) {
382 cls_rule_set_icmp_code(rule, icmp_code);
384 return OFPERR_OFPBMC_BAD_FIELD;
391 if (!(wc & (OFPFW11_TP_SRC))) {
392 cls_rule_set_tp_src(rule, match->tp_src);
394 if (!(wc & (OFPFW11_TP_DST))) {
395 cls_rule_set_tp_dst(rule, match->tp_dst);
400 /* We don't support SCTP and it seems that we should tell the
401 * controller, since OF1.1 implementations are supposed to. */
402 return OFPERR_OFPBMC_BAD_FIELD;
405 /* OF1.1 says explicitly to ignore this. */
410 if (rule->flow.dl_type == htons(ETH_TYPE_MPLS) ||
411 rule->flow.dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
412 enum { OFPFW11_MPLS_ALL = OFPFW11_MPLS_LABEL | OFPFW11_MPLS_TC };
414 if ((wc & OFPFW11_MPLS_ALL) != OFPFW11_MPLS_ALL) {
415 /* MPLS not supported. */
416 return OFPERR_OFPBMC_BAD_TAG;
420 if (match->metadata_mask != htonll(UINT64_MAX)) {
421 cls_rule_set_metadata_masked(rule, match->metadata,
422 ~match->metadata_mask);
428 /* Convert 'rule' into the OpenFlow 1.1 match structure 'match'. */
430 ofputil_cls_rule_to_ofp11_match(const struct cls_rule *rule,
431 struct ofp11_match *match)
436 memset(match, 0, sizeof *match);
437 match->omh.type = htons(OFPMT_STANDARD);
438 match->omh.length = htons(OFPMT11_STANDARD_LENGTH);
440 if (rule->wc.wildcards & FWW_IN_PORT) {
441 wc |= OFPFW11_IN_PORT;
443 match->in_port = ofputil_port_to_ofp11(rule->flow.in_port);
447 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
448 for (i = 0; i < ETH_ADDR_LEN; i++) {
449 match->dl_src_mask[i] = ~rule->wc.dl_src_mask[i];
452 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
453 for (i = 0; i < ETH_ADDR_LEN; i++) {
454 match->dl_dst_mask[i] = ~rule->wc.dl_dst_mask[i];
457 if (rule->wc.vlan_tci_mask == htons(0)) {
458 wc |= OFPFW11_DL_VLAN | OFPFW11_DL_VLAN_PCP;
459 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
460 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
461 match->dl_vlan = htons(OFPVID11_NONE);
462 wc |= OFPFW11_DL_VLAN_PCP;
464 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
465 match->dl_vlan = htons(OFPVID11_ANY);
467 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
470 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
471 wc |= OFPFW11_DL_VLAN_PCP;
473 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
477 if (rule->wc.wildcards & FWW_DL_TYPE) {
478 wc |= OFPFW11_DL_TYPE;
480 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
483 if (rule->wc.wildcards & FWW_NW_DSCP) {
484 wc |= OFPFW11_NW_TOS;
486 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
489 if (rule->wc.wildcards & FWW_NW_PROTO) {
490 wc |= OFPFW11_NW_PROTO;
492 match->nw_proto = rule->flow.nw_proto;
495 match->nw_src = rule->flow.nw_src;
496 match->nw_src_mask = ~rule->wc.nw_src_mask;
497 match->nw_dst = rule->flow.nw_dst;
498 match->nw_dst_mask = ~rule->wc.nw_dst_mask;
500 if (!rule->wc.tp_src_mask) {
501 wc |= OFPFW11_TP_SRC;
503 match->tp_src = rule->flow.tp_src;
506 if (!rule->wc.tp_dst_mask) {
507 wc |= OFPFW11_TP_DST;
509 match->tp_dst = rule->flow.tp_dst;
512 /* MPLS not supported. */
513 wc |= OFPFW11_MPLS_LABEL;
514 wc |= OFPFW11_MPLS_TC;
516 match->metadata = rule->flow.metadata;
517 match->metadata_mask = ~rule->wc.metadata_mask;
519 match->wildcards = htonl(wc);
522 /* Given a 'dl_type' value in the format used in struct flow, returns the
523 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
526 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
528 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
529 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
533 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
534 * structure, returns the corresponding 'dl_type' value for use in struct
537 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
539 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
540 ? htons(FLOW_DL_TYPE_NONE)
544 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
548 static uint32_t next_xid = 1;
549 return htonl(next_xid++);
552 /* Basic parsing of OpenFlow messages. */
554 struct ofputil_msg_type {
555 enum ofputil_msg_code code; /* OFPUTIL_*. */
556 uint8_t ofp_version; /* An OpenFlow version or 0 for "any". */
557 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
558 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
559 unsigned int min_size; /* Minimum total message size in bytes. */
560 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
561 * the message may exceed 'min_size' by an even multiple of this value. */
562 unsigned int extra_multiple;
565 /* Represents a malformed OpenFlow message. */
566 static const struct ofputil_msg_type ofputil_invalid_type = {
567 OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0
570 struct ofputil_msg_category {
571 const char *name; /* e.g. "OpenFlow message" */
572 const struct ofputil_msg_type *types;
574 enum ofperr missing_error; /* Error value for missing type. */
578 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
580 switch (type->extra_multiple) {
582 if (size != type->min_size) {
583 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
584 "length %u (expected length %u)",
585 type->name, size, type->min_size);
586 return OFPERR_OFPBRC_BAD_LEN;
591 if (size < type->min_size) {
592 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
593 "length %u (expected length at least %u bytes)",
594 type->name, size, type->min_size);
595 return OFPERR_OFPBRC_BAD_LEN;
600 if (size < type->min_size
601 || (size - type->min_size) % type->extra_multiple) {
602 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
603 "length %u (must be exactly %u bytes or longer "
604 "by an integer multiple of %u bytes)",
606 type->min_size, type->extra_multiple);
607 return OFPERR_OFPBRC_BAD_LEN;
614 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
615 uint8_t version, uint32_t value,
616 const struct ofputil_msg_type **typep)
618 const struct ofputil_msg_type *type;
620 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
621 if (type->value == value
622 && (!type->ofp_version || version == type->ofp_version)) {
628 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
630 return cat->missing_error;
634 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
635 const struct ofputil_msg_type **typep)
637 static const struct ofputil_msg_type nxt_messages[] = {
638 { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION,
639 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
640 sizeof(struct nx_role_request), 0 },
642 { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION,
643 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
644 sizeof(struct nx_role_request), 0 },
646 { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION,
647 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
648 sizeof(struct nx_set_flow_format), 0 },
650 { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION,
651 NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
652 sizeof(struct nx_set_packet_in_format), 0 },
654 { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION,
655 NXT_PACKET_IN, "NXT_PACKET_IN",
656 sizeof(struct nx_packet_in), 1 },
658 { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION,
659 NXT_FLOW_MOD, "NXT_FLOW_MOD",
660 sizeof(struct nx_flow_mod), 8 },
662 { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION,
663 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
664 sizeof(struct nx_flow_removed), 8 },
666 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION,
667 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
668 sizeof(struct nx_flow_mod_table_id), 0 },
670 { OFPUTIL_NXT_FLOW_AGE, OFP10_VERSION,
671 NXT_FLOW_AGE, "NXT_FLOW_AGE",
672 sizeof(struct nicira_header), 0 },
674 { OFPUTIL_NXT_SET_ASYNC_CONFIG, OFP10_VERSION,
675 NXT_SET_ASYNC_CONFIG, "NXT_SET_ASYNC_CONFIG",
676 sizeof(struct nx_async_config), 0 },
678 { OFPUTIL_NXT_SET_CONTROLLER_ID, OFP10_VERSION,
679 NXT_SET_CONTROLLER_ID, "NXT_SET_CONTROLLER_ID",
680 sizeof(struct nx_controller_id), 0 },
682 { OFPUTIL_NXT_FLOW_MONITOR_CANCEL, OFP10_VERSION,
683 NXT_FLOW_MONITOR_CANCEL, "NXT_FLOW_MONITOR_CANCEL",
684 sizeof(struct nx_flow_monitor_cancel), 0 },
686 { OFPUTIL_NXT_FLOW_MONITOR_PAUSED, OFP10_VERSION,
687 NXT_FLOW_MONITOR_PAUSED, "NXT_FLOW_MONITOR_PAUSED",
688 sizeof(struct nicira_header), 0 },
690 { OFPUTIL_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
691 NXT_FLOW_MONITOR_RESUMED, "NXT_FLOW_MONITOR_RESUMED",
692 sizeof(struct nicira_header), 0 },
695 static const struct ofputil_msg_category nxt_category = {
696 "Nicira extension message",
697 nxt_messages, ARRAY_SIZE(nxt_messages),
698 OFPERR_OFPBRC_BAD_SUBTYPE
701 const struct ofp_vendor_header *ovh;
702 const struct nicira_header *nh;
704 if (length < sizeof(struct ofp_vendor_header)) {
705 if (length == ntohs(oh->length)) {
706 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
708 return OFPERR_OFPBRC_BAD_LEN;
711 ovh = (const struct ofp_vendor_header *) oh;
712 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
713 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
714 "vendor %"PRIx32, ntohl(ovh->vendor));
715 return OFPERR_OFPBRC_BAD_VENDOR;
718 if (length < sizeof(struct nicira_header)) {
719 if (length == ntohs(oh->length)) {
720 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
721 "length %u (expected at least %zu)",
722 ntohs(ovh->header.length),
723 sizeof(struct nicira_header));
725 return OFPERR_OFPBRC_BAD_LEN;
728 nh = (const struct nicira_header *) oh;
729 return ofputil_lookup_openflow_message(&nxt_category, oh->version,
730 ntohl(nh->subtype), typep);
734 check_nxstats_msg(const struct ofp_header *oh, size_t length)
736 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
739 if (length < sizeof(struct ofp_vendor_stats_msg)) {
740 if (length == ntohs(oh->length)) {
741 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
743 return OFPERR_OFPBRC_BAD_LEN;
746 memcpy(&vendor, osm + 1, sizeof vendor);
747 if (vendor != htonl(NX_VENDOR_ID)) {
748 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
749 "unknown vendor %"PRIx32, ntohl(vendor));
750 return OFPERR_OFPBRC_BAD_VENDOR;
753 if (length < sizeof(struct nicira_stats_msg)) {
754 if (length == ntohs(osm->header.length)) {
755 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
757 return OFPERR_OFPBRC_BAD_LEN;
764 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
765 const struct ofputil_msg_type **typep)
767 static const struct ofputil_msg_type nxst_requests[] = {
768 { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION,
769 NXST_FLOW, "NXST_FLOW request",
770 sizeof(struct nx_flow_stats_request), 8 },
772 { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION,
773 NXST_AGGREGATE, "NXST_AGGREGATE request",
774 sizeof(struct nx_aggregate_stats_request), 8 },
776 { OFPUTIL_NXST_FLOW_MONITOR_REQUEST, OFP10_VERSION,
777 NXST_FLOW_MONITOR, "NXST_FLOW_MONITOR request",
778 sizeof(struct nicira_stats_msg), 8 },
781 static const struct ofputil_msg_category nxst_request_category = {
782 "Nicira extension statistics request",
783 nxst_requests, ARRAY_SIZE(nxst_requests),
784 OFPERR_OFPBRC_BAD_SUBTYPE
787 const struct nicira_stats_msg *nsm;
790 error = check_nxstats_msg(oh, length);
795 nsm = (struct nicira_stats_msg *) oh;
796 return ofputil_lookup_openflow_message(&nxst_request_category, oh->version,
797 ntohl(nsm->subtype), typep);
801 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
802 const struct ofputil_msg_type **typep)
804 static const struct ofputil_msg_type nxst_replies[] = {
805 { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION,
806 NXST_FLOW, "NXST_FLOW reply",
807 sizeof(struct nicira_stats_msg), 8 },
809 { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION,
810 NXST_AGGREGATE, "NXST_AGGREGATE reply",
811 sizeof(struct nx_aggregate_stats_reply), 0 },
813 { OFPUTIL_NXST_FLOW_MONITOR_REPLY, OFP10_VERSION,
814 NXST_FLOW_MONITOR, "NXST_FLOW_MONITOR reply",
815 sizeof(struct nicira_stats_msg), 8 },
818 static const struct ofputil_msg_category nxst_reply_category = {
819 "Nicira extension statistics reply",
820 nxst_replies, ARRAY_SIZE(nxst_replies),
821 OFPERR_OFPBRC_BAD_SUBTYPE
824 const struct nicira_stats_msg *nsm;
827 error = check_nxstats_msg(oh, length);
832 nsm = (struct nicira_stats_msg *) oh;
833 return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version,
834 ntohl(nsm->subtype), typep);
838 check_stats_msg(const struct ofp_header *oh, size_t length)
840 if (length < sizeof(struct ofp_stats_msg)) {
841 if (length == ntohs(oh->length)) {
842 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
844 return OFPERR_OFPBRC_BAD_LEN;
851 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
852 const struct ofputil_msg_type **typep)
854 static const struct ofputil_msg_type ofpst_requests[] = {
855 { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
856 OFPST_DESC, "OFPST_DESC request",
857 sizeof(struct ofp_stats_msg), 0 },
859 { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
860 OFPST_FLOW, "OFPST_FLOW request",
861 sizeof(struct ofp_flow_stats_request), 0 },
863 { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
864 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
865 sizeof(struct ofp_flow_stats_request), 0 },
867 { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
868 OFPST_TABLE, "OFPST_TABLE request",
869 sizeof(struct ofp_stats_msg), 0 },
871 { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
872 OFPST_PORT, "OFPST_PORT request",
873 sizeof(struct ofp_port_stats_request), 0 },
875 { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
876 OFPST_QUEUE, "OFPST_QUEUE request",
877 sizeof(struct ofp_queue_stats_request), 0 },
879 { OFPUTIL_OFPST_PORT_DESC_REQUEST, OFP10_VERSION,
880 OFPST_PORT_DESC, "OFPST_PORT_DESC request",
881 sizeof(struct ofp_stats_msg), 0 },
884 OFPST_VENDOR, "OFPST_VENDOR request",
885 sizeof(struct ofp_vendor_stats_msg), 1 },
888 static const struct ofputil_msg_category ofpst_request_category = {
889 "OpenFlow statistics",
890 ofpst_requests, ARRAY_SIZE(ofpst_requests),
891 OFPERR_OFPBRC_BAD_STAT
894 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
897 error = check_stats_msg(oh, length);
902 error = ofputil_lookup_openflow_message(&ofpst_request_category,
903 oh->version, ntohs(request->type),
905 if (!error && request->type == htons(OFPST_VENDOR)) {
906 error = ofputil_decode_nxst_request(oh, length, typep);
912 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
913 const struct ofputil_msg_type **typep)
915 static const struct ofputil_msg_type ofpst_replies[] = {
916 { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
917 OFPST_DESC, "OFPST_DESC reply",
918 sizeof(struct ofp_desc_stats), 0 },
920 { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
921 OFPST_FLOW, "OFPST_FLOW reply",
922 sizeof(struct ofp_stats_msg), 1 },
924 { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
925 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
926 sizeof(struct ofp_aggregate_stats_reply), 0 },
928 { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
929 OFPST_TABLE, "OFPST_TABLE reply",
930 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
932 { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION,
933 OFPST_PORT, "OFPST_PORT reply",
934 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
936 { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION,
937 OFPST_QUEUE, "OFPST_QUEUE reply",
938 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
940 { OFPUTIL_OFPST_PORT_DESC_REPLY, OFP10_VERSION,
941 OFPST_PORT_DESC, "OFPST_PORT_DESC reply",
942 sizeof(struct ofp_stats_msg), sizeof(struct ofp10_phy_port) },
945 OFPST_VENDOR, "OFPST_VENDOR reply",
946 sizeof(struct ofp_vendor_stats_msg), 1 },
949 static const struct ofputil_msg_category ofpst_reply_category = {
950 "OpenFlow statistics",
951 ofpst_replies, ARRAY_SIZE(ofpst_replies),
952 OFPERR_OFPBRC_BAD_STAT
955 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
958 error = check_stats_msg(oh, length);
963 error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version,
964 ntohs(reply->type), typep);
965 if (!error && reply->type == htons(OFPST_VENDOR)) {
966 error = ofputil_decode_nxst_reply(oh, length, typep);
972 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
973 const struct ofputil_msg_type **typep)
975 static const struct ofputil_msg_type ofpt_messages[] = {
976 { OFPUTIL_OFPT_HELLO, OFP10_VERSION,
977 OFPT_HELLO, "OFPT_HELLO",
978 sizeof(struct ofp_hello), 1 },
980 { OFPUTIL_OFPT_ERROR, 0,
981 OFPT_ERROR, "OFPT_ERROR",
982 sizeof(struct ofp_error_msg), 1 },
984 { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION,
985 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
986 sizeof(struct ofp_header), 1 },
988 { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION,
989 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
990 sizeof(struct ofp_header), 1 },
992 { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION,
993 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
994 sizeof(struct ofp_header), 0 },
996 { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION,
997 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
998 sizeof(struct ofp_switch_features), sizeof(struct ofp10_phy_port) },
999 { OFPUTIL_OFPT_FEATURES_REPLY, OFP11_VERSION,
1000 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
1001 sizeof(struct ofp_switch_features), sizeof(struct ofp11_port) },
1003 { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION,
1004 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
1005 sizeof(struct ofp_header), 0 },
1007 { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION,
1008 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
1009 sizeof(struct ofp_switch_config), 0 },
1011 { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION,
1012 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
1013 sizeof(struct ofp_switch_config), 0 },
1015 { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION,
1016 OFPT_PACKET_IN, "OFPT_PACKET_IN",
1017 offsetof(struct ofp_packet_in, data), 1 },
1019 { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION,
1020 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
1021 sizeof(struct ofp_flow_removed), 0 },
1023 { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION,
1024 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
1025 sizeof(struct ofp_port_status) + sizeof(struct ofp10_phy_port), 0 },
1026 { OFPUTIL_OFPT_PORT_STATUS, OFP11_VERSION,
1027 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
1028 sizeof(struct ofp_port_status) + sizeof(struct ofp11_port), 0 },
1030 { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
1031 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
1032 sizeof(struct ofp_packet_out), 1 },
1034 { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
1035 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
1036 sizeof(struct ofp_flow_mod), 1 },
1038 { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
1039 OFPT10_PORT_MOD, "OFPT_PORT_MOD",
1040 sizeof(struct ofp10_port_mod), 0 },
1041 { OFPUTIL_OFPT_PORT_MOD, OFP11_VERSION,
1042 OFPT11_PORT_MOD, "OFPT_PORT_MOD",
1043 sizeof(struct ofp11_port_mod), 0 },
1046 OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST",
1047 sizeof(struct ofp_stats_msg), 1 },
1050 OFPT10_STATS_REPLY, "OFPT_STATS_REPLY",
1051 sizeof(struct ofp_stats_msg), 1 },
1053 { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION,
1054 OFPT10_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
1055 sizeof(struct ofp_header), 0 },
1057 { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION,
1058 OFPT10_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
1059 sizeof(struct ofp_header), 0 },
1062 OFPT_VENDOR, "OFPT_VENDOR",
1063 sizeof(struct ofp_vendor_header), 1 },
1066 static const struct ofputil_msg_category ofpt_category = {
1068 ofpt_messages, ARRAY_SIZE(ofpt_messages),
1069 OFPERR_OFPBRC_BAD_TYPE
1074 error = ofputil_lookup_openflow_message(&ofpt_category, oh->version,
1077 switch ((oh->version << 8) | oh->type) {
1078 case (OFP10_VERSION << 8) | OFPT_VENDOR:
1079 case (OFP11_VERSION << 8) | OFPT_VENDOR:
1080 error = ofputil_decode_vendor(oh, length, typep);
1083 case (OFP10_VERSION << 8) | OFPT10_STATS_REQUEST:
1084 case (OFP11_VERSION << 8) | OFPT11_STATS_REQUEST:
1085 error = ofputil_decode_ofpst_request(oh, length, typep);
1088 case (OFP10_VERSION << 8) | OFPT10_STATS_REPLY:
1089 case (OFP11_VERSION << 8) | OFPT11_STATS_REPLY:
1090 error = ofputil_decode_ofpst_reply(oh, length, typep);
1099 /* Decodes the message type represented by 'oh'. Returns 0 if successful or an
1100 * OpenFlow error code on failure. Either way, stores in '*typep' a type
1101 * structure that can be inspected with the ofputil_msg_type_*() functions.
1103 * oh->length must indicate the correct length of the message (and must be at
1104 * least sizeof(struct ofp_header)).
1106 * Success indicates that 'oh' is at least as long as the minimum-length
1107 * message of its type. */
1109 ofputil_decode_msg_type(const struct ofp_header *oh,
1110 const struct ofputil_msg_type **typep)
1112 size_t length = ntohs(oh->length);
1115 error = ofputil_decode_msg_type__(oh, length, typep);
1117 error = ofputil_check_length(*typep, length);
1120 *typep = &ofputil_invalid_type;
1125 /* Decodes the message type represented by 'oh', of which only the first
1126 * 'length' bytes are available. Returns 0 if successful or an OpenFlow error
1127 * code on failure. Either way, stores in '*typep' a type structure that can
1128 * be inspected with the ofputil_msg_type_*() functions. */
1130 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
1131 const struct ofputil_msg_type **typep)
1135 error = (length >= sizeof *oh
1136 ? ofputil_decode_msg_type__(oh, length, typep)
1137 : OFPERR_OFPBRC_BAD_LEN);
1139 *typep = &ofputil_invalid_type;
1144 /* Returns an OFPUTIL_* message type code for 'type'. */
1145 enum ofputil_msg_code
1146 ofputil_msg_type_code(const struct ofputil_msg_type *type)
1153 struct proto_abbrev {
1154 enum ofputil_protocol protocol;
1158 /* Most users really don't care about some of the differences between
1159 * protocols. These abbreviations help with that. */
1160 static const struct proto_abbrev proto_abbrevs[] = {
1161 { OFPUTIL_P_ANY, "any" },
1162 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
1163 { OFPUTIL_P_NXM_ANY, "NXM" },
1165 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
1167 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
1171 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
1173 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
1174 * connection that has negotiated the given 'version'. 'version' should
1175 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
1176 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
1177 * outside the valid range. */
1178 enum ofputil_protocol
1179 ofputil_protocol_from_ofp_version(int version)
1182 case OFP10_VERSION: return OFPUTIL_P_OF10;
1187 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION or
1188 * OFP11_VERSION) that corresponds to 'protocol'. */
1190 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
1193 case OFPUTIL_P_OF10:
1194 case OFPUTIL_P_OF10_TID:
1196 case OFPUTIL_P_NXM_TID:
1197 return OFP10_VERSION;
1203 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
1206 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
1208 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
1211 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
1212 * extension turned on or off if 'enable' is true or false, respectively.
1214 * This extension is only useful for protocols whose "standard" version does
1215 * not allow specific tables to be modified. In particular, this is true of
1216 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
1217 * specifies a table ID and so there is no need for such an extension. When
1218 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
1219 * extension, this function just returns its 'protocol' argument unchanged
1220 * regardless of the value of 'enable'. */
1221 enum ofputil_protocol
1222 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
1225 case OFPUTIL_P_OF10:
1226 case OFPUTIL_P_OF10_TID:
1227 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
1230 case OFPUTIL_P_NXM_TID:
1231 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
1238 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
1239 * some extension to a standard protocol version, the return value is the
1240 * standard version of that protocol without any extension. If 'protocol' is a
1241 * standard protocol version, returns 'protocol' unchanged. */
1242 enum ofputil_protocol
1243 ofputil_protocol_to_base(enum ofputil_protocol protocol)
1245 return ofputil_protocol_set_tid(protocol, false);
1248 /* Returns 'new_base' with any extensions taken from 'cur'. */
1249 enum ofputil_protocol
1250 ofputil_protocol_set_base(enum ofputil_protocol cur,
1251 enum ofputil_protocol new_base)
1253 bool tid = (cur & OFPUTIL_P_TID) != 0;
1256 case OFPUTIL_P_OF10:
1257 case OFPUTIL_P_OF10_TID:
1258 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
1261 case OFPUTIL_P_NXM_TID:
1262 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
1269 /* Returns a string form of 'protocol', if a simple form exists (that is, if
1270 * 'protocol' is either a single protocol or it is a combination of protocols
1271 * that have a single abbreviation). Otherwise, returns NULL. */
1273 ofputil_protocol_to_string(enum ofputil_protocol protocol)
1275 const struct proto_abbrev *p;
1277 /* Use a "switch" statement for single-bit names so that we get a compiler
1278 * warning if we forget any. */
1281 return "NXM-table_id";
1283 case OFPUTIL_P_NXM_TID:
1284 return "NXM+table_id";
1286 case OFPUTIL_P_OF10:
1287 return "OpenFlow10-table_id";
1289 case OFPUTIL_P_OF10_TID:
1290 return "OpenFlow10+table_id";
1293 /* Check abbreviations. */
1294 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1295 if (protocol == p->protocol) {
1303 /* Returns a string that represents 'protocols'. The return value might be a
1304 * comma-separated list if 'protocols' doesn't have a simple name. The return
1305 * value is "none" if 'protocols' is 0.
1307 * The caller must free the returned string (with free()). */
1309 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1313 assert(!(protocols & ~OFPUTIL_P_ANY));
1314 if (protocols == 0) {
1315 return xstrdup("none");
1320 const struct proto_abbrev *p;
1324 ds_put_char(&s, ',');
1327 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1328 if ((protocols & p->protocol) == p->protocol) {
1329 ds_put_cstr(&s, p->name);
1330 protocols &= ~p->protocol;
1335 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1336 enum ofputil_protocol bit = 1u << i;
1338 if (protocols & bit) {
1339 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1348 return ds_steal_cstr(&s);
1351 static enum ofputil_protocol
1352 ofputil_protocol_from_string__(const char *s, size_t n)
1354 const struct proto_abbrev *p;
1357 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1358 enum ofputil_protocol bit = 1u << i;
1359 const char *name = ofputil_protocol_to_string(bit);
1361 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1366 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1367 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1375 /* Returns the nonempty set of protocols represented by 's', which can be a
1376 * single protocol name or abbreviation or a comma-separated list of them.
1378 * Aborts the program with an error message if 's' is invalid. */
1379 enum ofputil_protocol
1380 ofputil_protocols_from_string(const char *s)
1382 const char *orig_s = s;
1383 enum ofputil_protocol protocols;
1387 enum ofputil_protocol p;
1390 n = strcspn(s, ",");
1396 p = ofputil_protocol_from_string__(s, n);
1398 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1406 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1412 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1414 switch (packet_in_format) {
1415 case NXPIF_OPENFLOW10:
1424 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1426 switch (packet_in_format) {
1427 case NXPIF_OPENFLOW10:
1428 return "openflow10";
1437 ofputil_packet_in_format_from_string(const char *s)
1439 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1440 : !strcmp(s, "nxm") ? NXPIF_NXM
1445 regs_fully_wildcarded(const struct flow_wildcards *wc)
1449 for (i = 0; i < FLOW_N_REGS; i++) {
1450 if (wc->reg_masks[i] != 0) {
1457 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
1458 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
1459 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
1460 * use OpenFlow 1.0 protocol for backward compatibility. */
1461 enum ofputil_protocol
1462 ofputil_usable_protocols(const struct cls_rule *rule)
1464 const struct flow_wildcards *wc = &rule->wc;
1466 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 12);
1468 /* NXM and OF1.1+ supports bitwise matching on ethernet addresses. */
1469 if (!eth_mask_is_exact(wc->dl_src_mask)
1470 && !eth_addr_is_zero(wc->dl_src_mask)) {
1471 return OFPUTIL_P_NXM_ANY;
1473 if (!eth_mask_is_exact(wc->dl_dst_mask)
1474 && !eth_addr_is_zero(wc->dl_dst_mask)) {
1475 return OFPUTIL_P_NXM_ANY;
1478 /* NXM and OF1.1+ support matching metadata. */
1479 if (wc->metadata_mask != htonll(0)) {
1480 return OFPUTIL_P_NXM_ANY;
1483 /* Only NXM supports matching ARP hardware addresses. */
1484 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
1485 return OFPUTIL_P_NXM_ANY;
1488 /* Only NXM supports matching IPv6 traffic. */
1489 if (!(wc->wildcards & FWW_DL_TYPE)
1490 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
1491 return OFPUTIL_P_NXM_ANY;
1494 /* Only NXM supports matching registers. */
1495 if (!regs_fully_wildcarded(wc)) {
1496 return OFPUTIL_P_NXM_ANY;
1499 /* Only NXM supports matching tun_id. */
1500 if (wc->tun_id_mask != htonll(0)) {
1501 return OFPUTIL_P_NXM_ANY;
1504 /* Only NXM supports matching fragments. */
1505 if (wc->nw_frag_mask) {
1506 return OFPUTIL_P_NXM_ANY;
1509 /* Only NXM supports matching IPv6 flow label. */
1510 if (!(wc->wildcards & FWW_IPV6_LABEL)) {
1511 return OFPUTIL_P_NXM_ANY;
1514 /* Only NXM supports matching IP ECN bits. */
1515 if (!(wc->wildcards & FWW_NW_ECN)) {
1516 return OFPUTIL_P_NXM_ANY;
1519 /* Only NXM supports matching IP TTL/hop limit. */
1520 if (!(wc->wildcards & FWW_NW_TTL)) {
1521 return OFPUTIL_P_NXM_ANY;
1524 /* Only NXM supports non-CIDR IPv4 address masks. */
1525 if (!ip_is_cidr(wc->nw_src_mask) || !ip_is_cidr(wc->nw_dst_mask)) {
1526 return OFPUTIL_P_NXM_ANY;
1529 /* Only NXM supports bitwise matching on transport port. */
1530 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
1531 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
1532 return OFPUTIL_P_NXM_ANY;
1535 /* Other formats can express this rule. */
1536 return OFPUTIL_P_ANY;
1539 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1540 * protocol is 'current', at least partly transitions the protocol to 'want'.
1541 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1542 * connection if the switch processes the returned message correctly. (If
1543 * '*next != want' then the caller will have to iterate.)
1545 * If 'current == want', returns NULL and stores 'current' in '*next'. */
1547 ofputil_encode_set_protocol(enum ofputil_protocol current,
1548 enum ofputil_protocol want,
1549 enum ofputil_protocol *next)
1551 enum ofputil_protocol cur_base, want_base;
1552 bool cur_tid, want_tid;
1554 cur_base = ofputil_protocol_to_base(current);
1555 want_base = ofputil_protocol_to_base(want);
1556 if (cur_base != want_base) {
1557 *next = ofputil_protocol_set_base(current, want_base);
1559 switch (want_base) {
1561 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1563 case OFPUTIL_P_OF10:
1564 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1566 case OFPUTIL_P_OF10_TID:
1567 case OFPUTIL_P_NXM_TID:
1572 cur_tid = (current & OFPUTIL_P_TID) != 0;
1573 want_tid = (want & OFPUTIL_P_TID) != 0;
1574 if (cur_tid != want_tid) {
1575 *next = ofputil_protocol_set_tid(current, want_tid);
1576 return ofputil_make_flow_mod_table_id(want_tid);
1579 assert(current == want);
1585 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1586 * format to 'nxff'. */
1588 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1590 struct nx_set_flow_format *sff;
1593 assert(ofputil_nx_flow_format_is_valid(nxff));
1595 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
1596 sff->format = htonl(nxff);
1601 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1603 enum ofputil_protocol
1604 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1606 switch (flow_format) {
1607 case NXFF_OPENFLOW10:
1608 return OFPUTIL_P_OF10;
1611 return OFPUTIL_P_NXM;
1618 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1620 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1622 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1625 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1628 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1630 switch (flow_format) {
1631 case NXFF_OPENFLOW10:
1632 return "openflow10";
1641 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1643 struct nx_set_packet_in_format *spif;
1646 spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg);
1647 spif->format = htonl(packet_in_format);
1652 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1653 * extension on or off (according to 'flow_mod_table_id'). */
1655 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1657 struct nx_flow_mod_table_id *nfmti;
1660 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
1661 nfmti->set = flow_mod_table_id;
1665 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1666 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1669 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1670 * The caller must initialize 'ofpacts' and retains ownership of it.
1671 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1673 * Does not validate the flow_mod actions. The caller should do that, with
1674 * ofpacts_check(). */
1676 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1677 const struct ofp_header *oh,
1678 enum ofputil_protocol protocol,
1679 struct ofpbuf *ofpacts)
1681 const struct ofputil_msg_type *type;
1685 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1687 ofputil_decode_msg_type(oh, &type);
1688 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
1689 /* Standard OpenFlow flow_mod. */
1690 const struct ofp_flow_mod *ofm;
1694 /* Get the ofp_flow_mod. */
1695 ofm = ofpbuf_pull(&b, sizeof *ofm);
1697 /* Set priority based on original wildcards. Normally we'd allow
1698 * ofputil_cls_rule_from_match() to do this for us, but
1699 * ofputil_normalize_rule() can put wildcards where the original flow
1700 * didn't have them. */
1701 priority = ntohs(ofm->priority);
1702 if (!(ofm->match.wildcards & htonl(OFPFW10_ALL))) {
1703 priority = UINT16_MAX;
1706 /* Translate the rule. */
1707 ofputil_cls_rule_from_ofp10_match(&ofm->match, priority, &fm->cr);
1708 ofputil_normalize_rule(&fm->cr);
1710 /* Now get the actions. */
1711 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1716 /* Translate the message. */
1717 command = ntohs(ofm->command);
1718 fm->cookie = htonll(0);
1719 fm->cookie_mask = htonll(0);
1720 fm->new_cookie = ofm->cookie;
1721 fm->idle_timeout = ntohs(ofm->idle_timeout);
1722 fm->hard_timeout = ntohs(ofm->hard_timeout);
1723 fm->buffer_id = ntohl(ofm->buffer_id);
1724 fm->out_port = ntohs(ofm->out_port);
1725 fm->flags = ntohs(ofm->flags);
1726 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1727 /* Nicira extended flow_mod. */
1728 const struct nx_flow_mod *nfm;
1731 /* Dissect the message. */
1732 nfm = ofpbuf_pull(&b, sizeof *nfm);
1733 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1734 &fm->cr, &fm->cookie, &fm->cookie_mask);
1738 error = ofpacts_pull_openflow10(&b, b.size, ofpacts);
1743 /* Translate the message. */
1744 command = ntohs(nfm->command);
1745 if ((command & 0xff) == OFPFC_ADD && fm->cookie_mask) {
1746 /* Flow additions may only set a new cookie, not match an
1747 * existing cookie. */
1748 return OFPERR_NXBRC_NXM_INVALID;
1750 fm->new_cookie = nfm->cookie;
1751 fm->idle_timeout = ntohs(nfm->idle_timeout);
1752 fm->hard_timeout = ntohs(nfm->hard_timeout);
1753 fm->buffer_id = ntohl(nfm->buffer_id);
1754 fm->out_port = ntohs(nfm->out_port);
1755 fm->flags = ntohs(nfm->flags);
1760 fm->ofpacts = ofpacts->data;
1761 fm->ofpacts_len = ofpacts->size;
1762 if (protocol & OFPUTIL_P_TID) {
1763 fm->command = command & 0xff;
1764 fm->table_id = command >> 8;
1766 fm->command = command;
1767 fm->table_id = 0xff;
1773 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1774 * 'protocol' and returns the message. */
1776 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1777 enum ofputil_protocol protocol)
1779 struct ofp_flow_mod *ofm;
1780 struct nx_flow_mod *nfm;
1785 command = (protocol & OFPUTIL_P_TID
1786 ? (fm->command & 0xff) | (fm->table_id << 8)
1790 case OFPUTIL_P_OF10:
1791 case OFPUTIL_P_OF10_TID:
1792 msg = ofpbuf_new(sizeof *ofm + fm->ofpacts_len);
1793 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
1794 ofputil_cls_rule_to_ofp10_match(&fm->cr, &ofm->match);
1795 ofm->cookie = fm->new_cookie;
1796 ofm->command = htons(command);
1797 ofm->idle_timeout = htons(fm->idle_timeout);
1798 ofm->hard_timeout = htons(fm->hard_timeout);
1799 ofm->priority = htons(fm->cr.priority);
1800 ofm->buffer_id = htonl(fm->buffer_id);
1801 ofm->out_port = htons(fm->out_port);
1802 ofm->flags = htons(fm->flags);
1806 case OFPUTIL_P_NXM_TID:
1807 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + fm->ofpacts_len);
1808 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1810 nfm->command = htons(command);
1811 nfm->cookie = fm->new_cookie;
1812 match_len = nx_put_match(msg, false, &fm->cr,
1813 fm->cookie, fm->cookie_mask);
1815 nfm->idle_timeout = htons(fm->idle_timeout);
1816 nfm->hard_timeout = htons(fm->hard_timeout);
1817 nfm->priority = htons(fm->cr.priority);
1818 nfm->buffer_id = htonl(fm->buffer_id);
1819 nfm->out_port = htons(fm->out_port);
1820 nfm->flags = htons(fm->flags);
1821 nfm->match_len = htons(match_len);
1829 ofpacts_put_openflow10(fm->ofpacts, fm->ofpacts_len, msg);
1831 update_openflow_length(msg);
1835 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1836 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1837 * 0-bit for each protocol that is inadequate.
1839 * (The return value will have at least one 1-bit.) */
1840 enum ofputil_protocol
1841 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1844 enum ofputil_protocol usable_protocols;
1847 usable_protocols = OFPUTIL_P_ANY;
1848 for (i = 0; i < n_fms; i++) {
1849 const struct ofputil_flow_mod *fm = &fms[i];
1851 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1852 if (fm->table_id != 0xff) {
1853 usable_protocols &= OFPUTIL_P_TID;
1856 /* Matching of the cookie is only supported through NXM. */
1857 if (fm->cookie_mask != htonll(0)) {
1858 usable_protocols &= OFPUTIL_P_NXM_ANY;
1861 assert(usable_protocols);
1863 return usable_protocols;
1867 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1868 const struct ofp_header *oh,
1871 const struct ofp_flow_stats_request *ofsr =
1872 (const struct ofp_flow_stats_request *) oh;
1874 fsr->aggregate = aggregate;
1875 ofputil_cls_rule_from_ofp10_match(&ofsr->match, 0, &fsr->match);
1876 fsr->out_port = ntohs(ofsr->out_port);
1877 fsr->table_id = ofsr->table_id;
1878 fsr->cookie = fsr->cookie_mask = htonll(0);
1884 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1885 const struct ofp_header *oh,
1888 const struct nx_flow_stats_request *nfsr;
1892 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1894 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1895 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1896 &fsr->cookie, &fsr->cookie_mask);
1901 return OFPERR_OFPBRC_BAD_LEN;
1904 fsr->aggregate = aggregate;
1905 fsr->out_port = ntohs(nfsr->out_port);
1906 fsr->table_id = nfsr->table_id;
1911 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1912 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1913 * successful, otherwise an OpenFlow error code. */
1915 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1916 const struct ofp_header *oh)
1918 const struct ofputil_msg_type *type;
1922 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1924 ofputil_decode_msg_type(oh, &type);
1925 code = ofputil_msg_type_code(type);
1927 case OFPUTIL_OFPST_FLOW_REQUEST:
1928 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1930 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1931 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1933 case OFPUTIL_NXST_FLOW_REQUEST:
1934 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1936 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1937 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1940 /* Hey, the caller lied. */
1945 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1946 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1947 * 'protocol', and returns the message. */
1949 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1950 enum ofputil_protocol protocol)
1955 case OFPUTIL_P_OF10:
1956 case OFPUTIL_P_OF10_TID: {
1957 struct ofp_flow_stats_request *ofsr;
1960 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1961 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1962 ofputil_cls_rule_to_ofp10_match(&fsr->match, &ofsr->match);
1963 ofsr->table_id = fsr->table_id;
1964 ofsr->out_port = htons(fsr->out_port);
1969 case OFPUTIL_P_NXM_TID: {
1970 struct nx_flow_stats_request *nfsr;
1974 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1975 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1976 match_len = nx_put_match(msg, false, &fsr->match,
1977 fsr->cookie, fsr->cookie_mask);
1980 nfsr->out_port = htons(fsr->out_port);
1981 nfsr->match_len = htons(match_len);
1982 nfsr->table_id = fsr->table_id;
1993 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1994 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1996 * (The return value will have at least one 1-bit.) */
1997 enum ofputil_protocol
1998 ofputil_flow_stats_request_usable_protocols(
1999 const struct ofputil_flow_stats_request *fsr)
2001 enum ofputil_protocol usable_protocols;
2003 usable_protocols = ofputil_usable_protocols(&fsr->match);
2004 if (fsr->cookie_mask != htonll(0)) {
2005 usable_protocols &= OFPUTIL_P_NXM_ANY;
2007 return usable_protocols;
2010 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2011 * ofputil_flow_stats in 'fs'.
2013 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2014 * OpenFlow message. Calling this function multiple times for a single 'msg'
2015 * iterates through the replies. The caller must initially leave 'msg''s layer
2016 * pointers null and not modify them between calls.
2018 * Most switches don't send the values needed to populate fs->idle_age and
2019 * fs->hard_age, so those members will usually be set to 0. If the switch from
2020 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2021 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2022 * 'idle_age' and 'hard_age' members in 'fs'.
2024 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2025 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2026 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2028 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2029 * otherwise a positive errno value. */
2031 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
2033 bool flow_age_extension,
2034 struct ofpbuf *ofpacts)
2036 const struct ofputil_msg_type *type;
2039 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
2040 code = ofputil_msg_type_code(type);
2042 msg->l2 = msg->data;
2043 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
2044 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
2045 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
2046 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
2054 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
2055 const struct ofp_flow_stats *ofs;
2058 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
2060 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
2061 "bytes at end", msg->size);
2065 length = ntohs(ofs->length);
2066 if (length < sizeof *ofs) {
2067 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
2068 "length %zu", length);
2072 if (ofpacts_pull_openflow10(msg, length - sizeof *ofs, ofpacts)) {
2076 fs->cookie = get_32aligned_be64(&ofs->cookie);
2077 ofputil_cls_rule_from_ofp10_match(&ofs->match, ntohs(ofs->priority),
2079 fs->table_id = ofs->table_id;
2080 fs->duration_sec = ntohl(ofs->duration_sec);
2081 fs->duration_nsec = ntohl(ofs->duration_nsec);
2082 fs->idle_timeout = ntohs(ofs->idle_timeout);
2083 fs->hard_timeout = ntohs(ofs->hard_timeout);
2086 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
2087 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
2088 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
2089 const struct nx_flow_stats *nfs;
2090 size_t match_len, actions_len, length;
2092 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
2094 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
2095 "bytes at end", msg->size);
2099 length = ntohs(nfs->length);
2100 match_len = ntohs(nfs->match_len);
2101 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
2102 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
2103 "claims invalid length %zu", match_len, length);
2106 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
2111 actions_len = length - sizeof *nfs - ROUND_UP(match_len, 8);
2112 if (ofpacts_pull_openflow10(msg, actions_len, ofpacts)) {
2116 fs->cookie = nfs->cookie;
2117 fs->table_id = nfs->table_id;
2118 fs->duration_sec = ntohl(nfs->duration_sec);
2119 fs->duration_nsec = ntohl(nfs->duration_nsec);
2120 fs->idle_timeout = ntohs(nfs->idle_timeout);
2121 fs->hard_timeout = ntohs(nfs->hard_timeout);
2124 if (flow_age_extension) {
2125 if (nfs->idle_age) {
2126 fs->idle_age = ntohs(nfs->idle_age) - 1;
2128 if (nfs->hard_age) {
2129 fs->hard_age = ntohs(nfs->hard_age) - 1;
2132 fs->packet_count = ntohll(nfs->packet_count);
2133 fs->byte_count = ntohll(nfs->byte_count);
2138 fs->ofpacts = ofpacts->data;
2139 fs->ofpacts_len = ofpacts->size;
2144 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2146 * We use this in situations where OVS internally uses UINT64_MAX to mean
2147 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2149 unknown_to_zero(uint64_t count)
2151 return count != UINT64_MAX ? count : 0;
2154 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2155 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2156 * have been initialized with ofputil_start_stats_reply(). */
2158 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
2159 struct list *replies)
2161 struct ofpbuf *reply = ofpbuf_from_list(list_back(replies));
2162 const struct ofp_stats_msg *osm = reply->data;
2163 size_t start_ofs = reply->size;
2165 if (osm->type == htons(OFPST_FLOW)) {
2166 struct ofp_flow_stats *ofs;
2168 ofpbuf_put_uninit(reply, sizeof *ofs);
2169 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2171 ofs = ofpbuf_at_assert(reply, start_ofs, sizeof *ofs);
2172 ofs->length = htons(reply->size - start_ofs);
2173 ofs->table_id = fs->table_id;
2175 ofputil_cls_rule_to_ofp10_match(&fs->rule, &ofs->match);
2176 ofs->duration_sec = htonl(fs->duration_sec);
2177 ofs->duration_nsec = htonl(fs->duration_nsec);
2178 ofs->priority = htons(fs->rule.priority);
2179 ofs->idle_timeout = htons(fs->idle_timeout);
2180 ofs->hard_timeout = htons(fs->hard_timeout);
2181 memset(ofs->pad2, 0, sizeof ofs->pad2);
2182 put_32aligned_be64(&ofs->cookie, fs->cookie);
2183 put_32aligned_be64(&ofs->packet_count,
2184 htonll(unknown_to_zero(fs->packet_count)));
2185 put_32aligned_be64(&ofs->byte_count,
2186 htonll(unknown_to_zero(fs->byte_count)));
2187 } else if (osm->type == htons(OFPST_VENDOR)) {
2188 struct nx_flow_stats *nfs;
2191 ofpbuf_put_uninit(reply, sizeof *nfs);
2192 match_len = nx_put_match(reply, false, &fs->rule, 0, 0);
2193 ofpacts_put_openflow10(fs->ofpacts, fs->ofpacts_len, reply);
2195 nfs = ofpbuf_at_assert(reply, start_ofs, sizeof *nfs);
2196 nfs->length = htons(reply->size - start_ofs);
2197 nfs->table_id = fs->table_id;
2199 nfs->duration_sec = htonl(fs->duration_sec);
2200 nfs->duration_nsec = htonl(fs->duration_nsec);
2201 nfs->priority = htons(fs->rule.priority);
2202 nfs->idle_timeout = htons(fs->idle_timeout);
2203 nfs->hard_timeout = htons(fs->hard_timeout);
2204 nfs->idle_age = htons(fs->idle_age < 0 ? 0
2205 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
2207 nfs->hard_age = htons(fs->hard_age < 0 ? 0
2208 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
2210 nfs->match_len = htons(match_len);
2211 nfs->cookie = fs->cookie;
2212 nfs->packet_count = htonll(fs->packet_count);
2213 nfs->byte_count = htonll(fs->byte_count);
2218 ofputil_postappend_stats_reply(start_ofs, replies);
2221 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2222 * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
2224 ofputil_encode_aggregate_stats_reply(
2225 const struct ofputil_aggregate_stats *stats,
2226 const struct ofp_stats_msg *request)
2230 if (request->type == htons(OFPST_AGGREGATE)) {
2231 struct ofp_aggregate_stats_reply *asr;
2233 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
2234 put_32aligned_be64(&asr->packet_count,
2235 htonll(unknown_to_zero(stats->packet_count)));
2236 put_32aligned_be64(&asr->byte_count,
2237 htonll(unknown_to_zero(stats->byte_count)));
2238 asr->flow_count = htonl(stats->flow_count);
2239 } else if (request->type == htons(OFPST_VENDOR)) {
2240 struct nx_aggregate_stats_reply *nasr;
2242 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
2243 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
2244 nasr->packet_count = htonll(stats->packet_count);
2245 nasr->byte_count = htonll(stats->byte_count);
2246 nasr->flow_count = htonl(stats->flow_count);
2254 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
2255 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
2256 * an OpenFlow error code. */
2258 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
2259 const struct ofp_header *oh)
2261 const struct ofputil_msg_type *type;
2262 enum ofputil_msg_code code;
2264 ofputil_decode_msg_type(oh, &type);
2265 code = ofputil_msg_type_code(type);
2266 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
2267 const struct ofp_flow_removed *ofr;
2269 ofr = (const struct ofp_flow_removed *) oh;
2270 ofputil_cls_rule_from_ofp10_match(&ofr->match, ntohs(ofr->priority),
2272 fr->cookie = ofr->cookie;
2273 fr->reason = ofr->reason;
2274 fr->duration_sec = ntohl(ofr->duration_sec);
2275 fr->duration_nsec = ntohl(ofr->duration_nsec);
2276 fr->idle_timeout = ntohs(ofr->idle_timeout);
2277 fr->packet_count = ntohll(ofr->packet_count);
2278 fr->byte_count = ntohll(ofr->byte_count);
2279 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
2280 struct nx_flow_removed *nfr;
2284 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2286 nfr = ofpbuf_pull(&b, sizeof *nfr);
2287 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
2288 &fr->rule, NULL, NULL);
2293 return OFPERR_OFPBRC_BAD_LEN;
2296 fr->cookie = nfr->cookie;
2297 fr->reason = nfr->reason;
2298 fr->duration_sec = ntohl(nfr->duration_sec);
2299 fr->duration_nsec = ntohl(nfr->duration_nsec);
2300 fr->idle_timeout = ntohs(nfr->idle_timeout);
2301 fr->packet_count = ntohll(nfr->packet_count);
2302 fr->byte_count = ntohll(nfr->byte_count);
2310 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
2311 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
2314 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
2315 enum ofputil_protocol protocol)
2320 case OFPUTIL_P_OF10:
2321 case OFPUTIL_P_OF10_TID: {
2322 struct ofp_flow_removed *ofr;
2324 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
2326 ofputil_cls_rule_to_ofp10_match(&fr->rule, &ofr->match);
2327 ofr->cookie = fr->cookie;
2328 ofr->priority = htons(fr->rule.priority);
2329 ofr->reason = fr->reason;
2330 ofr->duration_sec = htonl(fr->duration_sec);
2331 ofr->duration_nsec = htonl(fr->duration_nsec);
2332 ofr->idle_timeout = htons(fr->idle_timeout);
2333 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2334 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2339 case OFPUTIL_P_NXM_TID: {
2340 struct nx_flow_removed *nfr;
2343 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
2344 match_len = nx_put_match(msg, false, &fr->rule, 0, 0);
2347 nfr->cookie = fr->cookie;
2348 nfr->priority = htons(fr->rule.priority);
2349 nfr->reason = fr->reason;
2350 nfr->duration_sec = htonl(fr->duration_sec);
2351 nfr->duration_nsec = htonl(fr->duration_nsec);
2352 nfr->idle_timeout = htons(fr->idle_timeout);
2353 nfr->match_len = htons(match_len);
2354 nfr->packet_count = htonll(fr->packet_count);
2355 nfr->byte_count = htonll(fr->byte_count);
2367 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2368 const struct ofp_header *oh)
2370 const struct ofputil_msg_type *type;
2371 enum ofputil_msg_code code;
2373 ofputil_decode_msg_type(oh, &type);
2374 code = ofputil_msg_type_code(type);
2375 memset(pin, 0, sizeof *pin);
2377 if (code == OFPUTIL_OFPT_PACKET_IN) {
2378 const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
2380 pin->packet = opi->data;
2381 pin->packet_len = ntohs(opi->header.length)
2382 - offsetof(struct ofp_packet_in, data);
2384 pin->fmd.in_port = ntohs(opi->in_port);
2385 pin->reason = opi->reason;
2386 pin->buffer_id = ntohl(opi->buffer_id);
2387 pin->total_len = ntohs(opi->total_len);
2388 } else if (code == OFPUTIL_NXT_PACKET_IN) {
2389 const struct nx_packet_in *npi;
2390 struct cls_rule rule;
2394 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2396 npi = ofpbuf_pull(&b, sizeof *npi);
2397 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2403 if (!ofpbuf_try_pull(&b, 2)) {
2404 return OFPERR_OFPBRC_BAD_LEN;
2407 pin->packet = b.data;
2408 pin->packet_len = b.size;
2409 pin->reason = npi->reason;
2410 pin->table_id = npi->table_id;
2411 pin->cookie = npi->cookie;
2413 pin->fmd.in_port = rule.flow.in_port;
2415 pin->fmd.tun_id = rule.flow.tun_id;
2416 pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
2418 pin->fmd.metadata = rule.flow.metadata;
2419 pin->fmd.metadata_mask = rule.wc.metadata_mask;
2421 memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
2422 memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
2423 sizeof pin->fmd.reg_masks);
2425 pin->buffer_id = ntohl(npi->buffer_id);
2426 pin->total_len = ntohs(npi->total_len);
2434 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2435 * in the format specified by 'packet_in_format'. */
2437 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2438 enum nx_packet_in_format packet_in_format)
2440 size_t send_len = MIN(pin->send_len, pin->packet_len);
2441 struct ofpbuf *packet;
2443 /* Add OFPT_PACKET_IN. */
2444 if (packet_in_format == NXPIF_OPENFLOW10) {
2445 size_t header_len = offsetof(struct ofp_packet_in, data);
2446 struct ofp_packet_in *opi;
2448 packet = ofpbuf_new(send_len + header_len);
2449 opi = ofpbuf_put_zeros(packet, header_len);
2450 opi->header.version = OFP10_VERSION;
2451 opi->header.type = OFPT_PACKET_IN;
2452 opi->total_len = htons(pin->total_len);
2453 opi->in_port = htons(pin->fmd.in_port);
2454 opi->reason = pin->reason;
2455 opi->buffer_id = htonl(pin->buffer_id);
2457 ofpbuf_put(packet, pin->packet, send_len);
2458 } else if (packet_in_format == NXPIF_NXM) {
2459 struct nx_packet_in *npi;
2460 struct cls_rule rule;
2464 /* Estimate of required PACKET_IN length includes the NPI header, space
2465 * for the match (2 times sizeof the metadata seems like enough), 2
2466 * bytes for padding, and the packet length. */
2467 packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
2470 cls_rule_init_catchall(&rule, 0);
2471 cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
2472 pin->fmd.tun_id_mask);
2473 cls_rule_set_metadata_masked(&rule, pin->fmd.metadata,
2474 pin->fmd.metadata_mask);
2477 for (i = 0; i < FLOW_N_REGS; i++) {
2478 cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
2479 pin->fmd.reg_masks[i]);
2482 cls_rule_set_in_port(&rule, pin->fmd.in_port);
2484 ofpbuf_put_zeros(packet, sizeof *npi);
2485 match_len = nx_put_match(packet, false, &rule, 0, 0);
2486 ofpbuf_put_zeros(packet, 2);
2487 ofpbuf_put(packet, pin->packet, send_len);
2490 npi->nxh.header.version = OFP10_VERSION;
2491 npi->nxh.header.type = OFPT_VENDOR;
2492 npi->nxh.vendor = htonl(NX_VENDOR_ID);
2493 npi->nxh.subtype = htonl(NXT_PACKET_IN);
2495 npi->buffer_id = htonl(pin->buffer_id);
2496 npi->total_len = htons(pin->total_len);
2497 npi->reason = pin->reason;
2498 npi->table_id = pin->table_id;
2499 npi->cookie = pin->cookie;
2500 npi->match_len = htons(match_len);
2504 update_openflow_length(packet);
2510 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2512 static char s[INT_STRLEN(int) + 1];
2519 case OFPR_INVALID_TTL:
2520 return "invalid_ttl";
2522 case OFPR_N_REASONS:
2524 sprintf(s, "%d", (int) reason);
2530 ofputil_packet_in_reason_from_string(const char *s,
2531 enum ofp_packet_in_reason *reason)
2535 for (i = 0; i < OFPR_N_REASONS; i++) {
2536 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2544 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
2547 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
2548 * message's actions. The caller must initialize 'ofpacts' and retains
2549 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
2551 * Returns 0 if successful, otherwise an OFPERR_* value. */
2553 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2554 const struct ofp_packet_out *opo,
2555 struct ofpbuf *ofpacts)
2560 po->buffer_id = ntohl(opo->buffer_id);
2561 po->in_port = ntohs(opo->in_port);
2562 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2563 && po->in_port != OFPP_NONE && po->in_port != OFPP_CONTROLLER) {
2564 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2566 return OFPERR_NXBRC_BAD_IN_PORT;
2569 ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
2570 ofpbuf_pull(&b, sizeof *opo);
2572 error = ofpacts_pull_openflow10(&b, ntohs(opo->actions_len), ofpacts);
2576 po->ofpacts = ofpacts->data;
2577 po->ofpacts_len = ofpacts->size;
2579 if (po->buffer_id == UINT32_MAX) {
2580 po->packet = b.data;
2581 po->packet_len = b.size;
2590 /* ofputil_phy_port */
2592 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2593 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2594 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2595 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2596 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2597 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2598 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2599 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2601 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2602 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2603 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2604 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2605 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2606 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2608 static enum netdev_features
2609 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2611 uint32_t ofp10 = ntohl(ofp10_);
2612 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2616 netdev_port_features_to_ofp10(enum netdev_features features)
2618 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2621 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2622 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2623 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2624 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2625 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2626 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2627 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2628 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2629 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2630 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2631 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2632 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2633 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2634 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2635 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2636 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2638 static enum netdev_features
2639 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2641 return ntohl(ofp11) & 0xffff;
2645 netdev_port_features_to_ofp11(enum netdev_features features)
2647 return htonl(features & 0xffff);
2651 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2652 const struct ofp10_phy_port *opp)
2654 memset(pp, 0, sizeof *pp);
2656 pp->port_no = ntohs(opp->port_no);
2657 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2658 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2660 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2661 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2663 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2664 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2665 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2666 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2668 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2669 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2675 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2676 const struct ofp11_port *op)
2680 memset(pp, 0, sizeof *pp);
2682 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2686 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2687 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2689 pp->config = ntohl(op->config) & OFPPC11_ALL;
2690 pp->state = ntohl(op->state) & OFPPC11_ALL;
2692 pp->curr = netdev_port_features_from_ofp11(op->curr);
2693 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2694 pp->supported = netdev_port_features_from_ofp11(op->supported);
2695 pp->peer = netdev_port_features_from_ofp11(op->peer);
2697 pp->curr_speed = ntohl(op->curr_speed);
2698 pp->max_speed = ntohl(op->max_speed);
2704 ofputil_get_phy_port_size(uint8_t ofp_version)
2706 return ofp_version == OFP10_VERSION ? sizeof(struct ofp10_phy_port)
2707 : sizeof(struct ofp11_port);
2711 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2712 struct ofp10_phy_port *opp)
2714 memset(opp, 0, sizeof *opp);
2716 opp->port_no = htons(pp->port_no);
2717 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2718 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2720 opp->config = htonl(pp->config & OFPPC10_ALL);
2721 opp->state = htonl(pp->state & OFPPS10_ALL);
2723 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2724 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2725 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2726 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2730 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2731 struct ofp11_port *op)
2733 memset(op, 0, sizeof *op);
2735 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2736 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2737 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2739 op->config = htonl(pp->config & OFPPC11_ALL);
2740 op->state = htonl(pp->state & OFPPS11_ALL);
2742 op->curr = netdev_port_features_to_ofp11(pp->curr);
2743 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2744 op->supported = netdev_port_features_to_ofp11(pp->supported);
2745 op->peer = netdev_port_features_to_ofp11(pp->peer);
2747 op->curr_speed = htonl(pp->curr_speed);
2748 op->max_speed = htonl(pp->max_speed);
2752 ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
2755 if (ofp_version == OFP10_VERSION) {
2756 struct ofp10_phy_port *opp;
2757 if (b->size + sizeof *opp <= UINT16_MAX) {
2758 opp = ofpbuf_put_uninit(b, sizeof *opp);
2759 ofputil_encode_ofp10_phy_port(pp, opp);
2762 struct ofp11_port *op;
2763 if (b->size + sizeof *op <= UINT16_MAX) {
2764 op = ofpbuf_put_uninit(b, sizeof *op);
2765 ofputil_encode_ofp11_port(pp, op);
2771 ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
2772 const struct ofputil_phy_port *pp,
2773 struct list *replies)
2775 if (ofp_version == OFP10_VERSION) {
2776 struct ofp10_phy_port *opp;
2778 opp = ofputil_append_stats_reply(sizeof *opp, replies);
2779 ofputil_encode_ofp10_phy_port(pp, opp);
2781 struct ofp11_port *op;
2783 op = ofputil_append_stats_reply(sizeof *op, replies);
2784 ofputil_encode_ofp11_port(pp, op);
2788 /* ofputil_switch_features */
2790 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2791 OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
2792 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2793 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2794 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2795 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2796 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2797 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2799 struct ofputil_action_bit_translation {
2800 enum ofputil_action_bitmap ofputil_bit;
2804 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2805 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2806 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2807 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2808 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2809 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2810 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2811 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2812 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2813 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2814 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2815 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2816 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2820 static const struct ofputil_action_bit_translation of11_action_bits[] = {
2821 { OFPUTIL_A_OUTPUT, OFPAT11_OUTPUT },
2822 { OFPUTIL_A_SET_VLAN_VID, OFPAT11_SET_VLAN_VID },
2823 { OFPUTIL_A_SET_VLAN_PCP, OFPAT11_SET_VLAN_PCP },
2824 { OFPUTIL_A_SET_DL_SRC, OFPAT11_SET_DL_SRC },
2825 { OFPUTIL_A_SET_DL_DST, OFPAT11_SET_DL_DST },
2826 { OFPUTIL_A_SET_NW_SRC, OFPAT11_SET_NW_SRC },
2827 { OFPUTIL_A_SET_NW_DST, OFPAT11_SET_NW_DST },
2828 { OFPUTIL_A_SET_NW_TOS, OFPAT11_SET_NW_TOS },
2829 { OFPUTIL_A_SET_NW_ECN, OFPAT11_SET_NW_ECN },
2830 { OFPUTIL_A_SET_TP_SRC, OFPAT11_SET_TP_SRC },
2831 { OFPUTIL_A_SET_TP_DST, OFPAT11_SET_TP_DST },
2832 { OFPUTIL_A_COPY_TTL_OUT, OFPAT11_COPY_TTL_OUT },
2833 { OFPUTIL_A_COPY_TTL_IN, OFPAT11_COPY_TTL_IN },
2834 { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
2835 { OFPUTIL_A_SET_MPLS_TC, OFPAT11_SET_MPLS_TC },
2836 { OFPUTIL_A_SET_MPLS_TTL, OFPAT11_SET_MPLS_TTL },
2837 { OFPUTIL_A_DEC_MPLS_TTL, OFPAT11_DEC_MPLS_TTL },
2838 { OFPUTIL_A_PUSH_VLAN, OFPAT11_PUSH_VLAN },
2839 { OFPUTIL_A_POP_VLAN, OFPAT11_POP_VLAN },
2840 { OFPUTIL_A_PUSH_MPLS, OFPAT11_PUSH_MPLS },
2841 { OFPUTIL_A_POP_MPLS, OFPAT11_POP_MPLS },
2842 { OFPUTIL_A_SET_QUEUE, OFPAT11_SET_QUEUE },
2843 { OFPUTIL_A_GROUP, OFPAT11_GROUP },
2844 { OFPUTIL_A_SET_NW_TTL, OFPAT11_SET_NW_TTL },
2845 { OFPUTIL_A_DEC_NW_TTL, OFPAT11_DEC_NW_TTL },
2849 static enum ofputil_action_bitmap
2850 decode_action_bits(ovs_be32 of_actions,
2851 const struct ofputil_action_bit_translation *x)
2853 enum ofputil_action_bitmap ofputil_actions;
2855 ofputil_actions = 0;
2856 for (; x->ofputil_bit; x++) {
2857 if (of_actions & htonl(1u << x->of_bit)) {
2858 ofputil_actions |= x->ofputil_bit;
2861 return ofputil_actions;
2864 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2865 * abstract representation in '*features'. Initializes '*b' to iterate over
2866 * the OpenFlow port structures following 'osf' with later calls to
2867 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
2868 * OFPERR_* value. */
2870 ofputil_decode_switch_features(const struct ofp_switch_features *osf,
2871 struct ofputil_switch_features *features,
2874 ofpbuf_use_const(b, osf, ntohs(osf->header.length));
2875 ofpbuf_pull(b, sizeof *osf);
2877 features->datapath_id = ntohll(osf->datapath_id);
2878 features->n_buffers = ntohl(osf->n_buffers);
2879 features->n_tables = osf->n_tables;
2881 features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
2883 if (b->size % ofputil_get_phy_port_size(osf->header.version)) {
2884 return OFPERR_OFPBRC_BAD_LEN;
2887 if (osf->header.version == OFP10_VERSION) {
2888 if (osf->capabilities & htonl(OFPC10_STP)) {
2889 features->capabilities |= OFPUTIL_C_STP;
2891 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2892 } else if (osf->header.version == OFP11_VERSION) {
2893 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2894 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2896 features->actions = decode_action_bits(osf->actions, of11_action_bits);
2898 return OFPERR_OFPBRC_BAD_VERSION;
2904 /* Returns true if the maximum number of ports are in 'osf'. */
2906 max_ports_in_features(const struct ofp_switch_features *osf)
2908 size_t pp_size = ofputil_get_phy_port_size(osf->header.version);
2909 return ntohs(osf->header.length) + pp_size > UINT16_MAX;
2912 /* Given a buffer 'b' that contains a Features Reply message, checks if
2913 * it contains the maximum number of ports that will fit. If so, it
2914 * returns true and removes the ports from the message. The caller
2915 * should then send an OFPST_PORT_DESC stats request to get the ports,
2916 * since the switch may have more ports than could be represented in the
2917 * Features Reply. Otherwise, returns false.
2920 ofputil_switch_features_ports_trunc(struct ofpbuf *b)
2922 struct ofp_switch_features *osf = b->data;
2924 if (max_ports_in_features(osf)) {
2925 /* Remove all the ports. */
2926 b->size = sizeof(*osf);
2927 update_openflow_length(b);
2936 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2937 const struct ofputil_action_bit_translation *x)
2939 uint32_t of_actions;
2942 for (; x->ofputil_bit; x++) {
2943 if (ofputil_actions & x->ofputil_bit) {
2944 of_actions |= 1 << x->of_bit;
2947 return htonl(of_actions);
2950 /* Returns a buffer owned by the caller that encodes 'features' in the format
2951 * required by 'protocol' with the given 'xid'. The caller should append port
2952 * information to the buffer with subsequent calls to
2953 * ofputil_put_switch_features_port(). */
2955 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2956 enum ofputil_protocol protocol, ovs_be32 xid)
2958 struct ofp_switch_features *osf;
2961 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
2962 osf->header.version = ofputil_protocol_to_ofp_version(protocol);
2963 osf->datapath_id = htonll(features->datapath_id);
2964 osf->n_buffers = htonl(features->n_buffers);
2965 osf->n_tables = features->n_tables;
2967 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2968 if (osf->header.version == OFP10_VERSION) {
2969 if (features->capabilities & OFPUTIL_C_STP) {
2970 osf->capabilities |= htonl(OFPC10_STP);
2972 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2974 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2975 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2977 osf->actions = encode_action_bits(features->actions, of11_action_bits);
2983 /* Encodes 'pp' into the format required by the switch_features message already
2984 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2985 * and appends the encoded version to 'b'. */
2987 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2990 const struct ofp_switch_features *osf = b->data;
2992 ofputil_put_phy_port(osf->header.version, pp, b);
2995 /* ofputil_port_status */
2997 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2998 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
3000 ofputil_decode_port_status(const struct ofp_port_status *ops,
3001 struct ofputil_port_status *ps)
3006 if (ops->reason != OFPPR_ADD &&
3007 ops->reason != OFPPR_DELETE &&
3008 ops->reason != OFPPR_MODIFY) {
3009 return OFPERR_NXBRC_BAD_REASON;
3011 ps->reason = ops->reason;
3013 ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
3014 ofpbuf_pull(&b, sizeof *ops);
3015 retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
3016 assert(retval != EOF);
3020 /* Converts the abstract form of a "port status" message in '*ps' into an
3021 * OpenFlow message suitable for 'protocol', and returns that encoded form in
3022 * a buffer owned by the caller. */
3024 ofputil_encode_port_status(const struct ofputil_port_status *ps,
3025 enum ofputil_protocol protocol)
3027 struct ofp_port_status *ops;
3030 b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
3031 ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
3032 ops->header.version = ofputil_protocol_to_ofp_version(protocol);
3033 ops->reason = ps->reason;
3034 ofputil_put_phy_port(ops->header.version, &ps->desc, b);
3035 update_openflow_length(b);
3039 /* ofputil_port_mod */
3041 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
3042 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
3044 ofputil_decode_port_mod(const struct ofp_header *oh,
3045 struct ofputil_port_mod *pm)
3047 if (oh->version == OFP10_VERSION) {
3048 const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
3050 if (oh->length != htons(sizeof *opm)) {
3051 return OFPERR_OFPBRC_BAD_LEN;
3054 pm->port_no = ntohs(opm->port_no);
3055 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3056 pm->config = ntohl(opm->config) & OFPPC10_ALL;
3057 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
3058 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
3059 } else if (oh->version == OFP11_VERSION) {
3060 const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
3063 if (oh->length != htons(sizeof *opm)) {
3064 return OFPERR_OFPBRC_BAD_LEN;
3067 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
3072 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
3073 pm->config = ntohl(opm->config) & OFPPC11_ALL;
3074 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
3075 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
3077 return OFPERR_OFPBRC_BAD_VERSION;
3080 pm->config &= pm->mask;
3084 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
3085 * message suitable for 'protocol', and returns that encoded form in a buffer
3086 * owned by the caller. */
3088 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
3089 enum ofputil_protocol protocol)
3091 uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
3094 if (ofp_version == OFP10_VERSION) {
3095 struct ofp10_port_mod *opm;
3097 opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
3098 opm->port_no = htons(pm->port_no);
3099 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3100 opm->config = htonl(pm->config & OFPPC10_ALL);
3101 opm->mask = htonl(pm->mask & OFPPC10_ALL);
3102 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
3103 } else if (ofp_version == OFP11_VERSION) {
3104 struct ofp11_port_mod *opm;
3106 opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
3107 opm->port_no = htonl(pm->port_no);
3108 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
3109 opm->config = htonl(pm->config & OFPPC11_ALL);
3110 opm->mask = htonl(pm->mask & OFPPC11_ALL);
3111 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
3119 /* ofputil_flow_monitor_request */
3121 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
3122 * ofputil_flow_monitor_request in 'rq'.
3124 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
3125 * message. Calling this function multiple times for a single 'msg' iterates
3126 * through the requests. The caller must initially leave 'msg''s layer
3127 * pointers null and not modify them between calls.
3129 * Returns 0 if successful, EOF if no requests were left in this 'msg',
3130 * otherwise an OFPERR_* value. */
3132 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *rq,
3135 struct nx_flow_monitor_request *nfmr;
3139 msg->l2 = msg->data;
3140 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
3147 nfmr = ofpbuf_try_pull(msg, sizeof *nfmr);
3149 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR request has %zu "
3150 "leftover bytes at end", msg->size);
3151 return OFPERR_OFPBRC_BAD_LEN;
3154 flags = ntohs(nfmr->flags);
3155 if (!(flags & (NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY))
3156 || flags & ~(NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE
3157 | NXFMF_MODIFY | NXFMF_ACTIONS | NXFMF_OWN)) {
3158 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR has bad flags %#"PRIx16,
3160 return OFPERR_NXBRC_FM_BAD_FLAGS;
3163 if (!is_all_zeros(nfmr->zeros, sizeof nfmr->zeros)) {
3164 return OFPERR_NXBRC_MUST_BE_ZERO;
3167 rq->id = ntohl(nfmr->id);
3169 rq->out_port = ntohs(nfmr->out_port);
3170 rq->table_id = nfmr->table_id;
3172 return nx_pull_match(msg, ntohs(nfmr->match_len), OFP_DEFAULT_PRIORITY,
3173 &rq->match, NULL, NULL);
3177 ofputil_append_flow_monitor_request(
3178 const struct ofputil_flow_monitor_request *rq, struct ofpbuf *msg)
3180 struct nx_flow_monitor_request *nfmr;
3185 ofputil_put_stats_header(alloc_xid(), OFPT10_STATS_REQUEST,
3186 htons(OFPST_VENDOR),
3187 htonl(NXST_FLOW_MONITOR), msg);
3190 start_ofs = msg->size;
3191 ofpbuf_put_zeros(msg, sizeof *nfmr);
3192 match_len = nx_put_match(msg, false, &rq->match, htonll(0), htonll(0));
3194 nfmr = ofpbuf_at_assert(msg, start_ofs, sizeof *nfmr);
3195 nfmr->id = htonl(rq->id);
3196 nfmr->flags = htons(rq->flags);
3197 nfmr->out_port = htons(rq->out_port);
3198 nfmr->match_len = htons(match_len);
3199 nfmr->table_id = rq->table_id;
3202 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
3203 * into an abstract ofputil_flow_update in 'update'. The caller must have
3204 * initialized update->match to point to space allocated for a cls_rule.
3206 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
3207 * actions (except for NXFME_ABBREV, which never includes actions). The caller
3208 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
3209 * will point into the 'ofpacts' buffer.
3211 * Multiple flow updates can be packed into a single OpenFlow message. Calling
3212 * this function multiple times for a single 'msg' iterates through the
3213 * updates. The caller must initially leave 'msg''s layer pointers null and
3214 * not modify them between calls.
3216 * Returns 0 if successful, EOF if no updates were left in this 'msg',
3217 * otherwise an OFPERR_* value. */
3219 ofputil_decode_flow_update(struct ofputil_flow_update *update,
3220 struct ofpbuf *msg, struct ofpbuf *ofpacts)
3222 struct nx_flow_update_header *nfuh;
3223 unsigned int length;
3226 msg->l2 = msg->data;
3227 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
3234 if (msg->size < sizeof(struct nx_flow_update_header)) {
3239 update->event = ntohs(nfuh->event);
3240 length = ntohs(nfuh->length);
3241 if (length > msg->size || length % 8) {
3245 if (update->event == NXFME_ABBREV) {
3246 struct nx_flow_update_abbrev *nfua;
3248 if (length != sizeof *nfua) {
3252 nfua = ofpbuf_pull(msg, sizeof *nfua);
3253 update->xid = nfua->xid;
3255 } else if (update->event == NXFME_ADDED
3256 || update->event == NXFME_DELETED
3257 || update->event == NXFME_MODIFIED) {
3258 struct nx_flow_update_full *nfuf;
3259 unsigned int actions_len;
3260 unsigned int match_len;
3263 if (length < sizeof *nfuf) {
3267 nfuf = ofpbuf_pull(msg, sizeof *nfuf);
3268 match_len = ntohs(nfuf->match_len);
3269 if (sizeof *nfuf + match_len > length) {
3273 update->reason = ntohs(nfuf->reason);
3274 update->idle_timeout = ntohs(nfuf->idle_timeout);
3275 update->hard_timeout = ntohs(nfuf->hard_timeout);
3276 update->table_id = nfuf->table_id;
3277 update->cookie = nfuf->cookie;
3279 error = nx_pull_match(msg, match_len, ntohs(nfuf->priority),
3280 update->match, NULL, NULL);
3285 actions_len = length - sizeof *nfuf - ROUND_UP(match_len, 8);
3286 error = ofpacts_pull_openflow10(msg, actions_len, ofpacts);
3291 update->ofpacts = ofpacts->data;
3292 update->ofpacts_len = ofpacts->size;
3295 VLOG_WARN_RL(&bad_ofmsg_rl,
3296 "NXST_FLOW_MONITOR reply has bad event %"PRIu16,
3297 ntohs(nfuh->event));
3298 return OFPERR_OFPET_BAD_REQUEST;
3302 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW_MONITOR reply has %zu "
3303 "leftover bytes at end", msg->size);
3304 return OFPERR_OFPBRC_BAD_LEN;
3308 ofputil_decode_flow_monitor_cancel(const struct ofp_header *oh)
3310 return ntohl(((const struct nx_flow_monitor_cancel *) oh)->id);
3314 ofputil_encode_flow_monitor_cancel(uint32_t id)
3316 struct nx_flow_monitor_cancel *nfmc;
3319 nfmc = make_nxmsg(sizeof *nfmc, NXT_FLOW_MONITOR_CANCEL, &msg);
3320 nfmc->id = htonl(id);
3325 ofputil_start_flow_update(struct list *replies)
3329 msg = ofpbuf_new(1024);
3330 ofputil_put_stats_header(htonl(0), OFPT10_STATS_REPLY,
3331 htons(OFPST_VENDOR),
3332 htonl(NXST_FLOW_MONITOR), msg);
3335 list_push_back(replies, &msg->list_node);
3339 ofputil_append_flow_update(const struct ofputil_flow_update *update,
3340 struct list *replies)
3342 struct nx_flow_update_header *nfuh;
3346 msg = ofpbuf_from_list(list_back(replies));
3347 start_ofs = msg->size;
3349 if (update->event == NXFME_ABBREV) {
3350 struct nx_flow_update_abbrev *nfua;
3352 nfua = ofpbuf_put_zeros(msg, sizeof *nfua);
3353 nfua->xid = update->xid;
3355 struct nx_flow_update_full *nfuf;
3358 ofpbuf_put_zeros(msg, sizeof *nfuf);
3359 match_len = nx_put_match(msg, false, update->match,
3360 htonll(0), htonll(0));
3361 ofpacts_put_openflow10(update->ofpacts, update->ofpacts_len, msg);
3363 nfuf = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuf);
3364 nfuf->reason = htons(update->reason);
3365 nfuf->priority = htons(update->match->priority);
3366 nfuf->idle_timeout = htons(update->idle_timeout);
3367 nfuf->hard_timeout = htons(update->hard_timeout);
3368 nfuf->match_len = htons(match_len);
3369 nfuf->table_id = update->table_id;
3370 nfuf->cookie = update->cookie;
3373 nfuh = ofpbuf_at_assert(msg, start_ofs, sizeof *nfuh);
3374 nfuh->length = htons(msg->size - start_ofs);
3375 nfuh->event = htons(update->event);
3377 ofputil_postappend_stats_reply(start_ofs, replies);
3381 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
3383 struct ofp_packet_out *opo;
3387 size = sizeof *opo + po->ofpacts_len;
3388 if (po->buffer_id == UINT32_MAX) {
3389 size += po->packet_len;
3392 msg = ofpbuf_new(size);
3393 put_openflow(sizeof *opo, OFPT_PACKET_OUT, msg);
3394 ofpacts_put_openflow10(po->ofpacts, po->ofpacts_len, msg);
3397 opo->buffer_id = htonl(po->buffer_id);
3398 opo->in_port = htons(po->in_port);
3399 opo->actions_len = htons(msg->size - sizeof *opo);
3401 if (po->buffer_id == UINT32_MAX) {
3402 ofpbuf_put(msg, po->packet, po->packet_len);
3405 update_openflow_length(msg);
3410 /* Returns a string representing the message type of 'type'. The string is the
3411 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
3412 * messages, the constant is followed by "request" or "reply",
3413 * e.g. "OFPST_AGGREGATE reply". */
3415 ofputil_msg_type_name(const struct ofputil_msg_type *type)
3420 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
3421 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
3422 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
3425 * The caller is responsible for freeing '*bufferp' when it is no longer
3428 * The OpenFlow header length is initially set to 'openflow_len'; if the
3429 * message is later extended, the length should be updated with
3430 * update_openflow_length() before sending.
3432 * Returns the header. */
3434 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
3436 *bufferp = ofpbuf_new(openflow_len);
3437 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
3440 /* Similar to make_openflow() but creates a Nicira vendor extension message
3441 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3443 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
3445 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
3448 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
3449 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
3450 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
3453 * The caller is responsible for freeing '*bufferp' when it is no longer
3456 * The OpenFlow header length is initially set to 'openflow_len'; if the
3457 * message is later extended, the length should be updated with
3458 * update_openflow_length() before sending.
3460 * Returns the header. */
3462 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
3463 struct ofpbuf **bufferp)
3465 *bufferp = ofpbuf_new(openflow_len);
3466 return put_openflow_xid(openflow_len, type, xid, *bufferp);
3469 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
3470 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3472 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
3473 struct ofpbuf **bufferp)
3475 *bufferp = ofpbuf_new(openflow_len);
3476 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
3479 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
3480 * with the given 'type' and an arbitrary transaction id. Allocated bytes
3481 * beyond the header, if any, are zeroed.
3483 * The OpenFlow header length is initially set to 'openflow_len'; if the
3484 * message is later extended, the length should be updated with
3485 * update_openflow_length() before sending.
3487 * Returns the header. */
3489 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
3491 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
3494 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
3495 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
3496 * the header, if any, are zeroed.
3498 * The OpenFlow header length is initially set to 'openflow_len'; if the
3499 * message is later extended, the length should be updated with
3500 * update_openflow_length() before sending.
3502 * Returns the header. */
3504 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
3505 struct ofpbuf *buffer)
3507 struct ofp_header *oh;
3509 assert(openflow_len >= sizeof *oh);
3510 assert(openflow_len <= UINT16_MAX);
3512 oh = ofpbuf_put_uninit(buffer, openflow_len);
3513 oh->version = OFP10_VERSION;
3515 oh->length = htons(openflow_len);
3517 memset(oh + 1, 0, openflow_len - sizeof *oh);
3521 /* Similar to put_openflow() but append a Nicira vendor extension message with
3522 * the specific 'subtype'. 'subtype' should be in host byte order. */
3524 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
3526 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
3529 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
3530 * with the specific 'subtype'. 'subtype' should be in host byte order. */
3532 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
3533 struct ofpbuf *buffer)
3535 struct nicira_header *nxh;
3537 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
3538 nxh->vendor = htonl(NX_VENDOR_ID);
3539 nxh->subtype = htonl(subtype);
3543 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
3544 * 'buffer->size'. */
3546 update_openflow_length(struct ofpbuf *buffer)
3548 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
3549 oh->length = htons(buffer->size);
3553 ofputil_put_stats_header(ovs_be32 xid, uint8_t ofp_type,
3554 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
3557 if (ofpst_type == htons(OFPST_VENDOR)) {
3558 struct nicira_stats_msg *nsm;
3560 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
3561 nsm->vsm.osm.type = ofpst_type;
3562 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
3563 nsm->subtype = nxst_subtype;
3565 struct ofp_stats_msg *osm;
3567 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
3568 osm->type = ofpst_type;
3572 /* Creates a statistics request message with total length 'openflow_len'
3573 * (including all headers) and the given 'ofpst_type', and stores the buffer
3574 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
3575 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
3576 * subtype (otherwise 'nxst_subtype' is ignored).
3578 * Initializes bytes following the headers to all-bits-zero.
3580 * Returns the first byte of the new message. */
3582 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
3583 uint32_t nxst_subtype, struct ofpbuf **bufferp)
3587 msg = *bufferp = ofpbuf_new(openflow_len);
3588 ofputil_put_stats_header(alloc_xid(), OFPT10_STATS_REQUEST,
3589 htons(ofpst_type), htonl(nxst_subtype), msg);
3590 ofpbuf_padto(msg, openflow_len);
3596 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
3598 ovs_be32 nxst_subtype;
3600 assert(request->header.type == OFPT10_STATS_REQUEST ||
3601 request->header.type == OFPT10_STATS_REPLY);
3603 nxst_subtype = (request->type != htons(OFPST_VENDOR)
3605 : ((const struct nicira_stats_msg *) request)->subtype);
3606 ofputil_put_stats_header(request->header.xid, OFPT10_STATS_REPLY,
3607 request->type, nxst_subtype, msg);
3610 /* Creates a statistics reply message with total length 'openflow_len'
3611 * (including all headers) and the same type (either a standard OpenFlow
3612 * statistics type or a Nicira extension type and subtype) as 'request', and
3613 * stores the buffer containing the new message in '*bufferp'.
3615 * Initializes bytes following the headers to all-bits-zero.
3617 * Returns the first byte of the new message. */
3619 ofputil_make_stats_reply(size_t openflow_len,
3620 const struct ofp_stats_msg *request,
3621 struct ofpbuf **bufferp)
3625 msg = *bufferp = ofpbuf_new(openflow_len);
3626 put_stats_reply__(request, msg);
3627 ofpbuf_padto(msg, openflow_len);
3632 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
3633 * replies to 'request', which should be an OpenFlow or Nicira extension
3634 * statistics request. Initially 'replies' will have a single reply message
3635 * that has only a header. The functions ofputil_reserve_stats_reply() and
3636 * ofputil_append_stats_reply() may be used to add to the reply. */
3638 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
3639 struct list *replies)
3643 msg = ofpbuf_new(1024);
3644 put_stats_reply__(request, msg);
3647 list_push_back(replies, &msg->list_node);
3650 /* Prepares to append up to 'len' bytes to the series of statistics replies in
3651 * 'replies', which should have been initialized with
3652 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
3653 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
3654 * do so with e.g. ofpbuf_put_uninit().) */
3656 ofputil_reserve_stats_reply(size_t len, struct list *replies)
3658 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3659 struct ofp_stats_msg *osm = msg->data;
3661 if (msg->size + len <= UINT16_MAX) {
3662 ofpbuf_prealloc_tailroom(msg, len);
3664 osm->flags |= htons(OFPSF_REPLY_MORE);
3666 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
3667 put_stats_reply__(osm, msg);
3668 list_push_back(replies, &msg->list_node);
3673 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
3674 * returns the first byte. */
3676 ofputil_append_stats_reply(size_t len, struct list *replies)
3678 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
3681 /* Sometimes, when composing stats replies, it's difficult to predict how long
3682 * an individual reply chunk will be before actually encoding it into the reply
3683 * buffer. This function allows easy handling of this case: just encode the
3684 * reply, then use this function to break the message into two pieces if it
3685 * exceeds the OpenFlow message limit.
3687 * In detail, if the final stats message in 'replies' is too long for OpenFlow,
3688 * this function breaks it into two separate stats replies, the first one with
3689 * the first 'start_ofs' bytes, the second one containing the bytes from that
3692 ofputil_postappend_stats_reply(size_t start_ofs, struct list *replies)
3694 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3696 assert(start_ofs <= UINT16_MAX);
3697 if (msg->size > UINT16_MAX) {
3698 size_t len = msg->size - start_ofs;
3699 memcpy(ofputil_append_stats_reply(len, replies),
3700 (const uint8_t *) msg->data + start_ofs, len);
3701 msg->size = start_ofs;
3705 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
3707 ofputil_stats_body(const struct ofp_header *oh)
3709 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3710 return (const struct ofp_stats_msg *) oh + 1;
3713 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
3715 ofputil_stats_body_len(const struct ofp_header *oh)
3717 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3718 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
3721 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
3723 ofputil_nxstats_body(const struct ofp_header *oh)
3725 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3726 return ((const struct nicira_stats_msg *) oh) + 1;
3729 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
3731 ofputil_nxstats_body_len(const struct ofp_header *oh)
3733 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3734 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
3737 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3739 make_echo_request(void)
3741 struct ofp_header *rq;
3742 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
3743 rq = ofpbuf_put_uninit(out, sizeof *rq);
3744 rq->version = OFP10_VERSION;
3745 rq->type = OFPT_ECHO_REQUEST;
3746 rq->length = htons(sizeof *rq);
3751 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3752 * OFPT_ECHO_REQUEST message in 'rq'. */
3754 make_echo_reply(const struct ofp_header *rq)
3756 size_t size = ntohs(rq->length);
3757 struct ofpbuf *out = ofpbuf_new(size);
3758 struct ofp_header *reply = ofpbuf_put(out, rq, size);
3759 reply->type = OFPT_ECHO_REPLY;
3764 ofputil_encode_barrier_request(void)
3768 make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
3773 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3775 switch (flags & OFPC_FRAG_MASK) {
3776 case OFPC_FRAG_NORMAL: return "normal";
3777 case OFPC_FRAG_DROP: return "drop";
3778 case OFPC_FRAG_REASM: return "reassemble";
3779 case OFPC_FRAG_NX_MATCH: return "nx-match";
3786 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3788 if (!strcasecmp(s, "normal")) {
3789 *flags = OFPC_FRAG_NORMAL;
3790 } else if (!strcasecmp(s, "drop")) {
3791 *flags = OFPC_FRAG_DROP;
3792 } else if (!strcasecmp(s, "reassemble")) {
3793 *flags = OFPC_FRAG_REASM;
3794 } else if (!strcasecmp(s, "nx-match")) {
3795 *flags = OFPC_FRAG_NX_MATCH;
3802 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3803 * port number and stores the latter in '*ofp10_port', for the purpose of
3804 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3805 * otherwise an OFPERR_* number.
3807 * See the definition of OFP11_MAX for an explanation of the mapping. */
3809 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3811 uint32_t ofp11_port_h = ntohl(ofp11_port);
3813 if (ofp11_port_h < OFPP_MAX) {
3814 *ofp10_port = ofp11_port_h;
3816 } else if (ofp11_port_h >= OFPP11_MAX) {
3817 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3820 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3821 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3822 ofp11_port_h, OFPP_MAX - 1,
3823 (uint32_t) OFPP11_MAX, UINT32_MAX);
3824 return OFPERR_OFPBAC_BAD_OUT_PORT;
3828 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3829 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3831 * See the definition of OFP11_MAX for an explanation of the mapping. */
3833 ofputil_port_to_ofp11(uint16_t ofp10_port)
3835 return htonl(ofp10_port < OFPP_MAX
3837 : ofp10_port + OFPP11_OFFSET);
3840 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3841 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3842 * 'port' is valid, otherwise an OpenFlow return code. */
3844 ofputil_check_output_port(uint16_t port, int max_ports)
3852 case OFPP_CONTROLLER:
3858 if (port < max_ports) {
3861 return OFPERR_OFPBAC_BAD_OUT_PORT;
3865 #define OFPUTIL_NAMED_PORTS \
3866 OFPUTIL_NAMED_PORT(IN_PORT) \
3867 OFPUTIL_NAMED_PORT(TABLE) \
3868 OFPUTIL_NAMED_PORT(NORMAL) \
3869 OFPUTIL_NAMED_PORT(FLOOD) \
3870 OFPUTIL_NAMED_PORT(ALL) \
3871 OFPUTIL_NAMED_PORT(CONTROLLER) \
3872 OFPUTIL_NAMED_PORT(LOCAL) \
3873 OFPUTIL_NAMED_PORT(NONE)
3875 /* Checks whether 's' is the string representation of an OpenFlow port number,
3876 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3877 * number in '*port' and returns true. Otherwise, returns false. */
3879 ofputil_port_from_string(const char *name, uint16_t *port)
3885 static const struct pair pairs[] = {
3886 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3888 #undef OFPUTIL_NAMED_PORT
3890 static const int n_pairs = ARRAY_SIZE(pairs);
3893 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3898 for (i = 0; i < n_pairs; i++) {
3899 if (!strcasecmp(name, pairs[i].name)) {
3900 *port = pairs[i].value;
3907 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3908 * Most ports' string representation is just the port number, but for special
3909 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3911 ofputil_format_port(uint16_t port, struct ds *s)
3916 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3918 #undef OFPUTIL_NAMED_PORT
3921 ds_put_format(s, "%"PRIu16, port);
3924 ds_put_cstr(s, name);
3927 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3928 * 'ofp_version', tries to pull the first element from the array. If
3929 * successful, initializes '*pp' with an abstract representation of the
3930 * port and returns 0. If no ports remain to be decoded, returns EOF.
3931 * On an error, returns a positive OFPERR_* value. */
3933 ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
3934 struct ofputil_phy_port *pp)
3936 if (ofp_version == OFP10_VERSION) {
3937 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
3938 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
3940 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
3941 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
3945 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
3946 * 'ofp_version', returns the number of elements. */
3947 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *b)
3949 return b->size / ofputil_get_phy_port_size(ofp_version);
3952 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3953 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3954 * 'name' is not the name of any action.
3956 * ofp-util.def lists the mapping from names to action. */
3958 ofputil_action_code_from_name(const char *name)
3960 static const char *names[OFPUTIL_N_ACTIONS] = {
3962 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3963 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) NAME,
3964 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3965 #include "ofp-util.def"
3970 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3971 if (*p && !strcasecmp(name, *p)) {
3978 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3979 * action. Initializes the parts of 'action' that identify it as having type
3980 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3981 * have variable length, the length used and cleared is that of struct
3984 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3987 case OFPUTIL_ACTION_INVALID:
3990 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3991 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3992 #define OFPAT11_ACTION OFPAT10_ACTION
3993 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3994 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3995 #include "ofp-util.def"
4000 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
4002 ofputil_init_##ENUM(struct STRUCT *s) \
4004 memset(s, 0, sizeof *s); \
4005 s->type = htons(ENUM); \
4006 s->len = htons(sizeof *s); \
4010 ofputil_put_##ENUM(struct ofpbuf *buf) \
4012 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4013 ofputil_init_##ENUM(s); \
4016 #define OFPAT11_ACTION OFPAT10_ACTION
4017 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
4019 ofputil_init_##ENUM(struct STRUCT *s) \
4021 memset(s, 0, sizeof *s); \
4022 s->type = htons(OFPAT10_VENDOR); \
4023 s->len = htons(sizeof *s); \
4024 s->vendor = htonl(NX_VENDOR_ID); \
4025 s->subtype = htons(ENUM); \
4029 ofputil_put_##ENUM(struct ofpbuf *buf) \
4031 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
4032 ofputil_init_##ENUM(s); \
4035 #include "ofp-util.def"
4037 /* "Normalizes" the wildcards in 'rule'. That means:
4039 * 1. If the type of level N is known, then only the valid fields for that
4040 * level may be specified. For example, ARP does not have a TOS field,
4041 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
4042 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
4043 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
4046 * 2. If the type of level N is not known (or not understood by Open
4047 * vSwitch), then no fields at all for that level may be specified. For
4048 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
4049 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
4053 ofputil_normalize_rule(struct cls_rule *rule)
4056 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
4057 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
4058 MAY_NW_PROTO = 1 << 2, /* nw_proto */
4059 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
4060 MAY_ARP_SHA = 1 << 4, /* arp_sha */
4061 MAY_ARP_THA = 1 << 5, /* arp_tha */
4062 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
4063 MAY_ND_TARGET = 1 << 7 /* nd_target */
4066 struct flow_wildcards wc;
4068 /* Figure out what fields may be matched. */
4069 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
4070 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
4071 if (rule->flow.nw_proto == IPPROTO_TCP ||
4072 rule->flow.nw_proto == IPPROTO_UDP ||
4073 rule->flow.nw_proto == IPPROTO_ICMP) {
4074 may_match |= MAY_TP_ADDR;
4076 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
4077 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
4078 if (rule->flow.nw_proto == IPPROTO_TCP ||
4079 rule->flow.nw_proto == IPPROTO_UDP) {
4080 may_match |= MAY_TP_ADDR;
4081 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
4082 may_match |= MAY_TP_ADDR;
4083 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
4084 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
4085 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
4086 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
4089 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
4090 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
4095 /* Clear the fields that may not be matched. */
4097 if (!(may_match & MAY_NW_ADDR)) {
4098 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
4100 if (!(may_match & MAY_TP_ADDR)) {
4101 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
4103 if (!(may_match & MAY_NW_PROTO)) {
4104 wc.wildcards |= FWW_NW_PROTO;
4106 if (!(may_match & MAY_IPVx)) {
4107 wc.wildcards |= FWW_NW_DSCP;
4108 wc.wildcards |= FWW_NW_ECN;
4109 wc.wildcards |= FWW_NW_TTL;
4111 if (!(may_match & MAY_ARP_SHA)) {
4112 wc.wildcards |= FWW_ARP_SHA;
4114 if (!(may_match & MAY_ARP_THA)) {
4115 wc.wildcards |= FWW_ARP_THA;
4117 if (!(may_match & MAY_IPV6)) {
4118 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
4119 wc.wildcards |= FWW_IPV6_LABEL;
4121 if (!(may_match & MAY_ND_TARGET)) {
4122 wc.nd_target_mask = in6addr_any;
4125 /* Log any changes. */
4126 if (!flow_wildcards_equal(&wc, &rule->wc)) {
4127 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
4128 char *pre = log ? cls_rule_to_string(rule) : NULL;
4131 cls_rule_zero_wildcarded_fields(rule);
4134 char *post = cls_rule_to_string(rule);
4135 VLOG_INFO("normalization changed ofp_match, details:");
4136 VLOG_INFO(" pre: %s", pre);
4137 VLOG_INFO("post: %s", post);
4144 /* Parses a key or a key-value pair from '*stringp'.
4146 * On success: Stores the key into '*keyp'. Stores the value, if present, into
4147 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
4148 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
4149 * are substrings of '*stringp' created by replacing some of its bytes by null
4150 * terminators. Returns true.
4152 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
4153 * NULL and returns false. */
4155 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
4157 char *pos, *key, *value;
4161 pos += strspn(pos, ", \t\r\n");
4163 *keyp = *valuep = NULL;
4168 key_len = strcspn(pos, ":=(, \t\r\n");
4169 if (key[key_len] == ':' || key[key_len] == '=') {
4170 /* The value can be separated by a colon. */
4173 value = key + key_len + 1;
4174 value_len = strcspn(value, ", \t\r\n");
4175 pos = value + value_len + (value[value_len] != '\0');
4176 value[value_len] = '\0';
4177 } else if (key[key_len] == '(') {
4178 /* The value can be surrounded by balanced parentheses. The outermost
4179 * set of parentheses is removed. */
4183 value = key + key_len + 1;
4184 for (value_len = 0; level > 0; value_len++) {
4185 switch (value[value_len]) {
4199 value[value_len - 1] = '\0';
4200 pos = value + value_len;
4202 /* There might be no value at all. */
4203 value = key + key_len; /* Will become the empty string below. */
4204 pos = key + key_len + (key[key_len] != '\0');
4206 key[key_len] = '\0';