vswitchd/ovs-brcompatd.c

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