vswitchd/ovs-brcompatd.c

   1 /* Copyright (c) 2008, 2009, 2010 Nicira Networks
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <config.h>
  17
  18 #include <asm/param.h>
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <getopt.h>
  22 #include <inttypes.h>
  23 #include <limits.h>
  24 #include <net/if.h>
  25 #include <linux/genetlink.h>
  26 #include <linux/rtnetlink.h>
  27 #include <signal.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32 #include <time.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35
  36 #include "command-line.h"
  37 #include "coverage.h"
  38 #include "daemon.h"
  39 #include "dirs.h"
  40 #include "dynamic-string.h"
  41 #include "fatal-signal.h"
  42 #include "json.h"
  43 #include "leak-checker.h"
  44 #include "netdev.h"
  45 #include "netlink.h"
  46 #include "ofpbuf.h"
  47 #include "openvswitch/brcompat-netlink.h"
  48 #include "ovsdb-idl.h"
  49 #include "packets.h"
  50 #include "poll-loop.h"
  51 #include "process.h"
  52 #include "signals.h"
  53 #include "svec.h"
  54 #include "timeval.h"
  55 #include "unixctl.h"
  56 #include "util.h"
  57 #include "vswitchd/vswitch-idl.h"
  58
  59 #include "vlog.h"
  60 #define THIS_MODULE VLM_brcompatd
  61
  62
  63 /* xxx Just hangs if datapath is rmmod/insmod.  Learn to reconnect? */
  64
  65 /* Actions to modify bridge compatibility configuration. */
  66 enum bmc_action {
  67     BMC_ADD_DP,
  68     BMC_DEL_DP,
  69     BMC_ADD_PORT,
  70     BMC_DEL_PORT
  71 };
  72
  73 static const char *parse_options(int argc, char *argv[]);
  74 static void usage(void) NO_RETURN;
  75
  76 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 60);
  77
  78 /* Maximum number of milliseconds to wait before pruning port entries that
  79  * no longer exist.  If set to zero, ports are never pruned. */
  80 static int prune_timeout = 5000;
  81
  82 /* Shell command to execute (via popen()) to send a control command to the
  83  * running ovs-vswitchd process.  The string must contain one instance of %s,
  84  * which is replaced by the control command. */
  85 static char *appctl_command;
  86
  87 /* Netlink socket to listen for interface changes. */
  88 static struct nl_sock *rtnl_sock;
  89
  90 /* Netlink socket to bridge compatibility kernel module. */
  91 static struct nl_sock *brc_sock;
  92
  93 /* The Generic Netlink family number used for bridge compatibility. */
  94 static int brc_family;
  95
  96 static const struct nl_policy brc_multicast_policy[] = {
  97     [BRC_GENL_A_MC_GROUP] = {.type = NL_A_U32 }
  98 };
  99
 100 static const struct nl_policy rtnlgrp_link_policy[] = {
 101     [IFLA_IFNAME] = { .type = NL_A_STRING, .optional = false },
 102     [IFLA_MASTER] = { .type = NL_A_U32, .optional = true },
 103 };
 104
 105 static int
 106 lookup_brc_multicast_group(int *multicast_group)
 107 {
 108     struct nl_sock *sock;
 109     struct ofpbuf request, *reply;
 110     struct nlattr *attrs[ARRAY_SIZE(brc_multicast_policy)];
 111     int retval;
 112
 113     retval = nl_sock_create(NETLINK_GENERIC, 0, 0, 0, &sock);
 114     if (retval) {
 115         return retval;
 116     }
 117     ofpbuf_init(&request, 0);
 118     nl_msg_put_genlmsghdr(&request, sock, 0, brc_family,
 119             NLM_F_REQUEST, BRC_GENL_C_QUERY_MC, 1);
 120     retval = nl_sock_transact(sock, &request, &reply);
 121     ofpbuf_uninit(&request);
 122     if (retval) {
 123         nl_sock_destroy(sock);
 124         return retval;
 125     }
 126     if (!nl_policy_parse(reply, NLMSG_HDRLEN + GENL_HDRLEN,
 127                          brc_multicast_policy, attrs,
 128                          ARRAY_SIZE(brc_multicast_policy))) {
 129         nl_sock_destroy(sock);
 130         ofpbuf_delete(reply);
 131         return EPROTO;
 132     }
 133     *multicast_group = nl_attr_get_u32(attrs[BRC_GENL_A_MC_GROUP]);
 134     nl_sock_destroy(sock);
 135     ofpbuf_delete(reply);
 136
 137     return 0;
 138 }
 139
 140 /* Opens a socket for brcompat notifications.  Returns 0 if successful,
 141  * otherwise a positive errno value. */
 142 static int
 143 brc_open(struct nl_sock **sock)
 144 {
 145     int multicast_group = 0;
 146     int retval;
 147
 148     retval = nl_lookup_genl_family(BRC_GENL_FAMILY_NAME, &brc_family);
 149     if (retval) {
 150         return retval;
 151     }
 152
 153     retval = lookup_brc_multicast_group(&multicast_group);
 154     if (retval) {
 155         return retval;
 156     }
 157
 158     retval = nl_sock_create(NETLINK_GENERIC, multicast_group, 0, 0, sock);
 159     if (retval) {
 160         return retval;
 161     }
 162
 163     return 0;
 164 }
 165
 166 static const struct nl_policy brc_dp_policy[] = {
 167     [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING },
 168 };
 169
 170 static struct ovsrec_bridge *
 171 find_bridge(const struct ovsrec_open_vswitch *ovs, const char *br_name)
 172 {
 173     size_t i;
 174
 175     for (i = 0; i < ovs->n_bridges; i++) {
 176         if (!strcmp(br_name, ovs->bridges[i]->name)) {
 177             return ovs->bridges[i];
 178         }
 179     }
 180
 181     return NULL;
 182 }
 183
 184 static int
 185 execute_appctl_command(const char *unixctl_command, char **output)
 186 {
 187     char *stdout_log, *stderr_log;
 188     int error, status;
 189     char *argv[5];
 190
 191     argv[0] = "/bin/sh";
 192     argv[1] = "-c";
 193     argv[2] = xasprintf(appctl_command, unixctl_command);
 194     argv[3] = NULL;
 195
 196     /* Run process and log status. */
 197     error = process_run_capture(argv, &stdout_log, &stderr_log, &status);
 198     if (error) {
 199         VLOG_ERR("failed to execute %s command via ovs-appctl: %s",
 200                  unixctl_command, strerror(error));
 201     } else if (status) {
 202         char *msg = process_status_msg(status);
 203         VLOG_ERR("ovs-appctl exited with error (%s)", msg);
 204         free(msg);
 205         error = ECHILD;
 206     }
 207
 208     /* Deal with stdout_log. */
 209     if (output) {
 210         *output = stdout_log;
 211     } else {
 212         free(stdout_log);
 213     }
 214
 215     /* Deal with stderr_log */
 216     if (stderr_log && *stderr_log) {
 217         VLOG_INFO("ovs-appctl wrote to stderr:\n%s", stderr_log);
 218     }
 219     free(stderr_log);
 220
 221     free(argv[2]);
 222
 223     return error;
 224 }
 225
 226 static void
 227 do_get_bridge_parts(const struct ovsrec_bridge *br, struct svec *parts,
 228                     int vlan, bool break_down_bonds)
 229 {
 230     struct svec ports;
 231     size_t i, j;
 232
 233     svec_init(&ports);
 234     for (i = 0; i < br->n_ports; i++) {
 235         const struct ovsrec_port *port = br->ports[i];
 236
 237         svec_add(&ports, port->name);
 238         if (vlan >= 0) {
 239             int port_vlan = port->n_tag ? *port->tag : 0;
 240             if (vlan != port_vlan) {
 241                 continue;
 242             }
 243         }
 244         if (break_down_bonds) {
 245             for (j = 0; j < port->n_interfaces; j++) {
 246                 const struct ovsrec_interface *iface = port->interfaces[j];
 247                 svec_add(parts, iface->name);
 248             }
 249         } else {
 250             svec_add(parts, port->name);
 251         }
 252     }
 253     svec_destroy(&ports);
 254 }
 255
 256 /* Add all the interfaces for 'bridge' to 'ifaces', breaking bonded interfaces
 257  * down into their constituent parts.
 258  *
 259  * If 'vlan' < 0, all interfaces on 'bridge' are reported.  If 'vlan' == 0,
 260  * then only interfaces for trunk ports or ports with implicit VLAN 0 are
 261  * reported.  If 'vlan' > 0, only interfaces with implicit VLAN 'vlan' are
 262  * reported.  */
 263 static void
 264 get_bridge_ifaces(const struct ovsrec_bridge *br, struct svec *ifaces,
 265                   int vlan)
 266 {
 267     do_get_bridge_parts(br, ifaces, vlan, true);
 268 }
 269
 270 /* Add all the ports for 'bridge' to 'ports'.  Bonded ports are reported under
 271  * the bond name, not broken down into their constituent interfaces.
 272  *
 273  * If 'vlan' < 0, all ports on 'bridge' are reported.  If 'vlan' == 0, then
 274  * only trunk ports or ports with implicit VLAN 0 are reported.  If 'vlan' > 0,
 275  * only port with implicit VLAN 'vlan' are reported.  */
 276 static void
 277 get_bridge_ports(const struct ovsrec_bridge *br, struct svec *ports,
 278                  int vlan)
 279 {
 280     do_get_bridge_parts(br, ports, vlan, false);
 281 }
 282
 283 #if 0
 284 /* Go through the configuration file and remove any ports that no longer
 285  * exist associated with a bridge. */
 286 static void
 287 prune_ports(void)
 288 {
 289     int i, j;
 290     struct svec bridges, delete;
 291
 292     if (cfg_lock(NULL, 0)) {
 293         /* Couldn't lock config file. */
 294         return;
 295     }
 296
 297     svec_init(&bridges);
 298     svec_init(&delete);
 299     cfg_get_subsections(&bridges, "bridge");
 300     for (i=0; i<bridges.n; i++) {
 301         const char *br_name = bridges.names[i];
 302         struct svec ifaces;
 303
 304         /* Check that each bridge interface exists. */
 305         svec_init(&ifaces);
 306         get_bridge_ifaces(br_name, &ifaces, -1);
 307         for (j = 0; j < ifaces.n; j++) {
 308             const char *iface_name = ifaces.names[j];
 309
 310             /* The local port and internal ports are created and destroyed by
 311              * ovs-vswitchd itself, so don't bother checking for them at all.
 312              * In practice, they might not exist if ovs-vswitchd hasn't
 313              * finished reloading since the configuration file was updated. */
 314             if (!strcmp(iface_name, br_name)
 315                 || cfg_get_bool(0, "iface.%s.internal", iface_name)) {
 316                 continue;
 317             }
 318
 319             if (!netdev_exists(iface_name)) {
 320                 VLOG_INFO_RL(&rl, "removing dead interface %s from %s",
 321                              iface_name, br_name);
 322                 svec_add(&delete, iface_name);
 323             }
 324         }
 325         svec_destroy(&ifaces);
 326     }
 327     svec_destroy(&bridges);
 328
 329     if (delete.n) {
 330         size_t i;
 331
 332         for (i = 0; i < delete.n; i++) {
 333             cfg_del_match("bridge.*.port=%s", delete.names[i]);
 334             cfg_del_match("bonding.*.slave=%s", delete.names[i]);
 335         }
 336         reload_config();
 337         cfg_unlock();
 338     } else {
 339         cfg_unlock();
 340     }
 341     svec_destroy(&delete);
 342 }
 343 #endif
 344
 345 static struct ovsdb_idl_txn *
 346 txn_from_openvswitch(const struct ovsrec_open_vswitch *ovs)
 347 {
 348     return ovsdb_idl_txn_get(&ovs->header_);
 349 }
 350
 351 static bool
 352 port_is_fake_bridge(const struct ovsrec_port *port)
 353 {
 354     return (port->fake_bridge
 355             && port->tag
 356             && *port->tag >= 1 && *port->tag <= 4095);
 357 }
 358
 359 static void
 360 ovs_insert_bridge(const struct ovsrec_open_vswitch *ovs,
 361                   struct ovsrec_bridge *bridge)
 362 {
 363     struct ovsrec_bridge **bridges;
 364     size_t i;
 365
 366     bridges = xmalloc(sizeof *ovs->bridges * (ovs->n_bridges + 1));
 367     for (i = 0; i < ovs->n_bridges; i++) {
 368         bridges[i] = ovs->bridges[i];
 369     }
 370     bridges[ovs->n_bridges] = bridge;
 371     ovsrec_open_vswitch_set_bridges(ovs, bridges, ovs->n_bridges + 1);
 372     free(bridges);
 373 }
 374
 375 static struct json *
 376 where_uuid_equals(const struct uuid *uuid)
 377 {
 378     return
 379         json_array_create_1(
 380             json_array_create_3(
 381                 json_string_create("_uuid"),
 382                 json_string_create("=="),
 383                 json_array_create_2(
 384                     json_string_create("uuid"),
 385                     json_string_create_nocopy(
 386                         xasprintf(UUID_FMT, UUID_ARGS(uuid))))));
 387 }
 388
 389 /* Commits 'txn'.  If 'wait_for_reload' is true, also waits for Open vSwitch to
 390    reload the configuration before returning.
 391
 392    Returns EAGAIN if the caller should try the operation again, 0 on success,
 393    otherwise a positive errno value. */
 394 static int
 395 commit_txn(struct ovsdb_idl_txn *txn, bool wait_for_reload)
 396 {
 397     struct ovsdb_idl *idl = ovsdb_idl_txn_get_idl (txn);
 398     enum ovsdb_idl_txn_status status;
 399     int64_t next_cfg = 0;
 400
 401     if (wait_for_reload) {
 402         const struct ovsrec_open_vswitch *ovs = ovsrec_open_vswitch_first(idl);
 403         struct json *where = where_uuid_equals(&ovs->header_.uuid);
 404         ovsdb_idl_txn_increment(txn, "Open_vSwitch", "next_cfg", where);
 405         json_destroy(where);
 406     }
 407     status = ovsdb_idl_txn_commit_block(txn);
 408     if (wait_for_reload && status == TXN_SUCCESS) {
 409         next_cfg = ovsdb_idl_txn_get_increment_new_value(txn);
 410     }
 411     ovsdb_idl_txn_destroy(txn);
 412
 413     switch (status) {
 414     case TXN_INCOMPLETE:
 415         NOT_REACHED();
 416
 417     case TXN_ABORTED:
 418         VLOG_ERR_RL(&rl, "OVSDB transaction unexpectedly aborted");
 419         return ECONNABORTED;
 420
 421     case TXN_UNCHANGED:
 422         return 0;
 423
 424     case TXN_SUCCESS:
 425         if (wait_for_reload) {
 426             for (;;) {
 427                 /* We can't use 'ovs' any longer because ovsdb_idl_run() can
 428                  * destroy it. */
 429                 const struct ovsrec_open_vswitch *ovs2;
 430
 431                 ovsdb_idl_run(idl);
 432                 OVSREC_OPEN_VSWITCH_FOR_EACH (ovs2, idl) {
 433                     if (ovs2->cur_cfg >= next_cfg) {
 434                         goto done;
 435                     }
 436                 }
 437                 ovsdb_idl_wait(idl);
 438                 poll_block();
 439             }
 440         done: ;
 441         }
 442         return 0;
 443
 444     case TXN_TRY_AGAIN:
 445         VLOG_ERR_RL(&rl, "OVSDB transaction needs retry");
 446         return EAGAIN;
 447
 448     case TXN_ERROR:
 449         VLOG_ERR_RL(&rl, "OVSDB transaction failed: %s",
 450                     ovsdb_idl_txn_get_error(txn));
 451         return EBUSY;
 452
 453     default:
 454         NOT_REACHED();
 455     }
 456 }
 457
 458 static int
 459 add_bridge(struct ovsdb_idl *idl, const struct ovsrec_open_vswitch *ovs,
 460            const char *br_name)
 461 {
 462     struct ovsrec_bridge *br;
 463     struct ovsrec_port *port;
 464     struct ovsrec_interface *iface;
 465     struct ovsdb_idl_txn *txn;
 466     char *comment;
 467
 468     if (find_bridge(ovs, br_name)) {
 469         VLOG_WARN("addbr %s: bridge %s exists", br_name, br_name);
 470         return EEXIST;
 471     } else if (netdev_exists(br_name)) {
 472         size_t i;
 473
 474         for (i = 0; i < ovs->n_bridges; i++) {
 475             size_t j;
 476             struct ovsrec_bridge *br_cfg = ovs->bridges[i];
 477
 478             for (j = 0; j < br_cfg->n_ports; j++) {
 479                 if (port_is_fake_bridge(br_cfg->ports[j])) {
 480                     VLOG_WARN("addbr %s: %s exists as a fake bridge",
 481                               br_name, br_name);
 482                     return 0;
 483                 }
 484             }
 485         }
 486
 487         VLOG_WARN("addbr %s: cannot create bridge %s because a network "
 488                   "device named %s already exists",
 489                   br_name, br_name, br_name);
 490         return EEXIST;
 491     }
 492
 493     txn = ovsdb_idl_txn_create(idl);
 494
 495     comment = xasprintf("ovs-brcompatd: addbr %s", br_name);
 496     ovsdb_idl_txn_add_comment(txn, comment);
 497     free(comment);
 498
 499     iface = ovsrec_interface_insert(txn_from_openvswitch(ovs));
 500     ovsrec_interface_set_name(iface, br_name);
 501
 502     port = ovsrec_port_insert(txn_from_openvswitch(ovs));
 503     ovsrec_port_set_name(port, br_name);
 504     ovsrec_port_set_interfaces(port, &iface, 1);
 505
 506     br = ovsrec_bridge_insert(txn_from_openvswitch(ovs));
 507     ovsrec_bridge_set_name(br, br_name);
 508     ovsrec_bridge_set_ports(br, &port, 1);
 509
 510     ovs_insert_bridge(ovs, br);
 511
 512     return commit_txn(txn, true);
 513 }
 514
 515 static void
 516 add_port(const struct ovsrec_open_vswitch *ovs,
 517          const struct ovsrec_bridge *br, const char *port_name)
 518 {
 519     struct ovsrec_interface *iface;
 520     struct ovsrec_port *port;
 521     struct ovsrec_port **ports;
 522     size_t i;
 523
 524     /* xxx Check conflicts? */
 525     iface = ovsrec_interface_insert(txn_from_openvswitch(ovs));
 526     ovsrec_interface_set_name(iface, port_name);
 527
 528     port = ovsrec_port_insert(txn_from_openvswitch(ovs));
 529     ovsrec_port_set_name(port, port_name);
 530     ovsrec_port_set_interfaces(port, &iface, 1);
 531
 532     ports = xmalloc(sizeof *br->ports * (br->n_ports + 1));
 533     for (i = 0; i < br->n_ports; i++) {
 534         ports[i] = br->ports[i];
 535     }
 536     ports[br->n_ports] = port;
 537     ovsrec_bridge_set_ports(br, ports, br->n_ports + 1);
 538     free(ports);
 539 }
 540
 541 static void
 542 del_port(const struct ovsrec_bridge *br, const char *port_name)
 543 {
 544     size_t i, j;
 545     struct ovsrec_port *port_rec = NULL;
 546
 547     for (i = 0; i < br->n_ports; i++) {
 548         struct ovsrec_port *port = br->ports[i];
 549         if (!strcmp(port_name, port->name)) {
 550             port_rec = port;
 551         }
 552         for (j = 0; j < port->n_interfaces; j++) {
 553             struct ovsrec_interface *iface = port->interfaces[j];
 554             if (!strcmp(port_name, iface->name)) {
 555                 ovsrec_interface_delete(iface);
 556             }
 557         }
 558     }
 559
 560     /* xxx Probably can move this into the "for" loop. */
 561     if (port_rec) {
 562         struct ovsrec_port **ports;
 563         size_t n;
 564
 565         ports = xmalloc(sizeof *br->ports * br->n_ports);
 566         for (i = n = 0; i < br->n_ports; i++) {
 567             if (br->ports[i] != port_rec) {
 568                 ports[n++] = br->ports[i];
 569             }
 570         }
 571         ovsrec_bridge_set_ports(br, ports, n);
 572         free(ports);
 573
 574         ovsrec_port_delete(port_rec);
 575     }
 576 }
 577
 578 static int
 579 del_bridge(struct ovsdb_idl *idl,
 580            const struct ovsrec_open_vswitch *ovs, const char *br_name)
 581 {
 582     struct ovsrec_bridge *br = find_bridge(ovs, br_name);
 583     struct ovsrec_bridge **bridges;
 584     struct ovsdb_idl_txn *txn;
 585     char *comment;
 586     size_t i, n;
 587
 588     if (!br) {
 589         VLOG_WARN("delbr %s: no bridge named %s", br_name, br_name);
 590         return ENXIO;
 591     }
 592
 593     txn = ovsdb_idl_txn_create(idl);
 594
 595     comment = xasprintf("ovs-brcompatd: delbr %s", br_name);
 596     ovsdb_idl_txn_add_comment(txn, comment);
 597     free(comment);
 598
 599     del_port(br, br_name);
 600
 601     bridges = xmalloc(sizeof *ovs->bridges * ovs->n_bridges);
 602     for (i = n = 0; i < ovs->n_bridges; i++) {
 603         if (ovs->bridges[i] != br) {
 604             bridges[n++] = ovs->bridges[i];
 605         }
 606     }
 607     ovsrec_open_vswitch_set_bridges(ovs, bridges, n);
 608     free(bridges);
 609
 610     /* Delete the bridge itself. */
 611     ovsrec_bridge_delete(br);
 612
 613     return commit_txn(txn, true);
 614 }
 615
 616 static int
 617 parse_command(struct ofpbuf *buffer, uint32_t *seq, const char **br_name,
 618               const char **port_name, uint64_t *count, uint64_t *skip)
 619 {
 620     static const struct nl_policy policy[] = {
 621         [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING, .optional = true },
 622         [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING, .optional = true },
 623         [BRC_GENL_A_FDB_COUNT] = { .type = NL_A_U64, .optional = true },
 624         [BRC_GENL_A_FDB_SKIP] = { .type = NL_A_U64, .optional = true },
 625     };
 626     struct nlattr *attrs[ARRAY_SIZE(policy)];
 627
 628     if (!nl_policy_parse(buffer, NLMSG_HDRLEN + GENL_HDRLEN, policy,
 629                          attrs, ARRAY_SIZE(policy))
 630         || (br_name && !attrs[BRC_GENL_A_DP_NAME])
 631         || (port_name && !attrs[BRC_GENL_A_PORT_NAME])
 632         || (count && !attrs[BRC_GENL_A_FDB_COUNT])
 633         || (skip && !attrs[BRC_GENL_A_FDB_SKIP])) {
 634         return EINVAL;
 635     }
 636
 637     *seq = ((struct nlmsghdr *) buffer->data)->nlmsg_seq;
 638     if (br_name) {
 639         *br_name = nl_attr_get_string(attrs[BRC_GENL_A_DP_NAME]);
 640     }
 641     if (port_name) {
 642         *port_name = nl_attr_get_string(attrs[BRC_GENL_A_PORT_NAME]);
 643     }
 644     if (count) {
 645         *count = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_COUNT]);
 646     }
 647     if (skip) {
 648         *skip = nl_attr_get_u64(attrs[BRC_GENL_A_FDB_SKIP]);
 649     }
 650     return 0;
 651 }
 652
 653 /* Composes and returns a reply to a request made by the datapath with Netlink
 654  * sequence number 'seq' and error code 'error'.  The caller may add additional
 655  * attributes to the message, then it may send it with send_reply(). */
 656 static struct ofpbuf *
 657 compose_reply(uint32_t seq, int error)
 658 {
 659     struct ofpbuf *reply = ofpbuf_new(4096);
 660     nl_msg_put_genlmsghdr(reply, brc_sock, 32, brc_family, NLM_F_REQUEST,
 661                           BRC_GENL_C_DP_RESULT, 1);
 662     ((struct nlmsghdr *) reply->data)->nlmsg_seq = seq;
 663     nl_msg_put_u32(reply, BRC_GENL_A_ERR_CODE, error);
 664     return reply;
 665 }
 666
 667 /* Sends 'reply' to the datapath and frees it. */
 668 static void
 669 send_reply(struct ofpbuf *reply)
 670 {
 671     int retval = nl_sock_send(brc_sock, reply, false);
 672     if (retval) {
 673         VLOG_WARN_RL(&rl, "replying to brcompat request: %s",
 674                      strerror(retval));
 675     }
 676     ofpbuf_delete(reply);
 677 }
 678
 679 /* Composes and sends a reply to a request made by the datapath with Netlink
 680  * sequence number 'seq' and error code 'error'. */
 681 static void
 682 send_simple_reply(uint32_t seq, int error)
 683 {
 684     send_reply(compose_reply(seq, error));
 685 }
 686
 687 static int
 688 handle_bridge_cmd(struct ovsdb_idl *idl,
 689                   const struct ovsrec_open_vswitch *ovs,
 690                   struct ofpbuf *buffer, bool add)
 691 {
 692     const char *br_name;
 693     uint32_t seq;
 694     int error;
 695
 696     error = parse_command(buffer, &seq, &br_name, NULL, NULL, NULL);
 697     if (!error) {
 698         int retval;
 699
 700         do {
 701             retval = (add ? add_bridge : del_bridge)(idl, ovs, br_name);
 702             VLOG_INFO_RL(&rl, "%sbr %s: %s",
 703                          add ? "add" : "del", br_name, strerror(retval));
 704         } while (retval == EAGAIN);
 705
 706         send_simple_reply(seq, error);
 707     }
 708     return error;
 709 }
 710
 711 static const struct nl_policy brc_port_policy[] = {
 712     [BRC_GENL_A_DP_NAME] = { .type = NL_A_STRING },
 713     [BRC_GENL_A_PORT_NAME] = { .type = NL_A_STRING },
 714 };
 715
 716 static int
 717 handle_port_cmd(struct ovsdb_idl *idl,
 718                 const struct ovsrec_open_vswitch *ovs,
 719                 struct ofpbuf *buffer, bool add)
 720 {
 721     const char *cmd_name = add ? "add-if" : "del-if";
 722     const char *br_name, *port_name;
 723     uint32_t seq;
 724     int error;
 725
 726     error = parse_command(buffer, &seq, &br_name, &port_name, NULL, NULL);
 727     if (!error) {
 728         struct ovsrec_bridge *br = find_bridge(ovs, br_name);
 729
 730         if (!br) {
 731             VLOG_WARN("%s %s %s: no bridge named %s",
 732                       cmd_name, br_name, port_name, br_name);
 733             error = EINVAL;
 734         } else if (!netdev_exists(port_name)) {
 735             VLOG_WARN("%s %s %s: no network device named %s",
 736                       cmd_name, br_name, port_name, port_name);
 737             error = EINVAL;
 738         } else {
 739             do {
 740                 struct ovsdb_idl_txn *txn = ovsdb_idl_txn_create(idl);
 741                 char *comment;
 742
 743                 if (add) {
 744                     comment = xasprintf("ovs-brcompatd: add-if %s", port_name);
 745                     add_port(ovs, br, port_name);
 746                 } else {
 747                     comment = xasprintf("ovs-brcompatd: del-if %s", port_name);
 748                     del_port(br, port_name);
 749                 }
 750
 751                 ovsdb_idl_txn_add_comment(txn, comment);
 752                 free(comment);
 753
 754                 error = commit_txn(txn, true);
 755                 VLOG_INFO_RL(&rl, "%s %s %s: %s",
 756                              cmd_name, br_name, port_name, strerror(error));
 757             } while (error == EAGAIN);
 758         }
 759         send_simple_reply(seq, error);
 760     }
 761
 762     return error;
 763 }
 764
 765 /* The caller is responsible for freeing '*ovs_name' if the call is
 766  * successful. */
 767 static int
 768 linux_bridge_to_ovs_bridge(const struct ovsrec_open_vswitch *ovs,
 769                            const char *linux_name,
 770                            const struct ovsrec_bridge **ovs_bridge,
 771                            int *br_vlan)
 772 {
 773     *ovs_bridge = find_bridge(ovs, linux_name);
 774     if (*ovs_bridge) {
 775         /* Bridge name is the same.  We are interested in VLAN 0. */
 776         *br_vlan = 0;
 777         return 0;
 778     } else {
 779         /* No such Open vSwitch bridge 'linux_name', but there might be an
 780          * internal port named 'linux_name' on some other bridge
 781          * 'ovs_bridge'.  If so then we are interested in the VLAN assigned to
 782          * port 'linux_name' on the bridge named 'ovs_bridge'. */
 783         size_t i, j;
 784
 785         for (i = 0; i < ovs->n_bridges; i++) {
 786             const struct ovsrec_bridge *br = ovs->bridges[i];
 787
 788             for (j = 0; j < br->n_ports; j++) {
 789                 const struct ovsrec_port *port = br->ports[j];
 790
 791                 if (!strcmp(port->name, linux_name)) {
 792                     *ovs_bridge = br;
 793                     *br_vlan = port->n_tag ? *port->tag : -1;
 794                     return 0;
 795                 }
 796             }
 797
 798         }
 799         return ENODEV;
 800     }
 801 }
 802
 803 static int
 804 handle_fdb_query_cmd(const struct ovsrec_open_vswitch *ovs,
 805                      struct ofpbuf *buffer)
 806 {
 807     /* This structure is copied directly from the Linux 2.6.30 header files.
 808      * It would be more straightforward to #include <linux/if_bridge.h>, but
 809      * the 'port_hi' member was only introduced in Linux 2.6.26 and so systems
 810      * with old header files won't have it. */
 811     struct __fdb_entry {
 812         __u8 mac_addr[6];
 813         __u8 port_no;
 814         __u8 is_local;
 815         __u32 ageing_timer_value;
 816         __u8 port_hi;
 817         __u8 pad0;
 818         __u16 unused;
 819     };
 820
 821     struct mac {
 822         uint8_t addr[6];
 823     };
 824     struct mac *local_macs;
 825     int n_local_macs;
 826     int i;
 827
 828     /* Impedance matching between the vswitchd and Linux kernel notions of what
 829      * a bridge is.  The kernel only handles a single VLAN per bridge, but
 830      * vswitchd can deal with all the VLANs on a single bridge.  We have to
 831      * pretend that the former is the case even though the latter is the
 832      * implementation. */
 833     const char *linux_name;   /* Name used by brctl. */
 834     const struct ovsrec_bridge *ovs_bridge;  /* Bridge used by ovs-vswitchd. */
 835     int br_vlan;                /* VLAN tag. */
 836     struct svec ifaces;
 837
 838     struct ofpbuf query_data;
 839     struct ofpbuf *reply;
 840     char *unixctl_command;
 841     uint64_t count, skip;
 842     char *output;
 843     char *save_ptr;
 844     uint32_t seq;
 845     int error;
 846
 847     /* Parse the command received from brcompat_mod. */
 848     error = parse_command(buffer, &seq, &linux_name, NULL, &count, &skip);
 849     if (error) {
 850         return error;
 851     }
 852
 853     /* Figure out vswitchd bridge and VLAN. */
 854     error = linux_bridge_to_ovs_bridge(ovs, linux_name,
 855                                        &ovs_bridge, &br_vlan);
 856     if (error) {
 857         send_simple_reply(seq, error);
 858         return error;
 859     }
 860
 861     /* Fetch the forwarding database using ovs-appctl. */
 862     unixctl_command = xasprintf("fdb/show %s", ovs_bridge->name);
 863     error = execute_appctl_command(unixctl_command, &output);
 864     free(unixctl_command);
 865     if (error) {
 866         send_simple_reply(seq, error);
 867         return error;
 868     }
 869
 870     /* Fetch the MAC address for each interface on the bridge, so that we can
 871      * fill in the is_local field in the response. */
 872     svec_init(&ifaces);
 873     get_bridge_ifaces(ovs_bridge, &ifaces, br_vlan);
 874     local_macs = xmalloc(ifaces.n * sizeof *local_macs);
 875     n_local_macs = 0;
 876     for (i = 0; i < ifaces.n; i++) {
 877         const char *iface_name = ifaces.names[i];
 878         struct mac *mac = &local_macs[n_local_macs];
 879         struct netdev *netdev;
 880
 881         error = netdev_open_default(iface_name, &netdev);
 882         if (!error) {
 883             if (!netdev_get_etheraddr(netdev, mac->addr)) {
 884                 n_local_macs++;
 885             }
 886             netdev_close(netdev);
 887         }
 888     }
 889     svec_destroy(&ifaces);
 890
 891     /* Parse the response from ovs-appctl and convert it to binary format to
 892      * pass back to the kernel. */
 893     ofpbuf_init(&query_data, sizeof(struct __fdb_entry) * 8);
 894     save_ptr = NULL;
 895     strtok_r(output, "\n", &save_ptr); /* Skip header line. */
 896     while (count > 0) {
 897         struct __fdb_entry *entry;
 898         int port, vlan, age;
 899         uint8_t mac[ETH_ADDR_LEN];
 900         char *line;
 901         bool is_local;
 902
 903         line = strtok_r(NULL, "\n", &save_ptr);
 904         if (!line) {
 905             break;
 906         }
 907
 908         if (sscanf(line, "%d %d "ETH_ADDR_SCAN_FMT" %d",
 909                    &port, &vlan, ETH_ADDR_SCAN_ARGS(mac), &age)
 910             != 2 + ETH_ADDR_SCAN_COUNT + 1) {
 911             struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 912             VLOG_INFO_RL(&rl, "fdb/show output has invalid format: %s", line);
 913             continue;
 914         }
 915
 916         if (vlan != br_vlan) {
 917             continue;
 918         }
 919
 920         if (skip > 0) {
 921             skip--;
 922             continue;
 923         }
 924
 925         /* Is this the MAC address of an interface on the bridge? */
 926         is_local = false;
 927         for (i = 0; i < n_local_macs; i++) {
 928             if (eth_addr_equals(local_macs[i].addr, mac)) {
 929                 is_local = true;
 930                 break;
 931             }
 932         }
 933
 934         entry = ofpbuf_put_uninit(&query_data, sizeof *entry);
 935         memcpy(entry->mac_addr, mac, ETH_ADDR_LEN);
 936         entry->port_no = port & 0xff;
 937         entry->is_local = is_local;
 938         entry->ageing_timer_value = age * HZ;
 939         entry->port_hi = (port & 0xff00) >> 8;
 940         entry->pad0 = 0;
 941         entry->unused = 0;
 942         count--;
 943     }
 944     free(output);
 945
 946     /* Compose and send reply to datapath. */
 947     reply = compose_reply(seq, 0);
 948     nl_msg_put_unspec(reply, BRC_GENL_A_FDB_DATA,
 949                       query_data.data, query_data.size);
 950     send_reply(reply);
 951
 952     /* Free memory. */
 953     ofpbuf_uninit(&query_data);
 954
 955     return 0;
 956 }
 957
 958 static void
 959 send_ifindex_reply(uint32_t seq, struct svec *ifaces)
 960 {
 961     struct ofpbuf *reply;
 962     const char *iface;
 963     size_t n_indices;
 964     int *indices;
 965     size_t i;
 966
 967     /* Make sure that any given interface only occurs once.  This shouldn't
 968      * happen, but who knows what people put into their configuration files. */
 969     svec_sort_unique(ifaces);
 970
 971     /* Convert 'ifaces' into ifindexes. */
 972     n_indices = 0;
 973     indices = xmalloc(ifaces->n * sizeof *indices);
 974     SVEC_FOR_EACH (i, iface, ifaces) {
 975         int ifindex = if_nametoindex(iface);
 976         if (ifindex) {
 977             indices[n_indices++] = ifindex;
 978         }
 979     }
 980
 981     /* Compose and send reply. */
 982     reply = compose_reply(seq, 0);
 983     nl_msg_put_unspec(reply, BRC_GENL_A_IFINDEXES,
 984                       indices, n_indices * sizeof *indices);
 985     send_reply(reply);
 986
 987     /* Free memory. */
 988     free(indices);
 989 }
 990
 991 static int
 992 handle_get_bridges_cmd(const struct ovsrec_open_vswitch *ovs,
 993                        struct ofpbuf *buffer)
 994 {
 995     struct svec bridges;
 996     size_t i, j;
 997
 998     uint32_t seq;
 999
1000     int error;
1001
1002     /* Parse Netlink command.
1003      *
1004      * The command doesn't actually have any arguments, but we need the
1005      * sequence number to send the reply. */
1006     error = parse_command(buffer, &seq, NULL, NULL, NULL, NULL);
1007     if (error) {
1008         return error;
1009     }
1010
1011     /* Get all the real bridges and all the fake ones. */
1012     svec_init(&bridges);
1013     for (i = 0; i < ovs->n_bridges; i++) {
1014         const struct ovsrec_bridge *br = ovs->bridges[i];
1015
1016         svec_add(&bridges, br->name);
1017         for (j = 0; j < br->n_ports; j++) {
1018             const struct ovsrec_port *port = br->ports[j];
1019
1020             if (port->fake_bridge) {
1021                 svec_add(&bridges, port->name);
1022             }
1023         }
1024     }
1025
1026     send_ifindex_reply(seq, &bridges);
1027     svec_destroy(&bridges);
1028
1029     return 0;
1030 }
1031
1032 static int
1033 handle_get_ports_cmd(const struct ovsrec_open_vswitch *ovs,
1034                      struct ofpbuf *buffer)
1035 {
1036     uint32_t seq;
1037
1038     const char *linux_name;
1039     const struct ovsrec_bridge *ovs_bridge;
1040     int br_vlan;
1041
1042     struct svec ports;
1043
1044     int error;
1045
1046     /* Parse Netlink command. */
1047     error = parse_command(buffer, &seq, &linux_name, NULL, NULL, NULL);
1048     if (error) {
1049         return error;
1050     }
1051
1052     error = linux_bridge_to_ovs_bridge(ovs, linux_name,
1053                                        &ovs_bridge, &br_vlan);
1054     if (error) {
1055         send_simple_reply(seq, error);
1056         return error;
1057     }
1058
1059     svec_init(&ports);
1060     get_bridge_ports(ovs_bridge, &ports, br_vlan);
1061     svec_sort(&ports);
1062     svec_del(&ports, linux_name);
1063     send_ifindex_reply(seq, &ports); /* XXX bonds won't show up */
1064     svec_destroy(&ports);
1065
1066     return 0;
1067 }
1068
1069 static void
1070 brc_recv_update(struct ovsdb_idl *idl)
1071 {
1072     int retval;
1073     struct ofpbuf *buffer;
1074     struct genlmsghdr *genlmsghdr;
1075     const struct ovsrec_open_vswitch *ovs;
1076
1077     buffer = NULL;
1078     do {
1079         ofpbuf_delete(buffer);
1080         retval = nl_sock_recv(brc_sock, &buffer, false);
1081     } while (retval == ENOBUFS
1082             || (!retval
1083                 && (nl_msg_nlmsgerr(buffer, NULL)
1084                     || nl_msg_nlmsghdr(buffer)->nlmsg_type == NLMSG_DONE)));
1085     if (retval) {
1086         if (retval != EAGAIN) {
1087             VLOG_WARN_RL(&rl, "brc_recv_update: %s", strerror(retval));
1088         }
1089         return;
1090     }
1091
1092     genlmsghdr = nl_msg_genlmsghdr(buffer);
1093     if (!genlmsghdr) {
1094         VLOG_WARN_RL(&rl, "received packet too short for generic NetLink");
1095         goto error;
1096     }
1097
1098     if (nl_msg_nlmsghdr(buffer)->nlmsg_type != brc_family) {
1099         VLOG_DBG_RL(&rl, "received type (%"PRIu16") != brcompat family (%d)",
1100                 nl_msg_nlmsghdr(buffer)->nlmsg_type, brc_family);
1101         goto error;
1102     }
1103
1104     /* Get the Open vSwitch configuration.  Just drop the request on the floor
1105      * if a valid configuration doesn't exist.  (We could check this earlier,
1106      * but we want to drain pending Netlink messages even when there is no Open
1107      * vSwitch configuration.) */
1108     ovs = ovsrec_open_vswitch_first(idl);
1109     if (!ovs) {
1110         VLOG_WARN_RL(&rl, "could not find valid configuration to update");
1111         goto error;
1112     }
1113
1114     switch (genlmsghdr->cmd) {
1115     case BRC_GENL_C_DP_ADD:
1116         handle_bridge_cmd(idl, ovs, buffer, true);
1117         break;
1118
1119     case BRC_GENL_C_DP_DEL:
1120         handle_bridge_cmd(idl, ovs, buffer, false);
1121         break;
1122
1123     case BRC_GENL_C_PORT_ADD:
1124         handle_port_cmd(idl, ovs, buffer, true);
1125         break;
1126
1127     case BRC_GENL_C_PORT_DEL:
1128         handle_port_cmd(idl, ovs, buffer, false);
1129         break;
1130
1131     case BRC_GENL_C_FDB_QUERY:
1132         handle_fdb_query_cmd(ovs, buffer);
1133         break;
1134
1135     case BRC_GENL_C_GET_BRIDGES:
1136         handle_get_bridges_cmd(ovs, buffer);
1137         break;
1138
1139     case BRC_GENL_C_GET_PORTS:
1140         handle_get_ports_cmd(ovs, buffer);
1141         break;
1142
1143     default:
1144         VLOG_WARN_RL(&rl, "received unknown brc netlink command: %d\n",
1145                      genlmsghdr->cmd);
1146         break;
1147     }
1148
1149 error:
1150     ofpbuf_delete(buffer);
1151     return;
1152 }
1153
1154 /* Check for interface configuration changes announced through RTNL. */
1155 static void
1156 rtnl_recv_update(struct ovsdb_idl *idl,
1157                  const struct ovsrec_open_vswitch *ovs)
1158 {
1159     struct ofpbuf *buf;
1160
1161     int error = nl_sock_recv(rtnl_sock, &buf, false);
1162     if (error == EAGAIN) {
1163         /* Nothing to do. */
1164     } else if (error == ENOBUFS) {
1165         VLOG_WARN_RL(&rl, "network monitor socket overflowed");
1166     } else if (error) {
1167         VLOG_WARN_RL(&rl, "error on network monitor socket: %s",
1168                 strerror(error));
1169     } else {
1170         struct nlattr *attrs[ARRAY_SIZE(rtnlgrp_link_policy)];
1171         struct nlmsghdr *nlh;
1172         struct ifinfomsg *iim;
1173
1174         nlh = ofpbuf_at(buf, 0, NLMSG_HDRLEN);
1175         iim = ofpbuf_at(buf, NLMSG_HDRLEN, sizeof *iim);
1176         if (!iim) {
1177             VLOG_WARN_RL(&rl, "received bad rtnl message (no ifinfomsg)");
1178             ofpbuf_delete(buf);
1179             return;
1180         }
1181
1182         if (!nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
1183                              rtnlgrp_link_policy,
1184                              attrs, ARRAY_SIZE(rtnlgrp_link_policy))) {
1185             VLOG_WARN_RL(&rl,"received bad rtnl message (policy)");
1186             ofpbuf_delete(buf);
1187             return;
1188         }
1189         if (nlh->nlmsg_type == RTM_DELLINK && attrs[IFLA_MASTER]) {
1190             const char *port_name = nl_attr_get_string(attrs[IFLA_IFNAME]);
1191             char br_name[IFNAMSIZ];
1192             uint32_t br_idx = nl_attr_get_u32(attrs[IFLA_MASTER]);
1193
1194             if (!if_indextoname(br_idx, br_name)) {
1195                 ofpbuf_delete(buf);
1196                 return;
1197             }
1198
1199             if (!netdev_exists(port_name)) {
1200                 /* Network device is really gone. */
1201                 struct ovsdb_idl_txn *txn;
1202                 struct ovsrec_bridge *br;
1203                 char *comment;
1204
1205                 VLOG_INFO("network device %s destroyed, "
1206                           "removing from bridge %s", port_name, br_name);
1207
1208                 br = find_bridge(ovs, br_name);
1209                 if (!br) {
1210                     VLOG_WARN("no bridge named %s from which to remove %s",
1211                             br_name, port_name);
1212                     ofpbuf_delete(buf);
1213                     return;
1214                 }
1215
1216                 txn = ovsdb_idl_txn_create(idl);
1217
1218                 comment = xasprintf("ovs-brcompatd: destroy port %s",
1219                         port_name);
1220                 ovsdb_idl_txn_add_comment(txn, comment);
1221                 free(comment);
1222
1223                 del_port(br, port_name);
1224                 commit_txn(txn, false);
1225             } else {
1226                 /* A network device by that name exists even though the kernel
1227                  * told us it had disappeared.  Probably, what happened was
1228                  * this:
1229                  *
1230                  *      1. Device destroyed.
1231                  *      2. Notification sent to us.
1232                  *      3. New device created with same name as old one.
1233                  *      4. ovs-brcompatd notified, removes device from bridge.
1234                  *
1235                  * There's no a priori reason that in this situation that the
1236                  * new device with the same name should remain in the bridge;
1237                  * on the contrary, that would be unexpected.  *But* there is
1238                  * one important situation where, if we do this, bad things
1239                  * happen.  This is the case of XenServer Tools version 5.0.0,
1240                  * which on boot of a Windows VM cause something like this to
1241                  * happen on the Xen host:
1242                  *
1243                  *      i. Create tap1.0 and vif1.0.
1244                  *      ii. Delete tap1.0.
1245                  *      iii. Delete vif1.0.
1246                  *      iv. Re-create vif1.0.
1247                  *
1248                  * (XenServer Tools 5.5.0 does not exhibit this behavior, and
1249                  * neither does a VM without Tools installed at all.@.)
1250                  *
1251                  * Steps iii and iv happen within a few seconds of each other.
1252                  * Step iv causes /etc/xensource/scripts/vif to run, which in
1253                  * turn calls ovs-cfg-mod to add the new device to the bridge.
1254                  * If step iv happens after step 4 (in our first list of
1255                  * steps), then all is well, but if it happens between 3 and 4
1256                  * (which can easily happen if ovs-brcompatd has to wait to
1257                  * lock the configuration file), then we will remove the new
1258                  * incarnation from the bridge instead of the old one!
1259                  *
1260                  * So, to avoid this problem, we do nothing here.  This is
1261                  * strictly incorrect except for this one particular case, and
1262                  * perhaps that will bite us someday.  If that happens, then we
1263                  * will have to somehow track network devices by ifindex, since
1264                  * a new device will have a new ifindex even if it has the same
1265                  * name as an old device.
1266                  */
1267                 VLOG_INFO("kernel reported network device %s removed but "
1268                           "a device by that name exists (XS Tools 5.0.0?)",
1269                           port_name);
1270             }
1271         }
1272         ofpbuf_delete(buf);
1273     }
1274 }
1275
1276 int
1277 main(int argc, char *argv[])
1278 {
1279     struct unixctl_server *unixctl;
1280     const char *remote;
1281     struct ovsdb_idl *idl;
1282     int retval;
1283
1284     proctitle_init(argc, argv);
1285     set_program_name(argv[0]);
1286     time_init();
1287     vlog_init();
1288     vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_WARN);
1289     vlog_set_levels(VLM_reconnect, VLF_ANY_FACILITY, VLL_WARN);
1290
1291     remote = parse_options(argc, argv);
1292     signal(SIGPIPE, SIG_IGN);
1293     process_init();
1294     ovsrec_init();
1295
1296     die_if_already_running();
1297     daemonize_start();
1298
1299     retval = unixctl_server_create(NULL, &unixctl);
1300     if (retval) {
1301         exit(EXIT_FAILURE);
1302     }
1303
1304     if (brc_open(&brc_sock)) {
1305         ovs_fatal(0, "could not open brcompat socket.  Check "
1306                 "\"brcompat\" kernel module.");
1307     }
1308
1309     if (prune_timeout) {
1310         if (nl_sock_create(NETLINK_ROUTE, RTNLGRP_LINK, 0, 0, &rtnl_sock)) {
1311             ovs_fatal(0, "could not create rtnetlink socket");
1312         }
1313     }
1314
1315     daemonize_complete();
1316
1317     idl = ovsdb_idl_create(remote, &ovsrec_idl_class);
1318
1319     for (;;) {
1320         const struct ovsrec_open_vswitch *ovs;
1321
1322         ovsdb_idl_run(idl);
1323
1324         unixctl_server_run(unixctl);
1325         brc_recv_update(idl);
1326
1327         ovs = ovsrec_open_vswitch_first(idl);
1328         if (!ovs && ovsdb_idl_has_ever_connected(idl)) {
1329             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
1330             VLOG_WARN_RL(&rl, "%s: database does not contain any Open vSwitch "
1331                          "configuration", remote);
1332         }
1333         netdev_run();
1334
1335         /* If 'prune_timeout' is non-zero, we actively prune from the
1336          * configuration of port entries that are no longer valid.  We
1337          * use two methods:
1338          *
1339          *   1) The kernel explicitly notifies us of removed ports
1340          *      through the RTNL messages.
1341          *
1342          *   2) We periodically check all ports associated with bridges
1343          *      to see if they no longer exist.
1344          */
1345         if (ovs && prune_timeout) {
1346             rtnl_recv_update(idl, ovs);
1347 #if 0
1348             prune_ports();
1349 #endif
1350
1351             nl_sock_wait(rtnl_sock, POLLIN);
1352             poll_timer_wait(prune_timeout);
1353         }
1354
1355
1356         nl_sock_wait(brc_sock, POLLIN);
1357         ovsdb_idl_wait(idl);
1358         unixctl_server_wait(unixctl);
1359         netdev_wait();
1360         poll_block();
1361     }
1362
1363     ovsdb_idl_destroy(idl);
1364
1365     return 0;
1366 }
1367
1368 static void
1369 validate_appctl_command(void)
1370 {
1371     const char *p;
1372     int n;
1373
1374     n = 0;
1375     for (p = strchr(appctl_command, '%'); p; p = strchr(p + 2, '%')) {
1376         if (p[1] == '%') {
1377             /* Nothing to do. */
1378         } else if (p[1] == 's') {
1379             n++;
1380         } else {
1381             ovs_fatal(0, "only '%%s' and '%%%%' allowed in --appctl-command");
1382         }
1383     }
1384     if (n != 1) {
1385         ovs_fatal(0, "'%%s' must appear exactly once in --appctl-command");
1386     }
1387 }
1388
1389 static const char *
1390 parse_options(int argc, char *argv[])
1391 {
1392     enum {
1393         OPT_PRUNE_TIMEOUT,
1394         OPT_APPCTL_COMMAND,
1395         VLOG_OPTION_ENUMS,
1396         LEAK_CHECKER_OPTION_ENUMS
1397     };
1398     static struct option long_options[] = {
1399         {"help",             no_argument, 0, 'h'},
1400         {"version",          no_argument, 0, 'V'},
1401         {"prune-timeout",    required_argument, 0, OPT_PRUNE_TIMEOUT},
1402         {"appctl-command",   required_argument, 0, OPT_APPCTL_COMMAND},
1403         DAEMON_LONG_OPTIONS,
1404         VLOG_LONG_OPTIONS,
1405         LEAK_CHECKER_LONG_OPTIONS,
1406         {0, 0, 0, 0},
1407     };
1408     char *short_options = long_options_to_short_options(long_options);
1409
1410     appctl_command = xasprintf("%s/ovs-appctl %%s", ovs_bindir);
1411     for (;;) {
1412         int c;
1413
1414         c = getopt_long(argc, argv, short_options, long_options, NULL);
1415         if (c == -1) {
1416             break;
1417         }
1418
1419         switch (c) {
1420         case 'H':
1421         case 'h':
1422             usage();
1423
1424         case 'V':
1425             OVS_PRINT_VERSION(0, 0);
1426             exit(EXIT_SUCCESS);
1427
1428         case OPT_PRUNE_TIMEOUT:
1429             prune_timeout = atoi(optarg) * 1000;
1430             break;
1431
1432         case OPT_APPCTL_COMMAND:
1433             appctl_command = optarg;
1434             break;
1435
1436         VLOG_OPTION_HANDLERS
1437         DAEMON_OPTION_HANDLERS
1438         LEAK_CHECKER_OPTION_HANDLERS
1439
1440         case '?':
1441             exit(EXIT_FAILURE);
1442
1443         default:
1444             abort();
1445         }
1446     }
1447     free(short_options);
1448
1449     validate_appctl_command();
1450
1451     argc -= optind;
1452     argv += optind;
1453
1454     if (argc != 1) {
1455         ovs_fatal(0, "database socket is non-option argument; "
1456                 "use --help for usage");
1457     }
1458
1459     return argv[0];
1460 }
1461
1462 static void
1463 usage(void)
1464 {
1465     printf("%s: bridge compatibility front-end for ovs-vswitchd\n"
1466            "usage: %s [OPTIONS] CONFIG\n"
1467            "CONFIG is the configuration file used by ovs-vswitchd.\n",
1468            program_name, program_name);
1469     printf("\nConfiguration options:\n"
1470            "  --appctl-command=COMMAND  shell command to run ovs-appctl\n"
1471            "  --prune-timeout=SECS    wait at most SECS before pruning ports\n"
1472           );
1473     daemon_usage();
1474     vlog_usage();
1475     printf("\nOther options:\n"
1476            "  -h, --help              display this help message\n"
1477            "  -V, --version           display version information\n");
1478     leak_checker_usage();
1479     printf("\nThe default appctl command is:\n%s\n", appctl_command);
1480     exit(EXIT_SUCCESS);
1481 }