2 * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
25 #include "fail-open.h"
31 #include "poll-loop.h"
40 VLOG_DEFINE_THIS_MODULE(connmgr);
41 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
43 /* An OpenFlow connection. */
45 struct connmgr *connmgr; /* Connection's manager. */
46 struct list node; /* In struct connmgr's "all_conns" list. */
47 struct rconn *rconn; /* OpenFlow connection. */
48 enum ofconn_type type; /* Type. */
49 enum nx_flow_format flow_format; /* Currently selected flow format. */
50 bool flow_mod_table_id; /* NXT_FLOW_MOD_TABLE_ID enabled? */
52 /* Asynchronous flow table operation support. */
53 struct list opgroups; /* Contains pending "ofopgroups", if any. */
54 struct ofpbuf *blocked; /* Postponed OpenFlow message, if any. */
55 bool retry; /* True if 'blocked' is ready to try again. */
57 /* OFPT_PACKET_IN related data. */
58 struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
59 #define N_SCHEDULERS 2
60 struct pinsched *schedulers[N_SCHEDULERS];
61 struct pktbuf *pktbuf; /* OpenFlow packet buffers. */
62 int miss_send_len; /* Bytes to send of buffered packets. */
64 /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
65 * requests, and the maximum number before we stop reading OpenFlow
67 #define OFCONN_REPLY_MAX 100
68 struct rconn_packet_counter *reply_counter;
70 /* type == OFCONN_PRIMARY only. */
71 enum nx_role role; /* Role. */
72 struct hmap_node hmap_node; /* In struct connmgr's "controllers" map. */
73 enum ofproto_band band; /* In-band or out-of-band? */
76 static struct ofconn *ofconn_create(struct connmgr *, struct rconn *,
78 static void ofconn_destroy(struct ofconn *);
80 static void ofconn_reconfigure(struct ofconn *,
81 const struct ofproto_controller *);
83 static void ofconn_run(struct ofconn *,
84 bool (*handle_openflow)(struct ofconn *,
85 struct ofpbuf *ofp_msg));
86 static void ofconn_wait(struct ofconn *, bool handling_openflow);
88 static const char *ofconn_get_target(const struct ofconn *);
89 static char *ofconn_make_name(const struct connmgr *, const char *target);
91 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
93 static bool ofconn_receives_async_msgs(const struct ofconn *);
95 static void ofconn_send(const struct ofconn *, struct ofpbuf *,
96 struct rconn_packet_counter *);
98 static void do_send_packet_in(struct ofpbuf *, void *ofconn_);
100 /* A listener for incoming OpenFlow "service" connections. */
102 struct hmap_node node; /* In struct connmgr's "services" hmap. */
103 struct pvconn *pvconn; /* OpenFlow connection listener. */
105 /* These are not used by ofservice directly. They are settings for
106 * accepted "struct ofconn"s from the pvconn. */
107 int probe_interval; /* Max idle time before probing, in seconds. */
108 int rate_limit; /* Max packet-in rate in packets per second. */
109 int burst_limit; /* Limit on accumulating packet credits. */
112 static void ofservice_reconfigure(struct ofservice *,
113 const struct ofproto_controller *);
114 static int ofservice_create(struct connmgr *, const char *target);
115 static void ofservice_destroy(struct connmgr *, struct ofservice *);
116 static struct ofservice *ofservice_lookup(struct connmgr *,
119 /* Connection manager for an OpenFlow switch. */
121 struct ofproto *ofproto;
123 char *local_port_name;
125 /* OpenFlow connections. */
126 struct hmap controllers; /* Controller "struct ofconn"s. */
127 struct list all_conns; /* Contains "struct ofconn"s. */
129 /* OpenFlow listeners. */
130 struct hmap services; /* Contains "struct ofservice"s. */
131 struct pvconn **snoops;
135 struct fail_open *fail_open;
136 enum ofproto_fail_mode fail_mode;
138 /* In-band control. */
139 struct in_band *in_band;
140 long long int next_in_band_update;
141 struct sockaddr_in *extra_in_band_remotes;
142 size_t n_extra_remotes;
146 static void update_in_band_remotes(struct connmgr *);
147 static void add_snooper(struct connmgr *, struct vconn *);
149 /* Creates and returns a new connection manager owned by 'ofproto'. 'name' is
150 * a name for the ofproto suitable for using in log messages.
151 * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
154 connmgr_create(struct ofproto *ofproto,
155 const char *name, const char *local_port_name)
159 mgr = xmalloc(sizeof *mgr);
160 mgr->ofproto = ofproto;
161 mgr->name = xstrdup(name);
162 mgr->local_port_name = xstrdup(local_port_name);
164 hmap_init(&mgr->controllers);
165 list_init(&mgr->all_conns);
167 hmap_init(&mgr->services);
171 mgr->fail_open = NULL;
172 mgr->fail_mode = OFPROTO_FAIL_SECURE;
175 mgr->next_in_band_update = LLONG_MAX;
176 mgr->extra_in_band_remotes = NULL;
177 mgr->n_extra_remotes = 0;
178 mgr->in_band_queue = -1;
183 /* Frees 'mgr' and all of its resources. */
185 connmgr_destroy(struct connmgr *mgr)
187 struct ofservice *ofservice, *next_ofservice;
188 struct ofconn *ofconn, *next_ofconn;
195 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
196 ofconn_destroy(ofconn);
198 hmap_destroy(&mgr->controllers);
200 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
201 ofservice_destroy(mgr, ofservice);
203 hmap_destroy(&mgr->services);
205 for (i = 0; i < mgr->n_snoops; i++) {
206 pvconn_close(mgr->snoops[i]);
210 fail_open_destroy(mgr->fail_open);
211 mgr->fail_open = NULL;
213 in_band_destroy(mgr->in_band);
215 free(mgr->extra_in_band_remotes);
217 free(mgr->local_port_name);
222 /* Does all of the periodic maintenance required by 'mgr'.
224 * If 'handle_openflow' is nonnull, calls 'handle_openflow' for each message
225 * received on an OpenFlow connection, passing along the OpenFlow connection
226 * itself and the message that was sent. If 'handle_openflow' returns true,
227 * the message is considered to be fully processed. If 'handle_openflow'
228 * returns false, the message is considered not to have been processed at all;
229 * it will be stored and re-presented to 'handle_openflow' following the next
230 * call to connmgr_retry(). 'handle_openflow' must not modify or free the
233 * If 'handle_openflow' is NULL, no OpenFlow messages will be processed and
234 * other activities that could affect the flow table (in-band processing,
235 * fail-open processing) are suppressed too. */
237 connmgr_run(struct connmgr *mgr,
238 bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
240 struct ofconn *ofconn, *next_ofconn;
241 struct ofservice *ofservice;
244 if (handle_openflow && mgr->in_band) {
245 if (time_msec() >= mgr->next_in_band_update) {
246 update_in_band_remotes(mgr);
248 in_band_run(mgr->in_band);
251 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
252 ofconn_run(ofconn, handle_openflow);
255 /* Fail-open maintenance. Do this after processing the ofconns since
256 * fail-open checks the status of the controller rconn. */
257 if (handle_openflow && mgr->fail_open) {
258 fail_open_run(mgr->fail_open);
261 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
265 retval = pvconn_accept(ofservice->pvconn, OFP_VERSION, &vconn);
270 rconn = rconn_create(ofservice->probe_interval, 0);
271 name = ofconn_make_name(mgr, vconn_get_name(vconn));
272 rconn_connect_unreliably(rconn, vconn, name);
275 ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE);
276 ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
277 ofservice->burst_limit);
278 } else if (retval != EAGAIN) {
279 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
283 for (i = 0; i < mgr->n_snoops; i++) {
287 retval = pvconn_accept(mgr->snoops[i], OFP_VERSION, &vconn);
289 add_snooper(mgr, vconn);
290 } else if (retval != EAGAIN) {
291 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
296 /* Causes the poll loop to wake up when connmgr_run() needs to run.
298 * If 'handling_openflow' is true, arriving OpenFlow messages and other
299 * activities that affect the flow table will wake up the poll loop. If
300 * 'handling_openflow' is false, they will not. */
302 connmgr_wait(struct connmgr *mgr, bool handling_openflow)
304 struct ofservice *ofservice;
305 struct ofconn *ofconn;
308 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
309 ofconn_wait(ofconn, handling_openflow);
311 if (handling_openflow && mgr->in_band) {
312 poll_timer_wait_until(mgr->next_in_band_update);
313 in_band_wait(mgr->in_band);
315 if (handling_openflow && mgr->fail_open) {
316 fail_open_wait(mgr->fail_open);
318 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
319 pvconn_wait(ofservice->pvconn);
321 for (i = 0; i < mgr->n_snoops; i++) {
322 pvconn_wait(mgr->snoops[i]);
326 /* Returns the ofproto that owns 'ofconn''s connmgr. */
328 ofconn_get_ofproto(const struct ofconn *ofconn)
330 return ofconn->connmgr->ofproto;
333 /* If processing of OpenFlow messages was blocked on any 'mgr' ofconns by
334 * returning false to the 'handle_openflow' callback to connmgr_run(), this
335 * re-enables them. */
337 connmgr_retry(struct connmgr *mgr)
339 struct ofconn *ofconn;
341 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
342 ofconn->retry = true;
346 /* OpenFlow configuration. */
348 static void add_controller(struct connmgr *, const char *target);
349 static struct ofconn *find_controller_by_target(struct connmgr *,
351 static void update_fail_open(struct connmgr *);
352 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
353 const struct sset *);
355 /* Returns true if 'mgr' has any configured primary controllers.
357 * Service controllers do not count, but configured primary controllers do
358 * count whether or not they are currently connected. */
360 connmgr_has_controllers(const struct connmgr *mgr)
362 return !hmap_is_empty(&mgr->controllers);
365 /* Initializes 'info' and populates it with information about each configured
366 * primary controller. The keys in 'info' are the controllers' targets; the
367 * data values are corresponding "struct ofproto_controller_info".
369 * The caller owns 'info' and everything in it and should free it when it is no
372 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
374 const struct ofconn *ofconn;
378 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
379 const struct rconn *rconn = ofconn->rconn;
380 time_t now = time_now();
381 time_t last_connection = rconn_get_last_connection(rconn);
382 time_t last_disconnect = rconn_get_last_disconnect(rconn);
383 int last_error = rconn_get_last_error(rconn);
384 struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
386 shash_add(info, rconn_get_target(rconn), cinfo);
388 cinfo->is_connected = rconn_is_connected(rconn);
389 cinfo->role = ofconn->role;
394 cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
395 cinfo->pairs.values[cinfo->pairs.n++] =
396 xstrdup(ovs_retval_to_string(last_error));
399 cinfo->pairs.keys[cinfo->pairs.n] = "state";
400 cinfo->pairs.values[cinfo->pairs.n++] =
401 xstrdup(rconn_get_state(rconn));
403 if (last_connection != TIME_MIN) {
404 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
405 cinfo->pairs.values[cinfo->pairs.n++]
406 = xasprintf("%ld", (long int) (now - last_connection));
409 if (last_disconnect != TIME_MIN) {
410 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
411 cinfo->pairs.values[cinfo->pairs.n++]
412 = xasprintf("%ld", (long int) (now - last_disconnect));
417 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
420 connmgr_set_controllers(struct connmgr *mgr,
421 const struct ofproto_controller *controllers,
422 size_t n_controllers)
424 bool had_controllers = connmgr_has_controllers(mgr);
425 struct shash new_controllers;
426 struct ofconn *ofconn, *next_ofconn;
427 struct ofservice *ofservice, *next_ofservice;
430 /* Create newly configured controllers and services.
431 * Create a name to ofproto_controller mapping in 'new_controllers'. */
432 shash_init(&new_controllers);
433 for (i = 0; i < n_controllers; i++) {
434 const struct ofproto_controller *c = &controllers[i];
436 if (!vconn_verify_name(c->target)) {
437 if (!find_controller_by_target(mgr, c->target)) {
438 add_controller(mgr, c->target);
440 } else if (!pvconn_verify_name(c->target)) {
441 if (!ofservice_lookup(mgr, c->target)) {
442 ofservice_create(mgr, c->target);
445 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
446 mgr->name, c->target);
450 shash_add_once(&new_controllers, c->target, &controllers[i]);
453 /* Delete controllers that are no longer configured.
454 * Update configuration of all now-existing controllers. */
455 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
456 struct ofproto_controller *c;
458 c = shash_find_data(&new_controllers, ofconn_get_target(ofconn));
460 ofconn_destroy(ofconn);
462 ofconn_reconfigure(ofconn, c);
466 /* Delete services that are no longer configured.
467 * Update configuration of all now-existing services. */
468 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
469 struct ofproto_controller *c;
471 c = shash_find_data(&new_controllers,
472 pvconn_get_name(ofservice->pvconn));
474 ofservice_destroy(mgr, ofservice);
476 ofservice_reconfigure(ofservice, c);
480 shash_destroy(&new_controllers);
482 update_in_band_remotes(mgr);
483 update_fail_open(mgr);
484 if (had_controllers != connmgr_has_controllers(mgr)) {
485 ofproto_flush_flows(mgr->ofproto);
489 /* Drops the connections between 'mgr' and all of its primary and secondary
490 * controllers, forcing them to reconnect. */
492 connmgr_reconnect(const struct connmgr *mgr)
494 struct ofconn *ofconn;
496 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
497 rconn_reconnect(ofconn->rconn);
501 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
503 * A "snoop" is a pvconn to which every OpenFlow message to or from the most
504 * important controller on 'mgr' is mirrored. */
506 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
508 return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
511 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
513 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
517 for (i = 0; i < mgr->n_snoops; i++) {
518 sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
522 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
524 connmgr_has_snoops(const struct connmgr *mgr)
526 return mgr->n_snoops > 0;
529 /* Creates a new controller for 'target' in 'mgr'. update_controller() needs
530 * to be called later to finish the new ofconn's configuration. */
532 add_controller(struct connmgr *mgr, const char *target)
534 char *name = ofconn_make_name(mgr, target);
535 struct ofconn *ofconn;
537 ofconn = ofconn_create(mgr, rconn_create(5, 8), OFCONN_PRIMARY);
538 ofconn->pktbuf = pktbuf_create();
539 ofconn->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
540 rconn_connect(ofconn->rconn, target, name);
541 hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
546 static struct ofconn *
547 find_controller_by_target(struct connmgr *mgr, const char *target)
549 struct ofconn *ofconn;
551 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
552 hash_string(target, 0), &mgr->controllers) {
553 if (!strcmp(ofconn_get_target(ofconn), target)) {
561 update_in_band_remotes(struct connmgr *mgr)
563 struct sockaddr_in *addrs;
564 size_t max_addrs, n_addrs;
565 struct ofconn *ofconn;
568 /* Allocate enough memory for as many remotes as we could possibly have. */
569 max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
570 addrs = xmalloc(max_addrs * sizeof *addrs);
573 /* Add all the remotes. */
574 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
575 struct sockaddr_in *sin = &addrs[n_addrs];
577 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
581 sin->sin_addr.s_addr = rconn_get_remote_ip(ofconn->rconn);
582 if (sin->sin_addr.s_addr) {
583 sin->sin_port = rconn_get_remote_port(ofconn->rconn);
587 for (i = 0; i < mgr->n_extra_remotes; i++) {
588 addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
591 /* Create or update or destroy in-band. */
594 in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
597 in_band_set_remotes(mgr->in_band, addrs, n_addrs);
599 in_band_set_queue(mgr->in_band, mgr->in_band_queue);
600 mgr->next_in_band_update = time_msec() + 1000;
602 in_band_destroy(mgr->in_band);
611 update_fail_open(struct connmgr *mgr)
613 if (connmgr_has_controllers(mgr)
614 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
615 if (!mgr->fail_open) {
616 mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
619 fail_open_destroy(mgr->fail_open);
620 mgr->fail_open = NULL;
625 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
626 const struct sset *sset)
628 struct pvconn **pvconns = *pvconnsp;
629 size_t n_pvconns = *n_pvconnsp;
634 for (i = 0; i < n_pvconns; i++) {
635 pvconn_close(pvconns[i]);
639 pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
641 SSET_FOR_EACH (name, sset) {
642 struct pvconn *pvconn;
645 error = pvconn_open(name, &pvconn);
647 pvconns[n_pvconns++] = pvconn;
649 VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
657 *n_pvconnsp = n_pvconns;
662 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
663 * means that 'ofconn' is more interesting for monitoring than a lower return
666 snoop_preference(const struct ofconn *ofconn)
668 switch (ofconn->role) {
676 /* Shouldn't happen. */
681 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
682 * Connects this vconn to a controller. */
684 add_snooper(struct connmgr *mgr, struct vconn *vconn)
686 struct ofconn *ofconn, *best;
688 /* Pick a controller for monitoring. */
690 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
691 if (ofconn->type == OFCONN_PRIMARY
692 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
698 rconn_add_monitor(best->rconn, vconn);
700 VLOG_INFO_RL(&rl, "no controller connection to snoop");
705 /* Public ofconn functions. */
707 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
709 ofconn_get_type(const struct ofconn *ofconn)
714 /* Returns the role configured for 'ofconn'.
716 * The default role, if no other role has been set, is NX_ROLE_OTHER. */
718 ofconn_get_role(const struct ofconn *ofconn)
723 /* Changes 'ofconn''s role to 'role'. If 'role' is NX_ROLE_MASTER then any
724 * existing master is demoted to a slave. */
726 ofconn_set_role(struct ofconn *ofconn, enum nx_role role)
728 if (role == NX_ROLE_MASTER) {
729 struct ofconn *other;
731 HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
732 if (other->role == NX_ROLE_MASTER) {
733 other->role = NX_ROLE_SLAVE;
740 /* Returns the currently configured flow format for 'ofconn', one of NXFF_*.
742 * The default, if no other format has been set, is NXFF_OPENFLOW10. */
744 ofconn_get_flow_format(struct ofconn *ofconn)
746 return ofconn->flow_format;
749 /* Sets the flow format for 'ofconn' to 'flow_format' (one of NXFF_*). */
751 ofconn_set_flow_format(struct ofconn *ofconn, enum nx_flow_format flow_format)
753 ofconn->flow_format = flow_format;
756 /* Returns true if the NXT_FLOW_MOD_TABLE_ID extension is enabled, false
759 * By default the extension is not enabled. */
761 ofconn_get_flow_mod_table_id(const struct ofconn *ofconn)
763 return ofconn->flow_mod_table_id;
766 /* Enables or disables (according to 'enable') the NXT_FLOW_MOD_TABLE_ID
767 * extension on 'ofconn'. */
769 ofconn_set_flow_mod_table_id(struct ofconn *ofconn, bool enable)
771 ofconn->flow_mod_table_id = enable;
774 /* Returns the default miss send length for 'ofconn'. */
776 ofconn_get_miss_send_len(const struct ofconn *ofconn)
778 return ofconn->miss_send_len;
781 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
783 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
785 ofconn->miss_send_len = miss_send_len;
788 /* Sends 'msg' on 'ofconn', accounting it as a reply. (If there is a
789 * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
790 * connmgr will stop accepting new OpenFlow requests on that ofconn until the
791 * controller has accepted some of the replies.) */
793 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
795 ofconn_send(ofconn, msg, ofconn->reply_counter);
798 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
799 * accounting them as replies. */
801 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
803 struct ofpbuf *reply, *next;
805 LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
806 list_remove(&reply->list_node);
807 ofconn_send_reply(ofconn, reply);
811 /* Sends 'error', which should be an OpenFlow error created with
812 * e.g. ofp_mkerr(), on 'ofconn', as a reply to 'request'. Only at most the
813 * first 64 bytes of 'request' are used. */
815 ofconn_send_error(const struct ofconn *ofconn,
816 const struct ofp_header *request, int error)
818 struct ofpbuf *msg = ofputil_encode_error_msg(error, request);
820 ofconn_send_reply(ofconn, msg);
824 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
826 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
827 struct ofpbuf **bufferp, uint16_t *in_port)
829 return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
832 /* Returns true if 'ofconn' has any pending opgroups. */
834 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
836 return !list_is_empty(&ofconn->opgroups);
839 /* Returns the number of pending opgroups on 'ofconn'. */
841 ofconn_n_pending_opgroups(const struct ofconn *ofconn)
843 return list_size(&ofconn->opgroups);
846 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
848 * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
849 * 'ofconn_node' from the list and re-initialize it with list_init(). The
850 * client may, therefore, use list_is_empty(ofconn_node) to determine whether
851 * 'ofconn_node' is still associated with an active ofconn.
853 * The client may also remove ofconn_node from the list itself, with
856 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
858 list_push_back(&ofconn->opgroups, ofconn_node);
861 /* Private ofconn functions. */
864 ofconn_get_target(const struct ofconn *ofconn)
866 return rconn_get_target(ofconn->rconn);
869 static struct ofconn *
870 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type)
872 struct ofconn *ofconn = xzalloc(sizeof *ofconn);
873 ofconn->connmgr = mgr;
874 list_push_back(&mgr->all_conns, &ofconn->node);
875 ofconn->rconn = rconn;
877 ofconn->flow_format = NXFF_OPENFLOW10;
878 ofconn->flow_mod_table_id = false;
879 list_init(&ofconn->opgroups);
880 ofconn->role = NX_ROLE_OTHER;
881 ofconn->packet_in_counter = rconn_packet_counter_create ();
882 ofconn->pktbuf = NULL;
883 ofconn->miss_send_len = 0;
884 ofconn->reply_counter = rconn_packet_counter_create ();
888 /* Disassociates 'ofconn' from all of the ofopgroups that it initiated that
889 * have not yet completed. (Those ofopgroups will still run to completion in
890 * the usual way, but any errors that they run into will not be reported on any
893 * Also discards any blocked operation on 'ofconn'. */
895 ofconn_flush(struct ofconn *ofconn)
897 while (!list_is_empty(&ofconn->opgroups)) {
898 list_init(list_pop_front(&ofconn->opgroups));
900 ofpbuf_delete(ofconn->blocked);
901 ofconn->blocked = NULL;
905 ofconn_destroy(struct ofconn *ofconn)
907 ofconn_flush(ofconn);
909 if (ofconn->type == OFCONN_PRIMARY) {
910 hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
913 list_remove(&ofconn->node);
914 rconn_destroy(ofconn->rconn);
915 rconn_packet_counter_destroy(ofconn->packet_in_counter);
916 rconn_packet_counter_destroy(ofconn->reply_counter);
917 pktbuf_destroy(ofconn->pktbuf);
921 /* Reconfigures 'ofconn' to match 'c'. 'ofconn' and 'c' must have the same
924 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
928 ofconn->band = c->band;
930 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
932 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
933 rconn_set_probe_interval(ofconn->rconn, probe_interval);
935 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
938 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
941 ofconn_may_recv(const struct ofconn *ofconn)
943 int count = rconn_packet_counter_read (ofconn->reply_counter);
944 return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
948 ofconn_run(struct ofconn *ofconn,
949 bool (*handle_openflow)(struct ofconn *, struct ofpbuf *ofp_msg))
951 struct connmgr *mgr = ofconn->connmgr;
954 for (i = 0; i < N_SCHEDULERS; i++) {
955 pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
958 rconn_run(ofconn->rconn);
960 if (handle_openflow) {
961 /* Limit the number of iterations to avoid starving other tasks. */
962 for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
963 struct ofpbuf *of_msg;
965 of_msg = (ofconn->blocked
967 : rconn_recv(ofconn->rconn));
971 if (mgr->fail_open) {
972 fail_open_maybe_recover(mgr->fail_open);
975 if (handle_openflow(ofconn, of_msg)) {
976 ofpbuf_delete(of_msg);
977 ofconn->blocked = NULL;
979 ofconn->blocked = of_msg;
980 ofconn->retry = false;
985 if (!rconn_is_alive(ofconn->rconn)) {
986 ofconn_destroy(ofconn);
987 } else if (!rconn_is_connected(ofconn->rconn)) {
988 ofconn_flush(ofconn);
993 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
997 for (i = 0; i < N_SCHEDULERS; i++) {
998 pinsched_wait(ofconn->schedulers[i]);
1000 rconn_run_wait(ofconn->rconn);
1001 if (handling_openflow && ofconn_may_recv(ofconn)) {
1002 rconn_recv_wait(ofconn->rconn);
1006 /* Returns true if 'ofconn' should receive asynchronous messages. */
1008 ofconn_receives_async_msgs(const struct ofconn *ofconn)
1010 if (!rconn_is_connected(ofconn->rconn)) {
1012 } else if (ofconn->type == OFCONN_PRIMARY) {
1013 /* Primary controllers always get asynchronous messages unless they
1014 * have configured themselves as "slaves". */
1015 return ofconn->role != NX_ROLE_SLAVE;
1017 /* Service connections don't get asynchronous messages unless they have
1018 * explicitly asked for them by setting a nonzero miss send length. */
1019 return ofconn->miss_send_len > 0;
1023 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1024 * 'target', suitable for use in log messages for identifying the connection.
1026 * The name is dynamically allocated. The caller should free it (with free())
1027 * when it is no longer needed. */
1029 ofconn_make_name(const struct connmgr *mgr, const char *target)
1031 return xasprintf("%s<->%s", mgr->name, target);
1035 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1039 for (i = 0; i < N_SCHEDULERS; i++) {
1040 struct pinsched **s = &ofconn->schedulers[i];
1044 *s = pinsched_create(rate, burst);
1046 pinsched_set_limits(*s, rate, burst);
1049 pinsched_destroy(*s);
1056 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1057 struct rconn_packet_counter *counter)
1059 update_openflow_length(msg);
1060 if (rconn_send(ofconn->rconn, msg, counter)) {
1065 /* Sending asynchronous messages. */
1067 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in,
1068 const struct flow *, struct ofpbuf *rw_packet);
1070 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1071 * controllers managed by 'mgr'. */
1073 connmgr_send_port_status(struct connmgr *mgr, const struct ofp_phy_port *opp,
1076 /* XXX Should limit the number of queued port status change messages. */
1077 struct ofconn *ofconn;
1079 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1080 struct ofp_port_status *ops;
1083 /* Primary controllers, even slaves, should always get port status
1084 updates. Otherwise obey ofconn_receives_async_msgs(). */
1085 if (ofconn->type != OFCONN_PRIMARY
1086 && !ofconn_receives_async_msgs(ofconn)) {
1090 ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1091 ops->reason = reason;
1093 ofconn_send(ofconn, b, NULL);
1097 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1098 * appropriate controllers managed by 'mgr'. */
1100 connmgr_send_flow_removed(struct connmgr *mgr,
1101 const struct ofputil_flow_removed *fr)
1103 struct ofconn *ofconn;
1105 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1108 if (!ofconn_receives_async_msgs(ofconn)) {
1112 /* Account flow expirations as replies to OpenFlow requests. That
1113 * works because preventing OpenFlow requests from being processed also
1114 * prevents new flows from being added (and expiring). (It also
1115 * prevents processing OpenFlow requests that would not add new flows,
1116 * so it is imperfect.) */
1117 msg = ofputil_encode_flow_removed(fr, ofconn->flow_format);
1118 ofconn_send_reply(ofconn, msg);
1122 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1123 * necessary according to their individual configurations.
1125 * 'rw_packet' may be NULL. Otherwise, 'rw_packet' must contain the same data
1126 * as pin->packet. (rw_packet == pin->packet is also valid.) Ownership of
1127 * 'rw_packet' is transferred to this function. */
1129 connmgr_send_packet_in(struct connmgr *mgr,
1130 const struct ofputil_packet_in *pin,
1131 const struct flow *flow, struct ofpbuf *rw_packet)
1133 struct ofconn *ofconn, *prev;
1136 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1137 if (ofconn_receives_async_msgs(ofconn)) {
1139 schedule_packet_in(prev, *pin, flow, NULL);
1145 schedule_packet_in(prev, *pin, flow, rw_packet);
1147 ofpbuf_delete(rw_packet);
1151 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1153 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1155 struct ofconn *ofconn = ofconn_;
1157 rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1158 ofconn->packet_in_counter, 100);
1161 /* Takes 'pin', whose packet has the flow specified by 'flow', composes an
1162 * OpenFlow packet-in message from it, and passes it to 'ofconn''s packet
1163 * scheduler for sending.
1165 * 'rw_packet' may be NULL. Otherwise, 'rw_packet' must contain the same data
1166 * as pin->packet. (rw_packet == pin->packet is also valid.) Ownership of
1167 * 'rw_packet' is transferred to this function. */
1169 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin,
1170 const struct flow *flow, struct ofpbuf *rw_packet)
1172 struct connmgr *mgr = ofconn->connmgr;
1174 /* Get OpenFlow buffer_id. */
1175 if (pin.reason == OFPR_ACTION) {
1176 pin.buffer_id = UINT32_MAX;
1177 } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1178 pin.buffer_id = pktbuf_get_null();
1179 } else if (!ofconn->pktbuf) {
1180 pin.buffer_id = UINT32_MAX;
1182 pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, flow->in_port);
1185 /* Figure out how much of the packet to send. */
1186 if (pin.reason == OFPR_NO_MATCH) {
1187 pin.send_len = pin.packet->size;
1189 /* Caller should have initialized 'send_len' to 'max_len' specified in
1190 * struct ofp_action_output. */
1192 if (pin.buffer_id != UINT32_MAX) {
1193 pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1196 /* Make OFPT_PACKET_IN and hand over to packet scheduler. It might
1197 * immediately call into do_send_packet_in() or it might buffer it for a
1198 * while (until a later call to pinsched_run()). */
1199 pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1200 flow->in_port, ofputil_encode_packet_in(&pin, rw_packet),
1201 do_send_packet_in, ofconn);
1204 /* Fail-open settings. */
1206 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1207 * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1208 enum ofproto_fail_mode
1209 connmgr_get_fail_mode(const struct connmgr *mgr)
1211 return mgr->fail_mode;
1214 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1215 * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1217 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1219 if (mgr->fail_mode != fail_mode) {
1220 mgr->fail_mode = fail_mode;
1221 update_fail_open(mgr);
1222 if (!connmgr_has_controllers(mgr)) {
1223 ofproto_flush_flows(mgr->ofproto);
1228 /* Fail-open implementation. */
1230 /* Returns the longest probe interval among the primary controllers configured
1231 * on 'mgr'. Returns 0 if there are no primary controllers. */
1233 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1235 const struct ofconn *ofconn;
1236 int max_probe_interval;
1238 max_probe_interval = 0;
1239 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1240 int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1241 max_probe_interval = MAX(max_probe_interval, probe_interval);
1243 return max_probe_interval;
1246 /* Returns the number of seconds for which all of 'mgr's primary controllers
1247 * have been disconnected. Returns 0 if 'mgr' has no primary controllers. */
1249 connmgr_failure_duration(const struct connmgr *mgr)
1251 const struct ofconn *ofconn;
1252 int min_failure_duration;
1254 if (!connmgr_has_controllers(mgr)) {
1258 min_failure_duration = INT_MAX;
1259 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1260 int failure_duration = rconn_failure_duration(ofconn->rconn);
1261 min_failure_duration = MIN(min_failure_duration, failure_duration);
1263 return min_failure_duration;
1266 /* Returns true if at least one primary controller is connected (regardless of
1267 * whether those controllers are believed to have authenticated and accepted
1268 * this switch), false if none of them are connected. */
1270 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1272 const struct ofconn *ofconn;
1274 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1275 if (rconn_is_connected(ofconn->rconn)) {
1282 /* Returns true if at least one primary controller is believed to have
1283 * authenticated and accepted this switch, false otherwise. */
1285 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1287 const struct ofconn *ofconn;
1289 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1290 if (rconn_is_admitted(ofconn->rconn)) {
1297 /* Sends 'packet' to each controller connected to 'mgr'. Takes ownership of
1300 connmgr_broadcast(struct connmgr *mgr, struct ofpbuf *packet)
1302 struct ofconn *ofconn, *prev;
1305 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1307 ofconn_send_reply(ofconn, ofpbuf_clone(packet));
1309 if (rconn_is_connected(ofconn->rconn)) {
1314 ofconn_send_reply(prev, packet);
1316 ofpbuf_delete(packet);
1320 /* In-band configuration. */
1322 static bool any_extras_changed(const struct connmgr *,
1323 const struct sockaddr_in *extras, size_t n);
1325 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1326 * in-band control should guarantee access, in the same way that in-band
1327 * control guarantees access to OpenFlow controllers. */
1329 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1330 const struct sockaddr_in *extras, size_t n)
1332 if (!any_extras_changed(mgr, extras, n)) {
1336 free(mgr->extra_in_band_remotes);
1337 mgr->n_extra_remotes = n;
1338 mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1340 update_in_band_remotes(mgr);
1343 /* Sets the OpenFlow queue used by flows set up by in-band control on
1344 * 'mgr' to 'queue_id'. If 'queue_id' is negative, then in-band control
1345 * flows will use the default queue. */
1347 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1349 if (queue_id != mgr->in_band_queue) {
1350 mgr->in_band_queue = queue_id;
1351 update_in_band_remotes(mgr);
1356 any_extras_changed(const struct connmgr *mgr,
1357 const struct sockaddr_in *extras, size_t n)
1361 if (n != mgr->n_extra_remotes) {
1365 for (i = 0; i < n; i++) {
1366 const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1367 const struct sockaddr_in *new = &extras[i];
1369 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1370 old->sin_port != new->sin_port) {
1378 /* In-band implementation. */
1381 connmgr_msg_in_hook(struct connmgr *mgr, const struct flow *flow,
1382 const struct ofpbuf *packet)
1384 return mgr->in_band && in_band_msg_in_hook(mgr->in_band, flow, packet);
1388 connmgr_may_set_up_flow(struct connmgr *mgr, const struct flow *flow,
1389 const struct nlattr *odp_actions,
1392 return !mgr->in_band || in_band_rule_check(flow, odp_actions, actions_len);
1395 /* Fail-open and in-band implementation. */
1397 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1398 * and standalone mode to re-create their flows.
1400 * In-band control has more sophisticated code that manages flows itself. */
1402 connmgr_flushed(struct connmgr *mgr)
1404 if (mgr->fail_open) {
1405 fail_open_flushed(mgr->fail_open);
1408 /* If there are no controllers and we're in standalone mode, set up a flow
1409 * that matches every packet and directs them to OFPP_NORMAL (which goes to
1410 * us). Otherwise, the switch is in secure mode and we won't pass any
1411 * traffic until a controller has been defined and it tells us to do so. */
1412 if (!connmgr_has_controllers(mgr)
1413 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1414 union ofp_action action;
1415 struct cls_rule rule;
1417 memset(&action, 0, sizeof action);
1418 action.type = htons(OFPAT_OUTPUT);
1419 action.output.len = htons(sizeof action);
1420 action.output.port = htons(OFPP_NORMAL);
1421 cls_rule_init_catchall(&rule, 0);
1422 ofproto_add_flow(mgr->ofproto, &rule, &action, 1);
1426 /* Creates a new ofservice for 'target' in 'mgr'. Returns 0 if successful,
1427 * otherwise a positive errno value.
1429 * ofservice_reconfigure() must be called to fully configure the new
1432 ofservice_create(struct connmgr *mgr, const char *target)
1434 struct ofservice *ofservice;
1435 struct pvconn *pvconn;
1438 error = pvconn_open(target, &pvconn);
1443 ofservice = xzalloc(sizeof *ofservice);
1444 hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1445 ofservice->pvconn = pvconn;
1451 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1453 hmap_remove(&mgr->services, &ofservice->node);
1454 pvconn_close(ofservice->pvconn);
1459 ofservice_reconfigure(struct ofservice *ofservice,
1460 const struct ofproto_controller *c)
1462 ofservice->probe_interval = c->probe_interval;
1463 ofservice->rate_limit = c->rate_limit;
1464 ofservice->burst_limit = c->burst_limit;
1467 /* Finds and returns the ofservice within 'mgr' that has the given
1468 * 'target', or a null pointer if none exists. */
1469 static struct ofservice *
1470 ofservice_lookup(struct connmgr *mgr, const char *target)
1472 struct ofservice *ofservice;
1474 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1476 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {