2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 "ofp-print.h"
22 #include <sys/types.h>
23 #include <netinet/in.h>
24 #include <netinet/icmp6.h>
27 #include "byte-order.h"
28 #include "classifier.h"
29 #include "dynamic-string.h"
31 #include "meta-flow.h"
32 #include "multipath.h"
35 #include "ofp-actions.h"
36 #include "ofp-errors.h"
42 #include "unaligned.h"
43 #include "type-props.h"
47 VLOG_DEFINE_THIS_MODULE(ofp_util
);
49 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
50 * in the peer and so there's not much point in showing a lot of them. */
51 static struct vlog_rate_limit bad_ofmsg_rl
= VLOG_RATE_LIMIT_INIT(1, 5);
53 struct ofp_prop_header
{
58 /* Pulls a property, beginning with struct ofp_prop_header, from the beginning
59 * of 'msg'. Stores the type of the property in '*typep' and, if 'property' is
60 * nonnull, the entire property, including the header, in '*property'. Returns
61 * 0 if successful, otherwise an error code. */
63 ofputil_pull_property(struct ofpbuf
*msg
, struct ofpbuf
*property
,
66 struct ofp_prop_header
*oph
;
69 if (ofpbuf_size(msg
) < sizeof *oph
) {
70 return OFPERR_OFPBPC_BAD_LEN
;
73 oph
= ofpbuf_data(msg
);
74 len
= ntohs(oph
->len
);
75 if (len
< sizeof *oph
|| ROUND_UP(len
, 8) > ofpbuf_size(msg
)) {
76 return OFPERR_OFPBPC_BAD_LEN
;
79 *typep
= ntohs(oph
->type
);
81 ofpbuf_use_const(property
, ofpbuf_data(msg
), len
);
83 ofpbuf_pull(msg
, ROUND_UP(len
, 8));
87 static void PRINTF_FORMAT(2, 3)
88 log_property(bool loose
, const char *message
, ...)
90 enum vlog_level level
= loose
? VLL_DBG
: VLL_WARN
;
91 if (!vlog_should_drop(THIS_MODULE
, level
, &bad_ofmsg_rl
)) {
94 va_start(args
, message
);
95 vlog_valist(THIS_MODULE
, level
, message
, args
);
100 /* Given the wildcard bit count in the least-significant 6 of 'wcbits', returns
101 * an IP netmask with a 1 in each bit that must match and a 0 in each bit that
104 * The bits in 'wcbits' are in the format used in enum ofp_flow_wildcards: 0
105 * is exact match, 1 ignores the LSB, 2 ignores the 2 least-significant bits,
106 * ..., 32 and higher wildcard the entire field. This is the *opposite* of the
107 * usual convention where e.g. /24 indicates that 8 bits (not 24 bits) are
110 ofputil_wcbits_to_netmask(int wcbits
)
113 return wcbits
< 32 ? htonl(~((1u << wcbits
) - 1)) : 0;
116 /* Given the IP netmask 'netmask', returns the number of bits of the IP address
117 * that it wildcards, that is, the number of 0-bits in 'netmask', a number
118 * between 0 and 32 inclusive.
120 * If 'netmask' is not a CIDR netmask (see ip_is_cidr()), the return value will
121 * still be in the valid range but isn't otherwise meaningful. */
123 ofputil_netmask_to_wcbits(ovs_be32 netmask
)
125 return 32 - ip_count_cidr_bits(netmask
);
128 /* Converts the OpenFlow 1.0 wildcards in 'ofpfw' (OFPFW10_*) into a
129 * flow_wildcards in 'wc' for use in struct match. It is the caller's
130 * responsibility to handle the special case where the flow match's dl_vlan is
131 * set to OFP_VLAN_NONE. */
133 ofputil_wildcard_from_ofpfw10(uint32_t ofpfw
, struct flow_wildcards
*wc
)
135 BUILD_ASSERT_DECL(FLOW_WC_SEQ
== 27);
137 /* Initialize most of wc. */
138 flow_wildcards_init_catchall(wc
);
140 if (!(ofpfw
& OFPFW10_IN_PORT
)) {
141 wc
->masks
.in_port
.ofp_port
= u16_to_ofp(UINT16_MAX
);
144 if (!(ofpfw
& OFPFW10_NW_TOS
)) {
145 wc
->masks
.nw_tos
|= IP_DSCP_MASK
;
148 if (!(ofpfw
& OFPFW10_NW_PROTO
)) {
149 wc
->masks
.nw_proto
= UINT8_MAX
;
151 wc
->masks
.nw_src
= ofputil_wcbits_to_netmask(ofpfw
152 >> OFPFW10_NW_SRC_SHIFT
);
153 wc
->masks
.nw_dst
= ofputil_wcbits_to_netmask(ofpfw
154 >> OFPFW10_NW_DST_SHIFT
);
156 if (!(ofpfw
& OFPFW10_TP_SRC
)) {
157 wc
->masks
.tp_src
= OVS_BE16_MAX
;
159 if (!(ofpfw
& OFPFW10_TP_DST
)) {
160 wc
->masks
.tp_dst
= OVS_BE16_MAX
;
163 if (!(ofpfw
& OFPFW10_DL_SRC
)) {
164 memset(wc
->masks
.dl_src
, 0xff, ETH_ADDR_LEN
);
166 if (!(ofpfw
& OFPFW10_DL_DST
)) {
167 memset(wc
->masks
.dl_dst
, 0xff, ETH_ADDR_LEN
);
169 if (!(ofpfw
& OFPFW10_DL_TYPE
)) {
170 wc
->masks
.dl_type
= OVS_BE16_MAX
;
174 if (!(ofpfw
& OFPFW10_DL_VLAN_PCP
)) {
175 wc
->masks
.vlan_tci
|= htons(VLAN_PCP_MASK
| VLAN_CFI
);
177 if (!(ofpfw
& OFPFW10_DL_VLAN
)) {
178 wc
->masks
.vlan_tci
|= htons(VLAN_VID_MASK
| VLAN_CFI
);
182 /* Converts the ofp10_match in 'ofmatch' into a struct match in 'match'. */
184 ofputil_match_from_ofp10_match(const struct ofp10_match
*ofmatch
,
187 uint32_t ofpfw
= ntohl(ofmatch
->wildcards
) & OFPFW10_ALL
;
189 /* Initialize match->wc. */
190 memset(&match
->flow
, 0, sizeof match
->flow
);
191 ofputil_wildcard_from_ofpfw10(ofpfw
, &match
->wc
);
193 /* Initialize most of match->flow. */
194 match
->flow
.nw_src
= ofmatch
->nw_src
;
195 match
->flow
.nw_dst
= ofmatch
->nw_dst
;
196 match
->flow
.in_port
.ofp_port
= u16_to_ofp(ntohs(ofmatch
->in_port
));
197 match
->flow
.dl_type
= ofputil_dl_type_from_openflow(ofmatch
->dl_type
);
198 match
->flow
.tp_src
= ofmatch
->tp_src
;
199 match
->flow
.tp_dst
= ofmatch
->tp_dst
;
200 memcpy(match
->flow
.dl_src
, ofmatch
->dl_src
, ETH_ADDR_LEN
);
201 memcpy(match
->flow
.dl_dst
, ofmatch
->dl_dst
, ETH_ADDR_LEN
);
202 match
->flow
.nw_tos
= ofmatch
->nw_tos
& IP_DSCP_MASK
;
203 match
->flow
.nw_proto
= ofmatch
->nw_proto
;
205 /* Translate VLANs. */
206 if (!(ofpfw
& OFPFW10_DL_VLAN
) &&
207 ofmatch
->dl_vlan
== htons(OFP10_VLAN_NONE
)) {
208 /* Match only packets without 802.1Q header.
210 * When OFPFW10_DL_VLAN_PCP is wildcarded, this is obviously correct.
212 * If OFPFW10_DL_VLAN_PCP is matched, the flow match is contradictory,
213 * because we can't have a specific PCP without an 802.1Q header.
214 * However, older versions of OVS treated this as matching packets
215 * withut an 802.1Q header, so we do here too. */
216 match
->flow
.vlan_tci
= htons(0);
217 match
->wc
.masks
.vlan_tci
= htons(0xffff);
219 ovs_be16 vid
, pcp
, tci
;
222 vid
= ofmatch
->dl_vlan
& htons(VLAN_VID_MASK
);
223 hpcp
= (ofmatch
->dl_vlan_pcp
<< VLAN_PCP_SHIFT
) & VLAN_PCP_MASK
;
225 tci
= vid
| pcp
| htons(VLAN_CFI
);
226 match
->flow
.vlan_tci
= tci
& match
->wc
.masks
.vlan_tci
;
230 match_zero_wildcarded_fields(match
);
233 /* Convert 'match' into the OpenFlow 1.0 match structure 'ofmatch'. */
235 ofputil_match_to_ofp10_match(const struct match
*match
,
236 struct ofp10_match
*ofmatch
)
238 const struct flow_wildcards
*wc
= &match
->wc
;
241 /* Figure out most OpenFlow wildcards. */
243 if (!wc
->masks
.in_port
.ofp_port
) {
244 ofpfw
|= OFPFW10_IN_PORT
;
246 if (!wc
->masks
.dl_type
) {
247 ofpfw
|= OFPFW10_DL_TYPE
;
249 if (!wc
->masks
.nw_proto
) {
250 ofpfw
|= OFPFW10_NW_PROTO
;
252 ofpfw
|= (ofputil_netmask_to_wcbits(wc
->masks
.nw_src
)
253 << OFPFW10_NW_SRC_SHIFT
);
254 ofpfw
|= (ofputil_netmask_to_wcbits(wc
->masks
.nw_dst
)
255 << OFPFW10_NW_DST_SHIFT
);
256 if (!(wc
->masks
.nw_tos
& IP_DSCP_MASK
)) {
257 ofpfw
|= OFPFW10_NW_TOS
;
259 if (!wc
->masks
.tp_src
) {
260 ofpfw
|= OFPFW10_TP_SRC
;
262 if (!wc
->masks
.tp_dst
) {
263 ofpfw
|= OFPFW10_TP_DST
;
265 if (eth_addr_is_zero(wc
->masks
.dl_src
)) {
266 ofpfw
|= OFPFW10_DL_SRC
;
268 if (eth_addr_is_zero(wc
->masks
.dl_dst
)) {
269 ofpfw
|= OFPFW10_DL_DST
;
272 /* Translate VLANs. */
273 ofmatch
->dl_vlan
= htons(0);
274 ofmatch
->dl_vlan_pcp
= 0;
275 if (match
->wc
.masks
.vlan_tci
== htons(0)) {
276 ofpfw
|= OFPFW10_DL_VLAN
| OFPFW10_DL_VLAN_PCP
;
277 } else if (match
->wc
.masks
.vlan_tci
& htons(VLAN_CFI
)
278 && !(match
->flow
.vlan_tci
& htons(VLAN_CFI
))) {
279 ofmatch
->dl_vlan
= htons(OFP10_VLAN_NONE
);
280 ofpfw
|= OFPFW10_DL_VLAN_PCP
;
282 if (!(match
->wc
.masks
.vlan_tci
& htons(VLAN_VID_MASK
))) {
283 ofpfw
|= OFPFW10_DL_VLAN
;
285 ofmatch
->dl_vlan
= htons(vlan_tci_to_vid(match
->flow
.vlan_tci
));
288 if (!(match
->wc
.masks
.vlan_tci
& htons(VLAN_PCP_MASK
))) {
289 ofpfw
|= OFPFW10_DL_VLAN_PCP
;
291 ofmatch
->dl_vlan_pcp
= vlan_tci_to_pcp(match
->flow
.vlan_tci
);
295 /* Compose most of the match structure. */
296 ofmatch
->wildcards
= htonl(ofpfw
);
297 ofmatch
->in_port
= htons(ofp_to_u16(match
->flow
.in_port
.ofp_port
));
298 memcpy(ofmatch
->dl_src
, match
->flow
.dl_src
, ETH_ADDR_LEN
);
299 memcpy(ofmatch
->dl_dst
, match
->flow
.dl_dst
, ETH_ADDR_LEN
);
300 ofmatch
->dl_type
= ofputil_dl_type_to_openflow(match
->flow
.dl_type
);
301 ofmatch
->nw_src
= match
->flow
.nw_src
;
302 ofmatch
->nw_dst
= match
->flow
.nw_dst
;
303 ofmatch
->nw_tos
= match
->flow
.nw_tos
& IP_DSCP_MASK
;
304 ofmatch
->nw_proto
= match
->flow
.nw_proto
;
305 ofmatch
->tp_src
= match
->flow
.tp_src
;
306 ofmatch
->tp_dst
= match
->flow
.tp_dst
;
307 memset(ofmatch
->pad1
, '\0', sizeof ofmatch
->pad1
);
308 memset(ofmatch
->pad2
, '\0', sizeof ofmatch
->pad2
);
312 ofputil_pull_ofp11_match(struct ofpbuf
*buf
, struct match
*match
,
313 uint16_t *padded_match_len
)
315 struct ofp11_match_header
*omh
= ofpbuf_data(buf
);
318 if (ofpbuf_size(buf
) < sizeof *omh
) {
319 return OFPERR_OFPBMC_BAD_LEN
;
322 match_len
= ntohs(omh
->length
);
324 switch (ntohs(omh
->type
)) {
325 case OFPMT_STANDARD
: {
326 struct ofp11_match
*om
;
328 if (match_len
!= sizeof *om
|| ofpbuf_size(buf
) < sizeof *om
) {
329 return OFPERR_OFPBMC_BAD_LEN
;
331 om
= ofpbuf_pull(buf
, sizeof *om
);
332 if (padded_match_len
) {
333 *padded_match_len
= match_len
;
335 return ofputil_match_from_ofp11_match(om
, match
);
339 if (padded_match_len
) {
340 *padded_match_len
= ROUND_UP(match_len
, 8);
342 return oxm_pull_match(buf
, match
);
345 return OFPERR_OFPBMC_BAD_TYPE
;
349 /* Converts the ofp11_match in 'ofmatch' into a struct match in 'match'.
350 * Returns 0 if successful, otherwise an OFPERR_* value. */
352 ofputil_match_from_ofp11_match(const struct ofp11_match
*ofmatch
,
355 uint16_t wc
= ntohl(ofmatch
->wildcards
);
356 uint8_t dl_src_mask
[ETH_ADDR_LEN
];
357 uint8_t dl_dst_mask
[ETH_ADDR_LEN
];
358 bool ipv4
, arp
, rarp
;
361 match_init_catchall(match
);
363 if (!(wc
& OFPFW11_IN_PORT
)) {
367 error
= ofputil_port_from_ofp11(ofmatch
->in_port
, &ofp_port
);
369 return OFPERR_OFPBMC_BAD_VALUE
;
371 match_set_in_port(match
, ofp_port
);
374 for (i
= 0; i
< ETH_ADDR_LEN
; i
++) {
375 dl_src_mask
[i
] = ~ofmatch
->dl_src_mask
[i
];
377 match_set_dl_src_masked(match
, ofmatch
->dl_src
, dl_src_mask
);
379 for (i
= 0; i
< ETH_ADDR_LEN
; i
++) {
380 dl_dst_mask
[i
] = ~ofmatch
->dl_dst_mask
[i
];
382 match_set_dl_dst_masked(match
, ofmatch
->dl_dst
, dl_dst_mask
);
384 if (!(wc
& OFPFW11_DL_VLAN
)) {
385 if (ofmatch
->dl_vlan
== htons(OFPVID11_NONE
)) {
386 /* Match only packets without a VLAN tag. */
387 match
->flow
.vlan_tci
= htons(0);
388 match
->wc
.masks
.vlan_tci
= OVS_BE16_MAX
;
390 if (ofmatch
->dl_vlan
== htons(OFPVID11_ANY
)) {
391 /* Match any packet with a VLAN tag regardless of VID. */
392 match
->flow
.vlan_tci
= htons(VLAN_CFI
);
393 match
->wc
.masks
.vlan_tci
= htons(VLAN_CFI
);
394 } else if (ntohs(ofmatch
->dl_vlan
) < 4096) {
395 /* Match only packets with the specified VLAN VID. */
396 match
->flow
.vlan_tci
= htons(VLAN_CFI
) | ofmatch
->dl_vlan
;
397 match
->wc
.masks
.vlan_tci
= htons(VLAN_CFI
| VLAN_VID_MASK
);
400 return OFPERR_OFPBMC_BAD_VALUE
;
403 if (!(wc
& OFPFW11_DL_VLAN_PCP
)) {
404 if (ofmatch
->dl_vlan_pcp
<= 7) {
405 match
->flow
.vlan_tci
|= htons(ofmatch
->dl_vlan_pcp
407 match
->wc
.masks
.vlan_tci
|= htons(VLAN_PCP_MASK
);
410 return OFPERR_OFPBMC_BAD_VALUE
;
416 if (!(wc
& OFPFW11_DL_TYPE
)) {
417 match_set_dl_type(match
,
418 ofputil_dl_type_from_openflow(ofmatch
->dl_type
));
421 ipv4
= match
->flow
.dl_type
== htons(ETH_TYPE_IP
);
422 arp
= match
->flow
.dl_type
== htons(ETH_TYPE_ARP
);
423 rarp
= match
->flow
.dl_type
== htons(ETH_TYPE_RARP
);
425 if (ipv4
&& !(wc
& OFPFW11_NW_TOS
)) {
426 if (ofmatch
->nw_tos
& ~IP_DSCP_MASK
) {
428 return OFPERR_OFPBMC_BAD_VALUE
;
431 match_set_nw_dscp(match
, ofmatch
->nw_tos
);
434 if (ipv4
|| arp
|| rarp
) {
435 if (!(wc
& OFPFW11_NW_PROTO
)) {
436 match_set_nw_proto(match
, ofmatch
->nw_proto
);
438 match_set_nw_src_masked(match
, ofmatch
->nw_src
, ~ofmatch
->nw_src_mask
);
439 match_set_nw_dst_masked(match
, ofmatch
->nw_dst
, ~ofmatch
->nw_dst_mask
);
442 #define OFPFW11_TP_ALL (OFPFW11_TP_SRC | OFPFW11_TP_DST)
443 if (ipv4
&& (wc
& OFPFW11_TP_ALL
) != OFPFW11_TP_ALL
) {
444 switch (match
->flow
.nw_proto
) {
446 /* "A.2.3 Flow Match Structures" in OF1.1 says:
448 * The tp_src and tp_dst fields will be ignored unless the
449 * network protocol specified is as TCP, UDP or SCTP.
451 * but I'm pretty sure we should support ICMP too, otherwise
452 * that's a regression from OF1.0. */
453 if (!(wc
& OFPFW11_TP_SRC
)) {
454 uint16_t icmp_type
= ntohs(ofmatch
->tp_src
);
455 if (icmp_type
< 0x100) {
456 match_set_icmp_type(match
, icmp_type
);
458 return OFPERR_OFPBMC_BAD_FIELD
;
461 if (!(wc
& OFPFW11_TP_DST
)) {
462 uint16_t icmp_code
= ntohs(ofmatch
->tp_dst
);
463 if (icmp_code
< 0x100) {
464 match_set_icmp_code(match
, icmp_code
);
466 return OFPERR_OFPBMC_BAD_FIELD
;
474 if (!(wc
& (OFPFW11_TP_SRC
))) {
475 match_set_tp_src(match
, ofmatch
->tp_src
);
477 if (!(wc
& (OFPFW11_TP_DST
))) {
478 match_set_tp_dst(match
, ofmatch
->tp_dst
);
483 /* OF1.1 says explicitly to ignore this. */
488 if (eth_type_mpls(match
->flow
.dl_type
)) {
489 if (!(wc
& OFPFW11_MPLS_LABEL
)) {
490 match_set_mpls_label(match
, 0, ofmatch
->mpls_label
);
492 if (!(wc
& OFPFW11_MPLS_TC
)) {
493 match_set_mpls_tc(match
, 0, ofmatch
->mpls_tc
);
497 match_set_metadata_masked(match
, ofmatch
->metadata
,
498 ~ofmatch
->metadata_mask
);
503 /* Convert 'match' into the OpenFlow 1.1 match structure 'ofmatch'. */
505 ofputil_match_to_ofp11_match(const struct match
*match
,
506 struct ofp11_match
*ofmatch
)
511 memset(ofmatch
, 0, sizeof *ofmatch
);
512 ofmatch
->omh
.type
= htons(OFPMT_STANDARD
);
513 ofmatch
->omh
.length
= htons(OFPMT11_STANDARD_LENGTH
);
515 if (!match
->wc
.masks
.in_port
.ofp_port
) {
516 wc
|= OFPFW11_IN_PORT
;
518 ofmatch
->in_port
= ofputil_port_to_ofp11(match
->flow
.in_port
.ofp_port
);
521 memcpy(ofmatch
->dl_src
, match
->flow
.dl_src
, ETH_ADDR_LEN
);
522 for (i
= 0; i
< ETH_ADDR_LEN
; i
++) {
523 ofmatch
->dl_src_mask
[i
] = ~match
->wc
.masks
.dl_src
[i
];
526 memcpy(ofmatch
->dl_dst
, match
->flow
.dl_dst
, ETH_ADDR_LEN
);
527 for (i
= 0; i
< ETH_ADDR_LEN
; i
++) {
528 ofmatch
->dl_dst_mask
[i
] = ~match
->wc
.masks
.dl_dst
[i
];
531 if (match
->wc
.masks
.vlan_tci
== htons(0)) {
532 wc
|= OFPFW11_DL_VLAN
| OFPFW11_DL_VLAN_PCP
;
533 } else if (match
->wc
.masks
.vlan_tci
& htons(VLAN_CFI
)
534 && !(match
->flow
.vlan_tci
& htons(VLAN_CFI
))) {
535 ofmatch
->dl_vlan
= htons(OFPVID11_NONE
);
536 wc
|= OFPFW11_DL_VLAN_PCP
;
538 if (!(match
->wc
.masks
.vlan_tci
& htons(VLAN_VID_MASK
))) {
539 ofmatch
->dl_vlan
= htons(OFPVID11_ANY
);
541 ofmatch
->dl_vlan
= htons(vlan_tci_to_vid(match
->flow
.vlan_tci
));
544 if (!(match
->wc
.masks
.vlan_tci
& htons(VLAN_PCP_MASK
))) {
545 wc
|= OFPFW11_DL_VLAN_PCP
;
547 ofmatch
->dl_vlan_pcp
= vlan_tci_to_pcp(match
->flow
.vlan_tci
);
551 if (!match
->wc
.masks
.dl_type
) {
552 wc
|= OFPFW11_DL_TYPE
;
554 ofmatch
->dl_type
= ofputil_dl_type_to_openflow(match
->flow
.dl_type
);
557 if (!(match
->wc
.masks
.nw_tos
& IP_DSCP_MASK
)) {
558 wc
|= OFPFW11_NW_TOS
;
560 ofmatch
->nw_tos
= match
->flow
.nw_tos
& IP_DSCP_MASK
;
563 if (!match
->wc
.masks
.nw_proto
) {
564 wc
|= OFPFW11_NW_PROTO
;
566 ofmatch
->nw_proto
= match
->flow
.nw_proto
;
569 ofmatch
->nw_src
= match
->flow
.nw_src
;
570 ofmatch
->nw_src_mask
= ~match
->wc
.masks
.nw_src
;
571 ofmatch
->nw_dst
= match
->flow
.nw_dst
;
572 ofmatch
->nw_dst_mask
= ~match
->wc
.masks
.nw_dst
;
574 if (!match
->wc
.masks
.tp_src
) {
575 wc
|= OFPFW11_TP_SRC
;
577 ofmatch
->tp_src
= match
->flow
.tp_src
;
580 if (!match
->wc
.masks
.tp_dst
) {
581 wc
|= OFPFW11_TP_DST
;
583 ofmatch
->tp_dst
= match
->flow
.tp_dst
;
586 if (!(match
->wc
.masks
.mpls_lse
[0] & htonl(MPLS_LABEL_MASK
))) {
587 wc
|= OFPFW11_MPLS_LABEL
;
589 ofmatch
->mpls_label
= htonl(mpls_lse_to_label(
590 match
->flow
.mpls_lse
[0]));
593 if (!(match
->wc
.masks
.mpls_lse
[0] & htonl(MPLS_TC_MASK
))) {
594 wc
|= OFPFW11_MPLS_TC
;
596 ofmatch
->mpls_tc
= mpls_lse_to_tc(match
->flow
.mpls_lse
[0]);
599 ofmatch
->metadata
= match
->flow
.metadata
;
600 ofmatch
->metadata_mask
= ~match
->wc
.masks
.metadata
;
602 ofmatch
->wildcards
= htonl(wc
);
605 /* Returns the "typical" length of a match for 'protocol', for use in
606 * estimating space to preallocate. */
608 ofputil_match_typical_len(enum ofputil_protocol protocol
)
611 case OFPUTIL_P_OF10_STD
:
612 case OFPUTIL_P_OF10_STD_TID
:
613 return sizeof(struct ofp10_match
);
615 case OFPUTIL_P_OF10_NXM
:
616 case OFPUTIL_P_OF10_NXM_TID
:
617 return NXM_TYPICAL_LEN
;
619 case OFPUTIL_P_OF11_STD
:
620 return sizeof(struct ofp11_match
);
622 case OFPUTIL_P_OF12_OXM
:
623 case OFPUTIL_P_OF13_OXM
:
624 case OFPUTIL_P_OF14_OXM
:
625 case OFPUTIL_P_OF15_OXM
:
626 return NXM_TYPICAL_LEN
;
633 /* Appends to 'b' an struct ofp11_match_header followed by a match that
634 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
635 * data appended out to a multiple of 8. 'protocol' must be one that is usable
636 * in OpenFlow 1.1 or later.
638 * This function can cause 'b''s data to be reallocated.
640 * Returns the number of bytes appended to 'b', excluding the padding. Never
643 ofputil_put_ofp11_match(struct ofpbuf
*b
, const struct match
*match
,
644 enum ofputil_protocol protocol
)
647 case OFPUTIL_P_OF10_STD
:
648 case OFPUTIL_P_OF10_STD_TID
:
649 case OFPUTIL_P_OF10_NXM
:
650 case OFPUTIL_P_OF10_NXM_TID
:
653 case OFPUTIL_P_OF11_STD
: {
654 struct ofp11_match
*om
;
656 /* Make sure that no padding is needed. */
657 BUILD_ASSERT_DECL(sizeof *om
% 8 == 0);
659 om
= ofpbuf_put_uninit(b
, sizeof *om
);
660 ofputil_match_to_ofp11_match(match
, om
);
664 case OFPUTIL_P_OF12_OXM
:
665 case OFPUTIL_P_OF13_OXM
:
666 case OFPUTIL_P_OF14_OXM
:
667 case OFPUTIL_P_OF15_OXM
:
668 return oxm_put_match(b
, match
,
669 ofputil_protocol_to_ofp_version(protocol
));
675 /* Given a 'dl_type' value in the format used in struct flow, returns the
676 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
679 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type
)
681 return (flow_dl_type
== htons(FLOW_DL_TYPE_NONE
)
682 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE
)
686 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
687 * structure, returns the corresponding 'dl_type' value for use in struct
690 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type
)
692 return (ofp_dl_type
== htons(OFP_DL_TYPE_NOT_ETH_TYPE
)
693 ? htons(FLOW_DL_TYPE_NONE
)
699 struct proto_abbrev
{
700 enum ofputil_protocol protocol
;
704 /* Most users really don't care about some of the differences between
705 * protocols. These abbreviations help with that. */
706 static const struct proto_abbrev proto_abbrevs
[] = {
707 { OFPUTIL_P_ANY
, "any" },
708 { OFPUTIL_P_OF10_STD_ANY
, "OpenFlow10" },
709 { OFPUTIL_P_OF10_NXM_ANY
, "NXM" },
710 { OFPUTIL_P_ANY_OXM
, "OXM" },
712 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
714 enum ofputil_protocol ofputil_flow_dump_protocols
[] = {
723 size_t ofputil_n_flow_dump_protocols
= ARRAY_SIZE(ofputil_flow_dump_protocols
);
725 /* Returns the set of ofputil_protocols that are supported with the given
726 * OpenFlow 'version'. 'version' should normally be an 8-bit OpenFlow version
727 * identifier (e.g. 0x01 for OpenFlow 1.0, 0x02 for OpenFlow 1.1). Returns 0
728 * if 'version' is not supported or outside the valid range. */
729 enum ofputil_protocol
730 ofputil_protocols_from_ofp_version(enum ofp_version version
)
734 return OFPUTIL_P_OF10_STD_ANY
| OFPUTIL_P_OF10_NXM_ANY
;
736 return OFPUTIL_P_OF11_STD
;
738 return OFPUTIL_P_OF12_OXM
;
740 return OFPUTIL_P_OF13_OXM
;
742 return OFPUTIL_P_OF14_OXM
;
744 return OFPUTIL_P_OF15_OXM
;
750 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
751 * connection that has negotiated the given 'version'. 'version' should
752 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
753 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
754 * outside the valid range. */
755 enum ofputil_protocol
756 ofputil_protocol_from_ofp_version(enum ofp_version version
)
758 return rightmost_1bit(ofputil_protocols_from_ofp_version(version
));
761 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
762 * etc.) that corresponds to 'protocol'. */
764 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol
)
767 case OFPUTIL_P_OF10_STD
:
768 case OFPUTIL_P_OF10_STD_TID
:
769 case OFPUTIL_P_OF10_NXM
:
770 case OFPUTIL_P_OF10_NXM_TID
:
771 return OFP10_VERSION
;
772 case OFPUTIL_P_OF11_STD
:
773 return OFP11_VERSION
;
774 case OFPUTIL_P_OF12_OXM
:
775 return OFP12_VERSION
;
776 case OFPUTIL_P_OF13_OXM
:
777 return OFP13_VERSION
;
778 case OFPUTIL_P_OF14_OXM
:
779 return OFP14_VERSION
;
780 case OFPUTIL_P_OF15_OXM
:
781 return OFP15_VERSION
;
787 /* Returns a bitmap of OpenFlow versions that are supported by at
788 * least one of the 'protocols'. */
790 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols
)
794 for (; protocols
; protocols
= zero_rightmost_1bit(protocols
)) {
795 enum ofputil_protocol protocol
= rightmost_1bit(protocols
);
797 bitmap
|= 1u << ofputil_protocol_to_ofp_version(protocol
);
803 /* Returns the set of protocols that are supported on top of the
804 * OpenFlow versions included in 'bitmap'. */
805 enum ofputil_protocol
806 ofputil_protocols_from_version_bitmap(uint32_t bitmap
)
808 enum ofputil_protocol protocols
= 0;
810 for (; bitmap
; bitmap
= zero_rightmost_1bit(bitmap
)) {
811 enum ofp_version version
= rightmost_1bit_idx(bitmap
);
813 protocols
|= ofputil_protocols_from_ofp_version(version
);
819 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
822 ofputil_protocol_is_valid(enum ofputil_protocol protocol
)
824 return protocol
& OFPUTIL_P_ANY
&& is_pow2(protocol
);
827 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
828 * extension turned on or off if 'enable' is true or false, respectively.
830 * This extension is only useful for protocols whose "standard" version does
831 * not allow specific tables to be modified. In particular, this is true of
832 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
833 * specifies a table ID and so there is no need for such an extension. When
834 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
835 * extension, this function just returns its 'protocol' argument unchanged
836 * regardless of the value of 'enable'. */
837 enum ofputil_protocol
838 ofputil_protocol_set_tid(enum ofputil_protocol protocol
, bool enable
)
841 case OFPUTIL_P_OF10_STD
:
842 case OFPUTIL_P_OF10_STD_TID
:
843 return enable
? OFPUTIL_P_OF10_STD_TID
: OFPUTIL_P_OF10_STD
;
845 case OFPUTIL_P_OF10_NXM
:
846 case OFPUTIL_P_OF10_NXM_TID
:
847 return enable
? OFPUTIL_P_OF10_NXM_TID
: OFPUTIL_P_OF10_NXM
;
849 case OFPUTIL_P_OF11_STD
:
850 return OFPUTIL_P_OF11_STD
;
852 case OFPUTIL_P_OF12_OXM
:
853 return OFPUTIL_P_OF12_OXM
;
855 case OFPUTIL_P_OF13_OXM
:
856 return OFPUTIL_P_OF13_OXM
;
858 case OFPUTIL_P_OF14_OXM
:
859 return OFPUTIL_P_OF14_OXM
;
861 case OFPUTIL_P_OF15_OXM
:
862 return OFPUTIL_P_OF15_OXM
;
869 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
870 * some extension to a standard protocol version, the return value is the
871 * standard version of that protocol without any extension. If 'protocol' is a
872 * standard protocol version, returns 'protocol' unchanged. */
873 enum ofputil_protocol
874 ofputil_protocol_to_base(enum ofputil_protocol protocol
)
876 return ofputil_protocol_set_tid(protocol
, false);
879 /* Returns 'new_base' with any extensions taken from 'cur'. */
880 enum ofputil_protocol
881 ofputil_protocol_set_base(enum ofputil_protocol cur
,
882 enum ofputil_protocol new_base
)
884 bool tid
= (cur
& OFPUTIL_P_TID
) != 0;
887 case OFPUTIL_P_OF10_STD
:
888 case OFPUTIL_P_OF10_STD_TID
:
889 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD
, tid
);
891 case OFPUTIL_P_OF10_NXM
:
892 case OFPUTIL_P_OF10_NXM_TID
:
893 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM
, tid
);
895 case OFPUTIL_P_OF11_STD
:
896 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD
, tid
);
898 case OFPUTIL_P_OF12_OXM
:
899 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM
, tid
);
901 case OFPUTIL_P_OF13_OXM
:
902 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM
, tid
);
904 case OFPUTIL_P_OF14_OXM
:
905 return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM
, tid
);
907 case OFPUTIL_P_OF15_OXM
:
908 return ofputil_protocol_set_tid(OFPUTIL_P_OF15_OXM
, tid
);
915 /* Returns a string form of 'protocol', if a simple form exists (that is, if
916 * 'protocol' is either a single protocol or it is a combination of protocols
917 * that have a single abbreviation). Otherwise, returns NULL. */
919 ofputil_protocol_to_string(enum ofputil_protocol protocol
)
921 const struct proto_abbrev
*p
;
923 /* Use a "switch" statement for single-bit names so that we get a compiler
924 * warning if we forget any. */
926 case OFPUTIL_P_OF10_NXM
:
927 return "NXM-table_id";
929 case OFPUTIL_P_OF10_NXM_TID
:
930 return "NXM+table_id";
932 case OFPUTIL_P_OF10_STD
:
933 return "OpenFlow10-table_id";
935 case OFPUTIL_P_OF10_STD_TID
:
936 return "OpenFlow10+table_id";
938 case OFPUTIL_P_OF11_STD
:
941 case OFPUTIL_P_OF12_OXM
:
942 return "OXM-OpenFlow12";
944 case OFPUTIL_P_OF13_OXM
:
945 return "OXM-OpenFlow13";
947 case OFPUTIL_P_OF14_OXM
:
948 return "OXM-OpenFlow14";
950 case OFPUTIL_P_OF15_OXM
:
951 return "OXM-OpenFlow15";
954 /* Check abbreviations. */
955 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
956 if (protocol
== p
->protocol
) {
964 /* Returns a string that represents 'protocols'. The return value might be a
965 * comma-separated list if 'protocols' doesn't have a simple name. The return
966 * value is "none" if 'protocols' is 0.
968 * The caller must free the returned string (with free()). */
970 ofputil_protocols_to_string(enum ofputil_protocol protocols
)
974 ovs_assert(!(protocols
& ~OFPUTIL_P_ANY
));
975 if (protocols
== 0) {
976 return xstrdup("none");
981 const struct proto_abbrev
*p
;
985 ds_put_char(&s
, ',');
988 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
989 if ((protocols
& p
->protocol
) == p
->protocol
) {
990 ds_put_cstr(&s
, p
->name
);
991 protocols
&= ~p
->protocol
;
996 for (i
= 0; i
< CHAR_BIT
* sizeof(enum ofputil_protocol
); i
++) {
997 enum ofputil_protocol bit
= 1u << i
;
999 if (protocols
& bit
) {
1000 ds_put_cstr(&s
, ofputil_protocol_to_string(bit
));
1009 return ds_steal_cstr(&s
);
1012 static enum ofputil_protocol
1013 ofputil_protocol_from_string__(const char *s
, size_t n
)
1015 const struct proto_abbrev
*p
;
1018 for (i
= 0; i
< CHAR_BIT
* sizeof(enum ofputil_protocol
); i
++) {
1019 enum ofputil_protocol bit
= 1u << i
;
1020 const char *name
= ofputil_protocol_to_string(bit
);
1022 if (name
&& n
== strlen(name
) && !strncasecmp(s
, name
, n
)) {
1027 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
1028 if (n
== strlen(p
->name
) && !strncasecmp(s
, p
->name
, n
)) {
1036 /* Returns the nonempty set of protocols represented by 's', which can be a
1037 * single protocol name or abbreviation or a comma-separated list of them.
1039 * Aborts the program with an error message if 's' is invalid. */
1040 enum ofputil_protocol
1041 ofputil_protocols_from_string(const char *s
)
1043 const char *orig_s
= s
;
1044 enum ofputil_protocol protocols
;
1048 enum ofputil_protocol p
;
1051 n
= strcspn(s
, ",");
1057 p
= ofputil_protocol_from_string__(s
, n
);
1059 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n
, s
);
1067 ovs_fatal(0, "%s: no flow protocol specified", orig_s
);
1073 ofputil_version_from_string(const char *s
)
1075 if (!strcasecmp(s
, "OpenFlow10")) {
1076 return OFP10_VERSION
;
1078 if (!strcasecmp(s
, "OpenFlow11")) {
1079 return OFP11_VERSION
;
1081 if (!strcasecmp(s
, "OpenFlow12")) {
1082 return OFP12_VERSION
;
1084 if (!strcasecmp(s
, "OpenFlow13")) {
1085 return OFP13_VERSION
;
1087 if (!strcasecmp(s
, "OpenFlow14")) {
1088 return OFP14_VERSION
;
1090 if (!strcasecmp(s
, "OpenFlow15")) {
1091 return OFP15_VERSION
;
1097 is_delimiter(unsigned char c
)
1099 return isspace(c
) || c
== ',';
1103 ofputil_versions_from_string(const char *s
)
1106 uint32_t bitmap
= 0;
1113 if (is_delimiter(s
[i
])) {
1118 while (s
[i
+ j
] && !is_delimiter(s
[i
+ j
])) {
1121 key
= xmemdup0(s
+ i
, j
);
1122 version
= ofputil_version_from_string(key
);
1124 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key
);
1127 bitmap
|= 1u << version
;
1135 ofputil_versions_from_strings(char ** const s
, size_t count
)
1137 uint32_t bitmap
= 0;
1140 int version
= ofputil_version_from_string(s
[count
]);
1142 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s
[count
]);
1144 bitmap
|= 1u << version
;
1152 ofputil_version_to_string(enum ofp_version ofp_version
)
1154 switch (ofp_version
) {
1156 return "OpenFlow10";
1158 return "OpenFlow11";
1160 return "OpenFlow12";
1162 return "OpenFlow13";
1164 return "OpenFlow14";
1166 return "OpenFlow15";
1173 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format
)
1175 switch (packet_in_format
) {
1176 case NXPIF_OPENFLOW10
:
1185 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format
)
1187 switch (packet_in_format
) {
1188 case NXPIF_OPENFLOW10
:
1189 return "openflow10";
1198 ofputil_packet_in_format_from_string(const char *s
)
1200 return (!strcmp(s
, "openflow10") ? NXPIF_OPENFLOW10
1201 : !strcmp(s
, "nxm") ? NXPIF_NXM
1206 ofputil_format_version(struct ds
*msg
, enum ofp_version version
)
1208 ds_put_format(msg
, "0x%02x", version
);
1212 ofputil_format_version_name(struct ds
*msg
, enum ofp_version version
)
1214 ds_put_cstr(msg
, ofputil_version_to_string(version
));
1218 ofputil_format_version_bitmap__(struct ds
*msg
, uint32_t bitmap
,
1219 void (*format_version
)(struct ds
*msg
,
1223 format_version(msg
, raw_ctz(bitmap
));
1224 bitmap
= zero_rightmost_1bit(bitmap
);
1226 ds_put_cstr(msg
, ", ");
1232 ofputil_format_version_bitmap(struct ds
*msg
, uint32_t bitmap
)
1234 ofputil_format_version_bitmap__(msg
, bitmap
, ofputil_format_version
);
1238 ofputil_format_version_bitmap_names(struct ds
*msg
, uint32_t bitmap
)
1240 ofputil_format_version_bitmap__(msg
, bitmap
, ofputil_format_version_name
);
1244 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header
*oheh
,
1245 uint32_t *allowed_versionsp
)
1247 uint16_t bitmap_len
= ntohs(oheh
->length
) - sizeof *oheh
;
1248 const ovs_be32
*bitmap
= ALIGNED_CAST(const ovs_be32
*, oheh
+ 1);
1249 uint32_t allowed_versions
;
1251 if (!bitmap_len
|| bitmap_len
% sizeof *bitmap
) {
1255 /* Only use the first 32-bit element of the bitmap as that is all the
1256 * current implementation supports. Subsequent elements are ignored which
1257 * should have no effect on session negotiation until Open vSwtich supports
1258 * wire-protocol versions greater than 31.
1260 allowed_versions
= ntohl(bitmap
[0]);
1262 if (allowed_versions
& 1) {
1263 /* There's no OpenFlow version 0. */
1264 VLOG_WARN_RL(&bad_ofmsg_rl
, "peer claims to support invalid OpenFlow "
1266 allowed_versions
&= ~1u;
1269 if (!allowed_versions
) {
1270 VLOG_WARN_RL(&bad_ofmsg_rl
, "peer does not support any OpenFlow "
1271 "version (between 0x01 and 0x1f)");
1275 *allowed_versionsp
= allowed_versions
;
1280 version_bitmap_from_version(uint8_t ofp_version
)
1282 return ((ofp_version
< 32 ? 1u << ofp_version
: 0) - 1) << 1;
1285 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1286 * the set of OpenFlow versions for which 'oh' announces support.
1288 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1289 * successful, and thus '*allowed_versions' is always initialized. However, it
1290 * returns false if 'oh' contains some data that could not be fully understood,
1291 * true if 'oh' was completely parsed. */
1293 ofputil_decode_hello(const struct ofp_header
*oh
, uint32_t *allowed_versions
)
1298 ofpbuf_use_const(&msg
, oh
, ntohs(oh
->length
));
1299 ofpbuf_pull(&msg
, sizeof *oh
);
1301 *allowed_versions
= version_bitmap_from_version(oh
->version
);
1302 while (ofpbuf_size(&msg
)) {
1303 const struct ofp_hello_elem_header
*oheh
;
1306 if (ofpbuf_size(&msg
) < sizeof *oheh
) {
1310 oheh
= ofpbuf_data(&msg
);
1311 len
= ntohs(oheh
->length
);
1312 if (len
< sizeof *oheh
|| !ofpbuf_try_pull(&msg
, ROUND_UP(len
, 8))) {
1316 if (oheh
->type
!= htons(OFPHET_VERSIONBITMAP
)
1317 || !ofputil_decode_hello_bitmap(oheh
, allowed_versions
)) {
1325 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1326 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1328 should_send_version_bitmap(uint32_t allowed_versions
)
1330 return !is_pow2((allowed_versions
>> 1) + 1);
1333 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1334 * versions in the 'allowed_versions' bitmaps and returns the message. */
1336 ofputil_encode_hello(uint32_t allowed_versions
)
1338 enum ofp_version ofp_version
;
1341 ofp_version
= leftmost_1bit_idx(allowed_versions
);
1342 msg
= ofpraw_alloc(OFPRAW_OFPT_HELLO
, ofp_version
, 0);
1344 if (should_send_version_bitmap(allowed_versions
)) {
1345 struct ofp_hello_elem_header
*oheh
;
1348 map_len
= sizeof allowed_versions
;
1349 oheh
= ofpbuf_put_zeros(msg
, ROUND_UP(map_len
+ sizeof *oheh
, 8));
1350 oheh
->type
= htons(OFPHET_VERSIONBITMAP
);
1351 oheh
->length
= htons(map_len
+ sizeof *oheh
);
1352 *ALIGNED_CAST(ovs_be32
*, oheh
+ 1) = htonl(allowed_versions
);
1354 ofpmsg_update_length(msg
);
1360 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1361 * protocol is 'current', at least partly transitions the protocol to 'want'.
1362 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1363 * connection if the switch processes the returned message correctly. (If
1364 * '*next != want' then the caller will have to iterate.)
1366 * If 'current == want', or if it is not possible to transition from 'current'
1367 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1368 * protocol versions), returns NULL and stores 'current' in '*next'. */
1370 ofputil_encode_set_protocol(enum ofputil_protocol current
,
1371 enum ofputil_protocol want
,
1372 enum ofputil_protocol
*next
)
1374 enum ofp_version cur_version
, want_version
;
1375 enum ofputil_protocol cur_base
, want_base
;
1376 bool cur_tid
, want_tid
;
1378 cur_version
= ofputil_protocol_to_ofp_version(current
);
1379 want_version
= ofputil_protocol_to_ofp_version(want
);
1380 if (cur_version
!= want_version
) {
1385 cur_base
= ofputil_protocol_to_base(current
);
1386 want_base
= ofputil_protocol_to_base(want
);
1387 if (cur_base
!= want_base
) {
1388 *next
= ofputil_protocol_set_base(current
, want_base
);
1390 switch (want_base
) {
1391 case OFPUTIL_P_OF10_NXM
:
1392 return ofputil_encode_nx_set_flow_format(NXFF_NXM
);
1394 case OFPUTIL_P_OF10_STD
:
1395 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10
);
1397 case OFPUTIL_P_OF11_STD
:
1398 case OFPUTIL_P_OF12_OXM
:
1399 case OFPUTIL_P_OF13_OXM
:
1400 case OFPUTIL_P_OF14_OXM
:
1401 case OFPUTIL_P_OF15_OXM
:
1402 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1403 * verified above that we're not trying to change versions. */
1406 case OFPUTIL_P_OF10_STD_TID
:
1407 case OFPUTIL_P_OF10_NXM_TID
:
1412 cur_tid
= (current
& OFPUTIL_P_TID
) != 0;
1413 want_tid
= (want
& OFPUTIL_P_TID
) != 0;
1414 if (cur_tid
!= want_tid
) {
1415 *next
= ofputil_protocol_set_tid(current
, want_tid
);
1416 return ofputil_make_flow_mod_table_id(want_tid
);
1419 ovs_assert(current
== want
);
1425 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1426 * format to 'nxff'. */
1428 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff
)
1430 struct nx_set_flow_format
*sff
;
1433 ovs_assert(ofputil_nx_flow_format_is_valid(nxff
));
1435 msg
= ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT
, OFP10_VERSION
, 0);
1436 sff
= ofpbuf_put_zeros(msg
, sizeof *sff
);
1437 sff
->format
= htonl(nxff
);
1442 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1444 enum ofputil_protocol
1445 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format
)
1447 switch (flow_format
) {
1448 case NXFF_OPENFLOW10
:
1449 return OFPUTIL_P_OF10_STD
;
1452 return OFPUTIL_P_OF10_NXM
;
1459 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1461 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format
)
1463 return ofputil_nx_flow_format_to_protocol(flow_format
) != 0;
1466 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1469 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format
)
1471 switch (flow_format
) {
1472 case NXFF_OPENFLOW10
:
1473 return "openflow10";
1482 ofputil_make_set_packet_in_format(enum ofp_version ofp_version
,
1483 enum nx_packet_in_format packet_in_format
)
1485 struct nx_set_packet_in_format
*spif
;
1488 msg
= ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT
, ofp_version
, 0);
1489 spif
= ofpbuf_put_zeros(msg
, sizeof *spif
);
1490 spif
->format
= htonl(packet_in_format
);
1495 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1496 * extension on or off (according to 'flow_mod_table_id'). */
1498 ofputil_make_flow_mod_table_id(bool flow_mod_table_id
)
1500 struct nx_flow_mod_table_id
*nfmti
;
1503 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID
, OFP10_VERSION
, 0);
1504 nfmti
= ofpbuf_put_zeros(msg
, sizeof *nfmti
);
1505 nfmti
->set
= flow_mod_table_id
;
1509 struct ofputil_flow_mod_flag
{
1511 enum ofp_version min_version
, max_version
;
1512 enum ofputil_flow_mod_flags flag
;
1515 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags
[] = {
1516 { OFPFF_SEND_FLOW_REM
, OFP10_VERSION
, 0, OFPUTIL_FF_SEND_FLOW_REM
},
1517 { OFPFF_CHECK_OVERLAP
, OFP10_VERSION
, 0, OFPUTIL_FF_CHECK_OVERLAP
},
1518 { OFPFF10_EMERG
, OFP10_VERSION
, OFP10_VERSION
,
1520 { OFPFF12_RESET_COUNTS
, OFP12_VERSION
, 0, OFPUTIL_FF_RESET_COUNTS
},
1521 { OFPFF13_NO_PKT_COUNTS
, OFP13_VERSION
, 0, OFPUTIL_FF_NO_PKT_COUNTS
},
1522 { OFPFF13_NO_BYT_COUNTS
, OFP13_VERSION
, 0, OFPUTIL_FF_NO_BYT_COUNTS
},
1527 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_
,
1528 enum ofp_flow_mod_command command
,
1529 enum ofp_version version
,
1530 enum ofputil_flow_mod_flags
*flagsp
)
1532 uint16_t raw_flags
= ntohs(raw_flags_
);
1533 const struct ofputil_flow_mod_flag
*f
;
1536 for (f
= ofputil_flow_mod_flags
; f
->raw_flag
; f
++) {
1537 if (raw_flags
& f
->raw_flag
1538 && version
>= f
->min_version
1539 && (!f
->max_version
|| version
<= f
->max_version
)) {
1540 raw_flags
&= ~f
->raw_flag
;
1545 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1548 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1549 * resets counters. */
1550 if ((version
== OFP10_VERSION
|| version
== OFP11_VERSION
)
1551 && command
== OFPFC_ADD
) {
1552 *flagsp
|= OFPUTIL_FF_RESET_COUNTS
;
1555 return raw_flags
? OFPERR_OFPFMFC_BAD_FLAGS
: 0;
1559 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags
,
1560 enum ofp_version version
)
1562 const struct ofputil_flow_mod_flag
*f
;
1566 for (f
= ofputil_flow_mod_flags
; f
->raw_flag
; f
++) {
1568 && version
>= f
->min_version
1569 && (!f
->max_version
|| version
<= f
->max_version
)) {
1570 raw_flags
|= f
->raw_flag
;
1574 return htons(raw_flags
);
1577 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1578 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1581 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1582 * The caller must initialize 'ofpacts' and retains ownership of it.
1583 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1585 * Does not validate the flow_mod actions. The caller should do that, with
1586 * ofpacts_check(). */
1588 ofputil_decode_flow_mod(struct ofputil_flow_mod
*fm
,
1589 const struct ofp_header
*oh
,
1590 enum ofputil_protocol protocol
,
1591 struct ofpbuf
*ofpacts
,
1592 ofp_port_t max_port
, uint8_t max_table
)
1599 /* Ignored for non-delete actions */
1600 fm
->delete_reason
= OFPRR_DELETE
;
1602 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1603 raw
= ofpraw_pull_assert(&b
);
1604 if (raw
== OFPRAW_OFPT11_FLOW_MOD
) {
1605 /* Standard OpenFlow 1.1+ flow_mod. */
1606 const struct ofp11_flow_mod
*ofm
;
1608 ofm
= ofpbuf_pull(&b
, sizeof *ofm
);
1610 error
= ofputil_pull_ofp11_match(&b
, &fm
->match
, NULL
);
1615 error
= ofpacts_pull_openflow_instructions(&b
, ofpbuf_size(&b
), oh
->version
,
1621 /* Translate the message. */
1622 fm
->priority
= ntohs(ofm
->priority
);
1623 if (ofm
->command
== OFPFC_ADD
1624 || (oh
->version
== OFP11_VERSION
1625 && (ofm
->command
== OFPFC_MODIFY
||
1626 ofm
->command
== OFPFC_MODIFY_STRICT
)
1627 && ofm
->cookie_mask
== htonll(0))) {
1628 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1629 * not match on the cookie is treated as an "add" if there is no
1631 fm
->cookie
= htonll(0);
1632 fm
->cookie_mask
= htonll(0);
1633 fm
->new_cookie
= ofm
->cookie
;
1635 fm
->cookie
= ofm
->cookie
;
1636 fm
->cookie_mask
= ofm
->cookie_mask
;
1637 fm
->new_cookie
= OVS_BE64_MAX
;
1639 fm
->modify_cookie
= false;
1640 fm
->command
= ofm
->command
;
1644 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1645 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1646 fm
->table_id
= ofm
->table_id
;
1647 if (fm
->table_id
== OFPTT_ALL
1648 && (oh
->version
== OFP11_VERSION
1649 || (ofm
->command
!= OFPFC_DELETE
&&
1650 ofm
->command
!= OFPFC_DELETE_STRICT
))) {
1651 return OFPERR_OFPFMFC_BAD_TABLE_ID
;
1654 fm
->idle_timeout
= ntohs(ofm
->idle_timeout
);
1655 fm
->hard_timeout
= ntohs(ofm
->hard_timeout
);
1656 fm
->buffer_id
= ntohl(ofm
->buffer_id
);
1657 error
= ofputil_port_from_ofp11(ofm
->out_port
, &fm
->out_port
);
1662 fm
->out_group
= (ofm
->command
== OFPFC_DELETE
||
1663 ofm
->command
== OFPFC_DELETE_STRICT
1664 ? ntohl(ofm
->out_group
)
1666 raw_flags
= ofm
->flags
;
1670 if (raw
== OFPRAW_OFPT10_FLOW_MOD
) {
1671 /* Standard OpenFlow 1.0 flow_mod. */
1672 const struct ofp10_flow_mod
*ofm
;
1674 /* Get the ofp10_flow_mod. */
1675 ofm
= ofpbuf_pull(&b
, sizeof *ofm
);
1677 /* Translate the rule. */
1678 ofputil_match_from_ofp10_match(&ofm
->match
, &fm
->match
);
1679 ofputil_normalize_match(&fm
->match
);
1681 /* Now get the actions. */
1682 error
= ofpacts_pull_openflow_actions(&b
, ofpbuf_size(&b
), oh
->version
,
1688 /* OpenFlow 1.0 says that exact-match rules have to have the
1689 * highest possible priority. */
1690 fm
->priority
= (ofm
->match
.wildcards
& htonl(OFPFW10_ALL
)
1691 ? ntohs(ofm
->priority
)
1694 /* Translate the message. */
1695 command
= ntohs(ofm
->command
);
1696 fm
->cookie
= htonll(0);
1697 fm
->cookie_mask
= htonll(0);
1698 fm
->new_cookie
= ofm
->cookie
;
1699 fm
->idle_timeout
= ntohs(ofm
->idle_timeout
);
1700 fm
->hard_timeout
= ntohs(ofm
->hard_timeout
);
1701 fm
->buffer_id
= ntohl(ofm
->buffer_id
);
1702 fm
->out_port
= u16_to_ofp(ntohs(ofm
->out_port
));
1703 fm
->out_group
= OFPG11_ANY
;
1704 raw_flags
= ofm
->flags
;
1705 } else if (raw
== OFPRAW_NXT_FLOW_MOD
) {
1706 /* Nicira extended flow_mod. */
1707 const struct nx_flow_mod
*nfm
;
1709 /* Dissect the message. */
1710 nfm
= ofpbuf_pull(&b
, sizeof *nfm
);
1711 error
= nx_pull_match(&b
, ntohs(nfm
->match_len
),
1712 &fm
->match
, &fm
->cookie
, &fm
->cookie_mask
);
1716 error
= ofpacts_pull_openflow_actions(&b
, ofpbuf_size(&b
), oh
->version
,
1722 /* Translate the message. */
1723 command
= ntohs(nfm
->command
);
1724 if ((command
& 0xff) == OFPFC_ADD
&& fm
->cookie_mask
) {
1725 /* Flow additions may only set a new cookie, not match an
1726 * existing cookie. */
1727 return OFPERR_NXBRC_NXM_INVALID
;
1729 fm
->priority
= ntohs(nfm
->priority
);
1730 fm
->new_cookie
= nfm
->cookie
;
1731 fm
->idle_timeout
= ntohs(nfm
->idle_timeout
);
1732 fm
->hard_timeout
= ntohs(nfm
->hard_timeout
);
1733 fm
->buffer_id
= ntohl(nfm
->buffer_id
);
1734 fm
->out_port
= u16_to_ofp(ntohs(nfm
->out_port
));
1735 fm
->out_group
= OFPG11_ANY
;
1736 raw_flags
= nfm
->flags
;
1741 fm
->modify_cookie
= fm
->new_cookie
!= OVS_BE64_MAX
;
1742 if (protocol
& OFPUTIL_P_TID
) {
1743 fm
->command
= command
& 0xff;
1744 fm
->table_id
= command
>> 8;
1746 fm
->command
= command
;
1747 fm
->table_id
= 0xff;
1751 fm
->ofpacts
= ofpbuf_data(ofpacts
);
1752 fm
->ofpacts_len
= ofpbuf_size(ofpacts
);
1754 error
= ofputil_decode_flow_mod_flags(raw_flags
, fm
->command
,
1755 oh
->version
, &fm
->flags
);
1760 if (fm
->flags
& OFPUTIL_FF_EMERG
) {
1761 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1762 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1764 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1765 * or hard_timeout is nonzero. Otherwise, there is no good error
1766 * code, so just state that the flow table is full. */
1767 return (fm
->hard_timeout
|| fm
->idle_timeout
1768 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1769 : OFPERR_OFPFMFC_TABLE_FULL
);
1772 return ofpacts_check_consistency(fm
->ofpacts
, fm
->ofpacts_len
,
1773 &fm
->match
.flow
, max_port
,
1774 fm
->table_id
, max_table
, protocol
);
1778 ofputil_pull_bands(struct ofpbuf
*msg
, size_t len
, uint16_t *n_bands
,
1779 struct ofpbuf
*bands
)
1781 const struct ofp13_meter_band_header
*ombh
;
1782 struct ofputil_meter_band
*mb
;
1785 ombh
= ofpbuf_try_pull(msg
, len
);
1787 return OFPERR_OFPBRC_BAD_LEN
;
1790 while (len
>= sizeof (struct ofp13_meter_band_drop
)) {
1791 size_t ombh_len
= ntohs(ombh
->len
);
1792 /* All supported band types have the same length. */
1793 if (ombh_len
!= sizeof (struct ofp13_meter_band_drop
)) {
1794 return OFPERR_OFPBRC_BAD_LEN
;
1796 mb
= ofpbuf_put_uninit(bands
, sizeof *mb
);
1797 mb
->type
= ntohs(ombh
->type
);
1798 if (mb
->type
!= OFPMBT13_DROP
&& mb
->type
!= OFPMBT13_DSCP_REMARK
) {
1799 return OFPERR_OFPMMFC_BAD_BAND
;
1801 mb
->rate
= ntohl(ombh
->rate
);
1802 mb
->burst_size
= ntohl(ombh
->burst_size
);
1803 mb
->prec_level
= (mb
->type
== OFPMBT13_DSCP_REMARK
) ?
1804 ((struct ofp13_meter_band_dscp_remark
*)ombh
)->prec_level
: 0;
1807 ombh
= ALIGNED_CAST(struct ofp13_meter_band_header
*,
1808 (char *) ombh
+ ombh_len
);
1811 return OFPERR_OFPBRC_BAD_LEN
;
1818 ofputil_decode_meter_mod(const struct ofp_header
*oh
,
1819 struct ofputil_meter_mod
*mm
,
1820 struct ofpbuf
*bands
)
1822 const struct ofp13_meter_mod
*omm
;
1825 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1826 ofpraw_pull_assert(&b
);
1827 omm
= ofpbuf_pull(&b
, sizeof *omm
);
1829 /* Translate the message. */
1830 mm
->command
= ntohs(omm
->command
);
1831 if (mm
->command
!= OFPMC13_ADD
&&
1832 mm
->command
!= OFPMC13_MODIFY
&&
1833 mm
->command
!= OFPMC13_DELETE
) {
1834 return OFPERR_OFPMMFC_BAD_COMMAND
;
1836 mm
->meter
.meter_id
= ntohl(omm
->meter_id
);
1838 if (mm
->command
== OFPMC13_DELETE
) {
1839 mm
->meter
.flags
= 0;
1840 mm
->meter
.n_bands
= 0;
1841 mm
->meter
.bands
= NULL
;
1845 mm
->meter
.flags
= ntohs(omm
->flags
);
1846 if (mm
->meter
.flags
& OFPMF13_KBPS
&&
1847 mm
->meter
.flags
& OFPMF13_PKTPS
) {
1848 return OFPERR_OFPMMFC_BAD_FLAGS
;
1850 mm
->meter
.bands
= ofpbuf_data(bands
);
1852 error
= ofputil_pull_bands(&b
, ofpbuf_size(&b
), &mm
->meter
.n_bands
, bands
);
1861 ofputil_decode_meter_request(const struct ofp_header
*oh
, uint32_t *meter_id
)
1863 const struct ofp13_meter_multipart_request
*omr
= ofpmsg_body(oh
);
1864 *meter_id
= ntohl(omr
->meter_id
);
1868 ofputil_encode_meter_request(enum ofp_version ofp_version
,
1869 enum ofputil_meter_request_type type
,
1877 case OFPUTIL_METER_CONFIG
:
1878 raw
= OFPRAW_OFPST13_METER_CONFIG_REQUEST
;
1880 case OFPUTIL_METER_STATS
:
1881 raw
= OFPRAW_OFPST13_METER_REQUEST
;
1884 case OFPUTIL_METER_FEATURES
:
1885 raw
= OFPRAW_OFPST13_METER_FEATURES_REQUEST
;
1889 msg
= ofpraw_alloc(raw
, ofp_version
, 0);
1891 if (type
!= OFPUTIL_METER_FEATURES
) {
1892 struct ofp13_meter_multipart_request
*omr
;
1893 omr
= ofpbuf_put_zeros(msg
, sizeof *omr
);
1894 omr
->meter_id
= htonl(meter_id
);
1900 ofputil_put_bands(uint16_t n_bands
, const struct ofputil_meter_band
*mb
,
1905 for (n
= 0; n
< n_bands
; ++n
) {
1906 /* Currently all band types have same size. */
1907 struct ofp13_meter_band_dscp_remark
*ombh
;
1908 size_t ombh_len
= sizeof *ombh
;
1910 ombh
= ofpbuf_put_zeros(msg
, ombh_len
);
1912 ombh
->type
= htons(mb
->type
);
1913 ombh
->len
= htons(ombh_len
);
1914 ombh
->rate
= htonl(mb
->rate
);
1915 ombh
->burst_size
= htonl(mb
->burst_size
);
1916 ombh
->prec_level
= mb
->prec_level
;
1922 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1924 ofputil_append_meter_config(struct list
*replies
,
1925 const struct ofputil_meter_config
*mc
)
1927 struct ofpbuf
*msg
= ofpbuf_from_list(list_back(replies
));
1928 size_t start_ofs
= ofpbuf_size(msg
);
1929 struct ofp13_meter_config
*reply
= ofpbuf_put_uninit(msg
, sizeof *reply
);
1930 reply
->flags
= htons(mc
->flags
);
1931 reply
->meter_id
= htonl(mc
->meter_id
);
1933 ofputil_put_bands(mc
->n_bands
, mc
->bands
, msg
);
1935 reply
->length
= htons(ofpbuf_size(msg
) - start_ofs
);
1937 ofpmp_postappend(replies
, start_ofs
);
1940 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1942 ofputil_append_meter_stats(struct list
*replies
,
1943 const struct ofputil_meter_stats
*ms
)
1945 struct ofp13_meter_stats
*reply
;
1949 len
= sizeof *reply
+ ms
->n_bands
* sizeof(struct ofp13_meter_band_stats
);
1950 reply
= ofpmp_append(replies
, len
);
1952 reply
->meter_id
= htonl(ms
->meter_id
);
1953 reply
->len
= htons(len
);
1954 memset(reply
->pad
, 0, sizeof reply
->pad
);
1955 reply
->flow_count
= htonl(ms
->flow_count
);
1956 reply
->packet_in_count
= htonll(ms
->packet_in_count
);
1957 reply
->byte_in_count
= htonll(ms
->byte_in_count
);
1958 reply
->duration_sec
= htonl(ms
->duration_sec
);
1959 reply
->duration_nsec
= htonl(ms
->duration_nsec
);
1961 for (n
= 0; n
< ms
->n_bands
; ++n
) {
1962 const struct ofputil_meter_band_stats
*src
= &ms
->bands
[n
];
1963 struct ofp13_meter_band_stats
*dst
= &reply
->band_stats
[n
];
1965 dst
->packet_band_count
= htonll(src
->packet_count
);
1966 dst
->byte_band_count
= htonll(src
->byte_count
);
1970 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1971 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1972 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1973 * it across the call.
1975 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1976 * message. Calling this function multiple times for a single 'msg' iterates
1977 * through the replies. 'bands' is cleared for each reply.
1979 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1980 * otherwise a positive errno value. */
1982 ofputil_decode_meter_config(struct ofpbuf
*msg
,
1983 struct ofputil_meter_config
*mc
,
1984 struct ofpbuf
*bands
)
1986 const struct ofp13_meter_config
*omc
;
1989 /* Pull OpenFlow headers for the first call. */
1991 ofpraw_pull_assert(msg
);
1994 if (!ofpbuf_size(msg
)) {
1998 omc
= ofpbuf_try_pull(msg
, sizeof *omc
);
2000 VLOG_WARN_RL(&bad_ofmsg_rl
,
2001 "OFPMP_METER_CONFIG reply has %"PRIu32
" leftover bytes at end",
2003 return OFPERR_OFPBRC_BAD_LEN
;
2006 ofpbuf_clear(bands
);
2007 err
= ofputil_pull_bands(msg
, ntohs(omc
->length
) - sizeof *omc
,
2008 &mc
->n_bands
, bands
);
2012 mc
->meter_id
= ntohl(omc
->meter_id
);
2013 mc
->flags
= ntohs(omc
->flags
);
2014 mc
->bands
= ofpbuf_data(bands
);
2020 ofputil_pull_band_stats(struct ofpbuf
*msg
, size_t len
, uint16_t *n_bands
,
2021 struct ofpbuf
*bands
)
2023 const struct ofp13_meter_band_stats
*ombs
;
2024 struct ofputil_meter_band_stats
*mbs
;
2027 ombs
= ofpbuf_try_pull(msg
, len
);
2029 return OFPERR_OFPBRC_BAD_LEN
;
2032 n
= len
/ sizeof *ombs
;
2033 if (len
!= n
* sizeof *ombs
) {
2034 return OFPERR_OFPBRC_BAD_LEN
;
2037 mbs
= ofpbuf_put_uninit(bands
, len
);
2039 for (i
= 0; i
< n
; ++i
) {
2040 mbs
[i
].packet_count
= ntohll(ombs
[i
].packet_band_count
);
2041 mbs
[i
].byte_count
= ntohll(ombs
[i
].byte_band_count
);
2047 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2048 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2049 * decoded into 'bands'.
2051 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2052 * message. Calling this function multiple times for a single 'msg' iterates
2053 * through the replies. 'bands' is cleared for each reply.
2055 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2056 * otherwise a positive errno value. */
2058 ofputil_decode_meter_stats(struct ofpbuf
*msg
,
2059 struct ofputil_meter_stats
*ms
,
2060 struct ofpbuf
*bands
)
2062 const struct ofp13_meter_stats
*oms
;
2065 /* Pull OpenFlow headers for the first call. */
2067 ofpraw_pull_assert(msg
);
2070 if (!ofpbuf_size(msg
)) {
2074 oms
= ofpbuf_try_pull(msg
, sizeof *oms
);
2076 VLOG_WARN_RL(&bad_ofmsg_rl
,
2077 "OFPMP_METER reply has %"PRIu32
" leftover bytes at end",
2079 return OFPERR_OFPBRC_BAD_LEN
;
2082 ofpbuf_clear(bands
);
2083 err
= ofputil_pull_band_stats(msg
, ntohs(oms
->len
) - sizeof *oms
,
2084 &ms
->n_bands
, bands
);
2088 ms
->meter_id
= ntohl(oms
->meter_id
);
2089 ms
->flow_count
= ntohl(oms
->flow_count
);
2090 ms
->packet_in_count
= ntohll(oms
->packet_in_count
);
2091 ms
->byte_in_count
= ntohll(oms
->byte_in_count
);
2092 ms
->duration_sec
= ntohl(oms
->duration_sec
);
2093 ms
->duration_nsec
= ntohl(oms
->duration_nsec
);
2094 ms
->bands
= ofpbuf_data(bands
);
2100 ofputil_decode_meter_features(const struct ofp_header
*oh
,
2101 struct ofputil_meter_features
*mf
)
2103 const struct ofp13_meter_features
*omf
= ofpmsg_body(oh
);
2105 mf
->max_meters
= ntohl(omf
->max_meter
);
2106 mf
->band_types
= ntohl(omf
->band_types
);
2107 mf
->capabilities
= ntohl(omf
->capabilities
);
2108 mf
->max_bands
= omf
->max_bands
;
2109 mf
->max_color
= omf
->max_color
;
2113 ofputil_encode_meter_features_reply(const struct ofputil_meter_features
*mf
,
2114 const struct ofp_header
*request
)
2116 struct ofpbuf
*reply
;
2117 struct ofp13_meter_features
*omf
;
2119 reply
= ofpraw_alloc_stats_reply(request
, 0);
2120 omf
= ofpbuf_put_zeros(reply
, sizeof *omf
);
2122 omf
->max_meter
= htonl(mf
->max_meters
);
2123 omf
->band_types
= htonl(mf
->band_types
);
2124 omf
->capabilities
= htonl(mf
->capabilities
);
2125 omf
->max_bands
= mf
->max_bands
;
2126 omf
->max_color
= mf
->max_color
;
2132 ofputil_encode_meter_mod(enum ofp_version ofp_version
,
2133 const struct ofputil_meter_mod
*mm
)
2137 struct ofp13_meter_mod
*omm
;
2139 msg
= ofpraw_alloc(OFPRAW_OFPT13_METER_MOD
, ofp_version
,
2140 NXM_TYPICAL_LEN
+ mm
->meter
.n_bands
* 16);
2141 omm
= ofpbuf_put_zeros(msg
, sizeof *omm
);
2142 omm
->command
= htons(mm
->command
);
2143 if (mm
->command
!= OFPMC13_DELETE
) {
2144 omm
->flags
= htons(mm
->meter
.flags
);
2146 omm
->meter_id
= htonl(mm
->meter
.meter_id
);
2148 ofputil_put_bands(mm
->meter
.n_bands
, mm
->meter
.bands
, msg
);
2150 ofpmsg_update_length(msg
);
2155 ofputil_tid_command(const struct ofputil_flow_mod
*fm
,
2156 enum ofputil_protocol protocol
)
2158 return htons(protocol
& OFPUTIL_P_TID
2159 ? (fm
->command
& 0xff) | (fm
->table_id
<< 8)
2163 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2164 * 'protocol' and returns the message. */
2166 ofputil_encode_flow_mod(const struct ofputil_flow_mod
*fm
,
2167 enum ofputil_protocol protocol
)
2169 enum ofp_version version
= ofputil_protocol_to_ofp_version(protocol
);
2170 ovs_be16 raw_flags
= ofputil_encode_flow_mod_flags(fm
->flags
, version
);
2174 case OFPUTIL_P_OF11_STD
:
2175 case OFPUTIL_P_OF12_OXM
:
2176 case OFPUTIL_P_OF13_OXM
:
2177 case OFPUTIL_P_OF14_OXM
:
2178 case OFPUTIL_P_OF15_OXM
: {
2179 struct ofp11_flow_mod
*ofm
;
2182 tailroom
= ofputil_match_typical_len(protocol
) + fm
->ofpacts_len
;
2183 msg
= ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD
, version
, tailroom
);
2184 ofm
= ofpbuf_put_zeros(msg
, sizeof *ofm
);
2185 if ((protocol
== OFPUTIL_P_OF11_STD
2186 && (fm
->command
== OFPFC_MODIFY
||
2187 fm
->command
== OFPFC_MODIFY_STRICT
)
2188 && fm
->cookie_mask
== htonll(0))
2189 || fm
->command
== OFPFC_ADD
) {
2190 ofm
->cookie
= fm
->new_cookie
;
2192 ofm
->cookie
= fm
->cookie
;
2194 ofm
->cookie_mask
= fm
->cookie_mask
;
2195 if (fm
->table_id
!= OFPTT_ALL
2196 || (protocol
!= OFPUTIL_P_OF11_STD
2197 && (fm
->command
== OFPFC_DELETE
||
2198 fm
->command
== OFPFC_DELETE_STRICT
))) {
2199 ofm
->table_id
= fm
->table_id
;
2203 ofm
->command
= fm
->command
;
2204 ofm
->idle_timeout
= htons(fm
->idle_timeout
);
2205 ofm
->hard_timeout
= htons(fm
->hard_timeout
);
2206 ofm
->priority
= htons(fm
->priority
);
2207 ofm
->buffer_id
= htonl(fm
->buffer_id
);
2208 ofm
->out_port
= ofputil_port_to_ofp11(fm
->out_port
);
2209 ofm
->out_group
= htonl(fm
->out_group
);
2210 ofm
->flags
= raw_flags
;
2211 ofputil_put_ofp11_match(msg
, &fm
->match
, protocol
);
2212 ofpacts_put_openflow_instructions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2217 case OFPUTIL_P_OF10_STD
:
2218 case OFPUTIL_P_OF10_STD_TID
: {
2219 struct ofp10_flow_mod
*ofm
;
2221 msg
= ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD
, OFP10_VERSION
,
2223 ofm
= ofpbuf_put_zeros(msg
, sizeof *ofm
);
2224 ofputil_match_to_ofp10_match(&fm
->match
, &ofm
->match
);
2225 ofm
->cookie
= fm
->new_cookie
;
2226 ofm
->command
= ofputil_tid_command(fm
, protocol
);
2227 ofm
->idle_timeout
= htons(fm
->idle_timeout
);
2228 ofm
->hard_timeout
= htons(fm
->hard_timeout
);
2229 ofm
->priority
= htons(fm
->priority
);
2230 ofm
->buffer_id
= htonl(fm
->buffer_id
);
2231 ofm
->out_port
= htons(ofp_to_u16(fm
->out_port
));
2232 ofm
->flags
= raw_flags
;
2233 ofpacts_put_openflow_actions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2238 case OFPUTIL_P_OF10_NXM
:
2239 case OFPUTIL_P_OF10_NXM_TID
: {
2240 struct nx_flow_mod
*nfm
;
2243 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MOD
, OFP10_VERSION
,
2244 NXM_TYPICAL_LEN
+ fm
->ofpacts_len
);
2245 nfm
= ofpbuf_put_zeros(msg
, sizeof *nfm
);
2246 nfm
->command
= ofputil_tid_command(fm
, protocol
);
2247 nfm
->cookie
= fm
->new_cookie
;
2248 match_len
= nx_put_match(msg
, &fm
->match
, fm
->cookie
, fm
->cookie_mask
);
2249 nfm
= ofpbuf_l3(msg
);
2250 nfm
->idle_timeout
= htons(fm
->idle_timeout
);
2251 nfm
->hard_timeout
= htons(fm
->hard_timeout
);
2252 nfm
->priority
= htons(fm
->priority
);
2253 nfm
->buffer_id
= htonl(fm
->buffer_id
);
2254 nfm
->out_port
= htons(ofp_to_u16(fm
->out_port
));
2255 nfm
->flags
= raw_flags
;
2256 nfm
->match_len
= htons(match_len
);
2257 ofpacts_put_openflow_actions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2266 ofpmsg_update_length(msg
);
2271 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request
*fsr
,
2272 const struct ofp10_flow_stats_request
*ofsr
,
2275 fsr
->aggregate
= aggregate
;
2276 ofputil_match_from_ofp10_match(&ofsr
->match
, &fsr
->match
);
2277 fsr
->out_port
= u16_to_ofp(ntohs(ofsr
->out_port
));
2278 fsr
->out_group
= OFPG11_ANY
;
2279 fsr
->table_id
= ofsr
->table_id
;
2280 fsr
->cookie
= fsr
->cookie_mask
= htonll(0);
2286 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request
*fsr
,
2287 struct ofpbuf
*b
, bool aggregate
)
2289 const struct ofp11_flow_stats_request
*ofsr
;
2292 ofsr
= ofpbuf_pull(b
, sizeof *ofsr
);
2293 fsr
->aggregate
= aggregate
;
2294 fsr
->table_id
= ofsr
->table_id
;
2295 error
= ofputil_port_from_ofp11(ofsr
->out_port
, &fsr
->out_port
);
2299 fsr
->out_group
= ntohl(ofsr
->out_group
);
2300 fsr
->cookie
= ofsr
->cookie
;
2301 fsr
->cookie_mask
= ofsr
->cookie_mask
;
2302 error
= ofputil_pull_ofp11_match(b
, &fsr
->match
, NULL
);
2311 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request
*fsr
,
2312 struct ofpbuf
*b
, bool aggregate
)
2314 const struct nx_flow_stats_request
*nfsr
;
2317 nfsr
= ofpbuf_pull(b
, sizeof *nfsr
);
2318 error
= nx_pull_match(b
, ntohs(nfsr
->match_len
), &fsr
->match
,
2319 &fsr
->cookie
, &fsr
->cookie_mask
);
2323 if (ofpbuf_size(b
)) {
2324 return OFPERR_OFPBRC_BAD_LEN
;
2327 fsr
->aggregate
= aggregate
;
2328 fsr
->out_port
= u16_to_ofp(ntohs(nfsr
->out_port
));
2329 fsr
->out_group
= OFPG11_ANY
;
2330 fsr
->table_id
= nfsr
->table_id
;
2335 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2336 * 'port', suitable for OpenFlow version 'version'. */
2338 ofputil_encode_queue_get_config_request(enum ofp_version version
,
2341 struct ofpbuf
*request
;
2343 if (version
== OFP10_VERSION
) {
2344 struct ofp10_queue_get_config_request
*qgcr10
;
2346 request
= ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
,
2348 qgcr10
= ofpbuf_put_zeros(request
, sizeof *qgcr10
);
2349 qgcr10
->port
= htons(ofp_to_u16(port
));
2351 struct ofp11_queue_get_config_request
*qgcr11
;
2353 request
= ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
,
2355 qgcr11
= ofpbuf_put_zeros(request
, sizeof *qgcr11
);
2356 qgcr11
->port
= ofputil_port_to_ofp11(port
);
2362 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2363 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2366 ofputil_decode_queue_get_config_request(const struct ofp_header
*oh
,
2369 const struct ofp10_queue_get_config_request
*qgcr10
;
2370 const struct ofp11_queue_get_config_request
*qgcr11
;
2374 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2375 raw
= ofpraw_pull_assert(&b
);
2377 switch ((int) raw
) {
2378 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
:
2379 qgcr10
= ofpbuf_data(&b
);
2380 *port
= u16_to_ofp(ntohs(qgcr10
->port
));
2383 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
:
2384 qgcr11
= ofpbuf_data(&b
);
2385 return ofputil_port_from_ofp11(qgcr11
->port
, port
);
2391 /* Constructs and returns the beginning of a reply to
2392 * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'. The caller may append information about
2393 * individual queues with ofputil_append_queue_get_config_reply(). */
2395 ofputil_encode_queue_get_config_reply(const struct ofp_header
*oh
)
2397 struct ofp10_queue_get_config_reply
*qgcr10
;
2398 struct ofp11_queue_get_config_reply
*qgcr11
;
2399 struct ofpbuf
*reply
;
2405 error
= ofputil_decode_queue_get_config_request(oh
, &port
);
2408 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2409 raw
= ofpraw_pull_assert(&b
);
2411 switch ((int) raw
) {
2412 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
:
2413 reply
= ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY
,
2415 qgcr10
= ofpbuf_put_zeros(reply
, sizeof *qgcr10
);
2416 qgcr10
->port
= htons(ofp_to_u16(port
));
2419 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
:
2420 reply
= ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY
,
2422 qgcr11
= ofpbuf_put_zeros(reply
, sizeof *qgcr11
);
2423 qgcr11
->port
= ofputil_port_to_ofp11(port
);
2434 put_queue_rate(struct ofpbuf
*reply
, enum ofp_queue_properties property
,
2437 if (rate
!= UINT16_MAX
) {
2438 struct ofp_queue_prop_rate
*oqpr
;
2440 oqpr
= ofpbuf_put_zeros(reply
, sizeof *oqpr
);
2441 oqpr
->prop_header
.property
= htons(property
);
2442 oqpr
->prop_header
.len
= htons(sizeof *oqpr
);
2443 oqpr
->rate
= htons(rate
);
2447 /* Appends a queue description for 'queue_id' to the
2448 * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2450 ofputil_append_queue_get_config_reply(struct ofpbuf
*reply
,
2451 const struct ofputil_queue_config
*oqc
)
2453 const struct ofp_header
*oh
= ofpbuf_data(reply
);
2454 size_t start_ofs
, len_ofs
;
2457 start_ofs
= ofpbuf_size(reply
);
2458 if (oh
->version
< OFP12_VERSION
) {
2459 struct ofp10_packet_queue
*opq10
;
2461 opq10
= ofpbuf_put_zeros(reply
, sizeof *opq10
);
2462 opq10
->queue_id
= htonl(oqc
->queue_id
);
2463 len_ofs
= (char *) &opq10
->len
- (char *) ofpbuf_data(reply
);
2465 struct ofp11_queue_get_config_reply
*qgcr11
;
2466 struct ofp12_packet_queue
*opq12
;
2469 qgcr11
= ofpbuf_l3(reply
);
2470 port
= qgcr11
->port
;
2472 opq12
= ofpbuf_put_zeros(reply
, sizeof *opq12
);
2474 opq12
->queue_id
= htonl(oqc
->queue_id
);
2475 len_ofs
= (char *) &opq12
->len
- (char *) ofpbuf_data(reply
);
2478 put_queue_rate(reply
, OFPQT_MIN_RATE
, oqc
->min_rate
);
2479 put_queue_rate(reply
, OFPQT_MAX_RATE
, oqc
->max_rate
);
2481 len
= ofpbuf_at(reply
, len_ofs
, sizeof *len
);
2482 *len
= htons(ofpbuf_size(reply
) - start_ofs
);
2485 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2486 * stores in '*port' the port that the reply is about. The caller may call
2487 * ofputil_pull_queue_get_config_reply() to obtain information about individual
2488 * queues included in the reply. Returns 0 if successful, otherwise an
2491 ofputil_decode_queue_get_config_reply(struct ofpbuf
*reply
, ofp_port_t
*port
)
2493 const struct ofp10_queue_get_config_reply
*qgcr10
;
2494 const struct ofp11_queue_get_config_reply
*qgcr11
;
2497 raw
= ofpraw_pull_assert(reply
);
2498 switch ((int) raw
) {
2499 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY
:
2500 qgcr10
= ofpbuf_pull(reply
, sizeof *qgcr10
);
2501 *port
= u16_to_ofp(ntohs(qgcr10
->port
));
2504 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY
:
2505 qgcr11
= ofpbuf_pull(reply
, sizeof *qgcr11
);
2506 return ofputil_port_from_ofp11(qgcr11
->port
, port
);
2513 parse_queue_rate(const struct ofp_queue_prop_header
*hdr
, uint16_t *rate
)
2515 const struct ofp_queue_prop_rate
*oqpr
;
2517 if (hdr
->len
== htons(sizeof *oqpr
)) {
2518 oqpr
= (const struct ofp_queue_prop_rate
*) hdr
;
2519 *rate
= ntohs(oqpr
->rate
);
2522 return OFPERR_OFPBRC_BAD_LEN
;
2526 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2527 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2528 * must already have pulled off the main header.
2530 * This function returns EOF if the last queue has already been decoded, 0 if a
2531 * queue was successfully decoded into '*queue', or an ofperr if there was a
2532 * problem decoding 'reply'. */
2534 ofputil_pull_queue_get_config_reply(struct ofpbuf
*reply
,
2535 struct ofputil_queue_config
*queue
)
2537 const struct ofp_header
*oh
;
2538 unsigned int opq_len
;
2541 if (!ofpbuf_size(reply
)) {
2545 queue
->min_rate
= UINT16_MAX
;
2546 queue
->max_rate
= UINT16_MAX
;
2549 if (oh
->version
< OFP12_VERSION
) {
2550 const struct ofp10_packet_queue
*opq10
;
2552 opq10
= ofpbuf_try_pull(reply
, sizeof *opq10
);
2554 return OFPERR_OFPBRC_BAD_LEN
;
2556 queue
->queue_id
= ntohl(opq10
->queue_id
);
2557 len
= ntohs(opq10
->len
);
2558 opq_len
= sizeof *opq10
;
2560 const struct ofp12_packet_queue
*opq12
;
2562 opq12
= ofpbuf_try_pull(reply
, sizeof *opq12
);
2564 return OFPERR_OFPBRC_BAD_LEN
;
2566 queue
->queue_id
= ntohl(opq12
->queue_id
);
2567 len
= ntohs(opq12
->len
);
2568 opq_len
= sizeof *opq12
;
2571 if (len
< opq_len
|| len
> ofpbuf_size(reply
) + opq_len
|| len
% 8) {
2572 return OFPERR_OFPBRC_BAD_LEN
;
2577 const struct ofp_queue_prop_header
*hdr
;
2578 unsigned int property
;
2579 unsigned int prop_len
;
2580 enum ofperr error
= 0;
2582 hdr
= ofpbuf_at_assert(reply
, 0, sizeof *hdr
);
2583 prop_len
= ntohs(hdr
->len
);
2584 if (prop_len
< sizeof *hdr
|| prop_len
> ofpbuf_size(reply
) || prop_len
% 8) {
2585 return OFPERR_OFPBRC_BAD_LEN
;
2588 property
= ntohs(hdr
->property
);
2590 case OFPQT_MIN_RATE
:
2591 error
= parse_queue_rate(hdr
, &queue
->min_rate
);
2594 case OFPQT_MAX_RATE
:
2595 error
= parse_queue_rate(hdr
, &queue
->max_rate
);
2599 VLOG_INFO_RL(&bad_ofmsg_rl
, "unknown queue property %u", property
);
2606 ofpbuf_pull(reply
, prop_len
);
2612 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2613 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2614 * successful, otherwise an OpenFlow error code. */
2616 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request
*fsr
,
2617 const struct ofp_header
*oh
)
2622 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2623 raw
= ofpraw_pull_assert(&b
);
2624 switch ((int) raw
) {
2625 case OFPRAW_OFPST10_FLOW_REQUEST
:
2626 return ofputil_decode_ofpst10_flow_request(fsr
, ofpbuf_data(&b
), false);
2628 case OFPRAW_OFPST10_AGGREGATE_REQUEST
:
2629 return ofputil_decode_ofpst10_flow_request(fsr
, ofpbuf_data(&b
), true);
2631 case OFPRAW_OFPST11_FLOW_REQUEST
:
2632 return ofputil_decode_ofpst11_flow_request(fsr
, &b
, false);
2634 case OFPRAW_OFPST11_AGGREGATE_REQUEST
:
2635 return ofputil_decode_ofpst11_flow_request(fsr
, &b
, true);
2637 case OFPRAW_NXST_FLOW_REQUEST
:
2638 return ofputil_decode_nxst_flow_request(fsr
, &b
, false);
2640 case OFPRAW_NXST_AGGREGATE_REQUEST
:
2641 return ofputil_decode_nxst_flow_request(fsr
, &b
, true);
2644 /* Hey, the caller lied. */
2649 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2650 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2651 * 'protocol', and returns the message. */
2653 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request
*fsr
,
2654 enum ofputil_protocol protocol
)
2660 case OFPUTIL_P_OF11_STD
:
2661 case OFPUTIL_P_OF12_OXM
:
2662 case OFPUTIL_P_OF13_OXM
:
2663 case OFPUTIL_P_OF14_OXM
:
2664 case OFPUTIL_P_OF15_OXM
: {
2665 struct ofp11_flow_stats_request
*ofsr
;
2667 raw
= (fsr
->aggregate
2668 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2669 : OFPRAW_OFPST11_FLOW_REQUEST
);
2670 msg
= ofpraw_alloc(raw
, ofputil_protocol_to_ofp_version(protocol
),
2671 ofputil_match_typical_len(protocol
));
2672 ofsr
= ofpbuf_put_zeros(msg
, sizeof *ofsr
);
2673 ofsr
->table_id
= fsr
->table_id
;
2674 ofsr
->out_port
= ofputil_port_to_ofp11(fsr
->out_port
);
2675 ofsr
->out_group
= htonl(fsr
->out_group
);
2676 ofsr
->cookie
= fsr
->cookie
;
2677 ofsr
->cookie_mask
= fsr
->cookie_mask
;
2678 ofputil_put_ofp11_match(msg
, &fsr
->match
, protocol
);
2682 case OFPUTIL_P_OF10_STD
:
2683 case OFPUTIL_P_OF10_STD_TID
: {
2684 struct ofp10_flow_stats_request
*ofsr
;
2686 raw
= (fsr
->aggregate
2687 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2688 : OFPRAW_OFPST10_FLOW_REQUEST
);
2689 msg
= ofpraw_alloc(raw
, OFP10_VERSION
, 0);
2690 ofsr
= ofpbuf_put_zeros(msg
, sizeof *ofsr
);
2691 ofputil_match_to_ofp10_match(&fsr
->match
, &ofsr
->match
);
2692 ofsr
->table_id
= fsr
->table_id
;
2693 ofsr
->out_port
= htons(ofp_to_u16(fsr
->out_port
));
2697 case OFPUTIL_P_OF10_NXM
:
2698 case OFPUTIL_P_OF10_NXM_TID
: {
2699 struct nx_flow_stats_request
*nfsr
;
2702 raw
= (fsr
->aggregate
2703 ? OFPRAW_NXST_AGGREGATE_REQUEST
2704 : OFPRAW_NXST_FLOW_REQUEST
);
2705 msg
= ofpraw_alloc(raw
, OFP10_VERSION
, NXM_TYPICAL_LEN
);
2706 ofpbuf_put_zeros(msg
, sizeof *nfsr
);
2707 match_len
= nx_put_match(msg
, &fsr
->match
,
2708 fsr
->cookie
, fsr
->cookie_mask
);
2710 nfsr
= ofpbuf_l3(msg
);
2711 nfsr
->out_port
= htons(ofp_to_u16(fsr
->out_port
));
2712 nfsr
->match_len
= htons(match_len
);
2713 nfsr
->table_id
= fsr
->table_id
;
2724 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2725 * ofputil_flow_stats in 'fs'.
2727 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2728 * OpenFlow message. Calling this function multiple times for a single 'msg'
2729 * iterates through the replies. The caller must initially leave 'msg''s layer
2730 * pointers null and not modify them between calls.
2732 * Most switches don't send the values needed to populate fs->idle_age and
2733 * fs->hard_age, so those members will usually be set to 0. If the switch from
2734 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2735 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2736 * 'idle_age' and 'hard_age' members in 'fs'.
2738 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2739 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2740 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2742 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2743 * otherwise a positive errno value. */
2745 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats
*fs
,
2747 bool flow_age_extension
,
2748 struct ofpbuf
*ofpacts
)
2750 const struct ofp_header
*oh
;
2755 ? ofpraw_decode(&raw
, msg
->frame
)
2756 : ofpraw_pull(&raw
, msg
));
2762 if (!ofpbuf_size(msg
)) {
2764 } else if (raw
== OFPRAW_OFPST11_FLOW_REPLY
2765 || raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2766 const struct ofp11_flow_stats
*ofs
;
2768 uint16_t padded_match_len
;
2770 ofs
= ofpbuf_try_pull(msg
, sizeof *ofs
);
2772 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply has %"PRIu32
" leftover "
2773 "bytes at end", ofpbuf_size(msg
));
2777 length
= ntohs(ofs
->length
);
2778 if (length
< sizeof *ofs
) {
2779 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply claims invalid "
2780 "length %"PRIuSIZE
, length
);
2784 if (ofputil_pull_ofp11_match(msg
, &fs
->match
, &padded_match_len
)) {
2785 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply bad match");
2789 if (ofpacts_pull_openflow_instructions(msg
, length
- sizeof *ofs
-
2790 padded_match_len
, oh
->version
,
2792 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply bad instructions");
2796 fs
->priority
= ntohs(ofs
->priority
);
2797 fs
->table_id
= ofs
->table_id
;
2798 fs
->duration_sec
= ntohl(ofs
->duration_sec
);
2799 fs
->duration_nsec
= ntohl(ofs
->duration_nsec
);
2800 fs
->idle_timeout
= ntohs(ofs
->idle_timeout
);
2801 fs
->hard_timeout
= ntohs(ofs
->hard_timeout
);
2802 if (raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2803 error
= ofputil_decode_flow_mod_flags(ofs
->flags
, -1, oh
->version
,
2813 fs
->cookie
= ofs
->cookie
;
2814 fs
->packet_count
= ntohll(ofs
->packet_count
);
2815 fs
->byte_count
= ntohll(ofs
->byte_count
);
2816 } else if (raw
== OFPRAW_OFPST10_FLOW_REPLY
) {
2817 const struct ofp10_flow_stats
*ofs
;
2820 ofs
= ofpbuf_try_pull(msg
, sizeof *ofs
);
2822 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply has %"PRIu32
" leftover "
2823 "bytes at end", ofpbuf_size(msg
));
2827 length
= ntohs(ofs
->length
);
2828 if (length
< sizeof *ofs
) {
2829 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply claims invalid "
2830 "length %"PRIuSIZE
, length
);
2834 if (ofpacts_pull_openflow_actions(msg
, length
- sizeof *ofs
,
2835 oh
->version
, ofpacts
)) {
2839 fs
->cookie
= get_32aligned_be64(&ofs
->cookie
);
2840 ofputil_match_from_ofp10_match(&ofs
->match
, &fs
->match
);
2841 fs
->priority
= ntohs(ofs
->priority
);
2842 fs
->table_id
= ofs
->table_id
;
2843 fs
->duration_sec
= ntohl(ofs
->duration_sec
);
2844 fs
->duration_nsec
= ntohl(ofs
->duration_nsec
);
2845 fs
->idle_timeout
= ntohs(ofs
->idle_timeout
);
2846 fs
->hard_timeout
= ntohs(ofs
->hard_timeout
);
2849 fs
->packet_count
= ntohll(get_32aligned_be64(&ofs
->packet_count
));
2850 fs
->byte_count
= ntohll(get_32aligned_be64(&ofs
->byte_count
));
2852 } else if (raw
== OFPRAW_NXST_FLOW_REPLY
) {
2853 const struct nx_flow_stats
*nfs
;
2854 size_t match_len
, actions_len
, length
;
2856 nfs
= ofpbuf_try_pull(msg
, sizeof *nfs
);
2858 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW reply has %"PRIu32
" leftover "
2859 "bytes at end", ofpbuf_size(msg
));
2863 length
= ntohs(nfs
->length
);
2864 match_len
= ntohs(nfs
->match_len
);
2865 if (length
< sizeof *nfs
+ ROUND_UP(match_len
, 8)) {
2866 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW reply with match_len=%"PRIuSIZE
" "
2867 "claims invalid length %"PRIuSIZE
, match_len
, length
);
2870 if (nx_pull_match(msg
, match_len
, &fs
->match
, NULL
, NULL
)) {
2874 actions_len
= length
- sizeof *nfs
- ROUND_UP(match_len
, 8);
2875 if (ofpacts_pull_openflow_actions(msg
, actions_len
, oh
->version
,
2880 fs
->cookie
= nfs
->cookie
;
2881 fs
->table_id
= nfs
->table_id
;
2882 fs
->duration_sec
= ntohl(nfs
->duration_sec
);
2883 fs
->duration_nsec
= ntohl(nfs
->duration_nsec
);
2884 fs
->priority
= ntohs(nfs
->priority
);
2885 fs
->idle_timeout
= ntohs(nfs
->idle_timeout
);
2886 fs
->hard_timeout
= ntohs(nfs
->hard_timeout
);
2889 if (flow_age_extension
) {
2890 if (nfs
->idle_age
) {
2891 fs
->idle_age
= ntohs(nfs
->idle_age
) - 1;
2893 if (nfs
->hard_age
) {
2894 fs
->hard_age
= ntohs(nfs
->hard_age
) - 1;
2897 fs
->packet_count
= ntohll(nfs
->packet_count
);
2898 fs
->byte_count
= ntohll(nfs
->byte_count
);
2904 fs
->ofpacts
= ofpbuf_data(ofpacts
);
2905 fs
->ofpacts_len
= ofpbuf_size(ofpacts
);
2910 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2912 * We use this in situations where OVS internally uses UINT64_MAX to mean
2913 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2915 unknown_to_zero(uint64_t count
)
2917 return count
!= UINT64_MAX
? count
: 0;
2920 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2921 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2922 * have been initialized with ofpmp_init(). */
2924 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats
*fs
,
2925 struct list
*replies
)
2927 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
2928 size_t start_ofs
= ofpbuf_size(reply
);
2929 enum ofp_version version
= ofpmp_version(replies
);
2930 enum ofpraw raw
= ofpmp_decode_raw(replies
);
2932 if (raw
== OFPRAW_OFPST11_FLOW_REPLY
|| raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2933 struct ofp11_flow_stats
*ofs
;
2935 ofpbuf_put_uninit(reply
, sizeof *ofs
);
2936 oxm_put_match(reply
, &fs
->match
, version
);
2937 ofpacts_put_openflow_instructions(fs
->ofpacts
, fs
->ofpacts_len
, reply
,
2940 ofs
= ofpbuf_at_assert(reply
, start_ofs
, sizeof *ofs
);
2941 ofs
->length
= htons(ofpbuf_size(reply
) - start_ofs
);
2942 ofs
->table_id
= fs
->table_id
;
2944 ofs
->duration_sec
= htonl(fs
->duration_sec
);
2945 ofs
->duration_nsec
= htonl(fs
->duration_nsec
);
2946 ofs
->priority
= htons(fs
->priority
);
2947 ofs
->idle_timeout
= htons(fs
->idle_timeout
);
2948 ofs
->hard_timeout
= htons(fs
->hard_timeout
);
2949 if (raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2950 ofs
->flags
= ofputil_encode_flow_mod_flags(fs
->flags
, version
);
2954 memset(ofs
->pad2
, 0, sizeof ofs
->pad2
);
2955 ofs
->cookie
= fs
->cookie
;
2956 ofs
->packet_count
= htonll(unknown_to_zero(fs
->packet_count
));
2957 ofs
->byte_count
= htonll(unknown_to_zero(fs
->byte_count
));
2958 } else if (raw
== OFPRAW_OFPST10_FLOW_REPLY
) {
2959 struct ofp10_flow_stats
*ofs
;
2961 ofpbuf_put_uninit(reply
, sizeof *ofs
);
2962 ofpacts_put_openflow_actions(fs
->ofpacts
, fs
->ofpacts_len
, reply
,
2964 ofs
= ofpbuf_at_assert(reply
, start_ofs
, sizeof *ofs
);
2965 ofs
->length
= htons(ofpbuf_size(reply
) - start_ofs
);
2966 ofs
->table_id
= fs
->table_id
;
2968 ofputil_match_to_ofp10_match(&fs
->match
, &ofs
->match
);
2969 ofs
->duration_sec
= htonl(fs
->duration_sec
);
2970 ofs
->duration_nsec
= htonl(fs
->duration_nsec
);
2971 ofs
->priority
= htons(fs
->priority
);
2972 ofs
->idle_timeout
= htons(fs
->idle_timeout
);
2973 ofs
->hard_timeout
= htons(fs
->hard_timeout
);
2974 memset(ofs
->pad2
, 0, sizeof ofs
->pad2
);
2975 put_32aligned_be64(&ofs
->cookie
, fs
->cookie
);
2976 put_32aligned_be64(&ofs
->packet_count
,
2977 htonll(unknown_to_zero(fs
->packet_count
)));
2978 put_32aligned_be64(&ofs
->byte_count
,
2979 htonll(unknown_to_zero(fs
->byte_count
)));
2980 } else if (raw
== OFPRAW_NXST_FLOW_REPLY
) {
2981 struct nx_flow_stats
*nfs
;
2984 ofpbuf_put_uninit(reply
, sizeof *nfs
);
2985 match_len
= nx_put_match(reply
, &fs
->match
, 0, 0);
2986 ofpacts_put_openflow_actions(fs
->ofpacts
, fs
->ofpacts_len
, reply
,
2988 nfs
= ofpbuf_at_assert(reply
, start_ofs
, sizeof *nfs
);
2989 nfs
->length
= htons(ofpbuf_size(reply
) - start_ofs
);
2990 nfs
->table_id
= fs
->table_id
;
2992 nfs
->duration_sec
= htonl(fs
->duration_sec
);
2993 nfs
->duration_nsec
= htonl(fs
->duration_nsec
);
2994 nfs
->priority
= htons(fs
->priority
);
2995 nfs
->idle_timeout
= htons(fs
->idle_timeout
);
2996 nfs
->hard_timeout
= htons(fs
->hard_timeout
);
2997 nfs
->idle_age
= htons(fs
->idle_age
< 0 ? 0
2998 : fs
->idle_age
< UINT16_MAX
? fs
->idle_age
+ 1
3000 nfs
->hard_age
= htons(fs
->hard_age
< 0 ? 0
3001 : fs
->hard_age
< UINT16_MAX
? fs
->hard_age
+ 1
3003 nfs
->match_len
= htons(match_len
);
3004 nfs
->cookie
= fs
->cookie
;
3005 nfs
->packet_count
= htonll(fs
->packet_count
);
3006 nfs
->byte_count
= htonll(fs
->byte_count
);
3011 ofpmp_postappend(replies
, start_ofs
);
3014 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
3015 * NXST_AGGREGATE reply matching 'request', and returns the message. */
3017 ofputil_encode_aggregate_stats_reply(
3018 const struct ofputil_aggregate_stats
*stats
,
3019 const struct ofp_header
*request
)
3021 struct ofp_aggregate_stats_reply
*asr
;
3022 uint64_t packet_count
;
3023 uint64_t byte_count
;
3027 ofpraw_decode(&raw
, request
);
3028 if (raw
== OFPRAW_OFPST10_AGGREGATE_REQUEST
) {
3029 packet_count
= unknown_to_zero(stats
->packet_count
);
3030 byte_count
= unknown_to_zero(stats
->byte_count
);
3032 packet_count
= stats
->packet_count
;
3033 byte_count
= stats
->byte_count
;
3036 msg
= ofpraw_alloc_stats_reply(request
, 0);
3037 asr
= ofpbuf_put_zeros(msg
, sizeof *asr
);
3038 put_32aligned_be64(&asr
->packet_count
, htonll(packet_count
));
3039 put_32aligned_be64(&asr
->byte_count
, htonll(byte_count
));
3040 asr
->flow_count
= htonl(stats
->flow_count
);
3046 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats
*stats
,
3047 const struct ofp_header
*reply
)
3049 struct ofp_aggregate_stats_reply
*asr
;
3052 ofpbuf_use_const(&msg
, reply
, ntohs(reply
->length
));
3053 ofpraw_pull_assert(&msg
);
3055 asr
= ofpbuf_l3(&msg
);
3056 stats
->packet_count
= ntohll(get_32aligned_be64(&asr
->packet_count
));
3057 stats
->byte_count
= ntohll(get_32aligned_be64(&asr
->byte_count
));
3058 stats
->flow_count
= ntohl(asr
->flow_count
);
3063 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3064 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
3065 * an OpenFlow error code. */
3067 ofputil_decode_flow_removed(struct ofputil_flow_removed
*fr
,
3068 const struct ofp_header
*oh
)
3073 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3074 raw
= ofpraw_pull_assert(&b
);
3075 if (raw
== OFPRAW_OFPT11_FLOW_REMOVED
) {
3076 const struct ofp12_flow_removed
*ofr
;
3079 ofr
= ofpbuf_pull(&b
, sizeof *ofr
);
3081 error
= ofputil_pull_ofp11_match(&b
, &fr
->match
, NULL
);
3086 fr
->priority
= ntohs(ofr
->priority
);
3087 fr
->cookie
= ofr
->cookie
;
3088 fr
->reason
= ofr
->reason
;
3089 fr
->table_id
= ofr
->table_id
;
3090 fr
->duration_sec
= ntohl(ofr
->duration_sec
);
3091 fr
->duration_nsec
= ntohl(ofr
->duration_nsec
);
3092 fr
->idle_timeout
= ntohs(ofr
->idle_timeout
);
3093 fr
->hard_timeout
= ntohs(ofr
->hard_timeout
);
3094 fr
->packet_count
= ntohll(ofr
->packet_count
);
3095 fr
->byte_count
= ntohll(ofr
->byte_count
);
3096 } else if (raw
== OFPRAW_OFPT10_FLOW_REMOVED
) {
3097 const struct ofp10_flow_removed
*ofr
;
3099 ofr
= ofpbuf_pull(&b
, sizeof *ofr
);
3101 ofputil_match_from_ofp10_match(&ofr
->match
, &fr
->match
);
3102 fr
->priority
= ntohs(ofr
->priority
);
3103 fr
->cookie
= ofr
->cookie
;
3104 fr
->reason
= ofr
->reason
;
3106 fr
->duration_sec
= ntohl(ofr
->duration_sec
);
3107 fr
->duration_nsec
= ntohl(ofr
->duration_nsec
);
3108 fr
->idle_timeout
= ntohs(ofr
->idle_timeout
);
3109 fr
->hard_timeout
= 0;
3110 fr
->packet_count
= ntohll(ofr
->packet_count
);
3111 fr
->byte_count
= ntohll(ofr
->byte_count
);
3112 } else if (raw
== OFPRAW_NXT_FLOW_REMOVED
) {
3113 struct nx_flow_removed
*nfr
;
3116 nfr
= ofpbuf_pull(&b
, sizeof *nfr
);
3117 error
= nx_pull_match(&b
, ntohs(nfr
->match_len
), &fr
->match
,
3122 if (ofpbuf_size(&b
)) {
3123 return OFPERR_OFPBRC_BAD_LEN
;
3126 fr
->priority
= ntohs(nfr
->priority
);
3127 fr
->cookie
= nfr
->cookie
;
3128 fr
->reason
= nfr
->reason
;
3129 fr
->table_id
= nfr
->table_id
? nfr
->table_id
- 1 : 255;
3130 fr
->duration_sec
= ntohl(nfr
->duration_sec
);
3131 fr
->duration_nsec
= ntohl(nfr
->duration_nsec
);
3132 fr
->idle_timeout
= ntohs(nfr
->idle_timeout
);
3133 fr
->hard_timeout
= 0;
3134 fr
->packet_count
= ntohll(nfr
->packet_count
);
3135 fr
->byte_count
= ntohll(nfr
->byte_count
);
3143 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3144 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3147 ofputil_encode_flow_removed(const struct ofputil_flow_removed
*fr
,
3148 enum ofputil_protocol protocol
)
3151 enum ofp_flow_removed_reason reason
= fr
->reason
;
3153 if (reason
== OFPRR_METER_DELETE
&& !(protocol
& OFPUTIL_P_OF14_UP
)) {
3154 reason
= OFPRR_DELETE
;
3158 case OFPUTIL_P_OF11_STD
:
3159 case OFPUTIL_P_OF12_OXM
:
3160 case OFPUTIL_P_OF13_OXM
:
3161 case OFPUTIL_P_OF14_OXM
:
3162 case OFPUTIL_P_OF15_OXM
: {
3163 struct ofp12_flow_removed
*ofr
;
3165 msg
= ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED
,
3166 ofputil_protocol_to_ofp_version(protocol
),
3168 ofputil_match_typical_len(protocol
));
3169 ofr
= ofpbuf_put_zeros(msg
, sizeof *ofr
);
3170 ofr
->cookie
= fr
->cookie
;
3171 ofr
->priority
= htons(fr
->priority
);
3172 ofr
->reason
= reason
;
3173 ofr
->table_id
= fr
->table_id
;
3174 ofr
->duration_sec
= htonl(fr
->duration_sec
);
3175 ofr
->duration_nsec
= htonl(fr
->duration_nsec
);
3176 ofr
->idle_timeout
= htons(fr
->idle_timeout
);
3177 ofr
->hard_timeout
= htons(fr
->hard_timeout
);
3178 ofr
->packet_count
= htonll(fr
->packet_count
);
3179 ofr
->byte_count
= htonll(fr
->byte_count
);
3180 ofputil_put_ofp11_match(msg
, &fr
->match
, protocol
);
3184 case OFPUTIL_P_OF10_STD
:
3185 case OFPUTIL_P_OF10_STD_TID
: {
3186 struct ofp10_flow_removed
*ofr
;
3188 msg
= ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED
, OFP10_VERSION
,
3190 ofr
= ofpbuf_put_zeros(msg
, sizeof *ofr
);
3191 ofputil_match_to_ofp10_match(&fr
->match
, &ofr
->match
);
3192 ofr
->cookie
= fr
->cookie
;
3193 ofr
->priority
= htons(fr
->priority
);
3194 ofr
->reason
= reason
;
3195 ofr
->duration_sec
= htonl(fr
->duration_sec
);
3196 ofr
->duration_nsec
= htonl(fr
->duration_nsec
);
3197 ofr
->idle_timeout
= htons(fr
->idle_timeout
);
3198 ofr
->packet_count
= htonll(unknown_to_zero(fr
->packet_count
));
3199 ofr
->byte_count
= htonll(unknown_to_zero(fr
->byte_count
));
3203 case OFPUTIL_P_OF10_NXM
:
3204 case OFPUTIL_P_OF10_NXM_TID
: {
3205 struct nx_flow_removed
*nfr
;
3208 msg
= ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED
, OFP10_VERSION
,
3209 htonl(0), NXM_TYPICAL_LEN
);
3210 ofpbuf_put_zeros(msg
, sizeof *nfr
);
3211 match_len
= nx_put_match(msg
, &fr
->match
, 0, 0);
3213 nfr
= ofpbuf_l3(msg
);
3214 nfr
->cookie
= fr
->cookie
;
3215 nfr
->priority
= htons(fr
->priority
);
3216 nfr
->reason
= reason
;
3217 nfr
->table_id
= fr
->table_id
+ 1;
3218 nfr
->duration_sec
= htonl(fr
->duration_sec
);
3219 nfr
->duration_nsec
= htonl(fr
->duration_nsec
);
3220 nfr
->idle_timeout
= htons(fr
->idle_timeout
);
3221 nfr
->match_len
= htons(match_len
);
3222 nfr
->packet_count
= htonll(fr
->packet_count
);
3223 nfr
->byte_count
= htonll(fr
->byte_count
);
3235 ofputil_decode_packet_in_finish(struct ofputil_packet_in
*pin
,
3236 struct match
*match
, struct ofpbuf
*b
)
3238 pin
->packet
= ofpbuf_data(b
);
3239 pin
->packet_len
= ofpbuf_size(b
);
3241 pin
->fmd
.in_port
= match
->flow
.in_port
.ofp_port
;
3242 pin
->fmd
.tun_id
= match
->flow
.tunnel
.tun_id
;
3243 pin
->fmd
.tun_src
= match
->flow
.tunnel
.ip_src
;
3244 pin
->fmd
.tun_dst
= match
->flow
.tunnel
.ip_dst
;
3245 pin
->fmd
.metadata
= match
->flow
.metadata
;
3246 memcpy(pin
->fmd
.regs
, match
->flow
.regs
, sizeof pin
->fmd
.regs
);
3247 pin
->fmd
.pkt_mark
= match
->flow
.pkt_mark
;
3251 ofputil_decode_packet_in(struct ofputil_packet_in
*pin
,
3252 const struct ofp_header
*oh
)
3257 memset(pin
, 0, sizeof *pin
);
3258 pin
->cookie
= OVS_BE64_MAX
;
3260 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3261 raw
= ofpraw_pull_assert(&b
);
3262 if (raw
== OFPRAW_OFPT13_PACKET_IN
|| raw
== OFPRAW_OFPT12_PACKET_IN
) {
3263 const struct ofp13_packet_in
*opi
;
3266 size_t packet_in_size
;
3268 if (raw
== OFPRAW_OFPT12_PACKET_IN
) {
3269 packet_in_size
= sizeof (struct ofp12_packet_in
);
3271 packet_in_size
= sizeof (struct ofp13_packet_in
);
3274 opi
= ofpbuf_pull(&b
, packet_in_size
);
3275 error
= oxm_pull_match_loose(&b
, &match
);
3280 if (!ofpbuf_try_pull(&b
, 2)) {
3281 return OFPERR_OFPBRC_BAD_LEN
;
3284 pin
->reason
= opi
->pi
.reason
;
3285 pin
->table_id
= opi
->pi
.table_id
;
3286 pin
->buffer_id
= ntohl(opi
->pi
.buffer_id
);
3287 pin
->total_len
= ntohs(opi
->pi
.total_len
);
3289 if (raw
== OFPRAW_OFPT13_PACKET_IN
) {
3290 pin
->cookie
= opi
->cookie
;
3293 ofputil_decode_packet_in_finish(pin
, &match
, &b
);
3294 } else if (raw
== OFPRAW_OFPT10_PACKET_IN
) {
3295 const struct ofp10_packet_in
*opi
;
3297 opi
= ofpbuf_pull(&b
, offsetof(struct ofp10_packet_in
, data
));
3299 pin
->packet
= opi
->data
;
3300 pin
->packet_len
= ofpbuf_size(&b
);
3302 pin
->fmd
.in_port
= u16_to_ofp(ntohs(opi
->in_port
));
3303 pin
->reason
= opi
->reason
;
3304 pin
->buffer_id
= ntohl(opi
->buffer_id
);
3305 pin
->total_len
= ntohs(opi
->total_len
);
3306 } else if (raw
== OFPRAW_OFPT11_PACKET_IN
) {
3307 const struct ofp11_packet_in
*opi
;
3310 opi
= ofpbuf_pull(&b
, sizeof *opi
);
3312 pin
->packet
= ofpbuf_data(&b
);
3313 pin
->packet_len
= ofpbuf_size(&b
);
3315 pin
->buffer_id
= ntohl(opi
->buffer_id
);
3316 error
= ofputil_port_from_ofp11(opi
->in_port
, &pin
->fmd
.in_port
);
3320 pin
->total_len
= ntohs(opi
->total_len
);
3321 pin
->reason
= opi
->reason
;
3322 pin
->table_id
= opi
->table_id
;
3323 } else if (raw
== OFPRAW_NXT_PACKET_IN
) {
3324 const struct nx_packet_in
*npi
;
3328 npi
= ofpbuf_pull(&b
, sizeof *npi
);
3329 error
= nx_pull_match_loose(&b
, ntohs(npi
->match_len
), &match
, NULL
,
3335 if (!ofpbuf_try_pull(&b
, 2)) {
3336 return OFPERR_OFPBRC_BAD_LEN
;
3339 pin
->reason
= npi
->reason
;
3340 pin
->table_id
= npi
->table_id
;
3341 pin
->cookie
= npi
->cookie
;
3343 pin
->buffer_id
= ntohl(npi
->buffer_id
);
3344 pin
->total_len
= ntohs(npi
->total_len
);
3346 ofputil_decode_packet_in_finish(pin
, &match
, &b
);
3355 ofputil_packet_in_to_match(const struct ofputil_packet_in
*pin
,
3356 struct match
*match
)
3360 match_init_catchall(match
);
3361 if (pin
->fmd
.tun_id
!= htonll(0)) {
3362 match_set_tun_id(match
, pin
->fmd
.tun_id
);
3364 if (pin
->fmd
.tun_src
!= htonl(0)) {
3365 match_set_tun_src(match
, pin
->fmd
.tun_src
);
3367 if (pin
->fmd
.tun_dst
!= htonl(0)) {
3368 match_set_tun_dst(match
, pin
->fmd
.tun_dst
);
3370 if (pin
->fmd
.metadata
!= htonll(0)) {
3371 match_set_metadata(match
, pin
->fmd
.metadata
);
3374 for (i
= 0; i
< FLOW_N_REGS
; i
++) {
3375 if (pin
->fmd
.regs
[i
]) {
3376 match_set_reg(match
, i
, pin
->fmd
.regs
[i
]);
3380 if (pin
->fmd
.pkt_mark
!= 0) {
3381 match_set_pkt_mark(match
, pin
->fmd
.pkt_mark
);
3384 match_set_in_port(match
, pin
->fmd
.in_port
);
3387 static struct ofpbuf
*
3388 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in
*pin
)
3390 struct ofp10_packet_in
*opi
;
3391 struct ofpbuf
*packet
;
3393 packet
= ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN
, OFP10_VERSION
,
3394 htonl(0), pin
->packet_len
);
3395 opi
= ofpbuf_put_zeros(packet
, offsetof(struct ofp10_packet_in
, data
));
3396 opi
->total_len
= htons(pin
->total_len
);
3397 opi
->in_port
= htons(ofp_to_u16(pin
->fmd
.in_port
));
3398 opi
->reason
= pin
->reason
;
3399 opi
->buffer_id
= htonl(pin
->buffer_id
);
3401 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3406 static struct ofpbuf
*
3407 ofputil_encode_nx_packet_in(const struct ofputil_packet_in
*pin
)
3409 struct nx_packet_in
*npi
;
3410 struct ofpbuf
*packet
;
3414 ofputil_packet_in_to_match(pin
, &match
);
3416 /* The final argument is just an estimate of the space required. */
3417 packet
= ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN
, OFP10_VERSION
,
3418 htonl(0), (sizeof(struct flow_metadata
) * 2
3419 + 2 + pin
->packet_len
));
3420 ofpbuf_put_zeros(packet
, sizeof *npi
);
3421 match_len
= nx_put_match(packet
, &match
, 0, 0);
3422 ofpbuf_put_zeros(packet
, 2);
3423 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3425 npi
= ofpbuf_l3(packet
);
3426 npi
->buffer_id
= htonl(pin
->buffer_id
);
3427 npi
->total_len
= htons(pin
->total_len
);
3428 npi
->reason
= pin
->reason
;
3429 npi
->table_id
= pin
->table_id
;
3430 npi
->cookie
= pin
->cookie
;
3431 npi
->match_len
= htons(match_len
);
3436 static struct ofpbuf
*
3437 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in
*pin
)
3439 struct ofp11_packet_in
*opi
;
3440 struct ofpbuf
*packet
;
3442 packet
= ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN
, OFP11_VERSION
,
3443 htonl(0), pin
->packet_len
);
3444 opi
= ofpbuf_put_zeros(packet
, sizeof *opi
);
3445 opi
->buffer_id
= htonl(pin
->buffer_id
);
3446 opi
->in_port
= ofputil_port_to_ofp11(pin
->fmd
.in_port
);
3447 opi
->in_phy_port
= opi
->in_port
;
3448 opi
->total_len
= htons(pin
->total_len
);
3449 opi
->reason
= pin
->reason
;
3450 opi
->table_id
= pin
->table_id
;
3452 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3457 static struct ofpbuf
*
3458 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in
*pin
,
3459 enum ofputil_protocol protocol
)
3461 struct ofp13_packet_in
*opi
;
3463 enum ofpraw packet_in_raw
;
3464 enum ofp_version packet_in_version
;
3465 size_t packet_in_size
;
3466 struct ofpbuf
*packet
;
3468 if (protocol
== OFPUTIL_P_OF12_OXM
) {
3469 packet_in_raw
= OFPRAW_OFPT12_PACKET_IN
;
3470 packet_in_version
= OFP12_VERSION
;
3471 packet_in_size
= sizeof (struct ofp12_packet_in
);
3473 packet_in_raw
= OFPRAW_OFPT13_PACKET_IN
;
3474 packet_in_version
= OFP13_VERSION
;
3475 packet_in_size
= sizeof (struct ofp13_packet_in
);
3478 ofputil_packet_in_to_match(pin
, &match
);
3480 /* The final argument is just an estimate of the space required. */
3481 packet
= ofpraw_alloc_xid(packet_in_raw
, packet_in_version
,
3482 htonl(0), (sizeof(struct flow_metadata
) * 2
3483 + 2 + pin
->packet_len
));
3484 ofpbuf_put_zeros(packet
, packet_in_size
);
3485 oxm_put_match(packet
, &match
, ofputil_protocol_to_ofp_version(protocol
));
3486 ofpbuf_put_zeros(packet
, 2);
3487 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3489 opi
= ofpbuf_l3(packet
);
3490 opi
->pi
.buffer_id
= htonl(pin
->buffer_id
);
3491 opi
->pi
.total_len
= htons(pin
->total_len
);
3492 opi
->pi
.reason
= pin
->reason
;
3493 opi
->pi
.table_id
= pin
->table_id
;
3494 if (protocol
== OFPUTIL_P_OF13_OXM
) {
3495 opi
->cookie
= pin
->cookie
;
3501 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3502 * in the format specified by 'packet_in_format'. */
3504 ofputil_encode_packet_in(const struct ofputil_packet_in
*pin
,
3505 enum ofputil_protocol protocol
,
3506 enum nx_packet_in_format packet_in_format
)
3508 struct ofpbuf
*packet
;
3511 case OFPUTIL_P_OF10_STD
:
3512 case OFPUTIL_P_OF10_STD_TID
:
3513 case OFPUTIL_P_OF10_NXM
:
3514 case OFPUTIL_P_OF10_NXM_TID
:
3515 packet
= (packet_in_format
== NXPIF_NXM
3516 ? ofputil_encode_nx_packet_in(pin
)
3517 : ofputil_encode_ofp10_packet_in(pin
));
3520 case OFPUTIL_P_OF11_STD
:
3521 packet
= ofputil_encode_ofp11_packet_in(pin
);
3524 case OFPUTIL_P_OF12_OXM
:
3525 case OFPUTIL_P_OF13_OXM
:
3526 case OFPUTIL_P_OF14_OXM
:
3527 case OFPUTIL_P_OF15_OXM
:
3528 packet
= ofputil_encode_ofp12_packet_in(pin
, protocol
);
3535 ofpmsg_update_length(packet
);
3539 /* Returns a string form of 'reason'. The return value is either a statically
3540 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3541 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3543 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason
,
3544 char *reasonbuf
, size_t bufsize
)
3551 case OFPR_INVALID_TTL
:
3552 return "invalid_ttl";
3554 case OFPR_N_REASONS
:
3556 snprintf(reasonbuf
, bufsize
, "%d", (int) reason
);
3562 ofputil_packet_in_reason_from_string(const char *s
,
3563 enum ofp_packet_in_reason
*reason
)
3567 for (i
= 0; i
< OFPR_N_REASONS
; i
++) {
3568 char reasonbuf
[OFPUTIL_PACKET_IN_REASON_BUFSIZE
];
3569 const char *reason_s
;
3571 reason_s
= ofputil_packet_in_reason_to_string(i
, reasonbuf
,
3573 if (!strcasecmp(s
, reason_s
)) {
3581 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3584 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3585 * message's actions. The caller must initialize 'ofpacts' and retains
3586 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3588 * Returns 0 if successful, otherwise an OFPERR_* value. */
3590 ofputil_decode_packet_out(struct ofputil_packet_out
*po
,
3591 const struct ofp_header
*oh
,
3592 struct ofpbuf
*ofpacts
)
3597 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3598 raw
= ofpraw_pull_assert(&b
);
3600 if (raw
== OFPRAW_OFPT11_PACKET_OUT
) {
3602 const struct ofp11_packet_out
*opo
= ofpbuf_pull(&b
, sizeof *opo
);
3604 po
->buffer_id
= ntohl(opo
->buffer_id
);
3605 error
= ofputil_port_from_ofp11(opo
->in_port
, &po
->in_port
);
3610 error
= ofpacts_pull_openflow_actions(&b
, ntohs(opo
->actions_len
),
3611 oh
->version
, ofpacts
);
3615 } else if (raw
== OFPRAW_OFPT10_PACKET_OUT
) {
3617 const struct ofp10_packet_out
*opo
= ofpbuf_pull(&b
, sizeof *opo
);
3619 po
->buffer_id
= ntohl(opo
->buffer_id
);
3620 po
->in_port
= u16_to_ofp(ntohs(opo
->in_port
));
3622 error
= ofpacts_pull_openflow_actions(&b
, ntohs(opo
->actions_len
),
3623 oh
->version
, ofpacts
);
3631 if (ofp_to_u16(po
->in_port
) >= ofp_to_u16(OFPP_MAX
)
3632 && po
->in_port
!= OFPP_LOCAL
3633 && po
->in_port
!= OFPP_NONE
&& po
->in_port
!= OFPP_CONTROLLER
) {
3634 VLOG_WARN_RL(&bad_ofmsg_rl
, "packet-out has bad input port %#"PRIx16
,
3636 return OFPERR_OFPBRC_BAD_PORT
;
3639 po
->ofpacts
= ofpbuf_data(ofpacts
);
3640 po
->ofpacts_len
= ofpbuf_size(ofpacts
);
3642 if (po
->buffer_id
== UINT32_MAX
) {
3643 po
->packet
= ofpbuf_data(&b
);
3644 po
->packet_len
= ofpbuf_size(&b
);
3653 /* ofputil_phy_port */
3655 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3656 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD
== OFPPF_10MB_HD
); /* bit 0 */
3657 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD
== OFPPF_10MB_FD
); /* bit 1 */
3658 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD
== OFPPF_100MB_HD
); /* bit 2 */
3659 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD
== OFPPF_100MB_FD
); /* bit 3 */
3660 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD
== OFPPF_1GB_HD
); /* bit 4 */
3661 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD
== OFPPF_1GB_FD
); /* bit 5 */
3662 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD
== OFPPF_10GB_FD
); /* bit 6 */
3664 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3665 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER
== (OFPPF10_COPPER
<< 4));
3666 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER
== (OFPPF10_FIBER
<< 4));
3667 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG
== (OFPPF10_AUTONEG
<< 4));
3668 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE
== (OFPPF10_PAUSE
<< 4));
3669 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM
== (OFPPF10_PAUSE_ASYM
<< 4));
3671 static enum netdev_features
3672 netdev_port_features_from_ofp10(ovs_be32 ofp10_
)
3674 uint32_t ofp10
= ntohl(ofp10_
);
3675 return (ofp10
& 0x7f) | ((ofp10
& 0xf80) << 4);
3679 netdev_port_features_to_ofp10(enum netdev_features features
)
3681 return htonl((features
& 0x7f) | ((features
& 0xf800) >> 4));
3684 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD
== OFPPF_10MB_HD
); /* bit 0 */
3685 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD
== OFPPF_10MB_FD
); /* bit 1 */
3686 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD
== OFPPF_100MB_HD
); /* bit 2 */
3687 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD
== OFPPF_100MB_FD
); /* bit 3 */
3688 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD
== OFPPF_1GB_HD
); /* bit 4 */
3689 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD
== OFPPF_1GB_FD
); /* bit 5 */
3690 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD
== OFPPF_10GB_FD
); /* bit 6 */
3691 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD
== OFPPF11_40GB_FD
); /* bit 7 */
3692 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD
== OFPPF11_100GB_FD
); /* bit 8 */
3693 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD
== OFPPF11_1TB_FD
); /* bit 9 */
3694 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER
== OFPPF11_OTHER
); /* bit 10 */
3695 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER
== OFPPF11_COPPER
); /* bit 11 */
3696 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER
== OFPPF11_FIBER
); /* bit 12 */
3697 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG
== OFPPF11_AUTONEG
); /* bit 13 */
3698 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE
== OFPPF11_PAUSE
); /* bit 14 */
3699 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM
== OFPPF11_PAUSE_ASYM
);/* bit 15 */
3701 static enum netdev_features
3702 netdev_port_features_from_ofp11(ovs_be32 ofp11
)
3704 return ntohl(ofp11
) & 0xffff;
3708 netdev_port_features_to_ofp11(enum netdev_features features
)
3710 return htonl(features
& 0xffff);
3714 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port
*pp
,
3715 const struct ofp10_phy_port
*opp
)
3717 pp
->port_no
= u16_to_ofp(ntohs(opp
->port_no
));
3718 memcpy(pp
->hw_addr
, opp
->hw_addr
, OFP_ETH_ALEN
);
3719 ovs_strlcpy(pp
->name
, opp
->name
, OFP_MAX_PORT_NAME_LEN
);
3721 pp
->config
= ntohl(opp
->config
) & OFPPC10_ALL
;
3722 pp
->state
= ntohl(opp
->state
) & OFPPS10_ALL
;
3724 pp
->curr
= netdev_port_features_from_ofp10(opp
->curr
);
3725 pp
->advertised
= netdev_port_features_from_ofp10(opp
->advertised
);
3726 pp
->supported
= netdev_port_features_from_ofp10(opp
->supported
);
3727 pp
->peer
= netdev_port_features_from_ofp10(opp
->peer
);
3729 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
3730 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
3736 ofputil_decode_ofp11_port(struct ofputil_phy_port
*pp
,
3737 const struct ofp11_port
*op
)
3741 error
= ofputil_port_from_ofp11(op
->port_no
, &pp
->port_no
);
3745 memcpy(pp
->hw_addr
, op
->hw_addr
, OFP_ETH_ALEN
);
3746 ovs_strlcpy(pp
->name
, op
->name
, OFP_MAX_PORT_NAME_LEN
);
3748 pp
->config
= ntohl(op
->config
) & OFPPC11_ALL
;
3749 pp
->state
= ntohl(op
->state
) & OFPPS11_ALL
;
3751 pp
->curr
= netdev_port_features_from_ofp11(op
->curr
);
3752 pp
->advertised
= netdev_port_features_from_ofp11(op
->advertised
);
3753 pp
->supported
= netdev_port_features_from_ofp11(op
->supported
);
3754 pp
->peer
= netdev_port_features_from_ofp11(op
->peer
);
3756 pp
->curr_speed
= ntohl(op
->curr_speed
);
3757 pp
->max_speed
= ntohl(op
->max_speed
);
3763 parse_ofp14_port_ethernet_property(const struct ofpbuf
*payload
,
3764 struct ofputil_phy_port
*pp
)
3766 struct ofp14_port_desc_prop_ethernet
*eth
= ofpbuf_data(payload
);
3768 if (ofpbuf_size(payload
) != sizeof *eth
) {
3769 return OFPERR_OFPBPC_BAD_LEN
;
3772 pp
->curr
= netdev_port_features_from_ofp11(eth
->curr
);
3773 pp
->advertised
= netdev_port_features_from_ofp11(eth
->advertised
);
3774 pp
->supported
= netdev_port_features_from_ofp11(eth
->supported
);
3775 pp
->peer
= netdev_port_features_from_ofp11(eth
->peer
);
3777 pp
->curr_speed
= ntohl(eth
->curr_speed
);
3778 pp
->max_speed
= ntohl(eth
->max_speed
);
3784 ofputil_pull_ofp14_port(struct ofputil_phy_port
*pp
, struct ofpbuf
*msg
)
3786 struct ofpbuf properties
;
3787 struct ofp14_port
*op
;
3791 op
= ofpbuf_try_pull(msg
, sizeof *op
);
3793 return OFPERR_OFPBRC_BAD_LEN
;
3796 len
= ntohs(op
->length
);
3797 if (len
< sizeof *op
|| len
- sizeof *op
> ofpbuf_size(msg
)) {
3798 return OFPERR_OFPBRC_BAD_LEN
;
3801 ofpbuf_use_const(&properties
, ofpbuf_pull(msg
, len
), len
);
3803 error
= ofputil_port_from_ofp11(op
->port_no
, &pp
->port_no
);
3807 memcpy(pp
->hw_addr
, op
->hw_addr
, OFP_ETH_ALEN
);
3808 ovs_strlcpy(pp
->name
, op
->name
, OFP_MAX_PORT_NAME_LEN
);
3810 pp
->config
= ntohl(op
->config
) & OFPPC11_ALL
;
3811 pp
->state
= ntohl(op
->state
) & OFPPS11_ALL
;
3813 while (ofpbuf_size(&properties
) > 0) {
3814 struct ofpbuf payload
;
3818 error
= ofputil_pull_property(&properties
, &payload
, &type
);
3824 case OFPPDPT14_ETHERNET
:
3825 error
= parse_ofp14_port_ethernet_property(&payload
, pp
);
3829 log_property(true, "unknown port property %"PRIu16
, type
);
3843 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port
*pp
,
3844 struct ofp10_phy_port
*opp
)
3846 memset(opp
, 0, sizeof *opp
);
3848 opp
->port_no
= htons(ofp_to_u16(pp
->port_no
));
3849 memcpy(opp
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3850 ovs_strlcpy(opp
->name
, pp
->name
, OFP_MAX_PORT_NAME_LEN
);
3852 opp
->config
= htonl(pp
->config
& OFPPC10_ALL
);
3853 opp
->state
= htonl(pp
->state
& OFPPS10_ALL
);
3855 opp
->curr
= netdev_port_features_to_ofp10(pp
->curr
);
3856 opp
->advertised
= netdev_port_features_to_ofp10(pp
->advertised
);
3857 opp
->supported
= netdev_port_features_to_ofp10(pp
->supported
);
3858 opp
->peer
= netdev_port_features_to_ofp10(pp
->peer
);
3862 ofputil_encode_ofp11_port(const struct ofputil_phy_port
*pp
,
3863 struct ofp11_port
*op
)
3865 memset(op
, 0, sizeof *op
);
3867 op
->port_no
= ofputil_port_to_ofp11(pp
->port_no
);
3868 memcpy(op
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3869 ovs_strlcpy(op
->name
, pp
->name
, OFP_MAX_PORT_NAME_LEN
);
3871 op
->config
= htonl(pp
->config
& OFPPC11_ALL
);
3872 op
->state
= htonl(pp
->state
& OFPPS11_ALL
);
3874 op
->curr
= netdev_port_features_to_ofp11(pp
->curr
);
3875 op
->advertised
= netdev_port_features_to_ofp11(pp
->advertised
);
3876 op
->supported
= netdev_port_features_to_ofp11(pp
->supported
);
3877 op
->peer
= netdev_port_features_to_ofp11(pp
->peer
);
3879 op
->curr_speed
= htonl(pp
->curr_speed
);
3880 op
->max_speed
= htonl(pp
->max_speed
);
3884 ofputil_put_ofp14_port(const struct ofputil_phy_port
*pp
,
3887 struct ofp14_port
*op
;
3888 struct ofp14_port_desc_prop_ethernet
*eth
;
3890 ofpbuf_prealloc_tailroom(b
, sizeof *op
+ sizeof *eth
);
3892 op
= ofpbuf_put_zeros(b
, sizeof *op
);
3893 op
->port_no
= ofputil_port_to_ofp11(pp
->port_no
);
3894 op
->length
= htons(sizeof *op
+ sizeof *eth
);
3895 memcpy(op
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3896 ovs_strlcpy(op
->name
, pp
->name
, sizeof op
->name
);
3897 op
->config
= htonl(pp
->config
& OFPPC11_ALL
);
3898 op
->state
= htonl(pp
->state
& OFPPS11_ALL
);
3900 eth
= ofpbuf_put_zeros(b
, sizeof *eth
);
3901 eth
->type
= htons(OFPPDPT14_ETHERNET
);
3902 eth
->length
= htons(sizeof *eth
);
3903 eth
->curr
= netdev_port_features_to_ofp11(pp
->curr
);
3904 eth
->advertised
= netdev_port_features_to_ofp11(pp
->advertised
);
3905 eth
->supported
= netdev_port_features_to_ofp11(pp
->supported
);
3906 eth
->peer
= netdev_port_features_to_ofp11(pp
->peer
);
3907 eth
->curr_speed
= htonl(pp
->curr_speed
);
3908 eth
->max_speed
= htonl(pp
->max_speed
);
3912 ofputil_put_phy_port(enum ofp_version ofp_version
,
3913 const struct ofputil_phy_port
*pp
, struct ofpbuf
*b
)
3915 switch (ofp_version
) {
3916 case OFP10_VERSION
: {
3917 struct ofp10_phy_port
*opp
= ofpbuf_put_uninit(b
, sizeof *opp
);
3918 ofputil_encode_ofp10_phy_port(pp
, opp
);
3924 case OFP13_VERSION
: {
3925 struct ofp11_port
*op
= ofpbuf_put_uninit(b
, sizeof *op
);
3926 ofputil_encode_ofp11_port(pp
, op
);
3932 ofputil_put_ofp14_port(pp
, b
);
3941 ofputil_decode_port_desc_stats_request(const struct ofp_header
*request
,
3947 ofpbuf_use_const(&b
, request
, ntohs(request
->length
));
3948 raw
= ofpraw_pull_assert(&b
);
3949 if (raw
== OFPRAW_OFPST10_PORT_DESC_REQUEST
) {
3952 } else if (raw
== OFPRAW_OFPST15_PORT_DESC_REQUEST
) {
3953 ovs_be32
*ofp11_port
;
3955 ofp11_port
= ofpbuf_pull(&b
, sizeof *ofp11_port
);
3956 return ofputil_port_from_ofp11(*ofp11_port
, port
);
3963 ofputil_encode_port_desc_stats_request(enum ofp_version ofp_version
,
3966 struct ofpbuf
*request
;
3967 ovs_be32 ofp11_port
;
3969 switch (ofp_version
) {
3975 request
= ofpraw_alloc(OFPRAW_OFPST10_PORT_DESC_REQUEST
,
3980 request
= ofpraw_alloc(OFPRAW_OFPST15_PORT_DESC_REQUEST
,
3982 ofp11_port
= ofputil_port_to_ofp11(port
);
3983 ofpbuf_put(request
, &ofp11_port
, sizeof ofp11_port
);
3994 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port
*pp
,
3995 struct list
*replies
)
3997 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
3998 size_t start_ofs
= ofpbuf_size(reply
);
4000 ofputil_put_phy_port(ofpmp_version(replies
), pp
, reply
);
4001 ofpmp_postappend(replies
, start_ofs
);
4004 /* ofputil_switch_features */
4006 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
4007 OFPC_IP_REASM | OFPC_QUEUE_STATS)
4008 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS
== OFPC_FLOW_STATS
);
4009 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS
== OFPC_TABLE_STATS
);
4010 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS
== OFPC_PORT_STATS
);
4011 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM
== OFPC_IP_REASM
);
4012 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS
== OFPC_QUEUE_STATS
);
4013 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP
== OFPC_ARP_MATCH_IP
);
4015 struct ofputil_action_bit_translation
{
4016 enum ofputil_action_bitmap ofputil_bit
;
4020 static const struct ofputil_action_bit_translation of10_action_bits
[] = {
4021 { OFPUTIL_A_OUTPUT
, OFPAT10_OUTPUT
},
4022 { OFPUTIL_A_SET_VLAN_VID
, OFPAT10_SET_VLAN_VID
},
4023 { OFPUTIL_A_SET_VLAN_PCP
, OFPAT10_SET_VLAN_PCP
},
4024 { OFPUTIL_A_STRIP_VLAN
, OFPAT10_STRIP_VLAN
},
4025 { OFPUTIL_A_SET_DL_SRC
, OFPAT10_SET_DL_SRC
},
4026 { OFPUTIL_A_SET_DL_DST
, OFPAT10_SET_DL_DST
},
4027 { OFPUTIL_A_SET_NW_SRC
, OFPAT10_SET_NW_SRC
},
4028 { OFPUTIL_A_SET_NW_DST
, OFPAT10_SET_NW_DST
},
4029 { OFPUTIL_A_SET_NW_TOS
, OFPAT10_SET_NW_TOS
},
4030 { OFPUTIL_A_SET_TP_SRC
, OFPAT10_SET_TP_SRC
},
4031 { OFPUTIL_A_SET_TP_DST
, OFPAT10_SET_TP_DST
},
4032 { OFPUTIL_A_ENQUEUE
, OFPAT10_ENQUEUE
},
4036 static enum ofputil_action_bitmap
4037 decode_action_bits(ovs_be32 of_actions
,
4038 const struct ofputil_action_bit_translation
*x
)
4040 enum ofputil_action_bitmap ofputil_actions
;
4042 ofputil_actions
= 0;
4043 for (; x
->ofputil_bit
; x
++) {
4044 if (of_actions
& htonl(1u << x
->of_bit
)) {
4045 ofputil_actions
|= x
->ofputil_bit
;
4048 return ofputil_actions
;
4052 ofputil_capabilities_mask(enum ofp_version ofp_version
)
4054 /* Handle capabilities whose bit is unique for all Open Flow versions */
4055 switch (ofp_version
) {
4058 return OFPC_COMMON
| OFPC_ARP_MATCH_IP
;
4063 return OFPC_COMMON
| OFPC12_PORT_BLOCKED
;
4065 /* Caller needs to check osf->header.version itself */
4070 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
4071 * abstract representation in '*features'. Initializes '*b' to iterate over
4072 * the OpenFlow port structures following 'osf' with later calls to
4073 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
4074 * OFPERR_* value. */
4076 ofputil_decode_switch_features(const struct ofp_header
*oh
,
4077 struct ofputil_switch_features
*features
,
4080 const struct ofp_switch_features
*osf
;
4083 ofpbuf_use_const(b
, oh
, ntohs(oh
->length
));
4084 raw
= ofpraw_pull_assert(b
);
4086 osf
= ofpbuf_pull(b
, sizeof *osf
);
4087 features
->datapath_id
= ntohll(osf
->datapath_id
);
4088 features
->n_buffers
= ntohl(osf
->n_buffers
);
4089 features
->n_tables
= osf
->n_tables
;
4090 features
->auxiliary_id
= 0;
4092 features
->capabilities
= ntohl(osf
->capabilities
) &
4093 ofputil_capabilities_mask(oh
->version
);
4095 if (raw
== OFPRAW_OFPT10_FEATURES_REPLY
) {
4096 if (osf
->capabilities
& htonl(OFPC10_STP
)) {
4097 features
->capabilities
|= OFPUTIL_C_STP
;
4099 features
->actions
= decode_action_bits(osf
->actions
, of10_action_bits
);
4100 } else if (raw
== OFPRAW_OFPT11_FEATURES_REPLY
4101 || raw
== OFPRAW_OFPT13_FEATURES_REPLY
) {
4102 if (osf
->capabilities
& htonl(OFPC11_GROUP_STATS
)) {
4103 features
->capabilities
|= OFPUTIL_C_GROUP_STATS
;
4105 features
->actions
= 0;
4106 if (raw
== OFPRAW_OFPT13_FEATURES_REPLY
) {
4107 features
->auxiliary_id
= osf
->auxiliary_id
;
4110 return OFPERR_OFPBRC_BAD_VERSION
;
4116 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4117 * switch's ports, unless there are too many to fit. In OpenFlow 1.3 and
4118 * later, an OFPT_FEATURES_REPLY does not list ports at all.
4120 * Given a buffer 'b' that contains a Features Reply message, this message
4121 * checks if it contains a complete list of the switch's ports. Returns true,
4122 * if so. Returns false if the list is missing (OF1.3+) or incomplete
4123 * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4126 * When this function returns false, the caller should send an OFPST_PORT_DESC
4127 * stats request to get the ports. */
4129 ofputil_switch_features_has_ports(struct ofpbuf
*b
)
4131 struct ofp_header
*oh
= ofpbuf_data(b
);
4132 size_t phy_port_size
;
4134 if (oh
->version
>= OFP13_VERSION
) {
4135 /* OpenFlow 1.3+ never has ports in the feature reply. */
4139 phy_port_size
= (oh
->version
== OFP10_VERSION
4140 ? sizeof(struct ofp10_phy_port
)
4141 : sizeof(struct ofp11_port
));
4142 if (ntohs(oh
->length
) + phy_port_size
<= UINT16_MAX
) {
4143 /* There's room for additional ports in the feature reply.
4144 * Assume that the list is complete. */
4148 /* The feature reply has no room for more ports. Probably the list is
4149 * truncated. Drop the ports and tell the caller to retrieve them with
4150 * OFPST_PORT_DESC. */
4151 ofpbuf_set_size(b
, sizeof *oh
+ sizeof(struct ofp_switch_features
));
4152 ofpmsg_update_length(b
);
4157 encode_action_bits(enum ofputil_action_bitmap ofputil_actions
,
4158 const struct ofputil_action_bit_translation
*x
)
4160 uint32_t of_actions
;
4163 for (; x
->ofputil_bit
; x
++) {
4164 if (ofputil_actions
& x
->ofputil_bit
) {
4165 of_actions
|= 1 << x
->of_bit
;
4168 return htonl(of_actions
);
4171 /* Returns a buffer owned by the caller that encodes 'features' in the format
4172 * required by 'protocol' with the given 'xid'. The caller should append port
4173 * information to the buffer with subsequent calls to
4174 * ofputil_put_switch_features_port(). */
4176 ofputil_encode_switch_features(const struct ofputil_switch_features
*features
,
4177 enum ofputil_protocol protocol
, ovs_be32 xid
)
4179 struct ofp_switch_features
*osf
;
4181 enum ofp_version version
;
4184 version
= ofputil_protocol_to_ofp_version(protocol
);
4187 raw
= OFPRAW_OFPT10_FEATURES_REPLY
;
4191 raw
= OFPRAW_OFPT11_FEATURES_REPLY
;
4196 raw
= OFPRAW_OFPT13_FEATURES_REPLY
;
4201 b
= ofpraw_alloc_xid(raw
, version
, xid
, 0);
4202 osf
= ofpbuf_put_zeros(b
, sizeof *osf
);
4203 osf
->datapath_id
= htonll(features
->datapath_id
);
4204 osf
->n_buffers
= htonl(features
->n_buffers
);
4205 osf
->n_tables
= features
->n_tables
;
4207 osf
->capabilities
= htonl(features
->capabilities
& OFPC_COMMON
);
4208 osf
->capabilities
= htonl(features
->capabilities
&
4209 ofputil_capabilities_mask(version
));
4212 if (features
->capabilities
& OFPUTIL_C_STP
) {
4213 osf
->capabilities
|= htonl(OFPC10_STP
);
4215 osf
->actions
= encode_action_bits(features
->actions
, of10_action_bits
);
4220 osf
->auxiliary_id
= features
->auxiliary_id
;
4224 if (features
->capabilities
& OFPUTIL_C_GROUP_STATS
) {
4225 osf
->capabilities
|= htonl(OFPC11_GROUP_STATS
);
4235 /* Encodes 'pp' into the format required by the switch_features message already
4236 * in 'b', which should have been returned by ofputil_encode_switch_features(),
4237 * and appends the encoded version to 'b'. */
4239 ofputil_put_switch_features_port(const struct ofputil_phy_port
*pp
,
4242 const struct ofp_header
*oh
= ofpbuf_data(b
);
4244 if (oh
->version
< OFP13_VERSION
) {
4245 /* Try adding a port description to the message, but drop it again if
4246 * the buffer overflows. (This possibility for overflow is why
4247 * OpenFlow 1.3+ moved port descriptions into a multipart message.) */
4248 size_t start_ofs
= ofpbuf_size(b
);
4249 ofputil_put_phy_port(oh
->version
, pp
, b
);
4250 if (ofpbuf_size(b
) > UINT16_MAX
) {
4251 ofpbuf_set_size(b
, start_ofs
);
4256 /* ofputil_port_status */
4258 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4259 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
4261 ofputil_decode_port_status(const struct ofp_header
*oh
,
4262 struct ofputil_port_status
*ps
)
4264 const struct ofp_port_status
*ops
;
4268 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4269 ofpraw_pull_assert(&b
);
4270 ops
= ofpbuf_pull(&b
, sizeof *ops
);
4272 if (ops
->reason
!= OFPPR_ADD
&&
4273 ops
->reason
!= OFPPR_DELETE
&&
4274 ops
->reason
!= OFPPR_MODIFY
) {
4275 return OFPERR_NXBRC_BAD_REASON
;
4277 ps
->reason
= ops
->reason
;
4279 retval
= ofputil_pull_phy_port(oh
->version
, &b
, &ps
->desc
);
4280 ovs_assert(retval
!= EOF
);
4284 /* Converts the abstract form of a "port status" message in '*ps' into an
4285 * OpenFlow message suitable for 'protocol', and returns that encoded form in
4286 * a buffer owned by the caller. */
4288 ofputil_encode_port_status(const struct ofputil_port_status
*ps
,
4289 enum ofputil_protocol protocol
)
4291 struct ofp_port_status
*ops
;
4293 enum ofp_version version
;
4296 version
= ofputil_protocol_to_ofp_version(protocol
);
4299 raw
= OFPRAW_OFPT10_PORT_STATUS
;
4305 raw
= OFPRAW_OFPT11_PORT_STATUS
;
4310 raw
= OFPRAW_OFPT14_PORT_STATUS
;
4317 b
= ofpraw_alloc_xid(raw
, version
, htonl(0), 0);
4318 ops
= ofpbuf_put_zeros(b
, sizeof *ops
);
4319 ops
->reason
= ps
->reason
;
4320 ofputil_put_phy_port(version
, &ps
->desc
, b
);
4321 ofpmsg_update_length(b
);
4325 /* ofputil_port_mod */
4328 parse_port_mod_ethernet_property(struct ofpbuf
*property
,
4329 struct ofputil_port_mod
*pm
)
4331 struct ofp14_port_mod_prop_ethernet
*eth
= ofpbuf_data(property
);
4333 if (ofpbuf_size(property
) != sizeof *eth
) {
4334 return OFPERR_OFPBRC_BAD_LEN
;
4337 pm
->advertise
= netdev_port_features_from_ofp11(eth
->advertise
);
4341 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4342 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4344 ofputil_decode_port_mod(const struct ofp_header
*oh
,
4345 struct ofputil_port_mod
*pm
, bool loose
)
4350 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4351 raw
= ofpraw_pull_assert(&b
);
4353 if (raw
== OFPRAW_OFPT10_PORT_MOD
) {
4354 const struct ofp10_port_mod
*opm
= ofpbuf_data(&b
);
4356 pm
->port_no
= u16_to_ofp(ntohs(opm
->port_no
));
4357 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4358 pm
->config
= ntohl(opm
->config
) & OFPPC10_ALL
;
4359 pm
->mask
= ntohl(opm
->mask
) & OFPPC10_ALL
;
4360 pm
->advertise
= netdev_port_features_from_ofp10(opm
->advertise
);
4361 } else if (raw
== OFPRAW_OFPT11_PORT_MOD
) {
4362 const struct ofp11_port_mod
*opm
= ofpbuf_data(&b
);
4365 error
= ofputil_port_from_ofp11(opm
->port_no
, &pm
->port_no
);
4370 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4371 pm
->config
= ntohl(opm
->config
) & OFPPC11_ALL
;
4372 pm
->mask
= ntohl(opm
->mask
) & OFPPC11_ALL
;
4373 pm
->advertise
= netdev_port_features_from_ofp11(opm
->advertise
);
4374 } else if (raw
== OFPRAW_OFPT14_PORT_MOD
) {
4375 const struct ofp14_port_mod
*opm
= ofpbuf_pull(&b
, sizeof *opm
);
4378 memset(pm
, 0, sizeof *pm
);
4380 error
= ofputil_port_from_ofp11(opm
->port_no
, &pm
->port_no
);
4385 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4386 pm
->config
= ntohl(opm
->config
) & OFPPC11_ALL
;
4387 pm
->mask
= ntohl(opm
->mask
) & OFPPC11_ALL
;
4389 while (ofpbuf_size(&b
) > 0) {
4390 struct ofpbuf property
;
4394 error
= ofputil_pull_property(&b
, &property
, &type
);
4400 case OFPPMPT14_ETHERNET
:
4401 error
= parse_port_mod_ethernet_property(&property
, pm
);
4405 log_property(loose
, "unknown port_mod property %"PRIu16
, type
);
4408 } else if (type
== OFPPMPT14_EXPERIMENTER
) {
4409 error
= OFPERR_OFPBPC_BAD_EXPERIMENTER
;
4411 error
= OFPERR_OFPBRC_BAD_TYPE
;
4421 return OFPERR_OFPBRC_BAD_TYPE
;
4424 pm
->config
&= pm
->mask
;
4428 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4429 * message suitable for 'protocol', and returns that encoded form in a buffer
4430 * owned by the caller. */
4432 ofputil_encode_port_mod(const struct ofputil_port_mod
*pm
,
4433 enum ofputil_protocol protocol
)
4435 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
4438 switch (ofp_version
) {
4439 case OFP10_VERSION
: {
4440 struct ofp10_port_mod
*opm
;
4442 b
= ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD
, ofp_version
, 0);
4443 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4444 opm
->port_no
= htons(ofp_to_u16(pm
->port_no
));
4445 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4446 opm
->config
= htonl(pm
->config
& OFPPC10_ALL
);
4447 opm
->mask
= htonl(pm
->mask
& OFPPC10_ALL
);
4448 opm
->advertise
= netdev_port_features_to_ofp10(pm
->advertise
);
4454 case OFP13_VERSION
: {
4455 struct ofp11_port_mod
*opm
;
4457 b
= ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD
, ofp_version
, 0);
4458 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4459 opm
->port_no
= ofputil_port_to_ofp11(pm
->port_no
);
4460 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4461 opm
->config
= htonl(pm
->config
& OFPPC11_ALL
);
4462 opm
->mask
= htonl(pm
->mask
& OFPPC11_ALL
);
4463 opm
->advertise
= netdev_port_features_to_ofp11(pm
->advertise
);
4467 case OFP15_VERSION
: {
4468 struct ofp14_port_mod_prop_ethernet
*eth
;
4469 struct ofp14_port_mod
*opm
;
4471 b
= ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD
, ofp_version
, sizeof *eth
);
4472 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4473 opm
->port_no
= ofputil_port_to_ofp11(pm
->port_no
);
4474 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4475 opm
->config
= htonl(pm
->config
& OFPPC11_ALL
);
4476 opm
->mask
= htonl(pm
->mask
& OFPPC11_ALL
);
4478 if (pm
->advertise
) {
4479 eth
= ofpbuf_put_zeros(b
, sizeof *eth
);
4480 eth
->type
= htons(OFPPMPT14_ETHERNET
);
4481 eth
->length
= htons(sizeof *eth
);
4482 eth
->advertise
= netdev_port_features_to_ofp11(pm
->advertise
);
4494 pull_table_feature_property(struct ofpbuf
*msg
, struct ofpbuf
*payload
,
4499 error
= ofputil_pull_property(msg
, payload
, typep
);
4500 if (payload
&& !error
) {
4501 ofpbuf_pull(payload
, sizeof(struct ofp_prop_header
));
4507 parse_table_ids(struct ofpbuf
*payload
, uint32_t *ids
)
4512 while (ofpbuf_size(payload
) > 0) {
4513 enum ofperr error
= pull_table_feature_property(payload
, NULL
, &type
);
4517 if (type
< CHAR_BIT
* sizeof *ids
) {
4525 parse_instruction_ids(struct ofpbuf
*payload
, bool loose
, uint32_t *insts
)
4528 while (ofpbuf_size(payload
) > 0) {
4529 enum ovs_instruction_type inst
;
4533 error
= pull_table_feature_property(payload
, NULL
, &ofpit
);
4538 error
= ovs_instruction_type_from_inst_type(&inst
, ofpit
);
4540 *insts
|= 1u << inst
;
4541 } else if (!loose
) {
4549 parse_table_features_next_table(struct ofpbuf
*payload
,
4550 unsigned long int *next_tables
)
4554 memset(next_tables
, 0, bitmap_n_bytes(255));
4555 for (i
= 0; i
< ofpbuf_size(payload
); i
++) {
4556 uint8_t id
= ((const uint8_t *) ofpbuf_data(payload
))[i
];
4558 return OFPERR_OFPBPC_BAD_VALUE
;
4560 bitmap_set1(next_tables
, id
);
4566 parse_oxm(struct ofpbuf
*b
, bool loose
,
4567 const struct mf_field
**fieldp
, bool *hasmask
)
4572 oxmp
= ofpbuf_try_pull(b
, sizeof *oxmp
);
4574 return OFPERR_OFPBPC_BAD_LEN
;
4578 /* Determine '*hasmask'. If 'oxm' is masked, convert it to the equivalent
4579 * unmasked version, because the table of OXM fields we support only has
4580 * masked versions of fields that we support with masks, but we should be
4581 * able to parse the masked versions of those here. */
4582 *hasmask
= NXM_HASMASK(oxm
);
4584 if (NXM_LENGTH(oxm
) & 1) {
4585 return OFPERR_OFPBPC_BAD_VALUE
;
4587 oxm
= NXM_HEADER(NXM_VENDOR(oxm
), NXM_FIELD(oxm
), NXM_LENGTH(oxm
) / 2);
4590 *fieldp
= mf_from_nxm_header(oxm
);
4592 log_property(loose
, "unknown OXM field %#"PRIx32
, ntohl(*oxmp
));
4594 return *fieldp
? 0 : OFPERR_OFPBMC_BAD_FIELD
;
4598 parse_oxms(struct ofpbuf
*payload
, bool loose
,
4599 struct mf_bitmap
*exactp
, struct mf_bitmap
*maskedp
)
4601 struct mf_bitmap exact
= MF_BITMAP_INITIALIZER
;
4602 struct mf_bitmap masked
= MF_BITMAP_INITIALIZER
;
4604 while (ofpbuf_size(payload
) > 0) {
4605 const struct mf_field
*field
;
4609 error
= parse_oxm(payload
, loose
, &field
, &hasmask
);
4611 bitmap_set1(hasmask
? masked
.bm
: exact
.bm
, field
->id
);
4612 } else if (error
!= OFPERR_OFPBMC_BAD_FIELD
|| !loose
) {
4618 } else if (!bitmap_is_all_zeros(exact
.bm
, MFF_N_IDS
)) {
4619 return OFPERR_OFPBMC_BAD_MASK
;
4623 } else if (!bitmap_is_all_zeros(masked
.bm
, MFF_N_IDS
)) {
4624 return OFPERR_OFPBMC_BAD_MASK
;
4629 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
4630 * ofputil_table_features in 'tf'.
4632 * If 'loose' is true, this function ignores properties and values that it does
4633 * not understand, as a controller would want to do when interpreting
4634 * capabilities provided by a switch. If 'loose' is false, this function
4635 * treats unknown properties and values as an error, as a switch would want to
4636 * do when interpreting a configuration request made by a controller.
4638 * A single OpenFlow message can specify features for multiple tables. Calling
4639 * this function multiple times for a single 'msg' iterates through the tables
4640 * in the message. The caller must initially leave 'msg''s layer pointers null
4641 * and not modify them between calls.
4643 * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
4644 * a positive "enum ofperr" value. */
4646 ofputil_decode_table_features(struct ofpbuf
*msg
,
4647 struct ofputil_table_features
*tf
, bool loose
)
4649 struct ofp13_table_features
*otf
;
4653 ofpraw_pull_assert(msg
);
4656 if (!ofpbuf_size(msg
)) {
4660 if (ofpbuf_size(msg
) < sizeof *otf
) {
4661 return OFPERR_OFPBPC_BAD_LEN
;
4664 otf
= ofpbuf_data(msg
);
4665 len
= ntohs(otf
->length
);
4666 if (len
< sizeof *otf
|| len
% 8 || len
> ofpbuf_size(msg
)) {
4667 return OFPERR_OFPBPC_BAD_LEN
;
4669 ofpbuf_pull(msg
, sizeof *otf
);
4671 tf
->table_id
= otf
->table_id
;
4672 if (tf
->table_id
== OFPTT_ALL
) {
4673 return OFPERR_OFPTFFC_BAD_TABLE
;
4676 ovs_strlcpy(tf
->name
, otf
->name
, OFP_MAX_TABLE_NAME_LEN
);
4677 tf
->metadata_match
= otf
->metadata_match
;
4678 tf
->metadata_write
= otf
->metadata_write
;
4679 tf
->config
= ntohl(otf
->config
);
4680 tf
->max_entries
= ntohl(otf
->max_entries
);
4682 while (ofpbuf_size(msg
) > 0) {
4683 struct ofpbuf payload
;
4687 error
= pull_table_feature_property(msg
, &payload
, &type
);
4692 switch ((enum ofp13_table_feature_prop_type
) type
) {
4693 case OFPTFPT13_INSTRUCTIONS
:
4694 error
= parse_instruction_ids(&payload
, loose
,
4695 &tf
->nonmiss
.instructions
);
4697 case OFPTFPT13_INSTRUCTIONS_MISS
:
4698 error
= parse_instruction_ids(&payload
, loose
,
4699 &tf
->miss
.instructions
);
4702 case OFPTFPT13_NEXT_TABLES
:
4703 error
= parse_table_features_next_table(&payload
,
4706 case OFPTFPT13_NEXT_TABLES_MISS
:
4707 error
= parse_table_features_next_table(&payload
, tf
->miss
.next
);
4710 case OFPTFPT13_WRITE_ACTIONS
:
4711 error
= parse_table_ids(&payload
, &tf
->nonmiss
.write
.actions
);
4713 case OFPTFPT13_WRITE_ACTIONS_MISS
:
4714 error
= parse_table_ids(&payload
, &tf
->miss
.write
.actions
);
4717 case OFPTFPT13_APPLY_ACTIONS
:
4718 error
= parse_table_ids(&payload
, &tf
->nonmiss
.apply
.actions
);
4720 case OFPTFPT13_APPLY_ACTIONS_MISS
:
4721 error
= parse_table_ids(&payload
, &tf
->miss
.apply
.actions
);
4724 case OFPTFPT13_MATCH
:
4725 error
= parse_oxms(&payload
, loose
, &tf
->match
, &tf
->mask
);
4727 case OFPTFPT13_WILDCARDS
:
4728 error
= parse_oxms(&payload
, loose
, &tf
->wildcard
, NULL
);
4731 case OFPTFPT13_WRITE_SETFIELD
:
4732 error
= parse_oxms(&payload
, loose
,
4733 &tf
->nonmiss
.write
.set_fields
, NULL
);
4735 case OFPTFPT13_WRITE_SETFIELD_MISS
:
4736 error
= parse_oxms(&payload
, loose
,
4737 &tf
->miss
.write
.set_fields
, NULL
);
4739 case OFPTFPT13_APPLY_SETFIELD
:
4740 error
= parse_oxms(&payload
, loose
,
4741 &tf
->nonmiss
.apply
.set_fields
, NULL
);
4743 case OFPTFPT13_APPLY_SETFIELD_MISS
:
4744 error
= parse_oxms(&payload
, loose
,
4745 &tf
->miss
.apply
.set_fields
, NULL
);
4748 case OFPTFPT13_EXPERIMENTER
:
4749 case OFPTFPT13_EXPERIMENTER_MISS
:
4751 log_property(loose
, "unknown table features property %"PRIu16
,
4753 error
= loose
? 0 : OFPERR_OFPBPC_BAD_TYPE
;
4761 /* Fix inconsistencies:
4763 * - Turn off 'mask' and 'wildcard' bits that are not in 'match',
4764 * because a field must be matchable to be masked or wildcarded.
4766 * - Turn on 'wildcard' bits that are set in 'mask', because a field
4767 * that is arbitrarily maskable can be wildcarded entirely. */
4768 bitmap_and(tf
->mask
.bm
, tf
->match
.bm
, MFF_N_IDS
);
4769 bitmap_and(tf
->wildcard
.bm
, tf
->match
.bm
, MFF_N_IDS
);
4771 bitmap_or(tf
->wildcard
.bm
, tf
->mask
.bm
, MFF_N_IDS
);
4776 /* Encodes and returns a request to obtain the table features of a switch.
4777 * The message is encoded for OpenFlow version 'ofp_version'. */
4779 ofputil_encode_table_features_request(enum ofp_version ofp_version
)
4781 struct ofpbuf
*request
= NULL
;
4783 switch (ofp_version
) {
4787 ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
4788 "(\'-O OpenFlow13\')");
4792 request
= ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST
,
4802 /* ofputil_table_mod */
4804 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
4805 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4807 ofputil_decode_table_mod(const struct ofp_header
*oh
,
4808 struct ofputil_table_mod
*pm
)
4813 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4814 raw
= ofpraw_pull_assert(&b
);
4816 if (raw
== OFPRAW_OFPT11_TABLE_MOD
) {
4817 const struct ofp11_table_mod
*otm
= ofpbuf_data(&b
);
4819 pm
->table_id
= otm
->table_id
;
4820 pm
->config
= ntohl(otm
->config
);
4821 } else if (raw
== OFPRAW_OFPT14_TABLE_MOD
) {
4822 const struct ofp14_table_mod
*otm
= ofpbuf_pull(&b
, sizeof *otm
);
4824 pm
->table_id
= otm
->table_id
;
4825 pm
->config
= ntohl(otm
->config
);
4826 /* We do not understand any properties yet, so we do not bother
4829 return OFPERR_OFPBRC_BAD_TYPE
;
4835 /* Converts the abstract form of a "table mod" message in '*pm' into an OpenFlow
4836 * message suitable for 'protocol', and returns that encoded form in a buffer
4837 * owned by the caller. */
4839 ofputil_encode_table_mod(const struct ofputil_table_mod
*pm
,
4840 enum ofputil_protocol protocol
)
4842 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
4845 switch (ofp_version
) {
4846 case OFP10_VERSION
: {
4847 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
4848 "(\'-O OpenFlow11\')");
4853 case OFP13_VERSION
: {
4854 struct ofp11_table_mod
*otm
;
4856 b
= ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD
, ofp_version
, 0);
4857 otm
= ofpbuf_put_zeros(b
, sizeof *otm
);
4858 otm
->table_id
= pm
->table_id
;
4859 otm
->config
= htonl(pm
->config
);
4863 case OFP15_VERSION
: {
4864 struct ofp14_table_mod
*otm
;
4866 b
= ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD
, ofp_version
, 0);
4867 otm
= ofpbuf_put_zeros(b
, sizeof *otm
);
4868 otm
->table_id
= pm
->table_id
;
4869 otm
->config
= htonl(pm
->config
);
4879 /* ofputil_role_request */
4881 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
4882 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
4883 * OFPERR_* value. */
4885 ofputil_decode_role_message(const struct ofp_header
*oh
,
4886 struct ofputil_role_request
*rr
)
4891 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4892 raw
= ofpraw_pull_assert(&b
);
4894 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
||
4895 raw
== OFPRAW_OFPT12_ROLE_REPLY
) {
4896 const struct ofp12_role_request
*orr
= ofpbuf_l3(&b
);
4898 if (orr
->role
!= htonl(OFPCR12_ROLE_NOCHANGE
) &&
4899 orr
->role
!= htonl(OFPCR12_ROLE_EQUAL
) &&
4900 orr
->role
!= htonl(OFPCR12_ROLE_MASTER
) &&
4901 orr
->role
!= htonl(OFPCR12_ROLE_SLAVE
)) {
4902 return OFPERR_OFPRRFC_BAD_ROLE
;
4905 rr
->role
= ntohl(orr
->role
);
4906 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
4907 ? orr
->role
== htonl(OFPCR12_ROLE_NOCHANGE
)
4908 : orr
->generation_id
== OVS_BE64_MAX
) {
4909 rr
->have_generation_id
= false;
4910 rr
->generation_id
= 0;
4912 rr
->have_generation_id
= true;
4913 rr
->generation_id
= ntohll(orr
->generation_id
);
4915 } else if (raw
== OFPRAW_NXT_ROLE_REQUEST
||
4916 raw
== OFPRAW_NXT_ROLE_REPLY
) {
4917 const struct nx_role_request
*nrr
= ofpbuf_l3(&b
);
4919 BUILD_ASSERT(NX_ROLE_OTHER
+ 1 == OFPCR12_ROLE_EQUAL
);
4920 BUILD_ASSERT(NX_ROLE_MASTER
+ 1 == OFPCR12_ROLE_MASTER
);
4921 BUILD_ASSERT(NX_ROLE_SLAVE
+ 1 == OFPCR12_ROLE_SLAVE
);
4923 if (nrr
->role
!= htonl(NX_ROLE_OTHER
) &&
4924 nrr
->role
!= htonl(NX_ROLE_MASTER
) &&
4925 nrr
->role
!= htonl(NX_ROLE_SLAVE
)) {
4926 return OFPERR_OFPRRFC_BAD_ROLE
;
4929 rr
->role
= ntohl(nrr
->role
) + 1;
4930 rr
->have_generation_id
= false;
4931 rr
->generation_id
= 0;
4939 /* Returns an encoded form of a role reply suitable for the "request" in a
4940 * buffer owned by the caller. */
4942 ofputil_encode_role_reply(const struct ofp_header
*request
,
4943 const struct ofputil_role_request
*rr
)
4948 raw
= ofpraw_decode_assert(request
);
4949 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
) {
4950 struct ofp12_role_request
*orr
;
4952 buf
= ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY
, request
, 0);
4953 orr
= ofpbuf_put_zeros(buf
, sizeof *orr
);
4955 orr
->role
= htonl(rr
->role
);
4956 orr
->generation_id
= htonll(rr
->have_generation_id
4959 } else if (raw
== OFPRAW_NXT_ROLE_REQUEST
) {
4960 struct nx_role_request
*nrr
;
4962 BUILD_ASSERT(NX_ROLE_OTHER
== OFPCR12_ROLE_EQUAL
- 1);
4963 BUILD_ASSERT(NX_ROLE_MASTER
== OFPCR12_ROLE_MASTER
- 1);
4964 BUILD_ASSERT(NX_ROLE_SLAVE
== OFPCR12_ROLE_SLAVE
- 1);
4966 buf
= ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY
, request
, 0);
4967 nrr
= ofpbuf_put_zeros(buf
, sizeof *nrr
);
4968 nrr
->role
= htonl(rr
->role
- 1);
4976 /* Encodes "role status" message 'status' for sending in the given
4977 * 'protocol'. Returns the role status message, if 'protocol' supports them,
4978 * otherwise a null pointer. */
4980 ofputil_encode_role_status(const struct ofputil_role_status
*status
,
4981 enum ofputil_protocol protocol
)
4983 enum ofp_version version
;
4985 version
= ofputil_protocol_to_ofp_version(protocol
);
4986 if (version
>= OFP14_VERSION
) {
4987 struct ofp14_role_status
*rstatus
;
4990 buf
= ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS
, version
, htonl(0),
4992 rstatus
= ofpbuf_put_zeros(buf
, sizeof *rstatus
);
4993 rstatus
->role
= htonl(status
->role
);
4994 rstatus
->reason
= status
->reason
;
4995 rstatus
->generation_id
= htonll(status
->generation_id
);
5004 ofputil_decode_role_status(const struct ofp_header
*oh
,
5005 struct ofputil_role_status
*rs
)
5009 const struct ofp14_role_status
*r
;
5011 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
5012 raw
= ofpraw_pull_assert(&b
);
5013 ovs_assert(raw
== OFPRAW_OFPT14_ROLE_STATUS
);
5016 if (r
->role
!= htonl(OFPCR12_ROLE_NOCHANGE
) &&
5017 r
->role
!= htonl(OFPCR12_ROLE_EQUAL
) &&
5018 r
->role
!= htonl(OFPCR12_ROLE_MASTER
) &&
5019 r
->role
!= htonl(OFPCR12_ROLE_SLAVE
)) {
5020 return OFPERR_OFPRRFC_BAD_ROLE
;
5023 rs
->role
= ntohl(r
->role
);
5024 rs
->generation_id
= ntohll(r
->generation_id
);
5025 rs
->reason
= r
->reason
;
5033 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats
*in
,
5037 enum ofp10_flow_wildcards wc10
;
5038 enum oxm12_ofb_match_fields mf12
;
5041 static const struct wc_map wc_map
[] = {
5042 { OFPFW10_IN_PORT
, OFPXMT12_OFB_IN_PORT
},
5043 { OFPFW10_DL_VLAN
, OFPXMT12_OFB_VLAN_VID
},
5044 { OFPFW10_DL_SRC
, OFPXMT12_OFB_ETH_SRC
},
5045 { OFPFW10_DL_DST
, OFPXMT12_OFB_ETH_DST
},
5046 { OFPFW10_DL_TYPE
, OFPXMT12_OFB_ETH_TYPE
},
5047 { OFPFW10_NW_PROTO
, OFPXMT12_OFB_IP_PROTO
},
5048 { OFPFW10_TP_SRC
, OFPXMT12_OFB_TCP_SRC
},
5049 { OFPFW10_TP_DST
, OFPXMT12_OFB_TCP_DST
},
5050 { OFPFW10_NW_SRC_MASK
, OFPXMT12_OFB_IPV4_SRC
},
5051 { OFPFW10_NW_DST_MASK
, OFPXMT12_OFB_IPV4_DST
},
5052 { OFPFW10_DL_VLAN_PCP
, OFPXMT12_OFB_VLAN_PCP
},
5053 { OFPFW10_NW_TOS
, OFPXMT12_OFB_IP_DSCP
},
5056 struct ofp10_table_stats
*out
;
5057 const struct wc_map
*p
;
5059 out
= ofpbuf_put_zeros(buf
, sizeof *out
);
5060 out
->table_id
= in
->table_id
;
5061 ovs_strlcpy(out
->name
, in
->name
, sizeof out
->name
);
5063 for (p
= wc_map
; p
< &wc_map
[ARRAY_SIZE(wc_map
)]; p
++) {
5064 if (in
->wildcards
& htonll(1ULL << p
->mf12
)) {
5065 out
->wildcards
|= htonl(p
->wc10
);
5068 out
->max_entries
= in
->max_entries
;
5069 out
->active_count
= in
->active_count
;
5070 put_32aligned_be64(&out
->lookup_count
, in
->lookup_count
);
5071 put_32aligned_be64(&out
->matched_count
, in
->matched_count
);
5075 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12
)
5078 enum ofp11_flow_match_fields fmf11
;
5079 enum oxm12_ofb_match_fields mf12
;
5082 static const struct map map
[] = {
5083 { OFPFMF11_IN_PORT
, OFPXMT12_OFB_IN_PORT
},
5084 { OFPFMF11_DL_VLAN
, OFPXMT12_OFB_VLAN_VID
},
5085 { OFPFMF11_DL_VLAN_PCP
, OFPXMT12_OFB_VLAN_PCP
},
5086 { OFPFMF11_DL_TYPE
, OFPXMT12_OFB_ETH_TYPE
},
5087 { OFPFMF11_NW_TOS
, OFPXMT12_OFB_IP_DSCP
},
5088 { OFPFMF11_NW_PROTO
, OFPXMT12_OFB_IP_PROTO
},
5089 { OFPFMF11_TP_SRC
, OFPXMT12_OFB_TCP_SRC
},
5090 { OFPFMF11_TP_DST
, OFPXMT12_OFB_TCP_DST
},
5091 { OFPFMF11_MPLS_LABEL
, OFPXMT12_OFB_MPLS_LABEL
},
5092 { OFPFMF11_MPLS_TC
, OFPXMT12_OFB_MPLS_TC
},
5093 /* I don't know what OFPFMF11_TYPE means. */
5094 { OFPFMF11_DL_SRC
, OFPXMT12_OFB_ETH_SRC
},
5095 { OFPFMF11_DL_DST
, OFPXMT12_OFB_ETH_DST
},
5096 { OFPFMF11_NW_SRC
, OFPXMT12_OFB_IPV4_SRC
},
5097 { OFPFMF11_NW_DST
, OFPXMT12_OFB_IPV4_DST
},
5098 { OFPFMF11_METADATA
, OFPXMT12_OFB_METADATA
},
5101 const struct map
*p
;
5105 for (p
= map
; p
< &map
[ARRAY_SIZE(map
)]; p
++) {
5106 if (oxm12
& htonll(1ULL << p
->mf12
)) {
5110 return htonl(fmf11
);
5114 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats
*in
,
5117 struct ofp11_table_stats
*out
;
5119 out
= ofpbuf_put_zeros(buf
, sizeof *out
);
5120 out
->table_id
= in
->table_id
;
5121 ovs_strlcpy(out
->name
, in
->name
, sizeof out
->name
);
5122 out
->wildcards
= oxm12_to_ofp11_flow_match_fields(in
->wildcards
);
5123 out
->match
= oxm12_to_ofp11_flow_match_fields(in
->match
);
5124 out
->instructions
= in
->instructions
;
5125 out
->write_actions
= in
->write_actions
;
5126 out
->apply_actions
= in
->apply_actions
;
5127 out
->config
= in
->config
;
5128 out
->max_entries
= in
->max_entries
;
5129 out
->active_count
= in
->active_count
;
5130 out
->lookup_count
= in
->lookup_count
;
5131 out
->matched_count
= in
->matched_count
;
5135 ofputil_put_ofp12_table_stats(const struct ofp12_table_stats
*in
,
5138 struct ofp12_table_stats
*out
= ofpbuf_put(buf
, in
, sizeof *in
);
5140 /* Trim off OF1.3-only capabilities. */
5141 out
->match
&= htonll(OFPXMT12_MASK
);
5142 out
->wildcards
&= htonll(OFPXMT12_MASK
);
5143 out
->write_setfields
&= htonll(OFPXMT12_MASK
);
5144 out
->apply_setfields
&= htonll(OFPXMT12_MASK
);
5148 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats
*in
,
5151 struct ofp13_table_stats
*out
;
5153 /* OF 1.3 splits table features off the ofp_table_stats,
5154 * so there is not much here. */
5156 out
= ofpbuf_put_uninit(buf
, sizeof *out
);
5157 out
->table_id
= in
->table_id
;
5158 out
->active_count
= in
->active_count
;
5159 out
->lookup_count
= in
->lookup_count
;
5160 out
->matched_count
= in
->matched_count
;
5164 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats
[], int n
,
5165 const struct ofp_header
*request
)
5167 struct ofpbuf
*reply
;
5170 reply
= ofpraw_alloc_stats_reply(request
, n
* sizeof *stats
);
5172 for (i
= 0; i
< n
; i
++) {
5173 switch ((enum ofp_version
) request
->version
) {
5175 ofputil_put_ofp10_table_stats(&stats
[i
], reply
);
5179 ofputil_put_ofp11_table_stats(&stats
[i
], reply
);
5183 ofputil_put_ofp12_table_stats(&stats
[i
], reply
);
5189 ofputil_put_ofp13_table_stats(&stats
[i
], reply
);
5200 /* ofputil_flow_monitor_request */
5202 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
5203 * ofputil_flow_monitor_request in 'rq'.
5205 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
5206 * message. Calling this function multiple times for a single 'msg' iterates
5207 * through the requests. The caller must initially leave 'msg''s layer
5208 * pointers null and not modify them between calls.
5210 * Returns 0 if successful, EOF if no requests were left in this 'msg',
5211 * otherwise an OFPERR_* value. */
5213 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request
*rq
,
5216 struct nx_flow_monitor_request
*nfmr
;
5220 ofpraw_pull_assert(msg
);
5223 if (!ofpbuf_size(msg
)) {
5227 nfmr
= ofpbuf_try_pull(msg
, sizeof *nfmr
);
5229 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR request has %"PRIu32
" "
5230 "leftover bytes at end", ofpbuf_size(msg
));
5231 return OFPERR_OFPBRC_BAD_LEN
;
5234 flags
= ntohs(nfmr
->flags
);
5235 if (!(flags
& (NXFMF_ADD
| NXFMF_DELETE
| NXFMF_MODIFY
))
5236 || flags
& ~(NXFMF_INITIAL
| NXFMF_ADD
| NXFMF_DELETE
5237 | NXFMF_MODIFY
| NXFMF_ACTIONS
| NXFMF_OWN
)) {
5238 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR has bad flags %#"PRIx16
,
5240 return OFPERR_OFPMOFC_BAD_FLAGS
;
5243 if (!is_all_zeros(nfmr
->zeros
, sizeof nfmr
->zeros
)) {
5244 return OFPERR_NXBRC_MUST_BE_ZERO
;
5247 rq
->id
= ntohl(nfmr
->id
);
5249 rq
->out_port
= u16_to_ofp(ntohs(nfmr
->out_port
));
5250 rq
->table_id
= nfmr
->table_id
;
5252 return nx_pull_match(msg
, ntohs(nfmr
->match_len
), &rq
->match
, NULL
, NULL
);
5256 ofputil_append_flow_monitor_request(
5257 const struct ofputil_flow_monitor_request
*rq
, struct ofpbuf
*msg
)
5259 struct nx_flow_monitor_request
*nfmr
;
5263 if (!ofpbuf_size(msg
)) {
5264 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST
, OFP10_VERSION
, msg
);
5267 start_ofs
= ofpbuf_size(msg
);
5268 ofpbuf_put_zeros(msg
, sizeof *nfmr
);
5269 match_len
= nx_put_match(msg
, &rq
->match
, htonll(0), htonll(0));
5271 nfmr
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfmr
);
5272 nfmr
->id
= htonl(rq
->id
);
5273 nfmr
->flags
= htons(rq
->flags
);
5274 nfmr
->out_port
= htons(ofp_to_u16(rq
->out_port
));
5275 nfmr
->match_len
= htons(match_len
);
5276 nfmr
->table_id
= rq
->table_id
;
5279 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
5280 * into an abstract ofputil_flow_update in 'update'. The caller must have
5281 * initialized update->match to point to space allocated for a match.
5283 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
5284 * actions (except for NXFME_ABBREV, which never includes actions). The caller
5285 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
5286 * will point into the 'ofpacts' buffer.
5288 * Multiple flow updates can be packed into a single OpenFlow message. Calling
5289 * this function multiple times for a single 'msg' iterates through the
5290 * updates. The caller must initially leave 'msg''s layer pointers null and
5291 * not modify them between calls.
5293 * Returns 0 if successful, EOF if no updates were left in this 'msg',
5294 * otherwise an OFPERR_* value. */
5296 ofputil_decode_flow_update(struct ofputil_flow_update
*update
,
5297 struct ofpbuf
*msg
, struct ofpbuf
*ofpacts
)
5299 struct nx_flow_update_header
*nfuh
;
5300 unsigned int length
;
5301 struct ofp_header
*oh
;
5304 ofpraw_pull_assert(msg
);
5307 if (!ofpbuf_size(msg
)) {
5311 if (ofpbuf_size(msg
) < sizeof(struct nx_flow_update_header
)) {
5317 nfuh
= ofpbuf_data(msg
);
5318 update
->event
= ntohs(nfuh
->event
);
5319 length
= ntohs(nfuh
->length
);
5320 if (length
> ofpbuf_size(msg
) || length
% 8) {
5324 if (update
->event
== NXFME_ABBREV
) {
5325 struct nx_flow_update_abbrev
*nfua
;
5327 if (length
!= sizeof *nfua
) {
5331 nfua
= ofpbuf_pull(msg
, sizeof *nfua
);
5332 update
->xid
= nfua
->xid
;
5334 } else if (update
->event
== NXFME_ADDED
5335 || update
->event
== NXFME_DELETED
5336 || update
->event
== NXFME_MODIFIED
) {
5337 struct nx_flow_update_full
*nfuf
;
5338 unsigned int actions_len
;
5339 unsigned int match_len
;
5342 if (length
< sizeof *nfuf
) {
5346 nfuf
= ofpbuf_pull(msg
, sizeof *nfuf
);
5347 match_len
= ntohs(nfuf
->match_len
);
5348 if (sizeof *nfuf
+ match_len
> length
) {
5352 update
->reason
= ntohs(nfuf
->reason
);
5353 update
->idle_timeout
= ntohs(nfuf
->idle_timeout
);
5354 update
->hard_timeout
= ntohs(nfuf
->hard_timeout
);
5355 update
->table_id
= nfuf
->table_id
;
5356 update
->cookie
= nfuf
->cookie
;
5357 update
->priority
= ntohs(nfuf
->priority
);
5359 error
= nx_pull_match(msg
, match_len
, update
->match
, NULL
, NULL
);
5364 actions_len
= length
- sizeof *nfuf
- ROUND_UP(match_len
, 8);
5365 error
= ofpacts_pull_openflow_actions(msg
, actions_len
, oh
->version
,
5371 update
->ofpacts
= ofpbuf_data(ofpacts
);
5372 update
->ofpacts_len
= ofpbuf_size(ofpacts
);
5375 VLOG_WARN_RL(&bad_ofmsg_rl
,
5376 "NXST_FLOW_MONITOR reply has bad event %"PRIu16
,
5377 ntohs(nfuh
->event
));
5378 return OFPERR_NXBRC_FM_BAD_EVENT
;
5382 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR reply has %"PRIu32
" "
5383 "leftover bytes at end", ofpbuf_size(msg
));
5384 return OFPERR_OFPBRC_BAD_LEN
;
5388 ofputil_decode_flow_monitor_cancel(const struct ofp_header
*oh
)
5390 const struct nx_flow_monitor_cancel
*cancel
= ofpmsg_body(oh
);
5392 return ntohl(cancel
->id
);
5396 ofputil_encode_flow_monitor_cancel(uint32_t id
)
5398 struct nx_flow_monitor_cancel
*nfmc
;
5401 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL
, OFP10_VERSION
, 0);
5402 nfmc
= ofpbuf_put_uninit(msg
, sizeof *nfmc
);
5403 nfmc
->id
= htonl(id
);
5408 ofputil_start_flow_update(struct list
*replies
)
5412 msg
= ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY
, OFP10_VERSION
,
5416 list_push_back(replies
, &msg
->list_node
);
5420 ofputil_append_flow_update(const struct ofputil_flow_update
*update
,
5421 struct list
*replies
)
5423 enum ofp_version version
= ofpmp_version(replies
);
5424 struct nx_flow_update_header
*nfuh
;
5428 msg
= ofpbuf_from_list(list_back(replies
));
5429 start_ofs
= ofpbuf_size(msg
);
5431 if (update
->event
== NXFME_ABBREV
) {
5432 struct nx_flow_update_abbrev
*nfua
;
5434 nfua
= ofpbuf_put_zeros(msg
, sizeof *nfua
);
5435 nfua
->xid
= update
->xid
;
5437 struct nx_flow_update_full
*nfuf
;
5440 ofpbuf_put_zeros(msg
, sizeof *nfuf
);
5441 match_len
= nx_put_match(msg
, update
->match
, htonll(0), htonll(0));
5442 ofpacts_put_openflow_actions(update
->ofpacts
, update
->ofpacts_len
, msg
,
5444 nfuf
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfuf
);
5445 nfuf
->reason
= htons(update
->reason
);
5446 nfuf
->priority
= htons(update
->priority
);
5447 nfuf
->idle_timeout
= htons(update
->idle_timeout
);
5448 nfuf
->hard_timeout
= htons(update
->hard_timeout
);
5449 nfuf
->match_len
= htons(match_len
);
5450 nfuf
->table_id
= update
->table_id
;
5451 nfuf
->cookie
= update
->cookie
;
5454 nfuh
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfuh
);
5455 nfuh
->length
= htons(ofpbuf_size(msg
) - start_ofs
);
5456 nfuh
->event
= htons(update
->event
);
5458 ofpmp_postappend(replies
, start_ofs
);
5462 ofputil_encode_packet_out(const struct ofputil_packet_out
*po
,
5463 enum ofputil_protocol protocol
)
5465 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
5469 size
= po
->ofpacts_len
;
5470 if (po
->buffer_id
== UINT32_MAX
) {
5471 size
+= po
->packet_len
;
5474 switch (ofp_version
) {
5475 case OFP10_VERSION
: {
5476 struct ofp10_packet_out
*opo
;
5479 msg
= ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT
, OFP10_VERSION
, size
);
5480 ofpbuf_put_zeros(msg
, sizeof *opo
);
5481 actions_ofs
= ofpbuf_size(msg
);
5482 ofpacts_put_openflow_actions(po
->ofpacts
, po
->ofpacts_len
, msg
,
5485 opo
= ofpbuf_l3(msg
);
5486 opo
->buffer_id
= htonl(po
->buffer_id
);
5487 opo
->in_port
= htons(ofp_to_u16(po
->in_port
));
5488 opo
->actions_len
= htons(ofpbuf_size(msg
) - actions_ofs
);
5496 case OFP15_VERSION
: {
5497 struct ofp11_packet_out
*opo
;
5500 msg
= ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT
, ofp_version
, size
);
5501 ofpbuf_put_zeros(msg
, sizeof *opo
);
5502 len
= ofpacts_put_openflow_actions(po
->ofpacts
, po
->ofpacts_len
, msg
,
5504 opo
= ofpbuf_l3(msg
);
5505 opo
->buffer_id
= htonl(po
->buffer_id
);
5506 opo
->in_port
= ofputil_port_to_ofp11(po
->in_port
);
5507 opo
->actions_len
= htons(len
);
5515 if (po
->buffer_id
== UINT32_MAX
) {
5516 ofpbuf_put(msg
, po
->packet
, po
->packet_len
);
5519 ofpmsg_update_length(msg
);
5524 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
5526 make_echo_request(enum ofp_version ofp_version
)
5528 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST
, ofp_version
,
5532 /* Creates and returns an OFPT_ECHO_REPLY message matching the
5533 * OFPT_ECHO_REQUEST message in 'rq'. */
5535 make_echo_reply(const struct ofp_header
*rq
)
5537 struct ofpbuf rq_buf
;
5538 struct ofpbuf
*reply
;
5540 ofpbuf_use_const(&rq_buf
, rq
, ntohs(rq
->length
));
5541 ofpraw_pull_assert(&rq_buf
);
5543 reply
= ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY
, rq
, ofpbuf_size(&rq_buf
));
5544 ofpbuf_put(reply
, ofpbuf_data(&rq_buf
), ofpbuf_size(&rq_buf
));
5549 ofputil_encode_barrier_request(enum ofp_version ofp_version
)
5553 switch (ofp_version
) {
5559 type
= OFPRAW_OFPT11_BARRIER_REQUEST
;
5563 type
= OFPRAW_OFPT10_BARRIER_REQUEST
;
5570 return ofpraw_alloc(type
, ofp_version
, 0);
5574 ofputil_frag_handling_to_string(enum ofp_config_flags flags
)
5576 switch (flags
& OFPC_FRAG_MASK
) {
5577 case OFPC_FRAG_NORMAL
: return "normal";
5578 case OFPC_FRAG_DROP
: return "drop";
5579 case OFPC_FRAG_REASM
: return "reassemble";
5580 case OFPC_FRAG_NX_MATCH
: return "nx-match";
5587 ofputil_frag_handling_from_string(const char *s
, enum ofp_config_flags
*flags
)
5589 if (!strcasecmp(s
, "normal")) {
5590 *flags
= OFPC_FRAG_NORMAL
;
5591 } else if (!strcasecmp(s
, "drop")) {
5592 *flags
= OFPC_FRAG_DROP
;
5593 } else if (!strcasecmp(s
, "reassemble")) {
5594 *flags
= OFPC_FRAG_REASM
;
5595 } else if (!strcasecmp(s
, "nx-match")) {
5596 *flags
= OFPC_FRAG_NX_MATCH
;
5603 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
5604 * port number and stores the latter in '*ofp10_port', for the purpose of
5605 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
5606 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
5608 * See the definition of OFP11_MAX for an explanation of the mapping. */
5610 ofputil_port_from_ofp11(ovs_be32 ofp11_port
, ofp_port_t
*ofp10_port
)
5612 uint32_t ofp11_port_h
= ntohl(ofp11_port
);
5614 if (ofp11_port_h
< ofp_to_u16(OFPP_MAX
)) {
5615 *ofp10_port
= u16_to_ofp(ofp11_port_h
);
5617 } else if (ofp11_port_h
>= ofp11_to_u32(OFPP11_MAX
)) {
5618 *ofp10_port
= u16_to_ofp(ofp11_port_h
- OFPP11_OFFSET
);
5621 *ofp10_port
= OFPP_NONE
;
5622 VLOG_WARN_RL(&bad_ofmsg_rl
, "port %"PRIu32
" is outside the supported "
5623 "range 0 through %d or 0x%"PRIx32
" through 0x%"PRIx32
,
5624 ofp11_port_h
, ofp_to_u16(OFPP_MAX
) - 1,
5625 ofp11_to_u32(OFPP11_MAX
), UINT32_MAX
);
5626 return OFPERR_OFPBAC_BAD_OUT_PORT
;
5630 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
5631 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
5633 * See the definition of OFP11_MAX for an explanation of the mapping. */
5635 ofputil_port_to_ofp11(ofp_port_t ofp10_port
)
5637 return htonl(ofp_to_u16(ofp10_port
) < ofp_to_u16(OFPP_MAX
)
5638 ? ofp_to_u16(ofp10_port
)
5639 : ofp_to_u16(ofp10_port
) + OFPP11_OFFSET
);
5642 #define OFPUTIL_NAMED_PORTS \
5643 OFPUTIL_NAMED_PORT(IN_PORT) \
5644 OFPUTIL_NAMED_PORT(TABLE) \
5645 OFPUTIL_NAMED_PORT(NORMAL) \
5646 OFPUTIL_NAMED_PORT(FLOOD) \
5647 OFPUTIL_NAMED_PORT(ALL) \
5648 OFPUTIL_NAMED_PORT(CONTROLLER) \
5649 OFPUTIL_NAMED_PORT(LOCAL) \
5650 OFPUTIL_NAMED_PORT(ANY)
5652 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
5653 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
5654 OFPUTIL_NAMED_PORTS \
5655 OFPUTIL_NAMED_PORT(NONE)
5657 /* Stores the port number represented by 's' into '*portp'. 's' may be an
5658 * integer or, for reserved ports, the standard OpenFlow name for the port
5661 * Returns true if successful, false if 's' is not a valid OpenFlow port number
5662 * or name. The caller should issue an error message in this case, because
5663 * this function usually does not. (This gives the caller an opportunity to
5664 * look up the port name another way, e.g. by contacting the switch and listing
5665 * the names of all its ports).
5667 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
5668 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
5669 * range as described in include/openflow/openflow-1.1.h. */
5671 ofputil_port_from_string(const char *s
, ofp_port_t
*portp
)
5673 unsigned int port32
; /* int is at least 32 bits wide. */
5676 VLOG_WARN("Negative value %s is not a valid port number.", s
);
5680 if (str_to_uint(s
, 10, &port32
)) {
5681 if (port32
< ofp_to_u16(OFPP_MAX
)) {
5683 } else if (port32
< ofp_to_u16(OFPP_FIRST_RESV
)) {
5684 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
5685 "be translated to %u when talking to an OF1.1 or "
5686 "later controller", port32
, port32
+ OFPP11_OFFSET
);
5687 } else if (port32
<= ofp_to_u16(OFPP_LAST_RESV
)) {
5688 char name
[OFP_MAX_PORT_NAME_LEN
];
5690 ofputil_port_to_string(u16_to_ofp(port32
), name
, sizeof name
);
5691 VLOG_WARN_ONCE("referring to port %s as %"PRIu32
" is deprecated "
5692 "for compatibility with OpenFlow 1.1 and later",
5694 } else if (port32
< ofp11_to_u32(OFPP11_MAX
)) {
5695 VLOG_WARN("port %u is outside the supported range 0 through "
5696 "%"PRIx16
" or 0x%x through 0x%"PRIx32
, port32
,
5697 UINT16_MAX
, ofp11_to_u32(OFPP11_MAX
), UINT32_MAX
);
5700 port32
-= OFPP11_OFFSET
;
5703 *portp
= u16_to_ofp(port32
);
5710 static const struct pair pairs
[] = {
5711 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
5712 OFPUTIL_NAMED_PORTS_WITH_NONE
5713 #undef OFPUTIL_NAMED_PORT
5715 const struct pair
*p
;
5717 for (p
= pairs
; p
< &pairs
[ARRAY_SIZE(pairs
)]; p
++) {
5718 if (!strcasecmp(s
, p
->name
)) {
5727 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
5728 * Most ports' string representation is just the port number, but for special
5729 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
5731 ofputil_format_port(ofp_port_t port
, struct ds
*s
)
5733 char name
[OFP_MAX_PORT_NAME_LEN
];
5735 ofputil_port_to_string(port
, name
, sizeof name
);
5736 ds_put_cstr(s
, name
);
5739 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5740 * representation of OpenFlow port number 'port'. Most ports are represented
5741 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
5742 * by name, e.g. "LOCAL". */
5744 ofputil_port_to_string(ofp_port_t port
,
5745 char namebuf
[OFP_MAX_PORT_NAME_LEN
], size_t bufsize
)
5748 #define OFPUTIL_NAMED_PORT(NAME) \
5750 ovs_strlcpy(namebuf, #NAME, bufsize); \
5753 #undef OFPUTIL_NAMED_PORT
5756 snprintf(namebuf
, bufsize
, "%"PRIu16
, port
);
5761 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
5762 * integer or, for reserved group IDs, the standard OpenFlow name for the group
5763 * (either "ANY" or "ALL").
5765 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
5768 ofputil_group_from_string(const char *s
, uint32_t *group_idp
)
5770 if (!strcasecmp(s
, "any")) {
5771 *group_idp
= OFPG11_ANY
;
5772 } else if (!strcasecmp(s
, "all")) {
5773 *group_idp
= OFPG11_ALL
;
5774 } else if (!str_to_uint(s
, 10, group_idp
)) {
5775 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
5776 "32-bit nonnegative integers or the keywords ANY or "
5784 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
5785 * Most groups' string representation is just the number, but for special
5786 * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */
5788 ofputil_format_group(uint32_t group_id
, struct ds
*s
)
5790 char name
[MAX_GROUP_NAME_LEN
];
5792 ofputil_group_to_string(group_id
, name
, sizeof name
);
5793 ds_put_cstr(s
, name
);
5797 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5798 * representation of OpenFlow group ID 'group_id'. Most group are represented
5799 * as just their number, but special groups, e.g. OFPG11_ALL, are represented
5800 * by name, e.g. "ALL". */
5802 ofputil_group_to_string(uint32_t group_id
,
5803 char namebuf
[MAX_GROUP_NAME_LEN
+ 1], size_t bufsize
)
5807 ovs_strlcpy(namebuf
, "ALL", bufsize
);
5811 ovs_strlcpy(namebuf
, "ANY", bufsize
);
5815 snprintf(namebuf
, bufsize
, "%"PRIu32
, group_id
);
5820 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5821 * 'ofp_version', tries to pull the first element from the array. If
5822 * successful, initializes '*pp' with an abstract representation of the
5823 * port and returns 0. If no ports remain to be decoded, returns EOF.
5824 * On an error, returns a positive OFPERR_* value. */
5826 ofputil_pull_phy_port(enum ofp_version ofp_version
, struct ofpbuf
*b
,
5827 struct ofputil_phy_port
*pp
)
5829 memset(pp
, 0, sizeof *pp
);
5831 switch (ofp_version
) {
5832 case OFP10_VERSION
: {
5833 const struct ofp10_phy_port
*opp
= ofpbuf_try_pull(b
, sizeof *opp
);
5834 return opp
? ofputil_decode_ofp10_phy_port(pp
, opp
) : EOF
;
5838 case OFP13_VERSION
: {
5839 const struct ofp11_port
*op
= ofpbuf_try_pull(b
, sizeof *op
);
5840 return op
? ofputil_decode_ofp11_port(pp
, op
) : EOF
;
5844 return ofpbuf_size(b
) ? ofputil_pull_ofp14_port(pp
, b
) : EOF
;
5850 /* ofp-util.def lists the mapping from names to action. */
5851 static const char *const names
[OFPUTIL_N_ACTIONS
] = {
5853 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
5854 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5855 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5856 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5857 #include "ofp-util.def"
5860 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
5861 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1
5862 * if 'name' is not the name of any action. */
5864 ofputil_action_code_from_name(const char *name
)
5866 const char *const *p
;
5868 for (p
= names
; p
< &names
[ARRAY_SIZE(names
)]; p
++) {
5869 if (*p
&& !strcasecmp(name
, *p
)) {
5876 /* Returns name corresponding to the 'enum ofputil_action_code',
5877 * or "Unkonwn action", if the name is not available. */
5879 ofputil_action_name_from_code(enum ofputil_action_code code
)
5881 return code
< (int)OFPUTIL_N_ACTIONS
&& names
[code
] ? names
[code
]
5885 enum ofputil_action_code
5886 ofputil_action_code_from_ofp13_action(enum ofp13_action_type type
)
5890 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5892 return OFPUTIL_##ENUM;
5893 #include "ofp-util.def"
5896 return OFPUTIL_ACTION_INVALID
;
5900 /* Appends an action of the type specified by 'code' to 'buf' and returns the
5901 * action. Initializes the parts of 'action' that identify it as having type
5902 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
5903 * have variable length, the length used and cleared is that of struct
5906 ofputil_put_action(enum ofputil_action_code code
, struct ofpbuf
*buf
)
5909 case OFPUTIL_ACTION_INVALID
:
5910 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
5911 #include "ofp-util.def"
5914 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5915 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5916 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5917 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5918 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5919 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5920 #include "ofp-util.def"
5925 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5927 ofputil_init_##ENUM(struct STRUCT *s) \
5929 memset(s, 0, sizeof *s); \
5930 s->type = htons(ENUM); \
5931 s->len = htons(sizeof *s); \
5935 ofputil_put_##ENUM(struct ofpbuf *buf) \
5937 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5938 ofputil_init_##ENUM(s); \
5941 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5942 OFPAT10_ACTION(ENUM, STRUCT, NAME)
5943 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5944 OFPAT10_ACTION(ENUM, STRUCT, NAME)
5945 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5947 ofputil_init_##ENUM(struct STRUCT *s) \
5949 memset(s, 0, sizeof *s); \
5950 s->type = htons(OFPAT10_VENDOR); \
5951 s->len = htons(sizeof *s); \
5952 s->vendor = htonl(NX_VENDOR_ID); \
5953 s->subtype = htons(ENUM); \
5957 ofputil_put_##ENUM(struct ofpbuf *buf) \
5959 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5960 ofputil_init_##ENUM(s); \
5963 #include "ofp-util.def"
5966 ofputil_normalize_match__(struct match
*match
, bool may_log
)
5969 MAY_NW_ADDR
= 1 << 0, /* nw_src, nw_dst */
5970 MAY_TP_ADDR
= 1 << 1, /* tp_src, tp_dst */
5971 MAY_NW_PROTO
= 1 << 2, /* nw_proto */
5972 MAY_IPVx
= 1 << 3, /* tos, frag, ttl */
5973 MAY_ARP_SHA
= 1 << 4, /* arp_sha */
5974 MAY_ARP_THA
= 1 << 5, /* arp_tha */
5975 MAY_IPV6
= 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
5976 MAY_ND_TARGET
= 1 << 7, /* nd_target */
5977 MAY_MPLS
= 1 << 8, /* mpls label and tc */
5980 struct flow_wildcards wc
;
5982 /* Figure out what fields may be matched. */
5983 if (match
->flow
.dl_type
== htons(ETH_TYPE_IP
)) {
5984 may_match
= MAY_NW_PROTO
| MAY_IPVx
| MAY_NW_ADDR
;
5985 if (match
->flow
.nw_proto
== IPPROTO_TCP
||
5986 match
->flow
.nw_proto
== IPPROTO_UDP
||
5987 match
->flow
.nw_proto
== IPPROTO_SCTP
||
5988 match
->flow
.nw_proto
== IPPROTO_ICMP
) {
5989 may_match
|= MAY_TP_ADDR
;
5991 } else if (match
->flow
.dl_type
== htons(ETH_TYPE_IPV6
)) {
5992 may_match
= MAY_NW_PROTO
| MAY_IPVx
| MAY_IPV6
;
5993 if (match
->flow
.nw_proto
== IPPROTO_TCP
||
5994 match
->flow
.nw_proto
== IPPROTO_UDP
||
5995 match
->flow
.nw_proto
== IPPROTO_SCTP
) {
5996 may_match
|= MAY_TP_ADDR
;
5997 } else if (match
->flow
.nw_proto
== IPPROTO_ICMPV6
) {
5998 may_match
|= MAY_TP_ADDR
;
5999 if (match
->flow
.tp_src
== htons(ND_NEIGHBOR_SOLICIT
)) {
6000 may_match
|= MAY_ND_TARGET
| MAY_ARP_SHA
;
6001 } else if (match
->flow
.tp_src
== htons(ND_NEIGHBOR_ADVERT
)) {
6002 may_match
|= MAY_ND_TARGET
| MAY_ARP_THA
;
6005 } else if (match
->flow
.dl_type
== htons(ETH_TYPE_ARP
) ||
6006 match
->flow
.dl_type
== htons(ETH_TYPE_RARP
)) {
6007 may_match
= MAY_NW_PROTO
| MAY_NW_ADDR
| MAY_ARP_SHA
| MAY_ARP_THA
;
6008 } else if (eth_type_mpls(match
->flow
.dl_type
)) {
6009 may_match
= MAY_MPLS
;
6014 /* Clear the fields that may not be matched. */
6016 if (!(may_match
& MAY_NW_ADDR
)) {
6017 wc
.masks
.nw_src
= wc
.masks
.nw_dst
= htonl(0);
6019 if (!(may_match
& MAY_TP_ADDR
)) {
6020 wc
.masks
.tp_src
= wc
.masks
.tp_dst
= htons(0);
6022 if (!(may_match
& MAY_NW_PROTO
)) {
6023 wc
.masks
.nw_proto
= 0;
6025 if (!(may_match
& MAY_IPVx
)) {
6026 wc
.masks
.nw_tos
= 0;
6027 wc
.masks
.nw_ttl
= 0;
6029 if (!(may_match
& MAY_ARP_SHA
)) {
6030 memset(wc
.masks
.arp_sha
, 0, ETH_ADDR_LEN
);
6032 if (!(may_match
& MAY_ARP_THA
)) {
6033 memset(wc
.masks
.arp_tha
, 0, ETH_ADDR_LEN
);
6035 if (!(may_match
& MAY_IPV6
)) {
6036 wc
.masks
.ipv6_src
= wc
.masks
.ipv6_dst
= in6addr_any
;
6037 wc
.masks
.ipv6_label
= htonl(0);
6039 if (!(may_match
& MAY_ND_TARGET
)) {
6040 wc
.masks
.nd_target
= in6addr_any
;
6042 if (!(may_match
& MAY_MPLS
)) {
6043 memset(wc
.masks
.mpls_lse
, 0, sizeof wc
.masks
.mpls_lse
);
6046 /* Log any changes. */
6047 if (!flow_wildcards_equal(&wc
, &match
->wc
)) {
6048 bool log
= may_log
&& !VLOG_DROP_INFO(&bad_ofmsg_rl
);
6049 char *pre
= log
? match_to_string(match
, OFP_DEFAULT_PRIORITY
) : NULL
;
6052 match_zero_wildcarded_fields(match
);
6055 char *post
= match_to_string(match
, OFP_DEFAULT_PRIORITY
);
6056 VLOG_INFO("normalization changed ofp_match, details:");
6057 VLOG_INFO(" pre: %s", pre
);
6058 VLOG_INFO("post: %s", post
);
6065 /* "Normalizes" the wildcards in 'match'. That means:
6067 * 1. If the type of level N is known, then only the valid fields for that
6068 * level may be specified. For example, ARP does not have a TOS field,
6069 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
6070 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
6071 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
6074 * 2. If the type of level N is not known (or not understood by Open
6075 * vSwitch), then no fields at all for that level may be specified. For
6076 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
6077 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
6080 * If this function changes 'match', it logs a rate-limited informational
6083 ofputil_normalize_match(struct match
*match
)
6085 ofputil_normalize_match__(match
, true);
6088 /* Same as ofputil_normalize_match() without the logging. Thus, this function
6089 * is suitable for a program's internal use, whereas ofputil_normalize_match()
6090 * sense for use on flows received from elsewhere (so that a bug in the program
6091 * that sent them can be reported and corrected). */
6093 ofputil_normalize_match_quiet(struct match
*match
)
6095 ofputil_normalize_match__(match
, false);
6098 /* Parses a key or a key-value pair from '*stringp'.
6100 * On success: Stores the key into '*keyp'. Stores the value, if present, into
6101 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
6102 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
6103 * are substrings of '*stringp' created by replacing some of its bytes by null
6104 * terminators. Returns true.
6106 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
6107 * NULL and returns false. */
6109 ofputil_parse_key_value(char **stringp
, char **keyp
, char **valuep
)
6111 char *pos
, *key
, *value
;
6115 pos
+= strspn(pos
, ", \t\r\n");
6117 *keyp
= *valuep
= NULL
;
6122 key_len
= strcspn(pos
, ":=(, \t\r\n");
6123 if (key
[key_len
] == ':' || key
[key_len
] == '=') {
6124 /* The value can be separated by a colon. */
6127 value
= key
+ key_len
+ 1;
6128 value_len
= strcspn(value
, ", \t\r\n");
6129 pos
= value
+ value_len
+ (value
[value_len
] != '\0');
6130 value
[value_len
] = '\0';
6131 } else if (key
[key_len
] == '(') {
6132 /* The value can be surrounded by balanced parentheses. The outermost
6133 * set of parentheses is removed. */
6137 value
= key
+ key_len
+ 1;
6138 for (value_len
= 0; level
> 0; value_len
++) {
6139 switch (value
[value_len
]) {
6153 value
[value_len
- 1] = '\0';
6154 pos
= value
+ value_len
;
6156 /* There might be no value at all. */
6157 value
= key
+ key_len
; /* Will become the empty string below. */
6158 pos
= key
+ key_len
+ (key
[key_len
] != '\0');
6160 key
[key_len
] = '\0';
6168 /* Encode a dump ports request for 'port', the encoded message
6169 * will be for Open Flow version 'ofp_version'. Returns message
6170 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6172 ofputil_encode_dump_ports_request(enum ofp_version ofp_version
, ofp_port_t port
)
6174 struct ofpbuf
*request
;
6176 switch (ofp_version
) {
6177 case OFP10_VERSION
: {
6178 struct ofp10_port_stats_request
*req
;
6179 request
= ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST
, ofp_version
, 0);
6180 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6181 req
->port_no
= htons(ofp_to_u16(port
));
6188 case OFP15_VERSION
: {
6189 struct ofp11_port_stats_request
*req
;
6190 request
= ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST
, ofp_version
, 0);
6191 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6192 req
->port_no
= ofputil_port_to_ofp11(port
);
6203 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats
*ops
,
6204 struct ofp10_port_stats
*ps10
)
6206 ps10
->port_no
= htons(ofp_to_u16(ops
->port_no
));
6207 memset(ps10
->pad
, 0, sizeof ps10
->pad
);
6208 put_32aligned_be64(&ps10
->rx_packets
, htonll(ops
->stats
.rx_packets
));
6209 put_32aligned_be64(&ps10
->tx_packets
, htonll(ops
->stats
.tx_packets
));
6210 put_32aligned_be64(&ps10
->rx_bytes
, htonll(ops
->stats
.rx_bytes
));
6211 put_32aligned_be64(&ps10
->tx_bytes
, htonll(ops
->stats
.tx_bytes
));
6212 put_32aligned_be64(&ps10
->rx_dropped
, htonll(ops
->stats
.rx_dropped
));
6213 put_32aligned_be64(&ps10
->tx_dropped
, htonll(ops
->stats
.tx_dropped
));
6214 put_32aligned_be64(&ps10
->rx_errors
, htonll(ops
->stats
.rx_errors
));
6215 put_32aligned_be64(&ps10
->tx_errors
, htonll(ops
->stats
.tx_errors
));
6216 put_32aligned_be64(&ps10
->rx_frame_err
, htonll(ops
->stats
.rx_frame_errors
));
6217 put_32aligned_be64(&ps10
->rx_over_err
, htonll(ops
->stats
.rx_over_errors
));
6218 put_32aligned_be64(&ps10
->rx_crc_err
, htonll(ops
->stats
.rx_crc_errors
));
6219 put_32aligned_be64(&ps10
->collisions
, htonll(ops
->stats
.collisions
));
6223 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats
*ops
,
6224 struct ofp11_port_stats
*ps11
)
6226 ps11
->port_no
= ofputil_port_to_ofp11(ops
->port_no
);
6227 memset(ps11
->pad
, 0, sizeof ps11
->pad
);
6228 ps11
->rx_packets
= htonll(ops
->stats
.rx_packets
);
6229 ps11
->tx_packets
= htonll(ops
->stats
.tx_packets
);
6230 ps11
->rx_bytes
= htonll(ops
->stats
.rx_bytes
);
6231 ps11
->tx_bytes
= htonll(ops
->stats
.tx_bytes
);
6232 ps11
->rx_dropped
= htonll(ops
->stats
.rx_dropped
);
6233 ps11
->tx_dropped
= htonll(ops
->stats
.tx_dropped
);
6234 ps11
->rx_errors
= htonll(ops
->stats
.rx_errors
);
6235 ps11
->tx_errors
= htonll(ops
->stats
.tx_errors
);
6236 ps11
->rx_frame_err
= htonll(ops
->stats
.rx_frame_errors
);
6237 ps11
->rx_over_err
= htonll(ops
->stats
.rx_over_errors
);
6238 ps11
->rx_crc_err
= htonll(ops
->stats
.rx_crc_errors
);
6239 ps11
->collisions
= htonll(ops
->stats
.collisions
);
6243 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats
*ops
,
6244 struct ofp13_port_stats
*ps13
)
6246 ofputil_port_stats_to_ofp11(ops
, &ps13
->ps
);
6247 ps13
->duration_sec
= htonl(ops
->duration_sec
);
6248 ps13
->duration_nsec
= htonl(ops
->duration_nsec
);
6252 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats
*ops
,
6253 struct list
*replies
)
6255 struct ofp14_port_stats_prop_ethernet
*eth
;
6256 struct ofp14_port_stats
*ps14
;
6257 struct ofpbuf
*reply
;
6259 reply
= ofpmp_reserve(replies
, sizeof *ps14
+ sizeof *eth
);
6261 ps14
= ofpbuf_put_uninit(reply
, sizeof *ps14
);
6262 ps14
->length
= htons(sizeof *ps14
+ sizeof *eth
);
6263 memset(ps14
->pad
, 0, sizeof ps14
->pad
);
6264 ps14
->port_no
= ofputil_port_to_ofp11(ops
->port_no
);
6265 ps14
->duration_sec
= htonl(ops
->duration_sec
);
6266 ps14
->duration_nsec
= htonl(ops
->duration_nsec
);
6267 ps14
->rx_packets
= htonll(ops
->stats
.rx_packets
);
6268 ps14
->tx_packets
= htonll(ops
->stats
.tx_packets
);
6269 ps14
->rx_bytes
= htonll(ops
->stats
.rx_bytes
);
6270 ps14
->tx_bytes
= htonll(ops
->stats
.tx_bytes
);
6271 ps14
->rx_dropped
= htonll(ops
->stats
.rx_dropped
);
6272 ps14
->tx_dropped
= htonll(ops
->stats
.tx_dropped
);
6273 ps14
->rx_errors
= htonll(ops
->stats
.rx_errors
);
6274 ps14
->tx_errors
= htonll(ops
->stats
.tx_errors
);
6276 eth
= ofpbuf_put_uninit(reply
, sizeof *eth
);
6277 eth
->type
= htons(OFPPSPT14_ETHERNET
);
6278 eth
->length
= htons(sizeof *eth
);
6279 memset(eth
->pad
, 0, sizeof eth
->pad
);
6280 eth
->rx_frame_err
= htonll(ops
->stats
.rx_frame_errors
);
6281 eth
->rx_over_err
= htonll(ops
->stats
.rx_over_errors
);
6282 eth
->rx_crc_err
= htonll(ops
->stats
.rx_crc_errors
);
6283 eth
->collisions
= htonll(ops
->stats
.collisions
);
6286 /* Encode a ports stat for 'ops' and append it to 'replies'. */
6288 ofputil_append_port_stat(struct list
*replies
,
6289 const struct ofputil_port_stats
*ops
)
6291 switch (ofpmp_version(replies
)) {
6292 case OFP13_VERSION
: {
6293 struct ofp13_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6294 ofputil_port_stats_to_ofp13(ops
, reply
);
6298 case OFP11_VERSION
: {
6299 struct ofp11_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6300 ofputil_port_stats_to_ofp11(ops
, reply
);
6304 case OFP10_VERSION
: {
6305 struct ofp10_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6306 ofputil_port_stats_to_ofp10(ops
, reply
);
6312 ofputil_append_ofp14_port_stats(ops
, replies
);
6321 ofputil_port_stats_from_ofp10(struct ofputil_port_stats
*ops
,
6322 const struct ofp10_port_stats
*ps10
)
6324 memset(ops
, 0, sizeof *ops
);
6326 ops
->port_no
= u16_to_ofp(ntohs(ps10
->port_no
));
6327 ops
->stats
.rx_packets
= ntohll(get_32aligned_be64(&ps10
->rx_packets
));
6328 ops
->stats
.tx_packets
= ntohll(get_32aligned_be64(&ps10
->tx_packets
));
6329 ops
->stats
.rx_bytes
= ntohll(get_32aligned_be64(&ps10
->rx_bytes
));
6330 ops
->stats
.tx_bytes
= ntohll(get_32aligned_be64(&ps10
->tx_bytes
));
6331 ops
->stats
.rx_dropped
= ntohll(get_32aligned_be64(&ps10
->rx_dropped
));
6332 ops
->stats
.tx_dropped
= ntohll(get_32aligned_be64(&ps10
->tx_dropped
));
6333 ops
->stats
.rx_errors
= ntohll(get_32aligned_be64(&ps10
->rx_errors
));
6334 ops
->stats
.tx_errors
= ntohll(get_32aligned_be64(&ps10
->tx_errors
));
6335 ops
->stats
.rx_frame_errors
=
6336 ntohll(get_32aligned_be64(&ps10
->rx_frame_err
));
6337 ops
->stats
.rx_over_errors
= ntohll(get_32aligned_be64(&ps10
->rx_over_err
));
6338 ops
->stats
.rx_crc_errors
= ntohll(get_32aligned_be64(&ps10
->rx_crc_err
));
6339 ops
->stats
.collisions
= ntohll(get_32aligned_be64(&ps10
->collisions
));
6340 ops
->duration_sec
= ops
->duration_nsec
= UINT32_MAX
;
6346 ofputil_port_stats_from_ofp11(struct ofputil_port_stats
*ops
,
6347 const struct ofp11_port_stats
*ps11
)
6351 memset(ops
, 0, sizeof *ops
);
6352 error
= ofputil_port_from_ofp11(ps11
->port_no
, &ops
->port_no
);
6357 ops
->stats
.rx_packets
= ntohll(ps11
->rx_packets
);
6358 ops
->stats
.tx_packets
= ntohll(ps11
->tx_packets
);
6359 ops
->stats
.rx_bytes
= ntohll(ps11
->rx_bytes
);
6360 ops
->stats
.tx_bytes
= ntohll(ps11
->tx_bytes
);
6361 ops
->stats
.rx_dropped
= ntohll(ps11
->rx_dropped
);
6362 ops
->stats
.tx_dropped
= ntohll(ps11
->tx_dropped
);
6363 ops
->stats
.rx_errors
= ntohll(ps11
->rx_errors
);
6364 ops
->stats
.tx_errors
= ntohll(ps11
->tx_errors
);
6365 ops
->stats
.rx_frame_errors
= ntohll(ps11
->rx_frame_err
);
6366 ops
->stats
.rx_over_errors
= ntohll(ps11
->rx_over_err
);
6367 ops
->stats
.rx_crc_errors
= ntohll(ps11
->rx_crc_err
);
6368 ops
->stats
.collisions
= ntohll(ps11
->collisions
);
6369 ops
->duration_sec
= ops
->duration_nsec
= UINT32_MAX
;
6375 ofputil_port_stats_from_ofp13(struct ofputil_port_stats
*ops
,
6376 const struct ofp13_port_stats
*ps13
)
6378 enum ofperr error
= ofputil_port_stats_from_ofp11(ops
, &ps13
->ps
);
6380 ops
->duration_sec
= ntohl(ps13
->duration_sec
);
6381 ops
->duration_nsec
= ntohl(ps13
->duration_nsec
);
6387 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf
*payload
,
6388 struct ofputil_port_stats
*ops
)
6390 const struct ofp14_port_stats_prop_ethernet
*eth
= ofpbuf_data(payload
);
6392 if (ofpbuf_size(payload
) != sizeof *eth
) {
6393 return OFPERR_OFPBPC_BAD_LEN
;
6396 ops
->stats
.rx_frame_errors
= ntohll(eth
->rx_frame_err
);
6397 ops
->stats
.rx_over_errors
= ntohll(eth
->rx_over_err
);
6398 ops
->stats
.rx_crc_errors
= ntohll(eth
->rx_crc_err
);
6399 ops
->stats
.collisions
= ntohll(eth
->collisions
);
6405 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats
*ops
,
6408 const struct ofp14_port_stats
*ps14
;
6409 struct ofpbuf properties
;
6413 ps14
= ofpbuf_try_pull(msg
, sizeof *ps14
);
6415 return OFPERR_OFPBRC_BAD_LEN
;
6418 len
= ntohs(ps14
->length
);
6419 if (len
< sizeof *ps14
|| len
- sizeof *ps14
> ofpbuf_size(msg
)) {
6420 return OFPERR_OFPBRC_BAD_LEN
;
6422 len
-= sizeof *ps14
;
6423 ofpbuf_use_const(&properties
, ofpbuf_pull(msg
, len
), len
);
6425 error
= ofputil_port_from_ofp11(ps14
->port_no
, &ops
->port_no
);
6430 ops
->duration_sec
= ntohl(ps14
->duration_sec
);
6431 ops
->duration_nsec
= ntohl(ps14
->duration_nsec
);
6432 ops
->stats
.rx_packets
= ntohll(ps14
->rx_packets
);
6433 ops
->stats
.tx_packets
= ntohll(ps14
->tx_packets
);
6434 ops
->stats
.rx_bytes
= ntohll(ps14
->rx_bytes
);
6435 ops
->stats
.tx_bytes
= ntohll(ps14
->tx_bytes
);
6436 ops
->stats
.rx_dropped
= ntohll(ps14
->rx_dropped
);
6437 ops
->stats
.tx_dropped
= ntohll(ps14
->tx_dropped
);
6438 ops
->stats
.rx_errors
= ntohll(ps14
->rx_errors
);
6439 ops
->stats
.tx_errors
= ntohll(ps14
->tx_errors
);
6440 ops
->stats
.rx_frame_errors
= UINT64_MAX
;
6441 ops
->stats
.rx_over_errors
= UINT64_MAX
;
6442 ops
->stats
.rx_crc_errors
= UINT64_MAX
;
6443 ops
->stats
.collisions
= UINT64_MAX
;
6445 while (ofpbuf_size(&properties
) > 0) {
6446 struct ofpbuf payload
;
6450 error
= ofputil_pull_property(&properties
, &payload
, &type
);
6456 case OFPPSPT14_ETHERNET
:
6457 error
= parse_ofp14_port_stats_ethernet_property(&payload
, ops
);
6461 log_property(true, "unknown port stats property %"PRIu16
, type
);
6474 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
6477 ofputil_count_port_stats(const struct ofp_header
*oh
)
6479 struct ofputil_port_stats ps
;
6483 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
6484 ofpraw_pull_assert(&b
);
6485 while (!ofputil_decode_port_stats(&ps
, &b
)) {
6491 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
6492 * ofputil_port_stats in 'ps'.
6494 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
6495 * message. Calling this function multiple times for a single 'msg' iterates
6496 * through the replies. The caller must initially leave 'msg''s layer pointers
6497 * null and not modify them between calls.
6499 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6500 * otherwise a positive errno value. */
6502 ofputil_decode_port_stats(struct ofputil_port_stats
*ps
, struct ofpbuf
*msg
)
6508 ? ofpraw_decode(&raw
, msg
->frame
)
6509 : ofpraw_pull(&raw
, msg
));
6514 if (!ofpbuf_size(msg
)) {
6516 } else if (raw
== OFPRAW_OFPST14_PORT_REPLY
) {
6517 return ofputil_pull_ofp14_port_stats(ps
, msg
);
6518 } else if (raw
== OFPRAW_OFPST13_PORT_REPLY
) {
6519 const struct ofp13_port_stats
*ps13
;
6521 ps13
= ofpbuf_try_pull(msg
, sizeof *ps13
);
6525 return ofputil_port_stats_from_ofp13(ps
, ps13
);
6526 } else if (raw
== OFPRAW_OFPST11_PORT_REPLY
) {
6527 const struct ofp11_port_stats
*ps11
;
6529 ps11
= ofpbuf_try_pull(msg
, sizeof *ps11
);
6533 return ofputil_port_stats_from_ofp11(ps
, ps11
);
6534 } else if (raw
== OFPRAW_OFPST10_PORT_REPLY
) {
6535 const struct ofp10_port_stats
*ps10
;
6537 ps10
= ofpbuf_try_pull(msg
, sizeof *ps10
);
6541 return ofputil_port_stats_from_ofp10(ps
, ps10
);
6547 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_PORT reply has %"PRIu32
" leftover "
6548 "bytes at end", ofpbuf_size(msg
));
6549 return OFPERR_OFPBRC_BAD_LEN
;
6552 /* Parse a port status request message into a 16 bit OpenFlow 1.0
6553 * port number and stores the latter in '*ofp10_port'.
6554 * Returns 0 if successful, otherwise an OFPERR_* number. */
6556 ofputil_decode_port_stats_request(const struct ofp_header
*request
,
6557 ofp_port_t
*ofp10_port
)
6559 switch ((enum ofp_version
)request
->version
) {
6564 case OFP11_VERSION
: {
6565 const struct ofp11_port_stats_request
*psr11
= ofpmsg_body(request
);
6566 return ofputil_port_from_ofp11(psr11
->port_no
, ofp10_port
);
6569 case OFP10_VERSION
: {
6570 const struct ofp10_port_stats_request
*psr10
= ofpmsg_body(request
);
6571 *ofp10_port
= u16_to_ofp(ntohs(psr10
->port_no
));
6580 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
6582 ofputil_bucket_list_destroy(struct list
*buckets
)
6584 struct ofputil_bucket
*bucket
, *next_bucket
;
6586 LIST_FOR_EACH_SAFE (bucket
, next_bucket
, list_node
, buckets
) {
6587 list_remove(&bucket
->list_node
);
6588 free(bucket
->ofpacts
);
6593 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
6594 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
6597 * Group statistics include packet and byte counts for each group. */
6599 ofputil_encode_group_stats_request(enum ofp_version ofp_version
,
6602 struct ofpbuf
*request
;
6604 switch (ofp_version
) {
6606 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
6607 "(\'-O OpenFlow11\')");
6612 case OFP15_VERSION
: {
6613 struct ofp11_group_stats_request
*req
;
6614 request
= ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST
, ofp_version
, 0);
6615 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6616 req
->group_id
= htonl(group_id
);
6626 /* Decodes the OpenFlow group description request in 'oh', returning the group
6627 * whose description is requested, or OFPG_ALL if stats for all groups was
6630 ofputil_decode_group_desc_request(const struct ofp_header
*oh
)
6632 struct ofpbuf request
;
6635 ofpbuf_use_const(&request
, oh
, ntohs(oh
->length
));
6636 raw
= ofpraw_pull_assert(&request
);
6637 if (raw
== OFPRAW_OFPST11_GROUP_DESC_REQUEST
) {
6639 } else if (raw
== OFPRAW_OFPST15_GROUP_DESC_REQUEST
) {
6640 ovs_be32
*group_id
= ofpbuf_pull(&request
, sizeof *group_id
);
6641 return ntohl(*group_id
);
6647 /* Returns an OpenFlow group description request for OpenFlow version
6648 * 'ofp_version', that requests stats for group 'group_id'. Use OFPG_ALL to
6649 * request stats for all groups (OpenFlow 1.4 and earlier always request all
6652 * Group descriptions include the bucket and action configuration for each
6655 ofputil_encode_group_desc_request(enum ofp_version ofp_version
,
6658 struct ofpbuf
*request
;
6661 switch (ofp_version
) {
6663 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
6664 "(\'-O OpenFlow11\')");
6669 request
= ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST
,
6673 request
= ofpraw_alloc(OFPRAW_OFPST15_GROUP_DESC_REQUEST
,
6675 gid
= htonl(group_id
);
6676 ofpbuf_put(request
, &gid
, sizeof gid
);
6686 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats
*gs
,
6687 struct ofp11_bucket_counter bucket_cnts
[])
6691 for (i
= 0; i
< gs
->n_buckets
; i
++) {
6692 bucket_cnts
[i
].packet_count
= htonll(gs
->bucket_stats
[i
].packet_count
);
6693 bucket_cnts
[i
].byte_count
= htonll(gs
->bucket_stats
[i
].byte_count
);
6698 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats
*gs
,
6699 struct ofp11_group_stats
*gs11
, size_t length
,
6700 struct ofp11_bucket_counter bucket_cnts
[])
6702 memset(gs11
, 0, sizeof *gs11
);
6703 gs11
->length
= htons(length
);
6704 gs11
->group_id
= htonl(gs
->group_id
);
6705 gs11
->ref_count
= htonl(gs
->ref_count
);
6706 gs11
->packet_count
= htonll(gs
->packet_count
);
6707 gs11
->byte_count
= htonll(gs
->byte_count
);
6708 ofputil_group_bucket_counters_to_ofp11(gs
, bucket_cnts
);
6712 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats
*gs
,
6713 struct ofp13_group_stats
*gs13
, size_t length
,
6714 struct ofp11_bucket_counter bucket_cnts
[])
6716 ofputil_group_stats_to_ofp11(gs
, &gs13
->gs
, length
, bucket_cnts
);
6717 gs13
->duration_sec
= htonl(gs
->duration_sec
);
6718 gs13
->duration_nsec
= htonl(gs
->duration_nsec
);
6722 /* Encodes 'gs' properly for the format of the list of group statistics
6723 * replies already begun in 'replies' and appends it to the list. 'replies'
6724 * must have originally been initialized with ofpmp_init(). */
6726 ofputil_append_group_stats(struct list
*replies
,
6727 const struct ofputil_group_stats
*gs
)
6729 size_t bucket_counter_size
;
6730 struct ofp11_bucket_counter
*bucket_counters
;
6733 bucket_counter_size
= gs
->n_buckets
* sizeof(struct ofp11_bucket_counter
);
6735 switch (ofpmp_version(replies
)) {
6737 case OFP12_VERSION
:{
6738 struct ofp11_group_stats
*gs11
;
6740 length
= sizeof *gs11
+ bucket_counter_size
;
6741 gs11
= ofpmp_append(replies
, length
);
6742 bucket_counters
= (struct ofp11_bucket_counter
*)(gs11
+ 1);
6743 ofputil_group_stats_to_ofp11(gs
, gs11
, length
, bucket_counters
);
6749 case OFP15_VERSION
: {
6750 struct ofp13_group_stats
*gs13
;
6752 length
= sizeof *gs13
+ bucket_counter_size
;
6753 gs13
= ofpmp_append(replies
, length
);
6754 bucket_counters
= (struct ofp11_bucket_counter
*)(gs13
+ 1);
6755 ofputil_group_stats_to_ofp13(gs
, gs13
, length
, bucket_counters
);
6764 /* Returns an OpenFlow group features request for OpenFlow version
6767 ofputil_encode_group_features_request(enum ofp_version ofp_version
)
6769 struct ofpbuf
*request
= NULL
;
6771 switch (ofp_version
) {
6774 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
6775 "(\'-O OpenFlow12\')");
6780 request
= ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST
,
6790 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
6791 * group features request 'request'. */
6793 ofputil_encode_group_features_reply(
6794 const struct ofputil_group_features
*features
,
6795 const struct ofp_header
*request
)
6797 struct ofp12_group_features_stats
*ogf
;
6798 struct ofpbuf
*reply
;
6800 reply
= ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY
,
6801 request
->version
, request
->xid
, 0);
6802 ogf
= ofpbuf_put_zeros(reply
, sizeof *ogf
);
6803 ogf
->types
= htonl(features
->types
);
6804 ogf
->capabilities
= htonl(features
->capabilities
);
6805 ogf
->max_groups
[0] = htonl(features
->max_groups
[0]);
6806 ogf
->max_groups
[1] = htonl(features
->max_groups
[1]);
6807 ogf
->max_groups
[2] = htonl(features
->max_groups
[2]);
6808 ogf
->max_groups
[3] = htonl(features
->max_groups
[3]);
6809 ogf
->actions
[0] = htonl(features
->actions
[0]);
6810 ogf
->actions
[1] = htonl(features
->actions
[1]);
6811 ogf
->actions
[2] = htonl(features
->actions
[2]);
6812 ogf
->actions
[3] = htonl(features
->actions
[3]);
6817 /* Decodes group features reply 'oh' into 'features'. */
6819 ofputil_decode_group_features_reply(const struct ofp_header
*oh
,
6820 struct ofputil_group_features
*features
)
6822 const struct ofp12_group_features_stats
*ogf
= ofpmsg_body(oh
);
6824 features
->types
= ntohl(ogf
->types
);
6825 features
->capabilities
= ntohl(ogf
->capabilities
);
6826 features
->max_groups
[0] = ntohl(ogf
->max_groups
[0]);
6827 features
->max_groups
[1] = ntohl(ogf
->max_groups
[1]);
6828 features
->max_groups
[2] = ntohl(ogf
->max_groups
[2]);
6829 features
->max_groups
[3] = ntohl(ogf
->max_groups
[3]);
6830 features
->actions
[0] = ntohl(ogf
->actions
[0]);
6831 features
->actions
[1] = ntohl(ogf
->actions
[1]);
6832 features
->actions
[2] = ntohl(ogf
->actions
[2]);
6833 features
->actions
[3] = ntohl(ogf
->actions
[3]);
6836 /* Parse a group status request message into a 32 bit OpenFlow 1.1
6837 * group ID and stores the latter in '*group_id'.
6838 * Returns 0 if successful, otherwise an OFPERR_* number. */
6840 ofputil_decode_group_stats_request(const struct ofp_header
*request
,
6843 const struct ofp11_group_stats_request
*gsr11
= ofpmsg_body(request
);
6844 *group_id
= ntohl(gsr11
->group_id
);
6848 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
6849 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
6850 * caller to eventually free.
6852 * Multiple group stats replies can be packed into a single OpenFlow message.
6853 * Calling this function multiple times for a single 'msg' iterates through the
6854 * replies. The caller must initially leave 'msg''s layer pointers null and
6855 * not modify them between calls.
6857 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6858 * otherwise a positive errno value. */
6860 ofputil_decode_group_stats_reply(struct ofpbuf
*msg
,
6861 struct ofputil_group_stats
*gs
)
6863 struct ofp11_bucket_counter
*obc
;
6864 struct ofp11_group_stats
*ogs11
;
6871 gs
->bucket_stats
= NULL
;
6873 ? ofpraw_decode(&raw
, msg
->frame
)
6874 : ofpraw_pull(&raw
, msg
));
6879 if (!ofpbuf_size(msg
)) {
6883 if (raw
== OFPRAW_OFPST11_GROUP_REPLY
) {
6884 base_len
= sizeof *ogs11
;
6885 ogs11
= ofpbuf_try_pull(msg
, sizeof *ogs11
);
6886 gs
->duration_sec
= gs
->duration_nsec
= UINT32_MAX
;
6887 } else if (raw
== OFPRAW_OFPST13_GROUP_REPLY
) {
6888 struct ofp13_group_stats
*ogs13
;
6890 base_len
= sizeof *ogs13
;
6891 ogs13
= ofpbuf_try_pull(msg
, sizeof *ogs13
);
6894 gs
->duration_sec
= ntohl(ogs13
->duration_sec
);
6895 gs
->duration_nsec
= ntohl(ogs13
->duration_nsec
);
6904 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply has %"PRIu32
" leftover bytes at end",
6905 ofpraw_get_name(raw
), ofpbuf_size(msg
));
6906 return OFPERR_OFPBRC_BAD_LEN
;
6908 length
= ntohs(ogs11
->length
);
6909 if (length
< sizeof base_len
) {
6910 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply claims invalid length %"PRIuSIZE
,
6911 ofpraw_get_name(raw
), length
);
6912 return OFPERR_OFPBRC_BAD_LEN
;
6915 gs
->group_id
= ntohl(ogs11
->group_id
);
6916 gs
->ref_count
= ntohl(ogs11
->ref_count
);
6917 gs
->packet_count
= ntohll(ogs11
->packet_count
);
6918 gs
->byte_count
= ntohll(ogs11
->byte_count
);
6920 gs
->n_buckets
= (length
- base_len
) / sizeof *obc
;
6921 obc
= ofpbuf_try_pull(msg
, gs
->n_buckets
* sizeof *obc
);
6923 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply has %"PRIu32
" leftover bytes at end",
6924 ofpraw_get_name(raw
), ofpbuf_size(msg
));
6925 return OFPERR_OFPBRC_BAD_LEN
;
6928 gs
->bucket_stats
= xmalloc(gs
->n_buckets
* sizeof *gs
->bucket_stats
);
6929 for (i
= 0; i
< gs
->n_buckets
; i
++) {
6930 gs
->bucket_stats
[i
].packet_count
= ntohll(obc
[i
].packet_count
);
6931 gs
->bucket_stats
[i
].byte_count
= ntohll(obc
[i
].byte_count
);
6937 /* Appends a group stats reply that contains the data in 'gds' to those already
6938 * present in the list of ofpbufs in 'replies'. 'replies' should have been
6939 * initialized with ofpmp_init(). */
6941 ofputil_append_group_desc_reply(const struct ofputil_group_desc
*gds
,
6942 struct list
*buckets
,
6943 struct list
*replies
)
6945 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
6946 enum ofp_version version
= ofpmp_version(replies
);
6947 struct ofp11_group_desc_stats
*ogds
;
6948 struct ofputil_bucket
*bucket
;
6951 start_ogds
= ofpbuf_size(reply
);
6952 ofpbuf_put_zeros(reply
, sizeof *ogds
);
6953 LIST_FOR_EACH (bucket
, list_node
, buckets
) {
6954 struct ofp11_bucket
*ob
;
6957 start_ob
= ofpbuf_size(reply
);
6958 ofpbuf_put_zeros(reply
, sizeof *ob
);
6959 ofpacts_put_openflow_actions(bucket
->ofpacts
, bucket
->ofpacts_len
,
6961 ob
= ofpbuf_at_assert(reply
, start_ob
, sizeof *ob
);
6962 ob
->len
= htons(ofpbuf_size(reply
) - start_ob
);
6963 ob
->weight
= htons(bucket
->weight
);
6964 ob
->watch_port
= ofputil_port_to_ofp11(bucket
->watch_port
);
6965 ob
->watch_group
= htonl(bucket
->watch_group
);
6967 ogds
= ofpbuf_at_assert(reply
, start_ogds
, sizeof *ogds
);
6968 ogds
->length
= htons(ofpbuf_size(reply
) - start_ogds
);
6969 ogds
->type
= gds
->type
;
6970 ogds
->group_id
= htonl(gds
->group_id
);
6972 ofpmp_postappend(replies
, start_ogds
);
6976 ofputil_pull_buckets(struct ofpbuf
*msg
, size_t buckets_length
,
6977 enum ofp_version version
, struct list
*buckets
)
6979 struct ofp11_bucket
*ob
;
6982 while (buckets_length
> 0) {
6983 struct ofputil_bucket
*bucket
;
6984 struct ofpbuf ofpacts
;
6988 ob
= (buckets_length
>= sizeof *ob
6989 ? ofpbuf_try_pull(msg
, sizeof *ob
)
6992 VLOG_WARN_RL(&bad_ofmsg_rl
, "buckets end with %"PRIuSIZE
" leftover bytes",
6994 return OFPERR_OFPGMFC_BAD_BUCKET
;
6997 ob_len
= ntohs(ob
->len
);
6998 if (ob_len
< sizeof *ob
) {
6999 VLOG_WARN_RL(&bad_ofmsg_rl
, "OpenFlow message bucket length "
7000 "%"PRIuSIZE
" is not valid", ob_len
);
7001 return OFPERR_OFPGMFC_BAD_BUCKET
;
7002 } else if (ob_len
> buckets_length
) {
7003 VLOG_WARN_RL(&bad_ofmsg_rl
, "OpenFlow message bucket length "
7004 "%"PRIuSIZE
" exceeds remaining buckets data size %"PRIuSIZE
,
7005 ob_len
, buckets_length
);
7006 return OFPERR_OFPGMFC_BAD_BUCKET
;
7008 buckets_length
-= ob_len
;
7010 ofpbuf_init(&ofpacts
, 0);
7011 error
= ofpacts_pull_openflow_actions(msg
, ob_len
- sizeof *ob
,
7014 ofpbuf_uninit(&ofpacts
);
7015 ofputil_bucket_list_destroy(buckets
);
7019 bucket
= xzalloc(sizeof *bucket
);
7020 bucket
->weight
= ntohs(ob
->weight
);
7021 error
= ofputil_port_from_ofp11(ob
->watch_port
, &bucket
->watch_port
);
7023 ofpbuf_uninit(&ofpacts
);
7024 ofputil_bucket_list_destroy(buckets
);
7025 return OFPERR_OFPGMFC_BAD_WATCH
;
7027 bucket
->watch_group
= ntohl(ob
->watch_group
);
7028 bucket
->ofpacts
= ofpbuf_steal_data(&ofpacts
);
7029 bucket
->ofpacts_len
= ofpbuf_size(&ofpacts
);
7030 list_push_back(buckets
, &bucket
->list_node
);
7036 /* Converts a group description reply in 'msg' into an abstract
7037 * ofputil_group_desc in 'gd'.
7039 * Multiple group description replies can be packed into a single OpenFlow
7040 * message. Calling this function multiple times for a single 'msg' iterates
7041 * through the replies. The caller must initially leave 'msg''s layer pointers
7042 * null and not modify them between calls.
7044 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7045 * otherwise a positive errno value. */
7047 ofputil_decode_group_desc_reply(struct ofputil_group_desc
*gd
,
7048 struct ofpbuf
*msg
, enum ofp_version version
)
7050 struct ofp11_group_desc_stats
*ogds
;
7054 ofpraw_pull_assert(msg
);
7057 if (!ofpbuf_size(msg
)) {
7061 ogds
= ofpbuf_try_pull(msg
, sizeof *ogds
);
7063 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST11_GROUP_DESC reply has %"PRIu32
" "
7064 "leftover bytes at end", ofpbuf_size(msg
));
7065 return OFPERR_OFPBRC_BAD_LEN
;
7067 gd
->type
= ogds
->type
;
7068 gd
->group_id
= ntohl(ogds
->group_id
);
7070 length
= ntohs(ogds
->length
);
7071 if (length
< sizeof *ogds
|| length
- sizeof *ogds
> ofpbuf_size(msg
)) {
7072 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST11_GROUP_DESC reply claims invalid "
7073 "length %"PRIuSIZE
, length
);
7074 return OFPERR_OFPBRC_BAD_LEN
;
7077 return ofputil_pull_buckets(msg
, length
- sizeof *ogds
, version
,
7081 /* Converts abstract group mod 'gm' into a message for OpenFlow version
7082 * 'ofp_version' and returns the message. */
7084 ofputil_encode_group_mod(enum ofp_version ofp_version
,
7085 const struct ofputil_group_mod
*gm
)
7088 struct ofp11_group_mod
*ogm
;
7090 size_t start_bucket
;
7091 struct ofputil_bucket
*bucket
;
7092 struct ofp11_bucket
*ob
;
7094 switch (ofp_version
) {
7095 case OFP10_VERSION
: {
7096 if (gm
->command
== OFPGC11_ADD
) {
7097 ovs_fatal(0, "add-group needs OpenFlow 1.1 or later "
7098 "(\'-O OpenFlow11\')");
7099 } else if (gm
->command
== OFPGC11_MODIFY
) {
7100 ovs_fatal(0, "mod-group needs OpenFlow 1.1 or later "
7101 "(\'-O OpenFlow11\')");
7103 ovs_fatal(0, "del-groups needs OpenFlow 1.1 or later "
7104 "(\'-O OpenFlow11\')");
7113 b
= ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD
, ofp_version
, 0);
7114 start_ogm
= ofpbuf_size(b
);
7115 ofpbuf_put_zeros(b
, sizeof *ogm
);
7117 LIST_FOR_EACH (bucket
, list_node
, &gm
->buckets
) {
7118 start_bucket
= ofpbuf_size(b
);
7119 ofpbuf_put_zeros(b
, sizeof *ob
);
7120 if (bucket
->ofpacts
&& bucket
->ofpacts_len
) {
7121 ofpacts_put_openflow_actions(bucket
->ofpacts
,
7122 bucket
->ofpacts_len
, b
,
7125 ob
= ofpbuf_at_assert(b
, start_bucket
, sizeof *ob
);
7126 ob
->len
= htons(ofpbuf_size(b
) - start_bucket
);;
7127 ob
->weight
= htons(bucket
->weight
);
7128 ob
->watch_port
= ofputil_port_to_ofp11(bucket
->watch_port
);
7129 ob
->watch_group
= htonl(bucket
->watch_group
);
7131 ogm
= ofpbuf_at_assert(b
, start_ogm
, sizeof *ogm
);
7132 ogm
->command
= htons(gm
->command
);
7133 ogm
->type
= gm
->type
;
7134 ogm
->group_id
= htonl(gm
->group_id
);
7145 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
7146 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
7148 ofputil_decode_group_mod(const struct ofp_header
*oh
,
7149 struct ofputil_group_mod
*gm
)
7151 const struct ofp11_group_mod
*ogm
;
7153 struct ofputil_bucket
*bucket
;
7156 ofpbuf_use_const(&msg
, oh
, ntohs(oh
->length
));
7157 ofpraw_pull_assert(&msg
);
7159 ogm
= ofpbuf_pull(&msg
, sizeof *ogm
);
7160 gm
->command
= ntohs(ogm
->command
);
7161 gm
->type
= ogm
->type
;
7162 gm
->group_id
= ntohl(ogm
->group_id
);
7164 err
= ofputil_pull_buckets(&msg
, ofpbuf_size(&msg
), oh
->version
, &gm
->buckets
);
7169 LIST_FOR_EACH (bucket
, list_node
, &gm
->buckets
) {
7172 case OFPGT11_INDIRECT
:
7173 if (ofputil_bucket_has_liveness(bucket
)) {
7174 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED
;
7177 case OFPGT11_SELECT
:
7180 if (!ofputil_bucket_has_liveness(bucket
)) {
7181 return OFPERR_OFPGMFC_INVALID_GROUP
;
7192 /* Parse a queue status request message into 'oqsr'.
7193 * Returns 0 if successful, otherwise an OFPERR_* number. */
7195 ofputil_decode_queue_stats_request(const struct ofp_header
*request
,
7196 struct ofputil_queue_stats_request
*oqsr
)
7198 switch ((enum ofp_version
)request
->version
) {
7203 case OFP11_VERSION
: {
7204 const struct ofp11_queue_stats_request
*qsr11
= ofpmsg_body(request
);
7205 oqsr
->queue_id
= ntohl(qsr11
->queue_id
);
7206 return ofputil_port_from_ofp11(qsr11
->port_no
, &oqsr
->port_no
);
7209 case OFP10_VERSION
: {
7210 const struct ofp10_queue_stats_request
*qsr10
= ofpmsg_body(request
);
7211 oqsr
->queue_id
= ntohl(qsr10
->queue_id
);
7212 oqsr
->port_no
= u16_to_ofp(ntohs(qsr10
->port_no
));
7213 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
7214 if (oqsr
->port_no
== OFPP_ALL
) {
7215 oqsr
->port_no
= OFPP_ANY
;
7225 /* Encode a queue statsrequest for 'oqsr', the encoded message
7226 * will be fore Open Flow version 'ofp_version'. Returns message
7227 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
7229 ofputil_encode_queue_stats_request(enum ofp_version ofp_version
,
7230 const struct ofputil_queue_stats_request
*oqsr
)
7232 struct ofpbuf
*request
;
7234 switch (ofp_version
) {
7239 case OFP15_VERSION
: {
7240 struct ofp11_queue_stats_request
*req
;
7241 request
= ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST
, ofp_version
, 0);
7242 req
= ofpbuf_put_zeros(request
, sizeof *req
);
7243 req
->port_no
= ofputil_port_to_ofp11(oqsr
->port_no
);
7244 req
->queue_id
= htonl(oqsr
->queue_id
);
7247 case OFP10_VERSION
: {
7248 struct ofp10_queue_stats_request
*req
;
7249 request
= ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST
, ofp_version
, 0);
7250 req
= ofpbuf_put_zeros(request
, sizeof *req
);
7251 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
7252 req
->port_no
= htons(ofp_to_u16(oqsr
->port_no
== OFPP_ANY
7253 ? OFPP_ALL
: oqsr
->port_no
));
7254 req
->queue_id
= htonl(oqsr
->queue_id
);
7264 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
7267 ofputil_count_queue_stats(const struct ofp_header
*oh
)
7269 struct ofputil_queue_stats qs
;
7273 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7274 ofpraw_pull_assert(&b
);
7275 while (!ofputil_decode_queue_stats(&qs
, &b
)) {
7282 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats
*oqs
,
7283 const struct ofp10_queue_stats
*qs10
)
7285 oqs
->port_no
= u16_to_ofp(ntohs(qs10
->port_no
));
7286 oqs
->queue_id
= ntohl(qs10
->queue_id
);
7287 oqs
->tx_bytes
= ntohll(get_32aligned_be64(&qs10
->tx_bytes
));
7288 oqs
->tx_packets
= ntohll(get_32aligned_be64(&qs10
->tx_packets
));
7289 oqs
->tx_errors
= ntohll(get_32aligned_be64(&qs10
->tx_errors
));
7290 oqs
->duration_sec
= oqs
->duration_nsec
= UINT32_MAX
;
7296 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats
*oqs
,
7297 const struct ofp11_queue_stats
*qs11
)
7301 error
= ofputil_port_from_ofp11(qs11
->port_no
, &oqs
->port_no
);
7306 oqs
->queue_id
= ntohl(qs11
->queue_id
);
7307 oqs
->tx_bytes
= ntohll(qs11
->tx_bytes
);
7308 oqs
->tx_packets
= ntohll(qs11
->tx_packets
);
7309 oqs
->tx_errors
= ntohll(qs11
->tx_errors
);
7310 oqs
->duration_sec
= oqs
->duration_nsec
= UINT32_MAX
;
7316 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats
*oqs
,
7317 const struct ofp13_queue_stats
*qs13
)
7319 enum ofperr error
= ofputil_queue_stats_from_ofp11(oqs
, &qs13
->qs
);
7321 oqs
->duration_sec
= ntohl(qs13
->duration_sec
);
7322 oqs
->duration_nsec
= ntohl(qs13
->duration_nsec
);
7329 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats
*oqs
,
7332 const struct ofp14_queue_stats
*qs14
;
7335 qs14
= ofpbuf_try_pull(msg
, sizeof *qs14
);
7337 return OFPERR_OFPBRC_BAD_LEN
;
7340 len
= ntohs(qs14
->length
);
7341 if (len
< sizeof *qs14
|| len
- sizeof *qs14
> ofpbuf_size(msg
)) {
7342 return OFPERR_OFPBRC_BAD_LEN
;
7344 ofpbuf_pull(msg
, len
- sizeof *qs14
);
7346 /* No properties yet defined, so ignore them for now. */
7348 return ofputil_queue_stats_from_ofp13(oqs
, &qs14
->qs
);
7351 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
7352 * ofputil_queue_stats in 'qs'.
7354 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
7355 * message. Calling this function multiple times for a single 'msg' iterates
7356 * through the replies. The caller must initially leave 'msg''s layer pointers
7357 * null and not modify them between calls.
7359 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7360 * otherwise a positive errno value. */
7362 ofputil_decode_queue_stats(struct ofputil_queue_stats
*qs
, struct ofpbuf
*msg
)
7368 ? ofpraw_decode(&raw
, msg
->frame
)
7369 : ofpraw_pull(&raw
, msg
));
7374 if (!ofpbuf_size(msg
)) {
7376 } else if (raw
== OFPRAW_OFPST14_QUEUE_REPLY
) {
7377 return ofputil_pull_ofp14_queue_stats(qs
, msg
);
7378 } else if (raw
== OFPRAW_OFPST13_QUEUE_REPLY
) {
7379 const struct ofp13_queue_stats
*qs13
;
7381 qs13
= ofpbuf_try_pull(msg
, sizeof *qs13
);
7385 return ofputil_queue_stats_from_ofp13(qs
, qs13
);
7386 } else if (raw
== OFPRAW_OFPST11_QUEUE_REPLY
) {
7387 const struct ofp11_queue_stats
*qs11
;
7389 qs11
= ofpbuf_try_pull(msg
, sizeof *qs11
);
7393 return ofputil_queue_stats_from_ofp11(qs
, qs11
);
7394 } else if (raw
== OFPRAW_OFPST10_QUEUE_REPLY
) {
7395 const struct ofp10_queue_stats
*qs10
;
7397 qs10
= ofpbuf_try_pull(msg
, sizeof *qs10
);
7401 return ofputil_queue_stats_from_ofp10(qs
, qs10
);
7407 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_QUEUE reply has %"PRIu32
" leftover "
7408 "bytes at end", ofpbuf_size(msg
));
7409 return OFPERR_OFPBRC_BAD_LEN
;
7413 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats
*oqs
,
7414 struct ofp10_queue_stats
*qs10
)
7416 qs10
->port_no
= htons(ofp_to_u16(oqs
->port_no
));
7417 memset(qs10
->pad
, 0, sizeof qs10
->pad
);
7418 qs10
->queue_id
= htonl(oqs
->queue_id
);
7419 put_32aligned_be64(&qs10
->tx_bytes
, htonll(oqs
->tx_bytes
));
7420 put_32aligned_be64(&qs10
->tx_packets
, htonll(oqs
->tx_packets
));
7421 put_32aligned_be64(&qs10
->tx_errors
, htonll(oqs
->tx_errors
));
7425 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats
*oqs
,
7426 struct ofp11_queue_stats
*qs11
)
7428 qs11
->port_no
= ofputil_port_to_ofp11(oqs
->port_no
);
7429 qs11
->queue_id
= htonl(oqs
->queue_id
);
7430 qs11
->tx_bytes
= htonll(oqs
->tx_bytes
);
7431 qs11
->tx_packets
= htonll(oqs
->tx_packets
);
7432 qs11
->tx_errors
= htonll(oqs
->tx_errors
);
7436 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats
*oqs
,
7437 struct ofp13_queue_stats
*qs13
)
7439 ofputil_queue_stats_to_ofp11(oqs
, &qs13
->qs
);
7440 if (oqs
->duration_sec
!= UINT32_MAX
) {
7441 qs13
->duration_sec
= htonl(oqs
->duration_sec
);
7442 qs13
->duration_nsec
= htonl(oqs
->duration_nsec
);
7444 qs13
->duration_sec
= OVS_BE32_MAX
;
7445 qs13
->duration_nsec
= OVS_BE32_MAX
;
7450 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats
*oqs
,
7451 struct ofp14_queue_stats
*qs14
)
7453 qs14
->length
= htons(sizeof *qs14
);
7454 memset(qs14
->pad
, 0, sizeof qs14
->pad
);
7455 ofputil_queue_stats_to_ofp13(oqs
, &qs14
->qs
);
7459 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
7461 ofputil_append_queue_stat(struct list
*replies
,
7462 const struct ofputil_queue_stats
*oqs
)
7464 switch (ofpmp_version(replies
)) {
7465 case OFP13_VERSION
: {
7466 struct ofp13_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7467 ofputil_queue_stats_to_ofp13(oqs
, reply
);
7472 case OFP11_VERSION
: {
7473 struct ofp11_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7474 ofputil_queue_stats_to_ofp11(oqs
, reply
);
7478 case OFP10_VERSION
: {
7479 struct ofp10_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7480 ofputil_queue_stats_to_ofp10(oqs
, reply
);
7485 case OFP15_VERSION
: {
7486 struct ofp14_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7487 ofputil_queue_stats_to_ofp14(oqs
, reply
);
7497 ofputil_decode_bundle_ctrl(const struct ofp_header
*oh
,
7498 struct ofputil_bundle_ctrl_msg
*msg
)
7502 const struct ofp14_bundle_ctrl_msg
*m
;
7504 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7505 raw
= ofpraw_pull_assert(&b
);
7506 ovs_assert(raw
== OFPRAW_OFPT14_BUNDLE_CONTROL
);
7509 msg
->bundle_id
= ntohl(m
->bundle_id
);
7510 msg
->type
= ntohs(m
->type
);
7511 msg
->flags
= ntohs(m
->flags
);
7517 ofputil_encode_bundle_ctrl_reply(const struct ofp_header
*oh
,
7518 struct ofputil_bundle_ctrl_msg
*msg
)
7521 struct ofp14_bundle_ctrl_msg
*m
;
7523 buf
= ofpraw_alloc_reply(OFPRAW_OFPT14_BUNDLE_CONTROL
, oh
, 0);
7524 m
= ofpbuf_put_zeros(buf
, sizeof *m
);
7526 m
->bundle_id
= htonl(msg
->bundle_id
);
7527 m
->type
= htons(msg
->type
);
7528 m
->flags
= htons(msg
->flags
);
7534 ofputil_decode_bundle_add(const struct ofp_header
*oh
,
7535 struct ofputil_bundle_add_msg
*msg
)
7537 const struct ofp14_bundle_ctrl_msg
*m
;
7542 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7543 raw
= ofpraw_pull_assert(&b
);
7544 ovs_assert(raw
== OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
);
7546 m
= ofpbuf_pull(&b
, sizeof *m
);
7547 msg
->bundle_id
= ntohl(m
->bundle_id
);
7548 msg
->flags
= ntohs(m
->flags
);
7550 msg
->msg
= ofpbuf_data(&b
);
7551 inner_len
= ntohs(msg
->msg
->length
);
7552 if (inner_len
< sizeof(struct ofp_header
) || inner_len
> ofpbuf_size(&b
)) {
7553 return OFPERR_OFPBFC_MSG_BAD_LEN
;
7560 ofputil_encode_bundle_add(enum ofp_version ofp_version
,
7561 struct ofputil_bundle_add_msg
*msg
)
7563 struct ofpbuf
*request
;
7564 struct ofp14_bundle_ctrl_msg
*m
;
7566 request
= ofpraw_alloc(OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
, ofp_version
, 0);
7567 m
= ofpbuf_put_zeros(request
, sizeof *m
);
7569 m
->bundle_id
= htonl(msg
->bundle_id
);
7570 m
->flags
= htons(msg
->flags
);
7571 ofpbuf_put(request
, msg
->msg
, ntohs(msg
->msg
->length
));