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