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
== 26);
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 return NXM_TYPICAL_LEN
;
632 /* Appends to 'b' an struct ofp11_match_header followed by a match that
633 * expresses 'match' properly for 'protocol', plus enough zero bytes to pad the
634 * data appended out to a multiple of 8. 'protocol' must be one that is usable
635 * in OpenFlow 1.1 or later.
637 * This function can cause 'b''s data to be reallocated.
639 * Returns the number of bytes appended to 'b', excluding the padding. Never
642 ofputil_put_ofp11_match(struct ofpbuf
*b
, const struct match
*match
,
643 enum ofputil_protocol protocol
)
646 case OFPUTIL_P_OF10_STD
:
647 case OFPUTIL_P_OF10_STD_TID
:
648 case OFPUTIL_P_OF10_NXM
:
649 case OFPUTIL_P_OF10_NXM_TID
:
652 case OFPUTIL_P_OF11_STD
: {
653 struct ofp11_match
*om
;
655 /* Make sure that no padding is needed. */
656 BUILD_ASSERT_DECL(sizeof *om
% 8 == 0);
658 om
= ofpbuf_put_uninit(b
, sizeof *om
);
659 ofputil_match_to_ofp11_match(match
, om
);
663 case OFPUTIL_P_OF12_OXM
:
664 case OFPUTIL_P_OF13_OXM
:
665 case OFPUTIL_P_OF14_OXM
:
666 return oxm_put_match(b
, match
);
672 /* Given a 'dl_type' value in the format used in struct flow, returns the
673 * corresponding 'dl_type' value for use in an ofp10_match or ofp11_match
676 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type
)
678 return (flow_dl_type
== htons(FLOW_DL_TYPE_NONE
)
679 ? htons(OFP_DL_TYPE_NOT_ETH_TYPE
)
683 /* Given a 'dl_type' value in the format used in an ofp10_match or ofp11_match
684 * structure, returns the corresponding 'dl_type' value for use in struct
687 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type
)
689 return (ofp_dl_type
== htons(OFP_DL_TYPE_NOT_ETH_TYPE
)
690 ? htons(FLOW_DL_TYPE_NONE
)
696 struct proto_abbrev
{
697 enum ofputil_protocol protocol
;
701 /* Most users really don't care about some of the differences between
702 * protocols. These abbreviations help with that.
704 * Until it is safe to use the OpenFlow 1.4 protocol (which currently can
705 * cause aborts due to unimplemented features), we omit OpenFlow 1.4 from all
707 static const struct proto_abbrev proto_abbrevs
[] = {
708 { OFPUTIL_P_ANY
& ~OFPUTIL_P_OF14_OXM
, "any" },
709 { OFPUTIL_P_OF10_STD_ANY
& ~OFPUTIL_P_OF14_OXM
, "OpenFlow10" },
710 { OFPUTIL_P_OF10_NXM_ANY
& ~OFPUTIL_P_OF14_OXM
, "NXM" },
711 { OFPUTIL_P_ANY_OXM
& ~OFPUTIL_P_OF14_OXM
, "OXM" },
713 #define N_PROTO_ABBREVS ARRAY_SIZE(proto_abbrevs)
715 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
;
748 /* Returns the ofputil_protocol that is initially in effect on an OpenFlow
749 * connection that has negotiated the given 'version'. 'version' should
750 * normally be an 8-bit OpenFlow version identifier (e.g. 0x01 for OpenFlow
751 * 1.0, 0x02 for OpenFlow 1.1). Returns 0 if 'version' is not supported or
752 * outside the valid range. */
753 enum ofputil_protocol
754 ofputil_protocol_from_ofp_version(enum ofp_version version
)
756 return rightmost_1bit(ofputil_protocols_from_ofp_version(version
));
759 /* Returns the OpenFlow protocol version number (e.g. OFP10_VERSION,
760 * etc.) that corresponds to 'protocol'. */
762 ofputil_protocol_to_ofp_version(enum ofputil_protocol protocol
)
765 case OFPUTIL_P_OF10_STD
:
766 case OFPUTIL_P_OF10_STD_TID
:
767 case OFPUTIL_P_OF10_NXM
:
768 case OFPUTIL_P_OF10_NXM_TID
:
769 return OFP10_VERSION
;
770 case OFPUTIL_P_OF11_STD
:
771 return OFP11_VERSION
;
772 case OFPUTIL_P_OF12_OXM
:
773 return OFP12_VERSION
;
774 case OFPUTIL_P_OF13_OXM
:
775 return OFP13_VERSION
;
776 case OFPUTIL_P_OF14_OXM
:
777 return OFP14_VERSION
;
783 /* Returns a bitmap of OpenFlow versions that are supported by at
784 * least one of the 'protocols'. */
786 ofputil_protocols_to_version_bitmap(enum ofputil_protocol protocols
)
790 for (; protocols
; protocols
= zero_rightmost_1bit(protocols
)) {
791 enum ofputil_protocol protocol
= rightmost_1bit(protocols
);
793 bitmap
|= 1u << ofputil_protocol_to_ofp_version(protocol
);
799 /* Returns the set of protocols that are supported on top of the
800 * OpenFlow versions included in 'bitmap'. */
801 enum ofputil_protocol
802 ofputil_protocols_from_version_bitmap(uint32_t bitmap
)
804 enum ofputil_protocol protocols
= 0;
806 for (; bitmap
; bitmap
= zero_rightmost_1bit(bitmap
)) {
807 enum ofp_version version
= rightmost_1bit_idx(bitmap
);
809 protocols
|= ofputil_protocols_from_ofp_version(version
);
815 /* Returns true if 'protocol' is a single OFPUTIL_P_* value, false
818 ofputil_protocol_is_valid(enum ofputil_protocol protocol
)
820 return protocol
& OFPUTIL_P_ANY
&& is_pow2(protocol
);
823 /* Returns the equivalent of 'protocol' with the Nicira flow_mod_table_id
824 * extension turned on or off if 'enable' is true or false, respectively.
826 * This extension is only useful for protocols whose "standard" version does
827 * not allow specific tables to be modified. In particular, this is true of
828 * OpenFlow 1.0. In later versions of OpenFlow, a flow_mod request always
829 * specifies a table ID and so there is no need for such an extension. When
830 * 'protocol' is such a protocol that doesn't need a flow_mod_table_id
831 * extension, this function just returns its 'protocol' argument unchanged
832 * regardless of the value of 'enable'. */
833 enum ofputil_protocol
834 ofputil_protocol_set_tid(enum ofputil_protocol protocol
, bool enable
)
837 case OFPUTIL_P_OF10_STD
:
838 case OFPUTIL_P_OF10_STD_TID
:
839 return enable
? OFPUTIL_P_OF10_STD_TID
: OFPUTIL_P_OF10_STD
;
841 case OFPUTIL_P_OF10_NXM
:
842 case OFPUTIL_P_OF10_NXM_TID
:
843 return enable
? OFPUTIL_P_OF10_NXM_TID
: OFPUTIL_P_OF10_NXM
;
845 case OFPUTIL_P_OF11_STD
:
846 return OFPUTIL_P_OF11_STD
;
848 case OFPUTIL_P_OF12_OXM
:
849 return OFPUTIL_P_OF12_OXM
;
851 case OFPUTIL_P_OF13_OXM
:
852 return OFPUTIL_P_OF13_OXM
;
854 case OFPUTIL_P_OF14_OXM
:
855 return OFPUTIL_P_OF14_OXM
;
862 /* Returns the "base" version of 'protocol'. That is, if 'protocol' includes
863 * some extension to a standard protocol version, the return value is the
864 * standard version of that protocol without any extension. If 'protocol' is a
865 * standard protocol version, returns 'protocol' unchanged. */
866 enum ofputil_protocol
867 ofputil_protocol_to_base(enum ofputil_protocol protocol
)
869 return ofputil_protocol_set_tid(protocol
, false);
872 /* Returns 'new_base' with any extensions taken from 'cur'. */
873 enum ofputil_protocol
874 ofputil_protocol_set_base(enum ofputil_protocol cur
,
875 enum ofputil_protocol new_base
)
877 bool tid
= (cur
& OFPUTIL_P_TID
) != 0;
880 case OFPUTIL_P_OF10_STD
:
881 case OFPUTIL_P_OF10_STD_TID
:
882 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_STD
, tid
);
884 case OFPUTIL_P_OF10_NXM
:
885 case OFPUTIL_P_OF10_NXM_TID
:
886 return ofputil_protocol_set_tid(OFPUTIL_P_OF10_NXM
, tid
);
888 case OFPUTIL_P_OF11_STD
:
889 return ofputil_protocol_set_tid(OFPUTIL_P_OF11_STD
, tid
);
891 case OFPUTIL_P_OF12_OXM
:
892 return ofputil_protocol_set_tid(OFPUTIL_P_OF12_OXM
, tid
);
894 case OFPUTIL_P_OF13_OXM
:
895 return ofputil_protocol_set_tid(OFPUTIL_P_OF13_OXM
, tid
);
897 case OFPUTIL_P_OF14_OXM
:
898 return ofputil_protocol_set_tid(OFPUTIL_P_OF14_OXM
, tid
);
905 /* Returns a string form of 'protocol', if a simple form exists (that is, if
906 * 'protocol' is either a single protocol or it is a combination of protocols
907 * that have a single abbreviation). Otherwise, returns NULL. */
909 ofputil_protocol_to_string(enum ofputil_protocol protocol
)
911 const struct proto_abbrev
*p
;
913 /* Use a "switch" statement for single-bit names so that we get a compiler
914 * warning if we forget any. */
916 case OFPUTIL_P_OF10_NXM
:
917 return "NXM-table_id";
919 case OFPUTIL_P_OF10_NXM_TID
:
920 return "NXM+table_id";
922 case OFPUTIL_P_OF10_STD
:
923 return "OpenFlow10-table_id";
925 case OFPUTIL_P_OF10_STD_TID
:
926 return "OpenFlow10+table_id";
928 case OFPUTIL_P_OF11_STD
:
931 case OFPUTIL_P_OF12_OXM
:
932 return "OXM-OpenFlow12";
934 case OFPUTIL_P_OF13_OXM
:
935 return "OXM-OpenFlow13";
937 case OFPUTIL_P_OF14_OXM
:
938 return "OXM-OpenFlow14";
941 /* Check abbreviations. */
942 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
943 if (protocol
== p
->protocol
) {
951 /* Returns a string that represents 'protocols'. The return value might be a
952 * comma-separated list if 'protocols' doesn't have a simple name. The return
953 * value is "none" if 'protocols' is 0.
955 * The caller must free the returned string (with free()). */
957 ofputil_protocols_to_string(enum ofputil_protocol protocols
)
961 ovs_assert(!(protocols
& ~OFPUTIL_P_ANY
));
962 if (protocols
== 0) {
963 return xstrdup("none");
968 const struct proto_abbrev
*p
;
972 ds_put_char(&s
, ',');
975 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
976 if ((protocols
& p
->protocol
) == p
->protocol
) {
977 ds_put_cstr(&s
, p
->name
);
978 protocols
&= ~p
->protocol
;
983 for (i
= 0; i
< CHAR_BIT
* sizeof(enum ofputil_protocol
); i
++) {
984 enum ofputil_protocol bit
= 1u << i
;
986 if (protocols
& bit
) {
987 ds_put_cstr(&s
, ofputil_protocol_to_string(bit
));
996 return ds_steal_cstr(&s
);
999 static enum ofputil_protocol
1000 ofputil_protocol_from_string__(const char *s
, size_t n
)
1002 const struct proto_abbrev
*p
;
1005 for (i
= 0; i
< CHAR_BIT
* sizeof(enum ofputil_protocol
); i
++) {
1006 enum ofputil_protocol bit
= 1u << i
;
1007 const char *name
= ofputil_protocol_to_string(bit
);
1009 if (name
&& n
== strlen(name
) && !strncasecmp(s
, name
, n
)) {
1014 for (p
= proto_abbrevs
; p
< &proto_abbrevs
[N_PROTO_ABBREVS
]; p
++) {
1015 if (n
== strlen(p
->name
) && !strncasecmp(s
, p
->name
, n
)) {
1023 /* Returns the nonempty set of protocols represented by 's', which can be a
1024 * single protocol name or abbreviation or a comma-separated list of them.
1026 * Aborts the program with an error message if 's' is invalid. */
1027 enum ofputil_protocol
1028 ofputil_protocols_from_string(const char *s
)
1030 const char *orig_s
= s
;
1031 enum ofputil_protocol protocols
;
1035 enum ofputil_protocol p
;
1038 n
= strcspn(s
, ",");
1044 p
= ofputil_protocol_from_string__(s
, n
);
1046 ovs_fatal(0, "%.*s: unknown flow protocol", (int) n
, s
);
1054 ovs_fatal(0, "%s: no flow protocol specified", orig_s
);
1060 ofputil_version_from_string(const char *s
)
1062 if (!strcasecmp(s
, "OpenFlow10")) {
1063 return OFP10_VERSION
;
1065 if (!strcasecmp(s
, "OpenFlow11")) {
1066 return OFP11_VERSION
;
1068 if (!strcasecmp(s
, "OpenFlow12")) {
1069 return OFP12_VERSION
;
1071 if (!strcasecmp(s
, "OpenFlow13")) {
1072 return OFP13_VERSION
;
1074 if (!strcasecmp(s
, "OpenFlow14")) {
1075 return OFP14_VERSION
;
1081 is_delimiter(unsigned char c
)
1083 return isspace(c
) || c
== ',';
1087 ofputil_versions_from_string(const char *s
)
1090 uint32_t bitmap
= 0;
1097 if (is_delimiter(s
[i
])) {
1102 while (s
[i
+ j
] && !is_delimiter(s
[i
+ j
])) {
1105 key
= xmemdup0(s
+ i
, j
);
1106 version
= ofputil_version_from_string(key
);
1108 VLOG_FATAL("Unknown OpenFlow version: \"%s\"", key
);
1111 bitmap
|= 1u << version
;
1119 ofputil_versions_from_strings(char ** const s
, size_t count
)
1121 uint32_t bitmap
= 0;
1124 int version
= ofputil_version_from_string(s
[count
]);
1126 VLOG_WARN("Unknown OpenFlow version: \"%s\"", s
[count
]);
1128 bitmap
|= 1u << version
;
1136 ofputil_version_to_string(enum ofp_version ofp_version
)
1138 switch (ofp_version
) {
1140 return "OpenFlow10";
1142 return "OpenFlow11";
1144 return "OpenFlow12";
1146 return "OpenFlow13";
1148 return "OpenFlow14";
1155 ofputil_packet_in_format_is_valid(enum nx_packet_in_format packet_in_format
)
1157 switch (packet_in_format
) {
1158 case NXPIF_OPENFLOW10
:
1167 ofputil_packet_in_format_to_string(enum nx_packet_in_format packet_in_format
)
1169 switch (packet_in_format
) {
1170 case NXPIF_OPENFLOW10
:
1171 return "openflow10";
1180 ofputil_packet_in_format_from_string(const char *s
)
1182 return (!strcmp(s
, "openflow10") ? NXPIF_OPENFLOW10
1183 : !strcmp(s
, "nxm") ? NXPIF_NXM
1188 ofputil_format_version(struct ds
*msg
, enum ofp_version version
)
1190 ds_put_format(msg
, "0x%02x", version
);
1194 ofputil_format_version_name(struct ds
*msg
, enum ofp_version version
)
1196 ds_put_cstr(msg
, ofputil_version_to_string(version
));
1200 ofputil_format_version_bitmap__(struct ds
*msg
, uint32_t bitmap
,
1201 void (*format_version
)(struct ds
*msg
,
1205 format_version(msg
, raw_ctz(bitmap
));
1206 bitmap
= zero_rightmost_1bit(bitmap
);
1208 ds_put_cstr(msg
, ", ");
1214 ofputil_format_version_bitmap(struct ds
*msg
, uint32_t bitmap
)
1216 ofputil_format_version_bitmap__(msg
, bitmap
, ofputil_format_version
);
1220 ofputil_format_version_bitmap_names(struct ds
*msg
, uint32_t bitmap
)
1222 ofputil_format_version_bitmap__(msg
, bitmap
, ofputil_format_version_name
);
1226 ofputil_decode_hello_bitmap(const struct ofp_hello_elem_header
*oheh
,
1227 uint32_t *allowed_versionsp
)
1229 uint16_t bitmap_len
= ntohs(oheh
->length
) - sizeof *oheh
;
1230 const ovs_be32
*bitmap
= ALIGNED_CAST(const ovs_be32
*, oheh
+ 1);
1231 uint32_t allowed_versions
;
1233 if (!bitmap_len
|| bitmap_len
% sizeof *bitmap
) {
1237 /* Only use the first 32-bit element of the bitmap as that is all the
1238 * current implementation supports. Subsequent elements are ignored which
1239 * should have no effect on session negotiation until Open vSwtich supports
1240 * wire-protocol versions greater than 31.
1242 allowed_versions
= ntohl(bitmap
[0]);
1244 if (allowed_versions
& 1) {
1245 /* There's no OpenFlow version 0. */
1246 VLOG_WARN_RL(&bad_ofmsg_rl
, "peer claims to support invalid OpenFlow "
1248 allowed_versions
&= ~1u;
1251 if (!allowed_versions
) {
1252 VLOG_WARN_RL(&bad_ofmsg_rl
, "peer does not support any OpenFlow "
1253 "version (between 0x01 and 0x1f)");
1257 *allowed_versionsp
= allowed_versions
;
1262 version_bitmap_from_version(uint8_t ofp_version
)
1264 return ((ofp_version
< 32 ? 1u << ofp_version
: 0) - 1) << 1;
1267 /* Decodes OpenFlow OFPT_HELLO message 'oh', storing into '*allowed_versions'
1268 * the set of OpenFlow versions for which 'oh' announces support.
1270 * Because of how OpenFlow defines OFPT_HELLO messages, this function is always
1271 * successful, and thus '*allowed_versions' is always initialized. However, it
1272 * returns false if 'oh' contains some data that could not be fully understood,
1273 * true if 'oh' was completely parsed. */
1275 ofputil_decode_hello(const struct ofp_header
*oh
, uint32_t *allowed_versions
)
1280 ofpbuf_use_const(&msg
, oh
, ntohs(oh
->length
));
1281 ofpbuf_pull(&msg
, sizeof *oh
);
1283 *allowed_versions
= version_bitmap_from_version(oh
->version
);
1284 while (ofpbuf_size(&msg
)) {
1285 const struct ofp_hello_elem_header
*oheh
;
1288 if (ofpbuf_size(&msg
) < sizeof *oheh
) {
1292 oheh
= ofpbuf_data(&msg
);
1293 len
= ntohs(oheh
->length
);
1294 if (len
< sizeof *oheh
|| !ofpbuf_try_pull(&msg
, ROUND_UP(len
, 8))) {
1298 if (oheh
->type
!= htons(OFPHET_VERSIONBITMAP
)
1299 || !ofputil_decode_hello_bitmap(oheh
, allowed_versions
)) {
1307 /* Returns true if 'allowed_versions' needs to be accompanied by a version
1308 * bitmap to be correctly expressed in an OFPT_HELLO message. */
1310 should_send_version_bitmap(uint32_t allowed_versions
)
1312 return !is_pow2((allowed_versions
>> 1) + 1);
1315 /* Create an OFPT_HELLO message that expresses support for the OpenFlow
1316 * versions in the 'allowed_versions' bitmaps and returns the message. */
1318 ofputil_encode_hello(uint32_t allowed_versions
)
1320 enum ofp_version ofp_version
;
1323 ofp_version
= leftmost_1bit_idx(allowed_versions
);
1324 msg
= ofpraw_alloc(OFPRAW_OFPT_HELLO
, ofp_version
, 0);
1326 if (should_send_version_bitmap(allowed_versions
)) {
1327 struct ofp_hello_elem_header
*oheh
;
1330 map_len
= sizeof allowed_versions
;
1331 oheh
= ofpbuf_put_zeros(msg
, ROUND_UP(map_len
+ sizeof *oheh
, 8));
1332 oheh
->type
= htons(OFPHET_VERSIONBITMAP
);
1333 oheh
->length
= htons(map_len
+ sizeof *oheh
);
1334 *ALIGNED_CAST(ovs_be32
*, oheh
+ 1) = htonl(allowed_versions
);
1336 ofpmsg_update_length(msg
);
1342 /* Returns an OpenFlow message that, sent on an OpenFlow connection whose
1343 * protocol is 'current', at least partly transitions the protocol to 'want'.
1344 * Stores in '*next' the protocol that will be in effect on the OpenFlow
1345 * connection if the switch processes the returned message correctly. (If
1346 * '*next != want' then the caller will have to iterate.)
1348 * If 'current == want', or if it is not possible to transition from 'current'
1349 * to 'want' (because, for example, 'current' and 'want' use different OpenFlow
1350 * protocol versions), returns NULL and stores 'current' in '*next'. */
1352 ofputil_encode_set_protocol(enum ofputil_protocol current
,
1353 enum ofputil_protocol want
,
1354 enum ofputil_protocol
*next
)
1356 enum ofp_version cur_version
, want_version
;
1357 enum ofputil_protocol cur_base
, want_base
;
1358 bool cur_tid
, want_tid
;
1360 cur_version
= ofputil_protocol_to_ofp_version(current
);
1361 want_version
= ofputil_protocol_to_ofp_version(want
);
1362 if (cur_version
!= want_version
) {
1367 cur_base
= ofputil_protocol_to_base(current
);
1368 want_base
= ofputil_protocol_to_base(want
);
1369 if (cur_base
!= want_base
) {
1370 *next
= ofputil_protocol_set_base(current
, want_base
);
1372 switch (want_base
) {
1373 case OFPUTIL_P_OF10_NXM
:
1374 return ofputil_encode_nx_set_flow_format(NXFF_NXM
);
1376 case OFPUTIL_P_OF10_STD
:
1377 return ofputil_encode_nx_set_flow_format(NXFF_OPENFLOW10
);
1379 case OFPUTIL_P_OF11_STD
:
1380 case OFPUTIL_P_OF12_OXM
:
1381 case OFPUTIL_P_OF13_OXM
:
1382 case OFPUTIL_P_OF14_OXM
:
1383 /* There is only one variant of each OpenFlow 1.1+ protocol, and we
1384 * verified above that we're not trying to change versions. */
1387 case OFPUTIL_P_OF10_STD_TID
:
1388 case OFPUTIL_P_OF10_NXM_TID
:
1393 cur_tid
= (current
& OFPUTIL_P_TID
) != 0;
1394 want_tid
= (want
& OFPUTIL_P_TID
) != 0;
1395 if (cur_tid
!= want_tid
) {
1396 *next
= ofputil_protocol_set_tid(current
, want_tid
);
1397 return ofputil_make_flow_mod_table_id(want_tid
);
1400 ovs_assert(current
== want
);
1406 /* Returns an NXT_SET_FLOW_FORMAT message that can be used to set the flow
1407 * format to 'nxff'. */
1409 ofputil_encode_nx_set_flow_format(enum nx_flow_format nxff
)
1411 struct nx_set_flow_format
*sff
;
1414 ovs_assert(ofputil_nx_flow_format_is_valid(nxff
));
1416 msg
= ofpraw_alloc(OFPRAW_NXT_SET_FLOW_FORMAT
, OFP10_VERSION
, 0);
1417 sff
= ofpbuf_put_zeros(msg
, sizeof *sff
);
1418 sff
->format
= htonl(nxff
);
1423 /* Returns the base protocol if 'flow_format' is a valid NXFF_* value, false
1425 enum ofputil_protocol
1426 ofputil_nx_flow_format_to_protocol(enum nx_flow_format flow_format
)
1428 switch (flow_format
) {
1429 case NXFF_OPENFLOW10
:
1430 return OFPUTIL_P_OF10_STD
;
1433 return OFPUTIL_P_OF10_NXM
;
1440 /* Returns true if 'flow_format' is a valid NXFF_* value, false otherwise. */
1442 ofputil_nx_flow_format_is_valid(enum nx_flow_format flow_format
)
1444 return ofputil_nx_flow_format_to_protocol(flow_format
) != 0;
1447 /* Returns a string version of 'flow_format', which must be a valid NXFF_*
1450 ofputil_nx_flow_format_to_string(enum nx_flow_format flow_format
)
1452 switch (flow_format
) {
1453 case NXFF_OPENFLOW10
:
1454 return "openflow10";
1463 ofputil_make_set_packet_in_format(enum ofp_version ofp_version
,
1464 enum nx_packet_in_format packet_in_format
)
1466 struct nx_set_packet_in_format
*spif
;
1469 msg
= ofpraw_alloc(OFPRAW_NXT_SET_PACKET_IN_FORMAT
, ofp_version
, 0);
1470 spif
= ofpbuf_put_zeros(msg
, sizeof *spif
);
1471 spif
->format
= htonl(packet_in_format
);
1476 /* Returns an OpenFlow message that can be used to turn the flow_mod_table_id
1477 * extension on or off (according to 'flow_mod_table_id'). */
1479 ofputil_make_flow_mod_table_id(bool flow_mod_table_id
)
1481 struct nx_flow_mod_table_id
*nfmti
;
1484 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MOD_TABLE_ID
, OFP10_VERSION
, 0);
1485 nfmti
= ofpbuf_put_zeros(msg
, sizeof *nfmti
);
1486 nfmti
->set
= flow_mod_table_id
;
1490 struct ofputil_flow_mod_flag
{
1492 enum ofp_version min_version
, max_version
;
1493 enum ofputil_flow_mod_flags flag
;
1496 static const struct ofputil_flow_mod_flag ofputil_flow_mod_flags
[] = {
1497 { OFPFF_SEND_FLOW_REM
, OFP10_VERSION
, 0, OFPUTIL_FF_SEND_FLOW_REM
},
1498 { OFPFF_CHECK_OVERLAP
, OFP10_VERSION
, 0, OFPUTIL_FF_CHECK_OVERLAP
},
1499 { OFPFF10_EMERG
, OFP10_VERSION
, OFP10_VERSION
,
1501 { OFPFF12_RESET_COUNTS
, OFP12_VERSION
, 0, OFPUTIL_FF_RESET_COUNTS
},
1502 { OFPFF13_NO_PKT_COUNTS
, OFP13_VERSION
, 0, OFPUTIL_FF_NO_PKT_COUNTS
},
1503 { OFPFF13_NO_BYT_COUNTS
, OFP13_VERSION
, 0, OFPUTIL_FF_NO_BYT_COUNTS
},
1508 ofputil_decode_flow_mod_flags(ovs_be16 raw_flags_
,
1509 enum ofp_flow_mod_command command
,
1510 enum ofp_version version
,
1511 enum ofputil_flow_mod_flags
*flagsp
)
1513 uint16_t raw_flags
= ntohs(raw_flags_
);
1514 const struct ofputil_flow_mod_flag
*f
;
1517 for (f
= ofputil_flow_mod_flags
; f
->raw_flag
; f
++) {
1518 if (raw_flags
& f
->raw_flag
1519 && version
>= f
->min_version
1520 && (!f
->max_version
|| version
<= f
->max_version
)) {
1521 raw_flags
&= ~f
->raw_flag
;
1526 /* In OF1.0 and OF1.1, "add" always resets counters, and other commands
1529 * In OF1.2 and later, OFPFF12_RESET_COUNTS controls whether each command
1530 * resets counters. */
1531 if ((version
== OFP10_VERSION
|| version
== OFP11_VERSION
)
1532 && command
== OFPFC_ADD
) {
1533 *flagsp
|= OFPUTIL_FF_RESET_COUNTS
;
1536 return raw_flags
? OFPERR_OFPFMFC_BAD_FLAGS
: 0;
1540 ofputil_encode_flow_mod_flags(enum ofputil_flow_mod_flags flags
,
1541 enum ofp_version version
)
1543 const struct ofputil_flow_mod_flag
*f
;
1547 for (f
= ofputil_flow_mod_flags
; f
->raw_flag
; f
++) {
1549 && version
>= f
->min_version
1550 && (!f
->max_version
|| version
<= f
->max_version
)) {
1551 raw_flags
|= f
->raw_flag
;
1555 return htons(raw_flags
);
1558 /* Converts an OFPT_FLOW_MOD or NXT_FLOW_MOD message 'oh' into an abstract
1559 * flow_mod in 'fm'. Returns 0 if successful, otherwise an OpenFlow error
1562 * Uses 'ofpacts' to store the abstract OFPACT_* version of 'oh''s actions.
1563 * The caller must initialize 'ofpacts' and retains ownership of it.
1564 * 'fm->ofpacts' will point into the 'ofpacts' buffer.
1566 * Does not validate the flow_mod actions. The caller should do that, with
1567 * ofpacts_check(). */
1569 ofputil_decode_flow_mod(struct ofputil_flow_mod
*fm
,
1570 const struct ofp_header
*oh
,
1571 enum ofputil_protocol protocol
,
1572 struct ofpbuf
*ofpacts
,
1573 ofp_port_t max_port
, uint8_t max_table
)
1580 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1581 raw
= ofpraw_pull_assert(&b
);
1582 if (raw
== OFPRAW_OFPT11_FLOW_MOD
) {
1583 /* Standard OpenFlow 1.1+ flow_mod. */
1584 const struct ofp11_flow_mod
*ofm
;
1586 ofm
= ofpbuf_pull(&b
, sizeof *ofm
);
1588 error
= ofputil_pull_ofp11_match(&b
, &fm
->match
, NULL
);
1593 error
= ofpacts_pull_openflow_instructions(&b
, ofpbuf_size(&b
), oh
->version
,
1599 /* Translate the message. */
1600 fm
->priority
= ntohs(ofm
->priority
);
1601 if (ofm
->command
== OFPFC_ADD
1602 || (oh
->version
== OFP11_VERSION
1603 && (ofm
->command
== OFPFC_MODIFY
||
1604 ofm
->command
== OFPFC_MODIFY_STRICT
)
1605 && ofm
->cookie_mask
== htonll(0))) {
1606 /* In OpenFlow 1.1 only, a "modify" or "modify-strict" that does
1607 * not match on the cookie is treated as an "add" if there is no
1609 fm
->cookie
= htonll(0);
1610 fm
->cookie_mask
= htonll(0);
1611 fm
->new_cookie
= ofm
->cookie
;
1613 fm
->cookie
= ofm
->cookie
;
1614 fm
->cookie_mask
= ofm
->cookie_mask
;
1615 fm
->new_cookie
= OVS_BE64_MAX
;
1617 fm
->modify_cookie
= false;
1618 fm
->command
= ofm
->command
;
1622 * OF1.1 entirely forbids table_id == OFPTT_ALL.
1623 * OF1.2+ allows table_id == OFPTT_ALL only for deletes. */
1624 fm
->table_id
= ofm
->table_id
;
1625 if (fm
->table_id
== OFPTT_ALL
1626 && (oh
->version
== OFP11_VERSION
1627 || (ofm
->command
!= OFPFC_DELETE
&&
1628 ofm
->command
!= OFPFC_DELETE_STRICT
))) {
1629 return OFPERR_OFPFMFC_BAD_TABLE_ID
;
1632 fm
->idle_timeout
= ntohs(ofm
->idle_timeout
);
1633 fm
->hard_timeout
= ntohs(ofm
->hard_timeout
);
1634 fm
->buffer_id
= ntohl(ofm
->buffer_id
);
1635 error
= ofputil_port_from_ofp11(ofm
->out_port
, &fm
->out_port
);
1640 fm
->out_group
= (ofm
->command
== OFPFC_DELETE
||
1641 ofm
->command
== OFPFC_DELETE_STRICT
1642 ? ntohl(ofm
->out_group
)
1644 raw_flags
= ofm
->flags
;
1648 if (raw
== OFPRAW_OFPT10_FLOW_MOD
) {
1649 /* Standard OpenFlow 1.0 flow_mod. */
1650 const struct ofp10_flow_mod
*ofm
;
1652 /* Get the ofp10_flow_mod. */
1653 ofm
= ofpbuf_pull(&b
, sizeof *ofm
);
1655 /* Translate the rule. */
1656 ofputil_match_from_ofp10_match(&ofm
->match
, &fm
->match
);
1657 ofputil_normalize_match(&fm
->match
);
1659 /* Now get the actions. */
1660 error
= ofpacts_pull_openflow_actions(&b
, ofpbuf_size(&b
), oh
->version
,
1666 /* OpenFlow 1.0 says that exact-match rules have to have the
1667 * highest possible priority. */
1668 fm
->priority
= (ofm
->match
.wildcards
& htonl(OFPFW10_ALL
)
1669 ? ntohs(ofm
->priority
)
1672 /* Translate the message. */
1673 command
= ntohs(ofm
->command
);
1674 fm
->cookie
= htonll(0);
1675 fm
->cookie_mask
= htonll(0);
1676 fm
->new_cookie
= ofm
->cookie
;
1677 fm
->idle_timeout
= ntohs(ofm
->idle_timeout
);
1678 fm
->hard_timeout
= ntohs(ofm
->hard_timeout
);
1679 fm
->buffer_id
= ntohl(ofm
->buffer_id
);
1680 fm
->out_port
= u16_to_ofp(ntohs(ofm
->out_port
));
1681 fm
->out_group
= OFPG11_ANY
;
1682 raw_flags
= ofm
->flags
;
1683 } else if (raw
== OFPRAW_NXT_FLOW_MOD
) {
1684 /* Nicira extended flow_mod. */
1685 const struct nx_flow_mod
*nfm
;
1687 /* Dissect the message. */
1688 nfm
= ofpbuf_pull(&b
, sizeof *nfm
);
1689 error
= nx_pull_match(&b
, ntohs(nfm
->match_len
),
1690 &fm
->match
, &fm
->cookie
, &fm
->cookie_mask
);
1694 error
= ofpacts_pull_openflow_actions(&b
, ofpbuf_size(&b
), oh
->version
,
1700 /* Translate the message. */
1701 command
= ntohs(nfm
->command
);
1702 if ((command
& 0xff) == OFPFC_ADD
&& fm
->cookie_mask
) {
1703 /* Flow additions may only set a new cookie, not match an
1704 * existing cookie. */
1705 return OFPERR_NXBRC_NXM_INVALID
;
1707 fm
->priority
= ntohs(nfm
->priority
);
1708 fm
->new_cookie
= nfm
->cookie
;
1709 fm
->idle_timeout
= ntohs(nfm
->idle_timeout
);
1710 fm
->hard_timeout
= ntohs(nfm
->hard_timeout
);
1711 fm
->buffer_id
= ntohl(nfm
->buffer_id
);
1712 fm
->out_port
= u16_to_ofp(ntohs(nfm
->out_port
));
1713 fm
->out_group
= OFPG11_ANY
;
1714 raw_flags
= nfm
->flags
;
1719 fm
->modify_cookie
= fm
->new_cookie
!= OVS_BE64_MAX
;
1720 if (protocol
& OFPUTIL_P_TID
) {
1721 fm
->command
= command
& 0xff;
1722 fm
->table_id
= command
>> 8;
1724 fm
->command
= command
;
1725 fm
->table_id
= 0xff;
1729 fm
->ofpacts
= ofpbuf_data(ofpacts
);
1730 fm
->ofpacts_len
= ofpbuf_size(ofpacts
);
1732 error
= ofputil_decode_flow_mod_flags(raw_flags
, fm
->command
,
1733 oh
->version
, &fm
->flags
);
1738 if (fm
->flags
& OFPUTIL_FF_EMERG
) {
1739 /* We do not support the OpenFlow 1.0 emergency flow cache, which
1740 * is not required in OpenFlow 1.0.1 and removed from OpenFlow 1.1.
1742 * OpenFlow 1.0 specifies the error code to use when idle_timeout
1743 * or hard_timeout is nonzero. Otherwise, there is no good error
1744 * code, so just state that the flow table is full. */
1745 return (fm
->hard_timeout
|| fm
->idle_timeout
1746 ? OFPERR_OFPFMFC_BAD_EMERG_TIMEOUT
1747 : OFPERR_OFPFMFC_TABLE_FULL
);
1750 return ofpacts_check_consistency(fm
->ofpacts
, fm
->ofpacts_len
,
1751 &fm
->match
.flow
, max_port
,
1752 fm
->table_id
, max_table
, protocol
);
1756 ofputil_pull_bands(struct ofpbuf
*msg
, size_t len
, uint16_t *n_bands
,
1757 struct ofpbuf
*bands
)
1759 const struct ofp13_meter_band_header
*ombh
;
1760 struct ofputil_meter_band
*mb
;
1763 ombh
= ofpbuf_try_pull(msg
, len
);
1765 return OFPERR_OFPBRC_BAD_LEN
;
1768 while (len
>= sizeof (struct ofp13_meter_band_drop
)) {
1769 size_t ombh_len
= ntohs(ombh
->len
);
1770 /* All supported band types have the same length. */
1771 if (ombh_len
!= sizeof (struct ofp13_meter_band_drop
)) {
1772 return OFPERR_OFPBRC_BAD_LEN
;
1774 mb
= ofpbuf_put_uninit(bands
, sizeof *mb
);
1775 mb
->type
= ntohs(ombh
->type
);
1776 if (mb
->type
!= OFPMBT13_DROP
&& mb
->type
!= OFPMBT13_DSCP_REMARK
) {
1777 return OFPERR_OFPMMFC_BAD_BAND
;
1779 mb
->rate
= ntohl(ombh
->rate
);
1780 mb
->burst_size
= ntohl(ombh
->burst_size
);
1781 mb
->prec_level
= (mb
->type
== OFPMBT13_DSCP_REMARK
) ?
1782 ((struct ofp13_meter_band_dscp_remark
*)ombh
)->prec_level
: 0;
1785 ombh
= ALIGNED_CAST(struct ofp13_meter_band_header
*,
1786 (char *) ombh
+ ombh_len
);
1789 return OFPERR_OFPBRC_BAD_LEN
;
1796 ofputil_decode_meter_mod(const struct ofp_header
*oh
,
1797 struct ofputil_meter_mod
*mm
,
1798 struct ofpbuf
*bands
)
1800 const struct ofp13_meter_mod
*omm
;
1803 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1804 ofpraw_pull_assert(&b
);
1805 omm
= ofpbuf_pull(&b
, sizeof *omm
);
1807 /* Translate the message. */
1808 mm
->command
= ntohs(omm
->command
);
1809 if (mm
->command
!= OFPMC13_ADD
&&
1810 mm
->command
!= OFPMC13_MODIFY
&&
1811 mm
->command
!= OFPMC13_DELETE
) {
1812 return OFPERR_OFPMMFC_BAD_COMMAND
;
1814 mm
->meter
.meter_id
= ntohl(omm
->meter_id
);
1816 if (mm
->command
== OFPMC13_DELETE
) {
1817 mm
->meter
.flags
= 0;
1818 mm
->meter
.n_bands
= 0;
1819 mm
->meter
.bands
= NULL
;
1823 mm
->meter
.flags
= ntohs(omm
->flags
);
1824 if (mm
->meter
.flags
& OFPMF13_KBPS
&&
1825 mm
->meter
.flags
& OFPMF13_PKTPS
) {
1826 return OFPERR_OFPMMFC_BAD_FLAGS
;
1828 mm
->meter
.bands
= ofpbuf_data(bands
);
1830 error
= ofputil_pull_bands(&b
, ofpbuf_size(&b
), &mm
->meter
.n_bands
, bands
);
1839 ofputil_decode_meter_request(const struct ofp_header
*oh
, uint32_t *meter_id
)
1841 const struct ofp13_meter_multipart_request
*omr
= ofpmsg_body(oh
);
1842 *meter_id
= ntohl(omr
->meter_id
);
1846 ofputil_encode_meter_request(enum ofp_version ofp_version
,
1847 enum ofputil_meter_request_type type
,
1855 case OFPUTIL_METER_CONFIG
:
1856 raw
= OFPRAW_OFPST13_METER_CONFIG_REQUEST
;
1858 case OFPUTIL_METER_STATS
:
1859 raw
= OFPRAW_OFPST13_METER_REQUEST
;
1862 case OFPUTIL_METER_FEATURES
:
1863 raw
= OFPRAW_OFPST13_METER_FEATURES_REQUEST
;
1867 msg
= ofpraw_alloc(raw
, ofp_version
, 0);
1869 if (type
!= OFPUTIL_METER_FEATURES
) {
1870 struct ofp13_meter_multipart_request
*omr
;
1871 omr
= ofpbuf_put_zeros(msg
, sizeof *omr
);
1872 omr
->meter_id
= htonl(meter_id
);
1878 ofputil_put_bands(uint16_t n_bands
, const struct ofputil_meter_band
*mb
,
1883 for (n
= 0; n
< n_bands
; ++n
) {
1884 /* Currently all band types have same size. */
1885 struct ofp13_meter_band_dscp_remark
*ombh
;
1886 size_t ombh_len
= sizeof *ombh
;
1888 ombh
= ofpbuf_put_zeros(msg
, ombh_len
);
1890 ombh
->type
= htons(mb
->type
);
1891 ombh
->len
= htons(ombh_len
);
1892 ombh
->rate
= htonl(mb
->rate
);
1893 ombh
->burst_size
= htonl(mb
->burst_size
);
1894 ombh
->prec_level
= mb
->prec_level
;
1900 /* Encode a meter stat for 'mc' and append it to 'replies'. */
1902 ofputil_append_meter_config(struct list
*replies
,
1903 const struct ofputil_meter_config
*mc
)
1905 struct ofpbuf
*msg
= ofpbuf_from_list(list_back(replies
));
1906 size_t start_ofs
= ofpbuf_size(msg
);
1907 struct ofp13_meter_config
*reply
= ofpbuf_put_uninit(msg
, sizeof *reply
);
1908 reply
->flags
= htons(mc
->flags
);
1909 reply
->meter_id
= htonl(mc
->meter_id
);
1911 ofputil_put_bands(mc
->n_bands
, mc
->bands
, msg
);
1913 reply
->length
= htons(ofpbuf_size(msg
) - start_ofs
);
1915 ofpmp_postappend(replies
, start_ofs
);
1918 /* Encode a meter stat for 'ms' and append it to 'replies'. */
1920 ofputil_append_meter_stats(struct list
*replies
,
1921 const struct ofputil_meter_stats
*ms
)
1923 struct ofp13_meter_stats
*reply
;
1927 len
= sizeof *reply
+ ms
->n_bands
* sizeof(struct ofp13_meter_band_stats
);
1928 reply
= ofpmp_append(replies
, len
);
1930 reply
->meter_id
= htonl(ms
->meter_id
);
1931 reply
->len
= htons(len
);
1932 memset(reply
->pad
, 0, sizeof reply
->pad
);
1933 reply
->flow_count
= htonl(ms
->flow_count
);
1934 reply
->packet_in_count
= htonll(ms
->packet_in_count
);
1935 reply
->byte_in_count
= htonll(ms
->byte_in_count
);
1936 reply
->duration_sec
= htonl(ms
->duration_sec
);
1937 reply
->duration_nsec
= htonl(ms
->duration_nsec
);
1939 for (n
= 0; n
< ms
->n_bands
; ++n
) {
1940 const struct ofputil_meter_band_stats
*src
= &ms
->bands
[n
];
1941 struct ofp13_meter_band_stats
*dst
= &reply
->band_stats
[n
];
1943 dst
->packet_band_count
= htonll(src
->packet_count
);
1944 dst
->byte_band_count
= htonll(src
->byte_count
);
1948 /* Converts an OFPMP_METER_CONFIG reply in 'msg' into an abstract
1949 * ofputil_meter_config in 'mc', with mc->bands pointing to bands decoded into
1950 * 'bands'. The caller must have initialized 'bands' and retains ownership of
1951 * it across the call.
1953 * Multiple OFPST13_METER_CONFIG replies can be packed into a single OpenFlow
1954 * message. Calling this function multiple times for a single 'msg' iterates
1955 * through the replies. 'bands' is cleared for each reply.
1957 * Returns 0 if successful, EOF if no replies were left in this 'msg',
1958 * otherwise a positive errno value. */
1960 ofputil_decode_meter_config(struct ofpbuf
*msg
,
1961 struct ofputil_meter_config
*mc
,
1962 struct ofpbuf
*bands
)
1964 const struct ofp13_meter_config
*omc
;
1967 /* Pull OpenFlow headers for the first call. */
1969 ofpraw_pull_assert(msg
);
1972 if (!ofpbuf_size(msg
)) {
1976 omc
= ofpbuf_try_pull(msg
, sizeof *omc
);
1978 VLOG_WARN_RL(&bad_ofmsg_rl
,
1979 "OFPMP_METER_CONFIG reply has %"PRIu32
" leftover bytes at end",
1981 return OFPERR_OFPBRC_BAD_LEN
;
1984 ofpbuf_clear(bands
);
1985 err
= ofputil_pull_bands(msg
, ntohs(omc
->length
) - sizeof *omc
,
1986 &mc
->n_bands
, bands
);
1990 mc
->meter_id
= ntohl(omc
->meter_id
);
1991 mc
->flags
= ntohs(omc
->flags
);
1992 mc
->bands
= ofpbuf_data(bands
);
1998 ofputil_pull_band_stats(struct ofpbuf
*msg
, size_t len
, uint16_t *n_bands
,
1999 struct ofpbuf
*bands
)
2001 const struct ofp13_meter_band_stats
*ombs
;
2002 struct ofputil_meter_band_stats
*mbs
;
2005 ombs
= ofpbuf_try_pull(msg
, len
);
2007 return OFPERR_OFPBRC_BAD_LEN
;
2010 n
= len
/ sizeof *ombs
;
2011 if (len
!= n
* sizeof *ombs
) {
2012 return OFPERR_OFPBRC_BAD_LEN
;
2015 mbs
= ofpbuf_put_uninit(bands
, len
);
2017 for (i
= 0; i
< n
; ++i
) {
2018 mbs
[i
].packet_count
= ntohll(ombs
[i
].packet_band_count
);
2019 mbs
[i
].byte_count
= ntohll(ombs
[i
].byte_band_count
);
2025 /* Converts an OFPMP_METER reply in 'msg' into an abstract
2026 * ofputil_meter_stats in 'ms', with ms->bands pointing to band stats
2027 * decoded into 'bands'.
2029 * Multiple OFPMP_METER replies can be packed into a single OpenFlow
2030 * message. Calling this function multiple times for a single 'msg' iterates
2031 * through the replies. 'bands' is cleared for each reply.
2033 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2034 * otherwise a positive errno value. */
2036 ofputil_decode_meter_stats(struct ofpbuf
*msg
,
2037 struct ofputil_meter_stats
*ms
,
2038 struct ofpbuf
*bands
)
2040 const struct ofp13_meter_stats
*oms
;
2043 /* Pull OpenFlow headers for the first call. */
2045 ofpraw_pull_assert(msg
);
2048 if (!ofpbuf_size(msg
)) {
2052 oms
= ofpbuf_try_pull(msg
, sizeof *oms
);
2054 VLOG_WARN_RL(&bad_ofmsg_rl
,
2055 "OFPMP_METER reply has %"PRIu32
" leftover bytes at end",
2057 return OFPERR_OFPBRC_BAD_LEN
;
2060 ofpbuf_clear(bands
);
2061 err
= ofputil_pull_band_stats(msg
, ntohs(oms
->len
) - sizeof *oms
,
2062 &ms
->n_bands
, bands
);
2066 ms
->meter_id
= ntohl(oms
->meter_id
);
2067 ms
->flow_count
= ntohl(oms
->flow_count
);
2068 ms
->packet_in_count
= ntohll(oms
->packet_in_count
);
2069 ms
->byte_in_count
= ntohll(oms
->byte_in_count
);
2070 ms
->duration_sec
= ntohl(oms
->duration_sec
);
2071 ms
->duration_nsec
= ntohl(oms
->duration_nsec
);
2072 ms
->bands
= ofpbuf_data(bands
);
2078 ofputil_decode_meter_features(const struct ofp_header
*oh
,
2079 struct ofputil_meter_features
*mf
)
2081 const struct ofp13_meter_features
*omf
= ofpmsg_body(oh
);
2083 mf
->max_meters
= ntohl(omf
->max_meter
);
2084 mf
->band_types
= ntohl(omf
->band_types
);
2085 mf
->capabilities
= ntohl(omf
->capabilities
);
2086 mf
->max_bands
= omf
->max_bands
;
2087 mf
->max_color
= omf
->max_color
;
2091 ofputil_encode_meter_features_reply(const struct ofputil_meter_features
*mf
,
2092 const struct ofp_header
*request
)
2094 struct ofpbuf
*reply
;
2095 struct ofp13_meter_features
*omf
;
2097 reply
= ofpraw_alloc_stats_reply(request
, 0);
2098 omf
= ofpbuf_put_zeros(reply
, sizeof *omf
);
2100 omf
->max_meter
= htonl(mf
->max_meters
);
2101 omf
->band_types
= htonl(mf
->band_types
);
2102 omf
->capabilities
= htonl(mf
->capabilities
);
2103 omf
->max_bands
= mf
->max_bands
;
2104 omf
->max_color
= mf
->max_color
;
2110 ofputil_encode_meter_mod(enum ofp_version ofp_version
,
2111 const struct ofputil_meter_mod
*mm
)
2115 struct ofp13_meter_mod
*omm
;
2117 msg
= ofpraw_alloc(OFPRAW_OFPT13_METER_MOD
, ofp_version
,
2118 NXM_TYPICAL_LEN
+ mm
->meter
.n_bands
* 16);
2119 omm
= ofpbuf_put_zeros(msg
, sizeof *omm
);
2120 omm
->command
= htons(mm
->command
);
2121 if (mm
->command
!= OFPMC13_DELETE
) {
2122 omm
->flags
= htons(mm
->meter
.flags
);
2124 omm
->meter_id
= htonl(mm
->meter
.meter_id
);
2126 ofputil_put_bands(mm
->meter
.n_bands
, mm
->meter
.bands
, msg
);
2128 ofpmsg_update_length(msg
);
2133 ofputil_tid_command(const struct ofputil_flow_mod
*fm
,
2134 enum ofputil_protocol protocol
)
2136 return htons(protocol
& OFPUTIL_P_TID
2137 ? (fm
->command
& 0xff) | (fm
->table_id
<< 8)
2141 /* Converts 'fm' into an OFPT_FLOW_MOD or NXT_FLOW_MOD message according to
2142 * 'protocol' and returns the message. */
2144 ofputil_encode_flow_mod(const struct ofputil_flow_mod
*fm
,
2145 enum ofputil_protocol protocol
)
2147 enum ofp_version version
= ofputil_protocol_to_ofp_version(protocol
);
2148 ovs_be16 raw_flags
= ofputil_encode_flow_mod_flags(fm
->flags
, version
);
2152 case OFPUTIL_P_OF11_STD
:
2153 case OFPUTIL_P_OF12_OXM
:
2154 case OFPUTIL_P_OF13_OXM
:
2155 case OFPUTIL_P_OF14_OXM
: {
2156 struct ofp11_flow_mod
*ofm
;
2159 tailroom
= ofputil_match_typical_len(protocol
) + fm
->ofpacts_len
;
2160 msg
= ofpraw_alloc(OFPRAW_OFPT11_FLOW_MOD
, version
, tailroom
);
2161 ofm
= ofpbuf_put_zeros(msg
, sizeof *ofm
);
2162 if ((protocol
== OFPUTIL_P_OF11_STD
2163 && (fm
->command
== OFPFC_MODIFY
||
2164 fm
->command
== OFPFC_MODIFY_STRICT
)
2165 && fm
->cookie_mask
== htonll(0))
2166 || fm
->command
== OFPFC_ADD
) {
2167 ofm
->cookie
= fm
->new_cookie
;
2169 ofm
->cookie
= fm
->cookie
;
2171 ofm
->cookie_mask
= fm
->cookie_mask
;
2172 if (fm
->table_id
!= OFPTT_ALL
2173 || (protocol
!= OFPUTIL_P_OF11_STD
2174 && (fm
->command
== OFPFC_DELETE
||
2175 fm
->command
== OFPFC_DELETE_STRICT
))) {
2176 ofm
->table_id
= fm
->table_id
;
2180 ofm
->command
= fm
->command
;
2181 ofm
->idle_timeout
= htons(fm
->idle_timeout
);
2182 ofm
->hard_timeout
= htons(fm
->hard_timeout
);
2183 ofm
->priority
= htons(fm
->priority
);
2184 ofm
->buffer_id
= htonl(fm
->buffer_id
);
2185 ofm
->out_port
= ofputil_port_to_ofp11(fm
->out_port
);
2186 ofm
->out_group
= htonl(fm
->out_group
);
2187 ofm
->flags
= raw_flags
;
2188 ofputil_put_ofp11_match(msg
, &fm
->match
, protocol
);
2189 ofpacts_put_openflow_instructions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2194 case OFPUTIL_P_OF10_STD
:
2195 case OFPUTIL_P_OF10_STD_TID
: {
2196 struct ofp10_flow_mod
*ofm
;
2198 msg
= ofpraw_alloc(OFPRAW_OFPT10_FLOW_MOD
, OFP10_VERSION
,
2200 ofm
= ofpbuf_put_zeros(msg
, sizeof *ofm
);
2201 ofputil_match_to_ofp10_match(&fm
->match
, &ofm
->match
);
2202 ofm
->cookie
= fm
->new_cookie
;
2203 ofm
->command
= ofputil_tid_command(fm
, protocol
);
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
= htons(ofp_to_u16(fm
->out_port
));
2209 ofm
->flags
= raw_flags
;
2210 ofpacts_put_openflow_actions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2215 case OFPUTIL_P_OF10_NXM
:
2216 case OFPUTIL_P_OF10_NXM_TID
: {
2217 struct nx_flow_mod
*nfm
;
2220 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MOD
, OFP10_VERSION
,
2221 NXM_TYPICAL_LEN
+ fm
->ofpacts_len
);
2222 nfm
= ofpbuf_put_zeros(msg
, sizeof *nfm
);
2223 nfm
->command
= ofputil_tid_command(fm
, protocol
);
2224 nfm
->cookie
= fm
->new_cookie
;
2225 match_len
= nx_put_match(msg
, &fm
->match
, fm
->cookie
, fm
->cookie_mask
);
2226 nfm
= ofpbuf_l3(msg
);
2227 nfm
->idle_timeout
= htons(fm
->idle_timeout
);
2228 nfm
->hard_timeout
= htons(fm
->hard_timeout
);
2229 nfm
->priority
= htons(fm
->priority
);
2230 nfm
->buffer_id
= htonl(fm
->buffer_id
);
2231 nfm
->out_port
= htons(ofp_to_u16(fm
->out_port
));
2232 nfm
->flags
= raw_flags
;
2233 nfm
->match_len
= htons(match_len
);
2234 ofpacts_put_openflow_actions(fm
->ofpacts
, fm
->ofpacts_len
, msg
,
2243 ofpmsg_update_length(msg
);
2248 ofputil_decode_ofpst10_flow_request(struct ofputil_flow_stats_request
*fsr
,
2249 const struct ofp10_flow_stats_request
*ofsr
,
2252 fsr
->aggregate
= aggregate
;
2253 ofputil_match_from_ofp10_match(&ofsr
->match
, &fsr
->match
);
2254 fsr
->out_port
= u16_to_ofp(ntohs(ofsr
->out_port
));
2255 fsr
->out_group
= OFPG11_ANY
;
2256 fsr
->table_id
= ofsr
->table_id
;
2257 fsr
->cookie
= fsr
->cookie_mask
= htonll(0);
2263 ofputil_decode_ofpst11_flow_request(struct ofputil_flow_stats_request
*fsr
,
2264 struct ofpbuf
*b
, bool aggregate
)
2266 const struct ofp11_flow_stats_request
*ofsr
;
2269 ofsr
= ofpbuf_pull(b
, sizeof *ofsr
);
2270 fsr
->aggregate
= aggregate
;
2271 fsr
->table_id
= ofsr
->table_id
;
2272 error
= ofputil_port_from_ofp11(ofsr
->out_port
, &fsr
->out_port
);
2276 fsr
->out_group
= ntohl(ofsr
->out_group
);
2277 fsr
->cookie
= ofsr
->cookie
;
2278 fsr
->cookie_mask
= ofsr
->cookie_mask
;
2279 error
= ofputil_pull_ofp11_match(b
, &fsr
->match
, NULL
);
2288 ofputil_decode_nxst_flow_request(struct ofputil_flow_stats_request
*fsr
,
2289 struct ofpbuf
*b
, bool aggregate
)
2291 const struct nx_flow_stats_request
*nfsr
;
2294 nfsr
= ofpbuf_pull(b
, sizeof *nfsr
);
2295 error
= nx_pull_match(b
, ntohs(nfsr
->match_len
), &fsr
->match
,
2296 &fsr
->cookie
, &fsr
->cookie_mask
);
2300 if (ofpbuf_size(b
)) {
2301 return OFPERR_OFPBRC_BAD_LEN
;
2304 fsr
->aggregate
= aggregate
;
2305 fsr
->out_port
= u16_to_ofp(ntohs(nfsr
->out_port
));
2306 fsr
->out_group
= OFPG11_ANY
;
2307 fsr
->table_id
= nfsr
->table_id
;
2312 /* Constructs and returns an OFPT_QUEUE_GET_CONFIG request for the specified
2313 * 'port', suitable for OpenFlow version 'version'. */
2315 ofputil_encode_queue_get_config_request(enum ofp_version version
,
2318 struct ofpbuf
*request
;
2320 if (version
== OFP10_VERSION
) {
2321 struct ofp10_queue_get_config_request
*qgcr10
;
2323 request
= ofpraw_alloc(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
,
2325 qgcr10
= ofpbuf_put_zeros(request
, sizeof *qgcr10
);
2326 qgcr10
->port
= htons(ofp_to_u16(port
));
2328 struct ofp11_queue_get_config_request
*qgcr11
;
2330 request
= ofpraw_alloc(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
,
2332 qgcr11
= ofpbuf_put_zeros(request
, sizeof *qgcr11
);
2333 qgcr11
->port
= ofputil_port_to_ofp11(port
);
2339 /* Parses OFPT_QUEUE_GET_CONFIG request 'oh', storing the port specified by the
2340 * request into '*port'. Returns 0 if successful, otherwise an OpenFlow error
2343 ofputil_decode_queue_get_config_request(const struct ofp_header
*oh
,
2346 const struct ofp10_queue_get_config_request
*qgcr10
;
2347 const struct ofp11_queue_get_config_request
*qgcr11
;
2351 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2352 raw
= ofpraw_pull_assert(&b
);
2354 switch ((int) raw
) {
2355 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
:
2356 qgcr10
= ofpbuf_data(&b
);
2357 *port
= u16_to_ofp(ntohs(qgcr10
->port
));
2360 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
:
2361 qgcr11
= ofpbuf_data(&b
);
2362 return ofputil_port_from_ofp11(qgcr11
->port
, port
);
2368 /* Constructs and returns the beginning of a reply to
2369 * OFPT_QUEUE_GET_CONFIG_REQUEST 'oh'. The caller may append information about
2370 * individual queues with ofputil_append_queue_get_config_reply(). */
2372 ofputil_encode_queue_get_config_reply(const struct ofp_header
*oh
)
2374 struct ofp10_queue_get_config_reply
*qgcr10
;
2375 struct ofp11_queue_get_config_reply
*qgcr11
;
2376 struct ofpbuf
*reply
;
2382 error
= ofputil_decode_queue_get_config_request(oh
, &port
);
2385 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2386 raw
= ofpraw_pull_assert(&b
);
2388 switch ((int) raw
) {
2389 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST
:
2390 reply
= ofpraw_alloc_reply(OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY
,
2392 qgcr10
= ofpbuf_put_zeros(reply
, sizeof *qgcr10
);
2393 qgcr10
->port
= htons(ofp_to_u16(port
));
2396 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST
:
2397 reply
= ofpraw_alloc_reply(OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY
,
2399 qgcr11
= ofpbuf_put_zeros(reply
, sizeof *qgcr11
);
2400 qgcr11
->port
= ofputil_port_to_ofp11(port
);
2411 put_queue_rate(struct ofpbuf
*reply
, enum ofp_queue_properties property
,
2414 if (rate
!= UINT16_MAX
) {
2415 struct ofp_queue_prop_rate
*oqpr
;
2417 oqpr
= ofpbuf_put_zeros(reply
, sizeof *oqpr
);
2418 oqpr
->prop_header
.property
= htons(property
);
2419 oqpr
->prop_header
.len
= htons(sizeof *oqpr
);
2420 oqpr
->rate
= htons(rate
);
2424 /* Appends a queue description for 'queue_id' to the
2425 * OFPT_QUEUE_GET_CONFIG_REPLY already in 'oh'. */
2427 ofputil_append_queue_get_config_reply(struct ofpbuf
*reply
,
2428 const struct ofputil_queue_config
*oqc
)
2430 const struct ofp_header
*oh
= ofpbuf_data(reply
);
2431 size_t start_ofs
, len_ofs
;
2434 start_ofs
= ofpbuf_size(reply
);
2435 if (oh
->version
< OFP12_VERSION
) {
2436 struct ofp10_packet_queue
*opq10
;
2438 opq10
= ofpbuf_put_zeros(reply
, sizeof *opq10
);
2439 opq10
->queue_id
= htonl(oqc
->queue_id
);
2440 len_ofs
= (char *) &opq10
->len
- (char *) ofpbuf_data(reply
);
2442 struct ofp11_queue_get_config_reply
*qgcr11
;
2443 struct ofp12_packet_queue
*opq12
;
2446 qgcr11
= ofpbuf_l3(reply
);
2447 port
= qgcr11
->port
;
2449 opq12
= ofpbuf_put_zeros(reply
, sizeof *opq12
);
2451 opq12
->queue_id
= htonl(oqc
->queue_id
);
2452 len_ofs
= (char *) &opq12
->len
- (char *) ofpbuf_data(reply
);
2455 put_queue_rate(reply
, OFPQT_MIN_RATE
, oqc
->min_rate
);
2456 put_queue_rate(reply
, OFPQT_MAX_RATE
, oqc
->max_rate
);
2458 len
= ofpbuf_at(reply
, len_ofs
, sizeof *len
);
2459 *len
= htons(ofpbuf_size(reply
) - start_ofs
);
2462 /* Decodes the initial part of an OFPT_QUEUE_GET_CONFIG_REPLY from 'reply' and
2463 * stores in '*port' the port that the reply is about. The caller may call
2464 * ofputil_pull_queue_get_config_reply() to obtain information about individual
2465 * queues included in the reply. Returns 0 if successful, otherwise an
2468 ofputil_decode_queue_get_config_reply(struct ofpbuf
*reply
, ofp_port_t
*port
)
2470 const struct ofp10_queue_get_config_reply
*qgcr10
;
2471 const struct ofp11_queue_get_config_reply
*qgcr11
;
2474 raw
= ofpraw_pull_assert(reply
);
2475 switch ((int) raw
) {
2476 case OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY
:
2477 qgcr10
= ofpbuf_pull(reply
, sizeof *qgcr10
);
2478 *port
= u16_to_ofp(ntohs(qgcr10
->port
));
2481 case OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY
:
2482 qgcr11
= ofpbuf_pull(reply
, sizeof *qgcr11
);
2483 return ofputil_port_from_ofp11(qgcr11
->port
, port
);
2490 parse_queue_rate(const struct ofp_queue_prop_header
*hdr
, uint16_t *rate
)
2492 const struct ofp_queue_prop_rate
*oqpr
;
2494 if (hdr
->len
== htons(sizeof *oqpr
)) {
2495 oqpr
= (const struct ofp_queue_prop_rate
*) hdr
;
2496 *rate
= ntohs(oqpr
->rate
);
2499 return OFPERR_OFPBRC_BAD_LEN
;
2503 /* Decodes information about a queue from the OFPT_QUEUE_GET_CONFIG_REPLY in
2504 * 'reply' and stores it in '*queue'. ofputil_decode_queue_get_config_reply()
2505 * must already have pulled off the main header.
2507 * This function returns EOF if the last queue has already been decoded, 0 if a
2508 * queue was successfully decoded into '*queue', or an ofperr if there was a
2509 * problem decoding 'reply'. */
2511 ofputil_pull_queue_get_config_reply(struct ofpbuf
*reply
,
2512 struct ofputil_queue_config
*queue
)
2514 const struct ofp_header
*oh
;
2515 unsigned int opq_len
;
2518 if (!ofpbuf_size(reply
)) {
2522 queue
->min_rate
= UINT16_MAX
;
2523 queue
->max_rate
= UINT16_MAX
;
2526 if (oh
->version
< OFP12_VERSION
) {
2527 const struct ofp10_packet_queue
*opq10
;
2529 opq10
= ofpbuf_try_pull(reply
, sizeof *opq10
);
2531 return OFPERR_OFPBRC_BAD_LEN
;
2533 queue
->queue_id
= ntohl(opq10
->queue_id
);
2534 len
= ntohs(opq10
->len
);
2535 opq_len
= sizeof *opq10
;
2537 const struct ofp12_packet_queue
*opq12
;
2539 opq12
= ofpbuf_try_pull(reply
, sizeof *opq12
);
2541 return OFPERR_OFPBRC_BAD_LEN
;
2543 queue
->queue_id
= ntohl(opq12
->queue_id
);
2544 len
= ntohs(opq12
->len
);
2545 opq_len
= sizeof *opq12
;
2548 if (len
< opq_len
|| len
> ofpbuf_size(reply
) + opq_len
|| len
% 8) {
2549 return OFPERR_OFPBRC_BAD_LEN
;
2554 const struct ofp_queue_prop_header
*hdr
;
2555 unsigned int property
;
2556 unsigned int prop_len
;
2557 enum ofperr error
= 0;
2559 hdr
= ofpbuf_at_assert(reply
, 0, sizeof *hdr
);
2560 prop_len
= ntohs(hdr
->len
);
2561 if (prop_len
< sizeof *hdr
|| prop_len
> ofpbuf_size(reply
) || prop_len
% 8) {
2562 return OFPERR_OFPBRC_BAD_LEN
;
2565 property
= ntohs(hdr
->property
);
2567 case OFPQT_MIN_RATE
:
2568 error
= parse_queue_rate(hdr
, &queue
->min_rate
);
2571 case OFPQT_MAX_RATE
:
2572 error
= parse_queue_rate(hdr
, &queue
->max_rate
);
2576 VLOG_INFO_RL(&bad_ofmsg_rl
, "unknown queue property %u", property
);
2583 ofpbuf_pull(reply
, prop_len
);
2589 /* Converts an OFPST_FLOW, OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE
2590 * request 'oh', into an abstract flow_stats_request in 'fsr'. Returns 0 if
2591 * successful, otherwise an OpenFlow error code. */
2593 ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request
*fsr
,
2594 const struct ofp_header
*oh
)
2599 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
2600 raw
= ofpraw_pull_assert(&b
);
2601 switch ((int) raw
) {
2602 case OFPRAW_OFPST10_FLOW_REQUEST
:
2603 return ofputil_decode_ofpst10_flow_request(fsr
, ofpbuf_data(&b
), false);
2605 case OFPRAW_OFPST10_AGGREGATE_REQUEST
:
2606 return ofputil_decode_ofpst10_flow_request(fsr
, ofpbuf_data(&b
), true);
2608 case OFPRAW_OFPST11_FLOW_REQUEST
:
2609 return ofputil_decode_ofpst11_flow_request(fsr
, &b
, false);
2611 case OFPRAW_OFPST11_AGGREGATE_REQUEST
:
2612 return ofputil_decode_ofpst11_flow_request(fsr
, &b
, true);
2614 case OFPRAW_NXST_FLOW_REQUEST
:
2615 return ofputil_decode_nxst_flow_request(fsr
, &b
, false);
2617 case OFPRAW_NXST_AGGREGATE_REQUEST
:
2618 return ofputil_decode_nxst_flow_request(fsr
, &b
, true);
2621 /* Hey, the caller lied. */
2626 /* Converts abstract flow_stats_request 'fsr' into an OFPST_FLOW,
2627 * OFPST_AGGREGATE, NXST_FLOW, or NXST_AGGREGATE request 'oh' according to
2628 * 'protocol', and returns the message. */
2630 ofputil_encode_flow_stats_request(const struct ofputil_flow_stats_request
*fsr
,
2631 enum ofputil_protocol protocol
)
2637 case OFPUTIL_P_OF11_STD
:
2638 case OFPUTIL_P_OF12_OXM
:
2639 case OFPUTIL_P_OF13_OXM
:
2640 case OFPUTIL_P_OF14_OXM
: {
2641 struct ofp11_flow_stats_request
*ofsr
;
2643 raw
= (fsr
->aggregate
2644 ? OFPRAW_OFPST11_AGGREGATE_REQUEST
2645 : OFPRAW_OFPST11_FLOW_REQUEST
);
2646 msg
= ofpraw_alloc(raw
, ofputil_protocol_to_ofp_version(protocol
),
2647 ofputil_match_typical_len(protocol
));
2648 ofsr
= ofpbuf_put_zeros(msg
, sizeof *ofsr
);
2649 ofsr
->table_id
= fsr
->table_id
;
2650 ofsr
->out_port
= ofputil_port_to_ofp11(fsr
->out_port
);
2651 ofsr
->out_group
= htonl(fsr
->out_group
);
2652 ofsr
->cookie
= fsr
->cookie
;
2653 ofsr
->cookie_mask
= fsr
->cookie_mask
;
2654 ofputil_put_ofp11_match(msg
, &fsr
->match
, protocol
);
2658 case OFPUTIL_P_OF10_STD
:
2659 case OFPUTIL_P_OF10_STD_TID
: {
2660 struct ofp10_flow_stats_request
*ofsr
;
2662 raw
= (fsr
->aggregate
2663 ? OFPRAW_OFPST10_AGGREGATE_REQUEST
2664 : OFPRAW_OFPST10_FLOW_REQUEST
);
2665 msg
= ofpraw_alloc(raw
, OFP10_VERSION
, 0);
2666 ofsr
= ofpbuf_put_zeros(msg
, sizeof *ofsr
);
2667 ofputil_match_to_ofp10_match(&fsr
->match
, &ofsr
->match
);
2668 ofsr
->table_id
= fsr
->table_id
;
2669 ofsr
->out_port
= htons(ofp_to_u16(fsr
->out_port
));
2673 case OFPUTIL_P_OF10_NXM
:
2674 case OFPUTIL_P_OF10_NXM_TID
: {
2675 struct nx_flow_stats_request
*nfsr
;
2678 raw
= (fsr
->aggregate
2679 ? OFPRAW_NXST_AGGREGATE_REQUEST
2680 : OFPRAW_NXST_FLOW_REQUEST
);
2681 msg
= ofpraw_alloc(raw
, OFP10_VERSION
, NXM_TYPICAL_LEN
);
2682 ofpbuf_put_zeros(msg
, sizeof *nfsr
);
2683 match_len
= nx_put_match(msg
, &fsr
->match
,
2684 fsr
->cookie
, fsr
->cookie_mask
);
2686 nfsr
= ofpbuf_l3(msg
);
2687 nfsr
->out_port
= htons(ofp_to_u16(fsr
->out_port
));
2688 nfsr
->match_len
= htons(match_len
);
2689 nfsr
->table_id
= fsr
->table_id
;
2700 /* Converts an OFPST_FLOW or NXST_FLOW reply in 'msg' into an abstract
2701 * ofputil_flow_stats in 'fs'.
2703 * Multiple OFPST_FLOW or NXST_FLOW replies can be packed into a single
2704 * OpenFlow message. Calling this function multiple times for a single 'msg'
2705 * iterates through the replies. The caller must initially leave 'msg''s layer
2706 * pointers null and not modify them between calls.
2708 * Most switches don't send the values needed to populate fs->idle_age and
2709 * fs->hard_age, so those members will usually be set to 0. If the switch from
2710 * which 'msg' originated is known to implement NXT_FLOW_AGE, then pass
2711 * 'flow_age_extension' as true so that the contents of 'msg' determine the
2712 * 'idle_age' and 'hard_age' members in 'fs'.
2714 * Uses 'ofpacts' to store the abstract OFPACT_* version of the flow stats
2715 * reply's actions. The caller must initialize 'ofpacts' and retains ownership
2716 * of it. 'fs->ofpacts' will point into the 'ofpacts' buffer.
2718 * Returns 0 if successful, EOF if no replies were left in this 'msg',
2719 * otherwise a positive errno value. */
2721 ofputil_decode_flow_stats_reply(struct ofputil_flow_stats
*fs
,
2723 bool flow_age_extension
,
2724 struct ofpbuf
*ofpacts
)
2726 const struct ofp_header
*oh
;
2731 ? ofpraw_decode(&raw
, msg
->frame
)
2732 : ofpraw_pull(&raw
, msg
));
2738 if (!ofpbuf_size(msg
)) {
2740 } else if (raw
== OFPRAW_OFPST11_FLOW_REPLY
2741 || raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2742 const struct ofp11_flow_stats
*ofs
;
2744 uint16_t padded_match_len
;
2746 ofs
= ofpbuf_try_pull(msg
, sizeof *ofs
);
2748 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply has %"PRIu32
" leftover "
2749 "bytes at end", ofpbuf_size(msg
));
2753 length
= ntohs(ofs
->length
);
2754 if (length
< sizeof *ofs
) {
2755 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply claims invalid "
2756 "length %"PRIuSIZE
, length
);
2760 if (ofputil_pull_ofp11_match(msg
, &fs
->match
, &padded_match_len
)) {
2761 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply bad match");
2765 if (ofpacts_pull_openflow_instructions(msg
, length
- sizeof *ofs
-
2766 padded_match_len
, oh
->version
,
2768 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply bad instructions");
2772 fs
->priority
= ntohs(ofs
->priority
);
2773 fs
->table_id
= ofs
->table_id
;
2774 fs
->duration_sec
= ntohl(ofs
->duration_sec
);
2775 fs
->duration_nsec
= ntohl(ofs
->duration_nsec
);
2776 fs
->idle_timeout
= ntohs(ofs
->idle_timeout
);
2777 fs
->hard_timeout
= ntohs(ofs
->hard_timeout
);
2778 if (raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2779 error
= ofputil_decode_flow_mod_flags(ofs
->flags
, -1, oh
->version
,
2789 fs
->cookie
= ofs
->cookie
;
2790 fs
->packet_count
= ntohll(ofs
->packet_count
);
2791 fs
->byte_count
= ntohll(ofs
->byte_count
);
2792 } else if (raw
== OFPRAW_OFPST10_FLOW_REPLY
) {
2793 const struct ofp10_flow_stats
*ofs
;
2796 ofs
= ofpbuf_try_pull(msg
, sizeof *ofs
);
2798 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply has %"PRIu32
" leftover "
2799 "bytes at end", ofpbuf_size(msg
));
2803 length
= ntohs(ofs
->length
);
2804 if (length
< sizeof *ofs
) {
2805 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_FLOW reply claims invalid "
2806 "length %"PRIuSIZE
, length
);
2810 if (ofpacts_pull_openflow_actions(msg
, length
- sizeof *ofs
,
2811 oh
->version
, ofpacts
)) {
2815 fs
->cookie
= get_32aligned_be64(&ofs
->cookie
);
2816 ofputil_match_from_ofp10_match(&ofs
->match
, &fs
->match
);
2817 fs
->priority
= ntohs(ofs
->priority
);
2818 fs
->table_id
= ofs
->table_id
;
2819 fs
->duration_sec
= ntohl(ofs
->duration_sec
);
2820 fs
->duration_nsec
= ntohl(ofs
->duration_nsec
);
2821 fs
->idle_timeout
= ntohs(ofs
->idle_timeout
);
2822 fs
->hard_timeout
= ntohs(ofs
->hard_timeout
);
2825 fs
->packet_count
= ntohll(get_32aligned_be64(&ofs
->packet_count
));
2826 fs
->byte_count
= ntohll(get_32aligned_be64(&ofs
->byte_count
));
2828 } else if (raw
== OFPRAW_NXST_FLOW_REPLY
) {
2829 const struct nx_flow_stats
*nfs
;
2830 size_t match_len
, actions_len
, length
;
2832 nfs
= ofpbuf_try_pull(msg
, sizeof *nfs
);
2834 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW reply has %"PRIu32
" leftover "
2835 "bytes at end", ofpbuf_size(msg
));
2839 length
= ntohs(nfs
->length
);
2840 match_len
= ntohs(nfs
->match_len
);
2841 if (length
< sizeof *nfs
+ ROUND_UP(match_len
, 8)) {
2842 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW reply with match_len=%"PRIuSIZE
" "
2843 "claims invalid length %"PRIuSIZE
, match_len
, length
);
2846 if (nx_pull_match(msg
, match_len
, &fs
->match
, NULL
, NULL
)) {
2850 actions_len
= length
- sizeof *nfs
- ROUND_UP(match_len
, 8);
2851 if (ofpacts_pull_openflow_actions(msg
, actions_len
, oh
->version
,
2856 fs
->cookie
= nfs
->cookie
;
2857 fs
->table_id
= nfs
->table_id
;
2858 fs
->duration_sec
= ntohl(nfs
->duration_sec
);
2859 fs
->duration_nsec
= ntohl(nfs
->duration_nsec
);
2860 fs
->priority
= ntohs(nfs
->priority
);
2861 fs
->idle_timeout
= ntohs(nfs
->idle_timeout
);
2862 fs
->hard_timeout
= ntohs(nfs
->hard_timeout
);
2865 if (flow_age_extension
) {
2866 if (nfs
->idle_age
) {
2867 fs
->idle_age
= ntohs(nfs
->idle_age
) - 1;
2869 if (nfs
->hard_age
) {
2870 fs
->hard_age
= ntohs(nfs
->hard_age
) - 1;
2873 fs
->packet_count
= ntohll(nfs
->packet_count
);
2874 fs
->byte_count
= ntohll(nfs
->byte_count
);
2880 fs
->ofpacts
= ofpbuf_data(ofpacts
);
2881 fs
->ofpacts_len
= ofpbuf_size(ofpacts
);
2886 /* Returns 'count' unchanged except that UINT64_MAX becomes 0.
2888 * We use this in situations where OVS internally uses UINT64_MAX to mean
2889 * "value unknown" but OpenFlow 1.0 does not define any unknown value. */
2891 unknown_to_zero(uint64_t count
)
2893 return count
!= UINT64_MAX
? count
: 0;
2896 /* Appends an OFPST_FLOW or NXST_FLOW reply that contains the data in 'fs' to
2897 * those already present in the list of ofpbufs in 'replies'. 'replies' should
2898 * have been initialized with ofpmp_init(). */
2900 ofputil_append_flow_stats_reply(const struct ofputil_flow_stats
*fs
,
2901 struct list
*replies
)
2903 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
2904 size_t start_ofs
= ofpbuf_size(reply
);
2905 enum ofp_version version
= ofpmp_version(replies
);
2906 enum ofpraw raw
= ofpmp_decode_raw(replies
);
2908 if (raw
== OFPRAW_OFPST11_FLOW_REPLY
|| raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2909 struct ofp11_flow_stats
*ofs
;
2911 ofpbuf_put_uninit(reply
, sizeof *ofs
);
2912 oxm_put_match(reply
, &fs
->match
);
2913 ofpacts_put_openflow_instructions(fs
->ofpacts
, fs
->ofpacts_len
, reply
,
2916 ofs
= ofpbuf_at_assert(reply
, start_ofs
, sizeof *ofs
);
2917 ofs
->length
= htons(ofpbuf_size(reply
) - start_ofs
);
2918 ofs
->table_id
= fs
->table_id
;
2920 ofs
->duration_sec
= htonl(fs
->duration_sec
);
2921 ofs
->duration_nsec
= htonl(fs
->duration_nsec
);
2922 ofs
->priority
= htons(fs
->priority
);
2923 ofs
->idle_timeout
= htons(fs
->idle_timeout
);
2924 ofs
->hard_timeout
= htons(fs
->hard_timeout
);
2925 if (raw
== OFPRAW_OFPST13_FLOW_REPLY
) {
2926 ofs
->flags
= ofputil_encode_flow_mod_flags(fs
->flags
, version
);
2930 memset(ofs
->pad2
, 0, sizeof ofs
->pad2
);
2931 ofs
->cookie
= fs
->cookie
;
2932 ofs
->packet_count
= htonll(unknown_to_zero(fs
->packet_count
));
2933 ofs
->byte_count
= htonll(unknown_to_zero(fs
->byte_count
));
2934 } else if (raw
== OFPRAW_OFPST10_FLOW_REPLY
) {
2935 struct ofp10_flow_stats
*ofs
;
2937 ofpbuf_put_uninit(reply
, sizeof *ofs
);
2938 ofpacts_put_openflow_actions(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 ofputil_match_to_ofp10_match(&fs
->match
, &ofs
->match
);
2945 ofs
->duration_sec
= htonl(fs
->duration_sec
);
2946 ofs
->duration_nsec
= htonl(fs
->duration_nsec
);
2947 ofs
->priority
= htons(fs
->priority
);
2948 ofs
->idle_timeout
= htons(fs
->idle_timeout
);
2949 ofs
->hard_timeout
= htons(fs
->hard_timeout
);
2950 memset(ofs
->pad2
, 0, sizeof ofs
->pad2
);
2951 put_32aligned_be64(&ofs
->cookie
, fs
->cookie
);
2952 put_32aligned_be64(&ofs
->packet_count
,
2953 htonll(unknown_to_zero(fs
->packet_count
)));
2954 put_32aligned_be64(&ofs
->byte_count
,
2955 htonll(unknown_to_zero(fs
->byte_count
)));
2956 } else if (raw
== OFPRAW_NXST_FLOW_REPLY
) {
2957 struct nx_flow_stats
*nfs
;
2960 ofpbuf_put_uninit(reply
, sizeof *nfs
);
2961 match_len
= nx_put_match(reply
, &fs
->match
, 0, 0);
2962 ofpacts_put_openflow_actions(fs
->ofpacts
, fs
->ofpacts_len
, reply
,
2964 nfs
= ofpbuf_at_assert(reply
, start_ofs
, sizeof *nfs
);
2965 nfs
->length
= htons(ofpbuf_size(reply
) - start_ofs
);
2966 nfs
->table_id
= fs
->table_id
;
2968 nfs
->duration_sec
= htonl(fs
->duration_sec
);
2969 nfs
->duration_nsec
= htonl(fs
->duration_nsec
);
2970 nfs
->priority
= htons(fs
->priority
);
2971 nfs
->idle_timeout
= htons(fs
->idle_timeout
);
2972 nfs
->hard_timeout
= htons(fs
->hard_timeout
);
2973 nfs
->idle_age
= htons(fs
->idle_age
< 0 ? 0
2974 : fs
->idle_age
< UINT16_MAX
? fs
->idle_age
+ 1
2976 nfs
->hard_age
= htons(fs
->hard_age
< 0 ? 0
2977 : fs
->hard_age
< UINT16_MAX
? fs
->hard_age
+ 1
2979 nfs
->match_len
= htons(match_len
);
2980 nfs
->cookie
= fs
->cookie
;
2981 nfs
->packet_count
= htonll(fs
->packet_count
);
2982 nfs
->byte_count
= htonll(fs
->byte_count
);
2987 ofpmp_postappend(replies
, start_ofs
);
2990 /* Converts abstract ofputil_aggregate_stats 'stats' into an OFPST_AGGREGATE or
2991 * NXST_AGGREGATE reply matching 'request', and returns the message. */
2993 ofputil_encode_aggregate_stats_reply(
2994 const struct ofputil_aggregate_stats
*stats
,
2995 const struct ofp_header
*request
)
2997 struct ofp_aggregate_stats_reply
*asr
;
2998 uint64_t packet_count
;
2999 uint64_t byte_count
;
3003 ofpraw_decode(&raw
, request
);
3004 if (raw
== OFPRAW_OFPST10_AGGREGATE_REQUEST
) {
3005 packet_count
= unknown_to_zero(stats
->packet_count
);
3006 byte_count
= unknown_to_zero(stats
->byte_count
);
3008 packet_count
= stats
->packet_count
;
3009 byte_count
= stats
->byte_count
;
3012 msg
= ofpraw_alloc_stats_reply(request
, 0);
3013 asr
= ofpbuf_put_zeros(msg
, sizeof *asr
);
3014 put_32aligned_be64(&asr
->packet_count
, htonll(packet_count
));
3015 put_32aligned_be64(&asr
->byte_count
, htonll(byte_count
));
3016 asr
->flow_count
= htonl(stats
->flow_count
);
3022 ofputil_decode_aggregate_stats_reply(struct ofputil_aggregate_stats
*stats
,
3023 const struct ofp_header
*reply
)
3025 struct ofp_aggregate_stats_reply
*asr
;
3028 ofpbuf_use_const(&msg
, reply
, ntohs(reply
->length
));
3029 ofpraw_pull_assert(&msg
);
3031 asr
= ofpbuf_l3(&msg
);
3032 stats
->packet_count
= ntohll(get_32aligned_be64(&asr
->packet_count
));
3033 stats
->byte_count
= ntohll(get_32aligned_be64(&asr
->byte_count
));
3034 stats
->flow_count
= ntohl(asr
->flow_count
);
3039 /* Converts an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message 'oh' into an
3040 * abstract ofputil_flow_removed in 'fr'. Returns 0 if successful, otherwise
3041 * an OpenFlow error code. */
3043 ofputil_decode_flow_removed(struct ofputil_flow_removed
*fr
,
3044 const struct ofp_header
*oh
)
3049 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3050 raw
= ofpraw_pull_assert(&b
);
3051 if (raw
== OFPRAW_OFPT11_FLOW_REMOVED
) {
3052 const struct ofp12_flow_removed
*ofr
;
3055 ofr
= ofpbuf_pull(&b
, sizeof *ofr
);
3057 error
= ofputil_pull_ofp11_match(&b
, &fr
->match
, NULL
);
3062 fr
->priority
= ntohs(ofr
->priority
);
3063 fr
->cookie
= ofr
->cookie
;
3064 fr
->reason
= ofr
->reason
;
3065 fr
->table_id
= ofr
->table_id
;
3066 fr
->duration_sec
= ntohl(ofr
->duration_sec
);
3067 fr
->duration_nsec
= ntohl(ofr
->duration_nsec
);
3068 fr
->idle_timeout
= ntohs(ofr
->idle_timeout
);
3069 fr
->hard_timeout
= ntohs(ofr
->hard_timeout
);
3070 fr
->packet_count
= ntohll(ofr
->packet_count
);
3071 fr
->byte_count
= ntohll(ofr
->byte_count
);
3072 } else if (raw
== OFPRAW_OFPT10_FLOW_REMOVED
) {
3073 const struct ofp10_flow_removed
*ofr
;
3075 ofr
= ofpbuf_pull(&b
, sizeof *ofr
);
3077 ofputil_match_from_ofp10_match(&ofr
->match
, &fr
->match
);
3078 fr
->priority
= ntohs(ofr
->priority
);
3079 fr
->cookie
= ofr
->cookie
;
3080 fr
->reason
= ofr
->reason
;
3082 fr
->duration_sec
= ntohl(ofr
->duration_sec
);
3083 fr
->duration_nsec
= ntohl(ofr
->duration_nsec
);
3084 fr
->idle_timeout
= ntohs(ofr
->idle_timeout
);
3085 fr
->hard_timeout
= 0;
3086 fr
->packet_count
= ntohll(ofr
->packet_count
);
3087 fr
->byte_count
= ntohll(ofr
->byte_count
);
3088 } else if (raw
== OFPRAW_NXT_FLOW_REMOVED
) {
3089 struct nx_flow_removed
*nfr
;
3092 nfr
= ofpbuf_pull(&b
, sizeof *nfr
);
3093 error
= nx_pull_match(&b
, ntohs(nfr
->match_len
), &fr
->match
,
3098 if (ofpbuf_size(&b
)) {
3099 return OFPERR_OFPBRC_BAD_LEN
;
3102 fr
->priority
= ntohs(nfr
->priority
);
3103 fr
->cookie
= nfr
->cookie
;
3104 fr
->reason
= nfr
->reason
;
3105 fr
->table_id
= nfr
->table_id
? nfr
->table_id
- 1 : 255;
3106 fr
->duration_sec
= ntohl(nfr
->duration_sec
);
3107 fr
->duration_nsec
= ntohl(nfr
->duration_nsec
);
3108 fr
->idle_timeout
= ntohs(nfr
->idle_timeout
);
3109 fr
->hard_timeout
= 0;
3110 fr
->packet_count
= ntohll(nfr
->packet_count
);
3111 fr
->byte_count
= ntohll(nfr
->byte_count
);
3119 /* Converts abstract ofputil_flow_removed 'fr' into an OFPT_FLOW_REMOVED or
3120 * NXT_FLOW_REMOVED message 'oh' according to 'protocol', and returns the
3123 ofputil_encode_flow_removed(const struct ofputil_flow_removed
*fr
,
3124 enum ofputil_protocol protocol
)
3129 case OFPUTIL_P_OF11_STD
:
3130 case OFPUTIL_P_OF12_OXM
:
3131 case OFPUTIL_P_OF13_OXM
:
3132 case OFPUTIL_P_OF14_OXM
: {
3133 struct ofp12_flow_removed
*ofr
;
3135 msg
= ofpraw_alloc_xid(OFPRAW_OFPT11_FLOW_REMOVED
,
3136 ofputil_protocol_to_ofp_version(protocol
),
3138 ofputil_match_typical_len(protocol
));
3139 ofr
= ofpbuf_put_zeros(msg
, sizeof *ofr
);
3140 ofr
->cookie
= fr
->cookie
;
3141 ofr
->priority
= htons(fr
->priority
);
3142 ofr
->reason
= fr
->reason
;
3143 ofr
->table_id
= fr
->table_id
;
3144 ofr
->duration_sec
= htonl(fr
->duration_sec
);
3145 ofr
->duration_nsec
= htonl(fr
->duration_nsec
);
3146 ofr
->idle_timeout
= htons(fr
->idle_timeout
);
3147 ofr
->hard_timeout
= htons(fr
->hard_timeout
);
3148 ofr
->packet_count
= htonll(fr
->packet_count
);
3149 ofr
->byte_count
= htonll(fr
->byte_count
);
3150 ofputil_put_ofp11_match(msg
, &fr
->match
, protocol
);
3154 case OFPUTIL_P_OF10_STD
:
3155 case OFPUTIL_P_OF10_STD_TID
: {
3156 struct ofp10_flow_removed
*ofr
;
3158 msg
= ofpraw_alloc_xid(OFPRAW_OFPT10_FLOW_REMOVED
, OFP10_VERSION
,
3160 ofr
= ofpbuf_put_zeros(msg
, sizeof *ofr
);
3161 ofputil_match_to_ofp10_match(&fr
->match
, &ofr
->match
);
3162 ofr
->cookie
= fr
->cookie
;
3163 ofr
->priority
= htons(fr
->priority
);
3164 ofr
->reason
= fr
->reason
;
3165 ofr
->duration_sec
= htonl(fr
->duration_sec
);
3166 ofr
->duration_nsec
= htonl(fr
->duration_nsec
);
3167 ofr
->idle_timeout
= htons(fr
->idle_timeout
);
3168 ofr
->packet_count
= htonll(unknown_to_zero(fr
->packet_count
));
3169 ofr
->byte_count
= htonll(unknown_to_zero(fr
->byte_count
));
3173 case OFPUTIL_P_OF10_NXM
:
3174 case OFPUTIL_P_OF10_NXM_TID
: {
3175 struct nx_flow_removed
*nfr
;
3178 msg
= ofpraw_alloc_xid(OFPRAW_NXT_FLOW_REMOVED
, OFP10_VERSION
,
3179 htonl(0), NXM_TYPICAL_LEN
);
3180 nfr
= ofpbuf_put_zeros(msg
, sizeof *nfr
);
3181 match_len
= nx_put_match(msg
, &fr
->match
, 0, 0);
3183 nfr
= ofpbuf_l3(msg
);
3184 nfr
->cookie
= fr
->cookie
;
3185 nfr
->priority
= htons(fr
->priority
);
3186 nfr
->reason
= fr
->reason
;
3187 nfr
->table_id
= fr
->table_id
+ 1;
3188 nfr
->duration_sec
= htonl(fr
->duration_sec
);
3189 nfr
->duration_nsec
= htonl(fr
->duration_nsec
);
3190 nfr
->idle_timeout
= htons(fr
->idle_timeout
);
3191 nfr
->match_len
= htons(match_len
);
3192 nfr
->packet_count
= htonll(fr
->packet_count
);
3193 nfr
->byte_count
= htonll(fr
->byte_count
);
3205 ofputil_decode_packet_in_finish(struct ofputil_packet_in
*pin
,
3206 struct match
*match
, struct ofpbuf
*b
)
3208 pin
->packet
= ofpbuf_data(b
);
3209 pin
->packet_len
= ofpbuf_size(b
);
3211 pin
->fmd
.in_port
= match
->flow
.in_port
.ofp_port
;
3212 pin
->fmd
.tun_id
= match
->flow
.tunnel
.tun_id
;
3213 pin
->fmd
.tun_src
= match
->flow
.tunnel
.ip_src
;
3214 pin
->fmd
.tun_dst
= match
->flow
.tunnel
.ip_dst
;
3215 pin
->fmd
.metadata
= match
->flow
.metadata
;
3216 memcpy(pin
->fmd
.regs
, match
->flow
.regs
, sizeof pin
->fmd
.regs
);
3217 pin
->fmd
.pkt_mark
= match
->flow
.pkt_mark
;
3221 ofputil_decode_packet_in(struct ofputil_packet_in
*pin
,
3222 const struct ofp_header
*oh
)
3227 memset(pin
, 0, sizeof *pin
);
3228 pin
->cookie
= OVS_BE64_MAX
;
3230 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3231 raw
= ofpraw_pull_assert(&b
);
3232 if (raw
== OFPRAW_OFPT13_PACKET_IN
|| raw
== OFPRAW_OFPT12_PACKET_IN
) {
3233 const struct ofp13_packet_in
*opi
;
3236 size_t packet_in_size
;
3238 if (raw
== OFPRAW_OFPT12_PACKET_IN
) {
3239 packet_in_size
= sizeof (struct ofp12_packet_in
);
3241 packet_in_size
= sizeof (struct ofp13_packet_in
);
3244 opi
= ofpbuf_pull(&b
, packet_in_size
);
3245 error
= oxm_pull_match_loose(&b
, &match
);
3250 if (!ofpbuf_try_pull(&b
, 2)) {
3251 return OFPERR_OFPBRC_BAD_LEN
;
3254 pin
->reason
= opi
->pi
.reason
;
3255 pin
->table_id
= opi
->pi
.table_id
;
3256 pin
->buffer_id
= ntohl(opi
->pi
.buffer_id
);
3257 pin
->total_len
= ntohs(opi
->pi
.total_len
);
3259 if (raw
== OFPRAW_OFPT13_PACKET_IN
) {
3260 pin
->cookie
= opi
->cookie
;
3263 ofputil_decode_packet_in_finish(pin
, &match
, &b
);
3264 } else if (raw
== OFPRAW_OFPT10_PACKET_IN
) {
3265 const struct ofp10_packet_in
*opi
;
3267 opi
= ofpbuf_pull(&b
, offsetof(struct ofp10_packet_in
, data
));
3269 pin
->packet
= opi
->data
;
3270 pin
->packet_len
= ofpbuf_size(&b
);
3272 pin
->fmd
.in_port
= u16_to_ofp(ntohs(opi
->in_port
));
3273 pin
->reason
= opi
->reason
;
3274 pin
->buffer_id
= ntohl(opi
->buffer_id
);
3275 pin
->total_len
= ntohs(opi
->total_len
);
3276 } else if (raw
== OFPRAW_OFPT11_PACKET_IN
) {
3277 const struct ofp11_packet_in
*opi
;
3280 opi
= ofpbuf_pull(&b
, sizeof *opi
);
3282 pin
->packet
= ofpbuf_data(&b
);
3283 pin
->packet_len
= ofpbuf_size(&b
);
3285 pin
->buffer_id
= ntohl(opi
->buffer_id
);
3286 error
= ofputil_port_from_ofp11(opi
->in_port
, &pin
->fmd
.in_port
);
3290 pin
->total_len
= ntohs(opi
->total_len
);
3291 pin
->reason
= opi
->reason
;
3292 pin
->table_id
= opi
->table_id
;
3293 } else if (raw
== OFPRAW_NXT_PACKET_IN
) {
3294 const struct nx_packet_in
*npi
;
3298 npi
= ofpbuf_pull(&b
, sizeof *npi
);
3299 error
= nx_pull_match_loose(&b
, ntohs(npi
->match_len
), &match
, NULL
,
3305 if (!ofpbuf_try_pull(&b
, 2)) {
3306 return OFPERR_OFPBRC_BAD_LEN
;
3309 pin
->reason
= npi
->reason
;
3310 pin
->table_id
= npi
->table_id
;
3311 pin
->cookie
= npi
->cookie
;
3313 pin
->buffer_id
= ntohl(npi
->buffer_id
);
3314 pin
->total_len
= ntohs(npi
->total_len
);
3316 ofputil_decode_packet_in_finish(pin
, &match
, &b
);
3325 ofputil_packet_in_to_match(const struct ofputil_packet_in
*pin
,
3326 struct match
*match
)
3330 match_init_catchall(match
);
3331 if (pin
->fmd
.tun_id
!= htonll(0)) {
3332 match_set_tun_id(match
, pin
->fmd
.tun_id
);
3334 if (pin
->fmd
.tun_src
!= htonl(0)) {
3335 match_set_tun_src(match
, pin
->fmd
.tun_src
);
3337 if (pin
->fmd
.tun_dst
!= htonl(0)) {
3338 match_set_tun_dst(match
, pin
->fmd
.tun_dst
);
3340 if (pin
->fmd
.metadata
!= htonll(0)) {
3341 match_set_metadata(match
, pin
->fmd
.metadata
);
3344 for (i
= 0; i
< FLOW_N_REGS
; i
++) {
3345 if (pin
->fmd
.regs
[i
]) {
3346 match_set_reg(match
, i
, pin
->fmd
.regs
[i
]);
3350 if (pin
->fmd
.pkt_mark
!= 0) {
3351 match_set_pkt_mark(match
, pin
->fmd
.pkt_mark
);
3354 match_set_in_port(match
, pin
->fmd
.in_port
);
3357 static struct ofpbuf
*
3358 ofputil_encode_ofp10_packet_in(const struct ofputil_packet_in
*pin
)
3360 struct ofp10_packet_in
*opi
;
3361 struct ofpbuf
*packet
;
3363 packet
= ofpraw_alloc_xid(OFPRAW_OFPT10_PACKET_IN
, OFP10_VERSION
,
3364 htonl(0), pin
->packet_len
);
3365 opi
= ofpbuf_put_zeros(packet
, offsetof(struct ofp10_packet_in
, data
));
3366 opi
->total_len
= htons(pin
->total_len
);
3367 opi
->in_port
= htons(ofp_to_u16(pin
->fmd
.in_port
));
3368 opi
->reason
= pin
->reason
;
3369 opi
->buffer_id
= htonl(pin
->buffer_id
);
3371 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3376 static struct ofpbuf
*
3377 ofputil_encode_nx_packet_in(const struct ofputil_packet_in
*pin
)
3379 struct nx_packet_in
*npi
;
3380 struct ofpbuf
*packet
;
3384 ofputil_packet_in_to_match(pin
, &match
);
3386 /* The final argument is just an estimate of the space required. */
3387 packet
= ofpraw_alloc_xid(OFPRAW_NXT_PACKET_IN
, OFP10_VERSION
,
3388 htonl(0), (sizeof(struct flow_metadata
) * 2
3389 + 2 + pin
->packet_len
));
3390 ofpbuf_put_zeros(packet
, sizeof *npi
);
3391 match_len
= nx_put_match(packet
, &match
, 0, 0);
3392 ofpbuf_put_zeros(packet
, 2);
3393 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3395 npi
= ofpbuf_l3(packet
);
3396 npi
->buffer_id
= htonl(pin
->buffer_id
);
3397 npi
->total_len
= htons(pin
->total_len
);
3398 npi
->reason
= pin
->reason
;
3399 npi
->table_id
= pin
->table_id
;
3400 npi
->cookie
= pin
->cookie
;
3401 npi
->match_len
= htons(match_len
);
3406 static struct ofpbuf
*
3407 ofputil_encode_ofp11_packet_in(const struct ofputil_packet_in
*pin
)
3409 struct ofp11_packet_in
*opi
;
3410 struct ofpbuf
*packet
;
3412 packet
= ofpraw_alloc_xid(OFPRAW_OFPT11_PACKET_IN
, OFP11_VERSION
,
3413 htonl(0), pin
->packet_len
);
3414 opi
= ofpbuf_put_zeros(packet
, sizeof *opi
);
3415 opi
->buffer_id
= htonl(pin
->buffer_id
);
3416 opi
->in_port
= ofputil_port_to_ofp11(pin
->fmd
.in_port
);
3417 opi
->in_phy_port
= opi
->in_port
;
3418 opi
->total_len
= htons(pin
->total_len
);
3419 opi
->reason
= pin
->reason
;
3420 opi
->table_id
= pin
->table_id
;
3422 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3427 static struct ofpbuf
*
3428 ofputil_encode_ofp12_packet_in(const struct ofputil_packet_in
*pin
,
3429 enum ofputil_protocol protocol
)
3431 struct ofp13_packet_in
*opi
;
3433 enum ofpraw packet_in_raw
;
3434 enum ofp_version packet_in_version
;
3435 size_t packet_in_size
;
3436 struct ofpbuf
*packet
;
3438 if (protocol
== OFPUTIL_P_OF12_OXM
) {
3439 packet_in_raw
= OFPRAW_OFPT12_PACKET_IN
;
3440 packet_in_version
= OFP12_VERSION
;
3441 packet_in_size
= sizeof (struct ofp12_packet_in
);
3443 packet_in_raw
= OFPRAW_OFPT13_PACKET_IN
;
3444 packet_in_version
= OFP13_VERSION
;
3445 packet_in_size
= sizeof (struct ofp13_packet_in
);
3448 ofputil_packet_in_to_match(pin
, &match
);
3450 /* The final argument is just an estimate of the space required. */
3451 packet
= ofpraw_alloc_xid(packet_in_raw
, packet_in_version
,
3452 htonl(0), (sizeof(struct flow_metadata
) * 2
3453 + 2 + pin
->packet_len
));
3454 ofpbuf_put_zeros(packet
, packet_in_size
);
3455 oxm_put_match(packet
, &match
);
3456 ofpbuf_put_zeros(packet
, 2);
3457 ofpbuf_put(packet
, pin
->packet
, pin
->packet_len
);
3459 opi
= ofpbuf_l3(packet
);
3460 opi
->pi
.buffer_id
= htonl(pin
->buffer_id
);
3461 opi
->pi
.total_len
= htons(pin
->total_len
);
3462 opi
->pi
.reason
= pin
->reason
;
3463 opi
->pi
.table_id
= pin
->table_id
;
3464 if (protocol
== OFPUTIL_P_OF13_OXM
) {
3465 opi
->cookie
= pin
->cookie
;
3471 /* Converts abstract ofputil_packet_in 'pin' into a PACKET_IN message
3472 * in the format specified by 'packet_in_format'. */
3474 ofputil_encode_packet_in(const struct ofputil_packet_in
*pin
,
3475 enum ofputil_protocol protocol
,
3476 enum nx_packet_in_format packet_in_format
)
3478 struct ofpbuf
*packet
;
3481 case OFPUTIL_P_OF10_STD
:
3482 case OFPUTIL_P_OF10_STD_TID
:
3483 case OFPUTIL_P_OF10_NXM
:
3484 case OFPUTIL_P_OF10_NXM_TID
:
3485 packet
= (packet_in_format
== NXPIF_NXM
3486 ? ofputil_encode_nx_packet_in(pin
)
3487 : ofputil_encode_ofp10_packet_in(pin
));
3490 case OFPUTIL_P_OF11_STD
:
3491 packet
= ofputil_encode_ofp11_packet_in(pin
);
3494 case OFPUTIL_P_OF12_OXM
:
3495 case OFPUTIL_P_OF13_OXM
:
3496 case OFPUTIL_P_OF14_OXM
:
3497 packet
= ofputil_encode_ofp12_packet_in(pin
, protocol
);
3504 ofpmsg_update_length(packet
);
3508 /* Returns a string form of 'reason'. The return value is either a statically
3509 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
3510 * 'bufsize' should be at least OFPUTIL_PACKET_IN_REASON_BUFSIZE. */
3512 ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason reason
,
3513 char *reasonbuf
, size_t bufsize
)
3520 case OFPR_INVALID_TTL
:
3521 return "invalid_ttl";
3523 case OFPR_N_REASONS
:
3525 snprintf(reasonbuf
, bufsize
, "%d", (int) reason
);
3531 ofputil_packet_in_reason_from_string(const char *s
,
3532 enum ofp_packet_in_reason
*reason
)
3536 for (i
= 0; i
< OFPR_N_REASONS
; i
++) {
3537 char reasonbuf
[OFPUTIL_PACKET_IN_REASON_BUFSIZE
];
3538 const char *reason_s
;
3540 reason_s
= ofputil_packet_in_reason_to_string(i
, reasonbuf
,
3542 if (!strcasecmp(s
, reason_s
)) {
3550 /* Converts an OFPT_PACKET_OUT in 'opo' into an abstract ofputil_packet_out in
3553 * Uses 'ofpacts' to store the abstract OFPACT_* version of the packet out
3554 * message's actions. The caller must initialize 'ofpacts' and retains
3555 * ownership of it. 'po->ofpacts' will point into the 'ofpacts' buffer.
3557 * Returns 0 if successful, otherwise an OFPERR_* value. */
3559 ofputil_decode_packet_out(struct ofputil_packet_out
*po
,
3560 const struct ofp_header
*oh
,
3561 struct ofpbuf
*ofpacts
)
3566 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
3567 raw
= ofpraw_pull_assert(&b
);
3569 if (raw
== OFPRAW_OFPT11_PACKET_OUT
) {
3571 const struct ofp11_packet_out
*opo
= ofpbuf_pull(&b
, sizeof *opo
);
3573 po
->buffer_id
= ntohl(opo
->buffer_id
);
3574 error
= ofputil_port_from_ofp11(opo
->in_port
, &po
->in_port
);
3579 error
= ofpacts_pull_openflow_actions(&b
, ntohs(opo
->actions_len
),
3580 oh
->version
, ofpacts
);
3584 } else if (raw
== OFPRAW_OFPT10_PACKET_OUT
) {
3586 const struct ofp10_packet_out
*opo
= ofpbuf_pull(&b
, sizeof *opo
);
3588 po
->buffer_id
= ntohl(opo
->buffer_id
);
3589 po
->in_port
= u16_to_ofp(ntohs(opo
->in_port
));
3591 error
= ofpacts_pull_openflow_actions(&b
, ntohs(opo
->actions_len
),
3592 oh
->version
, ofpacts
);
3600 if (ofp_to_u16(po
->in_port
) >= ofp_to_u16(OFPP_MAX
)
3601 && po
->in_port
!= OFPP_LOCAL
3602 && po
->in_port
!= OFPP_NONE
&& po
->in_port
!= OFPP_CONTROLLER
) {
3603 VLOG_WARN_RL(&bad_ofmsg_rl
, "packet-out has bad input port %#"PRIx16
,
3605 return OFPERR_OFPBRC_BAD_PORT
;
3608 po
->ofpacts
= ofpbuf_data(ofpacts
);
3609 po
->ofpacts_len
= ofpbuf_size(ofpacts
);
3611 if (po
->buffer_id
== UINT32_MAX
) {
3612 po
->packet
= ofpbuf_data(&b
);
3613 po
->packet_len
= ofpbuf_size(&b
);
3622 /* ofputil_phy_port */
3624 /* NETDEV_F_* to and from OFPPF_* and OFPPF10_*. */
3625 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD
== OFPPF_10MB_HD
); /* bit 0 */
3626 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD
== OFPPF_10MB_FD
); /* bit 1 */
3627 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD
== OFPPF_100MB_HD
); /* bit 2 */
3628 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD
== OFPPF_100MB_FD
); /* bit 3 */
3629 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD
== OFPPF_1GB_HD
); /* bit 4 */
3630 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD
== OFPPF_1GB_FD
); /* bit 5 */
3631 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD
== OFPPF_10GB_FD
); /* bit 6 */
3633 /* NETDEV_F_ bits 11...15 are OFPPF10_ bits 7...11: */
3634 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER
== (OFPPF10_COPPER
<< 4));
3635 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER
== (OFPPF10_FIBER
<< 4));
3636 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG
== (OFPPF10_AUTONEG
<< 4));
3637 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE
== (OFPPF10_PAUSE
<< 4));
3638 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM
== (OFPPF10_PAUSE_ASYM
<< 4));
3640 static enum netdev_features
3641 netdev_port_features_from_ofp10(ovs_be32 ofp10_
)
3643 uint32_t ofp10
= ntohl(ofp10_
);
3644 return (ofp10
& 0x7f) | ((ofp10
& 0xf80) << 4);
3648 netdev_port_features_to_ofp10(enum netdev_features features
)
3650 return htonl((features
& 0x7f) | ((features
& 0xf800) >> 4));
3653 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_HD
== OFPPF_10MB_HD
); /* bit 0 */
3654 BUILD_ASSERT_DECL((int) NETDEV_F_10MB_FD
== OFPPF_10MB_FD
); /* bit 1 */
3655 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_HD
== OFPPF_100MB_HD
); /* bit 2 */
3656 BUILD_ASSERT_DECL((int) NETDEV_F_100MB_FD
== OFPPF_100MB_FD
); /* bit 3 */
3657 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_HD
== OFPPF_1GB_HD
); /* bit 4 */
3658 BUILD_ASSERT_DECL((int) NETDEV_F_1GB_FD
== OFPPF_1GB_FD
); /* bit 5 */
3659 BUILD_ASSERT_DECL((int) NETDEV_F_10GB_FD
== OFPPF_10GB_FD
); /* bit 6 */
3660 BUILD_ASSERT_DECL((int) NETDEV_F_40GB_FD
== OFPPF11_40GB_FD
); /* bit 7 */
3661 BUILD_ASSERT_DECL((int) NETDEV_F_100GB_FD
== OFPPF11_100GB_FD
); /* bit 8 */
3662 BUILD_ASSERT_DECL((int) NETDEV_F_1TB_FD
== OFPPF11_1TB_FD
); /* bit 9 */
3663 BUILD_ASSERT_DECL((int) NETDEV_F_OTHER
== OFPPF11_OTHER
); /* bit 10 */
3664 BUILD_ASSERT_DECL((int) NETDEV_F_COPPER
== OFPPF11_COPPER
); /* bit 11 */
3665 BUILD_ASSERT_DECL((int) NETDEV_F_FIBER
== OFPPF11_FIBER
); /* bit 12 */
3666 BUILD_ASSERT_DECL((int) NETDEV_F_AUTONEG
== OFPPF11_AUTONEG
); /* bit 13 */
3667 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE
== OFPPF11_PAUSE
); /* bit 14 */
3668 BUILD_ASSERT_DECL((int) NETDEV_F_PAUSE_ASYM
== OFPPF11_PAUSE_ASYM
);/* bit 15 */
3670 static enum netdev_features
3671 netdev_port_features_from_ofp11(ovs_be32 ofp11
)
3673 return ntohl(ofp11
) & 0xffff;
3677 netdev_port_features_to_ofp11(enum netdev_features features
)
3679 return htonl(features
& 0xffff);
3683 ofputil_decode_ofp10_phy_port(struct ofputil_phy_port
*pp
,
3684 const struct ofp10_phy_port
*opp
)
3686 pp
->port_no
= u16_to_ofp(ntohs(opp
->port_no
));
3687 memcpy(pp
->hw_addr
, opp
->hw_addr
, OFP_ETH_ALEN
);
3688 ovs_strlcpy(pp
->name
, opp
->name
, OFP_MAX_PORT_NAME_LEN
);
3690 pp
->config
= ntohl(opp
->config
) & OFPPC10_ALL
;
3691 pp
->state
= ntohl(opp
->state
) & OFPPS10_ALL
;
3693 pp
->curr
= netdev_port_features_from_ofp10(opp
->curr
);
3694 pp
->advertised
= netdev_port_features_from_ofp10(opp
->advertised
);
3695 pp
->supported
= netdev_port_features_from_ofp10(opp
->supported
);
3696 pp
->peer
= netdev_port_features_from_ofp10(opp
->peer
);
3698 pp
->curr_speed
= netdev_features_to_bps(pp
->curr
, 0) / 1000;
3699 pp
->max_speed
= netdev_features_to_bps(pp
->supported
, 0) / 1000;
3705 ofputil_decode_ofp11_port(struct ofputil_phy_port
*pp
,
3706 const struct ofp11_port
*op
)
3710 error
= ofputil_port_from_ofp11(op
->port_no
, &pp
->port_no
);
3714 memcpy(pp
->hw_addr
, op
->hw_addr
, OFP_ETH_ALEN
);
3715 ovs_strlcpy(pp
->name
, op
->name
, OFP_MAX_PORT_NAME_LEN
);
3717 pp
->config
= ntohl(op
->config
) & OFPPC11_ALL
;
3718 pp
->state
= ntohl(op
->state
) & OFPPS11_ALL
;
3720 pp
->curr
= netdev_port_features_from_ofp11(op
->curr
);
3721 pp
->advertised
= netdev_port_features_from_ofp11(op
->advertised
);
3722 pp
->supported
= netdev_port_features_from_ofp11(op
->supported
);
3723 pp
->peer
= netdev_port_features_from_ofp11(op
->peer
);
3725 pp
->curr_speed
= ntohl(op
->curr_speed
);
3726 pp
->max_speed
= ntohl(op
->max_speed
);
3732 parse_ofp14_port_ethernet_property(const struct ofpbuf
*payload
,
3733 struct ofputil_phy_port
*pp
)
3735 struct ofp14_port_desc_prop_ethernet
*eth
= ofpbuf_data(payload
);
3737 if (ofpbuf_size(payload
) != sizeof *eth
) {
3738 return OFPERR_OFPBPC_BAD_LEN
;
3741 pp
->curr
= netdev_port_features_from_ofp11(eth
->curr
);
3742 pp
->advertised
= netdev_port_features_from_ofp11(eth
->advertised
);
3743 pp
->supported
= netdev_port_features_from_ofp11(eth
->supported
);
3744 pp
->peer
= netdev_port_features_from_ofp11(eth
->peer
);
3746 pp
->curr_speed
= ntohl(eth
->curr_speed
);
3747 pp
->max_speed
= ntohl(eth
->max_speed
);
3753 ofputil_pull_ofp14_port(struct ofputil_phy_port
*pp
, struct ofpbuf
*msg
)
3755 struct ofpbuf properties
;
3756 struct ofp14_port
*op
;
3760 op
= ofpbuf_try_pull(msg
, sizeof *op
);
3762 return OFPERR_OFPBRC_BAD_LEN
;
3765 len
= ntohs(op
->length
);
3766 if (len
< sizeof *op
|| len
- sizeof *op
> ofpbuf_size(msg
)) {
3767 return OFPERR_OFPBRC_BAD_LEN
;
3770 ofpbuf_use_const(&properties
, ofpbuf_pull(msg
, len
), len
);
3772 error
= ofputil_port_from_ofp11(op
->port_no
, &pp
->port_no
);
3776 memcpy(pp
->hw_addr
, op
->hw_addr
, OFP_ETH_ALEN
);
3777 ovs_strlcpy(pp
->name
, op
->name
, OFP_MAX_PORT_NAME_LEN
);
3779 pp
->config
= ntohl(op
->config
) & OFPPC11_ALL
;
3780 pp
->state
= ntohl(op
->state
) & OFPPS11_ALL
;
3782 while (ofpbuf_size(&properties
) > 0) {
3783 struct ofpbuf payload
;
3787 error
= ofputil_pull_property(&properties
, &payload
, &type
);
3793 case OFPPDPT14_ETHERNET
:
3794 error
= parse_ofp14_port_ethernet_property(&payload
, pp
);
3798 log_property(true, "unknown port property %"PRIu16
, type
);
3812 ofputil_get_phy_port_size(enum ofp_version ofp_version
)
3814 switch (ofp_version
) {
3816 return sizeof(struct ofp10_phy_port
);
3821 return sizeof(struct ofp11_port
);
3828 ofputil_encode_ofp10_phy_port(const struct ofputil_phy_port
*pp
,
3829 struct ofp10_phy_port
*opp
)
3831 memset(opp
, 0, sizeof *opp
);
3833 opp
->port_no
= htons(ofp_to_u16(pp
->port_no
));
3834 memcpy(opp
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3835 ovs_strlcpy(opp
->name
, pp
->name
, OFP_MAX_PORT_NAME_LEN
);
3837 opp
->config
= htonl(pp
->config
& OFPPC10_ALL
);
3838 opp
->state
= htonl(pp
->state
& OFPPS10_ALL
);
3840 opp
->curr
= netdev_port_features_to_ofp10(pp
->curr
);
3841 opp
->advertised
= netdev_port_features_to_ofp10(pp
->advertised
);
3842 opp
->supported
= netdev_port_features_to_ofp10(pp
->supported
);
3843 opp
->peer
= netdev_port_features_to_ofp10(pp
->peer
);
3847 ofputil_encode_ofp11_port(const struct ofputil_phy_port
*pp
,
3848 struct ofp11_port
*op
)
3850 memset(op
, 0, sizeof *op
);
3852 op
->port_no
= ofputil_port_to_ofp11(pp
->port_no
);
3853 memcpy(op
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3854 ovs_strlcpy(op
->name
, pp
->name
, OFP_MAX_PORT_NAME_LEN
);
3856 op
->config
= htonl(pp
->config
& OFPPC11_ALL
);
3857 op
->state
= htonl(pp
->state
& OFPPS11_ALL
);
3859 op
->curr
= netdev_port_features_to_ofp11(pp
->curr
);
3860 op
->advertised
= netdev_port_features_to_ofp11(pp
->advertised
);
3861 op
->supported
= netdev_port_features_to_ofp11(pp
->supported
);
3862 op
->peer
= netdev_port_features_to_ofp11(pp
->peer
);
3864 op
->curr_speed
= htonl(pp
->curr_speed
);
3865 op
->max_speed
= htonl(pp
->max_speed
);
3869 ofputil_put_ofp14_port(const struct ofputil_phy_port
*pp
,
3872 struct ofp14_port
*op
;
3873 struct ofp14_port_desc_prop_ethernet
*eth
;
3875 ofpbuf_prealloc_tailroom(b
, sizeof *op
+ sizeof *eth
);
3877 op
= ofpbuf_put_zeros(b
, sizeof *op
);
3878 op
->port_no
= ofputil_port_to_ofp11(pp
->port_no
);
3879 op
->length
= htons(sizeof *op
+ sizeof *eth
);
3880 memcpy(op
->hw_addr
, pp
->hw_addr
, ETH_ADDR_LEN
);
3881 ovs_strlcpy(op
->name
, pp
->name
, sizeof op
->name
);
3882 op
->config
= htonl(pp
->config
& OFPPC11_ALL
);
3883 op
->state
= htonl(pp
->state
& OFPPS11_ALL
);
3885 eth
= ofpbuf_put_zeros(b
, sizeof *eth
);
3886 eth
->type
= htons(OFPPDPT14_ETHERNET
);
3887 eth
->length
= htons(sizeof *eth
);
3888 eth
->curr
= netdev_port_features_to_ofp11(pp
->curr
);
3889 eth
->advertised
= netdev_port_features_to_ofp11(pp
->advertised
);
3890 eth
->supported
= netdev_port_features_to_ofp11(pp
->supported
);
3891 eth
->peer
= netdev_port_features_to_ofp11(pp
->peer
);
3892 eth
->curr_speed
= htonl(pp
->curr_speed
);
3893 eth
->max_speed
= htonl(pp
->max_speed
);
3897 ofputil_put_phy_port(enum ofp_version ofp_version
,
3898 const struct ofputil_phy_port
*pp
, struct ofpbuf
*b
)
3900 switch (ofp_version
) {
3901 case OFP10_VERSION
: {
3902 struct ofp10_phy_port
*opp
= ofpbuf_put_uninit(b
, sizeof *opp
);
3903 ofputil_encode_ofp10_phy_port(pp
, opp
);
3909 case OFP13_VERSION
: {
3910 struct ofp11_port
*op
= ofpbuf_put_uninit(b
, sizeof *op
);
3911 ofputil_encode_ofp11_port(pp
, op
);
3916 ofputil_put_ofp14_port(pp
, b
);
3925 ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port
*pp
,
3926 struct list
*replies
)
3928 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
3929 size_t start_ofs
= ofpbuf_size(reply
);
3931 ofputil_put_phy_port(ofpmp_version(replies
), pp
, reply
);
3932 ofpmp_postappend(replies
, start_ofs
);
3935 /* ofputil_switch_features */
3937 #define OFPC_COMMON (OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
3938 OFPC_IP_REASM | OFPC_QUEUE_STATS)
3939 BUILD_ASSERT_DECL((int) OFPUTIL_C_FLOW_STATS
== OFPC_FLOW_STATS
);
3940 BUILD_ASSERT_DECL((int) OFPUTIL_C_TABLE_STATS
== OFPC_TABLE_STATS
);
3941 BUILD_ASSERT_DECL((int) OFPUTIL_C_PORT_STATS
== OFPC_PORT_STATS
);
3942 BUILD_ASSERT_DECL((int) OFPUTIL_C_IP_REASM
== OFPC_IP_REASM
);
3943 BUILD_ASSERT_DECL((int) OFPUTIL_C_QUEUE_STATS
== OFPC_QUEUE_STATS
);
3944 BUILD_ASSERT_DECL((int) OFPUTIL_C_ARP_MATCH_IP
== OFPC_ARP_MATCH_IP
);
3946 struct ofputil_action_bit_translation
{
3947 enum ofputil_action_bitmap ofputil_bit
;
3951 static const struct ofputil_action_bit_translation of10_action_bits
[] = {
3952 { OFPUTIL_A_OUTPUT
, OFPAT10_OUTPUT
},
3953 { OFPUTIL_A_SET_VLAN_VID
, OFPAT10_SET_VLAN_VID
},
3954 { OFPUTIL_A_SET_VLAN_PCP
, OFPAT10_SET_VLAN_PCP
},
3955 { OFPUTIL_A_STRIP_VLAN
, OFPAT10_STRIP_VLAN
},
3956 { OFPUTIL_A_SET_DL_SRC
, OFPAT10_SET_DL_SRC
},
3957 { OFPUTIL_A_SET_DL_DST
, OFPAT10_SET_DL_DST
},
3958 { OFPUTIL_A_SET_NW_SRC
, OFPAT10_SET_NW_SRC
},
3959 { OFPUTIL_A_SET_NW_DST
, OFPAT10_SET_NW_DST
},
3960 { OFPUTIL_A_SET_NW_TOS
, OFPAT10_SET_NW_TOS
},
3961 { OFPUTIL_A_SET_TP_SRC
, OFPAT10_SET_TP_SRC
},
3962 { OFPUTIL_A_SET_TP_DST
, OFPAT10_SET_TP_DST
},
3963 { OFPUTIL_A_ENQUEUE
, OFPAT10_ENQUEUE
},
3967 static enum ofputil_action_bitmap
3968 decode_action_bits(ovs_be32 of_actions
,
3969 const struct ofputil_action_bit_translation
*x
)
3971 enum ofputil_action_bitmap ofputil_actions
;
3973 ofputil_actions
= 0;
3974 for (; x
->ofputil_bit
; x
++) {
3975 if (of_actions
& htonl(1u << x
->of_bit
)) {
3976 ofputil_actions
|= x
->ofputil_bit
;
3979 return ofputil_actions
;
3983 ofputil_capabilities_mask(enum ofp_version ofp_version
)
3985 /* Handle capabilities whose bit is unique for all Open Flow versions */
3986 switch (ofp_version
) {
3989 return OFPC_COMMON
| OFPC_ARP_MATCH_IP
;
3993 return OFPC_COMMON
| OFPC12_PORT_BLOCKED
;
3995 /* Caller needs to check osf->header.version itself */
4000 /* Decodes an OpenFlow 1.0 or 1.1 "switch_features" structure 'osf' into an
4001 * abstract representation in '*features'. Initializes '*b' to iterate over
4002 * the OpenFlow port structures following 'osf' with later calls to
4003 * ofputil_pull_phy_port(). Returns 0 if successful, otherwise an
4004 * OFPERR_* value. */
4006 ofputil_decode_switch_features(const struct ofp_header
*oh
,
4007 struct ofputil_switch_features
*features
,
4010 const struct ofp_switch_features
*osf
;
4013 ofpbuf_use_const(b
, oh
, ntohs(oh
->length
));
4014 raw
= ofpraw_pull_assert(b
);
4016 osf
= ofpbuf_pull(b
, sizeof *osf
);
4017 features
->datapath_id
= ntohll(osf
->datapath_id
);
4018 features
->n_buffers
= ntohl(osf
->n_buffers
);
4019 features
->n_tables
= osf
->n_tables
;
4020 features
->auxiliary_id
= 0;
4022 features
->capabilities
= ntohl(osf
->capabilities
) &
4023 ofputil_capabilities_mask(oh
->version
);
4025 if (raw
== OFPRAW_OFPT10_FEATURES_REPLY
) {
4026 if (osf
->capabilities
& htonl(OFPC10_STP
)) {
4027 features
->capabilities
|= OFPUTIL_C_STP
;
4029 features
->actions
= decode_action_bits(osf
->actions
, of10_action_bits
);
4030 } else if (raw
== OFPRAW_OFPT11_FEATURES_REPLY
4031 || raw
== OFPRAW_OFPT13_FEATURES_REPLY
) {
4032 if (osf
->capabilities
& htonl(OFPC11_GROUP_STATS
)) {
4033 features
->capabilities
|= OFPUTIL_C_GROUP_STATS
;
4035 features
->actions
= 0;
4036 if (raw
== OFPRAW_OFPT13_FEATURES_REPLY
) {
4037 features
->auxiliary_id
= osf
->auxiliary_id
;
4040 return OFPERR_OFPBRC_BAD_VERSION
;
4046 /* Returns true if the maximum number of ports are in 'oh'. */
4048 max_ports_in_features(const struct ofp_header
*oh
)
4050 size_t pp_size
= ofputil_get_phy_port_size(oh
->version
);
4051 return ntohs(oh
->length
) + pp_size
> UINT16_MAX
;
4054 /* In OpenFlow 1.0, 1.1, and 1.2, an OFPT_FEATURES_REPLY message lists all the
4055 * switch's ports, unless there are too many to fit. In OpenFlow 1.3 and
4056 * later, an OFPT_FEATURES_REPLY does not list ports at all.
4058 * Given a buffer 'b' that contains a Features Reply message, this message
4059 * checks if it contains a complete list of the switch's ports. Returns true,
4060 * if so. Returns false if the list is missing (OF1.3+) or incomplete
4061 * (OF1.0/1.1/1.2), and in the latter case removes all of the ports from the
4064 * When this function returns false, the caller should send an OFPST_PORT_DESC
4065 * stats request to get the ports. */
4067 ofputil_switch_features_has_ports(struct ofpbuf
*b
)
4069 struct ofp_header
*oh
= ofpbuf_data(b
);
4071 if (oh
->version
>= OFP13_VERSION
) {
4073 } else if (max_ports_in_features(oh
)) {
4074 ofpbuf_set_size(b
, sizeof *oh
+ sizeof(struct ofp_switch_features
));
4075 ofpmsg_update_length(b
);
4083 encode_action_bits(enum ofputil_action_bitmap ofputil_actions
,
4084 const struct ofputil_action_bit_translation
*x
)
4086 uint32_t of_actions
;
4089 for (; x
->ofputil_bit
; x
++) {
4090 if (ofputil_actions
& x
->ofputil_bit
) {
4091 of_actions
|= 1 << x
->of_bit
;
4094 return htonl(of_actions
);
4097 /* Returns a buffer owned by the caller that encodes 'features' in the format
4098 * required by 'protocol' with the given 'xid'. The caller should append port
4099 * information to the buffer with subsequent calls to
4100 * ofputil_put_switch_features_port(). */
4102 ofputil_encode_switch_features(const struct ofputil_switch_features
*features
,
4103 enum ofputil_protocol protocol
, ovs_be32 xid
)
4105 struct ofp_switch_features
*osf
;
4107 enum ofp_version version
;
4110 version
= ofputil_protocol_to_ofp_version(protocol
);
4113 raw
= OFPRAW_OFPT10_FEATURES_REPLY
;
4117 raw
= OFPRAW_OFPT11_FEATURES_REPLY
;
4121 raw
= OFPRAW_OFPT13_FEATURES_REPLY
;
4126 b
= ofpraw_alloc_xid(raw
, version
, xid
, 0);
4127 osf
= ofpbuf_put_zeros(b
, sizeof *osf
);
4128 osf
->datapath_id
= htonll(features
->datapath_id
);
4129 osf
->n_buffers
= htonl(features
->n_buffers
);
4130 osf
->n_tables
= features
->n_tables
;
4132 osf
->capabilities
= htonl(features
->capabilities
& OFPC_COMMON
);
4133 osf
->capabilities
= htonl(features
->capabilities
&
4134 ofputil_capabilities_mask(version
));
4137 if (features
->capabilities
& OFPUTIL_C_STP
) {
4138 osf
->capabilities
|= htonl(OFPC10_STP
);
4140 osf
->actions
= encode_action_bits(features
->actions
, of10_action_bits
);
4144 osf
->auxiliary_id
= features
->auxiliary_id
;
4148 if (features
->capabilities
& OFPUTIL_C_GROUP_STATS
) {
4149 osf
->capabilities
|= htonl(OFPC11_GROUP_STATS
);
4159 /* Encodes 'pp' into the format required by the switch_features message already
4160 * in 'b', which should have been returned by ofputil_encode_switch_features(),
4161 * and appends the encoded version to 'b'. */
4163 ofputil_put_switch_features_port(const struct ofputil_phy_port
*pp
,
4166 const struct ofp_header
*oh
= ofpbuf_data(b
);
4168 if (oh
->version
< OFP13_VERSION
) {
4169 /* Try adding a port description to the message, but drop it again if
4170 * the buffer overflows. (This possibility for overflow is why
4171 * OpenFlow 1.3+ moved port descriptions into a multipart message.) */
4172 size_t start_ofs
= ofpbuf_size(b
);
4173 ofputil_put_phy_port(oh
->version
, pp
, b
);
4174 if (ofpbuf_size(b
) > UINT16_MAX
) {
4175 ofpbuf_set_size(b
, start_ofs
);
4180 /* ofputil_port_status */
4182 /* Decodes the OpenFlow "port status" message in '*ops' into an abstract form
4183 * in '*ps'. Returns 0 if successful, otherwise an OFPERR_* value. */
4185 ofputil_decode_port_status(const struct ofp_header
*oh
,
4186 struct ofputil_port_status
*ps
)
4188 const struct ofp_port_status
*ops
;
4192 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4193 ofpraw_pull_assert(&b
);
4194 ops
= ofpbuf_pull(&b
, sizeof *ops
);
4196 if (ops
->reason
!= OFPPR_ADD
&&
4197 ops
->reason
!= OFPPR_DELETE
&&
4198 ops
->reason
!= OFPPR_MODIFY
) {
4199 return OFPERR_NXBRC_BAD_REASON
;
4201 ps
->reason
= ops
->reason
;
4203 retval
= ofputil_pull_phy_port(oh
->version
, &b
, &ps
->desc
);
4204 ovs_assert(retval
!= EOF
);
4208 /* Converts the abstract form of a "port status" message in '*ps' into an
4209 * OpenFlow message suitable for 'protocol', and returns that encoded form in
4210 * a buffer owned by the caller. */
4212 ofputil_encode_port_status(const struct ofputil_port_status
*ps
,
4213 enum ofputil_protocol protocol
)
4215 struct ofp_port_status
*ops
;
4217 enum ofp_version version
;
4220 version
= ofputil_protocol_to_ofp_version(protocol
);
4223 raw
= OFPRAW_OFPT10_PORT_STATUS
;
4229 raw
= OFPRAW_OFPT11_PORT_STATUS
;
4233 raw
= OFPRAW_OFPT14_PORT_STATUS
;
4240 b
= ofpraw_alloc_xid(raw
, version
, htonl(0), 0);
4241 ops
= ofpbuf_put_zeros(b
, sizeof *ops
);
4242 ops
->reason
= ps
->reason
;
4243 ofputil_put_phy_port(version
, &ps
->desc
, b
);
4244 ofpmsg_update_length(b
);
4248 /* ofputil_port_mod */
4251 parse_port_mod_ethernet_property(struct ofpbuf
*property
,
4252 struct ofputil_port_mod
*pm
)
4254 struct ofp14_port_mod_prop_ethernet
*eth
= ofpbuf_data(property
);
4256 if (ofpbuf_size(property
) != sizeof *eth
) {
4257 return OFPERR_OFPBRC_BAD_LEN
;
4260 pm
->advertise
= netdev_port_features_from_ofp11(eth
->advertise
);
4264 /* Decodes the OpenFlow "port mod" message in '*oh' into an abstract form in
4265 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4267 ofputil_decode_port_mod(const struct ofp_header
*oh
,
4268 struct ofputil_port_mod
*pm
, bool loose
)
4273 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4274 raw
= ofpraw_pull_assert(&b
);
4276 if (raw
== OFPRAW_OFPT10_PORT_MOD
) {
4277 const struct ofp10_port_mod
*opm
= ofpbuf_data(&b
);
4279 pm
->port_no
= u16_to_ofp(ntohs(opm
->port_no
));
4280 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4281 pm
->config
= ntohl(opm
->config
) & OFPPC10_ALL
;
4282 pm
->mask
= ntohl(opm
->mask
) & OFPPC10_ALL
;
4283 pm
->advertise
= netdev_port_features_from_ofp10(opm
->advertise
);
4284 } else if (raw
== OFPRAW_OFPT11_PORT_MOD
) {
4285 const struct ofp11_port_mod
*opm
= ofpbuf_data(&b
);
4288 error
= ofputil_port_from_ofp11(opm
->port_no
, &pm
->port_no
);
4293 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4294 pm
->config
= ntohl(opm
->config
) & OFPPC11_ALL
;
4295 pm
->mask
= ntohl(opm
->mask
) & OFPPC11_ALL
;
4296 pm
->advertise
= netdev_port_features_from_ofp11(opm
->advertise
);
4297 } else if (raw
== OFPRAW_OFPT14_PORT_MOD
) {
4298 const struct ofp14_port_mod
*opm
= ofpbuf_pull(&b
, sizeof *opm
);
4301 memset(pm
, 0, sizeof *pm
);
4303 error
= ofputil_port_from_ofp11(opm
->port_no
, &pm
->port_no
);
4308 memcpy(pm
->hw_addr
, opm
->hw_addr
, ETH_ADDR_LEN
);
4309 pm
->config
= ntohl(opm
->config
) & OFPPC11_ALL
;
4310 pm
->mask
= ntohl(opm
->mask
) & OFPPC11_ALL
;
4312 while (ofpbuf_size(&b
) > 0) {
4313 struct ofpbuf property
;
4317 error
= ofputil_pull_property(&b
, &property
, &type
);
4323 case OFPPMPT14_ETHERNET
:
4324 error
= parse_port_mod_ethernet_property(&property
, pm
);
4328 log_property(loose
, "unknown port_mod property %"PRIu16
, type
);
4331 } else if (type
== OFPPMPT14_EXPERIMENTER
) {
4332 error
= OFPERR_OFPBPC_BAD_EXPERIMENTER
;
4334 error
= OFPERR_OFPBRC_BAD_TYPE
;
4344 return OFPERR_OFPBRC_BAD_TYPE
;
4347 pm
->config
&= pm
->mask
;
4351 /* Converts the abstract form of a "port mod" message in '*pm' into an OpenFlow
4352 * message suitable for 'protocol', and returns that encoded form in a buffer
4353 * owned by the caller. */
4355 ofputil_encode_port_mod(const struct ofputil_port_mod
*pm
,
4356 enum ofputil_protocol protocol
)
4358 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
4361 switch (ofp_version
) {
4362 case OFP10_VERSION
: {
4363 struct ofp10_port_mod
*opm
;
4365 b
= ofpraw_alloc(OFPRAW_OFPT10_PORT_MOD
, ofp_version
, 0);
4366 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4367 opm
->port_no
= htons(ofp_to_u16(pm
->port_no
));
4368 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4369 opm
->config
= htonl(pm
->config
& OFPPC10_ALL
);
4370 opm
->mask
= htonl(pm
->mask
& OFPPC10_ALL
);
4371 opm
->advertise
= netdev_port_features_to_ofp10(pm
->advertise
);
4377 case OFP13_VERSION
: {
4378 struct ofp11_port_mod
*opm
;
4380 b
= ofpraw_alloc(OFPRAW_OFPT11_PORT_MOD
, ofp_version
, 0);
4381 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4382 opm
->port_no
= ofputil_port_to_ofp11(pm
->port_no
);
4383 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4384 opm
->config
= htonl(pm
->config
& OFPPC11_ALL
);
4385 opm
->mask
= htonl(pm
->mask
& OFPPC11_ALL
);
4386 opm
->advertise
= netdev_port_features_to_ofp11(pm
->advertise
);
4389 case OFP14_VERSION
: {
4390 struct ofp14_port_mod_prop_ethernet
*eth
;
4391 struct ofp14_port_mod
*opm
;
4393 b
= ofpraw_alloc(OFPRAW_OFPT14_PORT_MOD
, ofp_version
, sizeof *eth
);
4394 opm
= ofpbuf_put_zeros(b
, sizeof *opm
);
4395 opm
->port_no
= ofputil_port_to_ofp11(pm
->port_no
);
4396 memcpy(opm
->hw_addr
, pm
->hw_addr
, ETH_ADDR_LEN
);
4397 opm
->config
= htonl(pm
->config
& OFPPC11_ALL
);
4398 opm
->mask
= htonl(pm
->mask
& OFPPC11_ALL
);
4400 if (pm
->advertise
) {
4401 eth
= ofpbuf_put_zeros(b
, sizeof *eth
);
4402 eth
->type
= htons(OFPPMPT14_ETHERNET
);
4403 eth
->length
= htons(sizeof *eth
);
4404 eth
->advertise
= netdev_port_features_to_ofp11(pm
->advertise
);
4416 pull_table_feature_property(struct ofpbuf
*msg
, struct ofpbuf
*payload
,
4421 error
= ofputil_pull_property(msg
, payload
, typep
);
4422 if (payload
&& !error
) {
4423 ofpbuf_pull(payload
, sizeof(struct ofp_prop_header
));
4429 parse_table_ids(struct ofpbuf
*payload
, uint32_t *ids
)
4434 while (ofpbuf_size(payload
) > 0) {
4435 enum ofperr error
= pull_table_feature_property(payload
, NULL
, &type
);
4439 if (type
< CHAR_BIT
* sizeof *ids
) {
4447 parse_instruction_ids(struct ofpbuf
*payload
, bool loose
, uint32_t *insts
)
4450 while (ofpbuf_size(payload
) > 0) {
4451 enum ovs_instruction_type inst
;
4455 error
= pull_table_feature_property(payload
, NULL
, &ofpit
);
4460 error
= ovs_instruction_type_from_inst_type(&inst
, ofpit
);
4462 *insts
|= 1u << inst
;
4463 } else if (!loose
) {
4471 parse_table_features_next_table(struct ofpbuf
*payload
,
4472 unsigned long int *next_tables
)
4476 memset(next_tables
, 0, bitmap_n_bytes(255));
4477 for (i
= 0; i
< ofpbuf_size(payload
); i
++) {
4478 uint8_t id
= ((const uint8_t *) ofpbuf_data(payload
))[i
];
4480 return OFPERR_OFPBPC_BAD_VALUE
;
4482 bitmap_set1(next_tables
, id
);
4488 parse_oxm(struct ofpbuf
*b
, bool loose
,
4489 const struct mf_field
**fieldp
, bool *hasmask
)
4494 oxmp
= ofpbuf_try_pull(b
, sizeof *oxmp
);
4496 return OFPERR_OFPBPC_BAD_LEN
;
4500 /* Determine '*hasmask'. If 'oxm' is masked, convert it to the equivalent
4501 * unmasked version, because the table of OXM fields we support only has
4502 * masked versions of fields that we support with masks, but we should be
4503 * able to parse the masked versions of those here. */
4504 *hasmask
= NXM_HASMASK(oxm
);
4506 if (NXM_LENGTH(oxm
) & 1) {
4507 return OFPERR_OFPBPC_BAD_VALUE
;
4509 oxm
= NXM_HEADER(NXM_VENDOR(oxm
), NXM_FIELD(oxm
), NXM_LENGTH(oxm
) / 2);
4512 *fieldp
= mf_from_nxm_header(oxm
);
4514 log_property(loose
, "unknown OXM field %#"PRIx32
, ntohl(*oxmp
));
4516 return *fieldp
? 0 : OFPERR_OFPBMC_BAD_FIELD
;
4520 parse_oxms(struct ofpbuf
*payload
, bool loose
,
4521 uint64_t *exactp
, uint64_t *maskedp
)
4523 uint64_t exact
, masked
;
4526 while (ofpbuf_size(payload
) > 0) {
4527 const struct mf_field
*field
;
4531 error
= parse_oxm(payload
, loose
, &field
, &hasmask
);
4534 masked
|= UINT64_C(1) << field
->id
;
4536 exact
|= UINT64_C(1) << field
->id
;
4538 } else if (error
!= OFPERR_OFPBMC_BAD_FIELD
|| !loose
) {
4545 return OFPERR_OFPBMC_BAD_MASK
;
4549 } else if (masked
) {
4550 return OFPERR_OFPBMC_BAD_MASK
;
4555 /* Converts an OFPMP_TABLE_FEATURES request or reply in 'msg' into an abstract
4556 * ofputil_table_features in 'tf'.
4558 * If 'loose' is true, this function ignores properties and values that it does
4559 * not understand, as a controller would want to do when interpreting
4560 * capabilities provided by a switch. If 'loose' is false, this function
4561 * treats unknown properties and values as an error, as a switch would want to
4562 * do when interpreting a configuration request made by a controller.
4564 * A single OpenFlow message can specify features for multiple tables. Calling
4565 * this function multiple times for a single 'msg' iterates through the tables
4566 * in the message. The caller must initially leave 'msg''s layer pointers null
4567 * and not modify them between calls.
4569 * Returns 0 if successful, EOF if no tables were left in this 'msg', otherwise
4570 * a positive "enum ofperr" value. */
4572 ofputil_decode_table_features(struct ofpbuf
*msg
,
4573 struct ofputil_table_features
*tf
, bool loose
)
4575 struct ofp13_table_features
*otf
;
4579 ofpraw_pull_assert(msg
);
4582 if (!ofpbuf_size(msg
)) {
4586 if (ofpbuf_size(msg
) < sizeof *otf
) {
4587 return OFPERR_OFPBPC_BAD_LEN
;
4590 otf
= ofpbuf_data(msg
);
4591 len
= ntohs(otf
->length
);
4592 if (len
< sizeof *otf
|| len
% 8 || len
> ofpbuf_size(msg
)) {
4593 return OFPERR_OFPBPC_BAD_LEN
;
4595 ofpbuf_pull(msg
, sizeof *otf
);
4597 tf
->table_id
= otf
->table_id
;
4598 if (tf
->table_id
== OFPTT_ALL
) {
4599 return OFPERR_OFPTFFC_BAD_TABLE
;
4602 ovs_strlcpy(tf
->name
, otf
->name
, OFP_MAX_TABLE_NAME_LEN
);
4603 tf
->metadata_match
= otf
->metadata_match
;
4604 tf
->metadata_write
= otf
->metadata_write
;
4605 tf
->config
= ntohl(otf
->config
);
4606 tf
->max_entries
= ntohl(otf
->max_entries
);
4608 while (ofpbuf_size(msg
) > 0) {
4609 struct ofpbuf payload
;
4613 error
= pull_table_feature_property(msg
, &payload
, &type
);
4618 switch ((enum ofp13_table_feature_prop_type
) type
) {
4619 case OFPTFPT13_INSTRUCTIONS
:
4620 error
= parse_instruction_ids(&payload
, loose
,
4621 &tf
->nonmiss
.instructions
);
4623 case OFPTFPT13_INSTRUCTIONS_MISS
:
4624 error
= parse_instruction_ids(&payload
, loose
,
4625 &tf
->miss
.instructions
);
4628 case OFPTFPT13_NEXT_TABLES
:
4629 error
= parse_table_features_next_table(&payload
,
4632 case OFPTFPT13_NEXT_TABLES_MISS
:
4633 error
= parse_table_features_next_table(&payload
, tf
->miss
.next
);
4636 case OFPTFPT13_WRITE_ACTIONS
:
4637 error
= parse_table_ids(&payload
, &tf
->nonmiss
.write
.actions
);
4639 case OFPTFPT13_WRITE_ACTIONS_MISS
:
4640 error
= parse_table_ids(&payload
, &tf
->miss
.write
.actions
);
4643 case OFPTFPT13_APPLY_ACTIONS
:
4644 error
= parse_table_ids(&payload
, &tf
->nonmiss
.apply
.actions
);
4646 case OFPTFPT13_APPLY_ACTIONS_MISS
:
4647 error
= parse_table_ids(&payload
, &tf
->miss
.apply
.actions
);
4650 case OFPTFPT13_MATCH
:
4651 error
= parse_oxms(&payload
, loose
, &tf
->match
, &tf
->mask
);
4653 case OFPTFPT13_WILDCARDS
:
4654 error
= parse_oxms(&payload
, loose
, &tf
->wildcard
, NULL
);
4657 case OFPTFPT13_WRITE_SETFIELD
:
4658 error
= parse_oxms(&payload
, loose
,
4659 &tf
->nonmiss
.write
.set_fields
, NULL
);
4661 case OFPTFPT13_WRITE_SETFIELD_MISS
:
4662 error
= parse_oxms(&payload
, loose
,
4663 &tf
->miss
.write
.set_fields
, NULL
);
4665 case OFPTFPT13_APPLY_SETFIELD
:
4666 error
= parse_oxms(&payload
, loose
,
4667 &tf
->nonmiss
.apply
.set_fields
, NULL
);
4669 case OFPTFPT13_APPLY_SETFIELD_MISS
:
4670 error
= parse_oxms(&payload
, loose
,
4671 &tf
->miss
.apply
.set_fields
, NULL
);
4674 case OFPTFPT13_EXPERIMENTER
:
4675 case OFPTFPT13_EXPERIMENTER_MISS
:
4677 log_property(loose
, "unknown table features property %"PRIu16
,
4679 error
= loose
? 0 : OFPERR_OFPBPC_BAD_TYPE
;
4687 /* Fix inconsistencies:
4689 * - Turn off 'mask' and 'wildcard' bits that are not in 'match',
4690 * because a field must be matchable to be masked or wildcarded.
4692 * - Turn on 'wildcard' bits that are set in 'mask', because a field
4693 * that is arbitrarily maskable can be wildcarded entirely. */
4694 tf
->mask
&= tf
->match
;
4695 tf
->wildcard
&= tf
->match
;
4697 tf
->wildcard
|= tf
->mask
;
4702 /* Encodes and returns a request to obtain the table features of a switch.
4703 * The message is encoded for OpenFlow version 'ofp_version'. */
4705 ofputil_encode_table_features_request(enum ofp_version ofp_version
)
4707 struct ofpbuf
*request
= NULL
;
4709 switch (ofp_version
) {
4713 ovs_fatal(0, "dump-table-features needs OpenFlow 1.3 or later "
4714 "(\'-O OpenFlow13\')");
4717 request
= ofpraw_alloc(OFPRAW_OFPST13_TABLE_FEATURES_REQUEST
,
4727 /* ofputil_table_mod */
4729 /* Decodes the OpenFlow "table mod" message in '*oh' into an abstract form in
4730 * '*pm'. Returns 0 if successful, otherwise an OFPERR_* value. */
4732 ofputil_decode_table_mod(const struct ofp_header
*oh
,
4733 struct ofputil_table_mod
*pm
)
4738 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4739 raw
= ofpraw_pull_assert(&b
);
4741 if (raw
== OFPRAW_OFPT11_TABLE_MOD
) {
4742 const struct ofp11_table_mod
*otm
= ofpbuf_data(&b
);
4744 pm
->table_id
= otm
->table_id
;
4745 pm
->config
= ntohl(otm
->config
);
4746 } else if (raw
== OFPRAW_OFPT14_TABLE_MOD
) {
4747 const struct ofp14_table_mod
*otm
= ofpbuf_pull(&b
, sizeof *otm
);
4749 pm
->table_id
= otm
->table_id
;
4750 pm
->config
= ntohl(otm
->config
);
4751 /* We do not understand any properties yet, so we do not bother
4754 return OFPERR_OFPBRC_BAD_TYPE
;
4760 /* Converts the abstract form of a "table mod" message in '*pm' into an OpenFlow
4761 * message suitable for 'protocol', and returns that encoded form in a buffer
4762 * owned by the caller. */
4764 ofputil_encode_table_mod(const struct ofputil_table_mod
*pm
,
4765 enum ofputil_protocol protocol
)
4767 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
4770 switch (ofp_version
) {
4771 case OFP10_VERSION
: {
4772 ovs_fatal(0, "table mod needs OpenFlow 1.1 or later "
4773 "(\'-O OpenFlow11\')");
4778 case OFP13_VERSION
: {
4779 struct ofp11_table_mod
*otm
;
4781 b
= ofpraw_alloc(OFPRAW_OFPT11_TABLE_MOD
, ofp_version
, 0);
4782 otm
= ofpbuf_put_zeros(b
, sizeof *otm
);
4783 otm
->table_id
= pm
->table_id
;
4784 otm
->config
= htonl(pm
->config
);
4787 case OFP14_VERSION
: {
4788 struct ofp14_table_mod
*otm
;
4790 b
= ofpraw_alloc(OFPRAW_OFPT14_TABLE_MOD
, ofp_version
, 0);
4791 otm
= ofpbuf_put_zeros(b
, sizeof *otm
);
4792 otm
->table_id
= pm
->table_id
;
4793 otm
->config
= htonl(pm
->config
);
4803 /* ofputil_role_request */
4805 /* Decodes the OpenFlow "role request" or "role reply" message in '*oh' into
4806 * an abstract form in '*rr'. Returns 0 if successful, otherwise an
4807 * OFPERR_* value. */
4809 ofputil_decode_role_message(const struct ofp_header
*oh
,
4810 struct ofputil_role_request
*rr
)
4815 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4816 raw
= ofpraw_pull_assert(&b
);
4818 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
||
4819 raw
== OFPRAW_OFPT12_ROLE_REPLY
) {
4820 const struct ofp12_role_request
*orr
= ofpbuf_l3(&b
);
4822 if (orr
->role
!= htonl(OFPCR12_ROLE_NOCHANGE
) &&
4823 orr
->role
!= htonl(OFPCR12_ROLE_EQUAL
) &&
4824 orr
->role
!= htonl(OFPCR12_ROLE_MASTER
) &&
4825 orr
->role
!= htonl(OFPCR12_ROLE_SLAVE
)) {
4826 return OFPERR_OFPRRFC_BAD_ROLE
;
4829 rr
->role
= ntohl(orr
->role
);
4830 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
4831 ? orr
->role
== htonl(OFPCR12_ROLE_NOCHANGE
)
4832 : orr
->generation_id
== OVS_BE64_MAX
) {
4833 rr
->have_generation_id
= false;
4834 rr
->generation_id
= 0;
4836 rr
->have_generation_id
= true;
4837 rr
->generation_id
= ntohll(orr
->generation_id
);
4839 } else if (raw
== OFPRAW_NXT_ROLE_REQUEST
||
4840 raw
== OFPRAW_NXT_ROLE_REPLY
) {
4841 const struct nx_role_request
*nrr
= ofpbuf_l3(&b
);
4843 BUILD_ASSERT(NX_ROLE_OTHER
+ 1 == OFPCR12_ROLE_EQUAL
);
4844 BUILD_ASSERT(NX_ROLE_MASTER
+ 1 == OFPCR12_ROLE_MASTER
);
4845 BUILD_ASSERT(NX_ROLE_SLAVE
+ 1 == OFPCR12_ROLE_SLAVE
);
4847 if (nrr
->role
!= htonl(NX_ROLE_OTHER
) &&
4848 nrr
->role
!= htonl(NX_ROLE_MASTER
) &&
4849 nrr
->role
!= htonl(NX_ROLE_SLAVE
)) {
4850 return OFPERR_OFPRRFC_BAD_ROLE
;
4853 rr
->role
= ntohl(nrr
->role
) + 1;
4854 rr
->have_generation_id
= false;
4855 rr
->generation_id
= 0;
4863 /* Returns an encoded form of a role reply suitable for the "request" in a
4864 * buffer owned by the caller. */
4866 ofputil_encode_role_reply(const struct ofp_header
*request
,
4867 const struct ofputil_role_request
*rr
)
4872 raw
= ofpraw_decode_assert(request
);
4873 if (raw
== OFPRAW_OFPT12_ROLE_REQUEST
) {
4874 struct ofp12_role_request
*orr
;
4876 buf
= ofpraw_alloc_reply(OFPRAW_OFPT12_ROLE_REPLY
, request
, 0);
4877 orr
= ofpbuf_put_zeros(buf
, sizeof *orr
);
4879 orr
->role
= htonl(rr
->role
);
4880 orr
->generation_id
= htonll(rr
->have_generation_id
4883 } else if (raw
== OFPRAW_NXT_ROLE_REQUEST
) {
4884 struct nx_role_request
*nrr
;
4886 BUILD_ASSERT(NX_ROLE_OTHER
== OFPCR12_ROLE_EQUAL
- 1);
4887 BUILD_ASSERT(NX_ROLE_MASTER
== OFPCR12_ROLE_MASTER
- 1);
4888 BUILD_ASSERT(NX_ROLE_SLAVE
== OFPCR12_ROLE_SLAVE
- 1);
4890 buf
= ofpraw_alloc_reply(OFPRAW_NXT_ROLE_REPLY
, request
, 0);
4891 nrr
= ofpbuf_put_zeros(buf
, sizeof *nrr
);
4892 nrr
->role
= htonl(rr
->role
- 1);
4901 ofputil_encode_role_status(const struct ofputil_role_status
*status
,
4902 enum ofputil_protocol protocol
)
4905 enum ofp_version version
;
4906 struct ofp14_role_status
*rstatus
;
4908 version
= ofputil_protocol_to_ofp_version(protocol
);
4909 buf
= ofpraw_alloc_xid(OFPRAW_OFPT14_ROLE_STATUS
, version
, htonl(0), 0);
4910 rstatus
= ofpbuf_put_zeros(buf
, sizeof *rstatus
);
4911 rstatus
->role
= htonl(status
->role
);
4912 rstatus
->reason
= status
->reason
;
4913 rstatus
->generation_id
= htonll(status
->generation_id
);
4919 ofputil_decode_role_status(const struct ofp_header
*oh
,
4920 struct ofputil_role_status
*rs
)
4924 const struct ofp14_role_status
*r
;
4926 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
4927 raw
= ofpraw_pull_assert(&b
);
4928 ovs_assert(raw
== OFPRAW_OFPT14_ROLE_STATUS
);
4931 if (r
->role
!= htonl(OFPCR12_ROLE_NOCHANGE
) &&
4932 r
->role
!= htonl(OFPCR12_ROLE_EQUAL
) &&
4933 r
->role
!= htonl(OFPCR12_ROLE_MASTER
) &&
4934 r
->role
!= htonl(OFPCR12_ROLE_SLAVE
)) {
4935 return OFPERR_OFPRRFC_BAD_ROLE
;
4938 rs
->role
= ntohl(r
->role
);
4939 rs
->generation_id
= ntohll(r
->generation_id
);
4940 rs
->reason
= r
->reason
;
4948 ofputil_put_ofp10_table_stats(const struct ofp12_table_stats
*in
,
4952 enum ofp10_flow_wildcards wc10
;
4953 enum oxm12_ofb_match_fields mf12
;
4956 static const struct wc_map wc_map
[] = {
4957 { OFPFW10_IN_PORT
, OFPXMT12_OFB_IN_PORT
},
4958 { OFPFW10_DL_VLAN
, OFPXMT12_OFB_VLAN_VID
},
4959 { OFPFW10_DL_SRC
, OFPXMT12_OFB_ETH_SRC
},
4960 { OFPFW10_DL_DST
, OFPXMT12_OFB_ETH_DST
},
4961 { OFPFW10_DL_TYPE
, OFPXMT12_OFB_ETH_TYPE
},
4962 { OFPFW10_NW_PROTO
, OFPXMT12_OFB_IP_PROTO
},
4963 { OFPFW10_TP_SRC
, OFPXMT12_OFB_TCP_SRC
},
4964 { OFPFW10_TP_DST
, OFPXMT12_OFB_TCP_DST
},
4965 { OFPFW10_NW_SRC_MASK
, OFPXMT12_OFB_IPV4_SRC
},
4966 { OFPFW10_NW_DST_MASK
, OFPXMT12_OFB_IPV4_DST
},
4967 { OFPFW10_DL_VLAN_PCP
, OFPXMT12_OFB_VLAN_PCP
},
4968 { OFPFW10_NW_TOS
, OFPXMT12_OFB_IP_DSCP
},
4971 struct ofp10_table_stats
*out
;
4972 const struct wc_map
*p
;
4974 out
= ofpbuf_put_zeros(buf
, sizeof *out
);
4975 out
->table_id
= in
->table_id
;
4976 ovs_strlcpy(out
->name
, in
->name
, sizeof out
->name
);
4978 for (p
= wc_map
; p
< &wc_map
[ARRAY_SIZE(wc_map
)]; p
++) {
4979 if (in
->wildcards
& htonll(1ULL << p
->mf12
)) {
4980 out
->wildcards
|= htonl(p
->wc10
);
4983 out
->max_entries
= in
->max_entries
;
4984 out
->active_count
= in
->active_count
;
4985 put_32aligned_be64(&out
->lookup_count
, in
->lookup_count
);
4986 put_32aligned_be64(&out
->matched_count
, in
->matched_count
);
4990 oxm12_to_ofp11_flow_match_fields(ovs_be64 oxm12
)
4993 enum ofp11_flow_match_fields fmf11
;
4994 enum oxm12_ofb_match_fields mf12
;
4997 static const struct map map
[] = {
4998 { OFPFMF11_IN_PORT
, OFPXMT12_OFB_IN_PORT
},
4999 { OFPFMF11_DL_VLAN
, OFPXMT12_OFB_VLAN_VID
},
5000 { OFPFMF11_DL_VLAN_PCP
, OFPXMT12_OFB_VLAN_PCP
},
5001 { OFPFMF11_DL_TYPE
, OFPXMT12_OFB_ETH_TYPE
},
5002 { OFPFMF11_NW_TOS
, OFPXMT12_OFB_IP_DSCP
},
5003 { OFPFMF11_NW_PROTO
, OFPXMT12_OFB_IP_PROTO
},
5004 { OFPFMF11_TP_SRC
, OFPXMT12_OFB_TCP_SRC
},
5005 { OFPFMF11_TP_DST
, OFPXMT12_OFB_TCP_DST
},
5006 { OFPFMF11_MPLS_LABEL
, OFPXMT12_OFB_MPLS_LABEL
},
5007 { OFPFMF11_MPLS_TC
, OFPXMT12_OFB_MPLS_TC
},
5008 /* I don't know what OFPFMF11_TYPE means. */
5009 { OFPFMF11_DL_SRC
, OFPXMT12_OFB_ETH_SRC
},
5010 { OFPFMF11_DL_DST
, OFPXMT12_OFB_ETH_DST
},
5011 { OFPFMF11_NW_SRC
, OFPXMT12_OFB_IPV4_SRC
},
5012 { OFPFMF11_NW_DST
, OFPXMT12_OFB_IPV4_DST
},
5013 { OFPFMF11_METADATA
, OFPXMT12_OFB_METADATA
},
5016 const struct map
*p
;
5020 for (p
= map
; p
< &map
[ARRAY_SIZE(map
)]; p
++) {
5021 if (oxm12
& htonll(1ULL << p
->mf12
)) {
5025 return htonl(fmf11
);
5029 ofputil_put_ofp11_table_stats(const struct ofp12_table_stats
*in
,
5032 struct ofp11_table_stats
*out
;
5034 out
= ofpbuf_put_zeros(buf
, sizeof *out
);
5035 out
->table_id
= in
->table_id
;
5036 ovs_strlcpy(out
->name
, in
->name
, sizeof out
->name
);
5037 out
->wildcards
= oxm12_to_ofp11_flow_match_fields(in
->wildcards
);
5038 out
->match
= oxm12_to_ofp11_flow_match_fields(in
->match
);
5039 out
->instructions
= in
->instructions
;
5040 out
->write_actions
= in
->write_actions
;
5041 out
->apply_actions
= in
->apply_actions
;
5042 out
->config
= in
->config
;
5043 out
->max_entries
= in
->max_entries
;
5044 out
->active_count
= in
->active_count
;
5045 out
->lookup_count
= in
->lookup_count
;
5046 out
->matched_count
= in
->matched_count
;
5050 ofputil_put_ofp12_table_stats(const struct ofp12_table_stats
*in
,
5053 struct ofp12_table_stats
*out
= ofpbuf_put(buf
, in
, sizeof *in
);
5055 /* Trim off OF1.3-only capabilities. */
5056 out
->match
&= htonll(OFPXMT12_MASK
);
5057 out
->wildcards
&= htonll(OFPXMT12_MASK
);
5058 out
->write_setfields
&= htonll(OFPXMT12_MASK
);
5059 out
->apply_setfields
&= htonll(OFPXMT12_MASK
);
5063 ofputil_put_ofp13_table_stats(const struct ofp12_table_stats
*in
,
5066 struct ofp13_table_stats
*out
;
5068 /* OF 1.3 splits table features off the ofp_table_stats,
5069 * so there is not much here. */
5071 out
= ofpbuf_put_uninit(buf
, sizeof *out
);
5072 out
->table_id
= in
->table_id
;
5073 out
->active_count
= in
->active_count
;
5074 out
->lookup_count
= in
->lookup_count
;
5075 out
->matched_count
= in
->matched_count
;
5079 ofputil_encode_table_stats_reply(const struct ofp12_table_stats stats
[], int n
,
5080 const struct ofp_header
*request
)
5082 struct ofpbuf
*reply
;
5085 reply
= ofpraw_alloc_stats_reply(request
, n
* sizeof *stats
);
5087 for (i
= 0; i
< n
; i
++) {
5088 switch ((enum ofp_version
) request
->version
) {
5090 ofputil_put_ofp10_table_stats(&stats
[i
], reply
);
5094 ofputil_put_ofp11_table_stats(&stats
[i
], reply
);
5098 ofputil_put_ofp12_table_stats(&stats
[i
], reply
);
5103 ofputil_put_ofp13_table_stats(&stats
[i
], reply
);
5114 /* ofputil_flow_monitor_request */
5116 /* Converts an NXST_FLOW_MONITOR request in 'msg' into an abstract
5117 * ofputil_flow_monitor_request in 'rq'.
5119 * Multiple NXST_FLOW_MONITOR requests can be packed into a single OpenFlow
5120 * message. Calling this function multiple times for a single 'msg' iterates
5121 * through the requests. The caller must initially leave 'msg''s layer
5122 * pointers null and not modify them between calls.
5124 * Returns 0 if successful, EOF if no requests were left in this 'msg',
5125 * otherwise an OFPERR_* value. */
5127 ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request
*rq
,
5130 struct nx_flow_monitor_request
*nfmr
;
5134 ofpraw_pull_assert(msg
);
5137 if (!ofpbuf_size(msg
)) {
5141 nfmr
= ofpbuf_try_pull(msg
, sizeof *nfmr
);
5143 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR request has %"PRIu32
" "
5144 "leftover bytes at end", ofpbuf_size(msg
));
5145 return OFPERR_OFPBRC_BAD_LEN
;
5148 flags
= ntohs(nfmr
->flags
);
5149 if (!(flags
& (NXFMF_ADD
| NXFMF_DELETE
| NXFMF_MODIFY
))
5150 || flags
& ~(NXFMF_INITIAL
| NXFMF_ADD
| NXFMF_DELETE
5151 | NXFMF_MODIFY
| NXFMF_ACTIONS
| NXFMF_OWN
)) {
5152 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR has bad flags %#"PRIx16
,
5154 return OFPERR_NXBRC_FM_BAD_FLAGS
;
5157 if (!is_all_zeros(nfmr
->zeros
, sizeof nfmr
->zeros
)) {
5158 return OFPERR_NXBRC_MUST_BE_ZERO
;
5161 rq
->id
= ntohl(nfmr
->id
);
5163 rq
->out_port
= u16_to_ofp(ntohs(nfmr
->out_port
));
5164 rq
->table_id
= nfmr
->table_id
;
5166 return nx_pull_match(msg
, ntohs(nfmr
->match_len
), &rq
->match
, NULL
, NULL
);
5170 ofputil_append_flow_monitor_request(
5171 const struct ofputil_flow_monitor_request
*rq
, struct ofpbuf
*msg
)
5173 struct nx_flow_monitor_request
*nfmr
;
5177 if (!ofpbuf_size(msg
)) {
5178 ofpraw_put(OFPRAW_NXST_FLOW_MONITOR_REQUEST
, OFP10_VERSION
, msg
);
5181 start_ofs
= ofpbuf_size(msg
);
5182 ofpbuf_put_zeros(msg
, sizeof *nfmr
);
5183 match_len
= nx_put_match(msg
, &rq
->match
, htonll(0), htonll(0));
5185 nfmr
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfmr
);
5186 nfmr
->id
= htonl(rq
->id
);
5187 nfmr
->flags
= htons(rq
->flags
);
5188 nfmr
->out_port
= htons(ofp_to_u16(rq
->out_port
));
5189 nfmr
->match_len
= htons(match_len
);
5190 nfmr
->table_id
= rq
->table_id
;
5193 /* Converts an NXST_FLOW_MONITOR reply (also known as a flow update) in 'msg'
5194 * into an abstract ofputil_flow_update in 'update'. The caller must have
5195 * initialized update->match to point to space allocated for a match.
5197 * Uses 'ofpacts' to store the abstract OFPACT_* version of the update's
5198 * actions (except for NXFME_ABBREV, which never includes actions). The caller
5199 * must initialize 'ofpacts' and retains ownership of it. 'update->ofpacts'
5200 * will point into the 'ofpacts' buffer.
5202 * Multiple flow updates can be packed into a single OpenFlow message. Calling
5203 * this function multiple times for a single 'msg' iterates through the
5204 * updates. The caller must initially leave 'msg''s layer pointers null and
5205 * not modify them between calls.
5207 * Returns 0 if successful, EOF if no updates were left in this 'msg',
5208 * otherwise an OFPERR_* value. */
5210 ofputil_decode_flow_update(struct ofputil_flow_update
*update
,
5211 struct ofpbuf
*msg
, struct ofpbuf
*ofpacts
)
5213 struct nx_flow_update_header
*nfuh
;
5214 unsigned int length
;
5215 struct ofp_header
*oh
;
5218 ofpraw_pull_assert(msg
);
5221 if (!ofpbuf_size(msg
)) {
5225 if (ofpbuf_size(msg
) < sizeof(struct nx_flow_update_header
)) {
5231 nfuh
= ofpbuf_data(msg
);
5232 update
->event
= ntohs(nfuh
->event
);
5233 length
= ntohs(nfuh
->length
);
5234 if (length
> ofpbuf_size(msg
) || length
% 8) {
5238 if (update
->event
== NXFME_ABBREV
) {
5239 struct nx_flow_update_abbrev
*nfua
;
5241 if (length
!= sizeof *nfua
) {
5245 nfua
= ofpbuf_pull(msg
, sizeof *nfua
);
5246 update
->xid
= nfua
->xid
;
5248 } else if (update
->event
== NXFME_ADDED
5249 || update
->event
== NXFME_DELETED
5250 || update
->event
== NXFME_MODIFIED
) {
5251 struct nx_flow_update_full
*nfuf
;
5252 unsigned int actions_len
;
5253 unsigned int match_len
;
5256 if (length
< sizeof *nfuf
) {
5260 nfuf
= ofpbuf_pull(msg
, sizeof *nfuf
);
5261 match_len
= ntohs(nfuf
->match_len
);
5262 if (sizeof *nfuf
+ match_len
> length
) {
5266 update
->reason
= ntohs(nfuf
->reason
);
5267 update
->idle_timeout
= ntohs(nfuf
->idle_timeout
);
5268 update
->hard_timeout
= ntohs(nfuf
->hard_timeout
);
5269 update
->table_id
= nfuf
->table_id
;
5270 update
->cookie
= nfuf
->cookie
;
5271 update
->priority
= ntohs(nfuf
->priority
);
5273 error
= nx_pull_match(msg
, match_len
, update
->match
, NULL
, NULL
);
5278 actions_len
= length
- sizeof *nfuf
- ROUND_UP(match_len
, 8);
5279 error
= ofpacts_pull_openflow_actions(msg
, actions_len
, oh
->version
,
5285 update
->ofpacts
= ofpbuf_data(ofpacts
);
5286 update
->ofpacts_len
= ofpbuf_size(ofpacts
);
5289 VLOG_WARN_RL(&bad_ofmsg_rl
,
5290 "NXST_FLOW_MONITOR reply has bad event %"PRIu16
,
5291 ntohs(nfuh
->event
));
5292 return OFPERR_NXBRC_FM_BAD_EVENT
;
5296 VLOG_WARN_RL(&bad_ofmsg_rl
, "NXST_FLOW_MONITOR reply has %"PRIu32
" "
5297 "leftover bytes at end", ofpbuf_size(msg
));
5298 return OFPERR_OFPBRC_BAD_LEN
;
5302 ofputil_decode_flow_monitor_cancel(const struct ofp_header
*oh
)
5304 const struct nx_flow_monitor_cancel
*cancel
= ofpmsg_body(oh
);
5306 return ntohl(cancel
->id
);
5310 ofputil_encode_flow_monitor_cancel(uint32_t id
)
5312 struct nx_flow_monitor_cancel
*nfmc
;
5315 msg
= ofpraw_alloc(OFPRAW_NXT_FLOW_MONITOR_CANCEL
, OFP10_VERSION
, 0);
5316 nfmc
= ofpbuf_put_uninit(msg
, sizeof *nfmc
);
5317 nfmc
->id
= htonl(id
);
5322 ofputil_start_flow_update(struct list
*replies
)
5326 msg
= ofpraw_alloc_xid(OFPRAW_NXST_FLOW_MONITOR_REPLY
, OFP10_VERSION
,
5330 list_push_back(replies
, &msg
->list_node
);
5334 ofputil_append_flow_update(const struct ofputil_flow_update
*update
,
5335 struct list
*replies
)
5337 enum ofp_version version
= ofpmp_version(replies
);
5338 struct nx_flow_update_header
*nfuh
;
5342 msg
= ofpbuf_from_list(list_back(replies
));
5343 start_ofs
= ofpbuf_size(msg
);
5345 if (update
->event
== NXFME_ABBREV
) {
5346 struct nx_flow_update_abbrev
*nfua
;
5348 nfua
= ofpbuf_put_zeros(msg
, sizeof *nfua
);
5349 nfua
->xid
= update
->xid
;
5351 struct nx_flow_update_full
*nfuf
;
5354 ofpbuf_put_zeros(msg
, sizeof *nfuf
);
5355 match_len
= nx_put_match(msg
, update
->match
, htonll(0), htonll(0));
5356 ofpacts_put_openflow_actions(update
->ofpacts
, update
->ofpacts_len
, msg
,
5358 nfuf
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfuf
);
5359 nfuf
->reason
= htons(update
->reason
);
5360 nfuf
->priority
= htons(update
->priority
);
5361 nfuf
->idle_timeout
= htons(update
->idle_timeout
);
5362 nfuf
->hard_timeout
= htons(update
->hard_timeout
);
5363 nfuf
->match_len
= htons(match_len
);
5364 nfuf
->table_id
= update
->table_id
;
5365 nfuf
->cookie
= update
->cookie
;
5368 nfuh
= ofpbuf_at_assert(msg
, start_ofs
, sizeof *nfuh
);
5369 nfuh
->length
= htons(ofpbuf_size(msg
) - start_ofs
);
5370 nfuh
->event
= htons(update
->event
);
5372 ofpmp_postappend(replies
, start_ofs
);
5376 ofputil_encode_packet_out(const struct ofputil_packet_out
*po
,
5377 enum ofputil_protocol protocol
)
5379 enum ofp_version ofp_version
= ofputil_protocol_to_ofp_version(protocol
);
5383 size
= po
->ofpacts_len
;
5384 if (po
->buffer_id
== UINT32_MAX
) {
5385 size
+= po
->packet_len
;
5388 switch (ofp_version
) {
5389 case OFP10_VERSION
: {
5390 struct ofp10_packet_out
*opo
;
5393 msg
= ofpraw_alloc(OFPRAW_OFPT10_PACKET_OUT
, OFP10_VERSION
, size
);
5394 ofpbuf_put_zeros(msg
, sizeof *opo
);
5395 actions_ofs
= ofpbuf_size(msg
);
5396 ofpacts_put_openflow_actions(po
->ofpacts
, po
->ofpacts_len
, msg
,
5399 opo
= ofpbuf_l3(msg
);
5400 opo
->buffer_id
= htonl(po
->buffer_id
);
5401 opo
->in_port
= htons(ofp_to_u16(po
->in_port
));
5402 opo
->actions_len
= htons(ofpbuf_size(msg
) - actions_ofs
);
5409 case OFP14_VERSION
:{
5410 struct ofp11_packet_out
*opo
;
5413 msg
= ofpraw_alloc(OFPRAW_OFPT11_PACKET_OUT
, ofp_version
, size
);
5414 ofpbuf_put_zeros(msg
, sizeof *opo
);
5415 len
= ofpacts_put_openflow_actions(po
->ofpacts
, po
->ofpacts_len
, msg
,
5417 opo
= ofpbuf_l3(msg
);
5418 opo
->buffer_id
= htonl(po
->buffer_id
);
5419 opo
->in_port
= ofputil_port_to_ofp11(po
->in_port
);
5420 opo
->actions_len
= htons(len
);
5428 if (po
->buffer_id
== UINT32_MAX
) {
5429 ofpbuf_put(msg
, po
->packet
, po
->packet_len
);
5432 ofpmsg_update_length(msg
);
5437 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
5439 make_echo_request(enum ofp_version ofp_version
)
5441 return ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST
, ofp_version
,
5445 /* Creates and returns an OFPT_ECHO_REPLY message matching the
5446 * OFPT_ECHO_REQUEST message in 'rq'. */
5448 make_echo_reply(const struct ofp_header
*rq
)
5450 struct ofpbuf rq_buf
;
5451 struct ofpbuf
*reply
;
5453 ofpbuf_use_const(&rq_buf
, rq
, ntohs(rq
->length
));
5454 ofpraw_pull_assert(&rq_buf
);
5456 reply
= ofpraw_alloc_reply(OFPRAW_OFPT_ECHO_REPLY
, rq
, ofpbuf_size(&rq_buf
));
5457 ofpbuf_put(reply
, ofpbuf_data(&rq_buf
), ofpbuf_size(&rq_buf
));
5462 ofputil_encode_barrier_request(enum ofp_version ofp_version
)
5466 switch (ofp_version
) {
5471 type
= OFPRAW_OFPT11_BARRIER_REQUEST
;
5475 type
= OFPRAW_OFPT10_BARRIER_REQUEST
;
5482 return ofpraw_alloc(type
, ofp_version
, 0);
5486 ofputil_frag_handling_to_string(enum ofp_config_flags flags
)
5488 switch (flags
& OFPC_FRAG_MASK
) {
5489 case OFPC_FRAG_NORMAL
: return "normal";
5490 case OFPC_FRAG_DROP
: return "drop";
5491 case OFPC_FRAG_REASM
: return "reassemble";
5492 case OFPC_FRAG_NX_MATCH
: return "nx-match";
5499 ofputil_frag_handling_from_string(const char *s
, enum ofp_config_flags
*flags
)
5501 if (!strcasecmp(s
, "normal")) {
5502 *flags
= OFPC_FRAG_NORMAL
;
5503 } else if (!strcasecmp(s
, "drop")) {
5504 *flags
= OFPC_FRAG_DROP
;
5505 } else if (!strcasecmp(s
, "reassemble")) {
5506 *flags
= OFPC_FRAG_REASM
;
5507 } else if (!strcasecmp(s
, "nx-match")) {
5508 *flags
= OFPC_FRAG_NX_MATCH
;
5515 /* Converts the OpenFlow 1.1+ port number 'ofp11_port' into an OpenFlow 1.0
5516 * port number and stores the latter in '*ofp10_port', for the purpose of
5517 * decoding OpenFlow 1.1+ protocol messages. Returns 0 if successful,
5518 * otherwise an OFPERR_* number. On error, stores OFPP_NONE in '*ofp10_port'.
5520 * See the definition of OFP11_MAX for an explanation of the mapping. */
5522 ofputil_port_from_ofp11(ovs_be32 ofp11_port
, ofp_port_t
*ofp10_port
)
5524 uint32_t ofp11_port_h
= ntohl(ofp11_port
);
5526 if (ofp11_port_h
< ofp_to_u16(OFPP_MAX
)) {
5527 *ofp10_port
= u16_to_ofp(ofp11_port_h
);
5529 } else if (ofp11_port_h
>= ofp11_to_u32(OFPP11_MAX
)) {
5530 *ofp10_port
= u16_to_ofp(ofp11_port_h
- OFPP11_OFFSET
);
5533 *ofp10_port
= OFPP_NONE
;
5534 VLOG_WARN_RL(&bad_ofmsg_rl
, "port %"PRIu32
" is outside the supported "
5535 "range 0 through %d or 0x%"PRIx32
" through 0x%"PRIx32
,
5536 ofp11_port_h
, ofp_to_u16(OFPP_MAX
) - 1,
5537 ofp11_to_u32(OFPP11_MAX
), UINT32_MAX
);
5538 return OFPERR_OFPBAC_BAD_OUT_PORT
;
5542 /* Returns the OpenFlow 1.1+ port number equivalent to the OpenFlow 1.0 port
5543 * number 'ofp10_port', for encoding OpenFlow 1.1+ protocol messages.
5545 * See the definition of OFP11_MAX for an explanation of the mapping. */
5547 ofputil_port_to_ofp11(ofp_port_t ofp10_port
)
5549 return htonl(ofp_to_u16(ofp10_port
) < ofp_to_u16(OFPP_MAX
)
5550 ? ofp_to_u16(ofp10_port
)
5551 : ofp_to_u16(ofp10_port
) + OFPP11_OFFSET
);
5554 #define OFPUTIL_NAMED_PORTS \
5555 OFPUTIL_NAMED_PORT(IN_PORT) \
5556 OFPUTIL_NAMED_PORT(TABLE) \
5557 OFPUTIL_NAMED_PORT(NORMAL) \
5558 OFPUTIL_NAMED_PORT(FLOOD) \
5559 OFPUTIL_NAMED_PORT(ALL) \
5560 OFPUTIL_NAMED_PORT(CONTROLLER) \
5561 OFPUTIL_NAMED_PORT(LOCAL) \
5562 OFPUTIL_NAMED_PORT(ANY)
5564 /* For backwards compatibility, so that "none" is recognized as OFPP_ANY */
5565 #define OFPUTIL_NAMED_PORTS_WITH_NONE \
5566 OFPUTIL_NAMED_PORTS \
5567 OFPUTIL_NAMED_PORT(NONE)
5569 /* Stores the port number represented by 's' into '*portp'. 's' may be an
5570 * integer or, for reserved ports, the standard OpenFlow name for the port
5573 * Returns true if successful, false if 's' is not a valid OpenFlow port number
5574 * or name. The caller should issue an error message in this case, because
5575 * this function usually does not. (This gives the caller an opportunity to
5576 * look up the port name another way, e.g. by contacting the switch and listing
5577 * the names of all its ports).
5579 * This function accepts OpenFlow 1.0 port numbers. It also accepts a subset
5580 * of OpenFlow 1.1+ port numbers, mapping those port numbers into the 16-bit
5581 * range as described in include/openflow/openflow-1.1.h. */
5583 ofputil_port_from_string(const char *s
, ofp_port_t
*portp
)
5585 unsigned int port32
; /* int is at least 32 bits wide. */
5588 VLOG_WARN("Negative value %s is not a valid port number.", s
);
5592 if (str_to_uint(s
, 10, &port32
)) {
5593 if (port32
< ofp_to_u16(OFPP_MAX
)) {
5595 } else if (port32
< ofp_to_u16(OFPP_FIRST_RESV
)) {
5596 VLOG_WARN("port %u is a reserved OF1.0 port number that will "
5597 "be translated to %u when talking to an OF1.1 or "
5598 "later controller", port32
, port32
+ OFPP11_OFFSET
);
5599 } else if (port32
<= ofp_to_u16(OFPP_LAST_RESV
)) {
5600 char name
[OFP_MAX_PORT_NAME_LEN
];
5602 ofputil_port_to_string(u16_to_ofp(port32
), name
, sizeof name
);
5603 VLOG_WARN_ONCE("referring to port %s as %"PRIu32
" is deprecated "
5604 "for compatibility with OpenFlow 1.1 and later",
5606 } else if (port32
< ofp11_to_u32(OFPP11_MAX
)) {
5607 VLOG_WARN("port %u is outside the supported range 0 through "
5608 "%"PRIx16
" or 0x%x through 0x%"PRIx32
, port32
,
5609 UINT16_MAX
, ofp11_to_u32(OFPP11_MAX
), UINT32_MAX
);
5612 port32
-= OFPP11_OFFSET
;
5615 *portp
= u16_to_ofp(port32
);
5622 static const struct pair pairs
[] = {
5623 #define OFPUTIL_NAMED_PORT(NAME) {#NAME, OFPP_##NAME},
5624 OFPUTIL_NAMED_PORTS_WITH_NONE
5625 #undef OFPUTIL_NAMED_PORT
5627 const struct pair
*p
;
5629 for (p
= pairs
; p
< &pairs
[ARRAY_SIZE(pairs
)]; p
++) {
5630 if (!strcasecmp(s
, p
->name
)) {
5639 /* Appends to 's' a string representation of the OpenFlow port number 'port'.
5640 * Most ports' string representation is just the port number, but for special
5641 * ports, e.g. OFPP_LOCAL, it is the name, e.g. "LOCAL". */
5643 ofputil_format_port(ofp_port_t port
, struct ds
*s
)
5645 char name
[OFP_MAX_PORT_NAME_LEN
];
5647 ofputil_port_to_string(port
, name
, sizeof name
);
5648 ds_put_cstr(s
, name
);
5651 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5652 * representation of OpenFlow port number 'port'. Most ports are represented
5653 * as just the port number, but special ports, e.g. OFPP_LOCAL, are represented
5654 * by name, e.g. "LOCAL". */
5656 ofputil_port_to_string(ofp_port_t port
,
5657 char namebuf
[OFP_MAX_PORT_NAME_LEN
], size_t bufsize
)
5660 #define OFPUTIL_NAMED_PORT(NAME) \
5662 ovs_strlcpy(namebuf, #NAME, bufsize); \
5665 #undef OFPUTIL_NAMED_PORT
5668 snprintf(namebuf
, bufsize
, "%"PRIu16
, port
);
5673 /* Stores the group id represented by 's' into '*group_idp'. 's' may be an
5674 * integer or, for reserved group IDs, the standard OpenFlow name for the group
5675 * (either "ANY" or "ALL").
5677 * Returns true if successful, false if 's' is not a valid OpenFlow group ID or
5680 ofputil_group_from_string(const char *s
, uint32_t *group_idp
)
5682 if (!strcasecmp(s
, "any")) {
5683 *group_idp
= OFPG11_ANY
;
5684 } else if (!strcasecmp(s
, "all")) {
5685 *group_idp
= OFPG11_ALL
;
5686 } else if (!str_to_uint(s
, 10, group_idp
)) {
5687 VLOG_WARN("%s is not a valid group ID. (Valid group IDs are "
5688 "32-bit nonnegative integers or the keywords ANY or "
5696 /* Appends to 's' a string representation of the OpenFlow group ID 'group_id'.
5697 * Most groups' string representation is just the number, but for special
5698 * groups, e.g. OFPG11_ALL, it is the name, e.g. "ALL". */
5700 ofputil_format_group(uint32_t group_id
, struct ds
*s
)
5702 char name
[MAX_GROUP_NAME_LEN
];
5704 ofputil_group_to_string(group_id
, name
, sizeof name
);
5705 ds_put_cstr(s
, name
);
5709 /* Puts in the 'bufsize' byte in 'namebuf' a null-terminated string
5710 * representation of OpenFlow group ID 'group_id'. Most group are represented
5711 * as just their number, but special groups, e.g. OFPG11_ALL, are represented
5712 * by name, e.g. "ALL". */
5714 ofputil_group_to_string(uint32_t group_id
,
5715 char namebuf
[MAX_GROUP_NAME_LEN
+ 1], size_t bufsize
)
5719 ovs_strlcpy(namebuf
, "ALL", bufsize
);
5723 ovs_strlcpy(namebuf
, "ANY", bufsize
);
5727 snprintf(namebuf
, bufsize
, "%"PRIu32
, group_id
);
5732 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
5733 * 'ofp_version', tries to pull the first element from the array. If
5734 * successful, initializes '*pp' with an abstract representation of the
5735 * port and returns 0. If no ports remain to be decoded, returns EOF.
5736 * On an error, returns a positive OFPERR_* value. */
5738 ofputil_pull_phy_port(enum ofp_version ofp_version
, struct ofpbuf
*b
,
5739 struct ofputil_phy_port
*pp
)
5741 memset(pp
, 0, sizeof *pp
);
5743 switch (ofp_version
) {
5744 case OFP10_VERSION
: {
5745 const struct ofp10_phy_port
*opp
= ofpbuf_try_pull(b
, sizeof *opp
);
5746 return opp
? ofputil_decode_ofp10_phy_port(pp
, opp
) : EOF
;
5750 case OFP13_VERSION
: {
5751 const struct ofp11_port
*op
= ofpbuf_try_pull(b
, sizeof *op
);
5752 return op
? ofputil_decode_ofp11_port(pp
, op
) : EOF
;
5755 return ofpbuf_size(b
) ? ofputil_pull_ofp14_port(pp
, b
) : EOF
;
5761 /* ofp-util.def lists the mapping from names to action. */
5762 static const char *const names
[OFPUTIL_N_ACTIONS
] = {
5764 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) NAME,
5765 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5766 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5767 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) NAME,
5768 #include "ofp-util.def"
5771 /* Returns the 'enum ofputil_action_code' corresponding to 'name' (e.g. if
5772 * 'name' is "output" then the return value is OFPUTIL_OFPAT10_OUTPUT), or -1
5773 * if 'name' is not the name of any action. */
5775 ofputil_action_code_from_name(const char *name
)
5777 const char *const *p
;
5779 for (p
= names
; p
< &names
[ARRAY_SIZE(names
)]; p
++) {
5780 if (*p
&& !strcasecmp(name
, *p
)) {
5787 /* Returns name corresponding to the 'enum ofputil_action_code',
5788 * or "Unkonwn action", if the name is not available. */
5790 ofputil_action_name_from_code(enum ofputil_action_code code
)
5792 return code
< (int)OFPUTIL_N_ACTIONS
&& names
[code
] ? names
[code
]
5796 enum ofputil_action_code
5797 ofputil_action_code_from_ofp13_action(enum ofp13_action_type type
)
5801 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5803 return OFPUTIL_##ENUM;
5804 #include "ofp-util.def"
5807 return OFPUTIL_ACTION_INVALID
;
5811 /* Appends an action of the type specified by 'code' to 'buf' and returns the
5812 * action. Initializes the parts of 'action' that identify it as having type
5813 * <ENUM> and length 'sizeof *action' and zeros the rest. For actions that
5814 * have variable length, the length used and cleared is that of struct
5817 ofputil_put_action(enum ofputil_action_code code
, struct ofpbuf
*buf
)
5820 case OFPUTIL_ACTION_INVALID
:
5821 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
5822 #include "ofp-util.def"
5825 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5826 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5827 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5828 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5829 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5830 case OFPUTIL_##ENUM: return ofputil_put_##ENUM(buf);
5831 #include "ofp-util.def"
5836 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
5838 ofputil_init_##ENUM(struct STRUCT *s) \
5840 memset(s, 0, sizeof *s); \
5841 s->type = htons(ENUM); \
5842 s->len = htons(sizeof *s); \
5846 ofputil_put_##ENUM(struct ofpbuf *buf) \
5848 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5849 ofputil_init_##ENUM(s); \
5852 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5853 OFPAT10_ACTION(ENUM, STRUCT, NAME)
5854 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5855 OFPAT10_ACTION(ENUM, STRUCT, NAME)
5856 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
5858 ofputil_init_##ENUM(struct STRUCT *s) \
5860 memset(s, 0, sizeof *s); \
5861 s->type = htons(OFPAT10_VENDOR); \
5862 s->len = htons(sizeof *s); \
5863 s->vendor = htonl(NX_VENDOR_ID); \
5864 s->subtype = htons(ENUM); \
5868 ofputil_put_##ENUM(struct ofpbuf *buf) \
5870 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
5871 ofputil_init_##ENUM(s); \
5874 #include "ofp-util.def"
5877 ofputil_normalize_match__(struct match
*match
, bool may_log
)
5880 MAY_NW_ADDR
= 1 << 0, /* nw_src, nw_dst */
5881 MAY_TP_ADDR
= 1 << 1, /* tp_src, tp_dst */
5882 MAY_NW_PROTO
= 1 << 2, /* nw_proto */
5883 MAY_IPVx
= 1 << 3, /* tos, frag, ttl */
5884 MAY_ARP_SHA
= 1 << 4, /* arp_sha */
5885 MAY_ARP_THA
= 1 << 5, /* arp_tha */
5886 MAY_IPV6
= 1 << 6, /* ipv6_src, ipv6_dst, ipv6_label */
5887 MAY_ND_TARGET
= 1 << 7, /* nd_target */
5888 MAY_MPLS
= 1 << 8, /* mpls label and tc */
5891 struct flow_wildcards wc
;
5893 /* Figure out what fields may be matched. */
5894 if (match
->flow
.dl_type
== htons(ETH_TYPE_IP
)) {
5895 may_match
= MAY_NW_PROTO
| MAY_IPVx
| MAY_NW_ADDR
;
5896 if (match
->flow
.nw_proto
== IPPROTO_TCP
||
5897 match
->flow
.nw_proto
== IPPROTO_UDP
||
5898 match
->flow
.nw_proto
== IPPROTO_SCTP
||
5899 match
->flow
.nw_proto
== IPPROTO_ICMP
) {
5900 may_match
|= MAY_TP_ADDR
;
5902 } else if (match
->flow
.dl_type
== htons(ETH_TYPE_IPV6
)) {
5903 may_match
= MAY_NW_PROTO
| MAY_IPVx
| MAY_IPV6
;
5904 if (match
->flow
.nw_proto
== IPPROTO_TCP
||
5905 match
->flow
.nw_proto
== IPPROTO_UDP
||
5906 match
->flow
.nw_proto
== IPPROTO_SCTP
) {
5907 may_match
|= MAY_TP_ADDR
;
5908 } else if (match
->flow
.nw_proto
== IPPROTO_ICMPV6
) {
5909 may_match
|= MAY_TP_ADDR
;
5910 if (match
->flow
.tp_src
== htons(ND_NEIGHBOR_SOLICIT
)) {
5911 may_match
|= MAY_ND_TARGET
| MAY_ARP_SHA
;
5912 } else if (match
->flow
.tp_src
== htons(ND_NEIGHBOR_ADVERT
)) {
5913 may_match
|= MAY_ND_TARGET
| MAY_ARP_THA
;
5916 } else if (match
->flow
.dl_type
== htons(ETH_TYPE_ARP
) ||
5917 match
->flow
.dl_type
== htons(ETH_TYPE_RARP
)) {
5918 may_match
= MAY_NW_PROTO
| MAY_NW_ADDR
| MAY_ARP_SHA
| MAY_ARP_THA
;
5919 } else if (eth_type_mpls(match
->flow
.dl_type
)) {
5920 may_match
= MAY_MPLS
;
5925 /* Clear the fields that may not be matched. */
5927 if (!(may_match
& MAY_NW_ADDR
)) {
5928 wc
.masks
.nw_src
= wc
.masks
.nw_dst
= htonl(0);
5930 if (!(may_match
& MAY_TP_ADDR
)) {
5931 wc
.masks
.tp_src
= wc
.masks
.tp_dst
= htons(0);
5933 if (!(may_match
& MAY_NW_PROTO
)) {
5934 wc
.masks
.nw_proto
= 0;
5936 if (!(may_match
& MAY_IPVx
)) {
5937 wc
.masks
.nw_tos
= 0;
5938 wc
.masks
.nw_ttl
= 0;
5940 if (!(may_match
& MAY_ARP_SHA
)) {
5941 memset(wc
.masks
.arp_sha
, 0, ETH_ADDR_LEN
);
5943 if (!(may_match
& MAY_ARP_THA
)) {
5944 memset(wc
.masks
.arp_tha
, 0, ETH_ADDR_LEN
);
5946 if (!(may_match
& MAY_IPV6
)) {
5947 wc
.masks
.ipv6_src
= wc
.masks
.ipv6_dst
= in6addr_any
;
5948 wc
.masks
.ipv6_label
= htonl(0);
5950 if (!(may_match
& MAY_ND_TARGET
)) {
5951 wc
.masks
.nd_target
= in6addr_any
;
5953 if (!(may_match
& MAY_MPLS
)) {
5954 memset(wc
.masks
.mpls_lse
, 0, sizeof wc
.masks
.mpls_lse
);
5957 /* Log any changes. */
5958 if (!flow_wildcards_equal(&wc
, &match
->wc
)) {
5959 bool log
= may_log
&& !VLOG_DROP_INFO(&bad_ofmsg_rl
);
5960 char *pre
= log
? match_to_string(match
, OFP_DEFAULT_PRIORITY
) : NULL
;
5963 match_zero_wildcarded_fields(match
);
5966 char *post
= match_to_string(match
, OFP_DEFAULT_PRIORITY
);
5967 VLOG_INFO("normalization changed ofp_match, details:");
5968 VLOG_INFO(" pre: %s", pre
);
5969 VLOG_INFO("post: %s", post
);
5976 /* "Normalizes" the wildcards in 'match'. That means:
5978 * 1. If the type of level N is known, then only the valid fields for that
5979 * level may be specified. For example, ARP does not have a TOS field,
5980 * so nw_tos must be wildcarded if 'match' specifies an ARP flow.
5981 * Similarly, IPv4 does not have any IPv6 addresses, so ipv6_src and
5982 * ipv6_dst (and other fields) must be wildcarded if 'match' specifies an
5985 * 2. If the type of level N is not known (or not understood by Open
5986 * vSwitch), then no fields at all for that level may be specified. For
5987 * example, Open vSwitch does not understand SCTP, an L4 protocol, so the
5988 * L4 fields tp_src and tp_dst must be wildcarded if 'match' specifies an
5991 * If this function changes 'match', it logs a rate-limited informational
5994 ofputil_normalize_match(struct match
*match
)
5996 ofputil_normalize_match__(match
, true);
5999 /* Same as ofputil_normalize_match() without the logging. Thus, this function
6000 * is suitable for a program's internal use, whereas ofputil_normalize_match()
6001 * sense for use on flows received from elsewhere (so that a bug in the program
6002 * that sent them can be reported and corrected). */
6004 ofputil_normalize_match_quiet(struct match
*match
)
6006 ofputil_normalize_match__(match
, false);
6009 /* Parses a key or a key-value pair from '*stringp'.
6011 * On success: Stores the key into '*keyp'. Stores the value, if present, into
6012 * '*valuep', otherwise an empty string. Advances '*stringp' past the end of
6013 * the key-value pair, preparing it for another call. '*keyp' and '*valuep'
6014 * are substrings of '*stringp' created by replacing some of its bytes by null
6015 * terminators. Returns true.
6017 * If '*stringp' is just white space or commas, sets '*keyp' and '*valuep' to
6018 * NULL and returns false. */
6020 ofputil_parse_key_value(char **stringp
, char **keyp
, char **valuep
)
6022 char *pos
, *key
, *value
;
6026 pos
+= strspn(pos
, ", \t\r\n");
6028 *keyp
= *valuep
= NULL
;
6033 key_len
= strcspn(pos
, ":=(, \t\r\n");
6034 if (key
[key_len
] == ':' || key
[key_len
] == '=') {
6035 /* The value can be separated by a colon. */
6038 value
= key
+ key_len
+ 1;
6039 value_len
= strcspn(value
, ", \t\r\n");
6040 pos
= value
+ value_len
+ (value
[value_len
] != '\0');
6041 value
[value_len
] = '\0';
6042 } else if (key
[key_len
] == '(') {
6043 /* The value can be surrounded by balanced parentheses. The outermost
6044 * set of parentheses is removed. */
6048 value
= key
+ key_len
+ 1;
6049 for (value_len
= 0; level
> 0; value_len
++) {
6050 switch (value
[value_len
]) {
6064 value
[value_len
- 1] = '\0';
6065 pos
= value
+ value_len
;
6067 /* There might be no value at all. */
6068 value
= key
+ key_len
; /* Will become the empty string below. */
6069 pos
= key
+ key_len
+ (key
[key_len
] != '\0');
6071 key
[key_len
] = '\0';
6079 /* Encode a dump ports request for 'port', the encoded message
6080 * will be for Open Flow version 'ofp_version'. Returns message
6081 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
6083 ofputil_encode_dump_ports_request(enum ofp_version ofp_version
, ofp_port_t port
)
6085 struct ofpbuf
*request
;
6087 switch (ofp_version
) {
6088 case OFP10_VERSION
: {
6089 struct ofp10_port_stats_request
*req
;
6090 request
= ofpraw_alloc(OFPRAW_OFPST10_PORT_REQUEST
, ofp_version
, 0);
6091 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6092 req
->port_no
= htons(ofp_to_u16(port
));
6098 case OFP14_VERSION
:{
6099 struct ofp11_port_stats_request
*req
;
6100 request
= ofpraw_alloc(OFPRAW_OFPST11_PORT_REQUEST
, ofp_version
, 0);
6101 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6102 req
->port_no
= ofputil_port_to_ofp11(port
);
6113 ofputil_port_stats_to_ofp10(const struct ofputil_port_stats
*ops
,
6114 struct ofp10_port_stats
*ps10
)
6116 ps10
->port_no
= htons(ofp_to_u16(ops
->port_no
));
6117 memset(ps10
->pad
, 0, sizeof ps10
->pad
);
6118 put_32aligned_be64(&ps10
->rx_packets
, htonll(ops
->stats
.rx_packets
));
6119 put_32aligned_be64(&ps10
->tx_packets
, htonll(ops
->stats
.tx_packets
));
6120 put_32aligned_be64(&ps10
->rx_bytes
, htonll(ops
->stats
.rx_bytes
));
6121 put_32aligned_be64(&ps10
->tx_bytes
, htonll(ops
->stats
.tx_bytes
));
6122 put_32aligned_be64(&ps10
->rx_dropped
, htonll(ops
->stats
.rx_dropped
));
6123 put_32aligned_be64(&ps10
->tx_dropped
, htonll(ops
->stats
.tx_dropped
));
6124 put_32aligned_be64(&ps10
->rx_errors
, htonll(ops
->stats
.rx_errors
));
6125 put_32aligned_be64(&ps10
->tx_errors
, htonll(ops
->stats
.tx_errors
));
6126 put_32aligned_be64(&ps10
->rx_frame_err
, htonll(ops
->stats
.rx_frame_errors
));
6127 put_32aligned_be64(&ps10
->rx_over_err
, htonll(ops
->stats
.rx_over_errors
));
6128 put_32aligned_be64(&ps10
->rx_crc_err
, htonll(ops
->stats
.rx_crc_errors
));
6129 put_32aligned_be64(&ps10
->collisions
, htonll(ops
->stats
.collisions
));
6133 ofputil_port_stats_to_ofp11(const struct ofputil_port_stats
*ops
,
6134 struct ofp11_port_stats
*ps11
)
6136 ps11
->port_no
= ofputil_port_to_ofp11(ops
->port_no
);
6137 memset(ps11
->pad
, 0, sizeof ps11
->pad
);
6138 ps11
->rx_packets
= htonll(ops
->stats
.rx_packets
);
6139 ps11
->tx_packets
= htonll(ops
->stats
.tx_packets
);
6140 ps11
->rx_bytes
= htonll(ops
->stats
.rx_bytes
);
6141 ps11
->tx_bytes
= htonll(ops
->stats
.tx_bytes
);
6142 ps11
->rx_dropped
= htonll(ops
->stats
.rx_dropped
);
6143 ps11
->tx_dropped
= htonll(ops
->stats
.tx_dropped
);
6144 ps11
->rx_errors
= htonll(ops
->stats
.rx_errors
);
6145 ps11
->tx_errors
= htonll(ops
->stats
.tx_errors
);
6146 ps11
->rx_frame_err
= htonll(ops
->stats
.rx_frame_errors
);
6147 ps11
->rx_over_err
= htonll(ops
->stats
.rx_over_errors
);
6148 ps11
->rx_crc_err
= htonll(ops
->stats
.rx_crc_errors
);
6149 ps11
->collisions
= htonll(ops
->stats
.collisions
);
6153 ofputil_port_stats_to_ofp13(const struct ofputil_port_stats
*ops
,
6154 struct ofp13_port_stats
*ps13
)
6156 ofputil_port_stats_to_ofp11(ops
, &ps13
->ps
);
6157 ps13
->duration_sec
= htonl(ops
->duration_sec
);
6158 ps13
->duration_nsec
= htonl(ops
->duration_nsec
);
6162 ofputil_append_ofp14_port_stats(const struct ofputil_port_stats
*ops
,
6163 struct list
*replies
)
6165 struct ofp14_port_stats_prop_ethernet
*eth
;
6166 struct ofp14_port_stats
*ps14
;
6167 struct ofpbuf
*reply
;
6169 reply
= ofpmp_reserve(replies
, sizeof *ps14
+ sizeof *eth
);
6171 ps14
= ofpbuf_put_uninit(reply
, sizeof *ps14
);
6172 ps14
->length
= htons(sizeof *ps14
+ sizeof *eth
);
6173 memset(ps14
->pad
, 0, sizeof ps14
->pad
);
6174 ps14
->port_no
= ofputil_port_to_ofp11(ops
->port_no
);
6175 ps14
->duration_sec
= htonl(ops
->duration_sec
);
6176 ps14
->duration_nsec
= htonl(ops
->duration_nsec
);
6177 ps14
->rx_packets
= htonll(ops
->stats
.rx_packets
);
6178 ps14
->tx_packets
= htonll(ops
->stats
.tx_packets
);
6179 ps14
->rx_bytes
= htonll(ops
->stats
.rx_bytes
);
6180 ps14
->tx_bytes
= htonll(ops
->stats
.tx_bytes
);
6181 ps14
->rx_dropped
= htonll(ops
->stats
.rx_dropped
);
6182 ps14
->tx_dropped
= htonll(ops
->stats
.tx_dropped
);
6183 ps14
->rx_errors
= htonll(ops
->stats
.rx_errors
);
6184 ps14
->tx_errors
= htonll(ops
->stats
.tx_errors
);
6186 eth
= ofpbuf_put_uninit(reply
, sizeof *eth
);
6187 eth
->type
= htons(OFPPSPT14_ETHERNET
);
6188 eth
->length
= htons(sizeof *eth
);
6189 memset(eth
->pad
, 0, sizeof eth
->pad
);
6190 eth
->rx_frame_err
= htonll(ops
->stats
.rx_frame_errors
);
6191 eth
->rx_over_err
= htonll(ops
->stats
.rx_over_errors
);
6192 eth
->rx_crc_err
= htonll(ops
->stats
.rx_crc_errors
);
6193 eth
->collisions
= htonll(ops
->stats
.collisions
);
6196 /* Encode a ports stat for 'ops' and append it to 'replies'. */
6198 ofputil_append_port_stat(struct list
*replies
,
6199 const struct ofputil_port_stats
*ops
)
6201 switch (ofpmp_version(replies
)) {
6202 case OFP13_VERSION
: {
6203 struct ofp13_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6204 ofputil_port_stats_to_ofp13(ops
, reply
);
6208 case OFP11_VERSION
: {
6209 struct ofp11_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6210 ofputil_port_stats_to_ofp11(ops
, reply
);
6214 case OFP10_VERSION
: {
6215 struct ofp10_port_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
6216 ofputil_port_stats_to_ofp10(ops
, reply
);
6221 ofputil_append_ofp14_port_stats(ops
, replies
);
6230 ofputil_port_stats_from_ofp10(struct ofputil_port_stats
*ops
,
6231 const struct ofp10_port_stats
*ps10
)
6233 memset(ops
, 0, sizeof *ops
);
6235 ops
->port_no
= u16_to_ofp(ntohs(ps10
->port_no
));
6236 ops
->stats
.rx_packets
= ntohll(get_32aligned_be64(&ps10
->rx_packets
));
6237 ops
->stats
.tx_packets
= ntohll(get_32aligned_be64(&ps10
->tx_packets
));
6238 ops
->stats
.rx_bytes
= ntohll(get_32aligned_be64(&ps10
->rx_bytes
));
6239 ops
->stats
.tx_bytes
= ntohll(get_32aligned_be64(&ps10
->tx_bytes
));
6240 ops
->stats
.rx_dropped
= ntohll(get_32aligned_be64(&ps10
->rx_dropped
));
6241 ops
->stats
.tx_dropped
= ntohll(get_32aligned_be64(&ps10
->tx_dropped
));
6242 ops
->stats
.rx_errors
= ntohll(get_32aligned_be64(&ps10
->rx_errors
));
6243 ops
->stats
.tx_errors
= ntohll(get_32aligned_be64(&ps10
->tx_errors
));
6244 ops
->stats
.rx_frame_errors
=
6245 ntohll(get_32aligned_be64(&ps10
->rx_frame_err
));
6246 ops
->stats
.rx_over_errors
= ntohll(get_32aligned_be64(&ps10
->rx_over_err
));
6247 ops
->stats
.rx_crc_errors
= ntohll(get_32aligned_be64(&ps10
->rx_crc_err
));
6248 ops
->stats
.collisions
= ntohll(get_32aligned_be64(&ps10
->collisions
));
6249 ops
->duration_sec
= ops
->duration_nsec
= UINT32_MAX
;
6255 ofputil_port_stats_from_ofp11(struct ofputil_port_stats
*ops
,
6256 const struct ofp11_port_stats
*ps11
)
6260 memset(ops
, 0, sizeof *ops
);
6261 error
= ofputil_port_from_ofp11(ps11
->port_no
, &ops
->port_no
);
6266 ops
->stats
.rx_packets
= ntohll(ps11
->rx_packets
);
6267 ops
->stats
.tx_packets
= ntohll(ps11
->tx_packets
);
6268 ops
->stats
.rx_bytes
= ntohll(ps11
->rx_bytes
);
6269 ops
->stats
.tx_bytes
= ntohll(ps11
->tx_bytes
);
6270 ops
->stats
.rx_dropped
= ntohll(ps11
->rx_dropped
);
6271 ops
->stats
.tx_dropped
= ntohll(ps11
->tx_dropped
);
6272 ops
->stats
.rx_errors
= ntohll(ps11
->rx_errors
);
6273 ops
->stats
.tx_errors
= ntohll(ps11
->tx_errors
);
6274 ops
->stats
.rx_frame_errors
= ntohll(ps11
->rx_frame_err
);
6275 ops
->stats
.rx_over_errors
= ntohll(ps11
->rx_over_err
);
6276 ops
->stats
.rx_crc_errors
= ntohll(ps11
->rx_crc_err
);
6277 ops
->stats
.collisions
= ntohll(ps11
->collisions
);
6278 ops
->duration_sec
= ops
->duration_nsec
= UINT32_MAX
;
6284 ofputil_port_stats_from_ofp13(struct ofputil_port_stats
*ops
,
6285 const struct ofp13_port_stats
*ps13
)
6287 enum ofperr error
= ofputil_port_stats_from_ofp11(ops
, &ps13
->ps
);
6289 ops
->duration_sec
= ntohl(ps13
->duration_sec
);
6290 ops
->duration_nsec
= ntohl(ps13
->duration_nsec
);
6296 parse_ofp14_port_stats_ethernet_property(const struct ofpbuf
*payload
,
6297 struct ofputil_port_stats
*ops
)
6299 const struct ofp14_port_stats_prop_ethernet
*eth
= ofpbuf_data(payload
);
6301 if (ofpbuf_size(payload
) != sizeof *eth
) {
6302 return OFPERR_OFPBPC_BAD_LEN
;
6305 ops
->stats
.rx_frame_errors
= ntohll(eth
->rx_frame_err
);
6306 ops
->stats
.rx_over_errors
= ntohll(eth
->rx_over_err
);
6307 ops
->stats
.rx_crc_errors
= ntohll(eth
->rx_crc_err
);
6308 ops
->stats
.collisions
= ntohll(eth
->collisions
);
6314 ofputil_pull_ofp14_port_stats(struct ofputil_port_stats
*ops
,
6317 const struct ofp14_port_stats
*ps14
;
6318 struct ofpbuf properties
;
6322 ps14
= ofpbuf_try_pull(msg
, sizeof *ps14
);
6324 return OFPERR_OFPBRC_BAD_LEN
;
6327 len
= ntohs(ps14
->length
);
6328 if (len
< sizeof *ps14
|| len
- sizeof *ps14
> ofpbuf_size(msg
)) {
6329 return OFPERR_OFPBRC_BAD_LEN
;
6331 len
-= sizeof *ps14
;
6332 ofpbuf_use_const(&properties
, ofpbuf_pull(msg
, len
), len
);
6334 error
= ofputil_port_from_ofp11(ps14
->port_no
, &ops
->port_no
);
6339 ops
->duration_sec
= ntohl(ps14
->duration_sec
);
6340 ops
->duration_nsec
= ntohl(ps14
->duration_nsec
);
6341 ops
->stats
.rx_packets
= ntohll(ps14
->rx_packets
);
6342 ops
->stats
.tx_packets
= ntohll(ps14
->tx_packets
);
6343 ops
->stats
.rx_bytes
= ntohll(ps14
->rx_bytes
);
6344 ops
->stats
.tx_bytes
= ntohll(ps14
->tx_bytes
);
6345 ops
->stats
.rx_dropped
= ntohll(ps14
->rx_dropped
);
6346 ops
->stats
.tx_dropped
= ntohll(ps14
->tx_dropped
);
6347 ops
->stats
.rx_errors
= ntohll(ps14
->rx_errors
);
6348 ops
->stats
.tx_errors
= ntohll(ps14
->tx_errors
);
6349 ops
->stats
.rx_frame_errors
= UINT64_MAX
;
6350 ops
->stats
.rx_over_errors
= UINT64_MAX
;
6351 ops
->stats
.rx_crc_errors
= UINT64_MAX
;
6352 ops
->stats
.collisions
= UINT64_MAX
;
6354 while (ofpbuf_size(&properties
) > 0) {
6355 struct ofpbuf payload
;
6359 error
= ofputil_pull_property(&properties
, &payload
, &type
);
6365 case OFPPSPT14_ETHERNET
:
6366 error
= parse_ofp14_port_stats_ethernet_property(&payload
, ops
);
6370 log_property(true, "unknown port stats property %"PRIu16
, type
);
6383 /* Returns the number of port stats elements in OFPTYPE_PORT_STATS_REPLY
6386 ofputil_count_port_stats(const struct ofp_header
*oh
)
6388 struct ofputil_port_stats ps
;
6392 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
6393 ofpraw_pull_assert(&b
);
6394 while (!ofputil_decode_port_stats(&ps
, &b
)) {
6400 /* Converts an OFPST_PORT_STATS reply in 'msg' into an abstract
6401 * ofputil_port_stats in 'ps'.
6403 * Multiple OFPST_PORT_STATS replies can be packed into a single OpenFlow
6404 * message. Calling this function multiple times for a single 'msg' iterates
6405 * through the replies. The caller must initially leave 'msg''s layer pointers
6406 * null and not modify them between calls.
6408 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6409 * otherwise a positive errno value. */
6411 ofputil_decode_port_stats(struct ofputil_port_stats
*ps
, struct ofpbuf
*msg
)
6417 ? ofpraw_decode(&raw
, msg
->frame
)
6418 : ofpraw_pull(&raw
, msg
));
6423 if (!ofpbuf_size(msg
)) {
6425 } else if (raw
== OFPRAW_OFPST14_PORT_REPLY
) {
6426 return ofputil_pull_ofp14_port_stats(ps
, msg
);
6427 } else if (raw
== OFPRAW_OFPST13_PORT_REPLY
) {
6428 const struct ofp13_port_stats
*ps13
;
6430 ps13
= ofpbuf_try_pull(msg
, sizeof *ps13
);
6434 return ofputil_port_stats_from_ofp13(ps
, ps13
);
6435 } else if (raw
== OFPRAW_OFPST11_PORT_REPLY
) {
6436 const struct ofp11_port_stats
*ps11
;
6438 ps11
= ofpbuf_try_pull(msg
, sizeof *ps11
);
6442 return ofputil_port_stats_from_ofp11(ps
, ps11
);
6443 } else if (raw
== OFPRAW_OFPST10_PORT_REPLY
) {
6444 const struct ofp10_port_stats
*ps10
;
6446 ps10
= ofpbuf_try_pull(msg
, sizeof *ps10
);
6450 return ofputil_port_stats_from_ofp10(ps
, ps10
);
6456 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_PORT reply has %"PRIu32
" leftover "
6457 "bytes at end", ofpbuf_size(msg
));
6458 return OFPERR_OFPBRC_BAD_LEN
;
6461 /* Parse a port status request message into a 16 bit OpenFlow 1.0
6462 * port number and stores the latter in '*ofp10_port'.
6463 * Returns 0 if successful, otherwise an OFPERR_* number. */
6465 ofputil_decode_port_stats_request(const struct ofp_header
*request
,
6466 ofp_port_t
*ofp10_port
)
6468 switch ((enum ofp_version
)request
->version
) {
6472 case OFP11_VERSION
: {
6473 const struct ofp11_port_stats_request
*psr11
= ofpmsg_body(request
);
6474 return ofputil_port_from_ofp11(psr11
->port_no
, ofp10_port
);
6477 case OFP10_VERSION
: {
6478 const struct ofp10_port_stats_request
*psr10
= ofpmsg_body(request
);
6479 *ofp10_port
= u16_to_ofp(ntohs(psr10
->port_no
));
6488 /* Frees all of the "struct ofputil_bucket"s in the 'buckets' list. */
6490 ofputil_bucket_list_destroy(struct list
*buckets
)
6492 struct ofputil_bucket
*bucket
, *next_bucket
;
6494 LIST_FOR_EACH_SAFE (bucket
, next_bucket
, list_node
, buckets
) {
6495 list_remove(&bucket
->list_node
);
6496 free(bucket
->ofpacts
);
6501 /* Returns an OpenFlow group stats request for OpenFlow version 'ofp_version',
6502 * that requests stats for group 'group_id'. (Use OFPG_ALL to request stats
6505 * Group statistics include packet and byte counts for each group. */
6507 ofputil_encode_group_stats_request(enum ofp_version ofp_version
,
6510 struct ofpbuf
*request
;
6512 switch (ofp_version
) {
6514 ovs_fatal(0, "dump-group-stats needs OpenFlow 1.1 or later "
6515 "(\'-O OpenFlow11\')");
6519 case OFP14_VERSION
: {
6520 struct ofp11_group_stats_request
*req
;
6521 request
= ofpraw_alloc(OFPRAW_OFPST11_GROUP_REQUEST
, ofp_version
, 0);
6522 req
= ofpbuf_put_zeros(request
, sizeof *req
);
6523 req
->group_id
= htonl(group_id
);
6533 /* Returns an OpenFlow group description request for OpenFlow version
6534 * 'ofp_version', that requests stats for group 'group_id'. (Use OFPG_ALL to
6535 * request stats for all groups.)
6537 * Group descriptions include the bucket and action configuration for each
6540 ofputil_encode_group_desc_request(enum ofp_version ofp_version
)
6542 struct ofpbuf
*request
;
6544 switch (ofp_version
) {
6546 ovs_fatal(0, "dump-groups needs OpenFlow 1.1 or later "
6547 "(\'-O OpenFlow11\')");
6552 request
= ofpraw_alloc(OFPRAW_OFPST11_GROUP_DESC_REQUEST
, ofp_version
, 0);
6562 ofputil_group_bucket_counters_to_ofp11(const struct ofputil_group_stats
*gs
,
6563 struct ofp11_bucket_counter bucket_cnts
[])
6567 for (i
= 0; i
< gs
->n_buckets
; i
++) {
6568 bucket_cnts
[i
].packet_count
= htonll(gs
->bucket_stats
[i
].packet_count
);
6569 bucket_cnts
[i
].byte_count
= htonll(gs
->bucket_stats
[i
].byte_count
);
6574 ofputil_group_stats_to_ofp11(const struct ofputil_group_stats
*gs
,
6575 struct ofp11_group_stats
*gs11
, size_t length
,
6576 struct ofp11_bucket_counter bucket_cnts
[])
6578 memset(gs11
, 0, sizeof *gs11
);
6579 gs11
->length
= htons(length
);
6580 gs11
->group_id
= htonl(gs
->group_id
);
6581 gs11
->ref_count
= htonl(gs
->ref_count
);
6582 gs11
->packet_count
= htonll(gs
->packet_count
);
6583 gs11
->byte_count
= htonll(gs
->byte_count
);
6584 ofputil_group_bucket_counters_to_ofp11(gs
, bucket_cnts
);
6588 ofputil_group_stats_to_ofp13(const struct ofputil_group_stats
*gs
,
6589 struct ofp13_group_stats
*gs13
, size_t length
,
6590 struct ofp11_bucket_counter bucket_cnts
[])
6592 ofputil_group_stats_to_ofp11(gs
, &gs13
->gs
, length
, bucket_cnts
);
6593 gs13
->duration_sec
= htonl(gs
->duration_sec
);
6594 gs13
->duration_nsec
= htonl(gs
->duration_nsec
);
6598 /* Encodes 'gs' properly for the format of the list of group statistics
6599 * replies already begun in 'replies' and appends it to the list. 'replies'
6600 * must have originally been initialized with ofpmp_init(). */
6602 ofputil_append_group_stats(struct list
*replies
,
6603 const struct ofputil_group_stats
*gs
)
6605 size_t bucket_counter_size
;
6606 struct ofp11_bucket_counter
*bucket_counters
;
6609 bucket_counter_size
= gs
->n_buckets
* sizeof(struct ofp11_bucket_counter
);
6611 switch (ofpmp_version(replies
)) {
6613 case OFP12_VERSION
:{
6614 struct ofp11_group_stats
*gs11
;
6616 length
= sizeof *gs11
+ bucket_counter_size
;
6617 gs11
= ofpmp_append(replies
, length
);
6618 bucket_counters
= (struct ofp11_bucket_counter
*)(gs11
+ 1);
6619 ofputil_group_stats_to_ofp11(gs
, gs11
, length
, bucket_counters
);
6624 case OFP14_VERSION
:{
6625 struct ofp13_group_stats
*gs13
;
6627 length
= sizeof *gs13
+ bucket_counter_size
;
6628 gs13
= ofpmp_append(replies
, length
);
6629 bucket_counters
= (struct ofp11_bucket_counter
*)(gs13
+ 1);
6630 ofputil_group_stats_to_ofp13(gs
, gs13
, length
, bucket_counters
);
6639 /* Returns an OpenFlow group features request for OpenFlow version
6642 ofputil_encode_group_features_request(enum ofp_version ofp_version
)
6644 struct ofpbuf
*request
= NULL
;
6646 switch (ofp_version
) {
6649 ovs_fatal(0, "dump-group-features needs OpenFlow 1.2 or later "
6650 "(\'-O OpenFlow12\')");
6654 request
= ofpraw_alloc(OFPRAW_OFPST12_GROUP_FEATURES_REQUEST
,
6664 /* Returns a OpenFlow message that encodes 'features' properly as a reply to
6665 * group features request 'request'. */
6667 ofputil_encode_group_features_reply(
6668 const struct ofputil_group_features
*features
,
6669 const struct ofp_header
*request
)
6671 struct ofp12_group_features_stats
*ogf
;
6672 struct ofpbuf
*reply
;
6674 reply
= ofpraw_alloc_xid(OFPRAW_OFPST12_GROUP_FEATURES_REPLY
,
6675 request
->version
, request
->xid
, 0);
6676 ogf
= ofpbuf_put_zeros(reply
, sizeof *ogf
);
6677 ogf
->types
= htonl(features
->types
);
6678 ogf
->capabilities
= htonl(features
->capabilities
);
6679 ogf
->max_groups
[0] = htonl(features
->max_groups
[0]);
6680 ogf
->max_groups
[1] = htonl(features
->max_groups
[1]);
6681 ogf
->max_groups
[2] = htonl(features
->max_groups
[2]);
6682 ogf
->max_groups
[3] = htonl(features
->max_groups
[3]);
6683 ogf
->actions
[0] = htonl(features
->actions
[0]);
6684 ogf
->actions
[1] = htonl(features
->actions
[1]);
6685 ogf
->actions
[2] = htonl(features
->actions
[2]);
6686 ogf
->actions
[3] = htonl(features
->actions
[3]);
6691 /* Decodes group features reply 'oh' into 'features'. */
6693 ofputil_decode_group_features_reply(const struct ofp_header
*oh
,
6694 struct ofputil_group_features
*features
)
6696 const struct ofp12_group_features_stats
*ogf
= ofpmsg_body(oh
);
6698 features
->types
= ntohl(ogf
->types
);
6699 features
->capabilities
= ntohl(ogf
->capabilities
);
6700 features
->max_groups
[0] = ntohl(ogf
->max_groups
[0]);
6701 features
->max_groups
[1] = ntohl(ogf
->max_groups
[1]);
6702 features
->max_groups
[2] = ntohl(ogf
->max_groups
[2]);
6703 features
->max_groups
[3] = ntohl(ogf
->max_groups
[3]);
6704 features
->actions
[0] = ntohl(ogf
->actions
[0]);
6705 features
->actions
[1] = ntohl(ogf
->actions
[1]);
6706 features
->actions
[2] = ntohl(ogf
->actions
[2]);
6707 features
->actions
[3] = ntohl(ogf
->actions
[3]);
6710 /* Parse a group status request message into a 32 bit OpenFlow 1.1
6711 * group ID and stores the latter in '*group_id'.
6712 * Returns 0 if successful, otherwise an OFPERR_* number. */
6714 ofputil_decode_group_stats_request(const struct ofp_header
*request
,
6717 const struct ofp11_group_stats_request
*gsr11
= ofpmsg_body(request
);
6718 *group_id
= ntohl(gsr11
->group_id
);
6722 /* Converts a group stats reply in 'msg' into an abstract ofputil_group_stats
6723 * in 'gs'. Assigns freshly allocated memory to gs->bucket_stats for the
6724 * caller to eventually free.
6726 * Multiple group stats replies can be packed into a single OpenFlow message.
6727 * Calling this function multiple times for a single 'msg' iterates through the
6728 * replies. The caller must initially leave 'msg''s layer pointers null and
6729 * not modify them between calls.
6731 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6732 * otherwise a positive errno value. */
6734 ofputil_decode_group_stats_reply(struct ofpbuf
*msg
,
6735 struct ofputil_group_stats
*gs
)
6737 struct ofp11_bucket_counter
*obc
;
6738 struct ofp11_group_stats
*ogs11
;
6745 gs
->bucket_stats
= NULL
;
6747 ? ofpraw_decode(&raw
, msg
->frame
)
6748 : ofpraw_pull(&raw
, msg
));
6753 if (!ofpbuf_size(msg
)) {
6757 if (raw
== OFPRAW_OFPST11_GROUP_REPLY
) {
6758 base_len
= sizeof *ogs11
;
6759 ogs11
= ofpbuf_try_pull(msg
, sizeof *ogs11
);
6760 gs
->duration_sec
= gs
->duration_nsec
= UINT32_MAX
;
6761 } else if (raw
== OFPRAW_OFPST13_GROUP_REPLY
) {
6762 struct ofp13_group_stats
*ogs13
;
6764 base_len
= sizeof *ogs13
;
6765 ogs13
= ofpbuf_try_pull(msg
, sizeof *ogs13
);
6768 gs
->duration_sec
= ntohl(ogs13
->duration_sec
);
6769 gs
->duration_nsec
= ntohl(ogs13
->duration_nsec
);
6778 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply has %"PRIu32
" leftover bytes at end",
6779 ofpraw_get_name(raw
), ofpbuf_size(msg
));
6780 return OFPERR_OFPBRC_BAD_LEN
;
6782 length
= ntohs(ogs11
->length
);
6783 if (length
< sizeof base_len
) {
6784 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply claims invalid length %"PRIuSIZE
,
6785 ofpraw_get_name(raw
), length
);
6786 return OFPERR_OFPBRC_BAD_LEN
;
6789 gs
->group_id
= ntohl(ogs11
->group_id
);
6790 gs
->ref_count
= ntohl(ogs11
->ref_count
);
6791 gs
->packet_count
= ntohll(ogs11
->packet_count
);
6792 gs
->byte_count
= ntohll(ogs11
->byte_count
);
6794 gs
->n_buckets
= (length
- base_len
) / sizeof *obc
;
6795 obc
= ofpbuf_try_pull(msg
, gs
->n_buckets
* sizeof *obc
);
6797 VLOG_WARN_RL(&bad_ofmsg_rl
, "%s reply has %"PRIu32
" leftover bytes at end",
6798 ofpraw_get_name(raw
), ofpbuf_size(msg
));
6799 return OFPERR_OFPBRC_BAD_LEN
;
6802 gs
->bucket_stats
= xmalloc(gs
->n_buckets
* sizeof *gs
->bucket_stats
);
6803 for (i
= 0; i
< gs
->n_buckets
; i
++) {
6804 gs
->bucket_stats
[i
].packet_count
= ntohll(obc
[i
].packet_count
);
6805 gs
->bucket_stats
[i
].byte_count
= ntohll(obc
[i
].byte_count
);
6811 /* Appends a group stats reply that contains the data in 'gds' to those already
6812 * present in the list of ofpbufs in 'replies'. 'replies' should have been
6813 * initialized with ofpmp_init(). */
6815 ofputil_append_group_desc_reply(const struct ofputil_group_desc
*gds
,
6816 struct list
*buckets
,
6817 struct list
*replies
)
6819 struct ofpbuf
*reply
= ofpbuf_from_list(list_back(replies
));
6820 enum ofp_version version
= ofpmp_version(replies
);
6821 struct ofp11_group_desc_stats
*ogds
;
6822 struct ofputil_bucket
*bucket
;
6825 start_ogds
= ofpbuf_size(reply
);
6826 ofpbuf_put_zeros(reply
, sizeof *ogds
);
6827 LIST_FOR_EACH (bucket
, list_node
, buckets
) {
6828 struct ofp11_bucket
*ob
;
6831 start_ob
= ofpbuf_size(reply
);
6832 ofpbuf_put_zeros(reply
, sizeof *ob
);
6833 ofpacts_put_openflow_actions(bucket
->ofpacts
, bucket
->ofpacts_len
,
6835 ob
= ofpbuf_at_assert(reply
, start_ob
, sizeof *ob
);
6836 ob
->len
= htons(ofpbuf_size(reply
) - start_ob
);
6837 ob
->weight
= htons(bucket
->weight
);
6838 ob
->watch_port
= ofputil_port_to_ofp11(bucket
->watch_port
);
6839 ob
->watch_group
= htonl(bucket
->watch_group
);
6841 ogds
= ofpbuf_at_assert(reply
, start_ogds
, sizeof *ogds
);
6842 ogds
->length
= htons(ofpbuf_size(reply
) - start_ogds
);
6843 ogds
->type
= gds
->type
;
6844 ogds
->group_id
= htonl(gds
->group_id
);
6846 ofpmp_postappend(replies
, start_ogds
);
6850 ofputil_pull_buckets(struct ofpbuf
*msg
, size_t buckets_length
,
6851 enum ofp_version version
, struct list
*buckets
)
6853 struct ofp11_bucket
*ob
;
6856 while (buckets_length
> 0) {
6857 struct ofputil_bucket
*bucket
;
6858 struct ofpbuf ofpacts
;
6862 ob
= (buckets_length
>= sizeof *ob
6863 ? ofpbuf_try_pull(msg
, sizeof *ob
)
6866 VLOG_WARN_RL(&bad_ofmsg_rl
, "buckets end with %"PRIuSIZE
" leftover bytes",
6870 ob_len
= ntohs(ob
->len
);
6871 if (ob_len
< sizeof *ob
) {
6872 VLOG_WARN_RL(&bad_ofmsg_rl
, "OpenFlow message bucket length "
6873 "%"PRIuSIZE
" is not valid", ob_len
);
6874 return OFPERR_OFPGMFC_BAD_BUCKET
;
6875 } else if (ob_len
> buckets_length
) {
6876 VLOG_WARN_RL(&bad_ofmsg_rl
, "OpenFlow message bucket length "
6877 "%"PRIuSIZE
" exceeds remaining buckets data size %"PRIuSIZE
,
6878 ob_len
, buckets_length
);
6879 return OFPERR_OFPGMFC_BAD_BUCKET
;
6881 buckets_length
-= ob_len
;
6883 ofpbuf_init(&ofpacts
, 0);
6884 error
= ofpacts_pull_openflow_actions(msg
, ob_len
- sizeof *ob
,
6887 ofpbuf_uninit(&ofpacts
);
6888 ofputil_bucket_list_destroy(buckets
);
6892 bucket
= xzalloc(sizeof *bucket
);
6893 bucket
->weight
= ntohs(ob
->weight
);
6894 error
= ofputil_port_from_ofp11(ob
->watch_port
, &bucket
->watch_port
);
6896 ofpbuf_uninit(&ofpacts
);
6897 ofputil_bucket_list_destroy(buckets
);
6898 return OFPERR_OFPGMFC_BAD_WATCH
;
6900 bucket
->watch_group
= ntohl(ob
->watch_group
);
6901 bucket
->ofpacts
= ofpbuf_steal_data(&ofpacts
);
6902 bucket
->ofpacts_len
= ofpbuf_size(&ofpacts
);
6903 list_push_back(buckets
, &bucket
->list_node
);
6909 /* Converts a group description reply in 'msg' into an abstract
6910 * ofputil_group_desc in 'gd'.
6912 * Multiple group description replies can be packed into a single OpenFlow
6913 * message. Calling this function multiple times for a single 'msg' iterates
6914 * through the replies. The caller must initially leave 'msg''s layer pointers
6915 * null and not modify them between calls.
6917 * Returns 0 if successful, EOF if no replies were left in this 'msg',
6918 * otherwise a positive errno value. */
6920 ofputil_decode_group_desc_reply(struct ofputil_group_desc
*gd
,
6921 struct ofpbuf
*msg
, enum ofp_version version
)
6923 struct ofp11_group_desc_stats
*ogds
;
6927 ofpraw_pull_assert(msg
);
6930 if (!ofpbuf_size(msg
)) {
6934 ogds
= ofpbuf_try_pull(msg
, sizeof *ogds
);
6936 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST11_GROUP_DESC reply has %"PRIu32
" "
6937 "leftover bytes at end", ofpbuf_size(msg
));
6938 return OFPERR_OFPBRC_BAD_LEN
;
6940 gd
->type
= ogds
->type
;
6941 gd
->group_id
= ntohl(ogds
->group_id
);
6943 length
= ntohs(ogds
->length
);
6944 if (length
< sizeof *ogds
|| length
- sizeof *ogds
> ofpbuf_size(msg
)) {
6945 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST11_GROUP_DESC reply claims invalid "
6946 "length %"PRIuSIZE
, length
);
6947 return OFPERR_OFPBRC_BAD_LEN
;
6950 return ofputil_pull_buckets(msg
, length
- sizeof *ogds
, version
,
6954 /* Converts abstract group mod 'gm' into a message for OpenFlow version
6955 * 'ofp_version' and returns the message. */
6957 ofputil_encode_group_mod(enum ofp_version ofp_version
,
6958 const struct ofputil_group_mod
*gm
)
6961 struct ofp11_group_mod
*ogm
;
6963 size_t start_bucket
;
6964 struct ofputil_bucket
*bucket
;
6965 struct ofp11_bucket
*ob
;
6967 switch (ofp_version
) {
6968 case OFP10_VERSION
: {
6969 if (gm
->command
== OFPGC11_ADD
) {
6970 ovs_fatal(0, "add-group needs OpenFlow 1.1 or later "
6971 "(\'-O OpenFlow11\')");
6972 } else if (gm
->command
== OFPGC11_MODIFY
) {
6973 ovs_fatal(0, "mod-group needs OpenFlow 1.1 or later "
6974 "(\'-O OpenFlow11\')");
6976 ovs_fatal(0, "del-groups needs OpenFlow 1.1 or later "
6977 "(\'-O OpenFlow11\')");
6985 b
= ofpraw_alloc(OFPRAW_OFPT11_GROUP_MOD
, ofp_version
, 0);
6986 start_ogm
= ofpbuf_size(b
);
6987 ofpbuf_put_zeros(b
, sizeof *ogm
);
6989 LIST_FOR_EACH (bucket
, list_node
, &gm
->buckets
) {
6990 start_bucket
= ofpbuf_size(b
);
6991 ofpbuf_put_zeros(b
, sizeof *ob
);
6992 if (bucket
->ofpacts
&& bucket
->ofpacts_len
) {
6993 ofpacts_put_openflow_actions(bucket
->ofpacts
,
6994 bucket
->ofpacts_len
, b
,
6997 ob
= ofpbuf_at_assert(b
, start_bucket
, sizeof *ob
);
6998 ob
->len
= htons(ofpbuf_size(b
) - start_bucket
);;
6999 ob
->weight
= htons(bucket
->weight
);
7000 ob
->watch_port
= ofputil_port_to_ofp11(bucket
->watch_port
);
7001 ob
->watch_group
= htonl(bucket
->watch_group
);
7003 ogm
= ofpbuf_at_assert(b
, start_ogm
, sizeof *ogm
);
7004 ogm
->command
= htons(gm
->command
);
7005 ogm
->type
= gm
->type
;
7006 ogm
->group_id
= htonl(gm
->group_id
);
7017 /* Converts OpenFlow group mod message 'oh' into an abstract group mod in
7018 * 'gm'. Returns 0 if successful, otherwise an OpenFlow error code. */
7020 ofputil_decode_group_mod(const struct ofp_header
*oh
,
7021 struct ofputil_group_mod
*gm
)
7023 const struct ofp11_group_mod
*ogm
;
7025 struct ofputil_bucket
*bucket
;
7028 ofpbuf_use_const(&msg
, oh
, ntohs(oh
->length
));
7029 ofpraw_pull_assert(&msg
);
7031 ogm
= ofpbuf_pull(&msg
, sizeof *ogm
);
7032 gm
->command
= ntohs(ogm
->command
);
7033 gm
->type
= ogm
->type
;
7034 gm
->group_id
= ntohl(ogm
->group_id
);
7036 err
= ofputil_pull_buckets(&msg
, ofpbuf_size(&msg
), oh
->version
, &gm
->buckets
);
7041 LIST_FOR_EACH (bucket
, list_node
, &gm
->buckets
) {
7044 case OFPGT11_INDIRECT
:
7045 if (ofputil_bucket_has_liveness(bucket
)) {
7046 return OFPERR_OFPGMFC_WATCH_UNSUPPORTED
;
7049 case OFPGT11_SELECT
:
7052 if (!ofputil_bucket_has_liveness(bucket
)) {
7053 return OFPERR_OFPGMFC_INVALID_GROUP
;
7064 /* Parse a queue status request message into 'oqsr'.
7065 * Returns 0 if successful, otherwise an OFPERR_* number. */
7067 ofputil_decode_queue_stats_request(const struct ofp_header
*request
,
7068 struct ofputil_queue_stats_request
*oqsr
)
7070 switch ((enum ofp_version
)request
->version
) {
7074 case OFP11_VERSION
: {
7075 const struct ofp11_queue_stats_request
*qsr11
= ofpmsg_body(request
);
7076 oqsr
->queue_id
= ntohl(qsr11
->queue_id
);
7077 return ofputil_port_from_ofp11(qsr11
->port_no
, &oqsr
->port_no
);
7080 case OFP10_VERSION
: {
7081 const struct ofp10_queue_stats_request
*qsr10
= ofpmsg_body(request
);
7082 oqsr
->queue_id
= ntohl(qsr10
->queue_id
);
7083 oqsr
->port_no
= u16_to_ofp(ntohs(qsr10
->port_no
));
7084 /* OF 1.0 uses OFPP_ALL for OFPP_ANY */
7085 if (oqsr
->port_no
== OFPP_ALL
) {
7086 oqsr
->port_no
= OFPP_ANY
;
7096 /* Encode a queue statsrequest for 'oqsr', the encoded message
7097 * will be fore Open Flow version 'ofp_version'. Returns message
7098 * as a struct ofpbuf. Returns encoded message on success, NULL on error */
7100 ofputil_encode_queue_stats_request(enum ofp_version ofp_version
,
7101 const struct ofputil_queue_stats_request
*oqsr
)
7103 struct ofpbuf
*request
;
7105 switch (ofp_version
) {
7109 case OFP14_VERSION
: {
7110 struct ofp11_queue_stats_request
*req
;
7111 request
= ofpraw_alloc(OFPRAW_OFPST11_QUEUE_REQUEST
, ofp_version
, 0);
7112 req
= ofpbuf_put_zeros(request
, sizeof *req
);
7113 req
->port_no
= ofputil_port_to_ofp11(oqsr
->port_no
);
7114 req
->queue_id
= htonl(oqsr
->queue_id
);
7117 case OFP10_VERSION
: {
7118 struct ofp10_queue_stats_request
*req
;
7119 request
= ofpraw_alloc(OFPRAW_OFPST10_QUEUE_REQUEST
, ofp_version
, 0);
7120 req
= ofpbuf_put_zeros(request
, sizeof *req
);
7121 /* OpenFlow 1.0 needs OFPP_ALL instead of OFPP_ANY */
7122 req
->port_no
= htons(ofp_to_u16(oqsr
->port_no
== OFPP_ANY
7123 ? OFPP_ALL
: oqsr
->port_no
));
7124 req
->queue_id
= htonl(oqsr
->queue_id
);
7134 /* Returns the number of queue stats elements in OFPTYPE_QUEUE_STATS_REPLY
7137 ofputil_count_queue_stats(const struct ofp_header
*oh
)
7139 struct ofputil_queue_stats qs
;
7143 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7144 ofpraw_pull_assert(&b
);
7145 while (!ofputil_decode_queue_stats(&qs
, &b
)) {
7152 ofputil_queue_stats_from_ofp10(struct ofputil_queue_stats
*oqs
,
7153 const struct ofp10_queue_stats
*qs10
)
7155 oqs
->port_no
= u16_to_ofp(ntohs(qs10
->port_no
));
7156 oqs
->queue_id
= ntohl(qs10
->queue_id
);
7157 oqs
->tx_bytes
= ntohll(get_32aligned_be64(&qs10
->tx_bytes
));
7158 oqs
->tx_packets
= ntohll(get_32aligned_be64(&qs10
->tx_packets
));
7159 oqs
->tx_errors
= ntohll(get_32aligned_be64(&qs10
->tx_errors
));
7160 oqs
->duration_sec
= oqs
->duration_nsec
= UINT32_MAX
;
7166 ofputil_queue_stats_from_ofp11(struct ofputil_queue_stats
*oqs
,
7167 const struct ofp11_queue_stats
*qs11
)
7171 error
= ofputil_port_from_ofp11(qs11
->port_no
, &oqs
->port_no
);
7176 oqs
->queue_id
= ntohl(qs11
->queue_id
);
7177 oqs
->tx_bytes
= ntohll(qs11
->tx_bytes
);
7178 oqs
->tx_packets
= ntohll(qs11
->tx_packets
);
7179 oqs
->tx_errors
= ntohll(qs11
->tx_errors
);
7180 oqs
->duration_sec
= oqs
->duration_nsec
= UINT32_MAX
;
7186 ofputil_queue_stats_from_ofp13(struct ofputil_queue_stats
*oqs
,
7187 const struct ofp13_queue_stats
*qs13
)
7189 enum ofperr error
= ofputil_queue_stats_from_ofp11(oqs
, &qs13
->qs
);
7191 oqs
->duration_sec
= ntohl(qs13
->duration_sec
);
7192 oqs
->duration_nsec
= ntohl(qs13
->duration_nsec
);
7199 ofputil_pull_ofp14_queue_stats(struct ofputil_queue_stats
*oqs
,
7202 const struct ofp14_queue_stats
*qs14
;
7205 qs14
= ofpbuf_try_pull(msg
, sizeof *qs14
);
7207 return OFPERR_OFPBRC_BAD_LEN
;
7210 len
= ntohs(qs14
->length
);
7211 if (len
< sizeof *qs14
|| len
- sizeof *qs14
> ofpbuf_size(msg
)) {
7212 return OFPERR_OFPBRC_BAD_LEN
;
7214 ofpbuf_pull(msg
, len
- sizeof *qs14
);
7216 /* No properties yet defined, so ignore them for now. */
7218 return ofputil_queue_stats_from_ofp13(oqs
, &qs14
->qs
);
7221 /* Converts an OFPST_QUEUE_STATS reply in 'msg' into an abstract
7222 * ofputil_queue_stats in 'qs'.
7224 * Multiple OFPST_QUEUE_STATS replies can be packed into a single OpenFlow
7225 * message. Calling this function multiple times for a single 'msg' iterates
7226 * through the replies. The caller must initially leave 'msg''s layer pointers
7227 * null and not modify them between calls.
7229 * Returns 0 if successful, EOF if no replies were left in this 'msg',
7230 * otherwise a positive errno value. */
7232 ofputil_decode_queue_stats(struct ofputil_queue_stats
*qs
, struct ofpbuf
*msg
)
7238 ? ofpraw_decode(&raw
, msg
->frame
)
7239 : ofpraw_pull(&raw
, msg
));
7244 if (!ofpbuf_size(msg
)) {
7246 } else if (raw
== OFPRAW_OFPST14_QUEUE_REPLY
) {
7247 return ofputil_pull_ofp14_queue_stats(qs
, msg
);
7248 } else if (raw
== OFPRAW_OFPST13_QUEUE_REPLY
) {
7249 const struct ofp13_queue_stats
*qs13
;
7251 qs13
= ofpbuf_try_pull(msg
, sizeof *qs13
);
7255 return ofputil_queue_stats_from_ofp13(qs
, qs13
);
7256 } else if (raw
== OFPRAW_OFPST11_QUEUE_REPLY
) {
7257 const struct ofp11_queue_stats
*qs11
;
7259 qs11
= ofpbuf_try_pull(msg
, sizeof *qs11
);
7263 return ofputil_queue_stats_from_ofp11(qs
, qs11
);
7264 } else if (raw
== OFPRAW_OFPST10_QUEUE_REPLY
) {
7265 const struct ofp10_queue_stats
*qs10
;
7267 qs10
= ofpbuf_try_pull(msg
, sizeof *qs10
);
7271 return ofputil_queue_stats_from_ofp10(qs
, qs10
);
7277 VLOG_WARN_RL(&bad_ofmsg_rl
, "OFPST_QUEUE reply has %"PRIu32
" leftover "
7278 "bytes at end", ofpbuf_size(msg
));
7279 return OFPERR_OFPBRC_BAD_LEN
;
7283 ofputil_queue_stats_to_ofp10(const struct ofputil_queue_stats
*oqs
,
7284 struct ofp10_queue_stats
*qs10
)
7286 qs10
->port_no
= htons(ofp_to_u16(oqs
->port_no
));
7287 memset(qs10
->pad
, 0, sizeof qs10
->pad
);
7288 qs10
->queue_id
= htonl(oqs
->queue_id
);
7289 put_32aligned_be64(&qs10
->tx_bytes
, htonll(oqs
->tx_bytes
));
7290 put_32aligned_be64(&qs10
->tx_packets
, htonll(oqs
->tx_packets
));
7291 put_32aligned_be64(&qs10
->tx_errors
, htonll(oqs
->tx_errors
));
7295 ofputil_queue_stats_to_ofp11(const struct ofputil_queue_stats
*oqs
,
7296 struct ofp11_queue_stats
*qs11
)
7298 qs11
->port_no
= ofputil_port_to_ofp11(oqs
->port_no
);
7299 qs11
->queue_id
= htonl(oqs
->queue_id
);
7300 qs11
->tx_bytes
= htonll(oqs
->tx_bytes
);
7301 qs11
->tx_packets
= htonll(oqs
->tx_packets
);
7302 qs11
->tx_errors
= htonll(oqs
->tx_errors
);
7306 ofputil_queue_stats_to_ofp13(const struct ofputil_queue_stats
*oqs
,
7307 struct ofp13_queue_stats
*qs13
)
7309 ofputil_queue_stats_to_ofp11(oqs
, &qs13
->qs
);
7310 if (oqs
->duration_sec
!= UINT32_MAX
) {
7311 qs13
->duration_sec
= htonl(oqs
->duration_sec
);
7312 qs13
->duration_nsec
= htonl(oqs
->duration_nsec
);
7314 qs13
->duration_sec
= OVS_BE32_MAX
;
7315 qs13
->duration_nsec
= OVS_BE32_MAX
;
7320 ofputil_queue_stats_to_ofp14(const struct ofputil_queue_stats
*oqs
,
7321 struct ofp14_queue_stats
*qs14
)
7323 qs14
->length
= htons(sizeof *qs14
);
7324 memset(qs14
->pad
, 0, sizeof qs14
->pad
);
7325 ofputil_queue_stats_to_ofp13(oqs
, &qs14
->qs
);
7329 /* Encode a queue stat for 'oqs' and append it to 'replies'. */
7331 ofputil_append_queue_stat(struct list
*replies
,
7332 const struct ofputil_queue_stats
*oqs
)
7334 switch (ofpmp_version(replies
)) {
7335 case OFP13_VERSION
: {
7336 struct ofp13_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7337 ofputil_queue_stats_to_ofp13(oqs
, reply
);
7342 case OFP11_VERSION
: {
7343 struct ofp11_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7344 ofputil_queue_stats_to_ofp11(oqs
, reply
);
7348 case OFP10_VERSION
: {
7349 struct ofp10_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7350 ofputil_queue_stats_to_ofp10(oqs
, reply
);
7354 case OFP14_VERSION
: {
7355 struct ofp14_queue_stats
*reply
= ofpmp_append(replies
, sizeof *reply
);
7356 ofputil_queue_stats_to_ofp14(oqs
, reply
);
7366 ofputil_decode_bundle_ctrl(const struct ofp_header
*oh
,
7367 struct ofputil_bundle_ctrl_msg
*msg
)
7371 const struct ofp14_bundle_ctrl_msg
*m
;
7373 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7374 raw
= ofpraw_pull_assert(&b
);
7375 ovs_assert(raw
== OFPRAW_OFPT14_BUNDLE_CONTROL
);
7378 msg
->bundle_id
= ntohl(m
->bundle_id
);
7379 msg
->type
= ntohs(m
->type
);
7380 msg
->flags
= ntohs(m
->flags
);
7386 ofputil_encode_bundle_ctrl_reply(const struct ofp_header
*oh
,
7387 struct ofputil_bundle_ctrl_msg
*msg
)
7390 struct ofp14_bundle_ctrl_msg
*m
;
7392 buf
= ofpraw_alloc_reply(OFPRAW_OFPT14_BUNDLE_CONTROL
, oh
, 0);
7393 m
= ofpbuf_put_zeros(buf
, sizeof *m
);
7395 m
->bundle_id
= htonl(msg
->bundle_id
);
7396 m
->type
= htons(msg
->type
);
7397 m
->flags
= htons(msg
->flags
);
7403 ofputil_decode_bundle_add(const struct ofp_header
*oh
,
7404 struct ofputil_bundle_add_msg
*msg
)
7406 const struct ofp14_bundle_ctrl_msg
*m
;
7411 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
7412 raw
= ofpraw_pull_assert(&b
);
7413 ovs_assert(raw
== OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
);
7415 m
= ofpbuf_pull(&b
, sizeof *m
);
7416 msg
->bundle_id
= ntohl(m
->bundle_id
);
7417 msg
->flags
= ntohs(m
->flags
);
7419 msg
->msg
= ofpbuf_data(&b
);
7420 inner_len
= ntohs(msg
->msg
->length
);
7421 if (inner_len
< sizeof(struct ofp_header
) || inner_len
> ofpbuf_size(&b
)) {
7422 return OFPERR_OFPBFC_MSG_BAD_LEN
;
7429 ofputil_encode_bundle_add(enum ofp_version ofp_version
,
7430 struct ofputil_bundle_add_msg
*msg
)
7432 struct ofpbuf
*request
;
7433 struct ofp14_bundle_ctrl_msg
*m
;
7435 request
= ofpraw_alloc(OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE
, ofp_version
, 0);
7436 m
= ofpbuf_put_zeros(request
, sizeof *m
);
7438 m
->bundle_id
= htonl(msg
->bundle_id
);
7439 m
->flags
= htons(msg
->flags
);
7440 ofpbuf_put(request
, msg
->msg
, ntohs(msg
->msg
->length
));