2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "ofp-print.h"
21 #include <sys/types.h>
22 #include <netinet/in.h>
23 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-errors.h"
40 #include "unaligned.h"
41 #include "type-props.h"
44 VLOG_DEFINE_THIS_MODULE(ofp_util);
46 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
47 * in the peer and so there's not much point in showing a lot of them. */
48 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
50 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
51 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
54 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
55 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
56 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
57 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
60 ofputil_wcbits_to_netmask(int wcbits)
63 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
66 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
67 * that it wildcards, that is, the number of 0-bits in 'netmask'. 'netmask'
68 * must be a CIDR netmask (see ip_is_cidr()). */
70 ofputil_netmask_to_wcbits(ovs_be32 netmask)
72 return 32 - ip_count_cidr_bits(netmask);
75 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
77 #define WC_INVARIANT_LIST \
78 WC_INVARIANT_BIT(IN_PORT) \
79 WC_INVARIANT_BIT(DL_SRC) \
80 WC_INVARIANT_BIT(DL_DST) \
81 WC_INVARIANT_BIT(DL_TYPE) \
82 WC_INVARIANT_BIT(NW_PROTO)
84 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
85 * actually have the same names and values. */
86 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
88 #undef WC_INVARIANT_BIT
90 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
92 static const flow_wildcards_t WC_INVARIANTS = 0
93 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
95 #undef WC_INVARIANT_BIT
98 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
99 * struct cls_rule. It is the caller's responsibility to handle the special
100 * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
102 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
104 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 10);
106 /* Initialize most of rule->wc. */
107 flow_wildcards_init_catchall(wc);
108 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
110 /* Wildcard fields that aren't defined by ofp_match or tun_id. */
111 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_NW_ECN | FWW_NW_TTL
114 if (ofpfw & OFPFW_NW_TOS) {
115 /* OpenFlow 1.0 defines a TOS wildcard, but it's much later in
116 * the enum than we can use. */
117 wc->wildcards |= FWW_NW_DSCP;
120 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
121 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
123 if (!(ofpfw & OFPFW_TP_SRC)) {
124 wc->tp_src_mask = htons(UINT16_MAX);
126 if (!(ofpfw & OFPFW_TP_DST)) {
127 wc->tp_dst_mask = htons(UINT16_MAX);
130 if (ofpfw & OFPFW_DL_DST) {
131 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
132 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
133 * and FWW_ETH_MCAST. */
134 wc->wildcards |= FWW_ETH_MCAST;
138 if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
139 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
141 if (!(ofpfw & OFPFW_DL_VLAN)) {
142 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
146 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
149 ofputil_cls_rule_from_match(const struct ofp_match *match,
150 unsigned int priority, struct cls_rule *rule)
152 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
154 /* Initialize rule->priority, rule->wc. */
155 rule->priority = !ofpfw ? UINT16_MAX : priority;
156 ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
158 /* Initialize most of rule->flow. */
159 rule->flow.nw_src = match->nw_src;
160 rule->flow.nw_dst = match->nw_dst;
161 rule->flow.in_port = ntohs(match->in_port);
162 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
163 rule->flow.tp_src = match->tp_src;
164 rule->flow.tp_dst = match->tp_dst;
165 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
166 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
167 rule->flow.nw_tos = match->nw_tos & IP_DSCP_MASK;
168 rule->flow.nw_proto = match->nw_proto;
170 /* Translate VLANs. */
171 if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
172 /* Match only packets without 802.1Q header.
174 * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
176 * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
177 * because we can't have a specific PCP without an 802.1Q header.
178 * However, older versions of OVS treated this as matching packets
179 * withut an 802.1Q header, so we do here too. */
180 rule->flow.vlan_tci = htons(0);
181 rule->wc.vlan_tci_mask = htons(0xffff);
183 ovs_be16 vid, pcp, tci;
185 vid = match->dl_vlan & htons(VLAN_VID_MASK);
186 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
187 tci = vid | pcp | htons(VLAN_CFI);
188 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
192 cls_rule_zero_wildcarded_fields(rule);
195 /* Convert 'rule' into the OpenFlow match structure 'match'. */
197 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
199 const struct flow_wildcards *wc = &rule->wc;
202 /* Figure out most OpenFlow wildcards. */
203 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
204 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
205 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
206 if (wc->wildcards & FWW_NW_DSCP) {
207 ofpfw |= OFPFW_NW_TOS;
209 if (!wc->tp_src_mask) {
210 ofpfw |= OFPFW_TP_SRC;
212 if (!wc->tp_dst_mask) {
213 ofpfw |= OFPFW_TP_DST;
216 /* Translate VLANs. */
217 match->dl_vlan = htons(0);
218 match->dl_vlan_pcp = 0;
219 if (rule->wc.vlan_tci_mask == htons(0)) {
220 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
221 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
222 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
223 match->dl_vlan = htons(OFP_VLAN_NONE);
225 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
226 ofpfw |= OFPFW_DL_VLAN;
228 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
231 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
232 ofpfw |= OFPFW_DL_VLAN_PCP;
234 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
238 /* Compose most of the match structure. */
239 match->wildcards = htonl(ofpfw);
240 match->in_port = htons(rule->flow.in_port);
241 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
242 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
243 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
244 match->nw_src = rule->flow.nw_src;
245 match->nw_dst = rule->flow.nw_dst;
246 match->nw_tos = rule->flow.nw_tos & IP_DSCP_MASK;
247 match->nw_proto = rule->flow.nw_proto;
248 match->tp_src = rule->flow.tp_src;
249 match->tp_dst = rule->flow.tp_dst;
250 memset(match->pad1, '\0', sizeof match->pad1);
251 memset(match->pad2, '\0', sizeof match->pad2);
254 /* Given a 'dl_type' value in the format used in struct flow, returns the
255 * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
257 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
259 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
260 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
264 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
265 * structure, returns the corresponding 'dl_type' value for use in struct
268 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
270 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
271 ? htons(FLOW_DL_TYPE_NONE)
275 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
279 static uint32_t next_xid = 1;
280 return htonl(next_xid++);
283 /* Basic parsing of OpenFlow messages. */
285 struct ofputil_msg_type {
286 enum ofputil_msg_code code; /* OFPUTIL_*. */
287 uint8_t ofp_version; /* An OpenFlow version or 0 for "any". */
288 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
289 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
290 unsigned int min_size; /* Minimum total message size in bytes. */
291 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
292 * the message may exceed 'min_size' by an even multiple of this value. */
293 unsigned int extra_multiple;
296 /* Represents a malformed OpenFlow message. */
297 static const struct ofputil_msg_type ofputil_invalid_type = {
298 OFPUTIL_MSG_INVALID, 0, 0, "OFPUTIL_MSG_INVALID", 0, 0
301 struct ofputil_msg_category {
302 const char *name; /* e.g. "OpenFlow message" */
303 const struct ofputil_msg_type *types;
305 enum ofperr missing_error; /* Error value for missing type. */
309 ofputil_check_length(const struct ofputil_msg_type *type, unsigned int size)
311 switch (type->extra_multiple) {
313 if (size != type->min_size) {
314 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
315 "length %u (expected length %u)",
316 type->name, size, type->min_size);
317 return OFPERR_OFPBRC_BAD_LEN;
322 if (size < type->min_size) {
323 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
324 "length %u (expected length at least %u bytes)",
325 type->name, size, type->min_size);
326 return OFPERR_OFPBRC_BAD_LEN;
331 if (size < type->min_size
332 || (size - type->min_size) % type->extra_multiple) {
333 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s with incorrect "
334 "length %u (must be exactly %u bytes or longer "
335 "by an integer multiple of %u bytes)",
337 type->min_size, type->extra_multiple);
338 return OFPERR_OFPBRC_BAD_LEN;
345 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
346 uint8_t version, uint32_t value,
347 const struct ofputil_msg_type **typep)
349 const struct ofputil_msg_type *type;
351 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
352 if (type->value == value
353 && (!type->ofp_version || version == type->ofp_version)) {
359 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
361 return cat->missing_error;
365 ofputil_decode_vendor(const struct ofp_header *oh, size_t length,
366 const struct ofputil_msg_type **typep)
368 static const struct ofputil_msg_type nxt_messages[] = {
369 { OFPUTIL_NXT_ROLE_REQUEST, OFP10_VERSION,
370 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
371 sizeof(struct nx_role_request), 0 },
373 { OFPUTIL_NXT_ROLE_REPLY, OFP10_VERSION,
374 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
375 sizeof(struct nx_role_request), 0 },
377 { OFPUTIL_NXT_SET_FLOW_FORMAT, OFP10_VERSION,
378 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
379 sizeof(struct nx_set_flow_format), 0 },
381 { OFPUTIL_NXT_SET_PACKET_IN_FORMAT, OFP10_VERSION,
382 NXT_SET_PACKET_IN_FORMAT, "NXT_SET_PACKET_IN_FORMAT",
383 sizeof(struct nx_set_packet_in_format), 0 },
385 { OFPUTIL_NXT_PACKET_IN, OFP10_VERSION,
386 NXT_PACKET_IN, "NXT_PACKET_IN",
387 sizeof(struct nx_packet_in), 1 },
389 { OFPUTIL_NXT_FLOW_MOD, OFP10_VERSION,
390 NXT_FLOW_MOD, "NXT_FLOW_MOD",
391 sizeof(struct nx_flow_mod), 8 },
393 { OFPUTIL_NXT_FLOW_REMOVED, OFP10_VERSION,
394 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
395 sizeof(struct nx_flow_removed), 8 },
397 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID, OFP10_VERSION,
398 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
399 sizeof(struct nx_flow_mod_table_id), 0 },
401 { OFPUTIL_NXT_FLOW_AGE, OFP10_VERSION,
402 NXT_FLOW_AGE, "NXT_FLOW_AGE",
403 sizeof(struct nicira_header), 0 },
405 { OFPUTIL_NXT_SET_ASYNC_CONFIG, OFP10_VERSION,
406 NXT_SET_ASYNC_CONFIG, "NXT_SET_ASYNC_CONFIG",
407 sizeof(struct nx_async_config), 0 },
409 { OFPUTIL_NXT_SET_CONTROLLER_ID, OFP10_VERSION,
410 NXT_SET_CONTROLLER_ID, "NXT_SET_CONTROLLER_ID",
411 sizeof(struct nx_controller_id), 0 },
414 static const struct ofputil_msg_category nxt_category = {
415 "Nicira extension message",
416 nxt_messages, ARRAY_SIZE(nxt_messages),
417 OFPERR_OFPBRC_BAD_SUBTYPE
420 const struct ofp_vendor_header *ovh;
421 const struct nicira_header *nh;
423 if (length < sizeof(struct ofp_vendor_header)) {
424 if (length == ntohs(oh->length)) {
425 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor message");
427 return OFPERR_OFPBRC_BAD_LEN;
430 ovh = (const struct ofp_vendor_header *) oh;
431 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
432 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
433 "vendor %"PRIx32, ntohl(ovh->vendor));
434 return OFPERR_OFPBRC_BAD_VENDOR;
437 if (length < sizeof(struct nicira_header)) {
438 if (length == ntohs(oh->length)) {
439 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
440 "length %u (expected at least %zu)",
441 ntohs(ovh->header.length),
442 sizeof(struct nicira_header));
444 return OFPERR_OFPBRC_BAD_LEN;
447 nh = (const struct nicira_header *) oh;
448 return ofputil_lookup_openflow_message(&nxt_category, oh->version,
449 ntohl(nh->subtype), typep);
453 check_nxstats_msg(const struct ofp_header *oh, size_t length)
455 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
458 if (length < sizeof(struct ofp_vendor_stats_msg)) {
459 if (length == ntohs(oh->length)) {
460 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated vendor stats message");
462 return OFPERR_OFPBRC_BAD_LEN;
465 memcpy(&vendor, osm + 1, sizeof vendor);
466 if (vendor != htonl(NX_VENDOR_ID)) {
467 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
468 "unknown vendor %"PRIx32, ntohl(vendor));
469 return OFPERR_OFPBRC_BAD_VENDOR;
472 if (length < sizeof(struct nicira_stats_msg)) {
473 if (length == ntohs(osm->header.length)) {
474 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
476 return OFPERR_OFPBRC_BAD_LEN;
483 ofputil_decode_nxst_request(const struct ofp_header *oh, size_t length,
484 const struct ofputil_msg_type **typep)
486 static const struct ofputil_msg_type nxst_requests[] = {
487 { OFPUTIL_NXST_FLOW_REQUEST, OFP10_VERSION,
488 NXST_FLOW, "NXST_FLOW request",
489 sizeof(struct nx_flow_stats_request), 8 },
491 { OFPUTIL_NXST_AGGREGATE_REQUEST, OFP10_VERSION,
492 NXST_AGGREGATE, "NXST_AGGREGATE request",
493 sizeof(struct nx_aggregate_stats_request), 8 },
496 static const struct ofputil_msg_category nxst_request_category = {
497 "Nicira extension statistics request",
498 nxst_requests, ARRAY_SIZE(nxst_requests),
499 OFPERR_OFPBRC_BAD_SUBTYPE
502 const struct nicira_stats_msg *nsm;
505 error = check_nxstats_msg(oh, length);
510 nsm = (struct nicira_stats_msg *) oh;
511 return ofputil_lookup_openflow_message(&nxst_request_category, oh->version,
512 ntohl(nsm->subtype), typep);
516 ofputil_decode_nxst_reply(const struct ofp_header *oh, size_t length,
517 const struct ofputil_msg_type **typep)
519 static const struct ofputil_msg_type nxst_replies[] = {
520 { OFPUTIL_NXST_FLOW_REPLY, OFP10_VERSION,
521 NXST_FLOW, "NXST_FLOW reply",
522 sizeof(struct nicira_stats_msg), 8 },
524 { OFPUTIL_NXST_AGGREGATE_REPLY, OFP10_VERSION,
525 NXST_AGGREGATE, "NXST_AGGREGATE reply",
526 sizeof(struct nx_aggregate_stats_reply), 0 },
529 static const struct ofputil_msg_category nxst_reply_category = {
530 "Nicira extension statistics reply",
531 nxst_replies, ARRAY_SIZE(nxst_replies),
532 OFPERR_OFPBRC_BAD_SUBTYPE
535 const struct nicira_stats_msg *nsm;
538 error = check_nxstats_msg(oh, length);
543 nsm = (struct nicira_stats_msg *) oh;
544 return ofputil_lookup_openflow_message(&nxst_reply_category, oh->version,
545 ntohl(nsm->subtype), typep);
549 check_stats_msg(const struct ofp_header *oh, size_t length)
551 if (length < sizeof(struct ofp_stats_msg)) {
552 if (length == ntohs(oh->length)) {
553 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated stats message");
555 return OFPERR_OFPBRC_BAD_LEN;
562 ofputil_decode_ofpst_request(const struct ofp_header *oh, size_t length,
563 const struct ofputil_msg_type **typep)
565 static const struct ofputil_msg_type ofpst_requests[] = {
566 { OFPUTIL_OFPST_DESC_REQUEST, OFP10_VERSION,
567 OFPST_DESC, "OFPST_DESC request",
568 sizeof(struct ofp_stats_msg), 0 },
570 { OFPUTIL_OFPST_FLOW_REQUEST, OFP10_VERSION,
571 OFPST_FLOW, "OFPST_FLOW request",
572 sizeof(struct ofp_flow_stats_request), 0 },
574 { OFPUTIL_OFPST_AGGREGATE_REQUEST, OFP10_VERSION,
575 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
576 sizeof(struct ofp_flow_stats_request), 0 },
578 { OFPUTIL_OFPST_TABLE_REQUEST, OFP10_VERSION,
579 OFPST_TABLE, "OFPST_TABLE request",
580 sizeof(struct ofp_stats_msg), 0 },
582 { OFPUTIL_OFPST_PORT_REQUEST, OFP10_VERSION,
583 OFPST_PORT, "OFPST_PORT request",
584 sizeof(struct ofp_port_stats_request), 0 },
586 { OFPUTIL_OFPST_QUEUE_REQUEST, OFP10_VERSION,
587 OFPST_QUEUE, "OFPST_QUEUE request",
588 sizeof(struct ofp_queue_stats_request), 0 },
591 OFPST_VENDOR, "OFPST_VENDOR request",
592 sizeof(struct ofp_vendor_stats_msg), 1 },
595 static const struct ofputil_msg_category ofpst_request_category = {
596 "OpenFlow statistics",
597 ofpst_requests, ARRAY_SIZE(ofpst_requests),
598 OFPERR_OFPBRC_BAD_STAT
601 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
604 error = check_stats_msg(oh, length);
609 error = ofputil_lookup_openflow_message(&ofpst_request_category,
610 oh->version, ntohs(request->type),
612 if (!error && request->type == htons(OFPST_VENDOR)) {
613 error = ofputil_decode_nxst_request(oh, length, typep);
619 ofputil_decode_ofpst_reply(const struct ofp_header *oh, size_t length,
620 const struct ofputil_msg_type **typep)
622 static const struct ofputil_msg_type ofpst_replies[] = {
623 { OFPUTIL_OFPST_DESC_REPLY, OFP10_VERSION,
624 OFPST_DESC, "OFPST_DESC reply",
625 sizeof(struct ofp_desc_stats), 0 },
627 { OFPUTIL_OFPST_FLOW_REPLY, OFP10_VERSION,
628 OFPST_FLOW, "OFPST_FLOW reply",
629 sizeof(struct ofp_stats_msg), 1 },
631 { OFPUTIL_OFPST_AGGREGATE_REPLY, OFP10_VERSION,
632 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
633 sizeof(struct ofp_aggregate_stats_reply), 0 },
635 { OFPUTIL_OFPST_TABLE_REPLY, OFP10_VERSION,
636 OFPST_TABLE, "OFPST_TABLE reply",
637 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
639 { OFPUTIL_OFPST_PORT_REPLY, OFP10_VERSION,
640 OFPST_PORT, "OFPST_PORT reply",
641 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
643 { OFPUTIL_OFPST_QUEUE_REPLY, OFP10_VERSION,
644 OFPST_QUEUE, "OFPST_QUEUE reply",
645 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
648 OFPST_VENDOR, "OFPST_VENDOR reply",
649 sizeof(struct ofp_vendor_stats_msg), 1 },
652 static const struct ofputil_msg_category ofpst_reply_category = {
653 "OpenFlow statistics",
654 ofpst_replies, ARRAY_SIZE(ofpst_replies),
655 OFPERR_OFPBRC_BAD_STAT
658 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
661 error = check_stats_msg(oh, length);
666 error = ofputil_lookup_openflow_message(&ofpst_reply_category, oh->version,
667 ntohs(reply->type), typep);
668 if (!error && reply->type == htons(OFPST_VENDOR)) {
669 error = ofputil_decode_nxst_reply(oh, length, typep);
675 ofputil_decode_msg_type__(const struct ofp_header *oh, size_t length,
676 const struct ofputil_msg_type **typep)
678 static const struct ofputil_msg_type ofpt_messages[] = {
679 { OFPUTIL_OFPT_HELLO, OFP10_VERSION,
680 OFPT_HELLO, "OFPT_HELLO",
681 sizeof(struct ofp_hello), 1 },
683 { OFPUTIL_OFPT_ERROR, 0,
684 OFPT_ERROR, "OFPT_ERROR",
685 sizeof(struct ofp_error_msg), 1 },
687 { OFPUTIL_OFPT_ECHO_REQUEST, OFP10_VERSION,
688 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
689 sizeof(struct ofp_header), 1 },
691 { OFPUTIL_OFPT_ECHO_REPLY, OFP10_VERSION,
692 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
693 sizeof(struct ofp_header), 1 },
695 { OFPUTIL_OFPT_FEATURES_REQUEST, OFP10_VERSION,
696 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
697 sizeof(struct ofp_header), 0 },
699 { OFPUTIL_OFPT_FEATURES_REPLY, OFP10_VERSION,
700 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
701 sizeof(struct ofp_switch_features), sizeof(struct ofp10_phy_port) },
702 { OFPUTIL_OFPT_FEATURES_REPLY, OFP11_VERSION,
703 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
704 sizeof(struct ofp_switch_features), sizeof(struct ofp11_port) },
706 { OFPUTIL_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION,
707 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
708 sizeof(struct ofp_header), 0 },
710 { OFPUTIL_OFPT_GET_CONFIG_REPLY, OFP10_VERSION,
711 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
712 sizeof(struct ofp_switch_config), 0 },
714 { OFPUTIL_OFPT_SET_CONFIG, OFP10_VERSION,
715 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
716 sizeof(struct ofp_switch_config), 0 },
718 { OFPUTIL_OFPT_PACKET_IN, OFP10_VERSION,
719 OFPT_PACKET_IN, "OFPT_PACKET_IN",
720 offsetof(struct ofp_packet_in, data), 1 },
722 { OFPUTIL_OFPT_FLOW_REMOVED, OFP10_VERSION,
723 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
724 sizeof(struct ofp_flow_removed), 0 },
726 { OFPUTIL_OFPT_PORT_STATUS, OFP10_VERSION,
727 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
728 sizeof(struct ofp_port_status) + sizeof(struct ofp10_phy_port), 0 },
729 { OFPUTIL_OFPT_PORT_STATUS, OFP11_VERSION,
730 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
731 sizeof(struct ofp_port_status) + sizeof(struct ofp11_port), 0 },
733 { OFPUTIL_OFPT_PACKET_OUT, OFP10_VERSION,
734 OFPT10_PACKET_OUT, "OFPT_PACKET_OUT",
735 sizeof(struct ofp_packet_out), 1 },
737 { OFPUTIL_OFPT_FLOW_MOD, OFP10_VERSION,
738 OFPT10_FLOW_MOD, "OFPT_FLOW_MOD",
739 sizeof(struct ofp_flow_mod), 1 },
741 { OFPUTIL_OFPT_PORT_MOD, OFP10_VERSION,
742 OFPT10_PORT_MOD, "OFPT_PORT_MOD",
743 sizeof(struct ofp10_port_mod), 0 },
744 { OFPUTIL_OFPT_PORT_MOD, OFP11_VERSION,
745 OFPT11_PORT_MOD, "OFPT_PORT_MOD",
746 sizeof(struct ofp11_port_mod), 0 },
749 OFPT10_STATS_REQUEST, "OFPT_STATS_REQUEST",
750 sizeof(struct ofp_stats_msg), 1 },
753 OFPT10_STATS_REPLY, "OFPT_STATS_REPLY",
754 sizeof(struct ofp_stats_msg), 1 },
756 { OFPUTIL_OFPT_BARRIER_REQUEST, OFP10_VERSION,
757 OFPT10_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
758 sizeof(struct ofp_header), 0 },
760 { OFPUTIL_OFPT_BARRIER_REPLY, OFP10_VERSION,
761 OFPT10_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
762 sizeof(struct ofp_header), 0 },
765 OFPT_VENDOR, "OFPT_VENDOR",
766 sizeof(struct ofp_vendor_header), 1 },
769 static const struct ofputil_msg_category ofpt_category = {
771 ofpt_messages, ARRAY_SIZE(ofpt_messages),
772 OFPERR_OFPBRC_BAD_TYPE
777 error = ofputil_lookup_openflow_message(&ofpt_category, oh->version,
780 switch ((oh->version << 8) | oh->type) {
781 case (OFP10_VERSION << 8) | OFPT_VENDOR:
782 case (OFP11_VERSION << 8) | OFPT_VENDOR:
783 error = ofputil_decode_vendor(oh, length, typep);
786 case (OFP10_VERSION << 8) | OFPT10_STATS_REQUEST:
787 case (OFP11_VERSION << 8) | OFPT11_STATS_REQUEST:
788 error = ofputil_decode_ofpst_request(oh, length, typep);
791 case (OFP10_VERSION << 8) | OFPT10_STATS_REPLY:
792 case (OFP11_VERSION << 8) | OFPT11_STATS_REPLY:
793 error = ofputil_decode_ofpst_reply(oh, length, typep);
802 /* Decodes the message type represented by 'oh'. Returns 0 if successful or an
803 * OpenFlow error code on failure. Either way, stores in '*typep' a type
804 * structure that can be inspected with the ofputil_msg_type_*() functions.
806 * oh->length must indicate the correct length of the message (and must be at
807 * least sizeof(struct ofp_header)).
809 * Success indicates that 'oh' is at least as long as the minimum-length
810 * message of its type. */
812 ofputil_decode_msg_type(const struct ofp_header *oh,
813 const struct ofputil_msg_type **typep)
815 size_t length = ntohs(oh->length);
818 error = ofputil_decode_msg_type__(oh, length, typep);
820 error = ofputil_check_length(*typep, length);
823 *typep = &ofputil_invalid_type;
828 /* Decodes the message type represented by 'oh', of which only the first
829 * 'length' bytes are available. Returns 0 if successful or an OpenFlow error
830 * code on failure. Either way, stores in '*typep' a type structure that can
831 * be inspected with the ofputil_msg_type_*() functions. */
833 ofputil_decode_msg_type_partial(const struct ofp_header *oh, size_t length,
834 const struct ofputil_msg_type **typep)
838 error = (length >= sizeof *oh
839 ? ofputil_decode_msg_type__(oh, length, typep)
840 : OFPERR_OFPBRC_BAD_LEN);
842 *typep = &ofputil_invalid_type;
847 /* Returns an OFPUTIL_* message type code for 'type'. */
848 enum ofputil_msg_code
849 ofputil_msg_type_code(const struct ofputil_msg_type *type)
856 struct proto_abbrev {
857 enum ofputil_protocol protocol;
861 /* Most users really don't care about some of the differences between
862 * protocols. These abbreviations help with that. */
863 static const struct proto_abbrev proto_abbrevs[] = {
864 { OFPUTIL_P_ANY, "any" },
865 { OFPUTIL_P_OF10_ANY, "OpenFlow10" },
866 { OFPUTIL_P_NXM_ANY, "NXM" },
868 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
870 enum ofputil_protocol ofputil_flow_dump_protocols[] = {
874 size_t ofputil_n_flow_dump_protocols = ARRAY_SIZE(ofputil_flow_dump_protocols);
876 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
877 * connection that has negotiated the given 'version'. 'version' should
878 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
879 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
880 * outside the valid range. */
881 enum ofputil_protocol
882 ofputil_protocol_from_ofp_version(int version)
885 case OFP10_VERSION: return OFPUTIL_P_OF10;
890 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION or
891 * OFP11_VERSION) that corresponds to 'protocol'. */
893 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol)
897 case OFPUTIL_P_OF10_TID:
899 case OFPUTIL_P_NXM_TID:
900 return OFP10_VERSION;
906 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
909 ofputil_protocol_is_valid(enum ofputil_protocol protocol)
911 return protocol & OFPUTIL_P_ANY && is_pow2(protocol);
914 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
915 * extension turned on or off if 'enable' is true or false, respectively.
917 * This extension is only useful for protocols whose "standard" version does
918 * not allow specific tables to be modified. In particular, this is true of
919 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
920 * specifies a table ID and so there is no need for such an extension. When
921 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
922 * extension, this function just returns its 'protocol' argument unchanged
923 * regardless of the value of 'enable'. */
924 enum ofputil_protocol
925 ofputil_protocol_set_tid(enum ofputil_protocol protocol, bool enable)
929 case OFPUTIL_P_OF10_TID:
930 return enable ? OFPUTIL_P_OF10_TID : OFPUTIL_P_OF10;
933 case OFPUTIL_P_NXM_TID:
934 return enable ? OFPUTIL_P_NXM_TID : OFPUTIL_P_NXM;
941 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
942 * some extension to a standard protocol version, the return value is the
943 * standard version of that protocol without any extension. If 'protocol' is a
944 * standard protocol version, returns 'protocol' unchanged. */
945 enum ofputil_protocol
946 ofputil_protocol_to_base(enum ofputil_protocol protocol)
948 return ofputil_protocol_set_tid(protocol, false);
951 /* Returns 'new_base' with any extensions taken from 'cur'. */
952 enum ofputil_protocol
953 ofputil_protocol_set_base(enum ofputil_protocol cur,
954 enum ofputil_protocol new_base)
956 bool tid = (cur & OFPUTIL_P_TID) != 0;
960 case OFPUTIL_P_OF10_TID:
961 return ofputil_protocol_set_tid(OFPUTIL_P_OF10, tid);
964 case OFPUTIL_P_NXM_TID:
965 return ofputil_protocol_set_tid(OFPUTIL_P_NXM, tid);
972 /* Returns a string form of 'protocol', if a simple form exists (that is, if
973 * 'protocol' is either a single protocol or it is a combination of protocols
974 * that have a single abbreviation). Otherwise, returns NULL. */
976 ofputil_protocol_to_string(enum ofputil_protocol protocol)
978 const struct proto_abbrev *p;
980 /* Use a "switch" statement for single-bit names so that we get a compiler
981 * warning if we forget any. */
984 return "NXM-table_id";
986 case OFPUTIL_P_NXM_TID:
987 return "NXM+table_id";
990 return "OpenFlow10-table_id";
992 case OFPUTIL_P_OF10_TID:
993 return "OpenFlow10+table_id";
996 /* Check abbreviations. */
997 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
998 if (protocol == p->protocol) {
1006 /* Returns a string that represents 'protocols'. The return value might be a
1007 * comma-separated list if 'protocols' doesn't have a simple name. The return
1008 * value is "none" if 'protocols' is 0.
1010 * The caller must free the returned string (with free()). */
1012 ofputil_protocols_to_string(enum ofputil_protocol protocols)
1016 assert(!(protocols & ~OFPUTIL_P_ANY));
1017 if (protocols == 0) {
1018 return xstrdup("none");
1023 const struct proto_abbrev *p;
1027 ds_put_char(&s, ',');
1030 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1031 if ((protocols & p->protocol) == p->protocol) {
1032 ds_put_cstr(&s, p->name);
1033 protocols &= ~p->protocol;
1038 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1039 enum ofputil_protocol bit = 1u << i;
1041 if (protocols & bit) {
1042 ds_put_cstr(&s, ofputil_protocol_to_string(bit));
1051 return ds_steal_cstr(&s);
1054 static enum ofputil_protocol
1055 ofputil_protocol_from_string__(const char *s, size_t n)
1057 const struct proto_abbrev *p;
1060 for (i = 0; i < CHAR_BIT * sizeof(enum ofputil_protocol); i++) {
1061 enum ofputil_protocol bit = 1u << i;
1062 const char *name = ofputil_protocol_to_string(bit);
1064 if (name && n == strlen(name) && !strncasecmp(s, name, n)) {
1069 for (p = proto_abbrevs; p < &proto_abbrevs[N_PROTO_ABBREVS]; p++) {
1070 if (n == strlen(p->name) && !strncasecmp(s, p->name, n)) {
1078 /* Returns the nonempty set of protocols represented by 's', which can be a
1079 * single protocol name or abbreviation or a comma-separated list of them.
1081 * Aborts the program with an error message if 's' is invalid. */
1082 enum ofputil_protocol
1083 ofputil_protocols_from_string(const char *s)
1085 const char *orig_s = s;
1086 enum ofputil_protocol protocols;
1090 enum ofputil_protocol p;
1093 n = strcspn(s, ",");
1099 p = ofputil_protocol_from_string__(s, n);
1101 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n, s);
1109 ovs_fatal(0, "%s: no flow protocol specified", orig_s);
1115 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format)
1117 switch (packet_in_format) {
1118 case NXPIF_OPENFLOW10:
1127 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format)
1129 switch (packet_in_format) {
1130 case NXPIF_OPENFLOW10:
1131 return "openflow10";
1140 ofputil_packet_in_format_from_string(const char *s)
1142 return (!strcmp(s, "openflow10") ? NXPIF_OPENFLOW10
1143 : !strcmp(s, "nxm") ? NXPIF_NXM
1148 regs_fully_wildcarded(const struct flow_wildcards *wc)
1152 for (i = 0; i < FLOW_N_REGS; i++) {
1153 if (wc->reg_masks[i] != 0) {
1160 /* Returns a bit-mask of ofputil_protocols that can be used for sending 'rule'
1161 * to a switch (e.g. to add or remove a flow). Only NXM can handle tunnel IDs,
1162 * registers, or fixing the Ethernet multicast bit. Otherwise, it's better to
1163 * use OpenFlow 1.0 protocol for backward compatibility. */
1164 enum ofputil_protocol
1165 ofputil_usable_protocols(const struct cls_rule *rule)
1167 const struct flow_wildcards *wc = &rule->wc;
1169 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 10);
1171 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
1172 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
1173 return OFPUTIL_P_NXM_ANY;
1176 /* Only NXM supports matching ARP hardware addresses. */
1177 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
1178 return OFPUTIL_P_NXM_ANY;
1181 /* Only NXM supports matching IPv6 traffic. */
1182 if (!(wc->wildcards & FWW_DL_TYPE)
1183 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
1184 return OFPUTIL_P_NXM_ANY;
1187 /* Only NXM supports matching registers. */
1188 if (!regs_fully_wildcarded(wc)) {
1189 return OFPUTIL_P_NXM_ANY;
1192 /* Only NXM supports matching tun_id. */
1193 if (wc->tun_id_mask != htonll(0)) {
1194 return OFPUTIL_P_NXM_ANY;
1197 /* Only NXM supports matching fragments. */
1198 if (wc->nw_frag_mask) {
1199 return OFPUTIL_P_NXM_ANY;
1202 /* Only NXM supports matching IPv6 flow label. */
1203 if (!(wc->wildcards & FWW_IPV6_LABEL)) {
1204 return OFPUTIL_P_NXM_ANY;
1207 /* Only NXM supports matching IP ECN bits. */
1208 if (!(wc->wildcards & FWW_NW_ECN)) {
1209 return OFPUTIL_P_NXM_ANY;
1212 /* Only NXM supports matching IP TTL/hop limit. */
1213 if (!(wc->wildcards & FWW_NW_TTL)) {
1214 return OFPUTIL_P_NXM_ANY;
1217 /* Only NXM supports bitwise matching on transport port. */
1218 if ((wc->tp_src_mask && wc->tp_src_mask != htons(UINT16_MAX)) ||
1219 (wc->tp_dst_mask && wc->tp_dst_mask != htons(UINT16_MAX))) {
1220 return OFPUTIL_P_NXM_ANY;
1223 /* Other formats can express this rule. */
1224 return OFPUTIL_P_ANY;
1227 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1228 * protocol is 'current', at least partly transitions the protocol to 'want'.
1229 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1230 * connection if the switch processes the returned message correctly. (If
1231 * '*next != want' then the caller will have to iterate.)
1233 * If 'current == want', returns NULL and stores 'current' in '*next'. */
1235 ofputil_encode_set_protocol(enum ofputil_protocol current,
1236 enum ofputil_protocol want,
1237 enum ofputil_protocol *next)
1239 enum ofputil_protocol cur_base, want_base;
1240 bool cur_tid, want_tid;
1242 cur_base = ofputil_protocol_to_base(current);
1243 want_base = ofputil_protocol_to_base(want);
1244 if (cur_base != want_base) {
1245 *next = ofputil_protocol_set_base(current, want_base);
1247 switch (want_base) {
1249 return ofputil_encode_nx_set_flow_format(NXFF_NXM);
1251 case OFPUTIL_P_OF10:
1252 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10);
1254 case OFPUTIL_P_OF10_TID:
1255 case OFPUTIL_P_NXM_TID:
1260 cur_tid = (current & OFPUTIL_P_TID) != 0;
1261 want_tid = (want & OFPUTIL_P_TID) != 0;
1262 if (cur_tid != want_tid) {
1263 *next = ofputil_protocol_set_tid(current, want_tid);
1264 return ofputil_make_flow_mod_table_id(want_tid);
1267 assert(current == want);
1273 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1274 * format to 'nxff'. */
1276 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff)
1278 struct nx_set_flow_format *sff;
1281 assert(ofputil_nx_flow_format_is_valid(nxff));
1283 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
1284 sff->format = htonl(nxff);
1289 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1291 enum ofputil_protocol
1292 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format)
1294 switch (flow_format) {
1295 case NXFF_OPENFLOW10:
1296 return OFPUTIL_P_OF10;
1299 return OFPUTIL_P_NXM;
1306 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1308 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format)
1310 return ofputil_nx_flow_format_to_protocol(flow_format) != 0;
1313 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1316 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format)
1318 switch (flow_format) {
1319 case NXFF_OPENFLOW10:
1320 return "openflow10";
1329 ofputil_make_set_packet_in_format(enum nx_packet_in_format packet_in_format)
1331 struct nx_set_packet_in_format *spif;
1334 spif = make_nxmsg(sizeof *spif, NXT_SET_PACKET_IN_FORMAT, &msg);
1335 spif->format = htonl(packet_in_format);
1340 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1341 * extension on or off (according to 'flow_mod_table_id'). */
1343 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
1345 struct nx_flow_mod_table_id *nfmti;
1348 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
1349 nfmti->set = flow_mod_table_id;
1353 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1354 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1357 * Does not validate the flow_mod actions. */
1359 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
1360 const struct ofp_header *oh,
1361 enum ofputil_protocol protocol)
1363 const struct ofputil_msg_type *type;
1367 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1369 ofputil_decode_msg_type(oh, &type);
1370 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
1371 /* Standard OpenFlow flow_mod. */
1372 const struct ofp_flow_mod *ofm;
1376 /* Dissect the message. */
1377 ofm = ofpbuf_pull(&b, sizeof *ofm);
1378 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1383 /* Set priority based on original wildcards. Normally we'd allow
1384 * ofputil_cls_rule_from_match() to do this for us, but
1385 * ofputil_normalize_rule() can put wildcards where the original flow
1386 * didn't have them. */
1387 priority = ntohs(ofm->priority);
1388 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
1389 priority = UINT16_MAX;
1392 /* Translate the rule. */
1393 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
1394 ofputil_normalize_rule(&fm->cr);
1396 /* Translate the message. */
1397 fm->cookie = ofm->cookie;
1398 fm->cookie_mask = htonll(UINT64_MAX);
1399 command = ntohs(ofm->command);
1400 fm->idle_timeout = ntohs(ofm->idle_timeout);
1401 fm->hard_timeout = ntohs(ofm->hard_timeout);
1402 fm->buffer_id = ntohl(ofm->buffer_id);
1403 fm->out_port = ntohs(ofm->out_port);
1404 fm->flags = ntohs(ofm->flags);
1405 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
1406 /* Nicira extended flow_mod. */
1407 const struct nx_flow_mod *nfm;
1410 /* Dissect the message. */
1411 nfm = ofpbuf_pull(&b, sizeof *nfm);
1412 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
1413 &fm->cr, &fm->cookie, &fm->cookie_mask);
1417 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
1422 /* Translate the message. */
1423 command = ntohs(nfm->command);
1424 if (command == OFPFC_ADD) {
1425 if (fm->cookie_mask) {
1426 /* The "NXM_NX_COOKIE*" matches are not valid for flow
1427 * additions. Additions must use the "cookie" field of
1428 * the "nx_flow_mod" structure. */
1429 return OFPERR_NXBRC_NXM_INVALID;
1431 fm->cookie = nfm->cookie;
1432 fm->cookie_mask = htonll(UINT64_MAX);
1435 fm->idle_timeout = ntohs(nfm->idle_timeout);
1436 fm->hard_timeout = ntohs(nfm->hard_timeout);
1437 fm->buffer_id = ntohl(nfm->buffer_id);
1438 fm->out_port = ntohs(nfm->out_port);
1439 fm->flags = ntohs(nfm->flags);
1444 if (protocol & OFPUTIL_P_TID) {
1445 fm->command = command & 0xff;
1446 fm->table_id = command >> 8;
1448 fm->command = command;
1449 fm->table_id = 0xff;
1455 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
1456 * 'protocol' and returns the message.
1458 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
1459 * enabled, false otherwise. */
1461 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
1462 enum ofputil_protocol protocol)
1464 size_t actions_len = fm->n_actions * sizeof *fm->actions;
1465 struct ofp_flow_mod *ofm;
1466 struct nx_flow_mod *nfm;
1471 command = (protocol & OFPUTIL_P_TID
1472 ? (fm->command & 0xff) | (fm->table_id << 8)
1476 case OFPUTIL_P_OF10:
1477 case OFPUTIL_P_OF10_TID:
1478 msg = ofpbuf_new(sizeof *ofm + actions_len);
1479 ofm = put_openflow(sizeof *ofm, OFPT10_FLOW_MOD, msg);
1480 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
1481 ofm->cookie = fm->cookie;
1482 ofm->command = htons(command);
1483 ofm->idle_timeout = htons(fm->idle_timeout);
1484 ofm->hard_timeout = htons(fm->hard_timeout);
1485 ofm->priority = htons(fm->cr.priority);
1486 ofm->buffer_id = htonl(fm->buffer_id);
1487 ofm->out_port = htons(fm->out_port);
1488 ofm->flags = htons(fm->flags);
1492 case OFPUTIL_P_NXM_TID:
1493 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1494 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1496 nfm->command = htons(command);
1497 if (command == OFPFC_ADD) {
1498 nfm->cookie = fm->cookie;
1499 match_len = nx_put_match(msg, &fm->cr, 0, 0);
1502 match_len = nx_put_match(msg, &fm->cr,
1503 fm->cookie, fm->cookie_mask);
1505 nfm->idle_timeout = htons(fm->idle_timeout);
1506 nfm->hard_timeout = htons(fm->hard_timeout);
1507 nfm->priority = htons(fm->cr.priority);
1508 nfm->buffer_id = htonl(fm->buffer_id);
1509 nfm->out_port = htons(fm->out_port);
1510 nfm->flags = htons(fm->flags);
1511 nfm->match_len = htons(match_len);
1518 ofpbuf_put(msg, fm->actions, actions_len);
1519 update_openflow_length(msg);
1523 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1524 * send all of the 'n_fm's flow table modification requests in 'fms', and a
1525 * 0-bit for each protocol that is inadequate.
1527 * (The return value will have at least one 1-bit.) */
1528 enum ofputil_protocol
1529 ofputil_flow_mod_usable_protocols(const struct ofputil_flow_mod *fms,
1532 enum ofputil_protocol usable_protocols;
1535 usable_protocols = OFPUTIL_P_ANY;
1536 for (i = 0; i < n_fms; i++) {
1537 const struct ofputil_flow_mod *fm = &fms[i];
1539 usable_protocols &= ofputil_usable_protocols(&fm->cr);
1540 if (fm->table_id != 0xff) {
1541 usable_protocols &= OFPUTIL_P_TID;
1543 if (fm->command != OFPFC_ADD && fm->cookie_mask != htonll(0)) {
1544 usable_protocols &= OFPUTIL_P_NXM_ANY;
1547 assert(usable_protocols);
1549 return usable_protocols;
1553 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1554 const struct ofp_header *oh,
1557 const struct ofp_flow_stats_request *ofsr =
1558 (const struct ofp_flow_stats_request *) oh;
1560 fsr->aggregate = aggregate;
1561 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1562 fsr->out_port = ntohs(ofsr->out_port);
1563 fsr->table_id = ofsr->table_id;
1564 fsr->cookie = fsr->cookie_mask = htonll(0);
1570 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1571 const struct ofp_header *oh,
1574 const struct nx_flow_stats_request *nfsr;
1578 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1580 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1581 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match,
1582 &fsr->cookie, &fsr->cookie_mask);
1587 return OFPERR_OFPBRC_BAD_LEN;
1590 fsr->aggregate = aggregate;
1591 fsr->out_port = ntohs(nfsr->out_port);
1592 fsr->table_id = nfsr->table_id;
1597 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1598 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1599 * successful, otherwise an OpenFlow error code. */
1601 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1602 const struct ofp_header *oh)
1604 const struct ofputil_msg_type *type;
1608 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1610 ofputil_decode_msg_type(oh, &type);
1611 code = ofputil_msg_type_code(type);
1613 case OFPUTIL_OFPST_FLOW_REQUEST:
1614 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1616 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1617 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1619 case OFPUTIL_NXST_FLOW_REQUEST:
1620 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1622 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1623 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1626 /* Hey, the caller lied. */
1631 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1632 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1633 * 'protocol', and returns the message. */
1635 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1636 enum ofputil_protocol protocol)
1641 case OFPUTIL_P_OF10:
1642 case OFPUTIL_P_OF10_TID: {
1643 struct ofp_flow_stats_request *ofsr;
1646 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1647 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1648 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1649 ofsr->table_id = fsr->table_id;
1650 ofsr->out_port = htons(fsr->out_port);
1655 case OFPUTIL_P_NXM_TID: {
1656 struct nx_flow_stats_request *nfsr;
1660 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1661 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1662 match_len = nx_put_match(msg, &fsr->match,
1663 fsr->cookie, fsr->cookie_mask);
1666 nfsr->out_port = htons(fsr->out_port);
1667 nfsr->match_len = htons(match_len);
1668 nfsr->table_id = fsr->table_id;
1679 /* Returns a bitmask with a 1-bit for each protocol that could be used to
1680 * accurately encode 'fsr', and a 0-bit for each protocol that is inadequate.
1682 * (The return value will have at least one 1-bit.) */
1683 enum ofputil_protocol
1684 ofputil_flow_stats_request_usable_protocols(
1685 const struct ofputil_flow_stats_request *fsr)
1687 enum ofputil_protocol usable_protocols;
1689 usable_protocols = ofputil_usable_protocols(&fsr->match);
1690 if (fsr->cookie_mask != htonll(0)) {
1691 usable_protocols &= OFPUTIL_P_NXM_ANY;
1693 return usable_protocols;
1696 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1697 * ofputil_flow_stats in 'fs'.
1699 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1700 * OpenFlow message. Calling this function multiple times for a single 'msg'
1701 * iterates through the replies. The caller must initially leave 'msg''s layer
1702 * pointers null and not modify them between calls.
1704 * Most switches don't send the values needed to populate fs->idle_age and
1705 * fs->hard_age, so those members will usually be set to 0. If the switch from
1706 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
1707 * 'flow_age_extension' as true so that the contents of 'msg' determine the
1708 * 'idle_age' and 'hard_age' members in 'fs'.
1710 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1711 * otherwise a positive errno value. */
1713 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1715 bool flow_age_extension)
1717 const struct ofputil_msg_type *type;
1720 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1721 code = ofputil_msg_type_code(type);
1723 msg->l2 = msg->data;
1724 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1725 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1726 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1727 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1735 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1736 const struct ofp_flow_stats *ofs;
1739 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1741 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1742 "bytes at end", msg->size);
1746 length = ntohs(ofs->length);
1747 if (length < sizeof *ofs) {
1748 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1749 "length %zu", length);
1753 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1754 &fs->actions, &fs->n_actions)) {
1758 fs->cookie = get_32aligned_be64(&ofs->cookie);
1759 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1761 fs->table_id = ofs->table_id;
1762 fs->duration_sec = ntohl(ofs->duration_sec);
1763 fs->duration_nsec = ntohl(ofs->duration_nsec);
1764 fs->idle_timeout = ntohs(ofs->idle_timeout);
1765 fs->hard_timeout = ntohs(ofs->hard_timeout);
1768 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1769 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1770 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1771 const struct nx_flow_stats *nfs;
1772 size_t match_len, length;
1774 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1776 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1777 "bytes at end", msg->size);
1781 length = ntohs(nfs->length);
1782 match_len = ntohs(nfs->match_len);
1783 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1784 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1785 "claims invalid length %zu", match_len, length);
1788 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule,
1793 if (ofputil_pull_actions(msg,
1794 length - sizeof *nfs - ROUND_UP(match_len, 8),
1795 &fs->actions, &fs->n_actions)) {
1799 fs->cookie = nfs->cookie;
1800 fs->table_id = nfs->table_id;
1801 fs->duration_sec = ntohl(nfs->duration_sec);
1802 fs->duration_nsec = ntohl(nfs->duration_nsec);
1803 fs->idle_timeout = ntohs(nfs->idle_timeout);
1804 fs->hard_timeout = ntohs(nfs->hard_timeout);
1807 if (flow_age_extension) {
1808 if (nfs->idle_age) {
1809 fs->idle_age = ntohs(nfs->idle_age) - 1;
1811 if (nfs->hard_age) {
1812 fs->hard_age = ntohs(nfs->hard_age) - 1;
1815 fs->packet_count = ntohll(nfs->packet_count);
1816 fs->byte_count = ntohll(nfs->byte_count);
1824 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1826 * We use this in situations where OVS internally uses UINT64_MAX to mean
1827 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1829 unknown_to_zero(uint64_t count)
1831 return count != UINT64_MAX ? count : 0;
1834 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1835 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1836 * have been initialized with ofputil_start_stats_reply(). */
1838 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1839 struct list *replies)
1841 size_t act_len = fs->n_actions * sizeof *fs->actions;
1842 const struct ofp_stats_msg *osm;
1844 osm = ofpbuf_from_list(list_back(replies))->data;
1845 if (osm->type == htons(OFPST_FLOW)) {
1846 size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1847 struct ofp_flow_stats *ofs;
1849 ofs = ofputil_append_stats_reply(len, replies);
1850 ofs->length = htons(len);
1851 ofs->table_id = fs->table_id;
1853 ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1854 ofs->duration_sec = htonl(fs->duration_sec);
1855 ofs->duration_nsec = htonl(fs->duration_nsec);
1856 ofs->priority = htons(fs->rule.priority);
1857 ofs->idle_timeout = htons(fs->idle_timeout);
1858 ofs->hard_timeout = htons(fs->hard_timeout);
1859 memset(ofs->pad2, 0, sizeof ofs->pad2);
1860 put_32aligned_be64(&ofs->cookie, fs->cookie);
1861 put_32aligned_be64(&ofs->packet_count,
1862 htonll(unknown_to_zero(fs->packet_count)));
1863 put_32aligned_be64(&ofs->byte_count,
1864 htonll(unknown_to_zero(fs->byte_count)));
1865 memcpy(ofs->actions, fs->actions, act_len);
1866 } else if (osm->type == htons(OFPST_VENDOR)) {
1867 struct nx_flow_stats *nfs;
1871 msg = ofputil_reserve_stats_reply(
1872 sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1873 start_len = msg->size;
1875 nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1876 nfs->table_id = fs->table_id;
1878 nfs->duration_sec = htonl(fs->duration_sec);
1879 nfs->duration_nsec = htonl(fs->duration_nsec);
1880 nfs->priority = htons(fs->rule.priority);
1881 nfs->idle_timeout = htons(fs->idle_timeout);
1882 nfs->hard_timeout = htons(fs->hard_timeout);
1883 nfs->idle_age = htons(fs->idle_age < 0 ? 0
1884 : fs->idle_age < UINT16_MAX ? fs->idle_age + 1
1886 nfs->hard_age = htons(fs->hard_age < 0 ? 0
1887 : fs->hard_age < UINT16_MAX ? fs->hard_age + 1
1889 nfs->match_len = htons(nx_put_match(msg, &fs->rule, 0, 0));
1890 nfs->cookie = fs->cookie;
1891 nfs->packet_count = htonll(fs->packet_count);
1892 nfs->byte_count = htonll(fs->byte_count);
1893 ofpbuf_put(msg, fs->actions, act_len);
1894 nfs->length = htons(msg->size - start_len);
1900 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1901 * NXST_AGGREGATE reply according to 'protocol', and returns the message. */
1903 ofputil_encode_aggregate_stats_reply(
1904 const struct ofputil_aggregate_stats *stats,
1905 const struct ofp_stats_msg *request)
1909 if (request->type == htons(OFPST_AGGREGATE)) {
1910 struct ofp_aggregate_stats_reply *asr;
1912 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1913 put_32aligned_be64(&asr->packet_count,
1914 htonll(unknown_to_zero(stats->packet_count)));
1915 put_32aligned_be64(&asr->byte_count,
1916 htonll(unknown_to_zero(stats->byte_count)));
1917 asr->flow_count = htonl(stats->flow_count);
1918 } else if (request->type == htons(OFPST_VENDOR)) {
1919 struct nx_aggregate_stats_reply *nasr;
1921 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1922 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1923 nasr->packet_count = htonll(stats->packet_count);
1924 nasr->byte_count = htonll(stats->byte_count);
1925 nasr->flow_count = htonl(stats->flow_count);
1933 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1934 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1935 * an OpenFlow error code. */
1937 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1938 const struct ofp_header *oh)
1940 const struct ofputil_msg_type *type;
1941 enum ofputil_msg_code code;
1943 ofputil_decode_msg_type(oh, &type);
1944 code = ofputil_msg_type_code(type);
1945 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1946 const struct ofp_flow_removed *ofr;
1948 ofr = (const struct ofp_flow_removed *) oh;
1949 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1951 fr->cookie = ofr->cookie;
1952 fr->reason = ofr->reason;
1953 fr->duration_sec = ntohl(ofr->duration_sec);
1954 fr->duration_nsec = ntohl(ofr->duration_nsec);
1955 fr->idle_timeout = ntohs(ofr->idle_timeout);
1956 fr->packet_count = ntohll(ofr->packet_count);
1957 fr->byte_count = ntohll(ofr->byte_count);
1958 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1959 struct nx_flow_removed *nfr;
1963 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1965 nfr = ofpbuf_pull(&b, sizeof *nfr);
1966 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1967 &fr->rule, NULL, NULL);
1972 return OFPERR_OFPBRC_BAD_LEN;
1975 fr->cookie = nfr->cookie;
1976 fr->reason = nfr->reason;
1977 fr->duration_sec = ntohl(nfr->duration_sec);
1978 fr->duration_nsec = ntohl(nfr->duration_nsec);
1979 fr->idle_timeout = ntohs(nfr->idle_timeout);
1980 fr->packet_count = ntohll(nfr->packet_count);
1981 fr->byte_count = ntohll(nfr->byte_count);
1989 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1990 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
1993 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1994 enum ofputil_protocol protocol)
1999 case OFPUTIL_P_OF10:
2000 case OFPUTIL_P_OF10_TID: {
2001 struct ofp_flow_removed *ofr;
2003 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
2005 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
2006 ofr->cookie = fr->cookie;
2007 ofr->priority = htons(fr->rule.priority);
2008 ofr->reason = fr->reason;
2009 ofr->duration_sec = htonl(fr->duration_sec);
2010 ofr->duration_nsec = htonl(fr->duration_nsec);
2011 ofr->idle_timeout = htons(fr->idle_timeout);
2012 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
2013 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
2018 case OFPUTIL_P_NXM_TID: {
2019 struct nx_flow_removed *nfr;
2022 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
2023 match_len = nx_put_match(msg, &fr->rule, 0, 0);
2026 nfr->cookie = fr->cookie;
2027 nfr->priority = htons(fr->rule.priority);
2028 nfr->reason = fr->reason;
2029 nfr->duration_sec = htonl(fr->duration_sec);
2030 nfr->duration_nsec = htonl(fr->duration_nsec);
2031 nfr->idle_timeout = htons(fr->idle_timeout);
2032 nfr->match_len = htons(match_len);
2033 nfr->packet_count = htonll(fr->packet_count);
2034 nfr->byte_count = htonll(fr->byte_count);
2046 ofputil_decode_packet_in(struct ofputil_packet_in *pin,
2047 const struct ofp_header *oh)
2049 const struct ofputil_msg_type *type;
2050 enum ofputil_msg_code code;
2052 ofputil_decode_msg_type(oh, &type);
2053 code = ofputil_msg_type_code(type);
2054 memset(pin, 0, sizeof *pin);
2056 if (code == OFPUTIL_OFPT_PACKET_IN) {
2057 const struct ofp_packet_in *opi = (const struct ofp_packet_in *) oh;
2059 pin->packet = opi->data;
2060 pin->packet_len = ntohs(opi->header.length)
2061 - offsetof(struct ofp_packet_in, data);
2063 pin->fmd.in_port = ntohs(opi->in_port);
2064 pin->reason = opi->reason;
2065 pin->buffer_id = ntohl(opi->buffer_id);
2066 pin->total_len = ntohs(opi->total_len);
2067 } else if (code == OFPUTIL_NXT_PACKET_IN) {
2068 const struct nx_packet_in *npi;
2069 struct cls_rule rule;
2073 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2075 npi = ofpbuf_pull(&b, sizeof *npi);
2076 error = nx_pull_match_loose(&b, ntohs(npi->match_len), 0, &rule, NULL,
2082 if (!ofpbuf_try_pull(&b, 2)) {
2083 return OFPERR_OFPBRC_BAD_LEN;
2086 pin->packet = b.data;
2087 pin->packet_len = b.size;
2088 pin->reason = npi->reason;
2089 pin->table_id = npi->table_id;
2090 pin->cookie = npi->cookie;
2092 pin->fmd.in_port = rule.flow.in_port;
2094 pin->fmd.tun_id = rule.flow.tun_id;
2095 pin->fmd.tun_id_mask = rule.wc.tun_id_mask;
2097 memcpy(pin->fmd.regs, rule.flow.regs, sizeof pin->fmd.regs);
2098 memcpy(pin->fmd.reg_masks, rule.wc.reg_masks,
2099 sizeof pin->fmd.reg_masks);
2101 pin->buffer_id = ntohl(npi->buffer_id);
2102 pin->total_len = ntohs(npi->total_len);
2110 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
2111 * in the format specified by 'packet_in_format'. */
2113 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
2114 enum nx_packet_in_format packet_in_format)
2116 size_t send_len = MIN(pin->send_len, pin->packet_len);
2117 struct ofpbuf *packet;
2119 /* Add OFPT_PACKET_IN. */
2120 if (packet_in_format == NXPIF_OPENFLOW10) {
2121 size_t header_len = offsetof(struct ofp_packet_in, data);
2122 struct ofp_packet_in *opi;
2124 packet = ofpbuf_new(send_len + header_len);
2125 opi = ofpbuf_put_zeros(packet, header_len);
2126 opi->header.version = OFP10_VERSION;
2127 opi->header.type = OFPT_PACKET_IN;
2128 opi->total_len = htons(pin->total_len);
2129 opi->in_port = htons(pin->fmd.in_port);
2130 opi->reason = pin->reason;
2131 opi->buffer_id = htonl(pin->buffer_id);
2133 ofpbuf_put(packet, pin->packet, send_len);
2134 } else if (packet_in_format == NXPIF_NXM) {
2135 struct nx_packet_in *npi;
2136 struct cls_rule rule;
2140 /* Estimate of required PACKET_IN length includes the NPI header, space
2141 * for the match (2 times sizeof the metadata seems like enough), 2
2142 * bytes for padding, and the packet length. */
2143 packet = ofpbuf_new(sizeof *npi + sizeof(struct flow_metadata) * 2
2146 cls_rule_init_catchall(&rule, 0);
2147 cls_rule_set_tun_id_masked(&rule, pin->fmd.tun_id,
2148 pin->fmd.tun_id_mask);
2150 for (i = 0; i < FLOW_N_REGS; i++) {
2151 cls_rule_set_reg_masked(&rule, i, pin->fmd.regs[i],
2152 pin->fmd.reg_masks[i]);
2155 cls_rule_set_in_port(&rule, pin->fmd.in_port);
2157 ofpbuf_put_zeros(packet, sizeof *npi);
2158 match_len = nx_put_match(packet, &rule, 0, 0);
2159 ofpbuf_put_zeros(packet, 2);
2160 ofpbuf_put(packet, pin->packet, send_len);
2163 npi->nxh.header.version = OFP10_VERSION;
2164 npi->nxh.header.type = OFPT_VENDOR;
2165 npi->nxh.vendor = htonl(NX_VENDOR_ID);
2166 npi->nxh.subtype = htonl(NXT_PACKET_IN);
2168 npi->buffer_id = htonl(pin->buffer_id);
2169 npi->total_len = htons(pin->total_len);
2170 npi->reason = pin->reason;
2171 npi->table_id = pin->table_id;
2172 npi->cookie = pin->cookie;
2173 npi->match_len = htons(match_len);
2177 update_openflow_length(packet);
2183 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason)
2185 static char s[INT_STRLEN(int) + 1];
2192 case OFPR_INVALID_TTL:
2193 return "invalid_ttl";
2195 case OFPR_N_REASONS:
2197 sprintf(s, "%d", (int) reason);
2203 ofputil_packet_in_reason_from_string(const char *s,
2204 enum ofp_packet_in_reason *reason)
2208 for (i = 0; i < OFPR_N_REASONS; i++) {
2209 if (!strcasecmp(s, ofputil_packet_in_reason_to_string(i))) {
2218 ofputil_decode_packet_out(struct ofputil_packet_out *po,
2219 const struct ofp_packet_out *opo)
2224 po->buffer_id = ntohl(opo->buffer_id);
2225 po->in_port = ntohs(opo->in_port);
2226 if (po->in_port >= OFPP_MAX && po->in_port != OFPP_LOCAL
2227 && po->in_port != OFPP_NONE) {
2228 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out has bad input port %#"PRIx16,
2230 return OFPERR_NXBRC_BAD_IN_PORT;
2233 ofpbuf_use_const(&b, opo, ntohs(opo->header.length));
2234 ofpbuf_pull(&b, sizeof *opo);
2236 error = ofputil_pull_actions(&b, ntohs(opo->actions_len),
2237 &po->actions, &po->n_actions);
2242 if (po->buffer_id == UINT32_MAX) {
2243 po->packet = b.data;
2244 po->packet_len = b.size;
2253 /* ofputil_phy_port */
2255 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
2256 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2257 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2258 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2259 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2260 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2261 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2262 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2264 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
2265 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == (OFPPF10_COPPER << 4));
2266 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == (OFPPF10_FIBER << 4));
2267 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == (OFPPF10_AUTONEG << 4));
2268 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == (OFPPF10_PAUSE << 4));
2269 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == (OFPPF10_PAUSE_ASYM << 4));
2271 static enum netdev_features
2272 netdev_port_features_from_ofp10(ovs_be32 ofp10_)
2274 uint32_t ofp10 = ntohl(ofp10_);
2275 return (ofp10 & 0x7f) | ((ofp10 & 0xf80) << 4);
2279 netdev_port_features_to_ofp10(enum netdev_features features)
2281 return htonl((features & 0x7f) | ((features & 0xf800) >> 4));
2284 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD == OFPPF_10MB_HD); /* bit 0 */
2285 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD == OFPPF_10MB_FD); /* bit 1 */
2286 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD == OFPPF_100MB_HD); /* bit 2 */
2287 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD == OFPPF_100MB_FD); /* bit 3 */
2288 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD == OFPPF_1GB_HD); /* bit 4 */
2289 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD == OFPPF_1GB_FD); /* bit 5 */
2290 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD == OFPPF_10GB_FD); /* bit 6 */
2291 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD == OFPPF11_40GB_FD); /* bit 7 */
2292 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD == OFPPF11_100GB_FD); /* bit 8 */
2293 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD == OFPPF11_1TB_FD); /* bit 9 */
2294 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER == OFPPF11_OTHER); /* bit 10 */
2295 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER == OFPPF11_COPPER); /* bit 11 */
2296 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER == OFPPF11_FIBER); /* bit 12 */
2297 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG == OFPPF11_AUTONEG); /* bit 13 */
2298 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE == OFPPF11_PAUSE); /* bit 14 */
2299 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM == OFPPF11_PAUSE_ASYM);/* bit 15 */
2301 static enum netdev_features
2302 netdev_port_features_from_ofp11(ovs_be32 ofp11)
2304 return ntohl(ofp11) & 0xffff;
2308 netdev_port_features_to_ofp11(enum netdev_features features)
2310 return htonl(features & 0xffff);
2314 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port *pp,
2315 const struct ofp10_phy_port *opp)
2317 memset(pp, 0, sizeof *pp);
2319 pp->port_no = ntohs(opp->port_no);
2320 memcpy(pp->hw_addr, opp->hw_addr, OFP_ETH_ALEN);
2321 ovs_strlcpy(pp->name, opp->name, OFP_MAX_PORT_NAME_LEN);
2323 pp->config = ntohl(opp->config) & OFPPC10_ALL;
2324 pp->state = ntohl(opp->state) & OFPPS10_ALL;
2326 pp->curr = netdev_port_features_from_ofp10(opp->curr);
2327 pp->advertised = netdev_port_features_from_ofp10(opp->advertised);
2328 pp->supported = netdev_port_features_from_ofp10(opp->supported);
2329 pp->peer = netdev_port_features_from_ofp10(opp->peer);
2331 pp->curr_speed = netdev_features_to_bps(pp->curr) / 1000;
2332 pp->max_speed = netdev_features_to_bps(pp->supported) / 1000;
2338 ofputil_decode_ofp11_port(struct ofputil_phy_port *pp,
2339 const struct ofp11_port *op)
2343 memset(pp, 0, sizeof *pp);
2345 error = ofputil_port_from_ofp11(op->port_no, &pp->port_no);
2349 memcpy(pp->hw_addr, op->hw_addr, OFP_ETH_ALEN);
2350 ovs_strlcpy(pp->name, op->name, OFP_MAX_PORT_NAME_LEN);
2352 pp->config = ntohl(op->config) & OFPPC11_ALL;
2353 pp->state = ntohl(op->state) & OFPPC11_ALL;
2355 pp->curr = netdev_port_features_from_ofp11(op->curr);
2356 pp->advertised = netdev_port_features_from_ofp11(op->advertised);
2357 pp->supported = netdev_port_features_from_ofp11(op->supported);
2358 pp->peer = netdev_port_features_from_ofp11(op->peer);
2360 pp->curr_speed = ntohl(op->curr_speed);
2361 pp->max_speed = ntohl(op->max_speed);
2367 ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *b,
2368 struct ofputil_phy_port *pp)
2370 if (ofp_version == OFP10_VERSION) {
2371 const struct ofp10_phy_port *opp = ofpbuf_try_pull(b, sizeof *opp);
2372 return opp ? ofputil_decode_ofp10_phy_port(pp, opp) : EOF;
2374 const struct ofp11_port *op = ofpbuf_try_pull(b, sizeof *op);
2375 return op ? ofputil_decode_ofp11_port(pp, op) : EOF;
2380 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port *pp,
2381 struct ofp10_phy_port *opp)
2383 memset(opp, 0, sizeof *opp);
2385 opp->port_no = htons(pp->port_no);
2386 memcpy(opp->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2387 ovs_strlcpy(opp->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2389 opp->config = htonl(pp->config & OFPPC10_ALL);
2390 opp->state = htonl(pp->state & OFPPS10_ALL);
2392 opp->curr = netdev_port_features_to_ofp10(pp->curr);
2393 opp->advertised = netdev_port_features_to_ofp10(pp->advertised);
2394 opp->supported = netdev_port_features_to_ofp10(pp->supported);
2395 opp->peer = netdev_port_features_to_ofp10(pp->peer);
2399 ofputil_encode_ofp11_port(const struct ofputil_phy_port *pp,
2400 struct ofp11_port *op)
2402 memset(op, 0, sizeof *op);
2404 op->port_no = ofputil_port_to_ofp11(pp->port_no);
2405 memcpy(op->hw_addr, pp->hw_addr, ETH_ADDR_LEN);
2406 ovs_strlcpy(op->name, pp->name, OFP_MAX_PORT_NAME_LEN);
2408 op->config = htonl(pp->config & OFPPC11_ALL);
2409 op->state = htonl(pp->state & OFPPS11_ALL);
2411 op->curr = netdev_port_features_to_ofp11(pp->curr);
2412 op->advertised = netdev_port_features_to_ofp11(pp->advertised);
2413 op->supported = netdev_port_features_to_ofp11(pp->supported);
2414 op->peer = netdev_port_features_to_ofp11(pp->peer);
2416 op->curr_speed = htonl(pp->curr_speed);
2417 op->max_speed = htonl(pp->max_speed);
2421 ofputil_put_phy_port(uint8_t ofp_version, const struct ofputil_phy_port *pp,
2424 if (ofp_version == OFP10_VERSION) {
2425 struct ofp10_phy_port *opp;
2426 if (b->size + sizeof *opp <= UINT16_MAX) {
2427 opp = ofpbuf_put_uninit(b, sizeof *opp);
2428 ofputil_encode_ofp10_phy_port(pp, opp);
2431 struct ofp11_port *op;
2432 if (b->size + sizeof *op <= UINT16_MAX) {
2433 op = ofpbuf_put_uninit(b, sizeof *op);
2434 ofputil_encode_ofp11_port(pp, op);
2439 /* ofputil_switch_features */
2441 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
2442 OFPC_IP_REASM | OFPC_QUEUE_STATS | OFPC_ARP_MATCH_IP)
2443 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS == OFPC_FLOW_STATS);
2444 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS == OFPC_TABLE_STATS);
2445 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS == OFPC_PORT_STATS);
2446 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM == OFPC_IP_REASM);
2447 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS == OFPC_QUEUE_STATS);
2448 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP == OFPC_ARP_MATCH_IP);
2450 struct ofputil_action_bit_translation {
2451 enum ofputil_action_bitmap ofputil_bit;
2455 static const struct ofputil_action_bit_translation of10_action_bits[] = {
2456 { OFPUTIL_A_OUTPUT, OFPAT10_OUTPUT },
2457 { OFPUTIL_A_SET_VLAN_VID, OFPAT10_SET_VLAN_VID },
2458 { OFPUTIL_A_SET_VLAN_PCP, OFPAT10_SET_VLAN_PCP },
2459 { OFPUTIL_A_STRIP_VLAN, OFPAT10_STRIP_VLAN },
2460 { OFPUTIL_A_SET_DL_SRC, OFPAT10_SET_DL_SRC },
2461 { OFPUTIL_A_SET_DL_DST, OFPAT10_SET_DL_DST },
2462 { OFPUTIL_A_SET_NW_SRC, OFPAT10_SET_NW_SRC },
2463 { OFPUTIL_A_SET_NW_DST, OFPAT10_SET_NW_DST },
2464 { OFPUTIL_A_SET_NW_TOS, OFPAT10_SET_NW_TOS },
2465 { OFPUTIL_A_SET_TP_SRC, OFPAT10_SET_TP_SRC },
2466 { OFPUTIL_A_SET_TP_DST, OFPAT10_SET_TP_DST },
2467 { OFPUTIL_A_ENQUEUE, OFPAT10_ENQUEUE },
2471 static const struct ofputil_action_bit_translation of11_action_bits[] = {
2472 { OFPUTIL_A_OUTPUT, OFPAT11_OUTPUT },
2473 { OFPUTIL_A_SET_VLAN_VID, OFPAT11_SET_VLAN_VID },
2474 { OFPUTIL_A_SET_VLAN_PCP, OFPAT11_SET_VLAN_PCP },
2475 { OFPUTIL_A_SET_DL_SRC, OFPAT11_SET_DL_SRC },
2476 { OFPUTIL_A_SET_DL_DST, OFPAT11_SET_DL_DST },
2477 { OFPUTIL_A_SET_NW_SRC, OFPAT11_SET_NW_SRC },
2478 { OFPUTIL_A_SET_NW_DST, OFPAT11_SET_NW_DST },
2479 { OFPUTIL_A_SET_NW_TOS, OFPAT11_SET_NW_TOS },
2480 { OFPUTIL_A_SET_NW_ECN, OFPAT11_SET_NW_ECN },
2481 { OFPUTIL_A_SET_TP_SRC, OFPAT11_SET_TP_SRC },
2482 { OFPUTIL_A_SET_TP_DST, OFPAT11_SET_TP_DST },
2483 { OFPUTIL_A_COPY_TTL_OUT, OFPAT11_COPY_TTL_OUT },
2484 { OFPUTIL_A_COPY_TTL_IN, OFPAT11_COPY_TTL_IN },
2485 { OFPUTIL_A_SET_MPLS_LABEL, OFPAT11_SET_MPLS_LABEL },
2486 { OFPUTIL_A_SET_MPLS_TC, OFPAT11_SET_MPLS_TC },
2487 { OFPUTIL_A_SET_MPLS_TTL, OFPAT11_SET_MPLS_TTL },
2488 { OFPUTIL_A_DEC_MPLS_TTL, OFPAT11_DEC_MPLS_TTL },
2489 { OFPUTIL_A_PUSH_VLAN, OFPAT11_PUSH_VLAN },
2490 { OFPUTIL_A_POP_VLAN, OFPAT11_POP_VLAN },
2491 { OFPUTIL_A_PUSH_MPLS, OFPAT11_PUSH_MPLS },
2492 { OFPUTIL_A_POP_MPLS, OFPAT11_POP_MPLS },
2493 { OFPUTIL_A_SET_QUEUE, OFPAT11_SET_QUEUE },
2494 { OFPUTIL_A_GROUP, OFPAT11_GROUP },
2495 { OFPUTIL_A_SET_NW_TTL, OFPAT11_SET_NW_TTL },
2496 { OFPUTIL_A_DEC_NW_TTL, OFPAT11_DEC_NW_TTL },
2500 static enum ofputil_action_bitmap
2501 decode_action_bits(ovs_be32 of_actions,
2502 const struct ofputil_action_bit_translation *x)
2504 enum ofputil_action_bitmap ofputil_actions;
2506 ofputil_actions = 0;
2507 for (; x->ofputil_bit; x++) {
2508 if (of_actions & htonl(1u << x->of_bit)) {
2509 ofputil_actions |= x->ofputil_bit;
2512 return ofputil_actions;
2515 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
2516 * abstract representation in '*features'. Initializes '*b' to iterate over
2517 * the OpenFlow port structures following 'osf' with later calls to
2518 * ofputil_pull_switch_features_port(). Returns 0 if successful, otherwise an
2519 * OFPERR_* value. */
2521 ofputil_decode_switch_features(const struct ofp_switch_features *osf,
2522 struct ofputil_switch_features *features,
2525 ofpbuf_use_const(b, osf, ntohs(osf->header.length));
2526 ofpbuf_pull(b, sizeof *osf);
2527 b->l2 = (struct ofputil_switch_features *) osf;
2529 features->datapath_id = ntohll(osf->datapath_id);
2530 features->n_buffers = ntohl(osf->n_buffers);
2531 features->n_tables = osf->n_tables;
2533 features->capabilities = ntohl(osf->capabilities) & OFPC_COMMON;
2534 if (osf->header.version == OFP10_VERSION) {
2535 if (b->size % sizeof(struct ofp10_phy_port)) {
2536 return OFPERR_OFPBRC_BAD_LEN;
2539 if (osf->capabilities & htonl(OFPC10_STP)) {
2540 features->capabilities |= OFPUTIL_C_STP;
2542 features->actions = decode_action_bits(osf->actions, of10_action_bits);
2543 } else if (osf->header.version == OFP11_VERSION) {
2544 if (b->size % sizeof(struct ofp11_port)) {
2545 return OFPERR_OFPBRC_BAD_LEN;
2548 if (osf->capabilities & htonl(OFPC11_GROUP_STATS)) {
2549 features->capabilities |= OFPUTIL_C_GROUP_STATS;
2551 features->actions = decode_action_bits(osf->actions, of11_action_bits);
2553 return OFPERR_OFPBRC_BAD_VERSION;
2559 /* Given a buffer 'b' that was initialized by a previous successful call to
2560 * ofputil_decode_switch_features(), tries to decode an OpenFlow port structure
2561 * following the main switch features information. If successful, initializes
2562 * '*pp' with an abstract representation of the port and returns 0. If no
2563 * ports remained to be decoded, returns EOF. On an error, returns a positive
2564 * OFPERR_* value. */
2566 ofputil_pull_switch_features_port(struct ofpbuf *b,
2567 struct ofputil_phy_port *pp)
2569 const struct ofp_switch_features *osf = b->l2;
2570 return ofputil_pull_phy_port(osf->header.version, b, pp);
2573 /* Returns the number of OpenFlow port structures that follow the main switch
2574 * features information in '*osf'. The return value is only guaranteed to be
2575 * accurate if '*osf' is well-formed, that is, if
2576 * ofputil_decode_switch_features() can process '*osf' successfully. */
2578 ofputil_count_phy_ports(const struct ofp_switch_features *osf)
2580 size_t ports_len = ntohs(osf->header.length) - sizeof *osf;
2581 return (osf->header.version == OFP10_VERSION
2582 ? ports_len / sizeof(struct ofp10_phy_port)
2583 : ports_len / sizeof(struct ofp11_port));
2587 encode_action_bits(enum ofputil_action_bitmap ofputil_actions,
2588 const struct ofputil_action_bit_translation *x)
2590 uint32_t of_actions;
2593 for (; x->ofputil_bit; x++) {
2594 if (ofputil_actions & x->ofputil_bit) {
2595 of_actions |= 1 << x->of_bit;
2598 return htonl(of_actions);
2601 /* Returns a buffer owned by the caller that encodes 'features' in the format
2602 * required by 'protocol' with the given 'xid'. The caller should append port
2603 * information to the buffer with subsequent calls to
2604 * ofputil_put_switch_features_port(). */
2606 ofputil_encode_switch_features(const struct ofputil_switch_features *features,
2607 enum ofputil_protocol protocol, ovs_be32 xid)
2609 struct ofp_switch_features *osf;
2612 osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, xid, &b);
2613 osf->header.version = ofputil_protocol_to_ofp_version(protocol);
2614 osf->datapath_id = htonll(features->datapath_id);
2615 osf->n_buffers = htonl(features->n_buffers);
2616 osf->n_tables = features->n_tables;
2618 osf->capabilities = htonl(features->capabilities & OFPC_COMMON);
2619 if (osf->header.version == OFP10_VERSION) {
2620 if (features->capabilities & OFPUTIL_C_STP) {
2621 osf->capabilities |= htonl(OFPC10_STP);
2623 osf->actions = encode_action_bits(features->actions, of10_action_bits);
2625 if (features->capabilities & OFPUTIL_C_GROUP_STATS) {
2626 osf->capabilities |= htonl(OFPC11_GROUP_STATS);
2628 osf->actions = encode_action_bits(features->actions, of11_action_bits);
2634 /* Encodes 'pp' into the format required by the switch_features message already
2635 * in 'b', which should have been returned by ofputil_encode_switch_features(),
2636 * and appends the encoded version to 'b'. */
2638 ofputil_put_switch_features_port(const struct ofputil_phy_port *pp,
2641 const struct ofp_switch_features *osf = b->data;
2643 ofputil_put_phy_port(osf->header.version, pp, b);
2646 /* ofputil_port_status */
2648 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
2649 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
2651 ofputil_decode_port_status(const struct ofp_port_status *ops,
2652 struct ofputil_port_status *ps)
2657 if (ops->reason != OFPPR_ADD &&
2658 ops->reason != OFPPR_DELETE &&
2659 ops->reason != OFPPR_MODIFY) {
2660 return OFPERR_NXBRC_BAD_REASON;
2662 ps->reason = ops->reason;
2664 ofpbuf_use_const(&b, ops, ntohs(ops->header.length));
2665 ofpbuf_pull(&b, sizeof *ops);
2666 retval = ofputil_pull_phy_port(ops->header.version, &b, &ps->desc);
2667 assert(retval != EOF);
2671 /* Converts the abstract form of a "port status" message in '*ps' into an
2672 * OpenFlow message suitable for 'protocol', and returns that encoded form in
2673 * a buffer owned by the caller. */
2675 ofputil_encode_port_status(const struct ofputil_port_status *ps,
2676 enum ofputil_protocol protocol)
2678 struct ofp_port_status *ops;
2681 b = ofpbuf_new(sizeof *ops + sizeof(struct ofp11_port));
2682 ops = put_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, htonl(0), b);
2683 ops->header.version = ofputil_protocol_to_ofp_version(protocol);
2684 ops->reason = ps->reason;
2685 ofputil_put_phy_port(ops->header.version, &ps->desc, b);
2686 update_openflow_length(b);
2690 /* ofputil_port_mod */
2692 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
2693 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
2695 ofputil_decode_port_mod(const struct ofp_header *oh,
2696 struct ofputil_port_mod *pm)
2698 if (oh->version == OFP10_VERSION) {
2699 const struct ofp10_port_mod *opm = (const struct ofp10_port_mod *) oh;
2701 if (oh->length != htons(sizeof *opm)) {
2702 return OFPERR_OFPBRC_BAD_LEN;
2705 pm->port_no = ntohs(opm->port_no);
2706 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2707 pm->config = ntohl(opm->config) & OFPPC10_ALL;
2708 pm->mask = ntohl(opm->mask) & OFPPC10_ALL;
2709 pm->advertise = netdev_port_features_from_ofp10(opm->advertise);
2710 } else if (oh->version == OFP11_VERSION) {
2711 const struct ofp11_port_mod *opm = (const struct ofp11_port_mod *) oh;
2714 if (oh->length != htons(sizeof *opm)) {
2715 return OFPERR_OFPBRC_BAD_LEN;
2718 error = ofputil_port_from_ofp11(opm->port_no, &pm->port_no);
2723 memcpy(pm->hw_addr, opm->hw_addr, ETH_ADDR_LEN);
2724 pm->config = ntohl(opm->config) & OFPPC11_ALL;
2725 pm->mask = ntohl(opm->mask) & OFPPC11_ALL;
2726 pm->advertise = netdev_port_features_from_ofp11(opm->advertise);
2728 return OFPERR_OFPBRC_BAD_VERSION;
2731 pm->config &= pm->mask;
2735 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
2736 * message suitable for 'protocol', and returns that encoded form in a buffer
2737 * owned by the caller. */
2739 ofputil_encode_port_mod(const struct ofputil_port_mod *pm,
2740 enum ofputil_protocol protocol)
2742 uint8_t ofp_version = ofputil_protocol_to_ofp_version(protocol);
2745 if (ofp_version == OFP10_VERSION) {
2746 struct ofp10_port_mod *opm;
2748 opm = make_openflow(sizeof *opm, OFPT10_PORT_MOD, &b);
2749 opm->port_no = htons(pm->port_no);
2750 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2751 opm->config = htonl(pm->config & OFPPC10_ALL);
2752 opm->mask = htonl(pm->mask & OFPPC10_ALL);
2753 opm->advertise = netdev_port_features_to_ofp10(pm->advertise);
2754 } else if (ofp_version == OFP11_VERSION) {
2755 struct ofp11_port_mod *opm;
2757 opm = make_openflow(sizeof *opm, OFPT11_PORT_MOD, &b);
2758 opm->port_no = htonl(pm->port_no);
2759 memcpy(opm->hw_addr, pm->hw_addr, ETH_ADDR_LEN);
2760 opm->config = htonl(pm->config & OFPPC11_ALL);
2761 opm->mask = htonl(pm->mask & OFPPC11_ALL);
2762 opm->advertise = netdev_port_features_to_ofp11(pm->advertise);
2771 ofputil_encode_packet_out(const struct ofputil_packet_out *po)
2773 struct ofp_packet_out *opo;
2778 actions_len = po->n_actions * sizeof *po->actions;
2779 size = sizeof *opo + actions_len;
2780 if (po->buffer_id == UINT32_MAX) {
2781 size += po->packet_len;
2784 msg = ofpbuf_new(size);
2785 opo = put_openflow(sizeof *opo, OFPT10_PACKET_OUT, msg);
2786 opo->buffer_id = htonl(po->buffer_id);
2787 opo->in_port = htons(po->in_port);
2788 opo->actions_len = htons(actions_len);
2789 ofpbuf_put(msg, po->actions, actions_len);
2790 if (po->buffer_id == UINT32_MAX) {
2791 ofpbuf_put(msg, po->packet, po->packet_len);
2793 update_openflow_length(msg);
2798 /* Returns a string representing the message type of 'type'. The string is the
2799 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
2800 * messages, the constant is followed by "request" or "reply",
2801 * e.g. "OFPST_AGGREGATE reply". */
2803 ofputil_msg_type_name(const struct ofputil_msg_type *type)
2808 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2809 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2810 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
2813 * The caller is responsible for freeing '*bufferp' when it is no longer
2816 * The OpenFlow header length is initially set to 'openflow_len'; if the
2817 * message is later extended, the length should be updated with
2818 * update_openflow_length() before sending.
2820 * Returns the header. */
2822 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
2824 *bufferp = ofpbuf_new(openflow_len);
2825 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
2828 /* Similar to make_openflow() but creates a Nicira vendor extension message
2829 * with the specific 'subtype'. 'subtype' should be in host byte order. */
2831 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
2833 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
2836 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
2837 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
2838 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
2841 * The caller is responsible for freeing '*bufferp' when it is no longer
2844 * The OpenFlow header length is initially set to 'openflow_len'; if the
2845 * message is later extended, the length should be updated with
2846 * update_openflow_length() before sending.
2848 * Returns the header. */
2850 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2851 struct ofpbuf **bufferp)
2853 *bufferp = ofpbuf_new(openflow_len);
2854 return put_openflow_xid(openflow_len, type, xid, *bufferp);
2857 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
2858 * with the specific 'subtype'. 'subtype' should be in host byte order. */
2860 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2861 struct ofpbuf **bufferp)
2863 *bufferp = ofpbuf_new(openflow_len);
2864 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
2867 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2868 * with the given 'type' and an arbitrary transaction id. Allocated bytes
2869 * beyond the header, if any, are zeroed.
2871 * The OpenFlow header length is initially set to 'openflow_len'; if the
2872 * message is later extended, the length should be updated with
2873 * update_openflow_length() before sending.
2875 * Returns the header. */
2877 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
2879 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
2882 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
2883 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
2884 * the header, if any, are zeroed.
2886 * The OpenFlow header length is initially set to 'openflow_len'; if the
2887 * message is later extended, the length should be updated with
2888 * update_openflow_length() before sending.
2890 * Returns the header. */
2892 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
2893 struct ofpbuf *buffer)
2895 struct ofp_header *oh;
2897 assert(openflow_len >= sizeof *oh);
2898 assert(openflow_len <= UINT16_MAX);
2900 oh = ofpbuf_put_uninit(buffer, openflow_len);
2901 oh->version = OFP10_VERSION;
2903 oh->length = htons(openflow_len);
2905 memset(oh + 1, 0, openflow_len - sizeof *oh);
2909 /* Similar to put_openflow() but append a Nicira vendor extension message with
2910 * the specific 'subtype'. 'subtype' should be in host byte order. */
2912 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
2914 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
2917 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
2918 * with the specific 'subtype'. 'subtype' should be in host byte order. */
2920 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
2921 struct ofpbuf *buffer)
2923 struct nicira_header *nxh;
2925 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
2926 nxh->vendor = htonl(NX_VENDOR_ID);
2927 nxh->subtype = htonl(subtype);
2931 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
2932 * 'buffer->size'. */
2934 update_openflow_length(struct ofpbuf *buffer)
2936 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
2937 oh->length = htons(buffer->size);
2941 put_stats__(ovs_be32 xid, uint8_t ofp_type,
2942 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
2945 if (ofpst_type == htons(OFPST_VENDOR)) {
2946 struct nicira_stats_msg *nsm;
2948 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
2949 nsm->vsm.osm.type = ofpst_type;
2950 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
2951 nsm->subtype = nxst_subtype;
2953 struct ofp_stats_msg *osm;
2955 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
2956 osm->type = ofpst_type;
2960 /* Creates a statistics request message with total length 'openflow_len'
2961 * (including all headers) and the given 'ofpst_type', and stores the buffer
2962 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
2963 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
2964 * subtype (otherwise 'nxst_subtype' is ignored).
2966 * Initializes bytes following the headers to all-bits-zero.
2968 * Returns the first byte of the new message. */
2970 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
2971 uint32_t nxst_subtype, struct ofpbuf **bufferp)
2975 msg = *bufferp = ofpbuf_new(openflow_len);
2976 put_stats__(alloc_xid(), OFPT10_STATS_REQUEST,
2977 htons(ofpst_type), htonl(nxst_subtype), msg);
2978 ofpbuf_padto(msg, openflow_len);
2984 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
2986 assert(request->header.type == OFPT10_STATS_REQUEST ||
2987 request->header.type == OFPT10_STATS_REPLY);
2988 put_stats__(request->header.xid, OFPT10_STATS_REPLY, request->type,
2989 (request->type != htons(OFPST_VENDOR)
2991 : ((const struct nicira_stats_msg *) request)->subtype),
2995 /* Creates a statistics reply message with total length 'openflow_len'
2996 * (including all headers) and the same type (either a standard OpenFlow
2997 * statistics type or a Nicira extension type and subtype) as 'request', and
2998 * stores the buffer containing the new message in '*bufferp'.
3000 * Initializes bytes following the headers to all-bits-zero.
3002 * Returns the first byte of the new message. */
3004 ofputil_make_stats_reply(size_t openflow_len,
3005 const struct ofp_stats_msg *request,
3006 struct ofpbuf **bufferp)
3010 msg = *bufferp = ofpbuf_new(openflow_len);
3011 put_stats_reply__(request, msg);
3012 ofpbuf_padto(msg, openflow_len);
3017 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
3018 * replies to 'request', which should be an OpenFlow or Nicira extension
3019 * statistics request. Initially 'replies' will have a single reply message
3020 * that has only a header. The functions ofputil_reserve_stats_reply() and
3021 * ofputil_append_stats_reply() may be used to add to the reply. */
3023 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
3024 struct list *replies)
3028 msg = ofpbuf_new(1024);
3029 put_stats_reply__(request, msg);
3032 list_push_back(replies, &msg->list_node);
3035 /* Prepares to append up to 'len' bytes to the series of statistics replies in
3036 * 'replies', which should have been initialized with
3037 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
3038 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
3039 * do so with e.g. ofpbuf_put_uninit().) */
3041 ofputil_reserve_stats_reply(size_t len, struct list *replies)
3043 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
3044 struct ofp_stats_msg *osm = msg->data;
3046 if (msg->size + len <= UINT16_MAX) {
3047 ofpbuf_prealloc_tailroom(msg, len);
3049 osm->flags |= htons(OFPSF_REPLY_MORE);
3051 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
3052 put_stats_reply__(osm, msg);
3053 list_push_back(replies, &msg->list_node);
3058 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
3059 * returns the first byte. */
3061 ofputil_append_stats_reply(size_t len, struct list *replies)
3063 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
3066 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
3068 ofputil_stats_body(const struct ofp_header *oh)
3070 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3071 return (const struct ofp_stats_msg *) oh + 1;
3074 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
3076 ofputil_stats_body_len(const struct ofp_header *oh)
3078 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3079 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
3082 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
3084 ofputil_nxstats_body(const struct ofp_header *oh)
3086 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3087 return ((const struct nicira_stats_msg *) oh) + 1;
3090 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
3092 ofputil_nxstats_body_len(const struct ofp_header *oh)
3094 assert(oh->type == OFPT10_STATS_REQUEST || oh->type == OFPT10_STATS_REPLY);
3095 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
3099 make_flow_mod(uint16_t command, const struct cls_rule *rule,
3102 struct ofp_flow_mod *ofm;
3103 size_t size = sizeof *ofm + actions_len;
3104 struct ofpbuf *out = ofpbuf_new(size);
3105 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
3106 ofm->header.version = OFP10_VERSION;
3107 ofm->header.type = OFPT10_FLOW_MOD;
3108 ofm->header.length = htons(size);
3110 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
3111 ofputil_cls_rule_to_match(rule, &ofm->match);
3112 ofm->command = htons(command);
3117 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
3118 uint16_t idle_timeout, size_t actions_len)
3120 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
3121 struct ofp_flow_mod *ofm = out->data;
3122 ofm->idle_timeout = htons(idle_timeout);
3123 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
3124 ofm->buffer_id = htonl(buffer_id);
3129 make_del_flow(const struct cls_rule *rule)
3131 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
3132 struct ofp_flow_mod *ofm = out->data;
3133 ofm->out_port = htons(OFPP_NONE);
3138 make_add_simple_flow(const struct cls_rule *rule,
3139 uint32_t buffer_id, uint16_t out_port,
3140 uint16_t idle_timeout)
3142 if (out_port != OFPP_NONE) {
3143 struct ofp_action_output *oao;
3144 struct ofpbuf *buffer;
3146 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
3147 ofputil_put_OFPAT10_OUTPUT(buffer)->port = htons(out_port);
3150 return make_add_flow(rule, buffer_id, idle_timeout, 0);
3155 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
3156 const struct ofpbuf *payload, int max_send_len)
3158 struct ofp_packet_in *opi;
3162 send_len = MIN(max_send_len, payload->size);
3163 buf = ofpbuf_new(sizeof *opi + send_len);
3164 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
3165 OFPT_PACKET_IN, 0, buf);
3166 opi->buffer_id = htonl(buffer_id);
3167 opi->total_len = htons(payload->size);
3168 opi->in_port = htons(in_port);
3169 opi->reason = reason;
3170 ofpbuf_put(buf, payload->data, send_len);
3171 update_openflow_length(buf);
3176 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
3178 make_echo_request(void)
3180 struct ofp_header *rq;
3181 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
3182 rq = ofpbuf_put_uninit(out, sizeof *rq);
3183 rq->version = OFP10_VERSION;
3184 rq->type = OFPT_ECHO_REQUEST;
3185 rq->length = htons(sizeof *rq);
3190 /* Creates and returns an OFPT_ECHO_REPLY message matching the
3191 * OFPT_ECHO_REQUEST message in 'rq'. */
3193 make_echo_reply(const struct ofp_header *rq)
3195 size_t size = ntohs(rq->length);
3196 struct ofpbuf *out = ofpbuf_new(size);
3197 struct ofp_header *reply = ofpbuf_put(out, rq, size);
3198 reply->type = OFPT_ECHO_REPLY;
3203 ofputil_encode_barrier_request(void)
3207 make_openflow(sizeof(struct ofp_header), OFPT10_BARRIER_REQUEST, &msg);
3212 ofputil_frag_handling_to_string(enum ofp_config_flags flags)
3214 switch (flags & OFPC_FRAG_MASK) {
3215 case OFPC_FRAG_NORMAL: return "normal";
3216 case OFPC_FRAG_DROP: return "drop";
3217 case OFPC_FRAG_REASM: return "reassemble";
3218 case OFPC_FRAG_NX_MATCH: return "nx-match";
3225 ofputil_frag_handling_from_string(const char *s, enum ofp_config_flags *flags)
3227 if (!strcasecmp(s, "normal")) {
3228 *flags = OFPC_FRAG_NORMAL;
3229 } else if (!strcasecmp(s, "drop")) {
3230 *flags = OFPC_FRAG_DROP;
3231 } else if (!strcasecmp(s, "reassemble")) {
3232 *flags = OFPC_FRAG_REASM;
3233 } else if (!strcasecmp(s, "nx-match")) {
3234 *flags = OFPC_FRAG_NX_MATCH;
3241 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
3242 * port number and stores the latter in '*ofp10_port', for the purpose of
3243 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
3244 * otherwise an OFPERR_* number.
3246 * See the definition of OFP11_MAX for an explanation of the mapping. */
3248 ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port)
3250 uint32_t ofp11_port_h = ntohl(ofp11_port);
3252 if (ofp11_port_h < OFPP_MAX) {
3253 *ofp10_port = ofp11_port_h;
3255 } else if (ofp11_port_h >= OFPP11_MAX) {
3256 *ofp10_port = ofp11_port_h - OFPP11_OFFSET;
3259 VLOG_WARN_RL(&bad_ofmsg_rl, "port %"PRIu32" is outside the supported "
3260 "range 0 through %d or 0x%"PRIx32" through 0x%"PRIx32,
3261 ofp11_port_h, OFPP_MAX - 1,
3262 (uint32_t) OFPP11_MAX, UINT32_MAX);
3263 return OFPERR_OFPBAC_BAD_OUT_PORT;
3267 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
3268 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
3270 * See the definition of OFP11_MAX for an explanation of the mapping. */
3272 ofputil_port_to_ofp11(uint16_t ofp10_port)
3274 return htonl(ofp10_port < OFPP_MAX
3276 : ofp10_port + OFPP11_OFFSET);
3279 /* Checks that 'port' is a valid output port for the OFPAT10_OUTPUT action, given
3280 * that the switch will never have more than 'max_ports' ports. Returns 0 if
3281 * 'port' is valid, otherwise an OpenFlow return code. */
3283 ofputil_check_output_port(uint16_t port, int max_ports)
3291 case OFPP_CONTROLLER:
3296 if (port < max_ports) {
3299 return OFPERR_OFPBAC_BAD_OUT_PORT;
3303 #define OFPUTIL_NAMED_PORTS \
3304 OFPUTIL_NAMED_PORT(IN_PORT) \
3305 OFPUTIL_NAMED_PORT(TABLE) \
3306 OFPUTIL_NAMED_PORT(NORMAL) \
3307 OFPUTIL_NAMED_PORT(FLOOD) \
3308 OFPUTIL_NAMED_PORT(ALL) \
3309 OFPUTIL_NAMED_PORT(CONTROLLER) \
3310 OFPUTIL_NAMED_PORT(LOCAL) \
3311 OFPUTIL_NAMED_PORT(NONE)
3313 /* Checks whether 's' is the string representation of an OpenFlow port number,
3314 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
3315 * number in '*port' and returns true. Otherwise, returns false. */
3317 ofputil_port_from_string(const char *name, uint16_t *port)
3323 static const struct pair pairs[] = {
3324 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
3326 #undef OFPUTIL_NAMED_PORT
3328 static const int n_pairs = ARRAY_SIZE(pairs);
3331 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
3336 for (i = 0; i < n_pairs; i++) {
3337 if (!strcasecmp(name, pairs[i].name)) {
3338 *port = pairs[i].value;
3345 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
3346 * Most ports' string representation is just the port number, but for special
3347 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
3349 ofputil_format_port(uint16_t port, struct ds *s)
3354 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
3356 #undef OFPUTIL_NAMED_PORT
3359 ds_put_format(s, "%"PRIu16, port);
3362 ds_put_cstr(s, name);
3366 check_resubmit_table(const struct nx_action_resubmit *nar)
3368 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
3369 return OFPERR_OFPBAC_BAD_ARGUMENT;
3375 check_output_reg(const struct nx_action_output_reg *naor,
3376 const struct flow *flow)
3378 struct mf_subfield src;
3381 for (i = 0; i < sizeof naor->zero; i++) {
3382 if (naor->zero[i]) {
3383 return OFPERR_OFPBAC_BAD_ARGUMENT;
3387 nxm_decode(&src, naor->src, naor->ofs_nbits);
3388 return mf_check_src(&src, flow);
3392 validate_actions(const union ofp_action *actions, size_t n_actions,
3393 const struct flow *flow, int max_ports)
3395 const union ofp_action *a;
3398 OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
3403 code = ofputil_decode_action(a);
3406 VLOG_WARN_RL(&bad_ofmsg_rl,
3407 "action decoding error at offset %td (%s)",
3408 (a - actions) * sizeof *a, ofperr_get_name(error));
3414 switch ((enum ofputil_action_code) code) {
3415 case OFPUTIL_OFPAT10_OUTPUT:
3416 error = ofputil_check_output_port(ntohs(a->output.port),
3420 case OFPUTIL_OFPAT10_SET_VLAN_VID:
3421 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
3422 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3426 case OFPUTIL_OFPAT10_SET_VLAN_PCP:
3427 if (a->vlan_pcp.vlan_pcp & ~7) {
3428 error = OFPERR_OFPBAC_BAD_ARGUMENT;
3432 case OFPUTIL_OFPAT10_ENQUEUE:
3433 port = ntohs(((const struct ofp_action_enqueue *) a)->port);
3434 if (port >= max_ports && port != OFPP_IN_PORT
3435 && port != OFPP_LOCAL) {
3436 error = OFPERR_OFPBAC_BAD_OUT_PORT;
3440 case OFPUTIL_NXAST_REG_MOVE:
3441 error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
3445 case OFPUTIL_NXAST_REG_LOAD:
3446 error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
3450 case OFPUTIL_NXAST_MULTIPATH:
3451 error = multipath_check((const struct nx_action_multipath *) a,
3455 case OFPUTIL_NXAST_AUTOPATH:
3456 error = autopath_check((const struct nx_action_autopath *) a,
3460 case OFPUTIL_NXAST_BUNDLE:
3461 case OFPUTIL_NXAST_BUNDLE_LOAD:
3462 error = bundle_check((const struct nx_action_bundle *) a,
3466 case OFPUTIL_NXAST_OUTPUT_REG:
3467 error = check_output_reg((const struct nx_action_output_reg *) a,
3471 case OFPUTIL_NXAST_RESUBMIT_TABLE:
3472 error = check_resubmit_table(
3473 (const struct nx_action_resubmit *) a);
3476 case OFPUTIL_NXAST_LEARN:
3477 error = learn_check((const struct nx_action_learn *) a, flow);
3480 case OFPUTIL_NXAST_CONTROLLER:
3481 if (((const struct nx_action_controller *) a)->zero) {
3482 error = OFPERR_NXBAC_MUST_BE_ZERO;
3486 case OFPUTIL_OFPAT10_STRIP_VLAN:
3487 case OFPUTIL_OFPAT10_SET_NW_SRC:
3488 case OFPUTIL_OFPAT10_SET_NW_DST:
3489 case OFPUTIL_OFPAT10_SET_NW_TOS:
3490 case OFPUTIL_OFPAT10_SET_TP_SRC:
3491 case OFPUTIL_OFPAT10_SET_TP_DST:
3492 case OFPUTIL_OFPAT10_SET_DL_SRC:
3493 case OFPUTIL_OFPAT10_SET_DL_DST:
3494 case OFPUTIL_NXAST_RESUBMIT:
3495 case OFPUTIL_NXAST_SET_TUNNEL:
3496 case OFPUTIL_NXAST_SET_QUEUE:
3497 case OFPUTIL_NXAST_POP_QUEUE:
3498 case OFPUTIL_NXAST_NOTE:
3499 case OFPUTIL_NXAST_SET_TUNNEL64:
3500 case OFPUTIL_NXAST_EXIT:
3501 case OFPUTIL_NXAST_DEC_TTL:
3502 case OFPUTIL_NXAST_FIN_TIMEOUT:
3507 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
3508 (a - actions) * sizeof *a, ofperr_get_name(error));
3513 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
3514 (n_actions - left) * sizeof *a);
3515 return OFPERR_OFPBAC_BAD_LEN;
3520 struct ofputil_action {
3522 unsigned int min_len;
3523 unsigned int max_len;
3526 static const struct ofputil_action action_bad_type
3527 = { -OFPERR_OFPBAC_BAD_TYPE, 0, UINT_MAX };
3528 static const struct ofputil_action action_bad_len
3529 = { -OFPERR_OFPBAC_BAD_LEN, 0, UINT_MAX };
3530 static const struct ofputil_action action_bad_vendor
3531 = { -OFPERR_OFPBAC_BAD_VENDOR, 0, UINT_MAX };
3533 static const struct ofputil_action *
3534 ofputil_decode_ofpat_action(const union ofp_action *a)
3536 enum ofp10_action_type type = ntohs(a->type);
3539 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3541 static const struct ofputil_action action = { \
3543 sizeof(struct STRUCT), \
3544 sizeof(struct STRUCT) \
3548 #include "ofp-util.def"
3550 case OFPAT10_VENDOR:
3552 return &action_bad_type;
3556 static const struct ofputil_action *
3557 ofputil_decode_nxast_action(const union ofp_action *a)
3559 const struct nx_action_header *nah = (const struct nx_action_header *) a;
3560 enum nx_action_subtype subtype = ntohs(nah->subtype);
3563 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3565 static const struct ofputil_action action = { \
3567 sizeof(struct STRUCT), \
3568 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT) \
3572 #include "ofp-util.def"
3574 case NXAST_SNAT__OBSOLETE:
3575 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
3577 return &action_bad_type;
3581 /* Parses 'a' to determine its type. Returns a nonnegative OFPUTIL_OFPAT10_* or
3582 * OFPUTIL_NXAST_* constant if successful, otherwise a negative OFPERR_* error
3585 * The caller must have already verified that 'a''s length is correct (that is,
3586 * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
3587 * longer than the amount of space allocated to 'a').
3589 * This function verifies that 'a''s length is correct for the type of action
3590 * that it represents. */
3592 ofputil_decode_action(const union ofp_action *a)
3594 const struct ofputil_action *action;
3595 uint16_t len = ntohs(a->header.len);
3597 if (a->type != htons(OFPAT10_VENDOR)) {
3598 action = ofputil_decode_ofpat_action(a);
3600 switch (ntohl(a->vendor.vendor)) {
3602 if (len < sizeof(struct nx_action_header)) {
3603 return -OFPERR_OFPBAC_BAD_LEN;
3605 action = ofputil_decode_nxast_action(a);
3608 action = &action_bad_vendor;
3613 return (len >= action->min_len && len <= action->max_len
3615 : -OFPERR_OFPBAC_BAD_LEN);
3618 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT10_* or OFPUTIL_NXAST_*
3619 * constant. The caller must have already validated that 'a' is a valid action
3620 * understood by Open vSwitch (e.g. by a previous successful call to
3621 * ofputil_decode_action()). */
3622 enum ofputil_action_code
3623 ofputil_decode_action_unsafe(const union ofp_action *a)
3625 const struct ofputil_action *action;
3627 if (a->type != htons(OFPAT10_VENDOR)) {
3628 action = ofputil_decode_ofpat_action(a);
3630 action = ofputil_decode_nxast_action(a);
3633 return action->code;
3636 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
3637 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1 if
3638 * 'name' is not the name of any action.
3640 * ofp-util.def lists the mapping from names to action. */
3642 ofputil_action_code_from_name(const char *name)
3644 static const char *names[OFPUTIL_N_ACTIONS] = {
3645 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
3646 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
3647 #include "ofp-util.def"
3652 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
3653 if (*p && !strcasecmp(name, *p)) {
3660 /* Appends an action of the type specified by 'code' to 'buf' and returns the
3661 * action. Initializes the parts of 'action' that identify it as having type
3662 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
3663 * have variable length, the length used and cleared is that of struct
3666 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
3669 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3670 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3671 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3672 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
3673 #include "ofp-util.def"
3678 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
3680 ofputil_init_##ENUM(struct STRUCT *s) \
3682 memset(s, 0, sizeof *s); \
3683 s->type = htons(ENUM); \
3684 s->len = htons(sizeof *s); \
3688 ofputil_put_##ENUM(struct ofpbuf *buf) \
3690 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3691 ofputil_init_##ENUM(s); \
3694 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
3696 ofputil_init_##ENUM(struct STRUCT *s) \
3698 memset(s, 0, sizeof *s); \
3699 s->type = htons(OFPAT10_VENDOR); \
3700 s->len = htons(sizeof *s); \
3701 s->vendor = htonl(NX_VENDOR_ID); \
3702 s->subtype = htons(ENUM); \
3706 ofputil_put_##ENUM(struct ofpbuf *buf) \
3708 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
3709 ofputil_init_##ENUM(s); \
3712 #include "ofp-util.def"
3714 /* Returns true if 'action' outputs to 'port', false otherwise. */
3716 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
3718 switch (ntohs(action->type)) {
3719 case OFPAT10_OUTPUT:
3720 return action->output.port == port;
3721 case OFPAT10_ENQUEUE:
3722 return ((const struct ofp_action_enqueue *) action)->port == port;
3728 /* "Normalizes" the wildcards in 'rule'. That means:
3730 * 1. If the type of level N is known, then only the valid fields for that
3731 * level may be specified. For example, ARP does not have a TOS field,
3732 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
3733 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
3734 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
3737 * 2. If the type of level N is not known (or not understood by Open
3738 * vSwitch), then no fields at all for that level may be specified. For
3739 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
3740 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
3744 ofputil_normalize_rule(struct cls_rule *rule)
3747 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
3748 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
3749 MAY_NW_PROTO = 1 << 2, /* nw_proto */
3750 MAY_IPVx = 1 << 3, /* tos, frag, ttl */
3751 MAY_ARP_SHA = 1 << 4, /* arp_sha */
3752 MAY_ARP_THA = 1 << 5, /* arp_tha */
3753 MAY_IPV6 = 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
3754 MAY_ND_TARGET = 1 << 7 /* nd_target */
3757 struct flow_wildcards wc;
3759 /* Figure out what fields may be matched. */
3760 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
3761 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_NW_ADDR;
3762 if (rule->flow.nw_proto == IPPROTO_TCP ||
3763 rule->flow.nw_proto == IPPROTO_UDP ||
3764 rule->flow.nw_proto == IPPROTO_ICMP) {
3765 may_match |= MAY_TP_ADDR;
3767 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)) {
3768 may_match = MAY_NW_PROTO | MAY_IPVx | MAY_IPV6;
3769 if (rule->flow.nw_proto == IPPROTO_TCP ||
3770 rule->flow.nw_proto == IPPROTO_UDP) {
3771 may_match |= MAY_TP_ADDR;
3772 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
3773 may_match |= MAY_TP_ADDR;
3774 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
3775 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
3776 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
3777 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
3780 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
3781 may_match = MAY_NW_PROTO | MAY_NW_ADDR | MAY_ARP_SHA | MAY_ARP_THA;
3786 /* Clear the fields that may not be matched. */
3788 if (!(may_match & MAY_NW_ADDR)) {
3789 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
3791 if (!(may_match & MAY_TP_ADDR)) {
3792 wc.tp_src_mask = wc.tp_dst_mask = htons(0);
3794 if (!(may_match & MAY_NW_PROTO)) {
3795 wc.wildcards |= FWW_NW_PROTO;
3797 if (!(may_match & MAY_IPVx)) {
3798 wc.wildcards |= FWW_NW_DSCP;
3799 wc.wildcards |= FWW_NW_ECN;
3800 wc.wildcards |= FWW_NW_TTL;
3802 if (!(may_match & MAY_ARP_SHA)) {
3803 wc.wildcards |= FWW_ARP_SHA;
3805 if (!(may_match & MAY_ARP_THA)) {
3806 wc.wildcards |= FWW_ARP_THA;
3808 if (!(may_match & MAY_IPV6)) {
3809 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
3810 wc.wildcards |= FWW_IPV6_LABEL;
3812 if (!(may_match & MAY_ND_TARGET)) {
3813 wc.nd_target_mask = in6addr_any;
3816 /* Log any changes. */
3817 if (!flow_wildcards_equal(&wc, &rule->wc)) {
3818 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
3819 char *pre = log ? cls_rule_to_string(rule) : NULL;
3822 cls_rule_zero_wildcarded_fields(rule);
3825 char *post = cls_rule_to_string(rule);
3826 VLOG_INFO("normalization changed ofp_match, details:");
3827 VLOG_INFO(" pre: %s", pre);
3828 VLOG_INFO("post: %s", post);
3835 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
3836 * successful, otherwise an OpenFlow error.
3838 * If successful, the first action is stored in '*actionsp' and the number of
3839 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
3840 * are stored, respectively.
3842 * This function does not check that the actions are valid (the caller should
3843 * do so, with validate_actions()). The caller is also responsible for making
3844 * sure that 'b->data' is initially aligned appropriately for "union
3847 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
3848 union ofp_action **actionsp, size_t *n_actionsp)
3850 if (actions_len % OFP_ACTION_ALIGN != 0) {
3851 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3852 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
3856 *actionsp = ofpbuf_try_pull(b, actions_len);
3857 if (*actionsp == NULL) {
3858 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
3859 "exceeds remaining message length (%zu)",
3860 actions_len, b->size);
3864 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
3870 return OFPERR_OFPBRC_BAD_LEN;
3874 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
3875 const union ofp_action *b, size_t n_b)
3877 return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
3881 ofputil_actions_clone(const union ofp_action *actions, size_t n)
3883 return n ? xmemdup(actions, n * sizeof *actions) : NULL;
3886 /* Parses a key or a key-value pair from '*stringp'.
3888 * On success: Stores the key into '*keyp'. Stores the value, if present, into
3889 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
3890 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
3891 * are substrings of '*stringp' created by replacing some of its bytes by null
3892 * terminators. Returns true.
3894 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
3895 * NULL and returns false. */
3897 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
3899 char *pos, *key, *value;
3903 pos += strspn(pos, ", \t\r\n");
3905 *keyp = *valuep = NULL;
3910 key_len = strcspn(pos, ":=(, \t\r\n");
3911 if (key[key_len] == ':' || key[key_len] == '=') {
3912 /* The value can be separated by a colon. */
3915 value = key + key_len + 1;
3916 value_len = strcspn(value, ", \t\r\n");
3917 pos = value + value_len + (value[value_len] != '\0');
3918 value[value_len] = '\0';
3919 } else if (key[key_len] == '(') {
3920 /* The value can be surrounded by balanced parentheses. The outermost
3921 * set of parentheses is removed. */
3925 value = key + key_len + 1;
3926 for (value_len = 0; level > 0; value_len++) {
3927 switch (value[value_len]) {
3941 value[value_len - 1] = '\0';
3942 pos = value + value_len;
3944 /* There might be no value at all. */
3945 value = key + key_len; /* Will become the empty string below. */
3946 pos = key + key_len + (key[key_len] != '\0');
3948 key[key_len] = '\0';