Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / ofproto / fail-open.c
index 0e88729..b29e5af 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include "fail-open.h"
 #include <inttypes.h>
 #include <stdlib.h>
+#include "classifier.h"
+#include "connmgr.h"
 #include "flow.h"
 #include "mac-learning.h"
 #include "odp-util.h"
+#include "ofp-actions.h"
+#include "ofp-util.h"
+#include "ofpbuf.h"
 #include "ofproto.h"
+#include "ofproto-provider.h"
+#include "pktbuf.h"
+#include "poll-loop.h"
 #include "rconn.h"
-#include "status.h"
 #include "timeval.h"
-
-#define THIS_MODULE VLM_fail_open
+#include "vconn.h"
 #include "vlog.h"
 
+VLOG_DEFINE_THIS_MODULE(fail_open);
+
+/*
+ * Fail-open mode.
+ *
+ * In fail-open mode, the switch detects when the controller cannot be
+ * contacted or when the controller is dropping switch connections because the
+ * switch does not pass its admission control policy.  In those situations the
+ * switch sets up flows itself using the "normal" action.
+ *
+ * There is a little subtlety to implementation, to properly handle the case
+ * where the controller allows switch connections but drops them a few seconds
+ * later for admission control reasons.  Because of this case, we don't want to
+ * just stop setting up flows when we connect to the controller: if we did,
+ * then new flow setup and existing flows would stop during the duration of
+ * connection to the controller, and thus the whole network would go down for
+ * that period of time.
+ *
+ * So, instead, we add some special cases when we are connected to a
+ * controller, but not yet sure that it has admitted us:
+ *
+ *     - We set up flows immediately ourselves, but simultaneously send out an
+ *       OFPT_PACKET_IN to the controller.  We put a special bogus buffer-id in
+ *       these OFPT_PACKET_IN messages so that duplicate packets don't get sent
+ *       out to the network when the controller replies.
+ *
+ *     - We also send out OFPT_PACKET_IN messages for totally bogus packets
+ *       every so often, in case no real new flows are arriving in the network.
+ *
+ *     - We don't flush the flow table at the time we connect, because this
+ *       could cause network stuttering in a switch with lots of flows or very
+ *       high-bandwidth flows by suddenly throwing lots of packets down to
+ *       userspace.
+ */
+
 struct fail_open {
     struct ofproto *ofproto;
-    struct rconn *controller;
-    int trigger_duration;
+    struct connmgr *connmgr;
     int last_disconn_secs;
-    struct status_category *ss_cat;
+    long long int next_bogus_packet_in;
+    struct rconn_packet_counter *bogus_packet_counter;
 };
 
