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>
25 #include "byte-order.h"
26 #include "classifier.h"
27 #include "dynamic-string.h"
29 #include "multipath.h"
31 #include "ofp-errors.h"
36 #include "unaligned.h"
37 #include "type-props.h"
40 VLOG_DEFINE_THIS_MODULE(ofp_util);
42 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
43 * in the peer and so there's not much point in showing a lot of them. */
44 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
46 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
47 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
50 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
51 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
52 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
53 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
56 ofputil_wcbits_to_netmask(int wcbits)
59 return wcbits < 32 ? htonl(~((1u << wcbits) - 1)) : 0;
62 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
63 * that it wildcards, that is, the number of 0-bits in 'netmask'. 'netmask'
64 * must be a CIDR netmask (see ip_is_cidr()). */
66 ofputil_netmask_to_wcbits(ovs_be32 netmask)
68 return 32 - ip_count_cidr_bits(netmask);
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
90 static const flow_wildcards_t WC_INVARIANTS = 0
91 #define WC_INVARIANT_BIT(NAME) | FWW_##NAME
93 #undef WC_INVARIANT_BIT
96 /* Converts the wildcard in 'ofpfw' into a flow_wildcards in 'wc' for use in
97 * struct cls_rule. It is the caller's responsibility to handle the special
98 * case where the flow match's dl_vlan is set to OFP_VLAN_NONE. */
100 ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *wc)
102 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 2);
104 /* Initialize most of rule->wc. */
105 flow_wildcards_init_catchall(wc);
106 wc->wildcards = (OVS_FORCE flow_wildcards_t) ofpfw & WC_INVARIANTS;
108 /* Wildcard fields that aren't defined by ofp_match or tun_id. */
109 wc->wildcards |= (FWW_ARP_SHA | FWW_ARP_THA | FWW_ND_TARGET);
111 if (ofpfw & OFPFW_NW_TOS) {
112 wc->wildcards |= FWW_NW_TOS;
114 wc->nw_src_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_SRC_SHIFT);
115 wc->nw_dst_mask = ofputil_wcbits_to_netmask(ofpfw >> OFPFW_NW_DST_SHIFT);
117 if (ofpfw & OFPFW_DL_DST) {
118 /* OpenFlow 1.0 OFPFW_DL_DST covers the whole Ethernet destination, but
119 * Open vSwitch breaks the Ethernet destination into bits as FWW_DL_DST
120 * and FWW_ETH_MCAST. */
121 wc->wildcards |= FWW_ETH_MCAST;
125 if (!(ofpfw & OFPFW_DL_VLAN_PCP)) {
126 wc->vlan_tci_mask |= htons(VLAN_PCP_MASK | VLAN_CFI);
128 if (!(ofpfw & OFPFW_DL_VLAN)) {
129 wc->vlan_tci_mask |= htons(VLAN_VID_MASK | VLAN_CFI);
133 /* Converts the ofp_match in 'match' into a cls_rule in 'rule', with the given
136 ofputil_cls_rule_from_match(const struct ofp_match *match,
137 unsigned int priority, struct cls_rule *rule)
139 uint32_t ofpfw = ntohl(match->wildcards) & OFPFW_ALL;
141 /* Initialize rule->priority, rule->wc. */
142 rule->priority = !ofpfw ? UINT16_MAX : priority;
143 ofputil_wildcard_from_openflow(ofpfw, &rule->wc);
145 /* Initialize most of rule->flow. */
146 rule->flow.nw_src = match->nw_src;
147 rule->flow.nw_dst = match->nw_dst;
148 rule->flow.in_port = ntohs(match->in_port);
149 rule->flow.dl_type = ofputil_dl_type_from_openflow(match->dl_type);
150 rule->flow.tp_src = match->tp_src;
151 rule->flow.tp_dst = match->tp_dst;
152 memcpy(rule->flow.dl_src, match->dl_src, ETH_ADDR_LEN);
153 memcpy(rule->flow.dl_dst, match->dl_dst, ETH_ADDR_LEN);
154 rule->flow.nw_tos = match->nw_tos;
155 rule->flow.nw_proto = match->nw_proto;
157 /* Translate VLANs. */
158 if (!(ofpfw & OFPFW_DL_VLAN) && match->dl_vlan == htons(OFP_VLAN_NONE)) {
159 /* Match only packets without 802.1Q header.
161 * When OFPFW_DL_VLAN_PCP is wildcarded, this is obviously correct.
163 * If OFPFW_DL_VLAN_PCP is matched, the flow match is contradictory,
164 * because we can't have a specific PCP without an 802.1Q header.
165 * However, older versions of OVS treated this as matching packets
166 * withut an 802.1Q header, so we do here too. */
167 rule->flow.vlan_tci = htons(0);
168 rule->wc.vlan_tci_mask = htons(0xffff);
170 ovs_be16 vid, pcp, tci;
172 vid = match->dl_vlan & htons(VLAN_VID_MASK);
173 pcp = htons((match->dl_vlan_pcp << VLAN_PCP_SHIFT) & VLAN_PCP_MASK);
174 tci = vid | pcp | htons(VLAN_CFI);
175 rule->flow.vlan_tci = tci & rule->wc.vlan_tci_mask;
179 cls_rule_zero_wildcarded_fields(rule);
182 /* Convert 'rule' into the OpenFlow match structure 'match'. */
184 ofputil_cls_rule_to_match(const struct cls_rule *rule, struct ofp_match *match)
186 const struct flow_wildcards *wc = &rule->wc;
189 /* Figure out most OpenFlow wildcards. */
190 ofpfw = (OVS_FORCE uint32_t) (wc->wildcards & WC_INVARIANTS);
191 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_src_mask) << OFPFW_NW_SRC_SHIFT;
192 ofpfw |= ofputil_netmask_to_wcbits(wc->nw_dst_mask) << OFPFW_NW_DST_SHIFT;
193 if (wc->wildcards & FWW_NW_TOS) {
194 ofpfw |= OFPFW_NW_TOS;
197 /* Translate VLANs. */
198 match->dl_vlan = htons(0);
199 match->dl_vlan_pcp = 0;
200 if (rule->wc.vlan_tci_mask == htons(0)) {
201 ofpfw |= OFPFW_DL_VLAN | OFPFW_DL_VLAN_PCP;
202 } else if (rule->wc.vlan_tci_mask & htons(VLAN_CFI)
203 && !(rule->flow.vlan_tci & htons(VLAN_CFI))) {
204 match->dl_vlan = htons(OFP_VLAN_NONE);
206 if (!(rule->wc.vlan_tci_mask & htons(VLAN_VID_MASK))) {
207 ofpfw |= OFPFW_DL_VLAN;
209 match->dl_vlan = htons(vlan_tci_to_vid(rule->flow.vlan_tci));
212 if (!(rule->wc.vlan_tci_mask & htons(VLAN_PCP_MASK))) {
213 ofpfw |= OFPFW_DL_VLAN_PCP;
215 match->dl_vlan_pcp = vlan_tci_to_pcp(rule->flow.vlan_tci);
219 /* Compose most of the match structure. */
220 match->wildcards = htonl(ofpfw);
221 match->in_port = htons(rule->flow.in_port);
222 memcpy(match->dl_src, rule->flow.dl_src, ETH_ADDR_LEN);
223 memcpy(match->dl_dst, rule->flow.dl_dst, ETH_ADDR_LEN);
224 match->dl_type = ofputil_dl_type_to_openflow(rule->flow.dl_type);
225 match->nw_src = rule->flow.nw_src;
226 match->nw_dst = rule->flow.nw_dst;
227 match->nw_tos = rule->flow.nw_tos;
228 match->nw_proto = rule->flow.nw_proto;
229 match->tp_src = rule->flow.tp_src;
230 match->tp_dst = rule->flow.tp_dst;
231 memset(match->pad1, '\0', sizeof match->pad1);
232 memset(match->pad2, '\0', sizeof match->pad2);
235 /* Given a 'dl_type' value in the format used in struct flow, returns the
236 * corresponding 'dl_type' value for use in an OpenFlow ofp_match structure. */
238 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type)
240 return (flow_dl_type == htons(FLOW_DL_TYPE_NONE)
241 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE)
245 /* Given a 'dl_type' value in the format used in an OpenFlow ofp_match
246 * structure, returns the corresponding 'dl_type' value for use in struct
249 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type)
251 return (ofp_dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
252 ? htons(FLOW_DL_TYPE_NONE)
256 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
260 static uint32_t next_xid = 1;
261 return htonl(next_xid++);
264 /* Basic parsing of OpenFlow messages. */
266 struct ofputil_msg_type {
267 enum ofputil_msg_code code; /* OFPUTIL_*. */
268 uint32_t value; /* OFPT_*, OFPST_*, NXT_*, or NXST_*. */
269 const char *name; /* e.g. "OFPT_FLOW_REMOVED". */
270 unsigned int min_size; /* Minimum total message size in bytes. */
271 /* 0 if 'min_size' is the exact size that the message must be. Otherwise,
272 * the message may exceed 'min_size' by an even multiple of this value. */
273 unsigned int extra_multiple;
276 struct ofputil_msg_category {
277 const char *name; /* e.g. "OpenFlow message" */
278 const struct ofputil_msg_type *types;
280 int missing_error; /* ofp_mkerr() value for missing type. */
284 ofputil_length_ok(const struct ofputil_msg_category *cat,
285 const struct ofputil_msg_type *type,
288 switch (type->extra_multiple) {
290 if (size != type->min_size) {
291 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
292 "length %u (expected length %u)",
293 cat->name, type->name, size, type->min_size);
299 if (size < type->min_size) {
300 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
301 "length %u (expected length at least %u bytes)",
302 cat->name, type->name, size, type->min_size);
308 if (size < type->min_size
309 || (size - type->min_size) % type->extra_multiple) {
310 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s %s with incorrect "
311 "length %u (must be exactly %u bytes or longer "
312 "by an integer multiple of %u bytes)",
313 cat->name, type->name, size,
314 type->min_size, type->extra_multiple);
322 ofputil_lookup_openflow_message(const struct ofputil_msg_category *cat,
323 uint32_t value, unsigned int size,
324 const struct ofputil_msg_type **typep)
326 const struct ofputil_msg_type *type;
328 for (type = cat->types; type < &cat->types[cat->n_types]; type++) {
329 if (type->value == value) {
330 if (!ofputil_length_ok(cat, type, size)) {
331 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
338 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s of unknown type %"PRIu32,
340 return cat->missing_error;
344 ofputil_decode_vendor(const struct ofp_header *oh,
345 const struct ofputil_msg_type **typep)
347 static const struct ofputil_msg_type nxt_messages[] = {
348 { OFPUTIL_NXT_ROLE_REQUEST,
349 NXT_ROLE_REQUEST, "NXT_ROLE_REQUEST",
350 sizeof(struct nx_role_request), 0 },
352 { OFPUTIL_NXT_ROLE_REPLY,
353 NXT_ROLE_REPLY, "NXT_ROLE_REPLY",
354 sizeof(struct nx_role_request), 0 },
356 { OFPUTIL_NXT_SET_FLOW_FORMAT,
357 NXT_SET_FLOW_FORMAT, "NXT_SET_FLOW_FORMAT",
358 sizeof(struct nxt_set_flow_format), 0 },
360 { OFPUTIL_NXT_FLOW_MOD,
361 NXT_FLOW_MOD, "NXT_FLOW_MOD",
362 sizeof(struct nx_flow_mod), 8 },
364 { OFPUTIL_NXT_FLOW_REMOVED,
365 NXT_FLOW_REMOVED, "NXT_FLOW_REMOVED",
366 sizeof(struct nx_flow_removed), 8 },
368 { OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
369 NXT_FLOW_MOD_TABLE_ID, "NXT_FLOW_MOD_TABLE_ID",
370 sizeof(struct nxt_flow_mod_table_id), 0 },
373 static const struct ofputil_msg_category nxt_category = {
374 "Nicira extension message",
375 nxt_messages, ARRAY_SIZE(nxt_messages),
376 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
379 const struct ofp_vendor_header *ovh;
380 const struct nicira_header *nh;
382 ovh = (const struct ofp_vendor_header *) oh;
383 if (ovh->vendor != htonl(NX_VENDOR_ID)) {
384 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor message for unknown "
385 "vendor %"PRIx32, ntohl(ovh->vendor));
386 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
389 if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
390 VLOG_WARN_RL(&bad_ofmsg_rl, "received Nicira vendor message of "
391 "length %u (expected at least %zu)",
392 ntohs(ovh->header.length), sizeof(struct nicira_header));
393 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
396 nh = (const struct nicira_header *) oh;
397 return ofputil_lookup_openflow_message(&nxt_category, ntohl(nh->subtype),
398 ntohs(oh->length), typep);
402 check_nxstats_msg(const struct ofp_header *oh)
404 const struct ofp_stats_msg *osm = (const struct ofp_stats_msg *) oh;
407 memcpy(&vendor, osm + 1, sizeof vendor);
408 if (vendor != htonl(NX_VENDOR_ID)) {
409 VLOG_WARN_RL(&bad_ofmsg_rl, "received vendor stats message for "
410 "unknown vendor %"PRIx32, ntohl(vendor));
411 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
414 if (ntohs(osm->header.length) < sizeof(struct nicira_stats_msg)) {
415 VLOG_WARN_RL(&bad_ofmsg_rl, "truncated Nicira stats message");
416 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
423 ofputil_decode_nxst_request(const struct ofp_header *oh,
424 const struct ofputil_msg_type **typep)
426 static const struct ofputil_msg_type nxst_requests[] = {
427 { OFPUTIL_NXST_FLOW_REQUEST,
428 NXST_FLOW, "NXST_FLOW request",
429 sizeof(struct nx_flow_stats_request), 8 },
431 { OFPUTIL_NXST_AGGREGATE_REQUEST,
432 NXST_AGGREGATE, "NXST_AGGREGATE request",
433 sizeof(struct nx_aggregate_stats_request), 8 },
436 static const struct ofputil_msg_category nxst_request_category = {
437 "Nicira extension statistics request",
438 nxst_requests, ARRAY_SIZE(nxst_requests),
439 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
442 const struct nicira_stats_msg *nsm;
445 error = check_nxstats_msg(oh);
450 nsm = (struct nicira_stats_msg *) oh;
451 return ofputil_lookup_openflow_message(&nxst_request_category,
453 ntohs(oh->length), typep);
457 ofputil_decode_nxst_reply(const struct ofp_header *oh,
458 const struct ofputil_msg_type **typep)
460 static const struct ofputil_msg_type nxst_replies[] = {
461 { OFPUTIL_NXST_FLOW_REPLY,
462 NXST_FLOW, "NXST_FLOW reply",
463 sizeof(struct nicira_stats_msg), 8 },
465 { OFPUTIL_NXST_AGGREGATE_REPLY,
466 NXST_AGGREGATE, "NXST_AGGREGATE reply",
467 sizeof(struct nx_aggregate_stats_reply), 0 },
470 static const struct ofputil_msg_category nxst_reply_category = {
471 "Nicira extension statistics reply",
472 nxst_replies, ARRAY_SIZE(nxst_replies),
473 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE)
476 const struct nicira_stats_msg *nsm;
479 error = check_nxstats_msg(oh);
484 nsm = (struct nicira_stats_msg *) oh;
485 return ofputil_lookup_openflow_message(&nxst_reply_category,
487 ntohs(oh->length), typep);
491 ofputil_decode_ofpst_request(const struct ofp_header *oh,
492 const struct ofputil_msg_type **typep)
494 static const struct ofputil_msg_type ofpst_requests[] = {
495 { OFPUTIL_OFPST_DESC_REQUEST,
496 OFPST_DESC, "OFPST_DESC request",
497 sizeof(struct ofp_stats_msg), 0 },
499 { OFPUTIL_OFPST_FLOW_REQUEST,
500 OFPST_FLOW, "OFPST_FLOW request",
501 sizeof(struct ofp_flow_stats_request), 0 },
503 { OFPUTIL_OFPST_AGGREGATE_REQUEST,
504 OFPST_AGGREGATE, "OFPST_AGGREGATE request",
505 sizeof(struct ofp_flow_stats_request), 0 },
507 { OFPUTIL_OFPST_TABLE_REQUEST,
508 OFPST_TABLE, "OFPST_TABLE request",
509 sizeof(struct ofp_stats_msg), 0 },
511 { OFPUTIL_OFPST_PORT_REQUEST,
512 OFPST_PORT, "OFPST_PORT request",
513 sizeof(struct ofp_port_stats_request), 0 },
515 { OFPUTIL_OFPST_QUEUE_REQUEST,
516 OFPST_QUEUE, "OFPST_QUEUE request",
517 sizeof(struct ofp_queue_stats_request), 0 },
520 OFPST_VENDOR, "OFPST_VENDOR request",
521 sizeof(struct ofp_vendor_stats_msg), 1 },
524 static const struct ofputil_msg_category ofpst_request_category = {
525 "OpenFlow statistics",
526 ofpst_requests, ARRAY_SIZE(ofpst_requests),
527 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
530 const struct ofp_stats_msg *request = (const struct ofp_stats_msg *) oh;
533 error = ofputil_lookup_openflow_message(&ofpst_request_category,
534 ntohs(request->type),
535 ntohs(oh->length), typep);
536 if (!error && request->type == htons(OFPST_VENDOR)) {
537 error = ofputil_decode_nxst_request(oh, typep);
543 ofputil_decode_ofpst_reply(const struct ofp_header *oh,
544 const struct ofputil_msg_type **typep)
546 static const struct ofputil_msg_type ofpst_replies[] = {
547 { OFPUTIL_OFPST_DESC_REPLY,
548 OFPST_DESC, "OFPST_DESC reply",
549 sizeof(struct ofp_desc_stats), 0 },
551 { OFPUTIL_OFPST_FLOW_REPLY,
552 OFPST_FLOW, "OFPST_FLOW reply",
553 sizeof(struct ofp_stats_msg), 1 },
555 { OFPUTIL_OFPST_AGGREGATE_REPLY,
556 OFPST_AGGREGATE, "OFPST_AGGREGATE reply",
557 sizeof(struct ofp_aggregate_stats_reply), 0 },
559 { OFPUTIL_OFPST_TABLE_REPLY,
560 OFPST_TABLE, "OFPST_TABLE reply",
561 sizeof(struct ofp_stats_msg), sizeof(struct ofp_table_stats) },
563 { OFPUTIL_OFPST_PORT_REPLY,
564 OFPST_PORT, "OFPST_PORT reply",
565 sizeof(struct ofp_stats_msg), sizeof(struct ofp_port_stats) },
567 { OFPUTIL_OFPST_QUEUE_REPLY,
568 OFPST_QUEUE, "OFPST_QUEUE reply",
569 sizeof(struct ofp_stats_msg), sizeof(struct ofp_queue_stats) },
572 OFPST_VENDOR, "OFPST_VENDOR reply",
573 sizeof(struct ofp_vendor_stats_msg), 1 },
576 static const struct ofputil_msg_category ofpst_reply_category = {
577 "OpenFlow statistics",
578 ofpst_replies, ARRAY_SIZE(ofpst_replies),
579 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT)
582 const struct ofp_stats_msg *reply = (const struct ofp_stats_msg *) oh;
585 error = ofputil_lookup_openflow_message(&ofpst_reply_category,
587 ntohs(oh->length), typep);
588 if (!error && reply->type == htons(OFPST_VENDOR)) {
589 error = ofputil_decode_nxst_reply(oh, typep);
594 /* Decodes the message type represented by 'oh'. Returns 0 if successful or
595 * an OpenFlow error code constructed with ofp_mkerr() on failure. Either
596 * way, stores in '*typep' a type structure that can be inspected with the
597 * ofputil_msg_type_*() functions.
599 * oh->length must indicate the correct length of the message (and must be at
600 * least sizeof(struct ofp_header)).
602 * Success indicates that 'oh' is at least as long as the minimum-length
603 * message of its type. */
605 ofputil_decode_msg_type(const struct ofp_header *oh,
606 const struct ofputil_msg_type **typep)
608 static const struct ofputil_msg_type ofpt_messages[] = {
609 { OFPUTIL_OFPT_HELLO,
610 OFPT_HELLO, "OFPT_HELLO",
611 sizeof(struct ofp_hello), 1 },
613 { OFPUTIL_OFPT_ERROR,
614 OFPT_ERROR, "OFPT_ERROR",
615 sizeof(struct ofp_error_msg), 1 },
617 { OFPUTIL_OFPT_ECHO_REQUEST,
618 OFPT_ECHO_REQUEST, "OFPT_ECHO_REQUEST",
619 sizeof(struct ofp_header), 1 },
621 { OFPUTIL_OFPT_ECHO_REPLY,
622 OFPT_ECHO_REPLY, "OFPT_ECHO_REPLY",
623 sizeof(struct ofp_header), 1 },
625 { OFPUTIL_OFPT_FEATURES_REQUEST,
626 OFPT_FEATURES_REQUEST, "OFPT_FEATURES_REQUEST",
627 sizeof(struct ofp_header), 0 },
629 { OFPUTIL_OFPT_FEATURES_REPLY,
630 OFPT_FEATURES_REPLY, "OFPT_FEATURES_REPLY",
631 sizeof(struct ofp_switch_features), sizeof(struct ofp_phy_port) },
633 { OFPUTIL_OFPT_GET_CONFIG_REQUEST,
634 OFPT_GET_CONFIG_REQUEST, "OFPT_GET_CONFIG_REQUEST",
635 sizeof(struct ofp_header), 0 },
637 { OFPUTIL_OFPT_GET_CONFIG_REPLY,
638 OFPT_GET_CONFIG_REPLY, "OFPT_GET_CONFIG_REPLY",
639 sizeof(struct ofp_switch_config), 0 },
641 { OFPUTIL_OFPT_SET_CONFIG,
642 OFPT_SET_CONFIG, "OFPT_SET_CONFIG",
643 sizeof(struct ofp_switch_config), 0 },
645 { OFPUTIL_OFPT_PACKET_IN,
646 OFPT_PACKET_IN, "OFPT_PACKET_IN",
647 offsetof(struct ofp_packet_in, data), 1 },
649 { OFPUTIL_OFPT_FLOW_REMOVED,
650 OFPT_FLOW_REMOVED, "OFPT_FLOW_REMOVED",
651 sizeof(struct ofp_flow_removed), 0 },
653 { OFPUTIL_OFPT_PORT_STATUS,
654 OFPT_PORT_STATUS, "OFPT_PORT_STATUS",
655 sizeof(struct ofp_port_status), 0 },
657 { OFPUTIL_OFPT_PACKET_OUT,
658 OFPT_PACKET_OUT, "OFPT_PACKET_OUT",
659 sizeof(struct ofp_packet_out), 1 },
661 { OFPUTIL_OFPT_FLOW_MOD,
662 OFPT_FLOW_MOD, "OFPT_FLOW_MOD",
663 sizeof(struct ofp_flow_mod), 1 },
665 { OFPUTIL_OFPT_PORT_MOD,
666 OFPT_PORT_MOD, "OFPT_PORT_MOD",
667 sizeof(struct ofp_port_mod), 0 },
670 OFPT_STATS_REQUEST, "OFPT_STATS_REQUEST",
671 sizeof(struct ofp_stats_msg), 1 },
674 OFPT_STATS_REPLY, "OFPT_STATS_REPLY",
675 sizeof(struct ofp_stats_msg), 1 },
677 { OFPUTIL_OFPT_BARRIER_REQUEST,
678 OFPT_BARRIER_REQUEST, "OFPT_BARRIER_REQUEST",
679 sizeof(struct ofp_header), 0 },
681 { OFPUTIL_OFPT_BARRIER_REPLY,
682 OFPT_BARRIER_REPLY, "OFPT_BARRIER_REPLY",
683 sizeof(struct ofp_header), 0 },
686 OFPT_VENDOR, "OFPT_VENDOR",
687 sizeof(struct ofp_vendor_header), 1 },
690 static const struct ofputil_msg_category ofpt_category = {
692 ofpt_messages, ARRAY_SIZE(ofpt_messages),
693 OFP_MKERR(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE)
698 error = ofputil_lookup_openflow_message(&ofpt_category, oh->type,
699 ntohs(oh->length), typep);
703 error = ofputil_decode_vendor(oh, typep);
706 case OFPT_STATS_REQUEST:
707 error = ofputil_decode_ofpst_request(oh, typep);
710 case OFPT_STATS_REPLY:
711 error = ofputil_decode_ofpst_reply(oh, typep);
718 static const struct ofputil_msg_type ofputil_invalid_type = {
720 0, "OFPUTIL_MSG_INVALID",
724 *typep = &ofputil_invalid_type;
729 /* Returns an OFPUTIL_* message type code for 'type'. */
730 enum ofputil_msg_code
731 ofputil_msg_type_code(const struct ofputil_msg_type *type)
739 ofputil_flow_format_is_valid(enum nx_flow_format flow_format)
741 switch (flow_format) {
742 case NXFF_OPENFLOW10:
751 ofputil_flow_format_to_string(enum nx_flow_format flow_format)
753 switch (flow_format) {
754 case NXFF_OPENFLOW10:
764 ofputil_flow_format_from_string(const char *s)
766 return (!strcmp(s, "openflow10") ? NXFF_OPENFLOW10
767 : !strcmp(s, "nxm") ? NXFF_NXM
772 regs_fully_wildcarded(const struct flow_wildcards *wc)
776 for (i = 0; i < FLOW_N_REGS; i++) {
777 if (wc->reg_masks[i] != 0) {
784 /* Returns the minimum nx_flow_format to use for sending 'rule' to a switch
785 * (e.g. to add or remove a flow). Only NXM can handle tunnel IDs, registers,
786 * or fixing the Ethernet multicast bit. Otherwise, it's better to use
787 * NXFF_OPENFLOW10 for backward compatibility. */
789 ofputil_min_flow_format(const struct cls_rule *rule)
791 const struct flow_wildcards *wc = &rule->wc;
793 BUILD_ASSERT_DECL(FLOW_WC_SEQ == 2);
795 /* Only NXM supports separately wildcards the Ethernet multicast bit. */
796 if (!(wc->wildcards & FWW_DL_DST) != !(wc->wildcards & FWW_ETH_MCAST)) {
800 /* Only NXM supports matching ARP hardware addresses. */
801 if (!(wc->wildcards & FWW_ARP_SHA) || !(wc->wildcards & FWW_ARP_THA)) {
805 /* Only NXM supports matching IPv6 traffic. */
806 if (!(wc->wildcards & FWW_DL_TYPE)
807 && (rule->flow.dl_type == htons(ETH_TYPE_IPV6))) {
811 /* Only NXM supports matching registers. */
812 if (!regs_fully_wildcarded(wc)) {
816 /* Only NXM supports matching tun_id. */
817 if (wc->tun_id_mask != htonll(0)) {
821 /* Other formats can express this rule. */
822 return NXFF_OPENFLOW10;
825 /* Returns an OpenFlow message that can be used to set the flow format to
828 ofputil_make_set_flow_format(enum nx_flow_format flow_format)
830 struct nxt_set_flow_format *sff;
833 sff = make_nxmsg(sizeof *sff, NXT_SET_FLOW_FORMAT, &msg);
834 sff->format = htonl(flow_format);
839 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
840 * extension on or off (according to 'flow_mod_table_id'). */
842 ofputil_make_flow_mod_table_id(bool flow_mod_table_id)
844 struct nxt_flow_mod_table_id *nfmti;
847 nfmti = make_nxmsg(sizeof *nfmti, NXT_FLOW_MOD_TABLE_ID, &msg);
848 nfmti->set = flow_mod_table_id;
852 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
853 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
856 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
857 * enabled, false otherwise.
859 * Does not validate the flow_mod actions. */
861 ofputil_decode_flow_mod(struct ofputil_flow_mod *fm,
862 const struct ofp_header *oh, bool flow_mod_table_id)
864 const struct ofputil_msg_type *type;
868 ofpbuf_use_const(&b, oh, ntohs(oh->length));
870 ofputil_decode_msg_type(oh, &type);
871 if (ofputil_msg_type_code(type) == OFPUTIL_OFPT_FLOW_MOD) {
872 /* Standard OpenFlow flow_mod. */
873 const struct ofp_flow_mod *ofm;
877 /* Dissect the message. */
878 ofm = ofpbuf_pull(&b, sizeof *ofm);
879 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
884 /* Set priority based on original wildcards. Normally we'd allow
885 * ofputil_cls_rule_from_match() to do this for us, but
886 * ofputil_normalize_rule() can put wildcards where the original flow
887 * didn't have them. */
888 priority = ntohs(ofm->priority);
889 if (!(ofm->match.wildcards & htonl(OFPFW_ALL))) {
890 priority = UINT16_MAX;
893 /* Translate the rule. */
894 ofputil_cls_rule_from_match(&ofm->match, priority, &fm->cr);
895 ofputil_normalize_rule(&fm->cr, NXFF_OPENFLOW10);
897 /* Translate the message. */
898 fm->cookie = ofm->cookie;
899 command = ntohs(ofm->command);
900 fm->idle_timeout = ntohs(ofm->idle_timeout);
901 fm->hard_timeout = ntohs(ofm->hard_timeout);
902 fm->buffer_id = ntohl(ofm->buffer_id);
903 fm->out_port = ntohs(ofm->out_port);
904 fm->flags = ntohs(ofm->flags);
905 } else if (ofputil_msg_type_code(type) == OFPUTIL_NXT_FLOW_MOD) {
906 /* Nicira extended flow_mod. */
907 const struct nx_flow_mod *nfm;
910 /* Dissect the message. */
911 nfm = ofpbuf_pull(&b, sizeof *nfm);
912 error = nx_pull_match(&b, ntohs(nfm->match_len), ntohs(nfm->priority),
917 error = ofputil_pull_actions(&b, b.size, &fm->actions, &fm->n_actions);
922 /* Translate the message. */
923 fm->cookie = nfm->cookie;
924 command = ntohs(nfm->command);
925 fm->idle_timeout = ntohs(nfm->idle_timeout);
926 fm->hard_timeout = ntohs(nfm->hard_timeout);
927 fm->buffer_id = ntohl(nfm->buffer_id);
928 fm->out_port = ntohs(nfm->out_port);
929 fm->flags = ntohs(nfm->flags);
934 if (flow_mod_table_id) {
935 fm->command = command & 0xff;
936 fm->table_id = command >> 8;
938 fm->command = command;
945 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
946 * 'flow_format' and returns the message.
948 * 'flow_mod_table_id' should be true if the NXT_FLOW_MOD_TABLE_ID extension is
949 * enabled, false otherwise. */
951 ofputil_encode_flow_mod(const struct ofputil_flow_mod *fm,
952 enum nx_flow_format flow_format,
953 bool flow_mod_table_id)
955 size_t actions_len = fm->n_actions * sizeof *fm->actions;
959 command = (flow_mod_table_id
960 ? (fm->command & 0xff) | (fm->table_id << 8)
963 if (flow_format == NXFF_OPENFLOW10) {
964 struct ofp_flow_mod *ofm;
966 msg = ofpbuf_new(sizeof *ofm + actions_len);
967 ofm = put_openflow(sizeof *ofm, OFPT_FLOW_MOD, msg);
968 ofputil_cls_rule_to_match(&fm->cr, &ofm->match);
969 ofm->cookie = fm->cookie;
970 ofm->command = htons(command);
971 ofm->idle_timeout = htons(fm->idle_timeout);
972 ofm->hard_timeout = htons(fm->hard_timeout);
973 ofm->priority = htons(fm->cr.priority);
974 ofm->buffer_id = htonl(fm->buffer_id);
975 ofm->out_port = htons(fm->out_port);
976 ofm->flags = htons(fm->flags);
977 } else if (flow_format == NXFF_NXM) {
978 struct nx_flow_mod *nfm;
981 msg = ofpbuf_new(sizeof *nfm + NXM_TYPICAL_LEN + actions_len);
982 put_nxmsg(sizeof *nfm, NXT_FLOW_MOD, msg);
983 match_len = nx_put_match(msg, &fm->cr);
986 nfm->cookie = fm->cookie;
987 nfm->command = htons(command);
988 nfm->idle_timeout = htons(fm->idle_timeout);
989 nfm->hard_timeout = htons(fm->hard_timeout);
990 nfm->priority = htons(fm->cr.priority);
991 nfm->buffer_id = htonl(fm->buffer_id);
992 nfm->out_port = htons(fm->out_port);
993 nfm->flags = htons(fm->flags);
994 nfm->match_len = htons(match_len);
999 ofpbuf_put(msg, fm->actions, actions_len);
1000 update_openflow_length(msg);
1005 ofputil_decode_ofpst_flow_request(struct ofputil_flow_stats_request *fsr,
1006 const struct ofp_header *oh,
1009 const struct ofp_flow_stats_request *ofsr =
1010 (const struct ofp_flow_stats_request *) oh;
1012 fsr->aggregate = aggregate;
1013 ofputil_cls_rule_from_match(&ofsr->match, 0, &fsr->match);
1014 fsr->out_port = ntohs(ofsr->out_port);
1015 fsr->table_id = ofsr->table_id;
1021 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request *fsr,
1022 const struct ofp_header *oh,
1025 const struct nx_flow_stats_request *nfsr;
1029 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1031 nfsr = ofpbuf_pull(&b, sizeof *nfsr);
1032 error = nx_pull_match(&b, ntohs(nfsr->match_len), 0, &fsr->match);
1037 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1040 fsr->aggregate = aggregate;
1041 fsr->out_port = ntohs(nfsr->out_port);
1042 fsr->table_id = nfsr->table_id;
1047 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
1048 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
1049 * successful, otherwise an OpenFlow error code. */
1051 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *fsr,
1052 const struct ofp_header *oh)
1054 const struct ofputil_msg_type *type;
1058 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1060 ofputil_decode_msg_type(oh, &type);
1061 code = ofputil_msg_type_code(type);
1063 case OFPUTIL_OFPST_FLOW_REQUEST:
1064 return ofputil_decode_ofpst_flow_request(fsr, oh, false);
1066 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1067 return ofputil_decode_ofpst_flow_request(fsr, oh, true);
1069 case OFPUTIL_NXST_FLOW_REQUEST:
1070 return ofputil_decode_nxst_flow_request(fsr, oh, false);
1072 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1073 return ofputil_decode_nxst_flow_request(fsr, oh, true);
1076 /* Hey, the caller lied. */
1081 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
1082 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
1083 * 'flow_format', and returns the message. */
1085 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request *fsr,
1086 enum nx_flow_format flow_format)
1090 if (flow_format == NXFF_OPENFLOW10) {
1091 struct ofp_flow_stats_request *ofsr;
1094 type = fsr->aggregate ? OFPST_AGGREGATE : OFPST_FLOW;
1095 ofsr = ofputil_make_stats_request(sizeof *ofsr, type, 0, &msg);
1096 ofputil_cls_rule_to_match(&fsr->match, &ofsr->match);
1097 ofsr->table_id = fsr->table_id;
1098 ofsr->out_port = htons(fsr->out_port);
1099 } else if (flow_format == NXFF_NXM) {
1100 struct nx_flow_stats_request *nfsr;
1104 subtype = fsr->aggregate ? NXST_AGGREGATE : NXST_FLOW;
1105 ofputil_make_stats_request(sizeof *nfsr, OFPST_VENDOR, subtype, &msg);
1106 match_len = nx_put_match(msg, &fsr->match);
1109 nfsr->out_port = htons(fsr->out_port);
1110 nfsr->match_len = htons(match_len);
1111 nfsr->table_id = fsr->table_id;
1119 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
1120 * ofputil_flow_stats in 'fs'.
1122 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
1123 * OpenFlow message. Calling this function multiple times for a single 'msg'
1124 * iterates through the replies. The caller must initially leave 'msg''s layer
1125 * pointers null and not modify them between calls.
1127 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1128 * otherwise a positive errno value. */
1130 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *fs,
1133 const struct ofputil_msg_type *type;
1136 ofputil_decode_msg_type(msg->l2 ? msg->l2 : msg->data, &type);
1137 code = ofputil_msg_type_code(type);
1139 msg->l2 = msg->data;
1140 if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1141 ofpbuf_pull(msg, sizeof(struct ofp_stats_msg));
1142 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1143 ofpbuf_pull(msg, sizeof(struct nicira_stats_msg));
1151 } else if (code == OFPUTIL_OFPST_FLOW_REPLY) {
1152 const struct ofp_flow_stats *ofs;
1155 ofs = ofpbuf_try_pull(msg, sizeof *ofs);
1157 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply has %zu leftover "
1158 "bytes at end", msg->size);
1162 length = ntohs(ofs->length);
1163 if (length < sizeof *ofs) {
1164 VLOG_WARN_RL(&bad_ofmsg_rl, "OFPST_FLOW reply claims invalid "
1165 "length %zu", length);
1169 if (ofputil_pull_actions(msg, length - sizeof *ofs,
1170 &fs->actions, &fs->n_actions)) {
1174 fs->cookie = get_32aligned_be64(&ofs->cookie);
1175 ofputil_cls_rule_from_match(&ofs->match, ntohs(ofs->priority),
1177 fs->table_id = ofs->table_id;
1178 fs->duration_sec = ntohl(ofs->duration_sec);
1179 fs->duration_nsec = ntohl(ofs->duration_nsec);
1180 fs->idle_timeout = ntohs(ofs->idle_timeout);
1181 fs->hard_timeout = ntohs(ofs->hard_timeout);
1182 fs->packet_count = ntohll(get_32aligned_be64(&ofs->packet_count));
1183 fs->byte_count = ntohll(get_32aligned_be64(&ofs->byte_count));
1184 } else if (code == OFPUTIL_NXST_FLOW_REPLY) {
1185 const struct nx_flow_stats *nfs;
1186 size_t match_len, length;
1188 nfs = ofpbuf_try_pull(msg, sizeof *nfs);
1190 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply has %zu leftover "
1191 "bytes at end", msg->size);
1195 length = ntohs(nfs->length);
1196 match_len = ntohs(nfs->match_len);
1197 if (length < sizeof *nfs + ROUND_UP(match_len, 8)) {
1198 VLOG_WARN_RL(&bad_ofmsg_rl, "NXST_FLOW reply with match_len=%zu "
1199 "claims invalid length %zu", match_len, length);
1202 if (nx_pull_match(msg, match_len, ntohs(nfs->priority), &fs->rule)) {
1206 if (ofputil_pull_actions(msg,
1207 length - sizeof *nfs - ROUND_UP(match_len, 8),
1208 &fs->actions, &fs->n_actions)) {
1212 fs->cookie = nfs->cookie;
1213 fs->table_id = nfs->table_id;
1214 fs->duration_sec = ntohl(nfs->duration_sec);
1215 fs->duration_nsec = ntohl(nfs->duration_nsec);
1216 fs->idle_timeout = ntohs(nfs->idle_timeout);
1217 fs->hard_timeout = ntohs(nfs->hard_timeout);
1218 fs->packet_count = ntohll(nfs->packet_count);
1219 fs->byte_count = ntohll(nfs->byte_count);
1227 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
1229 * We use this in situations where OVS internally uses UINT64_MAX to mean
1230 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
1232 unknown_to_zero(uint64_t count)
1234 return count != UINT64_MAX ? count : 0;
1237 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
1238 * those already present in the list of ofpbufs in 'replies'. 'replies' should
1239 * have been initialized with ofputil_start_stats_reply(). */
1241 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *fs,
1242 struct list *replies)
1244 size_t act_len = fs->n_actions * sizeof *fs->actions;
1245 const struct ofp_stats_msg *osm;
1247 osm = ofpbuf_from_list(list_back(replies))->data;
1248 if (osm->type == htons(OFPST_FLOW)) {
1249 size_t len = offsetof(struct ofp_flow_stats, actions) + act_len;
1250 struct ofp_flow_stats *ofs;
1252 ofs = ofputil_append_stats_reply(len, replies);
1253 ofs->length = htons(len);
1254 ofs->table_id = fs->table_id;
1256 ofputil_cls_rule_to_match(&fs->rule, &ofs->match);
1257 ofs->duration_sec = htonl(fs->duration_sec);
1258 ofs->duration_nsec = htonl(fs->duration_nsec);
1259 ofs->priority = htons(fs->rule.priority);
1260 ofs->idle_timeout = htons(fs->idle_timeout);
1261 ofs->hard_timeout = htons(fs->hard_timeout);
1262 memset(ofs->pad2, 0, sizeof ofs->pad2);
1263 put_32aligned_be64(&ofs->cookie, fs->cookie);
1264 put_32aligned_be64(&ofs->packet_count,
1265 htonll(unknown_to_zero(fs->packet_count)));
1266 put_32aligned_be64(&ofs->byte_count,
1267 htonll(unknown_to_zero(fs->byte_count)));
1268 memcpy(ofs->actions, fs->actions, act_len);
1269 } else if (osm->type == htons(OFPST_VENDOR)) {
1270 struct nx_flow_stats *nfs;
1274 msg = ofputil_reserve_stats_reply(
1275 sizeof *nfs + NXM_MAX_LEN + act_len, replies);
1276 start_len = msg->size;
1278 nfs = ofpbuf_put_uninit(msg, sizeof *nfs);
1279 nfs->table_id = fs->table_id;
1281 nfs->duration_sec = htonl(fs->duration_sec);
1282 nfs->duration_nsec = htonl(fs->duration_nsec);
1283 nfs->priority = htons(fs->rule.priority);
1284 nfs->idle_timeout = htons(fs->idle_timeout);
1285 nfs->hard_timeout = htons(fs->hard_timeout);
1286 nfs->match_len = htons(nx_put_match(msg, &fs->rule));
1287 memset(nfs->pad2, 0, sizeof nfs->pad2);
1288 nfs->cookie = fs->cookie;
1289 nfs->packet_count = htonll(fs->packet_count);
1290 nfs->byte_count = htonll(fs->byte_count);
1291 ofpbuf_put(msg, fs->actions, act_len);
1292 nfs->length = htons(msg->size - start_len);
1298 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
1299 * NXST_AGGREGATE reply according to 'flow_format', and returns the message. */
1301 ofputil_encode_aggregate_stats_reply(
1302 const struct ofputil_aggregate_stats *stats,
1303 const struct ofp_stats_msg *request)
1307 if (request->type == htons(OFPST_AGGREGATE)) {
1308 struct ofp_aggregate_stats_reply *asr;
1310 asr = ofputil_make_stats_reply(sizeof *asr, request, &msg);
1311 put_32aligned_be64(&asr->packet_count,
1312 htonll(unknown_to_zero(stats->packet_count)));
1313 put_32aligned_be64(&asr->byte_count,
1314 htonll(unknown_to_zero(stats->byte_count)));
1315 asr->flow_count = htonl(stats->flow_count);
1316 } else if (request->type == htons(OFPST_VENDOR)) {
1317 struct nx_aggregate_stats_reply *nasr;
1319 nasr = ofputil_make_stats_reply(sizeof *nasr, request, &msg);
1320 assert(nasr->nsm.subtype == htonl(NXST_AGGREGATE));
1321 nasr->packet_count = htonll(stats->packet_count);
1322 nasr->byte_count = htonll(stats->byte_count);
1323 nasr->flow_count = htonl(stats->flow_count);
1331 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
1332 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
1333 * an OpenFlow error code. */
1335 ofputil_decode_flow_removed(struct ofputil_flow_removed *fr,
1336 const struct ofp_header *oh)
1338 const struct ofputil_msg_type *type;
1339 enum ofputil_msg_code code;
1341 ofputil_decode_msg_type(oh, &type);
1342 code = ofputil_msg_type_code(type);
1343 if (code == OFPUTIL_OFPT_FLOW_REMOVED) {
1344 const struct ofp_flow_removed *ofr;
1346 ofr = (const struct ofp_flow_removed *) oh;
1347 ofputil_cls_rule_from_match(&ofr->match, ntohs(ofr->priority),
1349 fr->cookie = ofr->cookie;
1350 fr->reason = ofr->reason;
1351 fr->duration_sec = ntohl(ofr->duration_sec);
1352 fr->duration_nsec = ntohl(ofr->duration_nsec);
1353 fr->idle_timeout = ntohs(ofr->idle_timeout);
1354 fr->packet_count = ntohll(ofr->packet_count);
1355 fr->byte_count = ntohll(ofr->byte_count);
1356 } else if (code == OFPUTIL_NXT_FLOW_REMOVED) {
1357 struct nx_flow_removed *nfr;
1361 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1363 nfr = ofpbuf_pull(&b, sizeof *nfr);
1364 error = nx_pull_match(&b, ntohs(nfr->match_len), ntohs(nfr->priority),
1370 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
1373 fr->cookie = nfr->cookie;
1374 fr->reason = nfr->reason;
1375 fr->duration_sec = ntohl(nfr->duration_sec);
1376 fr->duration_nsec = ntohl(nfr->duration_nsec);
1377 fr->idle_timeout = ntohs(nfr->idle_timeout);
1378 fr->packet_count = ntohll(nfr->packet_count);
1379 fr->byte_count = ntohll(nfr->byte_count);
1387 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
1388 * NXT_FLOW_REMOVED message 'oh' according to 'flow_format', and returns the
1391 ofputil_encode_flow_removed(const struct ofputil_flow_removed *fr,
1392 enum nx_flow_format flow_format)
1396 if (flow_format == NXFF_OPENFLOW10) {
1397 struct ofp_flow_removed *ofr;
1399 ofr = make_openflow_xid(sizeof *ofr, OFPT_FLOW_REMOVED, htonl(0),
1401 ofputil_cls_rule_to_match(&fr->rule, &ofr->match);
1402 ofr->cookie = fr->cookie;
1403 ofr->priority = htons(fr->rule.priority);
1404 ofr->reason = fr->reason;
1405 ofr->duration_sec = htonl(fr->duration_sec);
1406 ofr->duration_nsec = htonl(fr->duration_nsec);
1407 ofr->idle_timeout = htons(fr->idle_timeout);
1408 ofr->packet_count = htonll(unknown_to_zero(fr->packet_count));
1409 ofr->byte_count = htonll(unknown_to_zero(fr->byte_count));
1410 } else if (flow_format == NXFF_NXM) {
1411 struct nx_flow_removed *nfr;
1414 make_nxmsg_xid(sizeof *nfr, NXT_FLOW_REMOVED, htonl(0), &msg);
1415 match_len = nx_put_match(msg, &fr->rule);
1418 nfr->cookie = fr->cookie;
1419 nfr->priority = htons(fr->rule.priority);
1420 nfr->reason = fr->reason;
1421 nfr->duration_sec = htonl(fr->duration_sec);
1422 nfr->duration_nsec = htonl(fr->duration_nsec);
1423 nfr->idle_timeout = htons(fr->idle_timeout);
1424 nfr->match_len = htons(match_len);
1425 nfr->packet_count = htonll(fr->packet_count);
1426 nfr->byte_count = htonll(fr->byte_count);
1434 /* Converts abstract ofputil_packet_in 'pin' into an OFPT_PACKET_IN message
1435 * and returns the message.
1437 * If 'rw_packet' is NULL, the caller takes ownership of the newly allocated
1440 * If 'rw_packet' is nonnull, then it must contain the same data as
1441 * pin->packet. 'rw_packet' is allowed to be the same ofpbuf as pin->packet.
1442 * It is modified in-place into an OFPT_PACKET_IN message according to 'pin',
1443 * and then ofputil_encode_packet_in() returns 'rw_packet'. If 'rw_packet' has
1444 * enough headroom to insert a "struct ofp_packet_in", this is more efficient
1445 * than ofputil_encode_packet_in() because it does not copy the packet
1448 ofputil_encode_packet_in(const struct ofputil_packet_in *pin,
1449 struct ofpbuf *rw_packet)
1451 int total_len = pin->packet->size;
1452 struct ofp_packet_in opi;
1455 if (pin->send_len < rw_packet->size) {
1456 rw_packet->size = pin->send_len;
1459 rw_packet = ofpbuf_clone_data_with_headroom(
1460 pin->packet->data, MIN(pin->send_len, pin->packet->size),
1461 offsetof(struct ofp_packet_in, data));
1464 /* Add OFPT_PACKET_IN. */
1465 memset(&opi, 0, sizeof opi);
1466 opi.header.version = OFP_VERSION;
1467 opi.header.type = OFPT_PACKET_IN;
1468 opi.total_len = htons(total_len);
1469 opi.in_port = htons(pin->in_port);
1470 opi.reason = pin->reason;
1471 opi.buffer_id = htonl(pin->buffer_id);
1472 ofpbuf_push(rw_packet, &opi, offsetof(struct ofp_packet_in, data));
1473 update_openflow_length(rw_packet);
1478 /* Returns a string representing the message type of 'type'. The string is the
1479 * enumeration constant for the type, e.g. "OFPT_HELLO". For statistics
1480 * messages, the constant is followed by "request" or "reply",
1481 * e.g. "OFPST_AGGREGATE reply". */
1483 ofputil_msg_type_name(const struct ofputil_msg_type *type)
1488 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1489 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1490 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
1493 * The caller is responsible for freeing '*bufferp' when it is no longer
1496 * The OpenFlow header length is initially set to 'openflow_len'; if the
1497 * message is later extended, the length should be updated with
1498 * update_openflow_length() before sending.
1500 * Returns the header. */
1502 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
1504 *bufferp = ofpbuf_new(openflow_len);
1505 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
1508 /* Similar to make_openflow() but creates a Nicira vendor extension message
1509 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1511 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
1513 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
1516 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
1517 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
1518 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
1521 * The caller is responsible for freeing '*bufferp' when it is no longer
1524 * The OpenFlow header length is initially set to 'openflow_len'; if the
1525 * message is later extended, the length should be updated with
1526 * update_openflow_length() before sending.
1528 * Returns the header. */
1530 make_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1531 struct ofpbuf **bufferp)
1533 *bufferp = ofpbuf_new(openflow_len);
1534 return put_openflow_xid(openflow_len, type, xid, *bufferp);
1537 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
1538 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1540 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1541 struct ofpbuf **bufferp)
1543 *bufferp = ofpbuf_new(openflow_len);
1544 return put_nxmsg_xid(openflow_len, subtype, xid, *bufferp);
1547 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1548 * with the given 'type' and an arbitrary transaction id. Allocated bytes
1549 * beyond the header, if any, are zeroed.
1551 * The OpenFlow header length is initially set to 'openflow_len'; if the
1552 * message is later extended, the length should be updated with
1553 * update_openflow_length() before sending.
1555 * Returns the header. */
1557 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
1559 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
1562 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
1563 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
1564 * the header, if any, are zeroed.
1566 * The OpenFlow header length is initially set to 'openflow_len'; if the
1567 * message is later extended, the length should be updated with
1568 * update_openflow_length() before sending.
1570 * Returns the header. */
1572 put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
1573 struct ofpbuf *buffer)
1575 struct ofp_header *oh;
1577 assert(openflow_len >= sizeof *oh);
1578 assert(openflow_len <= UINT16_MAX);
1580 oh = ofpbuf_put_uninit(buffer, openflow_len);
1581 oh->version = OFP_VERSION;
1583 oh->length = htons(openflow_len);
1585 memset(oh + 1, 0, openflow_len - sizeof *oh);
1589 /* Similar to put_openflow() but append a Nicira vendor extension message with
1590 * the specific 'subtype'. 'subtype' should be in host byte order. */
1592 put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *buffer)
1594 return put_nxmsg_xid(openflow_len, subtype, alloc_xid(), buffer);
1597 /* Similar to put_openflow_xid() but append a Nicira vendor extension message
1598 * with the specific 'subtype'. 'subtype' should be in host byte order. */
1600 put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
1601 struct ofpbuf *buffer)
1603 struct nicira_header *nxh;
1605 nxh = put_openflow_xid(openflow_len, OFPT_VENDOR, xid, buffer);
1606 nxh->vendor = htonl(NX_VENDOR_ID);
1607 nxh->subtype = htonl(subtype);
1611 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
1612 * 'buffer->size'. */
1614 update_openflow_length(struct ofpbuf *buffer)
1616 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
1617 oh->length = htons(buffer->size);
1621 put_stats__(ovs_be32 xid, uint8_t ofp_type,
1622 ovs_be16 ofpst_type, ovs_be32 nxst_subtype,
1625 if (ofpst_type == htons(OFPST_VENDOR)) {
1626 struct nicira_stats_msg *nsm;
1628 nsm = put_openflow_xid(sizeof *nsm, ofp_type, xid, msg);
1629 nsm->vsm.osm.type = ofpst_type;
1630 nsm->vsm.vendor = htonl(NX_VENDOR_ID);
1631 nsm->subtype = nxst_subtype;
1633 struct ofp_stats_msg *osm;
1635 osm = put_openflow_xid(sizeof *osm, ofp_type, xid, msg);
1636 osm->type = ofpst_type;
1640 /* Creates a statistics request message with total length 'openflow_len'
1641 * (including all headers) and the given 'ofpst_type', and stores the buffer
1642 * containing the new message in '*bufferp'. If 'ofpst_type' is OFPST_VENDOR
1643 * then 'nxst_subtype' is used as the Nicira vendor extension statistics
1644 * subtype (otherwise 'nxst_subtype' is ignored).
1646 * Initializes bytes following the headers to all-bits-zero.
1648 * Returns the first byte of the new message. */
1650 ofputil_make_stats_request(size_t openflow_len, uint16_t ofpst_type,
1651 uint32_t nxst_subtype, struct ofpbuf **bufferp)
1655 msg = *bufferp = ofpbuf_new(openflow_len);
1656 put_stats__(alloc_xid(), OFPT_STATS_REQUEST,
1657 htons(ofpst_type), htonl(nxst_subtype), msg);
1658 ofpbuf_padto(msg, openflow_len);
1664 put_stats_reply__(const struct ofp_stats_msg *request, struct ofpbuf *msg)
1666 assert(request->header.type == OFPT_STATS_REQUEST ||
1667 request->header.type == OFPT_STATS_REPLY);
1668 put_stats__(request->header.xid, OFPT_STATS_REPLY, request->type,
1669 (request->type != htons(OFPST_VENDOR)
1671 : ((const struct nicira_stats_msg *) request)->subtype),
1675 /* Creates a statistics reply message with total length 'openflow_len'
1676 * (including all headers) and the same type (either a standard OpenFlow
1677 * statistics type or a Nicira extension type and subtype) as 'request', and
1678 * stores the buffer containing the new message in '*bufferp'.
1680 * Initializes bytes following the headers to all-bits-zero.
1682 * Returns the first byte of the new message. */
1684 ofputil_make_stats_reply(size_t openflow_len,
1685 const struct ofp_stats_msg *request,
1686 struct ofpbuf **bufferp)
1690 msg = *bufferp = ofpbuf_new(openflow_len);
1691 put_stats_reply__(request, msg);
1692 ofpbuf_padto(msg, openflow_len);
1697 /* Initializes 'replies' as a list of ofpbufs that will contain a series of
1698 * replies to 'request', which should be an OpenFlow or Nicira extension
1699 * statistics request. Initially 'replies' will have a single reply message
1700 * that has only a header. The functions ofputil_reserve_stats_reply() and
1701 * ofputil_append_stats_reply() may be used to add to the reply. */
1703 ofputil_start_stats_reply(const struct ofp_stats_msg *request,
1704 struct list *replies)
1708 msg = ofpbuf_new(1024);
1709 put_stats_reply__(request, msg);
1712 list_push_back(replies, &msg->list_node);
1715 /* Prepares to append up to 'len' bytes to the series of statistics replies in
1716 * 'replies', which should have been initialized with
1717 * ofputil_start_stats_reply(). Returns an ofpbuf with at least 'len' bytes of
1718 * tailroom. (The 'len' bytes have not actually be allocated; the caller must
1719 * do so with e.g. ofpbuf_put_uninit().) */
1721 ofputil_reserve_stats_reply(size_t len, struct list *replies)
1723 struct ofpbuf *msg = ofpbuf_from_list(list_back(replies));
1724 struct ofp_stats_msg *osm = msg->data;
1726 if (msg->size + len <= UINT16_MAX) {
1727 ofpbuf_prealloc_tailroom(msg, len);
1729 osm->flags |= htons(OFPSF_REPLY_MORE);
1731 msg = ofpbuf_new(MAX(1024, sizeof(struct nicira_stats_msg) + len));
1732 put_stats_reply__(osm, msg);
1733 list_push_back(replies, &msg->list_node);
1738 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
1739 * returns the first byte. */
1741 ofputil_append_stats_reply(size_t len, struct list *replies)
1743 return ofpbuf_put_uninit(ofputil_reserve_stats_reply(len, replies), len);
1746 /* Returns the first byte past the ofp_stats_msg header in 'oh'. */
1748 ofputil_stats_body(const struct ofp_header *oh)
1750 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1751 return (const struct ofp_stats_msg *) oh + 1;
1754 /* Returns the number of bytes past the ofp_stats_msg header in 'oh'. */
1756 ofputil_stats_body_len(const struct ofp_header *oh)
1758 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1759 return ntohs(oh->length) - sizeof(struct ofp_stats_msg);
1762 /* Returns the first byte past the nicira_stats_msg header in 'oh'. */
1764 ofputil_nxstats_body(const struct ofp_header *oh)
1766 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1767 return ((const struct nicira_stats_msg *) oh) + 1;
1770 /* Returns the number of bytes past the nicira_stats_msg header in 'oh'. */
1772 ofputil_nxstats_body_len(const struct ofp_header *oh)
1774 assert(oh->type == OFPT_STATS_REQUEST || oh->type == OFPT_STATS_REPLY);
1775 return ntohs(oh->length) - sizeof(struct nicira_stats_msg);
1779 make_flow_mod(uint16_t command, const struct cls_rule *rule,
1782 struct ofp_flow_mod *ofm;
1783 size_t size = sizeof *ofm + actions_len;
1784 struct ofpbuf *out = ofpbuf_new(size);
1785 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
1786 ofm->header.version = OFP_VERSION;
1787 ofm->header.type = OFPT_FLOW_MOD;
1788 ofm->header.length = htons(size);
1790 ofm->priority = htons(MIN(rule->priority, UINT16_MAX));
1791 ofputil_cls_rule_to_match(rule, &ofm->match);
1792 ofm->command = htons(command);
1797 make_add_flow(const struct cls_rule *rule, uint32_t buffer_id,
1798 uint16_t idle_timeout, size_t actions_len)
1800 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, rule, actions_len);
1801 struct ofp_flow_mod *ofm = out->data;
1802 ofm->idle_timeout = htons(idle_timeout);
1803 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
1804 ofm->buffer_id = htonl(buffer_id);
1809 make_del_flow(const struct cls_rule *rule)
1811 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, rule, 0);
1812 struct ofp_flow_mod *ofm = out->data;
1813 ofm->out_port = htons(OFPP_NONE);
1818 make_add_simple_flow(const struct cls_rule *rule,
1819 uint32_t buffer_id, uint16_t out_port,
1820 uint16_t idle_timeout)
1822 if (out_port != OFPP_NONE) {
1823 struct ofp_action_output *oao;
1824 struct ofpbuf *buffer;
1826 buffer = make_add_flow(rule, buffer_id, idle_timeout, sizeof *oao);
1827 ofputil_put_OFPAT_OUTPUT(buffer)->port = htons(out_port);
1830 return make_add_flow(rule, buffer_id, idle_timeout, 0);
1835 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
1836 const struct ofpbuf *payload, int max_send_len)
1838 struct ofp_packet_in *opi;
1842 send_len = MIN(max_send_len, payload->size);
1843 buf = ofpbuf_new(sizeof *opi + send_len);
1844 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
1845 OFPT_PACKET_IN, 0, buf);
1846 opi->buffer_id = htonl(buffer_id);
1847 opi->total_len = htons(payload->size);
1848 opi->in_port = htons(in_port);
1849 opi->reason = reason;
1850 ofpbuf_put(buf, payload->data, send_len);
1851 update_openflow_length(buf);
1857 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
1859 const struct ofp_action_header *actions, size_t n_actions)
1861 size_t actions_len = n_actions * sizeof *actions;
1862 struct ofp_packet_out *opo;
1863 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
1864 struct ofpbuf *out = ofpbuf_new(size);
1866 opo = ofpbuf_put_uninit(out, sizeof *opo);
1867 opo->header.version = OFP_VERSION;
1868 opo->header.type = OFPT_PACKET_OUT;
1869 opo->header.length = htons(size);
1870 opo->header.xid = htonl(0);
1871 opo->buffer_id = htonl(buffer_id);
1872 opo->in_port = htons(in_port);
1873 opo->actions_len = htons(actions_len);
1874 ofpbuf_put(out, actions, actions_len);
1876 ofpbuf_put(out, packet->data, packet->size);
1882 make_unbuffered_packet_out(const struct ofpbuf *packet,
1883 uint16_t in_port, uint16_t out_port)
1885 struct ofp_action_output action;
1886 action.type = htons(OFPAT_OUTPUT);
1887 action.len = htons(sizeof action);
1888 action.port = htons(out_port);
1889 return make_packet_out(packet, UINT32_MAX, in_port,
1890 (struct ofp_action_header *) &action, 1);
1894 make_buffered_packet_out(uint32_t buffer_id,
1895 uint16_t in_port, uint16_t out_port)
1897 if (out_port != OFPP_NONE) {
1898 struct ofp_action_output action;
1899 action.type = htons(OFPAT_OUTPUT);
1900 action.len = htons(sizeof action);
1901 action.port = htons(out_port);
1902 return make_packet_out(NULL, buffer_id, in_port,
1903 (struct ofp_action_header *) &action, 1);
1905 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
1909 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
1911 make_echo_request(void)
1913 struct ofp_header *rq;
1914 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
1915 rq = ofpbuf_put_uninit(out, sizeof *rq);
1916 rq->version = OFP_VERSION;
1917 rq->type = OFPT_ECHO_REQUEST;
1918 rq->length = htons(sizeof *rq);
1923 /* Creates and returns an OFPT_ECHO_REPLY message matching the
1924 * OFPT_ECHO_REQUEST message in 'rq'. */
1926 make_echo_reply(const struct ofp_header *rq)
1928 size_t size = ntohs(rq->length);
1929 struct ofpbuf *out = ofpbuf_new(size);
1930 struct ofp_header *reply = ofpbuf_put(out, rq, size);
1931 reply->type = OFPT_ECHO_REPLY;
1935 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
1936 * that the switch will never have more than 'max_ports' ports. Returns 0 if
1937 * 'port' is valid, otherwise an ofp_mkerr() return code. */
1939 ofputil_check_output_port(uint16_t port, int max_ports)
1947 case OFPP_CONTROLLER:
1952 if (port < max_ports) {
1955 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
1959 #define OFPUTIL_NAMED_PORTS \
1960 OFPUTIL_NAMED_PORT(IN_PORT) \
1961 OFPUTIL_NAMED_PORT(TABLE) \
1962 OFPUTIL_NAMED_PORT(NORMAL) \
1963 OFPUTIL_NAMED_PORT(FLOOD) \
1964 OFPUTIL_NAMED_PORT(ALL) \
1965 OFPUTIL_NAMED_PORT(CONTROLLER) \
1966 OFPUTIL_NAMED_PORT(LOCAL) \
1967 OFPUTIL_NAMED_PORT(NONE)
1969 /* Checks whether 's' is the string representation of an OpenFlow port number,
1970 * either as an integer or a string name (e.g. "LOCAL"). If it is, stores the
1971 * number in '*port' and returns true. Otherwise, returns false. */
1973 ofputil_port_from_string(const char *name, uint16_t *port)
1979 static const struct pair pairs[] = {
1980 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
1982 #undef OFPUTIL_NAMED_PORT
1984 static const int n_pairs = ARRAY_SIZE(pairs);
1987 if (str_to_int(name, 0, &i) && i >= 0 && i < UINT16_MAX) {
1992 for (i = 0; i < n_pairs; i++) {
1993 if (!strcasecmp(name, pairs[i].name)) {
1994 *port = pairs[i].value;
2001 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
2002 * Most ports' string representation is just the port number, but for special
2003 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
2005 ofputil_format_port(uint16_t port, struct ds *s)
2010 #define OFPUTIL_NAMED_PORT(NAME) case OFPP_##NAME: name = #NAME; break;
2012 #undef OFPUTIL_NAMED_PORT
2015 ds_put_format(s, "%"PRIu16, port);
2018 ds_put_cstr(s, name);
2022 check_resubmit_table(const struct nx_action_resubmit *nar)
2024 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
2025 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2031 check_output_reg(const struct nx_action_output_reg *naor,
2032 const struct flow *flow)
2036 for (i = 0; i < sizeof naor->zero; i++) {
2037 if (naor->zero[i]) {
2038 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2042 return nxm_src_check(naor->src, nxm_decode_ofs(naor->ofs_nbits),
2043 nxm_decode_n_bits(naor->ofs_nbits), flow);
2047 validate_actions(const union ofp_action *actions, size_t n_actions,
2048 const struct flow *flow, int max_ports)
2050 const union ofp_action *a;
2053 OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
2058 code = ofputil_decode_action(a);
2063 msg = ofputil_error_to_string(error);
2064 VLOG_WARN_RL(&bad_ofmsg_rl,
2065 "action decoding error at offset %td (%s)",
2066 (a - actions) * sizeof *a, msg);
2073 switch ((enum ofputil_action_code) code) {
2074 case OFPUTIL_OFPAT_OUTPUT:
2075 error = ofputil_check_output_port(ntohs(a->output.port),
2079 case OFPUTIL_OFPAT_SET_VLAN_VID:
2080 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
2081 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2085 case OFPUTIL_OFPAT_SET_VLAN_PCP:
2086 if (a->vlan_pcp.vlan_pcp & ~7) {
2087 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
2091 case OFPUTIL_OFPAT_ENQUEUE:
2092 port = ntohs(((const struct ofp_action_enqueue *) a)->port);
2093 if (port >= max_ports && port != OFPP_IN_PORT) {
2094 error = ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
2098 case OFPUTIL_NXAST_REG_MOVE:
2099 error = nxm_check_reg_move((const struct nx_action_reg_move *) a,
2103 case OFPUTIL_NXAST_REG_LOAD:
2104 error = nxm_check_reg_load((const struct nx_action_reg_load *) a,
2108 case OFPUTIL_NXAST_MULTIPATH:
2109 error = multipath_check((const struct nx_action_multipath *) a,
2113 case OFPUTIL_NXAST_AUTOPATH:
2114 error = autopath_check((const struct nx_action_autopath *) a,
2118 case OFPUTIL_NXAST_BUNDLE:
2119 case OFPUTIL_NXAST_BUNDLE_LOAD:
2120 error = bundle_check((const struct nx_action_bundle *) a,
2124 case OFPUTIL_NXAST_OUTPUT_REG:
2125 error = check_output_reg((const struct nx_action_output_reg *) a,
2129 case OFPUTIL_NXAST_RESUBMIT_TABLE:
2130 error = check_resubmit_table(
2131 (const struct nx_action_resubmit *) a);
2134 case OFPUTIL_NXAST_LEARN:
2135 error = learn_check((const struct nx_action_learn *) a, flow);
2138 case OFPUTIL_OFPAT_STRIP_VLAN:
2139 case OFPUTIL_OFPAT_SET_NW_SRC:
2140 case OFPUTIL_OFPAT_SET_NW_DST:
2141 case OFPUTIL_OFPAT_SET_NW_TOS:
2142 case OFPUTIL_OFPAT_SET_TP_SRC:
2143 case OFPUTIL_OFPAT_SET_TP_DST:
2144 case OFPUTIL_OFPAT_SET_DL_SRC:
2145 case OFPUTIL_OFPAT_SET_DL_DST:
2146 case OFPUTIL_NXAST_RESUBMIT:
2147 case OFPUTIL_NXAST_SET_TUNNEL:
2148 case OFPUTIL_NXAST_SET_QUEUE:
2149 case OFPUTIL_NXAST_POP_QUEUE:
2150 case OFPUTIL_NXAST_NOTE:
2151 case OFPUTIL_NXAST_SET_TUNNEL64:
2156 char *msg = ofputil_error_to_string(error);
2157 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action at offset %td (%s)",
2158 (a - actions) * sizeof *a, msg);
2164 VLOG_WARN_RL(&bad_ofmsg_rl, "bad action format at offset %zu",
2165 (n_actions - left) * sizeof *a);
2166 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2171 struct ofputil_action {
2173 unsigned int min_len;
2174 unsigned int max_len;
2177 static const struct ofputil_action action_bad_type
2178 = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE), 0, UINT_MAX };
2179 static const struct ofputil_action action_bad_len
2180 = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_LEN), 0, UINT_MAX };
2181 static const struct ofputil_action action_bad_vendor
2182 = { -OFP_MKERR(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR), 0, UINT_MAX };
2184 static const struct ofputil_action *
2185 ofputil_decode_ofpat_action(const union ofp_action *a)
2187 enum ofp_action_type type = ntohs(a->type);
2190 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2192 static const struct ofputil_action action = { \
2194 sizeof(struct STRUCT), \
2195 sizeof(struct STRUCT) \
2199 #include "ofp-util.def"
2203 return &action_bad_type;
2207 static const struct ofputil_action *
2208 ofputil_decode_nxast_action(const union ofp_action *a)
2210 const struct nx_action_header *nah = (const struct nx_action_header *) a;
2211 enum nx_action_subtype subtype = ntohs(nah->subtype);
2214 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2216 static const struct ofputil_action action = { \
2218 sizeof(struct STRUCT), \
2219 EXTENSIBLE ? UINT_MAX : sizeof(struct STRUCT) \
2223 #include "ofp-util.def"
2225 case NXAST_SNAT__OBSOLETE:
2226 case NXAST_DROP_SPOOFED_ARP__OBSOLETE:
2228 return &action_bad_type;
2232 /* Parses 'a' to determine its type. Returns a nonnegative OFPUTIL_OFPAT_* or
2233 * OFPUTIL_NXAST_* constant if successful, otherwise a negative OpenFlow error
2234 * code (as returned by ofp_mkerr()).
2236 * The caller must have already verified that 'a''s length is correct (that is,
2237 * a->header.len is nonzero and a multiple of sizeof(union ofp_action) and no
2238 * longer than the amount of space allocated to 'a').
2240 * This function verifies that 'a''s length is correct for the type of action
2241 * that it represents. */
2243 ofputil_decode_action(const union ofp_action *a)
2245 const struct ofputil_action *action;
2246 uint16_t len = ntohs(a->header.len);
2248 if (a->type != htons(OFPAT_VENDOR)) {
2249 action = ofputil_decode_ofpat_action(a);
2251 switch (ntohl(a->vendor.vendor)) {
2253 if (len < sizeof(struct nx_action_header)) {
2254 return -ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
2256 action = ofputil_decode_nxast_action(a);
2259 action = &action_bad_vendor;
2264 return (len >= action->min_len && len <= action->max_len
2266 : -ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN));
2269 /* Parses 'a' and returns its type as an OFPUTIL_OFPAT_* or OFPUTIL_NXAST_*
2270 * constant. The caller must have already validated that 'a' is a valid action
2271 * understood by Open vSwitch (e.g. by a previous successful call to
2272 * ofputil_decode_action()). */
2273 enum ofputil_action_code
2274 ofputil_decode_action_unsafe(const union ofp_action *a)
2276 const struct ofputil_action *action;
2278 if (a->type != htons(OFPAT_VENDOR)) {
2279 action = ofputil_decode_ofpat_action(a);
2281 action = ofputil_decode_nxast_action(a);
2284 return action->code;
2287 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
2288 * 'name' is "output" then the return value is OFPUTIL_OFPAT_OUTPUT), or -1 if
2289 * 'name' is not the name of any action.
2291 * ofp-util.def lists the mapping from names to action. */
2293 ofputil_action_code_from_name(const char *name)
2295 static const char *names[OFPUTIL_N_ACTIONS] = {
2296 #define OFPAT_ACTION(ENUM, STRUCT, NAME) NAME,
2297 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
2298 #include "ofp-util.def"
2303 for (p = names; p < &names[ARRAY_SIZE(names)]; p++) {
2304 if (*p && !strcasecmp(name, *p)) {
2311 /* Appends an action of the type specified by 'code' to 'buf' and returns the
2312 * action. Initializes the parts of 'action' that identify it as having type
2313 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
2314 * have variable length, the length used and cleared is that of struct
2317 ofputil_put_action(enum ofputil_action_code code, struct ofpbuf *buf)
2320 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2321 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2322 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2323 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
2324 #include "ofp-util.def"
2329 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
2331 ofputil_init_##ENUM(struct STRUCT *s) \
2333 memset(s, 0, sizeof *s); \
2334 s->type = htons(ENUM); \
2335 s->len = htons(sizeof *s); \
2339 ofputil_put_##ENUM(struct ofpbuf *buf) \
2341 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
2342 ofputil_init_##ENUM(s); \
2345 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
2347 ofputil_init_##ENUM(struct STRUCT *s) \
2349 memset(s, 0, sizeof *s); \
2350 s->type = htons(OFPAT_VENDOR); \
2351 s->len = htons(sizeof *s); \
2352 s->vendor = htonl(NX_VENDOR_ID); \
2353 s->subtype = htons(ENUM); \
2357 ofputil_put_##ENUM(struct ofpbuf *buf) \
2359 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
2360 ofputil_init_##ENUM(s); \
2363 #include "ofp-util.def"
2365 /* Returns true if 'action' outputs to 'port', false otherwise. */
2367 action_outputs_to_port(const union ofp_action *action, ovs_be16 port)
2369 switch (ntohs(action->type)) {
2371 return action->output.port == port;
2373 return ((const struct ofp_action_enqueue *) action)->port == port;
2379 /* "Normalizes" the wildcards in 'rule'. That means:
2381 * 1. If the type of level N is known, then only the valid fields for that
2382 * level may be specified. For example, ARP does not have a TOS field,
2383 * so nw_tos must be wildcarded if 'rule' specifies an ARP flow.
2384 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
2385 * ipv6_dst (and other fields) must be wildcarded if 'rule' specifies an
2388 * 2. If the type of level N is not known (or not understood by Open
2389 * vSwitch), then no fields at all for that level may be specified. For
2390 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
2391 * L4 fields tp_src and tp_dst must be wildcarded if 'rule' specifies an
2394 * 'flow_format' specifies the format of the flow as received or as intended to
2395 * be sent. This is important for IPv6 and ARP, for which NXM supports more
2396 * detailed matching. */
2398 ofputil_normalize_rule(struct cls_rule *rule, enum nx_flow_format flow_format)
2401 MAY_NW_ADDR = 1 << 0, /* nw_src, nw_dst */
2402 MAY_TP_ADDR = 1 << 1, /* tp_src, tp_dst */
2403 MAY_NW_PROTO = 1 << 2, /* nw_proto */
2404 MAY_NW_TOS = 1 << 3, /* nw_tos */
2405 MAY_ARP_SHA = 1 << 4, /* arp_sha */
2406 MAY_ARP_THA = 1 << 5, /* arp_tha */
2407 MAY_IPV6_ADDR = 1 << 6, /* ipv6_src, ipv6_dst */
2408 MAY_ND_TARGET = 1 << 7 /* nd_target */
2411 struct flow_wildcards wc;
2413 /* Figure out what fields may be matched. */
2414 if (rule->flow.dl_type == htons(ETH_TYPE_IP)) {
2415 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_NW_ADDR;
2416 if (rule->flow.nw_proto == IPPROTO_TCP ||
2417 rule->flow.nw_proto == IPPROTO_UDP ||
2418 rule->flow.nw_proto == IPPROTO_ICMP) {
2419 may_match |= MAY_TP_ADDR;
2421 } else if (rule->flow.dl_type == htons(ETH_TYPE_IPV6)
2422 && flow_format == NXFF_NXM) {
2423 may_match = MAY_NW_PROTO | MAY_NW_TOS | MAY_IPV6_ADDR;
2424 if (rule->flow.nw_proto == IPPROTO_TCP ||
2425 rule->flow.nw_proto == IPPROTO_UDP) {
2426 may_match |= MAY_TP_ADDR;
2427 } else if (rule->flow.nw_proto == IPPROTO_ICMPV6) {
2428 may_match |= MAY_TP_ADDR;
2429 if (rule->flow.tp_src == htons(ND_NEIGHBOR_SOLICIT)) {
2430 may_match |= MAY_ND_TARGET | MAY_ARP_SHA;
2431 } else if (rule->flow.tp_src == htons(ND_NEIGHBOR_ADVERT)) {
2432 may_match |= MAY_ND_TARGET | MAY_ARP_THA;
2435 } else if (rule->flow.dl_type == htons(ETH_TYPE_ARP)) {
2436 may_match = MAY_NW_PROTO | MAY_NW_ADDR;
2437 if (flow_format == NXFF_NXM) {
2438 may_match |= MAY_ARP_SHA | MAY_ARP_THA;
2444 /* Clear the fields that may not be matched. */
2446 if (!(may_match & MAY_NW_ADDR)) {
2447 wc.nw_src_mask = wc.nw_dst_mask = htonl(0);
2449 if (!(may_match & MAY_TP_ADDR)) {
2450 wc.wildcards |= FWW_TP_SRC | FWW_TP_DST;
2452 if (!(may_match & MAY_NW_PROTO)) {
2453 wc.wildcards |= FWW_NW_PROTO;
2455 if (!(may_match & MAY_NW_TOS)) {
2456 wc.wildcards |= FWW_NW_TOS;
2458 if (!(may_match & MAY_ARP_SHA)) {
2459 wc.wildcards |= FWW_ARP_SHA;
2461 if (!(may_match & MAY_ARP_THA)) {
2462 wc.wildcards |= FWW_ARP_THA;
2464 if (!(may_match & MAY_IPV6_ADDR)) {
2465 wc.ipv6_src_mask = wc.ipv6_dst_mask = in6addr_any;
2467 if (!(may_match & MAY_ND_TARGET)) {
2468 wc.wildcards |= FWW_ND_TARGET;
2471 /* Log any changes. */
2472 if (!flow_wildcards_equal(&wc, &rule->wc)) {
2473 bool log = !VLOG_DROP_INFO(&bad_ofmsg_rl);
2474 char *pre = log ? cls_rule_to_string(rule) : NULL;
2477 cls_rule_zero_wildcarded_fields(rule);
2480 char *post = cls_rule_to_string(rule);
2481 VLOG_INFO("normalization changed ofp_match, details:");
2482 VLOG_INFO(" pre: %s", pre);
2483 VLOG_INFO("post: %s", post);
2491 vendor_code_to_id(uint8_t code)
2494 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
2496 #undef OFPUTIL_VENDOR
2503 vendor_id_to_code(uint32_t id)
2506 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case VENDOR_ID: return NAME;
2508 #undef OFPUTIL_VENDOR
2514 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
2515 * information taken from 'error', whose encoding must be as described in the
2516 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
2517 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
2520 * Returns NULL if 'error' is not an OpenFlow error code. */
2522 ofputil_encode_error_msg(int error, const struct ofp_header *oh)
2524 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2534 if (!is_ofp_error(error)) {
2535 /* We format 'error' with strerror() here since it seems likely to be
2536 * a system errno value. */
2537 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
2538 error, strerror(error));
2545 len = ntohs(oh->length);
2555 vendor = get_ofp_err_vendor(error);
2556 type = get_ofp_err_type(error);
2557 code = get_ofp_err_code(error);
2558 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
2559 struct ofp_error_msg *oem;
2561 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
2562 oem->type = htons(type);
2563 oem->code = htons(code);
2565 struct ofp_error_msg *oem;
2566 struct nx_vendor_error *nve;
2569 vendor_id = vendor_code_to_id(vendor);
2570 if (vendor_id == UINT32_MAX) {
2571 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
2576 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
2577 OFPT_ERROR, xid, &buf);
2578 oem->type = htons(NXET_VENDOR);
2579 oem->code = htons(NXVC_VENDOR_ERROR);
2581 nve = (struct nx_vendor_error *)oem->data;
2582 nve->vendor = htonl(vendor_id);
2583 nve->type = htons(type);
2584 nve->code = htons(code);
2589 ofpbuf_put(buf, data, len);
2595 /* Decodes 'oh', which should be an OpenFlow OFPT_ERROR message, and returns an
2596 * Open vSwitch internal error code in the format described in the large
2597 * comment in ofp-util.h.
2599 * If 'payload_ofs' is nonnull, on success '*payload_ofs' is set to the offset
2600 * to the payload starting from 'oh' and on failure it is set to 0. */
2602 ofputil_decode_error_msg(const struct ofp_header *oh, size_t *payload_ofs)
2604 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2606 const struct ofp_error_msg *oem;
2607 uint16_t type, code;
2614 if (oh->type != OFPT_ERROR) {
2618 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2619 oem = ofpbuf_try_pull(&b, sizeof *oem);
2624 type = ntohs(oem->type);
2625 code = ntohs(oem->code);
2626 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
2627 const struct nx_vendor_error *nve = ofpbuf_try_pull(&b, sizeof *nve);
2632 vendor = vendor_id_to_code(ntohl(nve->vendor));
2634 VLOG_WARN_RL(&rl, "error contains unknown vendor ID %#"PRIx32,
2635 ntohl(nve->vendor));
2638 type = ntohs(nve->type);
2639 code = ntohs(nve->code);
2641 vendor = OFPUTIL_VENDOR_OPENFLOW;
2645 VLOG_WARN_RL(&rl, "error contains type %"PRIu16" greater than "
2646 "supported maximum value 1023", type);
2651 *payload_ofs = (uint8_t *) b.data - (uint8_t *) oh;
2653 return ofp_mkerr_vendor(vendor, type, code);
2657 ofputil_format_error(struct ds *s, int error)
2659 if (is_errno(error)) {
2660 ds_put_cstr(s, strerror(error));
2662 uint16_t type = get_ofp_err_type(error);
2663 uint16_t code = get_ofp_err_code(error);
2664 const char *type_s = ofp_error_type_to_string(type);
2665 const char *code_s = ofp_error_code_to_string(type, code);
2667 ds_put_format(s, "type ");
2669 ds_put_cstr(s, type_s);
2671 ds_put_format(s, "%"PRIu16, type);
2674 ds_put_cstr(s, ", code ");
2676 ds_put_cstr(s, code_s);
2678 ds_put_format(s, "%"PRIu16, code);
2684 ofputil_error_to_string(int error)
2686 struct ds s = DS_EMPTY_INITIALIZER;
2687 ofputil_format_error(&s, error);
2688 return ds_steal_cstr(&s);
2691 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
2692 * successful, otherwise an OpenFlow error.
2694 * If successful, the first action is stored in '*actionsp' and the number of
2695 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
2696 * are stored, respectively.
2698 * This function does not check that the actions are valid (the caller should
2699 * do so, with validate_actions()). The caller is also responsible for making
2700 * sure that 'b->data' is initially aligned appropriately for "union
2703 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
2704 union ofp_action **actionsp, size_t *n_actionsp)
2706 if (actions_len % OFP_ACTION_ALIGN != 0) {
2707 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2708 "is not a multiple of %d", actions_len, OFP_ACTION_ALIGN);
2712 *actionsp = ofpbuf_try_pull(b, actions_len);
2713 if (*actionsp == NULL) {
2714 VLOG_WARN_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
2715 "exceeds remaining message length (%zu)",
2716 actions_len, b->size);
2720 *n_actionsp = actions_len / OFP_ACTION_ALIGN;
2726 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2730 ofputil_actions_equal(const union ofp_action *a, size_t n_a,
2731 const union ofp_action *b, size_t n_b)
2733 return n_a == n_b && (!n_a || !memcmp(a, b, n_a * sizeof *a));
2737 ofputil_actions_clone(const union ofp_action *actions, size_t n)
2739 return n ? xmemdup(actions, n * sizeof *actions) : NULL;
2742 /* Parses a key or a key-value pair from '*stringp'.
2744 * On success: Stores the key into '*keyp'. Stores the value, if present, into
2745 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
2746 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
2747 * are substrings of '*stringp' created by replacing some of its bytes by null
2748 * terminators. Returns true.
2750 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
2751 * NULL and returns false. */
2753 ofputil_parse_key_value(char **stringp, char **keyp, char **valuep)
2755 char *pos, *key, *value;
2759 pos += strspn(pos, ", \t\r\n");
2761 *keyp = *valuep = NULL;
2766 key_len = strcspn(pos, ":=(, \t\r\n");
2767 if (key[key_len] == ':' || key[key_len] == '=') {
2768 /* The value can be separated by a colon. */
2771 value = key + key_len + 1;
2772 value_len = strcspn(value, ", \t\r\n");
2773 pos = value + value_len + (value[value_len] != '\0');
2774 value[value_len] = '\0';
2775 } else if (key[key_len] == '(') {
2776 /* The value can be surrounded by balanced parentheses. The outermost
2777 * set of parentheses is removed. */
2781 value = key + key_len + 1;
2782 for (value_len = 0; level > 0; value_len++) {
2783 switch (value[value_len]) {
2785 ovs_fatal(0, "unbalanced parentheses in argument to %s", key);
2796 value[value_len - 1] = '\0';
2797 pos = value + value_len;
2799 /* There might be no value at all. */
2800 value = key + key_len; /* Will become the empty string below. */
2801 pos = key + key_len + (key[key_len] != '\0');
2803 key[key_len] = '\0';