lib/netlink-socket.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "netlink-socket.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <stdlib.h>
  22 #include <sys/types.h>
  23 #include <sys/uio.h>
  24 #include <unistd.h>
  25 #include "coverage.h"
  26 #include "dynamic-string.h"
  27 #include "hash.h"
  28 #include "hmap.h"
  29 #include "netlink.h"
  30 #include "netlink-protocol.h"
  31 #include "odp-netlink.h"
  32 #include "ofpbuf.h"
  33 #include "ovs-thread.h"
  34 #include "poll-loop.h"
  35 #include "seq.h"
  36 #include "socket-util.h"
  37 #include "util.h"
  38 #include "vlog.h"
  39
  40 VLOG_DEFINE_THIS_MODULE(netlink_socket);
  41
  42 COVERAGE_DEFINE(netlink_overflow);
  43 COVERAGE_DEFINE(netlink_received);
  44 COVERAGE_DEFINE(netlink_recv_jumbo);
  45 COVERAGE_DEFINE(netlink_sent);
  46
  47 /* Linux header file confusion causes this to be undefined. */
  48 #ifndef SOL_NETLINK
  49 #define SOL_NETLINK 270
  50 #endif
  51
  52 #ifdef _WIN32
  53 static struct ovs_mutex portid_mutex = OVS_MUTEX_INITIALIZER;
  54 static uint32_t g_last_portid = 0;
  55
  56 /* Port IDs must be unique! */
  57 static uint32_t
  58 portid_next(void)
  59     OVS_GUARDED_BY(portid_mutex)
  60 {
  61     g_last_portid++;
  62     return g_last_portid;
  63 }
  64 #endif /* _WIN32 */
  65
  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);
  70
  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);
  74 #ifdef _WIN32
  75 static int get_sock_pid_from_kernel(struct nl_sock *sock);
  76 #endif
  77 \f
  78 /* Netlink sockets. */
  79
  80 struct nl_sock {
  81 #ifdef _WIN32
  82     HANDLE handle;
  83     OVERLAPPED overlapped;
  84     DWORD read_ioctl;
  85 #else
  86     int fd;
  87 #endif
  88     uint32_t next_seq;
  89     uint32_t pid;
  90     int protocol;
  91     unsigned int rcvbuf;        /* Receive buffer size (SO_RCVBUF). */
  92 };
  93
  94 /* Compile-time limit on iovecs, so that we can allocate a maximum-size array
  95  * of iovecs on the stack. */
  96 #define MAX_IOVS 128
  97
  98 /* Maximum number of iovecs that may be passed to sendmsg, capped at a
  99  * minimum of _XOPEN_IOV_MAX (16) and a maximum of MAX_IOVS.
 100  *
 101  * Initialized by nl_sock_create(). */
 102 static int max_iovs;
 103
 104 static int nl_pool_alloc(int protocol, struct nl_sock **sockp);
 105 static void nl_pool_release(struct nl_sock *);
 106
 107 /* Creates a new netlink socket for the given netlink 'protocol'
 108  * (NETLINK_ROUTE, NETLINK_GENERIC, ...).  Returns 0 and sets '*sockp' to the
 109  * new socket if successful, otherwise returns a positive errno value. */
 110 int
 111 nl_sock_create(int protocol, struct nl_sock **sockp)
 112 {
 113     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 114     struct nl_sock *sock;
 115 #ifndef _WIN32
 116     struct sockaddr_nl local, remote;
 117 #endif
 118     socklen_t local_size;
 119     int rcvbuf;
 120     int retval = 0;
 121
 122     if (ovsthread_once_start(&once)) {
 123         int save_errno = errno;
 124         errno = 0;
 125
 126         max_iovs = sysconf(_SC_UIO_MAXIOV);
 127         if (max_iovs < _XOPEN_IOV_MAX) {
 128             if (max_iovs == -1 && errno) {
 129                 VLOG_WARN("sysconf(_SC_UIO_MAXIOV): %s", ovs_strerror(errno));
 130             }
 131             max_iovs = _XOPEN_IOV_MAX;
 132         } else if (max_iovs > MAX_IOVS) {
 133             max_iovs = MAX_IOVS;
 134         }
 135
 136         errno = save_errno;
 137         ovsthread_once_done(&once);
 138     }
 139
 140     *sockp = NULL;
 141     sock = xmalloc(sizeof *sock);
 142
 143 #ifdef _WIN32
 144     sock->handle = CreateFile(OVS_DEVICE_NAME_USER,
 145                               GENERIC_READ | GENERIC_WRITE,
 146                               FILE_SHARE_READ | FILE_SHARE_WRITE,
 147                               NULL, OPEN_EXISTING,
 148                               FILE_FLAG_OVERLAPPED, NULL);
 149
 150     if (sock->handle == INVALID_HANDLE_VALUE) {
 151         VLOG_ERR("fcntl: %s", ovs_lasterror_to_string());
 152         goto error;
 153     }
 154
 155     memset(&sock->overlapped, 0, sizeof sock->overlapped);
 156     sock->overlapped.hEvent = CreateEvent(NULL, FALSE, FALSE, NULL);
 157     if (sock->overlapped.hEvent == NULL) {
 158         VLOG_ERR("fcntl: %s", ovs_lasterror_to_string());
 159         goto error;
 160     }
 161     /* Initialize the type/ioctl to Generic */
 162     sock->read_ioctl = OVS_IOCTL_READ;
 163 #else
 164     sock->fd = socket(AF_NETLINK, SOCK_RAW, protocol);
 165     if (sock->fd < 0) {
 166         VLOG_ERR("fcntl: %s", ovs_strerror(errno));
 167         goto error;
 168     }
 169 #endif
 170
 171     sock->protocol = protocol;
 172     sock->next_seq = 1;
 173
 174     rcvbuf = 1024 * 1024;
 175 #ifdef _WIN32
 176     sock->rcvbuf = rcvbuf;
 177     retval = get_sock_pid_from_kernel(sock);
 178     if (retval != 0) {
 179         goto error;
 180     }
 181 #else
 182     if (setsockopt(sock->fd, SOL_SOCKET, SO_RCVBUFFORCE,
 183                    &rcvbuf, sizeof rcvbuf)) {
 184         /* Only root can use SO_RCVBUFFORCE.  Everyone else gets EPERM.
 185          * Warn only if the failure is therefore unexpected. */
 186         if (errno != EPERM) {
 187             VLOG_WARN_RL(&rl, "setting %d-byte socket receive buffer failed "
 188                          "(%s)", rcvbuf, ovs_strerror(errno));
 189         }
 190     }
 191
 192     retval = get_socket_rcvbuf(sock->fd);
 193     if (retval < 0) {
 194         retval = -retval;
 195         goto error;
 196     }
 197     sock->rcvbuf = retval;
 198
 199     /* Connect to kernel (pid 0) as remote address. */
 200     memset(&remote, 0, sizeof remote);
 201     remote.nl_family = AF_NETLINK;
 202     remote.nl_pid = 0;
 203     if (connect(sock->fd, (struct sockaddr *) &remote, sizeof remote) < 0) {
 204         VLOG_ERR("connect(0): %s", ovs_strerror(errno));
 205         goto error;
 206     }
 207
 208     /* Obtain pid assigned by kernel. */
 209     local_size = sizeof local;
 210     if (getsockname(sock->fd, (struct sockaddr *) &local, &local_size) < 0) {
 211         VLOG_ERR("getsockname: %s", ovs_strerror(errno));
 212         goto error;
 213     }
 214     if (local_size < sizeof local || local.nl_family != AF_NETLINK) {
 215         VLOG_ERR("getsockname returned bad Netlink name");
 216         retval = EINVAL;
 217         goto error;
 218     }
 219     sock->pid = local.nl_pid;
 220 #endif
 221
 222     *sockp = sock;
 223     return 0;
 224
 225 error:
 226     if (retval == 0) {
 227         retval = errno;
 228         if (retval == 0) {
 229             retval = EINVAL;
 230         }
 231     }
 232 #ifdef _WIN32
 233     if (sock->overlapped.hEvent) {
 234         CloseHandle(sock->overlapped.hEvent);
 235     }
 236     if (sock->handle != INVALID_HANDLE_VALUE) {
 237         CloseHandle(sock->handle);
 238     }
 239 #else
 240     if (sock->fd >= 0) {
 241         close(sock->fd);
 242     }
 243 #endif
 244     free(sock);
 245     return retval;
 246 }
 247
 248 /* Creates a new netlink socket for the same protocol as 'src'.  Returns 0 and
 249  * sets '*sockp' to the new socket if successful, otherwise returns a positive
 250  * errno value.  */
 251 int
 252 nl_sock_clone(const struct nl_sock *src, struct nl_sock **sockp)
 253 {
 254     return nl_sock_create(src->protocol, sockp);
 255 }
 256
 257 /* Destroys netlink socket 'sock'. */
 258 void
 259 nl_sock_destroy(struct nl_sock *sock)
 260 {
 261     if (sock) {
 262 #ifdef _WIN32
 263         if (sock->overlapped.hEvent) {
 264             CloseHandle(sock->overlapped.hEvent);
 265         }
 266         CloseHandle(sock->handle);
 267 #else
 268         close(sock->fd);
 269 #endif
 270         free(sock);
 271     }
 272 }
 273
 274 #ifdef _WIN32
 275 /* Reads the pid for 'sock' generated in the kernel datapath. The function
 276  * follows a transaction semantic. Eventually this function should call into
 277  * nl_transact. */
 278 static int
 279 get_sock_pid_from_kernel(struct nl_sock *sock)
 280 {
 281     struct nl_transaction txn;
 282     struct ofpbuf request;
 283     uint64_t request_stub[128];
 284     struct ofpbuf reply;
 285     uint64_t reply_stub[128];
 286     struct ovs_header *ovs_header;
 287     struct nlmsghdr *nlmsg;
 288     uint32_t seq;
 289     int retval;
 290     DWORD bytes;
 291     int ovs_msg_size = sizeof (struct nlmsghdr) + sizeof (struct genlmsghdr) +
 292                        sizeof (struct ovs_header);
 293
 294     ofpbuf_use_stub(&request, request_stub, sizeof request_stub);
 295     txn.request = &request;
 296     ofpbuf_use_stub(&reply, reply_stub, sizeof reply_stub);
 297     txn.reply = &reply;
 298
 299     seq = nl_sock_allocate_seq(sock, 1);
 300     nl_msg_put_genlmsghdr(&request, 0, OVS_WIN_NL_CTRL_FAMILY_ID, 0,
 301                           OVS_CTRL_CMD_WIN_GET_PID, OVS_WIN_CONTROL_VERSION);
 302     nlmsg = nl_msg_nlmsghdr(txn.request);
 303     nlmsg->nlmsg_seq = seq;
 304
 305     ovs_header = ofpbuf_put_uninit(&request, sizeof *ovs_header);
 306     ovs_header->dp_ifindex = 0;
 307     ovs_header = ofpbuf_put_uninit(&reply, ovs_msg_size);
 308
 309     if (!DeviceIoControl(sock->handle, OVS_IOCTL_TRANSACT,
 310                          ofpbuf_data(txn.request), ofpbuf_size(txn.request),
 311                          ofpbuf_data(txn.reply), ofpbuf_size(txn.reply),
 312                          &bytes, NULL)) {
 313         retval = EINVAL;
 314         goto done;
 315     } else {
 316         if (bytes < ovs_msg_size) {
 317             retval = EINVAL;
 318             goto done;
 319         }
 320
 321         nlmsg = nl_msg_nlmsghdr(txn.reply);
 322         if (nlmsg->nlmsg_seq != seq) {
 323             retval = EINVAL;
 324             goto done;
 325         }
 326         sock->pid = nlmsg->nlmsg_pid;
 327     }
 328     retval = 0;
 329
 330 done:
 331     ofpbuf_uninit(&request);
 332     ofpbuf_uninit(&reply);
 333     return retval;
 334 }
 335 #endif  /* _WIN32 */
 336
 337 #ifdef _WIN32
 338 static int __inline
 339 nl_sock_mcgroup(struct nl_sock *sock, unsigned int multicast_group, bool join)
 340 {
 341     struct ofpbuf request;
 342     uint64_t request_stub[128];
 343     struct ovs_header *ovs_header;
 344     struct nlmsghdr *nlmsg;
 345     int error;
 346
 347     ofpbuf_use_stub(&request, request_stub, sizeof request_stub);
 348
 349     nl_msg_put_genlmsghdr(&request, 0, OVS_WIN_NL_CTRL_FAMILY_ID, 0,
 350                           OVS_CTRL_CMD_MC_SUBSCRIBE_REQ,
 351                           OVS_WIN_CONTROL_VERSION);
 352
 353     ovs_header = ofpbuf_put_uninit(&request, sizeof *ovs_header);
 354     ovs_header->dp_ifindex = 0;
 355
 356     nl_msg_put_u32(&request, OVS_NL_ATTR_MCAST_GRP, multicast_group);
 357     nl_msg_put_u8(&request, OVS_NL_ATTR_MCAST_JOIN, join ? 1 : 0);
 358
 359     error = nl_sock_send(sock, &request, true);
 360     ofpbuf_uninit(&request);
 361     return error;
 362 }
 363 #endif
 364 /* Tries to add 'sock' as a listener for 'multicast_group'.  Returns 0 if
 365  * successful, otherwise a positive errno value.
 366  *
 367  * A socket that is subscribed to a multicast group that receives asynchronous
 368  * notifications must not be used for Netlink transactions or dumps, because
 369  * transactions and dumps can cause notifications to be lost.
 370  *
 371  * Multicast group numbers are always positive.
 372  *
 373  * It is not an error to attempt to join a multicast group to which a socket
 374  * already belongs. */
 375 int
 376 nl_sock_join_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
 377 {
 378 #ifdef _WIN32
 379     /* Set the socket type as a "multicast" socket */
 380     sock->read_ioctl = OVS_IOCTL_READ_EVENT;
 381     int error = nl_sock_mcgroup(sock, multicast_group, true);
 382     if (error) {
 383         sock->read_ioctl = OVS_IOCTL_READ;
 384         VLOG_WARN("could not join multicast group %u (%s)",
 385                   multicast_group, ovs_strerror(errno));
 386         return errno;
 387     }
 388 #else
 389     if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_ADD_MEMBERSHIP,
 390                    &multicast_group, sizeof multicast_group) < 0) {
 391         VLOG_WARN("could not join multicast group %u (%s)",
 392                   multicast_group, ovs_strerror(errno));
 393         return errno;
 394     }
 395 #endif
 396     return 0;
 397 }
 398
 399 /* Tries to make 'sock' stop listening to 'multicast_group'.  Returns 0 if
 400  * successful, otherwise a positive errno value.
 401  *
 402  * Multicast group numbers are always positive.
 403  *
 404  * It is not an error to attempt to leave a multicast group to which a socket
 405  * does not belong.
 406  *
 407  * On success, reading from 'sock' will still return any messages that were
 408  * received on 'multicast_group' before the group was left. */
 409 int
 410 nl_sock_leave_mcgroup(struct nl_sock *sock, unsigned int multicast_group)
 411 {
 412 #ifdef _WIN32
 413     int error = nl_sock_mcgroup(sock, multicast_group, false);
 414     if (error) {
 415         VLOG_WARN("could not leave multicast group %u (%s)",
 416                    multicast_group, ovs_strerror(errno));
 417         return errno;
 418     }
 419     sock->read_ioctl = OVS_IOCTL_READ;
 420 #else
 421     if (setsockopt(sock->fd, SOL_NETLINK, NETLINK_DROP_MEMBERSHIP,
 422                    &multicast_group, sizeof multicast_group) < 0) {
 423         VLOG_WARN("could not leave multicast group %u (%s)",
 424                   multicast_group, ovs_strerror(errno));
 425         return errno;
 426     }
 427 #endif
 428     return 0;
 429 }
 430
 431 static int
 432 nl_sock_send__(struct nl_sock *sock, const struct ofpbuf *msg,
 433                uint32_t nlmsg_seq, bool wait)
 434 {
 435     struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(msg);
 436     int error;
 437
 438     nlmsg->nlmsg_len = ofpbuf_size(msg);
 439     nlmsg->nlmsg_seq = nlmsg_seq;
 440     nlmsg->nlmsg_pid = sock->pid;
 441     do {
 442         int retval;
 443 #ifdef _WIN32
 444         DWORD bytes;
 445
 446         if (!DeviceIoControl(sock->handle, OVS_IOCTL_WRITE,
 447                              ofpbuf_data(msg), ofpbuf_size(msg), NULL, 0,
 448                              &bytes, NULL)) {
 449             retval = -1;
 450             /* XXX: Map to a more appropriate error based on GetLastError(). */
 451             errno = EINVAL;
 452         } else {
 453             retval = ofpbuf_size(msg);
 454         }
 455 #else
 456         retval = send(sock->fd, ofpbuf_data(msg), ofpbuf_size(msg),
 457                       wait ? 0 : MSG_DONTWAIT);
 458 #endif
 459         error = retval < 0 ? errno : 0;
 460     } while (error == EINTR);
 461     log_nlmsg(__func__, error, ofpbuf_data(msg), ofpbuf_size(msg), sock->protocol);
 462     if (!error) {
 463         COVERAGE_INC(netlink_sent);
 464     }
 465     return error;
 466 }
 467
 468 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
 469  * 'sock'.  nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
 470  * will be set to 'sock''s pid, and nlmsg_seq will be initialized to a fresh
 471  * sequence number, before the message is sent.
 472  *
 473  * Returns 0 if successful, otherwise a positive errno value.  If
 474  * 'wait' is true, then the send will wait until buffer space is ready;
 475  * otherwise, returns EAGAIN if the 'sock' send buffer is full. */
 476 int
 477 nl_sock_send(struct nl_sock *sock, const struct ofpbuf *msg, bool wait)
 478 {
 479     return nl_sock_send_seq(sock, msg, nl_sock_allocate_seq(sock, 1), wait);
 480 }
 481
 482 /* Tries to send 'msg', which must contain a Netlink message, to the kernel on
 483  * 'sock'.  nlmsg_len in 'msg' will be finalized to match ofpbuf_size(msg), nlmsg_pid
 484  * will be set to 'sock''s pid, and nlmsg_seq will be initialized to
 485  * 'nlmsg_seq', before the message is sent.
 486  *
 487  * Returns 0 if successful, otherwise a positive errno value.  If
 488  * 'wait' is true, then the send will wait until buffer space is ready;
 489  * otherwise, returns EAGAIN if the 'sock' send buffer is full.
 490  *
 491  * This function is suitable for sending a reply to a request that was received
 492  * with sequence number 'nlmsg_seq'.  Otherwise, use nl_sock_send() instead. */
 493 int
 494 nl_sock_send_seq(struct nl_sock *sock, const struct ofpbuf *msg,
 495                  uint32_t nlmsg_seq, bool wait)
 496 {
 497     return nl_sock_send__(sock, msg, nlmsg_seq, wait);
 498 }
 499
 500 static int
 501 nl_sock_recv__(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
 502 {
 503     /* We can't accurately predict the size of the data to be received.  The
 504      * caller is supposed to have allocated enough space in 'buf' to handle the
 505      * "typical" case.  To handle exceptions, we make available enough space in
 506      * 'tail' to allow Netlink messages to be up to 64 kB long (a reasonable
 507      * figure since that's the maximum length of a Netlink attribute). */
 508     struct nlmsghdr *nlmsghdr;
 509     uint8_t tail[65536];
 510     struct iovec iov[2];
 511     struct msghdr msg;
 512     ssize_t retval;
 513     int error;
 514
 515     ovs_assert(buf->allocated >= sizeof *nlmsghdr);
 516     ofpbuf_clear(buf);
 517
 518     iov[0].iov_base = ofpbuf_base(buf);
 519     iov[0].iov_len = buf->allocated;
 520     iov[1].iov_base = tail;
 521     iov[1].iov_len = sizeof tail;
 522
 523     memset(&msg, 0, sizeof msg);
 524     msg.msg_iov = iov;
 525     msg.msg_iovlen = 2;
 526
 527     /* Receive a Netlink message from the kernel.
 528      *
 529      * This works around a kernel bug in which the kernel returns an error code
 530      * as if it were the number of bytes read.  It doesn't actually modify
 531      * anything in the receive buffer in that case, so we can initialize the
 532      * Netlink header with an impossible message length and then, upon success,
 533      * check whether it changed. */
 534     nlmsghdr = ofpbuf_base(buf);
 535     do {
 536         nlmsghdr->nlmsg_len = UINT32_MAX;
 537 #ifdef _WIN32
 538         DWORD bytes;
 539         if (!DeviceIoControl(sock->handle, sock->read_ioctl,
 540                              NULL, 0, tail, sizeof tail, &bytes, NULL)) {
 541             retval = -1;
 542             errno = EINVAL;
 543         } else {
 544             retval = bytes;
 545             if (retval == 0) {
 546                 retval = -1;
 547                 errno = EAGAIN;
 548             } else {
 549                 if (retval >= buf->allocated) {
 550                     ofpbuf_reinit(buf, retval);
 551                 }
 552                 memcpy(ofpbuf_data(buf), tail, retval);
 553                 ofpbuf_set_size(buf, retval);
 554             }
 555         }
 556 #else
 557         retval = recvmsg(sock->fd, &msg, wait ? 0 : MSG_DONTWAIT);
 558 #endif
 559         error = (retval < 0 ? errno
 560                  : retval == 0 ? ECONNRESET /* not possible? */
 561                  : nlmsghdr->nlmsg_len != UINT32_MAX ? 0
 562                  : retval);
 563     } while (error == EINTR);
 564     if (error) {
 565         if (error == ENOBUFS) {
 566             /* Socket receive buffer overflow dropped one or more messages that
 567              * the kernel tried to send to us. */
 568             COVERAGE_INC(netlink_overflow);
 569         }
 570         return error;
 571     }
 572
 573     if (msg.msg_flags & MSG_TRUNC) {
 574         VLOG_ERR_RL(&rl, "truncated message (longer than %"PRIuSIZE" bytes)",
 575                     sizeof tail);
 576         return E2BIG;
 577     }
 578
 579     if (retval < sizeof *nlmsghdr
 580         || nlmsghdr->nlmsg_len < sizeof *nlmsghdr
 581         || nlmsghdr->nlmsg_len > retval) {
 582         VLOG_ERR_RL(&rl, "received invalid nlmsg (%"PRIuSIZE" bytes < %"PRIuSIZE")",
 583                     retval, sizeof *nlmsghdr);
 584         return EPROTO;
 585     }
 586 #ifndef _WIN32
 587     ofpbuf_set_size(buf, MIN(retval, buf->allocated));
 588     if (retval > buf->allocated) {
 589         COVERAGE_INC(netlink_recv_jumbo);
 590         ofpbuf_put(buf, tail, retval - buf->allocated);
 591     }
 592 #endif
 593
 594     log_nlmsg(__func__, 0, ofpbuf_data(buf), ofpbuf_size(buf), sock->protocol);
 595     COVERAGE_INC(netlink_received);
 596
 597     return 0;
 598 }
 599
 600 /* Tries to receive a Netlink message from the kernel on 'sock' into 'buf'.  If
 601  * 'wait' is true, waits for a message to be ready.  Otherwise, fails with
 602  * EAGAIN if the 'sock' receive buffer is empty.
 603  *
 604  * The caller must have initialized 'buf' with an allocation of at least
 605  * NLMSG_HDRLEN bytes.  For best performance, the caller should allocate enough
 606  * space for a "typical" message.
 607  *
 608  * On success, returns 0 and replaces 'buf''s previous content by the received
 609  * message.  This function expands 'buf''s allocated memory, as necessary, to
 610  * hold the actual size of the received message.
 611  *
 612  * On failure, returns a positive errno value and clears 'buf' to zero length.
 613  * 'buf' retains its previous memory allocation.
 614  *
 615  * Regardless of success or failure, this function resets 'buf''s headroom to
 616  * 0. */
 617 int
 618 nl_sock_recv(struct nl_sock *sock, struct ofpbuf *buf, bool wait)
 619 {
 620     return nl_sock_recv__(sock, buf, wait);
 621 }
 622
 623 static void
 624 nl_sock_record_errors__(struct nl_transaction **transactions, size_t n,
 625                         int error)
 626 {
 627     size_t i;
 628
 629     for (i = 0; i < n; i++) {
 630         struct nl_transaction *txn = transactions[i];
 631
 632         txn->error = error;
 633         if (txn->reply) {
 634             ofpbuf_clear(txn->reply);
 635         }
 636     }
 637 }
 638
 639 static int
 640 nl_sock_transact_multiple__(struct nl_sock *sock,
 641                             struct nl_transaction **transactions, size_t n,
 642                             size_t *done)
 643 {
 644     uint64_t tmp_reply_stub[1024 / 8];
 645     struct nl_transaction tmp_txn;
 646     struct ofpbuf tmp_reply;
 647
 648     uint32_t base_seq;
 649     struct iovec iovs[MAX_IOVS];
 650     struct msghdr msg;
 651     int error;
 652     int i;
 653
 654     base_seq = nl_sock_allocate_seq(sock, n);
 655     *done = 0;
 656     for (i = 0; i < n; i++) {
 657         struct nl_transaction *txn = transactions[i];
 658         struct nlmsghdr *nlmsg = nl_msg_nlmsghdr(txn->request);
 659
 660         nlmsg->nlmsg_len = ofpbuf_size(txn->request);
 661         nlmsg->nlmsg_seq = base_seq + i;
 662         nlmsg->nlmsg_pid = sock->pid;
 663
 664         iovs[i].iov_base = ofpbuf_data(txn->request);
 665         iovs[i].iov_len = ofpbuf_size(txn->request);
 666     }
 667
 668 #ifndef _WIN32
 669     memset(&msg, 0, sizeof msg);
 670     msg.msg_iov = iovs;
 671     msg.msg_iovlen = n;
 672     do {
 673         error = sendmsg(sock->fd, &msg, 0) < 0 ? errno : 0;
 674     } while (error == EINTR);
 675
 676     for (i = 0; i < n; i++) {
 677         struct nl_transaction *txn = transactions[i];
 678
 679         log_nlmsg(__func__, error, ofpbuf_data(txn->request),
 680                   ofpbuf_size(txn->request), sock->protocol);
 681     }
 682     if (!error) {
 683         COVERAGE_ADD(netlink_sent, n);
 684     }
 685
 686     if (error) {
 687         return error;
 688     }
 689
 690     ofpbuf_use_stub(&tmp_reply, tmp_reply_stub, sizeof tmp_reply_stub);
 691     tmp_txn.request = NULL;
 692     tmp_txn.reply = &tmp_reply;
 693     tmp_txn.error = 0;
 694     while (n > 0) {
 695         struct nl_transaction *buf_txn, *txn;
 696         uint32_t seq;
 697
 698         /* Find a transaction whose buffer we can use for receiving a reply.
 699          * If no such transaction is left, use tmp_txn. */
 700         buf_txn = &tmp_txn;
 701         for (i = 0; i < n; i++) {
 702             if (transactions[i]->reply) {
 703                 buf_txn = transactions[i];
 704                 break;
 705             }
 706         }
 707
 708         /* Receive a reply. */
 709         error = nl_sock_recv__(sock, buf_txn->reply, false);
 710         if (error) {
 711             if (error == EAGAIN) {
 712                 nl_sock_record_errors__(transactions, n, 0);
 713                 *done += n;
 714                 error = 0;
 715             }
 716             break;
 717         }
 718
 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);
 723             continue;
 724         }
 725         i = seq - base_seq;
 726         txn = transactions[i];
 727
 728         /* Fill in the results for 'txn'. */
 729         if (nl_msg_nlmsgerr(buf_txn->reply, &txn->error)) {
 730             if (txn->reply) {
 731                 ofpbuf_clear(txn->reply);
 732             }
 733             if (txn->error) {
 734                 VLOG_DBG_RL(&rl, "received NAK error=%d (%s)",
 735                             error, ovs_strerror(txn->error));
 736             }
 737         } else {
 738             txn->error = 0;
 739             if (txn->reply && txn != buf_txn) {
 740                 /* Swap buffers. */
 741                 struct ofpbuf *reply = buf_txn->reply;
 742                 buf_txn->reply = txn->reply;
 743                 txn->reply = reply;
 744             }
 745         }
 746
 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
 749          * above.) */
 750         nl_sock_record_errors__(transactions, i, 0);
 751
 752         /* Advance. */
 753         *done += i + 1;
 754         transactions += i + 1;
 755         n -= i + 1;
 756         base_seq += i + 1;
 757     }
 758     ofpbuf_uninit(&tmp_reply);
 759 #else
 760     error = 0;
 761     uint8_t reply_buf[65536];
 762     for (i = 0; i < n; i++) {
 763         DWORD reply_len;
 764         struct nl_transaction *txn = transactions[i];
 765         struct nlmsghdr *request_nlmsg, *reply_nlmsg;
 766
 767         if (!DeviceIoControl(sock->handle, OVS_IOCTL_TRANSACT,
 768                              ofpbuf_data(txn->request),
 769                              ofpbuf_size(txn->request),
 770                              reply_buf, sizeof reply_buf,
 771                              &reply_len, NULL)) {
 772             /* XXX: Map to a more appropriate error. */
 773             error = EINVAL;
 774             break;
 775         }
 776
 777         if (reply_len < sizeof *reply_nlmsg) {
 778             nl_sock_record_errors__(transactions, n, 0);
 779             VLOG_DBG_RL(&rl, "insufficient length of reply %#"PRIu32
 780                 " for seq: %#"PRIx32, reply_len, request_nlmsg->nlmsg_seq);
 781             break;
 782         }
 783
 784         /* Validate the sequence number in the reply. */
 785         request_nlmsg = nl_msg_nlmsghdr(txn->request);
 786         reply_nlmsg = (struct nlmsghdr *)reply_buf;
 787
 788         if (request_nlmsg->nlmsg_seq != reply_nlmsg->nlmsg_seq) {
 789             ovs_assert(request_nlmsg->nlmsg_seq == reply_nlmsg->nlmsg_seq);
 790             VLOG_DBG_RL(&rl, "mismatched seq request %#"PRIx32
 791                 ", reply %#"PRIx32, request_nlmsg->nlmsg_seq,
 792                 reply_nlmsg->nlmsg_seq);
 793             break;
 794         }
 795
 796         /* Handle errors embedded within the netlink message. */
 797         ofpbuf_use_stub(&tmp_reply, reply_buf, sizeof reply_buf);
 798         ofpbuf_set_size(&tmp_reply, sizeof reply_buf);
 799         if (nl_msg_nlmsgerr(&tmp_reply, &txn->error)) {
 800             if (txn->reply) {
 801                 ofpbuf_clear(txn->reply);
 802             }
 803             if (txn->error) {
 804                 VLOG_DBG_RL(&rl, "received NAK error=%d (%s)",
 805                             error, ovs_strerror(txn->error));
 806             }
 807         } else {
 808             txn->error = 0;
 809             if (txn->reply) {
 810                 /* Copy the reply to the buffer specified by the caller. */
 811                 if (reply_len > txn->reply->allocated) {
 812                     ofpbuf_reinit(txn->reply, reply_len);
 813                 }
 814                 memcpy(ofpbuf_data(txn->reply), reply_buf, reply_len);
 815                 ofpbuf_set_size(txn->reply, reply_len);
 816             }
 817         }
 818         ofpbuf_uninit(&tmp_reply);
 819
 820         /* Count the number of successful transactions. */
 821         (*done)++;
 822
 823     }
 824
 825     if (!error) {
 826         COVERAGE_ADD(netlink_sent, n);
 827     }
 828 #endif
 829
 830     return error;
 831 }
 832
 833 static void
 834 nl_sock_transact_multiple(struct nl_sock *sock,
 835                           struct nl_transaction **transactions, size_t n)
 836 {
 837     int max_batch_count;
 838     int error;
 839
 840     if (!n) {
 841         return;
 842     }
 843
 844     /* In theory, every request could have a 64 kB reply.  But the default and
 845      * maximum socket rcvbuf size with typical Dom0 memory sizes both tend to
 846      * be a bit below 128 kB, so that would only allow a single message in a
 847      * "batch".  So we assume that replies average (at most) 4 kB, which allows
 848      * a good deal of batching.
 849      *
 850      * In practice, most of the requests that we batch either have no reply at
 851      * all or a brief reply. */
 852     max_batch_count = MAX(sock->rcvbuf / 4096, 1);
 853     max_batch_count = MIN(max_batch_count, max_iovs);
 854
 855     while (n > 0) {
 856         size_t count, bytes;
 857         size_t done;
 858
 859         /* Batch up to 'max_batch_count' transactions.  But cap it at about a
 860          * page of requests total because big skbuffs are expensive to
 861          * allocate in the kernel.  */
 862 #if defined(PAGESIZE)
 863         enum { MAX_BATCH_BYTES = MAX(1, PAGESIZE - 512) };
 864 #else
 865         enum { MAX_BATCH_BYTES = 4096 - 512 };
 866 #endif
 867         bytes = ofpbuf_size(transactions[0]->request);
 868         for (count = 1; count < n && count < max_batch_count; count++) {
 869             if (bytes + ofpbuf_size(transactions[count]->request) > MAX_BATCH_BYTES) {
 870                 break;
 871             }
 872             bytes += ofpbuf_size(transactions[count]->request);
 873         }
 874
 875         error = nl_sock_transact_multiple__(sock, transactions, count, &done);
 876         transactions += done;
 877         n -= done;
 878
 879         if (error == ENOBUFS) {
 880             VLOG_DBG_RL(&rl, "receive buffer overflow, resending request");
 881         } else if (error) {
 882             VLOG_ERR_RL(&rl, "transaction error (%s)", ovs_strerror(error));
 883             nl_sock_record_errors__(transactions, n, error);
 884         }
 885     }
 886 }
 887
 888 static int
 889 nl_sock_transact(struct nl_sock *sock, const struct ofpbuf *request,
 890                  struct ofpbuf **replyp)
 891 {
 892     struct nl_transaction *transactionp;
 893     struct nl_transaction transaction;
 894
 895     transaction.request = CONST_CAST(struct ofpbuf *, request);
 896     transaction.reply = replyp ? ofpbuf_new(1024) : NULL;
 897     transactionp = &transaction;
 898
 899     nl_sock_transact_multiple(sock, &transactionp, 1);
 900
 901     if (replyp) {
 902         if (transaction.error) {
 903             ofpbuf_delete(transaction.reply);
 904             *replyp = NULL;
 905         } else {
 906             *replyp = transaction.reply;
 907         }
 908     }
 909
 910     return transaction.error;
 911 }
 912
 913 /* Drain all the messages currently in 'sock''s receive queue. */
 914 int
 915 nl_sock_drain(struct nl_sock *sock)
 916 {
 917 #ifdef _WIN32
 918     return 0;
 919 #else
 920     return drain_rcvbuf(sock->fd);
 921 #endif
 922 }
 923
 924 /* Starts a Netlink "dump" operation, by sending 'request' to the kernel on a
 925  * Netlink socket created with the given 'protocol', and initializes 'dump' to
 926  * reflect the state of the operation.
 927  *
 928  * 'request' must contain a Netlink message.  Before sending the message,
 929  * nlmsg_len will be finalized to match request->size, and nlmsg_pid will be
 930  * set to the Netlink socket's pid.  NLM_F_DUMP and NLM_F_ACK will be set in
 931  * nlmsg_flags.
 932  *
 933  * The design of this Netlink socket library ensures that the dump is reliable.
 934  *
 935  * This function provides no status indication.  nl_dump_done() provides an
 936  * error status for the entire dump operation.
 937  *
 938  * The caller must eventually destroy 'request'.
 939  */
 940 void
 941 nl_dump_start(struct nl_dump *dump, int protocol, const struct ofpbuf *request)
 942 {
 943     nl_msg_nlmsghdr(request)->nlmsg_flags |= NLM_F_DUMP | NLM_F_ACK;
 944
 945     ovs_mutex_init(&dump->mutex);
 946     ovs_mutex_lock(&dump->mutex);
 947     dump->status = nl_pool_alloc(protocol, &dump->sock);
 948     if (!dump->status) {
 949         dump->status = nl_sock_send__(dump->sock, request,
 950                                       nl_sock_allocate_seq(dump->sock, 1),
 951                                       true);
 952     }
 953     dump->nl_seq = nl_msg_nlmsghdr(request)->nlmsg_seq;
 954     ovs_mutex_unlock(&dump->mutex);
 955 }
 956
 957 static int
 958 nl_dump_refill(struct nl_dump *dump, struct ofpbuf *buffer)
 959     OVS_REQUIRES(dump->mutex)
 960 {
 961     struct nlmsghdr *nlmsghdr;
 962     int error;
 963
 964     while (!ofpbuf_size(buffer)) {
 965         error = nl_sock_recv__(dump->sock, buffer, false);
 966         if (error) {
 967             /* The kernel never blocks providing the results of a dump, so
 968              * error == EAGAIN means that we've read the whole thing, and
 969              * therefore transform it into EOF.  (The kernel always provides
 970              * NLMSG_DONE as a sentinel.  Some other thread must have received
 971              * that already but not yet signaled it in 'status'.)
 972              *
 973              * Any other error is just an error. */
 974             return error == EAGAIN ? EOF : error;
 975         }
 976
 977         nlmsghdr = nl_msg_nlmsghdr(buffer);
 978         if (dump->nl_seq != nlmsghdr->nlmsg_seq) {
 979             VLOG_DBG_RL(&rl, "ignoring seq %#"PRIx32" != expected %#"PRIx32,
 980                         nlmsghdr->nlmsg_seq, dump->nl_seq);
 981             ofpbuf_clear(buffer);
 982         }
 983     }
 984
 985     if (nl_msg_nlmsgerr(buffer, &error) && error) {
 986         VLOG_INFO_RL(&rl, "netlink dump request error (%s)",
 987                      ovs_strerror(error));
 988         ofpbuf_clear(buffer);
 989         return error;
 990     }
 991
 992     return 0;
 993 }
 994
 995 static int
 996 nl_dump_next__(struct ofpbuf *reply, struct ofpbuf *buffer)
 997 {
 998     struct nlmsghdr *nlmsghdr = nl_msg_next(buffer, reply);
 999     if (!nlmsghdr) {
1000         VLOG_WARN_RL(&rl, "netlink dump contains message fragment");
1001         return EPROTO;
1002     } else if (nlmsghdr->nlmsg_type == NLMSG_DONE) {
1003         return EOF;
1004     } else {
1005         return 0;
1006     }
1007 }
1008
1009 /* Attempts to retrieve another reply from 'dump' into 'buffer'. 'dump' must
1010  * have been initialized with nl_dump_start(), and 'buffer' must have been
1011  * initialized. 'buffer' should be at least NL_DUMP_BUFSIZE bytes long.
1012  *
1013  * If successful, returns true and points 'reply->data' and
1014  * 'ofpbuf_size(reply)' to the message that was retrieved. The caller must not
1015  * modify 'reply' (because it points within 'buffer', which will be used by
1016  * future calls to this function).
1017  *
1018  * On failure, returns false and sets 'reply->data' to NULL and
1019  * 'ofpbuf_size(reply)' to 0.  Failure might indicate an actual error or merely
1020  * the end of replies.  An error status for the entire dump operation is
1021  * provided when it is completed by calling nl_dump_done().
1022  *
1023  * Multiple threads may call this function, passing the same nl_dump, however
1024  * each must provide independent buffers. This function may cache multiple
1025  * replies in the buffer, and these will be processed before more replies are
1026  * fetched. When this function returns false, other threads may continue to
1027  * process replies in their buffers, but they will not fetch more replies.
1028  */
1029 bool
1030 nl_dump_next(struct nl_dump *dump, struct ofpbuf *reply, struct ofpbuf *buffer)
1031 {
1032     int retval = 0;
1033
1034     /* If the buffer is empty, refill it.
1035      *
1036      * If the buffer is not empty, we don't check the dump's status.
1037      * Otherwise, we could end up skipping some of the dump results if thread A
1038      * hits EOF while thread B is in the midst of processing a batch. */
1039     if (!ofpbuf_size(buffer)) {
1040         ovs_mutex_lock(&dump->mutex);
1041         if (!dump->status) {
1042             /* Take the mutex here to avoid an in-kernel race.  If two threads
1043              * try to read from a Netlink dump socket at once, then the socket
1044              * error can be set to EINVAL, which will be encountered on the
1045              * next recv on that socket, which could be anywhere due to the way
1046              * that we pool Netlink sockets.  Serializing the recv calls avoids
1047              * the issue. */
1048             dump->status = nl_dump_refill(dump, buffer);
1049         }
1050         retval = dump->status;
1051         ovs_mutex_unlock(&dump->mutex);
1052     }
1053
1054     /* Fetch the next message from the buffer. */
1055     if (!retval) {
1056         retval = nl_dump_next__(reply, buffer);
1057         if (retval) {
1058             /* Record 'retval' as the dump status, but don't overwrite an error
1059              * with EOF.  */
1060             ovs_mutex_lock(&dump->mutex);
1061             if (dump->status <= 0) {
1062                 dump->status = retval;
1063             }
1064             ovs_mutex_unlock(&dump->mutex);
1065         }
1066     }
1067
1068     if (retval) {
1069         ofpbuf_set_data(reply, NULL);
1070         ofpbuf_set_size(reply, 0);
1071     }
1072     return !retval;
1073 }
1074
1075 /* Completes Netlink dump operation 'dump', which must have been initialized
1076  * with nl_dump_start().  Returns 0 if the dump operation was error-free,
1077  * otherwise a positive errno value describing the problem. */
1078 int
1079 nl_dump_done(struct nl_dump *dump)
1080 {
1081     int status;
1082
1083     ovs_mutex_lock(&dump->mutex);
1084     status = dump->status;
1085     ovs_mutex_unlock(&dump->mutex);
1086
1087     /* Drain any remaining messages that the client didn't read.  Otherwise the
1088      * kernel will continue to queue them up and waste buffer space.
1089      *
1090      * XXX We could just destroy and discard the socket in this case. */
1091     if (!status) {
1092         uint64_t tmp_reply_stub[NL_DUMP_BUFSIZE / 8];
1093         struct ofpbuf reply, buf;
1094
1095         ofpbuf_use_stub(&buf, tmp_reply_stub, sizeof tmp_reply_stub);
1096         while (nl_dump_next(dump, &reply, &buf)) {
1097             /* Nothing to do. */
1098         }
1099         ofpbuf_uninit(&buf);
1100
1101         ovs_mutex_lock(&dump->mutex);
1102         status = dump->status;
1103         ovs_mutex_unlock(&dump->mutex);
1104         ovs_assert(status);
1105     }
1106
1107     nl_pool_release(dump->sock);
1108     ovs_mutex_destroy(&dump->mutex);
1109
1110     return status == EOF ? 0 : status;
1111 }
1112
1113 #ifdef _WIN32
1114 /* Pend an I/O request in the driver. The driver completes the I/O whenever
1115  * an event or a packet is ready to be read. Once the I/O is completed
1116  * the overlapped structure event associated with the pending I/O will be set
1117  */
1118 static int
1119 pend_io_request(const struct nl_sock *sock)
1120 {
1121     struct ofpbuf request;
1122     uint64_t request_stub[128];
1123     struct ovs_header *ovs_header;
1124     struct nlmsghdr *nlmsg;
1125     uint32_t seq;
1126     int retval;
1127     int error;
1128     DWORD bytes;
1129     OVERLAPPED *overlapped = CONST_CAST(OVERLAPPED *, &sock->overlapped);
1130
1131     int ovs_msg_size = sizeof (struct nlmsghdr) + sizeof (struct genlmsghdr) +
1132                                sizeof (struct ovs_header);
1133
1134     ofpbuf_use_stub(&request, request_stub, sizeof request_stub);
1135
1136     seq = nl_sock_allocate_seq(sock, 1);
1137     nl_msg_put_genlmsghdr(&request, 0, OVS_WIN_NL_CTRL_FAMILY_ID, 0,
1138                           OVS_CTRL_CMD_WIN_PEND_REQ, OVS_WIN_CONTROL_VERSION);
1139     nlmsg = nl_msg_nlmsghdr(&request);
1140     nlmsg->nlmsg_seq = seq;
1141
1142     ovs_header = ofpbuf_put_uninit(&request, sizeof *ovs_header);
1143     ovs_header->dp_ifindex = 0;
1144
1145     if (!DeviceIoControl(sock->handle, OVS_IOCTL_WRITE,
1146                          ofpbuf_data(&request), ofpbuf_size(&request),
1147                          NULL, 0, &bytes, overlapped)) {
1148         error = GetLastError();
1149         /* Check if the I/O got pended */
1150         if (error != ERROR_IO_INCOMPLETE && error != ERROR_IO_PENDING) {
1151             VLOG_ERR("nl_sock_wait failed - %s\n", ovs_format_message(error));
1152             retval = EINVAL;
1153             goto done;
1154         }
1155     } else {
1156         /* The I/O was completed synchronously */
1157         poll_immediate_wake();
1158     }
1159     retval = 0;
1160
1161 done:
1162     ofpbuf_uninit(&request);
1163     return retval;
1164 }
1165 #endif  /* _WIN32 */
1166
1167 /* Causes poll_block() to wake up when any of the specified 'events' (which is
1168  * a OR'd combination of POLLIN, POLLOUT, etc.) occur on 'sock'. */
1169 void
1170 nl_sock_wait(const struct nl_sock *sock, short int events)
1171 {
1172 #ifdef _WIN32
1173     if (sock->overlapped.Internal != STATUS_PENDING) {
1174         pend_io_request(sock);
1175     }
1176     poll_fd_wait(sock->handle, events);
1177 #else
1178     poll_fd_wait(sock->fd, events);
1179 #endif
1180 }
1181
1182 /* Returns the underlying fd for 'sock', for use in "poll()"-like operations
1183  * that can't use nl_sock_wait().
1184  *
1185  * It's a little tricky to use the returned fd correctly, because nl_sock does
1186  * "copy on write" to allow a single nl_sock to be used for notifications,
1187  * transactions, and dumps.  If 'sock' is used only for notifications and
1188  * transactions (and never for dump) then the usage is safe. */
1189 int
1190 nl_sock_fd(const struct nl_sock *sock)
1191 {
1192 #ifdef _WIN32
1193     return sock->handle;
1194 #else
1195     return sock->fd;
1196 #endif
1197 }
1198
1199 /* Returns the PID associated with this socket. */
1200 uint32_t
1201 nl_sock_pid(const struct nl_sock *sock)
1202 {
1203     return sock->pid;
1204 }
1205 \f
1206 /* Miscellaneous.  */
1207
1208 struct genl_family {
1209     struct hmap_node hmap_node;
1210     uint16_t id;
1211     char *name;
1212 };
1213
1214 static struct hmap genl_families = HMAP_INITIALIZER(&genl_families);
1215
1216 static const struct nl_policy family_policy[CTRL_ATTR_MAX + 1] = {
1217     [CTRL_ATTR_FAMILY_ID] = {.type = NL_A_U16},
1218     [CTRL_ATTR_MCAST_GROUPS] = {.type = NL_A_NESTED, .optional = true},
1219 };
1220
1221 static struct genl_family *
1222 find_genl_family_by_id(uint16_t id)
1223 {
1224     struct genl_family *family;
1225
1226     HMAP_FOR_EACH_IN_BUCKET (family, hmap_node, hash_int(id, 0),
1227                              &genl_families) {
1228         if (family->id == id) {
1229             return family;
1230         }
1231     }
1232     return NULL;
1233 }
1234
1235 static void
1236 define_genl_family(uint16_t id, const char *name)
1237 {
1238     struct genl_family *family = find_genl_family_by_id(id);
1239
1240     if (family) {
1241         if (!strcmp(family->name, name)) {
1242             return;
1243         }
1244         free(family->name);
1245     } else {
1246         family = xmalloc(sizeof *family);
1247         family->id = id;
1248         hmap_insert(&genl_families, &family->hmap_node, hash_int(id, 0));
1249     }
1250     family->name = xstrdup(name);
1251 }
1252
1253 static const char *
1254 genl_family_to_name(uint16_t id)
1255 {
1256     if (id == GENL_ID_CTRL) {
1257         return "control";
1258     } else {
1259         struct genl_family *family = find_genl_family_by_id(id);
1260         return family ? family->name : "unknown";
1261     }
1262 }
1263
1264 #ifndef _WIN32
1265 static int
1266 do_lookup_genl_family(const char *name, struct nlattr **attrs,
1267                       struct ofpbuf **replyp)
1268 {
1269     struct nl_sock *sock;
1270     struct ofpbuf request, *reply;
1271     int error;
1272
1273     *replyp = NULL;
1274     error = nl_sock_create(NETLINK_GENERIC, &sock);
1275     if (error) {
1276         return error;
1277     }
1278
1279     ofpbuf_init(&request, 0);
1280     nl_msg_put_genlmsghdr(&request, 0, GENL_ID_CTRL, NLM_F_REQUEST,
1281                           CTRL_CMD_GETFAMILY, 1);
1282     nl_msg_put_string(&request, CTRL_ATTR_FAMILY_NAME, name);
1283     error = nl_sock_transact(sock, &request, &reply);
1284     ofpbuf_uninit(&request);
1285     if (error) {
1286         nl_sock_destroy(sock);
1287         return error;
1288     }
1289
1290     if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
1291                          family_policy, attrs, ARRAY_SIZE(family_policy))
1292         || nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]) == 0) {
1293         nl_sock_destroy(sock);
1294         ofpbuf_delete(reply);
1295         return EPROTO;
1296     }
1297
1298     nl_sock_destroy(sock);
1299     *replyp = reply;
1300     return 0;
1301 }
1302 #else
1303 static int
1304 do_lookup_genl_family(const char *name, struct nlattr **attrs,
1305                       struct ofpbuf **replyp)
1306 {
1307     struct nlmsghdr *nlmsg;
1308     struct ofpbuf *reply;
1309     int error;
1310     uint16_t family_id;
1311     const char *family_name;
1312     uint32_t family_version;
1313     uint32_t family_attrmax;
1314     uint32_t mcgrp_id = OVS_WIN_NL_INVALID_MCGRP_ID;
1315     const char *mcgrp_name = NULL;
1316
1317     *replyp = NULL;
1318     reply = ofpbuf_new(1024);
1319
1320     /* CTRL_ATTR_MCAST_GROUPS is supported only for VPORT family. */
1321     if (!strcmp(name, OVS_WIN_CONTROL_FAMILY)) {
1322         family_id = OVS_WIN_NL_CTRL_FAMILY_ID;
1323         family_name = OVS_WIN_CONTROL_FAMILY;
1324         family_version = OVS_WIN_CONTROL_VERSION;
1325         family_attrmax = OVS_WIN_CONTROL_ATTR_MAX;
1326     } else if (!strcmp(name, OVS_DATAPATH_FAMILY)) {
1327         family_id = OVS_WIN_NL_DATAPATH_FAMILY_ID;
1328         family_name = OVS_DATAPATH_FAMILY;
1329         family_version = OVS_DATAPATH_VERSION;
1330         family_attrmax = OVS_DP_ATTR_MAX;
1331     } else if (!strcmp(name, OVS_PACKET_FAMILY)) {
1332         family_id = OVS_WIN_NL_PACKET_FAMILY_ID;
1333         family_name = OVS_PACKET_FAMILY;
1334         family_version = OVS_PACKET_VERSION;
1335         family_attrmax = OVS_PACKET_ATTR_MAX;
1336     } else if (!strcmp(name, OVS_VPORT_FAMILY)) {
1337         family_id = OVS_WIN_NL_VPORT_FAMILY_ID;
1338         family_name = OVS_VPORT_FAMILY;
1339         family_version = OVS_VPORT_VERSION;
1340         family_attrmax = OVS_VPORT_ATTR_MAX;
1341         mcgrp_id = OVS_WIN_NL_VPORT_MCGRP_ID;
1342         mcgrp_name = OVS_VPORT_MCGROUP;
1343     } else if (!strcmp(name, OVS_FLOW_FAMILY)) {
1344         family_id = OVS_WIN_NL_FLOW_FAMILY_ID;
1345         family_name = OVS_FLOW_FAMILY;
1346         family_version = OVS_FLOW_VERSION;
1347         family_attrmax = OVS_FLOW_ATTR_MAX;
1348     } else if (!strcmp(name, OVS_WIN_NETDEV_FAMILY)) {
1349         family_id = OVS_WIN_NL_NETDEV_FAMILY_ID;
1350         family_name = OVS_WIN_NETDEV_FAMILY;
1351         family_version = OVS_WIN_NETDEV_VERSION;
1352         family_attrmax = OVS_WIN_NETDEV_ATTR_MAX;
1353     } else {
1354         ofpbuf_delete(reply);
1355         return EINVAL;
1356     }
1357
1358     nl_msg_put_genlmsghdr(reply, 0, GENL_ID_CTRL, 0,
1359                           CTRL_CMD_NEWFAMILY, family_version);
1360     /* CTRL_ATTR_HDRSIZE and CTRL_ATTR_OPS are not populated, but the
1361      * callers do not seem to need them. */
1362     nl_msg_put_u16(reply, CTRL_ATTR_FAMILY_ID, family_id);
1363     nl_msg_put_string(reply, CTRL_ATTR_FAMILY_NAME, family_name);
1364     nl_msg_put_u32(reply, CTRL_ATTR_VERSION, family_version);
1365     nl_msg_put_u32(reply, CTRL_ATTR_MAXATTR, family_attrmax);
1366
1367     if (mcgrp_id != OVS_WIN_NL_INVALID_MCGRP_ID) {
1368         size_t mcgrp_ofs1 = nl_msg_start_nested(reply, CTRL_ATTR_MCAST_GROUPS);
1369         size_t mcgrp_ofs2= nl_msg_start_nested(reply,
1370             OVS_WIN_NL_VPORT_MCGRP_ID - OVS_WIN_NL_MCGRP_START_ID);
1371         nl_msg_put_u32(reply, CTRL_ATTR_MCAST_GRP_ID, mcgrp_id);
1372         ovs_assert(mcgrp_name != NULL);
1373         nl_msg_put_string(reply, CTRL_ATTR_MCAST_GRP_NAME, mcgrp_name);
1374         nl_msg_end_nested(reply, mcgrp_ofs2);
1375         nl_msg_end_nested(reply, mcgrp_ofs1);
1376     }
1377
1378     /* Set the total length of the netlink message. */
1379     nlmsg = nl_msg_nlmsghdr(reply);
1380     nlmsg->nlmsg_len = ofpbuf_size(reply);
1381
1382     if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
1383                          family_policy, attrs, ARRAY_SIZE(family_policy))
1384         || nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]) == 0) {
1385         ofpbuf_delete(reply);
1386         return EPROTO;
1387     }
1388
1389     *replyp = reply;
1390     return 0;
1391 }
1392 #endif
1393
1394 /* Finds the multicast group called 'group_name' in genl family 'family_name'.
1395  * When successful, writes its result to 'multicast_group' and returns 0.
1396  * Otherwise, clears 'multicast_group' and returns a positive error code.
1397  */
1398 int
1399 nl_lookup_genl_mcgroup(const char *family_name, const char *group_name,
1400                        unsigned int *multicast_group)
1401 {
1402     struct nlattr *family_attrs[ARRAY_SIZE(family_policy)];
1403     const struct nlattr *mc;
1404     struct ofpbuf *reply;
1405     unsigned int left;
1406     int error;
1407
1408     *multicast_group = 0;
1409     error = do_lookup_genl_family(family_name, family_attrs, &reply);
1410     if (error) {
1411         return error;
1412     }
1413
1414     if (!family_attrs[CTRL_ATTR_MCAST_GROUPS]) {
1415         error = EPROTO;
1416         goto exit;
1417     }
1418
1419     NL_NESTED_FOR_EACH (mc, left, family_attrs[CTRL_ATTR_MCAST_GROUPS]) {
1420         static const struct nl_policy mc_policy[] = {
1421             [CTRL_ATTR_MCAST_GRP_ID] = {.type = NL_A_U32},
1422             [CTRL_ATTR_MCAST_GRP_NAME] = {.type = NL_A_STRING},
1423         };
1424
1425         struct nlattr *mc_attrs[ARRAY_SIZE(mc_policy)];
1426         const char *mc_name;
1427
1428         if (!nl_parse_nested(mc, mc_policy, mc_attrs, ARRAY_SIZE(mc_policy))) {
1429             error = EPROTO;
1430             goto exit;
1431         }
1432
1433         mc_name = nl_attr_get_string(mc_attrs[CTRL_ATTR_MCAST_GRP_NAME]);
1434         if (!strcmp(group_name, mc_name)) {
1435             *multicast_group =
1436                 nl_attr_get_u32(mc_attrs[CTRL_ATTR_MCAST_GRP_ID]);
1437             error = 0;
1438             goto exit;
1439         }
1440     }
1441     error = EPROTO;
1442
1443 exit:
1444     ofpbuf_delete(reply);
1445     return error;
1446 }
1447
1448 /* If '*number' is 0, translates the given Generic Netlink family 'name' to a
1449  * number and stores it in '*number'.  If successful, returns 0 and the caller
1450  * may use '*number' as the family number.  On failure, returns a positive
1451  * errno value and '*number' caches the errno value. */
1452 int
1453 nl_lookup_genl_family(const char *name, int *number)
1454 {
1455     if (*number == 0) {
1456         struct nlattr *attrs[ARRAY_SIZE(family_policy)];
1457         struct ofpbuf *reply;
1458         int error;
1459
1460         error = do_lookup_genl_family(name, attrs, &reply);
1461         if (!error) {
1462             *number = nl_attr_get_u16(attrs[CTRL_ATTR_FAMILY_ID]);
1463             define_genl_family(*number, name);
1464         } else {
1465             *number = -error;
1466         }
1467         ofpbuf_delete(reply);
1468
1469         ovs_assert(*number != 0);
1470     }
1471     return *number > 0 ? 0 : -*number;
1472 }
1473 \f
1474 struct nl_pool {
1475     struct nl_sock *socks[16];
1476     int n;
1477 };
1478
1479 static struct ovs_mutex pool_mutex = OVS_MUTEX_INITIALIZER;
1480 static struct nl_pool pools[MAX_LINKS] OVS_GUARDED_BY(pool_mutex);
1481
1482 static int
1483 nl_pool_alloc(int protocol, struct nl_sock **sockp)
1484 {
1485     struct nl_sock *sock = NULL;
1486     struct nl_pool *pool;
1487
1488     ovs_assert(protocol >= 0 && protocol < ARRAY_SIZE(pools));
1489
1490     ovs_mutex_lock(&pool_mutex);
1491     pool = &pools[protocol];
1492     if (pool->n > 0) {
1493         sock = pool->socks[--pool->n];
1494     }
1495     ovs_mutex_unlock(&pool_mutex);
1496
1497     if (sock) {
1498         *sockp = sock;
1499         return 0;
1500     } else {
1501         return nl_sock_create(protocol, sockp);
1502     }
1503 }
1504
1505 static void
1506 nl_pool_release(struct nl_sock *sock)
1507 {
1508     if (sock) {
1509         struct nl_pool *pool = &pools[sock->protocol];
1510
1511         ovs_mutex_lock(&pool_mutex);
1512         if (pool->n < ARRAY_SIZE(pool->socks)) {
1513             pool->socks[pool->n++] = sock;
1514             sock = NULL;
1515         }
1516         ovs_mutex_unlock(&pool_mutex);
1517
1518         nl_sock_destroy(sock);
1519     }
1520 }
1521
1522 /* Sends 'request' to the kernel on a Netlink socket for the given 'protocol'
1523  * (e.g. NETLINK_ROUTE or NETLINK_GENERIC) and waits for a response.  If
1524  * successful, returns 0.  On failure, returns a positive errno value.
1525  *
1526  * If 'replyp' is nonnull, then on success '*replyp' is set to the kernel's
1527  * reply, which the caller is responsible for freeing with ofpbuf_delete(), and
1528  * on failure '*replyp' is set to NULL.  If 'replyp' is null, then the kernel's
1529  * reply, if any, is discarded.
1530  *
1531  * Before the message is sent, nlmsg_len in 'request' will be finalized to
1532  * match ofpbuf_size(msg), nlmsg_pid will be set to the pid of the socket used
1533  * for sending the request, and nlmsg_seq will be initialized.
1534  *
1535  * The caller is responsible for destroying 'request'.
1536  *
1537  * Bare Netlink is an unreliable transport protocol.  This function layers
1538  * reliable delivery and reply semantics on top of bare Netlink.
1539  *
1540  * In Netlink, sending a request to the kernel is reliable enough, because the
1541  * kernel will tell us if the message cannot be queued (and we will in that
1542  * case put it on the transmit queue and wait until it can be delivered).
1543  *
1544  * Receiving the reply is the real problem: if the socket buffer is full when
1545  * the kernel tries to send the reply, the reply will be dropped.  However, the
1546  * kernel sets a flag that a reply has been dropped.  The next call to recv
1547  * then returns ENOBUFS.  We can then re-send the request.
1548  *
1549  * Caveats:
1550  *
1551  *      1. Netlink depends on sequence numbers to match up requests and
1552  *         replies.  The sender of a request supplies a sequence number, and
1553  *         the reply echos back that sequence number.
1554  *
1555  *         This is fine, but (1) some kernel netlink implementations are
1556  *         broken, in that they fail to echo sequence numbers and (2) this
1557  *         function will drop packets with non-matching sequence numbers, so
1558  *         that only a single request can be usefully transacted at a time.
1559  *
1560  *      2. Resending the request causes it to be re-executed, so the request
1561  *         needs to be idempotent.
1562  */
1563 int
1564 nl_transact(int protocol, const struct ofpbuf *request,
1565             struct ofpbuf **replyp)
1566 {
1567     struct nl_sock *sock;
1568     int error;
1569
1570     error = nl_pool_alloc(protocol, &sock);
1571     if (error) {
1572         *replyp = NULL;
1573         return error;
1574     }
1575
1576     error = nl_sock_transact(sock, request, replyp);
1577
1578     nl_pool_release(sock);
1579     return error;
1580 }
1581
1582 /* Sends the 'request' member of the 'n' transactions in 'transactions' on a
1583  * Netlink socket for the given 'protocol' (e.g. NETLINK_ROUTE or
1584  * NETLINK_GENERIC), in order, and receives responses to all of them.  Fills in
1585  * the 'error' member of each transaction with 0 if it was successful,
1586  * otherwise with a positive errno value.  If 'reply' is nonnull, then it will
1587  * be filled with the reply if the message receives a detailed reply.  In other
1588  * cases, i.e. where the request failed or had no reply beyond an indication of
1589  * success, 'reply' will be cleared if it is nonnull.
1590  *
1591  * The caller is responsible for destroying each request and reply, and the
1592  * transactions array itself.
1593  *
1594  * Before sending each message, this function will finalize nlmsg_len in each
1595  * 'request' to match the ofpbuf's size, set nlmsg_pid to the pid of the socket
1596  * used for the transaction, and initialize nlmsg_seq.
1597  *
1598  * Bare Netlink is an unreliable transport protocol.  This function layers
1599  * reliable delivery and reply semantics on top of bare Netlink.  See
1600  * nl_transact() for some caveats.
1601  */
1602 void
1603 nl_transact_multiple(int protocol,
1604                      struct nl_transaction **transactions, size_t n)
1605 {
1606     struct nl_sock *sock;
1607     int error;
1608
1609     error = nl_pool_alloc(protocol, &sock);
1610     if (!error) {
1611         nl_sock_transact_multiple(sock, transactions, n);
1612         nl_pool_release(sock);
1613     } else {
1614         nl_sock_record_errors__(transactions, n, error);
1615     }
1616 }
1617
1618 \f
1619 static uint32_t
1620 nl_sock_allocate_seq(struct nl_sock *sock, unsigned int n)
1621 {
1622     uint32_t seq = sock->next_seq;
1623
1624     sock->next_seq += n;
1625
1626     /* Make it impossible for the next request for sequence numbers to wrap
1627      * around to 0.  Start over with 1 to avoid ever using a sequence number of
1628      * 0, because the kernel uses sequence number 0 for notifications. */
1629     if (sock->next_seq >= UINT32_MAX / 2) {
1630         sock->next_seq = 1;
1631     }
1632
1633     return seq;
1634 }
1635
1636 static void
1637 nlmsghdr_to_string(const struct nlmsghdr *h, int protocol, struct ds *ds)
1638 {
1639     struct nlmsg_flag {
1640         unsigned int bits;
1641         const char *name;
1642     };
1643     static const struct nlmsg_flag flags[] = {
1644         { NLM_F_REQUEST, "REQUEST" },
1645         { NLM_F_MULTI, "MULTI" },
1646         { NLM_F_ACK, "ACK" },
1647         { NLM_F_ECHO, "ECHO" },
1648         { NLM_F_DUMP, "DUMP" },
1649         { NLM_F_ROOT, "ROOT" },
1650         { NLM_F_MATCH, "MATCH" },
1651         { NLM_F_ATOMIC, "ATOMIC" },
1652     };
1653     const struct nlmsg_flag *flag;
1654     uint16_t flags_left;
1655
1656     ds_put_format(ds, "nl(len:%"PRIu32", type=%"PRIu16,
1657                   h->nlmsg_len, h->nlmsg_type);
1658     if (h->nlmsg_type == NLMSG_NOOP) {
1659         ds_put_cstr(ds, "(no-op)");
1660     } else if (h->nlmsg_type == NLMSG_ERROR) {
1661         ds_put_cstr(ds, "(error)");
1662     } else if (h->nlmsg_type == NLMSG_DONE) {
1663         ds_put_cstr(ds, "(done)");
1664     } else if (h->nlmsg_type == NLMSG_OVERRUN) {
1665         ds_put_cstr(ds, "(overrun)");
1666     } else if (h->nlmsg_type < NLMSG_MIN_TYPE) {
1667         ds_put_cstr(ds, "(reserved)");
1668     } else if (protocol == NETLINK_GENERIC) {
1669         ds_put_format(ds, "(%s)", genl_family_to_name(h->nlmsg_type));
1670     } else {
1671         ds_put_cstr(ds, "(family-defined)");
1672     }
1673     ds_put_format(ds, ", flags=%"PRIx16, h->nlmsg_flags);
1674     flags_left = h->nlmsg_flags;
1675     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1676         if ((flags_left & flag->bits) == flag->bits) {
1677             ds_put_format(ds, "[%s]", flag->name);
1678             flags_left &= ~flag->bits;
1679         }
1680     }
1681     if (flags_left) {
1682         ds_put_format(ds, "[OTHER:%"PRIx16"]", flags_left);
1683     }
1684     ds_put_format(ds, ", seq=%"PRIx32", pid=%"PRIu32,
1685                   h->nlmsg_seq, h->nlmsg_pid);
1686 }
1687
1688 static char *
1689 nlmsg_to_string(const struct ofpbuf *buffer, int protocol)
1690 {
1691     struct ds ds = DS_EMPTY_INITIALIZER;
1692     const struct nlmsghdr *h = ofpbuf_at(buffer, 0, NLMSG_HDRLEN);
1693     if (h) {
1694         nlmsghdr_to_string(h, protocol, &ds);
1695         if (h->nlmsg_type == NLMSG_ERROR) {
1696             const struct nlmsgerr *e;
1697             e = ofpbuf_at(buffer, NLMSG_HDRLEN,
1698                           NLMSG_ALIGN(sizeof(struct nlmsgerr)));
1699             if (e) {
1700                 ds_put_format(&ds, " error(%d", e->error);
1701                 if (e->error < 0) {
1702                     ds_put_format(&ds, "(%s)", ovs_strerror(-e->error));
1703                 }
1704                 ds_put_cstr(&ds, ", in-reply-to(");
1705                 nlmsghdr_to_string(&e->msg, protocol, &ds);
1706                 ds_put_cstr(&ds, "))");
1707             } else {
1708                 ds_put_cstr(&ds, " error(truncated)");
1709             }
1710         } else if (h->nlmsg_type == NLMSG_DONE) {
1711             int *error = ofpbuf_at(buffer, NLMSG_HDRLEN, sizeof *error);
1712             if (error) {
1713                 ds_put_format(&ds, " done(%d", *error);
1714                 if (*error < 0) {
1715                     ds_put_format(&ds, "(%s)", ovs_strerror(-*error));
1716                 }
1717                 ds_put_cstr(&ds, ")");
1718             } else {
1719                 ds_put_cstr(&ds, " done(truncated)");
1720             }
1721         } else if (protocol == NETLINK_GENERIC) {
1722             struct genlmsghdr *genl = nl_msg_genlmsghdr(buffer);
1723             if (genl) {
1724                 ds_put_format(&ds, ",genl(cmd=%"PRIu8",version=%"PRIu8")",
1725                               genl->cmd, genl->version);
1726             }
1727         }
1728     } else {
1729         ds_put_cstr(&ds, "nl(truncated)");
1730     }
1731     return ds.string;
1732 }
1733
1734 static void
1735 log_nlmsg(const char *function, int error,
1736           const void *message, size_t size, int protocol)
1737 {
1738     struct ofpbuf buffer;
1739     char *nlmsg;
1740
1741     if (!VLOG_IS_DBG_ENABLED()) {
1742         return;
1743     }
1744
1745     ofpbuf_use_const(&buffer, message, size);
1746     nlmsg = nlmsg_to_string(&buffer, protocol);
1747     VLOG_DBG_RL(&rl, "%s (%s): %s", function, ovs_strerror(error), nlmsg);
1748     free(nlmsg);
1749 }