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 "util.h"
  51 #include "vlog.h"
  52
  53 VLOG_DEFINE_THIS_MODULE(dpif_linux);
  54
  55 /* Datapath interface for the openvswitch Linux kernel module. */
  56 struct dpif_linux {
  57     struct dpif dpif;
  58     int fd;
  59
  60     /* Used by dpif_linux_get_all_names(). */
  61     char *local_ifname;
  62     int minor;
  63
  64     /* Change notification. */
  65     int local_ifindex;          /* Ifindex of local port. */
  66     struct shash changed_ports;  /* Ports that have changed. */
  67     struct rtnetlink_notifier port_notifier;
  68     bool change_error;
  69 };
  70
  71 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
  72
  73 static int do_ioctl(const struct dpif *, int cmd, const void *arg);
  74 static int open_dpif(const struct dpif_linux_vport *local_vport,
  75                      struct dpif **);
  76 static int get_openvswitch_major(void);
  77 static int create_minor(const char *name, int minor);
  78 static int open_minor(int minor, int *fdp);
  79 static int make_openvswitch_device(int minor, char **fnp);
  80 static void dpif_linux_port_changed(const struct rtnetlink_link_change *,
  81                                     void *dpif);
  82
  83 static struct dpif_linux *
  84 dpif_linux_cast(const struct dpif *dpif)
  85 {
  86     dpif_assert_class(dpif, &dpif_linux_class);
  87     return CONTAINER_OF(dpif, struct dpif_linux, dpif);
  88 }
  89
  90 static int
  91 dpif_linux_enumerate(struct svec *all_dps)
  92 {
  93     int major;
  94     int error;
  95     int i;
  96
  97     /* Check that the Open vSwitch module is loaded. */
  98     major = get_openvswitch_major();
  99     if (major < 0) {
 100         return -major;
 101     }
 102
 103     error = 0;
 104     for (i = 0; i < ODP_MAX; i++) {
 105         struct dpif *dpif;
 106         char devname[16];
 107         int retval;
 108
 109         sprintf(devname, "dp%d", i);
 110         retval = dpif_open(devname, "system", &dpif);
 111         if (!retval) {
 112             svec_add(all_dps, devname);
 113             dpif_uninit(dpif, true);
 114         } else if (retval != ENODEV && !error) {
 115             error = retval;
 116         }
 117     }
 118     return error;
 119 }
 120
 121 static int
 122 dpif_linux_open(const struct dpif_class *class OVS_UNUSED, const char *name,
 123                 bool create, struct dpif **dpifp)
 124 {
 125     struct dpif_linux_vport request, reply;
 126     struct ofpbuf *buf;
 127     int minor;
 128     int error;
 129
 130     minor = !strncmp(name, "dp", 2)
 131             && isdigit((unsigned char)name[2]) ? atoi(name + 2) : -1;
 132     if (create) {
 133         if (minor >= 0) {
 134             error = create_minor(name, minor);
 135             if (error) {
 136                 return error;
 137             }
 138         } else {
 139             /* Scan for unused minor number. */
 140             for (minor = 0; ; minor++) {
 141                 if (minor >= ODP_MAX) {
 142                     /* All datapath numbers in use. */
 143                     return ENOBUFS;
 144                 }
 145
 146                 error = create_minor(name, minor);
 147                 if (!error) {
 148                     break;
 149                 } else if (error != EBUSY) {
 150                     return error;
 151                 }
 152             }
 153         }
 154     }
 155
 156     dpif_linux_vport_init(&request);
 157     request.cmd = ODP_VPORT_GET;
 158     request.port_no = ODPP_LOCAL;
 159     if (minor >= 0) {
 160         request.dp_idx = minor;
 161     } else {
 162         request.name = name;
 163     }
 164
 165     error = dpif_linux_vport_transact(&request, &reply, &buf);
 166     if (error) {
 167         return error;
 168     } else if (reply.port_no != ODPP_LOCAL) {
 169         /* This is an Open vSwitch device but not the local port.  We
 170          * intentionally support only using the name of the local port as the
 171          * name of a datapath; otherwise, it would be too difficult to
 172          * enumerate all the names of a datapath. */
 173         error = EOPNOTSUPP;
 174     } else {
 175         error = open_dpif(&reply, dpifp);
 176     }
 177
 178     ofpbuf_delete(buf);
 179     return error;
 180 }
 181
 182 static int
 183 open_dpif(const struct dpif_linux_vport *local_vport, struct dpif **dpifp)
 184 {
 185     int dp_idx = local_vport->dp_idx;
 186     struct dpif_linux *dpif;
 187     char *name;
 188     int error;
 189     int fd;
 190
 191     error = open_minor(dp_idx, &fd);
 192     if (error) {
 193         goto error;
 194     }
 195
 196     dpif = xmalloc(sizeof *dpif);
 197     error = rtnetlink_link_notifier_register(&dpif->port_notifier,
 198                                              dpif_linux_port_changed, dpif);
 199     if (error) {
 200         goto error_free;
 201     }
 202
 203     name = xasprintf("dp%d", dp_idx);
 204     dpif_init(&dpif->dpif, &dpif_linux_class, name, dp_idx, dp_idx);
 205     free(name);
 206
 207     dpif->fd = fd;
 208     dpif->local_ifname = xstrdup(local_vport->name);
 209     dpif->local_ifindex = local_vport->ifindex;
 210     dpif->minor = dp_idx;
 211     shash_init(&dpif->changed_ports);
 212     dpif->change_error = false;
 213     *dpifp = &dpif->dpif;
 214
 215     return 0;
 216
 217 error_free:
 218     free(dpif);
 219     close(fd);
 220 error:
 221     return error;
 222 }
 223
 224 static void
 225 dpif_linux_close(struct dpif *dpif_)
 226 {
 227     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 228     rtnetlink_link_notifier_unregister(&dpif->port_notifier);
 229     shash_destroy(&dpif->changed_ports);
 230     free(dpif->local_ifname);
 231     close(dpif->fd);
 232     free(dpif);
 233 }
 234
 235 static int
 236 dpif_linux_get_all_names(const struct dpif *dpif_, struct svec *all_names)
 237 {
 238     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 239
 240     svec_add_nocopy(all_names, xasprintf("dp%d", dpif->minor));
 241     svec_add(all_names, dpif->local_ifname);
 242     return 0;
 243 }
 244
 245 static int
 246 dpif_linux_destroy(struct dpif *dpif_)
 247 {
 248     return do_ioctl(dpif_, ODP_DP_DESTROY, NULL);
 249 }
 250
 251 static int
 252 dpif_linux_get_stats(const struct dpif *dpif_, struct odp_stats *stats)
 253 {
 254     memset(stats, 0, sizeof *stats);
 255     return do_ioctl(dpif_, ODP_DP_STATS, stats);
 256 }
 257
 258 static int
 259 dpif_linux_get_drop_frags(const struct dpif *dpif_, bool *drop_fragsp)
 260 {
 261     int drop_frags;
 262     int error;
 263
 264     error = do_ioctl(dpif_, ODP_GET_DROP_FRAGS, &drop_frags);
 265     if (!error) {
 266         *drop_fragsp = drop_frags & 1;
 267     }
 268     return error;
 269 }
 270
 271 static int
 272 dpif_linux_set_drop_frags(struct dpif *dpif_, bool drop_frags)
 273 {
 274     int drop_frags_int = drop_frags;
 275     return do_ioctl(dpif_, ODP_SET_DROP_FRAGS, &drop_frags_int);
 276 }
 277
 278 static int
 279 dpif_linux_port_add(struct dpif *dpif_, struct netdev *netdev,
 280                     uint16_t *port_nop)
 281 {
 282     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 283     const char *name = netdev_get_name(netdev);
 284     const char *type = netdev_get_type(netdev);
 285     struct dpif_linux_vport request, reply;
 286     const struct ofpbuf *options;
 287     struct ofpbuf *buf;
 288     int error;
 289
 290     dpif_linux_vport_init(&request);
 291     request.cmd = ODP_VPORT_NEW;
 292     request.dp_idx = dpif->minor;
 293     request.type = netdev_vport_get_vport_type(netdev);
 294     if (request.type == ODP_VPORT_TYPE_UNSPEC) {
 295         VLOG_WARN_RL(&error_rl, "%s: cannot create port `%s' because it has "
 296                      "unsupported type `%s'",
 297                      dpif_name(dpif_), name, type);
 298         return EINVAL;
 299     }
 300     request.name = name;
 301
 302     options = netdev_vport_get_options(netdev);
 303     if (options && options->size) {
 304         request.options = options->data;
 305         request.options_len = options->size;
 306     }
 307
 308     error = dpif_linux_vport_transact(&request, &reply, &buf);
 309     if (!error) {
 310         *port_nop = reply.port_no;
 311         ofpbuf_delete(buf);
 312     }
 313
 314     return error;
 315 }
 316
 317 static int
 318 dpif_linux_port_del(struct dpif *dpif_, uint16_t port_no)
 319 {
 320     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 321     struct dpif_linux_vport vport;
 322
 323     dpif_linux_vport_init(&vport);
 324     vport.cmd = ODP_VPORT_DEL;
 325     vport.dp_idx = dpif->minor;
 326     vport.port_no = port_no;
 327     return dpif_linux_vport_transact(&vport, NULL, NULL);
 328 }
 329
 330 static int
 331 dpif_linux_port_query__(const struct dpif *dpif, uint32_t port_no,
 332                         const char *port_name, struct dpif_port *dpif_port)
 333 {
 334     struct dpif_linux_vport request;
 335     struct dpif_linux_vport reply;
 336     struct ofpbuf *buf;
 337     int error;
 338
 339     dpif_linux_vport_init(&request);
 340     request.cmd = ODP_VPORT_GET;
 341     request.dp_idx = dpif_linux_cast(dpif)->minor;
 342     request.port_no = port_no;
 343     request.name = port_name;
 344
 345     error = dpif_linux_vport_transact(&request, &reply, &buf);
 346     if (!error) {
 347         dpif_port->name = xstrdup(reply.name);
 348         dpif_port->type = xstrdup(netdev_vport_get_netdev_type(&reply));
 349         dpif_port->port_no = reply.port_no;
 350         ofpbuf_delete(buf);
 351     }
 352     return error;
 353 }
 354
 355 static int
 356 dpif_linux_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 357                                 struct dpif_port *dpif_port)
 358 {
 359     return dpif_linux_port_query__(dpif, port_no, NULL, dpif_port);
 360 }
 361
 362 static int
 363 dpif_linux_port_query_by_name(const struct dpif *dpif, const char *devname,
 364                               struct dpif_port *dpif_port)
 365 {
 366     return dpif_linux_port_query__(dpif, 0, devname, dpif_port);
 367 }
 368
 369 static int
 370 dpif_linux_get_max_ports(const struct dpif *dpif OVS_UNUSED)
 371 {
 372     /* If the datapath increases its range of supported ports, then it should
 373      * start reporting that. */
 374     return 1024;
 375 }
 376
 377 static int
 378 dpif_linux_flow_flush(struct dpif *dpif_)
 379 {
 380     return do_ioctl(dpif_, ODP_FLOW_FLUSH, NULL);
 381 }
 382
 383 struct dpif_linux_port_state {
 384     struct ofpbuf *buf;
 385     uint32_t next;
 386 };
 387
 388 static int
 389 dpif_linux_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 390 {
 391     *statep = xzalloc(sizeof(struct dpif_linux_port_state));
 392     return 0;
 393 }
 394
 395 static int
 396 dpif_linux_port_dump_next(const struct dpif *dpif, void *state_,
 397                           struct dpif_port *dpif_port)
 398 {
 399     struct dpif_linux_port_state *state = state_;
 400     struct dpif_linux_vport request, reply;
 401     struct ofpbuf *buf;
 402     int error;
 403
 404     ofpbuf_delete(state->buf);
 405     state->buf = NULL;
 406
 407     dpif_linux_vport_init(&request);
 408     request.cmd = ODP_VPORT_DUMP;
 409     request.dp_idx = dpif_linux_cast(dpif)->minor;
 410     request.port_no = state->next;
 411     error = dpif_linux_vport_transact(&request, &reply, &buf);
 412     if (error) {
 413         return error == ENODEV ? EOF : error;
 414     } else {
 415         dpif_port->name = (char *) reply.name;
 416         dpif_port->type = (char *) netdev_vport_get_netdev_type(&reply);
 417         dpif_port->port_no = reply.port_no;
 418         state->buf = buf;
 419         state->next = reply.port_no + 1;
 420         return 0;
 421     }
 422 }
 423
 424 static int
 425 dpif_linux_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
 426 {
 427     struct dpif_linux_port_state *state = state_;
 428     ofpbuf_delete(state->buf);
 429     free(state);
 430     return 0;
 431 }
 432
 433 static int
 434 dpif_linux_port_poll(const struct dpif *dpif_, char **devnamep)
 435 {
 436     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 437
 438     if (dpif->change_error) {
 439         dpif->change_error = false;
 440         shash_clear(&dpif->changed_ports);
 441         return ENOBUFS;
 442     } else if (!shash_is_empty(&dpif->changed_ports)) {
 443         struct shash_node *node = shash_first(&dpif->changed_ports);
 444         *devnamep = shash_steal(&dpif->changed_ports, node);
 445         return 0;
 446     } else {
 447         return EAGAIN;
 448     }
 449 }
 450
 451 static void
 452 dpif_linux_port_poll_wait(const struct dpif *dpif_)
 453 {
 454     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 455     if (!shash_is_empty(&dpif->changed_ports) || dpif->change_error) {
 456         poll_immediate_wake();
 457     } else {
 458         rtnetlink_link_notifier_wait();
 459     }
 460 }
 461
 462 static int
 463 dpif_linux_flow_get(const struct dpif *dpif_, int flags,
 464                     const struct nlattr *key, size_t key_len,
 465                     struct ofpbuf **actionsp, struct odp_flow_stats *stats)
 466 {
 467     struct ofpbuf *actions = NULL;
 468     struct odp_flow odp_flow;
 469     int error;
 470
 471     memset(&odp_flow, 0, sizeof odp_flow);
 472     odp_flow.key = (struct nlattr *) key;
 473     odp_flow.key_len = key_len;
 474     if (actionsp) {
 475         actions = *actionsp = ofpbuf_new(65536);
 476         odp_flow.actions = actions->base;
 477         odp_flow.actions_len = actions->allocated;
 478     }
 479     odp_flow.flags = flags;
 480
 481     error = do_ioctl(dpif_, ODP_FLOW_GET, &odp_flow);
 482     if (!error) {
 483         if (stats) {
 484             *stats = odp_flow.stats;
 485         }
 486         if (actions) {
 487             actions->size = odp_flow.actions_len;
 488             ofpbuf_trim(actions);
 489         }
 490     } else {
 491         if (actions) {
 492             ofpbuf_delete(actions);
 493         }
 494     }
 495     return error;
 496 }
 497
 498 static int
 499 dpif_linux_flow_put(struct dpif *dpif_, int flags,
 500                     const struct nlattr *key, size_t key_len,
 501                     const struct nlattr *actions, size_t actions_len,
 502                     struct odp_flow_stats *stats)
 503 {
 504     struct odp_flow_put put;
 505     int error;
 506
 507     memset(&put, 0, sizeof put);
 508     put.flow.key = (struct nlattr *) key;
 509     put.flow.key_len = key_len;
 510     put.flow.actions = (struct nlattr *) actions;
 511     put.flow.actions_len = actions_len;
 512     put.flow.flags = 0;
 513     put.flags = flags;
 514     error = do_ioctl(dpif_, ODP_FLOW_PUT, &put);
 515     if (!error && stats) {
 516         *stats = put.flow.stats;
 517     }
 518     return error;
 519 }
 520
 521 static int
 522 dpif_linux_flow_del(struct dpif *dpif_,
 523                     const struct nlattr *key, size_t key_len,
 524                     struct odp_flow_stats *stats)
 525 {
 526     struct odp_flow odp_flow;
 527     int error;
 528
 529     memset(&odp_flow, 0, sizeof odp_flow);
 530     odp_flow.key = (struct nlattr *) key;
 531     odp_flow.key_len = key_len;
 532     error = do_ioctl(dpif_, ODP_FLOW_DEL, &odp_flow);
 533     if (!error && stats) {
 534         *stats = odp_flow.stats;
 535     }
 536     return error;
 537 }
 538
 539 struct dpif_linux_flow_state {
 540     struct odp_flow_dump dump;
 541     struct odp_flow flow;
 542     uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
 543     uint32_t actionsbuf[65536 / sizeof(uint32_t)];
 544 };
 545
 546 static int
 547 dpif_linux_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 548 {
 549     struct dpif_linux_flow_state *state;
 550
 551     *statep = state = xmalloc(sizeof *state);
 552     state->dump.state[0] = 0;
 553     state->dump.state[1] = 0;
 554     state->dump.flow = &state->flow;
 555     return 0;
 556 }
 557
 558 static int
 559 dpif_linux_flow_dump_next(const struct dpif *dpif, void *state_,
 560                           const struct nlattr **key, size_t *key_len,
 561                           const struct nlattr **actions, size_t *actions_len,
 562                           const struct odp_flow_stats **stats)
 563 {
 564     struct dpif_linux_flow_state *state = state_;
 565     int error;
 566
 567     memset(&state->flow, 0, sizeof state->flow);
 568     state->flow.key = (struct nlattr *) state->keybuf;
 569     state->flow.key_len = sizeof state->keybuf;
 570     if (actions) {
 571         state->flow.actions = (struct nlattr *) state->actionsbuf;
 572         state->flow.actions_len = sizeof state->actionsbuf;
 573     }
 574
 575     error = do_ioctl(dpif, ODP_FLOW_DUMP, &state->dump);
 576     if (!error) {
 577         if (state->flow.flags & ODPFF_EOF) {
 578             return EOF;
 579         }
 580         if (key) {
 581             *key = (const struct nlattr *) state->keybuf;
 582             *key_len = state->flow.key_len;
 583         }
 584         if (actions) {
 585             *actions = (const struct nlattr *) state->actionsbuf;
 586             *actions_len = state->flow.actions_len;
 587         }
 588         if (stats) {
 589             *stats = &state->flow.stats;
 590         }
 591     }
 592     return error;
 593 }
 594
 595 static int
 596 dpif_linux_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state)
 597 {
 598     free(state);
 599     return 0;
 600 }
 601
 602 static int
 603 dpif_linux_execute(struct dpif *dpif_,
 604                    const struct nlattr *actions, size_t actions_len,
 605                    const struct ofpbuf *buf)
 606 {
 607     struct odp_execute execute;
 608     memset(&execute, 0, sizeof execute);
 609     execute.actions = (struct nlattr *) actions;
 610     execute.actions_len = actions_len;
 611     execute.data = buf->data;
 612     execute.length = buf->size;
 613     return do_ioctl(dpif_, ODP_EXECUTE, &execute);
 614 }
 615
 616 static int
 617 dpif_linux_recv_get_mask(const struct dpif *dpif_, int *listen_mask)
 618 {
 619     return do_ioctl(dpif_, ODP_GET_LISTEN_MASK, listen_mask);
 620 }
 621
 622 static int
 623 dpif_linux_recv_set_mask(struct dpif *dpif_, int listen_mask)
 624 {
 625     return do_ioctl(dpif_, ODP_SET_LISTEN_MASK, &listen_mask);
 626 }
 627
 628 static int
 629 dpif_linux_get_sflow_probability(const struct dpif *dpif_,
 630                                  uint32_t *probability)
 631 {
 632     return do_ioctl(dpif_, ODP_GET_SFLOW_PROBABILITY, probability);
 633 }
 634
 635 static int
 636 dpif_linux_set_sflow_probability(struct dpif *dpif_, uint32_t probability)
 637 {
 638     return do_ioctl(dpif_, ODP_SET_SFLOW_PROBABILITY, &probability);
 639 }
 640
 641 static int
 642 dpif_linux_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
 643                              uint32_t queue_id, uint32_t *priority)
 644 {
 645     if (queue_id < 0xf000) {
 646         *priority = TC_H_MAKE(1 << 16, queue_id + 1);
 647         return 0;
 648     } else {
 649         return EINVAL;
 650     }
 651 }
 652
 653 static int
 654 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall)
 655 {
 656     static const struct nl_policy odp_packet_policy[] = {
 657         /* Always present. */
 658         [ODP_PACKET_ATTR_TYPE] = { .type = NL_A_U32 },
 659         [ODP_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
 660                                      .min_len = ETH_HEADER_LEN },
 661         [ODP_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
 662
 663         /* _ODPL_ACTION_NR only. */
 664         [ODP_PACKET_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
 665
 666         /* _ODPL_SFLOW_NR only. */
 667         [ODP_PACKET_ATTR_SAMPLE_POOL] = { .type = NL_A_U32, .optional = true },
 668         [ODP_PACKET_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
 669     };
 670
 671     struct odp_packet *odp_packet = buf->data;
 672     struct nlattr *a[ARRAY_SIZE(odp_packet_policy)];
 673
 674     if (!nl_policy_parse(buf, sizeof *odp_packet, odp_packet_policy,
 675                          a, ARRAY_SIZE(odp_packet_policy))) {
 676         return EINVAL;
 677     }
 678
 679     memset(upcall, 0, sizeof *upcall);
 680     upcall->type = nl_attr_get_u32(a[ODP_PACKET_ATTR_TYPE]);
 681     upcall->packet = buf;
 682     upcall->packet->data = (void *) nl_attr_get(a[ODP_PACKET_ATTR_PACKET]);
 683     upcall->packet->size = nl_attr_get_size(a[ODP_PACKET_ATTR_PACKET]);
 684     upcall->key = (void *) nl_attr_get(a[ODP_PACKET_ATTR_KEY]);
 685     upcall->key_len = nl_attr_get_size(a[ODP_PACKET_ATTR_KEY]);
 686     upcall->userdata = (a[ODP_PACKET_ATTR_USERDATA]
 687                         ? nl_attr_get_u64(a[ODP_PACKET_ATTR_USERDATA])
 688                         : 0);
 689     upcall->sample_pool = (a[ODP_PACKET_ATTR_SAMPLE_POOL]
 690                         ? nl_attr_get_u32(a[ODP_PACKET_ATTR_SAMPLE_POOL])
 691                            : 0);
 692     if (a[ODP_PACKET_ATTR_ACTIONS]) {
 693         upcall->actions = (void *) nl_attr_get(a[ODP_PACKET_ATTR_ACTIONS]);
 694         upcall->actions_len = nl_attr_get_size(a[ODP_PACKET_ATTR_ACTIONS]);
 695     }
 696
 697     return 0;
 698 }
 699
 700 static int
 701 dpif_linux_recv(struct dpif *dpif_, struct dpif_upcall *upcall)
 702 {
 703     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 704     struct ofpbuf *buf;
 705     int retval;
 706     int error;
 707
 708     buf = ofpbuf_new(65536);
 709     retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
 710     if (retval < 0) {
 711         error = errno;
 712         if (error != EAGAIN) {
 713             VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
 714                          dpif_name(dpif_), strerror(error));
 715         }
 716     } else if (retval >= sizeof(struct odp_packet)) {
 717         struct odp_packet *odp_packet = buf->data;
 718         buf->size += retval;
 719
 720         if (odp_packet->len <= retval) {
 721             error = parse_odp_packet(buf, upcall);
 722         } else {
 723             VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
 724                          "from %"PRIu32" bytes to %d",
 725                          dpif_name(dpif_), odp_packet->len, retval);
 726             error = ERANGE;
 727         }
 728     } else if (!retval) {
 729         VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif_));
 730         error = EPROTO;
 731     } else {
 732         VLOG_WARN_RL(&error_rl, "%s: discarding too-short message (%d bytes)",
 733                      dpif_name(dpif_), retval);
 734         error = ERANGE;
 735     }
 736
 737     if (error) {
 738         ofpbuf_delete(buf);
 739     }
 740     return error;
 741 }
 742
 743 static void
 744 dpif_linux_recv_wait(struct dpif *dpif_)
 745 {
 746     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 747     poll_fd_wait(dpif->fd, POLLIN);
 748 }
 749
 750 static void
 751 dpif_linux_recv_purge(struct dpif *dpif_)
 752 {
 753     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 754     int i;
 755
 756     /* This is somewhat bogus because it assumes that the following macros have
 757      * fixed values, but it's going to go away later.  */
 758 #define DP_N_QUEUES 3
 759 #define DP_MAX_QUEUE_LEN 100
 760     for (i = 0; i < DP_N_QUEUES * DP_MAX_QUEUE_LEN; i++) {
 761         /* Reading even 1 byte discards a whole datagram and saves time. */
 762         char buffer;
 763
 764         if (read(dpif->fd, &buffer, 1) != 1) {
 765             break;
 766         }
 767     }
 768 }
 769
 770 const struct dpif_class dpif_linux_class = {
 771     "system",
 772     NULL,
 773     NULL,
 774     dpif_linux_enumerate,
 775     dpif_linux_open,
 776     dpif_linux_close,
 777     dpif_linux_get_all_names,
 778     dpif_linux_destroy,
 779     dpif_linux_get_stats,
 780     dpif_linux_get_drop_frags,
 781     dpif_linux_set_drop_frags,
 782     dpif_linux_port_add,
 783     dpif_linux_port_del,
 784     dpif_linux_port_query_by_number,
 785     dpif_linux_port_query_by_name,
 786     dpif_linux_get_max_ports,
 787     dpif_linux_port_dump_start,
 788     dpif_linux_port_dump_next,
 789     dpif_linux_port_dump_done,
 790     dpif_linux_port_poll,
 791     dpif_linux_port_poll_wait,
 792     dpif_linux_flow_get,
 793     dpif_linux_flow_put,
 794     dpif_linux_flow_del,
 795     dpif_linux_flow_flush,
 796     dpif_linux_flow_dump_start,
 797     dpif_linux_flow_dump_next,
 798     dpif_linux_flow_dump_done,
 799     dpif_linux_execute,
 800     dpif_linux_recv_get_mask,
 801     dpif_linux_recv_set_mask,
 802     dpif_linux_get_sflow_probability,
 803     dpif_linux_set_sflow_probability,
 804     dpif_linux_queue_to_priority,
 805     dpif_linux_recv,
 806     dpif_linux_recv_wait,
 807     dpif_linux_recv_purge,
 808 };
 809 \f
 810 static int get_openvswitch_major(void);
 811 static int get_major(const char *target);
 812
 813 static int
 814 do_ioctl(const struct dpif *dpif_, int cmd, const void *arg)
 815 {
 816     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 817     return ioctl(dpif->fd, cmd, arg) ? errno : 0;
 818 }
 819
 820 bool
 821 dpif_linux_is_internal_device(const char *name)
 822 {
 823     struct dpif_linux_vport reply;
 824     struct ofpbuf *buf;
 825     int error;
 826
 827     error = dpif_linux_vport_get(name, &reply, &buf);
 828     if (!error) {
 829         ofpbuf_delete(buf);
 830     } else if (error != ENODEV) {
 831         VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
 832                      name, strerror(error));
 833     }
 834
 835     return reply.type == ODP_VPORT_TYPE_INTERNAL;
 836 }
 837
 838 static int
 839 make_openvswitch_device(int minor, char **fnp)
 840 {
 841     const char dirname[] = "/dev/net";
 842     int major;
 843     dev_t dev;
 844     struct stat s;
 845     char fn[128];
 846
 847     *fnp = NULL;
 848
 849     major = get_openvswitch_major();
 850     if (major < 0) {
 851         return -major;
 852     }
 853     dev = makedev(major, minor);
 854
 855     sprintf(fn, "%s/dp%d", dirname, minor);
 856     if (!stat(fn, &s)) {
 857         if (!S_ISCHR(s.st_mode)) {
 858             VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
 859                          fn);
 860         } else if (s.st_rdev != dev) {
 861             VLOG_WARN_RL(&error_rl,
 862                          "%s is device %u:%u but should be %u:%u, fixing",
 863                          fn, major(s.st_rdev), minor(s.st_rdev),
 864                          major(dev), minor(dev));
 865         } else {
 866             goto success;
 867         }
 868         if (unlink(fn)) {
 869             VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
 870                          fn, strerror(errno));
 871             return errno;
 872         }
 873     } else if (errno == ENOENT) {
 874         if (stat(dirname, &s)) {
 875             if (errno == ENOENT) {
 876                 if (mkdir(dirname, 0755)) {
 877                     VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
 878                                  dirname, strerror(errno));
 879                     return errno;
 880                 }
 881             } else {
 882                 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
 883                              dirname, strerror(errno));
 884                 return errno;
 885             }
 886         }
 887     } else {
 888         VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
 889         return errno;
 890     }
 891
 892     /* The device needs to be created. */
 893     if (mknod(fn, S_IFCHR | 0700, dev)) {
 894         VLOG_WARN_RL(&error_rl,
 895                      "%s: creating character device %u:%u failed (%s)",
 896                      fn, major(dev), minor(dev), strerror(errno));
 897         return errno;
 898     }
 899
 900 success:
 901     *fnp = xstrdup(fn);
 902     return 0;
 903 }
 904
 905 /* Return the major device number of the Open vSwitch device.  If it
 906  * cannot be determined, a negative errno is returned. */
 907 static int
 908 get_openvswitch_major(void)
 909 {
 910     static int openvswitch_major = -1;
 911     if (openvswitch_major < 0) {
 912         openvswitch_major = get_major("openvswitch");
 913     }
 914     return openvswitch_major;
 915 }
 916
 917 static int
 918 get_major(const char *target)
 919 {
 920     const char fn[] = "/proc/devices";
 921     char line[128];
 922     FILE *file;
 923     int ln;
 924
 925     file = fopen(fn, "r");
 926     if (!file) {
 927         VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
 928         return -errno;
 929     }
 930
 931     for (ln = 1; fgets(line, sizeof line, file); ln++) {
 932         char name[64];
 933         int major;
 934
 935         if (!strncmp(line, "Character", 9) || line[0] == '\0') {
 936             /* Nothing to do. */
 937         } else if (!strncmp(line, "Block", 5)) {
 938             /* We only want character devices, so skip the rest of the file. */
 939             break;
 940         } else if (sscanf(line, "%d %63s", &major, name)) {
 941             if (!strcmp(name, target)) {
 942                 fclose(file);
 943                 return major;
 944             }
 945         } else {
 946             VLOG_WARN_ONCE("%s:%d: syntax error", fn, ln);
 947         }
 948     }
 949
 950     fclose(file);
 951
 952     VLOG_ERR("%s: %s major not found (is the module loaded?)", fn, target);
 953     return -ENODEV;
 954 }
 955
 956 static int
 957 create_minor(const char *name, int minor)
 958 {
 959     int error;
 960     int fd;
 961
 962     error = open_minor(minor, &fd);
 963     if (error) {
 964         return error;
 965     }
 966
 967     error = ioctl(fd, ODP_DP_CREATE, name) ? errno : 0;
 968     close(fd);
 969     return error;
 970 }
 971
 972 static int
 973 open_minor(int minor, int *fdp)
 974 {
 975     int error;
 976     char *fn;
 977
 978     error = make_openvswitch_device(minor, &fn);
 979     if (error) {
 980         return error;
 981     }
 982
 983     *fdp = open(fn, O_RDONLY | O_NONBLOCK);
 984     if (*fdp < 0) {
 985         error = errno;
 986         VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
 987         free(fn);
 988         return error;
 989     }
 990     free(fn);
 991     return 0;
 992 }
 993
 994 static void
 995 dpif_linux_port_changed(const struct rtnetlink_link_change *change,
 996                         void *dpif_)
 997 {
 998     struct dpif_linux *dpif = dpif_;
 999
1000     if (change) {
1001         if (change->master_ifindex == dpif->local_ifindex
1002             && (change->nlmsg_type == RTM_NEWLINK
1003                 || change->nlmsg_type == RTM_DELLINK))
1004         {
1005             /* Our datapath changed, either adding a new port or deleting an
1006              * existing one. */
1007             shash_add_once(&dpif->changed_ports, change->ifname, NULL);
1008         }
1009     } else {
1010         dpif->change_error = true;
1011     }
1012 }
1013 \f
1014 /* Parses the contents of 'buf', which contains a "struct odp_vport" followed
1015  * by Netlink attributes, into 'vport'.  Returns 0 if successful, otherwise a
1016  * positive errno value.
1017  *
1018  * 'vport' will contain pointers into 'buf', so the caller should not free
1019  * 'buf' while 'vport' is still in use. */
1020 static int
1021 dpif_linux_vport_from_ofpbuf(struct dpif_linux_vport *vport,
1022                              const struct ofpbuf *buf)
1023 {
1024     static const struct nl_policy odp_vport_policy[] = {
1025         [ODP_VPORT_ATTR_PORT_NO] = { .type = NL_A_U32 },
1026         [ODP_VPORT_ATTR_TYPE] = { .type = NL_A_U32 },
1027         [ODP_VPORT_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1028         [ODP_VPORT_ATTR_STATS] = { .type = NL_A_UNSPEC,
1029                                    .min_len = sizeof(struct rtnl_link_stats64),
1030                                    .max_len = sizeof(struct rtnl_link_stats64),
1031                                    .optional = true },
1032         [ODP_VPORT_ATTR_ADDRESS] = { .type = NL_A_UNSPEC,
1033                                      .min_len = ETH_ADDR_LEN,
1034                                      .max_len = ETH_ADDR_LEN,
1035                                      .optional = true },
1036         [ODP_VPORT_ATTR_MTU] = { .type = NL_A_U32, .optional = true },
1037         [ODP_VPORT_ATTR_OPTIONS] = { .type = NL_A_NESTED, .optional = true },
1038         [ODP_VPORT_ATTR_IFINDEX] = { .type = NL_A_U32, .optional = true },
1039         [ODP_VPORT_ATTR_IFLINK] = { .type = NL_A_U32, .optional = true },
1040     };
1041
1042     struct odp_vport *odp_vport;
1043     struct nlattr *a[ARRAY_SIZE(odp_vport_policy)];
1044
1045     dpif_linux_vport_init(vport);
1046
1047     if (!nl_policy_parse(buf, sizeof *odp_vport, odp_vport_policy,
1048                          a, ARRAY_SIZE(odp_vport_policy))) {
1049         return EINVAL;
1050     }
1051     odp_vport = buf->data;
1052
1053     vport->dp_idx = odp_vport->dp_idx;
1054     vport->port_no = nl_attr_get_u32(a[ODP_VPORT_ATTR_PORT_NO]);
1055     vport->type = nl_attr_get_u32(a[ODP_VPORT_ATTR_TYPE]);
1056     vport->name = nl_attr_get_string(a[ODP_VPORT_ATTR_NAME]);
1057     if (a[ODP_VPORT_ATTR_STATS]) {
1058         vport->stats = nl_attr_get(a[ODP_VPORT_ATTR_STATS]);
1059     }
1060     if (a[ODP_VPORT_ATTR_ADDRESS]) {
1061         vport->address = nl_attr_get(a[ODP_VPORT_ATTR_ADDRESS]);
1062     }
1063     if (a[ODP_VPORT_ATTR_MTU]) {
1064         vport->mtu = nl_attr_get_u32(a[ODP_VPORT_ATTR_MTU]);
1065     }
1066     if (a[ODP_VPORT_ATTR_OPTIONS]) {
1067         vport->options = nl_attr_get(a[ODP_VPORT_ATTR_OPTIONS]);
1068         vport->options_len = nl_attr_get_size(a[ODP_VPORT_ATTR_OPTIONS]);
1069     }
1070     if (a[ODP_VPORT_ATTR_IFINDEX]) {
1071         vport->ifindex = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFINDEX]);
1072     }
1073     if (a[ODP_VPORT_ATTR_IFLINK]) {
1074         vport->iflink = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFLINK]);
1075     }
1076     return 0;
1077 }
1078
1079 /* Appends to 'buf' (which must initially be empty) a "struct odp_vport"
1080  * followed by Netlink attributes corresponding to 'vport'. */
1081 static void
1082 dpif_linux_vport_to_ofpbuf(const struct dpif_linux_vport *vport,
1083                            struct ofpbuf *buf)
1084 {
1085     struct odp_vport *odp_vport;
1086
1087     ofpbuf_reserve(buf, sizeof odp_vport);
1088
1089     if (vport->port_no != UINT32_MAX) {
1090         nl_msg_put_u32(buf, ODP_VPORT_ATTR_PORT_NO, vport->port_no);
1091     }
1092
1093     if (vport->type != ODP_VPORT_TYPE_UNSPEC) {
1094         nl_msg_put_u32(buf, ODP_VPORT_ATTR_TYPE, vport->type);
1095     }
1096
1097     if (vport->name) {
1098         nl_msg_put_string(buf, ODP_VPORT_ATTR_NAME, vport->name);
1099     }
1100
1101     if (vport->stats) {
1102         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_STATS,
1103                           vport->stats, sizeof *vport->stats);
1104     }
1105
1106     if (vport->address) {
1107         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_ADDRESS,
1108                           vport->address, ETH_ADDR_LEN);
1109     }
1110
1111     if (vport->mtu) {
1112         nl_msg_put_u32(buf, ODP_VPORT_ATTR_MTU, vport->mtu);
1113     }
1114
1115     if (vport->options) {
1116         nl_msg_put_nested(buf, ODP_VPORT_ATTR_OPTIONS,
1117                           vport->options, vport->options_len);
1118     }
1119
1120     if (vport->ifindex) {
1121         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFINDEX, vport->ifindex);
1122     }
1123
1124     if (vport->iflink) {
1125         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFLINK, vport->iflink);
1126     }
1127
1128     odp_vport = ofpbuf_push_uninit(buf, sizeof *odp_vport);
1129     odp_vport->dp_idx = vport->dp_idx;
1130     odp_vport->len = buf->size;
1131     odp_vport->total_len = (char *) ofpbuf_end(buf) - (char *) buf->data;
1132 }
1133
1134 /* Clears 'vport' to "empty" values. */
1135 void
1136 dpif_linux_vport_init(struct dpif_linux_vport *vport)
1137 {
1138     memset(vport, 0, sizeof *vport);
1139     vport->dp_idx = UINT32_MAX;
1140     vport->port_no = UINT32_MAX;
1141 }
1142
1143 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1144  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1145  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1146  * result of the command is expected to be an odp_vport also, which is decoded
1147  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1148  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1149 int
1150 dpif_linux_vport_transact(const struct dpif_linux_vport *request,
1151                           struct dpif_linux_vport *reply,
1152                           struct ofpbuf **bufp)
1153 {
1154     static int dp0_fd = -1;
1155     struct ofpbuf *buf = NULL;
1156     int error;
1157
1158     assert((reply != NULL) == (bufp != NULL));
1159     if (dp0_fd < 0) {
1160         int fd;
1161
1162         error = open_minor(0, &fd);
1163         if (error) {
1164             goto error;
1165         }
1166         dp0_fd = fd;
1167     }
1168
1169     buf = ofpbuf_new(1024);
1170     dpif_linux_vport_to_ofpbuf(request, buf);
1171
1172     error = ioctl(dp0_fd, request->cmd, buf->data) ? errno : 0;
1173     if (error) {
1174         goto error;
1175     }
1176
1177     if (bufp) {
1178         buf->size = ((struct odp_vport *) buf->data)->len;
1179         error = dpif_linux_vport_from_ofpbuf(reply, buf);
1180         if (error) {
1181             goto error;
1182         }
1183         *bufp = buf;
1184     } else {
1185         ofpbuf_delete(buf);
1186     }
1187     return 0;
1188
1189 error:
1190     ofpbuf_delete(buf);
1191     if (bufp) {
1192         memset(reply, 0, sizeof *reply);
1193         *bufp = NULL;
1194     }
1195     return error;
1196 }
1197
1198 /* Obtains information about the kernel vport named 'name' and stores it into
1199  * '*reply' and '*bufp'.  The caller must free '*bufp' when the reply is no
1200  * longer needed ('reply' will contain pointers into '*bufp').  */
1201 int
1202 dpif_linux_vport_get(const char *name, struct dpif_linux_vport *reply,
1203                      struct ofpbuf **bufp)
1204 {
1205     struct dpif_linux_vport request;
1206
1207     dpif_linux_vport_init(&request);
1208     request.cmd = ODP_VPORT_GET;
1209     request.name = name;
1210
1211     return dpif_linux_vport_transact(&request, reply, bufp);
1212 }
1213