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