2 * Copyright (c) 2012, 2013, 2014, 2015, 2016 Nicira, Inc.
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 "byte-order.h"
20 #include "openvswitch/hmap.h"
21 #include "openflow/nicira-ext.h"
22 #include "openflow/openflow.h"
23 #include "openvswitch/dynamic-string.h"
24 #include "openvswitch/ofp-msgs.h"
25 #include "openvswitch/ofpbuf.h"
26 #include "openvswitch/vlog.h"
27 #include "ovs-thread.h"
30 VLOG_DEFINE_THIS_MODULE(ofp_msgs
);
33 #define OFPT10_STATS_REQUEST 16
34 #define OFPT10_STATS_REPLY 17
35 #define OFPT11_STATS_REQUEST 18
36 #define OFPT11_STATS_REPLY 19
37 #define OFPST_VENDOR 0xffff
39 /* Vendor extension message. */
40 struct ofp_vendor_header
{
41 struct ofp_header header
; /* OFPT_VENDOR. */
42 ovs_be32 vendor
; /* Vendor ID:
43 * - MSB 0: low-order bytes are IEEE OUI.
44 * - MSB != 0: defined by OpenFlow
47 /* In theory everything after 'vendor' is vendor specific. In practice,
48 * the vendors we support put a 32-bit subtype here. We'll change this
49 * structure if we start adding support for other vendor formats. */
50 ovs_be32 subtype
; /* Vendor-specific subtype. */
52 /* Followed by vendor-defined additional data. */
54 OFP_ASSERT(sizeof(struct ofp_vendor_header
) == 16);
56 /* Statistics request or reply message. */
57 struct ofp10_stats_msg
{
58 struct ofp_header header
;
59 ovs_be16 type
; /* One of the OFPST_* constants. */
60 ovs_be16 flags
; /* Requests: always 0.
61 * Replies: 0 or OFPSF_REPLY_MORE. */
63 OFP_ASSERT(sizeof(struct ofp10_stats_msg
) == 12);
65 /* Vendor extension stats message. */
66 struct ofp10_vendor_stats_msg
{
67 struct ofp10_stats_msg osm
; /* Type OFPST_VENDOR. */
68 ovs_be32 vendor
; /* Vendor ID:
69 * - MSB 0: low-order bytes are IEEE OUI.
70 * - MSB != 0: defined by OpenFlow
72 /* Followed by vendor-defined arbitrary additional data. */
74 OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg
) == 16);
76 struct ofp11_stats_msg
{
77 struct ofp_header header
;
78 ovs_be16 type
; /* One of the OFPST_* constants. */
79 ovs_be16 flags
; /* OFPSF_REQ_* flags (none yet defined). */
81 /* Followed by the body of the request. */
83 OFP_ASSERT(sizeof(struct ofp11_stats_msg
) == 16);
85 /* Vendor extension stats message. */
86 struct ofp11_vendor_stats_msg
{
87 struct ofp11_stats_msg osm
; /* Type OFPST_VENDOR. */
88 ovs_be32 vendor
; /* Vendor ID:
89 * - MSB 0: low-order bytes are IEEE OUI.
90 * - MSB != 0: defined by OpenFlow
93 /* In theory everything after 'vendor' is vendor specific. In practice,
94 * the vendors we support put a 32-bit subtype here. We'll change this
95 * structure if we start adding support for other vendor formats. */
96 ovs_be32 subtype
; /* Vendor-specific subtype. */
98 /* Followed by vendor-defined additional data. */
100 OFP_ASSERT(sizeof(struct ofp11_vendor_stats_msg
) == 24);
102 /* Header for Nicira vendor stats request and reply messages in OpenFlow
104 struct nicira10_stats_msg
{
105 struct ofp10_vendor_stats_msg vsm
; /* Vendor NX_VENDOR_ID. */
106 ovs_be32 subtype
; /* One of NXST_* below. */
107 uint8_t pad
[4]; /* Align to 64-bits. */
109 OFP_ASSERT(sizeof(struct nicira10_stats_msg
) == 24);
111 /* A thin abstraction of OpenFlow headers:
113 * - 'version' and 'type' come straight from struct ofp_header, so these are
114 * always present and meaningful.
116 * - 'stat' comes from the 'type' member in statistics messages only. It is
117 * meaningful, therefore, only if 'version' and 'type' taken together
118 * specify a statistics request or reply. Otherwise it is 0.
120 * - 'vendor' is meaningful only for vendor messages, that is, if 'version'
121 * and 'type' specify a vendor message or if 'version' and 'type' specify
122 * a statistics message and 'stat' specifies a vendor statistic type.
125 * - 'subtype' is meaningful only for vendor messages and otherwise 0. It
126 * specifies a vendor-defined subtype. There is no standard format for
127 * these but 32 bits seems like it should be enough. */
129 uint8_t version
; /* From ofp_header. */
130 uint8_t type
; /* From ofp_header. */
131 uint16_t stat
; /* From ofp10_stats_msg or ofp11_stats_msg. */
132 uint32_t vendor
; /* From ofp_vendor_header,
133 * ofp10_vendor_stats_msg, or
134 * ofp11_vendor_stats_msg. */
135 uint32_t subtype
; /* From nicira_header, nicira10_stats_msg, or
136 * nicira11_stats_msg. */
138 BUILD_ASSERT_DECL(sizeof(struct ofphdrs
) == 12);
140 /* A mapping from OpenFlow headers to OFPRAW_*. */
141 struct raw_instance
{
142 struct hmap_node hmap_node
; /* In 'raw_instance_map'. */
143 struct ofphdrs hdrs
; /* Key. */
144 enum ofpraw raw
; /* Value. */
145 unsigned int hdrs_len
; /* ofphdrs_len(hdrs). */
148 /* Information about a particular 'enum ofpraw'. */
150 /* All possible instantiations of this OFPRAW_* into OpenFlow headers. */
151 struct raw_instance
*instances
; /* min_version - max_version + 1 elems. */
155 unsigned int min_body
;
156 unsigned int extra_multiple
;
161 /* All understood OpenFlow message types, indexed by their 'struct ofphdrs'. */
162 static struct hmap raw_instance_map
;
163 #include "ofp-msgs.inc"
165 static ovs_be32
alloc_xid(void);
167 /* ofphdrs functions. */
168 static uint32_t ofphdrs_hash(const struct ofphdrs
*);
169 static bool ofphdrs_equal(const struct ofphdrs
*a
, const struct ofphdrs
*b
);
170 static enum ofperr
ofphdrs_decode(struct ofphdrs
*,
171 const struct ofp_header
*oh
, size_t length
);
172 static void ofphdrs_decode_assert(struct ofphdrs
*,
173 const struct ofp_header
*oh
, size_t length
);
174 size_t ofphdrs_len(const struct ofphdrs
*);
176 static const struct raw_info
*raw_info_get(enum ofpraw
);
177 static struct raw_instance
*raw_instance_get(const struct raw_info
*,
180 static enum ofperr
ofpraw_from_ofphdrs(enum ofpraw
*, const struct ofphdrs
*);
182 /* Returns a transaction ID to use for an outgoing OpenFlow message. */
186 static atomic_count next_xid
= ATOMIC_COUNT_INIT(1);
188 return htonl(atomic_count_inc(&next_xid
));
192 ofphdrs_hash(const struct ofphdrs
*hdrs
)
194 BUILD_ASSERT_DECL(sizeof *hdrs
% 4 == 0);
195 return hash_bytes32((const uint32_t *) hdrs
, sizeof *hdrs
, 0);
199 ofphdrs_equal(const struct ofphdrs
*a
, const struct ofphdrs
*b
)
201 return !memcmp(a
, b
, sizeof *a
);
205 log_bad_vendor(uint32_t vendor
)
207 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
209 VLOG_WARN_RL(&rl
, "OpenFlow message has unknown vendor %#"PRIx32
, vendor
);
213 ofphdrs_decode(struct ofphdrs
*hdrs
,
214 const struct ofp_header
*oh
, size_t length
)
216 memset(hdrs
, 0, sizeof *hdrs
);
217 if (length
< sizeof *oh
) {
218 return OFPERR_OFPBRC_BAD_LEN
;
221 /* Get base message version and type (OFPT_*). */
222 hdrs
->version
= oh
->version
;
223 hdrs
->type
= oh
->type
;
225 if (hdrs
->type
== OFPT_VENDOR
) {
227 const struct ofp_vendor_header
*ovh
;
229 if (length
< sizeof *ovh
) {
230 return OFPERR_OFPBRC_BAD_LEN
;
233 ovh
= (const struct ofp_vendor_header
*) oh
;
234 hdrs
->vendor
= ntohl(ovh
->vendor
);
235 if (hdrs
->vendor
== NX_VENDOR_ID
|| hdrs
->vendor
== ONF_VENDOR_ID
) {
236 hdrs
->subtype
= ntohl(ovh
->subtype
);
238 log_bad_vendor(hdrs
->vendor
);
239 return OFPERR_OFPBRC_BAD_VENDOR
;
241 } else if (hdrs
->version
== OFP10_VERSION
242 && (hdrs
->type
== OFPT10_STATS_REQUEST
||
243 hdrs
->type
== OFPT10_STATS_REPLY
)) {
244 const struct ofp10_stats_msg
*osm
;
246 /* Get statistic type (OFPST_*). */
247 if (length
< sizeof *osm
) {
248 return OFPERR_OFPBRC_BAD_LEN
;
250 osm
= (const struct ofp10_stats_msg
*) oh
;
251 hdrs
->stat
= ntohs(osm
->type
);
253 if (hdrs
->stat
== OFPST_VENDOR
) {
255 const struct ofp10_vendor_stats_msg
*ovsm
;
257 if (length
< sizeof *ovsm
) {
258 return OFPERR_OFPBRC_BAD_LEN
;
261 ovsm
= (const struct ofp10_vendor_stats_msg
*) oh
;
262 hdrs
->vendor
= ntohl(ovsm
->vendor
);
263 if (hdrs
->vendor
== NX_VENDOR_ID
) {
264 /* Get Nicira statistic type (NXST_*). */
265 const struct nicira10_stats_msg
*nsm
;
267 if (length
< sizeof *nsm
) {
268 return OFPERR_OFPBRC_BAD_LEN
;
270 nsm
= (const struct nicira10_stats_msg
*) oh
;
271 hdrs
->subtype
= ntohl(nsm
->subtype
);
273 log_bad_vendor(hdrs
->vendor
);
274 return OFPERR_OFPBRC_BAD_VENDOR
;
277 } else if (hdrs
->version
!= OFP10_VERSION
278 && (hdrs
->type
== OFPT11_STATS_REQUEST
||
279 hdrs
->type
== OFPT11_STATS_REPLY
)) {
280 const struct ofp11_stats_msg
*osm
;
282 /* Get statistic type (OFPST_*). */
283 if (length
< sizeof *osm
) {
284 return OFPERR_OFPBRC_BAD_LEN
;
286 osm
= (const struct ofp11_stats_msg
*) oh
;
287 hdrs
->stat
= ntohs(osm
->type
);
289 if (hdrs
->stat
== OFPST_VENDOR
) {
291 const struct ofp11_vendor_stats_msg
*ovsm
;
293 if (length
< sizeof *ovsm
) {
294 return OFPERR_OFPBRC_BAD_LEN
;
297 ovsm
= (const struct ofp11_vendor_stats_msg
*) oh
;
298 hdrs
->vendor
= ntohl(ovsm
->vendor
);
299 if (hdrs
->vendor
== NX_VENDOR_ID
||
300 hdrs
->vendor
== ONF_VENDOR_ID
) {
301 hdrs
->subtype
= ntohl(ovsm
->subtype
);
303 log_bad_vendor(hdrs
->vendor
);
304 return OFPERR_OFPBRC_BAD_VENDOR
;
313 ofphdrs_decode_assert(struct ofphdrs
*hdrs
,
314 const struct ofp_header
*oh
, size_t length
)
316 enum ofperr error
= ofphdrs_decode(hdrs
, oh
, length
);
321 ofp_is_stat_request(enum ofp_version version
, uint8_t type
)
325 return type
== OFPT10_STATS_REQUEST
;
332 return type
== OFPT11_STATS_REQUEST
;
339 ofp_is_stat_reply(enum ofp_version version
, uint8_t type
)
343 return type
== OFPT10_STATS_REPLY
;
350 return type
== OFPT11_STATS_REPLY
;
357 ofp_is_stat(enum ofp_version version
, uint8_t type
)
359 return (ofp_is_stat_request(version
, type
) ||
360 ofp_is_stat_reply(version
, type
));
364 ofphdrs_is_stat(const struct ofphdrs
*hdrs
)
366 return ofp_is_stat(hdrs
->version
, hdrs
->type
);
370 ofphdrs_len(const struct ofphdrs
*hdrs
)
372 if (hdrs
->type
== OFPT_VENDOR
) {
373 return sizeof(struct ofp_vendor_header
);
376 switch ((enum ofp_version
) hdrs
->version
) {
378 if (hdrs
->type
== OFPT10_STATS_REQUEST
||
379 hdrs
->type
== OFPT10_STATS_REPLY
) {
380 return (hdrs
->stat
== OFPST_VENDOR
381 ? sizeof(struct nicira10_stats_msg
)
382 : sizeof(struct ofp10_stats_msg
));
392 if (hdrs
->type
== OFPT11_STATS_REQUEST
||
393 hdrs
->type
== OFPT11_STATS_REPLY
) {
394 return (hdrs
->stat
== OFPST_VENDOR
395 ? sizeof(struct ofp11_vendor_stats_msg
)
396 : sizeof(struct ofp11_stats_msg
));
401 return sizeof(struct ofp_header
);
404 /* Determines the OFPRAW_* type of the OpenFlow message at 'oh', which has
405 * length 'oh->length'. (The caller must ensure that 'oh->length' bytes of
406 * data are readable at 'oh'.) On success, returns 0 and stores the type into
407 * '*raw'. On failure, returns an OFPERR_* error code and zeros '*raw'.
409 * This function checks that 'oh' is a valid length for its particular type of
410 * message, and returns an error if not. */
412 ofpraw_decode(enum ofpraw
*raw
, const struct ofp_header
*oh
)
414 struct ofpbuf msg
= ofpbuf_const_initializer(oh
, ntohs(oh
->length
));
415 return ofpraw_pull(raw
, &msg
);
418 /* Does the same job as ofpraw_decode(), except that it assert-fails if
419 * ofpraw_decode() would have reported an error. Thus, it's able to use the
420 * return value for the OFPRAW_* message type instead of an error code.
422 * (It only makes sense to use this function if you previously called
423 * ofpraw_decode() on the message and thus know that it's OK.) */
425 ofpraw_decode_assert(const struct ofp_header
*oh
)
430 error
= ofpraw_decode(&raw
, oh
);
435 /* Determines the OFPRAW_* type of the OpenFlow message in 'msg', which starts
436 * at 'msg->data' and has length 'msg->size' bytes. On success,
437 * returns 0 and stores the type into '*rawp'. On failure, returns an OFPERR_*
438 * error code and zeros '*rawp'.
440 * This function checks that the message has a valid length for its particular
441 * type of message, and returns an error if not.
443 * In addition to setting '*rawp', this function pulls off the OpenFlow header
444 * (including the stats headers, vendor header, and any subtype header) with
445 * ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow
446 * header and 'msg->msg' just beyond the headers (that is, to the final value
449 ofpraw_pull(enum ofpraw
*rawp
, struct ofpbuf
*msg
)
451 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 5);
453 const struct raw_instance
*instance
;
454 const struct raw_info
*info
;
457 unsigned int min_len
;
463 /* Set default outputs. */
464 msg
->header
= msg
->data
;
465 msg
->msg
= msg
->header
;
469 error
= ofphdrs_decode(&hdrs
, msg
->data
, len
);
474 error
= ofpraw_from_ofphdrs(&raw
, &hdrs
);
479 info
= raw_info_get(raw
);
480 instance
= raw_instance_get(info
, hdrs
.version
);
481 msg
->header
= ofpbuf_pull(msg
, instance
->hdrs_len
);
482 msg
->msg
= msg
->data
;
484 min_len
= instance
->hdrs_len
+ info
->min_body
;
485 switch (info
->extra_multiple
) {
487 if (len
!= min_len
) {
488 VLOG_WARN_RL(&rl
, "received %s with incorrect length %u (expected "
489 "length %u)", info
->name
, len
, min_len
);
490 return OFPERR_OFPBRC_BAD_LEN
;
496 VLOG_WARN_RL(&rl
, "received %s with incorrect length %u (expected "
497 "length at least %u bytes)",
498 info
->name
, len
, min_len
);
499 return OFPERR_OFPBRC_BAD_LEN
;
504 if (len
< min_len
|| (len
- min_len
) % info
->extra_multiple
) {
505 VLOG_WARN_RL(&rl
, "received %s with incorrect length %u (must be "
506 "exactly %u bytes or longer by an integer multiple "
508 info
->name
, len
, min_len
, info
->extra_multiple
);
509 return OFPERR_OFPBRC_BAD_LEN
;
518 /* Does the same job as ofpraw_pull(), except that it assert-fails if
519 * ofpraw_pull() would have reported an error. Thus, it's able to use the
520 * return value for the OFPRAW_* message type instead of an error code.
522 * (It only makes sense to use this function if you previously called
523 * ofpraw_decode() on the message and thus know that it's OK.) */
525 ofpraw_pull_assert(struct ofpbuf
*msg
)
530 error
= ofpraw_pull(&raw
, msg
);
535 /* Determines the OFPRAW_* type of the OpenFlow message that starts at 'oh' and
536 * has length 'length' bytes. On success, returns 0 and stores the type into
537 * '*rawp'. On failure, returns an OFPERR_* error code and zeros '*rawp'.
539 * Unlike other functions for decoding message types, this one is not picky
540 * about message length. For example, it will successfully decode a message
541 * whose body is shorter than the minimum length for a message of its type.
542 * Thus, this is the correct function to use for decoding the type of a message
543 * that might have been truncated, such as the payload of an OpenFlow error
544 * message (which is allowed to be truncated to 64 bytes). */
546 ofpraw_decode_partial(enum ofpraw
*raw
,
547 const struct ofp_header
*oh
, size_t length
)
552 error
= ofphdrs_decode(&hdrs
, oh
, length
);
554 error
= ofpraw_from_ofphdrs(raw
, &hdrs
);
563 /* Encoding messages using OFPRAW_* values. */
565 static void ofpraw_put__(enum ofpraw
, uint8_t version
, ovs_be32 xid
,
566 size_t extra_tailroom
, struct ofpbuf
*);
568 /* Allocates and returns a new ofpbuf that contains an OpenFlow header for
569 * 'raw' with OpenFlow version 'version' and a fresh OpenFlow transaction ID.
570 * The ofpbuf has enough tailroom for the minimum body length of 'raw', plus
571 * 'extra_tailroom' additional bytes.
573 * Each 'raw' value is valid only for certain OpenFlow versions. The caller
574 * must specify a valid (raw, version) pair.
576 * In the returned ofpbuf, 'header' points to the beginning of the
577 * OpenFlow header and 'msg' points just after it, to where the
578 * message's body will start. The caller must actually allocate the
579 * body into the space reserved for it, e.g. with ofpbuf_put_uninit().
581 * The caller owns the returned ofpbuf and must free it when it is no longer
582 * needed, e.g. with ofpbuf_delete(). */
584 ofpraw_alloc(enum ofpraw raw
, uint8_t version
, size_t extra_tailroom
)
586 return ofpraw_alloc_xid(raw
, version
, alloc_xid(), extra_tailroom
);
589 /* Same as ofpraw_alloc() but the caller provides the transaction ID. */
591 ofpraw_alloc_xid(enum ofpraw raw
, uint8_t version
, ovs_be32 xid
,
592 size_t extra_tailroom
)
594 struct ofpbuf
*buf
= ofpbuf_new(0);
595 ofpraw_put__(raw
, version
, xid
, extra_tailroom
, buf
);
599 /* Same as ofpraw_alloc(), but obtains the OpenFlow version and transaction ID
600 * from 'request->version' and 'request->xid', respectively.
602 * Even though the version comes from 'request->version', the caller must still
603 * know what it is doing, by specifying a valid pairing of 'raw' and
604 * 'request->version', just like ofpraw_alloc(). */
606 ofpraw_alloc_reply(enum ofpraw raw
, const struct ofp_header
*request
,
607 size_t extra_tailroom
)
609 return ofpraw_alloc_xid(raw
, request
->version
, request
->xid
,
613 /* Allocates and returns a new ofpbuf that contains an OpenFlow header that is
614 * a stats reply to the stats request in 'request', using the same OpenFlow
615 * version and transaction ID as 'request'. The ofpbuf has enough tailroom for
616 * the stats reply's minimum body length, plus 'extra_tailroom' additional
619 * 'request' must be a stats request, that is, an OFPRAW_OFPST* or OFPRAW_NXST*
620 * value. Every stats request has a corresponding reply, so the (raw, version)
621 * pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here.
623 * In the returned ofpbuf, 'header' points to the beginning of the
624 * OpenFlow header and 'msg' points just after it, to where the
625 * message's body will start. The caller must actually allocate the
626 * body into the space reserved for it, e.g. with ofpbuf_put_uninit().
628 * The caller owns the returned ofpbuf and must free it when it is no longer
629 * needed, e.g. with ofpbuf_delete(). */
631 ofpraw_alloc_stats_reply(const struct ofp_header
*request
,
632 size_t extra_tailroom
)
634 enum ofpraw request_raw
;
635 enum ofpraw reply_raw
;
638 error
= ofpraw_decode_partial(&request_raw
, request
,
639 ntohs(request
->length
));
642 reply_raw
= ofpraw_stats_request_to_reply(request_raw
, request
->version
);
643 ovs_assert(reply_raw
);
645 return ofpraw_alloc_reply(reply_raw
, request
, extra_tailroom
);
648 /* Appends to 'buf' an OpenFlow header for 'raw' with OpenFlow version
649 * 'version' and a fresh OpenFlow transaction ID. Preallocates enough tailroom
650 * in 'buf' for the minimum body length of 'raw', plus 'extra_tailroom'
653 * Each 'raw' value is valid only for certain OpenFlow versions. The caller
654 * must specify a valid (raw, version) pair.
656 * Upon return, 'buf->header' points to the beginning of the OpenFlow header
657 * and 'buf->msg' points just after it, to where the message's body will start.
658 * The caller must actually allocating the body into the space reserved for it,
659 * e.g. with ofpbuf_put_uninit(). */
661 ofpraw_put(enum ofpraw raw
, uint8_t version
, struct ofpbuf
*buf
)
663 ofpraw_put__(raw
, version
, alloc_xid(), 0, buf
);
666 /* Same as ofpraw_put() but the caller provides the transaction ID. */
668 ofpraw_put_xid(enum ofpraw raw
, uint8_t version
, ovs_be32 xid
,
671 ofpraw_put__(raw
, version
, xid
, 0, buf
);
674 /* Same as ofpraw_put(), but obtains the OpenFlow version and transaction ID
675 * from 'request->version' and 'request->xid', respectively.
677 * Even though the version comes from 'request->version', the caller must still
678 * know what it is doing, by specifying a valid pairing of 'raw' and
679 * 'request->version', just like ofpraw_put(). */
681 ofpraw_put_reply(enum ofpraw raw
, const struct ofp_header
*request
,
684 ofpraw_put__(raw
, request
->version
, request
->xid
, 0, buf
);
687 /* Appends to 'buf' an OpenFlow header that is a stats reply to the stats
688 * request in 'request', using the same OpenFlow version and transaction ID as
689 * 'request'. Preallocate enough tailroom in 'buf for the stats reply's
690 * minimum body length, plus 'extra_tailroom' additional bytes.
692 * 'request' must be a stats request, that is, an OFPRAW_OFPST* or OFPRAW_NXST*
693 * value. Every stats request has a corresponding reply, so the (raw, version)
694 * pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here.
696 * In the returned ofpbuf, 'header' points to the beginning of the
697 * OpenFlow header and 'msg' points just after it, to where the
698 * message's body will start. The caller must actually allocate the
699 * body into the space reserved for it, e.g. with ofpbuf_put_uninit().
701 * The caller owns the returned ofpbuf and must free it when it is no longer
702 * needed, e.g. with ofpbuf_delete(). */
704 ofpraw_put_stats_reply(const struct ofp_header
*request
, struct ofpbuf
*buf
)
709 error
= ofpraw_decode_partial(&raw
, request
, ntohs(request
->length
));
712 raw
= ofpraw_stats_request_to_reply(raw
, request
->version
);
715 ofpraw_put__(raw
, request
->version
, request
->xid
, 0, buf
);
719 ofpraw_put__(enum ofpraw raw
, uint8_t version
, ovs_be32 xid
,
720 size_t extra_tailroom
, struct ofpbuf
*buf
)
722 const struct raw_info
*info
= raw_info_get(raw
);
723 const struct raw_instance
*instance
= raw_instance_get(info
, version
);
724 const struct ofphdrs
*hdrs
= &instance
->hdrs
;
725 struct ofp_header
*oh
;
727 ofpbuf_prealloc_tailroom(buf
, (instance
->hdrs_len
+ info
->min_body
729 buf
->header
= ofpbuf_put_uninit(buf
, instance
->hdrs_len
);
730 buf
->msg
= ofpbuf_tail(buf
);
733 oh
->version
= version
;
734 oh
->type
= hdrs
->type
;
735 oh
->length
= htons(buf
->size
);
738 if (hdrs
->type
== OFPT_VENDOR
) {
739 struct ofp_vendor_header
*ovh
= buf
->header
;
741 ovh
->vendor
= htonl(hdrs
->vendor
);
742 ovh
->subtype
= htonl(hdrs
->subtype
);
743 } else if (version
== OFP10_VERSION
744 && (hdrs
->type
== OFPT10_STATS_REQUEST
||
745 hdrs
->type
== OFPT10_STATS_REPLY
)) {
746 struct ofp10_stats_msg
*osm
= buf
->header
;
748 osm
->type
= htons(hdrs
->stat
);
749 osm
->flags
= htons(0);
751 if (hdrs
->stat
== OFPST_VENDOR
) {
752 struct ofp10_vendor_stats_msg
*ovsm
= buf
->header
;
754 ovsm
->vendor
= htonl(hdrs
->vendor
);
755 if (hdrs
->vendor
== NX_VENDOR_ID
) {
756 struct nicira10_stats_msg
*nsm
= buf
->header
;
758 nsm
->subtype
= htonl(hdrs
->subtype
);
759 memset(nsm
->pad
, 0, sizeof nsm
->pad
);
764 } else if (version
!= OFP10_VERSION
765 && (hdrs
->type
== OFPT11_STATS_REQUEST
||
766 hdrs
->type
== OFPT11_STATS_REPLY
)) {
767 struct ofp11_stats_msg
*osm
= buf
->header
;
769 osm
->type
= htons(hdrs
->stat
);
770 osm
->flags
= htons(0);
771 memset(osm
->pad
, 0, sizeof osm
->pad
);
773 if (hdrs
->stat
== OFPST_VENDOR
) {
774 struct ofp11_vendor_stats_msg
*ovsm
= buf
->header
;
776 ovsm
->vendor
= htonl(hdrs
->vendor
);
777 ovsm
->subtype
= htonl(hdrs
->subtype
);
782 /* Returns 'raw''s name.
784 * The name is the name used for 'raw' in the OpenFlow specification. For
785 * example, ofpraw_get_name(OFPRAW_OFPT10_FEATURES_REPLY) is
786 * "OFPT_FEATURES_REPLY".
788 * The caller must not modify or free the returned string. */
790 ofpraw_get_name(enum ofpraw raw
)
792 return raw_info_get(raw
)->name
;
795 /* Returns the stats reply that corresponds to 'raw' in the given OpenFlow
798 ofpraw_stats_request_to_reply(enum ofpraw raw
, uint8_t version
)
800 const struct raw_info
*info
= raw_info_get(raw
);
801 const struct raw_instance
*instance
= raw_instance_get(info
, version
);
802 enum ofpraw reply_raw
;
806 hdrs
= instance
->hdrs
;
807 switch ((enum ofp_version
)hdrs
.version
) {
809 ovs_assert(hdrs
.type
== OFPT10_STATS_REQUEST
);
810 hdrs
.type
= OFPT10_STATS_REPLY
;
818 ovs_assert(hdrs
.type
== OFPT11_STATS_REQUEST
);
819 hdrs
.type
= OFPT11_STATS_REPLY
;
825 error
= ofpraw_from_ofphdrs(&reply_raw
, &hdrs
);
831 /* Determines the OFPTYPE_* type of the OpenFlow message at 'oh', which has
832 * length 'oh->length'. (The caller must ensure that 'oh->length' bytes of
833 * data are readable at 'oh'.) On success, returns 0 and stores the type into
834 * '*typep'. On failure, returns an OFPERR_* error code and zeros '*typep'.
836 * This function checks that 'oh' is a valid length for its particular type of
837 * message, and returns an error if not. */
839 ofptype_decode(enum ofptype
*typep
, const struct ofp_header
*oh
)
844 error
= ofpraw_decode(&raw
, oh
);
845 *typep
= error
? 0 : ofptype_from_ofpraw(raw
);
849 /* Determines the OFPTYPE_* type of the OpenFlow message in 'msg', which starts
850 * at 'msg->data' and has length 'msg->size' bytes. On success,
851 * returns 0 and stores the type into '*typep'. On failure, returns an
852 * OFPERR_* error code and zeros '*typep'.
854 * This function checks that the message has a valid length for its particular
855 * type of message, and returns an error if not.
857 * In addition to setting '*typep', this function pulls off the OpenFlow header
858 * (including the stats headers, vendor header, and any subtype header) with
859 * ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow
860 * header and 'msg->msg' just beyond the headers (that is, to the final value
863 ofptype_pull(enum ofptype
*typep
, struct ofpbuf
*buf
)
868 error
= ofpraw_pull(&raw
, buf
);
869 *typep
= error
? 0 : ofptype_from_ofpraw(raw
);
873 /* Returns the OFPTYPE_* type that corresponds to 'raw'.
875 * (This is a one-way trip, because the mapping from ofpraw to ofptype is
878 ofptype_from_ofpraw(enum ofpraw raw
)
880 return raw_info_get(raw
)->type
;
884 ofptype_get_name(enum ofptype type
)
886 ovs_assert(type
< ARRAY_SIZE(type_names
));
887 return type_names
[type
];
890 /* Updates the 'length' field of the OpenFlow message in 'buf' to
893 ofpmsg_update_length(struct ofpbuf
*buf
)
895 struct ofp_header
*oh
= ofpbuf_at_assert(buf
, 0, sizeof *oh
);
896 oh
->length
= htons(buf
->size
);
899 /* Returns just past the OpenFlow header (including the stats headers, vendor
900 * header, and any subtype header) in 'oh'. */
902 ofpmsg_body(const struct ofp_header
*oh
)
906 ofphdrs_decode_assert(&hdrs
, oh
, ntohs(oh
->length
));
907 return (const uint8_t *) oh
+ ofphdrs_len(&hdrs
);
910 /* Return if it's a stat/multipart (OFPST) request message. */
912 ofpmsg_is_stat_request(const struct ofp_header
*oh
)
914 return ofp_is_stat_request(oh
->version
, oh
->type
);
917 static ovs_be16
*ofpmp_flags__(const struct ofp_header
*);
919 /* Initializes 'replies' as a new list of stats messages that reply to
920 * 'request', which must be a stats request message. Initially the list will
921 * consist of only a single reply part without any body. The caller should
922 * use calls to the other ofpmp_*() functions to add to the body and split the
923 * message into multiple parts, if necessary. */
925 ofpmp_init(struct ovs_list
*replies
, const struct ofp_header
*request
)
929 ovs_list_init(replies
);
931 msg
= ofpraw_alloc_stats_reply(request
, 1000);
932 ovs_list_push_back(replies
, &msg
->list_node
);
935 /* Prepares to append up to 'len' bytes to the series of statistics replies in
936 * 'replies', which should have been initialized with ofpmp_init(), if
937 * necessary adding a new reply to the list.
939 * Returns an ofpbuf with at least 'len' bytes of tailroom. The 'len' bytes
940 * have not actually been allocated, so the caller must do so with
941 * e.g. ofpbuf_put_uninit(). */
943 ofpmp_reserve(struct ovs_list
*replies
, size_t len
)
945 struct ofpbuf
*msg
= ofpbuf_from_list(ovs_list_back(replies
));
947 if (msg
->size
+ len
<= UINT16_MAX
) {
948 ofpbuf_prealloc_tailroom(msg
, len
);
951 unsigned int hdrs_len
;
955 ofphdrs_decode_assert(&hdrs
, msg
->data
, msg
->size
);
956 hdrs_len
= ofphdrs_len(&hdrs
);
958 next
= ofpbuf_new(MAX(1024, hdrs_len
+ len
));
959 ofpbuf_put(next
, msg
->data
, hdrs_len
);
960 next
->header
= next
->data
;
961 next
->msg
= ofpbuf_tail(next
);
962 ovs_list_push_back(replies
, &next
->list_node
);
964 *ofpmp_flags__(msg
->data
) |= htons(OFPSF_REPLY_MORE
);
970 /* Appends 'len' bytes to the series of statistics replies in 'replies', and
971 * returns the first byte. */
973 ofpmp_append(struct ovs_list
*replies
, size_t len
)
975 return ofpbuf_put_uninit(ofpmp_reserve(replies
, len
), len
);
978 /* Sometimes, when composing stats replies, it's difficult to predict how long
979 * an individual reply chunk will be before actually encoding it into the reply
980 * buffer. This function allows easy handling of this case: just encode the
981 * reply, then use this function to break the message into two pieces if it
982 * exceeds the OpenFlow message limit.
984 * In detail, if the final stats message in 'replies' is too long for OpenFlow,
985 * this function breaks it into two separate stats replies, the first one with
986 * the first 'start_ofs' bytes, the second one containing the bytes from that
989 ofpmp_postappend(struct ovs_list
*replies
, size_t start_ofs
)
991 struct ofpbuf
*msg
= ofpbuf_from_list(ovs_list_back(replies
));
993 ovs_assert(start_ofs
<= UINT16_MAX
);
994 if (msg
->size
> UINT16_MAX
) {
995 size_t len
= msg
->size
- start_ofs
;
996 memcpy(ofpmp_append(replies
, len
),
997 (const uint8_t *) msg
->data
+ start_ofs
, len
);
998 msg
->size
= start_ofs
;
1002 /* Returns the OpenFlow version of the replies being constructed in 'replies',
1003 * which should have been initialized by ofpmp_init(). */
1005 ofpmp_version(struct ovs_list
*replies
)
1007 struct ofpbuf
*msg
= ofpbuf_from_list(ovs_list_back(replies
));
1008 const struct ofp_header
*oh
= msg
->data
;
1013 /* Determines the OFPRAW_* type of the OpenFlow messages in 'replies', which
1014 * should have been initialized by ofpmp_init(). */
1016 ofpmp_decode_raw(struct ovs_list
*replies
)
1018 struct ofpbuf
*msg
= ofpbuf_from_list(ovs_list_back(replies
));
1022 error
= ofpraw_decode_partial(&raw
, msg
->data
, msg
->size
);
1028 ofpmp_flags__(const struct ofp_header
*oh
)
1030 switch ((enum ofp_version
)oh
->version
) {
1032 return &((struct ofp10_stats_msg
*) oh
)->flags
;
1039 return &((struct ofp11_stats_msg
*) oh
)->flags
;
1045 /* Returns the OFPSF_* flags found in the OpenFlow stats header of 'oh', which
1046 * must be an OpenFlow stats request or reply.
1048 * (OFPSF_REPLY_MORE is the only defined flag.) */
1050 ofpmp_flags(const struct ofp_header
*oh
)
1052 return ntohs(*ofpmp_flags__(oh
));
1055 /* Returns true if the OFPSF_REPLY_MORE flag is set in the OpenFlow stats
1056 * header of 'oh', which must be an OpenFlow stats request or reply, false if
1059 ofpmp_more(const struct ofp_header
*oh
)
1061 return (ofpmp_flags(oh
) & OFPSF_REPLY_MORE
) != 0;
1064 static void ofpmsgs_init(void);
1066 static const struct raw_info
*
1067 raw_info_get(enum ofpraw raw
)
1071 ovs_assert(raw
< ARRAY_SIZE(raw_infos
));
1072 return &raw_infos
[raw
];
1075 static struct raw_instance
*
1076 raw_instance_get(const struct raw_info
*info
, uint8_t version
)
1078 ovs_assert(version
>= info
->min_version
&& version
<= info
->max_version
);
1079 return &info
->instances
[version
- info
->min_version
];
1083 ofpraw_from_ofphdrs(enum ofpraw
*raw
, const struct ofphdrs
*hdrs
)
1085 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(1, 1);
1087 struct raw_instance
*raw_hdrs
;
1092 hash
= ofphdrs_hash(hdrs
);
1093 HMAP_FOR_EACH_WITH_HASH (raw_hdrs
, hmap_node
, hash
, &raw_instance_map
) {
1094 if (ofphdrs_equal(hdrs
, &raw_hdrs
->hdrs
)) {
1095 *raw
= raw_hdrs
->raw
;
1100 if (!VLOG_DROP_WARN(&rl
)) {
1104 ds_put_format(&s
, "version %"PRIu8
", type %"PRIu8
,
1105 hdrs
->version
, hdrs
->type
);
1106 if (ofphdrs_is_stat(hdrs
)) {
1107 ds_put_format(&s
, ", stat %"PRIu16
, hdrs
->stat
);
1110 ds_put_format(&s
, ", vendor 0x%"PRIx32
", subtype %"PRIu32
,
1111 hdrs
->vendor
, hdrs
->subtype
);
1113 VLOG_WARN("unknown OpenFlow message (%s)", ds_cstr(&s
));
1117 return (hdrs
->vendor
? OFPERR_OFPBRC_BAD_SUBTYPE
1118 : ofphdrs_is_stat(hdrs
) ? OFPERR_OFPBRC_BAD_STAT
1119 : OFPERR_OFPBRC_BAD_TYPE
);
1125 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
1126 const struct raw_info
*info
;
1128 if (!ovsthread_once_start(&once
)) {
1132 hmap_init(&raw_instance_map
);
1133 for (info
= raw_infos
; info
< &raw_infos
[ARRAY_SIZE(raw_infos
)]; info
++)
1135 int n_instances
= info
->max_version
- info
->min_version
+ 1;
1136 struct raw_instance
*inst
;
1138 for (inst
= info
->instances
;
1139 inst
< &info
->instances
[n_instances
];
1141 inst
->hdrs_len
= ofphdrs_len(&inst
->hdrs
);
1142 hmap_insert(&raw_instance_map
, &inst
->hmap_node
,
1143 ofphdrs_hash(&inst
->hdrs
));
1147 ovsthread_once_done(&once
);