/usr/src/openvswitch-1.4.0/lib/netlink.c is in openvswitch-datapath-dkms 1.4.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 | /*
* Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <config.h>
#include "netlink.h"
#include <assert.h>
#include <errno.h>
#include <inttypes.h>
#include <sys/types.h>
#include <unistd.h>
#include "coverage.h"
#include "netlink-protocol.h"
#include "ofpbuf.h"
#include "timeval.h"
#include "unaligned.h"
#include "vlog.h"
VLOG_DEFINE_THIS_MODULE(netlink);
/* A single (bad) Netlink message can in theory dump out many, many log
* messages, so the burst size is set quite high here to avoid missing useful
* information. Also, at high logging levels we log *all* Netlink messages. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 600);
/* Returns the nlmsghdr at the head of 'msg'.
*
* 'msg' must be at least as large as a nlmsghdr. */
struct nlmsghdr *
nl_msg_nlmsghdr(const struct ofpbuf *msg)
{
return ofpbuf_at_assert(msg, 0, NLMSG_HDRLEN);
}
/* Returns the genlmsghdr just past 'msg''s nlmsghdr.
*
* Returns a null pointer if 'msg' is not large enough to contain an nlmsghdr
* and a genlmsghdr. */
struct genlmsghdr *
nl_msg_genlmsghdr(const struct ofpbuf *msg)
{
return ofpbuf_at(msg, NLMSG_HDRLEN, GENL_HDRLEN);
}
/* If 'buffer' is a NLMSG_ERROR message, stores 0 in '*errorp' if it is an ACK
* message, otherwise a positive errno value, and returns true. If 'buffer' is
* not an NLMSG_ERROR message, returns false.
*
* 'msg' must be at least as large as a nlmsghdr. */
bool
nl_msg_nlmsgerr(const struct ofpbuf *msg, int *errorp)
{
if (nl_msg_nlmsghdr(msg)->nlmsg_type == NLMSG_ERROR) {
struct nlmsgerr *err = ofpbuf_at(msg, NLMSG_HDRLEN, sizeof *err);
int code = EPROTO;
if (!err) {
VLOG_ERR_RL(&rl, "received invalid nlmsgerr (%zd bytes < %zd)",
msg->size, NLMSG_HDRLEN + sizeof *err);
} else if (err->error <= 0 && err->error > INT_MIN) {
code = -err->error;
}
if (errorp) {
*errorp = code;
}
return true;
} else {
return false;
}
}
/* Ensures that 'b' has room for at least 'size' bytes plus netlink padding at
* its tail end, reallocating and copying its data if necessary. */
void
nl_msg_reserve(struct ofpbuf *msg, size_t size)
{
ofpbuf_prealloc_tailroom(msg, NLMSG_ALIGN(size));
}
static uint32_t
get_nlmsg_seq(void)
{
/* Next nlmsghdr sequence number.
*
* This implementation uses sequence numbers that are unique process-wide,
* to avoid a hypothetical race: send request, close socket, open new
* socket that reuses the old socket's PID value, send request on new
* socket, receive reply from kernel to old socket but with same PID and
* sequence number. (This race could be avoided other ways, e.g. by
* preventing PIDs from being quickly reused). */
static uint32_t next_seq;
if (next_seq == 0) {
/* Pick initial sequence number. */
next_seq = getpid() ^ time_wall();
}
return next_seq++;
}
/* Puts a nlmsghdr at the beginning of 'msg', which must be initially empty.
* Uses the given 'type' and 'flags'. 'expected_payload' should be
* an estimate of the number of payload bytes to be supplied; if the size of
* the payload is unknown a value of 0 is acceptable.
*
* 'type' is ordinarily an enumerated value specific to the Netlink protocol
* (e.g. RTM_NEWLINK, for NETLINK_ROUTE protocol). For Generic Netlink, 'type'
* is the family number obtained via nl_lookup_genl_family().
*
* 'flags' is a bit-mask that indicates what kind of request is being made. It
* is often NLM_F_REQUEST indicating that a request is being made, commonly
* or'd with NLM_F_ACK to request an acknowledgement.
*
* Sets the new nlmsghdr's nlmsg_pid field to 0 for now. nl_sock_send() will
* fill it in just before sending the message.
*
* nl_msg_put_genlmsghdr() is more convenient for composing a Generic Netlink
* message. */
void
nl_msg_put_nlmsghdr(struct ofpbuf *msg,
size_t expected_payload, uint32_t type, uint32_t flags)
{
struct nlmsghdr *nlmsghdr;
assert(msg->size == 0);
nl_msg_reserve(msg, NLMSG_HDRLEN + expected_payload);
nlmsghdr = nl_msg_put_uninit(msg, NLMSG_HDRLEN);
nlmsghdr->nlmsg_len = 0;
nlmsghdr->nlmsg_type = type;
nlmsghdr->nlmsg_flags = flags;
nlmsghdr->nlmsg_seq = get_nlmsg_seq();
nlmsghdr->nlmsg_pid = 0;
}
/* Puts a nlmsghdr and genlmsghdr at the beginning of 'msg', which must be
* initially empty. 'expected_payload' should be an estimate of the number of
* payload bytes to be supplied; if the size of the payload is unknown a value
* of 0 is acceptable.
*
* 'family' is the family number obtained via nl_lookup_genl_family().
*
* 'flags' is a bit-mask that indicates what kind of request is being made. It
* is often NLM_F_REQUEST indicating that a request is being made, commonly
* or'd with NLM_F_ACK to request an acknowledgement.
*
* 'cmd' is an enumerated value specific to the Generic Netlink family
* (e.g. CTRL_CMD_NEWFAMILY for the GENL_ID_CTRL family).
*
* 'version' is a version number specific to the family and command (often 1).
*
* Sets the new nlmsghdr's nlmsg_pid field to 0 for now. nl_sock_send() will
* fill it in just before sending the message.
*
* nl_msg_put_nlmsghdr() should be used to compose Netlink messages that are
* not Generic Netlink messages. */
void
nl_msg_put_genlmsghdr(struct ofpbuf *msg, size_t expected_payload,
int family, uint32_t flags, uint8_t cmd, uint8_t version)
{
struct genlmsghdr *genlmsghdr;
nl_msg_put_nlmsghdr(msg, GENL_HDRLEN + expected_payload, family, flags);
assert(msg->size == NLMSG_HDRLEN);
genlmsghdr = nl_msg_put_uninit(msg, GENL_HDRLEN);
genlmsghdr->cmd = cmd;
genlmsghdr->version = version;
genlmsghdr->reserved = 0;
}
/* Appends the 'size' bytes of data in 'p', plus Netlink padding if needed, to
* the tail end of 'msg'. Data in 'msg' is reallocated and copied if
* necessary. */
void
nl_msg_put(struct ofpbuf *msg, const void *data, size_t size)
{
memcpy(nl_msg_put_uninit(msg, size), data, size);
}
/* Appends 'size' bytes of data, plus Netlink padding if needed, to the tail
* end of 'msg', reallocating and copying its data if necessary. Returns a
* pointer to the first byte of the new data, which is left uninitialized. */
void *
nl_msg_put_uninit(struct ofpbuf *msg, size_t size)
{
size_t pad = NLMSG_ALIGN(size) - size;
char *p = ofpbuf_put_uninit(msg, size + pad);
if (pad) {
memset(p + size, 0, pad);
}
return p;
}
/* Prepends the 'size' bytes of data in 'p', plus Netlink padding if needed, to
* the head end of 'msg'. Data in 'msg' is reallocated and copied if
* necessary. */
void
nl_msg_push(struct ofpbuf *msg, const void *data, size_t size)
{
memcpy(nl_msg_push_uninit(msg, size), data, size);
}
/* Prepends 'size' bytes of data, plus Netlink padding if needed, to the head
* end of 'msg', reallocating and copying its data if necessary. Returns a
* pointer to the first byte of the new data, which is left uninitialized. */
void *
nl_msg_push_uninit(struct ofpbuf *msg, size_t size)
{
size_t pad = NLMSG_ALIGN(size) - size;
char *p = ofpbuf_push_uninit(msg, size + pad);
if (pad) {
memset(p + size, 0, pad);
}
return p;
}
/* Appends a Netlink attribute of the given 'type' and room for 'size' bytes of
* data as its payload, plus Netlink padding if needed, to the tail end of
* 'msg', reallocating and copying its data if necessary. Returns a pointer to
* the first byte of data in the attribute, which is left uninitialized. */
void *
nl_msg_put_unspec_uninit(struct ofpbuf *msg, uint16_t type, size_t size)
{
size_t total_size = NLA_HDRLEN + size;
struct nlattr* nla = nl_msg_put_uninit(msg, total_size);
assert(NLA_ALIGN(total_size) <= UINT16_MAX);
nla->nla_len = total_size;
nla->nla_type = type;
return nla + 1;
}
/* Appends a Netlink attribute of the given 'type' and the 'size' bytes of
* 'data' as its payload, to the tail end of 'msg', reallocating and copying
* its data if necessary. Returns a pointer to the first byte of data in the
* attribute, which is left uninitialized. */
void
nl_msg_put_unspec(struct ofpbuf *msg, uint16_t type,
const void *data, size_t size)
{
memcpy(nl_msg_put_unspec_uninit(msg, type, size), data, size);
}
/* Appends a Netlink attribute of the given 'type' and no payload to 'msg'.
* (Some Netlink protocols use the presence or absence of an attribute as a
* Boolean flag.) */
void
nl_msg_put_flag(struct ofpbuf *msg, uint16_t type)
{
nl_msg_put_unspec(msg, type, NULL, 0);
}
/* Appends a Netlink attribute of the given 'type' and the given 8-bit 'value'
* to 'msg'. */
void
nl_msg_put_u8(struct ofpbuf *msg, uint16_t type, uint8_t value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 16-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_put_u16(struct ofpbuf *msg, uint16_t type, uint16_t value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 32-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_put_u32(struct ofpbuf *msg, uint16_t type, uint32_t value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 64-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_put_u64(struct ofpbuf *msg, uint16_t type, uint64_t value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 16-bit network
* byte order 'value' to 'msg'. */
void
nl_msg_put_be16(struct ofpbuf *msg, uint16_t type, ovs_be16 value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 32-bit network
* byte order 'value' to 'msg'. */
void
nl_msg_put_be32(struct ofpbuf *msg, uint16_t type, ovs_be32 value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given 64-bit network
* byte order 'value' to 'msg'. */
void
nl_msg_put_be64(struct ofpbuf *msg, uint16_t type, ovs_be64 value)
{
nl_msg_put_unspec(msg, type, &value, sizeof value);
}
/* Appends a Netlink attribute of the given 'type' and the given
* null-terminated string 'value' to 'msg'. */
void
nl_msg_put_string(struct ofpbuf *msg, uint16_t type, const char *value)
{
nl_msg_put_unspec(msg, type, value, strlen(value) + 1);
}
/* Prepends a Netlink attribute of the given 'type' and room for 'size' bytes
* of data as its payload, plus Netlink padding if needed, to the head end of
* 'msg', reallocating and copying its data if necessary. Returns a pointer to
* the first byte of data in the attribute, which is left uninitialized. */
void *
nl_msg_push_unspec_uninit(struct ofpbuf *msg, uint16_t type, size_t size)
{
size_t total_size = NLA_HDRLEN + size;
struct nlattr* nla = nl_msg_push_uninit(msg, total_size);
assert(NLA_ALIGN(total_size) <= UINT16_MAX);
nla->nla_len = total_size;
nla->nla_type = type;
return nla + 1;
}
/* Prepends a Netlink attribute of the given 'type' and the 'size' bytes of
* 'data' as its payload, to the head end of 'msg', reallocating and copying
* its data if necessary. Returns a pointer to the first byte of data in the
* attribute, which is left uninitialized. */
void
nl_msg_push_unspec(struct ofpbuf *msg, uint16_t type,
const void *data, size_t size)
{
memcpy(nl_msg_push_unspec_uninit(msg, type, size), data, size);
}
/* Prepends a Netlink attribute of the given 'type' and no payload to 'msg'.
* (Some Netlink protocols use the presence or absence of an attribute as a
* Boolean flag.) */
void
nl_msg_push_flag(struct ofpbuf *msg, uint16_t type)
{
nl_msg_push_unspec(msg, type, NULL, 0);
}
/* Prepends a Netlink attribute of the given 'type' and the given 8-bit 'value'
* to 'msg'. */
void
nl_msg_push_u8(struct ofpbuf *msg, uint16_t type, uint8_t value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 16-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_push_u16(struct ofpbuf *msg, uint16_t type, uint16_t value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 32-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_push_u32(struct ofpbuf *msg, uint16_t type, uint32_t value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 64-bit host
* byte order 'value' to 'msg'. */
void
nl_msg_push_u64(struct ofpbuf *msg, uint16_t type, uint64_t value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 16-bit
* network byte order 'value' to 'msg'. */
void
nl_msg_push_be16(struct ofpbuf *msg, uint16_t type, ovs_be16 value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 32-bit
* network byte order 'value' to 'msg'. */
void
nl_msg_push_be32(struct ofpbuf *msg, uint16_t type, ovs_be32 value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given 64-bit
* network byte order 'value' to 'msg'. */
void
nl_msg_push_be64(struct ofpbuf *msg, uint16_t type, ovs_be64 value)
{
nl_msg_push_unspec(msg, type, &value, sizeof value);
}
/* Prepends a Netlink attribute of the given 'type' and the given
* null-terminated string 'value' to 'msg'. */
void
nl_msg_push_string(struct ofpbuf *msg, uint16_t type, const char *value)
{
nl_msg_push_unspec(msg, type, value, strlen(value) + 1);
}
/* Adds the header for nested Netlink attributes to 'msg', with the specified
* 'type', and returns the header's offset within 'msg'. The caller should add
* the content for the nested Netlink attribute to 'msg' (e.g. using the other
* nl_msg_*() functions), and then pass the returned offset to
* nl_msg_end_nested() to finish up the nested attributes. */
size_t
nl_msg_start_nested(struct ofpbuf *msg, uint16_t type)
{
size_t offset = msg->size;
nl_msg_put_unspec(msg, type, NULL, 0);
return offset;
}
/* Finalizes a nested Netlink attribute in 'msg'. 'offset' should be the value
* returned by nl_msg_start_nested(). */
void
nl_msg_end_nested(struct ofpbuf *msg, size_t offset)
{
struct nlattr *attr = ofpbuf_at_assert(msg, offset, sizeof *attr);
attr->nla_len = msg->size - offset;
}
/* Appends a nested Netlink attribute of the given 'type', with the 'size'
* bytes of content starting at 'data', to 'msg'. */
void
nl_msg_put_nested(struct ofpbuf *msg,
uint16_t type, const void *data, size_t size)
{
size_t offset = nl_msg_start_nested(msg, type);
nl_msg_put(msg, data, size);
nl_msg_end_nested(msg, offset);
}
/* If 'buffer' begins with a valid "struct nlmsghdr", pulls the header and its
* payload off 'buffer', stores header and payload in 'msg->data' and
* 'msg->size', and returns a pointer to the header.
*
* If 'buffer' does not begin with a "struct nlmsghdr" or begins with one that
* is invalid, returns NULL without modifying 'buffer'. */
struct nlmsghdr *
nl_msg_next(struct ofpbuf *buffer, struct ofpbuf *msg)
{
if (buffer->size >= sizeof(struct nlmsghdr)) {
struct nlmsghdr *nlmsghdr = nl_msg_nlmsghdr(buffer);
size_t len = nlmsghdr->nlmsg_len;
if (len >= sizeof *nlmsghdr && len <= buffer->size) {
ofpbuf_use_const(msg, nlmsghdr, len);
ofpbuf_pull(buffer, len);
return nlmsghdr;
}
}
msg->data = NULL;
msg->size = 0;
return NULL;
}
/* Attributes. */
/* Returns the bits of 'nla->nla_type' that are significant for determining its
* type. */
int
nl_attr_type(const struct nlattr *nla)
{
return nla->nla_type & NLA_TYPE_MASK;
}
/* Returns the first byte in the payload of attribute 'nla'. */
const void *
nl_attr_get(const struct nlattr *nla)
{
assert(nla->nla_len >= NLA_HDRLEN);
return nla + 1;
}
/* Returns the number of bytes in the payload of attribute 'nla'. */
size_t
nl_attr_get_size(const struct nlattr *nla)
{
assert(nla->nla_len >= NLA_HDRLEN);
return nla->nla_len - NLA_HDRLEN;
}
/* Asserts that 'nla''s payload is at least 'size' bytes long, and returns the
* first byte of the payload. */
const void *
nl_attr_get_unspec(const struct nlattr *nla, size_t size)
{
assert(nla->nla_len >= NLA_HDRLEN + size);
return nla + 1;
}
/* Returns true if 'nla' is nonnull. (Some Netlink protocols use the presence
* or absence of an attribute as a Boolean flag.) */
bool
nl_attr_get_flag(const struct nlattr *nla)
{
return nla != NULL;
}
#define NL_ATTR_GET_AS(NLA, TYPE) \
(*(TYPE*) nl_attr_get_unspec(nla, sizeof(TYPE)))
/* Returns the 8-bit value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 1 byte long. */
uint8_t
nl_attr_get_u8(const struct nlattr *nla)
{
return NL_ATTR_GET_AS(nla, uint8_t);
}
/* Returns the 16-bit host byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 2 bytes long. */
uint16_t
nl_attr_get_u16(const struct nlattr *nla)
{
return NL_ATTR_GET_AS(nla, uint16_t);
}
/* Returns the 32-bit host byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 4 bytes long. */
uint32_t
nl_attr_get_u32(const struct nlattr *nla)
{
return NL_ATTR_GET_AS(nla, uint32_t);
}
/* Returns the 64-bit host byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 8 bytes long. */
uint64_t
nl_attr_get_u64(const struct nlattr *nla)
{
const ovs_32aligned_u64 *x = nl_attr_get_unspec(nla, sizeof *x);
return get_32aligned_u64(x);
}
/* Returns the 16-bit network byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 2 bytes long. */
ovs_be16
nl_attr_get_be16(const struct nlattr *nla)
{
return NL_ATTR_GET_AS(nla, ovs_be16);
}
/* Returns the 32-bit network byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 4 bytes long. */
ovs_be32
nl_attr_get_be32(const struct nlattr *nla)
{
return NL_ATTR_GET_AS(nla, ovs_be32);
}
/* Returns the 64-bit network byte order value in 'nla''s payload.
*
* Asserts that 'nla''s payload is at least 8 bytes long. */
ovs_be64
nl_attr_get_be64(const struct nlattr *nla)
{
const ovs_32aligned_be64 *x = nl_attr_get_unspec(nla, sizeof *x);
return get_32aligned_be64(x);
}
/* Returns the null-terminated string value in 'nla''s payload.
*
* Asserts that 'nla''s payload contains a null-terminated string. */
const char *
nl_attr_get_string(const struct nlattr *nla)
{
assert(nla->nla_len > NLA_HDRLEN);
assert(memchr(nl_attr_get(nla), '\0', nla->nla_len - NLA_HDRLEN) != NULL);
return nl_attr_get(nla);
}
/* Initializes 'nested' to the payload of 'nla'. */
void
nl_attr_get_nested(const struct nlattr *nla, struct ofpbuf *nested)
{
ofpbuf_use_const(nested, nl_attr_get(nla), nl_attr_get_size(nla));
}
/* Default minimum and maximum payload sizes for each type of attribute. */
static const size_t attr_len_range[][2] = {
[0 ... N_NL_ATTR_TYPES - 1] = { 0, SIZE_MAX },
[NL_A_U8] = { 1, 1 },
[NL_A_U16] = { 2, 2 },
[NL_A_U32] = { 4, 4 },
[NL_A_U64] = { 8, 8 },
[NL_A_STRING] = { 1, SIZE_MAX },
[NL_A_FLAG] = { 0, SIZE_MAX },
[NL_A_NESTED] = { 0, SIZE_MAX },
};
bool
nl_attr_validate(const struct nlattr *nla, const struct nl_policy *policy)
{
uint16_t type = nl_attr_type(nla);
size_t min_len;
size_t max_len;
size_t len;
if (policy->type == NL_A_NO_ATTR) {
return true;
}
/* Figure out min and max length. */
min_len = policy->min_len;
if (!min_len) {
min_len = attr_len_range[policy->type][0];
}
max_len = policy->max_len;
if (!max_len) {
max_len = attr_len_range[policy->type][1];
}
/* Verify length. */
len = nl_attr_get_size(nla);
if (len < min_len || len > max_len) {
VLOG_DBG_RL(&rl, "attr %"PRIu16" length %zu not in "
"allowed range %zu...%zu", type, len, min_len, max_len);
return false;
}
/* Strings must be null terminated and must not have embedded nulls. */
if (policy->type == NL_A_STRING) {
if (((char *) nla)[nla->nla_len - 1]) {
VLOG_DBG_RL(&rl, "attr %"PRIu16" lacks null at end", type);
return false;
}
if (memchr(nla + 1, '\0', len - 1) != NULL) {
VLOG_DBG_RL(&rl, "attr %"PRIu16" has bad length", type);
return false;
}
}
return true;
}
/* Parses the 'msg' starting at the given 'nla_offset' as a sequence of Netlink
* attributes. 'policy[i]', for 0 <= i < n_attrs, specifies how the attribute
* with nla_type == i is parsed; a pointer to attribute i is stored in
* attrs[i]. Returns true if successful, false on failure.
*
* If the Netlink attributes in 'msg' follow a Netlink header and a Generic
* Netlink header, then 'nla_offset' should be NLMSG_HDRLEN + GENL_HDRLEN. */
bool
nl_policy_parse(const struct ofpbuf *msg, size_t nla_offset,
const struct nl_policy policy[],
struct nlattr *attrs[], size_t n_attrs)
{
struct nlattr *nla;
size_t left;
size_t i;
memset(attrs, 0, n_attrs * sizeof *attrs);
if (msg->size < nla_offset) {
VLOG_DBG_RL(&rl, "missing headers in nl_policy_parse");
return false;
}
NL_ATTR_FOR_EACH (nla, left,
(struct nlattr *) ((char *) msg->data + nla_offset),
msg->size - nla_offset)
{
uint16_t type = nl_attr_type(nla);
if (type < n_attrs && policy[type].type != NL_A_NO_ATTR) {
const struct nl_policy *e = &policy[type];
if (!nl_attr_validate(nla, e)) {
return false;
}
if (attrs[type]) {
VLOG_DBG_RL(&rl, "duplicate attr %"PRIu16, type);
}
attrs[type] = nla;
}
}
if (left) {
VLOG_DBG_RL(&rl, "attributes followed by garbage");
return false;
}
for (i = 0; i < n_attrs; i++) {
const struct nl_policy *e = &policy[i];
if (!e->optional && e->type != NL_A_NO_ATTR && !attrs[i]) {
VLOG_DBG_RL(&rl, "required attr %zu missing", i);
return false;
}
}
return true;
}
/* Parses the Netlink attributes within 'nla'. 'policy[i]', for 0 <= i <
* n_attrs, specifies how the attribute with nla_type == i is parsed; a pointer
* to attribute i is stored in attrs[i]. Returns true if successful, false on
* failure. */
bool
nl_parse_nested(const struct nlattr *nla, const struct nl_policy policy[],
struct nlattr *attrs[], size_t n_attrs)
{
struct ofpbuf buf;
nl_attr_get_nested(nla, &buf);
return nl_policy_parse(&buf, 0, policy, attrs, n_attrs);
}
const struct nlattr *
nl_attr_find__(const struct nlattr *attrs, size_t size, uint16_t type)
{
const struct nlattr *nla;
size_t left;
NL_ATTR_FOR_EACH (nla, left, attrs, size) {
if (nl_attr_type(nla) == type) {
return nla;
}
}
return NULL;
}
/* Returns the first Netlink attribute within 'buf' with the specified 'type',
* skipping a header of 'hdr_len' bytes at the beginning of 'buf'.
*
* This function does not validate the attribute's length. */
const struct nlattr *
nl_attr_find(const struct ofpbuf *buf, size_t hdr_len, uint16_t type)
{
const uint8_t *start = (const uint8_t *) buf->data + hdr_len;
return nl_attr_find__((const struct nlattr *) start, buf->size - hdr_len,
type);
}
/* Returns the first Netlink attribute within 'nla' with the specified
* 'type'.
*
* This function does not validate the attribute's length. */
const struct nlattr *
nl_attr_find_nested(const struct nlattr *nla, uint16_t type)
{
return nl_attr_find__(nl_attr_get(nla), nl_attr_get_size(nla), type);
}
|