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"
28 VLOG_DEFINE_THIS_MODULE(ofp_util);
30 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
31 * in the peer and so there's not much point in showing a lot of them. */
32 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
34 /* XXX we should really use consecutive xids to avoid probabilistic
36 static inline uint32_t
39 return random_uint32();
42 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
43 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
44 * an arbitrary transaction id. Allocated bytes beyond the header, if any, are
47 * The caller is responsible for freeing '*bufferp' when it is no longer
50 * The OpenFlow header length is initially set to 'openflow_len'; if the
51 * message is later extended, the length should be updated with
52 * update_openflow_length() before sending.
54 * Returns the header. */
56 make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp)
58 *bufferp = ofpbuf_new(openflow_len);
59 return put_openflow_xid(openflow_len, type, alloc_xid(), *bufferp);
62 /* Similar to make_openflow() but creates a Nicira vendor extension message
63 * with the specific 'subtype'. 'subtype' should be in host byte order. */
65 make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **bufferp)
67 return make_nxmsg_xid(openflow_len, subtype, alloc_xid(), bufferp);
70 /* Allocates and stores in '*bufferp' a new ofpbuf with a size of
71 * 'openflow_len', starting with an OpenFlow header with the given 'type' and
72 * transaction id 'xid'. Allocated bytes beyond the header, if any, are
75 * The caller is responsible for freeing '*bufferp' when it is no longer
78 * The OpenFlow header length is initially set to 'openflow_len'; if the
79 * message is later extended, the length should be updated with
80 * update_openflow_length() before sending.
82 * Returns the header. */
84 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
85 struct ofpbuf **bufferp)
87 *bufferp = ofpbuf_new(openflow_len);
88 return put_openflow_xid(openflow_len, type, xid, *bufferp);
91 /* Similar to make_openflow_xid() but creates a Nicira vendor extension message
92 * with the specific 'subtype'. 'subtype' should be in host byte order. */
94 make_nxmsg_xid(size_t openflow_len, uint32_t subtype, uint32_t xid,
95 struct ofpbuf **bufferp)
97 struct nicira_header *nxh = make_openflow_xid(openflow_len, OFPT_VENDOR,
99 nxh->vendor = htonl(NX_VENDOR_ID);
100 nxh->subtype = htonl(subtype);
104 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
105 * with the given 'type' and an arbitrary transaction id. Allocated bytes
106 * beyond the header, if any, are zeroed.
108 * The OpenFlow header length is initially set to 'openflow_len'; if the
109 * message is later extended, the length should be updated with
110 * update_openflow_length() before sending.
112 * Returns the header. */
114 put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *buffer)
116 return put_openflow_xid(openflow_len, type, alloc_xid(), buffer);
119 /* Appends 'openflow_len' bytes to 'buffer', starting with an OpenFlow header
120 * with the given 'type' and an transaction id 'xid'. Allocated bytes beyond
121 * the header, if any, are zeroed.
123 * The OpenFlow header length is initially set to 'openflow_len'; if the
124 * message is later extended, the length should be updated with
125 * update_openflow_length() before sending.
127 * Returns the header. */
129 put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
130 struct ofpbuf *buffer)
132 struct ofp_header *oh;
134 assert(openflow_len >= sizeof *oh);
135 assert(openflow_len <= UINT16_MAX);
137 oh = ofpbuf_put_uninit(buffer, openflow_len);
138 oh->version = OFP_VERSION;
140 oh->length = htons(openflow_len);
142 memset(oh + 1, 0, openflow_len - sizeof *oh);
146 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
149 update_openflow_length(struct ofpbuf *buffer)
151 struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
152 oh->length = htons(buffer->size);
156 make_flow_mod(uint16_t command, const struct flow *flow, size_t actions_len)
158 struct ofp_flow_mod *ofm;
159 size_t size = sizeof *ofm + actions_len;
160 struct ofpbuf *out = ofpbuf_new(size);
161 ofm = ofpbuf_put_zeros(out, sizeof *ofm);
162 ofm->header.version = OFP_VERSION;
163 ofm->header.type = OFPT_FLOW_MOD;
164 ofm->header.length = htons(size);
166 ofm->match.wildcards = htonl(0);
167 ofm->match.in_port = htons(flow->in_port == ODPP_LOCAL ? OFPP_LOCAL
169 memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
170 memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
171 ofm->match.dl_vlan = flow->dl_vlan;
172 ofm->match.dl_vlan_pcp = flow->dl_vlan_pcp;
173 ofm->match.dl_type = flow->dl_type;
174 ofm->match.nw_src = flow->nw_src;
175 ofm->match.nw_dst = flow->nw_dst;
176 ofm->match.nw_proto = flow->nw_proto;
177 ofm->match.nw_tos = flow->nw_tos;
178 ofm->match.tp_src = flow->tp_src;
179 ofm->match.tp_dst = flow->tp_dst;
180 ofm->command = htons(command);
185 make_add_flow(const struct flow *flow, uint32_t buffer_id,
186 uint16_t idle_timeout, size_t actions_len)
188 struct ofpbuf *out = make_flow_mod(OFPFC_ADD, flow, actions_len);
189 struct ofp_flow_mod *ofm = out->data;
190 ofm->idle_timeout = htons(idle_timeout);
191 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
192 ofm->buffer_id = htonl(buffer_id);
197 make_del_flow(const struct flow *flow)
199 struct ofpbuf *out = make_flow_mod(OFPFC_DELETE_STRICT, flow, 0);
200 struct ofp_flow_mod *ofm = out->data;
201 ofm->out_port = htons(OFPP_NONE);
206 make_add_simple_flow(const struct flow *flow,
207 uint32_t buffer_id, uint16_t out_port,
208 uint16_t idle_timeout)
210 if (out_port != OFPP_NONE) {
211 struct ofp_action_output *oao;
212 struct ofpbuf *buffer;
214 buffer = make_add_flow(flow, buffer_id, idle_timeout, sizeof *oao);
215 oao = ofpbuf_put_zeros(buffer, sizeof *oao);
216 oao->type = htons(OFPAT_OUTPUT);
217 oao->len = htons(sizeof *oao);
218 oao->port = htons(out_port);
221 return make_add_flow(flow, buffer_id, idle_timeout, 0);
226 make_packet_in(uint32_t buffer_id, uint16_t in_port, uint8_t reason,
227 const struct ofpbuf *payload, int max_send_len)
229 struct ofp_packet_in *opi;
233 send_len = MIN(max_send_len, payload->size);
234 buf = ofpbuf_new(sizeof *opi + send_len);
235 opi = put_openflow_xid(offsetof(struct ofp_packet_in, data),
236 OFPT_PACKET_IN, 0, buf);
237 opi->buffer_id = htonl(buffer_id);
238 opi->total_len = htons(payload->size);
239 opi->in_port = htons(in_port);
240 opi->reason = reason;
241 ofpbuf_put(buf, payload->data, send_len);
242 update_openflow_length(buf);
248 make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
250 const struct ofp_action_header *actions, size_t n_actions)
252 size_t actions_len = n_actions * sizeof *actions;
253 struct ofp_packet_out *opo;
254 size_t size = sizeof *opo + actions_len + (packet ? packet->size : 0);
255 struct ofpbuf *out = ofpbuf_new(size);
257 opo = ofpbuf_put_uninit(out, sizeof *opo);
258 opo->header.version = OFP_VERSION;
259 opo->header.type = OFPT_PACKET_OUT;
260 opo->header.length = htons(size);
261 opo->header.xid = htonl(0);
262 opo->buffer_id = htonl(buffer_id);
263 opo->in_port = htons(in_port == ODPP_LOCAL ? OFPP_LOCAL : in_port);
264 opo->actions_len = htons(actions_len);
265 ofpbuf_put(out, actions, actions_len);
267 ofpbuf_put(out, packet->data, packet->size);
273 make_unbuffered_packet_out(const struct ofpbuf *packet,
274 uint16_t in_port, uint16_t out_port)
276 struct ofp_action_output action;
277 action.type = htons(OFPAT_OUTPUT);
278 action.len = htons(sizeof action);
279 action.port = htons(out_port);
280 return make_packet_out(packet, UINT32_MAX, in_port,
281 (struct ofp_action_header *) &action, 1);
285 make_buffered_packet_out(uint32_t buffer_id,
286 uint16_t in_port, uint16_t out_port)
288 if (out_port != OFPP_NONE) {
289 struct ofp_action_output action;
290 action.type = htons(OFPAT_OUTPUT);
291 action.len = htons(sizeof action);
292 action.port = htons(out_port);
293 return make_packet_out(NULL, buffer_id, in_port,
294 (struct ofp_action_header *) &action, 1);
296 return make_packet_out(NULL, buffer_id, in_port, NULL, 0);
300 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
302 make_echo_request(void)
304 struct ofp_header *rq;
305 struct ofpbuf *out = ofpbuf_new(sizeof *rq);
306 rq = ofpbuf_put_uninit(out, sizeof *rq);
307 rq->version = OFP_VERSION;
308 rq->type = OFPT_ECHO_REQUEST;
309 rq->length = htons(sizeof *rq);
314 /* Creates and returns an OFPT_ECHO_REPLY message matching the
315 * OFPT_ECHO_REQUEST message in 'rq'. */
317 make_echo_reply(const struct ofp_header *rq)
319 size_t size = ntohs(rq->length);
320 struct ofpbuf *out = ofpbuf_new(size);
321 struct ofp_header *reply = ofpbuf_put(out, rq, size);
322 reply->type = OFPT_ECHO_REPLY;
327 check_message_type(uint8_t got_type, uint8_t want_type)
329 if (got_type != want_type) {
330 char *want_type_name = ofp_message_type_to_string(want_type);
331 char *got_type_name = ofp_message_type_to_string(got_type);
332 VLOG_WARN_RL(&bad_ofmsg_rl,
333 "received bad message type %s (expected %s)",
334 got_type_name, want_type_name);
335 free(want_type_name);
337 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
342 /* Checks that 'msg' has type 'type' and that it is exactly 'size' bytes long.
343 * Returns 0 if the checks pass, otherwise an OpenFlow error code (produced
344 * with ofp_mkerr()). */
346 check_ofp_message(const struct ofp_header *msg, uint8_t type, size_t size)
351 error = check_message_type(msg->type, type);
356 got_size = ntohs(msg->length);
357 if (got_size != size) {
358 char *type_name = ofp_message_type_to_string(type);
359 VLOG_WARN_RL(&bad_ofmsg_rl,
360 "received %s message of length %zu (expected %zu)",
361 type_name, got_size, size);
363 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
369 /* Checks that 'msg' has type 'type' and that 'msg' is 'size' plus a
370 * nonnegative integer multiple of 'array_elt_size' bytes long. Returns 0 if
371 * the checks pass, otherwise an OpenFlow error code (produced with
374 * If 'n_array_elts' is nonnull, then '*n_array_elts' is set to the number of
375 * 'array_elt_size' blocks in 'msg' past the first 'min_size' bytes, when
378 check_ofp_message_array(const struct ofp_header *msg, uint8_t type,
379 size_t min_size, size_t array_elt_size,
380 size_t *n_array_elts)
385 assert(array_elt_size);
387 error = check_message_type(msg->type, type);
392 got_size = ntohs(msg->length);
393 if (got_size < min_size) {
394 char *type_name = ofp_message_type_to_string(type);
395 VLOG_WARN_RL(&bad_ofmsg_rl, "received %s message of length %zu "
396 "(expected at least %zu)",
397 type_name, got_size, min_size);
399 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
401 if ((got_size - min_size) % array_elt_size) {
402 char *type_name = ofp_message_type_to_string(type);
403 VLOG_WARN_RL(&bad_ofmsg_rl,
404 "received %s message of bad length %zu: the "
405 "excess over %zu (%zu) is not evenly divisible by %zu "
406 "(remainder is %zu)",
407 type_name, got_size, min_size, got_size - min_size,
408 array_elt_size, (got_size - min_size) % array_elt_size);
410 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
413 *n_array_elts = (got_size - min_size) / array_elt_size;
419 check_ofp_packet_out(const struct ofp_header *oh, struct ofpbuf *data,
420 int *n_actionsp, int max_ports)
422 const struct ofp_packet_out *opo;
423 unsigned int actions_len, n_actions;
428 error = check_ofp_message_array(oh, OFPT_PACKET_OUT,
429 sizeof *opo, 1, &extra);
433 opo = (const struct ofp_packet_out *) oh;
435 actions_len = ntohs(opo->actions_len);
436 if (actions_len > extra) {
437 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out claims %u bytes of actions "
438 "but message has room for only %zu bytes",
440 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
442 if (actions_len % sizeof(union ofp_action)) {
443 VLOG_WARN_RL(&bad_ofmsg_rl, "packet-out claims %u bytes of actions, "
444 "which is not a multiple of %zu",
445 actions_len, sizeof(union ofp_action));
446 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
449 n_actions = actions_len / sizeof(union ofp_action);
450 error = validate_actions((const union ofp_action *) opo->actions,
451 n_actions, max_ports);
456 data->data = (void *) &opo->actions[n_actions];
457 data->size = extra - actions_len;
458 *n_actionsp = n_actions;
462 const struct ofp_flow_stats *
463 flow_stats_first(struct flow_stats_iterator *iter,
464 const struct ofp_stats_reply *osr)
466 iter->pos = osr->body;
467 iter->end = osr->body + (ntohs(osr->header.length)
468 - offsetof(struct ofp_stats_reply, body));
469 return flow_stats_next(iter);
472 const struct ofp_flow_stats *
473 flow_stats_next(struct flow_stats_iterator *iter)
475 ptrdiff_t bytes_left = iter->end - iter->pos;
476 const struct ofp_flow_stats *fs;
479 if (bytes_left < sizeof *fs) {
480 if (bytes_left != 0) {
481 VLOG_WARN_RL(&bad_ofmsg_rl,
482 "%td leftover bytes in flow stats reply", bytes_left);
487 fs = (const void *) iter->pos;
488 length = ntohs(fs->length);
489 if (length < sizeof *fs) {
490 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu is shorter than "
491 "min %zu", length, sizeof *fs);
493 } else if (length > bytes_left) {
494 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu but only %td "
495 "bytes left", length, bytes_left);
497 } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
498 VLOG_WARN_RL(&bad_ofmsg_rl, "flow stats length %zu has %zu bytes "
499 "left over in final action", length,
500 (length - sizeof *fs) % sizeof fs->actions[0]);
507 /* Alignment of ofp_actions. */
508 #define ACTION_ALIGNMENT 8
511 check_action_exact_len(const union ofp_action *a, unsigned int len,
512 unsigned int required_len)
514 if (len != required_len) {
515 VLOG_DBG_RL(&bad_ofmsg_rl,
516 "action %u has invalid length %"PRIu16" (must be %u)\n",
517 a->type, ntohs(a->header.len), required_len);
518 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
523 /* Checks that 'port' is a valid output port for the OFPAT_OUTPUT action, given
524 * that the switch will never have more than 'max_ports' ports. Returns 0 if
525 * 'port' is valid, otherwise an ofp_mkerr() return code. */
527 check_output_port(uint16_t port, int max_ports)
535 case OFPP_CONTROLLER:
540 if (port < max_ports) {
543 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown output port %x", port);
544 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
548 /* Checks that 'action' is a valid OFPAT_ENQUEUE action, given that the switch
549 * will never have more than 'max_ports' ports. Returns 0 if 'port' is valid,
550 * otherwise an ofp_mkerr() return code. */
552 check_enqueue_action(const union ofp_action *a, unsigned int len,
555 const struct ofp_action_enqueue *oae;
559 error = check_action_exact_len(a, len, 16);
564 oae = (const struct ofp_action_enqueue *) a;
565 port = ntohs(oae->port);
566 if (port < max_ports || port == OFPP_IN_PORT) {
569 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown enqueue port %x", port);
570 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT);
574 check_nicira_action(const union ofp_action *a, unsigned int len)
576 const struct nx_action_header *nah;
579 VLOG_DBG_RL(&bad_ofmsg_rl,
580 "Nicira vendor action only %u bytes", len);
581 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
583 nah = (const struct nx_action_header *) a;
585 switch (ntohs(nah->subtype)) {
587 case NXAST_SET_TUNNEL:
588 case NXAST_DROP_SPOOFED_ARP:
589 case NXAST_SET_QUEUE:
590 case NXAST_POP_QUEUE:
591 return check_action_exact_len(a, len, 16);
593 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE);
598 check_action(const union ofp_action *a, unsigned int len, int max_ports)
602 switch (ntohs(a->type)) {
604 error = check_action_exact_len(a, len, 8);
608 return check_output_port(ntohs(a->output.port), max_ports);
610 case OFPAT_SET_VLAN_VID:
611 error = check_action_exact_len(a, len, 8);
615 if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
616 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
620 case OFPAT_SET_VLAN_PCP:
621 error = check_action_exact_len(a, len, 8);
625 if (a->vlan_vid.vlan_vid & ~7) {
626 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
630 case OFPAT_STRIP_VLAN:
631 case OFPAT_SET_NW_SRC:
632 case OFPAT_SET_NW_DST:
633 case OFPAT_SET_NW_TOS:
634 case OFPAT_SET_TP_SRC:
635 case OFPAT_SET_TP_DST:
636 return check_action_exact_len(a, len, 8);
638 case OFPAT_SET_DL_SRC:
639 case OFPAT_SET_DL_DST:
640 return check_action_exact_len(a, len, 16);
643 return (a->vendor.vendor == htonl(NX_VENDOR_ID)
644 ? check_nicira_action(a, len)
645 : ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR));
648 return check_enqueue_action(a, len, max_ports);
651 VLOG_WARN_RL(&bad_ofmsg_rl, "unknown action type %"PRIu16,
653 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE);
658 validate_actions(const union ofp_action *actions, size_t n_actions,
663 for (i = 0; i < n_actions; ) {
664 const union ofp_action *a = &actions[i];
665 unsigned int len = ntohs(a->header.len);
666 unsigned int n_slots = len / ACTION_ALIGNMENT;
667 unsigned int slots_left = &actions[n_actions] - a;
670 if (n_slots > slots_left) {
671 VLOG_DBG_RL(&bad_ofmsg_rl,
672 "action requires %u slots but only %u remain",
673 n_slots, slots_left);
674 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
676 VLOG_DBG_RL(&bad_ofmsg_rl, "action has invalid length 0");
677 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
678 } else if (len % ACTION_ALIGNMENT) {
679 VLOG_DBG_RL(&bad_ofmsg_rl, "action length %u is not a multiple "
680 "of %d", len, ACTION_ALIGNMENT);
681 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
684 error = check_action(a, len, max_ports);
693 /* Returns true if 'action' outputs to 'port' (which must be in network byte
694 * order), false otherwise. */
696 action_outputs_to_port(const union ofp_action *action, uint16_t port)
698 switch (ntohs(action->type)) {
700 return action->output.port == port;
702 return ((const struct ofp_action_enqueue *) action)->port == port;
708 /* The set of actions must either come from a trusted source or have been
709 * previously validated with validate_actions(). */
710 const union ofp_action *
711 actions_first(struct actions_iterator *iter,
712 const union ofp_action *oa, size_t n_actions)
715 iter->end = oa + n_actions;
716 return actions_next(iter);
719 const union ofp_action *
720 actions_next(struct actions_iterator *iter)
722 if (iter->pos != iter->end) {
723 const union ofp_action *a = iter->pos;
724 unsigned int len = ntohs(a->header.len);
725 iter->pos += len / ACTION_ALIGNMENT;
733 normalize_match(struct ofp_match *m)
735 enum { OFPFW_NW = (OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK | OFPFW_NW_PROTO
737 enum { OFPFW_TP = OFPFW_TP_SRC | OFPFW_TP_DST };
740 wc = ntohl(m->wildcards) & OVSFW_ALL;
741 if (wc & OFPFW_DL_TYPE) {
744 /* Can't sensibly match on network or transport headers if the
745 * data link type is unknown. */
746 wc |= OFPFW_NW | OFPFW_TP;
747 m->nw_src = m->nw_dst = m->nw_proto = m->nw_tos = 0;
748 m->tp_src = m->tp_dst = 0;
749 } else if (m->dl_type == htons(ETH_TYPE_IP)) {
750 if (wc & OFPFW_NW_PROTO) {
753 /* Can't sensibly match on transport headers if the network
754 * protocol is unknown. */
756 m->tp_src = m->tp_dst = 0;
757 } else if (m->nw_proto == IPPROTO_TCP ||
758 m->nw_proto == IPPROTO_UDP ||
759 m->nw_proto == IPPROTO_ICMP) {
760 if (wc & OFPFW_TP_SRC) {
763 if (wc & OFPFW_TP_DST) {
767 /* Transport layer fields will always be extracted as zeros, so we
768 * can do an exact-match on those values. */
770 m->tp_src = m->tp_dst = 0;
772 if (wc & OFPFW_NW_SRC_MASK) {
773 m->nw_src &= flow_nw_bits_to_mask(wc, OFPFW_NW_SRC_SHIFT);
775 if (wc & OFPFW_NW_DST_MASK) {
776 m->nw_dst &= flow_nw_bits_to_mask(wc, OFPFW_NW_DST_SHIFT);
778 if (wc & OFPFW_NW_TOS) {
781 m->nw_tos &= IP_DSCP_MASK;
783 } else if (m->dl_type == htons(ETH_TYPE_ARP)) {
784 if (wc & OFPFW_NW_PROTO) {
787 if (wc & OFPFW_NW_SRC_MASK) {
788 m->nw_src &= flow_nw_bits_to_mask(wc, OFPFW_NW_SRC_SHIFT);
790 if (wc & OFPFW_NW_DST_MASK) {
791 m->nw_dst &= flow_nw_bits_to_mask(wc, OFPFW_NW_DST_SHIFT);
793 m->tp_src = m->tp_dst = m->nw_tos = 0;
795 /* Network and transport layer fields will always be extracted as
796 * zeros, so we can do an exact-match on those values. */
797 wc &= ~(OFPFW_NW | OFPFW_TP);
798 m->nw_proto = m->nw_src = m->nw_dst = m->nw_tos = 0;
799 m->tp_src = m->tp_dst = 0;
801 if (wc & OFPFW_DL_SRC) {
802 memset(m->dl_src, 0, sizeof m->dl_src);
804 if (wc & OFPFW_DL_DST) {
805 memset(m->dl_dst, 0, sizeof m->dl_dst);
807 m->wildcards = htonl(wc);
810 /* Returns a string that describes 'match' in a very literal way, without
811 * interpreting its contents except in a very basic fashion. The returned
812 * string is intended to be fixed-length, so that it is easy to see differences
813 * between two such strings if one is put above another. This is useful for
814 * describing changes made by normalize_match().
816 * The caller must free the returned string (with free()). */
818 ofp_match_to_literal_string(const struct ofp_match *match)
820 return xasprintf("wildcards=%#10"PRIx32" "
821 " in_port=%5"PRId16" "
822 " dl_src="ETH_ADDR_FMT" "
823 " dl_dst="ETH_ADDR_FMT" "
824 " dl_vlan=%5"PRId16" "
825 " dl_vlan_pcp=%3"PRId8" "
826 " dl_type=%#6"PRIx16" "
827 " nw_tos=%#4"PRIx8" "
828 " nw_proto=%#4"PRIx16" "
829 " nw_src=%#10"PRIx32" "
830 " nw_dst=%#10"PRIx32" "
831 " tp_src=%5"PRId16" "
833 ntohl(match->wildcards),
834 ntohs(match->in_port),
835 ETH_ADDR_ARGS(match->dl_src),
836 ETH_ADDR_ARGS(match->dl_dst),
837 ntohs(match->dl_vlan),
839 ntohs(match->dl_type),
842 ntohl(match->nw_src),
843 ntohl(match->nw_dst),
844 ntohs(match->tp_src),
845 ntohs(match->tp_dst));
849 vendor_code_to_id(uint8_t code)
852 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) case NAME: return VENDOR_ID;
854 #undef OFPUTIL_VENDOR
860 /* Creates and returns an OpenFlow message of type OFPT_ERROR with the error
861 * information taken from 'error', whose encoding must be as described in the
862 * large comment in ofp-util.h. If 'oh' is nonnull, then the error will use
863 * oh->xid as its transaction ID, and it will include up to the first 64 bytes
866 * Returns NULL if 'error' is not an OpenFlow error code. */
868 make_ofp_error_msg(int error, const struct ofp_header *oh)
870 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
880 if (!is_ofp_error(error)) {
881 /* We format 'error' with strerror() here since it seems likely to be
882 * a system errno value. */
883 VLOG_WARN_RL(&rl, "invalid OpenFlow error code %d (%s)",
884 error, strerror(error));
891 len = ntohs(oh->length);
901 vendor = get_ofp_err_vendor(error);
902 type = get_ofp_err_type(error);
903 code = get_ofp_err_code(error);
904 if (vendor == OFPUTIL_VENDOR_OPENFLOW) {
905 struct ofp_error_msg *oem;
907 oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR, xid, &buf);
908 oem->type = htons(type);
909 oem->code = htons(code);
911 struct ofp_error_msg *oem;
912 struct nx_vendor_error *nve;
915 vendor_id = vendor_code_to_id(vendor);
916 if (vendor_id == UINT32_MAX) {
917 VLOG_WARN_RL(&rl, "error %x contains invalid vendor code %d",
922 oem = make_openflow_xid(len + sizeof *oem + sizeof *nve,
923 OFPT_ERROR, xid, &buf);
924 oem->type = htons(NXET_VENDOR);
925 oem->code = htons(NXVC_VENDOR_ERROR);
927 nve = ofpbuf_put_uninit(buf, sizeof *nve);
928 nve->vendor = htonl(vendor_id);
929 nve->type = htons(type);
930 nve->code = htons(code);
934 ofpbuf_put(buf, data, len);
940 /* Attempts to pull 'actions_len' bytes from the front of 'b'. Returns 0 if
941 * successful, otherwise an OpenFlow error.
943 * If successful, the first action is stored in '*actionsp' and the number of
944 * "union ofp_action" size elements into '*n_actionsp'. Otherwise NULL and 0
945 * are stored, respectively.
947 * This function does not check that the actions are valid (the caller should
948 * do so, with validate_actions()). The caller is also responsible for making
949 * sure that 'b->data' is initially aligned appropriately for "union
952 ofputil_pull_actions(struct ofpbuf *b, unsigned int actions_len,
953 union ofp_action **actionsp, size_t *n_actionsp)
955 if (actions_len % ACTION_ALIGNMENT != 0) {
956 VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
957 "is not a multiple of %d", actions_len, ACTION_ALIGNMENT);
961 *actionsp = ofpbuf_try_pull(b, actions_len);
962 if (*actionsp == NULL) {
963 VLOG_DBG_RL(&bad_ofmsg_rl, "OpenFlow message actions length %u "
964 "exceeds remaining message length (%zu)",
965 actions_len, b->size);
969 *n_actionsp = actions_len / ACTION_ALIGNMENT;
975 return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);