lib/dpif.c

   1 /*
   2  * Copyright (c) 2008, 2009 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 #include "dpif.h"
  19
  20 #include <assert.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <fcntl.h>
  24 #include <inttypes.h>
  25 #include <net/if.h>
  26 #include <linux/rtnetlink.h>
  27 #include <linux/ethtool.h>
  28 #include <linux/sockios.h>
  29 #include <netinet/in.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <sys/ioctl.h>
  33 #include <sys/stat.h>
  34 #include <sys/sysmacros.h>
  35 #include <unistd.h>
  36
  37 #include "coverage.h"
  38 #include "dynamic-string.h"
  39 #include "flow.h"
  40 #include "netlink.h"
  41 #include "odp-util.h"
  42 #include "ofp-print.h"
  43 #include "ofpbuf.h"
  44 #include "packets.h"
  45 #include "poll-loop.h"
  46 #include "util.h"
  47 #include "valgrind.h"
  48
  49 #include "vlog.h"
  50 #define THIS_MODULE VLM_dpif
  51
  52 /* A datapath interface. */
  53 struct dpif {
  54     char *name;
  55     unsigned int minor;
  56     int fd;
  57 };
  58
  59 /* Rate limit for individual messages going to or from the datapath, output at
  60  * DBG level.  This is very high because, if these are enabled, it is because
  61  * we really need to see them. */
  62 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  63
  64 /* Not really much point in logging many dpif errors. */
  65 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
  66
  67 static int get_minor_from_name(const char *name, unsigned int *minor);
  68 static int name_to_minor(const char *name, unsigned int *minor);
  69 static int lookup_minor(const char *name, unsigned int *minor);
  70 static int open_by_minor(unsigned int minor, struct dpif **dpifp);
  71 static int make_openvswitch_device(unsigned int minor, char **fnp);
  72 static void check_rw_odp_flow(struct odp_flow *);
  73
  74 int
  75 dpif_open(const char *name, struct dpif **dpifp)
  76 {
  77     struct dpif *dpif;
  78     unsigned int minor;
  79     int listen_mask;
  80     int error;
  81
  82     *dpifp = NULL;
  83
  84     error = name_to_minor(name, &minor);
  85     if (error) {
  86         return error;
  87     }
  88
  89     error = open_by_minor(minor, &dpif);
  90     if (error) {
  91         return error;
  92     }
  93
  94     /* We can open the device, but that doesn't mean that it's been created.
  95      * If it hasn't been, then any command other than ODP_DP_CREATE will
  96      * return ENODEV.  Try something innocuous. */
  97     listen_mask = 0;            /* Make Valgrind happy. */
  98     if (ioctl(dpif->fd, ODP_GET_LISTEN_MASK, &listen_mask)) {
  99         error = errno;
 100         if (error != ENODEV) {
 101             VLOG_WARN("%s: probe returned unexpected error: %s",
 102                       dpif_name(dpif), strerror(error));
 103         }
 104         dpif_close(dpif);
 105         return error;
 106     }
 107     *dpifp = dpif;
 108     return 0;
 109 }
 110
 111 void
 112 dpif_close(struct dpif *dpif)
 113 {
 114     if (dpif) {
 115         free(dpif->name);
 116         close(dpif->fd);
 117         free(dpif);
 118     }
 119 }
 120
 121 static int
 122 do_ioctl(const struct dpif *dpif, int cmd, const char *cmd_name,
 123          const void *arg)
 124 {
 125     int error = ioctl(dpif->fd, cmd, arg) ? errno : 0;
 126     if (cmd_name) {
 127         if (error) {
 128             VLOG_WARN_RL(&error_rl, "%s: ioctl(%s) failed (%s)",
 129                          dpif_name(dpif), cmd_name, strerror(error));
 130         } else {
 131             VLOG_DBG_RL(&dpmsg_rl, "%s: ioctl(%s): success",
 132                         dpif_name(dpif), cmd_name);
 133         }
 134     }
 135     return error;
 136 }
 137
 138 int
 139 dpif_create(const char *name, struct dpif **dpifp)
 140 {
 141     unsigned int minor;
 142     int error;
 143
 144     *dpifp = NULL;
 145     if (!get_minor_from_name(name, &minor)) {
 146         /* Minor was specified in 'name', go ahead and create it. */
 147         struct dpif *dpif;
 148
 149         error = open_by_minor(minor, &dpif);
 150         if (error) {
 151             return error;
 152         }
 153
 154         error = ioctl(dpif->fd, ODP_DP_CREATE, name) < 0 ? errno : 0;
 155         if (!error) {
 156             *dpifp = dpif;
 157         } else {
 158             dpif_close(dpif);
 159         }
 160         return error;
 161     } else {
 162         for (minor = 0; minor < ODP_MAX; minor++) {
 163             struct dpif *dpif;
 164
 165             error = open_by_minor(minor, &dpif);
 166             if (error) {
 167                 return error;
 168             }
 169
 170             error = ioctl(dpif->fd, ODP_DP_CREATE, name) < 0 ? errno : 0;
 171             if (!error) {
 172                 *dpifp = dpif;
 173                 return 0;
 174             }
 175             dpif_close(dpif);
 176             if (error != EBUSY) {
 177                 return error;
 178             }
 179         }
 180         return ENOBUFS;
 181     }
 182 }
 183
 184 const char *
 185 dpif_name(const struct dpif *dpif)
 186 {
 187     return dpif->name;
 188 }
 189
 190 int
 191 dpif_delete(struct dpif *dpif)
 192 {
 193     COVERAGE_INC(dpif_destroy);
 194     return do_ioctl(dpif, ODP_DP_DESTROY, "ODP_DP_DESTROY", NULL);
 195 }
 196
 197 int
 198 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
 199 {
 200     memset(stats, 0, sizeof *stats);
 201     return do_ioctl(dpif, ODP_DP_STATS, "ODP_DP_STATS", stats);
 202 }
 203
 204 int
 205 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
 206 {
 207     int tmp;
 208     int error = do_ioctl(dpif, ODP_GET_DROP_FRAGS, "ODP_GET_DROP_FRAGS", &tmp);
 209     *drop_frags = error ? tmp & 1 : false;
 210     return error;
 211 }
 212
 213 int
 214 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
 215 {
 216     int tmp = drop_frags;
 217     return do_ioctl(dpif, ODP_SET_DROP_FRAGS, "ODP_SET_DROP_FRAGS", &tmp);
 218 }
 219
 220 int
 221 dpif_get_listen_mask(const struct dpif *dpif, int *listen_mask)
 222 {
 223     int error = do_ioctl(dpif, ODP_GET_LISTEN_MASK, "ODP_GET_LISTEN_MASK",
 224                          listen_mask);
 225     if (error) {
 226         *listen_mask = 0;
 227     }
 228     return error;
 229 }
 230
 231 int
 232 dpif_set_listen_mask(struct dpif *dpif, int listen_mask)
 233 {
 234     return do_ioctl(dpif, ODP_SET_LISTEN_MASK, "ODP_SET_LISTEN_MASK",
 235                     &listen_mask);
 236 }
 237
 238 int
 239 dpif_purge(struct dpif *dpif)
 240 {
 241     struct odp_stats stats;
 242     unsigned int i;
 243     int error;
 244
 245     COVERAGE_INC(dpif_purge);
 246
 247     error = dpif_get_dp_stats(dpif, &stats);
 248     if (error) {
 249         return error;
 250     }
 251
 252     for (i = 0; i < stats.max_miss_queue + stats.max_action_queue; i++) {
 253         struct ofpbuf *buf;
 254         error = dpif_recv(dpif, &buf);
 255         if (error) {
 256             return error == EAGAIN ? 0 : error;
 257         }
 258         ofpbuf_delete(buf);
 259     }
 260     return 0;
 261 }
 262
 263 int
 264 dpif_port_add(struct dpif *dpif, const char *devname, uint16_t port_no,
 265               uint16_t flags)
 266 {
 267     struct odp_port port;
 268
 269     COVERAGE_INC(dpif_port_add);
 270     memset(&port, 0, sizeof port);
 271     strncpy(port.devname, devname, sizeof port.devname);
 272     port.port = port_no;
 273     port.flags = flags;
 274     if (!ioctl(dpif->fd, ODP_PORT_ADD, &port)) {
 275         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
 276                     dpif_name(dpif), devname, port_no);
 277         return 0;
 278     } else {
 279         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port %"PRIu16": %s",
 280                      dpif_name(dpif), devname, port_no, strerror(errno));
 281         return errno;
 282     }
 283 }
 284
 285 int
 286 dpif_port_del(struct dpif *dpif, uint16_t port_no)
 287 {
 288     int tmp = port_no;
 289     COVERAGE_INC(dpif_port_del);
 290     return do_ioctl(dpif, ODP_PORT_DEL, "ODP_PORT_DEL", &tmp);
 291 }
 292
 293 int
 294 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 295                           struct odp_port *port)
 296 {
 297     memset(port, 0, sizeof *port);
 298     port->port = port_no;
 299     if (!ioctl(dpif->fd, ODP_PORT_QUERY, port)) {
 300         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
 301                     dpif_name(dpif), port_no, port->devname);
 302         return 0;
 303     } else {
 304         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
 305                      dpif_name(dpif), port_no, strerror(errno));
 306         return errno;
 307     }
 308 }
 309
 310 int
 311 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 312                         struct odp_port *port)
 313 {
 314     memset(port, 0, sizeof *port);
 315     strncpy(port->devname, devname, sizeof port->devname);
 316     if (!ioctl(dpif->fd, ODP_PORT_QUERY, port)) {
 317         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
 318                     dpif_name(dpif), devname, port->port);
 319         return 0;
 320     } else {
 321         /* Log level is DBG here because all the current callers are interested
 322          * in whether 'dpif' actually has a port 'devname', so that it's not an
 323          * issue worth logging if it doesn't. */
 324         VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
 325                     dpif_name(dpif), devname, strerror(errno));
 326         return errno;
 327     }
 328 }
 329
 330 int
 331 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
 332                    char *name, size_t name_size)
 333 {
 334     struct odp_port port;
 335     int error;
 336
 337     assert(name_size > 0);
 338
 339     error = dpif_port_query_by_number(dpif, port_no, &port);
 340     if (!error) {
 341         ovs_strlcpy(name, port.devname, name_size);
 342     } else {
 343         *name = '\0';
 344     }
 345     return error;
 346 }
 347
 348 int
 349 dpif_port_list(const struct dpif *dpif,
 350                struct odp_port **ports, size_t *n_ports)
 351 {
 352     struct odp_portvec pv;
 353     struct odp_stats stats;
 354     int error;
 355
 356     do {
 357         error = dpif_get_dp_stats(dpif, &stats);
 358         if (error) {
 359             goto error;
 360         }
 361
 362         *ports = xcalloc(1, stats.n_ports * sizeof **ports);
 363         pv.ports = *ports;
 364         pv.n_ports = stats.n_ports;
 365         error = do_ioctl(dpif, ODP_PORT_LIST, "ODP_PORT_LIST", &pv);
 366         if (error) {
 367             free(*ports);
 368             goto error;
 369         }
 370     } while (pv.n_ports != stats.n_ports);
 371     *n_ports = pv.n_ports;
 372     return 0;
 373
 374 error:
 375     *ports = NULL;
 376     *n_ports = 0;
 377     return error;
 378 }
 379
 380 int
 381 dpif_port_group_set(struct dpif *dpif, uint16_t group,
 382                     const uint16_t ports[], size_t n_ports)
 383 {
 384     struct odp_port_group pg;
 385
 386     COVERAGE_INC(dpif_port_group_set);
 387     assert(n_ports <= UINT16_MAX);
 388     pg.group = group;
 389     pg.ports = (uint16_t *) ports;
 390     pg.n_ports = n_ports;
 391     return do_ioctl(dpif, ODP_PORT_GROUP_SET, "ODP_PORT_GROUP_SET", &pg);
 392 }
 393
 394 /* Careful: '*n_out' can be greater than 'n_ports' on return, if 'n_ports' is
 395  * less than the number of ports in 'group'. */
 396 int
 397 dpif_port_group_get(const struct dpif *dpif, uint16_t group,
 398                     uint16_t ports[], size_t n_ports, size_t *n_out)
 399 {
 400     struct odp_port_group pg;
 401     int error;
 402
 403     assert(n_ports <= UINT16_MAX);
 404     pg.group = group;
 405     pg.ports = ports;
 406     pg.n_ports = n_ports;
 407     error = do_ioctl(dpif, ODP_PORT_GROUP_GET, "ODP_PORT_GROUP_GET", &pg);
 408     *n_out = error ? 0 : pg.n_ports;
 409     return error;
 410 }
 411
 412 int
 413 dpif_flow_flush(struct dpif *dpif)
 414 {
 415     COVERAGE_INC(dpif_flow_flush);
 416     return do_ioctl(dpif, ODP_FLOW_FLUSH, "ODP_FLOW_FLUSH", NULL);
 417 }
 418
 419 static enum vlog_level
 420 flow_message_log_level(int error)
 421 {
 422     return error ? VLL_WARN : VLL_DBG;
 423 }
 424
 425 static bool
 426 should_log_flow_message(int error)
 427 {
 428     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
 429                              error ? &error_rl : &dpmsg_rl);
 430 }
 431
 432 static void
 433 log_flow_message(const struct dpif *dpif, int error,
 434                  const char *operation,
 435                  const flow_t *flow, const struct odp_flow_stats *stats,
 436                  const union odp_action *actions, size_t n_actions)
 437 {
 438     struct ds ds = DS_EMPTY_INITIALIZER;
 439     ds_put_format(&ds, "%s: ", dpif_name(dpif));
 440     if (error) {
 441         ds_put_cstr(&ds, "failed to ");
 442     }
 443     ds_put_format(&ds, "%s ", operation);
 444     if (error) {
 445         ds_put_format(&ds, "(%s) ", strerror(error));
 446     }
 447     flow_format(&ds, flow);
 448     if (stats) {
 449         ds_put_cstr(&ds, ", ");
 450         format_odp_flow_stats(&ds, stats);
 451     }
 452     if (actions || n_actions) {
 453         ds_put_cstr(&ds, ", actions:");
 454         format_odp_actions(&ds, actions, n_actions);
 455     }
 456     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
 457     ds_destroy(&ds);
 458 }
 459
 460 static int
 461 do_flow_ioctl(const struct dpif *dpif, int cmd, struct odp_flow *flow,
 462               const char *operation, bool show_stats)
 463 {
 464     int error = do_ioctl(dpif, cmd, NULL, flow);
 465     if (error && show_stats) {
 466         flow->n_actions = 0;
 467     }
 468     if (should_log_flow_message(error)) {
 469         log_flow_message(dpif, error, operation, &flow->key,
 470                          show_stats && !error ? &flow->stats : NULL,
 471                          flow->actions, flow->n_actions);
 472     }
 473     return error;
 474 }
 475
 476 int
 477 dpif_flow_put(struct dpif *dpif, struct odp_flow_put *put)
 478 {
 479     int error = do_ioctl(dpif, ODP_FLOW_PUT, NULL, put);
 480     COVERAGE_INC(dpif_flow_put);
 481     if (should_log_flow_message(error)) {
 482         struct ds operation = DS_EMPTY_INITIALIZER;
 483         ds_put_cstr(&operation, "put");
 484         if (put->flags & ODPPF_CREATE) {
 485             ds_put_cstr(&operation, "[create]");
 486         }
 487         if (put->flags & ODPPF_MODIFY) {
 488             ds_put_cstr(&operation, "[modify]");
 489         }
 490         if (put->flags & ODPPF_ZERO_STATS) {
 491             ds_put_cstr(&operation, "[zero]");
 492         }
 493 #define ODPPF_ALL (ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS)
 494         if (put->flags & ~ODPPF_ALL) {
 495             ds_put_format(&operation, "[%x]", put->flags & ~ODPPF_ALL);
 496         }
 497         log_flow_message(dpif, error, ds_cstr(&operation), &put->flow.key,
 498                          !error ? &put->flow.stats : NULL,
 499                          put->flow.actions, put->flow.n_actions);
 500         ds_destroy(&operation);
 501     }
 502     return error;
 503 }
 504
 505 int
 506 dpif_flow_del(struct dpif *dpif, struct odp_flow *flow)
 507 {
 508     COVERAGE_INC(dpif_flow_del);
 509     check_rw_odp_flow(flow);
 510     memset(&flow->stats, 0, sizeof flow->stats);
 511     return do_flow_ioctl(dpif, ODP_FLOW_DEL, flow, "delete flow", true);
 512 }
 513
 514 int
 515 dpif_flow_get(const struct dpif *dpif, struct odp_flow *flow)
 516 {
 517     COVERAGE_INC(dpif_flow_query);
 518     check_rw_odp_flow(flow);
 519     memset(&flow->stats, 0, sizeof flow->stats);
 520     return do_flow_ioctl(dpif, ODP_FLOW_GET, flow, "get flow", true);
 521 }
 522
 523 int
 524 dpif_flow_get_multiple(const struct dpif *dpif,
 525                        struct odp_flow flows[], size_t n)
 526 {
 527     struct odp_flowvec fv;
 528     size_t i;
 529
 530     COVERAGE_ADD(dpif_flow_query_multiple, n);
 531     fv.flows = flows;
 532     fv.n_flows = n;
 533     for (i = 0; i < n; i++) {
 534         check_rw_odp_flow(&flows[i]);
 535     }
 536     return do_ioctl(dpif, ODP_FLOW_GET_MULTIPLE, "ODP_FLOW_GET_MULTIPLE",
 537                     &fv);
 538 }
 539
 540 int
 541 dpif_flow_list(const struct dpif *dpif, struct odp_flow flows[], size_t n,
 542                size_t *n_out)
 543 {
 544     struct odp_flowvec fv;
 545     uint32_t i;
 546     int error;
 547
 548     COVERAGE_INC(dpif_flow_query_list);
 549     fv.flows = flows;
 550     fv.n_flows = n;
 551     if (RUNNING_ON_VALGRIND) {
 552         memset(flows, 0, n * sizeof *flows);
 553     } else {
 554         for (i = 0; i < n; i++) {
 555             flows[i].actions = NULL;
 556             flows[i].n_actions = 0;
 557         }
 558     }
 559     error = do_ioctl(dpif, ODP_FLOW_LIST, NULL, &fv);
 560     if (error) {
 561         *n_out = 0;
 562         VLOG_WARN_RL(&error_rl, "%s: flow list failed (%s)",
 563                      dpif_name(dpif), strerror(error));
 564     } else {
 565         COVERAGE_ADD(dpif_flow_query_list_n, fv.n_flows);
 566         *n_out = fv.n_flows;
 567         VLOG_DBG_RL(&dpmsg_rl, "%s: listed %zu flows",
 568                     dpif_name(dpif), *n_out);
 569     }
 570     return error;
 571 }
 572
 573 int
 574 dpif_flow_list_all(const struct dpif *dpif,
 575                    struct odp_flow **flowsp, size_t *np)
 576 {
 577     struct odp_stats stats;
 578     struct odp_flow *flows;
 579     size_t n_flows;
 580     int error;
 581
 582     *flowsp = NULL;
 583     *np = 0;
 584
 585     error = dpif_get_dp_stats(dpif, &stats);
 586     if (error) {
 587         return error;
 588     }
 589
 590     flows = xmalloc(sizeof *flows * stats.n_flows);
 591     error = dpif_flow_list(dpif, flows, stats.n_flows, &n_flows);
 592     if (error) {
 593         free(flows);
 594         return error;
 595     }
 596
 597     if (stats.n_flows != n_flows) {
 598         VLOG_WARN_RL(&error_rl, "%s: datapath stats reported %"PRIu32" "
 599                      "flows but flow listing reported %zu",
 600                      dpif_name(dpif), stats.n_flows, n_flows);
 601     }
 602     *flowsp = flows;
 603     *np = n_flows;
 604     return 0;
 605 }
 606
 607 int
 608 dpif_execute(struct dpif *dpif, uint16_t in_port,
 609              const union odp_action actions[], size_t n_actions,
 610              const struct ofpbuf *buf)
 611 {
 612     int error;
 613
 614     COVERAGE_INC(dpif_execute);
 615     if (n_actions > 0) {
 616         struct odp_execute execute;
 617         memset(&execute, 0, sizeof execute);
 618         execute.in_port = in_port;
 619         execute.actions = (union odp_action *) actions;
 620         execute.n_actions = n_actions;
 621         execute.data = buf->data;
 622         execute.length = buf->size;
 623         error = do_ioctl(dpif, ODP_EXECUTE, NULL, &execute);
 624     } else {
 625         error = 0;
 626     }
 627
 628     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
 629         struct ds ds = DS_EMPTY_INITIALIZER;
 630         char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
 631         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
 632         format_odp_actions(&ds, actions, n_actions);
 633         if (error) {
 634             ds_put_format(&ds, " failed (%s)", strerror(error));
 635         }
 636         ds_put_format(&ds, " on packet %s", packet);
 637         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
 638         ds_destroy(&ds);
 639         free(packet);
 640     }
 641     return error;
 642 }
 643
 644 int
 645 dpif_recv(struct dpif *dpif, struct ofpbuf **bufp)
 646 {
 647     struct ofpbuf *buf;
 648     int retval;
 649     int error;
 650
 651     buf = ofpbuf_new(65536);
 652     retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
 653     if (retval < 0) {
 654         error = errno;
 655         if (error != EAGAIN) {
 656             VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
 657                          dpif_name(dpif), strerror(error));
 658         }
 659     } else if (retval >= sizeof(struct odp_msg)) {
 660         struct odp_msg *msg = buf->data;
 661         if (msg->length <= retval) {
 662             buf->size += retval;
 663             if (VLOG_IS_DBG_ENABLED()) {
 664                 void *payload = msg + 1;
 665                 size_t length = buf->size - sizeof *msg;
 666                 char *s = ofp_packet_to_string(payload, length, length);
 667                 VLOG_DBG_RL(&dpmsg_rl, "%s: received %s message of length "
 668                             "%zu on port %"PRIu16": %s", dpif_name(dpif),
 669                             (msg->type == _ODPL_MISS_NR ? "miss"
 670                              : msg->type == _ODPL_ACTION_NR ? "action"
 671                              : "<unknown>"),
 672                             msg->length - sizeof(struct odp_msg),
 673                             msg->port, s);
 674                 free(s);
 675             }
 676             *bufp = buf;
 677             COVERAGE_INC(dpif_recv);
 678             return 0;
 679         } else {
 680             VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
 681                          "from %zu bytes to %d",
 682                          dpif_name(dpif), msg->length, retval);
 683             error = ERANGE;
 684         }
 685     } else if (!retval) {
 686         VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif));
 687         error = EPROTO;
 688     } else {
 689         VLOG_WARN_RL(&error_rl,
 690                      "%s: discarding too-short message (%d bytes)",
 691                      dpif_name(dpif), retval);
 692         error = ERANGE;
 693     }
 694
 695     *bufp = NULL;
 696     ofpbuf_delete(buf);
 697     return error;
 698 }
 699
 700 void
 701 dpif_recv_wait(struct dpif *dpif)
 702 {
 703     poll_fd_wait(dpif->fd, POLLIN);
 704 }
 705
 706 void
 707 dpif_get_netflow_ids(const struct dpif *dpif,
 708                      uint8_t *engine_type, uint8_t *engine_id)
 709 {
 710     *engine_type = *engine_id = dpif->minor;
 711 }
 712 \f
 713 struct dpifmon {
 714     struct dpif *dpif;
 715     struct nl_sock *sock;
 716     int local_ifindex;
 717 };
 718
 719 int
 720 dpifmon_create(const char *datapath_name, struct dpifmon **monp)
 721 {
 722     struct dpifmon *mon;
 723     char local_name[IFNAMSIZ];
 724     int error;
 725
 726     mon = *monp = xmalloc(sizeof *mon);
 727
 728     error = dpif_open(datapath_name, &mon->dpif);
 729     if (error) {
 730         goto error;
 731     }
 732     error = dpif_port_get_name(mon->dpif, ODPP_LOCAL,
 733                                local_name, sizeof local_name);
 734     if (error) {
 735         goto error_close_dpif;
 736     }
 737
 738     mon->local_ifindex = if_nametoindex(local_name);
 739     if (!mon->local_ifindex) {
 740         error = errno;
 741         VLOG_WARN("could not get ifindex of %s device: %s",
 742                   local_name, strerror(errno));
 743         goto error_close_dpif;
 744     }
 745
 746     error = nl_sock_create(NETLINK_ROUTE, RTNLGRP_LINK, 0, 0, &mon->sock);
 747     if (error) {
 748         VLOG_WARN("could not create rtnetlink socket: %s", strerror(error));
 749         goto error_close_dpif;
 750     }
 751
 752     return 0;
 753
 754 error_close_dpif:
 755     dpif_close(mon->dpif);
 756 error:
 757     free(mon);
 758     *monp = NULL;
 759     return error;
 760 }
 761
 762 void
 763 dpifmon_destroy(struct dpifmon *mon)
 764 {
 765     if (mon) {
 766         dpif_close(mon->dpif);
 767         nl_sock_destroy(mon->sock);
 768     }
 769 }
 770
 771 int
 772 dpifmon_poll(struct dpifmon *mon, char **devnamep)
 773 {
 774     static struct vlog_rate_limit slow_rl = VLOG_RATE_LIMIT_INIT(1, 5);
 775     static const struct nl_policy rtnlgrp_link_policy[] = {
 776         [IFLA_IFNAME] = { .type = NL_A_STRING },
 777         [IFLA_MASTER] = { .type = NL_A_U32, .optional = true },
 778     };
 779     struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
 780     struct ofpbuf *buf;
 781     int error;
 782
 783     *devnamep = NULL;
 784 again:
 785     error = nl_sock_recv(mon->sock, &buf, false);
 786     switch (error) {
 787     case 0:
 788         if (!nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
 789                              rtnlgrp_link_policy,
 790                              attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
 791             VLOG_WARN_RL(&slow_rl, "received bad rtnl message");
 792             error = ENOBUFS;
 793         } else {
 794             const char *devname = nl_attr_get_string(attrs[IFLA_IFNAME]);
 795             bool for_us;
 796
 797             if (attrs[IFLA_MASTER]) {
 798                 uint32_t master_ifindex = nl_attr_get_u32(attrs[IFLA_MASTER]);
 799                 for_us = master_ifindex == mon->local_ifindex;
 800             } else {
 801                 /* It's for us if that device is one of our ports. */
 802                 struct odp_port port;
 803                 for_us = !dpif_port_query_by_name(mon->dpif, devname, &port);
 804             }
 805
 806             if (!for_us) {
 807                 /* Not for us, try again. */
 808                 ofpbuf_delete(buf);
 809                 COVERAGE_INC(dpifmon_poll_false_wakeup);
 810                 goto again;
 811             }
 812             COVERAGE_INC(dpifmon_poll_changed);
 813             *devnamep = xstrdup(devname);
 814         }
 815         ofpbuf_delete(buf);
 816         break;
 817
 818     case EAGAIN:
 819         /* Nothing to do. */
 820         break;
 821
 822     case ENOBUFS:
 823         VLOG_WARN_RL(&slow_rl, "dpifmon socket overflowed");
 824         break;
 825
 826     default:
 827         VLOG_WARN_RL(&slow_rl, "error on dpifmon socket: %s", strerror(error));
 828         break;
 829     }
 830     return error;
 831 }
 832
 833 void
 834 dpifmon_run(struct dpifmon *mon UNUSED)
 835 {
 836     /* Nothing to do in this implementation. */
 837 }
 838
 839 void
 840 dpifmon_wait(struct dpifmon *mon)
 841 {
 842     nl_sock_wait(mon->sock, POLLIN);
 843 }
 844 \f
 845 static int get_openvswitch_major(void);
 846 static int get_major(const char *target, int default_major);
 847
 848 static int
 849 lookup_minor(const char *name, unsigned int *minor)
 850 {
 851     struct ethtool_drvinfo drvinfo;
 852     struct ifreq ifr;
 853     int error;
 854     int sock;
 855
 856     *minor = -1;
 857     sock = socket(AF_INET, SOCK_DGRAM, 0);
 858     if (sock < 0) {
 859         VLOG_WARN("socket(AF_INET) failed: %s", strerror(errno));
 860         error = errno;
 861         goto error;
 862     }
 863
 864     memset(&ifr, 0, sizeof ifr);
 865     strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
 866     ifr.ifr_data = (caddr_t) &drvinfo;
 867
 868     memset(&drvinfo, 0, sizeof drvinfo);
 869     drvinfo.cmd = ETHTOOL_GDRVINFO;
 870     if (ioctl(sock, SIOCETHTOOL, &ifr)) {
 871         VLOG_WARN("ioctl(SIOCETHTOOL) failed: %s", strerror(errno));
 872         error = errno;
 873         goto error_close_sock;
 874     }
 875
 876     if (strcmp(drvinfo.driver, "openvswitch")) {
 877         VLOG_WARN("%s is not an openvswitch device", name);
 878         error = EOPNOTSUPP;
 879         goto error_close_sock;
 880     }
 881
 882     if (!isdigit(drvinfo.bus_info[0])) {
 883         VLOG_WARN("%s ethtool info does not contain an openvswitch minor",
 884                   name);
 885         error = EPROTOTYPE;
 886         goto error_close_sock;
 887     }
 888
 889     *minor = atoi(drvinfo.bus_info);
 890     close(sock);
 891     return 0;
 892
 893 error_close_sock:
 894     close(sock);
 895 error:
 896     return error;
 897 }
 898
 899 static int
 900 make_openvswitch_device(unsigned int minor, char **fnp)
 901 {
 902     dev_t dev = makedev(get_openvswitch_major(), minor);
 903     const char dirname[] = "/dev/net";
 904     struct stat s;
 905     char fn[128];
 906
 907     *fnp = NULL;
 908     sprintf(fn, "%s/dp%d", dirname, minor);
 909     if (!stat(fn, &s)) {
 910         if (!S_ISCHR(s.st_mode)) {
 911             VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
 912                          fn);
 913         } else if (s.st_rdev != dev) {
 914             VLOG_WARN_RL(&error_rl,
 915                          "%s is device %u:%u instead of %u:%u, fixing",
 916                          fn, major(s.st_rdev), minor(s.st_rdev),
 917                          major(dev), minor(dev));
 918         } else {
 919             goto success;
 920         }
 921         if (unlink(fn)) {
 922             VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
 923                          fn, strerror(errno));
 924             return errno;
 925         }
 926     } else if (errno == ENOENT) {
 927         if (stat(dirname, &s)) {
 928             if (errno == ENOENT) {
 929                 if (mkdir(dirname, 0755)) {
 930                     VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
 931                                  dirname, strerror(errno));
 932                     return errno;
 933                 }
 934             } else {
 935                 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
 936                              dirname, strerror(errno));
 937                 return errno;
 938             }
 939         }
 940     } else {
 941         VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
 942         return errno;
 943     }
 944
 945     /* The device needs to be created. */
 946     if (mknod(fn, S_IFCHR | 0700, dev)) {
 947         VLOG_WARN_RL(&error_rl,
 948                      "%s: creating character device %u:%u failed (%s)",
 949                      fn, major(dev), minor(dev), strerror(errno));
 950         return errno;
 951     }
 952
 953 success:
 954     *fnp = xstrdup(fn);
 955     return 0;
 956 }
 957
 958
 959 static int
 960 get_openvswitch_major(void)
 961 {
 962     static unsigned int openvswitch_major;
 963     if (!openvswitch_major) {
 964         enum { DEFAULT_MAJOR = 248 };
 965         openvswitch_major = get_major("openvswitch", DEFAULT_MAJOR);
 966     }
 967     return openvswitch_major;
 968 }
 969
 970 static int
 971 get_major(const char *target, int default_major)
 972 {
 973     const char fn[] = "/proc/devices";
 974     char line[128];
 975     FILE *file;
 976     int ln;
 977
 978     file = fopen(fn, "r");
 979     if (!file) {
 980         VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
 981         goto error;
 982     }
 983
 984     for (ln = 1; fgets(line, sizeof line, file); ln++) {
 985         char name[64];
 986         int major;
 987
 988         if (!strncmp(line, "Character", 9) || line[0] == '\0') {
 989             /* Nothing to do. */
 990         } else if (!strncmp(line, "Block", 5)) {
 991             /* We only want character devices, so skip the rest of the file. */
 992             break;
 993         } else if (sscanf(line, "%d %63s", &major, name)) {
 994             if (!strcmp(name, target)) {
 995                 fclose(file);
 996                 return major;
 997             }
 998         } else {
 999             static bool warned;
1000             if (!warned) {
1001                 VLOG_WARN("%s:%d: syntax error", fn, ln);
1002             }
1003             warned = true;
1004         }
1005     }
1006
1007     VLOG_ERR("%s: %s major not found (is the module loaded?), using "
1008              "default major %d", fn, target, default_major);
1009 error:
1010     VLOG_INFO("using default major %d for %s", default_major, target);
1011     return default_major;
1012 }
1013
1014 static int
1015 name_to_minor(const char *name, unsigned int *minor)
1016 {
1017     if (!get_minor_from_name(name, minor)) {
1018         return 0;
1019     }
1020     return lookup_minor(name, minor);
1021 }
1022
1023 static int
1024 get_minor_from_name(const char *name, unsigned int *minor)
1025 {
1026     if (!strncmp(name, "dp", 2) && isdigit(name[2])) {
1027         *minor = atoi(name + 2);
1028         return 0;
1029     } else {
1030         return EINVAL;
1031     }
1032 }
1033
1034 static int
1035 open_by_minor(unsigned int minor, struct dpif **dpifp)
1036 {
1037     struct dpif *dpif;
1038     int error;
1039     char *fn;
1040     int fd;
1041
1042     *dpifp = NULL;
1043     error = make_openvswitch_device(minor, &fn);
1044     if (error) {
1045         return error;
1046     }
1047
1048     fd = open(fn, O_RDONLY | O_NONBLOCK);
1049     if (fd < 0) {
1050         error = errno;
1051         VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
1052         free(fn);
1053         return error;
1054     }
1055     free(fn);
1056
1057     dpif = xmalloc(sizeof *dpif);
1058     dpif->name = xasprintf("dp%u", dpif->minor);
1059     dpif->minor = minor;
1060     dpif->fd = fd;
1061     *dpifp = dpif;
1062     return 0;
1063 }
1064 \f
1065 /* There is a tendency to construct odp_flow objects on the stack and to
1066  * forget to properly initialize their "actions" and "n_actions" members.
1067  * When this happens, we get memory corruption because the kernel
1068  * writes through the random pointer that is in the "actions" member.
1069  *
1070  * This function attempts to combat the problem by:
1071  *
1072  *      - Forcing a segfault if "actions" points to an invalid region (instead
1073  *        of just getting back EFAULT, which can be easily missed in the log).
1074  *
1075  *      - Storing a distinctive value that is likely to cause an
1076  *        easy-to-identify error later if it is dereferenced, etc.
1077  *
1078  *      - Triggering a warning on uninitialized memory from Valgrind if
1079  *        "actions" or "n_actions" was not initialized.
1080  */
1081 static void
1082 check_rw_odp_flow(struct odp_flow *flow)
1083 {
1084     if (flow->n_actions) {
1085         memset(&flow->actions[0], 0xcc, sizeof flow->actions[0]);
1086     }
1087 }