-/* Causes the switch to enter or leave fail-open mode, if appropriate. */
+static void fail_open_recover(struct fail_open *);
+
+/* Returns the number of seconds of disconnection after which fail-open mode
+ * should activate. */
+static int
+trigger_duration(const struct fail_open *fo)
+{
+    if (!connmgr_has_controllers(fo->connmgr)) {
+        /* Shouldn't ever arrive here, but if we do, never fail open. */
+        return INT_MAX;
+    } else {
+        /* Otherwise, every controller must have a chance to send an
+         * inactivity probe and reconnect before we fail open, so take the
+         * maximum probe interval and multiply by 3:
+         *
+         *  - The first interval is the idle time before sending an inactivity
+         *    probe.
+         *
+         *  - The second interval is the time allowed for a response to the
+         *    inactivity probe.
+         *
+         *  - The third interval is the time allowed to reconnect after no
+         *    response is received.
+         */
+        return connmgr_get_max_probe_interval(fo->connmgr) * 3;
+    }
+}
+
+/* Returns true if 'fo' is currently in fail-open mode, otherwise false. */
+bool
+fail_open_is_active(const struct fail_open *fo)
+{
+    return fo->last_disconn_secs != 0;
+}
+
+static void
+send_bogus_packet_ins(struct fail_open *fo)
+{
+    struct ofproto_packet_in pin;
+    uint8_t mac[ETH_ADDR_LEN];
+    struct ofpbuf b;
+
+    ofpbuf_init(&b, 128);
+    eth_addr_nicira_random(mac);
+    compose_rarp(&b, mac);
+
+    memset(&pin, 0, sizeof pin);
+    pin.up.packet = ofpbuf_data(&b);
+    pin.up.packet_len = ofpbuf_size(&b);
+    pin.up.reason = OFPR_NO_MATCH;
+    pin.up.fmd.in_port = OFPP_LOCAL;
+    pin.send_len = ofpbuf_size(&b);
+    pin.miss_type = OFPROTO_PACKET_IN_NO_MISS;
+    connmgr_send_packet_in(fo->connmgr, &pin);
+
+    ofpbuf_uninit(&b);
+}
+
+/* Enter fail-open mode if we should be in it. */
 void
 fail_open_run(struct fail_open *fo)
 {
-    int disconn_secs = rconn_failure_duration(fo->controller);
-    bool open = disconn_secs >= fo->trigger_duration;
-    if (open != (fo->last_disconn_secs != 0)) {
-        if (!open) {
-            flow_t flow;
+    int disconn_secs = connmgr_failure_duration(fo->connmgr);
 
-            VLOG_WARN("No longer in fail-open mode");
-            fo->last_disconn_secs = 0;
-
-            memset(&flow, 0, sizeof flow);
-            ofproto_delete_flow(fo->ofproto, &flow, OFPFW_ALL, 70000);
-        } else {
-            VLOG_WARN("Could not connect to controller for %d seconds, "
-                      "failing open", disconn_secs);
+    /* Enter fail-open mode if 'fo' is not in it but should be.  */
+    if (disconn_secs >= trigger_duration(fo)) {
+        if (!fail_open_is_active(fo)) {
+            VLOG_WARN("Could not connect to controller (or switch failed "
+                      "controller's post-connection admission control "
+                      "policy) for %d seconds, failing open", disconn_secs);
             fo->last_disconn_secs = disconn_secs;
 
             /* Flush all OpenFlow and datapath flows.  We will set up our
              * fail-open rule from fail_open_flushed() when
              * ofproto_flush_flows() calls back to us. */
             ofproto_flush_flows(fo->ofproto);
+        } else if (disconn_secs > fo->last_disconn_secs + 60) {
+            VLOG_INFO("Still in fail-open mode after %d seconds disconnected "
+                      "from controller", disconn_secs);
+            fo->last_disconn_secs = disconn_secs;
         }
-    } else if (open && disconn_secs > fo->last_disconn_secs + 60) {
-        VLOG_INFO("Still in fail-open mode after %d seconds disconnected "
-                  "from controller", disconn_secs);
-        fo->last_disconn_secs = disconn_secs;
     }
+
+    /* Schedule a bogus packet-in if we're connected and in fail-open. */
+    if (fail_open_is_active(fo)) {
+        if (connmgr_is_any_controller_connected(fo->connmgr)) {
+            bool expired = time_msec() >= fo->next_bogus_packet_in;
+            if (expired) {
+                send_bogus_packet_ins(fo);
+            }
+            if (expired || fo->next_bogus_packet_in == LLONG_MAX) {
+                fo->next_bogus_packet_in = time_msec() + 2000;
+            }
+        } else {
+            fo->next_bogus_packet_in = LLONG_MAX;
+        }
+    }
+
+}
+
+/* If 'fo' is currently in fail-open mode and its rconn has connected to the
+ * controller, exits fail open mode. */
+void
+fail_open_maybe_recover(struct fail_open *fo)
+    OVS_EXCLUDED(ofproto_mutex)
+{
+    if (fail_open_is_active(fo)
+        && connmgr_is_any_controller_admitted(fo->connmgr)) {
+        fail_open_recover(fo);
+    }
+}
+
+static void
+fail_open_recover(struct fail_open *fo)
+    OVS_EXCLUDED(ofproto_mutex)
+{
+    struct match match;
+
+    VLOG_WARN("No longer in fail-open mode");
+    fo->last_disconn_secs = 0;
+    fo->next_bogus_packet_in = LLONG_MAX;
+
+    match_init_catchall(&match);
+    ofproto_delete_flow(fo->ofproto, &match, FAIL_OPEN_PRIORITY);
 }
 
 void
-fail_open_wait(struct fail_open *fo UNUSED)
+fail_open_wait(struct fail_open *fo)
 {
-    /* Nothing to do. */
+    if (fo->next_bogus_packet_in != LLONG_MAX) {
+        poll_timer_wait_until(fo->next_bogus_packet_in);
+    }
 }
 
 void
 fail_open_flushed(struct fail_open *fo)
+    OVS_EXCLUDED(ofproto_mutex)
 {
-    int disconn_secs = rconn_failure_duration(fo->controller);
-    bool open = disconn_secs >= fo->trigger_duration;
+    int disconn_secs = connmgr_failure_duration(fo->connmgr);
+    bool open = disconn_secs >= trigger_duration(fo);
     if (open) {
-        union ofp_action action;
-        flow_t flow;
+        struct ofpbuf ofpacts;
+        struct match match;
 
         /* Set up a flow that matches every packet and directs them to
          * OFPP_NORMAL. */
-        memset(&action, 0, sizeof action);
-        action.type = htons(OFPAT_OUTPUT);
-        action.output.len = htons(sizeof action);
-        action.output.port = htons(OFPP_NORMAL);
-        memset(&flow, 0, sizeof flow);
-        ofproto_add_flow(fo->ofproto, &flow, OFPFW_ALL, 70000,
-                         &action, 1, 0);
-    }
-}
+        ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
+        ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
+        ofpact_pad(&ofpacts);
 
-static void
-fail_open_status_cb(struct status_reply *sr, void *fo_)
-{
-    struct fail_open *fo = fo_;
-    int cur_duration = rconn_failure_duration(fo->controller);
+        match_init_catchall(&match);
+        ofproto_add_flow(fo->ofproto, &match, FAIL_OPEN_PRIORITY,
+                         ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts));
 
-    status_reply_put(sr, "trigger-duration=%d", fo->trigger_duration);
-    status_reply_put(sr, "current-duration=%d", cur_duration);
-    status_reply_put(sr, "triggered=%s",
-                     cur_duration >= fo->trigger_duration ? "true" : "false");
+        ofpbuf_uninit(&ofpacts);
+    }
 }
 
