]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/netlink.c
2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 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.
21 #include <sys/types.h>
25 #include "netlink-protocol.h"
26 #include "openvswitch/ofpbuf.h"
28 #include "unaligned.h"
29 #include "openvswitch/vlog.h"
31 VLOG_DEFINE_THIS_MODULE(netlink
);
33 /* A single (bad) Netlink message can in theory dump out many, many log
34 * messages, so the burst size is set quite high here to avoid missing useful
35 * information. Also, at high logging levels we log *all* Netlink messages. */
36 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(60, 600);
38 /* Returns the nlmsghdr at the head of 'msg'.
40 * 'msg' must be at least as large as a nlmsghdr. */
42 nl_msg_nlmsghdr(const struct ofpbuf
*msg
)
44 return ofpbuf_at_assert(msg
, 0, NLMSG_HDRLEN
);
47 /* Returns the genlmsghdr just past 'msg''s nlmsghdr.
49 * Returns a null pointer if 'msg' is not large enough to contain an nlmsghdr
50 * and a genlmsghdr. */
52 nl_msg_genlmsghdr(const struct ofpbuf
*msg
)
54 return ofpbuf_at(msg
, NLMSG_HDRLEN
, GENL_HDRLEN
);
57 /* If 'buffer' is a NLMSG_ERROR message, stores 0 in '*errorp' if it is an ACK
58 * message, otherwise a positive errno value, and returns true. If 'buffer' is
59 * not an NLMSG_ERROR message, returns false.
61 * 'msg' must be at least as large as a nlmsghdr. */
63 nl_msg_nlmsgerr(const struct ofpbuf
*msg
, int *errorp
)
65 if (nl_msg_nlmsghdr(msg
)->nlmsg_type
== NLMSG_ERROR
) {
66 struct nlmsgerr
*err
= ofpbuf_at(msg
, NLMSG_HDRLEN
, sizeof *err
);
69 VLOG_ERR_RL(&rl
, "received invalid nlmsgerr (%"PRIu32
" bytes < %"PRIuSIZE
")",
70 msg
->size
, NLMSG_HDRLEN
+ sizeof *err
);
71 } else if (err
->error
<= 0 && err
->error
> INT_MIN
) {
83 /* Ensures that 'b' has room for at least 'size' bytes plus netlink padding at
84 * its tail end, reallocating and copying its data if necessary. */
86 nl_msg_reserve(struct ofpbuf
*msg
, size_t size
)
88 ofpbuf_prealloc_tailroom(msg
, NLMSG_ALIGN(size
));
91 /* Puts a nlmsghdr at the beginning of 'msg', which must be initially empty.
92 * Uses the given 'type' and 'flags'. 'expected_payload' should be
93 * an estimate of the number of payload bytes to be supplied; if the size of
94 * the payload is unknown a value of 0 is acceptable.
96 * 'type' is ordinarily an enumerated value specific to the Netlink protocol
97 * (e.g. RTM_NEWLINK, for NETLINK_ROUTE protocol). For Generic Netlink, 'type'
98 * is the family number obtained via nl_lookup_genl_family().
100 * 'flags' is a bit-mask that indicates what kind of request is being made. It
101 * is often NLM_F_REQUEST indicating that a request is being made, commonly
102 * or'd with NLM_F_ACK to request an acknowledgement.
104 * Sets the new nlmsghdr's nlmsg_len, nlmsg_seq, and nlmsg_pid fields to 0 for
105 * now. Functions that send Netlink messages will fill these in just before
106 * sending the message.
108 * nl_msg_put_genlmsghdr() is more convenient for composing a Generic Netlink
111 nl_msg_put_nlmsghdr(struct ofpbuf
*msg
,
112 size_t expected_payload
, uint32_t type
, uint32_t flags
)
114 struct nlmsghdr
*nlmsghdr
;
116 ovs_assert(msg
->size
== 0);
118 nl_msg_reserve(msg
, NLMSG_HDRLEN
+ expected_payload
);
119 nlmsghdr
= nl_msg_put_uninit(msg
, NLMSG_HDRLEN
);
120 nlmsghdr
->nlmsg_len
= 0;
121 nlmsghdr
->nlmsg_type
= type
;
122 nlmsghdr
->nlmsg_flags
= flags
;
123 nlmsghdr
->nlmsg_seq
= 0;
124 nlmsghdr
->nlmsg_pid
= 0;
127 /* Puts a nlmsghdr and genlmsghdr at the beginning of 'msg', which must be
128 * initially empty. 'expected_payload' should be an estimate of the number of
129 * payload bytes to be supplied; if the size of the payload is unknown a value
130 * of 0 is acceptable.
132 * 'family' is the family number obtained via nl_lookup_genl_family().
134 * 'flags' is a bit-mask that indicates what kind of request is being made. It
135 * is often NLM_F_REQUEST indicating that a request is being made, commonly
136 * or'd with NLM_F_ACK to request an acknowledgement.
138 * 'cmd' is an enumerated value specific to the Generic Netlink family
139 * (e.g. CTRL_CMD_NEWFAMILY for the GENL_ID_CTRL family).
141 * 'version' is a version number specific to the family and command (often 1).
143 * Sets the new nlmsghdr's nlmsg_pid field to 0 for now. nl_sock_send() will
144 * fill it in just before sending the message.
146 * nl_msg_put_nlmsghdr() should be used to compose Netlink messages that are
147 * not Generic Netlink messages. */
149 nl_msg_put_genlmsghdr(struct ofpbuf
*msg
, size_t expected_payload
,
150 int family
, uint32_t flags
, uint8_t cmd
, uint8_t version
)
152 struct genlmsghdr
*genlmsghdr
;
154 nl_msg_put_nlmsghdr(msg
, GENL_HDRLEN
+ expected_payload
, family
, flags
);
155 ovs_assert(msg
->size
== NLMSG_HDRLEN
);
156 genlmsghdr
= nl_msg_put_uninit(msg
, GENL_HDRLEN
);
157 genlmsghdr
->cmd
= cmd
;
158 genlmsghdr
->version
= version
;
159 genlmsghdr
->reserved
= 0;
162 /* Appends the 'size' bytes of data in 'p', plus Netlink padding if needed, to
163 * the tail end of 'msg'. Data in 'msg' is reallocated and copied if
166 nl_msg_put(struct ofpbuf
*msg
, const void *data
, size_t size
)
168 memcpy(nl_msg_put_uninit(msg
, size
), data
, size
);
171 /* Appends 'size' bytes of data, plus Netlink padding if needed, to the tail
172 * end of 'msg', reallocating and copying its data if necessary. Returns a
173 * pointer to the first byte of the new data, which is left uninitialized. */
175 nl_msg_put_uninit(struct ofpbuf
*msg
, size_t size
)
177 size_t pad
= PAD_SIZE(size
, NLMSG_ALIGNTO
);
178 char *p
= ofpbuf_put_uninit(msg
, size
+ pad
);
180 memset(p
+ size
, 0, pad
);
185 /* Prepends the 'size' bytes of data in 'p', plus Netlink padding if needed, to
186 * the head end of 'msg'. Data in 'msg' is reallocated and copied if
189 nl_msg_push(struct ofpbuf
*msg
, const void *data
, size_t size
)
191 memcpy(nl_msg_push_uninit(msg
, size
), data
, size
);
194 /* Prepends 'size' bytes of data, plus Netlink padding if needed, to the head
195 * end of 'msg', reallocating and copying its data if necessary. Returns a
196 * pointer to the first byte of the new data, which is left uninitialized. */
198 nl_msg_push_uninit(struct ofpbuf
*msg
, size_t size
)
200 size_t pad
= PAD_SIZE(size
, NLMSG_ALIGNTO
);
201 char *p
= ofpbuf_push_uninit(msg
, size
+ pad
);
203 memset(p
+ size
, 0, pad
);
208 /* Appends a Netlink attribute of the given 'type' and room for 'size' bytes of
209 * data as its payload, plus Netlink padding if needed, to the tail end of
210 * 'msg', reallocating and copying its data if necessary. Returns a pointer to
211 * the first byte of data in the attribute, which is left uninitialized. */
213 nl_msg_put_unspec_uninit(struct ofpbuf
*msg
, uint16_t type
, size_t size
)
215 size_t total_size
= NLA_HDRLEN
+ size
;
216 struct nlattr
* nla
= nl_msg_put_uninit(msg
, total_size
);
217 ovs_assert(!nl_attr_oversized(size
));
218 nla
->nla_len
= total_size
;
219 nla
->nla_type
= type
;
223 /* Appends a Netlink attribute of the given 'type' and room for 'size' bytes of
224 * data as its payload, plus Netlink padding if needed, to the tail end of
225 * 'msg', reallocating and copying its data if necessary. Returns a pointer to
226 * the first byte of data in the attribute, which is zeroed. */
228 nl_msg_put_unspec_zero(struct ofpbuf
*msg
, uint16_t type
, size_t size
)
230 void *data
= nl_msg_put_unspec_uninit(msg
, type
, size
);
231 memset(data
, 0, size
);
235 /* Appends a Netlink attribute of the given 'type' and the 'size' bytes of
236 * 'data' as its payload, to the tail end of 'msg', reallocating and copying
237 * its data if necessary. Returns a pointer to the first byte of data in the
238 * attribute, which is left uninitialized. */
240 nl_msg_put_unspec(struct ofpbuf
*msg
, uint16_t type
,
241 const void *data
, size_t size
)
243 memcpy(nl_msg_put_unspec_uninit(msg
, type
, size
), data
, size
);
246 /* Appends a Netlink attribute of the given 'type' and no payload to 'msg'.
247 * (Some Netlink protocols use the presence or absence of an attribute as a
250 nl_msg_put_flag(struct ofpbuf
*msg
, uint16_t type
)
252 nl_msg_put_unspec(msg
, type
, NULL
, 0);
255 /* Appends a Netlink attribute of the given 'type' and the given 8-bit 'value'
258 nl_msg_put_u8(struct ofpbuf
*msg
, uint16_t type
, uint8_t value
)
260 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
263 /* Appends a Netlink attribute of the given 'type' and the given 16-bit host
264 * byte order 'value' to 'msg'. */
266 nl_msg_put_u16(struct ofpbuf
*msg
, uint16_t type
, uint16_t value
)
268 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
271 /* Appends a Netlink attribute of the given 'type' and the given 32-bit host
272 * byte order 'value' to 'msg'. */
274 nl_msg_put_u32(struct ofpbuf
*msg
, uint16_t type
, uint32_t value
)
276 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
279 /* Appends a Netlink attribute of the given 'type' and the given 64-bit host
280 * byte order 'value' to 'msg'. */
282 nl_msg_put_u64(struct ofpbuf
*msg
, uint16_t type
, uint64_t value
)
284 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
287 /* Appends a Netlink attribute of the given 'type' and the given 16-bit network
288 * byte order 'value' to 'msg'. */
290 nl_msg_put_be16(struct ofpbuf
*msg
, uint16_t type
, ovs_be16 value
)
292 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
295 /* Appends a Netlink attribute of the given 'type' and the given 32-bit network
296 * byte order 'value' to 'msg'. */
298 nl_msg_put_be32(struct ofpbuf
*msg
, uint16_t type
, ovs_be32 value
)
300 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
303 /* Appends a Netlink attribute of the given 'type' and the given 64-bit network
304 * byte order 'value' to 'msg'. */
306 nl_msg_put_be64(struct ofpbuf
*msg
, uint16_t type
, ovs_be64 value
)
308 nl_msg_put_unspec(msg
, type
, &value
, sizeof value
);
311 /* Appends a Netlink attribute of the given 'type' and the given IPv6
312 * address order 'value' to 'msg'. */
314 nl_msg_put_in6_addr(struct ofpbuf
*msg
, uint16_t type
,
315 const struct in6_addr
*value
)
317 nl_msg_put_unspec(msg
, type
, value
, sizeof *value
);
320 /* Appends a Netlink attribute of the given 'type' and the given odp_port_t
321 * 'value' to 'msg'. */
323 nl_msg_put_odp_port(struct ofpbuf
*msg
, uint16_t type
, odp_port_t value
)
325 nl_msg_put_u32(msg
, type
, odp_to_u32(value
));
328 /* Appends a Netlink attribute of the given 'type' with the 'len' characters
329 * of 'value', followed by the null byte to 'msg'. */
331 nl_msg_put_string__(struct ofpbuf
*msg
, uint16_t type
, const char *value
,
334 char *data
= nl_msg_put_unspec_uninit(msg
, type
, len
+ 1);
336 memcpy(data
, value
, len
);
340 /* Appends a Netlink attribute of the given 'type' and the given
341 * null-terminated string 'value' to 'msg'. */
343 nl_msg_put_string(struct ofpbuf
*msg
, uint16_t type
, const char *value
)
345 nl_msg_put_unspec(msg
, type
, value
, strlen(value
) + 1);
348 /* Prepends a Netlink attribute of the given 'type' and room for 'size' bytes
349 * of data as its payload, plus Netlink padding if needed, to the head end of
350 * 'msg', reallocating and copying its data if necessary. Returns a pointer to
351 * the first byte of data in the attribute, which is left uninitialized. */
353 nl_msg_push_unspec_uninit(struct ofpbuf
*msg
, uint16_t type
, size_t size
)
355 size_t total_size
= NLA_HDRLEN
+ size
;
356 struct nlattr
* nla
= nl_msg_push_uninit(msg
, total_size
);
357 ovs_assert(!nl_attr_oversized(size
));
358 nla
->nla_len
= total_size
;
359 nla
->nla_type
= type
;
363 /* Prepends a Netlink attribute of the given 'type' and the 'size' bytes of
364 * 'data' as its payload, to the head end of 'msg', reallocating and copying
365 * its data if necessary. Returns a pointer to the first byte of data in the
366 * attribute, which is left uninitialized. */
368 nl_msg_push_unspec(struct ofpbuf
*msg
, uint16_t type
,
369 const void *data
, size_t size
)
371 memcpy(nl_msg_push_unspec_uninit(msg
, type
, size
), data
, size
);
374 /* Prepends a Netlink attribute of the given 'type' and no payload to 'msg'.
375 * (Some Netlink protocols use the presence or absence of an attribute as a
378 nl_msg_push_flag(struct ofpbuf
*msg
, uint16_t type
)
380 nl_msg_push_unspec_uninit(msg
, type
, 0);
383 /* Prepends a Netlink attribute of the given 'type' and the given 8-bit 'value'
386 nl_msg_push_u8(struct ofpbuf
*msg
, uint16_t type
, uint8_t value
)
388 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
391 /* Prepends a Netlink attribute of the given 'type' and the given 16-bit host
392 * byte order 'value' to 'msg'. */
394 nl_msg_push_u16(struct ofpbuf
*msg
, uint16_t type
, uint16_t value
)
396 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
399 /* Prepends a Netlink attribute of the given 'type' and the given 32-bit host
400 * byte order 'value' to 'msg'. */
402 nl_msg_push_u32(struct ofpbuf
*msg
, uint16_t type
, uint32_t value
)
404 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
407 /* Prepends a Netlink attribute of the given 'type' and the given 64-bit host
408 * byte order 'value' to 'msg'. */
410 nl_msg_push_u64(struct ofpbuf
*msg
, uint16_t type
, uint64_t value
)
412 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
415 /* Prepends a Netlink attribute of the given 'type' and the given 16-bit
416 * network byte order 'value' to 'msg'. */
418 nl_msg_push_be16(struct ofpbuf
*msg
, uint16_t type
, ovs_be16 value
)
420 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
423 /* Prepends a Netlink attribute of the given 'type' and the given 32-bit
424 * network byte order 'value' to 'msg'. */
426 nl_msg_push_be32(struct ofpbuf
*msg
, uint16_t type
, ovs_be32 value
)
428 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
431 /* Prepends a Netlink attribute of the given 'type' and the given 64-bit
432 * network byte order 'value' to 'msg'. */
434 nl_msg_push_be64(struct ofpbuf
*msg
, uint16_t type
, ovs_be64 value
)
436 nl_msg_push_unspec(msg
, type
, &value
, sizeof value
);
439 /* Prepends a Netlink attribute of the given 'type' and the given
440 * null-terminated string 'value' to 'msg'. */
442 nl_msg_push_string(struct ofpbuf
*msg
, uint16_t type
, const char *value
)
444 nl_msg_push_unspec(msg
, type
, value
, strlen(value
) + 1);
447 /* Adds the header for nested Netlink attributes to 'msg', with the specified
448 * 'type', and returns the header's offset within 'msg'. The caller should add
449 * the content for the nested Netlink attribute to 'msg' (e.g. using the other
450 * nl_msg_*() functions), and then pass the returned offset to
451 * nl_msg_end_nested() to finish up the nested attributes. */
453 nl_msg_start_nested(struct ofpbuf
*msg
, uint16_t type
)
455 size_t offset
= msg
->size
;
456 nl_msg_put_unspec(msg
, type
, NULL
, 0);
460 /* Finalizes a nested Netlink attribute in 'msg'. 'offset' should be the value
461 * returned by nl_msg_start_nested(). */
463 nl_msg_end_nested(struct ofpbuf
*msg
, size_t offset
)
465 struct nlattr
*attr
= ofpbuf_at_assert(msg
, offset
, sizeof *attr
);
466 attr
->nla_len
= msg
->size
- offset
;
469 /* Appends a nested Netlink attribute of the given 'type', with the 'size'
470 * bytes of content starting at 'data', to 'msg'. */
472 nl_msg_put_nested(struct ofpbuf
*msg
,
473 uint16_t type
, const void *data
, size_t size
)
475 size_t offset
= nl_msg_start_nested(msg
, type
);
476 nl_msg_put(msg
, data
, size
);
477 nl_msg_end_nested(msg
, offset
);
480 /* If 'buffer' begins with a valid "struct nlmsghdr", pulls the header and its
481 * payload off 'buffer', stores header and payload in 'msg->data' and
482 * 'msg->size', and returns a pointer to the header.
484 * If 'buffer' does not begin with a "struct nlmsghdr" or begins with one that
485 * is invalid, returns NULL and clears 'buffer' and 'msg'. */
487 nl_msg_next(struct ofpbuf
*buffer
, struct ofpbuf
*msg
)
489 if (buffer
->size
>= sizeof(struct nlmsghdr
)) {
490 struct nlmsghdr
*nlmsghdr
= nl_msg_nlmsghdr(buffer
);
491 size_t len
= nlmsghdr
->nlmsg_len
;
492 if (len
>= sizeof *nlmsghdr
&& len
<= buffer
->size
) {
493 ofpbuf_use_const(msg
, nlmsghdr
, len
);
494 ofpbuf_pull(buffer
, len
);
499 ofpbuf_clear(buffer
);
505 /* Returns true if a Netlink attribute with a payload that is 'payload_size'
506 * bytes long would be oversized, that is, if it's not possible to create an
507 * nlattr of that size because its size wouldn't fit in the 16-bit nla_len
510 nl_attr_oversized(size_t payload_size
)
512 return payload_size
> UINT16_MAX
- NLA_HDRLEN
;
517 /* Returns the bits of 'nla->nla_type' that are significant for determining its
520 nl_attr_type(const struct nlattr
*nla
)
522 return nla
->nla_type
& NLA_TYPE_MASK
;
525 /* Returns the first byte in the payload of attribute 'nla'. */
527 nl_attr_get(const struct nlattr
*nla
)
529 ovs_assert(nla
->nla_len
>= NLA_HDRLEN
);
533 /* Returns the number of bytes in the payload of attribute 'nla'. */
535 nl_attr_get_size(const struct nlattr
*nla
)
537 ovs_assert(nla
->nla_len
>= NLA_HDRLEN
);
538 return nla
->nla_len
- NLA_HDRLEN
;
541 /* Asserts that 'nla''s payload is at least 'size' bytes long, and returns the
542 * first byte of the payload. */
544 nl_attr_get_unspec(const struct nlattr
*nla
, size_t size
)
546 ovs_assert(nla
->nla_len
>= NLA_HDRLEN
+ size
);
550 /* Returns true if 'nla' is nonnull. (Some Netlink protocols use the presence
551 * or absence of an attribute as a Boolean flag.) */
553 nl_attr_get_flag(const struct nlattr
*nla
)
558 #define NL_ATTR_GET_AS(NLA, TYPE) \
559 (*(TYPE*) nl_attr_get_unspec(nla, sizeof(TYPE)))
561 /* Returns the 8-bit value in 'nla''s payload.
563 * Asserts that 'nla''s payload is at least 1 byte long. */
565 nl_attr_get_u8(const struct nlattr
*nla
)
567 return NL_ATTR_GET_AS(nla
, uint8_t);
570 /* Returns the 16-bit host byte order value in 'nla''s payload.
572 * Asserts that 'nla''s payload is at least 2 bytes long. */
574 nl_attr_get_u16(const struct nlattr
*nla
)
576 return NL_ATTR_GET_AS(nla
, uint16_t);
579 /* Returns the 32-bit host byte order value in 'nla''s payload.
581 * Asserts that 'nla''s payload is at least 4 bytes long. */
583 nl_attr_get_u32(const struct nlattr
*nla
)
585 return NL_ATTR_GET_AS(nla
, uint32_t);
588 /* Returns the 64-bit host byte order value in 'nla''s payload.
590 * Asserts that 'nla''s payload is at least 8 bytes long. */
592 nl_attr_get_u64(const struct nlattr
*nla
)
594 const ovs_32aligned_u64
*x
= nl_attr_get_unspec(nla
, sizeof *x
);
595 return get_32aligned_u64(x
);
598 /* Returns the 16-bit network byte order value in 'nla''s payload.
600 * Asserts that 'nla''s payload is at least 2 bytes long. */
602 nl_attr_get_be16(const struct nlattr
*nla
)
604 return NL_ATTR_GET_AS(nla
, ovs_be16
);
607 /* Returns the 32-bit network byte order value in 'nla''s payload.
609 * Asserts that 'nla''s payload is at least 4 bytes long. */
611 nl_attr_get_be32(const struct nlattr
*nla
)
613 return NL_ATTR_GET_AS(nla
, ovs_be32
);
616 /* Returns the 64-bit network byte order value in 'nla''s payload.
618 * Asserts that 'nla''s payload is at least 8 bytes long. */
620 nl_attr_get_be64(const struct nlattr
*nla
)
622 const ovs_32aligned_be64
*x
= nl_attr_get_unspec(nla
, sizeof *x
);
623 return get_32aligned_be64(x
);
626 /* Returns the IPv6 address value in 'nla''s payload.
628 * Asserts that 'nla''s payload is at least 16 bytes long. */
630 nl_attr_get_in6_addr(const struct nlattr
*nla
)
632 return NL_ATTR_GET_AS(nla
, struct in6_addr
);
635 /* Returns the 32-bit odp_port_t value in 'nla''s payload.
637 * Asserts that 'nla''s payload is at least 4 bytes long. */
639 nl_attr_get_odp_port(const struct nlattr
*nla
)
641 return u32_to_odp(nl_attr_get_u32(nla
));
644 /* Returns the null-terminated string value in 'nla''s payload.
646 * Asserts that 'nla''s payload contains a null-terminated string. */
648 nl_attr_get_string(const struct nlattr
*nla
)
650 ovs_assert(nla
->nla_len
> NLA_HDRLEN
);
651 ovs_assert(memchr(nl_attr_get(nla
), '\0', nla
->nla_len
- NLA_HDRLEN
));
652 return nl_attr_get(nla
);
655 /* Initializes 'nested' to the payload of 'nla'. */
657 nl_attr_get_nested(const struct nlattr
*nla
, struct ofpbuf
*nested
)
659 ofpbuf_use_const(nested
, nl_attr_get(nla
), nl_attr_get_size(nla
));
662 /* Default minimum payload size for each type of attribute. */
664 min_attr_len(enum nl_attr_type type
)
667 case NL_A_NO_ATTR
: return 0;
668 case NL_A_UNSPEC
: return 0;
669 case NL_A_U8
: return 1;
670 case NL_A_U16
: return 2;
671 case NL_A_U32
: return 4;
672 case NL_A_U64
: return 8;
673 case NL_A_STRING
: return 1;
674 case NL_A_FLAG
: return 0;
675 case NL_A_IPV6
: return 16;
676 case NL_A_NESTED
: return 0;
677 case N_NL_ATTR_TYPES
: default: OVS_NOT_REACHED();
681 /* Default maximum payload size for each type of attribute. */
683 max_attr_len(enum nl_attr_type type
)
686 case NL_A_NO_ATTR
: return SIZE_MAX
;
687 case NL_A_UNSPEC
: return SIZE_MAX
;
688 case NL_A_U8
: return 1;
689 case NL_A_U16
: return 2;
690 case NL_A_U32
: return 4;
691 case NL_A_U64
: return 8;
692 case NL_A_STRING
: return SIZE_MAX
;
693 case NL_A_FLAG
: return SIZE_MAX
;
694 case NL_A_IPV6
: return 16;
695 case NL_A_NESTED
: return SIZE_MAX
;
696 case N_NL_ATTR_TYPES
: default: OVS_NOT_REACHED();
701 nl_attr_validate(const struct nlattr
*nla
, const struct nl_policy
*policy
)
703 uint16_t type
= nl_attr_type(nla
);
708 if (policy
->type
== NL_A_NO_ATTR
) {
712 /* Figure out min and max length. */
713 min_len
= policy
->min_len
;
715 min_len
= min_attr_len(policy
->type
);
717 max_len
= policy
->max_len
;
719 max_len
= max_attr_len(policy
->type
);
723 len
= nl_attr_get_size(nla
);
724 if (len
< min_len
|| len
> max_len
) {
725 VLOG_DBG_RL(&rl
, "attr %"PRIu16
" length %"PRIuSIZE
" not in "
726 "allowed range %"PRIuSIZE
"...%"PRIuSIZE
, type
, len
, min_len
, max_len
);
730 /* Strings must be null terminated and must not have embedded nulls. */
731 if (policy
->type
== NL_A_STRING
) {
732 if (((char *) nla
)[nla
->nla_len
- 1]) {
733 VLOG_DBG_RL(&rl
, "attr %"PRIu16
" lacks null at end", type
);
736 if (memchr(nla
+ 1, '\0', len
- 1) != NULL
) {
737 VLOG_DBG_RL(&rl
, "attr %"PRIu16
" has bad length", type
);
745 /* Parses the 'msg' starting at the given 'nla_offset' as a sequence of Netlink
746 * attributes. 'policy[i]', for 0 <= i < n_attrs, specifies how the attribute
747 * with nla_type == i is parsed; a pointer to attribute i is stored in
748 * attrs[i]. Returns true if successful, false on failure.
750 * If the Netlink attributes in 'msg' follow a Netlink header and a Generic
751 * Netlink header, then 'nla_offset' should be NLMSG_HDRLEN + GENL_HDRLEN. */
753 nl_policy_parse(const struct ofpbuf
*msg
, size_t nla_offset
,
754 const struct nl_policy policy
[],
755 struct nlattr
*attrs
[], size_t n_attrs
)
761 memset(attrs
, 0, n_attrs
* sizeof *attrs
);
763 if (msg
->size
< nla_offset
) {
764 VLOG_DBG_RL(&rl
, "missing headers in nl_policy_parse");
768 NL_ATTR_FOR_EACH (nla
, left
, ofpbuf_at(msg
, nla_offset
, 0),
769 msg
->size
- nla_offset
)
771 uint16_t type
= nl_attr_type(nla
);
772 if (type
< n_attrs
&& policy
[type
].type
!= NL_A_NO_ATTR
) {
773 const struct nl_policy
*e
= &policy
[type
];
774 if (!nl_attr_validate(nla
, e
)) {
778 VLOG_DBG_RL(&rl
, "duplicate attr %"PRIu16
, type
);
784 VLOG_DBG_RL(&rl
, "attributes followed by garbage");
788 for (i
= 0; i
< n_attrs
; i
++) {
789 const struct nl_policy
*e
= &policy
[i
];
790 if (!e
->optional
&& e
->type
!= NL_A_NO_ATTR
&& !attrs
[i
]) {
791 VLOG_DBG_RL(&rl
, "required attr %"PRIuSIZE
" missing", i
);
798 /* Parses the Netlink attributes within 'nla'. 'policy[i]', for 0 <= i <
799 * n_attrs, specifies how the attribute with nla_type == i is parsed; a pointer
800 * to attribute i is stored in attrs[i]. Returns true if successful, false on
803 nl_parse_nested(const struct nlattr
*nla
, const struct nl_policy policy
[],
804 struct nlattr
*attrs
[], size_t n_attrs
)
808 nl_attr_get_nested(nla
, &buf
);
809 return nl_policy_parse(&buf
, 0, policy
, attrs
, n_attrs
);
812 const struct nlattr
*
813 nl_attr_find__(const struct nlattr
*attrs
, size_t size
, uint16_t type
)
815 const struct nlattr
*nla
;
818 NL_ATTR_FOR_EACH (nla
, left
, attrs
, size
) {
819 if (nl_attr_type(nla
) == type
) {
826 /* Returns the first Netlink attribute within 'buf' with the specified 'type',
827 * skipping a header of 'hdr_len' bytes at the beginning of 'buf'.
829 * This function does not validate the attribute's length. */
830 const struct nlattr
*
831 nl_attr_find(const struct ofpbuf
*buf
, size_t hdr_len
, uint16_t type
)
833 return nl_attr_find__(ofpbuf_at(buf
, hdr_len
, 0), buf
->size
- hdr_len
,
837 /* Returns the first Netlink attribute within 'nla' with the specified
840 * This function does not validate the attribute's length. */
841 const struct nlattr
*
842 nl_attr_find_nested(const struct nlattr
*nla
, uint16_t type
)
844 return nl_attr_find__(nl_attr_get(nla
), nl_attr_get_size(nla
), type
);