ofproto/fail-open.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015, 2016 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 "fail-open.h"
  19 #include <inttypes.h>
  20 #include <stdlib.h>
  21 #include "classifier.h"
  22 #include "connmgr.h"
  23 #include "flow.h"
  24 #include "mac-learning.h"
  25 #include "odp-util.h"
  26 #include "ofpbuf.h"
  27 #include "ofp-actions.h"
  28 #include "ofp-util.h"
  29 #include "ofproto.h"
  30 #include "ofproto-provider.h"
  31 #include "pktbuf.h"
  32 #include "dp-packet.h"
  33 #include "poll-loop.h"
  34 #include "rconn.h"
  35 #include "timeval.h"
  36 #include "openvswitch/vconn.h"
  37 #include "openvswitch/vlog.h"
  38
  39 VLOG_DEFINE_THIS_MODULE(fail_open);
  40
  41 /*
  42  * Fail-open mode.
  43  *
  44  * In fail-open mode, the switch detects when the controller cannot be
  45  * contacted or when the controller is dropping switch connections because the
  46  * switch does not pass its admission control policy.  In those situations the
  47  * switch sets up flows itself using the "normal" action.
  48  *
  49  * There is a little subtlety to implementation, to properly handle the case
  50  * where the controller allows switch connections but drops them a few seconds
  51  * later for admission control reasons.  Because of this case, we don't want to
  52  * just stop setting up flows when we connect to the controller: if we did,
  53  * then new flow setup and existing flows would stop during the duration of
  54  * connection to the controller, and thus the whole network would go down for
  55  * that period of time.
  56  *
  57  * So, instead, we add some special cases when we are connected to a
  58  * controller, but not yet sure that it has admitted us:
  59  *
  60  *     - We set up flows immediately ourselves, but simultaneously send out an
  61  *       OFPT_PACKET_IN to the controller.  We put a special bogus buffer-id in
  62  *       these OFPT_PACKET_IN messages so that duplicate packets don't get sent
  63  *       out to the network when the controller replies.
  64  *
  65  *     - We also send out OFPT_PACKET_IN messages for totally bogus packets
  66  *       every so often, in case no real new flows are arriving in the network.
  67  *
  68  *     - We don't flush the flow table at the time we connect, because this
  69  *       could cause network stuttering in a switch with lots of flows or very
  70  *       high-bandwidth flows by suddenly throwing lots of packets down to
  71  *       userspace.
  72  */
  73
  74 struct fail_open {
  75     struct ofproto *ofproto;
  76     struct connmgr *connmgr;
  77     int last_disconn_secs;
  78     long long int next_bogus_packet_in;
  79     struct rconn_packet_counter *bogus_packet_counter;
  80     bool fail_open_active;
  81 };
  82
  83 static void fail_open_recover(struct fail_open *);
  84
  85 /* Returns the number of seconds of disconnection after which fail-open mode
  86  * should activate. */
  87 static int
  88 trigger_duration(const struct fail_open *fo)
  89 {
  90     if (!connmgr_has_controllers(fo->connmgr)) {
  91         /* Shouldn't ever arrive here, but if we do, never fail open. */
  92         return INT_MAX;
  93     } else {
  94         /* Otherwise, every controller must have a chance to send an
  95          * inactivity probe and reconnect before we fail open, so take the
  96          * maximum probe interval and multiply by 3:
  97          *
  98          *  - The first interval is the idle time before sending an inactivity
  99          *    probe.
 100          *
 101          *  - The second interval is the time allowed for a response to the
 102          *    inactivity probe.
 103          *
 104          *  - The third interval is the time allowed to reconnect after no
 105          *    response is received.
 106          */
 107         return connmgr_get_max_probe_interval(fo->connmgr) * 3;
 108     }
 109 }
 110
 111 /* Returns true if 'fo' is currently in fail-open mode, otherwise false. */
 112 bool
 113 fail_open_is_active(const struct fail_open *fo)
 114 {
 115     return fo->last_disconn_secs != 0;
 116 }
 117
 118 static void
 119 send_bogus_packet_ins(struct fail_open *fo)
 120 {
 121     struct eth_addr mac;
 122     struct dp_packet b;
 123
 124     dp_packet_init(&b, 128);
 125     eth_addr_nicira_random(&mac);
 126     compose_rarp(&b, mac);
 127
 128     struct ofproto_packet_in pin = {
 129         .up = {
 130             .packet = dp_packet_data(&b),
 131             .len = dp_packet_size(&b),
 132             .flow_metadata = MATCH_CATCHALL_INITIALIZER,
 133             .flow_metadata.flow.in_port.ofp_port = OFPP_LOCAL,
 134             .flow_metadata.wc.masks.in_port.ofp_port = u16_to_ofp(UINT16_MAX),
 135             .reason = OFPR_NO_MATCH,
 136             .cookie = OVS_BE64_MAX,
 137         },
 138         .max_len = UINT16_MAX,
 139     };
 140     connmgr_send_packet_in(fo->connmgr, &pin);
 141
 142     dp_packet_uninit(&b);
 143 }
 144
 145 /* Enter fail-open mode if we should be in it. */
 146 void
 147 fail_open_run(struct fail_open *fo)
 148 {
 149     int disconn_secs = connmgr_failure_duration(fo->connmgr);
 150
 151     /* Enter fail-open mode if 'fo' is not in it but should be.  */
 152     if (disconn_secs >= trigger_duration(fo)) {
 153         if (!fail_open_is_active(fo)) {
 154             VLOG_WARN("Could not connect to controller (or switch failed "
 155                       "controller's post-connection admission control "
 156                       "policy) for %d seconds, failing open", disconn_secs);
 157             fo->last_disconn_secs = disconn_secs;
 158
 159             /* Flush all OpenFlow and datapath flows.  We will set up our
 160              * fail-open rule from fail_open_flushed() when
 161              * ofproto_flush_flows() calls back to us. */
 162             ofproto_flush_flows(fo->ofproto);
 163         } else if (disconn_secs > fo->last_disconn_secs + 60) {
 164             VLOG_INFO("Still in fail-open mode after %d seconds disconnected "
 165                       "from controller", disconn_secs);
 166             fo->last_disconn_secs = disconn_secs;
 167         }
 168     }
 169
 170     /* Schedule a bogus packet-in if we're connected and in fail-open. */
 171     if (fail_open_is_active(fo)) {
 172         if (connmgr_is_any_controller_connected(fo->connmgr)) {
 173             bool expired = time_msec() >= fo->next_bogus_packet_in;
 174             if (expired) {
 175                 send_bogus_packet_ins(fo);
 176             }
 177             if (expired || fo->next_bogus_packet_in == LLONG_MAX) {
 178                 fo->next_bogus_packet_in = time_msec() + 2000;
 179             }
 180         } else {
 181             fo->next_bogus_packet_in = LLONG_MAX;
 182         }
 183     }
 184
 185 }
 186
 187 /* If 'fo' is currently in fail-open mode and its rconn has connected to the
 188  * controller, exits fail open mode. */
 189 void
 190 fail_open_maybe_recover(struct fail_open *fo)
 191     OVS_EXCLUDED(ofproto_mutex)
 192 {
 193     if (fail_open_is_active(fo)
 194         && connmgr_is_any_controller_admitted(fo->connmgr)) {
 195         fail_open_recover(fo);
 196     }
 197 }
 198
 199 static void
 200 fail_open_recover(struct fail_open *fo)
 201     OVS_EXCLUDED(ofproto_mutex)
 202 {
 203     struct match match;
 204
 205     VLOG_WARN("No longer in fail-open mode");
 206     fo->last_disconn_secs = 0;
 207     fo->next_bogus_packet_in = LLONG_MAX;
 208
 209     match_init_catchall(&match);
 210     ofproto_delete_flow(fo->ofproto, &match, FAIL_OPEN_PRIORITY);
 211 }
 212
 213 void
 214 fail_open_wait(struct fail_open *fo)
 215 {
 216     if (fo->next_bogus_packet_in != LLONG_MAX) {
 217         poll_timer_wait_until(fo->next_bogus_packet_in);
 218     }
 219 }
 220
 221 void
 222 fail_open_flushed(struct fail_open *fo)
 223     OVS_EXCLUDED(ofproto_mutex)
 224 {
 225     int disconn_secs = connmgr_failure_duration(fo->connmgr);
 226     bool open = disconn_secs >= trigger_duration(fo);
 227     if (open) {
 228         struct ofpbuf ofpacts;
 229         struct match match;
 230
 231         /* Set up a flow that matches every packet and directs them to
 232          * OFPP_NORMAL. */
 233         ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
 234         ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
 235
 236         match_init_catchall(&match);
 237         ofproto_add_flow(fo->ofproto, &match, FAIL_OPEN_PRIORITY,
 238                          ofpacts.data, ofpacts.size);
 239
 240         ofpbuf_uninit(&ofpacts);
 241     }
 242     fo->fail_open_active = open;
 243 }
 244
 245 /* Returns the number of fail-open rules currently installed in the flow
 246  * table. */
 247 int
 248 fail_open_count_rules(const struct fail_open *fo)
 249 {
 250     return fo->fail_open_active != 0;
 251 }
 252
 253 /* Creates and returns a new struct fail_open for 'ofproto' and 'mgr'. */
 254 struct fail_open *
 255 fail_open_create(struct ofproto *ofproto, struct connmgr *mgr)
 256 {
 257     struct fail_open *fo = xmalloc(sizeof *fo);
 258     fo->ofproto = ofproto;
 259     fo->connmgr = mgr;
 260     fo->last_disconn_secs = 0;
 261     fo->next_bogus_packet_in = LLONG_MAX;
 262     fo->bogus_packet_counter = rconn_packet_counter_create();
 263     fo->fail_open_active = false;
 264     return fo;
 265 }
 266
 267 /* Destroys 'fo'. */
 268 void
 269 fail_open_destroy(struct fail_open *fo)
 270     OVS_EXCLUDED(ofproto_mutex)
 271 {
 272     if (fo) {
 273         if (fail_open_is_active(fo)) {
 274             fail_open_recover(fo);
 275         }
 276         /* We don't own fo->connmgr. */
 277         rconn_packet_counter_destroy(fo->bogus_packet_counter);
 278         free(fo);
 279     }
 280 }