+/* Creates and returns a new struct fail_open for 'ofproto' and 'mgr'. */
 struct fail_open *
-fail_open_create(struct ofproto *ofproto,
-                 int trigger_duration, struct switch_status *switch_status,
-                 struct rconn *controller)
+fail_open_create(struct ofproto *ofproto, struct connmgr *mgr)
 {
     struct fail_open *fo = xmalloc(sizeof *fo);
     fo->ofproto = ofproto;
-    fo->controller = controller;
-    fo->trigger_duration = trigger_duration;
+    fo->connmgr = mgr;
     fo->last_disconn_secs = 0;
-    fo->ss_cat = switch_status_register(switch_status, "fail-open",
-                                        fail_open_status_cb, fo);
+    fo->next_bogus_packet_in = LLONG_MAX;
+    fo->bogus_packet_counter = rconn_packet_counter_create();
     return fo;
 }
 
-void
-fail_open_set_trigger_duration(struct fail_open *fo, int trigger_duration)
-{
-    fo->trigger_duration = trigger_duration;
-}
-
+/* Destroys 'fo'. */
 void
 fail_open_destroy(struct fail_open *fo)
+    OVS_EXCLUDED(ofproto_mutex)
 {
     if (fo) {
-        /* We don't own fo->controller. */
-        switch_status_unregister(fo->ss_cat);
+        if (fail_open_is_active(fo)) {
+            fail_open_recover(fo);
+        }
+        /* We don't own fo->connmgr. */
+        rconn_packet_counter_destroy(fo->bogus_packet_counter);
         free(fo);
     }
 }