ofproto/in-band.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   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 "classifier.h"
  27 #include "dhcp.h"
  28 #include "flow.h"
  29 #include "netdev.h"
  30 #include "netlink.h"
  31 #include "odp-util.h"
  32 #include "ofp-actions.h"
  33 #include "ofproto.h"
  34 #include "ofpbuf.h"
  35 #include "ofproto-provider.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "timeval.h"
  40 #include "vlog.h"
  41
  42 VLOG_DEFINE_THIS_MODULE(in_band);
  43
  44 /* Priorities used in classifier for in-band rules.  These values are higher
  45  * than any that may be set with OpenFlow, and "18" kind of looks like "IB".
  46  * The ordering of priorities is not important because all of the rules set up
  47  * by in-band control have the same action.  The only reason to use more than
  48  * one priority is to make the kind of flow easier to see during debugging. */
  49 enum {
  50     /* One set per bridge. */
  51     IBR_FROM_LOCAL_DHCP = 180000, /* (a) From local port, DHCP. */
  52     IBR_TO_LOCAL_ARP,             /* (b) To local port, ARP. */
  53     IBR_FROM_LOCAL_ARP,           /* (c) From local port, ARP. */
  54
  55     /* One set per unique next-hop MAC. */
  56     IBR_TO_NEXT_HOP_ARP,          /* (d) To remote MAC, ARP. */
  57     IBR_FROM_NEXT_HOP_ARP,        /* (e) From remote MAC, ARP. */
  58
  59     /* One set per unique remote IP address. */
  60     IBR_TO_REMOTE_ARP,            /* (f) To remote IP, ARP. */
  61     IBR_FROM_REMOTE_ARP,          /* (g) From remote IP, ARP. */
  62
  63     /* One set per unique remote (IP,port) pair. */
  64     IBR_TO_REMOTE_TCP,            /* (h) To remote IP, TCP port. */
  65     IBR_FROM_REMOTE_TCP           /* (i) From remote IP, TCP port. */
  66 };
  67
  68 /* Track one remote IP and next hop information. */
  69 struct in_band_remote {
  70     struct sockaddr_in remote_addr; /* IP address, in network byte order. */
  71     uint8_t remote_mac[ETH_ADDR_LEN]; /* Next-hop MAC, all-zeros if unknown. */
  72     uint8_t last_remote_mac[ETH_ADDR_LEN]; /* Previous nonzero next-hop MAC. */
  73     struct netdev *remote_netdev; /* Device to send to next-hop MAC. */
  74 };
  75
  76 /* What to do to an in_band_rule. */
  77 enum in_band_op {
  78     ADD,                       /* Add the rule to ofproto's flow table. */
  79     DELETE                     /* Delete the rule from ofproto's flow table. */
  80 };
  81
  82 /* A rule to add to or delete from ofproto's flow table.  */
  83 struct in_band_rule {
  84     struct hmap_node hmap_node; /* In struct in_band's "rules" hmap. */
  85     struct match match;
  86     unsigned int priority;
  87     enum in_band_op op;
  88 };
  89
  90 struct in_band {
  91     struct ofproto *ofproto;
  92     int queue_id;
  93
  94     /* Remote information. */
  95     time_t next_remote_refresh; /* Refresh timer. */
  96     struct in_band_remote *remotes;
  97     size_t n_remotes;
  98
  99     /* Local information. */
 100     time_t next_local_refresh;       /* Refresh timer. */
 101     uint8_t local_mac[ETH_ADDR_LEN]; /* Current MAC. */
 102     struct netdev *local_netdev;     /* Local port's network device. */
 103
 104     /* Flow tracking. */
 105     struct hmap rules;          /* Contains "struct in_band_rule"s. */
 106 };
 107
 108 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 60);
 109
 110 static int
 111 refresh_remote(struct in_band *ib, struct in_band_remote *r)
 112 {
 113     struct in_addr next_hop_inaddr;
 114     char *next_hop_dev;
 115     int retval;
 116
 117     /* Find the next-hop IP address. */
 118     memset(r->remote_mac, 0, sizeof r->remote_mac);
 119     retval = netdev_get_next_hop(ib->local_netdev, &r->remote_addr.sin_addr,
 120                                  &next_hop_inaddr, &next_hop_dev);
 121     if (retval) {
 122         VLOG_WARN("cannot find route for controller ("IP_FMT"): %s",
 123                   IP_ARGS(r->remote_addr.sin_addr.s_addr), strerror(retval));
 124         return 1;
 125     }
 126     if (!next_hop_inaddr.s_addr) {
 127         next_hop_inaddr = r->remote_addr.sin_addr;
 128     }
 129
 130     /* Open the next-hop network device. */
 131     if (!r->remote_netdev
 132         || strcmp(netdev_get_name(r->remote_netdev), next_hop_dev))
 133     {
 134         netdev_close(r->remote_netdev);
 135
 136         retval = netdev_open(next_hop_dev, "system", &r->remote_netdev);
 137         if (retval) {
 138             VLOG_WARN_RL(&rl, "cannot open netdev %s (next hop "
 139                          "to controller "IP_FMT"): %s",
 140                          next_hop_dev, IP_ARGS(r->remote_addr.sin_addr.s_addr),
 141                          strerror(retval));
 142             free(next_hop_dev);
 143             return 1;
 144         }
 145     }
 146     free(next_hop_dev);
 147
 148     /* Look up the MAC address of the next-hop IP address. */
 149     retval = netdev_arp_lookup(r->remote_netdev, next_hop_inaddr.s_addr,
 150                                r->remote_mac);
 151     if (retval) {
 152         VLOG_DBG_RL(&rl, "cannot look up remote MAC address ("IP_FMT"): %s",
 153                     IP_ARGS(next_hop_inaddr.s_addr), strerror(retval));
 154     }
 155
 156     /* If we don't have a MAC address, then refresh quickly, since we probably
 157      * will get a MAC address soon (via ARP).  Otherwise, we can afford to wait
 158      * a little while. */
 159     return eth_addr_is_zero(r->remote_mac) ? 1 : 10;
 160 }
 161
 162 static bool
 163 refresh_remotes(struct in_band *ib)
 164 {
 165     struct in_band_remote *r;
 166     bool any_changes;
 167
 168     if (time_now() < ib->next_remote_refresh) {
 169         return false;
 170     }
 171
 172     any_changes = false;
 173     ib->next_remote_refresh = TIME_MAX;
 174     for (r = ib->remotes; r < &ib->remotes[ib->n_remotes]; r++) {
 175         uint8_t old_remote_mac[ETH_ADDR_LEN];
 176         time_t next_refresh;
 177
 178         /* Save old MAC. */
 179         memcpy(old_remote_mac, r->remote_mac, ETH_ADDR_LEN);
 180
 181         /* Refresh remote information. */
 182         next_refresh = refresh_remote(ib, r) + time_now();
 183         ib->next_remote_refresh = MIN(ib->next_remote_refresh, next_refresh);
 184
 185         /* If the MAC changed, log the changes. */
 186         if (!eth_addr_equals(r->remote_mac, old_remote_mac)) {
 187             any_changes = true;
 188             if (!eth_addr_is_zero(r->remote_mac)
 189                 && !eth_addr_equals(r->last_remote_mac, r->remote_mac)) {
 190                 VLOG_DBG("remote MAC address changed from "ETH_ADDR_FMT
 191                          " to "ETH_ADDR_FMT,
 192                          ETH_ADDR_ARGS(r->last_remote_mac),
 193                          ETH_ADDR_ARGS(r->remote_mac));
 194                 memcpy(r->last_remote_mac, r->remote_mac, ETH_ADDR_LEN);
 195             }
 196         }
 197     }
 198
 199     return any_changes;
 200 }
 201
 202 /* Refreshes the MAC address of the local port into ib->local_mac, if it is due
 203  * for a refresh.  Returns true if anything changed, otherwise false.  */
 204 static bool
 205 refresh_local(struct in_band *ib)
 206 {
 207     uint8_t ea[ETH_ADDR_LEN];
 208     time_t now;
 209
 210     now = time_now();
 211     if (now < ib->next_local_refresh) {
 212         return false;
 213     }
 214     ib->next_local_refresh = now + 1;
 215
 216     if (netdev_get_etheraddr(ib->local_netdev, ea)
 217         || eth_addr_equals(ea, ib->local_mac)) {
 218         return false;
 219     }
 220
 221     memcpy(ib->local_mac, ea, ETH_ADDR_LEN);
 222     return true;
 223 }
 224
 225 /* Returns true if packets in 'flow' should be directed to the local port.
 226  * (This keeps the flow table from preventing DHCP replies from being seen by
 227  * the local port.) */
 228 bool
 229 in_band_must_output_to_local_port(const struct flow *flow)
 230 {
 231     return (flow->dl_type == htons(ETH_TYPE_IP)
 232             && flow->nw_proto == IPPROTO_UDP
 233             && flow->tp_src == htons(DHCP_SERVER_PORT)
 234             && flow->tp_dst == htons(DHCP_CLIENT_PORT));
 235 }
 236
 237 static void
 238 add_rule(struct in_band *ib, const struct match *match, unsigned int priority)
 239 {
 240     uint32_t hash = match_hash(match, 0);
 241     struct in_band_rule *rule;
 242
 243     HMAP_FOR_EACH_WITH_HASH (rule, hmap_node, hash, &ib->rules) {
 244         if (match_equal(&rule->match, match)) {
 245             rule->op = ADD;
 246             return;
 247         }
 248     }
 249
 250     rule = xmalloc(sizeof *rule);
 251     rule->match = *match;
 252     rule->priority = priority;
 253     rule->op = ADD;
 254     hmap_insert(&ib->rules, &rule->hmap_node, hash);
 255 }
 256
 257 static void
 258 update_rules(struct in_band *ib)
 259 {
 260     struct in_band_rule *ib_rule;
 261     struct in_band_remote *r;
 262     struct match match;
 263
 264     /* Mark all the existing rules for deletion.  (Afterward we will re-add any
 265      * rules that are still valid.) */
 266     HMAP_FOR_EACH (ib_rule, hmap_node, &ib->rules) {
 267         ib_rule->op = DELETE;
 268     }
 269
 270     if (ib->n_remotes && !eth_addr_is_zero(ib->local_mac)) {
 271         /* (a) Allow DHCP requests sent from the local port. */
 272         match_init_catchall(&match);
 273         match_set_in_port(&match, OFPP_LOCAL);
 274         match_set_dl_type(&match, htons(ETH_TYPE_IP));
 275         match_set_dl_src(&match, ib->local_mac);
 276         match_set_nw_proto(&match, IPPROTO_UDP);
 277         match_set_tp_src(&match, htons(DHCP_CLIENT_PORT));
 278         match_set_tp_dst(&match, htons(DHCP_SERVER_PORT));
 279         add_rule(ib, &match, IBR_FROM_LOCAL_DHCP);
 280
 281         /* (b) Allow ARP replies to the local port's MAC address. */
 282         match_init_catchall(&match);
 283         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 284         match_set_dl_dst(&match, ib->local_mac);
 285         match_set_nw_proto(&match, ARP_OP_REPLY);
 286         add_rule(ib, &match, IBR_TO_LOCAL_ARP);
 287
 288         /* (c) Allow ARP requests from the local port's MAC address.  */
 289         match_init_catchall(&match);
 290         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 291         match_set_dl_src(&match, ib->local_mac);
 292         match_set_nw_proto(&match, ARP_OP_REQUEST);
 293         add_rule(ib, &match, IBR_FROM_LOCAL_ARP);
 294     }
 295
 296     for (r = ib->remotes; r < &ib->remotes[ib->n_remotes]; r++) {
 297         const uint8_t *remote_mac = r->remote_mac;
 298
 299         if (eth_addr_is_zero(remote_mac)) {
 300             continue;
 301         }
 302
 303         /* (d) Allow ARP replies to the next hop's MAC address. */
 304         match_init_catchall(&match);
 305         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 306         match_set_dl_dst(&match, remote_mac);
 307         match_set_nw_proto(&match, ARP_OP_REPLY);
 308         add_rule(ib, &match, IBR_TO_NEXT_HOP_ARP);
 309
 310         /* (e) Allow ARP requests from the next hop's MAC address. */
 311         match_init_catchall(&match);
 312         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 313         match_set_dl_src(&match, remote_mac);
 314         match_set_nw_proto(&match, ARP_OP_REQUEST);
 315         add_rule(ib, &match, IBR_FROM_NEXT_HOP_ARP);
 316     }
 317
 318     for (r = ib->remotes; r < &ib->remotes[ib->n_remotes]; r++) {
 319         const struct sockaddr_in *a = &r->remote_addr;
 320
 321         /* (f) Allow ARP replies containing the remote's IP address as a
 322          * target. */
 323         match_init_catchall(&match);
 324         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 325         match_set_nw_proto(&match, ARP_OP_REPLY);
 326         match_set_nw_dst(&match, a->sin_addr.s_addr);
 327         add_rule(ib, &match, IBR_TO_REMOTE_ARP);
 328
 329         /* (g) Allow ARP requests containing the remote's IP address as a
 330          * source. */
 331         match_init_catchall(&match);
 332         match_set_dl_type(&match, htons(ETH_TYPE_ARP));
 333         match_set_nw_proto(&match, ARP_OP_REQUEST);
 334         match_set_nw_src(&match, a->sin_addr.s_addr);
 335         add_rule(ib, &match, IBR_FROM_REMOTE_ARP);
 336
 337         /* (h) Allow TCP traffic to the remote's IP and port. */
 338         match_init_catchall(&match);
 339         match_set_dl_type(&match, htons(ETH_TYPE_IP));
 340         match_set_nw_proto(&match, IPPROTO_TCP);
 341         match_set_nw_dst(&match, a->sin_addr.s_addr);
 342         match_set_tp_dst(&match, a->sin_port);
 343         add_rule(ib, &match, IBR_TO_REMOTE_TCP);
 344
 345         /* (i) Allow TCP traffic from the remote's IP and port. */
 346         match_init_catchall(&match);
 347         match_set_dl_type(&match, htons(ETH_TYPE_IP));
 348         match_set_nw_proto(&match, IPPROTO_TCP);
 349         match_set_nw_src(&match, a->sin_addr.s_addr);
 350         match_set_tp_src(&match, a->sin_port);
 351         add_rule(ib, &match, IBR_FROM_REMOTE_TCP);
 352     }
 353 }
 354
 355 /* Updates the OpenFlow flow table for the current state of in-band control.
 356  * Returns true ordinarily.  Returns false if no remotes are configured on 'ib'
 357  * and 'ib' doesn't have any rules left to remove from the OpenFlow flow
 358  * table.  Thus, a false return value means that the caller can destroy 'ib'
 359  * without leaving extra flows hanging around in the flow table. */
 360 bool
 361 in_band_run(struct in_band *ib)
 362 {
 363     uint64_t ofpacts_stub[128 / 8];
 364     struct ofpbuf ofpacts;
 365
 366     struct in_band_rule *rule, *next;
 367
 368     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
 369
 370     if (ib->queue_id >= 0) {
 371         ofpact_put_SET_QUEUE(&ofpacts)->queue_id = ib->queue_id;
 372     }
 373     ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
 374
 375     refresh_local(ib);
 376     refresh_remotes(ib);
 377
 378     update_rules(ib);
 379
 380     HMAP_FOR_EACH_SAFE (rule, next, hmap_node, &ib->rules) {
 381         switch (rule->op) {
 382         case ADD:
 383             ofproto_add_flow(ib->ofproto, &rule->match, rule->priority,
 384                              ofpacts.data, ofpacts.size);
 385             break;
 386
 387         case DELETE:
 388             if (ofproto_delete_flow(ib->ofproto,
 389                                     &rule->match, rule->priority)) {
 390                 /* ofproto doesn't have the rule anymore so there's no reason
 391                  * for us to track it any longer. */
 392                 hmap_remove(&ib->rules, &rule->hmap_node);
 393                 free(rule);
 394             }
 395             break;
 396         }
 397     }
 398
 399     ofpbuf_uninit(&ofpacts);
 400
 401     return ib->n_remotes || !hmap_is_empty(&ib->rules);
 402 }
 403
 404 void
 405 in_band_wait(struct in_band *in_band)
 406 {
 407     long long int wakeup
 408             = MIN(in_band->next_remote_refresh, in_band->next_local_refresh);
 409     poll_timer_wait_until(wakeup * 1000);
 410 }
 411
 412 int
 413 in_band_create(struct ofproto *ofproto, const char *local_name,
 414                struct in_band **in_bandp)
 415 {
 416     struct in_band *in_band;
 417     struct netdev *local_netdev;
 418     int error;
 419
 420     *in_bandp = NULL;
 421     error = netdev_open(local_name, "internal", &local_netdev);
 422     if (error) {
 423         VLOG_ERR("failed to initialize in-band control: cannot open "
 424                  "datapath local port %s (%s)", local_name, strerror(error));
 425         return error;
 426     }
 427
 428     in_band = xzalloc(sizeof *in_band);
 429     in_band->ofproto = ofproto;
 430     in_band->queue_id = -1;
 431     in_band->next_remote_refresh = TIME_MIN;
 432     in_band->next_local_refresh = TIME_MIN;
 433     in_band->local_netdev = local_netdev;
 434     hmap_init(&in_band->rules);
 435
 436     *in_bandp = in_band;
 437
 438     return 0;
 439 }
 440
 441 void
 442 in_band_destroy(struct in_band *ib)
 443 {
 444     if (ib) {
 445         struct in_band_rule *rule, *next;
 446
 447         HMAP_FOR_EACH_SAFE (rule, next, hmap_node, &ib->rules) {
 448             hmap_remove(&ib->rules, &rule->hmap_node);
 449             free(rule);
 450         }
 451         hmap_destroy(&ib->rules);
 452         in_band_set_remotes(ib, NULL, 0);
 453         netdev_close(ib->local_netdev);
 454         free(ib);
 455     }
 456 }
 457
 458 static bool
 459 any_addresses_changed(struct in_band *ib,
 460                       const struct sockaddr_in *addresses, size_t n)
 461 {
 462     size_t i;
 463
 464     if (n != ib->n_remotes) {
 465         return true;
 466     }
 467
 468     for (i = 0; i < n; i++) {
 469         const struct sockaddr_in *old = &ib->remotes[i].remote_addr;
 470         const struct sockaddr_in *new = &addresses[i];
 471
 472         if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
 473             old->sin_port != new->sin_port) {
 474             return true;
 475         }
 476     }
 477
 478     return false;
 479 }
 480
 481 void
 482 in_band_set_remotes(struct in_band *ib,
 483                     const struct sockaddr_in *addresses, size_t n)
 484 {
 485     size_t i;
 486
 487     if (!any_addresses_changed(ib, addresses, n)) {
 488         return;
 489     }
 490
 491     /* Clear old remotes. */
 492     for (i = 0; i < ib->n_remotes; i++) {
 493         netdev_close(ib->remotes[i].remote_netdev);
 494     }
 495     free(ib->remotes);
 496
 497     /* Set up new remotes. */
 498     ib->remotes = n ? xzalloc(n * sizeof *ib->remotes) : NULL;
 499     ib->n_remotes = n;
 500     for (i = 0; i < n; i++) {
 501         ib->remotes[i].remote_addr = addresses[i];
 502     }
 503
 504     /* Force refresh in next call to in_band_run(). */
 505     ib->next_remote_refresh = TIME_MIN;
 506 }
 507
 508 /* Sets the OpenFlow queue used by flows set up by 'ib' to 'queue_id'.  If
 509  * 'queue_id' is negative, 'ib' will not set any queue (which is also the
 510  * default). */
 511 void
 512 in_band_set_queue(struct in_band *ib, int queue_id)
 513 {
 514     ib->queue_id = queue_id;
 515 }
 516