2 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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"
28 #include "ofp-actions.h"
32 #include "ofproto-provider.h"
34 #include "poll-loop.h"
44 VLOG_DEFINE_THIS_MODULE(connmgr);
45 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
47 /* An OpenFlow connection. */
49 /* Configuration that persists from one connection to the next. */
51 struct list node; /* In struct connmgr's "all_conns" list. */
52 struct hmap_node hmap_node; /* In struct connmgr's "controllers" map. */
54 struct connmgr *connmgr; /* Connection's manager. */
55 struct rconn *rconn; /* OpenFlow connection. */
56 enum ofconn_type type; /* Type. */
57 enum ofproto_band band; /* In-band or out-of-band? */
58 bool enable_async_msgs; /* Initially enable async messages? */
60 /* State that should be cleared from one connection to the next. */
63 enum ofp12_controller_role role; /* Role. */
64 enum ofputil_protocol protocol; /* Current protocol variant. */
65 enum nx_packet_in_format packet_in_format; /* OFPT_PACKET_IN format. */
67 /* Asynchronous flow table operation support. */
68 struct list opgroups; /* Contains pending "ofopgroups", if any. */
69 struct ofpbuf *blocked; /* Postponed OpenFlow message, if any. */
70 bool retry; /* True if 'blocked' is ready to try again. */
72 /* OFPT_PACKET_IN related data. */
73 struct rconn_packet_counter *packet_in_counter; /* # queued on 'rconn'. */
74 #define N_SCHEDULERS 2
75 struct pinsched *schedulers[N_SCHEDULERS];
76 struct pktbuf *pktbuf; /* OpenFlow packet buffers. */
77 int miss_send_len; /* Bytes to send of buffered packets. */
78 uint16_t controller_id; /* Connection controller ID. */
80 /* Number of OpenFlow messages queued on 'rconn' as replies to OpenFlow
81 * requests, and the maximum number before we stop reading OpenFlow
83 #define OFCONN_REPLY_MAX 100
84 struct rconn_packet_counter *reply_counter;
86 /* Asynchronous message configuration in each possible roles.
88 * A 1-bit enables sending an asynchronous message for one possible reason
89 * that the message might be generated, a 0-bit disables it. */
90 uint32_t master_async_config[OAM_N_TYPES]; /* master, other */
91 uint32_t slave_async_config[OAM_N_TYPES]; /* slave */
94 struct hmap monitors; /* Contains "struct ofmonitor"s. */
95 struct list updates; /* List of "struct ofpbuf"s. */
96 bool sent_abbrev_update; /* Does 'updates' contain NXFME_ABBREV? */
97 struct rconn_packet_counter *monitor_counter;
98 uint64_t monitor_paused;
101 static struct ofconn *ofconn_create(struct connmgr *, struct rconn *,
102 enum ofconn_type, bool enable_async_msgs);
103 static void ofconn_destroy(struct ofconn *);
104 static void ofconn_flush(struct ofconn *);
106 static void ofconn_reconfigure(struct ofconn *,
107 const struct ofproto_controller *);
109 static void ofconn_run(struct ofconn *,
110 bool (*handle_openflow)(struct ofconn *,
111 const struct ofpbuf *ofp_msg));
112 static void ofconn_wait(struct ofconn *, bool handling_openflow);
114 static const char *ofconn_get_target(const struct ofconn *);
115 static char *ofconn_make_name(const struct connmgr *, const char *target);
117 static void ofconn_set_rate_limit(struct ofconn *, int rate, int burst);
119 static void ofconn_send(const struct ofconn *, struct ofpbuf *,
120 struct rconn_packet_counter *);
122 static void do_send_packet_in(struct ofpbuf *, void *ofconn_);
124 /* A listener for incoming OpenFlow "service" connections. */
126 struct hmap_node node; /* In struct connmgr's "services" hmap. */
127 struct pvconn *pvconn; /* OpenFlow connection listener. */
129 /* These are not used by ofservice directly. They are settings for
130 * accepted "struct ofconn"s from the pvconn. */
131 int probe_interval; /* Max idle time before probing, in seconds. */
132 int rate_limit; /* Max packet-in rate in packets per second. */
133 int burst_limit; /* Limit on accumulating packet credits. */
134 bool enable_async_msgs; /* Initially enable async messages? */
135 uint8_t dscp; /* DSCP Value for controller connection */
136 uint32_t allowed_versions; /* OpenFlow protocol versions that may
137 * be negotiated for a session. */
140 static void ofservice_reconfigure(struct ofservice *,
141 const struct ofproto_controller *);
142 static int ofservice_create(struct connmgr *mgr, const char *target,
143 uint32_t allowed_versions, uint8_t dscp);
144 static void ofservice_destroy(struct connmgr *, struct ofservice *);
145 static struct ofservice *ofservice_lookup(struct connmgr *,
148 /* Connection manager for an OpenFlow switch. */
150 struct ofproto *ofproto;
152 char *local_port_name;
154 /* OpenFlow connections. */
155 struct hmap controllers; /* Controller "struct ofconn"s. */
156 struct list all_conns; /* Contains "struct ofconn"s. */
157 uint64_t master_election_id; /* monotonically increasing sequence number
158 * for master election */
159 bool master_election_id_defined;
161 /* OpenFlow listeners. */
162 struct hmap services; /* Contains "struct ofservice"s. */
163 struct pvconn **snoops;
167 struct fail_open *fail_open;
168 enum ofproto_fail_mode fail_mode;
170 /* In-band control. */
171 struct in_band *in_band;
172 struct sockaddr_in *extra_in_band_remotes;
173 size_t n_extra_remotes;
177 static void update_in_band_remotes(struct connmgr *);
178 static void add_snooper(struct connmgr *, struct vconn *);
179 static void ofmonitor_run(struct connmgr *);
180 static void ofmonitor_wait(struct connmgr *);
182 /* Creates and returns a new connection manager owned by 'ofproto'. 'name' is
183 * a name for the ofproto suitable for using in log messages.
184 * 'local_port_name' is the name of the local port (OFPP_LOCAL) within
187 connmgr_create(struct ofproto *ofproto,
188 const char *name, const char *local_port_name)
192 mgr = xmalloc(sizeof *mgr);
193 mgr->ofproto = ofproto;
194 mgr->name = xstrdup(name);
195 mgr->local_port_name = xstrdup(local_port_name);
197 hmap_init(&mgr->controllers);
198 list_init(&mgr->all_conns);
199 mgr->master_election_id = 0;
200 mgr->master_election_id_defined = false;
202 hmap_init(&mgr->services);
206 mgr->fail_open = NULL;
207 mgr->fail_mode = OFPROTO_FAIL_SECURE;
210 mgr->extra_in_band_remotes = NULL;
211 mgr->n_extra_remotes = 0;
212 mgr->in_band_queue = -1;
217 /* Frees 'mgr' and all of its resources. */
219 connmgr_destroy(struct connmgr *mgr)
221 struct ofservice *ofservice, *next_ofservice;
222 struct ofconn *ofconn, *next_ofconn;
229 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
230 ofconn_destroy(ofconn);
232 hmap_destroy(&mgr->controllers);
234 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
235 ofservice_destroy(mgr, ofservice);
237 hmap_destroy(&mgr->services);
239 for (i = 0; i < mgr->n_snoops; i++) {
240 pvconn_close(mgr->snoops[i]);
244 fail_open_destroy(mgr->fail_open);
245 mgr->fail_open = NULL;
247 in_band_destroy(mgr->in_band);
249 free(mgr->extra_in_band_remotes);
251 free(mgr->local_port_name);
256 /* Does all of the periodic maintenance required by 'mgr'.
258 * If 'handle_openflow' is nonnull, calls 'handle_openflow' for each message
259 * received on an OpenFlow connection, passing along the OpenFlow connection
260 * itself and the message that was sent. If 'handle_openflow' returns true,
261 * the message is considered to be fully processed. If 'handle_openflow'
262 * returns false, the message is considered not to have been processed at all;
263 * it will be stored and re-presented to 'handle_openflow' following the next
264 * call to connmgr_retry(). 'handle_openflow' must not modify or free the
267 * If 'handle_openflow' is NULL, no OpenFlow messages will be processed and
268 * other activities that could affect the flow table (in-band processing,
269 * fail-open processing) are suppressed too. */
271 connmgr_run(struct connmgr *mgr,
272 bool (*handle_openflow)(struct ofconn *,
273 const struct ofpbuf *ofp_msg))
275 struct ofconn *ofconn, *next_ofconn;
276 struct ofservice *ofservice;
279 if (handle_openflow && mgr->in_band) {
280 if (!in_band_run(mgr->in_band)) {
281 in_band_destroy(mgr->in_band);
286 LIST_FOR_EACH_SAFE (ofconn, next_ofconn, node, &mgr->all_conns) {
287 ofconn_run(ofconn, handle_openflow);
291 /* Fail-open maintenance. Do this after processing the ofconns since
292 * fail-open checks the status of the controller rconn. */
293 if (handle_openflow && mgr->fail_open) {
294 fail_open_run(mgr->fail_open);
297 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
301 retval = pvconn_accept(ofservice->pvconn, &vconn);
306 /* Passing default value for creation of the rconn */
307 rconn = rconn_create(ofservice->probe_interval, 0, ofservice->dscp,
308 vconn_get_allowed_versions(vconn));
309 name = ofconn_make_name(mgr, vconn_get_name(vconn));
310 rconn_connect_unreliably(rconn, vconn, name);
313 ofconn = ofconn_create(mgr, rconn, OFCONN_SERVICE,
314 ofservice->enable_async_msgs);
315 ofconn_set_rate_limit(ofconn, ofservice->rate_limit,
316 ofservice->burst_limit);
317 } else if (retval != EAGAIN) {
318 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
322 for (i = 0; i < mgr->n_snoops; i++) {
326 retval = pvconn_accept(mgr->snoops[i], &vconn);
328 add_snooper(mgr, vconn);
329 } else if (retval != EAGAIN) {
330 VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
335 /* Causes the poll loop to wake up when connmgr_run() needs to run.
337 * If 'handling_openflow' is true, arriving OpenFlow messages and other
338 * activities that affect the flow table will wake up the poll loop. If
339 * 'handling_openflow' is false, they will not. */
341 connmgr_wait(struct connmgr *mgr, bool handling_openflow)
343 struct ofservice *ofservice;
344 struct ofconn *ofconn;
347 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
348 ofconn_wait(ofconn, handling_openflow);
351 if (handling_openflow && mgr->in_band) {
352 in_band_wait(mgr->in_band);
354 if (handling_openflow && mgr->fail_open) {
355 fail_open_wait(mgr->fail_open);
357 HMAP_FOR_EACH (ofservice, node, &mgr->services) {
358 pvconn_wait(ofservice->pvconn);
360 for (i = 0; i < mgr->n_snoops; i++) {
361 pvconn_wait(mgr->snoops[i]);
365 /* Adds some memory usage statistics for 'mgr' into 'usage', for use with
366 * memory_report(). */
368 connmgr_get_memory_usage(const struct connmgr *mgr, struct simap *usage)
370 const struct ofconn *ofconn;
371 unsigned int packets = 0;
372 unsigned int ofconns = 0;
374 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
379 packets += rconn_count_txqlen(ofconn->rconn);
380 for (i = 0; i < N_SCHEDULERS; i++) {
381 packets += pinsched_count_txqlen(ofconn->schedulers[i]);
383 packets += pktbuf_count_packets(ofconn->pktbuf);
385 simap_increase(usage, "ofconns", ofconns);
386 simap_increase(usage, "packets", packets);
389 /* Returns the ofproto that owns 'ofconn''s connmgr. */
391 ofconn_get_ofproto(const struct ofconn *ofconn)
393 return ofconn->connmgr->ofproto;
396 /* If processing of OpenFlow messages was blocked on any 'mgr' ofconns by
397 * returning false to the 'handle_openflow' callback to connmgr_run(), this
398 * re-enables them. */
400 connmgr_retry(struct connmgr *mgr)
402 struct ofconn *ofconn;
404 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
405 ofconn->retry = true;
409 /* OpenFlow configuration. */
411 static void add_controller(struct connmgr *, const char *target, uint8_t dscp,
412 uint32_t allowed_versions);
413 static struct ofconn *find_controller_by_target(struct connmgr *,
415 static void update_fail_open(struct connmgr *);
416 static int set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
417 const struct sset *);
419 /* Returns true if 'mgr' has any configured primary controllers.
421 * Service controllers do not count, but configured primary controllers do
422 * count whether or not they are currently connected. */
424 connmgr_has_controllers(const struct connmgr *mgr)
426 return !hmap_is_empty(&mgr->controllers);
429 /* Initializes 'info' and populates it with information about each configured
430 * primary controller. The keys in 'info' are the controllers' targets; the
431 * data values are corresponding "struct ofproto_controller_info".
433 * The caller owns 'info' and everything in it and should free it when it is no
436 connmgr_get_controller_info(struct connmgr *mgr, struct shash *info)
438 const struct ofconn *ofconn;
440 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
441 const struct rconn *rconn = ofconn->rconn;
442 const char *target = rconn_get_target(rconn);
444 if (!shash_find(info, target)) {
445 struct ofproto_controller_info *cinfo = xmalloc(sizeof *cinfo);
446 time_t now = time_now();
447 time_t last_connection = rconn_get_last_connection(rconn);
448 time_t last_disconnect = rconn_get_last_disconnect(rconn);
449 int last_error = rconn_get_last_error(rconn);
451 shash_add(info, target, cinfo);
453 cinfo->is_connected = rconn_is_connected(rconn);
454 cinfo->role = ofconn->role;
459 cinfo->pairs.keys[cinfo->pairs.n] = "last_error";
460 cinfo->pairs.values[cinfo->pairs.n++]
461 = xstrdup(ovs_retval_to_string(last_error));
464 cinfo->pairs.keys[cinfo->pairs.n] = "state";
465 cinfo->pairs.values[cinfo->pairs.n++]
466 = xstrdup(rconn_get_state(rconn));
468 if (last_connection != TIME_MIN) {
469 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_connect";
470 cinfo->pairs.values[cinfo->pairs.n++]
471 = xasprintf("%ld", (long int) (now - last_connection));
474 if (last_disconnect != TIME_MIN) {
475 cinfo->pairs.keys[cinfo->pairs.n] = "sec_since_disconnect";
476 cinfo->pairs.values[cinfo->pairs.n++]
477 = xasprintf("%ld", (long int) (now - last_disconnect));
484 connmgr_free_controller_info(struct shash *info)
486 struct shash_node *node;
488 SHASH_FOR_EACH (node, info) {
489 struct ofproto_controller_info *cinfo = node->data;
490 while (cinfo->pairs.n) {
491 free(CONST_CAST(char *, cinfo->pairs.values[--cinfo->pairs.n]));
498 /* Changes 'mgr''s set of controllers to the 'n_controllers' controllers in
501 connmgr_set_controllers(struct connmgr *mgr,
502 const struct ofproto_controller *controllers,
503 size_t n_controllers, uint32_t allowed_versions)
505 bool had_controllers = connmgr_has_controllers(mgr);
506 struct shash new_controllers;
507 struct ofconn *ofconn, *next_ofconn;
508 struct ofservice *ofservice, *next_ofservice;
511 /* Create newly configured controllers and services.
512 * Create a name to ofproto_controller mapping in 'new_controllers'. */
513 shash_init(&new_controllers);
514 for (i = 0; i < n_controllers; i++) {
515 const struct ofproto_controller *c = &controllers[i];
517 if (!vconn_verify_name(c->target)) {
519 ofconn = find_controller_by_target(mgr, c->target);
521 VLOG_INFO("%s: added primary controller \"%s\"",
522 mgr->name, c->target);
524 } else if (rconn_get_allowed_versions(ofconn->rconn) !=
526 VLOG_INFO("%s: re-added primary controller \"%s\"",
527 mgr->name, c->target);
529 ofconn_destroy(ofconn);
532 add_controller(mgr, c->target, c->dscp, allowed_versions);
534 } else if (!pvconn_verify_name(c->target)) {
536 ofservice = ofservice_lookup(mgr, c->target);
538 VLOG_INFO("%s: added service controller \"%s\"",
539 mgr->name, c->target);
541 } else if (ofservice->allowed_versions != allowed_versions) {
542 VLOG_INFO("%s: re-added service controller \"%s\"",
543 mgr->name, c->target);
544 ofservice_destroy(mgr, ofservice);
548 ofservice_create(mgr, c->target, allowed_versions, c->dscp);
551 VLOG_WARN_RL(&rl, "%s: unsupported controller \"%s\"",
552 mgr->name, c->target);
556 shash_add_once(&new_controllers, c->target, &controllers[i]);
559 /* Delete controllers that are no longer configured.
560 * Update configuration of all now-existing controllers. */
561 HMAP_FOR_EACH_SAFE (ofconn, next_ofconn, hmap_node, &mgr->controllers) {
562 const char *target = ofconn_get_target(ofconn);
563 struct ofproto_controller *c;
565 c = shash_find_data(&new_controllers, target);
567 VLOG_INFO("%s: removed primary controller \"%s\"",
569 ofconn_destroy(ofconn);
571 ofconn_reconfigure(ofconn, c);
575 /* Delete services that are no longer configured.
576 * Update configuration of all now-existing services. */
577 HMAP_FOR_EACH_SAFE (ofservice, next_ofservice, node, &mgr->services) {
578 const char *target = pvconn_get_name(ofservice->pvconn);
579 struct ofproto_controller *c;
581 c = shash_find_data(&new_controllers, target);
583 VLOG_INFO("%s: removed service controller \"%s\"",
585 ofservice_destroy(mgr, ofservice);
587 ofservice_reconfigure(ofservice, c);
591 shash_destroy(&new_controllers);
593 update_in_band_remotes(mgr);
594 update_fail_open(mgr);
595 if (had_controllers != connmgr_has_controllers(mgr)) {
596 ofproto_flush_flows(mgr->ofproto);
600 /* Drops the connections between 'mgr' and all of its primary and secondary
601 * controllers, forcing them to reconnect. */
603 connmgr_reconnect(const struct connmgr *mgr)
605 struct ofconn *ofconn;
607 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
608 rconn_reconnect(ofconn->rconn);
612 /* Sets the "snoops" for 'mgr' to the pvconn targets listed in 'snoops'.
614 * A "snoop" is a pvconn to which every OpenFlow message to or from the most
615 * important controller on 'mgr' is mirrored. */
617 connmgr_set_snoops(struct connmgr *mgr, const struct sset *snoops)
619 return set_pvconns(&mgr->snoops, &mgr->n_snoops, snoops);
622 /* Adds each of the snoops currently configured on 'mgr' to 'snoops'. */
624 connmgr_get_snoops(const struct connmgr *mgr, struct sset *snoops)
628 for (i = 0; i < mgr->n_snoops; i++) {
629 sset_add(snoops, pvconn_get_name(mgr->snoops[i]));
633 /* Returns true if 'mgr' has at least one snoop, false if it has none. */
635 connmgr_has_snoops(const struct connmgr *mgr)
637 return mgr->n_snoops > 0;
640 /* Creates a new controller for 'target' in 'mgr'. update_controller() needs
641 * to be called later to finish the new ofconn's configuration. */
643 add_controller(struct connmgr *mgr, const char *target, uint8_t dscp,
644 uint32_t allowed_versions)
646 char *name = ofconn_make_name(mgr, target);
647 struct ofconn *ofconn;
649 ofconn = ofconn_create(mgr, rconn_create(5, 8, dscp, allowed_versions),
650 OFCONN_PRIMARY, true);
651 ofconn->pktbuf = pktbuf_create();
652 rconn_connect(ofconn->rconn, target, name);
653 hmap_insert(&mgr->controllers, &ofconn->hmap_node, hash_string(target, 0));
658 static struct ofconn *
659 find_controller_by_target(struct connmgr *mgr, const char *target)
661 struct ofconn *ofconn;
663 HMAP_FOR_EACH_WITH_HASH (ofconn, hmap_node,
664 hash_string(target, 0), &mgr->controllers) {
665 if (!strcmp(ofconn_get_target(ofconn), target)) {
673 update_in_band_remotes(struct connmgr *mgr)
675 struct sockaddr_in *addrs;
676 size_t max_addrs, n_addrs;
677 struct ofconn *ofconn;
680 /* Allocate enough memory for as many remotes as we could possibly have. */
681 max_addrs = mgr->n_extra_remotes + hmap_count(&mgr->controllers);
682 addrs = xmalloc(max_addrs * sizeof *addrs);
685 /* Add all the remotes. */
686 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
687 struct sockaddr_in *sin = &addrs[n_addrs];
688 const char *target = rconn_get_target(ofconn->rconn);
690 if (ofconn->band == OFPROTO_OUT_OF_BAND) {
694 if (stream_parse_target_with_default_ports(target,
701 for (i = 0; i < mgr->n_extra_remotes; i++) {
702 addrs[n_addrs++] = mgr->extra_in_band_remotes[i];
705 /* Create or update or destroy in-band. */
708 in_band_create(mgr->ofproto, mgr->local_port_name, &mgr->in_band);
710 in_band_set_queue(mgr->in_band, mgr->in_band_queue);
712 /* in_band_run() needs a chance to delete any existing in-band flows.
713 * We will destroy mgr->in_band after it's done with that. */
716 in_band_set_remotes(mgr->in_band, addrs, n_addrs);
724 update_fail_open(struct connmgr *mgr)
726 if (connmgr_has_controllers(mgr)
727 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
728 if (!mgr->fail_open) {
729 mgr->fail_open = fail_open_create(mgr->ofproto, mgr);
732 fail_open_destroy(mgr->fail_open);
733 mgr->fail_open = NULL;
738 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
739 const struct sset *sset)
741 struct pvconn **pvconns = *pvconnsp;
742 size_t n_pvconns = *n_pvconnsp;
747 for (i = 0; i < n_pvconns; i++) {
748 pvconn_close(pvconns[i]);
752 pvconns = xmalloc(sset_count(sset) * sizeof *pvconns);
754 SSET_FOR_EACH (name, sset) {
755 struct pvconn *pvconn;
757 error = pvconn_open(name, 0, 0, &pvconn);
759 pvconns[n_pvconns++] = pvconn;
761 VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
769 *n_pvconnsp = n_pvconns;
774 /* Returns a "preference level" for snooping 'ofconn'. A higher return value
775 * means that 'ofconn' is more interesting for monitoring than a lower return
778 snoop_preference(const struct ofconn *ofconn)
780 switch (ofconn->role) {
781 case OFPCR12_ROLE_MASTER:
783 case OFPCR12_ROLE_EQUAL:
785 case OFPCR12_ROLE_SLAVE:
787 case OFPCR12_ROLE_NOCHANGE:
789 /* Shouldn't happen. */
794 /* One of 'mgr''s "snoop" pvconns has accepted a new connection on 'vconn'.
795 * Connects this vconn to a controller. */
797 add_snooper(struct connmgr *mgr, struct vconn *vconn)
799 struct ofconn *ofconn, *best;
801 /* Pick a controller for monitoring. */
803 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
804 if (ofconn->type == OFCONN_PRIMARY
805 && (!best || snoop_preference(ofconn) > snoop_preference(best))) {
811 rconn_add_monitor(best->rconn, vconn);
813 VLOG_INFO_RL(&rl, "no controller connection to snoop");
818 /* Public ofconn functions. */
820 /* Returns the connection type, either OFCONN_PRIMARY or OFCONN_SERVICE. */
822 ofconn_get_type(const struct ofconn *ofconn)
827 /* If a master election id is defined, stores it into '*idp' and returns
828 * true. Otherwise, stores UINT64_MAX into '*idp' and returns false. */
830 ofconn_get_master_election_id(const struct ofconn *ofconn, uint64_t *idp)
832 *idp = (ofconn->connmgr->master_election_id_defined
833 ? ofconn->connmgr->master_election_id
835 return ofconn->connmgr->master_election_id_defined;
838 /* Sets the master election id.
840 * Returns true if successful, false if the id is stale
843 ofconn_set_master_election_id(struct ofconn *ofconn, uint64_t id)
845 if (ofconn->connmgr->master_election_id_defined
847 /* Unsigned difference interpreted as a two's complement signed
849 (int64_t)(id - ofconn->connmgr->master_election_id) < 0) {
852 ofconn->connmgr->master_election_id = id;
853 ofconn->connmgr->master_election_id_defined = true;
858 /* Returns the role configured for 'ofconn'.
860 * The default role, if no other role has been set, is OFPCR12_ROLE_EQUAL. */
861 enum ofp12_controller_role
862 ofconn_get_role(const struct ofconn *ofconn)
867 /* Changes 'ofconn''s role to 'role'. If 'role' is OFPCR12_ROLE_MASTER then
868 * any existing master is demoted to a slave. */
870 ofconn_set_role(struct ofconn *ofconn, enum ofp12_controller_role role)
872 if (role == OFPCR12_ROLE_MASTER) {
873 struct ofconn *other;
875 HMAP_FOR_EACH (other, hmap_node, &ofconn->connmgr->controllers) {
876 if (other->role == OFPCR12_ROLE_MASTER) {
877 other->role = OFPCR12_ROLE_SLAVE;
885 ofconn_set_invalid_ttl_to_controller(struct ofconn *ofconn, bool enable)
887 uint32_t bit = 1u << OFPR_INVALID_TTL;
889 ofconn->master_async_config[OAM_PACKET_IN] |= bit;
891 ofconn->master_async_config[OAM_PACKET_IN] &= ~bit;
896 ofconn_get_invalid_ttl_to_controller(struct ofconn *ofconn)
898 uint32_t bit = 1u << OFPR_INVALID_TTL;
899 return (ofconn->master_async_config[OAM_PACKET_IN] & bit) != 0;
902 /* Returns the currently configured protocol for 'ofconn', one of OFPUTIL_P_*.
904 * Returns OFPUTIL_P_NONE, which is not a valid protocol, if 'ofconn' hasn't
905 * completed version negotiation. This can't happen if at least one OpenFlow
906 * message, other than OFPT_HELLO, has been received on the connection (such as
907 * in ofproto.c's message handling code), since version negotiation is a
908 * prerequisite for starting to receive messages. This means that
909 * OFPUTIL_P_NONE is a special case that most callers need not worry about. */
910 enum ofputil_protocol
911 ofconn_get_protocol(const struct ofconn *ofconn)
913 if (ofconn->protocol == OFPUTIL_P_NONE &&
914 rconn_is_connected(ofconn->rconn)) {
915 int version = rconn_get_version(ofconn->rconn);
917 ofconn_set_protocol(CONST_CAST(struct ofconn *, ofconn),
918 ofputil_protocol_from_ofp_version(version));
922 return ofconn->protocol;
925 /* Sets the protocol for 'ofconn' to 'protocol' (one of OFPUTIL_P_*).
927 * (This doesn't actually send anything to accomplish this. Presumably the
928 * caller already did that.) */
930 ofconn_set_protocol(struct ofconn *ofconn, enum ofputil_protocol protocol)
932 ofconn->protocol = protocol;
935 /* Returns the currently configured packet in format for 'ofconn', one of
938 * The default, if no other format has been set, is NXPIF_OPENFLOW10. */
939 enum nx_packet_in_format
940 ofconn_get_packet_in_format(struct ofconn *ofconn)
942 return ofconn->packet_in_format;
945 /* Sets the packet in format for 'ofconn' to 'packet_in_format' (one of
948 ofconn_set_packet_in_format(struct ofconn *ofconn,
949 enum nx_packet_in_format packet_in_format)
951 ofconn->packet_in_format = packet_in_format;
954 /* Sets the controller connection ID for 'ofconn' to 'controller_id'.
956 * The connection controller ID is used for OFPP_CONTROLLER and
957 * NXAST_CONTROLLER actions. See "struct nx_action_controller" for details. */
959 ofconn_set_controller_id(struct ofconn *ofconn, uint16_t controller_id)
961 ofconn->controller_id = controller_id;
964 /* Returns the default miss send length for 'ofconn'. */
966 ofconn_get_miss_send_len(const struct ofconn *ofconn)
968 return ofconn->miss_send_len;
971 /* Sets the default miss send length for 'ofconn' to 'miss_send_len'. */
973 ofconn_set_miss_send_len(struct ofconn *ofconn, int miss_send_len)
975 ofconn->miss_send_len = miss_send_len;
979 ofconn_set_async_config(struct ofconn *ofconn,
980 const uint32_t master_masks[OAM_N_TYPES],
981 const uint32_t slave_masks[OAM_N_TYPES])
983 size_t size = sizeof ofconn->master_async_config;
984 memcpy(ofconn->master_async_config, master_masks, size);
985 memcpy(ofconn->slave_async_config, slave_masks, size);
988 /* Sends 'msg' on 'ofconn', accounting it as a reply. (If there is a
989 * sufficient number of OpenFlow replies in-flight on a single ofconn, then the
990 * connmgr will stop accepting new OpenFlow requests on that ofconn until the
991 * controller has accepted some of the replies.) */
993 ofconn_send_reply(const struct ofconn *ofconn, struct ofpbuf *msg)
995 ofconn_send(ofconn, msg, ofconn->reply_counter);
998 /* Sends each of the messages in list 'replies' on 'ofconn' in order,
999 * accounting them as replies. */
1001 ofconn_send_replies(const struct ofconn *ofconn, struct list *replies)
1003 struct ofpbuf *reply, *next;
1005 LIST_FOR_EACH_SAFE (reply, next, list_node, replies) {
1006 list_remove(&reply->list_node);
1007 ofconn_send_reply(ofconn, reply);
1011 /* Sends 'error' on 'ofconn', as a reply to 'request'. Only at most the
1012 * first 64 bytes of 'request' are used. */
1014 ofconn_send_error(const struct ofconn *ofconn,
1015 const struct ofp_header *request, enum ofperr error)
1017 static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(10, 10);
1018 struct ofpbuf *reply;
1020 reply = ofperr_encode_reply(error, request);
1021 if (!VLOG_DROP_INFO(&err_rl)) {
1022 const char *type_name;
1026 request_len = ntohs(request->length);
1027 type_name = (!ofpraw_decode_partial(&raw, request,
1028 MIN(64, request_len))
1029 ? ofpraw_get_name(raw)
1032 VLOG_INFO("%s: sending %s error reply to %s message",
1033 rconn_get_name(ofconn->rconn), ofperr_to_string(error),
1036 ofconn_send_reply(ofconn, reply);
1039 /* Same as pktbuf_retrieve(), using the pktbuf owned by 'ofconn'. */
1041 ofconn_pktbuf_retrieve(struct ofconn *ofconn, uint32_t id,
1042 struct ofpbuf **bufferp, uint16_t *in_port)
1044 return pktbuf_retrieve(ofconn->pktbuf, id, bufferp, in_port);
1047 /* Returns true if 'ofconn' has any pending opgroups. */
1049 ofconn_has_pending_opgroups(const struct ofconn *ofconn)
1051 return !list_is_empty(&ofconn->opgroups);
1054 /* Adds 'ofconn_node' to 'ofconn''s list of pending opgroups.
1056 * If 'ofconn' is destroyed or its connection drops, then 'ofconn' will remove
1057 * 'ofconn_node' from the list and re-initialize it with list_init(). The
1058 * client may, therefore, use list_is_empty(ofconn_node) to determine whether
1059 * 'ofconn_node' is still associated with an active ofconn.
1061 * The client may also remove ofconn_node from the list itself, with
1064 ofconn_add_opgroup(struct ofconn *ofconn, struct list *ofconn_node)
1066 list_push_back(&ofconn->opgroups, ofconn_node);
1069 /* Private ofconn functions. */
1072 ofconn_get_target(const struct ofconn *ofconn)
1074 return rconn_get_target(ofconn->rconn);
1077 static struct ofconn *
1078 ofconn_create(struct connmgr *mgr, struct rconn *rconn, enum ofconn_type type,
1079 bool enable_async_msgs)
1081 struct ofconn *ofconn;
1083 ofconn = xzalloc(sizeof *ofconn);
1084 ofconn->connmgr = mgr;
1085 list_push_back(&mgr->all_conns, &ofconn->node);
1086 ofconn->rconn = rconn;
1087 ofconn->type = type;
1088 ofconn->enable_async_msgs = enable_async_msgs;
1090 list_init(&ofconn->opgroups);
1092 hmap_init(&ofconn->monitors);
1093 list_init(&ofconn->updates);
1095 ofconn_flush(ofconn);
1100 /* Clears all of the state in 'ofconn' that should not persist from one
1101 * connection to the next. */
1103 ofconn_flush(struct ofconn *ofconn)
1105 struct ofmonitor *monitor, *next_monitor;
1108 ofconn->role = OFPCR12_ROLE_EQUAL;
1109 ofconn_set_protocol(ofconn, OFPUTIL_P_NONE);
1110 ofconn->packet_in_format = NXPIF_OPENFLOW10;
1112 /* Disassociate 'ofconn' from all of the ofopgroups that it initiated that
1113 * have not yet completed. (Those ofopgroups will still run to completion
1114 * in the usual way, but any errors that they run into will not be reported
1115 * on any OpenFlow channel.)
1117 * Also discard any blocked operation on 'ofconn'. */
1118 while (!list_is_empty(&ofconn->opgroups)) {
1119 list_init(list_pop_front(&ofconn->opgroups));
1121 ofpbuf_delete(ofconn->blocked);
1122 ofconn->blocked = NULL;
1124 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1125 ofconn->packet_in_counter = rconn_packet_counter_create();
1126 for (i = 0; i < N_SCHEDULERS; i++) {
1127 if (ofconn->schedulers[i]) {
1130 pinsched_get_limits(ofconn->schedulers[i], &rate, &burst);
1131 pinsched_destroy(ofconn->schedulers[i]);
1132 ofconn->schedulers[i] = pinsched_create(rate, burst);
1135 if (ofconn->pktbuf) {
1136 pktbuf_destroy(ofconn->pktbuf);
1137 ofconn->pktbuf = pktbuf_create();
1139 ofconn->miss_send_len = (ofconn->type == OFCONN_PRIMARY
1140 ? OFP_DEFAULT_MISS_SEND_LEN
1142 ofconn->controller_id = 0;
1144 rconn_packet_counter_destroy(ofconn->reply_counter);
1145 ofconn->reply_counter = rconn_packet_counter_create();
1147 if (ofconn->enable_async_msgs) {
1148 uint32_t *master = ofconn->master_async_config;
1149 uint32_t *slave = ofconn->slave_async_config;
1151 /* "master" and "other" roles get all asynchronous messages by default,
1152 * except that the controller needs to enable nonstandard "packet-in"
1153 * reasons itself. */
1154 master[OAM_PACKET_IN] = (1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION);
1155 master[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1156 | (1u << OFPPR_DELETE)
1157 | (1u << OFPPR_MODIFY));
1158 master[OAM_FLOW_REMOVED] = ((1u << OFPRR_IDLE_TIMEOUT)
1159 | (1u << OFPRR_HARD_TIMEOUT)
1160 | (1u << OFPRR_DELETE));
1162 /* "slave" role gets port status updates by default. */
1163 slave[OAM_PACKET_IN] = 0;
1164 slave[OAM_PORT_STATUS] = ((1u << OFPPR_ADD)
1165 | (1u << OFPPR_DELETE)
1166 | (1u << OFPPR_MODIFY));
1167 slave[OAM_FLOW_REMOVED] = 0;
1169 memset(ofconn->master_async_config, 0,
1170 sizeof ofconn->master_async_config);
1171 memset(ofconn->slave_async_config, 0,
1172 sizeof ofconn->slave_async_config);
1175 HMAP_FOR_EACH_SAFE (monitor, next_monitor, ofconn_node,
1176 &ofconn->monitors) {
1177 ofmonitor_destroy(monitor);
1179 rconn_packet_counter_destroy(ofconn->monitor_counter);
1180 ofconn->monitor_counter = rconn_packet_counter_create();
1181 ofpbuf_list_delete(&ofconn->updates); /* ...but it should be empty. */
1185 ofconn_destroy(struct ofconn *ofconn)
1187 ofconn_flush(ofconn);
1189 if (ofconn->type == OFCONN_PRIMARY) {
1190 hmap_remove(&ofconn->connmgr->controllers, &ofconn->hmap_node);
1193 hmap_destroy(&ofconn->monitors);
1194 list_remove(&ofconn->node);
1195 rconn_destroy(ofconn->rconn);
1196 rconn_packet_counter_destroy(ofconn->packet_in_counter);
1197 rconn_packet_counter_destroy(ofconn->reply_counter);
1198 pktbuf_destroy(ofconn->pktbuf);
1199 rconn_packet_counter_destroy(ofconn->monitor_counter);
1203 /* Reconfigures 'ofconn' to match 'c'. 'ofconn' and 'c' must have the same
1206 ofconn_reconfigure(struct ofconn *ofconn, const struct ofproto_controller *c)
1210 ofconn->band = c->band;
1211 ofconn->enable_async_msgs = c->enable_async_msgs;
1213 rconn_set_max_backoff(ofconn->rconn, c->max_backoff);
1215 probe_interval = c->probe_interval ? MAX(c->probe_interval, 5) : 0;
1216 rconn_set_probe_interval(ofconn->rconn, probe_interval);
1218 ofconn_set_rate_limit(ofconn, c->rate_limit, c->burst_limit);
1220 /* If dscp value changed reconnect. */
1221 if (c->dscp != rconn_get_dscp(ofconn->rconn)) {
1222 rconn_set_dscp(ofconn->rconn, c->dscp);
1223 rconn_reconnect(ofconn->rconn);
1227 /* Returns true if it makes sense for 'ofconn' to receive and process OpenFlow
1230 ofconn_may_recv(const struct ofconn *ofconn)
1232 int count = ofconn->reply_counter->n_packets;
1233 return (!ofconn->blocked || ofconn->retry) && count < OFCONN_REPLY_MAX;
1237 ofconn_run(struct ofconn *ofconn,
1238 bool (*handle_openflow)(struct ofconn *,
1239 const struct ofpbuf *ofp_msg))
1241 struct connmgr *mgr = ofconn->connmgr;
1244 for (i = 0; i < N_SCHEDULERS; i++) {
1245 pinsched_run(ofconn->schedulers[i], do_send_packet_in, ofconn);
1248 rconn_run(ofconn->rconn);
1250 if (handle_openflow) {
1251 /* Limit the number of iterations to avoid starving other tasks. */
1252 for (i = 0; i < 50 && ofconn_may_recv(ofconn); i++) {
1253 struct ofpbuf *of_msg;
1255 of_msg = (ofconn->blocked
1257 : rconn_recv(ofconn->rconn));
1261 if (mgr->fail_open) {
1262 fail_open_maybe_recover(mgr->fail_open);
1265 if (handle_openflow(ofconn, of_msg)) {
1266 ofpbuf_delete(of_msg);
1267 ofconn->blocked = NULL;
1269 ofconn->blocked = of_msg;
1270 ofconn->retry = false;
1275 if (!rconn_is_alive(ofconn->rconn)) {
1276 ofconn_destroy(ofconn);
1277 } else if (!rconn_is_connected(ofconn->rconn)) {
1278 ofconn_flush(ofconn);
1283 ofconn_wait(struct ofconn *ofconn, bool handling_openflow)
1287 for (i = 0; i < N_SCHEDULERS; i++) {
1288 pinsched_wait(ofconn->schedulers[i]);
1290 rconn_run_wait(ofconn->rconn);
1291 if (handling_openflow && ofconn_may_recv(ofconn)) {
1292 rconn_recv_wait(ofconn->rconn);
1296 /* Returns true if 'ofconn' should receive asynchronous messages of the given
1297 * OAM_* 'type' and 'reason', which should be a OFPR_* value for OAM_PACKET_IN,
1298 * a OFPPR_* value for OAM_PORT_STATUS, or an OFPRR_* value for
1299 * OAM_FLOW_REMOVED. Returns false if the message should not be sent on
1302 ofconn_receives_async_msg(const struct ofconn *ofconn,
1303 enum ofconn_async_msg_type type,
1304 unsigned int reason)
1306 const uint32_t *async_config;
1308 ovs_assert(reason < 32);
1309 ovs_assert((unsigned int) type < OAM_N_TYPES);
1311 if (ofconn_get_protocol(ofconn) == OFPUTIL_P_NONE
1312 || !rconn_is_connected(ofconn->rconn)) {
1316 /* Keep the following code in sync with the documentation in the
1317 * "Asynchronous Messages" section in DESIGN. */
1319 if (ofconn->type == OFCONN_SERVICE && !ofconn->miss_send_len) {
1320 /* Service connections don't get asynchronous messages unless they have
1321 * explicitly asked for them by setting a nonzero miss send length. */
1325 async_config = (ofconn->role == OFPCR12_ROLE_SLAVE
1326 ? ofconn->slave_async_config
1327 : ofconn->master_async_config);
1328 if (!(async_config[type] & (1u << reason))) {
1335 /* Returns a human-readable name for an OpenFlow connection between 'mgr' and
1336 * 'target', suitable for use in log messages for identifying the connection.
1338 * The name is dynamically allocated. The caller should free it (with free())
1339 * when it is no longer needed. */
1341 ofconn_make_name(const struct connmgr *mgr, const char *target)
1343 return xasprintf("%s<->%s", mgr->name, target);
1347 ofconn_set_rate_limit(struct ofconn *ofconn, int rate, int burst)
1351 for (i = 0; i < N_SCHEDULERS; i++) {
1352 struct pinsched **s = &ofconn->schedulers[i];
1356 *s = pinsched_create(rate, burst);
1358 pinsched_set_limits(*s, rate, burst);
1361 pinsched_destroy(*s);
1368 ofconn_send(const struct ofconn *ofconn, struct ofpbuf *msg,
1369 struct rconn_packet_counter *counter)
1371 ofpmsg_update_length(msg);
1372 rconn_send(ofconn->rconn, msg, counter);
1375 /* Sending asynchronous messages. */
1377 static void schedule_packet_in(struct ofconn *, struct ofputil_packet_in);
1379 /* Sends an OFPT_PORT_STATUS message with 'opp' and 'reason' to appropriate
1380 * controllers managed by 'mgr'. */
1382 connmgr_send_port_status(struct connmgr *mgr,
1383 const struct ofputil_phy_port *pp, uint8_t reason)
1385 /* XXX Should limit the number of queued port status change messages. */
1386 struct ofputil_port_status ps;
1387 struct ofconn *ofconn;
1391 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1392 if (ofconn_receives_async_msg(ofconn, OAM_PORT_STATUS, reason)) {
1395 msg = ofputil_encode_port_status(&ps, ofconn_get_protocol(ofconn));
1396 ofconn_send(ofconn, msg, NULL);
1401 /* Sends an OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED message based on 'fr' to
1402 * appropriate controllers managed by 'mgr'. */
1404 connmgr_send_flow_removed(struct connmgr *mgr,
1405 const struct ofputil_flow_removed *fr)
1407 struct ofconn *ofconn;
1409 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1410 if (ofconn_receives_async_msg(ofconn, OAM_FLOW_REMOVED, fr->reason)) {
1413 /* Account flow expirations as replies to OpenFlow requests. That
1414 * works because preventing OpenFlow requests from being processed
1415 * also prevents new flows from being added (and expiring). (It
1416 * also prevents processing OpenFlow requests that would not add
1417 * new flows, so it is imperfect.) */
1418 msg = ofputil_encode_flow_removed(fr, ofconn_get_protocol(ofconn));
1419 ofconn_send_reply(ofconn, msg);
1424 /* Given 'pin', sends an OFPT_PACKET_IN message to each OpenFlow controller as
1425 * necessary according to their individual configurations.
1427 * The caller doesn't need to fill in pin->buffer_id or pin->total_len. */
1429 connmgr_send_packet_in(struct connmgr *mgr,
1430 const struct ofputil_packet_in *pin)
1432 struct ofconn *ofconn;
1434 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1435 if (ofconn_receives_async_msg(ofconn, OAM_PACKET_IN, pin->reason)
1436 && ofconn->controller_id == pin->controller_id) {
1437 schedule_packet_in(ofconn, *pin);
1442 /* pinsched callback for sending 'ofp_packet_in' on 'ofconn'. */
1444 do_send_packet_in(struct ofpbuf *ofp_packet_in, void *ofconn_)
1446 struct ofconn *ofconn = ofconn_;
1448 rconn_send_with_limit(ofconn->rconn, ofp_packet_in,
1449 ofconn->packet_in_counter, 100);
1452 /* Takes 'pin', composes an OpenFlow packet-in message from it, and passes it
1453 * to 'ofconn''s packet scheduler for sending. */
1455 schedule_packet_in(struct ofconn *ofconn, struct ofputil_packet_in pin)
1457 struct connmgr *mgr = ofconn->connmgr;
1459 pin.total_len = pin.packet_len;
1461 /* Get OpenFlow buffer_id. */
1462 if (pin.reason == OFPR_ACTION) {
1463 pin.buffer_id = UINT32_MAX;
1464 } else if (mgr->fail_open && fail_open_is_active(mgr->fail_open)) {
1465 pin.buffer_id = pktbuf_get_null();
1466 } else if (!ofconn->pktbuf) {
1467 pin.buffer_id = UINT32_MAX;
1469 pin.buffer_id = pktbuf_save(ofconn->pktbuf, pin.packet, pin.packet_len,
1473 /* Figure out how much of the packet to send. */
1474 if (pin.reason == OFPR_NO_MATCH) {
1475 pin.send_len = pin.packet_len;
1477 /* Caller should have initialized 'send_len' to 'max_len' specified in
1480 if (pin.buffer_id != UINT32_MAX) {
1481 pin.send_len = MIN(pin.send_len, ofconn->miss_send_len);
1484 /* Make OFPT_PACKET_IN and hand over to packet scheduler. It might
1485 * immediately call into do_send_packet_in() or it might buffer it for a
1486 * while (until a later call to pinsched_run()). */
1487 pinsched_send(ofconn->schedulers[pin.reason == OFPR_NO_MATCH ? 0 : 1],
1489 ofputil_encode_packet_in(&pin, ofconn_get_protocol(ofconn),
1490 ofconn->packet_in_format),
1491 do_send_packet_in, ofconn);
1494 /* Fail-open settings. */
1496 /* Returns the failure handling mode (OFPROTO_FAIL_SECURE or
1497 * OFPROTO_FAIL_STANDALONE) for 'mgr'. */
1498 enum ofproto_fail_mode
1499 connmgr_get_fail_mode(const struct connmgr *mgr)
1501 return mgr->fail_mode;
1504 /* Sets the failure handling mode for 'mgr' to 'fail_mode' (either
1505 * OFPROTO_FAIL_SECURE or OFPROTO_FAIL_STANDALONE). */
1507 connmgr_set_fail_mode(struct connmgr *mgr, enum ofproto_fail_mode fail_mode)
1509 if (mgr->fail_mode != fail_mode) {
1510 mgr->fail_mode = fail_mode;
1511 update_fail_open(mgr);
1512 if (!connmgr_has_controllers(mgr)) {
1513 ofproto_flush_flows(mgr->ofproto);
1518 /* Fail-open implementation. */
1520 /* Returns the longest probe interval among the primary controllers configured
1521 * on 'mgr'. Returns 0 if there are no primary controllers. */
1523 connmgr_get_max_probe_interval(const struct connmgr *mgr)
1525 const struct ofconn *ofconn;
1526 int max_probe_interval;
1528 max_probe_interval = 0;
1529 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1530 int probe_interval = rconn_get_probe_interval(ofconn->rconn);
1531 max_probe_interval = MAX(max_probe_interval, probe_interval);
1533 return max_probe_interval;
1536 /* Returns the number of seconds for which all of 'mgr's primary controllers
1537 * have been disconnected. Returns 0 if 'mgr' has no primary controllers. */
1539 connmgr_failure_duration(const struct connmgr *mgr)
1541 const struct ofconn *ofconn;
1542 int min_failure_duration;
1544 if (!connmgr_has_controllers(mgr)) {
1548 min_failure_duration = INT_MAX;
1549 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1550 int failure_duration = rconn_failure_duration(ofconn->rconn);
1551 min_failure_duration = MIN(min_failure_duration, failure_duration);
1553 return min_failure_duration;
1556 /* Returns true if at least one primary controller is connected (regardless of
1557 * whether those controllers are believed to have authenticated and accepted
1558 * this switch), false if none of them are connected. */
1560 connmgr_is_any_controller_connected(const struct connmgr *mgr)
1562 const struct ofconn *ofconn;
1564 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1565 if (rconn_is_connected(ofconn->rconn)) {
1572 /* Returns true if at least one primary controller is believed to have
1573 * authenticated and accepted this switch, false otherwise. */
1575 connmgr_is_any_controller_admitted(const struct connmgr *mgr)
1577 const struct ofconn *ofconn;
1579 HMAP_FOR_EACH (ofconn, hmap_node, &mgr->controllers) {
1580 if (rconn_is_admitted(ofconn->rconn)) {
1587 /* In-band configuration. */
1589 static bool any_extras_changed(const struct connmgr *,
1590 const struct sockaddr_in *extras, size_t n);
1592 /* Sets the 'n' TCP port addresses in 'extras' as ones to which 'mgr''s
1593 * in-band control should guarantee access, in the same way that in-band
1594 * control guarantees access to OpenFlow controllers. */
1596 connmgr_set_extra_in_band_remotes(struct connmgr *mgr,
1597 const struct sockaddr_in *extras, size_t n)
1599 if (!any_extras_changed(mgr, extras, n)) {
1603 free(mgr->extra_in_band_remotes);
1604 mgr->n_extra_remotes = n;
1605 mgr->extra_in_band_remotes = xmemdup(extras, n * sizeof *extras);
1607 update_in_band_remotes(mgr);
1610 /* Sets the OpenFlow queue used by flows set up by in-band control on
1611 * 'mgr' to 'queue_id'. If 'queue_id' is negative, then in-band control
1612 * flows will use the default queue. */
1614 connmgr_set_in_band_queue(struct connmgr *mgr, int queue_id)
1616 if (queue_id != mgr->in_band_queue) {
1617 mgr->in_band_queue = queue_id;
1618 update_in_band_remotes(mgr);
1623 any_extras_changed(const struct connmgr *mgr,
1624 const struct sockaddr_in *extras, size_t n)
1628 if (n != mgr->n_extra_remotes) {
1632 for (i = 0; i < n; i++) {
1633 const struct sockaddr_in *old = &mgr->extra_in_band_remotes[i];
1634 const struct sockaddr_in *new = &extras[i];
1636 if (old->sin_addr.s_addr != new->sin_addr.s_addr ||
1637 old->sin_port != new->sin_port) {
1645 /* In-band implementation. */
1648 connmgr_must_output_local(struct connmgr *mgr, const struct flow *flow,
1649 uint32_t local_odp_port,
1650 const struct nlattr *odp_actions,
1653 return !mgr->in_band || in_band_rule_check(flow, local_odp_port,
1654 odp_actions, actions_len);
1657 /* Fail-open and in-band implementation. */
1659 /* Called by 'ofproto' after all flows have been flushed, to allow fail-open
1660 * and standalone mode to re-create their flows.
1662 * In-band control has more sophisticated code that manages flows itself. */
1664 connmgr_flushed(struct connmgr *mgr)
1666 if (mgr->fail_open) {
1667 fail_open_flushed(mgr->fail_open);
1670 /* If there are no controllers and we're in standalone mode, set up a flow
1671 * that matches every packet and directs them to OFPP_NORMAL (which goes to
1672 * us). Otherwise, the switch is in secure mode and we won't pass any
1673 * traffic until a controller has been defined and it tells us to do so. */
1674 if (!connmgr_has_controllers(mgr)
1675 && mgr->fail_mode == OFPROTO_FAIL_STANDALONE) {
1676 struct ofpbuf ofpacts;
1679 ofpbuf_init(&ofpacts, OFPACT_OUTPUT_SIZE);
1680 ofpact_put_OUTPUT(&ofpacts)->port = OFPP_NORMAL;
1681 ofpact_pad(&ofpacts);
1683 match_init_catchall(&match);
1684 ofproto_add_flow(mgr->ofproto, &match, 0, ofpacts.data, ofpacts.size);
1686 ofpbuf_uninit(&ofpacts);
1690 /* Creates a new ofservice for 'target' in 'mgr'. Returns 0 if successful,
1691 * otherwise a positive errno value.
1693 * ofservice_reconfigure() must be called to fully configure the new
1696 ofservice_create(struct connmgr *mgr, const char *target,
1697 uint32_t allowed_versions, uint8_t dscp)
1699 struct ofservice *ofservice;
1700 struct pvconn *pvconn;
1703 error = pvconn_open(target, allowed_versions, dscp, &pvconn);
1708 ofservice = xzalloc(sizeof *ofservice);
1709 hmap_insert(&mgr->services, &ofservice->node, hash_string(target, 0));
1710 ofservice->pvconn = pvconn;
1711 ofservice->allowed_versions = allowed_versions;
1717 ofservice_destroy(struct connmgr *mgr, struct ofservice *ofservice)
1719 hmap_remove(&mgr->services, &ofservice->node);
1720 pvconn_close(ofservice->pvconn);
1725 ofservice_reconfigure(struct ofservice *ofservice,
1726 const struct ofproto_controller *c)
1728 ofservice->probe_interval = c->probe_interval;
1729 ofservice->rate_limit = c->rate_limit;
1730 ofservice->burst_limit = c->burst_limit;
1731 ofservice->enable_async_msgs = c->enable_async_msgs;
1732 ofservice->dscp = c->dscp;
1735 /* Finds and returns the ofservice within 'mgr' that has the given
1736 * 'target', or a null pointer if none exists. */
1737 static struct ofservice *
1738 ofservice_lookup(struct connmgr *mgr, const char *target)
1740 struct ofservice *ofservice;
1742 HMAP_FOR_EACH_WITH_HASH (ofservice, node, hash_string(target, 0),
1744 if (!strcmp(pvconn_get_name(ofservice->pvconn), target)) {
1751 /* Flow monitors (NXST_FLOW_MONITOR). */
1753 /* A counter incremented when something significant happens to an OpenFlow
1756 * - When a rule is added, its 'add_seqno' and 'modify_seqno' are set to
1757 * the current value (which is then incremented).
1759 * - When a rule is modified, its 'modify_seqno' is set to the current
1760 * value (which is then incremented).
1762 * Thus, by comparing an old value of monitor_seqno against a rule's
1763 * 'add_seqno', one can tell whether the rule was added before or after the old
1764 * value was read, and similarly for 'modify_seqno'.
1766 * 32 bits should normally be sufficient (and would be nice, to save space in
1767 * each rule) but then we'd have to have some special cases for wraparound.
1769 * We initialize monitor_seqno to 1 to allow 0 to be used as an invalid
1771 static uint64_t monitor_seqno = 1;
1773 COVERAGE_DEFINE(ofmonitor_pause);
1774 COVERAGE_DEFINE(ofmonitor_resume);
1777 ofmonitor_create(const struct ofputil_flow_monitor_request *request,
1778 struct ofconn *ofconn, struct ofmonitor **monitorp)
1780 struct ofmonitor *m;
1784 m = ofmonitor_lookup(ofconn, request->id);
1786 return OFPERR_NXBRC_FM_DUPLICATE_ID;
1789 m = xmalloc(sizeof *m);
1791 hmap_insert(&ofconn->monitors, &m->ofconn_node, hash_int(request->id, 0));
1792 m->id = request->id;
1793 m->flags = request->flags;
1794 m->out_port = request->out_port;
1795 m->table_id = request->table_id;
1796 minimatch_init(&m->match, &request->match);
1803 ofmonitor_lookup(struct ofconn *ofconn, uint32_t id)
1805 struct ofmonitor *m;
1807 HMAP_FOR_EACH_IN_BUCKET (m, ofconn_node, hash_int(id, 0),
1808 &ofconn->monitors) {
1817 ofmonitor_destroy(struct ofmonitor *m)
1820 minimatch_destroy(&m->match);
1821 hmap_remove(&m->ofconn->monitors, &m->ofconn_node);
1827 ofmonitor_report(struct connmgr *mgr, struct rule *rule,
1828 enum nx_flow_update_event event,
1829 enum ofp_flow_removed_reason reason,
1830 const struct ofconn *abbrev_ofconn, ovs_be32 abbrev_xid)
1832 enum nx_flow_monitor_flags update;
1833 struct ofconn *ofconn;
1838 rule->add_seqno = rule->modify_seqno = monitor_seqno++;
1842 update = NXFMF_DELETE;
1845 case NXFME_MODIFIED:
1846 update = NXFMF_MODIFY;
1847 rule->modify_seqno = monitor_seqno++;
1855 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1856 enum nx_flow_monitor_flags flags = 0;
1857 struct ofmonitor *m;
1859 if (ofconn->monitor_paused) {
1860 /* Only send NXFME_DELETED notifications for flows that were added
1861 * before we paused. */
1862 if (event != NXFME_DELETED
1863 || rule->add_seqno > ofconn->monitor_paused) {
1868 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1869 if (m->flags & update
1870 && (m->table_id == 0xff || m->table_id == rule->table_id)
1871 && ofoperation_has_out_port(rule->pending, m->out_port)
1872 && cls_rule_is_loose_match(&rule->cr, &m->match)) {
1878 if (list_is_empty(&ofconn->updates)) {
1879 ofputil_start_flow_update(&ofconn->updates);
1880 ofconn->sent_abbrev_update = false;
1883 if (ofconn != abbrev_ofconn || ofconn->monitor_paused) {
1884 struct ofputil_flow_update fu;
1888 fu.reason = event == NXFME_DELETED ? reason : 0;
1889 fu.idle_timeout = rule->idle_timeout;
1890 fu.hard_timeout = rule->hard_timeout;
1891 fu.table_id = rule->table_id;
1892 fu.cookie = rule->flow_cookie;
1893 minimatch_expand(&rule->cr.match, &match);
1895 fu.priority = rule->cr.priority;
1896 if (flags & NXFMF_ACTIONS) {
1897 fu.ofpacts = rule->ofpacts;
1898 fu.ofpacts_len = rule->ofpacts_len;
1903 ofputil_append_flow_update(&fu, &ofconn->updates);
1904 } else if (!ofconn->sent_abbrev_update) {
1905 struct ofputil_flow_update fu;
1907 fu.event = NXFME_ABBREV;
1908 fu.xid = abbrev_xid;
1909 ofputil_append_flow_update(&fu, &ofconn->updates);
1911 ofconn->sent_abbrev_update = true;
1918 ofmonitor_flush(struct connmgr *mgr)
1920 struct ofconn *ofconn;
1922 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1923 struct ofpbuf *msg, *next;
1925 LIST_FOR_EACH_SAFE (msg, next, list_node, &ofconn->updates) {
1926 list_remove(&msg->list_node);
1927 ofconn_send(ofconn, msg, ofconn->monitor_counter);
1928 if (!ofconn->monitor_paused
1929 && ofconn->monitor_counter->n_bytes > 128 * 1024) {
1930 struct ofpbuf *pause;
1932 COVERAGE_INC(ofmonitor_pause);
1933 ofconn->monitor_paused = monitor_seqno++;
1934 pause = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_PAUSED,
1935 OFP10_VERSION, htonl(0), 0);
1936 ofconn_send(ofconn, pause, ofconn->monitor_counter);
1943 ofmonitor_resume(struct ofconn *ofconn)
1945 struct ofpbuf *resumed;
1946 struct ofmonitor *m;
1951 HMAP_FOR_EACH (m, ofconn_node, &ofconn->monitors) {
1952 ofmonitor_collect_resume_rules(m, ofconn->monitor_paused, &rules);
1956 ofmonitor_compose_refresh_updates(&rules, &msgs);
1958 resumed = ofpraw_alloc_xid(OFPRAW_NXT_FLOW_MONITOR_RESUMED, OFP10_VERSION,
1960 list_push_back(&msgs, &resumed->list_node);
1961 ofconn_send_replies(ofconn, &msgs);
1963 ofconn->monitor_paused = 0;
1967 ofmonitor_run(struct connmgr *mgr)
1969 struct ofconn *ofconn;
1971 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1972 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1973 COVERAGE_INC(ofmonitor_resume);
1974 ofmonitor_resume(ofconn);
1980 ofmonitor_wait(struct connmgr *mgr)
1982 struct ofconn *ofconn;
1984 LIST_FOR_EACH (ofconn, node, &mgr->all_conns) {
1985 if (ofconn->monitor_paused && !ofconn->monitor_counter->n_packets) {
1986 poll_immediate_wake();