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->body, 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 enum { OSM_SIZE = sizeof(struct ofp_stats_msg) };
504 static const struct ofputil_msg_type ofpst_requests[] = {
505 { OFPUTIL_OFPST_DESC_REQUEST,
506 OFPST_DESC, "OFPST_DESC request",
509 { OFPUTIL_OFPST_FLOW_REQUEST,
510 OFPST_FLOW, "OFPST_FLOW request",
511 OSM_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
513 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
514 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
515 OSM_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
517 { OFPUTIL_OFPST_TABLE_REQUEST,
518 OFPST_TABLE, "OFPST_TABLE request",
521 { OFPUTIL_OFPST_PORT_REQUEST,
522 OFPST_PORT, "OFPST_PORT request",
523 OSM_SIZE + sizeof(struct ofp_port_stats_request), 0 },
525 { OFPUTIL_OFPST_QUEUE_REQUEST,
526 OFPST_QUEUE, "OFPST_QUEUE request",
527 OSM_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
530 OFPST_VENDOR, "OFPST_VENDOR request",
531 OSM_SIZE + sizeof(uint32_t), 1 },
534 static const struct ofputil_msg_category ofpst_request_category = {
535 "OpenFlow statistics",
536 ofpst_requests, ARRAY_SIZE(ofpst_requests),
537 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
540 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
543 error = ofputil_lookup_openflow_message(&ofpst_request_category,
544 ntohs(request->type),
545 ntohs(oh->length), typep);
546 if (!error && request->type == htons(OFPST_VENDOR)) {
547 error = ofputil_decode_nxst_request(oh, typep);
553 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
554 const struct ofputil_msg_type **typep)
556 enum { OSM_SIZE = sizeof(struct ofp_stats_msg) };
557 static const struct ofputil_msg_type ofpst_replies[] = {
558 { OFPUTIL_OFPST_DESC_REPLY,
559 OFPST_DESC, "OFPST_DESC reply",
560 OSM_SIZE + sizeof(struct ofp_desc_stats), 0 },
562 { OFPUTIL_OFPST_FLOW_REPLY,
563 OFPST_FLOW, "OFPST_FLOW reply",
566 { OFPUTIL_OFPST_AGGREGATE_REPLY,
567 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
568 OSM_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
570 { OFPUTIL_OFPST_TABLE_REPLY,
571 OFPST_TABLE, "OFPST_TABLE reply",
572 OSM_SIZE, sizeof(struct ofp_table_stats) },
574 { OFPUTIL_OFPST_PORT_REPLY,
575 OFPST_PORT, "OFPST_PORT reply",
576 OSM_SIZE, sizeof(struct ofp_port_stats) },
578 { OFPUTIL_OFPST_QUEUE_REPLY,
579 OFPST_QUEUE, "OFPST_QUEUE reply",
580 OSM_SIZE, sizeof(struct ofp_queue_stats) },
583 OFPST_VENDOR, "OFPST_VENDOR reply",
584 OSM_SIZE + sizeof(uint32_t), 1 },
587 static const struct ofputil_msg_category ofpst_reply_category = {
588 "OpenFlow statistics",
589 ofpst_replies, ARRAY_SIZE(ofpst_replies),
590 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
593 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
596 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
598 ntohs(oh->length), typep);
599 if (!error && reply->type == htons(OFPST_VENDOR)) {
600 error = ofputil_decode_nxst_reply(oh, typep);
605 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
606 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
607 * way, stores in '*typep' a type structure that can be inspected with the
608 * ofputil_msg_type_*() functions.
610 * oh->length must indicate the correct length of the message (and must be at
611 * least sizeof(struct ofp_header)).
613 * Success indicates that 'oh' is at least as long as the minimum-length
614 * message of its type. */
616 ofputil_decode_msg_type(const struct ofp_header *oh,
617 const struct ofputil_msg_type **typep)
619 static const struct ofputil_msg_type ofpt_messages[] = {
620 { OFPUTIL_OFPT_HELLO,
621 OFPT_HELLO, "OFPT_HELLO",
622 sizeof(struct ofp_hello), 1 },
624 { OFPUTIL_OFPT_ERROR,
625 OFPT_ERROR, "OFPT_ERROR",
626 sizeof(struct ofp_error_msg), 1 },
628 { OFPUTIL_OFPT_ECHO_REQUEST,
629 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
630 sizeof(struct ofp_header), 1 },
632 { OFPUTIL_OFPT_ECHO_REPLY,
633 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
634 sizeof(struct ofp_header), 1 },
636 { OFPUTIL_OFPT_FEATURES_REQUEST,
637 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
638 sizeof(struct ofp_header), 0 },
640 { OFPUTIL_OFPT_FEATURES_REPLY,
641 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
642 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
644 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
645 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
646 sizeof(struct ofp_header), 0 },
648 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
649 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
650 sizeof(struct ofp_switch_config), 0 },
652 { OFPUTIL_OFPT_SET_CONFIG,
653 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
654 sizeof(struct ofp_switch_config), 0 },
656 { OFPUTIL_OFPT_PACKET_IN,
657 OFPT_PACKET_IN, "OFPT_PACKET_IN",
658 offsetof(struct ofp_packet_in, data), 1 },
660 { OFPUTIL_OFPT_FLOW_REMOVED,
661 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
662 sizeof(struct ofp_flow_removed), 0 },
664 { OFPUTIL_OFPT_PORT_STATUS,
665 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
666 sizeof(struct ofp_port_status), 0 },
668 { OFPUTIL_OFPT_PACKET_OUT,
669 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
670 sizeof(struct ofp_packet_out), 1 },
672 { OFPUTIL_OFPT_FLOW_MOD,
673 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
674 sizeof(struct ofp_flow_mod), 1 },
676 { OFPUTIL_OFPT_PORT_MOD,
677 OFPT_PORT_MOD, "OFPT_PORT_MOD",
678 sizeof(struct ofp_port_mod), 0 },
681 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
682 sizeof(struct ofp_stats_msg), 1 },
685 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
686 sizeof(struct ofp_stats_msg), 1 },
688 { OFPUTIL_OFPT_BARRIER_REQUEST,
689 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
690 sizeof(struct ofp_header), 0 },
692 { OFPUTIL_OFPT_BARRIER_REPLY,
693 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
694 sizeof(struct ofp_header), 0 },
697 OFPT_VENDOR, "OFPT_VENDOR",
698 sizeof(struct ofp_vendor_header), 1 },
701 static const struct ofputil_msg_category ofpt_category = {
703 ofpt_messages, ARRAY_SIZE(ofpt_messages),
704 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
709 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
710 ntohs(oh->length), typep);
714 error = ofputil_decode_vendor(oh, typep);
717 case OFPT_STATS_REQUEST:
718 error = ofputil_decode_ofpst_request(oh, typep);
721 case OFPT_STATS_REPLY:
722 error = ofputil_decode_ofpst_reply(oh, typep);
729 static const struct ofputil_msg_type ofputil_invalid_type = {
731 0, "OFPUTIL_INVALID",
735 *typep = &ofputil_invalid_type;
740 /* Returns an OFPUTIL_* message type code for 'type'. */
741 enum ofputil_msg_code
742 ofputil_msg_type_code(const struct ofputil_msg_type *type)
750 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
752 switch (flow_format) {
753 case NXFF_OPENFLOW10:
762 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
764 switch (flow_format) {
765 case NXFF_OPENFLOW10:
775 ofputil_flow_format_from_string(const char *s)
777 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
778 : !strcmp(s, "nxm") ? NXFF_NXM
783 regs_fully_wildcarded(const struct flow_wildcards *wc)
787 for (i = 0; i < FLOW_N_REGS; i++) {
788 if (wc->reg_masks[i] != 0) {
795 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
796 * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
797 * or fixing the Ethernet multicast bit. Otherwise, it's better to use
798 * NXFF_OPENFLOW10 for backward compatibility. */
800 ofputil_min_flow_format(const struct cls_rule *rule)
802 const struct flow_wildcards *wc = &rule->wc;
804 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
805 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
809 /* Only NXM supports matching ARP hardware addresses. */
810 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
814 /* Only NXM supports matching IPv6 traffic. */
815 if (!(wc->wildcards & FWW_DL_TYPE)
816 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
820 /* Only NXM supports matching registers. */
821 if (!regs_fully_wildcarded(wc)) {
825 /* Only NXM supports matching tun_id. */
826 if (wc->tun_id_mask != htonll(0)) {
830 /* Other formats can express this rule. */
831 return NXFF_OPENFLOW10;
834 /* Returns an OpenFlow message that can be used to set the flow format to
837 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
839 struct nxt_set_flow_format *sff;
842 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
843 sff->format = htonl(flow_format);
848 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
849 * extension on or off (according to 'flow_mod_table_id'). */
851 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
853 struct nxt_flow_mod_table_id *nfmti;
856 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
857 nfmti->set = flow_mod_table_id;
861 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
862 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
865 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
866 * enabled, false otherwise.
868 * Does not validate the flow_mod actions. */
870 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
871 bool flow_mod_table_id)
873 const struct ofputil_msg_type *type;
877 ofpbuf_use_const(&b, oh, ntohs(oh->length));
879 ofputil_decode_msg_type(oh, &type);
880 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
881 /* Standard OpenFlow flow_mod. */
882 const struct ofp_flow_mod *ofm;
886 /* Dissect the message. */
887 ofm = ofpbuf_pull(&b, sizeof *ofm);
888 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
893 /* Set priority based on original wildcards. Normally we'd allow
894 * ofputil_cls_rule_from_match() to do this for us, but
895 * ofputil_normalize_rule() can put wildcards where the original flow
896 * didn't have them. */
897 priority = ntohs(ofm->priority);
898 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
899 priority = UINT16_MAX;
902 /* Translate the rule. */
903 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
904 ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
906 /* Translate the message. */
907 fm->cookie = ofm->cookie;
908 command = ntohs(ofm->command);
909 fm->idle_timeout = ntohs(ofm->idle_timeout);
910 fm->hard_timeout = ntohs(ofm->hard_timeout);
911 fm->buffer_id = ntohl(ofm->buffer_id);
912 fm->out_port = ntohs(ofm->out_port);
913 fm->flags = ntohs(ofm->flags);
914 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
915 /* Nicira extended flow_mod. */
916 const struct nx_flow_mod *nfm;
919 /* Dissect the message. */
920 nfm = ofpbuf_pull(&b, sizeof *nfm);
921 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
926 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
931 /* Translate the message. */
932 fm->cookie = nfm->cookie;
933 command = ntohs(nfm->command);
934 fm->idle_timeout = ntohs(nfm->idle_timeout);
935 fm->hard_timeout = ntohs(nfm->hard_timeout);
936 fm->buffer_id = ntohl(nfm->buffer_id);
937 fm->out_port = ntohs(nfm->out_port);
938 fm->flags = ntohs(nfm->flags);
943 if (flow_mod_table_id) {
944 fm->command = command & 0xff;
945 fm->table_id = command >> 8;
947 fm->command = command;
954 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
955 * 'flow_format' and returns the message.
957 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
958 * enabled, false otherwise. */
960 ofputil_encode_flow_mod(const struct flow_mod *fm,
961 enum nx_flow_format flow_format,
962 bool flow_mod_table_id)
964 size_t actions_len = fm->n_actions * sizeof *fm->actions;
968 command = (flow_mod_table_id
969 ? (fm->command & 0xff) | (fm->table_id << 8)
972 if (flow_format == NXFF_OPENFLOW10) {
973 struct ofp_flow_mod *ofm;
975 msg = ofpbuf_new(sizeof *ofm + actions_len);
976 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
977 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
978 ofm->cookie = fm->cookie;
979 ofm->command = htons(fm->command);
980 ofm->idle_timeout = htons(fm->idle_timeout);
981 ofm->hard_timeout = htons(fm->hard_timeout);
982 ofm->priority = htons(fm->cr.priority);
983 ofm->buffer_id = htonl(fm->buffer_id);
984 ofm->out_port = htons(fm->out_port);
985 ofm->flags = htons(fm->flags);
986 } else if (flow_format == NXFF_NXM) {
987 struct nx_flow_mod *nfm;
990 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
991 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
992 match_len = nx_put_match(msg, &fm->cr);
995 nfm->cookie = fm->cookie;
996 nfm->command = htons(command);
997 nfm->idle_timeout = htons(fm->idle_timeout);
998 nfm->hard_timeout = htons(fm->hard_timeout);
999 nfm->priority = htons(fm->cr.priority);
1000 nfm->buffer_id = htonl(fm->buffer_id);
1001 nfm->out_port = htons(fm->out_port);
1002 nfm->flags = htons(fm->flags);
1003 nfm->match_len = htons(match_len);
1008 ofpbuf_put(msg, fm->actions, actions_len);
1009 update_openflow_length(msg);
1014 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1015 const struct ofp_header *oh,
1018 const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
1020 fsr->aggregate = aggregate;
1021 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1022 fsr->out_port = ntohs(ofsr->out_port);
1023 fsr->table_id = ofsr->table_id;
1029 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1030 const struct ofp_header *oh,
1033 const struct nx_flow_stats_request *nfsr;
1037 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1039 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1040 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1045 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1048 fsr->aggregate = aggregate;
1049 fsr->out_port = ntohs(nfsr->out_port);
1050 fsr->table_id = nfsr->table_id;
1055 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1056 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1057 * successful, otherwise an OpenFlow error code. */
1059 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1060 const struct ofp_header *oh)
1062 const struct ofputil_msg_type *type;
1066 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1068 ofputil_decode_msg_type(oh, &type);
1069 code = ofputil_msg_type_code(type);
1071 case OFPUTIL_OFPST_FLOW_REQUEST:
1072 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1074 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1075 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1077 case OFPUTIL_NXST_FLOW_REQUEST:
1078 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1080 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1081 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1084 /* Hey, the caller lied. */
1089 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1090 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1091 * 'flow_format', and returns the message. */
1093 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1094 enum nx_flow_format flow_format)
1098 if (flow_format == NXFF_OPENFLOW10) {
1099 struct ofp_flow_stats_request *ofsr;
1102 BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
1103 == sizeof(struct ofp_aggregate_stats_request));
1105 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1106 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
1107 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1108 ofsr->table_id = fsr->table_id;
1109 ofsr->out_port = htons(fsr->out_port);
1110 } else if (flow_format == NXFF_NXM) {
1111 struct nx_flow_stats_request *nfsr;
1115 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1116 ofputil_make_nxstats_request(sizeof *nfsr, subtype, &msg);
1117 match_len = nx_put_match(msg, &fsr->match);
1120 nfsr->out_port = htons(fsr->out_port);
1121 nfsr->match_len = htons(match_len);
1122 nfsr->table_id = fsr->table_id;
1130 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1131 * ofputil_flow_stats in 'fs'.
1133 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1134 * OpenFlow message. Calling this function multiple times for a single 'msg'
1135 * iterates through the replies. The caller must initially leave 'msg''s layer
1136 * pointers null and not modify them between calls.
1138 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1139 * otherwise a positive errno value. */
1141 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1144 const struct ofputil_msg_type *type;
1147 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1148 code = ofputil_msg_type_code(type);
1150 msg->l2 = msg->data;
1151 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1152 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1153 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1154 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1162 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1163 const struct ofp_flow_stats *ofs;
1166 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1168 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1169 "bytes at end", msg->size);
1173 length = ntohs(ofs->length);
1174 if (length < sizeof *ofs) {
1175 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1176 "length %zu", length);
1180 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1181 &fs->actions, &fs->n_actions)) {
1185 fs->cookie = get_32aligned_be64(&ofs->cookie);
1186 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1188 fs->table_id = ofs->table_id;
1189 fs->duration_sec = ntohl(ofs->duration_sec);
1190 fs->duration_nsec = ntohl(ofs->duration_nsec);
1191 fs->idle_timeout = ntohs(ofs->idle_timeout);
1192 fs->hard_timeout = ntohs(ofs->hard_timeout);
1193 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1194 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1195 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1196 const struct nx_flow_stats *nfs;
1197 size_t match_len, length;
1199 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1201 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1202 "bytes at end", msg->size);
1206 length = ntohs(nfs->length);
1207 match_len = ntohs(nfs->match_len);
1208 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1209 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1210 "claims invalid length %zu", match_len, length);
1213 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
1217 if (ofputil_pull_actions(msg,
1218 length - sizeof *nfs - ROUND_UP(match_len, 8),
1219 &fs->actions, &fs->n_actions)) {
1223 fs->cookie = nfs->cookie;
1224 fs->table_id = nfs->table_id;
1225 fs->duration_sec = ntohl(nfs->duration_sec);
1226 fs->duration_nsec = ntohl(nfs->duration_nsec);
1227 fs->idle_timeout = ntohs(nfs->idle_timeout);
1228 fs->hard_timeout = ntohs(nfs->hard_timeout);
1229 fs->packet_count = ntohll(nfs->packet_count);
1230 fs->byte_count = ntohll(nfs->byte_count);
1238 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1239 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1240 * an OpenFlow error code. */
1242 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1243 const struct ofp_header *oh)
1245 const struct ofputil_msg_type *type;
1246 enum ofputil_msg_code code;
1248 ofputil_decode_msg_type(oh, &type);
1249 code = ofputil_msg_type_code(type);
1250 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1251 const struct ofp_flow_removed *ofr;
1253 ofr = (const struct ofp_flow_removed *) oh;
1254 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1256 fr->cookie = ofr->cookie;
1257 fr->reason = ofr->reason;
1258 fr->duration_sec = ntohl(ofr->duration_sec);
1259 fr->duration_nsec = ntohl(ofr->duration_nsec);
1260 fr->idle_timeout = ntohs(ofr->idle_timeout);
1261 fr->packet_count = ntohll(ofr->packet_count);
1262 fr->byte_count = ntohll(ofr->byte_count);
1263 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1264 struct nx_flow_removed *nfr;
1268 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1270 nfr = ofpbuf_pull(&b, sizeof *nfr);
1271 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1277 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1280 fr->cookie = nfr->cookie;
1281 fr->reason = nfr->reason;
1282 fr->duration_sec = ntohl(nfr->duration_sec);
1283 fr->duration_nsec = ntohl(nfr->duration_nsec);
1284 fr->idle_timeout = ntohs(nfr->idle_timeout);
1285 fr->packet_count = ntohll(nfr->packet_count);
1286 fr->byte_count = ntohll(nfr->byte_count);
1294 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1295 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1298 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1299 enum nx_flow_format flow_format)
1303 if (flow_format == NXFF_OPENFLOW10) {
1304 struct ofp_flow_removed *ofr;
1306 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1308 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1309 ofr->cookie = fr->cookie;
1310 ofr->priority = htons(fr->rule.priority);
1311 ofr->reason = fr->reason;
1312 ofr->duration_sec = htonl(fr->duration_sec);
1313 ofr->duration_nsec = htonl(fr->duration_nsec);
1314 ofr->idle_timeout = htons(fr->idle_timeout);
1315 ofr->packet_count = htonll(fr->packet_count);
1316 ofr->byte_count = htonll(fr->byte_count);
1317 } else if (flow_format == NXFF_NXM) {
1318 struct nx_flow_removed *nfr;
1321 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1322 match_len = nx_put_match(msg, &fr->rule);
1325 nfr->cookie = fr->cookie;
1326 nfr->priority = htons(fr->rule.priority);
1327 nfr->reason = fr->reason;
1328 nfr->duration_sec = htonl(fr->duration_sec);
1329 nfr->duration_nsec = htonl(fr->duration_nsec);
1330 nfr->idle_timeout = htons(fr->idle_timeout);
1331 nfr->match_len = htons(match_len);
1332 nfr->packet_count = htonll(fr->packet_count);
1333 nfr->byte_count = htonll(fr->byte_count);
1341 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1342 * and returns the message.
1344 * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
1347 * If 'rw_packet' is nonnull, then it must contain the same data as
1348 * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
1349 * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
1350 * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
1351 * enough headroom to insert a "struct ofp_packet_in", this is more efficient
1352 * than ofputil_encode_packet_in() because it does not copy the packet
1355 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1356 struct ofpbuf *rw_packet)
1358 int total_len = pin->packet->size;
1359 struct ofp_packet_in *opi;
1362 if (pin->send_len < rw_packet->size) {
1363 rw_packet->size = pin->send_len;
1366 rw_packet = ofpbuf_clone_data_with_headroom(
1367 pin->packet->data, MIN(pin->send_len, pin->packet->size),
1368 offsetof(struct ofp_packet_in, data));
1371 /* Add OFPT_PACKET_IN. */
1372 opi = ofpbuf_push_zeros(rw_packet, offsetof(struct ofp_packet_in, data));
1373 opi->header.version = OFP_VERSION;
1374 opi->header.type = OFPT_PACKET_IN;
1375 opi->total_len = htons(total_len);
1376 opi->in_port = htons(pin->in_port);
1377 opi->reason = pin->reason;
1378 opi->buffer_id = htonl(pin->buffer_id);
1379 update_openflow_length(rw_packet);
1384 /* Returns a string representing the message type of 'type'. The string is the
1385 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1386 * messages, the constant is followed by "request" or "reply",
1387 * e.g. "OFPST_AGGREGATE reply". */
1389 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1394 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1395 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1396 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1399 * The caller is responsible for freeing '*bufferp' when it is no longer
1402 * The OpenFlow header length is initially set to 'openflow_len'; if the
1403 * message is later extended, the length should be updated with
1404 * update_openflow_length() before sending.
1406 * Returns the header. */
1408 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1410 *bufferp = ofpbuf_new(openflow_len);
1411 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1414 /* Similar to make_openflow() but creates a Nicira vendor extension message
1415 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1417 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1419 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1422 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1423 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1424 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1427 * The caller is responsible for freeing '*bufferp' when it is no longer
1430 * The OpenFlow header length is initially set to 'openflow_len'; if the
1431 * message is later extended, the length should be updated with
1432 * update_openflow_length() before sending.
1434 * Returns the header. */
1436 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1437 struct ofpbuf **bufferp)
1439 *bufferp = ofpbuf_new(openflow_len);
1440 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1443 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1444 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1446 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1447 struct ofpbuf **bufferp)
1449 *bufferp = ofpbuf_new(openflow_len);
1450 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1453 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1454 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1455 * beyond the header, if any, are zeroed.
1457 * The OpenFlow header length is initially set to 'openflow_len'; if the
1458 * message is later extended, the length should be updated with
1459 * update_openflow_length() before sending.
1461 * Returns the header. */
1463 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1465 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1468 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1469 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1470 * the header, if any, are zeroed.
1472 * The OpenFlow header length is initially set to 'openflow_len'; if the
1473 * message is later extended, the length should be updated with
1474 * update_openflow_length() before sending.
1476 * Returns the header. */
1478 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1479 struct ofpbuf *buffer)
1481 struct ofp_header *oh;
1483 assert(openflow_len >= sizeof *oh);
1484 assert(openflow_len <= UINT16_MAX);
1486 oh = ofpbuf_put_uninit(buffer, openflow_len);
1487 oh->version = OFP_VERSION;
1489 oh->length = htons(openflow_len);
1491 memset(oh + 1, 0, openflow_len - sizeof *oh);
1495 /* Similar to put_openflow() but append a Nicira vendor extension message with
1496 * the specific 'subtype'. 'subtype' should be in host byte order. */
1498 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1500 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1503 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1504 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1506 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1507 struct ofpbuf *buffer)
1509 struct nicira_header *nxh;
1511 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1512 nxh->vendor = htonl(NX_VENDOR_ID);
1513 nxh->subtype = htonl(subtype);
1517 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1518 * 'buffer->size'. */
1520 update_openflow_length(struct ofpbuf *buffer)
1522 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1523 oh->length = htons(buffer->size);
1526 /* Creates an ofp_stats_msg with the given 'type' and 'body_len' bytes of space
1527 * allocated for the 'body' member. Returns the first byte of the 'body'
1530 ofputil_make_stats_request(size_t body_len, uint16_t type,
1531 struct ofpbuf **bufferp)
1533 struct ofp_stats_msg *request;
1534 request = make_openflow(offsetof(struct ofp_stats_msg, body)
1535 + body_len, OFPT_STATS_REQUEST, bufferp);
1536 request->type = htons(type);
1537 request->flags = htons(0);
1541 /* Creates a stats request message with Nicira as vendor and the given
1542 * 'subtype', of total length 'openflow_len'. Returns the message. */
1544 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
1545 struct ofpbuf **bufferp)
1547 struct nicira_stats_msg *nsm;
1549 nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
1550 nsm->type = htons(OFPST_VENDOR);
1551 nsm->flags = htons(0);
1552 nsm->vendor = htonl(NX_VENDOR_ID);
1553 nsm->subtype = htonl(subtype);
1557 /* Returns the first byte of the body of the ofp_stats_msg in 'oh'. */
1559 ofputil_stats_body(const struct ofp_header *oh)
1561 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1562 return (const struct ofp_stats_msg *) oh + 1;
1565 /* Returns the length of the body of the ofp_stats_msg in 'oh'. */
1567 ofputil_stats_body_len(const struct ofp_header *oh)
1569 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1570 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
1573 /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
1575 ofputil_nxstats_body(const struct ofp_header *oh)
1577 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1578 return ((const struct nicira_stats_msg *) oh) + 1;
1581 /* Returns the length of the body of the nicira_stats_msg in 'oh'. */
1583 ofputil_nxstats_body_len(const struct ofp_header *oh)
1585 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1586 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1590 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1593 struct ofp_flow_mod *ofm;
1594 size_t size = sizeof *ofm + actions_len;
1595 struct ofpbuf *out = ofpbuf_new(size);
1596 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1597 ofm->header.version = OFP_VERSION;
1598 ofm->header.type = OFPT_FLOW_MOD;
1599 ofm->header.length = htons(size);
1601 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1602 ofputil_cls_rule_to_match(rule, &ofm->match);
1603 ofm->command = htons(command);
1608 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1609 uint16_t idle_timeout, size_t actions_len)
1611 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1612 struct ofp_flow_mod *ofm = out->data;
1613 ofm->idle_timeout = htons(idle_timeout);
1614 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1615 ofm->buffer_id = htonl(buffer_id);
1620 make_del_flow(const struct cls_rule *rule)
1622 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1623 struct ofp_flow_mod *ofm = out->data;
1624 ofm->out_port = htons(OFPP_NONE);
1629 make_add_simple_flow(const struct cls_rule *rule,
1630 uint32_t buffer_id, uint16_t out_port,
1631 uint16_t idle_timeout)
1633 if (out_port != OFPP_NONE) {
1634 struct ofp_action_output *oao;
1635 struct ofpbuf *buffer;
1637 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1638 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1639 oao->type = htons(OFPAT_OUTPUT);
1640 oao->len = htons(sizeof *oao);
1641 oao->port = htons(out_port);
1644 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1649 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1650 const struct ofpbuf *payload, int max_send_len)
1652 struct ofp_packet_in *opi;
1656 send_len = MIN(max_send_len, payload->size);
1657 buf = ofpbuf_new(sizeof *opi + send_len);
1658 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1659 OFPT_PACKET_IN, 0, buf);
1660 opi->buffer_id = htonl(buffer_id);
1661 opi->total_len = htons(payload->size);
1662 opi->in_port = htons(in_port);
1663 opi->reason = reason;
1664 ofpbuf_put(buf, payload->data, send_len);
1665 update_openflow_length(buf);
1671 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1673 const struct ofp_action_header *actions, size_t n_actions)
1675 size_t actions_len = n_actions * sizeof *actions;
1676 struct ofp_packet_out *opo;
1677 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1678 struct ofpbuf *out = ofpbuf_new(size);
1680 opo = ofpbuf_put_uninit(out, sizeof *opo);
1681 opo->header.version = OFP_VERSION;
1682 opo->header.type = OFPT_PACKET_OUT;
1683 opo->header.length = htons(size);
1684 opo->header.xid = htonl(0);
1685 opo->buffer_id = htonl(buffer_id);
1686 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1687 opo->actions_len = htons(actions_len);
1688 ofpbuf_put(out, actions, actions_len);
1690 ofpbuf_put(out, packet->data, packet->size);
1696 make_unbuffered_packet_out(const struct ofpbuf *packet,
1697 uint16_t in_port, uint16_t out_port)
1699 struct ofp_action_output action;
1700 action.type = htons(OFPAT_OUTPUT);
1701 action.len = htons(sizeof action);
1702 action.port = htons(out_port);
1703 return make_packet_out(packet, UINT32_MAX, in_port,
1704 (struct ofp_action_header *) &action, 1);
1708 make_buffered_packet_out(uint32_t buffer_id,
1709 uint16_t in_port, uint16_t out_port)
1711 if (out_port != OFPP_NONE) {
1712 struct ofp_action_output action;
1713 action.type = htons(OFPAT_OUTPUT);
1714 action.len = htons(sizeof action);
1715 action.port = htons(out_port);
1716 return make_packet_out(NULL, buffer_id, in_port,
1717 (struct ofp_action_header *) &action, 1);
1719 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1723 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1725 make_echo_request(void)
1727 struct ofp_header *rq;
1728 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1729 rq = ofpbuf_put_uninit(out, sizeof *rq);
1730 rq->version = OFP_VERSION;
1731 rq->type = OFPT_ECHO_REQUEST;
1732 rq->length = htons(sizeof *rq);
1737 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1738 * OFPT_ECHO_REQUEST message in 'rq'. */
1740 make_echo_reply(const struct ofp_header *rq)
1742 size_t size = ntohs(rq->length);
1743 struct ofpbuf *out = ofpbuf_new(size);
1744 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1745 reply->type = OFPT_ECHO_REPLY;
1750 check_action_exact_len(const union ofp_action *a, unsigned int len,
1751 unsigned int required_len)
1753 if (len != required_len) {
1754 VLOG_WARN_RL(&bad_ofmsg_rl, "action %"PRIu16" has invalid length "
1755 "%"PRIu16" (must be %u)\n",
1756 ntohs(a->type), ntohs(a->header.len), required_len);
1757 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1763 check_nx_action_exact_len(const struct nx_action_header *a,
1764 unsigned int len, unsigned int required_len)
1766 if (len != required_len) {
1767 VLOG_WARN_RL(&bad_ofmsg_rl,
1768 "Nicira action %"PRIu16" has invalid length %"PRIu16" "
1770 ntohs(a->subtype), ntohs(a->len), required_len);
1771 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1776 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1777 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1778 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1780 check_output_port(uint16_t port, int max_ports)
1788 case OFPP_CONTROLLER:
1793 if (port < max_ports) {
1796 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1797 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1801 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1802 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
1803 * otherwise an ofp_mkerr() return code. */
1805 check_enqueue_action(const union ofp_action *a, unsigned int len,
1808 const struct ofp_action_enqueue *oae;
1812 error = check_action_exact_len(a, len, 16);
1817 oae = (const struct ofp_action_enqueue *) a;
1818 port = ntohs(oae->port);
1819 if (port < max_ports || port == OFPP_IN_PORT) {
1822 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1823 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1827 check_nicira_action(const union ofp_action *a, unsigned int len,
1828 const struct flow *flow)
1830 const struct nx_action_header *nah;
1835 VLOG_WARN_RL(&bad_ofmsg_rl,
1836 "Nicira vendor action only %u bytes", len);
1837 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1839 nah = (const struct nx_action_header *) a;
1841 subtype = ntohs(nah->subtype);
1842 if (subtype > TYPE_MAXIMUM(enum nx_action_subtype)) {
1843 /* This is necessary because enum nx_action_subtype may be an
1844 * 8-bit type, so the cast below throws away the top 8 bits. */
1845 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1848 switch ((enum nx_action_subtype) subtype) {
1849 case NXAST_RESUBMIT:
1850 case NXAST_SET_TUNNEL:
1851 case NXAST_SET_QUEUE:
1852 case NXAST_POP_QUEUE:
1853 return check_nx_action_exact_len(nah, len, 16);
1855 case NXAST_REG_MOVE:
1856 error = check_nx_action_exact_len(nah, len,
1857 sizeof(struct nx_action_reg_move));
1861 return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1863 case NXAST_REG_LOAD:
1864 error = check_nx_action_exact_len(nah, len,
1865 sizeof(struct nx_action_reg_load));
1869 return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1874 case NXAST_SET_TUNNEL64:
1875 return check_nx_action_exact_len(
1876 nah, len, sizeof(struct nx_action_set_tunnel64));
1878 case NXAST_MULTIPATH:
1879 error = check_nx_action_exact_len(
1880 nah, len, sizeof(struct nx_action_multipath));
1884 return multipath_check((const struct nx_action_multipath *) a);
1886 case NXAST_AUTOPATH:
1887 error = check_nx_action_exact_len(
1888 nah, len, sizeof(struct nx_action_autopath));
1892 return autopath_check((const struct nx_action_autopath *) a);
1894 case NXAST_SNAT__OBSOLETE:
1895 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
1897 VLOG_WARN_RL(&bad_ofmsg_rl,
1898 "unknown Nicira vendor action subtype %d", subtype);
1899 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1904 check_action(const union ofp_action *a, unsigned int len,
1905 const struct flow *flow, int max_ports)
1907 enum ofp_action_type type = ntohs(a->type);
1912 error = check_action_exact_len(a, len, 8);
1916 return check_output_port(ntohs(a->output.port), max_ports);
1918 case OFPAT_SET_VLAN_VID:
1919 error = check_action_exact_len(a, len, 8);
1923 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1924 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1928 case OFPAT_SET_VLAN_PCP:
1929 error = check_action_exact_len(a, len, 8);
1933 if (a->vlan_pcp.vlan_pcp & ~7) {
1934 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1938 case OFPAT_STRIP_VLAN:
1939 case OFPAT_SET_NW_SRC:
1940 case OFPAT_SET_NW_DST:
1941 case OFPAT_SET_NW_TOS:
1942 case OFPAT_SET_TP_SRC:
1943 case OFPAT_SET_TP_DST:
1944 return check_action_exact_len(a, len, 8);
1946 case OFPAT_SET_DL_SRC:
1947 case OFPAT_SET_DL_DST:
1948 return check_action_exact_len(a, len, 16);
1951 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
1952 ? check_nicira_action(a, len, flow)
1953 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
1956 return check_enqueue_action(a, len, max_ports);
1959 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %d", (int) type);
1960 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
1965 validate_actions(const union ofp_action *actions, size_t n_actions,
1966 const struct flow *flow, int max_ports)
1970 for (i = 0; i < n_actions; ) {
1971 const union ofp_action *a = &actions[i];
1972 unsigned int len = ntohs(a->header.len);
1973 unsigned int n_slots = len / OFP_ACTION_ALIGN;
1974 unsigned int slots_left = &actions[n_actions] - a;
1977 if (n_slots > slots_left) {
1978 VLOG_WARN_RL(&bad_ofmsg_rl,
1979 "action requires %u slots but only %u remain",
1980 n_slots, slots_left);
1981 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1983 VLOG_WARN_RL(&bad_ofmsg_rl, "action has invalid length 0");
1984 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1985 } else if (len % OFP_ACTION_ALIGN) {
1986 VLOG_WARN_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
1987 "of %d", len, OFP_ACTION_ALIGN);
1988 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1991 error = check_action(a, len, flow, max_ports);
2000 /* Returns true if 'action' outputs to 'port', false otherwise. */
2002 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2004 switch (ntohs(action->type)) {
2006 return action->output.port == port;
2008 return ((const struct ofp_action_enqueue *) action)->port == port;
2014 /* The set of actions must either come from a trusted source or have been
2015 * previously validated with validate_actions(). */
2016 const union ofp_action *
2017 actions_first(struct actions_iterator *iter,
2018 const union ofp_action *oa, size_t n_actions)
2021 iter->end = oa + n_actions;
2022 return actions_next(iter);
2025 const union ofp_action *
2026 actions_next(struct actions_iterator *iter)
2028 if (iter->pos != iter->end) {
2029 const union ofp_action *a = iter->pos;
2030 unsigned int len = ntohs(a->header.len);
2031 iter->pos += len / OFP_ACTION_ALIGN;
2038 /* "Normalizes" the wildcards in 'rule'. That means:
2040 * 1. If the type of level N is known, then only the valid fields for that
2041 * level may be specified. For example, ARP does not have a TOS field,
2042 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2043 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2044 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2047 * 2. If the type of level N is not known (or not understood by Open
2048 * vSwitch), then no fields at all for that level may be specified. For
2049 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2050 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2053 * 'flow_format' specifies the format of the flow as received or as intended to
2054 * be sent. This is important for IPv6 and ARP, for which NXM supports more
2055 * detailed matching. */
2057 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2060 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
2061 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
2062 MAY_NW_PROTO = 1 << 2, /* nw_proto */
2063 MAY_NW_TOS = 1 << 3, /* nw_tos */
2064 MAY_ARP_SHA = 1 << 4, /* arp_sha */
2065 MAY_ARP_THA = 1 << 5, /* arp_tha */
2066 MAY_IPV6_ADDR = 1 << 6, /* ipv6_src, ipv6_dst */
2067 MAY_ND_TARGET = 1 << 7 /* nd_target */
2070 struct flow_wildcards wc;
2072 /* Figure out what fields may be matched. */
2073 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2074 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_NW_ADDR;
2075 if (rule->flow.nw_proto == IPPROTO_TCP ||
2076 rule->flow.nw_proto == IPPROTO_UDP ||
2077 rule->flow.nw_proto == IPPROTO_ICMP) {
2078 may_match |= MAY_TP_ADDR;
2080 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2081 && flow_format == NXFF_NXM) {
2082 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_IPV6_ADDR;
2083 if (rule->flow.nw_proto == IPPROTO_TCP ||
2084 rule->flow.nw_proto == IPPROTO_UDP) {
2085 may_match |= MAY_TP_ADDR;
2086 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2087 may_match |= MAY_TP_ADDR;
2088 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2089 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2090 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2091 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2094 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2095 may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2096 if (flow_format == NXFF_NXM) {
2097 may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2103 /* Clear the fields that may not be matched. */
2105 if (!(may_match & MAY_NW_ADDR)) {
2106 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2108 if (!(may_match & MAY_TP_ADDR)) {
2109 wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2111 if (!(may_match & MAY_NW_PROTO)) {
2112 wc.wildcards |= FWW_NW_PROTO;
2114 if (!(may_match & MAY_NW_TOS)) {
2115 wc.wildcards |= FWW_NW_TOS;
2117 if (!(may_match & MAY_ARP_SHA)) {
2118 wc.wildcards |= FWW_ARP_SHA;
2120 if (!(may_match & MAY_ARP_THA)) {
2121 wc.wildcards |= FWW_ARP_THA;
2123 if (!(may_match & MAY_IPV6_ADDR)) {
2124 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2126 if (!(may_match & MAY_ND_TARGET)) {
2127 wc.wildcards |= FWW_ND_TARGET;
2130 /* Log any changes. */
2131 if (!flow_wildcards_equal(&wc, &rule->wc)) {
2132 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2133 char *pre = log ? cls_rule_to_string(rule) : NULL;
2136 cls_rule_zero_wildcarded_fields(rule);
2139 char *post = cls_rule_to_string(rule);
2140 VLOG_INFO("normalization changed ofp_match, details:");
2141 VLOG_INFO(" pre: %s", pre);
2142 VLOG_INFO("post: %s", post);
2150 vendor_code_to_id(uint8_t code)
2153 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2155 #undef OFPUTIL_VENDOR
2162 vendor_id_to_code(uint32_t id)
2165 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2167 #undef OFPUTIL_VENDOR
2173 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2174 * information taken from 'error', whose encoding must be as described in the
2175 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
2176 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2179 * Returns NULL if 'error' is not an OpenFlow error code. */
2181 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2183 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2193 if (!is_ofp_error(error)) {
2194 /* We format 'error' with strerror() here since it seems likely to be
2195 * a system errno value. */
2196 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2197 error, strerror(error));
2204 len = ntohs(oh->length);
2214 vendor = get_ofp_err_vendor(error);
2215 type = get_ofp_err_type(error);
2216 code = get_ofp_err_code(error);
2217 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2218 struct ofp_error_msg *oem;
2220 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2221 oem->type = htons(type);
2222 oem->code = htons(code);
2224 struct ofp_error_msg *oem;
2225 struct nx_vendor_error *nve;
2228 vendor_id = vendor_code_to_id(vendor);
2229 if (vendor_id == UINT32_MAX) {
2230 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2235 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2236 OFPT_ERROR, xid, &buf);
2237 oem->type = htons(NXET_VENDOR);
2238 oem->code = htons(NXVC_VENDOR_ERROR);
2240 nve = (struct nx_vendor_error *)oem->data;
2241 nve->vendor = htonl(vendor_id);
2242 nve->type = htons(type);
2243 nve->code = htons(code);
2248 ofpbuf_put(buf, data, len);
2254 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2255 * Open vSwitch internal error code in the format described in the large
2256 * comment in ofp-util.h.
2258 * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2259 * to the payload starting from 'oh' and on failure it is set to 0. */
2261 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2263 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2265 const struct ofp_error_msg *oem;
2266 uint16_t type, code;
2273 if (oh->type != OFPT_ERROR) {
2277 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2278 oem = ofpbuf_try_pull(&b, sizeof *oem);
2283 type = ntohs(oem->type);
2284 code = ntohs(oem->code);
2285 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2286 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2291 vendor = vendor_id_to_code(ntohl(nve->vendor));
2293 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2294 ntohl(nve->vendor));
2297 type = ntohs(nve->type);
2298 code = ntohs(nve->code);
2300 vendor = OFPUTIL_VENDOR_OPENFLOW;
2304 VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2305 "supported maximum value 1023", type);
2310 *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2312 return ofp_mkerr_vendor(vendor, type, code);
2316 ofputil_format_error(struct ds *s, int error)
2318 if (is_errno(error)) {
2319 ds_put_cstr(s, strerror(error));
2321 uint16_t type = get_ofp_err_type(error);
2322 uint16_t code = get_ofp_err_code(error);
2323 const char *type_s = ofp_error_type_to_string(type);
2324 const char *code_s = ofp_error_code_to_string(type, code);
2326 ds_put_format(s, "type ");
2328 ds_put_cstr(s, type_s);
2330 ds_put_format(s, "%"PRIu16, type);
2333 ds_put_cstr(s, ", code ");
2335 ds_put_cstr(s, code_s);
2337 ds_put_format(s, "%"PRIu16, code);
2343 ofputil_error_to_string(int error)
2345 struct ds s = DS_EMPTY_INITIALIZER;
2346 ofputil_format_error(&s, error);
2347 return ds_steal_cstr(&s);
2350 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2351 * successful, otherwise an OpenFlow error.
2353 * If successful, the first action is stored in '*actionsp' and the number of
2354 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2355 * are stored, respectively.
2357 * This function does not check that the actions are valid (the caller should
2358 * do so, with validate_actions()). The caller is also responsible for making
2359 * sure that 'b->data' is initially aligned appropriately for "union
2362 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2363 union ofp_action **actionsp, size_t *n_actionsp)
2365 if (actions_len % OFP_ACTION_ALIGN != 0) {
2366 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2367 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2371 *actionsp = ofpbuf_try_pull(b, actions_len);
2372 if (*actionsp == NULL) {
2373 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2374 "exceeds remaining message length (%zu)",
2375 actions_len, b->size);
2379 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2385 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);