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 void
 463 odp_flow_stats_to_dpif_flow_stats(const struct odp_flow_stats *ofs,
 464                                   struct dpif_flow_stats *dfs)
 465 {
 466     dfs->n_packets = ofs->n_packets;
 467     dfs->n_bytes = ofs->n_bytes;
 468     dfs->used = ofs->used_sec * 1000 + ofs->used_nsec / 1000000;
 469     dfs->tcp_flags = ofs->tcp_flags;
 470 }
 471
 472 static int
 473 dpif_linux_flow_get(const struct dpif *dpif_,
 474                     const struct nlattr *key, size_t key_len,
 475                     struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 476 {
 477     struct ofpbuf *actions = NULL;
 478     struct odp_flow odp_flow;
 479     int error;
 480
 481     memset(&odp_flow, 0, sizeof odp_flow);
 482     odp_flow.key = (struct nlattr *) key;
 483     odp_flow.key_len = key_len;
 484     if (actionsp) {
 485         actions = *actionsp = ofpbuf_new(65536);
 486         odp_flow.actions = actions->base;
 487         odp_flow.actions_len = actions->allocated;
 488     }
 489
 490     error = do_ioctl(dpif_, ODP_FLOW_GET, &odp_flow);
 491     if (!error) {
 492         if (stats) {
 493             odp_flow_stats_to_dpif_flow_stats(&odp_flow.stats, stats);
 494         }
 495         if (actions) {
 496             actions->size = odp_flow.actions_len;
 497             ofpbuf_trim(actions);
 498         }
 499     } else {
 500         if (actions) {
 501             ofpbuf_delete(actions);
 502         }
 503     }
 504     return error;
 505 }
 506
 507 static int
 508 dpif_linux_flow_put(struct dpif *dpif_, enum dpif_flow_put_flags flags,
 509                     const struct nlattr *key, size_t key_len,
 510                     const struct nlattr *actions, size_t actions_len,
 511                     struct dpif_flow_stats *stats)
 512 {
 513     struct odp_flow_put put;
 514     int error;
 515
 516     memset(&put, 0, sizeof put);
 517     put.flow.key = (struct nlattr *) key;
 518     put.flow.key_len = key_len;
 519     put.flow.actions = (struct nlattr *) actions;
 520     put.flow.actions_len = actions_len;
 521     put.flags = 0;
 522     if (flags & DPIF_FP_CREATE) {
 523         put.flags |= ODPPF_CREATE;
 524     }
 525     if (flags & DPIF_FP_MODIFY) {
 526         put.flags |= ODPPF_MODIFY;
 527     }
 528     if (flags & DPIF_FP_ZERO_STATS) {
 529         put.flags |= ODPPF_ZERO_STATS;
 530     }
 531     error = do_ioctl(dpif_, ODP_FLOW_PUT, &put);
 532     if (!error && stats) {
 533         odp_flow_stats_to_dpif_flow_stats(&put.flow.stats, stats);
 534     }
 535     return error;
 536 }
 537
 538 static int
 539 dpif_linux_flow_del(struct dpif *dpif_,
 540                     const struct nlattr *key, size_t key_len,
 541                     struct dpif_flow_stats *stats)
 542 {
 543     struct odp_flow odp_flow;
 544     int error;
 545
 546     memset(&odp_flow, 0, sizeof odp_flow);
 547     odp_flow.key = (struct nlattr *) key;
 548     odp_flow.key_len = key_len;
 549     error = do_ioctl(dpif_, ODP_FLOW_DEL, &odp_flow);
 550     if (!error && stats) {
 551         odp_flow_stats_to_dpif_flow_stats(&odp_flow.stats, stats);
 552     }
 553     return error;
 554 }
 555
 556 struct dpif_linux_flow_state {
 557     struct odp_flow_dump dump;
 558     struct odp_flow flow;
 559     uint32_t keybuf[ODPUTIL_FLOW_KEY_U32S];
 560     uint32_t actionsbuf[65536 / sizeof(uint32_t)];
 561     struct dpif_flow_stats stats;
 562 };
 563
 564 static int
 565 dpif_linux_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
 566 {
 567     struct dpif_linux_flow_state *state;
 568
 569     *statep = state = xmalloc(sizeof *state);
 570     state->dump.state[0] = 0;
 571     state->dump.state[1] = 0;
 572     state->dump.flow = &state->flow;
 573     return 0;
 574 }
 575
 576 static int
 577 dpif_linux_flow_dump_next(const struct dpif *dpif, void *state_,
 578                           const struct nlattr **key, size_t *key_len,
 579                           const struct nlattr **actions, size_t *actions_len,
 580                           const struct dpif_flow_stats **stats)
 581 {
 582     struct dpif_linux_flow_state *state = state_;
 583     int error;
 584
 585     memset(&state->flow, 0, sizeof state->flow);
 586     state->flow.key = (struct nlattr *) state->keybuf;
 587     state->flow.key_len = sizeof state->keybuf;
 588     if (actions) {
 589         state->flow.actions = (struct nlattr *) state->actionsbuf;
 590         state->flow.actions_len = sizeof state->actionsbuf;
 591     }
 592
 593     error = do_ioctl(dpif, ODP_FLOW_DUMP, &state->dump);
 594     if (!error) {
 595         if (!state->flow.key_len) {
 596             return EOF;
 597         }
 598         if (key) {
 599             *key = (const struct nlattr *) state->keybuf;
 600             *key_len = state->flow.key_len;
 601         }
 602         if (actions) {
 603             *actions = (const struct nlattr *) state->actionsbuf;
 604             *actions_len = state->flow.actions_len;
 605         }
 606         if (stats) {
 607             odp_flow_stats_to_dpif_flow_stats(&state->flow.stats,
 608                                               &state->stats);
 609             *stats = &state->stats;
 610         }
 611     }
 612     return error;
 613 }
 614
 615 static int
 616 dpif_linux_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state)
 617 {
 618     free(state);
 619     return 0;
 620 }
 621
 622 static int
 623 dpif_linux_execute(struct dpif *dpif_,
 624                    const struct nlattr *actions, size_t actions_len,
 625                    const struct ofpbuf *buf)
 626 {
 627     struct odp_execute execute;
 628     memset(&execute, 0, sizeof execute);
 629     execute.actions = (struct nlattr *) actions;
 630     execute.actions_len = actions_len;
 631     execute.data = buf->data;
 632     execute.length = buf->size;
 633     return do_ioctl(dpif_, ODP_EXECUTE, &execute);
 634 }
 635
 636 static int
 637 dpif_linux_recv_get_mask(const struct dpif *dpif_, int *listen_mask)
 638 {
 639     return do_ioctl(dpif_, ODP_GET_LISTEN_MASK, listen_mask);
 640 }
 641
 642 static int
 643 dpif_linux_recv_set_mask(struct dpif *dpif_, int listen_mask)
 644 {
 645     return do_ioctl(dpif_, ODP_SET_LISTEN_MASK, &listen_mask);
 646 }
 647
 648 static int
 649 dpif_linux_get_sflow_probability(const struct dpif *dpif_,
 650                                  uint32_t *probability)
 651 {
 652     return do_ioctl(dpif_, ODP_GET_SFLOW_PROBABILITY, probability);
 653 }
 654
 655 static int
 656 dpif_linux_set_sflow_probability(struct dpif *dpif_, uint32_t probability)
 657 {
 658     return do_ioctl(dpif_, ODP_SET_SFLOW_PROBABILITY, &probability);
 659 }
 660
 661 static int
 662 dpif_linux_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
 663                              uint32_t queue_id, uint32_t *priority)
 664 {
 665     if (queue_id < 0xf000) {
 666         *priority = TC_H_MAKE(1 << 16, queue_id + 1);
 667         return 0;
 668     } else {
 669         return EINVAL;
 670     }
 671 }
 672
 673 static int
 674 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall)
 675 {
 676     static const struct nl_policy odp_packet_policy[] = {
 677         /* Always present. */
 678         [ODP_PACKET_ATTR_TYPE] = { .type = NL_A_U32 },
 679         [ODP_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
 680                                      .min_len = ETH_HEADER_LEN },
 681         [ODP_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
 682
 683         /* _ODPL_ACTION_NR only. */
 684         [ODP_PACKET_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
 685
 686         /* _ODPL_SFLOW_NR only. */
 687         [ODP_PACKET_ATTR_SAMPLE_POOL] = { .type = NL_A_U32, .optional = true },
 688         [ODP_PACKET_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
 689     };
 690
 691     struct odp_packet *odp_packet = buf->data;
 692     struct nlattr *a[ARRAY_SIZE(odp_packet_policy)];
 693
 694     if (!nl_policy_parse(buf, sizeof *odp_packet, odp_packet_policy,
 695                          a, ARRAY_SIZE(odp_packet_policy))) {
 696         return EINVAL;
 697     }
 698
 699     memset(upcall, 0, sizeof *upcall);
 700     upcall->type = nl_attr_get_u32(a[ODP_PACKET_ATTR_TYPE]);
 701     upcall->packet = buf;
 702     upcall->packet->data = (void *) nl_attr_get(a[ODP_PACKET_ATTR_PACKET]);
 703     upcall->packet->size = nl_attr_get_size(a[ODP_PACKET_ATTR_PACKET]);
 704     upcall->key = (void *) nl_attr_get(a[ODP_PACKET_ATTR_KEY]);
 705     upcall->key_len = nl_attr_get_size(a[ODP_PACKET_ATTR_KEY]);
 706     upcall->userdata = (a[ODP_PACKET_ATTR_USERDATA]
 707                         ? nl_attr_get_u64(a[ODP_PACKET_ATTR_USERDATA])
 708                         : 0);
 709     upcall->sample_pool = (a[ODP_PACKET_ATTR_SAMPLE_POOL]
 710                         ? nl_attr_get_u32(a[ODP_PACKET_ATTR_SAMPLE_POOL])
 711                            : 0);
 712     if (a[ODP_PACKET_ATTR_ACTIONS]) {
 713         upcall->actions = (void *) nl_attr_get(a[ODP_PACKET_ATTR_ACTIONS]);
 714         upcall->actions_len = nl_attr_get_size(a[ODP_PACKET_ATTR_ACTIONS]);
 715     }
 716
 717     return 0;
 718 }
 719
 720 static int
 721 dpif_linux_recv(struct dpif *dpif_, struct dpif_upcall *upcall)
 722 {
 723     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 724     struct ofpbuf *buf;
 725     int retval;
 726     int error;
 727
 728     buf = ofpbuf_new(65536);
 729     retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
 730     if (retval < 0) {
 731         error = errno;
 732         if (error != EAGAIN) {
 733             VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
 734                          dpif_name(dpif_), strerror(error));
 735         }
 736     } else if (retval >= sizeof(struct odp_packet)) {
 737         struct odp_packet *odp_packet = buf->data;
 738         buf->size += retval;
 739
 740         if (odp_packet->len <= retval) {
 741             error = parse_odp_packet(buf, upcall);
 742         } else {
 743             VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
 744                          "from %"PRIu32" bytes to %d",
 745                          dpif_name(dpif_), odp_packet->len, retval);
 746             error = ERANGE;
 747         }
 748     } else if (!retval) {
 749         VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif_));
 750         error = EPROTO;
 751     } else {
 752         VLOG_WARN_RL(&error_rl, "%s: discarding too-short message (%d bytes)",
 753                      dpif_name(dpif_), retval);
 754         error = ERANGE;
 755     }
 756
 757     if (error) {
 758         ofpbuf_delete(buf);
 759     }
 760     return error;
 761 }
 762
 763 static void
 764 dpif_linux_recv_wait(struct dpif *dpif_)
 765 {
 766     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 767     poll_fd_wait(dpif->fd, POLLIN);
 768 }
 769
 770 static void
 771 dpif_linux_recv_purge(struct dpif *dpif_)
 772 {
 773     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 774     int i;
 775
 776     /* This is somewhat bogus because it assumes that the following macros have
 777      * fixed values, but it's going to go away later.  */
 778 #define DP_N_QUEUES 3
 779 #define DP_MAX_QUEUE_LEN 100
 780     for (i = 0; i < DP_N_QUEUES * DP_MAX_QUEUE_LEN; i++) {
 781         /* Reading even 1 byte discards a whole datagram and saves time. */
 782         char buffer;
 783
 784         if (read(dpif->fd, &buffer, 1) != 1) {
 785             break;
 786         }
 787     }
 788 }
 789
 790 const struct dpif_class dpif_linux_class = {
 791     "system",
 792     NULL,
 793     NULL,
 794     dpif_linux_enumerate,
 795     dpif_linux_open,
 796     dpif_linux_close,
 797     dpif_linux_get_all_names,
 798     dpif_linux_destroy,
 799     dpif_linux_get_stats,
 800     dpif_linux_get_drop_frags,
 801     dpif_linux_set_drop_frags,
 802     dpif_linux_port_add,
 803     dpif_linux_port_del,
 804     dpif_linux_port_query_by_number,
 805     dpif_linux_port_query_by_name,
 806     dpif_linux_get_max_ports,
 807     dpif_linux_port_dump_start,
 808     dpif_linux_port_dump_next,
 809     dpif_linux_port_dump_done,
 810     dpif_linux_port_poll,
 811     dpif_linux_port_poll_wait,
 812     dpif_linux_flow_get,
 813     dpif_linux_flow_put,
 814     dpif_linux_flow_del,
 815     dpif_linux_flow_flush,
 816     dpif_linux_flow_dump_start,
 817     dpif_linux_flow_dump_next,
 818     dpif_linux_flow_dump_done,
 819     dpif_linux_execute,
 820     dpif_linux_recv_get_mask,
 821     dpif_linux_recv_set_mask,
 822     dpif_linux_get_sflow_probability,
 823     dpif_linux_set_sflow_probability,
 824     dpif_linux_queue_to_priority,
 825     dpif_linux_recv,
 826     dpif_linux_recv_wait,
 827     dpif_linux_recv_purge,
 828 };
 829 \f
 830 static int get_openvswitch_major(void);
 831 static int get_major(const char *target);
 832
 833 static int
 834 do_ioctl(const struct dpif *dpif_, int cmd, const void *arg)
 835 {
 836     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
 837     return ioctl(dpif->fd, cmd, arg) ? errno : 0;
 838 }
 839
 840 bool
 841 dpif_linux_is_internal_device(const char *name)
 842 {
 843     struct dpif_linux_vport reply;
 844     struct ofpbuf *buf;
 845     int error;
 846
 847     error = dpif_linux_vport_get(name, &reply, &buf);
 848     if (!error) {
 849         ofpbuf_delete(buf);
 850     } else if (error != ENODEV) {
 851         VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
 852                      name, strerror(error));
 853     }
 854
 855     return reply.type == ODP_VPORT_TYPE_INTERNAL;
 856 }
 857
 858 static int
 859 make_openvswitch_device(int minor, char **fnp)
 860 {
 861     const char dirname[] = "/dev/net";
 862     int major;
 863     dev_t dev;
 864     struct stat s;
 865     char fn[128];
 866
 867     *fnp = NULL;
 868
 869     major = get_openvswitch_major();
 870     if (major < 0) {
 871         return -major;
 872     }
 873     dev = makedev(major, minor);
 874
 875     sprintf(fn, "%s/dp%d", dirname, minor);
 876     if (!stat(fn, &s)) {
 877         if (!S_ISCHR(s.st_mode)) {
 878             VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
 879                          fn);
 880         } else if (s.st_rdev != dev) {
 881             VLOG_WARN_RL(&error_rl,
 882                          "%s is device %u:%u but should be %u:%u, fixing",
 883                          fn, major(s.st_rdev), minor(s.st_rdev),
 884                          major(dev), minor(dev));
 885         } else {
 886             goto success;
 887         }
 888         if (unlink(fn)) {
 889             VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
 890                          fn, strerror(errno));
 891             return errno;
 892         }
 893     } else if (errno == ENOENT) {
 894         if (stat(dirname, &s)) {
 895             if (errno == ENOENT) {
 896                 if (mkdir(dirname, 0755)) {
 897                     VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
 898                                  dirname, strerror(errno));
 899                     return errno;
 900                 }
 901             } else {
 902                 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
 903                              dirname, strerror(errno));
 904                 return errno;
 905             }
 906         }
 907     } else {
 908         VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
 909         return errno;
 910     }
 911
 912     /* The device needs to be created. */
 913     if (mknod(fn, S_IFCHR | 0700, dev)) {
 914         VLOG_WARN_RL(&error_rl,
 915                      "%s: creating character device %u:%u failed (%s)",
 916                      fn, major(dev), minor(dev), strerror(errno));
 917         return errno;
 918     }
 919
 920 success:
 921     *fnp = xstrdup(fn);
 922     return 0;
 923 }
 924
 925 /* Return the major device number of the Open vSwitch device.  If it
 926  * cannot be determined, a negative errno is returned. */
 927 static int
 928 get_openvswitch_major(void)
 929 {
 930     static int openvswitch_major = -1;
 931     if (openvswitch_major < 0) {
 932         openvswitch_major = get_major("openvswitch");
 933     }
 934     return openvswitch_major;
 935 }
 936
 937 static int
 938 get_major(const char *target)
 939 {
 940     const char fn[] = "/proc/devices";
 941     char line[128];
 942     FILE *file;
 943     int ln;
 944
 945     file = fopen(fn, "r");
 946     if (!file) {
 947         VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
 948         return -errno;
 949     }
 950
 951     for (ln = 1; fgets(line, sizeof line, file); ln++) {
 952         char name[64];
 953         int major;
 954
 955         if (!strncmp(line, "Character", 9) || line[0] == '\0') {
 956             /* Nothing to do. */
 957         } else if (!strncmp(line, "Block", 5)) {
 958             /* We only want character devices, so skip the rest of the file. */
 959             break;
 960         } else if (sscanf(line, "%d %63s", &major, name)) {
 961             if (!strcmp(name, target)) {
 962                 fclose(file);
 963                 return major;
 964             }
 965         } else {
 966             VLOG_WARN_ONCE("%s:%d: syntax error", fn, ln);
 967         }
 968     }
 969
 970     fclose(file);
 971
 972     VLOG_ERR("%s: %s major not found (is the module loaded?)", fn, target);
 973     return -ENODEV;
 974 }
 975
 976 static int
 977 create_minor(const char *name, int minor)
 978 {
 979     int error;
 980     int fd;
 981
 982     error = open_minor(minor, &fd);
 983     if (error) {
 984         return error;
 985     }
 986
 987     error = ioctl(fd, ODP_DP_CREATE, name) ? errno : 0;
 988     close(fd);
 989     return error;
 990 }
 991
 992 static int
 993 open_minor(int minor, int *fdp)
 994 {
 995     int error;
 996     char *fn;
 997
 998     error = make_openvswitch_device(minor, &fn);
 999     if (error) {
1000         return error;
1001     }
1002
1003     *fdp = open(fn, O_RDONLY | O_NONBLOCK);
1004     if (*fdp < 0) {
1005         error = errno;
1006         VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
1007         free(fn);
1008         return error;
1009     }
1010     free(fn);
1011     return 0;
1012 }
1013
1014 static void
1015 dpif_linux_port_changed(const struct rtnetlink_link_change *change,
1016                         void *dpif_)
1017 {
1018     struct dpif_linux *dpif = dpif_;
1019
1020     if (change) {
1021         if (change->master_ifindex == dpif->local_ifindex
1022             && (change->nlmsg_type == RTM_NEWLINK
1023                 || change->nlmsg_type == RTM_DELLINK))
1024         {
1025             /* Our datapath changed, either adding a new port or deleting an
1026              * existing one. */
1027             shash_add_once(&dpif->changed_ports, change->ifname, NULL);
1028         }
1029     } else {
1030         dpif->change_error = true;
1031     }
1032 }
1033 \f
1034 /* Parses the contents of 'buf', which contains a "struct odp_vport" followed
1035  * by Netlink attributes, into 'vport'.  Returns 0 if successful, otherwise a
1036  * positive errno value.
1037  *
1038  * 'vport' will contain pointers into 'buf', so the caller should not free
1039  * 'buf' while 'vport' is still in use. */
1040 static int
1041 dpif_linux_vport_from_ofpbuf(struct dpif_linux_vport *vport,
1042                              const struct ofpbuf *buf)
1043 {
1044     static const struct nl_policy odp_vport_policy[] = {
1045         [ODP_VPORT_ATTR_PORT_NO] = { .type = NL_A_U32 },
1046         [ODP_VPORT_ATTR_TYPE] = { .type = NL_A_U32 },
1047         [ODP_VPORT_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1048         [ODP_VPORT_ATTR_STATS] = { .type = NL_A_UNSPEC,
1049                                    .min_len = sizeof(struct rtnl_link_stats64),
1050                                    .max_len = sizeof(struct rtnl_link_stats64),
1051                                    .optional = true },
1052         [ODP_VPORT_ATTR_ADDRESS] = { .type = NL_A_UNSPEC,
1053                                      .min_len = ETH_ADDR_LEN,
1054                                      .max_len = ETH_ADDR_LEN,
1055                                      .optional = true },
1056         [ODP_VPORT_ATTR_MTU] = { .type = NL_A_U32, .optional = true },
1057         [ODP_VPORT_ATTR_OPTIONS] = { .type = NL_A_NESTED, .optional = true },
1058         [ODP_VPORT_ATTR_IFINDEX] = { .type = NL_A_U32, .optional = true },
1059         [ODP_VPORT_ATTR_IFLINK] = { .type = NL_A_U32, .optional = true },
1060     };
1061
1062     struct odp_vport *odp_vport;
1063     struct nlattr *a[ARRAY_SIZE(odp_vport_policy)];
1064
1065     dpif_linux_vport_init(vport);
1066
1067     if (!nl_policy_parse(buf, sizeof *odp_vport, odp_vport_policy,
1068                          a, ARRAY_SIZE(odp_vport_policy))) {
1069         return EINVAL;
1070     }
1071     odp_vport = buf->data;
1072
1073     vport->dp_idx = odp_vport->dp_idx;
1074     vport->port_no = nl_attr_get_u32(a[ODP_VPORT_ATTR_PORT_NO]);
1075     vport->type = nl_attr_get_u32(a[ODP_VPORT_ATTR_TYPE]);
1076     vport->name = nl_attr_get_string(a[ODP_VPORT_ATTR_NAME]);
1077     if (a[ODP_VPORT_ATTR_STATS]) {
1078         vport->stats = nl_attr_get(a[ODP_VPORT_ATTR_STATS]);
1079     }
1080     if (a[ODP_VPORT_ATTR_ADDRESS]) {
1081         vport->address = nl_attr_get(a[ODP_VPORT_ATTR_ADDRESS]);
1082     }
1083     if (a[ODP_VPORT_ATTR_MTU]) {
1084         vport->mtu = nl_attr_get_u32(a[ODP_VPORT_ATTR_MTU]);
1085     }
1086     if (a[ODP_VPORT_ATTR_OPTIONS]) {
1087         vport->options = nl_attr_get(a[ODP_VPORT_ATTR_OPTIONS]);
1088         vport->options_len = nl_attr_get_size(a[ODP_VPORT_ATTR_OPTIONS]);
1089     }
1090     if (a[ODP_VPORT_ATTR_IFINDEX]) {
1091         vport->ifindex = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFINDEX]);
1092     }
1093     if (a[ODP_VPORT_ATTR_IFLINK]) {
1094         vport->iflink = nl_attr_get_u32(a[ODP_VPORT_ATTR_IFLINK]);
1095     }
1096     return 0;
1097 }
1098
1099 /* Appends to 'buf' (which must initially be empty) a "struct odp_vport"
1100  * followed by Netlink attributes corresponding to 'vport'. */
1101 static void
1102 dpif_linux_vport_to_ofpbuf(const struct dpif_linux_vport *vport,
1103                            struct ofpbuf *buf)
1104 {
1105     struct odp_vport *odp_vport;
1106
1107     ofpbuf_reserve(buf, sizeof odp_vport);
1108
1109     if (vport->port_no != UINT32_MAX) {
1110         nl_msg_put_u32(buf, ODP_VPORT_ATTR_PORT_NO, vport->port_no);
1111     }
1112
1113     if (vport->type != ODP_VPORT_TYPE_UNSPEC) {
1114         nl_msg_put_u32(buf, ODP_VPORT_ATTR_TYPE, vport->type);
1115     }
1116
1117     if (vport->name) {
1118         nl_msg_put_string(buf, ODP_VPORT_ATTR_NAME, vport->name);
1119     }
1120
1121     if (vport->stats) {
1122         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_STATS,
1123                           vport->stats, sizeof *vport->stats);
1124     }
1125
1126     if (vport->address) {
1127         nl_msg_put_unspec(buf, ODP_VPORT_ATTR_ADDRESS,
1128                           vport->address, ETH_ADDR_LEN);
1129     }
1130
1131     if (vport->mtu) {
1132         nl_msg_put_u32(buf, ODP_VPORT_ATTR_MTU, vport->mtu);
1133     }
1134
1135     if (vport->options) {
1136         nl_msg_put_nested(buf, ODP_VPORT_ATTR_OPTIONS,
1137                           vport->options, vport->options_len);
1138     }
1139
1140     if (vport->ifindex) {
1141         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFINDEX, vport->ifindex);
1142     }
1143
1144     if (vport->iflink) {
1145         nl_msg_put_u32(buf, ODP_VPORT_ATTR_IFLINK, vport->iflink);
1146     }
1147
1148     odp_vport = ofpbuf_push_uninit(buf, sizeof *odp_vport);
1149     odp_vport->dp_idx = vport->dp_idx;
1150     odp_vport->len = buf->size;
1151     odp_vport->total_len = (char *) ofpbuf_end(buf) - (char *) buf->data;
1152 }
1153
1154 /* Clears 'vport' to "empty" values. */
1155 void
1156 dpif_linux_vport_init(struct dpif_linux_vport *vport)
1157 {
1158     memset(vport, 0, sizeof *vport);
1159     vport->dp_idx = UINT32_MAX;
1160     vport->port_no = UINT32_MAX;
1161 }
1162
1163 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1164  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1165  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1166  * result of the command is expected to be an odp_vport also, which is decoded
1167  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1168  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1169 int
1170 dpif_linux_vport_transact(const struct dpif_linux_vport *request,
1171                           struct dpif_linux_vport *reply,
1172                           struct ofpbuf **bufp)
1173 {
1174     static int dp0_fd = -1;
1175     struct ofpbuf *buf = NULL;
1176     int error;
1177
1178     assert((reply != NULL) == (bufp != NULL));
1179     if (dp0_fd < 0) {
1180         int fd;
1181
1182         error = open_minor(0, &fd);
1183         if (error) {
1184             goto error;
1185         }
1186         dp0_fd = fd;
1187     }
1188
1189     buf = ofpbuf_new(1024);
1190     dpif_linux_vport_to_ofpbuf(request, buf);
1191
1192     error = ioctl(dp0_fd, request->cmd, buf->data) ? errno : 0;
1193     if (error) {
1194         goto error;
1195     }
1196
1197     if (bufp) {
1198         buf->size = ((struct odp_vport *) buf->data)->len;
1199         error = dpif_linux_vport_from_ofpbuf(reply, buf);
1200         if (error) {
1201             goto error;
1202         }
1203         *bufp = buf;
1204     } else {
1205         ofpbuf_delete(buf);
1206     }
1207     return 0;
1208
1209 error:
1210     ofpbuf_delete(buf);
1211     if (bufp) {
1212         memset(reply, 0, sizeof *reply);
1213         *bufp = NULL;
1214     }
1215     return error;
1216 }
1217
1218 /* Obtains information about the kernel vport named 'name' and stores it into
1219  * '*reply' and '*bufp'.  The caller must free '*bufp' when the reply is no
1220  * longer needed ('reply' will contain pointers into '*bufp').  */
1221 int
1222 dpif_linux_vport_get(const char *name, struct dpif_linux_vport *reply,
1223                      struct ofpbuf **bufp)
1224 {
1225     struct dpif_linux_vport request;
1226
1227     dpif_linux_vport_init(&request);
1228     request.cmd = ODP_VPORT_GET;
1229     request.name = name;
1230
1231     return dpif_linux_vport_transact(&request, reply, bufp);
1232 }
1233