lib/dpif-linux.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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-linux.h"
  20
  21 #include <assert.h>
  22 #include <ctype.h>
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <inttypes.h>
  26 #include <net/if.h>
  27 #include <linux/types.h>
  28 #include <linux/ethtool.h>
  29 #include <linux/pkt_sched.h>
  30 #include <linux/rtnetlink.h>
  31 #include <linux/sockios.h>
  32 #include <stdlib.h>
  33 #include <sys/ioctl.h>
  34 #include <sys/stat.h>
  35 #include <unistd.h>
  36
  37 #include "dpif-provider.h"
  38 #include "netdev.h"
  39 #include "netdev-vport.h"
  40 #include "netlink.h"
  41 #include "odp-util.h"
  42 #include "ofpbuf.h"
  43 #include "openvswitch/tunnel.h"
  44 #include "packets.h"
  45 #include "poll-loop.h"
  46 #include "rtnetlink.h"
  47 #include "rtnetlink-link.h"
  48 #include "shash.h"
  49 #include "svec.h"
  50 #include "unaligned.h"
  51 #include "util.h"
  52 #include "vlog.h"
  53
  54 VLOG_DEFINE_THIS_MODULE(dpif_linux);
  55
  56 struct dpif_linux_dp {
  57     /* ioctl command argument. */
  58     int cmd;
  59
  60     /* struct odp_datapath header. */
  61     uint32_t dp_idx;
  62
  63     /* Attributes. */
  64     const char *name;                  /* ODP_DP_ATTR_NAME. */
  65     struct odp_stats stats;            /* ODP_DP_ATTR_STATS. */
  66     enum odp_frag_handling ipv4_frags; /* ODP_DP_ATTR_IPV4_FRAGS. */
  67     const uint32_t *sampling;          /* ODP_DP_ATTR_SAMPLING. */
  68 };
  69
  70 static void dpif_linux_dp_init(struct dpif_linux_dp *);
  71 static int dpif_linux_dp_transact(const struct dpif_linux_dp *request,
  72                                   struct dpif_linux_dp *reply,
  73                                   struct ofpbuf **bufp);
  74 static int dpif_linux_dp_get(const struct dpif *, struct dpif_linux_dp *reply,
  75                              struct ofpbuf **bufp);
  76
  77 struct dpif_linux_flow {
  78     /* ioctl command argument. */
  79     int cmd;
  80
  81     /* struct odp_flow header. */
  82     unsigned int nlmsg_flags;
  83     uint32_t dp_idx;
  84
  85     /* Attributes.
  86      *
  87      * The 'stats', 'used', and 'state' members point to 64-bit data that might
  88      * only be aligned on 32-bit boundaries, so get_unaligned_u64() should be
  89      * used to access their values. */
  90     const struct nlattr *key;           /* ODP_FLOW_ATTR_KEY. */
  91     size_t key_len;
  92     const struct nlattr *actions;       /* ODP_FLOW_ATTR_ACTIONS. */
  93     size_t actions_len;
  94     const struct odp_flow_stats *stats; /* ODP_FLOW_ATTR_STATS. */
  95     const uint8_t *tcp_flags;           /* ODP_FLOW_ATTR_TCP_FLAGS. */
  96     const uint64_t *used;               /* ODP_FLOW_ATTR_USED. */
  97     bool clear;                         /* ODP_FLOW_ATTR_CLEAR. */
  98     const uint64_t *state;              /* ODP_FLOW_ATTR_STATE. */
  99 };
 100
 101 static void dpif_linux_flow_init(struct dpif_linux_flow *);
 102 static int dpif_linux_flow_transact(const struct dpif_linux_flow *request,
 103                                     struct dpif_linux_flow *reply,
 104                                     struct ofpbuf **bufp);
 105 static void dpif_linux_flow_get_stats(const struct dpif_linux_flow *,
 106                                       struct dpif_flow_stats *);
 107
 108 /* Datapath interface for the openvswitch Linux kernel module. */
 109 struct dpif_linux {
 110     struct dpif dpif;
 111     int fd;
 112
 113     /* Used by dpif_linux_get_all_names(). */
 114     char *local_ifname;
 115     int minor;
 116
 117     /* Change notification. */
 118     int local_ifindex;          /* Ifindex of local port. */
 119     struct shash changed_ports;  /* Ports that have changed. */
 120     struct rtnetlink_notifier port_notifier;
 121     bool change_error;
 122 };
 123
 124 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
 125
 126 static int do_ioctl(const struct dpif *, int cmd, const void *arg);
 127 static int open_dpif(const struct dpif_linux_vport *local_vport,
 128                      struct dpif **);
 129 static int get_openvswitch_major(void);
 130 static int open_minor(int minor, int *fdp);
 131 static int make_openvswitch_device(int minor, char **fnp);
 132 static void dpif_linux_port_changed(const struct rtnetlink_link_change *,
 133                                     void *dpif);
 134
 135 static struct dpif_linux *
 136 dpif_linux_cast(const struct dpif *dpif)
 137 {
 138     dpif_assert_class(dpif, &dpif_linux_class);
 139     return CONTAINER_OF(dpif, struct dpif_linux, dpif);
 140 }
 141
 142 static int
 143 dpif_linux_enumerate(struct svec *all_dps)
 144 {
 145     uint32_t dp_idx;
 146     int major;
 147
 148     /* Check that the Open vSwitch module is loaded. */
 149     major = get_openvswitch_major();
 150     if (major < 0) {
 151         return -major;
 152     }
 153
 154     dp_idx = 0;
 155     for (;;) {
 156         struct dpif_linux_dp request, reply;
 157         struct ofpbuf *buf;
 158         char devname[16];
 159         int error;
 160
 161         dpif_linux_dp_init(&request);
 162         request.dp_idx = dp_idx;
 163         request.cmd = ODP_DP_DUMP;
 164
 165         error = dpif_linux_dp_transact(&request, &reply, &buf);
 166         if (error) {
 167             return error == ENODEV ? 0 : error;
 168         }
 169         ofpbuf_delete(buf);
 170
 171         sprintf(devname, "dp%d", reply.dp_idx);
 172         svec_add(all_dps, devname);
 173
 174         dp_idx = reply.dp_idx + 1;
 175     }
 176 }
 177
 178 static int
 179 dpif_linux_open(const struct dpif_class *class OVS_UNUSED, const char *name,
 180                 bool create, struct dpif **dpifp)
 181 {
 182     struct dpif_linux_vport request, reply;
 183     struct ofpbuf *buf;
 184     int minor;
 185     int error;
 186
 187     minor = !strncmp(name, "dp", 2)
 188             && isdigit((unsigned char)name[2]) ? atoi(name + 2) : -1;
 189     if (create) {
 190         struct dpif_linux_dp request, reply;
 191         struct ofpbuf *buf;
 192         int error;
 193
 194         dpif_linux_dp_init(&request);
 195         request.cmd = ODP_DP_NEW;
 196         request.dp_idx = minor;
 197         request.name = name;
 198         error = dpif_linux_dp_transact(&request, &reply, &buf);
 199         if (error) {
 200             return error;
 201         }
 202         minor = reply.dp_idx;
 203         ofpbuf_delete(buf);
 204     }
 205
 206     dpif_linux_vport_init(&request);
 207     request.cmd = ODP_VPORT_GET;
 208     request.port_no = ODPP_LOCAL;
 209     if (minor >= 0) {
 210         request.dp_idx = minor;
 211     } else {
 212         request.name = name;
 213     }
 214
 215     error = dpif_linux_vport_transact(&request, &reply, &buf);
 216     if (error) {
 217         return error;
 218     } else if (reply.port_no != ODPP_LOCAL) {
 219         /* This is an Open vSwitch device but not the local port.  We
 220          * intentionally support only using the name of the local port as the
 221          * name of a datapath; otherwise, it would be too difficult to
 222          * enumerate all the names of a datapath. */
 223         error = EOPNOTSUPP;
 224     } else {
 225         error = open_dpif(&reply, dpifp);
 226     }
 227
 228     ofpbuf_delete(buf);
 229     return error;
 230 }
 231
 232 static int
 233 open_dpif(const struct dpif_linux_vport *local_vport, struct dpif **dpifp)
 234 {
 235     int dp_idx = local_vport->dp_idx;
 236     struct dpif_linux *dpif;
 237     char *name;
 238     int error;
 239     int fd;
 240
 241     error = open_minor(dp_idx, &fd);
 242     if (error) {
 243         goto error;
 244     }
 245
 246     dpif = xmalloc(sizeof *dpif);
 247     error = rtnetlink_link_notifier_register(&dpif->port_notifier,
 248                                              dpif_linux_port_changed, dpif);
 249     if (error) {
 250         goto error_free;
 251     }
 252
 253     name = xasprintf("dp%d", dp_idx);
 254     dpif_init(&dpif->dpif, &dpif_linux_class, name, dp_idx, dp_idx);
 255     free(name);
 256
 257     dpif->fd = fd;
 258     dpif->local_ifname = xstrdup(local_vport->name);
 259     dpif->local_ifindex = local_vport->ifindex;
 260     dpif->minor = dp_idx;
 261     shash_init(&dpif->changed_ports);
 262     dpif->change_error = false;
 263     *dpifp = &dpif->dpif;
 264
 265     return 0;
 266
 267 error_free:
 268     free(dpif);
 269     close(fd);
 270 error:
 271     return error;
 272 }
 273
 274 static void
 275 dpif_linux_close(struct dpif *dpif_)
 276 {
 277     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 278     rtnetlink_link_notifier_unregister(&dpif->port_notifier);
 279     shash_destroy(&dpif->changed_ports);
 280     free(dpif->local_ifname);
 281     close(dpif->fd);
 282     free(dpif);
 283 }
 284
 285 static int
 286 dpif_linux_get_all_names(const struct dpif *dpif_, struct svec *all_names)
 287 {
 288     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 289
 290     svec_add_nocopy(all_names, xasprintf("dp%d", dpif->minor));
 291     svec_add(all_names, dpif->local_ifname);
 292     return 0;
 293 }
 294
 295 static int
 296 dpif_linux_destroy(struct dpif *dpif_)
 297 {
 298     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 299     struct dpif_linux_dp dp;
 300
 301     dpif_linux_dp_init(&dp);
 302     dp.cmd = ODP_DP_DEL;
 303     dp.dp_idx = dpif->minor;
 304     return dpif_linux_dp_transact(&dp, NULL, NULL);
 305 }
 306
 307 static int
 308 dpif_linux_get_stats(const struct dpif *dpif_, struct odp_stats *stats)
 309 {
 310     struct dpif_linux_dp dp;
 311     struct ofpbuf *buf;
 312     int error;
 313
 314     error = dpif_linux_dp_get(dpif_, &dp, &buf);
 315     if (!error) {
 316         *stats = dp.stats;
 317         ofpbuf_delete(buf);
 318     }
 319     return error;
 320 }
 321
 322 static int
 323 dpif_linux_get_drop_frags(const struct dpif *dpif_, bool *drop_fragsp)
 324 {
 325     struct dpif_linux_dp dp;
 326     struct ofpbuf *buf;
 327     int error;
 328
 329     error = dpif_linux_dp_get(dpif_, &dp, &buf);
 330     if (!error) {
 331         *drop_fragsp = dp.ipv4_frags == ODP_DP_FRAG_DROP;
 332         ofpbuf_delete(buf);
 333     }
 334     return error;
 335 }
 336
 337 static int
 338 dpif_linux_set_drop_frags(struct dpif *dpif_, bool drop_frags)
 339 {
 340     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 341     struct dpif_linux_dp dp;
 342
 343     dpif_linux_dp_init(&dp);
 344     dp.cmd = ODP_DP_SET;
 345     dp.dp_idx = dpif->minor;
 346     dp.ipv4_frags = drop_frags ? ODP_DP_FRAG_DROP : ODP_DP_FRAG_ZERO;
 347     return dpif_linux_dp_transact(&dp, NULL, NULL);
 348 }
 349
 350 static int
 351 dpif_linux_port_add(struct dpif *dpif_, struct netdev *netdev,
 352                     uint16_t *port_nop)
 353 {
 354     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 355     const char *name = netdev_get_name(netdev);
 356     const char *type = netdev_get_type(netdev);
 357     struct dpif_linux_vport request, reply;
 358     const struct ofpbuf *options;
 359     struct ofpbuf *buf;
 360     int error;
 361
 362     dpif_linux_vport_init(&request);
 363     request.cmd = ODP_VPORT_NEW;
 364     request.dp_idx = dpif->minor;
 365     request.type = netdev_vport_get_vport_type(netdev);
 366     if (request.type == ODP_VPORT_TYPE_UNSPEC) {
 367         VLOG_WARN_RL(&error_rl, "%s: cannot create port `%s' because it has "
 368                      "unsupported type `%s'",
 369                      dpif_name(dpif_), name, type);
 370         return EINVAL;
 371     }
 372     request.name = name;
 373
 374     options = netdev_vport_get_options(netdev);
 375     if (options && options->size) {
 376         request.options = options->data;
 377         request.options_len = options->size;
 378     }
 379
 380     error = dpif_linux_vport_transact(&request, &reply, &buf);
 381     if (!error) {
 382         *port_nop = reply.port_no;
 383         ofpbuf_delete(buf);
 384     }
 385
 386     return error;
 387 }
 388
 389 static int
 390 dpif_linux_port_del(struct dpif *dpif_, uint16_t port_no)
 391 {
 392     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 393     struct dpif_linux_vport vport;
 394
 395     dpif_linux_vport_init(&vport);
 396     vport.cmd = ODP_VPORT_DEL;
 397     vport.dp_idx = dpif->minor;
 398     vport.port_no = port_no;
 399     return dpif_linux_vport_transact(&vport, NULL, NULL);
 400 }
 401
 402 static int
 403 dpif_linux_port_query__(const struct dpif *dpif, uint32_t port_no,
 404                         const char *port_name, struct dpif_port *dpif_port)
 405 {
 406     struct dpif_linux_vport request;
 407     struct dpif_linux_vport reply;
 408     struct ofpbuf *buf;
 409     int error;
 410
 411     dpif_linux_vport_init(&request);
 412     request.cmd = ODP_VPORT_GET;
 413     request.dp_idx = dpif_linux_cast(dpif)->minor;
 414     request.port_no = port_no;
 415     request.name = port_name;
 416
 417     error = dpif_linux_vport_transact(&request, &reply, &buf);
 418     if (!error) {
 419         dpif_port->name = xstrdup(reply.name);
 420         dpif_port->type = xstrdup(netdev_vport_get_netdev_type(&reply));
 421         dpif_port->port_no = reply.port_no;
 422         ofpbuf_delete(buf);
 423     }
 424     return error;
 425 }
 426
 427 static int
 428 dpif_linux_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 429                                 struct dpif_port *dpif_port)
 430 {
 431     return dpif_linux_port_query__(dpif, port_no, NULL, dpif_port);
 432 }
 433
 434 static int
 435 dpif_linux_port_query_by_name(const struct dpif *dpif, const char *devname,
 436                               struct dpif_port *dpif_port)
 437 {
 438     return dpif_linux_port_query__(dpif, 0, devname, dpif_port);
 439 }
 440
 441 static int
 442 dpif_linux_get_max_ports(const struct dpif *dpif OVS_UNUSED)
 443 {
 444     /* If the datapath increases its range of supported ports, then it should
 445      * start reporting that. */
 446     return 1024;
 447 }
 448
 449 static int
 450 dpif_linux_flow_flush(struct dpif *dpif_)
 451 {
 452     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 453     return ioctl(dpif->fd, ODP_FLOW_FLUSH, dpif->minor) ? errno : 0;
 454 }
 455
 456 struct dpif_linux_port_state {
 457     struct ofpbuf *buf;
 458     uint32_t next;
 459 };
 460
 461 static int
 462 dpif_linux_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 463 {
 464     *statep = xzalloc(sizeof(struct dpif_linux_port_state));
 465     return 0;
 466 }
 467
 468 static int
 469 dpif_linux_port_dump_next(const struct dpif *dpif, void *state_,
 470                           struct dpif_port *dpif_port)
 471 {
 472     struct dpif_linux_port_state *state = state_;
 473     struct dpif_linux_vport request, reply;
 474     struct ofpbuf *buf;
 475     int error;
 476
 477     ofpbuf_delete(state->buf);
 478     state->buf = NULL;
 479
 480     dpif_linux_vport_init(&request);
 481     request.cmd = ODP_VPORT_DUMP;
 482     request.dp_idx = dpif_linux_cast(dpif)->minor;
 483     request.port_no = state->next;
 484     error = dpif_linux_vport_transact(&request, &reply, &buf);
 485     if (error) {
 486         return error == ENODEV ? EOF : error;
 487     } else {
 488         dpif_port->name = (char *) reply.name;
 489         dpif_port->type = (char *) netdev_vport_get_netdev_type(&reply);
 490         dpif_port->port_no = reply.port_no;
 491         state->buf = buf;
 492         state->next = reply.port_no + 1;
 493         return 0;
 494     }
 495 }
 496
 497 static int
 498 dpif_linux_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 499 {
 500     struct dpif_linux_port_state *state = state_;
 501     ofpbuf_delete(state->buf);
 502     free(state);
 503     return 0;
 504 }
 505
 506 static int
 507 dpif_linux_port_poll(const struct dpif *dpif_, char **devnamep)
 508 {
 509     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 510
 511     if (dpif->change_error) {
 512         dpif->change_error = false;
 513         shash_clear(&dpif->changed_ports);
 514         return ENOBUFS;
 515     } else if (!shash_is_empty(&dpif->changed_ports)) {
 516         struct shash_node *node = shash_first(&dpif->changed_ports);
 517         *devnamep = shash_steal(&dpif->changed_ports, node);
 518         return 0;
 519     } else {
 520         return EAGAIN;
 521     }
 522 }
 523
 524 static void
 525 dpif_linux_port_poll_wait(const struct dpif *dpif_)
 526 {
 527     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 528     if (!shash_is_empty(&dpif->changed_ports) || dpif->change_error) {
 529         poll_immediate_wake();
 530     } else {
 531         rtnetlink_link_notifier_wait();
 532     }
 533 }
 534
 535 static int
 536 dpif_linux_flow_get(const struct dpif *dpif_,
 537                     const struct nlattr *key, size_t key_len,
 538                     struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 539 {
 540     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 541     struct dpif_linux_flow request, reply;
 542     struct ofpbuf *buf;
 543     int error;
 544
 545     dpif_linux_flow_init(&request);
 546     request.cmd = ODP_FLOW_GET;
 547     request.dp_idx = dpif->minor;
 548     request.key = key;
 549     request.key_len = key_len;
 550     error = dpif_linux_flow_transact(&request, &reply, &buf);
 551     if (!error) {
 552         if (stats) {
 553             dpif_linux_flow_get_stats(&reply, stats);
 554         }
 555         if (actionsp) {
 556             buf->data = (void *) reply.actions;
 557             buf->size = reply.actions_len;
 558             *actionsp = buf;
 559         } else {
 560             ofpbuf_delete(buf);
 561         }
 562     }
 563     return error;
 564 }
 565
 566 static int
 567 dpif_linux_flow_put(struct dpif *dpif_, enum dpif_flow_put_flags flags,
 568                     const struct nlattr *key, size_t key_len,
 569                     const struct nlattr *actions, size_t actions_len,
 570                     struct dpif_flow_stats *stats)
 571 {
 572     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 573     struct dpif_linux_flow request, reply;
 574     struct ofpbuf *buf;
 575     int error;
 576
 577     dpif_linux_flow_init(&request);
 578     request.cmd = flags & DPIF_FP_CREATE ? ODP_FLOW_NEW : ODP_FLOW_SET;
 579     request.dp_idx = dpif->minor;
 580     request.key = key;
 581     request.key_len = key_len;
 582     request.actions = actions;
 583     request.actions_len = actions_len;
 584     if (flags & DPIF_FP_ZERO_STATS) {
 585         request.clear = true;
 586     }
 587     request.nlmsg_flags = flags & DPIF_FP_MODIFY ? 0 : NLM_F_CREATE;
 588     error = dpif_linux_flow_transact(&request,
 589                                      stats ? &reply : NULL,
 590                                      stats ? &buf : NULL);
 591     if (!error && stats) {
 592         dpif_linux_flow_get_stats(&reply, stats);
 593         ofpbuf_delete(buf);
 594     }
 595     return error;
 596 }
 597
 598 static int
 599 dpif_linux_flow_del(struct dpif *dpif_,
 600                     const struct nlattr *key, size_t key_len,
 601                     struct dpif_flow_stats *stats)
 602 {
 603     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 604     struct dpif_linux_flow request, reply;
 605     struct ofpbuf *buf;
 606     int error;
 607
 608     dpif_linux_flow_init(&request);
 609     request.cmd = ODP_FLOW_DEL;
 610     request.dp_idx = dpif->minor;
 611     request.key = key;
 612     request.key_len = key_len;
 613     error = dpif_linux_flow_transact(&request,
 614                                      stats ? &reply : NULL,
 615                                      stats ? &buf : NULL);
 616     if (!error && stats) {
 617         dpif_linux_flow_get_stats(&reply, stats);
 618         ofpbuf_delete(buf);
 619     }
 620     return error;
 621 }
 622
 623
 624 struct dpif_linux_flow_state {
 625     struct dpif_linux_flow flow;
 626     struct ofpbuf *buf;
 627     struct dpif_flow_stats stats;
 628 };
 629
 630 static int
 631 dpif_linux_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 632 {
 633     *statep = xzalloc(sizeof(struct dpif_linux_flow_state));
 634     return 0;
 635 }
 636
 637 static int
 638 dpif_linux_flow_dump_next(const struct dpif *dpif_, void *state_,
 639                           const struct nlattr **key, size_t *key_len,
 640                           const struct nlattr **actions, size_t *actions_len,
 641                           const struct dpif_flow_stats **stats)
 642 {
 643     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 644     struct dpif_linux_flow_state *state = state_;
 645     struct ofpbuf *old_buf = state->buf;
 646     struct dpif_linux_flow request;
 647     int error;
 648
 649     dpif_linux_flow_init(&request);
 650     request.cmd = ODP_FLOW_DUMP;
 651     request.dp_idx = dpif->minor;
 652     request.state = state->flow.state;
 653     error = dpif_linux_flow_transact(&request, &state->flow, &state->buf);
 654     ofpbuf_delete(old_buf);
 655
 656     if (!error) {
 657         if (key) {
 658             *key = state->flow.key;
 659             *key_len = state->flow.key_len;
 660         }
 661         if (actions) {
 662             *actions = state->flow.actions;
 663             *actions_len = state->flow.actions_len;
 664         }
 665         if (stats) {
 666             dpif_linux_flow_get_stats(&state->flow, &state->stats);
 667             *stats = &state->stats;
 668         }
 669     }
 670     return error == ENODEV ? EOF : error;
 671 }
 672
 673 static int
 674 dpif_linux_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 675 {
 676     struct dpif_linux_flow_state *state = state_;
 677
 678     ofpbuf_delete(state->buf);
 679     free(state);
 680     return 0;
 681 }
 682
 683 static int
 684 dpif_linux_execute(struct dpif *dpif_,
 685                    const struct nlattr *actions, size_t actions_len,
 686                    const struct ofpbuf *buf)
 687 {
 688     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 689     struct odp_execute execute;
 690
 691     memset(&execute, 0, sizeof execute);
 692     execute.dp_idx = dpif->minor;
 693     execute.actions = (struct nlattr *) actions;
 694     execute.actions_len = actions_len;
 695     execute.data = buf->data;
 696     execute.length = buf->size;
 697     return do_ioctl(dpif_, ODP_EXECUTE, &execute);
 698 }
 699
 700 static int
 701 dpif_linux_recv_get_mask(const struct dpif *dpif_, int *listen_mask)
 702 {
 703     return do_ioctl(dpif_, ODP_GET_LISTEN_MASK, listen_mask);
 704 }
 705
 706 static int
 707 dpif_linux_recv_set_mask(struct dpif *dpif_, int listen_mask)
 708 {
 709     return do_ioctl(dpif_, ODP_SET_LISTEN_MASK, &listen_mask);
 710 }
 711
 712 static int
 713 dpif_linux_get_sflow_probability(const struct dpif *dpif_,
 714                                  uint32_t *probability)
 715 {
 716     struct dpif_linux_dp dp;
 717     struct ofpbuf *buf;
 718     int error;
 719
 720     error = dpif_linux_dp_get(dpif_, &dp, &buf);
 721     if (!error) {
 722         *probability = dp.sampling ? *dp.sampling : 0;
 723         ofpbuf_delete(buf);
 724     }
 725     return error;
 726 }
 727
 728 static int
 729 dpif_linux_set_sflow_probability(struct dpif *dpif_, uint32_t probability)
 730 {
 731     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 732     struct dpif_linux_dp dp;
 733
 734     dpif_linux_dp_init(&dp);
 735     dp.cmd = ODP_DP_SET;
 736     dp.dp_idx = dpif->minor;
 737     dp.sampling = &probability;
 738     return dpif_linux_dp_transact(&dp, NULL, NULL);
 739 }
 740
 741 static int
 742 dpif_linux_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
 743                              uint32_t queue_id, uint32_t *priority)
 744 {
 745     if (queue_id < 0xf000) {
 746         *priority = TC_H_MAKE(1 << 16, queue_id + 1);
 747         return 0;
 748     } else {
 749         return EINVAL;
 750     }
 751 }
 752
 753 static int
 754 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall)
 755 {
 756     static const struct nl_policy odp_packet_policy[] = {
 757         /* Always present. */
 758         [ODP_PACKET_ATTR_TYPE] = { .type = NL_A_U32 },
 759         [ODP_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
 760                                      .min_len = ETH_HEADER_LEN },
 761         [ODP_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
 762
 763         /* _ODPL_ACTION_NR only. */
 764         [ODP_PACKET_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
 765
 766         /* _ODPL_SFLOW_NR only. */
 767         [ODP_PACKET_ATTR_SAMPLE_POOL] = { .type = NL_A_U32, .optional = true },
 768         [ODP_PACKET_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
 769     };
 770
 771     struct odp_packet *odp_packet = buf->data;
 772     struct nlattr *a[ARRAY_SIZE(odp_packet_policy)];
 773
 774     if (!nl_policy_parse(buf, sizeof *odp_packet, odp_packet_policy,
 775                          a, ARRAY_SIZE(odp_packet_policy))) {
 776         return EINVAL;
 777     }
 778
 779     memset(upcall, 0, sizeof *upcall);
 780     upcall->type = nl_attr_get_u32(a[ODP_PACKET_ATTR_TYPE]);
 781     upcall->packet = buf;
 782     upcall->packet->data = (void *) nl_attr_get(a[ODP_PACKET_ATTR_PACKET]);
 783     upcall->packet->size = nl_attr_get_size(a[ODP_PACKET_ATTR_PACKET]);
 784     upcall->key = (void *) nl_attr_get(a[ODP_PACKET_ATTR_KEY]);
 785     upcall->key_len = nl_attr_get_size(a[ODP_PACKET_ATTR_KEY]);
 786     upcall->userdata = (a[ODP_PACKET_ATTR_USERDATA]
 787                         ? nl_attr_get_u64(a[ODP_PACKET_ATTR_USERDATA])
 788                         : 0);
 789     upcall->sample_pool = (a[ODP_PACKET_ATTR_SAMPLE_POOL]
 790                         ? nl_attr_get_u32(a[ODP_PACKET_ATTR_SAMPLE_POOL])
 791                            : 0);
 792     if (a[ODP_PACKET_ATTR_ACTIONS]) {
 793         upcall->actions = (void *) nl_attr_get(a[ODP_PACKET_ATTR_ACTIONS]);
 794         upcall->actions_len = nl_attr_get_size(a[ODP_PACKET_ATTR_ACTIONS]);
 795     }
 796
 797     return 0;
 798 }
 799
 800 static int
 801 dpif_linux_recv(struct dpif *dpif_, struct dpif_upcall *upcall)
 802 {
 803     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 804     struct ofpbuf *buf;
 805     int retval;
 806     int error;
 807
 808     buf = ofpbuf_new(65536);
 809     retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
 810     if (retval < 0) {
 811         error = errno;
 812         if (error != EAGAIN) {
 813             VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
 814                          dpif_name(dpif_), strerror(error));
 815         }
 816     } else if (retval >= sizeof(struct odp_packet)) {
 817         struct odp_packet *odp_packet = buf->data;
 818         buf->size += retval;
 819
 820         if (odp_packet->len <= retval) {
 821             error = parse_odp_packet(buf, upcall);
 822         } else {
 823             VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
 824                          "from %"PRIu32" bytes to %d",
 825                          dpif_name(dpif_), odp_packet->len, retval);
 826             error = ERANGE;
 827         }
 828     } else if (!retval) {
 829         VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif_));
 830         error = EPROTO;
 831     } else {
 832         VLOG_WARN_RL(&error_rl, "%s: discarding too-short message (%d bytes)",
 833                      dpif_name(dpif_), retval);
 834         error = ERANGE;
 835     }
 836
 837     if (error) {
 838         ofpbuf_delete(buf);
 839     }
 840     return error;
 841 }
 842
 843 static void
 844 dpif_linux_recv_wait(struct dpif *dpif_)
 845 {
 846     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 847     poll_fd_wait(dpif->fd, POLLIN);
 848 }
 849
 850 static void
 851 dpif_linux_recv_purge(struct dpif *dpif_)
 852 {
 853     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 854     int i;
 855
 856     /* This is somewhat bogus because it assumes that the following macros have
 857      * fixed values, but it's going to go away later.  */
 858 #define DP_N_QUEUES 3
 859 #define DP_MAX_QUEUE_LEN 100
 860     for (i = 0; i < DP_N_QUEUES * DP_MAX_QUEUE_LEN; i++) {
 861         /* Reading even 1 byte discards a whole datagram and saves time. */
 862         char buffer;
 863
 864         if (read(dpif->fd, &buffer, 1) != 1) {
 865             break;
 866         }
 867     }
 868 }
 869
 870 const struct dpif_class dpif_linux_class = {
 871     "system",
 872     NULL,
 873     NULL,
 874     dpif_linux_enumerate,
 875     dpif_linux_open,
 876     dpif_linux_close,
 877     dpif_linux_get_all_names,
 878     dpif_linux_destroy,
 879     dpif_linux_get_stats,
 880     dpif_linux_get_drop_frags,
 881     dpif_linux_set_drop_frags,
 882     dpif_linux_port_add,
 883     dpif_linux_port_del,
 884     dpif_linux_port_query_by_number,
 885     dpif_linux_port_query_by_name,
 886     dpif_linux_get_max_ports,
 887     dpif_linux_port_dump_start,
 888     dpif_linux_port_dump_next,
 889     dpif_linux_port_dump_done,
 890     dpif_linux_port_poll,
 891     dpif_linux_port_poll_wait,
 892     dpif_linux_flow_get,
 893     dpif_linux_flow_put,
 894     dpif_linux_flow_del,
 895     dpif_linux_flow_flush,
 896     dpif_linux_flow_dump_start,
 897     dpif_linux_flow_dump_next,
 898     dpif_linux_flow_dump_done,
 899     dpif_linux_execute,
 900     dpif_linux_recv_get_mask,
 901     dpif_linux_recv_set_mask,
 902     dpif_linux_get_sflow_probability,
 903     dpif_linux_set_sflow_probability,
 904     dpif_linux_queue_to_priority,
 905     dpif_linux_recv,
 906     dpif_linux_recv_wait,
 907     dpif_linux_recv_purge,
 908 };
 909 \f
 910 static int get_openvswitch_major(void);
 911 static int get_major(const char *target);
 912
 913 static int
 914 do_ioctl(const struct dpif *dpif_, int cmd, const void *arg)
 915 {
 916     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 917     return ioctl(dpif->fd, cmd, arg) ? errno : 0;
 918 }
 919
 920 bool
 921 dpif_linux_is_internal_device(const char *name)
 922 {
 923     struct dpif_linux_vport reply;
 924     struct ofpbuf *buf;
 925     int error;
 926
 927     error = dpif_linux_vport_get(name, &reply, &buf);
 928     if (!error) {
 929         ofpbuf_delete(buf);
 930     } else if (error != ENODEV) {
 931         VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
 932                      name, strerror(error));
 933     }
 934
 935     return reply.type == ODP_VPORT_TYPE_INTERNAL;
 936 }
 937
 938 static int
 939 make_openvswitch_device(int minor, char **fnp)
 940 {
 941     const char dirname[] = "/dev/net";
 942     int major;
 943     dev_t dev;
 944     struct stat s;
 945     char fn[128];
 946
 947     *fnp = NULL;
 948
 949     major = get_openvswitch_major();
 950     if (major < 0) {
 951         return -major;
 952     }
 953     dev = makedev(major, minor);
 954
 955     sprintf(fn, "%s/dp%d", dirname, minor);
 956     if (!stat(fn, &s)) {
 957         if (!S_ISCHR(s.st_mode)) {
 958             VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
 959                          fn);
 960         } else if (s.st_rdev != dev) {
 961             VLOG_WARN_RL(&error_rl,
 962                          "%s is device %u:%u but should be %u:%u, fixing",
 963                          fn, major(s.st_rdev), minor(s.st_rdev),
 964                          major(dev), minor(dev));
 965         } else {
 966             goto success;
 967         }
 968         if (unlink(fn)) {
 969             VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
 970                          fn, strerror(errno));
 971             return errno;
 972         }
 973     } else if (errno == ENOENT) {
 974         if (stat(dirname, &s)) {
 975             if (errno == ENOENT) {
 976                 if (mkdir(dirname, 0755)) {
 977                     VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
 978                                  dirname, strerror(errno));
 979                     return errno;
 980                 }
 981             } else {
 982                 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
 983                              dirname, strerror(errno));
 984                 return errno;
 985             }
 986         }
 987     } else {
 988         VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
 989         return errno;
 990     }
 991
 992     /* The device needs to be created. */
 993     if (mknod(fn, S_IFCHR | 0700, dev)) {
 994         VLOG_WARN_RL(&error_rl,
 995                      "%s: creating character device %u:%u failed (%s)",
 996                      fn, major(dev), minor(dev), strerror(errno));
 997         return errno;
 998     }
 999
