lib/dpif-netlink.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
  19 #include "dpif-netlink.h"
  20
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <fcntl.h>
  24 #include <inttypes.h>
  25 #include <net/if.h>
  26 #include <linux/types.h>
  27 #include <linux/pkt_sched.h>
  28 #include <poll.h>
  29 #include <stdlib.h>
  30 #include <strings.h>
  31 #include <sys/epoll.h>
  32 #include <sys/stat.h>
  33 #include <unistd.h>
  34
  35 #include "bitmap.h"
  36 #include "dpif-provider.h"
  37 #include "dynamic-string.h"
  38 #include "flow.h"
  39 #include "fat-rwlock.h"
  40 #include "netdev.h"
  41 #include "netdev-linux.h"
  42 #include "netdev-vport.h"
  43 #include "netlink-notifier.h"
  44 #include "netlink-socket.h"
  45 #include "netlink.h"
  46 #include "odp-util.h"
  47 #include "ofpbuf.h"
  48 #include "packets.h"
  49 #include "poll-loop.h"
  50 #include "random.h"
  51 #include "shash.h"
  52 #include "sset.h"
  53 #include "timeval.h"
  54 #include "unaligned.h"
  55 #include "util.h"
  56 #include "vlog.h"
  57
  58 VLOG_DEFINE_THIS_MODULE(dpif_netlink);
  59 #ifdef _WIN32
  60 enum { WINDOWS = 1 };
  61 #else
  62 enum { WINDOWS = 0 };
  63 #endif
  64 enum { MAX_PORTS = USHRT_MAX };
  65
  66 /* This ethtool flag was introduced in Linux 2.6.24, so it might be
  67  * missing if we have old headers. */
  68 #define ETH_FLAG_LRO      (1 << 15)    /* LRO is enabled */
  69
  70 struct dpif_netlink_dp {
  71     /* Generic Netlink header. */
  72     uint8_t cmd;
  73
  74     /* struct ovs_header. */
  75     int dp_ifindex;
  76
  77     /* Attributes. */
  78     const char *name;                  /* OVS_DP_ATTR_NAME. */
  79     const uint32_t *upcall_pid;        /* OVS_DP_ATTR_UPCALL_PID. */
  80     uint32_t user_features;            /* OVS_DP_ATTR_USER_FEATURES */
  81     const struct ovs_dp_stats *stats;  /* OVS_DP_ATTR_STATS. */
  82     const struct ovs_dp_megaflow_stats *megaflow_stats;
  83                                        /* OVS_DP_ATTR_MEGAFLOW_STATS.*/
  84 };
  85
  86 static void dpif_netlink_dp_init(struct dpif_netlink_dp *);
  87 static int dpif_netlink_dp_from_ofpbuf(struct dpif_netlink_dp *,
  88                                        const struct ofpbuf *);
  89 static void dpif_netlink_dp_dump_start(struct nl_dump *);
  90 static int dpif_netlink_dp_transact(const struct dpif_netlink_dp *request,
  91                                     struct dpif_netlink_dp *reply,
  92                                     struct ofpbuf **bufp);
  93 static int dpif_netlink_dp_get(const struct dpif *,
  94                                struct dpif_netlink_dp *reply,
  95                                struct ofpbuf **bufp);
  96
  97 struct dpif_netlink_flow {
  98     /* Generic Netlink header. */
  99     uint8_t cmd;
 100
 101     /* struct ovs_header. */
 102     unsigned int nlmsg_flags;
 103     int dp_ifindex;
 104
 105     /* Attributes.
 106      *
 107      * The 'stats' member points to 64-bit data that might only be aligned on
 108      * 32-bit boundaries, so get_unaligned_u64() should be used to access its
 109      * values.
 110      *
 111      * If 'actions' is nonnull then OVS_FLOW_ATTR_ACTIONS will be included in
 112      * the Netlink version of the command, even if actions_len is zero. */
 113     const struct nlattr *key;           /* OVS_FLOW_ATTR_KEY. */
 114     size_t key_len;
 115     const struct nlattr *mask;          /* OVS_FLOW_ATTR_MASK. */
 116     size_t mask_len;
 117     const struct nlattr *actions;       /* OVS_FLOW_ATTR_ACTIONS. */
 118     size_t actions_len;
 119     const struct ovs_flow_stats *stats; /* OVS_FLOW_ATTR_STATS. */
 120     const uint8_t *tcp_flags;           /* OVS_FLOW_ATTR_TCP_FLAGS. */
 121     const ovs_32aligned_u64 *used;      /* OVS_FLOW_ATTR_USED. */
 122     bool clear;                         /* OVS_FLOW_ATTR_CLEAR. */
 123     bool probe;                         /* OVS_FLOW_ATTR_PROBE. */
 124 };
 125
 126 static void dpif_netlink_flow_init(struct dpif_netlink_flow *);
 127 static int dpif_netlink_flow_from_ofpbuf(struct dpif_netlink_flow *,
 128                                          const struct ofpbuf *);
 129 static void dpif_netlink_flow_to_ofpbuf(const struct dpif_netlink_flow *,
 130                                         struct ofpbuf *);
 131 static int dpif_netlink_flow_transact(struct dpif_netlink_flow *request,
 132                                       struct dpif_netlink_flow *reply,
 133                                       struct ofpbuf **bufp);
 134 static void dpif_netlink_flow_get_stats(const struct dpif_netlink_flow *,
 135                                         struct dpif_flow_stats *);
 136 static void dpif_netlink_flow_to_dpif_flow(struct dpif_flow *,
 137                                            const struct dpif_netlink_flow *);
 138
 139 /* One of the dpif channels between the kernel and userspace. */
 140 struct dpif_channel {
 141     struct nl_sock *sock;       /* Netlink socket. */
 142     long long int last_poll;    /* Last time this channel was polled. */
 143 };
 144
 145 #ifdef _WIN32
 146 #define VPORT_SOCK_POOL_SIZE 1
 147 /* On Windows, there is no native support for epoll.  There are equivalent
 148  * interfaces though, that are not used currently.  For simpicity, a pool of
 149  * netlink sockets is used.  Each socket is represented by 'struct
 150  * dpif_windows_vport_sock'.  Since it is a pool, multiple OVS ports may be
 151  * sharing the same socket.  In the future, we can add a reference count and
 152  * such fields. */
 153 struct dpif_windows_vport_sock {
 154     struct nl_sock *nl_sock;    /* netlink socket. */
 155 };
 156 #endif
 157
 158 struct dpif_handler {
 159     struct dpif_channel *channels;/* Array of channels for each handler. */
 160     struct epoll_event *epoll_events;
 161     int epoll_fd;                 /* epoll fd that includes channel socks. */
 162     int n_events;                 /* Num events returned by epoll_wait(). */
 163     int event_offset;             /* Offset into 'epoll_events'. */
 164
 165 #ifdef _WIN32
 166     /* Pool of sockets. */
 167     struct dpif_windows_vport_sock *vport_sock_pool;
 168     size_t last_used_pool_idx; /* Index to aid in allocating a
 169                                   socket in the pool to a port. */
 170 #endif
 171 };
 172
 173 /* Datapath interface for the openvswitch Linux kernel module. */
 174 struct dpif_netlink {
 175     struct dpif dpif;
 176     int dp_ifindex;
 177
 178     /* Upcall messages. */
 179     struct fat_rwlock upcall_lock;
 180     struct dpif_handler *handlers;
 181     uint32_t n_handlers;           /* Num of upcall handlers. */
 182     int uc_array_size;             /* Size of 'handler->channels' and */
 183                                    /* 'handler->epoll_events'. */
 184
 185     /* Change notification. */
 186     struct nl_sock *port_notifier; /* vport multicast group subscriber. */
 187     bool refresh_channels;
 188 };
 189
 190 static void report_loss(struct dpif_netlink *, struct dpif_channel *,
 191                         uint32_t ch_idx, uint32_t handler_id);
 192
 193 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
 194
 195 /* Generic Netlink family numbers for OVS.
 196  *
 197  * Initialized by dpif_netlink_init(). */
 198 static int ovs_datapath_family;
 199 static int ovs_vport_family;
 200 static int ovs_flow_family;
 201 static int ovs_packet_family;
 202
 203 /* Generic Netlink multicast groups for OVS.
 204  *
 205  * Initialized by dpif_netlink_init(). */
 206 static unsigned int ovs_vport_mcgroup;
 207
 208 static int dpif_netlink_init(void);
 209 static int open_dpif(const struct dpif_netlink_dp *, struct dpif **);
 210 static uint32_t dpif_netlink_port_get_pid(const struct dpif *,
 211                                           odp_port_t port_no, uint32_t hash);
 212 static void dpif_netlink_handler_uninit(struct dpif_handler *handler);
 213 static int dpif_netlink_refresh_channels(struct dpif_netlink *,
 214                                          uint32_t n_handlers);
 215 static void dpif_netlink_vport_to_ofpbuf(const struct dpif_netlink_vport *,
 216                                          struct ofpbuf *);
 217 static int dpif_netlink_vport_from_ofpbuf(struct dpif_netlink_vport *,
 218                                           const struct ofpbuf *);
 219
 220 static struct dpif_netlink *
 221 dpif_netlink_cast(const struct dpif *dpif)
 222 {
 223     dpif_assert_class(dpif, &dpif_netlink_class);
 224     return CONTAINER_OF(dpif, struct dpif_netlink, dpif);
 225 }
 226
 227 static int
 228 dpif_netlink_enumerate(struct sset *all_dps,
 229                        const struct dpif_class *dpif_class OVS_UNUSED)
 230 {
 231     struct nl_dump dump;
 232     uint64_t reply_stub[NL_DUMP_BUFSIZE / 8];
 233     struct ofpbuf msg, buf;
 234     int error;
 235
 236     error = dpif_netlink_init();
 237     if (error) {
 238         return error;
 239     }
 240
 241     ofpbuf_use_stub(&buf, reply_stub, sizeof reply_stub);
 242     dpif_netlink_dp_dump_start(&dump);
 243     while (nl_dump_next(&dump, &msg, &buf)) {
 244         struct dpif_netlink_dp dp;
 245
 246         if (!dpif_netlink_dp_from_ofpbuf(&dp, &msg)) {
 247             sset_add(all_dps, dp.name);
 248         }
 249     }
 250     ofpbuf_uninit(&buf);
 251     return nl_dump_done(&dump);
 252 }
 253
 254 static int
 255 dpif_netlink_open(const struct dpif_class *class OVS_UNUSED, const char *name,
 256                   bool create, struct dpif **dpifp)
 257 {
 258     struct dpif_netlink_dp dp_request, dp;
 259     struct ofpbuf *buf;
 260     uint32_t upcall_pid;
 261     int error;
 262
 263     error = dpif_netlink_init();
 264     if (error) {
 265         return error;
 266     }
 267
 268     /* Create or look up datapath. */
 269     dpif_netlink_dp_init(&dp_request);
 270     if (create) {
 271         dp_request.cmd = OVS_DP_CMD_NEW;
 272         upcall_pid = 0;
 273         dp_request.upcall_pid = &upcall_pid;
 274     } else {
 275         /* Use OVS_DP_CMD_SET to report user features */
 276         dp_request.cmd = OVS_DP_CMD_SET;
 277     }
 278     dp_request.name = name;
 279     dp_request.user_features |= OVS_DP_F_UNALIGNED;
 280     dp_request.user_features |= OVS_DP_F_VPORT_PIDS;
 281     error = dpif_netlink_dp_transact(&dp_request, &dp, &buf);
 282     if (error) {
 283         return error;
 284     }
 285
 286     error = open_dpif(&dp, dpifp);
 287     ofpbuf_delete(buf);
 288     return error;
 289 }
 290
 291 static int
 292 open_dpif(const struct dpif_netlink_dp *dp, struct dpif **dpifp)
 293 {
 294     struct dpif_netlink *dpif;
 295
 296     dpif = xzalloc(sizeof *dpif);
 297     dpif->port_notifier = NULL;
 298     fat_rwlock_init(&dpif->upcall_lock);
 299
 300     dpif_init(&dpif->dpif, &dpif_netlink_class, dp->name,
 301               dp->dp_ifindex, dp->dp_ifindex);
 302
 303     dpif->dp_ifindex = dp->dp_ifindex;
 304     *dpifp = &dpif->dpif;
 305
 306     return 0;
 307 }
 308
 309 /* Destroys the netlink sockets pointed by the elements in 'socksp'
 310  * and frees the 'socksp'.  */
 311 static void
 312 vport_del_socksp__(struct nl_sock **socksp, uint32_t n_socks)
 313 {
 314     size_t i;
 315
 316     for (i = 0; i < n_socks; i++) {
 317         nl_sock_destroy(socksp[i]);
 318     }
 319
 320     free(socksp);
 321 }
 322
 323 /* Creates an array of netlink sockets.  Returns an array of the
 324  * corresponding pointers.  Records the error in 'error'. */
 325 static struct nl_sock **
 326 vport_create_socksp__(uint32_t n_socks, int *error)
 327 {
 328     struct nl_sock **socksp = xzalloc(n_socks * sizeof *socksp);
 329     size_t i;
 330
 331     for (i = 0; i < n_socks; i++) {
 332         *error = nl_sock_create(NETLINK_GENERIC, &socksp[i]);
 333         if (*error) {
 334             goto error;
 335         }
 336     }
 337
 338     return socksp;
 339
 340 error:
 341     vport_del_socksp__(socksp, n_socks);
 342
 343     return NULL;
 344 }
 345
 346 #ifdef _WIN32
 347 static void
 348 vport_delete_sock_pool(struct dpif_handler *handler)
 349     OVS_REQ_WRLOCK(dpif->upcall_lock)
 350 {
 351     if (handler->vport_sock_pool) {
 352         uint32_t i;
 353         struct dpif_windows_vport_sock *sock_pool =
 354             handler->vport_sock_pool;
 355
 356         for (i = 0; i < VPORT_SOCK_POOL_SIZE; i++) {
 357             if (sock_pool[i].nl_sock) {
 358                 nl_sock_unsubscribe_packets(sock_pool[i].nl_sock);
 359                 nl_sock_destroy(sock_pool[i].nl_sock);
 360                 sock_pool[i].nl_sock = NULL;
 361             }
 362         }
 363
 364         free(handler->vport_sock_pool);
 365         handler->vport_sock_pool = NULL;
 366     }
 367 }
 368
 369 static int
 370 vport_create_sock_pool(struct dpif_handler *handler)
 371     OVS_REQ_WRLOCK(dpif->upcall_lock)
 372 {
 373     struct dpif_windows_vport_sock *sock_pool;
 374     size_t i;
 375     int error = 0;
 376
 377     sock_pool = xzalloc(VPORT_SOCK_POOL_SIZE * sizeof *sock_pool);
 378     for (i = 0; i < VPORT_SOCK_POOL_SIZE; i++) {
 379         error = nl_sock_create(NETLINK_GENERIC, &sock_pool[i].nl_sock);
 380         if (error) {
 381             goto error;
 382         }
 383
 384         /* Enable the netlink socket to receive packets.  This is equivalent to
 385          * calling nl_sock_join_mcgroup() to receive events. */
 386         error = nl_sock_subscribe_packets(sock_pool[i].nl_sock);
 387         if (error) {
 388            goto error;
 389         }
 390     }
 391
 392     handler->vport_sock_pool = sock_pool;
 393     handler->last_used_pool_idx = 0;
 394     return 0;
 395
 396 error:
 397     vport_delete_sock_pool(handler);
 398     return error;
 399 }
 400
 401 /* Returns an array pointers to netlink sockets.  The sockets are picked from a
 402  * pool. Records the error in 'error'. */
 403 static struct nl_sock **
 404 vport_create_socksp_windows(struct dpif_netlink *dpif, int *error)
 405     OVS_REQ_WRLOCK(dpif->upcall_lock)
 406 {
 407     uint32_t n_socks = dpif->n_handlers;
 408     struct nl_sock **socksp;
 409     size_t i;
 410
 411     ovs_assert(n_socks <= 1);
 412     socksp = xzalloc(n_socks * sizeof *socksp);
 413
 414     /* Pick netlink sockets to use in a round-robin fashion from each
 415      * handler's pool of sockets. */
 416     for (i = 0; i < n_socks; i++) {
 417         struct dpif_handler *handler = &dpif->handlers[i];
 418         struct dpif_windows_vport_sock *sock_pool = handler->vport_sock_pool;
 419         size_t index = handler->last_used_pool_idx;
 420
 421         /* A pool of sockets is allocated when the handler is initialized. */
 422         if (sock_pool == NULL) {
 423             free(socksp);
 424             *error = EINVAL;
 425             return NULL;
 426         }
 427
 428         ovs_assert(index < VPORT_SOCK_POOL_SIZE);
 429         socksp[i] = sock_pool[index].nl_sock;
 430         socksp[i] = sock_pool[index].nl_sock;
 431         ovs_assert(socksp[i]);
 432         index = (index == VPORT_SOCK_POOL_SIZE - 1) ? 0 : index + 1;
 433         handler->last_used_pool_idx = index;
 434     }
 435
 436     return socksp;
 437 }
 438
 439 static void
 440 vport_del_socksp_windows(struct dpif_netlink *dpif, struct nl_sock **socksp)
 441 {
 442     free(socksp);
 443 }
 444 #endif /* _WIN32 */
 445
 446 static struct nl_sock **
 447 vport_create_socksp(struct dpif_netlink *dpif, int *error)
 448 {
 449 #ifdef _WIN32
 450     return vport_create_socksp_windows(dpif, error);
 451 #else
 452     return vport_create_socksp__(dpif->n_handlers, error);
 453 #endif
 454 }
 455
 456 static void
 457 vport_del_socksp(struct dpif_netlink *dpif, struct nl_sock **socksp)
 458 {
 459 #ifdef _WIN32
 460     vport_del_socksp_windows(dpif, socksp);
 461 #else
 462     vport_del_socksp__(socksp, dpif->n_handlers);
 463 #endif
 464 }
 465
 466 /* Given the array of pointers to netlink sockets 'socksp', returns
 467  * the array of corresponding pids. If the 'socksp' is NULL, returns
 468  * a single-element array of value 0. */
 469 static uint32_t *
 470 vport_socksp_to_pids(struct nl_sock **socksp, uint32_t n_socks)
 471 {
 472     uint32_t *pids;
 473
 474     if (!socksp) {
 475         pids = xzalloc(sizeof *pids);
 476     } else {
 477         size_t i;
 478
 479         pids = xzalloc(n_socks * sizeof *pids);
 480         for (i = 0; i < n_socks; i++) {
 481             pids[i] = nl_sock_pid(socksp[i]);
 482         }
 483     }
 484
 485     return pids;
 486 }
 487
 488 /* Given the port number 'port_idx', extracts the pids of netlink sockets
 489  * associated to the port and assigns it to 'upcall_pids'. */
 490 static bool
 491 vport_get_pids(struct dpif_netlink *dpif, uint32_t port_idx,
 492                uint32_t **upcall_pids)
 493 {
 494     uint32_t *pids;
 495     size_t i;
 496
 497     /* Since the nl_sock can only be assigned in either all
 498      * or none "dpif->handlers" channels, the following check
 499      * would suffice. */
 500     if (!dpif->handlers[0].channels[port_idx].sock) {
 501         return false;
 502     }
 503     ovs_assert(!WINDOWS || dpif->n_handlers <= 1);
 504
 505     pids = xzalloc(dpif->n_handlers * sizeof *pids);
 506
 507     for (i = 0; i < dpif->n_handlers; i++) {
 508         pids[i] = nl_sock_pid(dpif->handlers[i].channels[port_idx].sock);
 509     }
 510
 511     *upcall_pids = pids;
 512
 513     return true;
 514 }
 515
 516 static int
 517 vport_add_channels(struct dpif_netlink *dpif, odp_port_t port_no,
 518                    struct nl_sock **socksp)
 519 {
 520     struct epoll_event event;
 521     uint32_t port_idx = odp_to_u32(port_no);
 522     size_t i, j;
 523     int error;
 524
 525     if (dpif->handlers == NULL) {
 526         return 0;
 527     }
 528
 529     /* We assume that the datapath densely chooses port numbers, which can
 530      * therefore be used as an index into 'channels' and 'epoll_events' of
 531      * 'dpif->handler'. */
 532     if (port_idx >= dpif->uc_array_size) {
 533         uint32_t new_size = port_idx + 1;
 534
 535         if (new_size > MAX_PORTS) {
 536             VLOG_WARN_RL(&error_rl, "%s: datapath port %"PRIu32" too big",
 537                          dpif_name(&dpif->dpif), port_no);
 538             return EFBIG;
 539         }
 540
 541         for (i = 0; i < dpif->n_handlers; i++) {
 542             struct dpif_handler *handler = &dpif->handlers[i];
 543
 544             handler->channels = xrealloc(handler->channels,
 545                                          new_size * sizeof *handler->channels);
 546
 547             for (j = dpif->uc_array_size; j < new_size; j++) {
 548                 handler->channels[j].sock = NULL;
 549             }
 550
 551             handler->epoll_events = xrealloc(handler->epoll_events,
 552                 new_size * sizeof *handler->epoll_events);
 553
 554         }
 555         dpif->uc_array_size = new_size;
 556     }
 557
 558     memset(&event, 0, sizeof event);
 559     event.events = EPOLLIN;
 560     event.data.u32 = port_idx;
 561
 562     for (i = 0; i < dpif->n_handlers; i++) {
 563         struct dpif_handler *handler = &dpif->handlers[i];
 564
 565 #ifndef _WIN32
 566         if (epoll_ctl(handler->epoll_fd, EPOLL_CTL_ADD, nl_sock_fd(socksp[i]),
 567                       &event) < 0) {
 568             error = errno;
 569             goto error;
 570         }
 571 #endif
 572         dpif->handlers[i].channels[port_idx].sock = socksp[i];
 573         dpif->handlers[i].channels[port_idx].last_poll = LLONG_MIN;
 574     }
 575
 576     return 0;
 577
 578 error:
 579     for (j = 0; j < i; j++) {
 580 #ifndef _WIN32
 581         epoll_ctl(dpif->handlers[j].epoll_fd, EPOLL_CTL_DEL,
 582                   nl_sock_fd(socksp[j]), NULL);
 583 #endif
 584         dpif->handlers[j].channels[port_idx].sock = NULL;
 585     }
 586
 587     return error;
 588 }
 589
 590 static void
 591 vport_del_channels(struct dpif_netlink *dpif, odp_port_t port_no)
 592 {
 593     uint32_t port_idx = odp_to_u32(port_no);
 594     size_t i;
 595
 596     if (!dpif->handlers || port_idx >= dpif->uc_array_size) {
 597         return;
 598     }
 599
 600     /* Since the sock can only be assigned in either all or none
 601      * of "dpif->handlers" channels, the following check would
 602      * suffice. */
 603     if (!dpif->handlers[0].channels[port_idx].sock) {
 604         return;
 605     }
 606
 607     for (i = 0; i < dpif->n_handlers; i++) {
 608         struct dpif_handler *handler = &dpif->handlers[i];
 609 #ifndef _WIN32
 610         epoll_ctl(handler->epoll_fd, EPOLL_CTL_DEL,
 611                   nl_sock_fd(handler->channels[port_idx].sock), NULL);
 612         nl_sock_destroy(handler->channels[port_idx].sock);
 613 #endif
 614         handler->channels[port_idx].sock = NULL;
 615         handler->event_offset = handler->n_events = 0;
 616     }
 617 }
 618
 619 static void
 620 destroy_all_channels(struct dpif_netlink *dpif)
 621     OVS_REQ_WRLOCK(dpif->upcall_lock)
 622 {
 623     unsigned int i;
 624
 625     if (!dpif->handlers) {
 626         return;
 627     }
 628
 629     for (i = 0; i < dpif->uc_array_size; i++ ) {
 630         struct dpif_netlink_vport vport_request;
 631         uint32_t upcall_pids = 0;
 632
 633         /* Since the sock can only be assigned in either all or none
 634          * of "dpif->handlers" channels, the following check would
 635          * suffice. */
 636         if (!dpif->handlers[0].channels[i].sock) {
 637             continue;
 638         }
 639
 640         /* Turn off upcalls. */
 641         dpif_netlink_vport_init(&vport_request);
 642         vport_request.cmd = OVS_VPORT_CMD_SET;
 643         vport_request.dp_ifindex = dpif->dp_ifindex;
 644         vport_request.port_no = u32_to_odp(i);
 645         vport_request.upcall_pids = &upcall_pids;
 646         dpif_netlink_vport_transact(&vport_request, NULL, NULL);
 647
 648         vport_del_channels(dpif, u32_to_odp(i));
 649     }
 650
 651     for (i = 0; i < dpif->n_handlers; i++) {
 652         struct dpif_handler *handler = &dpif->handlers[i];
 653
 654         dpif_netlink_handler_uninit(handler);
 655         free(handler->epoll_events);
 656         free(handler->channels);
 657     }
 658
 659     free(dpif->handlers);
 660     dpif->handlers = NULL;
 661     dpif->n_handlers = 0;
 662     dpif->uc_array_size = 0;
 663 }
 664
 665 static void
 666 dpif_netlink_close(struct dpif *dpif_)
 667 {
 668     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 669
 670     nl_sock_destroy(dpif->port_notifier);
 671
 672     fat_rwlock_wrlock(&dpif->upcall_lock);
 673     destroy_all_channels(dpif);
 674     fat_rwlock_unlock(&dpif->upcall_lock);
 675
 676     fat_rwlock_destroy(&dpif->upcall_lock);
 677     free(dpif);
 678 }
 679
 680 static int
 681 dpif_netlink_destroy(struct dpif *dpif_)
 682 {
 683     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 684     struct dpif_netlink_dp dp;
 685
 686     dpif_netlink_dp_init(&dp);
 687     dp.cmd = OVS_DP_CMD_DEL;
 688     dp.dp_ifindex = dpif->dp_ifindex;
 689     return dpif_netlink_dp_transact(&dp, NULL, NULL);
 690 }
 691
 692 static bool
 693 dpif_netlink_run(struct dpif *dpif_)
 694 {
 695     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 696
 697     if (dpif->refresh_channels) {
 698         dpif->refresh_channels = false;
 699         fat_rwlock_wrlock(&dpif->upcall_lock);
 700         dpif_netlink_refresh_channels(dpif, dpif->n_handlers);
 701         fat_rwlock_unlock(&dpif->upcall_lock);
 702     }
 703     return false;
 704 }
 705
 706 static int
 707 dpif_netlink_get_stats(const struct dpif *dpif_, struct dpif_dp_stats *stats)
 708 {
 709     struct dpif_netlink_dp dp;
 710     struct ofpbuf *buf;
 711     int error;
 712
 713     error = dpif_netlink_dp_get(dpif_, &dp, &buf);
 714     if (!error) {
 715         memset(stats, 0, sizeof *stats);
 716
 717         if (dp.stats) {
 718             stats->n_hit    = get_32aligned_u64(&dp.stats->n_hit);
 719             stats->n_missed = get_32aligned_u64(&dp.stats->n_missed);
 720             stats->n_lost   = get_32aligned_u64(&dp.stats->n_lost);
 721             stats->n_flows  = get_32aligned_u64(&dp.stats->n_flows);
 722         }
 723
 724         if (dp.megaflow_stats) {
 725             stats->n_masks = dp.megaflow_stats->n_masks;
 726             stats->n_mask_hit = get_32aligned_u64(
 727                 &dp.megaflow_stats->n_mask_hit);
 728         } else {
 729             stats->n_masks = UINT32_MAX;
 730             stats->n_mask_hit = UINT64_MAX;
 731         }
 732         ofpbuf_delete(buf);
 733     }
 734     return error;
 735 }
 736
 737 static const char *
 738 get_vport_type(const struct dpif_netlink_vport *vport)
 739 {
 740     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
 741
 742     switch (vport->type) {
 743     case OVS_VPORT_TYPE_NETDEV: {
 744         const char *type = netdev_get_type_from_name(vport->name);
 745
 746         return type ? type : "system";
 747     }
 748
 749     case OVS_VPORT_TYPE_INTERNAL:
 750         return "internal";
 751
 752     case OVS_VPORT_TYPE_GENEVE:
 753         return "geneve";
 754
 755     case OVS_VPORT_TYPE_GRE:
 756         return "gre";
 757
 758     case OVS_VPORT_TYPE_GRE64:
 759         return "gre64";
 760
 761     case OVS_VPORT_TYPE_VXLAN:
 762         return "vxlan";
 763
 764     case OVS_VPORT_TYPE_LISP:
 765         return "lisp";
 766
 767     case OVS_VPORT_TYPE_UNSPEC:
 768     case __OVS_VPORT_TYPE_MAX:
 769         break;
 770     }
 771
 772     VLOG_WARN_RL(&rl, "dp%d: port `%s' has unsupported type %u",
 773                  vport->dp_ifindex, vport->name, (unsigned int) vport->type);
 774     return "unknown";
 775 }
 776
 777 static enum ovs_vport_type
 778 netdev_to_ovs_vport_type(const struct netdev *netdev)
 779 {
 780     const char *type = netdev_get_type(netdev);
 781
 782     if (!strcmp(type, "tap") || !strcmp(type, "system")) {
 783         return OVS_VPORT_TYPE_NETDEV;
 784     } else if (!strcmp(type, "internal")) {
 785         return OVS_VPORT_TYPE_INTERNAL;
 786     } else if (!strcmp(type, "geneve")) {
 787         return OVS_VPORT_TYPE_GENEVE;
 788     } else if (strstr(type, "gre64")) {
 789         return OVS_VPORT_TYPE_GRE64;
 790     } else if (strstr(type, "gre")) {
 791         return OVS_VPORT_TYPE_GRE;
 792     } else if (!strcmp(type, "vxlan")) {
 793         return OVS_VPORT_TYPE_VXLAN;
 794     } else if (!strcmp(type, "lisp")) {
 795         return OVS_VPORT_TYPE_LISP;
 796     } else {
 797         return OVS_VPORT_TYPE_UNSPEC;
 798     }
 799 }
 800
 801 static int
 802 dpif_netlink_port_add__(struct dpif_netlink *dpif, struct netdev *netdev,
 803                         odp_port_t *port_nop)
 804     OVS_REQ_WRLOCK(dpif->upcall_lock)
 805 {
 806     const struct netdev_tunnel_config *tnl_cfg;
 807     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
 808     const char *name = netdev_vport_get_dpif_port(netdev,
 809                                                   namebuf, sizeof namebuf);
 810     const char *type = netdev_get_type(netdev);
 811     struct dpif_netlink_vport request, reply;
 812     struct ofpbuf *buf;
 813     uint64_t options_stub[64 / 8];
 814     struct ofpbuf options;
 815     struct nl_sock **socksp = NULL;
 816     uint32_t *upcall_pids;
 817     int error = 0;
 818
 819     if (dpif->handlers) {
 820         socksp = vport_create_socksp(dpif, &error);
 821         if (!socksp) {
 822             return error;
 823         }
 824     }
 825
 826     dpif_netlink_vport_init(&request);
 827     request.cmd = OVS_VPORT_CMD_NEW;
 828     request.dp_ifindex = dpif->dp_ifindex;
 829     request.type = netdev_to_ovs_vport_type(netdev);
 830     if (request.type == OVS_VPORT_TYPE_UNSPEC) {
 831         VLOG_WARN_RL(&error_rl, "%s: cannot create port `%s' because it has "
 832                      "unsupported type `%s'",
 833                      dpif_name(&dpif->dpif), name, type);
 834         vport_del_socksp(dpif, socksp);
 835         return EINVAL;
 836     }
 837     request.name = name;
 838
 839     if (request.type == OVS_VPORT_TYPE_NETDEV) {
 840 #ifdef _WIN32
 841         /* XXX : Map appropiate Windows handle */
 842 #else
 843         netdev_linux_ethtool_set_flag(netdev, ETH_FLAG_LRO, "LRO", false);
 844 #endif
 845     }
 846
 847     tnl_cfg = netdev_get_tunnel_config(netdev);
 848     if (tnl_cfg && tnl_cfg->dst_port != 0) {
 849         ofpbuf_use_stack(&options, options_stub, sizeof options_stub);
 850         nl_msg_put_u16(&options, OVS_TUNNEL_ATTR_DST_PORT,
 851                        ntohs(tnl_cfg->dst_port));
 852         request.options = ofpbuf_data(&options);
 853         request.options_len = ofpbuf_size(&options);
 854     }
 855
 856     request.port_no = *port_nop;
 857     upcall_pids = vport_socksp_to_pids(socksp, dpif->n_handlers);
 858     request.n_upcall_pids = socksp ? dpif->n_handlers : 1;
 859     request.upcall_pids = upcall_pids;
 860
 861     error = dpif_netlink_vport_transact(&request, &reply, &buf);
 862     if (!error) {
 863         *port_nop = reply.port_no;
 864     } else {
 865         if (error == EBUSY && *port_nop != ODPP_NONE) {
 866             VLOG_INFO("%s: requested port %"PRIu32" is in use",
 867                       dpif_name(&dpif->dpif), *port_nop);
 868         }
 869
 870         vport_del_socksp(dpif, socksp);
 871         goto exit;
 872     }
 873
 874     if (socksp) {
 875         error = vport_add_channels(dpif, *port_nop, socksp);
 876         if (error) {
 877             VLOG_INFO("%s: could not add channel for port %s",
 878                       dpif_name(&dpif->dpif), name);
 879
 880             /* Delete the port. */
 881             dpif_netlink_vport_init(&request);
 882             request.cmd = OVS_VPORT_CMD_DEL;
 883             request.dp_ifindex = dpif->dp_ifindex;
 884             request.port_no = *port_nop;
 885             dpif_netlink_vport_transact(&request, NULL, NULL);
 886             vport_del_socksp(dpif, socksp);
 887             goto exit;
 888         }
 889     }
 890     free(socksp);
 891
 892 exit:
 893     ofpbuf_delete(buf);
 894     free(upcall_pids);
 895
 896     return error;
 897 }
 898
 899 static int
 900 dpif_netlink_port_add(struct dpif *dpif_, struct netdev *netdev,
 901                       odp_port_t *port_nop)
 902 {
 903     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 904     int error;
 905
 906     fat_rwlock_wrlock(&dpif->upcall_lock);
 907     error = dpif_netlink_port_add__(dpif, netdev, port_nop);
 908     fat_rwlock_unlock(&dpif->upcall_lock);
 909
 910     return error;
 911 }
 912
 913 static int
 914 dpif_netlink_port_del__(struct dpif_netlink *dpif, odp_port_t port_no)
 915     OVS_REQ_WRLOCK(dpif->upcall_lock)
 916 {
 917     struct dpif_netlink_vport vport;
 918     int error;
 919
 920     dpif_netlink_vport_init(&vport);
 921     vport.cmd = OVS_VPORT_CMD_DEL;
 922     vport.dp_ifindex = dpif->dp_ifindex;
 923     vport.port_no = port_no;
 924     error = dpif_netlink_vport_transact(&vport, NULL, NULL);
 925
 926     vport_del_channels(dpif, port_no);
 927
 928     return error;
 929 }
 930
 931 static int
 932 dpif_netlink_port_del(struct dpif *dpif_, odp_port_t port_no)
 933 {
 934     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 935     int error;
 936
 937     fat_rwlock_wrlock(&dpif->upcall_lock);
 938     error = dpif_netlink_port_del__(dpif, port_no);
 939     fat_rwlock_unlock(&dpif->upcall_lock);
 940
 941     return error;
 942 }
 943
 944 static int
 945 dpif_netlink_port_query__(const struct dpif_netlink *dpif, odp_port_t port_no,
 946                           const char *port_name, struct dpif_port *dpif_port)
 947 {
 948     struct dpif_netlink_vport request;
 949     struct dpif_netlink_vport reply;
 950     struct ofpbuf *buf;
 951     int error;
 952
 953     dpif_netlink_vport_init(&request);
 954     request.cmd = OVS_VPORT_CMD_GET;
 955     request.dp_ifindex = dpif->dp_ifindex;
 956     request.port_no = port_no;
 957     request.name = port_name;
 958
 959     error = dpif_netlink_vport_transact(&request, &reply, &buf);
 960     if (!error) {
 961         if (reply.dp_ifindex != request.dp_ifindex) {
 962             /* A query by name reported that 'port_name' is in some datapath
 963              * other than 'dpif', but the caller wants to know about 'dpif'. */
 964             error = ENODEV;
 965         } else if (dpif_port) {
 966             dpif_port->name = xstrdup(reply.name);
 967             dpif_port->type = xstrdup(get_vport_type(&reply));
 968             dpif_port->port_no = reply.port_no;
 969         }
 970         ofpbuf_delete(buf);
 971     }
 972     return error;
 973 }
 974
 975 static int
 976 dpif_netlink_port_query_by_number(const struct dpif *dpif_, odp_port_t port_no,
 977                                   struct dpif_port *dpif_port)
 978 {
 979     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 980
 981     return dpif_netlink_port_query__(dpif, port_no, NULL, dpif_port);
 982 }
 983
 984 static int
 985 dpif_netlink_port_query_by_name(const struct dpif *dpif_, const char *devname,
 986                               struct dpif_port *dpif_port)
 987 {
 988     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
 989
 990     return dpif_netlink_port_query__(dpif, 0, devname, dpif_port);
 991 }
 992
 993 static uint32_t
 994 dpif_netlink_port_get_pid__(const struct dpif_netlink *dpif,
 995                             odp_port_t port_no, uint32_t hash)
 996     OVS_REQ_RDLOCK(dpif->upcall_lock)
 997 {
 998     uint32_t port_idx = odp_to_u32(port_no);
 999     uint32_t pid = 0;
1000
1001     if (dpif->handlers && dpif->uc_array_size > 0) {
1002         /* The ODPP_NONE "reserved" port number uses the "ovs-system"'s
1003          * channel, since it is not heavily loaded. */
1004         uint32_t idx = port_idx >= dpif->uc_array_size ? 0 : port_idx;
1005         struct dpif_handler *h = &dpif->handlers[hash % dpif->n_handlers];
1006
1007         /* Needs to check in case the socket pointer is changed in between
1008          * the holding of upcall_lock.  A known case happens when the main
1009          * thread deletes the vport while the handler thread is handling
1010          * the upcall from that port. */
1011         if (h->channels[idx].sock) {
1012             pid = nl_sock_pid(h->channels[idx].sock);
1013         }
1014     }
1015
1016     return pid;
1017 }
1018
1019 static uint32_t
1020 dpif_netlink_port_get_pid(const struct dpif *dpif_, odp_port_t port_no,
1021                           uint32_t hash)
1022 {
1023     const struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1024     uint32_t ret;
1025
1026     fat_rwlock_rdlock(&dpif->upcall_lock);
1027     ret = dpif_netlink_port_get_pid__(dpif, port_no, hash);
1028     fat_rwlock_unlock(&dpif->upcall_lock);
1029
1030     return ret;
1031 }
1032
1033 static int
1034 dpif_netlink_flow_flush(struct dpif *dpif_)
1035 {
1036     const struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1037     struct dpif_netlink_flow flow;
1038
1039     dpif_netlink_flow_init(&flow);
1040     flow.cmd = OVS_FLOW_CMD_DEL;
1041     flow.dp_ifindex = dpif->dp_ifindex;
1042     return dpif_netlink_flow_transact(&flow, NULL, NULL);
1043 }
1044
1045 struct dpif_netlink_port_state {
1046     struct nl_dump dump;
1047     struct ofpbuf buf;
1048 };
1049
1050 static void
1051 dpif_netlink_port_dump_start__(const struct dpif_netlink *dpif,
1052                                struct nl_dump *dump)
1053 {
1054     struct dpif_netlink_vport request;
1055     struct ofpbuf *buf;
1056
1057     dpif_netlink_vport_init(&request);
1058     request.cmd = OVS_VPORT_CMD_GET;
1059     request.dp_ifindex = dpif->dp_ifindex;
1060
1061     buf = ofpbuf_new(1024);
1062     dpif_netlink_vport_to_ofpbuf(&request, buf);
1063     nl_dump_start(dump, NETLINK_GENERIC, buf);
1064     ofpbuf_delete(buf);
1065 }
1066
1067 static int
1068 dpif_netlink_port_dump_start(const struct dpif *dpif_, void **statep)
1069 {
1070     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1071     struct dpif_netlink_port_state *state;
1072
1073     *statep = state = xmalloc(sizeof *state);
1074     dpif_netlink_port_dump_start__(dpif, &state->dump);
1075
1076     ofpbuf_init(&state->buf, NL_DUMP_BUFSIZE);
1077     return 0;
1078 }
1079
1080 static int
1081 dpif_netlink_port_dump_next__(const struct dpif_netlink *dpif,
1082                               struct nl_dump *dump,
1083                               struct dpif_netlink_vport *vport,
1084                               struct ofpbuf *buffer)
1085 {
1086     struct ofpbuf buf;
1087     int error;
1088
1089     if (!nl_dump_next(dump, &buf, buffer)) {
1090         return EOF;
1091     }
1092
1093     error = dpif_netlink_vport_from_ofpbuf(vport, &buf);
1094     if (error) {
1095         VLOG_WARN_RL(&error_rl, "%s: failed to parse vport record (%s)",
1096                      dpif_name(&dpif->dpif), ovs_strerror(error));
1097     }
1098     return error;
1099 }
1100
1101 static int
1102 dpif_netlink_port_dump_next(const struct dpif *dpif_, void *state_,
1103                             struct dpif_port *dpif_port)
1104 {
1105     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1106     struct dpif_netlink_port_state *state = state_;
1107     struct dpif_netlink_vport vport;
1108     int error;
1109
1110     error = dpif_netlink_port_dump_next__(dpif, &state->dump, &vport,
1111                                           &state->buf);
1112     if (error) {
1113         return error;
1114     }
1115     dpif_port->name = CONST_CAST(char *, vport.name);
1116     dpif_port->type = CONST_CAST(char *, get_vport_type(&vport));
1117     dpif_port->port_no = vport.port_no;
1118     return 0;
1119 }
1120
1121 static int
1122 dpif_netlink_port_dump_done(const struct dpif *dpif_ OVS_UNUSED, void *state_)
1123 {
1124     struct dpif_netlink_port_state *state = state_;
1125     int error = nl_dump_done(&state->dump);
1126
1127     ofpbuf_uninit(&state->buf);
1128     free(state);
1129     return error;
1130 }
1131
1132 static int
1133 dpif_netlink_port_poll(const struct dpif *dpif_, char **devnamep)
1134 {
1135     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1136
1137     /* Lazily create the Netlink socket to listen for notifications. */
1138     if (!dpif->port_notifier) {
1139         struct nl_sock *sock;
1140         int error;
1141
1142         error = nl_sock_create(NETLINK_GENERIC, &sock);
1143         if (error) {
1144             return error;
1145         }
1146
1147         error = nl_sock_join_mcgroup(sock, ovs_vport_mcgroup);
1148         if (error) {
1149             nl_sock_destroy(sock);
1150             return error;
1151         }
1152         dpif->port_notifier = sock;
1153
1154         /* We have no idea of the current state so report that everything
1155          * changed. */
1156         return ENOBUFS;
1157     }
1158
1159     for (;;) {
1160         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1161         uint64_t buf_stub[4096 / 8];
1162         struct ofpbuf buf;
1163         int error;
1164
1165         ofpbuf_use_stub(&buf, buf_stub, sizeof buf_stub);
1166         error = nl_sock_recv(dpif->port_notifier, &buf, false);
1167         if (!error) {
1168             struct dpif_netlink_vport vport;
1169
1170             error = dpif_netlink_vport_from_ofpbuf(&vport, &buf);
1171             if (!error) {
1172                 if (vport.dp_ifindex == dpif->dp_ifindex
1173                     && (vport.cmd == OVS_VPORT_CMD_NEW
1174                         || vport.cmd == OVS_VPORT_CMD_DEL
1175                         || vport.cmd == OVS_VPORT_CMD_SET)) {
1176                     VLOG_DBG("port_changed: dpif:%s vport:%s cmd:%"PRIu8,
1177                              dpif->dpif.full_name, vport.name, vport.cmd);
1178                     if (vport.cmd == OVS_VPORT_CMD_DEL && dpif->handlers) {
1179                         dpif->refresh_channels = true;
1180                     }
1181                     *devnamep = xstrdup(vport.name);
1182                     ofpbuf_uninit(&buf);
1183                     return 0;
1184                 }
1185             }
1186         } else if (error != EAGAIN) {
1187             VLOG_WARN_RL(&rl, "error reading or parsing netlink (%s)",
1188                          ovs_strerror(error));
1189             nl_sock_drain(dpif->port_notifier);
1190             error = ENOBUFS;
1191         }
1192
1193         ofpbuf_uninit(&buf);
1194         if (error) {
1195             return error;
1196         }
1197     }
1198 }
1199
1200 static void
1201 dpif_netlink_port_poll_wait(const struct dpif *dpif_)
1202 {
1203     const struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1204
1205     if (dpif->port_notifier) {
1206         nl_sock_wait(dpif->port_notifier, POLLIN);
1207     } else {
1208         poll_immediate_wake();
1209     }
1210 }
1211
1212 static void
1213 dpif_netlink_init_flow_get(const struct dpif_netlink *dpif,
1214                            const struct nlattr *key, size_t key_len,
1215                            struct dpif_netlink_flow *request)
1216 {
1217     dpif_netlink_flow_init(request);
1218     request->cmd = OVS_FLOW_CMD_GET;
1219     request->dp_ifindex = dpif->dp_ifindex;
1220     request->key = key;
1221     request->key_len = key_len;
1222 }
1223
1224 static int
1225 dpif_netlink_flow_get(const struct dpif_netlink *dpif,
1226                       const struct nlattr *key, size_t key_len,
1227                       struct dpif_netlink_flow *reply, struct ofpbuf **bufp)
1228 {
1229     struct dpif_netlink_flow request;
1230
1231     dpif_netlink_init_flow_get(dpif, key, key_len, &request);
1232     return dpif_netlink_flow_transact(&request, reply, bufp);
1233 }
1234
1235 static void
1236 dpif_netlink_init_flow_put(struct dpif_netlink *dpif,
1237                            const struct dpif_flow_put *put,
1238                            struct dpif_netlink_flow *request)
1239 {
1240     static const struct nlattr dummy_action;
1241
1242     dpif_netlink_flow_init(request);
1243     request->cmd = (put->flags & DPIF_FP_CREATE
1244                     ? OVS_FLOW_CMD_NEW : OVS_FLOW_CMD_SET);
1245     request->dp_ifindex = dpif->dp_ifindex;
1246     request->key = put->key;
1247     request->key_len = put->key_len;
1248     request->mask = put->mask;
1249     request->mask_len = put->mask_len;
1250     /* Ensure that OVS_FLOW_ATTR_ACTIONS will always be included. */
1251     request->actions = (put->actions
1252                         ? put->actions
1253                         : CONST_CAST(struct nlattr *, &dummy_action));
1254     request->actions_len = put->actions_len;
1255     if (put->flags & DPIF_FP_ZERO_STATS) {
1256         request->clear = true;
1257     }
1258     if (put->flags & DPIF_FP_PROBE) {
1259         request->probe = true;
1260     }
1261     request->nlmsg_flags = put->flags & DPIF_FP_MODIFY ? 0 : NLM_F_CREATE;
1262 }
1263
1264 static void
1265 dpif_netlink_init_flow_del(struct dpif_netlink *dpif,
1266                            const struct dpif_flow_del *del,
1267                            struct dpif_netlink_flow *request)
1268 {
1269     dpif_netlink_flow_init(request);
1270     request->cmd = OVS_FLOW_CMD_DEL;
1271     request->dp_ifindex = dpif->dp_ifindex;
1272     request->key = del->key;
1273     request->key_len = del->key_len;
1274 }
1275
1276 struct dpif_netlink_flow_dump {
1277     struct dpif_flow_dump up;
1278     struct nl_dump nl_dump;
1279     atomic_int status;
1280 };
1281
1282 static struct dpif_netlink_flow_dump *
1283 dpif_netlink_flow_dump_cast(struct dpif_flow_dump *dump)
1284 {
1285     return CONTAINER_OF(dump, struct dpif_netlink_flow_dump, up);
1286 }
1287
1288 static struct dpif_flow_dump *
1289 dpif_netlink_flow_dump_create(const struct dpif *dpif_)
1290 {
1291     const struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1292     struct dpif_netlink_flow_dump *dump;
1293     struct dpif_netlink_flow request;
1294     struct ofpbuf *buf;
1295
1296     dump = xmalloc(sizeof *dump);
1297     dpif_flow_dump_init(&dump->up, dpif_);
1298
1299     dpif_netlink_flow_init(&request);
1300     request.cmd = OVS_FLOW_CMD_GET;
1301     request.dp_ifindex = dpif->dp_ifindex;
1302
1303     buf = ofpbuf_new(1024);
1304     dpif_netlink_flow_to_ofpbuf(&request, buf);
1305     nl_dump_start(&dump->nl_dump, NETLINK_GENERIC, buf);
1306     ofpbuf_delete(buf);
1307     atomic_init(&dump->status, 0);
1308
1309     return &dump->up;
1310 }
1311
1312 static int
1313 dpif_netlink_flow_dump_destroy(struct dpif_flow_dump *dump_)
1314 {
1315     struct dpif_netlink_flow_dump *dump = dpif_netlink_flow_dump_cast(dump_);
1316     unsigned int nl_status = nl_dump_done(&dump->nl_dump);
1317     int dump_status;
1318
1319     /* No other thread has access to 'dump' at this point. */
1320     atomic_read_relaxed(&dump->status, &dump_status);
1321     free(dump);
1322     return dump_status ? dump_status : nl_status;
1323 }
1324
1325 struct dpif_netlink_flow_dump_thread {
1326     struct dpif_flow_dump_thread up;
1327     struct dpif_netlink_flow_dump *dump;
1328     struct dpif_netlink_flow flow;
1329     struct dpif_flow_stats stats;
1330     struct ofpbuf nl_flows;     /* Always used to store flows. */
1331     struct ofpbuf *nl_actions;  /* Used if kernel does not supply actions. */
1332 };
1333
1334 static struct dpif_netlink_flow_dump_thread *
1335 dpif_netlink_flow_dump_thread_cast(struct dpif_flow_dump_thread *thread)
1336 {
1337     return CONTAINER_OF(thread, struct dpif_netlink_flow_dump_thread, up);
1338 }
1339
1340 static struct dpif_flow_dump_thread *
1341 dpif_netlink_flow_dump_thread_create(struct dpif_flow_dump *dump_)
1342 {
1343     struct dpif_netlink_flow_dump *dump = dpif_netlink_flow_dump_cast(dump_);
1344     struct dpif_netlink_flow_dump_thread *thread;
1345
1346     thread = xmalloc(sizeof *thread);
1347     dpif_flow_dump_thread_init(&thread->up, &dump->up);
1348     thread->dump = dump;
1349     ofpbuf_init(&thread->nl_flows, NL_DUMP_BUFSIZE);
1350     thread->nl_actions = NULL;
1351
1352     return &thread->up;
1353 }
1354
1355 static void
1356 dpif_netlink_flow_dump_thread_destroy(struct dpif_flow_dump_thread *thread_)
1357 {
1358     struct dpif_netlink_flow_dump_thread *thread
1359         = dpif_netlink_flow_dump_thread_cast(thread_);
1360
1361     ofpbuf_uninit(&thread->nl_flows);
1362     ofpbuf_delete(thread->nl_actions);
1363     free(thread);
1364 }
1365
1366 static void
1367 dpif_netlink_flow_to_dpif_flow(struct dpif_flow *dpif_flow,
1368                                const struct dpif_netlink_flow *datapath_flow)
1369 {
1370     dpif_flow->key = datapath_flow->key;
1371     dpif_flow->key_len = datapath_flow->key_len;
1372     dpif_flow->mask = datapath_flow->mask;
1373     dpif_flow->mask_len = datapath_flow->mask_len;
1374     dpif_flow->actions = datapath_flow->actions;
1375     dpif_flow->actions_len = datapath_flow->actions_len;
1376     dpif_netlink_flow_get_stats(datapath_flow, &dpif_flow->stats);
1377 }
1378
1379 static int
1380 dpif_netlink_flow_dump_next(struct dpif_flow_dump_thread *thread_,
1381                             struct dpif_flow *flows, int max_flows)
1382 {
1383     struct dpif_netlink_flow_dump_thread *thread
1384         = dpif_netlink_flow_dump_thread_cast(thread_);
1385     struct dpif_netlink_flow_dump *dump = thread->dump;
1386     struct dpif_netlink *dpif = dpif_netlink_cast(thread->up.dpif);
1387     int n_flows;
1388
1389     ofpbuf_delete(thread->nl_actions);
1390     thread->nl_actions = NULL;
1391
1392     n_flows = 0;
1393     while (!n_flows
1394            || (n_flows < max_flows && ofpbuf_size(&thread->nl_flows))) {
1395         struct dpif_netlink_flow datapath_flow;
1396         struct ofpbuf nl_flow;
1397         int error;
1398
1399         /* Try to grab another flow. */
1400         if (!nl_dump_next(&dump->nl_dump, &nl_flow, &thread->nl_flows)) {
1401             break;
1402         }
1403
1404         /* Convert the flow to our output format. */
1405         error = dpif_netlink_flow_from_ofpbuf(&datapath_flow, &nl_flow);
1406         if (error) {
1407             atomic_store_relaxed(&dump->status, error);
1408             break;
1409         }
1410
1411         if (datapath_flow.actions) {
1412             /* Common case: the flow includes actions. */
1413             dpif_netlink_flow_to_dpif_flow(&flows[n_flows++], &datapath_flow);
1414         } else {
1415             /* Rare case: the flow does not include actions.  Retrieve this
1416              * individual flow again to get the actions. */
1417             error = dpif_netlink_flow_get(dpif, datapath_flow.key,
1418                                           datapath_flow.key_len,
1419                                           &datapath_flow, &thread->nl_actions);
1420             if (error == ENOENT) {
1421                 VLOG_DBG("dumped flow disappeared on get");
1422                 continue;
1423             } else if (error) {
1424                 VLOG_WARN("error fetching dumped flow: %s",
1425                           ovs_strerror(error));
1426                 atomic_store_relaxed(&dump->status, error);
1427                 break;
1428             }
1429
1430             /* Save this flow.  Then exit, because we only have one buffer to
1431              * handle this case. */
1432             dpif_netlink_flow_to_dpif_flow(&flows[n_flows++], &datapath_flow);
1433             break;
1434         }
1435     }
1436     return n_flows;
1437 }
1438
1439 static void
1440 dpif_netlink_encode_execute(int dp_ifindex, const struct dpif_execute *d_exec,
1441                             struct ofpbuf *buf)
1442 {
1443     struct ovs_header *k_exec;
1444     size_t key_ofs;
1445
1446     ofpbuf_prealloc_tailroom(buf, (64
1447                                    + ofpbuf_size(d_exec->packet)
1448                                    + ODP_KEY_METADATA_SIZE
1449                                    + d_exec->actions_len));
1450
1451     nl_msg_put_genlmsghdr(buf, 0, ovs_packet_family, NLM_F_REQUEST,
1452                           OVS_PACKET_CMD_EXECUTE, OVS_PACKET_VERSION);
1453
1454     k_exec = ofpbuf_put_uninit(buf, sizeof *k_exec);
1455     k_exec->dp_ifindex = dp_ifindex;
1456
1457     nl_msg_put_unspec(buf, OVS_PACKET_ATTR_PACKET,
1458                       ofpbuf_data(d_exec->packet),
1459                       ofpbuf_size(d_exec->packet));
1460
1461     key_ofs = nl_msg_start_nested(buf, OVS_PACKET_ATTR_KEY);
1462     odp_key_from_pkt_metadata(buf, &d_exec->md);
1463     nl_msg_end_nested(buf, key_ofs);
1464
1465     nl_msg_put_unspec(buf, OVS_PACKET_ATTR_ACTIONS,
1466                       d_exec->actions, d_exec->actions_len);
1467     if (d_exec->probe) {
1468         nl_msg_put_flag(buf, OVS_FLOW_ATTR_PROBE);
1469     }
1470 }
1471
1472 #define MAX_OPS 50
1473
1474 static void
1475 dpif_netlink_operate__(struct dpif_netlink *dpif,
1476                        struct dpif_op **ops, size_t n_ops)
1477 {
1478     struct op_auxdata {
1479         struct nl_transaction txn;
1480
1481         struct ofpbuf request;
1482         uint64_t request_stub[1024 / 8];
1483
1484         struct ofpbuf reply;
1485         uint64_t reply_stub[1024 / 8];
1486     } auxes[MAX_OPS];
1487
1488     struct nl_transaction *txnsp[MAX_OPS];
1489     size_t i;
1490
1491     ovs_assert(n_ops <= MAX_OPS);
1492     for (i = 0; i < n_ops; i++) {
1493         struct op_auxdata *aux = &auxes[i];
1494         struct dpif_op *op = ops[i];
1495         struct dpif_flow_put *put;
1496         struct dpif_flow_del *del;
1497         struct dpif_execute *execute;
1498         struct dpif_flow_get *get;
1499         struct dpif_netlink_flow flow;
1500
1501         ofpbuf_use_stub(&aux->request,
1502                         aux->request_stub, sizeof aux->request_stub);
1503         aux->txn.request = &aux->request;
1504
1505         ofpbuf_use_stub(&aux->reply, aux->reply_stub, sizeof aux->reply_stub);
1506         aux->txn.reply = NULL;
1507
1508         switch (op->type) {
1509         case DPIF_OP_FLOW_PUT:
1510             put = &op->u.flow_put;
1511             dpif_netlink_init_flow_put(dpif, put, &flow);
1512             if (put->stats) {
1513                 flow.nlmsg_flags |= NLM_F_ECHO;
1514                 aux->txn.reply = &aux->reply;
1515             }
1516             dpif_netlink_flow_to_ofpbuf(&flow, &aux->request);
1517             break;
1518
1519         case DPIF_OP_FLOW_DEL:
1520             del = &op->u.flow_del;
1521             dpif_netlink_init_flow_del(dpif, del, &flow);
1522             if (del->stats) {
1523                 flow.nlmsg_flags |= NLM_F_ECHO;
1524                 aux->txn.reply = &aux->reply;
1525             }
1526             dpif_netlink_flow_to_ofpbuf(&flow, &aux->request);
1527             break;
1528
1529         case DPIF_OP_EXECUTE:
1530             execute = &op->u.execute;
1531             dpif_netlink_encode_execute(dpif->dp_ifindex, execute,
1532                                         &aux->request);
1533             break;
1534
1535         case DPIF_OP_FLOW_GET:
1536             get = &op->u.flow_get;
1537             dpif_netlink_init_flow_get(dpif, get->key, get->key_len, &flow);
1538             aux->txn.reply = get->buffer;
1539             dpif_netlink_flow_to_ofpbuf(&flow, &aux->request);
1540             break;
1541
1542         default:
1543             OVS_NOT_REACHED();
1544         }
1545     }
1546
1547     for (i = 0; i < n_ops; i++) {
1548         txnsp[i] = &auxes[i].txn;
1549     }
1550     nl_transact_multiple(NETLINK_GENERIC, txnsp, n_ops);
1551
1552     for (i = 0; i < n_ops; i++) {
1553         struct op_auxdata *aux = &auxes[i];
1554         struct nl_transaction *txn = &auxes[i].txn;
1555         struct dpif_op *op = ops[i];
1556         struct dpif_flow_put *put;
1557         struct dpif_flow_del *del;
1558         struct dpif_flow_get *get;
1559
1560         op->error = txn->error;
1561
1562         switch (op->type) {
1563         case DPIF_OP_FLOW_PUT:
1564             put = &op->u.flow_put;
1565             if (put->stats) {
1566                 if (!op->error) {
1567                     struct dpif_netlink_flow reply;
1568
1569                     op->error = dpif_netlink_flow_from_ofpbuf(&reply,
1570                                                               txn->reply);
1571                     if (!op->error) {
1572                         dpif_netlink_flow_get_stats(&reply, put->stats);
1573                     }
1574                 }
1575             }
1576             break;
1577
1578         case DPIF_OP_FLOW_DEL:
1579             del = &op->u.flow_del;
1580             if (del->stats) {
1581                 if (!op->error) {
1582                     struct dpif_netlink_flow reply;
1583
1584                     op->error = dpif_netlink_flow_from_ofpbuf(&reply,
1585                                                               txn->reply);
1586                     if (!op->error) {
1587                         dpif_netlink_flow_get_stats(&reply, del->stats);
1588                     }
1589                 }
1590             }
1591             break;
1592
1593         case DPIF_OP_EXECUTE:
1594             break;
1595
1596         case DPIF_OP_FLOW_GET:
1597             get = &op->u.flow_get;
1598             if (!op->error) {
1599                 struct dpif_netlink_flow reply;
1600
1601                 op->error = dpif_netlink_flow_from_ofpbuf(&reply, txn->reply);
1602                 if (!op->error) {
1603                     dpif_netlink_flow_to_dpif_flow(get->flow, &reply);
1604                 }
1605             }
1606             break;
1607
1608         default:
1609             OVS_NOT_REACHED();
1610         }
1611
1612         ofpbuf_uninit(&aux->request);
1613         ofpbuf_uninit(&aux->reply);
1614     }
1615 }
1616
1617 static void
1618 dpif_netlink_operate(struct dpif *dpif_, struct dpif_op **ops, size_t n_ops)
1619 {
1620     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1621
1622     while (n_ops > 0) {
1623         size_t chunk = MIN(n_ops, MAX_OPS);
1624         dpif_netlink_operate__(dpif, ops, chunk);
1625         ops += chunk;
1626         n_ops -= chunk;
1627     }
1628 }
1629
1630 #if _WIN32
1631 static void
1632 dpif_netlink_handler_uninit(struct dpif_handler *handler)
1633 {
1634     vport_delete_sock_pool(handler);
1635 }
1636
1637 static int
1638 dpif_netlink_handler_init(struct dpif_handler *handler)
1639 {
1640     return vport_create_sock_pool(handler);
1641 }
1642 #else
1643
1644 static int
1645 dpif_netlink_handler_init(struct dpif_handler *handler)
1646 {
1647     handler->epoll_fd = epoll_create(10);
1648     return handler->epoll_fd < 0 ? errno : 0;
1649 }
1650
1651 static void
1652 dpif_netlink_handler_uninit(struct dpif_handler *handler)
1653 {
1654     close(handler->epoll_fd);
1655 }
1656 #endif
1657
1658 /* Synchronizes 'channels' in 'dpif->handlers'  with the set of vports
1659  * currently in 'dpif' in the kernel, by adding a new set of channels for
1660  * any kernel vport that lacks one and deleting any channels that have no
1661  * backing kernel vports. */
1662 static int
1663 dpif_netlink_refresh_channels(struct dpif_netlink *dpif, uint32_t n_handlers)
1664     OVS_REQ_WRLOCK(dpif->upcall_lock)
1665 {
1666     unsigned long int *keep_channels;
1667     struct dpif_netlink_vport vport;
1668     size_t keep_channels_nbits;
1669     struct nl_dump dump;
1670     uint64_t reply_stub[NL_DUMP_BUFSIZE / 8];
1671     struct ofpbuf buf;
1672     int retval = 0;
1673     size_t i;
1674
1675     ovs_assert(!WINDOWS || n_handlers <= 1);
1676     ovs_assert(!WINDOWS || dpif->n_handlers <= 1);
1677
1678     if (dpif->n_handlers != n_handlers) {
1679         destroy_all_channels(dpif);
1680         dpif->handlers = xzalloc(n_handlers * sizeof *dpif->handlers);
1681         for (i = 0; i < n_handlers; i++) {
1682             int error;
1683             struct dpif_handler *handler = &dpif->handlers[i];
1684
1685             error = dpif_netlink_handler_init(handler);
1686             if (error) {
1687                 size_t j;
1688                 struct dpif_handler *tmp = &dpif->handlers[i];
1689
1690
1691                 for (j = 0; j < i; j++) {
1692                     dpif_netlink_handler_uninit(tmp);
1693                 }
1694                 free(dpif->handlers);
1695                 dpif->handlers = NULL;
1696
1697                 return error;
1698             }
1699         }
1700         dpif->n_handlers = n_handlers;
1701     }
1702
1703     for (i = 0; i < n_handlers; i++) {
1704         struct dpif_handler *handler = &dpif->handlers[i];
1705
1706         handler->event_offset = handler->n_events = 0;
1707     }
1708
1709     keep_channels_nbits = dpif->uc_array_size;
1710     keep_channels = bitmap_allocate(keep_channels_nbits);
1711
1712     ofpbuf_use_stub(&buf, reply_stub, sizeof reply_stub);
1713     dpif_netlink_port_dump_start__(dpif, &dump);
1714     while (!dpif_netlink_port_dump_next__(dpif, &dump, &vport, &buf)) {
1715         uint32_t port_no = odp_to_u32(vport.port_no);
1716         uint32_t *upcall_pids = NULL;
1717         int error;
1718
1719         if (port_no >= dpif->uc_array_size
1720             || !vport_get_pids(dpif, port_no, &upcall_pids)) {
1721             struct nl_sock **socksp = vport_create_socksp(dpif, &error);
1722
1723             if (!socksp) {
1724                 goto error;
1725             }
1726
1727             error = vport_add_channels(dpif, vport.port_no, socksp);
1728             if (error) {
1729                 VLOG_INFO("%s: could not add channels for port %s",
1730                           dpif_name(&dpif->dpif), vport.name);
1731                 vport_del_socksp(dpif, socksp);
1732                 retval = error;
1733                 goto error;
1734             }
1735             upcall_pids = vport_socksp_to_pids(socksp, dpif->n_handlers);
1736             free(socksp);
1737         }
1738
1739         /* Configure the vport to deliver misses to 'sock'. */
1740         if (vport.upcall_pids[0] == 0
1741             || vport.n_upcall_pids != dpif->n_handlers
1742             || memcmp(upcall_pids, vport.upcall_pids, n_handlers * sizeof
1743                       *upcall_pids)) {
1744             struct dpif_netlink_vport vport_request;
1745
1746             dpif_netlink_vport_init(&vport_request);
1747             vport_request.cmd = OVS_VPORT_CMD_SET;
1748             vport_request.dp_ifindex = dpif->dp_ifindex;
1749             vport_request.port_no = vport.port_no;
1750             vport_request.n_upcall_pids = dpif->n_handlers;
1751             vport_request.upcall_pids = upcall_pids;
1752             error = dpif_netlink_vport_transact(&vport_request, NULL, NULL);
1753             if (error) {
1754                 VLOG_WARN_RL(&error_rl,
1755                              "%s: failed to set upcall pid on port: %s",
1756                              dpif_name(&dpif->dpif), ovs_strerror(error));
1757
1758                 if (error != ENODEV && error != ENOENT) {
1759                     retval = error;
1760                 } else {
1761                     /* The vport isn't really there, even though the dump says
1762                      * it is.  Probably we just hit a race after a port
1763                      * disappeared. */
1764                 }
1765                 goto error;
1766             }
1767         }
1768
1769         if (port_no < keep_channels_nbits) {
1770             bitmap_set1(keep_channels, port_no);
1771         }
1772         free(upcall_pids);
1773         continue;
1774
1775     error:
1776         free(upcall_pids);
1777         vport_del_channels(dpif, vport.port_no);
1778     }
1779     nl_dump_done(&dump);
1780     ofpbuf_uninit(&buf);
1781
1782     /* Discard any saved channels that we didn't reuse. */
1783     for (i = 0; i < keep_channels_nbits; i++) {
1784         if (!bitmap_is_set(keep_channels, i)) {
1785             vport_del_channels(dpif, u32_to_odp(i));
1786         }
1787     }
1788     free(keep_channels);
1789
1790     return retval;
1791 }
1792
1793 static int
1794 dpif_netlink_recv_set__(struct dpif_netlink *dpif, bool enable)
1795     OVS_REQ_WRLOCK(dpif->upcall_lock)
1796 {
1797     if ((dpif->handlers != NULL) == enable) {
1798         return 0;
1799     } else if (!enable) {
1800         destroy_all_channels(dpif);
1801         return 0;
1802     } else {
1803         return dpif_netlink_refresh_channels(dpif, 1);
1804     }
1805 }
1806
1807 static int
1808 dpif_netlink_recv_set(struct dpif *dpif_, bool enable)
1809 {
1810     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1811     int error;
1812
1813     fat_rwlock_wrlock(&dpif->upcall_lock);
1814     error = dpif_netlink_recv_set__(dpif, enable);
1815     fat_rwlock_unlock(&dpif->upcall_lock);
1816
1817     return error;
1818 }
1819
1820 static int
1821 dpif_netlink_handlers_set(struct dpif *dpif_, uint32_t n_handlers)
1822 {
1823     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
1824     int error = 0;
1825
1826 #ifdef _WIN32
1827     /* Multiple upcall handlers will be supported once kernel datapath supports
1828      * it. */
1829     if (n_handlers > 1) {
1830         return error;
1831     }
1832 #endif
1833
1834     fat_rwlock_wrlock(&dpif->upcall_lock);
1835     if (dpif->handlers) {
1836         error = dpif_netlink_refresh_channels(dpif, n_handlers);
1837     }
1838     fat_rwlock_unlock(&dpif->upcall_lock);
1839
1840     return error;
1841 }
1842
1843 static int
1844 dpif_netlink_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
1845                              uint32_t queue_id, uint32_t *priority)
1846 {
1847     if (queue_id < 0xf000) {
1848         *priority = TC_H_MAKE(1 << 16, queue_id + 1);
1849         return 0;
1850     } else {
1851         return EINVAL;
1852     }
1853 }
1854
1855 static int
1856 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall,
1857                  int *dp_ifindex)
1858 {
1859     static const struct nl_policy ovs_packet_policy[] = {
1860         /* Always present. */
1861         [OVS_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
1862                                      .min_len = ETH_HEADER_LEN },
1863         [OVS_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
1864
1865         /* OVS_PACKET_CMD_ACTION only. */
1866         [OVS_PACKET_ATTR_USERDATA] = { .type = NL_A_UNSPEC, .optional = true },
1867         [OVS_PACKET_ATTR_EGRESS_TUN_KEY] = { .type = NL_A_NESTED, .optional = true },
1868     };
1869
1870     struct ovs_header *ovs_header;
1871     struct nlattr *a[ARRAY_SIZE(ovs_packet_policy)];
1872     struct nlmsghdr *nlmsg;
1873     struct genlmsghdr *genl;
1874     struct ofpbuf b;
1875     int type;
1876
1877     ofpbuf_use_const(&b, ofpbuf_data(buf), ofpbuf_size(buf));
1878
1879     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
1880     genl = ofpbuf_try_pull(&b, sizeof *genl);
1881     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
1882     if (!nlmsg || !genl || !ovs_header
1883         || nlmsg->nlmsg_type != ovs_packet_family
1884         || !nl_policy_parse(&b, 0, ovs_packet_policy, a,
1885                             ARRAY_SIZE(ovs_packet_policy))) {
1886         return EINVAL;
1887     }
1888
1889     type = (genl->cmd == OVS_PACKET_CMD_MISS ? DPIF_UC_MISS
1890             : genl->cmd == OVS_PACKET_CMD_ACTION ? DPIF_UC_ACTION
1891             : -1);
1892     if (type < 0) {
1893         return EINVAL;
1894     }
1895
1896     /* (Re)set ALL fields of '*upcall' on successful return. */
1897     upcall->type = type;
1898     upcall->key = CONST_CAST(struct nlattr *,
1899                              nl_attr_get(a[OVS_PACKET_ATTR_KEY]));
1900     upcall->key_len = nl_attr_get_size(a[OVS_PACKET_ATTR_KEY]);
1901     upcall->userdata = a[OVS_PACKET_ATTR_USERDATA];
1902     upcall->out_tun_key = a[OVS_PACKET_ATTR_EGRESS_TUN_KEY];
1903
1904     /* Allow overwriting the netlink attribute header without reallocating. */
1905     ofpbuf_use_stub(&upcall->packet,
1906                     CONST_CAST(struct nlattr *,
1907                                nl_attr_get(a[OVS_PACKET_ATTR_PACKET])) - 1,
1908                     nl_attr_get_size(a[OVS_PACKET_ATTR_PACKET]) +
1909                     sizeof(struct nlattr));
1910     ofpbuf_set_data(&upcall->packet,
1911                     (char *)ofpbuf_data(&upcall->packet) + sizeof(struct nlattr));
1912     ofpbuf_set_size(&upcall->packet, nl_attr_get_size(a[OVS_PACKET_ATTR_PACKET]));
1913
1914     *dp_ifindex = ovs_header->dp_ifindex;
1915
1916     return 0;
1917 }
1918
1919 #ifdef _WIN32
1920 #define PACKET_RECV_BATCH_SIZE 50
1921 static int
1922 dpif_netlink_recv_windows(struct dpif_netlink *dpif, uint32_t handler_id,
1923                           struct dpif_upcall *upcall, struct ofpbuf *buf)
1924     OVS_REQ_RDLOCK(dpif->upcall_lock)
1925 {
1926     struct dpif_handler *handler;
1927     int read_tries = 0;
1928     struct dpif_windows_vport_sock *sock_pool;
1929     uint32_t i;
1930
1931     if (!dpif->handlers) {
1932         return EAGAIN;
1933     }
1934
1935     /* Only one handler is supported currently. */
1936     if (handler_id >= 1) {
1937         return EAGAIN;
1938     }
1939
1940     if (handler_id >= dpif->n_handlers) {
1941         return EAGAIN;
1942     }
1943
1944     handler = &dpif->handlers[handler_id];
1945     sock_pool = handler->vport_sock_pool;
1946
1947     for (i = 0; i < VPORT_SOCK_POOL_SIZE; i++) {
1948         for (;;) {
1949             int dp_ifindex;
1950             int error;
1951
1952             if (++read_tries > PACKET_RECV_BATCH_SIZE) {
1953                 return EAGAIN;
1954             }
1955
1956             error = nl_sock_recv(sock_pool[i].nl_sock, buf, false);
1957             if (error == ENOBUFS) {
1958                 /* ENOBUFS typically means that we've received so many
1959                  * packets that the buffer overflowed.  Try again
1960                  * immediately because there's almost certainly a packet
1961                  * waiting for us. */
1962                 /* XXX: report_loss(dpif, ch, idx, handler_id); */
1963                 continue;
1964             }
1965
1966             /* XXX: ch->last_poll = time_msec(); */
1967             if (error) {
1968                 if (error == EAGAIN) {
1969                     break;
1970                 }
1971                 return error;
1972             }
1973
1974             error = parse_odp_packet(buf, upcall, &dp_ifindex);
1975             if (!error && dp_ifindex == dpif->dp_ifindex) {
1976                 return 0;
1977             } else if (error) {
1978                 return error;
1979             }
1980         }
1981     }
1982
1983     return EAGAIN;
1984 }
1985 #else
1986 static int
1987 dpif_netlink_recv__(struct dpif_netlink *dpif, uint32_t handler_id,
1988                     struct dpif_upcall *upcall, struct ofpbuf *buf)
1989     OVS_REQ_RDLOCK(dpif->upcall_lock)
1990 {
1991     struct dpif_handler *handler;
1992     int read_tries = 0;
1993
1994     if (!dpif->handlers || handler_id >= dpif->n_handlers) {
1995         return EAGAIN;
1996     }
1997
1998     handler = &dpif->handlers[handler_id];
1999     if (handler->event_offset >= handler->n_events) {
2000         int retval;
2001
2002         handler->event_offset = handler->n_events = 0;
2003
2004         do {
2005             retval = epoll_wait(handler->epoll_fd, handler->epoll_events,
2006                                 dpif->uc_array_size, 0);
2007         } while (retval < 0 && errno == EINTR);
2008
2009         if (retval < 0) {
2010             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
2011             VLOG_WARN_RL(&rl, "epoll_wait failed (%s)", ovs_strerror(errno));
2012         } else if (retval > 0) {
2013             handler->n_events = retval;
2014         }
2015     }
2016
2017     while (handler->event_offset < handler->n_events) {
2018         int idx = handler->epoll_events[handler->event_offset].data.u32;
2019         struct dpif_channel *ch = &dpif->handlers[handler_id].channels[idx];
2020
2021         handler->event_offset++;
2022
2023         for (;;) {
2024             int dp_ifindex;
2025             int error;
2026
2027             if (++read_tries > 50) {
2028                 return EAGAIN;
2029             }
2030
2031             error = nl_sock_recv(ch->sock, buf, false);
2032             if (error == ENOBUFS) {
2033                 /* ENOBUFS typically means that we've received so many
2034                  * packets that the buffer overflowed.  Try again
2035                  * immediately because there's almost certainly a packet
2036                  * waiting for us. */
2037                 report_loss(dpif, ch, idx, handler_id);
2038                 continue;
2039             }
2040
2041             ch->last_poll = time_msec();
2042             if (error) {
2043                 if (error == EAGAIN) {
2044                     break;
2045                 }
2046                 return error;
2047             }
2048
2049             error = parse_odp_packet(buf, upcall, &dp_ifindex);
2050             if (!error && dp_ifindex == dpif->dp_ifindex) {
2051                 return 0;
2052             } else if (error) {
2053                 return error;
2054             }
2055         }
2056     }
2057
2058     return EAGAIN;
2059 }
2060 #endif
2061
2062 static int
2063 dpif_netlink_recv(struct dpif *dpif_, uint32_t handler_id,
2064                   struct dpif_upcall *upcall, struct ofpbuf *buf)
2065 {
2066     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
2067     int error;
2068
2069     fat_rwlock_rdlock(&dpif->upcall_lock);
2070 #ifdef _WIN32
2071     error = dpif_netlink_recv_windows(dpif, handler_id, upcall, buf);
2072 #else
2073     error = dpif_netlink_recv__(dpif, handler_id, upcall, buf);
2074 #endif
2075     fat_rwlock_unlock(&dpif->upcall_lock);
2076
2077     return error;
2078 }
2079
2080 static void
2081 dpif_netlink_recv_wait__(struct dpif_netlink *dpif, uint32_t handler_id)
2082     OVS_REQ_RDLOCK(dpif->upcall_lock)
2083 {
2084 #ifdef _WIN32
2085     uint32_t i;
2086     struct dpif_windows_vport_sock *sock_pool =
2087         dpif->handlers[handler_id].vport_sock_pool;
2088
2089     /* Only one handler is supported currently. */
2090     if (handler_id >= 1) {
2091         return;
2092     }
2093
2094     for (i = 0; i < VPORT_SOCK_POOL_SIZE; i++) {
2095         nl_sock_wait(sock_pool[i].nl_sock, POLLIN);
2096     }
2097 #else
2098     if (dpif->handlers && handler_id < dpif->n_handlers) {
2099         struct dpif_handler *handler = &dpif->handlers[handler_id];
2100
2101         poll_fd_wait(handler->epoll_fd, POLLIN);
2102     }
2103 #endif
2104 }
2105
2106 static void
2107 dpif_netlink_recv_wait(struct dpif *dpif_, uint32_t handler_id)
2108 {
2109     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
2110
2111     fat_rwlock_rdlock(&dpif->upcall_lock);
2112     dpif_netlink_recv_wait__(dpif, handler_id);
2113     fat_rwlock_unlock(&dpif->upcall_lock);
2114 }
2115
2116 static void
2117 dpif_netlink_recv_purge__(struct dpif_netlink *dpif)
2118     OVS_REQ_WRLOCK(dpif->upcall_lock)
2119 {
2120     if (dpif->handlers) {
2121         size_t i, j;
2122
2123         for (i = 0; i < dpif->uc_array_size; i++ ) {
2124             if (!dpif->handlers[0].channels[i].sock) {
2125                 continue;
2126             }
2127
2128             for (j = 0; j < dpif->n_handlers; j++) {
2129                 nl_sock_drain(dpif->handlers[j].channels[i].sock);
2130             }
2131         }
2132     }
2133 }
2134
2135 static void
2136 dpif_netlink_recv_purge(struct dpif *dpif_)
2137 {
2138     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
2139
2140     fat_rwlock_wrlock(&dpif->upcall_lock);
2141     dpif_netlink_recv_purge__(dpif);
2142     fat_rwlock_unlock(&dpif->upcall_lock);
2143 }
2144
2145 static char *
2146 dpif_netlink_get_datapath_version(void)
2147 {
2148     char *version_str = NULL;
2149
2150 #ifdef __linux__
2151
2152 #define MAX_VERSION_STR_SIZE 80
2153 #define LINUX_DATAPATH_VERSION_FILE  "/sys/module/openvswitch/version"
2154     FILE *f;
2155
2156     f = fopen(LINUX_DATAPATH_VERSION_FILE, "r");
2157     if (f) {
2158         char *newline;
2159         char version[MAX_VERSION_STR_SIZE];
2160
2161         if (fgets(version, MAX_VERSION_STR_SIZE, f)) {
2162             newline = strchr(version, '\n');
2163             if (newline) {
2164                 *newline = '\0';
2165             }
2166             version_str = xstrdup(version);
2167         }
2168         fclose(f);
2169     }
2170 #endif
2171
2172     return version_str;
2173 }
2174
2175 const struct dpif_class dpif_netlink_class = {
2176     "system",
2177     dpif_netlink_enumerate,
2178     NULL,
2179     dpif_netlink_open,
2180     dpif_netlink_close,
2181     dpif_netlink_destroy,
2182     dpif_netlink_run,
2183     NULL,                       /* wait */
2184     dpif_netlink_get_stats,
2185     dpif_netlink_port_add,
2186     dpif_netlink_port_del,
2187     dpif_netlink_port_query_by_number,
2188     dpif_netlink_port_query_by_name,
2189     dpif_netlink_port_get_pid,
2190     dpif_netlink_port_dump_start,
2191     dpif_netlink_port_dump_next,
2192     dpif_netlink_port_dump_done,
2193     dpif_netlink_port_poll,
2194     dpif_netlink_port_poll_wait,
2195     dpif_netlink_flow_flush,
2196     dpif_netlink_flow_dump_create,
2197     dpif_netlink_flow_dump_destroy,
2198     dpif_netlink_flow_dump_thread_create,
2199     dpif_netlink_flow_dump_thread_destroy,
2200     dpif_netlink_flow_dump_next,
2201     dpif_netlink_operate,
2202     dpif_netlink_recv_set,
2203     dpif_netlink_handlers_set,
2204     NULL,                       /* poll_thread_set */
2205     dpif_netlink_queue_to_priority,
2206     dpif_netlink_recv,
2207     dpif_netlink_recv_wait,
2208     dpif_netlink_recv_purge,
2209     NULL,                       /* register_upcall_cb */
2210     NULL,                       /* enable_upcall */
2211     NULL,                       /* disable_upcall */
2212     dpif_netlink_get_datapath_version, /* get_datapath_version */
2213 };
2214
2215 static int
2216 dpif_netlink_init(void)
2217 {
2218     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
2219     static int error;
2220
2221     if (ovsthread_once_start(&once)) {
2222         error = nl_lookup_genl_family(OVS_DATAPATH_FAMILY,
2223                                       &ovs_datapath_family);
2224         if (error) {
2225             VLOG_ERR("Generic Netlink family '%s' does not exist. "
2226                      "The Open vSwitch kernel module is probably not loaded.",
2227                      OVS_DATAPATH_FAMILY);
2228         }
2229         if (!error) {
2230             error = nl_lookup_genl_family(OVS_VPORT_FAMILY, &ovs_vport_family);
2231         }
2232         if (!error) {
2233             error = nl_lookup_genl_family(OVS_FLOW_FAMILY, &ovs_flow_family);
2234         }
2235         if (!error) {
2236             error = nl_lookup_genl_family(OVS_PACKET_FAMILY,
2237                                           &ovs_packet_family);
2238         }
2239         if (!error) {
2240             error = nl_lookup_genl_mcgroup(OVS_VPORT_FAMILY, OVS_VPORT_MCGROUP,
2241                                            &ovs_vport_mcgroup);
2242         }
2243
2244         ovsthread_once_done(&once);
2245     }
2246
2247     return error;
2248 }
2249
2250 bool
2251 dpif_netlink_is_internal_device(const char *name)
2252 {
2253     struct dpif_netlink_vport reply;
2254     struct ofpbuf *buf;
2255     int error;
2256
2257     error = dpif_netlink_vport_get(name, &reply, &buf);
2258     if (!error) {
2259         ofpbuf_delete(buf);
2260     } else if (error != ENODEV && error != ENOENT) {
2261         VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
2262                      name, ovs_strerror(error));
2263     }
2264
2265     return reply.type == OVS_VPORT_TYPE_INTERNAL;
2266 }
2267 \f
2268 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
2269  * by Netlink attributes, into 'vport'.  Returns 0 if successful, otherwise a
2270  * positive errno value.
2271  *
2272  * 'vport' will contain pointers into 'buf', so the caller should not free
2273  * 'buf' while 'vport' is still in use. */
2274 static int
2275 dpif_netlink_vport_from_ofpbuf(struct dpif_netlink_vport *vport,
2276                              const struct ofpbuf *buf)
2277 {
2278     static const struct nl_policy ovs_vport_policy[] = {
2279         [OVS_VPORT_ATTR_PORT_NO] = { .type = NL_A_U32 },
2280         [OVS_VPORT_ATTR_TYPE] = { .type = NL_A_U32 },
2281         [OVS_VPORT_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
2282         [OVS_VPORT_ATTR_UPCALL_PID] = { .type = NL_A_UNSPEC },
2283         [OVS_VPORT_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_vport_stats),
2284                                    .optional = true },
2285         [OVS_VPORT_ATTR_OPTIONS] = { .type = NL_A_NESTED, .optional = true },
2286     };
2287
2288     struct nlattr *a[ARRAY_SIZE(ovs_vport_policy)];
2289     struct ovs_header *ovs_header;
2290     struct nlmsghdr *nlmsg;
2291     struct genlmsghdr *genl;
2292     struct ofpbuf b;
2293
2294     dpif_netlink_vport_init(vport);
2295
2296     ofpbuf_use_const(&b, ofpbuf_data(buf), ofpbuf_size(buf));
2297     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
2298     genl = ofpbuf_try_pull(&b, sizeof *genl);
2299     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
2300     if (!nlmsg || !genl || !ovs_header
2301         || nlmsg->nlmsg_type != ovs_vport_family
2302         || !nl_policy_parse(&b, 0, ovs_vport_policy, a,
2303                             ARRAY_SIZE(ovs_vport_policy))) {
2304         return EINVAL;
2305     }
2306
2307     vport->cmd = genl->cmd;
2308     vport->dp_ifindex = ovs_header->dp_ifindex;
2309     vport->port_no = nl_attr_get_odp_port(a[OVS_VPORT_ATTR_PORT_NO]);
2310     vport->type = nl_attr_get_u32(a[OVS_VPORT_ATTR_TYPE]);
2311     vport->name = nl_attr_get_string(a[OVS_VPORT_ATTR_NAME]);
2312     if (a[OVS_VPORT_ATTR_UPCALL_PID]) {
2313         vport->n_upcall_pids = nl_attr_get_size(a[OVS_VPORT_ATTR_UPCALL_PID])
2314                                / (sizeof *vport->upcall_pids);
2315         vport->upcall_pids = nl_attr_get(a[OVS_VPORT_ATTR_UPCALL_PID]);
2316
2317     }
2318     if (a[OVS_VPORT_ATTR_STATS]) {
2319         vport->stats = nl_attr_get(a[OVS_VPORT_ATTR_STATS]);
2320     }
2321     if (a[OVS_VPORT_ATTR_OPTIONS]) {
2322         vport->options = nl_attr_get(a[OVS_VPORT_ATTR_OPTIONS]);
2323         vport->options_len = nl_attr_get_size(a[OVS_VPORT_ATTR_OPTIONS]);
2324     }
2325     return 0;
2326 }
2327
2328 /* Appends to 'buf' (which must initially be empty) a "struct ovs_header"
2329  * followed by Netlink attributes corresponding to 'vport'. */
2330 static void
2331 dpif_netlink_vport_to_ofpbuf(const struct dpif_netlink_vport *vport,
2332                              struct ofpbuf *buf)
2333 {
2334     struct ovs_header *ovs_header;
2335
2336     nl_msg_put_genlmsghdr(buf, 0, ovs_vport_family, NLM_F_REQUEST | NLM_F_ECHO,
2337                           vport->cmd, OVS_VPORT_VERSION);
2338
2339     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
2340     ovs_header->dp_ifindex = vport->dp_ifindex;
2341
2342     if (vport->port_no != ODPP_NONE) {
2343         nl_msg_put_odp_port(buf, OVS_VPORT_ATTR_PORT_NO, vport->port_no);
2344     }
2345
2346     if (vport->type != OVS_VPORT_TYPE_UNSPEC) {
2347         nl_msg_put_u32(buf, OVS_VPORT_ATTR_TYPE, vport->type);
2348     }
2349
2350     if (vport->name) {
2351         nl_msg_put_string(buf, OVS_VPORT_ATTR_NAME, vport->name);
2352     }
2353
2354     if (vport->upcall_pids) {
2355         nl_msg_put_unspec(buf, OVS_VPORT_ATTR_UPCALL_PID,
2356                           vport->upcall_pids,
2357                           vport->n_upcall_pids * sizeof *vport->upcall_pids);
2358     }
2359
2360     if (vport->stats) {
2361         nl_msg_put_unspec(buf, OVS_VPORT_ATTR_STATS,
2362                           vport->stats, sizeof *vport->stats);
2363     }
2364
2365     if (vport->options) {
2366         nl_msg_put_nested(buf, OVS_VPORT_ATTR_OPTIONS,
2367                           vport->options, vport->options_len);
2368     }
2369 }
2370
2371 /* Clears 'vport' to "empty" values. */
2372 void
2373 dpif_netlink_vport_init(struct dpif_netlink_vport *vport)
2374 {
2375     memset(vport, 0, sizeof *vport);
2376     vport->port_no = ODPP_NONE;
2377 }
2378
2379 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
2380  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
2381  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
2382  * result of the command is expected to be an ovs_vport also, which is decoded
2383  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
2384  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
2385 int
2386 dpif_netlink_vport_transact(const struct dpif_netlink_vport *request,
2387                             struct dpif_netlink_vport *reply,
2388                             struct ofpbuf **bufp)
2389 {
2390     struct ofpbuf *request_buf;
2391     int error;
2392
2393     ovs_assert((reply != NULL) == (bufp != NULL));
2394
2395     error = dpif_netlink_init();
2396     if (error) {
2397         if (reply) {
2398             *bufp = NULL;
2399             dpif_netlink_vport_init(reply);
2400         }
2401         return error;
2402     }
2403
2404     request_buf = ofpbuf_new(1024);
2405     dpif_netlink_vport_to_ofpbuf(request, request_buf);
2406     error = nl_transact(NETLINK_GENERIC, request_buf, bufp);
2407     ofpbuf_delete(request_buf);
2408
2409     if (reply) {
2410         if (!error) {
2411             error = dpif_netlink_vport_from_ofpbuf(reply, *bufp);
2412         }
2413         if (error) {
2414             dpif_netlink_vport_init(reply);
2415             ofpbuf_delete(*bufp);
2416             *bufp = NULL;
2417         }
2418     }
2419     return error;
2420 }
2421
2422 /* Obtains information about the kernel vport named 'name' and stores it into
2423  * '*reply' and '*bufp'.  The caller must free '*bufp' when the reply is no
2424  * longer needed ('reply' will contain pointers into '*bufp').  */
2425 int
2426 dpif_netlink_vport_get(const char *name, struct dpif_netlink_vport *reply,
2427                        struct ofpbuf **bufp)
2428 {
2429     struct dpif_netlink_vport request;
2430
2431     dpif_netlink_vport_init(&request);
2432     request.cmd = OVS_VPORT_CMD_GET;
2433     request.name = name;
2434
2435     return dpif_netlink_vport_transact(&request, reply, bufp);
2436 }
2437
2438 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
2439  * by Netlink attributes, into 'dp'.  Returns 0 if successful, otherwise a
2440  * positive errno value.
2441  *
2442  * 'dp' will contain pointers into 'buf', so the caller should not free 'buf'
2443  * while 'dp' is still in use. */
2444 static int
2445 dpif_netlink_dp_from_ofpbuf(struct dpif_netlink_dp *dp, const struct ofpbuf *buf)
2446 {
2447     static const struct nl_policy ovs_datapath_policy[] = {
2448         [OVS_DP_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
2449         [OVS_DP_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_dp_stats),
2450                                 .optional = true },
2451         [OVS_DP_ATTR_MEGAFLOW_STATS] = {
2452                         NL_POLICY_FOR(struct ovs_dp_megaflow_stats),
2453                         .optional = true },
2454     };
2455
2456     struct nlattr *a[ARRAY_SIZE(ovs_datapath_policy)];
2457     struct ovs_header *ovs_header;
2458     struct nlmsghdr *nlmsg;
2459     struct genlmsghdr *genl;
2460     struct ofpbuf b;
2461
2462     dpif_netlink_dp_init(dp);
2463
2464     ofpbuf_use_const(&b, ofpbuf_data(buf), ofpbuf_size(buf));
2465     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
2466     genl = ofpbuf_try_pull(&b, sizeof *genl);
2467     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
2468     if (!nlmsg || !genl || !ovs_header
2469         || nlmsg->nlmsg_type != ovs_datapath_family
2470         || !nl_policy_parse(&b, 0, ovs_datapath_policy, a,
2471                             ARRAY_SIZE(ovs_datapath_policy))) {
2472         return EINVAL;
2473     }
2474
2475     dp->cmd = genl->cmd;
2476     dp->dp_ifindex = ovs_header->dp_ifindex;
2477     dp->name = nl_attr_get_string(a[OVS_DP_ATTR_NAME]);
2478     if (a[OVS_DP_ATTR_STATS]) {
2479         dp->stats = nl_attr_get(a[OVS_DP_ATTR_STATS]);
2480     }
2481
2482     if (a[OVS_DP_ATTR_MEGAFLOW_STATS]) {
2483         dp->megaflow_stats = nl_attr_get(a[OVS_DP_ATTR_MEGAFLOW_STATS]);
2484     }
2485
2486     return 0;
2487 }
2488
2489 /* Appends to 'buf' the Generic Netlink message described by 'dp'. */
2490 static void
2491 dpif_netlink_dp_to_ofpbuf(const struct dpif_netlink_dp *dp, struct ofpbuf *buf)
2492 {
2493     struct ovs_header *ovs_header;
2494
2495     nl_msg_put_genlmsghdr(buf, 0, ovs_datapath_family,
2496                           NLM_F_REQUEST | NLM_F_ECHO, dp->cmd,
2497                           OVS_DATAPATH_VERSION);
2498
2499     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
2500     ovs_header->dp_ifindex = dp->dp_ifindex;
2501
2502     if (dp->name) {
2503         nl_msg_put_string(buf, OVS_DP_ATTR_NAME, dp->name);
2504     }
2505
2506     if (dp->upcall_pid) {
2507         nl_msg_put_u32(buf, OVS_DP_ATTR_UPCALL_PID, *dp->upcall_pid);
2508     }
2509
2510     if (dp->user_features) {
2511         nl_msg_put_u32(buf, OVS_DP_ATTR_USER_FEATURES, dp->user_features);
2512     }
2513
2514     /* Skip OVS_DP_ATTR_STATS since we never have a reason to serialize it. */
2515 }
2516
2517 /* Clears 'dp' to "empty" values. */
2518 static void
2519 dpif_netlink_dp_init(struct dpif_netlink_dp *dp)
2520 {
2521     memset(dp, 0, sizeof *dp);
2522 }
2523
2524 static void
2525 dpif_netlink_dp_dump_start(struct nl_dump *dump)
2526 {
2527     struct dpif_netlink_dp request;
2528     struct ofpbuf *buf;
2529
2530     dpif_netlink_dp_init(&request);
2531     request.cmd = OVS_DP_CMD_GET;
2532
2533     buf = ofpbuf_new(1024);
2534     dpif_netlink_dp_to_ofpbuf(&request, buf);
2535     nl_dump_start(dump, NETLINK_GENERIC, buf);
2536     ofpbuf_delete(buf);
2537 }
2538
2539 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
2540  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
2541  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
2542  * result of the command is expected to be of the same form, which is decoded
2543  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
2544  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
2545 static int
2546 dpif_netlink_dp_transact(const struct dpif_netlink_dp *request,
2547                          struct dpif_netlink_dp *reply, struct ofpbuf **bufp)
2548 {
2549     struct ofpbuf *request_buf;
2550     int error;
2551
2552     ovs_assert((reply != NULL) == (bufp != NULL));
2553
2554     request_buf = ofpbuf_new(1024);
2555     dpif_netlink_dp_to_ofpbuf(request, request_buf);
2556     error = nl_transact(NETLINK_GENERIC, request_buf, bufp);
2557     ofpbuf_delete(request_buf);
2558
2559     if (reply) {
2560         dpif_netlink_dp_init(reply);
2561         if (!error) {
2562             error = dpif_netlink_dp_from_ofpbuf(reply, *bufp);
2563         }
2564         if (error) {
2565             ofpbuf_delete(*bufp);
2566             *bufp = NULL;
2567         }
2568     }
2569     return error;
2570 }
2571
2572 /* Obtains information about 'dpif_' and stores it into '*reply' and '*bufp'.
2573  * The caller must free '*bufp' when the reply is no longer needed ('reply'
2574  * will contain pointers into '*bufp').  */
2575 static int
2576 dpif_netlink_dp_get(const struct dpif *dpif_, struct dpif_netlink_dp *reply,
2577                     struct ofpbuf **bufp)
2578 {
2579     struct dpif_netlink *dpif = dpif_netlink_cast(dpif_);
2580     struct dpif_netlink_dp request;
2581
2582     dpif_netlink_dp_init(&request);
2583     request.cmd = OVS_DP_CMD_GET;
2584     request.dp_ifindex = dpif->dp_ifindex;
2585
2586     return dpif_netlink_dp_transact(&request, reply, bufp);
2587 }
2588
2589 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
2590  * by Netlink attributes, into 'flow'.  Returns 0 if successful, otherwise a
2591  * positive errno value.
2592  *
2593  * 'flow' will contain pointers into 'buf', so the caller should not free 'buf'
2594  * while 'flow' is still in use. */
2595 static int
2596 dpif_netlink_flow_from_ofpbuf(struct dpif_netlink_flow *flow,
2597                               const struct ofpbuf *buf)
2598 {
2599     static const struct nl_policy ovs_flow_policy[] = {
2600         [OVS_FLOW_ATTR_KEY] = { .type = NL_A_NESTED },
2601         [OVS_FLOW_ATTR_MASK] = { .type = NL_A_NESTED, .optional = true },
2602         [OVS_FLOW_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
2603         [OVS_FLOW_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_flow_stats),
2604                                   .optional = true },
2605         [OVS_FLOW_ATTR_TCP_FLAGS] = { .type = NL_A_U8, .optional = true },
2606         [OVS_FLOW_ATTR_USED] = { .type = NL_A_U64, .optional = true },
2607         /* The kernel never uses OVS_FLOW_ATTR_CLEAR. */
2608         /* The kernel never uses OVS_FLOW_ATTR_PROBE. */
2609     };
2610
2611     struct nlattr *a[ARRAY_SIZE(ovs_flow_policy)];
2612     struct ovs_header *ovs_header;
2613     struct nlmsghdr *nlmsg;
2614     struct genlmsghdr *genl;
2615     struct ofpbuf b;
2616
2617     dpif_netlink_flow_init(flow);
2618
2619     ofpbuf_use_const(&b, ofpbuf_data(buf), ofpbuf_size(buf));
2620     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
2621     genl = ofpbuf_try_pull(&b, sizeof *genl);
2622     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
2623     if (!nlmsg || !genl || !ovs_header
2624         || nlmsg->nlmsg_type != ovs_flow_family
2625         || !nl_policy_parse(&b, 0, ovs_flow_policy, a,
2626                             ARRAY_SIZE(ovs_flow_policy))) {
2627         return EINVAL;
2628     }
2629
2630     flow->nlmsg_flags = nlmsg->nlmsg_flags;
2631     flow->dp_ifindex = ovs_header->dp_ifindex;
2632     flow->key = nl_attr_get(a[OVS_FLOW_ATTR_KEY]);
2633     flow->key_len = nl_attr_get_size(a[OVS_FLOW_ATTR_KEY]);
2634
2635     if (a[OVS_FLOW_ATTR_MASK]) {
2636         flow->mask = nl_attr_get(a[OVS_FLOW_ATTR_MASK]);
2637         flow->mask_len = nl_attr_get_size(a[OVS_FLOW_ATTR_MASK]);
2638     }
2639     if (a[OVS_FLOW_ATTR_ACTIONS]) {
2640         flow->actions = nl_attr_get(a[OVS_FLOW_ATTR_ACTIONS]);
2641         flow->actions_len = nl_attr_get_size(a[OVS_FLOW_ATTR_ACTIONS]);
2642     }
2643     if (a[OVS_FLOW_ATTR_STATS]) {
2644         flow->stats = nl_attr_get(a[OVS_FLOW_ATTR_STATS]);
2645     }
2646     if (a[OVS_FLOW_ATTR_TCP_FLAGS]) {
2647         flow->tcp_flags = nl_attr_get(a[OVS_FLOW_ATTR_TCP_FLAGS]);
2648     }
2649     if (a[OVS_FLOW_ATTR_USED]) {
2650         flow->used = nl_attr_get(a[OVS_FLOW_ATTR_USED]);
2651     }
2652     return 0;
2653 }
2654
2655 /* Appends to 'buf' (which must initially be empty) a "struct ovs_header"
2656  * followed by Netlink attributes corresponding to 'flow'. */
2657 static void
2658 dpif_netlink_flow_to_ofpbuf(const struct dpif_netlink_flow *flow,
2659                             struct ofpbuf *buf)
2660 {
2661     struct ovs_header *ovs_header;
2662
2663     nl_msg_put_genlmsghdr(buf, 0, ovs_flow_family,
2664                           NLM_F_REQUEST | flow->nlmsg_flags,
2665                           flow->cmd, OVS_FLOW_VERSION);
2666
2667     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
2668     ovs_header->dp_ifindex = flow->dp_ifindex;
2669
2670     if (flow->key_len) {
2671         nl_msg_put_unspec(buf, OVS_FLOW_ATTR_KEY, flow->key, flow->key_len);
2672     }
2673
2674     if (flow->mask_len) {
2675         nl_msg_put_unspec(buf, OVS_FLOW_ATTR_MASK, flow->mask, flow->mask_len);
2676     }
2677
2678     if (flow->actions || flow->actions_len) {
2679         nl_msg_put_unspec(buf, OVS_FLOW_ATTR_ACTIONS,
2680                           flow->actions, flow->actions_len);
2681     }
2682
2683     /* We never need to send these to the kernel. */
2684     ovs_assert(!flow->stats);
2685     ovs_assert(!flow->tcp_flags);
2686     ovs_assert(!flow->used);
2687
2688     if (flow->clear) {
2689         nl_msg_put_flag(buf, OVS_FLOW_ATTR_CLEAR);
2690     }
2691     if (flow->probe) {
2692         nl_msg_put_flag(buf, OVS_FLOW_ATTR_PROBE);
2693     }
2694 }
2695
2696 /* Clears 'flow' to "empty" values. */
2697 static void
2698 dpif_netlink_flow_init(struct dpif_netlink_flow *flow)
2699 {
2700     memset(flow, 0, sizeof *flow);
2701 }
2702
2703 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
2704  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
2705  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
2706  * result of the command is expected to be a flow also, which is decoded and
2707  * stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the reply
2708  * is no longer needed ('reply' will contain pointers into '*bufp'). */
2709 static int
2710 dpif_netlink_flow_transact(struct dpif_netlink_flow *request,
2711                            struct dpif_netlink_flow *reply,
2712                            struct ofpbuf **bufp)
2713 {
2714     struct ofpbuf *request_buf;
2715     int error;
2716
2717     ovs_assert((reply != NULL) == (bufp != NULL));
2718
2719     if (reply) {
2720         request->nlmsg_flags |= NLM_F_ECHO;
2721     }
2722
2723     request_buf = ofpbuf_new(1024);
2724     dpif_netlink_flow_to_ofpbuf(request, request_buf);
2725     error = nl_transact(NETLINK_GENERIC, request_buf, bufp);
2726     ofpbuf_delete(request_buf);
2727
2728     if (reply) {
2729         if (!error) {
2730             error = dpif_netlink_flow_from_ofpbuf(reply, *bufp);
2731         }
2732         if (error) {
2733             dpif_netlink_flow_init(reply);
2734             ofpbuf_delete(*bufp);
2735             *bufp = NULL;
2736         }
2737     }
2738     return error;
2739 }
2740
2741 static void
2742 dpif_netlink_flow_get_stats(const struct dpif_netlink_flow *flow,
2743                             struct dpif_flow_stats *stats)
2744 {
2745     if (flow->stats) {
2746         stats->n_packets = get_32aligned_u64(&flow->stats->n_packets);
2747         stats->n_bytes = get_32aligned_u64(&flow->stats->n_bytes);
2748     } else {
2749         stats->n_packets = 0;
2750         stats->n_bytes = 0;
2751     }
2752     stats->used = flow->used ? get_32aligned_u64(flow->used) : 0;
2753     stats->tcp_flags = flow->tcp_flags ? *flow->tcp_flags : 0;
2754 }
2755 \f
2756 /* Logs information about a packet that was recently lost in 'ch' (in
2757  * 'dpif_'). */
2758 static void
2759 report_loss(struct dpif_netlink *dpif, struct dpif_channel *ch, uint32_t ch_idx,
2760             uint32_t handler_id)
2761 {
2762     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
2763     struct ds s;
2764
2765     if (VLOG_DROP_WARN(&rl)) {
2766         return;
2767     }
2768
2769     ds_init(&s);
2770     if (ch->last_poll != LLONG_MIN) {
2771         ds_put_format(&s, " (last polled %lld ms ago)",
2772                       time_msec() - ch->last_poll);
2773     }
2774
2775     VLOG_WARN("%s: lost packet on port channel %u of handler %u",
2776               dpif_name(&dpif->dpif), ch_idx, handler_id);
2777     ds_destroy(&s);
2778 }