2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "netlink-socket.h"
22 #include <sys/types.h>
26 #include "dynamic-string.h"
30 #include "netlink-protocol.h"
31 #include "odp-netlink.h"
33 #include "ovs-thread.h"
34 #include "poll-loop.h"
36 #include "socket-util.h"
40 VLOG_DEFINE_THIS_MODULE(netlink_socket);
42 COVERAGE_DEFINE(netlink_overflow);
43 COVERAGE_DEFINE(netlink_received);
44 COVERAGE_DEFINE(netlink_recv_jumbo);
45 COVERAGE_DEFINE(netlink_sent);
47 /* Linux header file confusion causes this to be undefined. */
49 #define SOL_NETLINK 270
53 static struct ovs_mutex portid_mutex = OVS_MUTEX_INITIALIZER;
54 static uint32_t g_last_portid = 0;
56 /* Port IDs must be unique! */
59 OVS_GUARDED_BY(portid_mutex)
66 /* A single (bad) Netlink message can in theory dump out many, many log
67 * messages, so the burst size is set quite high here to avoid missing useful
68 * information. Also, at high logging levels we log *all* Netlink messages. */
69 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 600);
71 static uint32_t nl_sock_allocate_seq(struct nl_sock *, unsigned int n);
72 static void log_nlmsg(const char *function, int error,
73 const void *message, size_t size, int protocol);
75 static int get_sock_pid_from_kernel(struct nl_sock *sock);
78 /* Netlink sockets. */
89 unsigned int rcvbuf; /* Receive buffer size (SO_RCVBUF). */
92 /* Compile-time limit on iovecs, so that we can allocate a maximum-size array
93 * of iovecs on the stack. */
96 /* Maximum number of iovecs that may be passed to sendmsg, capped at a
97 * minimum of _XOPEN_IOV_MAX (16) and a maximum of MAX_IOVS.
99 * Initialized by nl_sock_create(). */
102 static int nl_pool_alloc(int protocol, struct nl_sock **sockp);
103 static void nl_pool_release(struct nl_sock *);
105 /* Creates a new netlink socket for the given netlink 'protocol'
106 * (NETLINK_ROUTE, NETLINK_GENERIC, ...). Returns 0 and sets '*sockp' to the
107 * new socket if successful, otherwise returns a positive errno value. */
109 nl_sock_create(int protocol, struct nl_sock **sockp)
111 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
112 struct nl_sock *sock;
114 struct sockaddr_nl local, remote;
116 socklen_t local_size;
120 if (ovsthread_once_start(&once)) {
121 int save_errno = errno;
124 max_iovs = sysconf(_SC_UIO_MAXIOV);
125 if (max_iovs < _XOPEN_IOV_MAX) {
126 if (max_iovs == -1 && errno) {
127 VLOG_WARN("sysconf(_SC_UIO_MAXIOV): %s", ovs_strerror(errno));
129 max_iovs = _XOPEN_IOV_MAX;
130 } else if (max_iovs > MAX_IOVS) {
135 ovsthread_once_done(&once);
139 sock = xmalloc(sizeof *sock);
142 sock->handle = CreateFileA("\\\\.\\OpenVSwitchDevice",
143 GENERIC_READ | GENERIC_WRITE,
144 FILE_SHARE_READ | FILE_SHARE_WRITE,
146 FILE_ATTRIBUTE_NORMAL, NULL);
148 int last_error = GetLastError();
150 if (sock->handle == INVALID_HANDLE_VALUE) {
151 VLOG_ERR("fcntl: %s", ovs_strerror(last_error));
155 sock->fd = socket(AF_NETLINK, SOCK_RAW, protocol);
157 VLOG_ERR("fcntl: %s", ovs_strerror(errno));
162 sock->protocol = protocol;
165 rcvbuf = 1024 * 1024;
167 sock->rcvbuf = rcvbuf;
168 retval = get_sock_pid_from_kernel(sock);
173 if (setsockopt(sock->fd, SOL_SOCKET, SO_RCVBUFFORCE,
174 &rcvbuf, sizeof rcvbuf)) {
175 /* Only root can use SO_RCVBUFFORCE. Everyone else gets EPERM.
176 * Warn only if the failure is therefore unexpected. */
177 if (errno != EPERM) {
178 VLOG_WARN_RL(&rl, "setting %d-byte socket receive buffer failed "
179 "(%s)", rcvbuf, ovs_strerror(errno));
183 retval = get_socket_rcvbuf(sock->fd);
188 sock->rcvbuf = retval;
190 /* Connect to kernel (pid 0) as remote address. */
191 memset(&remote, 0, sizeof remote);
192 remote.nl_family = AF_NETLINK;
194 if (connect(sock->fd, (struct sockaddr *) &remote, sizeof remote) < 0) {
195 VLOG_ERR("connect(0): %s", ovs_strerror(errno));
199 /* Obtain pid assigned by kernel. */
200 local_size = sizeof local;
201 if (getsockname(sock->fd, (struct sockaddr *) &local, &local_size) < 0) {
202 VLOG_ERR("getsockname: %s", ovs_strerror(errno));
205 if (local_size < sizeof local || local.nl_family != AF_NETLINK) {
206 VLOG_ERR("getsockname returned bad Netlink name");
210 sock->pid = local.nl_pid;
224 if (sock->handle != INVALID_HANDLE_VALUE) {
225 CloseHandle(sock->handle);
236 /* Creates a new netlink socket for the same protocol as 'src'. Returns 0 and
237 * sets '*sockp' to the new socket if successful, otherwise returns a positive
240 nl_sock_clone(const struct nl_sock *src, struct nl_sock **sockp)
242 return nl_sock_create(src->protocol, sockp);
245 /* Destroys netlink socket 'sock'. */
247 nl_sock_destroy(struct nl_sock *sock)
251 CloseHandle(sock->handle);
260 /* Reads the pid for 'sock' generated in the kernel datapath. The function
261 * follows a transaction semantic. Eventually this function should call into
264 get_sock_pid_from_kernel(struct nl_sock *sock)
266 struct nl_transaction txn;
267 struct ofpbuf request;
268 uint64_t request_stub[128];
270 uint64_t reply_stub[128];
271 struct ovs_header *ovs_header;
272 struct nlmsghdr *nlmsg;
276 int ovs_msg_size = sizeof (struct nlmsghdr) + sizeof (struct genlmsghdr) +
277 sizeof (struct ovs_header);
279 ofpbuf_use_stub(&request, request_stub, sizeof request_stub);
280 txn.request = &request;
281 ofpbuf_use_stub(&reply, reply_stub, sizeof reply_stub);
284 seq = nl_sock_allocate_seq(sock, 1);
285 nl_msg_put_genlmsghdr(&request, 0, OVS_WIN_NL_CTRL_FAMILY_ID, 0,
286 OVS_CTRL_CMD_WIN_GET_PID, OVS_WIN_CONTROL_VERSION);
287 nlmsg = nl_msg_nlmsghdr(txn.request);
288 nlmsg->nlmsg_seq = seq;
290 ovs_header = ofpbuf_put_uninit(&request, sizeof *ovs_header);
291 ovs_header->dp_ifindex = 0;
292 ovs_header = ofpbuf_put_uninit(&reply, ovs_msg_size);
294 if (!DeviceIoControl(sock->handle, OVS_IOCTL_TRANSACT,
295 ofpbuf_data(txn.request), ofpbuf_size(txn.request),
296 ofpbuf_data(txn.reply), ofpbuf_size(txn.reply),
301 if (bytes < ovs_msg_size) {
306 nlmsg = nl_msg_nlmsghdr(txn.reply);
307 if (nlmsg->nlmsg_seq != seq) {
311 sock->pid = nlmsg->nlmsg_pid;
316 ofpbuf_uninit(&request);
317 ofpbuf_uninit(&reply);
322 /* Tries to add 'sock' as a listener for 'multicast_group'. Returns 0 if
323 * successful, otherwise a positive errno value.
325 * A socket that is subscribed to a multicast group that receives asynchronous
326 * notifications must not be used for Netlink transactions or dumps, because
327 * transactions and dumps can cause notifications to be lost.
329 * Multicast group numbers are always positive.
331 * It is not an error to attempt to join a multicast group to which a socket
332 * already belongs. */
334 nl_sock_join_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
337 #define OVS_VPORT_MCGROUP_FALLBACK_ID 33
338 struct ofpbuf msg_buf;
339 struct message_multicast
342 /* if true, join; if else, leave */
344 unsigned int groupId;
347 struct message_multicast msg = { 0 };
349 msg.nlmsg_len = sizeof(struct message_multicast);
350 msg.nlmsg_type = OVS_VPORT_MCGROUP_FALLBACK_ID;
353 msg.nlmsg_pid = sock->pid;
356 msg.groupId = multicast_group;
357 msg_buf.base_ = &msg;
358 msg_buf.data_ = &msg;
359 msg_buf.size_ = msg.nlmsg_len;
361 nl_sock_send__(sock, &msg_buf, msg.nlmsg_seq, 0);
363 if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_ADD_MEMBERSHIP,
364 &multicast_group, sizeof multicast_group) < 0) {
365 VLOG_WARN("could not join multicast group %u (%s)",
366 multicast_group, ovs_strerror(errno));
373 /* Tries to make 'sock' stop listening to 'multicast_group'. Returns 0 if
374 * successful, otherwise a positive errno value.
376 * Multicast group numbers are always positive.
378 * It is not an error to attempt to leave a multicast group to which a socket
381 * On success, reading from 'sock' will still return any messages that were
382 * received on 'multicast_group' before the group was left. */
384 nl_sock_leave_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
387 struct ofpbuf msg_buf;
388 struct message_multicast
391 /* if true, join; if else, leave*/
395 struct message_multicast msg = { 0 };
396 nl_msg_put_nlmsghdr(&msg, sizeof(struct message_multicast),
400 msg_buf.base_ = &msg;
401 msg_buf.data_ = &msg;
402 msg_buf.size_ = msg.nlmsg_len;
404 nl_sock_send__(sock, &msg_buf, msg.nlmsg_seq, 0);
406 if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_DROP_MEMBERSHIP,
407 &multicast_group, sizeof multicast_group) < 0) {
408 VLOG_WARN("could not leave multicast group %u (%s)",
409 multicast_group, ovs_strerror(errno));
417 nl_sock_send__(struct nl_sock *sock, const struct ofpbuf *msg,
418 uint32_t nlmsg_seq, bool wait)
420 struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(msg);
423 nlmsg->nlmsg_len = ofpbuf_size(msg);
424 nlmsg->nlmsg_seq = nlmsg_seq;
425 nlmsg->nlmsg_pid = sock->pid;
431 if (!DeviceIoControl(sock->handle, OVS_IOCTL_WRITE,
432 ofpbuf_data(msg), ofpbuf_size(msg), NULL, 0,
435 /* XXX: Map to a more appropriate error based on GetLastError(). */
438 retval = ofpbuf_size(msg);
441 retval = send(sock->fd, ofpbuf_data(msg), ofpbuf_size(msg),
442 wait ? 0 : MSG_DONTWAIT);
444 error = retval < 0 ? errno : 0;
445 } while (error == EINTR);
446 log_nlmsg(__func__, error, ofpbuf_data(msg), ofpbuf_size(msg), sock->protocol);
448 COVERAGE_INC(netlink_sent);
453 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
454 * 'sock'. nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
455 * will be set to 'sock''s pid, and nlmsg_seq will be initialized to a fresh
456 * sequence number, before the message is sent.
458 * Returns 0 if successful, otherwise a positive errno value. If
459 * 'wait' is true, then the send will wait until buffer space is ready;
460 * otherwise, returns EAGAIN if the 'sock' send buffer is full. */
462 nl_sock_send(struct nl_sock *sock, const struct ofpbuf *msg, bool wait)
464 return nl_sock_send_seq(sock, msg, nl_sock_allocate_seq(sock, 1), wait);
467 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
468 * 'sock'. nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
469 * will be set to 'sock''s pid, and nlmsg_seq will be initialized to
470 * 'nlmsg_seq', before the message is sent.
472 * Returns 0 if successful, otherwise a positive errno value. If
473 * 'wait' is true, then the send will wait until buffer space is ready;
474 * otherwise, returns EAGAIN if the 'sock' send buffer is full.
476 * This function is suitable for sending a reply to a request that was received
477 * with sequence number 'nlmsg_seq'. Otherwise, use nl_sock_send() instead. */
479 nl_sock_send_seq(struct nl_sock *sock, const struct ofpbuf *msg,
480 uint32_t nlmsg_seq, bool wait)
482 return nl_sock_send__(sock, msg, nlmsg_seq, wait);
486 nl_sock_recv__(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
488 /* We can't accurately predict the size of the data to be received. The
489 * caller is supposed to have allocated enough space in 'buf' to handle the
490 * "typical" case. To handle exceptions, we make available enough space in
491 * 'tail' to allow Netlink messages to be up to 64 kB long (a reasonable
492 * figure since that's the maximum length of a Netlink attribute). */
493 struct nlmsghdr *nlmsghdr;
500 ovs_assert(buf->allocated >= sizeof *nlmsghdr);
503 iov[0].iov_base = ofpbuf_base(buf);
504 iov[0].iov_len = buf->allocated;
505 iov[1].iov_base = tail;
506 iov[1].iov_len = sizeof tail;
508 memset(&msg, 0, sizeof msg);
512 /* Receive a Netlink message from the kernel.
514 * This works around a kernel bug in which the kernel returns an error code
515 * as if it were the number of bytes read. It doesn't actually modify
516 * anything in the receive buffer in that case, so we can initialize the
517 * Netlink header with an impossible message length and then, upon success,
518 * check whether it changed. */
519 nlmsghdr = ofpbuf_base(buf);
521 nlmsghdr->nlmsg_len = UINT32_MAX;
524 if (!DeviceIoControl(sock->handle, OVS_IOCTL_READ,
525 NULL, 0, tail, sizeof tail, &bytes, NULL)) {
534 if (retval >= buf->allocated) {
535 ofpbuf_reinit(buf, retval);
537 memcpy(ofpbuf_data(buf), tail, retval);
538 ofpbuf_set_size(buf, retval);
542 retval = recvmsg(sock->fd, &msg, wait ? 0 : MSG_DONTWAIT);
544 error = (retval < 0 ? errno
545 : retval == 0 ? ECONNRESET /* not possible? */
546 : nlmsghdr->nlmsg_len != UINT32_MAX ? 0
548 } while (error == EINTR);
550 if (error == ENOBUFS) {
551 /* Socket receive buffer overflow dropped one or more messages that
552 * the kernel tried to send to us. */
553 COVERAGE_INC(netlink_overflow);
558 if (msg.msg_flags & MSG_TRUNC) {
559 VLOG_ERR_RL(&rl, "truncated message (longer than %"PRIuSIZE" bytes)",
564 if (retval < sizeof *nlmsghdr
565 || nlmsghdr->nlmsg_len < sizeof *nlmsghdr
566 || nlmsghdr->nlmsg_len > retval) {
567 VLOG_ERR_RL(&rl, "received invalid nlmsg (%"PRIuSIZE" bytes < %"PRIuSIZE")",
568 retval, sizeof *nlmsghdr);
572 ofpbuf_set_size(buf, MIN(retval, buf->allocated));
573 if (retval > buf->allocated) {
574 COVERAGE_INC(netlink_recv_jumbo);
575 ofpbuf_put(buf, tail, retval - buf->allocated);
579 log_nlmsg(__func__, 0, ofpbuf_data(buf), ofpbuf_size(buf), sock->protocol);
580 COVERAGE_INC(netlink_received);
585 /* Tries to receive a Netlink message from the kernel on 'sock' into 'buf'. If
586 * 'wait' is true, waits for a message to be ready. Otherwise, fails with
587 * EAGAIN if the 'sock' receive buffer is empty.
589 * The caller must have initialized 'buf' with an allocation of at least
590 * NLMSG_HDRLEN bytes. For best performance, the caller should allocate enough
591 * space for a "typical" message.
593 * On success, returns 0 and replaces 'buf''s previous content by the received
594 * message. This function expands 'buf''s allocated memory, as necessary, to
595 * hold the actual size of the received message.
597 * On failure, returns a positive errno value and clears 'buf' to zero length.
598 * 'buf' retains its previous memory allocation.
600 * Regardless of success or failure, this function resets 'buf''s headroom to
603 nl_sock_recv(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
605 return nl_sock_recv__(sock, buf, wait);
609 nl_sock_record_errors__(struct nl_transaction **transactions, size_t n,
614 for (i = 0; i < n; i++) {
615 struct nl_transaction *txn = transactions[i];
619 ofpbuf_clear(txn->reply);
625 nl_sock_transact_multiple__(struct nl_sock *sock,
626 struct nl_transaction **transactions, size_t n,
629 uint64_t tmp_reply_stub[1024 / 8];
630 struct nl_transaction tmp_txn;
631 struct ofpbuf tmp_reply;
634 struct iovec iovs[MAX_IOVS];
639 base_seq = nl_sock_allocate_seq(sock, n);
641 for (i = 0; i < n; i++) {
642 struct nl_transaction *txn = transactions[i];
643 struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(txn->request);
645 nlmsg->nlmsg_len = ofpbuf_size(txn->request);
646 nlmsg->nlmsg_seq = base_seq + i;
647 nlmsg->nlmsg_pid = sock->pid;
649 iovs[i].iov_base = ofpbuf_data(txn->request);
650 iovs[i].iov_len = ofpbuf_size(txn->request);
653 memset(&msg, 0, sizeof msg);
658 DWORD last_error = 0;
660 for (i = 0; i < n; i++) {
661 result = WriteFile((HANDLE)sock->handle, iovs[i].iov_base, iovs[i].iov_len,
663 last_error = GetLastError();
664 if (last_error != ERROR_SUCCESS && !result) {
672 error = sendmsg(sock->fd, &msg, 0) < 0 ? errno : 0;
674 } while (error == EINTR);
676 for (i = 0; i < n; i++) {
677 struct nl_transaction *txn = transactions[i];
679 log_nlmsg(__func__, error, ofpbuf_data(txn->request), ofpbuf_size(txn->request),
683 COVERAGE_ADD(netlink_sent, n);
690 ofpbuf_use_stub(&tmp_reply, tmp_reply_stub, sizeof tmp_reply_stub);
691 tmp_txn.request = NULL;
692 tmp_txn.reply = &tmp_reply;
695 struct nl_transaction *buf_txn, *txn;
698 /* Find a transaction whose buffer we can use for receiving a reply.
699 * If no such transaction is left, use tmp_txn. */
701 for (i = 0; i < n; i++) {
702 if (transactions[i]->reply) {
703 buf_txn = transactions[i];
708 /* Receive a reply. */
709 error = nl_sock_recv__(sock, buf_txn->reply, false);
711 if (error == EAGAIN) {
712 nl_sock_record_errors__(transactions, n, 0);
719 /* Match the reply up with a transaction. */
720 seq = nl_msg_nlmsghdr(buf_txn->reply)->nlmsg_seq;
721 if (seq < base_seq || seq >= base_seq + n) {
722 VLOG_DBG_RL(&rl, "ignoring unexpected seq %#"PRIx32, seq);
726 txn = transactions[i];
728 /* Fill in the results for 'txn'. */
729 if (nl_msg_nlmsgerr(buf_txn->reply, &txn->error)) {
731 ofpbuf_clear(txn->reply);
734 VLOG_DBG_RL(&rl, "received NAK error=%d (%s)",
735 error, ovs_strerror(txn->error));
739 if (txn->reply && txn != buf_txn) {
741 struct ofpbuf *reply = buf_txn->reply;
742 buf_txn->reply = txn->reply;
747 /* Fill in the results for transactions before 'txn'. (We have to do
748 * this after the results for 'txn' itself because of the buffer swap
750 nl_sock_record_errors__(transactions, i, 0);
754 transactions += i + 1;
758 ofpbuf_uninit(&tmp_reply);
764 nl_sock_transact_multiple(struct nl_sock *sock,
765 struct nl_transaction **transactions, size_t n)
774 /* In theory, every request could have a 64 kB reply. But the default and
775 * maximum socket rcvbuf size with typical Dom0 memory sizes both tend to
776 * be a bit below 128 kB, so that would only allow a single message in a
777 * "batch". So we assume that replies average (at most) 4 kB, which allows
778 * a good deal of batching.
780 * In practice, most of the requests that we batch either have no reply at
781 * all or a brief reply. */
782 max_batch_count = MAX(sock->rcvbuf / 4096, 1);
783 max_batch_count = MIN(max_batch_count, max_iovs);
789 /* Batch up to 'max_batch_count' transactions. But cap it at about a
790 * page of requests total because big skbuffs are expensive to
791 * allocate in the kernel. */
792 #if defined(PAGESIZE)
793 enum { MAX_BATCH_BYTES = MAX(1, PAGESIZE - 512) };
795 enum { MAX_BATCH_BYTES = 4096 - 512 };
797 bytes = ofpbuf_size(transactions[0]->request);
798 for (count = 1; count < n && count < max_batch_count; count++) {
799 if (bytes + ofpbuf_size(transactions[count]->request) > MAX_BATCH_BYTES) {
802 bytes += ofpbuf_size(transactions[count]->request);
805 error = nl_sock_transact_multiple__(sock, transactions, count, &done);
806 transactions += done;
809 if (error == ENOBUFS) {
810 VLOG_DBG_RL(&rl, "receive buffer overflow, resending request");
812 VLOG_ERR_RL(&rl, "transaction error (%s)", ovs_strerror(error));
813 nl_sock_record_errors__(transactions, n, error);
819 nl_sock_transact(struct nl_sock *sock, const struct ofpbuf *request,
820 struct ofpbuf **replyp)
822 struct nl_transaction *transactionp;
823 struct nl_transaction transaction;
825 transaction.request = CONST_CAST(struct ofpbuf *, request);
826 transaction.reply = replyp ? ofpbuf_new(1024) : NULL;
827 transactionp = &transaction;
829 nl_sock_transact_multiple(sock, &transactionp, 1);
832 if (transaction.error) {
833 ofpbuf_delete(transaction.reply);
836 *replyp = transaction.reply;
840 return transaction.error;
843 /* Drain all the messages currently in 'sock''s receive queue. */
845 nl_sock_drain(struct nl_sock *sock)
850 return drain_rcvbuf(sock->fd);
854 /* Starts a Netlink "dump" operation, by sending 'request' to the kernel on a
855 * Netlink socket created with the given 'protocol', and initializes 'dump' to
856 * reflect the state of the operation.
858 * 'request' must contain a Netlink message. Before sending the message,
859 * nlmsg_len will be finalized to match request->size, and nlmsg_pid will be
860 * set to the Netlink socket's pid. NLM_F_DUMP and NLM_F_ACK will be set in
863 * The design of this Netlink socket library ensures that the dump is reliable.
865 * This function provides no status indication. nl_dump_done() provides an
866 * error status for the entire dump operation.
868 * The caller must eventually destroy 'request'.
871 nl_dump_start(struct nl_dump *dump, int protocol, const struct ofpbuf *request)
873 nl_msg_nlmsghdr(request)->nlmsg_flags |= NLM_F_DUMP | NLM_F_ACK;
875 ovs_mutex_init(&dump->mutex);
876 ovs_mutex_lock(&dump->mutex);
877 dump->status = nl_pool_alloc(protocol, &dump->sock);
879 dump->status = nl_sock_send__(dump->sock, request,
880 nl_sock_allocate_seq(dump->sock, 1),
883 dump->nl_seq = nl_msg_nlmsghdr(request)->nlmsg_seq;
884 ovs_mutex_unlock(&dump->mutex);
888 nl_dump_refill(struct nl_dump *dump, struct ofpbuf *buffer)
889 OVS_REQUIRES(dump->mutex)
891 struct nlmsghdr *nlmsghdr;
894 while (!ofpbuf_size(buffer)) {
895 error = nl_sock_recv__(dump->sock, buffer, false);
897 /* The kernel never blocks providing the results of a dump, so
898 * error == EAGAIN means that we've read the whole thing, and
899 * therefore transform it into EOF. (The kernel always provides
900 * NLMSG_DONE as a sentinel. Some other thread must have received
901 * that already but not yet signaled it in 'status'.)
903 * Any other error is just an error. */
904 return error == EAGAIN ? EOF : error;
907 nlmsghdr = nl_msg_nlmsghdr(buffer);
908 if (dump->nl_seq != nlmsghdr->nlmsg_seq) {
909 VLOG_DBG_RL(&rl, "ignoring seq %#"PRIx32" != expected %#"PRIx32,
910 nlmsghdr->nlmsg_seq, dump->nl_seq);
911 ofpbuf_clear(buffer);
915 if (nl_msg_nlmsgerr(buffer, &error) && error) {
916 VLOG_INFO_RL(&rl, "netlink dump request error (%s)",
917 ovs_strerror(error));
918 ofpbuf_clear(buffer);
926 nl_dump_next__(struct ofpbuf *reply, struct ofpbuf *buffer)
928 struct nlmsghdr *nlmsghdr = nl_msg_next(buffer, reply);
930 VLOG_WARN_RL(&rl, "netlink dump contains message fragment");
932 } else if (nlmsghdr->nlmsg_type == NLMSG_DONE) {
939 /* Attempts to retrieve another reply from 'dump' into 'buffer'. 'dump' must
940 * have been initialized with nl_dump_start(), and 'buffer' must have been
941 * initialized. 'buffer' should be at least NL_DUMP_BUFSIZE bytes long.
943 * If successful, returns true and points 'reply->data' and
944 * 'ofpbuf_size(reply)' to the message that was retrieved. The caller must not
945 * modify 'reply' (because it points within 'buffer', which will be used by
946 * future calls to this function).
948 * On failure, returns false and sets 'reply->data' to NULL and
949 * 'ofpbuf_size(reply)' to 0. Failure might indicate an actual error or merely
950 * the end of replies. An error status for the entire dump operation is
951 * provided when it is completed by calling nl_dump_done().
953 * Multiple threads may call this function, passing the same nl_dump, however
954 * each must provide independent buffers. This function may cache multiple
955 * replies in the buffer, and these will be processed before more replies are
956 * fetched. When this function returns false, other threads may continue to
957 * process replies in their buffers, but they will not fetch more replies.
960 nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply, struct ofpbuf *buffer)
964 /* If the buffer is empty, refill it.
966 * If the buffer is not empty, we don't check the dump's status.
967 * Otherwise, we could end up skipping some of the dump results if thread A
968 * hits EOF while thread B is in the midst of processing a batch. */
969 if (!ofpbuf_size(buffer)) {
970 ovs_mutex_lock(&dump->mutex);
972 /* Take the mutex here to avoid an in-kernel race. If two threads
973 * try to read from a Netlink dump socket at once, then the socket
974 * error can be set to EINVAL, which will be encountered on the
975 * next recv on that socket, which could be anywhere due to the way
976 * that we pool Netlink sockets. Serializing the recv calls avoids
978 dump->status = nl_dump_refill(dump, buffer);
980 retval = dump->status;
981 ovs_mutex_unlock(&dump->mutex);
984 /* Fetch the next message from the buffer. */
986 retval = nl_dump_next__(reply, buffer);
988 /* Record 'retval' as the dump status, but don't overwrite an error
990 ovs_mutex_lock(&dump->mutex);
991 if (dump->status <= 0) {
992 dump->status = retval;
994 ovs_mutex_unlock(&dump->mutex);
999 ofpbuf_set_data(reply, NULL);
1000 ofpbuf_set_size(reply, 0);
1005 /* Completes Netlink dump operation 'dump', which must have been initialized
1006 * with nl_dump_start(). Returns 0 if the dump operation was error-free,
1007 * otherwise a positive errno value describing the problem. */
1009 nl_dump_done(struct nl_dump *dump)
1013 ovs_mutex_lock(&dump->mutex);
1014 status = dump->status;
1015 ovs_mutex_unlock(&dump->mutex);
1017 /* Drain any remaining messages that the client didn't read. Otherwise the
1018 * kernel will continue to queue them up and waste buffer space.
1020 * XXX We could just destroy and discard the socket in this case. */
1022 uint64_t tmp_reply_stub[NL_DUMP_BUFSIZE / 8];
1023 struct ofpbuf reply, buf;
1025 ofpbuf_use_stub(&buf, tmp_reply_stub, sizeof tmp_reply_stub);
1026 while (nl_dump_next(dump, &reply, &buf)) {
1027 /* Nothing to do. */
1029 ofpbuf_uninit(&buf);
1031 ovs_mutex_lock(&dump->mutex);
1032 status = dump->status;
1033 ovs_mutex_unlock(&dump->mutex);
1037 nl_pool_release(dump->sock);
1038 ovs_mutex_destroy(&dump->mutex);
1040 return status == EOF ? 0 : status;
1043 /* Causes poll_block() to wake up when any of the specified 'events' (which is
1044 * a OR'd combination of POLLIN, POLLOUT, etc.) occur on 'sock'. */
1046 nl_sock_wait(const struct nl_sock *sock, short int events)
1049 poll_fd_wait(sock->handle, events);
1051 poll_fd_wait(sock->fd, events);
1055 /* Returns the underlying fd for 'sock', for use in "poll()"-like operations
1056 * that can't use nl_sock_wait().
1058 * It's a little tricky to use the returned fd correctly, because nl_sock does
1059 * "copy on write" to allow a single nl_sock to be used for notifications,
1060 * transactions, and dumps. If 'sock' is used only for notifications and
1061 * transactions (and never for dump) then the usage is safe. */
1063 nl_sock_fd(const struct nl_sock *sock)
1066 return sock->handle;
1072 /* Returns the PID associated with this socket. */
1074 nl_sock_pid(const struct nl_sock *sock)
1079 /* Miscellaneous. */
1081 struct genl_family {
1082 struct hmap_node hmap_node;
1087 static struct hmap genl_families = HMAP_INITIALIZER(&genl_families);
1089 static const struct nl_policy family_policy[CTRL_ATTR_MAX + 1] = {
1090 [CTRL_ATTR_FAMILY_ID] = {.type = NL_A_U16},
1091 [CTRL_ATTR_MCAST_GROUPS] = {.type = NL_A_NESTED, .optional = true},
1094 static struct genl_family *
1095 find_genl_family_by_id(uint16_t id)
1097 struct genl_family *family;
1099 HMAP_FOR_EACH_IN_BUCKET (family, hmap_node, hash_int(id, 0),
1101 if (family->id == id) {
1109 define_genl_family(uint16_t id, const char *name)
1111 struct genl_family *family = find_genl_family_by_id(id);
1114 if (!strcmp(family->name, name)) {
1119 family = xmalloc(sizeof *family);
1121 hmap_insert(&genl_families, &family->hmap_node, hash_int(id, 0));
1123 family->name = xstrdup(name);
1127 genl_family_to_name(uint16_t id)
1129 if (id == GENL_ID_CTRL) {
1132 struct genl_family *family = find_genl_family_by_id(id);
1133 return family ? family->name : "unknown";
1139 do_lookup_genl_family(const char *name, struct nlattr **attrs,
1140 struct ofpbuf **replyp)
1142 struct nl_sock *sock;
1143 struct ofpbuf request, *reply;
1147 error = nl_sock_create(NETLINK_GENERIC, &sock);
1152 ofpbuf_init(&request, 0);
1153 nl_msg_put_genlmsghdr(&request, 0, GENL_ID_CTRL, NLM_F_REQUEST,
1154 CTRL_CMD_GETFAMILY, 1);
1155 nl_msg_put_string(&request, CTRL_ATTR_FAMILY_NAME, name);
1156 error = nl_sock_transact(sock, &request, &reply);
1157 ofpbuf_uninit(&request);
1159 nl_sock_destroy(sock);
1163 if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
1164 family_policy, attrs, ARRAY_SIZE(family_policy))
1165 || nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]) == 0) {
1166 nl_sock_destroy(sock);
1167 ofpbuf_delete(reply);
1171 nl_sock_destroy(sock);
1177 do_lookup_genl_family(const char *name, struct nlattr **attrs,
1178 struct ofpbuf **replyp)
1180 struct nl_sock *sock;
1181 struct nlmsghdr *nlmsg;
1182 struct ofpbuf *reply;
1185 const char *family_name;
1186 uint32_t family_version;
1187 uint32_t family_attrmax;
1188 uint32_t mcgrp_id = OVS_WIN_NL_INVALID_MCGRP_ID;
1189 const char *mcgrp_name = NULL;
1192 reply = ofpbuf_new(1024);
1194 /* CTRL_ATTR_MCAST_GROUPS is supported only for VPORT family. */
1195 if (!strcmp(name, OVS_WIN_CONTROL_FAMILY)) {
1196 family_id = OVS_WIN_NL_CTRL_FAMILY_ID;
1197 family_name = OVS_WIN_CONTROL_FAMILY;
1198 family_version = OVS_WIN_CONTROL_VERSION;
1199 family_attrmax = OVS_WIN_CONTROL_ATTR_MAX;
1200 } else if (!strcmp(name, OVS_DATAPATH_FAMILY)) {
1201 family_id = OVS_WIN_NL_DATAPATH_FAMILY_ID;
1202 family_name = OVS_DATAPATH_FAMILY;
1203 family_version = OVS_DATAPATH_VERSION;
1204 family_attrmax = OVS_DP_ATTR_MAX;
1205 } else if (!strcmp(name, OVS_PACKET_FAMILY)) {
1206 family_id = OVS_WIN_NL_PACKET_FAMILY_ID;
1207 family_name = OVS_PACKET_FAMILY;
1208 family_version = OVS_PACKET_VERSION;
1209 family_attrmax = OVS_PACKET_ATTR_MAX;
1210 } else if (!strcmp(name, OVS_VPORT_FAMILY)) {
1211 family_id = OVS_WIN_NL_VPORT_FAMILY_ID;
1212 family_name = OVS_VPORT_FAMILY;
1213 family_version = OVS_VPORT_VERSION;
1214 family_attrmax = OVS_VPORT_ATTR_MAX;
1215 mcgrp_id = OVS_WIN_NL_VPORT_MCGRP_ID;
1216 mcgrp_name = OVS_VPORT_MCGROUP;
1217 } else if (!strcmp(name, OVS_FLOW_FAMILY)) {
1218 family_id = OVS_WIN_NL_FLOW_FAMILY_ID;
1219 family_name = OVS_FLOW_FAMILY;
1220 family_version = OVS_FLOW_VERSION;
1221 family_attrmax = OVS_FLOW_ATTR_MAX;
1223 ofpbuf_delete(reply);
1227 nl_msg_put_genlmsghdr(reply, 0, GENL_ID_CTRL, 0,
1228 CTRL_CMD_NEWFAMILY, family_version);
1229 /* CTRL_ATTR_HDRSIZE and CTRL_ATTR_OPS are not populated, but the
1230 * callers do not seem to need them. */
1231 nl_msg_put_u16(reply, CTRL_ATTR_FAMILY_ID, family_id);
1232 nl_msg_put_string(reply, CTRL_ATTR_FAMILY_NAME, family_name);
1233 nl_msg_put_u32(reply, CTRL_ATTR_VERSION, family_version);
1234 nl_msg_put_u32(reply, CTRL_ATTR_MAXATTR, family_attrmax);
1236 if (mcgrp_id != OVS_WIN_NL_INVALID_MCGRP_ID) {
1237 size_t mcgrp_ofs1 = nl_msg_start_nested(reply, CTRL_ATTR_MCAST_GROUPS);
1238 size_t mcgrp_ofs2= nl_msg_start_nested(reply,
1239 OVS_WIN_NL_VPORT_MCGRP_ID - OVS_WIN_NL_MCGRP_START_ID);
1240 nl_msg_put_u32(reply, CTRL_ATTR_MCAST_GRP_ID, mcgrp_id);
1241 ovs_assert(mcgrp_name != NULL);
1242 nl_msg_put_string(reply, CTRL_ATTR_MCAST_GRP_NAME, mcgrp_name);
1243 nl_msg_end_nested(reply, mcgrp_ofs2);
1244 nl_msg_end_nested(reply, mcgrp_ofs1);
1247 /* Set the total length of the netlink message. */
1248 nlmsg = nl_msg_nlmsghdr(reply);
1249 nlmsg->nlmsg_len = ofpbuf_size(reply);
1251 if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
1252 family_policy, attrs, ARRAY_SIZE(family_policy))
1253 || nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]) == 0) {
1254 nl_sock_destroy(sock);
1255 ofpbuf_delete(reply);
1264 /* Finds the multicast group called 'group_name' in genl family 'family_name'.
1265 * When successful, writes its result to 'multicast_group' and returns 0.
1266 * Otherwise, clears 'multicast_group' and returns a positive error code.
1269 nl_lookup_genl_mcgroup(const char *family_name, const char *group_name,
1270 unsigned int *multicast_group)
1272 struct nlattr *family_attrs[ARRAY_SIZE(family_policy)];
1273 const struct nlattr *mc;
1274 struct ofpbuf *reply;
1278 *multicast_group = 0;
1279 error = do_lookup_genl_family(family_name, family_attrs, &reply);
1284 if (!family_attrs[CTRL_ATTR_MCAST_GROUPS]) {
1289 NL_NESTED_FOR_EACH (mc, left, family_attrs[CTRL_ATTR_MCAST_GROUPS]) {
1290 static const struct nl_policy mc_policy[] = {
1291 [CTRL_ATTR_MCAST_GRP_ID] = {.type = NL_A_U32},
1292 [CTRL_ATTR_MCAST_GRP_NAME] = {.type = NL_A_STRING},
1295 struct nlattr *mc_attrs[ARRAY_SIZE(mc_policy)];
1296 const char *mc_name;
1298 if (!nl_parse_nested(mc, mc_policy, mc_attrs, ARRAY_SIZE(mc_policy))) {
1303 mc_name = nl_attr_get_string(mc_attrs[CTRL_ATTR_MCAST_GRP_NAME]);
1304 if (!strcmp(group_name, mc_name)) {
1306 nl_attr_get_u32(mc_attrs[CTRL_ATTR_MCAST_GRP_ID]);
1314 ofpbuf_delete(reply);
1318 /* If '*number' is 0, translates the given Generic Netlink family 'name' to a
1319 * number and stores it in '*number'. If successful, returns 0 and the caller
1320 * may use '*number' as the family number. On failure, returns a positive
1321 * errno value and '*number' caches the errno value. */
1323 nl_lookup_genl_family(const char *name, int *number)
1326 struct nlattr *attrs[ARRAY_SIZE(family_policy)];
1327 struct ofpbuf *reply;
1330 error = do_lookup_genl_family(name, attrs, &reply);
1332 *number = nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]);
1333 define_genl_family(*number, name);
1337 ofpbuf_delete(reply);
1339 ovs_assert(*number != 0);
1341 return *number > 0 ? 0 : -*number;
1345 struct nl_sock *socks[16];
1349 static struct ovs_mutex pool_mutex = OVS_MUTEX_INITIALIZER;
1350 static struct nl_pool pools[MAX_LINKS] OVS_GUARDED_BY(pool_mutex);
1353 nl_pool_alloc(int protocol, struct nl_sock **sockp)
1355 struct nl_sock *sock = NULL;
1356 struct nl_pool *pool;
1358 ovs_assert(protocol >= 0 && protocol < ARRAY_SIZE(pools));
1360 ovs_mutex_lock(&pool_mutex);
1361 pool = &pools[protocol];
1363 sock = pool->socks[--pool->n];
1365 ovs_mutex_unlock(&pool_mutex);
1371 return nl_sock_create(protocol, sockp);
1376 nl_pool_release(struct nl_sock *sock)
1379 struct nl_pool *pool = &pools[sock->protocol];
1381 ovs_mutex_lock(&pool_mutex);
1382 if (pool->n < ARRAY_SIZE(pool->socks)) {
1383 pool->socks[pool->n++] = sock;
1386 ovs_mutex_unlock(&pool_mutex);
1388 nl_sock_destroy(sock);
1392 /* Sends 'request' to the kernel on a Netlink socket for the given 'protocol'
1393 * (e.g. NETLINK_ROUTE or NETLINK_GENERIC) and waits for a response. If
1394 * successful, returns 0. On failure, returns a positive errno value.
1396 * If 'replyp' is nonnull, then on success '*replyp' is set to the kernel's
1397 * reply, which the caller is responsible for freeing with ofpbuf_delete(), and
1398 * on failure '*replyp' is set to NULL. If 'replyp' is null, then the kernel's
1399 * reply, if any, is discarded.
1401 * Before the message is sent, nlmsg_len in 'request' will be finalized to
1402 * match ofpbuf_size(msg), nlmsg_pid will be set to the pid of the socket used
1403 * for sending the request, and nlmsg_seq will be initialized.
1405 * The caller is responsible for destroying 'request'.
1407 * Bare Netlink is an unreliable transport protocol. This function layers
1408 * reliable delivery and reply semantics on top of bare Netlink.
1410 * In Netlink, sending a request to the kernel is reliable enough, because the
1411 * kernel will tell us if the message cannot be queued (and we will in that
1412 * case put it on the transmit queue and wait until it can be delivered).
1414 * Receiving the reply is the real problem: if the socket buffer is full when
1415 * the kernel tries to send the reply, the reply will be dropped. However, the
1416 * kernel sets a flag that a reply has been dropped. The next call to recv
1417 * then returns ENOBUFS. We can then re-send the request.
1421 * 1. Netlink depends on sequence numbers to match up requests and
1422 * replies. The sender of a request supplies a sequence number, and
1423 * the reply echos back that sequence number.
1425 * This is fine, but (1) some kernel netlink implementations are
1426 * broken, in that they fail to echo sequence numbers and (2) this
1427 * function will drop packets with non-matching sequence numbers, so
1428 * that only a single request can be usefully transacted at a time.
1430 * 2. Resending the request causes it to be re-executed, so the request
1431 * needs to be idempotent.
1434 nl_transact(int protocol, const struct ofpbuf *request,
1435 struct ofpbuf **replyp)
1437 struct nl_sock *sock;
1440 error = nl_pool_alloc(protocol, &sock);
1446 error = nl_sock_transact(sock, request, replyp);
1448 nl_pool_release(sock);
1452 /* Sends the 'request' member of the 'n' transactions in 'transactions' on a
1453 * Netlink socket for the given 'protocol' (e.g. NETLINK_ROUTE or
1454 * NETLINK_GENERIC), in order, and receives responses to all of them. Fills in
1455 * the 'error' member of each transaction with 0 if it was successful,
1456 * otherwise with a positive errno value. If 'reply' is nonnull, then it will
1457 * be filled with the reply if the message receives a detailed reply. In other
1458 * cases, i.e. where the request failed or had no reply beyond an indication of
1459 * success, 'reply' will be cleared if it is nonnull.
1461 * The caller is responsible for destroying each request and reply, and the
1462 * transactions array itself.
1464 * Before sending each message, this function will finalize nlmsg_len in each
1465 * 'request' to match the ofpbuf's size, set nlmsg_pid to the pid of the socket
1466 * used for the transaction, and initialize nlmsg_seq.
1468 * Bare Netlink is an unreliable transport protocol. This function layers
1469 * reliable delivery and reply semantics on top of bare Netlink. See
1470 * nl_transact() for some caveats.
1473 nl_transact_multiple(int protocol,
1474 struct nl_transaction **transactions, size_t n)
1476 struct nl_sock *sock;
1479 error = nl_pool_alloc(protocol, &sock);
1481 nl_sock_transact_multiple(sock, transactions, n);
1482 nl_pool_release(sock);
1484 nl_sock_record_errors__(transactions, n, error);
1490 nl_sock_allocate_seq(struct nl_sock *sock, unsigned int n)
1492 uint32_t seq = sock->next_seq;
1494 sock->next_seq += n;
1496 /* Make it impossible for the next request for sequence numbers to wrap
1497 * around to 0. Start over with 1 to avoid ever using a sequence number of
1498 * 0, because the kernel uses sequence number 0 for notifications. */
1499 if (sock->next_seq >= UINT32_MAX / 2) {
1507 nlmsghdr_to_string(const struct nlmsghdr *h, int protocol, struct ds *ds)
1513 static const struct nlmsg_flag flags[] = {
1514 { NLM_F_REQUEST, "REQUEST" },
1515 { NLM_F_MULTI, "MULTI" },
1516 { NLM_F_ACK, "ACK" },
1517 { NLM_F_ECHO, "ECHO" },
1518 { NLM_F_DUMP, "DUMP" },
1519 { NLM_F_ROOT, "ROOT" },
1520 { NLM_F_MATCH, "MATCH" },
1521 { NLM_F_ATOMIC, "ATOMIC" },
1523 const struct nlmsg_flag *flag;
1524 uint16_t flags_left;
1526 ds_put_format(ds, "nl(len:%"PRIu32", type=%"PRIu16,
1527 h->nlmsg_len, h->nlmsg_type);
1528 if (h->nlmsg_type == NLMSG_NOOP) {
1529 ds_put_cstr(ds, "(no-op)");
1530 } else if (h->nlmsg_type == NLMSG_ERROR) {
1531 ds_put_cstr(ds, "(error)");
1532 } else if (h->nlmsg_type == NLMSG_DONE) {
1533 ds_put_cstr(ds, "(done)");
1534 } else if (h->nlmsg_type == NLMSG_OVERRUN) {
1535 ds_put_cstr(ds, "(overrun)");
1536 } else if (h->nlmsg_type < NLMSG_MIN_TYPE) {
1537 ds_put_cstr(ds, "(reserved)");
1538 } else if (protocol == NETLINK_GENERIC) {
1539 ds_put_format(ds, "(%s)", genl_family_to_name(h->nlmsg_type));
1541 ds_put_cstr(ds, "(family-defined)");
1543 ds_put_format(ds, ", flags=%"PRIx16, h->nlmsg_flags);
1544 flags_left = h->nlmsg_flags;
1545 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1546 if ((flags_left & flag->bits) == flag->bits) {
1547 ds_put_format(ds, "[%s]", flag->name);
1548 flags_left &= ~flag->bits;
1552 ds_put_format(ds, "[OTHER:%"PRIx16"]", flags_left);
1554 ds_put_format(ds, ", seq=%"PRIx32", pid=%"PRIu32,
1555 h->nlmsg_seq, h->nlmsg_pid);
1559 nlmsg_to_string(const struct ofpbuf *buffer, int protocol)
1561 struct ds ds = DS_EMPTY_INITIALIZER;
1562 const struct nlmsghdr *h = ofpbuf_at(buffer, 0, NLMSG_HDRLEN);
1564 nlmsghdr_to_string(h, protocol, &ds);
1565 if (h->nlmsg_type == NLMSG_ERROR) {
1566 const struct nlmsgerr *e;
1567 e = ofpbuf_at(buffer, NLMSG_HDRLEN,
1568 NLMSG_ALIGN(sizeof(struct nlmsgerr)));
1570 ds_put_format(&ds, " error(%d", e->error);
1572 ds_put_format(&ds, "(%s)", ovs_strerror(-e->error));
1574 ds_put_cstr(&ds, ", in-reply-to(");
1575 nlmsghdr_to_string(&e->msg, protocol, &ds);
1576 ds_put_cstr(&ds, "))");
1578 ds_put_cstr(&ds, " error(truncated)");
1580 } else if (h->nlmsg_type == NLMSG_DONE) {
1581 int *error = ofpbuf_at(buffer, NLMSG_HDRLEN, sizeof *error);
1583 ds_put_format(&ds, " done(%d", *error);
1585 ds_put_format(&ds, "(%s)", ovs_strerror(-*error));
1587 ds_put_cstr(&ds, ")");
1589 ds_put_cstr(&ds, " done(truncated)");
1591 } else if (protocol == NETLINK_GENERIC) {
1592 struct genlmsghdr *genl = nl_msg_genlmsghdr(buffer);
1594 ds_put_format(&ds, ",genl(cmd=%"PRIu8",version=%"PRIu8")",
1595 genl->cmd, genl->version);
1599 ds_put_cstr(&ds, "nl(truncated)");
1605 log_nlmsg(const char *function, int error,
1606 const void *message, size_t size, int protocol)
1608 struct ofpbuf buffer;
1611 if (!VLOG_IS_DBG_ENABLED()) {
1615 ofpbuf_use_const(&buffer, message, size);
1616 nlmsg = nlmsg_to_string(&buffer, protocol);
1617 VLOG_DBG_RL(&rl, "%s (%s): %s", function, ovs_strerror(error), nlmsg);