1000 success:
1001     *fnp = xstrdup(fn);
1002     return 0;
1003 }
1004
1005 /* Return the major device number of the Open vSwitch device.  If it
1006  * cannot be determined, a negative errno is returned. */
1007 static int
1008 get_openvswitch_major(void)
1009 {
1010     static int openvswitch_major = -1;
1011     if (openvswitch_major < 0) {
1012         openvswitch_major = get_major("openvswitch");
1013     }
1014     return openvswitch_major;
1015 }
1016
1017 static int
1018 get_major(const char *target)
1019 {
1020     const char fn[] = "/proc/devices";
1021     char line[128];
1022     FILE *file;
1023     int ln;
1024
1025     file = fopen(fn, "r");
1026     if (!file) {
1027         VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
1028         return -errno;
1029     }
1030
1031     for (ln = 1; fgets(line, sizeof line, file); ln++) {
1032         char name[64];
1033         int major;
1034
1035         if (!strncmp(line, "Character", 9) || line[0] == '\0') {
1036             /* Nothing to do. */
1037         } else if (!strncmp(line, "Block", 5)) {
1038             /* We only want character devices, so skip the rest of the file. */
1039             break;
1040         } else if (sscanf(line, "%d %63s", &major, name)) {
1041             if (!strcmp(name, target)) {
1042                 fclose(file);
1043                 return major;
1044             }
1045         } else {
1046             VLOG_WARN_ONCE("%s:%d: syntax error", fn, ln);
1047         }
1048     }
1049
1050     fclose(file);
1051
1052     VLOG_ERR("%s: %s major not found (is the module loaded?)", fn, target);
1053     return -ENODEV;
1054 }
1055
1056 static int
1057 open_minor(int minor, int *fdp)
1058 {
1059     int error;
1060     char *fn;
1061
1062     error = make_openvswitch_device(minor, &fn);
1063     if (error) {
1064         return error;
1065     }
1066
1067     *fdp = open(fn, O_RDONLY | O_NONBLOCK);
1068     if (*fdp < 0) {
1069         error = errno;
1070         VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
1071         free(fn);
1072         return error;
1073     }
1074     free(fn);
1075     return 0;
1076 }
1077
1078 static void
1079 dpif_linux_port_changed(const struct rtnetlink_link_change *change,
1080                         void *dpif_)
1081 {
1082     struct dpif_linux *dpif = dpif_;
1083
1084     if (change) {
1085         if (change->master_ifindex == dpif->local_ifindex
1086             && (change->nlmsg_type == RTM_NEWLINK
1087                 || change->nlmsg_type == RTM_DELLINK))
1088         {
1089             /* Our datapath changed, either adding a new port or deleting an
1090              * existing one. */
1091             shash_add_once(&dpif->changed_ports, change->ifname, NULL);
1092         }
1093     } else {
1094         dpif->change_error = true;
1095     }
1096 }
1097
1098 static int
1099 get_dp0_fd(int *dp0_fdp)
1100 {
1101     static int dp0_fd = -1;
1102     if (dp0_fd < 0) {
1103         int error;
1104         int fd;
1105
1106         error = open_minor(0, &fd);
1107         if (error) {
1108             return error;
1109         }
1110         dp0_fd = fd;
1111     }
1112     *dp0_fdp = dp0_fd;
1113     return 0;
1114 }
1115 \f
1116 /* Parses the contents of 'buf', which contains a "struct odp_vport" followed
1117  * by Netlink attributes, into 'vport'.  Returns 0 if successful, otherwise a
1118  * positive errno value.
1119  *
1120  * 'vport' will contain pointers into 'buf', so the caller should not free
1121  * 'buf' while 'vport' is still in use. */
1122 static int
1123 dpif_linux_vport_from_ofpbuf(struct dpif_linux_vport *vport,
1124                              const struct ofpbuf *buf)
1125 {
1126     static const struct nl_policy odp_vport_policy[] = {
1127         [ODP_VPORT_ATTR_PORT_NO] = { .type = NL_A_U32 },
1128         [ODP_VPORT_ATTR_TYPE] = { .type = NL_A_U32 },
1129         [ODP_VPORT_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1130         [ODP_VPORT_ATTR_STATS] = { .type = NL_A_UNSPEC,
1131                                    .min_len = sizeof(struct rtnl_link_stats64),
1132                                    .max_len = sizeof(struct rtnl_link_stats64),
1133                                    .optional = true },
1134         [ODP_VPORT_ATTR_ADDRESS] = { .type = NL_A_UNSPEC,
1135                                      .min_len = ETH_ADDR_LEN,
1136                                      .max_len = ETH_ADDR_LEN,
1137                                      .optional = true },
1138         [ODP_VPORT_ATTR_MTU] = { .type = NL_A_U32, .optional = true },
1139         [ODP_VPORT_ATTR_OPTIONS] = { .type = NL_A_NESTED, .optional = true },
1140         [ODP_VPORT_ATTR_IFINDEX] = { .type = NL_A_U32, .optional = true },
1141         [ODP_VPORT_ATTR_IFLINK] = { .type = NL_A_U32, .optional = true },
1142     };
1143
1144     struct odp_vport *odp_vport;
1145     struct nlattr *a[ARRAY_SIZE(odp_vport_policy)];
1146
1147     dpif_linux_vport_init(vport);
1148
1149     if (!nl_policy_parse(buf, sizeof *odp_vport, odp_vport_policy,
1150                          a, ARRAY_SIZE(odp_vport_policy))) {
1151         return EINVAL;
1152     }
1153     odp_vport = buf->data;
1154
1155     vport->dp_idx = odp_vport->dp_idx;
1156     vport->port_no = nl_attr_get_u32(a[ODP_VPORT_ATTR_PORT_NO]);
1157     vport->type = nl_attr_get_u32(a[ODP_VPORT_ATTR_TYPE]);
1158     vport->name = nl_attr_get_string(a[ODP_VPORT_ATTR_NAME]);
1159     if (a[ODP_VPORT_ATTR_STATS]) {
1160         vport->stats = nl_attr_get(a[ODP_VPORT_ATTR_STATS]);
1161     }
1162     if (a[ODP_VPORT_ATTR_ADDRESS]) {
1163         vport->address = nl_attr_get(a[ODP_VPORT_ATTR_ADDRESS]);
1164     }
1165     if (a[ODP_VPORT_ATTR_MTU]) {
1166         vport->mtu = nl_attr_get_u32(a[ODP_VPORT_ATTR_MTU]);
1167     }
1168     if (a[ODP_VPORT_ATTR_OPTIONS]) {
1169         vport->options = nl_attr_get(a[ODP_VPORT_ATTR_OPTIONS]);
1170         vport->options_len = nl_attr_get_size(a[ODP_VPORT_ATTR_OPTIONS]);
1171     }
1172     if (a[ODP_VPORT_ATTR_IFINDEX]) {
1173         vport->ifindex = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFINDEX]);
1174     }
1175     if (a[ODP_VPORT_ATTR_IFLINK]) {
1176         vport->iflink = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFLINK]);
1177     }
1178     return 0;
1179 }
1180
1181 /* Appends to 'buf' (which must initially be empty) a "struct odp_vport"
1182  * followed by Netlink attributes corresponding to 'vport'. */
1183 static void
1184 dpif_linux_vport_to_ofpbuf(const struct dpif_linux_vport *vport,
1185                            struct ofpbuf *buf)
1186 {
1187     struct odp_vport *odp_vport;
1188
1189     ofpbuf_reserve(buf, sizeof odp_vport);
1190
1191     if (vport->port_no != UINT32_MAX) {
1192         nl_msg_put_u32(buf, ODP_VPORT_ATTR_PORT_NO, vport->port_no);
1193     }
1194
1195     if (vport->type != ODP_VPORT_TYPE_UNSPEC) {
1196         nl_msg_put_u32(buf, ODP_VPORT_ATTR_TYPE, vport->type);
1197     }
1198
1199     if (vport->name) {
1200         nl_msg_put_string(buf, ODP_VPORT_ATTR_NAME, vport->name);
1201     }
1202
1203     if (vport->stats) {
1204         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_STATS,
1205                           vport->stats, sizeof *vport->stats);
1206     }
1207
1208     if (vport->address) {
1209         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_ADDRESS,
1210                           vport->address, ETH_ADDR_LEN);
1211     }
1212
1213     if (vport->mtu) {
1214         nl_msg_put_u32(buf, ODP_VPORT_ATTR_MTU, vport->mtu);
1215     }
1216
1217     if (vport->options) {
1218         nl_msg_put_nested(buf, ODP_VPORT_ATTR_OPTIONS,
1219                           vport->options, vport->options_len);
1220     }
1221
1222     if (vport->ifindex) {
1223         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFINDEX, vport->ifindex);
1224     }
1225
1226     if (vport->iflink) {
1227         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFLINK, vport->iflink);
1228     }
1229
1230     odp_vport = ofpbuf_push_uninit(buf, sizeof *odp_vport);
1231     odp_vport->dp_idx = vport->dp_idx;
1232     odp_vport->len = buf->size;
1233     odp_vport->total_len = (char *) ofpbuf_end(buf) - (char *) buf->data;
1234 }
1235
1236 /* Clears 'vport' to "empty" values. */
1237 void
1238 dpif_linux_vport_init(struct dpif_linux_vport *vport)
1239 {
1240     memset(vport, 0, sizeof *vport);
1241     vport->dp_idx = UINT32_MAX;
1242     vport->port_no = UINT32_MAX;
1243 }
1244
1245 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1246  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1247  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1248  * result of the command is expected to be an odp_vport also, which is decoded
1249  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1250  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1251 int
1252 dpif_linux_vport_transact(const struct dpif_linux_vport *request,
1253                           struct dpif_linux_vport *reply,
1254                           struct ofpbuf **bufp)
1255 {
1256     struct ofpbuf *buf = NULL;
1257     int error;
1258     int fd;
1259
1260     assert((reply != NULL) == (bufp != NULL));
1261
1262     error = get_dp0_fd(&fd);
1263     if (error) {
1264         goto error;
1265     }
1266
1267     buf = ofpbuf_new(1024);
1268     dpif_linux_vport_to_ofpbuf(request, buf);
1269
1270     error = ioctl(fd, request->cmd, buf->data) ? errno : 0;
1271     if (error) {
1272         goto error;
1273     }
1274
1275     if (bufp) {
1276         buf->size = ((struct odp_vport *) buf->data)->len;
1277         error = dpif_linux_vport_from_ofpbuf(reply, buf);
1278         if (error) {
1279             goto error;
1280         }
1281         *bufp = buf;
1282     } else {
1283         ofpbuf_delete(buf);
1284     }
1285     return 0;
1286
1287 error:
1288     ofpbuf_delete(buf);
1289     if (bufp) {
1290         memset(reply, 0, sizeof *reply);
1291         *bufp = NULL;
1292     }
1293     return error;
1294 }
1295
1296 /* Obtains information about the kernel vport named 'name' and stores it into
1297  * '*reply' and '*bufp'.  The caller must free '*bufp' when the reply is no
1298  * longer needed ('reply' will contain pointers into '*bufp').  */
1299 int
1300 dpif_linux_vport_get(const char *name, struct dpif_linux_vport *reply,
1301                      struct ofpbuf **bufp)
1302 {
1303     struct dpif_linux_vport request;
1304
1305     dpif_linux_vport_init(&request);
1306     request.cmd = ODP_VPORT_GET;
1307     request.name = name;
1308
1309     return dpif_linux_vport_transact(&request, reply, bufp);
1310 }
1311 \f
1312 /* Parses the contents of 'buf', which contains a "struct odp_datapath"
1313  * followed by Netlink attributes, into 'dp'.  Returns 0 if successful,
1314  * otherwise a positive errno value.
1315  *
1316  * 'dp' will contain pointers into 'buf', so the caller should not free 'buf'
1317  * while 'dp' is still in use. */
1318 static int
1319 dpif_linux_dp_from_ofpbuf(struct dpif_linux_dp *dp, const struct ofpbuf *buf)
1320 {
1321     static const struct nl_policy odp_datapath_policy[] = {
1322         [ODP_DP_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1323         [ODP_DP_ATTR_STATS] = { .type = NL_A_UNSPEC,
1324                                 .min_len = sizeof(struct odp_stats),
1325                                 .max_len = sizeof(struct odp_stats),
1326                                 .optional = true },
1327         [ODP_DP_ATTR_IPV4_FRAGS] = { .type = NL_A_U32, .optional = true },
1328         [ODP_DP_ATTR_SAMPLING] = { .type = NL_A_U32, .optional = true },
1329     };
1330
1331     struct odp_datapath *odp_dp;
1332     struct nlattr *a[ARRAY_SIZE(odp_datapath_policy)];
1333
1334     dpif_linux_dp_init(dp);
1335
1336     if (!nl_policy_parse(buf, sizeof *odp_dp, odp_datapath_policy,
1337                          a, ARRAY_SIZE(odp_datapath_policy))) {
1338         return EINVAL;
1339     }
1340     odp_dp = buf->data;
1341
1342     dp->dp_idx = odp_dp->dp_idx;
1343     dp->name = nl_attr_get_string(a[ODP_DP_ATTR_NAME]);
1344     if (a[ODP_DP_ATTR_STATS]) {
1345         /* Can't use structure assignment because Netlink doesn't ensure
1346          * sufficient alignment for 64-bit members. */
1347         memcpy(&dp->stats, nl_attr_get(a[ODP_DP_ATTR_STATS]),
1348                sizeof dp->stats);
1349     }
1350     if (a[ODP_DP_ATTR_IPV4_FRAGS]) {
1351         dp->ipv4_frags = nl_attr_get_u32(a[ODP_DP_ATTR_IPV4_FRAGS]);
1352     }
1353     if (a[ODP_DP_ATTR_SAMPLING]) {
1354         dp->sampling = nl_attr_get(a[ODP_DP_ATTR_SAMPLING]);
1355     }
1356     return 0;
1357 }
1358
1359 /* Appends to 'buf' (which must initially be empty) a "struct odp_datapath"
1360  * followed by Netlink attributes corresponding to 'dp'. */
1361 static void
1362 dpif_linux_dp_to_ofpbuf(const struct dpif_linux_dp *dp, struct ofpbuf *buf)
1363 {
1364     struct odp_datapath *odp_dp;
1365
1366     ofpbuf_reserve(buf, sizeof odp_dp);
1367
1368     if (dp->name) {
1369         nl_msg_put_string(buf, ODP_DP_ATTR_NAME, dp->name);
1370     }
1371
1372     /* Skip ODP_DP_ATTR_STATS since we never have a reason to serialize it. */
1373
1374     if (dp->ipv4_frags) {
1375         nl_msg_put_u32(buf, ODP_DP_ATTR_IPV4_FRAGS, dp->ipv4_frags);
1376     }
1377
1378     if (dp->sampling) {
1379         nl_msg_put_u32(buf, ODP_DP_ATTR_SAMPLING, *dp->sampling);
1380     }
1381
1382     odp_dp = ofpbuf_push_uninit(buf, sizeof *odp_dp);
1383     odp_dp->dp_idx = dp->dp_idx;
1384     odp_dp->len = buf->size;
1385     odp_dp->total_len = (char *) ofpbuf_end(buf) - (char *) buf->data;
1386 }
1387
1388 /* Clears 'dp' to "empty" values. */
1389 void
1390 dpif_linux_dp_init(struct dpif_linux_dp *dp)
1391 {
1392     memset(dp, 0, sizeof *dp);
1393     dp->dp_idx = -1;
1394 }
1395
1396 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1397  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1398  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1399  * result of the command is expected to be an odp_datapath also, which is
1400  * decoded and stored in '*reply' and '*bufp'.  The caller must free '*bufp'
1401  * when the reply is no longer needed ('reply' will contain pointers into
1402  * '*bufp'). */
1403 int
1404 dpif_linux_dp_transact(const struct dpif_linux_dp *request,
1405                        struct dpif_linux_dp *reply, struct ofpbuf **bufp)
1406 {
1407     struct ofpbuf *buf = NULL;
1408     int error;
1409     int fd;
1410
1411     assert((reply != NULL) == (bufp != NULL));
1412
1413     error = get_dp0_fd(&fd);
1414     if (error) {
1415         goto error;
1416     }
1417
1418     buf = ofpbuf_new(1024);
1419     dpif_linux_dp_to_ofpbuf(request, buf);
1420
1421     error = ioctl(fd, request->cmd, buf->data) ? errno : 0;
1422     if (error) {
1423         goto error;
1424     }
1425
1426     if (bufp) {
1427         buf->size = ((struct odp_datapath *) buf->data)->len;
1428         error = dpif_linux_dp_from_ofpbuf(reply, buf);
1429         if (error) {
1430             goto error;
1431         }
1432         *bufp = buf;
1433     } else {
1434         ofpbuf_delete(buf);
1435     }
1436     return 0;
1437
1438 error:
1439     ofpbuf_delete(buf);
1440     if (bufp) {
1441         memset(reply, 0, sizeof *reply);
1442         *bufp = NULL;
1443     }
1444     return error;
1445 }
1446
1447 /* Obtains information about 'dpif_' and stores it into '*reply' and '*bufp'.
1448  * The caller must free '*bufp' when the reply is no longer needed ('reply'
1449  * will contain pointers into '*bufp').  */
1450 int
1451 dpif_linux_dp_get(const struct dpif *dpif_, struct dpif_linux_dp *reply,
1452                   struct ofpbuf **bufp)
1453 {
1454     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
1455     struct dpif_linux_dp request;
1456
1457     dpif_linux_dp_init(&request);
1458     request.cmd = ODP_DP_GET;
1459     request.dp_idx = dpif->minor;
1460
1461     return dpif_linux_dp_transact(&request, reply, bufp);
1462 }
1463 \f
1464 /* Parses the contents of 'buf', which contains a "struct odp_flow" followed by
1465  * Netlink attributes, into 'flow'.  Returns 0 if successful, otherwise a
1466  * positive errno value.
1467  *
1468  * 'flow' will contain pointers into 'buf', so the caller should not free 'buf'
1469  * while 'flow' is still in use. */
1470 static int
1471 dpif_linux_flow_from_ofpbuf(struct dpif_linux_flow *flow,
1472                             const struct ofpbuf *buf)
1473 {
1474     static const struct nl_policy odp_flow_policy[] = {
1475         [ODP_FLOW_ATTR_KEY] = { .type = NL_A_NESTED },
1476         [ODP_FLOW_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
1477         [ODP_FLOW_ATTR_STATS] = { .type = NL_A_UNSPEC,
1478                                   .min_len = sizeof(struct odp_flow_stats),
1479                                   .max_len = sizeof(struct odp_flow_stats),
1480                                   .optional = true },
1481         [ODP_FLOW_ATTR_TCP_FLAGS] = { .type = NL_A_U8, .optional = true },
1482         [ODP_FLOW_ATTR_USED] = { .type = NL_A_U64, .optional = true },
1483         /* The kernel never uses ODP_FLOW_ATTR_CLEAR. */
1484         [ODP_FLOW_ATTR_STATE] = { .type = NL_A_U64, .optional = true },
1485     };
1486
1487     struct odp_flow *odp_flow;
1488     struct nlattr *a[ARRAY_SIZE(odp_flow_policy)];
1489
1490     dpif_linux_flow_init(flow);
1491
1492     if (!nl_policy_parse(buf, sizeof *odp_flow, odp_flow_policy,
1493                          a, ARRAY_SIZE(odp_flow_policy))) {
1494         return EINVAL;
1495     }
1496     odp_flow = buf->data;
1497
1498     flow->nlmsg_flags = odp_flow->nlmsg_flags;
1499     flow->dp_idx = odp_flow->dp_idx;
1500     flow->key = nl_attr_get(a[ODP_FLOW_ATTR_KEY]);
1501     flow->key_len = nl_attr_get_size(a[ODP_FLOW_ATTR_KEY]);
1502     if (a[ODP_FLOW_ATTR_ACTIONS]) {
1503         flow->actions = nl_attr_get(a[ODP_FLOW_ATTR_ACTIONS]);
1504         flow->actions_len = nl_attr_get_size(a[ODP_FLOW_ATTR_ACTIONS]);
1505     }
1506     if (a[ODP_FLOW_ATTR_STATS]) {
1507         flow->stats = nl_attr_get(a[ODP_FLOW_ATTR_STATS]);
1508     }
1509     if (a[ODP_FLOW_ATTR_TCP_FLAGS]) {
1510         flow->tcp_flags = nl_attr_get(a[ODP_FLOW_ATTR_TCP_FLAGS]);
1511     }
1512     if (a[ODP_FLOW_ATTR_STATE]) {
1513         flow->state = nl_attr_get(a[ODP_FLOW_ATTR_STATE]);
1514     }
1515     return 0;
1516 }
1517
1518 /* Appends to 'buf' (which must initially be empty) a "struct odp_flow"
1519  * followed by Netlink attributes corresponding to 'flow'. */
1520 static void
1521 dpif_linux_flow_to_ofpbuf(const struct dpif_linux_flow *flow,
1522                           struct ofpbuf *buf)
1523 {
1524     struct odp_flow *odp_flow;
1525
1526     ofpbuf_reserve(buf, sizeof odp_flow);
1527
1528     if (flow->key_len) {
1529         nl_msg_put_unspec(buf, ODP_FLOW_ATTR_KEY, flow->key, flow->key_len);
1530     }
1531
1532     if (flow->actions_len) {
1533         nl_msg_put_unspec(buf, ODP_FLOW_ATTR_ACTIONS,
1534                           flow->actions, flow->actions_len);
1535     }
1536
1537     /* We never need to send these to the kernel. */
1538     assert(!flow->stats);
1539     assert(!flow->tcp_flags);
1540     assert(!flow->used);
1541
1542     if (flow->clear) {
1543         nl_msg_put_flag(buf, ODP_FLOW_ATTR_CLEAR);
1544     }
1545
1546     if (flow->state) {
1547         nl_msg_put_u64(buf, ODP_FLOW_ATTR_STATE,
1548                        get_unaligned_u64(flow->state));
1549     }
1550
1551     odp_flow = ofpbuf_push_uninit(buf, sizeof *odp_flow);
1552     odp_flow->nlmsg_flags = flow->nlmsg_flags;
1553     odp_flow->dp_idx = flow->dp_idx;
1554     odp_flow->len = buf->size;
1555     odp_flow->total_len = (char *) ofpbuf_end(buf) - (char *) buf->data;
1556 }
1557
1558 /* Clears 'flow' to "empty" values. */
1559 void
1560 dpif_linux_flow_init(struct dpif_linux_flow *flow)
1561 {
1562     memset(flow, 0, sizeof *flow);
1563 }
1564
1565 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1566  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1567  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1568  * result of the command is expected to be an odp_flow also, which is decoded
1569  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1570  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1571 int
1572 dpif_linux_flow_transact(const struct dpif_linux_flow *request,
1573                          struct dpif_linux_flow *reply, struct ofpbuf **bufp)
1574 {
1575     struct ofpbuf *buf = NULL;
1576     int error;
1577     int fd;
1578
1579     assert((reply != NULL) == (bufp != NULL));
1580
1581     error = get_dp0_fd(&fd);
1582     if (error) {
1583         goto error;
1584     }
1585
1586     buf = ofpbuf_new(1024);
1587     dpif_linux_flow_to_ofpbuf(request, buf);
1588
1589     error = ioctl(fd, request->cmd, buf->data) ? errno : 0;
1590     if (error) {
1591         goto error;
1592     }
1593
1594     if (bufp) {
1595         buf->size = ((struct odp_flow *) buf->data)->len;
1596         error = dpif_linux_flow_from_ofpbuf(reply, buf);
1597         if (error) {
1598             goto error;
1599         }
1600         *bufp = buf;
1601     } else {
1602         ofpbuf_delete(buf);
1603     }
1604     return 0;
1605
1606 error:
1607     ofpbuf_delete(buf);
1608     if (bufp) {
1609         memset(reply, 0, sizeof *reply);
1610         *bufp = NULL;
1611     }
1612     return error;
1613 }
1614
1615 static void
1616 dpif_linux_flow_get_stats(const struct dpif_linux_flow *flow,
1617                           struct dpif_flow_stats *stats)
1618 {
1619     if (flow->stats) {
1620         stats->n_packets = get_unaligned_u64(&flow->stats->n_packets);
1621         stats->n_bytes = get_unaligned_u64(&flow->stats->n_bytes);
1622     } else {
1623         stats->n_packets = 0;
1624         stats->n_bytes = 0;
1625     }
1626     stats->used = flow->used ? get_unaligned_u64(flow->used) : 0;
1627     stats->tcp_flags = flow->tcp_flags ? *flow->tcp_flags : 0;
1628 }
1629