2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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 <netinet/icmp6.h>
24 #include "byte-order.h"
25 #include "classifier.h"
26 #include "dynamic-string.h"
27 #include "multipath.h"
29 #include "ofp-errors.h"
34 #include "unaligned.h"
35 #include "type-props.h"
38 VLOG_DEFINE_THIS_MODULE(ofp_util);
40 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
41 * in the peer and so there's not much point in showing a lot of them. */
42 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
44 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
45 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
48 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
49 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
50 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
51 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
54 ofputil_wcbits_to_netmask(int wcbits)
57 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
60 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
61 * that it wildcards. 'netmask' must be a CIDR netmask (see ip_is_cidr()). */
63 ofputil_netmask_to_wcbits(ovs_be32 netmask)
65 assert(ip_is_cidr(netmask));
67 return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask));
71 for (wcbits = 32; netmask; wcbits--) {
72 netmask &= netmask - 1;
79 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
81 #define WC_INVARIANT_LIST \
82 WC_INVARIANT_BIT(IN_PORT) \
83 WC_INVARIANT_BIT(DL_SRC) \
84 WC_INVARIANT_BIT(DL_DST) \
85 WC_INVARIANT_BIT(DL_TYPE) \
86 WC_INVARIANT_BIT(NW_PROTO) \
87 WC_INVARIANT_BIT(TP_SRC) \
88 WC_INVARIANT_BIT(TP_DST)
90 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
91 * actually have the same names and values. */
92 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
94 #undef WC_INVARIANT_BIT
96 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
98 static const flow_wildcards_t WC_INVARIANTS = 0
99 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
101 #undef WC_INVARIANT_BIT
104 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
105 * struct cls_rule. It is the caller's responsibility to handle the special
106 * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
108 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
110 /* Initialize most of rule->wc. */
111 flow_wildcards_init_catchall(wc);
112 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
114 /* Wildcard fields that aren't defined by ofp_match or tun_id. */
115 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_ND_TARGET);
117 if (ofpfw & OFPFW_NW_TOS) {
118 wc->wildcards |= FWW_NW_TOS;
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_DL_DST) {
124 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
125 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
126 * and FWW_ETH_MCAST. */
127 wc->wildcards |= FWW_ETH_MCAST;
131 if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
132 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
134 if (!(ofpfw & OFPFW_DL_VLAN)) {
135 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
139 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
142 ofputil_cls_rule_from_match(const struct ofp_match *match,
143 unsigned int priority, struct cls_rule *rule)
145 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
147 /* Initialize rule->priority, rule->wc. */
148 rule->priority = !ofpfw ? UINT16_MAX : priority;
149 ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
151 /* Initialize most of rule->flow. */
152 rule->flow.nw_src = match->nw_src;
153 rule->flow.nw_dst = match->nw_dst;
154 rule->flow.in_port = ntohs(match->in_port);
155 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
156 rule->flow.tp_src = match->tp_src;
157 rule->flow.tp_dst = match->tp_dst;
158 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
159 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
160 rule->flow.nw_tos = match->nw_tos;
161 rule->flow.nw_proto = match->nw_proto;
163 /* Translate VLANs. */
164 if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
165 /* Match only packets without 802.1Q header.
167 * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
169 * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
170 * because we can't have a specific PCP without an 802.1Q header.
171 * However, older versions of OVS treated this as matching packets
172 * withut an 802.1Q header, so we do here too. */
173 rule->flow.vlan_tci = htons(0);
174 rule->wc.vlan_tci_mask = htons(0xffff);
176 ovs_be16 vid, pcp, tci;
178 vid = match->dl_vlan & htons(VLAN_VID_MASK);
179 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
180 tci = vid | pcp | htons(VLAN_CFI);
181 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
185 cls_rule_zero_wildcarded_fields(rule);
188 /* Convert 'rule' into the OpenFlow match structure 'match'. */
190 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
192 const struct flow_wildcards *wc = &rule->wc;
195 /* Figure out most OpenFlow wildcards. */
196 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
197 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
198 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
199 if (wc->wildcards & FWW_NW_TOS) {
200 ofpfw |= OFPFW_NW_TOS;
203 /* Translate VLANs. */
204 match->dl_vlan = htons(0);
205 match->dl_vlan_pcp = 0;
206 if (rule->wc.vlan_tci_mask == htons(0)) {
207 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
208 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
209 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
210 match->dl_vlan = htons(OFP_VLAN_NONE);
212 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
213 ofpfw |= OFPFW_DL_VLAN;
215 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
218 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
219 ofpfw |= OFPFW_DL_VLAN_PCP;
221 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
225 /* Compose most of the match structure. */
226 match->wildcards = htonl(ofpfw);
227 match->in_port = htons(rule->flow.in_port);
228 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
229 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
230 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
231 match->nw_src = rule->flow.nw_src;
232 match->nw_dst = rule->flow.nw_dst;
233 match->nw_tos = rule->flow.nw_tos;
234 match->nw_proto = rule->flow.nw_proto;
235 match->tp_src = rule->flow.tp_src;
236 match->tp_dst = rule->flow.tp_dst;
237 memset(match->pad1, '\0', sizeof match->pad1);
238 memset(match->pad2, '\0', sizeof match->pad2);
241 /* Given a 'dl_type' value in the format used in struct flow, returns the
242 * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
244 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
246 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
247 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
251 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
252 * structure, returns the corresponding 'dl_type' value for use in struct
255 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
257 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
258 ? htons(FLOW_DL_TYPE_NONE)
262 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
266 static uint32_t next_xid = 1;
267 return htonl(next_xid++);
270 /* Basic parsing of OpenFlow messages. */
272 struct ofputil_msg_type {
273 enum ofputil_msg_code code; /* OFPUTIL_*. */
274 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
275 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
276 unsigned int min_size; /* Minimum total message size in bytes. */
277 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
278 * the message may exceed 'min_size' by an even multiple of this value. */
279 unsigned int extra_multiple;
282 struct ofputil_msg_category {
283 const char *name; /* e.g. "OpenFlow message" */
284 const struct ofputil_msg_type *types;
286 int missing_error; /* ofp_mkerr() value for missing type. */
290 ofputil_length_ok(const struct ofputil_msg_category *cat,
291 const struct ofputil_msg_type *type,
294 switch (type->extra_multiple) {
296 if (size != type->min_size) {
297 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
298 "length %u (expected length %u)",
299 cat->name, type->name, size, type->min_size);
305 if (size < type->min_size) {
306 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
307 "length %u (expected length at least %u bytes)",
308 cat->name, type->name, size, type->min_size);
314 if (size < type->min_size
315 || (size - type->min_size) % type->extra_multiple) {
316 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
317 "length %u (must be exactly %u bytes or longer "
318 "by an integer multiple of %u bytes)",
319 cat->name, type->name, size,
320 type->min_size, type->extra_multiple);
328 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
329 uint32_t value, unsigned int size,
330 const struct ofputil_msg_type **typep)
332 const struct ofputil_msg_type *type;
334 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
335 if (type->value == value) {
336 if (!ofputil_length_ok(cat, type, size)) {
337 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
344 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
346 return cat->missing_error;
350 ofputil_decode_vendor(const struct ofp_header *oh,
351 const struct ofputil_msg_type **typep)
353 BUILD_ASSERT_DECL(sizeof(struct nxt_set_flow_format)
354 != sizeof(struct nxt_flow_mod_table_id));
356 static const struct ofputil_msg_type nxt_messages[] = {
357 { OFPUTIL_NXT_ROLE_REQUEST,
358 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
359 sizeof(struct nx_role_request), 0 },
361 { OFPUTIL_NXT_ROLE_REPLY,
362 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
363 sizeof(struct nx_role_request), 0 },
365 { OFPUTIL_NXT_SET_FLOW_FORMAT,
366 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
367 sizeof(struct nxt_set_flow_format), 0 },
369 { OFPUTIL_NXT_FLOW_MOD,
370 NXT_FLOW_MOD, "NXT_FLOW_MOD",
371 sizeof(struct nx_flow_mod), 8 },
373 { OFPUTIL_NXT_FLOW_REMOVED,
374 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
375 sizeof(struct nx_flow_removed), 8 },
377 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
378 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
379 sizeof(struct nxt_flow_mod_table_id), 0 },
382 static const struct ofputil_msg_category nxt_category = {
383 "Nicira extension message",
384 nxt_messages, ARRAY_SIZE(nxt_messages),
385 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
388 const struct ofp_vendor_header *ovh;
389 const struct nicira_header *nh;
391 ovh = (const struct ofp_vendor_header *) oh;
392 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
393 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
394 "vendor %"PRIx32, ntohl(ovh->vendor));
395 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
398 if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
399 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
400 "length %u (expected at least %zu)",
401 ntohs(ovh->header.length), sizeof(struct nicira_header));
402 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
405 nh = (const struct nicira_header *) oh;
406 return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
407 ntohs(oh->length), typep);
411 check_nxstats_msg(const struct ofp_header *oh)
413 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
416 memcpy(&vendor, osm + 1, sizeof vendor);
417 if (vendor != htonl(NX_VENDOR_ID)) {
418 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
419 "unknown vendor %"PRIx32, ntohl(vendor));
420 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
423 if (ntohs(osm->header.length) < sizeof(struct nicira_stats_msg)) {
424 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
425 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
432 ofputil_decode_nxst_request(const struct ofp_header *oh,
433 const struct ofputil_msg_type **typep)
435 static const struct ofputil_msg_type nxst_requests[] = {
436 { OFPUTIL_NXST_FLOW_REQUEST,
437 NXST_FLOW, "NXST_FLOW request",
438 sizeof(struct nx_flow_stats_request), 8 },
440 { OFPUTIL_NXST_AGGREGATE_REQUEST,
441 NXST_AGGREGATE, "NXST_AGGREGATE request",
442 sizeof(struct nx_aggregate_stats_request), 8 },
445 static const struct ofputil_msg_category nxst_request_category = {
446 "Nicira extension statistics request",
447 nxst_requests, ARRAY_SIZE(nxst_requests),
448 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
451 const struct nicira_stats_msg *nsm;
454 error = check_nxstats_msg(oh);
459 nsm = (struct nicira_stats_msg *) oh;
460 return ofputil_lookup_openflow_message(&nxst_request_category,
462 ntohs(oh->length), typep);
466 ofputil_decode_nxst_reply(const struct ofp_header *oh,
467 const struct ofputil_msg_type **typep)
469 static const struct ofputil_msg_type nxst_replies[] = {
470 { OFPUTIL_NXST_FLOW_REPLY,
471 NXST_FLOW, "NXST_FLOW reply",
472 sizeof(struct nicira_stats_msg), 8 },
474 { OFPUTIL_NXST_AGGREGATE_REPLY,
475 NXST_AGGREGATE, "NXST_AGGREGATE reply",
476 sizeof(struct nx_aggregate_stats_reply), 0 },
479 static const struct ofputil_msg_category nxst_reply_category = {
480 "Nicira extension statistics reply",
481 nxst_replies, ARRAY_SIZE(nxst_replies),
482 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
485 const struct nicira_stats_msg *nsm;
488 error = check_nxstats_msg(oh);
493 nsm = (struct nicira_stats_msg *) oh;
494 return ofputil_lookup_openflow_message(&nxst_reply_category,
496 ntohs(oh->length), typep);
500 ofputil_decode_ofpst_request(const struct ofp_header *oh,
501 const struct ofputil_msg_type **typep)
503 static const struct ofputil_msg_type ofpst_requests[] = {
504 { OFPUTIL_OFPST_DESC_REQUEST,
505 OFPST_DESC, "OFPST_DESC request",
506 sizeof(struct ofp_stats_msg), 0 },
508 { OFPUTIL_OFPST_FLOW_REQUEST,
509 OFPST_FLOW, "OFPST_FLOW request",
510 sizeof(struct ofp_flow_stats_request), 0 },
512 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
513 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
514 sizeof(struct ofp_flow_stats_request), 0 },
516 { OFPUTIL_OFPST_TABLE_REQUEST,
517 OFPST_TABLE, "OFPST_TABLE request",
518 sizeof(struct ofp_stats_msg), 0 },
520 { OFPUTIL_OFPST_PORT_REQUEST,
521 OFPST_PORT, "OFPST_PORT request",
522 sizeof(struct ofp_port_stats_request), 0 },
524 { OFPUTIL_OFPST_QUEUE_REQUEST,
525 OFPST_QUEUE, "OFPST_QUEUE request",
526 sizeof(struct ofp_queue_stats_request), 0 },
529 OFPST_VENDOR, "OFPST_VENDOR request",
530 sizeof(struct ofp_vendor_stats_msg), 1 },
533 static const struct ofputil_msg_category ofpst_request_category = {
534 "OpenFlow statistics",
535 ofpst_requests, ARRAY_SIZE(ofpst_requests),
536 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
539 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
542 error = ofputil_lookup_openflow_message(&ofpst_request_category,
543 ntohs(request->type),
544 ntohs(oh->length), typep);
545 if (!error && request->type == htons(OFPST_VENDOR)) {
546 error = ofputil_decode_nxst_request(oh, typep);
552 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
553 const struct ofputil_msg_type **typep)
555 static const struct ofputil_msg_type ofpst_replies[] = {
556 { OFPUTIL_OFPST_DESC_REPLY,
557 OFPST_DESC, "OFPST_DESC reply",
558 sizeof(struct ofp_desc_stats), 0 },
560 { OFPUTIL_OFPST_FLOW_REPLY,
561 OFPST_FLOW, "OFPST_FLOW reply",
562 sizeof(struct ofp_stats_msg), 1 },
564 { OFPUTIL_OFPST_AGGREGATE_REPLY,
565 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
566 sizeof(struct ofp_aggregate_stats_reply), 0 },
568 { OFPUTIL_OFPST_TABLE_REPLY,
569 OFPST_TABLE, "OFPST_TABLE reply",
570 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
572 { OFPUTIL_OFPST_PORT_REPLY,
573 OFPST_PORT, "OFPST_PORT reply",
574 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
576 { OFPUTIL_OFPST_QUEUE_REPLY,
577 OFPST_QUEUE, "OFPST_QUEUE reply",
578 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
581 OFPST_VENDOR, "OFPST_VENDOR reply",
582 sizeof(struct ofp_vendor_stats_msg), 1 },
585 static const struct ofputil_msg_category ofpst_reply_category = {
586 "OpenFlow statistics",
587 ofpst_replies, ARRAY_SIZE(ofpst_replies),
588 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
591 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
594 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
596 ntohs(oh->length), typep);
597 if (!error && reply->type == htons(OFPST_VENDOR)) {
598 error = ofputil_decode_nxst_reply(oh, typep);
603 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
604 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
605 * way, stores in '*typep' a type structure that can be inspected with the
606 * ofputil_msg_type_*() functions.
608 * oh->length must indicate the correct length of the message (and must be at
609 * least sizeof(struct ofp_header)).
611 * Success indicates that 'oh' is at least as long as the minimum-length
612 * message of its type. */
614 ofputil_decode_msg_type(const struct ofp_header *oh,
615 const struct ofputil_msg_type **typep)
617 static const struct ofputil_msg_type ofpt_messages[] = {
618 { OFPUTIL_OFPT_HELLO,
619 OFPT_HELLO, "OFPT_HELLO",
620 sizeof(struct ofp_hello), 1 },
622 { OFPUTIL_OFPT_ERROR,
623 OFPT_ERROR, "OFPT_ERROR",
624 sizeof(struct ofp_error_msg), 1 },
626 { OFPUTIL_OFPT_ECHO_REQUEST,
627 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
628 sizeof(struct ofp_header), 1 },
630 { OFPUTIL_OFPT_ECHO_REPLY,
631 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
632 sizeof(struct ofp_header), 1 },
634 { OFPUTIL_OFPT_FEATURES_REQUEST,
635 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
636 sizeof(struct ofp_header), 0 },
638 { OFPUTIL_OFPT_FEATURES_REPLY,
639 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
640 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
642 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
643 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
644 sizeof(struct ofp_header), 0 },
646 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
647 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
648 sizeof(struct ofp_switch_config), 0 },
650 { OFPUTIL_OFPT_SET_CONFIG,
651 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
652 sizeof(struct ofp_switch_config), 0 },
654 { OFPUTIL_OFPT_PACKET_IN,
655 OFPT_PACKET_IN, "OFPT_PACKET_IN",
656 offsetof(struct ofp_packet_in, data), 1 },
658 { OFPUTIL_OFPT_FLOW_REMOVED,
659 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
660 sizeof(struct ofp_flow_removed), 0 },
662 { OFPUTIL_OFPT_PORT_STATUS,
663 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
664 sizeof(struct ofp_port_status), 0 },
666 { OFPUTIL_OFPT_PACKET_OUT,
667 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
668 sizeof(struct ofp_packet_out), 1 },
670 { OFPUTIL_OFPT_FLOW_MOD,
671 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
672 sizeof(struct ofp_flow_mod), 1 },
674 { OFPUTIL_OFPT_PORT_MOD,
675 OFPT_PORT_MOD, "OFPT_PORT_MOD",
676 sizeof(struct ofp_port_mod), 0 },
679 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
680 sizeof(struct ofp_stats_msg), 1 },
683 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
684 sizeof(struct ofp_stats_msg), 1 },
686 { OFPUTIL_OFPT_BARRIER_REQUEST,
687 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
688 sizeof(struct ofp_header), 0 },
690 { OFPUTIL_OFPT_BARRIER_REPLY,
691 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
692 sizeof(struct ofp_header), 0 },
695 OFPT_VENDOR, "OFPT_VENDOR",
696 sizeof(struct ofp_vendor_header), 1 },
699 static const struct ofputil_msg_category ofpt_category = {
701 ofpt_messages, ARRAY_SIZE(ofpt_messages),
702 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
707 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
708 ntohs(oh->length), typep);
712 error = ofputil_decode_vendor(oh, typep);
715 case OFPT_STATS_REQUEST:
716 error = ofputil_decode_ofpst_request(oh, typep);
719 case OFPT_STATS_REPLY:
720 error = ofputil_decode_ofpst_reply(oh, typep);
727 static const struct ofputil_msg_type ofputil_invalid_type = {
729 0, "OFPUTIL_INVALID",
733 *typep = &ofputil_invalid_type;
738 /* Returns an OFPUTIL_* message type code for 'type'. */
739 enum ofputil_msg_code
740 ofputil_msg_type_code(const struct ofputil_msg_type *type)
748 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
750 switch (flow_format) {
751 case NXFF_OPENFLOW10:
760 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
762 switch (flow_format) {
763 case NXFF_OPENFLOW10:
773 ofputil_flow_format_from_string(const char *s)
775 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
776 : !strcmp(s, "nxm") ? NXFF_NXM
781 regs_fully_wildcarded(const struct flow_wildcards *wc)
785 for (i = 0; i < FLOW_N_REGS; i++) {
786 if (wc->reg_masks[i] != 0) {
793 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
794 * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
795 * or fixing the Ethernet multicast bit. Otherwise, it's better to use
796 * NXFF_OPENFLOW10 for backward compatibility. */
798 ofputil_min_flow_format(const struct cls_rule *rule)
800 const struct flow_wildcards *wc = &rule->wc;
802 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
803 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
807 /* Only NXM supports matching ARP hardware addresses. */
808 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
812 /* Only NXM supports matching IPv6 traffic. */
813 if (!(wc->wildcards & FWW_DL_TYPE)
814 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
818 /* Only NXM supports matching registers. */
819 if (!regs_fully_wildcarded(wc)) {
823 /* Only NXM supports matching tun_id. */
824 if (wc->tun_id_mask != htonll(0)) {
828 /* Other formats can express this rule. */
829 return NXFF_OPENFLOW10;
832 /* Returns an OpenFlow message that can be used to set the flow format to
835 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
837 struct nxt_set_flow_format *sff;
840 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
841 sff->format = htonl(flow_format);
846 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
847 * extension on or off (according to 'flow_mod_table_id'). */
849 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
851 struct nxt_flow_mod_table_id *nfmti;
854 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
855 nfmti->set = flow_mod_table_id;
859 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
860 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
863 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
864 * enabled, false otherwise.
866 * Does not validate the flow_mod actions. */
868 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
869 bool flow_mod_table_id)
871 const struct ofputil_msg_type *type;
875 ofpbuf_use_const(&b, oh, ntohs(oh->length));
877 ofputil_decode_msg_type(oh, &type);
878 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
879 /* Standard OpenFlow flow_mod. */
880 const struct ofp_flow_mod *ofm;
884 /* Dissect the message. */
885 ofm = ofpbuf_pull(&b, sizeof *ofm);
886 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
891 /* Set priority based on original wildcards. Normally we'd allow
892 * ofputil_cls_rule_from_match() to do this for us, but
893 * ofputil_normalize_rule() can put wildcards where the original flow
894 * didn't have them. */
895 priority = ntohs(ofm->priority);
896 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
897 priority = UINT16_MAX;
900 /* Translate the rule. */
901 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
902 ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
904 /* Translate the message. */
905 fm->cookie = ofm->cookie;
906 command = ntohs(ofm->command);
907 fm->idle_timeout = ntohs(ofm->idle_timeout);
908 fm->hard_timeout = ntohs(ofm->hard_timeout);
909 fm->buffer_id = ntohl(ofm->buffer_id);
910 fm->out_port = ntohs(ofm->out_port);
911 fm->flags = ntohs(ofm->flags);
912 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
913 /* Nicira extended flow_mod. */
914 const struct nx_flow_mod *nfm;
917 /* Dissect the message. */
918 nfm = ofpbuf_pull(&b, sizeof *nfm);
919 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
924 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
929 /* Translate the message. */
930 fm->cookie = nfm->cookie;
931 command = ntohs(nfm->command);
932 fm->idle_timeout = ntohs(nfm->idle_timeout);
933 fm->hard_timeout = ntohs(nfm->hard_timeout);
934 fm->buffer_id = ntohl(nfm->buffer_id);
935 fm->out_port = ntohs(nfm->out_port);
936 fm->flags = ntohs(nfm->flags);
941 if (flow_mod_table_id) {
942 fm->command = command & 0xff;
943 fm->table_id = command >> 8;
945 fm->command = command;
952 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
953 * 'flow_format' and returns the message.
955 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
956 * enabled, false otherwise. */
958 ofputil_encode_flow_mod(const struct flow_mod *fm,
959 enum nx_flow_format flow_format,
960 bool flow_mod_table_id)
962 size_t actions_len = fm->n_actions * sizeof *fm->actions;
966 command = (flow_mod_table_id
967 ? (fm->command & 0xff) | (fm->table_id << 8)
970 if (flow_format == NXFF_OPENFLOW10) {
971 struct ofp_flow_mod *ofm;
973 msg = ofpbuf_new(sizeof *ofm + actions_len);
974 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
975 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
976 ofm->cookie = fm->cookie;
977 ofm->command = htons(fm->command);
978 ofm->idle_timeout = htons(fm->idle_timeout);
979 ofm->hard_timeout = htons(fm->hard_timeout);
980 ofm->priority = htons(fm->cr.priority);
981 ofm->buffer_id = htonl(fm->buffer_id);
982 ofm->out_port = htons(fm->out_port);
983 ofm->flags = htons(fm->flags);
984 } else if (flow_format == NXFF_NXM) {
985 struct nx_flow_mod *nfm;
988 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
989 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
990 match_len = nx_put_match(msg, &fm->cr);
993 nfm->cookie = fm->cookie;
994 nfm->command = htons(command);
995 nfm->idle_timeout = htons(fm->idle_timeout);
996 nfm->hard_timeout = htons(fm->hard_timeout);
997 nfm->priority = htons(fm->cr.priority);
998 nfm->buffer_id = htonl(fm->buffer_id);
999 nfm->out_port = htons(fm->out_port);
1000 nfm->flags = htons(fm->flags);
1001 nfm->match_len = htons(match_len);
1006 ofpbuf_put(msg, fm->actions, actions_len);
1007 update_openflow_length(msg);
1012 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1013 const struct ofp_header *oh,
1016 const struct ofp_flow_stats_request *ofsr =
1017 (const struct ofp_flow_stats_request *) oh;
1019 fsr->aggregate = aggregate;
1020 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1021 fsr->out_port = ntohs(ofsr->out_port);
1022 fsr->table_id = ofsr->table_id;
1028 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1029 const struct ofp_header *oh,
1032 const struct nx_flow_stats_request *nfsr;
1036 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1038 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1039 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1044 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1047 fsr->aggregate = aggregate;
1048 fsr->out_port = ntohs(nfsr->out_port);
1049 fsr->table_id = nfsr->table_id;
1054 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1055 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1056 * successful, otherwise an OpenFlow error code. */
1058 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1059 const struct ofp_header *oh)
1061 const struct ofputil_msg_type *type;
1065 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1067 ofputil_decode_msg_type(oh, &type);
1068 code = ofputil_msg_type_code(type);
1070 case OFPUTIL_OFPST_FLOW_REQUEST:
1071 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1073 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1074 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1076 case OFPUTIL_NXST_FLOW_REQUEST:
1077 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1079 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1080 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1083 /* Hey, the caller lied. */
1088 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1089 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1090 * 'flow_format', and returns the message. */
1092 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1093 enum nx_flow_format flow_format)
1097 if (flow_format == NXFF_OPENFLOW10) {
1098 struct ofp_flow_stats_request *ofsr;
1101 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1102 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1103 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1104 ofsr->table_id = fsr->table_id;
1105 ofsr->out_port = htons(fsr->out_port);
1106 } else if (flow_format == NXFF_NXM) {
1107 struct nx_flow_stats_request *nfsr;
1111 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1112 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1113 match_len = nx_put_match(msg, &fsr->match);
1116 nfsr->out_port = htons(fsr->out_port);
1117 nfsr->match_len = htons(match_len);
1118 nfsr->table_id = fsr->table_id;
1126 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1127 * ofputil_flow_stats in 'fs'.
1129 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1130 * OpenFlow message. Calling this function multiple times for a single 'msg'
1131 * iterates through the replies. The caller must initially leave 'msg''s layer
1132 * pointers null and not modify them between calls.
1134 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1135 * otherwise a positive errno value. */
1137 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1140 const struct ofputil_msg_type *type;
1143 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1144 code = ofputil_msg_type_code(type);
1146 msg->l2 = msg->data;
1147 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1148 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1149 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1150 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1158 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1159 const struct ofp_flow_stats *ofs;
1162 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1164 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1165 "bytes at end", msg->size);
1169 length = ntohs(ofs->length);
1170 if (length < sizeof *ofs) {
1171 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1172 "length %zu", length);
1176 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1177 &fs->actions, &fs->n_actions)) {
1181 fs->cookie = get_32aligned_be64(&ofs->cookie);
1182 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1184 fs->table_id = ofs->table_id;
1185 fs->duration_sec = ntohl(ofs->duration_sec);
1186 fs->duration_nsec = ntohl(ofs->duration_nsec);
1187 fs->idle_timeout = ntohs(ofs->idle_timeout);
1188 fs->hard_timeout = ntohs(ofs->hard_timeout);
1189 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1190 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1191 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1192 const struct nx_flow_stats *nfs;
1193 size_t match_len, length;
1195 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1197 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1198 "bytes at end", msg->size);
1202 length = ntohs(nfs->length);
1203 match_len = ntohs(nfs->match_len);
1204 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1205 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1206 "claims invalid length %zu", match_len, length);
1209 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
1213 if (ofputil_pull_actions(msg,
1214 length - sizeof *nfs - ROUND_UP(match_len, 8),
1215 &fs->actions, &fs->n_actions)) {
1219 fs->cookie = nfs->cookie;
1220 fs->table_id = nfs->table_id;
1221 fs->duration_sec = ntohl(nfs->duration_sec);
1222 fs->duration_nsec = ntohl(nfs->duration_nsec);
1223 fs->idle_timeout = ntohs(nfs->idle_timeout);
1224 fs->hard_timeout = ntohs(nfs->hard_timeout);
1225 fs->packet_count = ntohll(nfs->packet_count);
1226 fs->byte_count = ntohll(nfs->byte_count);
1234 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1235 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1236 * have been initialized with ofputil_start_stats_reply(). */
1238 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1239 struct list *replies)
1241 size_t act_len = fs->n_actions * sizeof *fs->actions;
1242 const struct ofp_stats_msg *osm;
1244 osm = ofpbuf_from_list(list_back(replies))->data;
1245 if (osm->type == htons(OFPST_FLOW)) {
1246 size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1247 struct ofp_flow_stats *ofs;
1249 ofs = ofputil_append_stats_reply(len, replies);
1250 ofs->length = htons(len);
1251 ofs->table_id = fs->table_id;
1253 ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1254 ofs->duration_sec = htonl(fs->duration_sec);
1255 ofs->duration_nsec = htonl(fs->duration_nsec);
1256 ofs->priority = htons(fs->rule.priority);
1257 ofs->idle_timeout = htons(fs->idle_timeout);
1258 ofs->hard_timeout = htons(fs->hard_timeout);
1259 memset(ofs->pad2, 0, sizeof ofs->pad2);
1260 put_32aligned_be64(&ofs->cookie, fs->cookie);
1261 put_32aligned_be64(&ofs->packet_count, htonll(fs->packet_count));
1262 put_32aligned_be64(&ofs->byte_count, htonll(fs->byte_count));
1263 memcpy(ofs->actions, fs->actions, act_len);
1264 } else if (osm->type == htons(OFPST_VENDOR)) {
1265 struct nx_flow_stats *nfs;
1269 msg = ofputil_reserve_stats_reply(
1270 sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1271 start_len = msg->size;
1273 nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1274 nfs->table_id = fs->table_id;
1276 nfs->duration_sec = htonl(fs->duration_sec);
1277 nfs->duration_nsec = htonl(fs->duration_nsec);
1278 nfs->priority = htons(fs->rule.priority);
1279 nfs->idle_timeout = htons(fs->idle_timeout);
1280 nfs->hard_timeout = htons(fs->hard_timeout);
1281 nfs->match_len = htons(nx_put_match(msg, &fs->rule));
1282 memset(nfs->pad2, 0, sizeof nfs->pad2);
1283 nfs->cookie = fs->cookie;
1284 nfs->packet_count = htonll(fs->packet_count);
1285 nfs->byte_count = htonll(fs->byte_count);
1286 ofpbuf_put(msg, fs->actions, act_len);
1287 nfs->length = htons(msg->size - start_len);
1293 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1294 * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */
1296 ofputil_encode_aggregate_stats_reply(
1297 const struct ofputil_aggregate_stats *stats,
1298 const struct ofp_stats_msg *request)
1302 if (request->type == htons(OFPST_AGGREGATE)) {
1303 struct ofp_aggregate_stats_reply *asr;
1305 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1306 put_32aligned_be64(&asr->packet_count, htonll(stats->packet_count));
1307 put_32aligned_be64(&asr->byte_count, htonll(stats->byte_count));
1308 asr->flow_count = htonl(stats->flow_count);
1309 } else if (request->type == htons(OFPST_VENDOR)) {
1310 struct nx_aggregate_stats_reply *nasr;
1312 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1313 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1314 nasr->packet_count = htonll(stats->packet_count);
1315 nasr->byte_count = htonll(stats->byte_count);
1316 nasr->flow_count = htonl(stats->flow_count);
1324 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1325 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1326 * an OpenFlow error code. */
1328 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1329 const struct ofp_header *oh)
1331 const struct ofputil_msg_type *type;
1332 enum ofputil_msg_code code;
1334 ofputil_decode_msg_type(oh, &type);
1335 code = ofputil_msg_type_code(type);
1336 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1337 const struct ofp_flow_removed *ofr;
1339 ofr = (const struct ofp_flow_removed *) oh;
1340 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1342 fr->cookie = ofr->cookie;
1343 fr->reason = ofr->reason;
1344 fr->duration_sec = ntohl(ofr->duration_sec);
1345 fr->duration_nsec = ntohl(ofr->duration_nsec);
1346 fr->idle_timeout = ntohs(ofr->idle_timeout);
1347 fr->packet_count = ntohll(ofr->packet_count);
1348 fr->byte_count = ntohll(ofr->byte_count);
1349 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1350 struct nx_flow_removed *nfr;
1354 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1356 nfr = ofpbuf_pull(&b, sizeof *nfr);
1357 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1363 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1366 fr->cookie = nfr->cookie;
1367 fr->reason = nfr->reason;
1368 fr->duration_sec = ntohl(nfr->duration_sec);
1369 fr->duration_nsec = ntohl(nfr->duration_nsec);
1370 fr->idle_timeout = ntohs(nfr->idle_timeout);
1371 fr->packet_count = ntohll(nfr->packet_count);
1372 fr->byte_count = ntohll(nfr->byte_count);
1380 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1381 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1384 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1385 enum nx_flow_format flow_format)
1389 if (flow_format == NXFF_OPENFLOW10) {
1390 struct ofp_flow_removed *ofr;
1392 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1394 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1395 ofr->cookie = fr->cookie;
1396 ofr->priority = htons(fr->rule.priority);
1397 ofr->reason = fr->reason;
1398 ofr->duration_sec = htonl(fr->duration_sec);
1399 ofr->duration_nsec = htonl(fr->duration_nsec);
1400 ofr->idle_timeout = htons(fr->idle_timeout);
1401 ofr->packet_count = htonll(fr->packet_count);
1402 ofr->byte_count = htonll(fr->byte_count);
1403 } else if (flow_format == NXFF_NXM) {
1404 struct nx_flow_removed *nfr;
1407 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1408 match_len = nx_put_match(msg, &fr->rule);
1411 nfr->cookie = fr->cookie;
1412 nfr->priority = htons(fr->rule.priority);
1413 nfr->reason = fr->reason;
1414 nfr->duration_sec = htonl(fr->duration_sec);
1415 nfr->duration_nsec = htonl(fr->duration_nsec);
1416 nfr->idle_timeout = htons(fr->idle_timeout);
1417 nfr->match_len = htons(match_len);
1418 nfr->packet_count = htonll(fr->packet_count);
1419 nfr->byte_count = htonll(fr->byte_count);
1427 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1428 * and returns the message.
1430 * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
1433 * If 'rw_packet' is nonnull, then it must contain the same data as
1434 * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
1435 * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
1436 * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
1437 * enough headroom to insert a "struct ofp_packet_in", this is more efficient
1438 * than ofputil_encode_packet_in() because it does not copy the packet
1441 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1442 struct ofpbuf *rw_packet)
1444 int total_len = pin->packet->size;
1445 struct ofp_packet_in *opi;
1448 if (pin->send_len < rw_packet->size) {
1449 rw_packet->size = pin->send_len;
1452 rw_packet = ofpbuf_clone_data_with_headroom(
1453 pin->packet->data, MIN(pin->send_len, pin->packet->size),
1454 offsetof(struct ofp_packet_in, data));
1457 /* Add OFPT_PACKET_IN. */
1458 opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data));
1459 opi->header.version = OFP_VERSION;
1460 opi->header.type = OFPT_PACKET_IN;
1461 opi->total_len = htons(total_len);
1462 opi->in_port = htons(pin->in_port);
1463 opi->reason = pin->reason;
1464 opi->buffer_id = htonl(pin->buffer_id);
1465 update_openflow_length(rw_packet);
1470 /* Returns a string representing the message type of 'type'. The string is the
1471 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1472 * messages, the constant is followed by "request" or "reply",
1473 * e.g. "OFPST_AGGREGATE reply". */
1475 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1480 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1481 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1482 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1485 * The caller is responsible for freeing '*bufferp' when it is no longer
1488 * The OpenFlow header length is initially set to 'openflow_len'; if the
1489 * message is later extended, the length should be updated with
1490 * update_openflow_length() before sending.
1492 * Returns the header. */
1494 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1496 *bufferp = ofpbuf_new(openflow_len);
1497 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1500 /* Similar to make_openflow() but creates a Nicira vendor extension message
1501 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1503 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1505 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1508 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1509 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1510 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1513 * The caller is responsible for freeing '*bufferp' when it is no longer
1516 * The OpenFlow header length is initially set to 'openflow_len'; if the
1517 * message is later extended, the length should be updated with
1518 * update_openflow_length() before sending.
1520 * Returns the header. */
1522 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1523 struct ofpbuf **bufferp)
1525 *bufferp = ofpbuf_new(openflow_len);
1526 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1529 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1530 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1532 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1533 struct ofpbuf **bufferp)
1535 *bufferp = ofpbuf_new(openflow_len);
1536 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1539 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1540 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1541 * beyond the header, if any, are zeroed.
1543 * The OpenFlow header length is initially set to 'openflow_len'; if the
1544 * message is later extended, the length should be updated with
1545 * update_openflow_length() before sending.
1547 * Returns the header. */
1549 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1551 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1554 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1555 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1556 * the header, if any, are zeroed.
1558 * The OpenFlow header length is initially set to 'openflow_len'; if the
1559 * message is later extended, the length should be updated with
1560 * update_openflow_length() before sending.
1562 * Returns the header. */
1564 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1565 struct ofpbuf *buffer)
1567 struct ofp_header *oh;
1569 assert(openflow_len >= sizeof *oh);
1570 assert(openflow_len <= UINT16_MAX);
1572 oh = ofpbuf_put_uninit(buffer, openflow_len);
1573 oh->version = OFP_VERSION;
1575 oh->length = htons(openflow_len);
1577 memset(oh + 1, 0, openflow_len - sizeof *oh);
1581 /* Similar to put_openflow() but append a Nicira vendor extension message with
1582 * the specific 'subtype'. 'subtype' should be in host byte order. */
1584 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1586 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1589 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1590 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1592 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1593 struct ofpbuf *buffer)
1595 struct nicira_header *nxh;
1597 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1598 nxh->vendor = htonl(NX_VENDOR_ID);
1599 nxh->subtype = htonl(subtype);
1603 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1604 * 'buffer->size'. */
1606 update_openflow_length(struct ofpbuf *buffer)
1608 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1609 oh->length = htons(buffer->size);
1613 put_stats__(ovs_be32 xid, uint8_t ofp_type,
1614 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
1617 if (ofpst_type == htons(OFPST_VENDOR)) {
1618 struct nicira_stats_msg *nsm;
1620 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
1621 nsm->vsm.osm.type = ofpst_type;
1622 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
1623 nsm->subtype = nxst_subtype;
1625 struct ofp_stats_msg *osm;
1627 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
1628 osm->type = ofpst_type;
1632 /* Creates a statistics request message with total length 'openflow_len'
1633 * (including all headers) and the given 'ofpst_type', and stores the buffer
1634 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
1635 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
1636 * subtype (otherwise 'nxst_subtype' is ignored).
1638 * Initializes bytes following the headers to all-bits-zero.
1640 * Returns the first byte of the new message. */
1642 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
1643 uint32_t nxst_subtype, struct ofpbuf **bufferp)
1647 msg = *bufferp = ofpbuf_new(openflow_len);
1648 put_stats__(alloc_xid(), OFPT_STATS_REQUEST,
1649 htons(ofpst_type), htonl(nxst_subtype), msg);
1650 ofpbuf_padto(msg, openflow_len);
1656 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
1658 assert(request->header.type == OFPT_STATS_REQUEST ||
1659 request->header.type == OFPT_STATS_REPLY);
1660 put_stats__(request->header.xid, OFPT_STATS_REPLY, request->type,
1661 (request->type != htons(OFPST_VENDOR)
1663 : ((const struct nicira_stats_msg *) request)->subtype),
1667 /* Creates a statistics reply message with total length 'openflow_len'
1668 * (including all headers) and the same type (either a standard OpenFlow
1669 * statistics type or a Nicira extension type and subtype) as 'request', and
1670 * stores the buffer containing the new message in '*bufferp'.
1672 * Initializes bytes following the headers to all-bits-zero.
1674 * Returns the first byte of the new message. */
1676 ofputil_make_stats_reply(size_t openflow_len,
1677 const struct ofp_stats_msg *request,
1678 struct ofpbuf **bufferp)
1682 msg = *bufferp = ofpbuf_new(openflow_len);
1683 put_stats_reply__(request, msg);
1684 ofpbuf_padto(msg, openflow_len);
1689 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
1690 * replies to 'request', which should be an OpenFlow or Nicira extension
1691 * statistics request. Initially 'replies' will have a single reply message
1692 * that has only a header. The functions ofputil_reserve_stats_reply() and
1693 * ofputil_append_stats_reply() may be used to add to the reply. */
1695 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
1696 struct list *replies)
1700 msg = ofpbuf_new(1024);
1701 put_stats_reply__(request, msg);
1704 list_push_back(replies, &msg->list_node);
1707 /* Prepares to append up to 'len' bytes to the series of statistics replies in
1708 * 'replies', which should have been initialized with
1709 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
1710 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
1711 * do so with e.g. ofpbuf_put_uninit().) */
1713 ofputil_reserve_stats_reply(size_t len, struct list *replies)
1715 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1716 struct ofp_stats_msg *osm = msg->data;
1718 if (msg->size + len <= UINT16_MAX) {
1719 ofpbuf_prealloc_tailroom(msg, len);
1721 osm->flags |= htons(OFPSF_REPLY_MORE);
1723 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
1724 put_stats_reply__(osm, msg);
1725 list_push_back(replies, &msg->list_node);
1730 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
1731 * returns the first byte. */
1733 ofputil_append_stats_reply(size_t len, struct list *replies)
1735 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
1738 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
1740 ofputil_stats_body(const struct ofp_header *oh)
1742 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1743 return (const struct ofp_stats_msg *) oh + 1;
1746 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
1748 ofputil_stats_body_len(const struct ofp_header *oh)
1750 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1751 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
1754 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
1756 ofputil_nxstats_body(const struct ofp_header *oh)
1758 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1759 return ((const struct nicira_stats_msg *) oh) + 1;
1762 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
1764 ofputil_nxstats_body_len(const struct ofp_header *oh)
1766 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1767 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1771 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1774 struct ofp_flow_mod *ofm;
1775 size_t size = sizeof *ofm + actions_len;
1776 struct ofpbuf *out = ofpbuf_new(size);
1777 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1778 ofm->header.version = OFP_VERSION;
1779 ofm->header.type = OFPT_FLOW_MOD;
1780 ofm->header.length = htons(size);
1782 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1783 ofputil_cls_rule_to_match(rule, &ofm->match);
1784 ofm->command = htons(command);
1789 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1790 uint16_t idle_timeout, size_t actions_len)
1792 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1793 struct ofp_flow_mod *ofm = out->data;
1794 ofm->idle_timeout = htons(idle_timeout);
1795 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1796 ofm->buffer_id = htonl(buffer_id);
1801 make_del_flow(const struct cls_rule *rule)
1803 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1804 struct ofp_flow_mod *ofm = out->data;
1805 ofm->out_port = htons(OFPP_NONE);
1810 make_add_simple_flow(const struct cls_rule *rule,
1811 uint32_t buffer_id, uint16_t out_port,
1812 uint16_t idle_timeout)
1814 if (out_port != OFPP_NONE) {
1815 struct ofp_action_output *oao;
1816 struct ofpbuf *buffer;
1818 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1819 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1820 oao->type = htons(OFPAT_OUTPUT);
1821 oao->len = htons(sizeof *oao);
1822 oao->port = htons(out_port);
1825 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1830 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1831 const struct ofpbuf *payload, int max_send_len)
1833 struct ofp_packet_in *opi;
1837 send_len = MIN(max_send_len, payload->size);
1838 buf = ofpbuf_new(sizeof *opi + send_len);
1839 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1840 OFPT_PACKET_IN, 0, buf);
1841 opi->buffer_id = htonl(buffer_id);
1842 opi->total_len = htons(payload->size);
1843 opi->in_port = htons(in_port);
1844 opi->reason = reason;
1845 ofpbuf_put(buf, payload->data, send_len);
1846 update_openflow_length(buf);
1852 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1854 const struct ofp_action_header *actions, size_t n_actions)
1856 size_t actions_len = n_actions * sizeof *actions;
1857 struct ofp_packet_out *opo;
1858 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1859 struct ofpbuf *out = ofpbuf_new(size);
1861 opo = ofpbuf_put_uninit(out, sizeof *opo);
1862 opo->header.version = OFP_VERSION;
1863 opo->header.type = OFPT_PACKET_OUT;
1864 opo->header.length = htons(size);
1865 opo->header.xid = htonl(0);
1866 opo->buffer_id = htonl(buffer_id);
1867 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1868 opo->actions_len = htons(actions_len);
1869 ofpbuf_put(out, actions, actions_len);
1871 ofpbuf_put(out, packet->data, packet->size);
1877 make_unbuffered_packet_out(const struct ofpbuf *packet,
1878 uint16_t in_port, uint16_t out_port)
1880 struct ofp_action_output action;
1881 action.type = htons(OFPAT_OUTPUT);
1882 action.len = htons(sizeof action);
1883 action.port = htons(out_port);
1884 return make_packet_out(packet, UINT32_MAX, in_port,
1885 (struct ofp_action_header *) &action, 1);
1889 make_buffered_packet_out(uint32_t buffer_id,
1890 uint16_t in_port, uint16_t out_port)
1892 if (out_port != OFPP_NONE) {
1893 struct ofp_action_output action;
1894 action.type = htons(OFPAT_OUTPUT);
1895 action.len = htons(sizeof action);
1896 action.port = htons(out_port);
1897 return make_packet_out(NULL, buffer_id, in_port,
1898 (struct ofp_action_header *) &action, 1);
1900 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1904 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1906 make_echo_request(void)
1908 struct ofp_header *rq;
1909 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1910 rq = ofpbuf_put_uninit(out, sizeof *rq);
1911 rq->version = OFP_VERSION;
1912 rq->type = OFPT_ECHO_REQUEST;
1913 rq->length = htons(sizeof *rq);
1918 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1919 * OFPT_ECHO_REQUEST message in 'rq'. */
1921 make_echo_reply(const struct ofp_header *rq)
1923 size_t size = ntohs(rq->length);
1924 struct ofpbuf *out = ofpbuf_new(size);
1925 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1926 reply->type = OFPT_ECHO_REPLY;
1931 check_action_exact_len(const union ofp_action *a, unsigned int len,
1932 unsigned int required_len)
1934 if (len != required_len) {
1935 VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length "
1936 "%"PRIu16" (must be %u)\n",
1937 ntohs(a->type), ntohs(a->header.len), required_len);
1938 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1944 check_nx_action_exact_len(const struct nx_action_header *a,
1945 unsigned int len, unsigned int required_len)
1947 if (len != required_len) {
1948 VLOG_WARN_RL(&bad_ofmsg_rl,
1949 "Nicira action %"PRIu16" has invalid length %"PRIu16" "
1951 ntohs(a->subtype), ntohs(a->len), required_len);
1952 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1957 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1958 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1959 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1961 check_output_port(uint16_t port, int max_ports)
1969 case OFPP_CONTROLLER:
1974 if (port < max_ports) {
1977 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1978 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1982 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1983 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
1984 * otherwise an ofp_mkerr() return code. */
1986 check_enqueue_action(const union ofp_action *a, unsigned int len,
1989 const struct ofp_action_enqueue *oae;
1993 error = check_action_exact_len(a, len, 16);
1998 oae = (const struct ofp_action_enqueue *) a;
1999 port = ntohs(oae->port);
2000 if (port < max_ports || port == OFPP_IN_PORT) {
2003 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
2004 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
2008 check_nicira_action(const union ofp_action *a, unsigned int len,
2009 const struct flow *flow)
2011 const struct nx_action_header *nah;
2016 VLOG_WARN_RL(&bad_ofmsg_rl,
2017 "Nicira vendor action only %u bytes", len);
2018 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2020 nah = (const struct nx_action_header *) a;
2022 subtype = ntohs(nah->subtype);
2023 if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
2024 /* This is necessary because enum nx_action_subtype may be an
2025 * 8-bit type, so the cast below throws away the top 8 bits. */
2026 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
2029 switch ((enum nx_action_subtype) subtype) {
2030 case NXAST_RESUBMIT:
2031 case NXAST_SET_TUNNEL:
2032 case NXAST_SET_QUEUE:
2033 case NXAST_POP_QUEUE:
2034 return check_nx_action_exact_len(nah, len, 16);
2036 case NXAST_REG_MOVE:
2037 error = check_nx_action_exact_len(nah, len,
2038 sizeof(struct nx_action_reg_move));
2042 return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
2044 case NXAST_REG_LOAD:
2045 error = check_nx_action_exact_len(nah, len,
2046 sizeof(struct nx_action_reg_load));
2050 return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
2055 case NXAST_SET_TUNNEL64:
2056 return check_nx_action_exact_len(
2057 nah, len, sizeof(struct nx_action_set_tunnel64));
2059 case NXAST_MULTIPATH:
2060 error = check_nx_action_exact_len(
2061 nah, len, sizeof(struct nx_action_multipath));
2065 return multipath_check((const struct nx_action_multipath *) a);
2067 case NXAST_AUTOPATH:
2068 error = check_nx_action_exact_len(
2069 nah, len, sizeof(struct nx_action_autopath));
2073 return autopath_check((const struct nx_action_autopath *) a);
2075 case NXAST_SNAT__OBSOLETE:
2076 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
2078 VLOG_WARN_RL(&bad_ofmsg_rl,
2079 "unknown Nicira vendor action subtype %d", subtype);
2080 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
2085 check_action(const union ofp_action *a, unsigned int len,
2086 const struct flow *flow, int max_ports)
2088 enum ofp_action_type type = ntohs(a->type);
2093 error = check_action_exact_len(a, len, 8);
2097 return check_output_port(ntohs(a->output.port), max_ports);
2099 case OFPAT_SET_VLAN_VID:
2100 error = check_action_exact_len(a, len, 8);
2104 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
2105 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2109 case OFPAT_SET_VLAN_PCP:
2110 error = check_action_exact_len(a, len, 8);
2114 if (a->vlan_pcp.vlan_pcp & ~7) {
2115 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2119 case OFPAT_STRIP_VLAN:
2120 case OFPAT_SET_NW_SRC:
2121 case OFPAT_SET_NW_DST:
2122 case OFPAT_SET_NW_TOS:
2123 case OFPAT_SET_TP_SRC:
2124 case OFPAT_SET_TP_DST:
2125 return check_action_exact_len(a, len, 8);
2127 case OFPAT_SET_DL_SRC:
2128 case OFPAT_SET_DL_DST:
2129 return check_action_exact_len(a, len, 16);
2132 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
2133 ? check_nicira_action(a, len, flow)
2134 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
2137 return check_enqueue_action(a, len, max_ports);
2140 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
2141 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
2146 validate_actions(const union ofp_action *actions, size_t n_actions,
2147 const struct flow *flow, int max_ports)
2151 for (i = 0; i < n_actions; ) {
2152 const union ofp_action *a = &actions[i];
2153 unsigned int len = ntohs(a->header.len);
2154 unsigned int n_slots = len / OFP_ACTION_ALIGN;
2155 unsigned int slots_left = &actions[n_actions] - a;
2158 if (n_slots > slots_left) {
2159 VLOG_WARN_RL(&bad_ofmsg_rl,
2160 "action requires %u slots but only %u remain",
2161 n_slots, slots_left);
2162 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2164 VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0");
2165 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2166 } else if (len % OFP_ACTION_ALIGN) {
2167 VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
2168 "of %d", len, OFP_ACTION_ALIGN);
2169 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2172 error = check_action(a, len, flow, max_ports);
2181 /* Returns true if 'action' outputs to 'port', false otherwise. */
2183 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2185 switch (ntohs(action->type)) {
2187 return action->output.port == port;
2189 return ((const struct ofp_action_enqueue *) action)->port == port;
2195 /* The set of actions must either come from a trusted source or have been
2196 * previously validated with validate_actions(). */
2197 const union ofp_action *
2198 actions_first(struct actions_iterator *iter,
2199 const union ofp_action *oa, size_t n_actions)
2202 iter->end = oa + n_actions;
2203 return actions_next(iter);
2206 const union ofp_action *
2207 actions_next(struct actions_iterator *iter)
2209 if (iter->pos != iter->end) {
2210 const union ofp_action *a = iter->pos;
2211 unsigned int len = ntohs(a->header.len);
2212 iter->pos += len / OFP_ACTION_ALIGN;
2219 /* "Normalizes" the wildcards in 'rule'. That means:
2221 * 1. If the type of level N is known, then only the valid fields for that
2222 * level may be specified. For example, ARP does not have a TOS field,
2223 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2224 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2225 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2228 * 2. If the type of level N is not known (or not understood by Open
2229 * vSwitch), then no fields at all for that level may be specified. For
2230 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2231 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2234 * 'flow_format' specifies the format of the flow as received or as intended to
2235 * be sent. This is important for IPv6 and ARP, for which NXM supports more
2236 * detailed matching. */
2238 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2241 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
2242 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
2243 MAY_NW_PROTO = 1 << 2, /* nw_proto */
2244 MAY_NW_TOS = 1 << 3, /* nw_tos */
2245 MAY_ARP_SHA = 1 << 4, /* arp_sha */
2246 MAY_ARP_THA = 1 << 5, /* arp_tha */
2247 MAY_IPV6_ADDR = 1 << 6, /* ipv6_src, ipv6_dst */
2248 MAY_ND_TARGET = 1 << 7 /* nd_target */
2251 struct flow_wildcards wc;
2253 /* Figure out what fields may be matched. */
2254 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2255 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_NW_ADDR;
2256 if (rule->flow.nw_proto == IPPROTO_TCP ||
2257 rule->flow.nw_proto == IPPROTO_UDP ||
2258 rule->flow.nw_proto == IPPROTO_ICMP) {
2259 may_match |= MAY_TP_ADDR;
2261 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2262 && flow_format == NXFF_NXM) {
2263 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_IPV6_ADDR;
2264 if (rule->flow.nw_proto == IPPROTO_TCP ||
2265 rule->flow.nw_proto == IPPROTO_UDP) {
2266 may_match |= MAY_TP_ADDR;
2267 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2268 may_match |= MAY_TP_ADDR;
2269 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2270 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2271 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2272 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2275 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2276 may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2277 if (flow_format == NXFF_NXM) {
2278 may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2284 /* Clear the fields that may not be matched. */
2286 if (!(may_match & MAY_NW_ADDR)) {
2287 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2289 if (!(may_match & MAY_TP_ADDR)) {
2290 wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2292 if (!(may_match & MAY_NW_PROTO)) {
2293 wc.wildcards |= FWW_NW_PROTO;
2295 if (!(may_match & MAY_NW_TOS)) {
2296 wc.wildcards |= FWW_NW_TOS;
2298 if (!(may_match & MAY_ARP_SHA)) {
2299 wc.wildcards |= FWW_ARP_SHA;
2301 if (!(may_match & MAY_ARP_THA)) {
2302 wc.wildcards |= FWW_ARP_THA;
2304 if (!(may_match & MAY_IPV6_ADDR)) {
2305 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2307 if (!(may_match & MAY_ND_TARGET)) {
2308 wc.wildcards |= FWW_ND_TARGET;
2311 /* Log any changes. */
2312 if (!flow_wildcards_equal(&wc, &rule->wc)) {
2313 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2314 char *pre = log ? cls_rule_to_string(rule) : NULL;
2317 cls_rule_zero_wildcarded_fields(rule);
2320 char *post = cls_rule_to_string(rule);
2321 VLOG_INFO("normalization changed ofp_match, details:");
2322 VLOG_INFO(" pre: %s", pre);
2323 VLOG_INFO("post: %s", post);
2331 vendor_code_to_id(uint8_t code)
2334 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2336 #undef OFPUTIL_VENDOR
2343 vendor_id_to_code(uint32_t id)
2346 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2348 #undef OFPUTIL_VENDOR
2354 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2355 * information taken from 'error', whose encoding must be as described in the
2356 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
2357 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2360 * Returns NULL if 'error' is not an OpenFlow error code. */
2362 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2364 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2374 if (!is_ofp_error(error)) {
2375 /* We format 'error' with strerror() here since it seems likely to be
2376 * a system errno value. */
2377 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2378 error, strerror(error));
2385 len = ntohs(oh->length);
2395 vendor = get_ofp_err_vendor(error);
2396 type = get_ofp_err_type(error);
2397 code = get_ofp_err_code(error);
2398 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2399 struct ofp_error_msg *oem;
2401 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2402 oem->type = htons(type);
2403 oem->code = htons(code);
2405 struct ofp_error_msg *oem;
2406 struct nx_vendor_error *nve;
2409 vendor_id = vendor_code_to_id(vendor);
2410 if (vendor_id == UINT32_MAX) {
2411 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2416 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2417 OFPT_ERROR, xid, &buf);
2418 oem->type = htons(NXET_VENDOR);
2419 oem->code = htons(NXVC_VENDOR_ERROR);
2421 nve = (struct nx_vendor_error *)oem->data;
2422 nve->vendor = htonl(vendor_id);
2423 nve->type = htons(type);
2424 nve->code = htons(code);
2429 ofpbuf_put(buf, data, len);
2435 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2436 * Open vSwitch internal error code in the format described in the large
2437 * comment in ofp-util.h.
2439 * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2440 * to the payload starting from 'oh' and on failure it is set to 0. */
2442 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2444 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2446 const struct ofp_error_msg *oem;
2447 uint16_t type, code;
2454 if (oh->type != OFPT_ERROR) {
2458 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2459 oem = ofpbuf_try_pull(&b, sizeof *oem);
2464 type = ntohs(oem->type);
2465 code = ntohs(oem->code);
2466 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2467 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2472 vendor = vendor_id_to_code(ntohl(nve->vendor));
2474 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2475 ntohl(nve->vendor));
2478 type = ntohs(nve->type);
2479 code = ntohs(nve->code);
2481 vendor = OFPUTIL_VENDOR_OPENFLOW;
2485 VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2486 "supported maximum value 1023", type);
2491 *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2493 return ofp_mkerr_vendor(vendor, type, code);
2497 ofputil_format_error(struct ds *s, int error)
2499 if (is_errno(error)) {
2500 ds_put_cstr(s, strerror(error));
2502 uint16_t type = get_ofp_err_type(error);
2503 uint16_t code = get_ofp_err_code(error);
2504 const char *type_s = ofp_error_type_to_string(type);
2505 const char *code_s = ofp_error_code_to_string(type, code);
2507 ds_put_format(s, "type ");
2509 ds_put_cstr(s, type_s);
2511 ds_put_format(s, "%"PRIu16, type);
2514 ds_put_cstr(s, ", code ");
2516 ds_put_cstr(s, code_s);
2518 ds_put_format(s, "%"PRIu16, code);
2524 ofputil_error_to_string(int error)
2526 struct ds s = DS_EMPTY_INITIALIZER;
2527 ofputil_format_error(&s, error);
2528 return ds_steal_cstr(&s);
2531 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2532 * successful, otherwise an OpenFlow error.
2534 * If successful, the first action is stored in '*actionsp' and the number of
2535 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2536 * are stored, respectively.
2538 * This function does not check that the actions are valid (the caller should
2539 * do so, with validate_actions()). The caller is also responsible for making
2540 * sure that 'b->data' is initially aligned appropriately for "union
2543 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2544 union ofp_action **actionsp, size_t *n_actionsp)
2546 if (actions_len % OFP_ACTION_ALIGN != 0) {
2547 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2548 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2552 *actionsp = ofpbuf_try_pull(b, actions_len);
2553 if (*actionsp == NULL) {
2554 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2555 "exceeds remaining message length (%zu)",
2556 actions_len, b->size);
2560 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2566 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2570 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
2571 const union ofp_action *b, size_t n_b)
2573 return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
2577 ofputil_actions_clone(const union ofp_action *actions, size_t n)
2579 return n ? xmemdup(actions, n * sizeof *actions) : NULL;