2 * Copyright (c) 2008, 2009, 2010 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 "byte-order.h"
22 #include "classifier.h"
30 VLOG_DEFINE_THIS_MODULE(ofp_util);
32 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
33 * in the peer and so there's not much point in showing a lot of them. */
34 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
36 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
37 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
40 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
41 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
42 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
43 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
46 ofputil_wcbits_to_netmask(int wcbits)
49 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
52 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
53 * that it wildcards. 'netmask' must be a CIDR netmask (see ip_is_cidr()). */
55 ofputil_netmask_to_wcbits(ovs_be32 netmask)
57 assert(ip_is_cidr(netmask));
59 return netmask == htonl(0) ? 32 : __builtin_ctz(ntohl(netmask));
63 for (wcbits = 32; netmask; wcbits--) {
64 netmask &= netmask - 1;
71 /* A list of the FWW_* and OFPFW_ bits that have the same value, meaning, and
73 #define WC_INVARIANT_LIST \
74 WC_INVARIANT_BIT(IN_PORT) \
75 WC_INVARIANT_BIT(DL_SRC) \
76 WC_INVARIANT_BIT(DL_DST) \
77 WC_INVARIANT_BIT(DL_TYPE) \
78 WC_INVARIANT_BIT(NW_PROTO) \
79 WC_INVARIANT_BIT(TP_SRC) \
80 WC_INVARIANT_BIT(TP_DST)
82 /* Verify that all of the invariant bits (as defined on WC_INVARIANT_LIST)
83 * actually have the same names and values. */
84 #define WC_INVARIANT_BIT(NAME) BUILD_ASSERT_DECL(FWW_##NAME == OFPFW_##NAME);
86 #undef WC_INVARIANT_BIT
88 /* WC_INVARIANTS is the invariant bits (as defined on WC_INVARIANT_LIST) all
92 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
94 #undef WC_INVARIANT_BIT
97 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
100 * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. In
101 * the latter case only, 'flow''s tun_id field will be taken from the high bits
102 * of 'cookie', if 'match''s wildcards do not indicate that tun_id is
105 ofputil_cls_rule_from_match(const struct ofp_match *match,
106 unsigned int priority,
107 enum nx_flow_format flow_format,
108 uint64_t cookie, struct cls_rule *rule)
110 struct flow_wildcards *wc = &rule->wc;
114 /* Initialize rule->priority. */
115 ofpfw = ntohl(match->wildcards);
116 ofpfw &= flow_format == NXFF_TUN_ID_FROM_COOKIE ? OVSFW_ALL : OFPFW_ALL;
117 rule->priority = !ofpfw ? UINT16_MAX : priority;
119 /* Initialize most of rule->wc. */
120 flow_wildcards_init_catchall(wc);
121 wc->wildcards = ofpfw & WC_INVARIANTS;
122 if (ofpfw & OFPFW_NW_TOS) {
123 wc->wildcards |= FWW_NW_TOS;
125 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
126 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
128 if (flow_format == NXFF_TUN_ID_FROM_COOKIE && !(ofpfw & NXFW_TUN_ID)) {
129 rule->flow.tun_id = htonl(ntohll(cookie) >> 32);
131 wc->wildcards |= FWW_TUN_ID;
132 rule->flow.tun_id = 0;
135 if (ofpfw & OFPFW_DL_DST) {
136 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
137 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
138 * and FWW_ETH_MCAST. */
139 wc->wildcards |= FWW_ETH_MCAST;
142 /* Initialize most of rule->flow. */
143 rule->flow.nw_src = match->nw_src;
144 rule->flow.nw_dst = match->nw_dst;
145 rule->flow.in_port = (match->in_port == htons(OFPP_LOCAL) ? ODPP_LOCAL
146 : ntohs(match->in_port));
147 rule->flow.dl_type = match->dl_type;
148 rule->flow.tp_src = match->tp_src;
149 rule->flow.tp_dst = match->tp_dst;
150 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
151 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
152 rule->flow.nw_tos = match->nw_tos;
153 rule->flow.nw_proto = match->nw_proto;
155 /* Translate VLANs. */
156 vid = match->dl_vlan & htons(VLAN_VID_MASK);
157 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
158 switch (ofpfw & (OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP)) {
159 case OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP:
160 /* Wildcard everything. */
161 rule->flow.vlan_tci = htons(0);
162 rule->wc.vlan_tci_mask = htons(0);
165 case OFPFW_DL_VLAN_PCP:
166 if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
167 /* Match only packets without 802.1Q header. */
168 rule->flow.vlan_tci = htons(0);
169 rule->wc.vlan_tci_mask = htons(0xffff);
171 /* Wildcard PCP, specific VID. */
172 rule->flow.vlan_tci = vid | htons(VLAN_CFI);
173 rule->wc.vlan_tci_mask = htons(VLAN_VID_MASK | VLAN_CFI);
178 /* Wildcard VID, specific PCP. */
179 rule->flow.vlan_tci = pcp | htons(VLAN_CFI);
180 rule->wc.vlan_tci_mask = htons(VLAN_PCP_MASK | VLAN_CFI);
184 if (match->dl_vlan == htons(OFP_VLAN_NONE)) {
185 /* This case is odd, since we can't have a specific PCP without an
186 * 802.1Q header. However, older versions of OVS treated this as
187 * matching packets withut an 802.1Q header, so we do here too. */
188 rule->flow.vlan_tci = htons(0);
189 rule->wc.vlan_tci_mask = htons(0xffff);
191 /* Specific VID and PCP. */
192 rule->flow.vlan_tci = vid | pcp | htons(VLAN_CFI);
193 rule->wc.vlan_tci_mask = htons(0xffff);
199 cls_rule_zero_wildcarded_fields(rule);
202 /* Extract 'flow' with 'wildcards' into the OpenFlow match structure
205 * 'flow_format' must either NXFF_OPENFLOW10 or NXFF_TUN_ID_FROM_COOKIE. In
206 * the latter case only, 'match''s NXFW_TUN_ID bit will be filled in; otherwise
207 * it is always set to 0. */
209 ofputil_cls_rule_to_match(const struct cls_rule *rule,
210 enum nx_flow_format flow_format,
211 struct ofp_match *match)
213 const struct flow_wildcards *wc = &rule->wc;
216 /* Figure out most OpenFlow wildcards. */
217 ofpfw = wc->wildcards & WC_INVARIANTS;
218 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
219 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
220 if (wc->wildcards & FWW_NW_TOS) {
221 ofpfw |= OFPFW_NW_TOS;
223 if (flow_format == NXFF_TUN_ID_FROM_COOKIE && wc->wildcards & FWW_TUN_ID) {
224 ofpfw |= NXFW_TUN_ID;
227 /* Translate VLANs. */
228 match->dl_vlan = htons(0);
229 match->dl_vlan_pcp = 0;
230 if (rule->wc.vlan_tci_mask == htons(0)) {
231 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
232 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
233 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
234 match->dl_vlan = htons(OFP_VLAN_NONE);
236 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
237 ofpfw |= OFPFW_DL_VLAN;
239 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
242 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
243 ofpfw |= OFPFW_DL_VLAN_PCP;
245 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
249 /* Compose most of the match structure. */
250 match->wildcards = htonl(ofpfw);
251 match->in_port = htons(rule->flow.in_port == ODPP_LOCAL ? OFPP_LOCAL
252 : rule->flow.in_port);
253 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
254 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
255 match->dl_type = rule->flow.dl_type;
256 match->nw_src = rule->flow.nw_src;
257 match->nw_dst = rule->flow.nw_dst;
258 match->nw_tos = rule->flow.nw_tos;
259 match->nw_proto = rule->flow.nw_proto;
260 match->tp_src = rule->flow.tp_src;
261 match->tp_dst = rule->flow.tp_dst;
262 memset(match->pad1, '\0', sizeof match->pad1);
263 memset(match->pad2, '\0', sizeof match->pad2);
266 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
270 static uint32_t next_xid = 1;
271 return htonl(next_xid++);
274 /* Basic parsing of OpenFlow messages. */
276 struct ofputil_msg_type {
277 enum ofputil_msg_code code; /* OFPUTIL_*. */
278 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
279 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
280 unsigned int min_size; /* Minimum total message size in bytes. */
281 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
282 * the message may exceed 'min_size' by an even multiple of this value. */
283 unsigned int extra_multiple;
286 struct ofputil_msg_category {
287 const char *name; /* e.g. "OpenFlow message" */
288 const struct ofputil_msg_type *types;
290 int missing_error; /* ofp_mkerr() value for missing type. */
294 ofputil_length_ok(const struct ofputil_msg_category *cat,
295 const struct ofputil_msg_type *type,
298 switch (type->extra_multiple) {
300 if (size != type->min_size) {
301 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
302 "length %u (expected length %u)",
303 cat->name, type->name, size, type->min_size);
309 if (size < type->min_size) {
310 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
311 "length %u (expected length at least %u bytes)",
312 cat->name, type->name, size, type->min_size);
318 if (size < type->min_size
319 || (size - type->min_size) % type->extra_multiple) {
320 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
321 "length %u (must be exactly %u bytes or longer "
322 "by an integer multiple of %u bytes)",
323 cat->name, type->name, size,
324 type->min_size, type->extra_multiple);
332 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
333 uint32_t value, unsigned int size,
334 const struct ofputil_msg_type **typep)
336 const struct ofputil_msg_type *type;
338 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
339 if (type->value == value) {
340 if (!ofputil_length_ok(cat, type, size)) {
341 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
348 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %u",
350 return cat->missing_error;
354 ofputil_decode_vendor(const struct ofp_header *oh,
355 const struct ofputil_msg_type **typep)
357 static const struct ofputil_msg_type nxt_messages[] = {
358 { OFPUTIL_NXT_STATUS_REQUEST,
359 NXT_STATUS_REQUEST, "NXT_STATUS_REQUEST",
360 sizeof(struct nicira_header), 1 },
362 { OFPUTIL_NXT_STATUS_REPLY,
363 NXT_STATUS_REPLY, "NXT_STATUS_REPLY",
364 sizeof(struct nicira_header), 1 },
366 { OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
367 NXT_TUN_ID_FROM_COOKIE, "NXT_TUN_ID_FROM_COOKIE",
368 sizeof(struct nxt_tun_id_cookie), 0 },
370 { OFPUTIL_NXT_ROLE_REQUEST,
371 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
372 sizeof(struct nx_role_request), 0 },
374 { OFPUTIL_NXT_ROLE_REPLY,
375 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
376 sizeof(struct nx_role_request), 0 },
378 { OFPUTIL_NXT_SET_FLOW_FORMAT,
379 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
380 sizeof(struct nxt_set_flow_format), 0 },
382 { OFPUTIL_NXT_FLOW_MOD,
383 NXT_FLOW_MOD, "NXT_FLOW_MOD",
384 sizeof(struct nx_flow_mod), 8 },
386 { OFPUTIL_NXT_FLOW_REMOVED,
387 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
388 sizeof(struct nx_flow_removed), 8 },
391 static const struct ofputil_msg_category nxt_category = {
392 "Nicira extension message",
393 nxt_messages, ARRAY_SIZE(nxt_messages),
394 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
397 const struct ofp_vendor_header *ovh;
398 const struct nicira_header *nh;
400 ovh = (const struct ofp_vendor_header *) oh;
401 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
402 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
403 "vendor %"PRIx32, ntohl(ovh->vendor));
404 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
407 if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
408 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
409 "length %u (expected at least %zu)",
410 ntohs(ovh->header.length), sizeof(struct nicira_header));
411 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
414 nh = (const struct nicira_header *) oh;
415 return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
416 ntohs(oh->length), typep);
420 check_nxstats_msg(const struct ofp_header *oh)
422 const struct ofp_stats_request *osr;
425 osr = (const struct ofp_stats_request *) oh;
427 memcpy(&vendor, osr->body, sizeof vendor);
428 if (vendor != htonl(NX_VENDOR_ID)) {
429 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
430 "unknown vendor %"PRIx32, ntohl(vendor));
431 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
434 if (ntohs(osr->header.length) < sizeof(struct nicira_stats_msg)) {
435 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
436 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
443 ofputil_decode_nxst_request(const struct ofp_header *oh,
444 const struct ofputil_msg_type **typep)
446 static const struct ofputil_msg_type nxst_requests[] = {
447 { OFPUTIL_NXST_FLOW_REQUEST,
448 NXST_FLOW, "NXST_FLOW request",
449 sizeof(struct nx_flow_stats_request), 8 },
451 { OFPUTIL_NXST_AGGREGATE_REQUEST,
452 NXST_AGGREGATE, "NXST_AGGREGATE request",
453 sizeof(struct nx_aggregate_stats_request), 8 },
456 static const struct ofputil_msg_category nxst_request_category = {
457 "Nicira extension statistics",
458 nxst_requests, ARRAY_SIZE(nxst_requests),
459 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
462 const struct nicira_stats_msg *nsm;
465 error = check_nxstats_msg(oh);
470 nsm = (struct nicira_stats_msg *) oh;
471 return ofputil_lookup_openflow_message(&nxst_request_category,
473 ntohs(oh->length), typep);
477 ofputil_decode_nxst_reply(const struct ofp_header *oh,
478 const struct ofputil_msg_type **typep)
480 static const struct ofputil_msg_type nxst_replies[] = {
481 { OFPUTIL_NXST_FLOW_REPLY,
482 NXST_FLOW, "NXST_FLOW reply",
483 sizeof(struct nicira_stats_msg), 8 },
485 { OFPUTIL_NXST_AGGREGATE_REPLY,
486 NXST_AGGREGATE, "NXST_AGGREGATE reply",
487 sizeof(struct nx_aggregate_stats_reply), 0 },
490 static const struct ofputil_msg_category nxst_reply_category = {
491 "Nicira extension statistics",
492 nxst_replies, ARRAY_SIZE(nxst_replies),
493 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
496 const struct nicira_stats_msg *nsm;
499 error = check_nxstats_msg(oh);
504 nsm = (struct nicira_stats_msg *) oh;
505 return ofputil_lookup_openflow_message(&nxst_reply_category,
507 ntohs(oh->length), typep);
511 ofputil_decode_ofpst_request(const struct ofp_header *oh,
512 const struct ofputil_msg_type **typep)
514 enum { OSR_SIZE = sizeof(struct ofp_stats_request) };
515 static const struct ofputil_msg_type ofpst_requests[] = {
516 { OFPUTIL_OFPST_DESC_REQUEST,
517 OFPST_DESC, "OFPST_DESC request",
520 { OFPUTIL_OFPST_FLOW_REQUEST,
521 OFPST_FLOW, "OFPST_FLOW request",
522 OSR_SIZE + sizeof(struct ofp_flow_stats_request), 0 },
524 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
525 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
526 OSR_SIZE + sizeof(struct ofp_aggregate_stats_request), 0 },
528 { OFPUTIL_OFPST_TABLE_REQUEST,
529 OFPST_TABLE, "OFPST_TABLE request",
532 { OFPUTIL_OFPST_PORT_REQUEST,
533 OFPST_PORT, "OFPST_PORT request",
534 OSR_SIZE + sizeof(struct ofp_port_stats_request), 0 },
536 { OFPUTIL_OFPST_QUEUE_REQUEST,
537 OFPST_QUEUE, "OFPST_QUEUE request",
538 OSR_SIZE + sizeof(struct ofp_queue_stats_request), 0 },
541 OFPST_VENDOR, "OFPST_VENDOR request",
542 OSR_SIZE + sizeof(uint32_t), 1 },
545 static const struct ofputil_msg_category ofpst_request_category = {
546 "OpenFlow statistics",
547 ofpst_requests, ARRAY_SIZE(ofpst_requests),
548 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
551 const struct ofp_stats_request *osr;
554 osr = (const struct ofp_stats_request *) oh;
555 error = ofputil_lookup_openflow_message(&ofpst_request_category,
557 ntohs(oh->length), typep);
558 if (!error && osr->type == htons(OFPST_VENDOR)) {
559 error = ofputil_decode_nxst_request(oh, typep);
565 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
566 const struct ofputil_msg_type **typep)
568 enum { OSR_SIZE = sizeof(struct ofp_stats_reply) };
569 static const struct ofputil_msg_type ofpst_replies[] = {
570 { OFPUTIL_OFPST_DESC_REPLY,
571 OFPST_DESC, "OFPST_DESC reply",
572 OSR_SIZE + sizeof(struct ofp_desc_stats), 0 },
574 { OFPUTIL_OFPST_FLOW_REPLY,
575 OFPST_FLOW, "OFPST_FLOW reply",
578 { OFPUTIL_OFPST_AGGREGATE_REPLY,
579 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
580 OSR_SIZE + sizeof(struct ofp_aggregate_stats_reply), 0 },
582 { OFPUTIL_OFPST_TABLE_REPLY,
583 OFPST_TABLE, "OFPST_TABLE reply",
584 OSR_SIZE, sizeof(struct ofp_table_stats) },
586 { OFPUTIL_OFPST_PORT_REPLY,
587 OFPST_PORT, "OFPST_PORT reply",
588 OSR_SIZE, sizeof(struct ofp_port_stats) },
590 { OFPUTIL_OFPST_QUEUE_REPLY,
591 OFPST_QUEUE, "OFPST_QUEUE reply",
592 OSR_SIZE, sizeof(struct ofp_queue_stats) },
595 OFPST_VENDOR, "OFPST_VENDOR reply",
596 OSR_SIZE + sizeof(uint32_t), 1 },
599 static const struct ofputil_msg_category ofpst_reply_category = {
600 "OpenFlow statistics",
601 ofpst_replies, ARRAY_SIZE(ofpst_replies),
602 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
605 const struct ofp_stats_reply *osr = (const struct ofp_stats_reply *) oh;
608 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
610 ntohs(oh->length), typep);
611 if (!error && osr->type == htons(OFPST_VENDOR)) {
612 error = ofputil_decode_nxst_reply(oh, typep);
617 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
618 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
619 * way, stores in '*typep' a type structure that can be inspected with the
620 * ofputil_msg_type_*() functions.
622 * oh->length must indicate the correct length of the message (and must be at
623 * least sizeof(struct ofp_header)).
625 * Success indicates that 'oh' is at least as long as the minimum-length
626 * message of its type. */
628 ofputil_decode_msg_type(const struct ofp_header *oh,
629 const struct ofputil_msg_type **typep)
631 static const struct ofputil_msg_type ofpt_messages[] = {
632 { OFPUTIL_OFPT_HELLO,
633 OFPT_HELLO, "OFPT_HELLO",
634 sizeof(struct ofp_hello), 1 },
636 { OFPUTIL_OFPT_ERROR,
637 OFPT_ERROR, "OFPT_ERROR",
638 sizeof(struct ofp_error_msg), 1 },
640 { OFPUTIL_OFPT_ECHO_REQUEST,
641 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
642 sizeof(struct ofp_header), 1 },
644 { OFPUTIL_OFPT_ECHO_REPLY,
645 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
646 sizeof(struct ofp_header), 1 },
648 { OFPUTIL_OFPT_FEATURES_REQUEST,
649 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
650 sizeof(struct ofp_header), 0 },
652 { OFPUTIL_OFPT_FEATURES_REPLY,
653 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
654 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
656 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
657 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
658 sizeof(struct ofp_header), 0 },
660 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
661 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
662 sizeof(struct ofp_switch_config), 0 },
664 { OFPUTIL_OFPT_SET_CONFIG,
665 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
666 sizeof(struct ofp_switch_config), 0 },
668 { OFPUTIL_OFPT_PACKET_IN,
669 OFPT_PACKET_IN, "OFPT_PACKET_IN",
670 offsetof(struct ofp_packet_in, data), 1 },
672 { OFPUTIL_OFPT_FLOW_REMOVED,
673 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
674 sizeof(struct ofp_flow_removed), 0 },
676 { OFPUTIL_OFPT_PORT_STATUS,
677 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
678 sizeof(struct ofp_port_status), 0 },
680 { OFPUTIL_OFPT_PACKET_OUT,
681 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
682 sizeof(struct ofp_packet_out), 1 },
684 { OFPUTIL_OFPT_FLOW_MOD,
685 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
686 sizeof(struct ofp_flow_mod), 1 },
688 { OFPUTIL_OFPT_PORT_MOD,
689 OFPT_PORT_MOD, "OFPT_PORT_MOD",
690 sizeof(struct ofp_port_mod), 0 },
693 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
694 sizeof(struct ofp_stats_request), 1 },
697 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
698 sizeof(struct ofp_stats_reply), 1 },
700 { OFPUTIL_OFPT_BARRIER_REQUEST,
701 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
702 sizeof(struct ofp_header), 0 },
704 { OFPUTIL_OFPT_BARRIER_REPLY,
705 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
706 sizeof(struct ofp_header), 0 },
709 OFPT_VENDOR, "OFPT_VENDOR",
710 sizeof(struct ofp_vendor_header), 1 },
713 static const struct ofputil_msg_category ofpt_category = {
715 ofpt_messages, ARRAY_SIZE(ofpt_messages),
716 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
721 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
722 ntohs(oh->length), typep);
726 error = ofputil_decode_vendor(oh, typep);
729 case OFPT_STATS_REQUEST:
730 error = ofputil_decode_ofpst_request(oh, typep);
733 case OFPT_STATS_REPLY:
734 error = ofputil_decode_ofpst_reply(oh, typep);
741 static const struct ofputil_msg_type ofputil_invalid_type = {
743 0, "OFPUTIL_INVALID",
747 *typep = &ofputil_invalid_type;
752 /* Returns an OFPUTIL_* message type code for 'type'. */
753 enum ofputil_msg_code
754 ofputil_msg_type_code(const struct ofputil_msg_type *type)
762 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
764 switch (flow_format) {
765 case NXFF_OPENFLOW10:
766 case NXFF_TUN_ID_FROM_COOKIE:
775 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
777 switch (flow_format) {
778 case NXFF_OPENFLOW10:
780 case NXFF_TUN_ID_FROM_COOKIE:
781 return "tun_id_from_cookie";
790 ofputil_flow_format_from_string(const char *s)
792 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
793 : !strcmp(s, "tun_id_from_cookie") ? NXFF_TUN_ID_FROM_COOKIE
794 : !strcmp(s, "nxm") ? NXFF_NXM
799 regs_fully_wildcarded(const struct flow_wildcards *wc)
803 for (i = 0; i < FLOW_N_REGS; i++) {
804 if (wc->reg_masks[i] != 0) {
811 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
812 * (e.g. to add or remove a flow). 'cookie_support' should be true if the
813 * command to be sent includes a flow cookie (as OFPT_FLOW_MOD does, for
814 * example) or false if the command does not (OFPST_FLOW and OFPST_AGGREGATE do
815 * not, for example). If 'cookie_support' is true, then 'cookie' should be the
816 * cookie to be sent; otherwise its value is ignored.
818 * The "best" flow format is chosen on this basis:
820 * - It must be capable of expressing the rule. NXFF_OPENFLOW10 flows can't
821 * handle tunnel IDs. NXFF_TUN_ID_FROM_COOKIE flows can't handle registers
822 * or fixing the Ethernet multicast bit, and can't handle tunnel IDs that
823 * conflict with the high 32 bits of the cookie or commands that don't
826 * - Otherwise, the chosen format should be as backward compatible as
827 * possible. (NXFF_OPENFLOW10 is more backward compatible than
828 * NXFF_TUN_ID_FROM_COOKIE, which is more backward compatible than
832 ofputil_min_flow_format(const struct cls_rule *rule, bool cookie_support,
835 const struct flow_wildcards *wc = &rule->wc;
836 ovs_be32 cookie_hi = htonl(ntohll(cookie) >> 32);
838 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)
839 || !regs_fully_wildcarded(wc)
840 || (!(wc->wildcards & FWW_TUN_ID)
842 || (cookie_hi && cookie_hi != rule->flow.tun_id)))) {
844 } else if (!(wc->wildcards & FWW_TUN_ID)) {
845 return NXFF_TUN_ID_FROM_COOKIE;
847 return NXFF_OPENFLOW10;
851 /* Returns an OpenFlow message that can be used to set the flow format to
854 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
858 if (flow_format == NXFF_OPENFLOW10
859 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
860 struct nxt_tun_id_cookie *tic;
862 tic = make_nxmsg(sizeof *tic, NXT_TUN_ID_FROM_COOKIE, &msg);
863 tic->set = flow_format == NXFF_TUN_ID_FROM_COOKIE;
865 struct nxt_set_flow_format *sff;
867 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
868 sff->format = htonl(flow_format);
874 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
875 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
878 * For OFPT_FLOW_MOD messages, 'flow_format' should be the current flow format
879 * at the time when the message was received. Otherwise 'flow_format' is
882 * Does not validate the flow_mod actions. */
884 ofputil_decode_flow_mod(struct flow_mod *fm, const struct ofp_header *oh,
885 enum nx_flow_format flow_format)
887 const struct ofputil_msg_type *type;
890 ofpbuf_use_const(&b, oh, ntohs(oh->length));
892 ofputil_decode_msg_type(oh, &type);
893 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
894 /* Standard OpenFlow flow_mod. */
895 struct ofp_match match, orig_match;
896 const struct ofp_flow_mod *ofm;
899 /* Dissect the message. */
900 ofm = ofpbuf_pull(&b, sizeof *ofm);
901 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
906 /* Normalize ofm->match. If normalization actually changes anything,
907 * then log the differences. */
909 match.pad1[0] = match.pad2[0] = 0;
911 normalize_match(&match);
912 if (memcmp(&match, &orig_match, sizeof orig_match)) {
913 if (!VLOG_DROP_INFO(&bad_ofmsg_rl)) {
914 char *old = ofp_match_to_literal_string(&orig_match);
915 char *new = ofp_match_to_literal_string(&match);
916 VLOG_INFO("normalization changed ofp_match, details:");
917 VLOG_INFO(" pre: %s", old);
918 VLOG_INFO("post: %s", new);
924 /* Translate the message. */
925 ofputil_cls_rule_from_match(&match, ntohs(ofm->priority), flow_format,
926 ofm->cookie, &fm->cr);
927 fm->cookie = ofm->cookie;
928 fm->command = ntohs(ofm->command);
929 fm->idle_timeout = ntohs(ofm->idle_timeout);
930 fm->hard_timeout = ntohs(ofm->hard_timeout);
931 fm->buffer_id = ntohl(ofm->buffer_id);
932 fm->out_port = ntohs(ofm->out_port);
933 fm->flags = ntohs(ofm->flags);
934 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
935 /* Nicira extended flow_mod. */
936 const struct nx_flow_mod *nfm;
939 /* Dissect the message. */
940 nfm = ofpbuf_pull(&b, sizeof *nfm);
941 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
946 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
951 /* Translate the message. */
952 fm->cookie = nfm->cookie;
953 fm->command = ntohs(nfm->command);
954 fm->idle_timeout = ntohs(nfm->idle_timeout);
955 fm->hard_timeout = ntohs(nfm->hard_timeout);
956 fm->buffer_id = ntohl(nfm->buffer_id);
957 fm->out_port = ntohs(nfm->out_port);
958 fm->flags = ntohs(nfm->flags);
966 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
967 * 'flow_format' and returns the message. */
969 ofputil_encode_flow_mod(const struct flow_mod *fm,
970 enum nx_flow_format flow_format)
972 size_t actions_len = fm->n_actions * sizeof *fm->actions;
975 if (flow_format == NXFF_OPENFLOW10
976 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
977 struct ofp_flow_mod *ofm;
979 msg = ofpbuf_new(sizeof *ofm + actions_len);
980 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
981 ofputil_cls_rule_to_match(&fm->cr, flow_format, &ofm->match);
982 if (flow_format != NXFF_TUN_ID_FROM_COOKIE
983 || fm->cr.wc.wildcards & FWW_TUN_ID) {
984 ofm->cookie = fm->cookie;
986 uint32_t cookie_lo = ntohll(fm->cookie);
987 uint32_t cookie_hi = ntohl(fm->cr.flow.tun_id);
988 ofm->cookie = htonll(cookie_lo | ((uint64_t) cookie_hi << 32));
990 ofm->command = htons(fm->command);
991 ofm->idle_timeout = htons(fm->idle_timeout);
992 ofm->hard_timeout = htons(fm->hard_timeout);
993 ofm->priority = htons(fm->cr.priority);
994 ofm->buffer_id = htonl(fm->buffer_id);
995 ofm->out_port = htons(fm->out_port);
996 ofm->flags = htons(fm->flags);
997 } else if (flow_format == NXFF_NXM) {
998 struct nx_flow_mod *nfm;
1001 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
1002 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
1003 match_len = nx_put_match(msg, &fm->cr);
1006 nfm->cookie = fm->cookie;
1007 nfm->command = htons(fm->command);
1008 nfm->idle_timeout = htons(fm->idle_timeout);
1009 nfm->hard_timeout = htons(fm->hard_timeout);
1010 nfm->priority = htons(fm->cr.priority);
1011 nfm->buffer_id = htonl(fm->buffer_id);
1012 nfm->out_port = htons(fm->out_port);
1013 nfm->flags = htons(fm->flags);
1014 nfm->match_len = htons(match_len);
1019 ofpbuf_put(msg, fm->actions, actions_len);
1020 update_openflow_length(msg);
1025 ofputil_decode_ofpst_flow_request(struct flow_stats_request *fsr,
1026 const struct ofp_header *oh,
1027 enum nx_flow_format flow_format,
1030 const struct ofp_flow_stats_request *ofsr = ofputil_stats_body(oh);
1032 fsr->aggregate = aggregate;
1033 ofputil_cls_rule_from_match(&ofsr->match, 0, flow_format, 0, &fsr->match);
1034 fsr->out_port = ntohs(ofsr->out_port);
1035 fsr->table_id = ofsr->table_id;
1041 ofputil_decode_nxst_flow_request(struct flow_stats_request *fsr,
1042 const struct ofp_header *oh,
1045 const struct nx_flow_stats_request *nfsr;
1049 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1051 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1052 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1057 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1060 fsr->aggregate = aggregate;
1061 fsr->out_port = ntohs(nfsr->out_port);
1062 fsr->table_id = nfsr->table_id;
1067 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1068 * message 'oh', received when the current flow format was 'flow_format', into
1069 * an abstract flow_stats_request in 'fsr'. Returns 0 if successful, otherwise
1070 * an OpenFlow error code. */
1072 ofputil_decode_flow_stats_request(struct flow_stats_request *fsr,
1073 const struct ofp_header *oh,
1074 enum nx_flow_format flow_format)
1076 const struct ofputil_msg_type *type;
1080 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1082 ofputil_decode_msg_type(oh, &type);
1083 code = ofputil_msg_type_code(type);
1085 case OFPUTIL_OFPST_FLOW_REQUEST:
1086 return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, false);
1088 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1089 return ofputil_decode_ofpst_flow_request(fsr, oh, flow_format, true);
1091 case OFPUTIL_NXST_FLOW_REQUEST:
1092 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1094 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1095 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1098 /* Hey, the caller lied. */
1103 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1104 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE message 'oh' according to
1105 * 'flow_format', and returns the message. */
1107 ofputil_encode_flow_stats_request(const struct flow_stats_request *fsr,
1108 enum nx_flow_format flow_format)
1112 if (flow_format == NXFF_OPENFLOW10
1113 || flow_format == NXFF_TUN_ID_FROM_COOKIE) {
1114 struct ofp_flow_stats_request *ofsr;
1117 BUILD_ASSERT_DECL(sizeof(struct ofp_flow_stats_request)
1118 == sizeof(struct ofp_aggregate_stats_request));
1120 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1121 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, &msg);
1122 ofputil_cls_rule_to_match(&fsr->match, flow_format, &ofsr->match);
1123 ofsr->table_id = fsr->table_id;
1124 ofsr->out_port = htons(fsr->out_port);
1125 } else if (flow_format == NXFF_NXM) {
1126 struct nx_flow_stats_request *nfsr;
1129 ofputil_make_nxstats_request(sizeof *nfsr, NXST_FLOW, &msg);
1130 match_len = nx_put_match(msg, &fsr->match);
1133 nfsr->out_port = htons(fsr->out_port);
1134 nfsr->match_len = htons(match_len);
1135 nfsr->table_id = fsr->table_id;
1143 /* Returns a string representing the message type of 'type'. The string is the
1144 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1145 * messages, the constant is followed by "request" or "reply",
1146 * e.g. "OFPST_AGGREGATE reply". */
1148 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1153 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1154 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1155 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1158 * The caller is responsible for freeing '*bufferp' when it is no longer
1161 * The OpenFlow header length is initially set to 'openflow_len'; if the
1162 * message is later extended, the length should be updated with
1163 * update_openflow_length() before sending.
1165 * Returns the header. */
1167 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1169 *bufferp = ofpbuf_new(openflow_len);
1170 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1173 /* Similar to make_openflow() but creates a Nicira vendor extension message
1174 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1176 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1178 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1181 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1182 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1183 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1186 * The caller is responsible for freeing '*bufferp' when it is no longer
1189 * The OpenFlow header length is initially set to 'openflow_len'; if the
1190 * message is later extended, the length should be updated with
1191 * update_openflow_length() before sending.
1193 * Returns the header. */
1195 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1196 struct ofpbuf **bufferp)
1198 *bufferp = ofpbuf_new(openflow_len);
1199 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1202 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1203 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1205 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1206 struct ofpbuf **bufferp)
1208 *bufferp = ofpbuf_new(openflow_len);
1209 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1212 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1213 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1214 * beyond the header, if any, are zeroed.
1216 * The OpenFlow header length is initially set to 'openflow_len'; if the
1217 * message is later extended, the length should be updated with
1218 * update_openflow_length() before sending.
1220 * Returns the header. */
1222 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1224 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1227 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1228 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1229 * the header, if any, are zeroed.
1231 * The OpenFlow header length is initially set to 'openflow_len'; if the
1232 * message is later extended, the length should be updated with
1233 * update_openflow_length() before sending.
1235 * Returns the header. */
1237 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1238 struct ofpbuf *buffer)
1240 struct ofp_header *oh;
1242 assert(openflow_len >= sizeof *oh);
1243 assert(openflow_len <= UINT16_MAX);
1245 oh = ofpbuf_put_uninit(buffer, openflow_len);
1246 oh->version = OFP_VERSION;
1248 oh->length = htons(openflow_len);
1250 memset(oh + 1, 0, openflow_len - sizeof *oh);
1254 /* Similar to put_openflow() but append a Nicira vendor extension message with
1255 * the specific 'subtype'. 'subtype' should be in host byte order. */
1257 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1259 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1262 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1263 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1265 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1266 struct ofpbuf *buffer)
1268 struct nicira_header *nxh;
1270 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1271 nxh->vendor = htonl(NX_VENDOR_ID);
1272 nxh->subtype = htonl(subtype);
1276 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1277 * 'buffer->size'. */
1279 update_openflow_length(struct ofpbuf *buffer)
1281 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1282 oh->length = htons(buffer->size);
1285 /* Creates an ofp_stats_request with the given 'type' and 'body_len' bytes of
1286 * space allocated for the 'body' member. Returns the first byte of the 'body'
1289 ofputil_make_stats_request(size_t body_len, uint16_t type,
1290 struct ofpbuf **bufferp)
1292 struct ofp_stats_request *osr;
1293 osr = make_openflow((offsetof(struct ofp_stats_request, body)
1294 + body_len), OFPT_STATS_REQUEST, bufferp);
1295 osr->type = htons(type);
1296 osr->flags = htons(0);
1300 /* Creates a stats request message with Nicira as vendor and the given
1301 * 'subtype', of total length 'openflow_len'. Returns the message. */
1303 ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
1304 struct ofpbuf **bufferp)
1306 struct nicira_stats_msg *nsm;
1308 nsm = make_openflow(openflow_len, OFPT_STATS_REQUEST, bufferp);
1309 nsm->type = htons(OFPST_VENDOR);
1310 nsm->flags = htons(0);
1311 nsm->vendor = htonl(NX_VENDOR_ID);
1312 nsm->subtype = htonl(subtype);
1316 /* Returns the first byte of the 'body' member of the ofp_stats_request or
1317 * ofp_stats_reply in 'oh'. */
1319 ofputil_stats_body(const struct ofp_header *oh)
1321 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1322 return ((const struct ofp_stats_request *) oh)->body;
1325 /* Returns the length of the 'body' member of the ofp_stats_request or
1326 * ofp_stats_reply in 'oh'. */
1328 ofputil_stats_body_len(const struct ofp_header *oh)
1330 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1331 return ntohs(oh->length) - sizeof(struct ofp_stats_request);
1334 /* Returns the first byte of the body of the nicira_stats_msg in 'oh'. */
1336 ofputil_nxstats_body(const struct ofp_header *oh)
1338 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1339 return ((const struct nicira_stats_msg *) oh) + 1;
1342 /* Returns the length of the body of the nicira_stats_msg in 'oh'. */
1344 ofputil_nxstats_body_len(const struct ofp_header *oh)
1346 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1347 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1351 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1354 struct ofp_flow_mod *ofm;
1355 size_t size = sizeof *ofm + actions_len;
1356 struct ofpbuf *out = ofpbuf_new(size);
1357 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1358 ofm->header.version = OFP_VERSION;
1359 ofm->header.type = OFPT_FLOW_MOD;
1360 ofm->header.length = htons(size);
1362 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1363 ofputil_cls_rule_to_match(rule, NXFF_OPENFLOW10, &ofm->match);
1364 ofm->command = htons(command);
1369 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1370 uint16_t idle_timeout, size_t actions_len)
1372 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1373 struct ofp_flow_mod *ofm = out->data;
1374 ofm->idle_timeout = htons(idle_timeout);
1375 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1376 ofm->buffer_id = htonl(buffer_id);
1381 make_del_flow(const struct cls_rule *rule)
1383 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1384 struct ofp_flow_mod *ofm = out->data;
1385 ofm->out_port = htons(OFPP_NONE);
1390 make_add_simple_flow(const struct cls_rule *rule,
1391 uint32_t buffer_id, uint16_t out_port,
1392 uint16_t idle_timeout)
1394 if (out_port != OFPP_NONE) {
1395 struct ofp_action_output *oao;
1396 struct ofpbuf *buffer;
1398 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1399 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
1400 oao->type = htons(OFPAT_OUTPUT);
1401 oao->len = htons(sizeof *oao);
1402 oao->port = htons(out_port);
1405 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1410 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1411 const struct ofpbuf *payload, int max_send_len)
1413 struct ofp_packet_in *opi;
1417 send_len = MIN(max_send_len, payload->size);
1418 buf = ofpbuf_new(sizeof *opi + send_len);
1419 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1420 OFPT_PACKET_IN, 0, buf);
1421 opi->buffer_id = htonl(buffer_id);
1422 opi->total_len = htons(payload->size);
1423 opi->in_port = htons(in_port);
1424 opi->reason = reason;
1425 ofpbuf_put(buf, payload->data, send_len);
1426 update_openflow_length(buf);
1432 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1434 const struct ofp_action_header *actions, size_t n_actions)
1436 size_t actions_len = n_actions * sizeof *actions;
1437 struct ofp_packet_out *opo;
1438 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1439 struct ofpbuf *out = ofpbuf_new(size);
1441 opo = ofpbuf_put_uninit(out, sizeof *opo);
1442 opo->header.version = OFP_VERSION;
1443 opo->header.type = OFPT_PACKET_OUT;
1444 opo->header.length = htons(size);
1445 opo->header.xid = htonl(0);
1446 opo->buffer_id = htonl(buffer_id);
1447 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
1448 opo->actions_len = htons(actions_len);
1449 ofpbuf_put(out, actions, actions_len);
1451 ofpbuf_put(out, packet->data, packet->size);
1457 make_unbuffered_packet_out(const struct ofpbuf *packet,
1458 uint16_t in_port, uint16_t out_port)
1460 struct ofp_action_output action;
1461 action.type = htons(OFPAT_OUTPUT);
1462 action.len = htons(sizeof action);
1463 action.port = htons(out_port);
1464 return make_packet_out(packet, UINT32_MAX, in_port,
1465 (struct ofp_action_header *) &action, 1);
1469 make_buffered_packet_out(uint32_t buffer_id,
1470 uint16_t in_port, uint16_t out_port)
1472 if (out_port != OFPP_NONE) {
1473 struct ofp_action_output action;
1474 action.type = htons(OFPAT_OUTPUT);
1475 action.len = htons(sizeof action);
1476 action.port = htons(out_port);
1477 return make_packet_out(NULL, buffer_id, in_port,
1478 (struct ofp_action_header *) &action, 1);
1480 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1484 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1486 make_echo_request(void)
1488 struct ofp_header *rq;
1489 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1490 rq = ofpbuf_put_uninit(out, sizeof *rq);
1491 rq->version = OFP_VERSION;
1492 rq->type = OFPT_ECHO_REQUEST;
1493 rq->length = htons(sizeof *rq);
1498 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1499 * OFPT_ECHO_REQUEST message in 'rq'. */
1501 make_echo_reply(const struct ofp_header *rq)
1503 size_t size = ntohs(rq->length);
1504 struct ofpbuf *out = ofpbuf_new(size);
1505 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1506 reply->type = OFPT_ECHO_REPLY;
1510 const struct ofp_flow_stats *
1511 flow_stats_first(struct flow_stats_iterator *iter,
1512 const struct ofp_stats_reply *osr)
1514 iter->pos = osr->body;
1515 iter->end = osr->body + (ntohs(osr->header.length)
1516 - offsetof(struct ofp_stats_reply, body));
1517 return flow_stats_next(iter);
1520 const struct ofp_flow_stats *
1521 flow_stats_next(struct flow_stats_iterator *iter)
1523 ptrdiff_t bytes_left = iter->end - iter->pos;
1524 const struct ofp_flow_stats *fs;
1527 if (bytes_left < sizeof *fs) {
1528 if (bytes_left != 0) {
1529 VLOG_WARN_RL(&bad_ofmsg_rl,
1530 "%td leftover bytes in flow stats reply", bytes_left);
1535 fs = (const void *) iter->pos;
1536 length = ntohs(fs->length);
1537 if (length < sizeof *fs) {
1538 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than "
1539 "min %zu", length, sizeof *fs);
1541 } else if (length > bytes_left) {
1542 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td "
1543 "bytes left", length, bytes_left);
1545 } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
1546 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes "
1547 "left over in final action", length,
1548 (length - sizeof *fs) % sizeof fs->actions[0]);
1551 iter->pos += length;
1556 check_action_exact_len(const union ofp_action *a, unsigned int len,
1557 unsigned int required_len)
1559 if (len != required_len) {
1560 VLOG_DBG_RL(&bad_ofmsg_rl,
1561 "action %u has invalid length %"PRIu16" (must be %u)\n",
1562 a->type, ntohs(a->header.len), required_len);
1563 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1568 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1569 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1570 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1572 check_output_port(uint16_t port, int max_ports)
1580 case OFPP_CONTROLLER:
1585 if (port < max_ports) {
1588 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
1589 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1593 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
1594 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
1595 * otherwise an ofp_mkerr() return code. */
1597 check_enqueue_action(const union ofp_action *a, unsigned int len,
1600 const struct ofp_action_enqueue *oae;
1604 error = check_action_exact_len(a, len, 16);
1609 oae = (const struct ofp_action_enqueue *) a;
1610 port = ntohs(oae->port);
1611 if (port < max_ports || port == OFPP_IN_PORT) {
1614 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
1615 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1619 check_nicira_action(const union ofp_action *a, unsigned int len,
1620 const struct flow *flow)
1622 const struct nx_action_header *nah;
1626 VLOG_DBG_RL(&bad_ofmsg_rl,
1627 "Nicira vendor action only %u bytes", len);
1628 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1630 nah = (const struct nx_action_header *) a;
1632 switch (ntohs(nah->subtype)) {
1633 case NXAST_RESUBMIT:
1634 case NXAST_SET_TUNNEL:
1635 case NXAST_DROP_SPOOFED_ARP:
1636 case NXAST_SET_QUEUE:
1637 case NXAST_POP_QUEUE:
1638 return check_action_exact_len(a, len, 16);
1640 case NXAST_REG_MOVE:
1641 error = check_action_exact_len(a, len,
1642 sizeof(struct nx_action_reg_move));
1646 return nxm_check_reg_move((const struct nx_action_reg_move *) a, flow);
1648 case NXAST_REG_LOAD:
1649 error = check_action_exact_len(a, len,
1650 sizeof(struct nx_action_reg_load));
1654 return nxm_check_reg_load((const struct nx_action_reg_load *) a, flow);
1660 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
1665 check_action(const union ofp_action *a, unsigned int len,
1666 const struct flow *flow, int max_ports)
1670 switch (ntohs(a->type)) {
1672 error = check_action_exact_len(a, len, 8);
1676 return check_output_port(ntohs(a->output.port), max_ports);
1678 case OFPAT_SET_VLAN_VID:
1679 error = check_action_exact_len(a, len, 8);
1683 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1684 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1688 case OFPAT_SET_VLAN_PCP:
1689 error = check_action_exact_len(a, len, 8);
1693 if (a->vlan_vid.vlan_vid & ~7) {
1694 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
1698 case OFPAT_STRIP_VLAN:
1699 case OFPAT_SET_NW_SRC:
1700 case OFPAT_SET_NW_DST:
1701 case OFPAT_SET_NW_TOS:
1702 case OFPAT_SET_TP_SRC:
1703 case OFPAT_SET_TP_DST:
1704 return check_action_exact_len(a, len, 8);
1706 case OFPAT_SET_DL_SRC:
1707 case OFPAT_SET_DL_DST:
1708 return check_action_exact_len(a, len, 16);
1711 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
1712 ? check_nicira_action(a, len, flow)
1713 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
1716 return check_enqueue_action(a, len, max_ports);
1719 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %"PRIu16,
1721 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
1726 validate_actions(const union ofp_action *actions, size_t n_actions,
1727 const struct flow *flow, int max_ports)
1731 for (i = 0; i < n_actions; ) {
1732 const union ofp_action *a = &actions[i];
1733 unsigned int len = ntohs(a->header.len);
1734 unsigned int n_slots = len / OFP_ACTION_ALIGN;
1735 unsigned int slots_left = &actions[n_actions] - a;
1738 if (n_slots > slots_left) {
1739 VLOG_DBG_RL(&bad_ofmsg_rl,
1740 "action requires %u slots but only %u remain",
1741 n_slots, slots_left);
1742 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1744 VLOG_DBG_RL(&bad_ofmsg_rl, "action has invalid length 0");
1745 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1746 } else if (len % OFP_ACTION_ALIGN) {
1747 VLOG_DBG_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
1748 "of %d", len, OFP_ACTION_ALIGN);
1749 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
1752 error = check_action(a, len, flow, max_ports);
1761 /* Returns true if 'action' outputs to 'port' (which must be in network byte
1762 * order), false otherwise. */
1764 action_outputs_to_port(const union ofp_action *action, uint16_t port)
1766 switch (ntohs(action->type)) {
1768 return action->output.port == port;
1770 return ((const struct ofp_action_enqueue *) action)->port == port;
1776 /* The set of actions must either come from a trusted source or have been
1777 * previously validated with validate_actions(). */
1778 const union ofp_action *
1779 actions_first(struct actions_iterator *iter,
1780 const union ofp_action *oa, size_t n_actions)
1783 iter->end = oa + n_actions;
1784 return actions_next(iter);
1787 const union ofp_action *
1788 actions_next(struct actions_iterator *iter)
1790 if (iter->pos != iter->end) {
1791 const union ofp_action *a = iter->pos;
1792 unsigned int len = ntohs(a->header.len);
1793 iter->pos += len / OFP_ACTION_ALIGN;
1801 normalize_match(struct ofp_match *m)
1803 enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
1805 enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
1808 wc = ntohl(m->wildcards) & OVSFW_ALL;
1809 if (wc & OFPFW_DL_TYPE) {
1812 /* Can't sensibly match on network or transport headers if the
1813 * data link type is unknown. */
1814 wc |= OFPFW_NW | OFPFW_TP;
1815 m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
1816 m->tp_src = m->tp_dst = 0;
1817 } else if (m->dl_type == htons(ETH_TYPE_IP)) {
1818 if (wc & OFPFW_NW_PROTO) {
1821 /* Can't sensibly match on transport headers if the network
1822 * protocol is unknown. */
1824 m->tp_src = m->tp_dst = 0;
1825 } else if (m->nw_proto == IPPROTO_TCP ||
1826 m->nw_proto == IPPROTO_UDP ||
1827 m->nw_proto == IPPROTO_ICMP) {
1828 if (wc & OFPFW_TP_SRC) {
1831 if (wc & OFPFW_TP_DST) {
1835 /* Transport layer fields will always be extracted as zeros, so we
1836 * can do an exact-match on those values. */
1838 m->tp_src = m->tp_dst = 0;
1840 if (wc & OFPFW_NW_SRC_MASK) {
1841 m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1843 if (wc & OFPFW_NW_DST_MASK) {
1844 m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1846 if (wc & OFPFW_NW_TOS) {
1849 m->nw_tos &= IP_DSCP_MASK;
1851 } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
1852 if (wc & OFPFW_NW_PROTO) {
1855 if (wc & OFPFW_NW_SRC_MASK) {
1856 m->nw_src &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_SRC_SHIFT);
1858 if (wc & OFPFW_NW_DST_MASK) {
1859 m->nw_dst &= ofputil_wcbits_to_netmask(wc >> OFPFW_NW_DST_SHIFT);
1861 m->tp_src = m->tp_dst = m->nw_tos = 0;
1863 /* Network and transport layer fields will always be extracted as
1864 * zeros, so we can do an exact-match on those values. */
1865 wc &= ~(OFPFW_NW | OFPFW_TP);
1866 m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
1867 m->tp_src = m->tp_dst = 0;
1869 if (wc & OFPFW_DL_SRC) {
1870 memset(m->dl_src, 0, sizeof m->dl_src);
1872 if (wc & OFPFW_DL_DST) {
1873 memset(m->dl_dst, 0, sizeof m->dl_dst);
1875 m->wildcards = htonl(wc);
1878 /* Returns a string that describes 'match' in a very literal way, without
1879 * interpreting its contents except in a very basic fashion. The returned
1880 * string is intended to be fixed-length, so that it is easy to see differences
1881 * between two such strings if one is put above another. This is useful for
1882 * describing changes made by normalize_match().
1884 * The caller must free the returned string (with free()). */
1886 ofp_match_to_literal_string(const struct ofp_match *match)
1888 return xasprintf("wildcards=%#10"PRIx32" "
1889 " in_port=%5"PRId16" "
1890 " dl_src="ETH_ADDR_FMT" "
1891 " dl_dst="ETH_ADDR_FMT" "
1892 " dl_vlan=%5"PRId16" "
1893 " dl_vlan_pcp=%3"PRId8" "
1894 " dl_type=%#6"PRIx16" "
1895 " nw_tos=%#4"PRIx8" "
1896 " nw_proto=%#4"PRIx16" "
1897 " nw_src=%#10"PRIx32" "
1898 " nw_dst=%#10"PRIx32" "
1899 " tp_src=%5"PRId16" "
1901 ntohl(match->wildcards),
1902 ntohs(match->in_port),
1903 ETH_ADDR_ARGS(match->dl_src),
1904 ETH_ADDR_ARGS(match->dl_dst),
1905 ntohs(match->dl_vlan),
1907 ntohs(match->dl_type),
1910 ntohl(match->nw_src),
1911 ntohl(match->nw_dst),
1912 ntohs(match->tp_src),
1913 ntohs(match->tp_dst));
1917 vendor_code_to_id(uint8_t code)
1920 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
1922 #undef OFPUTIL_VENDOR
1928 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
1929 * information taken from 'error', whose encoding must be as described in the
1930 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
1931 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
1934 * Returns NULL if 'error' is not an OpenFlow error code. */
1936 make_ofp_error_msg(int error, const struct ofp_header *oh)
1938 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1948 if (!is_ofp_error(error)) {
1949 /* We format 'error' with strerror() here since it seems likely to be
1950 * a system errno value. */
1951 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
1952 error, strerror(error));
1959 len = ntohs(oh->length);
1969 vendor = get_ofp_err_vendor(error);
1970 type = get_ofp_err_type(error);
1971 code = get_ofp_err_code(error);
1972 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
1973 struct ofp_error_msg *oem;
1975 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
1976 oem->type = htons(type);
1977 oem->code = htons(code);
1979 struct ofp_error_msg *oem;
1980 struct nx_vendor_error *nve;
1983 vendor_id = vendor_code_to_id(vendor);
1984 if (vendor_id == UINT32_MAX) {
1985 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
1990 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
1991 OFPT_ERROR, xid, &buf);
1992 oem->type = htons(NXET_VENDOR);
1993 oem->code = htons(NXVC_VENDOR_ERROR);
1995 nve = (struct nx_vendor_error *)oem->data;
1996 nve->vendor = htonl(vendor_id);
1997 nve->type = htons(type);
1998 nve->code = htons(code);
2003 ofpbuf_put(buf, data, len);
2009 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2010 * successful, otherwise an OpenFlow error.
2012 * If successful, the first action is stored in '*actionsp' and the number of
2013 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2014 * are stored, respectively.
2016 * This function does not check that the actions are valid (the caller should
2017 * do so, with validate_actions()). The caller is also responsible for making
2018 * sure that 'b->data' is initially aligned appropriately for "union
2021 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2022 union ofp_action **actionsp, size_t *n_actionsp)
2024 if (actions_len % OFP_ACTION_ALIGN != 0) {
2025 VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2026 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2030 *actionsp = ofpbuf_try_pull(b, actions_len);
2031 if (*actionsp == NULL) {
2032 VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2033 "exceeds remaining message length (%zu)",
2034 actions_len, b->size);
2038 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2044 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);