]>
Commit | Line | Data |
---|---|---|
982697a4 | 1 | /* |
0a96a21b | 2 | * Copyright (c) 2012, 2013, 2014, 2015, 2016 Nicira, Inc. |
982697a4 BP |
3 | * |
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: | |
7 | * | |
8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
9 | * | |
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. | |
15 | */ | |
16 | ||
17 | #include <config.h> | |
982697a4 | 18 | #include "byte-order.h" |
982697a4 | 19 | #include "hash.h" |
ee89ea7b | 20 | #include "openvswitch/hmap.h" |
982697a4 BP |
21 | #include "openflow/nicira-ext.h" |
22 | #include "openflow/openflow.h" | |
d271907f BW |
23 | #include "openvswitch/dynamic-string.h" |
24 | #include "openvswitch/ofp-msgs.h" | |
25 | #include "openvswitch/ofpbuf.h" | |
e6211adc | 26 | #include "openvswitch/vlog.h" |
d271907f | 27 | #include "ovs-thread.h" |
ee89ea7b | 28 | #include "util.h" |
982697a4 BP |
29 | |
30 | VLOG_DEFINE_THIS_MODULE(ofp_msgs); | |
31 | ||
32 | #define OFPT_VENDOR 4 | |
33 | #define OFPT10_STATS_REQUEST 16 | |
34 | #define OFPT10_STATS_REPLY 17 | |
35 | #define OFPT11_STATS_REQUEST 18 | |
36 | #define OFPT11_STATS_REPLY 19 | |
37 | #define OFPST_VENDOR 0xffff | |
38 | ||
2123bc8c BP |
39 | /* Vendor extension message. */ |
40 | struct ofp_vendor_header { | |
41 | struct ofp_header header; /* OFPT_VENDOR. */ | |
42 | ovs_be32 vendor; /* Vendor ID: | |
43 | * - MSB 0: low-order bytes are IEEE OUI. | |
44 | * - MSB != 0: defined by OpenFlow | |
45 | * consortium. */ | |
46 | ||
47 | /* In theory everything after 'vendor' is vendor specific. In practice, | |
48 | * the vendors we support put a 32-bit subtype here. We'll change this | |
49 | * structure if we start adding support for other vendor formats. */ | |
50 | ovs_be32 subtype; /* Vendor-specific subtype. */ | |
51 | ||
52 | /* Followed by vendor-defined additional data. */ | |
53 | }; | |
54 | OFP_ASSERT(sizeof(struct ofp_vendor_header) == 16); | |
55 | ||
df63a142 BP |
56 | /* Statistics request or reply message. */ |
57 | struct ofp10_stats_msg { | |
58 | struct ofp_header header; | |
59 | ovs_be16 type; /* One of the OFPST_* constants. */ | |
60 | ovs_be16 flags; /* Requests: always 0. | |
61 | * Replies: 0 or OFPSF_REPLY_MORE. */ | |
62 | }; | |
63 | OFP_ASSERT(sizeof(struct ofp10_stats_msg) == 12); | |
64 | ||
65 | /* Vendor extension stats message. */ | |
66 | struct ofp10_vendor_stats_msg { | |
67 | struct ofp10_stats_msg osm; /* Type OFPST_VENDOR. */ | |
68 | ovs_be32 vendor; /* Vendor ID: | |
69 | * - MSB 0: low-order bytes are IEEE OUI. | |
70 | * - MSB != 0: defined by OpenFlow | |
71 | * consortium. */ | |
72 | /* Followed by vendor-defined arbitrary additional data. */ | |
73 | }; | |
74 | OFP_ASSERT(sizeof(struct ofp10_vendor_stats_msg) == 16); | |
75 | ||
76 | struct ofp11_stats_msg { | |
77 | struct ofp_header header; | |
78 | ovs_be16 type; /* One of the OFPST_* constants. */ | |
79 | ovs_be16 flags; /* OFPSF_REQ_* flags (none yet defined). */ | |
80 | uint8_t pad[4]; | |
81 | /* Followed by the body of the request. */ | |
82 | }; | |
83 | OFP_ASSERT(sizeof(struct ofp11_stats_msg) == 16); | |
84 | ||
2123bc8c BP |
85 | /* Vendor extension stats message. */ |
86 | struct ofp11_vendor_stats_msg { | |
87 | struct ofp11_stats_msg osm; /* Type OFPST_VENDOR. */ | |
88 | ovs_be32 vendor; /* Vendor ID: | |
89 | * - MSB 0: low-order bytes are IEEE OUI. | |
90 | * - MSB != 0: defined by OpenFlow | |
91 | * consortium. */ | |
92 | ||
93 | /* In theory everything after 'vendor' is vendor specific. In practice, | |
94 | * the vendors we support put a 32-bit subtype here. We'll change this | |
95 | * structure if we start adding support for other vendor formats. */ | |
96 | ovs_be32 subtype; /* Vendor-specific subtype. */ | |
97 | ||
98 | /* Followed by vendor-defined additional data. */ | |
99 | }; | |
100 | OFP_ASSERT(sizeof(struct ofp11_vendor_stats_msg) == 24); | |
df63a142 BP |
101 | |
102 | /* Header for Nicira vendor stats request and reply messages in OpenFlow | |
103 | * 1.0. */ | |
104 | struct nicira10_stats_msg { | |
105 | struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */ | |
106 | ovs_be32 subtype; /* One of NXST_* below. */ | |
107 | uint8_t pad[4]; /* Align to 64-bits. */ | |
108 | }; | |
109 | OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24); | |
110 | ||
982697a4 BP |
111 | /* A thin abstraction of OpenFlow headers: |
112 | * | |
113 | * - 'version' and 'type' come straight from struct ofp_header, so these are | |
114 | * always present and meaningful. | |
115 | * | |
116 | * - 'stat' comes from the 'type' member in statistics messages only. It is | |
117 | * meaningful, therefore, only if 'version' and 'type' taken together | |
118 | * specify a statistics request or reply. Otherwise it is 0. | |
119 | * | |
120 | * - 'vendor' is meaningful only for vendor messages, that is, if 'version' | |
121 | * and 'type' specify a vendor message or if 'version' and 'type' specify | |
122 | * a statistics message and 'stat' specifies a vendor statistic type. | |
123 | * Otherwise it is 0. | |
124 | * | |
125 | * - 'subtype' is meaningful only for vendor messages and otherwise 0. It | |
126 | * specifies a vendor-defined subtype. There is no standard format for | |
127 | * these but 32 bits seems like it should be enough. */ | |
128 | struct ofphdrs { | |
129 | uint8_t version; /* From ofp_header. */ | |
130 | uint8_t type; /* From ofp_header. */ | |
131 | uint16_t stat; /* From ofp10_stats_msg or ofp11_stats_msg. */ | |
132 | uint32_t vendor; /* From ofp_vendor_header, | |
133 | * ofp10_vendor_stats_msg, or | |
134 | * ofp11_vendor_stats_msg. */ | |
135 | uint32_t subtype; /* From nicira_header, nicira10_stats_msg, or | |
136 | * nicira11_stats_msg. */ | |
137 | }; | |
138 | BUILD_ASSERT_DECL(sizeof(struct ofphdrs) == 12); | |
139 | ||
140 | /* A mapping from OpenFlow headers to OFPRAW_*. */ | |
141 | struct raw_instance { | |
142 | struct hmap_node hmap_node; /* In 'raw_instance_map'. */ | |
143 | struct ofphdrs hdrs; /* Key. */ | |
144 | enum ofpraw raw; /* Value. */ | |
145 | unsigned int hdrs_len; /* ofphdrs_len(hdrs). */ | |
146 | }; | |
147 | ||
148 | /* Information about a particular 'enum ofpraw'. */ | |
149 | struct raw_info { | |
150 | /* All possible instantiations of this OFPRAW_* into OpenFlow headers. */ | |
151 | struct raw_instance *instances; /* min_version - max_version + 1 elems. */ | |
152 | uint8_t min_version; | |
153 | uint8_t max_version; | |
154 | ||
155 | unsigned int min_body; | |
156 | unsigned int extra_multiple; | |
157 | enum ofptype type; | |
158 | const char *name; | |
159 | }; | |
160 | ||
161 | /* All understood OpenFlow message types, indexed by their 'struct ofphdrs'. */ | |
162 | static struct hmap raw_instance_map; | |
163 | #include "ofp-msgs.inc" | |
164 | ||
165 | static ovs_be32 alloc_xid(void); | |
166 | ||
167 | /* ofphdrs functions. */ | |
168 | static uint32_t ofphdrs_hash(const struct ofphdrs *); | |
169 | static bool ofphdrs_equal(const struct ofphdrs *a, const struct ofphdrs *b); | |
170 | static enum ofperr ofphdrs_decode(struct ofphdrs *, | |
171 | const struct ofp_header *oh, size_t length); | |
172 | static void ofphdrs_decode_assert(struct ofphdrs *, | |
173 | const struct ofp_header *oh, size_t length); | |
174 | size_t ofphdrs_len(const struct ofphdrs *); | |
175 | ||
176 | static const struct raw_info *raw_info_get(enum ofpraw); | |
177 | static struct raw_instance *raw_instance_get(const struct raw_info *, | |
178 | uint8_t version); | |
179 | ||
180 | static enum ofperr ofpraw_from_ofphdrs(enum ofpraw *, const struct ofphdrs *); | |
181 | \f | |
182 | /* Returns a transaction ID to use for an outgoing OpenFlow message. */ | |
183 | static ovs_be32 | |
184 | alloc_xid(void) | |
185 | { | |
ca4fbdfe | 186 | static atomic_count next_xid = ATOMIC_COUNT_INIT(1); |
d0c79f7f | 187 | |
ca4fbdfe | 188 | return htonl(atomic_count_inc(&next_xid)); |
982697a4 BP |
189 | } |
190 | \f | |
191 | static uint32_t | |
192 | ofphdrs_hash(const struct ofphdrs *hdrs) | |
193 | { | |
0a96a21b BP |
194 | BUILD_ASSERT_DECL(sizeof *hdrs % 4 == 0); |
195 | return hash_bytes32((const uint32_t *) hdrs, sizeof *hdrs, 0); | |
982697a4 BP |
196 | } |
197 | ||
198 | static bool | |
199 | ofphdrs_equal(const struct ofphdrs *a, const struct ofphdrs *b) | |
200 | { | |
201 | return !memcmp(a, b, sizeof *a); | |
202 | } | |
203 | ||
204 | static void | |
205 | log_bad_vendor(uint32_t vendor) | |
206 | { | |
207 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1); | |
208 | ||
209 | VLOG_WARN_RL(&rl, "OpenFlow message has unknown vendor %#"PRIx32, vendor); | |
210 | } | |
211 | ||
212 | static enum ofperr | |
213 | ofphdrs_decode(struct ofphdrs *hdrs, | |
214 | const struct ofp_header *oh, size_t length) | |
215 | { | |
216 | memset(hdrs, 0, sizeof *hdrs); | |
217 | if (length < sizeof *oh) { | |
218 | return OFPERR_OFPBRC_BAD_LEN; | |
219 | } | |
220 | ||
221 | /* Get base message version and type (OFPT_*). */ | |
222 | hdrs->version = oh->version; | |
223 | hdrs->type = oh->type; | |
224 | ||
225 | if (hdrs->type == OFPT_VENDOR) { | |
226 | /* Get vendor. */ | |
227 | const struct ofp_vendor_header *ovh; | |
228 | ||
229 | if (length < sizeof *ovh) { | |
230 | return OFPERR_OFPBRC_BAD_LEN; | |
231 | } | |
232 | ||
233 | ovh = (const struct ofp_vendor_header *) oh; | |
234 | hdrs->vendor = ntohl(ovh->vendor); | |
2123bc8c BP |
235 | if (hdrs->vendor == NX_VENDOR_ID || hdrs->vendor == ONF_VENDOR_ID) { |
236 | hdrs->subtype = ntohl(ovh->subtype); | |
982697a4 BP |
237 | } else { |
238 | log_bad_vendor(hdrs->vendor); | |
239 | return OFPERR_OFPBRC_BAD_VENDOR; | |
240 | } | |
241 | } else if (hdrs->version == OFP10_VERSION | |
242 | && (hdrs->type == OFPT10_STATS_REQUEST || | |
243 | hdrs->type == OFPT10_STATS_REPLY)) { | |
e2b9ac44 | 244 | const struct ofp10_stats_msg *osm; |
982697a4 BP |
245 | |
246 | /* Get statistic type (OFPST_*). */ | |
247 | if (length < sizeof *osm) { | |
248 | return OFPERR_OFPBRC_BAD_LEN; | |
249 | } | |
e2b9ac44 | 250 | osm = (const struct ofp10_stats_msg *) oh; |
982697a4 BP |
251 | hdrs->stat = ntohs(osm->type); |
252 | ||
253 | if (hdrs->stat == OFPST_VENDOR) { | |
254 | /* Get vendor. */ | |
255 | const struct ofp10_vendor_stats_msg *ovsm; | |
256 | ||
257 | if (length < sizeof *ovsm) { | |
258 | return OFPERR_OFPBRC_BAD_LEN; | |
259 | } | |
260 | ||
261 | ovsm = (const struct ofp10_vendor_stats_msg *) oh; | |
262 | hdrs->vendor = ntohl(ovsm->vendor); | |
263 | if (hdrs->vendor == NX_VENDOR_ID) { | |
264 | /* Get Nicira statistic type (NXST_*). */ | |
265 | const struct nicira10_stats_msg *nsm; | |
266 | ||
267 | if (length < sizeof *nsm) { | |
268 | return OFPERR_OFPBRC_BAD_LEN; | |
269 | } | |
270 | nsm = (const struct nicira10_stats_msg *) oh; | |
271 | hdrs->subtype = ntohl(nsm->subtype); | |
272 | } else { | |
273 | log_bad_vendor(hdrs->vendor); | |
274 | return OFPERR_OFPBRC_BAD_VENDOR; | |
275 | } | |
276 | } | |
277 | } else if (hdrs->version != OFP10_VERSION | |
278 | && (hdrs->type == OFPT11_STATS_REQUEST || | |
279 | hdrs->type == OFPT11_STATS_REPLY)) { | |
280 | const struct ofp11_stats_msg *osm; | |
281 | ||
282 | /* Get statistic type (OFPST_*). */ | |
283 | if (length < sizeof *osm) { | |
284 | return OFPERR_OFPBRC_BAD_LEN; | |
285 | } | |
286 | osm = (const struct ofp11_stats_msg *) oh; | |
287 | hdrs->stat = ntohs(osm->type); | |
288 | ||
289 | if (hdrs->stat == OFPST_VENDOR) { | |
290 | /* Get vendor. */ | |
291 | const struct ofp11_vendor_stats_msg *ovsm; | |
292 | ||
293 | if (length < sizeof *ovsm) { | |
294 | return OFPERR_OFPBRC_BAD_LEN; | |
295 | } | |
296 | ||
297 | ovsm = (const struct ofp11_vendor_stats_msg *) oh; | |
298 | hdrs->vendor = ntohl(ovsm->vendor); | |
2123bc8c BP |
299 | if (hdrs->vendor == NX_VENDOR_ID || |
300 | hdrs->vendor == ONF_VENDOR_ID) { | |
301 | hdrs->subtype = ntohl(ovsm->subtype); | |
982697a4 BP |
302 | } else { |
303 | log_bad_vendor(hdrs->vendor); | |
304 | return OFPERR_OFPBRC_BAD_VENDOR; | |
305 | } | |
306 | } | |
307 | } | |
308 | ||
309 | return 0; | |
310 | } | |
311 | ||
312 | static void | |
313 | ofphdrs_decode_assert(struct ofphdrs *hdrs, | |
314 | const struct ofp_header *oh, size_t length) | |
315 | { | |
316 | enum ofperr error = ofphdrs_decode(hdrs, oh, length); | |
cb22974d | 317 | ovs_assert(!error); |
982697a4 BP |
318 | } |
319 | ||
320 | static bool | |
76ec08e0 | 321 | ofp_is_stat_request(enum ofp_version version, uint8_t type) |
982697a4 | 322 | { |
76ec08e0 YT |
323 | switch (version) { |
324 | case OFP10_VERSION: | |
325 | return type == OFPT10_STATS_REQUEST; | |
326 | case OFP11_VERSION: | |
327 | case OFP12_VERSION: | |
328 | case OFP13_VERSION: | |
c37c0382 | 329 | case OFP14_VERSION: |
42dccab5 | 330 | case OFP15_VERSION: |
b79d45a1 | 331 | case OFP16_VERSION: |
76ec08e0 YT |
332 | return type == OFPT11_STATS_REQUEST; |
333 | } | |
334 | ||
335 | return false; | |
336 | } | |
337 | ||
338 | static bool | |
339 | ofp_is_stat_reply(enum ofp_version version, uint8_t type) | |
340 | { | |
341 | switch (version) { | |
2e3fa633 | 342 | case OFP10_VERSION: |
76ec08e0 | 343 | return type == OFPT10_STATS_REPLY; |
2e3fa633 SH |
344 | case OFP11_VERSION: |
345 | case OFP12_VERSION: | |
2e1ae200 | 346 | case OFP13_VERSION: |
c37c0382 | 347 | case OFP14_VERSION: |
42dccab5 | 348 | case OFP15_VERSION: |
b79d45a1 | 349 | case OFP16_VERSION: |
76ec08e0 | 350 | return type == OFPT11_STATS_REPLY; |
2e3fa633 SH |
351 | } |
352 | ||
353 | return false; | |
982697a4 BP |
354 | } |
355 | ||
76ec08e0 YT |
356 | static bool |
357 | ofp_is_stat(enum ofp_version version, uint8_t type) | |
358 | { | |
359 | return (ofp_is_stat_request(version, type) || | |
360 | ofp_is_stat_reply(version, type)); | |
361 | } | |
362 | ||
363 | static bool | |
364 | ofphdrs_is_stat(const struct ofphdrs *hdrs) | |
365 | { | |
366 | return ofp_is_stat(hdrs->version, hdrs->type); | |
367 | } | |
368 | ||
982697a4 BP |
369 | size_t |
370 | ofphdrs_len(const struct ofphdrs *hdrs) | |
371 | { | |
372 | if (hdrs->type == OFPT_VENDOR) { | |
2123bc8c | 373 | return sizeof(struct ofp_vendor_header); |
982697a4 BP |
374 | } |
375 | ||
2e3fa633 SH |
376 | switch ((enum ofp_version) hdrs->version) { |
377 | case OFP10_VERSION: | |
982697a4 BP |
378 | if (hdrs->type == OFPT10_STATS_REQUEST || |
379 | hdrs->type == OFPT10_STATS_REPLY) { | |
380 | return (hdrs->stat == OFPST_VENDOR | |
381 | ? sizeof(struct nicira10_stats_msg) | |
e2b9ac44 | 382 | : sizeof(struct ofp10_stats_msg)); |
982697a4 | 383 | } |
2e3fa633 SH |
384 | break; |
385 | ||
386 | case OFP11_VERSION: | |
387 | case OFP12_VERSION: | |
2e1ae200 | 388 | case OFP13_VERSION: |
c37c0382 | 389 | case OFP14_VERSION: |
42dccab5 | 390 | case OFP15_VERSION: |
b79d45a1 | 391 | case OFP16_VERSION: |
982697a4 BP |
392 | if (hdrs->type == OFPT11_STATS_REQUEST || |
393 | hdrs->type == OFPT11_STATS_REPLY) { | |
394 | return (hdrs->stat == OFPST_VENDOR | |
2123bc8c | 395 | ? sizeof(struct ofp11_vendor_stats_msg) |
982697a4 BP |
396 | : sizeof(struct ofp11_stats_msg)); |
397 | } | |
2e3fa633 | 398 | break; |
982697a4 BP |
399 | } |
400 | ||
401 | return sizeof(struct ofp_header); | |
402 | } | |
403 | \f | |
404 | /* Determines the OFPRAW_* type of the OpenFlow message at 'oh', which has | |
405 | * length 'oh->length'. (The caller must ensure that 'oh->length' bytes of | |
406 | * data are readable at 'oh'.) On success, returns 0 and stores the type into | |
407 | * '*raw'. On failure, returns an OFPERR_* error code and zeros '*raw'. | |
408 | * | |
409 | * This function checks that 'oh' is a valid length for its particular type of | |
410 | * message, and returns an error if not. */ | |
411 | enum ofperr | |
412 | ofpraw_decode(enum ofpraw *raw, const struct ofp_header *oh) | |
413 | { | |
0a2869d5 | 414 | struct ofpbuf msg = ofpbuf_const_initializer(oh, ntohs(oh->length)); |
982697a4 BP |
415 | return ofpraw_pull(raw, &msg); |
416 | } | |
417 | ||
964a5f60 BP |
418 | /* Does the same job as ofpraw_decode(), except that it assert-fails if |
419 | * ofpraw_decode() would have reported an error. Thus, it's able to use the | |
420 | * return value for the OFPRAW_* message type instead of an error code. | |
421 | * | |
422 | * (It only makes sense to use this function if you previously called | |
423 | * ofpraw_decode() on the message and thus know that it's OK.) */ | |
424 | enum ofpraw | |
425 | ofpraw_decode_assert(const struct ofp_header *oh) | |
426 | { | |
427 | enum ofperr error; | |
428 | enum ofpraw raw; | |
429 | ||
430 | error = ofpraw_decode(&raw, oh); | |
431 | ovs_assert(!error); | |
432 | return raw; | |
433 | } | |
434 | ||
982697a4 | 435 | /* Determines the OFPRAW_* type of the OpenFlow message in 'msg', which starts |
6fd6ed71 | 436 | * at 'msg->data' and has length 'msg->size' bytes. On success, |
cf3b7538 JR |
437 | * returns 0 and stores the type into '*rawp'. On failure, returns an OFPERR_* |
438 | * error code and zeros '*rawp'. | |
982697a4 BP |
439 | * |
440 | * This function checks that the message has a valid length for its particular | |
441 | * type of message, and returns an error if not. | |
442 | * | |
443 | * In addition to setting '*rawp', this function pulls off the OpenFlow header | |
444 | * (including the stats headers, vendor header, and any subtype header) with | |
77a9bb31 BP |
445 | * ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow |
446 | * header and 'msg->msg' just beyond the headers (that is, to the final value | |
447 | * of msg->data). */ | |
982697a4 BP |
448 | enum ofperr |
449 | ofpraw_pull(enum ofpraw *rawp, struct ofpbuf *msg) | |
450 | { | |
451 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); | |
452 | ||
453 | const struct raw_instance *instance; | |
454 | const struct raw_info *info; | |
455 | struct ofphdrs hdrs; | |
456 | ||
457 | unsigned int min_len; | |
458 | unsigned int len; | |
459 | ||
460 | enum ofperr error; | |
461 | enum ofpraw raw; | |
462 | ||
463 | /* Set default outputs. */ | |
6fd6ed71 PS |
464 | msg->header = msg->data; |
465 | msg->msg = msg->header; | |
982697a4 BP |
466 | *rawp = 0; |
467 | ||
6fd6ed71 PS |
468 | len = msg->size; |
469 | error = ofphdrs_decode(&hdrs, msg->data, len); | |
982697a4 BP |
470 | if (error) { |
471 | return error; | |
472 | } | |
473 | ||
474 | error = ofpraw_from_ofphdrs(&raw, &hdrs); | |
475 | if (error) { | |
476 | return error; | |
477 | } | |
478 | ||
479 | info = raw_info_get(raw); | |
480 | instance = raw_instance_get(info, hdrs.version); | |
6fd6ed71 PS |
481 | msg->header = ofpbuf_pull(msg, instance->hdrs_len); |
482 | msg->msg = msg->data; | |
982697a4 BP |
483 | |
484 | min_len = instance->hdrs_len + info->min_body; | |
485 | switch (info->extra_multiple) { | |
486 | case 0: | |
487 | if (len != min_len) { | |
488 | VLOG_WARN_RL(&rl, "received %s with incorrect length %u (expected " | |
489 | "length %u)", info->name, len, min_len); | |
490 | return OFPERR_OFPBRC_BAD_LEN; | |
491 | } | |
492 | break; | |
493 | ||
494 | case 1: | |
495 | if (len < min_len) { | |
496 | VLOG_WARN_RL(&rl, "received %s with incorrect length %u (expected " | |
497 | "length at least %u bytes)", | |
498 | info->name, len, min_len); | |
499 | return OFPERR_OFPBRC_BAD_LEN; | |
500 | } | |
501 | break; | |
502 | ||
503 | default: | |
504 | if (len < min_len || (len - min_len) % info->extra_multiple) { | |
505 | VLOG_WARN_RL(&rl, "received %s with incorrect length %u (must be " | |
506 | "exactly %u bytes or longer by an integer multiple " | |
507 | "of %u bytes)", | |
508 | info->name, len, min_len, info->extra_multiple); | |
509 | return OFPERR_OFPBRC_BAD_LEN; | |
510 | } | |
511 | break; | |
512 | } | |
513 | ||
514 | *rawp = raw; | |
515 | return 0; | |
516 | } | |
517 | ||
518 | /* Does the same job as ofpraw_pull(), except that it assert-fails if | |
e032c086 | 519 | * ofpraw_pull() would have reported an error. Thus, it's able to use the |
982697a4 BP |
520 | * return value for the OFPRAW_* message type instead of an error code. |
521 | * | |
522 | * (It only makes sense to use this function if you previously called | |
e032c086 | 523 | * ofpraw_decode() on the message and thus know that it's OK.) */ |
982697a4 BP |
524 | enum ofpraw |
525 | ofpraw_pull_assert(struct ofpbuf *msg) | |
526 | { | |
527 | enum ofperr error; | |
528 | enum ofpraw raw; | |
529 | ||
530 | error = ofpraw_pull(&raw, msg); | |
cb22974d | 531 | ovs_assert(!error); |
982697a4 BP |
532 | return raw; |
533 | } | |
534 | ||
535 | /* Determines the OFPRAW_* type of the OpenFlow message that starts at 'oh' and | |
536 | * has length 'length' bytes. On success, returns 0 and stores the type into | |
537 | * '*rawp'. On failure, returns an OFPERR_* error code and zeros '*rawp'. | |
538 | * | |
539 | * Unlike other functions for decoding message types, this one is not picky | |
540 | * about message length. For example, it will successfully decode a message | |
541 | * whose body is shorter than the minimum length for a message of its type. | |
542 | * Thus, this is the correct function to use for decoding the type of a message | |
543 | * that might have been truncated, such as the payload of an OpenFlow error | |
544 | * message (which is allowed to be truncated to 64 bytes). */ | |
545 | enum ofperr | |
546 | ofpraw_decode_partial(enum ofpraw *raw, | |
547 | const struct ofp_header *oh, size_t length) | |
548 | { | |
549 | struct ofphdrs hdrs; | |
550 | enum ofperr error; | |
551 | ||
552 | error = ofphdrs_decode(&hdrs, oh, length); | |
553 | if (!error) { | |
554 | error = ofpraw_from_ofphdrs(raw, &hdrs); | |
555 | } | |
556 | ||
557 | if (error) { | |
558 | *raw = 0; | |
559 | } | |
560 | return error; | |
561 | } | |
562 | \f | |
563 | /* Encoding messages using OFPRAW_* values. */ | |
564 | ||
565 | static void ofpraw_put__(enum ofpraw, uint8_t version, ovs_be32 xid, | |
566 | size_t extra_tailroom, struct ofpbuf *); | |
567 | ||
568 | /* Allocates and returns a new ofpbuf that contains an OpenFlow header for | |
569 | * 'raw' with OpenFlow version 'version' and a fresh OpenFlow transaction ID. | |
570 | * The ofpbuf has enough tailroom for the minimum body length of 'raw', plus | |
571 | * 'extra_tailroom' additional bytes. | |
572 | * | |
573 | * Each 'raw' value is valid only for certain OpenFlow versions. The caller | |
574 | * must specify a valid (raw, version) pair. | |
575 | * | |
77a9bb31 BP |
576 | * In the returned ofpbuf, 'header' points to the beginning of the |
577 | * OpenFlow header and 'msg' points just after it, to where the | |
cf3b7538 JR |
578 | * message's body will start. The caller must actually allocate the |
579 | * body into the space reserved for it, e.g. with ofpbuf_put_uninit(). | |
982697a4 BP |
580 | * |
581 | * The caller owns the returned ofpbuf and must free it when it is no longer | |
582 | * needed, e.g. with ofpbuf_delete(). */ | |
583 | struct ofpbuf * | |
584 | ofpraw_alloc(enum ofpraw raw, uint8_t version, size_t extra_tailroom) | |
585 | { | |
586 | return ofpraw_alloc_xid(raw, version, alloc_xid(), extra_tailroom); | |
587 | } | |
588 | ||
589 | /* Same as ofpraw_alloc() but the caller provides the transaction ID. */ | |
590 | struct ofpbuf * | |
591 | ofpraw_alloc_xid(enum ofpraw raw, uint8_t version, ovs_be32 xid, | |
592 | size_t extra_tailroom) | |
593 | { | |
594 | struct ofpbuf *buf = ofpbuf_new(0); | |
595 | ofpraw_put__(raw, version, xid, extra_tailroom, buf); | |
596 | return buf; | |
597 | } | |
598 | ||
599 | /* Same as ofpraw_alloc(), but obtains the OpenFlow version and transaction ID | |
600 | * from 'request->version' and 'request->xid', respectively. | |
601 | * | |
602 | * Even though the version comes from 'request->version', the caller must still | |
603 | * know what it is doing, by specifying a valid pairing of 'raw' and | |
604 | * 'request->version', just like ofpraw_alloc(). */ | |
605 | struct ofpbuf * | |
606 | ofpraw_alloc_reply(enum ofpraw raw, const struct ofp_header *request, | |
607 | size_t extra_tailroom) | |
608 | { | |
609 | return ofpraw_alloc_xid(raw, request->version, request->xid, | |
610 | extra_tailroom); | |
611 | } | |
612 | ||
613 | /* Allocates and returns a new ofpbuf that contains an OpenFlow header that is | |
614 | * a stats reply to the stats request in 'request', using the same OpenFlow | |
615 | * version and transaction ID as 'request'. The ofpbuf has enough tailroom for | |
616 | * the stats reply's minimum body length, plus 'extra_tailroom' additional | |
617 | * bytes. | |
618 | * | |
619 | * 'request' must be a stats request, that is, an OFPRAW_OFPST* or OFPRAW_NXST* | |
620 | * value. Every stats request has a corresponding reply, so the (raw, version) | |
621 | * pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here. | |
622 | * | |
77a9bb31 BP |
623 | * In the returned ofpbuf, 'header' points to the beginning of the |
624 | * OpenFlow header and 'msg' points just after it, to where the | |
cf3b7538 JR |
625 | * message's body will start. The caller must actually allocate the |
626 | * body into the space reserved for it, e.g. with ofpbuf_put_uninit(). | |
982697a4 BP |
627 | * |
628 | * The caller owns the returned ofpbuf and must free it when it is no longer | |
629 | * needed, e.g. with ofpbuf_delete(). */ | |
630 | struct ofpbuf * | |
631 | ofpraw_alloc_stats_reply(const struct ofp_header *request, | |
632 | size_t extra_tailroom) | |
633 | { | |
634 | enum ofpraw request_raw; | |
635 | enum ofpraw reply_raw; | |
636 | enum ofperr error; | |
637 | ||
638 | error = ofpraw_decode_partial(&request_raw, request, | |
639 | ntohs(request->length)); | |
cb22974d | 640 | ovs_assert(!error); |
982697a4 BP |
641 | |
642 | reply_raw = ofpraw_stats_request_to_reply(request_raw, request->version); | |
cb22974d | 643 | ovs_assert(reply_raw); |
982697a4 BP |
644 | |
645 | return ofpraw_alloc_reply(reply_raw, request, extra_tailroom); | |
646 | } | |
647 | ||
648 | /* Appends to 'buf' an OpenFlow header for 'raw' with OpenFlow version | |
649 | * 'version' and a fresh OpenFlow transaction ID. Preallocates enough tailroom | |
650 | * in 'buf' for the minimum body length of 'raw', plus 'extra_tailroom' | |
651 | * additional bytes. | |
652 | * | |
653 | * Each 'raw' value is valid only for certain OpenFlow versions. The caller | |
654 | * must specify a valid (raw, version) pair. | |
655 | * | |
77a9bb31 BP |
656 | * Upon return, 'buf->header' points to the beginning of the OpenFlow header |
657 | * and 'buf->msg' points just after it, to where the message's body will start. | |
658 | * The caller must actually allocating the body into the space reserved for it, | |
982697a4 BP |
659 | * e.g. with ofpbuf_put_uninit(). */ |
660 | void | |
661 | ofpraw_put(enum ofpraw raw, uint8_t version, struct ofpbuf *buf) | |
662 | { | |
663 | ofpraw_put__(raw, version, alloc_xid(), 0, buf); | |
664 | } | |
665 | ||
666 | /* Same as ofpraw_put() but the caller provides the transaction ID. */ | |
667 | void | |
668 | ofpraw_put_xid(enum ofpraw raw, uint8_t version, ovs_be32 xid, | |
669 | struct ofpbuf *buf) | |
670 | { | |
671 | ofpraw_put__(raw, version, xid, 0, buf); | |
672 | } | |
673 | ||
674 | /* Same as ofpraw_put(), but obtains the OpenFlow version and transaction ID | |
675 | * from 'request->version' and 'request->xid', respectively. | |
676 | * | |
677 | * Even though the version comes from 'request->version', the caller must still | |
678 | * know what it is doing, by specifying a valid pairing of 'raw' and | |
679 | * 'request->version', just like ofpraw_put(). */ | |
680 | void | |
681 | ofpraw_put_reply(enum ofpraw raw, const struct ofp_header *request, | |
682 | struct ofpbuf *buf) | |
683 | { | |
684 | ofpraw_put__(raw, request->version, request->xid, 0, buf); | |
685 | } | |
686 | ||
687 | /* Appends to 'buf' an OpenFlow header that is a stats reply to the stats | |
688 | * request in 'request', using the same OpenFlow version and transaction ID as | |
689 | * 'request'. Preallocate enough tailroom in 'buf for the stats reply's | |
690 | * minimum body length, plus 'extra_tailroom' additional bytes. | |
691 | * | |
692 | * 'request' must be a stats request, that is, an OFPRAW_OFPST* or OFPRAW_NXST* | |
693 | * value. Every stats request has a corresponding reply, so the (raw, version) | |
694 | * pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here. | |
695 | * | |
77a9bb31 BP |
696 | * In the returned ofpbuf, 'header' points to the beginning of the |
697 | * OpenFlow header and 'msg' points just after it, to where the | |
cf3b7538 JR |
698 | * message's body will start. The caller must actually allocate the |
699 | * body into the space reserved for it, e.g. with ofpbuf_put_uninit(). | |
982697a4 BP |
700 | * |
701 | * The caller owns the returned ofpbuf and must free it when it is no longer | |
702 | * needed, e.g. with ofpbuf_delete(). */ | |
703 | void | |
704 | ofpraw_put_stats_reply(const struct ofp_header *request, struct ofpbuf *buf) | |
705 | { | |
706 | enum ofperr error; | |
707 | enum ofpraw raw; | |
708 | ||
709 | error = ofpraw_decode_partial(&raw, request, ntohs(request->length)); | |
cb22974d | 710 | ovs_assert(!error); |
982697a4 BP |
711 | |
712 | raw = ofpraw_stats_request_to_reply(raw, request->version); | |
cb22974d | 713 | ovs_assert(raw); |
982697a4 BP |
714 | |
715 | ofpraw_put__(raw, request->version, request->xid, 0, buf); | |
716 | } | |
717 | ||
718 | static void | |
719 | ofpraw_put__(enum ofpraw raw, uint8_t version, ovs_be32 xid, | |
720 | size_t extra_tailroom, struct ofpbuf *buf) | |
721 | { | |
722 | const struct raw_info *info = raw_info_get(raw); | |
723 | const struct raw_instance *instance = raw_instance_get(info, version); | |
724 | const struct ofphdrs *hdrs = &instance->hdrs; | |
725 | struct ofp_header *oh; | |
726 | ||
727 | ofpbuf_prealloc_tailroom(buf, (instance->hdrs_len + info->min_body | |
728 | + extra_tailroom)); | |
6fd6ed71 PS |
729 | buf->header = ofpbuf_put_uninit(buf, instance->hdrs_len); |
730 | buf->msg = ofpbuf_tail(buf); | |
982697a4 | 731 | |
6fd6ed71 | 732 | oh = buf->header; |
982697a4 BP |
733 | oh->version = version; |
734 | oh->type = hdrs->type; | |
6fd6ed71 | 735 | oh->length = htons(buf->size); |
982697a4 BP |
736 | oh->xid = xid; |
737 | ||
738 | if (hdrs->type == OFPT_VENDOR) { | |
2123bc8c | 739 | struct ofp_vendor_header *ovh = buf->header; |
982697a4 | 740 | |
2123bc8c BP |
741 | ovh->vendor = htonl(hdrs->vendor); |
742 | ovh->subtype = htonl(hdrs->subtype); | |
982697a4 BP |
743 | } else if (version == OFP10_VERSION |
744 | && (hdrs->type == OFPT10_STATS_REQUEST || | |
745 | hdrs->type == OFPT10_STATS_REPLY)) { | |
6fd6ed71 | 746 | struct ofp10_stats_msg *osm = buf->header; |
982697a4 BP |
747 | |
748 | osm->type = htons(hdrs->stat); | |
749 | osm->flags = htons(0); | |
750 | ||
751 | if (hdrs->stat == OFPST_VENDOR) { | |
6fd6ed71 | 752 | struct ofp10_vendor_stats_msg *ovsm = buf->header; |
982697a4 BP |
753 | |
754 | ovsm->vendor = htonl(hdrs->vendor); | |
755 | if (hdrs->vendor == NX_VENDOR_ID) { | |
6fd6ed71 | 756 | struct nicira10_stats_msg *nsm = buf->header; |
982697a4 BP |
757 | |
758 | nsm->subtype = htonl(hdrs->subtype); | |
759 | memset(nsm->pad, 0, sizeof nsm->pad); | |
760 | } else { | |
428b2edd | 761 | OVS_NOT_REACHED(); |
982697a4 BP |
762 | } |
763 | } | |
764 | } else if (version != OFP10_VERSION | |
765 | && (hdrs->type == OFPT11_STATS_REQUEST || | |
766 | hdrs->type == OFPT11_STATS_REPLY)) { | |
6fd6ed71 | 767 | struct ofp11_stats_msg *osm = buf->header; |
982697a4 BP |
768 | |
769 | osm->type = htons(hdrs->stat); | |
770 | osm->flags = htons(0); | |
771 | memset(osm->pad, 0, sizeof osm->pad); | |
772 | ||
773 | if (hdrs->stat == OFPST_VENDOR) { | |
6fd6ed71 | 774 | struct ofp11_vendor_stats_msg *ovsm = buf->header; |
982697a4 BP |
775 | |
776 | ovsm->vendor = htonl(hdrs->vendor); | |
2123bc8c | 777 | ovsm->subtype = htonl(hdrs->subtype); |
982697a4 BP |
778 | } |
779 | } | |
780 | } | |
781 | \f | |
782 | /* Returns 'raw''s name. | |
783 | * | |
784 | * The name is the name used for 'raw' in the OpenFlow specification. For | |
785 | * example, ofpraw_get_name(OFPRAW_OFPT10_FEATURES_REPLY) is | |
786 | * "OFPT_FEATURES_REPLY". | |
787 | * | |
788 | * The caller must not modify or free the returned string. */ | |
789 | const char * | |
790 | ofpraw_get_name(enum ofpraw raw) | |
791 | { | |
792 | return raw_info_get(raw)->name; | |
793 | } | |
794 | ||
795 | /* Returns the stats reply that corresponds to 'raw' in the given OpenFlow | |
796 | * 'version'. */ | |
797 | enum ofpraw | |
798 | ofpraw_stats_request_to_reply(enum ofpraw raw, uint8_t version) | |
799 | { | |
800 | const struct raw_info *info = raw_info_get(raw); | |
801 | const struct raw_instance *instance = raw_instance_get(info, version); | |
802 | enum ofpraw reply_raw; | |
803 | struct ofphdrs hdrs; | |
804 | enum ofperr error; | |
805 | ||
806 | hdrs = instance->hdrs; | |
2e3fa633 SH |
807 | switch ((enum ofp_version)hdrs.version) { |
808 | case OFP10_VERSION: | |
cb22974d | 809 | ovs_assert(hdrs.type == OFPT10_STATS_REQUEST); |
982697a4 | 810 | hdrs.type = OFPT10_STATS_REPLY; |
2e3fa633 SH |
811 | break; |
812 | case OFP11_VERSION: | |
813 | case OFP12_VERSION: | |
2e1ae200 | 814 | case OFP13_VERSION: |
c37c0382 | 815 | case OFP14_VERSION: |
42dccab5 | 816 | case OFP15_VERSION: |
b79d45a1 | 817 | case OFP16_VERSION: |
cb22974d | 818 | ovs_assert(hdrs.type == OFPT11_STATS_REQUEST); |
982697a4 | 819 | hdrs.type = OFPT11_STATS_REPLY; |
2e3fa633 SH |
820 | break; |
821 | default: | |
428b2edd | 822 | OVS_NOT_REACHED(); |
982697a4 BP |
823 | } |
824 | ||
825 | error = ofpraw_from_ofphdrs(&reply_raw, &hdrs); | |
cb22974d | 826 | ovs_assert(!error); |
982697a4 BP |
827 | |
828 | return reply_raw; | |
829 | } | |
830 | \f | |
831 | /* Determines the OFPTYPE_* type of the OpenFlow message at 'oh', which has | |
832 | * length 'oh->length'. (The caller must ensure that 'oh->length' bytes of | |
833 | * data are readable at 'oh'.) On success, returns 0 and stores the type into | |
834 | * '*typep'. On failure, returns an OFPERR_* error code and zeros '*typep'. | |
835 | * | |
836 | * This function checks that 'oh' is a valid length for its particular type of | |
837 | * message, and returns an error if not. */ | |
838 | enum ofperr | |
839 | ofptype_decode(enum ofptype *typep, const struct ofp_header *oh) | |
840 | { | |
841 | enum ofperr error; | |
842 | enum ofpraw raw; | |
843 | ||
844 | error = ofpraw_decode(&raw, oh); | |
845 | *typep = error ? 0 : ofptype_from_ofpraw(raw); | |
846 | return error; | |
847 | } | |
848 | ||
849 | /* Determines the OFPTYPE_* type of the OpenFlow message in 'msg', which starts | |
6fd6ed71 | 850 | * at 'msg->data' and has length 'msg->size' bytes. On success, |
cf3b7538 JR |
851 | * returns 0 and stores the type into '*typep'. On failure, returns an |
852 | * OFPERR_* error code and zeros '*typep'. | |
982697a4 BP |
853 | * |
854 | * This function checks that the message has a valid length for its particular | |
855 | * type of message, and returns an error if not. | |
856 | * | |
857 | * In addition to setting '*typep', this function pulls off the OpenFlow header | |
858 | * (including the stats headers, vendor header, and any subtype header) with | |
77a9bb31 BP |
859 | * ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow |
860 | * header and 'msg->msg' just beyond the headers (that is, to the final value | |
861 | * of msg->data). */ | |
982697a4 BP |
862 | enum ofperr |
863 | ofptype_pull(enum ofptype *typep, struct ofpbuf *buf) | |
864 | { | |
865 | enum ofperr error; | |
866 | enum ofpraw raw; | |
867 | ||
868 | error = ofpraw_pull(&raw, buf); | |
869 | *typep = error ? 0 : ofptype_from_ofpraw(raw); | |
870 | return error; | |
871 | } | |
872 | ||
873 | /* Returns the OFPTYPE_* type that corresponds to 'raw'. | |
874 | * | |
875 | * (This is a one-way trip, because the mapping from ofpraw to ofptype is | |
876 | * many-to-one.) */ | |
877 | enum ofptype | |
878 | ofptype_from_ofpraw(enum ofpraw raw) | |
879 | { | |
880 | return raw_info_get(raw)->type; | |
881 | } | |
64795a0d BP |
882 | |
883 | const char * | |
884 | ofptype_get_name(enum ofptype type) | |
885 | { | |
886 | ovs_assert(type < ARRAY_SIZE(type_names)); | |
887 | return type_names[type]; | |
888 | } | |
982697a4 BP |
889 | \f |
890 | /* Updates the 'length' field of the OpenFlow message in 'buf' to | |
6fd6ed71 | 891 | * 'buf->size'. */ |
982697a4 BP |
892 | void |
893 | ofpmsg_update_length(struct ofpbuf *buf) | |
894 | { | |
895 | struct ofp_header *oh = ofpbuf_at_assert(buf, 0, sizeof *oh); | |
6fd6ed71 | 896 | oh->length = htons(buf->size); |
982697a4 BP |
897 | } |
898 | ||
ea274df9 | 899 | /* Returns just past the OpenFlow header (including the stats headers, vendor |
982697a4 BP |
900 | * header, and any subtype header) in 'oh'. */ |
901 | const void * | |
902 | ofpmsg_body(const struct ofp_header *oh) | |
903 | { | |
904 | struct ofphdrs hdrs; | |
905 | ||
906 | ofphdrs_decode_assert(&hdrs, oh, ntohs(oh->length)); | |
907 | return (const uint8_t *) oh + ofphdrs_len(&hdrs); | |
908 | } | |
76ec08e0 YT |
909 | |
910 | /* Return if it's a stat/multipart (OFPST) request message. */ | |
911 | bool | |
912 | ofpmsg_is_stat_request(const struct ofp_header *oh) | |
913 | { | |
914 | return ofp_is_stat_request(oh->version, oh->type); | |
915 | } | |
982697a4 | 916 | \f |
79b8c36c BP |
917 | static ovs_be16 *ofpmp_flags__(const struct ofp_header *); |
918 | ||
982697a4 BP |
919 | /* Initializes 'replies' as a new list of stats messages that reply to |
920 | * 'request', which must be a stats request message. Initially the list will | |
921 | * consist of only a single reply part without any body. The caller should | |
922 | * use calls to the other ofpmp_*() functions to add to the body and split the | |
923 | * message into multiple parts, if necessary. */ | |
924 | void | |
ca6ba700 | 925 | ofpmp_init(struct ovs_list *replies, const struct ofp_header *request) |
982697a4 BP |
926 | { |
927 | struct ofpbuf *msg; | |
928 | ||
417e7e66 | 929 | ovs_list_init(replies); |
982697a4 BP |
930 | |
931 | msg = ofpraw_alloc_stats_reply(request, 1000); | |
417e7e66 | 932 | ovs_list_push_back(replies, &msg->list_node); |
982697a4 BP |
933 | } |
934 | ||
935 | /* Prepares to append up to 'len' bytes to the series of statistics replies in | |
936 | * 'replies', which should have been initialized with ofpmp_init(), if | |
937 | * necessary adding a new reply to the list. | |
938 | * | |
939 | * Returns an ofpbuf with at least 'len' bytes of tailroom. The 'len' bytes | |
940 | * have not actually been allocated, so the caller must do so with | |
941 | * e.g. ofpbuf_put_uninit(). */ | |
942 | struct ofpbuf * | |
ca6ba700 | 943 | ofpmp_reserve(struct ovs_list *replies, size_t len) |
982697a4 | 944 | { |
417e7e66 | 945 | struct ofpbuf *msg = ofpbuf_from_list(ovs_list_back(replies)); |
982697a4 | 946 | |
6fd6ed71 | 947 | if (msg->size + len <= UINT16_MAX) { |
982697a4 BP |
948 | ofpbuf_prealloc_tailroom(msg, len); |
949 | return msg; | |
950 | } else { | |
951 | unsigned int hdrs_len; | |
952 | struct ofpbuf *next; | |
953 | struct ofphdrs hdrs; | |
954 | ||
6fd6ed71 | 955 | ofphdrs_decode_assert(&hdrs, msg->data, msg->size); |
982697a4 BP |
956 | hdrs_len = ofphdrs_len(&hdrs); |
957 | ||
958 | next = ofpbuf_new(MAX(1024, hdrs_len + len)); | |
6fd6ed71 PS |
959 | ofpbuf_put(next, msg->data, hdrs_len); |
960 | next->header = next->data; | |
961 | next->msg = ofpbuf_tail(next); | |
417e7e66 | 962 | ovs_list_push_back(replies, &next->list_node); |
982697a4 | 963 | |
6fd6ed71 | 964 | *ofpmp_flags__(msg->data) |= htons(OFPSF_REPLY_MORE); |
79b8c36c | 965 | |
982697a4 BP |
966 | return next; |
967 | } | |
968 | } | |
969 | ||
970 | /* Appends 'len' bytes to the series of statistics replies in 'replies', and | |
971 | * returns the first byte. */ | |
972 | void * | |
ca6ba700 | 973 | ofpmp_append(struct ovs_list *replies, size_t len) |
982697a4 BP |
974 | { |
975 | return ofpbuf_put_uninit(ofpmp_reserve(replies, len), len); | |
976 | } | |
977 | ||
978 | /* Sometimes, when composing stats replies, it's difficult to predict how long | |
979 | * an individual reply chunk will be before actually encoding it into the reply | |
980 | * buffer. This function allows easy handling of this case: just encode the | |
981 | * reply, then use this function to break the message into two pieces if it | |
982 | * exceeds the OpenFlow message limit. | |
983 | * | |
984 | * In detail, if the final stats message in 'replies' is too long for OpenFlow, | |
985 | * this function breaks it into two separate stats replies, the first one with | |
986 | * the first 'start_ofs' bytes, the second one containing the bytes from that | |
987 | * offset onward. */ | |
988 | void | |
ca6ba700 | 989 | ofpmp_postappend(struct ovs_list *replies, size_t start_ofs) |
982697a4 | 990 | { |
417e7e66 | 991 | struct ofpbuf *msg = ofpbuf_from_list(ovs_list_back(replies)); |
982697a4 | 992 | |
cb22974d | 993 | ovs_assert(start_ofs <= UINT16_MAX); |
6fd6ed71 PS |
994 | if (msg->size > UINT16_MAX) { |
995 | size_t len = msg->size - start_ofs; | |
982697a4 | 996 | memcpy(ofpmp_append(replies, len), |
6fd6ed71 PS |
997 | (const uint8_t *) msg->data + start_ofs, len); |
998 | msg->size = start_ofs; | |
982697a4 BP |
999 | } |
1000 | } | |
1001 | ||
e28ac5cf BP |
1002 | /* Returns the OpenFlow version of the replies being constructed in 'replies', |
1003 | * which should have been initialized by ofpmp_init(). */ | |
1004 | enum ofp_version | |
ca6ba700 | 1005 | ofpmp_version(struct ovs_list *replies) |
e28ac5cf | 1006 | { |
417e7e66 | 1007 | struct ofpbuf *msg = ofpbuf_from_list(ovs_list_back(replies)); |
6fd6ed71 | 1008 | const struct ofp_header *oh = msg->data; |
e28ac5cf BP |
1009 | |
1010 | return oh->version; | |
1011 | } | |
1012 | ||
1013 | /* Determines the OFPRAW_* type of the OpenFlow messages in 'replies', which | |
1014 | * should have been initialized by ofpmp_init(). */ | |
1015 | enum ofpraw | |
ca6ba700 | 1016 | ofpmp_decode_raw(struct ovs_list *replies) |
e28ac5cf | 1017 | { |
417e7e66 | 1018 | struct ofpbuf *msg = ofpbuf_from_list(ovs_list_back(replies)); |
e28ac5cf BP |
1019 | enum ofperr error; |
1020 | enum ofpraw raw; | |
1021 | ||
6fd6ed71 | 1022 | error = ofpraw_decode_partial(&raw, msg->data, msg->size); |
e28ac5cf BP |
1023 | ovs_assert(!error); |
1024 | return raw; | |
1025 | } | |
1026 | ||
982697a4 BP |
1027 | static ovs_be16 * |
1028 | ofpmp_flags__(const struct ofp_header *oh) | |
1029 | { | |
2e3fa633 SH |
1030 | switch ((enum ofp_version)oh->version) { |
1031 | case OFP10_VERSION: | |
1032 | return &((struct ofp10_stats_msg *) oh)->flags; | |
1033 | case OFP11_VERSION: | |
1034 | case OFP12_VERSION: | |
2e1ae200 | 1035 | case OFP13_VERSION: |
c37c0382 | 1036 | case OFP14_VERSION: |
42dccab5 | 1037 | case OFP15_VERSION: |
b79d45a1 | 1038 | case OFP16_VERSION: |
2e3fa633 SH |
1039 | return &((struct ofp11_stats_msg *) oh)->flags; |
1040 | default: | |
428b2edd | 1041 | OVS_NOT_REACHED(); |
2e3fa633 | 1042 | } |
982697a4 BP |
1043 | } |
1044 | ||
1045 | /* Returns the OFPSF_* flags found in the OpenFlow stats header of 'oh', which | |
1046 | * must be an OpenFlow stats request or reply. | |
1047 | * | |
1048 | * (OFPSF_REPLY_MORE is the only defined flag.) */ | |
1049 | uint16_t | |
1050 | ofpmp_flags(const struct ofp_header *oh) | |
1051 | { | |
1052 | return ntohs(*ofpmp_flags__(oh)); | |
1053 | } | |
1054 | ||
1055 | /* Returns true if the OFPSF_REPLY_MORE flag is set in the OpenFlow stats | |
1056 | * header of 'oh', which must be an OpenFlow stats request or reply, false if | |
1057 | * it is not set. */ | |
1058 | bool | |
1059 | ofpmp_more(const struct ofp_header *oh) | |
1060 | { | |
1061 | return (ofpmp_flags(oh) & OFPSF_REPLY_MORE) != 0; | |
1062 | } | |
1063 | \f | |
1064 | static void ofpmsgs_init(void); | |
1065 | ||
1066 | static const struct raw_info * | |
1067 | raw_info_get(enum ofpraw raw) | |
1068 | { | |
1069 | ofpmsgs_init(); | |
1070 | ||
cb22974d | 1071 | ovs_assert(raw < ARRAY_SIZE(raw_infos)); |
982697a4 BP |
1072 | return &raw_infos[raw]; |
1073 | } | |
1074 | ||
1075 | static struct raw_instance * | |
1076 | raw_instance_get(const struct raw_info *info, uint8_t version) | |
1077 | { | |
cb22974d | 1078 | ovs_assert(version >= info->min_version && version <= info->max_version); |
982697a4 BP |
1079 | return &info->instances[version - info->min_version]; |
1080 | } | |
1081 | ||
1082 | static enum ofperr | |
1083 | ofpraw_from_ofphdrs(enum ofpraw *raw, const struct ofphdrs *hdrs) | |
1084 | { | |
1085 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1); | |
1086 | ||
1087 | struct raw_instance *raw_hdrs; | |
1088 | uint32_t hash; | |
1089 | ||
1090 | ofpmsgs_init(); | |
1091 | ||
1092 | hash = ofphdrs_hash(hdrs); | |
1093 | HMAP_FOR_EACH_WITH_HASH (raw_hdrs, hmap_node, hash, &raw_instance_map) { | |
1094 | if (ofphdrs_equal(hdrs, &raw_hdrs->hdrs)) { | |
1095 | *raw = raw_hdrs->raw; | |
1096 | return 0; | |
1097 | } | |
1098 | } | |
1099 | ||
1100 | if (!VLOG_DROP_WARN(&rl)) { | |
1101 | struct ds s; | |
1102 | ||
1103 | ds_init(&s); | |
1104 | ds_put_format(&s, "version %"PRIu8", type %"PRIu8, | |
1105 | hdrs->version, hdrs->type); | |
1106 | if (ofphdrs_is_stat(hdrs)) { | |
1107 | ds_put_format(&s, ", stat %"PRIu16, hdrs->stat); | |
1108 | } | |
1109 | if (hdrs->vendor) { | |
1110 | ds_put_format(&s, ", vendor 0x%"PRIx32", subtype %"PRIu32, | |
1111 | hdrs->vendor, hdrs->subtype); | |
1112 | } | |
1113 | VLOG_WARN("unknown OpenFlow message (%s)", ds_cstr(&s)); | |
1114 | ds_destroy(&s); | |
1115 | } | |
1116 | ||
1117 | return (hdrs->vendor ? OFPERR_OFPBRC_BAD_SUBTYPE | |
1118 | : ofphdrs_is_stat(hdrs) ? OFPERR_OFPBRC_BAD_STAT | |
1119 | : OFPERR_OFPBRC_BAD_TYPE); | |
1120 | } | |
1121 | ||
1122 | static void | |
1123 | ofpmsgs_init(void) | |
1124 | { | |
06717cbd | 1125 | static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; |
982697a4 BP |
1126 | const struct raw_info *info; |
1127 | ||
06717cbd | 1128 | if (!ovsthread_once_start(&once)) { |
982697a4 BP |
1129 | return; |
1130 | } | |
1131 | ||
1132 | hmap_init(&raw_instance_map); | |
1133 | for (info = raw_infos; info < &raw_infos[ARRAY_SIZE(raw_infos)]; info++) | |
1134 | { | |
1135 | int n_instances = info->max_version - info->min_version + 1; | |
1136 | struct raw_instance *inst; | |
1137 | ||
1138 | for (inst = info->instances; | |
1139 | inst < &info->instances[n_instances]; | |
1140 | inst++) { | |
1141 | inst->hdrs_len = ofphdrs_len(&inst->hdrs); | |
1142 | hmap_insert(&raw_instance_map, &inst->hmap_node, | |
1143 | ofphdrs_hash(&inst->hdrs)); | |
1144 | } | |
1145 | } | |
06717cbd BP |
1146 | |
1147 | ovsthread_once_done(&once); | |
982697a4 | 1148 | } |