ofproto/in-band.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "in-band.h"
  19 #include <arpa/inet.h>
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <net/if.h>
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include "dhcp.h"
  26 #include "dpif.h"
  27 #include "flow.h"
  28 #include "mac-learning.h"
  29 #include "netdev.h"
  30 #include "odp-util.h"
  31 #include "ofp-print.h"
  32 #include "ofproto.h"
  33 #include "ofpbuf.h"
  34 #include "openflow/openflow.h"
  35 #include "openvswitch/datapath-protocol.h"
  36 #include "packets.h"
  37 #include "poll-loop.h"
  38 #include "rconn.h"
  39 #include "status.h"
  40 #include "timeval.h"
  41 #include "vconn.h"
  42
  43 #define THIS_MODULE VLM_in_band
  44 #include "vlog.h"
  45
  46 /* In-band control allows a single network to be used for OpenFlow
  47  * traffic and other data traffic.  Refer to ovs-vswitchd.conf(5) and
  48  * secchan(8) for a description of configuring in-band control.
  49  *
  50  * This comment is an attempt to describe how in-band control works at a
  51  * wire- and implementation-level.  Correctly implementing in-band
  52  * control has proven difficult due to its many subtleties, and has thus
  53  * gone through many iterations.  Please read through and understand the
  54  * reasoning behind the chosen rules before making modifications.
  55  *
  56  * In Open vSwitch, in-band control is implemented as "hidden" flows (in
  57  * that they are not visible through OpenFlow) and at a higher priority
  58  * than wildcarded flows can be set up by the controller.  This is done
  59  * so that the controller cannot interfere with them and possibly break
  60  * connectivity with its switches.  It is possible to see all flows,
  61  * including in-band ones, with the ovs-appctl "bridge/dump-flows"
  62  * command.
  63  *
  64  * The following rules are always enabled with the "normal" action by a
  65  * switch with in-band control:
  66  *
  67  *    a. DHCP requests sent from the local port.
  68  *    b. ARP replies to the local port's MAC address.
  69  *    c. ARP requests from the local port's MAC address.
  70  *    d. ARP replies to the remote side's MAC address.  Note that the
  71  *       remote side is either the controller or the gateway to reach
  72  *       the controller.
  73  *    e. ARP requests from the remote side's MAC address.  Note that
  74  *       like (d), the MAC is either for the controller or gateway.
  75  *    f. ARP replies containing the controller's IP address as a target.
  76  *    g. ARP requests containing the controller's IP address as a source.
  77  *    h. OpenFlow (6633/tcp) traffic to the controller's IP.
  78  *    i. OpenFlow (6633/tcp) traffic from the controller's IP.
  79  *
  80  * The goal of these rules is to be as narrow as possible to allow a
  81  * switch to join a network and be able to communicate with a
  82  * controller.  As mentioned earlier, these rules have higher priority
  83  * than the controller's rules, so if they are too broad, they may
  84  * prevent the controller from implementing its policy.  As such,
  85  * in-band actively monitors some aspects of flow and packet processing
  86  * so that the rules can be made more precise.
  87  *
  88  * In-band control monitors attempts to add flows into the datapath that
  89  * could interfere with its duties.  The datapath only allows exact
  90  * match entries, so in-band control is able to be very precise about
  91  * the flows it prevents.  Flows that miss in the datapath are sent to
  92  * userspace to be processed, so preventing these flows from being
  93  * cached in the "fast path" does not affect correctness.  The only type
  94  * of flow that is currently prevented is one that would prevent DHCP
  95  * replies from being seen by the local port.  For example, a rule that
  96  * forwarded all DHCP traffic to the controller would not be allowed,
  97  * but one that forwarded to all ports (including the local port) would.
  98  *
  99  * As mentioned earlier, packets that miss in the datapath are sent to
 100  * the userspace for processing.  The userspace has its own flow table,
 101  * the "classifier", so in-band checks whether any special processing
 102  * is needed before the classifier is consulted.  If a packet is a DHCP
 103  * response to a request from the local port, the packet is forwarded to
 104  * the local port, regardless of the flow table.  Note that this requires
 105  * L7 processing of DHCP replies to determine whether the 'chaddr' field
 106  * matches the MAC address of the local port.
 107  *
 108  * It is interesting to note that for an L3-based in-band control
 109  * mechanism, the majority of rules are devoted to ARP traffic.  At first
 110  * glance, some of these rules appear redundant.  However, each serves an
 111  * important role.  First, in order to determine the MAC address of the
 112  * remote side (controller or gateway) for other ARP rules, we must allow
 113  * ARP traffic for our local port with rules (b) and (c).  If we are
 114  * between a switch and its connection to the controller, we have to
 115  * allow the other switch's ARP traffic to through.  This is done with
 116  * rules (d) and (e), since we do not know the addresses of the other
 117  * switches a priori, but do know the controller's or gateway's.  Finally,
 118  * if the controller is running in a local guest VM that is not reached
 119  * through the local port, the switch that is connected to the VM must
 120  * allow ARP traffic based on the controller's IP address, since it will
 121  * not know the MAC address of the local port that is sending the traffic
 122  * or the MAC address of the controller in the guest VM.
 123  *
 124  * With a few notable exceptions below, in-band should work in most
 125  * network setups.  The following are considered "supported' in the
 126  * current implementation:
 127  *
 128  *    - Locally Connected.  The switch and controller are on the same
 129  *      subnet.  This uses rules (a), (b), (c), (h), and (i).
 130  *
 131  *    - Reached through Gateway.  The switch and controller are on
 132  *      different subnets and must go through a gateway.  This uses
 133  *      rules (a), (b), (c), (h), and (i).
 134  *
 135  *    - Between Switch and Controller.  This switch is between another
 136  *      switch and the controller, and we want to allow the other
 137  *      switch's traffic through.  This uses rules (d), (e), (h), and
 138  *      (i).  It uses (b) and (c) indirectly in order to know the MAC
 139  *      address for rules (d) and (e).  Note that DHCP for the other
 140  *      switch will not work unless the controller explicitly lets this
 141  *      switch pass the traffic.
 142  *
 143  *    - Between Switch and Gateway.  This switch is between another
 144  *      switch and the gateway, and we want to allow the other switch's
 145  *      traffic through.  This uses the same rules and logic as the
 146  *      "Between Switch and Controller" configuration described earlier.
 147  *
 148  *    - Controller on Local VM.  The controller is a guest VM on the
 149  *      system running in-band control.  This uses rules (a), (b), (c),
 150  *      (h), and (i).
 151  *
 152  *    - Controller on Local VM with Different Networks.  The controller
 153  *      is a guest VM on the system running in-band control, but the
 154  *      local port is not used to connect to the controller.  For
 155  *      example, an IP address is configured on eth0 of the switch.  The
 156  *      controller's VM is connected through eth1 of the switch, but an
 157  *      IP address has not been configured for that port on the switch.
 158  *      As such, the switch will use eth0 to connect to the controller,
 159  *      and eth1's rules about the local port will not work.  In the
 160  *      example, the switch attached to eth0 would use rules (a), (b),
 161  *      (c), (h), and (i) on eth0.  The switch attached to eth1 would use
 162  *      rules (f), (g), (h), and (i).
 163  *
 164  * The following are explicitly *not* supported by in-band control:
 165  *
 166  *    - Specify Controller by Name.  Currently, the controller must be
 167  *      identified by IP address.  A naive approach would be to permit
 168  *      all DNS traffic.  Unfortunately, this would prevent the
 169  *      controller from defining any policy over DNS.  Since switches
 170  *      that are located behind us need to connect to the controller,
 171  *      in-band cannot simply add a rule that allows DNS traffic from
 172  *      the local port.  The "correct" way to support this is to parse
 173  *      DNS requests to allow all traffic related to a request for the
 174  *      controller's name through.  Due to the potential security
 175  *      problems and amount of processing, we decided to hold off for
 176  *      the time-being.
 177  *
 178  *    - Differing Controllers for Switches.  All switches must know
 179  *      the L3 addresses for all the controllers that other switches
 180  *      may use, since rules need to be set up to allow traffic related
 181  *      to those controllers through.  See rules (f), (g), (h), and (i).
 182  *
 183  *    - Differing Routes for Switches.  In order for the switch to
 184  *      allow other switches to connect to a controller through a
 185  *      gateway, it allows the gateway's traffic through with rules (d)
 186  *      and (e).  If the routes to the controller differ for the two
 187  *      switches, we will not know the MAC address of the alternate
 188  *      gateway.
 189  */
 190
 191 /* Priorities used in classifier for in-band rules.  These values are higher
 192  * than any that may be set with OpenFlow, and "18" kind of looks like "IB".
 193  * The ordering of priorities is not important because all of the rules set up
 194  * by in-band control have the same action.  The only reason to use more than
 195  * one priority is to make the kind of flow easier to see during debugging. */
 196 enum {
 197     IBR_FROM_LOCAL_DHCP = 180000, /* (a) From local port, DHCP. */
 198     IBR_TO_LOCAL_ARP,             /* (b) To local port, ARP. */
 199     IBR_FROM_LOCAL_ARP,           /* (c) From local port, ARP. */
 200     IBR_TO_REMOTE_ARP,            /* (d) To remote MAC, ARP. */
 201     IBR_FROM_REMOTE_ARP,          /* (e) From remote MAC, ARP. */
 202     IBR_TO_CTL_ARP,               /* (f) To controller IP, ARP. */
 203     IBR_FROM_CTL_ARP,             /* (g) From controller IP, ARP. */
 204     IBR_TO_CTL_OFP,               /* (h) To controller, OpenFlow port. */
 205     IBR_FROM_CTL_OFP              /* (i) From controller, OpenFlow port. */
 206 };
 207
 208 struct in_band_rule {
 209     flow_t flow;
 210     uint32_t wildcards;
 211     unsigned int priority;
 212 };
 213
 214 /* Track one remote IP and next hop information. */
 215 struct in_band_remote {
 216     struct rconn *rconn;              /* Connection to remote. */
 217     uint32_t remote_ip;               /* Remote IP, 0 if unknown. */
 218     uint8_t remote_mac[ETH_ADDR_LEN]; /* Next-hop MAC, all-zeros if unknown. */
 219     uint8_t last_remote_mac[ETH_ADDR_LEN]; /* Previous nonzero next-hop MAC. */
 220     struct netdev *remote_netdev; /* Device to send to next-hop MAC. */
 221 };
 222
 223 struct in_band {
 224     struct ofproto *ofproto;
 225     struct status_category *ss_cat;
 226
 227     /* Remote information. */
 228     time_t next_remote_refresh; /* Refresh timer. */
 229     struct in_band_remote *remotes;
 230     size_t n_remotes;
 231
 232     /* Local information. */
 233     time_t next_local_refresh;       /* Refresh timer. */
 234     uint8_t local_mac[ETH_ADDR_LEN]; /* Current MAC. */
 235     struct netdev *local_netdev;     /* Local port's network device. */
 236
 237     /* Local and remote addresses that are installed as flows. */
 238     uint8_t installed_local_mac[ETH_ADDR_LEN];
 239     uint32_t *remote_ips;
 240     uint32_t n_remote_ips;
 241     uint8_t *remote_macs;
 242     size_t n_remote_macs;
 243 };
 244
 245 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 60);
 246
 247 static int
 248 refresh_remote(struct in_band *ib, struct in_band_remote *r)
 249 {
 250     struct in_addr remote_inaddr;
 251     struct in_addr next_hop_inaddr;
 252     char *next_hop_dev;
 253     int retval;
 254
 255     /* Get remote IP address. */
 256     r->remote_ip = rconn_get_remote_ip(r->rconn);
 257
 258     /* Find the next-hop IP address. */
 259     remote_inaddr.s_addr = r->remote_ip;
 260     memset(r->remote_mac, 0, sizeof r->remote_mac);
 261     retval = netdev_get_next_hop(ib->local_netdev, &remote_inaddr,
 262                                  &next_hop_inaddr, &next_hop_dev);
 263     if (retval) {
 264         VLOG_WARN("cannot find route for controller ("IP_FMT"): %s",
 265                   IP_ARGS(&r->remote_ip), strerror(retval));
 266         return 1;
 267     }
 268     if (!next_hop_inaddr.s_addr) {
 269         next_hop_inaddr.s_addr = remote_inaddr.s_addr;
 270     }
 271
 272     /* Get the next-hop IP and network device. */
 273     if (!r->remote_netdev
 274         || strcmp(netdev_get_name(r->remote_netdev), next_hop_dev))
 275     {
 276         netdev_close(r->remote_netdev);
 277
 278         retval = netdev_open_default(next_hop_dev, &r->remote_netdev);
 279         if (retval) {
 280             VLOG_WARN_RL(&rl, "cannot open netdev %s (next hop "
 281                          "to controller "IP_FMT"): %s",
 282                          next_hop_dev, IP_ARGS(&r->remote_ip),
 283                          strerror(retval));
 284             free(next_hop_dev);
 285             return 1;
 286         }
 287     }
 288     free(next_hop_dev);
 289
 290     /* Look up the MAC address of the next-hop IP address. */
 291     retval = netdev_arp_lookup(r->remote_netdev, next_hop_inaddr.s_addr,
 292                                r->remote_mac);
 293     if (retval) {
 294         VLOG_DBG_RL(&rl, "cannot look up remote MAC address ("IP_FMT"): %s",
 295                     IP_ARGS(&next_hop_inaddr.s_addr), strerror(retval));
 296     }
 297
 298     /* If we have an IP address but not a MAC address, then refresh quickly,
 299      * since we probably will get a MAC address soon (via ARP).  Otherwise, we
 300      * can afford to wait a little while. */
 301     return r->remote_ip && eth_addr_is_zero(r->remote_mac) ? 1 : 10;
 302 }
 303
 304 static bool
 305 refresh_remotes(struct in_band *ib)
 306 {
 307     struct in_band_remote *r;
 308     bool any_changes;
 309     int min_refresh;
 310
 311     if (time_now() < ib->next_remote_refresh) {
 312         return false;
 313     }
 314
 315     any_changes = false;
 316     min_refresh = 10;
 317     for (r = ib->remotes; r < &ib->remotes[ib->n_remotes]; r++) {
 318         uint8_t old_remote_mac[ETH_ADDR_LEN];
 319         uint32_t old_remote_ip;
 320         int refresh_interval;
 321
 322         /* Save old remote information. */
 323         old_remote_ip = r->remote_ip;
 324         memcpy(old_remote_mac, r->remote_mac, ETH_ADDR_LEN);
 325
 326         /* Refresh remote information. */
 327         refresh_interval = refresh_remote(ib, r);
 328         min_refresh = MIN(min_refresh, refresh_interval);
 329
 330         /* If anything changed, log the changes. */
 331         if (old_remote_ip != r->remote_ip) {
 332             any_changes = true;
 333             if (r->remote_ip) {
 334                 VLOG_DBG("remote IP address changed from "IP_FMT" to "IP_FMT,
 335                          IP_ARGS(&old_remote_ip), IP_ARGS(&r->remote_ip));
 336             }
 337         }
 338         if (!eth_addr_equals(r->remote_mac, old_remote_mac)) {
 339             any_changes = true;
 340             if (!eth_addr_is_zero(r->remote_mac)
 341                 && !eth_addr_equals(r->last_remote_mac, r->remote_mac)) {
 342                 VLOG_DBG("remote MAC address changed from "ETH_ADDR_FMT
 343                          " to "ETH_ADDR_FMT,
 344                          ETH_ADDR_ARGS(r->last_remote_mac),
 345                          ETH_ADDR_ARGS(r->remote_mac));
 346                 memcpy(r->last_remote_mac, r->remote_mac, ETH_ADDR_LEN);
 347             }
 348         }
 349     }
 350     ib->next_remote_refresh = time_now() + min_refresh;
 351
 352     return any_changes;
 353 }
 354
 355 /* Refreshes the MAC address of the local port into ib->local_mac, if it is due
 356  * for a refresh.  Returns true if anything changed, otherwise false.  */
 357 static bool
 358 refresh_local(struct in_band *ib)
 359 {
 360     uint8_t ea[ETH_ADDR_LEN];
 361     time_t now;
 362
 363     now = time_now();
 364     if (now < ib->next_local_refresh) {
 365         return false;
 366     }
 367     ib->next_local_refresh = now + 1;
 368
 369     if (netdev_get_etheraddr(ib->local_netdev, ea)
 370         || eth_addr_equals(ea, ib->local_mac)) {
 371         return false;
 372     }
 373
 374     memcpy(ib->local_mac, ea, ETH_ADDR_LEN);
 375     return true;
 376 }
 377
 378 static void
 379 in_band_status_cb(struct status_reply *sr, void *in_band_)
 380 {
 381     struct in_band *in_band = in_band_;
 382
 383     if (!eth_addr_is_zero(in_band->local_mac)) {
 384         status_reply_put(sr, "local-mac="ETH_ADDR_FMT,
 385                          ETH_ADDR_ARGS(in_band->local_mac));
 386     }
 387
 388     if (in_band->n_remotes
 389         && !eth_addr_is_zero(in_band->remotes[0].remote_mac)) {
 390         status_reply_put(sr, "remote-mac="ETH_ADDR_FMT,
 391                          ETH_ADDR_ARGS(in_band->remotes[0].remote_mac));
 392     }
 393 }
 394
 395 /* Returns true if 'packet' should be sent to the local port regardless
 396  * of the flow table. */
 397 bool
 398 in_band_msg_in_hook(struct in_band *in_band, const flow_t *flow,
 399                     const struct ofpbuf *packet)
 400 {
 401     if (!in_band) {
 402         return false;
 403     }
 404
 405     /* Regardless of how the flow table is configured, we want to be
 406      * able to see replies to our DHCP requests. */
 407     if (flow->dl_type == htons(ETH_TYPE_IP)
 408             && flow->nw_proto == IP_TYPE_UDP
 409             && flow->tp_src == htons(DHCP_SERVER_PORT)
 410             && flow->tp_dst == htons(DHCP_CLIENT_PORT)
 411             && packet->l7) {
 412         struct dhcp_header *dhcp;
 413
 414         dhcp = ofpbuf_at(packet, (char *)packet->l7 - (char *)packet->data,
 415                          sizeof *dhcp);
 416         if (!dhcp) {
 417             return false;
 418         }
 419
 420         refresh_local(in_band);
 421         if (!eth_addr_is_zero(in_band->local_mac)
 422             && eth_addr_equals(dhcp->chaddr, in_band->local_mac)) {
 423             return true;
 424         }
 425     }
 426
 427     return false;
 428 }
 429
 430 /* Returns true if the rule that would match 'flow' with 'actions' is
 431  * allowed to be set up in the datapath. */
 432 bool
 433 in_band_rule_check(struct in_band *in_band, const flow_t *flow,
 434                    const struct odp_actions *actions)
 435 {
 436     if (!in_band) {
 437         return true;
 438     }
 439
 440     /* Don't allow flows that would prevent DHCP replies from being seen
 441      * by the local port. */
 442     if (flow->dl_type == htons(ETH_TYPE_IP)
 443             && flow->nw_proto == IP_TYPE_UDP
 444             && flow->tp_src == htons(DHCP_SERVER_PORT)
 445             && flow->tp_dst == htons(DHCP_CLIENT_PORT)) {
 446         int i;
 447
 448         for (i=0; i<actions->n_actions; i++) {
 449             if (actions->actions[i].output.type == ODPAT_OUTPUT
 450                     && actions->actions[i].output.port == ODPP_LOCAL) {
 451                 return true;
 452             }
 453         }
 454         return false;
 455     }
 456
 457     return true;
 458 }
 459
 460 static void
 461 init_rule(struct in_band_rule *rule, unsigned int priority)
 462 {
 463     rule->wildcards = OVSFW_ALL;
 464     rule->priority = priority;
 465
 466     /* Not strictly necessary but seems cleaner. */
 467     memset(&rule->flow, 0, sizeof rule->flow);
 468 }
 469
 470 static void
 471 set_in_port(struct in_band_rule *rule, uint16_t odp_port)
 472 {
 473     rule->wildcards &= ~OFPFW_IN_PORT;
 474     rule->flow.in_port = odp_port;
 475 }
 476
 477 static void
 478 set_dl_type(struct in_band_rule *rule, uint16_t dl_type)
 479 {
 480     rule->wildcards &= ~OFPFW_DL_TYPE;
 481     rule->flow.dl_type = htons(dl_type);
 482 }
 483
 484 static void
 485 set_dl_src(struct in_band_rule *rule, const uint8_t dl_src[ETH_ADDR_LEN])
 486 {
 487     rule->wildcards &= ~OFPFW_DL_SRC;
 488     memcpy(rule->flow.dl_src, dl_src, ETH_ADDR_LEN);
 489 }
 490
 491 static void
 492 set_dl_dst(struct in_band_rule *rule, const uint8_t dl_dst[ETH_ADDR_LEN])
 493 {
 494     rule->wildcards &= ~OFPFW_DL_DST;
 495     memcpy(rule->flow.dl_dst, dl_dst, ETH_ADDR_LEN);
 496 }
 497
 498 static void
 499 set_tp_src(struct in_band_rule *rule, uint16_t tp_src)
 500 {
 501     rule->wildcards &= ~OFPFW_TP_SRC;
 502     rule->flow.tp_src = htons(tp_src);
 503 }
 504
 505 static void
 506 set_tp_dst(struct in_band_rule *rule, uint16_t tp_dst)
 507 {
 508     rule->wildcards &= ~OFPFW_TP_DST;
 509     rule->flow.tp_dst = htons(tp_dst);
 510 }
 511
 512 static void
 513 set_nw_proto(struct in_band_rule *rule, uint8_t nw_proto)
 514 {
 515     rule->wildcards &= ~OFPFW_NW_PROTO;
 516     rule->flow.nw_proto = nw_proto;
 517 }
 518
 519 static void
 520 set_nw_src(struct in_band_rule *rule, uint32_t nw_src)
 521 {
 522     rule->wildcards &= ~OFPFW_NW_SRC_MASK;
 523     rule->flow.nw_src = nw_src;
 524 }
 525
 526 static void
 527 set_nw_dst(struct in_band_rule *rule, uint32_t nw_dst)
 528 {
 529     rule->wildcards &= ~OFPFW_NW_DST_MASK;
 530     rule->flow.nw_dst = nw_dst;
 531 }
 532
 533 static void
 534 make_rules(struct in_band *ib,
 535            void (*cb)(struct in_band *, const struct in_band_rule *))
 536 {
 537     struct in_band_rule rule;
 538     size_t i;
 539
 540     if (!eth_addr_is_zero(ib->installed_local_mac)) {
 541         /* Allow DHCP requests to be sent from the local port. */
 542         init_rule(&rule, IBR_FROM_LOCAL_DHCP);
 543         set_in_port(&rule, ODPP_LOCAL);
 544         set_dl_type(&rule, ETH_TYPE_IP);
 545         set_dl_src(&rule, ib->installed_local_mac);
 546         set_nw_proto(&rule, IP_TYPE_UDP);
 547         set_tp_src(&rule, DHCP_CLIENT_PORT);
 548         set_tp_dst(&rule, DHCP_SERVER_PORT);
 549         cb(ib, &rule);
 550
 551         /* Allow the connection's interface to receive directed ARP traffic. */
 552         init_rule(&rule, IBR_TO_LOCAL_ARP);
 553         set_dl_type(&rule, ETH_TYPE_ARP);
 554         set_dl_dst(&rule, ib->installed_local_mac);
 555         set_nw_proto(&rule, ARP_OP_REPLY);
 556         cb(ib, &rule);
 557
 558         /* Allow the connection's interface to be the source of ARP traffic. */
 559         init_rule(&rule, IBR_FROM_LOCAL_ARP);
 560         set_dl_type(&rule, ETH_TYPE_ARP);
 561         set_dl_src(&rule, ib->installed_local_mac);
 562         set_nw_proto(&rule, ARP_OP_REQUEST);
 563         cb(ib, &rule);
 564     }
 565
 566     for (i = 0; i < ib->n_remote_macs; i++) {
 567         const uint8_t *remote_mac = &ib->remote_macs[i * ETH_ADDR_LEN];
 568
 569         if (i > 0) {
 570             const uint8_t *prev_mac = &ib->remote_macs[(i - 1) * ETH_ADDR_LEN];
 571             if (eth_addr_equals(remote_mac, prev_mac)) {
 572                 /* Skip duplicates. */
 573                 continue;
 574             }
 575         }
 576
 577         /* Allow ARP replies to the remote side's MAC. */
 578         init_rule(&rule, IBR_TO_REMOTE_ARP);
 579         set_dl_type(&rule, ETH_TYPE_ARP);
 580         set_dl_dst(&rule, remote_mac);
 581         set_nw_proto(&rule, ARP_OP_REPLY);
 582         cb(ib, &rule);
 583
 584         /* Allow ARP requests from the remote side's MAC. */
 585         init_rule(&rule, IBR_FROM_REMOTE_ARP);
 586         set_dl_type(&rule, ETH_TYPE_ARP);
 587         set_dl_src(&rule, remote_mac);
 588         set_nw_proto(&rule, ARP_OP_REQUEST);
 589         cb(ib, &rule);
 590     }
 591
 592     for (i = 0; i < ib->n_remote_ips; i++) {
 593         uint32_t remote_ip = ib->remote_ips[i];
 594
 595         if (i > 0 && ib->remote_ips[i - 1] == remote_ip) {
 596             /* Skip duplicates. */
 597             continue;
 598         }
 599
 600         /* Allow ARP replies to the controller's IP. */
 601         init_rule(&rule, IBR_TO_CTL_ARP);
 602         set_dl_type(&rule, ETH_TYPE_ARP);
 603         set_nw_proto(&rule, ARP_OP_REPLY);
 604         set_nw_dst(&rule, remote_ip);
 605         cb(ib, &rule);
 606
 607         /* Allow ARP requests from the controller's IP. */
 608         init_rule(&rule, IBR_FROM_CTL_ARP);
 609         set_dl_type(&rule, ETH_TYPE_ARP);
 610         set_nw_proto(&rule, ARP_OP_REQUEST);
 611         set_nw_src(&rule, remote_ip);
 612         cb(ib, &rule);
 613
 614         /* OpenFlow traffic to the controller. */
 615         init_rule(&rule, IBR_TO_CTL_OFP);
 616         set_dl_type(&rule, ETH_TYPE_IP);
 617         set_nw_proto(&rule, IP_TYPE_TCP);
 618         set_nw_dst(&rule, remote_ip);
 619         set_tp_dst(&rule, OFP_TCP_PORT);
 620         cb(ib, &rule);
 621
 622         /* OpenFlow traffic from the controller. */
 623         init_rule(&rule, IBR_FROM_CTL_OFP);
 624         set_dl_type(&rule, ETH_TYPE_IP);
 625         set_nw_proto(&rule, IP_TYPE_TCP);
 626         set_nw_src(&rule, remote_ip);
 627         set_tp_src(&rule, OFP_TCP_PORT);
 628         cb(ib, &rule);
 629     }
 630 }
 631
 632 static void
 633 clear_rules(struct in_band *ib)
 634 {
 635     memset(ib->installed_local_mac, 0, sizeof ib->installed_local_mac);
 636
 637     free(ib->remote_ips);
 638     ib->remote_ips = NULL;
 639     ib->n_remote_ips = 0;
 640
 641     free(ib->remote_macs);
 642     ib->remote_macs = NULL;
 643     ib->n_remote_macs = 0;
 644 }
 645
 646 static void
 647 drop_rule(struct in_band *ib, const struct in_band_rule *rule)
 648 {
 649     ofproto_delete_flow(ib->ofproto, &rule->flow,
 650                         rule->wildcards, rule->priority);
 651 }
 652
 653 static void
 654 drop_rules(struct in_band *ib)
 655 {
 656     make_rules(ib, drop_rule);
 657     clear_rules(ib);
 658 }
 659
 660 static void
 661 add_rule(struct in_band *ib, const struct in_band_rule *rule)
 662 {
 663     union ofp_action action;
 664
 665     action.type = htons(OFPAT_OUTPUT);
 666     action.output.len = htons(sizeof action);
 667     action.output.port = htons(OFPP_NORMAL);
 668     action.output.max_len = htons(0);
 669     ofproto_add_flow(ib->ofproto, &rule->flow, rule->wildcards,
 670                      rule->priority, &action, 1, 0);
 671 }
 672
 673 static void
 674 add_rules(struct in_band *ib)
 675 {
 676     make_rules(ib, add_rule);
 677 }
 678
 679 static int
 680 compare_ips(const void *a, const void *b)
 681 {
 682     return memcmp(a, b, sizeof(uint32_t));
 683 }
 684
 685 static int
 686 compare_macs(const void *a, const void *b)
 687 {
 688     return memcmp(a, b, ETH_ADDR_LEN);
 689 }
 690
 691 void
 692 in_band_run(struct in_band *ib)
 693 {
 694     struct in_band_remote *r;
 695     bool local_change, remote_change;
 696
 697     local_change = refresh_local(ib);
 698     remote_change = refresh_remotes(ib);
 699     if (!local_change && !remote_change) {
 700         /* Nothing changed, nothing to do. */
 701         return;
 702     }
 703
 704     /* Drop old rules. */
 705     drop_rules(ib);
 706
 707     /* Figure out new rules. */
 708     memcpy(ib->installed_local_mac, ib->local_mac, ETH_ADDR_LEN);
 709     ib->remote_ips = xmalloc(ib->n_remotes * sizeof *ib->remote_ips);
 710     ib->n_remote_ips = 0;
 711     ib->remote_macs = xmalloc(ib->n_remotes * ETH_ADDR_LEN);
 712     ib->n_remote_macs = 0;
 713     for (r = ib->remotes; r < &ib->remotes[ib->n_remotes]; r++) {
 714         if (r->remote_ip) {
 715             ib->remote_ips[ib->n_remote_ips++] = r->remote_ip;
 716         }
 717         if (!eth_addr_is_zero(r->remote_mac)) {
 718             memcpy(&ib->remote_macs[ib->n_remote_macs * ETH_ADDR_LEN],
 719                    r->remote_mac, ETH_ADDR_LEN);
 720             ib->n_remote_macs++;
 721         }
 722     }
 723
 724     /* Sort, to allow make_rules() to easily skip duplicates. */
 725     qsort(ib->remote_ips, ib->n_remote_ips, sizeof *ib->remote_ips,
 726           compare_ips);
 727     qsort(ib->remote_macs, ib->n_remote_macs, ETH_ADDR_LEN, compare_macs);
 728
 729     /* Add new rules. */
 730     add_rules(ib);
 731 }
 732
 733 void
 734 in_band_wait(struct in_band *in_band)
 735 {
 736     time_t now = time_now();
 737     time_t wakeup
 738             = MIN(in_band->next_remote_refresh, in_band->next_local_refresh);
 739     if (wakeup > now) {
 740         poll_timer_wait((wakeup - now) * 1000);
 741     } else {
 742         poll_immediate_wake();
 743     }
 744 }
 745
 746 /* ofproto has flushed all flows from the flow table and it is calling us back
 747  * to allow us to reinstall the ones that are important to us. */
 748 void
 749 in_band_flushed(struct in_band *in_band)
 750 {
 751     add_rules(in_band);
 752 }
 753
 754 int
 755 in_band_create(struct ofproto *ofproto, struct dpif *dpif,
 756                struct switch_status *ss, struct in_band **in_bandp)
 757 {
 758     struct in_band *in_band;
 759     char local_name[IF_NAMESIZE];
 760     struct netdev *local_netdev;
 761     int error;
 762
 763     error = dpif_port_get_name(dpif, ODPP_LOCAL,
 764                                local_name, sizeof local_name);
 765     if (error) {
 766         VLOG_ERR("failed to initialize in-band control: cannot get name "
 767                  "of datapath local port (%s)", strerror(error));
 768         return error;
 769     }
 770
 771     error = netdev_open_default(local_name, &local_netdev);
 772     if (error) {
 773         VLOG_ERR("failed to initialize in-band control: cannot open "
 774                  "datapath local port %s (%s)", local_name, strerror(error));
 775         return error;
 776     }
 777
 778     in_band = xzalloc(sizeof *in_band);
 779     in_band->ofproto = ofproto;
 780     in_band->ss_cat = switch_status_register(ss, "in-band",
 781                                              in_band_status_cb, in_band);
 782     in_band->next_remote_refresh = TIME_MIN;
 783     in_band->next_local_refresh = TIME_MIN;
 784     in_band->local_netdev = local_netdev;
 785
 786     *in_bandp = in_band;
 787
 788     return 0;
 789 }
 790
 791 void
 792 in_band_destroy(struct in_band *ib)
 793 {
 794     if (ib) {
 795         drop_rules(ib);
 796         in_band_set_remotes(ib, NULL, 0);
 797         switch_status_unregister(ib->ss_cat);
 798         netdev_close(ib->local_netdev);
 799         free(ib);
 800     }
 801 }
 802
 803 void
 804 in_band_set_remotes(struct in_band *ib, struct rconn **remotes, size_t n)
 805 {
 806     size_t i;
 807
 808     /* Optimize the case where the rconns are the same as last time. */
 809     if (n == ib->n_remotes) {
 810         for (i = 0; i < n; i++) {
 811             if (ib->remotes[i].rconn != remotes[i]) {
 812                 goto different;
 813             }
 814         }
 815         return;
 816
 817     different:;
 818     }
 819
 820     for (i = 0; i < ib->n_remotes; i++) {
 821         /* We don't own the rconn. */
 822         netdev_close(ib->remotes[i].remote_netdev);
 823     }
 824     free(ib->remotes);
 825
 826     ib->next_remote_refresh = TIME_MIN;
 827     ib->remotes = n ? xzalloc(n * sizeof *ib->remotes) : 0;
 828     ib->n_remotes = n;
 829     for (i = 0; i < n; i++) {
 830         ib->remotes[i].rconn = remotes[i];
 831     }
 832 }