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_request *osr;
416 osr = (const struct ofp_stats_request *) oh;
418 memcpy(&vendor, osr->body, sizeof vendor);
419 if (vendor != htonl(NX_VENDOR_ID)) {
420 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
421 "unknown vendor %"PRIx32, ntohl(vendor));
422 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
425 if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) {
426 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
427 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
434 ofputil_decode_nxst_request(const struct ofp_header *oh,
435 const struct ofputil_msg_type **typep)
437 static const struct ofputil_msg_type nxst_requests[] = {
438 { OFPUTIL_NXST_FLOW_REQUEST,
439 NXST_FLOW, "NXST_FLOW request",
440 sizeof(struct nx_flow_stats_request), 8 },
442 { OFPUTIL_NXST_AGGREGATE_REQUEST,
443 NXST_AGGREGATE, "NXST_AGGREGATE request",
444 sizeof(struct nx_aggregate_stats_request), 8 },
447 static const struct ofputil_msg_category nxst_request_category = {
448 "Nicira extension statistics request",
449 nxst_requests, ARRAY_SIZE(nxst_requests),
450 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
453 const struct nicira_stats_msg *nsm;
456 error = check_nxstats_msg(oh);
461 nsm = (struct nicira_stats_msg *) oh;
462 return ofputil_lookup_openflow_message(&nxst_request_category,
464 ntohs(oh->length), typep);
468 ofputil_decode_nxst_reply(const struct ofp_header *oh,
469 const struct ofputil_msg_type **typep)
471 static const struct ofputil_msg_type nxst_replies[] = {
472 { OFPUTIL_NXST_FLOW_REPLY,
473 NXST_FLOW, "NXST_FLOW reply",
474 sizeof(struct nicira_stats_msg), 8 },
476 { OFPUTIL_NXST_AGGREGATE_REPLY,
477 NXST_AGGREGATE, "NXST_AGGREGATE reply",
478 sizeof(struct nx_aggregate_stats_reply), 0 },
481 static const struct ofputil_msg_category nxst_reply_category = {
482 "Nicira extension statistics reply",
483 nxst_replies, ARRAY_SIZE(nxst_replies),
484 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
487 const struct nicira_stats_msg *nsm;
490 error = check_nxstats_msg(oh);
495 nsm = (struct nicira_stats_msg *) oh;
496 return ofputil_lookup_openflow_message(&nxst_reply_category,
498 ntohs(oh->length), typep);
502 ofputil_decode_ofpst_request(const struct ofp_header *oh,
503 const struct ofputil_msg_type **typep)
505 enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
506 static const struct ofputil_msg_type ofpst_requests[] = {
507 { OFPUTIL_OFPST_DESC_REQUEST,
508 OFPST_DESC, "OFPST_DESC request",
511 { OFPUTIL_OFPST_FLOW_REQUEST,
512 OFPST_FLOW, "OFPST_FLOW request",
513 OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
515 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
516 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
517 OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
519 { OFPUTIL_OFPST_TABLE_REQUEST,
520 OFPST_TABLE, "OFPST_TABLE request",
523 { OFPUTIL_OFPST_PORT_REQUEST,
524 OFPST_PORT, "OFPST_PORT request",
525 OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
527 { OFPUTIL_OFPST_QUEUE_REQUEST,
528 OFPST_QUEUE, "OFPST_QUEUE request",
529 OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
532 OFPST_VENDOR, "OFPST_VENDOR request",
533 OSR_SIZE + sizeof(uint32_t), 1 },
536 static const struct ofputil_msg_category ofpst_request_category = {
537 "OpenFlow statistics",
538 ofpst_requests, ARRAY_SIZE(ofpst_requests),
539 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
542 const struct ofp_stats_request *osr;
545 osr = (const struct ofp_stats_request *) oh;
546 error = ofputil_lookup_openflow_message(&ofpst_request_category,
548 ntohs(oh->length), typep);
549 if (!error && osr->type == htons(OFPST_VENDOR)) {
550 error = ofputil_decode_nxst_request(oh, typep);
556 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
557 const struct ofputil_msg_type **typep)
559 enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
560 static const struct ofputil_msg_type ofpst_replies[] = {
561 { OFPUTIL_OFPST_DESC_REPLY,
562 OFPST_DESC, "OFPST_DESC reply",
563 OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
565 { OFPUTIL_OFPST_FLOW_REPLY,
566 OFPST_FLOW, "OFPST_FLOW reply",
569 { OFPUTIL_OFPST_AGGREGATE_REPLY,
570 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
571 OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
573 { OFPUTIL_OFPST_TABLE_REPLY,
574 OFPST_TABLE, "OFPST_TABLE reply",
575 OSR_SIZE, sizeof(struct ofp_table_stats) },
577 { OFPUTIL_OFPST_PORT_REPLY,
578 OFPST_PORT, "OFPST_PORT reply",
579 OSR_SIZE, sizeof(struct ofp_port_stats) },
581 { OFPUTIL_OFPST_QUEUE_REPLY,
582 OFPST_QUEUE, "OFPST_QUEUE reply",
583 OSR_SIZE, sizeof(struct ofp_queue_stats) },
586 OFPST_VENDOR, "OFPST_VENDOR reply",
587 OSR_SIZE + sizeof(uint32_t), 1 },
590 static const struct ofputil_msg_category ofpst_reply_category = {
591 "OpenFlow statistics",
592 ofpst_replies, ARRAY_SIZE(ofpst_replies),
593 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
596 const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh;
599 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
601 ntohs(oh->length), typep);
602 if (!error && osr->type == htons(OFPST_VENDOR)) {
603 error = ofputil_decode_nxst_reply(oh, typep);
608 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
609 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
610 * way, stores in '*typep' a type structure that can be inspected with the
611 * ofputil_msg_type_*() functions.
613 * oh->length must indicate the correct length of the message (and must be at
614 * least sizeof(struct ofp_header)).
616 * Success indicates that 'oh' is at least as long as the minimum-length
617 * message of its type. */
619 ofputil_decode_msg_type(const struct ofp_header *oh,
620 const struct ofputil_msg_type **typep)
622 static const struct ofputil_msg_type ofpt_messages[] = {
623 { OFPUTIL_OFPT_HELLO,
624 OFPT_HELLO, "OFPT_HELLO",
625 sizeof(struct ofp_hello), 1 },
627 { OFPUTIL_OFPT_ERROR,
628 OFPT_ERROR, "OFPT_ERROR",
629 sizeof(struct ofp_error_msg), 1 },
631 { OFPUTIL_OFPT_ECHO_REQUEST,
632 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
633 sizeof(struct ofp_header), 1 },
635 { OFPUTIL_OFPT_ECHO_REPLY,
636 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
637 sizeof(struct ofp_header), 1 },
639 { OFPUTIL_OFPT_FEATURES_REQUEST,
640 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
641 sizeof(struct ofp_header), 0 },
643 { OFPUTIL_OFPT_FEATURES_REPLY,
644 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
645 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
647 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
648 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
649 sizeof(struct ofp_header), 0 },
651 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
652 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
653 sizeof(struct ofp_switch_config), 0 },
655 { OFPUTIL_OFPT_SET_CONFIG,
656 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
657 sizeof(struct ofp_switch_config), 0 },
659 { OFPUTIL_OFPT_PACKET_IN,
660 OFPT_PACKET_IN, "OFPT_PACKET_IN",
661 offsetof(struct ofp_packet_in, data), 1 },
663 { OFPUTIL_OFPT_FLOW_REMOVED,
664 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
665 sizeof(struct ofp_flow_removed), 0 },
667 { OFPUTIL_OFPT_PORT_STATUS,
668 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
669 sizeof(struct ofp_port_status), 0 },
671 { OFPUTIL_OFPT_PACKET_OUT,
672 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
673 sizeof(struct ofp_packet_out), 1 },
675 { OFPUTIL_OFPT_FLOW_MOD,
676 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
677 sizeof(struct ofp_flow_mod), 1 },
679 { OFPUTIL_OFPT_PORT_MOD,
680 OFPT_PORT_MOD, "OFPT_PORT_MOD",
681 sizeof(struct ofp_port_mod), 0 },
684 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
685 sizeof(struct ofp_stats_request), 1 },
688 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
689 sizeof(struct ofp_stats_reply), 1 },
691 { OFPUTIL_OFPT_BARRIER_REQUEST,
692 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
693 sizeof(struct ofp_header), 0 },
695 { OFPUTIL_OFPT_BARRIER_REPLY,
696 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
697 sizeof(struct ofp_header), 0 },
700 OFPT_VENDOR, "OFPT_VENDOR",
701 sizeof(struct ofp_vendor_header), 1 },
704 static const struct ofputil_msg_category ofpt_category = {
706 ofpt_messages, ARRAY_SIZE(ofpt_messages),
707 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
712 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
713 ntohs(oh->length), typep);
717 error = ofputil_decode_vendor(oh, typep);
720 case OFPT_STATS_REQUEST:
721 error = ofputil_decode_ofpst_request(oh, typep);
724 case OFPT_STATS_REPLY:
725 error = ofputil_decode_ofpst_reply(oh, typep);
732 static const struct ofputil_msg_type ofputil_invalid_type = {
734 0, "OFPUTIL_INVALID",
738 *typep = &ofputil_invalid_type;
743 /* Returns an OFPUTIL_* message type code for 'type'. */
744 enum ofputil_msg_code
745 ofputil_msg_type_code(const struct ofputil_msg_type *type)
753 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
755 switch (flow_format) {
756 case NXFF_OPENFLOW10:
765 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
767 switch (flow_format) {
768 case NXFF_OPENFLOW10:
778 ofputil_flow_format_from_string(const char *s)
780 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
781 : !strcmp(s, "nxm") ? NXFF_NXM
786 regs_fully_wildcarded(const struct flow_wildcards *wc)
790 for (i = 0; i < FLOW_N_REGS; i++) {
791 if (wc->reg_masks[i] != 0) {
798 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
799 * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
800 * or fixing the Ethernet multicast bit. Otherwise, it's better to use
801 * NXFF_OPENFLOW10 for backward compatibility. */
803 ofputil_min_flow_format(const struct cls_rule *rule)
805 const struct flow_wildcards *wc = &rule->wc;
807 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
808 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
812 /* Only NXM supports matching ARP hardware addresses. */
813 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
817 /* Only NXM supports matching IPv6 traffic. */
818 if (!(wc->wildcards & FWW_DL_TYPE)
819 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
823 /* Only NXM supports matching registers. */
824 if (!regs_fully_wildcarded(wc)) {
828 /* Only NXM supports matching tun_id. */
829 if (wc->tun_id_mask != htonll(0)) {
833 /* Other formats can express this rule. */
834 return NXFF_OPENFLOW10;
837 /* Returns an OpenFlow message that can be used to set the flow format to
840 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
842 struct nxt_set_flow_format *sff;
845 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
846 sff->format = htonl(flow_format);
851 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
852 * extension on or off (according to 'flow_mod_table_id'). */
854 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
856 struct nxt_flow_mod_table_id *nfmti;
859 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
860 nfmti->set = flow_mod_table_id;
864 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
865 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
868 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
869 * enabled, false otherwise.
871 * Does not validate the flow_mod actions. */
873 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
874 bool flow_mod_table_id)
876 const struct ofputil_msg_type *type;
880 ofpbuf_use_const(&b, oh, ntohs(oh->length));
882 ofputil_decode_msg_type(oh, &type);
883 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
884 /* Standard OpenFlow flow_mod. */
885 const struct ofp_flow_mod *ofm;
889 /* Dissect the message. */
890 ofm = ofpbuf_pull(&b, sizeof *ofm);
891 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
896 /* Set priority based on original wildcards. Normally we'd allow
897 * ofputil_cls_rule_from_match() to do this for us, but
898 * ofputil_normalize_rule() can put wildcards where the original flow
899 * didn't have them. */
900 priority = ntohs(ofm->priority);
901 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
902 priority = UINT16_MAX;
905 /* Translate the rule. */
906 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
907 ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
909 /* Translate the message. */
910 fm->cookie = ofm->cookie;
911 command = ntohs(ofm->command);
912 fm->idle_timeout = ntohs(ofm->idle_timeout);
913 fm->hard_timeout = ntohs(ofm->hard_timeout);
914 fm->buffer_id = ntohl(ofm->buffer_id);
915 fm->out_port = ntohs(ofm->out_port);
916 fm->flags = ntohs(ofm->flags);
917 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
918 /* Nicira extended flow_mod. */
919 const struct nx_flow_mod *nfm;
922 /* Dissect the message. */
923 nfm = ofpbuf_pull(&b, sizeof *nfm);
924 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
929 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
934 /* Translate the message. */
935 fm->cookie = nfm->cookie;
936 command = ntohs(nfm->command);
937 fm->idle_timeout = ntohs(nfm->idle_timeout);
938 fm->hard_timeout = ntohs(nfm->hard_timeout);
939 fm->buffer_id = ntohl(nfm->buffer_id);
940 fm->out_port = ntohs(nfm->out_port);
941 fm->flags = ntohs(nfm->flags);
946 if (flow_mod_table_id) {
947 fm->command = command & 0xff;
948 fm->table_id = command >> 8;
950 fm->command = command;
957 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
958 * 'flow_format' and returns the message.
960 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
961 * enabled, false otherwise. */
963 ofputil_encode_flow_mod(const struct flow_mod *fm,
964 enum nx_flow_format flow_format,
965 bool flow_mod_table_id)
967 size_t actions_len = fm->n_actions * sizeof *fm->actions;
971 command = (flow_mod_table_id
972 ? (fm->command & 0xff) | (fm->table_id << 8)
975 if (flow_format == NXFF_OPENFLOW10) {
976 struct ofp_flow_mod *ofm;
978 msg = ofpbuf_new(sizeof *ofm + actions_len);
979 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
980 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
981 ofm->cookie = fm->cookie;
982 ofm->command = htons(fm->command);
983 ofm->idle_timeout = htons(fm->idle_timeout);
984 ofm->hard_timeout = htons(fm->hard_timeout);
985 ofm->priority = htons(fm->cr.priority);
986 ofm->buffer_id = htonl(fm->buffer_id);
987 ofm->out_port = htons(fm->out_port);
988 ofm->flags = htons(fm->flags);
989 } else if (flow_format == NXFF_NXM) {
990 struct nx_flow_mod *nfm;
993 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
994 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
995 match_len = nx_put_match(msg, &fm->cr);
998 nfm->cookie = fm->cookie;
999 nfm->command = htons(command);
1000 nfm->idle_timeout = htons(fm->idle_timeout);
1001 nfm->hard_timeout = htons(fm->hard_timeout);
1002 nfm->priority = htons(fm->cr.priority);
1003 nfm->buffer_id = htonl(fm->buffer_id);
1004 nfm->out_port = htons(fm->out_port);
1005 nfm->flags = htons(fm->flags);
1006 nfm->match_len = htons(match_len);
1011 ofpbuf_put(msg, fm->actions, actions_len);
1012 update_openflow_length(msg);
1017 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1018 const struct ofp_header *oh,
1021 const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
1023 fsr->aggregate = aggregate;
1024 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1025 fsr->out_port = ntohs(ofsr->out_port);
1026 fsr->table_id = ofsr->table_id;
1032 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1033 const struct ofp_header *oh,
1036 const struct nx_flow_stats_request *nfsr;
1040 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1042 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1043 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1048 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1051 fsr->aggregate = aggregate;
1052 fsr->out_port = ntohs(nfsr->out_port);
1053 fsr->table_id = nfsr->table_id;
1058 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1059 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1060 * successful, otherwise an OpenFlow error code. */
1062 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1063 const struct ofp_header *oh)
1065 const struct ofputil_msg_type *type;
1069 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1071 ofputil_decode_msg_type(oh, &type);
1072 code = ofputil_msg_type_code(type);
1074 case OFPUTIL_OFPST_FLOW_REQUEST:
1075 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1077 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1078 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1080 case OFPUTIL_NXST_FLOW_REQUEST:
1081 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1083 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1084 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1087 /* Hey, the caller lied. */
1092 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1093 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1094 * 'flow_format', and returns the message. */
1096 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1097 enum nx_flow_format flow_format)
1101 if (flow_format == NXFF_OPENFLOW10) {
1102 struct ofp_flow_stats_request *ofsr;
1105 BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
1106 == sizeof(struct ofp_aggregate_stats_request));
1108 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1109 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
1110 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1111 ofsr->table_id = fsr->table_id;
1112 ofsr->out_port = htons(fsr->out_port);
1113 } else if (flow_format == NXFF_NXM) {
1114 struct nx_flow_stats_request *nfsr;
1118 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1119 ofputil_make_nxstats_request(sizeof *nfsr, subtype, &msg);
1120 match_len = nx_put_match(msg, &fsr->match);
1123 nfsr->out_port = htons(fsr->out_port);
1124 nfsr->match_len = htons(match_len);
1125 nfsr->table_id = fsr->table_id;
1133 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1134 * ofputil_flow_stats in 'fs'.
1136 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1137 * OpenFlow message. Calling this function multiple times for a single 'msg'
1138 * iterates through the replies. The caller must initially leave 'msg''s layer
1139 * pointers null and not modify them between calls.
1141 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1142 * otherwise a positive errno value. */
1144 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1147 const struct ofputil_msg_type *type;
1150 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1151 code = ofputil_msg_type_code(type);
1153 msg->l2 = msg->data;
1154 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1155 ofpbuf_pull(msg, sizeof(struct ofp_stats_reply));
1156 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1157 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1165 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1166 const struct ofp_flow_stats *ofs;
1169 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1171 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1172 "bytes at end", msg->size);
1176 length = ntohs(ofs->length);
1177 if (length < sizeof *ofs) {
1178 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1179 "length %zu", length);
1183 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1184 &fs->actions, &fs->n_actions)) {
1188 fs->cookie = get_32aligned_be64(&ofs->cookie);
1189 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1191 fs->table_id = ofs->table_id;
1192 fs->duration_sec = ntohl(ofs->duration_sec);
1193 fs->duration_nsec = ntohl(ofs->duration_nsec);
1194 fs->idle_timeout = ntohs(ofs->idle_timeout);
1195 fs->hard_timeout = ntohs(ofs->hard_timeout);
1196 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1197 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1198 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1199 const struct nx_flow_stats *nfs;
1200 size_t match_len, length;
1202 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1204 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1205 "bytes at end", msg->size);
1209 length = ntohs(nfs->length);
1210 match_len = ntohs(nfs->match_len);
1211 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1212 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1213 "claims invalid length %zu", match_len, length);
1216 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
1220 if (ofputil_pull_actions(msg,
1221 length - sizeof *nfs - ROUND_UP(match_len, 8),
1222 &fs->actions, &fs->n_actions)) {
1226 fs->cookie = nfs->cookie;
1227 fs->table_id = nfs->table_id;
1228 fs->duration_sec = ntohl(nfs->duration_sec);
1229 fs->duration_nsec = ntohl(nfs->duration_nsec);
1230 fs->idle_timeout = ntohs(nfs->idle_timeout);
1231 fs->hard_timeout = ntohs(nfs->hard_timeout);
1232 fs->packet_count = ntohll(nfs->packet_count);
1233 fs->byte_count = ntohll(nfs->byte_count);
1241 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1242 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1243 * an OpenFlow error code. */
1245 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1246 const struct ofp_header *oh)
1248 const struct ofputil_msg_type *type;
1249 enum ofputil_msg_code code;
1251 ofputil_decode_msg_type(oh, &type);
1252 code = ofputil_msg_type_code(type);
1253 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1254 const struct ofp_flow_removed *ofr;
1256 ofr = (const struct ofp_flow_removed *) oh;
1257 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1259 fr->cookie = ofr->cookie;
1260 fr->reason = ofr->reason;
1261 fr->duration_sec = ntohl(ofr->duration_sec);
1262 fr->duration_nsec = ntohl(ofr->duration_nsec);
1263 fr->idle_timeout = ntohs(ofr->idle_timeout);
1264 fr->packet_count = ntohll(ofr->packet_count);
1265 fr->byte_count = ntohll(ofr->byte_count);
1266 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1267 struct nx_flow_removed *nfr;
1271 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1273 nfr = ofpbuf_pull(&b, sizeof *nfr);
1274 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1280 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1283 fr->cookie = nfr->cookie;
1284 fr->reason = nfr->reason;
1285 fr->duration_sec = ntohl(nfr->duration_sec);
1286 fr->duration_nsec = ntohl(nfr->duration_nsec);
1287 fr->idle_timeout = ntohs(nfr->idle_timeout);
1288 fr->packet_count = ntohll(nfr->packet_count);
1289 fr->byte_count = ntohll(nfr->byte_count);
1297 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1298 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1301 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1302 enum nx_flow_format flow_format)
1306 if (flow_format == NXFF_OPENFLOW10) {
1307 struct ofp_flow_removed *ofr;
1309 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1311 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1312 ofr->cookie = fr->cookie;
1313 ofr->priority = htons(fr->rule.priority);
1314 ofr->reason = fr->reason;
1315 ofr->duration_sec = htonl(fr->duration_sec);
1316 ofr->duration_nsec = htonl(fr->duration_nsec);
1317 ofr->idle_timeout = htons(fr->idle_timeout);
1318 ofr->packet_count = htonll(fr->packet_count);
1319 ofr->byte_count = htonll(fr->byte_count);
1320 } else if (flow_format == NXFF_NXM) {
1321 struct nx_flow_removed *nfr;
1324 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1325 match_len = nx_put_match(msg, &fr->rule);
1328 nfr->cookie = fr->cookie;
1329 nfr->priority = htons(fr->rule.priority);
1330 nfr->reason = fr->reason;
1331 nfr->duration_sec = htonl(fr->duration_sec);
1332 nfr->duration_nsec = htonl(fr->duration_nsec);
1333 nfr->idle_timeout = htons(fr->idle_timeout);
1334 nfr->match_len = htons(match_len);
1335 nfr->packet_count = htonll(fr->packet_count);
1336 nfr->byte_count = htonll(fr->byte_count);
1344 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1345 * and returns the message.
1347 * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
1350 * If 'rw_packet' is nonnull, then it must contain the same data as
1351 * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
1352 * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
1353 * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
1354 * enough headroom to insert a "struct ofp_packet_in", this is more efficient
1355 * than ofputil_encode_packet_in() because it does not copy the packet
1358 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1359 struct ofpbuf *rw_packet)
1361 int total_len = pin->packet->size;
1362 struct ofp_packet_in *opi;
1365 if (pin->send_len < rw_packet->size) {
1366 rw_packet->size = pin->send_len;
1369 rw_packet = ofpbuf_clone_data_with_headroom(
1370 pin->packet->data, MIN(pin->send_len, pin->packet->size),
1371 offsetof(struct ofp_packet_in, data));
1374 /* Add OFPT_PACKET_IN. */
1375 opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data));
1376 opi->header.version = OFP_VERSION;
1377 opi->header.type = OFPT_PACKET_IN;
1378 opi->total_len = htons(total_len);
1379 opi->in_port = htons(pin->in_port);
1380 opi->reason = pin->reason;
1381 opi->buffer_id = htonl(pin->buffer_id);
1382 update_openflow_length(rw_packet);
1387 /* Returns a string representing the message type of 'type'. The string is the
1388 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1389 * messages, the constant is followed by "request" or "reply",
1390 * e.g. "OFPST_AGGREGATE reply". */
1392 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1397 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1398 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1399 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1402 * The caller is responsible for freeing '*bufferp' when it is no longer
1405 * The OpenFlow header length is initially set to 'openflow_len'; if the
1406 * message is later extended, the length should be updated with
1407 * update_openflow_length() before sending.
1409 * Returns the header. */
1411 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1413 *bufferp = ofpbuf_new(openflow_len);
1414 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1417 /* Similar to make_openflow() but creates a Nicira vendor extension message
1418 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1420 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1422 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1425 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1426 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1427 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1430 * The caller is responsible for freeing '*bufferp' when it is no longer
1433 * The OpenFlow header length is initially set to 'openflow_len'; if the
1434 * message is later extended, the length should be updated with
1435 * update_openflow_length() before sending.
1437 * Returns the header. */
1439 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1440 struct ofpbuf **bufferp)
1442 *bufferp = ofpbuf_new(openflow_len);
1443 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1446 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1447 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1449 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1450 struct ofpbuf **bufferp)
1452 *bufferp = ofpbuf_new(openflow_len);
1453 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1456 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1457 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1458 * beyond the header, if any, are zeroed.
1460 * The OpenFlow header length is initially set to 'openflow_len'; if the
1461 * message is later extended, the length should be updated with
1462 * update_openflow_length() before sending.
1464 * Returns the header. */
1466 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1468 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1471 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1472 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1473 * the header, if any, are zeroed.
1475 * The OpenFlow header length is initially set to 'openflow_len'; if the
1476 * message is later extended, the length should be updated with
1477 * update_openflow_length() before sending.
1479 * Returns the header. */
1481 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1482 struct ofpbuf *buffer)
1484 struct ofp_header *oh;
1486 assert(openflow_len >= sizeof *oh);
1487 assert(openflow_len <= UINT16_MAX);
1489 oh = ofpbuf_put_uninit(buffer, openflow_len);
1490 oh->version = OFP_VERSION;
1492 oh->length = htons(openflow_len);
1494 memset(oh + 1, 0, openflow_len - sizeof *oh);
1498 /* Similar to put_openflow() but append a Nicira vendor extension message with
1499 * the specific 'subtype'. 'subtype' should be in host byte order. */
1501 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1503 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1506 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1507 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1509 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1510 struct ofpbuf *buffer)
1512 struct nicira_header *nxh;
1514 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1515 nxh->vendor = htonl(NX_VENDOR_ID);
1516 nxh->subtype = htonl(subtype);
1520 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1521 * 'buffer->size'. */
1523 update_openflow_length(struct ofpbuf *buffer)
1525 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1526 oh->length = htons(buffer->size);
1529 /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
1530 * space allocated for the 'body' member. Returns the first byte of the 'body'
1533 ofputil_make_stats_request(size_t body_len, uint16_t type,
1534 struct ofpbuf **bufferp)
1536 struct ofp_stats_request *osr;
1537 osr = make_openflow((offsetof(struct ofp_stats_request, body)
1538 + body_len), OFPT_STATS_REQUEST, bufferp);
1539 osr->type = htons(type);
1540 osr->flags = htons(0);
1544 /* Creates a stats request message with Nicira as vendor and the given
1545 * 'subtype', of total length 'openflow_len'. Returns the message. */
1547 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
1548 struct ofpbuf **bufferp)
1550 struct nicira_stats_msg *nsm;
1552 nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
1553 nsm->type = htons(OFPST_VENDOR);
1554 nsm->flags = htons(0);
1555 nsm->vendor = htonl(NX_VENDOR_ID);
1556 nsm->subtype = htonl(subtype);
1560 /* Returns the first byte of the 'body' member of the ofp_stats_request or
1561 * ofp_stats_reply in 'oh'. */
1563 ofputil_stats_body(const struct ofp_header *oh)
1565 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1566 return ((const struct ofp_stats_request *) oh)->body;
1569 /* Returns the length of the 'body' member of the ofp_stats_request or
1570 * ofp_stats_reply in 'oh'. */
1572 ofputil_stats_body_len(const struct ofp_header *oh)
1574 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1575 return ntohs(oh->length) - sizeof(struct ofp_stats_request);
1578 /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
1580 ofputil_nxstats_body(const struct ofp_header *oh)
1582 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1583 return ((const struct nicira_stats_msg *) oh) + 1;
1586 /* Returns the length of the body of the nicira_stats_msg in 'oh'. */
1588 ofputil_nxstats_body_len(const struct ofp_header *oh)
1590 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1591 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1595 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1598 struct ofp_flow_mod *ofm;
1599 size_t size = sizeof *ofm + actions_len;
1600 struct ofpbuf *out = ofpbuf_new(size);
1601 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1602 ofm->header.version = OFP_VERSION;
1603 ofm->header.type = OFPT_FLOW_MOD;
1604 ofm->header.length = htons(size);
1606 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1607 ofputil_cls_rule_to_match(rule, &ofm->match);
1608 ofm->command = htons(command);
1613 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1614 uint16_t idle_timeout, size_t actions_len)
1616 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1617 struct ofp_flow_mod *ofm = out->data;
1618 ofm->idle_timeout = htons(idle_timeout);
1619 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1620 ofm->buffer_id = htonl(buffer_id);
1625 make_del_flow(const struct cls_rule *rule)
1627 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1628 struct ofp_flow_mod *ofm = out->data;
1629 ofm->out_port = htons(OFPP_NONE);
1634 make_add_simple_flow(const struct cls_rule *rule,
1635 uint32_t buffer_id, uint16_t out_port,
1636 uint16_t idle_timeout)
1638 if (out_port != OFPP_NONE) {
1639 struct ofp_action_output *oao;
1640 struct ofpbuf *buffer;
1642 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1643 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1644 oao->type = htons(OFPAT_OUTPUT);
1645 oao->len = htons(sizeof *oao);
1646 oao->port = htons(out_port);
1649 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1654 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1655 const struct ofpbuf *payload, int max_send_len)
1657 struct ofp_packet_in *opi;
1661 send_len = MIN(max_send_len, payload->size);
1662 buf = ofpbuf_new(sizeof *opi + send_len);
1663 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1664 OFPT_PACKET_IN, 0, buf);
1665 opi->buffer_id = htonl(buffer_id);
1666 opi->total_len = htons(payload->size);
1667 opi->in_port = htons(in_port);
1668 opi->reason = reason;
1669 ofpbuf_put(buf, payload->data, send_len);
1670 update_openflow_length(buf);
1676 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1678 const struct ofp_action_header *actions, size_t n_actions)
1680 size_t actions_len = n_actions * sizeof *actions;
1681 struct ofp_packet_out *opo;
1682 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1683 struct ofpbuf *out = ofpbuf_new(size);
1685 opo = ofpbuf_put_uninit(out, sizeof *opo);
1686 opo->header.version = OFP_VERSION;
1687 opo->header.type = OFPT_PACKET_OUT;
1688 opo->header.length = htons(size);
1689 opo->header.xid = htonl(0);
1690 opo->buffer_id = htonl(buffer_id);
1691 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1692 opo->actions_len = htons(actions_len);
1693 ofpbuf_put(out, actions, actions_len);
1695 ofpbuf_put(out, packet->data, packet->size);
1701 make_unbuffered_packet_out(const struct ofpbuf *packet,
1702 uint16_t in_port, uint16_t out_port)
1704 struct ofp_action_output action;
1705 action.type = htons(OFPAT_OUTPUT);
1706 action.len = htons(sizeof action);
1707 action.port = htons(out_port);
1708 return make_packet_out(packet, UINT32_MAX, in_port,
1709 (struct ofp_action_header *) &action, 1);
1713 make_buffered_packet_out(uint32_t buffer_id,
1714 uint16_t in_port, uint16_t out_port)
1716 if (out_port != OFPP_NONE) {
1717 struct ofp_action_output action;
1718 action.type = htons(OFPAT_OUTPUT);
1719 action.len = htons(sizeof action);
1720 action.port = htons(out_port);
1721 return make_packet_out(NULL, buffer_id, in_port,
1722 (struct ofp_action_header *) &action, 1);
1724 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1728 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1730 make_echo_request(void)
1732 struct ofp_header *rq;
1733 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1734 rq = ofpbuf_put_uninit(out, sizeof *rq);
1735 rq->version = OFP_VERSION;
1736 rq->type = OFPT_ECHO_REQUEST;
1737 rq->length = htons(sizeof *rq);
1742 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1743 * OFPT_ECHO_REQUEST message in 'rq'. */
1745 make_echo_reply(const struct ofp_header *rq)
1747 size_t size = ntohs(rq->length);
1748 struct ofpbuf *out = ofpbuf_new(size);
1749 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1750 reply->type = OFPT_ECHO_REPLY;
1755 check_action_exact_len(const union ofp_action *a, unsigned int len,
1756 unsigned int required_len)
1758 if (len != required_len) {
1759 VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length "
1760 "%"PRIu16" (must be %u)\n",
1761 ntohs(a->type), ntohs(a->header.len), required_len);
1762 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1768 check_nx_action_exact_len(const struct nx_action_header *a,
1769 unsigned int len, unsigned int required_len)
1771 if (len != required_len) {
1772 VLOG_WARN_RL(&bad_ofmsg_rl,
1773 "Nicira action %"PRIu16" has invalid length %"PRIu16" "
1775 ntohs(a->subtype), ntohs(a->len), required_len);
1776 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1781 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1782 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1783 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1785 check_output_port(uint16_t port, int max_ports)
1793 case OFPP_CONTROLLER:
1798 if (port < max_ports) {
1801 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1802 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1806 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1807 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
1808 * otherwise an ofp_mkerr() return code. */
1810 check_enqueue_action(const union ofp_action *a, unsigned int len,
1813 const struct ofp_action_enqueue *oae;
1817 error = check_action_exact_len(a, len, 16);
1822 oae = (const struct ofp_action_enqueue *) a;
1823 port = ntohs(oae->port);
1824 if (port < max_ports || port == OFPP_IN_PORT) {
1827 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1828 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1832 check_nicira_action(const union ofp_action *a, unsigned int len,
1833 const struct flow *flow)
1835 const struct nx_action_header *nah;
1840 VLOG_WARN_RL(&bad_ofmsg_rl,
1841 "Nicira vendor action only %u bytes", len);
1842 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1844 nah = (const struct nx_action_header *) a;
1846 subtype = ntohs(nah->subtype);
1847 if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
1848 /* This is necessary because enum nx_action_subtype may be an
1849 * 8-bit type, so the cast below throws away the top 8 bits. */
1850 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1853 switch ((enum nx_action_subtype) subtype) {
1854 case NXAST_RESUBMIT:
1855 case NXAST_SET_TUNNEL:
1856 case NXAST_SET_QUEUE:
1857 case NXAST_POP_QUEUE:
1858 return check_nx_action_exact_len(nah, len, 16);
1860 case NXAST_REG_MOVE:
1861 error = check_nx_action_exact_len(nah, len,
1862 sizeof(struct nx_action_reg_move));
1866 return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1868 case NXAST_REG_LOAD:
1869 error = check_nx_action_exact_len(nah, len,
1870 sizeof(struct nx_action_reg_load));
1874 return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1879 case NXAST_SET_TUNNEL64:
1880 return check_nx_action_exact_len(
1881 nah, len, sizeof(struct nx_action_set_tunnel64));
1883 case NXAST_MULTIPATH:
1884 error = check_nx_action_exact_len(
1885 nah, len, sizeof(struct nx_action_multipath));
1889 return multipath_check((const struct nx_action_multipath *) a);
1891 case NXAST_AUTOPATH:
1892 error = check_nx_action_exact_len(
1893 nah, len, sizeof(struct nx_action_autopath));
1897 return autopath_check((const struct nx_action_autopath *) a);
1899 case NXAST_SNAT__OBSOLETE:
1900 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
1902 VLOG_WARN_RL(&bad_ofmsg_rl,
1903 "unknown Nicira vendor action subtype %d", subtype);
1904 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1909 check_action(const union ofp_action *a, unsigned int len,
1910 const struct flow *flow, int max_ports)
1912 enum ofp_action_type type = ntohs(a->type);
1917 error = check_action_exact_len(a, len, 8);
1921 return check_output_port(ntohs(a->output.port), max_ports);
1923 case OFPAT_SET_VLAN_VID:
1924 error = check_action_exact_len(a, len, 8);
1928 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1929 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1933 case OFPAT_SET_VLAN_PCP:
1934 error = check_action_exact_len(a, len, 8);
1938 if (a->vlan_pcp.vlan_pcp & ~7) {
1939 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1943 case OFPAT_STRIP_VLAN:
1944 case OFPAT_SET_NW_SRC:
1945 case OFPAT_SET_NW_DST:
1946 case OFPAT_SET_NW_TOS:
1947 case OFPAT_SET_TP_SRC:
1948 case OFPAT_SET_TP_DST:
1949 return check_action_exact_len(a, len, 8);
1951 case OFPAT_SET_DL_SRC:
1952 case OFPAT_SET_DL_DST:
1953 return check_action_exact_len(a, len, 16);
1956 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
1957 ? check_nicira_action(a, len, flow)
1958 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
1961 return check_enqueue_action(a, len, max_ports);
1964 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
1965 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
1970 validate_actions(const union ofp_action *actions, size_t n_actions,
1971 const struct flow *flow, int max_ports)
1975 for (i = 0; i < n_actions; ) {
1976 const union ofp_action *a = &actions[i];
1977 unsigned int len = ntohs(a->header.len);
1978 unsigned int n_slots = len / OFP_ACTION_ALIGN;
1979 unsigned int slots_left = &actions[n_actions] - a;
1982 if (n_slots > slots_left) {
1983 VLOG_WARN_RL(&bad_ofmsg_rl,
1984 "action requires %u slots but only %u remain",
1985 n_slots, slots_left);
1986 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1988 VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0");
1989 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1990 } else if (len % OFP_ACTION_ALIGN) {
1991 VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
1992 "of %d", len, OFP_ACTION_ALIGN);
1993 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1996 error = check_action(a, len, flow, max_ports);
2005 /* Returns true if 'action' outputs to 'port', false otherwise. */
2007 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2009 switch (ntohs(action->type)) {
2011 return action->output.port == port;
2013 return ((const struct ofp_action_enqueue *) action)->port == port;
2019 /* The set of actions must either come from a trusted source or have been
2020 * previously validated with validate_actions(). */
2021 const union ofp_action *
2022 actions_first(struct actions_iterator *iter,
2023 const union ofp_action *oa, size_t n_actions)
2026 iter->end = oa + n_actions;
2027 return actions_next(iter);
2030 const union ofp_action *
2031 actions_next(struct actions_iterator *iter)
2033 if (iter->pos != iter->end) {
2034 const union ofp_action *a = iter->pos;
2035 unsigned int len = ntohs(a->header.len);
2036 iter->pos += len / OFP_ACTION_ALIGN;
2043 /* "Normalizes" the wildcards in 'rule'. That means:
2045 * 1. If the type of level N is known, then only the valid fields for that
2046 * level may be specified. For example, ARP does not have a TOS field,
2047 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2048 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2049 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2052 * 2. If the type of level N is not known (or not understood by Open
2053 * vSwitch), then no fields at all for that level may be specified. For
2054 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2055 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2058 * 'flow_format' specifies the format of the flow as received or as intended to
2059 * be sent. This is important for IPv6 and ARP, for which NXM supports more
2060 * detailed matching. */
2062 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2065 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
2066 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
2067 MAY_NW_PROTO = 1 << 2, /* nw_proto */
2068 MAY_NW_TOS = 1 << 3, /* nw_tos */
2069 MAY_ARP_SHA = 1 << 4, /* arp_sha */
2070 MAY_ARP_THA = 1 << 5, /* arp_tha */
2071 MAY_IPV6_ADDR = 1 << 6, /* ipv6_src, ipv6_dst */
2072 MAY_ND_TARGET = 1 << 7 /* nd_target */
2075 struct flow_wildcards wc;
2077 /* Figure out what fields may be matched. */
2078 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2079 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_NW_ADDR;
2080 if (rule->flow.nw_proto == IPPROTO_TCP ||
2081 rule->flow.nw_proto == IPPROTO_UDP ||
2082 rule->flow.nw_proto == IPPROTO_ICMP) {
2083 may_match |= MAY_TP_ADDR;
2085 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2086 && flow_format == NXFF_NXM) {
2087 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_IPV6_ADDR;
2088 if (rule->flow.nw_proto == IPPROTO_TCP ||
2089 rule->flow.nw_proto == IPPROTO_UDP) {
2090 may_match |= MAY_TP_ADDR;
2091 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2092 may_match |= MAY_TP_ADDR;
2093 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2094 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2095 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2096 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2099 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2100 may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2101 if (flow_format == NXFF_NXM) {
2102 may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2108 /* Clear the fields that may not be matched. */
2110 if (!(may_match & MAY_NW_ADDR)) {
2111 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2113 if (!(may_match & MAY_TP_ADDR)) {
2114 wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2116 if (!(may_match & MAY_NW_PROTO)) {
2117 wc.wildcards |= FWW_NW_PROTO;
2119 if (!(may_match & MAY_NW_TOS)) {
2120 wc.wildcards |= FWW_NW_TOS;
2122 if (!(may_match & MAY_ARP_SHA)) {
2123 wc.wildcards |= FWW_ARP_SHA;
2125 if (!(may_match & MAY_ARP_THA)) {
2126 wc.wildcards |= FWW_ARP_THA;
2128 if (!(may_match & MAY_IPV6_ADDR)) {
2129 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2131 if (!(may_match & MAY_ND_TARGET)) {
2132 wc.wildcards |= FWW_ND_TARGET;
2135 /* Log any changes. */
2136 if (!flow_wildcards_equal(&wc, &rule->wc)) {
2137 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2138 char *pre = log ? cls_rule_to_string(rule) : NULL;
2141 cls_rule_zero_wildcarded_fields(rule);
2144 char *post = cls_rule_to_string(rule);
2145 VLOG_INFO("normalization changed ofp_match, details:");
2146 VLOG_INFO(" pre: %s", pre);
2147 VLOG_INFO("post: %s", post);
2155 vendor_code_to_id(uint8_t code)
2158 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2160 #undef OFPUTIL_VENDOR
2167 vendor_id_to_code(uint32_t id)
2170 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2172 #undef OFPUTIL_VENDOR
2178 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2179 * information taken from 'error', whose encoding must be as described in the
2180 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
2181 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2184 * Returns NULL if 'error' is not an OpenFlow error code. */
2186 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2188 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2198 if (!is_ofp_error(error)) {
2199 /* We format 'error' with strerror() here since it seems likely to be
2200 * a system errno value. */
2201 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2202 error, strerror(error));
2209 len = ntohs(oh->length);
2219 vendor = get_ofp_err_vendor(error);
2220 type = get_ofp_err_type(error);
2221 code = get_ofp_err_code(error);
2222 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2223 struct ofp_error_msg *oem;
2225 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2226 oem->type = htons(type);
2227 oem->code = htons(code);
2229 struct ofp_error_msg *oem;
2230 struct nx_vendor_error *nve;
2233 vendor_id = vendor_code_to_id(vendor);
2234 if (vendor_id == UINT32_MAX) {
2235 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2240 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2241 OFPT_ERROR, xid, &buf);
2242 oem->type = htons(NXET_VENDOR);
2243 oem->code = htons(NXVC_VENDOR_ERROR);
2245 nve = (struct nx_vendor_error *)oem->data;
2246 nve->vendor = htonl(vendor_id);
2247 nve->type = htons(type);
2248 nve->code = htons(code);
2253 ofpbuf_put(buf, data, len);
2259 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2260 * Open vSwitch internal error code in the format described in the large
2261 * comment in ofp-util.h.
2263 * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2264 * to the payload starting from 'oh' and on failure it is set to 0. */
2266 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2268 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2270 const struct ofp_error_msg *oem;
2271 uint16_t type, code;
2278 if (oh->type != OFPT_ERROR) {
2282 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2283 oem = ofpbuf_try_pull(&b, sizeof *oem);
2288 type = ntohs(oem->type);
2289 code = ntohs(oem->code);
2290 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2291 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2296 vendor = vendor_id_to_code(ntohl(nve->vendor));
2298 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2299 ntohl(nve->vendor));
2302 type = ntohs(nve->type);
2303 code = ntohs(nve->code);
2305 vendor = OFPUTIL_VENDOR_OPENFLOW;
2309 VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2310 "supported maximum value 1023", type);
2315 *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2317 return ofp_mkerr_vendor(vendor, type, code);
2321 ofputil_format_error(struct ds *s, int error)
2323 if (is_errno(error)) {
2324 ds_put_cstr(s, strerror(error));
2326 uint16_t type = get_ofp_err_type(error);
2327 uint16_t code = get_ofp_err_code(error);
2328 const char *type_s = ofp_error_type_to_string(type);
2329 const char *code_s = ofp_error_code_to_string(type, code);
2331 ds_put_format(s, "type ");
2333 ds_put_cstr(s, type_s);
2335 ds_put_format(s, "%"PRIu16, type);
2338 ds_put_cstr(s, ", code ");
2340 ds_put_cstr(s, code_s);
2342 ds_put_format(s, "%"PRIu16, code);
2348 ofputil_error_to_string(int error)
2350 struct ds s = DS_EMPTY_INITIALIZER;
2351 ofputil_format_error(&s, error);
2352 return ds_steal_cstr(&s);
2355 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2356 * successful, otherwise an OpenFlow error.
2358 * If successful, the first action is stored in '*actionsp' and the number of
2359 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2360 * are stored, respectively.
2362 * This function does not check that the actions are valid (the caller should
2363 * do so, with validate_actions()). The caller is also responsible for making
2364 * sure that 'b->data' is initially aligned appropriately for "union
2367 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2368 union ofp_action **actionsp, size_t *n_actionsp)
2370 if (actions_len % OFP_ACTION_ALIGN != 0) {
2371 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2372 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2376 *actionsp = ofpbuf_try_pull(b, actions_len);
2377 if (*actionsp == NULL) {
2378 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2379 "exceeds remaining message length (%zu)",
2380 actions_len, b->size);
2384 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2390 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);